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/lockd/lockd.h>
13 #include <linux/lockd/share.h>
15 #define NLMDBG_FACILITY NLMDBG_CLIENT
17 #ifdef CONFIG_LOCKD_V4
19 cast_to_nlm(__be32 status
, u32 vers
)
21 /* Note: status is assumed to be in network byte order !!! */
26 case nlm_lck_denied_nolocks
:
28 case nlm_lck_denied_grace_period
:
32 status
= nlm_lck_denied
;
35 status
= nlm_lck_denied_nolocks
;
41 #define cast_status(status) (cast_to_nlm(status, rqstp->rq_vers))
43 #define cast_status(status) (status)
47 * Obtain client and file from arguments
50 nlmsvc_retrieve_args(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
51 struct nlm_host
**hostp
, struct nlm_file
**filp
)
53 struct nlm_host
*host
= NULL
;
54 struct nlm_file
*file
= NULL
;
55 struct nlm_lock
*lock
= &argp
->lock
;
58 /* nfsd callbacks must have been installed for this procedure */
60 return nlm_lck_denied_nolocks
;
62 /* Obtain host handle */
63 if (!(host
= nlmsvc_lookup_host(rqstp
, lock
->caller
, lock
->len
))
64 || (argp
->monitor
&& nsm_monitor(host
) < 0))
68 /* Obtain file pointer. Not used by FREE_ALL call. */
70 if ((error
= nlm_lookup_file(rqstp
, &file
, &lock
->fh
)) != 0)
74 /* Set up the missing parts of the file_lock structure */
75 lock
->fl
.fl_file
= file
->f_file
;
76 lock
->fl
.fl_owner
= (fl_owner_t
) host
;
77 lock
->fl
.fl_lmops
= &nlmsvc_lock_operations
;
83 nlm_release_host(host
);
86 return nlm_lck_denied_nolocks
;
90 * NULL: Test for presence of service
93 nlmsvc_proc_null(struct svc_rqst
*rqstp
, void *argp
, void *resp
)
95 dprintk("lockd: NULL called\n");
100 * TEST: Check for conflicting lock
103 nlmsvc_proc_test(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
104 struct nlm_res
*resp
)
106 struct nlm_host
*host
;
107 struct nlm_file
*file
;
108 __be32 rc
= rpc_success
;
110 dprintk("lockd: TEST called\n");
111 resp
->cookie
= argp
->cookie
;
113 /* Obtain client and file */
114 if ((resp
->status
= nlmsvc_retrieve_args(rqstp
, argp
, &host
, &file
)))
115 return resp
->status
== nlm_drop_reply
? rpc_drop_reply
:rpc_success
;
117 /* Now check for conflicting locks */
118 resp
->status
= cast_status(nlmsvc_testlock(rqstp
, file
, host
, &argp
->lock
, &resp
->lock
, &resp
->cookie
));
119 if (resp
->status
== nlm_drop_reply
)
122 dprintk("lockd: TEST status %d vers %d\n",
123 ntohl(resp
->status
), rqstp
->rq_vers
);
125 nlm_release_host(host
);
126 nlm_release_file(file
);
131 nlmsvc_proc_lock(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
132 struct nlm_res
*resp
)
134 struct nlm_host
*host
;
135 struct nlm_file
*file
;
136 __be32 rc
= rpc_success
;
138 dprintk("lockd: LOCK called\n");
140 resp
->cookie
= argp
->cookie
;
142 /* Obtain client and file */
143 if ((resp
->status
= nlmsvc_retrieve_args(rqstp
, argp
, &host
, &file
)))
144 return resp
->status
== nlm_drop_reply
? rpc_drop_reply
:rpc_success
;
147 /* If supplied state doesn't match current state, we assume it's
148 * an old request that time-warped somehow. Any error return would
149 * do in this case because it's irrelevant anyway.
151 * NB: We don't retrieve the remote host's state yet.
153 if (host
->h_nsmstate
&& host
->h_nsmstate
!= argp
->state
) {
154 resp
->status
= nlm_lck_denied_nolocks
;
158 /* Now try to lock the file */
159 resp
->status
= cast_status(nlmsvc_lock(rqstp
, file
, host
, &argp
->lock
,
160 argp
->block
, &argp
->cookie
,
162 if (resp
->status
== nlm_drop_reply
)
165 dprintk("lockd: LOCK status %d\n", ntohl(resp
->status
));
167 nlm_release_host(host
);
168 nlm_release_file(file
);
173 nlmsvc_proc_cancel(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
174 struct nlm_res
*resp
)
176 struct nlm_host
*host
;
177 struct nlm_file
*file
;
179 dprintk("lockd: CANCEL called\n");
181 resp
->cookie
= argp
->cookie
;
183 /* Don't accept requests during grace period */
184 if (locks_in_grace()) {
185 resp
->status
= nlm_lck_denied_grace_period
;
189 /* Obtain client and file */
190 if ((resp
->status
= nlmsvc_retrieve_args(rqstp
, argp
, &host
, &file
)))
191 return resp
->status
== nlm_drop_reply
? rpc_drop_reply
:rpc_success
;
193 /* Try to cancel request. */
194 resp
->status
= cast_status(nlmsvc_cancel_blocked(file
, &argp
->lock
));
196 dprintk("lockd: CANCEL status %d\n", ntohl(resp
->status
));
197 nlm_release_host(host
);
198 nlm_release_file(file
);
203 * UNLOCK: release a lock
206 nlmsvc_proc_unlock(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
207 struct nlm_res
*resp
)
209 struct nlm_host
*host
;
210 struct nlm_file
*file
;
212 dprintk("lockd: UNLOCK called\n");
214 resp
->cookie
= argp
->cookie
;
216 /* Don't accept new lock requests during grace period */
217 if (locks_in_grace()) {
218 resp
->status
= nlm_lck_denied_grace_period
;
222 /* Obtain client and file */
223 if ((resp
->status
= nlmsvc_retrieve_args(rqstp
, argp
, &host
, &file
)))
224 return resp
->status
== nlm_drop_reply
? rpc_drop_reply
:rpc_success
;
226 /* Now try to remove the lock */
227 resp
->status
= cast_status(nlmsvc_unlock(file
, &argp
->lock
));
229 dprintk("lockd: UNLOCK status %d\n", ntohl(resp
->status
));
230 nlm_release_host(host
);
231 nlm_release_file(file
);
236 * GRANTED: A server calls us to tell that a process' lock request
240 nlmsvc_proc_granted(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
241 struct nlm_res
*resp
)
243 resp
->cookie
= argp
->cookie
;
245 dprintk("lockd: GRANTED called\n");
246 resp
->status
= nlmclnt_grant(svc_addr(rqstp
), &argp
->lock
);
247 dprintk("lockd: GRANTED status %d\n", ntohl(resp
->status
));
252 * This is the generic lockd callback for async RPC calls
254 static void nlmsvc_callback_exit(struct rpc_task
*task
, void *data
)
256 dprintk("lockd: %5u callback returned %d\n", task
->tk_pid
,
260 static void nlmsvc_callback_release(void *data
)
262 nlm_release_call(data
);
265 static const struct rpc_call_ops nlmsvc_callback_ops
= {
266 .rpc_call_done
= nlmsvc_callback_exit
,
267 .rpc_release
= nlmsvc_callback_release
,
271 * `Async' versions of the above service routines. They aren't really,
272 * because we send the callback before the reply proper. I hope this
273 * doesn't break any clients.
275 static __be32
nlmsvc_callback(struct svc_rqst
*rqstp
, u32 proc
, struct nlm_args
*argp
,
276 __be32 (*func
)(struct svc_rqst
*, struct nlm_args
*, struct nlm_res
*))
278 struct nlm_host
*host
;
279 struct nlm_rqst
*call
;
282 host
= nlmsvc_lookup_host(rqstp
,
286 return rpc_system_err
;
288 call
= nlm_alloc_call(host
);
290 return rpc_system_err
;
292 stat
= func(rqstp
, argp
, &call
->a_res
);
294 nlm_release_call(call
);
298 call
->a_flags
= RPC_TASK_ASYNC
;
299 if (nlm_async_reply(call
, proc
, &nlmsvc_callback_ops
) < 0)
300 return rpc_system_err
;
304 static __be32
nlmsvc_proc_test_msg(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
307 dprintk("lockd: TEST_MSG called\n");
308 return nlmsvc_callback(rqstp
, NLMPROC_TEST_RES
, argp
, nlmsvc_proc_test
);
311 static __be32
nlmsvc_proc_lock_msg(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
314 dprintk("lockd: LOCK_MSG called\n");
315 return nlmsvc_callback(rqstp
, NLMPROC_LOCK_RES
, argp
, nlmsvc_proc_lock
);
318 static __be32
nlmsvc_proc_cancel_msg(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
321 dprintk("lockd: CANCEL_MSG called\n");
322 return nlmsvc_callback(rqstp
, NLMPROC_CANCEL_RES
, argp
, nlmsvc_proc_cancel
);
326 nlmsvc_proc_unlock_msg(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
329 dprintk("lockd: UNLOCK_MSG called\n");
330 return nlmsvc_callback(rqstp
, NLMPROC_UNLOCK_RES
, argp
, nlmsvc_proc_unlock
);
334 nlmsvc_proc_granted_msg(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
337 dprintk("lockd: GRANTED_MSG called\n");
338 return nlmsvc_callback(rqstp
, NLMPROC_GRANTED_RES
, argp
, nlmsvc_proc_granted
);
342 * SHARE: create a DOS share or alter existing share.
345 nlmsvc_proc_share(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
346 struct nlm_res
*resp
)
348 struct nlm_host
*host
;
349 struct nlm_file
*file
;
351 dprintk("lockd: SHARE called\n");
353 resp
->cookie
= argp
->cookie
;
355 /* Don't accept new lock requests during grace period */
356 if (locks_in_grace() && !argp
->reclaim
) {
357 resp
->status
= nlm_lck_denied_grace_period
;
361 /* Obtain client and file */
362 if ((resp
->status
= nlmsvc_retrieve_args(rqstp
, argp
, &host
, &file
)))
363 return resp
->status
== nlm_drop_reply
? rpc_drop_reply
:rpc_success
;
365 /* Now try to create the share */
366 resp
->status
= cast_status(nlmsvc_share_file(host
, file
, argp
));
368 dprintk("lockd: SHARE status %d\n", ntohl(resp
->status
));
369 nlm_release_host(host
);
370 nlm_release_file(file
);
375 * UNSHARE: Release a DOS share.
378 nlmsvc_proc_unshare(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
379 struct nlm_res
*resp
)
381 struct nlm_host
*host
;
382 struct nlm_file
*file
;
384 dprintk("lockd: UNSHARE called\n");
386 resp
->cookie
= argp
->cookie
;
388 /* Don't accept requests during grace period */
389 if (locks_in_grace()) {
390 resp
->status
= nlm_lck_denied_grace_period
;
394 /* Obtain client and file */
395 if ((resp
->status
= nlmsvc_retrieve_args(rqstp
, argp
, &host
, &file
)))
396 return resp
->status
== nlm_drop_reply
? rpc_drop_reply
:rpc_success
;
398 /* Now try to unshare the file */
399 resp
->status
= cast_status(nlmsvc_unshare_file(host
, file
, argp
));
401 dprintk("lockd: UNSHARE status %d\n", ntohl(resp
->status
));
402 nlm_release_host(host
);
403 nlm_release_file(file
);
408 * NM_LOCK: Create an unmonitored lock
411 nlmsvc_proc_nm_lock(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
412 struct nlm_res
*resp
)
414 dprintk("lockd: NM_LOCK called\n");
416 argp
->monitor
= 0; /* just clean the monitor flag */
417 return nlmsvc_proc_lock(rqstp
, argp
, resp
);
421 * FREE_ALL: Release all locks and shares held by client
424 nlmsvc_proc_free_all(struct svc_rqst
*rqstp
, struct nlm_args
*argp
,
427 struct nlm_host
*host
;
430 if (nlmsvc_retrieve_args(rqstp
, argp
, &host
, NULL
))
433 nlmsvc_free_host_resources(host
);
434 nlm_release_host(host
);
439 * SM_NOTIFY: private callback from statd (not part of official NLM proto)
442 nlmsvc_proc_sm_notify(struct svc_rqst
*rqstp
, struct nlm_reboot
*argp
,
445 dprintk("lockd: SM_NOTIFY called\n");
447 if (!nlm_privileged_requester(rqstp
)) {
448 char buf
[RPC_MAX_ADDRBUFLEN
];
449 printk(KERN_WARNING
"lockd: rejected NSM callback from %s\n",
450 svc_print_addr(rqstp
, buf
, sizeof(buf
)));
451 return rpc_system_err
;
454 nlm_host_rebooted(argp
);
459 * client sent a GRANTED_RES, let's remove the associated block
462 nlmsvc_proc_granted_res(struct svc_rqst
*rqstp
, struct nlm_res
*argp
,
468 dprintk("lockd: GRANTED_RES called\n");
470 nlmsvc_grant_reply(&argp
->cookie
, argp
->status
);
475 * NLM Server procedures.
478 #define nlmsvc_encode_norep nlmsvc_encode_void
479 #define nlmsvc_decode_norep nlmsvc_decode_void
480 #define nlmsvc_decode_testres nlmsvc_decode_void
481 #define nlmsvc_decode_lockres nlmsvc_decode_void
482 #define nlmsvc_decode_unlockres nlmsvc_decode_void
483 #define nlmsvc_decode_cancelres nlmsvc_decode_void
484 #define nlmsvc_decode_grantedres nlmsvc_decode_void
486 #define nlmsvc_proc_none nlmsvc_proc_null
487 #define nlmsvc_proc_test_res nlmsvc_proc_null
488 #define nlmsvc_proc_lock_res nlmsvc_proc_null
489 #define nlmsvc_proc_cancel_res nlmsvc_proc_null
490 #define nlmsvc_proc_unlock_res nlmsvc_proc_null
492 struct nlm_void
{ int dummy
; };
494 #define PROC(name, xargt, xrest, argt, rest, respsize) \
495 { .pc_func = (svc_procfunc) nlmsvc_proc_##name, \
496 .pc_decode = (kxdrproc_t) nlmsvc_decode_##xargt, \
497 .pc_encode = (kxdrproc_t) nlmsvc_encode_##xrest, \
498 .pc_release = NULL, \
499 .pc_argsize = sizeof(struct nlm_##argt), \
500 .pc_ressize = sizeof(struct nlm_##rest), \
501 .pc_xdrressize = respsize, \
504 #define Ck (1+XDR_QUADLEN(NLM_MAXCOOKIELEN)) /* cookie */
505 #define St 1 /* status */
506 #define No (1+1024/4) /* Net Obj */
507 #define Rg 2 /* range - offset + size */
509 struct svc_procedure nlmsvc_procedures
[] = {
510 PROC(null
, void, void, void, void, 1),
511 PROC(test
, testargs
, testres
, args
, res
, Ck
+St
+2+No
+Rg
),
512 PROC(lock
, lockargs
, res
, args
, res
, Ck
+St
),
513 PROC(cancel
, cancargs
, res
, args
, res
, Ck
+St
),
514 PROC(unlock
, unlockargs
, res
, args
, res
, Ck
+St
),
515 PROC(granted
, testargs
, res
, args
, res
, Ck
+St
),
516 PROC(test_msg
, testargs
, norep
, args
, void, 1),
517 PROC(lock_msg
, lockargs
, norep
, args
, void, 1),
518 PROC(cancel_msg
, cancargs
, norep
, args
, void, 1),
519 PROC(unlock_msg
, unlockargs
, norep
, args
, void, 1),
520 PROC(granted_msg
, testargs
, norep
, args
, void, 1),
521 PROC(test_res
, testres
, norep
, res
, void, 1),
522 PROC(lock_res
, lockres
, norep
, res
, void, 1),
523 PROC(cancel_res
, cancelres
, norep
, res
, void, 1),
524 PROC(unlock_res
, unlockres
, norep
, res
, void, 1),
525 PROC(granted_res
, res
, norep
, res
, void, 1),
527 PROC(sm_notify
, reboot
, void, reboot
, void, 1),
528 PROC(none
, void, void, void, void, 1),
529 PROC(none
, void, void, void, void, 1),
530 PROC(none
, void, void, void, void, 1),
531 PROC(share
, shareargs
, shareres
, args
, res
, Ck
+St
+1),
532 PROC(unshare
, shareargs
, shareres
, args
, res
, Ck
+St
+1),
533 PROC(nm_lock
, lockargs
, res
, args
, res
, Ck
+St
),
534 PROC(free_all
, notify
, void, args
, void, 0),