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/module.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>
47 #include <xen/interface/xen.h>
49 #include <xen/grant_table.h>
50 #include <xen/interface/memory.h>
51 #include <xen/hvc-console.h>
52 #include <xen/swiotlb-xen.h>
53 #include <asm/xen/hypercall.h>
54 #include <asm/xen/interface.h>
56 #include <asm/pgtable.h>
57 #include <asm/sync_bitops.h>
59 /* External tools reserve first few grant table entries. */
60 #define NR_RESERVED_ENTRIES 8
61 #define GNTTAB_LIST_END 0xffffffff
63 static grant_ref_t **gnttab_list;
64 static unsigned int nr_grant_frames;
65 static int gnttab_free_count;
66 static grant_ref_t gnttab_free_head;
67 static DEFINE_SPINLOCK(gnttab_list_lock);
68 struct grant_frames xen_auto_xlat_grant_frames;
71 struct grant_entry_v1 *v1;
72 union grant_entry_v2 *v2;
76 /*This is a structure of function pointers for grant table*/
79 * Mapping a list of frames for storing grant entries. Frames parameter
80 * is used to store grant table address when grant table being setup,
81 * nr_gframes is the number of frames to map grant table. Returning
82 * GNTST_okay means success and negative value means failure.
84 int (*map_frames)(xen_pfn_t *frames, unsigned int nr_gframes);
86 * Release a list of frames which are mapped in map_frames for grant
89 void (*unmap_frames)(void);
91 * Introducing a valid entry into the grant table, granting the frame of
92 * this grant entry to domain for accessing or transfering. Ref
93 * parameter is reference of this introduced grant entry, domid is id of
94 * granted domain, frame is the page frame to be granted, and flags is
95 * status of the grant entry to be updated.
97 void (*update_entry)(grant_ref_t ref, domid_t domid,
98 unsigned long frame, unsigned flags);
100 * Stop granting a grant entry to domain for accessing. Ref parameter is
101 * reference of a grant entry whose grant access will be stopped,
102 * readonly is not in use in this function. If the grant entry is
103 * currently mapped for reading or writing, just return failure(==0)
104 * directly and don't tear down the grant access. Otherwise, stop grant
105 * access for this entry and return success(==1).
107 int (*end_foreign_access_ref)(grant_ref_t ref, int readonly);
109 * Stop granting a grant entry to domain for transfer. Ref parameter is
110 * reference of a grant entry whose grant transfer will be stopped. If
111 * tranfer has not started, just reclaim the grant entry and return
112 * failure(==0). Otherwise, wait for the transfer to complete and then
115 unsigned long (*end_foreign_transfer_ref)(grant_ref_t ref);
117 * Query the status of a grant entry. Ref parameter is reference of
118 * queried grant entry, return value is the status of queried entry.
119 * Detailed status(writing/reading) can be gotten from the return value
122 int (*query_foreign_access)(grant_ref_t ref);
124 * Grant a domain to access a range of bytes within the page referred by
125 * an available grant entry. Ref parameter is reference of a grant entry
126 * which will be sub-page accessed, domid is id of grantee domain, frame
127 * is frame address of subpage grant, flags is grant type and flag
128 * information, page_off is offset of the range of bytes, and length is
129 * length of bytes to be accessed.
131 void (*update_subpage_entry)(grant_ref_t ref, domid_t domid,
132 unsigned long frame, int flags,
133 unsigned page_off, unsigned length);
135 * Redirect an available grant entry on domain A to another grant
136 * reference of domain B, then allow domain C to use grant reference
137 * of domain B transitively. Ref parameter is an available grant entry
138 * reference on domain A, domid is id of domain C which accesses grant
139 * entry transitively, flags is grant type and flag information,
140 * trans_domid is id of domain B whose grant entry is finally accessed
141 * transitively, trans_gref is grant entry transitive reference of
144 void (*update_trans_entry)(grant_ref_t ref, domid_t domid, int flags,
145 domid_t trans_domid, grant_ref_t trans_gref);
148 static 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 int grant_table_version;
154 static int grefs_per_grant_frame;
156 static struct gnttab_free_callback *gnttab_free_callback_list;
158 static int gnttab_expand(unsigned int req_entries);
160 #define RPP (PAGE_SIZE / sizeof(grant_ref_t))
161 #define SPP (PAGE_SIZE / sizeof(grant_status_t))
163 static inline grant_ref_t *__gnttab_entry(grant_ref_t entry)
165 return &gnttab_list[(entry) / RPP][(entry) % RPP];
167 /* This can be used as an l-value */
168 #define gnttab_entry(entry) (*__gnttab_entry(entry))
170 static int get_free_entries(unsigned count)
176 spin_lock_irqsave(&gnttab_list_lock, flags);
178 if ((gnttab_free_count < count) &&
179 ((rc = gnttab_expand(count - gnttab_free_count)) < 0)) {
180 spin_unlock_irqrestore(&gnttab_list_lock, flags);
184 ref = head = gnttab_free_head;
185 gnttab_free_count -= count;
187 head = gnttab_entry(head);
188 gnttab_free_head = gnttab_entry(head);
189 gnttab_entry(head) = GNTTAB_LIST_END;
191 spin_unlock_irqrestore(&gnttab_list_lock, flags);
196 static void do_free_callbacks(void)
198 struct gnttab_free_callback *callback, *next;
200 callback = gnttab_free_callback_list;
201 gnttab_free_callback_list = NULL;
203 while (callback != NULL) {
204 next = callback->next;
205 if (gnttab_free_count >= callback->count) {
206 callback->next = NULL;
207 callback->fn(callback->arg);
209 callback->next = gnttab_free_callback_list;
210 gnttab_free_callback_list = callback;
216 static inline void check_free_callbacks(void)
218 if (unlikely(gnttab_free_callback_list))
222 static void put_free_entry(grant_ref_t ref)
225 spin_lock_irqsave(&gnttab_list_lock, flags);
226 gnttab_entry(ref) = gnttab_free_head;
227 gnttab_free_head = ref;
229 check_free_callbacks();
230 spin_unlock_irqrestore(&gnttab_list_lock, flags);
234 * Following applies to gnttab_update_entry_v1 and gnttab_update_entry_v2.
235 * Introducing a valid entry into the grant table:
236 * 1. Write ent->domid.
237 * 2. Write ent->frame:
238 * GTF_permit_access: Frame to which access is permitted.
239 * GTF_accept_transfer: Pseudo-phys frame slot being filled by new
240 * frame, or zero if none.
241 * 3. Write memory barrier (WMB).
242 * 4. Write ent->flags, inc. valid type.
244 static void gnttab_update_entry_v1(grant_ref_t ref, domid_t domid,
245 unsigned long frame, unsigned flags)
247 gnttab_shared.v1[ref].domid = domid;
248 gnttab_shared.v1[ref].frame = frame;
250 gnttab_shared.v1[ref].flags = flags;
253 static void gnttab_update_entry_v2(grant_ref_t ref, domid_t domid,
254 unsigned long frame, unsigned flags)
256 gnttab_shared.v2[ref].hdr.domid = domid;
257 gnttab_shared.v2[ref].full_page.frame = frame;
259 gnttab_shared.v2[ref].hdr.flags = GTF_permit_access | flags;
263 * Public grant-issuing interface functions
265 void gnttab_grant_foreign_access_ref(grant_ref_t ref, domid_t domid,
266 unsigned long frame, int readonly)
268 gnttab_interface->update_entry(ref, domid, frame,
269 GTF_permit_access | (readonly ? GTF_readonly : 0));
271 EXPORT_SYMBOL_GPL(gnttab_grant_foreign_access_ref);
273 int gnttab_grant_foreign_access(domid_t domid, unsigned long frame,
278 ref = get_free_entries(1);
279 if (unlikely(ref < 0))
282 gnttab_grant_foreign_access_ref(ref, domid, frame, readonly);
286 EXPORT_SYMBOL_GPL(gnttab_grant_foreign_access);
288 static void gnttab_update_subpage_entry_v2(grant_ref_t ref, domid_t domid,
289 unsigned long frame, int flags,
290 unsigned page_off, unsigned length)
292 gnttab_shared.v2[ref].sub_page.frame = frame;
293 gnttab_shared.v2[ref].sub_page.page_off = page_off;
294 gnttab_shared.v2[ref].sub_page.length = length;
295 gnttab_shared.v2[ref].hdr.domid = domid;
297 gnttab_shared.v2[ref].hdr.flags =
298 GTF_permit_access | GTF_sub_page | flags;
301 int gnttab_grant_foreign_access_subpage_ref(grant_ref_t ref, domid_t domid,
302 unsigned long frame, int flags,
306 if (flags & (GTF_accept_transfer | GTF_reading |
307 GTF_writing | GTF_transitive))
310 if (gnttab_interface->update_subpage_entry == NULL)
313 gnttab_interface->update_subpage_entry(ref, domid, frame, flags,
318 EXPORT_SYMBOL_GPL(gnttab_grant_foreign_access_subpage_ref);
320 int gnttab_grant_foreign_access_subpage(domid_t domid, unsigned long frame,
321 int flags, unsigned page_off,
326 ref = get_free_entries(1);
327 if (unlikely(ref < 0))
330 rc = gnttab_grant_foreign_access_subpage_ref(ref, domid, frame, flags,
339 EXPORT_SYMBOL_GPL(gnttab_grant_foreign_access_subpage);
341 bool gnttab_subpage_grants_available(void)
343 return gnttab_interface->update_subpage_entry != NULL;
345 EXPORT_SYMBOL_GPL(gnttab_subpage_grants_available);
347 static void gnttab_update_trans_entry_v2(grant_ref_t ref, domid_t domid,
348 int flags, domid_t trans_domid,
349 grant_ref_t trans_gref)
351 gnttab_shared.v2[ref].transitive.trans_domid = trans_domid;
352 gnttab_shared.v2[ref].transitive.gref = trans_gref;
353 gnttab_shared.v2[ref].hdr.domid = domid;
355 gnttab_shared.v2[ref].hdr.flags =
356 GTF_permit_access | GTF_transitive | flags;
359 int gnttab_grant_foreign_access_trans_ref(grant_ref_t ref, domid_t domid,
360 int flags, domid_t trans_domid,
361 grant_ref_t trans_gref)
363 if (flags & (GTF_accept_transfer | GTF_reading |
364 GTF_writing | GTF_sub_page))
367 if (gnttab_interface->update_trans_entry == NULL)
370 gnttab_interface->update_trans_entry(ref, domid, flags, trans_domid,
375 EXPORT_SYMBOL_GPL(gnttab_grant_foreign_access_trans_ref);
377 int gnttab_grant_foreign_access_trans(domid_t domid, int flags,
379 grant_ref_t trans_gref)
383 ref = get_free_entries(1);
384 if (unlikely(ref < 0))
387 rc = gnttab_grant_foreign_access_trans_ref(ref, domid, flags,
388 trans_domid, trans_gref);
396 EXPORT_SYMBOL_GPL(gnttab_grant_foreign_access_trans);
398 bool gnttab_trans_grants_available(void)
400 return gnttab_interface->update_trans_entry != NULL;
402 EXPORT_SYMBOL_GPL(gnttab_trans_grants_available);
404 static int gnttab_query_foreign_access_v1(grant_ref_t ref)
406 return gnttab_shared.v1[ref].flags & (GTF_reading|GTF_writing);
409 static int gnttab_query_foreign_access_v2(grant_ref_t ref)
411 return grstatus[ref] & (GTF_reading|GTF_writing);
414 int gnttab_query_foreign_access(grant_ref_t ref)
416 return gnttab_interface->query_foreign_access(ref);
418 EXPORT_SYMBOL_GPL(gnttab_query_foreign_access);
420 static int gnttab_end_foreign_access_ref_v1(grant_ref_t ref, int readonly)
425 pflags = &gnttab_shared.v1[ref].flags;
429 if (flags & (GTF_reading|GTF_writing))
431 } while ((nflags = sync_cmpxchg(pflags, flags, 0)) != flags);
436 static int gnttab_end_foreign_access_ref_v2(grant_ref_t ref, int readonly)
438 gnttab_shared.v2[ref].hdr.flags = 0;
440 if (grstatus[ref] & (GTF_reading|GTF_writing)) {
443 /* The read of grstatus needs to have acquire
444 semantics. On x86, reads already have
445 that, and we just need to protect against
446 compiler reorderings. On other
447 architectures we may need a full
459 static inline int _gnttab_end_foreign_access_ref(grant_ref_t ref, int readonly)
461 return gnttab_interface->end_foreign_access_ref(ref, readonly);
464 int gnttab_end_foreign_access_ref(grant_ref_t ref, int readonly)
466 if (_gnttab_end_foreign_access_ref(ref, readonly))
468 pr_warn("WARNING: g.e. %#x still in use!\n", ref);
471 EXPORT_SYMBOL_GPL(gnttab_end_foreign_access_ref);
473 struct deferred_entry {
474 struct list_head list;
480 static LIST_HEAD(deferred_list);
481 static void gnttab_handle_deferred(unsigned long);
482 static DEFINE_TIMER(deferred_timer, gnttab_handle_deferred, 0, 0);
484 static void gnttab_handle_deferred(unsigned long unused)
486 unsigned int nr = 10;
487 struct deferred_entry *first = NULL;
490 spin_lock_irqsave(&gnttab_list_lock, flags);
492 struct deferred_entry *entry
493 = list_first_entry(&deferred_list,
494 struct deferred_entry, list);
498 list_del(&entry->list);
499 spin_unlock_irqrestore(&gnttab_list_lock, flags);
500 if (_gnttab_end_foreign_access_ref(entry->ref, entry->ro)) {
501 put_free_entry(entry->ref);
503 pr_debug("freeing g.e. %#x (pfn %#lx)\n",
504 entry->ref, page_to_pfn(entry->page));
505 __free_page(entry->page);
507 pr_info("freeing g.e. %#x\n", entry->ref);
511 if (!--entry->warn_delay)
512 pr_info("g.e. %#x still pending\n", entry->ref);
516 spin_lock_irqsave(&gnttab_list_lock, flags);
518 list_add_tail(&entry->list, &deferred_list);
519 else if (list_empty(&deferred_list))
522 if (!list_empty(&deferred_list) && !timer_pending(&deferred_timer)) {
523 deferred_timer.expires = jiffies + HZ;
524 add_timer(&deferred_timer);
526 spin_unlock_irqrestore(&gnttab_list_lock, flags);
529 static void gnttab_add_deferred(grant_ref_t ref, bool readonly,
532 struct deferred_entry *entry = kmalloc(sizeof(*entry), GFP_ATOMIC);
533 const char *what = KERN_WARNING "leaking";
539 entry->ro = readonly;
541 entry->warn_delay = 60;
542 spin_lock_irqsave(&gnttab_list_lock, flags);
543 list_add_tail(&entry->list, &deferred_list);
544 if (!timer_pending(&deferred_timer)) {
545 deferred_timer.expires = jiffies + HZ;
546 add_timer(&deferred_timer);
548 spin_unlock_irqrestore(&gnttab_list_lock, flags);
549 what = KERN_DEBUG "deferring";
551 printk("%s g.e. %#x (pfn %#lx)\n",
552 what, ref, page ? page_to_pfn(page) : -1);
555 void gnttab_end_foreign_access(grant_ref_t ref, int readonly,
558 if (gnttab_end_foreign_access_ref(ref, readonly)) {
563 gnttab_add_deferred(ref, readonly,
564 page ? virt_to_page(page) : NULL);
566 EXPORT_SYMBOL_GPL(gnttab_end_foreign_access);
568 int gnttab_grant_foreign_transfer(domid_t domid, unsigned long pfn)
572 ref = get_free_entries(1);
573 if (unlikely(ref < 0))
575 gnttab_grant_foreign_transfer_ref(ref, domid, pfn);
579 EXPORT_SYMBOL_GPL(gnttab_grant_foreign_transfer);
581 void gnttab_grant_foreign_transfer_ref(grant_ref_t ref, domid_t domid,
584 gnttab_interface->update_entry(ref, domid, pfn, GTF_accept_transfer);
586 EXPORT_SYMBOL_GPL(gnttab_grant_foreign_transfer_ref);
588 static unsigned long gnttab_end_foreign_transfer_ref_v1(grant_ref_t ref)
594 pflags = &gnttab_shared.v1[ref].flags;
597 * If a transfer is not even yet started, try to reclaim the grant
598 * reference and return failure (== 0).
600 while (!((flags = *pflags) & GTF_transfer_committed)) {
601 if (sync_cmpxchg(pflags, flags, 0) == flags)
606 /* If a transfer is in progress then wait until it is completed. */
607 while (!(flags & GTF_transfer_completed)) {
612 rmb(); /* Read the frame number /after/ reading completion status. */
613 frame = gnttab_shared.v1[ref].frame;
619 static unsigned long gnttab_end_foreign_transfer_ref_v2(grant_ref_t ref)
625 pflags = &gnttab_shared.v2[ref].hdr.flags;
628 * If a transfer is not even yet started, try to reclaim the grant
629 * reference and return failure (== 0).
631 while (!((flags = *pflags) & GTF_transfer_committed)) {
632 if (sync_cmpxchg(pflags, flags, 0) == flags)
637 /* If a transfer is in progress then wait until it is completed. */
638 while (!(flags & GTF_transfer_completed)) {
643 rmb(); /* Read the frame number /after/ reading completion status. */
644 frame = gnttab_shared.v2[ref].full_page.frame;
650 unsigned long gnttab_end_foreign_transfer_ref(grant_ref_t ref)
652 return gnttab_interface->end_foreign_transfer_ref(ref);
654 EXPORT_SYMBOL_GPL(gnttab_end_foreign_transfer_ref);
656 unsigned long gnttab_end_foreign_transfer(grant_ref_t ref)
658 unsigned long frame = gnttab_end_foreign_transfer_ref(ref);
662 EXPORT_SYMBOL_GPL(gnttab_end_foreign_transfer);
664 void gnttab_free_grant_reference(grant_ref_t ref)
668 EXPORT_SYMBOL_GPL(gnttab_free_grant_reference);
670 void gnttab_free_grant_references(grant_ref_t head)
675 if (head == GNTTAB_LIST_END)
677 spin_lock_irqsave(&gnttab_list_lock, flags);
679 while (gnttab_entry(ref) != GNTTAB_LIST_END) {
680 ref = gnttab_entry(ref);
683 gnttab_entry(ref) = gnttab_free_head;
684 gnttab_free_head = head;
685 gnttab_free_count += count;
686 check_free_callbacks();
687 spin_unlock_irqrestore(&gnttab_list_lock, flags);
689 EXPORT_SYMBOL_GPL(gnttab_free_grant_references);
691 int gnttab_alloc_grant_references(u16 count, grant_ref_t *head)
693 int h = get_free_entries(count);
702 EXPORT_SYMBOL_GPL(gnttab_alloc_grant_references);
704 int gnttab_empty_grant_references(const grant_ref_t *private_head)
706 return (*private_head == GNTTAB_LIST_END);
708 EXPORT_SYMBOL_GPL(gnttab_empty_grant_references);
710 int gnttab_claim_grant_reference(grant_ref_t *private_head)
712 grant_ref_t g = *private_head;
713 if (unlikely(g == GNTTAB_LIST_END))
715 *private_head = gnttab_entry(g);
718 EXPORT_SYMBOL_GPL(gnttab_claim_grant_reference);
720 void gnttab_release_grant_reference(grant_ref_t *private_head,
723 gnttab_entry(release) = *private_head;
724 *private_head = release;
726 EXPORT_SYMBOL_GPL(gnttab_release_grant_reference);
728 void gnttab_request_free_callback(struct gnttab_free_callback *callback,
729 void (*fn)(void *), void *arg, u16 count)
732 struct gnttab_free_callback *cb;
734 spin_lock_irqsave(&gnttab_list_lock, flags);
736 /* Check if the callback is already on the list */
737 cb = gnttab_free_callback_list;
746 callback->count = count;
747 callback->next = gnttab_free_callback_list;
748 gnttab_free_callback_list = callback;
749 check_free_callbacks();
751 spin_unlock_irqrestore(&gnttab_list_lock, flags);
753 EXPORT_SYMBOL_GPL(gnttab_request_free_callback);
755 void gnttab_cancel_free_callback(struct gnttab_free_callback *callback)
757 struct gnttab_free_callback **pcb;
760 spin_lock_irqsave(&gnttab_list_lock, flags);
761 for (pcb = &gnttab_free_callback_list; *pcb; pcb = &(*pcb)->next) {
762 if (*pcb == callback) {
763 *pcb = callback->next;
767 spin_unlock_irqrestore(&gnttab_list_lock, flags);
769 EXPORT_SYMBOL_GPL(gnttab_cancel_free_callback);
771 static int grow_gnttab_list(unsigned int more_frames)
773 unsigned int new_nr_grant_frames, extra_entries, i;
774 unsigned int nr_glist_frames, new_nr_glist_frames;
776 BUG_ON(grefs_per_grant_frame == 0);
778 new_nr_grant_frames = nr_grant_frames + more_frames;
779 extra_entries = more_frames * grefs_per_grant_frame;
781 nr_glist_frames = (nr_grant_frames * grefs_per_grant_frame + RPP - 1) / RPP;
782 new_nr_glist_frames =
783 (new_nr_grant_frames * grefs_per_grant_frame + RPP - 1) / RPP;
784 for (i = nr_glist_frames; i < new_nr_glist_frames; i++) {
785 gnttab_list[i] = (grant_ref_t *)__get_free_page(GFP_ATOMIC);
791 for (i = grefs_per_grant_frame * nr_grant_frames;
792 i < grefs_per_grant_frame * new_nr_grant_frames - 1; i++)
793 gnttab_entry(i) = i + 1;
795 gnttab_entry(i) = gnttab_free_head;
796 gnttab_free_head = grefs_per_grant_frame * nr_grant_frames;
797 gnttab_free_count += extra_entries;
799 nr_grant_frames = new_nr_grant_frames;
801 check_free_callbacks();
806 for ( ; i >= nr_glist_frames; i--)
807 free_page((unsigned long) gnttab_list[i]);
811 static unsigned int __max_nr_grant_frames(void)
813 struct gnttab_query_size query;
816 query.dom = DOMID_SELF;
818 rc = HYPERVISOR_grant_table_op(GNTTABOP_query_size, &query, 1);
819 if ((rc < 0) || (query.status != GNTST_okay))
820 return 4; /* Legacy max supported number of frames */
822 return query.max_nr_frames;
825 unsigned int gnttab_max_grant_frames(void)
827 unsigned int xen_max = __max_nr_grant_frames();
828 static unsigned int boot_max_nr_grant_frames;
830 /* First time, initialize it properly. */
831 if (!boot_max_nr_grant_frames)
832 boot_max_nr_grant_frames = __max_nr_grant_frames();
834 if (xen_max > boot_max_nr_grant_frames)
835 return boot_max_nr_grant_frames;
838 EXPORT_SYMBOL_GPL(gnttab_max_grant_frames);
840 int gnttab_setup_auto_xlat_frames(unsigned long addr)
843 unsigned int max_nr_gframes = __max_nr_grant_frames();
847 if (xen_auto_xlat_grant_frames.count)
850 vaddr = xen_remap(addr, PAGE_SIZE * max_nr_gframes);
852 pr_warn("Failed to ioremap gnttab share frames (addr=0x%08lx)!\n",
856 pfn = kcalloc(max_nr_gframes, sizeof(pfn[0]), GFP_KERNEL);
861 for (i = 0; i < max_nr_gframes; i++)
862 pfn[i] = PFN_DOWN(addr) + i;
864 xen_auto_xlat_grant_frames.vaddr = vaddr;
865 xen_auto_xlat_grant_frames.pfn = pfn;
866 xen_auto_xlat_grant_frames.count = max_nr_gframes;
870 EXPORT_SYMBOL_GPL(gnttab_setup_auto_xlat_frames);
872 void gnttab_free_auto_xlat_frames(void)
874 if (!xen_auto_xlat_grant_frames.count)
876 kfree(xen_auto_xlat_grant_frames.pfn);
877 xen_unmap(xen_auto_xlat_grant_frames.vaddr);
879 xen_auto_xlat_grant_frames.pfn = NULL;
880 xen_auto_xlat_grant_frames.count = 0;
881 xen_auto_xlat_grant_frames.vaddr = NULL;
883 EXPORT_SYMBOL_GPL(gnttab_free_auto_xlat_frames);
885 /* Handling of paged out grant targets (GNTST_eagain) */
886 #define MAX_DELAY 256
888 gnttab_retry_eagain_gop(unsigned int cmd, void *gop, int16_t *status,
894 BUG_ON(HYPERVISOR_grant_table_op(cmd, gop, 1));
895 if (*status == GNTST_eagain)
897 } while ((*status == GNTST_eagain) && (delay < MAX_DELAY));
899 if (delay >= MAX_DELAY) {
900 pr_err("%s: %s eagain grant\n", func, current->comm);
901 *status = GNTST_bad_page;
905 void gnttab_batch_map(struct gnttab_map_grant_ref *batch, unsigned count)
907 struct gnttab_map_grant_ref *op;
909 if (HYPERVISOR_grant_table_op(GNTTABOP_map_grant_ref, batch, count))
911 for (op = batch; op < batch + count; op++)
912 if (op->status == GNTST_eagain)
913 gnttab_retry_eagain_gop(GNTTABOP_map_grant_ref, op,
914 &op->status, __func__);
916 EXPORT_SYMBOL_GPL(gnttab_batch_map);
918 void gnttab_batch_copy(struct gnttab_copy *batch, unsigned count)
920 struct gnttab_copy *op;
922 if (HYPERVISOR_grant_table_op(GNTTABOP_copy, batch, count))
924 for (op = batch; op < batch + count; op++)
925 if (op->status == GNTST_eagain)
926 gnttab_retry_eagain_gop(GNTTABOP_copy, op,
927 &op->status, __func__);
929 EXPORT_SYMBOL_GPL(gnttab_batch_copy);
931 int gnttab_map_refs(struct gnttab_map_grant_ref *map_ops,
932 struct gnttab_map_grant_ref *kmap_ops,
933 struct page **pages, unsigned int count)
940 ret = HYPERVISOR_grant_table_op(GNTTABOP_map_grant_ref, map_ops, count);
944 /* Retry eagain maps */
945 for (i = 0; i < count; i++)
946 if (map_ops[i].status == GNTST_eagain)
947 gnttab_retry_eagain_gop(GNTTABOP_map_grant_ref, map_ops + i,
948 &map_ops[i].status, __func__);
950 /* this is basically a nop on x86 */
951 if (xen_feature(XENFEAT_auto_translated_physmap)) {
952 for (i = 0; i < count; i++) {
953 if (map_ops[i].status)
955 set_phys_to_machine(map_ops[i].host_addr >> PAGE_SHIFT,
956 map_ops[i].dev_bus_addr >> PAGE_SHIFT);
961 if (!in_interrupt() && paravirt_get_lazy_mode() == PARAVIRT_LAZY_NONE) {
962 arch_enter_lazy_mmu_mode();
966 for (i = 0; i < count; i++) {
967 /* Do not add to override if the map failed. */
968 if (map_ops[i].status)
971 if (map_ops[i].flags & GNTMAP_contains_pte) {
972 pte = (pte_t *) (mfn_to_virt(PFN_DOWN(map_ops[i].host_addr)) +
973 (map_ops[i].host_addr & ~PAGE_MASK));
976 mfn = PFN_DOWN(map_ops[i].dev_bus_addr);
978 ret = m2p_add_override(mfn, pages[i], kmap_ops ?
979 &kmap_ops[i] : NULL);
986 arch_leave_lazy_mmu_mode();
990 EXPORT_SYMBOL_GPL(gnttab_map_refs);
992 int gnttab_unmap_refs(struct gnttab_unmap_grant_ref *unmap_ops,
993 struct gnttab_map_grant_ref *kmap_ops,
994 struct page **pages, unsigned int count)
999 ret = HYPERVISOR_grant_table_op(GNTTABOP_unmap_grant_ref, unmap_ops, count);
1003 /* this is basically a nop on x86 */
1004 if (xen_feature(XENFEAT_auto_translated_physmap)) {
1005 for (i = 0; i < count; i++) {
1006 set_phys_to_machine(unmap_ops[i].host_addr >> PAGE_SHIFT,
1012 if (!in_interrupt() && paravirt_get_lazy_mode() == PARAVIRT_LAZY_NONE) {
1013 arch_enter_lazy_mmu_mode();
1017 for (i = 0; i < count; i++) {
1018 ret = m2p_remove_override(pages[i], kmap_ops ?
1019 &kmap_ops[i] : NULL);
1026 arch_leave_lazy_mmu_mode();
1030 EXPORT_SYMBOL_GPL(gnttab_unmap_refs);
1032 static unsigned nr_status_frames(unsigned nr_grant_frames)
1034 BUG_ON(grefs_per_grant_frame == 0);
1035 return (nr_grant_frames * grefs_per_grant_frame + SPP - 1) / SPP;
1038 static int gnttab_map_frames_v1(xen_pfn_t *frames, unsigned int nr_gframes)
1042 rc = arch_gnttab_map_shared(frames, nr_gframes,
1043 gnttab_max_grant_frames(),
1044 &gnttab_shared.addr);
1050 static void gnttab_unmap_frames_v1(void)
1052 arch_gnttab_unmap(gnttab_shared.addr, nr_grant_frames);
1055 static int gnttab_map_frames_v2(xen_pfn_t *frames, unsigned int nr_gframes)
1058 unsigned int nr_sframes;
1059 struct gnttab_get_status_frames getframes;
1062 nr_sframes = nr_status_frames(nr_gframes);
1064 /* No need for kzalloc as it is initialized in following hypercall
1065 * GNTTABOP_get_status_frames.
1067 sframes = kmalloc(nr_sframes * sizeof(uint64_t), GFP_ATOMIC);
1071 getframes.dom = DOMID_SELF;
1072 getframes.nr_frames = nr_sframes;
1073 set_xen_guest_handle(getframes.frame_list, sframes);
1075 rc = HYPERVISOR_grant_table_op(GNTTABOP_get_status_frames,
1077 if (rc == -ENOSYS) {
1082 BUG_ON(rc || getframes.status);
1084 rc = arch_gnttab_map_status(sframes, nr_sframes,
1085 nr_status_frames(gnttab_max_grant_frames()),
1090 rc = arch_gnttab_map_shared(frames, nr_gframes,
1091 gnttab_max_grant_frames(),
1092 &gnttab_shared.addr);
1098 static void gnttab_unmap_frames_v2(void)
1100 arch_gnttab_unmap(gnttab_shared.addr, nr_grant_frames);
1101 arch_gnttab_unmap(grstatus, nr_status_frames(nr_grant_frames));
1104 static int gnttab_map(unsigned int start_idx, unsigned int end_idx)
1106 struct gnttab_setup_table setup;
1108 unsigned int nr_gframes = end_idx + 1;
1111 if (xen_feature(XENFEAT_auto_translated_physmap)) {
1112 struct xen_add_to_physmap xatp;
1113 unsigned int i = end_idx;
1115 BUG_ON(xen_auto_xlat_grant_frames.count < nr_gframes);
1117 * Loop backwards, so that the first hypercall has the largest
1118 * index, ensuring that the table will grow only once.
1121 xatp.domid = DOMID_SELF;
1123 xatp.space = XENMAPSPACE_grant_table;
1124 xatp.gpfn = xen_auto_xlat_grant_frames.pfn[i];
1125 rc = HYPERVISOR_memory_op(XENMEM_add_to_physmap, &xatp);
1127 pr_warn("grant table add_to_physmap failed, err=%d\n",
1131 } while (i-- > start_idx);
1136 /* No need for kzalloc as it is initialized in following hypercall
1137 * GNTTABOP_setup_table.
1139 frames = kmalloc(nr_gframes * sizeof(unsigned long), GFP_ATOMIC);
1143 setup.dom = DOMID_SELF;
1144 setup.nr_frames = nr_gframes;
1145 set_xen_guest_handle(setup.frame_list, frames);
1147 rc = HYPERVISOR_grant_table_op(GNTTABOP_setup_table, &setup, 1);
1148 if (rc == -ENOSYS) {
1153 BUG_ON(rc || setup.status);
1155 rc = gnttab_interface->map_frames(frames, nr_gframes);
1162 static struct gnttab_ops gnttab_v1_ops = {
1163 .map_frames = gnttab_map_frames_v1,
1164 .unmap_frames = gnttab_unmap_frames_v1,
1165 .update_entry = gnttab_update_entry_v1,
1166 .end_foreign_access_ref = gnttab_end_foreign_access_ref_v1,
1167 .end_foreign_transfer_ref = gnttab_end_foreign_transfer_ref_v1,
1168 .query_foreign_access = gnttab_query_foreign_access_v1,
1171 static struct gnttab_ops gnttab_v2_ops = {
1172 .map_frames = gnttab_map_frames_v2,
1173 .unmap_frames = gnttab_unmap_frames_v2,
1174 .update_entry = gnttab_update_entry_v2,
1175 .end_foreign_access_ref = gnttab_end_foreign_access_ref_v2,
1176 .end_foreign_transfer_ref = gnttab_end_foreign_transfer_ref_v2,
1177 .query_foreign_access = gnttab_query_foreign_access_v2,
1178 .update_subpage_entry = gnttab_update_subpage_entry_v2,
1179 .update_trans_entry = gnttab_update_trans_entry_v2,
1182 static void gnttab_request_version(void)
1185 struct gnttab_set_version gsv;
1189 rc = HYPERVISOR_grant_table_op(GNTTABOP_set_version, &gsv, 1);
1190 if (rc == 0 && gsv.version == 2) {
1191 grant_table_version = 2;
1192 grefs_per_grant_frame = PAGE_SIZE / sizeof(union grant_entry_v2);
1193 gnttab_interface = &gnttab_v2_ops;
1194 } else if (grant_table_version == 2) {
1196 * If we've already used version 2 features,
1197 * but then suddenly discover that they're not
1198 * available (e.g. migrating to an older
1199 * version of Xen), almost unbounded badness
1202 panic("we need grant tables version 2, but only version 1 is available");
1204 grant_table_version = 1;
1205 grefs_per_grant_frame = PAGE_SIZE / sizeof(struct grant_entry_v1);
1206 gnttab_interface = &gnttab_v1_ops;
1208 pr_info("Grant tables using version %d layout\n", grant_table_version);
1211 static int gnttab_setup(void)
1213 unsigned int max_nr_gframes;
1215 max_nr_gframes = gnttab_max_grant_frames();
1216 if (max_nr_gframes < nr_grant_frames)
1219 if (xen_feature(XENFEAT_auto_translated_physmap) && gnttab_shared.addr == NULL) {
1220 gnttab_shared.addr = xen_auto_xlat_grant_frames.vaddr;
1221 if (gnttab_shared.addr == NULL) {
1222 pr_warn("gnttab share frames (addr=0x%08lx) is not mapped!\n",
1223 (unsigned long)xen_auto_xlat_grant_frames.vaddr);
1227 return gnttab_map(0, nr_grant_frames - 1);
1230 int gnttab_resume(void)
1232 gnttab_request_version();
1233 return gnttab_setup();
1236 int gnttab_suspend(void)
1238 gnttab_interface->unmap_frames();
1242 static int gnttab_expand(unsigned int req_entries)
1245 unsigned int cur, extra;
1247 BUG_ON(grefs_per_grant_frame == 0);
1248 cur = nr_grant_frames;
1249 extra = ((req_entries + (grefs_per_grant_frame-1)) /
1250 grefs_per_grant_frame);
1251 if (cur + extra > gnttab_max_grant_frames())
1254 rc = gnttab_map(cur, cur + extra - 1);
1256 rc = grow_gnttab_list(extra);
1261 int gnttab_init(void)
1264 unsigned int max_nr_glist_frames, nr_glist_frames;
1265 unsigned int nr_init_grefs;
1268 gnttab_request_version();
1269 nr_grant_frames = 1;
1271 /* Determine the maximum number of frames required for the
1272 * grant reference free list on the current hypervisor.
1274 BUG_ON(grefs_per_grant_frame == 0);
1275 max_nr_glist_frames = (gnttab_max_grant_frames() *
1276 grefs_per_grant_frame / RPP);
1278 gnttab_list = kmalloc(max_nr_glist_frames * sizeof(grant_ref_t *),
1280 if (gnttab_list == NULL)
1283 nr_glist_frames = (nr_grant_frames * grefs_per_grant_frame + RPP - 1) / RPP;
1284 for (i = 0; i < nr_glist_frames; i++) {
1285 gnttab_list[i] = (grant_ref_t *)__get_free_page(GFP_KERNEL);
1286 if (gnttab_list[i] == NULL) {
1292 if (gnttab_setup() < 0) {
1297 nr_init_grefs = nr_grant_frames * grefs_per_grant_frame;
1299 for (i = NR_RESERVED_ENTRIES; i < nr_init_grefs - 1; i++)
1300 gnttab_entry(i) = i + 1;
1302 gnttab_entry(nr_init_grefs - 1) = GNTTAB_LIST_END;
1303 gnttab_free_count = nr_init_grefs - NR_RESERVED_ENTRIES;
1304 gnttab_free_head = NR_RESERVED_ENTRIES;
1306 printk("Grant table initialized\n");
1310 for (i--; i >= 0; i--)
1311 free_page((unsigned long)gnttab_list[i]);
1315 EXPORT_SYMBOL_GPL(gnttab_init);
1317 static int __gnttab_init(void)
1319 /* Delay grant-table initialization in the PV on HVM case */
1320 if (xen_hvm_domain())
1323 if (!xen_pv_domain())
1326 return gnttab_init();
1328 /* Starts after core_initcall so that xen_pvh_gnttab_setup can be called
1329 * beforehand to initialize xen_auto_xlat_grant_frames. */
1330 core_initcall_sync(__gnttab_init);