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__) || 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))
62template <typename AddressSpaceViewTy>
63struct 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};
73template <typename AddressSpaceView>
74using PrimaryAllocatorASVT = SizeClassAllocator32<AP32<AddressSpaceView>>;
75using 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
80const uptr kAllocatorSpace = ~(uptr)0;
81const uptr kAllocatorSize  =  0x40000000000ULL;  // 4T.
82# elif defined(__powerpc64__)
83const uptr kAllocatorSpace = 0xa0000000000ULL;
84const uptr kAllocatorSize  = 0x20000000000ULL;  // 2T.
85#elif defined(__s390x__)
86const uptr kAllocatorSpace = 0x40000000000ULL;
87const uptr kAllocatorSize = 0x40000000000ULL;  // 4T.
88# else
89const uptr kAllocatorSpace = 0x600000000000ULL;
90const uptr kAllocatorSize  = 0x40000000000ULL;  // 4T.
91# endif
92template <typename AddressSpaceViewTy>
93struct 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
103template <typename AddressSpaceView>
104using PrimaryAllocatorASVT = SizeClassAllocator64<AP64<AddressSpaceView>>;
105using PrimaryAllocator = PrimaryAllocatorASVT<LocalAddressSpaceView>;
106#endif
107
108template <typename AddressSpaceView>
109using AllocatorASVT = CombinedAllocator<PrimaryAllocatorASVT<AddressSpaceView>>;
110using Allocator = AllocatorASVT<LocalAddressSpaceView>;
111using AllocatorCache = Allocator::AllocatorCache;
112
113Allocator::AllocatorCache *GetAllocatorCache();
114
115int lsan_posix_memalign(void **memptr, uptr alignment, uptr size,
116                        const StackTrace &stack);
117void *lsan_aligned_alloc(uptr alignment, uptr size, const StackTrace &stack);
118void *lsan_memalign(uptr alignment, uptr size, const StackTrace &stack);
119void *lsan_malloc(uptr size, const StackTrace &stack);
120void lsan_free(void *p);
121void *lsan_realloc(void *p, uptr size, const StackTrace &stack);
122void *lsan_reallocarray(void *p, uptr nmemb, uptr size,
123                        const StackTrace &stack);
124void *lsan_calloc(uptr nmemb, uptr size, const StackTrace &stack);
125void *lsan_valloc(uptr size, const StackTrace &stack);
126void *lsan_pvalloc(uptr size, const StackTrace &stack);
127uptr lsan_mz_size(const void *p);
128
129}  // namespace __lsan
130
131#endif  // LSAN_ALLOCATOR_H
132