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/bootmem.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/pgtable.h>
68 #include <asm/sync_bitops.h>
70 /* External tools reserve first few grant table entries. */
71 #define NR_RESERVED_ENTRIES 8
72 #define GNTTAB_LIST_END 0xffffffff
74 static grant_ref_t **gnttab_list;
75 static unsigned int nr_grant_frames;
76 static int gnttab_free_count;
77 static grant_ref_t gnttab_free_head;
78 static DEFINE_SPINLOCK(gnttab_list_lock);
79 struct grant_frames xen_auto_xlat_grant_frames;
80 static unsigned int xen_gnttab_version;
81 module_param_named(version, xen_gnttab_version, uint, 0);
84 struct grant_entry_v1 *v1;
85 union grant_entry_v2 *v2;
89 /*This is a structure of function pointers for grant table*/
92 * Version of the grant interface.
96 * Grant refs per grant frame.
98 unsigned int grefs_per_grant_frame;
100 * Mapping a list of frames for storing grant entries. Frames parameter
101 * is used to store grant table address when grant table being setup,
102 * nr_gframes is the number of frames to map grant table. Returning
103 * GNTST_okay means success and negative value means failure.
105 int (*map_frames)(xen_pfn_t *frames, unsigned int nr_gframes);
107 * Release a list of frames which are mapped in map_frames for grant
110 void (*unmap_frames)(void);
112 * Introducing a valid entry into the grant table, granting the frame of
113 * this grant entry to domain for accessing or transfering. Ref
114 * parameter is reference of this introduced grant entry, domid is id of
115 * granted domain, frame is the page frame to be granted, and flags is
116 * status of the grant entry to be updated.
118 void (*update_entry)(grant_ref_t ref, domid_t domid,
119 unsigned long frame, unsigned flags);
121 * Stop granting a grant entry to domain for accessing. Ref parameter is
122 * reference of a grant entry whose grant access will be stopped,
123 * readonly is not in use in this function. If the grant entry is
124 * currently mapped for reading or writing, just return failure(==0)
125 * directly and don't tear down the grant access. Otherwise, stop grant
126 * access for this entry and return success(==1).
128 int (*end_foreign_access_ref)(grant_ref_t ref, int readonly);
130 * Stop granting a grant entry to domain for transfer. Ref parameter is
131 * reference of a grant entry whose grant transfer will be stopped. If
132 * tranfer has not started, just reclaim the grant entry and return
133 * failure(==0). Otherwise, wait for the transfer to complete and then
136 unsigned long (*end_foreign_transfer_ref)(grant_ref_t ref);
138 * Read the frame number related to a given grant reference.
140 unsigned long (*read_frame)(grant_ref_t ref);
143 struct unmap_refs_callback_data {
144 struct completion completion;
148 static const struct gnttab_ops *gnttab_interface;
150 /* This reflects status of grant entries, so act as a global value. */
151 static grant_status_t *grstatus;
153 static struct gnttab_free_callback *gnttab_free_callback_list;
155 static int gnttab_expand(unsigned int req_entries);
157 #define RPP (PAGE_SIZE / sizeof(grant_ref_t))
158 #define SPP (PAGE_SIZE / sizeof(grant_status_t))
160 static inline grant_ref_t *__gnttab_entry(grant_ref_t entry)
162 return &gnttab_list[(entry) / RPP][(entry) % RPP];
164 /* This can be used as an l-value */
165 #define gnttab_entry(entry) (*__gnttab_entry(entry))
167 static int get_free_entries(unsigned count)
173 spin_lock_irqsave(&gnttab_list_lock, flags);
175 if ((gnttab_free_count < count) &&
176 ((rc = gnttab_expand(count - gnttab_free_count)) < 0)) {
177 spin_unlock_irqrestore(&gnttab_list_lock, flags);
181 ref = head = gnttab_free_head;
182 gnttab_free_count -= count;
184 head = gnttab_entry(head);
185 gnttab_free_head = gnttab_entry(head);
186 gnttab_entry(head) = GNTTAB_LIST_END;
188 spin_unlock_irqrestore(&gnttab_list_lock, flags);
193 static void do_free_callbacks(void)
195 struct gnttab_free_callback *callback, *next;
197 callback = gnttab_free_callback_list;
198 gnttab_free_callback_list = NULL;
200 while (callback != NULL) {
201 next = callback->next;
202 if (gnttab_free_count >= callback->count) {
203 callback->next = NULL;
204 callback->fn(callback->arg);
206 callback->next = gnttab_free_callback_list;
207 gnttab_free_callback_list = callback;
213 static inline void check_free_callbacks(void)
215 if (unlikely(gnttab_free_callback_list))
219 static void put_free_entry(grant_ref_t ref)
222 spin_lock_irqsave(&gnttab_list_lock, flags);
223 gnttab_entry(ref) = gnttab_free_head;
224 gnttab_free_head = ref;
226 check_free_callbacks();
227 spin_unlock_irqrestore(&gnttab_list_lock, flags);
231 * Following applies to gnttab_update_entry_v1 and gnttab_update_entry_v2.
232 * Introducing a valid entry into the grant table:
233 * 1. Write ent->domid.
234 * 2. Write ent->frame:
235 * GTF_permit_access: Frame to which access is permitted.
236 * GTF_accept_transfer: Pseudo-phys frame slot being filled by new
237 * frame, or zero if none.
238 * 3. Write memory barrier (WMB).
239 * 4. Write ent->flags, inc. valid type.
241 static void gnttab_update_entry_v1(grant_ref_t ref, domid_t domid,
242 unsigned long frame, unsigned flags)
244 gnttab_shared.v1[ref].domid = domid;
245 gnttab_shared.v1[ref].frame = frame;
247 gnttab_shared.v1[ref].flags = flags;
250 static void gnttab_update_entry_v2(grant_ref_t ref, domid_t domid,
251 unsigned long frame, unsigned int flags)
253 gnttab_shared.v2[ref].hdr.domid = domid;
254 gnttab_shared.v2[ref].full_page.frame = frame;
255 wmb(); /* Hypervisor concurrent accesses. */
256 gnttab_shared.v2[ref].hdr.flags = GTF_permit_access | flags;
260 * Public grant-issuing interface functions
262 void gnttab_grant_foreign_access_ref(grant_ref_t ref, domid_t domid,
263 unsigned long frame, int readonly)
265 gnttab_interface->update_entry(ref, domid, frame,
266 GTF_permit_access | (readonly ? GTF_readonly : 0));
268 EXPORT_SYMBOL_GPL(gnttab_grant_foreign_access_ref);
270 int gnttab_grant_foreign_access(domid_t domid, unsigned long frame,
275 ref = get_free_entries(1);
276 if (unlikely(ref < 0))
279 gnttab_grant_foreign_access_ref(ref, domid, frame, readonly);
283 EXPORT_SYMBOL_GPL(gnttab_grant_foreign_access);
285 static int gnttab_end_foreign_access_ref_v1(grant_ref_t ref, int readonly)
290 pflags = &gnttab_shared.v1[ref].flags;
294 if (flags & (GTF_reading|GTF_writing))
296 } while ((nflags = sync_cmpxchg(pflags, flags, 0)) != flags);
301 static int gnttab_end_foreign_access_ref_v2(grant_ref_t ref, int readonly)
303 gnttab_shared.v2[ref].hdr.flags = 0;
304 mb(); /* Concurrent access by hypervisor. */
305 if (grstatus[ref] & (GTF_reading|GTF_writing)) {
309 * The read of grstatus needs to have acquire semantics.
310 * On x86, reads already have that, and we just need to
311 * protect against compiler reorderings.
312 * On other architectures we may need a full barrier.
324 static inline int _gnttab_end_foreign_access_ref(grant_ref_t ref, int readonly)
326 return gnttab_interface->end_foreign_access_ref(ref, readonly);
329 int gnttab_end_foreign_access_ref(grant_ref_t ref, int readonly)
331 if (_gnttab_end_foreign_access_ref(ref, readonly))
333 pr_warn("WARNING: g.e. %#x still in use!\n", ref);
336 EXPORT_SYMBOL_GPL(gnttab_end_foreign_access_ref);
338 static unsigned long gnttab_read_frame_v1(grant_ref_t ref)
340 return gnttab_shared.v1[ref].frame;
343 static unsigned long gnttab_read_frame_v2(grant_ref_t ref)
345 return gnttab_shared.v2[ref].full_page.frame;
348 struct deferred_entry {
349 struct list_head list;
355 static LIST_HEAD(deferred_list);
356 static void gnttab_handle_deferred(struct timer_list *);
357 static DEFINE_TIMER(deferred_timer, gnttab_handle_deferred);
359 static void gnttab_handle_deferred(struct timer_list *unused)
361 unsigned int nr = 10;
362 struct deferred_entry *first = NULL;
365 spin_lock_irqsave(&gnttab_list_lock, flags);
367 struct deferred_entry *entry
368 = list_first_entry(&deferred_list,
369 struct deferred_entry, list);
373 list_del(&entry->list);
374 spin_unlock_irqrestore(&gnttab_list_lock, flags);
375 if (_gnttab_end_foreign_access_ref(entry->ref, entry->ro)) {
376 put_free_entry(entry->ref);
377 pr_debug("freeing g.e. %#x (pfn %#lx)\n",
378 entry->ref, page_to_pfn(entry->page));
379 put_page(entry->page);
383 if (!--entry->warn_delay)
384 pr_info("g.e. %#x still pending\n", entry->ref);
388 spin_lock_irqsave(&gnttab_list_lock, flags);
390 list_add_tail(&entry->list, &deferred_list);
391 else if (list_empty(&deferred_list))
394 if (!list_empty(&deferred_list) && !timer_pending(&deferred_timer)) {
395 deferred_timer.expires = jiffies + HZ;
396 add_timer(&deferred_timer);
398 spin_unlock_irqrestore(&gnttab_list_lock, flags);
401 static void gnttab_add_deferred(grant_ref_t ref, bool readonly,
404 struct deferred_entry *entry;
405 gfp_t gfp = (in_atomic() || irqs_disabled()) ? GFP_ATOMIC : GFP_KERNEL;
406 const char *what = KERN_WARNING "leaking";
408 entry = kmalloc(sizeof(*entry), gfp);
410 unsigned long gfn = gnttab_interface->read_frame(ref);
412 page = pfn_to_page(gfn_to_pfn(gfn));
420 entry->ro = readonly;
422 entry->warn_delay = 60;
423 spin_lock_irqsave(&gnttab_list_lock, flags);
424 list_add_tail(&entry->list, &deferred_list);
425 if (!timer_pending(&deferred_timer)) {
426 deferred_timer.expires = jiffies + HZ;
427 add_timer(&deferred_timer);
429 spin_unlock_irqrestore(&gnttab_list_lock, flags);
430 what = KERN_DEBUG "deferring";
432 printk("%s g.e. %#x (pfn %#lx)\n",
433 what, ref, page ? page_to_pfn(page) : -1);
436 int gnttab_try_end_foreign_access(grant_ref_t ref)
438 int ret = _gnttab_end_foreign_access_ref(ref, 0);
445 EXPORT_SYMBOL_GPL(gnttab_try_end_foreign_access);
447 void gnttab_end_foreign_access(grant_ref_t ref, int readonly,
450 if (gnttab_try_end_foreign_access(ref)) {
452 put_page(virt_to_page(page));
454 gnttab_add_deferred(ref, readonly,
455 page ? virt_to_page(page) : NULL);
457 EXPORT_SYMBOL_GPL(gnttab_end_foreign_access);
459 int gnttab_grant_foreign_transfer(domid_t domid, unsigned long pfn)
463 ref = get_free_entries(1);
464 if (unlikely(ref < 0))
466 gnttab_grant_foreign_transfer_ref(ref, domid, pfn);
470 EXPORT_SYMBOL_GPL(gnttab_grant_foreign_transfer);
472 void gnttab_grant_foreign_transfer_ref(grant_ref_t ref, domid_t domid,
475 gnttab_interface->update_entry(ref, domid, pfn, GTF_accept_transfer);
477 EXPORT_SYMBOL_GPL(gnttab_grant_foreign_transfer_ref);
479 static unsigned long gnttab_end_foreign_transfer_ref_v1(grant_ref_t ref)
485 pflags = &gnttab_shared.v1[ref].flags;
488 * If a transfer is not even yet started, try to reclaim the grant
489 * reference and return failure (== 0).
491 while (!((flags = *pflags) & GTF_transfer_committed)) {
492 if (sync_cmpxchg(pflags, flags, 0) == flags)
497 /* If a transfer is in progress then wait until it is completed. */
498 while (!(flags & GTF_transfer_completed)) {
503 rmb(); /* Read the frame number /after/ reading completion status. */
504 frame = gnttab_shared.v1[ref].frame;
510 static unsigned long gnttab_end_foreign_transfer_ref_v2(grant_ref_t ref)
516 pflags = &gnttab_shared.v2[ref].hdr.flags;
519 * If a transfer is not even yet started, try to reclaim the grant
520 * reference and return failure (== 0).
522 while (!((flags = *pflags) & GTF_transfer_committed)) {
523 if (sync_cmpxchg(pflags, flags, 0) == flags)
528 /* If a transfer is in progress then wait until it is completed. */
529 while (!(flags & GTF_transfer_completed)) {
534 rmb(); /* Read the frame number /after/ reading completion status. */
535 frame = gnttab_shared.v2[ref].full_page.frame;
541 unsigned long gnttab_end_foreign_transfer_ref(grant_ref_t ref)
543 return gnttab_interface->end_foreign_transfer_ref(ref);
545 EXPORT_SYMBOL_GPL(gnttab_end_foreign_transfer_ref);
547 unsigned long gnttab_end_foreign_transfer(grant_ref_t ref)
549 unsigned long frame = gnttab_end_foreign_transfer_ref(ref);
553 EXPORT_SYMBOL_GPL(gnttab_end_foreign_transfer);
555 void gnttab_free_grant_reference(grant_ref_t ref)
559 EXPORT_SYMBOL_GPL(gnttab_free_grant_reference);
561 void gnttab_free_grant_references(grant_ref_t head)
566 if (head == GNTTAB_LIST_END)
568 spin_lock_irqsave(&gnttab_list_lock, flags);
570 while (gnttab_entry(ref) != GNTTAB_LIST_END) {
571 ref = gnttab_entry(ref);
574 gnttab_entry(ref) = gnttab_free_head;
575 gnttab_free_head = head;
576 gnttab_free_count += count;
577 check_free_callbacks();
578 spin_unlock_irqrestore(&gnttab_list_lock, flags);
580 EXPORT_SYMBOL_GPL(gnttab_free_grant_references);
582 int gnttab_alloc_grant_references(u16 count, grant_ref_t *head)
584 int h = get_free_entries(count);
593 EXPORT_SYMBOL_GPL(gnttab_alloc_grant_references);
595 int gnttab_empty_grant_references(const grant_ref_t *private_head)
597 return (*private_head == GNTTAB_LIST_END);
599 EXPORT_SYMBOL_GPL(gnttab_empty_grant_references);
601 int gnttab_claim_grant_reference(grant_ref_t *private_head)
603 grant_ref_t g = *private_head;
604 if (unlikely(g == GNTTAB_LIST_END))
606 *private_head = gnttab_entry(g);
609 EXPORT_SYMBOL_GPL(gnttab_claim_grant_reference);
611 void gnttab_release_grant_reference(grant_ref_t *private_head,
614 gnttab_entry(release) = *private_head;
615 *private_head = release;
617 EXPORT_SYMBOL_GPL(gnttab_release_grant_reference);
619 void gnttab_request_free_callback(struct gnttab_free_callback *callback,
620 void (*fn)(void *), void *arg, u16 count)
623 struct gnttab_free_callback *cb;
625 spin_lock_irqsave(&gnttab_list_lock, flags);
627 /* Check if the callback is already on the list */
628 cb = gnttab_free_callback_list;
637 callback->count = count;
638 callback->next = gnttab_free_callback_list;
639 gnttab_free_callback_list = callback;
640 check_free_callbacks();
642 spin_unlock_irqrestore(&gnttab_list_lock, flags);
644 EXPORT_SYMBOL_GPL(gnttab_request_free_callback);
646 void gnttab_cancel_free_callback(struct gnttab_free_callback *callback)
648 struct gnttab_free_callback **pcb;
651 spin_lock_irqsave(&gnttab_list_lock, flags);
652 for (pcb = &gnttab_free_callback_list; *pcb; pcb = &(*pcb)->next) {
653 if (*pcb == callback) {
654 *pcb = callback->next;
658 spin_unlock_irqrestore(&gnttab_list_lock, flags);
660 EXPORT_SYMBOL_GPL(gnttab_cancel_free_callback);
662 static unsigned int gnttab_frames(unsigned int frames, unsigned int align)
664 return (frames * gnttab_interface->grefs_per_grant_frame + align - 1) /
668 static int grow_gnttab_list(unsigned int more_frames)
670 unsigned int new_nr_grant_frames, extra_entries, i;
671 unsigned int nr_glist_frames, new_nr_glist_frames;
672 unsigned int grefs_per_frame;
674 BUG_ON(gnttab_interface == NULL);
675 grefs_per_frame = gnttab_interface->grefs_per_grant_frame;
677 new_nr_grant_frames = nr_grant_frames + more_frames;
678 extra_entries = more_frames * grefs_per_frame;
680 nr_glist_frames = gnttab_frames(nr_grant_frames, RPP);
681 new_nr_glist_frames = gnttab_frames(new_nr_grant_frames, RPP);
682 for (i = nr_glist_frames; i < new_nr_glist_frames; i++) {
683 gnttab_list[i] = (grant_ref_t *)__get_free_page(GFP_ATOMIC);
689 for (i = grefs_per_frame * nr_grant_frames;
690 i < grefs_per_frame * new_nr_grant_frames - 1; i++)
691 gnttab_entry(i) = i + 1;
693 gnttab_entry(i) = gnttab_free_head;
694 gnttab_free_head = grefs_per_frame * nr_grant_frames;
695 gnttab_free_count += extra_entries;
697 nr_grant_frames = new_nr_grant_frames;
699 check_free_callbacks();
704 while (i-- > nr_glist_frames)
705 free_page((unsigned long) gnttab_list[i]);
709 static unsigned int __max_nr_grant_frames(void)
711 struct gnttab_query_size query;
714 query.dom = DOMID_SELF;
716 rc = HYPERVISOR_grant_table_op(GNTTABOP_query_size, &query, 1);
717 if ((rc < 0) || (query.status != GNTST_okay))
718 return 4; /* Legacy max supported number of frames */
720 return query.max_nr_frames;
723 unsigned int gnttab_max_grant_frames(void)
725 unsigned int xen_max = __max_nr_grant_frames();
726 static unsigned int boot_max_nr_grant_frames;
728 /* First time, initialize it properly. */
729 if (!boot_max_nr_grant_frames)
730 boot_max_nr_grant_frames = __max_nr_grant_frames();
732 if (xen_max > boot_max_nr_grant_frames)
733 return boot_max_nr_grant_frames;
736 EXPORT_SYMBOL_GPL(gnttab_max_grant_frames);
738 int gnttab_setup_auto_xlat_frames(phys_addr_t addr)
741 unsigned int max_nr_gframes = __max_nr_grant_frames();
745 if (xen_auto_xlat_grant_frames.count)
748 vaddr = xen_remap(addr, XEN_PAGE_SIZE * max_nr_gframes);
750 pr_warn("Failed to ioremap gnttab share frames (addr=%pa)!\n",
754 pfn = kcalloc(max_nr_gframes, sizeof(pfn[0]), GFP_KERNEL);
759 for (i = 0; i < max_nr_gframes; i++)
760 pfn[i] = XEN_PFN_DOWN(addr) + i;
762 xen_auto_xlat_grant_frames.vaddr = vaddr;
763 xen_auto_xlat_grant_frames.pfn = pfn;
764 xen_auto_xlat_grant_frames.count = max_nr_gframes;
768 EXPORT_SYMBOL_GPL(gnttab_setup_auto_xlat_frames);
770 void gnttab_free_auto_xlat_frames(void)
772 if (!xen_auto_xlat_grant_frames.count)
774 kfree(xen_auto_xlat_grant_frames.pfn);
775 xen_unmap(xen_auto_xlat_grant_frames.vaddr);
777 xen_auto_xlat_grant_frames.pfn = NULL;
778 xen_auto_xlat_grant_frames.count = 0;
779 xen_auto_xlat_grant_frames.vaddr = NULL;
781 EXPORT_SYMBOL_GPL(gnttab_free_auto_xlat_frames);
783 int gnttab_pages_set_private(int nr_pages, struct page **pages)
787 for (i = 0; i < nr_pages; i++) {
788 #if BITS_PER_LONG < 64
789 struct xen_page_foreign *foreign;
791 foreign = kzalloc(sizeof(*foreign), GFP_KERNEL);
795 set_page_private(pages[i], (unsigned long)foreign);
797 SetPagePrivate(pages[i]);
802 EXPORT_SYMBOL_GPL(gnttab_pages_set_private);
805 * gnttab_alloc_pages - alloc pages suitable for grant mapping into
806 * @nr_pages: number of pages to alloc
807 * @pages: returns the pages
809 int gnttab_alloc_pages(int nr_pages, struct page **pages)
813 ret = alloc_xenballooned_pages(nr_pages, pages);
817 ret = gnttab_pages_set_private(nr_pages, pages);
819 gnttab_free_pages(nr_pages, pages);
823 EXPORT_SYMBOL_GPL(gnttab_alloc_pages);
825 void gnttab_pages_clear_private(int nr_pages, struct page **pages)
829 for (i = 0; i < nr_pages; i++) {
830 if (PagePrivate(pages[i])) {
831 #if BITS_PER_LONG < 64
832 kfree((void *)page_private(pages[i]));
834 ClearPagePrivate(pages[i]);
838 EXPORT_SYMBOL_GPL(gnttab_pages_clear_private);
841 * gnttab_free_pages - free pages allocated by gnttab_alloc_pages()
842 * @nr_pages; number of pages to free
845 void gnttab_free_pages(int nr_pages, struct page **pages)
847 gnttab_pages_clear_private(nr_pages, pages);
848 free_xenballooned_pages(nr_pages, pages);
850 EXPORT_SYMBOL_GPL(gnttab_free_pages);
852 #ifdef CONFIG_XEN_GRANT_DMA_ALLOC
854 * gnttab_dma_alloc_pages - alloc DMAable pages suitable for grant mapping into
855 * @args: arguments to the function
857 int gnttab_dma_alloc_pages(struct gnttab_dma_alloc_args *args)
859 unsigned long pfn, start_pfn;
863 size = args->nr_pages << PAGE_SHIFT;
865 args->vaddr = dma_alloc_coherent(args->dev, size,
867 GFP_KERNEL | __GFP_NOWARN);
869 args->vaddr = dma_alloc_wc(args->dev, size,
871 GFP_KERNEL | __GFP_NOWARN);
873 pr_debug("Failed to allocate DMA buffer of size %zu\n", size);
877 start_pfn = __phys_to_pfn(args->dev_bus_addr);
878 for (pfn = start_pfn, i = 0; pfn < start_pfn + args->nr_pages;
880 struct page *page = pfn_to_page(pfn);
882 args->pages[i] = page;
883 args->frames[i] = xen_page_to_gfn(page);
884 xenmem_reservation_scrub_page(page);
887 xenmem_reservation_va_mapping_reset(args->nr_pages, args->pages);
889 ret = xenmem_reservation_decrease(args->nr_pages, args->frames);
890 if (ret != args->nr_pages) {
891 pr_debug("Failed to decrease reservation for DMA buffer\n");
896 ret = gnttab_pages_set_private(args->nr_pages, args->pages);
903 gnttab_dma_free_pages(args);
906 EXPORT_SYMBOL_GPL(gnttab_dma_alloc_pages);
909 * gnttab_dma_free_pages - free DMAable pages
910 * @args: arguments to the function
912 int gnttab_dma_free_pages(struct gnttab_dma_alloc_args *args)
917 gnttab_pages_clear_private(args->nr_pages, args->pages);
919 for (i = 0; i < args->nr_pages; i++)
920 args->frames[i] = page_to_xen_pfn(args->pages[i]);
922 ret = xenmem_reservation_increase(args->nr_pages, args->frames);
923 if (ret != args->nr_pages) {
924 pr_debug("Failed to increase reservation for DMA buffer\n");
930 xenmem_reservation_va_mapping_update(args->nr_pages, args->pages,
933 size = args->nr_pages << PAGE_SHIFT;
935 dma_free_coherent(args->dev, size,
936 args->vaddr, args->dev_bus_addr);
938 dma_free_wc(args->dev, size,
939 args->vaddr, args->dev_bus_addr);
942 EXPORT_SYMBOL_GPL(gnttab_dma_free_pages);
945 /* Handling of paged out grant targets (GNTST_eagain) */
946 #define MAX_DELAY 256
948 gnttab_retry_eagain_gop(unsigned int cmd, void *gop, int16_t *status,
954 BUG_ON(HYPERVISOR_grant_table_op(cmd, gop, 1));
955 if (*status == GNTST_eagain)
957 } while ((*status == GNTST_eagain) && (delay < MAX_DELAY));
959 if (delay >= MAX_DELAY) {
960 pr_err("%s: %s eagain grant\n", func, current->comm);
961 *status = GNTST_bad_page;
965 void gnttab_batch_map(struct gnttab_map_grant_ref *batch, unsigned count)
967 struct gnttab_map_grant_ref *op;
969 if (HYPERVISOR_grant_table_op(GNTTABOP_map_grant_ref, batch, count))
971 for (op = batch; op < batch + count; op++)
972 if (op->status == GNTST_eagain)
973 gnttab_retry_eagain_gop(GNTTABOP_map_grant_ref, op,
974 &op->status, __func__);
976 EXPORT_SYMBOL_GPL(gnttab_batch_map);
978 void gnttab_batch_copy(struct gnttab_copy *batch, unsigned count)
980 struct gnttab_copy *op;
982 if (HYPERVISOR_grant_table_op(GNTTABOP_copy, batch, count))
984 for (op = batch; op < batch + count; op++)
985 if (op->status == GNTST_eagain)
986 gnttab_retry_eagain_gop(GNTTABOP_copy, op,
987 &op->status, __func__);
989 EXPORT_SYMBOL_GPL(gnttab_batch_copy);
991 void gnttab_foreach_grant_in_range(struct page *page,
997 unsigned int goffset;
999 unsigned long xen_pfn;
1001 len = min_t(unsigned int, PAGE_SIZE - offset, len);
1002 goffset = xen_offset_in_page(offset);
1004 xen_pfn = page_to_xen_pfn(page) + XEN_PFN_DOWN(offset);
1007 glen = min_t(unsigned int, XEN_PAGE_SIZE - goffset, len);
1008 fn(pfn_to_gfn(xen_pfn), goffset, glen, data);
1015 EXPORT_SYMBOL_GPL(gnttab_foreach_grant_in_range);
1017 void gnttab_foreach_grant(struct page **pages,
1018 unsigned int nr_grefs,
1022 unsigned int goffset = 0;
1023 unsigned long xen_pfn = 0;
1026 for (i = 0; i < nr_grefs; i++) {
1027 if ((i % XEN_PFN_PER_PAGE) == 0) {
1028 xen_pfn = page_to_xen_pfn(pages[i / XEN_PFN_PER_PAGE]);
1032 fn(pfn_to_gfn(xen_pfn), goffset, XEN_PAGE_SIZE, data);
1034 goffset += XEN_PAGE_SIZE;
1039 int gnttab_map_refs(struct gnttab_map_grant_ref *map_ops,
1040 struct gnttab_map_grant_ref *kmap_ops,
1041 struct page **pages, unsigned int count)
1045 ret = HYPERVISOR_grant_table_op(GNTTABOP_map_grant_ref, map_ops, count);
1049 for (i = 0; i < count; i++) {
1050 switch (map_ops[i].status) {
1053 struct xen_page_foreign *foreign;
1055 SetPageForeign(pages[i]);
1056 foreign = xen_page_foreign(pages[i]);
1057 foreign->domid = map_ops[i].dom;
1058 foreign->gref = map_ops[i].ref;
1062 case GNTST_no_device_space:
1063 pr_warn_ratelimited("maptrack limit reached, can't map all guest pages\n");
1067 /* Retry eagain maps */
1068 gnttab_retry_eagain_gop(GNTTABOP_map_grant_ref,
1070 &map_ops[i].status, __func__);
1071 /* Test status in next loop iteration. */
1080 return set_foreign_p2m_mapping(map_ops, kmap_ops, pages, count);
1082 EXPORT_SYMBOL_GPL(gnttab_map_refs);
1084 int gnttab_unmap_refs(struct gnttab_unmap_grant_ref *unmap_ops,
1085 struct gnttab_unmap_grant_ref *kunmap_ops,
1086 struct page **pages, unsigned int count)
1091 ret = HYPERVISOR_grant_table_op(GNTTABOP_unmap_grant_ref, unmap_ops, count);
1095 for (i = 0; i < count; i++)
1096 ClearPageForeign(pages[i]);
1098 return clear_foreign_p2m_mapping(unmap_ops, kunmap_ops, pages, count);
1100 EXPORT_SYMBOL_GPL(gnttab_unmap_refs);
1102 #define GNTTAB_UNMAP_REFS_DELAY 5
1104 static void __gnttab_unmap_refs_async(struct gntab_unmap_queue_data* item);
1106 static void gnttab_unmap_work(struct work_struct *work)
1108 struct gntab_unmap_queue_data
1109 *unmap_data = container_of(work,
1110 struct gntab_unmap_queue_data,
1112 if (unmap_data->age != UINT_MAX)
1114 __gnttab_unmap_refs_async(unmap_data);
1117 static void __gnttab_unmap_refs_async(struct gntab_unmap_queue_data* item)
1122 for (pc = 0; pc < item->count; pc++) {
1123 if (page_count(item->pages[pc]) > 1) {
1124 unsigned long delay = GNTTAB_UNMAP_REFS_DELAY * (item->age + 1);
1125 schedule_delayed_work(&item->gnttab_work,
1126 msecs_to_jiffies(delay));
1131 ret = gnttab_unmap_refs(item->unmap_ops, item->kunmap_ops,
1132 item->pages, item->count);
1133 item->done(ret, item);
1136 void gnttab_unmap_refs_async(struct gntab_unmap_queue_data* item)
1138 INIT_DELAYED_WORK(&item->gnttab_work, gnttab_unmap_work);
1141 __gnttab_unmap_refs_async(item);
1143 EXPORT_SYMBOL_GPL(gnttab_unmap_refs_async);
1145 static void unmap_refs_callback(int result,
1146 struct gntab_unmap_queue_data *data)
1148 struct unmap_refs_callback_data *d = data->data;
1151 complete(&d->completion);
1154 int gnttab_unmap_refs_sync(struct gntab_unmap_queue_data *item)
1156 struct unmap_refs_callback_data data;
1158 init_completion(&data.completion);
1160 item->done = &unmap_refs_callback;
1161 gnttab_unmap_refs_async(item);
1162 wait_for_completion(&data.completion);
1166 EXPORT_SYMBOL_GPL(gnttab_unmap_refs_sync);
1168 static unsigned int nr_status_frames(unsigned int nr_grant_frames)
1170 BUG_ON(gnttab_interface == NULL);
1171 return gnttab_frames(nr_grant_frames, SPP);
1174 static int gnttab_map_frames_v1(xen_pfn_t *frames, unsigned int nr_gframes)
1178 rc = arch_gnttab_map_shared(frames, nr_gframes,
1179 gnttab_max_grant_frames(),
1180 &gnttab_shared.addr);
1186 static void gnttab_unmap_frames_v1(void)
1188 arch_gnttab_unmap(gnttab_shared.addr, nr_grant_frames);
1191 static int gnttab_map_frames_v2(xen_pfn_t *frames, unsigned int nr_gframes)
1194 unsigned int nr_sframes;
1195 struct gnttab_get_status_frames getframes;
1198 nr_sframes = nr_status_frames(nr_gframes);
1200 /* No need for kzalloc as it is initialized in following hypercall
1201 * GNTTABOP_get_status_frames.
1203 sframes = kmalloc_array(nr_sframes, sizeof(uint64_t), GFP_ATOMIC);
1207 getframes.dom = DOMID_SELF;
1208 getframes.nr_frames = nr_sframes;
1209 set_xen_guest_handle(getframes.frame_list, sframes);
1211 rc = HYPERVISOR_grant_table_op(GNTTABOP_get_status_frames,
1213 if (rc == -ENOSYS) {
1218 BUG_ON(rc || getframes.status);
1220 rc = arch_gnttab_map_status(sframes, nr_sframes,
1221 nr_status_frames(gnttab_max_grant_frames()),
1226 rc = arch_gnttab_map_shared(frames, nr_gframes,
1227 gnttab_max_grant_frames(),
1228 &gnttab_shared.addr);
1234 static void gnttab_unmap_frames_v2(void)
1236 arch_gnttab_unmap(gnttab_shared.addr, nr_grant_frames);
1237 arch_gnttab_unmap(grstatus, nr_status_frames(nr_grant_frames));
1240 static int gnttab_map(unsigned int start_idx, unsigned int end_idx)
1242 struct gnttab_setup_table setup;
1244 unsigned int nr_gframes = end_idx + 1;
1247 if (xen_feature(XENFEAT_auto_translated_physmap)) {
1248 struct xen_add_to_physmap xatp;
1249 unsigned int i = end_idx;
1251 BUG_ON(xen_auto_xlat_grant_frames.count < nr_gframes);
1253 * Loop backwards, so that the first hypercall has the largest
1254 * index, ensuring that the table will grow only once.
1257 xatp.domid = DOMID_SELF;
1259 xatp.space = XENMAPSPACE_grant_table;
1260 xatp.gpfn = xen_auto_xlat_grant_frames.pfn[i];
1261 rc = HYPERVISOR_memory_op(XENMEM_add_to_physmap, &xatp);
1263 pr_warn("grant table add_to_physmap failed, err=%d\n",
1267 } while (i-- > start_idx);
1272 /* No need for kzalloc as it is initialized in following hypercall
1273 * GNTTABOP_setup_table.
1275 frames = kmalloc_array(nr_gframes, sizeof(unsigned long), GFP_ATOMIC);
1279 setup.dom = DOMID_SELF;
1280 setup.nr_frames = nr_gframes;
1281 set_xen_guest_handle(setup.frame_list, frames);
1283 rc = HYPERVISOR_grant_table_op(GNTTABOP_setup_table, &setup, 1);
1284 if (rc == -ENOSYS) {
1289 BUG_ON(rc || setup.status);
1291 rc = gnttab_interface->map_frames(frames, nr_gframes);
1298 static const struct gnttab_ops gnttab_v1_ops = {
1300 .grefs_per_grant_frame = XEN_PAGE_SIZE /
1301 sizeof(struct grant_entry_v1),
1302 .map_frames = gnttab_map_frames_v1,
1303 .unmap_frames = gnttab_unmap_frames_v1,
1304 .update_entry = gnttab_update_entry_v1,
1305 .end_foreign_access_ref = gnttab_end_foreign_access_ref_v1,
1306 .end_foreign_transfer_ref = gnttab_end_foreign_transfer_ref_v1,
1307 .read_frame = gnttab_read_frame_v1,
1310 static const struct gnttab_ops gnttab_v2_ops = {
1312 .grefs_per_grant_frame = XEN_PAGE_SIZE /
1313 sizeof(union grant_entry_v2),
1314 .map_frames = gnttab_map_frames_v2,
1315 .unmap_frames = gnttab_unmap_frames_v2,
1316 .update_entry = gnttab_update_entry_v2,
1317 .end_foreign_access_ref = gnttab_end_foreign_access_ref_v2,
1318 .end_foreign_transfer_ref = gnttab_end_foreign_transfer_ref_v2,
1319 .read_frame = gnttab_read_frame_v2,
1322 static bool gnttab_need_v2(void)
1325 uint32_t base, width;
1327 if (xen_pv_domain()) {
1328 base = xen_cpuid_base();
1329 if (cpuid_eax(base) < 5)
1330 return false; /* Information not available, use V1. */
1331 width = cpuid_ebx(base + 5) &
1332 XEN_CPUID_MACHINE_ADDRESS_WIDTH_MASK;
1333 return width > 32 + PAGE_SHIFT;
1336 return !!(max_possible_pfn >> 32);
1339 static void gnttab_request_version(void)
1342 struct gnttab_set_version gsv;
1344 if (gnttab_need_v2())
1349 /* Boot parameter overrides automatic selection. */
1350 if (xen_gnttab_version >= 1 && xen_gnttab_version <= 2)
1351 gsv.version = xen_gnttab_version;
1353 rc = HYPERVISOR_grant_table_op(GNTTABOP_set_version, &gsv, 1);
1354 if (rc == 0 && gsv.version == 2)
1355 gnttab_interface = &gnttab_v2_ops;
1357 gnttab_interface = &gnttab_v1_ops;
1358 pr_info("Grant tables using version %d layout\n",
1359 gnttab_interface->version);
1362 static int gnttab_setup(void)
1364 unsigned int max_nr_gframes;
1366 max_nr_gframes = gnttab_max_grant_frames();
1367 if (max_nr_gframes < nr_grant_frames)
1370 if (xen_feature(XENFEAT_auto_translated_physmap) && gnttab_shared.addr == NULL) {
1371 gnttab_shared.addr = xen_auto_xlat_grant_frames.vaddr;
1372 if (gnttab_shared.addr == NULL) {
1373 pr_warn("gnttab share frames (addr=0x%08lx) is not mapped!\n",
1374 (unsigned long)xen_auto_xlat_grant_frames.vaddr);
1378 return gnttab_map(0, nr_grant_frames - 1);
1381 int gnttab_resume(void)
1383 gnttab_request_version();
1384 return gnttab_setup();
1387 int gnttab_suspend(void)
1389 if (!xen_feature(XENFEAT_auto_translated_physmap))
1390 gnttab_interface->unmap_frames();
1394 static int gnttab_expand(unsigned int req_entries)
1397 unsigned int cur, extra;
1399 BUG_ON(gnttab_interface == NULL);
1400 cur = nr_grant_frames;
1401 extra = ((req_entries + gnttab_interface->grefs_per_grant_frame - 1) /
1402 gnttab_interface->grefs_per_grant_frame);
1403 if (cur + extra > gnttab_max_grant_frames()) {
1404 pr_warn_ratelimited("xen/grant-table: max_grant_frames reached"
1405 " cur=%u extra=%u limit=%u"
1406 " gnttab_free_count=%u req_entries=%u\n",
1407 cur, extra, gnttab_max_grant_frames(),
1408 gnttab_free_count, req_entries);
1412 rc = gnttab_map(cur, cur + extra - 1);
1414 rc = grow_gnttab_list(extra);
1419 int gnttab_init(void)
1422 unsigned long max_nr_grant_frames;
1423 unsigned int max_nr_glist_frames, nr_glist_frames;
1424 unsigned int nr_init_grefs;
1427 gnttab_request_version();
1428 max_nr_grant_frames = gnttab_max_grant_frames();
1429 nr_grant_frames = 1;
1431 /* Determine the maximum number of frames required for the
1432 * grant reference free list on the current hypervisor.
1434 BUG_ON(gnttab_interface == NULL);
1435 max_nr_glist_frames = (max_nr_grant_frames *
1436 gnttab_interface->grefs_per_grant_frame / RPP);
1438 gnttab_list = kmalloc_array(max_nr_glist_frames,
1439 sizeof(grant_ref_t *),
1441 if (gnttab_list == NULL)
1444 nr_glist_frames = gnttab_frames(nr_grant_frames, RPP);
1445 for (i = 0; i < nr_glist_frames; i++) {
1446 gnttab_list[i] = (grant_ref_t *)__get_free_page(GFP_KERNEL);
1447 if (gnttab_list[i] == NULL) {
1453 ret = arch_gnttab_init(max_nr_grant_frames,
1454 nr_status_frames(max_nr_grant_frames));
1458 if (gnttab_setup() < 0) {
1463 nr_init_grefs = nr_grant_frames *
1464 gnttab_interface->grefs_per_grant_frame;
1466 for (i = NR_RESERVED_ENTRIES; i < nr_init_grefs - 1; i++)
1467 gnttab_entry(i) = i + 1;
1469 gnttab_entry(nr_init_grefs - 1) = GNTTAB_LIST_END;
1470 gnttab_free_count = nr_init_grefs - NR_RESERVED_ENTRIES;
1471 gnttab_free_head = NR_RESERVED_ENTRIES;
1473 printk("Grant table initialized\n");
1477 for (i--; i >= 0; i--)
1478 free_page((unsigned long)gnttab_list[i]);
1482 EXPORT_SYMBOL_GPL(gnttab_init);
1484 static int __gnttab_init(void)
1489 /* Delay grant-table initialization in the PV on HVM case */
1490 if (xen_hvm_domain() && !xen_pvh_domain())
1493 return gnttab_init();
1495 /* Starts after core_initcall so that xen_pvh_gnttab_setup can be called
1496 * beforehand to initialize xen_auto_xlat_grant_frames. */
1497 core_initcall_sync(__gnttab_init);