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         uint32_t lkid;
 242         int error = -ENOMEM;
 243
 244         ls = dlm_find_lockspace_local(proc->lockspace);
 245         if (!ls)
 246                 return -ENOENT;
 247
 248         if (!params->castaddr || !params->lksb) {
 249                 error = -EINVAL;
 250                 goto out;
 251         }
 252
 253         ua = kzalloc(sizeof(struct dlm_user_args), GFP_NOFS);
 254         if (!ua)
 255                 goto out;
 256         ua->proc = proc;
 257         ua->user_lksb = params->lksb;
 258         ua->castparam = params->castparam;
 259         ua->castaddr = params->castaddr;
 260         ua->bastparam = params->bastparam;
 261         ua->bastaddr = params->bastaddr;
 262         ua->xid = params->xid;
 263
 264         if (params->flags & DLM_LKF_CONVERT) {
 265                 error = dlm_user_convert(ls, ua,
 266                                          params->mode, params->flags,
 267                                          params->lkid, params->lvb,
 268                                          (unsigned long) params->timeout);
 269         } else if (params->flags & DLM_LKF_ORPHAN) {
 270                 error = dlm_user_adopt_orphan(ls, ua,
 271                                          params->mode, params->flags,
 272                                          params->name, params->namelen,
 273                                          (unsigned long) params->timeout,
 274                                          &lkid);
 275                 if (!error)
 276                         error = lkid;
 277         } else {
 278                 error = dlm_user_request(ls, ua,
 279                                          params->mode, params->flags,
 280                                          params->name, params->namelen,
 281                                          (unsigned long) params->timeout);
 282                 if (!error)
 283                         error = ua->lksb.sb_lkid;
 284         }
 285  out:
 286         dlm_put_lockspace(ls);
 287         return error;
 288 }
 289
 290 static int device_user_unlock(struct dlm_user_proc *proc,
 291                               struct dlm_lock_params *params)
 292 {
 293         struct dlm_ls *ls;
 294         struct dlm_user_args *ua;
 295         int error = -ENOMEM;
 296
 297         ls = dlm_find_lockspace_local(proc->lockspace);
 298         if (!ls)
 299                 return -ENOENT;
 300
 301         ua = kzalloc(sizeof(struct dlm_user_args), GFP_NOFS);
 302         if (!ua)
 303                 goto out;
 304         ua->proc = proc;
 305         ua->user_lksb = params->lksb;
 306         ua->castparam = params->castparam;
 307         ua->castaddr = params->castaddr;
 308
 309         if (params->flags & DLM_LKF_CANCEL)
 310                 error = dlm_user_cancel(ls, ua, params->flags, params->lkid);
 311         else
 312                 error = dlm_user_unlock(ls, ua, params->flags, params->lkid,
 313                                         params->lvb);
 314  out:
 315         dlm_put_lockspace(ls);
 316         return error;
 317 }
 318
 319 static int device_user_deadlock(struct dlm_user_proc *proc,
 320                                 struct dlm_lock_params *params)
 321 {
 322         struct dlm_ls *ls;
 323         int error;
 324
 325         ls = dlm_find_lockspace_local(proc->lockspace);
 326         if (!ls)
 327                 return -ENOENT;
 328
 329         error = dlm_user_deadlock(ls, params->flags, params->lkid);
 330
 331         dlm_put_lockspace(ls);
 332         return error;
 333 }
 334
 335 static int dlm_device_register(struct dlm_ls *ls, char *name)
 336 {
 337         int error, len;
 338
 339         /* The device is already registered.  This happens when the
 340            lockspace is created multiple times from userspace. */
 341         if (ls->ls_device.name)
 342                 return 0;
 343
 344         error = -ENOMEM;
 345         len = strlen(name) + strlen(name_prefix) + 2;
 346         ls->ls_device.name = kzalloc(len, GFP_NOFS);
 347         if (!ls->ls_device.name)
 348                 goto fail;
 349
 350         snprintf((char *)ls->ls_device.name, len, "%s_%s", name_prefix,
 351                  name);
 352         ls->ls_device.fops = &device_fops;
 353         ls->ls_device.minor = MISC_DYNAMIC_MINOR;
 354
 355         error = misc_register(&ls->ls_device);
 356         if (error) {
 357                 kfree(ls->ls_device.name);
 358                 /* this has to be set to NULL
 359                  * to avoid a double-free in dlm_device_deregister
 360                  */
 361                 ls->ls_device.name = NULL;
 362         }
 363 fail:
 364         return error;
 365 }
 366
 367 int dlm_device_deregister(struct dlm_ls *ls)
 368 {
 369         /* The device is not registered.  This happens when the lockspace
 370            was never used from userspace, or when device_create_lockspace()
 371            calls dlm_release_lockspace() after the register fails. */
 372         if (!ls->ls_device.name)
 373                 return 0;
 374
 375         misc_deregister(&ls->ls_device);
 376         kfree(ls->ls_device.name);
 377         return 0;
 378 }
 379
 380 static int device_user_purge(struct dlm_user_proc *proc,
 381                              struct dlm_purge_params *params)
 382 {
 383         struct dlm_ls *ls;
 384         int error;
 385
 386         ls = dlm_find_lockspace_local(proc->lockspace);
 387         if (!ls)
 388                 return -ENOENT;
 389
 390         error = dlm_user_purge(ls, proc, params->nodeid, params->pid);
 391
 392         dlm_put_lockspace(ls);
 393         return error;
 394 }
 395
 396 static int device_create_lockspace(struct dlm_lspace_params *params)
 397 {
 398         dlm_lockspace_t *lockspace;
 399         struct dlm_ls *ls;
 400         int error;
 401
 402         if (!capable(CAP_SYS_ADMIN))
 403                 return -EPERM;
 404
 405         error = dlm_new_lockspace(params->name, NULL, params->flags,
 406                                   DLM_USER_LVB_LEN, NULL, NULL, NULL,
 407                                   &lockspace);
 408         if (error)
 409                 return error;
 410
 411         ls = dlm_find_lockspace_local(lockspace);
 412         if (!ls)
 413                 return -ENOENT;
 414
 415         error = dlm_device_register(ls, params->name);
 416         dlm_put_lockspace(ls);
 417
 418         if (error)
 419                 dlm_release_lockspace(lockspace, 0);
 420         else
 421                 error = ls->ls_device.minor;
 422
 423         return error;
 424 }
 425
 426 static int device_remove_lockspace(struct dlm_lspace_params *params)
 427 {
 428         dlm_lockspace_t *lockspace;
 429         struct dlm_ls *ls;
 430         int error, force = 0;
 431
 432         if (!capable(CAP_SYS_ADMIN))
 433                 return -EPERM;
 434
 435         ls = dlm_find_lockspace_device(params->minor);
 436         if (!ls)
 437                 return -ENOENT;
 438
 439         if (params->flags & DLM_USER_LSFLG_FORCEFREE)
 440                 force = 2;
 441
 442         lockspace = ls->ls_local_handle;
 443         dlm_put_lockspace(ls);
 444
 445         /* The final dlm_release_lockspace waits for references to go to
 446            zero, so all processes will need to close their device for the
 447            ls before the release will proceed.  release also calls the
 448            device_deregister above.  Converting a positive return value
 449            from release to zero means that userspace won't know when its
 450            release was the final one, but it shouldn't need to know. */
 451
 452         error = dlm_release_lockspace(lockspace, force);
 453         if (error > 0)
 454                 error = 0;
 455         return error;
 456 }
 457
 458 /* Check the user's version matches ours */
 459 static int check_version(struct dlm_write_request *req)
 460 {
 461         if (req->version[0] != DLM_DEVICE_VERSION_MAJOR ||
 462             (req->version[0] == DLM_DEVICE_VERSION_MAJOR &&
 463              req->version[1] > DLM_DEVICE_VERSION_MINOR)) {
 464
 465                 printk(KERN_DEBUG "dlm: process %s (%d) version mismatch "
 466                        "user (%d.%d.%d) kernel (%d.%d.%d)\n",
 467                        current->comm,
 468                        task_pid_nr(current),
 469                        req->version[0],
 470                        req->version[1],
 471                        req->version[2],
 472                        DLM_DEVICE_VERSION_MAJOR,
 473                        DLM_DEVICE_VERSION_MINOR,
 474                        DLM_DEVICE_VERSION_PATCH);
 475                 return -EINVAL;
 476         }
 477         return 0;
 478 }
 479
 480 /*
 481  * device_write
 482  *
 483  *   device_user_lock
 484  *     dlm_user_request -> request_lock
 485  *     dlm_user_convert -> convert_lock
 486  *
 487  *   device_user_unlock
 488  *     dlm_user_unlock -> unlock_lock
 489  *     dlm_user_cancel -> cancel_lock
 490  *
 491  *   device_create_lockspace
 492  *     dlm_new_lockspace
 493  *
 494  *   device_remove_lockspace
 495  *     dlm_release_lockspace
 496  */
 497
 498 /* a write to a lockspace device is a lock or unlock request, a write
 499    to the control device is to create/remove a lockspace */
 500
 501 static ssize_t device_write(struct file *file, const char __user *buf,
 502                             size_t count, loff_t *ppos)
 503 {
 504         struct dlm_user_proc *proc = file->private_data;
 505         struct dlm_write_request *kbuf;
 506         int error;
 507
 508 #ifdef CONFIG_COMPAT
 509         if (count < sizeof(struct dlm_write_request32))
 510 #else
 511         if (count < sizeof(struct dlm_write_request))
 512 #endif
 513                 return -EINVAL;
 514
 515         /*
 516          * can't compare against COMPAT/dlm_write_request32 because
 517          * we don't yet know if is64bit is zero
 518          */
 519         if (count > sizeof(struct dlm_write_request) + DLM_RESNAME_MAXLEN)
 520                 return -EINVAL;
 521
 522         kbuf = kzalloc(count + 1, GFP_NOFS);
 523         if (!kbuf)
 524                 return -ENOMEM;
 525
 526         if (copy_from_user(kbuf, buf, count)) {
 527                 error = -EFAULT;
 528                 goto out_free;
 529         }
 530
 531         if (check_version(kbuf)) {
 532                 error = -EBADE;
 533                 goto out_free;
 534         }
 535
 536 #ifdef CONFIG_COMPAT
 537         if (!kbuf->is64bit) {
 538                 struct dlm_write_request32 *k32buf;
 539                 int namelen = 0;
 540
 541                 if (count > sizeof(struct dlm_write_request32))
 542                         namelen = count - sizeof(struct dlm_write_request32);
 543
 544                 k32buf = (struct dlm_write_request32 *)kbuf;
 545
 546                 /* add 1 after namelen so that the name string is terminated */
 547                 kbuf = kzalloc(sizeof(struct dlm_write_request) + namelen + 1,
 548                                GFP_NOFS);
 549                 if (!kbuf) {
 550                         kfree(k32buf);
 551                         return -ENOMEM;
 552                 }
 553
 554                 if (proc)
 555                         set_bit(DLM_PROC_FLAGS_COMPAT, &proc->flags);
 556
 557                 compat_input(kbuf, k32buf, namelen);
 558                 kfree(k32buf);
 559         }
 560 #endif
 561
 562         /* do we really need this? can a write happen after a close? */
 563         if ((kbuf->cmd == DLM_USER_LOCK || kbuf->cmd == DLM_USER_UNLOCK) &&
 564             (proc && test_bit(DLM_PROC_FLAGS_CLOSING, &proc->flags))) {
 565                 error = -EINVAL;
 566                 goto out_free;
 567         }
 568
 569         error = -EINVAL;
 570
 571         switch (kbuf->cmd)
 572         {
 573         case DLM_USER_LOCK:
 574                 if (!proc) {
 575                         log_print("no locking on control device");
 576                         goto out_free;
 577                 }
 578                 error = device_user_lock(proc, &kbuf->i.lock);
 579                 break;
 580
 581         case DLM_USER_UNLOCK:
 582                 if (!proc) {
 583                         log_print("no locking on control device");
 584                         goto out_free;
 585                 }
 586                 error = device_user_unlock(proc, &kbuf->i.lock);
 587                 break;
 588
 589         case DLM_USER_DEADLOCK:
 590                 if (!proc) {
 591                         log_print("no locking on control device");
 592                         goto out_free;
 593                 }
 594                 error = device_user_deadlock(proc, &kbuf->i.lock);
 595                 break;
 596
 597         case DLM_USER_CREATE_LOCKSPACE:
 598                 if (proc) {
 599                         log_print("create/remove only on control device");
 600                         goto out_free;
 601                 }
 602                 error = device_create_lockspace(&kbuf->i.lspace);
 603                 break;
 604
 605         case DLM_USER_REMOVE_LOCKSPACE:
 606                 if (proc) {
 607                         log_print("create/remove only on control device");
 608                         goto out_free;
 609                 }
 610                 error = device_remove_lockspace(&kbuf->i.lspace);
 611                 break;
 612
 613         case DLM_USER_PURGE:
 614                 if (!proc) {
 615                         log_print("no locking on control device");
 616                         goto out_free;
 617                 }
 618                 error = device_user_purge(proc, &kbuf->i.purge);
 619                 break;
 620
 621         default:
 622                 log_print("Unknown command passed to DLM device : %d\n",
 623                           kbuf->cmd);
 624         }
 625
 626  out_free:
 627         kfree(kbuf);
 628         return error;
 629 }
 630
 631 /* Every process that opens the lockspace device has its own "proc" structure
 632    hanging off the open file that's used to keep track of locks owned by the
 633    process and asts that need to be delivered to the process. */
 634
 635 static int device_open(struct inode *inode, struct file *file)
 636 {
 637         struct dlm_user_proc *proc;
 638         struct dlm_ls *ls;
 639
 640         ls = dlm_find_lockspace_device(iminor(inode));
 641         if (!ls)
 642                 return -ENOENT;
 643
 644         proc = kzalloc(sizeof(struct dlm_user_proc), GFP_NOFS);
 645         if (!proc) {
 646                 dlm_put_lockspace(ls);
 647                 return -ENOMEM;
 648         }
 649
 650         proc->lockspace = ls->ls_local_handle;
 651         INIT_LIST_HEAD(&proc->asts);
 652         INIT_LIST_HEAD(&proc->locks);
 653         INIT_LIST_HEAD(&proc->unlocking);
 654         spin_lock_init(&proc->asts_spin);
 655         spin_lock_init(&proc->locks_spin);
 656         init_waitqueue_head(&proc->wait);
 657         file->private_data = proc;
 658
 659         return 0;
 660 }
 661
 662 static int device_close(struct inode *inode, struct file *file)
 663 {
 664         struct dlm_user_proc *proc = file->private_data;
 665         struct dlm_ls *ls;
 666
 667         ls = dlm_find_lockspace_local(proc->lockspace);
 668         if (!ls)
 669                 return -ENOENT;
 670
 671         set_bit(DLM_PROC_FLAGS_CLOSING, &proc->flags);
 672
 673         dlm_clear_proc_locks(ls, proc);
 674
 675         /* at this point no more lkb's should exist for this lockspace,
 676            so there's no chance of dlm_user_add_ast() being called and
 677            looking for lkb->ua->proc */
 678
 679         kfree(proc);
 680         file->private_data = NULL;
 681
 682         dlm_put_lockspace(ls);
 683         dlm_put_lockspace(ls);  /* for the find in device_open() */
 684
 685         /* FIXME: AUTOFREE: if this ls is no longer used do
 686            device_remove_lockspace() */
 687
 688         return 0;
 689 }
 690
 691 static int copy_result_to_user(struct dlm_user_args *ua, int compat,
 692                                uint32_t flags, int mode, int copy_lvb,
 693                                char __user *buf, size_t count)
 694 {
 695 #ifdef CONFIG_COMPAT
 696         struct dlm_lock_result32 result32;
 697 #endif
 698         struct dlm_lock_result result;
 699         void *resultptr;
 700         int error=0;
 701         int len;
 702         int struct_len;
 703
 704         memset(&result, 0, sizeof(struct dlm_lock_result));
 705         result.version[0] = DLM_DEVICE_VERSION_MAJOR;
 706         result.version[1] = DLM_DEVICE_VERSION_MINOR;
 707         result.version[2] = DLM_DEVICE_VERSION_PATCH;
 708         memcpy(&result.lksb, &ua->lksb, offsetof(struct dlm_lksb, sb_lvbptr));
 709         result.user_lksb = ua->user_lksb;
 710
 711         /* FIXME: dlm1 provides for the user's bastparam/addr to not be updated
 712            in a conversion unless the conversion is successful.  See code
 713            in dlm_user_convert() for updating ua from ua_tmp.  OpenVMS, though,
 714            notes that a new blocking AST address and parameter are set even if
 715            the conversion fails, so maybe we should just do that. */
 716
 717         if (flags & DLM_CB_BAST) {
 718                 result.user_astaddr = ua->bastaddr;
 719                 result.user_astparam = ua->bastparam;
 720                 result.bast_mode = mode;
 721         } else {
 722                 result.user_astaddr = ua->castaddr;
 723                 result.user_astparam = ua->castparam;
 724         }
 725
 726 #ifdef CONFIG_COMPAT
 727         if (compat)
 728                 len = sizeof(struct dlm_lock_result32);
 729         else
 730 #endif
 731                 len = sizeof(struct dlm_lock_result);
 732         struct_len = len;
 733
 734         /* copy lvb to userspace if there is one, it's been updated, and
 735            the user buffer has space for it */
 736
 737         if (copy_lvb && ua->lksb.sb_lvbptr && count >= len + DLM_USER_LVB_LEN) {
 738                 if (copy_to_user(buf+len, ua->lksb.sb_lvbptr,
 739                                  DLM_USER_LVB_LEN)) {
 740                         error = -EFAULT;
 741                         goto out;
 742                 }
 743
 744                 result.lvb_offset = len;
 745                 len += DLM_USER_LVB_LEN;
 746         }
 747
 748         result.length = len;
 749         resultptr = &result;
 750 #ifdef CONFIG_COMPAT
 751         if (compat) {
 752                 compat_output(&result, &result32);
 753                 resultptr = &result32;
 754         }
 755 #endif
 756
 757         if (copy_to_user(buf, resultptr, struct_len))
 758                 error = -EFAULT;
 759         else
 760                 error = len;
 761  out:
 762         return error;
 763 }
 764
 765 static int copy_version_to_user(char __user *buf, size_t count)
 766 {
 767         struct dlm_device_version ver;
 768
 769         memset(&ver, 0, sizeof(struct dlm_device_version));
 770         ver.version[0] = DLM_DEVICE_VERSION_MAJOR;
 771         ver.version[1] = DLM_DEVICE_VERSION_MINOR;
 772         ver.version[2] = DLM_DEVICE_VERSION_PATCH;
 773
 774         if (copy_to_user(buf, &ver, sizeof(struct dlm_device_version)))
 775                 return -EFAULT;
 776         return sizeof(struct dlm_device_version);
 777 }
 778
 779 /* a read returns a single ast described in a struct dlm_lock_result */
 780
 781 static ssize_t device_read(struct file *file, char __user *buf, size_t count,
 782                            loff_t *ppos)
 783 {
 784         struct dlm_user_proc *proc = file->private_data;
 785         struct dlm_lkb *lkb;
 786         DECLARE_WAITQUEUE(wait, current);
 787         struct dlm_callback cb;
 788         int rv, resid, copy_lvb = 0;
 789         int old_mode, new_mode;
 790
 791         if (count == sizeof(struct dlm_device_version)) {
 792                 rv = copy_version_to_user(buf, count);
 793                 return rv;
 794         }
 795
 796         if (!proc) {
 797                 log_print("non-version read from control device %zu", count);
 798                 return -EINVAL;
 799         }
 800
 801 #ifdef CONFIG_COMPAT
 802         if (count < sizeof(struct dlm_lock_result32))
 803 #else
 804         if (count < sizeof(struct dlm_lock_result))
 805 #endif
 806                 return -EINVAL;
 807
 808  try_another:
 809
 810         /* do we really need this? can a read happen after a close? */
 811         if (test_bit(DLM_PROC_FLAGS_CLOSING, &proc->flags))
 812                 return -EINVAL;
 813
 814         spin_lock(&proc->asts_spin);
 815         if (list_empty(&proc->asts)) {
 816                 if (file->f_flags & O_NONBLOCK) {
 817                         spin_unlock(&proc->asts_spin);
 818                         return -EAGAIN;
 819                 }
 820
 821                 add_wait_queue(&proc->wait, &wait);
 822
 823         repeat:
 824                 set_current_state(TASK_INTERRUPTIBLE);
 825                 if (list_empty(&proc->asts) && !signal_pending(current)) {
 826                         spin_unlock(&proc->asts_spin);
 827                         schedule();
 828                         spin_lock(&proc->asts_spin);
 829                         goto repeat;
 830                 }
 831                 set_current_state(TASK_RUNNING);
 832                 remove_wait_queue(&proc->wait, &wait);
 833
 834                 if (signal_pending(current)) {
 835                         spin_unlock(&proc->asts_spin);
 836                         return -ERESTARTSYS;
 837                 }
 838         }
 839
 840         /* if we empty lkb_callbacks, we don't want to unlock the spinlock
 841            without removing lkb_cb_list; so empty lkb_cb_list is always
 842            consistent with empty lkb_callbacks */
 843
 844         lkb = list_entry(proc->asts.next, struct dlm_lkb, lkb_cb_list);
 845
 846         /* rem_lkb_callback sets a new lkb_last_cast */
 847         old_mode = lkb->lkb_last_cast.mode;
 848
 849         rv = dlm_rem_lkb_callback(lkb->lkb_resource->res_ls, lkb, &cb, &resid);
 850         if (rv < 0) {
 851                 /* this shouldn't happen; lkb should have been removed from
 852                    list when resid was zero */
 853                 log_print("dlm_rem_lkb_callback empty %x", lkb->lkb_id);
 854                 list_del_init(&lkb->lkb_cb_list);
 855                 spin_unlock(&proc->asts_spin);
 856                 /* removes ref for proc->asts, may cause lkb to be freed */
 857                 dlm_put_lkb(lkb);
 858                 goto try_another;
 859         }
 860         if (!resid)
 861                 list_del_init(&lkb->lkb_cb_list);
 862         spin_unlock(&proc->asts_spin);
 863
 864         if (cb.flags & DLM_CB_SKIP) {
 865                 /* removes ref for proc->asts, may cause lkb to be freed */
 866                 if (!resid)
 867                         dlm_put_lkb(lkb);
 868                 goto try_another;
 869         }
 870
 871         if (cb.flags & DLM_CB_CAST) {
 872                 new_mode = cb.mode;
 873
 874                 if (!cb.sb_status && lkb->lkb_lksb->sb_lvbptr &&
 875                     dlm_lvb_operations[old_mode + 1][new_mode + 1])
 876                         copy_lvb = 1;
 877
 878                 lkb->lkb_lksb->sb_status = cb.sb_status;
 879                 lkb->lkb_lksb->sb_flags = cb.sb_flags;
 880         }
 881
 882         rv = copy_result_to_user(lkb->lkb_ua,
 883                                  test_bit(DLM_PROC_FLAGS_COMPAT, &proc->flags),
 884                                  cb.flags, cb.mode, copy_lvb, buf, count);
 885
 886         /* removes ref for proc->asts, may cause lkb to be freed */
 887         if (!resid)
 888                 dlm_put_lkb(lkb);
 889
 890         return rv;
 891 }
 892
 893 static unsigned int device_poll(struct file *file, poll_table *wait)
 894 {
 895         struct dlm_user_proc *proc = file->private_data;
 896
 897         poll_wait(file, &proc->wait, wait);
 898
 899         spin_lock(&proc->asts_spin);
 900         if (!list_empty(&proc->asts)) {
 901                 spin_unlock(&proc->asts_spin);
 902                 return POLLIN | POLLRDNORM;
 903         }
 904         spin_unlock(&proc->asts_spin);
 905         return 0;
 906 }
 907
 908 int dlm_user_daemon_available(void)
 909 {
 910         /* dlm_controld hasn't started (or, has started, but not
 911            properly populated configfs) */
 912
 913         if (!dlm_our_nodeid())
 914                 return 0;
 915
 916         /* This is to deal with versions of dlm_controld that don't
 917            know about the monitor device.  We assume that if the
 918            dlm_controld was started (above), but the monitor device
 919            was never opened, that it's an old version.  dlm_controld
 920            should open the monitor device before populating configfs. */
 921
 922         if (dlm_monitor_unused)
 923                 return 1;
 924
 925         return atomic_read(&dlm_monitor_opened) ? 1 : 0;
 926 }
 927
 928 static int ctl_device_open(struct inode *inode, struct file *file)
 929 {
 930         file->private_data = NULL;
 931         return 0;
 932 }
 933
 934 static int ctl_device_close(struct inode *inode, struct file *file)
 935 {
 936         return 0;
 937 }
 938
 939 static int monitor_device_open(struct inode *inode, struct file *file)
 940 {
 941         atomic_inc(&dlm_monitor_opened);
 942         dlm_monitor_unused = 0;
 943         return 0;
 944 }
 945
 946 static int monitor_device_close(struct inode *inode, struct file *file)
 947 {
 948         if (atomic_dec_and_test(&dlm_monitor_opened))
 949                 dlm_stop_lockspaces();
 950         return 0;
 951 }
 952
 953 static const struct file_operations device_fops = {
 954         .open    = device_open,
 955         .release = device_close,
 956         .read    = device_read,
 957         .write   = device_write,
 958         .poll    = device_poll,
 959         .owner   = THIS_MODULE,
 960         .llseek  = noop_llseek,
 961 };
 962
 963 static const struct file_operations ctl_device_fops = {
 964         .open    = ctl_device_open,
 965         .release = ctl_device_close,
 966         .read    = device_read,
 967         .write   = device_write,
 968         .owner   = THIS_MODULE,
 969         .llseek  = noop_llseek,
 970 };
 971
 972 static struct miscdevice ctl_device = {
 973         .name  = "dlm-control",
 974         .fops  = &ctl_device_fops,
 975         .minor = MISC_DYNAMIC_MINOR,
 976 };
 977
 978 static const struct file_operations monitor_device_fops = {
 979         .open    = monitor_device_open,
 980         .release = monitor_device_close,
 981         .owner   = THIS_MODULE,
 982         .llseek  = noop_llseek,
 983 };
 984
 985 static struct miscdevice monitor_device = {
 986         .name  = "dlm-monitor",
 987         .fops  = &monitor_device_fops,
 988         .minor = MISC_DYNAMIC_MINOR,
 989 };
 990
 991 int __init dlm_user_init(void)
 992 {
 993         int error;
 994
 995         atomic_set(&dlm_monitor_opened, 0);
 996
 997         error = misc_register(&ctl_device);
 998         if (error) {
 999                 log_print("misc_register failed for control device");
1000                 goto out;
1001         }
1002
1003         error = misc_register(&monitor_device);
1004         if (error) {
1005                 log_print("misc_register failed for monitor device");
1006                 misc_deregister(&ctl_device);
1007         }
1008  out:
1009         return error;
1010 }
1011
1012 void dlm_user_exit(void)
1013 {
1014         misc_deregister(&ctl_device);
1015         misc_deregister(&monitor_device);
1016 }
1017