2 * linux/fs/nfs/callback_xdr.c
4 * Copyright (C) 2004 Trond Myklebust
6 * NFSv4 callback encode/decode procedures
8 #include <linux/kernel.h>
9 #include <linux/sunrpc/svc.h>
10 #include <linux/nfs4.h>
11 #include <linux/nfs_fs.h>
15 #define CB_OP_TAGLEN_MAXSZ (512)
16 #define CB_OP_HDR_RES_MAXSZ (2 + CB_OP_TAGLEN_MAXSZ)
17 #define CB_OP_GETATTR_BITMAP_MAXSZ (4)
18 #define CB_OP_GETATTR_RES_MAXSZ (CB_OP_HDR_RES_MAXSZ + \
19 CB_OP_GETATTR_BITMAP_MAXSZ + \
21 #define CB_OP_RECALL_RES_MAXSZ (CB_OP_HDR_RES_MAXSZ)
23 #if defined(CONFIG_NFS_V4_1)
24 #define CB_OP_SEQUENCE_RES_MAXSZ (CB_OP_HDR_RES_MAXSZ + \
26 #define CB_OP_RECALLANY_RES_MAXSZ (CB_OP_HDR_RES_MAXSZ)
27 #endif /* CONFIG_NFS_V4_1 */
29 #define NFSDBG_FACILITY NFSDBG_CALLBACK
31 /* Internal error code */
32 #define NFS4ERR_RESOURCE_HDR 11050
34 typedef __be32 (*callback_process_op_t)(void *, void *);
35 typedef __be32 (*callback_decode_arg_t)(struct svc_rqst *, struct xdr_stream *, void *);
36 typedef __be32 (*callback_encode_res_t)(struct svc_rqst *, struct xdr_stream *, void *);
40 callback_process_op_t process_op;
41 callback_decode_arg_t decode_args;
42 callback_encode_res_t encode_res;
46 static struct callback_op callback_ops[];
48 static __be32 nfs4_callback_null(struct svc_rqst *rqstp, void *argp, void *resp)
50 return htonl(NFS4_OK);
53 static int nfs4_decode_void(struct svc_rqst *rqstp, __be32 *p, void *dummy)
55 return xdr_argsize_check(rqstp, p);
58 static int nfs4_encode_void(struct svc_rqst *rqstp, __be32 *p, void *dummy)
60 return xdr_ressize_check(rqstp, p);
63 static __be32 *read_buf(struct xdr_stream *xdr, int nbytes)
67 p = xdr_inline_decode(xdr, nbytes);
68 if (unlikely(p == NULL))
69 printk(KERN_WARNING "NFSv4 callback reply buffer overflowed!\n");
73 static __be32 decode_string(struct xdr_stream *xdr, unsigned int *len, const char **str)
78 if (unlikely(p == NULL))
79 return htonl(NFS4ERR_RESOURCE);
83 p = read_buf(xdr, *len);
84 if (unlikely(p == NULL))
85 return htonl(NFS4ERR_RESOURCE);
86 *str = (const char *)p;
93 static __be32 decode_fh(struct xdr_stream *xdr, struct nfs_fh *fh)
98 if (unlikely(p == NULL))
99 return htonl(NFS4ERR_RESOURCE);
100 fh->size = ntohl(*p);
101 if (fh->size > NFS4_FHSIZE)
102 return htonl(NFS4ERR_BADHANDLE);
103 p = read_buf(xdr, fh->size);
104 if (unlikely(p == NULL))
105 return htonl(NFS4ERR_RESOURCE);
106 memcpy(&fh->data[0], p, fh->size);
107 memset(&fh->data[fh->size], 0, sizeof(fh->data) - fh->size);
111 static __be32 decode_bitmap(struct xdr_stream *xdr, uint32_t *bitmap)
114 unsigned int attrlen;
116 p = read_buf(xdr, 4);
117 if (unlikely(p == NULL))
118 return htonl(NFS4ERR_RESOURCE);
120 p = read_buf(xdr, attrlen << 2);
121 if (unlikely(p == NULL))
122 return htonl(NFS4ERR_RESOURCE);
123 if (likely(attrlen > 0))
124 bitmap[0] = ntohl(*p++);
126 bitmap[1] = ntohl(*p);
130 static __be32 decode_stateid(struct xdr_stream *xdr, nfs4_stateid *stateid)
134 p = read_buf(xdr, 16);
135 if (unlikely(p == NULL))
136 return htonl(NFS4ERR_RESOURCE);
137 memcpy(stateid->data, p, 16);
141 static __be32 decode_compound_hdr_arg(struct xdr_stream *xdr, struct cb_compound_hdr_arg *hdr)
146 status = decode_string(xdr, &hdr->taglen, &hdr->tag);
147 if (unlikely(status != 0))
149 /* We do not like overly long tags! */
150 if (hdr->taglen > CB_OP_TAGLEN_MAXSZ - 12) {
151 printk("NFSv4 CALLBACK %s: client sent tag of length %u\n",
152 __func__, hdr->taglen);
153 return htonl(NFS4ERR_RESOURCE);
155 p = read_buf(xdr, 12);
156 if (unlikely(p == NULL))
157 return htonl(NFS4ERR_RESOURCE);
158 hdr->minorversion = ntohl(*p++);
159 /* Check minor version is zero or one. */
160 if (hdr->minorversion <= 1) {
161 p++; /* skip callback_ident */
163 printk(KERN_WARNING "%s: NFSv4 server callback with "
164 "illegal minor version %u!\n",
165 __func__, hdr->minorversion);
166 return htonl(NFS4ERR_MINOR_VERS_MISMATCH);
168 hdr->nops = ntohl(*p);
169 dprintk("%s: minorversion %d nops %d\n", __func__,
170 hdr->minorversion, hdr->nops);
174 static __be32 decode_op_hdr(struct xdr_stream *xdr, unsigned int *op)
177 p = read_buf(xdr, 4);
178 if (unlikely(p == NULL))
179 return htonl(NFS4ERR_RESOURCE_HDR);
184 static __be32 decode_getattr_args(struct svc_rqst *rqstp, struct xdr_stream *xdr, struct cb_getattrargs *args)
188 status = decode_fh(xdr, &args->fh);
189 if (unlikely(status != 0))
191 args->addr = svc_addr(rqstp);
192 status = decode_bitmap(xdr, args->bitmap);
194 dprintk("%s: exit with status = %d\n", __func__, ntohl(status));
198 static __be32 decode_recall_args(struct svc_rqst *rqstp, struct xdr_stream *xdr, struct cb_recallargs *args)
203 args->addr = svc_addr(rqstp);
204 status = decode_stateid(xdr, &args->stateid);
205 if (unlikely(status != 0))
207 p = read_buf(xdr, 4);
208 if (unlikely(p == NULL)) {
209 status = htonl(NFS4ERR_RESOURCE);
212 args->truncate = ntohl(*p);
213 status = decode_fh(xdr, &args->fh);
215 dprintk("%s: exit with status = %d\n", __func__, ntohl(status));
219 #if defined(CONFIG_NFS_V4_1)
221 static unsigned decode_sessionid(struct xdr_stream *xdr,
222 struct nfs4_sessionid *sid)
225 int len = NFS4_MAX_SESSIONID_LEN;
227 p = read_buf(xdr, len);
228 if (unlikely(p == NULL))
229 return htonl(NFS4ERR_RESOURCE);
231 memcpy(sid->data, p, len);
235 static unsigned decode_rc_list(struct xdr_stream *xdr,
236 struct referring_call_list *rc_list)
242 status = decode_sessionid(xdr, &rc_list->rcl_sessionid);
246 status = htonl(NFS4ERR_RESOURCE);
247 p = read_buf(xdr, sizeof(uint32_t));
248 if (unlikely(p == NULL))
251 rc_list->rcl_nrefcalls = ntohl(*p++);
252 if (rc_list->rcl_nrefcalls) {
254 rc_list->rcl_nrefcalls * 2 * sizeof(uint32_t));
255 if (unlikely(p == NULL))
257 rc_list->rcl_refcalls = kmalloc(rc_list->rcl_nrefcalls *
258 sizeof(*rc_list->rcl_refcalls),
260 if (unlikely(rc_list->rcl_refcalls == NULL))
262 for (i = 0; i < rc_list->rcl_nrefcalls; i++) {
263 rc_list->rcl_refcalls[i].rc_sequenceid = ntohl(*p++);
264 rc_list->rcl_refcalls[i].rc_slotid = ntohl(*p++);
273 static unsigned decode_cb_sequence_args(struct svc_rqst *rqstp,
274 struct xdr_stream *xdr,
275 struct cb_sequenceargs *args)
281 status = decode_sessionid(xdr, &args->csa_sessionid);
285 status = htonl(NFS4ERR_RESOURCE);
286 p = read_buf(xdr, 5 * sizeof(uint32_t));
287 if (unlikely(p == NULL))
290 args->csa_addr = svc_addr(rqstp);
291 args->csa_sequenceid = ntohl(*p++);
292 args->csa_slotid = ntohl(*p++);
293 args->csa_highestslotid = ntohl(*p++);
294 args->csa_cachethis = ntohl(*p++);
295 args->csa_nrclists = ntohl(*p++);
296 args->csa_rclists = NULL;
297 if (args->csa_nrclists) {
298 args->csa_rclists = kmalloc(args->csa_nrclists *
299 sizeof(*args->csa_rclists),
301 if (unlikely(args->csa_rclists == NULL))
304 for (i = 0; i < args->csa_nrclists; i++) {
305 status = decode_rc_list(xdr, &args->csa_rclists[i]);
312 dprintk("%s: sessionid %x:%x:%x:%x sequenceid %u slotid %u "
313 "highestslotid %u cachethis %d nrclists %u\n",
315 ((u32 *)&args->csa_sessionid)[0],
316 ((u32 *)&args->csa_sessionid)[1],
317 ((u32 *)&args->csa_sessionid)[2],
318 ((u32 *)&args->csa_sessionid)[3],
319 args->csa_sequenceid, args->csa_slotid,
320 args->csa_highestslotid, args->csa_cachethis,
323 dprintk("%s: exit with status = %d\n", __func__, ntohl(status));
327 for (i = 0; i < args->csa_nrclists; i++)
328 kfree(args->csa_rclists[i].rcl_refcalls);
329 kfree(args->csa_rclists);
333 static unsigned decode_recallany_args(struct svc_rqst *rqstp,
334 struct xdr_stream *xdr,
335 struct cb_recallanyargs *args)
339 args->craa_addr = svc_addr(rqstp);
340 p = read_buf(xdr, 4);
341 if (unlikely(p == NULL))
342 return htonl(NFS4ERR_BADXDR);
343 args->craa_objs_to_keep = ntohl(*p++);
344 p = read_buf(xdr, 4);
345 if (unlikely(p == NULL))
346 return htonl(NFS4ERR_BADXDR);
347 args->craa_type_mask = ntohl(*p);
352 #endif /* CONFIG_NFS_V4_1 */
354 static __be32 encode_string(struct xdr_stream *xdr, unsigned int len, const char *str)
358 p = xdr_reserve_space(xdr, 4 + len);
359 if (unlikely(p == NULL))
360 return htonl(NFS4ERR_RESOURCE);
361 xdr_encode_opaque(p, str, len);
365 #define CB_SUPPORTED_ATTR0 (FATTR4_WORD0_CHANGE|FATTR4_WORD0_SIZE)
366 #define CB_SUPPORTED_ATTR1 (FATTR4_WORD1_TIME_METADATA|FATTR4_WORD1_TIME_MODIFY)
367 static __be32 encode_attr_bitmap(struct xdr_stream *xdr, const uint32_t *bitmap, __be32 **savep)
372 bm[0] = htonl(bitmap[0] & CB_SUPPORTED_ATTR0);
373 bm[1] = htonl(bitmap[1] & CB_SUPPORTED_ATTR1);
375 p = xdr_reserve_space(xdr, 16);
376 if (unlikely(p == NULL))
377 return htonl(NFS4ERR_RESOURCE);
381 } else if (bm[0] != 0) {
382 p = xdr_reserve_space(xdr, 12);
383 if (unlikely(p == NULL))
384 return htonl(NFS4ERR_RESOURCE);
388 p = xdr_reserve_space(xdr, 8);
389 if (unlikely(p == NULL))
390 return htonl(NFS4ERR_RESOURCE);
397 static __be32 encode_attr_change(struct xdr_stream *xdr, const uint32_t *bitmap, uint64_t change)
401 if (!(bitmap[0] & FATTR4_WORD0_CHANGE))
403 p = xdr_reserve_space(xdr, 8);
405 return htonl(NFS4ERR_RESOURCE);
406 p = xdr_encode_hyper(p, change);
410 static __be32 encode_attr_size(struct xdr_stream *xdr, const uint32_t *bitmap, uint64_t size)
414 if (!(bitmap[0] & FATTR4_WORD0_SIZE))
416 p = xdr_reserve_space(xdr, 8);
418 return htonl(NFS4ERR_RESOURCE);
419 p = xdr_encode_hyper(p, size);
423 static __be32 encode_attr_time(struct xdr_stream *xdr, const struct timespec *time)
427 p = xdr_reserve_space(xdr, 12);
429 return htonl(NFS4ERR_RESOURCE);
430 p = xdr_encode_hyper(p, time->tv_sec);
431 *p = htonl(time->tv_nsec);
435 static __be32 encode_attr_ctime(struct xdr_stream *xdr, const uint32_t *bitmap, const struct timespec *time)
437 if (!(bitmap[1] & FATTR4_WORD1_TIME_METADATA))
439 return encode_attr_time(xdr,time);
442 static __be32 encode_attr_mtime(struct xdr_stream *xdr, const uint32_t *bitmap, const struct timespec *time)
444 if (!(bitmap[1] & FATTR4_WORD1_TIME_MODIFY))
446 return encode_attr_time(xdr,time);
449 static __be32 encode_compound_hdr_res(struct xdr_stream *xdr, struct cb_compound_hdr_res *hdr)
453 hdr->status = xdr_reserve_space(xdr, 4);
454 if (unlikely(hdr->status == NULL))
455 return htonl(NFS4ERR_RESOURCE);
456 status = encode_string(xdr, hdr->taglen, hdr->tag);
457 if (unlikely(status != 0))
459 hdr->nops = xdr_reserve_space(xdr, 4);
460 if (unlikely(hdr->nops == NULL))
461 return htonl(NFS4ERR_RESOURCE);
465 static __be32 encode_op_hdr(struct xdr_stream *xdr, uint32_t op, __be32 res)
469 p = xdr_reserve_space(xdr, 8);
470 if (unlikely(p == NULL))
471 return htonl(NFS4ERR_RESOURCE_HDR);
477 static __be32 encode_getattr_res(struct svc_rqst *rqstp, struct xdr_stream *xdr, const struct cb_getattrres *res)
479 __be32 *savep = NULL;
480 __be32 status = res->status;
482 if (unlikely(status != 0))
484 status = encode_attr_bitmap(xdr, res->bitmap, &savep);
485 if (unlikely(status != 0))
487 status = encode_attr_change(xdr, res->bitmap, res->change_attr);
488 if (unlikely(status != 0))
490 status = encode_attr_size(xdr, res->bitmap, res->size);
491 if (unlikely(status != 0))
493 status = encode_attr_ctime(xdr, res->bitmap, &res->ctime);
494 if (unlikely(status != 0))
496 status = encode_attr_mtime(xdr, res->bitmap, &res->mtime);
497 *savep = htonl((unsigned int)((char *)xdr->p - (char *)(savep+1)));
499 dprintk("%s: exit with status = %d\n", __func__, ntohl(status));
503 #if defined(CONFIG_NFS_V4_1)
505 static unsigned encode_sessionid(struct xdr_stream *xdr,
506 const struct nfs4_sessionid *sid)
509 int len = NFS4_MAX_SESSIONID_LEN;
511 p = xdr_reserve_space(xdr, len);
512 if (unlikely(p == NULL))
513 return htonl(NFS4ERR_RESOURCE);
519 static unsigned encode_cb_sequence_res(struct svc_rqst *rqstp,
520 struct xdr_stream *xdr,
521 const struct cb_sequenceres *res)
524 unsigned status = res->csr_status;
526 if (unlikely(status != 0))
529 encode_sessionid(xdr, &res->csr_sessionid);
531 p = xdr_reserve_space(xdr, 4 * sizeof(uint32_t));
532 if (unlikely(p == NULL))
533 return htonl(NFS4ERR_RESOURCE);
535 *p++ = htonl(res->csr_sequenceid);
536 *p++ = htonl(res->csr_slotid);
537 *p++ = htonl(res->csr_highestslotid);
538 *p++ = htonl(res->csr_target_highestslotid);
540 dprintk("%s: exit with status = %d\n", __func__, ntohl(status));
545 preprocess_nfs41_op(int nop, unsigned int op_nr, struct callback_op **op)
547 if (op_nr == OP_CB_SEQUENCE) {
549 return htonl(NFS4ERR_SEQUENCE_POS);
552 return htonl(NFS4ERR_OP_NOT_IN_SESSION);
559 case OP_CB_RECALL_ANY:
560 *op = &callback_ops[op_nr];
563 case OP_CB_LAYOUTRECALL:
564 case OP_CB_NOTIFY_DEVICEID:
566 case OP_CB_PUSH_DELEG:
567 case OP_CB_RECALLABLE_OBJ_AVAIL:
568 case OP_CB_RECALL_SLOT:
569 case OP_CB_WANTS_CANCELLED:
570 case OP_CB_NOTIFY_LOCK:
571 return htonl(NFS4ERR_NOTSUPP);
574 return htonl(NFS4ERR_OP_ILLEGAL);
577 return htonl(NFS_OK);
580 #else /* CONFIG_NFS_V4_1 */
583 preprocess_nfs41_op(int nop, unsigned int op_nr, struct callback_op **op)
585 return htonl(NFS4ERR_MINOR_VERS_MISMATCH);
588 #endif /* CONFIG_NFS_V4_1 */
591 preprocess_nfs4_op(unsigned int op_nr, struct callback_op **op)
596 *op = &callback_ops[op_nr];
599 return htonl(NFS4ERR_OP_ILLEGAL);
602 return htonl(NFS_OK);
605 static __be32 process_op(uint32_t minorversion, int nop,
606 struct svc_rqst *rqstp,
607 struct xdr_stream *xdr_in, void *argp,
608 struct xdr_stream *xdr_out, void *resp, int* drc_status)
610 struct callback_op *op = &callback_ops[0];
616 dprintk("%s: start\n", __func__);
617 status = decode_op_hdr(xdr_in, &op_nr);
618 if (unlikely(status))
621 dprintk("%s: minorversion=%d nop=%d op_nr=%u\n",
622 __func__, minorversion, nop, op_nr);
624 status = minorversion ? preprocess_nfs41_op(nop, op_nr, &op) :
625 preprocess_nfs4_op(op_nr, &op);
626 if (status == htonl(NFS4ERR_OP_ILLEGAL))
627 op_nr = OP_CB_ILLEGAL;
632 status = *drc_status;
636 maxlen = xdr_out->end - xdr_out->p;
637 if (maxlen > 0 && maxlen < PAGE_SIZE) {
638 status = op->decode_args(rqstp, xdr_in, argp);
639 if (likely(status == 0))
640 status = op->process_op(argp, resp);
642 status = htonl(NFS4ERR_RESOURCE);
644 /* Only set by OP_CB_SEQUENCE processing */
645 if (status == htonl(NFS4ERR_RETRY_UNCACHED_REP)) {
646 *drc_status = status;
651 res = encode_op_hdr(xdr_out, op_nr, status);
654 if (op->encode_res != NULL && status == 0)
655 status = op->encode_res(rqstp, xdr_out, resp);
656 dprintk("%s: done, status = %d\n", __func__, ntohl(status));
661 * Decode, process and encode a COMPOUND
663 static __be32 nfs4_callback_compound(struct svc_rqst *rqstp, void *argp, void *resp)
665 struct cb_compound_hdr_arg hdr_arg = { 0 };
666 struct cb_compound_hdr_res hdr_res = { NULL };
667 struct xdr_stream xdr_in, xdr_out;
669 __be32 status, drc_status = 0;
670 unsigned int nops = 0;
672 dprintk("%s: start\n", __func__);
674 xdr_init_decode(&xdr_in, &rqstp->rq_arg, rqstp->rq_arg.head[0].iov_base);
676 p = (__be32*)((char *)rqstp->rq_res.head[0].iov_base + rqstp->rq_res.head[0].iov_len);
677 xdr_init_encode(&xdr_out, &rqstp->rq_res, p);
679 status = decode_compound_hdr_arg(&xdr_in, &hdr_arg);
680 if (status == __constant_htonl(NFS4ERR_RESOURCE))
681 return rpc_garbage_args;
683 hdr_res.taglen = hdr_arg.taglen;
684 hdr_res.tag = hdr_arg.tag;
685 if (encode_compound_hdr_res(&xdr_out, &hdr_res) != 0)
686 return rpc_system_err;
688 while (status == 0 && nops != hdr_arg.nops) {
689 status = process_op(hdr_arg.minorversion, nops, rqstp,
690 &xdr_in, argp, &xdr_out, resp, &drc_status);
694 /* Buffer overflow in decode_ops_hdr or encode_ops_hdr. Return
695 * resource error in cb_compound status without returning op */
696 if (unlikely(status == htonl(NFS4ERR_RESOURCE_HDR))) {
697 status = htonl(NFS4ERR_RESOURCE);
701 *hdr_res.status = status;
702 *hdr_res.nops = htonl(nops);
703 dprintk("%s: done, status = %u\n", __func__, ntohl(status));
708 * Define NFS4 callback COMPOUND ops.
710 static struct callback_op callback_ops[] = {
712 .res_maxsize = CB_OP_HDR_RES_MAXSZ,
715 .process_op = (callback_process_op_t)nfs4_callback_getattr,
716 .decode_args = (callback_decode_arg_t)decode_getattr_args,
717 .encode_res = (callback_encode_res_t)encode_getattr_res,
718 .res_maxsize = CB_OP_GETATTR_RES_MAXSZ,
721 .process_op = (callback_process_op_t)nfs4_callback_recall,
722 .decode_args = (callback_decode_arg_t)decode_recall_args,
723 .res_maxsize = CB_OP_RECALL_RES_MAXSZ,
725 #if defined(CONFIG_NFS_V4_1)
727 .process_op = (callback_process_op_t)nfs4_callback_sequence,
728 .decode_args = (callback_decode_arg_t)decode_cb_sequence_args,
729 .encode_res = (callback_encode_res_t)encode_cb_sequence_res,
730 .res_maxsize = CB_OP_SEQUENCE_RES_MAXSZ,
732 [OP_CB_RECALL_ANY] = {
733 .process_op = (callback_process_op_t)nfs4_callback_recallany,
734 .decode_args = (callback_decode_arg_t)decode_recallany_args,
735 .res_maxsize = CB_OP_RECALLANY_RES_MAXSZ,
737 #endif /* CONFIG_NFS_V4_1 */
741 * Define NFS4 callback procedures
743 static struct svc_procedure nfs4_callback_procedures1[] = {
745 .pc_func = nfs4_callback_null,
746 .pc_decode = (kxdrproc_t)nfs4_decode_void,
747 .pc_encode = (kxdrproc_t)nfs4_encode_void,
751 .pc_func = nfs4_callback_compound,
752 .pc_encode = (kxdrproc_t)nfs4_encode_void,
755 .pc_xdrressize = NFS4_CALLBACK_BUFSIZE,
759 struct svc_version nfs4_callback_version1 = {
761 .vs_nproc = ARRAY_SIZE(nfs4_callback_procedures1),
762 .vs_proc = nfs4_callback_procedures1,
763 .vs_xdrsize = NFS4_CALLBACK_XDRSIZE,
767 struct svc_version nfs4_callback_version4 = {
769 .vs_nproc = ARRAY_SIZE(nfs4_callback_procedures1),
770 .vs_proc = nfs4_callback_procedures1,
771 .vs_xdrsize = NFS4_CALLBACK_XDRSIZE,