bpf.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH v7 0/4] Tracing contention lock owner call stack
@ 2025-02-24 18:42 Chun-Tse Shao
  2025-02-24 18:42 ` [PATCH v7 1/4] perf lock: Add bpf maps for owner stack tracing Chun-Tse Shao
                   ` (3 more replies)
  0 siblings, 4 replies; 9+ messages in thread
From: Chun-Tse Shao @ 2025-02-24 18:42 UTC (permalink / raw)
  To: linux-kernel
  Cc: Chun-Tse Shao, peterz, mingo, acme, namhyung, mark.rutland,
	alexander.shishkin, jolsa, irogers, adrian.hunter, kan.liang,
	nick.forrington, linux-perf-users, bpf

For perf lock contention, the current owner tracking (-o option) only
works with per-thread mode (-t option). Enabling call stack mode for
owner can be useful for diagnosing why a system running slow in
lock contention.

Example output:
  $ sudo ~/linux/tools/perf/perf lock con -abvo -Y mutex -E16 perf bench sched pipe
   ...
   contended   total wait     max wait     avg wait         type   caller

         171      1.55 ms     20.26 us      9.06 us        mutex   pipe_read+0x57
                          0xffffffffac6318e7  pipe_read+0x57
                          0xffffffffac623862  vfs_read+0x332
                          0xffffffffac62434b  ksys_read+0xbb
                          0xfffffffface604b2  do_syscall_64+0x82
                          0xffffffffad00012f  entry_SYSCALL_64_after_hwframe+0x76
          36    193.71 us     15.27 us      5.38 us        mutex   pipe_write+0x50
                          0xffffffffac631ee0  pipe_write+0x50
                          0xffffffffac6241db  vfs_write+0x3bb
                          0xffffffffac6244ab  ksys_write+0xbb
                          0xfffffffface604b2  do_syscall_64+0x82
                          0xffffffffad00012f  entry_SYSCALL_64_after_hwframe+0x76
           4     51.22 us     16.47 us     12.80 us        mutex   do_epoll_wait+0x24d
                          0xffffffffac691f0d  do_epoll_wait+0x24d
                          0xffffffffac69249b  do_epoll_pwait.part.0+0xb
                          0xffffffffac693ba5  __x64_sys_epoll_pwait+0x95
                          0xfffffffface604b2  do_syscall_64+0x82
                          0xffffffffad00012f  entry_SYSCALL_64_after_hwframe+0x76
           2     20.88 us     11.95 us     10.44 us        mutex   do_epoll_wait+0x24d
                          0xffffffffac691f0d  do_epoll_wait+0x24d
                          0xffffffffac693943  __x64_sys_epoll_wait+0x73
                          0xfffffffface604b2  do_syscall_64+0x82
                          0xffffffffad00012f  entry_SYSCALL_64_after_hwframe+0x76
           1      7.33 us      7.33 us      7.33 us        mutex   do_epoll_ctl+0x6c1
                          0xffffffffac692e01  do_epoll_ctl+0x6c1
                          0xffffffffac6937e0  __x64_sys_epoll_ctl+0x70
                          0xfffffffface604b2  do_syscall_64+0x82
                          0xffffffffad00012f  entry_SYSCALL_64_after_hwframe+0x76
           1      6.64 us      6.64 us      6.64 us        mutex   do_epoll_ctl+0x3d4
                          0xffffffffac692b14  do_epoll_ctl+0x3d4
                          0xffffffffac6937e0  __x64_sys_epoll_ctl+0x70
                          0xfffffffface604b2  do_syscall_64+0x82
                          0xffffffffad00012f  entry_SYSCALL_64_after_hwframe+0x76

  === owner stack trace ===

           3     31.24 us     15.27 us     10.41 us        mutex   pipe_read+0x348
                          0xffffffffac631bd8  pipe_read+0x348
                          0xffffffffac623862  vfs_read+0x332
                          0xffffffffac62434b  ksys_read+0xbb
                          0xfffffffface604b2  do_syscall_64+0x82
                          0xffffffffad00012f  entry_SYSCALL_64_after_hwframe+0x76
  ...
v7:
  Remove duplicate contention records.

v6: lore.kernel.org/20250219214400.3317548-1-ctshao@google.com
  Free allocated memory in error patch.
  Add description in man page.

v5: lore.kernel.org/20250212222859.2086080-1-ctshao@google.com
  Move duplicated code into function.
  Remove code to retrieve undesired callstack at the end of `contention_end()`.
  Other minor fix based on Namhyung's review.

v4: lore.kernel.org/20250130052510.860318-1-ctshao@google.com
  Use `__sync_fetch_and_add()` to generate owner stackid automatically.
  Use `__sync_fetch_and_add(..., -1)` to workaround compiler error from
    `__sync_fetch_and_sub()`
  Remove unnecessary include headers.
  Dedicate on C-style comment.
  Other minor fix based on Namhyung's review.

v3: lore.kernel.org/20250129001905.619859-1-ctshao@google.com
  Rename/shorten multiple variables.
  Implement owner stackid.
  Add description for lock function return code in `contention_end()`.
  Other minor fix based on Namhyung's review.

v2: lore.kernel.org/20250113052220.2105645-1-ctshao@google.com
  Fix logic deficit in v1 patch 2/4.

v1: lore.kernel.org/20250110051346.1507178-1-ctshao@google.com

Chun-Tse Shao (4):
  perf lock: Add bpf maps for owner stack tracing
  perf lock: Retrieve owner callstack in bpf program
  perf lock: Make rb_tree helper functions generic
  perf lock: Report owner stack in usermode

 tools/perf/Documentation/perf-lock.txt        |   5 +-
 tools/perf/builtin-lock.c                     |  56 +++-
 tools/perf/util/bpf_lock_contention.c         |  71 ++++-
 .../perf/util/bpf_skel/lock_contention.bpf.c  | 245 +++++++++++++++++-
 tools/perf/util/bpf_skel/lock_data.h          |   7 +
 tools/perf/util/lock-contention.h             |   7 +
 6 files changed, 365 insertions(+), 26 deletions(-)

--
2.48.1.658.g4767266eb4-goog


^ permalink raw reply	[flat|nested] 9+ messages in thread

* [PATCH v7 1/4] perf lock: Add bpf maps for owner stack tracing
  2025-02-24 18:42 [PATCH v7 0/4] Tracing contention lock owner call stack Chun-Tse Shao
@ 2025-02-24 18:42 ` Chun-Tse Shao
  2025-02-24 18:42 ` [PATCH v7 2/4] perf lock: Retrieve owner callstack in bpf program Chun-Tse Shao
                   ` (2 subsequent siblings)
  3 siblings, 0 replies; 9+ messages in thread
From: Chun-Tse Shao @ 2025-02-24 18:42 UTC (permalink / raw)
  To: linux-kernel
  Cc: Chun-Tse Shao, peterz, mingo, acme, namhyung, mark.rutland,
	alexander.shishkin, jolsa, irogers, adrian.hunter, kan.liang,
	nick.forrington, linux-perf-users, bpf

Add a struct and few bpf maps in order to tracing owner stack.
`struct owner_tracing_data`: Contains owner's pid, stack id, timestamp for
  when the owner acquires lock, and the count of lock waiters.
`stack_buf`: Percpu buffer for retrieving owner stacktrace.
`owner_stacks`: For tracing owner stacktrace to customized owner stack id.
`owner_data`: For tracing lock_address to `struct owner_tracing_data` in
  bpf program.
`owner_stat`: For reporting owner stacktrace in usermode.

Signed-off-by: Chun-Tse Shao <ctshao@google.com>
---
 tools/perf/util/bpf_lock_contention.c         | 14 ++++++--
 .../perf/util/bpf_skel/lock_contention.bpf.c  | 33 +++++++++++++++++++
 tools/perf/util/bpf_skel/lock_data.h          |  7 ++++
 3 files changed, 52 insertions(+), 2 deletions(-)

diff --git a/tools/perf/util/bpf_lock_contention.c b/tools/perf/util/bpf_lock_contention.c
index fc8666222399..76542b86e83f 100644
--- a/tools/perf/util/bpf_lock_contention.c
+++ b/tools/perf/util/bpf_lock_contention.c
@@ -131,10 +131,20 @@ int lock_contention_prepare(struct lock_contention *con)
 	else
 		bpf_map__set_max_entries(skel->maps.task_data, 1);
 
-	if (con->save_callstack)
+	if (con->save_callstack) {
 		bpf_map__set_max_entries(skel->maps.stacks, con->map_nr_entries);
-	else
+		if (con->owner) {
+			bpf_map__set_value_size(skel->maps.stack_buf, con->max_stack * sizeof(u64));
+			bpf_map__set_key_size(skel->maps.owner_stacks,
+						con->max_stack * sizeof(u64));
+			bpf_map__set_max_entries(skel->maps.owner_stacks, con->map_nr_entries);
+			bpf_map__set_max_entries(skel->maps.owner_data, con->map_nr_entries);
+			bpf_map__set_max_entries(skel->maps.owner_stat, con->map_nr_entries);
+			skel->rodata->max_stack = con->max_stack;
+		}
+	} else {
 		bpf_map__set_max_entries(skel->maps.stacks, 1);
+	}
 
 	if (target__has_cpu(target)) {
 		skel->rodata->has_cpu = 1;
diff --git a/tools/perf/util/bpf_skel/lock_contention.bpf.c b/tools/perf/util/bpf_skel/lock_contention.bpf.c
index 6533ea9b044c..23fe9cc980ae 100644
--- a/tools/perf/util/bpf_skel/lock_contention.bpf.c
+++ b/tools/perf/util/bpf_skel/lock_contention.bpf.c
@@ -27,6 +27,38 @@ struct {
 	__uint(max_entries, MAX_ENTRIES);
 } stacks SEC(".maps");
 
+/* buffer for owner stacktrace */
+struct {
+	__uint(type, BPF_MAP_TYPE_PERCPU_ARRAY);
+	__uint(key_size, sizeof(__u32));
+	__uint(value_size, sizeof(__u64));
+	__uint(max_entries, 1);
+} stack_buf SEC(".maps");
+
+/* a map for tracing owner stacktrace to owner stack id */
+struct {
+	__uint(type, BPF_MAP_TYPE_HASH);
+	__uint(key_size, sizeof(__u64)); // owner stacktrace
+	__uint(value_size, sizeof(__s32)); // owner stack id
+	__uint(max_entries, 1);
+} owner_stacks SEC(".maps");
+
+/* a map for tracing lock address to owner data */
+struct {
+	__uint(type, BPF_MAP_TYPE_HASH);
+	__uint(key_size, sizeof(__u64)); // lock address
+	__uint(value_size, sizeof(struct owner_tracing_data));
+	__uint(max_entries, 1);
+} owner_data SEC(".maps");
+
+/* a map for contention_key (stores owner stack id) to contention data */
+struct {
+	__uint(type, BPF_MAP_TYPE_HASH);
+	__uint(key_size, sizeof(struct contention_key));
+	__uint(value_size, sizeof(struct contention_data));
+	__uint(max_entries, 1);
+} owner_stat SEC(".maps");
+
 /* maintain timestamp at the beginning of contention */
 struct {
 	__uint(type, BPF_MAP_TYPE_HASH);
@@ -143,6 +175,7 @@ const volatile int needs_callstack;
 const volatile int stack_skip;
 const volatile int lock_owner;
 const volatile int use_cgroup_v2;
+const volatile int max_stack;
 
 /* determine the key of lock stat */
 const volatile int aggr_mode;
diff --git a/tools/perf/util/bpf_skel/lock_data.h b/tools/perf/util/bpf_skel/lock_data.h
index c15f734d7fc4..15f5743bd409 100644
--- a/tools/perf/util/bpf_skel/lock_data.h
+++ b/tools/perf/util/bpf_skel/lock_data.h
@@ -3,6 +3,13 @@
 #ifndef UTIL_BPF_SKEL_LOCK_DATA_H
 #define UTIL_BPF_SKEL_LOCK_DATA_H
 
+struct owner_tracing_data {
+	u32 pid; // Who has the lock.
+	u32 count; // How many waiters for this lock.
+	u64 timestamp; // The time while the owner acquires lock and contention is going on.
+	s32 stack_id; // Identifier for `owner_stat`, which stores as value in `owner_stacks`
+};
+
 struct tstamp_data {
 	u64 timestamp;
 	u64 lock;
-- 
2.48.1.658.g4767266eb4-goog


^ permalink raw reply related	[flat|nested] 9+ messages in thread

* [PATCH v7 2/4] perf lock: Retrieve owner callstack in bpf program
  2025-02-24 18:42 [PATCH v7 0/4] Tracing contention lock owner call stack Chun-Tse Shao
  2025-02-24 18:42 ` [PATCH v7 1/4] perf lock: Add bpf maps for owner stack tracing Chun-Tse Shao
@ 2025-02-24 18:42 ` Chun-Tse Shao
  2025-02-24 18:42 ` [PATCH v7 3/4] perf lock: Make rb_tree helper functions generic Chun-Tse Shao
  2025-02-24 18:42 ` [PATCH v7 4/4] perf lock: Report owner stack in usermode Chun-Tse Shao
  3 siblings, 0 replies; 9+ messages in thread
From: Chun-Tse Shao @ 2025-02-24 18:42 UTC (permalink / raw)
  To: linux-kernel
  Cc: Chun-Tse Shao, peterz, mingo, acme, namhyung, mark.rutland,
	alexander.shishkin, jolsa, irogers, adrian.hunter, kan.liang,
	nick.forrington, linux-perf-users, bpf

This implements per-callstack aggregation of lock owners in addition to
per-thread.  The owner callstack is captured using `bpf_get_task_stack()`
at `contention_begin()` and it also adds a custom stackid function for the
owner stacks to be compared easily.

The owner info is kept in a hash map using lock addr as a key to handle
multiple waiters for the same lock.  At `contention_end()`, it updates the
owner lock stat based on the info that was saved at `contention_begin()`.
If there are more waiters, it'd update the owner pid to itself as
`contention_end()` means it gets the lock now.  But it also needs to check
the return value of the lock function in case task was killed by a signal
or something.

Signed-off-by: Chun-Tse Shao <ctshao@google.com>
---
 .../perf/util/bpf_skel/lock_contention.bpf.c  | 212 +++++++++++++++++-
 1 file changed, 203 insertions(+), 9 deletions(-)

diff --git a/tools/perf/util/bpf_skel/lock_contention.bpf.c b/tools/perf/util/bpf_skel/lock_contention.bpf.c
index 23fe9cc980ae..69be7a4234e0 100644
--- a/tools/perf/util/bpf_skel/lock_contention.bpf.c
+++ b/tools/perf/util/bpf_skel/lock_contention.bpf.c
@@ -197,6 +197,9 @@ int data_fail;
 int task_map_full;
 int data_map_full;
 
+struct task_struct *bpf_task_from_pid(s32 pid) __ksym __weak;
+void bpf_task_release(struct task_struct *p) __ksym __weak;
+
 static inline __u64 get_current_cgroup_id(void)
 {
 	struct task_struct *task;
@@ -420,6 +423,61 @@ static inline struct tstamp_data *get_tstamp_elem(__u32 flags)
 	return pelem;
 }
 
+static inline s32 get_owner_stack_id(u64 *stacktrace)
+{
+	s32 *id, new_id;
+	static s64 id_gen = 1;
+
+	id = bpf_map_lookup_elem(&owner_stacks, stacktrace);
+	if (id)
+		return *id;
+
+	new_id = (s32)__sync_fetch_and_add(&id_gen, 1);
+
+	bpf_map_update_elem(&owner_stacks, stacktrace, &new_id, BPF_NOEXIST);
+
+	id = bpf_map_lookup_elem(&owner_stacks, stacktrace);
+	if (id)
+		return *id;
+
+	return -1;
+}
+
+static inline void update_contention_data(struct contention_data *data, u64 duration, u32 count)
+{
+	__sync_fetch_and_add(&data->total_time, duration);
+	__sync_fetch_and_add(&data->count, count);
+
+	/* FIXME: need atomic operations */
+	if (data->max_time < duration)
+		data->max_time = duration;
+	if (data->min_time > duration)
+		data->min_time = duration;
+}
+
+static inline void update_owner_stat(u32 id, u64 duration, u32 flags)
+{
+	struct contention_key key = {
+		.stack_id = id,
+		.pid = 0,
+		.lock_addr_or_cgroup = 0,
+	};
+	struct contention_data *data = bpf_map_lookup_elem(&owner_stat, &key);
+
+	if (!data) {
+		struct contention_data first = {
+			.total_time = duration,
+			.max_time = duration,
+			.min_time = duration,
+			.count = 1,
+			.flags = flags,
+		};
+		bpf_map_update_elem(&owner_stat, &key, &first, BPF_NOEXIST);
+	} else {
+		update_contention_data(data, duration, 1);
+	}
+}
+
 SEC("tp_btf/contention_begin")
 int contention_begin(u64 *ctx)
 {
@@ -437,6 +495,72 @@ int contention_begin(u64 *ctx)
 	pelem->flags = (__u32)ctx[1];
 
 	if (needs_callstack) {
+		u32 i = 0;
+		u32 id = 0;
+		int owner_pid;
+		u64 *buf;
+		struct task_struct *task;
+		struct owner_tracing_data *otdata;
+
+		if (!lock_owner)
+			goto skip_owner;
+
+		task = get_lock_owner(pelem->lock, pelem->flags);
+		if (!task)
+			goto skip_owner;
+
+		owner_pid = BPF_CORE_READ(task, pid);
+
+		buf = bpf_map_lookup_elem(&stack_buf, &i);
+		if (!buf)
+			goto skip_owner;
+		for (i = 0; i < max_stack; i++)
+			buf[i] = 0x0;
+
+		if (!bpf_task_from_pid)
+			goto skip_owner;
+
+		task = bpf_task_from_pid(owner_pid);
+		if (!task)
+			goto skip_owner;
+
+		bpf_get_task_stack(task, buf, max_stack * sizeof(unsigned long), 0);
+		bpf_task_release(task);
+
+		otdata = bpf_map_lookup_elem(&owner_data, &pelem->lock);
+		id = get_owner_stack_id(buf);
+
+		/*
+		 * Contention just happens, or corner case `lock` is owned by process not
+		 * `owner_pid`. For the corner case we treat it as unexpected internal error and
+		 * just ignore the precvious tracing record.
+		 */
+		if (!otdata || otdata->pid != owner_pid) {
+			struct owner_tracing_data first = {
+				.pid = owner_pid,
+				.timestamp = pelem->timestamp,
+				.count = 1,
+				.stack_id = id,
+			};
+			bpf_map_update_elem(&owner_data, &pelem->lock, &first, BPF_ANY);
+		}
+		/* Contention is ongoing and new waiter joins */
+		else {
+			__sync_fetch_and_add(&otdata->count, 1);
+
+			/*
+			 * The owner is the same, but stacktrace might be changed. In this case we
+			 * store/update `owner_stat` based on current owner stack id.
+			 */
+			if (id != otdata->stack_id) {
+				update_owner_stat(id, pelem->timestamp - otdata->timestamp,
+						  pelem->flags);
+
+				otdata->timestamp = pelem->timestamp;
+				otdata->stack_id = id;
+			}
+		}
+skip_owner:
 		pelem->stack_id = bpf_get_stackid(ctx, &stacks,
 						  BPF_F_FAST_STACK_CMP | stack_skip);
 		if (pelem->stack_id < 0)
@@ -473,6 +597,7 @@ int contention_end(u64 *ctx)
 	struct tstamp_data *pelem;
 	struct contention_key key = {};
 	struct contention_data *data;
+	__u64 timestamp;
 	__u64 duration;
 	bool need_delete = false;
 
@@ -500,12 +625,88 @@ int contention_end(u64 *ctx)
 		need_delete = true;
 	}
 
-	duration = bpf_ktime_get_ns() - pelem->timestamp;
+	timestamp = bpf_ktime_get_ns();
+	duration = timestamp - pelem->timestamp;
 	if ((__s64)duration < 0) {
 		__sync_fetch_and_add(&time_fail, 1);
 		goto out;
 	}
 
+	if (needs_callstack && lock_owner) {
+		struct owner_tracing_data *otdata = bpf_map_lookup_elem(&owner_data, &pelem->lock);
+
+		if (!otdata)
+			goto skip_owner;
+
+		/* Update `owner_stat` */
+		update_owner_stat(otdata->stack_id, timestamp - otdata->timestamp, pelem->flags);
+
+		/* No contention is occurring, delete `lock` entry in `owner_data` */
+		if (otdata->count <= 1)
+			bpf_map_delete_elem(&owner_data, &pelem->lock);
+		/*
+		 * Contention is still ongoing, with a new owner (current task). `owner_data`
+		 * should be updated accordingly.
+		 */
+		else {
+			u32 i = 0;
+			s32 ret = (s32)ctx[1];
+			u64 *buf;
+
+			otdata->timestamp = timestamp;
+			__sync_fetch_and_add(&otdata->count, -1);
+
+			buf = bpf_map_lookup_elem(&stack_buf, &i);
+			if (!buf)
+				goto skip_owner;
+			for (i = 0; i < (u32)max_stack; i++)
+				buf[i] = 0x0;
+
+			/*
+			 * `ret` has the return code of the lock function.
+			 * If `ret` is negative, the current task terminates lock waiting without
+			 * acquiring it. Owner is not changed, but we still need to update the owner
+			 * stack.
+			 */
+			if (ret < 0) {
+				s32 id = 0;
+				struct task_struct *task;
+
+				if (!bpf_task_from_pid)
+					goto skip_owner;
+
+				task = bpf_task_from_pid(otdata->pid);
+				if (!task)
+					goto skip_owner;
+
+				bpf_get_task_stack(task, buf,
+						   max_stack * sizeof(unsigned long), 0);
+				bpf_task_release(task);
+
+				id = get_owner_stack_id(buf);
+
+				/*
+				 * If owner stack is changed, update owner stack id for this lock.
+				 */
+				if (id != otdata->stack_id)
+					otdata->stack_id = id;
+			}
+			/*
+			 * Otherwise, update tracing data with the current task, which is the new
+			 * owner.
+			 */
+			else {
+				otdata->pid = pid;
+				/*
+				 * We don't want to retrieve callstack here, since it is where the
+				 * current task acquires the lock and provides no additional
+				 * information. We simply assign -1 to invalidate it.
+				 */
+				otdata->stack_id = -1;
+			}
+		}
+	}
+skip_owner:
 	switch (aggr_mode) {
 	case LOCK_AGGR_CALLER:
 		key.stack_id = pelem->stack_id;
@@ -589,14 +790,7 @@ int contention_end(u64 *ctx)
 	}
 
 found:
-	__sync_fetch_and_add(&data->total_time, duration);
-	__sync_fetch_and_add(&data->count, 1);
-
-	/* FIXME: need atomic operations */
-	if (data->max_time < duration)
-		data->max_time = duration;
-	if (data->min_time > duration)
-		data->min_time = duration;
+	update_contention_data(data, duration, 1);
 
 out:
 	pelem->lock = 0;
-- 
2.48.1.658.g4767266eb4-goog


^ permalink raw reply related	[flat|nested] 9+ messages in thread

* [PATCH v7 3/4] perf lock: Make rb_tree helper functions generic
  2025-02-24 18:42 [PATCH v7 0/4] Tracing contention lock owner call stack Chun-Tse Shao
  2025-02-24 18:42 ` [PATCH v7 1/4] perf lock: Add bpf maps for owner stack tracing Chun-Tse Shao
  2025-02-24 18:42 ` [PATCH v7 2/4] perf lock: Retrieve owner callstack in bpf program Chun-Tse Shao
@ 2025-02-24 18:42 ` Chun-Tse Shao
  2025-02-24 18:42 ` [PATCH v7 4/4] perf lock: Report owner stack in usermode Chun-Tse Shao
  3 siblings, 0 replies; 9+ messages in thread
From: Chun-Tse Shao @ 2025-02-24 18:42 UTC (permalink / raw)
  To: linux-kernel
  Cc: Chun-Tse Shao, peterz, mingo, acme, namhyung, mark.rutland,
	alexander.shishkin, jolsa, irogers, adrian.hunter, kan.liang,
	nick.forrington, linux-perf-users, bpf

The rb_tree helper functions can be reused for parsing `owner_lock_stat`
into rb tree for sorting.

Signed-off-by: Chun-Tse Shao <ctshao@google.com>
---
 tools/perf/builtin-lock.c | 34 +++++++++++++++++++++++-----------
 1 file changed, 23 insertions(+), 11 deletions(-)

diff --git a/tools/perf/builtin-lock.c b/tools/perf/builtin-lock.c
index 5d405cd8e696..9bebc186286f 100644
--- a/tools/perf/builtin-lock.c
+++ b/tools/perf/builtin-lock.c
@@ -418,16 +418,13 @@ static void combine_lock_stats(struct lock_stat *st)
 	rb_insert_color(&st->rb, &sorted);
 }
 
-static void insert_to_result(struct lock_stat *st,
-			     int (*bigger)(struct lock_stat *, struct lock_stat *))
+static void insert_to(struct rb_root *rr, struct lock_stat *st,
+		      int (*bigger)(struct lock_stat *, struct lock_stat *))
 {
-	struct rb_node **rb = &result.rb_node;
+	struct rb_node **rb = &rr->rb_node;
 	struct rb_node *parent = NULL;
 	struct lock_stat *p;
 
-	if (combine_locks && st->combined)
-		return;
-
 	while (*rb) {
 		p = container_of(*rb, struct lock_stat, rb);
 		parent = *rb;
@@ -439,13 +436,21 @@ static void insert_to_result(struct lock_stat *st,
 	}
 
 	rb_link_node(&st->rb, parent, rb);
-	rb_insert_color(&st->rb, &result);
+	rb_insert_color(&st->rb, rr);
 }
 
-/* returns left most element of result, and erase it */
-static struct lock_stat *pop_from_result(void)
+static inline void insert_to_result(struct lock_stat *st,
+				    int (*bigger)(struct lock_stat *,
+						  struct lock_stat *))
+{
+	if (combine_locks && st->combined)
+		return;
+	insert_to(&result, st, bigger);
+}
+
+static inline struct lock_stat *pop_from(struct rb_root *rr)
 {
-	struct rb_node *node = result.rb_node;
+	struct rb_node *node = rr->rb_node;
 
 	if (!node)
 		return NULL;
@@ -453,8 +458,15 @@ static struct lock_stat *pop_from_result(void)
 	while (node->rb_left)
 		node = node->rb_left;
 
-	rb_erase(node, &result);
+	rb_erase(node, rr);
 	return container_of(node, struct lock_stat, rb);
+
+}
+
+/* returns left most element of result, and erase it */
+static struct lock_stat *pop_from_result(void)
+{
+	return pop_from(&result);
 }
 
 struct trace_lock_handler {
-- 
2.48.1.658.g4767266eb4-goog


^ permalink raw reply related	[flat|nested] 9+ messages in thread

* [PATCH v7 4/4] perf lock: Report owner stack in usermode
  2025-02-24 18:42 [PATCH v7 0/4] Tracing contention lock owner call stack Chun-Tse Shao
                   ` (2 preceding siblings ...)
  2025-02-24 18:42 ` [PATCH v7 3/4] perf lock: Make rb_tree helper functions generic Chun-Tse Shao
@ 2025-02-24 18:42 ` Chun-Tse Shao
  2025-02-26  9:57   ` Athira Rajeev
  3 siblings, 1 reply; 9+ messages in thread
From: Chun-Tse Shao @ 2025-02-24 18:42 UTC (permalink / raw)
  To: linux-kernel
  Cc: Chun-Tse Shao, peterz, mingo, acme, namhyung, mark.rutland,
	alexander.shishkin, jolsa, irogers, adrian.hunter, kan.liang,
	nick.forrington, linux-perf-users, bpf

This patch parses `owner_lock_stat` into a RB tree, enabling ordered
reporting of owner lock statistics with stack traces. It also updates
the documentation for the `-o` option in contention mode, decouples `-o`
from `-t`, and issues a warning to inform users about the new behavior
of `-ov`.

Example output:
  $ sudo ~/linux/tools/perf/perf lock con -abvo -Y mutex-spin -E3 perf bench sched pipe
  ...
   contended   total wait     max wait     avg wait         type   caller

         171      1.55 ms     20.26 us      9.06 us        mutex   pipe_read+0x57
                          0xffffffffac6318e7  pipe_read+0x57
                          0xffffffffac623862  vfs_read+0x332
                          0xffffffffac62434b  ksys_read+0xbb
                          0xfffffffface604b2  do_syscall_64+0x82
                          0xffffffffad00012f  entry_SYSCALL_64_after_hwframe+0x76
          36    193.71 us     15.27 us      5.38 us        mutex   pipe_write+0x50
                          0xffffffffac631ee0  pipe_write+0x50
                          0xffffffffac6241db  vfs_write+0x3bb
                          0xffffffffac6244ab  ksys_write+0xbb
                          0xfffffffface604b2  do_syscall_64+0x82
                          0xffffffffad00012f  entry_SYSCALL_64_after_hwframe+0x76
           4     51.22 us     16.47 us     12.80 us        mutex   do_epoll_wait+0x24d
                          0xffffffffac691f0d  do_epoll_wait+0x24d
                          0xffffffffac69249b  do_epoll_pwait.part.0+0xb
                          0xffffffffac693ba5  __x64_sys_epoll_pwait+0x95
                          0xfffffffface604b2  do_syscall_64+0x82
                          0xffffffffad00012f  entry_SYSCALL_64_after_hwframe+0x76

  === owner stack trace ===

           3     31.24 us     15.27 us     10.41 us        mutex   pipe_read+0x348
                          0xffffffffac631bd8  pipe_read+0x348
                          0xffffffffac623862  vfs_read+0x332
                          0xffffffffac62434b  ksys_read+0xbb
                          0xfffffffface604b2  do_syscall_64+0x82
                          0xffffffffad00012f  entry_SYSCALL_64_after_hwframe+0x76
  ...

Signed-off-by: Chun-Tse Shao <ctshao@google.com>
---
 tools/perf/Documentation/perf-lock.txt |  5 ++-
 tools/perf/builtin-lock.c              | 22 +++++++++-
 tools/perf/util/bpf_lock_contention.c  | 57 ++++++++++++++++++++++++++
 tools/perf/util/lock-contention.h      |  7 ++++
 4 files changed, 87 insertions(+), 4 deletions(-)

diff --git a/tools/perf/Documentation/perf-lock.txt b/tools/perf/Documentation/perf-lock.txt
index d3793054f7d3..859dc11a7372 100644
--- a/tools/perf/Documentation/perf-lock.txt
+++ b/tools/perf/Documentation/perf-lock.txt
@@ -179,8 +179,9 @@ CONTENTION OPTIONS
 
 -o::
 --lock-owner::
-	Show lock contention stat by owners.  Implies --threads and
-	requires --use-bpf.
+	Show lock contention stat by owners. This option can be combined with -t,
+	which shows owner's per thread lock stats, or -v, which shows owner's
+	stacktrace. Requires --use-bpf.
 
 -Y::
 --type-filter=<value>::
diff --git a/tools/perf/builtin-lock.c b/tools/perf/builtin-lock.c
index 9bebc186286f..05e7bc30488a 100644
--- a/tools/perf/builtin-lock.c
+++ b/tools/perf/builtin-lock.c
@@ -1817,6 +1817,22 @@ static void print_contention_result(struct lock_contention *con)
 			break;
 	}
 
+	if (con->owner && con->save_callstack && verbose > 0) {
+		struct rb_root root = RB_ROOT;
+
+		if (symbol_conf.field_sep)
+			fprintf(lock_output, "# owner stack trace:\n");
+		else
+			fprintf(lock_output, "\n=== owner stack trace ===\n\n");
+		while ((st = pop_owner_stack_trace(con)))
+			insert_to(&root, st, compare);
+
+		while ((st = pop_from(&root))) {
+			print_lock_stat(con, st);
+			free(st);
+		}
+	}
+
 	if (print_nr_entries) {
 		/* update the total/bad stats */
 		while ((st = pop_from_result())) {
@@ -1962,8 +1978,10 @@ static int check_lock_contention_options(const struct option *options,
 		}
 	}
 
-	if (show_lock_owner)
-		show_thread_stats = true;
+	if (show_lock_owner && !show_thread_stats) {
+		pr_warning("Now -o try to show owner's callstack instead of pid and comm.\n");
+		pr_warning("Please use -t option too to keep the old behavior.\n");
+	}
 
 	return 0;
 }
diff --git a/tools/perf/util/bpf_lock_contention.c b/tools/perf/util/bpf_lock_contention.c
index 76542b86e83f..16f4deba69ec 100644
--- a/tools/perf/util/bpf_lock_contention.c
+++ b/tools/perf/util/bpf_lock_contention.c
@@ -549,6 +549,63 @@ static const char *lock_contention_get_name(struct lock_contention *con,
 	return name_buf;
 }
 
+struct lock_stat *pop_owner_stack_trace(struct lock_contention *con)
+{
+	int stacks_fd, stat_fd;
+	u64 *stack_trace = NULL;
+	s32 stack_id;
+	struct contention_key ckey = {};
+	struct contention_data cdata = {};
+	size_t stack_size = con->max_stack * sizeof(*stack_trace);
+	struct lock_stat *st = NULL;
+
+	stacks_fd = bpf_map__fd(skel->maps.owner_stacks);
+	stat_fd = bpf_map__fd(skel->maps.owner_stat);
+	if (!stacks_fd || !stat_fd)
+		goto out_err;
+
+	stack_trace = zalloc(stack_size);
+	if (stack_trace == NULL)
+		goto out_err;
+
+	if (bpf_map_get_next_key(stacks_fd, NULL, stack_trace))
+		goto out_err;
+
+	bpf_map_lookup_elem(stacks_fd, stack_trace, &stack_id);
+	ckey.stack_id = stack_id;
+	bpf_map_lookup_elem(stat_fd, &ckey, &cdata);
+
+	st = zalloc(sizeof(struct lock_stat));
+	if (!st)
+		goto out_err;
+
+	st->name = strdup(stack_trace[0] ? lock_contention_get_name(con, NULL, stack_trace, 0) :
+					   "unknown");
+	if (!st->name)
+		goto out_err;
+
+	st->flags = cdata.flags;
+	st->nr_contended = cdata.count;
+	st->wait_time_total = cdata.total_time;
+	st->wait_time_max = cdata.max_time;
+	st->wait_time_min = cdata.min_time;
+	st->callstack = stack_trace;
+
+	if (cdata.count)
+		st->avg_wait_time = cdata.total_time / cdata.count;
+
+	bpf_map_delete_elem(stacks_fd, stack_trace);
+	bpf_map_delete_elem(stat_fd, &ckey);
+
+	return st;
+
+out_err:
+	free(stack_trace);
+	free(st);
+
+	return NULL;
+}
+
 int lock_contention_read(struct lock_contention *con)
 {
 	int fd, stack, err = 0;
diff --git a/tools/perf/util/lock-contention.h b/tools/perf/util/lock-contention.h
index a09f7fe877df..97fd33c57f17 100644
--- a/tools/perf/util/lock-contention.h
+++ b/tools/perf/util/lock-contention.h
@@ -168,6 +168,8 @@ int lock_contention_stop(void);
 int lock_contention_read(struct lock_contention *con);
 int lock_contention_finish(struct lock_contention *con);
 
+struct lock_stat *pop_owner_stack_trace(struct lock_contention *con);
+
 #else  /* !HAVE_BPF_SKEL */
 
 static inline int lock_contention_prepare(struct lock_contention *con __maybe_unused)
@@ -187,6 +189,11 @@ static inline int lock_contention_read(struct lock_contention *con __maybe_unuse
 	return 0;
 }
 
+struct lock_stat *pop_owner_stack_trace(struct lock_contention *con)
+{
+	return NULL;
+}
+
 #endif  /* HAVE_BPF_SKEL */
 
 #endif  /* PERF_LOCK_CONTENTION_H */
-- 
2.48.1.658.g4767266eb4-goog


^ permalink raw reply related	[flat|nested] 9+ messages in thread

* Re: [PATCH v7 4/4] perf lock: Report owner stack in usermode
  2025-02-24 18:42 ` [PATCH v7 4/4] perf lock: Report owner stack in usermode Chun-Tse Shao
@ 2025-02-26  9:57   ` Athira Rajeev
  2025-02-26 17:42     ` Namhyung Kim
  0 siblings, 1 reply; 9+ messages in thread
From: Athira Rajeev @ 2025-02-26  9:57 UTC (permalink / raw)
  To: Chun-Tse Shao, Namhyung Kim
  Cc: open list:PERFORMANCE EVENTS SUBSYSTEM, Peter Zijlstra,
	Ingo Molnar, Arnaldo Carvalho de Melo, Mark Rutland,
	Alexander Shishkin, Jiri Olsa, Ian Rogers, Adrian Hunter,
	Kan Liang, nick.forrington,
	open list:PERFORMANCE EVENTS SUBSYSTEM, bpf



> On 25 Feb 2025, at 12:12 AM, Chun-Tse Shao <ctshao@google.com> wrote:
> 
> This patch parses `owner_lock_stat` into a RB tree, enabling ordered
> reporting of owner lock statistics with stack traces. It also updates
> the documentation for the `-o` option in contention mode, decouples `-o`
> from `-t`, and issues a warning to inform users about the new behavior
> of `-ov`.
> 
> Example output:
>  $ sudo ~/linux/tools/perf/perf lock con -abvo -Y mutex-spin -E3 perf bench sched pipe
>  ...
>   contended   total wait     max wait     avg wait         type   caller
> 
>         171      1.55 ms     20.26 us      9.06 us        mutex   pipe_read+0x57
>                          0xffffffffac6318e7  pipe_read+0x57
>                          0xffffffffac623862  vfs_read+0x332
>                          0xffffffffac62434b  ksys_read+0xbb
>                          0xfffffffface604b2  do_syscall_64+0x82
>                          0xffffffffad00012f  entry_SYSCALL_64_after_hwframe+0x76
>          36    193.71 us     15.27 us      5.38 us        mutex   pipe_write+0x50
>                          0xffffffffac631ee0  pipe_write+0x50
>                          0xffffffffac6241db  vfs_write+0x3bb
>                          0xffffffffac6244ab  ksys_write+0xbb
>                          0xfffffffface604b2  do_syscall_64+0x82
>                          0xffffffffad00012f  entry_SYSCALL_64_after_hwframe+0x76
>           4     51.22 us     16.47 us     12.80 us        mutex   do_epoll_wait+0x24d
>                          0xffffffffac691f0d  do_epoll_wait+0x24d
>                          0xffffffffac69249b  do_epoll_pwait.part.0+0xb
>                          0xffffffffac693ba5  __x64_sys_epoll_pwait+0x95
>                          0xfffffffface604b2  do_syscall_64+0x82
>                          0xffffffffad00012f  entry_SYSCALL_64_after_hwframe+0x76
> 
>  === owner stack trace ===
> 
>           3     31.24 us     15.27 us     10.41 us        mutex   pipe_read+0x348
>                          0xffffffffac631bd8  pipe_read+0x348
>                          0xffffffffac623862  vfs_read+0x332
>                          0xffffffffac62434b  ksys_read+0xbb
>                          0xfffffffface604b2  do_syscall_64+0x82
>                          0xffffffffad00012f  entry_SYSCALL_64_after_hwframe+0x76
>  ...
> 
> Signed-off-by: Chun-Tse Shao <ctshao@google.com>
> ---
> tools/perf/Documentation/perf-lock.txt |  5 ++-
> tools/perf/builtin-lock.c              | 22 +++++++++-
> tools/perf/util/bpf_lock_contention.c  | 57 ++++++++++++++++++++++++++
> tools/perf/util/lock-contention.h      |  7 ++++
> 4 files changed, 87 insertions(+), 4 deletions(-)
> 
> diff --git a/tools/perf/Documentation/perf-lock.txt b/tools/perf/Documentation/perf-lock.txt
> index d3793054f7d3..859dc11a7372 100644
> --- a/tools/perf/Documentation/perf-lock.txt
> +++ b/tools/perf/Documentation/perf-lock.txt
> @@ -179,8 +179,9 @@ CONTENTION OPTIONS
> 
> -o::
> --lock-owner::
> - Show lock contention stat by owners.  Implies --threads and
> - requires --use-bpf.
> + Show lock contention stat by owners. This option can be combined with -t,
> + which shows owner's per thread lock stats, or -v, which shows owner's
> + stacktrace. Requires --use-bpf.
> 
> -Y::
> --type-filter=<value>::
> diff --git a/tools/perf/builtin-lock.c b/tools/perf/builtin-lock.c
> index 9bebc186286f..05e7bc30488a 100644
> --- a/tools/perf/builtin-lock.c
> +++ b/tools/perf/builtin-lock.c
> @@ -1817,6 +1817,22 @@ static void print_contention_result(struct lock_contention *con)
> break;
> }
> 
> + if (con->owner && con->save_callstack && verbose > 0) {
> + struct rb_root root = RB_ROOT;
> +
> + if (symbol_conf.field_sep)
> + fprintf(lock_output, "# owner stack trace:\n");
> + else
> + fprintf(lock_output, "\n=== owner stack trace ===\n\n");
> + while ((st = pop_owner_stack_trace(con)))
> + insert_to(&root, st, compare);
> +
> + while ((st = pop_from(&root))) {
> + print_lock_stat(con, st);
> + free(st);
> + }
> + }
> +
> if (print_nr_entries) {
> /* update the total/bad stats */
> while ((st = pop_from_result())) {
> @@ -1962,8 +1978,10 @@ static int check_lock_contention_options(const struct option *options,
> }
> }
> 
> - if (show_lock_owner)
> - show_thread_stats = true;
> + if (show_lock_owner && !show_thread_stats) {
> + pr_warning("Now -o try to show owner's callstack instead of pid and comm.\n");
> + pr_warning("Please use -t option too to keep the old behavior.\n");
> + }
> 
> return 0;
> }
> diff --git a/tools/perf/util/bpf_lock_contention.c b/tools/perf/util/bpf_lock_contention.c
> index 76542b86e83f..16f4deba69ec 100644
> --- a/tools/perf/util/bpf_lock_contention.c
> +++ b/tools/perf/util/bpf_lock_contention.c
> @@ -549,6 +549,63 @@ static const char *lock_contention_get_name(struct lock_contention *con,
> return name_buf;
> }
> 
> +struct lock_stat *pop_owner_stack_trace(struct lock_contention *con)
> +{
> + int stacks_fd, stat_fd;
> + u64 *stack_trace = NULL;
> + s32 stack_id;
> + struct contention_key ckey = {};
> + struct contention_data cdata = {};
> + size_t stack_size = con->max_stack * sizeof(*stack_trace);
> + struct lock_stat *st = NULL;
> +
> + stacks_fd = bpf_map__fd(skel->maps.owner_stacks);
> + stat_fd = bpf_map__fd(skel->maps.owner_stat);
> + if (!stacks_fd || !stat_fd)
> + goto out_err;
> +
> + stack_trace = zalloc(stack_size);
> + if (stack_trace == NULL)
> + goto out_err;
> +
> + if (bpf_map_get_next_key(stacks_fd, NULL, stack_trace))
> + goto out_err;
> +
> + bpf_map_lookup_elem(stacks_fd, stack_trace, &stack_id);
> + ckey.stack_id = stack_id;
> + bpf_map_lookup_elem(stat_fd, &ckey, &cdata);
> +
> + st = zalloc(sizeof(struct lock_stat));
> + if (!st)
> + goto out_err;
> +
> + st->name = strdup(stack_trace[0] ? lock_contention_get_name(con, NULL, stack_trace, 0) :
> +   "unknown");

Hi,

I am hitting a compilation issue with this change. Sorry for responding late. I tried with change from tmp.perf-tools-next and hit below issue:


  CC      util/bpf_lock_contention.o
util/bpf_lock_contention.c: In function ‘lock_contention_get_name’:
cc1: error: function may return address of local variable [-Werror=return-local-addr]
util/bpf_lock_contention.c:470:45: note: declared here
  470 |                 struct contention_task_data task;
      |                                             ^~~~
cc1: all warnings being treated as errors
make[4]: *** [/root/perf-tools-next/tools/build/Makefile.build:85: util/bpf_lock_contention.o] Error 1
make[4]: *** Waiting for unfinished jobs....
  LD      perf-in.o
make[3]: *** [/root/perf-tools-next/tools/build/Makefile.build:138: util] Error 2
make[2]: *** [Makefile.perf:822: perf-util-in.o] Error 2
make[1]: *** [Makefile.perf:321: sub-make] Error 2
make: *** [Makefile:76: all] Error 2


Code snippet:

if (con->aggr_mode == LOCK_AGGR_TASK) {
                struct contention_task_data task;
                int pid = key->pid;
                int task_fd = bpf_map__fd(skel->maps.task_data);

                /* do not update idle comm which contains CPU number */
                if (pid) {
                        struct thread *t = machine__findnew_thread(machine, /*pid=*/-1, pid);

                        if (t == NULL)
                                return name;
                        if (!bpf_map_lookup_elem(task_fd, &pid, &task) &&
                            thread__set_comm(t, task.comm, /*timestamp=*/0))
                                name = task.comm;
                }
                return name;
        }


We are calling lock_contention_get_name with second argument as NULL .
Though error above points to “contention_task_data”, I think the local variable here is for “name” ?


Thanks
Athira

> + if (!st->name)
> + goto out_err;
> +
> + st->flags = cdata.flags;
> + st->nr_contended = cdata.count;
> + st->wait_time_total = cdata.total_time;
> + st->wait_time_max = cdata.max_time;
> + st->wait_time_min = cdata.min_time;
> + st->callstack = stack_trace;
> +
> + if (cdata.count)
> + st->avg_wait_time = cdata.total_time / cdata.count;
> +
> + bpf_map_delete_elem(stacks_fd, stack_trace);
> + bpf_map_delete_elem(stat_fd, &ckey);
> +
> + return st;
> +
> +out_err:
> + free(stack_trace);
> + free(st);
> +
> + return NULL;
> +}
> +
> int lock_contention_read(struct lock_contention *con)
> {
> int fd, stack, err = 0;
> diff --git a/tools/perf/util/lock-contention.h b/tools/perf/util/lock-contention.h
> index a09f7fe877df..97fd33c57f17 100644
> --- a/tools/perf/util/lock-contention.h
> +++ b/tools/perf/util/lock-contention.h
> @@ -168,6 +168,8 @@ int lock_contention_stop(void);
> int lock_contention_read(struct lock_contention *con);
> int lock_contention_finish(struct lock_contention *con);
> 
> +struct lock_stat *pop_owner_stack_trace(struct lock_contention *con);
> +
> #else  /* !HAVE_BPF_SKEL */
> 
> static inline int lock_contention_prepare(struct lock_contention *con __maybe_unused)
> @@ -187,6 +189,11 @@ static inline int lock_contention_read(struct lock_contention *con __maybe_unuse
> return 0;
> }
> 
> +struct lock_stat *pop_owner_stack_trace(struct lock_contention *con)
> +{
> + return NULL;
> +}
> +
> #endif  /* HAVE_BPF_SKEL */
> 
> #endif  /* PERF_LOCK_CONTENTION_H */
> -- 
> 2.48.1.658.g4767266eb4-goog
> 
> 


^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: [PATCH v7 4/4] perf lock: Report owner stack in usermode
  2025-02-26  9:57   ` Athira Rajeev
@ 2025-02-26 17:42     ` Namhyung Kim
  2025-02-27  0:35       ` Chun-Tse Shao
  0 siblings, 1 reply; 9+ messages in thread
From: Namhyung Kim @ 2025-02-26 17:42 UTC (permalink / raw)
  To: Athira Rajeev
  Cc: Chun-Tse Shao, open list:PERFORMANCE EVENTS SUBSYSTEM,
	Peter Zijlstra, Ingo Molnar, Arnaldo Carvalho de Melo,
	Mark Rutland, Alexander Shishkin, Jiri Olsa, Ian Rogers,
	Adrian Hunter, Kan Liang, nick.forrington,
	open list:PERFORMANCE EVENTS SUBSYSTEM, bpf

Hello,

On Wed, Feb 26, 2025 at 03:27:41PM +0530, Athira Rajeev wrote:
> 
> 
> > On 25 Feb 2025, at 12:12 AM, Chun-Tse Shao <ctshao@google.com> wrote:
> > 
> > This patch parses `owner_lock_stat` into a RB tree, enabling ordered
> > reporting of owner lock statistics with stack traces. It also updates
> > the documentation for the `-o` option in contention mode, decouples `-o`
> > from `-t`, and issues a warning to inform users about the new behavior
> > of `-ov`.
> > 
> > Example output:
> >  $ sudo ~/linux/tools/perf/perf lock con -abvo -Y mutex-spin -E3 perf bench sched pipe
> >  ...
> >   contended   total wait     max wait     avg wait         type   caller
> > 
> >         171      1.55 ms     20.26 us      9.06 us        mutex   pipe_read+0x57
> >                          0xffffffffac6318e7  pipe_read+0x57
> >                          0xffffffffac623862  vfs_read+0x332
> >                          0xffffffffac62434b  ksys_read+0xbb
> >                          0xfffffffface604b2  do_syscall_64+0x82
> >                          0xffffffffad00012f  entry_SYSCALL_64_after_hwframe+0x76
> >          36    193.71 us     15.27 us      5.38 us        mutex   pipe_write+0x50
> >                          0xffffffffac631ee0  pipe_write+0x50
> >                          0xffffffffac6241db  vfs_write+0x3bb
> >                          0xffffffffac6244ab  ksys_write+0xbb
> >                          0xfffffffface604b2  do_syscall_64+0x82
> >                          0xffffffffad00012f  entry_SYSCALL_64_after_hwframe+0x76
> >           4     51.22 us     16.47 us     12.80 us        mutex   do_epoll_wait+0x24d
> >                          0xffffffffac691f0d  do_epoll_wait+0x24d
> >                          0xffffffffac69249b  do_epoll_pwait.part.0+0xb
> >                          0xffffffffac693ba5  __x64_sys_epoll_pwait+0x95
> >                          0xfffffffface604b2  do_syscall_64+0x82
> >                          0xffffffffad00012f  entry_SYSCALL_64_after_hwframe+0x76
> > 
> >  === owner stack trace ===
> > 
> >           3     31.24 us     15.27 us     10.41 us        mutex   pipe_read+0x348
> >                          0xffffffffac631bd8  pipe_read+0x348
> >                          0xffffffffac623862  vfs_read+0x332
> >                          0xffffffffac62434b  ksys_read+0xbb
> >                          0xfffffffface604b2  do_syscall_64+0x82
> >                          0xffffffffad00012f  entry_SYSCALL_64_after_hwframe+0x76
> >  ...
> > 
> > Signed-off-by: Chun-Tse Shao <ctshao@google.com>
> > ---
> > tools/perf/Documentation/perf-lock.txt |  5 ++-
> > tools/perf/builtin-lock.c              | 22 +++++++++-
> > tools/perf/util/bpf_lock_contention.c  | 57 ++++++++++++++++++++++++++
> > tools/perf/util/lock-contention.h      |  7 ++++
> > 4 files changed, 87 insertions(+), 4 deletions(-)
> > 
> > diff --git a/tools/perf/Documentation/perf-lock.txt b/tools/perf/Documentation/perf-lock.txt
> > index d3793054f7d3..859dc11a7372 100644
> > --- a/tools/perf/Documentation/perf-lock.txt
> > +++ b/tools/perf/Documentation/perf-lock.txt
> > @@ -179,8 +179,9 @@ CONTENTION OPTIONS
> > 
> > -o::
> > --lock-owner::
> > - Show lock contention stat by owners.  Implies --threads and
> > - requires --use-bpf.
> > + Show lock contention stat by owners. This option can be combined with -t,
> > + which shows owner's per thread lock stats, or -v, which shows owner's
> > + stacktrace. Requires --use-bpf.
> > 
> > -Y::
> > --type-filter=<value>::
> > diff --git a/tools/perf/builtin-lock.c b/tools/perf/builtin-lock.c
> > index 9bebc186286f..05e7bc30488a 100644
> > --- a/tools/perf/builtin-lock.c
> > +++ b/tools/perf/builtin-lock.c
> > @@ -1817,6 +1817,22 @@ static void print_contention_result(struct lock_contention *con)
> > break;
> > }
> > 
> > + if (con->owner && con->save_callstack && verbose > 0) {
> > + struct rb_root root = RB_ROOT;
> > +
> > + if (symbol_conf.field_sep)
> > + fprintf(lock_output, "# owner stack trace:\n");
> > + else
> > + fprintf(lock_output, "\n=== owner stack trace ===\n\n");
> > + while ((st = pop_owner_stack_trace(con)))
> > + insert_to(&root, st, compare);
> > +
> > + while ((st = pop_from(&root))) {
> > + print_lock_stat(con, st);
> > + free(st);
> > + }
> > + }
> > +
> > if (print_nr_entries) {
> > /* update the total/bad stats */
> > while ((st = pop_from_result())) {
> > @@ -1962,8 +1978,10 @@ static int check_lock_contention_options(const struct option *options,
> > }
> > }
> > 
> > - if (show_lock_owner)
> > - show_thread_stats = true;
> > + if (show_lock_owner && !show_thread_stats) {
> > + pr_warning("Now -o try to show owner's callstack instead of pid and comm.\n");
> > + pr_warning("Please use -t option too to keep the old behavior.\n");
> > + }
> > 
> > return 0;
> > }
> > diff --git a/tools/perf/util/bpf_lock_contention.c b/tools/perf/util/bpf_lock_contention.c
> > index 76542b86e83f..16f4deba69ec 100644
> > --- a/tools/perf/util/bpf_lock_contention.c
> > +++ b/tools/perf/util/bpf_lock_contention.c
> > @@ -549,6 +549,63 @@ static const char *lock_contention_get_name(struct lock_contention *con,
> > return name_buf;
> > }
> > 
> > +struct lock_stat *pop_owner_stack_trace(struct lock_contention *con)
> > +{
> > + int stacks_fd, stat_fd;
> > + u64 *stack_trace = NULL;
> > + s32 stack_id;
> > + struct contention_key ckey = {};
> > + struct contention_data cdata = {};
> > + size_t stack_size = con->max_stack * sizeof(*stack_trace);
> > + struct lock_stat *st = NULL;
> > +
> > + stacks_fd = bpf_map__fd(skel->maps.owner_stacks);
> > + stat_fd = bpf_map__fd(skel->maps.owner_stat);
> > + if (!stacks_fd || !stat_fd)
> > + goto out_err;
> > +
> > + stack_trace = zalloc(stack_size);
> > + if (stack_trace == NULL)
> > + goto out_err;
> > +
> > + if (bpf_map_get_next_key(stacks_fd, NULL, stack_trace))
> > + goto out_err;
> > +
> > + bpf_map_lookup_elem(stacks_fd, stack_trace, &stack_id);
> > + ckey.stack_id = stack_id;
> > + bpf_map_lookup_elem(stat_fd, &ckey, &cdata);
> > +
> > + st = zalloc(sizeof(struct lock_stat));
> > + if (!st)
> > + goto out_err;
> > +
> > + st->name = strdup(stack_trace[0] ? lock_contention_get_name(con, NULL, stack_trace, 0) :
> > +   "unknown");
> 
> Hi,
> 
> I am hitting a compilation issue with this change. Sorry for responding late. I tried with change from tmp.perf-tools-next and hit below issue:
> 
> 
>   CC      util/bpf_lock_contention.o
> util/bpf_lock_contention.c: In function ‘lock_contention_get_name’:
> cc1: error: function may return address of local variable [-Werror=return-local-addr]
> util/bpf_lock_contention.c:470:45: note: declared here
>   470 |                 struct contention_task_data task;
>       |                                             ^~~~
> cc1: all warnings being treated as errors
> make[4]: *** [/root/perf-tools-next/tools/build/Makefile.build:85: util/bpf_lock_contention.o] Error 1
> make[4]: *** Waiting for unfinished jobs....
>   LD      perf-in.o
> make[3]: *** [/root/perf-tools-next/tools/build/Makefile.build:138: util] Error 2
> make[2]: *** [Makefile.perf:822: perf-util-in.o] Error 2
> make[1]: *** [Makefile.perf:321: sub-make] Error 2
> make: *** [Makefile:76: all] Error 2

Thanks for the report.  I've noticed that and also found this error:

  In file included from util/lock-contention.c:4:0:                               
  util/lock-contention.h:192:19: error: no previous prototype for 'pop_owner_stack_trace' [-Werror=missing-prototypes]
   struct lock_stat *pop_owner_stack_trace(struct lock_contention *con)           
                     ^~~~~~~~~~~~~~~~~~~~~                                        
  util/lock-contention.h: In function 'pop_owner_stack_trace':                    
  util/lock-contention.h:192:65: error: unused parameter 'con' [-Werror=unused-parameter]
   struct lock_stat *pop_owner_stack_trace(struct lock_contention *con)           
                                                                   ^~~

Removed this series from tmp.perf-tools-next.

Thanks,
Namhyung

> 
> 
> Code snippet:
> 
> if (con->aggr_mode == LOCK_AGGR_TASK) {
>                 struct contention_task_data task;
>                 int pid = key->pid;
>                 int task_fd = bpf_map__fd(skel->maps.task_data);
> 
>                 /* do not update idle comm which contains CPU number */
>                 if (pid) {
>                         struct thread *t = machine__findnew_thread(machine, /*pid=*/-1, pid);
> 
>                         if (t == NULL)
>                                 return name;
>                         if (!bpf_map_lookup_elem(task_fd, &pid, &task) &&
>                             thread__set_comm(t, task.comm, /*timestamp=*/0))
>                                 name = task.comm;
>                 }
>                 return name;
>         }
> 
> 
> We are calling lock_contention_get_name with second argument as NULL .
> Though error above points to “contention_task_data”, I think the local variable here is for “name” ?
> 
> 
> Thanks
> Athira
> 
> > + if (!st->name)
> > + goto out_err;
> > +
> > + st->flags = cdata.flags;
> > + st->nr_contended = cdata.count;
> > + st->wait_time_total = cdata.total_time;
> > + st->wait_time_max = cdata.max_time;
> > + st->wait_time_min = cdata.min_time;
> > + st->callstack = stack_trace;
> > +
> > + if (cdata.count)
> > + st->avg_wait_time = cdata.total_time / cdata.count;
> > +
> > + bpf_map_delete_elem(stacks_fd, stack_trace);
> > + bpf_map_delete_elem(stat_fd, &ckey);
> > +
> > + return st;
> > +
> > +out_err:
> > + free(stack_trace);
> > + free(st);
> > +
> > + return NULL;
> > +}
> > +
> > int lock_contention_read(struct lock_contention *con)
> > {
> > int fd, stack, err = 0;
> > diff --git a/tools/perf/util/lock-contention.h b/tools/perf/util/lock-contention.h
> > index a09f7fe877df..97fd33c57f17 100644
> > --- a/tools/perf/util/lock-contention.h
> > +++ b/tools/perf/util/lock-contention.h
> > @@ -168,6 +168,8 @@ int lock_contention_stop(void);
> > int lock_contention_read(struct lock_contention *con);
> > int lock_contention_finish(struct lock_contention *con);
> > 
> > +struct lock_stat *pop_owner_stack_trace(struct lock_contention *con);
> > +
> > #else  /* !HAVE_BPF_SKEL */
> > 
> > static inline int lock_contention_prepare(struct lock_contention *con __maybe_unused)
> > @@ -187,6 +189,11 @@ static inline int lock_contention_read(struct lock_contention *con __maybe_unuse
> > return 0;
> > }
> > 
> > +struct lock_stat *pop_owner_stack_trace(struct lock_contention *con)
> > +{
> > + return NULL;
> > +}
> > +
> > #endif  /* HAVE_BPF_SKEL */
> > 
> > #endif  /* PERF_LOCK_CONTENTION_H */
> > -- 
> > 2.48.1.658.g4767266eb4-goog
> > 
> > 
> 

^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: [PATCH v7 4/4] perf lock: Report owner stack in usermode
  2025-02-26 17:42     ` Namhyung Kim
@ 2025-02-27  0:35       ` Chun-Tse Shao
  2025-02-27  7:05         ` Athira Rajeev
  0 siblings, 1 reply; 9+ messages in thread
From: Chun-Tse Shao @ 2025-02-27  0:35 UTC (permalink / raw)
  To: Namhyung Kim, Athira Rajeev
  Cc: open list:PERFORMANCE EVENTS SUBSYSTEM, Peter Zijlstra,
	Ingo Molnar, Arnaldo Carvalho de Melo, Mark Rutland,
	Alexander Shishkin, Jiri Olsa, Ian Rogers, Adrian Hunter,
	Kan Liang, nick.forrington,
	open list:PERFORMANCE EVENTS SUBSYSTEM, bpf

Hi Namhyung and Athira, thanks for your investigation! I fixed them
and submitted v8:
https://lore.kernel.org/20250227003359.732948-1-ctshao@google.com/

For `lock_contention_get_name `, I am not sure why the error is
revealed by me since I did not touch that part of code. Anyway I also
included the fix in my patchset.

Thank you,
CT



On Wed, Feb 26, 2025 at 9:42 AM Namhyung Kim <namhyung@kernel.org> wrote:
>
> Hello,
>
> On Wed, Feb 26, 2025 at 03:27:41PM +0530, Athira Rajeev wrote:
> >
> >
> > > On 25 Feb 2025, at 12:12 AM, Chun-Tse Shao <ctshao@google.com> wrote:
> > >
> > > This patch parses `owner_lock_stat` into a RB tree, enabling ordered
> > > reporting of owner lock statistics with stack traces. It also updates
> > > the documentation for the `-o` option in contention mode, decouples `-o`
> > > from `-t`, and issues a warning to inform users about the new behavior
> > > of `-ov`.
> > >
> > > Example output:
> > >  $ sudo ~/linux/tools/perf/perf lock con -abvo -Y mutex-spin -E3 perf bench sched pipe
> > >  ...
> > >   contended   total wait     max wait     avg wait         type   caller
> > >
> > >         171      1.55 ms     20.26 us      9.06 us        mutex   pipe_read+0x57
> > >                          0xffffffffac6318e7  pipe_read+0x57
> > >                          0xffffffffac623862  vfs_read+0x332
> > >                          0xffffffffac62434b  ksys_read+0xbb
> > >                          0xfffffffface604b2  do_syscall_64+0x82
> > >                          0xffffffffad00012f  entry_SYSCALL_64_after_hwframe+0x76
> > >          36    193.71 us     15.27 us      5.38 us        mutex   pipe_write+0x50
> > >                          0xffffffffac631ee0  pipe_write+0x50
> > >                          0xffffffffac6241db  vfs_write+0x3bb
> > >                          0xffffffffac6244ab  ksys_write+0xbb
> > >                          0xfffffffface604b2  do_syscall_64+0x82
> > >                          0xffffffffad00012f  entry_SYSCALL_64_after_hwframe+0x76
> > >           4     51.22 us     16.47 us     12.80 us        mutex   do_epoll_wait+0x24d
> > >                          0xffffffffac691f0d  do_epoll_wait+0x24d
> > >                          0xffffffffac69249b  do_epoll_pwait.part.0+0xb
> > >                          0xffffffffac693ba5  __x64_sys_epoll_pwait+0x95
> > >                          0xfffffffface604b2  do_syscall_64+0x82
> > >                          0xffffffffad00012f  entry_SYSCALL_64_after_hwframe+0x76
> > >
> > >  === owner stack trace ===
> > >
> > >           3     31.24 us     15.27 us     10.41 us        mutex   pipe_read+0x348
> > >                          0xffffffffac631bd8  pipe_read+0x348
> > >                          0xffffffffac623862  vfs_read+0x332
> > >                          0xffffffffac62434b  ksys_read+0xbb
> > >                          0xfffffffface604b2  do_syscall_64+0x82
> > >                          0xffffffffad00012f  entry_SYSCALL_64_after_hwframe+0x76
> > >  ...
> > >
> > > Signed-off-by: Chun-Tse Shao <ctshao@google.com>
> > > ---
> > > tools/perf/Documentation/perf-lock.txt |  5 ++-
> > > tools/perf/builtin-lock.c              | 22 +++++++++-
> > > tools/perf/util/bpf_lock_contention.c  | 57 ++++++++++++++++++++++++++
> > > tools/perf/util/lock-contention.h      |  7 ++++
> > > 4 files changed, 87 insertions(+), 4 deletions(-)
> > >
> > > diff --git a/tools/perf/Documentation/perf-lock.txt b/tools/perf/Documentation/perf-lock.txt
> > > index d3793054f7d3..859dc11a7372 100644
> > > --- a/tools/perf/Documentation/perf-lock.txt
> > > +++ b/tools/perf/Documentation/perf-lock.txt
> > > @@ -179,8 +179,9 @@ CONTENTION OPTIONS
> > >
> > > -o::
> > > --lock-owner::
> > > - Show lock contention stat by owners.  Implies --threads and
> > > - requires --use-bpf.
> > > + Show lock contention stat by owners. This option can be combined with -t,
> > > + which shows owner's per thread lock stats, or -v, which shows owner's
> > > + stacktrace. Requires --use-bpf.
> > >
> > > -Y::
> > > --type-filter=<value>::
> > > diff --git a/tools/perf/builtin-lock.c b/tools/perf/builtin-lock.c
> > > index 9bebc186286f..05e7bc30488a 100644
> > > --- a/tools/perf/builtin-lock.c
> > > +++ b/tools/perf/builtin-lock.c
> > > @@ -1817,6 +1817,22 @@ static void print_contention_result(struct lock_contention *con)
> > > break;
> > > }
> > >
> > > + if (con->owner && con->save_callstack && verbose > 0) {
> > > + struct rb_root root = RB_ROOT;
> > > +
> > > + if (symbol_conf.field_sep)
> > > + fprintf(lock_output, "# owner stack trace:\n");
> > > + else
> > > + fprintf(lock_output, "\n=== owner stack trace ===\n\n");
> > > + while ((st = pop_owner_stack_trace(con)))
> > > + insert_to(&root, st, compare);
> > > +
> > > + while ((st = pop_from(&root))) {
> > > + print_lock_stat(con, st);
> > > + free(st);
> > > + }
> > > + }
> > > +
> > > if (print_nr_entries) {
> > > /* update the total/bad stats */
> > > while ((st = pop_from_result())) {
> > > @@ -1962,8 +1978,10 @@ static int check_lock_contention_options(const struct option *options,
> > > }
> > > }
> > >
> > > - if (show_lock_owner)
> > > - show_thread_stats = true;
> > > + if (show_lock_owner && !show_thread_stats) {
> > > + pr_warning("Now -o try to show owner's callstack instead of pid and comm.\n");
> > > + pr_warning("Please use -t option too to keep the old behavior.\n");
> > > + }
> > >
> > > return 0;
> > > }
> > > diff --git a/tools/perf/util/bpf_lock_contention.c b/tools/perf/util/bpf_lock_contention.c
> > > index 76542b86e83f..16f4deba69ec 100644
> > > --- a/tools/perf/util/bpf_lock_contention.c
> > > +++ b/tools/perf/util/bpf_lock_contention.c
> > > @@ -549,6 +549,63 @@ static const char *lock_contention_get_name(struct lock_contention *con,
> > > return name_buf;
> > > }
> > >
> > > +struct lock_stat *pop_owner_stack_trace(struct lock_contention *con)
> > > +{
> > > + int stacks_fd, stat_fd;
> > > + u64 *stack_trace = NULL;
> > > + s32 stack_id;
> > > + struct contention_key ckey = {};
> > > + struct contention_data cdata = {};
> > > + size_t stack_size = con->max_stack * sizeof(*stack_trace);
> > > + struct lock_stat *st = NULL;
> > > +
> > > + stacks_fd = bpf_map__fd(skel->maps.owner_stacks);
> > > + stat_fd = bpf_map__fd(skel->maps.owner_stat);
> > > + if (!stacks_fd || !stat_fd)
> > > + goto out_err;
> > > +
> > > + stack_trace = zalloc(stack_size);
> > > + if (stack_trace == NULL)
> > > + goto out_err;
> > > +
> > > + if (bpf_map_get_next_key(stacks_fd, NULL, stack_trace))
> > > + goto out_err;
> > > +
> > > + bpf_map_lookup_elem(stacks_fd, stack_trace, &stack_id);
> > > + ckey.stack_id = stack_id;
> > > + bpf_map_lookup_elem(stat_fd, &ckey, &cdata);
> > > +
> > > + st = zalloc(sizeof(struct lock_stat));
> > > + if (!st)
> > > + goto out_err;
> > > +
> > > + st->name = strdup(stack_trace[0] ? lock_contention_get_name(con, NULL, stack_trace, 0) :
> > > +   "unknown");
> >
> > Hi,
> >
> > I am hitting a compilation issue with this change. Sorry for responding late. I tried with change from tmp.perf-tools-next and hit below issue:
> >
> >
> >   CC      util/bpf_lock_contention.o
> > util/bpf_lock_contention.c: In function ‘lock_contention_get_name’:
> > cc1: error: function may return address of local variable [-Werror=return-local-addr]
> > util/bpf_lock_contention.c:470:45: note: declared here
> >   470 |                 struct contention_task_data task;
> >       |                                             ^~~~
> > cc1: all warnings being treated as errors
> > make[4]: *** [/root/perf-tools-next/tools/build/Makefile.build:85: util/bpf_lock_contention.o] Error 1
> > make[4]: *** Waiting for unfinished jobs....
> >   LD      perf-in.o
> > make[3]: *** [/root/perf-tools-next/tools/build/Makefile.build:138: util] Error 2
> > make[2]: *** [Makefile.perf:822: perf-util-in.o] Error 2
> > make[1]: *** [Makefile.perf:321: sub-make] Error 2
> > make: *** [Makefile:76: all] Error 2
>
> Thanks for the report.  I've noticed that and also found this error:
>
>   In file included from util/lock-contention.c:4:0:
>   util/lock-contention.h:192:19: error: no previous prototype for 'pop_owner_stack_trace' [-Werror=missing-prototypes]
>    struct lock_stat *pop_owner_stack_trace(struct lock_contention *con)
>                      ^~~~~~~~~~~~~~~~~~~~~
>   util/lock-contention.h: In function 'pop_owner_stack_trace':
>   util/lock-contention.h:192:65: error: unused parameter 'con' [-Werror=unused-parameter]
>    struct lock_stat *pop_owner_stack_trace(struct lock_contention *con)
>                                                                    ^~~
>
> Removed this series from tmp.perf-tools-next.
>
> Thanks,
> Namhyung
>
> >
> >
> > Code snippet:
> >
> > if (con->aggr_mode == LOCK_AGGR_TASK) {
> >                 struct contention_task_data task;
> >                 int pid = key->pid;
> >                 int task_fd = bpf_map__fd(skel->maps.task_data);
> >
> >                 /* do not update idle comm which contains CPU number */
> >                 if (pid) {
> >                         struct thread *t = machine__findnew_thread(machine, /*pid=*/-1, pid);
> >
> >                         if (t == NULL)
> >                                 return name;
> >                         if (!bpf_map_lookup_elem(task_fd, &pid, &task) &&
> >                             thread__set_comm(t, task.comm, /*timestamp=*/0))
> >                                 name = task.comm;
> >                 }
> >                 return name;
> >         }
> >
> >
> > We are calling lock_contention_get_name with second argument as NULL .
> > Though error above points to “contention_task_data”, I think the local variable here is for “name” ?
> >
> >
> > Thanks
> > Athira
> >
> > > + if (!st->name)
> > > + goto out_err;
> > > +
> > > + st->flags = cdata.flags;
> > > + st->nr_contended = cdata.count;
> > > + st->wait_time_total = cdata.total_time;
> > > + st->wait_time_max = cdata.max_time;
> > > + st->wait_time_min = cdata.min_time;
> > > + st->callstack = stack_trace;
> > > +
> > > + if (cdata.count)
> > > + st->avg_wait_time = cdata.total_time / cdata.count;
> > > +
> > > + bpf_map_delete_elem(stacks_fd, stack_trace);
> > > + bpf_map_delete_elem(stat_fd, &ckey);
> > > +
> > > + return st;
> > > +
> > > +out_err:
> > > + free(stack_trace);
> > > + free(st);
> > > +
> > > + return NULL;
> > > +}
> > > +
> > > int lock_contention_read(struct lock_contention *con)
> > > {
> > > int fd, stack, err = 0;
> > > diff --git a/tools/perf/util/lock-contention.h b/tools/perf/util/lock-contention.h
> > > index a09f7fe877df..97fd33c57f17 100644
> > > --- a/tools/perf/util/lock-contention.h
> > > +++ b/tools/perf/util/lock-contention.h
> > > @@ -168,6 +168,8 @@ int lock_contention_stop(void);
> > > int lock_contention_read(struct lock_contention *con);
> > > int lock_contention_finish(struct lock_contention *con);
> > >
> > > +struct lock_stat *pop_owner_stack_trace(struct lock_contention *con);
> > > +
> > > #else  /* !HAVE_BPF_SKEL */
> > >
> > > static inline int lock_contention_prepare(struct lock_contention *con __maybe_unused)
> > > @@ -187,6 +189,11 @@ static inline int lock_contention_read(struct lock_contention *con __maybe_unuse
> > > return 0;
> > > }
> > >
> > > +struct lock_stat *pop_owner_stack_trace(struct lock_contention *con)
> > > +{
> > > + return NULL;
> > > +}
> > > +
> > > #endif  /* HAVE_BPF_SKEL */
> > >
> > > #endif  /* PERF_LOCK_CONTENTION_H */
> > > --
> > > 2.48.1.658.g4767266eb4-goog
> > >
> > >
> >

^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: [PATCH v7 4/4] perf lock: Report owner stack in usermode
  2025-02-27  0:35       ` Chun-Tse Shao
@ 2025-02-27  7:05         ` Athira Rajeev
  0 siblings, 0 replies; 9+ messages in thread
From: Athira Rajeev @ 2025-02-27  7:05 UTC (permalink / raw)
  To: Chun-Tse Shao
  Cc: Namhyung Kim, open list:PERFORMANCE EVENTS SUBSYSTEM,
	Peter Zijlstra, Ingo Molnar, Arnaldo Carvalho de Melo,
	Mark Rutland, Alexander Shishkin, Jiri Olsa, Ian Rogers,
	Adrian Hunter, Kan Liang, nick.forrington,
	open list:PERFORMANCE EVENTS SUBSYSTEM, bpf



> On 27 Feb 2025, at 6:05 AM, Chun-Tse Shao <ctshao@google.com> wrote:
> 
> Hi Namhyung and Athira, thanks for your investigation! I fixed them
> and submitted v8:
> https://lore.kernel.org/20250227003359.732948-1-ctshao@google.com/
> 
> For `lock_contention_get_name `, I am not sure why the error is
> revealed by me since I did not touch that part of code. Anyway I also
> included the fix in my patchset.
> 
> Thank you,
> CT
Hi Chun-Tse,

Sure, I will compile test with the version 8 and respond to the v8 mail thread.

Thanks
Athira
> 
> 
> 
> On Wed, Feb 26, 2025 at 9:42 AM Namhyung Kim <namhyung@kernel.org> wrote:
>> 
>> Hello,
>> 
>> On Wed, Feb 26, 2025 at 03:27:41PM +0530, Athira Rajeev wrote:
>>> 
>>> 
>>>> On 25 Feb 2025, at 12:12 AM, Chun-Tse Shao <ctshao@google.com> wrote:
>>>> 
>>>> This patch parses `owner_lock_stat` into a RB tree, enabling ordered
>>>> reporting of owner lock statistics with stack traces. It also updates
>>>> the documentation for the `-o` option in contention mode, decouples `-o`
>>>> from `-t`, and issues a warning to inform users about the new behavior
>>>> of `-ov`.
>>>> 
>>>> Example output:
>>>> $ sudo ~/linux/tools/perf/perf lock con -abvo -Y mutex-spin -E3 perf bench sched pipe
>>>> ...
>>>>  contended   total wait     max wait     avg wait         type   caller
>>>> 
>>>>        171      1.55 ms     20.26 us      9.06 us        mutex   pipe_read+0x57
>>>>                         0xffffffffac6318e7  pipe_read+0x57
>>>>                         0xffffffffac623862  vfs_read+0x332
>>>>                         0xffffffffac62434b  ksys_read+0xbb
>>>>                         0xfffffffface604b2  do_syscall_64+0x82
>>>>                         0xffffffffad00012f  entry_SYSCALL_64_after_hwframe+0x76
>>>>         36    193.71 us     15.27 us      5.38 us        mutex   pipe_write+0x50
>>>>                         0xffffffffac631ee0  pipe_write+0x50
>>>>                         0xffffffffac6241db  vfs_write+0x3bb
>>>>                         0xffffffffac6244ab  ksys_write+0xbb
>>>>                         0xfffffffface604b2  do_syscall_64+0x82
>>>>                         0xffffffffad00012f  entry_SYSCALL_64_after_hwframe+0x76
>>>>          4     51.22 us     16.47 us     12.80 us        mutex   do_epoll_wait+0x24d
>>>>                         0xffffffffac691f0d  do_epoll_wait+0x24d
>>>>                         0xffffffffac69249b  do_epoll_pwait.part.0+0xb
>>>>                         0xffffffffac693ba5  __x64_sys_epoll_pwait+0x95
>>>>                         0xfffffffface604b2  do_syscall_64+0x82
>>>>                         0xffffffffad00012f  entry_SYSCALL_64_after_hwframe+0x76
>>>> 
>>>> === owner stack trace ===
>>>> 
>>>>          3     31.24 us     15.27 us     10.41 us        mutex   pipe_read+0x348
>>>>                         0xffffffffac631bd8  pipe_read+0x348
>>>>                         0xffffffffac623862  vfs_read+0x332
>>>>                         0xffffffffac62434b  ksys_read+0xbb
>>>>                         0xfffffffface604b2  do_syscall_64+0x82
>>>>                         0xffffffffad00012f  entry_SYSCALL_64_after_hwframe+0x76
>>>> ...
>>>> 
>>>> Signed-off-by: Chun-Tse Shao <ctshao@google.com>
>>>> ---
>>>> tools/perf/Documentation/perf-lock.txt |  5 ++-
>>>> tools/perf/builtin-lock.c              | 22 +++++++++-
>>>> tools/perf/util/bpf_lock_contention.c  | 57 ++++++++++++++++++++++++++
>>>> tools/perf/util/lock-contention.h      |  7 ++++
>>>> 4 files changed, 87 insertions(+), 4 deletions(-)
>>>> 
>>>> diff --git a/tools/perf/Documentation/perf-lock.txt b/tools/perf/Documentation/perf-lock.txt
>>>> index d3793054f7d3..859dc11a7372 100644
>>>> --- a/tools/perf/Documentation/perf-lock.txt
>>>> +++ b/tools/perf/Documentation/perf-lock.txt
>>>> @@ -179,8 +179,9 @@ CONTENTION OPTIONS
>>>> 
>>>> -o::
>>>> --lock-owner::
>>>> - Show lock contention stat by owners.  Implies --threads and
>>>> - requires --use-bpf.
>>>> + Show lock contention stat by owners. This option can be combined with -t,
>>>> + which shows owner's per thread lock stats, or -v, which shows owner's
>>>> + stacktrace. Requires --use-bpf.
>>>> 
>>>> -Y::
>>>> --type-filter=<value>::
>>>> diff --git a/tools/perf/builtin-lock.c b/tools/perf/builtin-lock.c
>>>> index 9bebc186286f..05e7bc30488a 100644
>>>> --- a/tools/perf/builtin-lock.c
>>>> +++ b/tools/perf/builtin-lock.c
>>>> @@ -1817,6 +1817,22 @@ static void print_contention_result(struct lock_contention *con)
>>>> break;
>>>> }
>>>> 
>>>> + if (con->owner && con->save_callstack && verbose > 0) {
>>>> + struct rb_root root = RB_ROOT;
>>>> +
>>>> + if (symbol_conf.field_sep)
>>>> + fprintf(lock_output, "# owner stack trace:\n");
>>>> + else
>>>> + fprintf(lock_output, "\n=== owner stack trace ===\n\n");
>>>> + while ((st = pop_owner_stack_trace(con)))
>>>> + insert_to(&root, st, compare);
>>>> +
>>>> + while ((st = pop_from(&root))) {
>>>> + print_lock_stat(con, st);
>>>> + free(st);
>>>> + }
>>>> + }
>>>> +
>>>> if (print_nr_entries) {
>>>> /* update the total/bad stats */
>>>> while ((st = pop_from_result())) {
>>>> @@ -1962,8 +1978,10 @@ static int check_lock_contention_options(const struct option *options,
>>>> }
>>>> }
>>>> 
>>>> - if (show_lock_owner)
>>>> - show_thread_stats = true;
>>>> + if (show_lock_owner && !show_thread_stats) {
>>>> + pr_warning("Now -o try to show owner's callstack instead of pid and comm.\n");
>>>> + pr_warning("Please use -t option too to keep the old behavior.\n");
>>>> + }
>>>> 
>>>> return 0;
>>>> }
>>>> diff --git a/tools/perf/util/bpf_lock_contention.c b/tools/perf/util/bpf_lock_contention.c
>>>> index 76542b86e83f..16f4deba69ec 100644
>>>> --- a/tools/perf/util/bpf_lock_contention.c
>>>> +++ b/tools/perf/util/bpf_lock_contention.c
>>>> @@ -549,6 +549,63 @@ static const char *lock_contention_get_name(struct lock_contention *con,
>>>> return name_buf;
>>>> }
>>>> 
>>>> +struct lock_stat *pop_owner_stack_trace(struct lock_contention *con)
>>>> +{
>>>> + int stacks_fd, stat_fd;
>>>> + u64 *stack_trace = NULL;
>>>> + s32 stack_id;
>>>> + struct contention_key ckey = {};
>>>> + struct contention_data cdata = {};
>>>> + size_t stack_size = con->max_stack * sizeof(*stack_trace);
>>>> + struct lock_stat *st = NULL;
>>>> +
>>>> + stacks_fd = bpf_map__fd(skel->maps.owner_stacks);
>>>> + stat_fd = bpf_map__fd(skel->maps.owner_stat);
>>>> + if (!stacks_fd || !stat_fd)
>>>> + goto out_err;
>>>> +
>>>> + stack_trace = zalloc(stack_size);
>>>> + if (stack_trace == NULL)
>>>> + goto out_err;
>>>> +
>>>> + if (bpf_map_get_next_key(stacks_fd, NULL, stack_trace))
>>>> + goto out_err;
>>>> +
>>>> + bpf_map_lookup_elem(stacks_fd, stack_trace, &stack_id);
>>>> + ckey.stack_id = stack_id;
>>>> + bpf_map_lookup_elem(stat_fd, &ckey, &cdata);
>>>> +
>>>> + st = zalloc(sizeof(struct lock_stat));
>>>> + if (!st)
>>>> + goto out_err;
>>>> +
>>>> + st->name = strdup(stack_trace[0] ? lock_contention_get_name(con, NULL, stack_trace, 0) :
>>>> +   "unknown");
>>> 
>>> Hi,
>>> 
>>> I am hitting a compilation issue with this change. Sorry for responding late. I tried with change from tmp.perf-tools-next and hit below issue:
>>> 
>>> 
>>>  CC      util/bpf_lock_contention.o
>>> util/bpf_lock_contention.c: In function ‘lock_contention_get_name’:
>>> cc1: error: function may return address of local variable [-Werror=return-local-addr]
>>> util/bpf_lock_contention.c:470:45: note: declared here
>>>  470 |                 struct contention_task_data task;
>>>      |                                             ^~~~
>>> cc1: all warnings being treated as errors
>>> make[4]: *** [/root/perf-tools-next/tools/build/Makefile.build:85: util/bpf_lock_contention.o] Error 1
>>> make[4]: *** Waiting for unfinished jobs....
>>>  LD      perf-in.o
>>> make[3]: *** [/root/perf-tools-next/tools/build/Makefile.build:138: util] Error 2
>>> make[2]: *** [Makefile.perf:822: perf-util-in.o] Error 2
>>> make[1]: *** [Makefile.perf:321: sub-make] Error 2
>>> make: *** [Makefile:76: all] Error 2
>> 
>> Thanks for the report.  I've noticed that and also found this error:
>> 
>>  In file included from util/lock-contention.c:4:0:
>>  util/lock-contention.h:192:19: error: no previous prototype for 'pop_owner_stack_trace' [-Werror=missing-prototypes]
>>   struct lock_stat *pop_owner_stack_trace(struct lock_contention *con)
>>                     ^~~~~~~~~~~~~~~~~~~~~
>>  util/lock-contention.h: In function 'pop_owner_stack_trace':
>>  util/lock-contention.h:192:65: error: unused parameter 'con' [-Werror=unused-parameter]
>>   struct lock_stat *pop_owner_stack_trace(struct lock_contention *con)
>>                                                                   ^~~
>> 
>> Removed this series from tmp.perf-tools-next.
>> 
>> Thanks,
>> Namhyung
>> 
>>> 
>>> 
>>> Code snippet:
>>> 
>>> if (con->aggr_mode == LOCK_AGGR_TASK) {
>>>                struct contention_task_data task;
>>>                int pid = key->pid;
>>>                int task_fd = bpf_map__fd(skel->maps.task_data);
>>> 
>>>                /* do not update idle comm which contains CPU number */
>>>                if (pid) {
>>>                        struct thread *t = machine__findnew_thread(machine, /*pid=*/-1, pid);
>>> 
>>>                        if (t == NULL)
>>>                                return name;
>>>                        if (!bpf_map_lookup_elem(task_fd, &pid, &task) &&
>>>                            thread__set_comm(t, task.comm, /*timestamp=*/0))
>>>                                name = task.comm;
>>>                }
>>>                return name;
>>>        }
>>> 
>>> 
>>> We are calling lock_contention_get_name with second argument as NULL .
>>> Though error above points to “contention_task_data”, I think the local variable here is for “name” ?
>>> 
>>> 
>>> Thanks
>>> Athira
>>> 
>>>> + if (!st->name)
>>>> + goto out_err;
>>>> +
>>>> + st->flags = cdata.flags;
>>>> + st->nr_contended = cdata.count;
>>>> + st->wait_time_total = cdata.total_time;
>>>> + st->wait_time_max = cdata.max_time;
>>>> + st->wait_time_min = cdata.min_time;
>>>> + st->callstack = stack_trace;
>>>> +
>>>> + if (cdata.count)
>>>> + st->avg_wait_time = cdata.total_time / cdata.count;
>>>> +
>>>> + bpf_map_delete_elem(stacks_fd, stack_trace);
>>>> + bpf_map_delete_elem(stat_fd, &ckey);
>>>> +
>>>> + return st;
>>>> +
>>>> +out_err:
>>>> + free(stack_trace);
>>>> + free(st);
>>>> +
>>>> + return NULL;
>>>> +}
>>>> +
>>>> int lock_contention_read(struct lock_contention *con)
>>>> {
>>>> int fd, stack, err = 0;
>>>> diff --git a/tools/perf/util/lock-contention.h b/tools/perf/util/lock-contention.h
>>>> index a09f7fe877df..97fd33c57f17 100644
>>>> --- a/tools/perf/util/lock-contention.h
>>>> +++ b/tools/perf/util/lock-contention.h
>>>> @@ -168,6 +168,8 @@ int lock_contention_stop(void);
>>>> int lock_contention_read(struct lock_contention *con);
>>>> int lock_contention_finish(struct lock_contention *con);
>>>> 
>>>> +struct lock_stat *pop_owner_stack_trace(struct lock_contention *con);
>>>> +
>>>> #else  /* !HAVE_BPF_SKEL */
>>>> 
>>>> static inline int lock_contention_prepare(struct lock_contention *con __maybe_unused)
>>>> @@ -187,6 +189,11 @@ static inline int lock_contention_read(struct lock_contention *con __maybe_unuse
>>>> return 0;
>>>> }
>>>> 
>>>> +struct lock_stat *pop_owner_stack_trace(struct lock_contention *con)
>>>> +{
>>>> + return NULL;
>>>> +}
>>>> +
>>>> #endif  /* HAVE_BPF_SKEL */
>>>> 
>>>> #endif  /* PERF_LOCK_CONTENTION_H */
>>>> --
>>>> 2.48.1.658.g4767266eb4-goog
>>>> 
>>>> 
>>> 


^ permalink raw reply	[flat|nested] 9+ messages in thread

end of thread, other threads:[~2025-02-27  7:05 UTC | newest]

Thread overview: 9+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-02-24 18:42 [PATCH v7 0/4] Tracing contention lock owner call stack Chun-Tse Shao
2025-02-24 18:42 ` [PATCH v7 1/4] perf lock: Add bpf maps for owner stack tracing Chun-Tse Shao
2025-02-24 18:42 ` [PATCH v7 2/4] perf lock: Retrieve owner callstack in bpf program Chun-Tse Shao
2025-02-24 18:42 ` [PATCH v7 3/4] perf lock: Make rb_tree helper functions generic Chun-Tse Shao
2025-02-24 18:42 ` [PATCH v7 4/4] perf lock: Report owner stack in usermode Chun-Tse Shao
2025-02-26  9:57   ` Athira Rajeev
2025-02-26 17:42     ` Namhyung Kim
2025-02-27  0:35       ` Chun-Tse Shao
2025-02-27  7:05         ` Athira Rajeev

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).