uspace/lib/c/include/stacktrace.h

   1 /*
   2  * Copyright (c) 2009 Jakub Jermar
   3  * Copyright (c) 2010 Jiri Svoboda
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * - Redistributions of source code must retain the above copyright
  11  *   notice, this list of conditions and the following disclaimer.
  12  * - Redistributions in binary form must reproduce the above copyright
  13  *   notice, this list of conditions and the following disclaimer in the
  14  *   documentation and/or other materials provided with the distribution.
  15  * - The name of the author may not be used to endorse or promote products
  16  *   derived from this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 /** @addtogroup libc
  31  * @{
  32  */
  33 /** @file
  34  */
  35
  36 #ifndef _LIBC_STACKTRACE_H_
  37 #define _LIBC_STACKTRACE_H_
  38
  39 #include <errno.h>
  40 #include <stdint.h>
  41 #include <stdbool.h>
  42
  43 typedef struct {
  44         errno_t (*read_uintptr)(void *, uintptr_t, uintptr_t *);
  45         int (*printf)(const char *, ...);
  46 } stacktrace_ops_t;
  47
  48 typedef struct {
  49         void *op_arg;
  50         stacktrace_ops_t *ops;
  51 } stacktrace_t;
  52
  53 extern void stacktrace_print(void);
  54 extern void stacktrace_kio_print(void);
  55 extern void stacktrace_print_fp_pc(uintptr_t, uintptr_t);
  56 extern void stacktrace_print_generic(stacktrace_ops_t *, void *, uintptr_t,
  57     uintptr_t);
  58
  59 /*
  60  * The following interface is to be implemented by each architecture.
  61  */
  62 extern bool stacktrace_fp_valid(stacktrace_t *, uintptr_t);
  63 extern errno_t stacktrace_fp_prev(stacktrace_t *, uintptr_t, uintptr_t *);
  64 extern errno_t stacktrace_ra_get(stacktrace_t *, uintptr_t, uintptr_t *);
  65
  66 extern void stacktrace_prepare(void);
  67 extern uintptr_t stacktrace_fp_get(void);
  68 extern uintptr_t stacktrace_pc_get(void);
  69
  70 #endif
  71
  72 /** @}
  73  */