1 /******************************************************************************
4 * Method declarations and structures for accessing the XenStore.h
6 * Copyright (C) 2005 Rusty Russell, IBM Corporation
7 * Copyright (C) 2005 XenSource Ltd.
8 * Copyright (C) 2009,2010 Spectra Logic Corporation
10 * This file may be distributed separately from the Linux kernel, or
11 * incorporated into other software packages, subject to the following license:
13 * Permission is hereby granted, free of charge, to any person obtaining a copy
14 * of this source file (the "Software"), to deal in the Software without
15 * restriction, including without limitation the rights to use, copy, modify,
16 * merge, publish, distribute, sublicense, and/or sell copies of the Software,
17 * and to permit persons to whom the Software is furnished to do so, subject to
18 * the following conditions:
20 * The above copyright notice and this permission notice shall be included in
21 * all copies or substantial portions of the Software.
23 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
26 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
28 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
34 #ifndef _XEN_XENSTORE_XENSTOREVAR_H
35 #define _XEN_XENSTORE_XENSTOREVAR_H
37 #include <sys/queue.h>
39 #include <sys/eventhandler.h>
40 #include <sys/malloc.h>
43 #include <machine/stdarg.h>
45 #include <xen/xen-os.h>
46 #include <xen/interface/grant_table.h>
47 #include <xen/interface/io/xenbus.h>
48 #include <xen/interface/io/xs_wire.h>
50 #include "xenbus_if.h"
52 /* XenStore allocations including XenStore data returned to clients. */
53 MALLOC_DECLARE(M_XENSTORE);
57 typedef void (xs_watch_cb_t)(struct xs_watch *, const char **vec,
60 /* Register callback to watch subtree (node) in the XenStore. */
63 LIST_ENTRY(xs_watch) list;
65 /* Path being watched. */
68 /* Callback (executed in a process context with no locks held). */
69 xs_watch_cb_t *callback;
71 /* Callback client data untouched by the XenStore watch mechanism. */
72 uintptr_t callback_data;
74 LIST_HEAD(xs_watch_list, xs_watch);
76 typedef int (*xs_event_handler_t)(void *);
83 #define XST_NIL ((struct xs_transaction) { 0 })
86 * Check if Xenstore is initialized.
88 * \return True if initialized, false otherwise.
90 bool xs_initialized(void);
93 * Return xenstore event channel port.
95 * \return event channel port.
97 evtchn_port_t xs_evtchn(void);
100 * Return xenstore page physical memory address.
102 * \return xenstore page physical address.
104 vm_paddr_t xs_address(void);
107 * Fetch the contents of a directory in the XenStore.
109 * \param t The XenStore transaction covering this request.
110 * \param dir The dirname of the path to read.
111 * \param node The basename of the path to read.
112 * \param num The returned number of directory entries.
113 * \param result An array of directory entry strings.
115 * \return On success, 0. Otherwise an errno value indicating the
118 * \note The results buffer is malloced and should be free'd by the
119 * caller with 'free(*result, M_XENSTORE)'.
121 int xs_directory(struct xs_transaction t, const char *dir,
122 const char *node, unsigned int *num, const char ***result);
125 * Determine if a path exists in the XenStore.
127 * \param t The XenStore transaction covering this request.
128 * \param dir The dirname of the path to read.
129 * \param node The basename of the path to read.
131 * \retval 1 The path exists.
132 * \retval 0 The path does not exist or an error occurred attempting
133 * to make that determination.
135 int xs_exists(struct xs_transaction t, const char *dir, const char *node);
138 * Get the contents of a single "file". Returns the contents in
139 * *result which should be freed with free(*result, M_XENSTORE) after
140 * use. The length of the value in bytes is returned in *len.
142 * \param t The XenStore transaction covering this request.
143 * \param dir The dirname of the file to read.
144 * \param node The basename of the file to read.
145 * \param len The amount of data read.
146 * \param result The returned contents from this file.
148 * \return On success, 0. Otherwise an errno value indicating the
151 * \note The results buffer is malloced and should be free'd by the
152 * caller with 'free(*result, M_XENSTORE)'.
154 int xs_read(struct xs_transaction t, const char *dir,
155 const char *node, unsigned int *len, void **result);
158 * Write to a single file.
160 * \param t The XenStore transaction covering this request.
161 * \param dir The dirname of the file to write.
162 * \param node The basename of the file to write.
163 * \param string The NUL terminated string of data to write.
165 * \return On success, 0. Otherwise an errno value indicating the
168 int xs_write(struct xs_transaction t, const char *dir,
169 const char *node, const char *string);
172 * Create a new directory.
174 * \param t The XenStore transaction covering this request.
175 * \param dir The dirname of the directory to create.
176 * \param node The basename of the directory to create.
178 * \return On success, 0. Otherwise an errno value indicating the
181 int xs_mkdir(struct xs_transaction t, const char *dir,
185 * Remove a file or directory (directories must be empty).
187 * \param t The XenStore transaction covering this request.
188 * \param dir The dirname of the directory to remove.
189 * \param node The basename of the directory to remove.
191 * \return On success, 0. Otherwise an errno value indicating the
194 int xs_rm(struct xs_transaction t, const char *dir, const char *node);
197 * Destroy a tree of files rooted at dir/node.
199 * \param t The XenStore transaction covering this request.
200 * \param dir The dirname of the directory to remove.
201 * \param node The basename of the directory to remove.
203 * \return On success, 0. Otherwise an errno value indicating the
206 int xs_rm_tree(struct xs_transaction t, const char *dir,
210 * Start a transaction.
212 * Changes by others will not be seen during the lifetime of this
213 * transaction, and changes will not be visible to others until it
214 * is committed (xs_transaction_end).
216 * \param t The returned transaction.
218 * \return On success, 0. Otherwise an errno value indicating the
221 int xs_transaction_start(struct xs_transaction *t);
226 * \param t The transaction to end/commit.
227 * \param abort If non-zero, the transaction is discarded
228 * instead of committed.
230 * \return On success, 0. Otherwise an errno value indicating the
233 int xs_transaction_end(struct xs_transaction t, int abort);
236 * Single file read and scanf parsing of the result.
238 * \param t The XenStore transaction covering this request.
239 * \param dir The dirname of the path to read.
240 * \param node The basename of the path to read.
241 * \param scancountp The number of input values assigned (i.e. the result
243 * \param fmt Scanf format string followed by a variable number of
244 * scanf input arguments.
246 * \return On success, 0. Otherwise an errno value indicating the
249 int xs_scanf(struct xs_transaction t,
250 const char *dir, const char *node, int *scancountp, const char *fmt, ...)
251 __attribute__((format(scanf, 5, 6)));
254 * Printf formatted write to a XenStore file.
256 * \param t The XenStore transaction covering this request.
257 * \param dir The dirname of the path to read.
258 * \param node The basename of the path to read.
259 * \param fmt Printf format string followed by a variable number of
262 * \return On success, 0. Otherwise an errno value indicating the
263 * type of write failure.
265 int xs_printf(struct xs_transaction t, const char *dir,
266 const char *node, const char *fmt, ...)
267 __attribute__((format(printf, 4, 5)));
270 * va_list version of xenbus_printf().
272 * \param t The XenStore transaction covering this request.
273 * \param dir The dirname of the path to read.
274 * \param node The basename of the path to read.
275 * \param fmt Printf format string.
276 * \param ap Va_list of printf arguments.
278 * \return On success, 0. Otherwise an errno value indicating the
279 * type of write failure.
281 int xs_vprintf(struct xs_transaction t, const char *dir,
282 const char *node, const char *fmt, va_list ap);
285 * Multi-file read within a single directory and scanf parsing of
288 * \param t The XenStore transaction covering this request.
289 * \param dir The dirname of the paths to read.
290 * \param ... A variable number of argument triples specifying
291 * the file name, scanf-style format string, and
292 * output variable (pointer to storage of the results).
293 * The last triple in the call must be terminated
294 * will a final NULL argument. A NULL format string
295 * will cause the entire contents of the given file
296 * to be assigned as a NUL terminated, M_XENSTORE heap
297 * backed, string to the output parameter of that tuple.
299 * \return On success, 0. Otherwise an errno value indicating the
300 * type of read failure.
303 * char protocol_abi[64];
308 * error = xenbus_gather(XBT_NIL, xenbus_get_node(dev),
309 * "ring-ref", "%" PRIu32, &ring_ref,
310 * "protocol", "%63s", protocol_abi,
311 * "device-type", NULL, &dev_type,
316 * free(dev_type, M_XENSTORE);
318 int xs_gather(struct xs_transaction t, const char *dir, ...);
321 * Register a XenStore watch.
323 * XenStore watches allow a client to be notified via a callback (embedded
324 * within the watch object) of changes to an object in the XenStore.
326 * \param watch An xs_watch struct with it's node and callback fields
327 * properly initialized.
329 * \return On success, 0. Otherwise an errno value indicating the
330 * type of write failure. EEXIST errors from the XenStore
331 * are supressed, allowing multiple, physically different,
332 * xenbus_watch objects, to watch the same path in the XenStore.
334 int xs_register_watch(struct xs_watch *watch);
337 * Unregister a XenStore watch.
339 * \param watch An xs_watch object previously used in a successful call
340 * to xs_register_watch().
342 * The xs_watch object's node field is not altered by this call.
343 * It is the caller's responsibility to properly dispose of both the
344 * watch object and the data pointed to by watch->node.
346 void xs_unregister_watch(struct xs_watch *watch);
349 * Allocate and return an sbuf containing the XenStore path string
350 * <dir>/<name>. If name is the NUL string, the returned sbuf contains
351 * the path string <dir>.
353 * \param dir The NUL terminated directory prefix for new path.
354 * \param name The NUL terminated basename for the new path.
356 * \return A buffer containing the joined path.
358 struct sbuf *xs_join(const char *, const char *);
361 * Lock the xenstore request mutex.
366 * Unlock the xenstore request mutex.
368 void xs_unlock(void);
370 #endif /* _XEN_XENSTORE_XENSTOREVAR_H */