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>
19 #include <linux/lockd/sm_inter.h>
22 #define NLMDBG_FACILITY NLMDBG_CLIENT
24 #ifdef CONFIG_LOCKD_V4
26 cast_to_nlm(__be32 status, u32 vers)
28 /* Note: status is assumed to be in network byte order !!! */
33 case nlm_lck_denied_nolocks:
35 case nlm_lck_denied_grace_period:
39 status = nlm_lck_denied;
42 status = nlm_lck_denied_nolocks;
48 #define cast_status(status) (cast_to_nlm(status, rqstp->rq_vers))
50 #define cast_status(status) (status)
54 * Obtain client and file from arguments
57 nlmsvc_retrieve_args(struct svc_rqst *rqstp, struct nlm_args *argp,
58 struct nlm_host **hostp, struct nlm_file **filp)
60 struct nlm_host *host = NULL;
61 struct nlm_file *file = NULL;
62 struct nlm_lock *lock = &argp->lock;
65 /* nfsd callbacks must have been installed for this procedure */
67 return nlm_lck_denied_nolocks;
69 /* Obtain host handle */
70 if (!(host = nlmsvc_lookup_host(rqstp, lock->caller, lock->len))
71 || (argp->monitor && nsm_monitor(host) < 0))
75 /* Obtain file pointer. Not used by FREE_ALL call. */
77 if ((error = nlm_lookup_file(rqstp, &file, &lock->fh)) != 0)
81 /* Set up the missing parts of the file_lock structure */
82 lock->fl.fl_file = file->f_file;
83 lock->fl.fl_owner = (fl_owner_t) host;
84 lock->fl.fl_lmops = &nlmsvc_lock_operations;
90 nlm_release_host(host);
93 return nlm_lck_denied_nolocks;
97 * NULL: Test for presence of service
100 nlmsvc_proc_null(struct svc_rqst *rqstp, void *argp, void *resp)
102 dprintk("lockd: NULL called\n");
107 * TEST: Check for conflicting lock
110 nlmsvc_proc_test(struct svc_rqst *rqstp, struct nlm_args *argp,
111 struct nlm_res *resp)
113 struct nlm_host *host;
114 struct nlm_file *file;
115 int rc = rpc_success;
117 dprintk("lockd: TEST called\n");
118 resp->cookie = argp->cookie;
120 /* Don't accept test requests during grace period */
121 if (nlmsvc_grace_period) {
122 resp->status = nlm_lck_denied_grace_period;
126 /* Obtain client and file */
127 if ((resp->status = nlmsvc_retrieve_args(rqstp, argp, &host, &file)))
128 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
130 /* Now check for conflicting locks */
131 resp->status = cast_status(nlmsvc_testlock(rqstp, file, host, &argp->lock, &resp->lock, &resp->cookie));
132 if (resp->status == nlm_drop_reply)
135 dprintk("lockd: TEST status %d vers %d\n",
136 ntohl(resp->status), rqstp->rq_vers);
138 nlm_release_host(host);
139 nlm_release_file(file);
144 nlmsvc_proc_lock(struct svc_rqst *rqstp, struct nlm_args *argp,
145 struct nlm_res *resp)
147 struct nlm_host *host;
148 struct nlm_file *file;
149 int rc = rpc_success;
151 dprintk("lockd: LOCK called\n");
153 resp->cookie = argp->cookie;
155 /* Don't accept new lock requests during grace period */
156 if (nlmsvc_grace_period && !argp->reclaim) {
157 resp->status = nlm_lck_denied_grace_period;
161 /* Obtain client and file */
162 if ((resp->status = nlmsvc_retrieve_args(rqstp, argp, &host, &file)))
163 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
166 /* If supplied state doesn't match current state, we assume it's
167 * an old request that time-warped somehow. Any error return would
168 * do in this case because it's irrelevant anyway.
170 * NB: We don't retrieve the remote host's state yet.
172 if (host->h_nsmstate && host->h_nsmstate != argp->state) {
173 resp->status = nlm_lck_denied_nolocks;
177 /* Now try to lock the file */
178 resp->status = cast_status(nlmsvc_lock(rqstp, file, host, &argp->lock,
179 argp->block, &argp->cookie));
180 if (resp->status == nlm_drop_reply)
183 dprintk("lockd: LOCK status %d\n", ntohl(resp->status));
185 nlm_release_host(host);
186 nlm_release_file(file);
191 nlmsvc_proc_cancel(struct svc_rqst *rqstp, struct nlm_args *argp,
192 struct nlm_res *resp)
194 struct nlm_host *host;
195 struct nlm_file *file;
197 dprintk("lockd: CANCEL called\n");
199 resp->cookie = argp->cookie;
201 /* Don't accept requests during grace period */
202 if (nlmsvc_grace_period) {
203 resp->status = nlm_lck_denied_grace_period;
207 /* Obtain client and file */
208 if ((resp->status = nlmsvc_retrieve_args(rqstp, argp, &host, &file)))
209 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
211 /* Try to cancel request. */
212 resp->status = cast_status(nlmsvc_cancel_blocked(file, &argp->lock));
214 dprintk("lockd: CANCEL status %d\n", ntohl(resp->status));
215 nlm_release_host(host);
216 nlm_release_file(file);
221 * UNLOCK: release a lock
224 nlmsvc_proc_unlock(struct svc_rqst *rqstp, struct nlm_args *argp,
225 struct nlm_res *resp)
227 struct nlm_host *host;
228 struct nlm_file *file;
230 dprintk("lockd: UNLOCK called\n");
232 resp->cookie = argp->cookie;
234 /* Don't accept new lock requests during grace period */
235 if (nlmsvc_grace_period) {
236 resp->status = nlm_lck_denied_grace_period;
240 /* Obtain client and file */
241 if ((resp->status = nlmsvc_retrieve_args(rqstp, argp, &host, &file)))
242 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
244 /* Now try to remove the lock */
245 resp->status = cast_status(nlmsvc_unlock(file, &argp->lock));
247 dprintk("lockd: UNLOCK status %d\n", ntohl(resp->status));
248 nlm_release_host(host);
249 nlm_release_file(file);
254 * GRANTED: A server calls us to tell that a process' lock request
258 nlmsvc_proc_granted(struct svc_rqst *rqstp, struct nlm_args *argp,
259 struct nlm_res *resp)
261 resp->cookie = argp->cookie;
263 dprintk("lockd: GRANTED called\n");
264 resp->status = nlmclnt_grant(svc_addr_in(rqstp), &argp->lock);
265 dprintk("lockd: GRANTED status %d\n", ntohl(resp->status));
270 * This is the generic lockd callback for async RPC calls
272 static void nlmsvc_callback_exit(struct rpc_task *task, void *data)
274 dprintk("lockd: %5u callback returned %d\n", task->tk_pid,
278 static void nlmsvc_callback_release(void *data)
280 nlm_release_call(data);
283 static const struct rpc_call_ops nlmsvc_callback_ops = {
284 .rpc_call_done = nlmsvc_callback_exit,
285 .rpc_release = nlmsvc_callback_release,
289 * `Async' versions of the above service routines. They aren't really,
290 * because we send the callback before the reply proper. I hope this
291 * doesn't break any clients.
293 static __be32 nlmsvc_callback(struct svc_rqst *rqstp, u32 proc, struct nlm_args *argp,
294 __be32 (*func)(struct svc_rqst *, struct nlm_args *, struct nlm_res *))
296 struct nlm_host *host;
297 struct nlm_rqst *call;
300 host = nlmsvc_lookup_host(rqstp,
304 return rpc_system_err;
306 call = nlm_alloc_call(host);
308 return rpc_system_err;
310 stat = func(rqstp, argp, &call->a_res);
312 nlm_release_call(call);
316 call->a_flags = RPC_TASK_ASYNC;
317 if (nlm_async_reply(call, proc, &nlmsvc_callback_ops) < 0)
318 return rpc_system_err;
322 static __be32 nlmsvc_proc_test_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
325 dprintk("lockd: TEST_MSG called\n");
326 return nlmsvc_callback(rqstp, NLMPROC_TEST_RES, argp, nlmsvc_proc_test);
329 static __be32 nlmsvc_proc_lock_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
332 dprintk("lockd: LOCK_MSG called\n");
333 return nlmsvc_callback(rqstp, NLMPROC_LOCK_RES, argp, nlmsvc_proc_lock);
336 static __be32 nlmsvc_proc_cancel_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
339 dprintk("lockd: CANCEL_MSG called\n");
340 return nlmsvc_callback(rqstp, NLMPROC_CANCEL_RES, argp, nlmsvc_proc_cancel);
344 nlmsvc_proc_unlock_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
347 dprintk("lockd: UNLOCK_MSG called\n");
348 return nlmsvc_callback(rqstp, NLMPROC_UNLOCK_RES, argp, nlmsvc_proc_unlock);
352 nlmsvc_proc_granted_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
355 dprintk("lockd: GRANTED_MSG called\n");
356 return nlmsvc_callback(rqstp, NLMPROC_GRANTED_RES, argp, nlmsvc_proc_granted);
360 * SHARE: create a DOS share or alter existing share.
363 nlmsvc_proc_share(struct svc_rqst *rqstp, struct nlm_args *argp,
364 struct nlm_res *resp)
366 struct nlm_host *host;
367 struct nlm_file *file;
369 dprintk("lockd: SHARE called\n");
371 resp->cookie = argp->cookie;
373 /* Don't accept new lock requests during grace period */
374 if (nlmsvc_grace_period && !argp->reclaim) {
375 resp->status = nlm_lck_denied_grace_period;
379 /* Obtain client and file */
380 if ((resp->status = nlmsvc_retrieve_args(rqstp, argp, &host, &file)))
381 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
383 /* Now try to create the share */
384 resp->status = cast_status(nlmsvc_share_file(host, file, argp));
386 dprintk("lockd: SHARE status %d\n", ntohl(resp->status));
387 nlm_release_host(host);
388 nlm_release_file(file);
393 * UNSHARE: Release a DOS share.
396 nlmsvc_proc_unshare(struct svc_rqst *rqstp, struct nlm_args *argp,
397 struct nlm_res *resp)
399 struct nlm_host *host;
400 struct nlm_file *file;
402 dprintk("lockd: UNSHARE called\n");
404 resp->cookie = argp->cookie;
406 /* Don't accept requests during grace period */
407 if (nlmsvc_grace_period) {
408 resp->status = nlm_lck_denied_grace_period;
412 /* Obtain client and file */
413 if ((resp->status = nlmsvc_retrieve_args(rqstp, argp, &host, &file)))
414 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
416 /* Now try to unshare the file */
417 resp->status = cast_status(nlmsvc_unshare_file(host, file, argp));
419 dprintk("lockd: UNSHARE status %d\n", ntohl(resp->status));
420 nlm_release_host(host);
421 nlm_release_file(file);
426 * NM_LOCK: Create an unmonitored lock
429 nlmsvc_proc_nm_lock(struct svc_rqst *rqstp, struct nlm_args *argp,
430 struct nlm_res *resp)
432 dprintk("lockd: NM_LOCK called\n");
434 argp->monitor = 0; /* just clean the monitor flag */
435 return nlmsvc_proc_lock(rqstp, argp, resp);
439 * FREE_ALL: Release all locks and shares held by client
442 nlmsvc_proc_free_all(struct svc_rqst *rqstp, struct nlm_args *argp,
445 struct nlm_host *host;
448 if (nlmsvc_retrieve_args(rqstp, argp, &host, NULL))
451 nlmsvc_free_host_resources(host);
452 nlm_release_host(host);
457 * SM_NOTIFY: private callback from statd (not part of official NLM proto)
460 nlmsvc_proc_sm_notify(struct svc_rqst *rqstp, struct nlm_reboot *argp,
463 struct sockaddr_in saddr;
465 memcpy(&saddr, svc_addr_in(rqstp), sizeof(saddr));
467 dprintk("lockd: SM_NOTIFY called\n");
468 if (saddr.sin_addr.s_addr != htonl(INADDR_LOOPBACK)
469 || ntohs(saddr.sin_port) >= 1024) {
470 char buf[RPC_MAX_ADDRBUFLEN];
471 printk(KERN_WARNING "lockd: rejected NSM callback from %s\n",
472 svc_print_addr(rqstp, buf, sizeof(buf)));
473 return rpc_system_err;
476 /* Obtain the host pointer for this NFS server and try to
477 * reclaim all locks we hold on this server.
479 memset(&saddr, 0, sizeof(saddr));
480 saddr.sin_addr.s_addr = argp->addr;
481 nlm_host_rebooted(&saddr, argp->mon, argp->len, argp->state);
487 * client sent a GRANTED_RES, let's remove the associated block
490 nlmsvc_proc_granted_res(struct svc_rqst *rqstp, struct nlm_res *argp,
496 dprintk("lockd: GRANTED_RES called\n");
498 nlmsvc_grant_reply(&argp->cookie, argp->status);
503 * NLM Server procedures.
506 #define nlmsvc_encode_norep nlmsvc_encode_void
507 #define nlmsvc_decode_norep nlmsvc_decode_void
508 #define nlmsvc_decode_testres nlmsvc_decode_void
509 #define nlmsvc_decode_lockres nlmsvc_decode_void
510 #define nlmsvc_decode_unlockres nlmsvc_decode_void
511 #define nlmsvc_decode_cancelres nlmsvc_decode_void
512 #define nlmsvc_decode_grantedres nlmsvc_decode_void
514 #define nlmsvc_proc_none nlmsvc_proc_null
515 #define nlmsvc_proc_test_res nlmsvc_proc_null
516 #define nlmsvc_proc_lock_res nlmsvc_proc_null
517 #define nlmsvc_proc_cancel_res nlmsvc_proc_null
518 #define nlmsvc_proc_unlock_res nlmsvc_proc_null
520 struct nlm_void { int dummy; };
522 #define PROC(name, xargt, xrest, argt, rest, respsize) \
523 { .pc_func = (svc_procfunc) nlmsvc_proc_##name, \
524 .pc_decode = (kxdrproc_t) nlmsvc_decode_##xargt, \
525 .pc_encode = (kxdrproc_t) nlmsvc_encode_##xrest, \
526 .pc_release = NULL, \
527 .pc_argsize = sizeof(struct nlm_##argt), \
528 .pc_ressize = sizeof(struct nlm_##rest), \
529 .pc_xdrressize = respsize, \
532 #define Ck (1+XDR_QUADLEN(NLM_MAXCOOKIELEN)) /* cookie */
533 #define St 1 /* status */
534 #define No (1+1024/4) /* Net Obj */
535 #define Rg 2 /* range - offset + size */
537 struct svc_procedure nlmsvc_procedures[] = {
538 PROC(null, void, void, void, void, 1),
539 PROC(test, testargs, testres, args, res, Ck+St+2+No+Rg),
540 PROC(lock, lockargs, res, args, res, Ck+St),
541 PROC(cancel, cancargs, res, args, res, Ck+St),
542 PROC(unlock, unlockargs, res, args, res, Ck+St),
543 PROC(granted, testargs, res, args, res, Ck+St),
544 PROC(test_msg, testargs, norep, args, void, 1),
545 PROC(lock_msg, lockargs, norep, args, void, 1),
546 PROC(cancel_msg, cancargs, norep, args, void, 1),
547 PROC(unlock_msg, unlockargs, norep, args, void, 1),
548 PROC(granted_msg, testargs, norep, args, void, 1),
549 PROC(test_res, testres, norep, res, void, 1),
550 PROC(lock_res, lockres, norep, res, void, 1),
551 PROC(cancel_res, cancelres, norep, res, void, 1),
552 PROC(unlock_res, unlockres, norep, res, void, 1),
553 PROC(granted_res, res, norep, res, void, 1),
555 PROC(sm_notify, reboot, void, reboot, void, 1),
556 PROC(none, void, void, void, void, 1),
557 PROC(none, void, void, void, void, 1),
558 PROC(none, void, void, void, void, 1),
559 PROC(share, shareargs, shareres, args, res, Ck+St+1),
560 PROC(unshare, shareargs, shareres, args, res, Ck+St+1),
561 PROC(nm_lock, lockargs, res, args, res, Ck+St),
562 PROC(free_all, notify, void, args, void, 0),