uio.h 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  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. int type;
  20. const struct iovec *iov;
  21. unsigned long nr_segs;
  22. size_t iov_offset;
  23. size_t count;
  24. };
  25. /*
  26. * Total number of bytes covered by an iovec.
  27. *
  28. * NOTE that it is not safe to use this function until all the iovec's
  29. * segment lengths have been validated. Because the individual lengths can
  30. * overflow a size_t when added together.
  31. */
  32. static inline size_t iov_length(const struct iovec *iov, unsigned long nr_segs)
  33. {
  34. unsigned long seg;
  35. size_t ret = 0;
  36. for (seg = 0; seg < nr_segs; seg++)
  37. ret += iov[seg].iov_len;
  38. return ret;
  39. }
  40. static inline struct iovec iov_iter_iovec(const struct iov_iter *iter)
  41. {
  42. return (struct iovec) {
  43. .iov_base = iter->iov->iov_base + iter->iov_offset,
  44. .iov_len = min(iter->count,
  45. iter->iov->iov_len - iter->iov_offset),
  46. };
  47. }
  48. #define iov_for_each(iov, iter, start) \
  49. for (iter = (start); \
  50. (iter).count && \
  51. ((iov = iov_iter_iovec(&(iter))), 1); \
  52. iov_iter_advance(&(iter), (iov).iov_len))
  53. unsigned long iov_shorten(struct iovec *iov, unsigned long nr_segs, size_t to);
  54. size_t iov_iter_copy_from_user_atomic(struct page *page,
  55. struct iov_iter *i, unsigned long offset, size_t bytes);
  56. void iov_iter_advance(struct iov_iter *i, size_t bytes);
  57. int iov_iter_fault_in_readable(struct iov_iter *i, size_t bytes);
  58. size_t iov_iter_single_seg_count(const struct iov_iter *i);
  59. size_t copy_page_to_iter(struct page *page, size_t offset, size_t bytes,
  60. struct iov_iter *i);
  61. unsigned long iov_iter_alignment(const struct iov_iter *i);
  62. void iov_iter_init(struct iov_iter *i, int direction, const struct iovec *iov,
  63. unsigned long nr_segs, size_t count);
  64. ssize_t iov_iter_get_pages(struct iov_iter *i, struct page **pages,
  65. size_t maxsize, size_t *start);
  66. int iov_iter_npages(const struct iov_iter *i, int maxpages);
  67. static inline size_t iov_iter_count(struct iov_iter *i)
  68. {
  69. return i->count;
  70. }
  71. int memcpy_fromiovec(unsigned char *kdata, struct iovec *iov, int len);
  72. int memcpy_toiovec(struct iovec *iov, unsigned char *kdata, int len);
  73. #endif