1 //===-- asan_allocator.h ----------------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file is a part of AddressSanitizer, an address sanity checker.
12 // ASan-private header for asan_allocator.cc.
13 //===----------------------------------------------------------------------===//
15 #ifndef ASAN_ALLOCATOR_H
16 #define ASAN_ALLOCATOR_H
18 #include "asan_flags.h"
19 #include "asan_internal.h"
20 #include "asan_interceptors.h"
21 #include "sanitizer_common/sanitizer_allocator.h"
22 #include "sanitizer_common/sanitizer_list.h"
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 [ ]
34 struct AllocatorOptions {
35 u32 quarantine_size_mb;
39 u8 alloc_dealloc_mismatch;
41 void SetFrom(const Flags *f, const CommonFlags *cf);
42 void CopyTo(Flags *f, CommonFlags *cf);
45 void InitializeAllocator(const AllocatorOptions &options);
46 void ReInitializeAllocator(const AllocatorOptions &options);
47 void GetAllocatorOptions(AllocatorOptions *options);
51 explicit AsanChunkView(AsanChunk *chunk) : chunk_(chunk) {}
52 bool IsValid(); // Checks if AsanChunkView points to a valid allocated
53 // or quarantined chunk.
54 bool IsAllocated(); // Checks if the memory is currently allocated.
55 uptr Beg(); // First byte of user memory.
56 uptr End(); // Last byte of user memory.
57 uptr UsedSize(); // Size requested by the user.
60 bool Eq(const AsanChunkView &c) const { return chunk_ == c.chunk_; }
61 u32 GetAllocStackId();
63 StackTrace GetAllocStack();
64 StackTrace GetFreeStack();
65 bool AddrIsInside(uptr addr, uptr access_size, sptr *offset) {
66 if (addr >= Beg() && (addr + access_size) <= End()) {
67 *offset = addr - Beg();
72 bool AddrIsAtLeft(uptr addr, uptr access_size, sptr *offset) {
75 *offset = Beg() - addr;
80 bool AddrIsAtRight(uptr addr, uptr access_size, sptr *offset) {
81 if (addr + access_size > End()) {
82 *offset = addr - End();
89 AsanChunk *const chunk_;
92 AsanChunkView FindHeapChunkByAddress(uptr address);
94 // List of AsanChunks with total size.
95 class AsanChunkFifoList: public IntrusiveList<AsanChunk> {
97 explicit AsanChunkFifoList(LinkerInitialized) { }
98 AsanChunkFifoList() { clear(); }
99 void Push(AsanChunk *n);
100 void PushList(AsanChunkFifoList *q);
102 uptr size() { return size_; }
104 IntrusiveList<AsanChunk>::clear();
111 struct AsanMapUnmapCallback {
112 void OnMap(uptr p, uptr size) const;
113 void OnUnmap(uptr p, uptr size) const;
116 #if SANITIZER_CAN_USE_ALLOCATOR64
117 # if defined(__powerpc64__)
118 const uptr kAllocatorSpace = 0xa0000000000ULL;
119 const uptr kAllocatorSize = 0x20000000000ULL; // 2T.
120 # elif defined(__aarch64__)
121 // AArch64/SANITIZIER_CAN_USER_ALLOCATOR64 is only for 42-bit VMA
122 // so no need to different values for different VMA.
123 const uptr kAllocatorSpace = 0x10000000000ULL;
124 const uptr kAllocatorSize = 0x10000000000ULL; // 3T.
126 const uptr kAllocatorSpace = 0x600000000000ULL;
127 const uptr kAllocatorSize = 0x40000000000ULL; // 4T.
129 typedef DefaultSizeClassMap SizeClassMap;
130 typedef SizeClassAllocator64<kAllocatorSpace, kAllocatorSize, 0 /*metadata*/,
131 SizeClassMap, AsanMapUnmapCallback> PrimaryAllocator;
132 #else // Fallback to SizeClassAllocator32.
133 static const uptr kRegionSizeLog = 20;
134 static const uptr kNumRegions = SANITIZER_MMAP_RANGE_SIZE >> kRegionSizeLog;
135 # if SANITIZER_WORDSIZE == 32
136 typedef FlatByteMap<kNumRegions> ByteMap;
137 # elif SANITIZER_WORDSIZE == 64
138 typedef TwoLevelByteMap<(kNumRegions >> 12), 1 << 12> ByteMap;
140 typedef CompactSizeClassMap SizeClassMap;
141 typedef SizeClassAllocator32<0, SANITIZER_MMAP_RANGE_SIZE, 16,
142 SizeClassMap, kRegionSizeLog,
144 AsanMapUnmapCallback> PrimaryAllocator;
145 #endif // SANITIZER_CAN_USE_ALLOCATOR64
147 static const uptr kNumberOfSizeClasses = SizeClassMap::kNumClasses;
148 typedef SizeClassAllocatorLocalCache<PrimaryAllocator> AllocatorCache;
149 typedef LargeMmapAllocator<AsanMapUnmapCallback> SecondaryAllocator;
150 typedef CombinedAllocator<PrimaryAllocator, AllocatorCache,
151 SecondaryAllocator> AsanAllocator;
154 struct AsanThreadLocalMallocStorage {
155 uptr quarantine_cache[16];
156 AllocatorCache allocator_cache;
159 // These objects are allocated via mmap() and are zero-initialized.
160 AsanThreadLocalMallocStorage() {}
163 void *asan_memalign(uptr alignment, uptr size, BufferedStackTrace *stack,
164 AllocType alloc_type);
165 void asan_free(void *ptr, BufferedStackTrace *stack, AllocType alloc_type);
166 void asan_sized_free(void *ptr, uptr size, BufferedStackTrace *stack,
167 AllocType alloc_type);
169 void *asan_malloc(uptr size, BufferedStackTrace *stack);
170 void *asan_calloc(uptr nmemb, uptr size, BufferedStackTrace *stack);
171 void *asan_realloc(void *p, uptr size, BufferedStackTrace *stack);
172 void *asan_valloc(uptr size, BufferedStackTrace *stack);
173 void *asan_pvalloc(uptr size, BufferedStackTrace *stack);
175 int asan_posix_memalign(void **memptr, uptr alignment, uptr size,
176 BufferedStackTrace *stack);
177 uptr asan_malloc_usable_size(const void *ptr, uptr pc, uptr bp);
179 uptr asan_mz_size(const void *ptr);
180 void asan_mz_force_lock();
181 void asan_mz_force_unlock();
183 void PrintInternalAllocatorStats();
184 void AsanSoftRssLimitExceededCallback(bool exceeded);
186 } // namespace __asan
187 #endif // ASAN_ALLOCATOR_H