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
// Copyright 2020 Xavier Gillard // // 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 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. //! This module provides a dead simple low-overhead wrapper around the system //! allocator which lets a program know its own memory consumption and peak //! memory consumption at runtime. use std::alloc::{GlobalAlloc, Layout, System}; use std::sync::atomic::{AtomicUsize, Ordering}; /// This atomic counter monitors the amount of memory (in bytes) that is /// currently allocated for this process. static CURRENT: AtomicUsize = AtomicUsize::new(0); /// This atomic counter monitors the maximum amount of memory (in bytes) that /// has been allocated for this process over the course of its life. static PEAK : AtomicUsize = AtomicUsize::new(0); /// This structure implements a dead simple low-overhead wrapper around the /// system allocator. It lets a program know its own memory and peak memory /// consumption at runtime. /// /// # Note /// The peak allocator is really just a shim around the system allocator. The /// bulk of its work is delegated to the system allocator and all `PeakAlloc` /// does is to maintain the atomic counters. /// /// # Example /// To make use of the PeakAllocator, all you need to do, is to declare a static /// instance of it, and annotate it with the `#[global_allocator]` attribute. /// Then, in your main module (or anywhere else in your code where it is deemed /// useful), you just call methods on the static variable you declared. /// /// ``` /// use peak_alloc::PeakAlloc; /// /// #[global_allocator] /// static PEAK_ALLOC: PeakAlloc = PeakAlloc; /// /// fn main() { /// // Do your funky stuff... /// /// let current_mem = PEAK_ALLOC.current_usage_as_mb(); /// println!("This program currently uses {} MB of RAM.", current_mem); /// let peak_mem = PEAK_ALLOC.peak_usage_as_gb(); /// println!("The max amount that was used {}", peak_mem); /// } /// ``` #[derive(Debug, Default, Copy, Clone)] pub struct PeakAlloc; impl PeakAlloc { /// Returns the number of bytes that are currently allocated to the process pub fn current_usage(&self) -> usize { CURRENT.load(Ordering::SeqCst) } /// Returns the maximum number of bytes that have been allocated to the /// process over the course of its life. pub fn peak_usage(&self) -> usize { PEAK.load(Ordering::SeqCst) } /// Returns the amount of memory (in kb) that is currently allocated /// to the process. pub fn current_usage_as_kb(&self) -> f32 { Self::kb(self.current_usage()) } /// Returns the amount of memory (in mb) that is currently allocated /// to the process. pub fn current_usage_as_mb(&self) -> f32 { Self::mb(self.current_usage()) } /// Returns the amount of memory (in gb) that is currently allocated /// to the process. pub fn current_usage_as_gb(&self) -> f32 { Self::gb(self.current_usage()) } /// Returns the maximum quantity of memory (in kb) that have been allocated /// to the process over the course of its life. pub fn peak_usage_as_kb(&self) -> f32 { Self::kb(self.peak_usage()) } /// Returns the maximum quantity of memory (in mb) that have been allocated /// to the process over the course of its life. pub fn peak_usage_as_mb(&self) -> f32 { Self::mb(self.peak_usage()) } /// Returns the maximum quantity of memory (in gb) that have been allocated /// to the process over the course of its life. pub fn peak_usage_as_gb(&self) -> f32 { Self::gb(self.peak_usage()) } /// Performs the bytes to kilobytes conversion fn kb(x: usize) -> f32 { x as f32 / 1024.0 } /// Performs the bytes to megabytes conversion fn mb(x: usize) -> f32 { x as f32 / (1024.0 * 1024.0) } /// Performs the bytes to gigabytes conversion fn gb(x: usize) -> f32 { x as f32 / (1024.0 * 1024.0 * 1024.0) } } /// PeakAlloc only implements the minimum required set of methods to make it /// useable as a global allocator (with `#[global_allocator]` attribute). /// /// No funky stuff is done below. unsafe impl GlobalAlloc for PeakAlloc { unsafe fn alloc(&self, layout: Layout) -> *mut u8 { let ret = System.alloc(layout); if !ret.is_null() { CURRENT.fetch_add(layout.size(), Ordering::SeqCst); PEAK.fetch_max(CURRENT.load(Ordering::SeqCst), Ordering::SeqCst); } ret } unsafe fn dealloc(&self, ptr: *mut u8, layout: Layout) { System.dealloc(ptr, layout); CURRENT.fetch_sub(layout.size(), Ordering::SeqCst); } }