1 // SPDX-License-Identifier: GPL-2.0 2 3 #ifndef _LINUX_KERNEL_TRACE_H 4 #define _LINUX_KERNEL_TRACE_H 5 6 #include <linux/fs.h> 7 #include <linux/atomic.h> 8 #include <linux/sched.h> 9 #include <linux/clocksource.h> 10 #include <linux/ring_buffer.h> 11 #include <linux/mmiotrace.h> 12 #include <linux/tracepoint.h> 13 #include <linux/ftrace.h> 14 #include <linux/trace.h> 15 #include <linux/hw_breakpoint.h> 16 #include <linux/trace_seq.h> 17 #include <linux/trace_events.h> 18 #include <linux/compiler.h> 19 #include <linux/glob.h> 20 #include <linux/irq_work.h> 21 #include <linux/workqueue.h> 22 #include <linux/ctype.h> 23 #include <linux/once_lite.h> 24 25 #include "pid_list.h" 26 27 #ifdef CONFIG_FTRACE_SYSCALLS 28 #include <asm/unistd.h> /* For NR_syscalls */ 29 #include <asm/syscall.h> /* some archs define it here */ 30 #endif 31 32 #define TRACE_MODE_WRITE 0640 33 #define TRACE_MODE_READ 0440 34 35 enum trace_type { 36 __TRACE_FIRST_TYPE = 0, 37 38 TRACE_FN, 39 TRACE_CTX, 40 TRACE_WAKE, 41 TRACE_STACK, 42 TRACE_PRINT, 43 TRACE_BPRINT, 44 TRACE_MMIO_RW, 45 TRACE_MMIO_MAP, 46 TRACE_BRANCH, 47 TRACE_GRAPH_RET, 48 TRACE_GRAPH_ENT, 49 TRACE_GRAPH_RETADDR_ENT, 50 TRACE_USER_STACK, 51 TRACE_BLK, 52 TRACE_BPUTS, 53 TRACE_HWLAT, 54 TRACE_OSNOISE, 55 TRACE_TIMERLAT, 56 TRACE_RAW_DATA, 57 TRACE_FUNC_REPEATS, 58 59 __TRACE_LAST_TYPE, 60 }; 61 62 63 #undef __field 64 #define __field(type, item) type item; 65 66 #undef __field_fn 67 #define __field_fn(type, item) type item; 68 69 #undef __field_struct 70 #define __field_struct(type, item) __field(type, item) 71 72 #undef __field_desc 73 #define __field_desc(type, container, item) 74 75 #undef __field_packed 76 #define __field_packed(type, container, item) 77 78 #undef __array 79 #define __array(type, item, size) type item[size]; 80 81 /* 82 * For backward compatibility, older user space expects to see the 83 * kernel_stack event with a fixed size caller field. But today the fix 84 * size is ignored by the kernel, and the real structure is dynamic. 85 * Expose to user space: "unsigned long caller[8];" but the real structure 86 * will be "unsigned long caller[] __counted_by(size)" 87 */ 88 #undef __stack_array 89 #define __stack_array(type, item, size, field) type item[] __counted_by(field); 90 91 #undef __array_desc 92 #define __array_desc(type, container, item, size) 93 94 #undef __dynamic_array 95 #define __dynamic_array(type, item) type item[]; 96 97 #undef __rel_dynamic_array 98 #define __rel_dynamic_array(type, item) type item[]; 99 100 #undef F_STRUCT 101 #define F_STRUCT(args...) args 102 103 #undef FTRACE_ENTRY 104 #define FTRACE_ENTRY(name, struct_name, id, tstruct, print) \ 105 struct struct_name { \ 106 struct trace_entry ent; \ 107 tstruct \ 108 } 109 110 #undef FTRACE_ENTRY_DUP 111 #define FTRACE_ENTRY_DUP(name, name_struct, id, tstruct, printk) 112 113 #undef FTRACE_ENTRY_REG 114 #define FTRACE_ENTRY_REG(name, struct_name, id, tstruct, print, regfn) \ 115 FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print)) 116 117 #undef FTRACE_ENTRY_PACKED 118 #define FTRACE_ENTRY_PACKED(name, struct_name, id, tstruct, print) \ 119 FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print)) __packed 120 121 #include "trace_entries.h" 122 123 /* Use this for memory failure errors */ 124 #define MEM_FAIL(condition, fmt, ...) \ 125 DO_ONCE_LITE_IF(condition, pr_err, "ERROR: " fmt, ##__VA_ARGS__) 126 127 #define FAULT_STRING "(fault)" 128 129 #define HIST_STACKTRACE_DEPTH 16 130 #define HIST_STACKTRACE_SIZE (HIST_STACKTRACE_DEPTH * sizeof(unsigned long)) 131 #define HIST_STACKTRACE_SKIP 5 132 133 /* 134 * syscalls are special, and need special handling, this is why 135 * they are not included in trace_entries.h 136 */ 137 struct syscall_trace_enter { 138 struct trace_entry ent; 139 int nr; 140 unsigned long args[]; 141 }; 142 143 struct syscall_trace_exit { 144 struct trace_entry ent; 145 int nr; 146 long ret; 147 }; 148 149 struct kprobe_trace_entry_head { 150 struct trace_entry ent; 151 unsigned long ip; 152 }; 153 154 struct eprobe_trace_entry_head { 155 struct trace_entry ent; 156 }; 157 158 struct kretprobe_trace_entry_head { 159 struct trace_entry ent; 160 unsigned long func; 161 unsigned long ret_ip; 162 }; 163 164 struct fentry_trace_entry_head { 165 struct trace_entry ent; 166 unsigned long ip; 167 }; 168 169 struct fexit_trace_entry_head { 170 struct trace_entry ent; 171 unsigned long func; 172 unsigned long ret_ip; 173 }; 174 175 #define TRACE_BUF_SIZE 1024 176 177 struct trace_array; 178 179 /* 180 * The CPU trace array - it consists of thousands of trace entries 181 * plus some other descriptor data: (for example which task started 182 * the trace, etc.) 183 */ 184 struct trace_array_cpu { 185 atomic_t disabled; 186 void *buffer_page; /* ring buffer spare */ 187 188 unsigned long entries; 189 unsigned long saved_latency; 190 unsigned long critical_start; 191 unsigned long critical_end; 192 unsigned long critical_sequence; 193 unsigned long nice; 194 unsigned long policy; 195 unsigned long rt_priority; 196 unsigned long skipped_entries; 197 u64 preempt_timestamp; 198 pid_t pid; 199 kuid_t uid; 200 char comm[TASK_COMM_LEN]; 201 202 #ifdef CONFIG_FUNCTION_TRACER 203 int ftrace_ignore_pid; 204 #endif 205 bool ignore_pid; 206 }; 207 208 struct tracer; 209 struct trace_option_dentry; 210 211 struct array_buffer { 212 struct trace_array *tr; 213 struct trace_buffer *buffer; 214 struct trace_array_cpu __percpu *data; 215 u64 time_start; 216 int cpu; 217 }; 218 219 #define TRACE_FLAGS_MAX_SIZE 32 220 221 struct trace_options { 222 struct tracer *tracer; 223 struct trace_option_dentry *topts; 224 }; 225 226 struct trace_pid_list *trace_pid_list_alloc(void); 227 void trace_pid_list_free(struct trace_pid_list *pid_list); 228 bool trace_pid_list_is_set(struct trace_pid_list *pid_list, unsigned int pid); 229 int trace_pid_list_set(struct trace_pid_list *pid_list, unsigned int pid); 230 int trace_pid_list_clear(struct trace_pid_list *pid_list, unsigned int pid); 231 int trace_pid_list_first(struct trace_pid_list *pid_list, unsigned int *pid); 232 int trace_pid_list_next(struct trace_pid_list *pid_list, unsigned int pid, 233 unsigned int *next); 234 235 enum { 236 TRACE_PIDS = BIT(0), 237 TRACE_NO_PIDS = BIT(1), 238 }; 239 240 static inline bool pid_type_enabled(int type, struct trace_pid_list *pid_list, 241 struct trace_pid_list *no_pid_list) 242 { 243 /* Return true if the pid list in type has pids */ 244 return ((type & TRACE_PIDS) && pid_list) || 245 ((type & TRACE_NO_PIDS) && no_pid_list); 246 } 247 248 static inline bool still_need_pid_events(int type, struct trace_pid_list *pid_list, 249 struct trace_pid_list *no_pid_list) 250 { 251 /* 252 * Turning off what is in @type, return true if the "other" 253 * pid list, still has pids in it. 254 */ 255 return (!(type & TRACE_PIDS) && pid_list) || 256 (!(type & TRACE_NO_PIDS) && no_pid_list); 257 } 258 259 typedef bool (*cond_update_fn_t)(struct trace_array *tr, void *cond_data); 260 261 /** 262 * struct cond_snapshot - conditional snapshot data and callback 263 * 264 * The cond_snapshot structure encapsulates a callback function and 265 * data associated with the snapshot for a given tracing instance. 266 * 267 * When a snapshot is taken conditionally, by invoking 268 * tracing_snapshot_cond(tr, cond_data), the cond_data passed in is 269 * passed in turn to the cond_snapshot.update() function. That data 270 * can be compared by the update() implementation with the cond_data 271 * contained within the struct cond_snapshot instance associated with 272 * the trace_array. Because the tr->max_lock is held throughout the 273 * update() call, the update() function can directly retrieve the 274 * cond_snapshot and cond_data associated with the per-instance 275 * snapshot associated with the trace_array. 276 * 277 * The cond_snapshot.update() implementation can save data to be 278 * associated with the snapshot if it decides to, and returns 'true' 279 * in that case, or it returns 'false' if the conditional snapshot 280 * shouldn't be taken. 281 * 282 * The cond_snapshot instance is created and associated with the 283 * user-defined cond_data by tracing_cond_snapshot_enable(). 284 * Likewise, the cond_snapshot instance is destroyed and is no longer 285 * associated with the trace instance by 286 * tracing_cond_snapshot_disable(). 287 * 288 * The method below is required. 289 * 290 * @update: When a conditional snapshot is invoked, the update() 291 * callback function is invoked with the tr->max_lock held. The 292 * update() implementation signals whether or not to actually 293 * take the snapshot, by returning 'true' if so, 'false' if no 294 * snapshot should be taken. Because the max_lock is held for 295 * the duration of update(), the implementation is safe to 296 * directly retrieved and save any implementation data it needs 297 * to in association with the snapshot. 298 */ 299 struct cond_snapshot { 300 void *cond_data; 301 cond_update_fn_t update; 302 }; 303 304 /* 305 * struct trace_func_repeats - used to keep track of the consecutive 306 * (on the same CPU) calls of a single function. 307 */ 308 struct trace_func_repeats { 309 unsigned long ip; 310 unsigned long parent_ip; 311 unsigned long count; 312 u64 ts_last_call; 313 }; 314 315 /* 316 * The trace array - an array of per-CPU trace arrays. This is the 317 * highest level data structure that individual tracers deal with. 318 * They have on/off state as well: 319 */ 320 struct trace_array { 321 struct list_head list; 322 char *name; 323 struct array_buffer array_buffer; 324 #ifdef CONFIG_TRACER_MAX_TRACE 325 /* 326 * The max_buffer is used to snapshot the trace when a maximum 327 * latency is reached, or when the user initiates a snapshot. 328 * Some tracers will use this to store a maximum trace while 329 * it continues examining live traces. 330 * 331 * The buffers for the max_buffer are set up the same as the array_buffer 332 * When a snapshot is taken, the buffer of the max_buffer is swapped 333 * with the buffer of the array_buffer and the buffers are reset for 334 * the array_buffer so the tracing can continue. 335 */ 336 struct array_buffer max_buffer; 337 bool allocated_snapshot; 338 spinlock_t snapshot_trigger_lock; 339 unsigned int snapshot; 340 unsigned long max_latency; 341 #ifdef CONFIG_FSNOTIFY 342 struct dentry *d_max_latency; 343 struct work_struct fsnotify_work; 344 struct irq_work fsnotify_irqwork; 345 #endif 346 #endif 347 /* The below is for memory mapped ring buffer */ 348 unsigned int mapped; 349 unsigned long range_addr_start; 350 unsigned long range_addr_size; 351 long text_delta; 352 long data_delta; 353 354 struct trace_pid_list __rcu *filtered_pids; 355 struct trace_pid_list __rcu *filtered_no_pids; 356 /* 357 * max_lock is used to protect the swapping of buffers 358 * when taking a max snapshot. The buffers themselves are 359 * protected by per_cpu spinlocks. But the action of the swap 360 * needs its own lock. 361 * 362 * This is defined as a arch_spinlock_t in order to help 363 * with performance when lockdep debugging is enabled. 364 * 365 * It is also used in other places outside the update_max_tr 366 * so it needs to be defined outside of the 367 * CONFIG_TRACER_MAX_TRACE. 368 */ 369 arch_spinlock_t max_lock; 370 int buffer_disabled; 371 #ifdef CONFIG_FTRACE_SYSCALLS 372 int sys_refcount_enter; 373 int sys_refcount_exit; 374 struct trace_event_file __rcu *enter_syscall_files[NR_syscalls]; 375 struct trace_event_file __rcu *exit_syscall_files[NR_syscalls]; 376 #endif 377 int stop_count; 378 int clock_id; 379 int nr_topts; 380 bool clear_trace; 381 int buffer_percent; 382 unsigned int n_err_log_entries; 383 struct tracer *current_trace; 384 unsigned int trace_flags; 385 unsigned char trace_flags_index[TRACE_FLAGS_MAX_SIZE]; 386 unsigned int flags; 387 raw_spinlock_t start_lock; 388 const char *system_names; 389 struct list_head err_log; 390 struct dentry *dir; 391 struct dentry *options; 392 struct dentry *percpu_dir; 393 struct eventfs_inode *event_dir; 394 struct trace_options *topts; 395 struct list_head systems; 396 struct list_head events; 397 struct trace_event_file *trace_marker_file; 398 cpumask_var_t tracing_cpumask; /* only trace on set CPUs */ 399 /* one per_cpu trace_pipe can be opened by only one user */ 400 cpumask_var_t pipe_cpumask; 401 int ref; 402 int trace_ref; 403 #ifdef CONFIG_FUNCTION_TRACER 404 struct ftrace_ops *ops; 405 struct trace_pid_list __rcu *function_pids; 406 struct trace_pid_list __rcu *function_no_pids; 407 #ifdef CONFIG_FUNCTION_GRAPH_TRACER 408 struct fgraph_ops *gops; 409 #endif 410 #ifdef CONFIG_DYNAMIC_FTRACE 411 /* All of these are protected by the ftrace_lock */ 412 struct list_head func_probes; 413 struct list_head mod_trace; 414 struct list_head mod_notrace; 415 #endif 416 /* function tracing enabled */ 417 int function_enabled; 418 #endif 419 int no_filter_buffering_ref; 420 struct list_head hist_vars; 421 #ifdef CONFIG_TRACER_SNAPSHOT 422 struct cond_snapshot *cond_snapshot; 423 #endif 424 struct trace_func_repeats __percpu *last_func_repeats; 425 /* 426 * On boot up, the ring buffer is set to the minimum size, so that 427 * we do not waste memory on systems that are not using tracing. 428 */ 429 bool ring_buffer_expanded; 430 }; 431 432 enum { 433 TRACE_ARRAY_FL_GLOBAL = BIT(0), 434 TRACE_ARRAY_FL_BOOT = BIT(1), 435 }; 436 437 extern struct list_head ftrace_trace_arrays; 438 439 extern struct mutex trace_types_lock; 440 441 extern int trace_array_get(struct trace_array *tr); 442 extern int tracing_check_open_get_tr(struct trace_array *tr); 443 extern struct trace_array *trace_array_find(const char *instance); 444 extern struct trace_array *trace_array_find_get(const char *instance); 445 446 extern u64 tracing_event_time_stamp(struct trace_buffer *buffer, struct ring_buffer_event *rbe); 447 extern int tracing_set_filter_buffering(struct trace_array *tr, bool set); 448 extern int tracing_set_clock(struct trace_array *tr, const char *clockstr); 449 450 extern bool trace_clock_in_ns(struct trace_array *tr); 451 452 /* 453 * The global tracer (top) should be the first trace array added, 454 * but we check the flag anyway. 455 */ 456 static inline struct trace_array *top_trace_array(void) 457 { 458 struct trace_array *tr; 459 460 if (list_empty(&ftrace_trace_arrays)) 461 return NULL; 462 463 tr = list_entry(ftrace_trace_arrays.prev, 464 typeof(*tr), list); 465 WARN_ON(!(tr->flags & TRACE_ARRAY_FL_GLOBAL)); 466 return tr; 467 } 468 469 #define FTRACE_CMP_TYPE(var, type) \ 470 __builtin_types_compatible_p(typeof(var), type *) 471 472 #undef IF_ASSIGN 473 #define IF_ASSIGN(var, entry, etype, id) \ 474 if (FTRACE_CMP_TYPE(var, etype)) { \ 475 var = (typeof(var))(entry); \ 476 WARN_ON(id != 0 && (entry)->type != id); \ 477 break; \ 478 } 479 480 /* Will cause compile errors if type is not found. */ 481 extern void __ftrace_bad_type(void); 482 483 /* 484 * The trace_assign_type is a verifier that the entry type is 485 * the same as the type being assigned. To add new types simply 486 * add a line with the following format: 487 * 488 * IF_ASSIGN(var, ent, type, id); 489 * 490 * Where "type" is the trace type that includes the trace_entry 491 * as the "ent" item. And "id" is the trace identifier that is 492 * used in the trace_type enum. 493 * 494 * If the type can have more than one id, then use zero. 495 */ 496 #define trace_assign_type(var, ent) \ 497 do { \ 498 IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \ 499 IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \ 500 IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \ 501 IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\ 502 IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \ 503 IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT); \ 504 IF_ASSIGN(var, ent, struct bputs_entry, TRACE_BPUTS); \ 505 IF_ASSIGN(var, ent, struct hwlat_entry, TRACE_HWLAT); \ 506 IF_ASSIGN(var, ent, struct osnoise_entry, TRACE_OSNOISE);\ 507 IF_ASSIGN(var, ent, struct timerlat_entry, TRACE_TIMERLAT);\ 508 IF_ASSIGN(var, ent, struct raw_data_entry, TRACE_RAW_DATA);\ 509 IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \ 510 TRACE_MMIO_RW); \ 511 IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \ 512 TRACE_MMIO_MAP); \ 513 IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \ 514 IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \ 515 TRACE_GRAPH_ENT); \ 516 IF_ASSIGN(var, ent, struct fgraph_retaddr_ent_entry,\ 517 TRACE_GRAPH_RETADDR_ENT); \ 518 IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \ 519 TRACE_GRAPH_RET); \ 520 IF_ASSIGN(var, ent, struct func_repeats_entry, \ 521 TRACE_FUNC_REPEATS); \ 522 __ftrace_bad_type(); \ 523 } while (0) 524 525 /* 526 * An option specific to a tracer. This is a boolean value. 527 * The bit is the bit index that sets its value on the 528 * flags value in struct tracer_flags. 529 */ 530 struct tracer_opt { 531 const char *name; /* Will appear on the trace_options file */ 532 u32 bit; /* Mask assigned in val field in tracer_flags */ 533 }; 534 535 /* 536 * The set of specific options for a tracer. Your tracer 537 * have to set the initial value of the flags val. 538 */ 539 struct tracer_flags { 540 u32 val; 541 struct tracer_opt *opts; 542 struct tracer *trace; 543 }; 544 545 /* Makes more easy to define a tracer opt */ 546 #define TRACER_OPT(s, b) .name = #s, .bit = b 547 548 549 struct trace_option_dentry { 550 struct tracer_opt *opt; 551 struct tracer_flags *flags; 552 struct trace_array *tr; 553 struct dentry *entry; 554 }; 555 556 /** 557 * struct tracer - a specific tracer and its callbacks to interact with tracefs 558 * @name: the name chosen to select it on the available_tracers file 559 * @init: called when one switches to this tracer (echo name > current_tracer) 560 * @reset: called when one switches to another tracer 561 * @start: called when tracing is unpaused (echo 1 > tracing_on) 562 * @stop: called when tracing is paused (echo 0 > tracing_on) 563 * @update_thresh: called when tracing_thresh is updated 564 * @open: called when the trace file is opened 565 * @pipe_open: called when the trace_pipe file is opened 566 * @close: called when the trace file is released 567 * @pipe_close: called when the trace_pipe file is released 568 * @read: override the default read callback on trace_pipe 569 * @splice_read: override the default splice_read callback on trace_pipe 570 * @selftest: selftest to run on boot (see trace_selftest.c) 571 * @print_headers: override the first lines that describe your columns 572 * @print_line: callback that prints a trace 573 * @set_flag: signals one of your private flags changed (trace_options file) 574 * @flags: your private flags 575 */ 576 struct tracer { 577 const char *name; 578 int (*init)(struct trace_array *tr); 579 void (*reset)(struct trace_array *tr); 580 void (*start)(struct trace_array *tr); 581 void (*stop)(struct trace_array *tr); 582 int (*update_thresh)(struct trace_array *tr); 583 void (*open)(struct trace_iterator *iter); 584 void (*pipe_open)(struct trace_iterator *iter); 585 void (*close)(struct trace_iterator *iter); 586 void (*pipe_close)(struct trace_iterator *iter); 587 ssize_t (*read)(struct trace_iterator *iter, 588 struct file *filp, char __user *ubuf, 589 size_t cnt, loff_t *ppos); 590 ssize_t (*splice_read)(struct trace_iterator *iter, 591 struct file *filp, 592 loff_t *ppos, 593 struct pipe_inode_info *pipe, 594 size_t len, 595 unsigned int flags); 596 #ifdef CONFIG_FTRACE_STARTUP_TEST 597 int (*selftest)(struct tracer *trace, 598 struct trace_array *tr); 599 #endif 600 void (*print_header)(struct seq_file *m); 601 enum print_line_t (*print_line)(struct trace_iterator *iter); 602 /* If you handled the flag setting, return 0 */ 603 int (*set_flag)(struct trace_array *tr, 604 u32 old_flags, u32 bit, int set); 605 /* Return 0 if OK with change, else return non-zero */ 606 int (*flag_changed)(struct trace_array *tr, 607 u32 mask, int set); 608 struct tracer *next; 609 struct tracer_flags *flags; 610 int enabled; 611 bool print_max; 612 bool allow_instances; 613 #ifdef CONFIG_TRACER_MAX_TRACE 614 bool use_max_tr; 615 #endif 616 /* True if tracer cannot be enabled in kernel param */ 617 bool noboot; 618 }; 619 620 static inline struct ring_buffer_iter * 621 trace_buffer_iter(struct trace_iterator *iter, int cpu) 622 { 623 return iter->buffer_iter ? iter->buffer_iter[cpu] : NULL; 624 } 625 626 int tracer_init(struct tracer *t, struct trace_array *tr); 627 int tracing_is_enabled(void); 628 void tracing_reset_online_cpus(struct array_buffer *buf); 629 void tracing_reset_all_online_cpus(void); 630 void tracing_reset_all_online_cpus_unlocked(void); 631 int tracing_open_generic(struct inode *inode, struct file *filp); 632 int tracing_open_generic_tr(struct inode *inode, struct file *filp); 633 int tracing_release_generic_tr(struct inode *inode, struct file *file); 634 int tracing_open_file_tr(struct inode *inode, struct file *filp); 635 int tracing_release_file_tr(struct inode *inode, struct file *filp); 636 int tracing_single_release_file_tr(struct inode *inode, struct file *filp); 637 bool tracing_is_disabled(void); 638 bool tracer_tracing_is_on(struct trace_array *tr); 639 void tracer_tracing_on(struct trace_array *tr); 640 void tracer_tracing_off(struct trace_array *tr); 641 struct dentry *trace_create_file(const char *name, 642 umode_t mode, 643 struct dentry *parent, 644 void *data, 645 const struct file_operations *fops); 646 647 int tracing_init_dentry(void); 648 649 struct ring_buffer_event; 650 651 struct ring_buffer_event * 652 trace_buffer_lock_reserve(struct trace_buffer *buffer, 653 int type, 654 unsigned long len, 655 unsigned int trace_ctx); 656 657 int ring_buffer_meta_seq_init(struct file *file, struct trace_buffer *buffer, int cpu); 658 659 struct trace_entry *tracing_get_trace_entry(struct trace_array *tr, 660 struct trace_array_cpu *data); 661 662 struct trace_entry *trace_find_next_entry(struct trace_iterator *iter, 663 int *ent_cpu, u64 *ent_ts); 664 665 void trace_buffer_unlock_commit_nostack(struct trace_buffer *buffer, 666 struct ring_buffer_event *event); 667 668 bool trace_is_tracepoint_string(const char *str); 669 const char *trace_event_format(struct trace_iterator *iter, const char *fmt); 670 void trace_check_vprintf(struct trace_iterator *iter, const char *fmt, 671 va_list ap) __printf(2, 0); 672 char *trace_iter_expand_format(struct trace_iterator *iter); 673 674 int trace_empty(struct trace_iterator *iter); 675 676 void *trace_find_next_entry_inc(struct trace_iterator *iter); 677 678 void trace_init_global_iter(struct trace_iterator *iter); 679 680 void tracing_iter_reset(struct trace_iterator *iter, int cpu); 681 682 unsigned long trace_total_entries_cpu(struct trace_array *tr, int cpu); 683 unsigned long trace_total_entries(struct trace_array *tr); 684 685 void trace_function(struct trace_array *tr, 686 unsigned long ip, 687 unsigned long parent_ip, 688 unsigned int trace_ctx); 689 void trace_graph_function(struct trace_array *tr, 690 unsigned long ip, 691 unsigned long parent_ip, 692 unsigned int trace_ctx); 693 void trace_latency_header(struct seq_file *m); 694 void trace_default_header(struct seq_file *m); 695 void print_trace_header(struct seq_file *m, struct trace_iterator *iter); 696 697 void trace_graph_return(struct ftrace_graph_ret *trace, struct fgraph_ops *gops); 698 int trace_graph_entry(struct ftrace_graph_ent *trace, struct fgraph_ops *gops); 699 700 void tracing_start_cmdline_record(void); 701 void tracing_stop_cmdline_record(void); 702 void tracing_start_tgid_record(void); 703 void tracing_stop_tgid_record(void); 704 705 int register_tracer(struct tracer *type); 706 int is_tracing_stopped(void); 707 708 loff_t tracing_lseek(struct file *file, loff_t offset, int whence); 709 710 extern cpumask_var_t __read_mostly tracing_buffer_mask; 711 712 #define for_each_tracing_cpu(cpu) \ 713 for_each_cpu(cpu, tracing_buffer_mask) 714 715 extern unsigned long nsecs_to_usecs(unsigned long nsecs); 716 717 extern unsigned long tracing_thresh; 718 719 /* PID filtering */ 720 721 extern int pid_max; 722 723 bool trace_find_filtered_pid(struct trace_pid_list *filtered_pids, 724 pid_t search_pid); 725 bool trace_ignore_this_task(struct trace_pid_list *filtered_pids, 726 struct trace_pid_list *filtered_no_pids, 727 struct task_struct *task); 728 void trace_filter_add_remove_task(struct trace_pid_list *pid_list, 729 struct task_struct *self, 730 struct task_struct *task); 731 void *trace_pid_next(struct trace_pid_list *pid_list, void *v, loff_t *pos); 732 void *trace_pid_start(struct trace_pid_list *pid_list, loff_t *pos); 733 int trace_pid_show(struct seq_file *m, void *v); 734 int trace_pid_write(struct trace_pid_list *filtered_pids, 735 struct trace_pid_list **new_pid_list, 736 const char __user *ubuf, size_t cnt); 737 738 #ifdef CONFIG_TRACER_MAX_TRACE 739 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu, 740 void *cond_data); 741 void update_max_tr_single(struct trace_array *tr, 742 struct task_struct *tsk, int cpu); 743 744 #ifdef CONFIG_FSNOTIFY 745 #define LATENCY_FS_NOTIFY 746 #endif 747 #endif /* CONFIG_TRACER_MAX_TRACE */ 748 749 #ifdef LATENCY_FS_NOTIFY 750 void latency_fsnotify(struct trace_array *tr); 751 #else 752 static inline void latency_fsnotify(struct trace_array *tr) { } 753 #endif 754 755 #ifdef CONFIG_STACKTRACE 756 void __trace_stack(struct trace_array *tr, unsigned int trace_ctx, int skip); 757 #else 758 static inline void __trace_stack(struct trace_array *tr, unsigned int trace_ctx, 759 int skip) 760 { 761 } 762 #endif /* CONFIG_STACKTRACE */ 763 764 void trace_last_func_repeats(struct trace_array *tr, 765 struct trace_func_repeats *last_info, 766 unsigned int trace_ctx); 767 768 extern u64 ftrace_now(int cpu); 769 770 extern void trace_find_cmdline(int pid, char comm[]); 771 extern int trace_find_tgid(int pid); 772 extern void trace_event_follow_fork(struct trace_array *tr, bool enable); 773 774 #ifdef CONFIG_DYNAMIC_FTRACE 775 extern unsigned long ftrace_update_tot_cnt; 776 extern unsigned long ftrace_number_of_pages; 777 extern unsigned long ftrace_number_of_groups; 778 extern u64 ftrace_update_time; 779 extern u64 ftrace_total_mod_time; 780 void ftrace_init_trace_array(struct trace_array *tr); 781 #else 782 static inline void ftrace_init_trace_array(struct trace_array *tr) { } 783 #endif 784 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func 785 extern int DYN_FTRACE_TEST_NAME(void); 786 #define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2 787 extern int DYN_FTRACE_TEST_NAME2(void); 788 789 extern void trace_set_ring_buffer_expanded(struct trace_array *tr); 790 extern bool tracing_selftest_disabled; 791 792 #ifdef CONFIG_FTRACE_STARTUP_TEST 793 extern void __init disable_tracing_selftest(const char *reason); 794 795 extern int trace_selftest_startup_function(struct tracer *trace, 796 struct trace_array *tr); 797 extern int trace_selftest_startup_function_graph(struct tracer *trace, 798 struct trace_array *tr); 799 extern int trace_selftest_startup_irqsoff(struct tracer *trace, 800 struct trace_array *tr); 801 extern int trace_selftest_startup_preemptoff(struct tracer *trace, 802 struct trace_array *tr); 803 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace, 804 struct trace_array *tr); 805 extern int trace_selftest_startup_wakeup(struct tracer *trace, 806 struct trace_array *tr); 807 extern int trace_selftest_startup_nop(struct tracer *trace, 808 struct trace_array *tr); 809 extern int trace_selftest_startup_branch(struct tracer *trace, 810 struct trace_array *tr); 811 /* 812 * Tracer data references selftest functions that only occur 813 * on boot up. These can be __init functions. Thus, when selftests 814 * are enabled, then the tracers need to reference __init functions. 815 */ 816 #define __tracer_data __refdata 817 #else 818 static inline void __init disable_tracing_selftest(const char *reason) 819 { 820 } 821 /* Tracers are seldom changed. Optimize when selftests are disabled. */ 822 #define __tracer_data __read_mostly 823 #endif /* CONFIG_FTRACE_STARTUP_TEST */ 824 825 extern void *head_page(struct trace_array_cpu *data); 826 extern unsigned long long ns2usecs(u64 nsec); 827 extern int 828 trace_vbprintk(unsigned long ip, const char *fmt, va_list args); 829 extern int 830 trace_vprintk(unsigned long ip, const char *fmt, va_list args); 831 extern int 832 trace_array_vprintk(struct trace_array *tr, 833 unsigned long ip, const char *fmt, va_list args); 834 int trace_array_printk_buf(struct trace_buffer *buffer, 835 unsigned long ip, const char *fmt, ...); 836 void trace_printk_seq(struct trace_seq *s); 837 enum print_line_t print_trace_line(struct trace_iterator *iter); 838 839 extern char trace_find_mark(unsigned long long duration); 840 841 struct ftrace_hash; 842 843 struct ftrace_mod_load { 844 struct list_head list; 845 char *func; 846 char *module; 847 int enable; 848 }; 849 850 enum { 851 FTRACE_HASH_FL_MOD = (1 << 0), 852 }; 853 854 struct ftrace_hash { 855 unsigned long size_bits; 856 struct hlist_head *buckets; 857 unsigned long count; 858 unsigned long flags; 859 struct rcu_head rcu; 860 }; 861 862 struct ftrace_func_entry * 863 ftrace_lookup_ip(struct ftrace_hash *hash, unsigned long ip); 864 865 static __always_inline bool ftrace_hash_empty(struct ftrace_hash *hash) 866 { 867 return !hash || !(hash->count || (hash->flags & FTRACE_HASH_FL_MOD)); 868 } 869 870 /* Standard output formatting function used for function return traces */ 871 #ifdef CONFIG_FUNCTION_GRAPH_TRACER 872 873 /* Flag options */ 874 #define TRACE_GRAPH_PRINT_OVERRUN 0x1 875 #define TRACE_GRAPH_PRINT_CPU 0x2 876 #define TRACE_GRAPH_PRINT_OVERHEAD 0x4 877 #define TRACE_GRAPH_PRINT_PROC 0x8 878 #define TRACE_GRAPH_PRINT_DURATION 0x10 879 #define TRACE_GRAPH_PRINT_ABS_TIME 0x20 880 #define TRACE_GRAPH_PRINT_REL_TIME 0x40 881 #define TRACE_GRAPH_PRINT_IRQS 0x80 882 #define TRACE_GRAPH_PRINT_TAIL 0x100 883 #define TRACE_GRAPH_SLEEP_TIME 0x200 884 #define TRACE_GRAPH_GRAPH_TIME 0x400 885 #define TRACE_GRAPH_PRINT_RETVAL 0x800 886 #define TRACE_GRAPH_PRINT_RETVAL_HEX 0x1000 887 #define TRACE_GRAPH_PRINT_RETADDR 0x2000 888 #define TRACE_GRAPH_PRINT_FILL_SHIFT 28 889 #define TRACE_GRAPH_PRINT_FILL_MASK (0x3 << TRACE_GRAPH_PRINT_FILL_SHIFT) 890 891 extern void ftrace_graph_sleep_time_control(bool enable); 892 893 #ifdef CONFIG_FUNCTION_PROFILER 894 extern void ftrace_graph_graph_time_control(bool enable); 895 #else 896 static inline void ftrace_graph_graph_time_control(bool enable) { } 897 #endif 898 899 extern enum print_line_t 900 print_graph_function_flags(struct trace_iterator *iter, u32 flags); 901 extern void print_graph_headers_flags(struct seq_file *s, u32 flags); 902 extern void 903 trace_print_graph_duration(unsigned long long duration, struct trace_seq *s); 904 extern void graph_trace_open(struct trace_iterator *iter); 905 extern void graph_trace_close(struct trace_iterator *iter); 906 extern int __trace_graph_entry(struct trace_array *tr, 907 struct ftrace_graph_ent *trace, 908 unsigned int trace_ctx); 909 extern int __trace_graph_retaddr_entry(struct trace_array *tr, 910 struct ftrace_graph_ent *trace, 911 unsigned int trace_ctx, 912 unsigned long retaddr); 913 extern void __trace_graph_return(struct trace_array *tr, 914 struct ftrace_graph_ret *trace, 915 unsigned int trace_ctx); 916 extern void init_array_fgraph_ops(struct trace_array *tr, struct ftrace_ops *ops); 917 extern int allocate_fgraph_ops(struct trace_array *tr, struct ftrace_ops *ops); 918 extern void free_fgraph_ops(struct trace_array *tr); 919 920 enum { 921 TRACE_GRAPH_FL = 1, 922 923 /* 924 * In the very unlikely case that an interrupt came in 925 * at a start of graph tracing, and we want to trace 926 * the function in that interrupt, the depth can be greater 927 * than zero, because of the preempted start of a previous 928 * trace. In an even more unlikely case, depth could be 2 929 * if a softirq interrupted the start of graph tracing, 930 * followed by an interrupt preempting a start of graph 931 * tracing in the softirq, and depth can even be 3 932 * if an NMI came in at the start of an interrupt function 933 * that preempted a softirq start of a function that 934 * preempted normal context!!!! Luckily, it can't be 935 * greater than 3, so the next two bits are a mask 936 * of what the depth is when we set TRACE_GRAPH_FL 937 */ 938 939 TRACE_GRAPH_DEPTH_START_BIT, 940 TRACE_GRAPH_DEPTH_END_BIT, 941 942 /* 943 * To implement set_graph_notrace, if this bit is set, we ignore 944 * function graph tracing of called functions, until the return 945 * function is called to clear it. 946 */ 947 TRACE_GRAPH_NOTRACE_BIT, 948 }; 949 950 #define TRACE_GRAPH_NOTRACE (1 << TRACE_GRAPH_NOTRACE_BIT) 951 952 static inline unsigned long ftrace_graph_depth(unsigned long *task_var) 953 { 954 return (*task_var >> TRACE_GRAPH_DEPTH_START_BIT) & 3; 955 } 956 957 static inline void ftrace_graph_set_depth(unsigned long *task_var, int depth) 958 { 959 *task_var &= ~(3 << TRACE_GRAPH_DEPTH_START_BIT); 960 *task_var |= (depth & 3) << TRACE_GRAPH_DEPTH_START_BIT; 961 } 962 963 #ifdef CONFIG_DYNAMIC_FTRACE 964 extern struct ftrace_hash __rcu *ftrace_graph_hash; 965 extern struct ftrace_hash __rcu *ftrace_graph_notrace_hash; 966 967 static inline int 968 ftrace_graph_addr(unsigned long *task_var, struct ftrace_graph_ent *trace) 969 { 970 unsigned long addr = trace->func; 971 int ret = 0; 972 struct ftrace_hash *hash; 973 974 preempt_disable_notrace(); 975 976 /* 977 * Have to open code "rcu_dereference_sched()" because the 978 * function graph tracer can be called when RCU is not 979 * "watching". 980 * Protected with schedule_on_each_cpu(ftrace_sync) 981 */ 982 hash = rcu_dereference_protected(ftrace_graph_hash, !preemptible()); 983 984 if (ftrace_hash_empty(hash)) { 985 ret = 1; 986 goto out; 987 } 988 989 if (ftrace_lookup_ip(hash, addr)) { 990 /* 991 * This needs to be cleared on the return functions 992 * when the depth is zero. 993 */ 994 *task_var |= TRACE_GRAPH_FL; 995 ftrace_graph_set_depth(task_var, trace->depth); 996 997 /* 998 * If no irqs are to be traced, but a set_graph_function 999 * is set, and called by an interrupt handler, we still 1000 * want to trace it. 1001 */ 1002 if (in_hardirq()) 1003 trace_recursion_set(TRACE_IRQ_BIT); 1004 else 1005 trace_recursion_clear(TRACE_IRQ_BIT); 1006 ret = 1; 1007 } 1008 1009 out: 1010 preempt_enable_notrace(); 1011 return ret; 1012 } 1013 1014 static inline void 1015 ftrace_graph_addr_finish(struct fgraph_ops *gops, struct ftrace_graph_ret *trace) 1016 { 1017 unsigned long *task_var = fgraph_get_task_var(gops); 1018 1019 if ((*task_var & TRACE_GRAPH_FL) && 1020 trace->depth == ftrace_graph_depth(task_var)) 1021 *task_var &= ~TRACE_GRAPH_FL; 1022 } 1023 1024 static inline int ftrace_graph_notrace_addr(unsigned long addr) 1025 { 1026 int ret = 0; 1027 struct ftrace_hash *notrace_hash; 1028 1029 preempt_disable_notrace(); 1030 1031 /* 1032 * Have to open code "rcu_dereference_sched()" because the 1033 * function graph tracer can be called when RCU is not 1034 * "watching". 1035 * Protected with schedule_on_each_cpu(ftrace_sync) 1036 */ 1037 notrace_hash = rcu_dereference_protected(ftrace_graph_notrace_hash, 1038 !preemptible()); 1039 1040 if (ftrace_lookup_ip(notrace_hash, addr)) 1041 ret = 1; 1042 1043 preempt_enable_notrace(); 1044 return ret; 1045 } 1046 #else 1047 static inline int ftrace_graph_addr(unsigned long *task_var, struct ftrace_graph_ent *trace) 1048 { 1049 return 1; 1050 } 1051 1052 static inline int ftrace_graph_notrace_addr(unsigned long addr) 1053 { 1054 return 0; 1055 } 1056 static inline void ftrace_graph_addr_finish(struct fgraph_ops *gops, struct ftrace_graph_ret *trace) 1057 { } 1058 #endif /* CONFIG_DYNAMIC_FTRACE */ 1059 1060 extern unsigned int fgraph_max_depth; 1061 extern bool fgraph_sleep_time; 1062 1063 static inline bool 1064 ftrace_graph_ignore_func(struct fgraph_ops *gops, struct ftrace_graph_ent *trace) 1065 { 1066 unsigned long *task_var = fgraph_get_task_var(gops); 1067 1068 /* trace it when it is-nested-in or is a function enabled. */ 1069 return !((*task_var & TRACE_GRAPH_FL) || 1070 ftrace_graph_addr(task_var, trace)) || 1071 (trace->depth < 0) || 1072 (fgraph_max_depth && trace->depth >= fgraph_max_depth); 1073 } 1074 1075 void fgraph_init_ops(struct ftrace_ops *dst_ops, 1076 struct ftrace_ops *src_ops); 1077 1078 #else /* CONFIG_FUNCTION_GRAPH_TRACER */ 1079 static inline enum print_line_t 1080 print_graph_function_flags(struct trace_iterator *iter, u32 flags) 1081 { 1082 return TRACE_TYPE_UNHANDLED; 1083 } 1084 static inline void free_fgraph_ops(struct trace_array *tr) { } 1085 /* ftrace_ops may not be defined */ 1086 #define init_array_fgraph_ops(tr, ops) do { } while (0) 1087 #define allocate_fgraph_ops(tr, ops) ({ 0; }) 1088 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */ 1089 1090 extern struct list_head ftrace_pids; 1091 1092 #ifdef CONFIG_FUNCTION_TRACER 1093 1094 #define FTRACE_PID_IGNORE -1 1095 #define FTRACE_PID_TRACE -2 1096 1097 struct ftrace_func_command { 1098 struct list_head list; 1099 char *name; 1100 int (*func)(struct trace_array *tr, 1101 struct ftrace_hash *hash, 1102 char *func, char *cmd, 1103 char *params, int enable); 1104 }; 1105 extern bool ftrace_filter_param __initdata; 1106 static inline int ftrace_trace_task(struct trace_array *tr) 1107 { 1108 return this_cpu_read(tr->array_buffer.data->ftrace_ignore_pid) != 1109 FTRACE_PID_IGNORE; 1110 } 1111 extern int ftrace_is_dead(void); 1112 int ftrace_create_function_files(struct trace_array *tr, 1113 struct dentry *parent); 1114 void ftrace_destroy_function_files(struct trace_array *tr); 1115 int ftrace_allocate_ftrace_ops(struct trace_array *tr); 1116 void ftrace_free_ftrace_ops(struct trace_array *tr); 1117 void ftrace_init_global_array_ops(struct trace_array *tr); 1118 void ftrace_init_array_ops(struct trace_array *tr, ftrace_func_t func); 1119 void ftrace_reset_array_ops(struct trace_array *tr); 1120 void ftrace_init_tracefs(struct trace_array *tr, struct dentry *d_tracer); 1121 void ftrace_init_tracefs_toplevel(struct trace_array *tr, 1122 struct dentry *d_tracer); 1123 void ftrace_clear_pids(struct trace_array *tr); 1124 int init_function_trace(void); 1125 void ftrace_pid_follow_fork(struct trace_array *tr, bool enable); 1126 #else 1127 static inline int ftrace_trace_task(struct trace_array *tr) 1128 { 1129 return 1; 1130 } 1131 static inline int ftrace_is_dead(void) { return 0; } 1132 static inline int 1133 ftrace_create_function_files(struct trace_array *tr, 1134 struct dentry *parent) 1135 { 1136 return 0; 1137 } 1138 static inline int ftrace_allocate_ftrace_ops(struct trace_array *tr) 1139 { 1140 return 0; 1141 } 1142 static inline void ftrace_free_ftrace_ops(struct trace_array *tr) { } 1143 static inline void ftrace_destroy_function_files(struct trace_array *tr) { } 1144 static inline __init void 1145 ftrace_init_global_array_ops(struct trace_array *tr) { } 1146 static inline void ftrace_reset_array_ops(struct trace_array *tr) { } 1147 static inline void ftrace_init_tracefs(struct trace_array *tr, struct dentry *d) { } 1148 static inline void ftrace_init_tracefs_toplevel(struct trace_array *tr, struct dentry *d) { } 1149 static inline void ftrace_clear_pids(struct trace_array *tr) { } 1150 static inline int init_function_trace(void) { return 0; } 1151 static inline void ftrace_pid_follow_fork(struct trace_array *tr, bool enable) { } 1152 /* ftace_func_t type is not defined, use macro instead of static inline */ 1153 #define ftrace_init_array_ops(tr, func) do { } while (0) 1154 #endif /* CONFIG_FUNCTION_TRACER */ 1155 1156 #if defined(CONFIG_FUNCTION_TRACER) && defined(CONFIG_DYNAMIC_FTRACE) 1157 1158 struct ftrace_probe_ops { 1159 void (*func)(unsigned long ip, 1160 unsigned long parent_ip, 1161 struct trace_array *tr, 1162 struct ftrace_probe_ops *ops, 1163 void *data); 1164 int (*init)(struct ftrace_probe_ops *ops, 1165 struct trace_array *tr, 1166 unsigned long ip, void *init_data, 1167 void **data); 1168 void (*free)(struct ftrace_probe_ops *ops, 1169 struct trace_array *tr, 1170 unsigned long ip, void *data); 1171 int (*print)(struct seq_file *m, 1172 unsigned long ip, 1173 struct ftrace_probe_ops *ops, 1174 void *data); 1175 }; 1176 1177 struct ftrace_func_mapper; 1178 typedef int (*ftrace_mapper_func)(void *data); 1179 1180 struct ftrace_func_mapper *allocate_ftrace_func_mapper(void); 1181 void **ftrace_func_mapper_find_ip(struct ftrace_func_mapper *mapper, 1182 unsigned long ip); 1183 int ftrace_func_mapper_add_ip(struct ftrace_func_mapper *mapper, 1184 unsigned long ip, void *data); 1185 void *ftrace_func_mapper_remove_ip(struct ftrace_func_mapper *mapper, 1186 unsigned long ip); 1187 void free_ftrace_func_mapper(struct ftrace_func_mapper *mapper, 1188 ftrace_mapper_func free_func); 1189 1190 extern int 1191 register_ftrace_function_probe(char *glob, struct trace_array *tr, 1192 struct ftrace_probe_ops *ops, void *data); 1193 extern int 1194 unregister_ftrace_function_probe_func(char *glob, struct trace_array *tr, 1195 struct ftrace_probe_ops *ops); 1196 extern void clear_ftrace_function_probes(struct trace_array *tr); 1197 1198 int register_ftrace_command(struct ftrace_func_command *cmd); 1199 int unregister_ftrace_command(struct ftrace_func_command *cmd); 1200 1201 void ftrace_create_filter_files(struct ftrace_ops *ops, 1202 struct dentry *parent); 1203 void ftrace_destroy_filter_files(struct ftrace_ops *ops); 1204 1205 extern int ftrace_set_filter(struct ftrace_ops *ops, unsigned char *buf, 1206 int len, int reset); 1207 extern int ftrace_set_notrace(struct ftrace_ops *ops, unsigned char *buf, 1208 int len, int reset); 1209 #else 1210 struct ftrace_func_command; 1211 1212 static inline __init int register_ftrace_command(struct ftrace_func_command *cmd) 1213 { 1214 return -EINVAL; 1215 } 1216 static inline __init int unregister_ftrace_command(char *cmd_name) 1217 { 1218 return -EINVAL; 1219 } 1220 static inline void clear_ftrace_function_probes(struct trace_array *tr) 1221 { 1222 } 1223 1224 /* 1225 * The ops parameter passed in is usually undefined. 1226 * This must be a macro. 1227 */ 1228 #define ftrace_create_filter_files(ops, parent) do { } while (0) 1229 #define ftrace_destroy_filter_files(ops) do { } while (0) 1230 #endif /* CONFIG_FUNCTION_TRACER && CONFIG_DYNAMIC_FTRACE */ 1231 1232 bool ftrace_event_is_function(struct trace_event_call *call); 1233 1234 /* 1235 * struct trace_parser - servers for reading the user input separated by spaces 1236 * @cont: set if the input is not complete - no final space char was found 1237 * @buffer: holds the parsed user input 1238 * @idx: user input length 1239 * @size: buffer size 1240 */ 1241 struct trace_parser { 1242 bool cont; 1243 char *buffer; 1244 unsigned idx; 1245 unsigned size; 1246 }; 1247 1248 static inline bool trace_parser_loaded(struct trace_parser *parser) 1249 { 1250 return (parser->idx != 0); 1251 } 1252 1253 static inline bool trace_parser_cont(struct trace_parser *parser) 1254 { 1255 return parser->cont; 1256 } 1257 1258 static inline void trace_parser_clear(struct trace_parser *parser) 1259 { 1260 parser->cont = false; 1261 parser->idx = 0; 1262 } 1263 1264 extern int trace_parser_get_init(struct trace_parser *parser, int size); 1265 extern void trace_parser_put(struct trace_parser *parser); 1266 extern int trace_get_user(struct trace_parser *parser, const char __user *ubuf, 1267 size_t cnt, loff_t *ppos); 1268 1269 /* 1270 * Only create function graph options if function graph is configured. 1271 */ 1272 #ifdef CONFIG_FUNCTION_GRAPH_TRACER 1273 # define FGRAPH_FLAGS \ 1274 C(DISPLAY_GRAPH, "display-graph"), 1275 #else 1276 # define FGRAPH_FLAGS 1277 #endif 1278 1279 #ifdef CONFIG_BRANCH_TRACER 1280 # define BRANCH_FLAGS \ 1281 C(BRANCH, "branch"), 1282 #else 1283 # define BRANCH_FLAGS 1284 #endif 1285 1286 #ifdef CONFIG_FUNCTION_TRACER 1287 # define FUNCTION_FLAGS \ 1288 C(FUNCTION, "function-trace"), \ 1289 C(FUNC_FORK, "function-fork"), 1290 # define FUNCTION_DEFAULT_FLAGS TRACE_ITER_FUNCTION 1291 #else 1292 # define FUNCTION_FLAGS 1293 # define FUNCTION_DEFAULT_FLAGS 0UL 1294 # define TRACE_ITER_FUNC_FORK 0UL 1295 #endif 1296 1297 #ifdef CONFIG_STACKTRACE 1298 # define STACK_FLAGS \ 1299 C(STACKTRACE, "stacktrace"), 1300 #else 1301 # define STACK_FLAGS 1302 #endif 1303 1304 /* 1305 * trace_iterator_flags is an enumeration that defines bit 1306 * positions into trace_flags that controls the output. 1307 * 1308 * NOTE: These bits must match the trace_options array in 1309 * trace.c (this macro guarantees it). 1310 */ 1311 #define TRACE_FLAGS \ 1312 C(PRINT_PARENT, "print-parent"), \ 1313 C(SYM_OFFSET, "sym-offset"), \ 1314 C(SYM_ADDR, "sym-addr"), \ 1315 C(VERBOSE, "verbose"), \ 1316 C(RAW, "raw"), \ 1317 C(HEX, "hex"), \ 1318 C(BIN, "bin"), \ 1319 C(BLOCK, "block"), \ 1320 C(FIELDS, "fields"), \ 1321 C(PRINTK, "trace_printk"), \ 1322 C(ANNOTATE, "annotate"), \ 1323 C(USERSTACKTRACE, "userstacktrace"), \ 1324 C(SYM_USEROBJ, "sym-userobj"), \ 1325 C(PRINTK_MSGONLY, "printk-msg-only"), \ 1326 C(CONTEXT_INFO, "context-info"), /* Print pid/cpu/time */ \ 1327 C(LATENCY_FMT, "latency-format"), \ 1328 C(RECORD_CMD, "record-cmd"), \ 1329 C(RECORD_TGID, "record-tgid"), \ 1330 C(OVERWRITE, "overwrite"), \ 1331 C(STOP_ON_FREE, "disable_on_free"), \ 1332 C(IRQ_INFO, "irq-info"), \ 1333 C(MARKERS, "markers"), \ 1334 C(EVENT_FORK, "event-fork"), \ 1335 C(TRACE_PRINTK, "trace_printk_dest"), \ 1336 C(PAUSE_ON_TRACE, "pause-on-trace"), \ 1337 C(HASH_PTR, "hash-ptr"), /* Print hashed pointer */ \ 1338 FUNCTION_FLAGS \ 1339 FGRAPH_FLAGS \ 1340 STACK_FLAGS \ 1341 BRANCH_FLAGS 1342 1343 /* 1344 * By defining C, we can make TRACE_FLAGS a list of bit names 1345 * that will define the bits for the flag masks. 1346 */ 1347 #undef C 1348 #define C(a, b) TRACE_ITER_##a##_BIT 1349 1350 enum trace_iterator_bits { 1351 TRACE_FLAGS 1352 /* Make sure we don't go more than we have bits for */ 1353 TRACE_ITER_LAST_BIT 1354 }; 1355 1356 /* 1357 * By redefining C, we can make TRACE_FLAGS a list of masks that 1358 * use the bits as defined above. 1359 */ 1360 #undef C 1361 #define C(a, b) TRACE_ITER_##a = (1 << TRACE_ITER_##a##_BIT) 1362 1363 enum trace_iterator_flags { TRACE_FLAGS }; 1364 1365 /* 1366 * TRACE_ITER_SYM_MASK masks the options in trace_flags that 1367 * control the output of kernel symbols. 1368 */ 1369 #define TRACE_ITER_SYM_MASK \ 1370 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR) 1371 1372 extern struct tracer nop_trace; 1373 1374 #ifdef CONFIG_BRANCH_TRACER 1375 extern int enable_branch_tracing(struct trace_array *tr); 1376 extern void disable_branch_tracing(void); 1377 static inline int trace_branch_enable(struct trace_array *tr) 1378 { 1379 if (tr->trace_flags & TRACE_ITER_BRANCH) 1380 return enable_branch_tracing(tr); 1381 return 0; 1382 } 1383 static inline void trace_branch_disable(void) 1384 { 1385 /* due to races, always disable */ 1386 disable_branch_tracing(); 1387 } 1388 #else 1389 static inline int trace_branch_enable(struct trace_array *tr) 1390 { 1391 return 0; 1392 } 1393 static inline void trace_branch_disable(void) 1394 { 1395 } 1396 #endif /* CONFIG_BRANCH_TRACER */ 1397 1398 /* set ring buffers to default size if not already done so */ 1399 int tracing_update_buffers(struct trace_array *tr); 1400 1401 union trace_synth_field { 1402 u8 as_u8; 1403 u16 as_u16; 1404 u32 as_u32; 1405 u64 as_u64; 1406 struct trace_dynamic_info as_dynamic; 1407 }; 1408 1409 struct ftrace_event_field { 1410 struct list_head link; 1411 const char *name; 1412 const char *type; 1413 int filter_type; 1414 int offset; 1415 int size; 1416 int is_signed; 1417 int len; 1418 }; 1419 1420 struct prog_entry; 1421 1422 struct event_filter { 1423 struct prog_entry __rcu *prog; 1424 char *filter_string; 1425 }; 1426 1427 struct event_subsystem { 1428 struct list_head list; 1429 const char *name; 1430 struct event_filter *filter; 1431 int ref_count; 1432 }; 1433 1434 struct trace_subsystem_dir { 1435 struct list_head list; 1436 struct event_subsystem *subsystem; 1437 struct trace_array *tr; 1438 struct eventfs_inode *ei; 1439 int ref_count; 1440 int nr_events; 1441 }; 1442 1443 extern int call_filter_check_discard(struct trace_event_call *call, void *rec, 1444 struct trace_buffer *buffer, 1445 struct ring_buffer_event *event); 1446 1447 void trace_buffer_unlock_commit_regs(struct trace_array *tr, 1448 struct trace_buffer *buffer, 1449 struct ring_buffer_event *event, 1450 unsigned int trcace_ctx, 1451 struct pt_regs *regs); 1452 1453 static inline void trace_buffer_unlock_commit(struct trace_array *tr, 1454 struct trace_buffer *buffer, 1455 struct ring_buffer_event *event, 1456 unsigned int trace_ctx) 1457 { 1458 trace_buffer_unlock_commit_regs(tr, buffer, event, trace_ctx, NULL); 1459 } 1460 1461 DECLARE_PER_CPU(bool, trace_taskinfo_save); 1462 int trace_save_cmdline(struct task_struct *tsk); 1463 int trace_create_savedcmd(void); 1464 int trace_alloc_tgid_map(void); 1465 void trace_free_saved_cmdlines_buffer(void); 1466 1467 extern const struct file_operations tracing_saved_cmdlines_fops; 1468 extern const struct file_operations tracing_saved_tgids_fops; 1469 extern const struct file_operations tracing_saved_cmdlines_size_fops; 1470 1471 DECLARE_PER_CPU(struct ring_buffer_event *, trace_buffered_event); 1472 DECLARE_PER_CPU(int, trace_buffered_event_cnt); 1473 void trace_buffered_event_disable(void); 1474 void trace_buffered_event_enable(void); 1475 1476 void early_enable_events(struct trace_array *tr, char *buf, bool disable_first); 1477 1478 static inline void 1479 __trace_event_discard_commit(struct trace_buffer *buffer, 1480 struct ring_buffer_event *event) 1481 { 1482 if (this_cpu_read(trace_buffered_event) == event) { 1483 /* Simply release the temp buffer and enable preemption */ 1484 this_cpu_dec(trace_buffered_event_cnt); 1485 preempt_enable_notrace(); 1486 return; 1487 } 1488 /* ring_buffer_discard_commit() enables preemption */ 1489 ring_buffer_discard_commit(buffer, event); 1490 } 1491 1492 /* 1493 * Helper function for event_trigger_unlock_commit{_regs}(). 1494 * If there are event triggers attached to this event that requires 1495 * filtering against its fields, then they will be called as the 1496 * entry already holds the field information of the current event. 1497 * 1498 * It also checks if the event should be discarded or not. 1499 * It is to be discarded if the event is soft disabled and the 1500 * event was only recorded to process triggers, or if the event 1501 * filter is active and this event did not match the filters. 1502 * 1503 * Returns true if the event is discarded, false otherwise. 1504 */ 1505 static inline bool 1506 __event_trigger_test_discard(struct trace_event_file *file, 1507 struct trace_buffer *buffer, 1508 struct ring_buffer_event *event, 1509 void *entry, 1510 enum event_trigger_type *tt) 1511 { 1512 unsigned long eflags = file->flags; 1513 1514 if (eflags & EVENT_FILE_FL_TRIGGER_COND) 1515 *tt = event_triggers_call(file, buffer, entry, event); 1516 1517 if (likely(!(file->flags & (EVENT_FILE_FL_SOFT_DISABLED | 1518 EVENT_FILE_FL_FILTERED | 1519 EVENT_FILE_FL_PID_FILTER)))) 1520 return false; 1521 1522 if (file->flags & EVENT_FILE_FL_SOFT_DISABLED) 1523 goto discard; 1524 1525 if (file->flags & EVENT_FILE_FL_FILTERED && 1526 !filter_match_preds(file->filter, entry)) 1527 goto discard; 1528 1529 if ((file->flags & EVENT_FILE_FL_PID_FILTER) && 1530 trace_event_ignore_this_pid(file)) 1531 goto discard; 1532 1533 return false; 1534 discard: 1535 __trace_event_discard_commit(buffer, event); 1536 return true; 1537 } 1538 1539 /** 1540 * event_trigger_unlock_commit - handle triggers and finish event commit 1541 * @file: The file pointer associated with the event 1542 * @buffer: The ring buffer that the event is being written to 1543 * @event: The event meta data in the ring buffer 1544 * @entry: The event itself 1545 * @trace_ctx: The tracing context flags. 1546 * 1547 * This is a helper function to handle triggers that require data 1548 * from the event itself. It also tests the event against filters and 1549 * if the event is soft disabled and should be discarded. 1550 */ 1551 static inline void 1552 event_trigger_unlock_commit(struct trace_event_file *file, 1553 struct trace_buffer *buffer, 1554 struct ring_buffer_event *event, 1555 void *entry, unsigned int trace_ctx) 1556 { 1557 enum event_trigger_type tt = ETT_NONE; 1558 1559 if (!__event_trigger_test_discard(file, buffer, event, entry, &tt)) 1560 trace_buffer_unlock_commit(file->tr, buffer, event, trace_ctx); 1561 1562 if (tt) 1563 event_triggers_post_call(file, tt); 1564 } 1565 1566 #define FILTER_PRED_INVALID ((unsigned short)-1) 1567 #define FILTER_PRED_IS_RIGHT (1 << 15) 1568 #define FILTER_PRED_FOLD (1 << 15) 1569 1570 /* 1571 * The max preds is the size of unsigned short with 1572 * two flags at the MSBs. One bit is used for both the IS_RIGHT 1573 * and FOLD flags. The other is reserved. 1574 * 1575 * 2^14 preds is way more than enough. 1576 */ 1577 #define MAX_FILTER_PRED 16384 1578 1579 struct filter_pred; 1580 struct regex; 1581 1582 typedef int (*regex_match_func)(char *str, struct regex *r, int len); 1583 1584 enum regex_type { 1585 MATCH_FULL = 0, 1586 MATCH_FRONT_ONLY, 1587 MATCH_MIDDLE_ONLY, 1588 MATCH_END_ONLY, 1589 MATCH_GLOB, 1590 MATCH_INDEX, 1591 }; 1592 1593 struct regex { 1594 char pattern[MAX_FILTER_STR_VAL]; 1595 int len; 1596 int field_len; 1597 regex_match_func match; 1598 }; 1599 1600 static inline bool is_string_field(struct ftrace_event_field *field) 1601 { 1602 return field->filter_type == FILTER_DYN_STRING || 1603 field->filter_type == FILTER_RDYN_STRING || 1604 field->filter_type == FILTER_STATIC_STRING || 1605 field->filter_type == FILTER_PTR_STRING || 1606 field->filter_type == FILTER_COMM; 1607 } 1608 1609 static inline bool is_function_field(struct ftrace_event_field *field) 1610 { 1611 return field->filter_type == FILTER_TRACE_FN; 1612 } 1613 1614 extern enum regex_type 1615 filter_parse_regex(char *buff, int len, char **search, int *not); 1616 extern void print_event_filter(struct trace_event_file *file, 1617 struct trace_seq *s); 1618 extern int apply_event_filter(struct trace_event_file *file, 1619 char *filter_string); 1620 extern int apply_subsystem_event_filter(struct trace_subsystem_dir *dir, 1621 char *filter_string); 1622 extern void print_subsystem_event_filter(struct event_subsystem *system, 1623 struct trace_seq *s); 1624 extern int filter_assign_type(const char *type); 1625 extern int create_event_filter(struct trace_array *tr, 1626 struct trace_event_call *call, 1627 char *filter_str, bool set_str, 1628 struct event_filter **filterp); 1629 extern void free_event_filter(struct event_filter *filter); 1630 1631 struct ftrace_event_field * 1632 trace_find_event_field(struct trace_event_call *call, char *name); 1633 1634 extern void trace_event_enable_cmd_record(bool enable); 1635 extern void trace_event_enable_tgid_record(bool enable); 1636 1637 extern int event_trace_init(void); 1638 extern int init_events(void); 1639 extern int event_trace_add_tracer(struct dentry *parent, struct trace_array *tr); 1640 extern int event_trace_del_tracer(struct trace_array *tr); 1641 extern void __trace_early_add_events(struct trace_array *tr); 1642 1643 extern struct trace_event_file *__find_event_file(struct trace_array *tr, 1644 const char *system, 1645 const char *event); 1646 extern struct trace_event_file *find_event_file(struct trace_array *tr, 1647 const char *system, 1648 const char *event); 1649 1650 static inline void *event_file_data(struct file *filp) 1651 { 1652 return READ_ONCE(file_inode(filp)->i_private); 1653 } 1654 1655 extern struct mutex event_mutex; 1656 extern struct list_head ftrace_events; 1657 1658 /* 1659 * When the trace_event_file is the filp->i_private pointer, 1660 * it must be taken under the event_mutex lock, and then checked 1661 * if the EVENT_FILE_FL_FREED flag is set. If it is, then the 1662 * data pointed to by the trace_event_file can not be trusted. 1663 * 1664 * Use the event_file_file() to access the trace_event_file from 1665 * the filp the first time under the event_mutex and check for 1666 * NULL. If it is needed to be retrieved again and the event_mutex 1667 * is still held, then the event_file_data() can be used and it 1668 * is guaranteed to be valid. 1669 */ 1670 static inline struct trace_event_file *event_file_file(struct file *filp) 1671 { 1672 struct trace_event_file *file; 1673 1674 lockdep_assert_held(&event_mutex); 1675 file = READ_ONCE(file_inode(filp)->i_private); 1676 if (!file || file->flags & EVENT_FILE_FL_FREED) 1677 return NULL; 1678 return file; 1679 } 1680 1681 extern const struct file_operations event_trigger_fops; 1682 extern const struct file_operations event_hist_fops; 1683 extern const struct file_operations event_hist_debug_fops; 1684 extern const struct file_operations event_inject_fops; 1685 1686 #ifdef CONFIG_HIST_TRIGGERS 1687 extern int register_trigger_hist_cmd(void); 1688 extern int register_trigger_hist_enable_disable_cmds(void); 1689 #else 1690 static inline int register_trigger_hist_cmd(void) { return 0; } 1691 static inline int register_trigger_hist_enable_disable_cmds(void) { return 0; } 1692 #endif 1693 1694 extern int register_trigger_cmds(void); 1695 extern void clear_event_triggers(struct trace_array *tr); 1696 1697 enum { 1698 EVENT_TRIGGER_FL_PROBE = BIT(0), 1699 }; 1700 1701 struct event_trigger_data { 1702 unsigned long count; 1703 int ref; 1704 int flags; 1705 struct event_trigger_ops *ops; 1706 struct event_command *cmd_ops; 1707 struct event_filter __rcu *filter; 1708 char *filter_str; 1709 void *private_data; 1710 bool paused; 1711 bool paused_tmp; 1712 struct list_head list; 1713 char *name; 1714 struct list_head named_list; 1715 struct event_trigger_data *named_data; 1716 }; 1717 1718 /* Avoid typos */ 1719 #define ENABLE_EVENT_STR "enable_event" 1720 #define DISABLE_EVENT_STR "disable_event" 1721 #define ENABLE_HIST_STR "enable_hist" 1722 #define DISABLE_HIST_STR "disable_hist" 1723 1724 struct enable_trigger_data { 1725 struct trace_event_file *file; 1726 bool enable; 1727 bool hist; 1728 }; 1729 1730 extern int event_enable_trigger_print(struct seq_file *m, 1731 struct event_trigger_data *data); 1732 extern void event_enable_trigger_free(struct event_trigger_data *data); 1733 extern int event_enable_trigger_parse(struct event_command *cmd_ops, 1734 struct trace_event_file *file, 1735 char *glob, char *cmd, 1736 char *param_and_filter); 1737 extern int event_enable_register_trigger(char *glob, 1738 struct event_trigger_data *data, 1739 struct trace_event_file *file); 1740 extern void event_enable_unregister_trigger(char *glob, 1741 struct event_trigger_data *test, 1742 struct trace_event_file *file); 1743 extern void trigger_data_free(struct event_trigger_data *data); 1744 extern int event_trigger_init(struct event_trigger_data *data); 1745 extern int trace_event_trigger_enable_disable(struct trace_event_file *file, 1746 int trigger_enable); 1747 extern void update_cond_flag(struct trace_event_file *file); 1748 extern int set_trigger_filter(char *filter_str, 1749 struct event_trigger_data *trigger_data, 1750 struct trace_event_file *file); 1751 extern struct event_trigger_data *find_named_trigger(const char *name); 1752 extern bool is_named_trigger(struct event_trigger_data *test); 1753 extern int save_named_trigger(const char *name, 1754 struct event_trigger_data *data); 1755 extern void del_named_trigger(struct event_trigger_data *data); 1756 extern void pause_named_trigger(struct event_trigger_data *data); 1757 extern void unpause_named_trigger(struct event_trigger_data *data); 1758 extern void set_named_trigger_data(struct event_trigger_data *data, 1759 struct event_trigger_data *named_data); 1760 extern struct event_trigger_data * 1761 get_named_trigger_data(struct event_trigger_data *data); 1762 extern int register_event_command(struct event_command *cmd); 1763 extern int unregister_event_command(struct event_command *cmd); 1764 extern int register_trigger_hist_enable_disable_cmds(void); 1765 extern bool event_trigger_check_remove(const char *glob); 1766 extern bool event_trigger_empty_param(const char *param); 1767 extern int event_trigger_separate_filter(char *param_and_filter, char **param, 1768 char **filter, bool param_required); 1769 extern struct event_trigger_data * 1770 event_trigger_alloc(struct event_command *cmd_ops, 1771 char *cmd, 1772 char *param, 1773 void *private_data); 1774 extern int event_trigger_parse_num(char *trigger, 1775 struct event_trigger_data *trigger_data); 1776 extern int event_trigger_set_filter(struct event_command *cmd_ops, 1777 struct trace_event_file *file, 1778 char *param, 1779 struct event_trigger_data *trigger_data); 1780 extern void event_trigger_reset_filter(struct event_command *cmd_ops, 1781 struct event_trigger_data *trigger_data); 1782 extern int event_trigger_register(struct event_command *cmd_ops, 1783 struct trace_event_file *file, 1784 char *glob, 1785 struct event_trigger_data *trigger_data); 1786 extern void event_trigger_unregister(struct event_command *cmd_ops, 1787 struct trace_event_file *file, 1788 char *glob, 1789 struct event_trigger_data *trigger_data); 1790 1791 extern void event_file_get(struct trace_event_file *file); 1792 extern void event_file_put(struct trace_event_file *file); 1793 1794 /** 1795 * struct event_trigger_ops - callbacks for trace event triggers 1796 * 1797 * The methods in this structure provide per-event trigger hooks for 1798 * various trigger operations. 1799 * 1800 * The @init and @free methods are used during trigger setup and 1801 * teardown, typically called from an event_command's @parse() 1802 * function implementation. 1803 * 1804 * The @print method is used to print the trigger spec. 1805 * 1806 * The @trigger method is the function that actually implements the 1807 * trigger and is called in the context of the triggering event 1808 * whenever that event occurs. 1809 * 1810 * All the methods below, except for @init() and @free(), must be 1811 * implemented. 1812 * 1813 * @trigger: The trigger 'probe' function called when the triggering 1814 * event occurs. The data passed into this callback is the data 1815 * that was supplied to the event_command @reg() function that 1816 * registered the trigger (see struct event_command) along with 1817 * the trace record, rec. 1818 * 1819 * @init: An optional initialization function called for the trigger 1820 * when the trigger is registered (via the event_command reg() 1821 * function). This can be used to perform per-trigger 1822 * initialization such as incrementing a per-trigger reference 1823 * count, for instance. This is usually implemented by the 1824 * generic utility function @event_trigger_init() (see 1825 * trace_event_triggers.c). 1826 * 1827 * @free: An optional de-initialization function called for the 1828 * trigger when the trigger is unregistered (via the 1829 * event_command @reg() function). This can be used to perform 1830 * per-trigger de-initialization such as decrementing a 1831 * per-trigger reference count and freeing corresponding trigger 1832 * data, for instance. This is usually implemented by the 1833 * generic utility function @event_trigger_free() (see 1834 * trace_event_triggers.c). 1835 * 1836 * @print: The callback function invoked to have the trigger print 1837 * itself. This is usually implemented by a wrapper function 1838 * that calls the generic utility function @event_trigger_print() 1839 * (see trace_event_triggers.c). 1840 */ 1841 struct event_trigger_ops { 1842 void (*trigger)(struct event_trigger_data *data, 1843 struct trace_buffer *buffer, 1844 void *rec, 1845 struct ring_buffer_event *rbe); 1846 int (*init)(struct event_trigger_data *data); 1847 void (*free)(struct event_trigger_data *data); 1848 int (*print)(struct seq_file *m, 1849 struct event_trigger_data *data); 1850 }; 1851 1852 /** 1853 * struct event_command - callbacks and data members for event commands 1854 * 1855 * Event commands are invoked by users by writing the command name 1856 * into the 'trigger' file associated with a trace event. The 1857 * parameters associated with a specific invocation of an event 1858 * command are used to create an event trigger instance, which is 1859 * added to the list of trigger instances associated with that trace 1860 * event. When the event is hit, the set of triggers associated with 1861 * that event is invoked. 1862 * 1863 * The data members in this structure provide per-event command data 1864 * for various event commands. 1865 * 1866 * All the data members below, except for @post_trigger, must be set 1867 * for each event command. 1868 * 1869 * @name: The unique name that identifies the event command. This is 1870 * the name used when setting triggers via trigger files. 1871 * 1872 * @trigger_type: A unique id that identifies the event command 1873 * 'type'. This value has two purposes, the first to ensure that 1874 * only one trigger of the same type can be set at a given time 1875 * for a particular event e.g. it doesn't make sense to have both 1876 * a traceon and traceoff trigger attached to a single event at 1877 * the same time, so traceon and traceoff have the same type 1878 * though they have different names. The @trigger_type value is 1879 * also used as a bit value for deferring the actual trigger 1880 * action until after the current event is finished. Some 1881 * commands need to do this if they themselves log to the trace 1882 * buffer (see the @post_trigger() member below). @trigger_type 1883 * values are defined by adding new values to the trigger_type 1884 * enum in include/linux/trace_events.h. 1885 * 1886 * @flags: See the enum event_command_flags below. 1887 * 1888 * All the methods below, except for @set_filter() and @unreg_all(), 1889 * must be implemented. 1890 * 1891 * @parse: The callback function responsible for parsing and 1892 * registering the trigger written to the 'trigger' file by the 1893 * user. It allocates the trigger instance and registers it with 1894 * the appropriate trace event. It makes use of the other 1895 * event_command callback functions to orchestrate this, and is 1896 * usually implemented by the generic utility function 1897 * @event_trigger_callback() (see trace_event_triggers.c). 1898 * 1899 * @reg: Adds the trigger to the list of triggers associated with the 1900 * event, and enables the event trigger itself, after 1901 * initializing it (via the event_trigger_ops @init() function). 1902 * This is also where commands can use the @trigger_type value to 1903 * make the decision as to whether or not multiple instances of 1904 * the trigger should be allowed. This is usually implemented by 1905 * the generic utility function @register_trigger() (see 1906 * trace_event_triggers.c). 1907 * 1908 * @unreg: Removes the trigger from the list of triggers associated 1909 * with the event, and disables the event trigger itself, after 1910 * initializing it (via the event_trigger_ops @free() function). 1911 * This is usually implemented by the generic utility function 1912 * @unregister_trigger() (see trace_event_triggers.c). 1913 * 1914 * @unreg_all: An optional function called to remove all the triggers 1915 * from the list of triggers associated with the event. Called 1916 * when a trigger file is opened in truncate mode. 1917 * 1918 * @set_filter: An optional function called to parse and set a filter 1919 * for the trigger. If no @set_filter() method is set for the 1920 * event command, filters set by the user for the command will be 1921 * ignored. This is usually implemented by the generic utility 1922 * function @set_trigger_filter() (see trace_event_triggers.c). 1923 * 1924 * @get_trigger_ops: The callback function invoked to retrieve the 1925 * event_trigger_ops implementation associated with the command. 1926 * This callback function allows a single event_command to 1927 * support multiple trigger implementations via different sets of 1928 * event_trigger_ops, depending on the value of the @param 1929 * string. 1930 */ 1931 struct event_command { 1932 struct list_head list; 1933 char *name; 1934 enum event_trigger_type trigger_type; 1935 int flags; 1936 int (*parse)(struct event_command *cmd_ops, 1937 struct trace_event_file *file, 1938 char *glob, char *cmd, 1939 char *param_and_filter); 1940 int (*reg)(char *glob, 1941 struct event_trigger_data *data, 1942 struct trace_event_file *file); 1943 void (*unreg)(char *glob, 1944 struct event_trigger_data *data, 1945 struct trace_event_file *file); 1946 void (*unreg_all)(struct trace_event_file *file); 1947 int (*set_filter)(char *filter_str, 1948 struct event_trigger_data *data, 1949 struct trace_event_file *file); 1950 struct event_trigger_ops *(*get_trigger_ops)(char *cmd, char *param); 1951 }; 1952 1953 /** 1954 * enum event_command_flags - flags for struct event_command 1955 * 1956 * @POST_TRIGGER: A flag that says whether or not this command needs 1957 * to have its action delayed until after the current event has 1958 * been closed. Some triggers need to avoid being invoked while 1959 * an event is currently in the process of being logged, since 1960 * the trigger may itself log data into the trace buffer. Thus 1961 * we make sure the current event is committed before invoking 1962 * those triggers. To do that, the trigger invocation is split 1963 * in two - the first part checks the filter using the current 1964 * trace record; if a command has the @post_trigger flag set, it 1965 * sets a bit for itself in the return value, otherwise it 1966 * directly invokes the trigger. Once all commands have been 1967 * either invoked or set their return flag, the current record is 1968 * either committed or discarded. At that point, if any commands 1969 * have deferred their triggers, those commands are finally 1970 * invoked following the close of the current event. In other 1971 * words, if the event_trigger_ops @func() probe implementation 1972 * itself logs to the trace buffer, this flag should be set, 1973 * otherwise it can be left unspecified. 1974 * 1975 * @NEEDS_REC: A flag that says whether or not this command needs 1976 * access to the trace record in order to perform its function, 1977 * regardless of whether or not it has a filter associated with 1978 * it (filters make a trigger require access to the trace record 1979 * but are not always present). 1980 */ 1981 enum event_command_flags { 1982 EVENT_CMD_FL_POST_TRIGGER = 1, 1983 EVENT_CMD_FL_NEEDS_REC = 2, 1984 }; 1985 1986 static inline bool event_command_post_trigger(struct event_command *cmd_ops) 1987 { 1988 return cmd_ops->flags & EVENT_CMD_FL_POST_TRIGGER; 1989 } 1990 1991 static inline bool event_command_needs_rec(struct event_command *cmd_ops) 1992 { 1993 return cmd_ops->flags & EVENT_CMD_FL_NEEDS_REC; 1994 } 1995 1996 extern int trace_event_enable_disable(struct trace_event_file *file, 1997 int enable, int soft_disable); 1998 extern int tracing_alloc_snapshot(void); 1999 extern void tracing_snapshot_cond(struct trace_array *tr, void *cond_data); 2000 extern int tracing_snapshot_cond_enable(struct trace_array *tr, void *cond_data, cond_update_fn_t update); 2001 2002 extern int tracing_snapshot_cond_disable(struct trace_array *tr); 2003 extern void *tracing_cond_snapshot_data(struct trace_array *tr); 2004 2005 extern const char *__start___trace_bprintk_fmt[]; 2006 extern const char *__stop___trace_bprintk_fmt[]; 2007 2008 extern const char *__start___tracepoint_str[]; 2009 extern const char *__stop___tracepoint_str[]; 2010 2011 void trace_printk_control(bool enabled); 2012 void trace_printk_start_comm(void); 2013 int trace_keep_overwrite(struct tracer *tracer, u32 mask, int set); 2014 int set_tracer_flag(struct trace_array *tr, unsigned int mask, int enabled); 2015 2016 /* Used from boot time tracer */ 2017 extern int trace_set_options(struct trace_array *tr, char *option); 2018 extern int tracing_set_tracer(struct trace_array *tr, const char *buf); 2019 extern ssize_t tracing_resize_ring_buffer(struct trace_array *tr, 2020 unsigned long size, int cpu_id); 2021 extern int tracing_set_cpumask(struct trace_array *tr, 2022 cpumask_var_t tracing_cpumask_new); 2023 2024 2025 #define MAX_EVENT_NAME_LEN 64 2026 2027 extern ssize_t trace_parse_run_command(struct file *file, 2028 const char __user *buffer, size_t count, loff_t *ppos, 2029 int (*createfn)(const char *)); 2030 2031 extern unsigned int err_pos(char *cmd, const char *str); 2032 extern void tracing_log_err(struct trace_array *tr, 2033 const char *loc, const char *cmd, 2034 const char **errs, u8 type, u16 pos); 2035 2036 /* 2037 * Normal trace_printk() and friends allocates special buffers 2038 * to do the manipulation, as well as saves the print formats 2039 * into sections to display. But the trace infrastructure wants 2040 * to use these without the added overhead at the price of being 2041 * a bit slower (used mainly for warnings, where we don't care 2042 * about performance). The internal_trace_puts() is for such 2043 * a purpose. 2044 */ 2045 #define internal_trace_puts(str) __trace_puts(_THIS_IP_, str, strlen(str)) 2046 2047 #undef FTRACE_ENTRY 2048 #define FTRACE_ENTRY(call, struct_name, id, tstruct, print) \ 2049 extern struct trace_event_call \ 2050 __aligned(4) event_##call; 2051 #undef FTRACE_ENTRY_DUP 2052 #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print) \ 2053 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print)) 2054 #undef FTRACE_ENTRY_PACKED 2055 #define FTRACE_ENTRY_PACKED(call, struct_name, id, tstruct, print) \ 2056 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print)) 2057 2058 #include "trace_entries.h" 2059 2060 #if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_FUNCTION_TRACER) 2061 int perf_ftrace_event_register(struct trace_event_call *call, 2062 enum trace_reg type, void *data); 2063 #else 2064 #define perf_ftrace_event_register NULL 2065 #endif 2066 2067 #ifdef CONFIG_FTRACE_SYSCALLS 2068 void init_ftrace_syscalls(void); 2069 const char *get_syscall_name(int syscall); 2070 #else 2071 static inline void init_ftrace_syscalls(void) { } 2072 static inline const char *get_syscall_name(int syscall) 2073 { 2074 return NULL; 2075 } 2076 #endif 2077 2078 #ifdef CONFIG_EVENT_TRACING 2079 void trace_event_init(void); 2080 void trace_event_eval_update(struct trace_eval_map **map, int len); 2081 /* Used from boot time tracer */ 2082 extern int ftrace_set_clr_event(struct trace_array *tr, char *buf, int set); 2083 extern int trigger_process_regex(struct trace_event_file *file, char *buff); 2084 #else 2085 static inline void __init trace_event_init(void) { } 2086 static inline void trace_event_eval_update(struct trace_eval_map **map, int len) { } 2087 #endif 2088 2089 #ifdef CONFIG_TRACER_SNAPSHOT 2090 void tracing_snapshot_instance(struct trace_array *tr); 2091 int tracing_alloc_snapshot_instance(struct trace_array *tr); 2092 int tracing_arm_snapshot(struct trace_array *tr); 2093 void tracing_disarm_snapshot(struct trace_array *tr); 2094 #else 2095 static inline void tracing_snapshot_instance(struct trace_array *tr) { } 2096 static inline int tracing_alloc_snapshot_instance(struct trace_array *tr) 2097 { 2098 return 0; 2099 } 2100 static inline int tracing_arm_snapshot(struct trace_array *tr) { return 0; } 2101 static inline void tracing_disarm_snapshot(struct trace_array *tr) { } 2102 #endif 2103 2104 #ifdef CONFIG_PREEMPT_TRACER 2105 void tracer_preempt_on(unsigned long a0, unsigned long a1); 2106 void tracer_preempt_off(unsigned long a0, unsigned long a1); 2107 #else 2108 static inline void tracer_preempt_on(unsigned long a0, unsigned long a1) { } 2109 static inline void tracer_preempt_off(unsigned long a0, unsigned long a1) { } 2110 #endif 2111 #ifdef CONFIG_IRQSOFF_TRACER 2112 void tracer_hardirqs_on(unsigned long a0, unsigned long a1); 2113 void tracer_hardirqs_off(unsigned long a0, unsigned long a1); 2114 #else 2115 static inline void tracer_hardirqs_on(unsigned long a0, unsigned long a1) { } 2116 static inline void tracer_hardirqs_off(unsigned long a0, unsigned long a1) { } 2117 #endif 2118 2119 /* 2120 * Reset the state of the trace_iterator so that it can read consumed data. 2121 * Normally, the trace_iterator is used for reading the data when it is not 2122 * consumed, and must retain state. 2123 */ 2124 static __always_inline void trace_iterator_reset(struct trace_iterator *iter) 2125 { 2126 memset_startat(iter, 0, seq); 2127 iter->pos = -1; 2128 } 2129 2130 /* Check the name is good for event/group/fields */ 2131 static inline bool __is_good_name(const char *name, bool hash_ok) 2132 { 2133 if (!isalpha(*name) && *name != '_' && (!hash_ok || *name != '-')) 2134 return false; 2135 while (*++name != '\0') { 2136 if (!isalpha(*name) && !isdigit(*name) && *name != '_' && 2137 (!hash_ok || *name != '-')) 2138 return false; 2139 } 2140 return true; 2141 } 2142 2143 /* Check the name is good for event/group/fields */ 2144 static inline bool is_good_name(const char *name) 2145 { 2146 return __is_good_name(name, false); 2147 } 2148 2149 /* Check the name is good for system */ 2150 static inline bool is_good_system_name(const char *name) 2151 { 2152 return __is_good_name(name, true); 2153 } 2154 2155 /* Convert certain expected symbols into '_' when generating event names */ 2156 static inline void sanitize_event_name(char *name) 2157 { 2158 while (*name++ != '\0') 2159 if (*name == ':' || *name == '.') 2160 *name = '_'; 2161 } 2162 2163 /* 2164 * This is a generic way to read and write a u64 value from a file in tracefs. 2165 * 2166 * The value is stored on the variable pointed by *val. The value needs 2167 * to be at least *min and at most *max. The write is protected by an 2168 * existing *lock. 2169 */ 2170 struct trace_min_max_param { 2171 struct mutex *lock; 2172 u64 *val; 2173 u64 *min; 2174 u64 *max; 2175 }; 2176 2177 #define U64_STR_SIZE 24 /* 20 digits max */ 2178 2179 extern const struct file_operations trace_min_max_fops; 2180 2181 #ifdef CONFIG_RV 2182 extern int rv_init_interface(void); 2183 #else 2184 static inline int rv_init_interface(void) 2185 { 2186 return 0; 2187 } 2188 #endif 2189 2190 #endif /* _LINUX_KERNEL_TRACE_H */ 2191