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