]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - include/linux/uio.h
UBUNTU: SAUCE: LSM stacking: procfs: add smack subdir to attrs
[mirror_ubuntu-artful-kernel.git] / include / linux / uio.h
CommitLineData
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>
aa28de27 13#include <linux/thread_info.h>
607ca46e 14#include <uapi/linux/uio.h>
1da177e4 15
92236878 16struct page;
241699cd 17struct pipe_inode_info;
812ed032
JS
18
19struct kvec {
20 void *iov_base; /* and that should *never* hold a userland pointer */
21 size_t iov_len;
22};
23
62a8067a
AV
24enum {
25 ITER_IOVEC = 0,
26 ITER_KVEC = 2,
27 ITER_BVEC = 4,
241699cd 28 ITER_PIPE = 8,
62a8067a
AV
29};
30
92236878 31struct iov_iter {
71d8e532 32 int type;
92236878
KO
33 size_t iov_offset;
34 size_t count;
62a8067a
AV
35 union {
36 const struct iovec *iov;
a280455f 37 const struct kvec *kvec;
62a8067a 38 const struct bio_vec *bvec;
241699cd
AV
39 struct pipe_inode_info *pipe;
40 };
41 union {
42 unsigned long nr_segs;
27c0e374
AV
43 struct {
44 int idx;
45 int start_idx;
46 };
62a8067a 47 };
92236878
KO
48};
49
1da177e4
LT
50/*
51 * Total number of bytes covered by an iovec.
52 *
53 * NOTE that it is not safe to use this function until all the iovec's
54 * segment lengths have been validated. Because the individual lengths can
55 * overflow a size_t when added together.
56 */
57static inline size_t iov_length(const struct iovec *iov, unsigned long nr_segs)
58{
59 unsigned long seg;
60 size_t ret = 0;
61
62 for (seg = 0; seg < nr_segs; seg++)
63 ret += iov[seg].iov_len;
64 return ret;
65}
66
92236878
KO
67static inline struct iovec iov_iter_iovec(const struct iov_iter *iter)
68{
69 return (struct iovec) {
70 .iov_base = iter->iov->iov_base + iter->iov_offset,
71 .iov_len = min(iter->count,
72 iter->iov->iov_len - iter->iov_offset),
73 };
74}
75
76#define iov_for_each(iov, iter, start) \
241699cd 77 if (!((start).type & (ITER_BVEC | ITER_PIPE))) \
92236878
KO
78 for (iter = (start); \
79 (iter).count && \
80 ((iov = iov_iter_iovec(&(iter))), 1); \
81 iov_iter_advance(&(iter), (iov).iov_len))
82
1da177e4 83unsigned long iov_shorten(struct iovec *iov, unsigned long nr_segs, size_t to);
d2f83e90 84
92236878
KO
85size_t iov_iter_copy_from_user_atomic(struct page *page,
86 struct iov_iter *i, unsigned long offset, size_t bytes);
92236878 87void iov_iter_advance(struct iov_iter *i, size_t bytes);
27c0e374 88void iov_iter_revert(struct iov_iter *i, size_t bytes);
92236878
KO
89int iov_iter_fault_in_readable(struct iov_iter *i, size_t bytes);
90size_t iov_iter_single_seg_count(const struct iov_iter *i);
6e58e79d
AV
91size_t copy_page_to_iter(struct page *page, size_t offset, size_t bytes,
92 struct iov_iter *i);
f0d1bec9
AV
93size_t copy_page_from_iter(struct page *page, size_t offset, size_t bytes,
94 struct iov_iter *i);
aa28de27
AV
95
96size_t _copy_to_iter(const void *addr, size_t bytes, struct iov_iter *i);
97size_t _copy_from_iter(void *addr, size_t bytes, struct iov_iter *i);
98bool _copy_from_iter_full(void *addr, size_t bytes, struct iov_iter *i);
99size_t _copy_from_iter_nocache(void *addr, size_t bytes, struct iov_iter *i);
100bool _copy_from_iter_full_nocache(void *addr, size_t bytes, struct iov_iter *i);
101
102static __always_inline __must_check
103size_t copy_to_iter(const void *addr, size_t bytes, struct iov_iter *i)
104{
105 if (unlikely(!check_copy_size(addr, bytes, true)))
c43aeb19 106 return 0;
aa28de27
AV
107 else
108 return _copy_to_iter(addr, bytes, i);
109}
110
111static __always_inline __must_check
112size_t copy_from_iter(void *addr, size_t bytes, struct iov_iter *i)
113{
114 if (unlikely(!check_copy_size(addr, bytes, false)))
c43aeb19 115 return 0;
aa28de27
AV
116 else
117 return _copy_from_iter(addr, bytes, i);
118}
119
120static __always_inline __must_check
121bool copy_from_iter_full(void *addr, size_t bytes, struct iov_iter *i)
122{
123 if (unlikely(!check_copy_size(addr, bytes, false)))
124 return false;
125 else
126 return _copy_from_iter_full(addr, bytes, i);
127}
128
129static __always_inline __must_check
130size_t copy_from_iter_nocache(void *addr, size_t bytes, struct iov_iter *i)
131{
132 if (unlikely(!check_copy_size(addr, bytes, false)))
c43aeb19 133 return 0;
aa28de27
AV
134 else
135 return _copy_from_iter_nocache(addr, bytes, i);
136}
137
138static __always_inline __must_check
139bool copy_from_iter_full_nocache(void *addr, size_t bytes, struct iov_iter *i)
140{
141 if (unlikely(!check_copy_size(addr, bytes, false)))
142 return false;
143 else
144 return _copy_from_iter_full_nocache(addr, bytes, i);
145}
146
0aed55af
DW
147#ifdef CONFIG_ARCH_HAS_UACCESS_FLUSHCACHE
148/*
149 * Note, users like pmem that depend on the stricter semantics of
150 * copy_from_iter_flushcache() than copy_from_iter_nocache() must check for
151 * IS_ENABLED(CONFIG_ARCH_HAS_UACCESS_FLUSHCACHE) before assuming that the
152 * destination is flushed from the cache on return.
153 */
6a37e940 154size_t _copy_from_iter_flushcache(void *addr, size_t bytes, struct iov_iter *i);
0aed55af 155#else
6a37e940
LT
156#define _copy_from_iter_flushcache _copy_from_iter_nocache
157#endif
158
159static __always_inline __must_check
160size_t copy_from_iter_flushcache(void *addr, size_t bytes, struct iov_iter *i)
0aed55af 161{
6a37e940 162 if (unlikely(!check_copy_size(addr, bytes, false)))
c43aeb19 163 return 0;
6a37e940
LT
164 else
165 return _copy_from_iter_flushcache(addr, bytes, i);
0aed55af 166}
6a37e940 167
c35e0248 168size_t iov_iter_zero(size_t bytes, struct iov_iter *);
886a3911 169unsigned long iov_iter_alignment(const struct iov_iter *i);
357f435d 170unsigned long iov_iter_gap_alignment(const struct iov_iter *i);
71d8e532
AV
171void iov_iter_init(struct iov_iter *i, int direction, const struct iovec *iov,
172 unsigned long nr_segs, size_t count);
05afcb77
AV
173void iov_iter_kvec(struct iov_iter *i, int direction, const struct kvec *kvec,
174 unsigned long nr_segs, size_t count);
175void iov_iter_bvec(struct iov_iter *i, int direction, const struct bio_vec *bvec,
abb78f87 176 unsigned long nr_segs, size_t count);
241699cd
AV
177void iov_iter_pipe(struct iov_iter *i, int direction, struct pipe_inode_info *pipe,
178 size_t count);
7b2c99d1 179ssize_t iov_iter_get_pages(struct iov_iter *i, struct page **pages,
2c80929c 180 size_t maxsize, unsigned maxpages, size_t *start);
91f79c43
AV
181ssize_t iov_iter_get_pages_alloc(struct iov_iter *i, struct page ***pages,
182 size_t maxsize, size_t *start);
f67da30c 183int iov_iter_npages(const struct iov_iter *i, int maxpages);
92236878 184
4b8164b9
AV
185const void *dup_iter(struct iov_iter *new, struct iov_iter *old, gfp_t flags);
186
b57332b4 187static inline size_t iov_iter_count(const struct iov_iter *i)
92236878
KO
188{
189 return i->count;
190}
191
b57332b4 192static inline bool iter_is_iovec(const struct iov_iter *i)
777eda2c 193{
241699cd 194 return !(i->type & (ITER_BVEC | ITER_KVEC | ITER_PIPE));
777eda2c
AV
195}
196
bd8e0ff9
OS
197/*
198 * Get one of READ or WRITE out of iter->type without any other flags OR'd in
199 * with it.
200 *
201 * The ?: is just for type safety.
202 */
d3849953 203#define iov_iter_rw(i) ((0 ? (struct iov_iter *)0 : (i))->type & (READ | WRITE))
bd8e0ff9 204
0b86dbf6
AV
205/*
206 * Cap the iov_iter by given limit; note that the second argument is
207 * *not* the new size - it's upper limit for such. Passing it a value
208 * greater than the amount of data in iov_iter is fine - it'll just do
209 * nothing in that case.
210 */
211static inline void iov_iter_truncate(struct iov_iter *i, u64 count)
0c949334 212{
0b86dbf6
AV
213 /*
214 * count doesn't have to fit in size_t - comparison extends both
215 * operands to u64 here and any value that would be truncated by
216 * conversion in assignement is by definition greater than all
217 * values of size_t, including old i->count.
218 */
0c949334
AV
219 if (i->count > count)
220 i->count = count;
221}
222
b42b15fd
AV
223/*
224 * reexpand a previously truncated iterator; count must be no more than how much
225 * we had shrunk it.
226 */
227static inline void iov_iter_reexpand(struct iov_iter *i, size_t count)
228{
229 i->count = count;
230}
36f7a8a4 231size_t csum_and_copy_to_iter(const void *addr, size_t bytes, __wsum *csum, struct iov_iter *i);
a604ec7e 232size_t csum_and_copy_from_iter(void *addr, size_t bytes, __wsum *csum, struct iov_iter *i);
cbbd26b8 233bool csum_and_copy_from_iter_full(void *addr, size_t bytes, __wsum *csum, struct iov_iter *i);
b42b15fd 234
bc917be8
AV
235int import_iovec(int type, const struct iovec __user * uvector,
236 unsigned nr_segs, unsigned fast_segs,
237 struct iovec **iov, struct iov_iter *i);
238
239#ifdef CONFIG_COMPAT
240struct compat_iovec;
241int compat_import_iovec(int type, const struct compat_iovec __user * uvector,
242 unsigned nr_segs, unsigned fast_segs,
243 struct iovec **iov, struct iov_iter *i);
244#endif
245
246int import_single_range(int type, void __user *buf, size_t len,
247 struct iovec *iov, struct iov_iter *i);
248
812ed032 249#endif