[tip: sched/core] sched: Add annotations to RT_GROUP_SCHED fields

[tip-bot2 for Michal Koutný]

The following commit has been merged into the sched/core branch of tip:

Commit-ID:     0ab94c3242742bfb540abeedb6bb98440146ac5b
Gitweb:        https://git.kernel.org/tip/0ab94c3242742bfb540abeedb6bb98440146ac5b
Author:        Michal Koutný <mkoutny@xxxxxxxx>
AuthorDate:    Mon, 10 Mar 2025 18:04:41 +01:00
Committer:     Peter Zijlstra <peterz@xxxxxxxxxxxxx>
CommitterDate: Tue, 08 Apr 2025 20:55:55 +02:00

sched: Add annotations to RT_GROUP_SCHED fields

Update comments to ease RT throttling understanding.

Signed-off-by: Michal Koutný <mkoutny@xxxxxxxx>
Signed-off-by: Peter Zijlstra (Intel) <peterz@xxxxxxxxxxxxx>
Link: https://lkml.kernel.org/r/20250310170442.504716-10-mkoutny@xxxxxxxx
---
 kernel/sched/sched.h | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/kernel/sched/sched.h b/kernel/sched/sched.h
index 898aab7..c5a6a50 100644
--- a/kernel/sched/sched.h
+++ b/kernel/sched/sched.h
@@ -813,17 +813,17 @@ struct rt_rq {
 
 #ifdef CONFIG_RT_GROUP_SCHED
 	int			rt_throttled;
-	u64			rt_time;
-	u64			rt_runtime;
+	u64			rt_time; /* consumed RT time, goes up in update_curr_rt */
+	u64			rt_runtime; /* allotted RT time, "slice" from rt_bandwidth, RT sharing/balancing */
 	/* Nests inside the rq lock: */
 	raw_spinlock_t		rt_runtime_lock;
 
 	unsigned int		rt_nr_boosted;
 
-	struct rq		*rq;
+	struct rq		*rq; /* this is always top-level rq, cache? */
 #endif
 #ifdef CONFIG_CGROUP_SCHED
-	struct task_group	*tg;
+	struct task_group	*tg; /* this tg has "this" rt_rq on given CPU for runnable entities */
 #endif
 };