2 * Details of the "wire" protocol between Xen Store Daemon and client
3 * library or guest kernel.
5 * Permission is hereby granted, free of charge, to any person obtaining a copy
6 * of this software and associated documentation files (the "Software"), to
7 * deal in the Software without restriction, including without limitation the
8 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
9 * sell copies of the Software, and to permit persons to whom the Software is
10 * furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
23 * Copyright (C) 2005 Rusty Russell IBM Corporation
48 XS_IS_DOMAIN_INTRODUCED,
54 XS_INVALID = 0xffff /* Guaranteed to remain an invalid type */
57 #define XS_WRITE_NONE "NONE"
58 #define XS_WRITE_CREATE "CREATE"
59 #define XS_WRITE_CREATE_EXCL "CREATE|EXCL"
61 /* We hand errors as strings, for portability. */
65 const char *errstring;
68 #define XSD_ERROR(x) { x, #x }
69 /* LINTED: static unused */
70 static struct xsd_errors xsd_errors[]
72 __attribute__((unused))
95 uint32_t type; /* XS_??? */
96 uint32_t req_id;/* Request identifier, echoed in daemon's response. */
97 uint32_t tx_id; /* Transaction id (0 if not related to a transaction). */
98 uint32_t len; /* Length of data following this. */
100 /* Generally followed by nul-terminated string(s). */
110 * `incontents 150 xenstore_struct XenStore wire protocol.
112 * Inter-domain shared memory communications. */
113 #define XENSTORE_RING_SIZE 1024
114 typedef uint32_t XENSTORE_RING_IDX;
115 #define MASK_XENSTORE_IDX(idx) ((idx) & (XENSTORE_RING_SIZE-1))
116 struct xenstore_domain_interface {
117 char req[XENSTORE_RING_SIZE]; /* Requests to xenstore daemon. */
118 char rsp[XENSTORE_RING_SIZE]; /* Replies and async watch events. */
119 XENSTORE_RING_IDX req_cons, req_prod;
120 XENSTORE_RING_IDX rsp_cons, rsp_prod;
121 uint32_t server_features; /* Bitmap of features supported by the server */
125 /* Violating this is very bad. See docs/misc/xenstore.txt. */
126 #define XENSTORE_PAYLOAD_MAX 4096
128 /* Violating these just gets you an error back */
129 #define XENSTORE_ABS_PATH_MAX 3072
130 #define XENSTORE_REL_PATH_MAX 2048
132 /* The ability to reconnect a ring */
133 #define XENSTORE_SERVER_FEATURE_RECONNECTION 1
135 /* Valid values for the connection field */
136 #define XENSTORE_CONNECTED 0 /* the steady-state */
137 #define XENSTORE_RECONNECT 1 /* guest has initiated a reconnect */
139 #endif /* _XS_WIRE_H */
144 * c-file-style: "BSD"
147 * indent-tabs-mode: nil