fs/lockd/svc4proc.c

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