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