xref: /openbsd-src/gnu/llvm/compiler-rt/lib/memprof/memprof_stack.h (revision d89ec533011f513df1010f142a111086a0785f09)
1*d89ec533Spatrick //===-- memprof_stack.h ----------------------------------------*- C++ -*-===//
2*d89ec533Spatrick //
3*d89ec533Spatrick // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4*d89ec533Spatrick // See https://llvm.org/LICENSE.txt for license information.
5*d89ec533Spatrick // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6*d89ec533Spatrick //
7*d89ec533Spatrick //===----------------------------------------------------------------------===//
8*d89ec533Spatrick //
9*d89ec533Spatrick // This file is a part of MemProfiler, a memory profiler.
10*d89ec533Spatrick //
11*d89ec533Spatrick // MemProf-private header for memprof_stack.cpp.
12*d89ec533Spatrick //===----------------------------------------------------------------------===//
13*d89ec533Spatrick 
14*d89ec533Spatrick #ifndef MEMPROF_STACK_H
15*d89ec533Spatrick #define MEMPROF_STACK_H
16*d89ec533Spatrick 
17*d89ec533Spatrick #include "memprof_flags.h"
18*d89ec533Spatrick #include "memprof_thread.h"
19*d89ec533Spatrick #include "sanitizer_common/sanitizer_flags.h"
20*d89ec533Spatrick #include "sanitizer_common/sanitizer_stacktrace.h"
21*d89ec533Spatrick 
22*d89ec533Spatrick namespace __memprof {
23*d89ec533Spatrick 
24*d89ec533Spatrick static const u32 kDefaultMallocContextSize = 30;
25*d89ec533Spatrick 
26*d89ec533Spatrick void SetMallocContextSize(u32 size);
27*d89ec533Spatrick u32 GetMallocContextSize();
28*d89ec533Spatrick 
29*d89ec533Spatrick } // namespace __memprof
30*d89ec533Spatrick 
31*d89ec533Spatrick // NOTE: A Rule of thumb is to retrieve stack trace in the interceptors
32*d89ec533Spatrick // as early as possible (in functions exposed to the user), as we generally
33*d89ec533Spatrick // don't want stack trace to contain functions from MemProf internals.
34*d89ec533Spatrick 
35*d89ec533Spatrick #define GET_STACK_TRACE(max_size, fast)                                        \
36*d89ec533Spatrick   BufferedStackTrace stack;                                                    \
37*d89ec533Spatrick   if (max_size <= 2) {                                                         \
38*d89ec533Spatrick     stack.size = max_size;                                                     \
39*d89ec533Spatrick     if (max_size > 0) {                                                        \
40*d89ec533Spatrick       stack.top_frame_bp = GET_CURRENT_FRAME();                                \
41*d89ec533Spatrick       stack.trace_buffer[0] = StackTrace::GetCurrentPc();                      \
42*d89ec533Spatrick       if (max_size > 1)                                                        \
43*d89ec533Spatrick         stack.trace_buffer[1] = GET_CALLER_PC();                               \
44*d89ec533Spatrick     }                                                                          \
45*d89ec533Spatrick   } else {                                                                     \
46*d89ec533Spatrick     stack.Unwind(StackTrace::GetCurrentPc(), GET_CURRENT_FRAME(), nullptr,     \
47*d89ec533Spatrick                  fast, max_size);                                              \
48*d89ec533Spatrick   }
49*d89ec533Spatrick 
50*d89ec533Spatrick #define GET_STACK_TRACE_FATAL_HERE                                             \
51*d89ec533Spatrick   GET_STACK_TRACE(kStackTraceMax, common_flags()->fast_unwind_on_fatal)
52*d89ec533Spatrick 
53*d89ec533Spatrick #define GET_STACK_TRACE_THREAD GET_STACK_TRACE(kStackTraceMax, true)
54*d89ec533Spatrick 
55*d89ec533Spatrick #define GET_STACK_TRACE_MALLOC                                                 \
56*d89ec533Spatrick   GET_STACK_TRACE(GetMallocContextSize(), common_flags()->fast_unwind_on_malloc)
57*d89ec533Spatrick 
58*d89ec533Spatrick #define GET_STACK_TRACE_FREE GET_STACK_TRACE_MALLOC
59*d89ec533Spatrick 
60*d89ec533Spatrick #define PRINT_CURRENT_STACK()                                                  \
61*d89ec533Spatrick   {                                                                            \
62*d89ec533Spatrick     GET_STACK_TRACE_FATAL_HERE;                                                \
63*d89ec533Spatrick     stack.Print();                                                             \
64*d89ec533Spatrick   }
65*d89ec533Spatrick 
66*d89ec533Spatrick #endif // MEMPROF_STACK_H
67