annotate libsanitizer/sanitizer_common/sanitizer_allocator_primary32.h @ 118:fd00160c1b76

ifdef TARGET_64BIT
author mir3636
date Tue, 27 Feb 2018 15:01:35 +0900
parents 04ced10e8804
children 1830386684a0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
111
kono
parents:
diff changeset
1 //===-- sanitizer_allocator_primary32.h -------------------------*- C++ -*-===//
kono
parents:
diff changeset
2 //
kono
parents:
diff changeset
3 // This file is distributed under the University of Illinois Open Source
kono
parents:
diff changeset
4 // License. See LICENSE.TXT for details.
kono
parents:
diff changeset
5 //
kono
parents:
diff changeset
6 //===----------------------------------------------------------------------===//
kono
parents:
diff changeset
7 //
kono
parents:
diff changeset
8 // Part of the Sanitizer Allocator.
kono
parents:
diff changeset
9 //
kono
parents:
diff changeset
10 //===----------------------------------------------------------------------===//
kono
parents:
diff changeset
11 #ifndef SANITIZER_ALLOCATOR_H
kono
parents:
diff changeset
12 #error This file must be included inside sanitizer_allocator.h
kono
parents:
diff changeset
13 #endif
kono
parents:
diff changeset
14
kono
parents:
diff changeset
15 template<class SizeClassAllocator> struct SizeClassAllocator32LocalCache;
kono
parents:
diff changeset
16
kono
parents:
diff changeset
17 // SizeClassAllocator32 -- allocator for 32-bit address space.
kono
parents:
diff changeset
18 // This allocator can theoretically be used on 64-bit arch, but there it is less
kono
parents:
diff changeset
19 // efficient than SizeClassAllocator64.
kono
parents:
diff changeset
20 //
kono
parents:
diff changeset
21 // [kSpaceBeg, kSpaceBeg + kSpaceSize) is the range of addresses which can
kono
parents:
diff changeset
22 // be returned by MmapOrDie().
kono
parents:
diff changeset
23 //
kono
parents:
diff changeset
24 // Region:
kono
parents:
diff changeset
25 // a result of a single call to MmapAlignedOrDieOnFatalError(kRegionSize,
kono
parents:
diff changeset
26 // kRegionSize).
kono
parents:
diff changeset
27 // Since the regions are aligned by kRegionSize, there are exactly
kono
parents:
diff changeset
28 // kNumPossibleRegions possible regions in the address space and so we keep
kono
parents:
diff changeset
29 // a ByteMap possible_regions to store the size classes of each Region.
kono
parents:
diff changeset
30 // 0 size class means the region is not used by the allocator.
kono
parents:
diff changeset
31 //
kono
parents:
diff changeset
32 // One Region is used to allocate chunks of a single size class.
kono
parents:
diff changeset
33 // A Region looks like this:
kono
parents:
diff changeset
34 // UserChunk1 .. UserChunkN <gap> MetaChunkN .. MetaChunk1
kono
parents:
diff changeset
35 //
kono
parents:
diff changeset
36 // In order to avoid false sharing the objects of this class should be
kono
parents:
diff changeset
37 // chache-line aligned.
kono
parents:
diff changeset
38
kono
parents:
diff changeset
39 struct SizeClassAllocator32FlagMasks { // Bit masks.
kono
parents:
diff changeset
40 enum {
kono
parents:
diff changeset
41 kRandomShuffleChunks = 1,
kono
parents:
diff changeset
42 kUseSeparateSizeClassForBatch = 2,
kono
parents:
diff changeset
43 };
kono
parents:
diff changeset
44 };
kono
parents:
diff changeset
45
kono
parents:
diff changeset
46 template <class Params>
kono
parents:
diff changeset
47 class SizeClassAllocator32 {
kono
parents:
diff changeset
48 public:
kono
parents:
diff changeset
49 static const uptr kSpaceBeg = Params::kSpaceBeg;
kono
parents:
diff changeset
50 static const u64 kSpaceSize = Params::kSpaceSize;
kono
parents:
diff changeset
51 static const uptr kMetadataSize = Params::kMetadataSize;
kono
parents:
diff changeset
52 typedef typename Params::SizeClassMap SizeClassMap;
kono
parents:
diff changeset
53 static const uptr kRegionSizeLog = Params::kRegionSizeLog;
kono
parents:
diff changeset
54 typedef typename Params::ByteMap ByteMap;
kono
parents:
diff changeset
55 typedef typename Params::MapUnmapCallback MapUnmapCallback;
kono
parents:
diff changeset
56
kono
parents:
diff changeset
57 static const bool kRandomShuffleChunks = Params::kFlags &
kono
parents:
diff changeset
58 SizeClassAllocator32FlagMasks::kRandomShuffleChunks;
kono
parents:
diff changeset
59 static const bool kUseSeparateSizeClassForBatch = Params::kFlags &
kono
parents:
diff changeset
60 SizeClassAllocator32FlagMasks::kUseSeparateSizeClassForBatch;
kono
parents:
diff changeset
61
kono
parents:
diff changeset
62 struct TransferBatch {
kono
parents:
diff changeset
63 static const uptr kMaxNumCached = SizeClassMap::kMaxNumCachedHint - 2;
kono
parents:
diff changeset
64 void SetFromArray(uptr region_beg_unused, void *batch[], uptr count) {
kono
parents:
diff changeset
65 count_ = count;
kono
parents:
diff changeset
66 CHECK_LE(count_, kMaxNumCached);
kono
parents:
diff changeset
67 for (uptr i = 0; i < count; i++)
kono
parents:
diff changeset
68 batch_[i] = batch[i];
kono
parents:
diff changeset
69 }
kono
parents:
diff changeset
70 uptr Count() const { return count_; }
kono
parents:
diff changeset
71 void Clear() { count_ = 0; }
kono
parents:
diff changeset
72 void Add(void *ptr) {
kono
parents:
diff changeset
73 batch_[count_++] = ptr;
kono
parents:
diff changeset
74 CHECK_LE(count_, kMaxNumCached);
kono
parents:
diff changeset
75 }
kono
parents:
diff changeset
76 void CopyToArray(void *to_batch[]) {
kono
parents:
diff changeset
77 for (uptr i = 0, n = Count(); i < n; i++)
kono
parents:
diff changeset
78 to_batch[i] = batch_[i];
kono
parents:
diff changeset
79 }
kono
parents:
diff changeset
80
kono
parents:
diff changeset
81 // How much memory do we need for a batch containing n elements.
kono
parents:
diff changeset
82 static uptr AllocationSizeRequiredForNElements(uptr n) {
kono
parents:
diff changeset
83 return sizeof(uptr) * 2 + sizeof(void *) * n;
kono
parents:
diff changeset
84 }
kono
parents:
diff changeset
85 static uptr MaxCached(uptr class_id) {
kono
parents:
diff changeset
86 return Min(kMaxNumCached, SizeClassMap::MaxCachedHint(class_id));
kono
parents:
diff changeset
87 }
kono
parents:
diff changeset
88
kono
parents:
diff changeset
89 TransferBatch *next;
kono
parents:
diff changeset
90
kono
parents:
diff changeset
91 private:
kono
parents:
diff changeset
92 uptr count_;
kono
parents:
diff changeset
93 void *batch_[kMaxNumCached];
kono
parents:
diff changeset
94 };
kono
parents:
diff changeset
95
kono
parents:
diff changeset
96 static const uptr kBatchSize = sizeof(TransferBatch);
kono
parents:
diff changeset
97 COMPILER_CHECK((kBatchSize & (kBatchSize - 1)) == 0);
kono
parents:
diff changeset
98 COMPILER_CHECK(kBatchSize == SizeClassMap::kMaxNumCachedHint * sizeof(uptr));
kono
parents:
diff changeset
99
kono
parents:
diff changeset
100 static uptr ClassIdToSize(uptr class_id) {
kono
parents:
diff changeset
101 return (class_id == SizeClassMap::kBatchClassID) ?
kono
parents:
diff changeset
102 kBatchSize : SizeClassMap::Size(class_id);
kono
parents:
diff changeset
103 }
kono
parents:
diff changeset
104
kono
parents:
diff changeset
105 typedef SizeClassAllocator32<Params> ThisT;
kono
parents:
diff changeset
106 typedef SizeClassAllocator32LocalCache<ThisT> AllocatorCache;
kono
parents:
diff changeset
107
kono
parents:
diff changeset
108 void Init(s32 release_to_os_interval_ms) {
kono
parents:
diff changeset
109 possible_regions.TestOnlyInit();
kono
parents:
diff changeset
110 internal_memset(size_class_info_array, 0, sizeof(size_class_info_array));
kono
parents:
diff changeset
111 }
kono
parents:
diff changeset
112
kono
parents:
diff changeset
113 s32 ReleaseToOSIntervalMs() const {
kono
parents:
diff changeset
114 return kReleaseToOSIntervalNever;
kono
parents:
diff changeset
115 }
kono
parents:
diff changeset
116
kono
parents:
diff changeset
117 void SetReleaseToOSIntervalMs(s32 release_to_os_interval_ms) {
kono
parents:
diff changeset
118 // This is empty here. Currently only implemented in 64-bit allocator.
kono
parents:
diff changeset
119 }
kono
parents:
diff changeset
120
kono
parents:
diff changeset
121 void *MapWithCallback(uptr size) {
kono
parents:
diff changeset
122 void *res = MmapOrDie(size, "SizeClassAllocator32");
kono
parents:
diff changeset
123 MapUnmapCallback().OnMap((uptr)res, size);
kono
parents:
diff changeset
124 return res;
kono
parents:
diff changeset
125 }
kono
parents:
diff changeset
126
kono
parents:
diff changeset
127 void UnmapWithCallback(uptr beg, uptr size) {
kono
parents:
diff changeset
128 MapUnmapCallback().OnUnmap(beg, size);
kono
parents:
diff changeset
129 UnmapOrDie(reinterpret_cast<void *>(beg), size);
kono
parents:
diff changeset
130 }
kono
parents:
diff changeset
131
kono
parents:
diff changeset
132 static bool CanAllocate(uptr size, uptr alignment) {
kono
parents:
diff changeset
133 return size <= SizeClassMap::kMaxSize &&
kono
parents:
diff changeset
134 alignment <= SizeClassMap::kMaxSize;
kono
parents:
diff changeset
135 }
kono
parents:
diff changeset
136
kono
parents:
diff changeset
137 void *GetMetaData(const void *p) {
kono
parents:
diff changeset
138 CHECK(PointerIsMine(p));
kono
parents:
diff changeset
139 uptr mem = reinterpret_cast<uptr>(p);
kono
parents:
diff changeset
140 uptr beg = ComputeRegionBeg(mem);
kono
parents:
diff changeset
141 uptr size = ClassIdToSize(GetSizeClass(p));
kono
parents:
diff changeset
142 u32 offset = mem - beg;
kono
parents:
diff changeset
143 uptr n = offset / (u32)size; // 32-bit division
kono
parents:
diff changeset
144 uptr meta = (beg + kRegionSize) - (n + 1) * kMetadataSize;
kono
parents:
diff changeset
145 return reinterpret_cast<void*>(meta);
kono
parents:
diff changeset
146 }
kono
parents:
diff changeset
147
kono
parents:
diff changeset
148 NOINLINE TransferBatch *AllocateBatch(AllocatorStats *stat, AllocatorCache *c,
kono
parents:
diff changeset
149 uptr class_id) {
kono
parents:
diff changeset
150 CHECK_LT(class_id, kNumClasses);
kono
parents:
diff changeset
151 SizeClassInfo *sci = GetSizeClassInfo(class_id);
kono
parents:
diff changeset
152 SpinMutexLock l(&sci->mutex);
kono
parents:
diff changeset
153 if (sci->free_list.empty() &&
kono
parents:
diff changeset
154 UNLIKELY(!PopulateFreeList(stat, c, sci, class_id)))
kono
parents:
diff changeset
155 return nullptr;
kono
parents:
diff changeset
156 CHECK(!sci->free_list.empty());
kono
parents:
diff changeset
157 TransferBatch *b = sci->free_list.front();
kono
parents:
diff changeset
158 sci->free_list.pop_front();
kono
parents:
diff changeset
159 return b;
kono
parents:
diff changeset
160 }
kono
parents:
diff changeset
161
kono
parents:
diff changeset
162 NOINLINE void DeallocateBatch(AllocatorStats *stat, uptr class_id,
kono
parents:
diff changeset
163 TransferBatch *b) {
kono
parents:
diff changeset
164 CHECK_LT(class_id, kNumClasses);
kono
parents:
diff changeset
165 CHECK_GT(b->Count(), 0);
kono
parents:
diff changeset
166 SizeClassInfo *sci = GetSizeClassInfo(class_id);
kono
parents:
diff changeset
167 SpinMutexLock l(&sci->mutex);
kono
parents:
diff changeset
168 sci->free_list.push_front(b);
kono
parents:
diff changeset
169 }
kono
parents:
diff changeset
170
kono
parents:
diff changeset
171 uptr GetRegionBeginBySizeClass(uptr class_id) { return 0; }
kono
parents:
diff changeset
172
kono
parents:
diff changeset
173 bool PointerIsMine(const void *p) {
kono
parents:
diff changeset
174 uptr mem = reinterpret_cast<uptr>(p);
kono
parents:
diff changeset
175 if (mem < kSpaceBeg || mem >= kSpaceBeg + kSpaceSize)
kono
parents:
diff changeset
176 return false;
kono
parents:
diff changeset
177 return GetSizeClass(p) != 0;
kono
parents:
diff changeset
178 }
kono
parents:
diff changeset
179
kono
parents:
diff changeset
180 uptr GetSizeClass(const void *p) {
kono
parents:
diff changeset
181 return possible_regions[ComputeRegionId(reinterpret_cast<uptr>(p))];
kono
parents:
diff changeset
182 }
kono
parents:
diff changeset
183
kono
parents:
diff changeset
184 void *GetBlockBegin(const void *p) {
kono
parents:
diff changeset
185 CHECK(PointerIsMine(p));
kono
parents:
diff changeset
186 uptr mem = reinterpret_cast<uptr>(p);
kono
parents:
diff changeset
187 uptr beg = ComputeRegionBeg(mem);
kono
parents:
diff changeset
188 uptr size = ClassIdToSize(GetSizeClass(p));
kono
parents:
diff changeset
189 u32 offset = mem - beg;
kono
parents:
diff changeset
190 u32 n = offset / (u32)size; // 32-bit division
kono
parents:
diff changeset
191 uptr res = beg + (n * (u32)size);
kono
parents:
diff changeset
192 return reinterpret_cast<void*>(res);
kono
parents:
diff changeset
193 }
kono
parents:
diff changeset
194
kono
parents:
diff changeset
195 uptr GetActuallyAllocatedSize(void *p) {
kono
parents:
diff changeset
196 CHECK(PointerIsMine(p));
kono
parents:
diff changeset
197 return ClassIdToSize(GetSizeClass(p));
kono
parents:
diff changeset
198 }
kono
parents:
diff changeset
199
kono
parents:
diff changeset
200 uptr ClassID(uptr size) { return SizeClassMap::ClassID(size); }
kono
parents:
diff changeset
201
kono
parents:
diff changeset
202 uptr TotalMemoryUsed() {
kono
parents:
diff changeset
203 // No need to lock here.
kono
parents:
diff changeset
204 uptr res = 0;
kono
parents:
diff changeset
205 for (uptr i = 0; i < kNumPossibleRegions; i++)
kono
parents:
diff changeset
206 if (possible_regions[i])
kono
parents:
diff changeset
207 res += kRegionSize;
kono
parents:
diff changeset
208 return res;
kono
parents:
diff changeset
209 }
kono
parents:
diff changeset
210
kono
parents:
diff changeset
211 void TestOnlyUnmap() {
kono
parents:
diff changeset
212 for (uptr i = 0; i < kNumPossibleRegions; i++)
kono
parents:
diff changeset
213 if (possible_regions[i])
kono
parents:
diff changeset
214 UnmapWithCallback((i * kRegionSize), kRegionSize);
kono
parents:
diff changeset
215 }
kono
parents:
diff changeset
216
kono
parents:
diff changeset
217 // ForceLock() and ForceUnlock() are needed to implement Darwin malloc zone
kono
parents:
diff changeset
218 // introspection API.
kono
parents:
diff changeset
219 void ForceLock() {
kono
parents:
diff changeset
220 for (uptr i = 0; i < kNumClasses; i++) {
kono
parents:
diff changeset
221 GetSizeClassInfo(i)->mutex.Lock();
kono
parents:
diff changeset
222 }
kono
parents:
diff changeset
223 }
kono
parents:
diff changeset
224
kono
parents:
diff changeset
225 void ForceUnlock() {
kono
parents:
diff changeset
226 for (int i = kNumClasses - 1; i >= 0; i--) {
kono
parents:
diff changeset
227 GetSizeClassInfo(i)->mutex.Unlock();
kono
parents:
diff changeset
228 }
kono
parents:
diff changeset
229 }
kono
parents:
diff changeset
230
kono
parents:
diff changeset
231 // Iterate over all existing chunks.
kono
parents:
diff changeset
232 // The allocator must be locked when calling this function.
kono
parents:
diff changeset
233 void ForEachChunk(ForEachChunkCallback callback, void *arg) {
kono
parents:
diff changeset
234 for (uptr region = 0; region < kNumPossibleRegions; region++)
kono
parents:
diff changeset
235 if (possible_regions[region]) {
kono
parents:
diff changeset
236 uptr chunk_size = ClassIdToSize(possible_regions[region]);
kono
parents:
diff changeset
237 uptr max_chunks_in_region = kRegionSize / (chunk_size + kMetadataSize);
kono
parents:
diff changeset
238 uptr region_beg = region * kRegionSize;
kono
parents:
diff changeset
239 for (uptr chunk = region_beg;
kono
parents:
diff changeset
240 chunk < region_beg + max_chunks_in_region * chunk_size;
kono
parents:
diff changeset
241 chunk += chunk_size) {
kono
parents:
diff changeset
242 // Too slow: CHECK_EQ((void *)chunk, GetBlockBegin((void *)chunk));
kono
parents:
diff changeset
243 callback(chunk, arg);
kono
parents:
diff changeset
244 }
kono
parents:
diff changeset
245 }
kono
parents:
diff changeset
246 }
kono
parents:
diff changeset
247
kono
parents:
diff changeset
248 void PrintStats() {
kono
parents:
diff changeset
249 }
kono
parents:
diff changeset
250
kono
parents:
diff changeset
251 static uptr AdditionalSize() {
kono
parents:
diff changeset
252 return 0;
kono
parents:
diff changeset
253 }
kono
parents:
diff changeset
254
kono
parents:
diff changeset
255 typedef SizeClassMap SizeClassMapT;
kono
parents:
diff changeset
256 static const uptr kNumClasses = SizeClassMap::kNumClasses;
kono
parents:
diff changeset
257
kono
parents:
diff changeset
258 private:
kono
parents:
diff changeset
259 static const uptr kRegionSize = 1 << kRegionSizeLog;
kono
parents:
diff changeset
260 static const uptr kNumPossibleRegions = kSpaceSize / kRegionSize;
kono
parents:
diff changeset
261
kono
parents:
diff changeset
262 struct SizeClassInfo {
kono
parents:
diff changeset
263 SpinMutex mutex;
kono
parents:
diff changeset
264 IntrusiveList<TransferBatch> free_list;
kono
parents:
diff changeset
265 char padding[kCacheLineSize - sizeof(uptr) -
kono
parents:
diff changeset
266 sizeof(IntrusiveList<TransferBatch>)];
kono
parents:
diff changeset
267 };
kono
parents:
diff changeset
268 COMPILER_CHECK(sizeof(SizeClassInfo) == kCacheLineSize);
kono
parents:
diff changeset
269
kono
parents:
diff changeset
270 uptr ComputeRegionId(uptr mem) {
kono
parents:
diff changeset
271 uptr res = mem >> kRegionSizeLog;
kono
parents:
diff changeset
272 CHECK_LT(res, kNumPossibleRegions);
kono
parents:
diff changeset
273 return res;
kono
parents:
diff changeset
274 }
kono
parents:
diff changeset
275
kono
parents:
diff changeset
276 uptr ComputeRegionBeg(uptr mem) {
kono
parents:
diff changeset
277 return mem & ~(kRegionSize - 1);
kono
parents:
diff changeset
278 }
kono
parents:
diff changeset
279
kono
parents:
diff changeset
280 uptr AllocateRegion(AllocatorStats *stat, uptr class_id) {
kono
parents:
diff changeset
281 CHECK_LT(class_id, kNumClasses);
kono
parents:
diff changeset
282 uptr res = reinterpret_cast<uptr>(MmapAlignedOrDieOnFatalError(
kono
parents:
diff changeset
283 kRegionSize, kRegionSize, "SizeClassAllocator32"));
kono
parents:
diff changeset
284 if (UNLIKELY(!res))
kono
parents:
diff changeset
285 return 0;
kono
parents:
diff changeset
286 MapUnmapCallback().OnMap(res, kRegionSize);
kono
parents:
diff changeset
287 stat->Add(AllocatorStatMapped, kRegionSize);
kono
parents:
diff changeset
288 CHECK(IsAligned(res, kRegionSize));
kono
parents:
diff changeset
289 possible_regions.set(ComputeRegionId(res), static_cast<u8>(class_id));
kono
parents:
diff changeset
290 return res;
kono
parents:
diff changeset
291 }
kono
parents:
diff changeset
292
kono
parents:
diff changeset
293 SizeClassInfo *GetSizeClassInfo(uptr class_id) {
kono
parents:
diff changeset
294 CHECK_LT(class_id, kNumClasses);
kono
parents:
diff changeset
295 return &size_class_info_array[class_id];
kono
parents:
diff changeset
296 }
kono
parents:
diff changeset
297
kono
parents:
diff changeset
298 bool PopulateFreeList(AllocatorStats *stat, AllocatorCache *c,
kono
parents:
diff changeset
299 SizeClassInfo *sci, uptr class_id) {
kono
parents:
diff changeset
300 uptr size = ClassIdToSize(class_id);
kono
parents:
diff changeset
301 uptr reg = AllocateRegion(stat, class_id);
kono
parents:
diff changeset
302 if (UNLIKELY(!reg))
kono
parents:
diff changeset
303 return false;
kono
parents:
diff changeset
304 uptr n_chunks = kRegionSize / (size + kMetadataSize);
kono
parents:
diff changeset
305 uptr max_count = TransferBatch::MaxCached(class_id);
kono
parents:
diff changeset
306 CHECK_GT(max_count, 0);
kono
parents:
diff changeset
307 TransferBatch *b = nullptr;
kono
parents:
diff changeset
308 for (uptr i = reg; i < reg + n_chunks * size; i += size) {
kono
parents:
diff changeset
309 if (!b) {
kono
parents:
diff changeset
310 b = c->CreateBatch(class_id, this, (TransferBatch*)i);
kono
parents:
diff changeset
311 if (UNLIKELY(!b))
kono
parents:
diff changeset
312 return false;
kono
parents:
diff changeset
313 b->Clear();
kono
parents:
diff changeset
314 }
kono
parents:
diff changeset
315 b->Add((void*)i);
kono
parents:
diff changeset
316 if (b->Count() == max_count) {
kono
parents:
diff changeset
317 sci->free_list.push_back(b);
kono
parents:
diff changeset
318 b = nullptr;
kono
parents:
diff changeset
319 }
kono
parents:
diff changeset
320 }
kono
parents:
diff changeset
321 if (b) {
kono
parents:
diff changeset
322 CHECK_GT(b->Count(), 0);
kono
parents:
diff changeset
323 sci->free_list.push_back(b);
kono
parents:
diff changeset
324 }
kono
parents:
diff changeset
325 return true;
kono
parents:
diff changeset
326 }
kono
parents:
diff changeset
327
kono
parents:
diff changeset
328 ByteMap possible_regions;
kono
parents:
diff changeset
329 SizeClassInfo size_class_info_array[kNumClasses];
kono
parents:
diff changeset
330 };