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 #define CB_OP_RECALLSLOT_RES_MAXSZ (CB_OP_HDR_RES_MAXSZ)
28 #endif /* CONFIG_NFS_V4_1 */
30 #define NFSDBG_FACILITY NFSDBG_CALLBACK
32 /* Internal error code */
33 #define NFS4ERR_RESOURCE_HDR 11050
35 typedef __be32 (*callback_process_op_t)(void *, void *);
36 typedef __be32 (*callback_decode_arg_t)(struct svc_rqst *, struct xdr_stream *, void *);
37 typedef __be32 (*callback_encode_res_t)(struct svc_rqst *, struct xdr_stream *, void *);
41 callback_process_op_t process_op;
42 callback_decode_arg_t decode_args;
43 callback_encode_res_t encode_res;
47 static struct callback_op callback_ops[];
49 static __be32 nfs4_callback_null(struct svc_rqst *rqstp, void *argp, void *resp)
51 return htonl(NFS4_OK);
54 static int nfs4_decode_void(struct svc_rqst *rqstp, __be32 *p, void *dummy)
56 return xdr_argsize_check(rqstp, p);
59 static int nfs4_encode_void(struct svc_rqst *rqstp, __be32 *p, void *dummy)
61 return xdr_ressize_check(rqstp, p);
64 static __be32 *read_buf(struct xdr_stream *xdr, int nbytes)
68 p = xdr_inline_decode(xdr, nbytes);
69 if (unlikely(p == NULL))
70 printk(KERN_WARNING "NFSv4 callback reply buffer overflowed!\n");
74 static __be32 decode_string(struct xdr_stream *xdr, unsigned int *len, const char **str)
79 if (unlikely(p == NULL))
80 return htonl(NFS4ERR_RESOURCE);
84 p = read_buf(xdr, *len);
85 if (unlikely(p == NULL))
86 return htonl(NFS4ERR_RESOURCE);
87 *str = (const char *)p;
94 static __be32 decode_fh(struct xdr_stream *xdr, struct nfs_fh *fh)
99 if (unlikely(p == NULL))
100 return htonl(NFS4ERR_RESOURCE);
101 fh->size = ntohl(*p);
102 if (fh->size > NFS4_FHSIZE)
103 return htonl(NFS4ERR_BADHANDLE);
104 p = read_buf(xdr, fh->size);
105 if (unlikely(p == NULL))
106 return htonl(NFS4ERR_RESOURCE);
107 memcpy(&fh->data[0], p, fh->size);
108 memset(&fh->data[fh->size], 0, sizeof(fh->data) - fh->size);
112 static __be32 decode_bitmap(struct xdr_stream *xdr, uint32_t *bitmap)
115 unsigned int attrlen;
117 p = read_buf(xdr, 4);
118 if (unlikely(p == NULL))
119 return htonl(NFS4ERR_RESOURCE);
121 p = read_buf(xdr, attrlen << 2);
122 if (unlikely(p == NULL))
123 return htonl(NFS4ERR_RESOURCE);
124 if (likely(attrlen > 0))
125 bitmap[0] = ntohl(*p++);
127 bitmap[1] = ntohl(*p);
131 static __be32 decode_stateid(struct xdr_stream *xdr, nfs4_stateid *stateid)
135 p = read_buf(xdr, 16);
136 if (unlikely(p == NULL))
137 return htonl(NFS4ERR_RESOURCE);
138 memcpy(stateid->data, p, 16);
142 static __be32 decode_compound_hdr_arg(struct xdr_stream *xdr, struct cb_compound_hdr_arg *hdr)
147 status = decode_string(xdr, &hdr->taglen, &hdr->tag);
148 if (unlikely(status != 0))
150 /* We do not like overly long tags! */
151 if (hdr->taglen > CB_OP_TAGLEN_MAXSZ - 12) {
152 printk("NFSv4 CALLBACK %s: client sent tag of length %u\n",
153 __func__, hdr->taglen);
154 return htonl(NFS4ERR_RESOURCE);
156 p = read_buf(xdr, 12);
157 if (unlikely(p == NULL))
158 return htonl(NFS4ERR_RESOURCE);
159 hdr->minorversion = ntohl(*p++);
160 /* Check minor version is zero or one. */
161 if (hdr->minorversion <= 1) {
162 p++; /* skip callback_ident */
164 printk(KERN_WARNING "%s: NFSv4 server callback with "
165 "illegal minor version %u!\n",
166 __func__, hdr->minorversion);
167 return htonl(NFS4ERR_MINOR_VERS_MISMATCH);
169 hdr->nops = ntohl(*p);
170 dprintk("%s: minorversion %d nops %d\n", __func__,
171 hdr->minorversion, hdr->nops);
175 static __be32 decode_op_hdr(struct xdr_stream *xdr, unsigned int *op)
178 p = read_buf(xdr, 4);
179 if (unlikely(p == NULL))
180 return htonl(NFS4ERR_RESOURCE_HDR);
185 static __be32 decode_getattr_args(struct svc_rqst *rqstp, struct xdr_stream *xdr, struct cb_getattrargs *args)
189 status = decode_fh(xdr, &args->fh);
190 if (unlikely(status != 0))
192 args->addr = svc_addr(rqstp);
193 status = decode_bitmap(xdr, args->bitmap);
195 dprintk("%s: exit with status = %d\n", __func__, ntohl(status));
199 static __be32 decode_recall_args(struct svc_rqst *rqstp, struct xdr_stream *xdr, struct cb_recallargs *args)
204 args->addr = svc_addr(rqstp);
205 status = decode_stateid(xdr, &args->stateid);
206 if (unlikely(status != 0))
208 p = read_buf(xdr, 4);
209 if (unlikely(p == NULL)) {
210 status = htonl(NFS4ERR_RESOURCE);
213 args->truncate = ntohl(*p);
214 status = decode_fh(xdr, &args->fh);
216 dprintk("%s: exit with status = %d\n", __func__, ntohl(status));
220 #if defined(CONFIG_NFS_V4_1)
222 static __be32 decode_sessionid(struct xdr_stream *xdr,
223 struct nfs4_sessionid *sid)
226 int len = NFS4_MAX_SESSIONID_LEN;
228 p = read_buf(xdr, len);
229 if (unlikely(p == NULL))
230 return htonl(NFS4ERR_RESOURCE);
232 memcpy(sid->data, p, len);
236 static __be32 decode_rc_list(struct xdr_stream *xdr,
237 struct referring_call_list *rc_list)
243 status = decode_sessionid(xdr, &rc_list->rcl_sessionid);
247 status = htonl(NFS4ERR_RESOURCE);
248 p = read_buf(xdr, sizeof(uint32_t));
249 if (unlikely(p == NULL))
252 rc_list->rcl_nrefcalls = ntohl(*p++);
253 if (rc_list->rcl_nrefcalls) {
255 rc_list->rcl_nrefcalls * 2 * sizeof(uint32_t));
256 if (unlikely(p == NULL))
258 rc_list->rcl_refcalls = kmalloc(rc_list->rcl_nrefcalls *
259 sizeof(*rc_list->rcl_refcalls),
261 if (unlikely(rc_list->rcl_refcalls == NULL))
263 for (i = 0; i < rc_list->rcl_nrefcalls; i++) {
264 rc_list->rcl_refcalls[i].rc_sequenceid = ntohl(*p++);
265 rc_list->rcl_refcalls[i].rc_slotid = ntohl(*p++);
274 static __be32 decode_cb_sequence_args(struct svc_rqst *rqstp,
275 struct xdr_stream *xdr,
276 struct cb_sequenceargs *args)
282 status = decode_sessionid(xdr, &args->csa_sessionid);
286 status = htonl(NFS4ERR_RESOURCE);
287 p = read_buf(xdr, 5 * sizeof(uint32_t));
288 if (unlikely(p == NULL))
291 args->csa_addr = svc_addr(rqstp);
292 args->csa_sequenceid = ntohl(*p++);
293 args->csa_slotid = ntohl(*p++);
294 args->csa_highestslotid = ntohl(*p++);
295 args->csa_cachethis = ntohl(*p++);
296 args->csa_nrclists = ntohl(*p++);
297 args->csa_rclists = NULL;
298 if (args->csa_nrclists) {
299 args->csa_rclists = kmalloc(args->csa_nrclists *
300 sizeof(*args->csa_rclists),
302 if (unlikely(args->csa_rclists == NULL))
305 for (i = 0; i < args->csa_nrclists; i++) {
306 status = decode_rc_list(xdr, &args->csa_rclists[i]);
313 dprintk("%s: sessionid %x:%x:%x:%x sequenceid %u slotid %u "
314 "highestslotid %u cachethis %d nrclists %u\n",
316 ((u32 *)&args->csa_sessionid)[0],
317 ((u32 *)&args->csa_sessionid)[1],
318 ((u32 *)&args->csa_sessionid)[2],
319 ((u32 *)&args->csa_sessionid)[3],
320 args->csa_sequenceid, args->csa_slotid,
321 args->csa_highestslotid, args->csa_cachethis,
324 dprintk("%s: exit with status = %d\n", __func__, ntohl(status));
328 for (i = 0; i < args->csa_nrclists; i++)
329 kfree(args->csa_rclists[i].rcl_refcalls);
330 kfree(args->csa_rclists);
334 static __be32 decode_recallany_args(struct svc_rqst *rqstp,
335 struct xdr_stream *xdr,
336 struct cb_recallanyargs *args)
340 args->craa_addr = svc_addr(rqstp);
341 p = read_buf(xdr, 4);
342 if (unlikely(p == NULL))
343 return htonl(NFS4ERR_BADXDR);
344 args->craa_objs_to_keep = ntohl(*p++);
345 p = read_buf(xdr, 4);
346 if (unlikely(p == NULL))
347 return htonl(NFS4ERR_BADXDR);
348 args->craa_type_mask = ntohl(*p);
353 static __be32 decode_recallslot_args(struct svc_rqst *rqstp,
354 struct xdr_stream *xdr,
355 struct cb_recallslotargs *args)
359 args->crsa_addr = svc_addr(rqstp);
360 p = read_buf(xdr, 4);
361 if (unlikely(p == NULL))
362 return htonl(NFS4ERR_BADXDR);
363 args->crsa_target_max_slots = ntohl(*p++);
367 #endif /* CONFIG_NFS_V4_1 */
369 static __be32 encode_string(struct xdr_stream *xdr, unsigned int len, const char *str)
373 p = xdr_reserve_space(xdr, 4 + len);
374 if (unlikely(p == NULL))
375 return htonl(NFS4ERR_RESOURCE);
376 xdr_encode_opaque(p, str, len);
380 #define CB_SUPPORTED_ATTR0 (FATTR4_WORD0_CHANGE|FATTR4_WORD0_SIZE)
381 #define CB_SUPPORTED_ATTR1 (FATTR4_WORD1_TIME_METADATA|FATTR4_WORD1_TIME_MODIFY)
382 static __be32 encode_attr_bitmap(struct xdr_stream *xdr, const uint32_t *bitmap, __be32 **savep)
387 bm[0] = htonl(bitmap[0] & CB_SUPPORTED_ATTR0);
388 bm[1] = htonl(bitmap[1] & CB_SUPPORTED_ATTR1);
390 p = xdr_reserve_space(xdr, 16);
391 if (unlikely(p == NULL))
392 return htonl(NFS4ERR_RESOURCE);
396 } else if (bm[0] != 0) {
397 p = xdr_reserve_space(xdr, 12);
398 if (unlikely(p == NULL))
399 return htonl(NFS4ERR_RESOURCE);
403 p = xdr_reserve_space(xdr, 8);
404 if (unlikely(p == NULL))
405 return htonl(NFS4ERR_RESOURCE);
412 static __be32 encode_attr_change(struct xdr_stream *xdr, const uint32_t *bitmap, uint64_t change)
416 if (!(bitmap[0] & FATTR4_WORD0_CHANGE))
418 p = xdr_reserve_space(xdr, 8);
420 return htonl(NFS4ERR_RESOURCE);
421 p = xdr_encode_hyper(p, change);
425 static __be32 encode_attr_size(struct xdr_stream *xdr, const uint32_t *bitmap, uint64_t size)
429 if (!(bitmap[0] & FATTR4_WORD0_SIZE))
431 p = xdr_reserve_space(xdr, 8);
433 return htonl(NFS4ERR_RESOURCE);
434 p = xdr_encode_hyper(p, size);
438 static __be32 encode_attr_time(struct xdr_stream *xdr, const struct timespec *time)
442 p = xdr_reserve_space(xdr, 12);
444 return htonl(NFS4ERR_RESOURCE);
445 p = xdr_encode_hyper(p, time->tv_sec);
446 *p = htonl(time->tv_nsec);
450 static __be32 encode_attr_ctime(struct xdr_stream *xdr, const uint32_t *bitmap, const struct timespec *time)
452 if (!(bitmap[1] & FATTR4_WORD1_TIME_METADATA))
454 return encode_attr_time(xdr,time);
457 static __be32 encode_attr_mtime(struct xdr_stream *xdr, const uint32_t *bitmap, const struct timespec *time)
459 if (!(bitmap[1] & FATTR4_WORD1_TIME_MODIFY))
461 return encode_attr_time(xdr,time);
464 static __be32 encode_compound_hdr_res(struct xdr_stream *xdr, struct cb_compound_hdr_res *hdr)
468 hdr->status = xdr_reserve_space(xdr, 4);
469 if (unlikely(hdr->status == NULL))
470 return htonl(NFS4ERR_RESOURCE);
471 status = encode_string(xdr, hdr->taglen, hdr->tag);
472 if (unlikely(status != 0))
474 hdr->nops = xdr_reserve_space(xdr, 4);
475 if (unlikely(hdr->nops == NULL))
476 return htonl(NFS4ERR_RESOURCE);
480 static __be32 encode_op_hdr(struct xdr_stream *xdr, uint32_t op, __be32 res)
484 p = xdr_reserve_space(xdr, 8);
485 if (unlikely(p == NULL))
486 return htonl(NFS4ERR_RESOURCE_HDR);
492 static __be32 encode_getattr_res(struct svc_rqst *rqstp, struct xdr_stream *xdr, const struct cb_getattrres *res)
494 __be32 *savep = NULL;
495 __be32 status = res->status;
497 if (unlikely(status != 0))
499 status = encode_attr_bitmap(xdr, res->bitmap, &savep);
500 if (unlikely(status != 0))
502 status = encode_attr_change(xdr, res->bitmap, res->change_attr);
503 if (unlikely(status != 0))
505 status = encode_attr_size(xdr, res->bitmap, res->size);
506 if (unlikely(status != 0))
508 status = encode_attr_ctime(xdr, res->bitmap, &res->ctime);
509 if (unlikely(status != 0))
511 status = encode_attr_mtime(xdr, res->bitmap, &res->mtime);
512 *savep = htonl((unsigned int)((char *)xdr->p - (char *)(savep+1)));
514 dprintk("%s: exit with status = %d\n", __func__, ntohl(status));
518 #if defined(CONFIG_NFS_V4_1)
520 static __be32 encode_sessionid(struct xdr_stream *xdr,
521 const struct nfs4_sessionid *sid)
524 int len = NFS4_MAX_SESSIONID_LEN;
526 p = xdr_reserve_space(xdr, len);
527 if (unlikely(p == NULL))
528 return htonl(NFS4ERR_RESOURCE);
534 static __be32 encode_cb_sequence_res(struct svc_rqst *rqstp,
535 struct xdr_stream *xdr,
536 const struct cb_sequenceres *res)
539 unsigned status = res->csr_status;
541 if (unlikely(status != 0))
544 encode_sessionid(xdr, &res->csr_sessionid);
546 p = xdr_reserve_space(xdr, 4 * sizeof(uint32_t));
547 if (unlikely(p == NULL))
548 return htonl(NFS4ERR_RESOURCE);
550 *p++ = htonl(res->csr_sequenceid);
551 *p++ = htonl(res->csr_slotid);
552 *p++ = htonl(res->csr_highestslotid);
553 *p++ = htonl(res->csr_target_highestslotid);
555 dprintk("%s: exit with status = %d\n", __func__, ntohl(status));
560 preprocess_nfs41_op(int nop, unsigned int op_nr, struct callback_op **op)
562 if (op_nr == OP_CB_SEQUENCE) {
564 return htonl(NFS4ERR_SEQUENCE_POS);
567 return htonl(NFS4ERR_OP_NOT_IN_SESSION);
574 case OP_CB_RECALL_ANY:
575 case OP_CB_RECALL_SLOT:
576 *op = &callback_ops[op_nr];
579 case OP_CB_LAYOUTRECALL:
580 case OP_CB_NOTIFY_DEVICEID:
582 case OP_CB_PUSH_DELEG:
583 case OP_CB_RECALLABLE_OBJ_AVAIL:
584 case OP_CB_WANTS_CANCELLED:
585 case OP_CB_NOTIFY_LOCK:
586 return htonl(NFS4ERR_NOTSUPP);
589 return htonl(NFS4ERR_OP_ILLEGAL);
592 return htonl(NFS_OK);
595 #else /* CONFIG_NFS_V4_1 */
598 preprocess_nfs41_op(int nop, unsigned int op_nr, struct callback_op **op)
600 return htonl(NFS4ERR_MINOR_VERS_MISMATCH);
603 #endif /* CONFIG_NFS_V4_1 */
606 preprocess_nfs4_op(unsigned int op_nr, struct callback_op **op)
611 *op = &callback_ops[op_nr];
614 return htonl(NFS4ERR_OP_ILLEGAL);
617 return htonl(NFS_OK);
620 static __be32 process_op(uint32_t minorversion, int nop,
621 struct svc_rqst *rqstp,
622 struct xdr_stream *xdr_in, void *argp,
623 struct xdr_stream *xdr_out, void *resp, int* drc_status)
625 struct callback_op *op = &callback_ops[0];
631 dprintk("%s: start\n", __func__);
632 status = decode_op_hdr(xdr_in, &op_nr);
633 if (unlikely(status))
636 dprintk("%s: minorversion=%d nop=%d op_nr=%u\n",
637 __func__, minorversion, nop, op_nr);
639 status = minorversion ? preprocess_nfs41_op(nop, op_nr, &op) :
640 preprocess_nfs4_op(op_nr, &op);
641 if (status == htonl(NFS4ERR_OP_ILLEGAL))
642 op_nr = OP_CB_ILLEGAL;
647 status = *drc_status;
651 maxlen = xdr_out->end - xdr_out->p;
652 if (maxlen > 0 && maxlen < PAGE_SIZE) {
653 status = op->decode_args(rqstp, xdr_in, argp);
654 if (likely(status == 0))
655 status = op->process_op(argp, resp);
657 status = htonl(NFS4ERR_RESOURCE);
659 /* Only set by OP_CB_SEQUENCE processing */
660 if (status == htonl(NFS4ERR_RETRY_UNCACHED_REP)) {
661 *drc_status = status;
666 res = encode_op_hdr(xdr_out, op_nr, status);
669 if (op->encode_res != NULL && status == 0)
670 status = op->encode_res(rqstp, xdr_out, resp);
671 dprintk("%s: done, status = %d\n", __func__, ntohl(status));
676 * Decode, process and encode a COMPOUND
678 static __be32 nfs4_callback_compound(struct svc_rqst *rqstp, void *argp, void *resp)
680 struct cb_compound_hdr_arg hdr_arg = { 0 };
681 struct cb_compound_hdr_res hdr_res = { NULL };
682 struct xdr_stream xdr_in, xdr_out;
684 __be32 status, drc_status = 0;
685 unsigned int nops = 0;
687 dprintk("%s: start\n", __func__);
689 xdr_init_decode(&xdr_in, &rqstp->rq_arg, rqstp->rq_arg.head[0].iov_base);
691 p = (__be32*)((char *)rqstp->rq_res.head[0].iov_base + rqstp->rq_res.head[0].iov_len);
692 xdr_init_encode(&xdr_out, &rqstp->rq_res, p);
694 status = decode_compound_hdr_arg(&xdr_in, &hdr_arg);
695 if (status == __constant_htonl(NFS4ERR_RESOURCE))
696 return rpc_garbage_args;
698 hdr_res.taglen = hdr_arg.taglen;
699 hdr_res.tag = hdr_arg.tag;
700 if (encode_compound_hdr_res(&xdr_out, &hdr_res) != 0)
701 return rpc_system_err;
703 while (status == 0 && nops != hdr_arg.nops) {
704 status = process_op(hdr_arg.minorversion, nops, rqstp,
705 &xdr_in, argp, &xdr_out, resp, &drc_status);
709 /* Buffer overflow in decode_ops_hdr or encode_ops_hdr. Return
710 * resource error in cb_compound status without returning op */
711 if (unlikely(status == htonl(NFS4ERR_RESOURCE_HDR))) {
712 status = htonl(NFS4ERR_RESOURCE);
716 *hdr_res.status = status;
717 *hdr_res.nops = htonl(nops);
718 dprintk("%s: done, status = %u\n", __func__, ntohl(status));
723 * Define NFS4 callback COMPOUND ops.
725 static struct callback_op callback_ops[] = {
727 .res_maxsize = CB_OP_HDR_RES_MAXSZ,
730 .process_op = (callback_process_op_t)nfs4_callback_getattr,
731 .decode_args = (callback_decode_arg_t)decode_getattr_args,
732 .encode_res = (callback_encode_res_t)encode_getattr_res,
733 .res_maxsize = CB_OP_GETATTR_RES_MAXSZ,
736 .process_op = (callback_process_op_t)nfs4_callback_recall,
737 .decode_args = (callback_decode_arg_t)decode_recall_args,
738 .res_maxsize = CB_OP_RECALL_RES_MAXSZ,
740 #if defined(CONFIG_NFS_V4_1)
742 .process_op = (callback_process_op_t)nfs4_callback_sequence,
743 .decode_args = (callback_decode_arg_t)decode_cb_sequence_args,
744 .encode_res = (callback_encode_res_t)encode_cb_sequence_res,
745 .res_maxsize = CB_OP_SEQUENCE_RES_MAXSZ,
747 [OP_CB_RECALL_ANY] = {
748 .process_op = (callback_process_op_t)nfs4_callback_recallany,
749 .decode_args = (callback_decode_arg_t)decode_recallany_args,
750 .res_maxsize = CB_OP_RECALLANY_RES_MAXSZ,
752 [OP_CB_RECALL_SLOT] = {
753 .process_op = (callback_process_op_t)nfs4_callback_recallslot,
754 .decode_args = (callback_decode_arg_t)decode_recallslot_args,
755 .res_maxsize = CB_OP_RECALLSLOT_RES_MAXSZ,
757 #endif /* CONFIG_NFS_V4_1 */
761 * Define NFS4 callback procedures
763 static struct svc_procedure nfs4_callback_procedures1[] = {
765 .pc_func = nfs4_callback_null,
766 .pc_decode = (kxdrproc_t)nfs4_decode_void,
767 .pc_encode = (kxdrproc_t)nfs4_encode_void,
771 .pc_func = nfs4_callback_compound,
772 .pc_encode = (kxdrproc_t)nfs4_encode_void,
775 .pc_xdrressize = NFS4_CALLBACK_BUFSIZE,
779 struct svc_version nfs4_callback_version1 = {
781 .vs_nproc = ARRAY_SIZE(nfs4_callback_procedures1),
782 .vs_proc = nfs4_callback_procedures1,
783 .vs_xdrsize = NFS4_CALLBACK_XDRSIZE,
788 struct svc_version nfs4_callback_version4 = {
790 .vs_nproc = ARRAY_SIZE(nfs4_callback_procedures1),
791 .vs_proc = nfs4_callback_procedures1,
792 .vs_xdrsize = NFS4_CALLBACK_XDRSIZE,