2 * linux/fs/lockd/clnt4xdr.c
4 * XDR functions to encode/decode NLM version 4 RPC arguments and results.
6 * NLM client-side only.
8 * Copyright (C) 2010, Oracle. All rights reserved.
11 #include <linux/types.h>
12 #include <linux/sunrpc/xdr.h>
13 #include <linux/sunrpc/clnt.h>
14 #include <linux/sunrpc/stats.h>
15 #include <linux/lockd/lockd.h>
17 #define NLMDBG_FACILITY NLMDBG_XDR
19 #if (NLMCLNT_OHSIZE > XDR_MAX_NETOBJ)
20 # error "NLM host name cannot be larger than XDR_MAX_NETOBJ!"
23 #if (NLMCLNT_OHSIZE > NLM_MAXSTRLEN)
24 # error "NLM host name cannot be larger than NLM's maximum string length!"
28 * Declare the space requirements for NLM arguments and replies as
29 * number of 32bit-words
31 #define NLM4_void_sz (0)
32 #define NLM4_cookie_sz (1+(NLM_MAXCOOKIELEN>>2))
33 #define NLM4_caller_sz (1+(NLMCLNT_OHSIZE>>2))
34 #define NLM4_owner_sz (1+(NLMCLNT_OHSIZE>>2))
35 #define NLM4_fhandle_sz (1+(NFS3_FHSIZE>>2))
36 #define NLM4_lock_sz (5+NLM4_caller_sz+NLM4_owner_sz+NLM4_fhandle_sz)
37 #define NLM4_holder_sz (6+NLM4_owner_sz)
39 #define NLM4_testargs_sz (NLM4_cookie_sz+1+NLM4_lock_sz)
40 #define NLM4_lockargs_sz (NLM4_cookie_sz+4+NLM4_lock_sz)
41 #define NLM4_cancargs_sz (NLM4_cookie_sz+2+NLM4_lock_sz)
42 #define NLM4_unlockargs_sz (NLM4_cookie_sz+NLM4_lock_sz)
44 #define NLM4_testres_sz (NLM4_cookie_sz+1+NLM4_holder_sz)
45 #define NLM4_res_sz (NLM4_cookie_sz+1)
46 #define NLM4_norep_sz (0)
49 static s64 loff_t_to_s64(loff_t offset)
53 if (offset >= NLM4_OFFSET_MAX)
54 res = NLM4_OFFSET_MAX;
55 else if (offset <= -NLM4_OFFSET_MAX)
56 res = -NLM4_OFFSET_MAX;
62 static void nlm4_compute_offsets(const struct nlm_lock *lock,
63 u64 *l_offset, u64 *l_len)
65 const struct file_lock *fl = &lock->fl;
67 BUG_ON(fl->fl_start > NLM4_OFFSET_MAX);
68 BUG_ON(fl->fl_end > NLM4_OFFSET_MAX &&
69 fl->fl_end != OFFSET_MAX);
71 *l_offset = loff_t_to_s64(fl->fl_start);
72 if (fl->fl_end == OFFSET_MAX)
75 *l_len = loff_t_to_s64(fl->fl_end - fl->fl_start + 1);
79 * Handle decode buffer overflows out-of-line.
81 static void print_overflow_msg(const char *func, const struct xdr_stream *xdr)
83 dprintk("lockd: %s prematurely hit the end of our receive buffer. "
84 "Remaining buffer length is %tu words.\n",
85 func, xdr->end - xdr->p);
90 * Encode/decode NLMv4 basic data types
92 * Basic NLMv4 data types are defined in Appendix II, section 6.1.4
93 * of RFC 1813: "NFS Version 3 Protocol Specification" and in Chapter
94 * 10 of X/Open's "Protocols for Interworking: XNFS, Version 3W".
96 * Not all basic data types have their own encoding and decoding
97 * functions. For run-time efficiency, some data types are encoded
101 static void encode_bool(struct xdr_stream *xdr, const int value)
105 p = xdr_reserve_space(xdr, 4);
106 *p = value ? xdr_one : xdr_zero;
109 static void encode_int32(struct xdr_stream *xdr, const s32 value)
113 p = xdr_reserve_space(xdr, 4);
114 *p = cpu_to_be32(value);
118 * typedef opaque netobj<MAXNETOBJ_SZ>
120 static void encode_netobj(struct xdr_stream *xdr,
121 const u8 *data, const unsigned int length)
125 BUG_ON(length > XDR_MAX_NETOBJ);
126 p = xdr_reserve_space(xdr, 4 + length);
127 xdr_encode_opaque(p, data, length);
130 static int decode_netobj(struct xdr_stream *xdr,
131 struct xdr_netobj *obj)
136 p = xdr_inline_decode(xdr, 4);
137 if (unlikely(p == NULL))
139 length = be32_to_cpup(p++);
140 if (unlikely(length > XDR_MAX_NETOBJ))
146 dprintk("NFS: returned netobj was too long: %u\n", length);
149 print_overflow_msg(__func__, xdr);
156 static void encode_cookie(struct xdr_stream *xdr,
157 const struct nlm_cookie *cookie)
159 BUG_ON(cookie->len > NLM_MAXCOOKIELEN);
160 encode_netobj(xdr, (u8 *)&cookie->data, cookie->len);
163 static int decode_cookie(struct xdr_stream *xdr,
164 struct nlm_cookie *cookie)
169 p = xdr_inline_decode(xdr, 4);
170 if (unlikely(p == NULL))
172 length = be32_to_cpup(p++);
173 /* apparently HPUX can return empty cookies */
176 if (length > NLM_MAXCOOKIELEN)
178 p = xdr_inline_decode(xdr, length);
179 if (unlikely(p == NULL))
181 cookie->len = length;
182 memcpy(cookie->data, p, length);
186 memset(cookie->data, 0, 4);
189 dprintk("NFS: returned cookie was too long: %u\n", length);
192 print_overflow_msg(__func__, xdr);
199 static void encode_fh(struct xdr_stream *xdr, const struct nfs_fh *fh)
201 BUG_ON(fh->size > NFS3_FHSIZE);
202 encode_netobj(xdr, (u8 *)&fh->data, fh->size);
209 * NLM4_DENIED_NOLOCKS = 2,
211 * NLM4_DENIED_GRACE_PERIOD = 4,
223 * NB: we don't swap bytes for the NLM status values. The upper
224 * layers deal directly with the status value in network byte
227 static void encode_nlm4_stat(struct xdr_stream *xdr,
232 BUG_ON(be32_to_cpu(stat) > NLM_FAILED);
233 p = xdr_reserve_space(xdr, 4);
237 static int decode_nlm4_stat(struct xdr_stream *xdr, __be32 *stat)
241 p = xdr_inline_decode(xdr, 4);
242 if (unlikely(p == NULL))
244 if (unlikely(*p > nlm4_failed))
249 dprintk("%s: server returned invalid nlm4_stats value: %u\n",
250 __func__, be32_to_cpup(p));
253 print_overflow_msg(__func__, xdr);
258 * struct nlm4_holder {
266 static void encode_nlm4_holder(struct xdr_stream *xdr,
267 const struct nlm_res *result)
269 const struct nlm_lock *lock = &result->lock;
273 encode_bool(xdr, lock->fl.fl_type == F_RDLCK);
274 encode_int32(xdr, lock->svid);
275 encode_netobj(xdr, lock->oh.data, lock->oh.len);
277 p = xdr_reserve_space(xdr, 4 + 4);
278 nlm4_compute_offsets(lock, &l_offset, &l_len);
279 p = xdr_encode_hyper(p, l_offset);
280 xdr_encode_hyper(p, l_len);
283 static int decode_nlm4_holder(struct xdr_stream *xdr, struct nlm_res *result)
285 struct nlm_lock *lock = &result->lock;
286 struct file_lock *fl = &lock->fl;
293 memset(lock, 0, sizeof(*lock));
296 p = xdr_inline_decode(xdr, 4 + 4);
297 if (unlikely(p == NULL))
299 exclusive = be32_to_cpup(p++);
300 lock->svid = be32_to_cpup(p);
301 fl->fl_pid = (pid_t)lock->svid;
303 error = decode_netobj(xdr, &lock->oh);
307 p = xdr_inline_decode(xdr, 8 + 8);
308 if (unlikely(p == NULL))
311 fl->fl_flags = FL_POSIX;
312 fl->fl_type = exclusive != 0 ? F_WRLCK : F_RDLCK;
313 p = xdr_decode_hyper(p, &l_offset);
314 xdr_decode_hyper(p, &l_len);
315 end = l_offset + l_len - 1;
317 fl->fl_start = (loff_t)l_offset;
318 if (l_len == 0 || end < 0)
319 fl->fl_end = OFFSET_MAX;
321 fl->fl_end = (loff_t)end;
326 print_overflow_msg(__func__, xdr);
331 * string caller_name<LM_MAXSTRLEN>;
333 static void encode_caller_name(struct xdr_stream *xdr, const char *name)
335 /* NB: client-side does not set lock->len */
336 u32 length = strlen(name);
339 BUG_ON(length > NLM_MAXSTRLEN);
340 p = xdr_reserve_space(xdr, 4 + length);
341 xdr_encode_opaque(p, name, length);
346 * string caller_name<LM_MAXSTRLEN>;
354 static void encode_nlm4_lock(struct xdr_stream *xdr,
355 const struct nlm_lock *lock)
360 encode_caller_name(xdr, lock->caller);
361 encode_fh(xdr, &lock->fh);
362 encode_netobj(xdr, lock->oh.data, lock->oh.len);
364 p = xdr_reserve_space(xdr, 4 + 8 + 8);
365 *p++ = cpu_to_be32(lock->svid);
367 nlm4_compute_offsets(lock, &l_offset, &l_len);
368 p = xdr_encode_hyper(p, l_offset);
369 xdr_encode_hyper(p, l_len);
374 * NLMv4 XDR encode functions
376 * NLMv4 argument types are defined in Appendix II of RFC 1813:
377 * "NFS Version 3 Protocol Specification" and Chapter 10 of X/Open's
378 * "Protocols for Interworking: XNFS, Version 3W".
382 * struct nlm4_testargs {
385 * struct nlm4_lock alock;
388 static void nlm4_xdr_enc_testargs(struct rpc_rqst *req,
389 struct xdr_stream *xdr,
390 const struct nlm_args *args)
392 const struct nlm_lock *lock = &args->lock;
394 encode_cookie(xdr, &args->cookie);
395 encode_bool(xdr, lock->fl.fl_type == F_WRLCK);
396 encode_nlm4_lock(xdr, lock);
400 * struct nlm4_lockargs {
404 * struct nlm4_lock alock;
409 static void nlm4_xdr_enc_lockargs(struct rpc_rqst *req,
410 struct xdr_stream *xdr,
411 const struct nlm_args *args)
413 const struct nlm_lock *lock = &args->lock;
415 encode_cookie(xdr, &args->cookie);
416 encode_bool(xdr, args->block);
417 encode_bool(xdr, lock->fl.fl_type == F_WRLCK);
418 encode_nlm4_lock(xdr, lock);
419 encode_bool(xdr, args->reclaim);
420 encode_int32(xdr, args->state);
424 * struct nlm4_cancargs {
428 * struct nlm4_lock alock;
431 static void nlm4_xdr_enc_cancargs(struct rpc_rqst *req,
432 struct xdr_stream *xdr,
433 const struct nlm_args *args)
435 const struct nlm_lock *lock = &args->lock;
437 encode_cookie(xdr, &args->cookie);
438 encode_bool(xdr, args->block);
439 encode_bool(xdr, lock->fl.fl_type == F_WRLCK);
440 encode_nlm4_lock(xdr, lock);
444 * struct nlm4_unlockargs {
446 * struct nlm4_lock alock;
449 static void nlm4_xdr_enc_unlockargs(struct rpc_rqst *req,
450 struct xdr_stream *xdr,
451 const struct nlm_args *args)
453 const struct nlm_lock *lock = &args->lock;
455 encode_cookie(xdr, &args->cookie);
456 encode_nlm4_lock(xdr, lock);
465 static void nlm4_xdr_enc_res(struct rpc_rqst *req,
466 struct xdr_stream *xdr,
467 const struct nlm_res *result)
469 encode_cookie(xdr, &result->cookie);
470 encode_nlm4_stat(xdr, result->status);
474 * union nlm4_testrply switch (nlm4_stats stat) {
476 * struct nlm4_holder holder;
481 * struct nlm4_testres {
483 * nlm4_testrply test_stat;
486 static void nlm4_xdr_enc_testres(struct rpc_rqst *req,
487 struct xdr_stream *xdr,
488 const struct nlm_res *result)
490 encode_cookie(xdr, &result->cookie);
491 encode_nlm4_stat(xdr, result->status);
492 if (result->status == nlm_lck_denied)
493 encode_nlm4_holder(xdr, result);
498 * NLMv4 XDR decode functions
500 * NLMv4 argument types are defined in Appendix II of RFC 1813:
501 * "NFS Version 3 Protocol Specification" and Chapter 10 of X/Open's
502 * "Protocols for Interworking: XNFS, Version 3W".
506 * union nlm4_testrply switch (nlm4_stats stat) {
508 * struct nlm4_holder holder;
513 * struct nlm4_testres {
515 * nlm4_testrply test_stat;
518 static int decode_nlm4_testrply(struct xdr_stream *xdr,
519 struct nlm_res *result)
523 error = decode_nlm4_stat(xdr, &result->status);
526 if (result->status == nlm_lck_denied)
527 error = decode_nlm4_holder(xdr, result);
532 static int nlm4_xdr_dec_testres(struct rpc_rqst *req,
533 struct xdr_stream *xdr,
534 struct nlm_res *result)
538 error = decode_cookie(xdr, &result->cookie);
541 error = decode_nlm4_testrply(xdr, result);
552 static int nlm4_xdr_dec_res(struct rpc_rqst *req,
553 struct xdr_stream *xdr,
554 struct nlm_res *result)
558 error = decode_cookie(xdr, &result->cookie);
561 error = decode_nlm4_stat(xdr, &result->status);
568 * For NLM, a void procedure really returns nothing
570 #define nlm4_xdr_dec_norep NULL
572 #define PROC(proc, argtype, restype) \
573 [NLMPROC_##proc] = { \
574 .p_proc = NLMPROC_##proc, \
575 .p_encode = (kxdreproc_t)nlm4_xdr_enc_##argtype, \
576 .p_decode = (kxdrdproc_t)nlm4_xdr_dec_##restype, \
577 .p_arglen = NLM4_##argtype##_sz, \
578 .p_replen = NLM4_##restype##_sz, \
579 .p_statidx = NLMPROC_##proc, \
583 static struct rpc_procinfo nlm4_procedures[] = {
584 PROC(TEST, testargs, testres),
585 PROC(LOCK, lockargs, res),
586 PROC(CANCEL, cancargs, res),
587 PROC(UNLOCK, unlockargs, res),
588 PROC(GRANTED, testargs, res),
589 PROC(TEST_MSG, testargs, norep),
590 PROC(LOCK_MSG, lockargs, norep),
591 PROC(CANCEL_MSG, cancargs, norep),
592 PROC(UNLOCK_MSG, unlockargs, norep),
593 PROC(GRANTED_MSG, testargs, norep),
594 PROC(TEST_RES, testres, norep),
595 PROC(LOCK_RES, res, norep),
596 PROC(CANCEL_RES, res, norep),
597 PROC(UNLOCK_RES, res, norep),
598 PROC(GRANTED_RES, res, norep),
601 struct rpc_version nlm_version4 = {
603 .nrprocs = ARRAY_SIZE(nlm4_procedures),
604 .procs = nlm4_procedures,