Received-SPF: pass (google.com: domain of linux-kernel+bounces-137907-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3;
From: Atul Pant <quic_atulpant@quicinc.com>
To: mingo@redhat.com, peterz@infradead.org, juri.lelli@redhat.com,
        vincent.guittot@linaro.org, dietmar.eggemann@arm.com,
        rostedt@goodmis.org, bsegall@google.com, mgorman@suse.de,
        bristot@redhat.com, vschneid@redhat.com, rafael@kernel.org,
        daniel.lezcano@linaro.org
Cc: Atul Pant <quic_atulpant@quicinc.com>, kernel@quicinc.com,
        linux-kernel@vger.kernel.org, linux-pm@vger.kernel.org
Subject: [RFC PATCH 2/2] sched/idle: Add a description for play_idle_precise
Date: Wed, 10 Apr 2024 10:24:17 +0530
Message-Id: <20240410045417.3048209-3-quic_atulpant@quicinc.com>
In-Reply-To: <20240410045417.3048209-1-quic_atulpant@quicinc.com>
References: <20240410045417.3048209-1-quic_atulpant@quicinc.com>
Precedence: bulk
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit

Since runtime accounting of any RT idle thread is prevented, add a
description about this function that it runs idle loops on a cpu
without these threads being preempted due to RT throttling.

Signed-off-by: Atul Pant <quic_atulpant@quicinc.com>
---
 kernel/sched/idle.c | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/kernel/sched/idle.c b/kernel/sched/idle.c
index 5007b25c5bc6..7aaf3679f50a 100644
--- a/kernel/sched/idle.c
+++ b/kernel/sched/idle.c
@@ -334,6 +334,11 @@ static enum hrtimer_restart idle_inject_timer_fn(struct hrtimer *timer)
 	return HRTIMER_NORESTART;
 }
 
+/*
+ * This function runs idle loops on a cpu, whose policy is set as SCHED_FIFO.
+ * Despite being a rt thread, runtime for it is not accounted, thus preventing
+ * its preemption due to rt-throttling
+ */
 void play_idle_precise(u64 duration_ns, u64 latency_ns)
 {
 	struct idle_timer it;
-- 
2.25.1