2 * CPUFreq governor based on scheduler-provided CPU utilization data.
4 * Copyright (C) 2016, Intel Corporation
5 * Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
12 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
14 #include <linux/cpufreq.h>
15 #include <linux/kthread.h>
16 #include <uapi/linux/sched/types.h>
17 #include <linux/slab.h>
18 #include <trace/events/power.h>
22 #define SUGOV_KTHREAD_PRIORITY 50
24 struct sugov_tunables
{
25 struct gov_attr_set attr_set
;
26 unsigned int rate_limit_us
;
30 struct cpufreq_policy
*policy
;
32 struct sugov_tunables
*tunables
;
33 struct list_head tunables_hook
;
35 raw_spinlock_t update_lock
; /* For shared policies */
36 u64 last_freq_update_time
;
37 s64 freq_update_delay_ns
;
38 unsigned int next_freq
;
39 unsigned int cached_raw_freq
;
41 /* The next fields are only needed if fast switch cannot be used. */
42 struct irq_work irq_work
;
43 struct kthread_work work
;
44 struct mutex work_lock
;
45 struct kthread_worker worker
;
46 struct task_struct
*thread
;
47 bool work_in_progress
;
49 bool need_freq_update
;
53 struct update_util_data update_util
;
54 struct sugov_policy
*sg_policy
;
57 bool iowait_boost_pending
;
58 unsigned int iowait_boost
;
59 unsigned int iowait_boost_max
;
62 /* The fields below are only needed when sharing a policy. */
67 /* The field below is for single-CPU policies only. */
68 #ifdef CONFIG_NO_HZ_COMMON
69 unsigned long saved_idle_calls
;
73 static DEFINE_PER_CPU(struct sugov_cpu
, sugov_cpu
);
75 /************************ Governor internals ***********************/
77 static bool sugov_should_update_freq(struct sugov_policy
*sg_policy
, u64 time
)
82 * Since cpufreq_update_util() is called with rq->lock held for
83 * the @target_cpu, our per-cpu data is fully serialized.
85 * However, drivers cannot in general deal with cross-cpu
86 * requests, so while get_next_freq() will work, our
87 * sugov_update_commit() call may not for the fast switching platforms.
89 * Hence stop here for remote requests if they aren't supported
90 * by the hardware, as calculating the frequency is pointless if
91 * we cannot in fact act on it.
93 * For the slow switching platforms, the kthread is always scheduled on
94 * the right set of CPUs and any CPU can find the next frequency and
95 * schedule the kthread.
97 if (sg_policy
->policy
->fast_switch_enabled
&&
98 !cpufreq_can_do_remote_dvfs(sg_policy
->policy
))
101 if (sg_policy
->work_in_progress
)
104 if (unlikely(sg_policy
->need_freq_update
)) {
105 sg_policy
->need_freq_update
= false;
107 * This happens when limits change, so forget the previous
108 * next_freq value and force an update.
110 sg_policy
->next_freq
= UINT_MAX
;
114 delta_ns
= time
- sg_policy
->last_freq_update_time
;
115 return delta_ns
>= sg_policy
->freq_update_delay_ns
;
118 static void sugov_update_commit(struct sugov_policy
*sg_policy
, u64 time
,
119 unsigned int next_freq
)
121 struct cpufreq_policy
*policy
= sg_policy
->policy
;
123 if (sg_policy
->next_freq
== next_freq
)
126 sg_policy
->next_freq
= next_freq
;
127 sg_policy
->last_freq_update_time
= time
;
129 if (policy
->fast_switch_enabled
) {
130 next_freq
= cpufreq_driver_fast_switch(policy
, next_freq
);
134 policy
->cur
= next_freq
;
135 trace_cpu_frequency(next_freq
, smp_processor_id());
137 sg_policy
->work_in_progress
= true;
138 irq_work_queue(&sg_policy
->irq_work
);
143 * get_next_freq - Compute a new frequency for a given cpufreq policy.
144 * @sg_policy: schedutil policy object to compute the new frequency for.
145 * @util: Current CPU utilization.
146 * @max: CPU capacity.
148 * If the utilization is frequency-invariant, choose the new frequency to be
149 * proportional to it, that is
151 * next_freq = C * max_freq * util / max
153 * Otherwise, approximate the would-be frequency-invariant utilization by
154 * util_raw * (curr_freq / max_freq) which leads to
156 * next_freq = C * curr_freq * util_raw / max
158 * Take C = 1.25 for the frequency tipping point at (util / max) = 0.8.
160 * The lowest driver-supported frequency which is equal or greater than the raw
161 * next_freq (as calculated above) is returned, subject to policy min/max and
162 * cpufreq driver limitations.
164 static unsigned int get_next_freq(struct sugov_policy
*sg_policy
,
165 unsigned long util
, unsigned long max
)
167 struct cpufreq_policy
*policy
= sg_policy
->policy
;
168 unsigned int freq
= arch_scale_freq_invariant() ?
169 policy
->cpuinfo
.max_freq
: policy
->cur
;
171 freq
= (freq
+ (freq
>> 2)) * util
/ max
;
173 if (freq
== sg_policy
->cached_raw_freq
&& sg_policy
->next_freq
!= UINT_MAX
)
174 return sg_policy
->next_freq
;
175 sg_policy
->cached_raw_freq
= freq
;
176 return cpufreq_driver_resolve_freq(policy
, freq
);
179 static void sugov_get_util(unsigned long *util
, unsigned long *max
, int cpu
)
181 struct rq
*rq
= cpu_rq(cpu
);
182 unsigned long cfs_max
;
184 cfs_max
= arch_scale_cpu_capacity(NULL
, cpu
);
186 *util
= min(rq
->cfs
.avg
.util_avg
, cfs_max
);
190 static void sugov_set_iowait_boost(struct sugov_cpu
*sg_cpu
, u64 time
,
193 if (flags
& SCHED_CPUFREQ_IOWAIT
) {
194 if (sg_cpu
->iowait_boost_pending
)
197 sg_cpu
->iowait_boost_pending
= true;
199 if (sg_cpu
->iowait_boost
) {
200 sg_cpu
->iowait_boost
<<= 1;
201 if (sg_cpu
->iowait_boost
> sg_cpu
->iowait_boost_max
)
202 sg_cpu
->iowait_boost
= sg_cpu
->iowait_boost_max
;
204 sg_cpu
->iowait_boost
= sg_cpu
->sg_policy
->policy
->min
;
206 } else if (sg_cpu
->iowait_boost
) {
207 s64 delta_ns
= time
- sg_cpu
->last_update
;
209 /* Clear iowait_boost if the CPU apprears to have been idle. */
210 if (delta_ns
> TICK_NSEC
) {
211 sg_cpu
->iowait_boost
= 0;
212 sg_cpu
->iowait_boost_pending
= false;
217 static void sugov_iowait_boost(struct sugov_cpu
*sg_cpu
, unsigned long *util
,
220 unsigned int boost_util
, boost_max
;
222 if (!sg_cpu
->iowait_boost
)
225 if (sg_cpu
->iowait_boost_pending
) {
226 sg_cpu
->iowait_boost_pending
= false;
228 sg_cpu
->iowait_boost
>>= 1;
229 if (sg_cpu
->iowait_boost
< sg_cpu
->sg_policy
->policy
->min
) {
230 sg_cpu
->iowait_boost
= 0;
235 boost_util
= sg_cpu
->iowait_boost
;
236 boost_max
= sg_cpu
->iowait_boost_max
;
238 if (*util
* boost_max
< *max
* boost_util
) {
244 #ifdef CONFIG_NO_HZ_COMMON
245 static bool sugov_cpu_is_busy(struct sugov_cpu
*sg_cpu
)
247 unsigned long idle_calls
= tick_nohz_get_idle_calls();
248 bool ret
= idle_calls
== sg_cpu
->saved_idle_calls
;
250 sg_cpu
->saved_idle_calls
= idle_calls
;
254 static inline bool sugov_cpu_is_busy(struct sugov_cpu
*sg_cpu
) { return false; }
255 #endif /* CONFIG_NO_HZ_COMMON */
257 static void sugov_update_single(struct update_util_data
*hook
, u64 time
,
260 struct sugov_cpu
*sg_cpu
= container_of(hook
, struct sugov_cpu
, update_util
);
261 struct sugov_policy
*sg_policy
= sg_cpu
->sg_policy
;
262 struct cpufreq_policy
*policy
= sg_policy
->policy
;
263 unsigned long util
, max
;
267 sugov_set_iowait_boost(sg_cpu
, time
, flags
);
268 sg_cpu
->last_update
= time
;
270 if (!sugov_should_update_freq(sg_policy
, time
))
273 busy
= sugov_cpu_is_busy(sg_cpu
);
275 if (flags
& SCHED_CPUFREQ_RT_DL
) {
276 next_f
= policy
->cpuinfo
.max_freq
;
278 sugov_get_util(&util
, &max
, sg_cpu
->cpu
);
279 sugov_iowait_boost(sg_cpu
, &util
, &max
);
280 next_f
= get_next_freq(sg_policy
, util
, max
);
282 * Do not reduce the frequency if the CPU has not been idle
283 * recently, as the reduction is likely to be premature then.
285 if (busy
&& next_f
< sg_policy
->next_freq
) {
286 next_f
= sg_policy
->next_freq
;
288 /* Reset cached freq as next_freq has changed */
289 sg_policy
->cached_raw_freq
= 0;
292 sugov_update_commit(sg_policy
, time
, next_f
);
295 static unsigned int sugov_next_freq_shared(struct sugov_cpu
*sg_cpu
, u64 time
)
297 struct sugov_policy
*sg_policy
= sg_cpu
->sg_policy
;
298 struct cpufreq_policy
*policy
= sg_policy
->policy
;
299 unsigned long util
= 0, max
= 1;
302 for_each_cpu(j
, policy
->cpus
) {
303 struct sugov_cpu
*j_sg_cpu
= &per_cpu(sugov_cpu
, j
);
304 unsigned long j_util
, j_max
;
308 * If the CPU utilization was last updated before the previous
309 * frequency update and the time elapsed between the last update
310 * of the CPU utilization and the last frequency update is long
311 * enough, don't take the CPU into account as it probably is
312 * idle now (and clear iowait_boost for it).
314 delta_ns
= time
- j_sg_cpu
->last_update
;
315 if (delta_ns
> TICK_NSEC
) {
316 j_sg_cpu
->iowait_boost
= 0;
317 j_sg_cpu
->iowait_boost_pending
= false;
320 if (j_sg_cpu
->flags
& SCHED_CPUFREQ_RT_DL
)
321 return policy
->cpuinfo
.max_freq
;
323 j_util
= j_sg_cpu
->util
;
324 j_max
= j_sg_cpu
->max
;
325 if (j_util
* max
> j_max
* util
) {
330 sugov_iowait_boost(j_sg_cpu
, &util
, &max
);
333 return get_next_freq(sg_policy
, util
, max
);
336 static void sugov_update_shared(struct update_util_data
*hook
, u64 time
,
339 struct sugov_cpu
*sg_cpu
= container_of(hook
, struct sugov_cpu
, update_util
);
340 struct sugov_policy
*sg_policy
= sg_cpu
->sg_policy
;
341 unsigned long util
, max
;
344 sugov_get_util(&util
, &max
, sg_cpu
->cpu
);
346 raw_spin_lock(&sg_policy
->update_lock
);
350 sg_cpu
->flags
= flags
;
352 sugov_set_iowait_boost(sg_cpu
, time
, flags
);
353 sg_cpu
->last_update
= time
;
355 if (sugov_should_update_freq(sg_policy
, time
)) {
356 if (flags
& SCHED_CPUFREQ_RT_DL
)
357 next_f
= sg_policy
->policy
->cpuinfo
.max_freq
;
359 next_f
= sugov_next_freq_shared(sg_cpu
, time
);
361 sugov_update_commit(sg_policy
, time
, next_f
);
364 raw_spin_unlock(&sg_policy
->update_lock
);
367 static void sugov_work(struct kthread_work
*work
)
369 struct sugov_policy
*sg_policy
= container_of(work
, struct sugov_policy
, work
);
371 mutex_lock(&sg_policy
->work_lock
);
372 __cpufreq_driver_target(sg_policy
->policy
, sg_policy
->next_freq
,
374 mutex_unlock(&sg_policy
->work_lock
);
376 sg_policy
->work_in_progress
= false;
379 static void sugov_irq_work(struct irq_work
*irq_work
)
381 struct sugov_policy
*sg_policy
;
383 sg_policy
= container_of(irq_work
, struct sugov_policy
, irq_work
);
386 * For RT and deadline tasks, the schedutil governor shoots the
387 * frequency to maximum. Special care must be taken to ensure that this
388 * kthread doesn't result in the same behavior.
390 * This is (mostly) guaranteed by the work_in_progress flag. The flag is
391 * updated only at the end of the sugov_work() function and before that
392 * the schedutil governor rejects all other frequency scaling requests.
394 * There is a very rare case though, where the RT thread yields right
395 * after the work_in_progress flag is cleared. The effects of that are
398 kthread_queue_work(&sg_policy
->worker
, &sg_policy
->work
);
401 /************************** sysfs interface ************************/
403 static struct sugov_tunables
*global_tunables
;
404 static DEFINE_MUTEX(global_tunables_lock
);
406 static inline struct sugov_tunables
*to_sugov_tunables(struct gov_attr_set
*attr_set
)
408 return container_of(attr_set
, struct sugov_tunables
, attr_set
);
411 static ssize_t
rate_limit_us_show(struct gov_attr_set
*attr_set
, char *buf
)
413 struct sugov_tunables
*tunables
= to_sugov_tunables(attr_set
);
415 return sprintf(buf
, "%u\n", tunables
->rate_limit_us
);
418 static ssize_t
rate_limit_us_store(struct gov_attr_set
*attr_set
, const char *buf
,
421 struct sugov_tunables
*tunables
= to_sugov_tunables(attr_set
);
422 struct sugov_policy
*sg_policy
;
423 unsigned int rate_limit_us
;
425 if (kstrtouint(buf
, 10, &rate_limit_us
))
428 tunables
->rate_limit_us
= rate_limit_us
;
430 list_for_each_entry(sg_policy
, &attr_set
->policy_list
, tunables_hook
)
431 sg_policy
->freq_update_delay_ns
= rate_limit_us
* NSEC_PER_USEC
;
436 static struct governor_attr rate_limit_us
= __ATTR_RW(rate_limit_us
);
438 static struct attribute
*sugov_attributes
[] = {
443 static struct kobj_type sugov_tunables_ktype
= {
444 .default_attrs
= sugov_attributes
,
445 .sysfs_ops
= &governor_sysfs_ops
,
448 /********************** cpufreq governor interface *********************/
450 static struct cpufreq_governor schedutil_gov
;
452 static struct sugov_policy
*sugov_policy_alloc(struct cpufreq_policy
*policy
)
454 struct sugov_policy
*sg_policy
;
456 sg_policy
= kzalloc(sizeof(*sg_policy
), GFP_KERNEL
);
460 sg_policy
->policy
= policy
;
461 raw_spin_lock_init(&sg_policy
->update_lock
);
465 static void sugov_policy_free(struct sugov_policy
*sg_policy
)
470 static int sugov_kthread_create(struct sugov_policy
*sg_policy
)
472 struct task_struct
*thread
;
473 struct sched_param param
= { .sched_priority
= MAX_USER_RT_PRIO
/ 2 };
474 struct cpufreq_policy
*policy
= sg_policy
->policy
;
477 /* kthread only required for slow path */
478 if (policy
->fast_switch_enabled
)
481 kthread_init_work(&sg_policy
->work
, sugov_work
);
482 kthread_init_worker(&sg_policy
->worker
);
483 thread
= kthread_create(kthread_worker_fn
, &sg_policy
->worker
,
485 cpumask_first(policy
->related_cpus
));
486 if (IS_ERR(thread
)) {
487 pr_err("failed to create sugov thread: %ld\n", PTR_ERR(thread
));
488 return PTR_ERR(thread
);
491 ret
= sched_setscheduler_nocheck(thread
, SCHED_FIFO
, ¶m
);
493 kthread_stop(thread
);
494 pr_warn("%s: failed to set SCHED_FIFO\n", __func__
);
498 sg_policy
->thread
= thread
;
500 /* Kthread is bound to all CPUs by default */
501 if (!policy
->dvfs_possible_from_any_cpu
)
502 kthread_bind_mask(thread
, policy
->related_cpus
);
504 init_irq_work(&sg_policy
->irq_work
, sugov_irq_work
);
505 mutex_init(&sg_policy
->work_lock
);
507 wake_up_process(thread
);
512 static void sugov_kthread_stop(struct sugov_policy
*sg_policy
)
514 /* kthread only required for slow path */
515 if (sg_policy
->policy
->fast_switch_enabled
)
518 kthread_flush_worker(&sg_policy
->worker
);
519 kthread_stop(sg_policy
->thread
);
520 mutex_destroy(&sg_policy
->work_lock
);
523 static struct sugov_tunables
*sugov_tunables_alloc(struct sugov_policy
*sg_policy
)
525 struct sugov_tunables
*tunables
;
527 tunables
= kzalloc(sizeof(*tunables
), GFP_KERNEL
);
529 gov_attr_set_init(&tunables
->attr_set
, &sg_policy
->tunables_hook
);
530 if (!have_governor_per_policy())
531 global_tunables
= tunables
;
536 static void sugov_tunables_free(struct sugov_tunables
*tunables
)
538 if (!have_governor_per_policy())
539 global_tunables
= NULL
;
544 static int sugov_init(struct cpufreq_policy
*policy
)
546 struct sugov_policy
*sg_policy
;
547 struct sugov_tunables
*tunables
;
550 /* State should be equivalent to EXIT */
551 if (policy
->governor_data
)
554 cpufreq_enable_fast_switch(policy
);
556 sg_policy
= sugov_policy_alloc(policy
);
559 goto disable_fast_switch
;
562 ret
= sugov_kthread_create(sg_policy
);
566 mutex_lock(&global_tunables_lock
);
568 if (global_tunables
) {
569 if (WARN_ON(have_governor_per_policy())) {
573 policy
->governor_data
= sg_policy
;
574 sg_policy
->tunables
= global_tunables
;
576 gov_attr_set_get(&global_tunables
->attr_set
, &sg_policy
->tunables_hook
);
580 tunables
= sugov_tunables_alloc(sg_policy
);
586 tunables
->rate_limit_us
= cpufreq_policy_transition_delay_us(policy
);
588 policy
->governor_data
= sg_policy
;
589 sg_policy
->tunables
= tunables
;
591 ret
= kobject_init_and_add(&tunables
->attr_set
.kobj
, &sugov_tunables_ktype
,
592 get_governor_parent_kobj(policy
), "%s",
598 mutex_unlock(&global_tunables_lock
);
602 policy
->governor_data
= NULL
;
603 sugov_tunables_free(tunables
);
606 sugov_kthread_stop(sg_policy
);
609 mutex_unlock(&global_tunables_lock
);
611 sugov_policy_free(sg_policy
);
614 cpufreq_disable_fast_switch(policy
);
616 pr_err("initialization failed (error %d)\n", ret
);
620 static void sugov_exit(struct cpufreq_policy
*policy
)
622 struct sugov_policy
*sg_policy
= policy
->governor_data
;
623 struct sugov_tunables
*tunables
= sg_policy
->tunables
;
626 mutex_lock(&global_tunables_lock
);
628 count
= gov_attr_set_put(&tunables
->attr_set
, &sg_policy
->tunables_hook
);
629 policy
->governor_data
= NULL
;
631 sugov_tunables_free(tunables
);
633 mutex_unlock(&global_tunables_lock
);
635 sugov_kthread_stop(sg_policy
);
636 sugov_policy_free(sg_policy
);
637 cpufreq_disable_fast_switch(policy
);
640 static int sugov_start(struct cpufreq_policy
*policy
)
642 struct sugov_policy
*sg_policy
= policy
->governor_data
;
645 sg_policy
->freq_update_delay_ns
= sg_policy
->tunables
->rate_limit_us
* NSEC_PER_USEC
;
646 sg_policy
->last_freq_update_time
= 0;
647 sg_policy
->next_freq
= UINT_MAX
;
648 sg_policy
->work_in_progress
= false;
649 sg_policy
->need_freq_update
= false;
650 sg_policy
->cached_raw_freq
= 0;
652 for_each_cpu(cpu
, policy
->cpus
) {
653 struct sugov_cpu
*sg_cpu
= &per_cpu(sugov_cpu
, cpu
);
655 memset(sg_cpu
, 0, sizeof(*sg_cpu
));
657 sg_cpu
->sg_policy
= sg_policy
;
658 sg_cpu
->flags
= SCHED_CPUFREQ_RT
;
659 sg_cpu
->iowait_boost_max
= policy
->cpuinfo
.max_freq
;
662 for_each_cpu(cpu
, policy
->cpus
) {
663 struct sugov_cpu
*sg_cpu
= &per_cpu(sugov_cpu
, cpu
);
665 cpufreq_add_update_util_hook(cpu
, &sg_cpu
->update_util
,
666 policy_is_shared(policy
) ?
667 sugov_update_shared
:
668 sugov_update_single
);
673 static void sugov_stop(struct cpufreq_policy
*policy
)
675 struct sugov_policy
*sg_policy
= policy
->governor_data
;
678 for_each_cpu(cpu
, policy
->cpus
)
679 cpufreq_remove_update_util_hook(cpu
);
683 if (!policy
->fast_switch_enabled
) {
684 irq_work_sync(&sg_policy
->irq_work
);
685 kthread_cancel_work_sync(&sg_policy
->work
);
689 static void sugov_limits(struct cpufreq_policy
*policy
)
691 struct sugov_policy
*sg_policy
= policy
->governor_data
;
693 if (!policy
->fast_switch_enabled
) {
694 mutex_lock(&sg_policy
->work_lock
);
695 cpufreq_policy_apply_limits(policy
);
696 mutex_unlock(&sg_policy
->work_lock
);
699 sg_policy
->need_freq_update
= true;
702 static struct cpufreq_governor schedutil_gov
= {
704 .owner
= THIS_MODULE
,
705 .dynamic_switching
= true,
708 .start
= sugov_start
,
710 .limits
= sugov_limits
,
713 #ifdef CONFIG_CPU_FREQ_DEFAULT_GOV_SCHEDUTIL
714 struct cpufreq_governor
*cpufreq_default_governor(void)
716 return &schedutil_gov
;
720 static int __init
sugov_register(void)
722 return cpufreq_register_governor(&schedutil_gov
);
724 fs_initcall(sugov_register
);