buffer.hpp 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511
  1. //
  2. // Copyright (c) 2025 Klemens Morgenstern (klemens.morgenstern@gmx.net)
  3. //
  4. // Distributed under the Boost Software License, Version 1.0. (See accompanying
  5. // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
  6. //
  7. #ifndef BOOST_COBALT_IO_BUFFER_HPP
  8. #define BOOST_COBALT_IO_BUFFER_HPP
  9. #include <boost/asio/buffer.hpp>
  10. #include <boost/asio/registered_buffer.hpp>
  11. #include <boost/cobalt/config.hpp>
  12. #include <span>
  13. namespace boost::cobalt::io
  14. {
  15. using asio::buffer;
  16. using asio::mutable_buffer;
  17. struct mutable_buffer_sequence
  18. {
  19. std::size_t buffer_count() const {return tail_.size() + 1u;}
  20. #if defined(BOOST_ASIO_HAS_IO_URING)
  21. mutable_buffer_sequence(asio::mutable_registered_buffer buffer = {}) : registered_(buffer) { }
  22. mutable_buffer_sequence(asio::mutable_buffer head) : registered_{}
  23. {
  24. this->head_ = head;
  25. }
  26. mutable_buffer_sequence(const mutable_buffer_sequence & rhs) : registered_(rhs.registered_), tail_(rhs.tail_) {}
  27. #else
  28. mutable_buffer_sequence(asio::mutable_registered_buffer buffer = {}) : head_(buffer.buffer()) { }
  29. mutable_buffer_sequence(asio::mutable_buffer head) : head_{head} { }
  30. mutable_buffer_sequence(const mutable_buffer_sequence & rhs) : head_(rhs.head_), tail_(rhs.tail_) {}
  31. #endif
  32. mutable_buffer_sequence& operator=(const mutable_buffer_sequence & rhs)
  33. {
  34. #if defined(BOOST_ASIO_HAS_IO_URING)
  35. registered_ = rhs.registered_;
  36. #else
  37. head_ = rhs.head_;
  38. #endif
  39. tail_ = rhs.tail_;
  40. return *this;
  41. }
  42. ~mutable_buffer_sequence() {}
  43. template<typename T>
  44. requires (std::constructible_from<std::span<const asio::mutable_buffer>, const T&>)
  45. mutable_buffer_sequence(const T & value)
  46. #if defined(BOOST_ASIO_HAS_IO_URING)
  47. : registered_{}
  48. #endif
  49. {
  50. std::span<const asio::mutable_buffer> spn(value);
  51. if (!spn.empty())
  52. {
  53. head_ = spn.front();
  54. tail_ = spn.subspan(1u);
  55. }
  56. }
  57. mutable_buffer_sequence(std::span<const asio::mutable_buffer> spn)
  58. #if defined(BOOST_ASIO_HAS_IO_URING)
  59. : registered_{}
  60. #endif
  61. {
  62. if (!spn.empty())
  63. {
  64. head_ = spn.front();
  65. tail_ = spn.subspan(1u);
  66. }
  67. }
  68. mutable_buffer_sequence & operator+=(std::size_t n)
  69. {
  70. if (n < head_.size())
  71. head_ += n;
  72. else
  73. {
  74. n -= head_.size();
  75. std::size_t idx = 0u;
  76. while (idx < tail_.size() && n > tail_[idx].size() )
  77. n -= tail_[idx++].size();
  78. if (idx == tail_.size()) // we're exceeding the size, so just drop everything
  79. {
  80. tail_ = {};
  81. head_ = {};
  82. }
  83. if (tail_.empty())
  84. head_ = {};
  85. else
  86. {
  87. head_ = tail_[idx];
  88. head_ += n;
  89. tail_ = tail_.subspan(idx + 1);
  90. }
  91. }
  92. return *this;
  93. }
  94. struct const_iterator
  95. {
  96. using iterator_category = std::random_access_iterator_tag;
  97. using value_type = asio::mutable_buffer;
  98. using difference_type = std::ptrdiff_t;
  99. using pointer = const asio::mutable_buffer*;
  100. using reference = const asio::mutable_buffer&;
  101. BOOST_COBALT_MSVC_NOINLINE
  102. const_iterator(asio::mutable_buffer head,
  103. std::span<const asio::mutable_buffer> tail,
  104. std::size_t offset = std::numeric_limits<std::size_t>::max()) : head_(head), tail_(tail), offset_(offset) {}
  105. BOOST_COBALT_MSVC_NOINLINE
  106. reference & operator*() const
  107. {
  108. return offset_ == std::numeric_limits<std::size_t>::max() ? head_ : tail_[offset_];
  109. }
  110. BOOST_COBALT_MSVC_NOINLINE
  111. pointer operator->() const
  112. {
  113. return offset_ == std::numeric_limits<std::size_t>::max() ? &head_ : &tail_[offset_];
  114. }
  115. const_iterator operator++()
  116. {
  117. offset_++;
  118. return *this;
  119. }
  120. const_iterator operator++(int)
  121. {
  122. auto o = *this;
  123. offset_ ++ ;
  124. return o;
  125. }
  126. const_iterator operator--()
  127. {
  128. offset_ --;
  129. return *this;
  130. }
  131. const_iterator operator--(int)
  132. {
  133. auto o = *this;
  134. offset_ -- ;
  135. return o;
  136. }
  137. const_iterator operator+(difference_type diff) const
  138. {
  139. auto res = *this;
  140. res.offset_ += diff;
  141. return res;
  142. }
  143. const_iterator operator-(difference_type diff) const
  144. {
  145. auto res = *this;
  146. res.offset_ -= diff;
  147. return res;
  148. }
  149. const_iterator& operator+=(difference_type diff)
  150. {
  151. offset_ += diff;
  152. return *this;
  153. }
  154. const_iterator operator-=(difference_type diff)
  155. {
  156. offset_ -= diff;
  157. return *this;
  158. }
  159. reference operator[](difference_type n) const
  160. {
  161. auto idx = offset_ + n;
  162. return idx == std::numeric_limits<std::size_t>::max() ? head_ : tail_[idx];
  163. }
  164. difference_type operator-(const_iterator itr) const
  165. {
  166. return static_cast<difference_type>(offset_) - static_cast<difference_type>(itr.offset_);
  167. }
  168. friend auto operator<=>(const const_iterator & lhs, const const_iterator & rhs)
  169. {
  170. return std::make_tuple(lhs.head_.data(), lhs.head_.size(), lhs.tail_.data(), lhs.tail_.size(), lhs.offset_)
  171. <=> std::make_tuple(rhs.head_.data(), rhs.head_.size(), rhs.tail_.data(), rhs.tail_.size(), rhs.offset_);
  172. };
  173. friend bool operator==(const const_iterator & lhs, const const_iterator & rhs)
  174. {
  175. return std::make_tuple(lhs.head_.data(), lhs.head_.size(), lhs.tail_.data(), lhs.tail_.size(), lhs.offset_)
  176. == std::make_tuple(rhs.head_.data(), rhs.head_.size(), rhs.tail_.data(), rhs.tail_.size(), rhs.offset_);
  177. }
  178. friend bool operator!=(const const_iterator & lhs, const const_iterator & rhs)
  179. {
  180. return std::make_tuple(lhs.head_.data(), lhs.head_.size(), lhs.tail_.data(), lhs.tail_.size(), lhs.offset_)
  181. != std::make_tuple(rhs.head_.data(), rhs.head_.size(), rhs.tail_.data(), rhs.tail_.size(), rhs.offset_);
  182. }
  183. private:
  184. asio::mutable_buffer head_;
  185. std::span<const asio::mutable_buffer> tail_;
  186. std::size_t offset_{std::numeric_limits<std::size_t>::max()};
  187. };
  188. BOOST_COBALT_MSVC_NOINLINE
  189. const_iterator begin() const {return const_iterator{head_, tail_};}
  190. BOOST_COBALT_MSVC_NOINLINE
  191. const_iterator end() const {return const_iterator{head_, tail_, tail_.size()};}
  192. bool is_registered() const
  193. {
  194. #if defined(BOOST_ASIO_HAS_IO_URING)
  195. return registered_.id() != asio::registered_buffer_id();
  196. #else
  197. return false;
  198. #endif
  199. }
  200. template<typename Func>
  201. friend auto visit(const mutable_buffer_sequence & seq, Func && func)
  202. {
  203. if (seq.buffer_count() > 1u)
  204. return std::forward<Func>(func)(seq);
  205. #if defined(BOOST_ASIO_HAS_IO_URING)
  206. else if (seq.is_registered())
  207. return std::forward<Func>(func)(seq.registered_);
  208. #endif
  209. else
  210. return std::forward<Func>(func)(seq.head_);
  211. }
  212. private:
  213. #if defined(BOOST_ASIO_HAS_IO_URING)
  214. union {
  215. asio::mutable_registered_buffer registered_{};
  216. asio::mutable_buffer head_;
  217. };
  218. #else
  219. asio::mutable_buffer head_;
  220. #endif
  221. std::span<const asio::mutable_buffer> tail_;
  222. };
  223. using asio::const_buffer;
  224. struct const_buffer_sequence
  225. {
  226. std::size_t buffer_count() const {return tail_.size() + 1u;}
  227. #if defined(BOOST_ASIO_HAS_IO_URING)
  228. const_buffer_sequence(asio::const_registered_buffer buffer = {}) : registered_(buffer) {}
  229. const_buffer_sequence(asio::mutable_registered_buffer buffer) : registered_(buffer) {}
  230. const_buffer_sequence(asio::const_buffer head) : registered_{} { this->head_ = head; }
  231. const_buffer_sequence(asio::mutable_buffer head) : registered_{} { this->head_ = head; }
  232. const_buffer_sequence(const const_buffer_sequence & rhs) : registered_(rhs.registered_), tail_(rhs.tail_) {}
  233. #else
  234. const_buffer_sequence(asio::const_registered_buffer buffer = {}) : head_(buffer.buffer()) {}
  235. const_buffer_sequence(asio::mutable_registered_buffer buffer) : head_(buffer.buffer()) {}
  236. const_buffer_sequence(asio::const_buffer head) : head_{ head} { }
  237. const_buffer_sequence(asio::mutable_buffer head) : head_{ head} { }
  238. const_buffer_sequence(const const_buffer_sequence & rhs) : head_(rhs.head_), tail_(rhs.tail_) {}
  239. #endif
  240. template<typename T>
  241. requires (std::constructible_from<std::span<const asio::const_buffer>, const T&>)
  242. const_buffer_sequence(const T & value)
  243. #if defined(BOOST_ASIO_HAS_IO_URING)
  244. : registered_{}
  245. #endif
  246. {
  247. std::span<const asio::const_buffer> spn(value);
  248. if (!spn.empty())
  249. {
  250. head_ = spn.front();
  251. tail_ = spn.subspan(1u);
  252. }
  253. }
  254. const_buffer_sequence& operator=(const const_buffer_sequence & rhs)
  255. {
  256. #if defined(BOOST_ASIO_HAS_IO_URING)
  257. registered_ = rhs.registered_;
  258. #else
  259. head_ = rhs.head_;
  260. #endif
  261. tail_ = rhs.tail_;
  262. return *this;
  263. }
  264. ~const_buffer_sequence() {}
  265. const_buffer_sequence(std::span<const asio::const_buffer> spn)
  266. #if defined(BOOST_ASIO_HAS_IO_URING)
  267. : registered_{}
  268. #endif
  269. {
  270. if (!spn.empty())
  271. {
  272. head_ = spn.front();
  273. tail_ = spn.subspan(1u);
  274. }
  275. }
  276. const_buffer_sequence & operator+=(std::size_t n)
  277. {
  278. if (n < head_.size())
  279. head_ += n;
  280. else
  281. {
  282. n -= head_.size();
  283. std::size_t idx = 0u;
  284. while (idx < tail_.size() && n > tail_[idx].size() )
  285. n -= tail_[idx++].size();
  286. if (idx == tail_.size()) // we're exceeding the size, so just drop everything
  287. {
  288. tail_ = {};
  289. head_ = {};
  290. }
  291. if (tail_.empty())
  292. head_ = {};
  293. else
  294. {
  295. head_ = tail_[idx];
  296. head_ += n;
  297. tail_ = tail_.subspan(idx + 1);
  298. }
  299. }
  300. return *this;
  301. }
  302. struct const_iterator
  303. {
  304. using iterator_category = std::random_access_iterator_tag;
  305. using value_type = asio::const_buffer;
  306. using difference_type = std::ptrdiff_t;
  307. using pointer = const asio::const_buffer*;
  308. using reference = const asio::const_buffer&;
  309. BOOST_COBALT_MSVC_NOINLINE
  310. const_iterator(asio::const_buffer head,
  311. std::span<const asio::const_buffer> tail,
  312. std::size_t offset = std::numeric_limits<std::size_t>::max()) : head_(head), tail_(tail), offset_(offset)
  313. {
  314. }
  315. BOOST_COBALT_MSVC_NOINLINE
  316. reference & operator*() const
  317. {
  318. return offset_ == std::numeric_limits<std::size_t>::max() ? head_ : tail_[offset_];
  319. }
  320. BOOST_COBALT_MSVC_NOINLINE
  321. pointer operator->() const
  322. {
  323. return offset_ == std::numeric_limits<std::size_t>::max() ? &head_ : &tail_[offset_];
  324. }
  325. const_iterator operator++()
  326. {
  327. offset_++;
  328. return *this;
  329. }
  330. const_iterator operator++(int)
  331. {
  332. auto o = *this;
  333. offset_ ++ ;
  334. return o;
  335. }
  336. const_iterator operator--()
  337. {
  338. offset_ --;
  339. return *this;
  340. }
  341. const_iterator operator--(int)
  342. {
  343. auto o = *this;
  344. offset_ -- ;
  345. return o;
  346. }
  347. const_iterator operator+(difference_type diff) const
  348. {
  349. auto res = *this;
  350. res.offset_ += diff;
  351. return res;
  352. }
  353. const_iterator operator-(difference_type diff) const
  354. {
  355. auto res = *this;
  356. res.offset_ -= diff;
  357. return res;
  358. }
  359. const_iterator& operator+=(difference_type diff)
  360. {
  361. offset_ += diff;
  362. return *this;
  363. }
  364. const_iterator operator-=(difference_type diff)
  365. {
  366. offset_ -= diff;
  367. return *this;
  368. }
  369. BOOST_COBALT_MSVC_NOINLINE
  370. reference operator[](difference_type n) const
  371. {
  372. auto idx = offset_ + n;
  373. return idx == std::numeric_limits<std::size_t>::max() ? head_ : tail_[idx];
  374. }
  375. difference_type operator-(const_iterator itr) const
  376. {
  377. return static_cast<difference_type>(offset_) - static_cast<difference_type>(itr.offset_);
  378. }
  379. friend auto operator<=>(const const_iterator & lhs, const const_iterator & rhs)
  380. {
  381. return std::make_tuple(lhs.head_.data(), lhs.head_.size(), lhs.tail_.data(), lhs.tail_.size(), lhs.offset_)
  382. <=> std::make_tuple(rhs.head_.data(), rhs.head_.size(), rhs.tail_.data(), rhs.tail_.size(), rhs.offset_);
  383. };
  384. friend bool operator==(const const_iterator & lhs, const const_iterator & rhs)
  385. {
  386. return std::make_tuple(lhs.head_.data(), lhs.head_.size(), lhs.tail_.data(), lhs.tail_.size(), lhs.offset_)
  387. == std::make_tuple(rhs.head_.data(), rhs.head_.size(), rhs.tail_.data(), rhs.tail_.size(), rhs.offset_);
  388. }
  389. friend bool operator!=(const const_iterator & lhs, const const_iterator & rhs)
  390. {
  391. return std::make_tuple(lhs.head_.data(), lhs.head_.size(), lhs.tail_.data(), lhs.tail_.size(), lhs.offset_)
  392. != std::make_tuple(rhs.head_.data(), rhs.head_.size(), rhs.tail_.data(), rhs.tail_.size(), rhs.offset_);
  393. }
  394. private:
  395. asio::const_buffer head_;
  396. std::span<const asio::const_buffer> tail_;
  397. std::size_t offset_{std::numeric_limits<std::size_t>::max()};
  398. };
  399. BOOST_COBALT_MSVC_NOINLINE
  400. const_iterator begin() const {return const_iterator{head_, tail_};}
  401. BOOST_COBALT_MSVC_NOINLINE
  402. const_iterator end() const {return const_iterator{head_, tail_, tail_.size()};}
  403. bool is_registered() const
  404. {
  405. #if defined(BOOST_ASIO_HAS_IO_URING)
  406. return registered_.id() != asio::registered_buffer_id();
  407. #else
  408. return false;
  409. #endif
  410. }
  411. template<typename Func>
  412. friend auto visit(const const_buffer_sequence & seq, Func && func)
  413. {
  414. if (seq.buffer_count() > 1u)
  415. return std::forward<Func>(func)(seq);
  416. // Windows doesn't support registerd buffers anyhow
  417. #if defined(BOOST_ASIO_HAS_IO_URING)
  418. else if (seq.is_registered())
  419. return std::forward<Func>(func)(seq.registered_);
  420. #endif
  421. else
  422. return std::forward<Func>(func)(seq.head_);
  423. }
  424. private:
  425. #if defined(BOOST_ASIO_HAS_IO_URING)
  426. union {
  427. asio::const_registered_buffer registered_;
  428. asio::const_buffer head_;
  429. };
  430. #else
  431. asio::const_buffer head_;
  432. #endif
  433. std::span<const asio::const_buffer> tail_;
  434. };
  435. using asio::buffer_copy;
  436. using asio::buffer_size;
  437. }
  438. #endif //BOOST_COBALT_IO_BUFFER_HPP