The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/xen/interface/vcpu.h

Version: -  FREEBSD  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-2  -  FREEBSD-11-1  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-4  -  FREEBSD-10-3  -  FREEBSD-10-2  -  FREEBSD-10-1  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-3  -  FREEBSD-9-2  -  FREEBSD-9-1  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-4  -  FREEBSD-8-3  -  FREEBSD-8-2  -  FREEBSD-8-1  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-4  -  FREEBSD-7-3  -  FREEBSD-7-2  -  FREEBSD-7-1  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-4  -  FREEBSD-6-3  -  FREEBSD-6-2  -  FREEBSD-6-1  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-5  -  FREEBSD-5-4  -  FREEBSD-5-3  -  FREEBSD-5-2  -  FREEBSD-5-1  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
SearchContext: -  none  -  3  -  10 

    1 /******************************************************************************
    2  * vcpu.h
    3  * 
    4  * VCPU initialisation, query, and hotplug.
    5  * 
    6  * Permission is hereby granted, free of charge, to any person obtaining a copy
    7  * of this software and associated documentation files (the "Software"), to
    8  * deal in the Software without restriction, including without limitation the
    9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
   10  * sell copies of the Software, and to permit persons to whom the Software is
   11  * furnished to do so, subject to the following conditions:
   12  *
   13  * The above copyright notice and this permission notice shall be included in
   14  * all copies or substantial portions of the Software.
   15  *
   16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
   19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
   20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
   21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
   22  * DEALINGS IN THE SOFTWARE.
   23  *
   24  * Copyright (c) 2005, Keir Fraser <keir@xensource.com>
   25  */
   26 
   27 #ifndef __XEN_PUBLIC_VCPU_H__
   28 #define __XEN_PUBLIC_VCPU_H__
   29 
   30 #include "xen.h"
   31 
   32 /*
   33  * Prototype for this hypercall is:
   34  *  int vcpu_op(int cmd, int vcpuid, void *extra_args)
   35  * @cmd        == VCPUOP_??? (VCPU operation).
   36  * @vcpuid     == VCPU to operate on.
   37  * @extra_args == Operation-specific extra arguments (NULL if none).
   38  */
   39 
   40 /*
   41  * Initialise a VCPU. Each VCPU can be initialised only once. A 
   42  * newly-initialised VCPU will not run until it is brought up by VCPUOP_up.
   43  * 
   44  * @extra_arg == pointer to vcpu_guest_context structure containing initial
   45  *               state for the VCPU.
   46  */
   47 #define VCPUOP_initialise            0
   48 
   49 /*
   50  * Bring up a VCPU. This makes the VCPU runnable. This operation will fail
   51  * if the VCPU has not been initialised (VCPUOP_initialise).
   52  */
   53 #define VCPUOP_up                    1
   54 
   55 /*
   56  * Bring down a VCPU (i.e., make it non-runnable).
   57  * There are a few caveats that callers should observe:
   58  *  1. This operation may return, and VCPU_is_up may return false, before the
   59  *     VCPU stops running (i.e., the command is asynchronous). It is a good
   60  *     idea to ensure that the VCPU has entered a non-critical loop before
   61  *     bringing it down. Alternatively, this operation is guaranteed
   62  *     synchronous if invoked by the VCPU itself.
   63  *  2. After a VCPU is initialised, there is currently no way to drop all its
   64  *     references to domain memory. Even a VCPU that is down still holds
   65  *     memory references via its pagetable base pointer and GDT. It is good
   66  *     practise to move a VCPU onto an 'idle' or default page table, LDT and
   67  *     GDT before bringing it down.
   68  */
   69 #define VCPUOP_down                  2
   70 
   71 /* Returns 1 if the given VCPU is up. */
   72 #define VCPUOP_is_up                 3
   73 
   74 /*
   75  * Return information about the state and running time of a VCPU.
   76  * @extra_arg == pointer to vcpu_runstate_info structure.
   77  */
   78 #define VCPUOP_get_runstate_info     4
   79 struct vcpu_runstate_info {
   80     /* VCPU's current state (RUNSTATE_*). */
   81     int      state;
   82     /* When was current state entered (system time, ns)? */
   83     uint64_t state_entry_time;
   84     /*
   85      * Time spent in each RUNSTATE_* (ns). The sum of these times is
   86      * guaranteed not to drift from system time.
   87      */
   88     uint64_t time[4];
   89 };
   90 typedef struct vcpu_runstate_info vcpu_runstate_info_t;
   91 DEFINE_XEN_GUEST_HANDLE(vcpu_runstate_info_t);
   92 
   93 /* VCPU is currently running on a physical CPU. */
   94 #define RUNSTATE_running  0
   95 
   96 /* VCPU is runnable, but not currently scheduled on any physical CPU. */
   97 #define RUNSTATE_runnable 1
   98 
   99 /* VCPU is blocked (a.k.a. idle). It is therefore not runnable. */
  100 #define RUNSTATE_blocked  2
  101 
  102 /*
  103  * VCPU is not runnable, but it is not blocked.
  104  * This is a 'catch all' state for things like hotplug and pauses by the
  105  * system administrator (or for critical sections in the hypervisor).
  106  * RUNSTATE_blocked dominates this state (it is the preferred state).
  107  */
  108 #define RUNSTATE_offline  3
  109 
  110 /*
  111  * Register a shared memory area from which the guest may obtain its own
  112  * runstate information without needing to execute a hypercall.
  113  * Notes:
  114  *  1. The registered address may be virtual or physical or guest handle,
  115  *     depending on the platform. Virtual address or guest handle should be
  116  *     registered on x86 systems.
  117  *  2. Only one shared area may be registered per VCPU. The shared area is
  118  *     updated by the hypervisor each time the VCPU is scheduled. Thus
  119  *     runstate.state will always be RUNSTATE_running and
  120  *     runstate.state_entry_time will indicate the system time at which the
  121  *     VCPU was last scheduled to run.
  122  * @extra_arg == pointer to vcpu_register_runstate_memory_area structure.
  123  */
  124 #define VCPUOP_register_runstate_memory_area 5
  125 struct vcpu_register_runstate_memory_area {
  126     union {
  127         XEN_GUEST_HANDLE(vcpu_runstate_info_t) h;
  128         struct vcpu_runstate_info *v;
  129         uint64_t p;
  130     } addr;
  131 };
  132 typedef struct vcpu_register_runstate_memory_area vcpu_register_runstate_memory_area_t;
  133 DEFINE_XEN_GUEST_HANDLE(vcpu_register_runstate_memory_area_t);
  134 
  135 /*
  136  * Set or stop a VCPU's periodic timer. Every VCPU has one periodic timer
  137  * which can be set via these commands. Periods smaller than one millisecond
  138  * may not be supported.
  139  */
  140 #define VCPUOP_set_periodic_timer    6 /* arg == vcpu_set_periodic_timer_t */
  141 #define VCPUOP_stop_periodic_timer   7 /* arg == NULL */
  142 struct vcpu_set_periodic_timer {
  143     uint64_t period_ns;
  144 };
  145 typedef struct vcpu_set_periodic_timer vcpu_set_periodic_timer_t;
  146 DEFINE_XEN_GUEST_HANDLE(vcpu_set_periodic_timer_t);
  147 
  148 /*
  149  * Set or stop a VCPU's single-shot timer. Every VCPU has one single-shot
  150  * timer which can be set via these commands.
  151  */
  152 #define VCPUOP_set_singleshot_timer  8 /* arg == vcpu_set_singleshot_timer_t */
  153 #define VCPUOP_stop_singleshot_timer 9 /* arg == NULL */
  154 struct vcpu_set_singleshot_timer {
  155     uint64_t timeout_abs_ns;   /* Absolute system time value in nanoseconds. */
  156     uint32_t flags;            /* VCPU_SSHOTTMR_??? */
  157 };
  158 typedef struct vcpu_set_singleshot_timer vcpu_set_singleshot_timer_t;
  159 DEFINE_XEN_GUEST_HANDLE(vcpu_set_singleshot_timer_t);
  160 
  161 /* Flags to VCPUOP_set_singleshot_timer. */
  162  /* Require the timeout to be in the future (return -ETIME if it's passed). */
  163 #define _VCPU_SSHOTTMR_future (0)
  164 #define VCPU_SSHOTTMR_future  (1U << _VCPU_SSHOTTMR_future)
  165 
  166 /* 
  167  * Register a memory location in the guest address space for the
  168  * vcpu_info structure.  This allows the guest to place the vcpu_info
  169  * structure in a convenient place, such as in a per-cpu data area.
  170  * The pointer need not be page aligned, but the structure must not
  171  * cross a page boundary.
  172  *
  173  * This may be called only once per vcpu.
  174  */
  175 #define VCPUOP_register_vcpu_info   10  /* arg == vcpu_register_vcpu_info_t */
  176 struct vcpu_register_vcpu_info {
  177     uint64_t mfn;    /* mfn of page to place vcpu_info */
  178     uint32_t offset; /* offset within page */
  179     uint32_t rsvd;   /* unused */
  180 };
  181 typedef struct vcpu_register_vcpu_info vcpu_register_vcpu_info_t;
  182 DEFINE_XEN_GUEST_HANDLE(vcpu_register_vcpu_info_t);
  183 
  184 /* Send an NMI to the specified VCPU. @extra_arg == NULL. */
  185 #define VCPUOP_send_nmi             11
  186 
  187 /* 
  188  * Get the physical ID information for a pinned vcpu's underlying physical
  189  * processor.  The physical ID informmation is architecture-specific.
  190  * On x86: id[31:0]=apic_id, id[63:32]=acpi_id.
  191  * This command returns -EINVAL if it is not a valid operation for this VCPU.
  192  */
  193 #define VCPUOP_get_physid           12 /* arg == vcpu_get_physid_t */
  194 struct vcpu_get_physid {
  195     uint64_t phys_id;
  196 };
  197 typedef struct vcpu_get_physid vcpu_get_physid_t;
  198 DEFINE_XEN_GUEST_HANDLE(vcpu_get_physid_t);
  199 #define xen_vcpu_physid_to_x86_apicid(physid) ((uint32_t)(physid))
  200 #define xen_vcpu_physid_to_x86_acpiid(physid) ((uint32_t)((physid) >> 32))
  201 
  202 /* 
  203  * Register a memory location to get a secondary copy of the vcpu time
  204  * parameters.  The master copy still exists as part of the vcpu shared
  205  * memory area, and this secondary copy is updated whenever the master copy
  206  * is updated (and using the same versioning scheme for synchronisation).
  207  *
  208  * The intent is that this copy may be mapped (RO) into userspace so
  209  * that usermode can compute system time using the time info and the
  210  * tsc.  Usermode will see an array of vcpu_time_info structures, one
  211  * for each vcpu, and choose the right one by an existing mechanism
  212  * which allows it to get the current vcpu number (such as via a
  213  * segment limit).  It can then apply the normal algorithm to compute
  214  * system time from the tsc.
  215  *
  216  * @extra_arg == pointer to vcpu_register_time_info_memory_area structure.
  217  */
  218 #define VCPUOP_register_vcpu_time_memory_area   13
  219 DEFINE_XEN_GUEST_HANDLE(vcpu_time_info_t);
  220 struct vcpu_register_time_memory_area {
  221     union {
  222         XEN_GUEST_HANDLE(vcpu_time_info_t) h;
  223         struct vcpu_time_info *v;
  224         uint64_t p;
  225     } addr;
  226 };
  227 typedef struct vcpu_register_time_memory_area vcpu_register_time_memory_area_t;
  228 DEFINE_XEN_GUEST_HANDLE(vcpu_register_time_memory_area_t);
  229 
  230 #endif /* __XEN_PUBLIC_VCPU_H__ */
  231 
  232 /*
  233  * Local variables:
  234  * mode: C
  235  * c-set-style: "BSD"
  236  * c-basic-offset: 4
  237  * tab-width: 4
  238  * indent-tabs-mode: nil
  239  * End:
  240  */

Cache object: 2e48801233da03fb38499404ddc37d18


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.