1//===-- asan_interceptors.cpp ---------------------------------------------===//
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 AddressSanitizer, an address sanity checker.
10//
11// Interceptors for operators new and delete.
12//===----------------------------------------------------------------------===//
13
14#include <stddef.h>
15
16#include "asan_allocator.h"
17#include "asan_internal.h"
18#include "asan_report.h"
19#include "asan_stack.h"
20#include "interception/interception.h"
21
22// C++ operators can't have dllexport attributes on Windows. We export them
23// anyway by passing extra -export flags to the linker, which is exactly that
24// dllexport would normally do. We need to export them in order to make the
25// VS2015 dynamic CRT (MD) work.
26#if SANITIZER_WINDOWS && defined(_MSC_VER)
27# define CXX_OPERATOR_ATTRIBUTE
28# define COMMENT_EXPORT(sym) __pragma(comment(linker, "/export:" sym))
29# ifdef _WIN64
30COMMENT_EXPORT("??2@YAPEAX_K@Z") // operator new
31COMMENT_EXPORT("??2@YAPEAX_KAEBUnothrow_t@std@@@Z") // operator new nothrow
32COMMENT_EXPORT("??3@YAXPEAX@Z") // operator delete
33COMMENT_EXPORT("??3@YAXPEAX_K@Z") // sized operator delete
34COMMENT_EXPORT("??_U@YAPEAX_K@Z") // operator new[]
35COMMENT_EXPORT("??_V@YAXPEAX@Z") // operator delete[]
36# else
37COMMENT_EXPORT("??2@YAPAXI@Z") // operator new
38COMMENT_EXPORT("??2@YAPAXIABUnothrow_t@std@@@Z") // operator new nothrow
39COMMENT_EXPORT("??3@YAXPAX@Z") // operator delete
40COMMENT_EXPORT("??3@YAXPAXI@Z") // sized operator delete
41COMMENT_EXPORT("??_U@YAPAXI@Z") // operator new[]
42COMMENT_EXPORT("??_V@YAXPAX@Z") // operator delete[]
43# endif
44# undef COMMENT_EXPORT
45#else
46# define CXX_OPERATOR_ATTRIBUTE INTERCEPTOR_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
47#endif
48
49using namespace __asan;
50
51// This code has issues on OSX.
52// See https://github.com/google/sanitizers/issues/131.
53
54// Fake std::nothrow_t and std::align_val_t to avoid including <new>.
55namespace std {
56struct nothrow_t {};
57enum class align_val_t : size_t {};
58} // namespace std
59
60// TODO(alekseyshl): throw std::bad_alloc instead of dying on OOM.
61// For local pool allocation, align to SHADOW_GRANULARITY to match asan
62// allocator behavior.
63#define OPERATOR_NEW_BODY \
64 GET_STACK_TRACE_MALLOC; \
65 void* res = asan_new(size, &stack); \
66 if (UNLIKELY(!res)) \
67 ReportOutOfMemory(size, &stack); \
68 return res
69#define OPERATOR_NEW_BODY_NOTHROW \
70 GET_STACK_TRACE_MALLOC; \
71 return asan_new(size, &stack)
72#define OPERATOR_NEW_BODY_ARRAY \
73 GET_STACK_TRACE_MALLOC; \
74 void* res = asan_new_array(size, &stack); \
75 if (UNLIKELY(!res)) \
76 ReportOutOfMemory(size, &stack); \
77 return res
78#define OPERATOR_NEW_BODY_ARRAY_NOTHROW \
79 GET_STACK_TRACE_MALLOC; \
80 return asan_new_array(size, &stack)
81#define OPERATOR_NEW_BODY_ALIGN \
82 GET_STACK_TRACE_MALLOC; \
83 void* res = asan_new_aligned(size, static_cast<uptr>(align), &stack); \
84 if (UNLIKELY(!res)) \
85 ReportOutOfMemory(size, &stack); \
86 return res
87#define OPERATOR_NEW_BODY_ALIGN_NOTHROW \
88 GET_STACK_TRACE_MALLOC; \
89 return asan_new_aligned(size, static_cast<uptr>(align), &stack)
90#define OPERATOR_NEW_BODY_ALIGN_ARRAY \
91 GET_STACK_TRACE_MALLOC; \
92 void* res = asan_new_array_aligned(size, static_cast<uptr>(align), &stack); \
93 if (UNLIKELY(!res)) \
94 ReportOutOfMemory(size, &stack); \
95 return res
96#define OPERATOR_NEW_BODY_ALIGN_ARRAY_NOTHROW \
97 GET_STACK_TRACE_MALLOC; \
98 return asan_new_array_aligned(size, static_cast<uptr>(align), &stack)
99
100// On OS X it's not enough to just provide our own 'operator new' and
101// 'operator delete' implementations, because they're going to be in the
102// runtime dylib, and the main executable will depend on both the runtime
103// dylib and libstdc++, each of those'll have its implementation of new and
104// delete.
105// To make sure that C++ allocation/deallocation operators are overridden on
106// OS X we need to intercept them using their mangled names.
107#if !SANITIZER_APPLE
108CXX_OPERATOR_ATTRIBUTE
109void* operator new(size_t size) { OPERATOR_NEW_BODY; }
110CXX_OPERATOR_ATTRIBUTE
111void* operator new[](size_t size) { OPERATOR_NEW_BODY_ARRAY; }
112CXX_OPERATOR_ATTRIBUTE
113void* operator new(size_t size, std::nothrow_t const&) {
114 OPERATOR_NEW_BODY_NOTHROW;
115}
116CXX_OPERATOR_ATTRIBUTE
117void* operator new[](size_t size, std::nothrow_t const&) {
118 OPERATOR_NEW_BODY_ARRAY_NOTHROW;
119}
120CXX_OPERATOR_ATTRIBUTE
121void* operator new(size_t size, std::align_val_t align) {
122 OPERATOR_NEW_BODY_ALIGN;
123}
124CXX_OPERATOR_ATTRIBUTE
125void* operator new[](size_t size, std::align_val_t align) {
126 OPERATOR_NEW_BODY_ALIGN_ARRAY;
127}
128CXX_OPERATOR_ATTRIBUTE
129void* operator new(size_t size, std::align_val_t align, std::nothrow_t const&) {
130 OPERATOR_NEW_BODY_ALIGN_NOTHROW;
131}
132CXX_OPERATOR_ATTRIBUTE
133void* operator new[](size_t size, std::align_val_t align,
134 std::nothrow_t const&) {
135 OPERATOR_NEW_BODY_ALIGN_ARRAY_NOTHROW;
136}
137
138#else // SANITIZER_APPLE
139INTERCEPTOR(void*, _Znwm, size_t size) { OPERATOR_NEW_BODY; }
140INTERCEPTOR(void*, _Znam, size_t size) { OPERATOR_NEW_BODY_ARRAY; }
141INTERCEPTOR(void*, _ZnwmRKSt9nothrow_t, size_t size, std::nothrow_t const&) {
142 OPERATOR_NEW_BODY_NOTHROW;
143}
144INTERCEPTOR(void*, _ZnamRKSt9nothrow_t, size_t size, std::nothrow_t const&) {
145 OPERATOR_NEW_BODY_ARRAY_NOTHROW;
146}
147#endif // !SANITIZER_APPLE
148
149#define OPERATOR_DELETE_BODY \
150 GET_STACK_TRACE_FREE; \
151 asan_delete(ptr, &stack)
152#define OPERATOR_DELETE_BODY_ARRAY \
153 GET_STACK_TRACE_FREE; \
154 asan_delete_array(ptr, &stack)
155#define OPERATOR_DELETE_BODY_ALIGN \
156 GET_STACK_TRACE_FREE; \
157 asan_delete_aligned(ptr, static_cast<uptr>(align), &stack)
158#define OPERATOR_DELETE_BODY_ALIGN_ARRAY \
159 GET_STACK_TRACE_FREE; \
160 asan_delete_array_aligned(ptr, static_cast<uptr>(align), &stack)
161#define OPERATOR_DELETE_BODY_SIZE \
162 GET_STACK_TRACE_FREE; \
163 asan_delete_sized(ptr, size, &stack)
164#define OPERATOR_DELETE_BODY_SIZE_ARRAY \
165 GET_STACK_TRACE_FREE; \
166 asan_delete_array_sized(ptr, size, &stack)
167#define OPERATOR_DELETE_BODY_SIZE_ALIGN \
168 GET_STACK_TRACE_FREE; \
169 asan_delete_sized_aligned(ptr, size, static_cast<uptr>(align), &stack)
170#define OPERATOR_DELETE_BODY_SIZE_ALIGN_ARRAY \
171 GET_STACK_TRACE_FREE; \
172 asan_delete_array_sized_aligned(ptr, size, static_cast<uptr>(align), &stack)
173
174#if !SANITIZER_APPLE
175CXX_OPERATOR_ATTRIBUTE
176void operator delete(void* ptr) NOEXCEPT { OPERATOR_DELETE_BODY; }
177CXX_OPERATOR_ATTRIBUTE
178void operator delete[](void* ptr) NOEXCEPT { OPERATOR_DELETE_BODY_ARRAY; }
179CXX_OPERATOR_ATTRIBUTE
180void operator delete(void* ptr, std::nothrow_t const&) { OPERATOR_DELETE_BODY; }
181CXX_OPERATOR_ATTRIBUTE
182void operator delete[](void* ptr, std::nothrow_t const&) {
183 OPERATOR_DELETE_BODY_ARRAY;
184}
185CXX_OPERATOR_ATTRIBUTE
186void operator delete(void* ptr, size_t size) NOEXCEPT {
187 OPERATOR_DELETE_BODY_SIZE;
188}
189CXX_OPERATOR_ATTRIBUTE
190void operator delete[](void* ptr, size_t size) NOEXCEPT {
191 OPERATOR_DELETE_BODY_SIZE_ARRAY;
192}
193CXX_OPERATOR_ATTRIBUTE
194void operator delete(void* ptr, std::align_val_t align) NOEXCEPT {
195 OPERATOR_DELETE_BODY_ALIGN;
196}
197CXX_OPERATOR_ATTRIBUTE
198void operator delete[](void* ptr, std::align_val_t align) NOEXCEPT {
199 OPERATOR_DELETE_BODY_ALIGN_ARRAY;
200}
201CXX_OPERATOR_ATTRIBUTE
202void operator delete(void* ptr, std::align_val_t align, std::nothrow_t const&) {
203 OPERATOR_DELETE_BODY_ALIGN;
204}
205CXX_OPERATOR_ATTRIBUTE
206void operator delete[](void* ptr, std::align_val_t align,
207 std::nothrow_t const&) {
208 OPERATOR_DELETE_BODY_ALIGN_ARRAY;
209}
210CXX_OPERATOR_ATTRIBUTE
211void operator delete(void* ptr, size_t size, std::align_val_t align) NOEXCEPT {
212 OPERATOR_DELETE_BODY_SIZE_ALIGN;
213}
214CXX_OPERATOR_ATTRIBUTE
215void operator delete[](void* ptr, size_t size,
216 std::align_val_t align) NOEXCEPT {
217 OPERATOR_DELETE_BODY_SIZE_ALIGN_ARRAY;
218}
219
220#else // SANITIZER_APPLE
221INTERCEPTOR(void, _ZdlPv, void* ptr) { OPERATOR_DELETE_BODY; }
222INTERCEPTOR(void, _ZdaPv, void* ptr) { OPERATOR_DELETE_BODY_ARRAY; }
223INTERCEPTOR(void, _ZdlPvRKSt9nothrow_t, void* ptr, std::nothrow_t const&) {
224 OPERATOR_DELETE_BODY;
225}
226INTERCEPTOR(void, _ZdaPvRKSt9nothrow_t, void* ptr, std::nothrow_t const&) {
227 OPERATOR_DELETE_BODY_ARRAY;
228}
229#endif // !SANITIZER_APPLE
230