• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * CPUFreq governor based on scheduler-provided CPU utilization data.
3  *
4  * Copyright (C) 2016, Intel Corporation
5  * Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
6  *
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.
10  */
11 
12 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
13 
14 #include <linux/cpufreq.h>
15 #include <linux/kthread.h>
16 #include <linux/slab.h>
17 #include <trace/events/power.h>
18 
19 #include "sched.h"
20 #include "tune.h"
21 
22 unsigned long boosted_cpu_util(int cpu);
23 
24 /* Stub out fast switch routines present on mainline to reduce the backport
25  * overhead. */
26 #define cpufreq_driver_fast_switch(x, y) 0
27 #define cpufreq_enable_fast_switch(x)
28 #define cpufreq_disable_fast_switch(x)
29 #define LATENCY_MULTIPLIER			(1000)
30 #define SUGOV_KTHREAD_PRIORITY	50
31 
32 struct sugov_tunables {
33 	struct gov_attr_set attr_set;
34 	unsigned int up_rate_limit_us;
35 	unsigned int down_rate_limit_us;
36 };
37 
38 struct sugov_policy {
39 	struct cpufreq_policy *policy;
40 
41 	struct sugov_tunables *tunables;
42 	struct list_head tunables_hook;
43 
44 	raw_spinlock_t update_lock;  /* For shared policies */
45 	u64 last_freq_update_time;
46 	s64 min_rate_limit_ns;
47 	s64 up_rate_delay_ns;
48 	s64 down_rate_delay_ns;
49 	unsigned int next_freq;
50 	unsigned int cached_raw_freq;
51 
52 	/* The next fields are only needed if fast switch cannot be used. */
53 	struct irq_work irq_work;
54 	struct kthread_work work;
55 	struct mutex work_lock;
56 	struct kthread_worker worker;
57 	struct task_struct *thread;
58 	bool work_in_progress;
59 
60 	bool need_freq_update;
61 };
62 
63 struct sugov_cpu {
64 	struct update_util_data update_util;
65 	struct sugov_policy *sg_policy;
66 
67 	unsigned long iowait_boost;
68 	unsigned long iowait_boost_max;
69 	u64 last_update;
70 
71 	/* The fields below are only needed when sharing a policy. */
72 	unsigned long util;
73 	unsigned long max;
74 	unsigned int flags;
75 
76 	/* The field below is for single-CPU policies only. */
77 #ifdef CONFIG_NO_HZ_COMMON
78 	unsigned long saved_idle_calls;
79 #endif
80 };
81 
82 static DEFINE_PER_CPU(struct sugov_cpu, sugov_cpu);
83 
84 /************************ Governor internals ***********************/
85 
sugov_should_update_freq(struct sugov_policy * sg_policy,u64 time)86 static bool sugov_should_update_freq(struct sugov_policy *sg_policy, u64 time)
87 {
88 	s64 delta_ns;
89 
90 	if (sg_policy->work_in_progress)
91 		return false;
92 
93 	if (unlikely(sg_policy->need_freq_update)) {
94 		sg_policy->need_freq_update = false;
95 		/*
96 		 * This happens when limits change, so forget the previous
97 		 * next_freq value and force an update.
98 		 */
99 		sg_policy->next_freq = UINT_MAX;
100 		return true;
101 	}
102 
103 	delta_ns = time - sg_policy->last_freq_update_time;
104 
105 	/* No need to recalculate next freq for min_rate_limit_us at least */
106 	return delta_ns >= sg_policy->min_rate_limit_ns;
107 }
108 
sugov_up_down_rate_limit(struct sugov_policy * sg_policy,u64 time,unsigned int next_freq)109 static bool sugov_up_down_rate_limit(struct sugov_policy *sg_policy, u64 time,
110 				     unsigned int next_freq)
111 {
112 	s64 delta_ns;
113 
114 	delta_ns = time - sg_policy->last_freq_update_time;
115 
116 	if (next_freq > sg_policy->next_freq &&
117 	    delta_ns < sg_policy->up_rate_delay_ns)
118 			return true;
119 
120 	if (next_freq < sg_policy->next_freq &&
121 	    delta_ns < sg_policy->down_rate_delay_ns)
122 			return true;
123 
124 	return false;
125 }
126 
sugov_update_commit(struct sugov_policy * sg_policy,u64 time,unsigned int next_freq)127 static void sugov_update_commit(struct sugov_policy *sg_policy, u64 time,
128 				unsigned int next_freq)
129 {
130 	struct cpufreq_policy *policy = sg_policy->policy;
131 
132 	if (sugov_up_down_rate_limit(sg_policy, time, next_freq)) {
133 		/* Reset cached freq as next_freq isn't changed */
134 		sg_policy->cached_raw_freq = 0;
135 		return;
136 	}
137 
138 	if (sg_policy->next_freq == next_freq)
139 		return;
140 
141 	sg_policy->next_freq = next_freq;
142 	sg_policy->last_freq_update_time = time;
143 
144 	if (policy->fast_switch_enabled) {
145 		next_freq = cpufreq_driver_fast_switch(policy, next_freq);
146 		if (next_freq == CPUFREQ_ENTRY_INVALID)
147 			return;
148 
149 		policy->cur = next_freq;
150 		trace_cpu_frequency(next_freq, smp_processor_id());
151 	} else {
152 		sg_policy->work_in_progress = true;
153 		irq_work_queue(&sg_policy->irq_work);
154 	}
155 }
156 
157 /**
158  * get_next_freq - Compute a new frequency for a given cpufreq policy.
159  * @sg_policy: schedutil policy object to compute the new frequency for.
160  * @util: Current CPU utilization.
161  * @max: CPU capacity.
162  *
163  * If the utilization is frequency-invariant, choose the new frequency to be
164  * proportional to it, that is
165  *
166  * next_freq = C * max_freq * util / max
167  *
168  * Otherwise, approximate the would-be frequency-invariant utilization by
169  * util_raw * (curr_freq / max_freq) which leads to
170  *
171  * next_freq = C * curr_freq * util_raw / max
172  *
173  * Take C = 1.25 for the frequency tipping point at (util / max) = 0.8.
174  *
175  * The lowest driver-supported frequency which is equal or greater than the raw
176  * next_freq (as calculated above) is returned, subject to policy min/max and
177  * cpufreq driver limitations.
178  */
get_next_freq(struct sugov_policy * sg_policy,unsigned long util,unsigned long max)179 static unsigned int get_next_freq(struct sugov_policy *sg_policy,
180 				  unsigned long util, unsigned long max)
181 {
182 	struct cpufreq_policy *policy = sg_policy->policy;
183 	unsigned int freq = arch_scale_freq_invariant() ?
184 				policy->cpuinfo.max_freq : policy->cur;
185 
186 	freq = (freq + (freq >> 2)) * util / max;
187 
188 	if (freq == sg_policy->cached_raw_freq && sg_policy->next_freq != UINT_MAX)
189 		return sg_policy->next_freq;
190 	sg_policy->cached_raw_freq = freq;
191 	return cpufreq_driver_resolve_freq(policy, freq);
192 }
193 
use_pelt(void)194 static inline bool use_pelt(void)
195 {
196 #ifdef CONFIG_SCHED_WALT
197 	return (!sysctl_sched_use_walt_cpu_util || walt_disabled);
198 #else
199 	return true;
200 #endif
201 }
202 
sugov_get_util(unsigned long * util,unsigned long * max,u64 time)203 static void sugov_get_util(unsigned long *util, unsigned long *max, u64 time)
204 {
205 	int cpu = smp_processor_id();
206 	struct rq *rq = cpu_rq(cpu);
207 	unsigned long max_cap, rt;
208 	s64 delta;
209 
210 	max_cap = arch_scale_cpu_capacity(NULL, cpu);
211 
212 	sched_avg_update(rq);
213 	delta = time - rq->age_stamp;
214 	if (unlikely(delta < 0))
215 		delta = 0;
216 	rt = div64_u64(rq->rt_avg, sched_avg_period() + delta);
217 	rt = (rt * max_cap) >> SCHED_CAPACITY_SHIFT;
218 
219 	*util = boosted_cpu_util(cpu);
220 	if (likely(use_pelt()))
221 		*util = min((*util + rt), max_cap);
222 
223 	*max = max_cap;
224 }
225 
sugov_set_iowait_boost(struct sugov_cpu * sg_cpu,u64 time,unsigned int flags)226 static void sugov_set_iowait_boost(struct sugov_cpu *sg_cpu, u64 time,
227 				   unsigned int flags)
228 {
229 	if (flags & SCHED_CPUFREQ_IOWAIT) {
230 		sg_cpu->iowait_boost = sg_cpu->iowait_boost_max;
231 	} else if (sg_cpu->iowait_boost) {
232 		s64 delta_ns = time - sg_cpu->last_update;
233 
234 		/* Clear iowait_boost if the CPU apprears to have been idle. */
235 		if (delta_ns > TICK_NSEC)
236 			sg_cpu->iowait_boost = 0;
237 	}
238 }
239 
sugov_iowait_boost(struct sugov_cpu * sg_cpu,unsigned long * util,unsigned long * max)240 static void sugov_iowait_boost(struct sugov_cpu *sg_cpu, unsigned long *util,
241 			       unsigned long *max)
242 {
243 	unsigned long boost_util = sg_cpu->iowait_boost;
244 	unsigned long boost_max = sg_cpu->iowait_boost_max;
245 
246 	if (!boost_util)
247 		return;
248 
249 	if (*util * boost_max < *max * boost_util) {
250 		*util = boost_util;
251 		*max = boost_max;
252 	}
253 	sg_cpu->iowait_boost >>= 1;
254 }
255 
256 #ifdef CONFIG_NO_HZ_COMMON
sugov_cpu_is_busy(struct sugov_cpu * sg_cpu)257 static bool sugov_cpu_is_busy(struct sugov_cpu *sg_cpu)
258 {
259 	unsigned long idle_calls = tick_nohz_get_idle_calls();
260 	bool ret = idle_calls == sg_cpu->saved_idle_calls;
261 
262 	sg_cpu->saved_idle_calls = idle_calls;
263 	return ret;
264 }
265 #else
sugov_cpu_is_busy(struct sugov_cpu * sg_cpu)266 static inline bool sugov_cpu_is_busy(struct sugov_cpu *sg_cpu) { return false; }
267 #endif /* CONFIG_NO_HZ_COMMON */
268 
sugov_update_single(struct update_util_data * hook,u64 time,unsigned int flags)269 static void sugov_update_single(struct update_util_data *hook, u64 time,
270 				unsigned int flags)
271 {
272 	struct sugov_cpu *sg_cpu = container_of(hook, struct sugov_cpu, update_util);
273 	struct sugov_policy *sg_policy = sg_cpu->sg_policy;
274 	struct cpufreq_policy *policy = sg_policy->policy;
275 	unsigned long util, max;
276 	unsigned int next_f;
277 	bool busy;
278 
279 	sugov_set_iowait_boost(sg_cpu, time, flags);
280 	sg_cpu->last_update = time;
281 
282 	if (!sugov_should_update_freq(sg_policy, time))
283 		return;
284 
285 	busy = sugov_cpu_is_busy(sg_cpu);
286 
287 	if (flags & SCHED_CPUFREQ_DL) {
288 		next_f = policy->cpuinfo.max_freq;
289 	} else {
290 		sugov_get_util(&util, &max, time);
291 		sugov_iowait_boost(sg_cpu, &util, &max);
292 		next_f = get_next_freq(sg_policy, util, max);
293 		/*
294 		 * Do not reduce the frequency if the CPU has not been idle
295 		 * recently, as the reduction is likely to be premature then.
296 		 */
297 		if (busy && next_f < sg_policy->next_freq) {
298 			next_f = sg_policy->next_freq;
299 
300 			/* Reset cached freq as next_freq has changed */
301 			sg_policy->cached_raw_freq = 0;
302 		}
303 	}
304 	sugov_update_commit(sg_policy, time, next_f);
305 }
306 
sugov_next_freq_shared(struct sugov_cpu * sg_cpu)307 static unsigned int sugov_next_freq_shared(struct sugov_cpu *sg_cpu)
308 {
309 	struct sugov_policy *sg_policy = sg_cpu->sg_policy;
310 	struct cpufreq_policy *policy = sg_policy->policy;
311 	u64 last_freq_update_time = sg_policy->last_freq_update_time;
312 	unsigned long util = 0, max = 1;
313 	unsigned int j;
314 
315 	for_each_cpu(j, policy->cpus) {
316 		struct sugov_cpu *j_sg_cpu = &per_cpu(sugov_cpu, j);
317 		unsigned long j_util, j_max;
318 		s64 delta_ns;
319 
320 		/*
321 		 * If the CPU utilization was last updated before the previous
322 		 * frequency update and the time elapsed between the last update
323 		 * of the CPU utilization and the last frequency update is long
324 		 * enough, don't take the CPU into account as it probably is
325 		 * idle now (and clear iowait_boost for it).
326 		 */
327 		delta_ns = last_freq_update_time - j_sg_cpu->last_update;
328 		if (delta_ns > TICK_NSEC) {
329 			j_sg_cpu->iowait_boost = 0;
330 			continue;
331 		}
332 		if (j_sg_cpu->flags & SCHED_CPUFREQ_DL)
333 			return policy->cpuinfo.max_freq;
334 
335 		j_util = j_sg_cpu->util;
336 		j_max = j_sg_cpu->max;
337 		if (j_util * max > j_max * util) {
338 			util = j_util;
339 			max = j_max;
340 		}
341 
342 		sugov_iowait_boost(j_sg_cpu, &util, &max);
343 	}
344 
345 	return get_next_freq(sg_policy, util, max);
346 }
347 
sugov_update_shared(struct update_util_data * hook,u64 time,unsigned int flags)348 static void sugov_update_shared(struct update_util_data *hook, u64 time,
349 				unsigned int flags)
350 {
351 	struct sugov_cpu *sg_cpu = container_of(hook, struct sugov_cpu, update_util);
352 	struct sugov_policy *sg_policy = sg_cpu->sg_policy;
353 	unsigned long util, max;
354 	unsigned int next_f;
355 
356 	sugov_get_util(&util, &max, time);
357 
358 	raw_spin_lock(&sg_policy->update_lock);
359 
360 	sg_cpu->util = util;
361 	sg_cpu->max = max;
362 	sg_cpu->flags = flags;
363 
364 	sugov_set_iowait_boost(sg_cpu, time, flags);
365 	sg_cpu->last_update = time;
366 
367 	if (sugov_should_update_freq(sg_policy, time)) {
368 		if (flags & SCHED_CPUFREQ_DL)
369 			next_f = sg_policy->policy->cpuinfo.max_freq;
370 		else
371 			next_f = sugov_next_freq_shared(sg_cpu);
372 
373 		sugov_update_commit(sg_policy, time, next_f);
374 	}
375 
376 	raw_spin_unlock(&sg_policy->update_lock);
377 }
378 
sugov_work(struct kthread_work * work)379 static void sugov_work(struct kthread_work *work)
380 {
381 	struct sugov_policy *sg_policy = container_of(work, struct sugov_policy, work);
382 
383 	mutex_lock(&sg_policy->work_lock);
384 	__cpufreq_driver_target(sg_policy->policy, sg_policy->next_freq,
385 				CPUFREQ_RELATION_L);
386 	mutex_unlock(&sg_policy->work_lock);
387 
388 	sg_policy->work_in_progress = false;
389 }
390 
sugov_irq_work(struct irq_work * irq_work)391 static void sugov_irq_work(struct irq_work *irq_work)
392 {
393 	struct sugov_policy *sg_policy;
394 
395 	sg_policy = container_of(irq_work, struct sugov_policy, irq_work);
396 
397 	/*
398 	 * For RT and deadline tasks, the schedutil governor shoots the
399 	 * frequency to maximum. Special care must be taken to ensure that this
400 	 * kthread doesn't result in the same behavior.
401 	 *
402 	 * This is (mostly) guaranteed by the work_in_progress flag. The flag is
403 	 * updated only at the end of the sugov_work() function and before that
404 	 * the schedutil governor rejects all other frequency scaling requests.
405 	 *
406 	 * There is a very rare case though, where the RT thread yields right
407 	 * after the work_in_progress flag is cleared. The effects of that are
408 	 * neglected for now.
409 	 */
410 	kthread_queue_work(&sg_policy->worker, &sg_policy->work);
411 }
412 
413 /************************** sysfs interface ************************/
414 
415 static struct sugov_tunables *global_tunables;
416 static DEFINE_MUTEX(global_tunables_lock);
417 
to_sugov_tunables(struct gov_attr_set * attr_set)418 static inline struct sugov_tunables *to_sugov_tunables(struct gov_attr_set *attr_set)
419 {
420 	return container_of(attr_set, struct sugov_tunables, attr_set);
421 }
422 
423 static DEFINE_MUTEX(min_rate_lock);
424 
update_min_rate_limit_us(struct sugov_policy * sg_policy)425 static void update_min_rate_limit_us(struct sugov_policy *sg_policy)
426 {
427 	mutex_lock(&min_rate_lock);
428 	sg_policy->min_rate_limit_ns = min(sg_policy->up_rate_delay_ns,
429 					   sg_policy->down_rate_delay_ns);
430 	mutex_unlock(&min_rate_lock);
431 }
432 
up_rate_limit_us_show(struct gov_attr_set * attr_set,char * buf)433 static ssize_t up_rate_limit_us_show(struct gov_attr_set *attr_set, char *buf)
434 {
435 	struct sugov_tunables *tunables = to_sugov_tunables(attr_set);
436 
437 	return sprintf(buf, "%u\n", tunables->up_rate_limit_us);
438 }
439 
down_rate_limit_us_show(struct gov_attr_set * attr_set,char * buf)440 static ssize_t down_rate_limit_us_show(struct gov_attr_set *attr_set, char *buf)
441 {
442 	struct sugov_tunables *tunables = to_sugov_tunables(attr_set);
443 
444 	return sprintf(buf, "%u\n", tunables->down_rate_limit_us);
445 }
446 
up_rate_limit_us_store(struct gov_attr_set * attr_set,const char * buf,size_t count)447 static ssize_t up_rate_limit_us_store(struct gov_attr_set *attr_set,
448 				      const char *buf, size_t count)
449 {
450 	struct sugov_tunables *tunables = to_sugov_tunables(attr_set);
451 	struct sugov_policy *sg_policy;
452 	unsigned int rate_limit_us;
453 
454 	if (kstrtouint(buf, 10, &rate_limit_us))
455 		return -EINVAL;
456 
457 	tunables->up_rate_limit_us = rate_limit_us;
458 
459 	list_for_each_entry(sg_policy, &attr_set->policy_list, tunables_hook) {
460 		sg_policy->up_rate_delay_ns = rate_limit_us * NSEC_PER_USEC;
461 		update_min_rate_limit_us(sg_policy);
462 	}
463 
464 	return count;
465 }
466 
down_rate_limit_us_store(struct gov_attr_set * attr_set,const char * buf,size_t count)467 static ssize_t down_rate_limit_us_store(struct gov_attr_set *attr_set,
468 					const char *buf, size_t count)
469 {
470 	struct sugov_tunables *tunables = to_sugov_tunables(attr_set);
471 	struct sugov_policy *sg_policy;
472 	unsigned int rate_limit_us;
473 
474 	if (kstrtouint(buf, 10, &rate_limit_us))
475 		return -EINVAL;
476 
477 	tunables->down_rate_limit_us = rate_limit_us;
478 
479 	list_for_each_entry(sg_policy, &attr_set->policy_list, tunables_hook) {
480 		sg_policy->down_rate_delay_ns = rate_limit_us * NSEC_PER_USEC;
481 		update_min_rate_limit_us(sg_policy);
482 	}
483 
484 	return count;
485 }
486 
487 static struct governor_attr up_rate_limit_us = __ATTR_RW(up_rate_limit_us);
488 static struct governor_attr down_rate_limit_us = __ATTR_RW(down_rate_limit_us);
489 
490 static struct attribute *sugov_attributes[] = {
491 	&up_rate_limit_us.attr,
492 	&down_rate_limit_us.attr,
493 	NULL
494 };
495 
496 static struct kobj_type sugov_tunables_ktype = {
497 	.default_attrs = sugov_attributes,
498 	.sysfs_ops = &governor_sysfs_ops,
499 };
500 
501 /********************** cpufreq governor interface *********************/
502 
503 static struct cpufreq_governor schedutil_gov;
504 
sugov_policy_alloc(struct cpufreq_policy * policy)505 static struct sugov_policy *sugov_policy_alloc(struct cpufreq_policy *policy)
506 {
507 	struct sugov_policy *sg_policy;
508 
509 	sg_policy = kzalloc(sizeof(*sg_policy), GFP_KERNEL);
510 	if (!sg_policy)
511 		return NULL;
512 
513 	sg_policy->policy = policy;
514 	raw_spin_lock_init(&sg_policy->update_lock);
515 	return sg_policy;
516 }
517 
sugov_policy_free(struct sugov_policy * sg_policy)518 static void sugov_policy_free(struct sugov_policy *sg_policy)
519 {
520 	kfree(sg_policy);
521 }
522 
sugov_kthread_create(struct sugov_policy * sg_policy)523 static int sugov_kthread_create(struct sugov_policy *sg_policy)
524 {
525 	struct task_struct *thread;
526 	struct sched_param param = { .sched_priority = MAX_USER_RT_PRIO / 2 };
527 	struct cpufreq_policy *policy = sg_policy->policy;
528 	int ret;
529 
530 	/* kthread only required for slow path */
531 	if (policy->fast_switch_enabled)
532 		return 0;
533 
534 	kthread_init_work(&sg_policy->work, sugov_work);
535 	kthread_init_worker(&sg_policy->worker);
536 	thread = kthread_create(kthread_worker_fn, &sg_policy->worker,
537 				"sugov:%d",
538 				cpumask_first(policy->related_cpus));
539 	if (IS_ERR(thread)) {
540 		pr_err("failed to create sugov thread: %ld\n", PTR_ERR(thread));
541 		return PTR_ERR(thread);
542 	}
543 
544 	ret = sched_setscheduler_nocheck(thread, SCHED_FIFO, &param);
545 	if (ret) {
546 		kthread_stop(thread);
547 		pr_warn("%s: failed to set SCHED_FIFO\n", __func__);
548 		return ret;
549 	}
550 
551 	sg_policy->thread = thread;
552 	kthread_bind_mask(thread, policy->related_cpus);
553 	init_irq_work(&sg_policy->irq_work, sugov_irq_work);
554 	mutex_init(&sg_policy->work_lock);
555 
556 	wake_up_process(thread);
557 
558 	return 0;
559 }
560 
sugov_kthread_stop(struct sugov_policy * sg_policy)561 static void sugov_kthread_stop(struct sugov_policy *sg_policy)
562 {
563 	/* kthread only required for slow path */
564 	if (sg_policy->policy->fast_switch_enabled)
565 		return;
566 
567 	kthread_flush_worker(&sg_policy->worker);
568 	kthread_stop(sg_policy->thread);
569 	mutex_destroy(&sg_policy->work_lock);
570 }
571 
sugov_tunables_alloc(struct sugov_policy * sg_policy)572 static struct sugov_tunables *sugov_tunables_alloc(struct sugov_policy *sg_policy)
573 {
574 	struct sugov_tunables *tunables;
575 
576 	tunables = kzalloc(sizeof(*tunables), GFP_KERNEL);
577 	if (tunables) {
578 		gov_attr_set_init(&tunables->attr_set, &sg_policy->tunables_hook);
579 		if (!have_governor_per_policy())
580 			global_tunables = tunables;
581 	}
582 	return tunables;
583 }
584 
sugov_tunables_free(struct sugov_tunables * tunables)585 static void sugov_tunables_free(struct sugov_tunables *tunables)
586 {
587 	if (!have_governor_per_policy())
588 		global_tunables = NULL;
589 
590 	kfree(tunables);
591 }
592 
sugov_init(struct cpufreq_policy * policy)593 static int sugov_init(struct cpufreq_policy *policy)
594 {
595 	struct sugov_policy *sg_policy;
596 	struct sugov_tunables *tunables;
597 	int ret = 0;
598 
599 	/* State should be equivalent to EXIT */
600 	if (policy->governor_data)
601 		return -EBUSY;
602 
603 	cpufreq_enable_fast_switch(policy);
604 
605 	sg_policy = sugov_policy_alloc(policy);
606 	if (!sg_policy) {
607 		ret = -ENOMEM;
608 		goto disable_fast_switch;
609 	}
610 
611 	ret = sugov_kthread_create(sg_policy);
612 	if (ret)
613 		goto free_sg_policy;
614 
615 	mutex_lock(&global_tunables_lock);
616 
617 	if (global_tunables) {
618 		if (WARN_ON(have_governor_per_policy())) {
619 			ret = -EINVAL;
620 			goto stop_kthread;
621 		}
622 		policy->governor_data = sg_policy;
623 		sg_policy->tunables = global_tunables;
624 
625 		gov_attr_set_get(&global_tunables->attr_set, &sg_policy->tunables_hook);
626 		goto out;
627 	}
628 
629 	tunables = sugov_tunables_alloc(sg_policy);
630 	if (!tunables) {
631 		ret = -ENOMEM;
632 		goto stop_kthread;
633 	}
634 
635 	if (policy->up_transition_delay_us && policy->down_transition_delay_us) {
636 		tunables->up_rate_limit_us = policy->up_transition_delay_us;
637 		tunables->down_rate_limit_us = policy->down_transition_delay_us;
638 	} else {
639 		unsigned int lat;
640 
641                 tunables->up_rate_limit_us = LATENCY_MULTIPLIER;
642                 tunables->down_rate_limit_us = LATENCY_MULTIPLIER;
643 		lat = policy->cpuinfo.transition_latency / NSEC_PER_USEC;
644 		if (lat) {
645                         tunables->up_rate_limit_us *= lat;
646                         tunables->down_rate_limit_us *= lat;
647                 }
648 	}
649 
650 	policy->governor_data = sg_policy;
651 	sg_policy->tunables = tunables;
652 
653 	ret = kobject_init_and_add(&tunables->attr_set.kobj, &sugov_tunables_ktype,
654 				   get_governor_parent_kobj(policy), "%s",
655 				   schedutil_gov.name);
656 	if (ret)
657 		goto fail;
658 
659 out:
660 	mutex_unlock(&global_tunables_lock);
661 	return 0;
662 
663 fail:
664 	policy->governor_data = NULL;
665 	sugov_tunables_free(tunables);
666 
667  stop_kthread:
668 	sugov_kthread_stop(sg_policy);
669 
670  free_sg_policy:
671 	mutex_unlock(&global_tunables_lock);
672 
673 	sugov_policy_free(sg_policy);
674 
675 disable_fast_switch:
676 	cpufreq_disable_fast_switch(policy);
677 
678 	pr_err("initialization failed (error %d)\n", ret);
679 	return ret;
680 }
681 
sugov_exit(struct cpufreq_policy * policy)682 static void sugov_exit(struct cpufreq_policy *policy)
683 {
684 	struct sugov_policy *sg_policy = policy->governor_data;
685 	struct sugov_tunables *tunables = sg_policy->tunables;
686 	unsigned int count;
687 
688 	mutex_lock(&global_tunables_lock);
689 
690 	count = gov_attr_set_put(&tunables->attr_set, &sg_policy->tunables_hook);
691 	policy->governor_data = NULL;
692 	if (!count)
693 		sugov_tunables_free(tunables);
694 
695 	mutex_unlock(&global_tunables_lock);
696 
697 	sugov_kthread_stop(sg_policy);
698 	sugov_policy_free(sg_policy);
699 
700 	cpufreq_disable_fast_switch(policy);
701 }
702 
sugov_start(struct cpufreq_policy * policy)703 static int sugov_start(struct cpufreq_policy *policy)
704 {
705 	struct sugov_policy *sg_policy = policy->governor_data;
706 	unsigned int cpu;
707 
708 	sg_policy->up_rate_delay_ns =
709 		sg_policy->tunables->up_rate_limit_us * NSEC_PER_USEC;
710 	sg_policy->down_rate_delay_ns =
711 		sg_policy->tunables->down_rate_limit_us * NSEC_PER_USEC;
712 	update_min_rate_limit_us(sg_policy);
713 	sg_policy->last_freq_update_time = 0;
714 	sg_policy->next_freq = UINT_MAX;
715 	sg_policy->work_in_progress = false;
716 	sg_policy->need_freq_update = false;
717 	sg_policy->cached_raw_freq = 0;
718 
719 	for_each_cpu(cpu, policy->cpus) {
720 		struct sugov_cpu *sg_cpu = &per_cpu(sugov_cpu, cpu);
721 
722 		memset(sg_cpu, 0, sizeof(*sg_cpu));
723 		sg_cpu->sg_policy = sg_policy;
724 		sg_cpu->flags = SCHED_CPUFREQ_DL;
725 		sg_cpu->iowait_boost_max = policy->cpuinfo.max_freq;
726 		cpufreq_add_update_util_hook(cpu, &sg_cpu->update_util,
727 					     policy_is_shared(policy) ?
728 							sugov_update_shared :
729 							sugov_update_single);
730 	}
731 	return 0;
732 }
733 
sugov_stop(struct cpufreq_policy * policy)734 static void sugov_stop(struct cpufreq_policy *policy)
735 {
736 	struct sugov_policy *sg_policy = policy->governor_data;
737 	unsigned int cpu;
738 
739 	for_each_cpu(cpu, policy->cpus)
740 		cpufreq_remove_update_util_hook(cpu);
741 
742 	synchronize_sched();
743 
744 	if (!policy->fast_switch_enabled) {
745 		irq_work_sync(&sg_policy->irq_work);
746 		kthread_cancel_work_sync(&sg_policy->work);
747 	}
748 }
749 
sugov_limits(struct cpufreq_policy * policy)750 static void sugov_limits(struct cpufreq_policy *policy)
751 {
752 	struct sugov_policy *sg_policy = policy->governor_data;
753 
754 	if (!policy->fast_switch_enabled) {
755 		mutex_lock(&sg_policy->work_lock);
756 		cpufreq_policy_apply_limits(policy);
757 		mutex_unlock(&sg_policy->work_lock);
758 	}
759 
760 	sg_policy->need_freq_update = true;
761 }
762 
763 static struct cpufreq_governor schedutil_gov = {
764 	.name = "schedutil",
765 	.owner = THIS_MODULE,
766 	.init = sugov_init,
767 	.exit = sugov_exit,
768 	.start = sugov_start,
769 	.stop = sugov_stop,
770 	.limits = sugov_limits,
771 };
772 
773 #ifdef CONFIG_CPU_FREQ_DEFAULT_GOV_SCHEDUTIL
cpufreq_default_governor(void)774 struct cpufreq_governor *cpufreq_default_governor(void)
775 {
776 	return &schedutil_gov;
777 }
778 #endif
779 
sugov_register(void)780 static int __init sugov_register(void)
781 {
782 	return cpufreq_register_governor(&schedutil_gov);
783 }
784 fs_initcall(sugov_register);
785