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
22namespace __lsan {
23
24void *Allocate(const StackTrace &stack, uptr size, uptr alignment,
25               bool cleared);
26void Deallocate(void *p);
27void *Reallocate(const StackTrace &stack, void *p, uptr new_size,
28                 uptr alignment);
29uptr GetMallocUsableSize(const void *p);
30
31template<typename Callable>
32void ForEachChunk(const Callable &callback);
33
34void GetAllocatorCacheRange(uptr *begin, uptr *end);
35void AllocatorThreadFinish();
36void InitializeAllocator();
37
38const bool kAlwaysClearMemory = true;
39
40struct 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__)
54template <typename AddressSpaceViewTy>
55struct 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};
65template <typename AddressSpaceView>
66using PrimaryAllocatorASVT = SizeClassAllocator32<AP32<AddressSpaceView>>;
67using PrimaryAllocator = PrimaryAllocatorASVT<LocalAddressSpaceView>;
68#elif defined(__x86_64__) || defined(__powerpc64__) || defined(__s390x__)
69# if SANITIZER_FUCHSIA
70const uptr kAllocatorSpace = ~(uptr)0;
71const uptr kAllocatorSize  =  0x40000000000ULL;  // 4T.
72# elif defined(__powerpc64__)
73const uptr kAllocatorSpace = 0xa0000000000ULL;
74const uptr kAllocatorSize  = 0x20000000000ULL;  // 2T.
75#elif defined(__s390x__)
76const uptr kAllocatorSpace = 0x40000000000ULL;
77const uptr kAllocatorSize = 0x40000000000ULL;  // 4T.
78# else
79const uptr kAllocatorSpace = 0x600000000000ULL;
80const uptr kAllocatorSize  = 0x40000000000ULL;  // 4T.
81# endif
82template <typename AddressSpaceViewTy>
83struct 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
93template <typename AddressSpaceView>
94using PrimaryAllocatorASVT = SizeClassAllocator64<AP64<AddressSpaceView>>;
95using PrimaryAllocator = PrimaryAllocatorASVT<LocalAddressSpaceView>;
96#endif
97
98template <typename AddressSpaceView>
99using AllocatorASVT = CombinedAllocator<PrimaryAllocatorASVT<AddressSpaceView>>;
100using Allocator = AllocatorASVT<LocalAddressSpaceView>;
101using AllocatorCache = Allocator::AllocatorCache;
102
103Allocator::AllocatorCache *GetAllocatorCache();
104
105int lsan_posix_memalign(void **memptr, uptr alignment, uptr size,
106                        const StackTrace &stack);
107void *lsan_aligned_alloc(uptr alignment, uptr size, const StackTrace &stack);
108void *lsan_memalign(uptr alignment, uptr size, const StackTrace &stack);
109void *lsan_malloc(uptr size, const StackTrace &stack);
110void lsan_free(void *p);
111void *lsan_realloc(void *p, uptr size, const StackTrace &stack);
112void *lsan_reallocarray(void *p, uptr nmemb, uptr size,
113                        const StackTrace &stack);
114void *lsan_calloc(uptr nmemb, uptr size, const StackTrace &stack);
115void *lsan_valloc(uptr size, const StackTrace &stack);
116void *lsan_pvalloc(uptr size, const StackTrace &stack);
117uptr lsan_mz_size(const void *p);
118
119}  // namespace __lsan
120
121#endif  // LSAN_ALLOCATOR_H
122