1 //===-- asan_allocator.h ----------------------------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file is a part of AddressSanitizer, an address sanity checker.
10 //
11 // ASan-private header for asan_allocator.cpp.
12 //===----------------------------------------------------------------------===//
13
14 #ifndef ASAN_ALLOCATOR_H
15 #define ASAN_ALLOCATOR_H
16
17 #include "asan_flags.h"
18 #include "asan_interceptors.h"
19 #include "asan_internal.h"
20 #include "sanitizer_common/sanitizer_allocator.h"
21 #include "sanitizer_common/sanitizer_list.h"
22 #include "sanitizer_common/sanitizer_platform.h"
23
24 namespace __asan {
25
26 enum AllocType {
27 FROM_MALLOC = 1, // Memory block came from malloc, calloc, realloc, etc.
28 FROM_NEW = 2, // Memory block came from operator new.
29 FROM_NEW_BR = 3 // Memory block came from operator new [ ]
30 };
31
32 class AsanChunk;
33
34 struct AllocatorOptions {
35 u32 quarantine_size_mb;
36 u32 thread_local_quarantine_size_kb;
37 u16 min_redzone;
38 u16 max_redzone;
39 u8 may_return_null;
40 u8 alloc_dealloc_mismatch;
41 s32 release_to_os_interval_ms;
42
43 void SetFrom(const Flags *f, const CommonFlags *cf);
44 void CopyTo(Flags *f, CommonFlags *cf);
45 };
46
47 void InitializeAllocator(const AllocatorOptions &options);
48 void ReInitializeAllocator(const AllocatorOptions &options);
49 void GetAllocatorOptions(AllocatorOptions *options);
50
51 class AsanChunkView {
52 public:
53 explicit AsanChunkView(AsanChunk *chunk) : chunk_(chunk) {}
54 bool IsValid() const; // Checks if AsanChunkView points to a valid
55 // allocated or quarantined chunk.
56 bool IsAllocated() const; // Checks if the memory is currently allocated.
57 bool IsQuarantined() const; // Checks if the memory is currently quarantined.
58 uptr Beg() const; // First byte of user memory.
59 uptr End() const; // Last byte of user memory.
60 uptr UsedSize() const; // Size requested by the user.
61 u32 UserRequestedAlignment() const; // Originally requested alignment.
62 uptr AllocTid() const;
63 uptr FreeTid() const;
64 bool Eq(const AsanChunkView &c) const { return chunk_ == c.chunk_; }
65 u32 GetAllocStackId() const;
66 u32 GetFreeStackId() const;
67 AllocType GetAllocType() const;
68 bool AddrIsInside(uptr addr, uptr access_size, sptr *offset) const {
69 if (addr >= Beg() && (addr + access_size) <= End()) {
70 *offset = addr - Beg();
71 return true;
72 }
73 return false;
74 }
75 bool AddrIsAtLeft(uptr addr, uptr access_size, sptr *offset) const {
76 (void)access_size;
77 if (addr < Beg()) {
78 *offset = Beg() - addr;
79 return true;
80 }
81 return false;
82 }
83 bool AddrIsAtRight(uptr addr, uptr access_size, sptr *offset) const {
84 if (addr + access_size > End()) {
85 *offset = addr - End();
86 return true;
87 }
88 return false;
89 }
90
91 private:
92 AsanChunk *const chunk_;
93 };
94
95 AsanChunkView FindHeapChunkByAddress(uptr address);
96 AsanChunkView FindHeapChunkByAllocBeg(uptr address);
97
98 // List of AsanChunks with total size.
99 class AsanChunkFifoList: public IntrusiveList<AsanChunk> {
100 public:
101 explicit AsanChunkFifoList(LinkerInitialized) { }
102 AsanChunkFifoList() { clear(); }
103 void Push(AsanChunk *n);
104 void PushList(AsanChunkFifoList *q);
105 AsanChunk *Pop();
106 uptr size() { return size_; }
107 void clear() {
108 IntrusiveList<AsanChunk>::clear();
109 size_ = 0;
110 }
111 private:
112 uptr size_;
113 };
114
115 struct AsanMapUnmapCallback {
116 void OnMap(uptr p, uptr size) const;
117 void OnUnmap(uptr p, uptr size) const;
118 };
119
120 #if SANITIZER_CAN_USE_ALLOCATOR64
121 # if SANITIZER_FUCHSIA
122 const uptr kAllocatorSpace = ~(uptr)0;
123 const uptr kAllocatorSize = 0x40000000000ULL; // 4T.
124 typedef DefaultSizeClassMap SizeClassMap;
125 # elif defined(__powerpc64__)
126 const uptr kAllocatorSpace = ~(uptr)0;
127 const uptr kAllocatorSize = 0x20000000000ULL; // 2T.
128 typedef DefaultSizeClassMap SizeClassMap;
129 # elif defined(__aarch64__) && SANITIZER_ANDROID
130 // Android needs to support 39, 42 and 48 bit VMA.
131 const uptr kAllocatorSpace = ~(uptr)0;
132 const uptr kAllocatorSize = 0x2000000000ULL; // 128G.
133 typedef VeryCompactSizeClassMap SizeClassMap;
134 #elif SANITIZER_RISCV64
135 const uptr kAllocatorSpace = ~(uptr)0;
136 const uptr kAllocatorSize = 0x2000000000ULL; // 128G.
137 typedef VeryDenseSizeClassMap SizeClassMap;
138 #elif defined(__sparc__)
139 const uptr kAllocatorSpace = ~(uptr)0;
140 const uptr kAllocatorSize = 0x20000000000ULL; // 2T.
141 typedef DefaultSizeClassMap SizeClassMap;
142 # elif SANITIZER_WINDOWS
143 const uptr kAllocatorSpace = ~(uptr)0;
144 const uptr kAllocatorSize = 0x8000000000ULL; // 500G
145 typedef DefaultSizeClassMap SizeClassMap;
146 # else
147 const uptr kAllocatorSpace = 0x600000000000ULL;
148 const uptr kAllocatorSize = 0x40000000000ULL; // 4T.
149 typedef DefaultSizeClassMap SizeClassMap;
150 # endif
151 template <typename AddressSpaceViewTy>
152 struct AP64 { // Allocator64 parameters. Deliberately using a short name.
153 static const uptr kSpaceBeg = kAllocatorSpace;
154 static const uptr kSpaceSize = kAllocatorSize;
155 static const uptr kMetadataSize = 0;
156 typedef __asan::SizeClassMap SizeClassMap;
157 typedef AsanMapUnmapCallback MapUnmapCallback;
158 static const uptr kFlags = 0;
159 using AddressSpaceView = AddressSpaceViewTy;
160 };
161
162 template <typename AddressSpaceView>
163 using PrimaryAllocatorASVT = SizeClassAllocator64<AP64<AddressSpaceView>>;
164 using PrimaryAllocator = PrimaryAllocatorASVT<LocalAddressSpaceView>;
165 #else // Fallback to SizeClassAllocator32.
166 typedef CompactSizeClassMap SizeClassMap;
167 template <typename AddressSpaceViewTy>
168 struct AP32 {
169 static const uptr kSpaceBeg = 0;
170 static const u64 kSpaceSize = SANITIZER_MMAP_RANGE_SIZE;
171 static const uptr kMetadataSize = 0;
172 typedef __asan::SizeClassMap SizeClassMap;
173 static const uptr kRegionSizeLog = 20;
174 using AddressSpaceView = AddressSpaceViewTy;
175 typedef AsanMapUnmapCallback MapUnmapCallback;
176 static const uptr kFlags = 0;
177 };
178 template <typename AddressSpaceView>
179 using PrimaryAllocatorASVT = SizeClassAllocator32<AP32<AddressSpaceView> >;
180 using PrimaryAllocator = PrimaryAllocatorASVT<LocalAddressSpaceView>;
181 #endif // SANITIZER_CAN_USE_ALLOCATOR64
182
183 static const uptr kNumberOfSizeClasses = SizeClassMap::kNumClasses;
184
185 template <typename AddressSpaceView>
186 using AsanAllocatorASVT =
187 CombinedAllocator<PrimaryAllocatorASVT<AddressSpaceView>>;
188 using AsanAllocator = AsanAllocatorASVT<LocalAddressSpaceView>;
189 using AllocatorCache = AsanAllocator::AllocatorCache;
190
191 struct AsanThreadLocalMallocStorage {
192 uptr quarantine_cache[16];
193 AllocatorCache allocator_cache;
194 void CommitBack();
195 private:
196 // These objects are allocated via mmap() and are zero-initialized.
197 AsanThreadLocalMallocStorage() {}
198 };
199
200 void *asan_memalign(uptr alignment, uptr size, BufferedStackTrace *stack,
201 AllocType alloc_type);
202 void asan_free(void *ptr, BufferedStackTrace *stack, AllocType alloc_type);
203 void asan_delete(void *ptr, uptr size, uptr alignment,
204 BufferedStackTrace *stack, AllocType alloc_type);
205
206 void *asan_malloc(uptr size, BufferedStackTrace *stack);
207 void *asan_calloc(uptr nmemb, uptr size, BufferedStackTrace *stack);
208 void *asan_realloc(void *p, uptr size, BufferedStackTrace *stack);
209 void *asan_reallocarray(void *p, uptr nmemb, uptr size,
210 BufferedStackTrace *stack);
211 void *asan_valloc(uptr size, BufferedStackTrace *stack);
212 void *asan_pvalloc(uptr size, BufferedStackTrace *stack);
213
214 void *asan_aligned_alloc(uptr alignment, uptr size, BufferedStackTrace *stack);
215 int asan_posix_memalign(void **memptr, uptr alignment, uptr size,
216 BufferedStackTrace *stack);
217 uptr asan_malloc_usable_size(const void *ptr, uptr pc, uptr bp);
218
219 uptr asan_mz_size(const void *ptr);
220 void asan_mz_force_lock();
221 void asan_mz_force_unlock();
222
223 void PrintInternalAllocatorStats();
224 void AsanSoftRssLimitExceededCallback(bool exceeded);
225
226 } // namespace __asan
227 #endif // ASAN_ALLOCATOR_H