1 /******************************************************************************
2 * Client-facing interface for the Xenbus driver. In other words, the
3 * interface between the Xenbus and the device-specific code, be it the
4 * frontend or the backend of that driver.
6 * Copyright (C) 2005 XenSource Ltd
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License version 2
10 * as published by the Free Software Foundation; or, when distributed
11 * separately from the Linux kernel or incorporated into other
12 * software packages, subject to the following license:
14 * Permission is hereby granted, free of charge, to any person obtaining a copy
15 * of this source file (the "Software"), to deal in the Software without
16 * restriction, including without limitation the rights to use, copy, modify,
17 * merge, publish, distribute, sublicense, and/or sell copies of the Software,
18 * and to permit persons to whom the Software is furnished to do so, subject to
19 * the following conditions:
21 * The above copyright notice and this permission notice shall be included in
22 * all copies or substantial portions of the Software.
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
25 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
27 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
29 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
34 #include <linux/slab.h>
35 #include <linux/types.h>
36 #include <linux/spinlock.h>
37 #include <linux/vmalloc.h>
38 #include <linux/export.h>
39 #include <asm/xen/hypervisor.h>
40 #include <asm/xen/page.h>
41 #include <xen/interface/xen.h>
42 #include <xen/interface/event_channel.h>
43 #include <xen/balloon.h>
44 #include <xen/events.h>
45 #include <xen/grant_table.h>
46 #include <xen/xenbus.h>
49 #include "xenbus_probe.h"
51 struct xenbus_map_node
{
52 struct list_head next
;
54 struct vm_struct
*area
; /* PV */
55 struct page
*page
; /* HVM */
57 grant_handle_t handle
;
60 static DEFINE_SPINLOCK(xenbus_valloc_lock
);
61 static LIST_HEAD(xenbus_valloc_pages
);
63 struct xenbus_ring_ops
{
64 int (*map
)(struct xenbus_device
*dev
, int gnt
, void **vaddr
);
65 int (*unmap
)(struct xenbus_device
*dev
, void *vaddr
);
68 static const struct xenbus_ring_ops
*ring_ops __read_mostly
;
70 const char *xenbus_strstate(enum xenbus_state state
)
72 static const char *const name
[] = {
73 [ XenbusStateUnknown
] = "Unknown",
74 [ XenbusStateInitialising
] = "Initialising",
75 [ XenbusStateInitWait
] = "InitWait",
76 [ XenbusStateInitialised
] = "Initialised",
77 [ XenbusStateConnected
] = "Connected",
78 [ XenbusStateClosing
] = "Closing",
79 [ XenbusStateClosed
] = "Closed",
80 [XenbusStateReconfiguring
] = "Reconfiguring",
81 [XenbusStateReconfigured
] = "Reconfigured",
83 return (state
< ARRAY_SIZE(name
)) ? name
[state
] : "INVALID";
85 EXPORT_SYMBOL_GPL(xenbus_strstate
);
88 * xenbus_watch_path - register a watch
90 * @path: path to watch
91 * @watch: watch to register
92 * @callback: callback to register
94 * Register a @watch on the given path, using the given xenbus_watch structure
95 * for storage, and the given @callback function as the callback. Return 0 on
96 * success, or -errno on error. On success, the given @path will be saved as
97 * @watch->node, and remains the caller's to free. On error, @watch->node will
98 * be NULL, the device will switch to %XenbusStateClosing, and the error will
99 * be saved in the store.
101 int xenbus_watch_path(struct xenbus_device
*dev
, const char *path
,
102 struct xenbus_watch
*watch
,
103 void (*callback
)(struct xenbus_watch
*,
104 const char **, unsigned int))
109 watch
->callback
= callback
;
111 err
= register_xenbus_watch(watch
);
115 watch
->callback
= NULL
;
116 xenbus_dev_fatal(dev
, err
, "adding watch on %s", path
);
121 EXPORT_SYMBOL_GPL(xenbus_watch_path
);
125 * xenbus_watch_pathfmt - register a watch on a sprintf-formatted path
126 * @dev: xenbus device
127 * @watch: watch to register
128 * @callback: callback to register
129 * @pathfmt: format of path to watch
131 * Register a watch on the given @path, using the given xenbus_watch
132 * structure for storage, and the given @callback function as the callback.
133 * Return 0 on success, or -errno on error. On success, the watched path
134 * (@path/@path2) will be saved as @watch->node, and becomes the caller's to
135 * kfree(). On error, watch->node will be NULL, so the caller has nothing to
136 * free, the device will switch to %XenbusStateClosing, and the error will be
137 * saved in the store.
139 int xenbus_watch_pathfmt(struct xenbus_device
*dev
,
140 struct xenbus_watch
*watch
,
141 void (*callback
)(struct xenbus_watch
*,
142 const char **, unsigned int),
143 const char *pathfmt
, ...)
149 va_start(ap
, pathfmt
);
150 path
= kvasprintf(GFP_NOIO
| __GFP_HIGH
, pathfmt
, ap
);
154 xenbus_dev_fatal(dev
, -ENOMEM
, "allocating path for watch");
157 err
= xenbus_watch_path(dev
, path
, watch
, callback
);
163 EXPORT_SYMBOL_GPL(xenbus_watch_pathfmt
);
165 static void xenbus_switch_fatal(struct xenbus_device
*, int, int,
169 __xenbus_switch_state(struct xenbus_device
*dev
,
170 enum xenbus_state state
, int depth
)
172 /* We check whether the state is currently set to the given value, and
173 if not, then the state is set. We don't want to unconditionally
174 write the given state, because we don't want to fire watches
175 unnecessarily. Furthermore, if the node has gone, we don't write
176 to it, as the device will be tearing down, and we don't want to
177 resurrect that directory.
179 Note that, because of this cached value of our state, this
180 function will not take a caller's Xenstore transaction
181 (something it was trying to in the past) because dev->state
182 would not get reset if the transaction was aborted.
185 struct xenbus_transaction xbt
;
189 if (state
== dev
->state
)
195 err
= xenbus_transaction_start(&xbt
);
197 xenbus_switch_fatal(dev
, depth
, err
, "starting transaction");
201 err
= xenbus_scanf(xbt
, dev
->nodename
, "state", "%d", ¤t_state
);
205 err
= xenbus_printf(xbt
, dev
->nodename
, "state", "%d", state
);
207 xenbus_switch_fatal(dev
, depth
, err
, "writing new state");
213 err
= xenbus_transaction_end(xbt
, abort
);
215 if (err
== -EAGAIN
&& !abort
)
217 xenbus_switch_fatal(dev
, depth
, err
, "ending transaction");
225 * xenbus_switch_state
226 * @dev: xenbus device
229 * Advertise in the store a change of the given driver to the given new_state.
230 * Return 0 on success, or -errno on error. On error, the device will switch
231 * to XenbusStateClosing, and the error will be saved in the store.
233 int xenbus_switch_state(struct xenbus_device
*dev
, enum xenbus_state state
)
235 return __xenbus_switch_state(dev
, state
, 0);
238 EXPORT_SYMBOL_GPL(xenbus_switch_state
);
240 int xenbus_frontend_closed(struct xenbus_device
*dev
)
242 xenbus_switch_state(dev
, XenbusStateClosed
);
243 complete(&dev
->down
);
246 EXPORT_SYMBOL_GPL(xenbus_frontend_closed
);
249 * Return the path to the error node for the given device, or NULL on failure.
250 * If the value returned is non-NULL, then it is the caller's to kfree.
252 static char *error_path(struct xenbus_device
*dev
)
254 return kasprintf(GFP_KERNEL
, "error/%s", dev
->nodename
);
258 static void xenbus_va_dev_error(struct xenbus_device
*dev
, int err
,
259 const char *fmt
, va_list ap
)
263 char *printf_buffer
= NULL
;
264 char *path_buffer
= NULL
;
266 #define PRINTF_BUFFER_SIZE 4096
267 printf_buffer
= kmalloc(PRINTF_BUFFER_SIZE
, GFP_KERNEL
);
268 if (printf_buffer
== NULL
)
271 len
= sprintf(printf_buffer
, "%i ", -err
);
272 ret
= vsnprintf(printf_buffer
+len
, PRINTF_BUFFER_SIZE
-len
, fmt
, ap
);
274 BUG_ON(len
+ ret
> PRINTF_BUFFER_SIZE
-1);
276 dev_err(&dev
->dev
, "%s\n", printf_buffer
);
278 path_buffer
= error_path(dev
);
280 if (path_buffer
== NULL
) {
281 dev_err(&dev
->dev
, "failed to write error node for %s (%s)\n",
282 dev
->nodename
, printf_buffer
);
286 if (xenbus_write(XBT_NIL
, path_buffer
, "error", printf_buffer
) != 0) {
287 dev_err(&dev
->dev
, "failed to write error node for %s (%s)\n",
288 dev
->nodename
, printf_buffer
);
293 kfree(printf_buffer
);
300 * @dev: xenbus device
301 * @err: error to report
302 * @fmt: error message format
304 * Report the given negative errno into the store, along with the given
307 void xenbus_dev_error(struct xenbus_device
*dev
, int err
, const char *fmt
, ...)
312 xenbus_va_dev_error(dev
, err
, fmt
, ap
);
315 EXPORT_SYMBOL_GPL(xenbus_dev_error
);
319 * @dev: xenbus device
320 * @err: error to report
321 * @fmt: error message format
323 * Equivalent to xenbus_dev_error(dev, err, fmt, args), followed by
324 * xenbus_switch_state(dev, XenbusStateClosing) to schedule an orderly
325 * closedown of this driver and its peer.
328 void xenbus_dev_fatal(struct xenbus_device
*dev
, int err
, const char *fmt
, ...)
333 xenbus_va_dev_error(dev
, err
, fmt
, ap
);
336 xenbus_switch_state(dev
, XenbusStateClosing
);
338 EXPORT_SYMBOL_GPL(xenbus_dev_fatal
);
341 * Equivalent to xenbus_dev_fatal(dev, err, fmt, args), but helps
342 * avoiding recursion within xenbus_switch_state.
344 static void xenbus_switch_fatal(struct xenbus_device
*dev
, int depth
, int err
,
345 const char *fmt
, ...)
350 xenbus_va_dev_error(dev
, err
, fmt
, ap
);
354 __xenbus_switch_state(dev
, XenbusStateClosing
, 1);
359 * @dev: xenbus device
360 * @ring_mfn: mfn of ring to grant
362 * Grant access to the given @ring_mfn to the peer of the given device. Return
363 * 0 on success, or -errno on error. On error, the device will switch to
364 * XenbusStateClosing, and the error will be saved in the store.
366 int xenbus_grant_ring(struct xenbus_device
*dev
, unsigned long ring_mfn
)
368 int err
= gnttab_grant_foreign_access(dev
->otherend_id
, ring_mfn
, 0);
370 xenbus_dev_fatal(dev
, err
, "granting access to ring page");
373 EXPORT_SYMBOL_GPL(xenbus_grant_ring
);
377 * Allocate an event channel for the given xenbus_device, assigning the newly
378 * created local port to *port. Return 0 on success, or -errno on error. On
379 * error, the device will switch to XenbusStateClosing, and the error will be
380 * saved in the store.
382 int xenbus_alloc_evtchn(struct xenbus_device
*dev
, int *port
)
384 struct evtchn_alloc_unbound alloc_unbound
;
387 alloc_unbound
.dom
= DOMID_SELF
;
388 alloc_unbound
.remote_dom
= dev
->otherend_id
;
390 err
= HYPERVISOR_event_channel_op(EVTCHNOP_alloc_unbound
,
393 xenbus_dev_fatal(dev
, err
, "allocating event channel");
395 *port
= alloc_unbound
.port
;
399 EXPORT_SYMBOL_GPL(xenbus_alloc_evtchn
);
403 * Bind to an existing interdomain event channel in another domain. Returns 0
404 * on success and stores the local port in *port. On error, returns -errno,
405 * switches the device to XenbusStateClosing, and saves the error in XenStore.
407 int xenbus_bind_evtchn(struct xenbus_device
*dev
, int remote_port
, int *port
)
409 struct evtchn_bind_interdomain bind_interdomain
;
412 bind_interdomain
.remote_dom
= dev
->otherend_id
;
413 bind_interdomain
.remote_port
= remote_port
;
415 err
= HYPERVISOR_event_channel_op(EVTCHNOP_bind_interdomain
,
418 xenbus_dev_fatal(dev
, err
,
419 "binding to event channel %d from domain %d",
420 remote_port
, dev
->otherend_id
);
422 *port
= bind_interdomain
.local_port
;
426 EXPORT_SYMBOL_GPL(xenbus_bind_evtchn
);
430 * Free an existing event channel. Returns 0 on success or -errno on error.
432 int xenbus_free_evtchn(struct xenbus_device
*dev
, int port
)
434 struct evtchn_close close
;
439 err
= HYPERVISOR_event_channel_op(EVTCHNOP_close
, &close
);
441 xenbus_dev_error(dev
, err
, "freeing event channel %d", port
);
445 EXPORT_SYMBOL_GPL(xenbus_free_evtchn
);
449 * xenbus_map_ring_valloc
450 * @dev: xenbus device
451 * @gnt_ref: grant reference
452 * @vaddr: pointer to address to be filled out by mapping
454 * Based on Rusty Russell's skeleton driver's map_page.
455 * Map a page of memory into this domain from another domain's grant table.
456 * xenbus_map_ring_valloc allocates a page of virtual address space, maps the
457 * page to that address, and sets *vaddr to that address.
458 * Returns 0 on success, and GNTST_* (see xen/include/interface/grant_table.h)
459 * or -ENOMEM on error. If an error is returned, device will switch to
460 * XenbusStateClosing and the error message will be saved in XenStore.
462 int xenbus_map_ring_valloc(struct xenbus_device
*dev
, int gnt_ref
, void **vaddr
)
464 return ring_ops
->map(dev
, gnt_ref
, vaddr
);
466 EXPORT_SYMBOL_GPL(xenbus_map_ring_valloc
);
468 static int xenbus_map_ring_valloc_pv(struct xenbus_device
*dev
,
469 int gnt_ref
, void **vaddr
)
471 struct gnttab_map_grant_ref op
= {
472 .flags
= GNTMAP_host_map
| GNTMAP_contains_pte
,
474 .dom
= dev
->otherend_id
,
476 struct xenbus_map_node
*node
;
477 struct vm_struct
*area
;
482 node
= kzalloc(sizeof(*node
), GFP_KERNEL
);
486 area
= alloc_vm_area(PAGE_SIZE
, &pte
);
492 op
.host_addr
= arbitrary_virt_to_machine(pte
).maddr
;
494 gnttab_batch_map(&op
, 1);
496 if (op
.status
!= GNTST_okay
) {
499 xenbus_dev_fatal(dev
, op
.status
,
500 "mapping in shared page %d from domain %d",
501 gnt_ref
, dev
->otherend_id
);
505 node
->handle
= op
.handle
;
508 spin_lock(&xenbus_valloc_lock
);
509 list_add(&node
->next
, &xenbus_valloc_pages
);
510 spin_unlock(&xenbus_valloc_lock
);
516 static int xenbus_map_ring_valloc_hvm(struct xenbus_device
*dev
,
517 int gnt_ref
, void **vaddr
)
519 struct xenbus_map_node
*node
;
525 node
= kzalloc(sizeof(*node
), GFP_KERNEL
);
529 err
= alloc_xenballooned_pages(1, &node
->page
, false /* lowmem */);
533 addr
= pfn_to_kaddr(page_to_pfn(node
->page
));
535 err
= xenbus_map_ring(dev
, gnt_ref
, &node
->handle
, addr
);
537 goto out_err_free_ballooned_pages
;
539 spin_lock(&xenbus_valloc_lock
);
540 list_add(&node
->next
, &xenbus_valloc_pages
);
541 spin_unlock(&xenbus_valloc_lock
);
546 out_err_free_ballooned_pages
:
547 free_xenballooned_pages(1, &node
->page
);
556 * @dev: xenbus device
557 * @gnt_ref: grant reference
558 * @handle: pointer to grant handle to be filled
559 * @vaddr: address to be mapped to
561 * Map a page of memory into this domain from another domain's grant table.
562 * xenbus_map_ring does not allocate the virtual address space (you must do
563 * this yourself!). It only maps in the page to the specified address.
564 * Returns 0 on success, and GNTST_* (see xen/include/interface/grant_table.h)
565 * or -ENOMEM on error. If an error is returned, device will switch to
566 * XenbusStateClosing and the error message will be saved in XenStore.
568 int xenbus_map_ring(struct xenbus_device
*dev
, int gnt_ref
,
569 grant_handle_t
*handle
, void *vaddr
)
571 struct gnttab_map_grant_ref op
;
573 gnttab_set_map_op(&op
, (unsigned long)vaddr
, GNTMAP_host_map
, gnt_ref
,
576 gnttab_batch_map(&op
, 1);
578 if (op
.status
!= GNTST_okay
) {
579 xenbus_dev_fatal(dev
, op
.status
,
580 "mapping in shared page %d from domain %d",
581 gnt_ref
, dev
->otherend_id
);
587 EXPORT_SYMBOL_GPL(xenbus_map_ring
);
591 * xenbus_unmap_ring_vfree
592 * @dev: xenbus device
593 * @vaddr: addr to unmap
595 * Based on Rusty Russell's skeleton driver's unmap_page.
596 * Unmap a page of memory in this domain that was imported from another domain.
597 * Use xenbus_unmap_ring_vfree if you mapped in your memory with
598 * xenbus_map_ring_valloc (it will free the virtual address space).
599 * Returns 0 on success and returns GNTST_* on error
600 * (see xen/include/interface/grant_table.h).
602 int xenbus_unmap_ring_vfree(struct xenbus_device
*dev
, void *vaddr
)
604 return ring_ops
->unmap(dev
, vaddr
);
606 EXPORT_SYMBOL_GPL(xenbus_unmap_ring_vfree
);
608 static int xenbus_unmap_ring_vfree_pv(struct xenbus_device
*dev
, void *vaddr
)
610 struct xenbus_map_node
*node
;
611 struct gnttab_unmap_grant_ref op
= {
612 .host_addr
= (unsigned long)vaddr
,
616 spin_lock(&xenbus_valloc_lock
);
617 list_for_each_entry(node
, &xenbus_valloc_pages
, next
) {
618 if (node
->area
->addr
== vaddr
) {
619 list_del(&node
->next
);
625 spin_unlock(&xenbus_valloc_lock
);
628 xenbus_dev_error(dev
, -ENOENT
,
629 "can't find mapped virtual address %p", vaddr
);
630 return GNTST_bad_virt_addr
;
633 op
.handle
= node
->handle
;
634 op
.host_addr
= arbitrary_virt_to_machine(
635 lookup_address((unsigned long)vaddr
, &level
)).maddr
;
637 if (HYPERVISOR_grant_table_op(GNTTABOP_unmap_grant_ref
, &op
, 1))
640 if (op
.status
== GNTST_okay
)
641 free_vm_area(node
->area
);
643 xenbus_dev_error(dev
, op
.status
,
644 "unmapping page at handle %d error %d",
645 node
->handle
, op
.status
);
651 static int xenbus_unmap_ring_vfree_hvm(struct xenbus_device
*dev
, void *vaddr
)
654 struct xenbus_map_node
*node
;
657 spin_lock(&xenbus_valloc_lock
);
658 list_for_each_entry(node
, &xenbus_valloc_pages
, next
) {
659 addr
= pfn_to_kaddr(page_to_pfn(node
->page
));
661 list_del(&node
->next
);
667 spin_unlock(&xenbus_valloc_lock
);
670 xenbus_dev_error(dev
, -ENOENT
,
671 "can't find mapped virtual address %p", vaddr
);
672 return GNTST_bad_virt_addr
;
675 rv
= xenbus_unmap_ring(dev
, node
->handle
, addr
);
678 free_xenballooned_pages(1, &node
->page
);
680 WARN(1, "Leaking %p\n", vaddr
);
688 * @dev: xenbus device
689 * @handle: grant handle
690 * @vaddr: addr to unmap
692 * Unmap a page of memory in this domain that was imported from another domain.
693 * Returns 0 on success and returns GNTST_* on error
694 * (see xen/include/interface/grant_table.h).
696 int xenbus_unmap_ring(struct xenbus_device
*dev
,
697 grant_handle_t handle
, void *vaddr
)
699 struct gnttab_unmap_grant_ref op
;
701 gnttab_set_unmap_op(&op
, (unsigned long)vaddr
, GNTMAP_host_map
, handle
);
703 if (HYPERVISOR_grant_table_op(GNTTABOP_unmap_grant_ref
, &op
, 1))
706 if (op
.status
!= GNTST_okay
)
707 xenbus_dev_error(dev
, op
.status
,
708 "unmapping page at handle %d error %d",
713 EXPORT_SYMBOL_GPL(xenbus_unmap_ring
);
717 * xenbus_read_driver_state
718 * @path: path for driver
720 * Return the state of the driver rooted at the given store path, or
721 * XenbusStateUnknown if no state can be read.
723 enum xenbus_state
xenbus_read_driver_state(const char *path
)
725 enum xenbus_state result
;
726 int err
= xenbus_gather(XBT_NIL
, path
, "state", "%d", &result
, NULL
);
728 result
= XenbusStateUnknown
;
732 EXPORT_SYMBOL_GPL(xenbus_read_driver_state
);
734 static const struct xenbus_ring_ops ring_ops_pv
= {
735 .map
= xenbus_map_ring_valloc_pv
,
736 .unmap
= xenbus_unmap_ring_vfree_pv
,
739 static const struct xenbus_ring_ops ring_ops_hvm
= {
740 .map
= xenbus_map_ring_valloc_hvm
,
741 .unmap
= xenbus_unmap_ring_vfree_hvm
,
744 void __init
xenbus_ring_ops_init(void)
747 ring_ops
= &ring_ops_pv
;
749 ring_ops
= &ring_ops_hvm
;