linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jiri Olsa <jolsa@kernel.org>
To: Arnaldo Carvalho de Melo <acme@kernel.org>
Cc: lkml <linux-kernel@vger.kernel.org>,
	Peter Zijlstra <a.p.zijlstra@chello.nl>,
	Ingo Molnar <mingo@kernel.org>,
	Mark Rutland <mark.rutland@arm.com>,
	Namhyung Kim <namhyung@kernel.org>,
	Alexander Shishkin <alexander.shishkin@linux.intel.com>,
	Michael Petlan <mpetlan@redhat.com>,
	Ian Rogers <irogers@google.com>,
	Stephane Eranian <eranian@google.com>,
	Alexei Budankov <abudankov@huawei.com>
Subject: [PATCH 17/22] perf daemon: Add man page for perf-daemon
Date: Sat,  2 Jan 2021 23:04:36 +0100	[thread overview]
Message-ID: <20210102220441.794923-18-jolsa@kernel.org> (raw)
In-Reply-To: <20210102220441.794923-1-jolsa@kernel.org>

Adding man page for perf-daemon usage.

Signed-off-by: Jiri Olsa <jolsa@kernel.org>
---
 tools/perf/Documentation/perf-config.txt |  14 ++
 tools/perf/Documentation/perf-daemon.txt | 187 +++++++++++++++++++++++
 2 files changed, 201 insertions(+)

diff --git a/tools/perf/Documentation/perf-config.txt b/tools/perf/Documentation/perf-config.txt
index c3ce48f1b379..153bde14bbe0 100644
--- a/tools/perf/Documentation/perf-config.txt
+++ b/tools/perf/Documentation/perf-config.txt
@@ -703,6 +703,20 @@ auxtrace.*::
 		If the directory does not exist or has the wrong file type,
 		the current directory is used.
 
+daemon.*::
+
+	daemon.base::
+		Base path for daemon data. All sessions data are stored under
+		this path.
+
+session-<NAME>.*::
+
+	session-<NAME>.run::
+
+		Defines new record session for daemon. The value is record's
+		command line without the 'record' keyword.
+
+
 SEE ALSO
 --------
 linkperf:perf[1]
diff --git a/tools/perf/Documentation/perf-daemon.txt b/tools/perf/Documentation/perf-daemon.txt
index e69de29bb2d1..b0e1015476c2 100644
--- a/tools/perf/Documentation/perf-daemon.txt
+++ b/tools/perf/Documentation/perf-daemon.txt
@@ -0,0 +1,187 @@
+perf-daemon(1)
+==============
+
+NAME
+----
+perf-daemon - Run record sessions on background
+
+SYNOPSIS
+--------
+[verse]
+'perf daemon'
+'perf daemon' [<options>]
+'perf daemon start'  [<options>]
+'perf daemon stop'   [<options>]
+'perf daemon signal' [<options>]
+'perf daemon ping'   [<options>]
+
+
+DESCRIPTION
+-----------
+This command allows to run simple daemon process that starts and
+monitors configured record sessions.
+
+Each session represents one perf record process started with
+control setup (with perf record --control.. options).
+
+These sessions are configured through config file, see CONFIG FILE
+section with EXAMPLES.
+
+
+OPTIONS
+-------
+--config=<PATH>::
+	Config file path, if not perf will check system and default
+	locations (/etc/perfconfig, $HOME/.perfconfig).
+
+-v::
+--verbose::
+	Be more verbose.
+
+
+All generic options are available also under commands.
+
+
+START COMMAND
+-------------
+The start command creates the daemon process.
+
+-f::
+--foreground::
+	Do not put the process in background.
+
+
+STOP COMMAND
+------------
+The stop command stops all the session and the daemon process.
+
+
+SIGNAL COMMAND
+--------------
+The signal command sends signal to configured sessions.
+
+--session::
+	Send signal to specific session.
+
+
+PING COMMAND
+------------
+The ping command sends control ping to configured sessions.
+
+--session::
+	Send ping to specific session.
+
+
+CONFIG FILE
+-----------
+The daemon is configured within standard perf config file by
+following new variables:
+
+daemon.base:
+	Base path for daemon data. All sessions data are
+	stored under this path.
+
+session-<NAME>.run:
+	Defines new record session. The value is record's command
+	line without the 'record' keyword.
+
+Each perf record session is run in daemon.base/<NAME> directory.
+
+
+EXAMPLES
+--------
+Example with 2 record sessions:
+
+  # cat ~/.perfconfig
+  [daemon]
+  base=/opt/perfdata
+
+  [session-cycles]
+  run = -m 10M -e cycles --overwrite --switch-output -a
+
+  [session-sched]
+  run = -m 20M -e sched:* --overwrite --switch-output -a
+
+
+Starting the daemon:
+
+  # perf daemon start
+
+
+Check sessions:
+
+  # perf daemon
+  [603349:daemon] base: /opt/perfdata
+  [603350:cycles] perf record -m 10M -e cycles --overwrite --switch-output -a
+  [603351:sched] perf record -m 20M -e sched:* --overwrite --switch-output -a
+
+First line is daemon process info with configured daemon base.
+
+
+Check sessions with more info:
+
+  # perf daemon -v
+  [603349:daemon] base: /opt/perfdata
+    output:  /opt/perfdata/output
+    lock:    /opt/perfdata/lock
+    up:      1 minutes
+  [603350:cycles] perf record -m 10M -e cycles --overwrite --switch-output -a
+    base:    /opt/perfdata/session-cycles
+    output:  /opt/perfdata/session-cycles/output
+    control: /opt/perfdata/session-cycles/control
+    ack:     /opt/perfdata/session-cycles/ack
+    up:      1 minutes
+  [603351:sched] perf record -m 20M -e sched:* --overwrite --switch-output -a
+    base:    /opt/perfdata/session-sched
+    output:  /opt/perfdata/session-sched/output
+    control: /opt/perfdata/session-sched/control
+    ack:     /opt/perfdata/session-sched/ack
+    up:      1 minutes
+
+The 'base' path is daemon/session base.
+The 'lock' file is daemon's lock file guarding that no other
+daemon is running on top of the base.
+The 'output' file is perf record output for specific session.
+The 'control' and 'ack' files are perf control files.
+The 'up' number shows minutes daemon/session is running.
+
+
+Make sure control session is online:
+
+  # perf daemon ping
+  OK   cycles
+  OK   sched
+
+
+Send USR2 signal to session 'cycles' to generate perf.data file:
+
+  # perf daemon signal --session cycles
+  signal 12 sent to session 'cycles [603452]'
+
+  # tail -2  /opt/perfdata/session-cycles/output
+  [ perf record: dump data: Woken up 1 times ]
+  [ perf record: Dump perf.data.2020123017013149 ]
+
+
+Send USR2 signal to all sessions:
+
+  # perf daemon signal
+  signal 12 sent to session 'cycles [603452]'
+  signal 12 sent to session 'sched [603453]'
+
+  # tail -2  /opt/perfdata/session-cycles/output
+  [ perf record: dump data: Woken up 1 times ]
+  [ perf record: Dump perf.data.2020123017024689 ]
+  # tail -2  /opt/perfdata/session-sched/output
+  [ perf record: dump data: Woken up 1 times ]
+  [ perf record: Dump perf.data.2020123017024713 ]
+
+
+Stop daemon:
+
+  # perf daemon stop
+
+
+SEE ALSO
+--------
+linkperf:perf-record[1], linkperf:perf-config[1]
-- 
2.26.2


  parent reply	other threads:[~2021-01-02 22:06 UTC|newest]

Thread overview: 44+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-01-02 22:04 [PATCHv2 00/22] perf tools: Add daemon command Jiri Olsa
2021-01-02 22:04 ` [PATCH 01/22] perf tools: Make perf_config_from_file static Jiri Olsa
2021-01-18 15:51   ` Arnaldo Carvalho de Melo
2021-01-02 22:04 ` [PATCH 02/22] perf tools: Add config set interface Jiri Olsa
2021-01-18 15:53   ` Arnaldo Carvalho de Melo
2021-01-02 22:04 ` [PATCH 03/22] perf tools: Add debug_set_display_time function Jiri Olsa
2021-01-18 16:02   ` Arnaldo Carvalho de Melo
2021-01-19 14:59   ` Arnaldo Carvalho de Melo
2021-01-19 17:39     ` Jiri Olsa
2021-01-19 19:42       ` Arnaldo Carvalho de Melo
2021-01-02 22:04 ` [PATCH 04/22] perf tools: Add perf_home_perfconfig function Jiri Olsa
2021-01-18 16:05   ` Arnaldo Carvalho de Melo
2021-01-02 22:04 ` [PATCH 05/22] perf tools: Make perf_config_system global Jiri Olsa
2021-01-18 16:03   ` Arnaldo Carvalho de Melo
2021-01-02 22:04 ` [PATCH 06/22] perf tools: Make perf_config_global gobal Jiri Olsa
2021-01-18 16:05   ` Arnaldo Carvalho de Melo
2021-01-02 22:04 ` [PATCH 07/22] perf daemon: Add daemon command Jiri Olsa
2021-01-19  4:08   ` Namhyung Kim
2021-01-19 18:31     ` Jiri Olsa
2021-01-21  4:53       ` Namhyung Kim
2021-01-27  7:09   ` Namhyung Kim
2021-01-27 22:01     ` Jiri Olsa
2021-01-02 22:04 ` [PATCH 08/22] perf daemon: Add config file change check Jiri Olsa
2021-01-19  5:31   ` Namhyung Kim
2021-01-19 17:49     ` Jiri Olsa
2021-01-21  4:54       ` Namhyung Kim
2021-01-02 22:04 ` [PATCH 09/22] perf daemon: Add signalfd support Jiri Olsa
2021-01-02 22:04 ` [PATCH 10/22] perf daemon: Add signal command Jiri Olsa
2021-01-02 22:04 ` [PATCH 11/22] perf daemon: Add stop command Jiri Olsa
2021-01-19  5:35   ` Namhyung Kim
2021-01-02 22:04 ` [PATCH 12/22] perf daemon: Allow only one daemon over base directory Jiri Olsa
2021-01-19  5:37   ` Namhyung Kim
2021-01-19 17:44     ` Jiri Olsa
2021-01-02 22:04 ` [PATCH 13/22] perf daemon: Set control fifo for session Jiri Olsa
2021-01-02 22:04 ` [PATCH 14/22] perf daemon: Add ping command Jiri Olsa
2021-01-02 22:04 ` [PATCH 15/22] perf daemon: Use control to stop session Jiri Olsa
2021-01-02 22:04 ` [PATCH 16/22] perf daemon: Add up time for daemon/session list Jiri Olsa
2021-01-02 22:04 ` Jiri Olsa [this message]
2021-01-02 22:04 ` [PATCH 18/22] perf test: Add daemon list command test Jiri Olsa
2021-01-02 22:04 ` [PATCH 19/22] perf test: Add daemon reconfig test Jiri Olsa
2021-01-02 22:04 ` [PATCH 20/22] perf test: Add daemon stop command test Jiri Olsa
2021-01-02 22:04 ` [PATCH 21/22] perf test: Add daemon signal " Jiri Olsa
2021-01-02 22:04 ` [PATCH 22/22] perf test: Add daemon ping " Jiri Olsa
2021-01-18 12:55 ` [PATCHv2 00/22] perf tools: Add daemon command Jiri Olsa

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=20210102220441.794923-18-jolsa@kernel.org \
    --to=jolsa@kernel.org \
    --cc=a.p.zijlstra@chello.nl \
    --cc=abudankov@huawei.com \
    --cc=acme@kernel.org \
    --cc=alexander.shishkin@linux.intel.com \
    --cc=eranian@google.com \
    --cc=irogers@google.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mark.rutland@arm.com \
    --cc=mingo@kernel.org \
    --cc=mpetlan@redhat.com \
    --cc=namhyung@kernel.org \
    /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).