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 #include <linux/module.h>
35 #include <linux/sched.h>
37 #include <linux/vmalloc.h>
38 #include <linux/uaccess.h>
41 #include <xen/interface/xen.h>
43 #include <xen/grant_table.h>
44 #include <asm/xen/hypercall.h>
46 #include <asm/pgtable.h>
47 #include <asm/sync_bitops.h>
50 /* External tools reserve first few grant table entries. */
51 #define NR_RESERVED_ENTRIES 8
52 #define GNTTAB_LIST_END 0xffffffff
53 #define GREFS_PER_GRANT_FRAME (PAGE_SIZE / sizeof(struct grant_entry))
55 static grant_ref_t
**gnttab_list
;
56 static unsigned int nr_grant_frames
;
57 static unsigned int boot_max_nr_grant_frames
;
58 static int gnttab_free_count
;
59 static grant_ref_t gnttab_free_head
;
60 static DEFINE_SPINLOCK(gnttab_list_lock
);
62 static struct grant_entry
*shared
;
64 static struct gnttab_free_callback
*gnttab_free_callback_list
;
66 static int gnttab_expand(unsigned int req_entries
);
68 #define RPP (PAGE_SIZE / sizeof(grant_ref_t))
70 static inline grant_ref_t
*__gnttab_entry(grant_ref_t entry
)
72 return &gnttab_list
[(entry
) / RPP
][(entry
) % RPP
];
74 /* This can be used as an l-value */
75 #define gnttab_entry(entry) (*__gnttab_entry(entry))
77 static int get_free_entries(unsigned count
)
83 spin_lock_irqsave(&gnttab_list_lock
, flags
);
85 if ((gnttab_free_count
< count
) &&
86 ((rc
= gnttab_expand(count
- gnttab_free_count
)) < 0)) {
87 spin_unlock_irqrestore(&gnttab_list_lock
, flags
);
91 ref
= head
= gnttab_free_head
;
92 gnttab_free_count
-= count
;
94 head
= gnttab_entry(head
);
95 gnttab_free_head
= gnttab_entry(head
);
96 gnttab_entry(head
) = GNTTAB_LIST_END
;
98 spin_unlock_irqrestore(&gnttab_list_lock
, flags
);
103 static void do_free_callbacks(void)
105 struct gnttab_free_callback
*callback
, *next
;
107 callback
= gnttab_free_callback_list
;
108 gnttab_free_callback_list
= NULL
;
110 while (callback
!= NULL
) {
111 next
= callback
->next
;
112 if (gnttab_free_count
>= callback
->count
) {
113 callback
->next
= NULL
;
114 callback
->fn(callback
->arg
);
116 callback
->next
= gnttab_free_callback_list
;
117 gnttab_free_callback_list
= callback
;
123 static inline void check_free_callbacks(void)
125 if (unlikely(gnttab_free_callback_list
))
129 static void put_free_entry(grant_ref_t ref
)
132 spin_lock_irqsave(&gnttab_list_lock
, flags
);
133 gnttab_entry(ref
) = gnttab_free_head
;
134 gnttab_free_head
= ref
;
136 check_free_callbacks();
137 spin_unlock_irqrestore(&gnttab_list_lock
, flags
);
140 static void update_grant_entry(grant_ref_t ref
, domid_t domid
,
141 unsigned long frame
, unsigned flags
)
144 * Introducing a valid entry into the grant table:
145 * 1. Write ent->domid.
146 * 2. Write ent->frame:
147 * GTF_permit_access: Frame to which access is permitted.
148 * GTF_accept_transfer: Pseudo-phys frame slot being filled by new
149 * frame, or zero if none.
150 * 3. Write memory barrier (WMB).
151 * 4. Write ent->flags, inc. valid type.
153 shared
[ref
].frame
= frame
;
154 shared
[ref
].domid
= domid
;
156 shared
[ref
].flags
= flags
;
160 * Public grant-issuing interface functions
162 void gnttab_grant_foreign_access_ref(grant_ref_t ref
, domid_t domid
,
163 unsigned long frame
, int readonly
)
165 update_grant_entry(ref
, domid
, frame
,
166 GTF_permit_access
| (readonly
? GTF_readonly
: 0));
168 EXPORT_SYMBOL_GPL(gnttab_grant_foreign_access_ref
);
170 int gnttab_grant_foreign_access(domid_t domid
, unsigned long frame
,
175 ref
= get_free_entries(1);
176 if (unlikely(ref
< 0))
179 gnttab_grant_foreign_access_ref(ref
, domid
, frame
, readonly
);
183 EXPORT_SYMBOL_GPL(gnttab_grant_foreign_access
);
185 int gnttab_query_foreign_access(grant_ref_t ref
)
189 nflags
= shared
[ref
].flags
;
191 return (nflags
& (GTF_reading
|GTF_writing
));
193 EXPORT_SYMBOL_GPL(gnttab_query_foreign_access
);
195 int gnttab_end_foreign_access_ref(grant_ref_t ref
, int readonly
)
199 nflags
= shared
[ref
].flags
;
202 if (flags
& (GTF_reading
|GTF_writing
)) {
203 printk(KERN_ALERT
"WARNING: g.e. still in use!\n");
206 } while ((nflags
= sync_cmpxchg(&shared
[ref
].flags
, flags
, 0)) != flags
);
210 EXPORT_SYMBOL_GPL(gnttab_end_foreign_access_ref
);
212 void gnttab_end_foreign_access(grant_ref_t ref
, int readonly
,
215 if (gnttab_end_foreign_access_ref(ref
, readonly
)) {
220 /* XXX This needs to be fixed so that the ref and page are
221 placed on a list to be freed up later. */
223 "WARNING: leaking g.e. and page still in use!\n");
226 EXPORT_SYMBOL_GPL(gnttab_end_foreign_access
);
228 int gnttab_grant_foreign_transfer(domid_t domid
, unsigned long pfn
)
232 ref
= get_free_entries(1);
233 if (unlikely(ref
< 0))
235 gnttab_grant_foreign_transfer_ref(ref
, domid
, pfn
);
239 EXPORT_SYMBOL_GPL(gnttab_grant_foreign_transfer
);
241 void gnttab_grant_foreign_transfer_ref(grant_ref_t ref
, domid_t domid
,
244 update_grant_entry(ref
, domid
, pfn
, GTF_accept_transfer
);
246 EXPORT_SYMBOL_GPL(gnttab_grant_foreign_transfer_ref
);
248 unsigned long gnttab_end_foreign_transfer_ref(grant_ref_t ref
)
254 * If a transfer is not even yet started, try to reclaim the grant
255 * reference and return failure (== 0).
257 while (!((flags
= shared
[ref
].flags
) & GTF_transfer_committed
)) {
258 if (sync_cmpxchg(&shared
[ref
].flags
, flags
, 0) == flags
)
263 /* If a transfer is in progress then wait until it is completed. */
264 while (!(flags
& GTF_transfer_completed
)) {
265 flags
= shared
[ref
].flags
;
269 rmb(); /* Read the frame number /after/ reading completion status. */
270 frame
= shared
[ref
].frame
;
275 EXPORT_SYMBOL_GPL(gnttab_end_foreign_transfer_ref
);
277 unsigned long gnttab_end_foreign_transfer(grant_ref_t ref
)
279 unsigned long frame
= gnttab_end_foreign_transfer_ref(ref
);
283 EXPORT_SYMBOL_GPL(gnttab_end_foreign_transfer
);
285 void gnttab_free_grant_reference(grant_ref_t ref
)
289 EXPORT_SYMBOL_GPL(gnttab_free_grant_reference
);
291 void gnttab_free_grant_references(grant_ref_t head
)
296 if (head
== GNTTAB_LIST_END
)
298 spin_lock_irqsave(&gnttab_list_lock
, flags
);
300 while (gnttab_entry(ref
) != GNTTAB_LIST_END
) {
301 ref
= gnttab_entry(ref
);
304 gnttab_entry(ref
) = gnttab_free_head
;
305 gnttab_free_head
= head
;
306 gnttab_free_count
+= count
;
307 check_free_callbacks();
308 spin_unlock_irqrestore(&gnttab_list_lock
, flags
);
310 EXPORT_SYMBOL_GPL(gnttab_free_grant_references
);
312 int gnttab_alloc_grant_references(u16 count
, grant_ref_t
*head
)
314 int h
= get_free_entries(count
);
323 EXPORT_SYMBOL_GPL(gnttab_alloc_grant_references
);
325 int gnttab_empty_grant_references(const grant_ref_t
*private_head
)
327 return (*private_head
== GNTTAB_LIST_END
);
329 EXPORT_SYMBOL_GPL(gnttab_empty_grant_references
);
331 int gnttab_claim_grant_reference(grant_ref_t
*private_head
)
333 grant_ref_t g
= *private_head
;
334 if (unlikely(g
== GNTTAB_LIST_END
))
336 *private_head
= gnttab_entry(g
);
339 EXPORT_SYMBOL_GPL(gnttab_claim_grant_reference
);
341 void gnttab_release_grant_reference(grant_ref_t
*private_head
,
344 gnttab_entry(release
) = *private_head
;
345 *private_head
= release
;
347 EXPORT_SYMBOL_GPL(gnttab_release_grant_reference
);
349 void gnttab_request_free_callback(struct gnttab_free_callback
*callback
,
350 void (*fn
)(void *), void *arg
, u16 count
)
353 spin_lock_irqsave(&gnttab_list_lock
, flags
);
358 callback
->count
= count
;
359 callback
->next
= gnttab_free_callback_list
;
360 gnttab_free_callback_list
= callback
;
361 check_free_callbacks();
363 spin_unlock_irqrestore(&gnttab_list_lock
, flags
);
365 EXPORT_SYMBOL_GPL(gnttab_request_free_callback
);
367 void gnttab_cancel_free_callback(struct gnttab_free_callback
*callback
)
369 struct gnttab_free_callback
**pcb
;
372 spin_lock_irqsave(&gnttab_list_lock
, flags
);
373 for (pcb
= &gnttab_free_callback_list
; *pcb
; pcb
= &(*pcb
)->next
) {
374 if (*pcb
== callback
) {
375 *pcb
= callback
->next
;
379 spin_unlock_irqrestore(&gnttab_list_lock
, flags
);
381 EXPORT_SYMBOL_GPL(gnttab_cancel_free_callback
);
383 static int grow_gnttab_list(unsigned int more_frames
)
385 unsigned int new_nr_grant_frames
, extra_entries
, i
;
386 unsigned int nr_glist_frames
, new_nr_glist_frames
;
388 new_nr_grant_frames
= nr_grant_frames
+ more_frames
;
389 extra_entries
= more_frames
* GREFS_PER_GRANT_FRAME
;
391 nr_glist_frames
= (nr_grant_frames
* GREFS_PER_GRANT_FRAME
+ RPP
- 1) / RPP
;
392 new_nr_glist_frames
=
393 (new_nr_grant_frames
* GREFS_PER_GRANT_FRAME
+ RPP
- 1) / RPP
;
394 for (i
= nr_glist_frames
; i
< new_nr_glist_frames
; i
++) {
395 gnttab_list
[i
] = (grant_ref_t
*)__get_free_page(GFP_ATOMIC
);
401 for (i
= GREFS_PER_GRANT_FRAME
* nr_grant_frames
;
402 i
< GREFS_PER_GRANT_FRAME
* new_nr_grant_frames
- 1; i
++)
403 gnttab_entry(i
) = i
+ 1;
405 gnttab_entry(i
) = gnttab_free_head
;
406 gnttab_free_head
= GREFS_PER_GRANT_FRAME
* nr_grant_frames
;
407 gnttab_free_count
+= extra_entries
;
409 nr_grant_frames
= new_nr_grant_frames
;
411 check_free_callbacks();
416 for ( ; i
>= nr_glist_frames
; i
--)
417 free_page((unsigned long) gnttab_list
[i
]);
421 static unsigned int __max_nr_grant_frames(void)
423 struct gnttab_query_size query
;
426 query
.dom
= DOMID_SELF
;
428 rc
= HYPERVISOR_grant_table_op(GNTTABOP_query_size
, &query
, 1);
429 if ((rc
< 0) || (query
.status
!= GNTST_okay
))
430 return 4; /* Legacy max supported number of frames */
432 return query
.max_nr_frames
;
435 static inline unsigned int max_nr_grant_frames(void)
437 unsigned int xen_max
= __max_nr_grant_frames();
439 if (xen_max
> boot_max_nr_grant_frames
)
440 return boot_max_nr_grant_frames
;
444 static int gnttab_map(unsigned int start_idx
, unsigned int end_idx
)
446 struct gnttab_setup_table setup
;
447 unsigned long *frames
;
448 unsigned int nr_gframes
= end_idx
+ 1;
451 frames
= kmalloc(nr_gframes
* sizeof(unsigned long), GFP_ATOMIC
);
455 setup
.dom
= DOMID_SELF
;
456 setup
.nr_frames
= nr_gframes
;
457 set_xen_guest_handle(setup
.frame_list
, frames
);
459 rc
= HYPERVISOR_grant_table_op(GNTTABOP_setup_table
, &setup
, 1);
465 BUG_ON(rc
|| setup
.status
);
467 rc
= arch_gnttab_map_shared(frames
, nr_gframes
, max_nr_grant_frames(),
476 int gnttab_resume(void)
478 if (max_nr_grant_frames() < nr_grant_frames
)
480 return gnttab_map(0, nr_grant_frames
- 1);
483 int gnttab_suspend(void)
485 arch_gnttab_unmap_shared(shared
, nr_grant_frames
);
489 static int gnttab_expand(unsigned int req_entries
)
492 unsigned int cur
, extra
;
494 cur
= nr_grant_frames
;
495 extra
= ((req_entries
+ (GREFS_PER_GRANT_FRAME
-1)) /
496 GREFS_PER_GRANT_FRAME
);
497 if (cur
+ extra
> max_nr_grant_frames())
500 rc
= gnttab_map(cur
, cur
+ extra
- 1);
502 rc
= grow_gnttab_list(extra
);
507 static int __devinit
gnttab_init(void)
510 unsigned int max_nr_glist_frames
, nr_glist_frames
;
511 unsigned int nr_init_grefs
;
517 boot_max_nr_grant_frames
= __max_nr_grant_frames();
519 /* Determine the maximum number of frames required for the
520 * grant reference free list on the current hypervisor.
522 max_nr_glist_frames
= (boot_max_nr_grant_frames
*
523 GREFS_PER_GRANT_FRAME
/ RPP
);
525 gnttab_list
= kmalloc(max_nr_glist_frames
* sizeof(grant_ref_t
*),
527 if (gnttab_list
== NULL
)
530 nr_glist_frames
= (nr_grant_frames
* GREFS_PER_GRANT_FRAME
+ RPP
- 1) / RPP
;
531 for (i
= 0; i
< nr_glist_frames
; i
++) {
532 gnttab_list
[i
] = (grant_ref_t
*)__get_free_page(GFP_KERNEL
);
533 if (gnttab_list
[i
] == NULL
)
537 if (gnttab_resume() < 0)
540 nr_init_grefs
= nr_grant_frames
* GREFS_PER_GRANT_FRAME
;
542 for (i
= NR_RESERVED_ENTRIES
; i
< nr_init_grefs
- 1; i
++)
543 gnttab_entry(i
) = i
+ 1;
545 gnttab_entry(nr_init_grefs
- 1) = GNTTAB_LIST_END
;
546 gnttab_free_count
= nr_init_grefs
- NR_RESERVED_ENTRIES
;
547 gnttab_free_head
= NR_RESERVED_ENTRIES
;
549 printk("Grant table initialized\n");
553 for (i
--; i
>= 0; i
--)
554 free_page((unsigned long)gnttab_list
[i
]);
559 core_initcall(gnttab_init
);