blob: e5497dc2475b839375666633a3fd756f114e6081 [file] [log] [blame]
Thomas Gleixner457c8992019-05-19 13:08:55 +01001// SPDX-License-Identifier: GPL-2.0-only
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * linux/net/sunrpc/xdr.c
4 *
5 * Generic XDR support.
6 *
7 * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
8 */
9
Chuck Levera246b012005-08-11 16:25:23 -040010#include <linux/module.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090011#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#include <linux/types.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <linux/string.h>
14#include <linux/kernel.h>
15#include <linux/pagemap.h>
16#include <linux/errno.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/sunrpc/xdr.h>
18#include <linux/sunrpc/msg_prot.h>
Trond Myklebust9d96acb2018-09-13 12:22:04 -040019#include <linux/bvec.h>
Chuck Lever55828632019-02-11 11:24:10 -050020#include <trace/events/sunrpc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070021
22/*
23 * XDR functions for basic NFS types
24 */
Alexey Dobriyand8ed0292006-09-26 22:29:38 -070025__be32 *
26xdr_encode_netobj(__be32 *p, const struct xdr_netobj *obj)
Linus Torvalds1da177e2005-04-16 15:20:36 -070027{
28 unsigned int quadlen = XDR_QUADLEN(obj->len);
29
30 p[quadlen] = 0; /* zero trailing bytes */
Benny Halevy9f162d22009-08-14 17:18:44 +030031 *p++ = cpu_to_be32(obj->len);
Linus Torvalds1da177e2005-04-16 15:20:36 -070032 memcpy(p, obj->data, obj->len);
33 return p + XDR_QUADLEN(obj->len);
34}
Trond Myklebust468039e2008-12-23 15:21:31 -050035EXPORT_SYMBOL_GPL(xdr_encode_netobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -070036
Alexey Dobriyand8ed0292006-09-26 22:29:38 -070037__be32 *
38xdr_decode_netobj(__be32 *p, struct xdr_netobj *obj)
Linus Torvalds1da177e2005-04-16 15:20:36 -070039{
40 unsigned int len;
41
Benny Halevy98866b52009-08-14 17:18:49 +030042 if ((len = be32_to_cpu(*p++)) > XDR_MAX_NETOBJ)
Linus Torvalds1da177e2005-04-16 15:20:36 -070043 return NULL;
44 obj->len = len;
45 obj->data = (u8 *) p;
46 return p + XDR_QUADLEN(len);
47}
Trond Myklebust468039e2008-12-23 15:21:31 -050048EXPORT_SYMBOL_GPL(xdr_decode_netobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
50/**
51 * xdr_encode_opaque_fixed - Encode fixed length opaque data
Pavel Pisa4dc3b162005-05-01 08:59:25 -070052 * @p: pointer to current position in XDR buffer.
53 * @ptr: pointer to data to encode (or NULL)
54 * @nbytes: size of data.
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 *
56 * Copy the array of data of length nbytes at ptr to the XDR buffer
57 * at position p, then align to the next 32-bit boundary by padding
58 * with zero bytes (see RFC1832).
59 * Note: if ptr is NULL, only the padding is performed.
60 *
61 * Returns the updated current XDR buffer position
62 *
63 */
Alexey Dobriyand8ed0292006-09-26 22:29:38 -070064__be32 *xdr_encode_opaque_fixed(__be32 *p, const void *ptr, unsigned int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -070065{
66 if (likely(nbytes != 0)) {
67 unsigned int quadlen = XDR_QUADLEN(nbytes);
68 unsigned int padding = (quadlen << 2) - nbytes;
69
70 if (ptr != NULL)
71 memcpy(p, ptr, nbytes);
72 if (padding != 0)
73 memset((char *)p + nbytes, 0, padding);
74 p += quadlen;
75 }
76 return p;
77}
Trond Myklebust468039e2008-12-23 15:21:31 -050078EXPORT_SYMBOL_GPL(xdr_encode_opaque_fixed);
Linus Torvalds1da177e2005-04-16 15:20:36 -070079
80/**
81 * xdr_encode_opaque - Encode variable length opaque data
Pavel Pisa4dc3b162005-05-01 08:59:25 -070082 * @p: pointer to current position in XDR buffer.
83 * @ptr: pointer to data to encode (or NULL)
84 * @nbytes: size of data.
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 *
86 * Returns the updated current XDR buffer position
87 */
Alexey Dobriyand8ed0292006-09-26 22:29:38 -070088__be32 *xdr_encode_opaque(__be32 *p, const void *ptr, unsigned int nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -070089{
Benny Halevy9f162d22009-08-14 17:18:44 +030090 *p++ = cpu_to_be32(nbytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -070091 return xdr_encode_opaque_fixed(p, ptr, nbytes);
92}
Trond Myklebust468039e2008-12-23 15:21:31 -050093EXPORT_SYMBOL_GPL(xdr_encode_opaque);
Linus Torvalds1da177e2005-04-16 15:20:36 -070094
Alexey Dobriyand8ed0292006-09-26 22:29:38 -070095__be32 *
96xdr_encode_string(__be32 *p, const char *string)
Linus Torvalds1da177e2005-04-16 15:20:36 -070097{
98 return xdr_encode_array(p, string, strlen(string));
99}
Trond Myklebust468039e2008-12-23 15:21:31 -0500100EXPORT_SYMBOL_GPL(xdr_encode_string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700102__be32 *
Chuck Levere5cff482007-11-01 16:56:47 -0400103xdr_decode_string_inplace(__be32 *p, char **sp,
104 unsigned int *lenp, unsigned int maxlen)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105{
Chuck Levere5cff482007-11-01 16:56:47 -0400106 u32 len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
Benny Halevy98866b52009-08-14 17:18:49 +0300108 len = be32_to_cpu(*p++);
Chuck Levere5cff482007-11-01 16:56:47 -0400109 if (len > maxlen)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110 return NULL;
111 *lenp = len;
112 *sp = (char *) p;
113 return p + XDR_QUADLEN(len);
114}
Trond Myklebust468039e2008-12-23 15:21:31 -0500115EXPORT_SYMBOL_GPL(xdr_decode_string_inplace);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116
Chuck Leverb4687da2010-09-21 16:55:48 -0400117/**
118 * xdr_terminate_string - '\0'-terminate a string residing in an xdr_buf
119 * @buf: XDR buffer where string resides
120 * @len: length of string, in bytes
121 *
122 */
123void
124xdr_terminate_string(struct xdr_buf *buf, const u32 len)
125{
126 char *kaddr;
127
Cong Wangb8541782011-11-25 23:14:40 +0800128 kaddr = kmap_atomic(buf->pages[0]);
Chuck Leverb4687da2010-09-21 16:55:48 -0400129 kaddr[buf->page_base + len] = '\0';
Cong Wangb8541782011-11-25 23:14:40 +0800130 kunmap_atomic(kaddr);
Chuck Leverb4687da2010-09-21 16:55:48 -0400131}
Trond Myklebust0d961aa2011-07-13 19:24:15 -0400132EXPORT_SYMBOL_GPL(xdr_terminate_string);
Chuck Leverb4687da2010-09-21 16:55:48 -0400133
Trond Myklebust9d96acb2018-09-13 12:22:04 -0400134size_t
135xdr_buf_pagecount(struct xdr_buf *buf)
136{
137 if (!buf->page_len)
138 return 0;
139 return (buf->page_base + buf->page_len + PAGE_SIZE - 1) >> PAGE_SHIFT;
140}
141
142int
143xdr_alloc_bvec(struct xdr_buf *buf, gfp_t gfp)
144{
145 size_t i, n = xdr_buf_pagecount(buf);
146
147 if (n != 0 && buf->bvec == NULL) {
148 buf->bvec = kmalloc_array(n, sizeof(buf->bvec[0]), gfp);
149 if (!buf->bvec)
150 return -ENOMEM;
151 for (i = 0; i < n; i++) {
152 buf->bvec[i].bv_page = buf->pages[i];
153 buf->bvec[i].bv_len = PAGE_SIZE;
154 buf->bvec[i].bv_offset = 0;
155 }
156 }
157 return 0;
158}
159
160void
161xdr_free_bvec(struct xdr_buf *buf)
162{
163 kfree(buf->bvec);
164 buf->bvec = NULL;
165}
166
Chuck Levercf500ba2019-02-11 11:25:20 -0500167/**
168 * xdr_inline_pages - Prepare receive buffer for a large reply
169 * @xdr: xdr_buf into which reply will be placed
170 * @offset: expected offset where data payload will start, in bytes
171 * @pages: vector of struct page pointers
172 * @base: offset in first page where receive should start, in bytes
173 * @len: expected size of the upper layer data payload, in bytes
174 *
175 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176void
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177xdr_inline_pages(struct xdr_buf *xdr, unsigned int offset,
178 struct page **pages, unsigned int base, unsigned int len)
179{
180 struct kvec *head = xdr->head;
181 struct kvec *tail = xdr->tail;
182 char *buf = (char *)head->iov_base;
183 unsigned int buflen = head->iov_len;
184
185 head->iov_len = offset;
186
187 xdr->pages = pages;
188 xdr->page_base = base;
189 xdr->page_len = len;
190
191 tail->iov_base = buf + offset;
192 tail->iov_len = buflen - offset;
Chuck Lever02ef04e2019-02-11 11:25:25 -0500193 if ((xdr->page_len & 3) == 0)
194 tail->iov_len -= sizeof(__be32);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195
196 xdr->buflen += len;
197}
Trond Myklebust468039e2008-12-23 15:21:31 -0500198EXPORT_SYMBOL_GPL(xdr_inline_pages);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200/*
201 * Helper routines for doing 'memmove' like operations on a struct xdr_buf
Ben Hutchings2c530402012-07-10 10:55:09 +0000202 */
203
204/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 * _shift_data_right_pages
206 * @pages: vector of pages containing both the source and dest memory area.
207 * @pgto_base: page vector address of destination
208 * @pgfrom_base: page vector address of source
209 * @len: number of bytes to copy
210 *
211 * Note: the addresses pgto_base and pgfrom_base are both calculated in
212 * the same way:
213 * if a memory area starts at byte 'base' in page 'pages[i]',
Kirill A. Shutemovea1754a2016-04-01 15:29:48 +0300214 * then its address is given as (i << PAGE_SHIFT) + base
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 * Also note: pgfrom_base must be < pgto_base, but the memory areas
216 * they point to may overlap.
217 */
218static void
219_shift_data_right_pages(struct page **pages, size_t pgto_base,
220 size_t pgfrom_base, size_t len)
221{
222 struct page **pgfrom, **pgto;
223 char *vfrom, *vto;
224 size_t copy;
225
226 BUG_ON(pgto_base <= pgfrom_base);
227
228 pgto_base += len;
229 pgfrom_base += len;
230
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300231 pgto = pages + (pgto_base >> PAGE_SHIFT);
232 pgfrom = pages + (pgfrom_base >> PAGE_SHIFT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300234 pgto_base &= ~PAGE_MASK;
235 pgfrom_base &= ~PAGE_MASK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236
237 do {
238 /* Are any pointers crossing a page boundary? */
239 if (pgto_base == 0) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300240 pgto_base = PAGE_SIZE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 pgto--;
242 }
243 if (pgfrom_base == 0) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300244 pgfrom_base = PAGE_SIZE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 pgfrom--;
246 }
247
248 copy = len;
249 if (copy > pgto_base)
250 copy = pgto_base;
251 if (copy > pgfrom_base)
252 copy = pgfrom_base;
253 pgto_base -= copy;
254 pgfrom_base -= copy;
255
Cong Wangb8541782011-11-25 23:14:40 +0800256 vto = kmap_atomic(*pgto);
Trond Myklebust347e2232013-08-28 13:35:13 -0400257 if (*pgto != *pgfrom) {
258 vfrom = kmap_atomic(*pgfrom);
259 memcpy(vto + pgto_base, vfrom + pgfrom_base, copy);
260 kunmap_atomic(vfrom);
261 } else
262 memmove(vto + pgto_base, vto + pgfrom_base, copy);
Trond Myklebustbce34812006-07-05 13:17:12 -0400263 flush_dcache_page(*pgto);
Cong Wangb8541782011-11-25 23:14:40 +0800264 kunmap_atomic(vto);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265
266 } while ((len -= copy) != 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267}
268
Ben Hutchings2c530402012-07-10 10:55:09 +0000269/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270 * _copy_to_pages
271 * @pages: array of pages
272 * @pgbase: page vector address of destination
273 * @p: pointer to source data
274 * @len: length
275 *
276 * Copies data from an arbitrary memory location into an array of pages
277 * The copy is assumed to be non-overlapping.
278 */
279static void
280_copy_to_pages(struct page **pages, size_t pgbase, const char *p, size_t len)
281{
282 struct page **pgto;
283 char *vto;
284 size_t copy;
285
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300286 pgto = pages + (pgbase >> PAGE_SHIFT);
287 pgbase &= ~PAGE_MASK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288
Trond Myklebustdaeba892008-03-31 17:02:02 -0400289 for (;;) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300290 copy = PAGE_SIZE - pgbase;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291 if (copy > len)
292 copy = len;
293
Cong Wangb8541782011-11-25 23:14:40 +0800294 vto = kmap_atomic(*pgto);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 memcpy(vto + pgbase, p, copy);
Cong Wangb8541782011-11-25 23:14:40 +0800296 kunmap_atomic(vto);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297
Trond Myklebustdaeba892008-03-31 17:02:02 -0400298 len -= copy;
299 if (len == 0)
300 break;
301
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302 pgbase += copy;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300303 if (pgbase == PAGE_SIZE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 flush_dcache_page(*pgto);
305 pgbase = 0;
306 pgto++;
307 }
308 p += copy;
Trond Myklebustdaeba892008-03-31 17:02:02 -0400309 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310 flush_dcache_page(*pgto);
311}
312
Ben Hutchings2c530402012-07-10 10:55:09 +0000313/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 * _copy_from_pages
315 * @p: pointer to destination
316 * @pages: array of pages
317 * @pgbase: offset of source data
318 * @len: length
319 *
320 * Copies data into an arbitrary memory location from an array of pages
321 * The copy is assumed to be non-overlapping.
322 */
Andy Adamsonbf118a32011-12-07 11:55:27 -0500323void
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324_copy_from_pages(char *p, struct page **pages, size_t pgbase, size_t len)
325{
326 struct page **pgfrom;
327 char *vfrom;
328 size_t copy;
329
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300330 pgfrom = pages + (pgbase >> PAGE_SHIFT);
331 pgbase &= ~PAGE_MASK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332
333 do {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300334 copy = PAGE_SIZE - pgbase;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 if (copy > len)
336 copy = len;
337
Cong Wangb8541782011-11-25 23:14:40 +0800338 vfrom = kmap_atomic(*pgfrom);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 memcpy(p, vfrom + pgbase, copy);
Cong Wangb8541782011-11-25 23:14:40 +0800340 kunmap_atomic(vfrom);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341
342 pgbase += copy;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300343 if (pgbase == PAGE_SIZE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 pgbase = 0;
345 pgfrom++;
346 }
347 p += copy;
348
349 } while ((len -= copy) != 0);
350}
Andy Adamsonbf118a32011-12-07 11:55:27 -0500351EXPORT_SYMBOL_GPL(_copy_from_pages);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352
Ben Hutchings2c530402012-07-10 10:55:09 +0000353/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 * xdr_shrink_bufhead
355 * @buf: xdr_buf
356 * @len: bytes to remove from buf->head[0]
357 *
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -0800358 * Shrinks XDR buffer's header kvec buf->head[0] by
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 * 'len' bytes. The extra data is not lost, but is instead
360 * moved into the inlined pages and/or the tail.
361 */
Chuck Lever7be9cea32019-02-11 11:24:16 -0500362static unsigned int
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363xdr_shrink_bufhead(struct xdr_buf *buf, size_t len)
364{
365 struct kvec *head, *tail;
366 size_t copy, offs;
367 unsigned int pglen = buf->page_len;
Chuck Lever7be9cea32019-02-11 11:24:16 -0500368 unsigned int result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369
Chuck Lever7be9cea32019-02-11 11:24:16 -0500370 result = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371 tail = buf->tail;
372 head = buf->head;
Weston Andros Adamson18e624a2012-10-23 10:43:42 -0400373
374 WARN_ON_ONCE(len > head->iov_len);
375 if (len > head->iov_len)
376 len = head->iov_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377
378 /* Shift the tail first */
379 if (tail->iov_len != 0) {
380 if (tail->iov_len > len) {
381 copy = tail->iov_len - len;
382 memmove((char *)tail->iov_base + len,
383 tail->iov_base, copy);
Chuck Lever7be9cea32019-02-11 11:24:16 -0500384 result += copy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 }
386 /* Copy from the inlined pages into the tail */
387 copy = len;
388 if (copy > pglen)
389 copy = pglen;
390 offs = len - copy;
391 if (offs >= tail->iov_len)
392 copy = 0;
393 else if (copy > tail->iov_len - offs)
394 copy = tail->iov_len - offs;
Chuck Lever7be9cea32019-02-11 11:24:16 -0500395 if (copy != 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 _copy_from_pages((char *)tail->iov_base + offs,
397 buf->pages,
398 buf->page_base + pglen + offs - len,
399 copy);
Chuck Lever7be9cea32019-02-11 11:24:16 -0500400 result += copy;
401 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 /* Do we also need to copy data from the head into the tail ? */
403 if (len > pglen) {
404 offs = copy = len - pglen;
405 if (copy > tail->iov_len)
406 copy = tail->iov_len;
407 memcpy(tail->iov_base,
408 (char *)head->iov_base +
409 head->iov_len - offs,
410 copy);
Chuck Lever7be9cea32019-02-11 11:24:16 -0500411 result += copy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 }
413 }
414 /* Now handle pages */
415 if (pglen != 0) {
416 if (pglen > len)
417 _shift_data_right_pages(buf->pages,
418 buf->page_base + len,
419 buf->page_base,
420 pglen - len);
421 copy = len;
422 if (len > pglen)
423 copy = pglen;
424 _copy_to_pages(buf->pages, buf->page_base,
425 (char *)head->iov_base + head->iov_len - len,
426 copy);
Chuck Lever7be9cea32019-02-11 11:24:16 -0500427 result += copy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 }
429 head->iov_len -= len;
430 buf->buflen -= len;
431 /* Have we truncated the message? */
432 if (buf->len > buf->buflen)
433 buf->len = buf->buflen;
Chuck Lever7be9cea32019-02-11 11:24:16 -0500434
435 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436}
437
Ben Hutchings2c530402012-07-10 10:55:09 +0000438/**
Chuck Levere8d70b32019-11-15 08:39:07 -0500439 * xdr_shrink_pagelen - shrinks buf->pages by up to @len bytes
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 * @buf: xdr_buf
441 * @len: bytes to remove from buf->pages
442 *
Chuck Levere8d70b32019-11-15 08:39:07 -0500443 * The extra data is not lost, but is instead moved into buf->tail.
444 * Returns the actual number of bytes moved.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 */
Chuck Lever7be9cea32019-02-11 11:24:16 -0500446static unsigned int
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447xdr_shrink_pagelen(struct xdr_buf *buf, size_t len)
448{
449 struct kvec *tail;
450 size_t copy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 unsigned int pglen = buf->page_len;
Trond Myklebustcf187c22010-08-29 12:13:16 -0400452 unsigned int tailbuf_len;
Chuck Lever7be9cea32019-02-11 11:24:16 -0500453 unsigned int result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454
Chuck Lever7be9cea32019-02-11 11:24:16 -0500455 result = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456 tail = buf->tail;
Chuck Levere8d70b32019-11-15 08:39:07 -0500457 if (len > buf->page_len)
458 len = buf-> page_len;
Trond Myklebustcf187c22010-08-29 12:13:16 -0400459 tailbuf_len = buf->buflen - buf->head->iov_len - buf->page_len;
460
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 /* Shift the tail first */
Trond Myklebustcf187c22010-08-29 12:13:16 -0400462 if (tailbuf_len != 0) {
463 unsigned int free_space = tailbuf_len - tail->iov_len;
464
465 if (len < free_space)
466 free_space = len;
467 tail->iov_len += free_space;
468
Benny Halevy42d6d8a2010-08-29 12:13:15 -0400469 copy = len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470 if (tail->iov_len > len) {
Benny Halevy0fe62a352010-08-29 12:13:15 -0400471 char *p = (char *)tail->iov_base + len;
Benny Halevy2e29ebb2010-08-29 12:13:15 -0400472 memmove(p, tail->iov_base, tail->iov_len - len);
Chuck Lever7be9cea32019-02-11 11:24:16 -0500473 result += tail->iov_len - len;
Benny Halevy42d6d8a2010-08-29 12:13:15 -0400474 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475 copy = tail->iov_len;
Benny Halevy42d6d8a2010-08-29 12:13:15 -0400476 /* Copy from the inlined pages into the tail */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 _copy_from_pages((char *)tail->iov_base,
478 buf->pages, buf->page_base + pglen - len,
479 copy);
Chuck Lever7be9cea32019-02-11 11:24:16 -0500480 result += copy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481 }
482 buf->page_len -= len;
483 buf->buflen -= len;
484 /* Have we truncated the message? */
485 if (buf->len > buf->buflen)
486 buf->len = buf->buflen;
Chuck Lever7be9cea32019-02-11 11:24:16 -0500487
488 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489}
490
491void
492xdr_shift_buf(struct xdr_buf *buf, size_t len)
493{
494 xdr_shrink_bufhead(buf, len);
495}
Trond Myklebust468039e2008-12-23 15:21:31 -0500496EXPORT_SYMBOL_GPL(xdr_shift_buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497
498/**
Trond Myklebust4517d522012-06-21 17:14:46 -0400499 * xdr_stream_pos - Return the current offset from the start of the xdr_stream
500 * @xdr: pointer to struct xdr_stream
501 */
502unsigned int xdr_stream_pos(const struct xdr_stream *xdr)
503{
504 return (unsigned int)(XDR_QUADLEN(xdr->buf->len) - xdr->nwords) << 2;
505}
506EXPORT_SYMBOL_GPL(xdr_stream_pos);
507
508/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 * xdr_init_encode - Initialize a struct xdr_stream for sending data.
510 * @xdr: pointer to xdr_stream struct
511 * @buf: pointer to XDR buffer in which to encode data
512 * @p: current pointer inside XDR buffer
Chuck Lever0ccc61b2019-02-11 11:24:05 -0500513 * @rqst: pointer to controlling rpc_rqst, for debugging
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 *
515 * Note: at the moment the RPC client only passes the length of our
516 * scratch buffer in the xdr_buf's header kvec. Previously this
517 * meant we needed to call xdr_adjust_iovec() after encoding the
518 * data. With the new scheme, the xdr_stream manages the details
519 * of the buffer length, and takes care of adjusting the kvec
520 * length for us.
521 */
Chuck Lever0ccc61b2019-02-11 11:24:05 -0500522void xdr_init_encode(struct xdr_stream *xdr, struct xdr_buf *buf, __be32 *p,
523 struct rpc_rqst *rqst)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524{
525 struct kvec *iov = buf->head;
Trond Myklebust334ccfd2005-06-22 17:16:19 +0000526 int scratch_len = buf->buflen - buf->page_len - buf->tail[0].iov_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527
J. Bruce Fields2825a7f2013-08-26 16:04:46 -0400528 xdr_set_scratch_buffer(xdr, NULL, 0);
Trond Myklebust334ccfd2005-06-22 17:16:19 +0000529 BUG_ON(scratch_len < 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 xdr->buf = buf;
531 xdr->iov = iov;
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700532 xdr->p = (__be32 *)((char *)iov->iov_base + iov->iov_len);
533 xdr->end = (__be32 *)((char *)iov->iov_base + scratch_len);
Trond Myklebust334ccfd2005-06-22 17:16:19 +0000534 BUG_ON(iov->iov_len > scratch_len);
535
536 if (p != xdr->p && p != NULL) {
537 size_t len;
538
539 BUG_ON(p < xdr->p || p > xdr->end);
540 len = (char *)p - (char *)xdr->p;
541 xdr->p = p;
542 buf->len += len;
543 iov->iov_len += len;
544 }
Chuck Lever0ccc61b2019-02-11 11:24:05 -0500545 xdr->rqst = rqst;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546}
Trond Myklebust468039e2008-12-23 15:21:31 -0500547EXPORT_SYMBOL_GPL(xdr_init_encode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548
549/**
J. Bruce Fields2825a7f2013-08-26 16:04:46 -0400550 * xdr_commit_encode - Ensure all data is written to buffer
551 * @xdr: pointer to xdr_stream
552 *
553 * We handle encoding across page boundaries by giving the caller a
554 * temporary location to write to, then later copying the data into
555 * place; xdr_commit_encode does that copying.
556 *
557 * Normally the caller doesn't need to call this directly, as the
558 * following xdr_reserve_space will do it. But an explicit call may be
559 * required at the end of encoding, or any other time when the xdr_buf
560 * data might be read.
561 */
Chuck Lever95bd8302019-08-19 18:37:05 -0400562inline void xdr_commit_encode(struct xdr_stream *xdr)
J. Bruce Fields2825a7f2013-08-26 16:04:46 -0400563{
564 int shift = xdr->scratch.iov_len;
565 void *page;
566
567 if (shift == 0)
568 return;
569 page = page_address(*xdr->page_ptr);
570 memcpy(xdr->scratch.iov_base, page, shift);
571 memmove(page, page + shift, (void *)xdr->p - page);
572 xdr->scratch.iov_len = 0;
573}
574EXPORT_SYMBOL_GPL(xdr_commit_encode);
575
Trond Myklebust22cb4382014-07-12 18:01:02 -0400576static __be32 *xdr_get_next_encode_buffer(struct xdr_stream *xdr,
577 size_t nbytes)
J. Bruce Fields2825a7f2013-08-26 16:04:46 -0400578{
YueHaibing025911a2018-11-08 02:04:57 +0000579 __be32 *p;
J. Bruce Fields2825a7f2013-08-26 16:04:46 -0400580 int space_left;
581 int frag1bytes, frag2bytes;
582
583 if (nbytes > PAGE_SIZE)
Chuck Lever55828632019-02-11 11:24:10 -0500584 goto out_overflow; /* Bigger buffers require special handling */
J. Bruce Fields2825a7f2013-08-26 16:04:46 -0400585 if (xdr->buf->len + nbytes > xdr->buf->buflen)
Chuck Lever55828632019-02-11 11:24:10 -0500586 goto out_overflow; /* Sorry, we're totally out of space */
J. Bruce Fields2825a7f2013-08-26 16:04:46 -0400587 frag1bytes = (xdr->end - xdr->p) << 2;
588 frag2bytes = nbytes - frag1bytes;
589 if (xdr->iov)
590 xdr->iov->iov_len += frag1bytes;
J. Bruce Fields05638dc2014-06-02 12:05:47 -0400591 else
J. Bruce Fields2825a7f2013-08-26 16:04:46 -0400592 xdr->buf->page_len += frag1bytes;
J. Bruce Fields05638dc2014-06-02 12:05:47 -0400593 xdr->page_ptr++;
J. Bruce Fields2825a7f2013-08-26 16:04:46 -0400594 xdr->iov = NULL;
595 /*
596 * If the last encode didn't end exactly on a page boundary, the
597 * next one will straddle boundaries. Encode into the next
598 * page, then copy it back later in xdr_commit_encode. We use
599 * the "scratch" iov to track any temporarily unused fragment of
600 * space at the end of the previous buffer:
601 */
602 xdr->scratch.iov_base = xdr->p;
603 xdr->scratch.iov_len = frag1bytes;
604 p = page_address(*xdr->page_ptr);
605 /*
606 * Note this is where the next encode will start after we've
607 * shifted this one back:
608 */
609 xdr->p = (void *)p + frag2bytes;
610 space_left = xdr->buf->buflen - xdr->buf->len;
611 xdr->end = (void *)p + min_t(int, space_left, PAGE_SIZE);
612 xdr->buf->page_len += frag2bytes;
613 xdr->buf->len += nbytes;
614 return p;
Chuck Lever55828632019-02-11 11:24:10 -0500615out_overflow:
616 trace_rpc_xdr_overflow(xdr, nbytes);
617 return NULL;
J. Bruce Fields2825a7f2013-08-26 16:04:46 -0400618}
619
620/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 * xdr_reserve_space - Reserve buffer space for sending
622 * @xdr: pointer to xdr_stream
623 * @nbytes: number of bytes to reserve
624 *
625 * Checks that we have enough buffer space to encode 'nbytes' more
626 * bytes of data. If so, update the total xdr_buf length, and
627 * adjust the length of the current kvec.
628 */
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700629__be32 * xdr_reserve_space(struct xdr_stream *xdr, size_t nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630{
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700631 __be32 *p = xdr->p;
632 __be32 *q;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633
J. Bruce Fields2825a7f2013-08-26 16:04:46 -0400634 xdr_commit_encode(xdr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 /* align nbytes on the next 32-bit boundary */
636 nbytes += 3;
637 nbytes &= ~3;
638 q = p + (nbytes >> 2);
639 if (unlikely(q > xdr->end || q < p))
J. Bruce Fields2825a7f2013-08-26 16:04:46 -0400640 return xdr_get_next_encode_buffer(xdr, nbytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 xdr->p = q;
J. Bruce Fields2825a7f2013-08-26 16:04:46 -0400642 if (xdr->iov)
643 xdr->iov->iov_len += nbytes;
644 else
645 xdr->buf->page_len += nbytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 xdr->buf->len += nbytes;
647 return p;
648}
Trond Myklebust468039e2008-12-23 15:21:31 -0500649EXPORT_SYMBOL_GPL(xdr_reserve_space);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650
651/**
J. Bruce Fields3e19ce72014-02-25 17:44:21 -0500652 * xdr_truncate_encode - truncate an encode buffer
653 * @xdr: pointer to xdr_stream
654 * @len: new length of buffer
655 *
656 * Truncates the xdr stream, so that xdr->buf->len == len,
657 * and xdr->p points at offset len from the start of the buffer, and
658 * head, tail, and page lengths are adjusted to correspond.
659 *
660 * If this means moving xdr->p to a different buffer, we assume that
661 * that the end pointer should be set to the end of the current page,
662 * except in the case of the head buffer when we assume the head
663 * buffer's current length represents the end of the available buffer.
664 *
665 * This is *not* safe to use on a buffer that already has inlined page
666 * cache pages (as in a zero-copy server read reply), except for the
667 * simple case of truncating from one position in the tail to another.
668 *
669 */
670void xdr_truncate_encode(struct xdr_stream *xdr, size_t len)
671{
672 struct xdr_buf *buf = xdr->buf;
673 struct kvec *head = buf->head;
674 struct kvec *tail = buf->tail;
675 int fraglen;
J. Bruce Fields49a068f2014-12-22 16:14:51 -0500676 int new;
J. Bruce Fields3e19ce72014-02-25 17:44:21 -0500677
678 if (len > buf->len) {
679 WARN_ON_ONCE(1);
680 return;
681 }
J. Bruce Fields2825a7f2013-08-26 16:04:46 -0400682 xdr_commit_encode(xdr);
J. Bruce Fields3e19ce72014-02-25 17:44:21 -0500683
684 fraglen = min_t(int, buf->len - len, tail->iov_len);
685 tail->iov_len -= fraglen;
686 buf->len -= fraglen;
J. Bruce Fieldsed38c062014-09-19 17:21:35 -0400687 if (tail->iov_len) {
J. Bruce Fields3e19ce72014-02-25 17:44:21 -0500688 xdr->p = tail->iov_base + tail->iov_len;
J. Bruce Fields280caac2014-10-01 11:36:31 -0400689 WARN_ON_ONCE(!xdr->end);
690 WARN_ON_ONCE(!xdr->iov);
J. Bruce Fields3e19ce72014-02-25 17:44:21 -0500691 return;
692 }
693 WARN_ON_ONCE(fraglen);
694 fraglen = min_t(int, buf->len - len, buf->page_len);
695 buf->page_len -= fraglen;
696 buf->len -= fraglen;
697
698 new = buf->page_base + buf->page_len;
J. Bruce Fields49a068f2014-12-22 16:14:51 -0500699
700 xdr->page_ptr = buf->pages + (new >> PAGE_SHIFT);
J. Bruce Fields3e19ce72014-02-25 17:44:21 -0500701
J. Bruce Fieldsed38c062014-09-19 17:21:35 -0400702 if (buf->page_len) {
J. Bruce Fields3e19ce72014-02-25 17:44:21 -0500703 xdr->p = page_address(*xdr->page_ptr);
704 xdr->end = (void *)xdr->p + PAGE_SIZE;
705 xdr->p = (void *)xdr->p + (new % PAGE_SIZE);
J. Bruce Fields280caac2014-10-01 11:36:31 -0400706 WARN_ON_ONCE(xdr->iov);
J. Bruce Fields3e19ce72014-02-25 17:44:21 -0500707 return;
708 }
Frank Sorenson5d7a5bc2018-10-30 15:10:40 -0500709 if (fraglen)
J. Bruce Fields3e19ce72014-02-25 17:44:21 -0500710 xdr->end = head->iov_base + head->iov_len;
711 /* (otherwise assume xdr->end is already set) */
Frank Sorenson5d7a5bc2018-10-30 15:10:40 -0500712 xdr->page_ptr--;
J. Bruce Fields3e19ce72014-02-25 17:44:21 -0500713 head->iov_len = len;
714 buf->len = len;
715 xdr->p = head->iov_base + head->iov_len;
716 xdr->iov = buf->head;
717}
718EXPORT_SYMBOL(xdr_truncate_encode);
719
720/**
J. Bruce Fieldsdb3f58a2014-03-06 13:22:18 -0500721 * xdr_restrict_buflen - decrease available buffer space
722 * @xdr: pointer to xdr_stream
723 * @newbuflen: new maximum number of bytes available
724 *
725 * Adjust our idea of how much space is available in the buffer.
726 * If we've already used too much space in the buffer, returns -1.
727 * If the available space is already smaller than newbuflen, returns 0
728 * and does nothing. Otherwise, adjusts xdr->buf->buflen to newbuflen
729 * and ensures xdr->end is set at most offset newbuflen from the start
730 * of the buffer.
731 */
732int xdr_restrict_buflen(struct xdr_stream *xdr, int newbuflen)
733{
734 struct xdr_buf *buf = xdr->buf;
735 int left_in_this_buf = (void *)xdr->end - (void *)xdr->p;
736 int end_offset = buf->len + left_in_this_buf;
737
738 if (newbuflen < 0 || newbuflen < buf->len)
739 return -1;
740 if (newbuflen > buf->buflen)
741 return 0;
742 if (newbuflen < end_offset)
743 xdr->end = (void *)xdr->end + newbuflen - end_offset;
744 buf->buflen = newbuflen;
745 return 0;
746}
747EXPORT_SYMBOL(xdr_restrict_buflen);
748
749/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 * xdr_write_pages - Insert a list of pages into an XDR buffer for sending
751 * @xdr: pointer to xdr_stream
752 * @pages: list of pages
753 * @base: offset of first byte
754 * @len: length of data in bytes
755 *
756 */
757void xdr_write_pages(struct xdr_stream *xdr, struct page **pages, unsigned int base,
758 unsigned int len)
759{
760 struct xdr_buf *buf = xdr->buf;
761 struct kvec *iov = buf->tail;
762 buf->pages = pages;
763 buf->page_base = base;
764 buf->page_len = len;
765
766 iov->iov_base = (char *)xdr->p;
767 iov->iov_len = 0;
768 xdr->iov = iov;
769
770 if (len & 3) {
771 unsigned int pad = 4 - (len & 3);
772
773 BUG_ON(xdr->p >= xdr->end);
774 iov->iov_base = (char *)xdr->p + (len & 3);
775 iov->iov_len += pad;
776 len += pad;
777 *xdr->p++ = 0;
778 }
779 buf->buflen += len;
780 buf->len += len;
781}
Trond Myklebust468039e2008-12-23 15:21:31 -0500782EXPORT_SYMBOL_GPL(xdr_write_pages);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783
Trond Myklebust66502392011-01-08 17:45:38 -0500784static void xdr_set_iov(struct xdr_stream *xdr, struct kvec *iov,
Trond Myklebust15376932012-06-28 17:17:48 -0400785 unsigned int len)
Trond Myklebust66502392011-01-08 17:45:38 -0500786{
787 if (len > iov->iov_len)
788 len = iov->iov_len;
Trond Myklebust15376932012-06-28 17:17:48 -0400789 xdr->p = (__be32*)iov->iov_base;
Trond Myklebust66502392011-01-08 17:45:38 -0500790 xdr->end = (__be32*)(iov->iov_base + len);
791 xdr->iov = iov;
792 xdr->page_ptr = NULL;
793}
794
795static int xdr_set_page_base(struct xdr_stream *xdr,
796 unsigned int base, unsigned int len)
797{
798 unsigned int pgnr;
799 unsigned int maxlen;
800 unsigned int pgoff;
801 unsigned int pgend;
802 void *kaddr;
803
804 maxlen = xdr->buf->page_len;
805 if (base >= maxlen)
806 return -EINVAL;
807 maxlen -= base;
808 if (len > maxlen)
809 len = maxlen;
810
811 base += xdr->buf->page_base;
812
813 pgnr = base >> PAGE_SHIFT;
814 xdr->page_ptr = &xdr->buf->pages[pgnr];
815 kaddr = page_address(*xdr->page_ptr);
816
817 pgoff = base & ~PAGE_MASK;
818 xdr->p = (__be32*)(kaddr + pgoff);
819
820 pgend = pgoff + len;
821 if (pgend > PAGE_SIZE)
822 pgend = PAGE_SIZE;
823 xdr->end = (__be32*)(kaddr + pgend);
824 xdr->iov = NULL;
825 return 0;
826}
827
828static void xdr_set_next_page(struct xdr_stream *xdr)
829{
830 unsigned int newbase;
831
832 newbase = (1 + xdr->page_ptr - xdr->buf->pages) << PAGE_SHIFT;
833 newbase -= xdr->buf->page_base;
834
835 if (xdr_set_page_base(xdr, newbase, PAGE_SIZE) < 0)
Trond Myklebusta6cebd42016-09-20 14:33:43 -0400836 xdr_set_iov(xdr, xdr->buf->tail, xdr->nwords << 2);
Trond Myklebust66502392011-01-08 17:45:38 -0500837}
838
839static bool xdr_set_next_buffer(struct xdr_stream *xdr)
840{
841 if (xdr->page_ptr != NULL)
842 xdr_set_next_page(xdr);
843 else if (xdr->iov == xdr->buf->head) {
844 if (xdr_set_page_base(xdr, 0, PAGE_SIZE) < 0)
Trond Myklebusta6cebd42016-09-20 14:33:43 -0400845 xdr_set_iov(xdr, xdr->buf->tail, xdr->nwords << 2);
Trond Myklebust66502392011-01-08 17:45:38 -0500846 }
847 return xdr->p != xdr->end;
848}
849
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850/**
851 * xdr_init_decode - Initialize an xdr_stream for decoding data.
852 * @xdr: pointer to xdr_stream struct
853 * @buf: pointer to XDR buffer from which to decode data
854 * @p: current pointer inside XDR buffer
Chuck Lever0ccc61b2019-02-11 11:24:05 -0500855 * @rqst: pointer to controlling rpc_rqst, for debugging
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 */
Chuck Lever0ccc61b2019-02-11 11:24:05 -0500857void xdr_init_decode(struct xdr_stream *xdr, struct xdr_buf *buf, __be32 *p,
858 struct rpc_rqst *rqst)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860 xdr->buf = buf;
Trond Myklebust66502392011-01-08 17:45:38 -0500861 xdr->scratch.iov_base = NULL;
862 xdr->scratch.iov_len = 0;
Trond Myklebustbfeea1d2012-06-20 09:58:35 -0400863 xdr->nwords = XDR_QUADLEN(buf->len);
Trond Myklebust66502392011-01-08 17:45:38 -0500864 if (buf->head[0].iov_len != 0)
Trond Myklebust15376932012-06-28 17:17:48 -0400865 xdr_set_iov(xdr, buf->head, buf->len);
Trond Myklebust66502392011-01-08 17:45:38 -0500866 else if (buf->page_len != 0)
867 xdr_set_page_base(xdr, 0, buf->len);
Benjamin Coddington06ef26a2016-04-06 11:32:52 -0400868 else
869 xdr_set_iov(xdr, buf->head, buf->len);
Trond Myklebustbfeea1d2012-06-20 09:58:35 -0400870 if (p != NULL && p > xdr->p && xdr->end >= p) {
871 xdr->nwords -= p - xdr->p;
Trond Myklebust15376932012-06-28 17:17:48 -0400872 xdr->p = p;
Trond Myklebustbfeea1d2012-06-20 09:58:35 -0400873 }
Chuck Lever0ccc61b2019-02-11 11:24:05 -0500874 xdr->rqst = rqst;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700875}
Trond Myklebust468039e2008-12-23 15:21:31 -0500876EXPORT_SYMBOL_GPL(xdr_init_decode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877
Benny Halevyf7da7a12011-05-19 14:16:47 -0400878/**
Chuck Lever7ecce752017-04-11 13:23:59 -0400879 * xdr_init_decode_pages - Initialize an xdr_stream for decoding into pages
Benny Halevyf7da7a12011-05-19 14:16:47 -0400880 * @xdr: pointer to xdr_stream struct
881 * @buf: pointer to XDR buffer from which to decode data
882 * @pages: list of pages to decode into
883 * @len: length in bytes of buffer in pages
884 */
885void xdr_init_decode_pages(struct xdr_stream *xdr, struct xdr_buf *buf,
886 struct page **pages, unsigned int len)
887{
888 memset(buf, 0, sizeof(*buf));
889 buf->pages = pages;
890 buf->page_len = len;
891 buf->buflen = len;
892 buf->len = len;
Chuck Lever0ccc61b2019-02-11 11:24:05 -0500893 xdr_init_decode(xdr, buf, NULL, NULL);
Benny Halevyf7da7a12011-05-19 14:16:47 -0400894}
895EXPORT_SYMBOL_GPL(xdr_init_decode_pages);
896
Trond Myklebust66502392011-01-08 17:45:38 -0500897static __be32 * __xdr_inline_decode(struct xdr_stream *xdr, size_t nbytes)
Trond Myklebustba8e4522010-10-19 19:58:49 -0400898{
Trond Myklebustbfeea1d2012-06-20 09:58:35 -0400899 unsigned int nwords = XDR_QUADLEN(nbytes);
Trond Myklebustba8e4522010-10-19 19:58:49 -0400900 __be32 *p = xdr->p;
Trond Myklebustbfeea1d2012-06-20 09:58:35 -0400901 __be32 *q = p + nwords;
Trond Myklebustba8e4522010-10-19 19:58:49 -0400902
Trond Myklebustbfeea1d2012-06-20 09:58:35 -0400903 if (unlikely(nwords > xdr->nwords || q > xdr->end || q < p))
Trond Myklebustba8e4522010-10-19 19:58:49 -0400904 return NULL;
Trond Myklebust66502392011-01-08 17:45:38 -0500905 xdr->p = q;
Trond Myklebustbfeea1d2012-06-20 09:58:35 -0400906 xdr->nwords -= nwords;
Trond Myklebustba8e4522010-10-19 19:58:49 -0400907 return p;
908}
Trond Myklebustba8e4522010-10-19 19:58:49 -0400909
910/**
Trond Myklebust66502392011-01-08 17:45:38 -0500911 * xdr_set_scratch_buffer - Attach a scratch buffer for decoding data.
912 * @xdr: pointer to xdr_stream struct
913 * @buf: pointer to an empty buffer
914 * @buflen: size of 'buf'
915 *
916 * The scratch buffer is used when decoding from an array of pages.
917 * If an xdr_inline_decode() call spans across page boundaries, then
918 * we copy the data into the scratch buffer in order to allow linear
919 * access.
920 */
921void xdr_set_scratch_buffer(struct xdr_stream *xdr, void *buf, size_t buflen)
922{
923 xdr->scratch.iov_base = buf;
924 xdr->scratch.iov_len = buflen;
925}
926EXPORT_SYMBOL_GPL(xdr_set_scratch_buffer);
927
928static __be32 *xdr_copy_to_scratch(struct xdr_stream *xdr, size_t nbytes)
929{
930 __be32 *p;
Trond Myklebustace0e142016-09-20 14:33:42 -0400931 char *cpdest = xdr->scratch.iov_base;
Trond Myklebust66502392011-01-08 17:45:38 -0500932 size_t cplen = (char *)xdr->end - (char *)xdr->p;
933
934 if (nbytes > xdr->scratch.iov_len)
Chuck Lever55828632019-02-11 11:24:10 -0500935 goto out_overflow;
Trond Myklebustace0e142016-09-20 14:33:42 -0400936 p = __xdr_inline_decode(xdr, cplen);
937 if (p == NULL)
938 return NULL;
939 memcpy(cpdest, p, cplen);
Chuck Lever55828632019-02-11 11:24:10 -0500940 if (!xdr_set_next_buffer(xdr))
941 goto out_overflow;
Trond Myklebust66502392011-01-08 17:45:38 -0500942 cpdest += cplen;
943 nbytes -= cplen;
Trond Myklebust66502392011-01-08 17:45:38 -0500944 p = __xdr_inline_decode(xdr, nbytes);
945 if (p == NULL)
946 return NULL;
947 memcpy(cpdest, p, nbytes);
948 return xdr->scratch.iov_base;
Chuck Lever55828632019-02-11 11:24:10 -0500949out_overflow:
950 trace_rpc_xdr_overflow(xdr, nbytes);
951 return NULL;
Trond Myklebust66502392011-01-08 17:45:38 -0500952}
953
954/**
955 * xdr_inline_decode - Retrieve XDR data to decode
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956 * @xdr: pointer to xdr_stream struct
957 * @nbytes: number of bytes of data to decode
958 *
959 * Check if the input buffer is long enough to enable us to decode
960 * 'nbytes' more bytes of data starting at the current position.
961 * If so return the current pointer, then update the current
962 * pointer position.
963 */
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700964__be32 * xdr_inline_decode(struct xdr_stream *xdr, size_t nbytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965{
Trond Myklebust66502392011-01-08 17:45:38 -0500966 __be32 *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967
Chuck Lever55828632019-02-11 11:24:10 -0500968 if (unlikely(nbytes == 0))
Trond Myklebust66502392011-01-08 17:45:38 -0500969 return xdr->p;
970 if (xdr->p == xdr->end && !xdr_set_next_buffer(xdr))
Chuck Lever55828632019-02-11 11:24:10 -0500971 goto out_overflow;
Trond Myklebust66502392011-01-08 17:45:38 -0500972 p = __xdr_inline_decode(xdr, nbytes);
973 if (p != NULL)
974 return p;
975 return xdr_copy_to_scratch(xdr, nbytes);
Chuck Lever55828632019-02-11 11:24:10 -0500976out_overflow:
977 trace_rpc_xdr_overflow(xdr, nbytes);
978 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979}
Trond Myklebust468039e2008-12-23 15:21:31 -0500980EXPORT_SYMBOL_GPL(xdr_inline_decode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981
Trond Myklebust3994ee62012-06-26 12:34:05 -0400982static unsigned int xdr_align_pages(struct xdr_stream *xdr, unsigned int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983{
984 struct xdr_buf *buf = xdr->buf;
985 struct kvec *iov;
Trond Myklebustbfeea1d2012-06-20 09:58:35 -0400986 unsigned int nwords = XDR_QUADLEN(len);
Trond Myklebustb760b312012-06-26 12:19:55 -0400987 unsigned int cur = xdr_stream_pos(xdr);
Chuck Lever7be9cea32019-02-11 11:24:16 -0500988 unsigned int copied, offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989
Trond Myklebustbfeea1d2012-06-20 09:58:35 -0400990 if (xdr->nwords == 0)
Trond Myklebustc337d362012-06-21 17:05:37 -0400991 return 0;
Chuck Lever7be9cea32019-02-11 11:24:16 -0500992
Trond Myklebusta11a2bf2012-08-02 13:21:43 -0400993 /* Realign pages to current pointer position */
Chuck Lever7be9cea32019-02-11 11:24:16 -0500994 iov = buf->head;
Trond Myklebusta11a2bf2012-08-02 13:21:43 -0400995 if (iov->iov_len > cur) {
Chuck Lever7be9cea32019-02-11 11:24:16 -0500996 offset = iov->iov_len - cur;
997 copied = xdr_shrink_bufhead(buf, offset);
998 trace_rpc_xdr_alignment(xdr, offset, copied);
Trond Myklebusta11a2bf2012-08-02 13:21:43 -0400999 xdr->nwords = XDR_QUADLEN(buf->len - cur);
1000 }
1001
Trond Myklebustbfeea1d2012-06-20 09:58:35 -04001002 if (nwords > xdr->nwords) {
1003 nwords = xdr->nwords;
1004 len = nwords << 2;
1005 }
Trond Myklebusta11a2bf2012-08-02 13:21:43 -04001006 if (buf->page_len <= len)
Trond Myklebust8a9a8b82012-08-01 14:32:13 -04001007 len = buf->page_len;
Trond Myklebusta11a2bf2012-08-02 13:21:43 -04001008 else if (nwords < xdr->nwords) {
1009 /* Truncate page data and move it into the tail */
Chuck Lever7be9cea32019-02-11 11:24:16 -05001010 offset = buf->page_len - len;
1011 copied = xdr_shrink_pagelen(buf, offset);
1012 trace_rpc_xdr_alignment(xdr, offset, copied);
Trond Myklebusta11a2bf2012-08-02 13:21:43 -04001013 xdr->nwords = XDR_QUADLEN(buf->len - cur);
1014 }
Trond Myklebust3994ee62012-06-26 12:34:05 -04001015 return len;
1016}
Trond Myklebustbd00f842012-06-26 13:50:43 -04001017
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018/**
1019 * xdr_read_pages - Ensure page-based XDR data to decode is aligned at current pointer position
1020 * @xdr: pointer to xdr_stream struct
1021 * @len: number of bytes of page data
1022 *
1023 * Moves data beyond the current pointer position from the XDR head[] buffer
1024 * into the page list. Any data that lies beyond current position + "len"
1025 * bytes is moved into the XDR tail[].
Trond Myklebust3994ee62012-06-26 12:34:05 -04001026 *
1027 * Returns the number of XDR encoded bytes now contained in the pages
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028 */
Trond Myklebust3994ee62012-06-26 12:34:05 -04001029unsigned int xdr_read_pages(struct xdr_stream *xdr, unsigned int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030{
1031 struct xdr_buf *buf = xdr->buf;
1032 struct kvec *iov;
Trond Myklebust3994ee62012-06-26 12:34:05 -04001033 unsigned int nwords;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034 unsigned int end;
Trond Myklebust3994ee62012-06-26 12:34:05 -04001035 unsigned int padding;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036
Trond Myklebust3994ee62012-06-26 12:34:05 -04001037 len = xdr_align_pages(xdr, len);
1038 if (len == 0)
1039 return 0;
1040 nwords = XDR_QUADLEN(len);
Trond Myklebustbfeea1d2012-06-20 09:58:35 -04001041 padding = (nwords << 2) - len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042 xdr->iov = iov = buf->tail;
1043 /* Compute remaining message length. */
Trond Myklebustbd00f842012-06-26 13:50:43 -04001044 end = ((xdr->nwords - nwords) << 2) + padding;
1045 if (end > iov->iov_len)
1046 end = iov->iov_len;
1047
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048 /*
1049 * Position current pointer at beginning of tail, and
1050 * set remaining message length.
1051 */
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001052 xdr->p = (__be32 *)((char *)iov->iov_base + padding);
1053 xdr->end = (__be32 *)((char *)iov->iov_base + end);
Trond Myklebust76cacaa2012-06-26 15:32:40 -04001054 xdr->page_ptr = NULL;
Trond Myklebustbfeea1d2012-06-20 09:58:35 -04001055 xdr->nwords = XDR_QUADLEN(end - padding);
Trond Myklebustc337d362012-06-21 17:05:37 -04001056 return len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057}
Trond Myklebust468039e2008-12-23 15:21:31 -05001058EXPORT_SYMBOL_GPL(xdr_read_pages);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059
Trond Myklebust8b23ea72006-06-09 09:34:21 -04001060/**
1061 * xdr_enter_page - decode data from the XDR page
1062 * @xdr: pointer to xdr_stream struct
1063 * @len: number of bytes of page data
1064 *
1065 * Moves data beyond the current pointer position from the XDR head[] buffer
1066 * into the page list. Any data that lies beyond current position + "len"
1067 * bytes is moved into the XDR tail[]. The current pointer is then
1068 * repositioned at the beginning of the first XDR page.
1069 */
1070void xdr_enter_page(struct xdr_stream *xdr, unsigned int len)
1071{
Trond Myklebustf8bb7f02012-06-21 14:53:10 -04001072 len = xdr_align_pages(xdr, len);
Trond Myklebust8b23ea72006-06-09 09:34:21 -04001073 /*
1074 * Position current pointer at beginning of tail, and
1075 * set remaining message length.
1076 */
Trond Myklebustf8bb7f02012-06-21 14:53:10 -04001077 if (len != 0)
1078 xdr_set_page_base(xdr, 0, len);
Trond Myklebust8b23ea72006-06-09 09:34:21 -04001079}
Trond Myklebust468039e2008-12-23 15:21:31 -05001080EXPORT_SYMBOL_GPL(xdr_enter_page);
Trond Myklebust8b23ea72006-06-09 09:34:21 -04001081
Julia Lawallc2bd2c02020-01-01 08:43:30 +01001082static const struct kvec empty_iov = {.iov_base = NULL, .iov_len = 0};
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083
1084void
1085xdr_buf_from_iov(struct kvec *iov, struct xdr_buf *buf)
1086{
1087 buf->head[0] = *iov;
1088 buf->tail[0] = empty_iov;
1089 buf->page_len = 0;
1090 buf->buflen = buf->len = iov->iov_len;
1091}
Trond Myklebust468039e2008-12-23 15:21:31 -05001092EXPORT_SYMBOL_GPL(xdr_buf_from_iov);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093
J. Bruce Fieldsde4aee22014-02-25 17:21:08 -05001094/**
1095 * xdr_buf_subsegment - set subbuf to a portion of buf
1096 * @buf: an xdr buffer
1097 * @subbuf: the result buffer
1098 * @base: beginning of range in bytes
1099 * @len: length of range in bytes
1100 *
1101 * sets @subbuf to an xdr buffer representing the portion of @buf of
1102 * length @len starting at offset @base.
1103 *
1104 * @buf and @subbuf may be pointers to the same struct xdr_buf.
1105 *
1106 * Returns -1 if base of length are out of bounds.
1107 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108int
1109xdr_buf_subsegment(struct xdr_buf *buf, struct xdr_buf *subbuf,
Trond Myklebust1e789572006-08-31 15:09:19 -04001110 unsigned int base, unsigned int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001111{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112 subbuf->buflen = subbuf->len = len;
Trond Myklebust1e789572006-08-31 15:09:19 -04001113 if (base < buf->head[0].iov_len) {
1114 subbuf->head[0].iov_base = buf->head[0].iov_base + base;
1115 subbuf->head[0].iov_len = min_t(unsigned int, len,
1116 buf->head[0].iov_len - base);
1117 len -= subbuf->head[0].iov_len;
1118 base = 0;
1119 } else {
Trond Myklebust1e789572006-08-31 15:09:19 -04001120 base -= buf->head[0].iov_len;
J. Bruce Fieldsde4aee22014-02-25 17:21:08 -05001121 subbuf->head[0].iov_len = 0;
Trond Myklebust1e789572006-08-31 15:09:19 -04001122 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001123
1124 if (base < buf->page_len) {
Trond Myklebust1e789572006-08-31 15:09:19 -04001125 subbuf->page_len = min(buf->page_len - base, len);
1126 base += buf->page_base;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001127 subbuf->page_base = base & ~PAGE_MASK;
1128 subbuf->pages = &buf->pages[base >> PAGE_SHIFT];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129 len -= subbuf->page_len;
1130 base = 0;
1131 } else {
1132 base -= buf->page_len;
1133 subbuf->page_len = 0;
1134 }
1135
Trond Myklebust1e789572006-08-31 15:09:19 -04001136 if (base < buf->tail[0].iov_len) {
1137 subbuf->tail[0].iov_base = buf->tail[0].iov_base + base;
1138 subbuf->tail[0].iov_len = min_t(unsigned int, len,
1139 buf->tail[0].iov_len - base);
1140 len -= subbuf->tail[0].iov_len;
1141 base = 0;
1142 } else {
Trond Myklebust1e789572006-08-31 15:09:19 -04001143 base -= buf->tail[0].iov_len;
J. Bruce Fieldsde4aee22014-02-25 17:21:08 -05001144 subbuf->tail[0].iov_len = 0;
Trond Myklebust1e789572006-08-31 15:09:19 -04001145 }
1146
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147 if (base || len)
1148 return -1;
1149 return 0;
1150}
Trond Myklebust468039e2008-12-23 15:21:31 -05001151EXPORT_SYMBOL_GPL(xdr_buf_subsegment);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152
Trond Myklebust4e3e43a2006-10-17 13:47:24 -04001153static void __read_bytes_from_xdr_buf(struct xdr_buf *subbuf, void *obj, unsigned int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154{
Trond Myklebust1e789572006-08-31 15:09:19 -04001155 unsigned int this_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001156
Trond Myklebust4e3e43a2006-10-17 13:47:24 -04001157 this_len = min_t(unsigned int, len, subbuf->head[0].iov_len);
1158 memcpy(obj, subbuf->head[0].iov_base, this_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159 len -= this_len;
1160 obj += this_len;
Trond Myklebust4e3e43a2006-10-17 13:47:24 -04001161 this_len = min_t(unsigned int, len, subbuf->page_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162 if (this_len)
Trond Myklebust4e3e43a2006-10-17 13:47:24 -04001163 _copy_from_pages(obj, subbuf->pages, subbuf->page_base, this_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164 len -= this_len;
1165 obj += this_len;
Trond Myklebust4e3e43a2006-10-17 13:47:24 -04001166 this_len = min_t(unsigned int, len, subbuf->tail[0].iov_len);
1167 memcpy(obj, subbuf->tail[0].iov_base, this_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168}
1169
Andreas Gruenbacherbd8100e2005-06-22 17:16:24 +00001170/* obj is assumed to point to allocated memory of size at least len: */
Trond Myklebust4e3e43a2006-10-17 13:47:24 -04001171int read_bytes_from_xdr_buf(struct xdr_buf *buf, unsigned int base, void *obj, unsigned int len)
Andreas Gruenbacherbd8100e2005-06-22 17:16:24 +00001172{
1173 struct xdr_buf subbuf;
Andreas Gruenbacherbd8100e2005-06-22 17:16:24 +00001174 int status;
1175
1176 status = xdr_buf_subsegment(buf, &subbuf, base, len);
Trond Myklebust4e3e43a2006-10-17 13:47:24 -04001177 if (status != 0)
1178 return status;
1179 __read_bytes_from_xdr_buf(&subbuf, obj, len);
1180 return 0;
1181}
Trond Myklebust468039e2008-12-23 15:21:31 -05001182EXPORT_SYMBOL_GPL(read_bytes_from_xdr_buf);
Trond Myklebust4e3e43a2006-10-17 13:47:24 -04001183
1184static void __write_bytes_to_xdr_buf(struct xdr_buf *subbuf, void *obj, unsigned int len)
1185{
1186 unsigned int this_len;
1187
1188 this_len = min_t(unsigned int, len, subbuf->head[0].iov_len);
1189 memcpy(subbuf->head[0].iov_base, obj, this_len);
Andreas Gruenbacherbd8100e2005-06-22 17:16:24 +00001190 len -= this_len;
1191 obj += this_len;
Trond Myklebust4e3e43a2006-10-17 13:47:24 -04001192 this_len = min_t(unsigned int, len, subbuf->page_len);
Andreas Gruenbacherbd8100e2005-06-22 17:16:24 +00001193 if (this_len)
Trond Myklebust4e3e43a2006-10-17 13:47:24 -04001194 _copy_to_pages(subbuf->pages, subbuf->page_base, obj, this_len);
Andreas Gruenbacherbd8100e2005-06-22 17:16:24 +00001195 len -= this_len;
1196 obj += this_len;
Trond Myklebust4e3e43a2006-10-17 13:47:24 -04001197 this_len = min_t(unsigned int, len, subbuf->tail[0].iov_len);
1198 memcpy(subbuf->tail[0].iov_base, obj, this_len);
1199}
1200
1201/* obj is assumed to point to allocated memory of size at least len: */
1202int write_bytes_to_xdr_buf(struct xdr_buf *buf, unsigned int base, void *obj, unsigned int len)
1203{
1204 struct xdr_buf subbuf;
1205 int status;
1206
1207 status = xdr_buf_subsegment(buf, &subbuf, base, len);
1208 if (status != 0)
1209 return status;
1210 __write_bytes_to_xdr_buf(&subbuf, obj, len);
1211 return 0;
Andreas Gruenbacherbd8100e2005-06-22 17:16:24 +00001212}
Kevin Coffmanc43abae2010-03-17 13:02:58 -04001213EXPORT_SYMBOL_GPL(write_bytes_to_xdr_buf);
Andreas Gruenbacherbd8100e2005-06-22 17:16:24 +00001214
1215int
Trond Myklebust1e789572006-08-31 15:09:19 -04001216xdr_decode_word(struct xdr_buf *buf, unsigned int base, u32 *obj)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001217{
Alexey Dobriyand8ed0292006-09-26 22:29:38 -07001218 __be32 raw;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219 int status;
1220
1221 status = read_bytes_from_xdr_buf(buf, base, &raw, sizeof(*obj));
1222 if (status)
1223 return status;
Benny Halevy98866b52009-08-14 17:18:49 +03001224 *obj = be32_to_cpu(raw);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225 return 0;
1226}
Trond Myklebust468039e2008-12-23 15:21:31 -05001227EXPORT_SYMBOL_GPL(xdr_decode_word);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228
Andreas Gruenbacherbd8100e2005-06-22 17:16:24 +00001229int
Trond Myklebust1e789572006-08-31 15:09:19 -04001230xdr_encode_word(struct xdr_buf *buf, unsigned int base, u32 obj)
Andreas Gruenbacherbd8100e2005-06-22 17:16:24 +00001231{
Benny Halevy9f162d22009-08-14 17:18:44 +03001232 __be32 raw = cpu_to_be32(obj);
Andreas Gruenbacherbd8100e2005-06-22 17:16:24 +00001233
1234 return write_bytes_to_xdr_buf(buf, base, &raw, sizeof(obj));
1235}
Trond Myklebust468039e2008-12-23 15:21:31 -05001236EXPORT_SYMBOL_GPL(xdr_encode_word);
Andreas Gruenbacherbd8100e2005-06-22 17:16:24 +00001237
Benjamin Coddingtonf925ab92019-09-16 07:59:38 -04001238/**
1239 * xdr_buf_read_mic() - obtain the address of the GSS mic from xdr buf
1240 * @buf: pointer to buffer containing a mic
1241 * @mic: on success, returns the address of the mic
1242 * @offset: the offset in buf where mic may be found
1243 *
1244 * This function may modify the xdr buf if the mic is found to be straddling
1245 * a boundary between head, pages, and tail. On success the mic can be read
1246 * from the address returned. There is no need to free the mic.
1247 *
1248 * Return: Success returns 0, otherwise an integer error.
Benjamin Coddington5f1bc392019-09-16 07:59:37 -04001249 */
Benjamin Coddingtonf925ab92019-09-16 07:59:38 -04001250int xdr_buf_read_mic(struct xdr_buf *buf, struct xdr_netobj *mic, unsigned int offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001251{
Trond Myklebustbee57c92006-10-09 22:08:22 -04001252 struct xdr_buf subbuf;
Benjamin Coddington5f1bc392019-09-16 07:59:37 -04001253 unsigned int boundary;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254
Benjamin Coddingtonf925ab92019-09-16 07:59:38 -04001255 if (xdr_decode_word(buf, offset, &mic->len))
Trond Myklebustbee57c92006-10-09 22:08:22 -04001256 return -EFAULT;
Benjamin Coddington5f1bc392019-09-16 07:59:37 -04001257 offset += 4;
1258
Benjamin Coddingtonf925ab92019-09-16 07:59:38 -04001259 /* Is the mic partially in the head? */
Benjamin Coddington5f1bc392019-09-16 07:59:37 -04001260 boundary = buf->head[0].iov_len;
Benjamin Coddingtonf925ab92019-09-16 07:59:38 -04001261 if (offset < boundary && (offset + mic->len) > boundary)
Benjamin Coddington5f1bc392019-09-16 07:59:37 -04001262 xdr_shift_buf(buf, boundary - offset);
1263
Benjamin Coddingtonf925ab92019-09-16 07:59:38 -04001264 /* Is the mic partially in the pages? */
Benjamin Coddington5f1bc392019-09-16 07:59:37 -04001265 boundary += buf->page_len;
Benjamin Coddingtonf925ab92019-09-16 07:59:38 -04001266 if (offset < boundary && (offset + mic->len) > boundary)
Benjamin Coddington5f1bc392019-09-16 07:59:37 -04001267 xdr_shrink_pagelen(buf, boundary - offset);
1268
Benjamin Coddingtonf925ab92019-09-16 07:59:38 -04001269 if (xdr_buf_subsegment(buf, &subbuf, offset, mic->len))
Trond Myklebustbee57c92006-10-09 22:08:22 -04001270 return -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271
Benjamin Coddingtonf925ab92019-09-16 07:59:38 -04001272 /* Is the mic contained entirely in the head? */
1273 mic->data = subbuf.head[0].iov_base;
1274 if (subbuf.head[0].iov_len == mic->len)
Trond Myklebustbee57c92006-10-09 22:08:22 -04001275 return 0;
Benjamin Coddingtonf925ab92019-09-16 07:59:38 -04001276 /* ..or is the mic contained entirely in the tail? */
1277 mic->data = subbuf.tail[0].iov_base;
1278 if (subbuf.tail[0].iov_len == mic->len)
Trond Myklebustbee57c92006-10-09 22:08:22 -04001279 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280
Benjamin Coddingtonf925ab92019-09-16 07:59:38 -04001281 /* Find a contiguous area in @buf to hold all of @mic */
1282 if (mic->len > buf->buflen - buf->len)
Trond Myklebustbee57c92006-10-09 22:08:22 -04001283 return -ENOMEM;
1284 if (buf->tail[0].iov_len != 0)
Benjamin Coddingtonf925ab92019-09-16 07:59:38 -04001285 mic->data = buf->tail[0].iov_base + buf->tail[0].iov_len;
Trond Myklebustbee57c92006-10-09 22:08:22 -04001286 else
Benjamin Coddingtonf925ab92019-09-16 07:59:38 -04001287 mic->data = buf->head[0].iov_base + buf->head[0].iov_len;
1288 __read_bytes_from_xdr_buf(&subbuf, mic->data, mic->len);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290}
Benjamin Coddingtonf925ab92019-09-16 07:59:38 -04001291EXPORT_SYMBOL_GPL(xdr_buf_read_mic);
Andreas Gruenbacherbd8100e2005-06-22 17:16:24 +00001292
1293/* Returns 0 on success, or else a negative error code. */
1294static int
1295xdr_xcode_array2(struct xdr_buf *buf, unsigned int base,
1296 struct xdr_array2_desc *desc, int encode)
1297{
1298 char *elem = NULL, *c;
1299 unsigned int copied = 0, todo, avail_here;
1300 struct page **ppages = NULL;
1301 int err;
1302
1303 if (encode) {
1304 if (xdr_encode_word(buf, base, desc->array_len) != 0)
1305 return -EINVAL;
1306 } else {
1307 if (xdr_decode_word(buf, base, &desc->array_len) != 0 ||
Trond Myklebust58fcb8d2005-08-10 18:15:12 -04001308 desc->array_len > desc->array_maxlen ||
Andreas Gruenbacherbd8100e2005-06-22 17:16:24 +00001309 (unsigned long) base + 4 + desc->array_len *
1310 desc->elem_size > buf->len)
1311 return -EINVAL;
1312 }
1313 base += 4;
1314
1315 if (!desc->xcode)
1316 return 0;
1317
1318 todo = desc->array_len * desc->elem_size;
1319
1320 /* process head */
1321 if (todo && base < buf->head->iov_len) {
1322 c = buf->head->iov_base + base;
1323 avail_here = min_t(unsigned int, todo,
1324 buf->head->iov_len - base);
1325 todo -= avail_here;
1326
1327 while (avail_here >= desc->elem_size) {
1328 err = desc->xcode(desc, c);
1329 if (err)
1330 goto out;
1331 c += desc->elem_size;
1332 avail_here -= desc->elem_size;
1333 }
1334 if (avail_here) {
1335 if (!elem) {
1336 elem = kmalloc(desc->elem_size, GFP_KERNEL);
1337 err = -ENOMEM;
1338 if (!elem)
1339 goto out;
1340 }
1341 if (encode) {
1342 err = desc->xcode(desc, elem);
1343 if (err)
1344 goto out;
1345 memcpy(c, elem, avail_here);
1346 } else
1347 memcpy(elem, c, avail_here);
1348 copied = avail_here;
1349 }
1350 base = buf->head->iov_len; /* align to start of pages */
1351 }
1352
1353 /* process pages array */
1354 base -= buf->head->iov_len;
1355 if (todo && base < buf->page_len) {
1356 unsigned int avail_page;
1357
1358 avail_here = min(todo, buf->page_len - base);
1359 todo -= avail_here;
1360
1361 base += buf->page_base;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001362 ppages = buf->pages + (base >> PAGE_SHIFT);
1363 base &= ~PAGE_MASK;
1364 avail_page = min_t(unsigned int, PAGE_SIZE - base,
Andreas Gruenbacherbd8100e2005-06-22 17:16:24 +00001365 avail_here);
1366 c = kmap(*ppages) + base;
1367
1368 while (avail_here) {
1369 avail_here -= avail_page;
1370 if (copied || avail_page < desc->elem_size) {
1371 unsigned int l = min(avail_page,
1372 desc->elem_size - copied);
1373 if (!elem) {
1374 elem = kmalloc(desc->elem_size,
1375 GFP_KERNEL);
1376 err = -ENOMEM;
1377 if (!elem)
1378 goto out;
1379 }
1380 if (encode) {
1381 if (!copied) {
1382 err = desc->xcode(desc, elem);
1383 if (err)
1384 goto out;
1385 }
1386 memcpy(c, elem + copied, l);
1387 copied += l;
1388 if (copied == desc->elem_size)
1389 copied = 0;
1390 } else {
1391 memcpy(elem + copied, c, l);
1392 copied += l;
1393 if (copied == desc->elem_size) {
1394 err = desc->xcode(desc, elem);
1395 if (err)
1396 goto out;
1397 copied = 0;
1398 }
1399 }
1400 avail_page -= l;
1401 c += l;
1402 }
1403 while (avail_page >= desc->elem_size) {
1404 err = desc->xcode(desc, c);
1405 if (err)
1406 goto out;
1407 c += desc->elem_size;
1408 avail_page -= desc->elem_size;
1409 }
1410 if (avail_page) {
1411 unsigned int l = min(avail_page,
1412 desc->elem_size - copied);
1413 if (!elem) {
1414 elem = kmalloc(desc->elem_size,
1415 GFP_KERNEL);
1416 err = -ENOMEM;
1417 if (!elem)
1418 goto out;
1419 }
1420 if (encode) {
1421 if (!copied) {
1422 err = desc->xcode(desc, elem);
1423 if (err)
1424 goto out;
1425 }
1426 memcpy(c, elem + copied, l);
1427 copied += l;
1428 if (copied == desc->elem_size)
1429 copied = 0;
1430 } else {
1431 memcpy(elem + copied, c, l);
1432 copied += l;
1433 if (copied == desc->elem_size) {
1434 err = desc->xcode(desc, elem);
1435 if (err)
1436 goto out;
1437 copied = 0;
1438 }
1439 }
1440 }
1441 if (avail_here) {
1442 kunmap(*ppages);
1443 ppages++;
1444 c = kmap(*ppages);
1445 }
1446
1447 avail_page = min(avail_here,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001448 (unsigned int) PAGE_SIZE);
Andreas Gruenbacherbd8100e2005-06-22 17:16:24 +00001449 }
1450 base = buf->page_len; /* align to start of tail */
1451 }
1452
1453 /* process tail */
1454 base -= buf->page_len;
1455 if (todo) {
1456 c = buf->tail->iov_base + base;
1457 if (copied) {
1458 unsigned int l = desc->elem_size - copied;
1459
1460 if (encode)
1461 memcpy(c, elem + copied, l);
1462 else {
1463 memcpy(elem + copied, c, l);
1464 err = desc->xcode(desc, elem);
1465 if (err)
1466 goto out;
1467 }
1468 todo -= l;
1469 c += l;
1470 }
1471 while (todo) {
1472 err = desc->xcode(desc, c);
1473 if (err)
1474 goto out;
1475 c += desc->elem_size;
1476 todo -= desc->elem_size;
1477 }
1478 }
1479 err = 0;
1480
1481out:
Jesper Juhla51482b2005-11-08 09:41:34 -08001482 kfree(elem);
Andreas Gruenbacherbd8100e2005-06-22 17:16:24 +00001483 if (ppages)
1484 kunmap(*ppages);
1485 return err;
1486}
1487
1488int
1489xdr_decode_array2(struct xdr_buf *buf, unsigned int base,
1490 struct xdr_array2_desc *desc)
1491{
1492 if (base >= buf->len)
1493 return -EINVAL;
1494
1495 return xdr_xcode_array2(buf, base, desc, 0);
1496}
Trond Myklebust468039e2008-12-23 15:21:31 -05001497EXPORT_SYMBOL_GPL(xdr_decode_array2);
Andreas Gruenbacherbd8100e2005-06-22 17:16:24 +00001498
1499int
1500xdr_encode_array2(struct xdr_buf *buf, unsigned int base,
1501 struct xdr_array2_desc *desc)
1502{
1503 if ((unsigned long) base + 4 + desc->array_len * desc->elem_size >
1504 buf->head->iov_len + buf->page_len + buf->tail->iov_len)
1505 return -EINVAL;
1506
1507 return xdr_xcode_array2(buf, base, desc, 1);
1508}
Trond Myklebust468039e2008-12-23 15:21:31 -05001509EXPORT_SYMBOL_GPL(xdr_encode_array2);
Olga Kornievskaia37a4e6c2006-12-04 20:22:33 -05001510
1511int
1512xdr_process_buf(struct xdr_buf *buf, unsigned int offset, unsigned int len,
YOSHIFUJI Hideakicca51722007-02-09 15:38:13 -08001513 int (*actor)(struct scatterlist *, void *), void *data)
Olga Kornievskaia37a4e6c2006-12-04 20:22:33 -05001514{
1515 int i, ret = 0;
Eric Dumazet95c96172012-04-15 05:58:06 +00001516 unsigned int page_len, thislen, page_offset;
Olga Kornievskaia37a4e6c2006-12-04 20:22:33 -05001517 struct scatterlist sg[1];
1518
Herbert Xu68e3f5d2007-10-27 00:52:07 -07001519 sg_init_table(sg, 1);
1520
Olga Kornievskaia37a4e6c2006-12-04 20:22:33 -05001521 if (offset >= buf->head[0].iov_len) {
1522 offset -= buf->head[0].iov_len;
1523 } else {
1524 thislen = buf->head[0].iov_len - offset;
1525 if (thislen > len)
1526 thislen = len;
1527 sg_set_buf(sg, buf->head[0].iov_base + offset, thislen);
1528 ret = actor(sg, data);
1529 if (ret)
1530 goto out;
1531 offset = 0;
1532 len -= thislen;
1533 }
1534 if (len == 0)
1535 goto out;
1536
1537 if (offset >= buf->page_len) {
1538 offset -= buf->page_len;
1539 } else {
1540 page_len = buf->page_len - offset;
1541 if (page_len > len)
1542 page_len = len;
1543 len -= page_len;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001544 page_offset = (offset + buf->page_base) & (PAGE_SIZE - 1);
1545 i = (offset + buf->page_base) >> PAGE_SHIFT;
1546 thislen = PAGE_SIZE - page_offset;
Olga Kornievskaia37a4e6c2006-12-04 20:22:33 -05001547 do {
1548 if (thislen > page_len)
1549 thislen = page_len;
Jens Axboe642f149032007-10-24 11:20:47 +02001550 sg_set_page(sg, buf->pages[i], thislen, page_offset);
Olga Kornievskaia37a4e6c2006-12-04 20:22:33 -05001551 ret = actor(sg, data);
1552 if (ret)
1553 goto out;
1554 page_len -= thislen;
1555 i++;
1556 page_offset = 0;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001557 thislen = PAGE_SIZE;
Olga Kornievskaia37a4e6c2006-12-04 20:22:33 -05001558 } while (page_len != 0);
1559 offset = 0;
1560 }
1561 if (len == 0)
1562 goto out;
1563 if (offset < buf->tail[0].iov_len) {
1564 thislen = buf->tail[0].iov_len - offset;
1565 if (thislen > len)
1566 thislen = len;
1567 sg_set_buf(sg, buf->tail[0].iov_base + offset, thislen);
1568 ret = actor(sg, data);
1569 len -= thislen;
1570 }
1571 if (len != 0)
1572 ret = -EINVAL;
1573out:
1574 return ret;
1575}
Trond Myklebust468039e2008-12-23 15:21:31 -05001576EXPORT_SYMBOL_GPL(xdr_process_buf);
Olga Kornievskaia37a4e6c2006-12-04 20:22:33 -05001577
Trond Myklebust5c741d42017-02-19 16:08:31 -05001578/**
Trond Myklebust0e779aa2018-03-20 17:03:05 -04001579 * xdr_stream_decode_opaque - Decode variable length opaque
1580 * @xdr: pointer to xdr_stream
1581 * @ptr: location to store opaque data
1582 * @size: size of storage buffer @ptr
1583 *
1584 * Return values:
1585 * On success, returns size of object stored in *@ptr
1586 * %-EBADMSG on XDR buffer overflow
1587 * %-EMSGSIZE on overflow of storage buffer @ptr
1588 */
1589ssize_t xdr_stream_decode_opaque(struct xdr_stream *xdr, void *ptr, size_t size)
1590{
1591 ssize_t ret;
1592 void *p;
1593
1594 ret = xdr_stream_decode_opaque_inline(xdr, &p, size);
1595 if (ret <= 0)
1596 return ret;
1597 memcpy(ptr, p, ret);
1598 return ret;
1599}
1600EXPORT_SYMBOL_GPL(xdr_stream_decode_opaque);
1601
1602/**
1603 * xdr_stream_decode_opaque_dup - Decode and duplicate variable length opaque
1604 * @xdr: pointer to xdr_stream
1605 * @ptr: location to store pointer to opaque data
1606 * @maxlen: maximum acceptable object size
1607 * @gfp_flags: GFP mask to use
1608 *
1609 * Return values:
1610 * On success, returns size of object stored in *@ptr
1611 * %-EBADMSG on XDR buffer overflow
1612 * %-EMSGSIZE if the size of the object would exceed @maxlen
1613 * %-ENOMEM on memory allocation failure
1614 */
1615ssize_t xdr_stream_decode_opaque_dup(struct xdr_stream *xdr, void **ptr,
1616 size_t maxlen, gfp_t gfp_flags)
1617{
1618 ssize_t ret;
1619 void *p;
1620
1621 ret = xdr_stream_decode_opaque_inline(xdr, &p, maxlen);
1622 if (ret > 0) {
1623 *ptr = kmemdup(p, ret, gfp_flags);
1624 if (*ptr != NULL)
1625 return ret;
1626 ret = -ENOMEM;
1627 }
1628 *ptr = NULL;
1629 return ret;
1630}
1631EXPORT_SYMBOL_GPL(xdr_stream_decode_opaque_dup);
1632
1633/**
1634 * xdr_stream_decode_string - Decode variable length string
1635 * @xdr: pointer to xdr_stream
1636 * @str: location to store string
1637 * @size: size of storage buffer @str
1638 *
1639 * Return values:
1640 * On success, returns length of NUL-terminated string stored in *@str
1641 * %-EBADMSG on XDR buffer overflow
1642 * %-EMSGSIZE on overflow of storage buffer @str
1643 */
1644ssize_t xdr_stream_decode_string(struct xdr_stream *xdr, char *str, size_t size)
1645{
1646 ssize_t ret;
1647 void *p;
1648
1649 ret = xdr_stream_decode_opaque_inline(xdr, &p, size);
1650 if (ret > 0) {
1651 memcpy(str, p, ret);
1652 str[ret] = '\0';
1653 return strlen(str);
1654 }
1655 *str = '\0';
1656 return ret;
1657}
1658EXPORT_SYMBOL_GPL(xdr_stream_decode_string);
1659
1660/**
Trond Myklebust5c741d42017-02-19 16:08:31 -05001661 * xdr_stream_decode_string_dup - Decode and duplicate variable length string
1662 * @xdr: pointer to xdr_stream
1663 * @str: location to store pointer to string
1664 * @maxlen: maximum acceptable string length
1665 * @gfp_flags: GFP mask to use
1666 *
1667 * Return values:
1668 * On success, returns length of NUL-terminated string stored in *@ptr
1669 * %-EBADMSG on XDR buffer overflow
1670 * %-EMSGSIZE if the size of the string would exceed @maxlen
1671 * %-ENOMEM on memory allocation failure
1672 */
1673ssize_t xdr_stream_decode_string_dup(struct xdr_stream *xdr, char **str,
1674 size_t maxlen, gfp_t gfp_flags)
1675{
1676 void *p;
1677 ssize_t ret;
1678
1679 ret = xdr_stream_decode_opaque_inline(xdr, &p, maxlen);
1680 if (ret > 0) {
1681 char *s = kmalloc(ret + 1, gfp_flags);
1682 if (s != NULL) {
1683 memcpy(s, p, ret);
1684 s[ret] = '\0';
1685 *str = s;
1686 return strlen(s);
1687 }
1688 ret = -ENOMEM;
1689 }
1690 *str = NULL;
1691 return ret;
1692}
1693EXPORT_SYMBOL_GPL(xdr_stream_decode_string_dup);