4 * XDR support for lockd and the lock client.
6 * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
9 #include <linux/config.h>
10 #include <linux/types.h>
11 #include <linux/sched.h>
12 #include <linux/utsname.h>
13 #include <linux/nfs.h>
15 #include <linux/sunrpc/xdr.h>
16 #include <linux/sunrpc/clnt.h>
17 #include <linux/sunrpc/svc.h>
18 #include <linux/sunrpc/stats.h>
19 #include <linux/lockd/lockd.h>
20 #include <linux/lockd/sm_inter.h>
22 #define NLMDBG_FACILITY NLMDBG_XDR
26 s32_to_loff_t(__s32 offset)
28 return (loff_t)offset;
32 loff_t_to_s32(loff_t offset)
35 if (offset >= NLM_OFFSET_MAX)
37 else if (offset <= -NLM_OFFSET_MAX)
38 res = -NLM_OFFSET_MAX;
45 * XDR functions for basic NLM types
47 static inline u32 *nlm_decode_cookie(u32 *p, struct nlm_cookie *c)
56 memset(c->data, 0, 4); /* hockeypux brain damage */
58 else if(len<=NLM_MAXCOOKIELEN)
61 memcpy(c->data, p, len);
67 "lockd: bad cookie size %d (only cookies under %d bytes are supported.)\n", len, NLM_MAXCOOKIELEN);
74 nlm_encode_cookie(u32 *p, struct nlm_cookie *c)
77 memcpy(p, c->data, c->len);
78 p+=XDR_QUADLEN(c->len);
83 nlm_decode_fh(u32 *p, struct nfs_fh *f)
87 if ((len = ntohl(*p++)) != NFS2_FHSIZE) {
89 "lockd: bad fhandle size %d (should be %d)\n",
93 f->size = NFS2_FHSIZE;
94 memset(f->data, 0, sizeof(f->data));
95 memcpy(f->data, p, NFS2_FHSIZE);
96 return p + XDR_QUADLEN(NFS2_FHSIZE);
100 nlm_encode_fh(u32 *p, struct nfs_fh *f)
102 *p++ = htonl(NFS2_FHSIZE);
103 memcpy(p, f->data, NFS2_FHSIZE);
104 return p + XDR_QUADLEN(NFS2_FHSIZE);
108 * Encode and decode owner handle
111 nlm_decode_oh(u32 *p, struct xdr_netobj *oh)
113 return xdr_decode_netobj(p, oh);
117 nlm_encode_oh(u32 *p, struct xdr_netobj *oh)
119 return xdr_encode_netobj(p, oh);
123 nlm_decode_lock(u32 *p, struct nlm_lock *lock)
125 struct file_lock *fl = &lock->fl;
128 if (!(p = xdr_decode_string_inplace(p, &lock->caller,
131 || !(p = nlm_decode_fh(p, &lock->fh))
132 || !(p = nlm_decode_oh(p, &lock->oh)))
136 fl->fl_owner = current->files;
137 fl->fl_pid = ntohl(*p++);
138 fl->fl_flags = FL_POSIX;
139 fl->fl_type = F_RDLCK; /* as good as anything else */
142 end = start + len - 1;
144 fl->fl_start = s32_to_loff_t(start);
146 if (len == 0 || end < 0)
147 fl->fl_end = OFFSET_MAX;
149 fl->fl_end = s32_to_loff_t(end);
154 * Encode a lock as part of an NLM call
157 nlm_encode_lock(u32 *p, struct nlm_lock *lock)
159 struct file_lock *fl = &lock->fl;
162 if (!(p = xdr_encode_string(p, lock->caller))
163 || !(p = nlm_encode_fh(p, &lock->fh))
164 || !(p = nlm_encode_oh(p, &lock->oh)))
167 if (fl->fl_start > NLM_OFFSET_MAX
168 || (fl->fl_end > NLM_OFFSET_MAX && fl->fl_end != OFFSET_MAX))
171 start = loff_t_to_s32(fl->fl_start);
172 if (fl->fl_end == OFFSET_MAX)
175 len = loff_t_to_s32(fl->fl_end - fl->fl_start + 1);
177 *p++ = htonl(fl->fl_pid);
185 * Encode result of a TEST/TEST_MSG call
188 nlm_encode_testres(u32 *p, struct nlm_res *resp)
192 if (!(p = nlm_encode_cookie(p, &resp->cookie)))
196 if (resp->status == nlm_lck_denied) {
197 struct file_lock *fl = &resp->lock.fl;
199 *p++ = (fl->fl_type == F_RDLCK)? xdr_zero : xdr_one;
200 *p++ = htonl(fl->fl_pid);
202 /* Encode owner handle. */
203 if (!(p = xdr_encode_netobj(p, &resp->lock.oh)))
206 start = loff_t_to_s32(fl->fl_start);
207 if (fl->fl_end == OFFSET_MAX)
210 len = loff_t_to_s32(fl->fl_end - fl->fl_start + 1);
221 * First, the server side XDR functions
224 nlmsvc_decode_testargs(struct svc_rqst *rqstp, u32 *p, nlm_args *argp)
228 if (!(p = nlm_decode_cookie(p, &argp->cookie)))
231 exclusive = ntohl(*p++);
232 if (!(p = nlm_decode_lock(p, &argp->lock)))
235 argp->lock.fl.fl_type = F_WRLCK;
237 return xdr_argsize_check(rqstp, p);
241 nlmsvc_encode_testres(struct svc_rqst *rqstp, u32 *p, struct nlm_res *resp)
243 if (!(p = nlm_encode_testres(p, resp)))
245 return xdr_ressize_check(rqstp, p);
249 nlmsvc_decode_lockargs(struct svc_rqst *rqstp, u32 *p, nlm_args *argp)
253 if (!(p = nlm_decode_cookie(p, &argp->cookie)))
255 argp->block = ntohl(*p++);
256 exclusive = ntohl(*p++);
257 if (!(p = nlm_decode_lock(p, &argp->lock)))
260 argp->lock.fl.fl_type = F_WRLCK;
261 argp->reclaim = ntohl(*p++);
262 argp->state = ntohl(*p++);
263 argp->monitor = 1; /* monitor client by default */
265 return xdr_argsize_check(rqstp, p);
269 nlmsvc_decode_cancargs(struct svc_rqst *rqstp, u32 *p, nlm_args *argp)
273 if (!(p = nlm_decode_cookie(p, &argp->cookie)))
275 argp->block = ntohl(*p++);
276 exclusive = ntohl(*p++);
277 if (!(p = nlm_decode_lock(p, &argp->lock)))
280 argp->lock.fl.fl_type = F_WRLCK;
281 return xdr_argsize_check(rqstp, p);
285 nlmsvc_decode_unlockargs(struct svc_rqst *rqstp, u32 *p, nlm_args *argp)
287 if (!(p = nlm_decode_cookie(p, &argp->cookie))
288 || !(p = nlm_decode_lock(p, &argp->lock)))
290 argp->lock.fl.fl_type = F_UNLCK;
291 return xdr_argsize_check(rqstp, p);
295 nlmsvc_decode_shareargs(struct svc_rqst *rqstp, u32 *p, nlm_args *argp)
297 struct nlm_lock *lock = &argp->lock;
299 memset(lock, 0, sizeof(*lock));
300 locks_init_lock(&lock->fl);
301 lock->fl.fl_pid = ~(u32) 0;
303 if (!(p = nlm_decode_cookie(p, &argp->cookie))
304 || !(p = xdr_decode_string_inplace(p, &lock->caller,
305 &lock->len, NLM_MAXSTRLEN))
306 || !(p = nlm_decode_fh(p, &lock->fh))
307 || !(p = nlm_decode_oh(p, &lock->oh)))
309 argp->fsm_mode = ntohl(*p++);
310 argp->fsm_access = ntohl(*p++);
311 return xdr_argsize_check(rqstp, p);
315 nlmsvc_encode_shareres(struct svc_rqst *rqstp, u32 *p, struct nlm_res *resp)
317 if (!(p = nlm_encode_cookie(p, &resp->cookie)))
320 *p++ = xdr_zero; /* sequence argument */
321 return xdr_ressize_check(rqstp, p);
325 nlmsvc_encode_res(struct svc_rqst *rqstp, u32 *p, struct nlm_res *resp)
327 if (!(p = nlm_encode_cookie(p, &resp->cookie)))
330 return xdr_ressize_check(rqstp, p);
334 nlmsvc_decode_notify(struct svc_rqst *rqstp, u32 *p, struct nlm_args *argp)
336 struct nlm_lock *lock = &argp->lock;
338 if (!(p = xdr_decode_string_inplace(p, &lock->caller,
339 &lock->len, NLM_MAXSTRLEN)))
341 argp->state = ntohl(*p++);
342 return xdr_argsize_check(rqstp, p);
346 nlmsvc_decode_reboot(struct svc_rqst *rqstp, u32 *p, struct nlm_reboot *argp)
348 if (!(p = xdr_decode_string_inplace(p, &argp->mon, &argp->len, SM_MAXSTRLEN)))
350 argp->state = ntohl(*p++);
351 /* Preserve the address in network byte order */
355 return xdr_argsize_check(rqstp, p);
359 nlmsvc_decode_res(struct svc_rqst *rqstp, u32 *p, struct nlm_res *resp)
361 if (!(p = nlm_decode_cookie(p, &resp->cookie)))
363 resp->status = ntohl(*p++);
364 return xdr_argsize_check(rqstp, p);
368 nlmsvc_decode_void(struct svc_rqst *rqstp, u32 *p, void *dummy)
370 return xdr_argsize_check(rqstp, p);
374 nlmsvc_encode_void(struct svc_rqst *rqstp, u32 *p, void *dummy)
376 return xdr_ressize_check(rqstp, p);
380 * Now, the client side XDR functions
382 #ifdef NLMCLNT_SUPPORT_SHARES
384 nlmclt_decode_void(struct rpc_rqst *req, u32 *p, void *ptr)
391 nlmclt_encode_testargs(struct rpc_rqst *req, u32 *p, nlm_args *argp)
393 struct nlm_lock *lock = &argp->lock;
395 if (!(p = nlm_encode_cookie(p, &argp->cookie)))
397 *p++ = (lock->fl.fl_type == F_WRLCK)? xdr_one : xdr_zero;
398 if (!(p = nlm_encode_lock(p, lock)))
400 req->rq_slen = xdr_adjust_iovec(req->rq_svec, p);
405 nlmclt_decode_testres(struct rpc_rqst *req, u32 *p, struct nlm_res *resp)
407 if (!(p = nlm_decode_cookie(p, &resp->cookie)))
409 resp->status = ntohl(*p++);
410 if (resp->status == NLM_LCK_DENIED) {
411 struct file_lock *fl = &resp->lock.fl;
415 memset(&resp->lock, 0, sizeof(resp->lock));
418 fl->fl_pid = ntohl(*p++);
419 if (!(p = nlm_decode_oh(p, &resp->lock.oh)))
422 fl->fl_flags = FL_POSIX;
423 fl->fl_type = excl? F_WRLCK : F_RDLCK;
426 end = start + len - 1;
428 fl->fl_start = s32_to_loff_t(start);
429 if (len == 0 || end < 0)
430 fl->fl_end = OFFSET_MAX;
432 fl->fl_end = s32_to_loff_t(end);
439 nlmclt_encode_lockargs(struct rpc_rqst *req, u32 *p, nlm_args *argp)
441 struct nlm_lock *lock = &argp->lock;
443 if (!(p = nlm_encode_cookie(p, &argp->cookie)))
445 *p++ = argp->block? xdr_one : xdr_zero;
446 *p++ = (lock->fl.fl_type == F_WRLCK)? xdr_one : xdr_zero;
447 if (!(p = nlm_encode_lock(p, lock)))
449 *p++ = argp->reclaim? xdr_one : xdr_zero;
450 *p++ = htonl(argp->state);
451 req->rq_slen = xdr_adjust_iovec(req->rq_svec, p);
456 nlmclt_encode_cancargs(struct rpc_rqst *req, u32 *p, nlm_args *argp)
458 struct nlm_lock *lock = &argp->lock;
460 if (!(p = nlm_encode_cookie(p, &argp->cookie)))
462 *p++ = argp->block? xdr_one : xdr_zero;
463 *p++ = (lock->fl.fl_type == F_WRLCK)? xdr_one : xdr_zero;
464 if (!(p = nlm_encode_lock(p, lock)))
466 req->rq_slen = xdr_adjust_iovec(req->rq_svec, p);
471 nlmclt_encode_unlockargs(struct rpc_rqst *req, u32 *p, nlm_args *argp)
473 struct nlm_lock *lock = &argp->lock;
475 if (!(p = nlm_encode_cookie(p, &argp->cookie)))
477 if (!(p = nlm_encode_lock(p, lock)))
479 req->rq_slen = xdr_adjust_iovec(req->rq_svec, p);
484 nlmclt_encode_res(struct rpc_rqst *req, u32 *p, struct nlm_res *resp)
486 if (!(p = nlm_encode_cookie(p, &resp->cookie)))
489 req->rq_slen = xdr_adjust_iovec(req->rq_svec, p);
494 nlmclt_encode_testres(struct rpc_rqst *req, u32 *p, struct nlm_res *resp)
496 if (!(p = nlm_encode_testres(p, resp)))
498 req->rq_slen = xdr_adjust_iovec(req->rq_svec, p);
503 nlmclt_decode_res(struct rpc_rqst *req, u32 *p, struct nlm_res *resp)
505 if (!(p = nlm_decode_cookie(p, &resp->cookie)))
507 resp->status = ntohl(*p++);
512 * Buffer requirements for NLM
514 #define NLM_void_sz 0
515 #define NLM_cookie_sz 1+XDR_QUADLEN(NLM_MAXCOOKIELEN)
516 #define NLM_caller_sz 1+XDR_QUADLEN(sizeof(system_utsname.nodename))
517 #define NLM_netobj_sz 1+XDR_QUADLEN(XDR_MAX_NETOBJ)
518 /* #define NLM_owner_sz 1+XDR_QUADLEN(NLM_MAXOWNER) */
519 #define NLM_fhandle_sz 1+XDR_QUADLEN(NFS2_FHSIZE)
520 #define NLM_lock_sz 3+NLM_caller_sz+NLM_netobj_sz+NLM_fhandle_sz
521 #define NLM_holder_sz 4+NLM_netobj_sz
523 #define NLM_testargs_sz NLM_cookie_sz+1+NLM_lock_sz
524 #define NLM_lockargs_sz NLM_cookie_sz+4+NLM_lock_sz
525 #define NLM_cancargs_sz NLM_cookie_sz+2+NLM_lock_sz
526 #define NLM_unlockargs_sz NLM_cookie_sz+NLM_lock_sz
528 #define NLM_testres_sz NLM_cookie_sz+1+NLM_holder_sz
529 #define NLM_res_sz NLM_cookie_sz+1
530 #define NLM_norep_sz 0
533 # define MAX(a, b) (((a) > (b))? (a) : (b))
537 * For NLM, a void procedure really returns nothing
539 #define nlmclt_decode_norep NULL
541 #define PROC(proc, argtype, restype) \
542 [NLMPROC_##proc] = { \
543 .p_proc = NLMPROC_##proc, \
544 .p_encode = (kxdrproc_t) nlmclt_encode_##argtype, \
545 .p_decode = (kxdrproc_t) nlmclt_decode_##restype, \
546 .p_bufsiz = MAX(NLM_##argtype##_sz, NLM_##restype##_sz) << 2 \
549 static struct rpc_procinfo nlm_procedures[] = {
550 PROC(TEST, testargs, testres),
551 PROC(LOCK, lockargs, res),
552 PROC(CANCEL, cancargs, res),
553 PROC(UNLOCK, unlockargs, res),
554 PROC(GRANTED, testargs, res),
555 PROC(TEST_MSG, testargs, norep),
556 PROC(LOCK_MSG, lockargs, norep),
557 PROC(CANCEL_MSG, cancargs, norep),
558 PROC(UNLOCK_MSG, unlockargs, norep),
559 PROC(GRANTED_MSG, testargs, norep),
560 PROC(TEST_RES, testres, norep),
561 PROC(LOCK_RES, res, norep),
562 PROC(CANCEL_RES, res, norep),
563 PROC(UNLOCK_RES, res, norep),
564 PROC(GRANTED_RES, res, norep),
565 #ifdef NLMCLNT_SUPPORT_SHARES
566 PROC(SHARE, shareargs, shareres),
567 PROC(UNSHARE, shareargs, shareres),
568 PROC(NM_LOCK, lockargs, res),
569 PROC(FREE_ALL, notify, void),
573 static struct rpc_version nlm_version1 = {
576 .procs = nlm_procedures,
579 static struct rpc_version nlm_version3 = {
582 .procs = nlm_procedures,
585 #ifdef CONFIG_LOCKD_V4
586 extern struct rpc_version nlm_version4;
589 static struct rpc_version * nlm_versions[] = {
592 #ifdef CONFIG_LOCKD_V4
597 static struct rpc_stat nlm_stats;
599 struct rpc_program nlm_program = {
601 .number = NLM_PROGRAM,
602 .nrvers = sizeof(nlm_versions) / sizeof(nlm_versions[0]),
603 .version = nlm_versions,
608 const char *nlmdbg_cookie2a(const struct nlm_cookie *cookie)
611 * We can get away with a static buffer because we're only
612 * called with BKL held.
614 static char buf[2*NLM_MAXCOOKIELEN+1];
616 int len = sizeof(buf);
619 len--; /* allow for trailing \0 */
622 for (i = 0 ; i < cookie->len ; i++) {
627 sprintf(p, "%02x", cookie->data[i]);