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
:
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
;
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
;
116 dprintk("lockd: TEST called\n");
117 resp
->cookie
= argp
->cookie
;
119 /* Don't accept test requests during grace period */
120 if (nlmsvc_grace_period
) {
121 resp
->status
= nlm_lck_denied_grace_period
;
125 /* Obtain client and file */
126 if ((resp
->status
= nlmsvc_retrieve_args(rqstp
, argp
, &host
, &file
)))
127 return resp
->status
== nlm_drop_reply
? rpc_drop_reply
:rpc_success
;
129 /* Now check for conflicting locks */
130 resp
->status
= cast_status(nlmsvc_testlock(file
, &argp
->lock
, &resp
->lock
));
132 dprintk("lockd: TEST status %d vers %d\n",
133 ntohl(resp
->status
), rqstp
->rq_vers
);
134 nlm_release_host(host
);
135 nlm_release_file(file
);
140 nlmsvc_proc_lock(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
141 struct nlm_res
*resp
)
143 struct nlm_host
*host
;
144 struct nlm_file
*file
;
146 dprintk("lockd: LOCK called\n");
148 resp
->cookie
= argp
->cookie
;
150 /* Don't accept new lock requests during grace period */
151 if (nlmsvc_grace_period
&& !argp
->reclaim
) {
152 resp
->status
= nlm_lck_denied_grace_period
;
156 /* Obtain client and file */
157 if ((resp
->status
= nlmsvc_retrieve_args(rqstp
, argp
, &host
, &file
)))
158 return resp
->status
== nlm_drop_reply
? rpc_drop_reply
:rpc_success
;
161 /* If supplied state doesn't match current state, we assume it's
162 * an old request that time-warped somehow. Any error return would
163 * do in this case because it's irrelevant anyway.
165 * NB: We don't retrieve the remote host's state yet.
167 if (host
->h_nsmstate
&& host
->h_nsmstate
!= argp
->state
) {
168 resp
->status
= nlm_lck_denied_nolocks
;
172 /* Now try to lock the file */
173 resp
->status
= cast_status(nlmsvc_lock(rqstp
, file
, &argp
->lock
,
174 argp
->block
, &argp
->cookie
));
176 dprintk("lockd: LOCK status %d\n", ntohl(resp
->status
));
177 nlm_release_host(host
);
178 nlm_release_file(file
);
183 nlmsvc_proc_cancel(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: CANCEL called\n");
191 resp
->cookie
= argp
->cookie
;
193 /* Don't accept requests during grace period */
194 if (nlmsvc_grace_period
) {
195 resp
->status
= nlm_lck_denied_grace_period
;
199 /* Obtain client and file */
200 if ((resp
->status
= nlmsvc_retrieve_args(rqstp
, argp
, &host
, &file
)))
201 return resp
->status
== nlm_drop_reply
? rpc_drop_reply
:rpc_success
;
203 /* Try to cancel request. */
204 resp
->status
= cast_status(nlmsvc_cancel_blocked(file
, &argp
->lock
));
206 dprintk("lockd: CANCEL status %d\n", ntohl(resp
->status
));
207 nlm_release_host(host
);
208 nlm_release_file(file
);
213 * UNLOCK: release a lock
216 nlmsvc_proc_unlock(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
217 struct nlm_res
*resp
)
219 struct nlm_host
*host
;
220 struct nlm_file
*file
;
222 dprintk("lockd: UNLOCK called\n");
224 resp
->cookie
= argp
->cookie
;
226 /* Don't accept new lock requests during grace period */
227 if (nlmsvc_grace_period
) {
228 resp
->status
= nlm_lck_denied_grace_period
;
232 /* Obtain client and file */
233 if ((resp
->status
= nlmsvc_retrieve_args(rqstp
, argp
, &host
, &file
)))
234 return resp
->status
== nlm_drop_reply
? rpc_drop_reply
:rpc_success
;
236 /* Now try to remove the lock */
237 resp
->status
= cast_status(nlmsvc_unlock(file
, &argp
->lock
));
239 dprintk("lockd: UNLOCK status %d\n", ntohl(resp
->status
));
240 nlm_release_host(host
);
241 nlm_release_file(file
);
246 * GRANTED: A server calls us to tell that a process' lock request
250 nlmsvc_proc_granted(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
251 struct nlm_res
*resp
)
253 resp
->cookie
= argp
->cookie
;
255 dprintk("lockd: GRANTED called\n");
256 resp
->status
= nlmclnt_grant(svc_addr_in(rqstp
), &argp
->lock
);
257 dprintk("lockd: GRANTED status %d\n", ntohl(resp
->status
));
262 * This is the generic lockd callback for async RPC calls
264 static void nlmsvc_callback_exit(struct rpc_task
*task
, void *data
)
266 dprintk("lockd: %5u callback returned %d\n", task
->tk_pid
,
270 static void nlmsvc_callback_release(void *data
)
272 nlm_release_call(data
);
275 static const struct rpc_call_ops nlmsvc_callback_ops
= {
276 .rpc_call_done
= nlmsvc_callback_exit
,
277 .rpc_release
= nlmsvc_callback_release
,
281 * `Async' versions of the above service routines. They aren't really,
282 * because we send the callback before the reply proper. I hope this
283 * doesn't break any clients.
285 static __be32
nlmsvc_callback(struct svc_rqst
*rqstp
, u32 proc
, struct nlm_args
*argp
,
286 __be32 (*func
)(struct svc_rqst
*, struct nlm_args
*, struct nlm_res
*))
288 struct nlm_host
*host
;
289 struct nlm_rqst
*call
;
292 host
= nlmsvc_lookup_host(rqstp
,
296 return rpc_system_err
;
298 call
= nlm_alloc_call(host
);
300 return rpc_system_err
;
302 stat
= func(rqstp
, argp
, &call
->a_res
);
304 nlm_release_call(call
);
308 call
->a_flags
= RPC_TASK_ASYNC
;
309 if (nlm_async_reply(call
, proc
, &nlmsvc_callback_ops
) < 0)
310 return rpc_system_err
;
314 static __be32
nlmsvc_proc_test_msg(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
317 dprintk("lockd: TEST_MSG called\n");
318 return nlmsvc_callback(rqstp
, NLMPROC_TEST_RES
, argp
, nlmsvc_proc_test
);
321 static __be32
nlmsvc_proc_lock_msg(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
324 dprintk("lockd: LOCK_MSG called\n");
325 return nlmsvc_callback(rqstp
, NLMPROC_LOCK_RES
, argp
, nlmsvc_proc_lock
);
328 static __be32
nlmsvc_proc_cancel_msg(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
331 dprintk("lockd: CANCEL_MSG called\n");
332 return nlmsvc_callback(rqstp
, NLMPROC_CANCEL_RES
, argp
, nlmsvc_proc_cancel
);
336 nlmsvc_proc_unlock_msg(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
339 dprintk("lockd: UNLOCK_MSG called\n");
340 return nlmsvc_callback(rqstp
, NLMPROC_UNLOCK_RES
, argp
, nlmsvc_proc_unlock
);
344 nlmsvc_proc_granted_msg(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
347 dprintk("lockd: GRANTED_MSG called\n");
348 return nlmsvc_callback(rqstp
, NLMPROC_GRANTED_RES
, argp
, nlmsvc_proc_granted
);
352 * SHARE: create a DOS share or alter existing share.
355 nlmsvc_proc_share(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: SHARE called\n");
363 resp
->cookie
= argp
->cookie
;
365 /* Don't accept new lock requests during grace period */
366 if (nlmsvc_grace_period
&& !argp
->reclaim
) {
367 resp
->status
= nlm_lck_denied_grace_period
;
371 /* Obtain client and file */
372 if ((resp
->status
= nlmsvc_retrieve_args(rqstp
, argp
, &host
, &file
)))
373 return resp
->status
== nlm_drop_reply
? rpc_drop_reply
:rpc_success
;
375 /* Now try to create the share */
376 resp
->status
= cast_status(nlmsvc_share_file(host
, file
, argp
));
378 dprintk("lockd: SHARE status %d\n", ntohl(resp
->status
));
379 nlm_release_host(host
);
380 nlm_release_file(file
);
385 * UNSHARE: Release a DOS share.
388 nlmsvc_proc_unshare(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
389 struct nlm_res
*resp
)
391 struct nlm_host
*host
;
392 struct nlm_file
*file
;
394 dprintk("lockd: UNSHARE called\n");
396 resp
->cookie
= argp
->cookie
;
398 /* Don't accept requests during grace period */
399 if (nlmsvc_grace_period
) {
400 resp
->status
= nlm_lck_denied_grace_period
;
404 /* Obtain client and file */
405 if ((resp
->status
= nlmsvc_retrieve_args(rqstp
, argp
, &host
, &file
)))
406 return resp
->status
== nlm_drop_reply
? rpc_drop_reply
:rpc_success
;
408 /* Now try to unshare the file */
409 resp
->status
= cast_status(nlmsvc_unshare_file(host
, file
, argp
));
411 dprintk("lockd: UNSHARE status %d\n", ntohl(resp
->status
));
412 nlm_release_host(host
);
413 nlm_release_file(file
);
418 * NM_LOCK: Create an unmonitored lock
421 nlmsvc_proc_nm_lock(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
422 struct nlm_res
*resp
)
424 dprintk("lockd: NM_LOCK called\n");
426 argp
->monitor
= 0; /* just clean the monitor flag */
427 return nlmsvc_proc_lock(rqstp
, argp
, resp
);
431 * FREE_ALL: Release all locks and shares held by client
434 nlmsvc_proc_free_all(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
437 struct nlm_host
*host
;
440 if (nlmsvc_retrieve_args(rqstp
, argp
, &host
, NULL
))
443 nlmsvc_free_host_resources(host
);
444 nlm_release_host(host
);
449 * SM_NOTIFY: private callback from statd (not part of official NLM proto)
452 nlmsvc_proc_sm_notify(struct svc_rqst
*rqstp
, struct nlm_reboot
*argp
,
455 struct sockaddr_in saddr
;
457 memcpy(&saddr
, svc_addr_in(rqstp
), sizeof(saddr
));
459 dprintk("lockd: SM_NOTIFY called\n");
460 if (saddr
.sin_addr
.s_addr
!= htonl(INADDR_LOOPBACK
)
461 || ntohs(saddr
.sin_port
) >= 1024) {
462 char buf
[RPC_MAX_ADDRBUFLEN
];
463 printk(KERN_WARNING
"lockd: rejected NSM callback from %s\n",
464 svc_print_addr(rqstp
, buf
, sizeof(buf
)));
465 return rpc_system_err
;
468 /* Obtain the host pointer for this NFS server and try to
469 * reclaim all locks we hold on this server.
471 memset(&saddr
, 0, sizeof(saddr
));
472 saddr
.sin_addr
.s_addr
= argp
->addr
;
473 nlm_host_rebooted(&saddr
, argp
->mon
, argp
->len
, argp
->state
);
479 * client sent a GRANTED_RES, let's remove the associated block
482 nlmsvc_proc_granted_res(struct svc_rqst
*rqstp
, struct nlm_res
*argp
,
488 dprintk("lockd: GRANTED_RES called\n");
490 nlmsvc_grant_reply(&argp
->cookie
, argp
->status
);
495 * NLM Server procedures.
498 #define nlmsvc_encode_norep nlmsvc_encode_void
499 #define nlmsvc_decode_norep nlmsvc_decode_void
500 #define nlmsvc_decode_testres nlmsvc_decode_void
501 #define nlmsvc_decode_lockres nlmsvc_decode_void
502 #define nlmsvc_decode_unlockres nlmsvc_decode_void
503 #define nlmsvc_decode_cancelres nlmsvc_decode_void
504 #define nlmsvc_decode_grantedres nlmsvc_decode_void
506 #define nlmsvc_proc_none nlmsvc_proc_null
507 #define nlmsvc_proc_test_res nlmsvc_proc_null
508 #define nlmsvc_proc_lock_res nlmsvc_proc_null
509 #define nlmsvc_proc_cancel_res nlmsvc_proc_null
510 #define nlmsvc_proc_unlock_res nlmsvc_proc_null
512 struct nlm_void
{ int dummy
; };
514 #define PROC(name, xargt, xrest, argt, rest, respsize) \
515 { .pc_func = (svc_procfunc) nlmsvc_proc_##name, \
516 .pc_decode = (kxdrproc_t) nlmsvc_decode_##xargt, \
517 .pc_encode = (kxdrproc_t) nlmsvc_encode_##xrest, \
518 .pc_release = NULL, \
519 .pc_argsize = sizeof(struct nlm_##argt), \
520 .pc_ressize = sizeof(struct nlm_##rest), \
521 .pc_xdrressize = respsize, \
524 #define Ck (1+XDR_QUADLEN(NLM_MAXCOOKIELEN)) /* cookie */
525 #define St 1 /* status */
526 #define No (1+1024/4) /* Net Obj */
527 #define Rg 2 /* range - offset + size */
529 struct svc_procedure nlmsvc_procedures
[] = {
530 PROC(null
, void, void, void, void, 1),
531 PROC(test
, testargs
, testres
, args
, res
, Ck
+St
+2+No
+Rg
),
532 PROC(lock
, lockargs
, res
, args
, res
, Ck
+St
),
533 PROC(cancel
, cancargs
, res
, args
, res
, Ck
+St
),
534 PROC(unlock
, unlockargs
, res
, args
, res
, Ck
+St
),
535 PROC(granted
, testargs
, res
, args
, res
, Ck
+St
),
536 PROC(test_msg
, testargs
, norep
, args
, void, 1),
537 PROC(lock_msg
, lockargs
, norep
, args
, void, 1),
538 PROC(cancel_msg
, cancargs
, norep
, args
, void, 1),
539 PROC(unlock_msg
, unlockargs
, norep
, args
, void, 1),
540 PROC(granted_msg
, testargs
, norep
, args
, void, 1),
541 PROC(test_res
, testres
, norep
, res
, void, 1),
542 PROC(lock_res
, lockres
, norep
, res
, void, 1),
543 PROC(cancel_res
, cancelres
, norep
, res
, void, 1),
544 PROC(unlock_res
, unlockres
, norep
, res
, void, 1),
545 PROC(granted_res
, res
, norep
, res
, void, 1),
547 PROC(sm_notify
, reboot
, void, reboot
, void, 1),
548 PROC(none
, void, void, void, void, 1),
549 PROC(none
, void, void, void, void, 1),
550 PROC(none
, void, void, void, void, 1),
551 PROC(share
, shareargs
, shareres
, args
, res
, Ck
+St
+1),
552 PROC(unshare
, shareargs
, shareres
, args
, res
, Ck
+St
+1),
553 PROC(nm_lock
, lockargs
, res
, args
, res
, Ck
+St
),
554 PROC(free_all
, notify
, void, args
, void, 0),