fs/lockd/svcproc.c

   1 /*
   2  * linux/fs/lockd/svcproc.c
   3  *
   4  * Lockd server procedures. We don't implement the NLM_*_RES
   5  * procedures because we don't use the async procedures.
   6  *
   7  * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
   8  */
   9
  10 #include <linux/types.h>
  11 #include <linux/time.h>
  12 #include <linux/slab.h>
  13 #include <linux/in.h>
  14 #include <linux/sunrpc/svc.h>
  15 #include <linux/sunrpc/clnt.h>
  16 #include <linux/nfsd/nfsd.h>
  17 #include <linux/lockd/lockd.h>
  18 #include <linux/lockd/share.h>
  19 #include <linux/lockd/sm_inter.h>
  20
  21
  22 #define NLMDBG_FACILITY         NLMDBG_CLIENT
  23
  24 #ifdef CONFIG_LOCKD_V4
  25 static __be32
  26 cast_to_nlm(__be32 status, u32 vers)
  27 {
  28         /* Note: status is assumed to be in network byte order !!! */
  29         if (vers != 4){
  30                 switch (status) {
  31                 case nlm_granted:
  32                 case nlm_lck_denied:
  33                 case nlm_lck_denied_nolocks:
  34                 case nlm_lck_blocked:
  35                 case nlm_lck_denied_grace_period:
  36                 case nlm_drop_reply:
  37                         break;
  38                 case nlm4_deadlock:
  39                         status = nlm_lck_denied;
  40                         break;
  41                 default:
  42                         status = nlm_lck_denied_nolocks;
  43                 }
  44         }
  45
  46         return (status);
  47 }
  48 #define cast_status(status) (cast_to_nlm(status, rqstp->rq_vers))
  49 #else
  50 #define cast_status(status) (status)
  51 #endif
  52
  53 /*
  54  * Obtain client and file from arguments
  55  */
  56 static __be32
  57 nlmsvc_retrieve_args(struct svc_rqst *rqstp, struct nlm_args *argp,
  58                         struct nlm_host **hostp, struct nlm_file **filp)
  59 {
  60         struct nlm_host         *host = NULL;
  61         struct nlm_file         *file = NULL;
  62         struct nlm_lock         *lock = &argp->lock;
  63         __be32                  error = 0;
  64
  65         /* nfsd callbacks must have been installed for this procedure */
  66         if (!nlmsvc_ops)
  67                 return nlm_lck_denied_nolocks;
  68
  69         /* Obtain host handle */
  70         if (!(host = nlmsvc_lookup_host(rqstp, lock->caller, lock->len))
  71          || (argp->monitor && nsm_monitor(host) < 0))
  72                 goto no_locks;
  73         *hostp = host;
  74
  75         /* Obtain file pointer. Not used by FREE_ALL call. */
  76         if (filp != NULL) {
  77                 if ((error = nlm_lookup_file(rqstp, &file, &lock->fh)) != 0)
  78                         goto no_locks;
  79                 *filp = file;
  80
  81                 /* Set up the missing parts of the file_lock structure */
  82                 lock->fl.fl_file  = file->f_file;
  83                 lock->fl.fl_owner = (fl_owner_t) host;
  84                 lock->fl.fl_lmops = &nlmsvc_lock_operations;
  85         }
  86
  87         return 0;
  88
  89 no_locks:
  90         if (host)
  91                 nlm_release_host(host);
  92         if (error)
  93                 return error;
  94         return nlm_lck_denied_nolocks;
  95 }
  96
  97 /*
  98  * NULL: Test for presence of service
  99  */
 100 static __be32
 101 nlmsvc_proc_null(struct svc_rqst *rqstp, void *argp, void *resp)
 102 {
 103         dprintk("lockd: NULL          called\n");
 104         return rpc_success;
 105 }
 106
 107 /*
 108  * TEST: Check for conflicting lock
 109  */
 110 static __be32
 111 nlmsvc_proc_test(struct svc_rqst *rqstp, struct nlm_args *argp,
 112                                          struct nlm_res  *resp)
 113 {
 114         struct nlm_host *host;
 115         struct nlm_file *file;
 116         int rc = rpc_success;
 117
 118         dprintk("lockd: TEST          called\n");
 119         resp->cookie = argp->cookie;
 120
 121         /* Don't accept test requests during grace period */
 122         if (nlmsvc_grace_period) {
 123                 resp->status = nlm_lck_denied_grace_period;
 124                 return rc;
 125         }
 126
 127         /* Obtain client and file */
 128         if ((resp->status = nlmsvc_retrieve_args(rqstp, argp, &host, &file)))
 129                 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
 130
 131         /* Now check for conflicting locks */
 132         resp->status = cast_status(nlmsvc_testlock(rqstp, file, &argp->lock, &resp->lock, &resp->cookie));
 133         if (resp->status == nlm_drop_reply)
 134                 rc = rpc_drop_reply;
 135         else
 136                 dprintk("lockd: TEST          status %d vers %d\n",
 137                         ntohl(resp->status), rqstp->rq_vers);
 138
 139         nlm_release_host(host);
 140         nlm_release_file(file);
 141         return rc;
 142 }
 143
 144 static __be32
 145 nlmsvc_proc_lock(struct svc_rqst *rqstp, struct nlm_args *argp,
 146                                          struct nlm_res  *resp)
 147 {
 148         struct nlm_host *host;
 149         struct nlm_file *file;
 150         int rc = rpc_success;
 151
 152         dprintk("lockd: LOCK          called\n");
 153
 154         resp->cookie = argp->cookie;
 155
 156         /* Don't accept new lock requests during grace period */
 157         if (nlmsvc_grace_period && !argp->reclaim) {
 158                 resp->status = nlm_lck_denied_grace_period;
 159                 return rc;
 160         }
 161
 162         /* Obtain client and file */
 163         if ((resp->status = nlmsvc_retrieve_args(rqstp, argp, &host, &file)))
 164                 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
 165
 166 #if 0
 167         /* If supplied state doesn't match current state, we assume it's
 168          * an old request that time-warped somehow. Any error return would
 169          * do in this case because it's irrelevant anyway.
 170          *
 171          * NB: We don't retrieve the remote host's state yet.
 172          */
 173         if (host->h_nsmstate && host->h_nsmstate != argp->state) {
 174                 resp->status = nlm_lck_denied_nolocks;
 175         } else
 176 #endif
 177
 178         /* Now try to lock the file */
 179         resp->status = cast_status(nlmsvc_lock(rqstp, file, &argp->lock,
 180                                                argp->block, &argp->cookie));
 181         if (resp->status == nlm_drop_reply)
 182                 rc = rpc_drop_reply;
 183         else
 184                 dprintk("lockd: LOCK         status %d\n", ntohl(resp->status));
 185
 186         nlm_release_host(host);
 187         nlm_release_file(file);
 188         return rc;
 189 }
 190
 191 static __be32
 192 nlmsvc_proc_cancel(struct svc_rqst *rqstp, struct nlm_args *argp,
 193                                            struct nlm_res  *resp)
 194 {
 195         struct nlm_host *host;
 196         struct nlm_file *file;
 197
 198         dprintk("lockd: CANCEL        called\n");
 199
 200         resp->cookie = argp->cookie;
 201
 202         /* Don't accept requests during grace period */
 203         if (nlmsvc_grace_period) {
 204                 resp->status = nlm_lck_denied_grace_period;
 205                 return rpc_success;
 206         }
 207
 208         /* Obtain client and file */
 209         if ((resp->status = nlmsvc_retrieve_args(rqstp, argp, &host, &file)))
 210                 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
 211
 212         /* Try to cancel request. */
 213         resp->status = cast_status(nlmsvc_cancel_blocked(file, &argp->lock));
 214
 215         dprintk("lockd: CANCEL        status %d\n", ntohl(resp->status));
 216         nlm_release_host(host);
 217         nlm_release_file(file);
 218         return rpc_success;
 219 }
 220
 221 /*
 222  * UNLOCK: release a lock
 223  */
 224 static __be32
 225 nlmsvc_proc_unlock(struct svc_rqst *rqstp, struct nlm_args *argp,
 226                                            struct nlm_res  *resp)
 227 {
 228         struct nlm_host *host;
 229         struct nlm_file *file;
 230
 231         dprintk("lockd: UNLOCK        called\n");
 232
 233         resp->cookie = argp->cookie;
 234
 235         /* Don't accept new lock requests during grace period */
 236         if (nlmsvc_grace_period) {
 237                 resp->status = nlm_lck_denied_grace_period;
 238                 return rpc_success;
 239         }
 240
 241         /* Obtain client and file */
 242         if ((resp->status = nlmsvc_retrieve_args(rqstp, argp, &host, &file)))
 243                 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
 244
 245         /* Now try to remove the lock */
 246         resp->status = cast_status(nlmsvc_unlock(file, &argp->lock));
 247
 248         dprintk("lockd: UNLOCK        status %d\n", ntohl(resp->status));
 249         nlm_release_host(host);
 250         nlm_release_file(file);
 251         return rpc_success;
 252 }
 253
 254 /*
 255  * GRANTED: A server calls us to tell that a process' lock request
 256  * was granted
 257  */
 258 static __be32
 259 nlmsvc_proc_granted(struct svc_rqst *rqstp, struct nlm_args *argp,
 260                                             struct nlm_res  *resp)
 261 {
 262         resp->cookie = argp->cookie;
 263
 264         dprintk("lockd: GRANTED       called\n");
 265         resp->status = nlmclnt_grant(svc_addr_in(rqstp), &argp->lock);
 266         dprintk("lockd: GRANTED       status %d\n", ntohl(resp->status));
 267         return rpc_success;
 268 }
 269
 270 /*
 271  * This is the generic lockd callback for async RPC calls
 272  */
 273 static void nlmsvc_callback_exit(struct rpc_task *task, void *data)
 274 {
 275         dprintk("lockd: %5u callback returned %d\n", task->tk_pid,
 276                         -task->tk_status);
 277 }
 278
 279 static void nlmsvc_callback_release(void *data)
 280 {
 281         lock_kernel();
 282         nlm_release_call(data);
 283         unlock_kernel();
 284 }
 285
 286 static const struct rpc_call_ops nlmsvc_callback_ops = {
 287         .rpc_call_done = nlmsvc_callback_exit,
 288         .rpc_release = nlmsvc_callback_release,
 289 };
 290
 291 /*
 292  * `Async' versions of the above service routines. They aren't really,
 293  * because we send the callback before the reply proper. I hope this
 294  * doesn't break any clients.
 295  */
 296 static __be32 nlmsvc_callback(struct svc_rqst *rqstp, u32 proc, struct nlm_args *argp,
 297                 __be32 (*func)(struct svc_rqst *, struct nlm_args *, struct nlm_res  *))
 298 {
 299         struct nlm_host *host;
 300         struct nlm_rqst *call;
 301         __be32 stat;
 302
 303         host = nlmsvc_lookup_host(rqstp,
 304                                   argp->lock.caller,
 305                                   argp->lock.len);
 306         if (host == NULL)
 307                 return rpc_system_err;
 308
 309         call = nlm_alloc_call(host);
 310         if (call == NULL)
 311                 return rpc_system_err;
 312
 313         stat = func(rqstp, argp, &call->a_res);
 314         if (stat != 0) {
 315                 nlm_release_call(call);
 316                 return stat;
 317         }
 318
 319         call->a_flags = RPC_TASK_ASYNC;
 320         if (nlm_async_reply(call, proc, &nlmsvc_callback_ops) < 0)
 321                 return rpc_system_err;
 322         return rpc_success;
 323 }
 324
 325 static __be32 nlmsvc_proc_test_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
 326                                              void            *resp)
 327 {
 328         dprintk("lockd: TEST_MSG      called\n");
 329         return nlmsvc_callback(rqstp, NLMPROC_TEST_RES, argp, nlmsvc_proc_test);
 330 }
 331
 332 static __be32 nlmsvc_proc_lock_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
 333                                              void            *resp)
 334 {
 335         dprintk("lockd: LOCK_MSG      called\n");
 336         return nlmsvc_callback(rqstp, NLMPROC_LOCK_RES, argp, nlmsvc_proc_lock);
 337 }
 338
 339 static __be32 nlmsvc_proc_cancel_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
 340                                                void            *resp)
 341 {
 342         dprintk("lockd: CANCEL_MSG    called\n");
 343         return nlmsvc_callback(rqstp, NLMPROC_CANCEL_RES, argp, nlmsvc_proc_cancel);
 344 }
 345
 346 static __be32
 347 nlmsvc_proc_unlock_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
 348                                                void            *resp)
 349 {
 350         dprintk("lockd: UNLOCK_MSG    called\n");
 351         return nlmsvc_callback(rqstp, NLMPROC_UNLOCK_RES, argp, nlmsvc_proc_unlock);
 352 }
 353
 354 static __be32
 355 nlmsvc_proc_granted_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
 356                                                 void            *resp)
 357 {
 358         dprintk("lockd: GRANTED_MSG   called\n");
 359         return nlmsvc_callback(rqstp, NLMPROC_GRANTED_RES, argp, nlmsvc_proc_granted);
 360 }
 361
 362 /*
 363  * SHARE: create a DOS share or alter existing share.
 364  */
 365 static __be32
 366 nlmsvc_proc_share(struct svc_rqst *rqstp, struct nlm_args *argp,
 367                                           struct nlm_res  *resp)
 368 {
 369         struct nlm_host *host;
 370         struct nlm_file *file;
 371
 372         dprintk("lockd: SHARE         called\n");
 373
 374         resp->cookie = argp->cookie;
 375
 376         /* Don't accept new lock requests during grace period */
 377         if (nlmsvc_grace_period && !argp->reclaim) {
 378                 resp->status = nlm_lck_denied_grace_period;
 379                 return rpc_success;
 380         }
 381
 382         /* Obtain client and file */
 383         if ((resp->status = nlmsvc_retrieve_args(rqstp, argp, &host, &file)))
 384                 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
 385
 386         /* Now try to create the share */
 387         resp->status = cast_status(nlmsvc_share_file(host, file, argp));
 388
 389         dprintk("lockd: SHARE         status %d\n", ntohl(resp->status));
 390         nlm_release_host(host);
 391         nlm_release_file(file);
 392         return rpc_success;
 393 }
 394
 395 /*
 396  * UNSHARE: Release a DOS share.
 397  */
 398 static __be32
 399 nlmsvc_proc_unshare(struct svc_rqst *rqstp, struct nlm_args *argp,
 400                                             struct nlm_res  *resp)
 401 {
 402         struct nlm_host *host;
 403         struct nlm_file *file;
 404
 405         dprintk("lockd: UNSHARE       called\n");
 406
 407         resp->cookie = argp->cookie;
 408
 409         /* Don't accept requests during grace period */
 410         if (nlmsvc_grace_period) {
 411                 resp->status = nlm_lck_denied_grace_period;
 412                 return rpc_success;
 413         }
 414
 415         /* Obtain client and file */
 416         if ((resp->status = nlmsvc_retrieve_args(rqstp, argp, &host, &file)))
 417                 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
 418
 419         /* Now try to unshare the file */
 420         resp->status = cast_status(nlmsvc_unshare_file(host, file, argp));
 421
 422         dprintk("lockd: UNSHARE       status %d\n", ntohl(resp->status));
 423         nlm_release_host(host);
 424         nlm_release_file(file);
 425         return rpc_success;
 426 }
 427
 428 /*
 429  * NM_LOCK: Create an unmonitored lock
 430  */
 431 static __be32
 432 nlmsvc_proc_nm_lock(struct svc_rqst *rqstp, struct nlm_args *argp,
 433                                             struct nlm_res  *resp)
 434 {
 435         dprintk("lockd: NM_LOCK       called\n");
 436
 437         argp->monitor = 0;              /* just clean the monitor flag */
 438         return nlmsvc_proc_lock(rqstp, argp, resp);
 439 }
 440
 441 /*
 442  * FREE_ALL: Release all locks and shares held by client
 443  */
 444 static __be32
 445 nlmsvc_proc_free_all(struct svc_rqst *rqstp, struct nlm_args *argp,
 446                                              void            *resp)
 447 {
 448         struct nlm_host *host;
 449
 450         /* Obtain client */
 451         if (nlmsvc_retrieve_args(rqstp, argp, &host, NULL))
 452                 return rpc_success;
 453
 454         nlmsvc_free_host_resources(host);
 455         nlm_release_host(host);
 456         return rpc_success;
 457 }
 458
 459 /*
 460  * SM_NOTIFY: private callback from statd (not part of official NLM proto)
 461  */
 462 static __be32
 463 nlmsvc_proc_sm_notify(struct svc_rqst *rqstp, struct nlm_reboot *argp,
 464                                               void              *resp)
 465 {
 466         struct sockaddr_in      saddr;
 467
 468         memcpy(&saddr, svc_addr_in(rqstp), sizeof(saddr));
 469
 470         dprintk("lockd: SM_NOTIFY     called\n");
 471         if (saddr.sin_addr.s_addr != htonl(INADDR_LOOPBACK)
 472          || ntohs(saddr.sin_port) >= 1024) {
 473                 char buf[RPC_MAX_ADDRBUFLEN];
 474                 printk(KERN_WARNING "lockd: rejected NSM callback from %s\n",
 475                                 svc_print_addr(rqstp, buf, sizeof(buf)));
 476                 return rpc_system_err;
 477         }
 478
 479         /* Obtain the host pointer for this NFS server and try to
 480          * reclaim all locks we hold on this server.
 481          */
 482         memset(&saddr, 0, sizeof(saddr));
 483         saddr.sin_addr.s_addr = argp->addr;
 484         nlm_host_rebooted(&saddr, argp->mon, argp->len, argp->state);
 485
 486         return rpc_success;
 487 }
 488
 489 /*
 490  * client sent a GRANTED_RES, let's remove the associated block
 491  */
 492 static __be32
 493 nlmsvc_proc_granted_res(struct svc_rqst *rqstp, struct nlm_res  *argp,
 494                                                 void            *resp)
 495 {
 496         if (!nlmsvc_ops)
 497                 return rpc_success;
 498
 499         dprintk("lockd: GRANTED_RES   called\n");
 500
 501         nlmsvc_grant_reply(&argp->cookie, argp->status);
 502         return rpc_success;
 503 }
 504
 505 /*
 506  * NLM Server procedures.
 507  */
 508
 509 #define nlmsvc_encode_norep     nlmsvc_encode_void
 510 #define nlmsvc_decode_norep     nlmsvc_decode_void
 511 #define nlmsvc_decode_testres   nlmsvc_decode_void
 512 #define nlmsvc_decode_lockres   nlmsvc_decode_void
 513 #define nlmsvc_decode_unlockres nlmsvc_decode_void
 514 #define nlmsvc_decode_cancelres nlmsvc_decode_void
 515 #define nlmsvc_decode_grantedres        nlmsvc_decode_void
 516
 517 #define nlmsvc_proc_none        nlmsvc_proc_null
 518 #define nlmsvc_proc_test_res    nlmsvc_proc_null
 519 #define nlmsvc_proc_lock_res    nlmsvc_proc_null
 520 #define nlmsvc_proc_cancel_res  nlmsvc_proc_null
 521 #define nlmsvc_proc_unlock_res  nlmsvc_proc_null
 522
 523 struct nlm_void                 { int dummy; };
 524
 525 #define PROC(name, xargt, xrest, argt, rest, respsize)  \
 526  { .pc_func     = (svc_procfunc) nlmsvc_proc_##name,    \
 527    .pc_decode   = (kxdrproc_t) nlmsvc_decode_##xargt,   \
 528    .pc_encode   = (kxdrproc_t) nlmsvc_encode_##xrest,   \
 529    .pc_release  = NULL,                                 \
 530    .pc_argsize  = sizeof(struct nlm_##argt),            \
 531    .pc_ressize  = sizeof(struct nlm_##rest),            \
 532    .pc_xdrressize = respsize,                           \
 533  }
 534
 535 #define Ck      (1+XDR_QUADLEN(NLM_MAXCOOKIELEN))       /* cookie */
 536 #define St      1                               /* status */
 537 #define No      (1+1024/4)                      /* Net Obj */
 538 #define Rg      2                               /* range - offset + size */
 539
 540 struct svc_procedure            nlmsvc_procedures[] = {
 541   PROC(null,            void,           void,           void,   void, 1),
 542   PROC(test,            testargs,       testres,        args,   res, Ck+St+2+No+Rg),
 543   PROC(lock,            lockargs,       res,            args,   res, Ck+St),
 544   PROC(cancel,          cancargs,       res,            args,   res, Ck+St),
 545   PROC(unlock,          unlockargs,     res,            args,   res, Ck+St),
 546   PROC(granted,         testargs,       res,            args,   res, Ck+St),
 547   PROC(test_msg,        testargs,       norep,          args,   void, 1),
 548   PROC(lock_msg,        lockargs,       norep,          args,   void, 1),
 549   PROC(cancel_msg,      cancargs,       norep,          args,   void, 1),
 550   PROC(unlock_msg,      unlockargs,     norep,          args,   void, 1),
 551   PROC(granted_msg,     testargs,       norep,          args,   void, 1),
 552   PROC(test_res,        testres,        norep,          res,    void, 1),
 553   PROC(lock_res,        lockres,        norep,          res,    void, 1),
 554   PROC(cancel_res,      cancelres,      norep,          res,    void, 1),
 555   PROC(unlock_res,      unlockres,      norep,          res,    void, 1),
 556   PROC(granted_res,     res,            norep,          res,    void, 1),
 557   /* statd callback */
 558   PROC(sm_notify,       reboot,         void,           reboot, void, 1),
 559   PROC(none,            void,           void,           void,   void, 1),
 560   PROC(none,            void,           void,           void,   void, 1),
 561   PROC(none,            void,           void,           void,   void, 1),
 562   PROC(share,           shareargs,      shareres,       args,   res, Ck+St+1),
 563   PROC(unshare,         shareargs,      shareres,       args,   res, Ck+St+1),
 564   PROC(nm_lock,         lockargs,       res,            args,   res, Ck+St),
 565   PROC(free_all,        notify,         void,           args,   void, 0),
 566
 567 };