tracing: Add basic event trigger framework

Add a 'trigger' file for each trace event, enabling 'trace event
triggers' to be set for trace events.

'trace event triggers' are patterned after the existing 'ftrace
function triggers' implementation except that triggers are written to
per-event 'trigger' files instead of to a single file such as the
'set_ftrace_filter' used for ftrace function triggers.

The implementation is meant to be entirely separate from ftrace
function triggers, in order to keep the respective implementations
relatively simple and to allow them to diverge.

The event trigger functionality is built on top of SOFT_DISABLE
functionality.  It adds a TRIGGER_MODE bit to the ftrace_event_file
flags which is checked when any trace event fires.  Triggers set for a
particular event need to be checked regardless of whether that event
is actually enabled or not - getting an event to fire even if it's not
enabled is what's already implemented by SOFT_DISABLE mode, so trigger
mode directly reuses that.  Event trigger essentially inherit the soft
disable logic in __ftrace_event_enable_disable() while adding a bit of
logic and trigger reference counting via tm_ref on top of that in a
new trace_event_trigger_enable_disable() function.  Because the base
__ftrace_event_enable_disable() code now needs to be invoked from
outside trace_events.c, a wrapper is also added for those usages.

The triggers for an event are actually invoked via a new function,
event_triggers_call(), and code is also added to invoke them for
ftrace_raw_event calls as well as syscall events.

The main part of the patch creates a new trace_events_trigger.c file
to contain the trace event triggers implementation.

The standard open, read, and release file operations are implemented
here.

The open() implementation sets up for the various open modes of the
'trigger' file.  It creates and attaches the trigger iterator and sets
up the command parser.  If opened for reading set up the trigger
seq_ops.

The read() implementation parses the event trigger written to the
'trigger' file, looks up the trigger command, and passes it along to
that event_command's func() implementation for command-specific
processing.

The release() implementation does whatever cleanup is needed to
release the 'trigger' file, like releasing the parser and trigger
iterator, etc.

A couple of functions for event command registration and
unregistration are added, along with a list to add them to and a mutex
to protect them, as well as an (initially empty) registration function
to add the set of commands that will be added by future commits, and
call to it from the trace event initialization code.

also added are a couple trigger-specific data structures needed for
these implementations such as a trigger iterator and a struct for
trigger-specific data.

A couple structs consisting mostly of function meant to be implemented
in command-specific ways, event_command and event_trigger_ops, are
used by the generic event trigger command implementations.  They're
being put into trace.h alongside the other trace_event data structures
and functions, in the expectation that they'll be needed in several
trace_event-related files such as trace_events_trigger.c and
trace_events.c.

The event_command.func() function is meant to be called by the trigger
parsing code in order to add a trigger instance to the corresponding
event.  It essentially coordinates adding a live trigger instance to
the event, and arming the triggering the event.

Every event_command func() implementation essentially does the
same thing for any command:

   - choose ops - use the value of param to choose either a number or
     count version of event_trigger_ops specific to the command
   - do the register or unregister of those ops
   - associate a filter, if specified, with the triggering event

The reg() and unreg() ops allow command-specific implementations for
event_trigger_op registration and unregistration, and the
get_trigger_ops() op allows command-specific event_trigger_ops
selection to be parameterized.  When a trigger instance is added, the
reg() op essentially adds that trigger to the triggering event and
arms it, while unreg() does the opposite.  The set_filter() function
is used to associate a filter with the trigger - if the command
doesn't specify a set_filter() implementation, the command will ignore
filters.

Each command has an associated trigger_type, which serves double duty,
both as a unique identifier for the command as well as a value that
can be used for setting a trigger mode bit during trigger invocation.

The signature of func() adds a pointer to the event_command struct,
used to invoke those functions, along with a command_data param that
can be passed to the reg/unreg functions.  This allows func()
implementations to use command-specific blobs and supports code
re-use.

The event_trigger_ops.func() command corrsponds to the trigger 'probe'
function that gets called when the triggering event is actually
invoked.  The other functions are used to list the trigger when
needed, along with a couple mundane book-keeping functions.

This also moves event_file_data() into trace.h so it can be used
outside of trace_events.c.

Link: http://lkml.kernel.org/r/316d95061accdee070aac8e5750afba0192fa5b9.1382622043.git.tom.zanussi@linux.intel.com

Signed-off-by: Tom Zanussi <tom.zanussi@linux.intel.com>
Idea-by: Steve Rostedt <rostedt@goodmis.org>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>

1 files changed, 278 insertions, 0 deletions

diff --git a/kernel/trace/trace_events_trigger.c b/kernel/trace/trace_events_trigger.c
new file mode 100644
index 000000000000..60a6a6d66dc0
--- /dev/null
+++ b/kernel/trace/trace_events_trigger.c
@@ -0,0 +1,278 @@
+/*
+ * trace_events_trigger - trace event triggers
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ *
+ * Copyright (C) 2013 Tom Zanussi <tom.zanussi@linux.intel.com>
+ */
+
+#include <linux/module.h>
+#include <linux/ctype.h>
+#include <linux/mutex.h>
+#include <linux/slab.h>
+
+#include "trace.h"
+
+static LIST_HEAD(trigger_commands);
+static DEFINE_MUTEX(trigger_cmd_mutex);
+
+/**
+ * event_triggers_call - Call triggers associated with a trace event
+ * @file: The ftrace_event_file associated with the event
+ *
+ * For each trigger associated with an event, invoke the trigger
+ * function registered with the associated trigger command.
+ *
+ * Called from tracepoint handlers (with rcu_read_lock_sched() held).
+ *
+ * Return: an enum event_trigger_type value containing a set bit for
+ * any trigger that should be deferred, ETT_NONE if nothing to defer.
+ */
+void event_triggers_call(struct ftrace_event_file *file)
+{
+        struct event_trigger_data *data;
+
+        if (list_empty(&file->triggers))
+                return;
+
+        list_for_each_entry_rcu(data, &file->triggers, list)
+                data->ops->func(data);
+}
+EXPORT_SYMBOL_GPL(event_triggers_call);
+
+static void *trigger_next(struct seq_file *m, void *t, loff_t *pos)
+{
+        struct ftrace_event_file *event_file = event_file_data(m->private);
+
+        return seq_list_next(t, &event_file->triggers, pos);
+}
+
+static void *trigger_start(struct seq_file *m, loff_t *pos)
+{
+        struct ftrace_event_file *event_file;
+
+        /* ->stop() is called even if ->start() fails */
+        mutex_lock(&event_mutex);
+        event_file = event_file_data(m->private);
+        if (unlikely(!event_file))
+                return ERR_PTR(-ENODEV);
+
+        return seq_list_start(&event_file->triggers, *pos);
+}
+
+static void trigger_stop(struct seq_file *m, void *t)
+{
+        mutex_unlock(&event_mutex);
+}
+
+static int trigger_show(struct seq_file *m, void *v)
+{
+        struct event_trigger_data *data;
+
+        data = list_entry(v, struct event_trigger_data, list);
+        data->ops->print(m, data->ops, data);
+
+        return 0;
+}
+
+static const struct seq_operations event_triggers_seq_ops = {
+        .start = trigger_start,
+        .next = trigger_next,
+        .stop = trigger_stop,
+        .show = trigger_show,
+};
+
+static int event_trigger_regex_open(struct inode *inode, struct file *file)
+{
+        int ret = 0;
+
+        mutex_lock(&event_mutex);
+
+        if (unlikely(!event_file_data(file))) {
+                mutex_unlock(&event_mutex);
+                return -ENODEV;
+        }
+
+        if (file->f_mode & FMODE_READ) {
+                ret = seq_open(file, &event_triggers_seq_ops);
+                if (!ret) {
+                        struct seq_file *m = file->private_data;
+                        m->private = file;
+                }
+        }
+
+        mutex_unlock(&event_mutex);
+
+        return ret;
+}
+
+static int trigger_process_regex(struct ftrace_event_file *file, char *buff)
+{
+        char *command, *next = buff;
+        struct event_command *p;
+        int ret = -EINVAL;
+
+        command = strsep(&next, ": \t");
+        command = (command[0] != '!') ? command : command + 1;
+
+        mutex_lock(&trigger_cmd_mutex);
+        list_for_each_entry(p, &trigger_commands, list) {
+                if (strcmp(p->name, command) == 0) {
+                        ret = p->func(p, file, buff, command, next);
+                        goto out_unlock;
+                }
+        }
+ out_unlock:
+        mutex_unlock(&trigger_cmd_mutex);
+
+        return ret;
+}
+
+static ssize_t event_trigger_regex_write(struct file *file,
+                                         const char __user *ubuf,
+                                         size_t cnt, loff_t *ppos)
+{
+        struct ftrace_event_file *event_file;
+        ssize_t ret;
+        char *buf;
+
+        if (!cnt)
+                return 0;
+
+        if (cnt >= PAGE_SIZE)
+                return -EINVAL;
+
+        buf = (char *)__get_free_page(GFP_TEMPORARY);
+        if (!buf)
+                return -ENOMEM;
+
+        if (copy_from_user(buf, ubuf, cnt)) {
+                free_page((unsigned long)buf);
+                return -EFAULT;
+        }
+        buf[cnt] = '\0';
+        strim(buf);
+
+        mutex_lock(&event_mutex);
+        event_file = event_file_data(file);
+        if (unlikely(!event_file)) {
+                mutex_unlock(&event_mutex);
+                free_page((unsigned long)buf);
+                return -ENODEV;
+        }
+        ret = trigger_process_regex(event_file, buf);
+        mutex_unlock(&event_mutex);
+
+        free_page((unsigned long)buf);
+        if (ret < 0)
+                goto out;
+
+        *ppos += cnt;
+        ret = cnt;
+ out:
+        return ret;
+}
+
+static int event_trigger_regex_release(struct inode *inode, struct file *file)
+{
+        mutex_lock(&event_mutex);
+
+        if (file->f_mode & FMODE_READ)
+                seq_release(inode, file);
+
+        mutex_unlock(&event_mutex);
+
+        return 0;
+}
+
+static ssize_t
+event_trigger_write(struct file *filp, const char __user *ubuf,
+                    size_t cnt, loff_t *ppos)
+{
+        return event_trigger_regex_write(filp, ubuf, cnt, ppos);
+}
+
+static int
+event_trigger_open(struct inode *inode, struct file *filp)
+{
+        return event_trigger_regex_open(inode, filp);
+}
+
+static int
+event_trigger_release(struct inode *inode, struct file *file)
+{
+        return event_trigger_regex_release(inode, file);
+}
+
+const struct file_operations event_trigger_fops = {
+        .open = event_trigger_open,
+        .read = seq_read,
+        .write = event_trigger_write,
+        .llseek = ftrace_filter_lseek,
+        .release = event_trigger_release,
+};
+
+static int trace_event_trigger_enable_disable(struct ftrace_event_file *file,
+                                              int trigger_enable)
+{
+        int ret = 0;
+
+        if (trigger_enable) {
+                if (atomic_inc_return(&file->tm_ref) > 1)
+                        return ret;
+                set_bit(FTRACE_EVENT_FL_TRIGGER_MODE_BIT, &file->flags);
+                ret = trace_event_enable_disable(file, 1, 1);
+        } else {
+                if (atomic_dec_return(&file->tm_ref) > 0)
+                        return ret;
+                clear_bit(FTRACE_EVENT_FL_TRIGGER_MODE_BIT, &file->flags);
+                ret = trace_event_enable_disable(file, 0, 1);
+        }
+
+        return ret;
+}
+
+/**
+ * clear_event_triggers - Clear all triggers associated with a trace array
+ * @tr: The trace array to clear
+ *
+ * For each trigger, the triggering event has its tm_ref decremented
+ * via trace_event_trigger_enable_disable(), and any associated event
+ * (in the case of enable/disable_event triggers) will have its sm_ref
+ * decremented via free()->trace_event_enable_disable().  That
+ * combination effectively reverses the soft-mode/trigger state added
+ * by trigger registration.
+ *
+ * Must be called with event_mutex held.
+ */
+void
+clear_event_triggers(struct trace_array *tr)
+{
+        struct ftrace_event_file *file;
+
+        list_for_each_entry(file, &tr->events, list) {
+                struct event_trigger_data *data;
+                list_for_each_entry_rcu(data, &file->triggers, list) {
+                        trace_event_trigger_enable_disable(file, 0);
+                        if (data->ops->free)
+                                data->ops->free(data->ops, data);
+                }
+        }
+}
+
+__init int register_trigger_cmds(void)
+{
+        return 0;
+}