include/xen/interface/event_channel.h

   1 /******************************************************************************
   2  * event_channel.h
   3  *
   4  * Event channels between domains.
   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) 2003-2004, K A Fraser.
  25  */
  26
  27 #ifndef __XEN_PUBLIC_EVENT_CHANNEL_H__
  28 #define __XEN_PUBLIC_EVENT_CHANNEL_H__
  29
  30 #include <xen/interface/xen.h>
  31
  32 /*
  33  * `incontents 150 evtchn Event Channels
  34  *
  35  * Event channels are the basic primitive provided by Xen for event
  36  * notifications. An event is the Xen equivalent of a hardware
  37  * interrupt. They essentially store one bit of information, the event
  38  * of interest is signalled by transitioning this bit from 0 to 1.
  39  *
  40  * Notifications are received by a guest via an upcall from Xen,
  41  * indicating when an event arrives (setting the bit). Further
  42  * notifications are masked until the bit is cleared again (therefore,
  43  * guests must check the value of the bit after re-enabling event
  44  * delivery to ensure no missed notifications).
  45  *
  46  * Event notifications can be masked by setting a flag; this is
  47  * equivalent to disabling interrupts and can be used to ensure
  48  * atomicity of certain operations in the guest kernel.
  49  *
  50  * Event channels are represented by the evtchn_* fields in
  51  * struct shared_info and struct vcpu_info.
  52  */
  53
  54 /*
  55  * ` enum neg_errnoval
  56  * ` HYPERVISOR_event_channel_op(enum event_channel_op cmd, void *args)
  57  * `
  58  * @cmd  == EVTCHNOP_* (event-channel operation).
  59  * @args == struct evtchn_* Operation-specific extra arguments (NULL if none).
  60  */
  61
  62 /* ` enum event_channel_op { // EVTCHNOP_* => struct evtchn_* */
  63 #define EVTCHNOP_bind_interdomain 0
  64 #define EVTCHNOP_bind_virq        1
  65 #define EVTCHNOP_bind_pirq        2
  66 #define EVTCHNOP_close            3
  67 #define EVTCHNOP_send             4
  68 #define EVTCHNOP_status           5
  69 #define EVTCHNOP_alloc_unbound    6
  70 #define EVTCHNOP_bind_ipi         7
  71 #define EVTCHNOP_bind_vcpu        8
  72 #define EVTCHNOP_unmask           9
  73 #define EVTCHNOP_reset           10
  74 /* ` } */
  75
  76 typedef uint32_t evtchn_port_t;
  77 DEFINE_XEN_GUEST_HANDLE(evtchn_port_t);
  78
  79 /*
  80  * EVTCHNOP_alloc_unbound: Allocate a port in domain <dom> and mark as
  81  * accepting interdomain bindings from domain <remote_dom>. A fresh port
  82  * is allocated in <dom> and returned as <port>.
  83  * NOTES:
  84  *  1. If the caller is unprivileged then <dom> must be DOMID_SELF.
  85  *  2. <rdom> may be DOMID_SELF, allowing loopback connections.
  86  */
  87 struct evtchn_alloc_unbound {
  88         /* IN parameters */
  89         domid_t dom, remote_dom;
  90         /* OUT parameters */
  91         evtchn_port_t port;
  92 };
  93 typedef struct evtchn_alloc_unbound evtchn_alloc_unbound_t;
  94
  95 /*
  96  * EVTCHNOP_bind_interdomain: Construct an interdomain event channel between
  97  * the calling domain and <remote_dom>. <remote_dom,remote_port> must identify
  98  * a port that is unbound and marked as accepting bindings from the calling
  99  * domain. A fresh port is allocated in the calling domain and returned as
 100  * <local_port>.
 101  * NOTES:
 102  *  1. <remote_dom> may be DOMID_SELF, allowing loopback connections.
 103  */
 104 struct evtchn_bind_interdomain {
 105         /* IN parameters. */
 106         domid_t remote_dom;
 107         evtchn_port_t remote_port;
 108         /* OUT parameters. */
 109         evtchn_port_t local_port;
 110 };
 111 typedef struct evtchn_bind_interdomain evtchn_bind_interdomain_t;
 112
 113 /*
 114  * EVTCHNOP_bind_virq: Bind a local event channel to VIRQ <irq> on specified
 115  * vcpu.
 116  * NOTES:
 117  *  1. Virtual IRQs are classified as per-vcpu or global. See the VIRQ list
 118  *     in xen.h for the classification of each VIRQ.
 119  *  2. Global VIRQs must be allocated on VCPU0 but can subsequently be
 120  *     re-bound via EVTCHNOP_bind_vcpu.
 121  *  3. Per-vcpu VIRQs may be bound to at most one event channel per vcpu.
 122  *     The allocated event channel is bound to the specified vcpu and the
 123  *     binding cannot be changed.
 124  */
 125 struct evtchn_bind_virq {
 126         /* IN parameters. */
 127         uint32_t virq; /* enum virq */
 128         uint32_t vcpu;
 129         /* OUT parameters. */
 130         evtchn_port_t port;
 131 };
 132 typedef struct evtchn_bind_virq evtchn_bind_virq_t;
 133
 134 /*
 135  * EVTCHNOP_bind_pirq: Bind a local event channel to a real IRQ (PIRQ <irq>).
 136  * NOTES:
 137  *  1. A physical IRQ may be bound to at most one event channel per domain.
 138  *  2. Only a sufficiently-privileged domain may bind to a physical IRQ.
 139  */
 140 struct evtchn_bind_pirq {
 141         /* IN parameters. */
 142         uint32_t pirq;
 143 #define BIND_PIRQ__WILL_SHARE 1
 144         uint32_t flags; /* BIND_PIRQ__* */
 145         /* OUT parameters. */
 146         evtchn_port_t port;
 147 };
 148 typedef struct evtchn_bind_pirq evtchn_bind_pirq_t;
 149
 150 /*
 151  * EVTCHNOP_bind_ipi: Bind a local event channel to receive events.
 152  * NOTES:
 153  *  1. The allocated event channel is bound to the specified vcpu. The binding
 154  *     may not be changed.
 155  */
 156 struct evtchn_bind_ipi {
 157         uint32_t vcpu;
 158         /* OUT parameters. */
 159         evtchn_port_t port;
 160 };
 161 typedef struct evtchn_bind_ipi evtchn_bind_ipi_t;
 162
 163 /*
 164  * EVTCHNOP_close: Close a local event channel <port>. If the channel is
 165  * interdomain then the remote end is placed in the unbound state
 166  * (EVTCHNSTAT_unbound), awaiting a new connection.
 167  */
 168 struct evtchn_close {
 169         /* IN parameters. */
 170         evtchn_port_t port;
 171 };
 172 typedef struct evtchn_close evtchn_close_t;
 173
 174 /*
 175  * EVTCHNOP_send: Send an event to the remote end of the channel whose local
 176  * endpoint is <port>.
 177  */
 178 struct evtchn_send {
 179         /* IN parameters. */
 180         evtchn_port_t port;
 181 };
 182 typedef struct evtchn_send evtchn_send_t;
 183
 184 /*
 185  * EVTCHNOP_status: Get the current status of the communication channel which
 186  * has an endpoint at <dom, port>.
 187  * NOTES:
 188  *  1. <dom> may be specified as DOMID_SELF.
 189  *  2. Only a sufficiently-privileged domain may obtain the status of an event
 190  *     channel for which <dom> is not DOMID_SELF.
 191  */
 192 struct evtchn_status {
 193         /* IN parameters */
 194         domid_t  dom;
 195         evtchn_port_t port;
 196         /* OUT parameters */
 197 #define EVTCHNSTAT_closed       0  /* Channel is not in use.                 */
 198 #define EVTCHNSTAT_unbound      1  /* Channel is waiting interdom connection.*/
 199 #define EVTCHNSTAT_interdomain  2  /* Channel is connected to remote domain. */
 200 #define EVTCHNSTAT_pirq         3  /* Channel is bound to a phys IRQ line.   */
 201 #define EVTCHNSTAT_virq         4  /* Channel is bound to a virtual IRQ line */
 202 #define EVTCHNSTAT_ipi          5  /* Channel is bound to a virtual IPI line */
 203         uint32_t status;
 204         uint32_t vcpu;             /* VCPU to which this channel is bound.   */
 205         union {
 206                 struct {
 207                         domid_t dom;
 208                 } unbound; /* EVTCHNSTAT_unbound */
 209                 struct {
 210                         domid_t dom;
 211                         evtchn_port_t port;
 212                 } interdomain; /* EVTCHNSTAT_interdomain */
 213                 uint32_t pirq;      /* EVTCHNSTAT_pirq        */
 214                 uint32_t virq;      /* EVTCHNSTAT_virq        */
 215         } u;
 216 };
 217 typedef struct evtchn_status evtchn_status_t;
 218
 219 /*
 220  * EVTCHNOP_bind_vcpu: Specify which vcpu a channel should notify when an
 221  * event is pending.
 222  * NOTES:
 223  *  1. IPI-bound channels always notify the vcpu specified at bind time.
 224  *     This binding cannot be changed.
 225  *  2. Per-VCPU VIRQ channels always notify the vcpu specified at bind time.
 226  *     This binding cannot be changed.
 227  *  3. All other channels notify vcpu0 by default. This default is set when
 228  *     the channel is allocated (a port that is freed and subsequently reused
 229  *     has its binding reset to vcpu0).
 230  */
 231 struct evtchn_bind_vcpu {
 232         /* IN parameters. */
 233         evtchn_port_t port;
 234         uint32_t vcpu;
 235 };
 236 typedef struct evtchn_bind_vcpu evtchn_bind_vcpu_t;
 237
 238 /*
 239  * EVTCHNOP_unmask: Unmask the specified local event-channel port and deliver
 240  * a notification to the appropriate VCPU if an event is pending.
 241  */
 242 struct evtchn_unmask {
 243         /* IN parameters. */
 244         evtchn_port_t port;
 245 };
 246 typedef struct evtchn_unmask evtchn_unmask_t;
 247
 248 /*
 249  * EVTCHNOP_reset: Close all event channels associated with specified domain.
 250  * NOTES:
 251  *  1. <dom> may be specified as DOMID_SELF.
 252  *  2. Only a sufficiently-privileged domain may specify other than DOMID_SELF.
 253  */
 254 struct evtchn_reset {
 255     /* IN parameters. */
 256     domid_t dom;
 257 };
 258 typedef struct evtchn_reset evtchn_reset_t;
 259
 260 /*
 261  * ` enum neg_errnoval
 262  * ` HYPERVISOR_event_channel_op_compat(struct evtchn_op *op)
 263  * `
 264  * Superceded by new event_channel_op() hypercall since 0x00030202.
 265  */
 266 struct evtchn_op {
 267         uint32_t cmd; /* enum event_channel_op */
 268         union {
 269                 struct evtchn_alloc_unbound    alloc_unbound;
 270                 struct evtchn_bind_interdomain bind_interdomain;
 271                 struct evtchn_bind_virq        bind_virq;
 272                 struct evtchn_bind_pirq        bind_pirq;
 273                 struct evtchn_bind_ipi         bind_ipi;
 274                 struct evtchn_close            close;
 275                 struct evtchn_send             send;
 276                 struct evtchn_status           status;
 277                 struct evtchn_bind_vcpu        bind_vcpu;
 278                 struct evtchn_unmask           unmask;
 279         } u;
 280 };
 281 DEFINE_GUEST_HANDLE_STRUCT(evtchn_op);
 282 typedef struct evtchn_op evtchn_op_t;
 283 DEFINE_XEN_GUEST_HANDLE(evtchn_op_t);
 284
 285 #endif /* __XEN_PUBLIC_EVENT_CHANNEL_H__ */