[deliverable/linux.git] / include / xen / interface / vcpu.h

/******************************************************************************
 * vcpu.h
 *
 * VCPU initialisation, query, and hotplug.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 *
 * Copyright (c) 2005, Keir Fraser <keir@xensource.com>
 */

#ifndef __XEN_PUBLIC_VCPU_H__
#define __XEN_PUBLIC_VCPU_H__

/*
 * Prototype for this hypercall is:
 *	int vcpu_op(int cmd, int vcpuid, void *extra_args)
 * @cmd		   == VCPUOP_??? (VCPU operation).
 * @vcpuid	   == VCPU to operate on.
 * @extra_args == Operation-specific extra arguments (NULL if none).
 */

/*
 * Initialise a VCPU. Each VCPU can be initialised only once. A
 * newly-initialised VCPU will not run until it is brought up by VCPUOP_up.
 *
 * @extra_arg == pointer to vcpu_guest_context structure containing initial
 *				 state for the VCPU.
 */
#define VCPUOP_initialise			 0

/*
 * Bring up a VCPU. This makes the VCPU runnable. This operation will fail
 * if the VCPU has not been initialised (VCPUOP_initialise).
 */
#define VCPUOP_up					 1

/*
 * Bring down a VCPU (i.e., make it non-runnable).
 * There are a few caveats that callers should observe:
 *	1. This operation may return, and VCPU_is_up may return false, before the
 *	   VCPU stops running (i.e., the command is asynchronous). It is a good
 *	   idea to ensure that the VCPU has entered a non-critical loop before
 *	   bringing it down. Alternatively, this operation is guaranteed
 *	   synchronous if invoked by the VCPU itself.
 *	2. After a VCPU is initialised, there is currently no way to drop all its
 *	   references to domain memory. Even a VCPU that is down still holds
 *	   memory references via its pagetable base pointer and GDT. It is good
 *	   practise to move a VCPU onto an 'idle' or default page table, LDT and
 *	   GDT before bringing it down.
 */
#define VCPUOP_down					 2

/* Returns 1 if the given VCPU is up. */
#define VCPUOP_is_up				 3

/*
 * Return information about the state and running time of a VCPU.
 * @extra_arg == pointer to vcpu_runstate_info structure.
 */
#define VCPUOP_get_runstate_info	 4
struct vcpu_runstate_info {
	/* VCPU's current state (RUNSTATE_*). */
	int		 state;
	/* When was current state entered (system time, ns)? */
	uint64_t state_entry_time;
	/*
	 * Update indicator set in state_entry_time:
	 * When activated via VMASST_TYPE_runstate_update_flag, set during
	 * updates in guest memory mapped copy of vcpu_runstate_info.
	 */
#define XEN_RUNSTATE_UPDATE	(1ULL << 63)
	/*
	 * Time spent in each RUNSTATE_* (ns). The sum of these times is
	 * guaranteed not to drift from system time.
	 */
	uint64_t time[4];
};
DEFINE_GUEST_HANDLE_STRUCT(vcpu_runstate_info);

/* VCPU is currently running on a physical CPU. */
#define RUNSTATE_running  0

/* VCPU is runnable, but not currently scheduled on any physical CPU. */
#define RUNSTATE_runnable 1

/* VCPU is blocked (a.k.a. idle). It is therefore not runnable. */
#define RUNSTATE_blocked  2

/*
 * VCPU is not runnable, but it is not blocked.
 * This is a 'catch all' state for things like hotplug and pauses by the
 * system administrator (or for critical sections in the hypervisor).
 * RUNSTATE_blocked dominates this state (it is the preferred state).
 */
#define RUNSTATE_offline  3

/*
 * Register a shared memory area from which the guest may obtain its own
 * runstate information without needing to execute a hypercall.
 * Notes:
 *	1. The registered address may be virtual or physical, depending on the
 *	   platform. The virtual address should be registered on x86 systems.
 *	2. Only one shared area may be registered per VCPU. The shared area is
 *	   updated by the hypervisor each time the VCPU is scheduled. Thus
 *	   runstate.state will always be RUNSTATE_running and
 *	   runstate.state_entry_time will indicate the system time at which the
 *	   VCPU was last scheduled to run.
 * @extra_arg == pointer to vcpu_register_runstate_memory_area structure.
 */
#define VCPUOP_register_runstate_memory_area 5
struct vcpu_register_runstate_memory_area {
		union {
				GUEST_HANDLE(vcpu_runstate_info) h;
				struct vcpu_runstate_info *v;
				uint64_t p;
		} addr;
};

/*
 * Set or stop a VCPU's periodic timer. Every VCPU has one periodic timer
 * which can be set via these commands. Periods smaller than one millisecond
 * may not be supported.
 */
#define VCPUOP_set_periodic_timer	 6 /* arg == vcpu_set_periodic_timer_t */
#define VCPUOP_stop_periodic_timer	 7 /* arg == NULL */
struct vcpu_set_periodic_timer {
		uint64_t period_ns;
};
DEFINE_GUEST_HANDLE_STRUCT(vcpu_set_periodic_timer);

/*
 * Set or stop a VCPU's single-shot timer. Every VCPU has one single-shot
 * timer which can be set via these commands.
 */
#define VCPUOP_set_singleshot_timer	 8 /* arg == vcpu_set_singleshot_timer_t */
#define VCPUOP_stop_singleshot_timer 9 /* arg == NULL */
struct vcpu_set_singleshot_timer {
		uint64_t timeout_abs_ns;
		uint32_t flags;			   /* VCPU_SSHOTTMR_??? */
};
DEFINE_GUEST_HANDLE_STRUCT(vcpu_set_singleshot_timer);

/* Flags to VCPUOP_set_singleshot_timer. */
 /* Require the timeout to be in the future (return -ETIME if it's passed). */
#define _VCPU_SSHOTTMR_future (0)
#define VCPU_SSHOTTMR_future  (1U << _VCPU_SSHOTTMR_future)

/*
 * Register a memory location in the guest address space for the
 * vcpu_info structure.  This allows the guest to place the vcpu_info
 * structure in a convenient place, such as in a per-cpu data area.
 * The pointer need not be page aligned, but the structure must not
 * cross a page boundary.
 */
#define VCPUOP_register_vcpu_info   10  /* arg == struct vcpu_info */
struct vcpu_register_vcpu_info {
    uint64_t mfn;    /* mfn of page to place vcpu_info */
    uint32_t offset; /* offset within page */
    uint32_t rsvd;   /* unused */
};
DEFINE_GUEST_HANDLE_STRUCT(vcpu_register_vcpu_info);

/* Send an NMI to the specified VCPU. @extra_arg == NULL. */
#define VCPUOP_send_nmi             11
#endif /* __XEN_PUBLIC_VCPU_H__ */
Commit	Line	Data
a42089dd JF	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	/*
	31	* Prototype for this hypercall is:
	32	* int vcpu_op(int cmd, int vcpuid, void *extra_args)
	33	* @cmd == VCPUOP_??? (VCPU operation).
	34	* @vcpuid == VCPU to operate on.
	35	* @extra_args == Operation-specific extra arguments (NULL if none).
	36	*/
	37
	38	/*
	39	* Initialise a VCPU. Each VCPU can be initialised only once. A
	40	* newly-initialised VCPU will not run until it is brought up by VCPUOP_up.
	41	*
	42	* @extra_arg == pointer to vcpu_guest_context structure containing initial
	43	* state for the VCPU.
	44	*/
	45	#define VCPUOP_initialise 0
	46
	47	/*
	48	* Bring up a VCPU. This makes the VCPU runnable. This operation will fail
	49	* if the VCPU has not been initialised (VCPUOP_initialise).
	50	*/
	51	#define VCPUOP_up 1
	52
	53	/*
	54	* Bring down a VCPU (i.e., make it non-runnable).
	55	* There are a few caveats that callers should observe:
	56	* 1. This operation may return, and VCPU_is_up may return false, before the
	57	* VCPU stops running (i.e., the command is asynchronous). It is a good
	58	* idea to ensure that the VCPU has entered a non-critical loop before
	59	* bringing it down. Alternatively, this operation is guaranteed
	60	* synchronous if invoked by the VCPU itself.
	61	* 2. After a VCPU is initialised, there is currently no way to drop all its
	62	* references to domain memory. Even a VCPU that is down still holds
	63	* memory references via its pagetable base pointer and GDT. It is good
	64	* practise to move a VCPU onto an 'idle' or default page table, LDT and
65	* GDT before bringing it down.
66	*/
67	#define VCPUOP_down 2
68
69	/* Returns 1 if the given VCPU is up. */
70	#define VCPUOP_is_up 3
71
72	/*
73	* Return information about the state and running time of a VCPU.
74	* @extra_arg == pointer to vcpu_runstate_info structure.
75	*/
76	#define VCPUOP_get_runstate_info 4
77	struct vcpu_runstate_info {
7ba8dba9 JG	78	/* VCPU's current state (RUNSTATE_). /
	79	int state;
	80	/* When was current state entered (system time, ns)? */
	81	uint64_t state_entry_time;
	82	/*
	83	* Update indicator set in state_entry_time:
	84	* When activated via VMASST_TYPE_runstate_update_flag, set during
	85	* updates in guest memory mapped copy of vcpu_runstate_info.
	86	*/
	87	#define XEN_RUNSTATE_UPDATE (1ULL << 63)
	88	/*
	89	* Time spent in each RUNSTATE_* (ns). The sum of these times is
	90	* guaranteed not to drift from system time.
	91	*/
	92	uint64_t time[4];
a42089dd	93	};
27244269	94	DEFINE_GUEST_HANDLE_STRUCT(vcpu_runstate_info);
a42089dd JF	95
	96	/* VCPU is currently running on a physical CPU. */
	97	#define RUNSTATE_running 0
	98
	99	/* VCPU is runnable, but not currently scheduled on any physical CPU. */
	100	#define RUNSTATE_runnable 1
	101
	102	/* VCPU is blocked (a.k.a. idle). It is therefore not runnable. */
	103	#define RUNSTATE_blocked 2
	104
	105	/*
	106	* VCPU is not runnable, but it is not blocked.
	107	* This is a 'catch all' state for things like hotplug and pauses by the
	108	* system administrator (or for critical sections in the hypervisor).
	109	* RUNSTATE_blocked dominates this state (it is the preferred state).
	110	*/
	111	#define RUNSTATE_offline 3
	112
	113	/*
	114	* Register a shared memory area from which the guest may obtain its own
	115	* runstate information without needing to execute a hypercall.
	116	* Notes:
	117	* 1. The registered address may be virtual or physical, depending on the
	118	* platform. The virtual address should be registered on x86 systems.
	119	* 2. Only one shared area may be registered per VCPU. The shared area is
	120	* updated by the hypervisor each time the VCPU is scheduled. Thus
	121	* runstate.state will always be RUNSTATE_running and
	122	* runstate.state_entry_time will indicate the system time at which the
	123	* VCPU was last scheduled to run.
	124	* @extra_arg == pointer to vcpu_register_runstate_memory_area structure.
	125	*/
	126	#define VCPUOP_register_runstate_memory_area 5
	127	struct vcpu_register_runstate_memory_area {
	128	union {
27244269	129	GUEST_HANDLE(vcpu_runstate_info) h;
a42089dd JF	130	struct vcpu_runstate_info *v;
	131	uint64_t p;
	132	} addr;
	133	};
	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	};
27244269	145	DEFINE_GUEST_HANDLE_STRUCT(vcpu_set_periodic_timer);
a42089dd JF	146
	147	/*
	148	* Set or stop a VCPU's single-shot timer. Every VCPU has one single-shot
	149	* timer which can be set via these commands.
	150	*/
	151	#define VCPUOP_set_singleshot_timer 8 /* arg == vcpu_set_singleshot_timer_t */
	152	#define VCPUOP_stop_singleshot_timer 9 /* arg == NULL */
	153	struct vcpu_set_singleshot_timer {
	154	uint64_t timeout_abs_ns;
	155	uint32_t flags; /* VCPU_SSHOTTMR_??? */
	156	};
27244269	157	DEFINE_GUEST_HANDLE_STRUCT(vcpu_set_singleshot_timer);
a42089dd JF	158
	159	/* Flags to VCPUOP_set_singleshot_timer. */
	160	/* Require the timeout to be in the future (return -ETIME if it's passed). */
	161	#define _VCPU_SSHOTTMR_future (0)
	162	#define VCPU_SSHOTTMR_future (1U << _VCPU_SSHOTTMR_future)
	163
60223a32 JF	164	/*
	165	* Register a memory location in the guest address space for the
	166	* vcpu_info structure. This allows the guest to place the vcpu_info
	167	* structure in a convenient place, such as in a per-cpu data area.
	168	* The pointer need not be page aligned, but the structure must not
	169	* cross a page boundary.
	170	*/
	171	#define VCPUOP_register_vcpu_info 10 /* arg == struct vcpu_info */
	172	struct vcpu_register_vcpu_info {
e3d26976 JF	173	uint64_t mfn; /* mfn of page to place vcpu_info */
	174	uint32_t offset; /* offset within page */
	175	uint32_t rsvd; /* unused */
60223a32	176	};
27244269	177	DEFINE_GUEST_HANDLE_STRUCT(vcpu_register_vcpu_info);
60223a32	178
6efa20e4 KRW	179	/* Send an NMI to the specified VCPU. @extra_arg == NULL. */
6efa20e4 KRW	180	#define VCPUOP_send_nmi 11
a42089dd	181	#endif /* __XEN_PUBLIC_VCPU_H__ */