1726721a5STom Zanussi // SPDX-License-Identifier: GPL-2.0
2726721a5STom Zanussi /*
3726721a5STom Zanussi * trace_events_synth - synthetic trace events
4726721a5STom Zanussi *
5726721a5STom Zanussi * Copyright (C) 2015, 2020 Tom Zanussi <tom.zanussi@linux.intel.com>
6726721a5STom Zanussi */
7726721a5STom Zanussi
8726721a5STom Zanussi #include <linux/module.h>
9726721a5STom Zanussi #include <linux/kallsyms.h>
10726721a5STom Zanussi #include <linux/security.h>
11726721a5STom Zanussi #include <linux/mutex.h>
12726721a5STom Zanussi #include <linux/slab.h>
13726721a5STom Zanussi #include <linux/stacktrace.h>
14726721a5STom Zanussi #include <linux/rculist.h>
15726721a5STom Zanussi #include <linux/tracefs.h>
16726721a5STom Zanussi
17726721a5STom Zanussi /* for gfp flag names */
18726721a5STom Zanussi #include <linux/trace_events.h>
19726721a5STom Zanussi #include <trace/events/mmflags.h>
200934ae99SSteven Rostedt (Google) #include "trace_probe.h"
210934ae99SSteven Rostedt (Google) #include "trace_probe_kernel.h"
22726721a5STom Zanussi
23726721a5STom Zanussi #include "trace_synth.h"
24726721a5STom Zanussi
25d4d70463STom Zanussi #undef ERRORS
26d4d70463STom Zanussi #define ERRORS \
27d4d70463STom Zanussi C(BAD_NAME, "Illegal name"), \
288d3e8165STom Zanussi C(INVALID_CMD, "Command must be of the form: <name> field[;field] ..."),\
298d3e8165STom Zanussi C(INVALID_DYN_CMD, "Command must be of the form: s or -:[synthetic/]<name> field[;field] ..."),\
30d4d70463STom Zanussi C(EVENT_EXISTS, "Event already exists"), \
31d4d70463STom Zanussi C(TOO_MANY_FIELDS, "Too many fields"), \
32d4d70463STom Zanussi C(INCOMPLETE_TYPE, "Incomplete type"), \
33d4d70463STom Zanussi C(INVALID_TYPE, "Invalid type"), \
34d4d70463STom Zanussi C(INVALID_FIELD, "Invalid field"), \
358d3e8165STom Zanussi C(INVALID_ARRAY_SPEC, "Invalid array specification"),
36d4d70463STom Zanussi
37d4d70463STom Zanussi #undef C
38d4d70463STom Zanussi #define C(a, b) SYNTH_ERR_##a
39d4d70463STom Zanussi
40d4d70463STom Zanussi enum { ERRORS };
41d4d70463STom Zanussi
42d4d70463STom Zanussi #undef C
43d4d70463STom Zanussi #define C(a, b) b
44d4d70463STom Zanussi
45d4d70463STom Zanussi static const char *err_text[] = { ERRORS };
46d4d70463STom Zanussi
4731c68396SSteven Rostedt (Google) static DEFINE_MUTEX(lastcmd_mutex);
4827c888daSTom Zanussi static char *last_cmd;
49d4d70463STom Zanussi
errpos(const char * str)50d4d70463STom Zanussi static int errpos(const char *str)
51d4d70463STom Zanussi {
524ccf11c4STze-nan Wu int ret = 0;
5327c888daSTom Zanussi
544ccf11c4STze-nan Wu mutex_lock(&lastcmd_mutex);
554ccf11c4STze-nan Wu if (!str || !last_cmd)
564ccf11c4STze-nan Wu goto out;
574ccf11c4STze-nan Wu
584ccf11c4STze-nan Wu ret = err_pos(last_cmd, str);
594ccf11c4STze-nan Wu out:
604ccf11c4STze-nan Wu mutex_unlock(&lastcmd_mutex);
614ccf11c4STze-nan Wu return ret;
62d4d70463STom Zanussi }
63d4d70463STom Zanussi
last_cmd_set(const char * str)64c9e759b1STom Zanussi static void last_cmd_set(const char *str)
65d4d70463STom Zanussi {
66d4d70463STom Zanussi if (!str)
67d4d70463STom Zanussi return;
68d4d70463STom Zanussi
694ccf11c4STze-nan Wu mutex_lock(&lastcmd_mutex);
7027c888daSTom Zanussi kfree(last_cmd);
719f438d4dSTom Zanussi last_cmd = kstrdup(str, GFP_KERNEL);
724ccf11c4STze-nan Wu mutex_unlock(&lastcmd_mutex);
73d4d70463STom Zanussi }
74d4d70463STom Zanussi
synth_err(u8 err_type,u16 err_pos)7527c888daSTom Zanussi static void synth_err(u8 err_type, u16 err_pos)
76d4d70463STom Zanussi {
774ccf11c4STze-nan Wu mutex_lock(&lastcmd_mutex);
7827c888daSTom Zanussi if (!last_cmd)
794ccf11c4STze-nan Wu goto out;
8027c888daSTom Zanussi
81d4d70463STom Zanussi tracing_log_err(NULL, "synthetic_events", last_cmd, err_text,
82d4d70463STom Zanussi err_type, err_pos);
834ccf11c4STze-nan Wu out:
844ccf11c4STze-nan Wu mutex_unlock(&lastcmd_mutex);
85d4d70463STom Zanussi }
86d4d70463STom Zanussi
87d262271dSMasami Hiramatsu static int create_synth_event(const char *raw_command);
88726721a5STom Zanussi static int synth_event_show(struct seq_file *m, struct dyn_event *ev);
89726721a5STom Zanussi static int synth_event_release(struct dyn_event *ev);
90726721a5STom Zanussi static bool synth_event_is_busy(struct dyn_event *ev);
91726721a5STom Zanussi static bool synth_event_match(const char *system, const char *event,
92726721a5STom Zanussi int argc, const char **argv, struct dyn_event *ev);
93726721a5STom Zanussi
94726721a5STom Zanussi static struct dyn_event_operations synth_event_ops = {
95726721a5STom Zanussi .create = create_synth_event,
96726721a5STom Zanussi .show = synth_event_show,
97726721a5STom Zanussi .is_busy = synth_event_is_busy,
98726721a5STom Zanussi .free = synth_event_release,
99726721a5STom Zanussi .match = synth_event_match,
100726721a5STom Zanussi };
101726721a5STom Zanussi
is_synth_event(struct dyn_event * ev)102726721a5STom Zanussi static bool is_synth_event(struct dyn_event *ev)
103726721a5STom Zanussi {
104726721a5STom Zanussi return ev->ops == &synth_event_ops;
105726721a5STom Zanussi }
106726721a5STom Zanussi
to_synth_event(struct dyn_event * ev)107726721a5STom Zanussi static struct synth_event *to_synth_event(struct dyn_event *ev)
108726721a5STom Zanussi {
109726721a5STom Zanussi return container_of(ev, struct synth_event, devent);
110726721a5STom Zanussi }
111726721a5STom Zanussi
synth_event_is_busy(struct dyn_event * ev)112726721a5STom Zanussi static bool synth_event_is_busy(struct dyn_event *ev)
113726721a5STom Zanussi {
114726721a5STom Zanussi struct synth_event *event = to_synth_event(ev);
115726721a5STom Zanussi
116726721a5STom Zanussi return event->ref != 0;
117726721a5STom Zanussi }
118726721a5STom Zanussi
synth_event_match(const char * system,const char * event,int argc,const char ** argv,struct dyn_event * ev)119726721a5STom Zanussi static bool synth_event_match(const char *system, const char *event,
120726721a5STom Zanussi int argc, const char **argv, struct dyn_event *ev)
121726721a5STom Zanussi {
122726721a5STom Zanussi struct synth_event *sev = to_synth_event(ev);
123726721a5STom Zanussi
124726721a5STom Zanussi return strcmp(sev->name, event) == 0 &&
125726721a5STom Zanussi (!system || strcmp(system, SYNTH_SYSTEM) == 0);
126726721a5STom Zanussi }
127726721a5STom Zanussi
128726721a5STom Zanussi struct synth_trace_event {
129726721a5STom Zanussi struct trace_entry ent;
130ddeea494SSven Schnelle union trace_synth_field fields[];
131726721a5STom Zanussi };
132726721a5STom Zanussi
synth_event_define_fields(struct trace_event_call * call)133726721a5STom Zanussi static int synth_event_define_fields(struct trace_event_call *call)
134726721a5STom Zanussi {
135726721a5STom Zanussi struct synth_trace_event trace;
136726721a5STom Zanussi int offset = offsetof(typeof(trace), fields);
137726721a5STom Zanussi struct synth_event *event = call->data;
138726721a5STom Zanussi unsigned int i, size, n_u64;
139726721a5STom Zanussi char *name, *type;
140726721a5STom Zanussi bool is_signed;
141726721a5STom Zanussi int ret = 0;
142726721a5STom Zanussi
143726721a5STom Zanussi for (i = 0, n_u64 = 0; i < event->n_fields; i++) {
144726721a5STom Zanussi size = event->fields[i]->size;
145726721a5STom Zanussi is_signed = event->fields[i]->is_signed;
146726721a5STom Zanussi type = event->fields[i]->type;
147726721a5STom Zanussi name = event->fields[i]->name;
148726721a5STom Zanussi ret = trace_define_field(call, type, name, offset, size,
149726721a5STom Zanussi is_signed, FILTER_OTHER);
150726721a5STom Zanussi if (ret)
151726721a5STom Zanussi break;
152726721a5STom Zanussi
153726721a5STom Zanussi event->fields[i]->offset = n_u64;
154726721a5STom Zanussi
155bd82631dSTom Zanussi if (event->fields[i]->is_string && !event->fields[i]->is_dynamic) {
156726721a5STom Zanussi offset += STR_VAR_LEN_MAX;
157726721a5STom Zanussi n_u64 += STR_VAR_LEN_MAX / sizeof(u64);
158726721a5STom Zanussi } else {
159726721a5STom Zanussi offset += sizeof(u64);
160726721a5STom Zanussi n_u64++;
161726721a5STom Zanussi }
162726721a5STom Zanussi }
163726721a5STom Zanussi
164726721a5STom Zanussi event->n_u64 = n_u64;
165726721a5STom Zanussi
166726721a5STom Zanussi return ret;
167726721a5STom Zanussi }
168726721a5STom Zanussi
synth_field_signed(char * type)169726721a5STom Zanussi static bool synth_field_signed(char *type)
170726721a5STom Zanussi {
171726721a5STom Zanussi if (str_has_prefix(type, "u"))
172726721a5STom Zanussi return false;
173726721a5STom Zanussi if (strcmp(type, "gfp_t") == 0)
174726721a5STom Zanussi return false;
175726721a5STom Zanussi
176726721a5STom Zanussi return true;
177726721a5STom Zanussi }
178726721a5STom Zanussi
synth_field_is_string(char * type)179726721a5STom Zanussi static int synth_field_is_string(char *type)
180726721a5STom Zanussi {
181726721a5STom Zanussi if (strstr(type, "char[") != NULL)
182726721a5STom Zanussi return true;
183726721a5STom Zanussi
184726721a5STom Zanussi return false;
185726721a5STom Zanussi }
186726721a5STom Zanussi
synth_field_is_stack(char * type)18700cf3d67SSteven Rostedt (Google) static int synth_field_is_stack(char *type)
18800cf3d67SSteven Rostedt (Google) {
18900cf3d67SSteven Rostedt (Google) if (strstr(type, "long[") != NULL)
19000cf3d67SSteven Rostedt (Google) return true;
19100cf3d67SSteven Rostedt (Google)
19200cf3d67SSteven Rostedt (Google) return false;
19300cf3d67SSteven Rostedt (Google) }
19400cf3d67SSteven Rostedt (Google)
synth_field_string_size(char * type)195726721a5STom Zanussi static int synth_field_string_size(char *type)
196726721a5STom Zanussi {
197726721a5STom Zanussi char buf[4], *end, *start;
198726721a5STom Zanussi unsigned int len;
199726721a5STom Zanussi int size, err;
200726721a5STom Zanussi
201726721a5STom Zanussi start = strstr(type, "char[");
202726721a5STom Zanussi if (start == NULL)
203726721a5STom Zanussi return -EINVAL;
204726721a5STom Zanussi start += sizeof("char[") - 1;
205726721a5STom Zanussi
206726721a5STom Zanussi end = strchr(type, ']');
20710819e25STom Zanussi if (!end || end < start || type + strlen(type) > end + 1)
208726721a5STom Zanussi return -EINVAL;
209726721a5STom Zanussi
210726721a5STom Zanussi len = end - start;
211726721a5STom Zanussi if (len > 3)
212726721a5STom Zanussi return -EINVAL;
213726721a5STom Zanussi
214bd82631dSTom Zanussi if (len == 0)
215bd82631dSTom Zanussi return 0; /* variable-length string */
216bd82631dSTom Zanussi
217726721a5STom Zanussi strncpy(buf, start, len);
218726721a5STom Zanussi buf[len] = '\0';
219726721a5STom Zanussi
220726721a5STom Zanussi err = kstrtouint(buf, 0, &size);
221726721a5STom Zanussi if (err)
222726721a5STom Zanussi return err;
223726721a5STom Zanussi
224726721a5STom Zanussi if (size > STR_VAR_LEN_MAX)
225726721a5STom Zanussi return -EINVAL;
226726721a5STom Zanussi
227726721a5STom Zanussi return size;
228726721a5STom Zanussi }
229726721a5STom Zanussi
synth_field_size(char * type)230726721a5STom Zanussi static int synth_field_size(char *type)
231726721a5STom Zanussi {
232726721a5STom Zanussi int size = 0;
233726721a5STom Zanussi
234726721a5STom Zanussi if (strcmp(type, "s64") == 0)
235726721a5STom Zanussi size = sizeof(s64);
236726721a5STom Zanussi else if (strcmp(type, "u64") == 0)
237726721a5STom Zanussi size = sizeof(u64);
238726721a5STom Zanussi else if (strcmp(type, "s32") == 0)
239726721a5STom Zanussi size = sizeof(s32);
240726721a5STom Zanussi else if (strcmp(type, "u32") == 0)
241726721a5STom Zanussi size = sizeof(u32);
242726721a5STom Zanussi else if (strcmp(type, "s16") == 0)
243726721a5STom Zanussi size = sizeof(s16);
244726721a5STom Zanussi else if (strcmp(type, "u16") == 0)
245726721a5STom Zanussi size = sizeof(u16);
246726721a5STom Zanussi else if (strcmp(type, "s8") == 0)
247726721a5STom Zanussi size = sizeof(s8);
248726721a5STom Zanussi else if (strcmp(type, "u8") == 0)
249726721a5STom Zanussi size = sizeof(u8);
250726721a5STom Zanussi else if (strcmp(type, "char") == 0)
251726721a5STom Zanussi size = sizeof(char);
252726721a5STom Zanussi else if (strcmp(type, "unsigned char") == 0)
253726721a5STom Zanussi size = sizeof(unsigned char);
254726721a5STom Zanussi else if (strcmp(type, "int") == 0)
255726721a5STom Zanussi size = sizeof(int);
256726721a5STom Zanussi else if (strcmp(type, "unsigned int") == 0)
257726721a5STom Zanussi size = sizeof(unsigned int);
258726721a5STom Zanussi else if (strcmp(type, "long") == 0)
259726721a5STom Zanussi size = sizeof(long);
260726721a5STom Zanussi else if (strcmp(type, "unsigned long") == 0)
261726721a5STom Zanussi size = sizeof(unsigned long);
2626107742dSAxel Rasmussen else if (strcmp(type, "bool") == 0)
2636107742dSAxel Rasmussen size = sizeof(bool);
264726721a5STom Zanussi else if (strcmp(type, "pid_t") == 0)
265726721a5STom Zanussi size = sizeof(pid_t);
266726721a5STom Zanussi else if (strcmp(type, "gfp_t") == 0)
267726721a5STom Zanussi size = sizeof(gfp_t);
268726721a5STom Zanussi else if (synth_field_is_string(type))
269726721a5STom Zanussi size = synth_field_string_size(type);
27000cf3d67SSteven Rostedt (Google) else if (synth_field_is_stack(type))
27100cf3d67SSteven Rostedt (Google) size = 0;
272726721a5STom Zanussi
273726721a5STom Zanussi return size;
274726721a5STom Zanussi }
275726721a5STom Zanussi
synth_field_fmt(char * type)276726721a5STom Zanussi static const char *synth_field_fmt(char *type)
277726721a5STom Zanussi {
278726721a5STom Zanussi const char *fmt = "%llu";
279726721a5STom Zanussi
280726721a5STom Zanussi if (strcmp(type, "s64") == 0)
281726721a5STom Zanussi fmt = "%lld";
282726721a5STom Zanussi else if (strcmp(type, "u64") == 0)
283726721a5STom Zanussi fmt = "%llu";
284726721a5STom Zanussi else if (strcmp(type, "s32") == 0)
285726721a5STom Zanussi fmt = "%d";
286726721a5STom Zanussi else if (strcmp(type, "u32") == 0)
287726721a5STom Zanussi fmt = "%u";
288726721a5STom Zanussi else if (strcmp(type, "s16") == 0)
289726721a5STom Zanussi fmt = "%d";
290726721a5STom Zanussi else if (strcmp(type, "u16") == 0)
291726721a5STom Zanussi fmt = "%u";
292726721a5STom Zanussi else if (strcmp(type, "s8") == 0)
293726721a5STom Zanussi fmt = "%d";
294726721a5STom Zanussi else if (strcmp(type, "u8") == 0)
295726721a5STom Zanussi fmt = "%u";
296726721a5STom Zanussi else if (strcmp(type, "char") == 0)
297726721a5STom Zanussi fmt = "%d";
298726721a5STom Zanussi else if (strcmp(type, "unsigned char") == 0)
299726721a5STom Zanussi fmt = "%u";
300726721a5STom Zanussi else if (strcmp(type, "int") == 0)
301726721a5STom Zanussi fmt = "%d";
302726721a5STom Zanussi else if (strcmp(type, "unsigned int") == 0)
303726721a5STom Zanussi fmt = "%u";
304726721a5STom Zanussi else if (strcmp(type, "long") == 0)
305726721a5STom Zanussi fmt = "%ld";
306726721a5STom Zanussi else if (strcmp(type, "unsigned long") == 0)
307726721a5STom Zanussi fmt = "%lu";
3086107742dSAxel Rasmussen else if (strcmp(type, "bool") == 0)
3096107742dSAxel Rasmussen fmt = "%d";
310726721a5STom Zanussi else if (strcmp(type, "pid_t") == 0)
311726721a5STom Zanussi fmt = "%d";
312726721a5STom Zanussi else if (strcmp(type, "gfp_t") == 0)
313726721a5STom Zanussi fmt = "%x";
314726721a5STom Zanussi else if (synth_field_is_string(type))
3158db4d6bfSSteven Rostedt (VMware) fmt = "%.*s";
31600cf3d67SSteven Rostedt (Google) else if (synth_field_is_stack(type))
31700cf3d67SSteven Rostedt (Google) fmt = "%s";
318726721a5STom Zanussi
319726721a5STom Zanussi return fmt;
320726721a5STom Zanussi }
321726721a5STom Zanussi
print_synth_event_num_val(struct trace_seq * s,char * print_fmt,char * name,int size,union trace_synth_field * val,char * space)322726721a5STom Zanussi static void print_synth_event_num_val(struct trace_seq *s,
323726721a5STom Zanussi char *print_fmt, char *name,
324ddeea494SSven Schnelle int size, union trace_synth_field *val, char *space)
325726721a5STom Zanussi {
326726721a5STom Zanussi switch (size) {
327726721a5STom Zanussi case 1:
328ddeea494SSven Schnelle trace_seq_printf(s, print_fmt, name, val->as_u8, space);
329726721a5STom Zanussi break;
330726721a5STom Zanussi
331726721a5STom Zanussi case 2:
332ddeea494SSven Schnelle trace_seq_printf(s, print_fmt, name, val->as_u16, space);
333726721a5STom Zanussi break;
334726721a5STom Zanussi
335726721a5STom Zanussi case 4:
336ddeea494SSven Schnelle trace_seq_printf(s, print_fmt, name, val->as_u32, space);
337726721a5STom Zanussi break;
338726721a5STom Zanussi
339726721a5STom Zanussi default:
34062663b84STero Kristo trace_seq_printf(s, print_fmt, name, val->as_u64, space);
341726721a5STom Zanussi break;
342726721a5STom Zanussi }
343726721a5STom Zanussi }
344726721a5STom Zanussi
print_synth_event(struct trace_iterator * iter,int flags,struct trace_event * event)345726721a5STom Zanussi static enum print_line_t print_synth_event(struct trace_iterator *iter,
346726721a5STom Zanussi int flags,
347726721a5STom Zanussi struct trace_event *event)
348726721a5STom Zanussi {
349726721a5STom Zanussi struct trace_array *tr = iter->tr;
350726721a5STom Zanussi struct trace_seq *s = &iter->seq;
351726721a5STom Zanussi struct synth_trace_event *entry;
352726721a5STom Zanussi struct synth_event *se;
353887f92e0SSven Schnelle unsigned int i, j, n_u64;
354726721a5STom Zanussi char print_fmt[32];
355726721a5STom Zanussi const char *fmt;
356726721a5STom Zanussi
357726721a5STom Zanussi entry = (struct synth_trace_event *)iter->ent;
358726721a5STom Zanussi se = container_of(event, struct synth_event, call.event);
359726721a5STom Zanussi
360726721a5STom Zanussi trace_seq_printf(s, "%s: ", se->name);
361726721a5STom Zanussi
362726721a5STom Zanussi for (i = 0, n_u64 = 0; i < se->n_fields; i++) {
363726721a5STom Zanussi if (trace_seq_has_overflowed(s))
364726721a5STom Zanussi goto end;
365726721a5STom Zanussi
366726721a5STom Zanussi fmt = synth_field_fmt(se->fields[i]->type);
367726721a5STom Zanussi
368726721a5STom Zanussi /* parameter types */
369726721a5STom Zanussi if (tr && tr->trace_flags & TRACE_ITER_VERBOSE)
370726721a5STom Zanussi trace_seq_printf(s, "%s ", fmt);
371726721a5STom Zanussi
372726721a5STom Zanussi snprintf(print_fmt, sizeof(print_fmt), "%%s=%s%%s", fmt);
373726721a5STom Zanussi
374726721a5STom Zanussi /* parameter values */
375726721a5STom Zanussi if (se->fields[i]->is_string) {
376bd82631dSTom Zanussi if (se->fields[i]->is_dynamic) {
377ddeea494SSven Schnelle union trace_synth_field *data = &entry->fields[n_u64];
378bd82631dSTom Zanussi
379bd82631dSTom Zanussi trace_seq_printf(s, print_fmt, se->fields[i]->name,
3808db4d6bfSSteven Rostedt (VMware) STR_VAR_LEN_MAX,
381ddeea494SSven Schnelle (char *)entry + data->as_dynamic.offset,
382bd82631dSTom Zanussi i == se->n_fields - 1 ? "" : " ");
383bd82631dSTom Zanussi n_u64++;
384bd82631dSTom Zanussi } else {
385726721a5STom Zanussi trace_seq_printf(s, print_fmt, se->fields[i]->name,
3868db4d6bfSSteven Rostedt (VMware) STR_VAR_LEN_MAX,
387ddeea494SSven Schnelle (char *)&entry->fields[n_u64].as_u64,
388726721a5STom Zanussi i == se->n_fields - 1 ? "" : " ");
389726721a5STom Zanussi n_u64 += STR_VAR_LEN_MAX / sizeof(u64);
390bd82631dSTom Zanussi }
39100cf3d67SSteven Rostedt (Google) } else if (se->fields[i]->is_stack) {
392ddeea494SSven Schnelle union trace_synth_field *data = &entry->fields[n_u64];
393887f92e0SSven Schnelle unsigned long *p = (void *)entry + data->as_dynamic.offset;
39400cf3d67SSteven Rostedt (Google)
39500cf3d67SSteven Rostedt (Google) trace_seq_printf(s, "%s=STACK:\n", se->fields[i]->name);
396887f92e0SSven Schnelle for (j = 1; j < data->as_dynamic.len / sizeof(long); j++)
397887f92e0SSven Schnelle trace_seq_printf(s, "=> %pS\n", (void *)p[j]);
39800cf3d67SSteven Rostedt (Google) n_u64++;
399726721a5STom Zanussi } else {
400726721a5STom Zanussi struct trace_print_flags __flags[] = {
401726721a5STom Zanussi __def_gfpflag_names, {-1, NULL} };
402726721a5STom Zanussi char *space = (i == se->n_fields - 1 ? "" : " ");
403726721a5STom Zanussi
404726721a5STom Zanussi print_synth_event_num_val(s, print_fmt,
405726721a5STom Zanussi se->fields[i]->name,
406726721a5STom Zanussi se->fields[i]->size,
407ddeea494SSven Schnelle &entry->fields[n_u64],
408726721a5STom Zanussi space);
409726721a5STom Zanussi
410726721a5STom Zanussi if (strcmp(se->fields[i]->type, "gfp_t") == 0) {
411726721a5STom Zanussi trace_seq_puts(s, " (");
412726721a5STom Zanussi trace_print_flags_seq(s, "|",
413ddeea494SSven Schnelle entry->fields[n_u64].as_u64,
414726721a5STom Zanussi __flags);
415726721a5STom Zanussi trace_seq_putc(s, ')');
416726721a5STom Zanussi }
417726721a5STom Zanussi n_u64++;
418726721a5STom Zanussi }
419726721a5STom Zanussi }
420726721a5STom Zanussi end:
421726721a5STom Zanussi trace_seq_putc(s, '\n');
422726721a5STom Zanussi
423726721a5STom Zanussi return trace_handle_return(s);
424726721a5STom Zanussi }
425726721a5STom Zanussi
426726721a5STom Zanussi static struct trace_event_functions synth_event_funcs = {
427726721a5STom Zanussi .trace = print_synth_event
428726721a5STom Zanussi };
429726721a5STom Zanussi
trace_string(struct synth_trace_event * entry,struct synth_event * event,char * str_val,bool is_dynamic,unsigned int data_size,unsigned int * n_u64)430bd82631dSTom Zanussi static unsigned int trace_string(struct synth_trace_event *entry,
431bd82631dSTom Zanussi struct synth_event *event,
432bd82631dSTom Zanussi char *str_val,
433bd82631dSTom Zanussi bool is_dynamic,
434bd82631dSTom Zanussi unsigned int data_size,
435bd82631dSTom Zanussi unsigned int *n_u64)
436bd82631dSTom Zanussi {
437bd82631dSTom Zanussi unsigned int len = 0;
438bd82631dSTom Zanussi char *str_field;
4390934ae99SSteven Rostedt (Google) int ret;
440bd82631dSTom Zanussi
441bd82631dSTom Zanussi if (is_dynamic) {
442ddeea494SSven Schnelle union trace_synth_field *data = &entry->fields[*n_u64];
443bd82631dSTom Zanussi
444*ac9a1c3bSThorsten Blum len = fetch_store_strlen((unsigned long)str_val);
445ddeea494SSven Schnelle data->as_dynamic.offset = struct_size(entry, fields, event->n_u64) + data_size;
446*ac9a1c3bSThorsten Blum data->as_dynamic.len = len;
447bd82631dSTom Zanussi
448672a2bf8SSong Chen ret = fetch_store_string((unsigned long)str_val, &entry->fields[*n_u64], entry);
4490934ae99SSteven Rostedt (Google)
450bd82631dSTom Zanussi (*n_u64)++;
451bd82631dSTom Zanussi } else {
452ddeea494SSven Schnelle str_field = (char *)&entry->fields[*n_u64].as_u64;
453bd82631dSTom Zanussi
4540934ae99SSteven Rostedt (Google) #ifdef CONFIG_ARCH_HAS_NON_OVERLAPPING_ADDRESS_SPACE
4550934ae99SSteven Rostedt (Google) if ((unsigned long)str_val < TASK_SIZE)
456707e483eSSteven Rostedt (Google) ret = strncpy_from_user_nofault(str_field, (const void __user *)str_val, STR_VAR_LEN_MAX);
4570934ae99SSteven Rostedt (Google) else
4580934ae99SSteven Rostedt (Google) #endif
4590934ae99SSteven Rostedt (Google) ret = strncpy_from_kernel_nofault(str_field, str_val, STR_VAR_LEN_MAX);
4600934ae99SSteven Rostedt (Google)
4610934ae99SSteven Rostedt (Google) if (ret < 0)
4620934ae99SSteven Rostedt (Google) strcpy(str_field, FAULT_STRING);
4630934ae99SSteven Rostedt (Google)
464bd82631dSTom Zanussi (*n_u64) += STR_VAR_LEN_MAX / sizeof(u64);
465bd82631dSTom Zanussi }
466bd82631dSTom Zanussi
467bd82631dSTom Zanussi return len;
468bd82631dSTom Zanussi }
469bd82631dSTom Zanussi
trace_stack(struct synth_trace_event * entry,struct synth_event * event,long * stack,unsigned int data_size,unsigned int * n_u64)47000cf3d67SSteven Rostedt (Google) static unsigned int trace_stack(struct synth_trace_event *entry,
47100cf3d67SSteven Rostedt (Google) struct synth_event *event,
47200cf3d67SSteven Rostedt (Google) long *stack,
47300cf3d67SSteven Rostedt (Google) unsigned int data_size,
47400cf3d67SSteven Rostedt (Google) unsigned int *n_u64)
47500cf3d67SSteven Rostedt (Google) {
476ddeea494SSven Schnelle union trace_synth_field *data = &entry->fields[*n_u64];
47700cf3d67SSteven Rostedt (Google) unsigned int len;
47800cf3d67SSteven Rostedt (Google) u32 data_offset;
47900cf3d67SSteven Rostedt (Google) void *data_loc;
48000cf3d67SSteven Rostedt (Google)
48100cf3d67SSteven Rostedt (Google) data_offset = struct_size(entry, fields, event->n_u64);
48200cf3d67SSteven Rostedt (Google) data_offset += data_size;
48300cf3d67SSteven Rostedt (Google)
48400cf3d67SSteven Rostedt (Google) for (len = 0; len < HIST_STACKTRACE_DEPTH; len++) {
48500cf3d67SSteven Rostedt (Google) if (!stack[len])
48600cf3d67SSteven Rostedt (Google) break;
48700cf3d67SSteven Rostedt (Google) }
48800cf3d67SSteven Rostedt (Google)
48900cf3d67SSteven Rostedt (Google) len *= sizeof(long);
49000cf3d67SSteven Rostedt (Google)
49100cf3d67SSteven Rostedt (Google) /* Find the dynamic section to copy the stack into. */
49200cf3d67SSteven Rostedt (Google) data_loc = (void *)entry + data_offset;
49300cf3d67SSteven Rostedt (Google) memcpy(data_loc, stack, len);
49400cf3d67SSteven Rostedt (Google)
49500cf3d67SSteven Rostedt (Google) /* Fill in the field that holds the offset/len combo */
496ddeea494SSven Schnelle
497ddeea494SSven Schnelle data->as_dynamic.offset = data_offset;
498ddeea494SSven Schnelle data->as_dynamic.len = len;
49900cf3d67SSteven Rostedt (Google)
50000cf3d67SSteven Rostedt (Google) (*n_u64)++;
50100cf3d67SSteven Rostedt (Google)
50200cf3d67SSteven Rostedt (Google) return len;
50300cf3d67SSteven Rostedt (Google) }
50400cf3d67SSteven Rostedt (Google)
trace_event_raw_event_synth(void * __data,u64 * var_ref_vals,unsigned int * var_ref_idx)505726721a5STom Zanussi static notrace void trace_event_raw_event_synth(void *__data,
506726721a5STom Zanussi u64 *var_ref_vals,
507726721a5STom Zanussi unsigned int *var_ref_idx)
508726721a5STom Zanussi {
509bd82631dSTom Zanussi unsigned int i, n_u64, val_idx, len, data_size = 0;
510726721a5STom Zanussi struct trace_event_file *trace_file = __data;
511726721a5STom Zanussi struct synth_trace_event *entry;
512726721a5STom Zanussi struct trace_event_buffer fbuffer;
513726721a5STom Zanussi struct trace_buffer *buffer;
514726721a5STom Zanussi struct synth_event *event;
515726721a5STom Zanussi int fields_size = 0;
516726721a5STom Zanussi
517726721a5STom Zanussi event = trace_file->event_call->data;
518726721a5STom Zanussi
519726721a5STom Zanussi if (trace_trigger_soft_disabled(trace_file))
520726721a5STom Zanussi return;
521726721a5STom Zanussi
522726721a5STom Zanussi fields_size = event->n_u64 * sizeof(u64);
523726721a5STom Zanussi
524bd82631dSTom Zanussi for (i = 0; i < event->n_dynamic_fields; i++) {
525bd82631dSTom Zanussi unsigned int field_pos = event->dynamic_fields[i]->field_pos;
526bd82631dSTom Zanussi char *str_val;
527bd82631dSTom Zanussi
528bd82631dSTom Zanussi val_idx = var_ref_idx[field_pos];
529bd82631dSTom Zanussi str_val = (char *)(long)var_ref_vals[val_idx];
530bd82631dSTom Zanussi
531fc1a9dc1STom Zanussi if (event->dynamic_fields[i]->is_stack) {
532c4d6b543SSven Schnelle /* reserve one extra element for size */
533c4d6b543SSven Schnelle len = *((unsigned long *)str_val) + 1;
534fc1a9dc1STom Zanussi len *= sizeof(unsigned long);
535fc1a9dc1STom Zanussi } else {
536672a2bf8SSong Chen len = fetch_store_strlen((unsigned long)str_val);
537fc1a9dc1STom Zanussi }
538bd82631dSTom Zanussi
539bd82631dSTom Zanussi fields_size += len;
540bd82631dSTom Zanussi }
541bd82631dSTom Zanussi
542726721a5STom Zanussi /*
543726721a5STom Zanussi * Avoid ring buffer recursion detection, as this event
544726721a5STom Zanussi * is being performed within another event.
545726721a5STom Zanussi */
546726721a5STom Zanussi buffer = trace_file->tr->array_buffer.buffer;
547726721a5STom Zanussi ring_buffer_nest_start(buffer);
548726721a5STom Zanussi
549726721a5STom Zanussi entry = trace_event_buffer_reserve(&fbuffer, trace_file,
550726721a5STom Zanussi sizeof(*entry) + fields_size);
551726721a5STom Zanussi if (!entry)
552726721a5STom Zanussi goto out;
553726721a5STom Zanussi
554726721a5STom Zanussi for (i = 0, n_u64 = 0; i < event->n_fields; i++) {
555726721a5STom Zanussi val_idx = var_ref_idx[i];
556726721a5STom Zanussi if (event->fields[i]->is_string) {
557726721a5STom Zanussi char *str_val = (char *)(long)var_ref_vals[val_idx];
558726721a5STom Zanussi
559bd82631dSTom Zanussi len = trace_string(entry, event, str_val,
560bd82631dSTom Zanussi event->fields[i]->is_dynamic,
561bd82631dSTom Zanussi data_size, &n_u64);
562bd82631dSTom Zanussi data_size += len; /* only dynamic string increments */
5639971c3f9SSteven Rostedt (Google) } else if (event->fields[i]->is_stack) {
56400cf3d67SSteven Rostedt (Google) long *stack = (long *)(long)var_ref_vals[val_idx];
56500cf3d67SSteven Rostedt (Google)
56600cf3d67SSteven Rostedt (Google) len = trace_stack(entry, event, stack,
56700cf3d67SSteven Rostedt (Google) data_size, &n_u64);
56800cf3d67SSteven Rostedt (Google) data_size += len;
569726721a5STom Zanussi } else {
570726721a5STom Zanussi struct synth_field *field = event->fields[i];
571726721a5STom Zanussi u64 val = var_ref_vals[val_idx];
572726721a5STom Zanussi
573726721a5STom Zanussi switch (field->size) {
574726721a5STom Zanussi case 1:
575ddeea494SSven Schnelle entry->fields[n_u64].as_u8 = (u8)val;
576726721a5STom Zanussi break;
577726721a5STom Zanussi
578726721a5STom Zanussi case 2:
579ddeea494SSven Schnelle entry->fields[n_u64].as_u16 = (u16)val;
580726721a5STom Zanussi break;
581726721a5STom Zanussi
582726721a5STom Zanussi case 4:
583ddeea494SSven Schnelle entry->fields[n_u64].as_u32 = (u32)val;
584726721a5STom Zanussi break;
585726721a5STom Zanussi
586726721a5STom Zanussi default:
587ddeea494SSven Schnelle entry->fields[n_u64].as_u64 = val;
588726721a5STom Zanussi break;
589726721a5STom Zanussi }
590726721a5STom Zanussi n_u64++;
591726721a5STom Zanussi }
592726721a5STom Zanussi }
593726721a5STom Zanussi
594726721a5STom Zanussi trace_event_buffer_commit(&fbuffer);
595726721a5STom Zanussi out:
596726721a5STom Zanussi ring_buffer_nest_end(buffer);
597726721a5STom Zanussi }
598726721a5STom Zanussi
free_synth_event_print_fmt(struct trace_event_call * call)599726721a5STom Zanussi static void free_synth_event_print_fmt(struct trace_event_call *call)
600726721a5STom Zanussi {
601726721a5STom Zanussi if (call) {
602726721a5STom Zanussi kfree(call->print_fmt);
603726721a5STom Zanussi call->print_fmt = NULL;
604726721a5STom Zanussi }
605726721a5STom Zanussi }
606726721a5STom Zanussi
__set_synth_event_print_fmt(struct synth_event * event,char * buf,int len)607726721a5STom Zanussi static int __set_synth_event_print_fmt(struct synth_event *event,
608726721a5STom Zanussi char *buf, int len)
609726721a5STom Zanussi {
610726721a5STom Zanussi const char *fmt;
611726721a5STom Zanussi int pos = 0;
612726721a5STom Zanussi int i;
613726721a5STom Zanussi
614726721a5STom Zanussi /* When len=0, we just calculate the needed length */
615726721a5STom Zanussi #define LEN_OR_ZERO (len ? len - pos : 0)
616726721a5STom Zanussi
617726721a5STom Zanussi pos += snprintf(buf + pos, LEN_OR_ZERO, "\"");
618726721a5STom Zanussi for (i = 0; i < event->n_fields; i++) {
619726721a5STom Zanussi fmt = synth_field_fmt(event->fields[i]->type);
620726721a5STom Zanussi pos += snprintf(buf + pos, LEN_OR_ZERO, "%s=%s%s",
621726721a5STom Zanussi event->fields[i]->name, fmt,
622726721a5STom Zanussi i == event->n_fields - 1 ? "" : ", ");
623726721a5STom Zanussi }
624726721a5STom Zanussi pos += snprintf(buf + pos, LEN_OR_ZERO, "\"");
625726721a5STom Zanussi
626726721a5STom Zanussi for (i = 0; i < event->n_fields; i++) {
62784818355SSteven Rostedt (VMware) if (event->fields[i]->is_string &&
628bd82631dSTom Zanussi event->fields[i]->is_dynamic)
629bd82631dSTom Zanussi pos += snprintf(buf + pos, LEN_OR_ZERO,
630bd82631dSTom Zanussi ", __get_str(%s)", event->fields[i]->name);
63100cf3d67SSteven Rostedt (Google) else if (event->fields[i]->is_stack)
63200cf3d67SSteven Rostedt (Google) pos += snprintf(buf + pos, LEN_OR_ZERO,
63300cf3d67SSteven Rostedt (Google) ", __get_stacktrace(%s)", event->fields[i]->name);
634bd82631dSTom Zanussi else
635726721a5STom Zanussi pos += snprintf(buf + pos, LEN_OR_ZERO,
636726721a5STom Zanussi ", REC->%s", event->fields[i]->name);
637726721a5STom Zanussi }
638726721a5STom Zanussi
639726721a5STom Zanussi #undef LEN_OR_ZERO
640726721a5STom Zanussi
641726721a5STom Zanussi /* return the length of print_fmt */
642726721a5STom Zanussi return pos;
643726721a5STom Zanussi }
644726721a5STom Zanussi
set_synth_event_print_fmt(struct trace_event_call * call)645726721a5STom Zanussi static int set_synth_event_print_fmt(struct trace_event_call *call)
646726721a5STom Zanussi {
647726721a5STom Zanussi struct synth_event *event = call->data;
648726721a5STom Zanussi char *print_fmt;
649726721a5STom Zanussi int len;
650726721a5STom Zanussi
651726721a5STom Zanussi /* First: called with 0 length to calculate the needed length */
652726721a5STom Zanussi len = __set_synth_event_print_fmt(event, NULL, 0);
653726721a5STom Zanussi
654726721a5STom Zanussi print_fmt = kmalloc(len + 1, GFP_KERNEL);
655726721a5STom Zanussi if (!print_fmt)
656726721a5STom Zanussi return -ENOMEM;
657726721a5STom Zanussi
658726721a5STom Zanussi /* Second: actually write the @print_fmt */
659726721a5STom Zanussi __set_synth_event_print_fmt(event, print_fmt, len + 1);
660726721a5STom Zanussi call->print_fmt = print_fmt;
661726721a5STom Zanussi
662726721a5STom Zanussi return 0;
663726721a5STom Zanussi }
664726721a5STom Zanussi
free_synth_field(struct synth_field * field)665726721a5STom Zanussi static void free_synth_field(struct synth_field *field)
666726721a5STom Zanussi {
667726721a5STom Zanussi kfree(field->type);
668726721a5STom Zanussi kfree(field->name);
669726721a5STom Zanussi kfree(field);
670726721a5STom Zanussi }
671726721a5STom Zanussi
check_field_version(const char * prefix,const char * field_type,const char * field_name)6728b5ab6bdSTom Zanussi static int check_field_version(const char *prefix, const char *field_type,
6738b5ab6bdSTom Zanussi const char *field_name)
6748b5ab6bdSTom Zanussi {
6758b5ab6bdSTom Zanussi /*
6768b5ab6bdSTom Zanussi * For backward compatibility, the old synthetic event command
6778b5ab6bdSTom Zanussi * format did not require semicolons, and in order to not
6788b5ab6bdSTom Zanussi * break user space, that old format must still work. If a new
6798b5ab6bdSTom Zanussi * feature is added, then the format that uses the new feature
6808b5ab6bdSTom Zanussi * will be required to have semicolons, as nothing that uses
6818b5ab6bdSTom Zanussi * the old format would be using the new, yet to be created,
6828b5ab6bdSTom Zanussi * feature. When a new feature is added, this will detect it,
6838b5ab6bdSTom Zanussi * and return a number greater than 1, and require the format
6848b5ab6bdSTom Zanussi * to use semicolons.
6858b5ab6bdSTom Zanussi */
6868b5ab6bdSTom Zanussi return 1;
6878b5ab6bdSTom Zanussi }
6888b5ab6bdSTom Zanussi
parse_synth_field(int argc,char ** argv,int * consumed,int * field_version)6898b5ab6bdSTom Zanussi static struct synth_field *parse_synth_field(int argc, char **argv,
6908b5ab6bdSTom Zanussi int *consumed, int *field_version)
691726721a5STom Zanussi {
692726721a5STom Zanussi const char *prefix = NULL, *field_type = argv[0], *field_name, *array;
693c9e759b1STom Zanussi struct synth_field *field;
6948b5ab6bdSTom Zanussi int len, ret = -ENOMEM;
695761a8c58SSteven Rostedt (VMware) struct seq_buf s;
6968fbeb52aSTom Zanussi ssize_t size;
697726721a5STom Zanussi
698726721a5STom Zanussi if (!strcmp(field_type, "unsigned")) {
699d4d70463STom Zanussi if (argc < 3) {
700d4d70463STom Zanussi synth_err(SYNTH_ERR_INCOMPLETE_TYPE, errpos(field_type));
701726721a5STom Zanussi return ERR_PTR(-EINVAL);
702d4d70463STom Zanussi }
703726721a5STom Zanussi prefix = "unsigned ";
704726721a5STom Zanussi field_type = argv[1];
705726721a5STom Zanussi field_name = argv[2];
7068b5ab6bdSTom Zanussi *consumed += 3;
707726721a5STom Zanussi } else {
708726721a5STom Zanussi field_name = argv[1];
7098b5ab6bdSTom Zanussi *consumed += 2;
710c9e759b1STom Zanussi }
711c9e759b1STom Zanussi
712c9e759b1STom Zanussi if (!field_name) {
713c9e759b1STom Zanussi synth_err(SYNTH_ERR_INVALID_FIELD, errpos(field_type));
714c9e759b1STom Zanussi return ERR_PTR(-EINVAL);
715726721a5STom Zanussi }
716726721a5STom Zanussi
7178b5ab6bdSTom Zanussi *field_version = check_field_version(prefix, field_type, field_name);
7188b5ab6bdSTom Zanussi
719726721a5STom Zanussi field = kzalloc(sizeof(*field), GFP_KERNEL);
720726721a5STom Zanussi if (!field)
721726721a5STom Zanussi return ERR_PTR(-ENOMEM);
722726721a5STom Zanussi
723726721a5STom Zanussi len = strlen(field_name);
724726721a5STom Zanussi array = strchr(field_name, '[');
725726721a5STom Zanussi if (array)
726726721a5STom Zanussi len -= strlen(array);
727726721a5STom Zanussi
728726721a5STom Zanussi field->name = kmemdup_nul(field_name, len, GFP_KERNEL);
729561ca669SSteven Rostedt (VMware) if (!field->name)
730726721a5STom Zanussi goto free;
731561ca669SSteven Rostedt (VMware)
7329bbb3329STom Zanussi if (!is_good_name(field->name)) {
733d4d70463STom Zanussi synth_err(SYNTH_ERR_BAD_NAME, errpos(field_name));
7349bbb3329STom Zanussi ret = -EINVAL;
7359bbb3329STom Zanussi goto free;
7369bbb3329STom Zanussi }
737726721a5STom Zanussi
738726721a5STom Zanussi len = strlen(field_type) + 1;
73910819e25STom Zanussi
740761a8c58SSteven Rostedt (VMware) if (array)
741761a8c58SSteven Rostedt (VMware) len += strlen(array);
74210819e25STom Zanussi
743726721a5STom Zanussi if (prefix)
744726721a5STom Zanussi len += strlen(prefix);
745726721a5STom Zanussi
746726721a5STom Zanussi field->type = kzalloc(len, GFP_KERNEL);
747561ca669SSteven Rostedt (VMware) if (!field->type)
748726721a5STom Zanussi goto free;
749561ca669SSteven Rostedt (VMware)
750761a8c58SSteven Rostedt (VMware) seq_buf_init(&s, field->type, len);
751726721a5STom Zanussi if (prefix)
752761a8c58SSteven Rostedt (VMware) seq_buf_puts(&s, prefix);
753761a8c58SSteven Rostedt (VMware) seq_buf_puts(&s, field_type);
754c9e759b1STom Zanussi if (array)
755761a8c58SSteven Rostedt (VMware) seq_buf_puts(&s, array);
756761a8c58SSteven Rostedt (VMware) if (WARN_ON_ONCE(!seq_buf_buffer_left(&s)))
757761a8c58SSteven Rostedt (VMware) goto free;
758561ca669SSteven Rostedt (VMware)
759761a8c58SSteven Rostedt (VMware) s.buffer[s.len] = '\0';
760726721a5STom Zanussi
7618fbeb52aSTom Zanussi size = synth_field_size(field->type);
762bd82631dSTom Zanussi if (size < 0) {
7638d3e8165STom Zanussi if (array)
7648d3e8165STom Zanussi synth_err(SYNTH_ERR_INVALID_ARRAY_SPEC, errpos(field_name));
7658d3e8165STom Zanussi else
766d4d70463STom Zanussi synth_err(SYNTH_ERR_INVALID_TYPE, errpos(field_type));
767726721a5STom Zanussi ret = -EINVAL;
768726721a5STom Zanussi goto free;
769bd82631dSTom Zanussi } else if (size == 0) {
77000cf3d67SSteven Rostedt (Google) if (synth_field_is_string(field->type) ||
77100cf3d67SSteven Rostedt (Google) synth_field_is_stack(field->type)) {
772bd82631dSTom Zanussi char *type;
773bd82631dSTom Zanussi
774761a8c58SSteven Rostedt (VMware) len = sizeof("__data_loc ") + strlen(field->type) + 1;
775761a8c58SSteven Rostedt (VMware) type = kzalloc(len, GFP_KERNEL);
776561ca669SSteven Rostedt (VMware) if (!type)
777bd82631dSTom Zanussi goto free;
778bd82631dSTom Zanussi
779761a8c58SSteven Rostedt (VMware) seq_buf_init(&s, type, len);
780761a8c58SSteven Rostedt (VMware) seq_buf_puts(&s, "__data_loc ");
781761a8c58SSteven Rostedt (VMware) seq_buf_puts(&s, field->type);
782761a8c58SSteven Rostedt (VMware)
783761a8c58SSteven Rostedt (VMware) if (WARN_ON_ONCE(!seq_buf_buffer_left(&s)))
784761a8c58SSteven Rostedt (VMware) goto free;
785761a8c58SSteven Rostedt (VMware) s.buffer[s.len] = '\0';
786761a8c58SSteven Rostedt (VMware)
787bd82631dSTom Zanussi kfree(field->type);
788bd82631dSTom Zanussi field->type = type;
789bd82631dSTom Zanussi
790bd82631dSTom Zanussi field->is_dynamic = true;
791bd82631dSTom Zanussi size = sizeof(u64);
792bd82631dSTom Zanussi } else {
793d4d70463STom Zanussi synth_err(SYNTH_ERR_INVALID_TYPE, errpos(field_type));
794bd82631dSTom Zanussi ret = -EINVAL;
795bd82631dSTom Zanussi goto free;
796bd82631dSTom Zanussi }
797726721a5STom Zanussi }
7988fbeb52aSTom Zanussi field->size = size;
799726721a5STom Zanussi
800726721a5STom Zanussi if (synth_field_is_string(field->type))
801726721a5STom Zanussi field->is_string = true;
80200cf3d67SSteven Rostedt (Google) else if (synth_field_is_stack(field->type))
80300cf3d67SSteven Rostedt (Google) field->is_stack = true;
804726721a5STom Zanussi
805726721a5STom Zanussi field->is_signed = synth_field_signed(field->type);
806726721a5STom Zanussi out:
807726721a5STom Zanussi return field;
808726721a5STom Zanussi free:
809726721a5STom Zanussi free_synth_field(field);
810726721a5STom Zanussi field = ERR_PTR(ret);
811726721a5STom Zanussi goto out;
812726721a5STom Zanussi }
813726721a5STom Zanussi
free_synth_tracepoint(struct tracepoint * tp)814726721a5STom Zanussi static void free_synth_tracepoint(struct tracepoint *tp)
815726721a5STom Zanussi {
816726721a5STom Zanussi if (!tp)
817726721a5STom Zanussi return;
818726721a5STom Zanussi
819726721a5STom Zanussi kfree(tp->name);
820726721a5STom Zanussi kfree(tp);
821726721a5STom Zanussi }
822726721a5STom Zanussi
alloc_synth_tracepoint(char * name)823726721a5STom Zanussi static struct tracepoint *alloc_synth_tracepoint(char *name)
824726721a5STom Zanussi {
825726721a5STom Zanussi struct tracepoint *tp;
826726721a5STom Zanussi
827726721a5STom Zanussi tp = kzalloc(sizeof(*tp), GFP_KERNEL);
828726721a5STom Zanussi if (!tp)
829726721a5STom Zanussi return ERR_PTR(-ENOMEM);
830726721a5STom Zanussi
831726721a5STom Zanussi tp->name = kstrdup(name, GFP_KERNEL);
832726721a5STom Zanussi if (!tp->name) {
833726721a5STom Zanussi kfree(tp);
834726721a5STom Zanussi return ERR_PTR(-ENOMEM);
835726721a5STom Zanussi }
836726721a5STom Zanussi
837726721a5STom Zanussi return tp;
838726721a5STom Zanussi }
839726721a5STom Zanussi
find_synth_event(const char * name)840726721a5STom Zanussi struct synth_event *find_synth_event(const char *name)
841726721a5STom Zanussi {
842726721a5STom Zanussi struct dyn_event *pos;
843726721a5STom Zanussi struct synth_event *event;
844726721a5STom Zanussi
845726721a5STom Zanussi for_each_dyn_event(pos) {
846726721a5STom Zanussi if (!is_synth_event(pos))
847726721a5STom Zanussi continue;
848726721a5STom Zanussi event = to_synth_event(pos);
849726721a5STom Zanussi if (strcmp(event->name, name) == 0)
850726721a5STom Zanussi return event;
851726721a5STom Zanussi }
852726721a5STom Zanussi
853726721a5STom Zanussi return NULL;
854726721a5STom Zanussi }
855726721a5STom Zanussi
856726721a5STom Zanussi static struct trace_event_fields synth_event_fields_array[] = {
857726721a5STom Zanussi { .type = TRACE_FUNCTION_TYPE,
858726721a5STom Zanussi .define_fields = synth_event_define_fields },
859726721a5STom Zanussi {}
860726721a5STom Zanussi };
861726721a5STom Zanussi
register_synth_event(struct synth_event * event)862726721a5STom Zanussi static int register_synth_event(struct synth_event *event)
863726721a5STom Zanussi {
864726721a5STom Zanussi struct trace_event_call *call = &event->call;
865726721a5STom Zanussi int ret = 0;
866726721a5STom Zanussi
867726721a5STom Zanussi event->call.class = &event->class;
868726721a5STom Zanussi event->class.system = kstrdup(SYNTH_SYSTEM, GFP_KERNEL);
869726721a5STom Zanussi if (!event->class.system) {
870726721a5STom Zanussi ret = -ENOMEM;
871726721a5STom Zanussi goto out;
872726721a5STom Zanussi }
873726721a5STom Zanussi
874726721a5STom Zanussi event->tp = alloc_synth_tracepoint(event->name);
875726721a5STom Zanussi if (IS_ERR(event->tp)) {
876726721a5STom Zanussi ret = PTR_ERR(event->tp);
877726721a5STom Zanussi event->tp = NULL;
878726721a5STom Zanussi goto out;
879726721a5STom Zanussi }
880726721a5STom Zanussi
881726721a5STom Zanussi INIT_LIST_HEAD(&call->class->fields);
882726721a5STom Zanussi call->event.funcs = &synth_event_funcs;
883726721a5STom Zanussi call->class->fields_array = synth_event_fields_array;
884726721a5STom Zanussi
885726721a5STom Zanussi ret = register_trace_event(&call->event);
886726721a5STom Zanussi if (!ret) {
887726721a5STom Zanussi ret = -ENODEV;
888726721a5STom Zanussi goto out;
889726721a5STom Zanussi }
890726721a5STom Zanussi call->flags = TRACE_EVENT_FL_TRACEPOINT;
891726721a5STom Zanussi call->class->reg = trace_event_reg;
892726721a5STom Zanussi call->class->probe = trace_event_raw_event_synth;
893726721a5STom Zanussi call->data = event;
894726721a5STom Zanussi call->tp = event->tp;
895726721a5STom Zanussi
896726721a5STom Zanussi ret = trace_add_event_call(call);
897726721a5STom Zanussi if (ret) {
898726721a5STom Zanussi pr_warn("Failed to register synthetic event: %s\n",
899726721a5STom Zanussi trace_event_name(call));
900726721a5STom Zanussi goto err;
901726721a5STom Zanussi }
902726721a5STom Zanussi
903726721a5STom Zanussi ret = set_synth_event_print_fmt(call);
9041b5f1c34SShang XiaoJing /* unregister_trace_event() will be called inside */
9051b5f1c34SShang XiaoJing if (ret < 0)
906726721a5STom Zanussi trace_remove_event_call(call);
907726721a5STom Zanussi out:
908726721a5STom Zanussi return ret;
909726721a5STom Zanussi err:
910726721a5STom Zanussi unregister_trace_event(&call->event);
911726721a5STom Zanussi goto out;
912726721a5STom Zanussi }
913726721a5STom Zanussi
unregister_synth_event(struct synth_event * event)914726721a5STom Zanussi static int unregister_synth_event(struct synth_event *event)
915726721a5STom Zanussi {
916726721a5STom Zanussi struct trace_event_call *call = &event->call;
917726721a5STom Zanussi int ret;
918726721a5STom Zanussi
919726721a5STom Zanussi ret = trace_remove_event_call(call);
920726721a5STom Zanussi
921726721a5STom Zanussi return ret;
922726721a5STom Zanussi }
923726721a5STom Zanussi
free_synth_event(struct synth_event * event)924726721a5STom Zanussi static void free_synth_event(struct synth_event *event)
925726721a5STom Zanussi {
926726721a5STom Zanussi unsigned int i;
927726721a5STom Zanussi
928726721a5STom Zanussi if (!event)
929726721a5STom Zanussi return;
930726721a5STom Zanussi
931726721a5STom Zanussi for (i = 0; i < event->n_fields; i++)
932726721a5STom Zanussi free_synth_field(event->fields[i]);
933726721a5STom Zanussi
934726721a5STom Zanussi kfree(event->fields);
935bd82631dSTom Zanussi kfree(event->dynamic_fields);
936726721a5STom Zanussi kfree(event->name);
937726721a5STom Zanussi kfree(event->class.system);
938726721a5STom Zanussi free_synth_tracepoint(event->tp);
939726721a5STom Zanussi free_synth_event_print_fmt(&event->call);
940726721a5STom Zanussi kfree(event);
941726721a5STom Zanussi }
942726721a5STom Zanussi
alloc_synth_event(const char * name,int n_fields,struct synth_field ** fields)943726721a5STom Zanussi static struct synth_event *alloc_synth_event(const char *name, int n_fields,
944726721a5STom Zanussi struct synth_field **fields)
945726721a5STom Zanussi {
946bd82631dSTom Zanussi unsigned int i, j, n_dynamic_fields = 0;
947726721a5STom Zanussi struct synth_event *event;
948726721a5STom Zanussi
949726721a5STom Zanussi event = kzalloc(sizeof(*event), GFP_KERNEL);
950726721a5STom Zanussi if (!event) {
951726721a5STom Zanussi event = ERR_PTR(-ENOMEM);
952726721a5STom Zanussi goto out;
953726721a5STom Zanussi }
954726721a5STom Zanussi
955726721a5STom Zanussi event->name = kstrdup(name, GFP_KERNEL);
956726721a5STom Zanussi if (!event->name) {
957726721a5STom Zanussi kfree(event);
958726721a5STom Zanussi event = ERR_PTR(-ENOMEM);
959726721a5STom Zanussi goto out;
960726721a5STom Zanussi }
961726721a5STom Zanussi
962726721a5STom Zanussi event->fields = kcalloc(n_fields, sizeof(*event->fields), GFP_KERNEL);
963726721a5STom Zanussi if (!event->fields) {
964726721a5STom Zanussi free_synth_event(event);
965726721a5STom Zanussi event = ERR_PTR(-ENOMEM);
966726721a5STom Zanussi goto out;
967726721a5STom Zanussi }
968726721a5STom Zanussi
969bd82631dSTom Zanussi for (i = 0; i < n_fields; i++)
970bd82631dSTom Zanussi if (fields[i]->is_dynamic)
971bd82631dSTom Zanussi n_dynamic_fields++;
972bd82631dSTom Zanussi
973bd82631dSTom Zanussi if (n_dynamic_fields) {
974bd82631dSTom Zanussi event->dynamic_fields = kcalloc(n_dynamic_fields,
975bd82631dSTom Zanussi sizeof(*event->dynamic_fields),
976bd82631dSTom Zanussi GFP_KERNEL);
977bd82631dSTom Zanussi if (!event->dynamic_fields) {
978bd82631dSTom Zanussi free_synth_event(event);
979bd82631dSTom Zanussi event = ERR_PTR(-ENOMEM);
980bd82631dSTom Zanussi goto out;
981bd82631dSTom Zanussi }
982bd82631dSTom Zanussi }
983bd82631dSTom Zanussi
984726721a5STom Zanussi dyn_event_init(&event->devent, &synth_event_ops);
985726721a5STom Zanussi
986bd82631dSTom Zanussi for (i = 0, j = 0; i < n_fields; i++) {
9879528c195SSteven Rostedt (VMware) fields[i]->field_pos = i;
988726721a5STom Zanussi event->fields[i] = fields[i];
989726721a5STom Zanussi
9909528c195SSteven Rostedt (VMware) if (fields[i]->is_dynamic)
991bd82631dSTom Zanussi event->dynamic_fields[j++] = fields[i];
992bd82631dSTom Zanussi }
9939528c195SSteven Rostedt (VMware) event->n_dynamic_fields = j;
994726721a5STom Zanussi event->n_fields = n_fields;
995726721a5STom Zanussi out:
996726721a5STom Zanussi return event;
997726721a5STom Zanussi }
998726721a5STom Zanussi
synth_event_check_arg_fn(void * data)999726721a5STom Zanussi static int synth_event_check_arg_fn(void *data)
1000726721a5STom Zanussi {
1001726721a5STom Zanussi struct dynevent_arg_pair *arg_pair = data;
1002726721a5STom Zanussi int size;
1003726721a5STom Zanussi
1004726721a5STom Zanussi size = synth_field_size((char *)arg_pair->lhs);
1005bd82631dSTom Zanussi if (size == 0) {
1006bd82631dSTom Zanussi if (strstr((char *)arg_pair->lhs, "["))
1007bd82631dSTom Zanussi return 0;
1008bd82631dSTom Zanussi }
1009726721a5STom Zanussi
1010726721a5STom Zanussi return size ? 0 : -EINVAL;
1011726721a5STom Zanussi }
1012726721a5STom Zanussi
1013726721a5STom Zanussi /**
1014726721a5STom Zanussi * synth_event_add_field - Add a new field to a synthetic event cmd
1015726721a5STom Zanussi * @cmd: A pointer to the dynevent_cmd struct representing the new event
1016726721a5STom Zanussi * @type: The type of the new field to add
1017726721a5STom Zanussi * @name: The name of the new field to add
1018726721a5STom Zanussi *
1019726721a5STom Zanussi * Add a new field to a synthetic event cmd object. Field ordering is in
1020726721a5STom Zanussi * the same order the fields are added.
1021726721a5STom Zanussi *
1022726721a5STom Zanussi * See synth_field_size() for available types. If field_name contains
1023726721a5STom Zanussi * [n] the field is considered to be an array.
1024726721a5STom Zanussi *
1025726721a5STom Zanussi * Return: 0 if successful, error otherwise.
1026726721a5STom Zanussi */
synth_event_add_field(struct dynevent_cmd * cmd,const char * type,const char * name)1027726721a5STom Zanussi int synth_event_add_field(struct dynevent_cmd *cmd, const char *type,
1028726721a5STom Zanussi const char *name)
1029726721a5STom Zanussi {
1030726721a5STom Zanussi struct dynevent_arg_pair arg_pair;
1031726721a5STom Zanussi int ret;
1032726721a5STom Zanussi
1033726721a5STom Zanussi if (cmd->type != DYNEVENT_TYPE_SYNTH)
1034726721a5STom Zanussi return -EINVAL;
1035726721a5STom Zanussi
1036726721a5STom Zanussi if (!type || !name)
1037726721a5STom Zanussi return -EINVAL;
1038726721a5STom Zanussi
1039726721a5STom Zanussi dynevent_arg_pair_init(&arg_pair, 0, ';');
1040726721a5STom Zanussi
1041726721a5STom Zanussi arg_pair.lhs = type;
1042726721a5STom Zanussi arg_pair.rhs = name;
1043726721a5STom Zanussi
1044726721a5STom Zanussi ret = dynevent_arg_pair_add(cmd, &arg_pair, synth_event_check_arg_fn);
1045726721a5STom Zanussi if (ret)
1046726721a5STom Zanussi return ret;
1047726721a5STom Zanussi
1048726721a5STom Zanussi if (++cmd->n_fields > SYNTH_FIELDS_MAX)
1049726721a5STom Zanussi ret = -EINVAL;
1050726721a5STom Zanussi
1051726721a5STom Zanussi return ret;
1052726721a5STom Zanussi }
1053726721a5STom Zanussi EXPORT_SYMBOL_GPL(synth_event_add_field);
1054726721a5STom Zanussi
1055726721a5STom Zanussi /**
1056726721a5STom Zanussi * synth_event_add_field_str - Add a new field to a synthetic event cmd
1057726721a5STom Zanussi * @cmd: A pointer to the dynevent_cmd struct representing the new event
1058726721a5STom Zanussi * @type_name: The type and name of the new field to add, as a single string
1059726721a5STom Zanussi *
1060726721a5STom Zanussi * Add a new field to a synthetic event cmd object, as a single
1061726721a5STom Zanussi * string. The @type_name string is expected to be of the form 'type
1062726721a5STom Zanussi * name', which will be appended by ';'. No sanity checking is done -
1063726721a5STom Zanussi * what's passed in is assumed to already be well-formed. Field
1064726721a5STom Zanussi * ordering is in the same order the fields are added.
1065726721a5STom Zanussi *
1066726721a5STom Zanussi * See synth_field_size() for available types. If field_name contains
1067726721a5STom Zanussi * [n] the field is considered to be an array.
1068726721a5STom Zanussi *
1069726721a5STom Zanussi * Return: 0 if successful, error otherwise.
1070726721a5STom Zanussi */
synth_event_add_field_str(struct dynevent_cmd * cmd,const char * type_name)1071726721a5STom Zanussi int synth_event_add_field_str(struct dynevent_cmd *cmd, const char *type_name)
1072726721a5STom Zanussi {
1073726721a5STom Zanussi struct dynevent_arg arg;
1074726721a5STom Zanussi int ret;
1075726721a5STom Zanussi
1076726721a5STom Zanussi if (cmd->type != DYNEVENT_TYPE_SYNTH)
1077726721a5STom Zanussi return -EINVAL;
1078726721a5STom Zanussi
1079726721a5STom Zanussi if (!type_name)
1080726721a5STom Zanussi return -EINVAL;
1081726721a5STom Zanussi
1082726721a5STom Zanussi dynevent_arg_init(&arg, ';');
1083726721a5STom Zanussi
1084726721a5STom Zanussi arg.str = type_name;
1085726721a5STom Zanussi
1086726721a5STom Zanussi ret = dynevent_arg_add(cmd, &arg, NULL);
1087726721a5STom Zanussi if (ret)
1088726721a5STom Zanussi return ret;
1089726721a5STom Zanussi
1090726721a5STom Zanussi if (++cmd->n_fields > SYNTH_FIELDS_MAX)
1091726721a5STom Zanussi ret = -EINVAL;
1092726721a5STom Zanussi
1093726721a5STom Zanussi return ret;
1094726721a5STom Zanussi }
1095726721a5STom Zanussi EXPORT_SYMBOL_GPL(synth_event_add_field_str);
1096726721a5STom Zanussi
1097726721a5STom Zanussi /**
1098726721a5STom Zanussi * synth_event_add_fields - Add multiple fields to a synthetic event cmd
1099726721a5STom Zanussi * @cmd: A pointer to the dynevent_cmd struct representing the new event
1100726721a5STom Zanussi * @fields: An array of type/name field descriptions
1101726721a5STom Zanussi * @n_fields: The number of field descriptions contained in the fields array
1102726721a5STom Zanussi *
1103726721a5STom Zanussi * Add a new set of fields to a synthetic event cmd object. The event
1104726721a5STom Zanussi * fields that will be defined for the event should be passed in as an
1105726721a5STom Zanussi * array of struct synth_field_desc, and the number of elements in the
1106726721a5STom Zanussi * array passed in as n_fields. Field ordering will retain the
1107726721a5STom Zanussi * ordering given in the fields array.
1108726721a5STom Zanussi *
1109726721a5STom Zanussi * See synth_field_size() for available types. If field_name contains
1110726721a5STom Zanussi * [n] the field is considered to be an array.
1111726721a5STom Zanussi *
1112726721a5STom Zanussi * Return: 0 if successful, error otherwise.
1113726721a5STom Zanussi */
synth_event_add_fields(struct dynevent_cmd * cmd,struct synth_field_desc * fields,unsigned int n_fields)1114726721a5STom Zanussi int synth_event_add_fields(struct dynevent_cmd *cmd,
1115726721a5STom Zanussi struct synth_field_desc *fields,
1116726721a5STom Zanussi unsigned int n_fields)
1117726721a5STom Zanussi {
1118726721a5STom Zanussi unsigned int i;
1119726721a5STom Zanussi int ret = 0;
1120726721a5STom Zanussi
1121726721a5STom Zanussi for (i = 0; i < n_fields; i++) {
1122726721a5STom Zanussi if (fields[i].type == NULL || fields[i].name == NULL) {
1123726721a5STom Zanussi ret = -EINVAL;
1124726721a5STom Zanussi break;
1125726721a5STom Zanussi }
1126726721a5STom Zanussi
1127726721a5STom Zanussi ret = synth_event_add_field(cmd, fields[i].type, fields[i].name);
1128726721a5STom Zanussi if (ret)
1129726721a5STom Zanussi break;
1130726721a5STom Zanussi }
1131726721a5STom Zanussi
1132726721a5STom Zanussi return ret;
1133726721a5STom Zanussi }
1134726721a5STom Zanussi EXPORT_SYMBOL_GPL(synth_event_add_fields);
1135726721a5STom Zanussi
1136726721a5STom Zanussi /**
1137726721a5STom Zanussi * __synth_event_gen_cmd_start - Start a synthetic event command from arg list
1138726721a5STom Zanussi * @cmd: A pointer to the dynevent_cmd struct representing the new event
1139726721a5STom Zanussi * @name: The name of the synthetic event
1140726721a5STom Zanussi * @mod: The module creating the event, NULL if not created from a module
1141726721a5STom Zanussi * @args: Variable number of arg (pairs), one pair for each field
1142726721a5STom Zanussi *
1143726721a5STom Zanussi * NOTE: Users normally won't want to call this function directly, but
1144726721a5STom Zanussi * rather use the synth_event_gen_cmd_start() wrapper, which
1145726721a5STom Zanussi * automatically adds a NULL to the end of the arg list. If this
1146726721a5STom Zanussi * function is used directly, make sure the last arg in the variable
1147726721a5STom Zanussi * arg list is NULL.
1148726721a5STom Zanussi *
1149726721a5STom Zanussi * Generate a synthetic event command to be executed by
1150726721a5STom Zanussi * synth_event_gen_cmd_end(). This function can be used to generate
1151726721a5STom Zanussi * the complete command or only the first part of it; in the latter
1152726721a5STom Zanussi * case, synth_event_add_field(), synth_event_add_field_str(), or
1153726721a5STom Zanussi * synth_event_add_fields() can be used to add more fields following
1154726721a5STom Zanussi * this.
1155726721a5STom Zanussi *
1156726721a5STom Zanussi * There should be an even number variable args, each pair consisting
1157726721a5STom Zanussi * of a type followed by a field name.
1158726721a5STom Zanussi *
1159726721a5STom Zanussi * See synth_field_size() for available types. If field_name contains
1160726721a5STom Zanussi * [n] the field is considered to be an array.
1161726721a5STom Zanussi *
1162726721a5STom Zanussi * Return: 0 if successful, error otherwise.
1163726721a5STom Zanussi */
__synth_event_gen_cmd_start(struct dynevent_cmd * cmd,const char * name,struct module * mod,...)1164726721a5STom Zanussi int __synth_event_gen_cmd_start(struct dynevent_cmd *cmd, const char *name,
1165726721a5STom Zanussi struct module *mod, ...)
1166726721a5STom Zanussi {
1167726721a5STom Zanussi struct dynevent_arg arg;
1168726721a5STom Zanussi va_list args;
1169726721a5STom Zanussi int ret;
1170726721a5STom Zanussi
1171726721a5STom Zanussi cmd->event_name = name;
1172726721a5STom Zanussi cmd->private_data = mod;
1173726721a5STom Zanussi
1174726721a5STom Zanussi if (cmd->type != DYNEVENT_TYPE_SYNTH)
1175726721a5STom Zanussi return -EINVAL;
1176726721a5STom Zanussi
1177726721a5STom Zanussi dynevent_arg_init(&arg, 0);
1178726721a5STom Zanussi arg.str = name;
1179726721a5STom Zanussi ret = dynevent_arg_add(cmd, &arg, NULL);
1180726721a5STom Zanussi if (ret)
1181726721a5STom Zanussi return ret;
1182726721a5STom Zanussi
1183726721a5STom Zanussi va_start(args, mod);
1184726721a5STom Zanussi for (;;) {
1185726721a5STom Zanussi const char *type, *name;
1186726721a5STom Zanussi
1187726721a5STom Zanussi type = va_arg(args, const char *);
1188726721a5STom Zanussi if (!type)
1189726721a5STom Zanussi break;
1190726721a5STom Zanussi name = va_arg(args, const char *);
1191726721a5STom Zanussi if (!name)
1192726721a5STom Zanussi break;
1193726721a5STom Zanussi
1194726721a5STom Zanussi if (++cmd->n_fields > SYNTH_FIELDS_MAX) {
1195726721a5STom Zanussi ret = -EINVAL;
1196726721a5STom Zanussi break;
1197726721a5STom Zanussi }
1198726721a5STom Zanussi
1199726721a5STom Zanussi ret = synth_event_add_field(cmd, type, name);
1200726721a5STom Zanussi if (ret)
1201726721a5STom Zanussi break;
1202726721a5STom Zanussi }
1203726721a5STom Zanussi va_end(args);
1204726721a5STom Zanussi
1205726721a5STom Zanussi return ret;
1206726721a5STom Zanussi }
1207726721a5STom Zanussi EXPORT_SYMBOL_GPL(__synth_event_gen_cmd_start);
1208726721a5STom Zanussi
1209726721a5STom Zanussi /**
1210726721a5STom Zanussi * synth_event_gen_cmd_array_start - Start synthetic event command from an array
1211726721a5STom Zanussi * @cmd: A pointer to the dynevent_cmd struct representing the new event
1212726721a5STom Zanussi * @name: The name of the synthetic event
1213b32c789fSGaosheng Cui * @mod: The module creating the event, NULL if not created from a module
1214726721a5STom Zanussi * @fields: An array of type/name field descriptions
1215726721a5STom Zanussi * @n_fields: The number of field descriptions contained in the fields array
1216726721a5STom Zanussi *
1217726721a5STom Zanussi * Generate a synthetic event command to be executed by
1218726721a5STom Zanussi * synth_event_gen_cmd_end(). This function can be used to generate
1219726721a5STom Zanussi * the complete command or only the first part of it; in the latter
1220726721a5STom Zanussi * case, synth_event_add_field(), synth_event_add_field_str(), or
1221726721a5STom Zanussi * synth_event_add_fields() can be used to add more fields following
1222726721a5STom Zanussi * this.
1223726721a5STom Zanussi *
1224726721a5STom Zanussi * The event fields that will be defined for the event should be
1225726721a5STom Zanussi * passed in as an array of struct synth_field_desc, and the number of
1226726721a5STom Zanussi * elements in the array passed in as n_fields. Field ordering will
1227726721a5STom Zanussi * retain the ordering given in the fields array.
1228726721a5STom Zanussi *
1229726721a5STom Zanussi * See synth_field_size() for available types. If field_name contains
1230726721a5STom Zanussi * [n] the field is considered to be an array.
1231726721a5STom Zanussi *
1232726721a5STom Zanussi * Return: 0 if successful, error otherwise.
1233726721a5STom Zanussi */
synth_event_gen_cmd_array_start(struct dynevent_cmd * cmd,const char * name,struct module * mod,struct synth_field_desc * fields,unsigned int n_fields)1234726721a5STom Zanussi int synth_event_gen_cmd_array_start(struct dynevent_cmd *cmd, const char *name,
1235726721a5STom Zanussi struct module *mod,
1236726721a5STom Zanussi struct synth_field_desc *fields,
1237726721a5STom Zanussi unsigned int n_fields)
1238726721a5STom Zanussi {
1239726721a5STom Zanussi struct dynevent_arg arg;
1240726721a5STom Zanussi unsigned int i;
1241726721a5STom Zanussi int ret = 0;
1242726721a5STom Zanussi
1243726721a5STom Zanussi cmd->event_name = name;
1244726721a5STom Zanussi cmd->private_data = mod;
1245726721a5STom Zanussi
1246726721a5STom Zanussi if (cmd->type != DYNEVENT_TYPE_SYNTH)
1247726721a5STom Zanussi return -EINVAL;
1248726721a5STom Zanussi
1249726721a5STom Zanussi if (n_fields > SYNTH_FIELDS_MAX)
1250726721a5STom Zanussi return -EINVAL;
1251726721a5STom Zanussi
1252726721a5STom Zanussi dynevent_arg_init(&arg, 0);
1253726721a5STom Zanussi arg.str = name;
1254726721a5STom Zanussi ret = dynevent_arg_add(cmd, &arg, NULL);
1255726721a5STom Zanussi if (ret)
1256726721a5STom Zanussi return ret;
1257726721a5STom Zanussi
1258726721a5STom Zanussi for (i = 0; i < n_fields; i++) {
1259726721a5STom Zanussi if (fields[i].type == NULL || fields[i].name == NULL)
1260726721a5STom Zanussi return -EINVAL;
1261726721a5STom Zanussi
1262726721a5STom Zanussi ret = synth_event_add_field(cmd, fields[i].type, fields[i].name);
1263726721a5STom Zanussi if (ret)
1264726721a5STom Zanussi break;
1265726721a5STom Zanussi }
1266726721a5STom Zanussi
1267726721a5STom Zanussi return ret;
1268726721a5STom Zanussi }
1269726721a5STom Zanussi EXPORT_SYMBOL_GPL(synth_event_gen_cmd_array_start);
1270726721a5STom Zanussi
__create_synth_event(const char * name,const char * raw_fields)1271c9e759b1STom Zanussi static int __create_synth_event(const char *name, const char *raw_fields)
1272d4d70463STom Zanussi {
1273c9e759b1STom Zanussi char **argv, *field_str, *tmp_fields, *saved_fields = NULL;
1274726721a5STom Zanussi struct synth_field *field, *fields[SYNTH_FIELDS_MAX];
12758b5ab6bdSTom Zanussi int consumed, cmd_version = 1, n_fields_this_loop;
1276c9e759b1STom Zanussi int i, argc, n_fields = 0, ret = 0;
1277726721a5STom Zanussi struct synth_event *event = NULL;
1278d4d70463STom Zanussi
1279726721a5STom Zanussi /*
1280726721a5STom Zanussi * Argument syntax:
1281726721a5STom Zanussi * - Add synthetic event: <event_name> field[;field] ...
1282726721a5STom Zanussi * - Remove synthetic event: !<event_name> field[;field] ...
1283726721a5STom Zanussi * where 'field' = type field_name
1284726721a5STom Zanussi */
1285726721a5STom Zanussi
1286c9e759b1STom Zanussi if (name[0] == '\0') {
12878d3e8165STom Zanussi synth_err(SYNTH_ERR_INVALID_CMD, 0);
1288726721a5STom Zanussi return -EINVAL;
1289d4d70463STom Zanussi }
1290726721a5STom Zanussi
1291c9e759b1STom Zanussi if (!is_good_name(name)) {
1292c9e759b1STom Zanussi synth_err(SYNTH_ERR_BAD_NAME, errpos(name));
1293c9e759b1STom Zanussi return -EINVAL;
1294c9e759b1STom Zanussi }
1295c9e759b1STom Zanussi
1296726721a5STom Zanussi mutex_lock(&event_mutex);
1297726721a5STom Zanussi
1298726721a5STom Zanussi event = find_synth_event(name);
1299726721a5STom Zanussi if (event) {
1300d4d70463STom Zanussi synth_err(SYNTH_ERR_EVENT_EXISTS, errpos(name));
1301726721a5STom Zanussi ret = -EEXIST;
1302c9e759b1STom Zanussi goto err;
1303726721a5STom Zanussi }
1304726721a5STom Zanussi
1305c9e759b1STom Zanussi tmp_fields = saved_fields = kstrdup(raw_fields, GFP_KERNEL);
1306c9e759b1STom Zanussi if (!tmp_fields) {
1307c9e759b1STom Zanussi ret = -ENOMEM;
1308c9e759b1STom Zanussi goto err;
1309c9e759b1STom Zanussi }
1310c9e759b1STom Zanussi
1311c9e759b1STom Zanussi while ((field_str = strsep(&tmp_fields, ";")) != NULL) {
1312c9e759b1STom Zanussi argv = argv_split(GFP_KERNEL, field_str, &argc);
1313c9e759b1STom Zanussi if (!argv) {
1314c9e759b1STom Zanussi ret = -ENOMEM;
1315c9e759b1STom Zanussi goto err;
1316c9e759b1STom Zanussi }
1317c9e759b1STom Zanussi
1318f40fc799SVamshi K Sthambamkadi if (!argc) {
1319f40fc799SVamshi K Sthambamkadi argv_free(argv);
1320726721a5STom Zanussi continue;
1321f40fc799SVamshi K Sthambamkadi }
1322c9e759b1STom Zanussi
13238b5ab6bdSTom Zanussi n_fields_this_loop = 0;
13248b5ab6bdSTom Zanussi consumed = 0;
13258b5ab6bdSTom Zanussi while (argc > consumed) {
13268b5ab6bdSTom Zanussi int field_version;
13278b5ab6bdSTom Zanussi
13288b5ab6bdSTom Zanussi field = parse_synth_field(argc - consumed,
13298b5ab6bdSTom Zanussi argv + consumed, &consumed,
13308b5ab6bdSTom Zanussi &field_version);
1331c9e759b1STom Zanussi if (IS_ERR(field)) {
1332c9e759b1STom Zanussi ret = PTR_ERR(field);
1333c24be24aSMiaoqian Lin goto err_free_arg;
1334c9e759b1STom Zanussi }
1335c9e759b1STom Zanussi
13368b5ab6bdSTom Zanussi /*
13378b5ab6bdSTom Zanussi * Track the highest version of any field we
13388b5ab6bdSTom Zanussi * found in the command.
13398b5ab6bdSTom Zanussi */
13408b5ab6bdSTom Zanussi if (field_version > cmd_version)
13418b5ab6bdSTom Zanussi cmd_version = field_version;
13428b5ab6bdSTom Zanussi
13438b5ab6bdSTom Zanussi /*
13448b5ab6bdSTom Zanussi * Now sort out what is and isn't valid for
13458b5ab6bdSTom Zanussi * each supported version.
13468b5ab6bdSTom Zanussi *
13478b5ab6bdSTom Zanussi * If we see more than 1 field per loop, it
13488b5ab6bdSTom Zanussi * means we have multiple fields between
13498b5ab6bdSTom Zanussi * semicolons, and that's something we no
13508b5ab6bdSTom Zanussi * longer support in a version 2 or greater
13518b5ab6bdSTom Zanussi * command.
13528b5ab6bdSTom Zanussi */
13538b5ab6bdSTom Zanussi if (cmd_version > 1 && n_fields_this_loop >= 1) {
13548b5ab6bdSTom Zanussi synth_err(SYNTH_ERR_INVALID_CMD, errpos(field_str));
13558b5ab6bdSTom Zanussi ret = -EINVAL;
1356c24be24aSMiaoqian Lin goto err_free_arg;
13578b5ab6bdSTom Zanussi }
1358c9e759b1STom Zanussi
1359726721a5STom Zanussi if (n_fields == SYNTH_FIELDS_MAX) {
1360d4d70463STom Zanussi synth_err(SYNTH_ERR_TOO_MANY_FIELDS, 0);
1361726721a5STom Zanussi ret = -EINVAL;
1362c24be24aSMiaoqian Lin goto err_free_arg;
1363726721a5STom Zanussi }
1364ff4837f7SZheng Yejian fields[n_fields++] = field;
13658b5ab6bdSTom Zanussi
13668b5ab6bdSTom Zanussi n_fields_this_loop++;
13678b5ab6bdSTom Zanussi }
1368c24be24aSMiaoqian Lin argv_free(argv);
13698b5ab6bdSTom Zanussi
13708b5ab6bdSTom Zanussi if (consumed < argc) {
13718b5ab6bdSTom Zanussi synth_err(SYNTH_ERR_INVALID_CMD, 0);
13728b5ab6bdSTom Zanussi ret = -EINVAL;
13738b5ab6bdSTom Zanussi goto err;
13748b5ab6bdSTom Zanussi }
13758b5ab6bdSTom Zanussi
1376726721a5STom Zanussi }
1377726721a5STom Zanussi
1378c9e759b1STom Zanussi if (n_fields == 0) {
13798d3e8165STom Zanussi synth_err(SYNTH_ERR_INVALID_CMD, 0);
1380726721a5STom Zanussi ret = -EINVAL;
1381726721a5STom Zanussi goto err;
1382726721a5STom Zanussi }
1383726721a5STom Zanussi
1384726721a5STom Zanussi event = alloc_synth_event(name, n_fields, fields);
1385726721a5STom Zanussi if (IS_ERR(event)) {
1386726721a5STom Zanussi ret = PTR_ERR(event);
1387726721a5STom Zanussi event = NULL;
1388726721a5STom Zanussi goto err;
1389726721a5STom Zanussi }
1390726721a5STom Zanussi ret = register_synth_event(event);
1391726721a5STom Zanussi if (!ret)
13928b0e6c74SSteven Rostedt (VMware) dyn_event_add(&event->devent, &event->call);
1393726721a5STom Zanussi else
1394726721a5STom Zanussi free_synth_event(event);
1395726721a5STom Zanussi out:
1396726721a5STom Zanussi mutex_unlock(&event_mutex);
1397726721a5STom Zanussi
1398c9e759b1STom Zanussi kfree(saved_fields);
1399c9e759b1STom Zanussi
1400726721a5STom Zanussi return ret;
1401c24be24aSMiaoqian Lin err_free_arg:
1402c24be24aSMiaoqian Lin argv_free(argv);
1403726721a5STom Zanussi err:
1404726721a5STom Zanussi for (i = 0; i < n_fields; i++)
1405726721a5STom Zanussi free_synth_field(fields[i]);
1406726721a5STom Zanussi
1407726721a5STom Zanussi goto out;
1408726721a5STom Zanussi }
1409726721a5STom Zanussi
1410726721a5STom Zanussi /**
1411726721a5STom Zanussi * synth_event_create - Create a new synthetic event
14122b5894ccSQiujun Huang * @name: The name of the new synthetic event
1413726721a5STom Zanussi * @fields: An array of type/name field descriptions
1414726721a5STom Zanussi * @n_fields: The number of field descriptions contained in the fields array
1415726721a5STom Zanussi * @mod: The module creating the event, NULL if not created from a module
1416726721a5STom Zanussi *
1417726721a5STom Zanussi * Create a new synthetic event with the given name under the
1418726721a5STom Zanussi * trace/events/synthetic/ directory. The event fields that will be
1419726721a5STom Zanussi * defined for the event should be passed in as an array of struct
1420726721a5STom Zanussi * synth_field_desc, and the number elements in the array passed in as
1421726721a5STom Zanussi * n_fields. Field ordering will retain the ordering given in the
1422726721a5STom Zanussi * fields array.
1423726721a5STom Zanussi *
1424726721a5STom Zanussi * If the new synthetic event is being created from a module, the mod
1425726721a5STom Zanussi * param must be non-NULL. This will ensure that the trace buffer
1426726721a5STom Zanussi * won't contain unreadable events.
1427726721a5STom Zanussi *
1428726721a5STom Zanussi * The new synth event should be deleted using synth_event_delete()
1429726721a5STom Zanussi * function. The new synthetic event can be generated from modules or
1430726721a5STom Zanussi * other kernel code using trace_synth_event() and related functions.
1431726721a5STom Zanussi *
1432726721a5STom Zanussi * Return: 0 if successful, error otherwise.
1433726721a5STom Zanussi */
synth_event_create(const char * name,struct synth_field_desc * fields,unsigned int n_fields,struct module * mod)1434726721a5STom Zanussi int synth_event_create(const char *name, struct synth_field_desc *fields,
1435726721a5STom Zanussi unsigned int n_fields, struct module *mod)
1436726721a5STom Zanussi {
1437726721a5STom Zanussi struct dynevent_cmd cmd;
1438726721a5STom Zanussi char *buf;
1439726721a5STom Zanussi int ret;
1440726721a5STom Zanussi
1441726721a5STom Zanussi buf = kzalloc(MAX_DYNEVENT_CMD_LEN, GFP_KERNEL);
1442726721a5STom Zanussi if (!buf)
1443726721a5STom Zanussi return -ENOMEM;
1444726721a5STom Zanussi
1445726721a5STom Zanussi synth_event_cmd_init(&cmd, buf, MAX_DYNEVENT_CMD_LEN);
1446726721a5STom Zanussi
1447726721a5STom Zanussi ret = synth_event_gen_cmd_array_start(&cmd, name, mod,
1448726721a5STom Zanussi fields, n_fields);
1449726721a5STom Zanussi if (ret)
1450726721a5STom Zanussi goto out;
1451726721a5STom Zanussi
1452726721a5STom Zanussi ret = synth_event_gen_cmd_end(&cmd);
1453726721a5STom Zanussi out:
1454726721a5STom Zanussi kfree(buf);
1455726721a5STom Zanussi
1456726721a5STom Zanussi return ret;
1457726721a5STom Zanussi }
1458726721a5STom Zanussi EXPORT_SYMBOL_GPL(synth_event_create);
1459726721a5STom Zanussi
destroy_synth_event(struct synth_event * se)1460726721a5STom Zanussi static int destroy_synth_event(struct synth_event *se)
1461726721a5STom Zanussi {
1462726721a5STom Zanussi int ret;
1463726721a5STom Zanussi
1464726721a5STom Zanussi if (se->ref)
14651d18538eSSteven Rostedt (VMware) return -EBUSY;
14661d18538eSSteven Rostedt (VMware)
14671d18538eSSteven Rostedt (VMware) if (trace_event_dyn_busy(&se->call))
14681d18538eSSteven Rostedt (VMware) return -EBUSY;
14691d18538eSSteven Rostedt (VMware)
1470726721a5STom Zanussi ret = unregister_synth_event(se);
1471726721a5STom Zanussi if (!ret) {
1472726721a5STom Zanussi dyn_event_remove(&se->devent);
1473726721a5STom Zanussi free_synth_event(se);
1474726721a5STom Zanussi }
1475726721a5STom Zanussi
1476726721a5STom Zanussi return ret;
1477726721a5STom Zanussi }
1478726721a5STom Zanussi
1479726721a5STom Zanussi /**
1480726721a5STom Zanussi * synth_event_delete - Delete a synthetic event
1481f2cc020dSIngo Molnar * @event_name: The name of the new synthetic event
1482726721a5STom Zanussi *
1483726721a5STom Zanussi * Delete a synthetic event that was created with synth_event_create().
1484726721a5STom Zanussi *
1485726721a5STom Zanussi * Return: 0 if successful, error otherwise.
1486726721a5STom Zanussi */
synth_event_delete(const char * event_name)1487726721a5STom Zanussi int synth_event_delete(const char *event_name)
1488726721a5STom Zanussi {
1489726721a5STom Zanussi struct synth_event *se = NULL;
1490726721a5STom Zanussi struct module *mod = NULL;
1491726721a5STom Zanussi int ret = -ENOENT;
1492726721a5STom Zanussi
1493726721a5STom Zanussi mutex_lock(&event_mutex);
1494726721a5STom Zanussi se = find_synth_event(event_name);
1495726721a5STom Zanussi if (se) {
1496726721a5STom Zanussi mod = se->mod;
1497726721a5STom Zanussi ret = destroy_synth_event(se);
1498726721a5STom Zanussi }
1499726721a5STom Zanussi mutex_unlock(&event_mutex);
1500726721a5STom Zanussi
1501726721a5STom Zanussi if (mod) {
1502726721a5STom Zanussi /*
1503726721a5STom Zanussi * It is safest to reset the ring buffer if the module
1504726721a5STom Zanussi * being unloaded registered any events that were
1505726721a5STom Zanussi * used. The only worry is if a new module gets
1506726721a5STom Zanussi * loaded, and takes on the same id as the events of
1507726721a5STom Zanussi * this module. When printing out the buffer, traced
1508726721a5STom Zanussi * events left over from this module may be passed to
1509726721a5STom Zanussi * the new module events and unexpected results may
1510726721a5STom Zanussi * occur.
1511726721a5STom Zanussi */
1512726721a5STom Zanussi tracing_reset_all_online_cpus();
1513726721a5STom Zanussi }
1514726721a5STom Zanussi
1515726721a5STom Zanussi return ret;
1516726721a5STom Zanussi }
1517726721a5STom Zanussi EXPORT_SYMBOL_GPL(synth_event_delete);
1518726721a5STom Zanussi
check_command(const char * raw_command)1519c9e759b1STom Zanussi static int check_command(const char *raw_command)
1520726721a5STom Zanussi {
1521c9e759b1STom Zanussi char **argv = NULL, *cmd, *saved_cmd, *name_and_field;
1522c9e759b1STom Zanussi int argc, ret = 0;
1523d262271dSMasami Hiramatsu
1524c9e759b1STom Zanussi cmd = saved_cmd = kstrdup(raw_command, GFP_KERNEL);
1525c9e759b1STom Zanussi if (!cmd)
1526d262271dSMasami Hiramatsu return -ENOMEM;
1527d262271dSMasami Hiramatsu
1528c9e759b1STom Zanussi name_and_field = strsep(&cmd, ";");
1529c9e759b1STom Zanussi if (!name_and_field) {
1530c9e759b1STom Zanussi ret = -EINVAL;
1531c9e759b1STom Zanussi goto free;
1532c9e759b1STom Zanussi }
1533c9e759b1STom Zanussi
1534c9e759b1STom Zanussi if (name_and_field[0] == '!')
1535d262271dSMasami Hiramatsu goto free;
1536d262271dSMasami Hiramatsu
1537c9e759b1STom Zanussi argv = argv_split(GFP_KERNEL, name_and_field, &argc);
1538c9e759b1STom Zanussi if (!argv) {
1539c9e759b1STom Zanussi ret = -ENOMEM;
1540c9e759b1STom Zanussi goto free;
1541c9e759b1STom Zanussi }
1542c9e759b1STom Zanussi argv_free(argv);
1543726721a5STom Zanussi
1544c9e759b1STom Zanussi if (argc < 3)
1545c9e759b1STom Zanussi ret = -EINVAL;
1546c9e759b1STom Zanussi free:
1547c9e759b1STom Zanussi kfree(saved_cmd);
1548c9e759b1STom Zanussi
1549c9e759b1STom Zanussi return ret;
1550c9e759b1STom Zanussi }
1551c9e759b1STom Zanussi
create_or_delete_synth_event(const char * raw_command)1552c9e759b1STom Zanussi static int create_or_delete_synth_event(const char *raw_command)
1553c9e759b1STom Zanussi {
1554c9e759b1STom Zanussi char *name = NULL, *fields, *p;
1555c9e759b1STom Zanussi int ret = 0;
1556c9e759b1STom Zanussi
1557c9e759b1STom Zanussi raw_command = skip_spaces(raw_command);
1558c9e759b1STom Zanussi if (raw_command[0] == '\0')
1559c9e759b1STom Zanussi return ret;
1560c9e759b1STom Zanussi
1561c9e759b1STom Zanussi last_cmd_set(raw_command);
1562c9e759b1STom Zanussi
1563c9e759b1STom Zanussi ret = check_command(raw_command);
1564c9e759b1STom Zanussi if (ret) {
15658d3e8165STom Zanussi synth_err(SYNTH_ERR_INVALID_CMD, 0);
1566c9e759b1STom Zanussi return ret;
1567c9e759b1STom Zanussi }
1568c9e759b1STom Zanussi
1569c9e759b1STom Zanussi p = strpbrk(raw_command, " \t");
1570c9e759b1STom Zanussi if (!p && raw_command[0] != '!') {
15718d3e8165STom Zanussi synth_err(SYNTH_ERR_INVALID_CMD, 0);
1572c9e759b1STom Zanussi ret = -EINVAL;
1573c9e759b1STom Zanussi goto free;
1574c9e759b1STom Zanussi }
1575c9e759b1STom Zanussi
1576c9e759b1STom Zanussi name = kmemdup_nul(raw_command, p ? p - raw_command : strlen(raw_command), GFP_KERNEL);
1577c9e759b1STom Zanussi if (!name)
1578c9e759b1STom Zanussi return -ENOMEM;
1579c9e759b1STom Zanussi
1580726721a5STom Zanussi if (name[0] == '!') {
1581726721a5STom Zanussi ret = synth_event_delete(name + 1);
1582d262271dSMasami Hiramatsu goto free;
1583726721a5STom Zanussi }
1584726721a5STom Zanussi
1585c9e759b1STom Zanussi fields = skip_spaces(p);
1586d262271dSMasami Hiramatsu
1587c9e759b1STom Zanussi ret = __create_synth_event(name, fields);
1588c9e759b1STom Zanussi free:
1589c9e759b1STom Zanussi kfree(name);
1590c9e759b1STom Zanussi
1591c9e759b1STom Zanussi return ret;
1592726721a5STom Zanussi }
1593726721a5STom Zanussi
synth_event_run_command(struct dynevent_cmd * cmd)1594726721a5STom Zanussi static int synth_event_run_command(struct dynevent_cmd *cmd)
1595726721a5STom Zanussi {
1596726721a5STom Zanussi struct synth_event *se;
1597726721a5STom Zanussi int ret;
1598726721a5STom Zanussi
1599d262271dSMasami Hiramatsu ret = create_or_delete_synth_event(cmd->seq.buffer);
1600726721a5STom Zanussi if (ret)
1601726721a5STom Zanussi return ret;
1602726721a5STom Zanussi
1603726721a5STom Zanussi se = find_synth_event(cmd->event_name);
1604726721a5STom Zanussi if (WARN_ON(!se))
1605726721a5STom Zanussi return -ENOENT;
1606726721a5STom Zanussi
1607726721a5STom Zanussi se->mod = cmd->private_data;
1608726721a5STom Zanussi
1609726721a5STom Zanussi return ret;
1610726721a5STom Zanussi }
1611726721a5STom Zanussi
1612726721a5STom Zanussi /**
1613726721a5STom Zanussi * synth_event_cmd_init - Initialize a synthetic event command object
1614726721a5STom Zanussi * @cmd: A pointer to the dynevent_cmd struct representing the new event
1615726721a5STom Zanussi * @buf: A pointer to the buffer used to build the command
1616726721a5STom Zanussi * @maxlen: The length of the buffer passed in @buf
1617726721a5STom Zanussi *
1618726721a5STom Zanussi * Initialize a synthetic event command object. Use this before
1619726721a5STom Zanussi * calling any of the other dyenvent_cmd functions.
1620726721a5STom Zanussi */
synth_event_cmd_init(struct dynevent_cmd * cmd,char * buf,int maxlen)1621726721a5STom Zanussi void synth_event_cmd_init(struct dynevent_cmd *cmd, char *buf, int maxlen)
1622726721a5STom Zanussi {
1623726721a5STom Zanussi dynevent_cmd_init(cmd, buf, maxlen, DYNEVENT_TYPE_SYNTH,
1624726721a5STom Zanussi synth_event_run_command);
1625726721a5STom Zanussi }
1626726721a5STom Zanussi EXPORT_SYMBOL_GPL(synth_event_cmd_init);
1627726721a5STom Zanussi
1628726721a5STom Zanussi static inline int
__synth_event_trace_init(struct trace_event_file * file,struct synth_event_trace_state * trace_state)1629bd82631dSTom Zanussi __synth_event_trace_init(struct trace_event_file *file,
1630726721a5STom Zanussi struct synth_event_trace_state *trace_state)
1631726721a5STom Zanussi {
1632726721a5STom Zanussi int ret = 0;
1633726721a5STom Zanussi
1634726721a5STom Zanussi memset(trace_state, '\0', sizeof(*trace_state));
1635726721a5STom Zanussi
1636726721a5STom Zanussi /*
1637726721a5STom Zanussi * Normal event tracing doesn't get called at all unless the
1638726721a5STom Zanussi * ENABLED bit is set (which attaches the probe thus allowing
1639726721a5STom Zanussi * this code to be called, etc). Because this is called
1640726721a5STom Zanussi * directly by the user, we don't have that but we still need
16415c8c206eSRandy Dunlap * to honor not logging when disabled. For the iterated
16422b5894ccSQiujun Huang * trace case, we save the enabled state upon start and just
1643726721a5STom Zanussi * ignore the following data calls.
1644726721a5STom Zanussi */
1645726721a5STom Zanussi if (!(file->flags & EVENT_FILE_FL_ENABLED) ||
1646726721a5STom Zanussi trace_trigger_soft_disabled(file)) {
1647726721a5STom Zanussi trace_state->disabled = true;
1648726721a5STom Zanussi ret = -ENOENT;
1649726721a5STom Zanussi goto out;
1650726721a5STom Zanussi }
1651726721a5STom Zanussi
1652726721a5STom Zanussi trace_state->event = file->event_call->data;
1653bd82631dSTom Zanussi out:
1654bd82631dSTom Zanussi return ret;
1655bd82631dSTom Zanussi }
1656bd82631dSTom Zanussi
1657bd82631dSTom Zanussi static inline int
__synth_event_trace_start(struct trace_event_file * file,struct synth_event_trace_state * trace_state,int dynamic_fields_size)1658bd82631dSTom Zanussi __synth_event_trace_start(struct trace_event_file *file,
1659bd82631dSTom Zanussi struct synth_event_trace_state *trace_state,
1660bd82631dSTom Zanussi int dynamic_fields_size)
1661bd82631dSTom Zanussi {
1662bd82631dSTom Zanussi int entry_size, fields_size = 0;
1663bd82631dSTom Zanussi int ret = 0;
1664726721a5STom Zanussi
1665726721a5STom Zanussi fields_size = trace_state->event->n_u64 * sizeof(u64);
1666bd82631dSTom Zanussi fields_size += dynamic_fields_size;
1667726721a5STom Zanussi
1668726721a5STom Zanussi /*
1669726721a5STom Zanussi * Avoid ring buffer recursion detection, as this event
1670726721a5STom Zanussi * is being performed within another event.
1671726721a5STom Zanussi */
1672726721a5STom Zanussi trace_state->buffer = file->tr->array_buffer.buffer;
1673726721a5STom Zanussi ring_buffer_nest_start(trace_state->buffer);
1674726721a5STom Zanussi
1675726721a5STom Zanussi entry_size = sizeof(*trace_state->entry) + fields_size;
1676726721a5STom Zanussi trace_state->entry = trace_event_buffer_reserve(&trace_state->fbuffer,
1677726721a5STom Zanussi file,
1678726721a5STom Zanussi entry_size);
1679726721a5STom Zanussi if (!trace_state->entry) {
1680726721a5STom Zanussi ring_buffer_nest_end(trace_state->buffer);
1681726721a5STom Zanussi ret = -EINVAL;
1682726721a5STom Zanussi }
1683bd82631dSTom Zanussi
1684726721a5STom Zanussi return ret;
1685726721a5STom Zanussi }
1686726721a5STom Zanussi
1687726721a5STom Zanussi static inline void
__synth_event_trace_end(struct synth_event_trace_state * trace_state)1688726721a5STom Zanussi __synth_event_trace_end(struct synth_event_trace_state *trace_state)
1689726721a5STom Zanussi {
1690726721a5STom Zanussi trace_event_buffer_commit(&trace_state->fbuffer);
1691726721a5STom Zanussi
1692726721a5STom Zanussi ring_buffer_nest_end(trace_state->buffer);
1693726721a5STom Zanussi }
1694726721a5STom Zanussi
1695726721a5STom Zanussi /**
1696726721a5STom Zanussi * synth_event_trace - Trace a synthetic event
1697726721a5STom Zanussi * @file: The trace_event_file representing the synthetic event
1698726721a5STom Zanussi * @n_vals: The number of values in vals
1699726721a5STom Zanussi * @args: Variable number of args containing the event values
1700726721a5STom Zanussi *
1701726721a5STom Zanussi * Trace a synthetic event using the values passed in the variable
1702726721a5STom Zanussi * argument list.
1703726721a5STom Zanussi *
1704726721a5STom Zanussi * The argument list should be a list 'n_vals' u64 values. The number
1705726721a5STom Zanussi * of vals must match the number of field in the synthetic event, and
1706726721a5STom Zanussi * must be in the same order as the synthetic event fields.
1707726721a5STom Zanussi *
1708726721a5STom Zanussi * All vals should be cast to u64, and string vals are just pointers
1709726721a5STom Zanussi * to strings, cast to u64. Strings will be copied into space
1710726721a5STom Zanussi * reserved in the event for the string, using these pointers.
1711726721a5STom Zanussi *
1712726721a5STom Zanussi * Return: 0 on success, err otherwise.
1713726721a5STom Zanussi */
synth_event_trace(struct trace_event_file * file,unsigned int n_vals,...)1714726721a5STom Zanussi int synth_event_trace(struct trace_event_file *file, unsigned int n_vals, ...)
1715726721a5STom Zanussi {
1716bd82631dSTom Zanussi unsigned int i, n_u64, len, data_size = 0;
1717726721a5STom Zanussi struct synth_event_trace_state state;
1718726721a5STom Zanussi va_list args;
1719726721a5STom Zanussi int ret;
1720726721a5STom Zanussi
1721bd82631dSTom Zanussi ret = __synth_event_trace_init(file, &state);
1722726721a5STom Zanussi if (ret) {
1723726721a5STom Zanussi if (ret == -ENOENT)
1724726721a5STom Zanussi ret = 0; /* just disabled, not really an error */
1725726721a5STom Zanussi return ret;
1726726721a5STom Zanussi }
1727726721a5STom Zanussi
1728bd82631dSTom Zanussi if (state.event->n_dynamic_fields) {
1729bd82631dSTom Zanussi va_start(args, n_vals);
1730bd82631dSTom Zanussi
1731bd82631dSTom Zanussi for (i = 0; i < state.event->n_fields; i++) {
1732bd82631dSTom Zanussi u64 val = va_arg(args, u64);
1733bd82631dSTom Zanussi
1734bd82631dSTom Zanussi if (state.event->fields[i]->is_string &&
1735bd82631dSTom Zanussi state.event->fields[i]->is_dynamic) {
1736bd82631dSTom Zanussi char *str_val = (char *)(long)val;
1737bd82631dSTom Zanussi
1738bd82631dSTom Zanussi data_size += strlen(str_val) + 1;
1739bd82631dSTom Zanussi }
1740bd82631dSTom Zanussi }
1741bd82631dSTom Zanussi
1742bd82631dSTom Zanussi va_end(args);
1743bd82631dSTom Zanussi }
1744bd82631dSTom Zanussi
1745bd82631dSTom Zanussi ret = __synth_event_trace_start(file, &state, data_size);
1746bd82631dSTom Zanussi if (ret)
1747bd82631dSTom Zanussi return ret;
1748bd82631dSTom Zanussi
1749726721a5STom Zanussi if (n_vals != state.event->n_fields) {
1750726721a5STom Zanussi ret = -EINVAL;
1751726721a5STom Zanussi goto out;
1752726721a5STom Zanussi }
1753726721a5STom Zanussi
1754bd82631dSTom Zanussi data_size = 0;
1755bd82631dSTom Zanussi
1756726721a5STom Zanussi va_start(args, n_vals);
1757726721a5STom Zanussi for (i = 0, n_u64 = 0; i < state.event->n_fields; i++) {
1758726721a5STom Zanussi u64 val;
1759726721a5STom Zanussi
1760726721a5STom Zanussi val = va_arg(args, u64);
1761726721a5STom Zanussi
1762726721a5STom Zanussi if (state.event->fields[i]->is_string) {
1763726721a5STom Zanussi char *str_val = (char *)(long)val;
1764726721a5STom Zanussi
1765bd82631dSTom Zanussi len = trace_string(state.entry, state.event, str_val,
1766bd82631dSTom Zanussi state.event->fields[i]->is_dynamic,
1767bd82631dSTom Zanussi data_size, &n_u64);
1768bd82631dSTom Zanussi data_size += len; /* only dynamic string increments */
1769726721a5STom Zanussi } else {
1770726721a5STom Zanussi struct synth_field *field = state.event->fields[i];
1771726721a5STom Zanussi
1772726721a5STom Zanussi switch (field->size) {
1773726721a5STom Zanussi case 1:
1774ddeea494SSven Schnelle state.entry->fields[n_u64].as_u8 = (u8)val;
1775726721a5STom Zanussi break;
1776726721a5STom Zanussi
1777726721a5STom Zanussi case 2:
1778ddeea494SSven Schnelle state.entry->fields[n_u64].as_u16 = (u16)val;
1779726721a5STom Zanussi break;
1780726721a5STom Zanussi
1781726721a5STom Zanussi case 4:
1782ddeea494SSven Schnelle state.entry->fields[n_u64].as_u32 = (u32)val;
1783726721a5STom Zanussi break;
1784726721a5STom Zanussi
1785726721a5STom Zanussi default:
1786ddeea494SSven Schnelle state.entry->fields[n_u64].as_u64 = val;
1787726721a5STom Zanussi break;
1788726721a5STom Zanussi }
1789726721a5STom Zanussi n_u64++;
1790726721a5STom Zanussi }
1791726721a5STom Zanussi }
1792726721a5STom Zanussi va_end(args);
1793726721a5STom Zanussi out:
1794726721a5STom Zanussi __synth_event_trace_end(&state);
1795726721a5STom Zanussi
1796726721a5STom Zanussi return ret;
1797726721a5STom Zanussi }
1798726721a5STom Zanussi EXPORT_SYMBOL_GPL(synth_event_trace);
1799726721a5STom Zanussi
1800726721a5STom Zanussi /**
1801726721a5STom Zanussi * synth_event_trace_array - Trace a synthetic event from an array
1802726721a5STom Zanussi * @file: The trace_event_file representing the synthetic event
1803726721a5STom Zanussi * @vals: Array of values
1804726721a5STom Zanussi * @n_vals: The number of values in vals
1805726721a5STom Zanussi *
1806726721a5STom Zanussi * Trace a synthetic event using the values passed in as 'vals'.
1807726721a5STom Zanussi *
1808726721a5STom Zanussi * The 'vals' array is just an array of 'n_vals' u64. The number of
1809726721a5STom Zanussi * vals must match the number of field in the synthetic event, and
1810726721a5STom Zanussi * must be in the same order as the synthetic event fields.
1811726721a5STom Zanussi *
1812726721a5STom Zanussi * All vals should be cast to u64, and string vals are just pointers
1813726721a5STom Zanussi * to strings, cast to u64. Strings will be copied into space
1814726721a5STom Zanussi * reserved in the event for the string, using these pointers.
1815726721a5STom Zanussi *
1816726721a5STom Zanussi * Return: 0 on success, err otherwise.
1817726721a5STom Zanussi */
synth_event_trace_array(struct trace_event_file * file,u64 * vals,unsigned int n_vals)1818726721a5STom Zanussi int synth_event_trace_array(struct trace_event_file *file, u64 *vals,
1819726721a5STom Zanussi unsigned int n_vals)
1820726721a5STom Zanussi {
1821bd82631dSTom Zanussi unsigned int i, n_u64, field_pos, len, data_size = 0;
1822726721a5STom Zanussi struct synth_event_trace_state state;
1823bd82631dSTom Zanussi char *str_val;
1824726721a5STom Zanussi int ret;
1825726721a5STom Zanussi
1826bd82631dSTom Zanussi ret = __synth_event_trace_init(file, &state);
1827726721a5STom Zanussi if (ret) {
1828726721a5STom Zanussi if (ret == -ENOENT)
1829726721a5STom Zanussi ret = 0; /* just disabled, not really an error */
1830726721a5STom Zanussi return ret;
1831726721a5STom Zanussi }
1832726721a5STom Zanussi
1833bd82631dSTom Zanussi if (state.event->n_dynamic_fields) {
1834bd82631dSTom Zanussi for (i = 0; i < state.event->n_dynamic_fields; i++) {
1835bd82631dSTom Zanussi field_pos = state.event->dynamic_fields[i]->field_pos;
1836bd82631dSTom Zanussi str_val = (char *)(long)vals[field_pos];
1837bd82631dSTom Zanussi len = strlen(str_val) + 1;
1838bd82631dSTom Zanussi data_size += len;
1839bd82631dSTom Zanussi }
1840bd82631dSTom Zanussi }
1841bd82631dSTom Zanussi
1842bd82631dSTom Zanussi ret = __synth_event_trace_start(file, &state, data_size);
1843bd82631dSTom Zanussi if (ret)
1844bd82631dSTom Zanussi return ret;
1845bd82631dSTom Zanussi
1846726721a5STom Zanussi if (n_vals != state.event->n_fields) {
1847726721a5STom Zanussi ret = -EINVAL;
1848726721a5STom Zanussi goto out;
1849726721a5STom Zanussi }
1850726721a5STom Zanussi
1851bd82631dSTom Zanussi data_size = 0;
1852bd82631dSTom Zanussi
1853726721a5STom Zanussi for (i = 0, n_u64 = 0; i < state.event->n_fields; i++) {
1854726721a5STom Zanussi if (state.event->fields[i]->is_string) {
1855726721a5STom Zanussi char *str_val = (char *)(long)vals[i];
1856726721a5STom Zanussi
1857bd82631dSTom Zanussi len = trace_string(state.entry, state.event, str_val,
1858bd82631dSTom Zanussi state.event->fields[i]->is_dynamic,
1859bd82631dSTom Zanussi data_size, &n_u64);
1860bd82631dSTom Zanussi data_size += len; /* only dynamic string increments */
1861726721a5STom Zanussi } else {
1862726721a5STom Zanussi struct synth_field *field = state.event->fields[i];
1863726721a5STom Zanussi u64 val = vals[i];
1864726721a5STom Zanussi
1865726721a5STom Zanussi switch (field->size) {
1866726721a5STom Zanussi case 1:
1867ddeea494SSven Schnelle state.entry->fields[n_u64].as_u8 = (u8)val;
1868726721a5STom Zanussi break;
1869726721a5STom Zanussi
1870726721a5STom Zanussi case 2:
1871ddeea494SSven Schnelle state.entry->fields[n_u64].as_u16 = (u16)val;
1872726721a5STom Zanussi break;
1873726721a5STom Zanussi
1874726721a5STom Zanussi case 4:
1875ddeea494SSven Schnelle state.entry->fields[n_u64].as_u32 = (u32)val;
1876726721a5STom Zanussi break;
1877726721a5STom Zanussi
1878726721a5STom Zanussi default:
1879ddeea494SSven Schnelle state.entry->fields[n_u64].as_u64 = val;
1880726721a5STom Zanussi break;
1881726721a5STom Zanussi }
1882726721a5STom Zanussi n_u64++;
1883726721a5STom Zanussi }
1884726721a5STom Zanussi }
1885726721a5STom Zanussi out:
1886726721a5STom Zanussi __synth_event_trace_end(&state);
1887726721a5STom Zanussi
1888726721a5STom Zanussi return ret;
1889726721a5STom Zanussi }
1890726721a5STom Zanussi EXPORT_SYMBOL_GPL(synth_event_trace_array);
1891726721a5STom Zanussi
1892726721a5STom Zanussi /**
1893726721a5STom Zanussi * synth_event_trace_start - Start piecewise synthetic event trace
1894726721a5STom Zanussi * @file: The trace_event_file representing the synthetic event
1895726721a5STom Zanussi * @trace_state: A pointer to object tracking the piecewise trace state
1896726721a5STom Zanussi *
1897726721a5STom Zanussi * Start the trace of a synthetic event field-by-field rather than all
1898726721a5STom Zanussi * at once.
1899726721a5STom Zanussi *
1900726721a5STom Zanussi * This function 'opens' an event trace, which means space is reserved
1901726721a5STom Zanussi * for the event in the trace buffer, after which the event's
1902726721a5STom Zanussi * individual field values can be set through either
1903726721a5STom Zanussi * synth_event_add_next_val() or synth_event_add_val().
1904726721a5STom Zanussi *
1905726721a5STom Zanussi * A pointer to a trace_state object is passed in, which will keep
1906726721a5STom Zanussi * track of the current event trace state until the event trace is
1907726721a5STom Zanussi * closed (and the event finally traced) using
1908726721a5STom Zanussi * synth_event_trace_end().
1909726721a5STom Zanussi *
1910726721a5STom Zanussi * Note that synth_event_trace_end() must be called after all values
1911726721a5STom Zanussi * have been added for each event trace, regardless of whether adding
1912726721a5STom Zanussi * all field values succeeded or not.
1913726721a5STom Zanussi *
1914726721a5STom Zanussi * Note also that for a given event trace, all fields must be added
1915726721a5STom Zanussi * using either synth_event_add_next_val() or synth_event_add_val()
1916726721a5STom Zanussi * but not both together or interleaved.
1917726721a5STom Zanussi *
1918726721a5STom Zanussi * Return: 0 on success, err otherwise.
1919726721a5STom Zanussi */
synth_event_trace_start(struct trace_event_file * file,struct synth_event_trace_state * trace_state)1920726721a5STom Zanussi int synth_event_trace_start(struct trace_event_file *file,
1921726721a5STom Zanussi struct synth_event_trace_state *trace_state)
1922726721a5STom Zanussi {
1923726721a5STom Zanussi int ret;
1924726721a5STom Zanussi
1925726721a5STom Zanussi if (!trace_state)
1926726721a5STom Zanussi return -EINVAL;
1927726721a5STom Zanussi
1928bd82631dSTom Zanussi ret = __synth_event_trace_init(file, trace_state);
1929bd82631dSTom Zanussi if (ret) {
1930726721a5STom Zanussi if (ret == -ENOENT)
1931726721a5STom Zanussi ret = 0; /* just disabled, not really an error */
1932bd82631dSTom Zanussi return ret;
1933bd82631dSTom Zanussi }
1934bd82631dSTom Zanussi
1935bd82631dSTom Zanussi if (trace_state->event->n_dynamic_fields)
1936bd82631dSTom Zanussi return -ENOTSUPP;
1937bd82631dSTom Zanussi
1938bd82631dSTom Zanussi ret = __synth_event_trace_start(file, trace_state, 0);
1939726721a5STom Zanussi
1940726721a5STom Zanussi return ret;
1941726721a5STom Zanussi }
1942726721a5STom Zanussi EXPORT_SYMBOL_GPL(synth_event_trace_start);
1943726721a5STom Zanussi
__synth_event_add_val(const char * field_name,u64 val,struct synth_event_trace_state * trace_state)1944726721a5STom Zanussi static int __synth_event_add_val(const char *field_name, u64 val,
1945726721a5STom Zanussi struct synth_event_trace_state *trace_state)
1946726721a5STom Zanussi {
1947726721a5STom Zanussi struct synth_field *field = NULL;
1948726721a5STom Zanussi struct synth_trace_event *entry;
1949726721a5STom Zanussi struct synth_event *event;
1950726721a5STom Zanussi int i, ret = 0;
1951726721a5STom Zanussi
1952726721a5STom Zanussi if (!trace_state) {
1953726721a5STom Zanussi ret = -EINVAL;
1954726721a5STom Zanussi goto out;
1955726721a5STom Zanussi }
1956726721a5STom Zanussi
1957726721a5STom Zanussi /* can't mix add_next_synth_val() with add_synth_val() */
1958726721a5STom Zanussi if (field_name) {
1959726721a5STom Zanussi if (trace_state->add_next) {
1960726721a5STom Zanussi ret = -EINVAL;
1961726721a5STom Zanussi goto out;
1962726721a5STom Zanussi }
1963726721a5STom Zanussi trace_state->add_name = true;
1964726721a5STom Zanussi } else {
1965726721a5STom Zanussi if (trace_state->add_name) {
1966726721a5STom Zanussi ret = -EINVAL;
1967726721a5STom Zanussi goto out;
1968726721a5STom Zanussi }
1969726721a5STom Zanussi trace_state->add_next = true;
1970726721a5STom Zanussi }
1971726721a5STom Zanussi
1972726721a5STom Zanussi if (trace_state->disabled)
1973726721a5STom Zanussi goto out;
1974726721a5STom Zanussi
1975726721a5STom Zanussi event = trace_state->event;
1976726721a5STom Zanussi if (trace_state->add_name) {
1977726721a5STom Zanussi for (i = 0; i < event->n_fields; i++) {
1978726721a5STom Zanussi field = event->fields[i];
1979726721a5STom Zanussi if (strcmp(field->name, field_name) == 0)
1980726721a5STom Zanussi break;
1981726721a5STom Zanussi }
1982726721a5STom Zanussi if (!field) {
1983726721a5STom Zanussi ret = -EINVAL;
1984726721a5STom Zanussi goto out;
1985726721a5STom Zanussi }
1986726721a5STom Zanussi } else {
1987726721a5STom Zanussi if (trace_state->cur_field >= event->n_fields) {
1988726721a5STom Zanussi ret = -EINVAL;
1989726721a5STom Zanussi goto out;
1990726721a5STom Zanussi }
1991726721a5STom Zanussi field = event->fields[trace_state->cur_field++];
1992726721a5STom Zanussi }
1993726721a5STom Zanussi
1994726721a5STom Zanussi entry = trace_state->entry;
1995726721a5STom Zanussi if (field->is_string) {
1996726721a5STom Zanussi char *str_val = (char *)(long)val;
1997726721a5STom Zanussi char *str_field;
1998726721a5STom Zanussi
1999bd82631dSTom Zanussi if (field->is_dynamic) { /* add_val can't do dynamic strings */
2000bd82631dSTom Zanussi ret = -EINVAL;
2001bd82631dSTom Zanussi goto out;
2002bd82631dSTom Zanussi }
2003bd82631dSTom Zanussi
2004726721a5STom Zanussi if (!str_val) {
2005726721a5STom Zanussi ret = -EINVAL;
2006726721a5STom Zanussi goto out;
2007726721a5STom Zanussi }
2008726721a5STom Zanussi
2009726721a5STom Zanussi str_field = (char *)&entry->fields[field->offset];
2010726721a5STom Zanussi strscpy(str_field, str_val, STR_VAR_LEN_MAX);
2011726721a5STom Zanussi } else {
2012726721a5STom Zanussi switch (field->size) {
2013726721a5STom Zanussi case 1:
2014ddeea494SSven Schnelle trace_state->entry->fields[field->offset].as_u8 = (u8)val;
2015726721a5STom Zanussi break;
2016726721a5STom Zanussi
2017726721a5STom Zanussi case 2:
2018ddeea494SSven Schnelle trace_state->entry->fields[field->offset].as_u16 = (u16)val;
2019726721a5STom Zanussi break;
2020726721a5STom Zanussi
2021726721a5STom Zanussi case 4:
2022ddeea494SSven Schnelle trace_state->entry->fields[field->offset].as_u32 = (u32)val;
2023726721a5STom Zanussi break;
2024726721a5STom Zanussi
2025726721a5STom Zanussi default:
2026ddeea494SSven Schnelle trace_state->entry->fields[field->offset].as_u64 = val;
2027726721a5STom Zanussi break;
2028726721a5STom Zanussi }
2029726721a5STom Zanussi }
2030726721a5STom Zanussi out:
2031726721a5STom Zanussi return ret;
2032726721a5STom Zanussi }
2033726721a5STom Zanussi
2034726721a5STom Zanussi /**
2035726721a5STom Zanussi * synth_event_add_next_val - Add the next field's value to an open synth trace
2036726721a5STom Zanussi * @val: The value to set the next field to
2037726721a5STom Zanussi * @trace_state: A pointer to object tracking the piecewise trace state
2038726721a5STom Zanussi *
2039726721a5STom Zanussi * Set the value of the next field in an event that's been opened by
2040726721a5STom Zanussi * synth_event_trace_start().
2041726721a5STom Zanussi *
2042726721a5STom Zanussi * The val param should be the value cast to u64. If the value points
2043726721a5STom Zanussi * to a string, the val param should be a char * cast to u64.
2044726721a5STom Zanussi *
2045726721a5STom Zanussi * This function assumes all the fields in an event are to be set one
2046726721a5STom Zanussi * after another - successive calls to this function are made, one for
2047726721a5STom Zanussi * each field, in the order of the fields in the event, until all
2048726721a5STom Zanussi * fields have been set. If you'd rather set each field individually
2049726721a5STom Zanussi * without regard to ordering, synth_event_add_val() can be used
2050726721a5STom Zanussi * instead.
2051726721a5STom Zanussi *
2052726721a5STom Zanussi * Note however that synth_event_add_next_val() and
2053726721a5STom Zanussi * synth_event_add_val() can't be intermixed for a given event trace -
2054726721a5STom Zanussi * one or the other but not both can be used at the same time.
2055726721a5STom Zanussi *
2056726721a5STom Zanussi * Note also that synth_event_trace_end() must be called after all
2057726721a5STom Zanussi * values have been added for each event trace, regardless of whether
2058726721a5STom Zanussi * adding all field values succeeded or not.
2059726721a5STom Zanussi *
2060726721a5STom Zanussi * Return: 0 on success, err otherwise.
2061726721a5STom Zanussi */
synth_event_add_next_val(u64 val,struct synth_event_trace_state * trace_state)2062726721a5STom Zanussi int synth_event_add_next_val(u64 val,
2063726721a5STom Zanussi struct synth_event_trace_state *trace_state)
2064726721a5STom Zanussi {
2065726721a5STom Zanussi return __synth_event_add_val(NULL, val, trace_state);
2066726721a5STom Zanussi }
2067726721a5STom Zanussi EXPORT_SYMBOL_GPL(synth_event_add_next_val);
2068726721a5STom Zanussi
2069726721a5STom Zanussi /**
2070726721a5STom Zanussi * synth_event_add_val - Add a named field's value to an open synth trace
2071726721a5STom Zanussi * @field_name: The name of the synthetic event field value to set
20721d83c3a2SQiujun Huang * @val: The value to set the named field to
2073726721a5STom Zanussi * @trace_state: A pointer to object tracking the piecewise trace state
2074726721a5STom Zanussi *
2075726721a5STom Zanussi * Set the value of the named field in an event that's been opened by
2076726721a5STom Zanussi * synth_event_trace_start().
2077726721a5STom Zanussi *
2078726721a5STom Zanussi * The val param should be the value cast to u64. If the value points
2079726721a5STom Zanussi * to a string, the val param should be a char * cast to u64.
2080726721a5STom Zanussi *
2081726721a5STom Zanussi * This function looks up the field name, and if found, sets the field
2082726721a5STom Zanussi * to the specified value. This lookup makes this function more
2083726721a5STom Zanussi * expensive than synth_event_add_next_val(), so use that or the
2084726721a5STom Zanussi * none-piecewise synth_event_trace() instead if efficiency is more
2085726721a5STom Zanussi * important.
2086726721a5STom Zanussi *
2087726721a5STom Zanussi * Note however that synth_event_add_next_val() and
2088726721a5STom Zanussi * synth_event_add_val() can't be intermixed for a given event trace -
2089726721a5STom Zanussi * one or the other but not both can be used at the same time.
2090726721a5STom Zanussi *
2091726721a5STom Zanussi * Note also that synth_event_trace_end() must be called after all
2092726721a5STom Zanussi * values have been added for each event trace, regardless of whether
2093726721a5STom Zanussi * adding all field values succeeded or not.
2094726721a5STom Zanussi *
2095726721a5STom Zanussi * Return: 0 on success, err otherwise.
2096726721a5STom Zanussi */
synth_event_add_val(const char * field_name,u64 val,struct synth_event_trace_state * trace_state)2097726721a5STom Zanussi int synth_event_add_val(const char *field_name, u64 val,
2098726721a5STom Zanussi struct synth_event_trace_state *trace_state)
2099726721a5STom Zanussi {
2100726721a5STom Zanussi return __synth_event_add_val(field_name, val, trace_state);
2101726721a5STom Zanussi }
2102726721a5STom Zanussi EXPORT_SYMBOL_GPL(synth_event_add_val);
2103726721a5STom Zanussi
2104726721a5STom Zanussi /**
2105726721a5STom Zanussi * synth_event_trace_end - End piecewise synthetic event trace
2106726721a5STom Zanussi * @trace_state: A pointer to object tracking the piecewise trace state
2107726721a5STom Zanussi *
2108726721a5STom Zanussi * End the trace of a synthetic event opened by
2109726721a5STom Zanussi * synth_event_trace__start().
2110726721a5STom Zanussi *
2111726721a5STom Zanussi * This function 'closes' an event trace, which basically means that
2112726721a5STom Zanussi * it commits the reserved event and cleans up other loose ends.
2113726721a5STom Zanussi *
2114726721a5STom Zanussi * A pointer to a trace_state object is passed in, which will keep
2115726721a5STom Zanussi * track of the current event trace state opened with
2116726721a5STom Zanussi * synth_event_trace_start().
2117726721a5STom Zanussi *
2118726721a5STom Zanussi * Note that this function must be called after all values have been
2119726721a5STom Zanussi * added for each event trace, regardless of whether adding all field
2120726721a5STom Zanussi * values succeeded or not.
2121726721a5STom Zanussi *
2122726721a5STom Zanussi * Return: 0 on success, err otherwise.
2123726721a5STom Zanussi */
synth_event_trace_end(struct synth_event_trace_state * trace_state)2124726721a5STom Zanussi int synth_event_trace_end(struct synth_event_trace_state *trace_state)
2125726721a5STom Zanussi {
2126726721a5STom Zanussi if (!trace_state)
2127726721a5STom Zanussi return -EINVAL;
2128726721a5STom Zanussi
2129726721a5STom Zanussi __synth_event_trace_end(trace_state);
2130726721a5STom Zanussi
2131726721a5STom Zanussi return 0;
2132726721a5STom Zanussi }
2133726721a5STom Zanussi EXPORT_SYMBOL_GPL(synth_event_trace_end);
2134726721a5STom Zanussi
create_synth_event(const char * raw_command)2135d262271dSMasami Hiramatsu static int create_synth_event(const char *raw_command)
2136726721a5STom Zanussi {
2137c9e759b1STom Zanussi char *fields, *p;
2138c9e759b1STom Zanussi const char *name;
2139c9e759b1STom Zanussi int len, ret = 0;
2140726721a5STom Zanussi
2141c9e759b1STom Zanussi raw_command = skip_spaces(raw_command);
2142c9e759b1STom Zanussi if (raw_command[0] == '\0')
2143d262271dSMasami Hiramatsu return ret;
2144d262271dSMasami Hiramatsu
2145c9e759b1STom Zanussi last_cmd_set(raw_command);
2146d262271dSMasami Hiramatsu
21474f67cca7SBeau Belgrave name = raw_command;
21484f67cca7SBeau Belgrave
21494f67cca7SBeau Belgrave /* Don't try to process if not our system */
21504f67cca7SBeau Belgrave if (name[0] != 's' || name[1] != ':')
21514f67cca7SBeau Belgrave return -ECANCELED;
21524f67cca7SBeau Belgrave name += 2;
21534f67cca7SBeau Belgrave
2154c9e759b1STom Zanussi p = strpbrk(raw_command, " \t");
21558d3e8165STom Zanussi if (!p) {
21568d3e8165STom Zanussi synth_err(SYNTH_ERR_INVALID_CMD, 0);
2157c9e759b1STom Zanussi return -EINVAL;
21588d3e8165STom Zanussi }
2159d262271dSMasami Hiramatsu
2160c9e759b1STom Zanussi fields = skip_spaces(p);
2161c9e759b1STom Zanussi
2162726721a5STom Zanussi /* This interface accepts group name prefix */
2163726721a5STom Zanussi if (strchr(name, '/')) {
2164726721a5STom Zanussi len = str_has_prefix(name, SYNTH_SYSTEM "/");
21658d3e8165STom Zanussi if (len == 0) {
21668d3e8165STom Zanussi synth_err(SYNTH_ERR_INVALID_DYN_CMD, 0);
2167c9e759b1STom Zanussi return -EINVAL;
21688d3e8165STom Zanussi }
2169726721a5STom Zanussi name += len;
2170726721a5STom Zanussi }
2171d262271dSMasami Hiramatsu
2172c9e759b1STom Zanussi len = name - raw_command;
2173c9e759b1STom Zanussi
2174c9e759b1STom Zanussi ret = check_command(raw_command + len);
2175c9e759b1STom Zanussi if (ret) {
21768d3e8165STom Zanussi synth_err(SYNTH_ERR_INVALID_CMD, 0);
2177c9e759b1STom Zanussi return ret;
2178c9e759b1STom Zanussi }
2179c9e759b1STom Zanussi
2180c9e759b1STom Zanussi name = kmemdup_nul(raw_command + len, p - raw_command - len, GFP_KERNEL);
2181c9e759b1STom Zanussi if (!name)
2182c9e759b1STom Zanussi return -ENOMEM;
2183c9e759b1STom Zanussi
2184c9e759b1STom Zanussi ret = __create_synth_event(name, fields);
2185c9e759b1STom Zanussi
2186c9e759b1STom Zanussi kfree(name);
2187d262271dSMasami Hiramatsu
2188d262271dSMasami Hiramatsu return ret;
2189726721a5STom Zanussi }
2190726721a5STom Zanussi
synth_event_release(struct dyn_event * ev)2191726721a5STom Zanussi static int synth_event_release(struct dyn_event *ev)
2192726721a5STom Zanussi {
2193726721a5STom Zanussi struct synth_event *event = to_synth_event(ev);
2194726721a5STom Zanussi int ret;
2195726721a5STom Zanussi
2196726721a5STom Zanussi if (event->ref)
2197726721a5STom Zanussi return -EBUSY;
2198726721a5STom Zanussi
21991d18538eSSteven Rostedt (VMware) if (trace_event_dyn_busy(&event->call))
22001d18538eSSteven Rostedt (VMware) return -EBUSY;
22011d18538eSSteven Rostedt (VMware)
2202726721a5STom Zanussi ret = unregister_synth_event(event);
2203726721a5STom Zanussi if (ret)
2204726721a5STom Zanussi return ret;
2205726721a5STom Zanussi
2206726721a5STom Zanussi dyn_event_remove(ev);
2207726721a5STom Zanussi free_synth_event(event);
2208726721a5STom Zanussi return 0;
2209726721a5STom Zanussi }
2210726721a5STom Zanussi
__synth_event_show(struct seq_file * m,struct synth_event * event)2211726721a5STom Zanussi static int __synth_event_show(struct seq_file *m, struct synth_event *event)
2212726721a5STom Zanussi {
2213726721a5STom Zanussi struct synth_field *field;
2214726721a5STom Zanussi unsigned int i;
22157d27adf5STom Zanussi char *type, *t;
2216726721a5STom Zanussi
2217726721a5STom Zanussi seq_printf(m, "%s\t", event->name);
2218726721a5STom Zanussi
2219726721a5STom Zanussi for (i = 0; i < event->n_fields; i++) {
2220726721a5STom Zanussi field = event->fields[i];
2221726721a5STom Zanussi
22227d27adf5STom Zanussi type = field->type;
22237d27adf5STom Zanussi t = strstr(type, "__data_loc");
22247d27adf5STom Zanussi if (t) { /* __data_loc belongs in format but not event desc */
22257d27adf5STom Zanussi t += sizeof("__data_loc");
22267d27adf5STom Zanussi type = t;
22277d27adf5STom Zanussi }
22287d27adf5STom Zanussi
2229726721a5STom Zanussi /* parameter values */
22307d27adf5STom Zanussi seq_printf(m, "%s %s%s", type, field->name,
2231726721a5STom Zanussi i == event->n_fields - 1 ? "" : "; ");
2232726721a5STom Zanussi }
2233726721a5STom Zanussi
2234726721a5STom Zanussi seq_putc(m, '\n');
2235726721a5STom Zanussi
2236726721a5STom Zanussi return 0;
2237726721a5STom Zanussi }
2238726721a5STom Zanussi
synth_event_show(struct seq_file * m,struct dyn_event * ev)2239726721a5STom Zanussi static int synth_event_show(struct seq_file *m, struct dyn_event *ev)
2240726721a5STom Zanussi {
2241726721a5STom Zanussi struct synth_event *event = to_synth_event(ev);
2242726721a5STom Zanussi
2243726721a5STom Zanussi seq_printf(m, "s:%s/", event->class.system);
2244726721a5STom Zanussi
2245726721a5STom Zanussi return __synth_event_show(m, event);
2246726721a5STom Zanussi }
2247726721a5STom Zanussi
synth_events_seq_show(struct seq_file * m,void * v)2248726721a5STom Zanussi static int synth_events_seq_show(struct seq_file *m, void *v)
2249726721a5STom Zanussi {
2250726721a5STom Zanussi struct dyn_event *ev = v;
2251726721a5STom Zanussi
2252726721a5STom Zanussi if (!is_synth_event(ev))
2253726721a5STom Zanussi return 0;
2254726721a5STom Zanussi
2255726721a5STom Zanussi return __synth_event_show(m, to_synth_event(ev));
2256726721a5STom Zanussi }
2257726721a5STom Zanussi
2258726721a5STom Zanussi static const struct seq_operations synth_events_seq_op = {
2259726721a5STom Zanussi .start = dyn_event_seq_start,
2260726721a5STom Zanussi .next = dyn_event_seq_next,
2261726721a5STom Zanussi .stop = dyn_event_seq_stop,
2262726721a5STom Zanussi .show = synth_events_seq_show,
2263726721a5STom Zanussi };
2264726721a5STom Zanussi
synth_events_open(struct inode * inode,struct file * file)2265726721a5STom Zanussi static int synth_events_open(struct inode *inode, struct file *file)
2266726721a5STom Zanussi {
2267726721a5STom Zanussi int ret;
2268726721a5STom Zanussi
2269726721a5STom Zanussi ret = security_locked_down(LOCKDOWN_TRACEFS);
2270726721a5STom Zanussi if (ret)
2271726721a5STom Zanussi return ret;
2272726721a5STom Zanussi
2273726721a5STom Zanussi if ((file->f_mode & FMODE_WRITE) && (file->f_flags & O_TRUNC)) {
2274726721a5STom Zanussi ret = dyn_events_release_all(&synth_event_ops);
2275726721a5STom Zanussi if (ret < 0)
2276726721a5STom Zanussi return ret;
2277726721a5STom Zanussi }
2278726721a5STom Zanussi
2279726721a5STom Zanussi return seq_open(file, &synth_events_seq_op);
2280726721a5STom Zanussi }
2281726721a5STom Zanussi
synth_events_write(struct file * file,const char __user * buffer,size_t count,loff_t * ppos)2282726721a5STom Zanussi static ssize_t synth_events_write(struct file *file,
2283726721a5STom Zanussi const char __user *buffer,
2284726721a5STom Zanussi size_t count, loff_t *ppos)
2285726721a5STom Zanussi {
2286726721a5STom Zanussi return trace_parse_run_command(file, buffer, count, ppos,
2287726721a5STom Zanussi create_or_delete_synth_event);
2288726721a5STom Zanussi }
2289726721a5STom Zanussi
2290726721a5STom Zanussi static const struct file_operations synth_events_fops = {
2291726721a5STom Zanussi .open = synth_events_open,
2292726721a5STom Zanussi .write = synth_events_write,
2293726721a5STom Zanussi .read = seq_read,
2294726721a5STom Zanussi .llseek = seq_lseek,
2295726721a5STom Zanussi .release = seq_release,
2296726721a5STom Zanussi };
2297726721a5STom Zanussi
2298ba0fbfbbSMasami Hiramatsu /*
2299ba0fbfbbSMasami Hiramatsu * Register dynevent at core_initcall. This allows kernel to setup kprobe
2300ba0fbfbbSMasami Hiramatsu * events in postcore_initcall without tracefs.
2301ba0fbfbbSMasami Hiramatsu */
trace_events_synth_init_early(void)2302ba0fbfbbSMasami Hiramatsu static __init int trace_events_synth_init_early(void)
2303ba0fbfbbSMasami Hiramatsu {
2304ba0fbfbbSMasami Hiramatsu int err = 0;
2305ba0fbfbbSMasami Hiramatsu
2306ba0fbfbbSMasami Hiramatsu err = dyn_event_register(&synth_event_ops);
2307ba0fbfbbSMasami Hiramatsu if (err)
2308ba0fbfbbSMasami Hiramatsu pr_warn("Could not register synth_event_ops\n");
2309ba0fbfbbSMasami Hiramatsu
2310ba0fbfbbSMasami Hiramatsu return err;
2311ba0fbfbbSMasami Hiramatsu }
2312ba0fbfbbSMasami Hiramatsu core_initcall(trace_events_synth_init_early);
2313ba0fbfbbSMasami Hiramatsu
trace_events_synth_init(void)2314726721a5STom Zanussi static __init int trace_events_synth_init(void)
2315726721a5STom Zanussi {
2316726721a5STom Zanussi struct dentry *entry = NULL;
2317726721a5STom Zanussi int err = 0;
231822c36b18SWei Yang err = tracing_init_dentry();
231922c36b18SWei Yang if (err)
2320726721a5STom Zanussi goto err;
2321726721a5STom Zanussi
232221ccc9cdSSteven Rostedt (VMware) entry = tracefs_create_file("synthetic_events", TRACE_MODE_WRITE,
232321ccc9cdSSteven Rostedt (VMware) NULL, NULL, &synth_events_fops);
2324726721a5STom Zanussi if (!entry) {
2325726721a5STom Zanussi err = -ENODEV;
2326726721a5STom Zanussi goto err;
2327726721a5STom Zanussi }
2328726721a5STom Zanussi
2329726721a5STom Zanussi return err;
2330726721a5STom Zanussi err:
2331726721a5STom Zanussi pr_warn("Could not create tracefs 'synthetic_events' entry\n");
2332726721a5STom Zanussi
2333726721a5STom Zanussi return err;
2334726721a5STom Zanussi }
2335726721a5STom Zanussi
2336726721a5STom Zanussi fs_initcall(trace_events_synth_init);
2337