1 /******************************************************************************
4 * Granting foreign access to our memory reservation.
6 * Copyright (c) 2005-2006, Christopher Clark
7 * Copyright (c) 2004-2005, K A Fraser
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License version 2
11 * as published by the Free Software Foundation; or, when distributed
12 * separately from the Linux kernel or incorporated into other
13 * software packages, subject to the following license:
15 * Permission is hereby granted, free of charge, to any person obtaining a copy
16 * of this source file (the "Software"), to deal in the Software without
17 * restriction, including without limitation the rights to use, copy, modify,
18 * merge, publish, distribute, sublicense, and/or sell copies of the Software,
19 * and to permit persons to whom the Software is furnished to do so, subject to
20 * the following conditions:
22 * The above copyright notice and this permission notice shall be included in
23 * all copies or substantial portions of the Software.
25 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
26 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
27 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
28 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
29 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
30 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
34 #define pr_fmt(fmt) "xen:" KBUILD_MODNAME ": " fmt
36 #include <linux/memblock.h>
37 #include <linux/sched.h>
39 #include <linux/slab.h>
40 #include <linux/vmalloc.h>
41 #include <linux/uaccess.h>
43 #include <linux/delay.h>
44 #include <linux/hardirq.h>
45 #include <linux/workqueue.h>
46 #include <linux/ratelimit.h>
47 #include <linux/moduleparam.h>
48 #ifdef CONFIG_XEN_GRANT_DMA_ALLOC
49 #include <linux/dma-mapping.h>
53 #include <xen/interface/xen.h>
55 #include <xen/grant_table.h>
56 #include <xen/interface/memory.h>
57 #include <xen/hvc-console.h>
58 #include <xen/swiotlb-xen.h>
59 #include <xen/balloon.h>
61 #include <asm/xen/cpuid.h>
63 #include <xen/mem-reservation.h>
64 #include <asm/xen/hypercall.h>
65 #include <asm/xen/interface.h>
67 #include <asm/sync_bitops.h>
69 /* External tools reserve first few grant table entries. */
70 #define NR_RESERVED_ENTRIES 8
71 #define GNTTAB_LIST_END 0xffffffff
73 static grant_ref_t **gnttab_list;
74 static unsigned int nr_grant_frames;
75 static int gnttab_free_count;
76 static grant_ref_t gnttab_free_head;
77 static DEFINE_SPINLOCK(gnttab_list_lock);
78 struct grant_frames xen_auto_xlat_grant_frames;
79 static unsigned int xen_gnttab_version;
80 module_param_named(version, xen_gnttab_version, uint, 0);
83 struct grant_entry_v1 *v1;
84 union grant_entry_v2 *v2;
88 /*This is a structure of function pointers for grant table*/
91 * Version of the grant interface.
95 * Grant refs per grant frame.
97 unsigned int grefs_per_grant_frame;
99 * Mapping a list of frames for storing grant entries. Frames parameter
100 * is used to store grant table address when grant table being setup,
101 * nr_gframes is the number of frames to map grant table. Returning
102 * GNTST_okay means success and negative value means failure.
104 int (*map_frames)(xen_pfn_t *frames, unsigned int nr_gframes);
106 * Release a list of frames which are mapped in map_frames for grant
109 void (*unmap_frames)(void);
111 * Introducing a valid entry into the grant table, granting the frame of
112 * this grant entry to domain for accessing or transfering. Ref
113 * parameter is reference of this introduced grant entry, domid is id of
114 * granted domain, frame is the page frame to be granted, and flags is
115 * status of the grant entry to be updated.
117 void (*update_entry)(grant_ref_t ref, domid_t domid,
118 unsigned long frame, unsigned flags);
120 * Stop granting a grant entry to domain for accessing. Ref parameter is
121 * reference of a grant entry whose grant access will be stopped,
122 * readonly is not in use in this function. If the grant entry is
123 * currently mapped for reading or writing, just return failure(==0)
124 * directly and don't tear down the grant access. Otherwise, stop grant
125 * access for this entry and return success(==1).
127 int (*end_foreign_access_ref)(grant_ref_t ref, int readonly);
129 * Stop granting a grant entry to domain for transfer. Ref parameter is
130 * reference of a grant entry whose grant transfer will be stopped. If
131 * tranfer has not started, just reclaim the grant entry and return
132 * failure(==0). Otherwise, wait for the transfer to complete and then
135 unsigned long (*end_foreign_transfer_ref)(grant_ref_t ref);
137 * Query the status of a grant entry. Ref parameter is reference of
138 * queried grant entry, return value is the status of queried entry.
139 * Detailed status(writing/reading) can be gotten from the return value
142 int (*query_foreign_access)(grant_ref_t ref);
145 struct unmap_refs_callback_data {
146 struct completion completion;
150 static const struct gnttab_ops *gnttab_interface;
152 /* This reflects status of grant entries, so act as a global value. */
153 static grant_status_t *grstatus;
155 static struct gnttab_free_callback *gnttab_free_callback_list;
157 static int gnttab_expand(unsigned int req_entries);
159 #define RPP (PAGE_SIZE / sizeof(grant_ref_t))
160 #define SPP (PAGE_SIZE / sizeof(grant_status_t))
162 static inline grant_ref_t *__gnttab_entry(grant_ref_t entry)
164 return &gnttab_list[(entry) / RPP][(entry) % RPP];
166 /* This can be used as an l-value */
167 #define gnttab_entry(entry) (*__gnttab_entry(entry))
169 static int get_free_entries(unsigned count)
175 spin_lock_irqsave(&gnttab_list_lock, flags);
177 if ((gnttab_free_count < count) &&
178 ((rc = gnttab_expand(count - gnttab_free_count)) < 0)) {
179 spin_unlock_irqrestore(&gnttab_list_lock, flags);
183 ref = head = gnttab_free_head;
184 gnttab_free_count -= count;
186 head = gnttab_entry(head);
187 gnttab_free_head = gnttab_entry(head);
188 gnttab_entry(head) = GNTTAB_LIST_END;
190 spin_unlock_irqrestore(&gnttab_list_lock, flags);
195 static void do_free_callbacks(void)
197 struct gnttab_free_callback *callback, *next;
199 callback = gnttab_free_callback_list;
200 gnttab_free_callback_list = NULL;
202 while (callback != NULL) {
203 next = callback->next;
204 if (gnttab_free_count >= callback->count) {
205 callback->next = NULL;
206 callback->fn(callback->arg);
208 callback->next = gnttab_free_callback_list;
209 gnttab_free_callback_list = callback;
215 static inline void check_free_callbacks(void)
217 if (unlikely(gnttab_free_callback_list))
221 static void put_free_entry(grant_ref_t ref)
224 spin_lock_irqsave(&gnttab_list_lock, flags);
225 gnttab_entry(ref) = gnttab_free_head;
226 gnttab_free_head = ref;
228 check_free_callbacks();
229 spin_unlock_irqrestore(&gnttab_list_lock, flags);
233 * Following applies to gnttab_update_entry_v1 and gnttab_update_entry_v2.
234 * Introducing a valid entry into the grant table:
235 * 1. Write ent->domid.
236 * 2. Write ent->frame:
237 * GTF_permit_access: Frame to which access is permitted.
238 * GTF_accept_transfer: Pseudo-phys frame slot being filled by new
239 * frame, or zero if none.
240 * 3. Write memory barrier (WMB).
241 * 4. Write ent->flags, inc. valid type.
243 static void gnttab_update_entry_v1(grant_ref_t ref, domid_t domid,
244 unsigned long frame, unsigned flags)
246 gnttab_shared.v1[ref].domid = domid;
247 gnttab_shared.v1[ref].frame = frame;
249 gnttab_shared.v1[ref].flags = flags;
252 static void gnttab_update_entry_v2(grant_ref_t ref, domid_t domid,
253 unsigned long frame, unsigned int flags)
255 gnttab_shared.v2[ref].hdr.domid = domid;
256 gnttab_shared.v2[ref].full_page.frame = frame;
257 wmb(); /* Hypervisor concurrent accesses. */
258 gnttab_shared.v2[ref].hdr.flags = GTF_permit_access | flags;
262 * Public grant-issuing interface functions
264 void gnttab_grant_foreign_access_ref(grant_ref_t ref, domid_t domid,
265 unsigned long frame, int readonly)
267 gnttab_interface->update_entry(ref, domid, frame,
268 GTF_permit_access | (readonly ? GTF_readonly : 0));
270 EXPORT_SYMBOL_GPL(gnttab_grant_foreign_access_ref);
272 int gnttab_grant_foreign_access(domid_t domid, unsigned long frame,
277 ref = get_free_entries(1);
278 if (unlikely(ref < 0))
281 gnttab_grant_foreign_access_ref(ref, domid, frame, readonly);
285 EXPORT_SYMBOL_GPL(gnttab_grant_foreign_access);
287 static int gnttab_query_foreign_access_v1(grant_ref_t ref)
289 return gnttab_shared.v1[ref].flags & (GTF_reading|GTF_writing);
292 static int gnttab_query_foreign_access_v2(grant_ref_t ref)
294 return grstatus[ref] & (GTF_reading|GTF_writing);
297 int gnttab_query_foreign_access(grant_ref_t ref)
299 return gnttab_interface->query_foreign_access(ref);
301 EXPORT_SYMBOL_GPL(gnttab_query_foreign_access);
303 static int gnttab_end_foreign_access_ref_v1(grant_ref_t ref, int readonly)
308 pflags = &gnttab_shared.v1[ref].flags;
312 if (flags & (GTF_reading|GTF_writing))
314 } while ((nflags = sync_cmpxchg(pflags, flags, 0)) != flags);
319 static int gnttab_end_foreign_access_ref_v2(grant_ref_t ref, int readonly)
321 gnttab_shared.v2[ref].hdr.flags = 0;
322 mb(); /* Concurrent access by hypervisor. */
323 if (grstatus[ref] & (GTF_reading|GTF_writing)) {
327 * The read of grstatus needs to have acquire semantics.
328 * On x86, reads already have that, and we just need to
329 * protect against compiler reorderings.
330 * On other architectures we may need a full barrier.
342 static inline int _gnttab_end_foreign_access_ref(grant_ref_t ref, int readonly)
344 return gnttab_interface->end_foreign_access_ref(ref, readonly);
347 int gnttab_end_foreign_access_ref(grant_ref_t ref, int readonly)
349 if (_gnttab_end_foreign_access_ref(ref, readonly))
351 pr_warn("WARNING: g.e. %#x still in use!\n", ref);
354 EXPORT_SYMBOL_GPL(gnttab_end_foreign_access_ref);
356 struct deferred_entry {
357 struct list_head list;
363 static LIST_HEAD(deferred_list);
364 static void gnttab_handle_deferred(struct timer_list *);
365 static DEFINE_TIMER(deferred_timer, gnttab_handle_deferred);
367 static void gnttab_handle_deferred(struct timer_list *unused)
369 unsigned int nr = 10;
370 struct deferred_entry *first = NULL;
373 spin_lock_irqsave(&gnttab_list_lock, flags);
375 struct deferred_entry *entry
376 = list_first_entry(&deferred_list,
377 struct deferred_entry, list);
381 list_del(&entry->list);
382 spin_unlock_irqrestore(&gnttab_list_lock, flags);
383 if (_gnttab_end_foreign_access_ref(entry->ref, entry->ro)) {
384 put_free_entry(entry->ref);
386 pr_debug("freeing g.e. %#x (pfn %#lx)\n",
387 entry->ref, page_to_pfn(entry->page));
388 put_page(entry->page);
390 pr_info("freeing g.e. %#x\n", entry->ref);
394 if (!--entry->warn_delay)
395 pr_info("g.e. %#x still pending\n", entry->ref);
399 spin_lock_irqsave(&gnttab_list_lock, flags);
401 list_add_tail(&entry->list, &deferred_list);
402 else if (list_empty(&deferred_list))
405 if (!list_empty(&deferred_list) && !timer_pending(&deferred_timer)) {
406 deferred_timer.expires = jiffies + HZ;
407 add_timer(&deferred_timer);
409 spin_unlock_irqrestore(&gnttab_list_lock, flags);
412 static void gnttab_add_deferred(grant_ref_t ref, bool readonly,
415 struct deferred_entry *entry = kmalloc(sizeof(*entry), GFP_ATOMIC);
416 const char *what = KERN_WARNING "leaking";
422 entry->ro = readonly;
424 entry->warn_delay = 60;
425 spin_lock_irqsave(&gnttab_list_lock, flags);
426 list_add_tail(&entry->list, &deferred_list);
427 if (!timer_pending(&deferred_timer)) {
428 deferred_timer.expires = jiffies + HZ;
429 add_timer(&deferred_timer);
431 spin_unlock_irqrestore(&gnttab_list_lock, flags);
432 what = KERN_DEBUG "deferring";
434 printk("%s g.e. %#x (pfn %#lx)\n",
435 what, ref, page ? page_to_pfn(page) : -1);
438 void gnttab_end_foreign_access(grant_ref_t ref, int readonly,
441 if (gnttab_end_foreign_access_ref(ref, readonly)) {
444 put_page(virt_to_page(page));
446 gnttab_add_deferred(ref, readonly,
447 page ? virt_to_page(page) : NULL);
449 EXPORT_SYMBOL_GPL(gnttab_end_foreign_access);
451 int gnttab_grant_foreign_transfer(domid_t domid, unsigned long pfn)
455 ref = get_free_entries(1);
456 if (unlikely(ref < 0))
458 gnttab_grant_foreign_transfer_ref(ref, domid, pfn);
462 EXPORT_SYMBOL_GPL(gnttab_grant_foreign_transfer);
464 void gnttab_grant_foreign_transfer_ref(grant_ref_t ref, domid_t domid,
467 gnttab_interface->update_entry(ref, domid, pfn, GTF_accept_transfer);
469 EXPORT_SYMBOL_GPL(gnttab_grant_foreign_transfer_ref);
471 static unsigned long gnttab_end_foreign_transfer_ref_v1(grant_ref_t ref)
477 pflags = &gnttab_shared.v1[ref].flags;
480 * If a transfer is not even yet started, try to reclaim the grant
481 * reference and return failure (== 0).
483 while (!((flags = *pflags) & GTF_transfer_committed)) {
484 if (sync_cmpxchg(pflags, flags, 0) == flags)
489 /* If a transfer is in progress then wait until it is completed. */
490 while (!(flags & GTF_transfer_completed)) {
495 rmb(); /* Read the frame number /after/ reading completion status. */
496 frame = gnttab_shared.v1[ref].frame;
502 static unsigned long gnttab_end_foreign_transfer_ref_v2(grant_ref_t ref)
508 pflags = &gnttab_shared.v2[ref].hdr.flags;
511 * If a transfer is not even yet started, try to reclaim the grant
512 * reference and return failure (== 0).
514 while (!((flags = *pflags) & GTF_transfer_committed)) {
515 if (sync_cmpxchg(pflags, flags, 0) == flags)
520 /* If a transfer is in progress then wait until it is completed. */
521 while (!(flags & GTF_transfer_completed)) {
526 rmb(); /* Read the frame number /after/ reading completion status. */
527 frame = gnttab_shared.v2[ref].full_page.frame;
533 unsigned long gnttab_end_foreign_transfer_ref(grant_ref_t ref)
535 return gnttab_interface->end_foreign_transfer_ref(ref);
537 EXPORT_SYMBOL_GPL(gnttab_end_foreign_transfer_ref);
539 unsigned long gnttab_end_foreign_transfer(grant_ref_t ref)
541 unsigned long frame = gnttab_end_foreign_transfer_ref(ref);
545 EXPORT_SYMBOL_GPL(gnttab_end_foreign_transfer);
547 void gnttab_free_grant_reference(grant_ref_t ref)
551 EXPORT_SYMBOL_GPL(gnttab_free_grant_reference);
553 void gnttab_free_grant_references(grant_ref_t head)
558 if (head == GNTTAB_LIST_END)
560 spin_lock_irqsave(&gnttab_list_lock, flags);
562 while (gnttab_entry(ref) != GNTTAB_LIST_END) {
563 ref = gnttab_entry(ref);
566 gnttab_entry(ref) = gnttab_free_head;
567 gnttab_free_head = head;
568 gnttab_free_count += count;
569 check_free_callbacks();
570 spin_unlock_irqrestore(&gnttab_list_lock, flags);
572 EXPORT_SYMBOL_GPL(gnttab_free_grant_references);
574 int gnttab_alloc_grant_references(u16 count, grant_ref_t *head)
576 int h = get_free_entries(count);
585 EXPORT_SYMBOL_GPL(gnttab_alloc_grant_references);
587 int gnttab_empty_grant_references(const grant_ref_t *private_head)
589 return (*private_head == GNTTAB_LIST_END);
591 EXPORT_SYMBOL_GPL(gnttab_empty_grant_references);
593 int gnttab_claim_grant_reference(grant_ref_t *private_head)
595 grant_ref_t g = *private_head;
596 if (unlikely(g == GNTTAB_LIST_END))
598 *private_head = gnttab_entry(g);
601 EXPORT_SYMBOL_GPL(gnttab_claim_grant_reference);
603 void gnttab_release_grant_reference(grant_ref_t *private_head,
606 gnttab_entry(release) = *private_head;
607 *private_head = release;
609 EXPORT_SYMBOL_GPL(gnttab_release_grant_reference);
611 void gnttab_request_free_callback(struct gnttab_free_callback *callback,
612 void (*fn)(void *), void *arg, u16 count)
615 struct gnttab_free_callback *cb;
617 spin_lock_irqsave(&gnttab_list_lock, flags);
619 /* Check if the callback is already on the list */
620 cb = gnttab_free_callback_list;
629 callback->count = count;
630 callback->next = gnttab_free_callback_list;
631 gnttab_free_callback_list = callback;
632 check_free_callbacks();
634 spin_unlock_irqrestore(&gnttab_list_lock, flags);
636 EXPORT_SYMBOL_GPL(gnttab_request_free_callback);
638 void gnttab_cancel_free_callback(struct gnttab_free_callback *callback)
640 struct gnttab_free_callback **pcb;
643 spin_lock_irqsave(&gnttab_list_lock, flags);
644 for (pcb = &gnttab_free_callback_list; *pcb; pcb = &(*pcb)->next) {
645 if (*pcb == callback) {
646 *pcb = callback->next;
650 spin_unlock_irqrestore(&gnttab_list_lock, flags);
652 EXPORT_SYMBOL_GPL(gnttab_cancel_free_callback);
654 static unsigned int gnttab_frames(unsigned int frames, unsigned int align)
656 return (frames * gnttab_interface->grefs_per_grant_frame + align - 1) /
660 static int grow_gnttab_list(unsigned int more_frames)
662 unsigned int new_nr_grant_frames, extra_entries, i;
663 unsigned int nr_glist_frames, new_nr_glist_frames;
664 unsigned int grefs_per_frame;
666 grefs_per_frame = gnttab_interface->grefs_per_grant_frame;
668 new_nr_grant_frames = nr_grant_frames + more_frames;
669 extra_entries = more_frames * grefs_per_frame;
671 nr_glist_frames = gnttab_frames(nr_grant_frames, RPP);
672 new_nr_glist_frames = gnttab_frames(new_nr_grant_frames, RPP);
673 for (i = nr_glist_frames; i < new_nr_glist_frames; i++) {
674 gnttab_list[i] = (grant_ref_t *)__get_free_page(GFP_ATOMIC);
680 for (i = grefs_per_frame * nr_grant_frames;
681 i < grefs_per_frame * new_nr_grant_frames - 1; i++)
682 gnttab_entry(i) = i + 1;
684 gnttab_entry(i) = gnttab_free_head;
685 gnttab_free_head = grefs_per_frame * nr_grant_frames;
686 gnttab_free_count += extra_entries;
688 nr_grant_frames = new_nr_grant_frames;
690 check_free_callbacks();
695 while (i-- > nr_glist_frames)
696 free_page((unsigned long) gnttab_list[i]);
700 static unsigned int __max_nr_grant_frames(void)
702 struct gnttab_query_size query;
705 query.dom = DOMID_SELF;
707 rc = HYPERVISOR_grant_table_op(GNTTABOP_query_size, &query, 1);
708 if ((rc < 0) || (query.status != GNTST_okay))
709 return 4; /* Legacy max supported number of frames */
711 return query.max_nr_frames;
714 unsigned int gnttab_max_grant_frames(void)
716 unsigned int xen_max = __max_nr_grant_frames();
717 static unsigned int boot_max_nr_grant_frames;
719 /* First time, initialize it properly. */
720 if (!boot_max_nr_grant_frames)
721 boot_max_nr_grant_frames = __max_nr_grant_frames();
723 if (xen_max > boot_max_nr_grant_frames)
724 return boot_max_nr_grant_frames;
727 EXPORT_SYMBOL_GPL(gnttab_max_grant_frames);
729 int gnttab_setup_auto_xlat_frames(phys_addr_t addr)
732 unsigned int max_nr_gframes = __max_nr_grant_frames();
736 if (xen_auto_xlat_grant_frames.count)
739 vaddr = xen_remap(addr, XEN_PAGE_SIZE * max_nr_gframes);
741 pr_warn("Failed to ioremap gnttab share frames (addr=%pa)!\n",
745 pfn = kcalloc(max_nr_gframes, sizeof(pfn[0]), GFP_KERNEL);
750 for (i = 0; i < max_nr_gframes; i++)
751 pfn[i] = XEN_PFN_DOWN(addr) + i;
753 xen_auto_xlat_grant_frames.vaddr = vaddr;
754 xen_auto_xlat_grant_frames.pfn = pfn;
755 xen_auto_xlat_grant_frames.count = max_nr_gframes;
759 EXPORT_SYMBOL_GPL(gnttab_setup_auto_xlat_frames);
761 void gnttab_free_auto_xlat_frames(void)
763 if (!xen_auto_xlat_grant_frames.count)
765 kfree(xen_auto_xlat_grant_frames.pfn);
766 xen_unmap(xen_auto_xlat_grant_frames.vaddr);
768 xen_auto_xlat_grant_frames.pfn = NULL;
769 xen_auto_xlat_grant_frames.count = 0;
770 xen_auto_xlat_grant_frames.vaddr = NULL;
772 EXPORT_SYMBOL_GPL(gnttab_free_auto_xlat_frames);
774 int gnttab_pages_set_private(int nr_pages, struct page **pages)
778 for (i = 0; i < nr_pages; i++) {
779 #if BITS_PER_LONG < 64
780 struct xen_page_foreign *foreign;
782 foreign = kzalloc(sizeof(*foreign), GFP_KERNEL);
786 set_page_private(pages[i], (unsigned long)foreign);
788 SetPagePrivate(pages[i]);
793 EXPORT_SYMBOL_GPL(gnttab_pages_set_private);
796 * gnttab_alloc_pages - alloc pages suitable for grant mapping into
797 * @nr_pages: number of pages to alloc
798 * @pages: returns the pages
800 int gnttab_alloc_pages(int nr_pages, struct page **pages)
804 ret = xen_alloc_unpopulated_pages(nr_pages, pages);
808 ret = gnttab_pages_set_private(nr_pages, pages);
810 gnttab_free_pages(nr_pages, pages);
814 EXPORT_SYMBOL_GPL(gnttab_alloc_pages);
816 void gnttab_page_cache_init(struct gnttab_page_cache *cache)
818 spin_lock_init(&cache->lock);
819 INIT_LIST_HEAD(&cache->pages);
820 cache->num_pages = 0;
822 EXPORT_SYMBOL_GPL(gnttab_page_cache_init);
824 int gnttab_page_cache_get(struct gnttab_page_cache *cache, struct page **page)
828 spin_lock_irqsave(&cache->lock, flags);
830 if (list_empty(&cache->pages)) {
831 spin_unlock_irqrestore(&cache->lock, flags);
832 return gnttab_alloc_pages(1, page);
835 page[0] = list_first_entry(&cache->pages, struct page, lru);
836 list_del(&page[0]->lru);
839 spin_unlock_irqrestore(&cache->lock, flags);
843 EXPORT_SYMBOL_GPL(gnttab_page_cache_get);
845 void gnttab_page_cache_put(struct gnttab_page_cache *cache, struct page **page,
851 spin_lock_irqsave(&cache->lock, flags);
853 for (i = 0; i < num; i++)
854 list_add(&page[i]->lru, &cache->pages);
855 cache->num_pages += num;
857 spin_unlock_irqrestore(&cache->lock, flags);
859 EXPORT_SYMBOL_GPL(gnttab_page_cache_put);
861 void gnttab_page_cache_shrink(struct gnttab_page_cache *cache, unsigned int num)
863 struct page *page[10];
867 spin_lock_irqsave(&cache->lock, flags);
869 while (cache->num_pages > num) {
870 page[i] = list_first_entry(&cache->pages, struct page, lru);
871 list_del(&page[i]->lru);
873 if (++i == ARRAY_SIZE(page)) {
874 spin_unlock_irqrestore(&cache->lock, flags);
875 gnttab_free_pages(i, page);
877 spin_lock_irqsave(&cache->lock, flags);
881 spin_unlock_irqrestore(&cache->lock, flags);
884 gnttab_free_pages(i, page);
886 EXPORT_SYMBOL_GPL(gnttab_page_cache_shrink);
888 void gnttab_pages_clear_private(int nr_pages, struct page **pages)
892 for (i = 0; i < nr_pages; i++) {
893 if (PagePrivate(pages[i])) {
894 #if BITS_PER_LONG < 64
895 kfree((void *)page_private(pages[i]));
897 ClearPagePrivate(pages[i]);
901 EXPORT_SYMBOL_GPL(gnttab_pages_clear_private);
904 * gnttab_free_pages - free pages allocated by gnttab_alloc_pages()
905 * @nr_pages; number of pages to free
908 void gnttab_free_pages(int nr_pages, struct page **pages)
910 gnttab_pages_clear_private(nr_pages, pages);
911 xen_free_unpopulated_pages(nr_pages, pages);
913 EXPORT_SYMBOL_GPL(gnttab_free_pages);
915 #ifdef CONFIG_XEN_GRANT_DMA_ALLOC
917 * gnttab_dma_alloc_pages - alloc DMAable pages suitable for grant mapping into
918 * @args: arguments to the function
920 int gnttab_dma_alloc_pages(struct gnttab_dma_alloc_args *args)
922 unsigned long pfn, start_pfn;
926 size = args->nr_pages << PAGE_SHIFT;
928 args->vaddr = dma_alloc_coherent(args->dev, size,
930 GFP_KERNEL | __GFP_NOWARN);
932 args->vaddr = dma_alloc_wc(args->dev, size,
934 GFP_KERNEL | __GFP_NOWARN);
936 pr_debug("Failed to allocate DMA buffer of size %zu\n", size);
940 start_pfn = __phys_to_pfn(args->dev_bus_addr);
941 for (pfn = start_pfn, i = 0; pfn < start_pfn + args->nr_pages;
943 struct page *page = pfn_to_page(pfn);
945 args->pages[i] = page;
946 args->frames[i] = xen_page_to_gfn(page);
947 xenmem_reservation_scrub_page(page);
950 xenmem_reservation_va_mapping_reset(args->nr_pages, args->pages);
952 ret = xenmem_reservation_decrease(args->nr_pages, args->frames);
953 if (ret != args->nr_pages) {
954 pr_debug("Failed to decrease reservation for DMA buffer\n");
959 ret = gnttab_pages_set_private(args->nr_pages, args->pages);
966 gnttab_dma_free_pages(args);
969 EXPORT_SYMBOL_GPL(gnttab_dma_alloc_pages);
972 * gnttab_dma_free_pages - free DMAable pages
973 * @args: arguments to the function
975 int gnttab_dma_free_pages(struct gnttab_dma_alloc_args *args)
980 gnttab_pages_clear_private(args->nr_pages, args->pages);
982 for (i = 0; i < args->nr_pages; i++)
983 args->frames[i] = page_to_xen_pfn(args->pages[i]);
985 ret = xenmem_reservation_increase(args->nr_pages, args->frames);
986 if (ret != args->nr_pages) {
987 pr_debug("Failed to increase reservation for DMA buffer\n");
993 xenmem_reservation_va_mapping_update(args->nr_pages, args->pages,
996 size = args->nr_pages << PAGE_SHIFT;
998 dma_free_coherent(args->dev, size,
999 args->vaddr, args->dev_bus_addr);
1001 dma_free_wc(args->dev, size,
1002 args->vaddr, args->dev_bus_addr);
1005 EXPORT_SYMBOL_GPL(gnttab_dma_free_pages);
1008 /* Handling of paged out grant targets (GNTST_eagain) */
1009 #define MAX_DELAY 256
1011 gnttab_retry_eagain_gop(unsigned int cmd, void *gop, int16_t *status,
1017 BUG_ON(HYPERVISOR_grant_table_op(cmd, gop, 1));
1018 if (*status == GNTST_eagain)
1020 } while ((*status == GNTST_eagain) && (delay < MAX_DELAY));
1022 if (delay >= MAX_DELAY) {
1023 pr_err("%s: %s eagain grant\n", func, current->comm);
1024 *status = GNTST_bad_page;
1028 void gnttab_batch_map(struct gnttab_map_grant_ref *batch, unsigned count)
1030 struct gnttab_map_grant_ref *op;
1032 if (HYPERVISOR_grant_table_op(GNTTABOP_map_grant_ref, batch, count))
1034 for (op = batch; op < batch + count; op++)
1035 if (op->status == GNTST_eagain)
1036 gnttab_retry_eagain_gop(GNTTABOP_map_grant_ref, op,
1037 &op->status, __func__);
1039 EXPORT_SYMBOL_GPL(gnttab_batch_map);
1041 void gnttab_batch_copy(struct gnttab_copy *batch, unsigned count)
1043 struct gnttab_copy *op;
1045 if (HYPERVISOR_grant_table_op(GNTTABOP_copy, batch, count))
1047 for (op = batch; op < batch + count; op++)
1048 if (op->status == GNTST_eagain)
1049 gnttab_retry_eagain_gop(GNTTABOP_copy, op,
1050 &op->status, __func__);
1052 EXPORT_SYMBOL_GPL(gnttab_batch_copy);
1054 void gnttab_foreach_grant_in_range(struct page *page,
1055 unsigned int offset,
1060 unsigned int goffset;
1062 unsigned long xen_pfn;
1064 len = min_t(unsigned int, PAGE_SIZE - offset, len);
1065 goffset = xen_offset_in_page(offset);
1067 xen_pfn = page_to_xen_pfn(page) + XEN_PFN_DOWN(offset);
1070 glen = min_t(unsigned int, XEN_PAGE_SIZE - goffset, len);
1071 fn(pfn_to_gfn(xen_pfn), goffset, glen, data);
1078 EXPORT_SYMBOL_GPL(gnttab_foreach_grant_in_range);
1080 void gnttab_foreach_grant(struct page **pages,
1081 unsigned int nr_grefs,
1085 unsigned int goffset = 0;
1086 unsigned long xen_pfn = 0;
1089 for (i = 0; i < nr_grefs; i++) {
1090 if ((i % XEN_PFN_PER_PAGE) == 0) {
1091 xen_pfn = page_to_xen_pfn(pages[i / XEN_PFN_PER_PAGE]);
1095 fn(pfn_to_gfn(xen_pfn), goffset, XEN_PAGE_SIZE, data);
1097 goffset += XEN_PAGE_SIZE;
1102 int gnttab_map_refs(struct gnttab_map_grant_ref *map_ops,
1103 struct gnttab_map_grant_ref *kmap_ops,
1104 struct page **pages, unsigned int count)
1108 ret = HYPERVISOR_grant_table_op(GNTTABOP_map_grant_ref, map_ops, count);
1112 for (i = 0; i < count; i++) {
1113 switch (map_ops[i].status) {
1116 struct xen_page_foreign *foreign;
1118 SetPageForeign(pages[i]);
1119 foreign = xen_page_foreign(pages[i]);
1120 foreign->domid = map_ops[i].dom;
1121 foreign->gref = map_ops[i].ref;
1125 case GNTST_no_device_space:
1126 pr_warn_ratelimited("maptrack limit reached, can't map all guest pages\n");
1130 /* Retry eagain maps */
1131 gnttab_retry_eagain_gop(GNTTABOP_map_grant_ref,
1133 &map_ops[i].status, __func__);
1134 /* Test status in next loop iteration. */
1143 return set_foreign_p2m_mapping(map_ops, kmap_ops, pages, count);
1145 EXPORT_SYMBOL_GPL(gnttab_map_refs);
1147 int gnttab_unmap_refs(struct gnttab_unmap_grant_ref *unmap_ops,
1148 struct gnttab_unmap_grant_ref *kunmap_ops,
1149 struct page **pages, unsigned int count)
1154 ret = HYPERVISOR_grant_table_op(GNTTABOP_unmap_grant_ref, unmap_ops, count);
1158 for (i = 0; i < count; i++)
1159 ClearPageForeign(pages[i]);
1161 return clear_foreign_p2m_mapping(unmap_ops, kunmap_ops, pages, count);
1163 EXPORT_SYMBOL_GPL(gnttab_unmap_refs);
1165 #define GNTTAB_UNMAP_REFS_DELAY 5
1167 static void __gnttab_unmap_refs_async(struct gntab_unmap_queue_data* item);
1169 static void gnttab_unmap_work(struct work_struct *work)
1171 struct gntab_unmap_queue_data
1172 *unmap_data = container_of(work,
1173 struct gntab_unmap_queue_data,
1175 if (unmap_data->age != UINT_MAX)
1177 __gnttab_unmap_refs_async(unmap_data);
1180 static void __gnttab_unmap_refs_async(struct gntab_unmap_queue_data* item)
1185 for (pc = 0; pc < item->count; pc++) {
1186 if (page_count(item->pages[pc]) > 1) {
1187 unsigned long delay = GNTTAB_UNMAP_REFS_DELAY * (item->age + 1);
1188 schedule_delayed_work(&item->gnttab_work,
1189 msecs_to_jiffies(delay));
1194 ret = gnttab_unmap_refs(item->unmap_ops, item->kunmap_ops,
1195 item->pages, item->count);
1196 item->done(ret, item);
1199 void gnttab_unmap_refs_async(struct gntab_unmap_queue_data* item)
1201 INIT_DELAYED_WORK(&item->gnttab_work, gnttab_unmap_work);
1204 __gnttab_unmap_refs_async(item);
1206 EXPORT_SYMBOL_GPL(gnttab_unmap_refs_async);
1208 static void unmap_refs_callback(int result,
1209 struct gntab_unmap_queue_data *data)
1211 struct unmap_refs_callback_data *d = data->data;
1214 complete(&d->completion);
1217 int gnttab_unmap_refs_sync(struct gntab_unmap_queue_data *item)
1219 struct unmap_refs_callback_data data;
1221 init_completion(&data.completion);
1223 item->done = &unmap_refs_callback;
1224 gnttab_unmap_refs_async(item);
1225 wait_for_completion(&data.completion);
1229 EXPORT_SYMBOL_GPL(gnttab_unmap_refs_sync);
1231 static unsigned int nr_status_frames(unsigned int nr_grant_frames)
1233 return gnttab_frames(nr_grant_frames, SPP);
1236 static int gnttab_map_frames_v1(xen_pfn_t *frames, unsigned int nr_gframes)
1240 rc = arch_gnttab_map_shared(frames, nr_gframes,
1241 gnttab_max_grant_frames(),
1242 &gnttab_shared.addr);
1248 static void gnttab_unmap_frames_v1(void)
1250 arch_gnttab_unmap(gnttab_shared.addr, nr_grant_frames);
1253 static int gnttab_map_frames_v2(xen_pfn_t *frames, unsigned int nr_gframes)
1256 unsigned int nr_sframes;
1257 struct gnttab_get_status_frames getframes;
1260 nr_sframes = nr_status_frames(nr_gframes);
1262 /* No need for kzalloc as it is initialized in following hypercall
1263 * GNTTABOP_get_status_frames.
1265 sframes = kmalloc_array(nr_sframes, sizeof(uint64_t), GFP_ATOMIC);
1269 getframes.dom = DOMID_SELF;
1270 getframes.nr_frames = nr_sframes;
1271 set_xen_guest_handle(getframes.frame_list, sframes);
1273 rc = HYPERVISOR_grant_table_op(GNTTABOP_get_status_frames,
1275 if (rc == -ENOSYS) {
1280 BUG_ON(rc || getframes.status);
1282 rc = arch_gnttab_map_status(sframes, nr_sframes,
1283 nr_status_frames(gnttab_max_grant_frames()),
1288 rc = arch_gnttab_map_shared(frames, nr_gframes,
1289 gnttab_max_grant_frames(),
1290 &gnttab_shared.addr);
1296 static void gnttab_unmap_frames_v2(void)
1298 arch_gnttab_unmap(gnttab_shared.addr, nr_grant_frames);
1299 arch_gnttab_unmap(grstatus, nr_status_frames(nr_grant_frames));
1302 static int gnttab_map(unsigned int start_idx, unsigned int end_idx)
1304 struct gnttab_setup_table setup;
1306 unsigned int nr_gframes = end_idx + 1;
1309 if (xen_feature(XENFEAT_auto_translated_physmap)) {
1310 struct xen_add_to_physmap xatp;
1311 unsigned int i = end_idx;
1313 BUG_ON(xen_auto_xlat_grant_frames.count < nr_gframes);
1315 * Loop backwards, so that the first hypercall has the largest
1316 * index, ensuring that the table will grow only once.
1319 xatp.domid = DOMID_SELF;
1321 xatp.space = XENMAPSPACE_grant_table;
1322 xatp.gpfn = xen_auto_xlat_grant_frames.pfn[i];
1323 rc = HYPERVISOR_memory_op(XENMEM_add_to_physmap, &xatp);
1325 pr_warn("grant table add_to_physmap failed, err=%d\n",
1329 } while (i-- > start_idx);
1334 /* No need for kzalloc as it is initialized in following hypercall
1335 * GNTTABOP_setup_table.
1337 frames = kmalloc_array(nr_gframes, sizeof(unsigned long), GFP_ATOMIC);
1341 setup.dom = DOMID_SELF;
1342 setup.nr_frames = nr_gframes;
1343 set_xen_guest_handle(setup.frame_list, frames);
1345 rc = HYPERVISOR_grant_table_op(GNTTABOP_setup_table, &setup, 1);
1346 if (rc == -ENOSYS) {
1351 BUG_ON(rc || setup.status);
1353 rc = gnttab_interface->map_frames(frames, nr_gframes);
1360 static const struct gnttab_ops gnttab_v1_ops = {
1362 .grefs_per_grant_frame = XEN_PAGE_SIZE /
1363 sizeof(struct grant_entry_v1),
1364 .map_frames = gnttab_map_frames_v1,
1365 .unmap_frames = gnttab_unmap_frames_v1,
1366 .update_entry = gnttab_update_entry_v1,
1367 .end_foreign_access_ref = gnttab_end_foreign_access_ref_v1,
1368 .end_foreign_transfer_ref = gnttab_end_foreign_transfer_ref_v1,
1369 .query_foreign_access = gnttab_query_foreign_access_v1,
1372 static const struct gnttab_ops gnttab_v2_ops = {
1374 .grefs_per_grant_frame = XEN_PAGE_SIZE /
1375 sizeof(union grant_entry_v2),
1376 .map_frames = gnttab_map_frames_v2,
1377 .unmap_frames = gnttab_unmap_frames_v2,
1378 .update_entry = gnttab_update_entry_v2,
1379 .end_foreign_access_ref = gnttab_end_foreign_access_ref_v2,
1380 .end_foreign_transfer_ref = gnttab_end_foreign_transfer_ref_v2,
1381 .query_foreign_access = gnttab_query_foreign_access_v2,
1384 static bool gnttab_need_v2(void)
1387 uint32_t base, width;
1389 if (xen_pv_domain()) {
1390 base = xen_cpuid_base();
1391 if (cpuid_eax(base) < 5)
1392 return false; /* Information not available, use V1. */
1393 width = cpuid_ebx(base + 5) &
1394 XEN_CPUID_MACHINE_ADDRESS_WIDTH_MASK;
1395 return width > 32 + PAGE_SHIFT;
1398 return !!(max_possible_pfn >> 32);
1401 static void gnttab_request_version(void)
1404 struct gnttab_set_version gsv;
1406 if (gnttab_need_v2())
1411 /* Boot parameter overrides automatic selection. */
1412 if (xen_gnttab_version >= 1 && xen_gnttab_version <= 2)
1413 gsv.version = xen_gnttab_version;
1415 rc = HYPERVISOR_grant_table_op(GNTTABOP_set_version, &gsv, 1);
1416 if (rc == 0 && gsv.version == 2)
1417 gnttab_interface = &gnttab_v2_ops;
1419 gnttab_interface = &gnttab_v1_ops;
1420 pr_info("Grant tables using version %d layout\n",
1421 gnttab_interface->version);
1424 static int gnttab_setup(void)
1426 unsigned int max_nr_gframes;
1428 max_nr_gframes = gnttab_max_grant_frames();
1429 if (max_nr_gframes < nr_grant_frames)
1432 if (xen_feature(XENFEAT_auto_translated_physmap) && gnttab_shared.addr == NULL) {
1433 gnttab_shared.addr = xen_auto_xlat_grant_frames.vaddr;
1434 if (gnttab_shared.addr == NULL) {
1435 pr_warn("gnttab share frames is not mapped!\n");
1439 return gnttab_map(0, nr_grant_frames - 1);
1442 int gnttab_resume(void)
1444 gnttab_request_version();
1445 return gnttab_setup();
1448 int gnttab_suspend(void)
1450 if (!xen_feature(XENFEAT_auto_translated_physmap))
1451 gnttab_interface->unmap_frames();
1455 static int gnttab_expand(unsigned int req_entries)
1458 unsigned int cur, extra;
1460 cur = nr_grant_frames;
1461 extra = ((req_entries + gnttab_interface->grefs_per_grant_frame - 1) /
1462 gnttab_interface->grefs_per_grant_frame);
1463 if (cur + extra > gnttab_max_grant_frames()) {
1464 pr_warn_ratelimited("xen/grant-table: max_grant_frames reached"
1465 " cur=%u extra=%u limit=%u"
1466 " gnttab_free_count=%u req_entries=%u\n",
1467 cur, extra, gnttab_max_grant_frames(),
1468 gnttab_free_count, req_entries);
1472 rc = gnttab_map(cur, cur + extra - 1);
1474 rc = grow_gnttab_list(extra);
1479 int gnttab_init(void)
1482 unsigned long max_nr_grant_frames;
1483 unsigned int max_nr_glist_frames, nr_glist_frames;
1484 unsigned int nr_init_grefs;
1487 gnttab_request_version();
1488 max_nr_grant_frames = gnttab_max_grant_frames();
1489 nr_grant_frames = 1;
1491 /* Determine the maximum number of frames required for the
1492 * grant reference free list on the current hypervisor.
1494 max_nr_glist_frames = (max_nr_grant_frames *
1495 gnttab_interface->grefs_per_grant_frame / RPP);
1497 gnttab_list = kmalloc_array(max_nr_glist_frames,
1498 sizeof(grant_ref_t *),
1500 if (gnttab_list == NULL)
1503 nr_glist_frames = gnttab_frames(nr_grant_frames, RPP);
1504 for (i = 0; i < nr_glist_frames; i++) {
1505 gnttab_list[i] = (grant_ref_t *)__get_free_page(GFP_KERNEL);
1506 if (gnttab_list[i] == NULL) {
1512 ret = arch_gnttab_init(max_nr_grant_frames,
1513 nr_status_frames(max_nr_grant_frames));
1517 if (gnttab_setup() < 0) {
1522 nr_init_grefs = nr_grant_frames *
1523 gnttab_interface->grefs_per_grant_frame;
1525 for (i = NR_RESERVED_ENTRIES; i < nr_init_grefs - 1; i++)
1526 gnttab_entry(i) = i + 1;
1528 gnttab_entry(nr_init_grefs - 1) = GNTTAB_LIST_END;
1529 gnttab_free_count = nr_init_grefs - NR_RESERVED_ENTRIES;
1530 gnttab_free_head = NR_RESERVED_ENTRIES;
1532 printk("Grant table initialized\n");
1536 for (i--; i >= 0; i--)
1537 free_page((unsigned long)gnttab_list[i]);
1541 EXPORT_SYMBOL_GPL(gnttab_init);
1543 static int __gnttab_init(void)
1548 /* Delay grant-table initialization in the PV on HVM case */
1549 if (xen_hvm_domain() && !xen_pvh_domain())
1552 return gnttab_init();
1554 /* Starts after core_initcall so that xen_pvh_gnttab_setup can be called
1555 * beforehand to initialize xen_auto_xlat_grant_frames. */
1556 core_initcall_sync(__gnttab_init);