linux.git/tools/perf/Build, branch v6.18.21

perf build: Specify shellcheck should use bash

2025-06-30T16:43:06+00:00

When someone has a global shellcheckrc file, for example at
~/.config/shellcheckrc, with the directive 'shell=sh', building perf
will fail with many shellcheck errors like:

    In tests/shell/base_probe/test_adding_kernel.sh line 294:
    (( TEST_RESULT += $? ))
    ^---------------------^ SC3006 (warning): In POSIX sh, standalone ((..)) is undefined.

    For more information:
      https://www.shellcheck.net/wiki/SC3006 -- In POSIX sh, standalone ((..)) is...
    make[5]: *** [tests/Build:91: tests/shell/base_probe/test_adding_kernel.sh.shellcheck_log] Error 1

Passing the '-s bash' option ensures that it runs correctly regardless
of a developers global configuration.

This patch adds '-s bash' and other options to the SHELLCHECK variable
in Makefile.perf and makes use of the variable consistently.

Signed-off-by: Collin Funk 
Link: https://lore.kernel.org/r/63491dbc8439edf2e949d80e264b9d22332fea61.1751082075.git.collin.funk1@gmail.com
Signed-off-by: Namhyung Kim

perf build: Add pylint build tests

2025-03-24T16:38:20+00:00

If PYLINT=1 is passed to the build then run pylint over python code in
perf. Unlike shellcheck this isn't default on as there are currently
too many errors.

An example of an error:
```
************* Module setup
util/setup.py:19:0: C0301: Line too long (127/100) (line-too-long)
util/setup.py:20:0: C0301: Line too long (138/100) (line-too-long)
util/setup.py:63:0: C0301: Line too long (106/100) (line-too-long)
util/setup.py:1:0: C0114: Missing module docstring (missing-module-docstring)
util/setup.py:24:4: W0622: Redefining built-in 'vars' (redefined-builtin)
util/setup.py:11:4: C0103: Constant name "cc_options" doesn't conform to UPPER_CASE naming style (invalid-name)
util/setup.py:13:4: C0103: Constant name "cc_options" doesn't conform to UPPER_CASE naming style (invalid-name)
util/setup.py:15:34: R1732: Consider using 'with' for resource-allocating operations (consider-using-with)
util/setup.py:18:0: C0116: Missing function or method docstring (missing-function-docstring)
util/setup.py:19:16: R1732: Consider using 'with' for resource-allocating operations (consider-using-with)
util/setup.py:44:0: C0413: Import "from setuptools import setup, Extension" should be placed at the top of the module (wrong-import-position)
util/setup.py:46:0: C0413: Import "from setuptools.command.build_ext import build_ext as _build_ext" should be placed at the top of the module (wrong-import-position)
util/setup.py:47:0: C0413: Import "from setuptools.command.install_lib import install_lib as _install_lib" should be placed at the top of the module (wrong-import-position)
util/setup.py:49:0: C0115: Missing class docstring (missing-class-docstring)
util/setup.py:49:0: C0103: Class name "build_ext" doesn't conform to PascalCase naming style (invalid-name)
util/setup.py:52:8: W0201: Attribute 'build_lib' defined outside __init__ (attribute-defined-outside-init)
util/setup.py:53:8: W0201: Attribute 'build_temp' defined outside __init__ (attribute-defined-outside-init)
util/setup.py:55:0: C0115: Missing class docstring (missing-class-docstring)
util/setup.py:55:0: C0103: Class name "install_lib" doesn't conform to PascalCase naming style (invalid-name)
util/setup.py:58:8: W0201: Attribute 'build_dir' defined outside __init__ (attribute-defined-outside-init)

*-----------------------------------------------------------------
Your code has been rated at 6.67/10 (previous run: 6.51/10, +0.16)

make[4]: *** [util/Build:442: util/setup.py.pylint_log] Error 1
```

Reviewed-by: James Clark 
Signed-off-by: Ian Rogers 
Link: https://lore.kernel.org/r/20250311213628.569562-5-irogers@google.com
Signed-off-by: Namhyung Kim

perf build: Add mypy build tests

2025-03-24T16:38:20+00:00

If MYPY=1 is passed to the build then run mypy over python code in
perf. Unlike shellcheck this isn't default on as there are currently
too many errors.

An example of an error:
```
util/setup.py:8: error: Item "None" of "str | None" has no attribute "split"  [union-attr]
util/setup.py:15: error: Item "None" of "IO[bytes] | None" has no attribute "readline"  [union-attr]
util/setup.py:15: error: List item 0 has incompatible type "str | None"; expected "str | bytes | PathLike[str] | PathLike[bytes]"  [list-item]
util/setup.py:16: error: Unsupported left operand type for + ("None")  [operator]
util/setup.py:16: note: Left operand is of type "str | None"
util/setup.py:74: error: Unsupported left operand type for + ("None")  [operator]
util/setup.py:74: note: Left operand is of type "str | None"
Found 5 errors in 1 file (checked 1 source file)
make[4]: *** [util/Build:430: util/setup.py.mypy_log] Error 1
```

Reviewed-by: James Clark 
Signed-off-by: Ian Rogers 
Link: https://lore.kernel.org/r/20250311213628.569562-4-irogers@google.com
Signed-off-by: Namhyung Kim

perf build: Rename TEST_LOGS to SHELL_TEST_LOGS

2025-03-24T16:38:20+00:00

Rename TEST_LOGS to SHELL_TEST_LOGS as later changes will add more
kinds of test logs.
Minor comment tweak in Makefile.perf as more than just test shell
tests are checked.

Reviewed-by: James Clark 
Signed-off-by: Ian Rogers 
Link: https://lore.kernel.org/r/20250311213628.569562-3-irogers@google.com
Signed-off-by: Namhyung Kim

perf check: Introduce 'check' subcommand

2024-09-04T12:56:05+00:00

Currently the presence of a feature is checked with a combination of
perf version --build-options and greps, such as:

    perf version --build-options | grep " on .* HAVE_FEATURE"

Instead of this, introduce a subcommand "perf check feature", with which
scripts can test for presence of a feature, such as:

    perf check feature HAVE_FEATURE

'perf check feature' command is expected to have exit status of 0 if
feature is built-in, and 1 if it's not built-in or if feature is not known.

Multiple features can also be passed as a comma-separated list, in which
case the exit status will be 1 only if all of the passed features are
built-in. For example, with below command, it will have exit status of 0
only if both libtraceevent and bpf are enabled, else 1 in all other cases

    perf check feature libtraceevent,bpf

The arguments are case-insensitive.
An array 'supported_features' has also been introduced that can be used by
other commands like 'perf version --build-options', so that new features
can be added in one place, with the array

Committer testing:

  $ perf check feature libtraceevent,bpf
           libtraceevent: [ on  ]  # HAVE_LIBTRACEEVENT
                     bpf: [ on  ]  # HAVE_LIBBPF_SUPPORT
  $ perf check feature libtraceevent
           libtraceevent: [ on  ]  # HAVE_LIBTRACEEVENT
  $ perf check feature bpf
                     bpf: [ on  ]  # HAVE_LIBBPF_SUPPORT
  $ perf check -q feature bpf && echo "BPF support is present"
  BPF support is present
  $ perf check -q feature Bogus && echo "Bogus support is present"
  $

Reviewed-by: Athira Rajeev 
Signed-off-by: Aditya Gupta 
Tested-by: Arnaldo Carvalho de Melo 
Cc: Athira Rajeev 
Cc: Disha Goel 
Cc: Ian Rogers 
Cc: Jiri Olsa 
Cc: Kajol Jain 
Cc: Madhavan Srinivasan 
Cc: Namhyung Kim 
Link: https://lore.kernel.org/r/20240904061836.55873-3-adityag@linux.ibm.com
Signed-off-by: Arnaldo Carvalho de Melo

perf util: Make util its own library

2024-06-26T18:07:42+00:00

Make the util directory into its own library. This is done to avoid
compiling code twice, once for the perf tool and once for the perf
python module. For convenience:
  arch/common.c
  scripts/perl/Perf-Trace-Util/Context.c
  scripts/python/Perf-Trace-Util/Context.c
are made part of this library.

Signed-off-by: Ian Rogers 
Reviewed-by: James Clark 
Cc: Suzuki K Poulose 
Cc: Kees Cook 
Cc: Palmer Dabbelt 
Cc: Albert Ou 
Cc: Nick Terrell 
Cc: Gary Guo 
Cc: Alex Gaynor 
Cc: Boqun Feng 
Cc: Wedson Almeida Filho 
Cc: Ze Gao 
Cc: Alice Ryhl 
Cc: Andrei Vagin 
Cc: Yicong Yang 
Cc: Jonathan Cameron 
Cc: Guo Ren 
Cc: Miguel Ojeda 
Cc: Will Deacon 
Cc: Mike Leach 
Cc: Leo Yan 
Cc: Oliver Upton 
Cc: John Garry 
Cc: Benno Lossin 
Cc: Björn Roy Baron 
Cc: Andreas Hindborg 
Cc: Paul Walmsley 
Signed-off-by: Namhyung Kim 
Link: https://lore.kernel.org/r/20240625214117.953777-7-irogers@google.com

perf bench: Make bench its own library

2024-06-26T18:07:28+00:00

Make the benchmark code into a library so it may be linked against
things like the python module to avoid compiling code twice.

Signed-off-by: Ian Rogers 
Reviewed-by: James Clark 
Cc: Suzuki K Poulose 
Cc: Kees Cook 
Cc: Palmer Dabbelt 
Cc: Albert Ou 
Cc: Nick Terrell 
Cc: Gary Guo 
Cc: Alex Gaynor 
Cc: Boqun Feng 
Cc: Wedson Almeida Filho 
Cc: Ze Gao 
Cc: Alice Ryhl 
Cc: Andrei Vagin 
Cc: Yicong Yang 
Cc: Jonathan Cameron 
Cc: Guo Ren 
Cc: Miguel Ojeda 
Cc: Will Deacon 
Cc: Mike Leach 
Cc: Leo Yan 
Cc: Oliver Upton 
Cc: John Garry 
Cc: Benno Lossin 
Cc: Björn Roy Baron 
Cc: Andreas Hindborg 
Cc: Paul Walmsley 
Signed-off-by: Namhyung Kim 
Link: https://lore.kernel.org/r/20240625214117.953777-6-irogers@google.com

perf test: Make tests its own library

2024-06-26T18:07:11+00:00

Make the tests code its own library. This is done to avoid compiling
code twice, once for the perf tool and once for the perf python
module.

Signed-off-by: Ian Rogers 
Reviewed-by: James Clark 
Cc: Suzuki K Poulose 
Cc: Kees Cook 
Cc: Palmer Dabbelt 
Cc: Albert Ou 
Cc: Nick Terrell 
Cc: Gary Guo 
Cc: Alex Gaynor 
Cc: Boqun Feng 
Cc: Wedson Almeida Filho 
Cc: Ze Gao 
Cc: Alice Ryhl 
Cc: Andrei Vagin 
Cc: Yicong Yang 
Cc: Jonathan Cameron 
Cc: Guo Ren 
Cc: Miguel Ojeda 
Cc: Will Deacon 
Cc: Mike Leach 
Cc: Leo Yan 
Cc: Oliver Upton 
Cc: John Garry 
Cc: Benno Lossin 
Cc: Björn Roy Baron 
Cc: Andreas Hindborg 
Cc: Paul Walmsley 
Signed-off-by: Namhyung Kim 
Link: https://lore.kernel.org/r/20240625214117.953777-5-irogers@google.com

perf ui: Make ui its own library

2024-06-26T18:06:34+00:00

Make the ui code its own library. This is done to avoid compiling code
twice, once for the perf tool and once for the perf python module.

Signed-off-by: Ian Rogers 
Reviewed-by: James Clark 
Cc: Suzuki K Poulose 
Cc: Kees Cook 
Cc: Palmer Dabbelt 
Cc: Albert Ou 
Cc: Nick Terrell 
Cc: Gary Guo 
Cc: Alex Gaynor 
Cc: Boqun Feng 
Cc: Wedson Almeida Filho 
Cc: Ze Gao 
Cc: Alice Ryhl 
Cc: Andrei Vagin 
Cc: Yicong Yang 
Cc: Jonathan Cameron 
Cc: Guo Ren 
Cc: Miguel Ojeda 
Cc: Will Deacon 
Cc: Mike Leach 
Cc: Leo Yan 
Cc: Oliver Upton 
Cc: John Garry 
Cc: Benno Lossin 
Cc: Björn Roy Baron 
Cc: Andreas Hindborg 
Cc: Paul Walmsley 
Signed-off-by: Namhyung Kim 
Link: https://lore.kernel.org/r/20240625214117.953777-3-irogers@google.com

perf build: Add shellcheck to tools/perf scripts

2024-04-12T20:54:02+00:00

Address shell check errors/warnings in perf-archive.sh and
perf-completion.sh.

Reviewed-by: James Clark 
Signed-off-by: Ian Rogers 
Cc: Adrian Hunter 
Cc: Alexander Shishkin 
Cc: Athira Rajeev 
Cc: Ingo Molnar 
Cc: Jiri Olsa 
Cc: Kajol Jain 
Cc: Kan Liang 
Cc: Mark Rutland 
Cc: Namhyung Kim 
Cc: Oliver Upton 
Cc: Peter Zijlstra 
Cc: Ravi Bangoria 
Link: https://lore.kernel.org/r/20240409023216.2342032-2-irogers@google.com
Signed-off-by: Arnaldo Carvalho de Melo