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