tracing: Add dynamic event command creation interface
[linux-2.6-microblaze.git] / kernel / trace / trace_dynevent.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Generic dynamic event control interface
4  *
5  * Copyright (C) 2018 Masami Hiramatsu <mhiramat@kernel.org>
6  */
7
8 #include <linux/debugfs.h>
9 #include <linux/kernel.h>
10 #include <linux/list.h>
11 #include <linux/mm.h>
12 #include <linux/mutex.h>
13 #include <linux/tracefs.h>
14
15 #include "trace.h"
16 #include "trace_dynevent.h"
17
18 static DEFINE_MUTEX(dyn_event_ops_mutex);
19 static LIST_HEAD(dyn_event_ops_list);
20
21 int dyn_event_register(struct dyn_event_operations *ops)
22 {
23         if (!ops || !ops->create || !ops->show || !ops->is_busy ||
24             !ops->free || !ops->match)
25                 return -EINVAL;
26
27         INIT_LIST_HEAD(&ops->list);
28         mutex_lock(&dyn_event_ops_mutex);
29         list_add_tail(&ops->list, &dyn_event_ops_list);
30         mutex_unlock(&dyn_event_ops_mutex);
31         return 0;
32 }
33
34 int dyn_event_release(int argc, char **argv, struct dyn_event_operations *type)
35 {
36         struct dyn_event *pos, *n;
37         char *system = NULL, *event, *p;
38         int ret = -ENOENT;
39
40         if (argv[0][0] == '-') {
41                 if (argv[0][1] != ':')
42                         return -EINVAL;
43                 event = &argv[0][2];
44         } else {
45                 event = strchr(argv[0], ':');
46                 if (!event)
47                         return -EINVAL;
48                 event++;
49         }
50         argc--; argv++;
51
52         p = strchr(event, '/');
53         if (p) {
54                 system = event;
55                 event = p + 1;
56                 *p = '\0';
57         }
58         if (event[0] == '\0')
59                 return -EINVAL;
60
61         mutex_lock(&event_mutex);
62         for_each_dyn_event_safe(pos, n) {
63                 if (type && type != pos->ops)
64                         continue;
65                 if (!pos->ops->match(system, event,
66                                 argc, (const char **)argv, pos))
67                         continue;
68
69                 ret = pos->ops->free(pos);
70                 if (ret)
71                         break;
72         }
73         mutex_unlock(&event_mutex);
74
75         return ret;
76 }
77
78 static int create_dyn_event(int argc, char **argv)
79 {
80         struct dyn_event_operations *ops;
81         int ret = -ENODEV;
82
83         if (argv[0][0] == '-' || argv[0][0] == '!')
84                 return dyn_event_release(argc, argv, NULL);
85
86         mutex_lock(&dyn_event_ops_mutex);
87         list_for_each_entry(ops, &dyn_event_ops_list, list) {
88                 ret = ops->create(argc, (const char **)argv);
89                 if (!ret || ret != -ECANCELED)
90                         break;
91         }
92         mutex_unlock(&dyn_event_ops_mutex);
93         if (ret == -ECANCELED)
94                 ret = -EINVAL;
95
96         return ret;
97 }
98
99 /* Protected by event_mutex */
100 LIST_HEAD(dyn_event_list);
101
102 void *dyn_event_seq_start(struct seq_file *m, loff_t *pos)
103 {
104         mutex_lock(&event_mutex);
105         return seq_list_start(&dyn_event_list, *pos);
106 }
107
108 void *dyn_event_seq_next(struct seq_file *m, void *v, loff_t *pos)
109 {
110         return seq_list_next(v, &dyn_event_list, pos);
111 }
112
113 void dyn_event_seq_stop(struct seq_file *m, void *v)
114 {
115         mutex_unlock(&event_mutex);
116 }
117
118 static int dyn_event_seq_show(struct seq_file *m, void *v)
119 {
120         struct dyn_event *ev = v;
121
122         if (ev && ev->ops)
123                 return ev->ops->show(m, ev);
124
125         return 0;
126 }
127
128 static const struct seq_operations dyn_event_seq_op = {
129         .start  = dyn_event_seq_start,
130         .next   = dyn_event_seq_next,
131         .stop   = dyn_event_seq_stop,
132         .show   = dyn_event_seq_show
133 };
134
135 /*
136  * dyn_events_release_all - Release all specific events
137  * @type:       the dyn_event_operations * which filters releasing events
138  *
139  * This releases all events which ->ops matches @type. If @type is NULL,
140  * all events are released.
141  * Return -EBUSY if any of them are in use, and return other errors when
142  * it failed to free the given event. Except for -EBUSY, event releasing
143  * process will be aborted at that point and there may be some other
144  * releasable events on the list.
145  */
146 int dyn_events_release_all(struct dyn_event_operations *type)
147 {
148         struct dyn_event *ev, *tmp;
149         int ret = 0;
150
151         mutex_lock(&event_mutex);
152         for_each_dyn_event(ev) {
153                 if (type && ev->ops != type)
154                         continue;
155                 if (ev->ops->is_busy(ev)) {
156                         ret = -EBUSY;
157                         goto out;
158                 }
159         }
160         for_each_dyn_event_safe(ev, tmp) {
161                 if (type && ev->ops != type)
162                         continue;
163                 ret = ev->ops->free(ev);
164                 if (ret)
165                         break;
166         }
167 out:
168         mutex_unlock(&event_mutex);
169
170         return ret;
171 }
172
173 static int dyn_event_open(struct inode *inode, struct file *file)
174 {
175         int ret;
176
177         ret = tracing_check_open_get_tr(NULL);
178         if (ret)
179                 return ret;
180
181         if ((file->f_mode & FMODE_WRITE) && (file->f_flags & O_TRUNC)) {
182                 ret = dyn_events_release_all(NULL);
183                 if (ret < 0)
184                         return ret;
185         }
186
187         return seq_open(file, &dyn_event_seq_op);
188 }
189
190 static ssize_t dyn_event_write(struct file *file, const char __user *buffer,
191                                 size_t count, loff_t *ppos)
192 {
193         return trace_parse_run_command(file, buffer, count, ppos,
194                                        create_dyn_event);
195 }
196
197 static const struct file_operations dynamic_events_ops = {
198         .owner          = THIS_MODULE,
199         .open           = dyn_event_open,
200         .read           = seq_read,
201         .llseek         = seq_lseek,
202         .release        = seq_release,
203         .write          = dyn_event_write,
204 };
205
206 /* Make a tracefs interface for controlling dynamic events */
207 static __init int init_dynamic_event(void)
208 {
209         struct dentry *d_tracer;
210         struct dentry *entry;
211
212         d_tracer = tracing_init_dentry();
213         if (IS_ERR(d_tracer))
214                 return 0;
215
216         entry = tracefs_create_file("dynamic_events", 0644, d_tracer,
217                                     NULL, &dynamic_events_ops);
218
219         /* Event list interface */
220         if (!entry)
221                 pr_warn("Could not create tracefs 'dynamic_events' entry\n");
222
223         return 0;
224 }
225 fs_initcall(init_dynamic_event);
226
227 /**
228  * dynevent_arg_add - Add an arg to a dynevent_cmd
229  * @cmd: A pointer to the dynevent_cmd struct representing the new event cmd
230  * @arg: The argument to append to the current cmd
231  *
232  * Append an argument to a dynevent_cmd.  The argument string will be
233  * appended to the current cmd string, followed by a separator, if
234  * applicable.  Before the argument is added, the check_arg()
235  * function, if defined, is called.
236  *
237  * The cmd string, separator, and check_arg() function should be set
238  * using the dynevent_arg_init() before any arguments are added using
239  * this function.
240  *
241  * Return: 0 if successful, error otherwise.
242  */
243 int dynevent_arg_add(struct dynevent_cmd *cmd,
244                      struct dynevent_arg *arg)
245 {
246         int ret = 0;
247         int delta;
248         char *q;
249
250         if (arg->check_arg) {
251                 ret = arg->check_arg(arg);
252                 if (ret)
253                         return ret;
254         }
255
256         q = cmd->buf + (cmd->maxlen - cmd->remaining);
257
258         delta = snprintf(q, cmd->remaining, " %s%c", arg->str, arg->separator);
259         if (delta >= cmd->remaining) {
260                 pr_err("String is too long: %s\n", arg->str);
261                 return -E2BIG;
262         }
263         cmd->remaining -= delta;
264
265         return ret;
266 }
267
268 /**
269  * dynevent_arg_pair_add - Add an arg pair to a dynevent_cmd
270  * @cmd: A pointer to the dynevent_cmd struct representing the new event cmd
271  * @arg_pair: The argument pair to append to the current cmd
272  *
273  * Append an argument pair to a dynevent_cmd.  An argument pair
274  * consists of a left-hand-side argument and a right-hand-side
275  * argument separated by an operator, which can be whitespace, all
276  * followed by a separator, if applicable.  This can be used to add
277  * arguments of the form 'type variable_name;' or 'x+y'.
278  *
279  * The lhs argument string will be appended to the current cmd string,
280  * followed by an operator, if applicable, followd by the rhs string,
281  * followed finally by a separator, if applicable.  Before anything is
282  * added, the check_arg() function, if defined, is called.
283  *
284  * The cmd strings, operator, separator, and check_arg() function
285  * should be set using the dynevent_arg_pair_init() before any arguments
286  * are added using this function.
287  *
288  * Return: 0 if successful, error otherwise.
289  */
290 int dynevent_arg_pair_add(struct dynevent_cmd *cmd,
291                           struct dynevent_arg_pair *arg_pair)
292 {
293         int ret = 0;
294         int delta;
295         char *q;
296
297         if (arg_pair->check_arg) {
298                 ret = arg_pair->check_arg(arg_pair);
299                 if (ret)
300                         return ret;
301         }
302
303         q = cmd->buf + (cmd->maxlen - cmd->remaining);
304
305         delta = snprintf(q, cmd->remaining, " %s%c", arg_pair->lhs,
306                          arg_pair->operator);
307         if (delta >= cmd->remaining) {
308                 pr_err("field string is too long: %s\n", arg_pair->lhs);
309                 return -E2BIG;
310         }
311         cmd->remaining -= delta; q += delta;
312
313         delta = snprintf(q, cmd->remaining, "%s%c", arg_pair->rhs,
314                          arg_pair->separator);
315         if (delta >= cmd->remaining) {
316                 pr_err("field string is too long: %s\n", arg_pair->rhs);
317                 return -E2BIG;
318         }
319         cmd->remaining -= delta; q += delta;
320
321         return ret;
322 }
323
324 /**
325  * dynevent_str_add - Add a string to a dynevent_cmd
326  * @cmd: A pointer to the dynevent_cmd struct representing the new event cmd
327  * @str: The string to append to the current cmd
328  *
329  * Append a string to a dynevent_cmd.  The string will be appended to
330  * the current cmd string as-is, with nothing prepended or appended.
331  *
332  * Return: 0 if successful, error otherwise.
333  */
334 int dynevent_str_add(struct dynevent_cmd *cmd, const char *str)
335 {
336         int ret = 0;
337         int delta;
338         char *q;
339
340         q = cmd->buf + (cmd->maxlen - cmd->remaining);
341
342         delta = snprintf(q, cmd->remaining, "%s", str);
343         if (delta >= cmd->remaining) {
344                 pr_err("String is too long: %s\n", str);
345                 return -E2BIG;
346         }
347         cmd->remaining -= delta;
348
349         return ret;
350 }
351
352 /**
353  * dynevent_cmd_init - Initialize a dynevent_cmd object
354  * @cmd: A pointer to the dynevent_cmd struct representing the cmd
355  * @buf: A pointer to the buffer to generate the command into
356  * @maxlen: The length of the buffer the command will be generated into
357  * @type: The type of the cmd, checked against further operations
358  * @run_command: The type-specific function that will actually run the command
359  *
360  * Initialize a dynevent_cmd.  A dynevent_cmd is used to build up and
361  * run dynamic event creation commands, such as commands for creating
362  * synthetic and kprobe events.  Before calling any of the functions
363  * used to build the command, a dynevent_cmd object should be
364  * instantiated and initialized using this function.
365  *
366  * The initialization sets things up by saving a pointer to the
367  * user-supplied buffer and its length via the @buf and @maxlen
368  * params, and by saving the cmd-specific @type and @run_command
369  * params which are used to check subsequent dynevent_cmd operations
370  * and actually run the command when complete.
371  */
372 void dynevent_cmd_init(struct dynevent_cmd *cmd, char *buf, int maxlen,
373                        enum dynevent_type type,
374                        dynevent_create_fn_t run_command)
375 {
376         memset(cmd, '\0', sizeof(*cmd));
377
378         cmd->buf = buf;
379         cmd->maxlen = maxlen;
380         cmd->remaining = cmd->maxlen;
381         cmd->type = type;
382         cmd->run_command = run_command;
383 }
384
385 /**
386  * dynevent_arg_init - Initialize a dynevent_arg object
387  * @arg: A pointer to the dynevent_arg struct representing the arg
388  * @check_arg: An (optional) pointer to a function checking arg sanity
389  * @separator: An (optional) separator, appended after adding the arg
390  *
391  * Initialize a dynevent_arg object.  A dynevent_arg represents an
392  * object used to append single arguments to the current command
393  * string.  The @check_arg function, if present, will be used to check
394  * the sanity of the current arg string (which is directly set by the
395  * caller).  After the arg string is successfully appended to the
396  * command string, the optional @separator is appended.  If no
397  * separator was specified when initializing the arg, a space will be
398  * appended.
399  */
400 void dynevent_arg_init(struct dynevent_arg *arg,
401                        dynevent_check_arg_fn_t check_arg,
402                        char separator)
403 {
404         memset(arg, '\0', sizeof(*arg));
405
406         if (!separator)
407                 separator = ' ';
408         arg->separator = separator;
409
410         arg->check_arg = check_arg;
411 }
412
413 /**
414  * dynevent_arg_pair_init - Initialize a dynevent_arg_pair object
415  * @arg_pair: A pointer to the dynevent_arg_pair struct representing the arg
416  * @check_arg: An (optional) pointer to a function checking arg sanity
417  * @operator: An (optional) operator, appended after adding the first arg
418  * @separator: An (optional) separator, appended after adding the second arg
419  *
420  * Initialize a dynevent_arg_pair object.  A dynevent_arg_pair
421  * represents an object used to append argument pairs such as 'type
422  * variable_name;' or 'x+y' to the current command string.  An
423  * argument pair consists of a left-hand-side argument and a
424  * right-hand-side argument separated by an operator, which can be
425  * whitespace, all followed by a separator, if applicable. The
426  * @check_arg function, if present, will be used to check the sanity
427  * of the current arg strings (which is directly set by the caller).
428  * After the first arg string is successfully appended to the command
429  * string, the optional @operator is appended, followed by the second
430  * arg and and optional @separator.  If no separator was specified
431  * when initializing the arg, a space will be appended.
432  */
433 void dynevent_arg_pair_init(struct dynevent_arg_pair *arg_pair,
434                             dynevent_check_arg_fn_t check_arg,
435                             char operator, char separator)
436 {
437         memset(arg_pair, '\0', sizeof(*arg_pair));
438
439         if (!operator)
440                 operator = ' ';
441         arg_pair->operator = operator;
442
443         if (!separator)
444                 separator = ' ';
445         arg_pair->separator = separator;
446
447         arg_pair->check_arg = check_arg;
448 }
449
450 /**
451  * dynevent_create - Create the dynamic event contained in dynevent_cmd
452  * @cmd: The dynevent_cmd object containing the dynamic event creation command
453  *
454  * Once a dynevent_cmd object has been successfully built up via the
455  * dynevent_cmd_init(), dynevent_arg_add() and dynevent_arg_pair_add()
456  * functions, this function runs the final command to actually create
457  * the event.
458  *
459  * Return: 0 if the event was successfully created, error otherwise.
460  */
461 int dynevent_create(struct dynevent_cmd *cmd)
462 {
463         return cmd->run_command(cmd);
464 }
465 EXPORT_SYMBOL_GPL(dynevent_create);