From: Byungchul Park <byungchul@sk.com>
To: linux-kernel@vger.kernel.org
Cc: kernel_team@skhynix.com, torvalds@linux-foundation.org,
damien.lemoal@opensource.wdc.com, linux-ide@vger.kernel.org,
adilger.kernel@dilger.ca, linux-ext4@vger.kernel.org,
mingo@redhat.com, peterz@infradead.org, will@kernel.org,
tglx@linutronix.de, rostedt@goodmis.org, joel@joelfernandes.org,
sashal@kernel.org, daniel.vetter@ffwll.ch, duyuyang@gmail.com,
johannes.berg@intel.com, tj@kernel.org, tytso@mit.edu,
willy@infradead.org, david@fromorbit.com, amir73il@gmail.com,
gregkh@linuxfoundation.org, kernel-team@lge.com,
linux-mm@kvack.org, akpm@linux-foundation.org, mhocko@kernel.org,
minchan@kernel.org, hannes@cmpxchg.org, vdavydov.dev@gmail.com,
sj@kernel.org, jglisse@redhat.com, dennis@kernel.org,
cl@linux.com, penberg@kernel.org, rientjes@google.com,
vbabka@suse.cz, ngupta@vflare.org, linux-block@vger.kernel.org,
josef@toxicpanda.com, linux-fsdevel@vger.kernel.org,
viro@zeniv.linux.org.uk, jack@suse.cz, jlayton@kernel.org,
dan.j.williams@intel.com, hch@infradead.org, djwong@kernel.org,
dri-devel@lists.freedesktop.org, rodrigosiqueiramelo@gmail.com,
melissa.srw@gmail.com, hamohammed.sa@gmail.com,
42.hyeyoo@gmail.com, chris.p.wilson@intel.com,
gwan-gyeong.mun@intel.com, max.byungchul.park@gmail.com,
boqun.feng@gmail.com, longman@redhat.com, hdanton@sina.com,
her0gyugyu@gmail.com
Subject: [PATCH v11 03/26] dept: Add single event dependency tracker APIs
Date: Wed, 24 Jan 2024 20:59:14 +0900 [thread overview]
Message-ID: <20240124115938.80132-4-byungchul@sk.com> (raw)
In-Reply-To: <20240124115938.80132-1-byungchul@sk.com>
Wrapped the base APIs for easier annotation on wait and event. Start
with supporting waiters on each single event. More general support for
multiple events is a future work. Do more when the need arises.
How to annotate (the simplest way):
1. Initaialize a map for the interesting wait.
/*
* Recommand to place along with the wait instance.
*/
struct dept_map my_wait;
/*
* Recommand to place in the initialization code.
*/
sdt_map_init(&my_wait);
2. Place the following at the wait code.
sdt_wait(&my_wait);
3. Place the following at the event code.
sdt_event(&my_wait);
That's it!
Signed-off-by: Byungchul Park <byungchul@sk.com>
---
include/linux/dept_sdt.h | 62 ++++++++++++++++++++++++++++++++++++++++
1 file changed, 62 insertions(+)
create mode 100644 include/linux/dept_sdt.h
diff --git a/include/linux/dept_sdt.h b/include/linux/dept_sdt.h
new file mode 100644
index 000000000000..12a793b90c7e
--- /dev/null
+++ b/include/linux/dept_sdt.h
@@ -0,0 +1,62 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+/*
+ * Single-event Dependency Tracker
+ *
+ * Started by Byungchul Park <max.byungchul.park@gmail.com>:
+ *
+ * Copyright (c) 2020 LG Electronics, Inc., Byungchul Park
+ */
+
+#ifndef __LINUX_DEPT_SDT_H
+#define __LINUX_DEPT_SDT_H
+
+#include <linux/kernel.h>
+#include <linux/dept.h>
+
+#ifdef CONFIG_DEPT
+#define sdt_map_init(m) \
+ do { \
+ static struct dept_key __key; \
+ dept_map_init(m, &__key, 0, #m); \
+ } while (0)
+
+#define sdt_map_init_key(m, k) dept_map_init(m, k, 0, #m)
+
+#define sdt_wait(m) \
+ do { \
+ dept_request_event(m); \
+ dept_wait(m, 1UL, _THIS_IP_, __func__, 0); \
+ } while (0)
+
+/*
+ * sdt_might_sleep() and its family will be committed in __schedule()
+ * when it actually gets to __schedule(). Both dept_request_event() and
+ * dept_wait() will be performed on the commit.
+ */
+
+/*
+ * Use the code location as the class key if an explicit map is not used.
+ */
+#define sdt_might_sleep_start(m) \
+ do { \
+ struct dept_map *__m = m; \
+ static struct dept_key __key; \
+ dept_stage_wait(__m, __m ? NULL : &__key, _THIS_IP_, __func__);\
+ } while (0)
+
+#define sdt_might_sleep_end() dept_clean_stage()
+
+#define sdt_ecxt_enter(m) dept_ecxt_enter(m, 1UL, _THIS_IP_, "start", "event", 0)
+#define sdt_event(m) dept_event(m, 1UL, _THIS_IP_, __func__)
+#define sdt_ecxt_exit(m) dept_ecxt_exit(m, 1UL, _THIS_IP_)
+#else /* !CONFIG_DEPT */
+#define sdt_map_init(m) do { } while (0)
+#define sdt_map_init_key(m, k) do { (void)(k); } while (0)
+#define sdt_wait(m) do { } while (0)
+#define sdt_might_sleep_start(m) do { } while (0)
+#define sdt_might_sleep_end() do { } while (0)
+#define sdt_ecxt_enter(m) do { } while (0)
+#define sdt_event(m) do { } while (0)
+#define sdt_ecxt_exit(m) do { } while (0)
+#endif
+#endif /* __LINUX_DEPT_SDT_H */
--
2.17.1
next prev parent reply other threads:[~2024-01-24 11:59 UTC|newest]
Thread overview: 35+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-24 11:59 [PATCH v11 00/26] DEPT(Dependency Tracker) Byungchul Park
2024-01-24 11:59 ` [PATCH v11 01/26] llist: Move llist_{head,node} definition to types.h Byungchul Park
2024-01-24 11:59 ` [PATCH v11 02/26] dept: Implement Dept(Dependency Tracker) Byungchul Park
2024-01-24 11:59 ` Byungchul Park [this message]
2024-01-24 11:59 ` [PATCH v11 04/26] dept: Add lock dependency tracker APIs Byungchul Park
2024-01-24 11:59 ` [PATCH v11 05/26] dept: Tie to Lockdep and IRQ tracing Byungchul Park
2024-01-28 13:10 ` kernel test robot
2024-01-28 15:58 ` kernel test robot
2024-01-24 11:59 ` [PATCH v11 06/26] dept: Add proc knobs to show stats and dependency graph Byungchul Park
2024-01-24 11:59 ` [PATCH v11 07/26] dept: Apply sdt_might_sleep_{start,end}() to wait_for_completion()/complete() Byungchul Park
2024-01-24 11:59 ` [PATCH v11 08/26] dept: Apply sdt_might_sleep_{start,end}() to swait Byungchul Park
2024-01-24 11:59 ` [PATCH v11 09/26] dept: Apply sdt_might_sleep_{start,end}() to waitqueue wait Byungchul Park
2024-01-24 11:59 ` [PATCH v11 10/26] dept: Apply sdt_might_sleep_{start,end}() to hashed-waitqueue wait Byungchul Park
2024-01-24 11:59 ` [PATCH v11 11/26] dept: Distinguish each syscall context from another Byungchul Park
2024-01-24 11:59 ` [PATCH v11 12/26] dept: Distinguish each work " Byungchul Park
2024-01-24 11:59 ` [PATCH v11 13/26] dept: Add a mechanism to refill the internal memory pools on running out Byungchul Park
2024-01-24 11:59 ` [PATCH v11 14/26] locking/lockdep, cpu/hotplus: Use a weaker annotation in AP thread Byungchul Park
2024-01-26 17:30 ` Thomas Gleixner
2024-01-29 4:20 ` Byungchul Park
2024-01-30 2:58 ` Byungchul Park
2024-02-12 15:16 ` Thomas Gleixner
2024-02-13 1:18 ` Byungchul Park
2024-01-24 11:59 ` [PATCH v11 15/26] dept: Apply sdt_might_sleep_{start,end}() to dma fence wait Byungchul Park
2024-01-24 11:59 ` [PATCH v11 16/26] dept: Track timeout waits separately with a new Kconfig Byungchul Park
2024-01-24 11:59 ` [PATCH v11 17/26] dept: Apply timeout consideration to wait_for_completion()/complete() Byungchul Park
2024-01-24 11:59 ` [PATCH v11 18/26] dept: Apply timeout consideration to swait Byungchul Park
2024-01-24 11:59 ` [PATCH v11 19/26] dept: Apply timeout consideration to waitqueue wait Byungchul Park
2024-01-24 11:59 ` [PATCH v11 20/26] dept: Apply timeout consideration to hashed-waitqueue wait Byungchul Park
2024-01-24 11:59 ` [PATCH v11 21/26] dept: Apply timeout consideration to dma fence wait Byungchul Park
2024-01-24 11:59 ` [PATCH v11 22/26] dept: Record the latest one out of consecutive waits of the same class Byungchul Park
2024-01-24 11:59 ` [PATCH v11 23/26] dept: Make Dept able to work with an external wgen Byungchul Park
2024-01-24 11:59 ` [PATCH v11 24/26] dept: Track PG_locked with dept Byungchul Park
2024-01-24 11:59 ` [PATCH v11 25/26] dept: Print event context requestor's stacktrace on report Byungchul Park
2024-01-28 14:44 ` kernel test robot
2024-01-24 11:59 ` [PATCH v11 26/26] locking/lockdep, fs/jbd2: Use a weaker annotation in journal handling Byungchul Park
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240124115938.80132-4-byungchul@sk.com \
--to=byungchul@sk.com \
--cc=42.hyeyoo@gmail.com \
--cc=adilger.kernel@dilger.ca \
--cc=akpm@linux-foundation.org \
--cc=amir73il@gmail.com \
--cc=boqun.feng@gmail.com \
--cc=chris.p.wilson@intel.com \
--cc=cl@linux.com \
--cc=damien.lemoal@opensource.wdc.com \
--cc=dan.j.williams@intel.com \
--cc=daniel.vetter@ffwll.ch \
--cc=david@fromorbit.com \
--cc=dennis@kernel.org \
--cc=djwong@kernel.org \
--cc=dri-devel@lists.freedesktop.org \
--cc=duyuyang@gmail.com \
--cc=gregkh@linuxfoundation.org \
--cc=gwan-gyeong.mun@intel.com \
--cc=hamohammed.sa@gmail.com \
--cc=hannes@cmpxchg.org \
--cc=hch@infradead.org \
--cc=hdanton@sina.com \
--cc=her0gyugyu@gmail.com \
--cc=jack@suse.cz \
--cc=jglisse@redhat.com \
--cc=jlayton@kernel.org \
--cc=joel@joelfernandes.org \
--cc=johannes.berg@intel.com \
--cc=josef@toxicpanda.com \
--cc=kernel-team@lge.com \
--cc=kernel_team@skhynix.com \
--cc=linux-block@vger.kernel.org \
--cc=linux-ext4@vger.kernel.org \
--cc=linux-fsdevel@vger.kernel.org \
--cc=linux-ide@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=longman@redhat.com \
--cc=max.byungchul.park@gmail.com \
--cc=melissa.srw@gmail.com \
--cc=mhocko@kernel.org \
--cc=minchan@kernel.org \
--cc=mingo@redhat.com \
--cc=ngupta@vflare.org \
--cc=penberg@kernel.org \
--cc=peterz@infradead.org \
--cc=rientjes@google.com \
--cc=rodrigosiqueiramelo@gmail.com \
--cc=rostedt@goodmis.org \
--cc=sashal@kernel.org \
--cc=sj@kernel.org \
--cc=tglx@linutronix.de \
--cc=tj@kernel.org \
--cc=torvalds@linux-foundation.org \
--cc=tytso@mit.edu \
--cc=vbabka@suse.cz \
--cc=vdavydov.dev@gmail.com \
--cc=viro@zeniv.linux.org.uk \
--cc=will@kernel.org \
--cc=willy@infradead.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).