trace.h 30 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063
  1. #ifndef _LINUX_KERNEL_TRACE_H
  2. #define _LINUX_KERNEL_TRACE_H
  3. #include <linux/fs.h>
  4. #include <linux/atomic.h>
  5. #include <linux/sched.h>
  6. #include <linux/clocksource.h>
  7. #include <linux/ring_buffer.h>
  8. #include <linux/mmiotrace.h>
  9. #include <linux/tracepoint.h>
  10. #include <linux/ftrace.h>
  11. #include <linux/hw_breakpoint.h>
  12. #include <linux/trace_seq.h>
  13. #include <linux/ftrace_event.h>
  14. #ifdef CONFIG_FTRACE_SYSCALLS
  15. #include <asm/unistd.h> /* For NR_SYSCALLS */
  16. #include <asm/syscall.h> /* some archs define it here */
  17. #endif
  18. enum trace_type {
  19. __TRACE_FIRST_TYPE = 0,
  20. TRACE_FN,
  21. TRACE_CTX,
  22. TRACE_WAKE,
  23. TRACE_STACK,
  24. TRACE_PRINT,
  25. TRACE_BPRINT,
  26. TRACE_MMIO_RW,
  27. TRACE_MMIO_MAP,
  28. TRACE_BRANCH,
  29. TRACE_GRAPH_RET,
  30. TRACE_GRAPH_ENT,
  31. TRACE_USER_STACK,
  32. TRACE_BLK,
  33. TRACE_BPUTS,
  34. __TRACE_LAST_TYPE,
  35. };
  36. #undef __field
  37. #define __field(type, item) type item;
  38. #undef __field_struct
  39. #define __field_struct(type, item) __field(type, item)
  40. #undef __field_desc
  41. #define __field_desc(type, container, item)
  42. #undef __array
  43. #define __array(type, item, size) type item[size];
  44. #undef __array_desc
  45. #define __array_desc(type, container, item, size)
  46. #undef __dynamic_array
  47. #define __dynamic_array(type, item) type item[];
  48. #undef F_STRUCT
  49. #define F_STRUCT(args...) args
  50. #undef FTRACE_ENTRY
  51. #define FTRACE_ENTRY(name, struct_name, id, tstruct, print, filter) \
  52. struct struct_name { \
  53. struct trace_entry ent; \
  54. tstruct \
  55. }
  56. #undef TP_ARGS
  57. #define TP_ARGS(args...) args
  58. #undef FTRACE_ENTRY_DUP
  59. #define FTRACE_ENTRY_DUP(name, name_struct, id, tstruct, printk, filter)
  60. #undef FTRACE_ENTRY_REG
  61. #define FTRACE_ENTRY_REG(name, struct_name, id, tstruct, print, \
  62. filter, regfn) \
  63. FTRACE_ENTRY(name, struct_name, id, PARAMS(tstruct), PARAMS(print), \
  64. filter)
  65. #include "trace_entries.h"
  66. /*
  67. * syscalls are special, and need special handling, this is why
  68. * they are not included in trace_entries.h
  69. */
  70. struct syscall_trace_enter {
  71. struct trace_entry ent;
  72. int nr;
  73. unsigned long args[];
  74. };
  75. struct syscall_trace_exit {
  76. struct trace_entry ent;
  77. int nr;
  78. long ret;
  79. };
  80. struct kprobe_trace_entry_head {
  81. struct trace_entry ent;
  82. unsigned long ip;
  83. };
  84. struct kretprobe_trace_entry_head {
  85. struct trace_entry ent;
  86. unsigned long func;
  87. unsigned long ret_ip;
  88. };
  89. /*
  90. * trace_flag_type is an enumeration that holds different
  91. * states when a trace occurs. These are:
  92. * IRQS_OFF - interrupts were disabled
  93. * IRQS_NOSUPPORT - arch does not support irqs_disabled_flags
  94. * NEED_RESCHED - reschedule is requested
  95. * HARDIRQ - inside an interrupt handler
  96. * SOFTIRQ - inside a softirq handler
  97. */
  98. enum trace_flag_type {
  99. TRACE_FLAG_IRQS_OFF = 0x01,
  100. TRACE_FLAG_IRQS_NOSUPPORT = 0x02,
  101. TRACE_FLAG_NEED_RESCHED = 0x04,
  102. TRACE_FLAG_HARDIRQ = 0x08,
  103. TRACE_FLAG_SOFTIRQ = 0x10,
  104. };
  105. #define TRACE_BUF_SIZE 1024
  106. struct trace_array;
  107. struct trace_cpu {
  108. struct trace_array *tr;
  109. struct dentry *dir;
  110. int cpu;
  111. };
  112. /*
  113. * The CPU trace array - it consists of thousands of trace entries
  114. * plus some other descriptor data: (for example which task started
  115. * the trace, etc.)
  116. */
  117. struct trace_array_cpu {
  118. struct trace_cpu trace_cpu;
  119. atomic_t disabled;
  120. void *buffer_page; /* ring buffer spare */
  121. unsigned long entries;
  122. unsigned long saved_latency;
  123. unsigned long critical_start;
  124. unsigned long critical_end;
  125. unsigned long critical_sequence;
  126. unsigned long nice;
  127. unsigned long policy;
  128. unsigned long rt_priority;
  129. unsigned long skipped_entries;
  130. cycle_t preempt_timestamp;
  131. pid_t pid;
  132. kuid_t uid;
  133. char comm[TASK_COMM_LEN];
  134. };
  135. struct tracer;
  136. struct trace_buffer {
  137. struct trace_array *tr;
  138. struct ring_buffer *buffer;
  139. struct trace_array_cpu __percpu *data;
  140. cycle_t time_start;
  141. int cpu;
  142. };
  143. /*
  144. * The trace array - an array of per-CPU trace arrays. This is the
  145. * highest level data structure that individual tracers deal with.
  146. * They have on/off state as well:
  147. */
  148. struct trace_array {
  149. struct list_head list;
  150. char *name;
  151. struct trace_buffer trace_buffer;
  152. #ifdef CONFIG_TRACER_MAX_TRACE
  153. /*
  154. * The max_buffer is used to snapshot the trace when a maximum
  155. * latency is reached, or when the user initiates a snapshot.
  156. * Some tracers will use this to store a maximum trace while
  157. * it continues examining live traces.
  158. *
  159. * The buffers for the max_buffer are set up the same as the trace_buffer
  160. * When a snapshot is taken, the buffer of the max_buffer is swapped
  161. * with the buffer of the trace_buffer and the buffers are reset for
  162. * the trace_buffer so the tracing can continue.
  163. */
  164. struct trace_buffer max_buffer;
  165. bool allocated_snapshot;
  166. #endif
  167. int buffer_disabled;
  168. struct trace_cpu trace_cpu; /* place holder */
  169. #ifdef CONFIG_FTRACE_SYSCALLS
  170. int sys_refcount_enter;
  171. int sys_refcount_exit;
  172. DECLARE_BITMAP(enabled_enter_syscalls, NR_syscalls);
  173. DECLARE_BITMAP(enabled_exit_syscalls, NR_syscalls);
  174. #endif
  175. int stop_count;
  176. int clock_id;
  177. struct tracer *current_trace;
  178. unsigned int flags;
  179. raw_spinlock_t start_lock;
  180. struct dentry *dir;
  181. struct dentry *options;
  182. struct dentry *percpu_dir;
  183. struct dentry *event_dir;
  184. struct list_head systems;
  185. struct list_head events;
  186. struct task_struct *waiter;
  187. int ref;
  188. };
  189. enum {
  190. TRACE_ARRAY_FL_GLOBAL = (1 << 0)
  191. };
  192. extern struct list_head ftrace_trace_arrays;
  193. /*
  194. * The global tracer (top) should be the first trace array added,
  195. * but we check the flag anyway.
  196. */
  197. static inline struct trace_array *top_trace_array(void)
  198. {
  199. struct trace_array *tr;
  200. tr = list_entry(ftrace_trace_arrays.prev,
  201. typeof(*tr), list);
  202. WARN_ON(!(tr->flags & TRACE_ARRAY_FL_GLOBAL));
  203. return tr;
  204. }
  205. #define FTRACE_CMP_TYPE(var, type) \
  206. __builtin_types_compatible_p(typeof(var), type *)
  207. #undef IF_ASSIGN
  208. #define IF_ASSIGN(var, entry, etype, id) \
  209. if (FTRACE_CMP_TYPE(var, etype)) { \
  210. var = (typeof(var))(entry); \
  211. WARN_ON(id && (entry)->type != id); \
  212. break; \
  213. }
  214. /* Will cause compile errors if type is not found. */
  215. extern void __ftrace_bad_type(void);
  216. /*
  217. * The trace_assign_type is a verifier that the entry type is
  218. * the same as the type being assigned. To add new types simply
  219. * add a line with the following format:
  220. *
  221. * IF_ASSIGN(var, ent, type, id);
  222. *
  223. * Where "type" is the trace type that includes the trace_entry
  224. * as the "ent" item. And "id" is the trace identifier that is
  225. * used in the trace_type enum.
  226. *
  227. * If the type can have more than one id, then use zero.
  228. */
  229. #define trace_assign_type(var, ent) \
  230. do { \
  231. IF_ASSIGN(var, ent, struct ftrace_entry, TRACE_FN); \
  232. IF_ASSIGN(var, ent, struct ctx_switch_entry, 0); \
  233. IF_ASSIGN(var, ent, struct stack_entry, TRACE_STACK); \
  234. IF_ASSIGN(var, ent, struct userstack_entry, TRACE_USER_STACK);\
  235. IF_ASSIGN(var, ent, struct print_entry, TRACE_PRINT); \
  236. IF_ASSIGN(var, ent, struct bprint_entry, TRACE_BPRINT); \
  237. IF_ASSIGN(var, ent, struct bputs_entry, TRACE_BPUTS); \
  238. IF_ASSIGN(var, ent, struct trace_mmiotrace_rw, \
  239. TRACE_MMIO_RW); \
  240. IF_ASSIGN(var, ent, struct trace_mmiotrace_map, \
  241. TRACE_MMIO_MAP); \
  242. IF_ASSIGN(var, ent, struct trace_branch, TRACE_BRANCH); \
  243. IF_ASSIGN(var, ent, struct ftrace_graph_ent_entry, \
  244. TRACE_GRAPH_ENT); \
  245. IF_ASSIGN(var, ent, struct ftrace_graph_ret_entry, \
  246. TRACE_GRAPH_RET); \
  247. __ftrace_bad_type(); \
  248. } while (0)
  249. /*
  250. * An option specific to a tracer. This is a boolean value.
  251. * The bit is the bit index that sets its value on the
  252. * flags value in struct tracer_flags.
  253. */
  254. struct tracer_opt {
  255. const char *name; /* Will appear on the trace_options file */
  256. u32 bit; /* Mask assigned in val field in tracer_flags */
  257. };
  258. /*
  259. * The set of specific options for a tracer. Your tracer
  260. * have to set the initial value of the flags val.
  261. */
  262. struct tracer_flags {
  263. u32 val;
  264. struct tracer_opt *opts;
  265. };
  266. /* Makes more easy to define a tracer opt */
  267. #define TRACER_OPT(s, b) .name = #s, .bit = b
  268. /**
  269. * struct tracer - a specific tracer and its callbacks to interact with debugfs
  270. * @name: the name chosen to select it on the available_tracers file
  271. * @init: called when one switches to this tracer (echo name > current_tracer)
  272. * @reset: called when one switches to another tracer
  273. * @start: called when tracing is unpaused (echo 1 > tracing_enabled)
  274. * @stop: called when tracing is paused (echo 0 > tracing_enabled)
  275. * @open: called when the trace file is opened
  276. * @pipe_open: called when the trace_pipe file is opened
  277. * @wait_pipe: override how the user waits for traces on trace_pipe
  278. * @close: called when the trace file is released
  279. * @pipe_close: called when the trace_pipe file is released
  280. * @read: override the default read callback on trace_pipe
  281. * @splice_read: override the default splice_read callback on trace_pipe
  282. * @selftest: selftest to run on boot (see trace_selftest.c)
  283. * @print_headers: override the first lines that describe your columns
  284. * @print_line: callback that prints a trace
  285. * @set_flag: signals one of your private flags changed (trace_options file)
  286. * @flags: your private flags
  287. */
  288. struct tracer {
  289. const char *name;
  290. int (*init)(struct trace_array *tr);
  291. void (*reset)(struct trace_array *tr);
  292. void (*start)(struct trace_array *tr);
  293. void (*stop)(struct trace_array *tr);
  294. void (*open)(struct trace_iterator *iter);
  295. void (*pipe_open)(struct trace_iterator *iter);
  296. void (*wait_pipe)(struct trace_iterator *iter);
  297. void (*close)(struct trace_iterator *iter);
  298. void (*pipe_close)(struct trace_iterator *iter);
  299. ssize_t (*read)(struct trace_iterator *iter,
  300. struct file *filp, char __user *ubuf,
  301. size_t cnt, loff_t *ppos);
  302. ssize_t (*splice_read)(struct trace_iterator *iter,
  303. struct file *filp,
  304. loff_t *ppos,
  305. struct pipe_inode_info *pipe,
  306. size_t len,
  307. unsigned int flags);
  308. #ifdef CONFIG_FTRACE_STARTUP_TEST
  309. int (*selftest)(struct tracer *trace,
  310. struct trace_array *tr);
  311. #endif
  312. void (*print_header)(struct seq_file *m);
  313. enum print_line_t (*print_line)(struct trace_iterator *iter);
  314. /* If you handled the flag setting, return 0 */
  315. int (*set_flag)(u32 old_flags, u32 bit, int set);
  316. /* Return 0 if OK with change, else return non-zero */
  317. int (*flag_changed)(struct tracer *tracer,
  318. u32 mask, int set);
  319. struct tracer *next;
  320. struct tracer_flags *flags;
  321. bool print_max;
  322. bool enabled;
  323. #ifdef CONFIG_TRACER_MAX_TRACE
  324. bool use_max_tr;
  325. #endif
  326. };
  327. /* Only current can touch trace_recursion */
  328. /*
  329. * For function tracing recursion:
  330. * The order of these bits are important.
  331. *
  332. * When function tracing occurs, the following steps are made:
  333. * If arch does not support a ftrace feature:
  334. * call internal function (uses INTERNAL bits) which calls...
  335. * If callback is registered to the "global" list, the list
  336. * function is called and recursion checks the GLOBAL bits.
  337. * then this function calls...
  338. * The function callback, which can use the FTRACE bits to
  339. * check for recursion.
  340. *
  341. * Now if the arch does not suppport a feature, and it calls
  342. * the global list function which calls the ftrace callback
  343. * all three of these steps will do a recursion protection.
  344. * There's no reason to do one if the previous caller already
  345. * did. The recursion that we are protecting against will
  346. * go through the same steps again.
  347. *
  348. * To prevent the multiple recursion checks, if a recursion
  349. * bit is set that is higher than the MAX bit of the current
  350. * check, then we know that the check was made by the previous
  351. * caller, and we can skip the current check.
  352. */
  353. enum {
  354. TRACE_BUFFER_BIT,
  355. TRACE_BUFFER_NMI_BIT,
  356. TRACE_BUFFER_IRQ_BIT,
  357. TRACE_BUFFER_SIRQ_BIT,
  358. /* Start of function recursion bits */
  359. TRACE_FTRACE_BIT,
  360. TRACE_FTRACE_NMI_BIT,
  361. TRACE_FTRACE_IRQ_BIT,
  362. TRACE_FTRACE_SIRQ_BIT,
  363. /* GLOBAL_BITs must be greater than FTRACE_BITs */
  364. TRACE_GLOBAL_BIT,
  365. TRACE_GLOBAL_NMI_BIT,
  366. TRACE_GLOBAL_IRQ_BIT,
  367. TRACE_GLOBAL_SIRQ_BIT,
  368. /* INTERNAL_BITs must be greater than GLOBAL_BITs */
  369. TRACE_INTERNAL_BIT,
  370. TRACE_INTERNAL_NMI_BIT,
  371. TRACE_INTERNAL_IRQ_BIT,
  372. TRACE_INTERNAL_SIRQ_BIT,
  373. TRACE_CONTROL_BIT,
  374. /*
  375. * Abuse of the trace_recursion.
  376. * As we need a way to maintain state if we are tracing the function
  377. * graph in irq because we want to trace a particular function that
  378. * was called in irq context but we have irq tracing off. Since this
  379. * can only be modified by current, we can reuse trace_recursion.
  380. */
  381. TRACE_IRQ_BIT,
  382. };
  383. #define trace_recursion_set(bit) do { (current)->trace_recursion |= (1<<(bit)); } while (0)
  384. #define trace_recursion_clear(bit) do { (current)->trace_recursion &= ~(1<<(bit)); } while (0)
  385. #define trace_recursion_test(bit) ((current)->trace_recursion & (1<<(bit)))
  386. #define TRACE_CONTEXT_BITS 4
  387. #define TRACE_FTRACE_START TRACE_FTRACE_BIT
  388. #define TRACE_FTRACE_MAX ((1 << (TRACE_FTRACE_START + TRACE_CONTEXT_BITS)) - 1)
  389. #define TRACE_GLOBAL_START TRACE_GLOBAL_BIT
  390. #define TRACE_GLOBAL_MAX ((1 << (TRACE_GLOBAL_START + TRACE_CONTEXT_BITS)) - 1)
  391. #define TRACE_LIST_START TRACE_INTERNAL_BIT
  392. #define TRACE_LIST_MAX ((1 << (TRACE_LIST_START + TRACE_CONTEXT_BITS)) - 1)
  393. #define TRACE_CONTEXT_MASK TRACE_LIST_MAX
  394. static __always_inline int trace_get_context_bit(void)
  395. {
  396. int bit;
  397. if (in_interrupt()) {
  398. if (in_nmi())
  399. bit = 0;
  400. else if (in_irq())
  401. bit = 1;
  402. else
  403. bit = 2;
  404. } else
  405. bit = 3;
  406. return bit;
  407. }
  408. static __always_inline int trace_test_and_set_recursion(int start, int max)
  409. {
  410. unsigned int val = current->trace_recursion;
  411. int bit;
  412. /* A previous recursion check was made */
  413. if ((val & TRACE_CONTEXT_MASK) > max)
  414. return 0;
  415. bit = trace_get_context_bit() + start;
  416. if (unlikely(val & (1 << bit)))
  417. return -1;
  418. val |= 1 << bit;
  419. current->trace_recursion = val;
  420. barrier();
  421. return bit;
  422. }
  423. static __always_inline void trace_clear_recursion(int bit)
  424. {
  425. unsigned int val = current->trace_recursion;
  426. if (!bit)
  427. return;
  428. bit = 1 << bit;
  429. val &= ~bit;
  430. barrier();
  431. current->trace_recursion = val;
  432. }
  433. static inline struct ring_buffer_iter *
  434. trace_buffer_iter(struct trace_iterator *iter, int cpu)
  435. {
  436. if (iter->buffer_iter && iter->buffer_iter[cpu])
  437. return iter->buffer_iter[cpu];
  438. return NULL;
  439. }
  440. int tracer_init(struct tracer *t, struct trace_array *tr);
  441. int tracing_is_enabled(void);
  442. void tracing_reset(struct trace_buffer *buf, int cpu);
  443. void tracing_reset_online_cpus(struct trace_buffer *buf);
  444. void tracing_reset_current(int cpu);
  445. void tracing_reset_all_online_cpus(void);
  446. int tracing_open_generic(struct inode *inode, struct file *filp);
  447. struct dentry *trace_create_file(const char *name,
  448. umode_t mode,
  449. struct dentry *parent,
  450. void *data,
  451. const struct file_operations *fops);
  452. struct dentry *tracing_init_dentry_tr(struct trace_array *tr);
  453. struct dentry *tracing_init_dentry(void);
  454. struct ring_buffer_event;
  455. struct ring_buffer_event *
  456. trace_buffer_lock_reserve(struct ring_buffer *buffer,
  457. int type,
  458. unsigned long len,
  459. unsigned long flags,
  460. int pc);
  461. struct trace_entry *tracing_get_trace_entry(struct trace_array *tr,
  462. struct trace_array_cpu *data);
  463. struct trace_entry *trace_find_next_entry(struct trace_iterator *iter,
  464. int *ent_cpu, u64 *ent_ts);
  465. void __buffer_unlock_commit(struct ring_buffer *buffer,
  466. struct ring_buffer_event *event);
  467. int trace_empty(struct trace_iterator *iter);
  468. void *trace_find_next_entry_inc(struct trace_iterator *iter);
  469. void trace_init_global_iter(struct trace_iterator *iter);
  470. void tracing_iter_reset(struct trace_iterator *iter, int cpu);
  471. void poll_wait_pipe(struct trace_iterator *iter);
  472. void ftrace(struct trace_array *tr,
  473. struct trace_array_cpu *data,
  474. unsigned long ip,
  475. unsigned long parent_ip,
  476. unsigned long flags, int pc);
  477. void tracing_sched_switch_trace(struct trace_array *tr,
  478. struct task_struct *prev,
  479. struct task_struct *next,
  480. unsigned long flags, int pc);
  481. void tracing_sched_wakeup_trace(struct trace_array *tr,
  482. struct task_struct *wakee,
  483. struct task_struct *cur,
  484. unsigned long flags, int pc);
  485. void trace_function(struct trace_array *tr,
  486. unsigned long ip,
  487. unsigned long parent_ip,
  488. unsigned long flags, int pc);
  489. void trace_graph_function(struct trace_array *tr,
  490. unsigned long ip,
  491. unsigned long parent_ip,
  492. unsigned long flags, int pc);
  493. void trace_latency_header(struct seq_file *m);
  494. void trace_default_header(struct seq_file *m);
  495. void print_trace_header(struct seq_file *m, struct trace_iterator *iter);
  496. int trace_empty(struct trace_iterator *iter);
  497. void trace_graph_return(struct ftrace_graph_ret *trace);
  498. int trace_graph_entry(struct ftrace_graph_ent *trace);
  499. void set_graph_array(struct trace_array *tr);
  500. void tracing_start_cmdline_record(void);
  501. void tracing_stop_cmdline_record(void);
  502. void tracing_sched_switch_assign_trace(struct trace_array *tr);
  503. void tracing_stop_sched_switch_record(void);
  504. void tracing_start_sched_switch_record(void);
  505. int register_tracer(struct tracer *type);
  506. int is_tracing_stopped(void);
  507. extern cpumask_var_t __read_mostly tracing_buffer_mask;
  508. #define for_each_tracing_cpu(cpu) \
  509. for_each_cpu(cpu, tracing_buffer_mask)
  510. extern unsigned long nsecs_to_usecs(unsigned long nsecs);
  511. extern unsigned long tracing_thresh;
  512. #ifdef CONFIG_TRACER_MAX_TRACE
  513. extern unsigned long tracing_max_latency;
  514. void update_max_tr(struct trace_array *tr, struct task_struct *tsk, int cpu);
  515. void update_max_tr_single(struct trace_array *tr,
  516. struct task_struct *tsk, int cpu);
  517. #endif /* CONFIG_TRACER_MAX_TRACE */
  518. #ifdef CONFIG_STACKTRACE
  519. void ftrace_trace_stack(struct ring_buffer *buffer, unsigned long flags,
  520. int skip, int pc);
  521. void ftrace_trace_stack_regs(struct ring_buffer *buffer, unsigned long flags,
  522. int skip, int pc, struct pt_regs *regs);
  523. void ftrace_trace_userstack(struct ring_buffer *buffer, unsigned long flags,
  524. int pc);
  525. void __trace_stack(struct trace_array *tr, unsigned long flags, int skip,
  526. int pc);
  527. #else
  528. static inline void ftrace_trace_stack(struct ring_buffer *buffer,
  529. unsigned long flags, int skip, int pc)
  530. {
  531. }
  532. static inline void ftrace_trace_stack_regs(struct ring_buffer *buffer,
  533. unsigned long flags, int skip,
  534. int pc, struct pt_regs *regs)
  535. {
  536. }
  537. static inline void ftrace_trace_userstack(struct ring_buffer *buffer,
  538. unsigned long flags, int pc)
  539. {
  540. }
  541. static inline void __trace_stack(struct trace_array *tr, unsigned long flags,
  542. int skip, int pc)
  543. {
  544. }
  545. #endif /* CONFIG_STACKTRACE */
  546. extern cycle_t ftrace_now(int cpu);
  547. extern void trace_find_cmdline(int pid, char comm[]);
  548. #ifdef CONFIG_DYNAMIC_FTRACE
  549. extern unsigned long ftrace_update_tot_cnt;
  550. #endif
  551. #define DYN_FTRACE_TEST_NAME trace_selftest_dynamic_test_func
  552. extern int DYN_FTRACE_TEST_NAME(void);
  553. #define DYN_FTRACE_TEST_NAME2 trace_selftest_dynamic_test_func2
  554. extern int DYN_FTRACE_TEST_NAME2(void);
  555. extern bool ring_buffer_expanded;
  556. extern bool tracing_selftest_disabled;
  557. DECLARE_PER_CPU(int, ftrace_cpu_disabled);
  558. #ifdef CONFIG_FTRACE_STARTUP_TEST
  559. extern int trace_selftest_startup_function(struct tracer *trace,
  560. struct trace_array *tr);
  561. extern int trace_selftest_startup_function_graph(struct tracer *trace,
  562. struct trace_array *tr);
  563. extern int trace_selftest_startup_irqsoff(struct tracer *trace,
  564. struct trace_array *tr);
  565. extern int trace_selftest_startup_preemptoff(struct tracer *trace,
  566. struct trace_array *tr);
  567. extern int trace_selftest_startup_preemptirqsoff(struct tracer *trace,
  568. struct trace_array *tr);
  569. extern int trace_selftest_startup_wakeup(struct tracer *trace,
  570. struct trace_array *tr);
  571. extern int trace_selftest_startup_nop(struct tracer *trace,
  572. struct trace_array *tr);
  573. extern int trace_selftest_startup_sched_switch(struct tracer *trace,
  574. struct trace_array *tr);
  575. extern int trace_selftest_startup_branch(struct tracer *trace,
  576. struct trace_array *tr);
  577. #endif /* CONFIG_FTRACE_STARTUP_TEST */
  578. extern void *head_page(struct trace_array_cpu *data);
  579. extern unsigned long long ns2usecs(cycle_t nsec);
  580. extern int
  581. trace_vbprintk(unsigned long ip, const char *fmt, va_list args);
  582. extern int
  583. trace_vprintk(unsigned long ip, const char *fmt, va_list args);
  584. extern int
  585. trace_array_vprintk(struct trace_array *tr,
  586. unsigned long ip, const char *fmt, va_list args);
  587. int trace_array_printk(struct trace_array *tr,
  588. unsigned long ip, const char *fmt, ...);
  589. int trace_array_printk_buf(struct ring_buffer *buffer,
  590. unsigned long ip, const char *fmt, ...);
  591. void trace_printk_seq(struct trace_seq *s);
  592. enum print_line_t print_trace_line(struct trace_iterator *iter);
  593. extern unsigned long trace_flags;
  594. /* Standard output formatting function used for function return traces */
  595. #ifdef CONFIG_FUNCTION_GRAPH_TRACER
  596. /* Flag options */
  597. #define TRACE_GRAPH_PRINT_OVERRUN 0x1
  598. #define TRACE_GRAPH_PRINT_CPU 0x2
  599. #define TRACE_GRAPH_PRINT_OVERHEAD 0x4
  600. #define TRACE_GRAPH_PRINT_PROC 0x8
  601. #define TRACE_GRAPH_PRINT_DURATION 0x10
  602. #define TRACE_GRAPH_PRINT_ABS_TIME 0x20
  603. extern enum print_line_t
  604. print_graph_function_flags(struct trace_iterator *iter, u32 flags);
  605. extern void print_graph_headers_flags(struct seq_file *s, u32 flags);
  606. extern enum print_line_t
  607. trace_print_graph_duration(unsigned long long duration, struct trace_seq *s);
  608. extern void graph_trace_open(struct trace_iterator *iter);
  609. extern void graph_trace_close(struct trace_iterator *iter);
  610. extern int __trace_graph_entry(struct trace_array *tr,
  611. struct ftrace_graph_ent *trace,
  612. unsigned long flags, int pc);
  613. extern void __trace_graph_return(struct trace_array *tr,
  614. struct ftrace_graph_ret *trace,
  615. unsigned long flags, int pc);
  616. #ifdef CONFIG_DYNAMIC_FTRACE
  617. /* TODO: make this variable */
  618. #define FTRACE_GRAPH_MAX_FUNCS 32
  619. extern int ftrace_graph_filter_enabled;
  620. extern int ftrace_graph_count;
  621. extern unsigned long ftrace_graph_funcs[FTRACE_GRAPH_MAX_FUNCS];
  622. static inline int ftrace_graph_addr(unsigned long addr)
  623. {
  624. int i;
  625. if (!ftrace_graph_filter_enabled)
  626. return 1;
  627. for (i = 0; i < ftrace_graph_count; i++) {
  628. if (addr == ftrace_graph_funcs[i]) {
  629. /*
  630. * If no irqs are to be traced, but a set_graph_function
  631. * is set, and called by an interrupt handler, we still
  632. * want to trace it.
  633. */
  634. if (in_irq())
  635. trace_recursion_set(TRACE_IRQ_BIT);
  636. else
  637. trace_recursion_clear(TRACE_IRQ_BIT);
  638. return 1;
  639. }
  640. }
  641. return 0;
  642. }
  643. #else
  644. static inline int ftrace_graph_addr(unsigned long addr)
  645. {
  646. return 1;
  647. }
  648. #endif /* CONFIG_DYNAMIC_FTRACE */
  649. #else /* CONFIG_FUNCTION_GRAPH_TRACER */
  650. static inline enum print_line_t
  651. print_graph_function_flags(struct trace_iterator *iter, u32 flags)
  652. {
  653. return TRACE_TYPE_UNHANDLED;
  654. }
  655. #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
  656. extern struct list_head ftrace_pids;
  657. #ifdef CONFIG_FUNCTION_TRACER
  658. static inline int ftrace_trace_task(struct task_struct *task)
  659. {
  660. if (list_empty(&ftrace_pids))
  661. return 1;
  662. return test_tsk_trace_trace(task);
  663. }
  664. extern int ftrace_is_dead(void);
  665. #else
  666. static inline int ftrace_trace_task(struct task_struct *task)
  667. {
  668. return 1;
  669. }
  670. static inline int ftrace_is_dead(void) { return 0; }
  671. #endif
  672. int ftrace_event_is_function(struct ftrace_event_call *call);
  673. /*
  674. * struct trace_parser - servers for reading the user input separated by spaces
  675. * @cont: set if the input is not complete - no final space char was found
  676. * @buffer: holds the parsed user input
  677. * @idx: user input length
  678. * @size: buffer size
  679. */
  680. struct trace_parser {
  681. bool cont;
  682. char *buffer;
  683. unsigned idx;
  684. unsigned size;
  685. };
  686. static inline bool trace_parser_loaded(struct trace_parser *parser)
  687. {
  688. return (parser->idx != 0);
  689. }
  690. static inline bool trace_parser_cont(struct trace_parser *parser)
  691. {
  692. return parser->cont;
  693. }
  694. static inline void trace_parser_clear(struct trace_parser *parser)
  695. {
  696. parser->cont = false;
  697. parser->idx = 0;
  698. }
  699. extern int trace_parser_get_init(struct trace_parser *parser, int size);
  700. extern void trace_parser_put(struct trace_parser *parser);
  701. extern int trace_get_user(struct trace_parser *parser, const char __user *ubuf,
  702. size_t cnt, loff_t *ppos);
  703. /*
  704. * trace_iterator_flags is an enumeration that defines bit
  705. * positions into trace_flags that controls the output.
  706. *
  707. * NOTE: These bits must match the trace_options array in
  708. * trace.c.
  709. */
  710. enum trace_iterator_flags {
  711. TRACE_ITER_PRINT_PARENT = 0x01,
  712. TRACE_ITER_SYM_OFFSET = 0x02,
  713. TRACE_ITER_SYM_ADDR = 0x04,
  714. TRACE_ITER_VERBOSE = 0x08,
  715. TRACE_ITER_RAW = 0x10,
  716. TRACE_ITER_HEX = 0x20,
  717. TRACE_ITER_BIN = 0x40,
  718. TRACE_ITER_BLOCK = 0x80,
  719. TRACE_ITER_STACKTRACE = 0x100,
  720. TRACE_ITER_PRINTK = 0x200,
  721. TRACE_ITER_PREEMPTONLY = 0x400,
  722. TRACE_ITER_BRANCH = 0x800,
  723. TRACE_ITER_ANNOTATE = 0x1000,
  724. TRACE_ITER_USERSTACKTRACE = 0x2000,
  725. TRACE_ITER_SYM_USEROBJ = 0x4000,
  726. TRACE_ITER_PRINTK_MSGONLY = 0x8000,
  727. TRACE_ITER_CONTEXT_INFO = 0x10000, /* Print pid/cpu/time */
  728. TRACE_ITER_LATENCY_FMT = 0x20000,
  729. TRACE_ITER_SLEEP_TIME = 0x40000,
  730. TRACE_ITER_GRAPH_TIME = 0x80000,
  731. TRACE_ITER_RECORD_CMD = 0x100000,
  732. TRACE_ITER_OVERWRITE = 0x200000,
  733. TRACE_ITER_STOP_ON_FREE = 0x400000,
  734. TRACE_ITER_IRQ_INFO = 0x800000,
  735. TRACE_ITER_MARKERS = 0x1000000,
  736. TRACE_ITER_FUNCTION = 0x2000000,
  737. };
  738. /*
  739. * TRACE_ITER_SYM_MASK masks the options in trace_flags that
  740. * control the output of kernel symbols.
  741. */
  742. #define TRACE_ITER_SYM_MASK \
  743. (TRACE_ITER_PRINT_PARENT|TRACE_ITER_SYM_OFFSET|TRACE_ITER_SYM_ADDR)
  744. extern struct tracer nop_trace;
  745. #ifdef CONFIG_BRANCH_TRACER
  746. extern int enable_branch_tracing(struct trace_array *tr);
  747. extern void disable_branch_tracing(void);
  748. static inline int trace_branch_enable(struct trace_array *tr)
  749. {
  750. if (trace_flags & TRACE_ITER_BRANCH)
  751. return enable_branch_tracing(tr);
  752. return 0;
  753. }
  754. static inline void trace_branch_disable(void)
  755. {
  756. /* due to races, always disable */
  757. disable_branch_tracing();
  758. }
  759. #else
  760. static inline int trace_branch_enable(struct trace_array *tr)
  761. {
  762. return 0;
  763. }
  764. static inline void trace_branch_disable(void)
  765. {
  766. }
  767. #endif /* CONFIG_BRANCH_TRACER */
  768. /* set ring buffers to default size if not already done so */
  769. int tracing_update_buffers(void);
  770. /* trace event type bit fields, not numeric */
  771. enum {
  772. TRACE_EVENT_TYPE_PRINTF = 1,
  773. TRACE_EVENT_TYPE_RAW = 2,
  774. };
  775. struct ftrace_event_field {
  776. struct list_head link;
  777. const char *name;
  778. const char *type;
  779. int filter_type;
  780. int offset;
  781. int size;
  782. int is_signed;
  783. };
  784. struct event_filter {
  785. int n_preds; /* Number assigned */
  786. int a_preds; /* allocated */
  787. struct filter_pred *preds;
  788. struct filter_pred *root;
  789. char *filter_string;
  790. };
  791. struct event_subsystem {
  792. struct list_head list;
  793. const char *name;
  794. struct event_filter *filter;
  795. int ref_count;
  796. };
  797. struct ftrace_subsystem_dir {
  798. struct list_head list;
  799. struct event_subsystem *subsystem;
  800. struct trace_array *tr;
  801. struct dentry *entry;
  802. int ref_count;
  803. int nr_events;
  804. };
  805. #define FILTER_PRED_INVALID ((unsigned short)-1)
  806. #define FILTER_PRED_IS_RIGHT (1 << 15)
  807. #define FILTER_PRED_FOLD (1 << 15)
  808. /*
  809. * The max preds is the size of unsigned short with
  810. * two flags at the MSBs. One bit is used for both the IS_RIGHT
  811. * and FOLD flags. The other is reserved.
  812. *
  813. * 2^14 preds is way more than enough.
  814. */
  815. #define MAX_FILTER_PRED 16384
  816. struct filter_pred;
  817. struct regex;
  818. typedef int (*filter_pred_fn_t) (struct filter_pred *pred, void *event);
  819. typedef int (*regex_match_func)(char *str, struct regex *r, int len);
  820. enum regex_type {
  821. MATCH_FULL = 0,
  822. MATCH_FRONT_ONLY,
  823. MATCH_MIDDLE_ONLY,
  824. MATCH_END_ONLY,
  825. };
  826. struct regex {
  827. char pattern[MAX_FILTER_STR_VAL];
  828. int len;
  829. int field_len;
  830. regex_match_func match;
  831. };
  832. struct filter_pred {
  833. filter_pred_fn_t fn;
  834. u64 val;
  835. struct regex regex;
  836. unsigned short *ops;
  837. struct ftrace_event_field *field;
  838. int offset;
  839. int not;
  840. int op;
  841. unsigned short index;
  842. unsigned short parent;
  843. unsigned short left;
  844. unsigned short right;
  845. };
  846. extern enum regex_type
  847. filter_parse_regex(char *buff, int len, char **search, int *not);
  848. extern void print_event_filter(struct ftrace_event_call *call,
  849. struct trace_seq *s);
  850. extern int apply_event_filter(struct ftrace_event_call *call,
  851. char *filter_string);
  852. extern int apply_subsystem_event_filter(struct ftrace_subsystem_dir *dir,
  853. char *filter_string);
  854. extern void print_subsystem_event_filter(struct event_subsystem *system,
  855. struct trace_seq *s);
  856. extern int filter_assign_type(const char *type);
  857. struct ftrace_event_field *
  858. trace_find_event_field(struct ftrace_event_call *call, char *name);
  859. static inline int
  860. filter_check_discard(struct ftrace_event_call *call, void *rec,
  861. struct ring_buffer *buffer,
  862. struct ring_buffer_event *event)
  863. {
  864. if (unlikely(call->flags & TRACE_EVENT_FL_FILTERED) &&
  865. !filter_match_preds(call->filter, rec)) {
  866. ring_buffer_discard_commit(buffer, event);
  867. return 1;
  868. }
  869. return 0;
  870. }
  871. extern void trace_event_enable_cmd_record(bool enable);
  872. extern int event_trace_add_tracer(struct dentry *parent, struct trace_array *tr);
  873. extern int event_trace_del_tracer(struct trace_array *tr);
  874. extern struct mutex event_mutex;
  875. extern struct list_head ftrace_events;
  876. extern const char *__start___trace_bprintk_fmt[];
  877. extern const char *__stop___trace_bprintk_fmt[];
  878. void trace_printk_init_buffers(void);
  879. void trace_printk_start_comm(void);
  880. int trace_keep_overwrite(struct tracer *tracer, u32 mask, int set);
  881. int set_tracer_flag(struct trace_array *tr, unsigned int mask, int enabled);
  882. /*
  883. * Normal trace_printk() and friends allocates special buffers
  884. * to do the manipulation, as well as saves the print formats
  885. * into sections to display. But the trace infrastructure wants
  886. * to use these without the added overhead at the price of being
  887. * a bit slower (used mainly for warnings, where we don't care
  888. * about performance). The internal_trace_puts() is for such
  889. * a purpose.
  890. */
  891. #define internal_trace_puts(str) __trace_puts(_THIS_IP_, str, strlen(str))
  892. #undef FTRACE_ENTRY
  893. #define FTRACE_ENTRY(call, struct_name, id, tstruct, print, filter) \
  894. extern struct ftrace_event_call \
  895. __attribute__((__aligned__(4))) event_##call;
  896. #undef FTRACE_ENTRY_DUP
  897. #define FTRACE_ENTRY_DUP(call, struct_name, id, tstruct, print, filter) \
  898. FTRACE_ENTRY(call, struct_name, id, PARAMS(tstruct), PARAMS(print), \
  899. filter)
  900. #include "trace_entries.h"
  901. #if defined(CONFIG_PERF_EVENTS) && defined(CONFIG_FUNCTION_TRACER)
  902. int perf_ftrace_event_register(struct ftrace_event_call *call,
  903. enum trace_reg type, void *data);
  904. #else
  905. #define perf_ftrace_event_register NULL
  906. #endif
  907. #endif /* _LINUX_KERNEL_TRACE_H */