xref: /freebsd/contrib/llvm-project/compiler-rt/lib/lsan/lsan_allocator.h (revision faf25f48d601ae39f5752602f3020e2e92605625)
1 //=-- lsan_allocator.h ----------------------------------------------------===//
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 LeakSanitizer.
10 // Allocator for standalone LSan.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LSAN_ALLOCATOR_H
15 #define LSAN_ALLOCATOR_H
16 
17 #include "sanitizer_common/sanitizer_allocator.h"
18 #include "sanitizer_common/sanitizer_common.h"
19 #include "sanitizer_common/sanitizer_internal_defs.h"
20 #include "lsan_common.h"
21 
22 namespace __lsan {
23 
24 void *Allocate(const StackTrace &stack, uptr size, uptr alignment,
25                bool cleared);
26 void Deallocate(void *p);
27 void *Reallocate(const StackTrace &stack, void *p, uptr new_size,
28                  uptr alignment);
29 uptr GetMallocUsableSize(const void *p);
30 
31 template<typename Callable>
32 void ForEachChunk(const Callable &callback);
33 
34 void GetAllocatorCacheRange(uptr *begin, uptr *end);
35 void AllocatorThreadFinish();
36 void InitializeAllocator();
37 
38 const bool kAlwaysClearMemory = true;
39 
40 struct ChunkMetadata {
41   u8 allocated : 8;  // Must be first.
42   ChunkTag tag : 2;
43 #if SANITIZER_WORDSIZE == 64
44   uptr requested_size : 54;
45 #else
46   uptr requested_size : 32;
47   uptr padding : 22;
48 #endif
49   u32 stack_trace_id;
50 };
51 
52 #if defined(__mips64) || defined(__aarch64__) || defined(__i386__) || \
53     defined(__arm__) || SANITIZER_RISCV64 || defined(__hexagon__)
54 template <typename AddressSpaceViewTy>
55 struct AP32 {
56   static const uptr kSpaceBeg = 0;
57   static const u64 kSpaceSize = SANITIZER_MMAP_RANGE_SIZE;
58   static const uptr kMetadataSize = sizeof(ChunkMetadata);
59   typedef __sanitizer::CompactSizeClassMap SizeClassMap;
60   static const uptr kRegionSizeLog = 20;
61   using AddressSpaceView = AddressSpaceViewTy;
62   typedef NoOpMapUnmapCallback MapUnmapCallback;
63   static const uptr kFlags = 0;
64 };
65 template <typename AddressSpaceView>
66 using PrimaryAllocatorASVT = SizeClassAllocator32<AP32<AddressSpaceView>>;
67 using PrimaryAllocator = PrimaryAllocatorASVT<LocalAddressSpaceView>;
68 #elif defined(__x86_64__) || defined(__powerpc64__) || defined(__s390x__)
69 # if SANITIZER_FUCHSIA
70 const uptr kAllocatorSpace = ~(uptr)0;
71 const uptr kAllocatorSize  =  0x40000000000ULL;  // 4T.
72 # elif defined(__powerpc64__)
73 const uptr kAllocatorSpace = 0xa0000000000ULL;
74 const uptr kAllocatorSize  = 0x20000000000ULL;  // 2T.
75 #elif defined(__s390x__)
76 const uptr kAllocatorSpace = 0x40000000000ULL;
77 const uptr kAllocatorSize = 0x40000000000ULL;  // 4T.
78 # else
79 const uptr kAllocatorSpace = 0x600000000000ULL;
80 const uptr kAllocatorSize  = 0x40000000000ULL;  // 4T.
81 # endif
82 template <typename AddressSpaceViewTy>
83 struct AP64 {  // Allocator64 parameters. Deliberately using a short name.
84   static const uptr kSpaceBeg = kAllocatorSpace;
85   static const uptr kSpaceSize = kAllocatorSize;
86   static const uptr kMetadataSize = sizeof(ChunkMetadata);
87   typedef DefaultSizeClassMap SizeClassMap;
88   typedef NoOpMapUnmapCallback MapUnmapCallback;
89   static const uptr kFlags = 0;
90   using AddressSpaceView = AddressSpaceViewTy;
91 };
92 
93 template <typename AddressSpaceView>
94 using PrimaryAllocatorASVT = SizeClassAllocator64<AP64<AddressSpaceView>>;
95 using PrimaryAllocator = PrimaryAllocatorASVT<LocalAddressSpaceView>;
96 #endif
97 
98 template <typename AddressSpaceView>
99 using AllocatorASVT = CombinedAllocator<PrimaryAllocatorASVT<AddressSpaceView>>;
100 using Allocator = AllocatorASVT<LocalAddressSpaceView>;
101 using AllocatorCache = Allocator::AllocatorCache;
102 
103 Allocator::AllocatorCache *GetAllocatorCache();
104 
105 int lsan_posix_memalign(void **memptr, uptr alignment, uptr size,
106                         const StackTrace &stack);
107 void *lsan_aligned_alloc(uptr alignment, uptr size, const StackTrace &stack);
108 void *lsan_memalign(uptr alignment, uptr size, const StackTrace &stack);
109 void *lsan_malloc(uptr size, const StackTrace &stack);
110 void lsan_free(void *p);
111 void *lsan_realloc(void *p, uptr size, const StackTrace &stack);
112 void *lsan_reallocarray(void *p, uptr nmemb, uptr size,
113                         const StackTrace &stack);
114 void *lsan_calloc(uptr nmemb, uptr size, const StackTrace &stack);
115 void *lsan_valloc(uptr size, const StackTrace &stack);
116 void *lsan_pvalloc(uptr size, const StackTrace &stack);
117 uptr lsan_mz_size(const void *p);
118 
119 }  // namespace __lsan
120 
121 #endif  // LSAN_ALLOCATOR_H
122