granicus.if.org Git - strace/blob - unwind.h

   1 /*
   2  * Unwinder backends interface.
   3  *
   4  * Copyright (c) 2013 Luca Clementi <luca.clementi@gmail.com>
   5  * Copyright (c) 2013-2018 The strace developers.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. 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  * 3. 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 #ifndef STRACE_UNWIND_H
  31 #define STRACE_UNWIND_H
  32
  33 #include "defs.h"
  34
  35 /*
  36  * Type used in stacktrace walker.
  37  */
  38
  39 /* This storage be enough large to store unw_word_t. */
  40 typedef unsigned long unwind_function_offset_t;
  41
  42 typedef void (*unwind_call_action_fn)(void *data,
  43                                       const char *binary_filename,
  44                                       const char *symbol_name,
  45                                       unwind_function_offset_t function_offset,
  46                                       unsigned long true_offset);
  47 typedef void (*unwind_error_action_fn)(void *data,
  48                                        const char *error,
  49                                        unsigned long true_offset);
  50
  51 struct unwind_unwinder_t {
  52         const char *name;
  53
  54         /* Initialize the unwinder. */
  55         void   (*init)(void);
  56
  57         /* Make/destroy the context data attached to tcb. */
  58         void * (*tcb_init)(struct tcb *);
  59         void   (*tcb_fin)(struct tcb *);
  60
  61         /* Walk the stack. */
  62         void   (*tcb_walk)(struct tcb *,
  63                            unwind_call_action_fn,
  64                            unwind_error_action_fn,
  65                            void *);
  66 };
  67
  68 extern const struct unwind_unwinder_t unwinder;
  69
  70 #endif /* !STRACE_UNWIND_H */