include/linux/uio.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 /*
   3  *      Berkeley style UIO structures   -       Alan Cox 1994.
   4  */
   5 #ifndef __LINUX_UIO_H
   6 #define __LINUX_UIO_H
   7
   8 #include <linux/kernel.h>
   9 #include <linux/thread_info.h>
  10 #include <uapi/linux/uio.h>
  11
  12 struct page;
  13 struct pipe_inode_info;
  14
  15 struct kvec {
  16         void *iov_base; /* and that should *never* hold a userland pointer */
  17         size_t iov_len;
  18 };
  19
  20 enum iter_type {
  21         /* iter types */
  22         ITER_IOVEC,
  23         ITER_KVEC,
  24         ITER_BVEC,
  25         ITER_PIPE,
  26         ITER_XARRAY,
  27         ITER_DISCARD,
  28 };
  29
  30 struct iov_iter_state {
  31         size_t iov_offset;
  32         size_t count;
  33         unsigned long nr_segs;
  34 };
  35
  36 struct iov_iter {
  37         u8 iter_type;
  38         bool data_source;
  39         size_t iov_offset;
  40         size_t count;
  41         union {
  42                 const struct iovec *iov;
  43                 const struct kvec *kvec;
  44                 const struct bio_vec *bvec;
  45                 struct xarray *xarray;
  46                 struct pipe_inode_info *pipe;
  47         };
  48         union {
  49                 unsigned long nr_segs;
  50                 struct {
  51                         unsigned int head;
  52                         unsigned int start_head;
  53                 };
  54                 loff_t xarray_start;
  55         };
  56 };
  57
  58 static inline enum iter_type iov_iter_type(const struct iov_iter *i)
  59 {
  60         return i->iter_type;
  61 }
  62
  63 static inline void iov_iter_save_state(struct iov_iter *iter,
  64                                        struct iov_iter_state *state)
  65 {
  66         state->iov_offset = iter->iov_offset;
  67         state->count = iter->count;
  68         state->nr_segs = iter->nr_segs;
  69 }
  70
  71 static inline bool iter_is_iovec(const struct iov_iter *i)
  72 {
  73         return iov_iter_type(i) == ITER_IOVEC;
  74 }
  75
  76 static inline bool iov_iter_is_kvec(const struct iov_iter *i)
  77 {
  78         return iov_iter_type(i) == ITER_KVEC;
  79 }
  80
  81 static inline bool iov_iter_is_bvec(const struct iov_iter *i)
  82 {
  83         return iov_iter_type(i) == ITER_BVEC;
  84 }
  85
  86 static inline bool iov_iter_is_pipe(const struct iov_iter *i)
  87 {
  88         return iov_iter_type(i) == ITER_PIPE;
  89 }
  90
  91 static inline bool iov_iter_is_discard(const struct iov_iter *i)
  92 {
  93         return iov_iter_type(i) == ITER_DISCARD;
  94 }
  95
  96 static inline bool iov_iter_is_xarray(const struct iov_iter *i)
  97 {
  98         return iov_iter_type(i) == ITER_XARRAY;
  99 }
 100
 101 static inline unsigned char iov_iter_rw(const struct iov_iter *i)
 102 {
 103         return i->data_source ? WRITE : READ;
 104 }
 105
 106 /*
 107  * Total number of bytes covered by an iovec.
 108  *
 109  * NOTE that it is not safe to use this function until all the iovec's
 110  * segment lengths have been validated.  Because the individual lengths can
 111  * overflow a size_t when added together.
 112  */
 113 static inline size_t iov_length(const struct iovec *iov, unsigned long nr_segs)
 114 {
 115         unsigned long seg;
 116         size_t ret = 0;
 117
 118         for (seg = 0; seg < nr_segs; seg++)
 119                 ret += iov[seg].iov_len;
 120         return ret;
 121 }
 122
 123 static inline struct iovec iov_iter_iovec(const struct iov_iter *iter)
 124 {
 125         return (struct iovec) {
 126                 .iov_base = iter->iov->iov_base + iter->iov_offset,
 127                 .iov_len = min(iter->count,
 128                                iter->iov->iov_len - iter->iov_offset),
 129         };
 130 }
 131
 132 size_t copy_page_from_iter_atomic(struct page *page, unsigned offset,
 133                                   size_t bytes, struct iov_iter *i);
 134 void iov_iter_advance(struct iov_iter *i, size_t bytes);
 135 void iov_iter_revert(struct iov_iter *i, size_t bytes);
 136 size_t fault_in_iov_iter_readable(const struct iov_iter *i, size_t bytes);
 137 size_t fault_in_iov_iter_writeable(const struct iov_iter *i, size_t bytes);
 138 size_t iov_iter_single_seg_count(const struct iov_iter *i);
 139 size_t copy_page_to_iter(struct page *page, size_t offset, size_t bytes,
 140                          struct iov_iter *i);
 141 size_t copy_page_from_iter(struct page *page, size_t offset, size_t bytes,
 142                          struct iov_iter *i);
 143
 144 size_t _copy_to_iter(const void *addr, size_t bytes, struct iov_iter *i);
 145 size_t _copy_from_iter(void *addr, size_t bytes, struct iov_iter *i);
 146 size_t _copy_from_iter_nocache(void *addr, size_t bytes, struct iov_iter *i);
 147
 148 static __always_inline __must_check
 149 size_t copy_to_iter(const void *addr, size_t bytes, struct iov_iter *i)
 150 {
 151         if (unlikely(!check_copy_size(addr, bytes, true)))
 152                 return 0;
 153         else
 154                 return _copy_to_iter(addr, bytes, i);
 155 }
 156
 157 static __always_inline __must_check
 158 size_t copy_from_iter(void *addr, size_t bytes, struct iov_iter *i)
 159 {
 160         if (unlikely(!check_copy_size(addr, bytes, false)))
 161                 return 0;
 162         else
 163                 return _copy_from_iter(addr, bytes, i);
 164 }
 165
 166 static __always_inline __must_check
 167 bool copy_from_iter_full(void *addr, size_t bytes, struct iov_iter *i)
 168 {
 169         size_t copied = copy_from_iter(addr, bytes, i);
 170         if (likely(copied == bytes))
 171                 return true;
 172         iov_iter_revert(i, copied);
 173         return false;
 174 }
 175
 176 static __always_inline __must_check
 177 size_t copy_from_iter_nocache(void *addr, size_t bytes, struct iov_iter *i)
 178 {
 179         if (unlikely(!check_copy_size(addr, bytes, false)))
 180                 return 0;
 181         else
 182                 return _copy_from_iter_nocache(addr, bytes, i);
 183 }
 184
 185 static __always_inline __must_check
 186 bool copy_from_iter_full_nocache(void *addr, size_t bytes, struct iov_iter *i)
 187 {
 188         size_t copied = copy_from_iter_nocache(addr, bytes, i);
 189         if (likely(copied == bytes))
 190                 return true;
 191         iov_iter_revert(i, copied);
 192         return false;
 193 }
 194
 195 #ifdef CONFIG_ARCH_HAS_UACCESS_FLUSHCACHE
 196 /*
 197  * Note, users like pmem that depend on the stricter semantics of
 198  * copy_from_iter_flushcache() than copy_from_iter_nocache() must check for
 199  * IS_ENABLED(CONFIG_ARCH_HAS_UACCESS_FLUSHCACHE) before assuming that the
 200  * destination is flushed from the cache on return.
 201  */
 202 size_t _copy_from_iter_flushcache(void *addr, size_t bytes, struct iov_iter *i);
 203 #else
 204 #define _copy_from_iter_flushcache _copy_from_iter_nocache
 205 #endif
 206
 207 #ifdef CONFIG_ARCH_HAS_COPY_MC
 208 size_t _copy_mc_to_iter(const void *addr, size_t bytes, struct iov_iter *i);
 209 #else
 210 #define _copy_mc_to_iter _copy_to_iter
 211 #endif
 212
 213 static __always_inline __must_check
 214 size_t copy_from_iter_flushcache(void *addr, size_t bytes, struct iov_iter *i)
 215 {
 216         if (unlikely(!check_copy_size(addr, bytes, false)))
 217                 return 0;
 218         else
 219                 return _copy_from_iter_flushcache(addr, bytes, i);
 220 }
 221
 222 static __always_inline __must_check
 223 size_t copy_mc_to_iter(void *addr, size_t bytes, struct iov_iter *i)
 224 {
 225         if (unlikely(!check_copy_size(addr, bytes, true)))
 226                 return 0;
 227         else
 228                 return _copy_mc_to_iter(addr, bytes, i);
 229 }
 230
 231 size_t iov_iter_zero(size_t bytes, struct iov_iter *);
 232 unsigned long iov_iter_alignment(const struct iov_iter *i);
 233 unsigned long iov_iter_gap_alignment(const struct iov_iter *i);
 234 void iov_iter_init(struct iov_iter *i, unsigned int direction, const struct iovec *iov,
 235                         unsigned long nr_segs, size_t count);
 236 void iov_iter_kvec(struct iov_iter *i, unsigned int direction, const struct kvec *kvec,
 237                         unsigned long nr_segs, size_t count);
 238 void iov_iter_bvec(struct iov_iter *i, unsigned int direction, const struct bio_vec *bvec,
 239                         unsigned long nr_segs, size_t count);
 240 void iov_iter_pipe(struct iov_iter *i, unsigned int direction, struct pipe_inode_info *pipe,
 241                         size_t count);
 242 void iov_iter_discard(struct iov_iter *i, unsigned int direction, size_t count);
 243 void iov_iter_xarray(struct iov_iter *i, unsigned int direction, struct xarray *xarray,
 244                      loff_t start, size_t count);
 245 ssize_t iov_iter_get_pages(struct iov_iter *i, struct page **pages,
 246                         size_t maxsize, unsigned maxpages, size_t *start);
 247 ssize_t iov_iter_get_pages_alloc(struct iov_iter *i, struct page ***pages,
 248                         size_t maxsize, size_t *start);
 249 int iov_iter_npages(const struct iov_iter *i, int maxpages);
 250 void iov_iter_restore(struct iov_iter *i, struct iov_iter_state *state);
 251
 252 const void *dup_iter(struct iov_iter *new, struct iov_iter *old, gfp_t flags);
 253
 254 static inline size_t iov_iter_count(const struct iov_iter *i)
 255 {
 256         return i->count;
 257 }
 258
 259 /*
 260  * Cap the iov_iter by given limit; note that the second argument is
 261  * *not* the new size - it's upper limit for such.  Passing it a value
 262  * greater than the amount of data in iov_iter is fine - it'll just do
 263  * nothing in that case.
 264  */
 265 static inline void iov_iter_truncate(struct iov_iter *i, u64 count)
 266 {
 267         /*
 268          * count doesn't have to fit in size_t - comparison extends both
 269          * operands to u64 here and any value that would be truncated by
 270          * conversion in assignement is by definition greater than all
 271          * values of size_t, including old i->count.
 272          */
 273         if (i->count > count)
 274                 i->count = count;
 275 }
 276
 277 /*
 278  * reexpand a previously truncated iterator; count must be no more than how much
 279  * we had shrunk it.
 280  */
 281 static inline void iov_iter_reexpand(struct iov_iter *i, size_t count)
 282 {
 283         i->count = count;
 284 }
 285
 286 struct csum_state {
 287         __wsum csum;
 288         size_t off;
 289 };
 290
 291 size_t csum_and_copy_to_iter(const void *addr, size_t bytes, void *csstate, struct iov_iter *i);
 292 size_t csum_and_copy_from_iter(void *addr, size_t bytes, __wsum *csum, struct iov_iter *i);
 293
 294 static __always_inline __must_check
 295 bool csum_and_copy_from_iter_full(void *addr, size_t bytes,
 296                                   __wsum *csum, struct iov_iter *i)
 297 {
 298         size_t copied = csum_and_copy_from_iter(addr, bytes, csum, i);
 299         if (likely(copied == bytes))
 300                 return true;
 301         iov_iter_revert(i, copied);
 302         return false;
 303 }
 304 size_t hash_and_copy_to_iter(const void *addr, size_t bytes, void *hashp,
 305                 struct iov_iter *i);
 306
 307 struct iovec *iovec_from_user(const struct iovec __user *uvector,
 308                 unsigned long nr_segs, unsigned long fast_segs,
 309                 struct iovec *fast_iov, bool compat);
 310 ssize_t import_iovec(int type, const struct iovec __user *uvec,
 311                  unsigned nr_segs, unsigned fast_segs, struct iovec **iovp,
 312                  struct iov_iter *i);
 313 ssize_t __import_iovec(int type, const struct iovec __user *uvec,
 314                  unsigned nr_segs, unsigned fast_segs, struct iovec **iovp,
 315                  struct iov_iter *i, bool compat);
 316 int import_single_range(int type, void __user *buf, size_t len,
 317                  struct iovec *iov, struct iov_iter *i);
 318
 319 #endif