src/gallium/auxiliary/util/u_debug_stack.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2009 VMware, Inc.
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sub license, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  21  * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
  22  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  *
  26  **************************************************************************/
  27
  28 #ifndef U_DEBUG_STACK_H_
  29 #define U_DEBUG_STACK_H_
  30
  31
  32 /**
  33  * @file
  34  * Stack backtracing.
  35  *
  36  * @author Jose Fonseca <jfonseca@vmware.com>
  37  */
  38
  39
  40 #ifdef  __cplusplus
  41 extern "C" {
  42 #endif
  43
  44
  45 /**
  46  * Represent a frame from a stack backtrace.
  47  *
  48  * XXX: Do not change this.
  49  *
  50  * TODO: This should be refactored as a void * typedef.
  51  */
  52 struct debug_stack_frame
  53 {
  54    const void *function;
  55 };
  56
  57
  58 void
  59 debug_backtrace_capture(struct debug_stack_frame *backtrace,
  60                         unsigned start_frame,
  61                         unsigned nr_frames);
  62
  63 void
  64 debug_backtrace_dump(const struct debug_stack_frame *backtrace,
  65                      unsigned nr_frames);
  66
  67
  68 #ifdef  __cplusplus
  69 }
  70 #endif
  71
  72 #endif /* U_DEBUG_STACK_H_ */