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 bool trace_find_filtered_pid(struct trace_pid_list *filtered_pids, 722 pid_t search_pid); 723 bool trace_ignore_this_task(struct trace_pid_list *filtered_pids, 724 struct trace_pid_list *filtered_no_pids, 725 struct task_struct *task); 726 void trace_filter_add_remove_task(struct trace_pid_list *pid_list, 727 struct task_struct *self, 728 struct task_struct *task); 729 void *trace_pid_next(struct trace_pid_list *pid_list, void *v, loff_t *pos); 730 void *trace_pid_start(struct trace_pid_list *pid_list, loff_t *pos); 731 int trace_pid_show(struct seq_file *m, void *v); 732 int trace_pid_write(struct trace_pid_list *filtered_pids, 733 struct trace_pid_list **new_pid_list, 734 const char __user *ubuf, size_t cnt); 735 736 #ifdef CONFIG_TRACER_MAX_TRACE 737 void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu, 738 void *cond_data); 739 void update_max_tr_single(struct trace_array *tr, 740 struct task_struct *tsk, int cpu); 741 742 #ifdef CONFIG_FSNOTIFY 743 #define LATENCY_FS_NOTIFY 744 #endif 745 #endif /* CONFIG_TRACER_MAX_TRACE */ 746 747 #ifdef LATENCY_FS_NOTIFY 748 void latency_fsnotify(struct trace_array *tr); 749 #else 750 static inline void latency_fsnotify(struct trace_array *tr) { } 751 #endif 752 753 #ifdef CONFIG_STACKTRACE 754 void __trace_stack(struct trace_array *tr, unsigned int trace_ctx, int skip); 755 #else 756 static inline void __trace_stack(struct trace_array *tr, unsigned int trace_ctx, 757 int skip) 758 { 759 } 760 #endif /* CONFIG_STACKTRACE */ 761 762 void trace_last_func_repeats(struct trace_array *tr, 763 struct trace_func_repeats *last_info, 764 unsigned int trace_ctx); 765 766 extern u64 ftrace_now(int cpu); 767 768 extern void trace_find_cmdline(int pid, char comm[]); 769 extern int trace_find_tgid(int pid); 770 extern void trace_event_follow_fork(struct trace_array *tr, bool enable); 771 772 #ifdef CONFIG_DYNAMIC_FTRACE 773 extern unsigned long ftrace_update_tot_cnt; 774 extern unsigned long ftrace_number_of_pages; 775 extern unsigned long ftrace_number_of_groups; 776 extern u64 ftrace_update_time; 777 extern u64 ftrace_total_mod_time; 778 void ftrace_init_trace_array(struct trace_array *tr); 779 #else 780 static inline void ftrace_init_trace_array(struct trace_array *tr) { } 781 #endif 782 #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func 783 extern int DYN_FTRACE_TEST_NAME(void); 784 #define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2 785 extern int DYN_FTRACE_TEST_NAME2(void); 786 787 extern void trace_set_ring_buffer_expanded(struct trace_array *tr); 788 extern bool tracing_selftest_disabled; 789 790 #ifdef CONFIG_FTRACE_STARTUP_TEST 791 extern void __init disable_tracing_selftest(const char *reason); 792 793 extern int trace_selftest_startup_function(struct tracer *trace, 794 struct trace_array *tr); 795 extern int trace_selftest_startup_function_graph(struct tracer *trace, 796 struct trace_array *tr); 797 extern int trace_selftest_startup_irqsoff(struct tracer *trace, 798 struct trace_array *tr); 799 extern int trace_selftest_startup_preemptoff(struct tracer *trace, 800 struct trace_array *tr); 801 extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace, 802 struct trace_array *tr); 803 extern int trace_selftest_startup_wakeup(struct tracer *trace, 804 struct trace_array *tr); 805 extern int trace_selftest_startup_nop(struct tracer *trace, 806 struct trace_array *tr); 807 extern int trace_selftest_startup_branch(struct tracer *trace, 808 struct trace_array *tr); 809 /* 810 * Tracer data references selftest functions that only occur 811 * on boot up. These can be __init functions. Thus, when selftests 812 * are enabled, then the tracers need to reference __init functions. 813 */ 814 #define __tracer_data __refdata 815 #else 816 static inline void __init disable_tracing_selftest(const char *reason) 817 { 818 } 819 /* Tracers are seldom changed. Optimize when selftests are disabled. */ 820 #define __tracer_data __read_mostly 821 #endif /* CONFIG_FTRACE_STARTUP_TEST */ 822 823 extern void *head_page(struct trace_array_cpu *data); 824 extern unsigned long long ns2usecs(u64 nsec); 825 extern int 826 trace_vbprintk(unsigned long ip, const char *fmt, va_list args); 827 extern int 828 trace_vprintk(unsigned long ip, const char *fmt, va_list args); 829 extern int 830 trace_array_vprintk(struct trace_array *tr, 831 unsigned long ip, const char *fmt, va_list args); 832 int trace_array_printk_buf(struct trace_buffer *buffer, 833 unsigned long ip, const char *fmt, ...); 834 void trace_printk_seq(struct trace_seq *s); 835 enum print_line_t print_trace_line(struct trace_iterator *iter); 836 837 extern char trace_find_mark(unsigned long long duration); 838 839 struct ftrace_hash; 840 841 struct ftrace_mod_load { 842 struct list_head list; 843 char *func; 844 char *module; 845 int enable; 846 }; 847 848 enum { 849 FTRACE_HASH_FL_MOD = (1 << 0), 850 }; 851 852 struct ftrace_hash { 853 unsigned long size_bits; 854 struct hlist_head *buckets; 855 unsigned long count; 856 unsigned long flags; 857 struct rcu_head rcu; 858 }; 859 860 struct ftrace_func_entry * 861 ftrace_lookup_ip(struct ftrace_hash *hash, unsigned long ip); 862 863 static __always_inline bool ftrace_hash_empty(struct ftrace_hash *hash) 864 { 865 return !hash || !(hash->count || (hash->flags & FTRACE_HASH_FL_MOD)); 866 } 867 868 /* Standard output formatting function used for function return traces */ 869 #ifdef CONFIG_FUNCTION_GRAPH_TRACER 870 871 /* Flag options */ 872 #define TRACE_GRAPH_PRINT_OVERRUN 0x1 873 #define TRACE_GRAPH_PRINT_CPU 0x2 874 #define TRACE_GRAPH_PRINT_OVERHEAD 0x4 875 #define TRACE_GRAPH_PRINT_PROC 0x8 876 #define TRACE_GRAPH_PRINT_DURATION 0x10 877 #define TRACE_GRAPH_PRINT_ABS_TIME 0x20 878 #define TRACE_GRAPH_PRINT_REL_TIME 0x40 879 #define TRACE_GRAPH_PRINT_IRQS 0x80 880 #define TRACE_GRAPH_PRINT_TAIL 0x100 881 #define TRACE_GRAPH_SLEEP_TIME 0x200 882 #define TRACE_GRAPH_GRAPH_TIME 0x400 883 #define TRACE_GRAPH_PRINT_RETVAL 0x800 884 #define TRACE_GRAPH_PRINT_RETVAL_HEX 0x1000 885 #define TRACE_GRAPH_PRINT_RETADDR 0x2000 886 #define TRACE_GRAPH_PRINT_FILL_SHIFT 28 887 #define TRACE_GRAPH_PRINT_FILL_MASK (0x3 << TRACE_GRAPH_PRINT_FILL_SHIFT) 888 889 extern void ftrace_graph_sleep_time_control(bool enable); 890 891 #ifdef CONFIG_FUNCTION_PROFILER 892 extern void ftrace_graph_graph_time_control(bool enable); 893 #else 894 static inline void ftrace_graph_graph_time_control(bool enable) { } 895 #endif 896 897 extern enum print_line_t 898 print_graph_function_flags(struct trace_iterator *iter, u32 flags); 899 extern void print_graph_headers_flags(struct seq_file *s, u32 flags); 900 extern void 901 trace_print_graph_duration(unsigned long long duration, struct trace_seq *s); 902 extern void graph_trace_open(struct trace_iterator *iter); 903 extern void graph_trace_close(struct trace_iterator *iter); 904 extern int __trace_graph_entry(struct trace_array *tr, 905 struct ftrace_graph_ent *trace, 906 unsigned int trace_ctx); 907 extern int __trace_graph_retaddr_entry(struct trace_array *tr, 908 struct ftrace_graph_ent *trace, 909 unsigned int trace_ctx, 910 unsigned long retaddr); 911 extern void __trace_graph_return(struct trace_array *tr, 912 struct ftrace_graph_ret *trace, 913 unsigned int trace_ctx); 914 extern void init_array_fgraph_ops(struct trace_array *tr, struct ftrace_ops *ops); 915 extern int allocate_fgraph_ops(struct trace_array *tr, struct ftrace_ops *ops); 916 extern void free_fgraph_ops(struct trace_array *tr); 917 918 enum { 919 TRACE_GRAPH_FL = 1, 920 921 /* 922 * In the very unlikely case that an interrupt came in 923 * at a start of graph tracing, and we want to trace 924 * the function in that interrupt, the depth can be greater 925 * than zero, because of the preempted start of a previous 926 * trace. In an even more unlikely case, depth could be 2 927 * if a softirq interrupted the start of graph tracing, 928 * followed by an interrupt preempting a start of graph 929 * tracing in the softirq, and depth can even be 3 930 * if an NMI came in at the start of an interrupt function 931 * that preempted a softirq start of a function that 932 * preempted normal context!!!! Luckily, it can't be 933 * greater than 3, so the next two bits are a mask 934 * of what the depth is when we set TRACE_GRAPH_FL 935 */ 936 937 TRACE_GRAPH_DEPTH_START_BIT, 938 TRACE_GRAPH_DEPTH_END_BIT, 939 940 /* 941 * To implement set_graph_notrace, if this bit is set, we ignore 942 * function graph tracing of called functions, until the return 943 * function is called to clear it. 944 */ 945 TRACE_GRAPH_NOTRACE_BIT, 946 }; 947 948 #define TRACE_GRAPH_NOTRACE (1 << TRACE_GRAPH_NOTRACE_BIT) 949 950 static inline unsigned long ftrace_graph_depth(unsigned long *task_var) 951 { 952 return (*task_var >> TRACE_GRAPH_DEPTH_START_BIT) & 3; 953 } 954 955 static inline void ftrace_graph_set_depth(unsigned long *task_var, int depth) 956 { 957 *task_var &= ~(3 << TRACE_GRAPH_DEPTH_START_BIT); 958 *task_var |= (depth & 3) << TRACE_GRAPH_DEPTH_START_BIT; 959 } 960 961 #ifdef CONFIG_DYNAMIC_FTRACE 962 extern struct ftrace_hash __rcu *ftrace_graph_hash; 963 extern struct ftrace_hash __rcu *ftrace_graph_notrace_hash; 964 965 static inline int 966 ftrace_graph_addr(unsigned long *task_var, struct ftrace_graph_ent *trace) 967 { 968 unsigned long addr = trace->func; 969 int ret = 0; 970 struct ftrace_hash *hash; 971 972 preempt_disable_notrace(); 973 974 /* 975 * Have to open code "rcu_dereference_sched()" because the 976 * function graph tracer can be called when RCU is not 977 * "watching". 978 * Protected with schedule_on_each_cpu(ftrace_sync) 979 */ 980 hash = rcu_dereference_protected(ftrace_graph_hash, !preemptible()); 981 982 if (ftrace_hash_empty(hash)) { 983 ret = 1; 984 goto out; 985 } 986 987 if (ftrace_lookup_ip(hash, addr)) { 988 /* 989 * This needs to be cleared on the return functions 990 * when the depth is zero. 991 */ 992 *task_var |= TRACE_GRAPH_FL; 993 ftrace_graph_set_depth(task_var, trace->depth); 994 995 /* 996 * If no irqs are to be traced, but a set_graph_function 997 * is set, and called by an interrupt handler, we still 998 * want to trace it. 999 */ 1000 if (in_hardirq()) 1001 trace_recursion_set(TRACE_IRQ_BIT); 1002 else 1003 trace_recursion_clear(TRACE_IRQ_BIT); 1004 ret = 1; 1005 } 1006 1007 out: 1008 preempt_enable_notrace(); 1009 return ret; 1010 } 1011 1012 static inline void 1013 ftrace_graph_addr_finish(struct fgraph_ops *gops, struct ftrace_graph_ret *trace) 1014 { 1015 unsigned long *task_var = fgraph_get_task_var(gops); 1016 1017 if ((*task_var & TRACE_GRAPH_FL) && 1018 trace->depth == ftrace_graph_depth(task_var)) 1019 *task_var &= ~TRACE_GRAPH_FL; 1020 } 1021 1022 static inline int ftrace_graph_notrace_addr(unsigned long addr) 1023 { 1024 int ret = 0; 1025 struct ftrace_hash *notrace_hash; 1026 1027 preempt_disable_notrace(); 1028 1029 /* 1030 * Have to open code "rcu_dereference_sched()" because the 1031 * function graph tracer can be called when RCU is not 1032 * "watching". 1033 * Protected with schedule_on_each_cpu(ftrace_sync) 1034 */ 1035 notrace_hash = rcu_dereference_protected(ftrace_graph_notrace_hash, 1036 !preemptible()); 1037 1038 if (ftrace_lookup_ip(notrace_hash, addr)) 1039 ret = 1; 1040 1041 preempt_enable_notrace(); 1042 return ret; 1043 } 1044 #else 1045 static inline int ftrace_graph_addr(unsigned long *task_var, struct ftrace_graph_ent *trace) 1046 { 1047 return 1; 1048 } 1049 1050 static inline int ftrace_graph_notrace_addr(unsigned long addr) 1051 { 1052 return 0; 1053 } 1054 static inline void ftrace_graph_addr_finish(struct fgraph_ops *gops, struct ftrace_graph_ret *trace) 1055 { } 1056 #endif /* CONFIG_DYNAMIC_FTRACE */ 1057 1058 extern unsigned int fgraph_max_depth; 1059 extern bool fgraph_sleep_time; 1060 1061 static inline bool 1062 ftrace_graph_ignore_func(struct fgraph_ops *gops, struct ftrace_graph_ent *trace) 1063 { 1064 unsigned long *task_var = fgraph_get_task_var(gops); 1065 1066 /* trace it when it is-nested-in or is a function enabled. */ 1067 return !((*task_var & TRACE_GRAPH_FL) || 1068 ftrace_graph_addr(task_var, trace)) || 1069 (trace->depth < 0) || 1070 (fgraph_max_depth && trace->depth >= fgraph_max_depth); 1071 } 1072 1073 void fgraph_init_ops(struct ftrace_ops *dst_ops, 1074 struct ftrace_ops *src_ops); 1075 1076 #else /* CONFIG_FUNCTION_GRAPH_TRACER */ 1077 static inline enum print_line_t 1078 print_graph_function_flags(struct trace_iterator *iter, u32 flags) 1079 { 1080 return TRACE_TYPE_UNHANDLED; 1081 } 1082 static inline void free_fgraph_ops(struct trace_array *tr) { } 1083 /* ftrace_ops may not be defined */ 1084 #define init_array_fgraph_ops(tr, ops) do { } while (0) 1085 #define allocate_fgraph_ops(tr, ops) ({ 0; }) 1086 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */ 1087 1088 extern struct list_head ftrace_pids; 1089 1090 #ifdef CONFIG_FUNCTION_TRACER 1091 1092 #define FTRACE_PID_IGNORE -1 1093 #define FTRACE_PID_TRACE -2 1094 1095 struct ftrace_func_command { 1096 struct list_head list; 1097 char *name; 1098 int (*func)(struct trace_array *tr, 1099 struct ftrace_hash *hash, 1100 char *func, char *cmd, 1101 char *params, int enable); 1102 }; 1103 extern bool ftrace_filter_param __initdata; 1104 static inline int ftrace_trace_task(struct trace_array *tr) 1105 { 1106 return this_cpu_read(tr->array_buffer.data->ftrace_ignore_pid) != 1107 FTRACE_PID_IGNORE; 1108 } 1109 extern int ftrace_is_dead(void); 1110 int ftrace_create_function_files(struct trace_array *tr, 1111 struct dentry *parent); 1112 void ftrace_destroy_function_files(struct trace_array *tr); 1113 int ftrace_allocate_ftrace_ops(struct trace_array *tr); 1114 void ftrace_free_ftrace_ops(struct trace_array *tr); 1115 void ftrace_init_global_array_ops(struct trace_array *tr); 1116 void ftrace_init_array_ops(struct trace_array *tr, ftrace_func_t func); 1117 void ftrace_reset_array_ops(struct trace_array *tr); 1118 void ftrace_init_tracefs(struct trace_array *tr, struct dentry *d_tracer); 1119 void ftrace_init_tracefs_toplevel(struct trace_array *tr, 1120 struct dentry *d_tracer); 1121 void ftrace_clear_pids(struct trace_array *tr); 1122 int init_function_trace(void); 1123 void ftrace_pid_follow_fork(struct trace_array *tr, bool enable); 1124 #else 1125 static inline int ftrace_trace_task(struct trace_array *tr) 1126 { 1127 return 1; 1128 } 1129 static inline int ftrace_is_dead(void) { return 0; } 1130 static inline int 1131 ftrace_create_function_files(struct trace_array *tr, 1132 struct dentry *parent) 1133 { 1134 return 0; 1135 } 1136 static inline int ftrace_allocate_ftrace_ops(struct trace_array *tr) 1137 { 1138 return 0; 1139 } 1140 static inline void ftrace_free_ftrace_ops(struct trace_array *tr) { } 1141 static inline void ftrace_destroy_function_files(struct trace_array *tr) { } 1142 static inline __init void 1143 ftrace_init_global_array_ops(struct trace_array *tr) { } 1144 static inline void ftrace_reset_array_ops(struct trace_array *tr) { } 1145 static inline void ftrace_init_tracefs(struct trace_array *tr, struct dentry *d) { } 1146 static inline void ftrace_init_tracefs_toplevel(struct trace_array *tr, struct dentry *d) { } 1147 static inline void ftrace_clear_pids(struct trace_array *tr) { } 1148 static inline int init_function_trace(void) { return 0; } 1149 static inline void ftrace_pid_follow_fork(struct trace_array *tr, bool enable) { } 1150 /* ftace_func_t type is not defined, use macro instead of static inline */ 1151 #define ftrace_init_array_ops(tr, func) do { } while (0) 1152 #endif /* CONFIG_FUNCTION_TRACER */ 1153 1154 #if defined(CONFIG_FUNCTION_TRACER) && defined(CONFIG_DYNAMIC_FTRACE) 1155 1156 struct ftrace_probe_ops { 1157 void (*func)(unsigned long ip, 1158 unsigned long parent_ip, 1159 struct trace_array *tr, 1160 struct ftrace_probe_ops *ops, 1161 void *data); 1162 int (*init)(struct ftrace_probe_ops *ops, 1163 struct trace_array *tr, 1164 unsigned long ip, void *init_data, 1165 void **data); 1166 void (*free)(struct ftrace_probe_ops *ops, 1167 struct trace_array *tr, 1168 unsigned long ip, void *data); 1169 int (*print)(struct seq_file *m, 1170 unsigned long ip, 1171 struct ftrace_probe_ops *ops, 1172 void *data); 1173 }; 1174 1175 struct ftrace_func_mapper; 1176 typedef int (*ftrace_mapper_func)(void *data); 1177 1178 struct ftrace_func_mapper *allocate_ftrace_func_mapper(void); 1179 void **ftrace_func_mapper_find_ip(struct ftrace_func_mapper *mapper, 1180 unsigned long ip); 1181 int ftrace_func_mapper_add_ip(struct ftrace_func_mapper *mapper, 1182 unsigned long ip, void *data); 1183 void *ftrace_func_mapper_remove_ip(struct ftrace_func_mapper *mapper, 1184 unsigned long ip); 1185 void free_ftrace_func_mapper(struct ftrace_func_mapper *mapper, 1186 ftrace_mapper_func free_func); 1187 1188 extern int 1189 register_ftrace_function_probe(char *glob, struct trace_array *tr, 1190 struct ftrace_probe_ops *ops, void *data); 1191 extern int 1192 unregister_ftrace_function_probe_func(char *glob, struct trace_array *tr, 1193 struct ftrace_probe_ops *ops); 1194 extern void clear_ftrace_function_probes(struct trace_array *tr); 1195 1196 int register_ftrace_command(struct ftrace_func_command *cmd); 1197 int unregister_ftrace_command(struct ftrace_func_command *cmd); 1198 1199 void ftrace_create_filter_files(struct ftrace_ops *ops, 1200 struct dentry *parent); 1201 void ftrace_destroy_filter_files(struct ftrace_ops *ops); 1202 1203 extern int ftrace_set_filter(struct ftrace_ops *ops, unsigned char *buf, 1204 int len, int reset); 1205 extern int ftrace_set_notrace(struct ftrace_ops *ops, unsigned char *buf, 1206 int len, int reset); 1207 #else 1208 struct ftrace_func_command; 1209 1210 static inline __init int register_ftrace_command(struct ftrace_func_command *cmd) 1211 { 1212 return -EINVAL; 1213 } 1214 static inline __init int unregister_ftrace_command(char *cmd_name) 1215 { 1216 return -EINVAL; 1217 } 1218 static inline void clear_ftrace_function_probes(struct trace_array *tr) 1219 { 1220 } 1221 1222 /* 1223 * The ops parameter passed in is usually undefined. 1224 * This must be a macro. 1225 */ 1226 #define ftrace_create_filter_files(ops, parent) do { } while (0) 1227 #define ftrace_destroy_filter_files(ops) do { } while (0) 1228 #endif /* CONFIG_FUNCTION_TRACER && CONFIG_DYNAMIC_FTRACE */ 1229 1230 bool ftrace_event_is_function(struct trace_event_call *call); 1231 1232 /* 1233 * struct trace_parser - servers for reading the user input separated by spaces 1234 * @cont: set if the input is not complete - no final space char was found 1235 * @buffer: holds the parsed user input 1236 * @idx: user input length 1237 * @size: buffer size 1238 */ 1239 struct trace_parser { 1240 bool cont; 1241 char *buffer; 1242 unsigned idx; 1243 unsigned size; 1244 }; 1245 1246 static inline bool trace_parser_loaded(struct trace_parser *parser) 1247 { 1248 return (parser->idx != 0); 1249 } 1250 1251 static inline bool trace_parser_cont(struct trace_parser *parser) 1252 { 1253 return parser->cont; 1254 } 1255 1256 static inline void trace_parser_clear(struct trace_parser *parser) 1257 { 1258 parser->cont = false; 1259 parser->idx = 0; 1260 } 1261 1262 extern int trace_parser_get_init(struct trace_parser *parser, int size); 1263 extern void trace_parser_put(struct trace_parser *parser); 1264 extern int trace_get_user(struct trace_parser *parser, const char __user *ubuf, 1265 size_t cnt, loff_t *ppos); 1266 1267 /* 1268 * Only create function graph options if function graph is configured. 1269 */ 1270 #ifdef CONFIG_FUNCTION_GRAPH_TRACER 1271 # define FGRAPH_FLAGS \ 1272 C(DISPLAY_GRAPH, "display-graph"), 1273 #else 1274 # define FGRAPH_FLAGS 1275 #endif 1276 1277 #ifdef CONFIG_BRANCH_TRACER 1278 # define BRANCH_FLAGS \ 1279 C(BRANCH, "branch"), 1280 #else 1281 # define BRANCH_FLAGS 1282 #endif 1283 1284 #ifdef CONFIG_FUNCTION_TRACER 1285 # define FUNCTION_FLAGS \ 1286 C(FUNCTION, "function-trace"), \ 1287 C(FUNC_FORK, "function-fork"), 1288 # define FUNCTION_DEFAULT_FLAGS TRACE_ITER_FUNCTION 1289 #else 1290 # define FUNCTION_FLAGS 1291 # define FUNCTION_DEFAULT_FLAGS 0UL 1292 # define TRACE_ITER_FUNC_FORK 0UL 1293 #endif 1294 1295 #ifdef CONFIG_STACKTRACE 1296 # define STACK_FLAGS \ 1297 C(STACKTRACE, "stacktrace"), 1298 #else 1299 # define STACK_FLAGS 1300 #endif 1301 1302 /* 1303 * trace_iterator_flags is an enumeration that defines bit 1304 * positions into trace_flags that controls the output. 1305 * 1306 * NOTE: These bits must match the trace_options array in 1307 * trace.c (this macro guarantees it). 1308 */ 1309 #define TRACE_FLAGS \ 1310 C(PRINT_PARENT, "print-parent"), \ 1311 C(SYM_OFFSET, "sym-offset"), \ 1312 C(SYM_ADDR, "sym-addr"), \ 1313 C(VERBOSE, "verbose"), \ 1314 C(RAW, "raw"), \ 1315 C(HEX, "hex"), \ 1316 C(BIN, "bin"), \ 1317 C(BLOCK, "block"), \ 1318 C(FIELDS, "fields"), \ 1319 C(PRINTK, "trace_printk"), \ 1320 C(ANNOTATE, "annotate"), \ 1321 C(USERSTACKTRACE, "userstacktrace"), \ 1322 C(SYM_USEROBJ, "sym-userobj"), \ 1323 C(PRINTK_MSGONLY, "printk-msg-only"), \ 1324 C(CONTEXT_INFO, "context-info"), /* Print pid/cpu/time */ \ 1325 C(LATENCY_FMT, "latency-format"), \ 1326 C(RECORD_CMD, "record-cmd"), \ 1327 C(RECORD_TGID, "record-tgid"), \ 1328 C(OVERWRITE, "overwrite"), \ 1329 C(STOP_ON_FREE, "disable_on_free"), \ 1330 C(IRQ_INFO, "irq-info"), \ 1331 C(MARKERS, "markers"), \ 1332 C(EVENT_FORK, "event-fork"), \ 1333 C(TRACE_PRINTK, "trace_printk_dest"), \ 1334 C(PAUSE_ON_TRACE, "pause-on-trace"), \ 1335 C(HASH_PTR, "hash-ptr"), /* Print hashed pointer */ \ 1336 FUNCTION_FLAGS \ 1337 FGRAPH_FLAGS \ 1338 STACK_FLAGS \ 1339 BRANCH_FLAGS 1340 1341 /* 1342 * By defining C, we can make TRACE_FLAGS a list of bit names 1343 * that will define the bits for the flag masks. 1344 */ 1345 #undef C 1346 #define C(a, b) TRACE_ITER_##a##_BIT 1347 1348 enum trace_iterator_bits { 1349 TRACE_FLAGS 1350 /* Make sure we don't go more than we have bits for */ 1351 TRACE_ITER_LAST_BIT 1352 }; 1353 1354 /* 1355 * By redefining C, we can make TRACE_FLAGS a list of masks that 1356 * use the bits as defined above. 1357 */ 1358 #undef C 1359 #define C(a, b) TRACE_ITER_##a = (1 << TRACE_ITER_##a##_BIT) 1360 1361 enum trace_iterator_flags { TRACE_FLAGS }; 1362 1363 /* 1364 * TRACE_ITER_SYM_MASK masks the options in trace_flags that 1365 * control the output of kernel symbols. 1366 */ 1367 #define TRACE_ITER_SYM_MASK \ 1368 (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR) 1369 1370 extern struct tracer nop_trace; 1371 1372 #ifdef CONFIG_BRANCH_TRACER 1373 extern int enable_branch_tracing(struct trace_array *tr); 1374 extern void disable_branch_tracing(void); 1375 static inline int trace_branch_enable(struct trace_array *tr) 1376 { 1377 if (tr->trace_flags & TRACE_ITER_BRANCH) 1378 return enable_branch_tracing(tr); 1379 return 0; 1380 } 1381 static inline void trace_branch_disable(void) 1382 { 1383 /* due to races, always disable */ 1384 disable_branch_tracing(); 1385 } 1386 #else 1387 static inline int trace_branch_enable(struct trace_array *tr) 1388 { 1389 return 0; 1390 } 1391 static inline void trace_branch_disable(void) 1392 { 1393 } 1394 #endif /* CONFIG_BRANCH_TRACER */ 1395 1396 /* set ring buffers to default size if not already done so */ 1397 int tracing_update_buffers(struct trace_array *tr); 1398 1399 union trace_synth_field { 1400 u8 as_u8; 1401 u16 as_u16; 1402 u32 as_u32; 1403 u64 as_u64; 1404 struct trace_dynamic_info as_dynamic; 1405 }; 1406 1407 struct ftrace_event_field { 1408 struct list_head link; 1409 const char *name; 1410 const char *type; 1411 int filter_type; 1412 int offset; 1413 int size; 1414 int is_signed; 1415 int len; 1416 }; 1417 1418 struct prog_entry; 1419 1420 struct event_filter { 1421 struct prog_entry __rcu *prog; 1422 char *filter_string; 1423 }; 1424 1425 struct event_subsystem { 1426 struct list_head list; 1427 const char *name; 1428 struct event_filter *filter; 1429 int ref_count; 1430 }; 1431 1432 struct trace_subsystem_dir { 1433 struct list_head list; 1434 struct event_subsystem *subsystem; 1435 struct trace_array *tr; 1436 struct eventfs_inode *ei; 1437 int ref_count; 1438 int nr_events; 1439 }; 1440 1441 void trace_buffer_unlock_commit_regs(struct trace_array *tr, 1442 struct trace_buffer *buffer, 1443 struct ring_buffer_event *event, 1444 unsigned int trcace_ctx, 1445 struct pt_regs *regs); 1446 1447 static inline void trace_buffer_unlock_commit(struct trace_array *tr, 1448 struct trace_buffer *buffer, 1449 struct ring_buffer_event *event, 1450 unsigned int trace_ctx) 1451 { 1452 trace_buffer_unlock_commit_regs(tr, buffer, event, trace_ctx, NULL); 1453 } 1454 1455 DECLARE_PER_CPU(bool, trace_taskinfo_save); 1456 int trace_save_cmdline(struct task_struct *tsk); 1457 int trace_create_savedcmd(void); 1458 int trace_alloc_tgid_map(void); 1459 void trace_free_saved_cmdlines_buffer(void); 1460 1461 extern const struct file_operations tracing_saved_cmdlines_fops; 1462 extern const struct file_operations tracing_saved_tgids_fops; 1463 extern const struct file_operations tracing_saved_cmdlines_size_fops; 1464 1465 DECLARE_PER_CPU(struct ring_buffer_event *, trace_buffered_event); 1466 DECLARE_PER_CPU(int, trace_buffered_event_cnt); 1467 void trace_buffered_event_disable(void); 1468 void trace_buffered_event_enable(void); 1469 1470 void early_enable_events(struct trace_array *tr, char *buf, bool disable_first); 1471 1472 static inline void 1473 __trace_event_discard_commit(struct trace_buffer *buffer, 1474 struct ring_buffer_event *event) 1475 { 1476 if (this_cpu_read(trace_buffered_event) == event) { 1477 /* Simply release the temp buffer and enable preemption */ 1478 this_cpu_dec(trace_buffered_event_cnt); 1479 preempt_enable_notrace(); 1480 return; 1481 } 1482 /* ring_buffer_discard_commit() enables preemption */ 1483 ring_buffer_discard_commit(buffer, event); 1484 } 1485 1486 /* 1487 * Helper function for event_trigger_unlock_commit{_regs}(). 1488 * If there are event triggers attached to this event that requires 1489 * filtering against its fields, then they will be called as the 1490 * entry already holds the field information of the current event. 1491 * 1492 * It also checks if the event should be discarded or not. 1493 * It is to be discarded if the event is soft disabled and the 1494 * event was only recorded to process triggers, or if the event 1495 * filter is active and this event did not match the filters. 1496 * 1497 * Returns true if the event is discarded, false otherwise. 1498 */ 1499 static inline bool 1500 __event_trigger_test_discard(struct trace_event_file *file, 1501 struct trace_buffer *buffer, 1502 struct ring_buffer_event *event, 1503 void *entry, 1504 enum event_trigger_type *tt) 1505 { 1506 unsigned long eflags = file->flags; 1507 1508 if (eflags & EVENT_FILE_FL_TRIGGER_COND) 1509 *tt = event_triggers_call(file, buffer, entry, event); 1510 1511 if (likely(!(file->flags & (EVENT_FILE_FL_SOFT_DISABLED | 1512 EVENT_FILE_FL_FILTERED | 1513 EVENT_FILE_FL_PID_FILTER)))) 1514 return false; 1515 1516 if (file->flags & EVENT_FILE_FL_SOFT_DISABLED) 1517 goto discard; 1518 1519 if (file->flags & EVENT_FILE_FL_FILTERED && 1520 !filter_match_preds(file->filter, entry)) 1521 goto discard; 1522 1523 if ((file->flags & EVENT_FILE_FL_PID_FILTER) && 1524 trace_event_ignore_this_pid(file)) 1525 goto discard; 1526 1527 return false; 1528 discard: 1529 __trace_event_discard_commit(buffer, event); 1530 return true; 1531 } 1532 1533 /** 1534 * event_trigger_unlock_commit - handle triggers and finish event commit 1535 * @file: The file pointer associated with the event 1536 * @buffer: The ring buffer that the event is being written to 1537 * @event: The event meta data in the ring buffer 1538 * @entry: The event itself 1539 * @trace_ctx: The tracing context flags. 1540 * 1541 * This is a helper function to handle triggers that require data 1542 * from the event itself. It also tests the event against filters and 1543 * if the event is soft disabled and should be discarded. 1544 */ 1545 static inline void 1546 event_trigger_unlock_commit(struct trace_event_file *file, 1547 struct trace_buffer *buffer, 1548 struct ring_buffer_event *event, 1549 void *entry, unsigned int trace_ctx) 1550 { 1551 enum event_trigger_type tt = ETT_NONE; 1552 1553 if (!__event_trigger_test_discard(file, buffer, event, entry, &tt)) 1554 trace_buffer_unlock_commit(file->tr, buffer, event, trace_ctx); 1555 1556 if (tt) 1557 event_triggers_post_call(file, tt); 1558 } 1559 1560 #define FILTER_PRED_INVALID ((unsigned short)-1) 1561 #define FILTER_PRED_IS_RIGHT (1 << 15) 1562 #define FILTER_PRED_FOLD (1 << 15) 1563 1564 /* 1565 * The max preds is the size of unsigned short with 1566 * two flags at the MSBs. One bit is used for both the IS_RIGHT 1567 * and FOLD flags. The other is reserved. 1568 * 1569 * 2^14 preds is way more than enough. 1570 */ 1571 #define MAX_FILTER_PRED 16384 1572 1573 struct filter_pred; 1574 struct regex; 1575 1576 typedef int (*regex_match_func)(char *str, struct regex *r, int len); 1577 1578 enum regex_type { 1579 MATCH_FULL = 0, 1580 MATCH_FRONT_ONLY, 1581 MATCH_MIDDLE_ONLY, 1582 MATCH_END_ONLY, 1583 MATCH_GLOB, 1584 MATCH_INDEX, 1585 }; 1586 1587 struct regex { 1588 char pattern[MAX_FILTER_STR_VAL]; 1589 int len; 1590 int field_len; 1591 regex_match_func match; 1592 }; 1593 1594 static inline bool is_string_field(struct ftrace_event_field *field) 1595 { 1596 return field->filter_type == FILTER_DYN_STRING || 1597 field->filter_type == FILTER_RDYN_STRING || 1598 field->filter_type == FILTER_STATIC_STRING || 1599 field->filter_type == FILTER_PTR_STRING || 1600 field->filter_type == FILTER_COMM; 1601 } 1602 1603 static inline bool is_function_field(struct ftrace_event_field *field) 1604 { 1605 return field->filter_type == FILTER_TRACE_FN; 1606 } 1607 1608 extern enum regex_type 1609 filter_parse_regex(char *buff, int len, char **search, int *not); 1610 extern void print_event_filter(struct trace_event_file *file, 1611 struct trace_seq *s); 1612 extern int apply_event_filter(struct trace_event_file *file, 1613 char *filter_string); 1614 extern int apply_subsystem_event_filter(struct trace_subsystem_dir *dir, 1615 char *filter_string); 1616 extern void print_subsystem_event_filter(struct event_subsystem *system, 1617 struct trace_seq *s); 1618 extern int filter_assign_type(const char *type); 1619 extern int create_event_filter(struct trace_array *tr, 1620 struct trace_event_call *call, 1621 char *filter_str, bool set_str, 1622 struct event_filter **filterp); 1623 extern void free_event_filter(struct event_filter *filter); 1624 1625 struct ftrace_event_field * 1626 trace_find_event_field(struct trace_event_call *call, char *name); 1627 1628 extern void trace_event_enable_cmd_record(bool enable); 1629 extern void trace_event_enable_tgid_record(bool enable); 1630 1631 extern int event_trace_init(void); 1632 extern int init_events(void); 1633 extern int event_trace_add_tracer(struct dentry *parent, struct trace_array *tr); 1634 extern int event_trace_del_tracer(struct trace_array *tr); 1635 extern void __trace_early_add_events(struct trace_array *tr); 1636 1637 extern struct trace_event_file *__find_event_file(struct trace_array *tr, 1638 const char *system, 1639 const char *event); 1640 extern struct trace_event_file *find_event_file(struct trace_array *tr, 1641 const char *system, 1642 const char *event); 1643 1644 static inline void *event_file_data(struct file *filp) 1645 { 1646 return READ_ONCE(file_inode(filp)->i_private); 1647 } 1648 1649 extern struct mutex event_mutex; 1650 extern struct list_head ftrace_events; 1651 1652 /* 1653 * When the trace_event_file is the filp->i_private pointer, 1654 * it must be taken under the event_mutex lock, and then checked 1655 * if the EVENT_FILE_FL_FREED flag is set. If it is, then the 1656 * data pointed to by the trace_event_file can not be trusted. 1657 * 1658 * Use the event_file_file() to access the trace_event_file from 1659 * the filp the first time under the event_mutex and check for 1660 * NULL. If it is needed to be retrieved again and the event_mutex 1661 * is still held, then the event_file_data() can be used and it 1662 * is guaranteed to be valid. 1663 */ 1664 static inline struct trace_event_file *event_file_file(struct file *filp) 1665 { 1666 struct trace_event_file *file; 1667 1668 lockdep_assert_held(&event_mutex); 1669 file = READ_ONCE(file_inode(filp)->i_private); 1670 if (!file || file->flags & EVENT_FILE_FL_FREED) 1671 return NULL; 1672 return file; 1673 } 1674 1675 extern const struct file_operations event_trigger_fops; 1676 extern const struct file_operations event_hist_fops; 1677 extern const struct file_operations event_hist_debug_fops; 1678 extern const struct file_operations event_inject_fops; 1679 1680 #ifdef CONFIG_HIST_TRIGGERS 1681 extern int register_trigger_hist_cmd(void); 1682 extern int register_trigger_hist_enable_disable_cmds(void); 1683 #else 1684 static inline int register_trigger_hist_cmd(void) { return 0; } 1685 static inline int register_trigger_hist_enable_disable_cmds(void) { return 0; } 1686 #endif 1687 1688 extern int register_trigger_cmds(void); 1689 extern void clear_event_triggers(struct trace_array *tr); 1690 1691 enum { 1692 EVENT_TRIGGER_FL_PROBE = BIT(0), 1693 }; 1694 1695 struct event_trigger_data { 1696 unsigned long count; 1697 int ref; 1698 int flags; 1699 struct event_trigger_ops *ops; 1700 struct event_command *cmd_ops; 1701 struct event_filter __rcu *filter; 1702 char *filter_str; 1703 void *private_data; 1704 bool paused; 1705 bool paused_tmp; 1706 struct list_head list; 1707 char *name; 1708 struct list_head named_list; 1709 struct event_trigger_data *named_data; 1710 }; 1711 1712 /* Avoid typos */ 1713 #define ENABLE_EVENT_STR "enable_event" 1714 #define DISABLE_EVENT_STR "disable_event" 1715 #define ENABLE_HIST_STR "enable_hist" 1716 #define DISABLE_HIST_STR "disable_hist" 1717 1718 struct enable_trigger_data { 1719 struct trace_event_file *file; 1720 bool enable; 1721 bool hist; 1722 }; 1723 1724 extern int event_enable_trigger_print(struct seq_file *m, 1725 struct event_trigger_data *data); 1726 extern void event_enable_trigger_free(struct event_trigger_data *data); 1727 extern int event_enable_trigger_parse(struct event_command *cmd_ops, 1728 struct trace_event_file *file, 1729 char *glob, char *cmd, 1730 char *param_and_filter); 1731 extern int event_enable_register_trigger(char *glob, 1732 struct event_trigger_data *data, 1733 struct trace_event_file *file); 1734 extern void event_enable_unregister_trigger(char *glob, 1735 struct event_trigger_data *test, 1736 struct trace_event_file *file); 1737 extern void trigger_data_free(struct event_trigger_data *data); 1738 extern int event_trigger_init(struct event_trigger_data *data); 1739 extern int trace_event_trigger_enable_disable(struct trace_event_file *file, 1740 int trigger_enable); 1741 extern void update_cond_flag(struct trace_event_file *file); 1742 extern int set_trigger_filter(char *filter_str, 1743 struct event_trigger_data *trigger_data, 1744 struct trace_event_file *file); 1745 extern struct event_trigger_data *find_named_trigger(const char *name); 1746 extern bool is_named_trigger(struct event_trigger_data *test); 1747 extern int save_named_trigger(const char *name, 1748 struct event_trigger_data *data); 1749 extern void del_named_trigger(struct event_trigger_data *data); 1750 extern void pause_named_trigger(struct event_trigger_data *data); 1751 extern void unpause_named_trigger(struct event_trigger_data *data); 1752 extern void set_named_trigger_data(struct event_trigger_data *data, 1753 struct event_trigger_data *named_data); 1754 extern struct event_trigger_data * 1755 get_named_trigger_data(struct event_trigger_data *data); 1756 extern int register_event_command(struct event_command *cmd); 1757 extern int unregister_event_command(struct event_command *cmd); 1758 extern int register_trigger_hist_enable_disable_cmds(void); 1759 extern bool event_trigger_check_remove(const char *glob); 1760 extern bool event_trigger_empty_param(const char *param); 1761 extern int event_trigger_separate_filter(char *param_and_filter, char **param, 1762 char **filter, bool param_required); 1763 extern struct event_trigger_data * 1764 event_trigger_alloc(struct event_command *cmd_ops, 1765 char *cmd, 1766 char *param, 1767 void *private_data); 1768 extern int event_trigger_parse_num(char *trigger, 1769 struct event_trigger_data *trigger_data); 1770 extern int event_trigger_set_filter(struct event_command *cmd_ops, 1771 struct trace_event_file *file, 1772 char *param, 1773 struct event_trigger_data *trigger_data); 1774 extern void event_trigger_reset_filter(struct event_command *cmd_ops, 1775 struct event_trigger_data *trigger_data); 1776 extern int event_trigger_register(struct event_command *cmd_ops, 1777 struct trace_event_file *file, 1778 char *glob, 1779 struct event_trigger_data *trigger_data); 1780 extern void event_trigger_unregister(struct event_command *cmd_ops, 1781 struct trace_event_file *file, 1782 char *glob, 1783 struct event_trigger_data *trigger_data); 1784 1785 extern void event_file_get(struct trace_event_file *file); 1786 extern void event_file_put(struct trace_event_file *file); 1787 1788 /** 1789 * struct event_trigger_ops - callbacks for trace event triggers 1790 * 1791 * The methods in this structure provide per-event trigger hooks for 1792 * various trigger operations. 1793 * 1794 * The @init and @free methods are used during trigger setup and 1795 * teardown, typically called from an event_command's @parse() 1796 * function implementation. 1797 * 1798 * The @print method is used to print the trigger spec. 1799 * 1800 * The @trigger method is the function that actually implements the 1801 * trigger and is called in the context of the triggering event 1802 * whenever that event occurs. 1803 * 1804 * All the methods below, except for @init() and @free(), must be 1805 * implemented. 1806 * 1807 * @trigger: The trigger 'probe' function called when the triggering 1808 * event occurs. The data passed into this callback is the data 1809 * that was supplied to the event_command @reg() function that 1810 * registered the trigger (see struct event_command) along with 1811 * the trace record, rec. 1812 * 1813 * @init: An optional initialization function called for the trigger 1814 * when the trigger is registered (via the event_command reg() 1815 * function). This can be used to perform per-trigger 1816 * initialization such as incrementing a per-trigger reference 1817 * count, for instance. This is usually implemented by the 1818 * generic utility function @event_trigger_init() (see 1819 * trace_event_triggers.c). 1820 * 1821 * @free: An optional de-initialization function called for the 1822 * trigger when the trigger is unregistered (via the 1823 * event_command @reg() function). This can be used to perform 1824 * per-trigger de-initialization such as decrementing a 1825 * per-trigger reference count and freeing corresponding trigger 1826 * data, for instance. This is usually implemented by the 1827 * generic utility function @event_trigger_free() (see 1828 * trace_event_triggers.c). 1829 * 1830 * @print: The callback function invoked to have the trigger print 1831 * itself. This is usually implemented by a wrapper function 1832 * that calls the generic utility function @event_trigger_print() 1833 * (see trace_event_triggers.c). 1834 */ 1835 struct event_trigger_ops { 1836 void (*trigger)(struct event_trigger_data *data, 1837 struct trace_buffer *buffer, 1838 void *rec, 1839 struct ring_buffer_event *rbe); 1840 int (*init)(struct event_trigger_data *data); 1841 void (*free)(struct event_trigger_data *data); 1842 int (*print)(struct seq_file *m, 1843 struct event_trigger_data *data); 1844 }; 1845 1846 /** 1847 * struct event_command - callbacks and data members for event commands 1848 * 1849 * Event commands are invoked by users by writing the command name 1850 * into the 'trigger' file associated with a trace event. The 1851 * parameters associated with a specific invocation of an event 1852 * command are used to create an event trigger instance, which is 1853 * added to the list of trigger instances associated with that trace 1854 * event. When the event is hit, the set of triggers associated with 1855 * that event is invoked. 1856 * 1857 * The data members in this structure provide per-event command data 1858 * for various event commands. 1859 * 1860 * All the data members below, except for @post_trigger, must be set 1861 * for each event command. 1862 * 1863 * @name: The unique name that identifies the event command. This is 1864 * the name used when setting triggers via trigger files. 1865 * 1866 * @trigger_type: A unique id that identifies the event command 1867 * 'type'. This value has two purposes, the first to ensure that 1868 * only one trigger of the same type can be set at a given time 1869 * for a particular event e.g. it doesn't make sense to have both 1870 * a traceon and traceoff trigger attached to a single event at 1871 * the same time, so traceon and traceoff have the same type 1872 * though they have different names. The @trigger_type value is 1873 * also used as a bit value for deferring the actual trigger 1874 * action until after the current event is finished. Some 1875 * commands need to do this if they themselves log to the trace 1876 * buffer (see the @post_trigger() member below). @trigger_type 1877 * values are defined by adding new values to the trigger_type 1878 * enum in include/linux/trace_events.h. 1879 * 1880 * @flags: See the enum event_command_flags below. 1881 * 1882 * All the methods below, except for @set_filter() and @unreg_all(), 1883 * must be implemented. 1884 * 1885 * @parse: The callback function responsible for parsing and 1886 * registering the trigger written to the 'trigger' file by the 1887 * user. It allocates the trigger instance and registers it with 1888 * the appropriate trace event. It makes use of the other 1889 * event_command callback functions to orchestrate this, and is 1890 * usually implemented by the generic utility function 1891 * @event_trigger_callback() (see trace_event_triggers.c). 1892 * 1893 * @reg: Adds the trigger to the list of triggers associated with the 1894 * event, and enables the event trigger itself, after 1895 * initializing it (via the event_trigger_ops @init() function). 1896 * This is also where commands can use the @trigger_type value to 1897 * make the decision as to whether or not multiple instances of 1898 * the trigger should be allowed. This is usually implemented by 1899 * the generic utility function @register_trigger() (see 1900 * trace_event_triggers.c). 1901 * 1902 * @unreg: Removes the trigger from the list of triggers associated 1903 * with the event, and disables the event trigger itself, after 1904 * initializing it (via the event_trigger_ops @free() function). 1905 * This is usually implemented by the generic utility function 1906 * @unregister_trigger() (see trace_event_triggers.c). 1907 * 1908 * @unreg_all: An optional function called to remove all the triggers 1909 * from the list of triggers associated with the event. Called 1910 * when a trigger file is opened in truncate mode. 1911 * 1912 * @set_filter: An optional function called to parse and set a filter 1913 * for the trigger. If no @set_filter() method is set for the 1914 * event command, filters set by the user for the command will be 1915 * ignored. This is usually implemented by the generic utility 1916 * function @set_trigger_filter() (see trace_event_triggers.c). 1917 * 1918 * @get_trigger_ops: The callback function invoked to retrieve the 1919 * event_trigger_ops implementation associated with the command. 1920 * This callback function allows a single event_command to 1921 * support multiple trigger implementations via different sets of 1922 * event_trigger_ops, depending on the value of the @param 1923 * string. 1924 */ 1925 struct event_command { 1926 struct list_head list; 1927 char *name; 1928 enum event_trigger_type trigger_type; 1929 int flags; 1930 int (*parse)(struct event_command *cmd_ops, 1931 struct trace_event_file *file, 1932 char *glob, char *cmd, 1933 char *param_and_filter); 1934 int (*reg)(char *glob, 1935 struct event_trigger_data *data, 1936 struct trace_event_file *file); 1937 void (*unreg)(char *glob, 1938 struct event_trigger_data *data, 1939 struct trace_event_file *file); 1940 void (*unreg_all)(struct trace_event_file *file); 1941 int (*set_filter)(char *filter_str, 1942 struct event_trigger_data *data, 1943 struct trace_event_file *file); 1944 struct event_trigger_ops *(*get_trigger_ops)(char *cmd, char *param); 1945 }; 1946 1947 /** 1948 * enum event_command_flags - flags for struct event_command 1949 * 1950 * @POST_TRIGGER: A flag that says whether or not this command needs 1951 * to have its action delayed until after the current event has 1952 * been closed. Some triggers need to avoid being invoked while 1953 * an event is currently in the process of being logged, since 1954 * the trigger may itself log data into the trace buffer. Thus 1955 * we make sure the current event is committed before invoking 1956 * those triggers. To do that, the trigger invocation is split 1957 * in two - the first part checks the filter using the current 1958 * trace record; if a command has the @post_trigger flag set, it 1959 * sets a bit for itself in the return value, otherwise it 1960 * directly invokes the trigger. Once all commands have been 1961 * either invoked or set their return flag, the current record is 1962 * either committed or discarded. At that point, if any commands 1963 * have deferred their triggers, those commands are finally 1964 * invoked following the close of the current event. In other 1965 * words, if the event_trigger_ops @func() probe implementation 1966 * itself logs to the trace buffer, this flag should be set, 1967 * otherwise it can be left unspecified. 1968 * 1969 * @NEEDS_REC: A flag that says whether or not this command needs 1970 * access to the trace record in order to perform its function, 1971 * regardless of whether or not it has a filter associated with 1972 * it (filters make a trigger require access to the trace record 1973 * but are not always present). 1974 */ 1975 enum event_command_flags { 1976 EVENT_CMD_FL_POST_TRIGGER = 1, 1977 EVENT_CMD_FL_NEEDS_REC = 2, 1978 }; 1979 1980 static inline bool event_command_post_trigger(struct event_command *cmd_ops) 1981 { 1982 return cmd_ops->flags & EVENT_CMD_FL_POST_TRIGGER; 1983 } 1984 1985 static inline bool event_command_needs_rec(struct event_command *cmd_ops) 1986 { 1987 return cmd_ops->flags & EVENT_CMD_FL_NEEDS_REC; 1988 } 1989 1990 extern int trace_event_enable_disable(struct trace_event_file *file, 1991 int enable, int soft_disable); 1992 extern int tracing_alloc_snapshot(void); 1993 extern void tracing_snapshot_cond(struct trace_array *tr, void *cond_data); 1994 extern int tracing_snapshot_cond_enable(struct trace_array *tr, void *cond_data, cond_update_fn_t update); 1995 1996 extern int tracing_snapshot_cond_disable(struct trace_array *tr); 1997 extern void *tracing_cond_snapshot_data(struct trace_array *tr); 1998 1999 extern const char *__start___trace_bprintk_fmt[]; 2000 extern const char *__stop___trace_bprintk_fmt[]; 2001 2002 extern const char *__start___tracepoint_str[]; 2003 extern const char *__stop___tracepoint_str[]; 2004 2005 void trace_printk_control(bool enabled); 2006 void trace_printk_start_comm(void); 2007 int trace_keep_overwrite(struct tracer *tracer, u32 mask, int set); 2008 int set_tracer_flag(struct trace_array *tr, unsigned int mask, int enabled); 2009 2010 /* Used from boot time tracer */ 2011 extern int trace_set_options(struct trace_array *tr, char *option); 2012 extern int tracing_set_tracer(struct trace_array *tr, const char *buf); 2013 extern ssize_t tracing_resize_ring_buffer(struct trace_array *tr, 2014 unsigned long size, int cpu_id); 2015 extern int tracing_set_cpumask(struct trace_array *tr, 2016 cpumask_var_t tracing_cpumask_new); 2017 2018 2019 #define MAX_EVENT_NAME_LEN 64 2020 2021 extern ssize_t trace_parse_run_command(struct file *file, 2022 const char __user *buffer, size_t count, loff_t *ppos, 2023 int (*createfn)(const char *)); 2024 2025 extern unsigned int err_pos(char *cmd, const char *str); 2026 extern void tracing_log_err(struct trace_array *tr, 2027 const char *loc, const char *cmd, 2028 const char **errs, u8 type, u16 pos); 2029 2030 /* 2031 * Normal trace_printk() and friends allocates special buffers 2032 * to do the manipulation, as well as saves the print formats 2033 * into sections to display. But the trace infrastructure wants 2034 * to use these without the added overhead at the price of being 2035 * a bit slower (used mainly for warnings, where we don't care 2036 * about performance). The internal_trace_puts() is for such 2037 * a purpose. 2038 */ 2039 #define internal_trace_puts(str) __trace_puts(_THIS_IP_, str, strlen(str)) 2040 2041 #undef FTRACE_ENTRY 2042 #define FTRACE_ENTRY(call, struct_name, id, tstruct, print) \ 2043 extern struct trace_event_call \ 2044 __aligned(4) event_##call; 2045 #undef FTRACE_ENTRY_DUP 2046 #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print) \ 2047 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print)) 2048 #undef FTRACE_ENTRY_PACKED 2049 #define FTRACE_ENTRY_PACKED(call, struct_name, id, tstruct, print) \ 2050 FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print)) 2051 2052 #include "trace_entries.h" 2053 2054 #if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_FUNCTION_TRACER) 2055 int perf_ftrace_event_register(struct trace_event_call *call, 2056 enum trace_reg type, void *data); 2057 #else 2058 #define perf_ftrace_event_register NULL 2059 #endif 2060 2061 #ifdef CONFIG_FTRACE_SYSCALLS 2062 void init_ftrace_syscalls(void); 2063 const char *get_syscall_name(int syscall); 2064 #else 2065 static inline void init_ftrace_syscalls(void) { } 2066 static inline const char *get_syscall_name(int syscall) 2067 { 2068 return NULL; 2069 } 2070 #endif 2071 2072 #ifdef CONFIG_EVENT_TRACING 2073 void trace_event_init(void); 2074 void trace_event_eval_update(struct trace_eval_map **map, int len); 2075 /* Used from boot time tracer */ 2076 extern int ftrace_set_clr_event(struct trace_array *tr, char *buf, int set); 2077 extern int trigger_process_regex(struct trace_event_file *file, char *buff); 2078 #else 2079 static inline void __init trace_event_init(void) { } 2080 static inline void trace_event_eval_update(struct trace_eval_map **map, int len) { } 2081 #endif 2082 2083 #ifdef CONFIG_TRACER_SNAPSHOT 2084 void tracing_snapshot_instance(struct trace_array *tr); 2085 int tracing_alloc_snapshot_instance(struct trace_array *tr); 2086 int tracing_arm_snapshot(struct trace_array *tr); 2087 void tracing_disarm_snapshot(struct trace_array *tr); 2088 #else 2089 static inline void tracing_snapshot_instance(struct trace_array *tr) { } 2090 static inline int tracing_alloc_snapshot_instance(struct trace_array *tr) 2091 { 2092 return 0; 2093 } 2094 static inline int tracing_arm_snapshot(struct trace_array *tr) { return 0; } 2095 static inline void tracing_disarm_snapshot(struct trace_array *tr) { } 2096 #endif 2097 2098 #ifdef CONFIG_PREEMPT_TRACER 2099 void tracer_preempt_on(unsigned long a0, unsigned long a1); 2100 void tracer_preempt_off(unsigned long a0, unsigned long a1); 2101 #else 2102 static inline void tracer_preempt_on(unsigned long a0, unsigned long a1) { } 2103 static inline void tracer_preempt_off(unsigned long a0, unsigned long a1) { } 2104 #endif 2105 #ifdef CONFIG_IRQSOFF_TRACER 2106 void tracer_hardirqs_on(unsigned long a0, unsigned long a1); 2107 void tracer_hardirqs_off(unsigned long a0, unsigned long a1); 2108 #else 2109 static inline void tracer_hardirqs_on(unsigned long a0, unsigned long a1) { } 2110 static inline void tracer_hardirqs_off(unsigned long a0, unsigned long a1) { } 2111 #endif 2112 2113 /* 2114 * Reset the state of the trace_iterator so that it can read consumed data. 2115 * Normally, the trace_iterator is used for reading the data when it is not 2116 * consumed, and must retain state. 2117 */ 2118 static __always_inline void trace_iterator_reset(struct trace_iterator *iter) 2119 { 2120 memset_startat(iter, 0, seq); 2121 iter->pos = -1; 2122 } 2123 2124 /* Check the name is good for event/group/fields */ 2125 static inline bool __is_good_name(const char *name, bool hash_ok) 2126 { 2127 if (!isalpha(*name) && *name != '_' && (!hash_ok || *name != '-')) 2128 return false; 2129 while (*++name != '\0') { 2130 if (!isalpha(*name) && !isdigit(*name) && *name != '_' && 2131 (!hash_ok || *name != '-')) 2132 return false; 2133 } 2134 return true; 2135 } 2136 2137 /* Check the name is good for event/group/fields */ 2138 static inline bool is_good_name(const char *name) 2139 { 2140 return __is_good_name(name, false); 2141 } 2142 2143 /* Check the name is good for system */ 2144 static inline bool is_good_system_name(const char *name) 2145 { 2146 return __is_good_name(name, true); 2147 } 2148 2149 /* Convert certain expected symbols into '_' when generating event names */ 2150 static inline void sanitize_event_name(char *name) 2151 { 2152 while (*name++ != '\0') 2153 if (*name == ':' || *name == '.') 2154 *name = '_'; 2155 } 2156 2157 /* 2158 * This is a generic way to read and write a u64 value from a file in tracefs. 2159 * 2160 * The value is stored on the variable pointed by *val. The value needs 2161 * to be at least *min and at most *max. The write is protected by an 2162 * existing *lock. 2163 */ 2164 struct trace_min_max_param { 2165 struct mutex *lock; 2166 u64 *val; 2167 u64 *min; 2168 u64 *max; 2169 }; 2170 2171 #define U64_STR_SIZE 24 /* 20 digits max */ 2172 2173 extern const struct file_operations trace_min_max_fops; 2174 2175 #ifdef CONFIG_RV 2176 extern int rv_init_interface(void); 2177 #else 2178 static inline int rv_init_interface(void) 2179 { 2180 return 0; 2181 } 2182 #endif 2183 2184 /* 2185 * This is used only to distinguish 2186 * function address from trampoline code. 2187 * So this value has no meaning. 2188 */ 2189 #define FTRACE_TRAMPOLINE_MARKER ((unsigned long) INT_MAX) 2190 2191 #endif /* _LINUX_KERNEL_TRACE_H */ 2192