gdb/tracepoint.h

   1 /* Data structures associated with tracepoints in GDB.
   2    Copyright (C) 1997, 1998, 1999, 2000, 2007 Free Software Foundation, Inc.
   3
   4    This file is part of GDB.
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 2 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program; if not, write to the Free Software
  18    Foundation, Inc., 51 Franklin Street, Fifth Floor,
  19    Boston, MA 02110-1301, USA.  */
  20
  21 #if !defined (TRACEPOINT_H)
  22 #define TRACEPOINT_H 1
  23
  24 /* The data structure for an action: */
  25 struct action_line
  26   {
  27     struct action_line *next;
  28     char *action;
  29   };
  30
  31 /* The data structure for a tracepoint: */
  32
  33 struct tracepoint
  34   {
  35     struct tracepoint *next;
  36
  37     int enabled_p;
  38
  39 #if 0
  40     /* Type of tracepoint.  (MVS FIXME: needed?) */
  41     enum tptype type;
  42
  43     /* What to do with this tracepoint after we hit it
  44        MVS FIXME: needed?).  */
  45     enum tpdisp disposition;
  46 #endif
  47     /* Number assigned to distinguish tracepoints.  */
  48     int number;
  49
  50     /* Address to trace at, or NULL if not an instruction tracepoint.
  51        (MVS ?) */
  52     CORE_ADDR address;
  53
  54     /* Line number of this address.
  55        Only matters if address is non-NULL.  */
  56     int line_number;
  57
  58     /* Source file name of this address.
  59        Only matters if address is non-NULL.  */
  60     char *source_file;
  61
  62     /* Number of times this tracepoint should single-step
  63        and collect additional data.  */
  64     long step_count;
  65
  66     /* Number of times this tracepoint should be hit before
  67        disabling/ending.  */
  68     int pass_count;
  69
  70     /* Chain of action lines to execute when this tracepoint is hit.  */
  71     struct action_line *actions;
  72
  73     /* Conditional (MVS ?).  */
  74     struct expression *cond;
  75
  76     /* String we used to set the tracepoint (malloc'd).
  77        Only matters if address is non-NULL.  */
  78     char *addr_string;
  79
  80     /* Language we used to set the tracepoint.  */
  81     enum language language;
  82
  83     /* Input radix we used to set the tracepoint.  */
  84     int input_radix;
  85
  86     /* Count of the number of times this tracepoint was taken, dumped
  87        with the info, but not used for anything else.  Useful for
  88        seeing how many times you hit a tracepoint prior to the program
  89        aborting, so you can back up to just before the abort.  */
  90     int hit_count;
  91
  92     /* Thread number for thread-specific tracepoint,
  93        or -1 if don't care.  */
  94     int thread;
  95
  96     /* BFD section, in case of overlays: no, I don't know if
  97        tracepoints are really gonna work with overlays.  */
  98     asection *section;
  99   };
 100
 101 enum actionline_type
 102   {
 103     BADLINE = -1,
 104     GENERIC = 0,
 105     END = 1,
 106     STEPPING = 2
 107   };
 108
 109
 110 /* The tracepoint chain of all tracepoints.  */
 111
 112 extern struct tracepoint *tracepoint_chain;
 113
 114 extern unsigned long trace_running_p;
 115
 116 /* A hook used to notify the UI of tracepoint operations.  */
 117
 118 void (*deprecated_create_tracepoint_hook) (struct tracepoint *);
 119 void (*deprecated_delete_tracepoint_hook) (struct tracepoint *);
 120 void (*deprecated_modify_tracepoint_hook) (struct tracepoint *);
 121 void (*deprecated_trace_find_hook) (char *arg, int from_tty);
 122 void (*deprecated_trace_start_stop_hook) (int start, int from_tty);
 123
 124 struct tracepoint *get_tracepoint_by_number (char **, int, int);
 125 int get_traceframe_number (void);
 126 void free_actions (struct tracepoint *);
 127 enum actionline_type validate_actionline (char **, struct tracepoint *);
 128
 129
 130 /* Walk the following statement or block through all tracepoints.
 131    ALL_TRACEPOINTS_SAFE does so even if the statment deletes the
 132    current breakpoint.  */
 133
 134 #define ALL_TRACEPOINTS(t)  for (t = tracepoint_chain; t; t = t->next)
 135
 136 #define ALL_TRACEPOINTS_SAFE(t,tmp)     \
 137         for (t = tracepoint_chain;      \
 138              t ? (tmp = t->next, 1) : 0;\
 139              t = tmp)
 140 #endif  /* TRACEPOINT_H */