1 /*
2  * Details of the "wire" protocol between Xen Store Daemon and client
3  * library or guest kernel.
4  *
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:
11  *
12  * The above copyright notice and this permission notice shall be included in
13  * all copies or substantial portions of the Software.
14  *
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.
22  *
23  * Copyright (C) 2005 Rusty Russell IBM Corporation
24  */
25 
26 #ifndef _XS_WIRE_H
27 #define _XS_WIRE_H
28 
29 enum xsd_sockmsg_type
30 {
31     XS_DEBUG,
32     XS_DIRECTORY,
33     XS_READ,
34     XS_GET_PERMS,
35     XS_WATCH,
36     XS_UNWATCH,
37     XS_TRANSACTION_START,
38     XS_TRANSACTION_END,
39     XS_INTRODUCE,
40     XS_RELEASE,
41     XS_GET_DOMAIN_PATH,
42     XS_WRITE,
43     XS_MKDIR,
44     XS_RM,
45     XS_SET_PERMS,
46     XS_WATCH_EVENT,
47     XS_ERROR,
48     XS_IS_DOMAIN_INTRODUCED,
49     XS_RESUME
50 };
51 
52 #define XS_WRITE_NONE "NONE"
53 #define XS_WRITE_CREATE "CREATE"
54 #define XS_WRITE_CREATE_EXCL "CREATE|EXCL"
55 
56 /* We hand errors as strings, for portability. */
57 struct xsd_errors
58 {
59     int errnum;
60     const char *errstring;
61 };
62 #define XSD_ERROR(x) { x, #x }
63 /* LINTED: static unused */
64 static struct xsd_errors xsd_errors[]
65 #if defined(__GNUC__)
66 __attribute__((unused))
67 #endif
68     = {
69     XSD_ERROR(EINVAL),
70     XSD_ERROR(EACCES),
71     XSD_ERROR(EEXIST),
72     XSD_ERROR(EISDIR),
73     XSD_ERROR(ENOENT),
74     XSD_ERROR(ENOMEM),
75     XSD_ERROR(ENOSPC),
76     XSD_ERROR(EIO),
77     XSD_ERROR(ENOTEMPTY),
78     XSD_ERROR(ENOSYS),
79     XSD_ERROR(EROFS),
80     XSD_ERROR(EBUSY),
81     XSD_ERROR(EAGAIN),
82     XSD_ERROR(EISCONN)
83 };
84 
85 struct xsd_sockmsg
86 {
87     uint32_t type;  /* XS_??? */
88     uint32_t req_id;/* Request identifier, echoed in daemon's response.  */
89     uint32_t tx_id; /* Transaction id (0 if not related to a transaction). */
90     uint32_t len;   /* Length of data following this. */
91 
92     /* Generally followed by nul-terminated string(s). */
93 };
94 
95 enum xs_watch_type
96 {
97     XS_WATCH_PATH = 0,
98     XS_WATCH_TOKEN
99 };
100 
101 /* Inter-domain shared memory communications. */
102 #define XENSTORE_RING_SIZE 1024
103 typedef uint32_t XENSTORE_RING_IDX;
104 #define MASK_XENSTORE_IDX(idx) ((idx) & (XENSTORE_RING_SIZE-1))
105 struct xenstore_domain_interface {
106     char req[XENSTORE_RING_SIZE]; /* Requests to xenstore daemon. */
107     char rsp[XENSTORE_RING_SIZE]; /* Replies and async watch events. */
108     XENSTORE_RING_IDX req_cons, req_prod;
109     XENSTORE_RING_IDX rsp_cons, rsp_prod;
110 };
111 
112 #endif /* _XS_WIRE_H */
113 
114 /*
115  * Local variables:
116  * mode: C
117  * c-set-style: "BSD"
118  * c-basic-offset: 4
119  * tab-width: 4
120  * indent-tabs-mode: nil
121  * End:
122  */
123