├── .github └── workflows │ └── ci.yaml ├── .gitignore ├── Cargo.toml ├── LICENSE-APACHE ├── LICENSE-MIT ├── README.md ├── bors.toml ├── rustfmt.toml ├── src └── lib.rs └── xtask ├── Cargo.toml ├── src └── main.rs └── tests └── tidy.rs /.github/workflows/ci.yaml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | pull_request: 4 | push: 5 | branches: ["master", "staging", "trying"] 6 | 7 | env: 8 | CARGO_INCREMENTAL: 0 9 | CARGO_NET_RETRY: 10 10 | CI: 1 11 | RUST_BACKTRACE: short 12 | RUSTFLAGS: -D warnings 13 | RUSTUP_MAX_RETRIES: 10 14 | 15 | jobs: 16 | test: 17 | name: Rust 18 | runs-on: ubuntu-latest 19 | 20 | steps: 21 | - uses: actions/checkout@v2 22 | with: 23 | fetch-depth: 0 # fetch tags for publish 24 | - uses: actions-rs/toolchain@v1 25 | with: 26 | toolchain: stable 27 | profile: minimal 28 | override: true 29 | 30 | - run: cargo run -p xtask -- ci 31 | env: 32 | CRATES_IO_TOKEN: ${{ secrets.CRATES_IO_TOKEN }} 33 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | Cargo.lock 3 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "backtrace-on-stack-overflow" 3 | description = "Best effort backtrace printing" 4 | version = "0.3.0" 5 | license = "MIT OR Apache-2.0" 6 | repository = "https://github.com/matklad/backtrace-on-stack-overflow" 7 | authors = ["Aleksey Kladov "] 8 | edition = "2018" 9 | 10 | [workspace] 11 | members = ["xtask"] 12 | 13 | exclude = [".github/", "bors.toml", "rustfmt.toml"] 14 | 15 | [dependencies] 16 | backtrace = "0.3.65" 17 | libc = "0.2.126" 18 | nix = "0.26.4" 19 | -------------------------------------------------------------------------------- /LICENSE-APACHE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /LICENSE-MIT: -------------------------------------------------------------------------------- 1 | Permission is hereby granted, free of charge, to any 2 | person obtaining a copy of this software and associated 3 | documentation files (the "Software"), to deal in the 4 | Software without restriction, including without 5 | limitation the rights to use, copy, modify, merge, 6 | publish, distribute, sublicense, and/or sell copies of 7 | the Software, and to permit persons to whom the Software 8 | is furnished to do so, subject to the following 9 | conditions: 10 | 11 | The above copyright notice and this permission notice 12 | shall be included in all copies or substantial portions 13 | of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF 16 | ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED 17 | TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 18 | PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT 19 | SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 20 | CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 21 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR 22 | IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 23 | DEALINGS IN THE SOFTWARE. 24 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # backtrace-on-stack-overflow 2 | 3 | By default, Rust aborts on stackoverflow without printing a backtrace: 4 | 5 | ```console 6 | λ bat src/main.rs 7 | fn main() { 8 | f(92) 9 | } 10 | 11 | fn f(x: u64) { 12 | f(x) 13 | } 14 | λ cargo run 15 | Finished dev [unoptimized + debuginfo] target(s) in 0.00s 16 | Running `target/debug/so` 17 | 18 | thread 'main' has overflowed its stack 19 | fatal runtime error: stack overflow 20 | fish: Job 1, 'cargo run' terminated by signal SIGABRT (Abort) 21 | ``` 22 | 23 | This crate fixes this: 24 | 25 | ```console 26 | λ bat src/main.rs 27 | fn main() { 28 | unsafe { backtrace_on_stack_overflow::enable() }; 29 | f(92) 30 | } 31 | 32 | fn f(x: u64) { 33 | f(x) 34 | } 35 | λ cargo run 36 | Finished dev [unoptimized + debuginfo] target(s) in 0.01s 37 | Running `target/debug/so` 38 | Stack Overflow: 39 | 0: backtrace_on_stack_overflow::handle_sigsegv 40 | at /home/matklad/p/backtrace-on-stack-overflow/src/lib.rs:33:40 41 | 1: 42 | 2: so::f 43 | at src/main.rs:6 44 | 3: so::f 45 | at src/main.rs:7:5 46 | 4: so::f 47 | at src/main.rs:7:5 48 | 5: so::f 49 | at src/main.rs:7:5 50 | 6: so::f 51 | at src/main.rs:7:5 52 | 7: so::f 53 | at src/main.rs:7:5 54 | 8: so::f 55 | at src/main.rs:7:5 56 | 9: so::f 57 | at src/main.rs:7:5 58 | 10: so::f 59 | at src/main.rs:7:5 60 | ``` 61 | 62 | This crate works for debugging, but is unsuited for being enabled in production. 63 | -------------------------------------------------------------------------------- /bors.toml: -------------------------------------------------------------------------------- 1 | status = [ "Rust" ] 2 | delete_merged_branches = true 3 | -------------------------------------------------------------------------------- /rustfmt.toml: -------------------------------------------------------------------------------- 1 | reorder_modules = false 2 | use_small_heuristics = "Max" 3 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | //! By default, Rust aborts on stackoverflow without printing a backtrace: 2 | //! 3 | //! ```console 4 | //! λ bat src/main.rs 5 | //! fn main() { 6 | //! f(92) 7 | //! } 8 | //! 9 | //! fn f(x: u64) { 10 | //! f(x) 11 | //! } 12 | //! λ cargo run 13 | //! Finished dev [unoptimized + debuginfo] target(s) in 0.00s 14 | //! Running `target/debug/so` 15 | //! 16 | //! thread 'main' has overflowed its stack 17 | //! fatal runtime error: stack overflow 18 | //! fish: Job 1, 'cargo run' terminated by signal SIGABRT (Abort) 19 | //! ``` 20 | //! 21 | //! This crate fixes this: 22 | //! 23 | //! ```console 24 | //! λ bat src/main.rs 25 | //! fn main() { 26 | //! unsafe { backtrace_on_stack_overflow::enable() }; 27 | //! f(92) 28 | //! } 29 | //! 30 | //! fn f(x: u64) { 31 | //! f(x) 32 | //! } 33 | //! λ cargo run 34 | //! Finished dev [unoptimized + debuginfo] target(s) in 0.01s 35 | //! Running `target/debug/so` 36 | //! Stack Overflow: 37 | //! 0: backtrace_on_stack_overflow::handle_sigsegv 38 | //! at /home/matklad/p/backtrace-on-stack-overflow/src/lib.rs:33:40 39 | //! 1: 40 | //! 2: so::f 41 | //! at src/main.rs:6 42 | //! 3: so::f 43 | //! at src/main.rs:7:5 44 | //! 4: so::f 45 | //! at src/main.rs:7:5 46 | //! 5: so::f 47 | //! at src/main.rs:7:5 48 | //! 6: so::f 49 | //! at src/main.rs:7:5 50 | //! 7: so::f 51 | //! at src/main.rs:7:5 52 | //! 8: so::f 53 | //! at src/main.rs:7:5 54 | //! 9: so::f 55 | //! at src/main.rs:7:5 56 | //! 10: so::f 57 | //! at src/main.rs:7:5 58 | //! ``` 59 | //! 60 | //! This crate works for debugging, but is unsuited for being enabled in production. 61 | use nix::sys::signal; 62 | 63 | /// Best effort printing of backtrace on stack overflow. 64 | /// 65 | /// Works on my machine, may summon laundry-eating nasal daemons. 66 | /// 67 | /// PRs to make this more robust are welcome 68 | pub unsafe fn enable() { 69 | static ONCE: std::sync::Once = std::sync::Once::new(); 70 | 71 | ONCE.call_once(|| { 72 | // Use u128 for alignment. 73 | let buf = Vec::leak(vec![0u128; 4096]); 74 | let stack = libc::stack_t { 75 | ss_sp: buf.as_ptr() as *mut libc::c_void, 76 | ss_flags: 0, 77 | ss_size: buf.len() * std::mem::size_of::(), 78 | }; 79 | let mut old = libc::stack_t { ss_sp: std::ptr::null_mut(), ss_flags: 0, ss_size: 0 }; 80 | let ret = libc::sigaltstack(&stack, &mut old); 81 | assert_eq!(ret, 0, "sigaltstack failed"); 82 | 83 | let sig_action = signal::SigAction::new( 84 | signal::SigHandler::Handler(handle_sigsegv), 85 | signal::SaFlags::SA_NODEFER | signal::SaFlags::SA_ONSTACK, 86 | signal::SigSet::empty(), 87 | ); 88 | signal::sigaction(signal::SIGSEGV, &sig_action).unwrap(); 89 | signal::sigaction(signal::SIGABRT, &sig_action).unwrap(); 90 | }) 91 | } 92 | 93 | extern "C" fn handle_sigsegv(_: i32) { 94 | eprintln!("Stack Overflow:\n{:?}", backtrace::Backtrace::new()); 95 | std::process::abort(); 96 | } 97 | -------------------------------------------------------------------------------- /xtask/Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "xtask" 3 | version = "0.0.0" 4 | publish = false 5 | authors = ["Aleksey Kladov "] 6 | edition = "2018" 7 | 8 | [dependencies] 9 | xaction = "0.2" 10 | -------------------------------------------------------------------------------- /xtask/src/main.rs: -------------------------------------------------------------------------------- 1 | use std::env; 2 | 3 | use xaction::{cargo_toml, cmd, git, section, Result}; 4 | 5 | fn main() { 6 | if let Err(err) = try_main() { 7 | eprintln!("error: {}", err); 8 | std::process::exit(1) 9 | } 10 | } 11 | 12 | fn try_main() -> Result<()> { 13 | let subcommand = std::env::args().nth(1); 14 | match subcommand { 15 | Some(it) if it == "ci" => (), 16 | _ => { 17 | print_usage(); 18 | Err("invalid arguments")? 19 | } 20 | } 21 | 22 | let cargo_toml = cargo_toml()?; 23 | 24 | { 25 | let _s = section("BUILD"); 26 | cmd!("cargo test --workspace --no-run").run()?; 27 | } 28 | 29 | { 30 | let _s = section("TEST"); 31 | cmd!("cargo test --workspace -- --nocapture").run()?; 32 | } 33 | 34 | let version = cargo_toml.version()?; 35 | let tag = format!("v{}", version); 36 | 37 | let dry_run = 38 | env::var("CI").is_err() || git::has_tag(&tag)? || git::current_branch()? != "master"; 39 | xaction::set_dry_run(dry_run); 40 | 41 | { 42 | let _s = section("PUBLISH"); 43 | cargo_toml.publish()?; 44 | git::tag(&tag)?; 45 | git::push_tags()?; 46 | } 47 | Ok(()) 48 | } 49 | 50 | fn print_usage() { 51 | eprintln!( 52 | "\ 53 | Usage: cargo run -p xtask 54 | 55 | SUBCOMMANDS: 56 | ci 57 | " 58 | ) 59 | } 60 | -------------------------------------------------------------------------------- /xtask/tests/tidy.rs: -------------------------------------------------------------------------------- 1 | use xaction::cmd; 2 | 3 | #[test] 4 | fn test_formatting() { 5 | cmd!("cargo fmt --all -- --check").run().unwrap() 6 | } 7 | --------------------------------------------------------------------------------