drivers/xen/xenbus/xenbus_dev_frontend.c

   1 /*
   2  * Driver giving user-space access to the kernel's xenbus connection
   3  * to xenstore.
   4  *
   5  * Copyright (c) 2005, Christian Limpach
   6  * Copyright (c) 2005, Rusty Russell, IBM Corporation
   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  * Changes:
  33  * 2008-10-07  Alex Zeffertt    Replaced /proc/xen/xenbus with xenfs filesystem
  34  *                              and /proc/xen compatibility mount point.
  35  *                              Turned xenfs into a loadable module.
  36  */
  37
  38 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  39
  40 #include <linux/kernel.h>
  41 #include <linux/errno.h>
  42 #include <linux/uio.h>
  43 #include <linux/notifier.h>
  44 #include <linux/wait.h>
  45 #include <linux/fs.h>
  46 #include <linux/poll.h>
  47 #include <linux/mutex.h>
  48 #include <linux/sched.h>
  49 #include <linux/spinlock.h>
  50 #include <linux/mount.h>
  51 #include <linux/pagemap.h>
  52 #include <linux/uaccess.h>
  53 #include <linux/init.h>
  54 #include <linux/namei.h>
  55 #include <linux/string.h>
  56 #include <linux/slab.h>
  57 #include <linux/miscdevice.h>
  58 #include <linux/workqueue.h>
  59
  60 #include <xen/xenbus.h>
  61 #include <xen/xen.h>
  62 #include <asm/xen/hypervisor.h>
  63
  64 #include "xenbus.h"
  65
  66 /*
  67  * An element of a list of outstanding transactions, for which we're
  68  * still waiting a reply.
  69  */
  70 struct xenbus_transaction_holder {
  71         struct list_head list;
  72         struct xenbus_transaction handle;
  73 };
  74
  75 /*
  76  * A buffer of data on the queue.
  77  */
  78 struct read_buffer {
  79         struct list_head list;
  80         unsigned int cons;
  81         unsigned int len;
  82         char msg[];
  83 };
  84
  85 struct xenbus_file_priv {
  86         /*
  87          * msgbuffer_mutex is held while partial requests are built up
  88          * and complete requests are acted on.  It therefore protects
  89          * the "transactions" and "watches" lists, and the partial
  90          * request length and buffer.
  91          *
  92          * reply_mutex protects the reply being built up to return to
  93          * usermode.  It nests inside msgbuffer_mutex but may be held
  94          * alone during a watch callback.
  95          */
  96         struct mutex msgbuffer_mutex;
  97
  98         /* In-progress transactions */
  99         struct list_head transactions;
 100
 101         /* Active watches. */
 102         struct list_head watches;
 103
 104         /* Partial request. */
 105         unsigned int len;
 106         union {
 107                 struct xsd_sockmsg msg;
 108                 char buffer[XENSTORE_PAYLOAD_MAX];
 109         } u;
 110
 111         /* Response queue. */
 112         struct mutex reply_mutex;
 113         struct list_head read_buffers;
 114         wait_queue_head_t read_waitq;
 115
 116         struct kref kref;
 117
 118         struct work_struct wq;
 119 };
 120
 121 /* Read out any raw xenbus messages queued up. */
 122 static ssize_t xenbus_file_read(struct file *filp,
 123                                char __user *ubuf,
 124                                size_t len, loff_t *ppos)
 125 {
 126         struct xenbus_file_priv *u = filp->private_data;
 127         struct read_buffer *rb;
 128         ssize_t i;
 129         int ret;
 130
 131         mutex_lock(&u->reply_mutex);
 132 again:
 133         while (list_empty(&u->read_buffers)) {
 134                 mutex_unlock(&u->reply_mutex);
 135                 if (filp->f_flags & O_NONBLOCK)
 136                         return -EAGAIN;
 137
 138                 ret = wait_event_interruptible(u->read_waitq,
 139                                                !list_empty(&u->read_buffers));
 140                 if (ret)
 141                         return ret;
 142                 mutex_lock(&u->reply_mutex);
 143         }
 144
 145         rb = list_entry(u->read_buffers.next, struct read_buffer, list);
 146         i = 0;
 147         while (i < len) {
 148                 size_t sz = min_t(size_t, len - i, rb->len - rb->cons);
 149
 150                 ret = copy_to_user(ubuf + i, &rb->msg[rb->cons], sz);
 151
 152                 i += sz - ret;
 153                 rb->cons += sz - ret;
 154
 155                 if (ret != 0) {
 156                         if (i == 0)
 157                                 i = -EFAULT;
 158                         goto out;
 159                 }
 160
 161                 /* Clear out buffer if it has been consumed */
 162                 if (rb->cons == rb->len) {
 163                         list_del(&rb->list);
 164                         kfree(rb);
 165                         if (list_empty(&u->read_buffers))
 166                                 break;
 167                         rb = list_entry(u->read_buffers.next,
 168                                         struct read_buffer, list);
 169                 }
 170         }
 171         if (i == 0)
 172                 goto again;
 173
 174 out:
 175         mutex_unlock(&u->reply_mutex);
 176         return i;
 177 }
 178
 179 /*
 180  * Add a buffer to the queue.  Caller must hold the appropriate lock
 181  * if the queue is not local.  (Commonly the caller will build up
 182  * multiple queued buffers on a temporary local list, and then add it
 183  * to the appropriate list under lock once all the buffers have een
 184  * successfully allocated.)
 185  */
 186 static int queue_reply(struct list_head *queue, const void *data, size_t len)
 187 {
 188         struct read_buffer *rb;
 189
 190         if (len == 0)
 191                 return 0;
 192         if (len > XENSTORE_PAYLOAD_MAX)
 193                 return -EINVAL;
 194
 195         rb = kmalloc(sizeof(*rb) + len, GFP_KERNEL);
 196         if (rb == NULL)
 197                 return -ENOMEM;
 198
 199         rb->cons = 0;
 200         rb->len = len;
 201
 202         memcpy(rb->msg, data, len);
 203
 204         list_add_tail(&rb->list, queue);
 205         return 0;
 206 }
 207
 208 /*
 209  * Free all the read_buffer s on a list.
 210  * Caller must have sole reference to list.
 211  */
 212 static void queue_cleanup(struct list_head *list)
 213 {
 214         struct read_buffer *rb;
 215
 216         while (!list_empty(list)) {
 217                 rb = list_entry(list->next, struct read_buffer, list);
 218                 list_del(list->next);
 219                 kfree(rb);
 220         }
 221 }
 222
 223 struct watch_adapter {
 224         struct list_head list;
 225         struct xenbus_watch watch;
 226         struct xenbus_file_priv *dev_data;
 227         char *token;
 228 };
 229
 230 static void free_watch_adapter(struct watch_adapter *watch)
 231 {
 232         kfree(watch->watch.node);
 233         kfree(watch->token);
 234         kfree(watch);
 235 }
 236
 237 static struct watch_adapter *alloc_watch_adapter(const char *path,
 238                                                  const char *token)
 239 {
 240         struct watch_adapter *watch;
 241
 242         watch = kzalloc(sizeof(*watch), GFP_KERNEL);
 243         if (watch == NULL)
 244                 goto out_fail;
 245
 246         watch->watch.node = kstrdup(path, GFP_KERNEL);
 247         if (watch->watch.node == NULL)
 248                 goto out_free;
 249
 250         watch->token = kstrdup(token, GFP_KERNEL);
 251         if (watch->token == NULL)
 252                 goto out_free;
 253
 254         return watch;
 255
 256 out_free:
 257         free_watch_adapter(watch);
 258
 259 out_fail:
 260         return NULL;
 261 }
 262
 263 static void watch_fired(struct xenbus_watch *watch,
 264                         const char *path,
 265                         const char *token)
 266 {
 267         struct watch_adapter *adap;
 268         struct xsd_sockmsg hdr;
 269         const char *token_caller;
 270         int path_len, tok_len, body_len;
 271         int ret;
 272         LIST_HEAD(staging_q);
 273
 274         adap = container_of(watch, struct watch_adapter, watch);
 275
 276         token_caller = adap->token;
 277
 278         path_len = strlen(path) + 1;
 279         tok_len = strlen(token_caller) + 1;
 280         body_len = path_len + tok_len;
 281
 282         hdr.type = XS_WATCH_EVENT;
 283         hdr.len = body_len;
 284
 285         mutex_lock(&adap->dev_data->reply_mutex);
 286
 287         ret = queue_reply(&staging_q, &hdr, sizeof(hdr));
 288         if (!ret)
 289                 ret = queue_reply(&staging_q, path, path_len);
 290         if (!ret)
 291                 ret = queue_reply(&staging_q, token_caller, tok_len);
 292
 293         if (!ret) {
 294                 /* success: pass reply list onto watcher */
 295                 list_splice_tail(&staging_q, &adap->dev_data->read_buffers);
 296                 wake_up(&adap->dev_data->read_waitq);
 297         } else
 298                 queue_cleanup(&staging_q);
 299
 300         mutex_unlock(&adap->dev_data->reply_mutex);
 301 }
 302
 303 static void xenbus_worker(struct work_struct *wq)
 304 {
 305         struct xenbus_file_priv *u;
 306         struct xenbus_transaction_holder *trans, *tmp;
 307         struct watch_adapter *watch, *tmp_watch;
 308         struct read_buffer *rb, *tmp_rb;
 309
 310         u = container_of(wq, struct xenbus_file_priv, wq);
 311
 312         /*
 313          * No need for locking here because there are no other users,
 314          * by definition.
 315          */
 316
 317         list_for_each_entry_safe(trans, tmp, &u->transactions, list) {
 318                 xenbus_transaction_end(trans->handle, 1);
 319                 list_del(&trans->list);
 320                 kfree(trans);
 321         }
 322
 323         list_for_each_entry_safe(watch, tmp_watch, &u->watches, list) {
 324                 unregister_xenbus_watch(&watch->watch);
 325                 list_del(&watch->list);
 326                 free_watch_adapter(watch);
 327         }
 328
 329         list_for_each_entry_safe(rb, tmp_rb, &u->read_buffers, list) {
 330                 list_del(&rb->list);
 331                 kfree(rb);
 332         }
 333         kfree(u);
 334 }
 335
 336 static void xenbus_file_free(struct kref *kref)
 337 {
 338         struct xenbus_file_priv *u;
 339
 340         /*
 341          * We might be called in xenbus_thread().
 342          * Use workqueue to avoid deadlock.
 343          */
 344         u = container_of(kref, struct xenbus_file_priv, kref);
 345         schedule_work(&u->wq);
 346 }
 347
 348 static struct xenbus_transaction_holder *xenbus_get_transaction(
 349         struct xenbus_file_priv *u, uint32_t tx_id)
 350 {
 351         struct xenbus_transaction_holder *trans;
 352
 353         list_for_each_entry(trans, &u->transactions, list)
 354                 if (trans->handle.id == tx_id)
 355                         return trans;
 356
 357         return NULL;
 358 }
 359
 360 void xenbus_dev_queue_reply(struct xb_req_data *req)
 361 {
 362         struct xenbus_file_priv *u = req->par;
 363         struct xenbus_transaction_holder *trans = NULL;
 364         int rc;
 365         LIST_HEAD(staging_q);
 366
 367         xs_request_exit(req);
 368
 369         mutex_lock(&u->msgbuffer_mutex);
 370
 371         if (req->type == XS_TRANSACTION_START) {
 372                 trans = xenbus_get_transaction(u, 0);
 373                 if (WARN_ON(!trans))
 374                         goto out;
 375                 if (req->msg.type == XS_ERROR) {
 376                         list_del(&trans->list);
 377                         kfree(trans);
 378                 } else {
 379                         rc = kstrtou32(req->body, 10, &trans->handle.id);
 380                         if (WARN_ON(rc))
 381                                 goto out;
 382                 }
 383         } else if (req->type == XS_TRANSACTION_END) {
 384                 trans = xenbus_get_transaction(u, req->msg.tx_id);
 385                 if (WARN_ON(!trans))
 386                         goto out;
 387                 list_del(&trans->list);
 388                 kfree(trans);
 389         }
 390
 391         mutex_unlock(&u->msgbuffer_mutex);
 392
 393         mutex_lock(&u->reply_mutex);
 394         rc = queue_reply(&staging_q, &req->msg, sizeof(req->msg));
 395         if (!rc)
 396                 rc = queue_reply(&staging_q, req->body, req->msg.len);
 397         if (!rc) {
 398                 list_splice_tail(&staging_q, &u->read_buffers);
 399                 wake_up(&u->read_waitq);
 400         } else {
 401                 queue_cleanup(&staging_q);
 402         }
 403         mutex_unlock(&u->reply_mutex);
 404
 405         kfree(req->body);
 406         kfree(req);
 407
 408         kref_put(&u->kref, xenbus_file_free);
 409
 410         return;
 411
 412  out:
 413         mutex_unlock(&u->msgbuffer_mutex);
 414 }
 415
 416 static int xenbus_command_reply(struct xenbus_file_priv *u,
 417                                 unsigned int msg_type, const char *reply)
 418 {
 419         struct {
 420                 struct xsd_sockmsg hdr;
 421                 char body[16];
 422         } msg;
 423         int rc;
 424
 425         msg.hdr = u->u.msg;
 426         msg.hdr.type = msg_type;
 427         msg.hdr.len = strlen(reply) + 1;
 428         if (msg.hdr.len > sizeof(msg.body))
 429                 return -E2BIG;
 430         memcpy(&msg.body, reply, msg.hdr.len);
 431
 432         mutex_lock(&u->reply_mutex);
 433         rc = queue_reply(&u->read_buffers, &msg, sizeof(msg.hdr) + msg.hdr.len);
 434         wake_up(&u->read_waitq);
 435         mutex_unlock(&u->reply_mutex);
 436
 437         if (!rc)
 438                 kref_put(&u->kref, xenbus_file_free);
 439
 440         return rc;
 441 }
 442
 443 static int xenbus_write_transaction(unsigned msg_type,
 444                                     struct xenbus_file_priv *u)
 445 {
 446         int rc;
 447         struct xenbus_transaction_holder *trans = NULL;
 448
 449         if (msg_type == XS_TRANSACTION_START) {
 450                 trans = kzalloc(sizeof(*trans), GFP_KERNEL);
 451                 if (!trans) {
 452                         rc = -ENOMEM;
 453                         goto out;
 454                 }
 455                 list_add(&trans->list, &u->transactions);
 456         } else if (u->u.msg.tx_id != 0 &&
 457                    !xenbus_get_transaction(u, u->u.msg.tx_id))
 458                 return xenbus_command_reply(u, XS_ERROR, "ENOENT");
 459
 460         rc = xenbus_dev_request_and_reply(&u->u.msg, u);
 461         if (rc && trans) {
 462                 list_del(&trans->list);
 463                 kfree(trans);
 464         }
 465
 466 out:
 467         return rc;
 468 }
 469
 470 static int xenbus_write_watch(unsigned msg_type, struct xenbus_file_priv *u)
 471 {
 472         struct watch_adapter *watch;
 473         char *path, *token;
 474         int err, rc;
 475         LIST_HEAD(staging_q);
 476
 477         path = u->u.buffer + sizeof(u->u.msg);
 478         token = memchr(path, 0, u->u.msg.len);
 479         if (token == NULL) {
 480                 rc = xenbus_command_reply(u, XS_ERROR, "EINVAL");
 481                 goto out;
 482         }
 483         token++;
 484         if (memchr(token, 0, u->u.msg.len - (token - path)) == NULL) {
 485                 rc = xenbus_command_reply(u, XS_ERROR, "EINVAL");
 486                 goto out;
 487         }
 488
 489         if (msg_type == XS_WATCH) {
 490                 watch = alloc_watch_adapter(path, token);
 491                 if (watch == NULL) {
 492                         rc = -ENOMEM;
 493                         goto out;
 494                 }
 495
 496                 watch->watch.callback = watch_fired;
 497                 watch->dev_data = u;
 498
 499                 err = register_xenbus_watch(&watch->watch);
 500                 if (err) {
 501                         free_watch_adapter(watch);
 502                         rc = err;
 503                         goto out;
 504                 }
 505                 list_add(&watch->list, &u->watches);
 506         } else {
 507                 list_for_each_entry(watch, &u->watches, list) {
 508                         if (!strcmp(watch->token, token) &&
 509                             !strcmp(watch->watch.node, path)) {
 510                                 unregister_xenbus_watch(&watch->watch);
 511                                 list_del(&watch->list);
 512                                 free_watch_adapter(watch);
 513                                 break;
 514                         }
 515                 }
 516         }
 517
 518         /* Success.  Synthesize a reply to say all is OK. */
 519         rc = xenbus_command_reply(u, msg_type, "OK");
 520
 521 out:
 522         return rc;
 523 }
 524
 525 static ssize_t xenbus_file_write(struct file *filp,
 526                                 const char __user *ubuf,
 527                                 size_t len, loff_t *ppos)
 528 {
 529         struct xenbus_file_priv *u = filp->private_data;
 530         uint32_t msg_type;
 531         int rc = len;
 532         int ret;
 533         LIST_HEAD(staging_q);
 534
 535         /*
 536          * We're expecting usermode to be writing properly formed
 537          * xenbus messages.  If they write an incomplete message we
 538          * buffer it up.  Once it is complete, we act on it.
 539          */
 540
 541         /*
 542          * Make sure concurrent writers can't stomp all over each
 543          * other's messages and make a mess of our partial message
 544          * buffer.  We don't make any attemppt to stop multiple
 545          * writers from making a mess of each other's incomplete
 546          * messages; we're just trying to guarantee our own internal
 547          * consistency and make sure that single writes are handled
 548          * atomically.
 549          */
 550         mutex_lock(&u->msgbuffer_mutex);
 551
 552         /* Get this out of the way early to avoid confusion */
 553         if (len == 0)
 554                 goto out;
 555
 556         /* Can't write a xenbus message larger we can buffer */
 557         if (len > sizeof(u->u.buffer) - u->len) {
 558                 /* On error, dump existing buffer */
 559                 u->len = 0;
 560                 rc = -EINVAL;
 561                 goto out;
 562         }
 563
 564         ret = copy_from_user(u->u.buffer + u->len, ubuf, len);
 565
 566         if (ret != 0) {
 567                 rc = -EFAULT;
 568                 goto out;
 569         }
 570
 571         /* Deal with a partial copy. */
 572         len -= ret;
 573         rc = len;
 574
 575         u->len += len;
 576
 577         /* Return if we haven't got a full message yet */
 578         if (u->len < sizeof(u->u.msg))
 579                 goto out;       /* not even the header yet */
 580
 581         /* If we're expecting a message that's larger than we can
 582            possibly send, dump what we have and return an error. */
 583         if ((sizeof(u->u.msg) + u->u.msg.len) > sizeof(u->u.buffer)) {
 584                 rc = -E2BIG;
 585                 u->len = 0;
 586                 goto out;
 587         }
 588
 589         if (u->len < (sizeof(u->u.msg) + u->u.msg.len))
 590                 goto out;       /* incomplete data portion */
 591
 592         /*
 593          * OK, now we have a complete message.  Do something with it.
 594          */
 595
 596         kref_get(&u->kref);
 597
 598         msg_type = u->u.msg.type;
 599
 600         switch (msg_type) {
 601         case XS_WATCH:
 602         case XS_UNWATCH:
 603                 /* (Un)Ask for some path to be watched for changes */
 604                 ret = xenbus_write_watch(msg_type, u);
 605                 break;
 606
 607         default:
 608                 /* Send out a transaction */
 609                 ret = xenbus_write_transaction(msg_type, u);
 610                 break;
 611         }
 612         if (ret != 0) {
 613                 rc = ret;
 614                 kref_put(&u->kref, xenbus_file_free);
 615         }
 616
 617         /* Buffered message consumed */
 618         u->len = 0;
 619
 620  out:
 621         mutex_unlock(&u->msgbuffer_mutex);
 622         return rc;
 623 }
 624
 625 static int xenbus_file_open(struct inode *inode, struct file *filp)
 626 {
 627         struct xenbus_file_priv *u;
 628
 629         if (xen_store_evtchn == 0)
 630                 return -ENOENT;
 631
 632         stream_open(inode, filp);
 633
 634         u = kzalloc(sizeof(*u), GFP_KERNEL);
 635         if (u == NULL)
 636                 return -ENOMEM;
 637
 638         kref_init(&u->kref);
 639
 640         INIT_LIST_HEAD(&u->transactions);
 641         INIT_LIST_HEAD(&u->watches);
 642         INIT_LIST_HEAD(&u->read_buffers);
 643         init_waitqueue_head(&u->read_waitq);
 644         INIT_WORK(&u->wq, xenbus_worker);
 645
 646         mutex_init(&u->reply_mutex);
 647         mutex_init(&u->msgbuffer_mutex);
 648
 649         filp->private_data = u;
 650
 651         return 0;
 652 }
 653
 654 static int xenbus_file_release(struct inode *inode, struct file *filp)
 655 {
 656         struct xenbus_file_priv *u = filp->private_data;
 657
 658         kref_put(&u->kref, xenbus_file_free);
 659
 660         return 0;
 661 }
 662
 663 static unsigned int xenbus_file_poll(struct file *file, poll_table *wait)
 664 {
 665         struct xenbus_file_priv *u = file->private_data;
 666
 667         poll_wait(file, &u->read_waitq, wait);
 668         if (!list_empty(&u->read_buffers))
 669                 return POLLIN | POLLRDNORM;
 670         return 0;
 671 }
 672
 673 const struct file_operations xen_xenbus_fops = {
 674         .read = xenbus_file_read,
 675         .write = xenbus_file_write,
 676         .open = xenbus_file_open,
 677         .release = xenbus_file_release,
 678         .poll = xenbus_file_poll,
 679         .llseek = no_llseek,
 680 };
 681 EXPORT_SYMBOL_GPL(xen_xenbus_fops);
 682
 683 static struct miscdevice xenbus_dev = {
 684         .minor = MISC_DYNAMIC_MINOR,
 685         .name = "xen/xenbus",
 686         .fops = &xen_xenbus_fops,
 687 };
 688
 689 static int __init xenbus_init(void)
 690 {
 691         int err;
 692
 693         if (!xen_domain())
 694                 return -ENODEV;
 695
 696         err = misc_register(&xenbus_dev);
 697         if (err)
 698                 pr_err("Could not register xenbus frontend device\n");
 699         return err;
 700 }
 701 device_initcall(xenbus_init);