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
;
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
, host
, &argp
->lock
, &resp
->lock
, &resp
->cookie
);
103 if (resp
->status
== nlm_drop_reply
)
106 dprintk("lockd: TEST4 status %d\n", ntohl(resp
->status
));
108 nlm_release_host(host
);
109 nlm_release_file(file
);
114 nlm4svc_proc_lock(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
115 struct nlm_res
*resp
)
117 struct nlm_host
*host
;
118 struct nlm_file
*file
;
119 int rc
= rpc_success
;
121 dprintk("lockd: LOCK called\n");
123 resp
->cookie
= argp
->cookie
;
125 /* Don't accept new lock requests during grace period */
126 if (nlmsvc_grace_period
&& !argp
->reclaim
) {
127 resp
->status
= nlm_lck_denied_grace_period
;
131 /* Obtain client and file */
132 if ((resp
->status
= nlm4svc_retrieve_args(rqstp
, argp
, &host
, &file
)))
133 return resp
->status
== nlm_drop_reply
? rpc_drop_reply
:rpc_success
;
136 /* If supplied state doesn't match current state, we assume it's
137 * an old request that time-warped somehow. Any error return would
138 * do in this case because it's irrelevant anyway.
140 * NB: We don't retrieve the remote host's state yet.
142 if (host
->h_nsmstate
&& host
->h_nsmstate
!= argp
->state
) {
143 resp
->status
= nlm_lck_denied_nolocks
;
147 /* Now try to lock the file */
148 resp
->status
= nlmsvc_lock(rqstp
, file
, host
, &argp
->lock
,
149 argp
->block
, &argp
->cookie
);
150 if (resp
->status
== nlm_drop_reply
)
153 dprintk("lockd: LOCK status %d\n", ntohl(resp
->status
));
155 nlm_release_host(host
);
156 nlm_release_file(file
);
161 nlm4svc_proc_cancel(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
162 struct nlm_res
*resp
)
164 struct nlm_host
*host
;
165 struct nlm_file
*file
;
167 dprintk("lockd: CANCEL called\n");
169 resp
->cookie
= argp
->cookie
;
171 /* Don't accept requests during grace period */
172 if (nlmsvc_grace_period
) {
173 resp
->status
= nlm_lck_denied_grace_period
;
177 /* Obtain client and file */
178 if ((resp
->status
= nlm4svc_retrieve_args(rqstp
, argp
, &host
, &file
)))
179 return resp
->status
== nlm_drop_reply
? rpc_drop_reply
:rpc_success
;
181 /* Try to cancel request. */
182 resp
->status
= nlmsvc_cancel_blocked(file
, &argp
->lock
);
184 dprintk("lockd: CANCEL status %d\n", ntohl(resp
->status
));
185 nlm_release_host(host
);
186 nlm_release_file(file
);
191 * UNLOCK: release a lock
194 nlm4svc_proc_unlock(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
195 struct nlm_res
*resp
)
197 struct nlm_host
*host
;
198 struct nlm_file
*file
;
200 dprintk("lockd: UNLOCK called\n");
202 resp
->cookie
= argp
->cookie
;
204 /* Don't accept new lock requests during grace period */
205 if (nlmsvc_grace_period
) {
206 resp
->status
= nlm_lck_denied_grace_period
;
210 /* Obtain client and file */
211 if ((resp
->status
= nlm4svc_retrieve_args(rqstp
, argp
, &host
, &file
)))
212 return resp
->status
== nlm_drop_reply
? rpc_drop_reply
:rpc_success
;
214 /* Now try to remove the lock */
215 resp
->status
= nlmsvc_unlock(file
, &argp
->lock
);
217 dprintk("lockd: UNLOCK status %d\n", ntohl(resp
->status
));
218 nlm_release_host(host
);
219 nlm_release_file(file
);
224 * GRANTED: A server calls us to tell that a process' lock request
228 nlm4svc_proc_granted(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
229 struct nlm_res
*resp
)
231 resp
->cookie
= argp
->cookie
;
233 dprintk("lockd: GRANTED called\n");
234 resp
->status
= nlmclnt_grant(svc_addr_in(rqstp
), &argp
->lock
);
235 dprintk("lockd: GRANTED status %d\n", ntohl(resp
->status
));
240 * This is the generic lockd callback for async RPC calls
242 static void nlm4svc_callback_exit(struct rpc_task
*task
, void *data
)
244 dprintk("lockd: %5u callback returned %d\n", task
->tk_pid
,
248 static void nlm4svc_callback_release(void *data
)
250 nlm_release_call(data
);
253 static const struct rpc_call_ops nlm4svc_callback_ops
= {
254 .rpc_call_done
= nlm4svc_callback_exit
,
255 .rpc_release
= nlm4svc_callback_release
,
259 * `Async' versions of the above service routines. They aren't really,
260 * because we send the callback before the reply proper. I hope this
261 * doesn't break any clients.
263 static __be32
nlm4svc_callback(struct svc_rqst
*rqstp
, u32 proc
, struct nlm_args
*argp
,
264 __be32 (*func
)(struct svc_rqst
*, struct nlm_args
*, struct nlm_res
*))
266 struct nlm_host
*host
;
267 struct nlm_rqst
*call
;
270 host
= nlmsvc_lookup_host(rqstp
,
274 return rpc_system_err
;
276 call
= nlm_alloc_call(host
);
278 return rpc_system_err
;
280 stat
= func(rqstp
, argp
, &call
->a_res
);
282 nlm_release_call(call
);
286 call
->a_flags
= RPC_TASK_ASYNC
;
287 if (nlm_async_reply(call
, proc
, &nlm4svc_callback_ops
) < 0)
288 return rpc_system_err
;
292 static __be32
nlm4svc_proc_test_msg(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
295 dprintk("lockd: TEST_MSG called\n");
296 return nlm4svc_callback(rqstp
, NLMPROC_TEST_RES
, argp
, nlm4svc_proc_test
);
299 static __be32
nlm4svc_proc_lock_msg(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
302 dprintk("lockd: LOCK_MSG called\n");
303 return nlm4svc_callback(rqstp
, NLMPROC_LOCK_RES
, argp
, nlm4svc_proc_lock
);
306 static __be32
nlm4svc_proc_cancel_msg(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
309 dprintk("lockd: CANCEL_MSG called\n");
310 return nlm4svc_callback(rqstp
, NLMPROC_CANCEL_RES
, argp
, nlm4svc_proc_cancel
);
313 static __be32
nlm4svc_proc_unlock_msg(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
316 dprintk("lockd: UNLOCK_MSG called\n");
317 return nlm4svc_callback(rqstp
, NLMPROC_UNLOCK_RES
, argp
, nlm4svc_proc_unlock
);
320 static __be32
nlm4svc_proc_granted_msg(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
323 dprintk("lockd: GRANTED_MSG called\n");
324 return nlm4svc_callback(rqstp
, NLMPROC_GRANTED_RES
, argp
, nlm4svc_proc_granted
);
328 * SHARE: create a DOS share or alter existing share.
331 nlm4svc_proc_share(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
332 struct nlm_res
*resp
)
334 struct nlm_host
*host
;
335 struct nlm_file
*file
;
337 dprintk("lockd: SHARE called\n");
339 resp
->cookie
= argp
->cookie
;
341 /* Don't accept new lock requests during grace period */
342 if (nlmsvc_grace_period
&& !argp
->reclaim
) {
343 resp
->status
= nlm_lck_denied_grace_period
;
347 /* Obtain client and file */
348 if ((resp
->status
= nlm4svc_retrieve_args(rqstp
, argp
, &host
, &file
)))
349 return resp
->status
== nlm_drop_reply
? rpc_drop_reply
:rpc_success
;
351 /* Now try to create the share */
352 resp
->status
= nlmsvc_share_file(host
, file
, argp
);
354 dprintk("lockd: SHARE status %d\n", ntohl(resp
->status
));
355 nlm_release_host(host
);
356 nlm_release_file(file
);
361 * UNSHARE: Release a DOS share.
364 nlm4svc_proc_unshare(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
365 struct nlm_res
*resp
)
367 struct nlm_host
*host
;
368 struct nlm_file
*file
;
370 dprintk("lockd: UNSHARE called\n");
372 resp
->cookie
= argp
->cookie
;
374 /* Don't accept requests during grace period */
375 if (nlmsvc_grace_period
) {
376 resp
->status
= nlm_lck_denied_grace_period
;
380 /* Obtain client and file */
381 if ((resp
->status
= nlm4svc_retrieve_args(rqstp
, argp
, &host
, &file
)))
382 return resp
->status
== nlm_drop_reply
? rpc_drop_reply
:rpc_success
;
384 /* Now try to lock the file */
385 resp
->status
= nlmsvc_unshare_file(host
, file
, argp
);
387 dprintk("lockd: UNSHARE status %d\n", ntohl(resp
->status
));
388 nlm_release_host(host
);
389 nlm_release_file(file
);
394 * NM_LOCK: Create an unmonitored lock
397 nlm4svc_proc_nm_lock(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
398 struct nlm_res
*resp
)
400 dprintk("lockd: NM_LOCK called\n");
402 argp
->monitor
= 0; /* just clean the monitor flag */
403 return nlm4svc_proc_lock(rqstp
, argp
, resp
);
407 * FREE_ALL: Release all locks and shares held by client
410 nlm4svc_proc_free_all(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
413 struct nlm_host
*host
;
416 if (nlm4svc_retrieve_args(rqstp
, argp
, &host
, NULL
))
419 nlmsvc_free_host_resources(host
);
420 nlm_release_host(host
);
425 * SM_NOTIFY: private callback from statd (not part of official NLM proto)
428 nlm4svc_proc_sm_notify(struct svc_rqst
*rqstp
, struct nlm_reboot
*argp
,
431 struct sockaddr_in saddr
;
433 memcpy(&saddr
, svc_addr_in(rqstp
), sizeof(saddr
));
435 dprintk("lockd: SM_NOTIFY called\n");
436 if (saddr
.sin_addr
.s_addr
!= htonl(INADDR_LOOPBACK
)
437 || ntohs(saddr
.sin_port
) >= 1024) {
438 char buf
[RPC_MAX_ADDRBUFLEN
];
439 printk(KERN_WARNING
"lockd: rejected NSM callback from %s\n",
440 svc_print_addr(rqstp
, buf
, sizeof(buf
)));
441 return rpc_system_err
;
444 /* Obtain the host pointer for this NFS server and try to
445 * reclaim all locks we hold on this server.
447 memset(&saddr
, 0, sizeof(saddr
));
448 saddr
.sin_addr
.s_addr
= argp
->addr
;
449 nlm_host_rebooted(&saddr
, argp
->mon
, argp
->len
, argp
->state
);
455 * client sent a GRANTED_RES, let's remove the associated block
458 nlm4svc_proc_granted_res(struct svc_rqst
*rqstp
, struct nlm_res
*argp
,
464 dprintk("lockd: GRANTED_RES called\n");
466 nlmsvc_grant_reply(&argp
->cookie
, argp
->status
);
472 * NLM Server procedures.
475 #define nlm4svc_encode_norep nlm4svc_encode_void
476 #define nlm4svc_decode_norep nlm4svc_decode_void
477 #define nlm4svc_decode_testres nlm4svc_decode_void
478 #define nlm4svc_decode_lockres nlm4svc_decode_void
479 #define nlm4svc_decode_unlockres nlm4svc_decode_void
480 #define nlm4svc_decode_cancelres nlm4svc_decode_void
481 #define nlm4svc_decode_grantedres nlm4svc_decode_void
483 #define nlm4svc_proc_none nlm4svc_proc_null
484 #define nlm4svc_proc_test_res nlm4svc_proc_null
485 #define nlm4svc_proc_lock_res nlm4svc_proc_null
486 #define nlm4svc_proc_cancel_res nlm4svc_proc_null
487 #define nlm4svc_proc_unlock_res nlm4svc_proc_null
489 struct nlm_void
{ int dummy
; };
491 #define PROC(name, xargt, xrest, argt, rest, respsize) \
492 { .pc_func = (svc_procfunc) nlm4svc_proc_##name, \
493 .pc_decode = (kxdrproc_t) nlm4svc_decode_##xargt, \
494 .pc_encode = (kxdrproc_t) nlm4svc_encode_##xrest, \
495 .pc_release = NULL, \
496 .pc_argsize = sizeof(struct nlm_##argt), \
497 .pc_ressize = sizeof(struct nlm_##rest), \
498 .pc_xdrressize = respsize, \
500 #define Ck (1+XDR_QUADLEN(NLM_MAXCOOKIELEN)) /* cookie */
501 #define No (1+1024/4) /* netobj */
502 #define St 1 /* status */
503 #define Rg 4 /* range (offset + length) */
504 struct svc_procedure nlmsvc_procedures4
[] = {
505 PROC(null
, void, void, void, void, 1),
506 PROC(test
, testargs
, testres
, args
, res
, Ck
+St
+2+No
+Rg
),
507 PROC(lock
, lockargs
, res
, args
, res
, Ck
+St
),
508 PROC(cancel
, cancargs
, res
, args
, res
, Ck
+St
),
509 PROC(unlock
, unlockargs
, res
, args
, res
, Ck
+St
),
510 PROC(granted
, testargs
, res
, args
, res
, Ck
+St
),
511 PROC(test_msg
, testargs
, norep
, args
, void, 1),
512 PROC(lock_msg
, lockargs
, norep
, args
, void, 1),
513 PROC(cancel_msg
, cancargs
, norep
, args
, void, 1),
514 PROC(unlock_msg
, unlockargs
, norep
, args
, void, 1),
515 PROC(granted_msg
, testargs
, norep
, args
, void, 1),
516 PROC(test_res
, testres
, norep
, res
, void, 1),
517 PROC(lock_res
, lockres
, norep
, res
, void, 1),
518 PROC(cancel_res
, cancelres
, norep
, res
, void, 1),
519 PROC(unlock_res
, unlockres
, norep
, res
, void, 1),
520 PROC(granted_res
, res
, norep
, res
, void, 1),
522 PROC(sm_notify
, reboot
, void, reboot
, void, 1),
523 PROC(none
, void, void, void, void, 0),
524 PROC(none
, void, void, void, void, 0),
525 PROC(none
, void, void, void, void, 0),
526 PROC(share
, shareargs
, shareres
, args
, res
, Ck
+St
+1),
527 PROC(unshare
, shareargs
, shareres
, args
, res
, Ck
+St
+1),
528 PROC(nm_lock
, lockargs
, res
, args
, res
, Ck
+St
),
529 PROC(free_all
, notify
, void, args
, void, 1),