1
2
3
4
5
6
7
8
9
10
11#ifndef _SUNRPC_XDR_H_
12#define _SUNRPC_XDR_H_
13
14#include <linux/uio.h>
15#include <asm/byteorder.h>
16#include <asm/unaligned.h>
17#include <linux/scatterlist.h>
18
19struct bio_vec;
20struct rpc_rqst;
21
22
23
24
25
26
27#define XDR_UNIT sizeof(__be32)
28
29
30
31
32#define XDR_QUADLEN(l) (((l) + 3) >> 2)
33
34
35
36
37#define XDR_MAX_NETOBJ 1024
38struct xdr_netobj {
39 unsigned int len;
40 u8 * data;
41};
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56struct xdr_buf {
57 struct kvec head[1],
58 tail[1];
59
60 struct bio_vec *bvec;
61 struct page ** pages;
62 unsigned int page_base,
63 page_len,
64 flags;
65#define XDRBUF_READ 0x01
66#define XDRBUF_WRITE 0x02
67#define XDRBUF_SPARSE_PAGES 0x04
68
69 unsigned int buflen,
70 len;
71};
72
73static inline void
74xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
75{
76 buf->head[0].iov_base = start;
77 buf->head[0].iov_len = len;
78 buf->tail[0].iov_len = 0;
79 buf->pages = NULL;
80 buf->page_len = 0;
81 buf->flags = 0;
82 buf->len = 0;
83 buf->buflen = len;
84}
85
86
87
88
89
90#define xdr_zero cpu_to_be32(0)
91#define xdr_one cpu_to_be32(1)
92#define xdr_two cpu_to_be32(2)
93
94#define rpc_auth_null cpu_to_be32(RPC_AUTH_NULL)
95#define rpc_auth_unix cpu_to_be32(RPC_AUTH_UNIX)
96#define rpc_auth_short cpu_to_be32(RPC_AUTH_SHORT)
97#define rpc_auth_gss cpu_to_be32(RPC_AUTH_GSS)
98
99#define rpc_call cpu_to_be32(RPC_CALL)
100#define rpc_reply cpu_to_be32(RPC_REPLY)
101
102#define rpc_msg_accepted cpu_to_be32(RPC_MSG_ACCEPTED)
103
104#define rpc_success cpu_to_be32(RPC_SUCCESS)
105#define rpc_prog_unavail cpu_to_be32(RPC_PROG_UNAVAIL)
106#define rpc_prog_mismatch cpu_to_be32(RPC_PROG_MISMATCH)
107#define rpc_proc_unavail cpu_to_be32(RPC_PROC_UNAVAIL)
108#define rpc_garbage_args cpu_to_be32(RPC_GARBAGE_ARGS)
109#define rpc_system_err cpu_to_be32(RPC_SYSTEM_ERR)
110#define rpc_drop_reply cpu_to_be32(RPC_DROP_REPLY)
111
112#define rpc_mismatch cpu_to_be32(RPC_MISMATCH)
113#define rpc_auth_error cpu_to_be32(RPC_AUTH_ERROR)
114
115#define rpc_auth_ok cpu_to_be32(RPC_AUTH_OK)
116#define rpc_autherr_badcred cpu_to_be32(RPC_AUTH_BADCRED)
117#define rpc_autherr_rejectedcred cpu_to_be32(RPC_AUTH_REJECTEDCRED)
118#define rpc_autherr_badverf cpu_to_be32(RPC_AUTH_BADVERF)
119#define rpc_autherr_rejectedverf cpu_to_be32(RPC_AUTH_REJECTEDVERF)
120#define rpc_autherr_tooweak cpu_to_be32(RPC_AUTH_TOOWEAK)
121#define rpcsec_gsserr_credproblem cpu_to_be32(RPCSEC_GSS_CREDPROBLEM)
122#define rpcsec_gsserr_ctxproblem cpu_to_be32(RPCSEC_GSS_CTXPROBLEM)
123
124
125
126
127__be32 *xdr_encode_opaque_fixed(__be32 *p, const void *ptr, unsigned int len);
128__be32 *xdr_encode_opaque(__be32 *p, const void *ptr, unsigned int len);
129__be32 *xdr_encode_string(__be32 *p, const char *s);
130__be32 *xdr_decode_string_inplace(__be32 *p, char **sp, unsigned int *lenp,
131 unsigned int maxlen);
132__be32 *xdr_encode_netobj(__be32 *p, const struct xdr_netobj *);
133__be32 *xdr_decode_netobj(__be32 *p, struct xdr_netobj *);
134
135void xdr_inline_pages(struct xdr_buf *, unsigned int,
136 struct page **, unsigned int, unsigned int);
137void xdr_terminate_string(const struct xdr_buf *, const u32);
138size_t xdr_buf_pagecount(const struct xdr_buf *buf);
139int xdr_alloc_bvec(struct xdr_buf *buf, gfp_t gfp);
140void xdr_free_bvec(struct xdr_buf *buf);
141
142static inline __be32 *xdr_encode_array(__be32 *p, const void *s, unsigned int len)
143{
144 return xdr_encode_opaque(p, s, len);
145}
146
147
148
149
150static inline __be32 *
151xdr_encode_hyper(__be32 *p, __u64 val)
152{
153 put_unaligned_be64(val, p);
154 return p + 2;
155}
156
157static inline __be32 *
158xdr_decode_hyper(__be32 *p, __u64 *valp)
159{
160 *valp = get_unaligned_be64(p);
161 return p + 2;
162}
163
164static inline __be32 *
165xdr_decode_opaque_fixed(__be32 *p, void *ptr, unsigned int len)
166{
167 memcpy(ptr, p, len);
168 return p + XDR_QUADLEN(len);
169}
170
171static inline void xdr_netobj_dup(struct xdr_netobj *dst,
172 struct xdr_netobj *src, gfp_t gfp_mask)
173{
174 dst->data = kmemdup(src->data, src->len, gfp_mask);
175 dst->len = src->len;
176}
177
178
179
180
181static inline int
182xdr_adjust_iovec(struct kvec *iov, __be32 *p)
183{
184 return iov->iov_len = ((u8 *) p - (u8 *) iov->iov_base);
185}
186
187
188
189
190extern void xdr_shift_buf(struct xdr_buf *, size_t);
191extern void xdr_buf_from_iov(const struct kvec *, struct xdr_buf *);
192extern int xdr_buf_subsegment(const struct xdr_buf *, struct xdr_buf *, unsigned int, unsigned int);
193extern void xdr_buf_trim(struct xdr_buf *, unsigned int);
194extern int read_bytes_from_xdr_buf(const struct xdr_buf *, unsigned int, void *, unsigned int);
195extern int write_bytes_to_xdr_buf(const struct xdr_buf *, unsigned int, void *, unsigned int);
196
197extern int xdr_encode_word(const struct xdr_buf *, unsigned int, u32);
198extern int xdr_decode_word(const struct xdr_buf *, unsigned int, u32 *);
199
200struct xdr_array2_desc;
201typedef int (*xdr_xcode_elem_t)(struct xdr_array2_desc *desc, void *elem);
202struct xdr_array2_desc {
203 unsigned int elem_size;
204 unsigned int array_len;
205 unsigned int array_maxlen;
206 xdr_xcode_elem_t xcode;
207};
208
209extern int xdr_decode_array2(const struct xdr_buf *buf, unsigned int base,
210 struct xdr_array2_desc *desc);
211extern int xdr_encode_array2(const struct xdr_buf *buf, unsigned int base,
212 struct xdr_array2_desc *desc);
213extern void _copy_from_pages(char *p, struct page **pages, size_t pgbase,
214 size_t len);
215
216
217
218
219struct xdr_stream {
220 __be32 *p;
221 struct xdr_buf *buf;
222
223 __be32 *end;
224 struct kvec *iov;
225 struct kvec scratch;
226 struct page **page_ptr;
227 unsigned int nwords;
228
229 struct rpc_rqst *rqst;
230};
231
232
233
234
235typedef void (*kxdreproc_t)(struct rpc_rqst *rqstp, struct xdr_stream *xdr,
236 const void *obj);
237typedef int (*kxdrdproc_t)(struct rpc_rqst *rqstp, struct xdr_stream *xdr,
238 void *obj);
239
240extern void xdr_init_encode(struct xdr_stream *xdr, struct xdr_buf *buf,
241 __be32 *p, struct rpc_rqst *rqst);
242extern __be32 *xdr_reserve_space(struct xdr_stream *xdr, size_t nbytes);
243extern int xdr_reserve_space_vec(struct xdr_stream *xdr, struct kvec *vec,
244 size_t nbytes);
245extern void xdr_commit_encode(struct xdr_stream *xdr);
246extern void xdr_truncate_encode(struct xdr_stream *xdr, size_t len);
247extern int xdr_restrict_buflen(struct xdr_stream *xdr, int newbuflen);
248extern void xdr_write_pages(struct xdr_stream *xdr, struct page **pages,
249 unsigned int base, unsigned int len);
250extern unsigned int xdr_stream_pos(const struct xdr_stream *xdr);
251extern unsigned int xdr_page_pos(const struct xdr_stream *xdr);
252extern void xdr_init_decode(struct xdr_stream *xdr, struct xdr_buf *buf,
253 __be32 *p, struct rpc_rqst *rqst);
254extern void xdr_init_decode_pages(struct xdr_stream *xdr, struct xdr_buf *buf,
255 struct page **pages, unsigned int len);
256extern __be32 *xdr_inline_decode(struct xdr_stream *xdr, size_t nbytes);
257extern unsigned int xdr_read_pages(struct xdr_stream *xdr, unsigned int len);
258extern void xdr_enter_page(struct xdr_stream *xdr, unsigned int len);
259extern int xdr_process_buf(const struct xdr_buf *buf, unsigned int offset, unsigned int len, int (*actor)(struct scatterlist *, void *), void *data);
260extern unsigned int xdr_align_data(struct xdr_stream *, unsigned int offset, unsigned int length);
261extern unsigned int xdr_expand_hole(struct xdr_stream *, unsigned int offset, unsigned int length);
262extern bool xdr_stream_subsegment(struct xdr_stream *xdr, struct xdr_buf *subbuf,
263 unsigned int len);
264
265
266
267
268
269
270
271
272
273
274
275
276static inline void
277xdr_set_scratch_buffer(struct xdr_stream *xdr, void *buf, size_t buflen)
278{
279 xdr->scratch.iov_base = buf;
280 xdr->scratch.iov_len = buflen;
281}
282
283
284
285
286
287
288
289
290static inline void
291xdr_set_scratch_page(struct xdr_stream *xdr, struct page *page)
292{
293 xdr_set_scratch_buffer(xdr, page_address(page), PAGE_SIZE);
294}
295
296
297
298
299
300
301
302static inline void
303xdr_reset_scratch_buffer(struct xdr_stream *xdr)
304{
305 xdr_set_scratch_buffer(xdr, NULL, 0);
306}
307
308
309
310
311
312
313
314
315static inline size_t
316xdr_stream_remaining(const struct xdr_stream *xdr)
317{
318 return xdr->nwords << 2;
319}
320
321ssize_t xdr_stream_decode_opaque(struct xdr_stream *xdr, void *ptr,
322 size_t size);
323ssize_t xdr_stream_decode_opaque_dup(struct xdr_stream *xdr, void **ptr,
324 size_t maxlen, gfp_t gfp_flags);
325ssize_t xdr_stream_decode_string(struct xdr_stream *xdr, char *str,
326 size_t size);
327ssize_t xdr_stream_decode_string_dup(struct xdr_stream *xdr, char **str,
328 size_t maxlen, gfp_t gfp_flags);
329
330
331
332
333
334
335
336static inline size_t
337xdr_align_size(size_t n)
338{
339 const size_t mask = XDR_UNIT - 1;
340
341 return (n + mask) & ~mask;
342}
343
344
345
346
347
348
349
350
351
352
353
354static inline size_t xdr_pad_size(size_t n)
355{
356 return xdr_align_size(n) - n;
357}
358
359
360
361
362
363
364
365
366
367static inline ssize_t xdr_stream_encode_item_present(struct xdr_stream *xdr)
368{
369 const size_t len = XDR_UNIT;
370 __be32 *p = xdr_reserve_space(xdr, len);
371
372 if (unlikely(!p))
373 return -EMSGSIZE;
374 *p = xdr_one;
375 return len;
376}
377
378
379
380
381
382
383
384
385
386static inline int xdr_stream_encode_item_absent(struct xdr_stream *xdr)
387{
388 const size_t len = XDR_UNIT;
389 __be32 *p = xdr_reserve_space(xdr, len);
390
391 if (unlikely(!p))
392 return -EMSGSIZE;
393 *p = xdr_zero;
394 return len;
395}
396
397
398
399
400
401
402
403
404
405
406static inline ssize_t
407xdr_stream_encode_u32(struct xdr_stream *xdr, __u32 n)
408{
409 const size_t len = sizeof(n);
410 __be32 *p = xdr_reserve_space(xdr, len);
411
412 if (unlikely(!p))
413 return -EMSGSIZE;
414 *p = cpu_to_be32(n);
415 return len;
416}
417
418
419
420
421
422
423
424
425
426
427static inline ssize_t
428xdr_stream_encode_u64(struct xdr_stream *xdr, __u64 n)
429{
430 const size_t len = sizeof(n);
431 __be32 *p = xdr_reserve_space(xdr, len);
432
433 if (unlikely(!p))
434 return -EMSGSIZE;
435 xdr_encode_hyper(p, n);
436 return len;
437}
438
439
440
441
442
443
444
445
446
447
448
449static inline ssize_t
450xdr_stream_encode_opaque_inline(struct xdr_stream *xdr, void **ptr, size_t len)
451{
452 size_t count = sizeof(__u32) + xdr_align_size(len);
453 __be32 *p = xdr_reserve_space(xdr, count);
454
455 if (unlikely(!p)) {
456 *ptr = NULL;
457 return -EMSGSIZE;
458 }
459 xdr_encode_opaque(p, NULL, len);
460 *ptr = ++p;
461 return count;
462}
463
464
465
466
467
468
469
470
471
472
473
474static inline ssize_t
475xdr_stream_encode_opaque_fixed(struct xdr_stream *xdr, const void *ptr, size_t len)
476{
477 __be32 *p = xdr_reserve_space(xdr, len);
478
479 if (unlikely(!p))
480 return -EMSGSIZE;
481 xdr_encode_opaque_fixed(p, ptr, len);
482 return xdr_align_size(len);
483}
484
485
486
487
488
489
490
491
492
493
494
495static inline ssize_t
496xdr_stream_encode_opaque(struct xdr_stream *xdr, const void *ptr, size_t len)
497{
498 size_t count = sizeof(__u32) + xdr_align_size(len);
499 __be32 *p = xdr_reserve_space(xdr, count);
500
501 if (unlikely(!p))
502 return -EMSGSIZE;
503 xdr_encode_opaque(p, ptr, len);
504 return count;
505}
506
507
508
509
510
511
512
513
514
515
516
517static inline ssize_t
518xdr_stream_encode_uint32_array(struct xdr_stream *xdr,
519 const __u32 *array, size_t array_size)
520{
521 ssize_t ret = (array_size+1) * sizeof(__u32);
522 __be32 *p = xdr_reserve_space(xdr, ret);
523
524 if (unlikely(!p))
525 return -EMSGSIZE;
526 *p++ = cpu_to_be32(array_size);
527 for (; array_size > 0; p++, array++, array_size--)
528 *p = cpu_to_be32p(array);
529 return ret;
530}
531
532
533
534
535
536
537
538
539
540static inline bool xdr_item_is_absent(const __be32 *p)
541{
542 return *p == xdr_zero;
543}
544
545
546
547
548
549
550
551
552
553static inline bool xdr_item_is_present(const __be32 *p)
554{
555 return *p != xdr_zero;
556}
557
558
559
560
561
562
563
564
565
566
567static inline ssize_t
568xdr_stream_decode_bool(struct xdr_stream *xdr, __u32 *ptr)
569{
570 const size_t count = sizeof(*ptr);
571 __be32 *p = xdr_inline_decode(xdr, count);
572
573 if (unlikely(!p))
574 return -EBADMSG;
575 *ptr = (*p != xdr_zero);
576 return 0;
577}
578
579
580
581
582
583
584
585
586
587
588static inline ssize_t
589xdr_stream_decode_u32(struct xdr_stream *xdr, __u32 *ptr)
590{
591 const size_t count = sizeof(*ptr);
592 __be32 *p = xdr_inline_decode(xdr, count);
593
594 if (unlikely(!p))
595 return -EBADMSG;
596 *ptr = be32_to_cpup(p);
597 return 0;
598}
599
600
601
602
603
604
605
606
607
608
609static inline ssize_t
610xdr_stream_decode_u64(struct xdr_stream *xdr, __u64 *ptr)
611{
612 const size_t count = sizeof(*ptr);
613 __be32 *p = xdr_inline_decode(xdr, count);
614
615 if (unlikely(!p))
616 return -EBADMSG;
617 xdr_decode_hyper(p, ptr);
618 return 0;
619}
620
621
622
623
624
625
626
627
628
629
630
631static inline ssize_t
632xdr_stream_decode_opaque_fixed(struct xdr_stream *xdr, void *ptr, size_t len)
633{
634 __be32 *p = xdr_inline_decode(xdr, len);
635
636 if (unlikely(!p))
637 return -EBADMSG;
638 xdr_decode_opaque_fixed(p, ptr, len);
639 return len;
640}
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658static inline ssize_t
659xdr_stream_decode_opaque_inline(struct xdr_stream *xdr, void **ptr, size_t maxlen)
660{
661 __be32 *p;
662 __u32 len;
663
664 *ptr = NULL;
665 if (unlikely(xdr_stream_decode_u32(xdr, &len) < 0))
666 return -EBADMSG;
667 if (len != 0) {
668 p = xdr_inline_decode(xdr, len);
669 if (unlikely(!p))
670 return -EBADMSG;
671 if (unlikely(len > maxlen))
672 return -EMSGSIZE;
673 *ptr = p;
674 }
675 return len;
676}
677
678
679
680
681
682
683
684
685
686
687
688
689static inline ssize_t
690xdr_stream_decode_uint32_array(struct xdr_stream *xdr,
691 __u32 *array, size_t array_size)
692{
693 __be32 *p;
694 __u32 len;
695 ssize_t retval;
696
697 if (unlikely(xdr_stream_decode_u32(xdr, &len) < 0))
698 return -EBADMSG;
699 p = xdr_inline_decode(xdr, len * sizeof(*p));
700 if (unlikely(!p))
701 return -EBADMSG;
702 if (array == NULL)
703 return len;
704 if (len <= array_size) {
705 if (len < array_size)
706 memset(array+len, 0, (array_size-len)*sizeof(*array));
707 array_size = len;
708 retval = len;
709 } else
710 retval = -EMSGSIZE;
711 for (; array_size > 0; p++, array++, array_size--)
712 *array = be32_to_cpup(p);
713 return retval;
714}
715
716#endif
717