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 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
//! Information about the run-time jemalloc configuration. //! //! These settings are controlled by the `MALLOC_CONF` environment variable. use std::io; use std::os::raw::{c_char, c_uint}; use {get, get_bool, get_bool_mib, get_mib, get_str, get_str_mib, name_to_mib}; const ABORT: *const c_char = b"opt.abort\0" as *const _ as *const _; /// Determines if jemalloc will call `abort(3)` on most warnings. /// /// This is disabled by default unless `--enable-debug` was specified during build configuration. /// /// # Examples /// /// ``` /// println!("abort on warning: {}", jemalloc_ctl::opt::abort().unwrap()); /// ``` pub fn abort() -> io::Result<bool> { unsafe { get_bool(ABORT) } } /// A type determining if jemalloc will call `abort(3)` on most warnings. /// /// This is disabled by default unless `--enable-debug` was specified during build configuration. /// /// # Examples /// /// ``` /// use jemalloc_ctl::opt::Abort; /// /// let abort = Abort::new().unwrap(); /// /// println!("abort on warning: {}", abort.get().unwrap()); /// ``` pub struct Abort([usize; 2]); impl Abort { /// Returns a new `Abort`. pub fn new() -> io::Result<Abort> { unsafe { let mut mib = [0; 2]; name_to_mib(ABORT, &mut mib)?; Ok(Abort(mib)) } } /// Returns the abort-on-warning behavior. pub fn get(&self) -> io::Result<bool> { unsafe { get_bool_mib(&self.0) } } } const DSS: *const c_char = b"opt.dss\0" as *const _ as *const _; /// Returns the dss (`sbrk(2)`) allocation precedence as related to `mmap(2)` allocation. /// /// The following settings are supported if `sbrk(2)` is supported by the operating system: /// "disabled", "primary", and "secondary"; otherwise only "disabled" is supported. The default is /// "secondary" if `sbrk(2)` is supported by the operating system; "disabled" otherwise. /// /// # Examples /// /// ``` /// println!("dss priority: {}", jemalloc_ctl::opt::dss().unwrap()); /// ``` pub fn dss() -> io::Result<&'static str> { unsafe { get_str(DSS) } } /// A type providing access to the dss (`sbrk(2)`) allocation precedence as related to `mmap(2)` /// allocation. /// /// The following settings are supported if `sbrk(2)` is supported by the operating system: /// "disabled", "primary", and "secondary"; otherwise only "disabled" is supported. The default is /// "secondary" if `sbrk(2)` is supported by the operating system; "disabled" otherwise. /// /// # Examples /// /// ``` /// use jemalloc_ctl::opt::Dss; /// /// let dss = Dss::new().unwrap(); /// /// println!("dss priority: {}", dss.get().unwrap()); /// ``` #[derive(Copy, Clone)] pub struct Dss([usize; 2]); impl Dss { /// Returns a new `Dss`. pub fn new() -> io::Result<Dss> { unsafe { let mut mib = [0; 2]; name_to_mib(DSS, &mut mib)?; Ok(Dss(mib)) } } /// Returns the dss allocation precedence. pub fn get(&self) -> io::Result<&'static str> { unsafe { get_str_mib(&self.0) } } } const NARENAS: *const c_char = b"opt.narenas\0" as *const _ as *const _; /// Returns the maximum number of arenas to use for automatic multiplexing of threads and arenas. /// /// The default is four times the number of CPUs, or one if there is a single CPU. /// /// # Examples /// /// ``` /// println!("number of arenas: {}", jemalloc_ctl::opt::narenas().unwrap()); /// ``` pub fn narenas() -> io::Result<c_uint> { unsafe { get(NARENAS) } } /// A type providing access to the maximum number of arenas to use for automatic multiplexing of /// threads and arenas. /// /// The default is four times the number of CPUs, or one if there is a single CPU. /// /// # Examples /// /// ``` /// use jemalloc_ctl::opt::NArenas; /// /// let narenas = NArenas::new().unwrap(); /// /// println!("number of arenas: {}", narenas.get().unwrap()); /// ``` #[derive(Copy, Clone)] pub struct NArenas([usize; 2]); impl NArenas { /// Returns a new `NArenas`. pub fn new() -> io::Result<NArenas> { unsafe { let mut mib = [0; 2]; name_to_mib(NARENAS, &mut mib)?; Ok(NArenas(mib)) } } /// Returns the maximum number of arenas. pub fn get(&self) -> io::Result<c_uint> { unsafe { get_mib(&self.0) } } } const JUNK: *const c_char = b"opt.junk\0" as *const _ as *const _; /// Returns jemalloc's junk filling mode. /// /// Requires `--enable-fill` to have been specified during build configuration. /// /// If set to "alloc", each byte of uninitialized allocated memory will be set to `0x5a`. If set to /// "free", each byte of deallocated memory will be set to `0x5a`. If set to "true", both allocated /// and deallocated memory will be initialized, and if set to "false" junk filling will be disabled. /// This is intended for debugging and will impact performance negatively. /// /// The default is "false", unless `--enable-debug` was specified during build configuration, in /// which case the default is "true". /// /// # Examples /// /// ``` /// println!("junk filling: {}", jemalloc_ctl::opt::junk().unwrap()); /// ``` pub fn junk() -> io::Result<&'static str> { unsafe { get_str(JUNK) } } /// A type providing access to jemalloc's junk filling mode. /// /// Requires `--enable-fill` to have been specified during build configuration. /// /// If set to "alloc", each byte of uninitialized allocated memory will be set to `0x5a`. If set to /// "free", each byte of deallocated memory will be set to `0x5a`. If set to "true", both allocated /// and deallocated memory will be initialized, and if set to "false" junk filling will be disabled. /// This is intended for debugging and will impact performance negatively. /// /// The default is "false", unless `--enable-debug` was specified during build configuration, in /// which case the default is "true". /// /// # Examples /// /// ``` /// use jemalloc_ctl::opt::Junk; /// /// let junk = Junk::new().unwrap(); /// /// println!("junk filling: {}", junk.get().unwrap()); /// ``` #[derive(Copy, Clone)] pub struct Junk([usize; 2]); impl Junk { /// Returns a new `Junk`. pub fn new() -> io::Result<Junk> { unsafe { let mut mib = [0; 2]; name_to_mib(JUNK, &mut mib)?; Ok(Junk(mib)) } } /// Returns jemalloc's junk filling mode. pub fn get(&self) -> io::Result<&'static str> { unsafe { get_str_mib(&self.0) } } } const ZERO: *const c_char = b"opt.zero\0" as *const _ as *const _; /// Returns jemalloc's zeroing behavior. /// /// Requires `--enable-fill` to have been specified during build configuration. /// /// If enabled, jemalloc will initialize each byte of uninitialized allocated memory to 0. This is /// intended for debugging and will impact performance negatively. It is disabled by default. /// /// # Examples /// /// ``` /// println!("zeroing: {}", jemalloc_ctl::opt::zero().unwrap()); /// ``` pub fn zero() -> io::Result<bool> { unsafe { get_bool(ZERO) } } /// A type providing access to jemalloc's zeroing behavior. /// /// Requires `--enable-fill` to have been specified during build configuration. /// /// If enabled, jemalloc will initialize each byte of uninitialized allocated memory to 0. This is /// intended for debugging and will impact performance negatively. It is disabled by default. /// /// # Examples /// /// ``` /// use jemalloc_ctl::opt::Zero; /// /// let zero = Zero::new().unwrap(); /// /// println!("zeroing: {}", zero.get().unwrap()); /// ``` pub struct Zero([usize; 2]); impl Zero { /// Returns a new `Zero`. pub fn new() -> io::Result<Zero> { unsafe { let mut mib = [0; 2]; name_to_mib(ZERO, &mut mib)?; Ok(Zero(mib)) } } /// Returns the jemalloc zeroing behavior. pub fn get(&self) -> io::Result<bool> { unsafe { get_bool_mib(&self.0) } } } const TCACHE: *const c_char = b"opt.tcache\0" as *const _ as *const _; /// Determines if thread-local allocation caching is enabled. /// /// Thread-specific caching allows many allocations to be satisfied without performing any thread /// synchronization, at the cost of increased memory use. This is enabled by default. /// /// # Examples /// /// ``` /// println!("thread-local caching: {}", jemalloc_ctl::opt::tcache().unwrap()); /// ``` pub fn tcache() -> io::Result<bool> { unsafe { get_bool(TCACHE) } } /// A type providing access to thread-local allocation caching behavior. /// /// Thread-specific caching allows many allocations to be satisfied without performing any thread /// synchronization, at the cost of increased memory use. This is enabled by default. /// /// # Examples /// /// ``` /// use jemalloc_ctl::opt::Tcache; /// /// let tcache = Tcache::new().unwrap(); /// /// println!("thread-local caching: {}", tcache.get().unwrap()); /// ``` pub struct Tcache([usize; 2]); impl Tcache { /// Returns a new `Tcache`. pub fn new() -> io::Result<Tcache> { unsafe { let mut mib = [0; 2]; name_to_mib(TCACHE, &mut mib)?; Ok(Tcache(mib)) } } /// Returns the thread-local caching behavior. pub fn get(&self) -> io::Result<bool> { unsafe { get_bool_mib(&self.0) } } } const LG_TCACHE_MAX: *const c_char = b"opt.lg_tcache_max\0" as *const _ as *const _; /// Returns the maximum size class (log base 2) to cache in the thread-specific cache (tcache). /// /// At a minimum, all small size classes are cached, and at a maximum all large size classes are /// cached. The default maximum is 32 KiB (2^15). /// /// # Examples /// /// ``` /// println!("max cached allocation size: {}", 1 << jemalloc_ctl::opt::lg_tcache_max().unwrap()); /// ``` pub fn lg_tcache_max() -> io::Result<usize> { unsafe { get(LG_TCACHE_MAX) } } /// A type providing access to the maximum size class (log base 2) to cache in the thread-specific /// cache (tcache). /// /// At a minimum, all small size classes are cached, and at a maximum all large size classes are /// cached. The default maximum is 32 KiB (2^15). /// /// # Examples /// /// ``` /// use jemalloc_ctl::opt::LgTcacheMax; /// /// let lg_tcache_max = LgTcacheMax::new().unwrap(); /// /// println!("max cached allocation size: {}", 1 << lg_tcache_max.get().unwrap()); /// ``` #[derive(Copy, Clone)] pub struct LgTcacheMax([usize; 2]); impl LgTcacheMax { /// Returns a new `LgTcacheMax`. pub fn new() -> io::Result<LgTcacheMax> { unsafe { let mut mib = [0; 2]; name_to_mib(LG_TCACHE_MAX, &mut mib)?; Ok(LgTcacheMax(mib)) } } /// Returns the maximum cached size class. pub fn get(&self) -> io::Result<usize> { unsafe { get_mib(&self.0) } } }