xref: /netbsd-src/external/gpl3/gcc/dist/libsanitizer/lsan/lsan_allocator.h (revision cacddd24c120ffcce62ad97b3c7e238db7eaae79)
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     ((defined(__sparc__) || \
55       defined(__powerpc__) || \
56       defined(__m68k__) || \
57       defined(__hppa__) || \
58       defined(__sh3__) || \
59       defined(__vax__) || \
60       defined(__riscv) || \
61       defined(__mips__)) && !defined(_LP64))
62 template <typename AddressSpaceViewTy>
63 struct AP32 {
64   static const uptr kSpaceBeg = 0;
65   static const u64 kSpaceSize = SANITIZER_MMAP_RANGE_SIZE;
66   static const uptr kMetadataSize = sizeof(ChunkMetadata);
67   typedef __sanitizer::CompactSizeClassMap SizeClassMap;
68   static const uptr kRegionSizeLog = 20;
69   using AddressSpaceView = AddressSpaceViewTy;
70   typedef NoOpMapUnmapCallback MapUnmapCallback;
71   static const uptr kFlags = 0;
72 };
73 template <typename AddressSpaceView>
74 using PrimaryAllocatorASVT = SizeClassAllocator32<AP32<AddressSpaceView>>;
75 using PrimaryAllocator = PrimaryAllocatorASVT<LocalAddressSpaceView>;
76 #elif defined(__x86_64__) || defined(__powerpc64__) || defined(__s390x__) || \
77       defined(__sparc64__) || defined(__ia64__) || defined(__alpha__) || \
78       defined(__mips64) || defined(__riscv)
79 # if SANITIZER_FUCHSIA
80 const uptr kAllocatorSpace = ~(uptr)0;
81 const uptr kAllocatorSize  =  0x40000000000ULL;  // 4T.
82 # elif defined(__powerpc64__)
83 const uptr kAllocatorSpace = 0xa0000000000ULL;
84 const uptr kAllocatorSize  = 0x20000000000ULL;  // 2T.
85 #elif defined(__s390x__)
86 const uptr kAllocatorSpace = 0x40000000000ULL;
87 const uptr kAllocatorSize = 0x40000000000ULL;  // 4T.
88 # else
89 const uptr kAllocatorSpace = 0x600000000000ULL;
90 const uptr kAllocatorSize  = 0x40000000000ULL;  // 4T.
91 # endif
92 template <typename AddressSpaceViewTy>
93 struct AP64 {  // Allocator64 parameters. Deliberately using a short name.
94   static const uptr kSpaceBeg = kAllocatorSpace;
95   static const uptr kSpaceSize = kAllocatorSize;
96   static const uptr kMetadataSize = sizeof(ChunkMetadata);
97   typedef DefaultSizeClassMap SizeClassMap;
98   typedef NoOpMapUnmapCallback MapUnmapCallback;
99   static const uptr kFlags = 0;
100   using AddressSpaceView = AddressSpaceViewTy;
101 };
102 
103 template <typename AddressSpaceView>
104 using PrimaryAllocatorASVT = SizeClassAllocator64<AP64<AddressSpaceView>>;
105 using PrimaryAllocator = PrimaryAllocatorASVT<LocalAddressSpaceView>;
106 #endif
107 
108 template <typename AddressSpaceView>
109 using AllocatorASVT = CombinedAllocator<PrimaryAllocatorASVT<AddressSpaceView>>;
110 using Allocator = AllocatorASVT<LocalAddressSpaceView>;
111 using AllocatorCache = Allocator::AllocatorCache;
112 
113 Allocator::AllocatorCache *GetAllocatorCache();
114 
115 int lsan_posix_memalign(void **memptr, uptr alignment, uptr size,
116                         const StackTrace &stack);
117 void *lsan_aligned_alloc(uptr alignment, uptr size, const StackTrace &stack);
118 void *lsan_memalign(uptr alignment, uptr size, const StackTrace &stack);
119 void *lsan_malloc(uptr size, const StackTrace &stack);
120 void lsan_free(void *p);
121 void *lsan_realloc(void *p, uptr size, const StackTrace &stack);
122 void *lsan_reallocarray(void *p, uptr nmemb, uptr size,
123                         const StackTrace &stack);
124 void *lsan_calloc(uptr nmemb, uptr size, const StackTrace &stack);
125 void *lsan_valloc(uptr size, const StackTrace &stack);
126 void *lsan_pvalloc(uptr size, const StackTrace &stack);
127 uptr lsan_mz_size(const void *p);
128 
129 }  // namespace __lsan
130 
131 #endif  // LSAN_ALLOCATOR_H
132