1181624Skmacy/* 2181624Skmacy * Details of the "wire" protocol between Xen Store Daemon and client 3181624Skmacy * library or guest kernel. 4181624Skmacy * 5181624Skmacy * Permission is hereby granted, free of charge, to any person obtaining a copy 6181624Skmacy * of this software and associated documentation files (the "Software"), to 7181624Skmacy * deal in the Software without restriction, including without limitation the 8181624Skmacy * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 9181624Skmacy * sell copies of the Software, and to permit persons to whom the Software is 10181624Skmacy * furnished to do so, subject to the following conditions: 11181624Skmacy * 12181624Skmacy * The above copyright notice and this permission notice shall be included in 13181624Skmacy * all copies or substantial portions of the Software. 14181624Skmacy * 15181624Skmacy * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16181624Skmacy * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17181624Skmacy * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18181624Skmacy * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19181624Skmacy * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 20181624Skmacy * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 21181624Skmacy * DEALINGS IN THE SOFTWARE. 22181624Skmacy * 23181624Skmacy * Copyright (C) 2005 Rusty Russell IBM Corporation 24181624Skmacy */ 25181624Skmacy 26181624Skmacy#ifndef _XS_WIRE_H 27181624Skmacy#define _XS_WIRE_H 28181624Skmacy 29181624Skmacyenum xsd_sockmsg_type 30181624Skmacy{ 31181624Skmacy XS_DEBUG, 32181624Skmacy XS_DIRECTORY, 33181624Skmacy XS_READ, 34181624Skmacy XS_GET_PERMS, 35181624Skmacy XS_WATCH, 36181624Skmacy XS_UNWATCH, 37181624Skmacy XS_TRANSACTION_START, 38181624Skmacy XS_TRANSACTION_END, 39181624Skmacy XS_INTRODUCE, 40181624Skmacy XS_RELEASE, 41181624Skmacy XS_GET_DOMAIN_PATH, 42181624Skmacy XS_WRITE, 43181624Skmacy XS_MKDIR, 44181624Skmacy XS_RM, 45181624Skmacy XS_SET_PERMS, 46181624Skmacy XS_WATCH_EVENT, 47181624Skmacy XS_ERROR, 48181624Skmacy XS_IS_DOMAIN_INTRODUCED, 49183375Skmacy XS_RESUME, 50251767Sgibbs XS_SET_TARGET, 51251767Sgibbs XS_RESTRICT, 52288917Sroyger XS_RESET_WATCHES, 53288917Sroyger 54288917Sroyger XS_INVALID = 0xffff /* Guaranteed to remain an invalid type */ 55181624Skmacy}; 56181624Skmacy 57181624Skmacy#define XS_WRITE_NONE "NONE" 58181624Skmacy#define XS_WRITE_CREATE "CREATE" 59181624Skmacy#define XS_WRITE_CREATE_EXCL "CREATE|EXCL" 60181624Skmacy 61181624Skmacy/* We hand errors as strings, for portability. */ 62181624Skmacystruct xsd_errors 63181624Skmacy{ 64181624Skmacy int errnum; 65181624Skmacy const char *errstring; 66181624Skmacy}; 67251767Sgibbs#ifdef EINVAL 68181624Skmacy#define XSD_ERROR(x) { x, #x } 69183375Skmacy/* LINTED: static unused */ 70181624Skmacystatic struct xsd_errors xsd_errors[] 71181624Skmacy#if defined(__GNUC__) 72181624Skmacy__attribute__((unused)) 73181624Skmacy#endif 74181624Skmacy = { 75181624Skmacy XSD_ERROR(EINVAL), 76181624Skmacy XSD_ERROR(EACCES), 77181624Skmacy XSD_ERROR(EEXIST), 78181624Skmacy XSD_ERROR(EISDIR), 79181624Skmacy XSD_ERROR(ENOENT), 80181624Skmacy XSD_ERROR(ENOMEM), 81181624Skmacy XSD_ERROR(ENOSPC), 82181624Skmacy XSD_ERROR(EIO), 83181624Skmacy XSD_ERROR(ENOTEMPTY), 84181624Skmacy XSD_ERROR(ENOSYS), 85181624Skmacy XSD_ERROR(EROFS), 86181624Skmacy XSD_ERROR(EBUSY), 87181624Skmacy XSD_ERROR(EAGAIN), 88288917Sroyger XSD_ERROR(EISCONN), 89288917Sroyger XSD_ERROR(E2BIG) 90181624Skmacy}; 91251767Sgibbs#endif 92181624Skmacy 93181624Skmacystruct xsd_sockmsg 94181624Skmacy{ 95181624Skmacy uint32_t type; /* XS_??? */ 96181624Skmacy uint32_t req_id;/* Request identifier, echoed in daemon's response. */ 97181624Skmacy uint32_t tx_id; /* Transaction id (0 if not related to a transaction). */ 98181624Skmacy uint32_t len; /* Length of data following this. */ 99181624Skmacy 100181624Skmacy /* Generally followed by nul-terminated string(s). */ 101181624Skmacy}; 102181624Skmacy 103181624Skmacyenum xs_watch_type 104181624Skmacy{ 105181624Skmacy XS_WATCH_PATH = 0, 106181624Skmacy XS_WATCH_TOKEN 107181624Skmacy}; 108181624Skmacy 109288917Sroyger/* 110288917Sroyger * `incontents 150 xenstore_struct XenStore wire protocol. 111288917Sroyger * 112288917Sroyger * Inter-domain shared memory communications. */ 113181624Skmacy#define XENSTORE_RING_SIZE 1024 114181624Skmacytypedef uint32_t XENSTORE_RING_IDX; 115181624Skmacy#define MASK_XENSTORE_IDX(idx) ((idx) & (XENSTORE_RING_SIZE-1)) 116181624Skmacystruct xenstore_domain_interface { 117181624Skmacy char req[XENSTORE_RING_SIZE]; /* Requests to xenstore daemon. */ 118181624Skmacy char rsp[XENSTORE_RING_SIZE]; /* Replies and async watch events. */ 119181624Skmacy XENSTORE_RING_IDX req_cons, req_prod; 120181624Skmacy XENSTORE_RING_IDX rsp_cons, rsp_prod; 121288917Sroyger uint32_t server_features; /* Bitmap of features supported by the server */ 122288917Sroyger uint32_t connection; 123181624Skmacy}; 124181624Skmacy 125183375Skmacy/* Violating this is very bad. See docs/misc/xenstore.txt. */ 126183375Skmacy#define XENSTORE_PAYLOAD_MAX 4096 127183375Skmacy 128183375Skmacy/* Violating these just gets you an error back */ 129183375Skmacy#define XENSTORE_ABS_PATH_MAX 3072 130183375Skmacy#define XENSTORE_REL_PATH_MAX 2048 131183375Skmacy 132288917Sroyger/* The ability to reconnect a ring */ 133288917Sroyger#define XENSTORE_SERVER_FEATURE_RECONNECTION 1 134288917Sroyger 135288917Sroyger/* Valid values for the connection field */ 136288917Sroyger#define XENSTORE_CONNECTED 0 /* the steady-state */ 137288917Sroyger#define XENSTORE_RECONNECT 1 /* guest has initiated a reconnect */ 138288917Sroyger 139181624Skmacy#endif /* _XS_WIRE_H */ 140181624Skmacy 141181624Skmacy/* 142181624Skmacy * Local variables: 143181624Skmacy * mode: C 144288917Sroyger * c-file-style: "BSD" 145181624Skmacy * c-basic-offset: 4 146181624Skmacy * tab-width: 4 147181624Skmacy * indent-tabs-mode: nil 148181624Skmacy * End: 149181624Skmacy */ 150