1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * Berkeley style UIO structures - Alan Cox 1994.
8 #include <linux/kernel.h>
9 #include <linux/thread_info.h>
10 #include <uapi/linux/uio.h>
13 struct pipe_inode_info
;
16 void *iov_base
; /* and that should *never* hold a userland pointer */
31 * Bit 0 is the read/write bit, set if we're writing.
32 * Bit 1 is the BVEC_FLAG_NO_REF bit, set if type is a bvec and
33 * the caller isn't expecting to drop a page reference when done.
39 const struct iovec
*iov
;
40 const struct kvec
*kvec
;
41 const struct bio_vec
*bvec
;
42 struct pipe_inode_info
*pipe
;
45 unsigned long nr_segs
;
48 unsigned int start_head
;
53 static inline enum iter_type
iov_iter_type(const struct iov_iter
*i
)
55 return i
->type
& ~(READ
| WRITE
);
58 static inline bool iter_is_iovec(const struct iov_iter
*i
)
60 return iov_iter_type(i
) == ITER_IOVEC
;
63 static inline bool iov_iter_is_kvec(const struct iov_iter
*i
)
65 return iov_iter_type(i
) == ITER_KVEC
;
68 static inline bool iov_iter_is_bvec(const struct iov_iter
*i
)
70 return iov_iter_type(i
) == ITER_BVEC
;
73 static inline bool iov_iter_is_pipe(const struct iov_iter
*i
)
75 return iov_iter_type(i
) == ITER_PIPE
;
78 static inline bool iov_iter_is_discard(const struct iov_iter
*i
)
80 return iov_iter_type(i
) == ITER_DISCARD
;
83 static inline unsigned char iov_iter_rw(const struct iov_iter
*i
)
85 return i
->type
& (READ
| WRITE
);
89 * Total number of bytes covered by an iovec.
91 * NOTE that it is not safe to use this function until all the iovec's
92 * segment lengths have been validated. Because the individual lengths can
93 * overflow a size_t when added together.
95 static inline size_t iov_length(const struct iovec
*iov
, unsigned long nr_segs
)
100 for (seg
= 0; seg
< nr_segs
; seg
++)
101 ret
+= iov
[seg
].iov_len
;
105 static inline struct iovec
iov_iter_iovec(const struct iov_iter
*iter
)
107 return (struct iovec
) {
108 .iov_base
= iter
->iov
->iov_base
+ iter
->iov_offset
,
109 .iov_len
= min(iter
->count
,
110 iter
->iov
->iov_len
- iter
->iov_offset
),
114 size_t iov_iter_copy_from_user_atomic(struct page
*page
,
115 struct iov_iter
*i
, unsigned long offset
, size_t bytes
);
116 void iov_iter_advance(struct iov_iter
*i
, size_t bytes
);
117 void iov_iter_revert(struct iov_iter
*i
, size_t bytes
);
118 int iov_iter_fault_in_readable(struct iov_iter
*i
, size_t bytes
);
119 size_t iov_iter_single_seg_count(const struct iov_iter
*i
);
120 size_t copy_page_to_iter(struct page
*page
, size_t offset
, size_t bytes
,
122 size_t copy_page_from_iter(struct page
*page
, size_t offset
, size_t bytes
,
125 size_t _copy_to_iter(const void *addr
, size_t bytes
, struct iov_iter
*i
);
126 size_t _copy_from_iter(void *addr
, size_t bytes
, struct iov_iter
*i
);
127 bool _copy_from_iter_full(void *addr
, size_t bytes
, struct iov_iter
*i
);
128 size_t _copy_from_iter_nocache(void *addr
, size_t bytes
, struct iov_iter
*i
);
129 bool _copy_from_iter_full_nocache(void *addr
, size_t bytes
, struct iov_iter
*i
);
131 static __always_inline __must_check
132 size_t copy_to_iter(const void *addr
, size_t bytes
, struct iov_iter
*i
)
134 if (unlikely(!check_copy_size(addr
, bytes
, true)))
137 return _copy_to_iter(addr
, bytes
, i
);
140 static __always_inline __must_check
141 size_t copy_from_iter(void *addr
, size_t bytes
, struct iov_iter
*i
)
143 if (unlikely(!check_copy_size(addr
, bytes
, false)))
146 return _copy_from_iter(addr
, bytes
, i
);
149 static __always_inline __must_check
150 bool copy_from_iter_full(void *addr
, size_t bytes
, struct iov_iter
*i
)
152 if (unlikely(!check_copy_size(addr
, bytes
, false)))
155 return _copy_from_iter_full(addr
, bytes
, i
);
158 static __always_inline __must_check
159 size_t copy_from_iter_nocache(void *addr
, size_t bytes
, struct iov_iter
*i
)
161 if (unlikely(!check_copy_size(addr
, bytes
, false)))
164 return _copy_from_iter_nocache(addr
, bytes
, i
);
167 static __always_inline __must_check
168 bool copy_from_iter_full_nocache(void *addr
, size_t bytes
, struct iov_iter
*i
)
170 if (unlikely(!check_copy_size(addr
, bytes
, false)))
173 return _copy_from_iter_full_nocache(addr
, bytes
, i
);
176 #ifdef CONFIG_ARCH_HAS_UACCESS_FLUSHCACHE
178 * Note, users like pmem that depend on the stricter semantics of
179 * copy_from_iter_flushcache() than copy_from_iter_nocache() must check for
180 * IS_ENABLED(CONFIG_ARCH_HAS_UACCESS_FLUSHCACHE) before assuming that the
181 * destination is flushed from the cache on return.
183 size_t _copy_from_iter_flushcache(void *addr
, size_t bytes
, struct iov_iter
*i
);
185 #define _copy_from_iter_flushcache _copy_from_iter_nocache
188 #ifdef CONFIG_ARCH_HAS_COPY_MC
189 size_t _copy_mc_to_iter(const void *addr
, size_t bytes
, struct iov_iter
*i
);
191 #define _copy_mc_to_iter _copy_to_iter
194 static __always_inline __must_check
195 size_t copy_from_iter_flushcache(void *addr
, size_t bytes
, struct iov_iter
*i
)
197 if (unlikely(!check_copy_size(addr
, bytes
, false)))
200 return _copy_from_iter_flushcache(addr
, bytes
, i
);
203 static __always_inline __must_check
204 size_t copy_mc_to_iter(void *addr
, size_t bytes
, struct iov_iter
*i
)
206 if (unlikely(!check_copy_size(addr
, bytes
, true)))
209 return _copy_mc_to_iter(addr
, bytes
, i
);
212 size_t iov_iter_zero(size_t bytes
, struct iov_iter
*);
213 unsigned long iov_iter_alignment(const struct iov_iter
*i
);
214 unsigned long iov_iter_gap_alignment(const struct iov_iter
*i
);
215 void iov_iter_init(struct iov_iter
*i
, unsigned int direction
, const struct iovec
*iov
,
216 unsigned long nr_segs
, size_t count
);
217 void iov_iter_kvec(struct iov_iter
*i
, unsigned int direction
, const struct kvec
*kvec
,
218 unsigned long nr_segs
, size_t count
);
219 void iov_iter_bvec(struct iov_iter
*i
, unsigned int direction
, const struct bio_vec
*bvec
,
220 unsigned long nr_segs
, size_t count
);
221 void iov_iter_pipe(struct iov_iter
*i
, unsigned int direction
, struct pipe_inode_info
*pipe
,
223 void iov_iter_discard(struct iov_iter
*i
, unsigned int direction
, size_t count
);
224 ssize_t
iov_iter_get_pages(struct iov_iter
*i
, struct page
**pages
,
225 size_t maxsize
, unsigned maxpages
, size_t *start
);
226 ssize_t
iov_iter_get_pages_alloc(struct iov_iter
*i
, struct page
***pages
,
227 size_t maxsize
, size_t *start
);
228 int iov_iter_npages(const struct iov_iter
*i
, int maxpages
);
230 const void *dup_iter(struct iov_iter
*new, struct iov_iter
*old
, gfp_t flags
);
232 static inline size_t iov_iter_count(const struct iov_iter
*i
)
238 * Cap the iov_iter by given limit; note that the second argument is
239 * *not* the new size - it's upper limit for such. Passing it a value
240 * greater than the amount of data in iov_iter is fine - it'll just do
241 * nothing in that case.
243 static inline void iov_iter_truncate(struct iov_iter
*i
, u64 count
)
246 * count doesn't have to fit in size_t - comparison extends both
247 * operands to u64 here and any value that would be truncated by
248 * conversion in assignement is by definition greater than all
249 * values of size_t, including old i->count.
251 if (i
->count
> count
)
256 * reexpand a previously truncated iterator; count must be no more than how much
259 static inline void iov_iter_reexpand(struct iov_iter
*i
, size_t count
)
263 size_t csum_and_copy_to_iter(const void *addr
, size_t bytes
, void *csump
, struct iov_iter
*i
);
264 size_t csum_and_copy_from_iter(void *addr
, size_t bytes
, __wsum
*csum
, struct iov_iter
*i
);
265 bool csum_and_copy_from_iter_full(void *addr
, size_t bytes
, __wsum
*csum
, struct iov_iter
*i
);
266 size_t hash_and_copy_to_iter(const void *addr
, size_t bytes
, void *hashp
,
269 struct iovec
*iovec_from_user(const struct iovec __user
*uvector
,
270 unsigned long nr_segs
, unsigned long fast_segs
,
271 struct iovec
*fast_iov
, bool compat
);
272 ssize_t
import_iovec(int type
, const struct iovec __user
*uvec
,
273 unsigned nr_segs
, unsigned fast_segs
, struct iovec
**iovp
,
275 ssize_t
__import_iovec(int type
, const struct iovec __user
*uvec
,
276 unsigned nr_segs
, unsigned fast_segs
, struct iovec
**iovp
,
277 struct iov_iter
*i
, bool compat
);
278 int import_single_range(int type
, void __user
*buf
, size_t len
,
279 struct iovec
*iov
, struct iov_iter
*i
);
281 int iov_iter_for_each_range(struct iov_iter
*i
, size_t bytes
,
282 int (*f
)(struct kvec
*vec
, void *context
),