diff options
| author | Mathieu Desnoyers <mathieu.desnoyers@efficios.com> | 2014-03-10 21:04:58 -0400 |
|---|---|---|
| committer | Steven Rostedt <rostedt@goodmis.org> | 2014-03-11 21:53:50 -0400 |
| commit | 3bbc8db341773eb6aa5576eaabca4e95170fbe34 (patch) | |
| tree | 24f87de66e39047469030533117d061733c5493c /kernel/tracepoint.c | |
| parent | 4c11628a16506a8a8e030515f601771df07bba97 (diff) | |
| download | linux-3bbc8db341773eb6aa5576eaabca4e95170fbe34.tar.gz linux-3bbc8db341773eb6aa5576eaabca4e95170fbe34.tar.bz2 linux-3bbc8db341773eb6aa5576eaabca4e95170fbe34.zip | |
tracepoints: API doc update to tracepoint_probe_register() return value
Describe the return values of tracepoint_probe_register(), including
-ENODEV added by commit:
Author: Steven Rostedt <rostedt@goodmis.org>
tracing: Warn if a tracepoint is not set via debugfs
Link: http://lkml.kernel.org/r/1394499898-1537-2-git-send-email-mathieu.desnoyers@efficios.com
CC: Ingo Molnar <mingo@kernel.org>
CC: Frederic Weisbecker <fweisbec@gmail.com>
CC: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
Diffstat (limited to 'kernel/tracepoint.c')
| -rw-r--r-- | kernel/tracepoint.c | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/kernel/tracepoint.c b/kernel/tracepoint.c index a4f629da3011..e2a58a22b0f4 100644 --- a/kernel/tracepoint.c +++ b/kernel/tracepoint.c @@ -378,7 +378,17 @@ tracepoint_add_probe(const char *name, void *probe, void *data) * @probe: probe handler * @data: probe private data * - * Returns 0 if ok, error value on error. + * Returns: + * - 0 if the probe was successfully registered, and tracepoint + * callsites are currently loaded for that probe, + * - -ENODEV if the probe was successfully registered, but no tracepoint + * callsite is currently loaded for that probe, + * - other negative error value on error. + * + * When tracepoint_probe_register() returns either 0 or -ENODEV, + * parameters @name, @probe, and @data may be used by the tracepoint + * infrastructure until the probe is unregistered. + * * The probe address must at least be aligned on the architecture pointer size. */ int tracepoint_probe_register(const char *name, void *probe, void *data) |