2 * linux/fs/lockd/xdr4.c
4 * XDR support for lockd and the lock client.
6 * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
7 * Copyright (C) 1999, Trond Myklebust <trond.myklebust@fys.uio.no>
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
25 s64_to_loff_t(__s64 offset)
27 return (loff_t)offset;
32 loff_t_to_s64(loff_t offset)
35 if (offset > NLM4_OFFSET_MAX)
36 res = NLM4_OFFSET_MAX;
37 else if (offset < -NLM4_OFFSET_MAX)
38 res = -NLM4_OFFSET_MAX;
45 * XDR functions for basic NLM types
48 nlm4_decode_cookie(u32 *p, struct nlm_cookie *c)
57 memset(c->data, 0, 4); /* hockeypux brain damage */
62 memcpy(c->data, p, len);
68 "lockd: bad cookie size %d (only cookies under 8 bytes are supported.)\n", len);
75 nlm4_encode_cookie(u32 *p, struct nlm_cookie *c)
78 memcpy(p, c->data, c->len);
84 nlm4_decode_fh(u32 *p, struct nfs_fh *f)
86 memset(f->data, 0, sizeof(f->data));
87 f->size = ntohl(*p++);
88 if (f->size > NFS_MAXFHSIZE) {
90 "lockd: bad fhandle size %d (should be <=%d)\n",
91 f->size, NFS_MAXFHSIZE);
94 memcpy(f->data, p, f->size);
95 return p + XDR_QUADLEN(f->size);
99 nlm4_encode_fh(u32 *p, struct nfs_fh *f)
101 *p++ = htonl(f->size);
102 if (f->size) p[XDR_QUADLEN(f->size)-1] = 0; /* don't leak anything */
103 memcpy(p, f->data, f->size);
104 return p + XDR_QUADLEN(f->size);
108 * Encode and decode owner handle
111 nlm4_decode_oh(u32 *p, struct xdr_netobj *oh)
113 return xdr_decode_netobj(p, oh);
117 nlm4_encode_oh(u32 *p, struct xdr_netobj *oh)
119 return xdr_encode_netobj(p, oh);
123 nlm4_decode_lock(u32 *p, struct nlm_lock *lock)
125 struct file_lock *fl = &lock->fl;
126 __s64 len, start, end;
128 if (!(p = xdr_decode_string_inplace(p, &lock->caller,
129 &lock->len, NLM_MAXSTRLEN))
130 || !(p = nlm4_decode_fh(p, &lock->fh))
131 || !(p = nlm4_decode_oh(p, &lock->oh)))
135 fl->fl_owner = current->files;
136 fl->fl_pid = ntohl(*p++);
137 fl->fl_flags = FL_POSIX;
138 fl->fl_type = F_RDLCK; /* as good as anything else */
139 p = xdr_decode_hyper(p, &start);
140 p = xdr_decode_hyper(p, &len);
141 end = start + len - 1;
143 fl->fl_start = s64_to_loff_t(start);
145 if (len == 0 || end < 0)
146 fl->fl_end = OFFSET_MAX;
148 fl->fl_end = s64_to_loff_t(end);
153 * Encode a lock as part of an NLM call
156 nlm4_encode_lock(u32 *p, struct nlm_lock *lock)
158 struct file_lock *fl = &lock->fl;
161 if (!(p = xdr_encode_string(p, lock->caller))
162 || !(p = nlm4_encode_fh(p, &lock->fh))
163 || !(p = nlm4_encode_oh(p, &lock->oh)))
166 if (fl->fl_start > NLM4_OFFSET_MAX
167 || (fl->fl_end > NLM4_OFFSET_MAX && fl->fl_end != OFFSET_MAX))
170 *p++ = htonl(fl->fl_pid);
172 start = loff_t_to_s64(fl->fl_start);
173 if (fl->fl_end == OFFSET_MAX)
176 len = loff_t_to_s64(fl->fl_end - fl->fl_start + 1);
178 p = xdr_encode_hyper(p, start);
179 p = xdr_encode_hyper(p, len);
185 * Encode result of a TEST/TEST_MSG call
188 nlm4_encode_testres(u32 *p, struct nlm_res *resp)
192 dprintk("xdr: before encode_testres (p %p resp %p)\n", p, resp);
193 if (!(p = nlm4_encode_cookie(p, &resp->cookie)))
197 if (resp->status == nlm_lck_denied) {
198 struct file_lock *fl = &resp->lock.fl;
200 *p++ = (fl->fl_type == F_RDLCK)? xdr_zero : xdr_one;
201 *p++ = htonl(fl->fl_pid);
203 /* Encode owner handle. */
204 if (!(p = xdr_encode_netobj(p, &resp->lock.oh)))
207 start = loff_t_to_s64(fl->fl_start);
208 if (fl->fl_end == OFFSET_MAX)
211 len = loff_t_to_s64(fl->fl_end - fl->fl_start + 1);
213 p = xdr_encode_hyper(p, start);
214 p = xdr_encode_hyper(p, len);
215 dprintk("xdr: encode_testres (status %d pid %d type %d start %Ld end %Ld)\n",
216 resp->status, fl->fl_pid, fl->fl_type,
217 (long long)fl->fl_start, (long long)fl->fl_end);
220 dprintk("xdr: after encode_testres (p %p resp %p)\n", p, resp);
226 * Check buffer bounds after decoding arguments
229 xdr_argsize_check(struct svc_rqst *rqstp, u32 *p)
231 struct svc_buf *buf = &rqstp->rq_argbuf;
233 return p - buf->base <= buf->buflen;
237 xdr_ressize_check(struct svc_rqst *rqstp, u32 *p)
239 struct svc_buf *buf = &rqstp->rq_resbuf;
241 buf->len = p - buf->base;
242 return (buf->len <= buf->buflen);
246 * First, the server side XDR functions
249 nlm4svc_decode_testargs(struct svc_rqst *rqstp, u32 *p, nlm_args *argp)
253 if (!(p = nlm4_decode_cookie(p, &argp->cookie)))
256 exclusive = ntohl(*p++);
257 if (!(p = nlm4_decode_lock(p, &argp->lock)))
260 argp->lock.fl.fl_type = F_WRLCK;
262 return xdr_argsize_check(rqstp, p);
266 nlm4svc_encode_testres(struct svc_rqst *rqstp, u32 *p, struct nlm_res *resp)
268 if (!(p = nlm4_encode_testres(p, resp)))
270 return xdr_ressize_check(rqstp, p);
274 nlm4svc_decode_lockargs(struct svc_rqst *rqstp, u32 *p, nlm_args *argp)
278 if (!(p = nlm4_decode_cookie(p, &argp->cookie)))
280 argp->block = ntohl(*p++);
281 exclusive = ntohl(*p++);
282 if (!(p = nlm4_decode_lock(p, &argp->lock)))
285 argp->lock.fl.fl_type = F_WRLCK;
286 argp->reclaim = ntohl(*p++);
287 argp->state = ntohl(*p++);
288 argp->monitor = 1; /* monitor client by default */
290 return xdr_argsize_check(rqstp, p);
294 nlm4svc_decode_cancargs(struct svc_rqst *rqstp, u32 *p, nlm_args *argp)
298 if (!(p = nlm4_decode_cookie(p, &argp->cookie)))
300 argp->block = ntohl(*p++);
301 exclusive = ntohl(*p++);
302 if (!(p = nlm4_decode_lock(p, &argp->lock)))
305 argp->lock.fl.fl_type = F_WRLCK;
306 return xdr_argsize_check(rqstp, p);
310 nlm4svc_decode_unlockargs(struct svc_rqst *rqstp, u32 *p, nlm_args *argp)
312 if (!(p = nlm4_decode_cookie(p, &argp->cookie))
313 || !(p = nlm4_decode_lock(p, &argp->lock)))
315 argp->lock.fl.fl_type = F_UNLCK;
316 return xdr_argsize_check(rqstp, p);
320 nlm4svc_decode_shareargs(struct svc_rqst *rqstp, u32 *p, nlm_args *argp)
322 struct nlm_lock *lock = &argp->lock;
324 memset(lock, 0, sizeof(*lock));
325 locks_init_lock(&lock->fl);
326 lock->fl.fl_pid = ~(u32) 0;
328 if (!(p = nlm4_decode_cookie(p, &argp->cookie))
329 || !(p = xdr_decode_string_inplace(p, &lock->caller,
330 &lock->len, NLM_MAXSTRLEN))
331 || !(p = nlm4_decode_fh(p, &lock->fh))
332 || !(p = nlm4_decode_oh(p, &lock->oh)))
334 argp->fsm_mode = ntohl(*p++);
335 argp->fsm_access = ntohl(*p++);
336 return xdr_argsize_check(rqstp, p);
340 nlm4svc_encode_shareres(struct svc_rqst *rqstp, u32 *p, struct nlm_res *resp)
342 if (!(p = nlm4_encode_cookie(p, &resp->cookie)))
345 *p++ = xdr_zero; /* sequence argument */
346 return xdr_ressize_check(rqstp, p);
350 nlm4svc_encode_res(struct svc_rqst *rqstp, u32 *p, struct nlm_res *resp)
352 if (!(p = nlm4_encode_cookie(p, &resp->cookie)))
355 return xdr_ressize_check(rqstp, p);
359 nlm4svc_decode_notify(struct svc_rqst *rqstp, u32 *p, struct nlm_args *argp)
361 struct nlm_lock *lock = &argp->lock;
363 if (!(p = xdr_decode_string_inplace(p, &lock->caller,
364 &lock->len, NLM_MAXSTRLEN)))
366 argp->state = ntohl(*p++);
367 return xdr_argsize_check(rqstp, p);
371 nlm4svc_decode_reboot(struct svc_rqst *rqstp, u32 *p, struct nlm_reboot *argp)
373 if (!(p = xdr_decode_string_inplace(p, &argp->mon, &argp->len, SM_MAXSTRLEN)))
375 argp->state = ntohl(*p++);
376 /* Preserve the address in network byte order */
378 return xdr_argsize_check(rqstp, p);
382 nlm4svc_decode_res(struct svc_rqst *rqstp, u32 *p, struct nlm_res *resp)
384 if (!(p = nlm4_decode_cookie(p, &resp->cookie)))
386 resp->status = ntohl(*p++);
387 return xdr_argsize_check(rqstp, p);
391 nlm4svc_decode_void(struct svc_rqst *rqstp, u32 *p, void *dummy)
393 return xdr_argsize_check(rqstp, p);
397 nlm4svc_encode_void(struct svc_rqst *rqstp, u32 *p, void *dummy)
399 return xdr_ressize_check(rqstp, p);
403 * Now, the client side XDR functions
406 nlm4clt_encode_void(struct rpc_rqst *req, u32 *p, void *ptr)
408 req->rq_slen = xdr_adjust_iovec(req->rq_svec, p);
413 nlm4clt_decode_void(struct rpc_rqst *req, u32 *p, void *ptr)
419 nlm4clt_encode_testargs(struct rpc_rqst *req, u32 *p, nlm_args *argp)
421 struct nlm_lock *lock = &argp->lock;
423 if (!(p = nlm4_encode_cookie(p, &argp->cookie)))
425 *p++ = (lock->fl.fl_type == F_WRLCK)? xdr_one : xdr_zero;
426 if (!(p = nlm4_encode_lock(p, lock)))
428 req->rq_slen = xdr_adjust_iovec(req->rq_svec, p);
433 nlm4clt_decode_testres(struct rpc_rqst *req, u32 *p, struct nlm_res *resp)
435 if (!(p = nlm4_decode_cookie(p, &resp->cookie)))
437 resp->status = ntohl(*p++);
438 if (resp->status == NLM_LCK_DENIED) {
439 struct file_lock *fl = &resp->lock.fl;
443 memset(&resp->lock, 0, sizeof(resp->lock));
446 fl->fl_pid = ntohl(*p++);
447 if (!(p = nlm4_decode_oh(p, &resp->lock.oh)))
450 fl->fl_flags = FL_POSIX;
451 fl->fl_type = excl? F_WRLCK : F_RDLCK;
452 p = xdr_decode_hyper(p, &start);
453 p = xdr_decode_hyper(p, &len);
454 end = start + len - 1;
456 fl->fl_start = s64_to_loff_t(start);
457 if (len == 0 || end < 0)
458 fl->fl_end = OFFSET_MAX;
460 fl->fl_end = s64_to_loff_t(end);
467 nlm4clt_encode_lockargs(struct rpc_rqst *req, u32 *p, nlm_args *argp)
469 struct nlm_lock *lock = &argp->lock;
471 if (!(p = nlm4_encode_cookie(p, &argp->cookie)))
473 *p++ = argp->block? xdr_one : xdr_zero;
474 *p++ = (lock->fl.fl_type == F_WRLCK)? xdr_one : xdr_zero;
475 if (!(p = nlm4_encode_lock(p, lock)))
477 *p++ = argp->reclaim? xdr_one : xdr_zero;
478 *p++ = htonl(argp->state);
479 req->rq_slen = xdr_adjust_iovec(req->rq_svec, p);
484 nlm4clt_encode_cancargs(struct rpc_rqst *req, u32 *p, nlm_args *argp)
486 struct nlm_lock *lock = &argp->lock;
488 if (!(p = nlm4_encode_cookie(p, &argp->cookie)))
490 *p++ = argp->block? xdr_one : xdr_zero;
491 *p++ = (lock->fl.fl_type == F_WRLCK)? xdr_one : xdr_zero;
492 if (!(p = nlm4_encode_lock(p, lock)))
494 req->rq_slen = xdr_adjust_iovec(req->rq_svec, p);
499 nlm4clt_encode_unlockargs(struct rpc_rqst *req, u32 *p, nlm_args *argp)
501 struct nlm_lock *lock = &argp->lock;
503 if (!(p = nlm4_encode_cookie(p, &argp->cookie)))
505 if (!(p = nlm4_encode_lock(p, lock)))
507 req->rq_slen = xdr_adjust_iovec(req->rq_svec, p);
512 nlm4clt_encode_res(struct rpc_rqst *req, u32 *p, struct nlm_res *resp)
514 if (!(p = nlm4_encode_cookie(p, &resp->cookie)))
517 req->rq_slen = xdr_adjust_iovec(req->rq_svec, p);
522 nlm4clt_encode_testres(struct rpc_rqst *req, u32 *p, struct nlm_res *resp)
524 if (!(p = nlm4_encode_testres(p, resp)))
526 req->rq_slen = xdr_adjust_iovec(req->rq_svec, p);
531 nlm4clt_decode_res(struct rpc_rqst *req, u32 *p, struct nlm_res *resp)
533 if (!(p = nlm4_decode_cookie(p, &resp->cookie)))
535 resp->status = ntohl(*p++);
540 * Buffer requirements for NLM
542 #define NLM4_void_sz 0
543 #define NLM4_cookie_sz 3 /* 1 len , 2 data */
544 #define NLM4_caller_sz 1+XDR_QUADLEN(NLM_MAXSTRLEN)
545 #define NLM4_netobj_sz 1+XDR_QUADLEN(XDR_MAX_NETOBJ)
546 /* #define NLM4_owner_sz 1+XDR_QUADLEN(NLM4_MAXOWNER) */
547 #define NLM4_fhandle_sz 1+XDR_QUADLEN(NFS3_FHSIZE)
548 #define NLM4_lock_sz 5+NLM4_caller_sz+NLM4_netobj_sz+NLM4_fhandle_sz
549 #define NLM4_holder_sz 6+NLM4_netobj_sz
551 #define NLM4_testargs_sz NLM4_cookie_sz+1+NLM4_lock_sz
552 #define NLM4_lockargs_sz NLM4_cookie_sz+4+NLM4_lock_sz
553 #define NLM4_cancargs_sz NLM4_cookie_sz+2+NLM4_lock_sz
554 #define NLM4_unlockargs_sz NLM4_cookie_sz+NLM4_lock_sz
556 #define NLM4_testres_sz NLM4_cookie_sz+1+NLM4_holder_sz
557 #define NLM4_res_sz NLM4_cookie_sz+1
558 #define NLM4_norep_sz 0
561 # define MAX(a,b) (((a) > (b))? (a) : (b))
565 * For NLM, a void procedure really returns nothing
567 #define nlm4clt_decode_norep NULL
569 #define PROC(proc, argtype, restype) \
570 { .p_procname = "nlm4_" #proc, \
571 .p_encode = (kxdrproc_t) nlm4clt_encode_##argtype, \
572 .p_decode = (kxdrproc_t) nlm4clt_decode_##restype, \
573 .p_bufsiz = MAX(NLM4_##argtype##_sz, NLM4_##restype##_sz) << 2 \
576 static struct rpc_procinfo nlm4_procedures[] = {
577 PROC(null, void, void),
578 PROC(test, testargs, testres),
579 PROC(lock, lockargs, res),
580 PROC(canc, cancargs, res),
581 PROC(unlock, unlockargs, res),
582 PROC(granted, testargs, res),
583 PROC(test_msg, testargs, norep),
584 PROC(lock_msg, lockargs, norep),
585 PROC(canc_msg, cancargs, norep),
586 PROC(unlock_msg, unlockargs, norep),
587 PROC(granted_msg, testargs, norep),
588 PROC(test_res, testres, norep),
589 PROC(lock_res, res, norep),
590 PROC(canc_res, res, norep),
591 PROC(unlock_res, res, norep),
592 PROC(granted_res, res, norep),
593 PROC(undef, void, void),
594 PROC(undef, void, void),
595 PROC(undef, void, void),
596 PROC(undef, void, void),
597 #ifdef NLMCLNT_SUPPORT_SHARES
598 PROC(share, shareargs, shareres),
599 PROC(unshare, shareargs, shareres),
600 PROC(nm_lock, lockargs, res),
601 PROC(free_all, notify, void),
603 PROC(undef, void, void),
604 PROC(undef, void, void),
605 PROC(undef, void, void),
606 PROC(undef, void, void),
610 struct rpc_version nlm_version4 = {
611 4, 24, nlm4_procedures,