Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * Berkeley style UIO structures - Alan Cox 1994. | |
3 | * | |
4 | * This program is free software; you can redistribute it and/or | |
5 | * modify it under the terms of the GNU General Public License | |
6 | * as published by the Free Software Foundation; either version | |
7 | * 2 of the License, or (at your option) any later version. | |
8 | */ | |
607ca46e DH |
9 | #ifndef __LINUX_UIO_H |
10 | #define __LINUX_UIO_H | |
1da177e4 | 11 | |
92236878 | 12 | #include <linux/kernel.h> |
607ca46e | 13 | #include <uapi/linux/uio.h> |
1da177e4 | 14 | |
92236878 | 15 | struct page; |
812ed032 JS |
16 | |
17 | struct kvec { | |
18 | void *iov_base; /* and that should *never* hold a userland pointer */ | |
19 | size_t iov_len; | |
20 | }; | |
21 | ||
62a8067a AV |
22 | enum { |
23 | ITER_IOVEC = 0, | |
24 | ITER_KVEC = 2, | |
25 | ITER_BVEC = 4, | |
26 | }; | |
27 | ||
92236878 | 28 | struct iov_iter { |
71d8e532 | 29 | int type; |
92236878 KO |
30 | size_t iov_offset; |
31 | size_t count; | |
62a8067a AV |
32 | union { |
33 | const struct iovec *iov; | |
34 | const struct bio_vec *bvec; | |
35 | }; | |
36 | unsigned long nr_segs; | |
92236878 KO |
37 | }; |
38 | ||
1da177e4 LT |
39 | /* |
40 | * Total number of bytes covered by an iovec. | |
41 | * | |
42 | * NOTE that it is not safe to use this function until all the iovec's | |
43 | * segment lengths have been validated. Because the individual lengths can | |
44 | * overflow a size_t when added together. | |
45 | */ | |
46 | static inline size_t iov_length(const struct iovec *iov, unsigned long nr_segs) | |
47 | { | |
48 | unsigned long seg; | |
49 | size_t ret = 0; | |
50 | ||
51 | for (seg = 0; seg < nr_segs; seg++) | |
52 | ret += iov[seg].iov_len; | |
53 | return ret; | |
54 | } | |
55 | ||
92236878 KO |
56 | static inline struct iovec iov_iter_iovec(const struct iov_iter *iter) |
57 | { | |
58 | return (struct iovec) { | |
59 | .iov_base = iter->iov->iov_base + iter->iov_offset, | |
60 | .iov_len = min(iter->count, | |
61 | iter->iov->iov_len - iter->iov_offset), | |
62 | }; | |
63 | } | |
64 | ||
65 | #define iov_for_each(iov, iter, start) \ | |
62a8067a | 66 | if (!((start).type & ITER_BVEC)) \ |
92236878 KO |
67 | for (iter = (start); \ |
68 | (iter).count && \ | |
69 | ((iov = iov_iter_iovec(&(iter))), 1); \ | |
70 | iov_iter_advance(&(iter), (iov).iov_len)) | |
71 | ||
1da177e4 | 72 | unsigned long iov_shorten(struct iovec *iov, unsigned long nr_segs, size_t to); |
d2f83e90 | 73 | |
92236878 KO |
74 | size_t iov_iter_copy_from_user_atomic(struct page *page, |
75 | struct iov_iter *i, unsigned long offset, size_t bytes); | |
92236878 KO |
76 | void iov_iter_advance(struct iov_iter *i, size_t bytes); |
77 | int iov_iter_fault_in_readable(struct iov_iter *i, size_t bytes); | |
78 | size_t iov_iter_single_seg_count(const struct iov_iter *i); | |
6e58e79d AV |
79 | size_t copy_page_to_iter(struct page *page, size_t offset, size_t bytes, |
80 | struct iov_iter *i); | |
f0d1bec9 AV |
81 | size_t copy_page_from_iter(struct page *page, size_t offset, size_t bytes, |
82 | struct iov_iter *i); | |
c35e0248 MW |
83 | size_t copy_to_iter(void *addr, size_t bytes, struct iov_iter *i); |
84 | size_t copy_from_iter(void *addr, size_t bytes, struct iov_iter *i); | |
85 | size_t iov_iter_zero(size_t bytes, struct iov_iter *); | |
886a3911 | 86 | unsigned long iov_iter_alignment(const struct iov_iter *i); |
71d8e532 AV |
87 | void iov_iter_init(struct iov_iter *i, int direction, const struct iovec *iov, |
88 | unsigned long nr_segs, size_t count); | |
7b2c99d1 | 89 | ssize_t iov_iter_get_pages(struct iov_iter *i, struct page **pages, |
2c80929c | 90 | size_t maxsize, unsigned maxpages, size_t *start); |
91f79c43 AV |
91 | ssize_t iov_iter_get_pages_alloc(struct iov_iter *i, struct page ***pages, |
92 | size_t maxsize, size_t *start); | |
f67da30c | 93 | int iov_iter_npages(const struct iov_iter *i, int maxpages); |
92236878 KO |
94 | |
95 | static inline size_t iov_iter_count(struct iov_iter *i) | |
96 | { | |
97 | return i->count; | |
98 | } | |
99 | ||
0b86dbf6 AV |
100 | /* |
101 | * Cap the iov_iter by given limit; note that the second argument is | |
102 | * *not* the new size - it's upper limit for such. Passing it a value | |
103 | * greater than the amount of data in iov_iter is fine - it'll just do | |
104 | * nothing in that case. | |
105 | */ | |
106 | static inline void iov_iter_truncate(struct iov_iter *i, u64 count) | |
0c949334 | 107 | { |
0b86dbf6 AV |
108 | /* |
109 | * count doesn't have to fit in size_t - comparison extends both | |
110 | * operands to u64 here and any value that would be truncated by | |
111 | * conversion in assignement is by definition greater than all | |
112 | * values of size_t, including old i->count. | |
113 | */ | |
0c949334 AV |
114 | if (i->count > count) |
115 | i->count = count; | |
116 | } | |
117 | ||
b42b15fd AV |
118 | /* |
119 | * reexpand a previously truncated iterator; count must be no more than how much | |
120 | * we had shrunk it. | |
121 | */ | |
122 | static inline void iov_iter_reexpand(struct iov_iter *i, size_t count) | |
123 | { | |
124 | i->count = count; | |
125 | } | |
126 | ||
d2f83e90 RR |
127 | int memcpy_fromiovec(unsigned char *kdata, struct iovec *iov, int len); |
128 | int memcpy_toiovec(struct iovec *iov, unsigned char *kdata, int len); | |
ac5ccdba MT |
129 | int memcpy_fromiovecend(unsigned char *kdata, const struct iovec *iov, |
130 | int offset, int len); | |
131 | int memcpy_toiovecend(const struct iovec *v, unsigned char *kdata, | |
132 | int offset, int len); | |
886a3911 | 133 | |
812ed032 | 134 | #endif |