Skip to content

tools/perf: Adopt kernel compiler-context-analysis.h annotations

Ian Rogers bpf linux-perf-users lkml llvm 14 versions – New

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v14 Latest23 patches 0 repliesNew
  2. v1321 patches 0 repliesSuperseded
  3. v1220 patches 12 repliesSuperseded
Earlier versions · 11
VersionPostedPatchesRepliesStatus
v1120 patches2 repliesSuperseded
v1020 patches1 replySuperseded
v919 patches0 repliesSuperseded
v819 patches4 repliesSuperseded
v717 patches0 repliesSuperseded
v617 patches0 repliesSuperseded
v517 patches0 repliesSuperseded
v417 patches0 repliesSuperseded
v317 patches0 repliesSuperseded
v210 patches5 repliesSuperseded
v110 patches7 repliesSuperseded

Changes in v14 from the cover letter

- Rebase onto perf-tools-next (dropping the redundant __maps__insert() hunk from patch 20 now covered by commit 31fa6010e5c0 ("perf maps:
Check map__start_cmp() in __maps__insert()")).
- Keep mmap2_valid ahead of build_id in __dso_id__cmp() so DSOs created from inode-based MMAP2 events that later gain a build ID do not break bsearch() ordering for subsequent inode-only lookups (Sashiko).
- Prepare TPEBS events under tpebs_mtx, wait on tpebs_starting (with tpebs_gen check) and check tpebs_enabled before treating an already-started session as ready in evsel__tpebs_open(), purge all prepared tpebs_results entries only for the owning session on error, initialize tpebs_cmd.out = -1, and re-lookup t after reacquiring tpebs_mtx in evsel__tpebs_read() (Sashiko).
- Hold machines->lock around remaining direct accesses to machines.guests in aslr, build-id, and session, and annotate machines->guests with __guarded_by(&lock) (patches 22 and 23).

Patches in v14 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/23compiler-context-analysis: Avoid unused parameter warning in _context_unsafe_alias()include/linux/compiler-context-analysis.h+1 -10 replies
2/23tools headers compiler: Synchronize compiler_types.h with the kernel sourcestools/include/linux/compiler-gcc.h tools/include/linux/compiler.h tools/include/linux/compiler_types.h+275 -530 replies
3/23tools headers: Synchronize linux/compiler-context-analysis.h with the kernel sourcestools/include/linux/compiler-context-analysis.h tools/perf/check-headers.sh+480 -390 replies
4/23perf mutex: Use kernel style compiler-context-analysis.h annotationstools/perf/Makefile.config tools/perf/builtin-sched.c tools/perf/builtin-top.c +14 more+70 -1470 replies
5/23perf build: Enable additional Clang thread-safety flagstools/perf/Makefile.config+7 -10 replies
6/23perf comm: Add __guarded_by annotations to struct comm_strstools/perf/util/comm.c+3 -30 replies
7/23perf vdso: Fix unlocked __dsos__add() and race in __machine__addnew_vdso()tools/perf/util/dsos.c tools/perf/util/dsos.h tools/perf/util/vdso.c+42 -200 replies
8/23perf dsos: Skip BPF and OOL DSOs in dsos__find_kernel_dso()tools/perf/util/dso.h tools/perf/util/dsos.c tools/perf/util/machine.c +1 more+25 -170 replies
9/23perf dsos: Ensure DSOs in auxtrace, machine, and symbol are in dsostools/perf/util/auxtrace.c tools/perf/util/machine.c tools/perf/util/symbol.c+21 -30 replies
10/23perf dso: Pass dso_data to close_data_fd() and dso__list_del()tools/perf/util/dso.c tools/perf/util/dso.h+12 -350 replies
11/23perf dso: Use DEFINE_MUTEX for dso__data_open_locktools/perf/util/dso.c tools/perf/util/dso.h+32 -460 replies
12/23perf dsos: Use read lock fast path in dsos__findnew_id()tools/perf/util/dso.c tools/perf/util/dso.h tools/perf/util/dsos.c+42 -140 replies
13/23perf dso: Expand context analysis annotationstools/perf/tests/dso-data.c tools/perf/util/dso.c tools/perf/util/dsos.c +2 more+26 -120 replies
14/23perf thread: Expand context analysis annotations to threads and namespaces_locktools/perf/util/thread.c tools/perf/util/thread.h tools/perf/util/threads.c +1 more+26 -140 replies
15/23perf intel-tpebs: Fix race in tpebs_stop() and tpebs_cmd.out fd handlingtools/perf/util/intel-tpebs.c+184 -590 replies
16/23perf intel-tpebs: Use DEFINE_MUTEX for tpebs_mtx and add lock annotationstools/perf/util/intel-tpebs.c+48 -610 replies
17/23perf config: Add __guarded_by and __must_hold annotationstools/perf/util/config.c+29 -180 replies
18/23perf env: Add __guarded_by and __must_hold annotationstools/perf/util/bpf-event.h tools/perf/util/env.c tools/perf/util/env.h+15 -100 replies
19/23perf maps: Fix lock inversion in maps__load_first()tools/perf/util/maps.c+8 -30 replies
20/23perf maps: Fix map index lookup fallback and removaltools/perf/tests/maps.c tools/perf/util/machine.c tools/perf/util/maps.c+207 -450 replies
21/23perf maps: Add context analysis annotationstools/perf/util/maps.c+77 -420 replies
22/23perf machine: Hold machines->lock for remaining guests rbtree accessestools/perf/util/aslr.c tools/perf/util/build-id.c tools/perf/util/session.c+18 -20 replies
23/23perf machine: Add __guarded_by annotation to machines->gueststools/perf/util/machine.c tools/perf/util/machine.h+3 -10 replies

Reviews trailers per patch

1 of 23 patches has a Reviewed-by or Acked-by.

PatchMarco Elver
1/23R-b
2/23
3/23
4/23
5/23
6/23
7/23
8/23
9/23
10/23
11/23
12/23
13/23
14/23
15/23
16/23
17/23
18/23
19/23
20/23
21/23
22/23
23/23

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v14 thread

Cover letter [PATCH v14 00/23] tools/perf: Adopt kernel compiler-context-analysis.h annotations

The perf tool previously added Clang thread-safety annotations in tools/perf/util/mutex.h (GUARDED_BY, LOCKABLE, EXCLUSIVE_LOCK_FUNCTION, UNLOCK_FUNCTION, etc.). Since then, the Linux kernel has adopted a unified set of static context analysis macros and attributes in include/linux/compiler-context-analysis.h (context_lock_struct, __guarded_by, __acquires, __releases, __must_hold, etc.).

This series makes tools/include/linux/compiler-context-analysis.h functional by synchronizing it and the required compiler_types.h helpers with the kernel headers, converts tools/perf from its custom mutex.h macros to the kernel-style compiler-context-analysis.h annotations, and expands context analysis coverage across comm, dso/dsos, thread/threads, config, intel-tpebs, env, maps, and machines. Along the way, separate preparatory patches fix an unlocked __dsos__add() call and TOCTOU race in __machine__addnew_vdso(), skip BPF and OOL DSOs in dsos__find_kernel_dso(), ensure DSOs created in auxtrace, machine, and symbol helpers belong to a dsos collection, avoid dropping _dso__data_open_lock in dso__list_del() under REFCNT_CHECKING, switch dso__data_open_lock and tpebs_mtx to DEFINE_MUTEX(), add a read-lock fast path to dsos__findnew_id(), fix an unlocked read of tpebs_reader_thread and double-close of tpebs_cmd.out in intel-tpebs, avoid a potential read-to-write deadlock in maps__load_first(), fix map index lookup fallback and removal in maps, and hold machines->lock for remaining direct accesses to machines->guests.

This series was developed and reviewed with assistance from an AI coding agent (Gemini 3.1 Pro) and reviewed with Sashiko.

v14:
- Rebase onto perf-tools-next (dropping the redundant __maps__insert() hunk from patch 20 now covered by commit 31fa6010e5c0 ("perf maps:
Check map__start_cmp() in __maps__insert()")).
- Keep mmap2_valid ahead of build_id in __dso_id__cmp() so DSOs created from inode-based MMAP2 events that later gain a build ID do not break bsearch() ordering for subsequent inode-only lookups (Sashiko).
- Prepare TPEBS events under tpebs_mtx, wait on tpebs_starting (with tpebs_gen check) and check tpebs_enabled before treating an already-started session as ready in evsel__tpebs_open(), purge all prepared tpebs_results entries only for the owning session on error, initialize tpebs_cmd.out = -1, and re-lookup t after reacquiring tpebs_mtx in evsel__tpebs_read() (Sashiko).
- Hold machines->lock around remaining direct accesses to machines.guests in aslr, build-id, and session, and annotate machines->guests with __guarded_by(&lock) (patches 22 and 23).

v13:
- Rebase onto perf-tools-next.
- Factor out dso__is_bpf_prog() for dsos__find_kernel_dso_cb() and

    check ksym_type == PERF_RECORD_KSYMBOL_TYPE_BPF &&
    is_bpf_image(event->ksymbol.name) before setting
    DSO_BINARY_TYPE__BPF_IMAGE in machine__process_ksymbol_register()
    (Namhyung).

- Prioritize build IDs over inode fields in __dso_id__cmp(), dso__needs_improve_id(), and __dso__improve_id() so an existing DSO with a defined build ID is not updated with inode metadata (Namhyung).
- Rewrite patch 15's commit message concisely, fold intel-tpebs lock annotations (with split control_fd/ack_fd declarations) into patch 16, and split config and env annotations into standalone patches 17 and 18 (Namhyung).

v12:
- Rebase onto perf-tools-next.
- Newline-terminate control commands in tpebs_send_record_cmd() so consecutive writes cannot coalesce in evlist__ctlfd_recv(), send SIGTERM in tpebs_stop() if ENABLE had not completed (tpebs_enabled, annotated __guarded_by(&tpebs_mtx) in patch 17) or sending STOP fails, and ignore late samples in process_sample_event() once tpebs_stopping is set.

v11:
- Rebase onto perf-tools-next.
- Add Fixes tags to patches 7, 15, and 18.
- Serialize tpebs_send_record_cmd() with teardown via tpebs_cmd_in_flight and tpebs_cmd_cond, check check_if_command_finished(&tpebs_cmd) under tpebs_mtx only when not stopping, guard evsel__tpebs_open() against a concurrent tpebs_stop() with a generation counter (tpebs_gen) and tpebs_stopping across closing the fds and finish_command(), and annotate tpebs_cmd, control_fd, ack_fd, tpebs_stopping, tpebs_cmd_in_flight, and tpebs_gen with __guarded_by(&tpebs_mtx) in patch 17.

v10:
- Split the maps__load_first() lock inversion fix (patch 18) from the maps index lookup and removal fixes (patch 19).
- Fall back to the linear pointer scan in maps__by_address_index() and maps__by_name_index() when bsearch() returns NULL, check map__start(prev) < map__start(new) in __maps__insert(), factor out __maps__remove_at() so maps__remove_maps() removes at index i directly without risking an infinite loop, guard against -1 index wraparound in maps__find_next_entry(), refresh sort invariants in maps__fixup_end() and machine__create_kernel_maps(), and add a unit test in tests/maps.c.

v9:
- Rebase onto perf-tools-next (resolving the conflict in tools/include/linux/compiler.h with ASSERT_STATIC_STORAGE() and converting the newly added dso__set_symsrc_filename() lock annotation in tools/perf/util/dso.h).
- Move __must_hold_shared(&dsos->lock) on __dsos__find() from patch 13 into patch 7 where __dsos__find() is introduced so every commit in the series builds cleanly with -Wthread-safety.

v8:
- Set DSO_BINARY_TYPE__BPF_IMAGE for non-OOL ksymbol DSOs in machine__process_ksymbol_register() and skip DSO_BINARY_TYPE__BPF_PROG_INFO, DSO_BINARY_TYPE__BPF_IMAGE, and DSO_BINARY_TYPE__OOL in dsos__find_kernel_dso_cb() so that dsos__find_kernel_dso() does not match ksymbol DSOs in machine->dsos (patch 8).
- Split the dsos__add() additions in auxtrace, machine, and symbol into a standalone patch (patch 9) before "perf dso: Pass dso_data to close_data_fd() and dso__list_del()" (patch 10).

v7:
- Add newly created DSOs in machine__process_ksymbol_register() and dso__split_kallsyms() to machine->dsos so assert(dso__dsos(dso)) in dso__list_add() always holds.
- Add __guarded_by(&config_mutex) to function-local static parser buffers in parse_value() and perf_parse_file().
- Remove from maps_by_name before calling map__put(maps_by_address[address_idx]) in __maps__remove() so callers such as maps__remove_maps() that pass maps_by_address[i] as map do not use a freed handle in maps__by_name_index() under REFCNT_CHECKING.

v6:
- Rebase onto perf-tools-next.

v5:
- Hold machine->dsos.lock in write mode across machine->vdso_info initialization and temporary file creation in machine__findnew_vdso() and __machine__findnew_compat(), and annotate __machine__addnew_vdso() with __must_hold(&machine->dsos.lock).
- Reset tpebs_cmd.pid = 0 and return early without setting

    t->started = true if start_command() fails in
    evsel__tpebs_start_perf_record().

v4:
- Place the DSO loaded in addr_filter__resolve_syms() into a dsos collection so dso__dsos(dso) is populated.
- Join tpebs_reader_thread on error in evsel__tpebs_open(), document why tpebs_cmd.pid is cleared before pthread_join() in tpebs_stop(), and include <pthread.h> and <signal.h> in util/intel-tpebs.c.
- Include <string.h> in util/maps.c.

v3:
- Rebase onto perf-tools-next (converting the newly added dso__find_binary_type() lock annotations in util/dso.c).
- Separate bug fixes, DEFINE_MUTEX() cleanups, and improvements (vdso, dso_data, dso__data_open_lock, dsos__findnew_id, intel-tpebs, tpebs_mtx, maps) from the annotation patches.
- Move AI coding assistant attribution to the cover letter and drop per-commit Assisted-by tags per linux-next Documentation/process/coding-assistants.rst.
- Add Marco Elver's Reviewed-by to patch 1.
- Define __diag_clang_23() and Clang ASM_INPUT_G/ASM_INPUT_RM/ ASM_OUTPUT_RM overrides in tools/include/linux/compiler-gcc.h.
- Probe for -Wthread-safety-pointer/-Wthread-safety-beta in Makefile.config.
- Pass write_locked to __dsos__find().
- Pass struct dso_data * to close_data_fd() and dso__list_del() to remove the REFCNT_CHECKING dso pointer from struct dso_data and avoid dropping dso__data_open_lock in dso__list_del(), and include <assert.h> in util/dso.c.
- Re-validate DSO lookup under the write lock in dsos__findnew_id() via __dsos__findnew_id(), and handle NULL dso_id in dso__needs_improve_id(), __dso__improve_id(), and dso_id__cmp().
- Reset tpebs_cmd.out = -1 if start_command() fails and include

    <stdint.h>, <stdlib.h>, <string.h>, and <unistd.h> in
    util/intel-tpebs.c.

- Bounds-check the index in __maps__remove() (freeing maps_by_name if out of bounds).

v2:
- Use -c rather than -E when probing for -fexperimental-late-parse-attributes in Makefile.config to avoid -Werror,-Wunused-command-line-argument.
- Acquire machine->dsos.lock in write mode across duplicate checking,

    dso__set_long_name(), and __dsos__add() in __machine__addnew_vdso().

- Avoid dropping dso__data_open_lock in dso__list_del() under REFCNT_CHECKING.
- Pass tpebs_cmd.out directly to __sample_reader() and set tpebs_cmd.out = -1 in evsel__tpebs_open() to avoid a double-close in tpebs_stop(), and clarify the config_set_mutex comment.
- Drop maps__lock before calling map__load() in maps__load_first() to avoid a read-to-write self-deadlock when loading kernel maps inserts additional trampoline maps.

Ian Rogers (23):
compiler-context-analysis: Avoid unused parameter warning in
_context_unsafe_alias()
tools headers compiler: Synchronize compiler_types.h with the kernel
sources
tools headers: Synchronize linux/compiler-context-analysis.h with the
kernel sources
perf mutex: Use kernel style compiler-context-analysis.h annotations perf build: Enable additional Clang thread-safety flags perf comm: Add __guarded_by annotations to struct comm_strs perf vdso: Fix unlocked __dsos__add() and race in

    __machine__addnew_vdso()

perf dsos: Skip BPF and OOL DSOs in dsos__find_kernel_dso() perf dsos: Ensure DSOs in auxtrace, machine, and symbol are in dsos perf dso: Pass dso_data to close_data_fd() and dso__list_del() perf dso: Use DEFINE_MUTEX for dso__data_open_lock
perf dsos: Use read lock fast path in dsos__findnew_id() perf dso: Expand context analysis annotations
perf thread: Expand context analysis annotations to threads and
namespaces_lock
perf intel-tpebs: Fix race in tpebs_stop() and tpebs_cmd.out fd
handling
perf intel-tpebs: Use DEFINE_MUTEX for tpebs_mtx and add lock
annotations
perf config: Add __guarded_by and __must_hold annotations perf env: Add __guarded_by and __must_hold annotations perf maps: Fix lock inversion in maps__load_first()
perf maps: Fix map index lookup fallback and removal
perf maps: Add context analysis annotations
perf machine: Hold machines->lock for remaining guests rbtree accesses perf machine: Add __guarded_by annotation to machines->guests

 include/linux/compiler-context-analysis.h     |   2 +-
 .../include/linux/compiler-context-analysis.h | 518 ++++++++++++++++--
 tools/include/linux/compiler-gcc.h            |  72 ++-
 tools/include/linux/compiler.h                |  50 +-
 tools/include/linux/compiler_types.h          | 206 ++++++-
 tools/perf/Makefile.config                    |   8 +-
 tools/perf/builtin-sched.c                    |  16 +-
 tools/perf/builtin-top.c                      |   4 +-
 tools/perf/check-headers.sh                   |   1 +
 tools/perf/tests/dso-data.c                   |   4 +
 tools/perf/tests/maps.c                       | 140 +++++
 tools/perf/util/annotate.c                    |   4 +-
 tools/perf/util/annotate.h                    |   8 +-
 tools/perf/util/aslr.c                        |   4 +
 tools/perf/util/auxtrace.c                    |  16 +-
 tools/perf/util/bpf-event.h                   |   5 +-
 tools/perf/util/build-id.c                    |   8 +
 tools/perf/util/comm.c                        |  10 +-
 tools/perf/util/config.c                      |  47 +-
 tools/perf/util/dso.c                         | 169 +++---
 tools/perf/util/dso.h                         |  33 +-
 tools/perf/util/dsos.c                        |  34 +-
 tools/perf/util/dsos.h                        |  12 +-
 tools/perf/util/env.c                         |   1 +
 tools/perf/util/env.h                         |  19 +-
 tools/perf/util/intel-tpebs.c                 | 314 +++++++----
 tools/perf/util/libbfd.c                      |   4 +-
 tools/perf/util/machine.c                     |  35 +-
 tools/perf/util/machine.h                     |   3 +-
 tools/perf/util/map.c                         |  14 +-
 tools/perf/util/maps.c                        | 215 +++++---
 tools/perf/util/mutex.c                       |   4 +-
 tools/perf/util/mutex.h                       |  90 +--
 tools/perf/util/rwsem.c                       |   8 +-
 tools/perf/util/rwsem.h                       |  10 +-
 tools/perf/util/session.c                     |   8 +-
 tools/perf/util/symbol.c                      |   4 +
 tools/perf/util/thread.c                      |  10 +-
 tools/perf/util/thread.h                      |  30 +-
 tools/perf/util/threads.c                     |   4 +
 tools/perf/util/threads.h                     |   6 +-
 tools/perf/util/vdso.c                        |  53 +-
 42 files changed, 1604 insertions(+), 599 deletions(-)

base-commit: b7ff10b9ddec8da75304c40fe4abf1ee4f9f0a43

Signature · 1 line
2.56.1.703.gf848ed807c-goog