block, bfq: remove wrong lock in bfq_requests_merged
[platform/kernel/linux-rpi.git] / block / bfq-iosched.c
1 /*
2  * Budget Fair Queueing (BFQ) I/O scheduler.
3  *
4  * Based on ideas and code from CFQ:
5  * Copyright (C) 2003 Jens Axboe <axboe@kernel.dk>
6  *
7  * Copyright (C) 2008 Fabio Checconi <fabio@gandalf.sssup.it>
8  *                    Paolo Valente <paolo.valente@unimore.it>
9  *
10  * Copyright (C) 2010 Paolo Valente <paolo.valente@unimore.it>
11  *                    Arianna Avanzini <avanzini@google.com>
12  *
13  * Copyright (C) 2017 Paolo Valente <paolo.valente@linaro.org>
14  *
15  *  This program is free software; you can redistribute it and/or
16  *  modify it under the terms of the GNU General Public License as
17  *  published by the Free Software Foundation; either version 2 of the
18  *  License, or (at your option) any later version.
19  *
20  *  This program is distributed in the hope that it will be useful,
21  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
22  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
23  *  General Public License for more details.
24  *
25  * BFQ is a proportional-share I/O scheduler, with some extra
26  * low-latency capabilities. BFQ also supports full hierarchical
27  * scheduling through cgroups. Next paragraphs provide an introduction
28  * on BFQ inner workings. Details on BFQ benefits, usage and
29  * limitations can be found in Documentation/block/bfq-iosched.txt.
30  *
31  * BFQ is a proportional-share storage-I/O scheduling algorithm based
32  * on the slice-by-slice service scheme of CFQ. But BFQ assigns
33  * budgets, measured in number of sectors, to processes instead of
34  * time slices. The device is not granted to the in-service process
35  * for a given time slice, but until it has exhausted its assigned
36  * budget. This change from the time to the service domain enables BFQ
37  * to distribute the device throughput among processes as desired,
38  * without any distortion due to throughput fluctuations, or to device
39  * internal queueing. BFQ uses an ad hoc internal scheduler, called
40  * B-WF2Q+, to schedule processes according to their budgets. More
41  * precisely, BFQ schedules queues associated with processes. Each
42  * process/queue is assigned a user-configurable weight, and B-WF2Q+
43  * guarantees that each queue receives a fraction of the throughput
44  * proportional to its weight. Thanks to the accurate policy of
45  * B-WF2Q+, BFQ can afford to assign high budgets to I/O-bound
46  * processes issuing sequential requests (to boost the throughput),
47  * and yet guarantee a low latency to interactive and soft real-time
48  * applications.
49  *
50  * In particular, to provide these low-latency guarantees, BFQ
51  * explicitly privileges the I/O of two classes of time-sensitive
52  * applications: interactive and soft real-time. This feature enables
53  * BFQ to provide applications in these classes with a very low
54  * latency. Finally, BFQ also features additional heuristics for
55  * preserving both a low latency and a high throughput on NCQ-capable,
56  * rotational or flash-based devices, and to get the job done quickly
57  * for applications consisting in many I/O-bound processes.
58  *
59  * NOTE: if the main or only goal, with a given device, is to achieve
60  * the maximum-possible throughput at all times, then do switch off
61  * all low-latency heuristics for that device, by setting low_latency
62  * to 0.
63  *
64  * BFQ is described in [1], where also a reference to the initial, more
65  * theoretical paper on BFQ can be found. The interested reader can find
66  * in the latter paper full details on the main algorithm, as well as
67  * formulas of the guarantees and formal proofs of all the properties.
68  * With respect to the version of BFQ presented in these papers, this
69  * implementation adds a few more heuristics, such as the one that
70  * guarantees a low latency to soft real-time applications, and a
71  * hierarchical extension based on H-WF2Q+.
72  *
73  * B-WF2Q+ is based on WF2Q+, which is described in [2], together with
74  * H-WF2Q+, while the augmented tree used here to implement B-WF2Q+
75  * with O(log N) complexity derives from the one introduced with EEVDF
76  * in [3].
77  *
78  * [1] P. Valente, A. Avanzini, "Evolution of the BFQ Storage I/O
79  *     Scheduler", Proceedings of the First Workshop on Mobile System
80  *     Technologies (MST-2015), May 2015.
81  *     http://algogroup.unimore.it/people/paolo/disk_sched/mst-2015.pdf
82  *
83  * [2] Jon C.R. Bennett and H. Zhang, "Hierarchical Packet Fair Queueing
84  *     Algorithms", IEEE/ACM Transactions on Networking, 5(5):675-689,
85  *     Oct 1997.
86  *
87  * http://www.cs.cmu.edu/~hzhang/papers/TON-97-Oct.ps.gz
88  *
89  * [3] I. Stoica and H. Abdel-Wahab, "Earliest Eligible Virtual Deadline
90  *     First: A Flexible and Accurate Mechanism for Proportional Share
91  *     Resource Allocation", technical report.
92  *
93  * http://www.cs.berkeley.edu/~istoica/papers/eevdf-tr-95.pdf
94  */
95 #include <linux/module.h>
96 #include <linux/slab.h>
97 #include <linux/blkdev.h>
98 #include <linux/cgroup.h>
99 #include <linux/elevator.h>
100 #include <linux/ktime.h>
101 #include <linux/rbtree.h>
102 #include <linux/ioprio.h>
103 #include <linux/sbitmap.h>
104 #include <linux/delay.h>
105
106 #include "blk.h"
107 #include "blk-mq.h"
108 #include "blk-mq-tag.h"
109 #include "blk-mq-sched.h"
110 #include "bfq-iosched.h"
111 #include "blk-wbt.h"
112
113 #define BFQ_BFQQ_FNS(name)                                              \
114 void bfq_mark_bfqq_##name(struct bfq_queue *bfqq)                       \
115 {                                                                       \
116         __set_bit(BFQQF_##name, &(bfqq)->flags);                        \
117 }                                                                       \
118 void bfq_clear_bfqq_##name(struct bfq_queue *bfqq)                      \
119 {                                                                       \
120         __clear_bit(BFQQF_##name, &(bfqq)->flags);              \
121 }                                                                       \
122 int bfq_bfqq_##name(const struct bfq_queue *bfqq)                       \
123 {                                                                       \
124         return test_bit(BFQQF_##name, &(bfqq)->flags);          \
125 }
126
127 BFQ_BFQQ_FNS(just_created);
128 BFQ_BFQQ_FNS(busy);
129 BFQ_BFQQ_FNS(wait_request);
130 BFQ_BFQQ_FNS(non_blocking_wait_rq);
131 BFQ_BFQQ_FNS(fifo_expire);
132 BFQ_BFQQ_FNS(has_short_ttime);
133 BFQ_BFQQ_FNS(sync);
134 BFQ_BFQQ_FNS(IO_bound);
135 BFQ_BFQQ_FNS(in_large_burst);
136 BFQ_BFQQ_FNS(coop);
137 BFQ_BFQQ_FNS(split_coop);
138 BFQ_BFQQ_FNS(softrt_update);
139 #undef BFQ_BFQQ_FNS                                             \
140
141 /* Expiration time of sync (0) and async (1) requests, in ns. */
142 static const u64 bfq_fifo_expire[2] = { NSEC_PER_SEC / 4, NSEC_PER_SEC / 8 };
143
144 /* Maximum backwards seek (magic number lifted from CFQ), in KiB. */
145 static const int bfq_back_max = 16 * 1024;
146
147 /* Penalty of a backwards seek, in number of sectors. */
148 static const int bfq_back_penalty = 2;
149
150 /* Idling period duration, in ns. */
151 static u64 bfq_slice_idle = NSEC_PER_SEC / 125;
152
153 /* Minimum number of assigned budgets for which stats are safe to compute. */
154 static const int bfq_stats_min_budgets = 194;
155
156 /* Default maximum budget values, in sectors and number of requests. */
157 static const int bfq_default_max_budget = 16 * 1024;
158
159 /*
160  * Async to sync throughput distribution is controlled as follows:
161  * when an async request is served, the entity is charged the number
162  * of sectors of the request, multiplied by the factor below
163  */
164 static const int bfq_async_charge_factor = 10;
165
166 /* Default timeout values, in jiffies, approximating CFQ defaults. */
167 const int bfq_timeout = HZ / 8;
168
169 static struct kmem_cache *bfq_pool;
170
171 /* Below this threshold (in ns), we consider thinktime immediate. */
172 #define BFQ_MIN_TT              (2 * NSEC_PER_MSEC)
173
174 /* hw_tag detection: parallel requests threshold and min samples needed. */
175 #define BFQ_HW_QUEUE_THRESHOLD  4
176 #define BFQ_HW_QUEUE_SAMPLES    32
177
178 #define BFQQ_SEEK_THR           (sector_t)(8 * 100)
179 #define BFQQ_SECT_THR_NONROT    (sector_t)(2 * 32)
180 #define BFQQ_CLOSE_THR          (sector_t)(8 * 1024)
181 #define BFQQ_SEEKY(bfqq)        (hweight32(bfqq->seek_history) > 32/8)
182
183 /* Min number of samples required to perform peak-rate update */
184 #define BFQ_RATE_MIN_SAMPLES    32
185 /* Min observation time interval required to perform a peak-rate update (ns) */
186 #define BFQ_RATE_MIN_INTERVAL   (300*NSEC_PER_MSEC)
187 /* Target observation time interval for a peak-rate update (ns) */
188 #define BFQ_RATE_REF_INTERVAL   NSEC_PER_SEC
189
190 /* Shift used for peak rate fixed precision calculations. */
191 #define BFQ_RATE_SHIFT          16
192
193 /*
194  * By default, BFQ computes the duration of the weight raising for
195  * interactive applications automatically, using the following formula:
196  * duration = (R / r) * T, where r is the peak rate of the device, and
197  * R and T are two reference parameters.
198  * In particular, R is the peak rate of the reference device (see below),
199  * and T is a reference time: given the systems that are likely to be
200  * installed on the reference device according to its speed class, T is
201  * about the maximum time needed, under BFQ and while reading two files in
202  * parallel, to load typical large applications on these systems.
203  * In practice, the slower/faster the device at hand is, the more/less it
204  * takes to load applications with respect to the reference device.
205  * Accordingly, the longer/shorter BFQ grants weight raising to interactive
206  * applications.
207  *
208  * BFQ uses four different reference pairs (R, T), depending on:
209  * . whether the device is rotational or non-rotational;
210  * . whether the device is slow, such as old or portable HDDs, as well as
211  *   SD cards, or fast, such as newer HDDs and SSDs.
212  *
213  * The device's speed class is dynamically (re)detected in
214  * bfq_update_peak_rate() every time the estimated peak rate is updated.
215  *
216  * In the following definitions, R_slow[0]/R_fast[0] and
217  * T_slow[0]/T_fast[0] are the reference values for a slow/fast
218  * rotational device, whereas R_slow[1]/R_fast[1] and
219  * T_slow[1]/T_fast[1] are the reference values for a slow/fast
220  * non-rotational device. Finally, device_speed_thresh are the
221  * thresholds used to switch between speed classes. The reference
222  * rates are not the actual peak rates of the devices used as a
223  * reference, but slightly lower values. The reason for using these
224  * slightly lower values is that the peak-rate estimator tends to
225  * yield slightly lower values than the actual peak rate (it can yield
226  * the actual peak rate only if there is only one process doing I/O,
227  * and the process does sequential I/O).
228  *
229  * Both the reference peak rates and the thresholds are measured in
230  * sectors/usec, left-shifted by BFQ_RATE_SHIFT.
231  */
232 static int R_slow[2] = {1000, 10700};
233 static int R_fast[2] = {14000, 33000};
234 /*
235  * To improve readability, a conversion function is used to initialize the
236  * following arrays, which entails that they can be initialized only in a
237  * function.
238  */
239 static int T_slow[2];
240 static int T_fast[2];
241 static int device_speed_thresh[2];
242
243 #define RQ_BIC(rq)              icq_to_bic((rq)->elv.priv[0])
244 #define RQ_BFQQ(rq)             ((rq)->elv.priv[1])
245
246 struct bfq_queue *bic_to_bfqq(struct bfq_io_cq *bic, bool is_sync)
247 {
248         return bic->bfqq[is_sync];
249 }
250
251 void bic_set_bfqq(struct bfq_io_cq *bic, struct bfq_queue *bfqq, bool is_sync)
252 {
253         bic->bfqq[is_sync] = bfqq;
254 }
255
256 struct bfq_data *bic_to_bfqd(struct bfq_io_cq *bic)
257 {
258         return bic->icq.q->elevator->elevator_data;
259 }
260
261 /**
262  * icq_to_bic - convert iocontext queue structure to bfq_io_cq.
263  * @icq: the iocontext queue.
264  */
265 static struct bfq_io_cq *icq_to_bic(struct io_cq *icq)
266 {
267         /* bic->icq is the first member, %NULL will convert to %NULL */
268         return container_of(icq, struct bfq_io_cq, icq);
269 }
270
271 /**
272  * bfq_bic_lookup - search into @ioc a bic associated to @bfqd.
273  * @bfqd: the lookup key.
274  * @ioc: the io_context of the process doing I/O.
275  * @q: the request queue.
276  */
277 static struct bfq_io_cq *bfq_bic_lookup(struct bfq_data *bfqd,
278                                         struct io_context *ioc,
279                                         struct request_queue *q)
280 {
281         if (ioc) {
282                 unsigned long flags;
283                 struct bfq_io_cq *icq;
284
285                 spin_lock_irqsave(q->queue_lock, flags);
286                 icq = icq_to_bic(ioc_lookup_icq(ioc, q));
287                 spin_unlock_irqrestore(q->queue_lock, flags);
288
289                 return icq;
290         }
291
292         return NULL;
293 }
294
295 /*
296  * Scheduler run of queue, if there are requests pending and no one in the
297  * driver that will restart queueing.
298  */
299 void bfq_schedule_dispatch(struct bfq_data *bfqd)
300 {
301         if (bfqd->queued != 0) {
302                 bfq_log(bfqd, "schedule dispatch");
303                 blk_mq_run_hw_queues(bfqd->queue, true);
304         }
305 }
306
307 #define bfq_class_idle(bfqq)    ((bfqq)->ioprio_class == IOPRIO_CLASS_IDLE)
308 #define bfq_class_rt(bfqq)      ((bfqq)->ioprio_class == IOPRIO_CLASS_RT)
309
310 #define bfq_sample_valid(samples)       ((samples) > 80)
311
312 /*
313  * Lifted from AS - choose which of rq1 and rq2 that is best served now.
314  * We choose the request that is closesr to the head right now.  Distance
315  * behind the head is penalized and only allowed to a certain extent.
316  */
317 static struct request *bfq_choose_req(struct bfq_data *bfqd,
318                                       struct request *rq1,
319                                       struct request *rq2,
320                                       sector_t last)
321 {
322         sector_t s1, s2, d1 = 0, d2 = 0;
323         unsigned long back_max;
324 #define BFQ_RQ1_WRAP    0x01 /* request 1 wraps */
325 #define BFQ_RQ2_WRAP    0x02 /* request 2 wraps */
326         unsigned int wrap = 0; /* bit mask: requests behind the disk head? */
327
328         if (!rq1 || rq1 == rq2)
329                 return rq2;
330         if (!rq2)
331                 return rq1;
332
333         if (rq_is_sync(rq1) && !rq_is_sync(rq2))
334                 return rq1;
335         else if (rq_is_sync(rq2) && !rq_is_sync(rq1))
336                 return rq2;
337         if ((rq1->cmd_flags & REQ_META) && !(rq2->cmd_flags & REQ_META))
338                 return rq1;
339         else if ((rq2->cmd_flags & REQ_META) && !(rq1->cmd_flags & REQ_META))
340                 return rq2;
341
342         s1 = blk_rq_pos(rq1);
343         s2 = blk_rq_pos(rq2);
344
345         /*
346          * By definition, 1KiB is 2 sectors.
347          */
348         back_max = bfqd->bfq_back_max * 2;
349
350         /*
351          * Strict one way elevator _except_ in the case where we allow
352          * short backward seeks which are biased as twice the cost of a
353          * similar forward seek.
354          */
355         if (s1 >= last)
356                 d1 = s1 - last;
357         else if (s1 + back_max >= last)
358                 d1 = (last - s1) * bfqd->bfq_back_penalty;
359         else
360                 wrap |= BFQ_RQ1_WRAP;
361
362         if (s2 >= last)
363                 d2 = s2 - last;
364         else if (s2 + back_max >= last)
365                 d2 = (last - s2) * bfqd->bfq_back_penalty;
366         else
367                 wrap |= BFQ_RQ2_WRAP;
368
369         /* Found required data */
370
371         /*
372          * By doing switch() on the bit mask "wrap" we avoid having to
373          * check two variables for all permutations: --> faster!
374          */
375         switch (wrap) {
376         case 0: /* common case for CFQ: rq1 and rq2 not wrapped */
377                 if (d1 < d2)
378                         return rq1;
379                 else if (d2 < d1)
380                         return rq2;
381
382                 if (s1 >= s2)
383                         return rq1;
384                 else
385                         return rq2;
386
387         case BFQ_RQ2_WRAP:
388                 return rq1;
389         case BFQ_RQ1_WRAP:
390                 return rq2;
391         case BFQ_RQ1_WRAP|BFQ_RQ2_WRAP: /* both rqs wrapped */
392         default:
393                 /*
394                  * Since both rqs are wrapped,
395                  * start with the one that's further behind head
396                  * (--> only *one* back seek required),
397                  * since back seek takes more time than forward.
398                  */
399                 if (s1 <= s2)
400                         return rq1;
401                 else
402                         return rq2;
403         }
404 }
405
406 static struct bfq_queue *
407 bfq_rq_pos_tree_lookup(struct bfq_data *bfqd, struct rb_root *root,
408                      sector_t sector, struct rb_node **ret_parent,
409                      struct rb_node ***rb_link)
410 {
411         struct rb_node **p, *parent;
412         struct bfq_queue *bfqq = NULL;
413
414         parent = NULL;
415         p = &root->rb_node;
416         while (*p) {
417                 struct rb_node **n;
418
419                 parent = *p;
420                 bfqq = rb_entry(parent, struct bfq_queue, pos_node);
421
422                 /*
423                  * Sort strictly based on sector. Smallest to the left,
424                  * largest to the right.
425                  */
426                 if (sector > blk_rq_pos(bfqq->next_rq))
427                         n = &(*p)->rb_right;
428                 else if (sector < blk_rq_pos(bfqq->next_rq))
429                         n = &(*p)->rb_left;
430                 else
431                         break;
432                 p = n;
433                 bfqq = NULL;
434         }
435
436         *ret_parent = parent;
437         if (rb_link)
438                 *rb_link = p;
439
440         bfq_log(bfqd, "rq_pos_tree_lookup %llu: returning %d",
441                 (unsigned long long)sector,
442                 bfqq ? bfqq->pid : 0);
443
444         return bfqq;
445 }
446
447 void bfq_pos_tree_add_move(struct bfq_data *bfqd, struct bfq_queue *bfqq)
448 {
449         struct rb_node **p, *parent;
450         struct bfq_queue *__bfqq;
451
452         if (bfqq->pos_root) {
453                 rb_erase(&bfqq->pos_node, bfqq->pos_root);
454                 bfqq->pos_root = NULL;
455         }
456
457         if (bfq_class_idle(bfqq))
458                 return;
459         if (!bfqq->next_rq)
460                 return;
461
462         bfqq->pos_root = &bfq_bfqq_to_bfqg(bfqq)->rq_pos_tree;
463         __bfqq = bfq_rq_pos_tree_lookup(bfqd, bfqq->pos_root,
464                         blk_rq_pos(bfqq->next_rq), &parent, &p);
465         if (!__bfqq) {
466                 rb_link_node(&bfqq->pos_node, parent, p);
467                 rb_insert_color(&bfqq->pos_node, bfqq->pos_root);
468         } else
469                 bfqq->pos_root = NULL;
470 }
471
472 /*
473  * Tell whether there are active queues or groups with differentiated weights.
474  */
475 static bool bfq_differentiated_weights(struct bfq_data *bfqd)
476 {
477         /*
478          * For weights to differ, at least one of the trees must contain
479          * at least two nodes.
480          */
481         return (!RB_EMPTY_ROOT(&bfqd->queue_weights_tree) &&
482                 (bfqd->queue_weights_tree.rb_node->rb_left ||
483                  bfqd->queue_weights_tree.rb_node->rb_right)
484 #ifdef CONFIG_BFQ_GROUP_IOSCHED
485                ) ||
486                (!RB_EMPTY_ROOT(&bfqd->group_weights_tree) &&
487                 (bfqd->group_weights_tree.rb_node->rb_left ||
488                  bfqd->group_weights_tree.rb_node->rb_right)
489 #endif
490                );
491 }
492
493 /*
494  * The following function returns true if every queue must receive the
495  * same share of the throughput (this condition is used when deciding
496  * whether idling may be disabled, see the comments in the function
497  * bfq_bfqq_may_idle()).
498  *
499  * Such a scenario occurs when:
500  * 1) all active queues have the same weight,
501  * 2) all active groups at the same level in the groups tree have the same
502  *    weight,
503  * 3) all active groups at the same level in the groups tree have the same
504  *    number of children.
505  *
506  * Unfortunately, keeping the necessary state for evaluating exactly the
507  * above symmetry conditions would be quite complex and time-consuming.
508  * Therefore this function evaluates, instead, the following stronger
509  * sub-conditions, for which it is much easier to maintain the needed
510  * state:
511  * 1) all active queues have the same weight,
512  * 2) all active groups have the same weight,
513  * 3) all active groups have at most one active child each.
514  * In particular, the last two conditions are always true if hierarchical
515  * support and the cgroups interface are not enabled, thus no state needs
516  * to be maintained in this case.
517  */
518 static bool bfq_symmetric_scenario(struct bfq_data *bfqd)
519 {
520         return !bfq_differentiated_weights(bfqd);
521 }
522
523 /*
524  * If the weight-counter tree passed as input contains no counter for
525  * the weight of the input entity, then add that counter; otherwise just
526  * increment the existing counter.
527  *
528  * Note that weight-counter trees contain few nodes in mostly symmetric
529  * scenarios. For example, if all queues have the same weight, then the
530  * weight-counter tree for the queues may contain at most one node.
531  * This holds even if low_latency is on, because weight-raised queues
532  * are not inserted in the tree.
533  * In most scenarios, the rate at which nodes are created/destroyed
534  * should be low too.
535  */
536 void bfq_weights_tree_add(struct bfq_data *bfqd, struct bfq_entity *entity,
537                           struct rb_root *root)
538 {
539         struct rb_node **new = &(root->rb_node), *parent = NULL;
540
541         /*
542          * Do not insert if the entity is already associated with a
543          * counter, which happens if:
544          *   1) the entity is associated with a queue,
545          *   2) a request arrival has caused the queue to become both
546          *      non-weight-raised, and hence change its weight, and
547          *      backlogged; in this respect, each of the two events
548          *      causes an invocation of this function,
549          *   3) this is the invocation of this function caused by the
550          *      second event. This second invocation is actually useless,
551          *      and we handle this fact by exiting immediately. More
552          *      efficient or clearer solutions might possibly be adopted.
553          */
554         if (entity->weight_counter)
555                 return;
556
557         while (*new) {
558                 struct bfq_weight_counter *__counter = container_of(*new,
559                                                 struct bfq_weight_counter,
560                                                 weights_node);
561                 parent = *new;
562
563                 if (entity->weight == __counter->weight) {
564                         entity->weight_counter = __counter;
565                         goto inc_counter;
566                 }
567                 if (entity->weight < __counter->weight)
568                         new = &((*new)->rb_left);
569                 else
570                         new = &((*new)->rb_right);
571         }
572
573         entity->weight_counter = kzalloc(sizeof(struct bfq_weight_counter),
574                                          GFP_ATOMIC);
575
576         /*
577          * In the unlucky event of an allocation failure, we just
578          * exit. This will cause the weight of entity to not be
579          * considered in bfq_differentiated_weights, which, in its
580          * turn, causes the scenario to be deemed wrongly symmetric in
581          * case entity's weight would have been the only weight making
582          * the scenario asymmetric. On the bright side, no unbalance
583          * will however occur when entity becomes inactive again (the
584          * invocation of this function is triggered by an activation
585          * of entity). In fact, bfq_weights_tree_remove does nothing
586          * if !entity->weight_counter.
587          */
588         if (unlikely(!entity->weight_counter))
589                 return;
590
591         entity->weight_counter->weight = entity->weight;
592         rb_link_node(&entity->weight_counter->weights_node, parent, new);
593         rb_insert_color(&entity->weight_counter->weights_node, root);
594
595 inc_counter:
596         entity->weight_counter->num_active++;
597 }
598
599 /*
600  * Decrement the weight counter associated with the entity, and, if the
601  * counter reaches 0, remove the counter from the tree.
602  * See the comments to the function bfq_weights_tree_add() for considerations
603  * about overhead.
604  */
605 void bfq_weights_tree_remove(struct bfq_data *bfqd, struct bfq_entity *entity,
606                              struct rb_root *root)
607 {
608         if (!entity->weight_counter)
609                 return;
610
611         entity->weight_counter->num_active--;
612         if (entity->weight_counter->num_active > 0)
613                 goto reset_entity_pointer;
614
615         rb_erase(&entity->weight_counter->weights_node, root);
616         kfree(entity->weight_counter);
617
618 reset_entity_pointer:
619         entity->weight_counter = NULL;
620 }
621
622 /*
623  * Return expired entry, or NULL to just start from scratch in rbtree.
624  */
625 static struct request *bfq_check_fifo(struct bfq_queue *bfqq,
626                                       struct request *last)
627 {
628         struct request *rq;
629
630         if (bfq_bfqq_fifo_expire(bfqq))
631                 return NULL;
632
633         bfq_mark_bfqq_fifo_expire(bfqq);
634
635         rq = rq_entry_fifo(bfqq->fifo.next);
636
637         if (rq == last || ktime_get_ns() < rq->fifo_time)
638                 return NULL;
639
640         bfq_log_bfqq(bfqq->bfqd, bfqq, "check_fifo: returned %p", rq);
641         return rq;
642 }
643
644 static struct request *bfq_find_next_rq(struct bfq_data *bfqd,
645                                         struct bfq_queue *bfqq,
646                                         struct request *last)
647 {
648         struct rb_node *rbnext = rb_next(&last->rb_node);
649         struct rb_node *rbprev = rb_prev(&last->rb_node);
650         struct request *next, *prev = NULL;
651
652         /* Follow expired path, else get first next available. */
653         next = bfq_check_fifo(bfqq, last);
654         if (next)
655                 return next;
656
657         if (rbprev)
658                 prev = rb_entry_rq(rbprev);
659
660         if (rbnext)
661                 next = rb_entry_rq(rbnext);
662         else {
663                 rbnext = rb_first(&bfqq->sort_list);
664                 if (rbnext && rbnext != &last->rb_node)
665                         next = rb_entry_rq(rbnext);
666         }
667
668         return bfq_choose_req(bfqd, next, prev, blk_rq_pos(last));
669 }
670
671 /* see the definition of bfq_async_charge_factor for details */
672 static unsigned long bfq_serv_to_charge(struct request *rq,
673                                         struct bfq_queue *bfqq)
674 {
675         if (bfq_bfqq_sync(bfqq) || bfqq->wr_coeff > 1)
676                 return blk_rq_sectors(rq);
677
678         /*
679          * If there are no weight-raised queues, then amplify service
680          * by just the async charge factor; otherwise amplify service
681          * by twice the async charge factor, to further reduce latency
682          * for weight-raised queues.
683          */
684         if (bfqq->bfqd->wr_busy_queues == 0)
685                 return blk_rq_sectors(rq) * bfq_async_charge_factor;
686
687         return blk_rq_sectors(rq) * 2 * bfq_async_charge_factor;
688 }
689
690 /**
691  * bfq_updated_next_req - update the queue after a new next_rq selection.
692  * @bfqd: the device data the queue belongs to.
693  * @bfqq: the queue to update.
694  *
695  * If the first request of a queue changes we make sure that the queue
696  * has enough budget to serve at least its first request (if the
697  * request has grown).  We do this because if the queue has not enough
698  * budget for its first request, it has to go through two dispatch
699  * rounds to actually get it dispatched.
700  */
701 static void bfq_updated_next_req(struct bfq_data *bfqd,
702                                  struct bfq_queue *bfqq)
703 {
704         struct bfq_entity *entity = &bfqq->entity;
705         struct request *next_rq = bfqq->next_rq;
706         unsigned long new_budget;
707
708         if (!next_rq)
709                 return;
710
711         if (bfqq == bfqd->in_service_queue)
712                 /*
713                  * In order not to break guarantees, budgets cannot be
714                  * changed after an entity has been selected.
715                  */
716                 return;
717
718         new_budget = max_t(unsigned long, bfqq->max_budget,
719                            bfq_serv_to_charge(next_rq, bfqq));
720         if (entity->budget != new_budget) {
721                 entity->budget = new_budget;
722                 bfq_log_bfqq(bfqd, bfqq, "updated next rq: new budget %lu",
723                                          new_budget);
724                 bfq_requeue_bfqq(bfqd, bfqq, false);
725         }
726 }
727
728 static void
729 bfq_bfqq_resume_state(struct bfq_queue *bfqq, struct bfq_data *bfqd,
730                       struct bfq_io_cq *bic, bool bfq_already_existing)
731 {
732         unsigned int old_wr_coeff = bfqq->wr_coeff;
733         bool busy = bfq_already_existing && bfq_bfqq_busy(bfqq);
734
735         if (bic->saved_has_short_ttime)
736                 bfq_mark_bfqq_has_short_ttime(bfqq);
737         else
738                 bfq_clear_bfqq_has_short_ttime(bfqq);
739
740         if (bic->saved_IO_bound)
741                 bfq_mark_bfqq_IO_bound(bfqq);
742         else
743                 bfq_clear_bfqq_IO_bound(bfqq);
744
745         bfqq->ttime = bic->saved_ttime;
746         bfqq->wr_coeff = bic->saved_wr_coeff;
747         bfqq->wr_start_at_switch_to_srt = bic->saved_wr_start_at_switch_to_srt;
748         bfqq->last_wr_start_finish = bic->saved_last_wr_start_finish;
749         bfqq->wr_cur_max_time = bic->saved_wr_cur_max_time;
750
751         if (bfqq->wr_coeff > 1 && (bfq_bfqq_in_large_burst(bfqq) ||
752             time_is_before_jiffies(bfqq->last_wr_start_finish +
753                                    bfqq->wr_cur_max_time))) {
754                 bfq_log_bfqq(bfqq->bfqd, bfqq,
755                     "resume state: switching off wr");
756
757                 bfqq->wr_coeff = 1;
758         }
759
760         /* make sure weight will be updated, however we got here */
761         bfqq->entity.prio_changed = 1;
762
763         if (likely(!busy))
764                 return;
765
766         if (old_wr_coeff == 1 && bfqq->wr_coeff > 1)
767                 bfqd->wr_busy_queues++;
768         else if (old_wr_coeff > 1 && bfqq->wr_coeff == 1)
769                 bfqd->wr_busy_queues--;
770 }
771
772 static int bfqq_process_refs(struct bfq_queue *bfqq)
773 {
774         return bfqq->ref - bfqq->allocated - bfqq->entity.on_st;
775 }
776
777 /* Empty burst list and add just bfqq (see comments on bfq_handle_burst) */
778 static void bfq_reset_burst_list(struct bfq_data *bfqd, struct bfq_queue *bfqq)
779 {
780         struct bfq_queue *item;
781         struct hlist_node *n;
782
783         hlist_for_each_entry_safe(item, n, &bfqd->burst_list, burst_list_node)
784                 hlist_del_init(&item->burst_list_node);
785         hlist_add_head(&bfqq->burst_list_node, &bfqd->burst_list);
786         bfqd->burst_size = 1;
787         bfqd->burst_parent_entity = bfqq->entity.parent;
788 }
789
790 /* Add bfqq to the list of queues in current burst (see bfq_handle_burst) */
791 static void bfq_add_to_burst(struct bfq_data *bfqd, struct bfq_queue *bfqq)
792 {
793         /* Increment burst size to take into account also bfqq */
794         bfqd->burst_size++;
795
796         if (bfqd->burst_size == bfqd->bfq_large_burst_thresh) {
797                 struct bfq_queue *pos, *bfqq_item;
798                 struct hlist_node *n;
799
800                 /*
801                  * Enough queues have been activated shortly after each
802                  * other to consider this burst as large.
803                  */
804                 bfqd->large_burst = true;
805
806                 /*
807                  * We can now mark all queues in the burst list as
808                  * belonging to a large burst.
809                  */
810                 hlist_for_each_entry(bfqq_item, &bfqd->burst_list,
811                                      burst_list_node)
812                         bfq_mark_bfqq_in_large_burst(bfqq_item);
813                 bfq_mark_bfqq_in_large_burst(bfqq);
814
815                 /*
816                  * From now on, and until the current burst finishes, any
817                  * new queue being activated shortly after the last queue
818                  * was inserted in the burst can be immediately marked as
819                  * belonging to a large burst. So the burst list is not
820                  * needed any more. Remove it.
821                  */
822                 hlist_for_each_entry_safe(pos, n, &bfqd->burst_list,
823                                           burst_list_node)
824                         hlist_del_init(&pos->burst_list_node);
825         } else /*
826                 * Burst not yet large: add bfqq to the burst list. Do
827                 * not increment the ref counter for bfqq, because bfqq
828                 * is removed from the burst list before freeing bfqq
829                 * in put_queue.
830                 */
831                 hlist_add_head(&bfqq->burst_list_node, &bfqd->burst_list);
832 }
833
834 /*
835  * If many queues belonging to the same group happen to be created
836  * shortly after each other, then the processes associated with these
837  * queues have typically a common goal. In particular, bursts of queue
838  * creations are usually caused by services or applications that spawn
839  * many parallel threads/processes. Examples are systemd during boot,
840  * or git grep. To help these processes get their job done as soon as
841  * possible, it is usually better to not grant either weight-raising
842  * or device idling to their queues.
843  *
844  * In this comment we describe, firstly, the reasons why this fact
845  * holds, and, secondly, the next function, which implements the main
846  * steps needed to properly mark these queues so that they can then be
847  * treated in a different way.
848  *
849  * The above services or applications benefit mostly from a high
850  * throughput: the quicker the requests of the activated queues are
851  * cumulatively served, the sooner the target job of these queues gets
852  * completed. As a consequence, weight-raising any of these queues,
853  * which also implies idling the device for it, is almost always
854  * counterproductive. In most cases it just lowers throughput.
855  *
856  * On the other hand, a burst of queue creations may be caused also by
857  * the start of an application that does not consist of a lot of
858  * parallel I/O-bound threads. In fact, with a complex application,
859  * several short processes may need to be executed to start-up the
860  * application. In this respect, to start an application as quickly as
861  * possible, the best thing to do is in any case to privilege the I/O
862  * related to the application with respect to all other
863  * I/O. Therefore, the best strategy to start as quickly as possible
864  * an application that causes a burst of queue creations is to
865  * weight-raise all the queues created during the burst. This is the
866  * exact opposite of the best strategy for the other type of bursts.
867  *
868  * In the end, to take the best action for each of the two cases, the
869  * two types of bursts need to be distinguished. Fortunately, this
870  * seems relatively easy, by looking at the sizes of the bursts. In
871  * particular, we found a threshold such that only bursts with a
872  * larger size than that threshold are apparently caused by
873  * services or commands such as systemd or git grep. For brevity,
874  * hereafter we call just 'large' these bursts. BFQ *does not*
875  * weight-raise queues whose creation occurs in a large burst. In
876  * addition, for each of these queues BFQ performs or does not perform
877  * idling depending on which choice boosts the throughput more. The
878  * exact choice depends on the device and request pattern at
879  * hand.
880  *
881  * Unfortunately, false positives may occur while an interactive task
882  * is starting (e.g., an application is being started). The
883  * consequence is that the queues associated with the task do not
884  * enjoy weight raising as expected. Fortunately these false positives
885  * are very rare. They typically occur if some service happens to
886  * start doing I/O exactly when the interactive task starts.
887  *
888  * Turning back to the next function, it implements all the steps
889  * needed to detect the occurrence of a large burst and to properly
890  * mark all the queues belonging to it (so that they can then be
891  * treated in a different way). This goal is achieved by maintaining a
892  * "burst list" that holds, temporarily, the queues that belong to the
893  * burst in progress. The list is then used to mark these queues as
894  * belonging to a large burst if the burst does become large. The main
895  * steps are the following.
896  *
897  * . when the very first queue is created, the queue is inserted into the
898  *   list (as it could be the first queue in a possible burst)
899  *
900  * . if the current burst has not yet become large, and a queue Q that does
901  *   not yet belong to the burst is activated shortly after the last time
902  *   at which a new queue entered the burst list, then the function appends
903  *   Q to the burst list
904  *
905  * . if, as a consequence of the previous step, the burst size reaches
906  *   the large-burst threshold, then
907  *
908  *     . all the queues in the burst list are marked as belonging to a
909  *       large burst
910  *
911  *     . the burst list is deleted; in fact, the burst list already served
912  *       its purpose (keeping temporarily track of the queues in a burst,
913  *       so as to be able to mark them as belonging to a large burst in the
914  *       previous sub-step), and now is not needed any more
915  *
916  *     . the device enters a large-burst mode
917  *
918  * . if a queue Q that does not belong to the burst is created while
919  *   the device is in large-burst mode and shortly after the last time
920  *   at which a queue either entered the burst list or was marked as
921  *   belonging to the current large burst, then Q is immediately marked
922  *   as belonging to a large burst.
923  *
924  * . if a queue Q that does not belong to the burst is created a while
925  *   later, i.e., not shortly after, than the last time at which a queue
926  *   either entered the burst list or was marked as belonging to the
927  *   current large burst, then the current burst is deemed as finished and:
928  *
929  *        . the large-burst mode is reset if set
930  *
931  *        . the burst list is emptied
932  *
933  *        . Q is inserted in the burst list, as Q may be the first queue
934  *          in a possible new burst (then the burst list contains just Q
935  *          after this step).
936  */
937 static void bfq_handle_burst(struct bfq_data *bfqd, struct bfq_queue *bfqq)
938 {
939         /*
940          * If bfqq is already in the burst list or is part of a large
941          * burst, or finally has just been split, then there is
942          * nothing else to do.
943          */
944         if (!hlist_unhashed(&bfqq->burst_list_node) ||
945             bfq_bfqq_in_large_burst(bfqq) ||
946             time_is_after_eq_jiffies(bfqq->split_time +
947                                      msecs_to_jiffies(10)))
948                 return;
949
950         /*
951          * If bfqq's creation happens late enough, or bfqq belongs to
952          * a different group than the burst group, then the current
953          * burst is finished, and related data structures must be
954          * reset.
955          *
956          * In this respect, consider the special case where bfqq is
957          * the very first queue created after BFQ is selected for this
958          * device. In this case, last_ins_in_burst and
959          * burst_parent_entity are not yet significant when we get
960          * here. But it is easy to verify that, whether or not the
961          * following condition is true, bfqq will end up being
962          * inserted into the burst list. In particular the list will
963          * happen to contain only bfqq. And this is exactly what has
964          * to happen, as bfqq may be the first queue of the first
965          * burst.
966          */
967         if (time_is_before_jiffies(bfqd->last_ins_in_burst +
968             bfqd->bfq_burst_interval) ||
969             bfqq->entity.parent != bfqd->burst_parent_entity) {
970                 bfqd->large_burst = false;
971                 bfq_reset_burst_list(bfqd, bfqq);
972                 goto end;
973         }
974
975         /*
976          * If we get here, then bfqq is being activated shortly after the
977          * last queue. So, if the current burst is also large, we can mark
978          * bfqq as belonging to this large burst immediately.
979          */
980         if (bfqd->large_burst) {
981                 bfq_mark_bfqq_in_large_burst(bfqq);
982                 goto end;
983         }
984
985         /*
986          * If we get here, then a large-burst state has not yet been
987          * reached, but bfqq is being activated shortly after the last
988          * queue. Then we add bfqq to the burst.
989          */
990         bfq_add_to_burst(bfqd, bfqq);
991 end:
992         /*
993          * At this point, bfqq either has been added to the current
994          * burst or has caused the current burst to terminate and a
995          * possible new burst to start. In particular, in the second
996          * case, bfqq has become the first queue in the possible new
997          * burst.  In both cases last_ins_in_burst needs to be moved
998          * forward.
999          */
1000         bfqd->last_ins_in_burst = jiffies;
1001 }
1002
1003 static int bfq_bfqq_budget_left(struct bfq_queue *bfqq)
1004 {
1005         struct bfq_entity *entity = &bfqq->entity;
1006
1007         return entity->budget - entity->service;
1008 }
1009
1010 /*
1011  * If enough samples have been computed, return the current max budget
1012  * stored in bfqd, which is dynamically updated according to the
1013  * estimated disk peak rate; otherwise return the default max budget
1014  */
1015 static int bfq_max_budget(struct bfq_data *bfqd)
1016 {
1017         if (bfqd->budgets_assigned < bfq_stats_min_budgets)
1018                 return bfq_default_max_budget;
1019         else
1020                 return bfqd->bfq_max_budget;
1021 }
1022
1023 /*
1024  * Return min budget, which is a fraction of the current or default
1025  * max budget (trying with 1/32)
1026  */
1027 static int bfq_min_budget(struct bfq_data *bfqd)
1028 {
1029         if (bfqd->budgets_assigned < bfq_stats_min_budgets)
1030                 return bfq_default_max_budget / 32;
1031         else
1032                 return bfqd->bfq_max_budget / 32;
1033 }
1034
1035 /*
1036  * The next function, invoked after the input queue bfqq switches from
1037  * idle to busy, updates the budget of bfqq. The function also tells
1038  * whether the in-service queue should be expired, by returning
1039  * true. The purpose of expiring the in-service queue is to give bfqq
1040  * the chance to possibly preempt the in-service queue, and the reason
1041  * for preempting the in-service queue is to achieve one of the two
1042  * goals below.
1043  *
1044  * 1. Guarantee to bfqq its reserved bandwidth even if bfqq has
1045  * expired because it has remained idle. In particular, bfqq may have
1046  * expired for one of the following two reasons:
1047  *
1048  * - BFQQE_NO_MORE_REQUESTS bfqq did not enjoy any device idling
1049  *   and did not make it to issue a new request before its last
1050  *   request was served;
1051  *
1052  * - BFQQE_TOO_IDLE bfqq did enjoy device idling, but did not issue
1053  *   a new request before the expiration of the idling-time.
1054  *
1055  * Even if bfqq has expired for one of the above reasons, the process
1056  * associated with the queue may be however issuing requests greedily,
1057  * and thus be sensitive to the bandwidth it receives (bfqq may have
1058  * remained idle for other reasons: CPU high load, bfqq not enjoying
1059  * idling, I/O throttling somewhere in the path from the process to
1060  * the I/O scheduler, ...). But if, after every expiration for one of
1061  * the above two reasons, bfqq has to wait for the service of at least
1062  * one full budget of another queue before being served again, then
1063  * bfqq is likely to get a much lower bandwidth or resource time than
1064  * its reserved ones. To address this issue, two countermeasures need
1065  * to be taken.
1066  *
1067  * First, the budget and the timestamps of bfqq need to be updated in
1068  * a special way on bfqq reactivation: they need to be updated as if
1069  * bfqq did not remain idle and did not expire. In fact, if they are
1070  * computed as if bfqq expired and remained idle until reactivation,
1071  * then the process associated with bfqq is treated as if, instead of
1072  * being greedy, it stopped issuing requests when bfqq remained idle,
1073  * and restarts issuing requests only on this reactivation. In other
1074  * words, the scheduler does not help the process recover the "service
1075  * hole" between bfqq expiration and reactivation. As a consequence,
1076  * the process receives a lower bandwidth than its reserved one. In
1077  * contrast, to recover this hole, the budget must be updated as if
1078  * bfqq was not expired at all before this reactivation, i.e., it must
1079  * be set to the value of the remaining budget when bfqq was
1080  * expired. Along the same line, timestamps need to be assigned the
1081  * value they had the last time bfqq was selected for service, i.e.,
1082  * before last expiration. Thus timestamps need to be back-shifted
1083  * with respect to their normal computation (see [1] for more details
1084  * on this tricky aspect).
1085  *
1086  * Secondly, to allow the process to recover the hole, the in-service
1087  * queue must be expired too, to give bfqq the chance to preempt it
1088  * immediately. In fact, if bfqq has to wait for a full budget of the
1089  * in-service queue to be completed, then it may become impossible to
1090  * let the process recover the hole, even if the back-shifted
1091  * timestamps of bfqq are lower than those of the in-service queue. If
1092  * this happens for most or all of the holes, then the process may not
1093  * receive its reserved bandwidth. In this respect, it is worth noting
1094  * that, being the service of outstanding requests unpreemptible, a
1095  * little fraction of the holes may however be unrecoverable, thereby
1096  * causing a little loss of bandwidth.
1097  *
1098  * The last important point is detecting whether bfqq does need this
1099  * bandwidth recovery. In this respect, the next function deems the
1100  * process associated with bfqq greedy, and thus allows it to recover
1101  * the hole, if: 1) the process is waiting for the arrival of a new
1102  * request (which implies that bfqq expired for one of the above two
1103  * reasons), and 2) such a request has arrived soon. The first
1104  * condition is controlled through the flag non_blocking_wait_rq,
1105  * while the second through the flag arrived_in_time. If both
1106  * conditions hold, then the function computes the budget in the
1107  * above-described special way, and signals that the in-service queue
1108  * should be expired. Timestamp back-shifting is done later in
1109  * __bfq_activate_entity.
1110  *
1111  * 2. Reduce latency. Even if timestamps are not backshifted to let
1112  * the process associated with bfqq recover a service hole, bfqq may
1113  * however happen to have, after being (re)activated, a lower finish
1114  * timestamp than the in-service queue.  That is, the next budget of
1115  * bfqq may have to be completed before the one of the in-service
1116  * queue. If this is the case, then preempting the in-service queue
1117  * allows this goal to be achieved, apart from the unpreemptible,
1118  * outstanding requests mentioned above.
1119  *
1120  * Unfortunately, regardless of which of the above two goals one wants
1121  * to achieve, service trees need first to be updated to know whether
1122  * the in-service queue must be preempted. To have service trees
1123  * correctly updated, the in-service queue must be expired and
1124  * rescheduled, and bfqq must be scheduled too. This is one of the
1125  * most costly operations (in future versions, the scheduling
1126  * mechanism may be re-designed in such a way to make it possible to
1127  * know whether preemption is needed without needing to update service
1128  * trees). In addition, queue preemptions almost always cause random
1129  * I/O, and thus loss of throughput. Because of these facts, the next
1130  * function adopts the following simple scheme to avoid both costly
1131  * operations and too frequent preemptions: it requests the expiration
1132  * of the in-service queue (unconditionally) only for queues that need
1133  * to recover a hole, or that either are weight-raised or deserve to
1134  * be weight-raised.
1135  */
1136 static bool bfq_bfqq_update_budg_for_activation(struct bfq_data *bfqd,
1137                                                 struct bfq_queue *bfqq,
1138                                                 bool arrived_in_time,
1139                                                 bool wr_or_deserves_wr)
1140 {
1141         struct bfq_entity *entity = &bfqq->entity;
1142
1143         if (bfq_bfqq_non_blocking_wait_rq(bfqq) && arrived_in_time) {
1144                 /*
1145                  * We do not clear the flag non_blocking_wait_rq here, as
1146                  * the latter is used in bfq_activate_bfqq to signal
1147                  * that timestamps need to be back-shifted (and is
1148                  * cleared right after).
1149                  */
1150
1151                 /*
1152                  * In next assignment we rely on that either
1153                  * entity->service or entity->budget are not updated
1154                  * on expiration if bfqq is empty (see
1155                  * __bfq_bfqq_recalc_budget). Thus both quantities
1156                  * remain unchanged after such an expiration, and the
1157                  * following statement therefore assigns to
1158                  * entity->budget the remaining budget on such an
1159                  * expiration. For clarity, entity->service is not
1160                  * updated on expiration in any case, and, in normal
1161                  * operation, is reset only when bfqq is selected for
1162                  * service (see bfq_get_next_queue).
1163                  */
1164                 entity->budget = min_t(unsigned long,
1165                                        bfq_bfqq_budget_left(bfqq),
1166                                        bfqq->max_budget);
1167
1168                 return true;
1169         }
1170
1171         entity->budget = max_t(unsigned long, bfqq->max_budget,
1172                                bfq_serv_to_charge(bfqq->next_rq, bfqq));
1173         bfq_clear_bfqq_non_blocking_wait_rq(bfqq);
1174         return wr_or_deserves_wr;
1175 }
1176
1177 static unsigned int bfq_wr_duration(struct bfq_data *bfqd)
1178 {
1179         u64 dur;
1180
1181         if (bfqd->bfq_wr_max_time > 0)
1182                 return bfqd->bfq_wr_max_time;
1183
1184         dur = bfqd->RT_prod;
1185         do_div(dur, bfqd->peak_rate);
1186
1187         /*
1188          * Limit duration between 3 and 13 seconds. Tests show that
1189          * higher values than 13 seconds often yield the opposite of
1190          * the desired result, i.e., worsen responsiveness by letting
1191          * non-interactive and non-soft-real-time applications
1192          * preserve weight raising for a too long time interval.
1193          *
1194          * On the other end, lower values than 3 seconds make it
1195          * difficult for most interactive tasks to complete their jobs
1196          * before weight-raising finishes.
1197          */
1198         if (dur > msecs_to_jiffies(13000))
1199                 dur = msecs_to_jiffies(13000);
1200         else if (dur < msecs_to_jiffies(3000))
1201                 dur = msecs_to_jiffies(3000);
1202
1203         return dur;
1204 }
1205
1206 static void bfq_update_bfqq_wr_on_rq_arrival(struct bfq_data *bfqd,
1207                                              struct bfq_queue *bfqq,
1208                                              unsigned int old_wr_coeff,
1209                                              bool wr_or_deserves_wr,
1210                                              bool interactive,
1211                                              bool in_burst,
1212                                              bool soft_rt)
1213 {
1214         if (old_wr_coeff == 1 && wr_or_deserves_wr) {
1215                 /* start a weight-raising period */
1216                 if (interactive) {
1217                         bfqq->wr_coeff = bfqd->bfq_wr_coeff;
1218                         bfqq->wr_cur_max_time = bfq_wr_duration(bfqd);
1219                 } else {
1220                         bfqq->wr_start_at_switch_to_srt = jiffies;
1221                         bfqq->wr_coeff = bfqd->bfq_wr_coeff *
1222                                 BFQ_SOFTRT_WEIGHT_FACTOR;
1223                         bfqq->wr_cur_max_time =
1224                                 bfqd->bfq_wr_rt_max_time;
1225                 }
1226
1227                 /*
1228                  * If needed, further reduce budget to make sure it is
1229                  * close to bfqq's backlog, so as to reduce the
1230                  * scheduling-error component due to a too large
1231                  * budget. Do not care about throughput consequences,
1232                  * but only about latency. Finally, do not assign a
1233                  * too small budget either, to avoid increasing
1234                  * latency by causing too frequent expirations.
1235                  */
1236                 bfqq->entity.budget = min_t(unsigned long,
1237                                             bfqq->entity.budget,
1238                                             2 * bfq_min_budget(bfqd));
1239         } else if (old_wr_coeff > 1) {
1240                 if (interactive) { /* update wr coeff and duration */
1241                         bfqq->wr_coeff = bfqd->bfq_wr_coeff;
1242                         bfqq->wr_cur_max_time = bfq_wr_duration(bfqd);
1243                 } else if (in_burst)
1244                         bfqq->wr_coeff = 1;
1245                 else if (soft_rt) {
1246                         /*
1247                          * The application is now or still meeting the
1248                          * requirements for being deemed soft rt.  We
1249                          * can then correctly and safely (re)charge
1250                          * the weight-raising duration for the
1251                          * application with the weight-raising
1252                          * duration for soft rt applications.
1253                          *
1254                          * In particular, doing this recharge now, i.e.,
1255                          * before the weight-raising period for the
1256                          * application finishes, reduces the probability
1257                          * of the following negative scenario:
1258                          * 1) the weight of a soft rt application is
1259                          *    raised at startup (as for any newly
1260                          *    created application),
1261                          * 2) since the application is not interactive,
1262                          *    at a certain time weight-raising is
1263                          *    stopped for the application,
1264                          * 3) at that time the application happens to
1265                          *    still have pending requests, and hence
1266                          *    is destined to not have a chance to be
1267                          *    deemed soft rt before these requests are
1268                          *    completed (see the comments to the
1269                          *    function bfq_bfqq_softrt_next_start()
1270                          *    for details on soft rt detection),
1271                          * 4) these pending requests experience a high
1272                          *    latency because the application is not
1273                          *    weight-raised while they are pending.
1274                          */
1275                         if (bfqq->wr_cur_max_time !=
1276                                 bfqd->bfq_wr_rt_max_time) {
1277                                 bfqq->wr_start_at_switch_to_srt =
1278                                         bfqq->last_wr_start_finish;
1279
1280                                 bfqq->wr_cur_max_time =
1281                                         bfqd->bfq_wr_rt_max_time;
1282                                 bfqq->wr_coeff = bfqd->bfq_wr_coeff *
1283                                         BFQ_SOFTRT_WEIGHT_FACTOR;
1284                         }
1285                         bfqq->last_wr_start_finish = jiffies;
1286                 }
1287         }
1288 }
1289
1290 static bool bfq_bfqq_idle_for_long_time(struct bfq_data *bfqd,
1291                                         struct bfq_queue *bfqq)
1292 {
1293         return bfqq->dispatched == 0 &&
1294                 time_is_before_jiffies(
1295                         bfqq->budget_timeout +
1296                         bfqd->bfq_wr_min_idle_time);
1297 }
1298
1299 static void bfq_bfqq_handle_idle_busy_switch(struct bfq_data *bfqd,
1300                                              struct bfq_queue *bfqq,
1301                                              int old_wr_coeff,
1302                                              struct request *rq,
1303                                              bool *interactive)
1304 {
1305         bool soft_rt, in_burst, wr_or_deserves_wr,
1306                 bfqq_wants_to_preempt,
1307                 idle_for_long_time = bfq_bfqq_idle_for_long_time(bfqd, bfqq),
1308                 /*
1309                  * See the comments on
1310                  * bfq_bfqq_update_budg_for_activation for
1311                  * details on the usage of the next variable.
1312                  */
1313                 arrived_in_time =  ktime_get_ns() <=
1314                         bfqq->ttime.last_end_request +
1315                         bfqd->bfq_slice_idle * 3;
1316
1317         bfqg_stats_update_io_add(bfqq_group(RQ_BFQQ(rq)), bfqq, rq->cmd_flags);
1318
1319         /*
1320          * bfqq deserves to be weight-raised if:
1321          * - it is sync,
1322          * - it does not belong to a large burst,
1323          * - it has been idle for enough time or is soft real-time,
1324          * - is linked to a bfq_io_cq (it is not shared in any sense).
1325          */
1326         in_burst = bfq_bfqq_in_large_burst(bfqq);
1327         soft_rt = bfqd->bfq_wr_max_softrt_rate > 0 &&
1328                 !in_burst &&
1329                 time_is_before_jiffies(bfqq->soft_rt_next_start);
1330         *interactive = !in_burst && idle_for_long_time;
1331         wr_or_deserves_wr = bfqd->low_latency &&
1332                 (bfqq->wr_coeff > 1 ||
1333                  (bfq_bfqq_sync(bfqq) &&
1334                   bfqq->bic && (*interactive || soft_rt)));
1335
1336         /*
1337          * Using the last flag, update budget and check whether bfqq
1338          * may want to preempt the in-service queue.
1339          */
1340         bfqq_wants_to_preempt =
1341                 bfq_bfqq_update_budg_for_activation(bfqd, bfqq,
1342                                                     arrived_in_time,
1343                                                     wr_or_deserves_wr);
1344
1345         /*
1346          * If bfqq happened to be activated in a burst, but has been
1347          * idle for much more than an interactive queue, then we
1348          * assume that, in the overall I/O initiated in the burst, the
1349          * I/O associated with bfqq is finished. So bfqq does not need
1350          * to be treated as a queue belonging to a burst
1351          * anymore. Accordingly, we reset bfqq's in_large_burst flag
1352          * if set, and remove bfqq from the burst list if it's
1353          * there. We do not decrement burst_size, because the fact
1354          * that bfqq does not need to belong to the burst list any
1355          * more does not invalidate the fact that bfqq was created in
1356          * a burst.
1357          */
1358         if (likely(!bfq_bfqq_just_created(bfqq)) &&
1359             idle_for_long_time &&
1360             time_is_before_jiffies(
1361                     bfqq->budget_timeout +
1362                     msecs_to_jiffies(10000))) {
1363                 hlist_del_init(&bfqq->burst_list_node);
1364                 bfq_clear_bfqq_in_large_burst(bfqq);
1365         }
1366
1367         bfq_clear_bfqq_just_created(bfqq);
1368
1369
1370         if (!bfq_bfqq_IO_bound(bfqq)) {
1371                 if (arrived_in_time) {
1372                         bfqq->requests_within_timer++;
1373                         if (bfqq->requests_within_timer >=
1374                             bfqd->bfq_requests_within_timer)
1375                                 bfq_mark_bfqq_IO_bound(bfqq);
1376                 } else
1377                         bfqq->requests_within_timer = 0;
1378         }
1379
1380         if (bfqd->low_latency) {
1381                 if (unlikely(time_is_after_jiffies(bfqq->split_time)))
1382                         /* wraparound */
1383                         bfqq->split_time =
1384                                 jiffies - bfqd->bfq_wr_min_idle_time - 1;
1385
1386                 if (time_is_before_jiffies(bfqq->split_time +
1387                                            bfqd->bfq_wr_min_idle_time)) {
1388                         bfq_update_bfqq_wr_on_rq_arrival(bfqd, bfqq,
1389                                                          old_wr_coeff,
1390                                                          wr_or_deserves_wr,
1391                                                          *interactive,
1392                                                          in_burst,
1393                                                          soft_rt);
1394
1395                         if (old_wr_coeff != bfqq->wr_coeff)
1396                                 bfqq->entity.prio_changed = 1;
1397                 }
1398         }
1399
1400         bfqq->last_idle_bklogged = jiffies;
1401         bfqq->service_from_backlogged = 0;
1402         bfq_clear_bfqq_softrt_update(bfqq);
1403
1404         bfq_add_bfqq_busy(bfqd, bfqq);
1405
1406         /*
1407          * Expire in-service queue only if preemption may be needed
1408          * for guarantees. In this respect, the function
1409          * next_queue_may_preempt just checks a simple, necessary
1410          * condition, and not a sufficient condition based on
1411          * timestamps. In fact, for the latter condition to be
1412          * evaluated, timestamps would need first to be updated, and
1413          * this operation is quite costly (see the comments on the
1414          * function bfq_bfqq_update_budg_for_activation).
1415          */
1416         if (bfqd->in_service_queue && bfqq_wants_to_preempt &&
1417             bfqd->in_service_queue->wr_coeff < bfqq->wr_coeff &&
1418             next_queue_may_preempt(bfqd))
1419                 bfq_bfqq_expire(bfqd, bfqd->in_service_queue,
1420                                 false, BFQQE_PREEMPTED);
1421 }
1422
1423 static void bfq_add_request(struct request *rq)
1424 {
1425         struct bfq_queue *bfqq = RQ_BFQQ(rq);
1426         struct bfq_data *bfqd = bfqq->bfqd;
1427         struct request *next_rq, *prev;
1428         unsigned int old_wr_coeff = bfqq->wr_coeff;
1429         bool interactive = false;
1430
1431         bfq_log_bfqq(bfqd, bfqq, "add_request %d", rq_is_sync(rq));
1432         bfqq->queued[rq_is_sync(rq)]++;
1433         bfqd->queued++;
1434
1435         elv_rb_add(&bfqq->sort_list, rq);
1436
1437         /*
1438          * Check if this request is a better next-serve candidate.
1439          */
1440         prev = bfqq->next_rq;
1441         next_rq = bfq_choose_req(bfqd, bfqq->next_rq, rq, bfqd->last_position);
1442         bfqq->next_rq = next_rq;
1443
1444         /*
1445          * Adjust priority tree position, if next_rq changes.
1446          */
1447         if (prev != bfqq->next_rq)
1448                 bfq_pos_tree_add_move(bfqd, bfqq);
1449
1450         if (!bfq_bfqq_busy(bfqq)) /* switching to busy ... */
1451                 bfq_bfqq_handle_idle_busy_switch(bfqd, bfqq, old_wr_coeff,
1452                                                  rq, &interactive);
1453         else {
1454                 if (bfqd->low_latency && old_wr_coeff == 1 && !rq_is_sync(rq) &&
1455                     time_is_before_jiffies(
1456                                 bfqq->last_wr_start_finish +
1457                                 bfqd->bfq_wr_min_inter_arr_async)) {
1458                         bfqq->wr_coeff = bfqd->bfq_wr_coeff;
1459                         bfqq->wr_cur_max_time = bfq_wr_duration(bfqd);
1460
1461                         bfqd->wr_busy_queues++;
1462                         bfqq->entity.prio_changed = 1;
1463                 }
1464                 if (prev != bfqq->next_rq)
1465                         bfq_updated_next_req(bfqd, bfqq);
1466         }
1467
1468         /*
1469          * Assign jiffies to last_wr_start_finish in the following
1470          * cases:
1471          *
1472          * . if bfqq is not going to be weight-raised, because, for
1473          *   non weight-raised queues, last_wr_start_finish stores the
1474          *   arrival time of the last request; as of now, this piece
1475          *   of information is used only for deciding whether to
1476          *   weight-raise async queues
1477          *
1478          * . if bfqq is not weight-raised, because, if bfqq is now
1479          *   switching to weight-raised, then last_wr_start_finish
1480          *   stores the time when weight-raising starts
1481          *
1482          * . if bfqq is interactive, because, regardless of whether
1483          *   bfqq is currently weight-raised, the weight-raising
1484          *   period must start or restart (this case is considered
1485          *   separately because it is not detected by the above
1486          *   conditions, if bfqq is already weight-raised)
1487          *
1488          * last_wr_start_finish has to be updated also if bfqq is soft
1489          * real-time, because the weight-raising period is constantly
1490          * restarted on idle-to-busy transitions for these queues, but
1491          * this is already done in bfq_bfqq_handle_idle_busy_switch if
1492          * needed.
1493          */
1494         if (bfqd->low_latency &&
1495                 (old_wr_coeff == 1 || bfqq->wr_coeff == 1 || interactive))
1496                 bfqq->last_wr_start_finish = jiffies;
1497 }
1498
1499 static struct request *bfq_find_rq_fmerge(struct bfq_data *bfqd,
1500                                           struct bio *bio,
1501                                           struct request_queue *q)
1502 {
1503         struct bfq_queue *bfqq = bfqd->bio_bfqq;
1504
1505
1506         if (bfqq)
1507                 return elv_rb_find(&bfqq->sort_list, bio_end_sector(bio));
1508
1509         return NULL;
1510 }
1511
1512 static sector_t get_sdist(sector_t last_pos, struct request *rq)
1513 {
1514         if (last_pos)
1515                 return abs(blk_rq_pos(rq) - last_pos);
1516
1517         return 0;
1518 }
1519
1520 #if 0 /* Still not clear if we can do without next two functions */
1521 static void bfq_activate_request(struct request_queue *q, struct request *rq)
1522 {
1523         struct bfq_data *bfqd = q->elevator->elevator_data;
1524
1525         bfqd->rq_in_driver++;
1526 }
1527
1528 static void bfq_deactivate_request(struct request_queue *q, struct request *rq)
1529 {
1530         struct bfq_data *bfqd = q->elevator->elevator_data;
1531
1532         bfqd->rq_in_driver--;
1533 }
1534 #endif
1535
1536 static void bfq_remove_request(struct request_queue *q,
1537                                struct request *rq)
1538 {
1539         struct bfq_queue *bfqq = RQ_BFQQ(rq);
1540         struct bfq_data *bfqd = bfqq->bfqd;
1541         const int sync = rq_is_sync(rq);
1542
1543         if (bfqq->next_rq == rq) {
1544                 bfqq->next_rq = bfq_find_next_rq(bfqd, bfqq, rq);
1545                 bfq_updated_next_req(bfqd, bfqq);
1546         }
1547
1548         if (rq->queuelist.prev != &rq->queuelist)
1549                 list_del_init(&rq->queuelist);
1550         bfqq->queued[sync]--;
1551         bfqd->queued--;
1552         elv_rb_del(&bfqq->sort_list, rq);
1553
1554         elv_rqhash_del(q, rq);
1555         if (q->last_merge == rq)
1556                 q->last_merge = NULL;
1557
1558         if (RB_EMPTY_ROOT(&bfqq->sort_list)) {
1559                 bfqq->next_rq = NULL;
1560
1561                 if (bfq_bfqq_busy(bfqq) && bfqq != bfqd->in_service_queue) {
1562                         bfq_del_bfqq_busy(bfqd, bfqq, false);
1563                         /*
1564                          * bfqq emptied. In normal operation, when
1565                          * bfqq is empty, bfqq->entity.service and
1566                          * bfqq->entity.budget must contain,
1567                          * respectively, the service received and the
1568                          * budget used last time bfqq emptied. These
1569                          * facts do not hold in this case, as at least
1570                          * this last removal occurred while bfqq is
1571                          * not in service. To avoid inconsistencies,
1572                          * reset both bfqq->entity.service and
1573                          * bfqq->entity.budget, if bfqq has still a
1574                          * process that may issue I/O requests to it.
1575                          */
1576                         bfqq->entity.budget = bfqq->entity.service = 0;
1577                 }
1578
1579                 /*
1580                  * Remove queue from request-position tree as it is empty.
1581                  */
1582                 if (bfqq->pos_root) {
1583                         rb_erase(&bfqq->pos_node, bfqq->pos_root);
1584                         bfqq->pos_root = NULL;
1585                 }
1586         }
1587
1588         if (rq->cmd_flags & REQ_META)
1589                 bfqq->meta_pending--;
1590
1591         bfqg_stats_update_io_remove(bfqq_group(bfqq), rq->cmd_flags);
1592 }
1593
1594 static bool bfq_bio_merge(struct blk_mq_hw_ctx *hctx, struct bio *bio)
1595 {
1596         struct request_queue *q = hctx->queue;
1597         struct bfq_data *bfqd = q->elevator->elevator_data;
1598         struct request *free = NULL;
1599         /*
1600          * bfq_bic_lookup grabs the queue_lock: invoke it now and
1601          * store its return value for later use, to avoid nesting
1602          * queue_lock inside the bfqd->lock. We assume that the bic
1603          * returned by bfq_bic_lookup does not go away before
1604          * bfqd->lock is taken.
1605          */
1606         struct bfq_io_cq *bic = bfq_bic_lookup(bfqd, current->io_context, q);
1607         bool ret;
1608
1609         spin_lock_irq(&bfqd->lock);
1610
1611         if (bic)
1612                 bfqd->bio_bfqq = bic_to_bfqq(bic, op_is_sync(bio->bi_opf));
1613         else
1614                 bfqd->bio_bfqq = NULL;
1615         bfqd->bio_bic = bic;
1616
1617         ret = blk_mq_sched_try_merge(q, bio, &free);
1618
1619         if (free)
1620                 blk_mq_free_request(free);
1621         spin_unlock_irq(&bfqd->lock);
1622
1623         return ret;
1624 }
1625
1626 static int bfq_request_merge(struct request_queue *q, struct request **req,
1627                              struct bio *bio)
1628 {
1629         struct bfq_data *bfqd = q->elevator->elevator_data;
1630         struct request *__rq;
1631
1632         __rq = bfq_find_rq_fmerge(bfqd, bio, q);
1633         if (__rq && elv_bio_merge_ok(__rq, bio)) {
1634                 *req = __rq;
1635                 return ELEVATOR_FRONT_MERGE;
1636         }
1637
1638         return ELEVATOR_NO_MERGE;
1639 }
1640
1641 static void bfq_request_merged(struct request_queue *q, struct request *req,
1642                                enum elv_merge type)
1643 {
1644         if (type == ELEVATOR_FRONT_MERGE &&
1645             rb_prev(&req->rb_node) &&
1646             blk_rq_pos(req) <
1647             blk_rq_pos(container_of(rb_prev(&req->rb_node),
1648                                     struct request, rb_node))) {
1649                 struct bfq_queue *bfqq = RQ_BFQQ(req);
1650                 struct bfq_data *bfqd = bfqq->bfqd;
1651                 struct request *prev, *next_rq;
1652
1653                 /* Reposition request in its sort_list */
1654                 elv_rb_del(&bfqq->sort_list, req);
1655                 elv_rb_add(&bfqq->sort_list, req);
1656
1657                 /* Choose next request to be served for bfqq */
1658                 prev = bfqq->next_rq;
1659                 next_rq = bfq_choose_req(bfqd, bfqq->next_rq, req,
1660                                          bfqd->last_position);
1661                 bfqq->next_rq = next_rq;
1662                 /*
1663                  * If next_rq changes, update both the queue's budget to
1664                  * fit the new request and the queue's position in its
1665                  * rq_pos_tree.
1666                  */
1667                 if (prev != bfqq->next_rq) {
1668                         bfq_updated_next_req(bfqd, bfqq);
1669                         bfq_pos_tree_add_move(bfqd, bfqq);
1670                 }
1671         }
1672 }
1673
1674 static void bfq_requests_merged(struct request_queue *q, struct request *rq,
1675                                 struct request *next)
1676 {
1677         struct bfq_queue *bfqq = RQ_BFQQ(rq), *next_bfqq = RQ_BFQQ(next);
1678
1679         if (!RB_EMPTY_NODE(&rq->rb_node))
1680                 goto end;
1681
1682         /*
1683          * If next and rq belong to the same bfq_queue and next is older
1684          * than rq, then reposition rq in the fifo (by substituting next
1685          * with rq). Otherwise, if next and rq belong to different
1686          * bfq_queues, never reposition rq: in fact, we would have to
1687          * reposition it with respect to next's position in its own fifo,
1688          * which would most certainly be too expensive with respect to
1689          * the benefits.
1690          */
1691         if (bfqq == next_bfqq &&
1692             !list_empty(&rq->queuelist) && !list_empty(&next->queuelist) &&
1693             next->fifo_time < rq->fifo_time) {
1694                 list_del_init(&rq->queuelist);
1695                 list_replace_init(&next->queuelist, &rq->queuelist);
1696                 rq->fifo_time = next->fifo_time;
1697         }
1698
1699         if (bfqq->next_rq == next)
1700                 bfqq->next_rq = rq;
1701
1702         bfq_remove_request(q, next);
1703
1704 end:
1705         bfqg_stats_update_io_merged(bfqq_group(bfqq), next->cmd_flags);
1706 }
1707
1708 /* Must be called with bfqq != NULL */
1709 static void bfq_bfqq_end_wr(struct bfq_queue *bfqq)
1710 {
1711         if (bfq_bfqq_busy(bfqq))
1712                 bfqq->bfqd->wr_busy_queues--;
1713         bfqq->wr_coeff = 1;
1714         bfqq->wr_cur_max_time = 0;
1715         bfqq->last_wr_start_finish = jiffies;
1716         /*
1717          * Trigger a weight change on the next invocation of
1718          * __bfq_entity_update_weight_prio.
1719          */
1720         bfqq->entity.prio_changed = 1;
1721 }
1722
1723 void bfq_end_wr_async_queues(struct bfq_data *bfqd,
1724                              struct bfq_group *bfqg)
1725 {
1726         int i, j;
1727
1728         for (i = 0; i < 2; i++)
1729                 for (j = 0; j < IOPRIO_BE_NR; j++)
1730                         if (bfqg->async_bfqq[i][j])
1731                                 bfq_bfqq_end_wr(bfqg->async_bfqq[i][j]);
1732         if (bfqg->async_idle_bfqq)
1733                 bfq_bfqq_end_wr(bfqg->async_idle_bfqq);
1734 }
1735
1736 static void bfq_end_wr(struct bfq_data *bfqd)
1737 {
1738         struct bfq_queue *bfqq;
1739
1740         spin_lock_irq(&bfqd->lock);
1741
1742         list_for_each_entry(bfqq, &bfqd->active_list, bfqq_list)
1743                 bfq_bfqq_end_wr(bfqq);
1744         list_for_each_entry(bfqq, &bfqd->idle_list, bfqq_list)
1745                 bfq_bfqq_end_wr(bfqq);
1746         bfq_end_wr_async(bfqd);
1747
1748         spin_unlock_irq(&bfqd->lock);
1749 }
1750
1751 static sector_t bfq_io_struct_pos(void *io_struct, bool request)
1752 {
1753         if (request)
1754                 return blk_rq_pos(io_struct);
1755         else
1756                 return ((struct bio *)io_struct)->bi_iter.bi_sector;
1757 }
1758
1759 static int bfq_rq_close_to_sector(void *io_struct, bool request,
1760                                   sector_t sector)
1761 {
1762         return abs(bfq_io_struct_pos(io_struct, request) - sector) <=
1763                BFQQ_CLOSE_THR;
1764 }
1765
1766 static struct bfq_queue *bfqq_find_close(struct bfq_data *bfqd,
1767                                          struct bfq_queue *bfqq,
1768                                          sector_t sector)
1769 {
1770         struct rb_root *root = &bfq_bfqq_to_bfqg(bfqq)->rq_pos_tree;
1771         struct rb_node *parent, *node;
1772         struct bfq_queue *__bfqq;
1773
1774         if (RB_EMPTY_ROOT(root))
1775                 return NULL;
1776
1777         /*
1778          * First, if we find a request starting at the end of the last
1779          * request, choose it.
1780          */
1781         __bfqq = bfq_rq_pos_tree_lookup(bfqd, root, sector, &parent, NULL);
1782         if (__bfqq)
1783                 return __bfqq;
1784
1785         /*
1786          * If the exact sector wasn't found, the parent of the NULL leaf
1787          * will contain the closest sector (rq_pos_tree sorted by
1788          * next_request position).
1789          */
1790         __bfqq = rb_entry(parent, struct bfq_queue, pos_node);
1791         if (bfq_rq_close_to_sector(__bfqq->next_rq, true, sector))
1792                 return __bfqq;
1793
1794         if (blk_rq_pos(__bfqq->next_rq) < sector)
1795                 node = rb_next(&__bfqq->pos_node);
1796         else
1797                 node = rb_prev(&__bfqq->pos_node);
1798         if (!node)
1799                 return NULL;
1800
1801         __bfqq = rb_entry(node, struct bfq_queue, pos_node);
1802         if (bfq_rq_close_to_sector(__bfqq->next_rq, true, sector))
1803                 return __bfqq;
1804
1805         return NULL;
1806 }
1807
1808 static struct bfq_queue *bfq_find_close_cooperator(struct bfq_data *bfqd,
1809                                                    struct bfq_queue *cur_bfqq,
1810                                                    sector_t sector)
1811 {
1812         struct bfq_queue *bfqq;
1813
1814         /*
1815          * We shall notice if some of the queues are cooperating,
1816          * e.g., working closely on the same area of the device. In
1817          * that case, we can group them together and: 1) don't waste
1818          * time idling, and 2) serve the union of their requests in
1819          * the best possible order for throughput.
1820          */
1821         bfqq = bfqq_find_close(bfqd, cur_bfqq, sector);
1822         if (!bfqq || bfqq == cur_bfqq)
1823                 return NULL;
1824
1825         return bfqq;
1826 }
1827
1828 static struct bfq_queue *
1829 bfq_setup_merge(struct bfq_queue *bfqq, struct bfq_queue *new_bfqq)
1830 {
1831         int process_refs, new_process_refs;
1832         struct bfq_queue *__bfqq;
1833
1834         /*
1835          * If there are no process references on the new_bfqq, then it is
1836          * unsafe to follow the ->new_bfqq chain as other bfqq's in the chain
1837          * may have dropped their last reference (not just their last process
1838          * reference).
1839          */
1840         if (!bfqq_process_refs(new_bfqq))
1841                 return NULL;
1842
1843         /* Avoid a circular list and skip interim queue merges. */
1844         while ((__bfqq = new_bfqq->new_bfqq)) {
1845                 if (__bfqq == bfqq)
1846                         return NULL;
1847                 new_bfqq = __bfqq;
1848         }
1849
1850         process_refs = bfqq_process_refs(bfqq);
1851         new_process_refs = bfqq_process_refs(new_bfqq);
1852         /*
1853          * If the process for the bfqq has gone away, there is no
1854          * sense in merging the queues.
1855          */
1856         if (process_refs == 0 || new_process_refs == 0)
1857                 return NULL;
1858
1859         bfq_log_bfqq(bfqq->bfqd, bfqq, "scheduling merge with queue %d",
1860                 new_bfqq->pid);
1861
1862         /*
1863          * Merging is just a redirection: the requests of the process
1864          * owning one of the two queues are redirected to the other queue.
1865          * The latter queue, in its turn, is set as shared if this is the
1866          * first time that the requests of some process are redirected to
1867          * it.
1868          *
1869          * We redirect bfqq to new_bfqq and not the opposite, because
1870          * we are in the context of the process owning bfqq, thus we
1871          * have the io_cq of this process. So we can immediately
1872          * configure this io_cq to redirect the requests of the
1873          * process to new_bfqq. In contrast, the io_cq of new_bfqq is
1874          * not available any more (new_bfqq->bic == NULL).
1875          *
1876          * Anyway, even in case new_bfqq coincides with the in-service
1877          * queue, redirecting requests the in-service queue is the
1878          * best option, as we feed the in-service queue with new
1879          * requests close to the last request served and, by doing so,
1880          * are likely to increase the throughput.
1881          */
1882         bfqq->new_bfqq = new_bfqq;
1883         new_bfqq->ref += process_refs;
1884         return new_bfqq;
1885 }
1886
1887 static bool bfq_may_be_close_cooperator(struct bfq_queue *bfqq,
1888                                         struct bfq_queue *new_bfqq)
1889 {
1890         if (bfq_class_idle(bfqq) || bfq_class_idle(new_bfqq) ||
1891             (bfqq->ioprio_class != new_bfqq->ioprio_class))
1892                 return false;
1893
1894         /*
1895          * If either of the queues has already been detected as seeky,
1896          * then merging it with the other queue is unlikely to lead to
1897          * sequential I/O.
1898          */
1899         if (BFQQ_SEEKY(bfqq) || BFQQ_SEEKY(new_bfqq))
1900                 return false;
1901
1902         /*
1903          * Interleaved I/O is known to be done by (some) applications
1904          * only for reads, so it does not make sense to merge async
1905          * queues.
1906          */
1907         if (!bfq_bfqq_sync(bfqq) || !bfq_bfqq_sync(new_bfqq))
1908                 return false;
1909
1910         return true;
1911 }
1912
1913 /*
1914  * If this function returns true, then bfqq cannot be merged. The idea
1915  * is that true cooperation happens very early after processes start
1916  * to do I/O. Usually, late cooperations are just accidental false
1917  * positives. In case bfqq is weight-raised, such false positives
1918  * would evidently degrade latency guarantees for bfqq.
1919  */
1920 static bool wr_from_too_long(struct bfq_queue *bfqq)
1921 {
1922         return bfqq->wr_coeff > 1 &&
1923                 time_is_before_jiffies(bfqq->last_wr_start_finish +
1924                                        msecs_to_jiffies(100));
1925 }
1926
1927 /*
1928  * Attempt to schedule a merge of bfqq with the currently in-service
1929  * queue or with a close queue among the scheduled queues.  Return
1930  * NULL if no merge was scheduled, a pointer to the shared bfq_queue
1931  * structure otherwise.
1932  *
1933  * The OOM queue is not allowed to participate to cooperation: in fact, since
1934  * the requests temporarily redirected to the OOM queue could be redirected
1935  * again to dedicated queues at any time, the state needed to correctly
1936  * handle merging with the OOM queue would be quite complex and expensive
1937  * to maintain. Besides, in such a critical condition as an out of memory,
1938  * the benefits of queue merging may be little relevant, or even negligible.
1939  *
1940  * Weight-raised queues can be merged only if their weight-raising
1941  * period has just started. In fact cooperating processes are usually
1942  * started together. Thus, with this filter we avoid false positives
1943  * that would jeopardize low-latency guarantees.
1944  *
1945  * WARNING: queue merging may impair fairness among non-weight raised
1946  * queues, for at least two reasons: 1) the original weight of a
1947  * merged queue may change during the merged state, 2) even being the
1948  * weight the same, a merged queue may be bloated with many more
1949  * requests than the ones produced by its originally-associated
1950  * process.
1951  */
1952 static struct bfq_queue *
1953 bfq_setup_cooperator(struct bfq_data *bfqd, struct bfq_queue *bfqq,
1954                      void *io_struct, bool request)
1955 {
1956         struct bfq_queue *in_service_bfqq, *new_bfqq;
1957
1958         if (bfqq->new_bfqq)
1959                 return bfqq->new_bfqq;
1960
1961         if (!io_struct ||
1962             wr_from_too_long(bfqq) ||
1963             unlikely(bfqq == &bfqd->oom_bfqq))
1964                 return NULL;
1965
1966         /* If there is only one backlogged queue, don't search. */
1967         if (bfqd->busy_queues == 1)
1968                 return NULL;
1969
1970         in_service_bfqq = bfqd->in_service_queue;
1971
1972         if (!in_service_bfqq || in_service_bfqq == bfqq
1973             || wr_from_too_long(in_service_bfqq) ||
1974             unlikely(in_service_bfqq == &bfqd->oom_bfqq))
1975                 goto check_scheduled;
1976
1977         if (bfq_rq_close_to_sector(io_struct, request, bfqd->last_position) &&
1978             bfqq->entity.parent == in_service_bfqq->entity.parent &&
1979             bfq_may_be_close_cooperator(bfqq, in_service_bfqq)) {
1980                 new_bfqq = bfq_setup_merge(bfqq, in_service_bfqq);
1981                 if (new_bfqq)
1982                         return new_bfqq;
1983         }
1984         /*
1985          * Check whether there is a cooperator among currently scheduled
1986          * queues. The only thing we need is that the bio/request is not
1987          * NULL, as we need it to establish whether a cooperator exists.
1988          */
1989 check_scheduled:
1990         new_bfqq = bfq_find_close_cooperator(bfqd, bfqq,
1991                         bfq_io_struct_pos(io_struct, request));
1992
1993         if (new_bfqq && !wr_from_too_long(new_bfqq) &&
1994             likely(new_bfqq != &bfqd->oom_bfqq) &&
1995             bfq_may_be_close_cooperator(bfqq, new_bfqq))
1996                 return bfq_setup_merge(bfqq, new_bfqq);
1997
1998         return NULL;
1999 }
2000
2001 static void bfq_bfqq_save_state(struct bfq_queue *bfqq)
2002 {
2003         struct bfq_io_cq *bic = bfqq->bic;
2004
2005         /*
2006          * If !bfqq->bic, the queue is already shared or its requests
2007          * have already been redirected to a shared queue; both idle window
2008          * and weight raising state have already been saved. Do nothing.
2009          */
2010         if (!bic)
2011                 return;
2012
2013         bic->saved_ttime = bfqq->ttime;
2014         bic->saved_has_short_ttime = bfq_bfqq_has_short_ttime(bfqq);
2015         bic->saved_IO_bound = bfq_bfqq_IO_bound(bfqq);
2016         bic->saved_in_large_burst = bfq_bfqq_in_large_burst(bfqq);
2017         bic->was_in_burst_list = !hlist_unhashed(&bfqq->burst_list_node);
2018         bic->saved_wr_coeff = bfqq->wr_coeff;
2019         bic->saved_wr_start_at_switch_to_srt = bfqq->wr_start_at_switch_to_srt;
2020         bic->saved_last_wr_start_finish = bfqq->last_wr_start_finish;
2021         bic->saved_wr_cur_max_time = bfqq->wr_cur_max_time;
2022 }
2023
2024 static void
2025 bfq_merge_bfqqs(struct bfq_data *bfqd, struct bfq_io_cq *bic,
2026                 struct bfq_queue *bfqq, struct bfq_queue *new_bfqq)
2027 {
2028         bfq_log_bfqq(bfqd, bfqq, "merging with queue %lu",
2029                 (unsigned long)new_bfqq->pid);
2030         /* Save weight raising and idle window of the merged queues */
2031         bfq_bfqq_save_state(bfqq);
2032         bfq_bfqq_save_state(new_bfqq);
2033         if (bfq_bfqq_IO_bound(bfqq))
2034                 bfq_mark_bfqq_IO_bound(new_bfqq);
2035         bfq_clear_bfqq_IO_bound(bfqq);
2036
2037         /*
2038          * If bfqq is weight-raised, then let new_bfqq inherit
2039          * weight-raising. To reduce false positives, neglect the case
2040          * where bfqq has just been created, but has not yet made it
2041          * to be weight-raised (which may happen because EQM may merge
2042          * bfqq even before bfq_add_request is executed for the first
2043          * time for bfqq). Handling this case would however be very
2044          * easy, thanks to the flag just_created.
2045          */
2046         if (new_bfqq->wr_coeff == 1 && bfqq->wr_coeff > 1) {
2047                 new_bfqq->wr_coeff = bfqq->wr_coeff;
2048                 new_bfqq->wr_cur_max_time = bfqq->wr_cur_max_time;
2049                 new_bfqq->last_wr_start_finish = bfqq->last_wr_start_finish;
2050                 new_bfqq->wr_start_at_switch_to_srt =
2051                         bfqq->wr_start_at_switch_to_srt;
2052                 if (bfq_bfqq_busy(new_bfqq))
2053                         bfqd->wr_busy_queues++;
2054                 new_bfqq->entity.prio_changed = 1;
2055         }
2056
2057         if (bfqq->wr_coeff > 1) { /* bfqq has given its wr to new_bfqq */
2058                 bfqq->wr_coeff = 1;
2059                 bfqq->entity.prio_changed = 1;
2060                 if (bfq_bfqq_busy(bfqq))
2061                         bfqd->wr_busy_queues--;
2062         }
2063
2064         bfq_log_bfqq(bfqd, new_bfqq, "merge_bfqqs: wr_busy %d",
2065                      bfqd->wr_busy_queues);
2066
2067         /*
2068          * Merge queues (that is, let bic redirect its requests to new_bfqq)
2069          */
2070         bic_set_bfqq(bic, new_bfqq, 1);
2071         bfq_mark_bfqq_coop(new_bfqq);
2072         /*
2073          * new_bfqq now belongs to at least two bics (it is a shared queue):
2074          * set new_bfqq->bic to NULL. bfqq either:
2075          * - does not belong to any bic any more, and hence bfqq->bic must
2076          *   be set to NULL, or
2077          * - is a queue whose owning bics have already been redirected to a
2078          *   different queue, hence the queue is destined to not belong to
2079          *   any bic soon and bfqq->bic is already NULL (therefore the next
2080          *   assignment causes no harm).
2081          */
2082         new_bfqq->bic = NULL;
2083         bfqq->bic = NULL;
2084         /* release process reference to bfqq */
2085         bfq_put_queue(bfqq);
2086 }
2087
2088 static bool bfq_allow_bio_merge(struct request_queue *q, struct request *rq,
2089                                 struct bio *bio)
2090 {
2091         struct bfq_data *bfqd = q->elevator->elevator_data;
2092         bool is_sync = op_is_sync(bio->bi_opf);
2093         struct bfq_queue *bfqq = bfqd->bio_bfqq, *new_bfqq;
2094
2095         /*
2096          * Disallow merge of a sync bio into an async request.
2097          */
2098         if (is_sync && !rq_is_sync(rq))
2099                 return false;
2100
2101         /*
2102          * Lookup the bfqq that this bio will be queued with. Allow
2103          * merge only if rq is queued there.
2104          */
2105         if (!bfqq)
2106                 return false;
2107
2108         /*
2109          * We take advantage of this function to perform an early merge
2110          * of the queues of possible cooperating processes.
2111          */
2112         new_bfqq = bfq_setup_cooperator(bfqd, bfqq, bio, false);
2113         if (new_bfqq) {
2114                 /*
2115                  * bic still points to bfqq, then it has not yet been
2116                  * redirected to some other bfq_queue, and a queue
2117                  * merge beween bfqq and new_bfqq can be safely
2118                  * fulfillled, i.e., bic can be redirected to new_bfqq
2119                  * and bfqq can be put.
2120                  */
2121                 bfq_merge_bfqqs(bfqd, bfqd->bio_bic, bfqq,
2122                                 new_bfqq);
2123                 /*
2124                  * If we get here, bio will be queued into new_queue,
2125                  * so use new_bfqq to decide whether bio and rq can be
2126                  * merged.
2127                  */
2128                 bfqq = new_bfqq;
2129
2130                 /*
2131                  * Change also bqfd->bio_bfqq, as
2132                  * bfqd->bio_bic now points to new_bfqq, and
2133                  * this function may be invoked again (and then may
2134                  * use again bqfd->bio_bfqq).
2135                  */
2136                 bfqd->bio_bfqq = bfqq;
2137         }
2138
2139         return bfqq == RQ_BFQQ(rq);
2140 }
2141
2142 /*
2143  * Set the maximum time for the in-service queue to consume its
2144  * budget. This prevents seeky processes from lowering the throughput.
2145  * In practice, a time-slice service scheme is used with seeky
2146  * processes.
2147  */
2148 static void bfq_set_budget_timeout(struct bfq_data *bfqd,
2149                                    struct bfq_queue *bfqq)
2150 {
2151         unsigned int timeout_coeff;
2152
2153         if (bfqq->wr_cur_max_time == bfqd->bfq_wr_rt_max_time)
2154                 timeout_coeff = 1;
2155         else
2156                 timeout_coeff = bfqq->entity.weight / bfqq->entity.orig_weight;
2157
2158         bfqd->last_budget_start = ktime_get();
2159
2160         bfqq->budget_timeout = jiffies +
2161                 bfqd->bfq_timeout * timeout_coeff;
2162 }
2163
2164 static void __bfq_set_in_service_queue(struct bfq_data *bfqd,
2165                                        struct bfq_queue *bfqq)
2166 {
2167         if (bfqq) {
2168                 bfqg_stats_update_avg_queue_size(bfqq_group(bfqq));
2169                 bfq_clear_bfqq_fifo_expire(bfqq);
2170
2171                 bfqd->budgets_assigned = (bfqd->budgets_assigned * 7 + 256) / 8;
2172
2173                 if (time_is_before_jiffies(bfqq->last_wr_start_finish) &&
2174                     bfqq->wr_coeff > 1 &&
2175                     bfqq->wr_cur_max_time == bfqd->bfq_wr_rt_max_time &&
2176                     time_is_before_jiffies(bfqq->budget_timeout)) {
2177                         /*
2178                          * For soft real-time queues, move the start
2179                          * of the weight-raising period forward by the
2180                          * time the queue has not received any
2181                          * service. Otherwise, a relatively long
2182                          * service delay is likely to cause the
2183                          * weight-raising period of the queue to end,
2184                          * because of the short duration of the
2185                          * weight-raising period of a soft real-time
2186                          * queue.  It is worth noting that this move
2187                          * is not so dangerous for the other queues,
2188                          * because soft real-time queues are not
2189                          * greedy.
2190                          *
2191                          * To not add a further variable, we use the
2192                          * overloaded field budget_timeout to
2193                          * determine for how long the queue has not
2194                          * received service, i.e., how much time has
2195                          * elapsed since the queue expired. However,
2196                          * this is a little imprecise, because
2197                          * budget_timeout is set to jiffies if bfqq
2198                          * not only expires, but also remains with no
2199                          * request.
2200                          */
2201                         if (time_after(bfqq->budget_timeout,
2202                                        bfqq->last_wr_start_finish))
2203                                 bfqq->last_wr_start_finish +=
2204                                         jiffies - bfqq->budget_timeout;
2205                         else
2206                                 bfqq->last_wr_start_finish = jiffies;
2207                 }
2208
2209                 bfq_set_budget_timeout(bfqd, bfqq);
2210                 bfq_log_bfqq(bfqd, bfqq,
2211                              "set_in_service_queue, cur-budget = %d",
2212                              bfqq->entity.budget);
2213         }
2214
2215         bfqd->in_service_queue = bfqq;
2216 }
2217
2218 /*
2219  * Get and set a new queue for service.
2220  */
2221 static struct bfq_queue *bfq_set_in_service_queue(struct bfq_data *bfqd)
2222 {
2223         struct bfq_queue *bfqq = bfq_get_next_queue(bfqd);
2224
2225         __bfq_set_in_service_queue(bfqd, bfqq);
2226         return bfqq;
2227 }
2228
2229 static void bfq_arm_slice_timer(struct bfq_data *bfqd)
2230 {
2231         struct bfq_queue *bfqq = bfqd->in_service_queue;
2232         u32 sl;
2233
2234         bfq_mark_bfqq_wait_request(bfqq);
2235
2236         /*
2237          * We don't want to idle for seeks, but we do want to allow
2238          * fair distribution of slice time for a process doing back-to-back
2239          * seeks. So allow a little bit of time for him to submit a new rq.
2240          */
2241         sl = bfqd->bfq_slice_idle;
2242         /*
2243          * Unless the queue is being weight-raised or the scenario is
2244          * asymmetric, grant only minimum idle time if the queue
2245          * is seeky. A long idling is preserved for a weight-raised
2246          * queue, or, more in general, in an asymmetric scenario,
2247          * because a long idling is needed for guaranteeing to a queue
2248          * its reserved share of the throughput (in particular, it is
2249          * needed if the queue has a higher weight than some other
2250          * queue).
2251          */
2252         if (BFQQ_SEEKY(bfqq) && bfqq->wr_coeff == 1 &&
2253             bfq_symmetric_scenario(bfqd))
2254                 sl = min_t(u64, sl, BFQ_MIN_TT);
2255
2256         bfqd->last_idling_start = ktime_get();
2257         hrtimer_start(&bfqd->idle_slice_timer, ns_to_ktime(sl),
2258                       HRTIMER_MODE_REL);
2259         bfqg_stats_set_start_idle_time(bfqq_group(bfqq));
2260 }
2261
2262 /*
2263  * In autotuning mode, max_budget is dynamically recomputed as the
2264  * amount of sectors transferred in timeout at the estimated peak
2265  * rate. This enables BFQ to utilize a full timeslice with a full
2266  * budget, even if the in-service queue is served at peak rate. And
2267  * this maximises throughput with sequential workloads.
2268  */
2269 static unsigned long bfq_calc_max_budget(struct bfq_data *bfqd)
2270 {
2271         return (u64)bfqd->peak_rate * USEC_PER_MSEC *
2272                 jiffies_to_msecs(bfqd->bfq_timeout)>>BFQ_RATE_SHIFT;
2273 }
2274
2275 /*
2276  * Update parameters related to throughput and responsiveness, as a
2277  * function of the estimated peak rate. See comments on
2278  * bfq_calc_max_budget(), and on T_slow and T_fast arrays.
2279  */
2280 static void update_thr_responsiveness_params(struct bfq_data *bfqd)
2281 {
2282         int dev_type = blk_queue_nonrot(bfqd->queue);
2283
2284         if (bfqd->bfq_user_max_budget == 0)
2285                 bfqd->bfq_max_budget =
2286                         bfq_calc_max_budget(bfqd);
2287
2288         if (bfqd->device_speed == BFQ_BFQD_FAST &&
2289             bfqd->peak_rate < device_speed_thresh[dev_type]) {
2290                 bfqd->device_speed = BFQ_BFQD_SLOW;
2291                 bfqd->RT_prod = R_slow[dev_type] *
2292                         T_slow[dev_type];
2293         } else if (bfqd->device_speed == BFQ_BFQD_SLOW &&
2294                    bfqd->peak_rate > device_speed_thresh[dev_type]) {
2295                 bfqd->device_speed = BFQ_BFQD_FAST;
2296                 bfqd->RT_prod = R_fast[dev_type] *
2297                         T_fast[dev_type];
2298         }
2299
2300         bfq_log(bfqd,
2301 "dev_type %s dev_speed_class = %s (%llu sects/sec), thresh %llu setcs/sec",
2302                 dev_type == 0 ? "ROT" : "NONROT",
2303                 bfqd->device_speed == BFQ_BFQD_FAST ? "FAST" : "SLOW",
2304                 bfqd->device_speed == BFQ_BFQD_FAST ?
2305                 (USEC_PER_SEC*(u64)R_fast[dev_type])>>BFQ_RATE_SHIFT :
2306                 (USEC_PER_SEC*(u64)R_slow[dev_type])>>BFQ_RATE_SHIFT,
2307                 (USEC_PER_SEC*(u64)device_speed_thresh[dev_type])>>
2308                 BFQ_RATE_SHIFT);
2309 }
2310
2311 static void bfq_reset_rate_computation(struct bfq_data *bfqd,
2312                                        struct request *rq)
2313 {
2314         if (rq != NULL) { /* new rq dispatch now, reset accordingly */
2315                 bfqd->last_dispatch = bfqd->first_dispatch = ktime_get_ns();
2316                 bfqd->peak_rate_samples = 1;
2317                 bfqd->sequential_samples = 0;
2318                 bfqd->tot_sectors_dispatched = bfqd->last_rq_max_size =
2319                         blk_rq_sectors(rq);
2320         } else /* no new rq dispatched, just reset the number of samples */
2321                 bfqd->peak_rate_samples = 0; /* full re-init on next disp. */
2322
2323         bfq_log(bfqd,
2324                 "reset_rate_computation at end, sample %u/%u tot_sects %llu",
2325                 bfqd->peak_rate_samples, bfqd->sequential_samples,
2326                 bfqd->tot_sectors_dispatched);
2327 }
2328
2329 static void bfq_update_rate_reset(struct bfq_data *bfqd, struct request *rq)
2330 {
2331         u32 rate, weight, divisor;
2332
2333         /*
2334          * For the convergence property to hold (see comments on
2335          * bfq_update_peak_rate()) and for the assessment to be
2336          * reliable, a minimum number of samples must be present, and
2337          * a minimum amount of time must have elapsed. If not so, do
2338          * not compute new rate. Just reset parameters, to get ready
2339          * for a new evaluation attempt.
2340          */
2341         if (bfqd->peak_rate_samples < BFQ_RATE_MIN_SAMPLES ||
2342             bfqd->delta_from_first < BFQ_RATE_MIN_INTERVAL)
2343                 goto reset_computation;
2344
2345         /*
2346          * If a new request completion has occurred after last
2347          * dispatch, then, to approximate the rate at which requests
2348          * have been served by the device, it is more precise to
2349          * extend the observation interval to the last completion.
2350          */
2351         bfqd->delta_from_first =
2352                 max_t(u64, bfqd->delta_from_first,
2353                       bfqd->last_completion - bfqd->first_dispatch);
2354
2355         /*
2356          * Rate computed in sects/usec, and not sects/nsec, for
2357          * precision issues.
2358          */
2359         rate = div64_ul(bfqd->tot_sectors_dispatched<<BFQ_RATE_SHIFT,
2360                         div_u64(bfqd->delta_from_first, NSEC_PER_USEC));
2361
2362         /*
2363          * Peak rate not updated if:
2364          * - the percentage of sequential dispatches is below 3/4 of the
2365          *   total, and rate is below the current estimated peak rate
2366          * - rate is unreasonably high (> 20M sectors/sec)
2367          */
2368         if ((bfqd->sequential_samples < (3 * bfqd->peak_rate_samples)>>2 &&
2369              rate <= bfqd->peak_rate) ||
2370                 rate > 20<<BFQ_RATE_SHIFT)
2371                 goto reset_computation;
2372
2373         /*
2374          * We have to update the peak rate, at last! To this purpose,
2375          * we use a low-pass filter. We compute the smoothing constant
2376          * of the filter as a function of the 'weight' of the new
2377          * measured rate.
2378          *
2379          * As can be seen in next formulas, we define this weight as a
2380          * quantity proportional to how sequential the workload is,
2381          * and to how long the observation time interval is.
2382          *
2383          * The weight runs from 0 to 8. The maximum value of the
2384          * weight, 8, yields the minimum value for the smoothing
2385          * constant. At this minimum value for the smoothing constant,
2386          * the measured rate contributes for half of the next value of
2387          * the estimated peak rate.
2388          *
2389          * So, the first step is to compute the weight as a function
2390          * of how sequential the workload is. Note that the weight
2391          * cannot reach 9, because bfqd->sequential_samples cannot
2392          * become equal to bfqd->peak_rate_samples, which, in its
2393          * turn, holds true because bfqd->sequential_samples is not
2394          * incremented for the first sample.
2395          */
2396         weight = (9 * bfqd->sequential_samples) / bfqd->peak_rate_samples;
2397
2398         /*
2399          * Second step: further refine the weight as a function of the
2400          * duration of the observation interval.
2401          */
2402         weight = min_t(u32, 8,
2403                        div_u64(weight * bfqd->delta_from_first,
2404                                BFQ_RATE_REF_INTERVAL));
2405
2406         /*
2407          * Divisor ranging from 10, for minimum weight, to 2, for
2408          * maximum weight.
2409          */
2410         divisor = 10 - weight;
2411
2412         /*
2413          * Finally, update peak rate:
2414          *
2415          * peak_rate = peak_rate * (divisor-1) / divisor  +  rate / divisor
2416          */
2417         bfqd->peak_rate *= divisor-1;
2418         bfqd->peak_rate /= divisor;
2419         rate /= divisor; /* smoothing constant alpha = 1/divisor */
2420
2421         bfqd->peak_rate += rate;
2422         update_thr_responsiveness_params(bfqd);
2423
2424 reset_computation:
2425         bfq_reset_rate_computation(bfqd, rq);
2426 }
2427
2428 /*
2429  * Update the read/write peak rate (the main quantity used for
2430  * auto-tuning, see update_thr_responsiveness_params()).
2431  *
2432  * It is not trivial to estimate the peak rate (correctly): because of
2433  * the presence of sw and hw queues between the scheduler and the
2434  * device components that finally serve I/O requests, it is hard to
2435  * say exactly when a given dispatched request is served inside the
2436  * device, and for how long. As a consequence, it is hard to know
2437  * precisely at what rate a given set of requests is actually served
2438  * by the device.
2439  *
2440  * On the opposite end, the dispatch time of any request is trivially
2441  * available, and, from this piece of information, the "dispatch rate"
2442  * of requests can be immediately computed. So, the idea in the next
2443  * function is to use what is known, namely request dispatch times
2444  * (plus, when useful, request completion times), to estimate what is
2445  * unknown, namely in-device request service rate.
2446  *
2447  * The main issue is that, because of the above facts, the rate at
2448  * which a certain set of requests is dispatched over a certain time
2449  * interval can vary greatly with respect to the rate at which the
2450  * same requests are then served. But, since the size of any
2451  * intermediate queue is limited, and the service scheme is lossless
2452  * (no request is silently dropped), the following obvious convergence
2453  * property holds: the number of requests dispatched MUST become
2454  * closer and closer to the number of requests completed as the
2455  * observation interval grows. This is the key property used in
2456  * the next function to estimate the peak service rate as a function
2457  * of the observed dispatch rate. The function assumes to be invoked
2458  * on every request dispatch.
2459  */
2460 static void bfq_update_peak_rate(struct bfq_data *bfqd, struct request *rq)
2461 {
2462         u64 now_ns = ktime_get_ns();
2463
2464         if (bfqd->peak_rate_samples == 0) { /* first dispatch */
2465                 bfq_log(bfqd, "update_peak_rate: goto reset, samples %d",
2466                         bfqd->peak_rate_samples);
2467                 bfq_reset_rate_computation(bfqd, rq);
2468                 goto update_last_values; /* will add one sample */
2469         }
2470
2471         /*
2472          * Device idle for very long: the observation interval lasting
2473          * up to this dispatch cannot be a valid observation interval
2474          * for computing a new peak rate (similarly to the late-
2475          * completion event in bfq_completed_request()). Go to
2476          * update_rate_and_reset to have the following three steps
2477          * taken:
2478          * - close the observation interval at the last (previous)
2479          *   request dispatch or completion
2480          * - compute rate, if possible, for that observation interval
2481          * - start a new observation interval with this dispatch
2482          */
2483         if (now_ns - bfqd->last_dispatch > 100*NSEC_PER_MSEC &&
2484             bfqd->rq_in_driver == 0)
2485                 goto update_rate_and_reset;
2486
2487         /* Update sampling information */
2488         bfqd->peak_rate_samples++;
2489
2490         if ((bfqd->rq_in_driver > 0 ||
2491                 now_ns - bfqd->last_completion < BFQ_MIN_TT)
2492              && get_sdist(bfqd->last_position, rq) < BFQQ_SEEK_THR)
2493                 bfqd->sequential_samples++;
2494
2495         bfqd->tot_sectors_dispatched += blk_rq_sectors(rq);
2496
2497         /* Reset max observed rq size every 32 dispatches */
2498         if (likely(bfqd->peak_rate_samples % 32))
2499                 bfqd->last_rq_max_size =
2500                         max_t(u32, blk_rq_sectors(rq), bfqd->last_rq_max_size);
2501         else
2502                 bfqd->last_rq_max_size = blk_rq_sectors(rq);
2503
2504         bfqd->delta_from_first = now_ns - bfqd->first_dispatch;
2505
2506         /* Target observation interval not yet reached, go on sampling */
2507         if (bfqd->delta_from_first < BFQ_RATE_REF_INTERVAL)
2508                 goto update_last_values;
2509
2510 update_rate_and_reset:
2511         bfq_update_rate_reset(bfqd, rq);
2512 update_last_values:
2513         bfqd->last_position = blk_rq_pos(rq) + blk_rq_sectors(rq);
2514         bfqd->last_dispatch = now_ns;
2515 }
2516
2517 /*
2518  * Remove request from internal lists.
2519  */
2520 static void bfq_dispatch_remove(struct request_queue *q, struct request *rq)
2521 {
2522         struct bfq_queue *bfqq = RQ_BFQQ(rq);
2523
2524         /*
2525          * For consistency, the next instruction should have been
2526          * executed after removing the request from the queue and
2527          * dispatching it.  We execute instead this instruction before
2528          * bfq_remove_request() (and hence introduce a temporary
2529          * inconsistency), for efficiency.  In fact, should this
2530          * dispatch occur for a non in-service bfqq, this anticipated
2531          * increment prevents two counters related to bfqq->dispatched
2532          * from risking to be, first, uselessly decremented, and then
2533          * incremented again when the (new) value of bfqq->dispatched
2534          * happens to be taken into account.
2535          */
2536         bfqq->dispatched++;
2537         bfq_update_peak_rate(q->elevator->elevator_data, rq);
2538
2539         bfq_remove_request(q, rq);
2540 }
2541
2542 static void __bfq_bfqq_expire(struct bfq_data *bfqd, struct bfq_queue *bfqq)
2543 {
2544         /*
2545          * If this bfqq is shared between multiple processes, check
2546          * to make sure that those processes are still issuing I/Os
2547          * within the mean seek distance. If not, it may be time to
2548          * break the queues apart again.
2549          */
2550         if (bfq_bfqq_coop(bfqq) && BFQQ_SEEKY(bfqq))
2551                 bfq_mark_bfqq_split_coop(bfqq);
2552
2553         if (RB_EMPTY_ROOT(&bfqq->sort_list)) {
2554                 if (bfqq->dispatched == 0)
2555                         /*
2556                          * Overloading budget_timeout field to store
2557                          * the time at which the queue remains with no
2558                          * backlog and no outstanding request; used by
2559                          * the weight-raising mechanism.
2560                          */
2561                         bfqq->budget_timeout = jiffies;
2562
2563                 bfq_del_bfqq_busy(bfqd, bfqq, true);
2564         } else {
2565                 bfq_requeue_bfqq(bfqd, bfqq, true);
2566                 /*
2567                  * Resort priority tree of potential close cooperators.
2568                  */
2569                 bfq_pos_tree_add_move(bfqd, bfqq);
2570         }
2571
2572         /*
2573          * All in-service entities must have been properly deactivated
2574          * or requeued before executing the next function, which
2575          * resets all in-service entites as no more in service.
2576          */
2577         __bfq_bfqd_reset_in_service(bfqd);
2578 }
2579
2580 /**
2581  * __bfq_bfqq_recalc_budget - try to adapt the budget to the @bfqq behavior.
2582  * @bfqd: device data.
2583  * @bfqq: queue to update.
2584  * @reason: reason for expiration.
2585  *
2586  * Handle the feedback on @bfqq budget at queue expiration.
2587  * See the body for detailed comments.
2588  */
2589 static void __bfq_bfqq_recalc_budget(struct bfq_data *bfqd,
2590                                      struct bfq_queue *bfqq,
2591                                      enum bfqq_expiration reason)
2592 {
2593         struct request *next_rq;
2594         int budget, min_budget;
2595
2596         min_budget = bfq_min_budget(bfqd);
2597
2598         if (bfqq->wr_coeff == 1)
2599                 budget = bfqq->max_budget;
2600         else /*
2601               * Use a constant, low budget for weight-raised queues,
2602               * to help achieve a low latency. Keep it slightly higher
2603               * than the minimum possible budget, to cause a little
2604               * bit fewer expirations.
2605               */
2606                 budget = 2 * min_budget;
2607
2608         bfq_log_bfqq(bfqd, bfqq, "recalc_budg: last budg %d, budg left %d",
2609                 bfqq->entity.budget, bfq_bfqq_budget_left(bfqq));
2610         bfq_log_bfqq(bfqd, bfqq, "recalc_budg: last max_budg %d, min budg %d",
2611                 budget, bfq_min_budget(bfqd));
2612         bfq_log_bfqq(bfqd, bfqq, "recalc_budg: sync %d, seeky %d",
2613                 bfq_bfqq_sync(bfqq), BFQQ_SEEKY(bfqd->in_service_queue));
2614
2615         if (bfq_bfqq_sync(bfqq) && bfqq->wr_coeff == 1) {
2616                 switch (reason) {
2617                 /*
2618                  * Caveat: in all the following cases we trade latency
2619                  * for throughput.
2620                  */
2621                 case BFQQE_TOO_IDLE:
2622                         /*
2623                          * This is the only case where we may reduce
2624                          * the budget: if there is no request of the
2625                          * process still waiting for completion, then
2626                          * we assume (tentatively) that the timer has
2627                          * expired because the batch of requests of
2628                          * the process could have been served with a
2629                          * smaller budget.  Hence, betting that
2630                          * process will behave in the same way when it
2631                          * becomes backlogged again, we reduce its
2632                          * next budget.  As long as we guess right,
2633                          * this budget cut reduces the latency
2634                          * experienced by the process.
2635                          *
2636                          * However, if there are still outstanding
2637                          * requests, then the process may have not yet
2638                          * issued its next request just because it is
2639                          * still waiting for the completion of some of
2640                          * the still outstanding ones.  So in this
2641                          * subcase we do not reduce its budget, on the
2642                          * contrary we increase it to possibly boost
2643                          * the throughput, as discussed in the
2644                          * comments to the BUDGET_TIMEOUT case.
2645                          */
2646                         if (bfqq->dispatched > 0) /* still outstanding reqs */
2647                                 budget = min(budget * 2, bfqd->bfq_max_budget);
2648                         else {
2649                                 if (budget > 5 * min_budget)
2650                                         budget -= 4 * min_budget;
2651                                 else
2652                                         budget = min_budget;
2653                         }
2654                         break;
2655                 case BFQQE_BUDGET_TIMEOUT:
2656                         /*
2657                          * We double the budget here because it gives
2658                          * the chance to boost the throughput if this
2659                          * is not a seeky process (and has bumped into
2660                          * this timeout because of, e.g., ZBR).
2661                          */
2662                         budget = min(budget * 2, bfqd->bfq_max_budget);
2663                         break;
2664                 case BFQQE_BUDGET_EXHAUSTED:
2665                         /*
2666                          * The process still has backlog, and did not
2667                          * let either the budget timeout or the disk
2668                          * idling timeout expire. Hence it is not
2669                          * seeky, has a short thinktime and may be
2670                          * happy with a higher budget too. So
2671                          * definitely increase the budget of this good
2672                          * candidate to boost the disk throughput.
2673                          */
2674                         budget = min(budget * 4, bfqd->bfq_max_budget);
2675                         break;
2676                 case BFQQE_NO_MORE_REQUESTS:
2677                         /*
2678                          * For queues that expire for this reason, it
2679                          * is particularly important to keep the
2680                          * budget close to the actual service they
2681                          * need. Doing so reduces the timestamp
2682                          * misalignment problem described in the
2683                          * comments in the body of
2684                          * __bfq_activate_entity. In fact, suppose
2685                          * that a queue systematically expires for
2686                          * BFQQE_NO_MORE_REQUESTS and presents a
2687                          * new request in time to enjoy timestamp
2688                          * back-shifting. The larger the budget of the
2689                          * queue is with respect to the service the
2690                          * queue actually requests in each service
2691                          * slot, the more times the queue can be
2692                          * reactivated with the same virtual finish
2693                          * time. It follows that, even if this finish
2694                          * time is pushed to the system virtual time
2695                          * to reduce the consequent timestamp
2696                          * misalignment, the queue unjustly enjoys for
2697                          * many re-activations a lower finish time
2698                          * than all newly activated queues.
2699                          *
2700                          * The service needed by bfqq is measured
2701                          * quite precisely by bfqq->entity.service.
2702                          * Since bfqq does not enjoy device idling,
2703                          * bfqq->entity.service is equal to the number
2704                          * of sectors that the process associated with
2705                          * bfqq requested to read/write before waiting
2706                          * for request completions, or blocking for
2707                          * other reasons.
2708                          */
2709                         budget = max_t(int, bfqq->entity.service, min_budget);
2710                         break;
2711                 default:
2712                         return;
2713                 }
2714         } else if (!bfq_bfqq_sync(bfqq)) {
2715                 /*
2716                  * Async queues get always the maximum possible
2717                  * budget, as for them we do not care about latency
2718                  * (in addition, their ability to dispatch is limited
2719                  * by the charging factor).
2720                  */
2721                 budget = bfqd->bfq_max_budget;
2722         }
2723
2724         bfqq->max_budget = budget;
2725
2726         if (bfqd->budgets_assigned >= bfq_stats_min_budgets &&
2727             !bfqd->bfq_user_max_budget)
2728                 bfqq->max_budget = min(bfqq->max_budget, bfqd->bfq_max_budget);
2729
2730         /*
2731          * If there is still backlog, then assign a new budget, making
2732          * sure that it is large enough for the next request.  Since
2733          * the finish time of bfqq must be kept in sync with the
2734          * budget, be sure to call __bfq_bfqq_expire() *after* this
2735          * update.
2736          *
2737          * If there is no backlog, then no need to update the budget;
2738          * it will be updated on the arrival of a new request.
2739          */
2740         next_rq = bfqq->next_rq;
2741         if (next_rq)
2742                 bfqq->entity.budget = max_t(unsigned long, bfqq->max_budget,
2743                                             bfq_serv_to_charge(next_rq, bfqq));
2744
2745         bfq_log_bfqq(bfqd, bfqq, "head sect: %u, new budget %d",
2746                         next_rq ? blk_rq_sectors(next_rq) : 0,
2747                         bfqq->entity.budget);
2748 }
2749
2750 /*
2751  * Return true if the process associated with bfqq is "slow". The slow
2752  * flag is used, in addition to the budget timeout, to reduce the
2753  * amount of service provided to seeky processes, and thus reduce
2754  * their chances to lower the throughput. More details in the comments
2755  * on the function bfq_bfqq_expire().
2756  *
2757  * An important observation is in order: as discussed in the comments
2758  * on the function bfq_update_peak_rate(), with devices with internal
2759  * queues, it is hard if ever possible to know when and for how long
2760  * an I/O request is processed by the device (apart from the trivial
2761  * I/O pattern where a new request is dispatched only after the
2762  * previous one has been completed). This makes it hard to evaluate
2763  * the real rate at which the I/O requests of each bfq_queue are
2764  * served.  In fact, for an I/O scheduler like BFQ, serving a
2765  * bfq_queue means just dispatching its requests during its service
2766  * slot (i.e., until the budget of the queue is exhausted, or the
2767  * queue remains idle, or, finally, a timeout fires). But, during the
2768  * service slot of a bfq_queue, around 100 ms at most, the device may
2769  * be even still processing requests of bfq_queues served in previous
2770  * service slots. On the opposite end, the requests of the in-service
2771  * bfq_queue may be completed after the service slot of the queue
2772  * finishes.
2773  *
2774  * Anyway, unless more sophisticated solutions are used
2775  * (where possible), the sum of the sizes of the requests dispatched
2776  * during the service slot of a bfq_queue is probably the only
2777  * approximation available for the service received by the bfq_queue
2778  * during its service slot. And this sum is the quantity used in this
2779  * function to evaluate the I/O speed of a process.
2780  */
2781 static bool bfq_bfqq_is_slow(struct bfq_data *bfqd, struct bfq_queue *bfqq,
2782                                  bool compensate, enum bfqq_expiration reason,
2783                                  unsigned long *delta_ms)
2784 {
2785         ktime_t delta_ktime;
2786         u32 delta_usecs;
2787         bool slow = BFQQ_SEEKY(bfqq); /* if delta too short, use seekyness */
2788
2789         if (!bfq_bfqq_sync(bfqq))
2790                 return false;
2791
2792         if (compensate)
2793                 delta_ktime = bfqd->last_idling_start;
2794         else
2795                 delta_ktime = ktime_get();
2796         delta_ktime = ktime_sub(delta_ktime, bfqd->last_budget_start);
2797         delta_usecs = ktime_to_us(delta_ktime);
2798
2799         /* don't use too short time intervals */
2800         if (delta_usecs < 1000) {
2801                 if (blk_queue_nonrot(bfqd->queue))
2802                          /*
2803                           * give same worst-case guarantees as idling
2804                           * for seeky
2805                           */
2806                         *delta_ms = BFQ_MIN_TT / NSEC_PER_MSEC;
2807                 else /* charge at least one seek */
2808                         *delta_ms = bfq_slice_idle / NSEC_PER_MSEC;
2809
2810                 return slow;
2811         }
2812
2813         *delta_ms = delta_usecs / USEC_PER_MSEC;
2814
2815         /*
2816          * Use only long (> 20ms) intervals to filter out excessive
2817          * spikes in service rate estimation.
2818          */
2819         if (delta_usecs > 20000) {
2820                 /*
2821                  * Caveat for rotational devices: processes doing I/O
2822                  * in the slower disk zones tend to be slow(er) even
2823                  * if not seeky. In this respect, the estimated peak
2824                  * rate is likely to be an average over the disk
2825                  * surface. Accordingly, to not be too harsh with
2826                  * unlucky processes, a process is deemed slow only if
2827                  * its rate has been lower than half of the estimated
2828                  * peak rate.
2829                  */
2830                 slow = bfqq->entity.service < bfqd->bfq_max_budget / 2;
2831         }
2832
2833         bfq_log_bfqq(bfqd, bfqq, "bfq_bfqq_is_slow: slow %d", slow);
2834
2835         return slow;
2836 }
2837
2838 /*
2839  * To be deemed as soft real-time, an application must meet two
2840  * requirements. First, the application must not require an average
2841  * bandwidth higher than the approximate bandwidth required to playback or
2842  * record a compressed high-definition video.
2843  * The next function is invoked on the completion of the last request of a
2844  * batch, to compute the next-start time instant, soft_rt_next_start, such
2845  * that, if the next request of the application does not arrive before
2846  * soft_rt_next_start, then the above requirement on the bandwidth is met.
2847  *
2848  * The second requirement is that the request pattern of the application is
2849  * isochronous, i.e., that, after issuing a request or a batch of requests,
2850  * the application stops issuing new requests until all its pending requests
2851  * have been completed. After that, the application may issue a new batch,
2852  * and so on.
2853  * For this reason the next function is invoked to compute
2854  * soft_rt_next_start only for applications that meet this requirement,
2855  * whereas soft_rt_next_start is set to infinity for applications that do
2856  * not.
2857  *
2858  * Unfortunately, even a greedy application may happen to behave in an
2859  * isochronous way if the CPU load is high. In fact, the application may
2860  * stop issuing requests while the CPUs are busy serving other processes,
2861  * then restart, then stop again for a while, and so on. In addition, if
2862  * the disk achieves a low enough throughput with the request pattern
2863  * issued by the application (e.g., because the request pattern is random
2864  * and/or the device is slow), then the application may meet the above
2865  * bandwidth requirement too. To prevent such a greedy application to be
2866  * deemed as soft real-time, a further rule is used in the computation of
2867  * soft_rt_next_start: soft_rt_next_start must be higher than the current
2868  * time plus the maximum time for which the arrival of a request is waited
2869  * for when a sync queue becomes idle, namely bfqd->bfq_slice_idle.
2870  * This filters out greedy applications, as the latter issue instead their
2871  * next request as soon as possible after the last one has been completed
2872  * (in contrast, when a batch of requests is completed, a soft real-time
2873  * application spends some time processing data).
2874  *
2875  * Unfortunately, the last filter may easily generate false positives if
2876  * only bfqd->bfq_slice_idle is used as a reference time interval and one
2877  * or both the following cases occur:
2878  * 1) HZ is so low that the duration of a jiffy is comparable to or higher
2879  *    than bfqd->bfq_slice_idle. This happens, e.g., on slow devices with
2880  *    HZ=100.
2881  * 2) jiffies, instead of increasing at a constant rate, may stop increasing
2882  *    for a while, then suddenly 'jump' by several units to recover the lost
2883  *    increments. This seems to happen, e.g., inside virtual machines.
2884  * To address this issue, we do not use as a reference time interval just
2885  * bfqd->bfq_slice_idle, but bfqd->bfq_slice_idle plus a few jiffies. In
2886  * particular we add the minimum number of jiffies for which the filter
2887  * seems to be quite precise also in embedded systems and KVM/QEMU virtual
2888  * machines.
2889  */
2890 static unsigned long bfq_bfqq_softrt_next_start(struct bfq_data *bfqd,
2891                                                 struct bfq_queue *bfqq)
2892 {
2893         return max(bfqq->last_idle_bklogged +
2894                    HZ * bfqq->service_from_backlogged /
2895                    bfqd->bfq_wr_max_softrt_rate,
2896                    jiffies + nsecs_to_jiffies(bfqq->bfqd->bfq_slice_idle) + 4);
2897 }
2898
2899 /*
2900  * Return the farthest future time instant according to jiffies
2901  * macros.
2902  */
2903 static unsigned long bfq_greatest_from_now(void)
2904 {
2905         return jiffies + MAX_JIFFY_OFFSET;
2906 }
2907
2908 /*
2909  * Return the farthest past time instant according to jiffies
2910  * macros.
2911  */
2912 static unsigned long bfq_smallest_from_now(void)
2913 {
2914         return jiffies - MAX_JIFFY_OFFSET;
2915 }
2916
2917 /**
2918  * bfq_bfqq_expire - expire a queue.
2919  * @bfqd: device owning the queue.
2920  * @bfqq: the queue to expire.
2921  * @compensate: if true, compensate for the time spent idling.
2922  * @reason: the reason causing the expiration.
2923  *
2924  * If the process associated with bfqq does slow I/O (e.g., because it
2925  * issues random requests), we charge bfqq with the time it has been
2926  * in service instead of the service it has received (see
2927  * bfq_bfqq_charge_time for details on how this goal is achieved). As
2928  * a consequence, bfqq will typically get higher timestamps upon
2929  * reactivation, and hence it will be rescheduled as if it had
2930  * received more service than what it has actually received. In the
2931  * end, bfqq receives less service in proportion to how slowly its
2932  * associated process consumes its budgets (and hence how seriously it
2933  * tends to lower the throughput). In addition, this time-charging
2934  * strategy guarantees time fairness among slow processes. In
2935  * contrast, if the process associated with bfqq is not slow, we
2936  * charge bfqq exactly with the service it has received.
2937  *
2938  * Charging time to the first type of queues and the exact service to
2939  * the other has the effect of using the WF2Q+ policy to schedule the
2940  * former on a timeslice basis, without violating service domain
2941  * guarantees among the latter.
2942  */
2943 void bfq_bfqq_expire(struct bfq_data *bfqd,
2944                      struct bfq_queue *bfqq,
2945                      bool compensate,
2946                      enum bfqq_expiration reason)
2947 {
2948         bool slow;
2949         unsigned long delta = 0;
2950         struct bfq_entity *entity = &bfqq->entity;
2951         int ref;
2952
2953         /*
2954          * Check whether the process is slow (see bfq_bfqq_is_slow).
2955          */
2956         slow = bfq_bfqq_is_slow(bfqd, bfqq, compensate, reason, &delta);
2957
2958         /*
2959          * Increase service_from_backlogged before next statement,
2960          * because the possible next invocation of
2961          * bfq_bfqq_charge_time would likely inflate
2962          * entity->service. In contrast, service_from_backlogged must
2963          * contain real service, to enable the soft real-time
2964          * heuristic to correctly compute the bandwidth consumed by
2965          * bfqq.
2966          */
2967         bfqq->service_from_backlogged += entity->service;
2968
2969         /*
2970          * As above explained, charge slow (typically seeky) and
2971          * timed-out queues with the time and not the service
2972          * received, to favor sequential workloads.
2973          *
2974          * Processes doing I/O in the slower disk zones will tend to
2975          * be slow(er) even if not seeky. Therefore, since the
2976          * estimated peak rate is actually an average over the disk
2977          * surface, these processes may timeout just for bad luck. To
2978          * avoid punishing them, do not charge time to processes that
2979          * succeeded in consuming at least 2/3 of their budget. This
2980          * allows BFQ to preserve enough elasticity to still perform
2981          * bandwidth, and not time, distribution with little unlucky
2982          * or quasi-sequential processes.
2983          */
2984         if (bfqq->wr_coeff == 1 &&
2985             (slow ||
2986              (reason == BFQQE_BUDGET_TIMEOUT &&
2987               bfq_bfqq_budget_left(bfqq) >=  entity->budget / 3)))
2988                 bfq_bfqq_charge_time(bfqd, bfqq, delta);
2989
2990         if (reason == BFQQE_TOO_IDLE &&
2991             entity->service <= 2 * entity->budget / 10)
2992                 bfq_clear_bfqq_IO_bound(bfqq);
2993
2994         if (bfqd->low_latency && bfqq->wr_coeff == 1)
2995                 bfqq->last_wr_start_finish = jiffies;
2996
2997         if (bfqd->low_latency && bfqd->bfq_wr_max_softrt_rate > 0 &&
2998             RB_EMPTY_ROOT(&bfqq->sort_list)) {
2999                 /*
3000                  * If we get here, and there are no outstanding
3001                  * requests, then the request pattern is isochronous
3002                  * (see the comments on the function
3003                  * bfq_bfqq_softrt_next_start()). Thus we can compute
3004                  * soft_rt_next_start. If, instead, the queue still
3005                  * has outstanding requests, then we have to wait for
3006                  * the completion of all the outstanding requests to
3007                  * discover whether the request pattern is actually
3008                  * isochronous.
3009                  */
3010                 if (bfqq->dispatched == 0)
3011                         bfqq->soft_rt_next_start =
3012                                 bfq_bfqq_softrt_next_start(bfqd, bfqq);
3013                 else {
3014                         /*
3015                          * The application is still waiting for the
3016                          * completion of one or more requests:
3017                          * prevent it from possibly being incorrectly
3018                          * deemed as soft real-time by setting its
3019                          * soft_rt_next_start to infinity. In fact,
3020                          * without this assignment, the application
3021                          * would be incorrectly deemed as soft
3022                          * real-time if:
3023                          * 1) it issued a new request before the
3024                          *    completion of all its in-flight
3025                          *    requests, and
3026                          * 2) at that time, its soft_rt_next_start
3027                          *    happened to be in the past.
3028                          */
3029                         bfqq->soft_rt_next_start =
3030                                 bfq_greatest_from_now();
3031                         /*
3032                          * Schedule an update of soft_rt_next_start to when
3033                          * the task may be discovered to be isochronous.
3034                          */
3035                         bfq_mark_bfqq_softrt_update(bfqq);
3036                 }
3037         }
3038
3039         bfq_log_bfqq(bfqd, bfqq,
3040                 "expire (%d, slow %d, num_disp %d, short_ttime %d)", reason,
3041                 slow, bfqq->dispatched, bfq_bfqq_has_short_ttime(bfqq));
3042
3043         /*
3044          * Increase, decrease or leave budget unchanged according to
3045          * reason.
3046          */
3047         __bfq_bfqq_recalc_budget(bfqd, bfqq, reason);
3048         ref = bfqq->ref;
3049         __bfq_bfqq_expire(bfqd, bfqq);
3050
3051         /* mark bfqq as waiting a request only if a bic still points to it */
3052         if (ref > 1 && !bfq_bfqq_busy(bfqq) &&
3053             reason != BFQQE_BUDGET_TIMEOUT &&
3054             reason != BFQQE_BUDGET_EXHAUSTED)
3055                 bfq_mark_bfqq_non_blocking_wait_rq(bfqq);
3056 }
3057
3058 /*
3059  * Budget timeout is not implemented through a dedicated timer, but
3060  * just checked on request arrivals and completions, as well as on
3061  * idle timer expirations.
3062  */
3063 static bool bfq_bfqq_budget_timeout(struct bfq_queue *bfqq)
3064 {
3065         return time_is_before_eq_jiffies(bfqq->budget_timeout);
3066 }
3067
3068 /*
3069  * If we expire a queue that is actively waiting (i.e., with the
3070  * device idled) for the arrival of a new request, then we may incur
3071  * the timestamp misalignment problem described in the body of the
3072  * function __bfq_activate_entity. Hence we return true only if this
3073  * condition does not hold, or if the queue is slow enough to deserve
3074  * only to be kicked off for preserving a high throughput.
3075  */
3076 static bool bfq_may_expire_for_budg_timeout(struct bfq_queue *bfqq)
3077 {
3078         bfq_log_bfqq(bfqq->bfqd, bfqq,
3079                 "may_budget_timeout: wait_request %d left %d timeout %d",
3080                 bfq_bfqq_wait_request(bfqq),
3081                         bfq_bfqq_budget_left(bfqq) >=  bfqq->entity.budget / 3,
3082                 bfq_bfqq_budget_timeout(bfqq));
3083
3084         return (!bfq_bfqq_wait_request(bfqq) ||
3085                 bfq_bfqq_budget_left(bfqq) >=  bfqq->entity.budget / 3)
3086                 &&
3087                 bfq_bfqq_budget_timeout(bfqq);
3088 }
3089
3090 /*
3091  * For a queue that becomes empty, device idling is allowed only if
3092  * this function returns true for the queue. As a consequence, since
3093  * device idling plays a critical role in both throughput boosting and
3094  * service guarantees, the return value of this function plays a
3095  * critical role in both these aspects as well.
3096  *
3097  * In a nutshell, this function returns true only if idling is
3098  * beneficial for throughput or, even if detrimental for throughput,
3099  * idling is however necessary to preserve service guarantees (low
3100  * latency, desired throughput distribution, ...). In particular, on
3101  * NCQ-capable devices, this function tries to return false, so as to
3102  * help keep the drives' internal queues full, whenever this helps the
3103  * device boost the throughput without causing any service-guarantee
3104  * issue.
3105  *
3106  * In more detail, the return value of this function is obtained by,
3107  * first, computing a number of boolean variables that take into
3108  * account throughput and service-guarantee issues, and, then,
3109  * combining these variables in a logical expression. Most of the
3110  * issues taken into account are not trivial. We discuss these issues
3111  * individually while introducing the variables.
3112  */
3113 static bool bfq_bfqq_may_idle(struct bfq_queue *bfqq)
3114 {
3115         struct bfq_data *bfqd = bfqq->bfqd;
3116         bool rot_without_queueing =
3117                 !blk_queue_nonrot(bfqd->queue) && !bfqd->hw_tag,
3118                 bfqq_sequential_and_IO_bound,
3119                 idling_boosts_thr, idling_boosts_thr_without_issues,
3120                 idling_needed_for_service_guarantees,
3121                 asymmetric_scenario;
3122
3123         if (bfqd->strict_guarantees)
3124                 return true;
3125
3126         /*
3127          * Idling is performed only if slice_idle > 0. In addition, we
3128          * do not idle if
3129          * (a) bfqq is async
3130          * (b) bfqq is in the idle io prio class: in this case we do
3131          * not idle because we want to minimize the bandwidth that
3132          * queues in this class can steal to higher-priority queues
3133          */
3134         if (bfqd->bfq_slice_idle == 0 || !bfq_bfqq_sync(bfqq) ||
3135             bfq_class_idle(bfqq))
3136                 return false;
3137
3138         bfqq_sequential_and_IO_bound = !BFQQ_SEEKY(bfqq) &&
3139                 bfq_bfqq_IO_bound(bfqq) && bfq_bfqq_has_short_ttime(bfqq);
3140
3141         /*
3142          * The next variable takes into account the cases where idling
3143          * boosts the throughput.
3144          *
3145          * The value of the variable is computed considering, first, that
3146          * idling is virtually always beneficial for the throughput if:
3147          * (a) the device is not NCQ-capable and rotational, or
3148          * (b) regardless of the presence of NCQ, the device is rotational and
3149          *     the request pattern for bfqq is I/O-bound and sequential, or
3150          * (c) regardless of whether it is rotational, the device is
3151          *     not NCQ-capable and the request pattern for bfqq is
3152          *     I/O-bound and sequential.
3153          *
3154          * Secondly, and in contrast to the above item (b), idling an
3155          * NCQ-capable flash-based device would not boost the
3156          * throughput even with sequential I/O; rather it would lower
3157          * the throughput in proportion to how fast the device
3158          * is. Accordingly, the next variable is true if any of the
3159          * above conditions (a), (b) or (c) is true, and, in
3160          * particular, happens to be false if bfqd is an NCQ-capable
3161          * flash-based device.
3162          */
3163         idling_boosts_thr = rot_without_queueing ||
3164                 ((!blk_queue_nonrot(bfqd->queue) || !bfqd->hw_tag) &&
3165                  bfqq_sequential_and_IO_bound);
3166
3167         /*
3168          * The value of the next variable,
3169          * idling_boosts_thr_without_issues, is equal to that of
3170          * idling_boosts_thr, unless a special case holds. In this
3171          * special case, described below, idling may cause problems to
3172          * weight-raised queues.
3173          *
3174          * When the request pool is saturated (e.g., in the presence
3175          * of write hogs), if the processes associated with
3176          * non-weight-raised queues ask for requests at a lower rate,
3177          * then processes associated with weight-raised queues have a
3178          * higher probability to get a request from the pool
3179          * immediately (or at least soon) when they need one. Thus
3180          * they have a higher probability to actually get a fraction
3181          * of the device throughput proportional to their high
3182          * weight. This is especially true with NCQ-capable drives,
3183          * which enqueue several requests in advance, and further
3184          * reorder internally-queued requests.
3185          *
3186          * For this reason, we force to false the value of
3187          * idling_boosts_thr_without_issues if there are weight-raised
3188          * busy queues. In this case, and if bfqq is not weight-raised,
3189          * this guarantees that the device is not idled for bfqq (if,
3190          * instead, bfqq is weight-raised, then idling will be
3191          * guaranteed by another variable, see below). Combined with
3192          * the timestamping rules of BFQ (see [1] for details), this
3193          * behavior causes bfqq, and hence any sync non-weight-raised
3194          * queue, to get a lower number of requests served, and thus
3195          * to ask for a lower number of requests from the request
3196          * pool, before the busy weight-raised queues get served
3197          * again. This often mitigates starvation problems in the
3198          * presence of heavy write workloads and NCQ, thereby
3199          * guaranteeing a higher application and system responsiveness
3200          * in these hostile scenarios.
3201          */
3202         idling_boosts_thr_without_issues = idling_boosts_thr &&
3203                 bfqd->wr_busy_queues == 0;
3204
3205         /*
3206          * There is then a case where idling must be performed not
3207          * for throughput concerns, but to preserve service
3208          * guarantees.
3209          *
3210          * To introduce this case, we can note that allowing the drive
3211          * to enqueue more than one request at a time, and hence
3212          * delegating de facto final scheduling decisions to the
3213          * drive's internal scheduler, entails loss of control on the
3214          * actual request service order. In particular, the critical
3215          * situation is when requests from different processes happen
3216          * to be present, at the same time, in the internal queue(s)
3217          * of the drive. In such a situation, the drive, by deciding
3218          * the service order of the internally-queued requests, does
3219          * determine also the actual throughput distribution among
3220          * these processes. But the drive typically has no notion or
3221          * concern about per-process throughput distribution, and
3222          * makes its decisions only on a per-request basis. Therefore,
3223          * the service distribution enforced by the drive's internal
3224          * scheduler is likely to coincide with the desired
3225          * device-throughput distribution only in a completely
3226          * symmetric scenario where:
3227          * (i)  each of these processes must get the same throughput as
3228          *      the others;
3229          * (ii) all these processes have the same I/O pattern
3230                 (either sequential or random).
3231          * In fact, in such a scenario, the drive will tend to treat
3232          * the requests of each of these processes in about the same
3233          * way as the requests of the others, and thus to provide
3234          * each of these processes with about the same throughput
3235          * (which is exactly the desired throughput distribution). In
3236          * contrast, in any asymmetric scenario, device idling is
3237          * certainly needed to guarantee that bfqq receives its
3238          * assigned fraction of the device throughput (see [1] for
3239          * details).
3240          *
3241          * We address this issue by controlling, actually, only the
3242          * symmetry sub-condition (i), i.e., provided that
3243          * sub-condition (i) holds, idling is not performed,
3244          * regardless of whether sub-condition (ii) holds. In other
3245          * words, only if sub-condition (i) holds, then idling is
3246          * allowed, and the device tends to be prevented from queueing
3247          * many requests, possibly of several processes. The reason
3248          * for not controlling also sub-condition (ii) is that we
3249          * exploit preemption to preserve guarantees in case of
3250          * symmetric scenarios, even if (ii) does not hold, as
3251          * explained in the next two paragraphs.
3252          *
3253          * Even if a queue, say Q, is expired when it remains idle, Q
3254          * can still preempt the new in-service queue if the next
3255          * request of Q arrives soon (see the comments on
3256          * bfq_bfqq_update_budg_for_activation). If all queues and
3257          * groups have the same weight, this form of preemption,
3258          * combined with the hole-recovery heuristic described in the
3259          * comments on function bfq_bfqq_update_budg_for_activation,
3260          * are enough to preserve a correct bandwidth distribution in
3261          * the mid term, even without idling. In fact, even if not
3262          * idling allows the internal queues of the device to contain
3263          * many requests, and thus to reorder requests, we can rather
3264          * safely assume that the internal scheduler still preserves a
3265          * minimum of mid-term fairness. The motivation for using
3266          * preemption instead of idling is that, by not idling,
3267          * service guarantees are preserved without minimally
3268          * sacrificing throughput. In other words, both a high
3269          * throughput and its desired distribution are obtained.
3270          *
3271          * More precisely, this preemption-based, idleless approach
3272          * provides fairness in terms of IOPS, and not sectors per
3273          * second. This can be seen with a simple example. Suppose
3274          * that there are two queues with the same weight, but that
3275          * the first queue receives requests of 8 sectors, while the
3276          * second queue receives requests of 1024 sectors. In
3277          * addition, suppose that each of the two queues contains at
3278          * most one request at a time, which implies that each queue
3279          * always remains idle after it is served. Finally, after
3280          * remaining idle, each queue receives very quickly a new
3281          * request. It follows that the two queues are served
3282          * alternatively, preempting each other if needed. This
3283          * implies that, although both queues have the same weight,
3284          * the queue with large requests receives a service that is
3285          * 1024/8 times as high as the service received by the other
3286          * queue.
3287          *
3288          * On the other hand, device idling is performed, and thus
3289          * pure sector-domain guarantees are provided, for the
3290          * following queues, which are likely to need stronger
3291          * throughput guarantees: weight-raised queues, and queues
3292          * with a higher weight than other queues. When such queues
3293          * are active, sub-condition (i) is false, which triggers
3294          * device idling.
3295          *
3296          * According to the above considerations, the next variable is
3297          * true (only) if sub-condition (i) holds. To compute the
3298          * value of this variable, we not only use the return value of
3299          * the function bfq_symmetric_scenario(), but also check
3300          * whether bfqq is being weight-raised, because
3301          * bfq_symmetric_scenario() does not take into account also
3302          * weight-raised queues (see comments on
3303          * bfq_weights_tree_add()).
3304          *
3305          * As a side note, it is worth considering that the above
3306          * device-idling countermeasures may however fail in the
3307          * following unlucky scenario: if idling is (correctly)
3308          * disabled in a time period during which all symmetry
3309          * sub-conditions hold, and hence the device is allowed to
3310          * enqueue many requests, but at some later point in time some
3311          * sub-condition stops to hold, then it may become impossible
3312          * to let requests be served in the desired order until all
3313          * the requests already queued in the device have been served.
3314          */
3315         asymmetric_scenario = bfqq->wr_coeff > 1 ||
3316                 !bfq_symmetric_scenario(bfqd);
3317
3318         /*
3319          * Finally, there is a case where maximizing throughput is the
3320          * best choice even if it may cause unfairness toward
3321          * bfqq. Such a case is when bfqq became active in a burst of
3322          * queue activations. Queues that became active during a large
3323          * burst benefit only from throughput, as discussed in the
3324          * comments on bfq_handle_burst. Thus, if bfqq became active
3325          * in a burst and not idling the device maximizes throughput,
3326          * then the device must no be idled, because not idling the
3327          * device provides bfqq and all other queues in the burst with
3328          * maximum benefit. Combining this and the above case, we can
3329          * now establish when idling is actually needed to preserve
3330          * service guarantees.
3331          */
3332         idling_needed_for_service_guarantees =
3333                 asymmetric_scenario && !bfq_bfqq_in_large_burst(bfqq);
3334
3335         /*
3336          * We have now all the components we need to compute the
3337          * return value of the function, which is true only if idling
3338          * either boosts the throughput (without issues), or is
3339          * necessary to preserve service guarantees.
3340          */
3341         return idling_boosts_thr_without_issues ||
3342                 idling_needed_for_service_guarantees;
3343 }
3344
3345 /*
3346  * If the in-service queue is empty but the function bfq_bfqq_may_idle
3347  * returns true, then:
3348  * 1) the queue must remain in service and cannot be expired, and
3349  * 2) the device must be idled to wait for the possible arrival of a new
3350  *    request for the queue.
3351  * See the comments on the function bfq_bfqq_may_idle for the reasons
3352  * why performing device idling is the best choice to boost the throughput
3353  * and preserve service guarantees when bfq_bfqq_may_idle itself
3354  * returns true.
3355  */
3356 static bool bfq_bfqq_must_idle(struct bfq_queue *bfqq)
3357 {
3358         return RB_EMPTY_ROOT(&bfqq->sort_list) && bfq_bfqq_may_idle(bfqq);
3359 }
3360
3361 /*
3362  * Select a queue for service.  If we have a current queue in service,
3363  * check whether to continue servicing it, or retrieve and set a new one.
3364  */
3365 static struct bfq_queue *bfq_select_queue(struct bfq_data *bfqd)
3366 {
3367         struct bfq_queue *bfqq;
3368         struct request *next_rq;
3369         enum bfqq_expiration reason = BFQQE_BUDGET_TIMEOUT;
3370
3371         bfqq = bfqd->in_service_queue;
3372         if (!bfqq)
3373                 goto new_queue;
3374
3375         bfq_log_bfqq(bfqd, bfqq, "select_queue: already in-service queue");
3376
3377         if (bfq_may_expire_for_budg_timeout(bfqq) &&
3378             !bfq_bfqq_wait_request(bfqq) &&
3379             !bfq_bfqq_must_idle(bfqq))
3380                 goto expire;
3381
3382 check_queue:
3383         /*
3384          * This loop is rarely executed more than once. Even when it
3385          * happens, it is much more convenient to re-execute this loop
3386          * than to return NULL and trigger a new dispatch to get a
3387          * request served.
3388          */
3389         next_rq = bfqq->next_rq;
3390         /*
3391          * If bfqq has requests queued and it has enough budget left to
3392          * serve them, keep the queue, otherwise expire it.
3393          */
3394         if (next_rq) {
3395                 if (bfq_serv_to_charge(next_rq, bfqq) >
3396                         bfq_bfqq_budget_left(bfqq)) {
3397                         /*
3398                          * Expire the queue for budget exhaustion,
3399                          * which makes sure that the next budget is
3400                          * enough to serve the next request, even if
3401                          * it comes from the fifo expired path.
3402                          */
3403                         reason = BFQQE_BUDGET_EXHAUSTED;
3404                         goto expire;
3405                 } else {
3406                         /*
3407                          * The idle timer may be pending because we may
3408                          * not disable disk idling even when a new request
3409                          * arrives.
3410                          */
3411                         if (bfq_bfqq_wait_request(bfqq)) {
3412                                 /*
3413                                  * If we get here: 1) at least a new request
3414                                  * has arrived but we have not disabled the
3415                                  * timer because the request was too small,
3416                                  * 2) then the block layer has unplugged
3417                                  * the device, causing the dispatch to be
3418                                  * invoked.
3419                                  *
3420                                  * Since the device is unplugged, now the
3421                                  * requests are probably large enough to
3422                                  * provide a reasonable throughput.
3423                                  * So we disable idling.
3424                                  */
3425                                 bfq_clear_bfqq_wait_request(bfqq);
3426                                 hrtimer_try_to_cancel(&bfqd->idle_slice_timer);
3427                                 bfqg_stats_update_idle_time(bfqq_group(bfqq));
3428                         }
3429                         goto keep_queue;
3430                 }
3431         }
3432
3433         /*
3434          * No requests pending. However, if the in-service queue is idling
3435          * for a new request, or has requests waiting for a completion and
3436          * may idle after their completion, then keep it anyway.
3437          */
3438         if (bfq_bfqq_wait_request(bfqq) ||
3439             (bfqq->dispatched != 0 && bfq_bfqq_may_idle(bfqq))) {
3440                 bfqq = NULL;
3441                 goto keep_queue;
3442         }
3443
3444         reason = BFQQE_NO_MORE_REQUESTS;
3445 expire:
3446         bfq_bfqq_expire(bfqd, bfqq, false, reason);
3447 new_queue:
3448         bfqq = bfq_set_in_service_queue(bfqd);
3449         if (bfqq) {
3450                 bfq_log_bfqq(bfqd, bfqq, "select_queue: checking new queue");
3451                 goto check_queue;
3452         }
3453 keep_queue:
3454         if (bfqq)
3455                 bfq_log_bfqq(bfqd, bfqq, "select_queue: returned this queue");
3456         else
3457                 bfq_log(bfqd, "select_queue: no queue returned");
3458
3459         return bfqq;
3460 }
3461
3462 static void bfq_update_wr_data(struct bfq_data *bfqd, struct bfq_queue *bfqq)
3463 {
3464         struct bfq_entity *entity = &bfqq->entity;
3465
3466         if (bfqq->wr_coeff > 1) { /* queue is being weight-raised */
3467                 bfq_log_bfqq(bfqd, bfqq,
3468                         "raising period dur %u/%u msec, old coeff %u, w %d(%d)",
3469                         jiffies_to_msecs(jiffies - bfqq->last_wr_start_finish),
3470                         jiffies_to_msecs(bfqq->wr_cur_max_time),
3471                         bfqq->wr_coeff,
3472                         bfqq->entity.weight, bfqq->entity.orig_weight);
3473
3474                 if (entity->prio_changed)
3475                         bfq_log_bfqq(bfqd, bfqq, "WARN: pending prio change");
3476
3477                 /*
3478                  * If the queue was activated in a burst, or too much
3479                  * time has elapsed from the beginning of this
3480                  * weight-raising period, then end weight raising.
3481                  */
3482                 if (bfq_bfqq_in_large_burst(bfqq))
3483                         bfq_bfqq_end_wr(bfqq);
3484                 else if (time_is_before_jiffies(bfqq->last_wr_start_finish +
3485                                                 bfqq->wr_cur_max_time)) {
3486                         if (bfqq->wr_cur_max_time != bfqd->bfq_wr_rt_max_time ||
3487                         time_is_before_jiffies(bfqq->wr_start_at_switch_to_srt +
3488                                                bfq_wr_duration(bfqd)))
3489                                 bfq_bfqq_end_wr(bfqq);
3490                         else {
3491                                 /* switch back to interactive wr */
3492                                 bfqq->wr_coeff = bfqd->bfq_wr_coeff;
3493                                 bfqq->wr_cur_max_time = bfq_wr_duration(bfqd);
3494                                 bfqq->last_wr_start_finish =
3495                                         bfqq->wr_start_at_switch_to_srt;
3496                                 bfqq->entity.prio_changed = 1;
3497                         }
3498                 }
3499         }
3500         /*
3501          * To improve latency (for this or other queues), immediately
3502          * update weight both if it must be raised and if it must be
3503          * lowered. Since, entity may be on some active tree here, and
3504          * might have a pending change of its ioprio class, invoke
3505          * next function with the last parameter unset (see the
3506          * comments on the function).
3507          */
3508         if ((entity->weight > entity->orig_weight) != (bfqq->wr_coeff > 1))
3509                 __bfq_entity_update_weight_prio(bfq_entity_service_tree(entity),
3510                                                 entity, false);
3511 }
3512
3513 /*
3514  * Dispatch next request from bfqq.
3515  */
3516 static struct request *bfq_dispatch_rq_from_bfqq(struct bfq_data *bfqd,
3517                                                  struct bfq_queue *bfqq)
3518 {
3519         struct request *rq = bfqq->next_rq;
3520         unsigned long service_to_charge;
3521
3522         service_to_charge = bfq_serv_to_charge(rq, bfqq);
3523
3524         bfq_bfqq_served(bfqq, service_to_charge);
3525
3526         bfq_dispatch_remove(bfqd->queue, rq);
3527
3528         /*
3529          * If weight raising has to terminate for bfqq, then next
3530          * function causes an immediate update of bfqq's weight,
3531          * without waiting for next activation. As a consequence, on
3532          * expiration, bfqq will be timestamped as if has never been
3533          * weight-raised during this service slot, even if it has
3534          * received part or even most of the service as a
3535          * weight-raised queue. This inflates bfqq's timestamps, which
3536          * is beneficial, as bfqq is then more willing to leave the
3537          * device immediately to possible other weight-raised queues.
3538          */
3539         bfq_update_wr_data(bfqd, bfqq);
3540
3541         /*
3542          * Expire bfqq, pretending that its budget expired, if bfqq
3543          * belongs to CLASS_IDLE and other queues are waiting for
3544          * service.
3545          */
3546         if (bfqd->busy_queues > 1 && bfq_class_idle(bfqq))
3547                 goto expire;
3548
3549         return rq;
3550
3551 expire:
3552         bfq_bfqq_expire(bfqd, bfqq, false, BFQQE_BUDGET_EXHAUSTED);
3553         return rq;
3554 }
3555
3556 static bool bfq_has_work(struct blk_mq_hw_ctx *hctx)
3557 {
3558         struct bfq_data *bfqd = hctx->queue->elevator->elevator_data;
3559
3560         /*
3561          * Avoiding lock: a race on bfqd->busy_queues should cause at
3562          * most a call to dispatch for nothing
3563          */
3564         return !list_empty_careful(&bfqd->dispatch) ||
3565                 bfqd->busy_queues > 0;
3566 }
3567
3568 static struct request *__bfq_dispatch_request(struct blk_mq_hw_ctx *hctx)
3569 {
3570         struct bfq_data *bfqd = hctx->queue->elevator->elevator_data;
3571         struct request *rq = NULL;
3572         struct bfq_queue *bfqq = NULL;
3573
3574         if (!list_empty(&bfqd->dispatch)) {
3575                 rq = list_first_entry(&bfqd->dispatch, struct request,
3576                                       queuelist);
3577                 list_del_init(&rq->queuelist);
3578
3579                 bfqq = RQ_BFQQ(rq);
3580
3581                 if (bfqq) {
3582                         /*
3583                          * Increment counters here, because this
3584                          * dispatch does not follow the standard
3585                          * dispatch flow (where counters are
3586                          * incremented)
3587                          */
3588                         bfqq->dispatched++;
3589
3590                         goto inc_in_driver_start_rq;
3591                 }
3592
3593                 /*
3594                  * We exploit the put_rq_private hook to decrement
3595                  * rq_in_driver, but put_rq_private will not be
3596                  * invoked on this request. So, to avoid unbalance,
3597                  * just start this request, without incrementing
3598                  * rq_in_driver. As a negative consequence,
3599                  * rq_in_driver is deceptively lower than it should be
3600                  * while this request is in service. This may cause
3601                  * bfq_schedule_dispatch to be invoked uselessly.
3602                  *
3603                  * As for implementing an exact solution, the
3604                  * put_request hook, if defined, is probably invoked
3605                  * also on this request. So, by exploiting this hook,
3606                  * we could 1) increment rq_in_driver here, and 2)
3607                  * decrement it in put_request. Such a solution would
3608                  * let the value of the counter be always accurate,
3609                  * but it would entail using an extra interface
3610                  * function. This cost seems higher than the benefit,
3611                  * being the frequency of non-elevator-private
3612                  * requests very low.
3613                  */
3614                 goto start_rq;
3615         }
3616
3617         bfq_log(bfqd, "dispatch requests: %d busy queues", bfqd->busy_queues);
3618
3619         if (bfqd->busy_queues == 0)
3620                 goto exit;
3621
3622         /*
3623          * Force device to serve one request at a time if
3624          * strict_guarantees is true. Forcing this service scheme is
3625          * currently the ONLY way to guarantee that the request
3626          * service order enforced by the scheduler is respected by a
3627          * queueing device. Otherwise the device is free even to make
3628          * some unlucky request wait for as long as the device
3629          * wishes.
3630          *
3631          * Of course, serving one request at at time may cause loss of
3632          * throughput.
3633          */
3634         if (bfqd->strict_guarantees && bfqd->rq_in_driver > 0)
3635                 goto exit;
3636
3637         bfqq = bfq_select_queue(bfqd);
3638         if (!bfqq)
3639                 goto exit;
3640
3641         rq = bfq_dispatch_rq_from_bfqq(bfqd, bfqq);
3642
3643         if (rq) {
3644 inc_in_driver_start_rq:
3645                 bfqd->rq_in_driver++;
3646 start_rq:
3647                 rq->rq_flags |= RQF_STARTED;
3648         }
3649 exit:
3650         return rq;
3651 }
3652
3653 static struct request *bfq_dispatch_request(struct blk_mq_hw_ctx *hctx)
3654 {
3655         struct bfq_data *bfqd = hctx->queue->elevator->elevator_data;
3656         struct request *rq;
3657
3658         spin_lock_irq(&bfqd->lock);
3659
3660         rq = __bfq_dispatch_request(hctx);
3661         spin_unlock_irq(&bfqd->lock);
3662
3663         return rq;
3664 }
3665
3666 /*
3667  * Task holds one reference to the queue, dropped when task exits.  Each rq
3668  * in-flight on this queue also holds a reference, dropped when rq is freed.
3669  *
3670  * Scheduler lock must be held here. Recall not to use bfqq after calling
3671  * this function on it.
3672  */
3673 void bfq_put_queue(struct bfq_queue *bfqq)
3674 {
3675 #ifdef CONFIG_BFQ_GROUP_IOSCHED
3676         struct bfq_group *bfqg = bfqq_group(bfqq);
3677 #endif
3678
3679         if (bfqq->bfqd)
3680                 bfq_log_bfqq(bfqq->bfqd, bfqq, "put_queue: %p %d",
3681                              bfqq, bfqq->ref);
3682
3683         bfqq->ref--;
3684         if (bfqq->ref)
3685                 return;
3686
3687         if (bfq_bfqq_sync(bfqq))
3688                 /*
3689                  * The fact that this queue is being destroyed does not
3690                  * invalidate the fact that this queue may have been
3691                  * activated during the current burst. As a consequence,
3692                  * although the queue does not exist anymore, and hence
3693                  * needs to be removed from the burst list if there,
3694                  * the burst size has not to be decremented.
3695                  */
3696                 hlist_del_init(&bfqq->burst_list_node);
3697
3698         kmem_cache_free(bfq_pool, bfqq);
3699 #ifdef CONFIG_BFQ_GROUP_IOSCHED
3700         bfqg_and_blkg_put(bfqg);
3701 #endif
3702 }
3703
3704 static void bfq_put_cooperator(struct bfq_queue *bfqq)
3705 {
3706         struct bfq_queue *__bfqq, *next;
3707
3708         /*
3709          * If this queue was scheduled to merge with another queue, be
3710          * sure to drop the reference taken on that queue (and others in
3711          * the merge chain). See bfq_setup_merge and bfq_merge_bfqqs.
3712          */
3713         __bfqq = bfqq->new_bfqq;
3714         while (__bfqq) {
3715                 if (__bfqq == bfqq)
3716                         break;
3717                 next = __bfqq->new_bfqq;
3718                 bfq_put_queue(__bfqq);
3719                 __bfqq = next;
3720         }
3721 }
3722
3723 static void bfq_exit_bfqq(struct bfq_data *bfqd, struct bfq_queue *bfqq)
3724 {
3725         if (bfqq == bfqd->in_service_queue) {
3726                 __bfq_bfqq_expire(bfqd, bfqq);
3727                 bfq_schedule_dispatch(bfqd);
3728         }
3729
3730         bfq_log_bfqq(bfqd, bfqq, "exit_bfqq: %p, %d", bfqq, bfqq->ref);
3731
3732         bfq_put_cooperator(bfqq);
3733
3734         bfq_put_queue(bfqq); /* release process reference */
3735 }
3736
3737 static void bfq_exit_icq_bfqq(struct bfq_io_cq *bic, bool is_sync)
3738 {
3739         struct bfq_queue *bfqq = bic_to_bfqq(bic, is_sync);
3740         struct bfq_data *bfqd;
3741
3742         if (bfqq)
3743                 bfqd = bfqq->bfqd; /* NULL if scheduler already exited */
3744
3745         if (bfqq && bfqd) {
3746                 unsigned long flags;
3747
3748                 spin_lock_irqsave(&bfqd->lock, flags);
3749                 bfq_exit_bfqq(bfqd, bfqq);
3750                 bic_set_bfqq(bic, NULL, is_sync);
3751                 spin_unlock_irqrestore(&bfqd->lock, flags);
3752         }
3753 }
3754
3755 static void bfq_exit_icq(struct io_cq *icq)
3756 {
3757         struct bfq_io_cq *bic = icq_to_bic(icq);
3758
3759         bfq_exit_icq_bfqq(bic, true);
3760         bfq_exit_icq_bfqq(bic, false);
3761 }
3762
3763 /*
3764  * Update the entity prio values; note that the new values will not
3765  * be used until the next (re)activation.
3766  */
3767 static void
3768 bfq_set_next_ioprio_data(struct bfq_queue *bfqq, struct bfq_io_cq *bic)
3769 {
3770         struct task_struct *tsk = current;
3771         int ioprio_class;
3772         struct bfq_data *bfqd = bfqq->bfqd;
3773
3774         if (!bfqd)
3775                 return;
3776
3777         ioprio_class = IOPRIO_PRIO_CLASS(bic->ioprio);
3778         switch (ioprio_class) {
3779         default:
3780                 dev_err(bfqq->bfqd->queue->backing_dev_info->dev,
3781                         "bfq: bad prio class %d\n", ioprio_class);
3782                 /* fall through */
3783         case IOPRIO_CLASS_NONE:
3784                 /*
3785                  * No prio set, inherit CPU scheduling settings.
3786                  */
3787                 bfqq->new_ioprio = task_nice_ioprio(tsk);
3788                 bfqq->new_ioprio_class = task_nice_ioclass(tsk);
3789                 break;
3790         case IOPRIO_CLASS_RT:
3791                 bfqq->new_ioprio = IOPRIO_PRIO_DATA(bic->ioprio);
3792                 bfqq->new_ioprio_class = IOPRIO_CLASS_RT;
3793                 break;
3794         case IOPRIO_CLASS_BE:
3795                 bfqq->new_ioprio = IOPRIO_PRIO_DATA(bic->ioprio);
3796                 bfqq->new_ioprio_class = IOPRIO_CLASS_BE;
3797                 break;
3798         case IOPRIO_CLASS_IDLE:
3799                 bfqq->new_ioprio_class = IOPRIO_CLASS_IDLE;
3800                 bfqq->new_ioprio = 7;
3801                 break;
3802         }
3803
3804         if (bfqq->new_ioprio >= IOPRIO_BE_NR) {
3805                 pr_crit("bfq_set_next_ioprio_data: new_ioprio %d\n",
3806                         bfqq->new_ioprio);
3807                 bfqq->new_ioprio = IOPRIO_BE_NR;
3808         }
3809
3810         bfqq->entity.new_weight = bfq_ioprio_to_weight(bfqq->new_ioprio);
3811         bfqq->entity.prio_changed = 1;
3812 }
3813
3814 static struct bfq_queue *bfq_get_queue(struct bfq_data *bfqd,
3815                                        struct bio *bio, bool is_sync,
3816                                        struct bfq_io_cq *bic);
3817
3818 static void bfq_check_ioprio_change(struct bfq_io_cq *bic, struct bio *bio)
3819 {
3820         struct bfq_data *bfqd = bic_to_bfqd(bic);
3821         struct bfq_queue *bfqq;
3822         int ioprio = bic->icq.ioc->ioprio;
3823
3824         /*
3825          * This condition may trigger on a newly created bic, be sure to
3826          * drop the lock before returning.
3827          */
3828         if (unlikely(!bfqd) || likely(bic->ioprio == ioprio))
3829                 return;
3830
3831         bic->ioprio = ioprio;
3832
3833         bfqq = bic_to_bfqq(bic, false);
3834         if (bfqq) {
3835                 /* release process reference on this queue */
3836                 bfq_put_queue(bfqq);
3837                 bfqq = bfq_get_queue(bfqd, bio, BLK_RW_ASYNC, bic);
3838                 bic_set_bfqq(bic, bfqq, false);
3839         }
3840
3841         bfqq = bic_to_bfqq(bic, true);
3842         if (bfqq)
3843                 bfq_set_next_ioprio_data(bfqq, bic);
3844 }
3845
3846 static void bfq_init_bfqq(struct bfq_data *bfqd, struct bfq_queue *bfqq,
3847                           struct bfq_io_cq *bic, pid_t pid, int is_sync)
3848 {
3849         RB_CLEAR_NODE(&bfqq->entity.rb_node);
3850         INIT_LIST_HEAD(&bfqq->fifo);
3851         INIT_HLIST_NODE(&bfqq->burst_list_node);
3852
3853         bfqq->ref = 0;
3854         bfqq->bfqd = bfqd;
3855
3856         if (bic)
3857                 bfq_set_next_ioprio_data(bfqq, bic);
3858
3859         if (is_sync) {
3860                 /*
3861                  * No need to mark as has_short_ttime if in
3862                  * idle_class, because no device idling is performed
3863                  * for queues in idle class
3864                  */
3865                 if (!bfq_class_idle(bfqq))
3866                         /* tentatively mark as has_short_ttime */
3867                         bfq_mark_bfqq_has_short_ttime(bfqq);
3868                 bfq_mark_bfqq_sync(bfqq);
3869                 bfq_mark_bfqq_just_created(bfqq);
3870         } else
3871                 bfq_clear_bfqq_sync(bfqq);
3872
3873         /* set end request to minus infinity from now */
3874         bfqq->ttime.last_end_request = ktime_get_ns() + 1;
3875
3876         bfq_mark_bfqq_IO_bound(bfqq);
3877
3878         bfqq->pid = pid;
3879
3880         /* Tentative initial value to trade off between thr and lat */
3881         bfqq->max_budget = (2 * bfq_max_budget(bfqd)) / 3;
3882         bfqq->budget_timeout = bfq_smallest_from_now();
3883
3884         bfqq->wr_coeff = 1;
3885         bfqq->last_wr_start_finish = jiffies;
3886         bfqq->wr_start_at_switch_to_srt = bfq_smallest_from_now();
3887         bfqq->split_time = bfq_smallest_from_now();
3888
3889         /*
3890          * Set to the value for which bfqq will not be deemed as
3891          * soft rt when it becomes backlogged.
3892          */
3893         bfqq->soft_rt_next_start = bfq_greatest_from_now();
3894
3895         /* first request is almost certainly seeky */
3896         bfqq->seek_history = 1;
3897 }
3898
3899 static struct bfq_queue **bfq_async_queue_prio(struct bfq_data *bfqd,
3900                                                struct bfq_group *bfqg,
3901                                                int ioprio_class, int ioprio)
3902 {
3903         switch (ioprio_class) {
3904         case IOPRIO_CLASS_RT:
3905                 return &bfqg->async_bfqq[0][ioprio];
3906         case IOPRIO_CLASS_NONE:
3907                 ioprio = IOPRIO_NORM;
3908                 /* fall through */
3909         case IOPRIO_CLASS_BE:
3910                 return &bfqg->async_bfqq[1][ioprio];
3911         case IOPRIO_CLASS_IDLE:
3912                 return &bfqg->async_idle_bfqq;
3913         default:
3914                 return NULL;
3915         }
3916 }
3917
3918 static struct bfq_queue *bfq_get_queue(struct bfq_data *bfqd,
3919                                        struct bio *bio, bool is_sync,
3920                                        struct bfq_io_cq *bic)
3921 {
3922         const int ioprio = IOPRIO_PRIO_DATA(bic->ioprio);
3923         const int ioprio_class = IOPRIO_PRIO_CLASS(bic->ioprio);
3924         struct bfq_queue **async_bfqq = NULL;
3925         struct bfq_queue *bfqq;
3926         struct bfq_group *bfqg;
3927
3928         rcu_read_lock();
3929
3930         bfqg = bfq_find_set_group(bfqd, bio_blkcg(bio));
3931         if (!bfqg) {
3932                 bfqq = &bfqd->oom_bfqq;
3933                 goto out;
3934         }
3935
3936         if (!is_sync) {
3937                 async_bfqq = bfq_async_queue_prio(bfqd, bfqg, ioprio_class,
3938                                                   ioprio);
3939                 bfqq = *async_bfqq;
3940                 if (bfqq)
3941                         goto out;
3942         }
3943
3944         bfqq = kmem_cache_alloc_node(bfq_pool,
3945                                      GFP_NOWAIT | __GFP_ZERO | __GFP_NOWARN,
3946                                      bfqd->queue->node);
3947
3948         if (bfqq) {
3949                 bfq_init_bfqq(bfqd, bfqq, bic, current->pid,
3950                               is_sync);
3951                 bfq_init_entity(&bfqq->entity, bfqg);
3952                 bfq_log_bfqq(bfqd, bfqq, "allocated");
3953         } else {
3954                 bfqq = &bfqd->oom_bfqq;
3955                 bfq_log_bfqq(bfqd, bfqq, "using oom bfqq");
3956                 goto out;
3957         }
3958
3959         /*
3960          * Pin the queue now that it's allocated, scheduler exit will
3961          * prune it.
3962          */
3963         if (async_bfqq) {
3964                 bfqq->ref++; /*
3965                               * Extra group reference, w.r.t. sync
3966                               * queue. This extra reference is removed
3967                               * only if bfqq->bfqg disappears, to
3968                               * guarantee that this queue is not freed
3969                               * until its group goes away.
3970                               */
3971                 bfq_log_bfqq(bfqd, bfqq, "get_queue, bfqq not in async: %p, %d",
3972                              bfqq, bfqq->ref);
3973                 *async_bfqq = bfqq;
3974         }
3975
3976 out:
3977         bfqq->ref++; /* get a process reference to this queue */
3978         bfq_log_bfqq(bfqd, bfqq, "get_queue, at end: %p, %d", bfqq, bfqq->ref);
3979         rcu_read_unlock();
3980         return bfqq;
3981 }
3982
3983 static void bfq_update_io_thinktime(struct bfq_data *bfqd,
3984                                     struct bfq_queue *bfqq)
3985 {
3986         struct bfq_ttime *ttime = &bfqq->ttime;
3987         u64 elapsed = ktime_get_ns() - bfqq->ttime.last_end_request;
3988
3989         elapsed = min_t(u64, elapsed, 2ULL * bfqd->bfq_slice_idle);
3990
3991         ttime->ttime_samples = (7*bfqq->ttime.ttime_samples + 256) / 8;
3992         ttime->ttime_total = div_u64(7*ttime->ttime_total + 256*elapsed,  8);
3993         ttime->ttime_mean = div64_ul(ttime->ttime_total + 128,
3994                                      ttime->ttime_samples);
3995 }
3996
3997 static void
3998 bfq_update_io_seektime(struct bfq_data *bfqd, struct bfq_queue *bfqq,
3999                        struct request *rq)
4000 {
4001         bfqq->seek_history <<= 1;
4002         bfqq->seek_history |=
4003                 get_sdist(bfqq->last_request_pos, rq) > BFQQ_SEEK_THR &&
4004                 (!blk_queue_nonrot(bfqd->queue) ||
4005                  blk_rq_sectors(rq) < BFQQ_SECT_THR_NONROT);
4006 }
4007
4008 static void bfq_update_has_short_ttime(struct bfq_data *bfqd,
4009                                        struct bfq_queue *bfqq,
4010                                        struct bfq_io_cq *bic)
4011 {
4012         bool has_short_ttime = true;
4013
4014         /*
4015          * No need to update has_short_ttime if bfqq is async or in
4016          * idle io prio class, or if bfq_slice_idle is zero, because
4017          * no device idling is performed for bfqq in this case.
4018          */
4019         if (!bfq_bfqq_sync(bfqq) || bfq_class_idle(bfqq) ||
4020             bfqd->bfq_slice_idle == 0)
4021                 return;
4022
4023         /* Idle window just restored, statistics are meaningless. */
4024         if (time_is_after_eq_jiffies(bfqq->split_time +
4025                                      bfqd->bfq_wr_min_idle_time))
4026                 return;
4027
4028         /* Think time is infinite if no process is linked to
4029          * bfqq. Otherwise check average think time to
4030          * decide whether to mark as has_short_ttime
4031          */
4032         if (atomic_read(&bic->icq.ioc->active_ref) == 0 ||
4033             (bfq_sample_valid(bfqq->ttime.ttime_samples) &&
4034              bfqq->ttime.ttime_mean > bfqd->bfq_slice_idle))
4035                 has_short_ttime = false;
4036
4037         bfq_log_bfqq(bfqd, bfqq, "update_has_short_ttime: has_short_ttime %d",
4038                      has_short_ttime);
4039
4040         if (has_short_ttime)
4041                 bfq_mark_bfqq_has_short_ttime(bfqq);
4042         else
4043                 bfq_clear_bfqq_has_short_ttime(bfqq);
4044 }
4045
4046 /*
4047  * Called when a new fs request (rq) is added to bfqq.  Check if there's
4048  * something we should do about it.
4049  */
4050 static void bfq_rq_enqueued(struct bfq_data *bfqd, struct bfq_queue *bfqq,
4051                             struct request *rq)
4052 {
4053         struct bfq_io_cq *bic = RQ_BIC(rq);
4054
4055         if (rq->cmd_flags & REQ_META)
4056                 bfqq->meta_pending++;
4057
4058         bfq_update_io_thinktime(bfqd, bfqq);
4059         bfq_update_has_short_ttime(bfqd, bfqq, bic);
4060         bfq_update_io_seektime(bfqd, bfqq, rq);
4061
4062         bfq_log_bfqq(bfqd, bfqq,
4063                      "rq_enqueued: has_short_ttime=%d (seeky %d)",
4064                      bfq_bfqq_has_short_ttime(bfqq), BFQQ_SEEKY(bfqq));
4065
4066         bfqq->last_request_pos = blk_rq_pos(rq) + blk_rq_sectors(rq);
4067
4068         if (bfqq == bfqd->in_service_queue && bfq_bfqq_wait_request(bfqq)) {
4069                 bool small_req = bfqq->queued[rq_is_sync(rq)] == 1 &&
4070                                  blk_rq_sectors(rq) < 32;
4071                 bool budget_timeout = bfq_bfqq_budget_timeout(bfqq);
4072
4073                 /*
4074                  * There is just this request queued: if the request
4075                  * is small and the queue is not to be expired, then
4076                  * just exit.
4077                  *
4078                  * In this way, if the device is being idled to wait
4079                  * for a new request from the in-service queue, we
4080                  * avoid unplugging the device and committing the
4081                  * device to serve just a small request. On the
4082                  * contrary, we wait for the block layer to decide
4083                  * when to unplug the device: hopefully, new requests
4084                  * will be merged to this one quickly, then the device
4085                  * will be unplugged and larger requests will be
4086                  * dispatched.
4087                  */
4088                 if (small_req && !budget_timeout)
4089                         return;
4090
4091                 /*
4092                  * A large enough request arrived, or the queue is to
4093                  * be expired: in both cases disk idling is to be
4094                  * stopped, so clear wait_request flag and reset
4095                  * timer.
4096                  */
4097                 bfq_clear_bfqq_wait_request(bfqq);
4098                 hrtimer_try_to_cancel(&bfqd->idle_slice_timer);
4099                 bfqg_stats_update_idle_time(bfqq_group(bfqq));
4100
4101                 /*
4102                  * The queue is not empty, because a new request just
4103                  * arrived. Hence we can safely expire the queue, in
4104                  * case of budget timeout, without risking that the
4105                  * timestamps of the queue are not updated correctly.
4106                  * See [1] for more details.
4107                  */
4108                 if (budget_timeout)
4109                         bfq_bfqq_expire(bfqd, bfqq, false,
4110                                         BFQQE_BUDGET_TIMEOUT);
4111         }
4112 }
4113
4114 static void __bfq_insert_request(struct bfq_data *bfqd, struct request *rq)
4115 {
4116         struct bfq_queue *bfqq = RQ_BFQQ(rq),
4117                 *new_bfqq = bfq_setup_cooperator(bfqd, bfqq, rq, true);
4118
4119         if (new_bfqq) {
4120                 if (bic_to_bfqq(RQ_BIC(rq), 1) != bfqq)
4121                         new_bfqq = bic_to_bfqq(RQ_BIC(rq), 1);
4122                 /*
4123                  * Release the request's reference to the old bfqq
4124                  * and make sure one is taken to the shared queue.
4125                  */
4126                 new_bfqq->allocated++;
4127                 bfqq->allocated--;
4128                 new_bfqq->ref++;
4129                 bfq_clear_bfqq_just_created(bfqq);
4130                 /*
4131                  * If the bic associated with the process
4132                  * issuing this request still points to bfqq
4133                  * (and thus has not been already redirected
4134                  * to new_bfqq or even some other bfq_queue),
4135                  * then complete the merge and redirect it to
4136                  * new_bfqq.
4137                  */
4138                 if (bic_to_bfqq(RQ_BIC(rq), 1) == bfqq)
4139                         bfq_merge_bfqqs(bfqd, RQ_BIC(rq),
4140                                         bfqq, new_bfqq);
4141                 /*
4142                  * rq is about to be enqueued into new_bfqq,
4143                  * release rq reference on bfqq
4144                  */
4145                 bfq_put_queue(bfqq);
4146                 rq->elv.priv[1] = new_bfqq;
4147                 bfqq = new_bfqq;
4148         }
4149
4150         bfq_add_request(rq);
4151
4152         rq->fifo_time = ktime_get_ns() + bfqd->bfq_fifo_expire[rq_is_sync(rq)];
4153         list_add_tail(&rq->queuelist, &bfqq->fifo);
4154
4155         bfq_rq_enqueued(bfqd, bfqq, rq);
4156 }
4157
4158 static void bfq_insert_request(struct blk_mq_hw_ctx *hctx, struct request *rq,
4159                                bool at_head)
4160 {
4161         struct request_queue *q = hctx->queue;
4162         struct bfq_data *bfqd = q->elevator->elevator_data;
4163
4164         spin_lock_irq(&bfqd->lock);
4165         if (blk_mq_sched_try_insert_merge(q, rq)) {
4166                 spin_unlock_irq(&bfqd->lock);
4167                 return;
4168         }
4169
4170         spin_unlock_irq(&bfqd->lock);
4171
4172         blk_mq_sched_request_inserted(rq);
4173
4174         spin_lock_irq(&bfqd->lock);
4175         if (at_head || blk_rq_is_passthrough(rq)) {
4176                 if (at_head)
4177                         list_add(&rq->queuelist, &bfqd->dispatch);
4178                 else
4179                         list_add_tail(&rq->queuelist, &bfqd->dispatch);
4180         } else {
4181                 __bfq_insert_request(bfqd, rq);
4182
4183                 if (rq_mergeable(rq)) {
4184                         elv_rqhash_add(q, rq);
4185                         if (!q->last_merge)
4186                                 q->last_merge = rq;
4187                 }
4188         }
4189
4190         spin_unlock_irq(&bfqd->lock);
4191 }
4192
4193 static void bfq_insert_requests(struct blk_mq_hw_ctx *hctx,
4194                                 struct list_head *list, bool at_head)
4195 {
4196         while (!list_empty(list)) {
4197                 struct request *rq;
4198
4199                 rq = list_first_entry(list, struct request, queuelist);
4200                 list_del_init(&rq->queuelist);
4201                 bfq_insert_request(hctx, rq, at_head);
4202         }
4203 }
4204
4205 static void bfq_update_hw_tag(struct bfq_data *bfqd)
4206 {
4207         bfqd->max_rq_in_driver = max_t(int, bfqd->max_rq_in_driver,
4208                                        bfqd->rq_in_driver);
4209
4210         if (bfqd->hw_tag == 1)
4211                 return;
4212
4213         /*
4214          * This sample is valid if the number of outstanding requests
4215          * is large enough to allow a queueing behavior.  Note that the
4216          * sum is not exact, as it's not taking into account deactivated
4217          * requests.
4218          */
4219         if (bfqd->rq_in_driver + bfqd->queued < BFQ_HW_QUEUE_THRESHOLD)
4220                 return;
4221
4222         if (bfqd->hw_tag_samples++ < BFQ_HW_QUEUE_SAMPLES)
4223                 return;
4224
4225         bfqd->hw_tag = bfqd->max_rq_in_driver > BFQ_HW_QUEUE_THRESHOLD;
4226         bfqd->max_rq_in_driver = 0;
4227         bfqd->hw_tag_samples = 0;
4228 }
4229
4230 static void bfq_completed_request(struct bfq_queue *bfqq, struct bfq_data *bfqd)
4231 {
4232         u64 now_ns;
4233         u32 delta_us;
4234
4235         bfq_update_hw_tag(bfqd);
4236
4237         bfqd->rq_in_driver--;
4238         bfqq->dispatched--;
4239
4240         if (!bfqq->dispatched && !bfq_bfqq_busy(bfqq)) {
4241                 /*
4242                  * Set budget_timeout (which we overload to store the
4243                  * time at which the queue remains with no backlog and
4244                  * no outstanding request; used by the weight-raising
4245                  * mechanism).
4246                  */
4247                 bfqq->budget_timeout = jiffies;
4248
4249                 bfq_weights_tree_remove(bfqd, &bfqq->entity,
4250                                         &bfqd->queue_weights_tree);
4251         }
4252
4253         now_ns = ktime_get_ns();
4254
4255         bfqq->ttime.last_end_request = now_ns;
4256
4257         /*
4258          * Using us instead of ns, to get a reasonable precision in
4259          * computing rate in next check.
4260          */
4261         delta_us = div_u64(now_ns - bfqd->last_completion, NSEC_PER_USEC);
4262
4263         /*
4264          * If the request took rather long to complete, and, according
4265          * to the maximum request size recorded, this completion latency
4266          * implies that the request was certainly served at a very low
4267          * rate (less than 1M sectors/sec), then the whole observation
4268          * interval that lasts up to this time instant cannot be a
4269          * valid time interval for computing a new peak rate.  Invoke
4270          * bfq_update_rate_reset to have the following three steps
4271          * taken:
4272          * - close the observation interval at the last (previous)
4273          *   request dispatch or completion
4274          * - compute rate, if possible, for that observation interval
4275          * - reset to zero samples, which will trigger a proper
4276          *   re-initialization of the observation interval on next
4277          *   dispatch
4278          */
4279         if (delta_us > BFQ_MIN_TT/NSEC_PER_USEC &&
4280            (bfqd->last_rq_max_size<<BFQ_RATE_SHIFT)/delta_us <
4281                         1UL<<(BFQ_RATE_SHIFT - 10))
4282                 bfq_update_rate_reset(bfqd, NULL);
4283         bfqd->last_completion = now_ns;
4284
4285         /*
4286          * If we are waiting to discover whether the request pattern
4287          * of the task associated with the queue is actually
4288          * isochronous, and both requisites for this condition to hold
4289          * are now satisfied, then compute soft_rt_next_start (see the
4290          * comments on the function bfq_bfqq_softrt_next_start()). We
4291          * schedule this delayed check when bfqq expires, if it still
4292          * has in-flight requests.
4293          */
4294         if (bfq_bfqq_softrt_update(bfqq) && bfqq->dispatched == 0 &&
4295             RB_EMPTY_ROOT(&bfqq->sort_list))
4296                 bfqq->soft_rt_next_start =
4297                         bfq_bfqq_softrt_next_start(bfqd, bfqq);
4298
4299         /*
4300          * If this is the in-service queue, check if it needs to be expired,
4301          * or if we want to idle in case it has no pending requests.
4302          */
4303         if (bfqd->in_service_queue == bfqq) {
4304                 if (bfqq->dispatched == 0 && bfq_bfqq_must_idle(bfqq)) {
4305                         bfq_arm_slice_timer(bfqd);
4306                         return;
4307                 } else if (bfq_may_expire_for_budg_timeout(bfqq))
4308                         bfq_bfqq_expire(bfqd, bfqq, false,
4309                                         BFQQE_BUDGET_TIMEOUT);
4310                 else if (RB_EMPTY_ROOT(&bfqq->sort_list) &&
4311                          (bfqq->dispatched == 0 ||
4312                           !bfq_bfqq_may_idle(bfqq)))
4313                         bfq_bfqq_expire(bfqd, bfqq, false,
4314                                         BFQQE_NO_MORE_REQUESTS);
4315         }
4316
4317         if (!bfqd->rq_in_driver)
4318                 bfq_schedule_dispatch(bfqd);
4319 }
4320
4321 static void bfq_put_rq_priv_body(struct bfq_queue *bfqq)
4322 {
4323         bfqq->allocated--;
4324
4325         bfq_put_queue(bfqq);
4326 }
4327
4328 static void bfq_finish_request(struct request *rq)
4329 {
4330         struct bfq_queue *bfqq;
4331         struct bfq_data *bfqd;
4332
4333         if (!rq->elv.icq)
4334                 return;
4335
4336         bfqq = RQ_BFQQ(rq);
4337         bfqd = bfqq->bfqd;
4338
4339         if (rq->rq_flags & RQF_STARTED)
4340                 bfqg_stats_update_completion(bfqq_group(bfqq),
4341                                              rq_start_time_ns(rq),
4342                                              rq_io_start_time_ns(rq),
4343                                              rq->cmd_flags);
4344
4345         if (likely(rq->rq_flags & RQF_STARTED)) {
4346                 unsigned long flags;
4347
4348                 spin_lock_irqsave(&bfqd->lock, flags);
4349
4350                 bfq_completed_request(bfqq, bfqd);
4351                 bfq_put_rq_priv_body(bfqq);
4352
4353                 spin_unlock_irqrestore(&bfqd->lock, flags);
4354         } else {
4355                 /*
4356                  * Request rq may be still/already in the scheduler,
4357                  * in which case we need to remove it. And we cannot
4358                  * defer such a check and removal, to avoid
4359                  * inconsistencies in the time interval from the end
4360                  * of this function to the start of the deferred work.
4361                  * This situation seems to occur only in process
4362                  * context, as a consequence of a merge. In the
4363                  * current version of the code, this implies that the
4364                  * lock is held.
4365                  */
4366
4367                 if (!RB_EMPTY_NODE(&rq->rb_node))
4368                         bfq_remove_request(rq->q, rq);
4369                 bfq_put_rq_priv_body(bfqq);
4370         }
4371
4372         rq->elv.priv[0] = NULL;
4373         rq->elv.priv[1] = NULL;
4374 }
4375
4376 /*
4377  * Returns NULL if a new bfqq should be allocated, or the old bfqq if this
4378  * was the last process referring to that bfqq.
4379  */
4380 static struct bfq_queue *
4381 bfq_split_bfqq(struct bfq_io_cq *bic, struct bfq_queue *bfqq)
4382 {
4383         bfq_log_bfqq(bfqq->bfqd, bfqq, "splitting queue");
4384
4385         if (bfqq_process_refs(bfqq) == 1) {
4386                 bfqq->pid = current->pid;
4387                 bfq_clear_bfqq_coop(bfqq);
4388                 bfq_clear_bfqq_split_coop(bfqq);
4389                 return bfqq;
4390         }
4391
4392         bic_set_bfqq(bic, NULL, 1);
4393
4394         bfq_put_cooperator(bfqq);
4395
4396         bfq_put_queue(bfqq);
4397         return NULL;
4398 }
4399
4400 static struct bfq_queue *bfq_get_bfqq_handle_split(struct bfq_data *bfqd,
4401                                                    struct bfq_io_cq *bic,
4402                                                    struct bio *bio,
4403                                                    bool split, bool is_sync,
4404                                                    bool *new_queue)
4405 {
4406         struct bfq_queue *bfqq = bic_to_bfqq(bic, is_sync);
4407
4408         if (likely(bfqq && bfqq != &bfqd->oom_bfqq))
4409                 return bfqq;
4410
4411         if (new_queue)
4412                 *new_queue = true;
4413
4414         if (bfqq)
4415                 bfq_put_queue(bfqq);
4416         bfqq = bfq_get_queue(bfqd, bio, is_sync, bic);
4417
4418         bic_set_bfqq(bic, bfqq, is_sync);
4419         if (split && is_sync) {
4420                 if ((bic->was_in_burst_list && bfqd->large_burst) ||
4421                     bic->saved_in_large_burst)
4422                         bfq_mark_bfqq_in_large_burst(bfqq);
4423                 else {
4424                         bfq_clear_bfqq_in_large_burst(bfqq);
4425                         if (bic->was_in_burst_list)
4426                                 hlist_add_head(&bfqq->burst_list_node,
4427                                                &bfqd->burst_list);
4428                 }
4429                 bfqq->split_time = jiffies;
4430         }
4431
4432         return bfqq;
4433 }
4434
4435 /*
4436  * Allocate bfq data structures associated with this request.
4437  */
4438 static void bfq_prepare_request(struct request *rq, struct bio *bio)
4439 {
4440         struct request_queue *q = rq->q;
4441         struct bfq_data *bfqd = q->elevator->elevator_data;
4442         struct bfq_io_cq *bic;
4443         const int is_sync = rq_is_sync(rq);
4444         struct bfq_queue *bfqq;
4445         bool new_queue = false;
4446         bool bfqq_already_existing = false, split = false;
4447
4448         /*
4449          * Even if we don't have an icq attached, we should still clear
4450          * the scheduler pointers, as they might point to previously
4451          * allocated bic/bfqq structs.
4452          */
4453         if (!rq->elv.icq) {
4454                 rq->elv.priv[0] = rq->elv.priv[1] = NULL;
4455                 return;
4456         }
4457
4458         bic = icq_to_bic(rq->elv.icq);
4459
4460         spin_lock_irq(&bfqd->lock);
4461
4462         bfq_check_ioprio_change(bic, bio);
4463
4464         bfq_bic_update_cgroup(bic, bio);
4465
4466         bfqq = bfq_get_bfqq_handle_split(bfqd, bic, bio, false, is_sync,
4467                                          &new_queue);
4468
4469         if (likely(!new_queue)) {
4470                 /* If the queue was seeky for too long, break it apart. */
4471                 if (bfq_bfqq_coop(bfqq) && bfq_bfqq_split_coop(bfqq)) {
4472                         bfq_log_bfqq(bfqd, bfqq, "breaking apart bfqq");
4473
4474                         /* Update bic before losing reference to bfqq */
4475                         if (bfq_bfqq_in_large_burst(bfqq))
4476                                 bic->saved_in_large_burst = true;
4477
4478                         bfqq = bfq_split_bfqq(bic, bfqq);
4479                         split = true;
4480
4481                         if (!bfqq)
4482                                 bfqq = bfq_get_bfqq_handle_split(bfqd, bic, bio,
4483                                                                  true, is_sync,
4484                                                                  NULL);
4485                         else
4486                                 bfqq_already_existing = true;
4487                 }
4488         }
4489
4490         bfqq->allocated++;
4491         bfqq->ref++;
4492         bfq_log_bfqq(bfqd, bfqq, "get_request %p: bfqq %p, %d",
4493                      rq, bfqq, bfqq->ref);
4494
4495         rq->elv.priv[0] = bic;
4496         rq->elv.priv[1] = bfqq;
4497
4498         /*
4499          * If a bfq_queue has only one process reference, it is owned
4500          * by only this bic: we can then set bfqq->bic = bic. in
4501          * addition, if the queue has also just been split, we have to
4502          * resume its state.
4503          */
4504         if (likely(bfqq != &bfqd->oom_bfqq) && bfqq_process_refs(bfqq) == 1) {
4505                 bfqq->bic = bic;
4506                 if (split) {
4507                         /*
4508                          * The queue has just been split from a shared
4509                          * queue: restore the idle window and the
4510                          * possible weight raising period.
4511                          */
4512                         bfq_bfqq_resume_state(bfqq, bfqd, bic,
4513                                               bfqq_already_existing);
4514                 }
4515         }
4516
4517         if (unlikely(bfq_bfqq_just_created(bfqq)))
4518                 bfq_handle_burst(bfqd, bfqq);
4519
4520         spin_unlock_irq(&bfqd->lock);
4521 }
4522
4523 static void bfq_idle_slice_timer_body(struct bfq_queue *bfqq)
4524 {
4525         struct bfq_data *bfqd = bfqq->bfqd;
4526         enum bfqq_expiration reason;
4527         unsigned long flags;
4528
4529         spin_lock_irqsave(&bfqd->lock, flags);
4530         bfq_clear_bfqq_wait_request(bfqq);
4531
4532         if (bfqq != bfqd->in_service_queue) {
4533                 spin_unlock_irqrestore(&bfqd->lock, flags);
4534                 return;
4535         }
4536
4537         if (bfq_bfqq_budget_timeout(bfqq))
4538                 /*
4539                  * Also here the queue can be safely expired
4540                  * for budget timeout without wasting
4541                  * guarantees
4542                  */
4543                 reason = BFQQE_BUDGET_TIMEOUT;
4544         else if (bfqq->queued[0] == 0 && bfqq->queued[1] == 0)
4545                 /*
4546                  * The queue may not be empty upon timer expiration,
4547                  * because we may not disable the timer when the
4548                  * first request of the in-service queue arrives
4549                  * during disk idling.
4550                  */
4551                 reason = BFQQE_TOO_IDLE;
4552         else
4553                 goto schedule_dispatch;
4554
4555         bfq_bfqq_expire(bfqd, bfqq, true, reason);
4556
4557 schedule_dispatch:
4558         spin_unlock_irqrestore(&bfqd->lock, flags);
4559         bfq_schedule_dispatch(bfqd);
4560 }
4561
4562 /*
4563  * Handler of the expiration of the timer running if the in-service queue
4564  * is idling inside its time slice.
4565  */
4566 static enum hrtimer_restart bfq_idle_slice_timer(struct hrtimer *timer)
4567 {
4568         struct bfq_data *bfqd = container_of(timer, struct bfq_data,
4569                                              idle_slice_timer);
4570         struct bfq_queue *bfqq = bfqd->in_service_queue;
4571
4572         /*
4573          * Theoretical race here: the in-service queue can be NULL or
4574          * different from the queue that was idling if a new request
4575          * arrives for the current queue and there is a full dispatch
4576          * cycle that changes the in-service queue.  This can hardly
4577          * happen, but in the worst case we just expire a queue too
4578          * early.
4579          */
4580         if (bfqq)
4581                 bfq_idle_slice_timer_body(bfqq);
4582
4583         return HRTIMER_NORESTART;
4584 }
4585
4586 static void __bfq_put_async_bfqq(struct bfq_data *bfqd,
4587                                  struct bfq_queue **bfqq_ptr)
4588 {
4589         struct bfq_queue *bfqq = *bfqq_ptr;
4590
4591         bfq_log(bfqd, "put_async_bfqq: %p", bfqq);
4592         if (bfqq) {
4593                 bfq_bfqq_move(bfqd, bfqq, bfqd->root_group);
4594
4595                 bfq_log_bfqq(bfqd, bfqq, "put_async_bfqq: putting %p, %d",
4596                              bfqq, bfqq->ref);
4597                 bfq_put_queue(bfqq);
4598                 *bfqq_ptr = NULL;
4599         }
4600 }
4601
4602 /*
4603  * Release all the bfqg references to its async queues.  If we are
4604  * deallocating the group these queues may still contain requests, so
4605  * we reparent them to the root cgroup (i.e., the only one that will
4606  * exist for sure until all the requests on a device are gone).
4607  */
4608 void bfq_put_async_queues(struct bfq_data *bfqd, struct bfq_group *bfqg)
4609 {
4610         int i, j;
4611
4612         for (i = 0; i < 2; i++)
4613                 for (j = 0; j < IOPRIO_BE_NR; j++)
4614                         __bfq_put_async_bfqq(bfqd, &bfqg->async_bfqq[i][j]);
4615
4616         __bfq_put_async_bfqq(bfqd, &bfqg->async_idle_bfqq);
4617 }
4618
4619 static void bfq_exit_queue(struct elevator_queue *e)
4620 {
4621         struct bfq_data *bfqd = e->elevator_data;
4622         struct bfq_queue *bfqq, *n;
4623
4624         hrtimer_cancel(&bfqd->idle_slice_timer);
4625
4626         spin_lock_irq(&bfqd->lock);
4627         list_for_each_entry_safe(bfqq, n, &bfqd->idle_list, bfqq_list)
4628                 bfq_deactivate_bfqq(bfqd, bfqq, false, false);
4629         spin_unlock_irq(&bfqd->lock);
4630
4631         hrtimer_cancel(&bfqd->idle_slice_timer);
4632
4633 #ifdef CONFIG_BFQ_GROUP_IOSCHED
4634         blkcg_deactivate_policy(bfqd->queue, &blkcg_policy_bfq);
4635 #else
4636         spin_lock_irq(&bfqd->lock);
4637         bfq_put_async_queues(bfqd, bfqd->root_group);
4638         kfree(bfqd->root_group);
4639         spin_unlock_irq(&bfqd->lock);
4640 #endif
4641
4642         kfree(bfqd);
4643 }
4644
4645 static void bfq_init_root_group(struct bfq_group *root_group,
4646                                 struct bfq_data *bfqd)
4647 {
4648         int i;
4649
4650 #ifdef CONFIG_BFQ_GROUP_IOSCHED
4651         root_group->entity.parent = NULL;
4652         root_group->my_entity = NULL;
4653         root_group->bfqd = bfqd;
4654 #endif
4655         root_group->rq_pos_tree = RB_ROOT;
4656         for (i = 0; i < BFQ_IOPRIO_CLASSES; i++)
4657                 root_group->sched_data.service_tree[i] = BFQ_SERVICE_TREE_INIT;
4658         root_group->sched_data.bfq_class_idle_last_service = jiffies;
4659 }
4660
4661 static int bfq_init_queue(struct request_queue *q, struct elevator_type *e)
4662 {
4663         struct bfq_data *bfqd;
4664         struct elevator_queue *eq;
4665
4666         eq = elevator_alloc(q, e);
4667         if (!eq)
4668                 return -ENOMEM;
4669
4670         bfqd = kzalloc_node(sizeof(*bfqd), GFP_KERNEL, q->node);
4671         if (!bfqd) {
4672                 kobject_put(&eq->kobj);
4673                 return -ENOMEM;
4674         }
4675         eq->elevator_data = bfqd;
4676
4677         spin_lock_irq(q->queue_lock);
4678         q->elevator = eq;
4679         spin_unlock_irq(q->queue_lock);
4680
4681         /*
4682          * Our fallback bfqq if bfq_find_alloc_queue() runs into OOM issues.
4683          * Grab a permanent reference to it, so that the normal code flow
4684          * will not attempt to free it.
4685          */
4686         bfq_init_bfqq(bfqd, &bfqd->oom_bfqq, NULL, 1, 0);
4687         bfqd->oom_bfqq.ref++;
4688         bfqd->oom_bfqq.new_ioprio = BFQ_DEFAULT_QUEUE_IOPRIO;
4689         bfqd->oom_bfqq.new_ioprio_class = IOPRIO_CLASS_BE;
4690         bfqd->oom_bfqq.entity.new_weight =
4691                 bfq_ioprio_to_weight(bfqd->oom_bfqq.new_ioprio);
4692
4693         /* oom_bfqq does not participate to bursts */
4694         bfq_clear_bfqq_just_created(&bfqd->oom_bfqq);
4695
4696         /*
4697          * Trigger weight initialization, according to ioprio, at the
4698          * oom_bfqq's first activation. The oom_bfqq's ioprio and ioprio
4699          * class won't be changed any more.
4700          */
4701         bfqd->oom_bfqq.entity.prio_changed = 1;
4702
4703         bfqd->queue = q;
4704
4705         INIT_LIST_HEAD(&bfqd->dispatch);
4706
4707         hrtimer_init(&bfqd->idle_slice_timer, CLOCK_MONOTONIC,
4708                      HRTIMER_MODE_REL);
4709         bfqd->idle_slice_timer.function = bfq_idle_slice_timer;
4710
4711         bfqd->queue_weights_tree = RB_ROOT;
4712         bfqd->group_weights_tree = RB_ROOT;
4713
4714         INIT_LIST_HEAD(&bfqd->active_list);
4715         INIT_LIST_HEAD(&bfqd->idle_list);
4716         INIT_HLIST_HEAD(&bfqd->burst_list);
4717
4718         bfqd->hw_tag = -1;
4719
4720         bfqd->bfq_max_budget = bfq_default_max_budget;
4721
4722         bfqd->bfq_fifo_expire[0] = bfq_fifo_expire[0];
4723         bfqd->bfq_fifo_expire[1] = bfq_fifo_expire[1];
4724         bfqd->bfq_back_max = bfq_back_max;
4725         bfqd->bfq_back_penalty = bfq_back_penalty;
4726         bfqd->bfq_slice_idle = bfq_slice_idle;
4727         bfqd->bfq_timeout = bfq_timeout;
4728
4729         bfqd->bfq_requests_within_timer = 120;
4730
4731         bfqd->bfq_large_burst_thresh = 8;
4732         bfqd->bfq_burst_interval = msecs_to_jiffies(180);
4733
4734         bfqd->low_latency = true;
4735
4736         /*
4737          * Trade-off between responsiveness and fairness.
4738          */
4739         bfqd->bfq_wr_coeff = 30;
4740         bfqd->bfq_wr_rt_max_time = msecs_to_jiffies(300);
4741         bfqd->bfq_wr_max_time = 0;
4742         bfqd->bfq_wr_min_idle_time = msecs_to_jiffies(2000);
4743         bfqd->bfq_wr_min_inter_arr_async = msecs_to_jiffies(500);
4744         bfqd->bfq_wr_max_softrt_rate = 7000; /*
4745                                               * Approximate rate required
4746                                               * to playback or record a
4747                                               * high-definition compressed
4748                                               * video.
4749                                               */
4750         bfqd->wr_busy_queues = 0;
4751
4752         /*
4753          * Begin by assuming, optimistically, that the device is a
4754          * high-speed one, and that its peak rate is equal to 2/3 of
4755          * the highest reference rate.
4756          */
4757         bfqd->RT_prod = R_fast[blk_queue_nonrot(bfqd->queue)] *
4758                         T_fast[blk_queue_nonrot(bfqd->queue)];
4759         bfqd->peak_rate = R_fast[blk_queue_nonrot(bfqd->queue)] * 2 / 3;
4760         bfqd->device_speed = BFQ_BFQD_FAST;
4761
4762         spin_lock_init(&bfqd->lock);
4763
4764         /*
4765          * The invocation of the next bfq_create_group_hierarchy
4766          * function is the head of a chain of function calls
4767          * (bfq_create_group_hierarchy->blkcg_activate_policy->
4768          * blk_mq_freeze_queue) that may lead to the invocation of the
4769          * has_work hook function. For this reason,
4770          * bfq_create_group_hierarchy is invoked only after all
4771          * scheduler data has been initialized, apart from the fields
4772          * that can be initialized only after invoking
4773          * bfq_create_group_hierarchy. This, in particular, enables
4774          * has_work to correctly return false. Of course, to avoid
4775          * other inconsistencies, the blk-mq stack must then refrain
4776          * from invoking further scheduler hooks before this init
4777          * function is finished.
4778          */
4779         bfqd->root_group = bfq_create_group_hierarchy(bfqd, q->node);
4780         if (!bfqd->root_group)
4781                 goto out_free;
4782         bfq_init_root_group(bfqd->root_group, bfqd);
4783         bfq_init_entity(&bfqd->oom_bfqq.entity, bfqd->root_group);
4784
4785         wbt_disable_default(q);
4786         return 0;
4787
4788 out_free:
4789         kfree(bfqd);
4790         kobject_put(&eq->kobj);
4791         return -ENOMEM;
4792 }
4793
4794 static void bfq_slab_kill(void)
4795 {
4796         kmem_cache_destroy(bfq_pool);
4797 }
4798
4799 static int __init bfq_slab_setup(void)
4800 {
4801         bfq_pool = KMEM_CACHE(bfq_queue, 0);
4802         if (!bfq_pool)
4803                 return -ENOMEM;
4804         return 0;
4805 }
4806
4807 static ssize_t bfq_var_show(unsigned int var, char *page)
4808 {
4809         return sprintf(page, "%u\n", var);
4810 }
4811
4812 static int bfq_var_store(unsigned long *var, const char *page)
4813 {
4814         unsigned long new_val;
4815         int ret = kstrtoul(page, 10, &new_val);
4816
4817         if (ret)
4818                 return ret;
4819         *var = new_val;
4820         return 0;
4821 }
4822
4823 #define SHOW_FUNCTION(__FUNC, __VAR, __CONV)                            \
4824 static ssize_t __FUNC(struct elevator_queue *e, char *page)             \
4825 {                                                                       \
4826         struct bfq_data *bfqd = e->elevator_data;                       \
4827         u64 __data = __VAR;                                             \
4828         if (__CONV == 1)                                                \
4829                 __data = jiffies_to_msecs(__data);                      \
4830         else if (__CONV == 2)                                           \
4831                 __data = div_u64(__data, NSEC_PER_MSEC);                \
4832         return bfq_var_show(__data, (page));                            \
4833 }
4834 SHOW_FUNCTION(bfq_fifo_expire_sync_show, bfqd->bfq_fifo_expire[1], 2);
4835 SHOW_FUNCTION(bfq_fifo_expire_async_show, bfqd->bfq_fifo_expire[0], 2);
4836 SHOW_FUNCTION(bfq_back_seek_max_show, bfqd->bfq_back_max, 0);
4837 SHOW_FUNCTION(bfq_back_seek_penalty_show, bfqd->bfq_back_penalty, 0);
4838 SHOW_FUNCTION(bfq_slice_idle_show, bfqd->bfq_slice_idle, 2);
4839 SHOW_FUNCTION(bfq_max_budget_show, bfqd->bfq_user_max_budget, 0);
4840 SHOW_FUNCTION(bfq_timeout_sync_show, bfqd->bfq_timeout, 1);
4841 SHOW_FUNCTION(bfq_strict_guarantees_show, bfqd->strict_guarantees, 0);
4842 SHOW_FUNCTION(bfq_low_latency_show, bfqd->low_latency, 0);
4843 #undef SHOW_FUNCTION
4844
4845 #define USEC_SHOW_FUNCTION(__FUNC, __VAR)                               \
4846 static ssize_t __FUNC(struct elevator_queue *e, char *page)             \
4847 {                                                                       \
4848         struct bfq_data *bfqd = e->elevator_data;                       \
4849         u64 __data = __VAR;                                             \
4850         __data = div_u64(__data, NSEC_PER_USEC);                        \
4851         return bfq_var_show(__data, (page));                            \
4852 }
4853 USEC_SHOW_FUNCTION(bfq_slice_idle_us_show, bfqd->bfq_slice_idle);
4854 #undef USEC_SHOW_FUNCTION
4855
4856 #define STORE_FUNCTION(__FUNC, __PTR, MIN, MAX, __CONV)                 \
4857 static ssize_t                                                          \
4858 __FUNC(struct elevator_queue *e, const char *page, size_t count)        \
4859 {                                                                       \
4860         struct bfq_data *bfqd = e->elevator_data;                       \
4861         unsigned long __data, __min = (MIN), __max = (MAX);             \
4862         int ret;                                                        \
4863                                                                         \
4864         ret = bfq_var_store(&__data, (page));                           \
4865         if (ret)                                                        \
4866                 return ret;                                             \
4867         if (__data < __min)                                             \
4868                 __data = __min;                                         \
4869         else if (__data > __max)                                        \
4870                 __data = __max;                                         \
4871         if (__CONV == 1)                                                \
4872                 *(__PTR) = msecs_to_jiffies(__data);                    \
4873         else if (__CONV == 2)                                           \
4874                 *(__PTR) = (u64)__data * NSEC_PER_MSEC;                 \
4875         else                                                            \
4876                 *(__PTR) = __data;                                      \
4877         return count;                                                   \
4878 }
4879 STORE_FUNCTION(bfq_fifo_expire_sync_store, &bfqd->bfq_fifo_expire[1], 1,
4880                 INT_MAX, 2);
4881 STORE_FUNCTION(bfq_fifo_expire_async_store, &bfqd->bfq_fifo_expire[0], 1,
4882                 INT_MAX, 2);
4883 STORE_FUNCTION(bfq_back_seek_max_store, &bfqd->bfq_back_max, 0, INT_MAX, 0);
4884 STORE_FUNCTION(bfq_back_seek_penalty_store, &bfqd->bfq_back_penalty, 1,
4885                 INT_MAX, 0);
4886 STORE_FUNCTION(bfq_slice_idle_store, &bfqd->bfq_slice_idle, 0, INT_MAX, 2);
4887 #undef STORE_FUNCTION
4888
4889 #define USEC_STORE_FUNCTION(__FUNC, __PTR, MIN, MAX)                    \
4890 static ssize_t __FUNC(struct elevator_queue *e, const char *page, size_t count)\
4891 {                                                                       \
4892         struct bfq_data *bfqd = e->elevator_data;                       \
4893         unsigned long __data, __min = (MIN), __max = (MAX);             \
4894         int ret;                                                        \
4895                                                                         \
4896         ret = bfq_var_store(&__data, (page));                           \
4897         if (ret)                                                        \
4898                 return ret;                                             \
4899         if (__data < __min)                                             \
4900                 __data = __min;                                         \
4901         else if (__data > __max)                                        \
4902                 __data = __max;                                         \
4903         *(__PTR) = (u64)__data * NSEC_PER_USEC;                         \
4904         return count;                                                   \
4905 }
4906 USEC_STORE_FUNCTION(bfq_slice_idle_us_store, &bfqd->bfq_slice_idle, 0,
4907                     UINT_MAX);
4908 #undef USEC_STORE_FUNCTION
4909
4910 static ssize_t bfq_max_budget_store(struct elevator_queue *e,
4911                                     const char *page, size_t count)
4912 {
4913         struct bfq_data *bfqd = e->elevator_data;
4914         unsigned long __data;
4915         int ret;
4916
4917         ret = bfq_var_store(&__data, (page));
4918         if (ret)
4919                 return ret;
4920
4921         if (__data == 0)
4922                 bfqd->bfq_max_budget = bfq_calc_max_budget(bfqd);
4923         else {
4924                 if (__data > INT_MAX)
4925                         __data = INT_MAX;
4926                 bfqd->bfq_max_budget = __data;
4927         }
4928
4929         bfqd->bfq_user_max_budget = __data;
4930
4931         return count;
4932 }
4933
4934 /*
4935  * Leaving this name to preserve name compatibility with cfq
4936  * parameters, but this timeout is used for both sync and async.
4937  */
4938 static ssize_t bfq_timeout_sync_store(struct elevator_queue *e,
4939                                       const char *page, size_t count)
4940 {
4941         struct bfq_data *bfqd = e->elevator_data;
4942         unsigned long __data;
4943         int ret;
4944
4945         ret = bfq_var_store(&__data, (page));
4946         if (ret)
4947                 return ret;
4948
4949         if (__data < 1)
4950                 __data = 1;
4951         else if (__data > INT_MAX)
4952                 __data = INT_MAX;
4953
4954         bfqd->bfq_timeout = msecs_to_jiffies(__data);
4955         if (bfqd->bfq_user_max_budget == 0)
4956                 bfqd->bfq_max_budget = bfq_calc_max_budget(bfqd);
4957
4958         return count;
4959 }
4960
4961 static ssize_t bfq_strict_guarantees_store(struct elevator_queue *e,
4962                                      const char *page, size_t count)
4963 {
4964         struct bfq_data *bfqd = e->elevator_data;
4965         unsigned long __data;
4966         int ret;
4967
4968         ret = bfq_var_store(&__data, (page));
4969         if (ret)
4970                 return ret;
4971
4972         if (__data > 1)
4973                 __data = 1;
4974         if (!bfqd->strict_guarantees && __data == 1
4975             && bfqd->bfq_slice_idle < 8 * NSEC_PER_MSEC)
4976                 bfqd->bfq_slice_idle = 8 * NSEC_PER_MSEC;
4977
4978         bfqd->strict_guarantees = __data;
4979
4980         return count;
4981 }
4982
4983 static ssize_t bfq_low_latency_store(struct elevator_queue *e,
4984                                      const char *page, size_t count)
4985 {
4986         struct bfq_data *bfqd = e->elevator_data;
4987         unsigned long __data;
4988         int ret;
4989
4990         ret = bfq_var_store(&__data, (page));
4991         if (ret)
4992                 return ret;
4993
4994         if (__data > 1)
4995                 __data = 1;
4996         if (__data == 0 && bfqd->low_latency != 0)
4997                 bfq_end_wr(bfqd);
4998         bfqd->low_latency = __data;
4999
5000         return count;
5001 }
5002
5003 #define BFQ_ATTR(name) \
5004         __ATTR(name, 0644, bfq_##name##_show, bfq_##name##_store)
5005
5006 static struct elv_fs_entry bfq_attrs[] = {
5007         BFQ_ATTR(fifo_expire_sync),
5008         BFQ_ATTR(fifo_expire_async),
5009         BFQ_ATTR(back_seek_max),
5010         BFQ_ATTR(back_seek_penalty),
5011         BFQ_ATTR(slice_idle),
5012         BFQ_ATTR(slice_idle_us),
5013         BFQ_ATTR(max_budget),
5014         BFQ_ATTR(timeout_sync),
5015         BFQ_ATTR(strict_guarantees),
5016         BFQ_ATTR(low_latency),
5017         __ATTR_NULL
5018 };
5019
5020 static struct elevator_type iosched_bfq_mq = {
5021         .ops.mq = {
5022                 .prepare_request        = bfq_prepare_request,
5023                 .finish_request         = bfq_finish_request,
5024                 .exit_icq               = bfq_exit_icq,
5025                 .insert_requests        = bfq_insert_requests,
5026                 .dispatch_request       = bfq_dispatch_request,
5027                 .next_request           = elv_rb_latter_request,
5028                 .former_request         = elv_rb_former_request,
5029                 .allow_merge            = bfq_allow_bio_merge,
5030                 .bio_merge              = bfq_bio_merge,
5031                 .request_merge          = bfq_request_merge,
5032                 .requests_merged        = bfq_requests_merged,
5033                 .request_merged         = bfq_request_merged,
5034                 .has_work               = bfq_has_work,
5035                 .init_sched             = bfq_init_queue,
5036                 .exit_sched             = bfq_exit_queue,
5037         },
5038
5039         .uses_mq =              true,
5040         .icq_size =             sizeof(struct bfq_io_cq),
5041         .icq_align =            __alignof__(struct bfq_io_cq),
5042         .elevator_attrs =       bfq_attrs,
5043         .elevator_name =        "bfq",
5044         .elevator_owner =       THIS_MODULE,
5045 };
5046 MODULE_ALIAS("bfq-iosched");
5047
5048 static int __init bfq_init(void)
5049 {
5050         int ret;
5051
5052 #ifdef CONFIG_BFQ_GROUP_IOSCHED
5053         ret = blkcg_policy_register(&blkcg_policy_bfq);
5054         if (ret)
5055                 return ret;
5056 #endif
5057
5058         ret = -ENOMEM;
5059         if (bfq_slab_setup())
5060                 goto err_pol_unreg;
5061
5062         /*
5063          * Times to load large popular applications for the typical
5064          * systems installed on the reference devices (see the
5065          * comments before the definitions of the next two
5066          * arrays). Actually, we use slightly slower values, as the
5067          * estimated peak rate tends to be smaller than the actual
5068          * peak rate.  The reason for this last fact is that estimates
5069          * are computed over much shorter time intervals than the long
5070          * intervals typically used for benchmarking. Why? First, to
5071          * adapt more quickly to variations. Second, because an I/O
5072          * scheduler cannot rely on a peak-rate-evaluation workload to
5073          * be run for a long time.
5074          */
5075         T_slow[0] = msecs_to_jiffies(3500); /* actually 4 sec */
5076         T_slow[1] = msecs_to_jiffies(6000); /* actually 6.5 sec */
5077         T_fast[0] = msecs_to_jiffies(7000); /* actually 8 sec */
5078         T_fast[1] = msecs_to_jiffies(2500); /* actually 3 sec */
5079
5080         /*
5081          * Thresholds that determine the switch between speed classes
5082          * (see the comments before the definition of the array
5083          * device_speed_thresh). These thresholds are biased towards
5084          * transitions to the fast class. This is safer than the
5085          * opposite bias. In fact, a wrong transition to the slow
5086          * class results in short weight-raising periods, because the
5087          * speed of the device then tends to be higher that the
5088          * reference peak rate. On the opposite end, a wrong
5089          * transition to the fast class tends to increase
5090          * weight-raising periods, because of the opposite reason.
5091          */
5092         device_speed_thresh[0] = (4 * R_slow[0]) / 3;
5093         device_speed_thresh[1] = (4 * R_slow[1]) / 3;
5094
5095         ret = elv_register(&iosched_bfq_mq);
5096         if (ret)
5097                 goto slab_kill;
5098
5099         return 0;
5100
5101 slab_kill:
5102         bfq_slab_kill();
5103 err_pol_unreg:
5104 #ifdef CONFIG_BFQ_GROUP_IOSCHED
5105         blkcg_policy_unregister(&blkcg_policy_bfq);
5106 #endif
5107         return ret;
5108 }
5109
5110 static void __exit bfq_exit(void)
5111 {
5112         elv_unregister(&iosched_bfq_mq);
5113 #ifdef CONFIG_BFQ_GROUP_IOSCHED
5114         blkcg_policy_unregister(&blkcg_policy_bfq);
5115 #endif
5116         bfq_slab_kill();
5117 }
5118
5119 module_init(bfq_init);
5120 module_exit(bfq_exit);
5121
5122 MODULE_AUTHOR("Paolo Valente");
5123 MODULE_LICENSE("GPL");
5124 MODULE_DESCRIPTION("MQ Budget Fair Queueing I/O Scheduler");