fs/dlm/user.c

   1 /*
   2  * Copyright (C) 2006-2010 Red Hat, Inc.  All rights reserved.
   3  *
   4  * This copyrighted material is made available to anyone wishing to use,
   5  * modify, copy, or redistribute it subject to the terms and conditions
   6  * of the GNU General Public License v.2.
   7  */
   8
   9 #include <linux/miscdevice.h>
  10 #include <linux/init.h>
  11 #include <linux/wait.h>
  12 #include <linux/module.h>
  13 #include <linux/file.h>
  14 #include <linux/fs.h>
  15 #include <linux/poll.h>
  16 #include <linux/signal.h>
  17 #include <linux/spinlock.h>
  18 #include <linux/dlm.h>
  19 #include <linux/dlm_device.h>
  20 #include <linux/slab.h>
  21
  22 #include "dlm_internal.h"
  23 #include "lockspace.h"
  24 #include "lock.h"
  25 #include "lvb_table.h"
  26 #include "user.h"
  27 #include "ast.h"
  28
  29 static const char name_prefix[] = "dlm";
  30 static const struct file_operations device_fops;
  31 static atomic_t dlm_monitor_opened;
  32 static int dlm_monitor_unused = 1;
  33
  34 #ifdef CONFIG_COMPAT
  35
  36 struct dlm_lock_params32 {
  37         __u8 mode;
  38         __u8 namelen;
  39         __u16 unused;
  40         __u32 flags;
  41         __u32 lkid;
  42         __u32 parent;
  43         __u64 xid;
  44         __u64 timeout;
  45         __u32 castparam;
  46         __u32 castaddr;
  47         __u32 bastparam;
  48         __u32 bastaddr;
  49         __u32 lksb;
  50         char lvb[DLM_USER_LVB_LEN];
  51         char name[0];
  52 };
  53
  54 struct dlm_write_request32 {
  55         __u32 version[3];
  56         __u8 cmd;
  57         __u8 is64bit;
  58         __u8 unused[2];
  59
  60         union  {
  61                 struct dlm_lock_params32 lock;
  62                 struct dlm_lspace_params lspace;
  63                 struct dlm_purge_params purge;
  64         } i;
  65 };
  66
  67 struct dlm_lksb32 {
  68         __u32 sb_status;
  69         __u32 sb_lkid;
  70         __u8 sb_flags;
  71         __u32 sb_lvbptr;
  72 };
  73
  74 struct dlm_lock_result32 {
  75         __u32 version[3];
  76         __u32 length;
  77         __u32 user_astaddr;
  78         __u32 user_astparam;
  79         __u32 user_lksb;
  80         struct dlm_lksb32 lksb;
  81         __u8 bast_mode;
  82         __u8 unused[3];
  83         /* Offsets may be zero if no data is present */
  84         __u32 lvb_offset;
  85 };
  86
  87 static void compat_input(struct dlm_write_request *kb,
  88                          struct dlm_write_request32 *kb32,
  89                          int namelen)
  90 {
  91         kb->version[0] = kb32->version[0];
  92         kb->version[1] = kb32->version[1];
  93         kb->version[2] = kb32->version[2];
  94
  95         kb->cmd = kb32->cmd;
  96         kb->is64bit = kb32->is64bit;
  97         if (kb->cmd == DLM_USER_CREATE_LOCKSPACE ||
  98             kb->cmd == DLM_USER_REMOVE_LOCKSPACE) {
  99                 kb->i.lspace.flags = kb32->i.lspace.flags;
 100                 kb->i.lspace.minor = kb32->i.lspace.minor;
 101                 memcpy(kb->i.lspace.name, kb32->i.lspace.name, namelen);
 102         } else if (kb->cmd == DLM_USER_PURGE) {
 103                 kb->i.purge.nodeid = kb32->i.purge.nodeid;
 104                 kb->i.purge.pid = kb32->i.purge.pid;
 105         } else {
 106                 kb->i.lock.mode = kb32->i.lock.mode;
 107                 kb->i.lock.namelen = kb32->i.lock.namelen;
 108                 kb->i.lock.flags = kb32->i.lock.flags;
 109                 kb->i.lock.lkid = kb32->i.lock.lkid;
 110                 kb->i.lock.parent = kb32->i.lock.parent;
 111                 kb->i.lock.xid = kb32->i.lock.xid;
 112                 kb->i.lock.timeout = kb32->i.lock.timeout;
 113                 kb->i.lock.castparam = (void *)(long)kb32->i.lock.castparam;
 114                 kb->i.lock.castaddr = (void *)(long)kb32->i.lock.castaddr;
 115                 kb->i.lock.bastparam = (void *)(long)kb32->i.lock.bastparam;
 116                 kb->i.lock.bastaddr = (void *)(long)kb32->i.lock.bastaddr;
 117                 kb->i.lock.lksb = (void *)(long)kb32->i.lock.lksb;
 118                 memcpy(kb->i.lock.lvb, kb32->i.lock.lvb, DLM_USER_LVB_LEN);
 119                 memcpy(kb->i.lock.name, kb32->i.lock.name, namelen);
 120         }
 121 }
 122
 123 static void compat_output(struct dlm_lock_result *res,
 124                           struct dlm_lock_result32 *res32)
 125 {
 126         res32->version[0] = res->version[0];
 127         res32->version[1] = res->version[1];
 128         res32->version[2] = res->version[2];
 129
 130         res32->user_astaddr = (__u32)(long)res->user_astaddr;
 131         res32->user_astparam = (__u32)(long)res->user_astparam;
 132         res32->user_lksb = (__u32)(long)res->user_lksb;
 133         res32->bast_mode = res->bast_mode;
 134
 135         res32->lvb_offset = res->lvb_offset;
 136         res32->length = res->length;
 137
 138         res32->lksb.sb_status = res->lksb.sb_status;
 139         res32->lksb.sb_flags = res->lksb.sb_flags;
 140         res32->lksb.sb_lkid = res->lksb.sb_lkid;
 141         res32->lksb.sb_lvbptr = (__u32)(long)res->lksb.sb_lvbptr;
 142 }
 143 #endif
 144
 145 /* Figure out if this lock is at the end of its life and no longer
 146    available for the application to use.  The lkb still exists until
 147    the final ast is read.  A lock becomes EOL in three situations:
 148      1. a noqueue request fails with EAGAIN
 149      2. an unlock completes with EUNLOCK
 150      3. a cancel of a waiting request completes with ECANCEL/EDEADLK
 151    An EOL lock needs to be removed from the process's list of locks.
 152    And we can't allow any new operation on an EOL lock.  This is
 153    not related to the lifetime of the lkb struct which is managed
 154    entirely by refcount. */
 155
 156 static int lkb_is_endoflife(int mode, int status)
 157 {
 158         switch (status) {
 159         case -DLM_EUNLOCK:
 160                 return 1;
 161         case -DLM_ECANCEL:
 162         case -ETIMEDOUT:
 163         case -EDEADLK:
 164         case -EAGAIN:
 165                 if (mode == DLM_LOCK_IV)
 166                         return 1;
 167                 break;
 168         }
 169         return 0;
 170 }
 171
 172 /* we could possibly check if the cancel of an orphan has resulted in the lkb
 173    being removed and then remove that lkb from the orphans list and free it */
 174
 175 void dlm_user_add_ast(struct dlm_lkb *lkb, uint32_t flags, int mode,
 176                       int status, uint32_t sbflags, uint64_t seq)
 177 {
 178         struct dlm_ls *ls;
 179         struct dlm_user_args *ua;
 180         struct dlm_user_proc *proc;
 181         int rv;
 182
 183         if (lkb->lkb_flags & (DLM_IFL_ORPHAN | DLM_IFL_DEAD))
 184                 return;
 185
 186         ls = lkb->lkb_resource->res_ls;
 187         mutex_lock(&ls->ls_clear_proc_locks);
 188
 189         /* If ORPHAN/DEAD flag is set, it means the process is dead so an ast
 190            can't be delivered.  For ORPHAN's, dlm_clear_proc_locks() freed
 191            lkb->ua so we can't try to use it.  This second check is necessary
 192            for cases where a completion ast is received for an operation that
 193            began before clear_proc_locks did its cancel/unlock. */
 194
 195         if (lkb->lkb_flags & (DLM_IFL_ORPHAN | DLM_IFL_DEAD))
 196                 goto out;
 197
 198         DLM_ASSERT(lkb->lkb_ua, dlm_print_lkb(lkb););
 199         ua = lkb->lkb_ua;
 200         proc = ua->proc;
 201
 202         if ((flags & DLM_CB_BAST) && ua->bastaddr == NULL)
 203                 goto out;
 204
 205         if ((flags & DLM_CB_CAST) && lkb_is_endoflife(mode, status))
 206                 lkb->lkb_flags |= DLM_IFL_ENDOFLIFE;
 207
 208         spin_lock(&proc->asts_spin);
 209
 210         rv = dlm_add_lkb_callback(lkb, flags, mode, status, sbflags, seq);
 211         if (rv < 0) {
 212                 spin_unlock(&proc->asts_spin);
 213                 goto out;
 214         }
 215
 216         if (list_empty(&lkb->lkb_cb_list)) {
 217                 kref_get(&lkb->lkb_ref);
 218                 list_add_tail(&lkb->lkb_cb_list, &proc->asts);
 219                 wake_up_interruptible(&proc->wait);
 220         }
 221         spin_unlock(&proc->asts_spin);
 222
 223         if (lkb->lkb_flags & DLM_IFL_ENDOFLIFE) {
 224                 /* N.B. spin_lock locks_spin, not asts_spin */
 225                 spin_lock(&proc->locks_spin);
 226                 if (!list_empty(&lkb->lkb_ownqueue)) {
 227                         list_del_init(&lkb->lkb_ownqueue);
 228                         dlm_put_lkb(lkb);
 229                 }
 230                 spin_unlock(&proc->locks_spin);
 231         }
 232  out:
 233         mutex_unlock(&ls->ls_clear_proc_locks);
 234 }
 235
 236 static int device_user_lock(struct dlm_user_proc *proc,
 237                             struct dlm_lock_params *params)
 238 {
 239         struct dlm_ls *ls;
 240         struct dlm_user_args *ua;
 241         int error = -ENOMEM;
 242
 243         ls = dlm_find_lockspace_local(proc->lockspace);
 244         if (!ls)
 245                 return -ENOENT;
 246
 247         if (!params->castaddr || !params->lksb) {
 248                 error = -EINVAL;
 249                 goto out;
 250         }
 251
 252         ua = kzalloc(sizeof(struct dlm_user_args), GFP_NOFS);
 253         if (!ua)
 254                 goto out;
 255         ua->proc = proc;
 256         ua->user_lksb = params->lksb;
 257         ua->castparam = params->castparam;
 258         ua->castaddr = params->castaddr;
 259         ua->bastparam = params->bastparam;
 260         ua->bastaddr = params->bastaddr;
 261         ua->xid = params->xid;
 262
 263         if (params->flags & DLM_LKF_CONVERT)
 264                 error = dlm_user_convert(ls, ua,
 265                                          params->mode, params->flags,
 266                                          params->lkid, params->lvb,
 267                                          (unsigned long) params->timeout);
 268         else {
 269                 error = dlm_user_request(ls, ua,
 270                                          params->mode, params->flags,
 271                                          params->name, params->namelen,
 272                                          (unsigned long) params->timeout);
 273                 if (!error)
 274                         error = ua->lksb.sb_lkid;
 275         }
 276  out:
 277         dlm_put_lockspace(ls);
 278         return error;
 279 }
 280
 281 static int device_user_unlock(struct dlm_user_proc *proc,
 282                               struct dlm_lock_params *params)
 283 {
 284         struct dlm_ls *ls;
 285         struct dlm_user_args *ua;
 286         int error = -ENOMEM;
 287
 288         ls = dlm_find_lockspace_local(proc->lockspace);
 289         if (!ls)
 290                 return -ENOENT;
 291
 292         ua = kzalloc(sizeof(struct dlm_user_args), GFP_NOFS);
 293         if (!ua)
 294                 goto out;
 295         ua->proc = proc;
 296         ua->user_lksb = params->lksb;
 297         ua->castparam = params->castparam;
 298         ua->castaddr = params->castaddr;
 299
 300         if (params->flags & DLM_LKF_CANCEL)
 301                 error = dlm_user_cancel(ls, ua, params->flags, params->lkid);
 302         else
 303                 error = dlm_user_unlock(ls, ua, params->flags, params->lkid,
 304                                         params->lvb);
 305  out:
 306         dlm_put_lockspace(ls);
 307         return error;
 308 }
 309
 310 static int device_user_deadlock(struct dlm_user_proc *proc,
 311                                 struct dlm_lock_params *params)
 312 {
 313         struct dlm_ls *ls;
 314         int error;
 315
 316         ls = dlm_find_lockspace_local(proc->lockspace);
 317         if (!ls)
 318                 return -ENOENT;
 319
 320         error = dlm_user_deadlock(ls, params->flags, params->lkid);
 321
 322         dlm_put_lockspace(ls);
 323         return error;
 324 }
 325
 326 static int dlm_device_register(struct dlm_ls *ls, char *name)
 327 {
 328         int error, len;
 329
 330         /* The device is already registered.  This happens when the
 331            lockspace is created multiple times from userspace. */
 332         if (ls->ls_device.name)
 333                 return 0;
 334
 335         error = -ENOMEM;
 336         len = strlen(name) + strlen(name_prefix) + 2;
 337         ls->ls_device.name = kzalloc(len, GFP_NOFS);
 338         if (!ls->ls_device.name)
 339                 goto fail;
 340
 341         snprintf((char *)ls->ls_device.name, len, "%s_%s", name_prefix,
 342                  name);
 343         ls->ls_device.fops = &device_fops;
 344         ls->ls_device.minor = MISC_DYNAMIC_MINOR;
 345
 346         error = misc_register(&ls->ls_device);
 347         if (error) {
 348                 kfree(ls->ls_device.name);
 349                 /* this has to be set to NULL
 350                  * to avoid a double-free in dlm_device_deregister
 351                  */
 352                 ls->ls_device.name = NULL;
 353         }
 354 fail:
 355         return error;
 356 }
 357
 358 int dlm_device_deregister(struct dlm_ls *ls)
 359 {
 360         int error;
 361
 362         /* The device is not registered.  This happens when the lockspace
 363            was never used from userspace, or when device_create_lockspace()
 364            calls dlm_release_lockspace() after the register fails. */
 365         if (!ls->ls_device.name)
 366                 return 0;
 367
 368         error = misc_deregister(&ls->ls_device);
 369         if (!error)
 370                 kfree(ls->ls_device.name);
 371         return error;
 372 }
 373
 374 static int device_user_purge(struct dlm_user_proc *proc,
 375                              struct dlm_purge_params *params)
 376 {
 377         struct dlm_ls *ls;
 378         int error;
 379
 380         ls = dlm_find_lockspace_local(proc->lockspace);
 381         if (!ls)
 382                 return -ENOENT;
 383
 384         error = dlm_user_purge(ls, proc, params->nodeid, params->pid);
 385
 386         dlm_put_lockspace(ls);
 387         return error;
 388 }
 389
 390 static int device_create_lockspace(struct dlm_lspace_params *params)
 391 {
 392         dlm_lockspace_t *lockspace;
 393         struct dlm_ls *ls;
 394         int error;
 395
 396         if (!capable(CAP_SYS_ADMIN))
 397                 return -EPERM;
 398
 399         error = dlm_new_lockspace(params->name, strlen(params->name),
 400                                   &lockspace, params->flags, DLM_USER_LVB_LEN);
 401         if (error)
 402                 return error;
 403
 404         ls = dlm_find_lockspace_local(lockspace);
 405         if (!ls)
 406                 return -ENOENT;
 407
 408         error = dlm_device_register(ls, params->name);
 409         dlm_put_lockspace(ls);
 410
 411         if (error)
 412                 dlm_release_lockspace(lockspace, 0);
 413         else
 414                 error = ls->ls_device.minor;
 415
 416         return error;
 417 }
 418
 419 static int device_remove_lockspace(struct dlm_lspace_params *params)
 420 {
 421         dlm_lockspace_t *lockspace;
 422         struct dlm_ls *ls;
 423         int error, force = 0;
 424
 425         if (!capable(CAP_SYS_ADMIN))
 426                 return -EPERM;
 427
 428         ls = dlm_find_lockspace_device(params->minor);
 429         if (!ls)
 430                 return -ENOENT;
 431
 432         if (params->flags & DLM_USER_LSFLG_FORCEFREE)
 433                 force = 2;
 434
 435         lockspace = ls->ls_local_handle;
 436         dlm_put_lockspace(ls);
 437
 438         /* The final dlm_release_lockspace waits for references to go to
 439            zero, so all processes will need to close their device for the
 440            ls before the release will proceed.  release also calls the
 441            device_deregister above.  Converting a positive return value
 442            from release to zero means that userspace won't know when its
 443            release was the final one, but it shouldn't need to know. */
 444
 445         error = dlm_release_lockspace(lockspace, force);
 446         if (error > 0)
 447                 error = 0;
 448         return error;
 449 }
 450
 451 /* Check the user's version matches ours */
 452 static int check_version(struct dlm_write_request *req)
 453 {
 454         if (req->version[0] != DLM_DEVICE_VERSION_MAJOR ||
 455             (req->version[0] == DLM_DEVICE_VERSION_MAJOR &&
 456              req->version[1] > DLM_DEVICE_VERSION_MINOR)) {
 457
 458                 printk(KERN_DEBUG "dlm: process %s (%d) version mismatch "
 459                        "user (%d.%d.%d) kernel (%d.%d.%d)\n",
 460                        current->comm,
 461                        task_pid_nr(current),
 462                        req->version[0],
 463                        req->version[1],
 464                        req->version[2],
 465                        DLM_DEVICE_VERSION_MAJOR,
 466                        DLM_DEVICE_VERSION_MINOR,
 467                        DLM_DEVICE_VERSION_PATCH);
 468                 return -EINVAL;
 469         }
 470         return 0;
 471 }
 472
 473 /*
 474  * device_write
 475  *
 476  *   device_user_lock
 477  *     dlm_user_request -> request_lock
 478  *     dlm_user_convert -> convert_lock
 479  *
 480  *   device_user_unlock
 481  *     dlm_user_unlock -> unlock_lock
 482  *     dlm_user_cancel -> cancel_lock
 483  *
 484  *   device_create_lockspace
 485  *     dlm_new_lockspace
 486  *
 487  *   device_remove_lockspace
 488  *     dlm_release_lockspace
 489  */
 490
 491 /* a write to a lockspace device is a lock or unlock request, a write
 492    to the control device is to create/remove a lockspace */
 493
 494 static ssize_t device_write(struct file *file, const char __user *buf,
 495                             size_t count, loff_t *ppos)
 496 {
 497         struct dlm_user_proc *proc = file->private_data;
 498         struct dlm_write_request *kbuf;
 499         sigset_t tmpsig, allsigs;
 500         int error;
 501
 502 #ifdef CONFIG_COMPAT
 503         if (count < sizeof(struct dlm_write_request32))
 504 #else
 505         if (count < sizeof(struct dlm_write_request))
 506 #endif
 507                 return -EINVAL;
 508
 509         kbuf = kzalloc(count + 1, GFP_NOFS);
 510         if (!kbuf)
 511                 return -ENOMEM;
 512
 513         if (copy_from_user(kbuf, buf, count)) {
 514                 error = -EFAULT;
 515                 goto out_free;
 516         }
 517
 518         if (check_version(kbuf)) {
 519                 error = -EBADE;
 520                 goto out_free;
 521         }
 522
 523 #ifdef CONFIG_COMPAT
 524         if (!kbuf->is64bit) {
 525                 struct dlm_write_request32 *k32buf;
 526                 int namelen = 0;
 527
 528                 if (count > sizeof(struct dlm_write_request32))
 529                         namelen = count - sizeof(struct dlm_write_request32);
 530
 531                 k32buf = (struct dlm_write_request32 *)kbuf;
 532
 533                 /* add 1 after namelen so that the name string is terminated */
 534                 kbuf = kzalloc(sizeof(struct dlm_write_request) + namelen + 1,
 535                                GFP_NOFS);
 536                 if (!kbuf) {
 537                         kfree(k32buf);
 538                         return -ENOMEM;
 539                 }
 540
 541                 if (proc)
 542                         set_bit(DLM_PROC_FLAGS_COMPAT, &proc->flags);
 543
 544                 compat_input(kbuf, k32buf, namelen);
 545                 kfree(k32buf);
 546         }
 547 #endif
 548
 549         /* do we really need this? can a write happen after a close? */
 550         if ((kbuf->cmd == DLM_USER_LOCK || kbuf->cmd == DLM_USER_UNLOCK) &&
 551             (proc && test_bit(DLM_PROC_FLAGS_CLOSING, &proc->flags))) {
 552                 error = -EINVAL;
 553                 goto out_free;
 554         }
 555
 556         sigfillset(&allsigs);
 557         sigprocmask(SIG_BLOCK, &allsigs, &tmpsig);
 558
 559         error = -EINVAL;
 560
 561         switch (kbuf->cmd)
 562         {
 563         case DLM_USER_LOCK:
 564                 if (!proc) {
 565                         log_print("no locking on control device");
 566                         goto out_sig;
 567                 }
 568                 error = device_user_lock(proc, &kbuf->i.lock);
 569                 break;
 570
 571         case DLM_USER_UNLOCK:
 572                 if (!proc) {
 573                         log_print("no locking on control device");
 574                         goto out_sig;
 575                 }
 576                 error = device_user_unlock(proc, &kbuf->i.lock);
 577                 break;
 578
 579         case DLM_USER_DEADLOCK:
 580                 if (!proc) {
 581                         log_print("no locking on control device");
 582                         goto out_sig;
 583                 }
 584                 error = device_user_deadlock(proc, &kbuf->i.lock);
 585                 break;
 586
 587         case DLM_USER_CREATE_LOCKSPACE:
 588                 if (proc) {
 589                         log_print("create/remove only on control device");
 590                         goto out_sig;
 591                 }
 592                 error = device_create_lockspace(&kbuf->i.lspace);
 593                 break;
 594
 595         case DLM_USER_REMOVE_LOCKSPACE:
 596                 if (proc) {
 597                         log_print("create/remove only on control device");
 598                         goto out_sig;
 599                 }
 600                 error = device_remove_lockspace(&kbuf->i.lspace);
 601                 break;
 602
 603         case DLM_USER_PURGE:
 604                 if (!proc) {
 605                         log_print("no locking on control device");
 606                         goto out_sig;
 607                 }
 608                 error = device_user_purge(proc, &kbuf->i.purge);
 609                 break;
 610
 611         default:
 612                 log_print("Unknown command passed to DLM device : %d\n",
 613                           kbuf->cmd);
 614         }
 615
 616  out_sig:
 617         sigprocmask(SIG_SETMASK, &tmpsig, NULL);
 618  out_free:
 619         kfree(kbuf);
 620         return error;
 621 }
 622
 623 /* Every process that opens the lockspace device has its own "proc" structure
 624    hanging off the open file that's used to keep track of locks owned by the
 625    process and asts that need to be delivered to the process. */
 626
 627 static int device_open(struct inode *inode, struct file *file)
 628 {
 629         struct dlm_user_proc *proc;
 630         struct dlm_ls *ls;
 631
 632         ls = dlm_find_lockspace_device(iminor(inode));
 633         if (!ls)
 634                 return -ENOENT;
 635
 636         proc = kzalloc(sizeof(struct dlm_user_proc), GFP_NOFS);
 637         if (!proc) {
 638                 dlm_put_lockspace(ls);
 639                 return -ENOMEM;
 640         }
 641
 642         proc->lockspace = ls->ls_local_handle;
 643         INIT_LIST_HEAD(&proc->asts);
 644         INIT_LIST_HEAD(&proc->locks);
 645         INIT_LIST_HEAD(&proc->unlocking);
 646         spin_lock_init(&proc->asts_spin);
 647         spin_lock_init(&proc->locks_spin);
 648         init_waitqueue_head(&proc->wait);
 649         file->private_data = proc;
 650
 651         return 0;
 652 }
 653
 654 static int device_close(struct inode *inode, struct file *file)
 655 {
 656         struct dlm_user_proc *proc = file->private_data;
 657         struct dlm_ls *ls;
 658         sigset_t tmpsig, allsigs;
 659
 660         ls = dlm_find_lockspace_local(proc->lockspace);
 661         if (!ls)
 662                 return -ENOENT;
 663
 664         sigfillset(&allsigs);
 665         sigprocmask(SIG_BLOCK, &allsigs, &tmpsig);
 666
 667         set_bit(DLM_PROC_FLAGS_CLOSING, &proc->flags);
 668
 669         dlm_clear_proc_locks(ls, proc);
 670
 671         /* at this point no more lkb's should exist for this lockspace,
 672            so there's no chance of dlm_user_add_ast() being called and
 673            looking for lkb->ua->proc */
 674
 675         kfree(proc);
 676         file->private_data = NULL;
 677
 678         dlm_put_lockspace(ls);
 679         dlm_put_lockspace(ls);  /* for the find in device_open() */
 680
 681         /* FIXME: AUTOFREE: if this ls is no longer used do
 682            device_remove_lockspace() */
 683
 684         sigprocmask(SIG_SETMASK, &tmpsig, NULL);
 685         recalc_sigpending();
 686
 687         return 0;
 688 }
 689
 690 static int copy_result_to_user(struct dlm_user_args *ua, int compat,
 691                                uint32_t flags, int mode, int copy_lvb,
 692                                char __user *buf, size_t count)
 693 {
 694 #ifdef CONFIG_COMPAT
 695         struct dlm_lock_result32 result32;
 696 #endif
 697         struct dlm_lock_result result;
 698         void *resultptr;
 699         int error=0;
 700         int len;
 701         int struct_len;
 702
 703         memset(&result, 0, sizeof(struct dlm_lock_result));
 704         result.version[0] = DLM_DEVICE_VERSION_MAJOR;
 705         result.version[1] = DLM_DEVICE_VERSION_MINOR;
 706         result.version[2] = DLM_DEVICE_VERSION_PATCH;
 707         memcpy(&result.lksb, &ua->lksb, sizeof(struct dlm_lksb));
 708         result.user_lksb = ua->user_lksb;
 709
 710         /* FIXME: dlm1 provides for the user's bastparam/addr to not be updated
 711            in a conversion unless the conversion is successful.  See code
 712            in dlm_user_convert() for updating ua from ua_tmp.  OpenVMS, though,
 713            notes that a new blocking AST address and parameter are set even if
 714            the conversion fails, so maybe we should just do that. */
 715
 716         if (flags & DLM_CB_BAST) {
 717                 result.user_astaddr = ua->bastaddr;
 718                 result.user_astparam = ua->bastparam;
 719                 result.bast_mode = mode;
 720         } else {
 721                 result.user_astaddr = ua->castaddr;
 722                 result.user_astparam = ua->castparam;
 723         }
 724
 725 #ifdef CONFIG_COMPAT
 726         if (compat)
 727                 len = sizeof(struct dlm_lock_result32);
 728         else
 729 #endif
 730                 len = sizeof(struct dlm_lock_result);
 731         struct_len = len;
 732
 733         /* copy lvb to userspace if there is one, it's been updated, and
 734            the user buffer has space for it */
 735
 736         if (copy_lvb && ua->lksb.sb_lvbptr && count >= len + DLM_USER_LVB_LEN) {
 737                 if (copy_to_user(buf+len, ua->lksb.sb_lvbptr,
 738                                  DLM_USER_LVB_LEN)) {
 739                         error = -EFAULT;
 740                         goto out;
 741                 }
 742
 743                 result.lvb_offset = len;
 744                 len += DLM_USER_LVB_LEN;
 745         }
 746
 747         result.length = len;
 748         resultptr = &result;
 749 #ifdef CONFIG_COMPAT
 750         if (compat) {
 751                 compat_output(&result, &result32);
 752                 resultptr = &result32;
 753         }
 754 #endif
 755
 756         if (copy_to_user(buf, resultptr, struct_len))
 757                 error = -EFAULT;
 758         else
 759                 error = len;
 760  out:
 761         return error;
 762 }
 763
 764 static int copy_version_to_user(char __user *buf, size_t count)
 765 {
 766         struct dlm_device_version ver;
 767
 768         memset(&ver, 0, sizeof(struct dlm_device_version));
 769         ver.version[0] = DLM_DEVICE_VERSION_MAJOR;
 770         ver.version[1] = DLM_DEVICE_VERSION_MINOR;
 771         ver.version[2] = DLM_DEVICE_VERSION_PATCH;
 772
 773         if (copy_to_user(buf, &ver, sizeof(struct dlm_device_version)))
 774                 return -EFAULT;
 775         return sizeof(struct dlm_device_version);
 776 }
 777
 778 /* a read returns a single ast described in a struct dlm_lock_result */
 779
 780 static ssize_t device_read(struct file *file, char __user *buf, size_t count,
 781                            loff_t *ppos)
 782 {
 783         struct dlm_user_proc *proc = file->private_data;
 784         struct dlm_lkb *lkb;
 785         DECLARE_WAITQUEUE(wait, current);
 786         struct dlm_callback cb;
 787         int rv, resid, copy_lvb = 0;
 788
 789         if (count == sizeof(struct dlm_device_version)) {
 790                 rv = copy_version_to_user(buf, count);
 791                 return rv;
 792         }
 793
 794         if (!proc) {
 795                 log_print("non-version read from control device %zu", count);
 796                 return -EINVAL;
 797         }
 798
 799 #ifdef CONFIG_COMPAT
 800         if (count < sizeof(struct dlm_lock_result32))
 801 #else
 802         if (count < sizeof(struct dlm_lock_result))
 803 #endif
 804                 return -EINVAL;
 805
 806  try_another:
 807
 808         /* do we really need this? can a read happen after a close? */
 809         if (test_bit(DLM_PROC_FLAGS_CLOSING, &proc->flags))
 810                 return -EINVAL;
 811
 812         spin_lock(&proc->asts_spin);
 813         if (list_empty(&proc->asts)) {
 814                 if (file->f_flags & O_NONBLOCK) {
 815                         spin_unlock(&proc->asts_spin);
 816                         return -EAGAIN;
 817                 }
 818
 819                 add_wait_queue(&proc->wait, &wait);
 820
 821         repeat:
 822                 set_current_state(TASK_INTERRUPTIBLE);
 823                 if (list_empty(&proc->asts) && !signal_pending(current)) {
 824                         spin_unlock(&proc->asts_spin);
 825                         schedule();
 826                         spin_lock(&proc->asts_spin);
 827                         goto repeat;
 828                 }
 829                 set_current_state(TASK_RUNNING);
 830                 remove_wait_queue(&proc->wait, &wait);
 831
 832                 if (signal_pending(current)) {
 833                         spin_unlock(&proc->asts_spin);
 834                         return -ERESTARTSYS;
 835                 }
 836         }
 837
 838         /* if we empty lkb_callbacks, we don't want to unlock the spinlock
 839            without removing lkb_cb_list; so empty lkb_cb_list is always
 840            consistent with empty lkb_callbacks */
 841
 842         lkb = list_entry(proc->asts.next, struct dlm_lkb, lkb_cb_list);
 843
 844         rv = dlm_rem_lkb_callback(lkb->lkb_resource->res_ls, lkb, &cb, &resid);
 845         if (rv < 0) {
 846                 /* this shouldn't happen; lkb should have been removed from
 847                    list when resid was zero */
 848                 log_print("dlm_rem_lkb_callback empty %x", lkb->lkb_id);
 849                 list_del_init(&lkb->lkb_cb_list);
 850                 spin_unlock(&proc->asts_spin);
 851                 /* removes ref for proc->asts, may cause lkb to be freed */
 852                 dlm_put_lkb(lkb);
 853                 goto try_another;
 854         }
 855         if (!resid)
 856                 list_del_init(&lkb->lkb_cb_list);
 857         spin_unlock(&proc->asts_spin);
 858
 859         if (cb.flags & DLM_CB_SKIP) {
 860                 /* removes ref for proc->asts, may cause lkb to be freed */
 861                 if (!resid)
 862                         dlm_put_lkb(lkb);
 863                 goto try_another;
 864         }
 865
 866         if (cb.flags & DLM_CB_CAST) {
 867                 int old_mode, new_mode;
 868
 869                 old_mode = lkb->lkb_last_cast.mode;
 870                 new_mode = cb.mode;
 871
 872                 if (!cb.sb_status && lkb->lkb_lksb->sb_lvbptr &&
 873                     dlm_lvb_operations[old_mode + 1][new_mode + 1])
 874                         copy_lvb = 1;
 875
 876                 lkb->lkb_lksb->sb_status = cb.sb_status;
 877                 lkb->lkb_lksb->sb_flags = cb.sb_flags;
 878         }
 879
 880         rv = copy_result_to_user(lkb->lkb_ua,
 881                                  test_bit(DLM_PROC_FLAGS_COMPAT, &proc->flags),
 882                                  cb.flags, cb.mode, copy_lvb, buf, count);
 883
 884         /* removes ref for proc->asts, may cause lkb to be freed */
 885         if (!resid)
 886                 dlm_put_lkb(lkb);
 887
 888         return rv;
 889 }
 890
 891 static unsigned int device_poll(struct file *file, poll_table *wait)
 892 {
 893         struct dlm_user_proc *proc = file->private_data;
 894
 895         poll_wait(file, &proc->wait, wait);
 896
 897         spin_lock(&proc->asts_spin);
 898         if (!list_empty(&proc->asts)) {
 899                 spin_unlock(&proc->asts_spin);
 900                 return POLLIN | POLLRDNORM;
 901         }
 902         spin_unlock(&proc->asts_spin);
 903         return 0;
 904 }
 905
 906 int dlm_user_daemon_available(void)
 907 {
 908         /* dlm_controld hasn't started (or, has started, but not
 909            properly populated configfs) */
 910
 911         if (!dlm_our_nodeid())
 912                 return 0;
 913
 914         /* This is to deal with versions of dlm_controld that don't
 915            know about the monitor device.  We assume that if the
 916            dlm_controld was started (above), but the monitor device
 917            was never opened, that it's an old version.  dlm_controld
 918            should open the monitor device before populating configfs. */
 919
 920         if (dlm_monitor_unused)
 921                 return 1;
 922
 923         return atomic_read(&dlm_monitor_opened) ? 1 : 0;
 924 }
 925
 926 static int ctl_device_open(struct inode *inode, struct file *file)
 927 {
 928         file->private_data = NULL;
 929         return 0;
 930 }
 931
 932 static int ctl_device_close(struct inode *inode, struct file *file)
 933 {
 934         return 0;
 935 }
 936
 937 static int monitor_device_open(struct inode *inode, struct file *file)
 938 {
 939         atomic_inc(&dlm_monitor_opened);
 940         dlm_monitor_unused = 0;
 941         return 0;
 942 }
 943
 944 static int monitor_device_close(struct inode *inode, struct file *file)
 945 {
 946         if (atomic_dec_and_test(&dlm_monitor_opened))
 947                 dlm_stop_lockspaces();
 948         return 0;
 949 }
 950
 951 static const struct file_operations device_fops = {
 952         .open    = device_open,
 953         .release = device_close,
 954         .read    = device_read,
 955         .write   = device_write,
 956         .poll    = device_poll,
 957         .owner   = THIS_MODULE,
 958         .llseek  = noop_llseek,
 959 };
 960
 961 static const struct file_operations ctl_device_fops = {
 962         .open    = ctl_device_open,
 963         .release = ctl_device_close,
 964         .read    = device_read,
 965         .write   = device_write,
 966         .owner   = THIS_MODULE,
 967         .llseek  = noop_llseek,
 968 };
 969
 970 static struct miscdevice ctl_device = {
 971         .name  = "dlm-control",
 972         .fops  = &ctl_device_fops,
 973         .minor = MISC_DYNAMIC_MINOR,
 974 };
 975
 976 static const struct file_operations monitor_device_fops = {
 977         .open    = monitor_device_open,
 978         .release = monitor_device_close,
 979         .owner   = THIS_MODULE,
 980         .llseek  = noop_llseek,
 981 };
 982
 983 static struct miscdevice monitor_device = {
 984         .name  = "dlm-monitor",
 985         .fops  = &monitor_device_fops,
 986         .minor = MISC_DYNAMIC_MINOR,
 987 };
 988
 989 int __init dlm_user_init(void)
 990 {
 991         int error;
 992
 993         atomic_set(&dlm_monitor_opened, 0);
 994
 995         error = misc_register(&ctl_device);
 996         if (error) {
 997                 log_print("misc_register failed for control device");
 998                 goto out;
 999         }
1000
1001         error = misc_register(&monitor_device);
1002         if (error) {
1003                 log_print("misc_register failed for monitor device");
1004                 misc_deregister(&ctl_device);
1005         }
1006  out:
1007         return error;
1008 }
1009
1010 void dlm_user_exit(void)
1011 {
1012         misc_deregister(&ctl_device);
1013         misc_deregister(&monitor_device);
1014 }
1015