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>
13 #include <linux/smp_lock.h>
15 #include <linux/sunrpc/svc.h>
16 #include <linux/sunrpc/clnt.h>
17 #include <linux/nfsd/nfsd.h>
18 #include <linux/lockd/lockd.h>
19 #include <linux/lockd/share.h>
21 #define NLMDBG_FACILITY NLMDBG_CLIENT
23 #ifdef CONFIG_LOCKD_V4
25 cast_to_nlm(__be32 status, u32 vers)
27 /* Note: status is assumed to be in network byte order !!! */
32 case nlm_lck_denied_nolocks:
34 case nlm_lck_denied_grace_period:
38 status = nlm_lck_denied;
41 status = nlm_lck_denied_nolocks;
47 #define cast_status(status) (cast_to_nlm(status, rqstp->rq_vers))
49 #define cast_status(status) (status)
53 * Obtain client and file from arguments
56 nlmsvc_retrieve_args(struct svc_rqst *rqstp, struct nlm_args *argp,
57 struct nlm_host **hostp, struct nlm_file **filp)
59 struct nlm_host *host = NULL;
60 struct nlm_file *file = NULL;
61 struct nlm_lock *lock = &argp->lock;
64 /* nfsd callbacks must have been installed for this procedure */
66 return nlm_lck_denied_nolocks;
68 /* Obtain host handle */
69 if (!(host = nlmsvc_lookup_host(rqstp, lock->caller, lock->len))
70 || (argp->monitor && nsm_monitor(host) < 0))
74 /* Obtain file pointer. Not used by FREE_ALL call. */
76 if ((error = nlm_lookup_file(rqstp, &file, &lock->fh)) != 0)
80 /* Set up the missing parts of the file_lock structure */
81 lock->fl.fl_file = file->f_file;
82 lock->fl.fl_owner = (fl_owner_t) host;
83 lock->fl.fl_lmops = &nlmsvc_lock_operations;
89 nlm_release_host(host);
92 return nlm_lck_denied_nolocks;
96 * NULL: Test for presence of service
99 nlmsvc_proc_null(struct svc_rqst *rqstp, void *argp, void *resp)
101 dprintk("lockd: NULL called\n");
106 * TEST: Check for conflicting lock
109 nlmsvc_proc_test(struct svc_rqst *rqstp, struct nlm_args *argp,
110 struct nlm_res *resp)
112 struct nlm_host *host;
113 struct nlm_file *file;
114 __be32 rc = rpc_success;
116 dprintk("lockd: TEST called\n");
117 resp->cookie = argp->cookie;
119 /* Obtain client and file */
120 if ((resp->status = nlmsvc_retrieve_args(rqstp, argp, &host, &file)))
121 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
123 /* Now check for conflicting locks */
124 resp->status = cast_status(nlmsvc_testlock(rqstp, file, host, &argp->lock, &resp->lock, &resp->cookie));
125 if (resp->status == nlm_drop_reply)
128 dprintk("lockd: TEST status %d vers %d\n",
129 ntohl(resp->status), rqstp->rq_vers);
131 nlm_release_host(host);
132 nlm_release_file(file);
137 nlmsvc_proc_lock(struct svc_rqst *rqstp, struct nlm_args *argp,
138 struct nlm_res *resp)
140 struct nlm_host *host;
141 struct nlm_file *file;
142 __be32 rc = rpc_success;
144 dprintk("lockd: LOCK called\n");
146 resp->cookie = argp->cookie;
148 /* Obtain client and file */
149 if ((resp->status = nlmsvc_retrieve_args(rqstp, argp, &host, &file)))
150 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
153 /* If supplied state doesn't match current state, we assume it's
154 * an old request that time-warped somehow. Any error return would
155 * do in this case because it's irrelevant anyway.
157 * NB: We don't retrieve the remote host's state yet.
159 if (host->h_nsmstate && host->h_nsmstate != argp->state) {
160 resp->status = nlm_lck_denied_nolocks;
164 /* Now try to lock the file */
165 resp->status = cast_status(nlmsvc_lock(rqstp, file, host, &argp->lock,
166 argp->block, &argp->cookie,
168 if (resp->status == nlm_drop_reply)
171 dprintk("lockd: LOCK status %d\n", ntohl(resp->status));
173 nlm_release_host(host);
174 nlm_release_file(file);
179 nlmsvc_proc_cancel(struct svc_rqst *rqstp, struct nlm_args *argp,
180 struct nlm_res *resp)
182 struct nlm_host *host;
183 struct nlm_file *file;
185 dprintk("lockd: CANCEL called\n");
187 resp->cookie = argp->cookie;
189 /* Don't accept requests during grace period */
190 if (locks_in_grace()) {
191 resp->status = nlm_lck_denied_grace_period;
195 /* Obtain client and file */
196 if ((resp->status = nlmsvc_retrieve_args(rqstp, argp, &host, &file)))
197 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
199 /* Try to cancel request. */
200 resp->status = cast_status(nlmsvc_cancel_blocked(file, &argp->lock));
202 dprintk("lockd: CANCEL status %d\n", ntohl(resp->status));
203 nlm_release_host(host);
204 nlm_release_file(file);
209 * UNLOCK: release a lock
212 nlmsvc_proc_unlock(struct svc_rqst *rqstp, struct nlm_args *argp,
213 struct nlm_res *resp)
215 struct nlm_host *host;
216 struct nlm_file *file;
218 dprintk("lockd: UNLOCK called\n");
220 resp->cookie = argp->cookie;
222 /* Don't accept new lock requests during grace period */
223 if (locks_in_grace()) {
224 resp->status = nlm_lck_denied_grace_period;
228 /* Obtain client and file */
229 if ((resp->status = nlmsvc_retrieve_args(rqstp, argp, &host, &file)))
230 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
232 /* Now try to remove the lock */
233 resp->status = cast_status(nlmsvc_unlock(file, &argp->lock));
235 dprintk("lockd: UNLOCK status %d\n", ntohl(resp->status));
236 nlm_release_host(host);
237 nlm_release_file(file);
242 * GRANTED: A server calls us to tell that a process' lock request
246 nlmsvc_proc_granted(struct svc_rqst *rqstp, struct nlm_args *argp,
247 struct nlm_res *resp)
249 resp->cookie = argp->cookie;
251 dprintk("lockd: GRANTED called\n");
252 resp->status = nlmclnt_grant(svc_addr(rqstp), &argp->lock);
253 dprintk("lockd: GRANTED status %d\n", ntohl(resp->status));
258 * This is the generic lockd callback for async RPC calls
260 static void nlmsvc_callback_exit(struct rpc_task *task, void *data)
262 dprintk("lockd: %5u callback returned %d\n", task->tk_pid,
266 static void nlmsvc_callback_release(void *data)
269 nlm_release_call(data);
273 static const struct rpc_call_ops nlmsvc_callback_ops = {
274 .rpc_call_done = nlmsvc_callback_exit,
275 .rpc_release = nlmsvc_callback_release,
279 * `Async' versions of the above service routines. They aren't really,
280 * because we send the callback before the reply proper. I hope this
281 * doesn't break any clients.
283 static __be32 nlmsvc_callback(struct svc_rqst *rqstp, u32 proc, struct nlm_args *argp,
284 __be32 (*func)(struct svc_rqst *, struct nlm_args *, struct nlm_res *))
286 struct nlm_host *host;
287 struct nlm_rqst *call;
290 host = nlmsvc_lookup_host(rqstp,
294 return rpc_system_err;
296 call = nlm_alloc_call(host);
298 return rpc_system_err;
300 stat = func(rqstp, argp, &call->a_res);
302 nlm_release_call(call);
306 call->a_flags = RPC_TASK_ASYNC;
307 if (nlm_async_reply(call, proc, &nlmsvc_callback_ops) < 0)
308 return rpc_system_err;
312 static __be32 nlmsvc_proc_test_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
315 dprintk("lockd: TEST_MSG called\n");
316 return nlmsvc_callback(rqstp, NLMPROC_TEST_RES, argp, nlmsvc_proc_test);
319 static __be32 nlmsvc_proc_lock_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
322 dprintk("lockd: LOCK_MSG called\n");
323 return nlmsvc_callback(rqstp, NLMPROC_LOCK_RES, argp, nlmsvc_proc_lock);
326 static __be32 nlmsvc_proc_cancel_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
329 dprintk("lockd: CANCEL_MSG called\n");
330 return nlmsvc_callback(rqstp, NLMPROC_CANCEL_RES, argp, nlmsvc_proc_cancel);
334 nlmsvc_proc_unlock_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
337 dprintk("lockd: UNLOCK_MSG called\n");
338 return nlmsvc_callback(rqstp, NLMPROC_UNLOCK_RES, argp, nlmsvc_proc_unlock);
342 nlmsvc_proc_granted_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
345 dprintk("lockd: GRANTED_MSG called\n");
346 return nlmsvc_callback(rqstp, NLMPROC_GRANTED_RES, argp, nlmsvc_proc_granted);
350 * SHARE: create a DOS share or alter existing share.
353 nlmsvc_proc_share(struct svc_rqst *rqstp, struct nlm_args *argp,
354 struct nlm_res *resp)
356 struct nlm_host *host;
357 struct nlm_file *file;
359 dprintk("lockd: SHARE called\n");
361 resp->cookie = argp->cookie;
363 /* Don't accept new lock requests during grace period */
364 if (locks_in_grace() && !argp->reclaim) {
365 resp->status = nlm_lck_denied_grace_period;
369 /* Obtain client and file */
370 if ((resp->status = nlmsvc_retrieve_args(rqstp, argp, &host, &file)))
371 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
373 /* Now try to create the share */
374 resp->status = cast_status(nlmsvc_share_file(host, file, argp));
376 dprintk("lockd: SHARE status %d\n", ntohl(resp->status));
377 nlm_release_host(host);
378 nlm_release_file(file);
383 * UNSHARE: Release a DOS share.
386 nlmsvc_proc_unshare(struct svc_rqst *rqstp, struct nlm_args *argp,
387 struct nlm_res *resp)
389 struct nlm_host *host;
390 struct nlm_file *file;
392 dprintk("lockd: UNSHARE called\n");
394 resp->cookie = argp->cookie;
396 /* Don't accept requests during grace period */
397 if (locks_in_grace()) {
398 resp->status = nlm_lck_denied_grace_period;
402 /* Obtain client and file */
403 if ((resp->status = nlmsvc_retrieve_args(rqstp, argp, &host, &file)))
404 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
406 /* Now try to unshare the file */
407 resp->status = cast_status(nlmsvc_unshare_file(host, file, argp));
409 dprintk("lockd: UNSHARE status %d\n", ntohl(resp->status));
410 nlm_release_host(host);
411 nlm_release_file(file);
416 * NM_LOCK: Create an unmonitored lock
419 nlmsvc_proc_nm_lock(struct svc_rqst *rqstp, struct nlm_args *argp,
420 struct nlm_res *resp)
422 dprintk("lockd: NM_LOCK called\n");
424 argp->monitor = 0; /* just clean the monitor flag */
425 return nlmsvc_proc_lock(rqstp, argp, resp);
429 * FREE_ALL: Release all locks and shares held by client
432 nlmsvc_proc_free_all(struct svc_rqst *rqstp, struct nlm_args *argp,
435 struct nlm_host *host;
438 if (nlmsvc_retrieve_args(rqstp, argp, &host, NULL))
441 nlmsvc_free_host_resources(host);
442 nlm_release_host(host);
447 * SM_NOTIFY: private callback from statd (not part of official NLM proto)
450 nlmsvc_proc_sm_notify(struct svc_rqst *rqstp, struct nlm_reboot *argp,
453 dprintk("lockd: SM_NOTIFY called\n");
455 if (!nlm_privileged_requester(rqstp)) {
456 char buf[RPC_MAX_ADDRBUFLEN];
457 printk(KERN_WARNING "lockd: rejected NSM callback from %s\n",
458 svc_print_addr(rqstp, buf, sizeof(buf)));
459 return rpc_system_err;
462 nlm_host_rebooted(argp);
467 * client sent a GRANTED_RES, let's remove the associated block
470 nlmsvc_proc_granted_res(struct svc_rqst *rqstp, struct nlm_res *argp,
476 dprintk("lockd: GRANTED_RES called\n");
478 nlmsvc_grant_reply(&argp->cookie, argp->status);
483 * NLM Server procedures.
486 #define nlmsvc_encode_norep nlmsvc_encode_void
487 #define nlmsvc_decode_norep nlmsvc_decode_void
488 #define nlmsvc_decode_testres nlmsvc_decode_void
489 #define nlmsvc_decode_lockres nlmsvc_decode_void
490 #define nlmsvc_decode_unlockres nlmsvc_decode_void
491 #define nlmsvc_decode_cancelres nlmsvc_decode_void
492 #define nlmsvc_decode_grantedres nlmsvc_decode_void
494 #define nlmsvc_proc_none nlmsvc_proc_null
495 #define nlmsvc_proc_test_res nlmsvc_proc_null
496 #define nlmsvc_proc_lock_res nlmsvc_proc_null
497 #define nlmsvc_proc_cancel_res nlmsvc_proc_null
498 #define nlmsvc_proc_unlock_res nlmsvc_proc_null
500 struct nlm_void { int dummy; };
502 #define PROC(name, xargt, xrest, argt, rest, respsize) \
503 { .pc_func = (svc_procfunc) nlmsvc_proc_##name, \
504 .pc_decode = (kxdrproc_t) nlmsvc_decode_##xargt, \
505 .pc_encode = (kxdrproc_t) nlmsvc_encode_##xrest, \
506 .pc_release = NULL, \
507 .pc_argsize = sizeof(struct nlm_##argt), \
508 .pc_ressize = sizeof(struct nlm_##rest), \
509 .pc_xdrressize = respsize, \
512 #define Ck (1+XDR_QUADLEN(NLM_MAXCOOKIELEN)) /* cookie */
513 #define St 1 /* status */
514 #define No (1+1024/4) /* Net Obj */
515 #define Rg 2 /* range - offset + size */
517 struct svc_procedure nlmsvc_procedures[] = {
518 PROC(null, void, void, void, void, 1),
519 PROC(test, testargs, testres, args, res, Ck+St+2+No+Rg),
520 PROC(lock, lockargs, res, args, res, Ck+St),
521 PROC(cancel, cancargs, res, args, res, Ck+St),
522 PROC(unlock, unlockargs, res, args, res, Ck+St),
523 PROC(granted, testargs, res, args, res, Ck+St),
524 PROC(test_msg, testargs, norep, args, void, 1),
525 PROC(lock_msg, lockargs, norep, args, void, 1),
526 PROC(cancel_msg, cancargs, norep, args, void, 1),
527 PROC(unlock_msg, unlockargs, norep, args, void, 1),
528 PROC(granted_msg, testargs, norep, args, void, 1),
529 PROC(test_res, testres, norep, res, void, 1),
530 PROC(lock_res, lockres, norep, res, void, 1),
531 PROC(cancel_res, cancelres, norep, res, void, 1),
532 PROC(unlock_res, unlockres, norep, res, void, 1),
533 PROC(granted_res, res, norep, res, void, 1),
535 PROC(sm_notify, reboot, void, reboot, void, 1),
536 PROC(none, void, void, void, void, 1),
537 PROC(none, void, void, void, void, 1),
538 PROC(none, void, void, void, void, 1),
539 PROC(share, shareargs, shareres, args, res, Ck+St+1),
540 PROC(unshare, shareargs, shareres, args, res, Ck+St+1),
541 PROC(nm_lock, lockargs, res, args, res, Ck+St),
542 PROC(free_all, notify, void, args, void, 0),