LXR linux/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
  20struct 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    GUEST_HANDLE(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};
  53DEFINE_GUEST_HANDLE_STRUCT(xen_memory_reservation);
  54
  55/*
  56 * Returns the maximum machine frame number of mapped RAM in this system.
  57 * This command always succeeds (it never returns an error code).
  58 * arg == NULL.
  59 */
  60#define XENMEM_maximum_ram_page     2
  61
  62/*
  63 * Returns the current or maximum memory reservation, in pages, of the
  64 * specified domain (may be DOMID_SELF). Returns -ve errcode on failure.
  65 * arg == addr of domid_t.
  66 */
  67#define XENMEM_current_reservation  3
  68#define XENMEM_maximum_reservation  4
  69
  70/*
  71 * Returns a list of MFN bases of 2MB extents comprising the machine_to_phys
  72 * mapping table. Architectures which do not have a m2p table do not implement
  73 * this command.
  74 * arg == addr of xen_machphys_mfn_list_t.
  75 */
  76#define XENMEM_machphys_mfn_list    5
  77struct xen_machphys_mfn_list {
  78    /*
  79     * Size of the 'extent_start' array. Fewer entries will be filled if the
  80     * machphys table is smaller than max_extents * 2MB.
  81     */
  82    unsigned int max_extents;
  83
  84    /*
  85     * Pointer to buffer to fill with list of extent starts. If there are
  86     * any large discontiguities in the machine address space, 2MB gaps in
  87     * the machphys table will be represented by an MFN base of zero.
  88     */
  89    GUEST_HANDLE(ulong) extent_start;
  90
  91    /*
  92     * Number of extents written to the above array. This will be smaller
  93     * than 'max_extents' if the machphys table is smaller than max_e * 2MB.
  94     */
  95    unsigned int nr_extents;
  96};
  97DEFINE_GUEST_HANDLE_STRUCT(xen_machphys_mfn_list);
  98
  99/*
 100 * Sets the GPFN at which a particular page appears in the specified guest's
 101 * pseudophysical address space.
 102 * arg == addr of xen_add_to_physmap_t.
 103 */
 104#define XENMEM_add_to_physmap      7
 105struct xen_add_to_physmap {
 106    /* Which domain to change the mapping for. */
 107    domid_t domid;
 108
 109    /* Source mapping space. */
 110#define XENMAPSPACE_shared_info 0 /* shared info page */
 111#define XENMAPSPACE_grant_table 1 /* grant table page */
 112    unsigned int space;
 113
 114    /* Index into source mapping space. */
 115    unsigned long idx;
 116
 117    /* GPFN where the source mapping page should appear. */
 118    unsigned long gpfn;
 119};
 120DEFINE_GUEST_HANDLE_STRUCT(xen_add_to_physmap);
 121
 122/*
 123 * Translates a list of domain-specific GPFNs into MFNs. Returns a -ve error
 124 * code on failure. This call only works for auto-translated guests.
 125 */
 126#define XENMEM_translate_gpfn_list  8
 127struct xen_translate_gpfn_list {
 128    /* Which domain to translate for? */
 129    domid_t domid;
 130
 131    /* Length of list. */
 132    unsigned long nr_gpfns;
 133
 134    /* List of GPFNs to translate. */
 135    GUEST_HANDLE(ulong) gpfn_list;
 136
 137    /*
 138     * Output list to contain MFN translations. May be the same as the input
 139     * list (in which case each input GPFN is overwritten with the output MFN).
 140     */
 141    GUEST_HANDLE(ulong) mfn_list;
 142};
 143DEFINE_GUEST_HANDLE_STRUCT(xen_translate_gpfn_list);
 144
 145#endif /* __XEN_PUBLIC_MEMORY_H__ */
 146