From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id A9074FF8862 for ; Sat, 25 Apr 2026 17:53:23 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender:List-Subscribe:List-Help :List-Post:List-Archive:List-Unsubscribe:List-Id:Content-Type:Cc:To:From: Subject:Message-ID:References:Mime-Version:In-Reply-To:Date:Reply-To: Content-Transfer-Encoding:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=zKsR0uveqcOXj5JincOO7p/wkB48KaaLUK1F2HfU7cI=; b=tCqCbsR17rSoUUfin1ge0Aji70 p5IO1B+xfyVxekfbaqcnjmwv0j17Ltq5LOUhzRx0/CC422pmh3FBUqKPL/r2Zr8iRZDOujYRcAw80 cjONgmxjhWFtHxrYXegxthZuiOPfkSL5KvK/dxb4EzteCGw96A4Kk0gIePQSmSiElLm0fbfGaIpBG 1ucn06fytcO7gkKVZHCRdi91Edj4H27OXBOfvcrLQ52G6YTJPiX+37w2Ak3KrX3+11cFIRhoo0MRd uDndUAbNM/qcXcwWX8oTZGKUl6r2q80tPrs2QkoVP9y9IiWBbbf6B46f27TrpT8XENIEPw2pm58dy u2fnIQIg==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.98.2 #2 (Red Hat Linux)) id 1wGhBs-0000000EfoE-1uLZ; Sat, 25 Apr 2026 17:53:17 +0000 Received: from mail-dl1-x1249.google.com ([2607:f8b0:4864:20::1249]) by bombadil.infradead.org with esmtps (Exim 4.98.2 #2 (Red Hat Linux)) id 1wGh9e-0000000Ee21-00UM for linux-arm-kernel@lists.infradead.org; Sat, 25 Apr 2026 17:51:18 +0000 Received: by mail-dl1-x1249.google.com with SMTP id a92af1059eb24-1270dcd11c1so5516656c88.0 for ; Sat, 25 Apr 2026 10:50:56 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20251104; t=1777139456; x=1777744256; darn=lists.infradead.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=zKsR0uveqcOXj5JincOO7p/wkB48KaaLUK1F2HfU7cI=; b=p4a/8YIjFVk93uD8yZ7+u9c8tC1N1JCmoZH9vi3nLJ0LKiaBBcKdngZDnHAKt0nbXa eLCgl/G/3N5IjF/tQG4hc4s7FjN8Mtv+Paf5vLycq0pGNJ8lZ+A9B8I7+LkKy3rJnpVN TCqQi1CWl/QT9Sv4ENrYdTcTLpmMzgbqiM3CFys6ocTJvRNXr0zM0xRoRadPRKdiCfJI XPp1bL4M3UP2FQxf5aRjQjCgVY+oSdMc3OpSYmf+no7gcOvlbstLAiEa7JBtOYtFlkGE IZ0IWwfUS9BBrTBl7eiANA3sxys97NMtkxbonBmCjk41bzSWauDUgPe3ny/1gu0UwX22 Q6Aw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1777139456; x=1777744256; 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=zKsR0uveqcOXj5JincOO7p/wkB48KaaLUK1F2HfU7cI=; b=VGiqqRF0X9p9AI2aeGllv9p1ttjzsyOMM8G/bMjyaLKe+gSU1I94m3+jBVM5R3e8tk 6KsdiEktu7y0+E9WcMe9c+XPV/CW3mwrlQ8abEayAPE6znUyQ392TEXKYsn3Xbo6SGQ/ V4j8MwYaigMwZgklc0+Z6uNqsUqbCTCWixY/557X7GPxXjprSCZIUP5vKE3734FP3J06 MAQCWVkvtk4V9Xxu5hGPU4iijUke4zcIETV4WX+oIqPtqPvRHyk7Mo74ALGBggakRKZW 40dI2GLnZQCTMhvzckZrQrlx0FgnSb4sldZaAm6Nf9SyO5nWqGdJr93xOTCqQ1K90vAf 5bNw== X-Forwarded-Encrypted: i=1; AFNElJ8okKzMc7teDJBNxQDFkJIPbFB7loliACuWoAR0ZCYB9HWEJM7J5JoTgmEdvDkSKOILHeMBss3Kbf+Rcz23yuxW@lists.infradead.org X-Gm-Message-State: AOJu0YxU+vnylI3qqgvx3Pe6tutTePEQ/bCTMiYoRplegfO4G5ZmGqkv AXWzN21YIZwc/QY4ZUxJChQV15iTGI2T61H+VfpQcBMZfLbriy1mOwc23ac7GL7IhrMJkxms82n Q5kb5viqOwA== X-Received: from dlah28.prod.google.com ([2002:a05:701b:261c:b0:12c:912f:7ce9]) (user=irogers job=prod-delivery.src-stubby-dispatcher) by 2002:a05:7022:e22:b0:128:d494:a1ab with SMTP id a92af1059eb24-12c73f83681mr21035351c88.15.1777139455464; Sat, 25 Apr 2026 10:50:55 -0700 (PDT) Date: Sat, 25 Apr 2026 10:48:55 -0700 In-Reply-To: <20260425174858.3922152-1-irogers@google.com> Mime-Version: 1.0 References: <20260424164721.2229025-1-irogers@google.com> <20260425174858.3922152-1-irogers@google.com> X-Mailer: git-send-email 2.54.0.545.g6539524ca2-goog Message-ID: <20260425174858.3922152-58-irogers@google.com> Subject: [PATCH v6 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" X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20260425_105058_406153_9BAB8EC5 X-CRM114-Status: GOOD ( 33.78 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org - 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'