include/xen/interface/memory.h

   1 /******************************************************************************
   2  * memory.h
   3  *
   4  * Memory reservation and information.
   5  *
   6  * Copyright (c) 2005, Keir Fraser <keir@xensource.com>
   7  */
   8
   9 #ifndef __XEN_PUBLIC_MEMORY_H__
  10 #define __XEN_PUBLIC_MEMORY_H__
  11
  12 /*
  13  * Increase or decrease the specified domain's memory reservation. Returns a
  14  * -ve errcode on failure, or the # extents successfully allocated or freed.
  15  * arg == addr of struct xen_memory_reservation.
  16  */
  17 #define XENMEM_increase_reservation 0
  18 #define XENMEM_decrease_reservation 1
  19 #define XENMEM_populate_physmap     6
  20 struct xen_memory_reservation {
  21
  22     /*
  23      * XENMEM_increase_reservation:
  24      *   OUT: MFN (*not* GMFN) bases of extents that were allocated
  25      * XENMEM_decrease_reservation:
  26      *   IN:  GMFN bases of extents to free
  27      * XENMEM_populate_physmap:
  28      *   IN:  GPFN bases of extents to populate with memory
  29      *   OUT: GMFN bases of extents that were allocated
  30      *   (NB. This command also updates the mach_to_phys translation table)
  31      */
  32     ulong extent_start;
  33
  34     /* Number of extents, and size/alignment of each (2^extent_order pages). */
  35     unsigned long  nr_extents;
  36     unsigned int   extent_order;
  37
  38     /*
  39      * Maximum # bits addressable by the user of the allocated region (e.g.,
  40      * I/O devices often have a 32-bit limitation even in 64-bit systems). If
  41      * zero then the user has no addressing restriction.
  42      * This field is not used by XENMEM_decrease_reservation.
  43      */
  44     unsigned int   address_bits;
  45
  46     /*
  47      * Domain whose reservation is being changed.
  48      * Unprivileged domains can specify only DOMID_SELF.
  49      */
  50     domid_t        domid;
  51
  52 };
  53
  54 /*
  55  * Returns the maximum machine frame number of mapped RAM in this system.
  56  * This command always succeeds (it never returns an error code).
  57  * arg == NULL.
  58  */
  59 #define XENMEM_maximum_ram_page     2
  60
  61 /*
  62  * Returns the current or maximum memory reservation, in pages, of the
  63  * specified domain (may be DOMID_SELF). Returns -ve errcode on failure.
  64  * arg == addr of domid_t.
  65  */
  66 #define XENMEM_current_reservation  3
  67 #define XENMEM_maximum_reservation  4
  68
  69 /*
  70  * Returns a list of MFN bases of 2MB extents comprising the machine_to_phys
  71  * mapping table. Architectures which do not have a m2p table do not implement
  72  * this command.
  73  * arg == addr of xen_machphys_mfn_list_t.
  74  */
  75 #define XENMEM_machphys_mfn_list    5
  76 struct xen_machphys_mfn_list {
  77     /*
  78      * Size of the 'extent_start' array. Fewer entries will be filled if the
  79      * machphys table is smaller than max_extents * 2MB.
  80      */
  81     unsigned int max_extents;
  82
  83     /*
  84      * Pointer to buffer to fill with list of extent starts. If there are
  85      * any large discontiguities in the machine address space, 2MB gaps in
  86      * the machphys table will be represented by an MFN base of zero.
  87      */
  88     ulong extent_start;
  89
  90     /*
  91      * Number of extents written to the above array. This will be smaller
  92      * than 'max_extents' if the machphys table is smaller than max_e * 2MB.
  93      */
  94     unsigned int nr_extents;
  95 };
  96
  97 /*
  98  * Sets the GPFN at which a particular page appears in the specified guest's
  99  * pseudophysical address space.
 100  * arg == addr of xen_add_to_physmap_t.
 101  */
 102 #define XENMEM_add_to_physmap      7
 103 struct xen_add_to_physmap {
 104     /* Which domain to change the mapping for. */
 105     domid_t domid;
 106
 107     /* Source mapping space. */
 108 #define XENMAPSPACE_shared_info 0 /* shared info page */
 109 #define XENMAPSPACE_grant_table 1 /* grant table page */
 110     unsigned int space;
 111
 112     /* Index into source mapping space. */
 113     unsigned long idx;
 114
 115     /* GPFN where the source mapping page should appear. */
 116     unsigned long gpfn;
 117 };
 118
 119 /*
 120  * Translates a list of domain-specific GPFNs into MFNs. Returns a -ve error
 121  * code on failure. This call only works for auto-translated guests.
 122  */
 123 #define XENMEM_translate_gpfn_list  8
 124 struct xen_translate_gpfn_list {
 125     /* Which domain to translate for? */
 126     domid_t domid;
 127
 128     /* Length of list. */
 129     unsigned long nr_gpfns;
 130
 131     /* List of GPFNs to translate. */
 132     ulong gpfn_list;
 133
 134     /*
 135      * Output list to contain MFN translations. May be the same as the input
 136      * list (in which case each input GPFN is overwritten with the output MFN).
 137      */
 138     ulong mfn_list;
 139 };
 140
 141 #endif /* __XEN_PUBLIC_MEMORY_H__ */