SAFE public projects git trees. - safe/jmp/linux-2.6/blob - kernel/trace/trace.h

   1 #ifndef _LINUX_KERNEL_TRACE_H
   2 #define _LINUX_KERNEL_TRACE_H
   3
   4 #include <linux/fs.h>
   5 #include <asm/atomic.h>
   6 #include <linux/sched.h>
   7 #include <linux/clocksource.h>
   8 #include <linux/mmiotrace.h>
   9
  10 enum trace_type {
  11         __TRACE_FIRST_TYPE = 0,
  12
  13         TRACE_FN,
  14         TRACE_CTX,
  15         TRACE_WAKE,
  16         TRACE_CONT,
  17         TRACE_STACK,
  18         TRACE_PRINT,
  19         TRACE_SPECIAL,
  20         TRACE_MMIO_RW,
  21         TRACE_MMIO_MAP,
  22
  23         __TRACE_LAST_TYPE
  24 };
  25
  26 /*
  27  * Function trace entry - function address and parent function addres:
  28  */
  29 struct ftrace_entry {
  30         unsigned long           ip;
  31         unsigned long           parent_ip;
  32 };
  33
  34 /*
  35  * Context switch trace entry - which task (and prio) we switched from/to:
  36  */
  37 struct ctx_switch_entry {
  38         unsigned int            prev_pid;
  39         unsigned char           prev_prio;
  40         unsigned char           prev_state;
  41         unsigned int            next_pid;
  42         unsigned char           next_prio;
  43         unsigned char           next_state;
  44 };
  45
  46 /*
  47  * Special (free-form) trace entry:
  48  */
  49 struct special_entry {
  50         unsigned long           arg1;
  51         unsigned long           arg2;
  52         unsigned long           arg3;
  53 };
  54
  55 /*
  56  * Stack-trace entry:
  57  */
  58
  59 #define FTRACE_STACK_ENTRIES    8
  60
  61 struct stack_entry {
  62         unsigned long           caller[FTRACE_STACK_ENTRIES];
  63 };
  64
  65 /*
  66  * ftrace_printk entry:
  67  */
  68 struct print_entry {
  69         unsigned long           ip;
  70         char                    buf[];
  71 };
  72
  73 /*
  74  * The trace field - the most basic unit of tracing. This is what
  75  * is printed in the end as a single line in the trace output, such as:
  76  *
  77  *     bash-15816 [01]   235.197585: idle_cpu <- irq_enter
  78  */
  79 struct trace_field {
  80         char                    cpu;
  81         char                    flags;
  82         char                    preempt_count;
  83         int                     pid;
  84         cycle_t                 t;
  85         union {
  86                 struct ftrace_entry             fn;
  87                 struct ctx_switch_entry         ctx;
  88                 struct special_entry            special;
  89                 struct stack_entry              stack;
  90                 struct print_entry              print;
  91                 struct mmiotrace_rw             mmiorw;
  92                 struct mmiotrace_map            mmiomap;
  93         };
  94 };
  95
  96 struct trace_field_cont {
  97         char                            buf[sizeof(struct trace_field)];
  98 };
  99
 100 struct trace_entry {
 101         char                            type;
 102         union {
 103                 struct trace_field      field;
 104                 struct trace_field_cont cont;
 105         };
 106 };
 107
 108 #define TRACE_ENTRY_SIZE        sizeof(struct trace_entry)
 109
 110 /*
 111  * The CPU trace array - it consists of thousands of trace entries
 112  * plus some other descriptor data: (for example which task started
 113  * the trace, etc.)
 114  */
 115 struct trace_array_cpu {
 116         struct list_head        trace_pages;
 117         atomic_t                disabled;
 118         raw_spinlock_t          lock;
 119         struct lock_class_key   lock_key;
 120
 121         /* these fields get copied into max-trace: */
 122         unsigned                trace_head_idx;
 123         unsigned                trace_tail_idx;
 124         void                    *trace_head; /* producer */
 125         void                    *trace_tail; /* consumer */
 126         unsigned long           trace_idx;
 127         unsigned long           overrun;
 128         unsigned long           saved_latency;
 129         unsigned long           critical_start;
 130         unsigned long           critical_end;
 131         unsigned long           critical_sequence;
 132         unsigned long           nice;
 133         unsigned long           policy;
 134         unsigned long           rt_priority;
 135         cycle_t                 preempt_timestamp;
 136         pid_t                   pid;
 137         uid_t                   uid;
 138         char                    comm[TASK_COMM_LEN];
 139 };
 140
 141 struct trace_iterator;
 142
 143 /*
 144  * The trace array - an array of per-CPU trace arrays. This is the
 145  * highest level data structure that individual tracers deal with.
 146  * They have on/off state as well:
 147  */
 148 struct trace_array {
 149         unsigned long           entries;
 150         long                    ctrl;
 151         int                     cpu;
 152         cycle_t                 time_start;
 153         struct task_struct      *waiter;
 154         struct trace_array_cpu  *data[NR_CPUS];
 155 };
 156
 157 /*
 158  * A specific tracer, represented by methods that operate on a trace array:
 159  */
 160 struct tracer {
 161         const char              *name;
 162         void                    (*init)(struct trace_array *tr);
 163         void                    (*reset)(struct trace_array *tr);
 164         void                    (*open)(struct trace_iterator *iter);
 165         void                    (*pipe_open)(struct trace_iterator *iter);
 166         void                    (*close)(struct trace_iterator *iter);
 167         void                    (*start)(struct trace_iterator *iter);
 168         void                    (*stop)(struct trace_iterator *iter);
 169         ssize_t                 (*read)(struct trace_iterator *iter,
 170                                         struct file *filp, char __user *ubuf,
 171                                         size_t cnt, loff_t *ppos);
 172         void                    (*ctrl_update)(struct trace_array *tr);
 173 #ifdef CONFIG_FTRACE_STARTUP_TEST
 174         int                     (*selftest)(struct tracer *trace,
 175                                             struct trace_array *tr);
 176 #endif
 177         int                     (*print_line)(struct trace_iterator *iter);
 178         struct tracer           *next;
 179         int                     print_max;
 180 };
 181
 182 struct trace_seq {
 183         unsigned char           buffer[PAGE_SIZE];
 184         unsigned int            len;
 185         unsigned int            readpos;
 186 };
 187
 188 /*
 189  * Trace iterator - used by printout routines who present trace
 190  * results to users and which routines might sleep, etc:
 191  */
 192 struct trace_iterator {
 193         struct trace_array      *tr;
 194         struct tracer           *trace;
 195         void                    *private;
 196         long                    last_overrun[NR_CPUS];
 197         long                    overrun[NR_CPUS];
 198
 199         /* The below is zeroed out in pipe_read */
 200         struct trace_seq        seq;
 201         struct trace_entry      *ent;
 202         int                     cpu;
 203
 204         struct trace_entry      *prev_ent;
 205         int                     prev_cpu;
 206
 207         unsigned long           iter_flags;
 208         loff_t                  pos;
 209         unsigned long           next_idx[NR_CPUS];
 210         struct list_head        *next_page[NR_CPUS];
 211         unsigned                next_page_idx[NR_CPUS];
 212         long                    idx;
 213 };
 214
 215 void tracing_reset(struct trace_array_cpu *data);
 216 int tracing_open_generic(struct inode *inode, struct file *filp);
 217 struct dentry *tracing_init_dentry(void);
 218 void init_tracer_sysprof_debugfs(struct dentry *d_tracer);
 219
 220 void ftrace(struct trace_array *tr,
 221                             struct trace_array_cpu *data,
 222                             unsigned long ip,
 223                             unsigned long parent_ip,
 224                             unsigned long flags);
 225 void tracing_sched_switch_trace(struct trace_array *tr,
 226                                 struct trace_array_cpu *data,
 227                                 struct task_struct *prev,
 228                                 struct task_struct *next,
 229                                 unsigned long flags);
 230 void tracing_record_cmdline(struct task_struct *tsk);
 231
 232 void tracing_sched_wakeup_trace(struct trace_array *tr,
 233                                 struct trace_array_cpu *data,
 234                                 struct task_struct *wakee,
 235                                 struct task_struct *cur,
 236                                 unsigned long flags);
 237 void trace_special(struct trace_array *tr,
 238                    struct trace_array_cpu *data,
 239                    unsigned long arg1,
 240                    unsigned long arg2,
 241                    unsigned long arg3);
 242 void trace_function(struct trace_array *tr,
 243                     struct trace_array_cpu *data,
 244                     unsigned long ip,
 245                     unsigned long parent_ip,
 246                     unsigned long flags);
 247
 248 void tracing_start_cmdline_record(void);
 249 void tracing_stop_cmdline_record(void);
 250 int register_tracer(struct tracer *type);
 251 void unregister_tracer(struct tracer *type);
 252
 253 extern unsigned long nsecs_to_usecs(unsigned long nsecs);
 254
 255 extern unsigned long tracing_max_latency;
 256 extern unsigned long tracing_thresh;
 257
 258 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
 259 void update_max_tr_single(struct trace_array *tr,
 260                           struct task_struct *tsk, int cpu);
 261
 262 extern cycle_t ftrace_now(int cpu);
 263
 264 #ifdef CONFIG_FTRACE
 265 void tracing_start_function_trace(void);
 266 void tracing_stop_function_trace(void);
 267 #else
 268 # define tracing_start_function_trace()         do { } while (0)
 269 # define tracing_stop_function_trace()          do { } while (0)
 270 #endif
 271
 272 #ifdef CONFIG_CONTEXT_SWITCH_TRACER
 273 typedef void
 274 (*tracer_switch_func_t)(void *private,
 275                         void *__rq,
 276                         struct task_struct *prev,
 277                         struct task_struct *next);
 278
 279 struct tracer_switch_ops {
 280         tracer_switch_func_t            func;
 281         void                            *private;
 282         struct tracer_switch_ops        *next;
 283 };
 284
 285 #endif /* CONFIG_CONTEXT_SWITCH_TRACER */
 286
 287 #ifdef CONFIG_DYNAMIC_FTRACE
 288 extern unsigned long ftrace_update_tot_cnt;
 289 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
 290 extern int DYN_FTRACE_TEST_NAME(void);
 291 #endif
 292
 293 #ifdef CONFIG_MMIOTRACE
 294 extern void __trace_mmiotrace_rw(struct trace_array *tr,
 295                                 struct trace_array_cpu *data,
 296                                 struct mmiotrace_rw *rw);
 297 extern void __trace_mmiotrace_map(struct trace_array *tr,
 298                                 struct trace_array_cpu *data,
 299                                 struct mmiotrace_map *map);
 300 #endif
 301
 302 #ifdef CONFIG_FTRACE_STARTUP_TEST
 303 #ifdef CONFIG_FTRACE
 304 extern int trace_selftest_startup_function(struct tracer *trace,
 305                                            struct trace_array *tr);
 306 #endif
 307 #ifdef CONFIG_IRQSOFF_TRACER
 308 extern int trace_selftest_startup_irqsoff(struct tracer *trace,
 309                                           struct trace_array *tr);
 310 #endif
 311 #ifdef CONFIG_PREEMPT_TRACER
 312 extern int trace_selftest_startup_preemptoff(struct tracer *trace,
 313                                              struct trace_array *tr);
 314 #endif
 315 #if defined(CONFIG_IRQSOFF_TRACER) && defined(CONFIG_PREEMPT_TRACER)
 316 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
 317                                                  struct trace_array *tr);
 318 #endif
 319 #ifdef CONFIG_SCHED_TRACER
 320 extern int trace_selftest_startup_wakeup(struct tracer *trace,
 321                                          struct trace_array *tr);
 322 #endif
 323 #ifdef CONFIG_CONTEXT_SWITCH_TRACER
 324 extern int trace_selftest_startup_sched_switch(struct tracer *trace,
 325                                                struct trace_array *tr);
 326 #endif
 327 #ifdef CONFIG_SYSPROF_TRACER
 328 extern int trace_selftest_startup_sysprof(struct tracer *trace,
 329                                                struct trace_array *tr);
 330 #endif
 331 #endif /* CONFIG_FTRACE_STARTUP_TEST */
 332
 333 extern void *head_page(struct trace_array_cpu *data);
 334 extern int trace_seq_printf(struct trace_seq *s, const char *fmt, ...);
 335 extern ssize_t trace_seq_to_user(struct trace_seq *s, char __user *ubuf,
 336                                  size_t cnt);
 337 extern long ns2usecs(cycle_t nsec);
 338
 339 extern unsigned long trace_flags;
 340
 341 /*
 342  * trace_iterator_flags is an enumeration that defines bit
 343  * positions into trace_flags that controls the output.
 344  *
 345  * NOTE: These bits must match the trace_options array in
 346  *       trace.c.
 347  */
 348 enum trace_iterator_flags {
 349         TRACE_ITER_PRINT_PARENT         = 0x01,
 350         TRACE_ITER_SYM_OFFSET           = 0x02,
 351         TRACE_ITER_SYM_ADDR             = 0x04,
 352         TRACE_ITER_VERBOSE              = 0x08,
 353         TRACE_ITER_RAW                  = 0x10,
 354         TRACE_ITER_HEX                  = 0x20,
 355         TRACE_ITER_BIN                  = 0x40,
 356         TRACE_ITER_BLOCK                = 0x80,
 357         TRACE_ITER_STACKTRACE           = 0x100,
 358         TRACE_ITER_SCHED_TREE           = 0x200,
 359         TRACE_ITER_PRINTK               = 0x400,
 360 };
 361
 362 #endif /* _LINUX_KERNEL_TRACE_H */