1 // SPDX-License-Identifier: GPL-2.0
3 * linux/fs/lockd/svc4proc.c
5 * Lockd server procedures. We don't implement the NLM_*_RES
6 * procedures because we don't use the async procedures.
8 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
11 #include <linux/types.h>
12 #include <linux/time.h>
13 #include <linux/lockd/lockd.h>
14 #include <linux/lockd/share.h>
15 #include <linux/sunrpc/svc_xprt.h>
17 #define NLMDBG_FACILITY NLMDBG_CLIENT
20 * Obtain client and file from arguments
23 nlm4svc_retrieve_args(struct svc_rqst *rqstp, struct nlm_args *argp,
24 struct nlm_host **hostp, struct nlm_file **filp)
26 struct nlm_host *host = NULL;
27 struct nlm_file *file = NULL;
28 struct nlm_lock *lock = &argp->lock;
31 /* nfsd callbacks must have been installed for this procedure */
33 return nlm_lck_denied_nolocks;
35 /* Obtain host handle */
36 if (!(host = nlmsvc_lookup_host(rqstp, lock->caller, lock->len))
37 || (argp->monitor && nsm_monitor(host) < 0))
41 /* Obtain file pointer. Not used by FREE_ALL call. */
43 int mode = lock_to_openmode(&lock->fl);
45 error = nlm_lookup_file(rqstp, &file, lock);
50 /* Set up the missing parts of the file_lock structure */
51 lock->fl.fl_file = file->f_file[mode];
52 lock->fl.fl_pid = current->tgid;
53 lock->fl.fl_lmops = &nlmsvc_lock_operations;
54 nlmsvc_locks_init_private(&lock->fl, host, (pid_t)lock->svid);
55 if (!lock->fl.fl_owner) {
56 /* lockowner allocation has failed */
57 nlmsvc_release_host(host);
58 return nlm_lck_denied_nolocks;
65 nlmsvc_release_host(host);
68 return nlm_lck_denied_nolocks;
72 * NULL: Test for presence of service
75 nlm4svc_proc_null(struct svc_rqst *rqstp)
77 dprintk("lockd: NULL called\n");
82 * TEST: Check for conflicting lock
85 __nlm4svc_proc_test(struct svc_rqst *rqstp, struct nlm_res *resp)
87 struct nlm_args *argp = rqstp->rq_argp;
88 struct nlm_host *host;
89 struct nlm_file *file;
90 __be32 rc = rpc_success;
92 dprintk("lockd: TEST4 called\n");
93 resp->cookie = argp->cookie;
95 /* Obtain client and file */
96 if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
97 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
99 /* Now check for conflicting locks */
100 resp->status = nlmsvc_testlock(rqstp, file, host, &argp->lock, &resp->lock, &resp->cookie);
101 if (resp->status == nlm_drop_reply)
104 dprintk("lockd: TEST4 status %d\n", ntohl(resp->status));
106 nlmsvc_release_lockowner(&argp->lock);
107 nlmsvc_release_host(host);
108 nlm_release_file(file);
113 nlm4svc_proc_test(struct svc_rqst *rqstp)
115 return __nlm4svc_proc_test(rqstp, rqstp->rq_resp);
119 __nlm4svc_proc_lock(struct svc_rqst *rqstp, struct nlm_res *resp)
121 struct nlm_args *argp = rqstp->rq_argp;
122 struct nlm_host *host;
123 struct nlm_file *file;
124 __be32 rc = rpc_success;
126 dprintk("lockd: LOCK called\n");
128 resp->cookie = argp->cookie;
130 /* Obtain client and file */
131 if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
132 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
135 /* If supplied state doesn't match current state, we assume it's
136 * an old request that time-warped somehow. Any error return would
137 * do in this case because it's irrelevant anyway.
139 * NB: We don't retrieve the remote host's state yet.
141 if (host->h_nsmstate && host->h_nsmstate != argp->state) {
142 resp->status = nlm_lck_denied_nolocks;
146 /* Now try to lock the file */
147 resp->status = nlmsvc_lock(rqstp, file, host, &argp->lock,
148 argp->block, &argp->cookie,
150 if (resp->status == nlm_drop_reply)
153 dprintk("lockd: LOCK status %d\n", ntohl(resp->status));
155 nlmsvc_release_lockowner(&argp->lock);
156 nlmsvc_release_host(host);
157 nlm_release_file(file);
162 nlm4svc_proc_lock(struct svc_rqst *rqstp)
164 return __nlm4svc_proc_lock(rqstp, rqstp->rq_resp);
168 __nlm4svc_proc_cancel(struct svc_rqst *rqstp, struct nlm_res *resp)
170 struct nlm_args *argp = rqstp->rq_argp;
171 struct nlm_host *host;
172 struct nlm_file *file;
174 dprintk("lockd: CANCEL called\n");
176 resp->cookie = argp->cookie;
178 /* Don't accept requests during grace period */
179 if (locks_in_grace(SVC_NET(rqstp))) {
180 resp->status = nlm_lck_denied_grace_period;
184 /* Obtain client and file */
185 if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
186 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
188 /* Try to cancel request. */
189 resp->status = nlmsvc_cancel_blocked(SVC_NET(rqstp), file, &argp->lock);
191 dprintk("lockd: CANCEL status %d\n", ntohl(resp->status));
192 nlmsvc_release_lockowner(&argp->lock);
193 nlmsvc_release_host(host);
194 nlm_release_file(file);
199 nlm4svc_proc_cancel(struct svc_rqst *rqstp)
201 return __nlm4svc_proc_cancel(rqstp, rqstp->rq_resp);
205 * UNLOCK: release a lock
208 __nlm4svc_proc_unlock(struct svc_rqst *rqstp, struct nlm_res *resp)
210 struct nlm_args *argp = rqstp->rq_argp;
211 struct nlm_host *host;
212 struct nlm_file *file;
214 dprintk("lockd: UNLOCK called\n");
216 resp->cookie = argp->cookie;
218 /* Don't accept new lock requests during grace period */
219 if (locks_in_grace(SVC_NET(rqstp))) {
220 resp->status = nlm_lck_denied_grace_period;
224 /* Obtain client and file */
225 if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
226 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
228 /* Now try to remove the lock */
229 resp->status = nlmsvc_unlock(SVC_NET(rqstp), file, &argp->lock);
231 dprintk("lockd: UNLOCK status %d\n", ntohl(resp->status));
232 nlmsvc_release_lockowner(&argp->lock);
233 nlmsvc_release_host(host);
234 nlm_release_file(file);
239 nlm4svc_proc_unlock(struct svc_rqst *rqstp)
241 return __nlm4svc_proc_unlock(rqstp, rqstp->rq_resp);
245 * GRANTED: A server calls us to tell that a process' lock request
249 __nlm4svc_proc_granted(struct svc_rqst *rqstp, struct nlm_res *resp)
251 struct nlm_args *argp = rqstp->rq_argp;
253 resp->cookie = argp->cookie;
255 dprintk("lockd: GRANTED called\n");
256 resp->status = nlmclnt_grant(svc_addr(rqstp), &argp->lock);
257 dprintk("lockd: GRANTED status %d\n", ntohl(resp->status));
262 nlm4svc_proc_granted(struct svc_rqst *rqstp)
264 return __nlm4svc_proc_granted(rqstp, rqstp->rq_resp);
268 * This is the generic lockd callback for async RPC calls
270 static void nlm4svc_callback_exit(struct rpc_task *task, void *data)
274 static void nlm4svc_callback_release(void *data)
276 nlmsvc_release_call(data);
279 static const struct rpc_call_ops nlm4svc_callback_ops = {
280 .rpc_call_done = nlm4svc_callback_exit,
281 .rpc_release = nlm4svc_callback_release,
285 * `Async' versions of the above service routines. They aren't really,
286 * because we send the callback before the reply proper. I hope this
287 * doesn't break any clients.
289 static __be32 nlm4svc_callback(struct svc_rqst *rqstp, u32 proc,
290 __be32 (*func)(struct svc_rqst *, struct nlm_res *))
292 struct nlm_args *argp = rqstp->rq_argp;
293 struct nlm_host *host;
294 struct nlm_rqst *call;
297 host = nlmsvc_lookup_host(rqstp,
301 return rpc_system_err;
303 call = nlm_alloc_call(host);
304 nlmsvc_release_host(host);
306 return rpc_system_err;
308 stat = func(rqstp, &call->a_res);
310 nlmsvc_release_call(call);
314 call->a_flags = RPC_TASK_ASYNC;
315 if (nlm_async_reply(call, proc, &nlm4svc_callback_ops) < 0)
316 return rpc_system_err;
320 static __be32 nlm4svc_proc_test_msg(struct svc_rqst *rqstp)
322 dprintk("lockd: TEST_MSG called\n");
323 return nlm4svc_callback(rqstp, NLMPROC_TEST_RES, __nlm4svc_proc_test);
326 static __be32 nlm4svc_proc_lock_msg(struct svc_rqst *rqstp)
328 dprintk("lockd: LOCK_MSG called\n");
329 return nlm4svc_callback(rqstp, NLMPROC_LOCK_RES, __nlm4svc_proc_lock);
332 static __be32 nlm4svc_proc_cancel_msg(struct svc_rqst *rqstp)
334 dprintk("lockd: CANCEL_MSG called\n");
335 return nlm4svc_callback(rqstp, NLMPROC_CANCEL_RES, __nlm4svc_proc_cancel);
338 static __be32 nlm4svc_proc_unlock_msg(struct svc_rqst *rqstp)
340 dprintk("lockd: UNLOCK_MSG called\n");
341 return nlm4svc_callback(rqstp, NLMPROC_UNLOCK_RES, __nlm4svc_proc_unlock);
344 static __be32 nlm4svc_proc_granted_msg(struct svc_rqst *rqstp)
346 dprintk("lockd: GRANTED_MSG called\n");
347 return nlm4svc_callback(rqstp, NLMPROC_GRANTED_RES, __nlm4svc_proc_granted);
351 * SHARE: create a DOS share or alter existing share.
354 nlm4svc_proc_share(struct svc_rqst *rqstp)
356 struct nlm_args *argp = rqstp->rq_argp;
357 struct nlm_res *resp = rqstp->rq_resp;
358 struct nlm_host *host;
359 struct nlm_file *file;
361 dprintk("lockd: SHARE called\n");
363 resp->cookie = argp->cookie;
365 /* Don't accept new lock requests during grace period */
366 if (locks_in_grace(SVC_NET(rqstp)) && !argp->reclaim) {
367 resp->status = nlm_lck_denied_grace_period;
371 /* Obtain client and file */
372 if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
373 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
375 /* Now try to create the share */
376 resp->status = nlmsvc_share_file(host, file, argp);
378 dprintk("lockd: SHARE status %d\n", ntohl(resp->status));
379 nlmsvc_release_lockowner(&argp->lock);
380 nlmsvc_release_host(host);
381 nlm_release_file(file);
386 * UNSHARE: Release a DOS share.
389 nlm4svc_proc_unshare(struct svc_rqst *rqstp)
391 struct nlm_args *argp = rqstp->rq_argp;
392 struct nlm_res *resp = rqstp->rq_resp;
393 struct nlm_host *host;
394 struct nlm_file *file;
396 dprintk("lockd: UNSHARE called\n");
398 resp->cookie = argp->cookie;
400 /* Don't accept requests during grace period */
401 if (locks_in_grace(SVC_NET(rqstp))) {
402 resp->status = nlm_lck_denied_grace_period;
406 /* Obtain client and file */
407 if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
408 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
410 /* Now try to lock the file */
411 resp->status = nlmsvc_unshare_file(host, file, argp);
413 dprintk("lockd: UNSHARE status %d\n", ntohl(resp->status));
414 nlmsvc_release_lockowner(&argp->lock);
415 nlmsvc_release_host(host);
416 nlm_release_file(file);
421 * NM_LOCK: Create an unmonitored lock
424 nlm4svc_proc_nm_lock(struct svc_rqst *rqstp)
426 struct nlm_args *argp = rqstp->rq_argp;
428 dprintk("lockd: NM_LOCK called\n");
430 argp->monitor = 0; /* just clean the monitor flag */
431 return nlm4svc_proc_lock(rqstp);
435 * FREE_ALL: Release all locks and shares held by client
438 nlm4svc_proc_free_all(struct svc_rqst *rqstp)
440 struct nlm_args *argp = rqstp->rq_argp;
441 struct nlm_host *host;
444 if (nlm4svc_retrieve_args(rqstp, argp, &host, NULL))
447 nlmsvc_free_host_resources(host);
448 nlmsvc_release_host(host);
453 * SM_NOTIFY: private callback from statd (not part of official NLM proto)
456 nlm4svc_proc_sm_notify(struct svc_rqst *rqstp)
458 struct nlm_reboot *argp = rqstp->rq_argp;
460 dprintk("lockd: SM_NOTIFY called\n");
462 if (!nlm_privileged_requester(rqstp)) {
463 char buf[RPC_MAX_ADDRBUFLEN];
464 printk(KERN_WARNING "lockd: rejected NSM callback from %s\n",
465 svc_print_addr(rqstp, buf, sizeof(buf)));
466 return rpc_system_err;
469 nlm_host_rebooted(SVC_NET(rqstp), argp);
474 * client sent a GRANTED_RES, let's remove the associated block
477 nlm4svc_proc_granted_res(struct svc_rqst *rqstp)
479 struct nlm_res *argp = rqstp->rq_argp;
484 dprintk("lockd: GRANTED_RES called\n");
486 nlmsvc_grant_reply(&argp->cookie, argp->status);
491 nlm4svc_proc_unused(struct svc_rqst *rqstp)
493 return rpc_proc_unavail;
498 * NLM Server procedures.
501 struct nlm_void { int dummy; };
503 #define Ck (1+XDR_QUADLEN(NLM_MAXCOOKIELEN)) /* cookie */
504 #define No (1+1024/4) /* netobj */
505 #define St 1 /* status */
506 #define Rg 4 /* range (offset + length) */
508 const struct svc_procedure nlmsvc_procedures4[24] = {
510 .pc_func = nlm4svc_proc_null,
511 .pc_decode = nlm4svc_decode_void,
512 .pc_encode = nlm4svc_encode_void,
513 .pc_argsize = sizeof(struct nlm_void),
514 .pc_ressize = sizeof(struct nlm_void),
519 .pc_func = nlm4svc_proc_test,
520 .pc_decode = nlm4svc_decode_testargs,
521 .pc_encode = nlm4svc_encode_testres,
522 .pc_argsize = sizeof(struct nlm_args),
523 .pc_ressize = sizeof(struct nlm_res),
524 .pc_xdrressize = Ck+St+2+No+Rg,
528 .pc_func = nlm4svc_proc_lock,
529 .pc_decode = nlm4svc_decode_lockargs,
530 .pc_encode = nlm4svc_encode_res,
531 .pc_argsize = sizeof(struct nlm_args),
532 .pc_ressize = sizeof(struct nlm_res),
533 .pc_xdrressize = Ck+St,
537 .pc_func = nlm4svc_proc_cancel,
538 .pc_decode = nlm4svc_decode_cancargs,
539 .pc_encode = nlm4svc_encode_res,
540 .pc_argsize = sizeof(struct nlm_args),
541 .pc_ressize = sizeof(struct nlm_res),
542 .pc_xdrressize = Ck+St,
546 .pc_func = nlm4svc_proc_unlock,
547 .pc_decode = nlm4svc_decode_unlockargs,
548 .pc_encode = nlm4svc_encode_res,
549 .pc_argsize = sizeof(struct nlm_args),
550 .pc_ressize = sizeof(struct nlm_res),
551 .pc_xdrressize = Ck+St,
554 [NLMPROC_GRANTED] = {
555 .pc_func = nlm4svc_proc_granted,
556 .pc_decode = nlm4svc_decode_testargs,
557 .pc_encode = nlm4svc_encode_res,
558 .pc_argsize = sizeof(struct nlm_args),
559 .pc_ressize = sizeof(struct nlm_res),
560 .pc_xdrressize = Ck+St,
561 .pc_name = "GRANTED",
563 [NLMPROC_TEST_MSG] = {
564 .pc_func = nlm4svc_proc_test_msg,
565 .pc_decode = nlm4svc_decode_testargs,
566 .pc_encode = nlm4svc_encode_void,
567 .pc_argsize = sizeof(struct nlm_args),
568 .pc_ressize = sizeof(struct nlm_void),
570 .pc_name = "TEST_MSG",
572 [NLMPROC_LOCK_MSG] = {
573 .pc_func = nlm4svc_proc_lock_msg,
574 .pc_decode = nlm4svc_decode_lockargs,
575 .pc_encode = nlm4svc_encode_void,
576 .pc_argsize = sizeof(struct nlm_args),
577 .pc_ressize = sizeof(struct nlm_void),
579 .pc_name = "LOCK_MSG",
581 [NLMPROC_CANCEL_MSG] = {
582 .pc_func = nlm4svc_proc_cancel_msg,
583 .pc_decode = nlm4svc_decode_cancargs,
584 .pc_encode = nlm4svc_encode_void,
585 .pc_argsize = sizeof(struct nlm_args),
586 .pc_ressize = sizeof(struct nlm_void),
588 .pc_name = "CANCEL_MSG",
590 [NLMPROC_UNLOCK_MSG] = {
591 .pc_func = nlm4svc_proc_unlock_msg,
592 .pc_decode = nlm4svc_decode_unlockargs,
593 .pc_encode = nlm4svc_encode_void,
594 .pc_argsize = sizeof(struct nlm_args),
595 .pc_ressize = sizeof(struct nlm_void),
597 .pc_name = "UNLOCK_MSG",
599 [NLMPROC_GRANTED_MSG] = {
600 .pc_func = nlm4svc_proc_granted_msg,
601 .pc_decode = nlm4svc_decode_testargs,
602 .pc_encode = nlm4svc_encode_void,
603 .pc_argsize = sizeof(struct nlm_args),
604 .pc_ressize = sizeof(struct nlm_void),
606 .pc_name = "GRANTED_MSG",
608 [NLMPROC_TEST_RES] = {
609 .pc_func = nlm4svc_proc_null,
610 .pc_decode = nlm4svc_decode_void,
611 .pc_encode = nlm4svc_encode_void,
612 .pc_argsize = sizeof(struct nlm_res),
613 .pc_ressize = sizeof(struct nlm_void),
615 .pc_name = "TEST_RES",
617 [NLMPROC_LOCK_RES] = {
618 .pc_func = nlm4svc_proc_null,
619 .pc_decode = nlm4svc_decode_void,
620 .pc_encode = nlm4svc_encode_void,
621 .pc_argsize = sizeof(struct nlm_res),
622 .pc_ressize = sizeof(struct nlm_void),
624 .pc_name = "LOCK_RES",
626 [NLMPROC_CANCEL_RES] = {
627 .pc_func = nlm4svc_proc_null,
628 .pc_decode = nlm4svc_decode_void,
629 .pc_encode = nlm4svc_encode_void,
630 .pc_argsize = sizeof(struct nlm_res),
631 .pc_ressize = sizeof(struct nlm_void),
633 .pc_name = "CANCEL_RES",
635 [NLMPROC_UNLOCK_RES] = {
636 .pc_func = nlm4svc_proc_null,
637 .pc_decode = nlm4svc_decode_void,
638 .pc_encode = nlm4svc_encode_void,
639 .pc_argsize = sizeof(struct nlm_res),
640 .pc_ressize = sizeof(struct nlm_void),
642 .pc_name = "UNLOCK_RES",
644 [NLMPROC_GRANTED_RES] = {
645 .pc_func = nlm4svc_proc_granted_res,
646 .pc_decode = nlm4svc_decode_res,
647 .pc_encode = nlm4svc_encode_void,
648 .pc_argsize = sizeof(struct nlm_res),
649 .pc_ressize = sizeof(struct nlm_void),
651 .pc_name = "GRANTED_RES",
653 [NLMPROC_NSM_NOTIFY] = {
654 .pc_func = nlm4svc_proc_sm_notify,
655 .pc_decode = nlm4svc_decode_reboot,
656 .pc_encode = nlm4svc_encode_void,
657 .pc_argsize = sizeof(struct nlm_reboot),
658 .pc_ressize = sizeof(struct nlm_void),
660 .pc_name = "SM_NOTIFY",
663 .pc_func = nlm4svc_proc_unused,
664 .pc_decode = nlm4svc_decode_void,
665 .pc_encode = nlm4svc_encode_void,
666 .pc_argsize = sizeof(struct nlm_void),
667 .pc_ressize = sizeof(struct nlm_void),
672 .pc_func = nlm4svc_proc_unused,
673 .pc_decode = nlm4svc_decode_void,
674 .pc_encode = nlm4svc_encode_void,
675 .pc_argsize = sizeof(struct nlm_void),
676 .pc_ressize = sizeof(struct nlm_void),
681 .pc_func = nlm4svc_proc_unused,
682 .pc_decode = nlm4svc_decode_void,
683 .pc_encode = nlm4svc_encode_void,
684 .pc_argsize = sizeof(struct nlm_void),
685 .pc_ressize = sizeof(struct nlm_void),
690 .pc_func = nlm4svc_proc_share,
691 .pc_decode = nlm4svc_decode_shareargs,
692 .pc_encode = nlm4svc_encode_shareres,
693 .pc_argsize = sizeof(struct nlm_args),
694 .pc_ressize = sizeof(struct nlm_res),
695 .pc_xdrressize = Ck+St+1,
698 [NLMPROC_UNSHARE] = {
699 .pc_func = nlm4svc_proc_unshare,
700 .pc_decode = nlm4svc_decode_shareargs,
701 .pc_encode = nlm4svc_encode_shareres,
702 .pc_argsize = sizeof(struct nlm_args),
703 .pc_ressize = sizeof(struct nlm_res),
704 .pc_xdrressize = Ck+St+1,
705 .pc_name = "UNSHARE",
707 [NLMPROC_NM_LOCK] = {
708 .pc_func = nlm4svc_proc_nm_lock,
709 .pc_decode = nlm4svc_decode_lockargs,
710 .pc_encode = nlm4svc_encode_res,
711 .pc_argsize = sizeof(struct nlm_args),
712 .pc_ressize = sizeof(struct nlm_res),
713 .pc_xdrressize = Ck+St,
714 .pc_name = "NM_LOCK",
716 [NLMPROC_FREE_ALL] = {
717 .pc_func = nlm4svc_proc_free_all,
718 .pc_decode = nlm4svc_decode_notify,
719 .pc_encode = nlm4svc_encode_void,
720 .pc_argsize = sizeof(struct nlm_args),
721 .pc_ressize = sizeof(struct nlm_void),
723 .pc_name = "FREE_ALL",