2 * linux/fs/lockd/svcproc.c
4 * Lockd server procedures. We don't implement the NLM_*_RES
5 * procedures because we don't use the async procedures.
7 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
10 #include <linux/types.h>
11 #include <linux/time.h>
12 #include <linux/slab.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>
20 #define NLMDBG_FACILITY NLMDBG_CLIENT
22 #ifdef CONFIG_LOCKD_V4
24 cast_to_nlm(__be32 status, u32 vers)
26 /* Note: status is assumed to be in network byte order !!! */
31 case nlm_lck_denied_nolocks:
33 case nlm_lck_denied_grace_period:
37 status = nlm_lck_denied;
40 status = nlm_lck_denied_nolocks;
46 #define cast_status(status) (cast_to_nlm(status, rqstp->rq_vers))
48 #define cast_status(status) (status)
52 * Obtain client and file from arguments
55 nlmsvc_retrieve_args(struct svc_rqst *rqstp, struct nlm_args *argp,
56 struct nlm_host **hostp, struct nlm_file **filp)
58 struct nlm_host *host = NULL;
59 struct nlm_file *file = NULL;
60 struct nlm_lock *lock = &argp->lock;
63 /* nfsd callbacks must have been installed for this procedure */
65 return nlm_lck_denied_nolocks;
67 /* Obtain host handle */
68 if (!(host = nlmsvc_lookup_host(rqstp, lock->caller, lock->len))
69 || (argp->monitor && nsm_monitor(host) < 0))
73 /* Obtain file pointer. Not used by FREE_ALL call. */
75 if ((error = nlm_lookup_file(rqstp, &file, &lock->fh)) != 0)
79 /* Set up the missing parts of the file_lock structure */
80 lock->fl.fl_file = file->f_file;
81 lock->fl.fl_owner = (fl_owner_t) host;
82 lock->fl.fl_lmops = &nlmsvc_lock_operations;
88 nlm_release_host(host);
91 return nlm_lck_denied_nolocks;
95 * NULL: Test for presence of service
98 nlmsvc_proc_null(struct svc_rqst *rqstp, void *argp, void *resp)
100 dprintk("lockd: NULL called\n");
105 * TEST: Check for conflicting lock
108 nlmsvc_proc_test(struct svc_rqst *rqstp, struct nlm_args *argp,
109 struct nlm_res *resp)
111 struct nlm_host *host;
112 struct nlm_file *file;
113 __be32 rc = rpc_success;
115 dprintk("lockd: TEST called\n");
116 resp->cookie = argp->cookie;
118 /* Obtain client and file */
119 if ((resp->status = nlmsvc_retrieve_args(rqstp, argp, &host, &file)))
120 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
122 /* Now check for conflicting locks */
123 resp->status = cast_status(nlmsvc_testlock(rqstp, file, host, &argp->lock, &resp->lock, &resp->cookie));
124 if (resp->status == nlm_drop_reply)
127 dprintk("lockd: TEST status %d vers %d\n",
128 ntohl(resp->status), rqstp->rq_vers);
130 nlm_release_host(host);
131 nlm_release_file(file);
136 nlmsvc_proc_lock(struct svc_rqst *rqstp, struct nlm_args *argp,
137 struct nlm_res *resp)
139 struct nlm_host *host;
140 struct nlm_file *file;
141 __be32 rc = rpc_success;
143 dprintk("lockd: LOCK called\n");
145 resp->cookie = argp->cookie;
147 /* Obtain client and file */
148 if ((resp->status = nlmsvc_retrieve_args(rqstp, argp, &host, &file)))
149 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
152 /* If supplied state doesn't match current state, we assume it's
153 * an old request that time-warped somehow. Any error return would
154 * do in this case because it's irrelevant anyway.
156 * NB: We don't retrieve the remote host's state yet.
158 if (host->h_nsmstate && host->h_nsmstate != argp->state) {
159 resp->status = nlm_lck_denied_nolocks;
163 /* Now try to lock the file */
164 resp->status = cast_status(nlmsvc_lock(rqstp, file, host, &argp->lock,
165 argp->block, &argp->cookie,
167 if (resp->status == nlm_drop_reply)
170 dprintk("lockd: LOCK status %d\n", ntohl(resp->status));
172 nlm_release_host(host);
173 nlm_release_file(file);
178 nlmsvc_proc_cancel(struct svc_rqst *rqstp, struct nlm_args *argp,
179 struct nlm_res *resp)
181 struct nlm_host *host;
182 struct nlm_file *file;
184 dprintk("lockd: CANCEL called\n");
186 resp->cookie = argp->cookie;
188 /* Don't accept requests during grace period */
189 if (locks_in_grace()) {
190 resp->status = nlm_lck_denied_grace_period;
194 /* Obtain client and file */
195 if ((resp->status = nlmsvc_retrieve_args(rqstp, argp, &host, &file)))
196 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
198 /* Try to cancel request. */
199 resp->status = cast_status(nlmsvc_cancel_blocked(file, &argp->lock));
201 dprintk("lockd: CANCEL status %d\n", ntohl(resp->status));
202 nlm_release_host(host);
203 nlm_release_file(file);
208 * UNLOCK: release a lock
211 nlmsvc_proc_unlock(struct svc_rqst *rqstp, struct nlm_args *argp,
212 struct nlm_res *resp)
214 struct nlm_host *host;
215 struct nlm_file *file;
217 dprintk("lockd: UNLOCK called\n");
219 resp->cookie = argp->cookie;
221 /* Don't accept new lock requests during grace period */
222 if (locks_in_grace()) {
223 resp->status = nlm_lck_denied_grace_period;
227 /* Obtain client and file */
228 if ((resp->status = nlmsvc_retrieve_args(rqstp, argp, &host, &file)))
229 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
231 /* Now try to remove the lock */
232 resp->status = cast_status(nlmsvc_unlock(file, &argp->lock));
234 dprintk("lockd: UNLOCK status %d\n", ntohl(resp->status));
235 nlm_release_host(host);
236 nlm_release_file(file);
241 * GRANTED: A server calls us to tell that a process' lock request
245 nlmsvc_proc_granted(struct svc_rqst *rqstp, struct nlm_args *argp,
246 struct nlm_res *resp)
248 resp->cookie = argp->cookie;
250 dprintk("lockd: GRANTED called\n");
251 resp->status = nlmclnt_grant(svc_addr(rqstp), &argp->lock);
252 dprintk("lockd: GRANTED status %d\n", ntohl(resp->status));
257 * This is the generic lockd callback for async RPC calls
259 static void nlmsvc_callback_exit(struct rpc_task *task, void *data)
261 dprintk("lockd: %5u callback returned %d\n", task->tk_pid,
265 static void nlmsvc_callback_release(void *data)
268 nlm_release_call(data);
272 static const struct rpc_call_ops nlmsvc_callback_ops = {
273 .rpc_call_done = nlmsvc_callback_exit,
274 .rpc_release = nlmsvc_callback_release,
278 * `Async' versions of the above service routines. They aren't really,
279 * because we send the callback before the reply proper. I hope this
280 * doesn't break any clients.
282 static __be32 nlmsvc_callback(struct svc_rqst *rqstp, u32 proc, struct nlm_args *argp,
283 __be32 (*func)(struct svc_rqst *, struct nlm_args *, struct nlm_res *))
285 struct nlm_host *host;
286 struct nlm_rqst *call;
289 host = nlmsvc_lookup_host(rqstp,
293 return rpc_system_err;
295 call = nlm_alloc_call(host);
297 return rpc_system_err;
299 stat = func(rqstp, argp, &call->a_res);
301 nlm_release_call(call);
305 call->a_flags = RPC_TASK_ASYNC;
306 if (nlm_async_reply(call, proc, &nlmsvc_callback_ops) < 0)
307 return rpc_system_err;
311 static __be32 nlmsvc_proc_test_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
314 dprintk("lockd: TEST_MSG called\n");
315 return nlmsvc_callback(rqstp, NLMPROC_TEST_RES, argp, nlmsvc_proc_test);
318 static __be32 nlmsvc_proc_lock_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
321 dprintk("lockd: LOCK_MSG called\n");
322 return nlmsvc_callback(rqstp, NLMPROC_LOCK_RES, argp, nlmsvc_proc_lock);
325 static __be32 nlmsvc_proc_cancel_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
328 dprintk("lockd: CANCEL_MSG called\n");
329 return nlmsvc_callback(rqstp, NLMPROC_CANCEL_RES, argp, nlmsvc_proc_cancel);
333 nlmsvc_proc_unlock_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
336 dprintk("lockd: UNLOCK_MSG called\n");
337 return nlmsvc_callback(rqstp, NLMPROC_UNLOCK_RES, argp, nlmsvc_proc_unlock);
341 nlmsvc_proc_granted_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
344 dprintk("lockd: GRANTED_MSG called\n");
345 return nlmsvc_callback(rqstp, NLMPROC_GRANTED_RES, argp, nlmsvc_proc_granted);
349 * SHARE: create a DOS share or alter existing share.
352 nlmsvc_proc_share(struct svc_rqst *rqstp, struct nlm_args *argp,
353 struct nlm_res *resp)
355 struct nlm_host *host;
356 struct nlm_file *file;
358 dprintk("lockd: SHARE called\n");
360 resp->cookie = argp->cookie;
362 /* Don't accept new lock requests during grace period */
363 if (locks_in_grace() && !argp->reclaim) {
364 resp->status = nlm_lck_denied_grace_period;
368 /* Obtain client and file */
369 if ((resp->status = nlmsvc_retrieve_args(rqstp, argp, &host, &file)))
370 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
372 /* Now try to create the share */
373 resp->status = cast_status(nlmsvc_share_file(host, file, argp));
375 dprintk("lockd: SHARE status %d\n", ntohl(resp->status));
376 nlm_release_host(host);
377 nlm_release_file(file);
382 * UNSHARE: Release a DOS share.
385 nlmsvc_proc_unshare(struct svc_rqst *rqstp, struct nlm_args *argp,
386 struct nlm_res *resp)
388 struct nlm_host *host;
389 struct nlm_file *file;
391 dprintk("lockd: UNSHARE called\n");
393 resp->cookie = argp->cookie;
395 /* Don't accept requests during grace period */
396 if (locks_in_grace()) {
397 resp->status = nlm_lck_denied_grace_period;
401 /* Obtain client and file */
402 if ((resp->status = nlmsvc_retrieve_args(rqstp, argp, &host, &file)))
403 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
405 /* Now try to unshare the file */
406 resp->status = cast_status(nlmsvc_unshare_file(host, file, argp));
408 dprintk("lockd: UNSHARE status %d\n", ntohl(resp->status));
409 nlm_release_host(host);
410 nlm_release_file(file);
415 * NM_LOCK: Create an unmonitored lock
418 nlmsvc_proc_nm_lock(struct svc_rqst *rqstp, struct nlm_args *argp,
419 struct nlm_res *resp)
421 dprintk("lockd: NM_LOCK called\n");
423 argp->monitor = 0; /* just clean the monitor flag */
424 return nlmsvc_proc_lock(rqstp, argp, resp);
428 * FREE_ALL: Release all locks and shares held by client
431 nlmsvc_proc_free_all(struct svc_rqst *rqstp, struct nlm_args *argp,
434 struct nlm_host *host;
437 if (nlmsvc_retrieve_args(rqstp, argp, &host, NULL))
440 nlmsvc_free_host_resources(host);
441 nlm_release_host(host);
446 * SM_NOTIFY: private callback from statd (not part of official NLM proto)
449 nlmsvc_proc_sm_notify(struct svc_rqst *rqstp, struct nlm_reboot *argp,
452 dprintk("lockd: SM_NOTIFY called\n");
454 if (!nlm_privileged_requester(rqstp)) {
455 char buf[RPC_MAX_ADDRBUFLEN];
456 printk(KERN_WARNING "lockd: rejected NSM callback from %s\n",
457 svc_print_addr(rqstp, buf, sizeof(buf)));
458 return rpc_system_err;
461 nlm_host_rebooted(argp);
466 * client sent a GRANTED_RES, let's remove the associated block
469 nlmsvc_proc_granted_res(struct svc_rqst *rqstp, struct nlm_res *argp,
475 dprintk("lockd: GRANTED_RES called\n");
477 nlmsvc_grant_reply(&argp->cookie, argp->status);
482 * NLM Server procedures.
485 #define nlmsvc_encode_norep nlmsvc_encode_void
486 #define nlmsvc_decode_norep nlmsvc_decode_void
487 #define nlmsvc_decode_testres nlmsvc_decode_void
488 #define nlmsvc_decode_lockres nlmsvc_decode_void
489 #define nlmsvc_decode_unlockres nlmsvc_decode_void
490 #define nlmsvc_decode_cancelres nlmsvc_decode_void
491 #define nlmsvc_decode_grantedres nlmsvc_decode_void
493 #define nlmsvc_proc_none nlmsvc_proc_null
494 #define nlmsvc_proc_test_res nlmsvc_proc_null
495 #define nlmsvc_proc_lock_res nlmsvc_proc_null
496 #define nlmsvc_proc_cancel_res nlmsvc_proc_null
497 #define nlmsvc_proc_unlock_res nlmsvc_proc_null
499 struct nlm_void { int dummy; };
501 #define PROC(name, xargt, xrest, argt, rest, respsize) \
502 { .pc_func = (svc_procfunc) nlmsvc_proc_##name, \
503 .pc_decode = (kxdrproc_t) nlmsvc_decode_##xargt, \
504 .pc_encode = (kxdrproc_t) nlmsvc_encode_##xrest, \
505 .pc_release = NULL, \
506 .pc_argsize = sizeof(struct nlm_##argt), \
507 .pc_ressize = sizeof(struct nlm_##rest), \
508 .pc_xdrressize = respsize, \
511 #define Ck (1+XDR_QUADLEN(NLM_MAXCOOKIELEN)) /* cookie */
512 #define St 1 /* status */
513 #define No (1+1024/4) /* Net Obj */
514 #define Rg 2 /* range - offset + size */
516 struct svc_procedure nlmsvc_procedures[] = {
517 PROC(null, void, void, void, void, 1),
518 PROC(test, testargs, testres, args, res, Ck+St+2+No+Rg),
519 PROC(lock, lockargs, res, args, res, Ck+St),
520 PROC(cancel, cancargs, res, args, res, Ck+St),
521 PROC(unlock, unlockargs, res, args, res, Ck+St),
522 PROC(granted, testargs, res, args, res, Ck+St),
523 PROC(test_msg, testargs, norep, args, void, 1),
524 PROC(lock_msg, lockargs, norep, args, void, 1),
525 PROC(cancel_msg, cancargs, norep, args, void, 1),
526 PROC(unlock_msg, unlockargs, norep, args, void, 1),
527 PROC(granted_msg, testargs, norep, args, void, 1),
528 PROC(test_res, testres, norep, res, void, 1),
529 PROC(lock_res, lockres, norep, res, void, 1),
530 PROC(cancel_res, cancelres, norep, res, void, 1),
531 PROC(unlock_res, unlockres, norep, res, void, 1),
532 PROC(granted_res, res, norep, res, void, 1),
534 PROC(sm_notify, reboot, void, reboot, void, 1),
535 PROC(none, void, void, void, void, 1),
536 PROC(none, void, void, void, void, 1),
537 PROC(none, void, void, void, void, 1),
538 PROC(share, shareargs, shareres, args, res, Ck+St+1),
539 PROC(unshare, shareargs, shareres, args, res, Ck+St+1),
540 PROC(nm_lock, lockargs, res, args, res, Ck+St),
541 PROC(free_all, notify, void, args, void, 0),