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/lockd/lockd.h>
13 #include <linux/lockd/share.h>
14 #include <linux/sunrpc/svc_xprt.h>
16 #define NLMDBG_FACILITY NLMDBG_CLIENT
18 #ifdef CONFIG_LOCKD_V4
20 cast_to_nlm(__be32 status, u32 vers)
22 /* Note: status is assumed to be in network byte order !!! */
27 case nlm_lck_denied_nolocks:
29 case nlm_lck_denied_grace_period:
33 status = nlm_lck_denied;
36 status = nlm_lck_denied_nolocks;
42 #define cast_status(status) (cast_to_nlm(status, rqstp->rq_vers))
44 #define cast_status(status) (status)
48 * Obtain client and file from arguments
51 nlmsvc_retrieve_args(struct svc_rqst *rqstp, struct nlm_args *argp,
52 struct nlm_host **hostp, struct nlm_file **filp)
54 struct nlm_host *host = NULL;
55 struct nlm_file *file = NULL;
56 struct nlm_lock *lock = &argp->lock;
59 /* nfsd callbacks must have been installed for this procedure */
61 return nlm_lck_denied_nolocks;
63 /* Obtain host handle */
64 if (!(host = nlmsvc_lookup_host(rqstp, lock->caller, lock->len))
65 || (argp->monitor && nsm_monitor(host) < 0))
69 /* Obtain file pointer. Not used by FREE_ALL call. */
71 if ((error = nlm_lookup_file(rqstp, &file, &lock->fh)) != 0)
75 /* Set up the missing parts of the file_lock structure */
76 lock->fl.fl_file = file->f_file;
77 lock->fl.fl_owner = (fl_owner_t) host;
78 lock->fl.fl_lmops = &nlmsvc_lock_operations;
84 nlmsvc_release_host(host);
87 return nlm_lck_denied_nolocks;
91 * NULL: Test for presence of service
94 nlmsvc_proc_null(struct svc_rqst *rqstp, void *argp, void *resp)
96 dprintk("lockd: NULL called\n");
101 * TEST: Check for conflicting lock
104 nlmsvc_proc_test(struct svc_rqst *rqstp, struct nlm_args *argp,
105 struct nlm_res *resp)
107 struct nlm_host *host;
108 struct nlm_file *file;
109 __be32 rc = rpc_success;
111 dprintk("lockd: TEST called\n");
112 resp->cookie = argp->cookie;
114 /* Obtain client and file */
115 if ((resp->status = nlmsvc_retrieve_args(rqstp, argp, &host, &file)))
116 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
118 /* Now check for conflicting locks */
119 resp->status = cast_status(nlmsvc_testlock(rqstp, file, host, &argp->lock, &resp->lock, &resp->cookie));
120 if (resp->status == nlm_drop_reply)
123 dprintk("lockd: TEST status %d vers %d\n",
124 ntohl(resp->status), rqstp->rq_vers);
126 nlmsvc_release_host(host);
127 nlm_release_file(file);
132 nlmsvc_proc_lock(struct svc_rqst *rqstp, struct nlm_args *argp,
133 struct nlm_res *resp)
135 struct nlm_host *host;
136 struct nlm_file *file;
137 __be32 rc = rpc_success;
139 dprintk("lockd: LOCK called\n");
141 resp->cookie = argp->cookie;
143 /* Obtain client and file */
144 if ((resp->status = nlmsvc_retrieve_args(rqstp, argp, &host, &file)))
145 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
148 /* If supplied state doesn't match current state, we assume it's
149 * an old request that time-warped somehow. Any error return would
150 * do in this case because it's irrelevant anyway.
152 * NB: We don't retrieve the remote host's state yet.
154 if (host->h_nsmstate && host->h_nsmstate != argp->state) {
155 resp->status = nlm_lck_denied_nolocks;
159 /* Now try to lock the file */
160 resp->status = cast_status(nlmsvc_lock(rqstp, file, host, &argp->lock,
161 argp->block, &argp->cookie,
163 if (resp->status == nlm_drop_reply)
166 dprintk("lockd: LOCK status %d\n", ntohl(resp->status));
168 nlmsvc_release_host(host);
169 nlm_release_file(file);
174 nlmsvc_proc_cancel(struct svc_rqst *rqstp, struct nlm_args *argp,
175 struct nlm_res *resp)
177 struct nlm_host *host;
178 struct nlm_file *file;
179 struct net *net = SVC_NET(rqstp);
181 dprintk("lockd: CANCEL called\n");
183 resp->cookie = argp->cookie;
185 /* Don't accept requests during grace period */
186 if (locks_in_grace(net)) {
187 resp->status = nlm_lck_denied_grace_period;
191 /* Obtain client and file */
192 if ((resp->status = nlmsvc_retrieve_args(rqstp, argp, &host, &file)))
193 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
195 /* Try to cancel request. */
196 resp->status = cast_status(nlmsvc_cancel_blocked(net, file, &argp->lock));
198 dprintk("lockd: CANCEL status %d\n", ntohl(resp->status));
199 nlmsvc_release_host(host);
200 nlm_release_file(file);
205 * UNLOCK: release a lock
208 nlmsvc_proc_unlock(struct svc_rqst *rqstp, struct nlm_args *argp,
209 struct nlm_res *resp)
211 struct nlm_host *host;
212 struct nlm_file *file;
213 struct net *net = SVC_NET(rqstp);
215 dprintk("lockd: UNLOCK called\n");
217 resp->cookie = argp->cookie;
219 /* Don't accept new lock requests during grace period */
220 if (locks_in_grace(net)) {
221 resp->status = nlm_lck_denied_grace_period;
225 /* Obtain client and file */
226 if ((resp->status = nlmsvc_retrieve_args(rqstp, argp, &host, &file)))
227 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
229 /* Now try to remove the lock */
230 resp->status = cast_status(nlmsvc_unlock(net, file, &argp->lock));
232 dprintk("lockd: UNLOCK status %d\n", ntohl(resp->status));
233 nlmsvc_release_host(host);
234 nlm_release_file(file);
239 * GRANTED: A server calls us to tell that a process' lock request
243 nlmsvc_proc_granted(struct svc_rqst *rqstp, struct nlm_args *argp,
244 struct nlm_res *resp)
246 resp->cookie = argp->cookie;
248 dprintk("lockd: GRANTED called\n");
249 resp->status = nlmclnt_grant(svc_addr(rqstp), &argp->lock);
250 dprintk("lockd: GRANTED status %d\n", ntohl(resp->status));
255 * This is the generic lockd callback for async RPC calls
257 static void nlmsvc_callback_exit(struct rpc_task *task, void *data)
259 dprintk("lockd: %5u callback returned %d\n", task->tk_pid,
263 void nlmsvc_release_call(struct nlm_rqst *call)
265 if (!atomic_dec_and_test(&call->a_count))
267 nlmsvc_release_host(call->a_host);
271 static void nlmsvc_callback_release(void *data)
273 nlmsvc_release_call(data);
276 static const struct rpc_call_ops nlmsvc_callback_ops = {
277 .rpc_call_done = nlmsvc_callback_exit,
278 .rpc_release = nlmsvc_callback_release,
282 * `Async' versions of the above service routines. They aren't really,
283 * because we send the callback before the reply proper. I hope this
284 * doesn't break any clients.
286 static __be32 nlmsvc_callback(struct svc_rqst *rqstp, u32 proc, struct nlm_args *argp,
287 __be32 (*func)(struct svc_rqst *, struct nlm_args *, struct nlm_res *))
289 struct nlm_host *host;
290 struct nlm_rqst *call;
293 host = nlmsvc_lookup_host(rqstp,
297 return rpc_system_err;
299 call = nlm_alloc_call(host);
301 return rpc_system_err;
303 stat = func(rqstp, argp, &call->a_res);
305 nlmsvc_release_call(call);
309 call->a_flags = RPC_TASK_ASYNC;
310 if (nlm_async_reply(call, proc, &nlmsvc_callback_ops) < 0)
311 return rpc_system_err;
315 static __be32 nlmsvc_proc_test_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
318 dprintk("lockd: TEST_MSG called\n");
319 return nlmsvc_callback(rqstp, NLMPROC_TEST_RES, argp, nlmsvc_proc_test);
322 static __be32 nlmsvc_proc_lock_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
325 dprintk("lockd: LOCK_MSG called\n");
326 return nlmsvc_callback(rqstp, NLMPROC_LOCK_RES, argp, nlmsvc_proc_lock);
329 static __be32 nlmsvc_proc_cancel_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
332 dprintk("lockd: CANCEL_MSG called\n");
333 return nlmsvc_callback(rqstp, NLMPROC_CANCEL_RES, argp, nlmsvc_proc_cancel);
337 nlmsvc_proc_unlock_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
340 dprintk("lockd: UNLOCK_MSG called\n");
341 return nlmsvc_callback(rqstp, NLMPROC_UNLOCK_RES, argp, nlmsvc_proc_unlock);
345 nlmsvc_proc_granted_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
348 dprintk("lockd: GRANTED_MSG called\n");
349 return nlmsvc_callback(rqstp, NLMPROC_GRANTED_RES, argp, nlmsvc_proc_granted);
353 * SHARE: create a DOS share or alter existing share.
356 nlmsvc_proc_share(struct svc_rqst *rqstp, struct nlm_args *argp,
357 struct nlm_res *resp)
359 struct nlm_host *host;
360 struct nlm_file *file;
362 dprintk("lockd: SHARE called\n");
364 resp->cookie = argp->cookie;
366 /* Don't accept new lock requests during grace period */
367 if (locks_in_grace(SVC_NET(rqstp)) && !argp->reclaim) {
368 resp->status = nlm_lck_denied_grace_period;
372 /* Obtain client and file */
373 if ((resp->status = nlmsvc_retrieve_args(rqstp, argp, &host, &file)))
374 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
376 /* Now try to create the share */
377 resp->status = cast_status(nlmsvc_share_file(host, file, argp));
379 dprintk("lockd: SHARE status %d\n", ntohl(resp->status));
380 nlmsvc_release_host(host);
381 nlm_release_file(file);
386 * UNSHARE: Release a DOS share.
389 nlmsvc_proc_unshare(struct svc_rqst *rqstp, struct nlm_args *argp,
390 struct nlm_res *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 = nlmsvc_retrieve_args(rqstp, argp, &host, &file)))
407 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
409 /* Now try to unshare the file */
410 resp->status = cast_status(nlmsvc_unshare_file(host, file, argp));
412 dprintk("lockd: UNSHARE status %d\n", ntohl(resp->status));
413 nlmsvc_release_host(host);
414 nlm_release_file(file);
419 * NM_LOCK: Create an unmonitored lock
422 nlmsvc_proc_nm_lock(struct svc_rqst *rqstp, struct nlm_args *argp,
423 struct nlm_res *resp)
425 dprintk("lockd: NM_LOCK called\n");
427 argp->monitor = 0; /* just clean the monitor flag */
428 return nlmsvc_proc_lock(rqstp, argp, resp);
432 * FREE_ALL: Release all locks and shares held by client
435 nlmsvc_proc_free_all(struct svc_rqst *rqstp, struct nlm_args *argp,
438 struct nlm_host *host;
441 if (nlmsvc_retrieve_args(rqstp, argp, &host, NULL))
444 nlmsvc_free_host_resources(host);
445 nlmsvc_release_host(host);
450 * SM_NOTIFY: private callback from statd (not part of official NLM proto)
453 nlmsvc_proc_sm_notify(struct svc_rqst *rqstp, struct nlm_reboot *argp,
456 dprintk("lockd: SM_NOTIFY called\n");
458 if (!nlm_privileged_requester(rqstp)) {
459 char buf[RPC_MAX_ADDRBUFLEN];
460 printk(KERN_WARNING "lockd: rejected NSM callback from %s\n",
461 svc_print_addr(rqstp, buf, sizeof(buf)));
462 return rpc_system_err;
465 nlm_host_rebooted(argp);
470 * client sent a GRANTED_RES, let's remove the associated block
473 nlmsvc_proc_granted_res(struct svc_rqst *rqstp, struct nlm_res *argp,
479 dprintk("lockd: GRANTED_RES called\n");
481 nlmsvc_grant_reply(&argp->cookie, argp->status);
486 * NLM Server procedures.
489 #define nlmsvc_encode_norep nlmsvc_encode_void
490 #define nlmsvc_decode_norep nlmsvc_decode_void
491 #define nlmsvc_decode_testres nlmsvc_decode_void
492 #define nlmsvc_decode_lockres nlmsvc_decode_void
493 #define nlmsvc_decode_unlockres nlmsvc_decode_void
494 #define nlmsvc_decode_cancelres nlmsvc_decode_void
495 #define nlmsvc_decode_grantedres nlmsvc_decode_void
497 #define nlmsvc_proc_none nlmsvc_proc_null
498 #define nlmsvc_proc_test_res nlmsvc_proc_null
499 #define nlmsvc_proc_lock_res nlmsvc_proc_null
500 #define nlmsvc_proc_cancel_res nlmsvc_proc_null
501 #define nlmsvc_proc_unlock_res nlmsvc_proc_null
503 struct nlm_void { int dummy; };
505 #define PROC(name, xargt, xrest, argt, rest, respsize) \
506 { .pc_func = (svc_procfunc) nlmsvc_proc_##name, \
507 .pc_decode = (kxdrproc_t) nlmsvc_decode_##xargt, \
508 .pc_encode = (kxdrproc_t) nlmsvc_encode_##xrest, \
509 .pc_release = NULL, \
510 .pc_argsize = sizeof(struct nlm_##argt), \
511 .pc_ressize = sizeof(struct nlm_##rest), \
512 .pc_xdrressize = respsize, \
515 #define Ck (1+XDR_QUADLEN(NLM_MAXCOOKIELEN)) /* cookie */
516 #define St 1 /* status */
517 #define No (1+1024/4) /* Net Obj */
518 #define Rg 2 /* range - offset + size */
520 struct svc_procedure nlmsvc_procedures[] = {
521 PROC(null, void, void, void, void, 1),
522 PROC(test, testargs, testres, args, res, Ck+St+2+No+Rg),
523 PROC(lock, lockargs, res, args, res, Ck+St),
524 PROC(cancel, cancargs, res, args, res, Ck+St),
525 PROC(unlock, unlockargs, res, args, res, Ck+St),
526 PROC(granted, testargs, res, args, res, Ck+St),
527 PROC(test_msg, testargs, norep, args, void, 1),
528 PROC(lock_msg, lockargs, norep, args, void, 1),
529 PROC(cancel_msg, cancargs, norep, args, void, 1),
530 PROC(unlock_msg, unlockargs, norep, args, void, 1),
531 PROC(granted_msg, testargs, norep, args, void, 1),
532 PROC(test_res, testres, norep, res, void, 1),
533 PROC(lock_res, lockres, norep, res, void, 1),
534 PROC(cancel_res, cancelres, norep, res, void, 1),
535 PROC(unlock_res, unlockres, norep, res, void, 1),
536 PROC(granted_res, res, norep, res, void, 1),
538 PROC(sm_notify, reboot, void, reboot, void, 1),
539 PROC(none, void, void, void, void, 1),
540 PROC(none, void, void, void, void, 1),
541 PROC(none, void, void, void, void, 1),
542 PROC(share, shareargs, shareres, args, res, Ck+St+1),
543 PROC(unshare, shareargs, shareres, args, res, Ck+St+1),
544 PROC(nm_lock, lockargs, res, args, res, Ck+St),
545 PROC(free_all, notify, void, args, void, 0),