1 /******************************************************************************
4 * Scheduler state interactions
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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.
24 * Copyright (c) 2005, Keir Fraser <keir@xensource.com>
27 #ifndef __XEN_PUBLIC_SCHED_H__
28 #define __XEN_PUBLIC_SCHED_H__
30 #include "event_channel.h"
33 * `incontents 150 sched Guest Scheduler Operations
35 * The SCHEDOP interface provides mechanisms for a guest to interact
36 * with the scheduler, including yield, blocking and shutting itself
41 * The prototype for this hypercall is:
42 * ` long HYPERVISOR_sched_op(enum sched_op cmd, void *arg, ...)
44 * @cmd == SCHEDOP_??? (scheduler operation).
45 * @arg == Operation-specific extra argument(s), as described below.
46 * ... == Additional Operation-specific extra arguments, described below.
48 * Versions of Xen prior to 3.0.2 provided only the following legacy version
49 * of this hypercall, supporting only the commands yield, block and shutdown:
50 * long sched_op(int cmd, unsigned long arg)
51 * @cmd == SCHEDOP_??? (scheduler operation).
52 * @arg == 0 (SCHEDOP_yield and SCHEDOP_block)
53 * == SHUTDOWN_* code (SCHEDOP_shutdown)
55 * This legacy version is available to new guests as:
56 * ` long HYPERVISOR_sched_op_compat(enum sched_op cmd, unsigned long arg)
59 /* ` enum sched_op { // SCHEDOP_* => struct sched_* */
61 * Voluntarily yield the CPU.
64 #define SCHEDOP_yield 0
67 * Block execution of this VCPU until an event is received for processing.
68 * If called with event upcalls masked, this operation will atomically
69 * reenable event delivery and check for pending events before blocking the
70 * VCPU. This avoids a "wakeup waiting" race.
73 #define SCHEDOP_block 1
76 * Halt execution of this domain (all VCPUs) and notify the system controller.
77 * @arg == pointer to sched_shutdown_t structure.
79 * If the sched_shutdown_t reason is SHUTDOWN_suspend then
80 * x86 PV guests must also set RDX (EDX for 32-bit guests) to the MFN
81 * of the guest's start info page. RDX/EDX is the third hypercall
84 * In addition, which reason is SHUTDOWN_suspend this hypercall
85 * returns 1 if suspend was cancelled or the domain was merely
86 * checkpointed, and 0 if it is resuming in a new domain.
88 #define SCHEDOP_shutdown 2
91 * Poll a set of event-channel ports. Return when one or more are pending. An
92 * optional timeout may be specified.
93 * @arg == pointer to sched_poll_t structure.
95 #define SCHEDOP_poll 3
98 * Declare a shutdown for another domain. The main use of this function is
99 * in interpreting shutdown requests and reasons for fully-virtualized
100 * domains. A para-virtualized domain may use SCHEDOP_shutdown directly.
101 * @arg == pointer to sched_remote_shutdown_t structure.
103 #define SCHEDOP_remote_shutdown 4
106 * Latch a shutdown code, so that when the domain later shuts down it
107 * reports this code to the control tools.
108 * @arg == sched_shutdown_t, as for SCHEDOP_shutdown.
110 #define SCHEDOP_shutdown_code 5
113 * Setup, poke and destroy a domain watchdog timer.
114 * @arg == pointer to sched_watchdog_t structure.
115 * With id == 0, setup a domain watchdog timer to cause domain shutdown
116 * after timeout, returns watchdog id.
117 * With id != 0 and timeout == 0, destroy domain watchdog timer.
118 * With id != 0 and timeout != 0, poke watchdog timer and set new timeout.
120 #define SCHEDOP_watchdog 6
123 struct sched_shutdown {
124 unsigned int reason; /* SHUTDOWN_* => enum sched_shutdown_reason */
126 typedef struct sched_shutdown sched_shutdown_t;
127 DEFINE_XEN_GUEST_HANDLE(sched_shutdown_t);
130 XEN_GUEST_HANDLE(evtchn_port_t) ports;
131 unsigned int nr_ports;
134 typedef struct sched_poll sched_poll_t;
135 DEFINE_XEN_GUEST_HANDLE(sched_poll_t);
137 struct sched_remote_shutdown {
138 domid_t domain_id; /* Remote domain ID */
139 unsigned int reason; /* SHUTDOWN_* => enum sched_shutdown_reason */
141 typedef struct sched_remote_shutdown sched_remote_shutdown_t;
142 DEFINE_XEN_GUEST_HANDLE(sched_remote_shutdown_t);
144 struct sched_watchdog {
145 uint32_t id; /* watchdog ID */
146 uint32_t timeout; /* timeout */
148 typedef struct sched_watchdog sched_watchdog_t;
149 DEFINE_XEN_GUEST_HANDLE(sched_watchdog_t);
152 * Reason codes for SCHEDOP_shutdown. These may be interpreted by control
153 * software to determine the appropriate action. For the most part, Xen does
154 * not care about the shutdown code.
156 /* ` enum sched_shutdown_reason { */
157 #define SHUTDOWN_poweroff 0 /* Domain exited normally. Clean up and kill. */
158 #define SHUTDOWN_reboot 1 /* Clean up, kill, and then restart. */
159 #define SHUTDOWN_suspend 2 /* Clean up, save suspend info, kill. */
160 #define SHUTDOWN_crash 3 /* Tell controller we've crashed. */
161 #define SHUTDOWN_watchdog 4 /* Restart because watchdog time expired. */
162 #define SHUTDOWN_MAX 4 /* Maximum valid shutdown reason. */
165 #endif /* __XEN_PUBLIC_SCHED_H__ */
170 * c-file-style: "BSD"
173 * indent-tabs-mode: nil