1 // SPDX-License-Identifier: GPL-2.0
3 * trace_events_trigger - trace event triggers
5 * Copyright (C) 2013 Tom Zanussi <tom.zanussi@linux.intel.com>
8 #include <linux/security.h>
9 #include <linux/module.h>
10 #include <linux/ctype.h>
11 #include <linux/mutex.h>
12 #include <linux/slab.h>
13 #include <linux/rculist.h>
17 static LIST_HEAD(trigger_commands);
18 static DEFINE_MUTEX(trigger_cmd_mutex);
20 void trigger_data_free(struct event_trigger_data *data)
22 if (data->cmd_ops->set_filter)
23 data->cmd_ops->set_filter(NULL, data, NULL);
25 /* make sure current triggers exit before free */
26 tracepoint_synchronize_unregister();
32 * event_triggers_call - Call triggers associated with a trace event
33 * @file: The trace_event_file associated with the event
34 * @rec: The trace entry for the event, NULL for unconditional invocation
36 * For each trigger associated with an event, invoke the trigger
37 * function registered with the associated trigger command. If rec is
38 * non-NULL, it means that the trigger requires further processing and
39 * shouldn't be unconditionally invoked. If rec is non-NULL and the
40 * trigger has a filter associated with it, rec will checked against
41 * the filter and if the record matches the trigger will be invoked.
42 * If the trigger is a 'post_trigger', meaning it shouldn't be invoked
43 * in any case until the current event is written, the trigger
44 * function isn't invoked but the bit associated with the deferred
45 * trigger is set in the return value.
47 * Returns an enum event_trigger_type value containing a set bit for
48 * any trigger that should be deferred, ETT_NONE if nothing to defer.
50 * Called from tracepoint handlers (with rcu_read_lock_sched() held).
52 * Return: an enum event_trigger_type value containing a set bit for
53 * any trigger that should be deferred, ETT_NONE if nothing to defer.
55 enum event_trigger_type
56 event_triggers_call(struct trace_event_file *file, void *rec,
57 struct ring_buffer_event *event)
59 struct event_trigger_data *data;
60 enum event_trigger_type tt = ETT_NONE;
61 struct event_filter *filter;
63 if (list_empty(&file->triggers))
66 list_for_each_entry_rcu(data, &file->triggers, list) {
70 data->ops->func(data, rec, event);
73 filter = rcu_dereference_sched(data->filter);
74 if (filter && !filter_match_preds(filter, rec))
76 if (event_command_post_trigger(data->cmd_ops)) {
77 tt |= data->cmd_ops->trigger_type;
80 data->ops->func(data, rec, event);
84 EXPORT_SYMBOL_GPL(event_triggers_call);
87 * event_triggers_post_call - Call 'post_triggers' for a trace event
88 * @file: The trace_event_file associated with the event
89 * @tt: enum event_trigger_type containing a set bit for each trigger to invoke
91 * For each trigger associated with an event, invoke the trigger
92 * function registered with the associated trigger command, if the
93 * corresponding bit is set in the tt enum passed into this function.
94 * See @event_triggers_call for details on how those bits are set.
96 * Called from tracepoint handlers (with rcu_read_lock_sched() held).
99 event_triggers_post_call(struct trace_event_file *file,
100 enum event_trigger_type tt)
102 struct event_trigger_data *data;
104 list_for_each_entry_rcu(data, &file->triggers, list) {
107 if (data->cmd_ops->trigger_type & tt)
108 data->ops->func(data, NULL, NULL);
111 EXPORT_SYMBOL_GPL(event_triggers_post_call);
113 #define SHOW_AVAILABLE_TRIGGERS (void *)(1UL)
115 static void *trigger_next(struct seq_file *m, void *t, loff_t *pos)
117 struct trace_event_file *event_file = event_file_data(m->private);
119 if (t == SHOW_AVAILABLE_TRIGGERS)
122 return seq_list_next(t, &event_file->triggers, pos);
125 static void *trigger_start(struct seq_file *m, loff_t *pos)
127 struct trace_event_file *event_file;
129 /* ->stop() is called even if ->start() fails */
130 mutex_lock(&event_mutex);
131 event_file = event_file_data(m->private);
132 if (unlikely(!event_file))
133 return ERR_PTR(-ENODEV);
135 if (list_empty(&event_file->triggers))
136 return *pos == 0 ? SHOW_AVAILABLE_TRIGGERS : NULL;
138 return seq_list_start(&event_file->triggers, *pos);
141 static void trigger_stop(struct seq_file *m, void *t)
143 mutex_unlock(&event_mutex);
146 static int trigger_show(struct seq_file *m, void *v)
148 struct event_trigger_data *data;
149 struct event_command *p;
151 if (v == SHOW_AVAILABLE_TRIGGERS) {
152 seq_puts(m, "# Available triggers:\n");
154 mutex_lock(&trigger_cmd_mutex);
155 list_for_each_entry_reverse(p, &trigger_commands, list)
156 seq_printf(m, " %s", p->name);
158 mutex_unlock(&trigger_cmd_mutex);
162 data = list_entry(v, struct event_trigger_data, list);
163 data->ops->print(m, data->ops, data);
168 static const struct seq_operations event_triggers_seq_ops = {
169 .start = trigger_start,
170 .next = trigger_next,
171 .stop = trigger_stop,
172 .show = trigger_show,
175 static int event_trigger_regex_open(struct inode *inode, struct file *file)
179 ret = security_locked_down(LOCKDOWN_TRACEFS);
183 mutex_lock(&event_mutex);
185 if (unlikely(!event_file_data(file))) {
186 mutex_unlock(&event_mutex);
190 if ((file->f_mode & FMODE_WRITE) &&
191 (file->f_flags & O_TRUNC)) {
192 struct trace_event_file *event_file;
193 struct event_command *p;
195 event_file = event_file_data(file);
197 list_for_each_entry(p, &trigger_commands, list) {
199 p->unreg_all(event_file);
203 if (file->f_mode & FMODE_READ) {
204 ret = seq_open(file, &event_triggers_seq_ops);
206 struct seq_file *m = file->private_data;
211 mutex_unlock(&event_mutex);
216 static int trigger_process_regex(struct trace_event_file *file, char *buff)
218 char *command, *next = buff;
219 struct event_command *p;
222 command = strsep(&next, ": \t");
223 command = (command[0] != '!') ? command : command + 1;
225 mutex_lock(&trigger_cmd_mutex);
226 list_for_each_entry(p, &trigger_commands, list) {
227 if (strcmp(p->name, command) == 0) {
228 ret = p->func(p, file, buff, command, next);
233 mutex_unlock(&trigger_cmd_mutex);
238 static ssize_t event_trigger_regex_write(struct file *file,
239 const char __user *ubuf,
240 size_t cnt, loff_t *ppos)
242 struct trace_event_file *event_file;
249 if (cnt >= PAGE_SIZE)
252 buf = memdup_user_nul(ubuf, cnt);
258 mutex_lock(&event_mutex);
259 event_file = event_file_data(file);
260 if (unlikely(!event_file)) {
261 mutex_unlock(&event_mutex);
265 ret = trigger_process_regex(event_file, buf);
266 mutex_unlock(&event_mutex);
278 static int event_trigger_regex_release(struct inode *inode, struct file *file)
280 mutex_lock(&event_mutex);
282 if (file->f_mode & FMODE_READ)
283 seq_release(inode, file);
285 mutex_unlock(&event_mutex);
291 event_trigger_write(struct file *filp, const char __user *ubuf,
292 size_t cnt, loff_t *ppos)
294 return event_trigger_regex_write(filp, ubuf, cnt, ppos);
298 event_trigger_open(struct inode *inode, struct file *filp)
300 /* Checks for tracefs lockdown */
301 return event_trigger_regex_open(inode, filp);
305 event_trigger_release(struct inode *inode, struct file *file)
307 return event_trigger_regex_release(inode, file);
310 const struct file_operations event_trigger_fops = {
311 .open = event_trigger_open,
313 .write = event_trigger_write,
314 .llseek = tracing_lseek,
315 .release = event_trigger_release,
319 * Currently we only register event commands from __init, so mark this
322 __init int register_event_command(struct event_command *cmd)
324 struct event_command *p;
327 mutex_lock(&trigger_cmd_mutex);
328 list_for_each_entry(p, &trigger_commands, list) {
329 if (strcmp(cmd->name, p->name) == 0) {
334 list_add(&cmd->list, &trigger_commands);
336 mutex_unlock(&trigger_cmd_mutex);
342 * Currently we only unregister event commands from __init, so mark
345 __init int unregister_event_command(struct event_command *cmd)
347 struct event_command *p, *n;
350 mutex_lock(&trigger_cmd_mutex);
351 list_for_each_entry_safe(p, n, &trigger_commands, list) {
352 if (strcmp(cmd->name, p->name) == 0) {
354 list_del_init(&p->list);
359 mutex_unlock(&trigger_cmd_mutex);
365 * event_trigger_print - Generic event_trigger_ops @print implementation
366 * @name: The name of the event trigger
367 * @m: The seq_file being printed to
368 * @data: Trigger-specific data
369 * @filter_str: filter_str to print, if present
371 * Common implementation for event triggers to print themselves.
373 * Usually wrapped by a function that simply sets the @name of the
374 * trigger command and then invokes this.
376 * Return: 0 on success, errno otherwise
379 event_trigger_print(const char *name, struct seq_file *m,
380 void *data, char *filter_str)
382 long count = (long)data;
387 seq_puts(m, ":unlimited");
389 seq_printf(m, ":count=%ld", count);
392 seq_printf(m, " if %s\n", filter_str);
400 * event_trigger_init - Generic event_trigger_ops @init implementation
401 * @ops: The trigger ops associated with the trigger
402 * @data: Trigger-specific data
404 * Common implementation of event trigger initialization.
406 * Usually used directly as the @init method in event trigger
409 * Return: 0 on success, errno otherwise
411 int event_trigger_init(struct event_trigger_ops *ops,
412 struct event_trigger_data *data)
419 * event_trigger_free - Generic event_trigger_ops @free implementation
420 * @ops: The trigger ops associated with the trigger
421 * @data: Trigger-specific data
423 * Common implementation of event trigger de-initialization.
425 * Usually used directly as the @free method in event trigger
429 event_trigger_free(struct event_trigger_ops *ops,
430 struct event_trigger_data *data)
432 if (WARN_ON_ONCE(data->ref <= 0))
437 trigger_data_free(data);
440 int trace_event_trigger_enable_disable(struct trace_event_file *file,
445 if (trigger_enable) {
446 if (atomic_inc_return(&file->tm_ref) > 1)
448 set_bit(EVENT_FILE_FL_TRIGGER_MODE_BIT, &file->flags);
449 ret = trace_event_enable_disable(file, 1, 1);
451 if (atomic_dec_return(&file->tm_ref) > 0)
453 clear_bit(EVENT_FILE_FL_TRIGGER_MODE_BIT, &file->flags);
454 ret = trace_event_enable_disable(file, 0, 1);
461 * clear_event_triggers - Clear all triggers associated with a trace array
462 * @tr: The trace array to clear
464 * For each trigger, the triggering event has its tm_ref decremented
465 * via trace_event_trigger_enable_disable(), and any associated event
466 * (in the case of enable/disable_event triggers) will have its sm_ref
467 * decremented via free()->trace_event_enable_disable(). That
468 * combination effectively reverses the soft-mode/trigger state added
469 * by trigger registration.
471 * Must be called with event_mutex held.
474 clear_event_triggers(struct trace_array *tr)
476 struct trace_event_file *file;
478 list_for_each_entry(file, &tr->events, list) {
479 struct event_trigger_data *data, *n;
480 list_for_each_entry_safe(data, n, &file->triggers, list) {
481 trace_event_trigger_enable_disable(file, 0);
482 list_del_rcu(&data->list);
484 data->ops->free(data->ops, data);
490 * update_cond_flag - Set or reset the TRIGGER_COND bit
491 * @file: The trace_event_file associated with the event
493 * If an event has triggers and any of those triggers has a filter or
494 * a post_trigger, trigger invocation needs to be deferred until after
495 * the current event has logged its data, and the event should have
496 * its TRIGGER_COND bit set, otherwise the TRIGGER_COND bit should be
499 void update_cond_flag(struct trace_event_file *file)
501 struct event_trigger_data *data;
502 bool set_cond = false;
504 lockdep_assert_held(&event_mutex);
506 list_for_each_entry(data, &file->triggers, list) {
507 if (data->filter || event_command_post_trigger(data->cmd_ops) ||
508 event_command_needs_rec(data->cmd_ops)) {
515 set_bit(EVENT_FILE_FL_TRIGGER_COND_BIT, &file->flags);
517 clear_bit(EVENT_FILE_FL_TRIGGER_COND_BIT, &file->flags);
521 * register_trigger - Generic event_command @reg implementation
522 * @glob: The raw string used to register the trigger
523 * @ops: The trigger ops associated with the trigger
524 * @data: Trigger-specific data to associate with the trigger
525 * @file: The trace_event_file associated with the event
527 * Common implementation for event trigger registration.
529 * Usually used directly as the @reg method in event command
532 * Return: 0 on success, errno otherwise
534 static int register_trigger(char *glob, struct event_trigger_ops *ops,
535 struct event_trigger_data *data,
536 struct trace_event_file *file)
538 struct event_trigger_data *test;
541 lockdep_assert_held(&event_mutex);
543 list_for_each_entry(test, &file->triggers, list) {
544 if (test->cmd_ops->trigger_type == data->cmd_ops->trigger_type) {
550 if (data->ops->init) {
551 ret = data->ops->init(data->ops, data);
556 list_add_rcu(&data->list, &file->triggers);
559 update_cond_flag(file);
560 if (trace_event_trigger_enable_disable(file, 1) < 0) {
561 list_del_rcu(&data->list);
562 update_cond_flag(file);
570 * unregister_trigger - Generic event_command @unreg implementation
571 * @glob: The raw string used to register the trigger
572 * @ops: The trigger ops associated with the trigger
573 * @test: Trigger-specific data used to find the trigger to remove
574 * @file: The trace_event_file associated with the event
576 * Common implementation for event trigger unregistration.
578 * Usually used directly as the @unreg method in event command
581 static void unregister_trigger(char *glob, struct event_trigger_ops *ops,
582 struct event_trigger_data *test,
583 struct trace_event_file *file)
585 struct event_trigger_data *data;
586 bool unregistered = false;
588 lockdep_assert_held(&event_mutex);
590 list_for_each_entry(data, &file->triggers, list) {
591 if (data->cmd_ops->trigger_type == test->cmd_ops->trigger_type) {
593 list_del_rcu(&data->list);
594 trace_event_trigger_enable_disable(file, 0);
595 update_cond_flag(file);
600 if (unregistered && data->ops->free)
601 data->ops->free(data->ops, data);
605 * event_trigger_callback - Generic event_command @func implementation
606 * @cmd_ops: The command ops, used for trigger registration
607 * @file: The trace_event_file associated with the event
608 * @glob: The raw string used to register the trigger
609 * @cmd: The cmd portion of the string used to register the trigger
610 * @param: The params portion of the string used to register the trigger
612 * Common implementation for event command parsing and trigger
615 * Usually used directly as the @func method in event command
618 * Return: 0 on success, errno otherwise
621 event_trigger_callback(struct event_command *cmd_ops,
622 struct trace_event_file *file,
623 char *glob, char *cmd, char *param)
625 struct event_trigger_data *trigger_data;
626 struct event_trigger_ops *trigger_ops;
627 char *trigger = NULL;
631 /* separate the trigger from the filter (t:n [if filter]) */
632 if (param && isdigit(param[0]))
633 trigger = strsep(¶m, " \t");
635 trigger_ops = cmd_ops->get_trigger_ops(cmd, trigger);
638 trigger_data = kzalloc(sizeof(*trigger_data), GFP_KERNEL);
642 trigger_data->count = -1;
643 trigger_data->ops = trigger_ops;
644 trigger_data->cmd_ops = cmd_ops;
645 trigger_data->private_data = file;
646 INIT_LIST_HEAD(&trigger_data->list);
647 INIT_LIST_HEAD(&trigger_data->named_list);
649 if (glob[0] == '!') {
650 cmd_ops->unreg(glob+1, trigger_ops, trigger_data, file);
657 number = strsep(&trigger, ":");
664 * We use the callback data field (which is a pointer)
667 ret = kstrtoul(number, 0, &trigger_data->count);
672 if (!param) /* if param is non-empty, it's supposed to be a filter */
675 if (!cmd_ops->set_filter)
678 ret = cmd_ops->set_filter(param, trigger_data, file);
683 /* Up the trigger_data count to make sure reg doesn't free it on failure */
684 event_trigger_init(trigger_ops, trigger_data);
685 ret = cmd_ops->reg(glob, trigger_ops, trigger_data, file);
687 * The above returns on success the # of functions enabled,
688 * but if it didn't find any functions it returns zero.
689 * Consider no functions a failure too.
692 cmd_ops->unreg(glob, trigger_ops, trigger_data, file);
697 /* Down the counter of trigger_data or free it if not used anymore */
698 event_trigger_free(trigger_ops, trigger_data);
703 if (cmd_ops->set_filter)
704 cmd_ops->set_filter(NULL, trigger_data, NULL);
710 * set_trigger_filter - Generic event_command @set_filter implementation
711 * @filter_str: The filter string for the trigger, NULL to remove filter
712 * @trigger_data: Trigger-specific data
713 * @file: The trace_event_file associated with the event
715 * Common implementation for event command filter parsing and filter
718 * Usually used directly as the @set_filter method in event command
721 * Also used to remove a filter (if filter_str = NULL).
723 * Return: 0 on success, errno otherwise
725 int set_trigger_filter(char *filter_str,
726 struct event_trigger_data *trigger_data,
727 struct trace_event_file *file)
729 struct event_trigger_data *data = trigger_data;
730 struct event_filter *filter = NULL, *tmp;
734 if (!filter_str) /* clear the current filter */
737 s = strsep(&filter_str, " \t");
739 if (!strlen(s) || strcmp(s, "if") != 0)
745 /* The filter is for the 'trigger' event, not the triggered event */
746 ret = create_event_filter(file->tr, file->event_call,
747 filter_str, false, &filter);
749 * If create_event_filter() fails, filter still needs to be freed.
750 * Which the calling code will do with data->filter.
753 tmp = rcu_access_pointer(data->filter);
755 rcu_assign_pointer(data->filter, filter);
758 /* Make sure the call is done with the filter */
759 tracepoint_synchronize_unregister();
760 free_event_filter(tmp);
763 kfree(data->filter_str);
764 data->filter_str = NULL;
767 data->filter_str = kstrdup(filter_str, GFP_KERNEL);
768 if (!data->filter_str) {
769 free_event_filter(rcu_access_pointer(data->filter));
778 static LIST_HEAD(named_triggers);
781 * find_named_trigger - Find the common named trigger associated with @name
782 * @name: The name of the set of named triggers to find the common data for
784 * Named triggers are sets of triggers that share a common set of
785 * trigger data. The first named trigger registered with a given name
786 * owns the common trigger data that the others subsequently
787 * registered with the same name will reference. This function
788 * returns the common trigger data associated with that first
789 * registered instance.
791 * Return: the common trigger data for the given named trigger on
792 * success, NULL otherwise.
794 struct event_trigger_data *find_named_trigger(const char *name)
796 struct event_trigger_data *data;
801 list_for_each_entry(data, &named_triggers, named_list) {
802 if (data->named_data)
804 if (strcmp(data->name, name) == 0)
812 * is_named_trigger - determine if a given trigger is a named trigger
813 * @test: The trigger data to test
815 * Return: true if 'test' is a named trigger, false otherwise.
817 bool is_named_trigger(struct event_trigger_data *test)
819 struct event_trigger_data *data;
821 list_for_each_entry(data, &named_triggers, named_list) {
830 * save_named_trigger - save the trigger in the named trigger list
831 * @name: The name of the named trigger set
832 * @data: The trigger data to save
834 * Return: 0 if successful, negative error otherwise.
836 int save_named_trigger(const char *name, struct event_trigger_data *data)
838 data->name = kstrdup(name, GFP_KERNEL);
842 list_add(&data->named_list, &named_triggers);
848 * del_named_trigger - delete a trigger from the named trigger list
849 * @data: The trigger data to delete
851 void del_named_trigger(struct event_trigger_data *data)
856 list_del(&data->named_list);
859 static void __pause_named_trigger(struct event_trigger_data *data, bool pause)
861 struct event_trigger_data *test;
863 list_for_each_entry(test, &named_triggers, named_list) {
864 if (strcmp(test->name, data->name) == 0) {
866 test->paused_tmp = test->paused;
869 test->paused = test->paused_tmp;
876 * pause_named_trigger - Pause all named triggers with the same name
877 * @data: The trigger data of a named trigger to pause
879 * Pauses a named trigger along with all other triggers having the
880 * same name. Because named triggers share a common set of data,
881 * pausing only one is meaningless, so pausing one named trigger needs
882 * to pause all triggers with the same name.
884 void pause_named_trigger(struct event_trigger_data *data)
886 __pause_named_trigger(data, true);
890 * unpause_named_trigger - Un-pause all named triggers with the same name
891 * @data: The trigger data of a named trigger to unpause
893 * Un-pauses a named trigger along with all other triggers having the
894 * same name. Because named triggers share a common set of data,
895 * unpausing only one is meaningless, so unpausing one named trigger
896 * needs to unpause all triggers with the same name.
898 void unpause_named_trigger(struct event_trigger_data *data)
900 __pause_named_trigger(data, false);
904 * set_named_trigger_data - Associate common named trigger data
905 * @data: The trigger data of a named trigger to unpause
907 * Named triggers are sets of triggers that share a common set of
908 * trigger data. The first named trigger registered with a given name
909 * owns the common trigger data that the others subsequently
910 * registered with the same name will reference. This function
911 * associates the common trigger data from the first trigger with the
914 void set_named_trigger_data(struct event_trigger_data *data,
915 struct event_trigger_data *named_data)
917 data->named_data = named_data;
920 struct event_trigger_data *
921 get_named_trigger_data(struct event_trigger_data *data)
923 return data->named_data;
927 traceon_trigger(struct event_trigger_data *data, void *rec,
928 struct ring_buffer_event *event)
937 traceon_count_trigger(struct event_trigger_data *data, void *rec,
938 struct ring_buffer_event *event)
946 if (data->count != -1)
953 traceoff_trigger(struct event_trigger_data *data, void *rec,
954 struct ring_buffer_event *event)
956 if (!tracing_is_on())
963 traceoff_count_trigger(struct event_trigger_data *data, void *rec,
964 struct ring_buffer_event *event)
966 if (!tracing_is_on())
972 if (data->count != -1)
979 traceon_trigger_print(struct seq_file *m, struct event_trigger_ops *ops,
980 struct event_trigger_data *data)
982 return event_trigger_print("traceon", m, (void *)data->count,
987 traceoff_trigger_print(struct seq_file *m, struct event_trigger_ops *ops,
988 struct event_trigger_data *data)
990 return event_trigger_print("traceoff", m, (void *)data->count,
994 static struct event_trigger_ops traceon_trigger_ops = {
995 .func = traceon_trigger,
996 .print = traceon_trigger_print,
997 .init = event_trigger_init,
998 .free = event_trigger_free,
1001 static struct event_trigger_ops traceon_count_trigger_ops = {
1002 .func = traceon_count_trigger,
1003 .print = traceon_trigger_print,
1004 .init = event_trigger_init,
1005 .free = event_trigger_free,
1008 static struct event_trigger_ops traceoff_trigger_ops = {
1009 .func = traceoff_trigger,
1010 .print = traceoff_trigger_print,
1011 .init = event_trigger_init,
1012 .free = event_trigger_free,
1015 static struct event_trigger_ops traceoff_count_trigger_ops = {
1016 .func = traceoff_count_trigger,
1017 .print = traceoff_trigger_print,
1018 .init = event_trigger_init,
1019 .free = event_trigger_free,
1022 static struct event_trigger_ops *
1023 onoff_get_trigger_ops(char *cmd, char *param)
1025 struct event_trigger_ops *ops;
1027 /* we register both traceon and traceoff to this callback */
1028 if (strcmp(cmd, "traceon") == 0)
1029 ops = param ? &traceon_count_trigger_ops :
1030 &traceon_trigger_ops;
1032 ops = param ? &traceoff_count_trigger_ops :
1033 &traceoff_trigger_ops;
1038 static struct event_command trigger_traceon_cmd = {
1040 .trigger_type = ETT_TRACE_ONOFF,
1041 .func = event_trigger_callback,
1042 .reg = register_trigger,
1043 .unreg = unregister_trigger,
1044 .get_trigger_ops = onoff_get_trigger_ops,
1045 .set_filter = set_trigger_filter,
1048 static struct event_command trigger_traceoff_cmd = {
1050 .trigger_type = ETT_TRACE_ONOFF,
1051 .flags = EVENT_CMD_FL_POST_TRIGGER,
1052 .func = event_trigger_callback,
1053 .reg = register_trigger,
1054 .unreg = unregister_trigger,
1055 .get_trigger_ops = onoff_get_trigger_ops,
1056 .set_filter = set_trigger_filter,
1059 #ifdef CONFIG_TRACER_SNAPSHOT
1061 snapshot_trigger(struct event_trigger_data *data, void *rec,
1062 struct ring_buffer_event *event)
1064 struct trace_event_file *file = data->private_data;
1067 tracing_snapshot_instance(file->tr);
1073 snapshot_count_trigger(struct event_trigger_data *data, void *rec,
1074 struct ring_buffer_event *event)
1079 if (data->count != -1)
1082 snapshot_trigger(data, rec, event);
1086 register_snapshot_trigger(char *glob, struct event_trigger_ops *ops,
1087 struct event_trigger_data *data,
1088 struct trace_event_file *file)
1090 int ret = register_trigger(glob, ops, data, file);
1092 if (ret > 0 && tracing_alloc_snapshot_instance(file->tr) != 0) {
1093 unregister_trigger(glob, ops, data, file);
1101 snapshot_trigger_print(struct seq_file *m, struct event_trigger_ops *ops,
1102 struct event_trigger_data *data)
1104 return event_trigger_print("snapshot", m, (void *)data->count,
1108 static struct event_trigger_ops snapshot_trigger_ops = {
1109 .func = snapshot_trigger,
1110 .print = snapshot_trigger_print,
1111 .init = event_trigger_init,
1112 .free = event_trigger_free,
1115 static struct event_trigger_ops snapshot_count_trigger_ops = {
1116 .func = snapshot_count_trigger,
1117 .print = snapshot_trigger_print,
1118 .init = event_trigger_init,
1119 .free = event_trigger_free,
1122 static struct event_trigger_ops *
1123 snapshot_get_trigger_ops(char *cmd, char *param)
1125 return param ? &snapshot_count_trigger_ops : &snapshot_trigger_ops;
1128 static struct event_command trigger_snapshot_cmd = {
1130 .trigger_type = ETT_SNAPSHOT,
1131 .func = event_trigger_callback,
1132 .reg = register_snapshot_trigger,
1133 .unreg = unregister_trigger,
1134 .get_trigger_ops = snapshot_get_trigger_ops,
1135 .set_filter = set_trigger_filter,
1138 static __init int register_trigger_snapshot_cmd(void)
1142 ret = register_event_command(&trigger_snapshot_cmd);
1148 static __init int register_trigger_snapshot_cmd(void) { return 0; }
1149 #endif /* CONFIG_TRACER_SNAPSHOT */
1151 #ifdef CONFIG_STACKTRACE
1152 #ifdef CONFIG_UNWINDER_ORC
1154 * event_triggers_post_call()
1155 * trace_event_raw_event_xxx()
1157 # define STACK_SKIP 2
1161 * stacktrace_trigger()
1162 * event_triggers_post_call()
1163 * trace_event_buffer_commit()
1164 * trace_event_raw_event_xxx()
1166 #define STACK_SKIP 4
1170 stacktrace_trigger(struct event_trigger_data *data, void *rec,
1171 struct ring_buffer_event *event)
1173 trace_dump_stack(STACK_SKIP);
1177 stacktrace_count_trigger(struct event_trigger_data *data, void *rec,
1178 struct ring_buffer_event *event)
1183 if (data->count != -1)
1186 stacktrace_trigger(data, rec, event);
1190 stacktrace_trigger_print(struct seq_file *m, struct event_trigger_ops *ops,
1191 struct event_trigger_data *data)
1193 return event_trigger_print("stacktrace", m, (void *)data->count,
1197 static struct event_trigger_ops stacktrace_trigger_ops = {
1198 .func = stacktrace_trigger,
1199 .print = stacktrace_trigger_print,
1200 .init = event_trigger_init,
1201 .free = event_trigger_free,
1204 static struct event_trigger_ops stacktrace_count_trigger_ops = {
1205 .func = stacktrace_count_trigger,
1206 .print = stacktrace_trigger_print,
1207 .init = event_trigger_init,
1208 .free = event_trigger_free,
1211 static struct event_trigger_ops *
1212 stacktrace_get_trigger_ops(char *cmd, char *param)
1214 return param ? &stacktrace_count_trigger_ops : &stacktrace_trigger_ops;
1217 static struct event_command trigger_stacktrace_cmd = {
1218 .name = "stacktrace",
1219 .trigger_type = ETT_STACKTRACE,
1220 .flags = EVENT_CMD_FL_POST_TRIGGER,
1221 .func = event_trigger_callback,
1222 .reg = register_trigger,
1223 .unreg = unregister_trigger,
1224 .get_trigger_ops = stacktrace_get_trigger_ops,
1225 .set_filter = set_trigger_filter,
1228 static __init int register_trigger_stacktrace_cmd(void)
1232 ret = register_event_command(&trigger_stacktrace_cmd);
1238 static __init int register_trigger_stacktrace_cmd(void) { return 0; }
1239 #endif /* CONFIG_STACKTRACE */
1241 static __init void unregister_trigger_traceon_traceoff_cmds(void)
1243 unregister_event_command(&trigger_traceon_cmd);
1244 unregister_event_command(&trigger_traceoff_cmd);
1248 event_enable_trigger(struct event_trigger_data *data, void *rec,
1249 struct ring_buffer_event *event)
1251 struct enable_trigger_data *enable_data = data->private_data;
1253 if (enable_data->enable)
1254 clear_bit(EVENT_FILE_FL_SOFT_DISABLED_BIT, &enable_data->file->flags);
1256 set_bit(EVENT_FILE_FL_SOFT_DISABLED_BIT, &enable_data->file->flags);
1260 event_enable_count_trigger(struct event_trigger_data *data, void *rec,
1261 struct ring_buffer_event *event)
1263 struct enable_trigger_data *enable_data = data->private_data;
1268 /* Skip if the event is in a state we want to switch to */
1269 if (enable_data->enable == !(enable_data->file->flags & EVENT_FILE_FL_SOFT_DISABLED))
1272 if (data->count != -1)
1275 event_enable_trigger(data, rec, event);
1278 int event_enable_trigger_print(struct seq_file *m,
1279 struct event_trigger_ops *ops,
1280 struct event_trigger_data *data)
1282 struct enable_trigger_data *enable_data = data->private_data;
1284 seq_printf(m, "%s:%s:%s",
1286 (enable_data->enable ? ENABLE_HIST_STR : DISABLE_HIST_STR) :
1287 (enable_data->enable ? ENABLE_EVENT_STR : DISABLE_EVENT_STR),
1288 enable_data->file->event_call->class->system,
1289 trace_event_name(enable_data->file->event_call));
1291 if (data->count == -1)
1292 seq_puts(m, ":unlimited");
1294 seq_printf(m, ":count=%ld", data->count);
1296 if (data->filter_str)
1297 seq_printf(m, " if %s\n", data->filter_str);
1304 void event_enable_trigger_free(struct event_trigger_ops *ops,
1305 struct event_trigger_data *data)
1307 struct enable_trigger_data *enable_data = data->private_data;
1309 if (WARN_ON_ONCE(data->ref <= 0))
1314 /* Remove the SOFT_MODE flag */
1315 trace_event_enable_disable(enable_data->file, 0, 1);
1316 module_put(enable_data->file->event_call->mod);
1317 trigger_data_free(data);
1322 static struct event_trigger_ops event_enable_trigger_ops = {
1323 .func = event_enable_trigger,
1324 .print = event_enable_trigger_print,
1325 .init = event_trigger_init,
1326 .free = event_enable_trigger_free,
1329 static struct event_trigger_ops event_enable_count_trigger_ops = {
1330 .func = event_enable_count_trigger,
1331 .print = event_enable_trigger_print,
1332 .init = event_trigger_init,
1333 .free = event_enable_trigger_free,
1336 static struct event_trigger_ops event_disable_trigger_ops = {
1337 .func = event_enable_trigger,
1338 .print = event_enable_trigger_print,
1339 .init = event_trigger_init,
1340 .free = event_enable_trigger_free,
1343 static struct event_trigger_ops event_disable_count_trigger_ops = {
1344 .func = event_enable_count_trigger,
1345 .print = event_enable_trigger_print,
1346 .init = event_trigger_init,
1347 .free = event_enable_trigger_free,
1350 int event_enable_trigger_func(struct event_command *cmd_ops,
1351 struct trace_event_file *file,
1352 char *glob, char *cmd, char *param)
1354 struct trace_event_file *event_enable_file;
1355 struct enable_trigger_data *enable_data;
1356 struct event_trigger_data *trigger_data;
1357 struct event_trigger_ops *trigger_ops;
1358 struct trace_array *tr = file->tr;
1370 /* separate the trigger from the filter (s:e:n [if filter]) */
1371 trigger = strsep(¶m, " \t");
1375 system = strsep(&trigger, ":");
1379 event = strsep(&trigger, ":");
1382 event_enable_file = find_event_file(tr, system, event);
1383 if (!event_enable_file)
1386 #ifdef CONFIG_HIST_TRIGGERS
1387 hist = ((strcmp(cmd, ENABLE_HIST_STR) == 0) ||
1388 (strcmp(cmd, DISABLE_HIST_STR) == 0));
1390 enable = ((strcmp(cmd, ENABLE_EVENT_STR) == 0) ||
1391 (strcmp(cmd, ENABLE_HIST_STR) == 0));
1393 enable = strcmp(cmd, ENABLE_EVENT_STR) == 0;
1395 trigger_ops = cmd_ops->get_trigger_ops(cmd, trigger);
1398 trigger_data = kzalloc(sizeof(*trigger_data), GFP_KERNEL);
1402 enable_data = kzalloc(sizeof(*enable_data), GFP_KERNEL);
1404 kfree(trigger_data);
1408 trigger_data->count = -1;
1409 trigger_data->ops = trigger_ops;
1410 trigger_data->cmd_ops = cmd_ops;
1411 INIT_LIST_HEAD(&trigger_data->list);
1412 RCU_INIT_POINTER(trigger_data->filter, NULL);
1414 enable_data->hist = hist;
1415 enable_data->enable = enable;
1416 enable_data->file = event_enable_file;
1417 trigger_data->private_data = enable_data;
1419 if (glob[0] == '!') {
1420 cmd_ops->unreg(glob+1, trigger_ops, trigger_data, file);
1421 kfree(trigger_data);
1427 /* Up the trigger_data count to make sure nothing frees it on failure */
1428 event_trigger_init(trigger_ops, trigger_data);
1431 number = strsep(&trigger, ":");
1434 if (!strlen(number))
1438 * We use the callback data field (which is a pointer)
1441 ret = kstrtoul(number, 0, &trigger_data->count);
1446 if (!param) /* if param is non-empty, it's supposed to be a filter */
1449 if (!cmd_ops->set_filter)
1452 ret = cmd_ops->set_filter(param, trigger_data, file);
1457 /* Don't let event modules unload while probe registered */
1458 ret = try_module_get(event_enable_file->event_call->mod);
1464 ret = trace_event_enable_disable(event_enable_file, 1, 1);
1467 ret = cmd_ops->reg(glob, trigger_ops, trigger_data, file);
1469 * The above returns on success the # of functions enabled,
1470 * but if it didn't find any functions it returns zero.
1471 * Consider no functions a failure too.
1478 /* Just return zero, not the number of enabled functions */
1480 event_trigger_free(trigger_ops, trigger_data);
1485 trace_event_enable_disable(event_enable_file, 0, 1);
1487 module_put(event_enable_file->event_call->mod);
1489 if (cmd_ops->set_filter)
1490 cmd_ops->set_filter(NULL, trigger_data, NULL);
1491 event_trigger_free(trigger_ops, trigger_data);
1496 int event_enable_register_trigger(char *glob,
1497 struct event_trigger_ops *ops,
1498 struct event_trigger_data *data,
1499 struct trace_event_file *file)
1501 struct enable_trigger_data *enable_data = data->private_data;
1502 struct enable_trigger_data *test_enable_data;
1503 struct event_trigger_data *test;
1506 lockdep_assert_held(&event_mutex);
1508 list_for_each_entry(test, &file->triggers, list) {
1509 test_enable_data = test->private_data;
1510 if (test_enable_data &&
1511 (test->cmd_ops->trigger_type ==
1512 data->cmd_ops->trigger_type) &&
1513 (test_enable_data->file == enable_data->file)) {
1519 if (data->ops->init) {
1520 ret = data->ops->init(data->ops, data);
1525 list_add_rcu(&data->list, &file->triggers);
1528 update_cond_flag(file);
1529 if (trace_event_trigger_enable_disable(file, 1) < 0) {
1530 list_del_rcu(&data->list);
1531 update_cond_flag(file);
1538 void event_enable_unregister_trigger(char *glob,
1539 struct event_trigger_ops *ops,
1540 struct event_trigger_data *test,
1541 struct trace_event_file *file)
1543 struct enable_trigger_data *test_enable_data = test->private_data;
1544 struct enable_trigger_data *enable_data;
1545 struct event_trigger_data *data;
1546 bool unregistered = false;
1548 lockdep_assert_held(&event_mutex);
1550 list_for_each_entry(data, &file->triggers, list) {
1551 enable_data = data->private_data;
1553 (data->cmd_ops->trigger_type ==
1554 test->cmd_ops->trigger_type) &&
1555 (enable_data->file == test_enable_data->file)) {
1556 unregistered = true;
1557 list_del_rcu(&data->list);
1558 trace_event_trigger_enable_disable(file, 0);
1559 update_cond_flag(file);
1564 if (unregistered && data->ops->free)
1565 data->ops->free(data->ops, data);
1568 static struct event_trigger_ops *
1569 event_enable_get_trigger_ops(char *cmd, char *param)
1571 struct event_trigger_ops *ops;
1574 #ifdef CONFIG_HIST_TRIGGERS
1575 enable = ((strcmp(cmd, ENABLE_EVENT_STR) == 0) ||
1576 (strcmp(cmd, ENABLE_HIST_STR) == 0));
1578 enable = strcmp(cmd, ENABLE_EVENT_STR) == 0;
1581 ops = param ? &event_enable_count_trigger_ops :
1582 &event_enable_trigger_ops;
1584 ops = param ? &event_disable_count_trigger_ops :
1585 &event_disable_trigger_ops;
1590 static struct event_command trigger_enable_cmd = {
1591 .name = ENABLE_EVENT_STR,
1592 .trigger_type = ETT_EVENT_ENABLE,
1593 .func = event_enable_trigger_func,
1594 .reg = event_enable_register_trigger,
1595 .unreg = event_enable_unregister_trigger,
1596 .get_trigger_ops = event_enable_get_trigger_ops,
1597 .set_filter = set_trigger_filter,
1600 static struct event_command trigger_disable_cmd = {
1601 .name = DISABLE_EVENT_STR,
1602 .trigger_type = ETT_EVENT_ENABLE,
1603 .func = event_enable_trigger_func,
1604 .reg = event_enable_register_trigger,
1605 .unreg = event_enable_unregister_trigger,
1606 .get_trigger_ops = event_enable_get_trigger_ops,
1607 .set_filter = set_trigger_filter,
1610 static __init void unregister_trigger_enable_disable_cmds(void)
1612 unregister_event_command(&trigger_enable_cmd);
1613 unregister_event_command(&trigger_disable_cmd);
1616 static __init int register_trigger_enable_disable_cmds(void)
1620 ret = register_event_command(&trigger_enable_cmd);
1621 if (WARN_ON(ret < 0))
1623 ret = register_event_command(&trigger_disable_cmd);
1624 if (WARN_ON(ret < 0))
1625 unregister_trigger_enable_disable_cmds();
1630 static __init int register_trigger_traceon_traceoff_cmds(void)
1634 ret = register_event_command(&trigger_traceon_cmd);
1635 if (WARN_ON(ret < 0))
1637 ret = register_event_command(&trigger_traceoff_cmd);
1638 if (WARN_ON(ret < 0))
1639 unregister_trigger_traceon_traceoff_cmds();
1644 __init int register_trigger_cmds(void)
1646 register_trigger_traceon_traceoff_cmds();
1647 register_trigger_snapshot_cmd();
1648 register_trigger_stacktrace_cmd();
1649 register_trigger_enable_disable_cmds();
1650 register_trigger_hist_enable_disable_cmds();
1651 register_trigger_hist_cmd();