1 /******************************************************************************
3 * Back-end of the driver for virtual block devices. This portion of the
4 * driver exports a 'unified' block-device interface that can be accessed
5 * by any operating system that implements a compatible front end. A
6 * reference front-end implementation can be found in:
7 * drivers/block/xen-blkfront.c
9 * Copyright (c) 2003-2004, Keir Fraser & Steve Hand
10 * Copyright (c) 2005, Christopher Clark
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License version 2
14 * as published by the Free Software Foundation; or, when distributed
15 * separately from the Linux kernel or incorporated into other
16 * software packages, subject to the following license:
18 * Permission is hereby granted, free of charge, to any person obtaining a copy
19 * of this source file (the "Software"), to deal in the Software without
20 * restriction, including without limitation the rights to use, copy, modify,
21 * merge, publish, distribute, sublicense, and/or sell copies of the Software,
22 * and to permit persons to whom the Software is furnished to do so, subject to
23 * the following conditions:
25 * The above copyright notice and this permission notice shall be included in
26 * all copies or substantial portions of the Software.
28 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
29 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
30 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
31 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
32 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
33 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
37 #include <linux/spinlock.h>
38 #include <linux/kthread.h>
39 #include <linux/list.h>
40 #include <linux/delay.h>
41 #include <linux/freezer.h>
42 #include <linux/bitmap.h>
44 #include <xen/events.h>
47 #include <asm/xen/hypervisor.h>
48 #include <asm/xen/hypercall.h>
49 #include <xen/balloon.h>
53 * Maximum number of unused free pages to keep in the internal buffer.
54 * Setting this to a value too low will reduce memory used in each backend,
55 * but can have a performance penalty.
57 * A sane value is xen_blkif_reqs * BLKIF_MAX_SEGMENTS_PER_REQUEST, but can
58 * be set to a lower value that might degrade performance on some intensive
62 static int xen_blkif_max_buffer_pages
= 1024;
63 module_param_named(max_buffer_pages
, xen_blkif_max_buffer_pages
, int, 0644);
64 MODULE_PARM_DESC(max_buffer_pages
,
65 "Maximum number of free pages to keep in each block backend buffer");
68 * Maximum number of grants to map persistently in blkback. For maximum
69 * performance this should be the total numbers of grants that can be used
70 * to fill the ring, but since this might become too high, specially with
71 * the use of indirect descriptors, we set it to a value that provides good
72 * performance without using too much memory.
74 * When the list of persistent grants is full we clean it up using a LRU
78 static int xen_blkif_max_pgrants
= 1056;
79 module_param_named(max_persistent_grants
, xen_blkif_max_pgrants
, int, 0644);
80 MODULE_PARM_DESC(max_persistent_grants
,
81 "Maximum number of grants to map persistently");
84 * The LRU mechanism to clean the lists of persistent grants needs to
85 * be executed periodically. The time interval between consecutive executions
86 * of the purge mechanism is set in ms.
88 #define LRU_INTERVAL 100
91 * When the persistent grants list is full we will remove unused grants
92 * from the list. The percent number of grants to be removed at each LRU
95 #define LRU_PERCENT_CLEAN 5
97 /* Run-time switchable: /sys/module/blkback/parameters/ */
98 static unsigned int log_stats
;
99 module_param(log_stats
, int, 0644);
101 #define BLKBACK_INVALID_HANDLE (~0)
103 /* Number of free pages to remove on each call to free_xenballooned_pages */
104 #define NUM_BATCH_FREE_PAGES 10
106 static inline int get_free_page(struct xen_blkif
*blkif
, struct page
**page
)
110 spin_lock_irqsave(&blkif
->free_pages_lock
, flags
);
111 if (list_empty(&blkif
->free_pages
)) {
112 BUG_ON(blkif
->free_pages_num
!= 0);
113 spin_unlock_irqrestore(&blkif
->free_pages_lock
, flags
);
114 return alloc_xenballooned_pages(1, page
, false);
116 BUG_ON(blkif
->free_pages_num
== 0);
117 page
[0] = list_first_entry(&blkif
->free_pages
, struct page
, lru
);
118 list_del(&page
[0]->lru
);
119 blkif
->free_pages_num
--;
120 spin_unlock_irqrestore(&blkif
->free_pages_lock
, flags
);
125 static inline void put_free_pages(struct xen_blkif
*blkif
, struct page
**page
,
131 spin_lock_irqsave(&blkif
->free_pages_lock
, flags
);
132 for (i
= 0; i
< num
; i
++)
133 list_add(&page
[i
]->lru
, &blkif
->free_pages
);
134 blkif
->free_pages_num
+= num
;
135 spin_unlock_irqrestore(&blkif
->free_pages_lock
, flags
);
138 static inline void shrink_free_pagepool(struct xen_blkif
*blkif
, int num
)
140 /* Remove requested pages in batches of NUM_BATCH_FREE_PAGES */
141 struct page
*page
[NUM_BATCH_FREE_PAGES
];
142 unsigned int num_pages
= 0;
145 spin_lock_irqsave(&blkif
->free_pages_lock
, flags
);
146 while (blkif
->free_pages_num
> num
) {
147 BUG_ON(list_empty(&blkif
->free_pages
));
148 page
[num_pages
] = list_first_entry(&blkif
->free_pages
,
150 list_del(&page
[num_pages
]->lru
);
151 blkif
->free_pages_num
--;
152 if (++num_pages
== NUM_BATCH_FREE_PAGES
) {
153 spin_unlock_irqrestore(&blkif
->free_pages_lock
, flags
);
154 free_xenballooned_pages(num_pages
, page
);
155 spin_lock_irqsave(&blkif
->free_pages_lock
, flags
);
159 spin_unlock_irqrestore(&blkif
->free_pages_lock
, flags
);
161 free_xenballooned_pages(num_pages
, page
);
164 #define vaddr(page) ((unsigned long)pfn_to_kaddr(page_to_pfn(page)))
166 static int do_block_io_op(struct xen_blkif
*blkif
);
167 static int dispatch_rw_block_io(struct xen_blkif
*blkif
,
168 struct blkif_request
*req
,
169 struct pending_req
*pending_req
);
170 static void make_response(struct xen_blkif
*blkif
, u64 id
,
171 unsigned short op
, int st
);
173 #define foreach_grant_safe(pos, n, rbtree, node) \
174 for ((pos) = container_of(rb_first((rbtree)), typeof(*(pos)), node), \
175 (n) = (&(pos)->node != NULL) ? rb_next(&(pos)->node) : NULL; \
176 &(pos)->node != NULL; \
177 (pos) = container_of(n, typeof(*(pos)), node), \
178 (n) = (&(pos)->node != NULL) ? rb_next(&(pos)->node) : NULL)
182 * We don't need locking around the persistent grant helpers
183 * because blkback uses a single-thread for each backed, so we
184 * can be sure that this functions will never be called recursively.
186 * The only exception to that is put_persistent_grant, that can be called
187 * from interrupt context (by xen_blkbk_unmap), so we have to use atomic
188 * bit operations to modify the flags of a persistent grant and to count
189 * the number of used grants.
191 static int add_persistent_gnt(struct xen_blkif
*blkif
,
192 struct persistent_gnt
*persistent_gnt
)
194 struct rb_node
**new = NULL
, *parent
= NULL
;
195 struct persistent_gnt
*this;
197 if (blkif
->persistent_gnt_c
>= xen_blkif_max_pgrants
) {
198 if (!blkif
->vbd
.overflow_max_grants
)
199 blkif
->vbd
.overflow_max_grants
= 1;
202 /* Figure out where to put new node */
203 new = &blkif
->persistent_gnts
.rb_node
;
205 this = container_of(*new, struct persistent_gnt
, node
);
208 if (persistent_gnt
->gnt
< this->gnt
)
209 new = &((*new)->rb_left
);
210 else if (persistent_gnt
->gnt
> this->gnt
)
211 new = &((*new)->rb_right
);
213 pr_alert_ratelimited(DRV_PFX
" trying to add a gref that's already in the tree\n");
218 bitmap_zero(persistent_gnt
->flags
, PERSISTENT_GNT_FLAGS_SIZE
);
219 set_bit(PERSISTENT_GNT_ACTIVE
, persistent_gnt
->flags
);
220 /* Add new node and rebalance tree. */
221 rb_link_node(&(persistent_gnt
->node
), parent
, new);
222 rb_insert_color(&(persistent_gnt
->node
), &blkif
->persistent_gnts
);
223 blkif
->persistent_gnt_c
++;
224 atomic_inc(&blkif
->persistent_gnt_in_use
);
228 static struct persistent_gnt
*get_persistent_gnt(struct xen_blkif
*blkif
,
231 struct persistent_gnt
*data
;
232 struct rb_node
*node
= NULL
;
234 node
= blkif
->persistent_gnts
.rb_node
;
236 data
= container_of(node
, struct persistent_gnt
, node
);
238 if (gref
< data
->gnt
)
239 node
= node
->rb_left
;
240 else if (gref
> data
->gnt
)
241 node
= node
->rb_right
;
243 if(test_bit(PERSISTENT_GNT_ACTIVE
, data
->flags
)) {
244 pr_alert_ratelimited(DRV_PFX
" requesting a grant already in use\n");
247 set_bit(PERSISTENT_GNT_ACTIVE
, data
->flags
);
248 atomic_inc(&blkif
->persistent_gnt_in_use
);
255 static void put_persistent_gnt(struct xen_blkif
*blkif
,
256 struct persistent_gnt
*persistent_gnt
)
258 if(!test_bit(PERSISTENT_GNT_ACTIVE
, persistent_gnt
->flags
))
259 pr_alert_ratelimited(DRV_PFX
" freeing a grant already unused");
260 set_bit(PERSISTENT_GNT_WAS_ACTIVE
, persistent_gnt
->flags
);
261 clear_bit(PERSISTENT_GNT_ACTIVE
, persistent_gnt
->flags
);
262 atomic_dec(&blkif
->persistent_gnt_in_use
);
265 static void free_persistent_gnts(struct xen_blkif
*blkif
, struct rb_root
*root
,
268 struct gnttab_unmap_grant_ref unmap
[BLKIF_MAX_SEGMENTS_PER_REQUEST
];
269 struct page
*pages
[BLKIF_MAX_SEGMENTS_PER_REQUEST
];
270 struct persistent_gnt
*persistent_gnt
;
273 int segs_to_unmap
= 0;
275 foreach_grant_safe(persistent_gnt
, n
, root
, node
) {
276 BUG_ON(persistent_gnt
->handle
==
277 BLKBACK_INVALID_HANDLE
);
278 gnttab_set_unmap_op(&unmap
[segs_to_unmap
],
279 (unsigned long) pfn_to_kaddr(page_to_pfn(
280 persistent_gnt
->page
)),
282 persistent_gnt
->handle
);
284 pages
[segs_to_unmap
] = persistent_gnt
->page
;
286 if (++segs_to_unmap
== BLKIF_MAX_SEGMENTS_PER_REQUEST
||
287 !rb_next(&persistent_gnt
->node
)) {
288 ret
= gnttab_unmap_refs(unmap
, NULL
, pages
,
291 put_free_pages(blkif
, pages
, segs_to_unmap
);
295 rb_erase(&persistent_gnt
->node
, root
);
296 kfree(persistent_gnt
);
302 void xen_blkbk_unmap_purged_grants(struct work_struct
*work
)
304 struct gnttab_unmap_grant_ref unmap
[BLKIF_MAX_SEGMENTS_PER_REQUEST
];
305 struct page
*pages
[BLKIF_MAX_SEGMENTS_PER_REQUEST
];
306 struct persistent_gnt
*persistent_gnt
;
307 int ret
, segs_to_unmap
= 0;
308 struct xen_blkif
*blkif
= container_of(work
, typeof(*blkif
), persistent_purge_work
);
310 while(!list_empty(&blkif
->persistent_purge_list
)) {
311 persistent_gnt
= list_first_entry(&blkif
->persistent_purge_list
,
312 struct persistent_gnt
,
314 list_del(&persistent_gnt
->remove_node
);
316 gnttab_set_unmap_op(&unmap
[segs_to_unmap
],
317 vaddr(persistent_gnt
->page
),
319 persistent_gnt
->handle
);
321 pages
[segs_to_unmap
] = persistent_gnt
->page
;
323 if (++segs_to_unmap
== BLKIF_MAX_SEGMENTS_PER_REQUEST
) {
324 ret
= gnttab_unmap_refs(unmap
, NULL
, pages
,
327 put_free_pages(blkif
, pages
, segs_to_unmap
);
330 kfree(persistent_gnt
);
332 if (segs_to_unmap
> 0) {
333 ret
= gnttab_unmap_refs(unmap
, NULL
, pages
, segs_to_unmap
);
335 put_free_pages(blkif
, pages
, segs_to_unmap
);
339 static void purge_persistent_gnt(struct xen_blkif
*blkif
)
341 struct persistent_gnt
*persistent_gnt
;
343 unsigned int num_clean
, total
;
344 bool scan_used
= false, clean_used
= false;
345 struct rb_root
*root
;
347 if (blkif
->persistent_gnt_c
< xen_blkif_max_pgrants
||
348 (blkif
->persistent_gnt_c
== xen_blkif_max_pgrants
&&
349 !blkif
->vbd
.overflow_max_grants
)) {
353 if (work_pending(&blkif
->persistent_purge_work
)) {
354 pr_alert_ratelimited(DRV_PFX
"Scheduled work from previous purge is still pending, cannot purge list\n");
358 num_clean
= (xen_blkif_max_pgrants
/ 100) * LRU_PERCENT_CLEAN
;
359 num_clean
= blkif
->persistent_gnt_c
- xen_blkif_max_pgrants
+ num_clean
;
360 num_clean
= min(blkif
->persistent_gnt_c
, num_clean
);
361 if ((num_clean
== 0) ||
362 (num_clean
> (blkif
->persistent_gnt_c
- atomic_read(&blkif
->persistent_gnt_in_use
))))
366 * At this point, we can assure that there will be no calls
367 * to get_persistent_grant (because we are executing this code from
368 * xen_blkif_schedule), there can only be calls to put_persistent_gnt,
369 * which means that the number of currently used grants will go down,
370 * but never up, so we will always be able to remove the requested
376 pr_debug(DRV_PFX
"Going to purge %u persistent grants\n", num_clean
);
378 BUG_ON(!list_empty(&blkif
->persistent_purge_list
));
379 root
= &blkif
->persistent_gnts
;
381 foreach_grant_safe(persistent_gnt
, n
, root
, node
) {
382 BUG_ON(persistent_gnt
->handle
==
383 BLKBACK_INVALID_HANDLE
);
386 clear_bit(PERSISTENT_GNT_WAS_ACTIVE
, persistent_gnt
->flags
);
390 if (test_bit(PERSISTENT_GNT_ACTIVE
, persistent_gnt
->flags
))
393 (test_bit(PERSISTENT_GNT_WAS_ACTIVE
, persistent_gnt
->flags
)))
396 rb_erase(&persistent_gnt
->node
, root
);
397 list_add(&persistent_gnt
->remove_node
,
398 &blkif
->persistent_purge_list
);
399 if (--num_clean
== 0)
403 * If we get here it means we also need to start cleaning
404 * grants that were used since last purge in order to cope
405 * with the requested num
407 if (!scan_used
&& !clean_used
) {
408 pr_debug(DRV_PFX
"Still missing %u purged frames\n", num_clean
);
414 pr_debug(DRV_PFX
"Finished scanning for grants to clean, removing used flag\n");
419 blkif
->persistent_gnt_c
-= (total
- num_clean
);
420 blkif
->vbd
.overflow_max_grants
= 0;
422 /* We can defer this work */
423 schedule_work(&blkif
->persistent_purge_work
);
424 pr_debug(DRV_PFX
"Purged %u/%u\n", (total
- num_clean
), total
);
429 * Retrieve from the 'pending_reqs' a free pending_req structure to be used.
431 static struct pending_req
*alloc_req(struct xen_blkif
*blkif
)
433 struct pending_req
*req
= NULL
;
436 spin_lock_irqsave(&blkif
->pending_free_lock
, flags
);
437 if (!list_empty(&blkif
->pending_free
)) {
438 req
= list_entry(blkif
->pending_free
.next
, struct pending_req
,
440 list_del(&req
->free_list
);
442 spin_unlock_irqrestore(&blkif
->pending_free_lock
, flags
);
447 * Return the 'pending_req' structure back to the freepool. We also
448 * wake up the thread if it was waiting for a free page.
450 static void free_req(struct xen_blkif
*blkif
, struct pending_req
*req
)
455 spin_lock_irqsave(&blkif
->pending_free_lock
, flags
);
456 was_empty
= list_empty(&blkif
->pending_free
);
457 list_add(&req
->free_list
, &blkif
->pending_free
);
458 spin_unlock_irqrestore(&blkif
->pending_free_lock
, flags
);
460 wake_up(&blkif
->pending_free_wq
);
464 * Routines for managing virtual block devices (vbds).
466 static int xen_vbd_translate(struct phys_req
*req
, struct xen_blkif
*blkif
,
469 struct xen_vbd
*vbd
= &blkif
->vbd
;
472 if ((operation
!= READ
) && vbd
->readonly
)
475 if (likely(req
->nr_sects
)) {
476 blkif_sector_t end
= req
->sector_number
+ req
->nr_sects
;
478 if (unlikely(end
< req
->sector_number
))
480 if (unlikely(end
> vbd_sz(vbd
)))
484 req
->dev
= vbd
->pdevice
;
485 req
->bdev
= vbd
->bdev
;
492 static void xen_vbd_resize(struct xen_blkif
*blkif
)
494 struct xen_vbd
*vbd
= &blkif
->vbd
;
495 struct xenbus_transaction xbt
;
497 struct xenbus_device
*dev
= xen_blkbk_xenbus(blkif
->be
);
498 unsigned long long new_size
= vbd_sz(vbd
);
500 pr_info(DRV_PFX
"VBD Resize: Domid: %d, Device: (%d, %d)\n",
501 blkif
->domid
, MAJOR(vbd
->pdevice
), MINOR(vbd
->pdevice
));
502 pr_info(DRV_PFX
"VBD Resize: new size %llu\n", new_size
);
503 vbd
->size
= new_size
;
505 err
= xenbus_transaction_start(&xbt
);
507 pr_warn(DRV_PFX
"Error starting transaction");
510 err
= xenbus_printf(xbt
, dev
->nodename
, "sectors", "%llu",
511 (unsigned long long)vbd_sz(vbd
));
513 pr_warn(DRV_PFX
"Error writing new size");
517 * Write the current state; we will use this to synchronize
518 * the front-end. If the current state is "connected" the
519 * front-end will get the new size information online.
521 err
= xenbus_printf(xbt
, dev
->nodename
, "state", "%d", dev
->state
);
523 pr_warn(DRV_PFX
"Error writing the state");
527 err
= xenbus_transaction_end(xbt
, 0);
531 pr_warn(DRV_PFX
"Error ending transaction");
534 xenbus_transaction_end(xbt
, 1);
538 * Notification from the guest OS.
540 static void blkif_notify_work(struct xen_blkif
*blkif
)
542 blkif
->waiting_reqs
= 1;
546 irqreturn_t
xen_blkif_be_int(int irq
, void *dev_id
)
548 blkif_notify_work(dev_id
);
553 * SCHEDULER FUNCTIONS
556 static void print_stats(struct xen_blkif
*blkif
)
558 pr_info("xen-blkback (%s): oo %3llu | rd %4llu | wr %4llu | f %4llu"
559 " | ds %4llu | pg: %4u/%4d\n",
560 current
->comm
, blkif
->st_oo_req
,
561 blkif
->st_rd_req
, blkif
->st_wr_req
,
562 blkif
->st_f_req
, blkif
->st_ds_req
,
563 blkif
->persistent_gnt_c
,
564 xen_blkif_max_pgrants
);
565 blkif
->st_print
= jiffies
+ msecs_to_jiffies(10 * 1000);
566 blkif
->st_rd_req
= 0;
567 blkif
->st_wr_req
= 0;
568 blkif
->st_oo_req
= 0;
569 blkif
->st_ds_req
= 0;
572 int xen_blkif_schedule(void *arg
)
574 struct xen_blkif
*blkif
= arg
;
575 struct xen_vbd
*vbd
= &blkif
->vbd
;
576 unsigned long timeout
;
579 xen_blkif_get(blkif
);
581 while (!kthread_should_stop()) {
584 if (unlikely(vbd
->size
!= vbd_sz(vbd
)))
585 xen_vbd_resize(blkif
);
587 timeout
= msecs_to_jiffies(LRU_INTERVAL
);
589 timeout
= wait_event_interruptible_timeout(
591 blkif
->waiting_reqs
|| kthread_should_stop(),
595 timeout
= wait_event_interruptible_timeout(
596 blkif
->pending_free_wq
,
597 !list_empty(&blkif
->pending_free
) ||
598 kthread_should_stop(),
603 blkif
->waiting_reqs
= 0;
604 smp_mb(); /* clear flag *before* checking for work */
606 ret
= do_block_io_op(blkif
);
608 blkif
->waiting_reqs
= 1;
610 wait_event_interruptible(blkif
->shutdown_wq
,
611 kthread_should_stop());
614 if (blkif
->vbd
.feature_gnt_persistent
&&
615 time_after(jiffies
, blkif
->next_lru
)) {
616 purge_persistent_gnt(blkif
);
617 blkif
->next_lru
= jiffies
+ msecs_to_jiffies(LRU_INTERVAL
);
620 /* Shrink if we have more than xen_blkif_max_buffer_pages */
621 shrink_free_pagepool(blkif
, xen_blkif_max_buffer_pages
);
623 if (log_stats
&& time_after(jiffies
, blkif
->st_print
))
627 /* Drain pending purge work */
628 flush_work(&blkif
->persistent_purge_work
);
633 blkif
->xenblkd
= NULL
;
634 xen_blkif_put(blkif
);
640 * Remove persistent grants and empty the pool of free pages
642 void xen_blkbk_free_caches(struct xen_blkif
*blkif
)
644 /* Free all persistent grant pages */
645 if (!RB_EMPTY_ROOT(&blkif
->persistent_gnts
))
646 free_persistent_gnts(blkif
, &blkif
->persistent_gnts
,
647 blkif
->persistent_gnt_c
);
649 BUG_ON(!RB_EMPTY_ROOT(&blkif
->persistent_gnts
));
650 blkif
->persistent_gnt_c
= 0;
652 /* Since we are shutting down remove all pages from the buffer */
653 shrink_free_pagepool(blkif
, 0 /* All */);
657 * Unmap the grant references, and also remove the M2P over-rides
658 * used in the 'pending_req'.
660 static void xen_blkbk_unmap(struct xen_blkif
*blkif
,
661 struct grant_page
*pages
[],
664 struct gnttab_unmap_grant_ref unmap
[BLKIF_MAX_SEGMENTS_PER_REQUEST
];
665 struct page
*unmap_pages
[BLKIF_MAX_SEGMENTS_PER_REQUEST
];
666 unsigned int i
, invcount
= 0;
669 for (i
= 0; i
< num
; i
++) {
670 if (pages
[i
]->persistent_gnt
!= NULL
) {
671 put_persistent_gnt(blkif
, pages
[i
]->persistent_gnt
);
674 if (pages
[i
]->handle
== BLKBACK_INVALID_HANDLE
)
676 unmap_pages
[invcount
] = pages
[i
]->page
;
677 gnttab_set_unmap_op(&unmap
[invcount
], vaddr(pages
[i
]->page
),
678 GNTMAP_host_map
, pages
[i
]->handle
);
679 pages
[i
]->handle
= BLKBACK_INVALID_HANDLE
;
680 if (++invcount
== BLKIF_MAX_SEGMENTS_PER_REQUEST
) {
681 ret
= gnttab_unmap_refs(unmap
, NULL
, unmap_pages
,
684 put_free_pages(blkif
, unmap_pages
, invcount
);
689 ret
= gnttab_unmap_refs(unmap
, NULL
, unmap_pages
, invcount
);
691 put_free_pages(blkif
, unmap_pages
, invcount
);
695 static int xen_blkbk_map(struct xen_blkif
*blkif
,
696 struct grant_page
*pages
[],
699 struct gnttab_map_grant_ref map
[BLKIF_MAX_SEGMENTS_PER_REQUEST
];
700 struct page
*pages_to_gnt
[BLKIF_MAX_SEGMENTS_PER_REQUEST
];
701 struct persistent_gnt
*persistent_gnt
= NULL
;
702 phys_addr_t addr
= 0;
703 int i
, seg_idx
, new_map_idx
;
706 int last_map
= 0, map_until
= 0;
707 int use_persistent_gnts
;
709 use_persistent_gnts
= (blkif
->vbd
.feature_gnt_persistent
);
712 * Fill out preq.nr_sects with proper amount of sectors, and setup
713 * assign map[..] with the PFN of the page in our domain with the
714 * corresponding grant reference for each page.
717 for (i
= map_until
; i
< num
; i
++) {
720 if (use_persistent_gnts
)
721 persistent_gnt
= get_persistent_gnt(
725 if (persistent_gnt
) {
727 * We are using persistent grants and
728 * the grant is already mapped
730 pages
[i
]->page
= persistent_gnt
->page
;
731 pages
[i
]->persistent_gnt
= persistent_gnt
;
733 if (get_free_page(blkif
, &pages
[i
]->page
))
735 addr
= vaddr(pages
[i
]->page
);
736 pages_to_gnt
[segs_to_map
] = pages
[i
]->page
;
737 pages
[i
]->persistent_gnt
= NULL
;
738 flags
= GNTMAP_host_map
;
739 if (!use_persistent_gnts
&& ro
)
740 flags
|= GNTMAP_readonly
;
741 gnttab_set_map_op(&map
[segs_to_map
++], addr
,
742 flags
, pages
[i
]->gref
,
746 if (segs_to_map
== BLKIF_MAX_SEGMENTS_PER_REQUEST
)
751 ret
= gnttab_map_refs(map
, NULL
, pages_to_gnt
, segs_to_map
);
756 * Now swizzle the MFN in our domain with the MFN from the other domain
757 * so that when we access vaddr(pending_req,i) it has the contents of
758 * the page from the other domain.
760 for (seg_idx
= last_map
, new_map_idx
= 0; seg_idx
< map_until
; seg_idx
++) {
761 if (!pages
[seg_idx
]->persistent_gnt
) {
762 /* This is a newly mapped grant */
763 BUG_ON(new_map_idx
>= segs_to_map
);
764 if (unlikely(map
[new_map_idx
].status
!= 0)) {
765 pr_debug(DRV_PFX
"invalid buffer -- could not remap it\n");
766 pages
[seg_idx
]->handle
= BLKBACK_INVALID_HANDLE
;
770 pages
[seg_idx
]->handle
= map
[new_map_idx
].handle
;
774 if (use_persistent_gnts
&&
775 blkif
->persistent_gnt_c
< xen_blkif_max_pgrants
) {
777 * We are using persistent grants, the grant is
778 * not mapped but we might have room for it.
780 persistent_gnt
= kmalloc(sizeof(struct persistent_gnt
),
782 if (!persistent_gnt
) {
784 * If we don't have enough memory to
785 * allocate the persistent_gnt struct
786 * map this grant non-persistenly
790 persistent_gnt
->gnt
= map
[new_map_idx
].ref
;
791 persistent_gnt
->handle
= map
[new_map_idx
].handle
;
792 persistent_gnt
->page
= pages
[seg_idx
]->page
;
793 if (add_persistent_gnt(blkif
,
795 kfree(persistent_gnt
);
796 persistent_gnt
= NULL
;
799 pages
[seg_idx
]->persistent_gnt
= persistent_gnt
;
800 pr_debug(DRV_PFX
" grant %u added to the tree of persistent grants, using %u/%u\n",
801 persistent_gnt
->gnt
, blkif
->persistent_gnt_c
,
802 xen_blkif_max_pgrants
);
805 if (use_persistent_gnts
&& !blkif
->vbd
.overflow_max_grants
) {
806 blkif
->vbd
.overflow_max_grants
= 1;
807 pr_debug(DRV_PFX
" domain %u, device %#x is using maximum number of persistent grants\n",
808 blkif
->domid
, blkif
->vbd
.handle
);
811 * We could not map this grant persistently, so use it as
812 * a non-persistent grant.
818 last_map
= map_until
;
819 if (map_until
!= num
)
825 pr_alert(DRV_PFX
"%s: out of memory\n", __func__
);
826 put_free_pages(blkif
, pages_to_gnt
, segs_to_map
);
830 static int xen_blkbk_map_seg(struct pending_req
*pending_req
)
834 rc
= xen_blkbk_map(pending_req
->blkif
, pending_req
->segments
,
835 pending_req
->nr_pages
,
836 (pending_req
->operation
!= BLKIF_OP_READ
));
841 static int xen_blkbk_parse_indirect(struct blkif_request
*req
,
842 struct pending_req
*pending_req
,
843 struct seg_buf seg
[],
844 struct phys_req
*preq
)
846 struct grant_page
**pages
= pending_req
->indirect_pages
;
847 struct xen_blkif
*blkif
= pending_req
->blkif
;
848 int indirect_grefs
, rc
, n
, nseg
, i
;
849 struct blkif_request_segment
*segments
= NULL
;
851 nseg
= pending_req
->nr_pages
;
852 indirect_grefs
= INDIRECT_PAGES(nseg
);
853 BUG_ON(indirect_grefs
> BLKIF_MAX_INDIRECT_PAGES_PER_REQUEST
);
855 for (i
= 0; i
< indirect_grefs
; i
++)
856 pages
[i
]->gref
= req
->u
.indirect
.indirect_grefs
[i
];
858 rc
= xen_blkbk_map(blkif
, pages
, indirect_grefs
, true);
862 for (n
= 0, i
= 0; n
< nseg
; n
++) {
863 if ((n
% SEGS_PER_INDIRECT_FRAME
) == 0) {
864 /* Map indirect segments */
866 kunmap_atomic(segments
);
867 segments
= kmap_atomic(pages
[n
/SEGS_PER_INDIRECT_FRAME
]->page
);
869 i
= n
% SEGS_PER_INDIRECT_FRAME
;
870 pending_req
->segments
[n
]->gref
= segments
[i
].gref
;
871 seg
[n
].nsec
= segments
[i
].last_sect
-
872 segments
[i
].first_sect
+ 1;
873 seg
[n
].offset
= (segments
[i
].first_sect
<< 9);
874 if ((segments
[i
].last_sect
>= (PAGE_SIZE
>> 9)) ||
875 (segments
[i
].last_sect
< segments
[i
].first_sect
)) {
879 preq
->nr_sects
+= seg
[n
].nsec
;
884 kunmap_atomic(segments
);
885 xen_blkbk_unmap(blkif
, pages
, indirect_grefs
);
889 static int dispatch_discard_io(struct xen_blkif
*blkif
,
890 struct blkif_request
*req
)
893 int status
= BLKIF_RSP_OKAY
;
894 struct block_device
*bdev
= blkif
->vbd
.bdev
;
895 unsigned long secure
;
896 struct phys_req preq
;
898 xen_blkif_get(blkif
);
900 preq
.sector_number
= req
->u
.discard
.sector_number
;
901 preq
.nr_sects
= req
->u
.discard
.nr_sectors
;
903 err
= xen_vbd_translate(&preq
, blkif
, WRITE
);
905 pr_warn(DRV_PFX
"access denied: DISCARD [%llu->%llu] on dev=%04x\n",
907 preq
.sector_number
+ preq
.nr_sects
, blkif
->vbd
.pdevice
);
912 secure
= (blkif
->vbd
.discard_secure
&&
913 (req
->u
.discard
.flag
& BLKIF_DISCARD_SECURE
)) ?
914 BLKDEV_DISCARD_SECURE
: 0;
916 err
= blkdev_issue_discard(bdev
, req
->u
.discard
.sector_number
,
917 req
->u
.discard
.nr_sectors
,
920 if (err
== -EOPNOTSUPP
) {
921 pr_debug(DRV_PFX
"discard op failed, not supported\n");
922 status
= BLKIF_RSP_EOPNOTSUPP
;
924 status
= BLKIF_RSP_ERROR
;
926 make_response(blkif
, req
->u
.discard
.id
, req
->operation
, status
);
927 xen_blkif_put(blkif
);
931 static int dispatch_other_io(struct xen_blkif
*blkif
,
932 struct blkif_request
*req
,
933 struct pending_req
*pending_req
)
935 free_req(blkif
, pending_req
);
936 make_response(blkif
, req
->u
.other
.id
, req
->operation
,
937 BLKIF_RSP_EOPNOTSUPP
);
941 static void xen_blk_drain_io(struct xen_blkif
*blkif
)
943 atomic_set(&blkif
->drain
, 1);
945 if (atomic_read(&blkif
->inflight
) == 0)
947 wait_for_completion_interruptible_timeout(
948 &blkif
->drain_complete
, HZ
);
950 if (!atomic_read(&blkif
->drain
))
952 } while (!kthread_should_stop());
953 atomic_set(&blkif
->drain
, 0);
957 * Completion callback on the bio's. Called as bh->b_end_io()
960 static void __end_block_io_op(struct pending_req
*pending_req
, int error
)
962 /* An error fails the entire request. */
963 if ((pending_req
->operation
== BLKIF_OP_FLUSH_DISKCACHE
) &&
964 (error
== -EOPNOTSUPP
)) {
965 pr_debug(DRV_PFX
"flush diskcache op failed, not supported\n");
966 xen_blkbk_flush_diskcache(XBT_NIL
, pending_req
->blkif
->be
, 0);
967 pending_req
->status
= BLKIF_RSP_EOPNOTSUPP
;
968 } else if ((pending_req
->operation
== BLKIF_OP_WRITE_BARRIER
) &&
969 (error
== -EOPNOTSUPP
)) {
970 pr_debug(DRV_PFX
"write barrier op failed, not supported\n");
971 xen_blkbk_barrier(XBT_NIL
, pending_req
->blkif
->be
, 0);
972 pending_req
->status
= BLKIF_RSP_EOPNOTSUPP
;
974 pr_debug(DRV_PFX
"Buffer not up-to-date at end of operation,"
975 " error=%d\n", error
);
976 pending_req
->status
= BLKIF_RSP_ERROR
;
980 * If all of the bio's have completed it is time to unmap
981 * the grant references associated with 'request' and provide
982 * the proper response on the ring.
984 if (atomic_dec_and_test(&pending_req
->pendcnt
)) {
985 struct xen_blkif
*blkif
= pending_req
->blkif
;
987 xen_blkbk_unmap(blkif
,
988 pending_req
->segments
,
989 pending_req
->nr_pages
);
990 make_response(blkif
, pending_req
->id
,
991 pending_req
->operation
, pending_req
->status
);
992 free_req(blkif
, pending_req
);
994 * Make sure the request is freed before releasing blkif,
995 * or there could be a race between free_req and the
996 * cleanup done in xen_blkif_free during shutdown.
998 * NB: The fact that we might try to wake up pending_free_wq
999 * before drain_complete (in case there's a drain going on)
1000 * it's not a problem with our current implementation
1001 * because we can assure there's no thread waiting on
1002 * pending_free_wq if there's a drain going on, but it has
1003 * to be taken into account if the current model is changed.
1005 if (atomic_dec_and_test(&blkif
->inflight
) && atomic_read(&blkif
->drain
)) {
1006 complete(&blkif
->drain_complete
);
1008 xen_blkif_put(blkif
);
1015 static void end_block_io_op(struct bio
*bio
, int error
)
1017 __end_block_io_op(bio
->bi_private
, error
);
1024 * Function to copy the from the ring buffer the 'struct blkif_request'
1025 * (which has the sectors we want, number of them, grant references, etc),
1026 * and transmute it to the block API to hand it over to the proper block disk.
1029 __do_block_io_op(struct xen_blkif
*blkif
)
1031 union blkif_back_rings
*blk_rings
= &blkif
->blk_rings
;
1032 struct blkif_request req
;
1033 struct pending_req
*pending_req
;
1037 rc
= blk_rings
->common
.req_cons
;
1038 rp
= blk_rings
->common
.sring
->req_prod
;
1039 rmb(); /* Ensure we see queued requests up to 'rp'. */
1041 if (RING_REQUEST_PROD_OVERFLOW(&blk_rings
->common
, rp
)) {
1042 rc
= blk_rings
->common
.rsp_prod_pvt
;
1043 pr_warn(DRV_PFX
"Frontend provided bogus ring requests (%d - %d = %d). Halting ring processing on dev=%04x\n",
1044 rp
, rc
, rp
- rc
, blkif
->vbd
.pdevice
);
1049 if (RING_REQUEST_CONS_OVERFLOW(&blk_rings
->common
, rc
))
1052 if (kthread_should_stop()) {
1057 pending_req
= alloc_req(blkif
);
1058 if (NULL
== pending_req
) {
1064 switch (blkif
->blk_protocol
) {
1065 case BLKIF_PROTOCOL_NATIVE
:
1066 memcpy(&req
, RING_GET_REQUEST(&blk_rings
->native
, rc
), sizeof(req
));
1068 case BLKIF_PROTOCOL_X86_32
:
1069 blkif_get_x86_32_req(&req
, RING_GET_REQUEST(&blk_rings
->x86_32
, rc
));
1071 case BLKIF_PROTOCOL_X86_64
:
1072 blkif_get_x86_64_req(&req
, RING_GET_REQUEST(&blk_rings
->x86_64
, rc
));
1077 blk_rings
->common
.req_cons
= ++rc
; /* before make_response() */
1079 /* Apply all sanity checks to /private copy/ of request. */
1082 switch (req
.operation
) {
1084 case BLKIF_OP_WRITE
:
1085 case BLKIF_OP_WRITE_BARRIER
:
1086 case BLKIF_OP_FLUSH_DISKCACHE
:
1087 case BLKIF_OP_INDIRECT
:
1088 if (dispatch_rw_block_io(blkif
, &req
, pending_req
))
1091 case BLKIF_OP_DISCARD
:
1092 free_req(blkif
, pending_req
);
1093 if (dispatch_discard_io(blkif
, &req
))
1097 if (dispatch_other_io(blkif
, &req
, pending_req
))
1102 /* Yield point for this unbounded loop. */
1110 do_block_io_op(struct xen_blkif
*blkif
)
1112 union blkif_back_rings
*blk_rings
= &blkif
->blk_rings
;
1116 more_to_do
= __do_block_io_op(blkif
);
1120 RING_FINAL_CHECK_FOR_REQUESTS(&blk_rings
->common
, more_to_do
);
1121 } while (more_to_do
);
1126 * Transmutation of the 'struct blkif_request' to a proper 'struct bio'
1127 * and call the 'submit_bio' to pass it to the underlying storage.
1129 static int dispatch_rw_block_io(struct xen_blkif
*blkif
,
1130 struct blkif_request
*req
,
1131 struct pending_req
*pending_req
)
1133 struct phys_req preq
;
1134 struct seg_buf
*seg
= pending_req
->seg
;
1136 struct bio
*bio
= NULL
;
1137 struct bio
**biolist
= pending_req
->biolist
;
1140 struct blk_plug plug
;
1142 struct grant_page
**pages
= pending_req
->segments
;
1143 unsigned short req_operation
;
1145 req_operation
= req
->operation
== BLKIF_OP_INDIRECT
?
1146 req
->u
.indirect
.indirect_op
: req
->operation
;
1147 if ((req
->operation
== BLKIF_OP_INDIRECT
) &&
1148 (req_operation
!= BLKIF_OP_READ
) &&
1149 (req_operation
!= BLKIF_OP_WRITE
)) {
1150 pr_debug(DRV_PFX
"Invalid indirect operation (%u)\n",
1155 switch (req_operation
) {
1160 case BLKIF_OP_WRITE
:
1162 operation
= WRITE_ODIRECT
;
1164 case BLKIF_OP_WRITE_BARRIER
:
1166 case BLKIF_OP_FLUSH_DISKCACHE
:
1168 operation
= WRITE_FLUSH
;
1171 operation
= 0; /* make gcc happy */
1176 /* Check that the number of segments is sane. */
1177 nseg
= req
->operation
== BLKIF_OP_INDIRECT
?
1178 req
->u
.indirect
.nr_segments
: req
->u
.rw
.nr_segments
;
1180 if (unlikely(nseg
== 0 && operation
!= WRITE_FLUSH
) ||
1181 unlikely((req
->operation
!= BLKIF_OP_INDIRECT
) &&
1182 (nseg
> BLKIF_MAX_SEGMENTS_PER_REQUEST
)) ||
1183 unlikely((req
->operation
== BLKIF_OP_INDIRECT
) &&
1184 (nseg
> MAX_INDIRECT_SEGMENTS
))) {
1185 pr_debug(DRV_PFX
"Bad number of segments in request (%d)\n",
1187 /* Haven't submitted any bio's yet. */
1193 pending_req
->blkif
= blkif
;
1194 pending_req
->id
= req
->u
.rw
.id
;
1195 pending_req
->operation
= req_operation
;
1196 pending_req
->status
= BLKIF_RSP_OKAY
;
1197 pending_req
->nr_pages
= nseg
;
1199 if (req
->operation
!= BLKIF_OP_INDIRECT
) {
1200 preq
.dev
= req
->u
.rw
.handle
;
1201 preq
.sector_number
= req
->u
.rw
.sector_number
;
1202 for (i
= 0; i
< nseg
; i
++) {
1203 pages
[i
]->gref
= req
->u
.rw
.seg
[i
].gref
;
1204 seg
[i
].nsec
= req
->u
.rw
.seg
[i
].last_sect
-
1205 req
->u
.rw
.seg
[i
].first_sect
+ 1;
1206 seg
[i
].offset
= (req
->u
.rw
.seg
[i
].first_sect
<< 9);
1207 if ((req
->u
.rw
.seg
[i
].last_sect
>= (PAGE_SIZE
>> 9)) ||
1208 (req
->u
.rw
.seg
[i
].last_sect
<
1209 req
->u
.rw
.seg
[i
].first_sect
))
1211 preq
.nr_sects
+= seg
[i
].nsec
;
1214 preq
.dev
= req
->u
.indirect
.handle
;
1215 preq
.sector_number
= req
->u
.indirect
.sector_number
;
1216 if (xen_blkbk_parse_indirect(req
, pending_req
, seg
, &preq
))
1220 if (xen_vbd_translate(&preq
, blkif
, operation
) != 0) {
1221 pr_debug(DRV_PFX
"access denied: %s of [%llu,%llu] on dev=%04x\n",
1222 operation
== READ
? "read" : "write",
1224 preq
.sector_number
+ preq
.nr_sects
,
1225 blkif
->vbd
.pdevice
);
1230 * This check _MUST_ be done after xen_vbd_translate as the preq.bdev
1233 for (i
= 0; i
< nseg
; i
++) {
1234 if (((int)preq
.sector_number
|(int)seg
[i
].nsec
) &
1235 ((bdev_logical_block_size(preq
.bdev
) >> 9) - 1)) {
1236 pr_debug(DRV_PFX
"Misaligned I/O request from domain %d",
1242 /* Wait on all outstanding I/O's and once that has been completed
1243 * issue the WRITE_FLUSH.
1246 xen_blk_drain_io(pending_req
->blkif
);
1249 * If we have failed at this point, we need to undo the M2P override,
1250 * set gnttab_set_unmap_op on all of the grant references and perform
1251 * the hypercall to unmap the grants - that is all done in
1254 if (xen_blkbk_map_seg(pending_req
))
1258 * This corresponding xen_blkif_put is done in __end_block_io_op, or
1259 * below (in "!bio") if we are handling a BLKIF_OP_DISCARD.
1261 xen_blkif_get(blkif
);
1262 atomic_inc(&blkif
->inflight
);
1264 for (i
= 0; i
< nseg
; i
++) {
1265 while ((bio
== NULL
) ||
1269 seg
[i
].offset
) == 0)) {
1271 int nr_iovecs
= min_t(int, (nseg
-i
), BIO_MAX_PAGES
);
1272 bio
= bio_alloc(GFP_KERNEL
, nr_iovecs
);
1273 if (unlikely(bio
== NULL
))
1276 biolist
[nbio
++] = bio
;
1277 bio
->bi_bdev
= preq
.bdev
;
1278 bio
->bi_private
= pending_req
;
1279 bio
->bi_end_io
= end_block_io_op
;
1280 bio
->bi_iter
.bi_sector
= preq
.sector_number
;
1283 preq
.sector_number
+= seg
[i
].nsec
;
1286 /* This will be hit if the operation was a flush or discard. */
1288 BUG_ON(operation
!= WRITE_FLUSH
);
1290 bio
= bio_alloc(GFP_KERNEL
, 0);
1291 if (unlikely(bio
== NULL
))
1294 biolist
[nbio
++] = bio
;
1295 bio
->bi_bdev
= preq
.bdev
;
1296 bio
->bi_private
= pending_req
;
1297 bio
->bi_end_io
= end_block_io_op
;
1300 atomic_set(&pending_req
->pendcnt
, nbio
);
1301 blk_start_plug(&plug
);
1303 for (i
= 0; i
< nbio
; i
++)
1304 submit_bio(operation
, biolist
[i
]);
1306 /* Let the I/Os go.. */
1307 blk_finish_plug(&plug
);
1309 if (operation
== READ
)
1310 blkif
->st_rd_sect
+= preq
.nr_sects
;
1311 else if (operation
& WRITE
)
1312 blkif
->st_wr_sect
+= preq
.nr_sects
;
1317 xen_blkbk_unmap(blkif
, pending_req
->segments
,
1318 pending_req
->nr_pages
);
1320 /* Haven't submitted any bio's yet. */
1321 make_response(blkif
, req
->u
.rw
.id
, req_operation
, BLKIF_RSP_ERROR
);
1322 free_req(blkif
, pending_req
);
1323 msleep(1); /* back off a bit */
1327 for (i
= 0; i
< nbio
; i
++)
1328 bio_put(biolist
[i
]);
1329 atomic_set(&pending_req
->pendcnt
, 1);
1330 __end_block_io_op(pending_req
, -EINVAL
);
1331 msleep(1); /* back off a bit */
1338 * Put a response on the ring on how the operation fared.
1340 static void make_response(struct xen_blkif
*blkif
, u64 id
,
1341 unsigned short op
, int st
)
1343 struct blkif_response resp
;
1344 unsigned long flags
;
1345 union blkif_back_rings
*blk_rings
= &blkif
->blk_rings
;
1349 resp
.operation
= op
;
1352 spin_lock_irqsave(&blkif
->blk_ring_lock
, flags
);
1353 /* Place on the response ring for the relevant domain. */
1354 switch (blkif
->blk_protocol
) {
1355 case BLKIF_PROTOCOL_NATIVE
:
1356 memcpy(RING_GET_RESPONSE(&blk_rings
->native
, blk_rings
->native
.rsp_prod_pvt
),
1357 &resp
, sizeof(resp
));
1359 case BLKIF_PROTOCOL_X86_32
:
1360 memcpy(RING_GET_RESPONSE(&blk_rings
->x86_32
, blk_rings
->x86_32
.rsp_prod_pvt
),
1361 &resp
, sizeof(resp
));
1363 case BLKIF_PROTOCOL_X86_64
:
1364 memcpy(RING_GET_RESPONSE(&blk_rings
->x86_64
, blk_rings
->x86_64
.rsp_prod_pvt
),
1365 &resp
, sizeof(resp
));
1370 blk_rings
->common
.rsp_prod_pvt
++;
1371 RING_PUSH_RESPONSES_AND_CHECK_NOTIFY(&blk_rings
->common
, notify
);
1372 spin_unlock_irqrestore(&blkif
->blk_ring_lock
, flags
);
1374 notify_remote_via_irq(blkif
->irq
);
1377 static int __init
xen_blkif_init(void)
1384 rc
= xen_blkif_interface_init();
1388 rc
= xen_blkif_xenbus_init();
1396 module_init(xen_blkif_init
);
1398 MODULE_LICENSE("Dual BSD/GPL");
1399 MODULE_ALIAS("xen-backend:vbd");