linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Tom Zanussi <zanussi@kernel.org>
To: rostedt@goodmis.org
Cc: tglx@linutronix.de, mhiramat@kernel.org, namhyung@kernel.org,
	vedang.patel@intel.com, bigeasy@linutronix.de,
	joel@joelfernandes.org, mathieu.desnoyers@efficios.com,
	julia@ni.com, linux-kernel@vger.kernel.org,
	linux-rt-users@vger.kernel.org
Subject: [PATCH v8 03/22] tracing: Add hist trigger handler.action documentation to README
Date: Mon, 10 Dec 2018 18:01:17 -0600	[thread overview]
Message-ID: <aed0a478f683ac4a7669c62d72e8a01d975e525b.1544483272.git.tom.zanussi@linux.intel.com> (raw)
In-Reply-To: <cover.1544483272.git.tom.zanussi@linux.intel.com>
In-Reply-To: <cover.1544483272.git.tom.zanussi@linux.intel.com>

From: Tom Zanussi <tom.zanussi@linux.intel.com>

Add abbreviated documentation for handlers and actions to README.

Signed-off-by: Tom Zanussi <tom.zanussi@linux.intel.com>
---
 kernel/trace/trace.c | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/kernel/trace/trace.c b/kernel/trace/trace.c
index 911470ad9e94..1abde13a7eab 100644
--- a/kernel/trace/trace.c
+++ b/kernel/trace/trace.c
@@ -4698,6 +4698,7 @@ static const char readme_msg[] =
 	"\t            [:size=#entries]\n"
 	"\t            [:pause][:continue][:clear]\n"
 	"\t            [:name=histname1]\n"
+	"\t            [:<handler>.<action>]\n"
 	"\t            [if <filter>]\n\n"
 	"\t    When a matching event is hit, an entry is added to a hash\n"
 	"\t    table using the key(s) and value(s) named, and the value of a\n"
@@ -4739,7 +4740,16 @@ static const char readme_msg[] =
 	"\t    The enable_hist and disable_hist triggers can be used to\n"
 	"\t    have one event conditionally start and stop another event's\n"
 	"\t    already-attached hist trigger.  The syntax is analagous to\n"
-	"\t    the enable_event and disable_event triggers.\n"
+	"\t    the enable_event and disable_event triggers.\n\n"
+	"\t    Hist trigger handlers and actions are executed whenever a\n"
+	"\t    a histogram entry is added or updated.  They take the form:\n\n"
+	"\t        <handler>.<action>\n\n"
+	"\t    The available handlers are:\n\n"
+	"\t        onmatch(matching.event)  - invoke on addition or update\n"
+	"\t        onmax(var)               - invoke if var exceeds current max\n\n"
+	"\t    The available actions are:\n\n"
+	"\t        <synthetic_event>(param list)        - generate synthetic event\n"
+	"\t        save(field,...)                      - save current event fields\n"
 #endif
 ;
 
-- 
2.14.1


  parent reply	other threads:[~2018-12-11  0:03 UTC|newest]

Thread overview: 33+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-12-11  0:01 [PATCH v8 00/22] tracing: Hist trigger snapshot and onchange additions Tom Zanussi
2018-12-11  0:01 ` [PATCH v8 01/22] tracing: Refactor hist trigger action code Tom Zanussi
2018-12-11  0:01 ` [PATCH v8 02/22] tracing: Make hist trigger Documentation better reflect actions/handlers Tom Zanussi
2018-12-11  0:01 ` Tom Zanussi [this message]
2018-12-14 13:11   ` [PATCH v8 03/22] tracing: Add hist trigger handler.action documentation to README Masami Hiramatsu
2018-12-14 17:16     ` Tom Zanussi
2018-12-11  0:01 ` [PATCH v8 04/22] tracing: Split up onmatch action data Tom Zanussi
2018-12-11  0:01 ` [PATCH v8 05/22] tracing: Generalize hist trigger onmax and save action Tom Zanussi
2018-12-11  0:01 ` [PATCH v8 06/22] tracing: Add conditional snapshot Tom Zanussi
2018-12-11  0:01 ` [PATCH v8 07/22] tracing: Add hist trigger snapshot() action Tom Zanussi
2018-12-11  0:01 ` [PATCH v8 08/22] tracing: Add hist trigger snapshot() action Documentation Tom Zanussi
2018-12-11  0:01 ` [PATCH v8 09/22] tracing: Add hist trigger snapshot() action test case Tom Zanussi
2018-12-14 16:14   ` Masami Hiramatsu
2018-12-11  0:01 ` [PATCH v8 10/22] tracing: Add hist trigger onchange() handler Tom Zanussi
2018-12-14 16:09   ` Masami Hiramatsu
2018-12-11  0:01 ` [PATCH v8 11/22] tracing: Add hist trigger onchange() handler Documentation Tom Zanussi
2018-12-11  0:01 ` [PATCH v8 12/22] tracing: Add hist trigger onchange() handler test case Tom Zanussi
2018-12-14 16:18   ` Masami Hiramatsu
2018-12-14 17:17     ` Tom Zanussi
2018-12-11  0:01 ` [PATCH v8 13/22] tracing: Add alternative synthetic event trace action syntax Tom Zanussi
2018-12-11  0:01 ` [PATCH v8 14/22] tracing: Add alternative synthetic event trace action test case Tom Zanussi
2018-12-11  0:01 ` [PATCH v8 15/22] tracing: Add hist trigger action 'expected fail' " Tom Zanussi
2018-12-11  0:01 ` [PATCH v8 16/22] tracing: Add SPDX license GPL-2.0 license identifier to inter-event testcases Tom Zanussi
2018-12-11  0:01 ` [PATCH v8 17/22] tracing: Remove unnecessary hist trigger struct fields Tom Zanussi
2018-12-11  0:01 ` [PATCH v8 18/22] tracing: Use var_refs[] for hist trigger reference checking Tom Zanussi
2018-12-11  0:01 ` [PATCH v8 19/22] tracing: Remove open-coding of hist trigger var_ref management Tom Zanussi
2018-12-11  0:01 ` [PATCH v8 20/22] tracing: Use hist trigger's var_ref array to destroy var_refs Tom Zanussi
2018-12-14 16:31   ` Masami Hiramatsu
2018-12-14 17:29     ` Tom Zanussi
2018-12-15  6:50       ` Namhyung Kim
2018-12-15 21:01         ` Tom Zanussi
2018-12-11  0:01 ` [PATCH v8 21/22] tracing: Remove hist trigger synth_var_refs Tom Zanussi
2018-12-11  0:01 ` [PATCH v8 22/22] tracing: Add hist trigger comments for variable-related fields Tom Zanussi

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=aed0a478f683ac4a7669c62d72e8a01d975e525b.1544483272.git.tom.zanussi@linux.intel.com \
    --to=zanussi@kernel.org \
    --cc=bigeasy@linutronix.de \
    --cc=joel@joelfernandes.org \
    --cc=julia@ni.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-rt-users@vger.kernel.org \
    --cc=mathieu.desnoyers@efficios.com \
    --cc=mhiramat@kernel.org \
    --cc=namhyung@kernel.org \
    --cc=rostedt@goodmis.org \
    --cc=tglx@linutronix.de \
    --cc=vedang.patel@intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).