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 */
59 else if(len<=NLM_MAXCOOKIELEN)
62 memcpy(c->data, p, len);
68 "lockd: bad cookie size %d (only cookies under %d bytes are supported.)\n", len, NLM_MAXCOOKIELEN);
75 nlm4_encode_cookie(u32 *p, struct nlm_cookie *c)
78 memcpy(p, c->data, c->len);
79 p+=XDR_QUADLEN(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 * First, the server side XDR functions
229 nlm4svc_decode_testargs(struct svc_rqst *rqstp, u32 *p, nlm_args *argp)
233 if (!(p = nlm4_decode_cookie(p, &argp->cookie)))
236 exclusive = ntohl(*p++);
237 if (!(p = nlm4_decode_lock(p, &argp->lock)))
240 argp->lock.fl.fl_type = F_WRLCK;
242 return xdr_argsize_check(rqstp, p);
246 nlm4svc_encode_testres(struct svc_rqst *rqstp, u32 *p, struct nlm_res *resp)
248 if (!(p = nlm4_encode_testres(p, resp)))
250 return xdr_ressize_check(rqstp, p);
254 nlm4svc_decode_lockargs(struct svc_rqst *rqstp, u32 *p, nlm_args *argp)
258 if (!(p = nlm4_decode_cookie(p, &argp->cookie)))
260 argp->block = ntohl(*p++);
261 exclusive = ntohl(*p++);
262 if (!(p = nlm4_decode_lock(p, &argp->lock)))
265 argp->lock.fl.fl_type = F_WRLCK;
266 argp->reclaim = ntohl(*p++);
267 argp->state = ntohl(*p++);
268 argp->monitor = 1; /* monitor client by default */
270 return xdr_argsize_check(rqstp, p);
274 nlm4svc_decode_cancargs(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 return xdr_argsize_check(rqstp, p);
290 nlm4svc_decode_unlockargs(struct svc_rqst *rqstp, u32 *p, nlm_args *argp)
292 if (!(p = nlm4_decode_cookie(p, &argp->cookie))
293 || !(p = nlm4_decode_lock(p, &argp->lock)))
295 argp->lock.fl.fl_type = F_UNLCK;
296 return xdr_argsize_check(rqstp, p);
300 nlm4svc_decode_shareargs(struct svc_rqst *rqstp, u32 *p, nlm_args *argp)
302 struct nlm_lock *lock = &argp->lock;
304 memset(lock, 0, sizeof(*lock));
305 locks_init_lock(&lock->fl);
306 lock->fl.fl_pid = ~(u32) 0;
308 if (!(p = nlm4_decode_cookie(p, &argp->cookie))
309 || !(p = xdr_decode_string_inplace(p, &lock->caller,
310 &lock->len, NLM_MAXSTRLEN))
311 || !(p = nlm4_decode_fh(p, &lock->fh))
312 || !(p = nlm4_decode_oh(p, &lock->oh)))
314 argp->fsm_mode = ntohl(*p++);
315 argp->fsm_access = ntohl(*p++);
316 return xdr_argsize_check(rqstp, p);
320 nlm4svc_encode_shareres(struct svc_rqst *rqstp, u32 *p, struct nlm_res *resp)
322 if (!(p = nlm4_encode_cookie(p, &resp->cookie)))
325 *p++ = xdr_zero; /* sequence argument */
326 return xdr_ressize_check(rqstp, p);
330 nlm4svc_encode_res(struct svc_rqst *rqstp, u32 *p, struct nlm_res *resp)
332 if (!(p = nlm4_encode_cookie(p, &resp->cookie)))
335 return xdr_ressize_check(rqstp, p);
339 nlm4svc_decode_notify(struct svc_rqst *rqstp, u32 *p, struct nlm_args *argp)
341 struct nlm_lock *lock = &argp->lock;
343 if (!(p = xdr_decode_string_inplace(p, &lock->caller,
344 &lock->len, NLM_MAXSTRLEN)))
346 argp->state = ntohl(*p++);
347 return xdr_argsize_check(rqstp, p);
351 nlm4svc_decode_reboot(struct svc_rqst *rqstp, u32 *p, struct nlm_reboot *argp)
353 if (!(p = xdr_decode_string_inplace(p, &argp->mon, &argp->len, SM_MAXSTRLEN)))
355 argp->state = ntohl(*p++);
356 /* Preserve the address in network byte order */
358 return xdr_argsize_check(rqstp, p);
362 nlm4svc_decode_res(struct svc_rqst *rqstp, u32 *p, struct nlm_res *resp)
364 if (!(p = nlm4_decode_cookie(p, &resp->cookie)))
366 resp->status = ntohl(*p++);
367 return xdr_argsize_check(rqstp, p);
371 nlm4svc_decode_void(struct svc_rqst *rqstp, u32 *p, void *dummy)
373 return xdr_argsize_check(rqstp, p);
377 nlm4svc_encode_void(struct svc_rqst *rqstp, u32 *p, void *dummy)
379 return xdr_ressize_check(rqstp, p);
383 * Now, the client side XDR functions
385 #ifdef NLMCLNT_SUPPORT_SHARES
387 nlm4clt_decode_void(struct rpc_rqst *req, u32 *p, void *ptr)
394 nlm4clt_encode_testargs(struct rpc_rqst *req, u32 *p, nlm_args *argp)
396 struct nlm_lock *lock = &argp->lock;
398 if (!(p = nlm4_encode_cookie(p, &argp->cookie)))
400 *p++ = (lock->fl.fl_type == F_WRLCK)? xdr_one : xdr_zero;
401 if (!(p = nlm4_encode_lock(p, lock)))
403 req->rq_slen = xdr_adjust_iovec(req->rq_svec, p);
408 nlm4clt_decode_testres(struct rpc_rqst *req, u32 *p, struct nlm_res *resp)
410 if (!(p = nlm4_decode_cookie(p, &resp->cookie)))
412 resp->status = ntohl(*p++);
413 if (resp->status == NLM_LCK_DENIED) {
414 struct file_lock *fl = &resp->lock.fl;
418 memset(&resp->lock, 0, sizeof(resp->lock));
421 fl->fl_pid = ntohl(*p++);
422 if (!(p = nlm4_decode_oh(p, &resp->lock.oh)))
425 fl->fl_flags = FL_POSIX;
426 fl->fl_type = excl? F_WRLCK : F_RDLCK;
427 p = xdr_decode_hyper(p, &start);
428 p = xdr_decode_hyper(p, &len);
429 end = start + len - 1;
431 fl->fl_start = s64_to_loff_t(start);
432 if (len == 0 || end < 0)
433 fl->fl_end = OFFSET_MAX;
435 fl->fl_end = s64_to_loff_t(end);
442 nlm4clt_encode_lockargs(struct rpc_rqst *req, u32 *p, nlm_args *argp)
444 struct nlm_lock *lock = &argp->lock;
446 if (!(p = nlm4_encode_cookie(p, &argp->cookie)))
448 *p++ = argp->block? xdr_one : xdr_zero;
449 *p++ = (lock->fl.fl_type == F_WRLCK)? xdr_one : xdr_zero;
450 if (!(p = nlm4_encode_lock(p, lock)))
452 *p++ = argp->reclaim? xdr_one : xdr_zero;
453 *p++ = htonl(argp->state);
454 req->rq_slen = xdr_adjust_iovec(req->rq_svec, p);
459 nlm4clt_encode_cancargs(struct rpc_rqst *req, u32 *p, nlm_args *argp)
461 struct nlm_lock *lock = &argp->lock;
463 if (!(p = nlm4_encode_cookie(p, &argp->cookie)))
465 *p++ = argp->block? xdr_one : xdr_zero;
466 *p++ = (lock->fl.fl_type == F_WRLCK)? xdr_one : xdr_zero;
467 if (!(p = nlm4_encode_lock(p, lock)))
469 req->rq_slen = xdr_adjust_iovec(req->rq_svec, p);
474 nlm4clt_encode_unlockargs(struct rpc_rqst *req, u32 *p, nlm_args *argp)
476 struct nlm_lock *lock = &argp->lock;
478 if (!(p = nlm4_encode_cookie(p, &argp->cookie)))
480 if (!(p = nlm4_encode_lock(p, lock)))
482 req->rq_slen = xdr_adjust_iovec(req->rq_svec, p);
487 nlm4clt_encode_res(struct rpc_rqst *req, u32 *p, struct nlm_res *resp)
489 if (!(p = nlm4_encode_cookie(p, &resp->cookie)))
492 req->rq_slen = xdr_adjust_iovec(req->rq_svec, p);
497 nlm4clt_encode_testres(struct rpc_rqst *req, u32 *p, struct nlm_res *resp)
499 if (!(p = nlm4_encode_testres(p, resp)))
501 req->rq_slen = xdr_adjust_iovec(req->rq_svec, p);
506 nlm4clt_decode_res(struct rpc_rqst *req, u32 *p, struct nlm_res *resp)
508 if (!(p = nlm4_decode_cookie(p, &resp->cookie)))
510 resp->status = ntohl(*p++);
515 * Buffer requirements for NLM
517 #define NLM4_void_sz 0
518 #define NLM4_cookie_sz 1+XDR_QUADLEN(NLM_MAXCOOKIELEN)
519 #define NLM4_caller_sz 1+XDR_QUADLEN(NLM_MAXSTRLEN)
520 #define NLM4_netobj_sz 1+XDR_QUADLEN(XDR_MAX_NETOBJ)
521 /* #define NLM4_owner_sz 1+XDR_QUADLEN(NLM4_MAXOWNER) */
522 #define NLM4_fhandle_sz 1+XDR_QUADLEN(NFS3_FHSIZE)
523 #define NLM4_lock_sz 5+NLM4_caller_sz+NLM4_netobj_sz+NLM4_fhandle_sz
524 #define NLM4_holder_sz 6+NLM4_netobj_sz
526 #define NLM4_testargs_sz NLM4_cookie_sz+1+NLM4_lock_sz
527 #define NLM4_lockargs_sz NLM4_cookie_sz+4+NLM4_lock_sz
528 #define NLM4_cancargs_sz NLM4_cookie_sz+2+NLM4_lock_sz
529 #define NLM4_unlockargs_sz NLM4_cookie_sz+NLM4_lock_sz
531 #define NLM4_testres_sz NLM4_cookie_sz+1+NLM4_holder_sz
532 #define NLM4_res_sz NLM4_cookie_sz+1
533 #define NLM4_norep_sz 0
536 # define MAX(a,b) (((a) > (b))? (a) : (b))
540 * For NLM, a void procedure really returns nothing
542 #define nlm4clt_decode_norep NULL
544 #define PROC(proc, argtype, restype) \
545 [NLMPROC_##proc] = { \
546 .p_proc = NLMPROC_##proc, \
547 .p_encode = (kxdrproc_t) nlm4clt_encode_##argtype, \
548 .p_decode = (kxdrproc_t) nlm4clt_decode_##restype, \
549 .p_bufsiz = MAX(NLM4_##argtype##_sz, NLM4_##restype##_sz) << 2 \
552 static struct rpc_procinfo nlm4_procedures[] = {
553 PROC(TEST, testargs, testres),
554 PROC(LOCK, lockargs, res),
555 PROC(CANCEL, cancargs, res),
556 PROC(UNLOCK, unlockargs, res),
557 PROC(GRANTED, testargs, res),
558 PROC(TEST_MSG, testargs, norep),
559 PROC(LOCK_MSG, lockargs, norep),
560 PROC(CANCEL_MSG, cancargs, norep),
561 PROC(UNLOCK_MSG, unlockargs, norep),
562 PROC(GRANTED_MSG, testargs, norep),
563 PROC(TEST_RES, testres, norep),
564 PROC(LOCK_RES, res, norep),
565 PROC(CANCEL_RES, res, norep),
566 PROC(UNLOCK_RES, res, norep),
567 PROC(GRANTED_RES, res, norep),
568 #ifdef NLMCLNT_SUPPORT_SHARES
569 PROC(SHARE, shareargs, shareres),
570 PROC(UNSHARE, shareargs, shareres),
571 PROC(NM_LOCK, lockargs, res),
572 PROC(FREE_ALL, notify, void),
576 struct rpc_version nlm_version4 = {
579 .procs = nlm4_procedures,