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
;
36 u32 thread_local_quarantine_size_kb
;
40 u8 alloc_dealloc_mismatch
;
41 s32 release_to_os_interval_ms
;
43 void SetFrom(const Flags
*f
, const CommonFlags
*cf
);
44 void CopyTo(Flags
*f
, CommonFlags
*cf
);
47 void InitializeAllocator(const AllocatorOptions
&options
);
48 void ReInitializeAllocator(const AllocatorOptions
&options
);
49 void GetAllocatorOptions(AllocatorOptions
*options
);
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;
64 bool Eq(const AsanChunkView
&c
) const { return chunk_
== c
.chunk_
; }
65 u32
GetAllocStackId() const;
66 u32
GetFreeStackId() const;
67 StackTrace
GetAllocStack() const;
68 StackTrace
GetFreeStack() const;
69 AllocType
GetAllocType() const;
70 bool AddrIsInside(uptr addr
, uptr access_size
, sptr
*offset
) const {
71 if (addr
>= Beg() && (addr
+ access_size
) <= End()) {
72 *offset
= addr
- Beg();
77 bool AddrIsAtLeft(uptr addr
, uptr access_size
, sptr
*offset
) const {
80 *offset
= Beg() - addr
;
85 bool AddrIsAtRight(uptr addr
, uptr access_size
, sptr
*offset
) const {
86 if (addr
+ access_size
> End()) {
87 *offset
= addr
- End();
94 AsanChunk
*const chunk_
;
97 AsanChunkView
FindHeapChunkByAddress(uptr address
);
98 AsanChunkView
FindHeapChunkByAllocBeg(uptr address
);
100 // List of AsanChunks with total size.
101 class AsanChunkFifoList
: public IntrusiveList
<AsanChunk
> {
103 explicit AsanChunkFifoList(LinkerInitialized
) { }
104 AsanChunkFifoList() { clear(); }
105 void Push(AsanChunk
*n
);
106 void PushList(AsanChunkFifoList
*q
);
108 uptr
size() { return size_
; }
110 IntrusiveList
<AsanChunk
>::clear();
117 struct AsanMapUnmapCallback
{
118 void OnMap(uptr p
, uptr size
) const;
119 void OnUnmap(uptr p
, uptr size
) const;
122 #if SANITIZER_CAN_USE_ALLOCATOR64
123 # if SANITIZER_FUCHSIA
124 const uptr kAllocatorSpace
= ~(uptr
)0;
125 const uptr kAllocatorSize
= 0x40000000000ULL
; // 4T.
126 typedef DefaultSizeClassMap SizeClassMap
;
127 # elif defined(__powerpc64__)
128 const uptr kAllocatorSpace
= 0xa0000000000ULL
;
129 const uptr kAllocatorSize
= 0x20000000000ULL
; // 2T.
130 typedef DefaultSizeClassMap SizeClassMap
;
131 # elif defined(__aarch64__) && SANITIZER_ANDROID
132 const uptr kAllocatorSpace
= 0x3000000000ULL
;
133 const uptr kAllocatorSize
= 0x2000000000ULL
; // 128G.
134 typedef VeryCompactSizeClassMap SizeClassMap
;
135 # elif defined(__aarch64__)
136 // AArch64/SANITIZER_CAN_USER_ALLOCATOR64 is only for 42-bit VMA
137 // so no need to different values for different VMA.
138 const uptr kAllocatorSpace
= 0x10000000000ULL
;
139 const uptr kAllocatorSize
= 0x10000000000ULL
; // 3T.
140 typedef DefaultSizeClassMap SizeClassMap
;
141 # elif SANITIZER_WINDOWS
142 const uptr kAllocatorSpace
= ~(uptr
)0;
143 const uptr kAllocatorSize
= 0x8000000000ULL
; // 500G
144 typedef DefaultSizeClassMap SizeClassMap
;
146 const uptr kAllocatorSpace
= 0x600000000000ULL
;
147 const uptr kAllocatorSize
= 0x40000000000ULL
; // 4T.
148 typedef DefaultSizeClassMap SizeClassMap
;
150 struct AP64
{ // Allocator64 parameters. Deliberately using a short name.
151 static const uptr kSpaceBeg
= kAllocatorSpace
;
152 static const uptr kSpaceSize
= kAllocatorSize
;
153 static const uptr kMetadataSize
= 0;
154 typedef __asan::SizeClassMap SizeClassMap
;
155 typedef AsanMapUnmapCallback MapUnmapCallback
;
156 static const uptr kFlags
= 0;
159 typedef SizeClassAllocator64
<AP64
> PrimaryAllocator
;
160 #else // Fallback to SizeClassAllocator32.
161 static const uptr kRegionSizeLog
= 20;
162 static const uptr kNumRegions
= SANITIZER_MMAP_RANGE_SIZE
>> kRegionSizeLog
;
163 # if SANITIZER_WORDSIZE == 32
164 typedef FlatByteMap
<kNumRegions
> ByteMap
;
165 # elif SANITIZER_WORDSIZE == 64
166 typedef TwoLevelByteMap
<(kNumRegions
>> 12), 1 << 12> ByteMap
;
168 typedef CompactSizeClassMap SizeClassMap
;
170 static const uptr kSpaceBeg
= 0;
171 static const u64 kSpaceSize
= SANITIZER_MMAP_RANGE_SIZE
;
172 static const uptr kMetadataSize
= 16;
173 typedef __asan::SizeClassMap SizeClassMap
;
174 static const uptr kRegionSizeLog
= __asan::kRegionSizeLog
;
175 typedef __asan::ByteMap ByteMap
;
176 typedef AsanMapUnmapCallback MapUnmapCallback
;
177 static const uptr kFlags
= 0;
179 typedef SizeClassAllocator32
<AP32
> PrimaryAllocator
;
180 #endif // SANITIZER_CAN_USE_ALLOCATOR64
182 static const uptr kNumberOfSizeClasses
= SizeClassMap::kNumClasses
;
183 typedef SizeClassAllocatorLocalCache
<PrimaryAllocator
> AllocatorCache
;
184 typedef LargeMmapAllocator
<AsanMapUnmapCallback
> SecondaryAllocator
;
185 typedef CombinedAllocator
<PrimaryAllocator
, AllocatorCache
,
186 SecondaryAllocator
> AsanAllocator
;
189 struct AsanThreadLocalMallocStorage
{
190 uptr quarantine_cache
[16];
191 AllocatorCache allocator_cache
;
194 // These objects are allocated via mmap() and are zero-initialized.
195 AsanThreadLocalMallocStorage() {}
198 void *asan_memalign(uptr alignment
, uptr size
, BufferedStackTrace
*stack
,
199 AllocType alloc_type
);
200 void asan_free(void *ptr
, BufferedStackTrace
*stack
, AllocType alloc_type
);
201 void asan_delete(void *ptr
, uptr size
, uptr alignment
,
202 BufferedStackTrace
*stack
, AllocType alloc_type
);
204 void *asan_malloc(uptr size
, BufferedStackTrace
*stack
);
205 void *asan_calloc(uptr nmemb
, uptr size
, BufferedStackTrace
*stack
);
206 void *asan_realloc(void *p
, uptr size
, BufferedStackTrace
*stack
);
207 void *asan_valloc(uptr size
, BufferedStackTrace
*stack
);
208 void *asan_pvalloc(uptr size
, BufferedStackTrace
*stack
);
210 int asan_posix_memalign(void **memptr
, uptr alignment
, uptr size
,
211 BufferedStackTrace
*stack
);
212 uptr
asan_malloc_usable_size(const void *ptr
, uptr pc
, uptr bp
);
214 uptr
asan_mz_size(const void *ptr
);
215 void asan_mz_force_lock();
216 void asan_mz_force_unlock();
218 void PrintInternalAllocatorStats();
219 void AsanSoftRssLimitExceededCallback(bool exceeded
);
221 } // namespace __asan
222 #endif // ASAN_ALLOCATOR_H