src/stacktrace.h

   1 // Copyright (c) 2000 - 2007, Google Inc.
   2 // All rights reserved.
   3 //
   4 // Redistribution and use in source and binary forms, with or without
   5 // modification, are permitted provided that the following conditions are
   6 // met:
   7 //
   8 //     * Redistributions of source code must retain the above copyright
   9 // notice, this list of conditions and the following disclaimer.
  10 //     * Redistributions in binary form must reproduce the above
  11 // copyright notice, this list of conditions and the following disclaimer
  12 // in the documentation and/or other materials provided with the
  13 // distribution.
  14 //     * Neither the name of Google Inc. nor the names of its
  15 // contributors may be used to endorse or promote products derived from
  16 // this software without specific prior written permission.
  17 //
  18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29 //
  30 // Routines to extract the current stack trace.  These functions are
  31 // thread-safe.
  32
  33 #ifndef BASE_STACKTRACE_H_
  34 #define BASE_STACKTRACE_H_
  35
  36 #include "config.h"
  37 #include "glog/logging.h"
  38
  39 _START_GOOGLE_NAMESPACE_
  40
  41 // This is similar to the GetStackFrames routine, except that it returns
  42 // the stack trace only, and not the stack frame sizes as well.
  43 // Example:
  44 //      main() { foo(); }
  45 //      foo() { bar(); }
  46 //      bar() {
  47 //        void* result[10];
  48 //        int depth = GetStackFrames(result, 10, 1);
  49 //      }
  50 //
  51 // This produces:
  52 //      result[0]       foo
  53 //      result[1]       main
  54 //           ....       ...
  55 //
  56 // "result" must not be NULL.
  57 GOOGLE_GLOG_DLL_DECL int GetStackTrace(void** result, int max_depth, int skip_count);
  58
  59 _END_GOOGLE_NAMESPACE_
  60
  61 #endif  // BASE_STACKTRACE_H_