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;
62 nlm_release_host(host);
65 return nlm_lck_denied_nolocks;
69 * NULL: Test for presence of service
72 nlm4svc_proc_null(struct svc_rqst *rqstp, void *argp, void *resp)
74 dprintk("lockd: NULL called\n");
79 * TEST: Check for conflicting lock
82 nlm4svc_proc_test(struct svc_rqst *rqstp, struct nlm_args *argp,
85 struct nlm_host *host;
86 struct nlm_file *file;
88 dprintk("lockd: TEST4 called\n");
89 resp->cookie = argp->cookie;
91 /* Don't accept test requests during grace period */
92 if (nlmsvc_grace_period) {
93 resp->status = nlm_lck_denied_grace_period;
97 /* Obtain client and file */
98 if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
99 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
101 /* Now check for conflicting locks */
102 resp->status = nlmsvc_testlock(rqstp, file, &argp->lock, &resp->lock, &resp->cookie);
103 if (resp->status == nlm_drop_reply)
104 return rpc_drop_reply;
106 dprintk("lockd: TEST4 status %d\n", ntohl(resp->status));
107 nlm_release_host(host);
108 nlm_release_file(file);
113 nlm4svc_proc_lock(struct svc_rqst *rqstp, struct nlm_args *argp,
114 struct nlm_res *resp)
116 struct nlm_host *host;
117 struct nlm_file *file;
119 dprintk("lockd: LOCK called\n");
121 resp->cookie = argp->cookie;
123 /* Don't accept new lock requests during grace period */
124 if (nlmsvc_grace_period && !argp->reclaim) {
125 resp->status = nlm_lck_denied_grace_period;
129 /* Obtain client and file */
130 if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
131 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
134 /* If supplied state doesn't match current state, we assume it's
135 * an old request that time-warped somehow. Any error return would
136 * do in this case because it's irrelevant anyway.
138 * NB: We don't retrieve the remote host's state yet.
140 if (host->h_nsmstate && host->h_nsmstate != argp->state) {
141 resp->status = nlm_lck_denied_nolocks;
145 /* Now try to lock the file */
146 resp->status = nlmsvc_lock(rqstp, file, &argp->lock,
147 argp->block, &argp->cookie);
149 dprintk("lockd: LOCK status %d\n", ntohl(resp->status));
150 nlm_release_host(host);
151 nlm_release_file(file);
156 nlm4svc_proc_cancel(struct svc_rqst *rqstp, struct nlm_args *argp,
157 struct nlm_res *resp)
159 struct nlm_host *host;
160 struct nlm_file *file;
162 dprintk("lockd: CANCEL called\n");
164 resp->cookie = argp->cookie;
166 /* Don't accept requests during grace period */
167 if (nlmsvc_grace_period) {
168 resp->status = nlm_lck_denied_grace_period;
172 /* Obtain client and file */
173 if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
174 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
176 /* Try to cancel request. */
177 resp->status = nlmsvc_cancel_blocked(file, &argp->lock);
179 dprintk("lockd: CANCEL status %d\n", ntohl(resp->status));
180 nlm_release_host(host);
181 nlm_release_file(file);
186 * UNLOCK: release a lock
189 nlm4svc_proc_unlock(struct svc_rqst *rqstp, struct nlm_args *argp,
190 struct nlm_res *resp)
192 struct nlm_host *host;
193 struct nlm_file *file;
195 dprintk("lockd: UNLOCK called\n");
197 resp->cookie = argp->cookie;
199 /* Don't accept new lock requests during grace period */
200 if (nlmsvc_grace_period) {
201 resp->status = nlm_lck_denied_grace_period;
205 /* Obtain client and file */
206 if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
207 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
209 /* Now try to remove the lock */
210 resp->status = nlmsvc_unlock(file, &argp->lock);
212 dprintk("lockd: UNLOCK status %d\n", ntohl(resp->status));
213 nlm_release_host(host);
214 nlm_release_file(file);
219 * GRANTED: A server calls us to tell that a process' lock request
223 nlm4svc_proc_granted(struct svc_rqst *rqstp, struct nlm_args *argp,
224 struct nlm_res *resp)
226 resp->cookie = argp->cookie;
228 dprintk("lockd: GRANTED called\n");
229 resp->status = nlmclnt_grant(svc_addr_in(rqstp), &argp->lock);
230 dprintk("lockd: GRANTED status %d\n", ntohl(resp->status));
235 * This is the generic lockd callback for async RPC calls
237 static void nlm4svc_callback_exit(struct rpc_task *task, void *data)
239 dprintk("lockd: %5u callback returned %d\n", task->tk_pid,
243 static void nlm4svc_callback_release(void *data)
245 nlm_release_call(data);
248 static const struct rpc_call_ops nlm4svc_callback_ops = {
249 .rpc_call_done = nlm4svc_callback_exit,
250 .rpc_release = nlm4svc_callback_release,
254 * `Async' versions of the above service routines. They aren't really,
255 * because we send the callback before the reply proper. I hope this
256 * doesn't break any clients.
258 static __be32 nlm4svc_callback(struct svc_rqst *rqstp, u32 proc, struct nlm_args *argp,
259 __be32 (*func)(struct svc_rqst *, struct nlm_args *, struct nlm_res *))
261 struct nlm_host *host;
262 struct nlm_rqst *call;
265 host = nlmsvc_lookup_host(rqstp,
269 return rpc_system_err;
271 call = nlm_alloc_call(host);
273 return rpc_system_err;
275 stat = func(rqstp, argp, &call->a_res);
277 nlm_release_call(call);
281 call->a_flags = RPC_TASK_ASYNC;
282 if (nlm_async_reply(call, proc, &nlm4svc_callback_ops) < 0)
283 return rpc_system_err;
287 static __be32 nlm4svc_proc_test_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
290 dprintk("lockd: TEST_MSG called\n");
291 return nlm4svc_callback(rqstp, NLMPROC_TEST_RES, argp, nlm4svc_proc_test);
294 static __be32 nlm4svc_proc_lock_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
297 dprintk("lockd: LOCK_MSG called\n");
298 return nlm4svc_callback(rqstp, NLMPROC_LOCK_RES, argp, nlm4svc_proc_lock);
301 static __be32 nlm4svc_proc_cancel_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
304 dprintk("lockd: CANCEL_MSG called\n");
305 return nlm4svc_callback(rqstp, NLMPROC_CANCEL_RES, argp, nlm4svc_proc_cancel);
308 static __be32 nlm4svc_proc_unlock_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
311 dprintk("lockd: UNLOCK_MSG called\n");
312 return nlm4svc_callback(rqstp, NLMPROC_UNLOCK_RES, argp, nlm4svc_proc_unlock);
315 static __be32 nlm4svc_proc_granted_msg(struct svc_rqst *rqstp, struct nlm_args *argp,
318 dprintk("lockd: GRANTED_MSG called\n");
319 return nlm4svc_callback(rqstp, NLMPROC_GRANTED_RES, argp, nlm4svc_proc_granted);
323 * SHARE: create a DOS share or alter existing share.
326 nlm4svc_proc_share(struct svc_rqst *rqstp, struct nlm_args *argp,
327 struct nlm_res *resp)
329 struct nlm_host *host;
330 struct nlm_file *file;
332 dprintk("lockd: SHARE called\n");
334 resp->cookie = argp->cookie;
336 /* Don't accept new lock requests during grace period */
337 if (nlmsvc_grace_period && !argp->reclaim) {
338 resp->status = nlm_lck_denied_grace_period;
342 /* Obtain client and file */
343 if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
344 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
346 /* Now try to create the share */
347 resp->status = nlmsvc_share_file(host, file, argp);
349 dprintk("lockd: SHARE status %d\n", ntohl(resp->status));
350 nlm_release_host(host);
351 nlm_release_file(file);
356 * UNSHARE: Release a DOS share.
359 nlm4svc_proc_unshare(struct svc_rqst *rqstp, struct nlm_args *argp,
360 struct nlm_res *resp)
362 struct nlm_host *host;
363 struct nlm_file *file;
365 dprintk("lockd: UNSHARE called\n");
367 resp->cookie = argp->cookie;
369 /* Don't accept requests during grace period */
370 if (nlmsvc_grace_period) {
371 resp->status = nlm_lck_denied_grace_period;
375 /* Obtain client and file */
376 if ((resp->status = nlm4svc_retrieve_args(rqstp, argp, &host, &file)))
377 return resp->status == nlm_drop_reply ? rpc_drop_reply :rpc_success;
379 /* Now try to lock the file */
380 resp->status = nlmsvc_unshare_file(host, file, argp);
382 dprintk("lockd: UNSHARE status %d\n", ntohl(resp->status));
383 nlm_release_host(host);
384 nlm_release_file(file);
389 * NM_LOCK: Create an unmonitored lock
392 nlm4svc_proc_nm_lock(struct svc_rqst *rqstp, struct nlm_args *argp,
393 struct nlm_res *resp)
395 dprintk("lockd: NM_LOCK called\n");
397 argp->monitor = 0; /* just clean the monitor flag */
398 return nlm4svc_proc_lock(rqstp, argp, resp);
402 * FREE_ALL: Release all locks and shares held by client
405 nlm4svc_proc_free_all(struct svc_rqst *rqstp, struct nlm_args *argp,
408 struct nlm_host *host;
411 if (nlm4svc_retrieve_args(rqstp, argp, &host, NULL))
414 nlmsvc_free_host_resources(host);
415 nlm_release_host(host);
420 * SM_NOTIFY: private callback from statd (not part of official NLM proto)
423 nlm4svc_proc_sm_notify(struct svc_rqst *rqstp, struct nlm_reboot *argp,
426 struct sockaddr_in saddr;
428 memcpy(&saddr, svc_addr_in(rqstp), sizeof(saddr));
430 dprintk("lockd: SM_NOTIFY called\n");
431 if (saddr.sin_addr.s_addr != htonl(INADDR_LOOPBACK)
432 || ntohs(saddr.sin_port) >= 1024) {
433 char buf[RPC_MAX_ADDRBUFLEN];
434 printk(KERN_WARNING "lockd: rejected NSM callback from %s\n",
435 svc_print_addr(rqstp, buf, sizeof(buf)));
436 return rpc_system_err;
439 /* Obtain the host pointer for this NFS server and try to
440 * reclaim all locks we hold on this server.
442 memset(&saddr, 0, sizeof(saddr));
443 saddr.sin_addr.s_addr = argp->addr;
444 nlm_host_rebooted(&saddr, argp->mon, argp->len, argp->state);
450 * client sent a GRANTED_RES, let's remove the associated block
453 nlm4svc_proc_granted_res(struct svc_rqst *rqstp, struct nlm_res *argp,
459 dprintk("lockd: GRANTED_RES called\n");
461 nlmsvc_grant_reply(&argp->cookie, argp->status);
467 * NLM Server procedures.
470 #define nlm4svc_encode_norep nlm4svc_encode_void
471 #define nlm4svc_decode_norep nlm4svc_decode_void
472 #define nlm4svc_decode_testres nlm4svc_decode_void
473 #define nlm4svc_decode_lockres nlm4svc_decode_void
474 #define nlm4svc_decode_unlockres nlm4svc_decode_void
475 #define nlm4svc_decode_cancelres nlm4svc_decode_void
476 #define nlm4svc_decode_grantedres nlm4svc_decode_void
478 #define nlm4svc_proc_none nlm4svc_proc_null
479 #define nlm4svc_proc_test_res nlm4svc_proc_null
480 #define nlm4svc_proc_lock_res nlm4svc_proc_null
481 #define nlm4svc_proc_cancel_res nlm4svc_proc_null
482 #define nlm4svc_proc_unlock_res nlm4svc_proc_null
484 struct nlm_void { int dummy; };
486 #define PROC(name, xargt, xrest, argt, rest, respsize) \
487 { .pc_func = (svc_procfunc) nlm4svc_proc_##name, \
488 .pc_decode = (kxdrproc_t) nlm4svc_decode_##xargt, \
489 .pc_encode = (kxdrproc_t) nlm4svc_encode_##xrest, \
490 .pc_release = NULL, \
491 .pc_argsize = sizeof(struct nlm_##argt), \
492 .pc_ressize = sizeof(struct nlm_##rest), \
493 .pc_xdrressize = respsize, \
495 #define Ck (1+XDR_QUADLEN(NLM_MAXCOOKIELEN)) /* cookie */
496 #define No (1+1024/4) /* netobj */
497 #define St 1 /* status */
498 #define Rg 4 /* range (offset + length) */
499 struct svc_procedure nlmsvc_procedures4[] = {
500 PROC(null, void, void, void, void, 1),
501 PROC(test, testargs, testres, args, res, Ck+St+2+No+Rg),
502 PROC(lock, lockargs, res, args, res, Ck+St),
503 PROC(cancel, cancargs, res, args, res, Ck+St),
504 PROC(unlock, unlockargs, res, args, res, Ck+St),
505 PROC(granted, testargs, res, args, res, Ck+St),
506 PROC(test_msg, testargs, norep, args, void, 1),
507 PROC(lock_msg, lockargs, norep, args, void, 1),
508 PROC(cancel_msg, cancargs, norep, args, void, 1),
509 PROC(unlock_msg, unlockargs, norep, args, void, 1),
510 PROC(granted_msg, testargs, norep, args, void, 1),
511 PROC(test_res, testres, norep, res, void, 1),
512 PROC(lock_res, lockres, norep, res, void, 1),
513 PROC(cancel_res, cancelres, norep, res, void, 1),
514 PROC(unlock_res, unlockres, norep, res, void, 1),
515 PROC(granted_res, res, norep, res, void, 1),
517 PROC(sm_notify, reboot, void, reboot, void, 1),
518 PROC(none, void, void, void, void, 0),
519 PROC(none, void, void, void, void, 0),
520 PROC(none, void, void, void, void, 0),
521 PROC(share, shareargs, shareres, args, res, Ck+St+1),
522 PROC(unshare, shareargs, shareres, args, res, Ck+St+1),
523 PROC(nm_lock, lockargs, res, args, res, Ck+St),
524 PROC(free_all, notify, void, args, void, 1),