1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
// Copyright 2020 Shin Yoshida // // "LGPL-3.0-or-later OR Apache-2.0 OR BSD-2-Clause OR MIT" // // This is part of test-allocator // // test-allocator is free software: you can redistribute it and/or modify // it under the terms of the GNU Lesser General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // test-allocator is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU Lesser General Public License for more details. // // You should have received a copy of the GNU Lesser General Public License // along with test-allocator. If not, see <http://www.gnu.org/licenses/>. // // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // // // Redistribution and use in source and binary forms, with or without modification, are permitted // provided that the following conditions are met: // // 1. Redistributions of source code must retain the above copyright notice, this list of // conditions and the following disclaimer. // 2. Redistributions in binary form must reproduce the above copyright notice, this // list of conditions and the following disclaimer in the documentation and/or other // materials provided with the distribution. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND // ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED // WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. // IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, // INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT // NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE // POSSIBILITY OF SUCH DAMAGE. // // // Permission is hereby granted, free of charge, to any person obtaining a copy of this software // and associated documentation files (the "Software"), to deal in the Software without // restriction, including without limitation the rights to use, copy, modify, merge, publish, // distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the // Software is furnished to do so, subject to the following conditions: // // The above copyright notice and this permission notice (including the next paragraph) shall be // included in all copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING // BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, // DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. extern crate rand; use core::alloc::{GlobalAlloc, Layout}; use std::alloc::System; use std::collections::hash_map::HashMap; use std::fmt; use std::sync::{Arc, Mutex}; /// Alias to `TestAlloc<System>` . /// 'GAlloc' stands for `Gharial Alloc` pub type GAlloc = TestAlloc<System>; /// `TestAlloc` is a implementation for `GlobalAlloc` to test memory leak and so on. /// /// It is a wrapper of another `GlobalAlloc` , and delegates the requests to the inner after testing. /// /// The checks are followings. /// /// - The argument `*mut u8` passed to `dealloc` is not null. (The behavior is undefined /// according to `GlobalAlloc` interface.) /// - The consistency of the argument `Layout` . /// i.e. the argument passed to `dealloc` matches to that passed to `alloc` having returned /// the corresponding pointer. /// - All allocated memories have already been deallocated on the drop. /// (Note that cloned instances share the allocating memory information. The check is done when the /// last cloned instance is dropped.) /// /// See also [`GAlloc`] . It is an alias to `TestAlloc<std::alloc::System>` . pub struct TestAlloc<A> where A: GlobalAlloc, { alloc: A, allocatings: Arc<Mutex<HashMap<*mut u8, Layout>>>, } impl<A> Default for TestAlloc<A> where A: GlobalAlloc + Default, { fn default() -> Self { Self::from(A::default()) } } impl<A> From<A> for TestAlloc<A> where A: GlobalAlloc, { fn from(inner: A) -> Self { Self { alloc: inner, allocatings: Arc::default(), } } } impl<A> Clone for TestAlloc<A> where A: GlobalAlloc + Clone, { fn clone(&self) -> Self { Self { alloc: self.alloc.clone(), allocatings: self.allocatings.clone(), } } } impl<A> Drop for TestAlloc<A> where A: GlobalAlloc, { fn drop(&mut self) { if Arc::strong_count(&self.allocatings) == 1 { let allocatings = self.allocatings.lock().unwrap(); assert_eq!(true, allocatings.is_empty()); } } } unsafe impl<A> GlobalAlloc for TestAlloc<A> where A: GlobalAlloc, { unsafe fn alloc(&self, layout: Layout) -> *mut u8 { let ptr = self.alloc.alloc(layout); if !ptr.is_null() { let mut allocatings = self.allocatings.lock().unwrap(); let prev = allocatings.insert(ptr, layout); assert_eq!(true, prev.is_none()); } ptr } unsafe fn dealloc(&self, ptr: *mut u8, layout: Layout) { // `GlobalAlloc::dealloc` interface does not define the behavior when ptr is null. assert_eq!(false, ptr.is_null()); // Enclose to release the lock as soon as possible. { let mut allocatings = self.allocatings.lock().unwrap(); let prev = allocatings.remove(&ptr).unwrap(); assert_eq!(layout, prev); } self.alloc.dealloc(ptr, layout); } } impl<A> fmt::Debug for TestAlloc<A> where A: GlobalAlloc + fmt::Debug, { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { f.debug_struct("TestAlloc") .field("alloc", &self.alloc) .field("info", &format!("{:p}", self.allocatings)) .finish() } } // `Send` is not implemented automatically because the key type of the `allocating` (*mut u8) // does not implement `Send` . However, it is used as an integer and never to be dereferenced. // It is safe to implement `Send` manually. unsafe impl<A> Send for TestAlloc<A> where A: GlobalAlloc + Send {} // `Send` is not implemented automatically because the key type of the `allocating` (*mut u8) // does not implement `Send` . However, it is used as an integer and never to be dereferenced. // It is safe to implement `Send` manually. unsafe impl<A> Sync for TestAlloc<A> where A: GlobalAlloc + Send + Sync {} /// `NeverAlloc` is an implementation for `GlobalAlloc` , which always fails. /// For example, `NeverAlloc::alloc` always returns a null pointer. #[derive(Clone, Copy, Debug)] pub struct NeverAlloc; impl Default for NeverAlloc { fn default() -> Self { Self } } unsafe impl GlobalAlloc for NeverAlloc { unsafe fn alloc(&self, _layout: Layout) -> *mut u8 { core::ptr::null_mut() } unsafe fn dealloc(&self, _ptr: *mut u8, _layout: Layout) { assert!(false) } } /// `MaybeAlloc` is an implementation for `GlobalAlloc` , which occasionally fails to allocate. /// /// It is a wrapper of another `GlobalAlloc` , and delegates the requests to the inner, however, sometimes fails to allocate /// memory on purpose. i.e. `MaybeAlloc::alloc` can return null pointer before memory exhaustion. /// /// The failure properbility is 1/16. #[derive(Debug)] pub struct MaybeAlloc<A = TestAlloc<System>> where A: GlobalAlloc, { alloc: A, } impl<A> Default for MaybeAlloc<A> where A: GlobalAlloc + Default, { fn default() -> Self { Self::from(A::default()) } } impl<A> From<A> for MaybeAlloc<A> where A: GlobalAlloc, { fn from(alloc: A) -> Self { Self { alloc } } } impl<A> Clone for MaybeAlloc<A> where A: GlobalAlloc + Clone, { fn clone(&self) -> Self { Self::from(self.alloc.clone()) } } unsafe impl<A> GlobalAlloc for MaybeAlloc<A> where A: GlobalAlloc, { unsafe fn alloc(&self, layout: Layout) -> *mut u8 { if rand::random::<u8>() % 16 == 0 { core::ptr::null_mut() } else { self.alloc.alloc(layout) } } unsafe fn dealloc(&self, ptr: *mut u8, layout: Layout) { assert_eq!(false, ptr.is_null()); self.alloc.dealloc(ptr, layout); } }