Merge branch 'egalax' into for-linus
[pandora-kernel.git] / drivers / cpuidle / governors / menu.c
1 /*
2  * menu.c - the menu idle governor
3  *
4  * Copyright (C) 2006-2007 Adam Belay <abelay@novell.com>
5  * Copyright (C) 2009 Intel Corporation
6  * Author:
7  *        Arjan van de Ven <arjan@linux.intel.com>
8  *
9  * This code is licenced under the GPL version 2 as described
10  * in the COPYING file that acompanies the Linux Kernel.
11  */
12
13 #include <linux/kernel.h>
14 #include <linux/cpuidle.h>
15 #include <linux/pm_qos_params.h>
16 #include <linux/time.h>
17 #include <linux/ktime.h>
18 #include <linux/hrtimer.h>
19 #include <linux/tick.h>
20 #include <linux/sched.h>
21 #include <linux/math64.h>
22
23 #define BUCKETS 12
24 #define RESOLUTION 1024
25 #define DECAY 4
26 #define MAX_INTERESTING 50000
27
28 /*
29  * Concepts and ideas behind the menu governor
30  *
31  * For the menu governor, there are 3 decision factors for picking a C
32  * state:
33  * 1) Energy break even point
34  * 2) Performance impact
35  * 3) Latency tolerance (from pmqos infrastructure)
36  * These these three factors are treated independently.
37  *
38  * Energy break even point
39  * -----------------------
40  * C state entry and exit have an energy cost, and a certain amount of time in
41  * the  C state is required to actually break even on this cost. CPUIDLE
42  * provides us this duration in the "target_residency" field. So all that we
43  * need is a good prediction of how long we'll be idle. Like the traditional
44  * menu governor, we start with the actual known "next timer event" time.
45  *
46  * Since there are other source of wakeups (interrupts for example) than
47  * the next timer event, this estimation is rather optimistic. To get a
48  * more realistic estimate, a correction factor is applied to the estimate,
49  * that is based on historic behavior. For example, if in the past the actual
50  * duration always was 50% of the next timer tick, the correction factor will
51  * be 0.5.
52  *
53  * menu uses a running average for this correction factor, however it uses a
54  * set of factors, not just a single factor. This stems from the realization
55  * that the ratio is dependent on the order of magnitude of the expected
56  * duration; if we expect 500 milliseconds of idle time the likelihood of
57  * getting an interrupt very early is much higher than if we expect 50 micro
58  * seconds of idle time. A second independent factor that has big impact on
59  * the actual factor is if there is (disk) IO outstanding or not.
60  * (as a special twist, we consider every sleep longer than 50 milliseconds
61  * as perfect; there are no power gains for sleeping longer than this)
62  *
63  * For these two reasons we keep an array of 12 independent factors, that gets
64  * indexed based on the magnitude of the expected duration as well as the
65  * "is IO outstanding" property.
66  *
67  * Limiting Performance Impact
68  * ---------------------------
69  * C states, especially those with large exit latencies, can have a real
70  * noticable impact on workloads, which is not acceptable for most sysadmins,
71  * and in addition, less performance has a power price of its own.
72  *
73  * As a general rule of thumb, menu assumes that the following heuristic
74  * holds:
75  *     The busier the system, the less impact of C states is acceptable
76  *
77  * This rule-of-thumb is implemented using a performance-multiplier:
78  * If the exit latency times the performance multiplier is longer than
79  * the predicted duration, the C state is not considered a candidate
80  * for selection due to a too high performance impact. So the higher
81  * this multiplier is, the longer we need to be idle to pick a deep C
82  * state, and thus the less likely a busy CPU will hit such a deep
83  * C state.
84  *
85  * Two factors are used in determing this multiplier:
86  * a value of 10 is added for each point of "per cpu load average" we have.
87  * a value of 5 points is added for each process that is waiting for
88  * IO on this CPU.
89  * (these values are experimentally determined)
90  *
91  * The load average factor gives a longer term (few seconds) input to the
92  * decision, while the iowait value gives a cpu local instantanious input.
93  * The iowait factor may look low, but realize that this is also already
94  * represented in the system load average.
95  *
96  */
97
98 struct menu_device {
99         int             last_state_idx;
100         int             needs_update;
101
102         unsigned int    expected_us;
103         u64             predicted_us;
104         unsigned int    exit_us;
105         unsigned int    bucket;
106         u64             correction_factor[BUCKETS];
107 };
108
109
110 #define LOAD_INT(x) ((x) >> FSHIFT)
111 #define LOAD_FRAC(x) LOAD_INT(((x) & (FIXED_1-1)) * 100)
112
113 static int get_loadavg(void)
114 {
115         unsigned long this = this_cpu_load();
116
117
118         return LOAD_INT(this) * 10 + LOAD_FRAC(this) / 10;
119 }
120
121 static inline int which_bucket(unsigned int duration)
122 {
123         int bucket = 0;
124
125         /*
126          * We keep two groups of stats; one with no
127          * IO pending, one without.
128          * This allows us to calculate
129          * E(duration)|iowait
130          */
131         if (nr_iowait_cpu())
132                 bucket = BUCKETS/2;
133
134         if (duration < 10)
135                 return bucket;
136         if (duration < 100)
137                 return bucket + 1;
138         if (duration < 1000)
139                 return bucket + 2;
140         if (duration < 10000)
141                 return bucket + 3;
142         if (duration < 100000)
143                 return bucket + 4;
144         return bucket + 5;
145 }
146
147 /*
148  * Return a multiplier for the exit latency that is intended
149  * to take performance requirements into account.
150  * The more performance critical we estimate the system
151  * to be, the higher this multiplier, and thus the higher
152  * the barrier to go to an expensive C state.
153  */
154 static inline int performance_multiplier(void)
155 {
156         int mult = 1;
157
158         /* for higher loadavg, we are more reluctant */
159
160         mult += 2 * get_loadavg();
161
162         /* for IO wait tasks (per cpu!) we add 5x each */
163         mult += 10 * nr_iowait_cpu();
164
165         return mult;
166 }
167
168 static DEFINE_PER_CPU(struct menu_device, menu_devices);
169
170 static void menu_update(struct cpuidle_device *dev);
171
172 /* This implements DIV_ROUND_CLOSEST but avoids 64 bit division */
173 static u64 div_round64(u64 dividend, u32 divisor)
174 {
175         return div_u64(dividend + (divisor / 2), divisor);
176 }
177
178 /**
179  * menu_select - selects the next idle state to enter
180  * @dev: the CPU
181  */
182 static int menu_select(struct cpuidle_device *dev)
183 {
184         struct menu_device *data = &__get_cpu_var(menu_devices);
185         int latency_req = pm_qos_requirement(PM_QOS_CPU_DMA_LATENCY);
186         int i;
187         int multiplier;
188
189         if (data->needs_update) {
190                 menu_update(dev);
191                 data->needs_update = 0;
192         }
193
194         data->last_state_idx = 0;
195         data->exit_us = 0;
196
197         /* Special case when user has set very strict latency requirement */
198         if (unlikely(latency_req == 0))
199                 return 0;
200
201         /* determine the expected residency time, round up */
202         data->expected_us =
203             DIV_ROUND_UP((u32)ktime_to_ns(tick_nohz_get_sleep_length()), 1000);
204
205
206         data->bucket = which_bucket(data->expected_us);
207
208         multiplier = performance_multiplier();
209
210         /*
211          * if the correction factor is 0 (eg first time init or cpu hotplug
212          * etc), we actually want to start out with a unity factor.
213          */
214         if (data->correction_factor[data->bucket] == 0)
215                 data->correction_factor[data->bucket] = RESOLUTION * DECAY;
216
217         /* Make sure to round up for half microseconds */
218         data->predicted_us = div_round64(data->expected_us * data->correction_factor[data->bucket],
219                                          RESOLUTION * DECAY);
220
221         /*
222          * We want to default to C1 (hlt), not to busy polling
223          * unless the timer is happening really really soon.
224          */
225         if (data->expected_us > 5)
226                 data->last_state_idx = CPUIDLE_DRIVER_STATE_START;
227
228
229         /* find the deepest idle state that satisfies our constraints */
230         for (i = CPUIDLE_DRIVER_STATE_START; i < dev->state_count; i++) {
231                 struct cpuidle_state *s = &dev->states[i];
232
233                 if (s->target_residency > data->predicted_us)
234                         break;
235                 if (s->exit_latency > latency_req)
236                         break;
237                 if (s->exit_latency * multiplier > data->predicted_us)
238                         break;
239                 data->exit_us = s->exit_latency;
240                 data->last_state_idx = i;
241         }
242
243         return data->last_state_idx;
244 }
245
246 /**
247  * menu_reflect - records that data structures need update
248  * @dev: the CPU
249  *
250  * NOTE: it's important to be fast here because this operation will add to
251  *       the overall exit latency.
252  */
253 static void menu_reflect(struct cpuidle_device *dev)
254 {
255         struct menu_device *data = &__get_cpu_var(menu_devices);
256         data->needs_update = 1;
257 }
258
259 /**
260  * menu_update - attempts to guess what happened after entry
261  * @dev: the CPU
262  */
263 static void menu_update(struct cpuidle_device *dev)
264 {
265         struct menu_device *data = &__get_cpu_var(menu_devices);
266         int last_idx = data->last_state_idx;
267         unsigned int last_idle_us = cpuidle_get_last_residency(dev);
268         struct cpuidle_state *target = &dev->states[last_idx];
269         unsigned int measured_us;
270         u64 new_factor;
271
272         /*
273          * Ugh, this idle state doesn't support residency measurements, so we
274          * are basically lost in the dark.  As a compromise, assume we slept
275          * for the whole expected time.
276          */
277         if (unlikely(!(target->flags & CPUIDLE_FLAG_TIME_VALID)))
278                 last_idle_us = data->expected_us;
279
280
281         measured_us = last_idle_us;
282
283         /*
284          * We correct for the exit latency; we are assuming here that the
285          * exit latency happens after the event that we're interested in.
286          */
287         if (measured_us > data->exit_us)
288                 measured_us -= data->exit_us;
289
290
291         /* update our correction ratio */
292
293         new_factor = data->correction_factor[data->bucket]
294                         * (DECAY - 1) / DECAY;
295
296         if (data->expected_us > 0 && measured_us < MAX_INTERESTING)
297                 new_factor += RESOLUTION * measured_us / data->expected_us;
298         else
299                 /*
300                  * we were idle so long that we count it as a perfect
301                  * prediction
302                  */
303                 new_factor += RESOLUTION;
304
305         /*
306          * We don't want 0 as factor; we always want at least
307          * a tiny bit of estimated time.
308          */
309         if (new_factor == 0)
310                 new_factor = 1;
311
312         data->correction_factor[data->bucket] = new_factor;
313 }
314
315 /**
316  * menu_enable_device - scans a CPU's states and does setup
317  * @dev: the CPU
318  */
319 static int menu_enable_device(struct cpuidle_device *dev)
320 {
321         struct menu_device *data = &per_cpu(menu_devices, dev->cpu);
322
323         memset(data, 0, sizeof(struct menu_device));
324
325         return 0;
326 }
327
328 static struct cpuidle_governor menu_governor = {
329         .name =         "menu",
330         .rating =       20,
331         .enable =       menu_enable_device,
332         .select =       menu_select,
333         .reflect =      menu_reflect,
334         .owner =        THIS_MODULE,
335 };
336
337 /**
338  * init_menu - initializes the governor
339  */
340 static int __init init_menu(void)
341 {
342         return cpuidle_register_governor(&menu_governor);
343 }
344
345 /**
346  * exit_menu - exits the governor
347  */
348 static void __exit exit_menu(void)
349 {
350         cpuidle_unregister_governor(&menu_governor);
351 }
352
353 MODULE_LICENSE("GPL");
354 module_init(init_menu);
355 module_exit(exit_menu);