uio.h 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  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. */
  9. #ifndef __LINUX_UIO_H
  10. #define __LINUX_UIO_H
  11. #include <linux/kernel.h>
  12. #include <uapi/linux/uio.h>
  13. struct page;
  14. struct kvec {
  15. void *iov_base; /* and that should *never* hold a userland pointer */
  16. size_t iov_len;
  17. };
  18. struct iov_iter {
  19. const struct iovec *iov;
  20. unsigned long nr_segs;
  21. size_t iov_offset;
  22. size_t count;
  23. };
  24. /*
  25. * Total number of bytes covered by an iovec.
  26. *
  27. * NOTE that it is not safe to use this function until all the iovec's
  28. * segment lengths have been validated. Because the individual lengths can
  29. * overflow a size_t when added together.
  30. */
  31. static inline size_t iov_length(const struct iovec *iov, unsigned long nr_segs)
  32. {
  33. unsigned long seg;
  34. size_t ret = 0;
  35. for (seg = 0; seg < nr_segs; seg++)
  36. ret += iov[seg].iov_len;
  37. return ret;
  38. }
  39. static inline struct iovec iov_iter_iovec(const struct iov_iter *iter)
  40. {
  41. return (struct iovec) {
  42. .iov_base = iter->iov->iov_base + iter->iov_offset,
  43. .iov_len = min(iter->count,
  44. iter->iov->iov_len - iter->iov_offset),
  45. };
  46. }
  47. #define iov_for_each(iov, iter, start) \
  48. for (iter = (start); \
  49. (iter).count && \
  50. ((iov = iov_iter_iovec(&(iter))), 1); \
  51. iov_iter_advance(&(iter), (iov).iov_len))
  52. unsigned long iov_shorten(struct iovec *iov, unsigned long nr_segs, size_t to);
  53. size_t iov_iter_copy_from_user_atomic(struct page *page,
  54. struct iov_iter *i, unsigned long offset, size_t bytes);
  55. void iov_iter_advance(struct iov_iter *i, size_t bytes);
  56. int iov_iter_fault_in_readable(struct iov_iter *i, size_t bytes);
  57. size_t iov_iter_single_seg_count(const struct iov_iter *i);
  58. size_t copy_page_to_iter(struct page *page, size_t offset, size_t bytes,
  59. struct iov_iter *i);
  60. static inline void iov_iter_init(struct iov_iter *i,
  61. const struct iovec *iov, unsigned long nr_segs,
  62. size_t count, size_t written)
  63. {
  64. i->iov = iov;
  65. i->nr_segs = nr_segs;
  66. i->iov_offset = 0;
  67. i->count = count + written;
  68. iov_iter_advance(i, written);
  69. }
  70. static inline size_t iov_iter_count(struct iov_iter *i)
  71. {
  72. return i->count;
  73. }
  74. int memcpy_fromiovec(unsigned char *kdata, struct iovec *iov, int len);
  75. int memcpy_toiovec(struct iovec *iov, unsigned char *kdata, int len);
  76. #endif