fs/coda/psdev.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  *              An implementation of a loadable kernel mode driver providing
   4  *              multiple kernel/user space bidirectional communications links.
   5  *
   6  *              Author:         Alan Cox <alan@lxorguk.ukuu.org.uk>
   7  *
   8  *              Adapted to become the Linux 2.0 Coda pseudo device
   9  *              Peter  Braam  <braam@maths.ox.ac.uk>
  10  *              Michael Callahan <mjc@emmy.smith.edu>
  11  *
  12  *              Changes for Linux 2.1
  13  *              Copyright (c) 1997 Carnegie-Mellon University
  14  */
  15
  16 #include <linux/module.h>
  17 #include <linux/errno.h>
  18 #include <linux/kernel.h>
  19 #include <linux/major.h>
  20 #include <linux/time.h>
  21 #include <linux/sched/signal.h>
  22 #include <linux/slab.h>
  23 #include <linux/ioport.h>
  24 #include <linux/fcntl.h>
  25 #include <linux/delay.h>
  26 #include <linux/skbuff.h>
  27 #include <linux/proc_fs.h>
  28 #include <linux/vmalloc.h>
  29 #include <linux/fs.h>
  30 #include <linux/file.h>
  31 #include <linux/poll.h>
  32 #include <linux/init.h>
  33 #include <linux/list.h>
  34 #include <linux/mutex.h>
  35 #include <linux/device.h>
  36 #include <linux/pid_namespace.h>
  37 #include <asm/io.h>
  38 #include <linux/uaccess.h>
  39
  40 #include <linux/coda.h>
  41 #include <linux/coda_psdev.h>
  42
  43 #include "coda_linux.h"
  44
  45 #include "coda_int.h"
  46
  47 /* statistics */
  48 int           coda_hard;         /* allows signals during upcalls */
  49 unsigned long coda_timeout = 30; /* .. secs, then signals will dequeue */
  50
  51
  52 struct venus_comm coda_comms[MAX_CODADEVS];
  53 static struct class *coda_psdev_class;
  54
  55 /*
  56  * Device operations
  57  */
  58
  59 static __poll_t coda_psdev_poll(struct file *file, poll_table * wait)
  60 {
  61         struct venus_comm *vcp = (struct venus_comm *) file->private_data;
  62         __poll_t mask = EPOLLOUT | EPOLLWRNORM;
  63
  64         poll_wait(file, &vcp->vc_waitq, wait);
  65         mutex_lock(&vcp->vc_mutex);
  66         if (!list_empty(&vcp->vc_pending))
  67                 mask |= EPOLLIN | EPOLLRDNORM;
  68         mutex_unlock(&vcp->vc_mutex);
  69
  70         return mask;
  71 }
  72
  73 static long coda_psdev_ioctl(struct file * filp, unsigned int cmd, unsigned long arg)
  74 {
  75         unsigned int data;
  76
  77         switch(cmd) {
  78         case CIOC_KERNEL_VERSION:
  79                 data = CODA_KERNEL_VERSION;
  80                 return put_user(data, (int __user *) arg);
  81         default:
  82                 return -ENOTTY;
  83         }
  84
  85         return 0;
  86 }
  87
  88 /*
  89  *      Receive a message written by Venus to the psdev
  90  */
  91
  92 static ssize_t coda_psdev_write(struct file *file, const char __user *buf,
  93                                 size_t nbytes, loff_t *off)
  94 {
  95         struct venus_comm *vcp = (struct venus_comm *) file->private_data;
  96         struct upc_req *req = NULL;
  97         struct upc_req *tmp;
  98         struct list_head *lh;
  99         struct coda_in_hdr hdr;
 100         ssize_t retval = 0, count = 0;
 101         int error;
 102
 103         /* make sure there is enough to copy out the (opcode, unique) values */
 104         if (nbytes < (2 * sizeof(u_int32_t)))
 105                 return -EINVAL;
 106
 107         /* Peek at the opcode, uniquefier */
 108         if (copy_from_user(&hdr, buf, 2 * sizeof(u_int32_t)))
 109                 return -EFAULT;
 110
 111         if (DOWNCALL(hdr.opcode)) {
 112                 union outputArgs *dcbuf;
 113                 int size = sizeof(*dcbuf);
 114
 115                 if  ( nbytes < sizeof(struct coda_out_hdr) ) {
 116                         pr_warn("coda_downcall opc %d uniq %d, not enough!\n",
 117                                 hdr.opcode, hdr.unique);
 118                         count = nbytes;
 119                         goto out;
 120                 }
 121                 if ( nbytes > size ) {
 122                         pr_warn("downcall opc %d, uniq %d, too much!",
 123                                 hdr.opcode, hdr.unique);
 124                         nbytes = size;
 125                 }
 126                 CODA_ALLOC(dcbuf, union outputArgs *, nbytes);
 127                 if (copy_from_user(dcbuf, buf, nbytes)) {
 128                         CODA_FREE(dcbuf, nbytes);
 129                         retval = -EFAULT;
 130                         goto out;
 131                 }
 132
 133                 /* what downcall errors does Venus handle ? */
 134                 error = coda_downcall(vcp, hdr.opcode, dcbuf, nbytes);
 135
 136                 CODA_FREE(dcbuf, nbytes);
 137                 if (error) {
 138                         pr_warn("%s: coda_downcall error: %d\n",
 139                                 __func__, error);
 140                         retval = error;
 141                         goto out;
 142                 }
 143                 count = nbytes;
 144                 goto out;
 145         }
 146
 147         /* Look for the message on the processing queue. */
 148         mutex_lock(&vcp->vc_mutex);
 149         list_for_each(lh, &vcp->vc_processing) {
 150                 tmp = list_entry(lh, struct upc_req , uc_chain);
 151                 if (tmp->uc_unique == hdr.unique) {
 152                         req = tmp;
 153                         list_del(&req->uc_chain);
 154                         break;
 155                 }
 156         }
 157         mutex_unlock(&vcp->vc_mutex);
 158
 159         if (!req) {
 160                 pr_warn("%s: msg (%d, %d) not found\n",
 161                         __func__, hdr.opcode, hdr.unique);
 162                 retval = -ESRCH;
 163                 goto out;
 164         }
 165
 166         /* move data into response buffer. */
 167         if (req->uc_outSize < nbytes) {
 168                 pr_warn("%s: too much cnt: %d, cnt: %ld, opc: %d, uniq: %d.\n",
 169                         __func__, req->uc_outSize, (long)nbytes,
 170                         hdr.opcode, hdr.unique);
 171                 nbytes = req->uc_outSize; /* don't have more space! */
 172         }
 173         if (copy_from_user(req->uc_data, buf, nbytes)) {
 174                 req->uc_flags |= CODA_REQ_ABORT;
 175                 wake_up(&req->uc_sleep);
 176                 retval = -EFAULT;
 177                 goto out;
 178         }
 179
 180         /* adjust outsize. is this useful ?? */
 181         req->uc_outSize = nbytes;
 182         req->uc_flags |= CODA_REQ_WRITE;
 183         count = nbytes;
 184
 185         /* Convert filedescriptor into a file handle */
 186         if (req->uc_opcode == CODA_OPEN_BY_FD) {
 187                 struct coda_open_by_fd_out *outp =
 188                         (struct coda_open_by_fd_out *)req->uc_data;
 189                 if (!outp->oh.result) {
 190                         outp->fh = fget(outp->fd);
 191                         if (!outp->fh)
 192                                 return -EBADF;
 193                 }
 194         }
 195
 196         wake_up(&req->uc_sleep);
 197 out:
 198         return(count ? count : retval);
 199 }
 200
 201 /*
 202  *      Read a message from the kernel to Venus
 203  */
 204
 205 static ssize_t coda_psdev_read(struct file * file, char __user * buf,
 206                                size_t nbytes, loff_t *off)
 207 {
 208         DECLARE_WAITQUEUE(wait, current);
 209         struct venus_comm *vcp = (struct venus_comm *) file->private_data;
 210         struct upc_req *req;
 211         ssize_t retval = 0, count = 0;
 212
 213         if (nbytes == 0)
 214                 return 0;
 215
 216         mutex_lock(&vcp->vc_mutex);
 217
 218         add_wait_queue(&vcp->vc_waitq, &wait);
 219         set_current_state(TASK_INTERRUPTIBLE);
 220
 221         while (list_empty(&vcp->vc_pending)) {
 222                 if (file->f_flags & O_NONBLOCK) {
 223                         retval = -EAGAIN;
 224                         break;
 225                 }
 226                 if (signal_pending(current)) {
 227                         retval = -ERESTARTSYS;
 228                         break;
 229                 }
 230                 mutex_unlock(&vcp->vc_mutex);
 231                 schedule();
 232                 mutex_lock(&vcp->vc_mutex);
 233         }
 234
 235         set_current_state(TASK_RUNNING);
 236         remove_wait_queue(&vcp->vc_waitq, &wait);
 237
 238         if (retval)
 239                 goto out;
 240
 241         req = list_entry(vcp->vc_pending.next, struct upc_req,uc_chain);
 242         list_del(&req->uc_chain);
 243
 244         /* Move the input args into userspace */
 245         count = req->uc_inSize;
 246         if (nbytes < req->uc_inSize) {
 247                 pr_warn("%s: Venus read %ld bytes of %d in message\n",
 248                         __func__, (long)nbytes, req->uc_inSize);
 249                 count = nbytes;
 250         }
 251
 252         if (copy_to_user(buf, req->uc_data, count))
 253                 retval = -EFAULT;
 254
 255         /* If request was not a signal, enqueue and don't free */
 256         if (!(req->uc_flags & CODA_REQ_ASYNC)) {
 257                 req->uc_flags |= CODA_REQ_READ;
 258                 list_add_tail(&(req->uc_chain), &vcp->vc_processing);
 259                 goto out;
 260         }
 261
 262         CODA_FREE(req->uc_data, sizeof(struct coda_in_hdr));
 263         kfree(req);
 264 out:
 265         mutex_unlock(&vcp->vc_mutex);
 266         return (count ? count : retval);
 267 }
 268
 269 static int coda_psdev_open(struct inode * inode, struct file * file)
 270 {
 271         struct venus_comm *vcp;
 272         int idx, err;
 273
 274         if (task_active_pid_ns(current) != &init_pid_ns)
 275                 return -EINVAL;
 276
 277         if (current_user_ns() != &init_user_ns)
 278                 return -EINVAL;
 279
 280         idx = iminor(inode);
 281         if (idx < 0 || idx >= MAX_CODADEVS)
 282                 return -ENODEV;
 283
 284         err = -EBUSY;
 285         vcp = &coda_comms[idx];
 286         mutex_lock(&vcp->vc_mutex);
 287
 288         if (!vcp->vc_inuse) {
 289                 vcp->vc_inuse++;
 290
 291                 INIT_LIST_HEAD(&vcp->vc_pending);
 292                 INIT_LIST_HEAD(&vcp->vc_processing);
 293                 init_waitqueue_head(&vcp->vc_waitq);
 294                 vcp->vc_sb = NULL;
 295                 vcp->vc_seq = 0;
 296
 297                 file->private_data = vcp;
 298                 err = 0;
 299         }
 300
 301         mutex_unlock(&vcp->vc_mutex);
 302         return err;
 303 }
 304
 305
 306 static int coda_psdev_release(struct inode * inode, struct file * file)
 307 {
 308         struct venus_comm *vcp = (struct venus_comm *) file->private_data;
 309         struct upc_req *req, *tmp;
 310
 311         if (!vcp || !vcp->vc_inuse ) {
 312                 pr_warn("%s: Not open.\n", __func__);
 313                 return -1;
 314         }
 315
 316         mutex_lock(&vcp->vc_mutex);
 317
 318         /* Wakeup clients so they can return. */
 319         list_for_each_entry_safe(req, tmp, &vcp->vc_pending, uc_chain) {
 320                 list_del(&req->uc_chain);
 321
 322                 /* Async requests need to be freed here */
 323                 if (req->uc_flags & CODA_REQ_ASYNC) {
 324                         CODA_FREE(req->uc_data, sizeof(struct coda_in_hdr));
 325                         kfree(req);
 326                         continue;
 327                 }
 328                 req->uc_flags |= CODA_REQ_ABORT;
 329                 wake_up(&req->uc_sleep);
 330         }
 331
 332         list_for_each_entry_safe(req, tmp, &vcp->vc_processing, uc_chain) {
 333                 list_del(&req->uc_chain);
 334
 335                 req->uc_flags |= CODA_REQ_ABORT;
 336                 wake_up(&req->uc_sleep);
 337         }
 338
 339         file->private_data = NULL;
 340         vcp->vc_inuse--;
 341         mutex_unlock(&vcp->vc_mutex);
 342         return 0;
 343 }
 344
 345
 346 static const struct file_operations coda_psdev_fops = {
 347         .owner          = THIS_MODULE,
 348         .read           = coda_psdev_read,
 349         .write          = coda_psdev_write,
 350         .poll           = coda_psdev_poll,
 351         .unlocked_ioctl = coda_psdev_ioctl,
 352         .open           = coda_psdev_open,
 353         .release        = coda_psdev_release,
 354         .llseek         = noop_llseek,
 355 };
 356
 357 static int init_coda_psdev(void)
 358 {
 359         int i, err = 0;
 360         if (register_chrdev(CODA_PSDEV_MAJOR, "coda", &coda_psdev_fops)) {
 361                 pr_err("%s: unable to get major %d\n",
 362                        __func__, CODA_PSDEV_MAJOR);
 363               return -EIO;
 364         }
 365         coda_psdev_class = class_create(THIS_MODULE, "coda");
 366         if (IS_ERR(coda_psdev_class)) {
 367                 err = PTR_ERR(coda_psdev_class);
 368                 goto out_chrdev;
 369         }
 370         for (i = 0; i < MAX_CODADEVS; i++) {
 371                 mutex_init(&(&coda_comms[i])->vc_mutex);
 372                 device_create(coda_psdev_class, NULL,
 373                               MKDEV(CODA_PSDEV_MAJOR, i), NULL, "cfs%d", i);
 374         }
 375         coda_sysctl_init();
 376         goto out;
 377
 378 out_chrdev:
 379         unregister_chrdev(CODA_PSDEV_MAJOR, "coda");
 380 out:
 381         return err;
 382 }
 383
 384 MODULE_AUTHOR("Jan Harkes, Peter J. Braam");
 385 MODULE_DESCRIPTION("Coda Distributed File System VFS interface");
 386 MODULE_ALIAS_CHARDEV_MAJOR(CODA_PSDEV_MAJOR);
 387 MODULE_LICENSE("GPL");
 388 MODULE_VERSION("6.6");
 389
 390 static int __init init_coda(void)
 391 {
 392         int status;
 393         int i;
 394
 395         status = coda_init_inodecache();
 396         if (status)
 397                 goto out2;
 398         status = init_coda_psdev();
 399         if ( status ) {
 400                 pr_warn("Problem (%d) in init_coda_psdev\n", status);
 401                 goto out1;
 402         }
 403
 404         status = register_filesystem(&coda_fs_type);
 405         if (status) {
 406                 pr_warn("failed to register filesystem!\n");
 407                 goto out;
 408         }
 409         return 0;
 410 out:
 411         for (i = 0; i < MAX_CODADEVS; i++)
 412                 device_destroy(coda_psdev_class, MKDEV(CODA_PSDEV_MAJOR, i));
 413         class_destroy(coda_psdev_class);
 414         unregister_chrdev(CODA_PSDEV_MAJOR, "coda");
 415         coda_sysctl_clean();
 416 out1:
 417         coda_destroy_inodecache();
 418 out2:
 419         return status;
 420 }
 421
 422 static void __exit exit_coda(void)
 423 {
 424         int err, i;
 425
 426         err = unregister_filesystem(&coda_fs_type);
 427         if (err != 0)
 428                 pr_warn("failed to unregister filesystem\n");
 429         for (i = 0; i < MAX_CODADEVS; i++)
 430                 device_destroy(coda_psdev_class, MKDEV(CODA_PSDEV_MAJOR, i));
 431         class_destroy(coda_psdev_class);
 432         unregister_chrdev(CODA_PSDEV_MAJOR, "coda");
 433         coda_sysctl_clean();
 434         coda_destroy_inodecache();
 435 }
 436
 437 module_init(init_coda);
 438 module_exit(exit_coda);
 439