15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2005, Google Inc. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// All rights reserved. 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Redistribution and use in source and binary forms, with or without 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// modification, are permitted provided that the following conditions are 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// met: 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// * Redistributions of source code must retain the above copyright 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// notice, this list of conditions and the following disclaimer. 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// * Redistributions in binary form must reproduce the above 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// copyright notice, this list of conditions and the following disclaimer 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// in the documentation and/or other materials provided with the 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// distribution. 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// * Neither the name of Google Inc. nor the names of its 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// contributors may be used to endorse or promote products derived from 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// this software without specific prior written permission. 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// --- 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Author: Arun Sharma 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Produce stack trace using libunwind 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef BASE_STACKTRACE_LIBINWIND_INL_H_ 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define BASE_STACKTRACE_LIBINWIND_INL_H_ 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Note: this file is included into stacktrace.cc more than once. 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Anything that should only be defined once should be here: 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// We only need local unwinder. 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define UNW_LOCAL_ONLY 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)extern "C" { 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <assert.h> 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string.h> // for memset() 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <libunwind.h> 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "gperftools/stacktrace.h" 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/logging.h" 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Sometimes, we can try to get a stack trace from within a stack 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// trace, because libunwind can call mmap (maybe indirectly via an 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// internal mmap based memory allocator), and that mmap gets trapped 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// and causes a stack-trace request. If were to try to honor that 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// recursive request, we'd end up with infinite recursion or deadlock. 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Luckily, it's safe to ignore those subsequent traces. In such 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// cases, we return 0 to indicate the situation. 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)static __thread int recursive; 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // BASE_STACKTRACE_LIBINWIND_INL_H_ 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Note: this part of the file is included several times. 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Do not put globals below. 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// The following 4 functions are generated from the code below: 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// GetStack{Trace,Frames}() 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// GetStack{Trace,Frames}WithContext() 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// These functions take the following args: 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// void** result: the stack-trace, as an array 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// int* sizes: the size of each stack frame, as an array 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// (GetStackFrames* only) 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// int max_depth: the size of the result (and sizes) array(s) 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// int skip_count: how many stack pointers to skip before storing in result 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// void* ucp: a ucontext_t* (GetStack{Trace,Frames}WithContext only) 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int GET_STACK_TRACE_OR_FRAMES { 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void *ip; 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int n = 0; 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unw_cursor_t cursor; 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unw_context_t uc; 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if IS_STACK_FRAMES 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unw_word_t sp = 0, next_sp = 0; 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (recursive) { 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return 0; 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ++recursive; 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unw_getcontext(&uc); 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int ret = unw_init_local(&cursor, &uc); 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) assert(ret >= 0); 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) skip_count++; // Do not include current frame 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) while (skip_count--) { 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (unw_step(&cursor) <= 0) { 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) goto out; 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if IS_STACK_FRAMES 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (unw_get_reg(&cursor, UNW_REG_SP, &next_sp)) { 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) goto out; 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) while (n < max_depth) { 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (unw_get_reg(&cursor, UNW_REG_IP, (unw_word_t *) &ip) < 0) { 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) break; 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if IS_STACK_FRAMES 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) sizes[n] = 0; 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) result[n++] = ip; 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (unw_step(&cursor) <= 0) { 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) break; 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if IS_STACK_FRAMES 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) sp = next_sp; 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (unw_get_reg(&cursor, UNW_REG_SP, &next_sp) , 0) { 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) break; 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) sizes[n - 1] = next_sp - sp; 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)out: 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) --recursive; 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return n; 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 129