blob: 907bcbb93afbf2a9b1890523165620378e7c9863 [file] [log] [blame]
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -07001/******************************************************************************
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.
5 *
6 * Copyright (C) 2005 XenSource Ltd
7 *
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:
13 *
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:
20 *
21 * The above copyright notice and this permission notice shall be included in
22 * all copies or substantial portions of the Software.
23 *
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
30 * IN THE SOFTWARE.
31 */
32
Steven Noonan45e27162013-03-01 05:14:59 -080033#include <linux/mm.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090034#include <linux/slab.h>
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -070035#include <linux/types.h>
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -050036#include <linux/spinlock.h>
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -070037#include <linux/vmalloc.h>
Paul Gortmaker63c97442011-07-10 13:22:07 -040038#include <linux/export.h>
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -070039#include <asm/xen/hypervisor.h>
Julien Gralla9fd60e2015-06-17 15:28:02 +010040#include <xen/page.h>
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -070041#include <xen/interface/xen.h>
42#include <xen/interface/event_channel.h>
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -050043#include <xen/balloon.h>
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -070044#include <xen/events.h>
45#include <xen/grant_table.h>
46#include <xen/xenbus.h>
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -050047#include <xen/xen.h>
Mukesh Rathorbe3e9cf2013-12-31 13:57:35 -050048#include <xen/features.h>
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -050049
Juergen Gross332f7912017-02-09 14:39:56 +010050#include "xenbus.h"
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -050051
Julien Grall89bf4b42015-10-13 17:50:13 +010052#define XENBUS_PAGES(_grants) (DIV_ROUND_UP(_grants, XEN_PFN_PER_PAGE))
53
54#define XENBUS_MAX_RING_PAGES (XENBUS_PAGES(XENBUS_MAX_RING_GRANTS))
55
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -050056struct xenbus_map_node {
57 struct list_head next;
58 union {
Wei Liuccc9d902015-04-03 14:44:59 +080059 struct {
60 struct vm_struct *area;
61 } pv;
62 struct {
Julien Grall89bf4b42015-10-13 17:50:13 +010063 struct page *pages[XENBUS_MAX_RING_PAGES];
64 unsigned long addrs[XENBUS_MAX_RING_GRANTS];
Wei Liuccc9d902015-04-03 14:44:59 +080065 void *addr;
66 } hvm;
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -050067 };
Julien Grall9cce2912015-10-13 17:50:11 +010068 grant_handle_t handles[XENBUS_MAX_RING_GRANTS];
Wei Liuccc9d902015-04-03 14:44:59 +080069 unsigned int nr_handles;
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -050070};
71
Juergen Gross3848e4e2020-07-01 14:16:37 +020072struct map_ring_valloc {
73 struct xenbus_map_node *node;
74
75 /* Why do we need two arrays? See comment of __xenbus_map_ring */
76 union {
77 unsigned long addrs[XENBUS_MAX_RING_GRANTS];
78 pte_t *ptes[XENBUS_MAX_RING_GRANTS];
79 };
80 phys_addr_t phys_addrs[XENBUS_MAX_RING_GRANTS];
81
82 struct gnttab_map_grant_ref map[XENBUS_MAX_RING_GRANTS];
83 struct gnttab_unmap_grant_ref unmap[XENBUS_MAX_RING_GRANTS];
84
85 unsigned int idx; /* HVM only. */
86};
87
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -050088static DEFINE_SPINLOCK(xenbus_valloc_lock);
89static LIST_HEAD(xenbus_valloc_pages);
90
91struct xenbus_ring_ops {
Juergen Gross3848e4e2020-07-01 14:16:37 +020092 int (*map)(struct xenbus_device *dev, struct map_ring_valloc *info,
Wei Liuccc9d902015-04-03 14:44:59 +080093 grant_ref_t *gnt_refs, unsigned int nr_grefs,
94 void **vaddr);
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -050095 int (*unmap)(struct xenbus_device *dev, void *vaddr);
96};
97
98static const struct xenbus_ring_ops *ring_ops __read_mostly;
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -070099
100const char *xenbus_strstate(enum xenbus_state state)
101{
102 static const char *const name[] = {
103 [ XenbusStateUnknown ] = "Unknown",
104 [ XenbusStateInitialising ] = "Initialising",
105 [ XenbusStateInitWait ] = "InitWait",
106 [ XenbusStateInitialised ] = "Initialised",
107 [ XenbusStateConnected ] = "Connected",
108 [ XenbusStateClosing ] = "Closing",
109 [ XenbusStateClosed ] = "Closed",
Yosuke Iwamatsu89afb6e2009-10-13 17:22:27 -0400110 [XenbusStateReconfiguring] = "Reconfiguring",
111 [XenbusStateReconfigured] = "Reconfigured",
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700112 };
113 return (state < ARRAY_SIZE(name)) ? name[state] : "INVALID";
114}
115EXPORT_SYMBOL_GPL(xenbus_strstate);
116
117/**
118 * xenbus_watch_path - register a watch
119 * @dev: xenbus device
120 * @path: path to watch
121 * @watch: watch to register
122 * @callback: callback to register
123 *
124 * Register a @watch on the given path, using the given xenbus_watch structure
125 * for storage, and the given @callback function as the callback. Return 0 on
126 * success, or -errno on error. On success, the given @path will be saved as
127 * @watch->node, and remains the caller's to free. On error, @watch->node will
128 * be NULL, the device will switch to %XenbusStateClosing, and the error will
129 * be saved in the store.
130 */
131int xenbus_watch_path(struct xenbus_device *dev, const char *path,
132 struct xenbus_watch *watch,
133 void (*callback)(struct xenbus_watch *,
Juergen Gross5584ea22017-02-09 14:39:57 +0100134 const char *, const char *))
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700135{
136 int err;
137
138 watch->node = path;
139 watch->callback = callback;
140
141 err = register_xenbus_watch(watch);
142
143 if (err) {
144 watch->node = NULL;
145 watch->callback = NULL;
146 xenbus_dev_fatal(dev, err, "adding watch on %s", path);
147 }
148
149 return err;
150}
151EXPORT_SYMBOL_GPL(xenbus_watch_path);
152
153
154/**
155 * xenbus_watch_pathfmt - register a watch on a sprintf-formatted path
156 * @dev: xenbus device
157 * @watch: watch to register
158 * @callback: callback to register
159 * @pathfmt: format of path to watch
160 *
161 * Register a watch on the given @path, using the given xenbus_watch
162 * structure for storage, and the given @callback function as the callback.
163 * Return 0 on success, or -errno on error. On success, the watched path
164 * (@path/@path2) will be saved as @watch->node, and becomes the caller's to
165 * kfree(). On error, watch->node will be NULL, so the caller has nothing to
166 * free, the device will switch to %XenbusStateClosing, and the error will be
167 * saved in the store.
168 */
169int xenbus_watch_pathfmt(struct xenbus_device *dev,
170 struct xenbus_watch *watch,
171 void (*callback)(struct xenbus_watch *,
Juergen Gross5584ea22017-02-09 14:39:57 +0100172 const char *, const char *),
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700173 const char *pathfmt, ...)
174{
175 int err;
176 va_list ap;
177 char *path;
178
179 va_start(ap, pathfmt);
Ian Campbella144ff02008-06-17 10:47:08 +0200180 path = kvasprintf(GFP_NOIO | __GFP_HIGH, pathfmt, ap);
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700181 va_end(ap);
182
183 if (!path) {
184 xenbus_dev_fatal(dev, -ENOMEM, "allocating path for watch");
185 return -ENOMEM;
186 }
187 err = xenbus_watch_path(dev, path, watch, callback);
188
189 if (err)
190 kfree(path);
191 return err;
192}
193EXPORT_SYMBOL_GPL(xenbus_watch_pathfmt);
194
Daniel Stodden5b61cb92010-04-30 22:01:15 +0000195static void xenbus_switch_fatal(struct xenbus_device *, int, int,
196 const char *, ...);
197
198static int
199__xenbus_switch_state(struct xenbus_device *dev,
200 enum xenbus_state state, int depth)
201{
202 /* We check whether the state is currently set to the given value, and
203 if not, then the state is set. We don't want to unconditionally
204 write the given state, because we don't want to fire watches
205 unnecessarily. Furthermore, if the node has gone, we don't write
206 to it, as the device will be tearing down, and we don't want to
207 resurrect that directory.
208
209 Note that, because of this cached value of our state, this
210 function will not take a caller's Xenstore transaction
211 (something it was trying to in the past) because dev->state
212 would not get reset if the transaction was aborted.
213 */
214
215 struct xenbus_transaction xbt;
216 int current_state;
217 int err, abort;
218
219 if (state == dev->state)
220 return 0;
221
222again:
223 abort = 1;
224
225 err = xenbus_transaction_start(&xbt);
226 if (err) {
227 xenbus_switch_fatal(dev, depth, err, "starting transaction");
228 return 0;
229 }
230
231 err = xenbus_scanf(xbt, dev->nodename, "state", "%d", &current_state);
232 if (err != 1)
233 goto abort;
234
235 err = xenbus_printf(xbt, dev->nodename, "state", "%d", state);
236 if (err) {
237 xenbus_switch_fatal(dev, depth, err, "writing new state");
238 goto abort;
239 }
240
241 abort = 0;
242abort:
243 err = xenbus_transaction_end(xbt, abort);
244 if (err) {
245 if (err == -EAGAIN && !abort)
246 goto again;
247 xenbus_switch_fatal(dev, depth, err, "ending transaction");
248 } else
249 dev->state = state;
250
251 return 0;
252}
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700253
254/**
255 * xenbus_switch_state
256 * @dev: xenbus device
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700257 * @state: new state
258 *
259 * Advertise in the store a change of the given driver to the given new_state.
260 * Return 0 on success, or -errno on error. On error, the device will switch
261 * to XenbusStateClosing, and the error will be saved in the store.
262 */
263int xenbus_switch_state(struct xenbus_device *dev, enum xenbus_state state)
264{
Daniel Stodden5b61cb92010-04-30 22:01:15 +0000265 return __xenbus_switch_state(dev, state, 0);
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700266}
Daniel Stodden5b61cb92010-04-30 22:01:15 +0000267
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700268EXPORT_SYMBOL_GPL(xenbus_switch_state);
269
270int xenbus_frontend_closed(struct xenbus_device *dev)
271{
272 xenbus_switch_state(dev, XenbusStateClosed);
273 complete(&dev->down);
274 return 0;
275}
276EXPORT_SYMBOL_GPL(xenbus_frontend_closed);
277
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700278static void xenbus_va_dev_error(struct xenbus_device *dev, int err,
279 const char *fmt, va_list ap)
280{
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700281 unsigned int len;
Joe Perchesc0d197d2017-02-08 03:33:36 -0800282 char *printf_buffer;
283 char *path_buffer;
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700284
285#define PRINTF_BUFFER_SIZE 4096
Joe Perchesc0d197d2017-02-08 03:33:36 -0800286
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700287 printf_buffer = kmalloc(PRINTF_BUFFER_SIZE, GFP_KERNEL);
Joe Perchesc0d197d2017-02-08 03:33:36 -0800288 if (!printf_buffer)
289 return;
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700290
291 len = sprintf(printf_buffer, "%i ", -err);
Joe Perchesc0d197d2017-02-08 03:33:36 -0800292 vsnprintf(printf_buffer + len, PRINTF_BUFFER_SIZE - len, fmt, ap);
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700293
294 dev_err(&dev->dev, "%s\n", printf_buffer);
295
Joe Perchesc0d197d2017-02-08 03:33:36 -0800296 path_buffer = kasprintf(GFP_KERNEL, "error/%s", dev->nodename);
Juergen Gross7a048ce2018-10-09 18:09:59 +0200297 if (path_buffer)
298 xenbus_write(XBT_NIL, path_buffer, "error", printf_buffer);
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700299
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700300 kfree(printf_buffer);
301 kfree(path_buffer);
302}
303
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700304/**
305 * xenbus_dev_error
306 * @dev: xenbus device
307 * @err: error to report
308 * @fmt: error message format
309 *
310 * Report the given negative errno into the store, along with the given
311 * formatted message.
312 */
313void xenbus_dev_error(struct xenbus_device *dev, int err, const char *fmt, ...)
314{
315 va_list ap;
316
317 va_start(ap, fmt);
318 xenbus_va_dev_error(dev, err, fmt, ap);
319 va_end(ap);
320}
321EXPORT_SYMBOL_GPL(xenbus_dev_error);
322
323/**
324 * xenbus_dev_fatal
325 * @dev: xenbus device
326 * @err: error to report
327 * @fmt: error message format
328 *
329 * Equivalent to xenbus_dev_error(dev, err, fmt, args), followed by
Qinghuang Fengd8220342009-01-07 18:07:10 -0800330 * xenbus_switch_state(dev, XenbusStateClosing) to schedule an orderly
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700331 * closedown of this driver and its peer.
332 */
333
334void xenbus_dev_fatal(struct xenbus_device *dev, int err, const char *fmt, ...)
335{
336 va_list ap;
337
338 va_start(ap, fmt);
339 xenbus_va_dev_error(dev, err, fmt, ap);
340 va_end(ap);
341
342 xenbus_switch_state(dev, XenbusStateClosing);
343}
344EXPORT_SYMBOL_GPL(xenbus_dev_fatal);
345
346/**
Daniel Stodden5b61cb92010-04-30 22:01:15 +0000347 * Equivalent to xenbus_dev_fatal(dev, err, fmt, args), but helps
348 * avoiding recursion within xenbus_switch_state.
349 */
350static void xenbus_switch_fatal(struct xenbus_device *dev, int depth, int err,
351 const char *fmt, ...)
352{
353 va_list ap;
354
355 va_start(ap, fmt);
356 xenbus_va_dev_error(dev, err, fmt, ap);
357 va_end(ap);
358
359 if (!depth)
360 __xenbus_switch_state(dev, XenbusStateClosing, 1);
361}
362
363/**
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700364 * xenbus_grant_ring
365 * @dev: xenbus device
Wei Liuccc9d902015-04-03 14:44:59 +0800366 * @vaddr: starting virtual address of the ring
367 * @nr_pages: number of pages to be granted
368 * @grefs: grant reference array to be filled in
369 *
370 * Grant access to the given @vaddr to the peer of the given device.
371 * Then fill in @grefs with grant references. Return 0 on success, or
372 * -errno on error. On error, the device will switch to
373 * XenbusStateClosing, and the error will be saved in the store.
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700374 */
Wei Liuccc9d902015-04-03 14:44:59 +0800375int xenbus_grant_ring(struct xenbus_device *dev, void *vaddr,
376 unsigned int nr_pages, grant_ref_t *grefs)
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700377{
Wei Liuccc9d902015-04-03 14:44:59 +0800378 int err;
379 int i, j;
380
381 for (i = 0; i < nr_pages; i++) {
Simon Leinerd742db72020-08-25 11:31:52 +0200382 unsigned long gfn;
383
384 if (is_vmalloc_addr(vaddr))
385 gfn = pfn_to_gfn(vmalloc_to_pfn(vaddr));
386 else
387 gfn = virt_to_gfn(vaddr);
388
389 err = gnttab_grant_foreign_access(dev->otherend_id, gfn, 0);
Wei Liuccc9d902015-04-03 14:44:59 +0800390 if (err < 0) {
391 xenbus_dev_fatal(dev, err,
392 "granting access to ring page");
393 goto fail;
394 }
395 grefs[i] = err;
Julien Grallc9fd55e2015-06-17 15:28:03 +0100396
Julien Grall7d567922015-05-05 16:38:27 +0100397 vaddr = vaddr + XEN_PAGE_SIZE;
Wei Liuccc9d902015-04-03 14:44:59 +0800398 }
399
400 return 0;
401
402fail:
403 for (j = 0; j < i; j++)
404 gnttab_end_foreign_access_ref(grefs[j], 0);
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700405 return err;
406}
407EXPORT_SYMBOL_GPL(xenbus_grant_ring);
408
409
410/**
411 * Allocate an event channel for the given xenbus_device, assigning the newly
412 * created local port to *port. Return 0 on success, or -errno on error. On
413 * error, the device will switch to XenbusStateClosing, and the error will be
414 * saved in the store.
415 */
Yan Yankovskyi0102e4e2020-03-23 18:15:11 +0200416int xenbus_alloc_evtchn(struct xenbus_device *dev, evtchn_port_t *port)
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700417{
418 struct evtchn_alloc_unbound alloc_unbound;
419 int err;
420
421 alloc_unbound.dom = DOMID_SELF;
422 alloc_unbound.remote_dom = dev->otherend_id;
423
424 err = HYPERVISOR_event_channel_op(EVTCHNOP_alloc_unbound,
425 &alloc_unbound);
426 if (err)
427 xenbus_dev_fatal(dev, err, "allocating event channel");
428 else
429 *port = alloc_unbound.port;
430
431 return err;
432}
433EXPORT_SYMBOL_GPL(xenbus_alloc_evtchn);
434
435
436/**
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700437 * Free an existing event channel. Returns 0 on success or -errno on error.
438 */
Yan Yankovskyi0102e4e2020-03-23 18:15:11 +0200439int xenbus_free_evtchn(struct xenbus_device *dev, evtchn_port_t port)
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700440{
441 struct evtchn_close close;
442 int err;
443
444 close.port = port;
445
446 err = HYPERVISOR_event_channel_op(EVTCHNOP_close, &close);
447 if (err)
Yan Yankovskyi0102e4e2020-03-23 18:15:11 +0200448 xenbus_dev_error(dev, err, "freeing event channel %u", port);
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700449
450 return err;
451}
452EXPORT_SYMBOL_GPL(xenbus_free_evtchn);
453
454
455/**
456 * xenbus_map_ring_valloc
457 * @dev: xenbus device
Wei Liuccc9d902015-04-03 14:44:59 +0800458 * @gnt_refs: grant reference array
459 * @nr_grefs: number of grant references
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700460 * @vaddr: pointer to address to be filled out by mapping
461 *
Wei Liuccc9d902015-04-03 14:44:59 +0800462 * Map @nr_grefs pages of memory into this domain from another
463 * domain's grant table. xenbus_map_ring_valloc allocates @nr_grefs
464 * pages of virtual address space, maps the pages to that address, and
Juergen Gross578c1bb2020-07-01 14:16:38 +0200465 * sets *vaddr to that address. Returns 0 on success, and -errno on
Wei Liuccc9d902015-04-03 14:44:59 +0800466 * error. If an error is returned, device will switch to
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700467 * XenbusStateClosing and the error message will be saved in XenStore.
468 */
Wei Liuccc9d902015-04-03 14:44:59 +0800469int xenbus_map_ring_valloc(struct xenbus_device *dev, grant_ref_t *gnt_refs,
470 unsigned int nr_grefs, void **vaddr)
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700471{
Juergen Gross6b51fd32020-03-26 09:03:58 +0100472 int err;
Juergen Gross3848e4e2020-07-01 14:16:37 +0200473 struct map_ring_valloc *info;
Juergen Gross6b51fd32020-03-26 09:03:58 +0100474
Juergen Gross3848e4e2020-07-01 14:16:37 +0200475 *vaddr = NULL;
476
477 if (nr_grefs > XENBUS_MAX_RING_GRANTS)
478 return -EINVAL;
479
480 info = kzalloc(sizeof(*info), GFP_KERNEL);
481 if (!info)
482 return -ENOMEM;
483
484 info->node = kzalloc(sizeof(*info->node), GFP_KERNEL);
Juergen Gross578c1bb2020-07-01 14:16:38 +0200485 if (!info->node)
Juergen Gross3848e4e2020-07-01 14:16:37 +0200486 err = -ENOMEM;
Juergen Gross578c1bb2020-07-01 14:16:38 +0200487 else
488 err = ring_ops->map(dev, info, gnt_refs, nr_grefs, vaddr);
Juergen Gross3848e4e2020-07-01 14:16:37 +0200489
Juergen Gross3848e4e2020-07-01 14:16:37 +0200490 kfree(info->node);
491 kfree(info);
Juergen Gross6b51fd32020-03-26 09:03:58 +0100492 return err;
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -0500493}
494EXPORT_SYMBOL_GPL(xenbus_map_ring_valloc);
495
Wei Liuccc9d902015-04-03 14:44:59 +0800496/* N.B. sizeof(phys_addr_t) doesn't always equal to sizeof(unsigned
497 * long), e.g. 32-on-64. Caller is responsible for preparing the
498 * right array to feed into this function */
499static int __xenbus_map_ring(struct xenbus_device *dev,
500 grant_ref_t *gnt_refs,
501 unsigned int nr_grefs,
502 grant_handle_t *handles,
Juergen Gross3848e4e2020-07-01 14:16:37 +0200503 struct map_ring_valloc *info,
Wei Liuccc9d902015-04-03 14:44:59 +0800504 unsigned int flags,
505 bool *leaked)
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -0500506{
Wei Liuccc9d902015-04-03 14:44:59 +0800507 int i, j;
Wei Liuccc9d902015-04-03 14:44:59 +0800508
Julien Grall9cce2912015-10-13 17:50:11 +0100509 if (nr_grefs > XENBUS_MAX_RING_GRANTS)
Wei Liuccc9d902015-04-03 14:44:59 +0800510 return -EINVAL;
511
512 for (i = 0; i < nr_grefs; i++) {
Juergen Gross3848e4e2020-07-01 14:16:37 +0200513 gnttab_set_map_op(&info->map[i], info->phys_addrs[i], flags,
514 gnt_refs[i], dev->otherend_id);
Wei Liuccc9d902015-04-03 14:44:59 +0800515 handles[i] = INVALID_GRANT_HANDLE;
516 }
517
Juergen Gross3848e4e2020-07-01 14:16:37 +0200518 gnttab_batch_map(info->map, i);
Wei Liuccc9d902015-04-03 14:44:59 +0800519
520 for (i = 0; i < nr_grefs; i++) {
Juergen Gross3848e4e2020-07-01 14:16:37 +0200521 if (info->map[i].status != GNTST_okay) {
Juergen Gross3848e4e2020-07-01 14:16:37 +0200522 xenbus_dev_fatal(dev, info->map[i].status,
Wei Liuccc9d902015-04-03 14:44:59 +0800523 "mapping in shared page %d from domain %d",
524 gnt_refs[i], dev->otherend_id);
525 goto fail;
526 } else
Juergen Gross3848e4e2020-07-01 14:16:37 +0200527 handles[i] = info->map[i].handle;
Wei Liuccc9d902015-04-03 14:44:59 +0800528 }
529
Juergen Gross578c1bb2020-07-01 14:16:38 +0200530 return 0;
Wei Liuccc9d902015-04-03 14:44:59 +0800531
532 fail:
533 for (i = j = 0; i < nr_grefs; i++) {
534 if (handles[i] != INVALID_GRANT_HANDLE) {
Juergen Gross3848e4e2020-07-01 14:16:37 +0200535 gnttab_set_unmap_op(&info->unmap[j],
536 info->phys_addrs[i],
Wei Liuccc9d902015-04-03 14:44:59 +0800537 GNTMAP_host_map, handles[i]);
538 j++;
539 }
540 }
541
Juergen Gross3848e4e2020-07-01 14:16:37 +0200542 if (HYPERVISOR_grant_table_op(GNTTABOP_unmap_grant_ref, info->unmap, j))
Wei Liuccc9d902015-04-03 14:44:59 +0800543 BUG();
544
545 *leaked = false;
546 for (i = 0; i < j; i++) {
Juergen Gross3848e4e2020-07-01 14:16:37 +0200547 if (info->unmap[i].status != GNTST_okay) {
Wei Liuccc9d902015-04-03 14:44:59 +0800548 *leaked = true;
549 break;
550 }
551 }
552
Juergen Gross578c1bb2020-07-01 14:16:38 +0200553 return -ENOENT;
Wei Liuccc9d902015-04-03 14:44:59 +0800554}
555
Juergen Grossb28089a2020-03-09 16:54:41 +0100556/**
557 * xenbus_unmap_ring
558 * @dev: xenbus device
559 * @handles: grant handle array
560 * @nr_handles: number of handles in the array
561 * @vaddrs: addresses to unmap
562 *
563 * Unmap memory in this domain that was imported from another domain.
564 * Returns 0 on success and returns GNTST_* on error
565 * (see xen/include/interface/grant_table.h).
566 */
567static int xenbus_unmap_ring(struct xenbus_device *dev, grant_handle_t *handles,
568 unsigned int nr_handles, unsigned long *vaddrs)
569{
570 struct gnttab_unmap_grant_ref unmap[XENBUS_MAX_RING_GRANTS];
571 int i;
572 int err;
573
574 if (nr_handles > XENBUS_MAX_RING_GRANTS)
575 return -EINVAL;
576
577 for (i = 0; i < nr_handles; i++)
578 gnttab_set_unmap_op(&unmap[i], vaddrs[i],
579 GNTMAP_host_map, handles[i]);
580
581 if (HYPERVISOR_grant_table_op(GNTTABOP_unmap_grant_ref, unmap, i))
582 BUG();
583
584 err = GNTST_okay;
585 for (i = 0; i < nr_handles; i++) {
586 if (unmap[i].status != GNTST_okay) {
587 xenbus_dev_error(dev, unmap[i].status,
588 "unmapping page at handle %d error %d",
589 handles[i], unmap[i].status);
590 err = unmap[i].status;
591 break;
592 }
593 }
594
595 return err;
596}
597
Julien Grall89bf4b42015-10-13 17:50:13 +0100598static void xenbus_map_ring_setup_grant_hvm(unsigned long gfn,
599 unsigned int goffset,
600 unsigned int len,
601 void *data)
602{
Juergen Gross3848e4e2020-07-01 14:16:37 +0200603 struct map_ring_valloc *info = data;
Julien Grall89bf4b42015-10-13 17:50:13 +0100604 unsigned long vaddr = (unsigned long)gfn_to_virt(gfn);
605
606 info->phys_addrs[info->idx] = vaddr;
607 info->addrs[info->idx] = vaddr;
608
609 info->idx++;
610}
611
Juergen Gross3848e4e2020-07-01 14:16:37 +0200612static int xenbus_map_ring_hvm(struct xenbus_device *dev,
613 struct map_ring_valloc *info,
614 grant_ref_t *gnt_ref,
615 unsigned int nr_grefs,
616 void **vaddr)
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -0500617{
Juergen Gross3848e4e2020-07-01 14:16:37 +0200618 struct xenbus_map_node *node = info->node;
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -0500619 int err;
620 void *addr;
Wei Liuccc9d902015-04-03 14:44:59 +0800621 bool leaked = false;
Julien Grall89bf4b42015-10-13 17:50:13 +0100622 unsigned int nr_pages = XENBUS_PAGES(nr_grefs);
Wei Liuccc9d902015-04-03 14:44:59 +0800623
Julien Grall89bf4b42015-10-13 17:50:13 +0100624 err = alloc_xenballooned_pages(nr_pages, node->hvm.pages);
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -0500625 if (err)
626 goto out_err;
627
Julien Grall89bf4b42015-10-13 17:50:13 +0100628 gnttab_foreach_grant(node->hvm.pages, nr_grefs,
629 xenbus_map_ring_setup_grant_hvm,
Juergen Gross3848e4e2020-07-01 14:16:37 +0200630 info);
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -0500631
Wei Liuccc9d902015-04-03 14:44:59 +0800632 err = __xenbus_map_ring(dev, gnt_ref, nr_grefs, node->handles,
Juergen Gross3848e4e2020-07-01 14:16:37 +0200633 info, GNTMAP_host_map, &leaked);
Wei Liuccc9d902015-04-03 14:44:59 +0800634 node->nr_handles = nr_grefs;
635
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -0500636 if (err)
Wei Liuccc9d902015-04-03 14:44:59 +0800637 goto out_free_ballooned_pages;
638
Julien Grall89bf4b42015-10-13 17:50:13 +0100639 addr = vmap(node->hvm.pages, nr_pages, VM_MAP | VM_IOREMAP,
Wei Liuccc9d902015-04-03 14:44:59 +0800640 PAGE_KERNEL);
641 if (!addr) {
642 err = -ENOMEM;
643 goto out_xenbus_unmap_ring;
644 }
645
646 node->hvm.addr = addr;
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -0500647
648 spin_lock(&xenbus_valloc_lock);
649 list_add(&node->next, &xenbus_valloc_pages);
650 spin_unlock(&xenbus_valloc_lock);
651
652 *vaddr = addr;
Juergen Gross3848e4e2020-07-01 14:16:37 +0200653 info->node = NULL;
654
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -0500655 return 0;
656
Wei Liuccc9d902015-04-03 14:44:59 +0800657 out_xenbus_unmap_ring:
658 if (!leaked)
Juergen Gross3848e4e2020-07-01 14:16:37 +0200659 xenbus_unmap_ring(dev, node->handles, nr_grefs, info->addrs);
Wei Liuccc9d902015-04-03 14:44:59 +0800660 else
661 pr_alert("leaking %p size %u page(s)",
Julien Grall89bf4b42015-10-13 17:50:13 +0100662 addr, nr_pages);
Wei Liuccc9d902015-04-03 14:44:59 +0800663 out_free_ballooned_pages:
664 if (!leaked)
Julien Grall89bf4b42015-10-13 17:50:13 +0100665 free_xenballooned_pages(nr_pages, node->hvm.pages);
Wei Liu8d0b8802013-05-29 17:02:58 +0100666 out_err:
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -0500667 return err;
668}
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700669
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700670/**
671 * xenbus_unmap_ring_vfree
672 * @dev: xenbus device
673 * @vaddr: addr to unmap
674 *
675 * Based on Rusty Russell's skeleton driver's unmap_page.
676 * Unmap a page of memory in this domain that was imported from another domain.
677 * Use xenbus_unmap_ring_vfree if you mapped in your memory with
678 * xenbus_map_ring_valloc (it will free the virtual address space).
679 * Returns 0 on success and returns GNTST_* on error
680 * (see xen/include/interface/grant_table.h).
681 */
682int xenbus_unmap_ring_vfree(struct xenbus_device *dev, void *vaddr)
683{
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -0500684 return ring_ops->unmap(dev, vaddr);
685}
686EXPORT_SYMBOL_GPL(xenbus_unmap_ring_vfree);
687
Juergen Grossfe9c1c92017-09-14 14:38:58 +0200688#ifdef CONFIG_XEN_PV
Juergen Gross3848e4e2020-07-01 14:16:37 +0200689static int xenbus_map_ring_pv(struct xenbus_device *dev,
690 struct map_ring_valloc *info,
691 grant_ref_t *gnt_refs,
692 unsigned int nr_grefs,
693 void **vaddr)
Juergen Grossfe9c1c92017-09-14 14:38:58 +0200694{
Juergen Gross3848e4e2020-07-01 14:16:37 +0200695 struct xenbus_map_node *node = info->node;
Juergen Grossfe9c1c92017-09-14 14:38:58 +0200696 struct vm_struct *area;
Juergen Grossfe9c1c92017-09-14 14:38:58 +0200697 int err = GNTST_okay;
698 int i;
699 bool leaked;
700
Juergen Gross3848e4e2020-07-01 14:16:37 +0200701 area = alloc_vm_area(XEN_PAGE_SIZE * nr_grefs, info->ptes);
Dan Carpenterba8c4232020-07-10 14:36:10 +0300702 if (!area)
Juergen Grossfe9c1c92017-09-14 14:38:58 +0200703 return -ENOMEM;
Juergen Grossfe9c1c92017-09-14 14:38:58 +0200704
705 for (i = 0; i < nr_grefs; i++)
Juergen Gross3848e4e2020-07-01 14:16:37 +0200706 info->phys_addrs[i] =
707 arbitrary_virt_to_machine(info->ptes[i]).maddr;
Juergen Grossfe9c1c92017-09-14 14:38:58 +0200708
709 err = __xenbus_map_ring(dev, gnt_refs, nr_grefs, node->handles,
Juergen Gross3848e4e2020-07-01 14:16:37 +0200710 info, GNTMAP_host_map | GNTMAP_contains_pte,
Juergen Grossfe9c1c92017-09-14 14:38:58 +0200711 &leaked);
712 if (err)
713 goto failed;
714
715 node->nr_handles = nr_grefs;
716 node->pv.area = area;
717
718 spin_lock(&xenbus_valloc_lock);
719 list_add(&node->next, &xenbus_valloc_pages);
720 spin_unlock(&xenbus_valloc_lock);
721
722 *vaddr = area->addr;
Juergen Gross3848e4e2020-07-01 14:16:37 +0200723 info->node = NULL;
724
Juergen Grossfe9c1c92017-09-14 14:38:58 +0200725 return 0;
726
727failed:
728 if (!leaked)
729 free_vm_area(area);
730 else
731 pr_alert("leaking VM area %p size %u page(s)", area, nr_grefs);
732
Juergen Grossfe9c1c92017-09-14 14:38:58 +0200733 return err;
734}
735
Juergen Gross3848e4e2020-07-01 14:16:37 +0200736static int xenbus_unmap_ring_pv(struct xenbus_device *dev, void *vaddr)
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -0500737{
738 struct xenbus_map_node *node;
Julien Grall9cce2912015-10-13 17:50:11 +0100739 struct gnttab_unmap_grant_ref unmap[XENBUS_MAX_RING_GRANTS];
David Vrabelcd129092011-09-29 16:53:32 +0100740 unsigned int level;
Wei Liuccc9d902015-04-03 14:44:59 +0800741 int i;
742 bool leaked = false;
743 int err;
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700744
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -0500745 spin_lock(&xenbus_valloc_lock);
746 list_for_each_entry(node, &xenbus_valloc_pages, next) {
Wei Liuccc9d902015-04-03 14:44:59 +0800747 if (node->pv.area->addr == vaddr) {
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -0500748 list_del(&node->next);
749 goto found;
750 }
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700751 }
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -0500752 node = NULL;
753 found:
754 spin_unlock(&xenbus_valloc_lock);
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700755
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -0500756 if (!node) {
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700757 xenbus_dev_error(dev, -ENOENT,
758 "can't find mapped virtual address %p", vaddr);
759 return GNTST_bad_virt_addr;
760 }
761
Wei Liuccc9d902015-04-03 14:44:59 +0800762 for (i = 0; i < node->nr_handles; i++) {
763 unsigned long addr;
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700764
Wei Liuccc9d902015-04-03 14:44:59 +0800765 memset(&unmap[i], 0, sizeof(unmap[i]));
Julien Grall7d567922015-05-05 16:38:27 +0100766 addr = (unsigned long)vaddr + (XEN_PAGE_SIZE * i);
Wei Liuccc9d902015-04-03 14:44:59 +0800767 unmap[i].host_addr = arbitrary_virt_to_machine(
768 lookup_address(addr, &level)).maddr;
769 unmap[i].dev_bus_addr = 0;
770 unmap[i].handle = node->handles[i];
771 }
772
773 if (HYPERVISOR_grant_table_op(GNTTABOP_unmap_grant_ref, unmap, i))
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700774 BUG();
775
Wei Liuccc9d902015-04-03 14:44:59 +0800776 err = GNTST_okay;
777 leaked = false;
778 for (i = 0; i < node->nr_handles; i++) {
779 if (unmap[i].status != GNTST_okay) {
780 leaked = true;
781 xenbus_dev_error(dev, unmap[i].status,
782 "unmapping page at handle %d error %d",
783 node->handles[i], unmap[i].status);
784 err = unmap[i].status;
785 break;
786 }
787 }
788
789 if (!leaked)
790 free_vm_area(node->pv.area);
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700791 else
Wei Liuccc9d902015-04-03 14:44:59 +0800792 pr_alert("leaking VM area %p size %u page(s)",
793 node->pv.area, node->nr_handles);
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700794
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -0500795 kfree(node);
Wei Liuccc9d902015-04-03 14:44:59 +0800796 return err;
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700797}
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700798
Juergen Grossfe9c1c92017-09-14 14:38:58 +0200799static const struct xenbus_ring_ops ring_ops_pv = {
Juergen Gross3848e4e2020-07-01 14:16:37 +0200800 .map = xenbus_map_ring_pv,
801 .unmap = xenbus_unmap_ring_pv,
Juergen Grossfe9c1c92017-09-14 14:38:58 +0200802};
803#endif
804
Juergen Gross3848e4e2020-07-01 14:16:37 +0200805struct unmap_ring_hvm
Julien Grall89bf4b42015-10-13 17:50:13 +0100806{
807 unsigned int idx;
808 unsigned long addrs[XENBUS_MAX_RING_GRANTS];
809};
810
811static void xenbus_unmap_ring_setup_grant_hvm(unsigned long gfn,
812 unsigned int goffset,
813 unsigned int len,
814 void *data)
815{
Juergen Gross3848e4e2020-07-01 14:16:37 +0200816 struct unmap_ring_hvm *info = data;
Julien Grall89bf4b42015-10-13 17:50:13 +0100817
818 info->addrs[info->idx] = (unsigned long)gfn_to_virt(gfn);
819
820 info->idx++;
821}
822
Juergen Gross3848e4e2020-07-01 14:16:37 +0200823static int xenbus_unmap_ring_hvm(struct xenbus_device *dev, void *vaddr)
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -0500824{
825 int rv;
826 struct xenbus_map_node *node;
827 void *addr;
Juergen Gross3848e4e2020-07-01 14:16:37 +0200828 struct unmap_ring_hvm info = {
Julien Grall89bf4b42015-10-13 17:50:13 +0100829 .idx = 0,
830 };
831 unsigned int nr_pages;
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -0500832
833 spin_lock(&xenbus_valloc_lock);
834 list_for_each_entry(node, &xenbus_valloc_pages, next) {
Wei Liuccc9d902015-04-03 14:44:59 +0800835 addr = node->hvm.addr;
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -0500836 if (addr == vaddr) {
837 list_del(&node->next);
838 goto found;
839 }
840 }
Jan Beulich5ac08002012-02-24 11:46:32 +0000841 node = addr = NULL;
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -0500842 found:
843 spin_unlock(&xenbus_valloc_lock);
844
845 if (!node) {
846 xenbus_dev_error(dev, -ENOENT,
847 "can't find mapped virtual address %p", vaddr);
848 return GNTST_bad_virt_addr;
849 }
850
Julien Grall89bf4b42015-10-13 17:50:13 +0100851 nr_pages = XENBUS_PAGES(node->nr_handles);
852
853 gnttab_foreach_grant(node->hvm.pages, node->nr_handles,
854 xenbus_unmap_ring_setup_grant_hvm,
855 &info);
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -0500856
Wei Liuccc9d902015-04-03 14:44:59 +0800857 rv = xenbus_unmap_ring(dev, node->handles, node->nr_handles,
Julien Grall89bf4b42015-10-13 17:50:13 +0100858 info.addrs);
Julien Grallc22fe512015-08-10 19:10:38 +0100859 if (!rv) {
Wei Liuccc9d902015-04-03 14:44:59 +0800860 vunmap(vaddr);
Julien Grall89bf4b42015-10-13 17:50:13 +0100861 free_xenballooned_pages(nr_pages, node->hvm.pages);
Julien Grallc22fe512015-08-10 19:10:38 +0100862 }
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -0500863 else
Julien Grall89bf4b42015-10-13 17:50:13 +0100864 WARN(1, "Leaking %p, size %u page(s)\n", vaddr, nr_pages);
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -0500865
866 kfree(node);
867 return rv;
868}
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700869
870/**
Jeremy Fitzhardinge4bac07c2007-07-17 18:37:06 -0700871 * xenbus_read_driver_state
872 * @path: path for driver
873 *
874 * Return the state of the driver rooted at the given store path, or
875 * XenbusStateUnknown if no state can be read.
876 */
877enum xenbus_state xenbus_read_driver_state(const char *path)
878{
879 enum xenbus_state result;
880 int err = xenbus_gather(XBT_NIL, path, "state", "%d", &result, NULL);
881 if (err)
882 result = XenbusStateUnknown;
883
884 return result;
885}
886EXPORT_SYMBOL_GPL(xenbus_read_driver_state);
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -0500887
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -0500888static const struct xenbus_ring_ops ring_ops_hvm = {
Juergen Gross3848e4e2020-07-01 14:16:37 +0200889 .map = xenbus_map_ring_hvm,
890 .unmap = xenbus_unmap_ring_hvm,
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -0500891};
892
893void __init xenbus_ring_ops_init(void)
894{
Juergen Grossfe9c1c92017-09-14 14:38:58 +0200895#ifdef CONFIG_XEN_PV
Mukesh Rathorbe3e9cf2013-12-31 13:57:35 -0500896 if (!xen_feature(XENFEAT_auto_translated_physmap))
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -0500897 ring_ops = &ring_ops_pv;
898 else
Juergen Grossfe9c1c92017-09-14 14:38:58 +0200899#endif
Daniel De Graaf2c5d37d2011-12-19 14:55:14 -0500900 ring_ops = &ring_ops_hvm;
901}