1 // SPDX-License-Identifier: GPL-2.0
4 * Tracing kernel boot-time
7 #define pr_fmt(fmt) "trace_boot: " fmt
9 #include <linux/bootconfig.h>
10 #include <linux/cpumask.h>
11 #include <linux/ftrace.h>
12 #include <linux/init.h>
13 #include <linux/kernel.h>
14 #include <linux/mutex.h>
15 #include <linux/string.h>
16 #include <linux/slab.h>
17 #include <linux/trace.h>
18 #include <linux/trace_events.h>
22 #define MAX_BUF_LEN 256
25 trace_boot_set_instance_options(struct trace_array *tr, struct xbc_node *node)
27 struct xbc_node *anode;
29 char buf[MAX_BUF_LEN];
32 /* Common ftrace options */
33 xbc_node_for_each_array_value(node, "options", anode, p) {
34 if (strlcpy(buf, p, ARRAY_SIZE(buf)) >= ARRAY_SIZE(buf)) {
35 pr_err("String is too long: %s\n", p);
39 if (trace_set_options(tr, buf) < 0)
40 pr_err("Failed to set option: %s\n", buf);
43 p = xbc_node_find_value(node, "tracing_on", NULL);
44 if (p && *p != '\0') {
45 if (kstrtoul(p, 10, &v))
46 pr_err("Failed to set tracing on: %s\n", p);
48 tracer_tracing_on(tr);
50 tracer_tracing_off(tr);
53 p = xbc_node_find_value(node, "trace_clock", NULL);
54 if (p && *p != '\0') {
55 if (tracing_set_clock(tr, p) < 0)
56 pr_err("Failed to set trace clock: %s\n", p);
59 p = xbc_node_find_value(node, "buffer_size", NULL);
60 if (p && *p != '\0') {
61 v = memparse(p, NULL);
63 pr_err("Buffer size is too small: %s\n", p);
64 if (tracing_resize_ring_buffer(tr, v, RING_BUFFER_ALL_CPUS) < 0)
65 pr_err("Failed to resize trace buffer to %s\n", p);
68 p = xbc_node_find_value(node, "cpumask", NULL);
69 if (p && *p != '\0') {
70 cpumask_var_t new_mask;
72 if (alloc_cpumask_var(&new_mask, GFP_KERNEL)) {
73 if (cpumask_parse(p, new_mask) < 0 ||
74 tracing_set_cpumask(tr, new_mask) < 0)
75 pr_err("Failed to set new CPU mask %s\n", p);
76 free_cpumask_var(new_mask);
81 #ifdef CONFIG_EVENT_TRACING
83 trace_boot_enable_events(struct trace_array *tr, struct xbc_node *node)
85 struct xbc_node *anode;
86 char buf[MAX_BUF_LEN];
89 xbc_node_for_each_array_value(node, "events", anode, p) {
90 if (strlcpy(buf, p, ARRAY_SIZE(buf)) >= ARRAY_SIZE(buf)) {
91 pr_err("String is too long: %s\n", p);
95 if (ftrace_set_clr_event(tr, buf, 1) < 0)
96 pr_err("Failed to enable event: %s\n", p);
100 #ifdef CONFIG_KPROBE_EVENTS
102 trace_boot_add_kprobe_event(struct xbc_node *node, const char *event)
104 struct dynevent_cmd cmd;
105 struct xbc_node *anode;
106 char buf[MAX_BUF_LEN];
110 xbc_node_for_each_array_value(node, "probes", anode, val) {
111 kprobe_event_cmd_init(&cmd, buf, MAX_BUF_LEN);
113 ret = kprobe_event_gen_cmd_start(&cmd, event, val);
115 pr_err("Failed to generate probe: %s\n", buf);
119 ret = kprobe_event_gen_cmd_end(&cmd);
121 pr_err("Failed to add probe: %s\n", buf);
129 static inline int __init
130 trace_boot_add_kprobe_event(struct xbc_node *node, const char *event)
132 pr_err("Kprobe event is not supported.\n");
137 #ifdef CONFIG_SYNTH_EVENTS
139 trace_boot_add_synth_event(struct xbc_node *node, const char *event)
141 struct dynevent_cmd cmd;
142 struct xbc_node *anode;
143 char buf[MAX_BUF_LEN];
147 synth_event_cmd_init(&cmd, buf, MAX_BUF_LEN);
149 ret = synth_event_gen_cmd_start(&cmd, event, NULL);
153 xbc_node_for_each_array_value(node, "fields", anode, p) {
154 ret = synth_event_add_field_str(&cmd, p);
159 ret = synth_event_gen_cmd_end(&cmd);
161 pr_err("Failed to add synthetic event: %s\n", buf);
166 static inline int __init
167 trace_boot_add_synth_event(struct xbc_node *node, const char *event)
169 pr_err("Synthetic event is not supported.\n");
174 #ifdef CONFIG_HIST_TRIGGERS
175 static int __init __printf(3, 4)
176 append_printf(char **bufp, char *end, const char *fmt, ...)
185 ret = vsnprintf(*bufp, end - *bufp, fmt, args);
186 if (ret < end - *bufp) {
198 append_str_nospace(char **bufp, char *end, const char *str)
203 while (p < end - 1 && *str != '\0') {
219 trace_boot_hist_add_array(struct xbc_node *hnode, char **bufp,
220 char *end, const char *key)
222 struct xbc_node *knode, *anode;
226 knode = xbc_node_find_child(hnode, key);
228 anode = xbc_node_get_child(knode);
230 pr_err("hist.%s requires value(s).\n", key);
234 append_printf(bufp, end, ":%s", key);
236 xbc_array_for_each_value(anode, p) {
237 append_printf(bufp, end, "%c%s", sep, p);
248 trace_boot_hist_add_one_handler(struct xbc_node *hnode, char **bufp,
249 char *end, const char *handler,
252 struct xbc_node *knode, *anode;
256 /* Compose 'handler' parameter */
257 p = xbc_node_find_value(hnode, param, NULL);
259 pr_err("hist.%s requires '%s' option.\n",
260 xbc_node_get_data(hnode), param);
263 append_printf(bufp, end, ":%s(%s)", handler, p);
265 /* Compose 'action' parameter */
266 knode = xbc_node_find_child(hnode, "trace");
268 knode = xbc_node_find_child(hnode, "save");
271 anode = xbc_node_get_child(knode);
272 if (!anode || !xbc_node_is_value(anode)) {
273 pr_err("hist.%s.%s requires value(s).\n",
274 xbc_node_get_data(hnode),
275 xbc_node_get_data(knode));
279 append_printf(bufp, end, ".%s", xbc_node_get_data(knode));
281 xbc_array_for_each_value(anode, p) {
282 append_printf(bufp, end, "%c%s", sep, p);
286 append_printf(bufp, end, ")");
287 } else if (xbc_node_find_child(hnode, "snapshot")) {
288 append_printf(bufp, end, ".snapshot()");
290 pr_err("hist.%s requires an action.\n",
291 xbc_node_get_data(hnode));
299 trace_boot_hist_add_handlers(struct xbc_node *hnode, char **bufp,
300 char *end, const char *param)
302 struct xbc_node *node;
303 const char *p, *handler;
306 handler = xbc_node_get_data(hnode);
308 xbc_node_for_each_subkey(hnode, node) {
309 p = xbc_node_get_data(node);
312 /* All digit started node should be instances. */
313 ret = trace_boot_hist_add_one_handler(node, bufp, end, handler, param);
318 if (xbc_node_find_child(hnode, param))
319 ret = trace_boot_hist_add_one_handler(hnode, bufp, end, handler, param);
325 * Histogram boottime tracing syntax.
327 * ftrace.[instance.INSTANCE.]event.GROUP.EVENT.hist[.N] {
329 * values = <VAL>[,...]
330 * sort = <SORT-KEY>[,...]
333 * var { <VAR> = <EXPR> ... }
334 * pause|continue|clear
335 * onmax|onchange[.N] { var = <VAR>; <ACTION> [= <PARAM>] }
336 * onmatch[.N] { event = <EVENT>; <ACTION> [= <PARAM>] }
340 * Where <ACTION> are;
342 * trace = <EVENT>, <ARG1>[, ...]
343 * save = <ARG1>[, ...]
347 trace_boot_compose_hist_cmd(struct xbc_node *hnode, char *buf, size_t size)
349 struct xbc_node *node, *knode;
350 char *end = buf + size;
354 append_printf(&buf, end, "hist");
356 ret = trace_boot_hist_add_array(hnode, &buf, end, "keys");
359 pr_err("hist requires keys.\n");
363 ret = trace_boot_hist_add_array(hnode, &buf, end, "values");
366 ret = trace_boot_hist_add_array(hnode, &buf, end, "sort");
370 p = xbc_node_find_value(hnode, "size", NULL);
372 append_printf(&buf, end, ":size=%s", p);
374 p = xbc_node_find_value(hnode, "name", NULL);
376 append_printf(&buf, end, ":name=%s", p);
378 node = xbc_node_find_child(hnode, "var");
380 xbc_node_for_each_key_value(node, knode, p) {
381 /* Expression must not include spaces. */
382 append_printf(&buf, end, ":%s=",
383 xbc_node_get_data(knode));
384 append_str_nospace(&buf, end, p);
388 /* Histogram control attributes (mutual exclusive) */
389 if (xbc_node_find_child(hnode, "pause"))
390 append_printf(&buf, end, ":pause");
391 else if (xbc_node_find_child(hnode, "continue"))
392 append_printf(&buf, end, ":continue");
393 else if (xbc_node_find_child(hnode, "clear"))
394 append_printf(&buf, end, ":clear");
396 /* Histogram handler and actions */
397 node = xbc_node_find_child(hnode, "onmax");
398 if (node && trace_boot_hist_add_handlers(node, &buf, end, "var") < 0)
400 node = xbc_node_find_child(hnode, "onchange");
401 if (node && trace_boot_hist_add_handlers(node, &buf, end, "var") < 0)
403 node = xbc_node_find_child(hnode, "onmatch");
404 if (node && trace_boot_hist_add_handlers(node, &buf, end, "event") < 0)
407 p = xbc_node_find_value(hnode, "filter", NULL);
409 append_printf(&buf, end, " if %s", p);
412 pr_err("hist exceeds the max command length.\n");
420 trace_boot_init_histograms(struct trace_event_file *file,
421 struct xbc_node *hnode, char *buf, size_t size)
423 struct xbc_node *node;
427 xbc_node_for_each_subkey(hnode, node) {
428 p = xbc_node_get_data(node);
431 /* All digit started node should be instances. */
432 if (trace_boot_compose_hist_cmd(node, buf, size) == 0) {
433 tmp = kstrdup(buf, GFP_KERNEL);
434 if (trigger_process_regex(file, buf) < 0)
435 pr_err("Failed to apply hist trigger: %s\n", tmp);
440 if (xbc_node_find_child(hnode, "keys")) {
441 if (trace_boot_compose_hist_cmd(hnode, buf, size) == 0) {
442 tmp = kstrdup(buf, GFP_KERNEL);
443 if (trigger_process_regex(file, buf) < 0)
444 pr_err("Failed to apply hist trigger: %s\n", tmp);
451 trace_boot_init_histograms(struct trace_event_file *file,
452 struct xbc_node *hnode, char *buf, size_t size)
459 trace_boot_init_one_event(struct trace_array *tr, struct xbc_node *gnode,
460 struct xbc_node *enode)
462 struct trace_event_file *file;
463 struct xbc_node *anode;
464 char buf[MAX_BUF_LEN];
465 const char *p, *group, *event;
467 group = xbc_node_get_data(gnode);
468 event = xbc_node_get_data(enode);
470 if (!strcmp(group, "kprobes"))
471 if (trace_boot_add_kprobe_event(enode, event) < 0)
473 if (!strcmp(group, "synthetic"))
474 if (trace_boot_add_synth_event(enode, event) < 0)
477 mutex_lock(&event_mutex);
478 file = find_event_file(tr, group, event);
480 pr_err("Failed to find event: %s:%s\n", group, event);
484 p = xbc_node_find_value(enode, "filter", NULL);
485 if (p && *p != '\0') {
486 if (strlcpy(buf, p, ARRAY_SIZE(buf)) >= ARRAY_SIZE(buf))
487 pr_err("filter string is too long: %s\n", p);
488 else if (apply_event_filter(file, buf) < 0)
489 pr_err("Failed to apply filter: %s\n", buf);
492 if (IS_ENABLED(CONFIG_HIST_TRIGGERS)) {
493 xbc_node_for_each_array_value(enode, "actions", anode, p) {
494 if (strlcpy(buf, p, ARRAY_SIZE(buf)) >= ARRAY_SIZE(buf))
495 pr_err("action string is too long: %s\n", p);
496 else if (trigger_process_regex(file, buf) < 0)
497 pr_err("Failed to apply an action: %s\n", p);
499 anode = xbc_node_find_child(enode, "hist");
501 trace_boot_init_histograms(file, anode, buf, ARRAY_SIZE(buf));
502 } else if (xbc_node_find_value(enode, "actions", NULL))
503 pr_err("Failed to apply event actions because CONFIG_HIST_TRIGGERS is not set.\n");
505 if (xbc_node_find_value(enode, "enable", NULL)) {
506 if (trace_event_enable_disable(file, 1, 0) < 0)
507 pr_err("Failed to enable event node: %s:%s\n",
511 mutex_unlock(&event_mutex);
515 trace_boot_init_events(struct trace_array *tr, struct xbc_node *node)
517 struct xbc_node *gnode, *enode;
518 bool enable, enable_all = false;
521 node = xbc_node_find_child(node, "event");
524 /* per-event key starts with "event.GROUP.EVENT" */
525 xbc_node_for_each_child(node, gnode) {
526 data = xbc_node_get_data(gnode);
527 if (!strcmp(data, "enable")) {
532 xbc_node_for_each_child(gnode, enode) {
533 data = xbc_node_get_data(enode);
534 if (!strcmp(data, "enable")) {
538 trace_boot_init_one_event(tr, gnode, enode);
540 /* Event enablement must be done after event settings */
542 data = xbc_node_get_data(gnode);
543 trace_array_set_clr_event(tr, data, NULL, true);
548 trace_array_set_clr_event(tr, NULL, NULL, true);
551 #define trace_boot_enable_events(tr, node) do {} while (0)
552 #define trace_boot_init_events(tr, node) do {} while (0)
555 #ifdef CONFIG_DYNAMIC_FTRACE
557 trace_boot_set_ftrace_filter(struct trace_array *tr, struct xbc_node *node)
559 struct xbc_node *anode;
563 xbc_node_for_each_array_value(node, "ftrace.filters", anode, p) {
564 q = kstrdup(p, GFP_KERNEL);
567 if (ftrace_set_filter(tr->ops, q, strlen(q), 0) < 0)
568 pr_err("Failed to add %s to ftrace filter\n", p);
570 ftrace_filter_param = true;
573 xbc_node_for_each_array_value(node, "ftrace.notraces", anode, p) {
574 q = kstrdup(p, GFP_KERNEL);
577 if (ftrace_set_notrace(tr->ops, q, strlen(q), 0) < 0)
578 pr_err("Failed to add %s to ftrace filter\n", p);
580 ftrace_filter_param = true;
585 #define trace_boot_set_ftrace_filter(tr, node) do {} while (0)
589 trace_boot_enable_tracer(struct trace_array *tr, struct xbc_node *node)
593 trace_boot_set_ftrace_filter(tr, node);
595 p = xbc_node_find_value(node, "tracer", NULL);
596 if (p && *p != '\0') {
597 if (tracing_set_tracer(tr, p) < 0)
598 pr_err("Failed to set given tracer: %s\n", p);
601 /* Since tracer can free snapshot buffer, allocate snapshot here.*/
602 if (xbc_node_find_value(node, "alloc_snapshot", NULL)) {
603 if (tracing_alloc_snapshot_instance(tr) < 0)
604 pr_err("Failed to allocate snapshot buffer\n");
609 trace_boot_init_one_instance(struct trace_array *tr, struct xbc_node *node)
611 trace_boot_set_instance_options(tr, node);
612 trace_boot_init_events(tr, node);
613 trace_boot_enable_events(tr, node);
614 trace_boot_enable_tracer(tr, node);
618 trace_boot_init_instances(struct xbc_node *node)
620 struct xbc_node *inode;
621 struct trace_array *tr;
624 node = xbc_node_find_child(node, "instance");
628 xbc_node_for_each_child(node, inode) {
629 p = xbc_node_get_data(inode);
630 if (!p || *p == '\0')
633 tr = trace_array_get_by_name(p);
635 pr_err("Failed to get trace instance %s\n", p);
638 trace_boot_init_one_instance(tr, inode);
643 static int __init trace_boot_init(void)
645 struct xbc_node *trace_node;
646 struct trace_array *tr;
648 trace_node = xbc_find_node("ftrace");
652 tr = top_trace_array();
656 /* Global trace array is also one instance */
657 trace_boot_init_one_instance(tr, trace_node);
658 trace_boot_init_instances(trace_node);
660 disable_tracing_selftest("running boot-time tracing");
665 * Start tracing at the end of core-initcall, so that it starts tracing
666 * from the beginning of postcore_initcall.
668 core_initcall_sync(trace_boot_init);