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/sched.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  * sched.h
    3  *
    4  * Scheduler state interactions
    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_SCHED_H__
   28 #define __XEN_PUBLIC_SCHED_H__
   29 
   30 #include "event_channel.h"
   31 
   32 /*
   33  * `incontents 150 sched Guest Scheduler Operations
   34  *
   35  * The SCHEDOP interface provides mechanisms for a guest to interact
   36  * with the scheduler, including yield, blocking and shutting itself
   37  * down.
   38  */
   39 
   40 /*
   41  * The prototype for this hypercall is:
   42  * ` long HYPERVISOR_sched_op(enum sched_op cmd, void *arg, ...)
   43  *
   44  * @cmd == SCHEDOP_??? (scheduler operation).
   45  * @arg == Operation-specific extra argument(s), as described below.
   46  * ...  == Additional Operation-specific extra arguments, described below.
   47  *
   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)
   54  *
   55  * This legacy version is available to new guests as:
   56  * ` long HYPERVISOR_sched_op_compat(enum sched_op cmd, unsigned long arg)
   57  */
   58 
   59 /* ` enum sched_op { // SCHEDOP_* => struct sched_* */
   60 /*
   61  * Voluntarily yield the CPU.
   62  * @arg == NULL.
   63  */
   64 #define SCHEDOP_yield       0
   65 
   66 /*
   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.
   71  * @arg == NULL.
   72  */
   73 #define SCHEDOP_block       1
   74 
   75 /*
   76  * Halt execution of this domain (all VCPUs) and notify the system controller.
   77  * @arg == pointer to sched_shutdown_t structure.
   78  *
   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
   82  * argument.
   83  *
   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.
   87  */
   88 #define SCHEDOP_shutdown    2
   89 
   90 /*
   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.
   94  */
   95 #define SCHEDOP_poll        3
   96 
   97 /*
   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.
  102  */
  103 #define SCHEDOP_remote_shutdown        4
  104 
  105 /*
  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.
  109  */
  110 #define SCHEDOP_shutdown_code 5
  111 
  112 /*
  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.
  119  */
  120 #define SCHEDOP_watchdog    6
  121 /* ` } */
  122 
  123 struct sched_shutdown {
  124     unsigned int reason; /* SHUTDOWN_* => enum sched_shutdown_reason */
  125 };
  126 typedef struct sched_shutdown sched_shutdown_t;
  127 DEFINE_XEN_GUEST_HANDLE(sched_shutdown_t);
  128 
  129 struct sched_poll {
  130     XEN_GUEST_HANDLE(evtchn_port_t) ports;
  131     unsigned int nr_ports;
  132     uint64_t timeout;
  133 };
  134 typedef struct sched_poll sched_poll_t;
  135 DEFINE_XEN_GUEST_HANDLE(sched_poll_t);
  136 
  137 struct sched_remote_shutdown {
  138     domid_t domain_id;         /* Remote domain ID */
  139     unsigned int reason;       /* SHUTDOWN_* => enum sched_shutdown_reason */
  140 };
  141 typedef struct sched_remote_shutdown sched_remote_shutdown_t;
  142 DEFINE_XEN_GUEST_HANDLE(sched_remote_shutdown_t);
  143 
  144 struct sched_watchdog {
  145     uint32_t id;                /* watchdog ID */
  146     uint32_t timeout;           /* timeout */
  147 };
  148 typedef struct sched_watchdog sched_watchdog_t;
  149 DEFINE_XEN_GUEST_HANDLE(sched_watchdog_t);
  150 
  151 /*
  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.
  155  */
  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.             */
  163 /* ` } */
  164 
  165 #endif /* __XEN_PUBLIC_SCHED_H__ */
  166 
  167 /*
  168  * Local variables:
  169  * mode: C
  170  * c-file-style: "BSD"
  171  * c-basic-offset: 4
  172  * tab-width: 4
  173  * indent-tabs-mode: nil
  174  * End:
  175  */

Cache object: b0d921a35397fba5bee3021f5662d8fa


[ 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.