/usr/include/xenforeignmemory.h is in libxen-dev 4.9.2-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 | /*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation;
* version 2.1 of the License.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef XENFOREIGNMEMORY_H
#define XENFOREIGNMEMORY_H
/*
* This library allows you to map foreign domain memory, subject to
* permissions for both the process and the domain in which the
* process runs.
*/
#include <stdint.h>
#include <stddef.h>
#include <xen/xen.h>
/* Callers who don't care don't need to #include <xentoollog.h> */
struct xentoollog_logger;
typedef struct xenforeignmemory_handle xenforeignmemory_handle;
/*
* Return a handle onto the foreign memory mapping driver. Logs errors.
*
* Note: After fork(2) a child process must not use any opened
* foreignmemory handle inherited from their parent, nor access any
* grant mapped areas associated with that handle.
*
* The child must open a new handle if they want to interact with
* foreignmemory.
*
* Calling exec(2) in a child will safely (and reliably) reclaim any
* resources which were allocated via a xenforeignmemory_handle in the
* parent.
*
* A child which does not call exec(2) may safely call
* xenforeignmemory_close() on a xenforeignmemory_handle inherited
* from their parent. This will attempt to reclaim any resources
* associated with that handle. Note that in some implementations this
* reclamation may not be completely effective, in this case any
* affected resources remain allocated.
*
* Calling xenforeignmemory_close() is the only safe operation on a
* xenforeignmemory_handle which has been inherited.
*/
xenforeignmemory_handle *xenforeignmemory_open(struct xentoollog_logger *logger,
unsigned open_flags);
/*
* Close a handle previously allocated with xenforeignmemory_open().
*
* Under normal circumstances (i.e. not in the child after a fork)
* xenforeignmemory_unmap() should be used on all mappings allocated
* by xenforeignmemory_map() prior to closing the handle in order to
* free up resources associated with those mappings.
*
* This is the only function which may be safely called on a
* xenforeignmemory_handle in a child after a
* fork. xenforeignmemory_unmap() must not be called under such
* circumstances.
*/
int xenforeignmemory_close(xenforeignmemory_handle *fmem);
/*
* Maps a range within one domain to a local address range. Mappings
* must be unmapped with xenforeignmemory_unmap and should follow the
* same rules as mmap regarding page alignment.
*
* prot is as for mmap(2).
*
* @arr is an array of @pages gfns to be mapped linearly in the local
* address range. @err is an (optional) output array used to report
* per-page errors, as errno values.
*
* If @err is given (is non-NULL) then the mapping may partially
* succeed and return a valid pointer while also using @err to
* indicate the success (0) or failure (errno value) of the individual
* pages. The global errno thread local variable is not valid in this
* case.
*
* If @err is not given (is NULL) then on failure to map any page any
* successful mappings will be undone and NULL will be returned. errno
* will be set to correspond to the first failure (which may not be
* the most critical).
*
* It is also possible to return NULL due to a complete failure,
* i.e. failure to even attempt the mapping, in this case the global
* errno will have been set and the contents of @err (if given) is
* invalid.
*
* Note that it is also possible to return non-NULL with the contents
* of @err indicating failure to map every page.
*/
void *xenforeignmemory_map(xenforeignmemory_handle *fmem, uint32_t dom,
int prot, size_t pages,
const xen_pfn_t arr[/*pages*/], int err[/*pages*/]);
/*
* Unmap a mapping previous created with xenforeignmemory_map().
*
* Returns 0 on success on failure sets errno and returns -1.
*/
int xenforeignmemory_unmap(xenforeignmemory_handle *fmem,
void *addr, size_t pages);
/**
* This function restricts the use of this handle to the specified
* domain.
*
* @parm fmem handle to the open foreignmemory interface
* @parm domid the domain id
* @return 0 on success, -1 on failure.
*/
int xenforeignmemory_restrict(xenforeignmemory_handle *fmem,
domid_t domid);
#endif
/*
* Local variables:
* mode: C
* c-file-style: "BSD"
* c-basic-offset: 4
* tab-width: 4
* indent-tabs-mode: nil
* End:
*/
|