grant_table.h 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192
  1. /******************************************************************************
  2. * grant_table.h
  3. *
  4. * Two sets of functionality:
  5. * 1. Granting foreign access to our memory reservation.
  6. * 2. Accessing others' memory reservations via grant references.
  7. * (i.e., mechanisms for both sender and recipient of grant references)
  8. *
  9. * Copyright (c) 2004-2005, K A Fraser
  10. * Copyright (c) 2005, Christopher Clark
  11. *
  12. * This program is free software; you can redistribute it and/or
  13. * modify it under the terms of the GNU General Public License version 2
  14. * as published by the Free Software Foundation; or, when distributed
  15. * separately from the Linux kernel or incorporated into other
  16. * software packages, subject to the following license:
  17. *
  18. * Permission is hereby granted, free of charge, to any person obtaining a copy
  19. * of this source file (the "Software"), to deal in the Software without
  20. * restriction, including without limitation the rights to use, copy, modify,
  21. * merge, publish, distribute, sublicense, and/or sell copies of the Software,
  22. * and to permit persons to whom the Software is furnished to do so, subject to
  23. * the following conditions:
  24. *
  25. * The above copyright notice and this permission notice shall be included in
  26. * all copies or substantial portions of the Software.
  27. *
  28. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  29. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  30. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  31. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  32. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  33. * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  34. * IN THE SOFTWARE.
  35. */
  36. #ifndef __ASM_GNTTAB_H__
  37. #define __ASM_GNTTAB_H__
  38. #include <asm/page.h>
  39. #include <xen/interface/xen.h>
  40. #include <xen/interface/grant_table.h>
  41. #include <asm/xen/hypervisor.h>
  42. #include <xen/features.h>
  43. /* NR_GRANT_FRAMES must be less than or equal to that configured in Xen */
  44. #define NR_GRANT_FRAMES 4
  45. struct gnttab_free_callback {
  46. struct gnttab_free_callback *next;
  47. void (*fn)(void *);
  48. void *arg;
  49. u16 count;
  50. };
  51. int gnttab_init(void);
  52. int gnttab_suspend(void);
  53. int gnttab_resume(void);
  54. int gnttab_grant_foreign_access(domid_t domid, unsigned long frame,
  55. int readonly);
  56. int gnttab_grant_foreign_access_subpage(domid_t domid, unsigned long frame,
  57. int flags, unsigned page_off,
  58. unsigned length);
  59. int gnttab_grant_foreign_access_trans(domid_t domid, int flags,
  60. domid_t trans_domid,
  61. grant_ref_t trans_gref);
  62. /*
  63. * Are sub-page grants available on this version of Xen? Returns true if they
  64. * are, and false if they're not.
  65. */
  66. bool gnttab_subpage_grants_available(void);
  67. /*
  68. * Are transitive grants available on this version of Xen? Returns true if they
  69. * are, and false if they're not.
  70. */
  71. bool gnttab_trans_grants_available(void);
  72. /*
  73. * End access through the given grant reference, iff the grant entry is no
  74. * longer in use. Return 1 if the grant entry was freed, 0 if it is still in
  75. * use.
  76. */
  77. int gnttab_end_foreign_access_ref(grant_ref_t ref, int readonly);
  78. /*
  79. * Eventually end access through the given grant reference, and once that
  80. * access has been ended, free the given page too. Access will be ended
  81. * immediately iff the grant entry is not in use, otherwise it will happen
  82. * some time later. page may be 0, in which case no freeing will occur.
  83. */
  84. void gnttab_end_foreign_access(grant_ref_t ref, int readonly,
  85. unsigned long page);
  86. int gnttab_grant_foreign_transfer(domid_t domid, unsigned long pfn);
  87. unsigned long gnttab_end_foreign_transfer_ref(grant_ref_t ref);
  88. unsigned long gnttab_end_foreign_transfer(grant_ref_t ref);
  89. int gnttab_query_foreign_access(grant_ref_t ref);
  90. /*
  91. * operations on reserved batches of grant references
  92. */
  93. int gnttab_alloc_grant_references(u16 count, grant_ref_t *pprivate_head);
  94. void gnttab_free_grant_reference(grant_ref_t ref);
  95. void gnttab_free_grant_references(grant_ref_t head);
  96. int gnttab_empty_grant_references(const grant_ref_t *pprivate_head);
  97. int gnttab_claim_grant_reference(grant_ref_t *pprivate_head);
  98. void gnttab_release_grant_reference(grant_ref_t *private_head,
  99. grant_ref_t release);
  100. void gnttab_request_free_callback(struct gnttab_free_callback *callback,
  101. void (*fn)(void *), void *arg, u16 count);
  102. void gnttab_cancel_free_callback(struct gnttab_free_callback *callback);
  103. void gnttab_grant_foreign_access_ref(grant_ref_t ref, domid_t domid,
  104. unsigned long frame, int readonly);
  105. int gnttab_grant_foreign_access_subpage_ref(grant_ref_t ref, domid_t domid,
  106. unsigned long frame, int flags,
  107. unsigned page_off,
  108. unsigned length);
  109. int gnttab_grant_foreign_access_trans_ref(grant_ref_t ref, domid_t domid,
  110. int flags, domid_t trans_domid,
  111. grant_ref_t trans_gref);
  112. void gnttab_grant_foreign_transfer_ref(grant_ref_t, domid_t domid,
  113. unsigned long pfn);
  114. static inline void
  115. gnttab_set_map_op(struct gnttab_map_grant_ref *map, phys_addr_t addr,
  116. uint32_t flags, grant_ref_t ref, domid_t domid)
  117. {
  118. if (flags & GNTMAP_contains_pte)
  119. map->host_addr = addr;
  120. else if (xen_feature(XENFEAT_auto_translated_physmap))
  121. map->host_addr = __pa(addr);
  122. else
  123. map->host_addr = addr;
  124. map->flags = flags;
  125. map->ref = ref;
  126. map->dom = domid;
  127. }
  128. static inline void
  129. gnttab_set_unmap_op(struct gnttab_unmap_grant_ref *unmap, phys_addr_t addr,
  130. uint32_t flags, grant_handle_t handle)
  131. {
  132. if (flags & GNTMAP_contains_pte)
  133. unmap->host_addr = addr;
  134. else if (xen_feature(XENFEAT_auto_translated_physmap))
  135. unmap->host_addr = __pa(addr);
  136. else
  137. unmap->host_addr = addr;
  138. unmap->handle = handle;
  139. unmap->dev_bus_addr = 0;
  140. }
  141. int arch_gnttab_map_shared(unsigned long *frames, unsigned long nr_gframes,
  142. unsigned long max_nr_gframes,
  143. void **__shared);
  144. int arch_gnttab_map_status(uint64_t *frames, unsigned long nr_gframes,
  145. unsigned long max_nr_gframes,
  146. grant_status_t **__shared);
  147. void arch_gnttab_unmap(void *shared, unsigned long nr_gframes);
  148. extern unsigned long xen_hvm_resume_frames;
  149. unsigned int gnttab_max_grant_frames(void);
  150. #define gnttab_map_vaddr(map) ((void *)(map.host_virt_addr))
  151. int gnttab_map_refs(struct gnttab_map_grant_ref *map_ops,
  152. struct gnttab_map_grant_ref *kmap_ops,
  153. struct page **pages, unsigned int count);
  154. int gnttab_unmap_refs(struct gnttab_unmap_grant_ref *unmap_ops,
  155. struct gnttab_map_grant_ref *kunmap_ops,
  156. struct page **pages, unsigned int count);
  157. #endif /* __ASM_GNTTAB_H__ */