1 // SPDX-License-Identifier: GPL-2.0
3 * trace_events_synth - synthetic trace events
5 * Copyright (C) 2015, 2020 Tom Zanussi <tom.zanussi@linux.intel.com>
8 #include <linux/module.h>
9 #include <linux/kallsyms.h>
10 #include <linux/security.h>
11 #include <linux/mutex.h>
12 #include <linux/slab.h>
13 #include <linux/stacktrace.h>
14 #include <linux/rculist.h>
15 #include <linux/tracefs.h>
17 /* for gfp flag names */
18 #include <linux/trace_events.h>
19 #include <trace/events/mmflags.h>
20 #include "trace_probe.h"
21 #include "trace_probe_kernel.h"
23 #include "trace_synth.h"
27 C(BAD_NAME, "Illegal name"), \
28 C(INVALID_CMD, "Command must be of the form: <name> field[;field] ..."),\
29 C(INVALID_DYN_CMD, "Command must be of the form: s or -:[synthetic/]<name> field[;field] ..."),\
30 C(EVENT_EXISTS, "Event already exists"), \
31 C(TOO_MANY_FIELDS, "Too many fields"), \
32 C(INCOMPLETE_TYPE, "Incomplete type"), \
33 C(INVALID_TYPE, "Invalid type"), \
34 C(INVALID_FIELD, "Invalid field"), \
35 C(INVALID_ARRAY_SPEC, "Invalid array specification"),
38 #define C(a, b) SYNTH_ERR_##a
45 static const char *err_text[] = { ERRORS };
47 static DEFINE_MUTEX(lastcmd_mutex);
48 static char *last_cmd;
50 static int errpos(const char *str)
54 mutex_lock(&lastcmd_mutex);
55 if (!str || !last_cmd)
58 ret = err_pos(last_cmd, str);
60 mutex_unlock(&lastcmd_mutex);
64 static void last_cmd_set(const char *str)
69 mutex_lock(&lastcmd_mutex);
71 last_cmd = kstrdup(str, GFP_KERNEL);
72 mutex_unlock(&lastcmd_mutex);
75 static void synth_err(u8 err_type, u16 err_pos)
77 mutex_lock(&lastcmd_mutex);
81 tracing_log_err(NULL, "synthetic_events", last_cmd, err_text,
84 mutex_unlock(&lastcmd_mutex);
87 static int create_synth_event(const char *raw_command);
88 static int synth_event_show(struct seq_file *m, struct dyn_event *ev);
89 static int synth_event_release(struct dyn_event *ev);
90 static bool synth_event_is_busy(struct dyn_event *ev);
91 static bool synth_event_match(const char *system, const char *event,
92 int argc, const char **argv, struct dyn_event *ev);
94 static struct dyn_event_operations synth_event_ops = {
95 .create = create_synth_event,
96 .show = synth_event_show,
97 .is_busy = synth_event_is_busy,
98 .free = synth_event_release,
99 .match = synth_event_match,
102 static bool is_synth_event(struct dyn_event *ev)
104 return ev->ops == &synth_event_ops;
107 static struct synth_event *to_synth_event(struct dyn_event *ev)
109 return container_of(ev, struct synth_event, devent);
112 static bool synth_event_is_busy(struct dyn_event *ev)
114 struct synth_event *event = to_synth_event(ev);
116 return event->ref != 0;
119 static bool synth_event_match(const char *system, const char *event,
120 int argc, const char **argv, struct dyn_event *ev)
122 struct synth_event *sev = to_synth_event(ev);
124 return strcmp(sev->name, event) == 0 &&
125 (!system || strcmp(system, SYNTH_SYSTEM) == 0);
128 struct synth_trace_event {
129 struct trace_entry ent;
133 static int synth_event_define_fields(struct trace_event_call *call)
135 struct synth_trace_event trace;
136 int offset = offsetof(typeof(trace), fields);
137 struct synth_event *event = call->data;
138 unsigned int i, size, n_u64;
143 for (i = 0, n_u64 = 0; i < event->n_fields; i++) {
144 size = event->fields[i]->size;
145 is_signed = event->fields[i]->is_signed;
146 type = event->fields[i]->type;
147 name = event->fields[i]->name;
148 ret = trace_define_field(call, type, name, offset, size,
149 is_signed, FILTER_OTHER);
153 event->fields[i]->offset = n_u64;
155 if (event->fields[i]->is_string && !event->fields[i]->is_dynamic) {
156 offset += STR_VAR_LEN_MAX;
157 n_u64 += STR_VAR_LEN_MAX / sizeof(u64);
159 offset += sizeof(u64);
164 event->n_u64 = n_u64;
169 static bool synth_field_signed(char *type)
171 if (str_has_prefix(type, "u"))
173 if (strcmp(type, "gfp_t") == 0)
179 static int synth_field_is_string(char *type)
181 if (strstr(type, "char[") != NULL)
187 static int synth_field_is_stack(char *type)
189 if (strstr(type, "long[") != NULL)
195 static int synth_field_string_size(char *type)
197 char buf[4], *end, *start;
201 start = strstr(type, "char[");
204 start += sizeof("char[") - 1;
206 end = strchr(type, ']');
207 if (!end || end < start || type + strlen(type) > end + 1)
215 return 0; /* variable-length string */
217 strncpy(buf, start, len);
220 err = kstrtouint(buf, 0, &size);
224 if (size > STR_VAR_LEN_MAX)
230 static int synth_field_size(char *type)
234 if (strcmp(type, "s64") == 0)
236 else if (strcmp(type, "u64") == 0)
238 else if (strcmp(type, "s32") == 0)
240 else if (strcmp(type, "u32") == 0)
242 else if (strcmp(type, "s16") == 0)
244 else if (strcmp(type, "u16") == 0)
246 else if (strcmp(type, "s8") == 0)
248 else if (strcmp(type, "u8") == 0)
250 else if (strcmp(type, "char") == 0)
252 else if (strcmp(type, "unsigned char") == 0)
253 size = sizeof(unsigned char);
254 else if (strcmp(type, "int") == 0)
256 else if (strcmp(type, "unsigned int") == 0)
257 size = sizeof(unsigned int);
258 else if (strcmp(type, "long") == 0)
260 else if (strcmp(type, "unsigned long") == 0)
261 size = sizeof(unsigned long);
262 else if (strcmp(type, "bool") == 0)
264 else if (strcmp(type, "pid_t") == 0)
265 size = sizeof(pid_t);
266 else if (strcmp(type, "gfp_t") == 0)
267 size = sizeof(gfp_t);
268 else if (synth_field_is_string(type))
269 size = synth_field_string_size(type);
270 else if (synth_field_is_stack(type))
276 static const char *synth_field_fmt(char *type)
278 const char *fmt = "%llu";
280 if (strcmp(type, "s64") == 0)
282 else if (strcmp(type, "u64") == 0)
284 else if (strcmp(type, "s32") == 0)
286 else if (strcmp(type, "u32") == 0)
288 else if (strcmp(type, "s16") == 0)
290 else if (strcmp(type, "u16") == 0)
292 else if (strcmp(type, "s8") == 0)
294 else if (strcmp(type, "u8") == 0)
296 else if (strcmp(type, "char") == 0)
298 else if (strcmp(type, "unsigned char") == 0)
300 else if (strcmp(type, "int") == 0)
302 else if (strcmp(type, "unsigned int") == 0)
304 else if (strcmp(type, "long") == 0)
306 else if (strcmp(type, "unsigned long") == 0)
308 else if (strcmp(type, "bool") == 0)
310 else if (strcmp(type, "pid_t") == 0)
312 else if (strcmp(type, "gfp_t") == 0)
314 else if (synth_field_is_string(type))
316 else if (synth_field_is_stack(type))
322 static void print_synth_event_num_val(struct trace_seq *s,
323 char *print_fmt, char *name,
324 int size, u64 val, char *space)
328 trace_seq_printf(s, print_fmt, name, (u8)val, space);
332 trace_seq_printf(s, print_fmt, name, (u16)val, space);
336 trace_seq_printf(s, print_fmt, name, (u32)val, space);
340 trace_seq_printf(s, print_fmt, name, val, space);
345 static enum print_line_t print_synth_event(struct trace_iterator *iter,
347 struct trace_event *event)
349 struct trace_array *tr = iter->tr;
350 struct trace_seq *s = &iter->seq;
351 struct synth_trace_event *entry;
352 struct synth_event *se;
353 unsigned int i, n_u64;
357 entry = (struct synth_trace_event *)iter->ent;
358 se = container_of(event, struct synth_event, call.event);
360 trace_seq_printf(s, "%s: ", se->name);
362 for (i = 0, n_u64 = 0; i < se->n_fields; i++) {
363 if (trace_seq_has_overflowed(s))
366 fmt = synth_field_fmt(se->fields[i]->type);
368 /* parameter types */
369 if (tr && tr->trace_flags & TRACE_ITER_VERBOSE)
370 trace_seq_printf(s, "%s ", fmt);
372 snprintf(print_fmt, sizeof(print_fmt), "%%s=%s%%s", fmt);
374 /* parameter values */
375 if (se->fields[i]->is_string) {
376 if (se->fields[i]->is_dynamic) {
377 u32 offset, data_offset;
380 offset = (u32)entry->fields[n_u64];
381 data_offset = offset & 0xffff;
383 str_field = (char *)entry + data_offset;
385 trace_seq_printf(s, print_fmt, se->fields[i]->name,
388 i == se->n_fields - 1 ? "" : " ");
391 trace_seq_printf(s, print_fmt, se->fields[i]->name,
393 (char *)&entry->fields[n_u64],
394 i == se->n_fields - 1 ? "" : " ");
395 n_u64 += STR_VAR_LEN_MAX / sizeof(u64);
397 } else if (se->fields[i]->is_stack) {
398 u32 offset, data_offset, len;
399 unsigned long *p, *end;
401 offset = (u32)entry->fields[n_u64];
402 data_offset = offset & 0xffff;
405 p = (void *)entry + data_offset;
406 end = (void *)p + len - (sizeof(long) - 1);
408 trace_seq_printf(s, "%s=STACK:\n", se->fields[i]->name);
410 for (; *p && p < end; p++)
411 trace_seq_printf(s, "=> %pS\n", (void *)*p);
415 struct trace_print_flags __flags[] = {
416 __def_gfpflag_names, {-1, NULL} };
417 char *space = (i == se->n_fields - 1 ? "" : " ");
419 print_synth_event_num_val(s, print_fmt,
422 entry->fields[n_u64],
425 if (strcmp(se->fields[i]->type, "gfp_t") == 0) {
426 trace_seq_puts(s, " (");
427 trace_print_flags_seq(s, "|",
428 entry->fields[n_u64],
430 trace_seq_putc(s, ')');
436 trace_seq_putc(s, '\n');
438 return trace_handle_return(s);
441 static struct trace_event_functions synth_event_funcs = {
442 .trace = print_synth_event
445 static unsigned int trace_string(struct synth_trace_event *entry,
446 struct synth_event *event,
449 unsigned int data_size,
452 unsigned int len = 0;
459 data_offset = offsetof(typeof(*entry), fields);
460 data_offset += event->n_u64 * sizeof(u64);
461 data_offset += data_size;
463 len = kern_fetch_store_strlen((unsigned long)str_val);
465 data_offset |= len << 16;
466 *(u32 *)&entry->fields[*n_u64] = data_offset;
468 ret = kern_fetch_store_string((unsigned long)str_val, &entry->fields[*n_u64], entry);
472 str_field = (char *)&entry->fields[*n_u64];
474 #ifdef CONFIG_ARCH_HAS_NON_OVERLAPPING_ADDRESS_SPACE
475 if ((unsigned long)str_val < TASK_SIZE)
476 ret = strncpy_from_user_nofault(str_field, str_val, STR_VAR_LEN_MAX);
479 ret = strncpy_from_kernel_nofault(str_field, str_val, STR_VAR_LEN_MAX);
482 strcpy(str_field, FAULT_STRING);
484 (*n_u64) += STR_VAR_LEN_MAX / sizeof(u64);
490 static unsigned int trace_stack(struct synth_trace_event *entry,
491 struct synth_event *event,
493 unsigned int data_size,
500 data_offset = struct_size(entry, fields, event->n_u64);
501 data_offset += data_size;
503 for (len = 0; len < HIST_STACKTRACE_DEPTH; len++) {
508 /* Include the zero'd element if it fits */
509 if (len < HIST_STACKTRACE_DEPTH)
514 /* Find the dynamic section to copy the stack into. */
515 data_loc = (void *)entry + data_offset;
516 memcpy(data_loc, stack, len);
518 /* Fill in the field that holds the offset/len combo */
519 data_offset |= len << 16;
520 *(u32 *)&entry->fields[*n_u64] = data_offset;
527 static notrace void trace_event_raw_event_synth(void *__data,
529 unsigned int *var_ref_idx)
531 unsigned int i, n_u64, val_idx, len, data_size = 0;
532 struct trace_event_file *trace_file = __data;
533 struct synth_trace_event *entry;
534 struct trace_event_buffer fbuffer;
535 struct trace_buffer *buffer;
536 struct synth_event *event;
539 event = trace_file->event_call->data;
541 if (trace_trigger_soft_disabled(trace_file))
544 fields_size = event->n_u64 * sizeof(u64);
546 for (i = 0; i < event->n_dynamic_fields; i++) {
547 unsigned int field_pos = event->dynamic_fields[i]->field_pos;
550 val_idx = var_ref_idx[field_pos];
551 str_val = (char *)(long)var_ref_vals[val_idx];
553 len = kern_fetch_store_strlen((unsigned long)str_val);
559 * Avoid ring buffer recursion detection, as this event
560 * is being performed within another event.
562 buffer = trace_file->tr->array_buffer.buffer;
563 ring_buffer_nest_start(buffer);
565 entry = trace_event_buffer_reserve(&fbuffer, trace_file,
566 sizeof(*entry) + fields_size);
570 for (i = 0, n_u64 = 0; i < event->n_fields; i++) {
571 val_idx = var_ref_idx[i];
572 if (event->fields[i]->is_string) {
573 char *str_val = (char *)(long)var_ref_vals[val_idx];
575 len = trace_string(entry, event, str_val,
576 event->fields[i]->is_dynamic,
578 data_size += len; /* only dynamic string increments */
579 } else if (event->fields[i]->is_stack) {
580 long *stack = (long *)(long)var_ref_vals[val_idx];
582 len = trace_stack(entry, event, stack,
586 struct synth_field *field = event->fields[i];
587 u64 val = var_ref_vals[val_idx];
589 switch (field->size) {
591 *(u8 *)&entry->fields[n_u64] = (u8)val;
595 *(u16 *)&entry->fields[n_u64] = (u16)val;
599 *(u32 *)&entry->fields[n_u64] = (u32)val;
603 entry->fields[n_u64] = val;
610 trace_event_buffer_commit(&fbuffer);
612 ring_buffer_nest_end(buffer);
615 static void free_synth_event_print_fmt(struct trace_event_call *call)
618 kfree(call->print_fmt);
619 call->print_fmt = NULL;
623 static int __set_synth_event_print_fmt(struct synth_event *event,
630 /* When len=0, we just calculate the needed length */
631 #define LEN_OR_ZERO (len ? len - pos : 0)
633 pos += snprintf(buf + pos, LEN_OR_ZERO, "\"");
634 for (i = 0; i < event->n_fields; i++) {
635 fmt = synth_field_fmt(event->fields[i]->type);
636 pos += snprintf(buf + pos, LEN_OR_ZERO, "%s=%s%s",
637 event->fields[i]->name, fmt,
638 i == event->n_fields - 1 ? "" : ", ");
640 pos += snprintf(buf + pos, LEN_OR_ZERO, "\"");
642 for (i = 0; i < event->n_fields; i++) {
643 if (event->fields[i]->is_string &&
644 event->fields[i]->is_dynamic)
645 pos += snprintf(buf + pos, LEN_OR_ZERO,
646 ", __get_str(%s)", event->fields[i]->name);
647 else if (event->fields[i]->is_stack)
648 pos += snprintf(buf + pos, LEN_OR_ZERO,
649 ", __get_stacktrace(%s)", event->fields[i]->name);
651 pos += snprintf(buf + pos, LEN_OR_ZERO,
652 ", REC->%s", event->fields[i]->name);
657 /* return the length of print_fmt */
661 static int set_synth_event_print_fmt(struct trace_event_call *call)
663 struct synth_event *event = call->data;
667 /* First: called with 0 length to calculate the needed length */
668 len = __set_synth_event_print_fmt(event, NULL, 0);
670 print_fmt = kmalloc(len + 1, GFP_KERNEL);
674 /* Second: actually write the @print_fmt */
675 __set_synth_event_print_fmt(event, print_fmt, len + 1);
676 call->print_fmt = print_fmt;
681 static void free_synth_field(struct synth_field *field)
688 static int check_field_version(const char *prefix, const char *field_type,
689 const char *field_name)
692 * For backward compatibility, the old synthetic event command
693 * format did not require semicolons, and in order to not
694 * break user space, that old format must still work. If a new
695 * feature is added, then the format that uses the new feature
696 * will be required to have semicolons, as nothing that uses
697 * the old format would be using the new, yet to be created,
698 * feature. When a new feature is added, this will detect it,
699 * and return a number greater than 1, and require the format
705 static struct synth_field *parse_synth_field(int argc, char **argv,
706 int *consumed, int *field_version)
708 const char *prefix = NULL, *field_type = argv[0], *field_name, *array;
709 struct synth_field *field;
710 int len, ret = -ENOMEM;
714 if (!strcmp(field_type, "unsigned")) {
716 synth_err(SYNTH_ERR_INCOMPLETE_TYPE, errpos(field_type));
717 return ERR_PTR(-EINVAL);
719 prefix = "unsigned ";
720 field_type = argv[1];
721 field_name = argv[2];
724 field_name = argv[1];
729 synth_err(SYNTH_ERR_INVALID_FIELD, errpos(field_type));
730 return ERR_PTR(-EINVAL);
733 *field_version = check_field_version(prefix, field_type, field_name);
735 field = kzalloc(sizeof(*field), GFP_KERNEL);
737 return ERR_PTR(-ENOMEM);
739 len = strlen(field_name);
740 array = strchr(field_name, '[');
742 len -= strlen(array);
744 field->name = kmemdup_nul(field_name, len, GFP_KERNEL);
748 if (!is_good_name(field->name)) {
749 synth_err(SYNTH_ERR_BAD_NAME, errpos(field_name));
754 len = strlen(field_type) + 1;
757 len += strlen(array);
760 len += strlen(prefix);
762 field->type = kzalloc(len, GFP_KERNEL);
766 seq_buf_init(&s, field->type, len);
768 seq_buf_puts(&s, prefix);
769 seq_buf_puts(&s, field_type);
771 seq_buf_puts(&s, array);
772 if (WARN_ON_ONCE(!seq_buf_buffer_left(&s)))
775 s.buffer[s.len] = '\0';
777 size = synth_field_size(field->type);
780 synth_err(SYNTH_ERR_INVALID_ARRAY_SPEC, errpos(field_name));
782 synth_err(SYNTH_ERR_INVALID_TYPE, errpos(field_type));
785 } else if (size == 0) {
786 if (synth_field_is_string(field->type) ||
787 synth_field_is_stack(field->type)) {
790 len = sizeof("__data_loc ") + strlen(field->type) + 1;
791 type = kzalloc(len, GFP_KERNEL);
795 seq_buf_init(&s, type, len);
796 seq_buf_puts(&s, "__data_loc ");
797 seq_buf_puts(&s, field->type);
799 if (WARN_ON_ONCE(!seq_buf_buffer_left(&s)))
801 s.buffer[s.len] = '\0';
806 field->is_dynamic = true;
809 synth_err(SYNTH_ERR_INVALID_TYPE, errpos(field_type));
816 if (synth_field_is_string(field->type))
817 field->is_string = true;
818 else if (synth_field_is_stack(field->type))
819 field->is_stack = true;
821 field->is_signed = synth_field_signed(field->type);
825 free_synth_field(field);
826 field = ERR_PTR(ret);
830 static void free_synth_tracepoint(struct tracepoint *tp)
839 static struct tracepoint *alloc_synth_tracepoint(char *name)
841 struct tracepoint *tp;
843 tp = kzalloc(sizeof(*tp), GFP_KERNEL);
845 return ERR_PTR(-ENOMEM);
847 tp->name = kstrdup(name, GFP_KERNEL);
850 return ERR_PTR(-ENOMEM);
856 struct synth_event *find_synth_event(const char *name)
858 struct dyn_event *pos;
859 struct synth_event *event;
861 for_each_dyn_event(pos) {
862 if (!is_synth_event(pos))
864 event = to_synth_event(pos);
865 if (strcmp(event->name, name) == 0)
872 static struct trace_event_fields synth_event_fields_array[] = {
873 { .type = TRACE_FUNCTION_TYPE,
874 .define_fields = synth_event_define_fields },
878 static int register_synth_event(struct synth_event *event)
880 struct trace_event_call *call = &event->call;
883 event->call.class = &event->class;
884 event->class.system = kstrdup(SYNTH_SYSTEM, GFP_KERNEL);
885 if (!event->class.system) {
890 event->tp = alloc_synth_tracepoint(event->name);
891 if (IS_ERR(event->tp)) {
892 ret = PTR_ERR(event->tp);
897 INIT_LIST_HEAD(&call->class->fields);
898 call->event.funcs = &synth_event_funcs;
899 call->class->fields_array = synth_event_fields_array;
901 ret = register_trace_event(&call->event);
906 call->flags = TRACE_EVENT_FL_TRACEPOINT;
907 call->class->reg = trace_event_reg;
908 call->class->probe = trace_event_raw_event_synth;
910 call->tp = event->tp;
912 ret = trace_add_event_call(call);
914 pr_warn("Failed to register synthetic event: %s\n",
915 trace_event_name(call));
919 ret = set_synth_event_print_fmt(call);
920 /* unregister_trace_event() will be called inside */
922 trace_remove_event_call(call);
926 unregister_trace_event(&call->event);
930 static int unregister_synth_event(struct synth_event *event)
932 struct trace_event_call *call = &event->call;
935 ret = trace_remove_event_call(call);
940 static void free_synth_event(struct synth_event *event)
947 for (i = 0; i < event->n_fields; i++)
948 free_synth_field(event->fields[i]);
950 kfree(event->fields);
951 kfree(event->dynamic_fields);
953 kfree(event->class.system);
954 free_synth_tracepoint(event->tp);
955 free_synth_event_print_fmt(&event->call);
959 static struct synth_event *alloc_synth_event(const char *name, int n_fields,
960 struct synth_field **fields)
962 unsigned int i, j, n_dynamic_fields = 0;
963 struct synth_event *event;
965 event = kzalloc(sizeof(*event), GFP_KERNEL);
967 event = ERR_PTR(-ENOMEM);
971 event->name = kstrdup(name, GFP_KERNEL);
974 event = ERR_PTR(-ENOMEM);
978 event->fields = kcalloc(n_fields, sizeof(*event->fields), GFP_KERNEL);
979 if (!event->fields) {
980 free_synth_event(event);
981 event = ERR_PTR(-ENOMEM);
985 for (i = 0; i < n_fields; i++)
986 if (fields[i]->is_dynamic)
989 if (n_dynamic_fields) {
990 event->dynamic_fields = kcalloc(n_dynamic_fields,
991 sizeof(*event->dynamic_fields),
993 if (!event->dynamic_fields) {
994 free_synth_event(event);
995 event = ERR_PTR(-ENOMEM);
1000 dyn_event_init(&event->devent, &synth_event_ops);
1002 for (i = 0, j = 0; i < n_fields; i++) {
1003 fields[i]->field_pos = i;
1004 event->fields[i] = fields[i];
1006 if (fields[i]->is_dynamic)
1007 event->dynamic_fields[j++] = fields[i];
1009 event->n_dynamic_fields = j;
1010 event->n_fields = n_fields;
1015 static int synth_event_check_arg_fn(void *data)
1017 struct dynevent_arg_pair *arg_pair = data;
1020 size = synth_field_size((char *)arg_pair->lhs);
1022 if (strstr((char *)arg_pair->lhs, "["))
1026 return size ? 0 : -EINVAL;
1030 * synth_event_add_field - Add a new field to a synthetic event cmd
1031 * @cmd: A pointer to the dynevent_cmd struct representing the new event
1032 * @type: The type of the new field to add
1033 * @name: The name of the new field to add
1035 * Add a new field to a synthetic event cmd object. Field ordering is in
1036 * the same order the fields are added.
1038 * See synth_field_size() for available types. If field_name contains
1039 * [n] the field is considered to be an array.
1041 * Return: 0 if successful, error otherwise.
1043 int synth_event_add_field(struct dynevent_cmd *cmd, const char *type,
1046 struct dynevent_arg_pair arg_pair;
1049 if (cmd->type != DYNEVENT_TYPE_SYNTH)
1055 dynevent_arg_pair_init(&arg_pair, 0, ';');
1057 arg_pair.lhs = type;
1058 arg_pair.rhs = name;
1060 ret = dynevent_arg_pair_add(cmd, &arg_pair, synth_event_check_arg_fn);
1064 if (++cmd->n_fields > SYNTH_FIELDS_MAX)
1069 EXPORT_SYMBOL_GPL(synth_event_add_field);
1072 * synth_event_add_field_str - Add a new field to a synthetic event cmd
1073 * @cmd: A pointer to the dynevent_cmd struct representing the new event
1074 * @type_name: The type and name of the new field to add, as a single string
1076 * Add a new field to a synthetic event cmd object, as a single
1077 * string. The @type_name string is expected to be of the form 'type
1078 * name', which will be appended by ';'. No sanity checking is done -
1079 * what's passed in is assumed to already be well-formed. Field
1080 * ordering is in the same order the fields are added.
1082 * See synth_field_size() for available types. If field_name contains
1083 * [n] the field is considered to be an array.
1085 * Return: 0 if successful, error otherwise.
1087 int synth_event_add_field_str(struct dynevent_cmd *cmd, const char *type_name)
1089 struct dynevent_arg arg;
1092 if (cmd->type != DYNEVENT_TYPE_SYNTH)
1098 dynevent_arg_init(&arg, ';');
1100 arg.str = type_name;
1102 ret = dynevent_arg_add(cmd, &arg, NULL);
1106 if (++cmd->n_fields > SYNTH_FIELDS_MAX)
1111 EXPORT_SYMBOL_GPL(synth_event_add_field_str);
1114 * synth_event_add_fields - Add multiple fields to a synthetic event cmd
1115 * @cmd: A pointer to the dynevent_cmd struct representing the new event
1116 * @fields: An array of type/name field descriptions
1117 * @n_fields: The number of field descriptions contained in the fields array
1119 * Add a new set of fields to a synthetic event cmd object. The event
1120 * fields that will be defined for the event should be passed in as an
1121 * array of struct synth_field_desc, and the number of elements in the
1122 * array passed in as n_fields. Field ordering will retain the
1123 * ordering given in the fields array.
1125 * See synth_field_size() for available types. If field_name contains
1126 * [n] the field is considered to be an array.
1128 * Return: 0 if successful, error otherwise.
1130 int synth_event_add_fields(struct dynevent_cmd *cmd,
1131 struct synth_field_desc *fields,
1132 unsigned int n_fields)
1137 for (i = 0; i < n_fields; i++) {
1138 if (fields[i].type == NULL || fields[i].name == NULL) {
1143 ret = synth_event_add_field(cmd, fields[i].type, fields[i].name);
1150 EXPORT_SYMBOL_GPL(synth_event_add_fields);
1153 * __synth_event_gen_cmd_start - Start a synthetic event command from arg list
1154 * @cmd: A pointer to the dynevent_cmd struct representing the new event
1155 * @name: The name of the synthetic event
1156 * @mod: The module creating the event, NULL if not created from a module
1157 * @args: Variable number of arg (pairs), one pair for each field
1159 * NOTE: Users normally won't want to call this function directly, but
1160 * rather use the synth_event_gen_cmd_start() wrapper, which
1161 * automatically adds a NULL to the end of the arg list. If this
1162 * function is used directly, make sure the last arg in the variable
1165 * Generate a synthetic event command to be executed by
1166 * synth_event_gen_cmd_end(). This function can be used to generate
1167 * the complete command or only the first part of it; in the latter
1168 * case, synth_event_add_field(), synth_event_add_field_str(), or
1169 * synth_event_add_fields() can be used to add more fields following
1172 * There should be an even number variable args, each pair consisting
1173 * of a type followed by a field name.
1175 * See synth_field_size() for available types. If field_name contains
1176 * [n] the field is considered to be an array.
1178 * Return: 0 if successful, error otherwise.
1180 int __synth_event_gen_cmd_start(struct dynevent_cmd *cmd, const char *name,
1181 struct module *mod, ...)
1183 struct dynevent_arg arg;
1187 cmd->event_name = name;
1188 cmd->private_data = mod;
1190 if (cmd->type != DYNEVENT_TYPE_SYNTH)
1193 dynevent_arg_init(&arg, 0);
1195 ret = dynevent_arg_add(cmd, &arg, NULL);
1199 va_start(args, mod);
1201 const char *type, *name;
1203 type = va_arg(args, const char *);
1206 name = va_arg(args, const char *);
1210 if (++cmd->n_fields > SYNTH_FIELDS_MAX) {
1215 ret = synth_event_add_field(cmd, type, name);
1223 EXPORT_SYMBOL_GPL(__synth_event_gen_cmd_start);
1226 * synth_event_gen_cmd_array_start - Start synthetic event command from an array
1227 * @cmd: A pointer to the dynevent_cmd struct representing the new event
1228 * @name: The name of the synthetic event
1229 * @fields: An array of type/name field descriptions
1230 * @n_fields: The number of field descriptions contained in the fields array
1232 * Generate a synthetic event command to be executed by
1233 * synth_event_gen_cmd_end(). This function can be used to generate
1234 * the complete command or only the first part of it; in the latter
1235 * case, synth_event_add_field(), synth_event_add_field_str(), or
1236 * synth_event_add_fields() can be used to add more fields following
1239 * The event fields that will be defined for the event should be
1240 * passed in as an array of struct synth_field_desc, and the number of
1241 * elements in the array passed in as n_fields. Field ordering will
1242 * retain the ordering given in the fields array.
1244 * See synth_field_size() for available types. If field_name contains
1245 * [n] the field is considered to be an array.
1247 * Return: 0 if successful, error otherwise.
1249 int synth_event_gen_cmd_array_start(struct dynevent_cmd *cmd, const char *name,
1251 struct synth_field_desc *fields,
1252 unsigned int n_fields)
1254 struct dynevent_arg arg;
1258 cmd->event_name = name;
1259 cmd->private_data = mod;
1261 if (cmd->type != DYNEVENT_TYPE_SYNTH)
1264 if (n_fields > SYNTH_FIELDS_MAX)
1267 dynevent_arg_init(&arg, 0);
1269 ret = dynevent_arg_add(cmd, &arg, NULL);
1273 for (i = 0; i < n_fields; i++) {
1274 if (fields[i].type == NULL || fields[i].name == NULL)
1277 ret = synth_event_add_field(cmd, fields[i].type, fields[i].name);
1284 EXPORT_SYMBOL_GPL(synth_event_gen_cmd_array_start);
1286 static int __create_synth_event(const char *name, const char *raw_fields)
1288 char **argv, *field_str, *tmp_fields, *saved_fields = NULL;
1289 struct synth_field *field, *fields[SYNTH_FIELDS_MAX];
1290 int consumed, cmd_version = 1, n_fields_this_loop;
1291 int i, argc, n_fields = 0, ret = 0;
1292 struct synth_event *event = NULL;
1296 * - Add synthetic event: <event_name> field[;field] ...
1297 * - Remove synthetic event: !<event_name> field[;field] ...
1298 * where 'field' = type field_name
1301 if (name[0] == '\0') {
1302 synth_err(SYNTH_ERR_INVALID_CMD, 0);
1306 if (!is_good_name(name)) {
1307 synth_err(SYNTH_ERR_BAD_NAME, errpos(name));
1311 mutex_lock(&event_mutex);
1313 event = find_synth_event(name);
1315 synth_err(SYNTH_ERR_EVENT_EXISTS, errpos(name));
1320 tmp_fields = saved_fields = kstrdup(raw_fields, GFP_KERNEL);
1326 while ((field_str = strsep(&tmp_fields, ";")) != NULL) {
1327 argv = argv_split(GFP_KERNEL, field_str, &argc);
1338 n_fields_this_loop = 0;
1340 while (argc > consumed) {
1343 field = parse_synth_field(argc - consumed,
1344 argv + consumed, &consumed,
1346 if (IS_ERR(field)) {
1347 ret = PTR_ERR(field);
1352 * Track the highest version of any field we
1353 * found in the command.
1355 if (field_version > cmd_version)
1356 cmd_version = field_version;
1359 * Now sort out what is and isn't valid for
1360 * each supported version.
1362 * If we see more than 1 field per loop, it
1363 * means we have multiple fields between
1364 * semicolons, and that's something we no
1365 * longer support in a version 2 or greater
1368 if (cmd_version > 1 && n_fields_this_loop >= 1) {
1369 synth_err(SYNTH_ERR_INVALID_CMD, errpos(field_str));
1374 if (n_fields == SYNTH_FIELDS_MAX) {
1375 synth_err(SYNTH_ERR_TOO_MANY_FIELDS, 0);
1379 fields[n_fields++] = field;
1381 n_fields_this_loop++;
1385 if (consumed < argc) {
1386 synth_err(SYNTH_ERR_INVALID_CMD, 0);
1393 if (n_fields == 0) {
1394 synth_err(SYNTH_ERR_INVALID_CMD, 0);
1399 event = alloc_synth_event(name, n_fields, fields);
1400 if (IS_ERR(event)) {
1401 ret = PTR_ERR(event);
1405 ret = register_synth_event(event);
1407 dyn_event_add(&event->devent, &event->call);
1409 free_synth_event(event);
1411 mutex_unlock(&event_mutex);
1413 kfree(saved_fields);
1419 for (i = 0; i < n_fields; i++)
1420 free_synth_field(fields[i]);
1426 * synth_event_create - Create a new synthetic event
1427 * @name: The name of the new synthetic event
1428 * @fields: An array of type/name field descriptions
1429 * @n_fields: The number of field descriptions contained in the fields array
1430 * @mod: The module creating the event, NULL if not created from a module
1432 * Create a new synthetic event with the given name under the
1433 * trace/events/synthetic/ directory. The event fields that will be
1434 * defined for the event should be passed in as an array of struct
1435 * synth_field_desc, and the number elements in the array passed in as
1436 * n_fields. Field ordering will retain the ordering given in the
1439 * If the new synthetic event is being created from a module, the mod
1440 * param must be non-NULL. This will ensure that the trace buffer
1441 * won't contain unreadable events.
1443 * The new synth event should be deleted using synth_event_delete()
1444 * function. The new synthetic event can be generated from modules or
1445 * other kernel code using trace_synth_event() and related functions.
1447 * Return: 0 if successful, error otherwise.
1449 int synth_event_create(const char *name, struct synth_field_desc *fields,
1450 unsigned int n_fields, struct module *mod)
1452 struct dynevent_cmd cmd;
1456 buf = kzalloc(MAX_DYNEVENT_CMD_LEN, GFP_KERNEL);
1460 synth_event_cmd_init(&cmd, buf, MAX_DYNEVENT_CMD_LEN);
1462 ret = synth_event_gen_cmd_array_start(&cmd, name, mod,
1467 ret = synth_event_gen_cmd_end(&cmd);
1473 EXPORT_SYMBOL_GPL(synth_event_create);
1475 static int destroy_synth_event(struct synth_event *se)
1482 if (trace_event_dyn_busy(&se->call))
1485 ret = unregister_synth_event(se);
1487 dyn_event_remove(&se->devent);
1488 free_synth_event(se);
1495 * synth_event_delete - Delete a synthetic event
1496 * @event_name: The name of the new synthetic event
1498 * Delete a synthetic event that was created with synth_event_create().
1500 * Return: 0 if successful, error otherwise.
1502 int synth_event_delete(const char *event_name)
1504 struct synth_event *se = NULL;
1505 struct module *mod = NULL;
1508 mutex_lock(&event_mutex);
1509 se = find_synth_event(event_name);
1512 ret = destroy_synth_event(se);
1514 mutex_unlock(&event_mutex);
1518 * It is safest to reset the ring buffer if the module
1519 * being unloaded registered any events that were
1520 * used. The only worry is if a new module gets
1521 * loaded, and takes on the same id as the events of
1522 * this module. When printing out the buffer, traced
1523 * events left over from this module may be passed to
1524 * the new module events and unexpected results may
1527 tracing_reset_all_online_cpus();
1532 EXPORT_SYMBOL_GPL(synth_event_delete);
1534 static int check_command(const char *raw_command)
1536 char **argv = NULL, *cmd, *saved_cmd, *name_and_field;
1539 cmd = saved_cmd = kstrdup(raw_command, GFP_KERNEL);
1543 name_and_field = strsep(&cmd, ";");
1544 if (!name_and_field) {
1549 if (name_and_field[0] == '!')
1552 argv = argv_split(GFP_KERNEL, name_and_field, &argc);
1567 static int create_or_delete_synth_event(const char *raw_command)
1569 char *name = NULL, *fields, *p;
1572 raw_command = skip_spaces(raw_command);
1573 if (raw_command[0] == '\0')
1576 last_cmd_set(raw_command);
1578 ret = check_command(raw_command);
1580 synth_err(SYNTH_ERR_INVALID_CMD, 0);
1584 p = strpbrk(raw_command, " \t");
1585 if (!p && raw_command[0] != '!') {
1586 synth_err(SYNTH_ERR_INVALID_CMD, 0);
1591 name = kmemdup_nul(raw_command, p ? p - raw_command : strlen(raw_command), GFP_KERNEL);
1595 if (name[0] == '!') {
1596 ret = synth_event_delete(name + 1);
1600 fields = skip_spaces(p);
1602 ret = __create_synth_event(name, fields);
1609 static int synth_event_run_command(struct dynevent_cmd *cmd)
1611 struct synth_event *se;
1614 ret = create_or_delete_synth_event(cmd->seq.buffer);
1618 se = find_synth_event(cmd->event_name);
1622 se->mod = cmd->private_data;
1628 * synth_event_cmd_init - Initialize a synthetic event command object
1629 * @cmd: A pointer to the dynevent_cmd struct representing the new event
1630 * @buf: A pointer to the buffer used to build the command
1631 * @maxlen: The length of the buffer passed in @buf
1633 * Initialize a synthetic event command object. Use this before
1634 * calling any of the other dyenvent_cmd functions.
1636 void synth_event_cmd_init(struct dynevent_cmd *cmd, char *buf, int maxlen)
1638 dynevent_cmd_init(cmd, buf, maxlen, DYNEVENT_TYPE_SYNTH,
1639 synth_event_run_command);
1641 EXPORT_SYMBOL_GPL(synth_event_cmd_init);
1644 __synth_event_trace_init(struct trace_event_file *file,
1645 struct synth_event_trace_state *trace_state)
1649 memset(trace_state, '\0', sizeof(*trace_state));
1652 * Normal event tracing doesn't get called at all unless the
1653 * ENABLED bit is set (which attaches the probe thus allowing
1654 * this code to be called, etc). Because this is called
1655 * directly by the user, we don't have that but we still need
1656 * to honor not logging when disabled. For the iterated
1657 * trace case, we save the enabled state upon start and just
1658 * ignore the following data calls.
1660 if (!(file->flags & EVENT_FILE_FL_ENABLED) ||
1661 trace_trigger_soft_disabled(file)) {
1662 trace_state->disabled = true;
1667 trace_state->event = file->event_call->data;
1673 __synth_event_trace_start(struct trace_event_file *file,
1674 struct synth_event_trace_state *trace_state,
1675 int dynamic_fields_size)
1677 int entry_size, fields_size = 0;
1680 fields_size = trace_state->event->n_u64 * sizeof(u64);
1681 fields_size += dynamic_fields_size;
1684 * Avoid ring buffer recursion detection, as this event
1685 * is being performed within another event.
1687 trace_state->buffer = file->tr->array_buffer.buffer;
1688 ring_buffer_nest_start(trace_state->buffer);
1690 entry_size = sizeof(*trace_state->entry) + fields_size;
1691 trace_state->entry = trace_event_buffer_reserve(&trace_state->fbuffer,
1694 if (!trace_state->entry) {
1695 ring_buffer_nest_end(trace_state->buffer);
1703 __synth_event_trace_end(struct synth_event_trace_state *trace_state)
1705 trace_event_buffer_commit(&trace_state->fbuffer);
1707 ring_buffer_nest_end(trace_state->buffer);
1711 * synth_event_trace - Trace a synthetic event
1712 * @file: The trace_event_file representing the synthetic event
1713 * @n_vals: The number of values in vals
1714 * @args: Variable number of args containing the event values
1716 * Trace a synthetic event using the values passed in the variable
1719 * The argument list should be a list 'n_vals' u64 values. The number
1720 * of vals must match the number of field in the synthetic event, and
1721 * must be in the same order as the synthetic event fields.
1723 * All vals should be cast to u64, and string vals are just pointers
1724 * to strings, cast to u64. Strings will be copied into space
1725 * reserved in the event for the string, using these pointers.
1727 * Return: 0 on success, err otherwise.
1729 int synth_event_trace(struct trace_event_file *file, unsigned int n_vals, ...)
1731 unsigned int i, n_u64, len, data_size = 0;
1732 struct synth_event_trace_state state;
1736 ret = __synth_event_trace_init(file, &state);
1739 ret = 0; /* just disabled, not really an error */
1743 if (state.event->n_dynamic_fields) {
1744 va_start(args, n_vals);
1746 for (i = 0; i < state.event->n_fields; i++) {
1747 u64 val = va_arg(args, u64);
1749 if (state.event->fields[i]->is_string &&
1750 state.event->fields[i]->is_dynamic) {
1751 char *str_val = (char *)(long)val;
1753 data_size += strlen(str_val) + 1;
1760 ret = __synth_event_trace_start(file, &state, data_size);
1764 if (n_vals != state.event->n_fields) {
1771 va_start(args, n_vals);
1772 for (i = 0, n_u64 = 0; i < state.event->n_fields; i++) {
1775 val = va_arg(args, u64);
1777 if (state.event->fields[i]->is_string) {
1778 char *str_val = (char *)(long)val;
1780 len = trace_string(state.entry, state.event, str_val,
1781 state.event->fields[i]->is_dynamic,
1783 data_size += len; /* only dynamic string increments */
1785 struct synth_field *field = state.event->fields[i];
1787 switch (field->size) {
1789 *(u8 *)&state.entry->fields[n_u64] = (u8)val;
1793 *(u16 *)&state.entry->fields[n_u64] = (u16)val;
1797 *(u32 *)&state.entry->fields[n_u64] = (u32)val;
1801 state.entry->fields[n_u64] = val;
1809 __synth_event_trace_end(&state);
1813 EXPORT_SYMBOL_GPL(synth_event_trace);
1816 * synth_event_trace_array - Trace a synthetic event from an array
1817 * @file: The trace_event_file representing the synthetic event
1818 * @vals: Array of values
1819 * @n_vals: The number of values in vals
1821 * Trace a synthetic event using the values passed in as 'vals'.
1823 * The 'vals' array is just an array of 'n_vals' u64. The number of
1824 * vals must match the number of field in the synthetic event, and
1825 * must be in the same order as the synthetic event fields.
1827 * All vals should be cast to u64, and string vals are just pointers
1828 * to strings, cast to u64. Strings will be copied into space
1829 * reserved in the event for the string, using these pointers.
1831 * Return: 0 on success, err otherwise.
1833 int synth_event_trace_array(struct trace_event_file *file, u64 *vals,
1834 unsigned int n_vals)
1836 unsigned int i, n_u64, field_pos, len, data_size = 0;
1837 struct synth_event_trace_state state;
1841 ret = __synth_event_trace_init(file, &state);
1844 ret = 0; /* just disabled, not really an error */
1848 if (state.event->n_dynamic_fields) {
1849 for (i = 0; i < state.event->n_dynamic_fields; i++) {
1850 field_pos = state.event->dynamic_fields[i]->field_pos;
1851 str_val = (char *)(long)vals[field_pos];
1852 len = strlen(str_val) + 1;
1857 ret = __synth_event_trace_start(file, &state, data_size);
1861 if (n_vals != state.event->n_fields) {
1868 for (i = 0, n_u64 = 0; i < state.event->n_fields; i++) {
1869 if (state.event->fields[i]->is_string) {
1870 char *str_val = (char *)(long)vals[i];
1872 len = trace_string(state.entry, state.event, str_val,
1873 state.event->fields[i]->is_dynamic,
1875 data_size += len; /* only dynamic string increments */
1877 struct synth_field *field = state.event->fields[i];
1880 switch (field->size) {
1882 *(u8 *)&state.entry->fields[n_u64] = (u8)val;
1886 *(u16 *)&state.entry->fields[n_u64] = (u16)val;
1890 *(u32 *)&state.entry->fields[n_u64] = (u32)val;
1894 state.entry->fields[n_u64] = val;
1901 __synth_event_trace_end(&state);
1905 EXPORT_SYMBOL_GPL(synth_event_trace_array);
1908 * synth_event_trace_start - Start piecewise synthetic event trace
1909 * @file: The trace_event_file representing the synthetic event
1910 * @trace_state: A pointer to object tracking the piecewise trace state
1912 * Start the trace of a synthetic event field-by-field rather than all
1915 * This function 'opens' an event trace, which means space is reserved
1916 * for the event in the trace buffer, after which the event's
1917 * individual field values can be set through either
1918 * synth_event_add_next_val() or synth_event_add_val().
1920 * A pointer to a trace_state object is passed in, which will keep
1921 * track of the current event trace state until the event trace is
1922 * closed (and the event finally traced) using
1923 * synth_event_trace_end().
1925 * Note that synth_event_trace_end() must be called after all values
1926 * have been added for each event trace, regardless of whether adding
1927 * all field values succeeded or not.
1929 * Note also that for a given event trace, all fields must be added
1930 * using either synth_event_add_next_val() or synth_event_add_val()
1931 * but not both together or interleaved.
1933 * Return: 0 on success, err otherwise.
1935 int synth_event_trace_start(struct trace_event_file *file,
1936 struct synth_event_trace_state *trace_state)
1943 ret = __synth_event_trace_init(file, trace_state);
1946 ret = 0; /* just disabled, not really an error */
1950 if (trace_state->event->n_dynamic_fields)
1953 ret = __synth_event_trace_start(file, trace_state, 0);
1957 EXPORT_SYMBOL_GPL(synth_event_trace_start);
1959 static int __synth_event_add_val(const char *field_name, u64 val,
1960 struct synth_event_trace_state *trace_state)
1962 struct synth_field *field = NULL;
1963 struct synth_trace_event *entry;
1964 struct synth_event *event;
1972 /* can't mix add_next_synth_val() with add_synth_val() */
1974 if (trace_state->add_next) {
1978 trace_state->add_name = true;
1980 if (trace_state->add_name) {
1984 trace_state->add_next = true;
1987 if (trace_state->disabled)
1990 event = trace_state->event;
1991 if (trace_state->add_name) {
1992 for (i = 0; i < event->n_fields; i++) {
1993 field = event->fields[i];
1994 if (strcmp(field->name, field_name) == 0)
2002 if (trace_state->cur_field >= event->n_fields) {
2006 field = event->fields[trace_state->cur_field++];
2009 entry = trace_state->entry;
2010 if (field->is_string) {
2011 char *str_val = (char *)(long)val;
2014 if (field->is_dynamic) { /* add_val can't do dynamic strings */
2024 str_field = (char *)&entry->fields[field->offset];
2025 strscpy(str_field, str_val, STR_VAR_LEN_MAX);
2027 switch (field->size) {
2029 *(u8 *)&trace_state->entry->fields[field->offset] = (u8)val;
2033 *(u16 *)&trace_state->entry->fields[field->offset] = (u16)val;
2037 *(u32 *)&trace_state->entry->fields[field->offset] = (u32)val;
2041 trace_state->entry->fields[field->offset] = val;
2050 * synth_event_add_next_val - Add the next field's value to an open synth trace
2051 * @val: The value to set the next field to
2052 * @trace_state: A pointer to object tracking the piecewise trace state
2054 * Set the value of the next field in an event that's been opened by
2055 * synth_event_trace_start().
2057 * The val param should be the value cast to u64. If the value points
2058 * to a string, the val param should be a char * cast to u64.
2060 * This function assumes all the fields in an event are to be set one
2061 * after another - successive calls to this function are made, one for
2062 * each field, in the order of the fields in the event, until all
2063 * fields have been set. If you'd rather set each field individually
2064 * without regard to ordering, synth_event_add_val() can be used
2067 * Note however that synth_event_add_next_val() and
2068 * synth_event_add_val() can't be intermixed for a given event trace -
2069 * one or the other but not both can be used at the same time.
2071 * Note also that synth_event_trace_end() must be called after all
2072 * values have been added for each event trace, regardless of whether
2073 * adding all field values succeeded or not.
2075 * Return: 0 on success, err otherwise.
2077 int synth_event_add_next_val(u64 val,
2078 struct synth_event_trace_state *trace_state)
2080 return __synth_event_add_val(NULL, val, trace_state);
2082 EXPORT_SYMBOL_GPL(synth_event_add_next_val);
2085 * synth_event_add_val - Add a named field's value to an open synth trace
2086 * @field_name: The name of the synthetic event field value to set
2087 * @val: The value to set the named field to
2088 * @trace_state: A pointer to object tracking the piecewise trace state
2090 * Set the value of the named field in an event that's been opened by
2091 * synth_event_trace_start().
2093 * The val param should be the value cast to u64. If the value points
2094 * to a string, the val param should be a char * cast to u64.
2096 * This function looks up the field name, and if found, sets the field
2097 * to the specified value. This lookup makes this function more
2098 * expensive than synth_event_add_next_val(), so use that or the
2099 * none-piecewise synth_event_trace() instead if efficiency is more
2102 * Note however that synth_event_add_next_val() and
2103 * synth_event_add_val() can't be intermixed for a given event trace -
2104 * one or the other but not both can be used at the same time.
2106 * Note also that synth_event_trace_end() must be called after all
2107 * values have been added for each event trace, regardless of whether
2108 * adding all field values succeeded or not.
2110 * Return: 0 on success, err otherwise.
2112 int synth_event_add_val(const char *field_name, u64 val,
2113 struct synth_event_trace_state *trace_state)
2115 return __synth_event_add_val(field_name, val, trace_state);
2117 EXPORT_SYMBOL_GPL(synth_event_add_val);
2120 * synth_event_trace_end - End piecewise synthetic event trace
2121 * @trace_state: A pointer to object tracking the piecewise trace state
2123 * End the trace of a synthetic event opened by
2124 * synth_event_trace__start().
2126 * This function 'closes' an event trace, which basically means that
2127 * it commits the reserved event and cleans up other loose ends.
2129 * A pointer to a trace_state object is passed in, which will keep
2130 * track of the current event trace state opened with
2131 * synth_event_trace_start().
2133 * Note that this function must be called after all values have been
2134 * added for each event trace, regardless of whether adding all field
2135 * values succeeded or not.
2137 * Return: 0 on success, err otherwise.
2139 int synth_event_trace_end(struct synth_event_trace_state *trace_state)
2144 __synth_event_trace_end(trace_state);
2148 EXPORT_SYMBOL_GPL(synth_event_trace_end);
2150 static int create_synth_event(const char *raw_command)
2156 raw_command = skip_spaces(raw_command);
2157 if (raw_command[0] == '\0')
2160 last_cmd_set(raw_command);
2164 /* Don't try to process if not our system */
2165 if (name[0] != 's' || name[1] != ':')
2169 p = strpbrk(raw_command, " \t");
2171 synth_err(SYNTH_ERR_INVALID_CMD, 0);
2175 fields = skip_spaces(p);
2177 /* This interface accepts group name prefix */
2178 if (strchr(name, '/')) {
2179 len = str_has_prefix(name, SYNTH_SYSTEM "/");
2181 synth_err(SYNTH_ERR_INVALID_DYN_CMD, 0);
2187 len = name - raw_command;
2189 ret = check_command(raw_command + len);
2191 synth_err(SYNTH_ERR_INVALID_CMD, 0);
2195 name = kmemdup_nul(raw_command + len, p - raw_command - len, GFP_KERNEL);
2199 ret = __create_synth_event(name, fields);
2206 static int synth_event_release(struct dyn_event *ev)
2208 struct synth_event *event = to_synth_event(ev);
2214 if (trace_event_dyn_busy(&event->call))
2217 ret = unregister_synth_event(event);
2221 dyn_event_remove(ev);
2222 free_synth_event(event);
2226 static int __synth_event_show(struct seq_file *m, struct synth_event *event)
2228 struct synth_field *field;
2232 seq_printf(m, "%s\t", event->name);
2234 for (i = 0; i < event->n_fields; i++) {
2235 field = event->fields[i];
2238 t = strstr(type, "__data_loc");
2239 if (t) { /* __data_loc belongs in format but not event desc */
2240 t += sizeof("__data_loc");
2244 /* parameter values */
2245 seq_printf(m, "%s %s%s", type, field->name,
2246 i == event->n_fields - 1 ? "" : "; ");
2254 static int synth_event_show(struct seq_file *m, struct dyn_event *ev)
2256 struct synth_event *event = to_synth_event(ev);
2258 seq_printf(m, "s:%s/", event->class.system);
2260 return __synth_event_show(m, event);
2263 static int synth_events_seq_show(struct seq_file *m, void *v)
2265 struct dyn_event *ev = v;
2267 if (!is_synth_event(ev))
2270 return __synth_event_show(m, to_synth_event(ev));
2273 static const struct seq_operations synth_events_seq_op = {
2274 .start = dyn_event_seq_start,
2275 .next = dyn_event_seq_next,
2276 .stop = dyn_event_seq_stop,
2277 .show = synth_events_seq_show,
2280 static int synth_events_open(struct inode *inode, struct file *file)
2284 ret = security_locked_down(LOCKDOWN_TRACEFS);
2288 if ((file->f_mode & FMODE_WRITE) && (file->f_flags & O_TRUNC)) {
2289 ret = dyn_events_release_all(&synth_event_ops);
2294 return seq_open(file, &synth_events_seq_op);
2297 static ssize_t synth_events_write(struct file *file,
2298 const char __user *buffer,
2299 size_t count, loff_t *ppos)
2301 return trace_parse_run_command(file, buffer, count, ppos,
2302 create_or_delete_synth_event);
2305 static const struct file_operations synth_events_fops = {
2306 .open = synth_events_open,
2307 .write = synth_events_write,
2309 .llseek = seq_lseek,
2310 .release = seq_release,
2314 * Register dynevent at core_initcall. This allows kernel to setup kprobe
2315 * events in postcore_initcall without tracefs.
2317 static __init int trace_events_synth_init_early(void)
2321 err = dyn_event_register(&synth_event_ops);
2323 pr_warn("Could not register synth_event_ops\n");
2327 core_initcall(trace_events_synth_init_early);
2329 static __init int trace_events_synth_init(void)
2331 struct dentry *entry = NULL;
2333 err = tracing_init_dentry();
2337 entry = tracefs_create_file("synthetic_events", TRACE_MODE_WRITE,
2338 NULL, NULL, &synth_events_fops);
2346 pr_warn("Could not create tracefs 'synthetic_events' entry\n");
2351 fs_initcall(trace_events_synth_init);