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