From patchwork Tue Jun 25 15:17:02 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Masami Hiramatsu \(Google\)" X-Patchwork-Id: 807368 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 0ACAE16F84A; Tue, 25 Jun 2024 15:17:06 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1719328626; cv=none; b=exFvamuE1ip3sezdjEpVLW1Q7rOYWaVC/qH54sXuUFOlAEodJkY5ISgLc2/jSSBjWoh2I/f4txJArVNihUX0S5C+ec8abvHQ+6Pls/R8aiv0UJjAMVqgetBNAf0K+/VrOWYo1v+TkQW9/aQR+9K5hLFgXhwWK9T38l2i5Y7Fia8= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1719328626; c=relaxed/simple; bh=j1DC0UzZ/dBT38wuUOOkztsH6kOaU8110vpQM+Q1e3g=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version:Content-Type; b=CqY603wNo/L7/5kzhk6shs6Jx/3AbRFm5n9mmGVOyNPKMrqOndBZsWBWPJKwDdh7RhhGc/8qx454AEdJzSV8qjGWSgHlua80AJBbKj92dJRwFw7aFDn7jyPuS2r++hg93sItYsd0QkKorC5A/SIdNra168Yw40ExFl/36gaPpgs= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=AVHMDpP7; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="AVHMDpP7" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 12425C32781; Tue, 25 Jun 2024 15:17:03 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1719328625; bh=j1DC0UzZ/dBT38wuUOOkztsH6kOaU8110vpQM+Q1e3g=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=AVHMDpP7Fd1U/bjneisG+SLteaZbHHEPi7RKLMTtgZ4qVD0mN/KPbAfXGUwCQEhBs 0MmUpSUg9tyiw4R46uv4aPAQn97mCGoZzUOt1KBPbaMsK6EAdXAB8DQZbmuLsD/glk jL2VuNqaSfOt7wiQJdCoEgmOb0lvB5DvfuV8IEylVDURRBIBVIjmrIrjQwgVhPouZi jOnJ2u2iTf2S+gZyyM/vSRmCDn9kYr0YqYtZhTCvQXglFu4gRBNHryEBArmHm2J/Fb Z3MzTPIKVK6LL2vOvBI4vJrCONNZLrSsHGBX0S2aAFPwlt61ZXRDctfNmcMZKJvFkJ neZXEaBcCOrzA== From: "Masami Hiramatsu (Google)" To: Steven Rostedt , Shuah Khan Cc: Masami Hiramatsu , Tom Zanussi , Mathieu Desnoyers , linux-kernel@vger.kernel.org, linux-trace-kernel@vger.kernel.org, linux-kselftest@vger.kernel.org Subject: [RFC PATCH 1/3] tracing/hist: Add poll(POLLIN) support on hist file Date: Wed, 26 Jun 2024 00:17:02 +0900 Message-Id: <171932862193.584123.6290391535804128870.stgit@devnote2> X-Mailer: git-send-email 2.34.1 In-Reply-To: <171932861260.584123.15653284949837094747.stgit@devnote2> References: <171932861260.584123.15653284949837094747.stgit@devnote2> User-Agent: StGit/0.19 Precedence: bulk X-Mailing-List: linux-kselftest@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 From: Masami Hiramatsu (Google) Add poll syscall support on the `hist` file. The Waiter will be waken up when the histogram is updated with POLLIN. Currently, there is no way to wait for a specific event in userspace. So user needs to peek the `trace` periodicaly, or wait on `trace_pipe`. But that is not good idea to peek the `trace` for the event randomely happens. And `trace_pipe` is not coming back until a page is filled with events. This allows user to wait for a specific events on `hist` file. User can set a histogram trigger on the event which they want to monitor. And poll() on its `hist` file. Since this poll() returns POLLIN, the next poll() will return soon unless you do read() on hist file. NOTE: To read the hist file again, you must set the file offset to 0, but just for monitoring the event, you may not need to read the histogram. Signed-off-by: Masami Hiramatsu (Google) --- include/linux/trace_events.h | 5 +++ kernel/trace/trace_events.c | 18 +++++++++ kernel/trace/trace_events_hist.c | 76 +++++++++++++++++++++++++++++++++++++- 3 files changed, 96 insertions(+), 3 deletions(-) diff --git a/include/linux/trace_events.h b/include/linux/trace_events.h index 9df3e2973626..0d496e2d1064 100644 --- a/include/linux/trace_events.h +++ b/include/linux/trace_events.h @@ -663,6 +663,11 @@ struct trace_event_file { struct trace_subsystem_dir *system; struct list_head triggers; +#ifdef CONFIG_HIST_TRIGGERS + struct irq_work hist_work; + wait_queue_head_t hist_wq; +#endif + /* * 32 bit flags: * bit 0: enabled diff --git a/kernel/trace/trace_events.c b/kernel/trace/trace_events.c index 6ef29eba90ce..07ce5b024dd9 100644 --- a/kernel/trace/trace_events.c +++ b/kernel/trace/trace_events.c @@ -2965,6 +2965,20 @@ static bool event_in_systems(struct trace_event_call *call, return !*p || isspace(*p) || *p == ','; } +#ifdef CONFIG_HIST_TRIGGERS +/* + * Wake up waiter on the hist_wq from irq_work because the hist trigger + * may happen in any context. + */ +static void hist_event_irq_work(struct irq_work *work) +{ + struct trace_event_file *event_file; + + event_file = container_of(work, struct trace_event_file, hist_work); + wake_up_all(&event_file->hist_wq); +} +#endif + static struct trace_event_file * trace_create_new_event(struct trace_event_call *call, struct trace_array *tr) @@ -2996,6 +3010,10 @@ trace_create_new_event(struct trace_event_call *call, atomic_set(&file->tm_ref, 0); INIT_LIST_HEAD(&file->triggers); list_add(&file->list, &tr->events); +#ifdef CONFIG_HIST_TRIGGERS + init_irq_work(&file->hist_work, hist_event_irq_work); + init_waitqueue_head(&file->hist_wq); +#endif event_file_get(file); return file; diff --git a/kernel/trace/trace_events_hist.c b/kernel/trace/trace_events_hist.c index 6ece1308d36a..136d91139949 100644 --- a/kernel/trace/trace_events_hist.c +++ b/kernel/trace/trace_events_hist.c @@ -5314,6 +5314,9 @@ static void event_hist_trigger(struct event_trigger_data *data, if (resolve_var_refs(hist_data, key, var_ref_vals, true)) hist_trigger_actions(hist_data, elt, buffer, rec, rbe, key, var_ref_vals); + + if (hist_data->event_file && wq_has_sleeper(&hist_data->event_file->hist_wq)) + irq_work_queue(&hist_data->event_file->hist_work); } static void hist_trigger_stacktrace_print(struct seq_file *m, @@ -5593,15 +5596,36 @@ static void hist_trigger_show(struct seq_file *m, n_entries, (u64)atomic64_read(&hist_data->map->drops)); } +struct hist_file_data { + struct file *file; + u64 last_read; +}; + +static u64 get_hist_hit_count(struct trace_event_file *event_file) +{ + struct hist_trigger_data *hist_data; + struct event_trigger_data *data; + u64 ret = 0; + + list_for_each_entry(data, &event_file->triggers, list) { + if (data->cmd_ops->trigger_type == ETT_EVENT_HIST) { + hist_data = data->private_data; + ret += atomic64_read(&hist_data->map->hits); + } + } + return ret; +} + static int hist_show(struct seq_file *m, void *v) { + struct hist_file_data *hist_file = m->private; struct event_trigger_data *data; struct trace_event_file *event_file; int n = 0, ret = 0; mutex_lock(&event_mutex); - event_file = event_file_data(m->private); + event_file = event_file_data(hist_file->file); if (unlikely(!event_file)) { ret = -ENODEV; goto out_unlock; @@ -5611,6 +5635,7 @@ static int hist_show(struct seq_file *m, void *v) if (data->cmd_ops->trigger_type == ETT_EVENT_HIST) hist_trigger_show(m, data, n++); } + hist_file->last_read = get_hist_hit_count(event_file); out_unlock: mutex_unlock(&event_mutex); @@ -5618,24 +5643,69 @@ static int hist_show(struct seq_file *m, void *v) return ret; } +static __poll_t event_hist_poll(struct file *file, struct poll_table_struct *wait) +{ + struct trace_event_file *event_file; + struct seq_file *m = file->private_data; + struct hist_file_data *hist_file = m->private; + __poll_t ret = 0; + + mutex_lock(&event_mutex); + + event_file = event_file_data(file); + if (!event_file) { + ret = EPOLLERR; + goto out_unlock; + } + + poll_wait(file, &event_file->hist_wq, wait); + + if (hist_file->last_read != get_hist_hit_count(event_file)) + ret = EPOLLIN | EPOLLRDNORM; + +out_unlock: + mutex_unlock(&event_mutex); + + return ret; +} + +static int event_hist_release(struct inode *inode, struct file *file) +{ + struct seq_file *m = file->private_data; + struct hist_file_data *hist_file = m->private; + + kfree(hist_file); + return tracing_single_release_file_tr(inode, file); +} + static int event_hist_open(struct inode *inode, struct file *file) { + struct hist_file_data *hist_file; int ret; ret = tracing_open_file_tr(inode, file); if (ret) return ret; + hist_file = kzalloc(sizeof(*hist_file), GFP_KERNEL); + if (!hist_file) + return -ENOMEM; + hist_file->file = file; + /* Clear private_data to avoid warning in single_open() */ file->private_data = NULL; - return single_open(file, hist_show, file); + ret = single_open(file, hist_show, hist_file); + if (ret) + kfree(hist_file); + return ret; } const struct file_operations event_hist_fops = { .open = event_hist_open, .read = seq_read, .llseek = seq_lseek, - .release = tracing_single_release_file_tr, + .release = event_hist_release, + .poll = event_hist_poll, }; #ifdef CONFIG_HIST_TRIGGERS_DEBUG From patchwork Tue Jun 25 15:17:20 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Masami Hiramatsu \(Google\)" X-Patchwork-Id: 807367 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 6B94D175570; Tue, 25 Jun 2024 15:17:24 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1719328644; cv=none; b=Nk8WNthapoTISKe0qc1Y89VAXSEARa4Vv2XAZQNNXUjqzWUYBCuCCBnNSopIPgIAuZ9C5vm8Vzdv2VkkIqYWcoHwVNcHq7v+gG1E0Mnw3geXk1g0ackfBaQ57CaHyUAnN98UTdvSFbid5Bw5ZS7MHT2kPMIA0hSs0q+BE5tMbS8= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1719328644; c=relaxed/simple; bh=pB4FB/igmk8EJqUlCRjX0n+041AXKCqYYycE3U3JBVE=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version:Content-Type; b=Yefw61c+FYIrkQejDVySLUZsFS5E/ZYq/dbQ8XnbgfH9XJcyib+tUZo+fJ0SAj6zU4h07RF9WP9mwzXlX3PiUX+To0cz62h8UgFSoTwhTTDOoI2jDqOUVyE55qXHg6b5ydhozm+CE4wBvb7MXaYNWP+hOwuunWzUXv6XLpdxpYs= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=M8nEJ5FV; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="M8nEJ5FV" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 62BB0C32781; Tue, 25 Jun 2024 15:17:22 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1719328644; bh=pB4FB/igmk8EJqUlCRjX0n+041AXKCqYYycE3U3JBVE=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=M8nEJ5FV7NXmyeeQ2gq9/LjfH/OFhTk5m0LgPjZIkb7LiyMb330/axgp0Ts7ldFHl W0UxgLoHIylziRjEpNNPhPtQvRCniaLuNk8ND0ftw3OK7JCDe6O5obvmD+Lwdams8S twvYesUDbV+Kr6P5FUBWC3ZfEbiI2PHHZJi7LoJz1koSmdQF1FuuqAr+n0lrkTQ278 R9iUBqE6N7sKPOC8ks9gSyBUy5Gz7cpyqAL+VXXtSUdrdw5wfuB4gMZ3n1NhbjcVzW 3SmpmaIYBX3ev7I5J24Zm+E0es7j43ECECWfkeriO/5MZevDR+8Y7+emXJEGayAzfq 7294LZoHeU6Sg== From: "Masami Hiramatsu (Google)" To: Steven Rostedt , Shuah Khan Cc: Masami Hiramatsu , Tom Zanussi , Mathieu Desnoyers , linux-kernel@vger.kernel.org, linux-trace-kernel@vger.kernel.org, linux-kselftest@vger.kernel.org Subject: [RFC PATCH 3/3] selftests/tracing: Add hist poll() support test Date: Wed, 26 Jun 2024 00:17:20 +0900 Message-Id: <171932864022.584123.13092042198625511966.stgit@devnote2> X-Mailer: git-send-email 2.34.1 In-Reply-To: <171932861260.584123.15653284949837094747.stgit@devnote2> References: <171932861260.584123.15653284949837094747.stgit@devnote2> User-Agent: StGit/0.19 Precedence: bulk X-Mailing-List: linux-kselftest@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 From: Masami Hiramatsu (Google) Add a testcase for poll() on hist file. This introduces a helper binary to the ftracetest, because there is no good way to reliably execute poll() on hist file. Signed-off-by: Masami Hiramatsu (Google) --- tools/testing/selftests/ftrace/Makefile | 3 + tools/testing/selftests/ftrace/poll.c | 34 +++++++++++++++ .../ftrace/test.d/trigger/trigger-hist-poll.tc | 46 ++++++++++++++++++++ 3 files changed, 83 insertions(+) create mode 100644 tools/testing/selftests/ftrace/poll.c create mode 100644 tools/testing/selftests/ftrace/test.d/trigger/trigger-hist-poll.tc diff --git a/tools/testing/selftests/ftrace/Makefile b/tools/testing/selftests/ftrace/Makefile index a1e955d2de4c..830b2299ea27 100644 --- a/tools/testing/selftests/ftrace/Makefile +++ b/tools/testing/selftests/ftrace/Makefile @@ -6,4 +6,7 @@ TEST_PROGS := ftracetest-ktap TEST_FILES := test.d settings EXTRA_CLEAN := $(OUTPUT)/logs/* +LDFLAGS += -static +TEST_GEN_PROGS = poll + include ../lib.mk diff --git a/tools/testing/selftests/ftrace/poll.c b/tools/testing/selftests/ftrace/poll.c new file mode 100644 index 000000000000..800d1114629c --- /dev/null +++ b/tools/testing/selftests/ftrace/poll.c @@ -0,0 +1,34 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Simple poll on a file. + * + * Copyright (c) 2024 Google LLC. + */ + +#include +#include +#include +#include + +#define BUFSIZE 4096 + +int main(int argc, char *argv[]) +{ + struct pollfd pfd = {.events = POLLPRI}; + char buf[BUFSIZE]; + + if (argc < 2) + return -1; + pfd.fd = open(argv[1], O_RDONLY); + if (pfd.fd < 0) { + perror("open"); + return -1; + } + + if (poll(&pfd, 1, -1) < 0) { + perror("poll"); + return -1; + } + close(pfd.fd); + return 0; +} diff --git a/tools/testing/selftests/ftrace/test.d/trigger/trigger-hist-poll.tc b/tools/testing/selftests/ftrace/test.d/trigger/trigger-hist-poll.tc new file mode 100644 index 000000000000..ac3999dee40b --- /dev/null +++ b/tools/testing/selftests/ftrace/test.d/trigger/trigger-hist-poll.tc @@ -0,0 +1,46 @@ +#!/bin/sh +# SPDX-License-Identifier: GPL-2.0 +# description: event trigger - test poll wait on histogram +# requires: set_event events/sched/sched_process_free/trigger events/sched/sched_process_free/hist +# flags: instance + +POLL=${FTRACETEST_ROOT}/poll + +if [ ! -x ${POLL} ]; then + echo "poll program is not compiled!" + exit_unresolved +fi + +EVENT=events/sched/sched_process_free/ + +echo "hist:key=comm" > ${EVENT}/trigger +echo 1 > ${EVENT}/enable + +# setting timeout +PID=$$ +SIG_FAIL=37 +trap exit_fail $SIG_FAIL +sleep 10 && (kill -s ${SIG_FAIL} ${PID} ||:) & +TOPID=$! + +# sleep command will exit after 2 seconds +sleep 2 & +BGPID=$! +${POLL} ${EVENT}/hist +# stop timeout +kill -KILL ${TOPID} ||: + +cat trace > ${TMPDIR}/trace + +if [ -d /proc/${BGPID} ]; then + echo "poll exits too soon" + kill -KILL ${BGPID} ||: + exit_fail +fi + +if ! grep -qw "sleep" ${TMPDIR}/trace; then + echo "poll exits before event happens" + exit_fail +fi + +exit_pass