From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-dy1-f202.google.com (mail-dy1-f202.google.com [74.125.82.202]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 3AFF739D6EE for ; Sat, 25 Apr 2026 22:45:37 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=74.125.82.202 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1777157142; cv=none; b=nbyTeJo01FhNshgJmCJIx/eaGEXQyX7re9KyWFNsDL0Ibf14ApJjePMPkGkwG8420Jkz/ZHN3VYaZnJZdaA1NbHwxyQgxwZtVhO29+OP7inqFApLtLSecTyHhkt9iTMUzfxueN6Q0s9qeuuX4pivTREbnxpYq61qgi4dgRqieLM= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1777157142; c=relaxed/simple; bh=Apg6COMVe+a+jj2rsPunZNoiHSeTxEABM6kBfoegsIs=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=EwOeNmkbryGUzrumkqL4FARDBCP18d4ZL75/g9kWO9BUUhhb9pT0XgfNkJThLM6KjqP/Z/6zXo952TmaiEtuIud42nee/R5WRah0s+l7qjBtiLWLA072F97Rsej+krG2iHIRChoxnuMU++UUoEGOgOpXtrY4SlP34dLmSwj1LdY= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com; spf=pass smtp.mailfrom=flex--irogers.bounces.google.com; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b=fw90G4Sn; arc=none smtp.client-ip=74.125.82.202 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=flex--irogers.bounces.google.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="fw90G4Sn" Received: by mail-dy1-f202.google.com with SMTP id 5a478bee46e88-2bdf6fe90a9so13689184eec.1 for ; Sat, 25 Apr 2026 15:45:37 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20251104; t=1777157136; x=1777761936; darn=vger.kernel.org; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=4nB2isuX/JhvQvkWDCfxi1bwLTo8ITgEAb1m1yloXvw=; b=fw90G4SnZyozsjkQyziRNpAeOv7q8FxpciNVrTvOZitgDX0z9qYDZX9asBTkvBV6ns 5o9v6fsEP58Uk4KWeyBtTPL203VtC65QGF7q3jEALJoyS6NknFxEZwAO4BBcsrPCPQO4 ddjm1UFhVDmXv10/PYb+PxFRwgaeLGNaMI6x7nRRd1A653u3SKa2Btv8EsIHAoHw7XAL GGuRKiSb0Zg0rBDsQ+D7tTlWZ+iTdKaR/xstIX5tAfGQR0asLHOcM9FaQFB5nc6sPOXo RpgbGiua5cw61oUPkckzse65iRKatn3eyGkChHDkDy1L8BXeLm3ltgTGX49tpWhv0gCO o4Bw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1777157136; x=1777761936; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=4nB2isuX/JhvQvkWDCfxi1bwLTo8ITgEAb1m1yloXvw=; b=SEl3BnvDUwI5TTbt/z0cAVAIio6liWokHi2XzvHrn1e3Qx8rKU8A2DEPAAUcbIE0aa 3+v/ZZ2HdHlpH6wFjuDkADDQX3/hDaeFi64+TwGczmBoYtfiplTjfLlro2/aFliONkuY GGUdEDoVE3Vdr8o3r0Ov4rYExG9ylEnx3oGVUIrdS4V0Wx8yFvab2GP8FgBVT1/E1KkJ HPsqrjWqHEtn1w66mi3QQeS2Ui/jqvr7yvhzp6rJh+cE7IjgEkKi8FZCfNSemgxQS5D/ TrbdZoEqu4Gn5a3eM9N1JhZPRsUwaYouenTkd8chvpDgTMS+17E1W/JIr00rf90ThKDe QGzg== X-Forwarded-Encrypted: i=1; AFNElJ+CxbDtWbf8zVAFUc2PPkIPs1fwRSi6cWe8SZn2+T8Jm6H+1+nmmcZ17hcDqhefPNLiSb/eUUhslCi9QAJpe5m3@vger.kernel.org X-Gm-Message-State: AOJu0YyIWDwDe/495cuCuo3luLUxaz2+Q7d45nBCVrhWq6TYwjQljOHr OXFe6IGq6i4HOG9MIf0KTTbQqEEguB36SNw4ZIWO9toa1FARbRabEohhlwHJpY8wxKBXT0tN1NC FEAKSe45VVw== X-Received: from dlae3.prod.google.com ([2002:a05:701b:2303:b0:12d:bcd0:59a4]) (user=irogers job=prod-delivery.src-stubby-dispatcher) by 2002:a05:7022:60f:b0:122:3a5:fc42 with SMTP id a92af1059eb24-12c73f99eeemr18600700c88.20.1777157136015; Sat, 25 Apr 2026 15:45:36 -0700 (PDT) Date: Sat, 25 Apr 2026 15:45:01 -0700 In-Reply-To: <20260425224503.170337-1-irogers@google.com> Precedence: bulk X-Mailing-List: linux-perf-users@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20260425174858.3922152-1-irogers@google.com> <20260425224503.170337-1-irogers@google.com> X-Mailer: git-send-email 2.54.0.545.g6539524ca2-goog Message-ID: <20260425224503.170337-15-irogers@google.com> Subject: [PATCH v7 57/59] perf Documentation: Update for standalone Python scripts and remove obsolete data From: Ian Rogers To: acme@kernel.org, adrian.hunter@intel.com, james.clark@linaro.org, leo.yan@linux.dev, namhyung@kernel.org, tmricht@linux.ibm.com Cc: alice.mei.rogers@gmail.com, dapeng1.mi@linux.intel.com, linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org, linux-perf-users@vger.kernel.org, mingo@redhat.com, peterz@infradead.org, Ian Rogers Content-Type: text/plain; charset="UTF-8" - Remove documentation for -g and -s options in perf-script.txt. - Remove links to perf-script-perl in perf-script.txt. - Rewrite perf-script-python.txt to describe the new standalone script usage with perf module. - Remove obsolete perf-script-perl.txt. Assisted-by: Gemini:gemini-3.1-pro-preview Signed-off-by: Ian Rogers --- v6: - Updated `perf-script-python.txt` to use indented code blocks to fix man page formatting, and documented `find_thread` and `elf_machine`. --- tools/perf/Documentation/perf-script-perl.txt | 216 ------ .../perf/Documentation/perf-script-python.txt | 713 +++--------------- tools/perf/Documentation/perf-script.txt | 70 +- 3 files changed, 96 insertions(+), 903 deletions(-) delete mode 100644 tools/perf/Documentation/perf-script-perl.txt diff --git a/tools/perf/Documentation/perf-script-perl.txt b/tools/perf/Documentation/perf-script-perl.txt deleted file mode 100644 index 5b479f5e62ff..000000000000 --- a/tools/perf/Documentation/perf-script-perl.txt +++ /dev/null @@ -1,216 +0,0 @@ -perf-script-perl(1) -=================== - -NAME ----- -perf-script-perl - Process trace data with a Perl script - -SYNOPSIS --------- -[verse] -'perf script' [-s [Perl]:script[.pl] ] - -DESCRIPTION ------------ - -This perf script option is used to process perf script data using perf's -built-in Perl interpreter. It reads and processes the input file and -displays the results of the trace analysis implemented in the given -Perl script, if any. - -STARTER SCRIPTS ---------------- - -You can avoid reading the rest of this document by running 'perf script --g perl' in the same directory as an existing perf.data trace file. -That will generate a starter script containing a handler for each of -the event types in the trace file; it simply prints every available -field for each event in the trace file. - -You can also look at the existing scripts in -~/libexec/perf-core/scripts/perl for typical examples showing how to -do basic things like aggregate event data, print results, etc. Also, -the check-perf-script.pl script, while not interesting for its results, -attempts to exercise all of the main scripting features. - -EVENT HANDLERS --------------- - -When perf script is invoked using a trace script, a user-defined -'handler function' is called for each event in the trace. If there's -no handler function defined for a given event type, the event is -ignored (or passed to a 'trace_unhandled' function, see below) and the -next event is processed. - -Most of the event's field values are passed as arguments to the -handler function; some of the less common ones aren't - those are -available as calls back into the perf executable (see below). - -As an example, the following perf record command can be used to record -all sched_wakeup events in the system: - - # perf record -a -e sched:sched_wakeup - -Traces meant to be processed using a script should be recorded with -the above option: -a to enable system-wide collection. - -The format file for the sched_wakeup event defines the following fields -(see /sys/kernel/tracing/events/sched/sched_wakeup/format): - ----- - format: - field:unsigned short common_type; - field:unsigned char common_flags; - field:unsigned char common_preempt_count; - field:int common_pid; - - field:char comm[TASK_COMM_LEN]; - field:pid_t pid; - field:int prio; - field:int success; - field:int target_cpu; ----- - -The handler function for this event would be defined as: - ----- -sub sched::sched_wakeup -{ - my ($event_name, $context, $common_cpu, $common_secs, - $common_nsecs, $common_pid, $common_comm, - $comm, $pid, $prio, $success, $target_cpu) = @_; -} ----- - -The handler function takes the form subsystem::event_name. - -The $common_* arguments in the handler's argument list are the set of -arguments passed to all event handlers; some of the fields correspond -to the common_* fields in the format file, but some are synthesized, -and some of the common_* fields aren't common enough to to be passed -to every event as arguments but are available as library functions. - -Here's a brief description of each of the invariant event args: - - $event_name the name of the event as text - $context an opaque 'cookie' used in calls back into perf - $common_cpu the cpu the event occurred on - $common_secs the secs portion of the event timestamp - $common_nsecs the nsecs portion of the event timestamp - $common_pid the pid of the current task - $common_comm the name of the current process - -All of the remaining fields in the event's format file have -counterparts as handler function arguments of the same name, as can be -seen in the example above. - -The above provides the basics needed to directly access every field of -every event in a trace, which covers 90% of what you need to know to -write a useful trace script. The sections below cover the rest. - -SCRIPT LAYOUT -------------- - -Every perf script Perl script should start by setting up a Perl module -search path and 'use'ing a few support modules (see module -descriptions below): - ----- - use lib "$ENV{'PERF_EXEC_PATH'}/scripts/perl/Perf-Trace-Util/lib"; - use lib "./Perf-Trace-Util/lib"; - use Perf::Trace::Core; - use Perf::Trace::Context; - use Perf::Trace::Util; ----- - -The rest of the script can contain handler functions and support -functions in any order. - -Aside from the event handler functions discussed above, every script -can implement a set of optional functions: - -*trace_begin*, if defined, is called before any event is processed and -gives scripts a chance to do setup tasks: - ----- - sub trace_begin - { - } ----- - -*trace_end*, if defined, is called after all events have been - processed and gives scripts a chance to do end-of-script tasks, such - as display results: - ----- -sub trace_end -{ -} ----- - -*trace_unhandled*, if defined, is called after for any event that - doesn't have a handler explicitly defined for it. The standard set - of common arguments are passed into it: - ----- -sub trace_unhandled -{ - my ($event_name, $context, $common_cpu, $common_secs, - $common_nsecs, $common_pid, $common_comm) = @_; -} ----- - -The remaining sections provide descriptions of each of the available -built-in perf script Perl modules and their associated functions. - -AVAILABLE MODULES AND FUNCTIONS -------------------------------- - -The following sections describe the functions and variables available -via the various Perf::Trace::* Perl modules. To use the functions and -variables from the given module, add the corresponding 'use -Perf::Trace::XXX' line to your perf script script. - -Perf::Trace::Core Module -~~~~~~~~~~~~~~~~~~~~~~~~ - -These functions provide some essential functions to user scripts. - -The *flag_str* and *symbol_str* functions provide human-readable -strings for flag and symbolic fields. These correspond to the strings -and values parsed from the 'print fmt' fields of the event format -files: - - flag_str($event_name, $field_name, $field_value) - returns the string representation corresponding to $field_value for the flag field $field_name of event $event_name - symbol_str($event_name, $field_name, $field_value) - returns the string representation corresponding to $field_value for the symbolic field $field_name of event $event_name - -Perf::Trace::Context Module -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Some of the 'common' fields in the event format file aren't all that -common, but need to be made accessible to user scripts nonetheless. - -Perf::Trace::Context defines a set of functions that can be used to -access this data in the context of the current event. Each of these -functions expects a $context variable, which is the same as the -$context variable passed into every event handler as the second -argument. - - common_pc($context) - returns common_preempt count for the current event - common_flags($context) - returns common_flags for the current event - common_lock_depth($context) - returns common_lock_depth for the current event - -Perf::Trace::Util Module -~~~~~~~~~~~~~~~~~~~~~~~~ - -Various utility functions for use with perf script: - - nsecs($secs, $nsecs) - returns total nsecs given secs/nsecs pair - nsecs_secs($nsecs) - returns whole secs portion given nsecs - nsecs_nsecs($nsecs) - returns nsecs remainder given nsecs - nsecs_str($nsecs) - returns printable string in the form secs.nsecs - avg($total, $n) - returns average given a sum and a total number of values - -SEE ALSO --------- -linkperf:perf-script[1] diff --git a/tools/perf/Documentation/perf-script-python.txt b/tools/perf/Documentation/perf-script-python.txt index 27a1cac6fe76..6bcf98e4e6c6 100644 --- a/tools/perf/Documentation/perf-script-python.txt +++ b/tools/perf/Documentation/perf-script-python.txt @@ -3,676 +3,143 @@ perf-script-python(1) NAME ---- -perf-script-python - Process trace data with a Python script +perf-script-python - Process trace data with a Python script using perf module SYNOPSIS -------- [verse] -'perf script' [-s [Python]:script[.py] ] +'perf script'