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 char *last_cmd;
49 static int errpos(const char *str)
51 if (!str || !last_cmd)
54 return err_pos(last_cmd, str);
57 static void last_cmd_set(const char *str)
64 last_cmd = kstrdup(str, GFP_KERNEL);
67 static void synth_err(u8 err_type, u16 err_pos)
72 tracing_log_err(NULL, "synthetic_events", last_cmd, err_text,
76 static int create_synth_event(const char *raw_command);
77 static int synth_event_show(struct seq_file *m, struct dyn_event *ev);
78 static int synth_event_release(struct dyn_event *ev);
79 static bool synth_event_is_busy(struct dyn_event *ev);
80 static bool synth_event_match(const char *system, const char *event,
81 int argc, const char **argv, struct dyn_event *ev);
83 static struct dyn_event_operations synth_event_ops = {
84 .create = create_synth_event,
85 .show = synth_event_show,
86 .is_busy = synth_event_is_busy,
87 .free = synth_event_release,
88 .match = synth_event_match,
91 static bool is_synth_event(struct dyn_event *ev)
93 return ev->ops == &synth_event_ops;
96 static struct synth_event *to_synth_event(struct dyn_event *ev)
98 return container_of(ev, struct synth_event, devent);
101 static bool synth_event_is_busy(struct dyn_event *ev)
103 struct synth_event *event = to_synth_event(ev);
105 return event->ref != 0;
108 static bool synth_event_match(const char *system, const char *event,
109 int argc, const char **argv, struct dyn_event *ev)
111 struct synth_event *sev = to_synth_event(ev);
113 return strcmp(sev->name, event) == 0 &&
114 (!system || strcmp(system, SYNTH_SYSTEM) == 0);
117 struct synth_trace_event {
118 struct trace_entry ent;
122 static int synth_event_define_fields(struct trace_event_call *call)
124 struct synth_trace_event trace;
125 int offset = offsetof(typeof(trace), fields);
126 struct synth_event *event = call->data;
127 unsigned int i, size, n_u64;
132 for (i = 0, n_u64 = 0; i < event->n_fields; i++) {
133 size = event->fields[i]->size;
134 is_signed = event->fields[i]->is_signed;
135 type = event->fields[i]->type;
136 name = event->fields[i]->name;
137 ret = trace_define_field(call, type, name, offset, size,
138 is_signed, FILTER_OTHER);
142 event->fields[i]->offset = n_u64;
144 if (event->fields[i]->is_string && !event->fields[i]->is_dynamic) {
145 offset += STR_VAR_LEN_MAX;
146 n_u64 += STR_VAR_LEN_MAX / sizeof(u64);
148 offset += sizeof(u64);
153 event->n_u64 = n_u64;
158 static bool synth_field_signed(char *type)
160 if (str_has_prefix(type, "u"))
162 if (strcmp(type, "gfp_t") == 0)
168 static int synth_field_is_string(char *type)
170 if (strstr(type, "char[") != NULL)
176 static int synth_field_is_stack(char *type)
178 if (strstr(type, "long[") != NULL)
184 static int synth_field_string_size(char *type)
186 char buf[4], *end, *start;
190 start = strstr(type, "char[");
193 start += sizeof("char[") - 1;
195 end = strchr(type, ']');
196 if (!end || end < start || type + strlen(type) > end + 1)
204 return 0; /* variable-length string */
206 strncpy(buf, start, len);
209 err = kstrtouint(buf, 0, &size);
213 if (size > STR_VAR_LEN_MAX)
219 static int synth_field_size(char *type)
223 if (strcmp(type, "s64") == 0)
225 else if (strcmp(type, "u64") == 0)
227 else if (strcmp(type, "s32") == 0)
229 else if (strcmp(type, "u32") == 0)
231 else if (strcmp(type, "s16") == 0)
233 else if (strcmp(type, "u16") == 0)
235 else if (strcmp(type, "s8") == 0)
237 else if (strcmp(type, "u8") == 0)
239 else if (strcmp(type, "char") == 0)
241 else if (strcmp(type, "unsigned char") == 0)
242 size = sizeof(unsigned char);
243 else if (strcmp(type, "int") == 0)
245 else if (strcmp(type, "unsigned int") == 0)
246 size = sizeof(unsigned int);
247 else if (strcmp(type, "long") == 0)
249 else if (strcmp(type, "unsigned long") == 0)
250 size = sizeof(unsigned long);
251 else if (strcmp(type, "bool") == 0)
253 else if (strcmp(type, "pid_t") == 0)
254 size = sizeof(pid_t);
255 else if (strcmp(type, "gfp_t") == 0)
256 size = sizeof(gfp_t);
257 else if (synth_field_is_string(type))
258 size = synth_field_string_size(type);
259 else if (synth_field_is_stack(type))
265 static const char *synth_field_fmt(char *type)
267 const char *fmt = "%llu";
269 if (strcmp(type, "s64") == 0)
271 else if (strcmp(type, "u64") == 0)
273 else if (strcmp(type, "s32") == 0)
275 else if (strcmp(type, "u32") == 0)
277 else if (strcmp(type, "s16") == 0)
279 else if (strcmp(type, "u16") == 0)
281 else if (strcmp(type, "s8") == 0)
283 else if (strcmp(type, "u8") == 0)
285 else if (strcmp(type, "char") == 0)
287 else if (strcmp(type, "unsigned char") == 0)
289 else if (strcmp(type, "int") == 0)
291 else if (strcmp(type, "unsigned int") == 0)
293 else if (strcmp(type, "long") == 0)
295 else if (strcmp(type, "unsigned long") == 0)
297 else if (strcmp(type, "bool") == 0)
299 else if (strcmp(type, "pid_t") == 0)
301 else if (strcmp(type, "gfp_t") == 0)
303 else if (synth_field_is_string(type))
305 else if (synth_field_is_stack(type))
311 static void print_synth_event_num_val(struct trace_seq *s,
312 char *print_fmt, char *name,
313 int size, u64 val, char *space)
317 trace_seq_printf(s, print_fmt, name, (u8)val, space);
321 trace_seq_printf(s, print_fmt, name, (u16)val, space);
325 trace_seq_printf(s, print_fmt, name, (u32)val, space);
329 trace_seq_printf(s, print_fmt, name, val, space);
334 static enum print_line_t print_synth_event(struct trace_iterator *iter,
336 struct trace_event *event)
338 struct trace_array *tr = iter->tr;
339 struct trace_seq *s = &iter->seq;
340 struct synth_trace_event *entry;
341 struct synth_event *se;
342 unsigned int i, n_u64;
346 entry = (struct synth_trace_event *)iter->ent;
347 se = container_of(event, struct synth_event, call.event);
349 trace_seq_printf(s, "%s: ", se->name);
351 for (i = 0, n_u64 = 0; i < se->n_fields; i++) {
352 if (trace_seq_has_overflowed(s))
355 fmt = synth_field_fmt(se->fields[i]->type);
357 /* parameter types */
358 if (tr && tr->trace_flags & TRACE_ITER_VERBOSE)
359 trace_seq_printf(s, "%s ", fmt);
361 snprintf(print_fmt, sizeof(print_fmt), "%%s=%s%%s", fmt);
363 /* parameter values */
364 if (se->fields[i]->is_string) {
365 if (se->fields[i]->is_dynamic) {
366 u32 offset, data_offset;
369 offset = (u32)entry->fields[n_u64];
370 data_offset = offset & 0xffff;
372 str_field = (char *)entry + data_offset;
374 trace_seq_printf(s, print_fmt, se->fields[i]->name,
377 i == se->n_fields - 1 ? "" : " ");
380 trace_seq_printf(s, print_fmt, se->fields[i]->name,
382 (char *)&entry->fields[n_u64],
383 i == se->n_fields - 1 ? "" : " ");
384 n_u64 += STR_VAR_LEN_MAX / sizeof(u64);
386 } else if (se->fields[i]->is_stack) {
387 u32 offset, data_offset, len;
388 unsigned long *p, *end;
390 offset = (u32)entry->fields[n_u64];
391 data_offset = offset & 0xffff;
394 p = (void *)entry + data_offset;
395 end = (void *)p + len - (sizeof(long) - 1);
397 trace_seq_printf(s, "%s=STACK:\n", se->fields[i]->name);
399 for (; *p && p < end; p++)
400 trace_seq_printf(s, "=> %pS\n", (void *)*p);
404 struct trace_print_flags __flags[] = {
405 __def_gfpflag_names, {-1, NULL} };
406 char *space = (i == se->n_fields - 1 ? "" : " ");
408 print_synth_event_num_val(s, print_fmt,
411 entry->fields[n_u64],
414 if (strcmp(se->fields[i]->type, "gfp_t") == 0) {
415 trace_seq_puts(s, " (");
416 trace_print_flags_seq(s, "|",
417 entry->fields[n_u64],
419 trace_seq_putc(s, ')');
425 trace_seq_putc(s, '\n');
427 return trace_handle_return(s);
430 static struct trace_event_functions synth_event_funcs = {
431 .trace = print_synth_event
434 static unsigned int trace_string(struct synth_trace_event *entry,
435 struct synth_event *event,
438 unsigned int data_size,
441 unsigned int len = 0;
448 data_offset = struct_size(entry, fields, event->n_u64);
449 data_offset += data_size;
451 len = fetch_store_strlen((unsigned long)str_val);
453 data_offset |= len << 16;
454 *(u32 *)&entry->fields[*n_u64] = data_offset;
456 ret = fetch_store_string((unsigned long)str_val, &entry->fields[*n_u64], entry);
460 str_field = (char *)&entry->fields[*n_u64];
462 #ifdef CONFIG_ARCH_HAS_NON_OVERLAPPING_ADDRESS_SPACE
463 if ((unsigned long)str_val < TASK_SIZE)
464 ret = strncpy_from_user_nofault(str_field, str_val, STR_VAR_LEN_MAX);
467 ret = strncpy_from_kernel_nofault(str_field, str_val, STR_VAR_LEN_MAX);
470 strcpy(str_field, FAULT_STRING);
472 (*n_u64) += STR_VAR_LEN_MAX / sizeof(u64);
478 static unsigned int trace_stack(struct synth_trace_event *entry,
479 struct synth_event *event,
481 unsigned int data_size,
488 data_offset = struct_size(entry, fields, event->n_u64);
489 data_offset += data_size;
491 for (len = 0; len < HIST_STACKTRACE_DEPTH; len++) {
496 /* Include the zero'd element if it fits */
497 if (len < HIST_STACKTRACE_DEPTH)
502 /* Find the dynamic section to copy the stack into. */
503 data_loc = (void *)entry + data_offset;
504 memcpy(data_loc, stack, len);
506 /* Fill in the field that holds the offset/len combo */
507 data_offset |= len << 16;
508 *(u32 *)&entry->fields[*n_u64] = data_offset;
515 static notrace void trace_event_raw_event_synth(void *__data,
517 unsigned int *var_ref_idx)
519 unsigned int i, n_u64, val_idx, len, data_size = 0;
520 struct trace_event_file *trace_file = __data;
521 struct synth_trace_event *entry;
522 struct trace_event_buffer fbuffer;
523 struct trace_buffer *buffer;
524 struct synth_event *event;
527 event = trace_file->event_call->data;
529 if (trace_trigger_soft_disabled(trace_file))
532 fields_size = event->n_u64 * sizeof(u64);
534 for (i = 0; i < event->n_dynamic_fields; i++) {
535 unsigned int field_pos = event->dynamic_fields[i]->field_pos;
538 val_idx = var_ref_idx[field_pos];
539 str_val = (char *)(long)var_ref_vals[val_idx];
541 if (event->dynamic_fields[i]->is_stack) {
542 len = *((unsigned long *)str_val);
543 len *= sizeof(unsigned long);
545 len = fetch_store_strlen((unsigned long)str_val);
552 * Avoid ring buffer recursion detection, as this event
553 * is being performed within another event.
555 buffer = trace_file->tr->array_buffer.buffer;
556 ring_buffer_nest_start(buffer);
558 entry = trace_event_buffer_reserve(&fbuffer, trace_file,
559 sizeof(*entry) + fields_size);
563 for (i = 0, n_u64 = 0; i < event->n_fields; i++) {
564 val_idx = var_ref_idx[i];
565 if (event->fields[i]->is_string) {
566 char *str_val = (char *)(long)var_ref_vals[val_idx];
568 len = trace_string(entry, event, str_val,
569 event->fields[i]->is_dynamic,
571 data_size += len; /* only dynamic string increments */
572 } else if (event->fields[i]->is_stack) {
573 long *stack = (long *)(long)var_ref_vals[val_idx];
575 len = trace_stack(entry, event, stack,
579 struct synth_field *field = event->fields[i];
580 u64 val = var_ref_vals[val_idx];
582 switch (field->size) {
584 *(u8 *)&entry->fields[n_u64] = (u8)val;
588 *(u16 *)&entry->fields[n_u64] = (u16)val;
592 *(u32 *)&entry->fields[n_u64] = (u32)val;
596 entry->fields[n_u64] = val;
603 trace_event_buffer_commit(&fbuffer);
605 ring_buffer_nest_end(buffer);
608 static void free_synth_event_print_fmt(struct trace_event_call *call)
611 kfree(call->print_fmt);
612 call->print_fmt = NULL;
616 static int __set_synth_event_print_fmt(struct synth_event *event,
623 /* When len=0, we just calculate the needed length */
624 #define LEN_OR_ZERO (len ? len - pos : 0)
626 pos += snprintf(buf + pos, LEN_OR_ZERO, "\"");
627 for (i = 0; i < event->n_fields; i++) {
628 fmt = synth_field_fmt(event->fields[i]->type);
629 pos += snprintf(buf + pos, LEN_OR_ZERO, "%s=%s%s",
630 event->fields[i]->name, fmt,
631 i == event->n_fields - 1 ? "" : ", ");
633 pos += snprintf(buf + pos, LEN_OR_ZERO, "\"");
635 for (i = 0; i < event->n_fields; i++) {
636 if (event->fields[i]->is_string &&
637 event->fields[i]->is_dynamic)
638 pos += snprintf(buf + pos, LEN_OR_ZERO,
639 ", __get_str(%s)", event->fields[i]->name);
640 else if (event->fields[i]->is_stack)
641 pos += snprintf(buf + pos, LEN_OR_ZERO,
642 ", __get_stacktrace(%s)", event->fields[i]->name);
644 pos += snprintf(buf + pos, LEN_OR_ZERO,
645 ", REC->%s", event->fields[i]->name);
650 /* return the length of print_fmt */
654 static int set_synth_event_print_fmt(struct trace_event_call *call)
656 struct synth_event *event = call->data;
660 /* First: called with 0 length to calculate the needed length */
661 len = __set_synth_event_print_fmt(event, NULL, 0);
663 print_fmt = kmalloc(len + 1, GFP_KERNEL);
667 /* Second: actually write the @print_fmt */
668 __set_synth_event_print_fmt(event, print_fmt, len + 1);
669 call->print_fmt = print_fmt;
674 static void free_synth_field(struct synth_field *field)
681 static int check_field_version(const char *prefix, const char *field_type,
682 const char *field_name)
685 * For backward compatibility, the old synthetic event command
686 * format did not require semicolons, and in order to not
687 * break user space, that old format must still work. If a new
688 * feature is added, then the format that uses the new feature
689 * will be required to have semicolons, as nothing that uses
690 * the old format would be using the new, yet to be created,
691 * feature. When a new feature is added, this will detect it,
692 * and return a number greater than 1, and require the format
698 static struct synth_field *parse_synth_field(int argc, char **argv,
699 int *consumed, int *field_version)
701 const char *prefix = NULL, *field_type = argv[0], *field_name, *array;
702 struct synth_field *field;
703 int len, ret = -ENOMEM;
707 if (!strcmp(field_type, "unsigned")) {
709 synth_err(SYNTH_ERR_INCOMPLETE_TYPE, errpos(field_type));
710 return ERR_PTR(-EINVAL);
712 prefix = "unsigned ";
713 field_type = argv[1];
714 field_name = argv[2];
717 field_name = argv[1];
722 synth_err(SYNTH_ERR_INVALID_FIELD, errpos(field_type));
723 return ERR_PTR(-EINVAL);
726 *field_version = check_field_version(prefix, field_type, field_name);
728 field = kzalloc(sizeof(*field), GFP_KERNEL);
730 return ERR_PTR(-ENOMEM);
732 len = strlen(field_name);
733 array = strchr(field_name, '[');
735 len -= strlen(array);
737 field->name = kmemdup_nul(field_name, len, GFP_KERNEL);
741 if (!is_good_name(field->name)) {
742 synth_err(SYNTH_ERR_BAD_NAME, errpos(field_name));
747 len = strlen(field_type) + 1;
750 len += strlen(array);
753 len += strlen(prefix);
755 field->type = kzalloc(len, GFP_KERNEL);
759 seq_buf_init(&s, field->type, len);
761 seq_buf_puts(&s, prefix);
762 seq_buf_puts(&s, field_type);
764 seq_buf_puts(&s, array);
765 if (WARN_ON_ONCE(!seq_buf_buffer_left(&s)))
768 s.buffer[s.len] = '\0';
770 size = synth_field_size(field->type);
773 synth_err(SYNTH_ERR_INVALID_ARRAY_SPEC, errpos(field_name));
775 synth_err(SYNTH_ERR_INVALID_TYPE, errpos(field_type));
778 } else if (size == 0) {
779 if (synth_field_is_string(field->type) ||
780 synth_field_is_stack(field->type)) {
783 len = sizeof("__data_loc ") + strlen(field->type) + 1;
784 type = kzalloc(len, GFP_KERNEL);
788 seq_buf_init(&s, type, len);
789 seq_buf_puts(&s, "__data_loc ");
790 seq_buf_puts(&s, field->type);
792 if (WARN_ON_ONCE(!seq_buf_buffer_left(&s)))
794 s.buffer[s.len] = '\0';
799 field->is_dynamic = true;
802 synth_err(SYNTH_ERR_INVALID_TYPE, errpos(field_type));
809 if (synth_field_is_string(field->type))
810 field->is_string = true;
811 else if (synth_field_is_stack(field->type))
812 field->is_stack = true;
814 field->is_signed = synth_field_signed(field->type);
818 free_synth_field(field);
819 field = ERR_PTR(ret);
823 static void free_synth_tracepoint(struct tracepoint *tp)
832 static struct tracepoint *alloc_synth_tracepoint(char *name)
834 struct tracepoint *tp;
836 tp = kzalloc(sizeof(*tp), GFP_KERNEL);
838 return ERR_PTR(-ENOMEM);
840 tp->name = kstrdup(name, GFP_KERNEL);
843 return ERR_PTR(-ENOMEM);
849 struct synth_event *find_synth_event(const char *name)
851 struct dyn_event *pos;
852 struct synth_event *event;
854 for_each_dyn_event(pos) {
855 if (!is_synth_event(pos))
857 event = to_synth_event(pos);
858 if (strcmp(event->name, name) == 0)
865 static struct trace_event_fields synth_event_fields_array[] = {
866 { .type = TRACE_FUNCTION_TYPE,
867 .define_fields = synth_event_define_fields },
871 static int register_synth_event(struct synth_event *event)
873 struct trace_event_call *call = &event->call;
876 event->call.class = &event->class;
877 event->class.system = kstrdup(SYNTH_SYSTEM, GFP_KERNEL);
878 if (!event->class.system) {
883 event->tp = alloc_synth_tracepoint(event->name);
884 if (IS_ERR(event->tp)) {
885 ret = PTR_ERR(event->tp);
890 INIT_LIST_HEAD(&call->class->fields);
891 call->event.funcs = &synth_event_funcs;
892 call->class->fields_array = synth_event_fields_array;
894 ret = register_trace_event(&call->event);
899 call->flags = TRACE_EVENT_FL_TRACEPOINT;
900 call->class->reg = trace_event_reg;
901 call->class->probe = trace_event_raw_event_synth;
903 call->tp = event->tp;
905 ret = trace_add_event_call(call);
907 pr_warn("Failed to register synthetic event: %s\n",
908 trace_event_name(call));
912 ret = set_synth_event_print_fmt(call);
913 /* unregister_trace_event() will be called inside */
915 trace_remove_event_call(call);
919 unregister_trace_event(&call->event);
923 static int unregister_synth_event(struct synth_event *event)
925 struct trace_event_call *call = &event->call;
928 ret = trace_remove_event_call(call);
933 static void free_synth_event(struct synth_event *event)
940 for (i = 0; i < event->n_fields; i++)
941 free_synth_field(event->fields[i]);
943 kfree(event->fields);
944 kfree(event->dynamic_fields);
946 kfree(event->class.system);
947 free_synth_tracepoint(event->tp);
948 free_synth_event_print_fmt(&event->call);
952 static struct synth_event *alloc_synth_event(const char *name, int n_fields,
953 struct synth_field **fields)
955 unsigned int i, j, n_dynamic_fields = 0;
956 struct synth_event *event;
958 event = kzalloc(sizeof(*event), GFP_KERNEL);
960 event = ERR_PTR(-ENOMEM);
964 event->name = kstrdup(name, GFP_KERNEL);
967 event = ERR_PTR(-ENOMEM);
971 event->fields = kcalloc(n_fields, sizeof(*event->fields), GFP_KERNEL);
972 if (!event->fields) {
973 free_synth_event(event);
974 event = ERR_PTR(-ENOMEM);
978 for (i = 0; i < n_fields; i++)
979 if (fields[i]->is_dynamic)
982 if (n_dynamic_fields) {
983 event->dynamic_fields = kcalloc(n_dynamic_fields,
984 sizeof(*event->dynamic_fields),
986 if (!event->dynamic_fields) {
987 free_synth_event(event);
988 event = ERR_PTR(-ENOMEM);
993 dyn_event_init(&event->devent, &synth_event_ops);
995 for (i = 0, j = 0; i < n_fields; i++) {
996 fields[i]->field_pos = i;
997 event->fields[i] = fields[i];
999 if (fields[i]->is_dynamic)
1000 event->dynamic_fields[j++] = fields[i];
1002 event->n_dynamic_fields = j;
1003 event->n_fields = n_fields;
1008 static int synth_event_check_arg_fn(void *data)
1010 struct dynevent_arg_pair *arg_pair = data;
1013 size = synth_field_size((char *)arg_pair->lhs);
1015 if (strstr((char *)arg_pair->lhs, "["))
1019 return size ? 0 : -EINVAL;
1023 * synth_event_add_field - Add a new field to a synthetic event cmd
1024 * @cmd: A pointer to the dynevent_cmd struct representing the new event
1025 * @type: The type of the new field to add
1026 * @name: The name of the new field to add
1028 * Add a new field to a synthetic event cmd object. Field ordering is in
1029 * the same order the fields are added.
1031 * See synth_field_size() for available types. If field_name contains
1032 * [n] the field is considered to be an array.
1034 * Return: 0 if successful, error otherwise.
1036 int synth_event_add_field(struct dynevent_cmd *cmd, const char *type,
1039 struct dynevent_arg_pair arg_pair;
1042 if (cmd->type != DYNEVENT_TYPE_SYNTH)
1048 dynevent_arg_pair_init(&arg_pair, 0, ';');
1050 arg_pair.lhs = type;
1051 arg_pair.rhs = name;
1053 ret = dynevent_arg_pair_add(cmd, &arg_pair, synth_event_check_arg_fn);
1057 if (++cmd->n_fields > SYNTH_FIELDS_MAX)
1062 EXPORT_SYMBOL_GPL(synth_event_add_field);
1065 * synth_event_add_field_str - Add a new field to a synthetic event cmd
1066 * @cmd: A pointer to the dynevent_cmd struct representing the new event
1067 * @type_name: The type and name of the new field to add, as a single string
1069 * Add a new field to a synthetic event cmd object, as a single
1070 * string. The @type_name string is expected to be of the form 'type
1071 * name', which will be appended by ';'. No sanity checking is done -
1072 * what's passed in is assumed to already be well-formed. Field
1073 * ordering is in the same order the fields are added.
1075 * See synth_field_size() for available types. If field_name contains
1076 * [n] the field is considered to be an array.
1078 * Return: 0 if successful, error otherwise.
1080 int synth_event_add_field_str(struct dynevent_cmd *cmd, const char *type_name)
1082 struct dynevent_arg arg;
1085 if (cmd->type != DYNEVENT_TYPE_SYNTH)
1091 dynevent_arg_init(&arg, ';');
1093 arg.str = type_name;
1095 ret = dynevent_arg_add(cmd, &arg, NULL);
1099 if (++cmd->n_fields > SYNTH_FIELDS_MAX)
1104 EXPORT_SYMBOL_GPL(synth_event_add_field_str);
1107 * synth_event_add_fields - Add multiple fields to a synthetic event cmd
1108 * @cmd: A pointer to the dynevent_cmd struct representing the new event
1109 * @fields: An array of type/name field descriptions
1110 * @n_fields: The number of field descriptions contained in the fields array
1112 * Add a new set of fields to a synthetic event cmd object. The event
1113 * fields that will be defined for the event should be passed in as an
1114 * array of struct synth_field_desc, and the number of elements in the
1115 * array passed in as n_fields. Field ordering will retain the
1116 * ordering given in the fields array.
1118 * See synth_field_size() for available types. If field_name contains
1119 * [n] the field is considered to be an array.
1121 * Return: 0 if successful, error otherwise.
1123 int synth_event_add_fields(struct dynevent_cmd *cmd,
1124 struct synth_field_desc *fields,
1125 unsigned int n_fields)
1130 for (i = 0; i < n_fields; i++) {
1131 if (fields[i].type == NULL || fields[i].name == NULL) {
1136 ret = synth_event_add_field(cmd, fields[i].type, fields[i].name);
1143 EXPORT_SYMBOL_GPL(synth_event_add_fields);
1146 * __synth_event_gen_cmd_start - Start a synthetic event command from arg list
1147 * @cmd: A pointer to the dynevent_cmd struct representing the new event
1148 * @name: The name of the synthetic event
1149 * @mod: The module creating the event, NULL if not created from a module
1150 * @args: Variable number of arg (pairs), one pair for each field
1152 * NOTE: Users normally won't want to call this function directly, but
1153 * rather use the synth_event_gen_cmd_start() wrapper, which
1154 * automatically adds a NULL to the end of the arg list. If this
1155 * function is used directly, make sure the last arg in the variable
1158 * Generate a synthetic event command to be executed by
1159 * synth_event_gen_cmd_end(). This function can be used to generate
1160 * the complete command or only the first part of it; in the latter
1161 * case, synth_event_add_field(), synth_event_add_field_str(), or
1162 * synth_event_add_fields() can be used to add more fields following
1165 * There should be an even number variable args, each pair consisting
1166 * of a type followed by a field name.
1168 * See synth_field_size() for available types. If field_name contains
1169 * [n] the field is considered to be an array.
1171 * Return: 0 if successful, error otherwise.
1173 int __synth_event_gen_cmd_start(struct dynevent_cmd *cmd, const char *name,
1174 struct module *mod, ...)
1176 struct dynevent_arg arg;
1180 cmd->event_name = name;
1181 cmd->private_data = mod;
1183 if (cmd->type != DYNEVENT_TYPE_SYNTH)
1186 dynevent_arg_init(&arg, 0);
1188 ret = dynevent_arg_add(cmd, &arg, NULL);
1192 va_start(args, mod);
1194 const char *type, *name;
1196 type = va_arg(args, const char *);
1199 name = va_arg(args, const char *);
1203 if (++cmd->n_fields > SYNTH_FIELDS_MAX) {
1208 ret = synth_event_add_field(cmd, type, name);
1216 EXPORT_SYMBOL_GPL(__synth_event_gen_cmd_start);
1219 * synth_event_gen_cmd_array_start - Start synthetic event command from an array
1220 * @cmd: A pointer to the dynevent_cmd struct representing the new event
1221 * @name: The name of the synthetic event
1222 * @fields: An array of type/name field descriptions
1223 * @n_fields: The number of field descriptions contained in the fields array
1225 * Generate a synthetic event command to be executed by
1226 * synth_event_gen_cmd_end(). This function can be used to generate
1227 * the complete command or only the first part of it; in the latter
1228 * case, synth_event_add_field(), synth_event_add_field_str(), or
1229 * synth_event_add_fields() can be used to add more fields following
1232 * The event fields that will be defined for the event should be
1233 * passed in as an array of struct synth_field_desc, and the number of
1234 * elements in the array passed in as n_fields. Field ordering will
1235 * retain the ordering given in the fields array.
1237 * See synth_field_size() for available types. If field_name contains
1238 * [n] the field is considered to be an array.
1240 * Return: 0 if successful, error otherwise.
1242 int synth_event_gen_cmd_array_start(struct dynevent_cmd *cmd, const char *name,
1244 struct synth_field_desc *fields,
1245 unsigned int n_fields)
1247 struct dynevent_arg arg;
1251 cmd->event_name = name;
1252 cmd->private_data = mod;
1254 if (cmd->type != DYNEVENT_TYPE_SYNTH)
1257 if (n_fields > SYNTH_FIELDS_MAX)
1260 dynevent_arg_init(&arg, 0);
1262 ret = dynevent_arg_add(cmd, &arg, NULL);
1266 for (i = 0; i < n_fields; i++) {
1267 if (fields[i].type == NULL || fields[i].name == NULL)
1270 ret = synth_event_add_field(cmd, fields[i].type, fields[i].name);
1277 EXPORT_SYMBOL_GPL(synth_event_gen_cmd_array_start);
1279 static int __create_synth_event(const char *name, const char *raw_fields)
1281 char **argv, *field_str, *tmp_fields, *saved_fields = NULL;
1282 struct synth_field *field, *fields[SYNTH_FIELDS_MAX];
1283 int consumed, cmd_version = 1, n_fields_this_loop;
1284 int i, argc, n_fields = 0, ret = 0;
1285 struct synth_event *event = NULL;
1289 * - Add synthetic event: <event_name> field[;field] ...
1290 * - Remove synthetic event: !<event_name> field[;field] ...
1291 * where 'field' = type field_name
1294 if (name[0] == '\0') {
1295 synth_err(SYNTH_ERR_INVALID_CMD, 0);
1299 if (!is_good_name(name)) {
1300 synth_err(SYNTH_ERR_BAD_NAME, errpos(name));
1304 mutex_lock(&event_mutex);
1306 event = find_synth_event(name);
1308 synth_err(SYNTH_ERR_EVENT_EXISTS, errpos(name));
1313 tmp_fields = saved_fields = kstrdup(raw_fields, GFP_KERNEL);
1319 while ((field_str = strsep(&tmp_fields, ";")) != NULL) {
1320 argv = argv_split(GFP_KERNEL, field_str, &argc);
1331 n_fields_this_loop = 0;
1333 while (argc > consumed) {
1336 field = parse_synth_field(argc - consumed,
1337 argv + consumed, &consumed,
1339 if (IS_ERR(field)) {
1340 ret = PTR_ERR(field);
1345 * Track the highest version of any field we
1346 * found in the command.
1348 if (field_version > cmd_version)
1349 cmd_version = field_version;
1352 * Now sort out what is and isn't valid for
1353 * each supported version.
1355 * If we see more than 1 field per loop, it
1356 * means we have multiple fields between
1357 * semicolons, and that's something we no
1358 * longer support in a version 2 or greater
1361 if (cmd_version > 1 && n_fields_this_loop >= 1) {
1362 synth_err(SYNTH_ERR_INVALID_CMD, errpos(field_str));
1367 if (n_fields == SYNTH_FIELDS_MAX) {
1368 synth_err(SYNTH_ERR_TOO_MANY_FIELDS, 0);
1372 fields[n_fields++] = field;
1374 n_fields_this_loop++;
1378 if (consumed < argc) {
1379 synth_err(SYNTH_ERR_INVALID_CMD, 0);
1386 if (n_fields == 0) {
1387 synth_err(SYNTH_ERR_INVALID_CMD, 0);
1392 event = alloc_synth_event(name, n_fields, fields);
1393 if (IS_ERR(event)) {
1394 ret = PTR_ERR(event);
1398 ret = register_synth_event(event);
1400 dyn_event_add(&event->devent, &event->call);
1402 free_synth_event(event);
1404 mutex_unlock(&event_mutex);
1406 kfree(saved_fields);
1412 for (i = 0; i < n_fields; i++)
1413 free_synth_field(fields[i]);
1419 * synth_event_create - Create a new synthetic event
1420 * @name: The name of the new synthetic event
1421 * @fields: An array of type/name field descriptions
1422 * @n_fields: The number of field descriptions contained in the fields array
1423 * @mod: The module creating the event, NULL if not created from a module
1425 * Create a new synthetic event with the given name under the
1426 * trace/events/synthetic/ directory. The event fields that will be
1427 * defined for the event should be passed in as an array of struct
1428 * synth_field_desc, and the number elements in the array passed in as
1429 * n_fields. Field ordering will retain the ordering given in the
1432 * If the new synthetic event is being created from a module, the mod
1433 * param must be non-NULL. This will ensure that the trace buffer
1434 * won't contain unreadable events.
1436 * The new synth event should be deleted using synth_event_delete()
1437 * function. The new synthetic event can be generated from modules or
1438 * other kernel code using trace_synth_event() and related functions.
1440 * Return: 0 if successful, error otherwise.
1442 int synth_event_create(const char *name, struct synth_field_desc *fields,
1443 unsigned int n_fields, struct module *mod)
1445 struct dynevent_cmd cmd;
1449 buf = kzalloc(MAX_DYNEVENT_CMD_LEN, GFP_KERNEL);
1453 synth_event_cmd_init(&cmd, buf, MAX_DYNEVENT_CMD_LEN);
1455 ret = synth_event_gen_cmd_array_start(&cmd, name, mod,
1460 ret = synth_event_gen_cmd_end(&cmd);
1466 EXPORT_SYMBOL_GPL(synth_event_create);
1468 static int destroy_synth_event(struct synth_event *se)
1475 if (trace_event_dyn_busy(&se->call))
1478 ret = unregister_synth_event(se);
1480 dyn_event_remove(&se->devent);
1481 free_synth_event(se);
1488 * synth_event_delete - Delete a synthetic event
1489 * @event_name: The name of the new synthetic event
1491 * Delete a synthetic event that was created with synth_event_create().
1493 * Return: 0 if successful, error otherwise.
1495 int synth_event_delete(const char *event_name)
1497 struct synth_event *se = NULL;
1498 struct module *mod = NULL;
1501 mutex_lock(&event_mutex);
1502 se = find_synth_event(event_name);
1505 ret = destroy_synth_event(se);
1507 mutex_unlock(&event_mutex);
1511 * It is safest to reset the ring buffer if the module
1512 * being unloaded registered any events that were
1513 * used. The only worry is if a new module gets
1514 * loaded, and takes on the same id as the events of
1515 * this module. When printing out the buffer, traced
1516 * events left over from this module may be passed to
1517 * the new module events and unexpected results may
1520 tracing_reset_all_online_cpus();
1525 EXPORT_SYMBOL_GPL(synth_event_delete);
1527 static int check_command(const char *raw_command)
1529 char **argv = NULL, *cmd, *saved_cmd, *name_and_field;
1532 cmd = saved_cmd = kstrdup(raw_command, GFP_KERNEL);
1536 name_and_field = strsep(&cmd, ";");
1537 if (!name_and_field) {
1542 if (name_and_field[0] == '!')
1545 argv = argv_split(GFP_KERNEL, name_and_field, &argc);
1560 static int create_or_delete_synth_event(const char *raw_command)
1562 char *name = NULL, *fields, *p;
1565 raw_command = skip_spaces(raw_command);
1566 if (raw_command[0] == '\0')
1569 last_cmd_set(raw_command);
1571 ret = check_command(raw_command);
1573 synth_err(SYNTH_ERR_INVALID_CMD, 0);
1577 p = strpbrk(raw_command, " \t");
1578 if (!p && raw_command[0] != '!') {
1579 synth_err(SYNTH_ERR_INVALID_CMD, 0);
1584 name = kmemdup_nul(raw_command, p ? p - raw_command : strlen(raw_command), GFP_KERNEL);
1588 if (name[0] == '!') {
1589 ret = synth_event_delete(name + 1);
1593 fields = skip_spaces(p);
1595 ret = __create_synth_event(name, fields);
1602 static int synth_event_run_command(struct dynevent_cmd *cmd)
1604 struct synth_event *se;
1607 ret = create_or_delete_synth_event(cmd->seq.buffer);
1611 se = find_synth_event(cmd->event_name);
1615 se->mod = cmd->private_data;
1621 * synth_event_cmd_init - Initialize a synthetic event command object
1622 * @cmd: A pointer to the dynevent_cmd struct representing the new event
1623 * @buf: A pointer to the buffer used to build the command
1624 * @maxlen: The length of the buffer passed in @buf
1626 * Initialize a synthetic event command object. Use this before
1627 * calling any of the other dyenvent_cmd functions.
1629 void synth_event_cmd_init(struct dynevent_cmd *cmd, char *buf, int maxlen)
1631 dynevent_cmd_init(cmd, buf, maxlen, DYNEVENT_TYPE_SYNTH,
1632 synth_event_run_command);
1634 EXPORT_SYMBOL_GPL(synth_event_cmd_init);
1637 __synth_event_trace_init(struct trace_event_file *file,
1638 struct synth_event_trace_state *trace_state)
1642 memset(trace_state, '\0', sizeof(*trace_state));
1645 * Normal event tracing doesn't get called at all unless the
1646 * ENABLED bit is set (which attaches the probe thus allowing
1647 * this code to be called, etc). Because this is called
1648 * directly by the user, we don't have that but we still need
1649 * to honor not logging when disabled. For the iterated
1650 * trace case, we save the enabled state upon start and just
1651 * ignore the following data calls.
1653 if (!(file->flags & EVENT_FILE_FL_ENABLED) ||
1654 trace_trigger_soft_disabled(file)) {
1655 trace_state->disabled = true;
1660 trace_state->event = file->event_call->data;
1666 __synth_event_trace_start(struct trace_event_file *file,
1667 struct synth_event_trace_state *trace_state,
1668 int dynamic_fields_size)
1670 int entry_size, fields_size = 0;
1673 fields_size = trace_state->event->n_u64 * sizeof(u64);
1674 fields_size += dynamic_fields_size;
1677 * Avoid ring buffer recursion detection, as this event
1678 * is being performed within another event.
1680 trace_state->buffer = file->tr->array_buffer.buffer;
1681 ring_buffer_nest_start(trace_state->buffer);
1683 entry_size = sizeof(*trace_state->entry) + fields_size;
1684 trace_state->entry = trace_event_buffer_reserve(&trace_state->fbuffer,
1687 if (!trace_state->entry) {
1688 ring_buffer_nest_end(trace_state->buffer);
1696 __synth_event_trace_end(struct synth_event_trace_state *trace_state)
1698 trace_event_buffer_commit(&trace_state->fbuffer);
1700 ring_buffer_nest_end(trace_state->buffer);
1704 * synth_event_trace - Trace a synthetic event
1705 * @file: The trace_event_file representing the synthetic event
1706 * @n_vals: The number of values in vals
1707 * @args: Variable number of args containing the event values
1709 * Trace a synthetic event using the values passed in the variable
1712 * The argument list should be a list 'n_vals' u64 values. The number
1713 * of vals must match the number of field in the synthetic event, and
1714 * must be in the same order as the synthetic event fields.
1716 * All vals should be cast to u64, and string vals are just pointers
1717 * to strings, cast to u64. Strings will be copied into space
1718 * reserved in the event for the string, using these pointers.
1720 * Return: 0 on success, err otherwise.
1722 int synth_event_trace(struct trace_event_file *file, unsigned int n_vals, ...)
1724 unsigned int i, n_u64, len, data_size = 0;
1725 struct synth_event_trace_state state;
1729 ret = __synth_event_trace_init(file, &state);
1732 ret = 0; /* just disabled, not really an error */
1736 if (state.event->n_dynamic_fields) {
1737 va_start(args, n_vals);
1739 for (i = 0; i < state.event->n_fields; i++) {
1740 u64 val = va_arg(args, u64);
1742 if (state.event->fields[i]->is_string &&
1743 state.event->fields[i]->is_dynamic) {
1744 char *str_val = (char *)(long)val;
1746 data_size += strlen(str_val) + 1;
1753 ret = __synth_event_trace_start(file, &state, data_size);
1757 if (n_vals != state.event->n_fields) {
1764 va_start(args, n_vals);
1765 for (i = 0, n_u64 = 0; i < state.event->n_fields; i++) {
1768 val = va_arg(args, u64);
1770 if (state.event->fields[i]->is_string) {
1771 char *str_val = (char *)(long)val;
1773 len = trace_string(state.entry, state.event, str_val,
1774 state.event->fields[i]->is_dynamic,
1776 data_size += len; /* only dynamic string increments */
1778 struct synth_field *field = state.event->fields[i];
1780 switch (field->size) {
1782 *(u8 *)&state.entry->fields[n_u64] = (u8)val;
1786 *(u16 *)&state.entry->fields[n_u64] = (u16)val;
1790 *(u32 *)&state.entry->fields[n_u64] = (u32)val;
1794 state.entry->fields[n_u64] = val;
1802 __synth_event_trace_end(&state);
1806 EXPORT_SYMBOL_GPL(synth_event_trace);
1809 * synth_event_trace_array - Trace a synthetic event from an array
1810 * @file: The trace_event_file representing the synthetic event
1811 * @vals: Array of values
1812 * @n_vals: The number of values in vals
1814 * Trace a synthetic event using the values passed in as 'vals'.
1816 * The 'vals' array is just an array of 'n_vals' u64. The number of
1817 * vals must match the number of field in the synthetic event, and
1818 * must be in the same order as the synthetic event fields.
1820 * All vals should be cast to u64, and string vals are just pointers
1821 * to strings, cast to u64. Strings will be copied into space
1822 * reserved in the event for the string, using these pointers.
1824 * Return: 0 on success, err otherwise.
1826 int synth_event_trace_array(struct trace_event_file *file, u64 *vals,
1827 unsigned int n_vals)
1829 unsigned int i, n_u64, field_pos, len, data_size = 0;
1830 struct synth_event_trace_state state;
1834 ret = __synth_event_trace_init(file, &state);
1837 ret = 0; /* just disabled, not really an error */
1841 if (state.event->n_dynamic_fields) {
1842 for (i = 0; i < state.event->n_dynamic_fields; i++) {
1843 field_pos = state.event->dynamic_fields[i]->field_pos;
1844 str_val = (char *)(long)vals[field_pos];
1845 len = strlen(str_val) + 1;
1850 ret = __synth_event_trace_start(file, &state, data_size);
1854 if (n_vals != state.event->n_fields) {
1861 for (i = 0, n_u64 = 0; i < state.event->n_fields; i++) {
1862 if (state.event->fields[i]->is_string) {
1863 char *str_val = (char *)(long)vals[i];
1865 len = trace_string(state.entry, state.event, str_val,
1866 state.event->fields[i]->is_dynamic,
1868 data_size += len; /* only dynamic string increments */
1870 struct synth_field *field = state.event->fields[i];
1873 switch (field->size) {
1875 *(u8 *)&state.entry->fields[n_u64] = (u8)val;
1879 *(u16 *)&state.entry->fields[n_u64] = (u16)val;
1883 *(u32 *)&state.entry->fields[n_u64] = (u32)val;
1887 state.entry->fields[n_u64] = val;
1894 __synth_event_trace_end(&state);
1898 EXPORT_SYMBOL_GPL(synth_event_trace_array);
1901 * synth_event_trace_start - Start piecewise synthetic event trace
1902 * @file: The trace_event_file representing the synthetic event
1903 * @trace_state: A pointer to object tracking the piecewise trace state
1905 * Start the trace of a synthetic event field-by-field rather than all
1908 * This function 'opens' an event trace, which means space is reserved
1909 * for the event in the trace buffer, after which the event's
1910 * individual field values can be set through either
1911 * synth_event_add_next_val() or synth_event_add_val().
1913 * A pointer to a trace_state object is passed in, which will keep
1914 * track of the current event trace state until the event trace is
1915 * closed (and the event finally traced) using
1916 * synth_event_trace_end().
1918 * Note that synth_event_trace_end() must be called after all values
1919 * have been added for each event trace, regardless of whether adding
1920 * all field values succeeded or not.
1922 * Note also that for a given event trace, all fields must be added
1923 * using either synth_event_add_next_val() or synth_event_add_val()
1924 * but not both together or interleaved.
1926 * Return: 0 on success, err otherwise.
1928 int synth_event_trace_start(struct trace_event_file *file,
1929 struct synth_event_trace_state *trace_state)
1936 ret = __synth_event_trace_init(file, trace_state);
1939 ret = 0; /* just disabled, not really an error */
1943 if (trace_state->event->n_dynamic_fields)
1946 ret = __synth_event_trace_start(file, trace_state, 0);
1950 EXPORT_SYMBOL_GPL(synth_event_trace_start);
1952 static int __synth_event_add_val(const char *field_name, u64 val,
1953 struct synth_event_trace_state *trace_state)
1955 struct synth_field *field = NULL;
1956 struct synth_trace_event *entry;
1957 struct synth_event *event;
1965 /* can't mix add_next_synth_val() with add_synth_val() */
1967 if (trace_state->add_next) {
1971 trace_state->add_name = true;
1973 if (trace_state->add_name) {
1977 trace_state->add_next = true;
1980 if (trace_state->disabled)
1983 event = trace_state->event;
1984 if (trace_state->add_name) {
1985 for (i = 0; i < event->n_fields; i++) {
1986 field = event->fields[i];
1987 if (strcmp(field->name, field_name) == 0)
1995 if (trace_state->cur_field >= event->n_fields) {
1999 field = event->fields[trace_state->cur_field++];
2002 entry = trace_state->entry;
2003 if (field->is_string) {
2004 char *str_val = (char *)(long)val;
2007 if (field->is_dynamic) { /* add_val can't do dynamic strings */
2017 str_field = (char *)&entry->fields[field->offset];
2018 strscpy(str_field, str_val, STR_VAR_LEN_MAX);
2020 switch (field->size) {
2022 *(u8 *)&trace_state->entry->fields[field->offset] = (u8)val;
2026 *(u16 *)&trace_state->entry->fields[field->offset] = (u16)val;
2030 *(u32 *)&trace_state->entry->fields[field->offset] = (u32)val;
2034 trace_state->entry->fields[field->offset] = val;
2043 * synth_event_add_next_val - Add the next field's value to an open synth trace
2044 * @val: The value to set the next field to
2045 * @trace_state: A pointer to object tracking the piecewise trace state
2047 * Set the value of the next field in an event that's been opened by
2048 * synth_event_trace_start().
2050 * The val param should be the value cast to u64. If the value points
2051 * to a string, the val param should be a char * cast to u64.
2053 * This function assumes all the fields in an event are to be set one
2054 * after another - successive calls to this function are made, one for
2055 * each field, in the order of the fields in the event, until all
2056 * fields have been set. If you'd rather set each field individually
2057 * without regard to ordering, synth_event_add_val() can be used
2060 * Note however that synth_event_add_next_val() and
2061 * synth_event_add_val() can't be intermixed for a given event trace -
2062 * one or the other but not both can be used at the same time.
2064 * Note also that synth_event_trace_end() must be called after all
2065 * values have been added for each event trace, regardless of whether
2066 * adding all field values succeeded or not.
2068 * Return: 0 on success, err otherwise.
2070 int synth_event_add_next_val(u64 val,
2071 struct synth_event_trace_state *trace_state)
2073 return __synth_event_add_val(NULL, val, trace_state);
2075 EXPORT_SYMBOL_GPL(synth_event_add_next_val);
2078 * synth_event_add_val - Add a named field's value to an open synth trace
2079 * @field_name: The name of the synthetic event field value to set
2080 * @val: The value to set the named field to
2081 * @trace_state: A pointer to object tracking the piecewise trace state
2083 * Set the value of the named field in an event that's been opened by
2084 * synth_event_trace_start().
2086 * The val param should be the value cast to u64. If the value points
2087 * to a string, the val param should be a char * cast to u64.
2089 * This function looks up the field name, and if found, sets the field
2090 * to the specified value. This lookup makes this function more
2091 * expensive than synth_event_add_next_val(), so use that or the
2092 * none-piecewise synth_event_trace() instead if efficiency is more
2095 * Note however that synth_event_add_next_val() and
2096 * synth_event_add_val() can't be intermixed for a given event trace -
2097 * one or the other but not both can be used at the same time.
2099 * Note also that synth_event_trace_end() must be called after all
2100 * values have been added for each event trace, regardless of whether
2101 * adding all field values succeeded or not.
2103 * Return: 0 on success, err otherwise.
2105 int synth_event_add_val(const char *field_name, u64 val,
2106 struct synth_event_trace_state *trace_state)
2108 return __synth_event_add_val(field_name, val, trace_state);
2110 EXPORT_SYMBOL_GPL(synth_event_add_val);
2113 * synth_event_trace_end - End piecewise synthetic event trace
2114 * @trace_state: A pointer to object tracking the piecewise trace state
2116 * End the trace of a synthetic event opened by
2117 * synth_event_trace__start().
2119 * This function 'closes' an event trace, which basically means that
2120 * it commits the reserved event and cleans up other loose ends.
2122 * A pointer to a trace_state object is passed in, which will keep
2123 * track of the current event trace state opened with
2124 * synth_event_trace_start().
2126 * Note that this function must be called after all values have been
2127 * added for each event trace, regardless of whether adding all field
2128 * values succeeded or not.
2130 * Return: 0 on success, err otherwise.
2132 int synth_event_trace_end(struct synth_event_trace_state *trace_state)
2137 __synth_event_trace_end(trace_state);
2141 EXPORT_SYMBOL_GPL(synth_event_trace_end);
2143 static int create_synth_event(const char *raw_command)
2149 raw_command = skip_spaces(raw_command);
2150 if (raw_command[0] == '\0')
2153 last_cmd_set(raw_command);
2157 /* Don't try to process if not our system */
2158 if (name[0] != 's' || name[1] != ':')
2162 p = strpbrk(raw_command, " \t");
2164 synth_err(SYNTH_ERR_INVALID_CMD, 0);
2168 fields = skip_spaces(p);
2170 /* This interface accepts group name prefix */
2171 if (strchr(name, '/')) {
2172 len = str_has_prefix(name, SYNTH_SYSTEM "/");
2174 synth_err(SYNTH_ERR_INVALID_DYN_CMD, 0);
2180 len = name - raw_command;
2182 ret = check_command(raw_command + len);
2184 synth_err(SYNTH_ERR_INVALID_CMD, 0);
2188 name = kmemdup_nul(raw_command + len, p - raw_command - len, GFP_KERNEL);
2192 ret = __create_synth_event(name, fields);
2199 static int synth_event_release(struct dyn_event *ev)
2201 struct synth_event *event = to_synth_event(ev);
2207 if (trace_event_dyn_busy(&event->call))
2210 ret = unregister_synth_event(event);
2214 dyn_event_remove(ev);
2215 free_synth_event(event);
2219 static int __synth_event_show(struct seq_file *m, struct synth_event *event)
2221 struct synth_field *field;
2225 seq_printf(m, "%s\t", event->name);
2227 for (i = 0; i < event->n_fields; i++) {
2228 field = event->fields[i];
2231 t = strstr(type, "__data_loc");
2232 if (t) { /* __data_loc belongs in format but not event desc */
2233 t += sizeof("__data_loc");
2237 /* parameter values */
2238 seq_printf(m, "%s %s%s", type, field->name,
2239 i == event->n_fields - 1 ? "" : "; ");
2247 static int synth_event_show(struct seq_file *m, struct dyn_event *ev)
2249 struct synth_event *event = to_synth_event(ev);
2251 seq_printf(m, "s:%s/", event->class.system);
2253 return __synth_event_show(m, event);
2256 static int synth_events_seq_show(struct seq_file *m, void *v)
2258 struct dyn_event *ev = v;
2260 if (!is_synth_event(ev))
2263 return __synth_event_show(m, to_synth_event(ev));
2266 static const struct seq_operations synth_events_seq_op = {
2267 .start = dyn_event_seq_start,
2268 .next = dyn_event_seq_next,
2269 .stop = dyn_event_seq_stop,
2270 .show = synth_events_seq_show,
2273 static int synth_events_open(struct inode *inode, struct file *file)
2277 ret = security_locked_down(LOCKDOWN_TRACEFS);
2281 if ((file->f_mode & FMODE_WRITE) && (file->f_flags & O_TRUNC)) {
2282 ret = dyn_events_release_all(&synth_event_ops);
2287 return seq_open(file, &synth_events_seq_op);
2290 static ssize_t synth_events_write(struct file *file,
2291 const char __user *buffer,
2292 size_t count, loff_t *ppos)
2294 return trace_parse_run_command(file, buffer, count, ppos,
2295 create_or_delete_synth_event);
2298 static const struct file_operations synth_events_fops = {
2299 .open = synth_events_open,
2300 .write = synth_events_write,
2302 .llseek = seq_lseek,
2303 .release = seq_release,
2307 * Register dynevent at core_initcall. This allows kernel to setup kprobe
2308 * events in postcore_initcall without tracefs.
2310 static __init int trace_events_synth_init_early(void)
2314 err = dyn_event_register(&synth_event_ops);
2316 pr_warn("Could not register synth_event_ops\n");
2320 core_initcall(trace_events_synth_init_early);
2322 static __init int trace_events_synth_init(void)
2324 struct dentry *entry = NULL;
2326 err = tracing_init_dentry();
2330 entry = tracefs_create_file("synthetic_events", TRACE_MODE_WRITE,
2331 NULL, NULL, &synth_events_fops);
2339 pr_warn("Could not create tracefs 'synthetic_events' entry\n");
2344 fs_initcall(trace_events_synth_init);