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.
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 if ((error = nlm_lookup_file(rqstp, &file, &lock->fh)) != 0)
47 /* Set up the missing parts of the file_lock structure */
48 lock->fl.fl_file = file->f_file;
49 lock->fl.fl_pid = current->tgid;
50 lock->fl.fl_lmops = &nlmsvc_lock_operations;
51 nlmsvc_locks_init_private(&lock->fl, host, (pid_t)lock->svid);
52 if (!lock->fl.fl_owner) {
53 /* lockowner allocation has failed */
54 nlmsvc_release_host(host);
55 return nlm_lck_denied_nolocks;
62 nlmsvc_release_host(host);
65 return nlm_lck_denied_nolocks;
69 * NULL: Test for presence of service
72 nlm4svc_proc_null(struct svc_rqst *rqstp)
74 dprintk("lockd: NULL called\n");
79 * TEST: Check for conflicting lock
82 __nlm4svc_proc_test(struct svc_rqst *rqstp, struct nlm_res *resp)
84 struct nlm_args *argp = rqstp->rq_argp;
85 struct nlm_host *host;
86 struct nlm_file *file;
87 __be32 rc = rpc_success;
89 dprintk("lockd: TEST4 called\n");
90 resp->cookie = argp->cookie;
92 /* Obtain client and file */
93 if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
94 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
96 /* Now check for conflicting locks */
97 resp->status = nlmsvc_testlock(rqstp, file, host, &argp->lock, &resp->lock, &resp->cookie);
98 if (resp->status == nlm_drop_reply)
101 dprintk("lockd: TEST4 status %d\n", ntohl(resp->status));
103 nlmsvc_release_lockowner(&argp->lock);
104 nlmsvc_release_host(host);
105 nlm_release_file(file);
110 nlm4svc_proc_test(struct svc_rqst *rqstp)
112 return __nlm4svc_proc_test(rqstp, rqstp->rq_resp);
116 __nlm4svc_proc_lock(struct svc_rqst *rqstp, struct nlm_res *resp)
118 struct nlm_args *argp = rqstp->rq_argp;
119 struct nlm_host *host;
120 struct nlm_file *file;
121 __be32 rc = rpc_success;
123 dprintk("lockd: LOCK called\n");
125 resp->cookie = argp->cookie;
127 /* Obtain client and file */
128 if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
129 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
132 /* If supplied state doesn't match current state, we assume it's
133 * an old request that time-warped somehow. Any error return would
134 * do in this case because it's irrelevant anyway.
136 * NB: We don't retrieve the remote host's state yet.
138 if (host->h_nsmstate && host->h_nsmstate != argp->state) {
139 resp->status = nlm_lck_denied_nolocks;
143 /* Now try to lock the file */
144 resp->status = nlmsvc_lock(rqstp, file, host, &argp->lock,
145 argp->block, &argp->cookie,
147 if (resp->status == nlm_drop_reply)
150 dprintk("lockd: LOCK status %d\n", ntohl(resp->status));
152 nlmsvc_release_lockowner(&argp->lock);
153 nlmsvc_release_host(host);
154 nlm_release_file(file);
159 nlm4svc_proc_lock(struct svc_rqst *rqstp)
161 return __nlm4svc_proc_lock(rqstp, rqstp->rq_resp);
165 __nlm4svc_proc_cancel(struct svc_rqst *rqstp, struct nlm_res *resp)
167 struct nlm_args *argp = rqstp->rq_argp;
168 struct nlm_host *host;
169 struct nlm_file *file;
171 dprintk("lockd: CANCEL called\n");
173 resp->cookie = argp->cookie;
175 /* Don't accept requests during grace period */
176 if (locks_in_grace(SVC_NET(rqstp))) {
177 resp->status = nlm_lck_denied_grace_period;
181 /* Obtain client and file */
182 if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
183 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
185 /* Try to cancel request. */
186 resp->status = nlmsvc_cancel_blocked(SVC_NET(rqstp), file, &argp->lock);
188 dprintk("lockd: CANCEL status %d\n", ntohl(resp->status));
189 nlmsvc_release_lockowner(&argp->lock);
190 nlmsvc_release_host(host);
191 nlm_release_file(file);
196 nlm4svc_proc_cancel(struct svc_rqst *rqstp)
198 return __nlm4svc_proc_cancel(rqstp, rqstp->rq_resp);
202 * UNLOCK: release a lock
205 __nlm4svc_proc_unlock(struct svc_rqst *rqstp, struct nlm_res *resp)
207 struct nlm_args *argp = rqstp->rq_argp;
208 struct nlm_host *host;
209 struct nlm_file *file;
211 dprintk("lockd: UNLOCK called\n");
213 resp->cookie = argp->cookie;
215 /* Don't accept new lock requests during grace period */
216 if (locks_in_grace(SVC_NET(rqstp))) {
217 resp->status = nlm_lck_denied_grace_period;
221 /* Obtain client and file */
222 if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
223 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
225 /* Now try to remove the lock */
226 resp->status = nlmsvc_unlock(SVC_NET(rqstp), file, &argp->lock);
228 dprintk("lockd: UNLOCK status %d\n", ntohl(resp->status));
229 nlmsvc_release_lockowner(&argp->lock);
230 nlmsvc_release_host(host);
231 nlm_release_file(file);
236 nlm4svc_proc_unlock(struct svc_rqst *rqstp)
238 return __nlm4svc_proc_unlock(rqstp, rqstp->rq_resp);
242 * GRANTED: A server calls us to tell that a process' lock request
246 __nlm4svc_proc_granted(struct svc_rqst *rqstp, struct nlm_res *resp)
248 struct nlm_args *argp = rqstp->rq_argp;
250 resp->cookie = argp->cookie;
252 dprintk("lockd: GRANTED called\n");
253 resp->status = nlmclnt_grant(svc_addr(rqstp), &argp->lock);
254 dprintk("lockd: GRANTED status %d\n", ntohl(resp->status));
259 nlm4svc_proc_granted(struct svc_rqst *rqstp)
261 return __nlm4svc_proc_granted(rqstp, rqstp->rq_resp);
265 * This is the generic lockd callback for async RPC calls
267 static void nlm4svc_callback_exit(struct rpc_task *task, void *data)
269 dprintk("lockd: %5u callback returned %d\n", task->tk_pid,
273 static void nlm4svc_callback_release(void *data)
275 nlmsvc_release_call(data);
278 static const struct rpc_call_ops nlm4svc_callback_ops = {
279 .rpc_call_done = nlm4svc_callback_exit,
280 .rpc_release = nlm4svc_callback_release,
284 * `Async' versions of the above service routines. They aren't really,
285 * because we send the callback before the reply proper. I hope this
286 * doesn't break any clients.
288 static __be32 nlm4svc_callback(struct svc_rqst *rqstp, u32 proc,
289 __be32 (*func)(struct svc_rqst *, struct nlm_res *))
291 struct nlm_args *argp = rqstp->rq_argp;
292 struct nlm_host *host;
293 struct nlm_rqst *call;
296 host = nlmsvc_lookup_host(rqstp,
300 return rpc_system_err;
302 call = nlm_alloc_call(host);
303 nlmsvc_release_host(host);
305 return rpc_system_err;
307 stat = func(rqstp, &call->a_res);
309 nlmsvc_release_call(call);
313 call->a_flags = RPC_TASK_ASYNC;
314 if (nlm_async_reply(call, proc, &nlm4svc_callback_ops) < 0)
315 return rpc_system_err;
319 static __be32 nlm4svc_proc_test_msg(struct svc_rqst *rqstp)
321 dprintk("lockd: TEST_MSG called\n");
322 return nlm4svc_callback(rqstp, NLMPROC_TEST_RES, __nlm4svc_proc_test);
325 static __be32 nlm4svc_proc_lock_msg(struct svc_rqst *rqstp)
327 dprintk("lockd: LOCK_MSG called\n");
328 return nlm4svc_callback(rqstp, NLMPROC_LOCK_RES, __nlm4svc_proc_lock);
331 static __be32 nlm4svc_proc_cancel_msg(struct svc_rqst *rqstp)
333 dprintk("lockd: CANCEL_MSG called\n");
334 return nlm4svc_callback(rqstp, NLMPROC_CANCEL_RES, __nlm4svc_proc_cancel);
337 static __be32 nlm4svc_proc_unlock_msg(struct svc_rqst *rqstp)
339 dprintk("lockd: UNLOCK_MSG called\n");
340 return nlm4svc_callback(rqstp, NLMPROC_UNLOCK_RES, __nlm4svc_proc_unlock);
343 static __be32 nlm4svc_proc_granted_msg(struct svc_rqst *rqstp)
345 dprintk("lockd: GRANTED_MSG called\n");
346 return nlm4svc_callback(rqstp, NLMPROC_GRANTED_RES, __nlm4svc_proc_granted);
350 * SHARE: create a DOS share or alter existing share.
353 nlm4svc_proc_share(struct svc_rqst *rqstp)
355 struct nlm_args *argp = rqstp->rq_argp;
356 struct nlm_res *resp = rqstp->rq_resp;
357 struct nlm_host *host;
358 struct nlm_file *file;
360 dprintk("lockd: SHARE called\n");
362 resp->cookie = argp->cookie;
364 /* Don't accept new lock requests during grace period */
365 if (locks_in_grace(SVC_NET(rqstp)) && !argp->reclaim) {
366 resp->status = nlm_lck_denied_grace_period;
370 /* Obtain client and file */
371 if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
372 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
374 /* Now try to create the share */
375 resp->status = nlmsvc_share_file(host, file, argp);
377 dprintk("lockd: SHARE status %d\n", ntohl(resp->status));
378 nlmsvc_release_lockowner(&argp->lock);
379 nlmsvc_release_host(host);
380 nlm_release_file(file);
385 * UNSHARE: Release a DOS share.
388 nlm4svc_proc_unshare(struct svc_rqst *rqstp)
390 struct nlm_args *argp = rqstp->rq_argp;
391 struct nlm_res *resp = rqstp->rq_resp;
392 struct nlm_host *host;
393 struct nlm_file *file;
395 dprintk("lockd: UNSHARE called\n");
397 resp->cookie = argp->cookie;
399 /* Don't accept requests during grace period */
400 if (locks_in_grace(SVC_NET(rqstp))) {
401 resp->status = nlm_lck_denied_grace_period;
405 /* Obtain client and file */
406 if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
407 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
409 /* Now try to lock the file */
410 resp->status = nlmsvc_unshare_file(host, file, argp);
412 dprintk("lockd: UNSHARE status %d\n", ntohl(resp->status));
413 nlmsvc_release_lockowner(&argp->lock);
414 nlmsvc_release_host(host);
415 nlm_release_file(file);
420 * NM_LOCK: Create an unmonitored lock
423 nlm4svc_proc_nm_lock(struct svc_rqst *rqstp)
425 struct nlm_args *argp = rqstp->rq_argp;
427 dprintk("lockd: NM_LOCK called\n");
429 argp->monitor = 0; /* just clean the monitor flag */
430 return nlm4svc_proc_lock(rqstp);
434 * FREE_ALL: Release all locks and shares held by client
437 nlm4svc_proc_free_all(struct svc_rqst *rqstp)
439 struct nlm_args *argp = rqstp->rq_argp;
440 struct nlm_host *host;
443 if (nlm4svc_retrieve_args(rqstp, argp, &host, NULL))
446 nlmsvc_free_host_resources(host);
447 nlmsvc_release_host(host);
452 * SM_NOTIFY: private callback from statd (not part of official NLM proto)
455 nlm4svc_proc_sm_notify(struct svc_rqst *rqstp)
457 struct nlm_reboot *argp = rqstp->rq_argp;
459 dprintk("lockd: SM_NOTIFY called\n");
461 if (!nlm_privileged_requester(rqstp)) {
462 char buf[RPC_MAX_ADDRBUFLEN];
463 printk(KERN_WARNING "lockd: rejected NSM callback from %s\n",
464 svc_print_addr(rqstp, buf, sizeof(buf)));
465 return rpc_system_err;
468 nlm_host_rebooted(SVC_NET(rqstp), argp);
473 * client sent a GRANTED_RES, let's remove the associated block
476 nlm4svc_proc_granted_res(struct svc_rqst *rqstp)
478 struct nlm_res *argp = rqstp->rq_argp;
483 dprintk("lockd: GRANTED_RES called\n");
485 nlmsvc_grant_reply(&argp->cookie, argp->status);
490 nlm4svc_proc_unused(struct svc_rqst *rqstp)
492 return rpc_proc_unavail;
497 * NLM Server procedures.
500 struct nlm_void { int dummy; };
502 #define Ck (1+XDR_QUADLEN(NLM_MAXCOOKIELEN)) /* cookie */
503 #define No (1+1024/4) /* netobj */
504 #define St 1 /* status */
505 #define Rg 4 /* range (offset + length) */
507 const struct svc_procedure nlmsvc_procedures4[24] = {
509 .pc_func = nlm4svc_proc_null,
510 .pc_decode = nlm4svc_decode_void,
511 .pc_encode = nlm4svc_encode_void,
512 .pc_argsize = sizeof(struct nlm_void),
513 .pc_ressize = sizeof(struct nlm_void),
518 .pc_func = nlm4svc_proc_test,
519 .pc_decode = nlm4svc_decode_testargs,
520 .pc_encode = nlm4svc_encode_testres,
521 .pc_argsize = sizeof(struct nlm_args),
522 .pc_ressize = sizeof(struct nlm_res),
523 .pc_xdrressize = Ck+St+2+No+Rg,
527 .pc_func = nlm4svc_proc_lock,
528 .pc_decode = nlm4svc_decode_lockargs,
529 .pc_encode = nlm4svc_encode_res,
530 .pc_argsize = sizeof(struct nlm_args),
531 .pc_ressize = sizeof(struct nlm_res),
532 .pc_xdrressize = Ck+St,
536 .pc_func = nlm4svc_proc_cancel,
537 .pc_decode = nlm4svc_decode_cancargs,
538 .pc_encode = nlm4svc_encode_res,
539 .pc_argsize = sizeof(struct nlm_args),
540 .pc_ressize = sizeof(struct nlm_res),
541 .pc_xdrressize = Ck+St,
545 .pc_func = nlm4svc_proc_unlock,
546 .pc_decode = nlm4svc_decode_unlockargs,
547 .pc_encode = nlm4svc_encode_res,
548 .pc_argsize = sizeof(struct nlm_args),
549 .pc_ressize = sizeof(struct nlm_res),
550 .pc_xdrressize = Ck+St,
553 [NLMPROC_GRANTED] = {
554 .pc_func = nlm4svc_proc_granted,
555 .pc_decode = nlm4svc_decode_testargs,
556 .pc_encode = nlm4svc_encode_res,
557 .pc_argsize = sizeof(struct nlm_args),
558 .pc_ressize = sizeof(struct nlm_res),
559 .pc_xdrressize = Ck+St,
560 .pc_name = "GRANTED",
562 [NLMPROC_TEST_MSG] = {
563 .pc_func = nlm4svc_proc_test_msg,
564 .pc_decode = nlm4svc_decode_testargs,
565 .pc_encode = nlm4svc_encode_void,
566 .pc_argsize = sizeof(struct nlm_args),
567 .pc_ressize = sizeof(struct nlm_void),
569 .pc_name = "TEST_MSG",
571 [NLMPROC_LOCK_MSG] = {
572 .pc_func = nlm4svc_proc_lock_msg,
573 .pc_decode = nlm4svc_decode_lockargs,
574 .pc_encode = nlm4svc_encode_void,
575 .pc_argsize = sizeof(struct nlm_args),
576 .pc_ressize = sizeof(struct nlm_void),
578 .pc_name = "LOCK_MSG",
580 [NLMPROC_CANCEL_MSG] = {
581 .pc_func = nlm4svc_proc_cancel_msg,
582 .pc_decode = nlm4svc_decode_cancargs,
583 .pc_encode = nlm4svc_encode_void,
584 .pc_argsize = sizeof(struct nlm_args),
585 .pc_ressize = sizeof(struct nlm_void),
587 .pc_name = "CANCEL_MSG",
589 [NLMPROC_UNLOCK_MSG] = {
590 .pc_func = nlm4svc_proc_unlock_msg,
591 .pc_decode = nlm4svc_decode_unlockargs,
592 .pc_encode = nlm4svc_encode_void,
593 .pc_argsize = sizeof(struct nlm_args),
594 .pc_ressize = sizeof(struct nlm_void),
596 .pc_name = "UNLOCK_MSG",
598 [NLMPROC_GRANTED_MSG] = {
599 .pc_func = nlm4svc_proc_granted_msg,
600 .pc_decode = nlm4svc_decode_testargs,
601 .pc_encode = nlm4svc_encode_void,
602 .pc_argsize = sizeof(struct nlm_args),
603 .pc_ressize = sizeof(struct nlm_void),
605 .pc_name = "GRANTED_MSG",
607 [NLMPROC_TEST_RES] = {
608 .pc_func = nlm4svc_proc_null,
609 .pc_decode = nlm4svc_decode_void,
610 .pc_encode = nlm4svc_encode_void,
611 .pc_argsize = sizeof(struct nlm_res),
612 .pc_ressize = sizeof(struct nlm_void),
614 .pc_name = "TEST_RES",
616 [NLMPROC_LOCK_RES] = {
617 .pc_func = nlm4svc_proc_null,
618 .pc_decode = nlm4svc_decode_void,
619 .pc_encode = nlm4svc_encode_void,
620 .pc_argsize = sizeof(struct nlm_res),
621 .pc_ressize = sizeof(struct nlm_void),
623 .pc_name = "LOCK_RES",
625 [NLMPROC_CANCEL_RES] = {
626 .pc_func = nlm4svc_proc_null,
627 .pc_decode = nlm4svc_decode_void,
628 .pc_encode = nlm4svc_encode_void,
629 .pc_argsize = sizeof(struct nlm_res),
630 .pc_ressize = sizeof(struct nlm_void),
632 .pc_name = "CANCEL_RES",
634 [NLMPROC_UNLOCK_RES] = {
635 .pc_func = nlm4svc_proc_null,
636 .pc_decode = nlm4svc_decode_void,
637 .pc_encode = nlm4svc_encode_void,
638 .pc_argsize = sizeof(struct nlm_res),
639 .pc_ressize = sizeof(struct nlm_void),
641 .pc_name = "UNLOCK_RES",
643 [NLMPROC_GRANTED_RES] = {
644 .pc_func = nlm4svc_proc_granted_res,
645 .pc_decode = nlm4svc_decode_res,
646 .pc_encode = nlm4svc_encode_void,
647 .pc_argsize = sizeof(struct nlm_res),
648 .pc_ressize = sizeof(struct nlm_void),
650 .pc_name = "GRANTED_RES",
652 [NLMPROC_NSM_NOTIFY] = {
653 .pc_func = nlm4svc_proc_sm_notify,
654 .pc_decode = nlm4svc_decode_reboot,
655 .pc_encode = nlm4svc_encode_void,
656 .pc_argsize = sizeof(struct nlm_reboot),
657 .pc_ressize = sizeof(struct nlm_void),
659 .pc_name = "SM_NOTIFY",
662 .pc_func = nlm4svc_proc_unused,
663 .pc_decode = nlm4svc_decode_void,
664 .pc_encode = nlm4svc_encode_void,
665 .pc_argsize = sizeof(struct nlm_void),
666 .pc_ressize = sizeof(struct nlm_void),
671 .pc_func = nlm4svc_proc_unused,
672 .pc_decode = nlm4svc_decode_void,
673 .pc_encode = nlm4svc_encode_void,
674 .pc_argsize = sizeof(struct nlm_void),
675 .pc_ressize = sizeof(struct nlm_void),
680 .pc_func = nlm4svc_proc_unused,
681 .pc_decode = nlm4svc_decode_void,
682 .pc_encode = nlm4svc_encode_void,
683 .pc_argsize = sizeof(struct nlm_void),
684 .pc_ressize = sizeof(struct nlm_void),
689 .pc_func = nlm4svc_proc_share,
690 .pc_decode = nlm4svc_decode_shareargs,
691 .pc_encode = nlm4svc_encode_shareres,
692 .pc_argsize = sizeof(struct nlm_args),
693 .pc_ressize = sizeof(struct nlm_res),
694 .pc_xdrressize = Ck+St+1,
697 [NLMPROC_UNSHARE] = {
698 .pc_func = nlm4svc_proc_unshare,
699 .pc_decode = nlm4svc_decode_shareargs,
700 .pc_encode = nlm4svc_encode_shareres,
701 .pc_argsize = sizeof(struct nlm_args),
702 .pc_ressize = sizeof(struct nlm_res),
703 .pc_xdrressize = Ck+St+1,
704 .pc_name = "UNSHARE",
706 [NLMPROC_NM_LOCK] = {
707 .pc_func = nlm4svc_proc_nm_lock,
708 .pc_decode = nlm4svc_decode_lockargs,
709 .pc_encode = nlm4svc_encode_res,
710 .pc_argsize = sizeof(struct nlm_args),
711 .pc_ressize = sizeof(struct nlm_res),
712 .pc_xdrressize = Ck+St,
713 .pc_name = "NM_LOCK",
715 [NLMPROC_FREE_ALL] = {
716 .pc_func = nlm4svc_proc_free_all,
717 .pc_decode = nlm4svc_decode_notify,
718 .pc_encode = nlm4svc_encode_void,
719 .pc_argsize = sizeof(struct nlm_args),
720 .pc_ressize = sizeof(struct nlm_void),
722 .pc_name = "FREE_ALL",