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

// Copyright 2015-2019 Parity Technologies (UK) Ltd.
// This file is part of Parity.

// Parity is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// Parity 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 General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with Parity.  If not, see <http://www.gnu.org/licenses/>.

//! default allocator management
//! Features are:
//! - windows:
//!	 - no features: default implementation from servo `heapsize` crate
//!	 - weealloc: default to `estimate_size`
//!	 - dlmalloc: default to `estimate_size`
//!	 - jemalloc: default windows allocator is used instead
//! - arch x86:
//!	 - no features: use default alloc
//!	 - jemalloc: use jemallocator crate
//!	 - weealloc: default to `estimate_size`
//!	 - dlmalloc: default to `estimate_size`
//! - arch x86/macos:
//!	 - no features: use default alloc, requires using `estimate_size`
//!	 - jemalloc: use jemallocator crate
//!	 - weealloc: default to `estimate_size`
//!	 - dlmalloc: default to `estimate_size`
//! - arch wasm32:
//!	 - no features: default to `estimate_size`
//!	 - weealloc: default to `estimate_size`
//!	 - dlmalloc: default to `estimate_size`
//!	 - jemalloc: compile error


use malloc_size::{MallocSizeOfOps, VoidPtrToSizeFn, MallocSizeOf};
#[cfg(feature = "std")]
use malloc_size::MallocUnconditionalSizeOf;
#[cfg(feature = "std")]
use std::os::raw::c_void;
#[cfg(not(feature = "std"))]
use core::ffi::c_void;

mod usable_size {

	use super::*;

cfg_if! {

	if #[cfg(any(
		target_arch = "wasm32",
		feature = "estimate-heapsize",
		feature = "weealloc-global",
		feature = "dlmalloc-global",
	))] {

		// do not try system allocator

		/// Warning this is for compatibility only.
		/// This function does panic: `estimate-heapsize` feature needs to be activated
		/// to avoid this function call.
		pub unsafe extern "C" fn malloc_usable_size(_ptr: *const c_void) -> usize {
			unreachable!("estimate heapsize only")
		}

	} else if #[cfg(target_os = "windows")] {

		// default windows allocator
		extern crate winapi;

		use self::winapi::um::heapapi::{GetProcessHeap, HeapSize, HeapValidate};

		/// Get the size of a heap block.
		/// Call windows allocator through `winapi` crate
		pub unsafe extern "C" fn malloc_usable_size(mut ptr: *const c_void) -> usize {

			let heap = GetProcessHeap();

			if HeapValidate(heap, 0, ptr) == 0 {
				ptr = *(ptr as *const *const c_void).offset(-1);
			}

			HeapSize(heap, 0, ptr) as usize
		}

	} else if #[cfg(feature = "jemalloc-global")] {

		/// Use of jemalloc usable size C function through jemallocator crate call.
		pub unsafe extern "C" fn malloc_usable_size(ptr: *const c_void) -> usize {
			jemallocator::usable_size(ptr)
		}

	} else if #[cfg(target_os = "linux")] {

		/// Linux call system allocator (currently malloc).
		extern "C" {
			pub fn malloc_usable_size(ptr: *const c_void) -> usize;
		}

	} else {
		// default allocator for non linux or windows system use estimate
		pub unsafe extern "C" fn malloc_usable_size(_ptr: *const c_void) -> usize {
			unreachable!("estimate heapsize or feature allocator needed")
		}

	}

}

	/// No enclosing function defined.
	#[inline]
	pub fn new_enclosing_size_fn() -> Option<VoidPtrToSizeFn> {
		None
	}
}

/// Get a new instance of a MallocSizeOfOps
pub fn new_malloc_size_ops() -> MallocSizeOfOps {
	MallocSizeOfOps::new(
		usable_size::malloc_usable_size,
		usable_size::new_enclosing_size_fn(),
		None,
	)
}

/// Extension methods for `MallocSizeOf` trait, do not implement
/// directly.
/// It allows getting heapsize without exposing `MallocSizeOfOps` 
/// (a single default `MallocSizeOfOps` is used for each call).
pub trait MallocSizeOfExt: MallocSizeOf {
	/// Method to launch a heapsize measurement with a 
	/// fresh state.
	fn malloc_size_of(&self) -> usize {
		let mut ops = new_malloc_size_ops();
		<Self as MallocSizeOf>::size_of(self, &mut ops)
	}
}

impl<T: MallocSizeOf> MallocSizeOfExt for T { }

#[cfg(feature = "std")]
impl<T: MallocSizeOf> MallocSizeOf for std::sync::Arc<T> {
	fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize {
		self.unconditional_size_of(ops)
	}
}