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