├── .gitignore ├── Cargo.toml ├── LICENSE-APACHE ├── LICENSE-MIT ├── README.md ├── examples └── fallible.rs └── src └── lib.rs /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | Cargo.lock 3 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "fault-injection" 3 | version = "1.0.10" 4 | edition = "2021" 5 | authors = ["Tyler Neely "] 6 | description = "Simple fault injection, concurrency delay injection, and error source annotation" 7 | license = "MIT OR Apache-2.0" 8 | repository = "https://github.com/komora-io/fault-injection" 9 | documentation = "https://docs.rs/fault-injection/" 10 | keywords = ["fault", "injection", "testing", "reliability", "crash"] 11 | categories = ["development-tools", "concurrency", "filesystem", "network-programming", "rust-patterns"] 12 | readme = "README.md" 13 | 14 | [dependencies] 15 | -------------------------------------------------------------------------------- /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 2022 Tyler Neely 190 | Copyright 2023 Tyler Neely 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /LICENSE-MIT: -------------------------------------------------------------------------------- 1 | Copyright (c) 2022 Tyler Neely 2 | Copyright (c) 2023 Tyler Neely 3 | 4 | Permission is hereby granted, free of charge, to any 5 | person obtaining a copy of this software and associated 6 | documentation files (the "Software"), to deal in the 7 | Software without restriction, including without 8 | limitation the rights to use, copy, modify, merge, 9 | publish, distribute, sublicense, and/or sell copies of 10 | the Software, and to permit persons to whom the Software 11 | is furnished to do so, subject to the following 12 | conditions: 13 | 14 | The above copyright notice and this permission notice 15 | shall be included in all copies or substantial portions 16 | of the Software. 17 | 18 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF 19 | ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED 20 | TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 21 | PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT 22 | SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 23 | CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 24 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR 25 | IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 26 | DEALINGS IN THE SOFTWARE. 27 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # fault-injection 2 | 3 | [docs](https://docs.rs/fault-injection) 4 | 5 | Similar to the `try!` macro or `?` operator, 6 | but externally controllable to inject faults 7 | during testing. Unlike the `try!` macro or `?` 8 | operator, this additionally annotates the 9 | description of the error to include the crate, 10 | file name, and line number where the error 11 | originated from to facilitate quick debugging. 12 | It is specialized to work with `io::Result` 13 | types, and will return an `io::Error` for faults, 14 | with `into()` called similar to the `try!` macro 15 | or `?` operator. 16 | Decrements the `FAULT_INJECT_COUNTER` by `1` 17 | (it is set to `u64::MAX` by default), and if 18 | it hits 0, returns an `io::Error` with a kind 19 | of `Other`. If `SLEEPINESS` is set to 20 | something other than 0, this macro will also 21 | inject weakly pseudorandom delays for 22 | facilitating a basic form of concurrency testing. 23 | 24 | # Examples 25 | ``` 26 | use std::io; 27 | 28 | use fault_injection::{fallible, set_trigger_function, FAULT_INJECT_COUNTER}; 29 | 30 | fn trigger_fn(crate_name: &str, file_name: &str, line_number: u32) { 31 | println!( 32 | "fault injected at {} {} {}", 33 | crate_name, file_name, line_number 34 | ); 35 | } 36 | 37 | fn do_io() -> io::Result<()> { 38 | Ok(()) 39 | } 40 | 41 | // this will return an injected error 42 | fn use_it() -> std::io::Result<()> { 43 | set_trigger_function(trigger_fn); 44 | FAULT_INJECT_COUNTER.store(1, std::sync::atomic::Ordering::Release); 45 | 46 | fallible!(do_io()); 47 | 48 | Ok(()) 49 | } 50 | ``` 51 | -------------------------------------------------------------------------------- /examples/fallible.rs: -------------------------------------------------------------------------------- 1 | use std::io; 2 | 3 | use fault_injection::{fallible, set_trigger_function, FAULT_INJECT_COUNTER}; 4 | 5 | fn trigger_fn(crate_name: &str, file_name: &str, line_number: u32) { 6 | println!( 7 | "fault injected at {} {} {}", 8 | crate_name, file_name, line_number 9 | ); 10 | } 11 | 12 | fn do_io() -> io::Result<()> { 13 | Ok(()) 14 | } 15 | 16 | fn main() -> io::Result<()> { 17 | set_trigger_function(trigger_fn); 18 | FAULT_INJECT_COUNTER.store(1, std::sync::atomic::Ordering::Release); 19 | 20 | fallible!(do_io()); 21 | 22 | Ok(()) 23 | } 24 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | /// Facilitates fault injection. Every time any IO operation 2 | /// is performed, this is decremented. If it hits 0, an 3 | /// io::Error is returned from that IO operation. Use this 4 | /// to ensure that error handling is being performed, by 5 | /// running some test workload, checking the counter, and 6 | /// then setting this to an incrementally-lower number while 7 | /// asserting that your application properly handles the 8 | /// error that will propagate up. Defaults to `u64::MAX`, 9 | /// so it won't be hit normally unless you do something 6 billion 10 | /// times per second for 100 years. If you're building something 11 | /// like that, maybe consider re-setting this to `u64::MAX` every 12 | /// few decades for safety. 13 | pub static FAULT_INJECT_COUNTER: core::sync::atomic::AtomicU64 = 14 | core::sync::atomic::AtomicU64::new(u64::MAX); 15 | 16 | /// Facilitates delay injection. If you set this to something other 17 | /// than 0, the `fallible!` macro will randomly call `std::thread::yield_now()`, 18 | /// with the nubmer of times being multiplied by this value. You should not 19 | /// need to set it very high to get a lot of delays, but you'll need 20 | /// to play with the number sometimes for specific concurrent systems under test. 21 | pub static SLEEPINESS: core::sync::atomic::AtomicU32 = core::sync::atomic::AtomicU32::new(0); 22 | 23 | #[doc(hidden)] 24 | pub type Trigger = fn(crate_name: &'static str, file_name: &'static str, line_number: u32); 25 | 26 | /// This function will be called any time the [`FAULT_INJECT_COUNTER`] reaches 0 27 | /// and an error is injected. You can use this to re-set the counter for deep 28 | /// fault tree enumeration, test auditing, etc... 29 | /// 30 | /// The function accepts the crate name, file name, and line number as arguments. 31 | /// 32 | /// [`FAULT_INJECT_COUNTER`]: FAULT_INJECT_COUNTER 33 | pub fn set_trigger_function(f: Trigger) { 34 | TRIGGER_FN.store( 35 | f as usize as *mut Trigger, 36 | core::sync::atomic::Ordering::Release, 37 | ); 38 | } 39 | 40 | #[doc(hidden)] 41 | pub static TRIGGER_FN: core::sync::atomic::AtomicPtr = 42 | core::sync::atomic::AtomicPtr::new(0 as _); 43 | 44 | /// Similar to the `try!` macro or `?` operator, 45 | /// but externally controllable to inject faults 46 | /// during testing. Unlike the `try!` macro or `?` 47 | /// operator, this additionally annotates the 48 | /// description of the error to include the crate, 49 | /// file name, and line number where the error 50 | /// originated from to facilitate quick debugging. 51 | /// It is specialized to work with `io::Result` 52 | /// types, and will return an `io::Error` for faults, 53 | /// with `into()` called similar to the `try!` macro 54 | /// or `?` operator. 55 | /// Decrements the [`FAULT_INJECT_COUNTER`] by `1` 56 | /// (it is set to `u64::MAX` by default), and if 57 | /// it hits 0, returns an `io::Error` with a kind 58 | /// of `Other`. If [`SLEEPINESS`] is set to 59 | /// something other than 0, this macro will also 60 | /// inject weakly pseudorandom delays for 61 | /// facilitating a basic form of concurrency testing. 62 | /// 63 | /// # Examples 64 | /// ``` 65 | /// use std::io; 66 | /// 67 | /// use fault_injection::{fallible, set_trigger_function, FAULT_INJECT_COUNTER}; 68 | /// 69 | /// fn trigger_fn(crate_name: &str, file_name: &str, line_number: u32) { 70 | /// println!( 71 | /// "fault injected at {} {} {}", 72 | /// crate_name, file_name, line_number 73 | /// ); 74 | /// } 75 | /// 76 | /// fn do_io() -> io::Result<()> { 77 | /// Ok(()) 78 | /// } 79 | /// 80 | /// // this will return an injected error 81 | /// fn use_it() -> std::io::Result<()> { 82 | /// set_trigger_function(trigger_fn); 83 | /// FAULT_INJECT_COUNTER.store(1, std::sync::atomic::Ordering::Release); 84 | /// 85 | /// fallible!(do_io()); 86 | /// 87 | /// Ok(()) 88 | /// } 89 | /// 90 | /// assert!(use_it().is_err()); 91 | /// ``` 92 | /// 93 | /// 94 | /// [`FAULT_INJECT_COUNTER`]: FAULT_INJECT_COUNTER 95 | /// [`SLEEPINESS`]: SLEEPINESS 96 | #[macro_export] 97 | macro_rules! fallible { 98 | ($e:expr) => {{ 99 | fault_injection::maybe!($e)? 100 | }}; 101 | } 102 | 103 | /// Performs the same fault injection as [`fallible`] but does not 104 | /// early-return, and does not try to convert the injected 105 | /// `io::Error` using the `?` operator. 106 | /// 107 | /// [`fallible`]: fallible 108 | #[macro_export] 109 | macro_rules! maybe { 110 | ($e:expr) => {{ 111 | let sleepiness = fault_injection::SLEEPINESS.load(core::sync::atomic::Ordering::Acquire); 112 | if sleepiness > 0 { 113 | #[cfg(target_arch = "x86")] 114 | let rdtsc = unsafe { core::arch::x86::_rdtsc() as u16 }; 115 | 116 | #[cfg(target_arch = "x86_64")] 117 | let rdtsc = unsafe { core::arch::x86_64::_rdtsc() as u16 }; 118 | 119 | #[cfg(not(any(target_arch = "x86", target_arch = "x86_64")))] 120 | let rdtsc = 0b10_u16; 121 | 122 | let random_sleeps = rdtsc.trailing_zeros() as u32 * sleepiness; 123 | 124 | for _ in 0..random_sleeps { 125 | std::thread::yield_now(); 126 | } 127 | } 128 | 129 | const CRATE_NAME: &str = if let Some(name) = core::option_env!("CARGO_CRATE_NAME") { 130 | name 131 | } else { 132 | "" 133 | }; 134 | 135 | if fault_injection::FAULT_INJECT_COUNTER.fetch_sub(1, core::sync::atomic::Ordering::AcqRel) 136 | == 1 137 | { 138 | let trigger_fn = fault_injection::TRIGGER_FN.load(core::sync::atomic::Ordering::Acquire); 139 | if !trigger_fn.is_null() { 140 | unsafe { 141 | let f: &fault_injection::Trigger = std::mem::transmute(&trigger_fn); 142 | (f)(CRATE_NAME, file!(), line!()); 143 | } 144 | } 145 | 146 | Err(fault_injection::annotate!(std::io::Error::new( 147 | std::io::ErrorKind::Other, 148 | "injected fault", 149 | ))) 150 | } else { 151 | match $e { 152 | Ok(ok) => Ok(ok), 153 | Err(e) => Err(fault_injection::annotate!(e)), 154 | } 155 | } 156 | }}; 157 | } 158 | 159 | /// Annotates an io::Error with the crate, file, and line number 160 | /// where the annotation has been performed. 161 | #[macro_export] 162 | macro_rules! annotate { 163 | ($e:expr) => {{ 164 | const CRATE_NAME: &str = if let Some(name) = core::option_env!("CARGO_CRATE_NAME") { 165 | name 166 | } else { 167 | "" 168 | }; 169 | 170 | std::io::Error::new( 171 | $e.kind(), 172 | format!( 173 | "{}:{}:{} -> {}", 174 | CRATE_NAME, 175 | file!(), 176 | line!(), 177 | $e.to_string() 178 | ), 179 | ) 180 | }}; 181 | } 182 | --------------------------------------------------------------------------------