4 * XDR support for lockd and the lock client.
6 * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
9 #include <linux/types.h>
10 #include <linux/sched.h>
11 #include <linux/utsname.h>
12 #include <linux/nfs.h>
14 #include <linux/sunrpc/xdr.h>
15 #include <linux/sunrpc/clnt.h>
16 #include <linux/sunrpc/svc.h>
17 #include <linux/sunrpc/stats.h>
18 #include <linux/lockd/lockd.h>
19 #include <linux/lockd/sm_inter.h>
21 #define NLMDBG_FACILITY NLMDBG_XDR
25 s32_to_loff_t(__s32 offset)
27 return (loff_t)offset;
31 loff_t_to_s32(loff_t offset)
34 if (offset >= NLM_OFFSET_MAX)
36 else if (offset <= -NLM_OFFSET_MAX)
37 res = -NLM_OFFSET_MAX;
44 * XDR functions for basic NLM types
46 static __be32 *nlm_decode_cookie(__be32 *p, struct nlm_cookie *c)
55 memset(c->data, 0, 4); /* hockeypux brain damage */
57 else if(len<=NLM_MAXCOOKIELEN)
60 memcpy(c->data, p, len);
65 dprintk("lockd: bad cookie size %d (only cookies under "
66 "%d bytes are supported.)\n",
67 len, NLM_MAXCOOKIELEN);
73 static inline __be32 *
74 nlm_encode_cookie(__be32 *p, struct nlm_cookie *c)
77 memcpy(p, c->data, c->len);
78 p+=XDR_QUADLEN(c->len);
83 nlm_decode_fh(__be32 *p, struct nfs_fh *f)
87 if ((len = ntohl(*p++)) != NFS2_FHSIZE) {
88 dprintk("lockd: bad fhandle size %d (should be %d)\n",
92 f->size = NFS2_FHSIZE;
93 memset(f->data, 0, sizeof(f->data));
94 memcpy(f->data, p, NFS2_FHSIZE);
95 return p + XDR_QUADLEN(NFS2_FHSIZE);
98 static inline __be32 *
99 nlm_encode_fh(__be32 *p, struct nfs_fh *f)
101 *p++ = htonl(NFS2_FHSIZE);
102 memcpy(p, f->data, NFS2_FHSIZE);
103 return p + XDR_QUADLEN(NFS2_FHSIZE);
107 * Encode and decode owner handle
109 static inline __be32 *
110 nlm_decode_oh(__be32 *p, struct xdr_netobj *oh)
112 return xdr_decode_netobj(p, oh);
115 static inline __be32 *
116 nlm_encode_oh(__be32 *p, struct xdr_netobj *oh)
118 return xdr_encode_netobj(p, oh);
122 nlm_decode_lock(__be32 *p, struct nlm_lock *lock)
124 struct file_lock *fl = &lock->fl;
127 if (!(p = xdr_decode_string_inplace(p, &lock->caller,
130 || !(p = nlm_decode_fh(p, &lock->fh))
131 || !(p = nlm_decode_oh(p, &lock->oh)))
133 lock->svid = ntohl(*p++);
136 fl->fl_owner = current->files;
137 fl->fl_pid = (pid_t)lock->svid;
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(__be32 *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(lock->svid);
185 * Encode result of a TEST/TEST_MSG call
188 nlm_encode_testres(__be32 *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(resp->lock.svid);
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, __be32 *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, __be32 *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, __be32 *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, __be32 *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, __be32 *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, __be32 *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->svid = ~(u32) 0;
302 lock->fl.fl_pid = (pid_t)lock->svid;
304 if (!(p = nlm_decode_cookie(p, &argp->cookie))
305 || !(p = xdr_decode_string_inplace(p, &lock->caller,
306 &lock->len, NLM_MAXSTRLEN))
307 || !(p = nlm_decode_fh(p, &lock->fh))
308 || !(p = nlm_decode_oh(p, &lock->oh)))
310 argp->fsm_mode = ntohl(*p++);
311 argp->fsm_access = ntohl(*p++);
312 return xdr_argsize_check(rqstp, p);
316 nlmsvc_encode_shareres(struct svc_rqst *rqstp, __be32 *p, struct nlm_res *resp)
318 if (!(p = nlm_encode_cookie(p, &resp->cookie)))
321 *p++ = xdr_zero; /* sequence argument */
322 return xdr_ressize_check(rqstp, p);
326 nlmsvc_encode_res(struct svc_rqst *rqstp, __be32 *p, struct nlm_res *resp)
328 if (!(p = nlm_encode_cookie(p, &resp->cookie)))
331 return xdr_ressize_check(rqstp, p);
335 nlmsvc_decode_notify(struct svc_rqst *rqstp, __be32 *p, struct nlm_args *argp)
337 struct nlm_lock *lock = &argp->lock;
339 if (!(p = xdr_decode_string_inplace(p, &lock->caller,
340 &lock->len, NLM_MAXSTRLEN)))
342 argp->state = ntohl(*p++);
343 return xdr_argsize_check(rqstp, p);
347 nlmsvc_decode_reboot(struct svc_rqst *rqstp, __be32 *p, struct nlm_reboot *argp)
349 if (!(p = xdr_decode_string_inplace(p, &argp->mon, &argp->len, SM_MAXSTRLEN)))
351 argp->state = ntohl(*p++);
352 /* Preserve the address in network byte order */
354 return xdr_argsize_check(rqstp, p);
358 nlmsvc_decode_res(struct svc_rqst *rqstp, __be32 *p, struct nlm_res *resp)
360 if (!(p = nlm_decode_cookie(p, &resp->cookie)))
363 return xdr_argsize_check(rqstp, p);
367 nlmsvc_decode_void(struct svc_rqst *rqstp, __be32 *p, void *dummy)
369 return xdr_argsize_check(rqstp, p);
373 nlmsvc_encode_void(struct svc_rqst *rqstp, __be32 *p, void *dummy)
375 return xdr_ressize_check(rqstp, p);
379 * Now, the client side XDR functions
381 #ifdef NLMCLNT_SUPPORT_SHARES
383 nlmclt_decode_void(struct rpc_rqst *req, u32 *p, void *ptr)
390 nlmclt_encode_testargs(struct rpc_rqst *req, __be32 *p, nlm_args *argp)
392 struct nlm_lock *lock = &argp->lock;
394 if (!(p = nlm_encode_cookie(p, &argp->cookie)))
396 *p++ = (lock->fl.fl_type == F_WRLCK)? xdr_one : xdr_zero;
397 if (!(p = nlm_encode_lock(p, lock)))
399 req->rq_slen = xdr_adjust_iovec(req->rq_svec, p);
404 nlmclt_decode_testres(struct rpc_rqst *req, __be32 *p, struct nlm_res *resp)
406 if (!(p = nlm_decode_cookie(p, &resp->cookie)))
409 if (resp->status == nlm_lck_denied) {
410 struct file_lock *fl = &resp->lock.fl;
414 memset(&resp->lock, 0, sizeof(resp->lock));
417 resp->lock.svid = ntohl(*p++);
418 fl->fl_pid = (pid_t)resp->lock.svid;
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, __be32 *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, __be32 *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, __be32 *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, __be32 *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, __be32 *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, __be32 *p, struct nlm_res *resp)
505 if (!(p = nlm_decode_cookie(p, &resp->cookie)))
511 #if (NLMCLNT_OHSIZE > XDR_MAX_NETOBJ)
512 # error "NLM host name cannot be larger than XDR_MAX_NETOBJ!"
516 * Buffer requirements for NLM
518 #define NLM_void_sz 0
519 #define NLM_cookie_sz 1+XDR_QUADLEN(NLM_MAXCOOKIELEN)
520 #define NLM_caller_sz 1+XDR_QUADLEN(NLMCLNT_OHSIZE)
521 #define NLM_owner_sz 1+XDR_QUADLEN(NLMCLNT_OHSIZE)
522 #define NLM_fhandle_sz 1+XDR_QUADLEN(NFS2_FHSIZE)
523 #define NLM_lock_sz 3+NLM_caller_sz+NLM_owner_sz+NLM_fhandle_sz
524 #define NLM_holder_sz 4+NLM_owner_sz
526 #define NLM_testargs_sz NLM_cookie_sz+1+NLM_lock_sz
527 #define NLM_lockargs_sz NLM_cookie_sz+4+NLM_lock_sz
528 #define NLM_cancargs_sz NLM_cookie_sz+2+NLM_lock_sz
529 #define NLM_unlockargs_sz NLM_cookie_sz+NLM_lock_sz
531 #define NLM_testres_sz NLM_cookie_sz+1+NLM_holder_sz
532 #define NLM_res_sz NLM_cookie_sz+1
533 #define NLM_norep_sz 0
536 * For NLM, a void procedure really returns nothing
538 #define nlmclt_decode_norep NULL
540 #define PROC(proc, argtype, restype) \
541 [NLMPROC_##proc] = { \
542 .p_proc = NLMPROC_##proc, \
543 .p_encode = (kxdrproc_t) nlmclt_encode_##argtype, \
544 .p_decode = (kxdrproc_t) nlmclt_decode_##restype, \
545 .p_arglen = NLM_##argtype##_sz, \
546 .p_replen = NLM_##restype##_sz, \
547 .p_statidx = NLMPROC_##proc, \
551 static struct rpc_procinfo nlm_procedures[] = {
552 PROC(TEST, testargs, testres),
553 PROC(LOCK, lockargs, res),
554 PROC(CANCEL, cancargs, res),
555 PROC(UNLOCK, unlockargs, res),
556 PROC(GRANTED, testargs, res),
557 PROC(TEST_MSG, testargs, norep),
558 PROC(LOCK_MSG, lockargs, norep),
559 PROC(CANCEL_MSG, cancargs, norep),
560 PROC(UNLOCK_MSG, unlockargs, norep),
561 PROC(GRANTED_MSG, testargs, norep),
562 PROC(TEST_RES, testres, norep),
563 PROC(LOCK_RES, res, norep),
564 PROC(CANCEL_RES, res, norep),
565 PROC(UNLOCK_RES, res, norep),
566 PROC(GRANTED_RES, res, norep),
567 #ifdef NLMCLNT_SUPPORT_SHARES
568 PROC(SHARE, shareargs, shareres),
569 PROC(UNSHARE, shareargs, shareres),
570 PROC(NM_LOCK, lockargs, res),
571 PROC(FREE_ALL, notify, void),
575 static struct rpc_version nlm_version1 = {
578 .procs = nlm_procedures,
581 static struct rpc_version nlm_version3 = {
584 .procs = nlm_procedures,
587 static struct rpc_version * nlm_versions[] = {
590 #ifdef CONFIG_LOCKD_V4
595 static struct rpc_stat nlm_stats;
597 struct rpc_program nlm_program = {
599 .number = NLM_PROGRAM,
600 .nrvers = ARRAY_SIZE(nlm_versions),
601 .version = nlm_versions,
606 const char *nlmdbg_cookie2a(const struct nlm_cookie *cookie)
609 * We can get away with a static buffer because we're only
610 * called with BKL held.
612 static char buf[2*NLM_MAXCOOKIELEN+1];
613 unsigned int i, len = sizeof(buf);
616 len--; /* allow for trailing \0 */
619 for (i = 0 ; i < cookie->len ; i++) {
624 sprintf(p, "%02x", cookie->data[i]);