843e19887f64dde75055cf8842fc4db2171eff45johnlev/******************************************************************************
843e19887f64dde75055cf8842fc4db2171eff45johnlev * grant_table.h
843e19887f64dde75055cf8842fc4db2171eff45johnlev *
843e19887f64dde75055cf8842fc4db2171eff45johnlev * Interface for granting foreign access to page frames, and receiving
843e19887f64dde75055cf8842fc4db2171eff45johnlev * page-ownership transfers.
843e19887f64dde75055cf8842fc4db2171eff45johnlev *
843e19887f64dde75055cf8842fc4db2171eff45johnlev * Permission is hereby granted, free of charge, to any person obtaining a copy
843e19887f64dde75055cf8842fc4db2171eff45johnlev * of this software and associated documentation files (the "Software"), to
843e19887f64dde75055cf8842fc4db2171eff45johnlev * deal in the Software without restriction, including without limitation the
843e19887f64dde75055cf8842fc4db2171eff45johnlev * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
843e19887f64dde75055cf8842fc4db2171eff45johnlev * sell copies of the Software, and to permit persons to whom the Software is
843e19887f64dde75055cf8842fc4db2171eff45johnlev * furnished to do so, subject to the following conditions:
843e19887f64dde75055cf8842fc4db2171eff45johnlev *
843e19887f64dde75055cf8842fc4db2171eff45johnlev * The above copyright notice and this permission notice shall be included in
843e19887f64dde75055cf8842fc4db2171eff45johnlev * all copies or substantial portions of the Software.
843e19887f64dde75055cf8842fc4db2171eff45johnlev *
843e19887f64dde75055cf8842fc4db2171eff45johnlev * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
843e19887f64dde75055cf8842fc4db2171eff45johnlev * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
843e19887f64dde75055cf8842fc4db2171eff45johnlev * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
843e19887f64dde75055cf8842fc4db2171eff45johnlev * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
843e19887f64dde75055cf8842fc4db2171eff45johnlev * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
843e19887f64dde75055cf8842fc4db2171eff45johnlev * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
843e19887f64dde75055cf8842fc4db2171eff45johnlev * DEALINGS IN THE SOFTWARE.
843e19887f64dde75055cf8842fc4db2171eff45johnlev *
843e19887f64dde75055cf8842fc4db2171eff45johnlev * Copyright (c) 2004, K A Fraser
843e19887f64dde75055cf8842fc4db2171eff45johnlev */
843e19887f64dde75055cf8842fc4db2171eff45johnlev
843e19887f64dde75055cf8842fc4db2171eff45johnlev#ifndef __XEN_PUBLIC_GRANT_TABLE_H__
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define __XEN_PUBLIC_GRANT_TABLE_H__
843e19887f64dde75055cf8842fc4db2171eff45johnlev
843e19887f64dde75055cf8842fc4db2171eff45johnlev
843e19887f64dde75055cf8842fc4db2171eff45johnlev/***********************************
843e19887f64dde75055cf8842fc4db2171eff45johnlev * GRANT TABLE REPRESENTATION
843e19887f64dde75055cf8842fc4db2171eff45johnlev */
843e19887f64dde75055cf8842fc4db2171eff45johnlev
843e19887f64dde75055cf8842fc4db2171eff45johnlev/* Some rough guidelines on accessing and updating grant-table entries
843e19887f64dde75055cf8842fc4db2171eff45johnlev * in a concurrency-safe manner. For more information, Linux contains a
843e19887f64dde75055cf8842fc4db2171eff45johnlev * reference implementation for guest OSes (arch/xen/kernel/grant_table.c).
843e19887f64dde75055cf8842fc4db2171eff45johnlev *
843e19887f64dde75055cf8842fc4db2171eff45johnlev * NB. WMB is a no-op on current-generation x86 processors. However, a
843e19887f64dde75055cf8842fc4db2171eff45johnlev * compiler barrier will still be required.
843e19887f64dde75055cf8842fc4db2171eff45johnlev *
843e19887f64dde75055cf8842fc4db2171eff45johnlev * Introducing a valid entry into the grant table:
843e19887f64dde75055cf8842fc4db2171eff45johnlev * 1. Write ent->domid.
843e19887f64dde75055cf8842fc4db2171eff45johnlev * 2. Write ent->frame:
843e19887f64dde75055cf8842fc4db2171eff45johnlev * GTF_permit_access: Frame to which access is permitted.
843e19887f64dde75055cf8842fc4db2171eff45johnlev * GTF_accept_transfer: Pseudo-phys frame slot being filled by new
843e19887f64dde75055cf8842fc4db2171eff45johnlev * frame, or zero if none.
843e19887f64dde75055cf8842fc4db2171eff45johnlev * 3. Write memory barrier (WMB).
843e19887f64dde75055cf8842fc4db2171eff45johnlev * 4. Write ent->flags, inc. valid type.
843e19887f64dde75055cf8842fc4db2171eff45johnlev *
843e19887f64dde75055cf8842fc4db2171eff45johnlev * Invalidating an unused GTF_permit_access entry:
843e19887f64dde75055cf8842fc4db2171eff45johnlev * 1. flags = ent->flags.
843e19887f64dde75055cf8842fc4db2171eff45johnlev * 2. Observe that !(flags & (GTF_reading|GTF_writing)).
843e19887f64dde75055cf8842fc4db2171eff45johnlev * 3. Check result of SMP-safe CMPXCHG(&ent->flags, flags, 0).
843e19887f64dde75055cf8842fc4db2171eff45johnlev * NB. No need for WMB as reuse of entry is control-dependent on success of
843e19887f64dde75055cf8842fc4db2171eff45johnlev * step 3, and all architectures guarantee ordering of ctrl-dep writes.
843e19887f64dde75055cf8842fc4db2171eff45johnlev *
843e19887f64dde75055cf8842fc4db2171eff45johnlev * Invalidating an in-use GTF_permit_access entry:
843e19887f64dde75055cf8842fc4db2171eff45johnlev * This cannot be done directly. Request assistance from the domain controller
843e19887f64dde75055cf8842fc4db2171eff45johnlev * which can set a timeout on the use of a grant entry and take necessary
843e19887f64dde75055cf8842fc4db2171eff45johnlev * action. (NB. This is not yet implemented!).
843e19887f64dde75055cf8842fc4db2171eff45johnlev *
843e19887f64dde75055cf8842fc4db2171eff45johnlev * Invalidating an unused GTF_accept_transfer entry:
843e19887f64dde75055cf8842fc4db2171eff45johnlev * 1. flags = ent->flags.
843e19887f64dde75055cf8842fc4db2171eff45johnlev * 2. Observe that !(flags & GTF_transfer_committed). [*]
843e19887f64dde75055cf8842fc4db2171eff45johnlev * 3. Check result of SMP-safe CMPXCHG(&ent->flags, flags, 0).
843e19887f64dde75055cf8842fc4db2171eff45johnlev * NB. No need for WMB as reuse of entry is control-dependent on success of
843e19887f64dde75055cf8842fc4db2171eff45johnlev * step 3, and all architectures guarantee ordering of ctrl-dep writes.
843e19887f64dde75055cf8842fc4db2171eff45johnlev * [*] If GTF_transfer_committed is set then the grant entry is 'committed'.
843e19887f64dde75055cf8842fc4db2171eff45johnlev * The guest must /not/ modify the grant entry until the address of the
843e19887f64dde75055cf8842fc4db2171eff45johnlev * transferred frame is written. It is safe for the guest to spin waiting
843e19887f64dde75055cf8842fc4db2171eff45johnlev * for this to occur (detect by observing GTF_transfer_completed in
843e19887f64dde75055cf8842fc4db2171eff45johnlev * ent->flags).
843e19887f64dde75055cf8842fc4db2171eff45johnlev *
843e19887f64dde75055cf8842fc4db2171eff45johnlev * Invalidating a committed GTF_accept_transfer entry:
843e19887f64dde75055cf8842fc4db2171eff45johnlev * 1. Wait for (ent->flags & GTF_transfer_completed).
843e19887f64dde75055cf8842fc4db2171eff45johnlev *
843e19887f64dde75055cf8842fc4db2171eff45johnlev * Changing a GTF_permit_access from writable to read-only:
843e19887f64dde75055cf8842fc4db2171eff45johnlev * Use SMP-safe CMPXCHG to set GTF_readonly, while checking !GTF_writing.
843e19887f64dde75055cf8842fc4db2171eff45johnlev *
843e19887f64dde75055cf8842fc4db2171eff45johnlev * Changing a GTF_permit_access from read-only to writable:
843e19887f64dde75055cf8842fc4db2171eff45johnlev * Use SMP-safe bit-setting instruction.
843e19887f64dde75055cf8842fc4db2171eff45johnlev */
843e19887f64dde75055cf8842fc4db2171eff45johnlev
843e19887f64dde75055cf8842fc4db2171eff45johnlev/*
843e19887f64dde75055cf8842fc4db2171eff45johnlev * A grant table comprises a packed array of grant entries in one or more
843e19887f64dde75055cf8842fc4db2171eff45johnlev * page frames shared between Xen and a guest.
843e19887f64dde75055cf8842fc4db2171eff45johnlev * [XEN]: This field is written by Xen and read by the sharing guest.
843e19887f64dde75055cf8842fc4db2171eff45johnlev * [GST]: This field is written by the guest and read by Xen.
843e19887f64dde75055cf8842fc4db2171eff45johnlev */
843e19887f64dde75055cf8842fc4db2171eff45johnlevstruct grant_entry {
843e19887f64dde75055cf8842fc4db2171eff45johnlev /* GTF_xxx: various type and flag information. [XEN,GST] */
843e19887f64dde75055cf8842fc4db2171eff45johnlev uint16_t flags;
843e19887f64dde75055cf8842fc4db2171eff45johnlev /* The domain being granted foreign privileges. [GST] */
843e19887f64dde75055cf8842fc4db2171eff45johnlev domid_t domid;
843e19887f64dde75055cf8842fc4db2171eff45johnlev /*
843e19887f64dde75055cf8842fc4db2171eff45johnlev * GTF_permit_access: Frame that @domid is allowed to map and access. [GST]
843e19887f64dde75055cf8842fc4db2171eff45johnlev * GTF_accept_transfer: Frame whose ownership transferred by @domid. [XEN]
843e19887f64dde75055cf8842fc4db2171eff45johnlev */
843e19887f64dde75055cf8842fc4db2171eff45johnlev uint32_t frame;
843e19887f64dde75055cf8842fc4db2171eff45johnlev};
843e19887f64dde75055cf8842fc4db2171eff45johnlevtypedef struct grant_entry grant_entry_t;
843e19887f64dde75055cf8842fc4db2171eff45johnlev
843e19887f64dde75055cf8842fc4db2171eff45johnlev/*
843e19887f64dde75055cf8842fc4db2171eff45johnlev * Type of grant entry.
843e19887f64dde75055cf8842fc4db2171eff45johnlev * GTF_invalid: This grant entry grants no privileges.
843e19887f64dde75055cf8842fc4db2171eff45johnlev * GTF_permit_access: Allow @domid to map/access @frame.
843e19887f64dde75055cf8842fc4db2171eff45johnlev * GTF_accept_transfer: Allow @domid to transfer ownership of one page frame
843e19887f64dde75055cf8842fc4db2171eff45johnlev * to this guest. Xen writes the page number to @frame.
843e19887f64dde75055cf8842fc4db2171eff45johnlev */
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define GTF_invalid (0U<<0)
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define GTF_permit_access (1U<<0)
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define GTF_accept_transfer (2U<<0)
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define GTF_type_mask (3U<<0)
843e19887f64dde75055cf8842fc4db2171eff45johnlev
843e19887f64dde75055cf8842fc4db2171eff45johnlev/*
843e19887f64dde75055cf8842fc4db2171eff45johnlev * Subflags for GTF_permit_access.
843e19887f64dde75055cf8842fc4db2171eff45johnlev * GTF_readonly: Restrict @domid to read-only mappings and accesses. [GST]
843e19887f64dde75055cf8842fc4db2171eff45johnlev * GTF_reading: Grant entry is currently mapped for reading by @domid. [XEN]
843e19887f64dde75055cf8842fc4db2171eff45johnlev * GTF_writing: Grant entry is currently mapped for writing by @domid. [XEN]
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee * GTF_PAT, GTF_PWT, GTF_PCD: (x86) cache attribute flags for the grant [GST]
843e19887f64dde75055cf8842fc4db2171eff45johnlev */
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define _GTF_readonly (2)
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define GTF_readonly (1U<<_GTF_readonly)
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define _GTF_reading (3)
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define GTF_reading (1U<<_GTF_reading)
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define _GTF_writing (4)
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define GTF_writing (1U<<_GTF_writing)
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee#define _GTF_PWT (5)
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee#define GTF_PWT (1U<<_GTF_PWT)
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee#define _GTF_PCD (6)
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee#define GTF_PCD (1U<<_GTF_PCD)
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee#define _GTF_PAT (7)
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee#define GTF_PAT (1U<<_GTF_PAT)
843e19887f64dde75055cf8842fc4db2171eff45johnlev
843e19887f64dde75055cf8842fc4db2171eff45johnlev/*
843e19887f64dde75055cf8842fc4db2171eff45johnlev * Subflags for GTF_accept_transfer:
843e19887f64dde75055cf8842fc4db2171eff45johnlev * GTF_transfer_committed: Xen sets this flag to indicate that it is committed
843e19887f64dde75055cf8842fc4db2171eff45johnlev * to transferring ownership of a page frame. When a guest sees this flag
843e19887f64dde75055cf8842fc4db2171eff45johnlev * it must /not/ modify the grant entry until GTF_transfer_completed is
843e19887f64dde75055cf8842fc4db2171eff45johnlev * set by Xen.
843e19887f64dde75055cf8842fc4db2171eff45johnlev * GTF_transfer_completed: It is safe for the guest to spin-wait on this flag
843e19887f64dde75055cf8842fc4db2171eff45johnlev * after reading GTF_transfer_committed. Xen will always write the frame
843e19887f64dde75055cf8842fc4db2171eff45johnlev * address, followed by ORing this flag, in a timely manner.
843e19887f64dde75055cf8842fc4db2171eff45johnlev */
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define _GTF_transfer_committed (2)
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define GTF_transfer_committed (1U<<_GTF_transfer_committed)
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define _GTF_transfer_completed (3)
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define GTF_transfer_completed (1U<<_GTF_transfer_completed)
843e19887f64dde75055cf8842fc4db2171eff45johnlev
843e19887f64dde75055cf8842fc4db2171eff45johnlev
843e19887f64dde75055cf8842fc4db2171eff45johnlev/***********************************
843e19887f64dde75055cf8842fc4db2171eff45johnlev * GRANT TABLE QUERIES AND USES
843e19887f64dde75055cf8842fc4db2171eff45johnlev */
843e19887f64dde75055cf8842fc4db2171eff45johnlev
843e19887f64dde75055cf8842fc4db2171eff45johnlev/*
843e19887f64dde75055cf8842fc4db2171eff45johnlev * Reference to a grant entry in a specified domain's grant table.
843e19887f64dde75055cf8842fc4db2171eff45johnlev */
843e19887f64dde75055cf8842fc4db2171eff45johnlevtypedef uint32_t grant_ref_t;
843e19887f64dde75055cf8842fc4db2171eff45johnlev
843e19887f64dde75055cf8842fc4db2171eff45johnlev/*
843e19887f64dde75055cf8842fc4db2171eff45johnlev * Handle to track a mapping created via a grant reference.
843e19887f64dde75055cf8842fc4db2171eff45johnlev */
843e19887f64dde75055cf8842fc4db2171eff45johnlevtypedef uint32_t grant_handle_t;
843e19887f64dde75055cf8842fc4db2171eff45johnlev
843e19887f64dde75055cf8842fc4db2171eff45johnlev/*
843e19887f64dde75055cf8842fc4db2171eff45johnlev * GNTTABOP_map_grant_ref: Map the grant entry (<dom>,<ref>) for access
843e19887f64dde75055cf8842fc4db2171eff45johnlev * by devices and/or host CPUs. If successful, <handle> is a tracking number
843e19887f64dde75055cf8842fc4db2171eff45johnlev * that must be presented later to destroy the mapping(s). On error, <handle>
843e19887f64dde75055cf8842fc4db2171eff45johnlev * is a negative status code.
843e19887f64dde75055cf8842fc4db2171eff45johnlev * NOTES:
843e19887f64dde75055cf8842fc4db2171eff45johnlev * 1. If GNTMAP_device_map is specified then <dev_bus_addr> is the address
843e19887f64dde75055cf8842fc4db2171eff45johnlev * via which I/O devices may access the granted frame.
843e19887f64dde75055cf8842fc4db2171eff45johnlev * 2. If GNTMAP_host_map is specified then a mapping will be added at
843e19887f64dde75055cf8842fc4db2171eff45johnlev * either a host virtual address in the current address space, or at
843e19887f64dde75055cf8842fc4db2171eff45johnlev * a PTE at the specified machine address. The type of mapping to
843e19887f64dde75055cf8842fc4db2171eff45johnlev * perform is selected through the GNTMAP_contains_pte flag, and the
843e19887f64dde75055cf8842fc4db2171eff45johnlev * address is specified in <host_addr>.
843e19887f64dde75055cf8842fc4db2171eff45johnlev * 3. Mappings should only be destroyed via GNTTABOP_unmap_grant_ref. If a
843e19887f64dde75055cf8842fc4db2171eff45johnlev * host mapping is destroyed by other means then it is *NOT* guaranteed
843e19887f64dde75055cf8842fc4db2171eff45johnlev * to be accounted to the correct grant reference!
843e19887f64dde75055cf8842fc4db2171eff45johnlev */
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define GNTTABOP_map_grant_ref 0
843e19887f64dde75055cf8842fc4db2171eff45johnlevstruct gnttab_map_grant_ref {
843e19887f64dde75055cf8842fc4db2171eff45johnlev /* IN parameters. */
843e19887f64dde75055cf8842fc4db2171eff45johnlev uint64_t host_addr;
843e19887f64dde75055cf8842fc4db2171eff45johnlev uint32_t flags; /* GNTMAP_* */
843e19887f64dde75055cf8842fc4db2171eff45johnlev grant_ref_t ref;
843e19887f64dde75055cf8842fc4db2171eff45johnlev domid_t dom;
843e19887f64dde75055cf8842fc4db2171eff45johnlev /* OUT parameters. */
843e19887f64dde75055cf8842fc4db2171eff45johnlev int16_t status; /* GNTST_* */
843e19887f64dde75055cf8842fc4db2171eff45johnlev grant_handle_t handle;
843e19887f64dde75055cf8842fc4db2171eff45johnlev uint64_t dev_bus_addr;
843e19887f64dde75055cf8842fc4db2171eff45johnlev};
843e19887f64dde75055cf8842fc4db2171eff45johnlevtypedef struct gnttab_map_grant_ref gnttab_map_grant_ref_t;
843e19887f64dde75055cf8842fc4db2171eff45johnlevDEFINE_XEN_GUEST_HANDLE(gnttab_map_grant_ref_t);
843e19887f64dde75055cf8842fc4db2171eff45johnlev
843e19887f64dde75055cf8842fc4db2171eff45johnlev/*
843e19887f64dde75055cf8842fc4db2171eff45johnlev * GNTTABOP_unmap_grant_ref: Destroy one or more grant-reference mappings
843e19887f64dde75055cf8842fc4db2171eff45johnlev * tracked by <handle>. If <host_addr> or <dev_bus_addr> is zero, that
843e19887f64dde75055cf8842fc4db2171eff45johnlev * field is ignored. If non-zero, they must refer to a device/host mapping
843e19887f64dde75055cf8842fc4db2171eff45johnlev * that is tracked by <handle>
843e19887f64dde75055cf8842fc4db2171eff45johnlev * NOTES:
843e19887f64dde75055cf8842fc4db2171eff45johnlev * 1. The call may fail in an undefined manner if either mapping is not
843e19887f64dde75055cf8842fc4db2171eff45johnlev * tracked by <handle>.
843e19887f64dde75055cf8842fc4db2171eff45johnlev * 3. After executing a batch of unmaps, it is guaranteed that no stale
843e19887f64dde75055cf8842fc4db2171eff45johnlev * mappings will remain in the device or host TLBs.
843e19887f64dde75055cf8842fc4db2171eff45johnlev */
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define GNTTABOP_unmap_grant_ref 1
843e19887f64dde75055cf8842fc4db2171eff45johnlevstruct gnttab_unmap_grant_ref {
843e19887f64dde75055cf8842fc4db2171eff45johnlev /* IN parameters. */
843e19887f64dde75055cf8842fc4db2171eff45johnlev uint64_t host_addr;
843e19887f64dde75055cf8842fc4db2171eff45johnlev uint64_t dev_bus_addr;
843e19887f64dde75055cf8842fc4db2171eff45johnlev grant_handle_t handle;
843e19887f64dde75055cf8842fc4db2171eff45johnlev /* OUT parameters. */
843e19887f64dde75055cf8842fc4db2171eff45johnlev int16_t status; /* GNTST_* */
843e19887f64dde75055cf8842fc4db2171eff45johnlev};
843e19887f64dde75055cf8842fc4db2171eff45johnlevtypedef struct gnttab_unmap_grant_ref gnttab_unmap_grant_ref_t;
843e19887f64dde75055cf8842fc4db2171eff45johnlevDEFINE_XEN_GUEST_HANDLE(gnttab_unmap_grant_ref_t);
843e19887f64dde75055cf8842fc4db2171eff45johnlev
843e19887f64dde75055cf8842fc4db2171eff45johnlev/*
843e19887f64dde75055cf8842fc4db2171eff45johnlev * GNTTABOP_setup_table: Set up a grant table for <dom> comprising at least
843e19887f64dde75055cf8842fc4db2171eff45johnlev * <nr_frames> pages. The frame addresses are written to the <frame_list>.
843e19887f64dde75055cf8842fc4db2171eff45johnlev * Only <nr_frames> addresses are written, even if the table is larger.
843e19887f64dde75055cf8842fc4db2171eff45johnlev * NOTES:
843e19887f64dde75055cf8842fc4db2171eff45johnlev * 1. <dom> may be specified as DOMID_SELF.
843e19887f64dde75055cf8842fc4db2171eff45johnlev * 2. Only a sufficiently-privileged domain may specify <dom> != DOMID_SELF.
843e19887f64dde75055cf8842fc4db2171eff45johnlev * 3. Xen may not support more than a single grant-table page per domain.
843e19887f64dde75055cf8842fc4db2171eff45johnlev */
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define GNTTABOP_setup_table 2
843e19887f64dde75055cf8842fc4db2171eff45johnlevstruct gnttab_setup_table {
843e19887f64dde75055cf8842fc4db2171eff45johnlev /* IN parameters. */
843e19887f64dde75055cf8842fc4db2171eff45johnlev domid_t dom;
843e19887f64dde75055cf8842fc4db2171eff45johnlev uint32_t nr_frames;
843e19887f64dde75055cf8842fc4db2171eff45johnlev /* OUT parameters. */
843e19887f64dde75055cf8842fc4db2171eff45johnlev int16_t status; /* GNTST_* */
843e19887f64dde75055cf8842fc4db2171eff45johnlev XEN_GUEST_HANDLE(ulong) frame_list;
843e19887f64dde75055cf8842fc4db2171eff45johnlev};
843e19887f64dde75055cf8842fc4db2171eff45johnlevtypedef struct gnttab_setup_table gnttab_setup_table_t;
843e19887f64dde75055cf8842fc4db2171eff45johnlevDEFINE_XEN_GUEST_HANDLE(gnttab_setup_table_t);
843e19887f64dde75055cf8842fc4db2171eff45johnlev
843e19887f64dde75055cf8842fc4db2171eff45johnlev/*
843e19887f64dde75055cf8842fc4db2171eff45johnlev * GNTTABOP_dump_table: Dump the contents of the grant table to the
843e19887f64dde75055cf8842fc4db2171eff45johnlev * xen console. Debugging use only.
843e19887f64dde75055cf8842fc4db2171eff45johnlev */
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define GNTTABOP_dump_table 3
843e19887f64dde75055cf8842fc4db2171eff45johnlevstruct gnttab_dump_table {
843e19887f64dde75055cf8842fc4db2171eff45johnlev /* IN parameters. */
843e19887f64dde75055cf8842fc4db2171eff45johnlev domid_t dom;
843e19887f64dde75055cf8842fc4db2171eff45johnlev /* OUT parameters. */
843e19887f64dde75055cf8842fc4db2171eff45johnlev int16_t status; /* GNTST_* */
843e19887f64dde75055cf8842fc4db2171eff45johnlev};
843e19887f64dde75055cf8842fc4db2171eff45johnlevtypedef struct gnttab_dump_table gnttab_dump_table_t;
843e19887f64dde75055cf8842fc4db2171eff45johnlevDEFINE_XEN_GUEST_HANDLE(gnttab_dump_table_t);
843e19887f64dde75055cf8842fc4db2171eff45johnlev
843e19887f64dde75055cf8842fc4db2171eff45johnlev/*
843e19887f64dde75055cf8842fc4db2171eff45johnlev * GNTTABOP_transfer_grant_ref: Transfer <frame> to a foreign domain. The
843e19887f64dde75055cf8842fc4db2171eff45johnlev * foreign domain has previously registered its interest in the transfer via
843e19887f64dde75055cf8842fc4db2171eff45johnlev * <domid, ref>.
843e19887f64dde75055cf8842fc4db2171eff45johnlev *
843e19887f64dde75055cf8842fc4db2171eff45johnlev * Note that, even if the transfer fails, the specified page no longer belongs
843e19887f64dde75055cf8842fc4db2171eff45johnlev * to the calling domain *unless* the error is GNTST_bad_page.
843e19887f64dde75055cf8842fc4db2171eff45johnlev */
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define GNTTABOP_transfer 4
843e19887f64dde75055cf8842fc4db2171eff45johnlevstruct gnttab_transfer {
843e19887f64dde75055cf8842fc4db2171eff45johnlev /* IN parameters. */
843e19887f64dde75055cf8842fc4db2171eff45johnlev xen_pfn_t mfn;
843e19887f64dde75055cf8842fc4db2171eff45johnlev domid_t domid;
843e19887f64dde75055cf8842fc4db2171eff45johnlev grant_ref_t ref;
843e19887f64dde75055cf8842fc4db2171eff45johnlev /* OUT parameters. */
843e19887f64dde75055cf8842fc4db2171eff45johnlev int16_t status;
843e19887f64dde75055cf8842fc4db2171eff45johnlev};
843e19887f64dde75055cf8842fc4db2171eff45johnlevtypedef struct gnttab_transfer gnttab_transfer_t;
843e19887f64dde75055cf8842fc4db2171eff45johnlevDEFINE_XEN_GUEST_HANDLE(gnttab_transfer_t);
843e19887f64dde75055cf8842fc4db2171eff45johnlev
843e19887f64dde75055cf8842fc4db2171eff45johnlev
843e19887f64dde75055cf8842fc4db2171eff45johnlev/*
843e19887f64dde75055cf8842fc4db2171eff45johnlev * GNTTABOP_copy: Hypervisor based copy
843e19887f64dde75055cf8842fc4db2171eff45johnlev * source and destinations can be eithers MFNs or, for foreign domains,
843e19887f64dde75055cf8842fc4db2171eff45johnlev * grant references. the foreign domain has to grant read/write access
843e19887f64dde75055cf8842fc4db2171eff45johnlev * in its grant table.
843e19887f64dde75055cf8842fc4db2171eff45johnlev *
843e19887f64dde75055cf8842fc4db2171eff45johnlev * The flags specify what type source and destinations are (either MFN
843e19887f64dde75055cf8842fc4db2171eff45johnlev * or grant reference).
843e19887f64dde75055cf8842fc4db2171eff45johnlev *
843e19887f64dde75055cf8842fc4db2171eff45johnlev * Note that this can also be used to copy data between two domains
843e19887f64dde75055cf8842fc4db2171eff45johnlev * via a third party if the source and destination domains had previously
843e19887f64dde75055cf8842fc4db2171eff45johnlev * grant appropriate access to their pages to the third party.
843e19887f64dde75055cf8842fc4db2171eff45johnlev *
843e19887f64dde75055cf8842fc4db2171eff45johnlev * source_offset specifies an offset in the source frame, dest_offset
843e19887f64dde75055cf8842fc4db2171eff45johnlev * the offset in the target frame and len specifies the number of
843e19887f64dde75055cf8842fc4db2171eff45johnlev * bytes to be copied.
843e19887f64dde75055cf8842fc4db2171eff45johnlev */
843e19887f64dde75055cf8842fc4db2171eff45johnlev
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define _GNTCOPY_source_gref (0)
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define GNTCOPY_source_gref (1<<_GNTCOPY_source_gref)
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define _GNTCOPY_dest_gref (1)
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define GNTCOPY_dest_gref (1<<_GNTCOPY_dest_gref)
843e19887f64dde75055cf8842fc4db2171eff45johnlev
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define GNTTABOP_copy 5
843e19887f64dde75055cf8842fc4db2171eff45johnlevtypedef struct gnttab_copy {
843e19887f64dde75055cf8842fc4db2171eff45johnlev /* IN parameters. */
843e19887f64dde75055cf8842fc4db2171eff45johnlev struct {
843e19887f64dde75055cf8842fc4db2171eff45johnlev union {
843e19887f64dde75055cf8842fc4db2171eff45johnlev grant_ref_t ref;
843e19887f64dde75055cf8842fc4db2171eff45johnlev xen_pfn_t gmfn;
843e19887f64dde75055cf8842fc4db2171eff45johnlev } u;
843e19887f64dde75055cf8842fc4db2171eff45johnlev domid_t domid;
843e19887f64dde75055cf8842fc4db2171eff45johnlev uint16_t offset;
843e19887f64dde75055cf8842fc4db2171eff45johnlev } source, dest;
843e19887f64dde75055cf8842fc4db2171eff45johnlev uint16_t len;
843e19887f64dde75055cf8842fc4db2171eff45johnlev uint16_t flags; /* GNTCOPY_* */
843e19887f64dde75055cf8842fc4db2171eff45johnlev /* OUT parameters. */
843e19887f64dde75055cf8842fc4db2171eff45johnlev int16_t status;
843e19887f64dde75055cf8842fc4db2171eff45johnlev} gnttab_copy_t;
843e19887f64dde75055cf8842fc4db2171eff45johnlevDEFINE_XEN_GUEST_HANDLE(gnttab_copy_t);
843e19887f64dde75055cf8842fc4db2171eff45johnlev
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab/*
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab * GNTTABOP_query_size: Query the current and maximum sizes of the shared
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab * grant table.
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab * NOTES:
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab * 1. <dom> may be specified as DOMID_SELF.
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab * 2. Only a sufficiently-privileged domain may specify <dom> != DOMID_SELF.
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab */
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab#define GNTTABOP_query_size 6
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rabstruct gnttab_query_size {
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab /* IN parameters. */
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab domid_t dom;
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab /* OUT parameters. */
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab uint32_t nr_frames;
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab uint32_t max_nr_frames;
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab int16_t status; /* GNTST_* */
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab};
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rabtypedef struct gnttab_query_size gnttab_query_size_t;
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rabDEFINE_XEN_GUEST_HANDLE(gnttab_query_size_t);
a576ab5b6e08c47732b3dedca9eaa8a8cbb85720rab
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee/*
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee * GNTTABOP_unmap_and_replace: Destroy one or more grant-reference mappings
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee * tracked by <handle> but atomically replace the page table entry with one
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee * pointing to the machine address under <new_addr>. <new_addr> will be
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee * redirected to the null entry.
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee * NOTES:
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee * 1. The call may fail in an undefined manner if either mapping is not
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee * tracked by <handle>.
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee * 2. After executing a batch of unmaps, it is guaranteed that no stale
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee * mappings will remain in the device or host TLBs.
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee */
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee#define GNTTABOP_unmap_and_replace 7
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybeestruct gnttab_unmap_and_replace {
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee /* IN parameters. */
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee uint64_t host_addr;
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee uint64_t new_addr;
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee grant_handle_t handle;
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee /* OUT parameters. */
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee int16_t status; /* GNTST_* */
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee};
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybeetypedef struct gnttab_unmap_and_replace gnttab_unmap_and_replace_t;
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart MaybeeDEFINE_XEN_GUEST_HANDLE(gnttab_unmap_and_replace_t);
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee
843e19887f64dde75055cf8842fc4db2171eff45johnlev
843e19887f64dde75055cf8842fc4db2171eff45johnlev/*
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee * Bitfield values for gnttab_map_grant_ref.flags.
843e19887f64dde75055cf8842fc4db2171eff45johnlev */
843e19887f64dde75055cf8842fc4db2171eff45johnlev /* Map the grant entry for access by I/O devices. */
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define _GNTMAP_device_map (0)
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define GNTMAP_device_map (1<<_GNTMAP_device_map)
843e19887f64dde75055cf8842fc4db2171eff45johnlev /* Map the grant entry for access by host CPUs. */
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define _GNTMAP_host_map (1)
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define GNTMAP_host_map (1<<_GNTMAP_host_map)
843e19887f64dde75055cf8842fc4db2171eff45johnlev /* Accesses to the granted frame will be restricted to read-only access. */
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define _GNTMAP_readonly (2)
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define GNTMAP_readonly (1<<_GNTMAP_readonly)
843e19887f64dde75055cf8842fc4db2171eff45johnlev /*
843e19887f64dde75055cf8842fc4db2171eff45johnlev * GNTMAP_host_map subflag:
843e19887f64dde75055cf8842fc4db2171eff45johnlev * 0 => The host mapping is usable only by the guest OS.
843e19887f64dde75055cf8842fc4db2171eff45johnlev * 1 => The host mapping is usable by guest OS + current application.
843e19887f64dde75055cf8842fc4db2171eff45johnlev */
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define _GNTMAP_application_map (3)
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define GNTMAP_application_map (1<<_GNTMAP_application_map)
843e19887f64dde75055cf8842fc4db2171eff45johnlev
843e19887f64dde75055cf8842fc4db2171eff45johnlev /*
843e19887f64dde75055cf8842fc4db2171eff45johnlev * GNTMAP_contains_pte subflag:
843e19887f64dde75055cf8842fc4db2171eff45johnlev * 0 => This map request contains a host virtual address.
843e19887f64dde75055cf8842fc4db2171eff45johnlev * 1 => This map request contains the machine addess of the PTE to update.
843e19887f64dde75055cf8842fc4db2171eff45johnlev */
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define _GNTMAP_contains_pte (4)
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define GNTMAP_contains_pte (1<<_GNTMAP_contains_pte)
843e19887f64dde75055cf8842fc4db2171eff45johnlev
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee/*
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee * Bits to be placed in guest kernel available PTE bits (architecture
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee * dependent; only supported when XENFEAT_gnttab_map_avail_bits is set).
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee */
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee#define _GNTMAP_guest_avail0 (16)
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee#define GNTMAP_guest_avail_mask ((uint32_t)~0 << _GNTMAP_guest_avail0)
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee
843e19887f64dde75055cf8842fc4db2171eff45johnlev/*
843e19887f64dde75055cf8842fc4db2171eff45johnlev * Values for error status returns. All errors are -ve.
843e19887f64dde75055cf8842fc4db2171eff45johnlev */
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define GNTST_okay (0) /* Normal return. */
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define GNTST_general_error (-1) /* General undefined error. */
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define GNTST_bad_domain (-2) /* Unrecognsed domain id. */
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define GNTST_bad_gntref (-3) /* Unrecognised or inappropriate gntref. */
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define GNTST_bad_handle (-4) /* Unrecognised or inappropriate handle. */
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define GNTST_bad_virt_addr (-5) /* Inappropriate virtual address to map. */
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define GNTST_bad_dev_addr (-6) /* Inappropriate device address to unmap.*/
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define GNTST_no_device_space (-7) /* Out of space in I/O MMU. */
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define GNTST_permission_denied (-8) /* Not enough privilege for operation. */
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define GNTST_bad_page (-9) /* Specified page was invalid for op. */
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee#define GNTST_bad_copy_arg (-10) /* copy arguments cross page boundary. */
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee#define GNTST_address_too_big (-11) /* transfer page address too large. */
843e19887f64dde75055cf8842fc4db2171eff45johnlev
843e19887f64dde75055cf8842fc4db2171eff45johnlev#define GNTTABOP_error_msgs { \
843e19887f64dde75055cf8842fc4db2171eff45johnlev "okay", \
843e19887f64dde75055cf8842fc4db2171eff45johnlev "undefined error", \
843e19887f64dde75055cf8842fc4db2171eff45johnlev "unrecognised domain id", \
843e19887f64dde75055cf8842fc4db2171eff45johnlev "invalid grant reference", \
843e19887f64dde75055cf8842fc4db2171eff45johnlev "invalid mapping handle", \
843e19887f64dde75055cf8842fc4db2171eff45johnlev "invalid virtual address", \
843e19887f64dde75055cf8842fc4db2171eff45johnlev "invalid device address", \
843e19887f64dde75055cf8842fc4db2171eff45johnlev "no spare translation slot in the I/O MMU", \
843e19887f64dde75055cf8842fc4db2171eff45johnlev "permission denied", \
843e19887f64dde75055cf8842fc4db2171eff45johnlev "bad page", \
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee "copy arguments cross page boundary", \
349b53dd4e695e3d833b5380540385145b2d3ae8Stuart Maybee "page address size too large" \
843e19887f64dde75055cf8842fc4db2171eff45johnlev}
843e19887f64dde75055cf8842fc4db2171eff45johnlev
843e19887f64dde75055cf8842fc4db2171eff45johnlev#endif /* __XEN_PUBLIC_GRANT_TABLE_H__ */
843e19887f64dde75055cf8842fc4db2171eff45johnlev
843e19887f64dde75055cf8842fc4db2171eff45johnlev/*
843e19887f64dde75055cf8842fc4db2171eff45johnlev * Local variables:
843e19887f64dde75055cf8842fc4db2171eff45johnlev * mode: C
843e19887f64dde75055cf8842fc4db2171eff45johnlev * c-set-style: "BSD"
843e19887f64dde75055cf8842fc4db2171eff45johnlev * c-basic-offset: 4
843e19887f64dde75055cf8842fc4db2171eff45johnlev * tab-width: 4
843e19887f64dde75055cf8842fc4db2171eff45johnlev * indent-tabs-mode: nil
843e19887f64dde75055cf8842fc4db2171eff45johnlev * End:
843e19887f64dde75055cf8842fc4db2171eff45johnlev */