1 //===-- sanitizer_stacktrace.cpp ------------------------------------------===//
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
7 //===----------------------------------------------------------------------===//
9 // This file is shared between AddressSanitizer and ThreadSanitizer
10 // run-time libraries.
11 //===----------------------------------------------------------------------===//
13 #include "sanitizer_stacktrace.h"
15 #include "sanitizer_common.h"
16 #include "sanitizer_flags.h"
17 #include "sanitizer_platform.h"
19 namespace __sanitizer {
21 uptr StackTrace::GetNextInstructionPc(uptr pc) {
22 #if defined(__sparc__) || defined(__mips__)
24 #elif defined(__powerpc__) || defined(__arm__) || defined(__aarch64__)
26 #elif SANITIZER_RISCV64
27 // Current check order is 4 -> 2 -> 6 -> 8
28 u8 InsnByte = *(u8 *)(pc);
29 if (((InsnByte & 0x3) == 0x3) && ((InsnByte & 0x1c) != 0x1c)) {
30 // xxxxxxxxxxxbbb11 | 32 bit | bbb != 111
33 if ((InsnByte & 0x3) != 0x3) {
34 // xxxxxxxxxxxxxxaa | 16 bit | aa != 11
37 // RISC-V encoding allows instructions to be up to 8 bytes long
38 if ((InsnByte & 0x3f) == 0x1f) {
39 // xxxxxxxxxx011111 | 48 bit |
42 if ((InsnByte & 0x7f) == 0x3f) {
43 // xxxxxxxxx0111111 | 64 bit |
46 // bail-out if could not figure out the instruction size
53 uptr StackTrace::GetCurrentPc() {
54 return GET_CALLER_PC();
57 void BufferedStackTrace::Init(const uptr *pcs, uptr cnt, uptr extra_top_pc) {
58 size = cnt + !!extra_top_pc;
59 CHECK_LE(size, kStackTraceMax);
60 internal_memcpy(trace_buffer, pcs, cnt * sizeof(trace_buffer[0]));
62 trace_buffer[cnt] = extra_top_pc;
66 // Sparc implemention is in its own file.
67 #if !defined(__sparc__)
69 // In GCC on ARM bp points to saved lr, not fp, so we should check the next
70 // cell in stack to be a saved frame pointer. GetCanonicFrame returns the
71 // pointer to saved frame pointer in any case.
72 static inline uhwptr *GetCanonicFrame(uptr bp,
75 CHECK_GT(stack_top, stack_bottom);
77 if (!IsValidFrame(bp, stack_top, stack_bottom)) return 0;
78 uhwptr *bp_prev = (uhwptr *)bp;
79 if (IsValidFrame((uptr)bp_prev[0], stack_top, stack_bottom)) return bp_prev;
80 // The next frame pointer does not look right. This could be a GCC frame, step
81 // back by 1 word and try again.
82 if (IsValidFrame((uptr)bp_prev[-1], stack_top, stack_bottom))
84 // Nope, this does not look right either. This means the frame after next does
85 // not have a valid frame pointer, but we can still extract the caller PC.
86 // Unfortunately, there is no way to decide between GCC and LLVM frame
87 // layouts. Assume LLVM.
94 void BufferedStackTrace::UnwindFast(uptr pc, uptr bp, uptr stack_top,
95 uptr stack_bottom, u32 max_depth) {
96 // TODO(yln): add arg sanity check for stack_top/stack_bottom
97 CHECK_GE(max_depth, 2);
98 const uptr kPageSize = GetPageSizeCached();
101 if (stack_top < 4096) return; // Sanity check for stack top.
102 uhwptr *frame = GetCanonicFrame(bp, stack_top, stack_bottom);
103 // Lowest possible address that makes sense as the next frame pointer.
104 // Goes up as we walk the stack.
105 uptr bottom = stack_bottom;
106 // Avoid infinite loop when frame == frame[0] by using frame > prev_frame.
107 while (IsValidFrame((uptr)frame, stack_top, bottom) &&
108 IsAligned((uptr)frame, sizeof(*frame)) &&
111 // PowerPC ABIs specify that the return address is saved at offset
112 // 16 of the *caller's* stack frame. Thus we must dereference the
113 // back chain to find the caller frame before extracting it.
114 uhwptr *caller_frame = (uhwptr*)frame[0];
115 if (!IsValidFrame((uptr)caller_frame, stack_top, bottom) ||
116 !IsAligned((uptr)caller_frame, sizeof(uhwptr)))
118 uhwptr pc1 = caller_frame[2];
119 #elif defined(__s390__)
120 uhwptr pc1 = frame[14];
121 #elif defined(__riscv)
122 // frame[-1] contains the return address
123 uhwptr pc1 = frame[-1];
125 uhwptr pc1 = frame[1];
127 // Let's assume that any pointer in the 0th page (i.e. <0x1000 on i386 and
128 // x86_64) is invalid and stop unwinding here. If we're adding support for
129 // a platform where this isn't true, we need to reconsider this check.
133 trace_buffer[size++] = (uptr) pc1;
135 bottom = (uptr)frame;
137 // frame[-2] contain fp of the previous frame
138 uptr new_bp = (uptr)frame[-2];
140 uptr new_bp = (uptr)frame[0];
142 frame = GetCanonicFrame(new_bp, stack_top, bottom);
146 #endif // !defined(__sparc__)
148 void BufferedStackTrace::PopStackFrames(uptr count) {
149 CHECK_LT(count, size);
151 for (uptr i = 0; i < size; ++i) {
152 trace_buffer[i] = trace_buffer[i + count];
156 static uptr Distance(uptr a, uptr b) { return a < b ? b - a : a - b; }
158 uptr BufferedStackTrace::LocatePcInTrace(uptr pc) {
160 for (uptr i = 1; i < size; ++i) {
161 if (Distance(trace[i], pc) < Distance(trace[best], pc)) best = i;
166 } // namespace __sanitizer