2 * linux/fs/lockd/svc4proc.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>
19 #include <linux/lockd/sm_inter.h>
22 #define NLMDBG_FACILITY NLMDBG_CLIENT
25 * Obtain client and file from arguments
28 nlm4svc_retrieve_args(struct svc_rqst *rqstp, struct nlm_args *argp,
29 struct nlm_host **hostp, struct nlm_file **filp)
31 struct nlm_host *host = NULL;
32 struct nlm_file *file = NULL;
33 struct nlm_lock *lock = &argp->lock;
36 /* nfsd callbacks must have been installed for this procedure */
38 return nlm_lck_denied_nolocks;
40 /* Obtain host handle */
41 if (!(host = nlmsvc_lookup_host(rqstp, lock->caller, lock->len))
42 || (argp->monitor && nsm_monitor(host) < 0))
46 /* Obtain file pointer. Not used by FREE_ALL call. */
48 if ((error = nlm_lookup_file(rqstp, &file, &lock->fh)) != 0)
52 /* Set up the missing parts of the file_lock structure */
53 lock->fl.fl_file = file->f_file;
54 lock->fl.fl_owner = (fl_owner_t) host;
55 lock->fl.fl_lmops = &nlmsvc_lock_operations;
61 nlm_release_host(host);
64 return nlm_lck_denied_nolocks;
68 * NULL: Test for presence of service
71 nlm4svc_proc_null(struct svc_rqst *rqstp, void *argp, void *resp)
73 dprintk("lockd: NULL called\n");
78 * TEST: Check for conflicting lock
81 nlm4svc_proc_test(struct svc_rqst *rqstp, struct nlm_args *argp,
84 struct nlm_host *host;
85 struct nlm_file *file;
86 __be32 rc = rpc_success;
88 dprintk("lockd: TEST4 called\n");
89 resp->cookie = argp->cookie;
91 /* Obtain client and file */
92 if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
93 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
95 /* Now check for conflicting locks */
96 resp->status = nlmsvc_testlock(rqstp, file, host, &argp->lock, &resp->lock, &resp->cookie);
97 if (resp->status == nlm_drop_reply)
100 dprintk("lockd: TEST4 status %d\n", ntohl(resp->status));
102 nlm_release_host(host);
103 nlm_release_file(file);
108 nlm4svc_proc_lock(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: LOCK called\n");
117 resp->cookie = argp->cookie;
119 /* Obtain client and file */
120 if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
121 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
124 /* If supplied state doesn't match current state, we assume it's
125 * an old request that time-warped somehow. Any error return would
126 * do in this case because it's irrelevant anyway.
128 * NB: We don't retrieve the remote host's state yet.
130 if (host->h_nsmstate && host->h_nsmstate != argp->state) {
131 resp->status = nlm_lck_denied_nolocks;
135 /* Now try to lock the file */
136 resp->status = nlmsvc_lock(rqstp, file, host, &argp->lock,
137 argp->block, &argp->cookie,
139 if (resp->status == nlm_drop_reply)
142 dprintk("lockd: LOCK status %d\n", ntohl(resp->status));
144 nlm_release_host(host);
145 nlm_release_file(file);
150 nlm4svc_proc_cancel(struct svc_rqst *rqstp, struct nlm_args *argp,
151 struct nlm_res *resp)
153 struct nlm_host *host;
154 struct nlm_file *file;
156 dprintk("lockd: CANCEL called\n");
158 resp->cookie = argp->cookie;
160 /* Don't accept requests during grace period */
161 if (locks_in_grace()) {
162 resp->status = nlm_lck_denied_grace_period;
166 /* Obtain client and file */
167 if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
168 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
170 /* Try to cancel request. */
171 resp->status = nlmsvc_cancel_blocked(file, &argp->lock);
173 dprintk("lockd: CANCEL status %d\n", ntohl(resp->status));
174 nlm_release_host(host);
175 nlm_release_file(file);
180 * UNLOCK: release a lock
183 nlm4svc_proc_unlock(struct svc_rqst *rqstp, struct nlm_args *argp,
184 struct nlm_res *resp)
186 struct nlm_host *host;
187 struct nlm_file *file;
189 dprintk("lockd: UNLOCK called\n");
191 resp->cookie = argp->cookie;
193 /* Don't accept new lock requests during grace period */
194 if (locks_in_grace()) {
195 resp->status = nlm_lck_denied_grace_period;
199 /* Obtain client and file */
200 if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
201 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
203 /* Now try to remove the lock */
204 resp->status = nlmsvc_unlock(file, &argp->lock);
206 dprintk("lockd: UNLOCK status %d\n", ntohl(resp->status));
207 nlm_release_host(host);
208 nlm_release_file(file);
213 * GRANTED: A server calls us to tell that a process' lock request
217 nlm4svc_proc_granted(struct svc_rqst *rqstp, struct nlm_args *argp,
218 struct nlm_res *resp)
220 resp->cookie = argp->cookie;
222 dprintk("lockd: GRANTED called\n");
223 resp->status = nlmclnt_grant(svc_addr(rqstp), &argp->lock);
224 dprintk("lockd: GRANTED status %d\n", ntohl(resp->status));
229 * This is the generic lockd callback for async RPC calls
231 static void nlm4svc_callback_exit(struct rpc_task *task, void *data)
233 dprintk("lockd: %5u callback returned %d\n", task->tk_pid,
237 static void nlm4svc_callback_release(void *data)
240 nlm_release_call(data);
244 static const struct rpc_call_ops nlm4svc_callback_ops = {
245 .rpc_call_done = nlm4svc_callback_exit,
246 .rpc_release = nlm4svc_callback_release,
250 * `Async' versions of the above service routines. They aren't really,
251 * because we send the callback before the reply proper. I hope this
252 * doesn't break any clients.
254 static __be32 nlm4svc_callback(struct svc_rqst *rqstp, u32 proc, struct nlm_args *argp,
255 __be32 (*func)(struct svc_rqst *, struct nlm_args *, struct nlm_res *))
257 struct nlm_host *host;
258 struct nlm_rqst *call;
261 host = nlmsvc_lookup_host(rqstp,
265 return rpc_system_err;
267 call = nlm_alloc_call(host);
269 return rpc_system_err;
271 stat = func(rqstp, argp, &call->a_res);
273 nlm_release_call(call);
277 call->a_flags = RPC_TASK_ASYNC;
278 if (nlm_async_reply(call, proc, &nlm4svc_callback_ops) < 0)
279 return rpc_system_err;
283 static __be32 nlm4svc_proc_test_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
286 dprintk("lockd: TEST_MSG called\n");
287 return nlm4svc_callback(rqstp, NLMPROC_TEST_RES, argp, nlm4svc_proc_test);
290 static __be32 nlm4svc_proc_lock_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
293 dprintk("lockd: LOCK_MSG called\n");
294 return nlm4svc_callback(rqstp, NLMPROC_LOCK_RES, argp, nlm4svc_proc_lock);
297 static __be32 nlm4svc_proc_cancel_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
300 dprintk("lockd: CANCEL_MSG called\n");
301 return nlm4svc_callback(rqstp, NLMPROC_CANCEL_RES, argp, nlm4svc_proc_cancel);
304 static __be32 nlm4svc_proc_unlock_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
307 dprintk("lockd: UNLOCK_MSG called\n");
308 return nlm4svc_callback(rqstp, NLMPROC_UNLOCK_RES, argp, nlm4svc_proc_unlock);
311 static __be32 nlm4svc_proc_granted_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
314 dprintk("lockd: GRANTED_MSG called\n");
315 return nlm4svc_callback(rqstp, NLMPROC_GRANTED_RES, argp, nlm4svc_proc_granted);
319 * SHARE: create a DOS share or alter existing share.
322 nlm4svc_proc_share(struct svc_rqst *rqstp, struct nlm_args *argp,
323 struct nlm_res *resp)
325 struct nlm_host *host;
326 struct nlm_file *file;
328 dprintk("lockd: SHARE called\n");
330 resp->cookie = argp->cookie;
332 /* Don't accept new lock requests during grace period */
333 if (locks_in_grace() && !argp->reclaim) {
334 resp->status = nlm_lck_denied_grace_period;
338 /* Obtain client and file */
339 if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
340 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
342 /* Now try to create the share */
343 resp->status = nlmsvc_share_file(host, file, argp);
345 dprintk("lockd: SHARE status %d\n", ntohl(resp->status));
346 nlm_release_host(host);
347 nlm_release_file(file);
352 * UNSHARE: Release a DOS share.
355 nlm4svc_proc_unshare(struct svc_rqst *rqstp, struct nlm_args *argp,
356 struct nlm_res *resp)
358 struct nlm_host *host;
359 struct nlm_file *file;
361 dprintk("lockd: UNSHARE called\n");
363 resp->cookie = argp->cookie;
365 /* Don't accept requests during grace period */
366 if (locks_in_grace()) {
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 lock the file */
376 resp->status = nlmsvc_unshare_file(host, file, argp);
378 dprintk("lockd: UNSHARE status %d\n", ntohl(resp->status));
379 nlm_release_host(host);
380 nlm_release_file(file);
385 * NM_LOCK: Create an unmonitored lock
388 nlm4svc_proc_nm_lock(struct svc_rqst *rqstp, struct nlm_args *argp,
389 struct nlm_res *resp)
391 dprintk("lockd: NM_LOCK called\n");
393 argp->monitor = 0; /* just clean the monitor flag */
394 return nlm4svc_proc_lock(rqstp, argp, resp);
398 * FREE_ALL: Release all locks and shares held by client
401 nlm4svc_proc_free_all(struct svc_rqst *rqstp, struct nlm_args *argp,
404 struct nlm_host *host;
407 if (nlm4svc_retrieve_args(rqstp, argp, &host, NULL))
410 nlmsvc_free_host_resources(host);
411 nlm_release_host(host);
416 * SM_NOTIFY: private callback from statd (not part of official NLM proto)
419 nlm4svc_proc_sm_notify(struct svc_rqst *rqstp, struct nlm_reboot *argp,
422 struct sockaddr_in saddr;
424 dprintk("lockd: SM_NOTIFY called\n");
426 if (!nlm_privileged_requester(rqstp)) {
427 char buf[RPC_MAX_ADDRBUFLEN];
428 printk(KERN_WARNING "lockd: rejected NSM callback from %s\n",
429 svc_print_addr(rqstp, buf, sizeof(buf)));
430 return rpc_system_err;
433 /* Obtain the host pointer for this NFS server and try to
434 * reclaim all locks we hold on this server.
436 memset(&saddr, 0, sizeof(saddr));
437 saddr.sin_family = AF_INET;
438 saddr.sin_addr.s_addr = argp->addr;
439 nlm_host_rebooted(&saddr, argp->mon, argp->len, argp->state);
445 * client sent a GRANTED_RES, let's remove the associated block
448 nlm4svc_proc_granted_res(struct svc_rqst *rqstp, struct nlm_res *argp,
454 dprintk("lockd: GRANTED_RES called\n");
456 nlmsvc_grant_reply(&argp->cookie, argp->status);
462 * NLM Server procedures.
465 #define nlm4svc_encode_norep nlm4svc_encode_void
466 #define nlm4svc_decode_norep nlm4svc_decode_void
467 #define nlm4svc_decode_testres nlm4svc_decode_void
468 #define nlm4svc_decode_lockres nlm4svc_decode_void
469 #define nlm4svc_decode_unlockres nlm4svc_decode_void
470 #define nlm4svc_decode_cancelres nlm4svc_decode_void
471 #define nlm4svc_decode_grantedres nlm4svc_decode_void
473 #define nlm4svc_proc_none nlm4svc_proc_null
474 #define nlm4svc_proc_test_res nlm4svc_proc_null
475 #define nlm4svc_proc_lock_res nlm4svc_proc_null
476 #define nlm4svc_proc_cancel_res nlm4svc_proc_null
477 #define nlm4svc_proc_unlock_res nlm4svc_proc_null
479 struct nlm_void { int dummy; };
481 #define PROC(name, xargt, xrest, argt, rest, respsize) \
482 { .pc_func = (svc_procfunc) nlm4svc_proc_##name, \
483 .pc_decode = (kxdrproc_t) nlm4svc_decode_##xargt, \
484 .pc_encode = (kxdrproc_t) nlm4svc_encode_##xrest, \
485 .pc_release = NULL, \
486 .pc_argsize = sizeof(struct nlm_##argt), \
487 .pc_ressize = sizeof(struct nlm_##rest), \
488 .pc_xdrressize = respsize, \
490 #define Ck (1+XDR_QUADLEN(NLM_MAXCOOKIELEN)) /* cookie */
491 #define No (1+1024/4) /* netobj */
492 #define St 1 /* status */
493 #define Rg 4 /* range (offset + length) */
494 struct svc_procedure nlmsvc_procedures4[] = {
495 PROC(null, void, void, void, void, 1),
496 PROC(test, testargs, testres, args, res, Ck+St+2+No+Rg),
497 PROC(lock, lockargs, res, args, res, Ck+St),
498 PROC(cancel, cancargs, res, args, res, Ck+St),
499 PROC(unlock, unlockargs, res, args, res, Ck+St),
500 PROC(granted, testargs, res, args, res, Ck+St),
501 PROC(test_msg, testargs, norep, args, void, 1),
502 PROC(lock_msg, lockargs, norep, args, void, 1),
503 PROC(cancel_msg, cancargs, norep, args, void, 1),
504 PROC(unlock_msg, unlockargs, norep, args, void, 1),
505 PROC(granted_msg, testargs, norep, args, void, 1),
506 PROC(test_res, testres, norep, res, void, 1),
507 PROC(lock_res, lockres, norep, res, void, 1),
508 PROC(cancel_res, cancelres, norep, res, void, 1),
509 PROC(unlock_res, unlockres, norep, res, void, 1),
510 PROC(granted_res, res, norep, res, void, 1),
512 PROC(sm_notify, reboot, void, reboot, void, 1),
513 PROC(none, void, void, void, void, 0),
514 PROC(none, void, void, void, void, 0),
515 PROC(none, void, void, void, void, 0),
516 PROC(share, shareargs, shareres, args, res, Ck+St+1),
517 PROC(unshare, shareargs, shareres, args, res, Ck+St+1),
518 PROC(nm_lock, lockargs, res, args, res, Ck+St),
519 PROC(free_all, notify, void, args, void, 1),