buffer_sequence_adapter.hpp 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700
  1. //
  2. // detail/buffer_sequence_adapter.hpp
  3. // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  4. //
  5. // Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com)
  6. //
  7. // Distributed under the Boost Software License, Version 1.0. (See accompanying
  8. // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
  9. //
  10. #ifndef BOOST_ASIO_DETAIL_BUFFER_SEQUENCE_ADAPTER_HPP
  11. #define BOOST_ASIO_DETAIL_BUFFER_SEQUENCE_ADAPTER_HPP
  12. #if defined(_MSC_VER) && (_MSC_VER >= 1200)
  13. # pragma once
  14. #endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
  15. #include <boost/asio/detail/config.hpp>
  16. #include <boost/asio/buffer.hpp>
  17. #include <boost/asio/detail/array_fwd.hpp>
  18. #include <boost/asio/detail/socket_types.hpp>
  19. #include <boost/asio/registered_buffer.hpp>
  20. #include <boost/asio/detail/push_options.hpp>
  21. namespace boost {
  22. namespace asio {
  23. namespace detail {
  24. class buffer_sequence_adapter_base
  25. {
  26. #if defined(BOOST_ASIO_WINDOWS_RUNTIME)
  27. public:
  28. // The maximum number of buffers to support in a single operation.
  29. enum { max_buffers = 1 };
  30. protected:
  31. typedef Windows::Storage::Streams::IBuffer^ native_buffer_type;
  32. BOOST_ASIO_DECL static void init_native_buffer(
  33. native_buffer_type& buf,
  34. const boost::asio::mutable_buffer& buffer);
  35. BOOST_ASIO_DECL static void init_native_buffer(
  36. native_buffer_type& buf,
  37. const boost::asio::const_buffer& buffer);
  38. #elif defined(BOOST_ASIO_WINDOWS) || defined(__CYGWIN__)
  39. public:
  40. // The maximum number of buffers to support in a single operation.
  41. enum { max_buffers = 64 < max_iov_len ? 64 : max_iov_len };
  42. protected:
  43. typedef WSABUF native_buffer_type;
  44. static void init_native_buffer(WSABUF& buf,
  45. const boost::asio::mutable_buffer& buffer)
  46. {
  47. buf.buf = static_cast<char*>(buffer.data());
  48. buf.len = static_cast<ULONG>(buffer.size());
  49. }
  50. static void init_native_buffer(WSABUF& buf,
  51. const boost::asio::const_buffer& buffer)
  52. {
  53. buf.buf = const_cast<char*>(static_cast<const char*>(buffer.data()));
  54. buf.len = static_cast<ULONG>(buffer.size());
  55. }
  56. #else // defined(BOOST_ASIO_WINDOWS) || defined(__CYGWIN__)
  57. public:
  58. // The maximum number of buffers to support in a single operation.
  59. enum { max_buffers = 64 < max_iov_len ? 64 : max_iov_len };
  60. protected:
  61. typedef iovec native_buffer_type;
  62. static void init_iov_base(void*& base, void* addr)
  63. {
  64. base = addr;
  65. }
  66. template <typename T>
  67. static void init_iov_base(T& base, void* addr)
  68. {
  69. base = static_cast<T>(addr);
  70. }
  71. static void init_native_buffer(iovec& iov,
  72. const boost::asio::mutable_buffer& buffer)
  73. {
  74. init_iov_base(iov.iov_base, buffer.data());
  75. iov.iov_len = buffer.size();
  76. }
  77. static void init_native_buffer(iovec& iov,
  78. const boost::asio::const_buffer& buffer)
  79. {
  80. init_iov_base(iov.iov_base, const_cast<void*>(buffer.data()));
  81. iov.iov_len = buffer.size();
  82. }
  83. #endif // defined(BOOST_ASIO_WINDOWS) || defined(__CYGWIN__)
  84. };
  85. // Helper class to translate buffers into the native buffer representation.
  86. template <typename Buffer, typename Buffers>
  87. class buffer_sequence_adapter
  88. : buffer_sequence_adapter_base
  89. {
  90. public:
  91. enum { is_single_buffer = false };
  92. enum { is_registered_buffer = false };
  93. explicit buffer_sequence_adapter(const Buffers& buffer_sequence)
  94. : count_(0), total_buffer_size_(0)
  95. {
  96. buffer_sequence_adapter::init(
  97. boost::asio::buffer_sequence_begin(buffer_sequence),
  98. boost::asio::buffer_sequence_end(buffer_sequence));
  99. }
  100. native_buffer_type* buffers()
  101. {
  102. return buffers_;
  103. }
  104. std::size_t count() const
  105. {
  106. return count_;
  107. }
  108. std::size_t total_size() const
  109. {
  110. return total_buffer_size_;
  111. }
  112. registered_buffer_id registered_id() const
  113. {
  114. return registered_buffer_id();
  115. }
  116. bool all_empty() const
  117. {
  118. return total_buffer_size_ == 0;
  119. }
  120. static bool all_empty(const Buffers& buffer_sequence)
  121. {
  122. return buffer_sequence_adapter::all_empty(
  123. boost::asio::buffer_sequence_begin(buffer_sequence),
  124. boost::asio::buffer_sequence_end(buffer_sequence));
  125. }
  126. static void validate(const Buffers& buffer_sequence)
  127. {
  128. buffer_sequence_adapter::validate(
  129. boost::asio::buffer_sequence_begin(buffer_sequence),
  130. boost::asio::buffer_sequence_end(buffer_sequence));
  131. }
  132. static Buffer first(const Buffers& buffer_sequence)
  133. {
  134. return buffer_sequence_adapter::first(
  135. boost::asio::buffer_sequence_begin(buffer_sequence),
  136. boost::asio::buffer_sequence_end(buffer_sequence));
  137. }
  138. enum { linearisation_storage_size = 8192 };
  139. static Buffer linearise(const Buffers& buffer_sequence,
  140. const boost::asio::mutable_buffer& storage)
  141. {
  142. return buffer_sequence_adapter::linearise(
  143. boost::asio::buffer_sequence_begin(buffer_sequence),
  144. boost::asio::buffer_sequence_end(buffer_sequence), storage);
  145. }
  146. private:
  147. template <typename Iterator>
  148. void init(Iterator begin, Iterator end)
  149. {
  150. Iterator iter = begin;
  151. for (; iter != end && count_ < max_buffers; ++iter, ++count_)
  152. {
  153. Buffer buffer(*iter);
  154. init_native_buffer(buffers_[count_], buffer);
  155. total_buffer_size_ += buffer.size();
  156. }
  157. }
  158. template <typename Iterator>
  159. static bool all_empty(Iterator begin, Iterator end)
  160. {
  161. Iterator iter = begin;
  162. std::size_t i = 0;
  163. for (; iter != end && i < max_buffers; ++iter, ++i)
  164. if (Buffer(*iter).size() > 0)
  165. return false;
  166. return true;
  167. }
  168. template <typename Iterator>
  169. static void validate(Iterator begin, Iterator end)
  170. {
  171. Iterator iter = begin;
  172. for (; iter != end; ++iter)
  173. {
  174. Buffer buffer(*iter);
  175. buffer.data();
  176. }
  177. }
  178. template <typename Iterator>
  179. static Buffer first(Iterator begin, Iterator end)
  180. {
  181. Iterator iter = begin;
  182. for (; iter != end; ++iter)
  183. {
  184. Buffer buffer(*iter);
  185. if (buffer.size() != 0)
  186. return buffer;
  187. }
  188. return Buffer();
  189. }
  190. template <typename Iterator>
  191. static Buffer linearise(Iterator begin, Iterator end,
  192. const boost::asio::mutable_buffer& storage)
  193. {
  194. boost::asio::mutable_buffer unused_storage = storage;
  195. Iterator iter = begin;
  196. while (iter != end && unused_storage.size() != 0)
  197. {
  198. Buffer buffer(*iter);
  199. ++iter;
  200. if (buffer.size() == 0)
  201. continue;
  202. if (unused_storage.size() == storage.size())
  203. {
  204. if (iter == end)
  205. return buffer;
  206. if (buffer.size() >= unused_storage.size())
  207. return buffer;
  208. }
  209. unused_storage += boost::asio::buffer_copy(unused_storage, buffer);
  210. }
  211. return Buffer(storage.data(), storage.size() - unused_storage.size());
  212. }
  213. native_buffer_type buffers_[max_buffers];
  214. std::size_t count_;
  215. std::size_t total_buffer_size_;
  216. };
  217. template <typename Buffer>
  218. class buffer_sequence_adapter<Buffer, boost::asio::mutable_buffer>
  219. : buffer_sequence_adapter_base
  220. {
  221. public:
  222. enum { is_single_buffer = true };
  223. enum { is_registered_buffer = false };
  224. explicit buffer_sequence_adapter(
  225. const boost::asio::mutable_buffer& buffer_sequence)
  226. {
  227. init_native_buffer(buffer_, Buffer(buffer_sequence));
  228. total_buffer_size_ = buffer_sequence.size();
  229. }
  230. native_buffer_type* buffers()
  231. {
  232. return &buffer_;
  233. }
  234. std::size_t count() const
  235. {
  236. return 1;
  237. }
  238. std::size_t total_size() const
  239. {
  240. return total_buffer_size_;
  241. }
  242. registered_buffer_id registered_id() const
  243. {
  244. return registered_buffer_id();
  245. }
  246. bool all_empty() const
  247. {
  248. return total_buffer_size_ == 0;
  249. }
  250. static bool all_empty(const boost::asio::mutable_buffer& buffer_sequence)
  251. {
  252. return buffer_sequence.size() == 0;
  253. }
  254. static void validate(const boost::asio::mutable_buffer& buffer_sequence)
  255. {
  256. buffer_sequence.data();
  257. }
  258. static Buffer first(const boost::asio::mutable_buffer& buffer_sequence)
  259. {
  260. return Buffer(buffer_sequence);
  261. }
  262. enum { linearisation_storage_size = 1 };
  263. static Buffer linearise(const boost::asio::mutable_buffer& buffer_sequence,
  264. const Buffer&)
  265. {
  266. return Buffer(buffer_sequence);
  267. }
  268. private:
  269. native_buffer_type buffer_;
  270. std::size_t total_buffer_size_;
  271. };
  272. template <typename Buffer>
  273. class buffer_sequence_adapter<Buffer, boost::asio::const_buffer>
  274. : buffer_sequence_adapter_base
  275. {
  276. public:
  277. enum { is_single_buffer = true };
  278. enum { is_registered_buffer = false };
  279. explicit buffer_sequence_adapter(
  280. const boost::asio::const_buffer& buffer_sequence)
  281. {
  282. init_native_buffer(buffer_, Buffer(buffer_sequence));
  283. total_buffer_size_ = buffer_sequence.size();
  284. }
  285. native_buffer_type* buffers()
  286. {
  287. return &buffer_;
  288. }
  289. std::size_t count() const
  290. {
  291. return 1;
  292. }
  293. std::size_t total_size() const
  294. {
  295. return total_buffer_size_;
  296. }
  297. registered_buffer_id registered_id() const
  298. {
  299. return registered_buffer_id();
  300. }
  301. bool all_empty() const
  302. {
  303. return total_buffer_size_ == 0;
  304. }
  305. static bool all_empty(const boost::asio::const_buffer& buffer_sequence)
  306. {
  307. return buffer_sequence.size() == 0;
  308. }
  309. static void validate(const boost::asio::const_buffer& buffer_sequence)
  310. {
  311. buffer_sequence.data();
  312. }
  313. static Buffer first(const boost::asio::const_buffer& buffer_sequence)
  314. {
  315. return Buffer(buffer_sequence);
  316. }
  317. enum { linearisation_storage_size = 1 };
  318. static Buffer linearise(const boost::asio::const_buffer& buffer_sequence,
  319. const Buffer&)
  320. {
  321. return Buffer(buffer_sequence);
  322. }
  323. private:
  324. native_buffer_type buffer_;
  325. std::size_t total_buffer_size_;
  326. };
  327. template <typename Buffer>
  328. class buffer_sequence_adapter<Buffer, boost::asio::mutable_registered_buffer>
  329. : buffer_sequence_adapter_base
  330. {
  331. public:
  332. enum { is_single_buffer = true };
  333. enum { is_registered_buffer = true };
  334. explicit buffer_sequence_adapter(
  335. const boost::asio::mutable_registered_buffer& buffer_sequence)
  336. {
  337. init_native_buffer(buffer_, buffer_sequence.buffer());
  338. total_buffer_size_ = buffer_sequence.size();
  339. registered_id_ = buffer_sequence.id();
  340. }
  341. native_buffer_type* buffers()
  342. {
  343. return &buffer_;
  344. }
  345. std::size_t count() const
  346. {
  347. return 1;
  348. }
  349. std::size_t total_size() const
  350. {
  351. return total_buffer_size_;
  352. }
  353. registered_buffer_id registered_id() const
  354. {
  355. return registered_id_;
  356. }
  357. bool all_empty() const
  358. {
  359. return total_buffer_size_ == 0;
  360. }
  361. static bool all_empty(
  362. const boost::asio::mutable_registered_buffer& buffer_sequence)
  363. {
  364. return buffer_sequence.size() == 0;
  365. }
  366. static void validate(
  367. const boost::asio::mutable_registered_buffer& buffer_sequence)
  368. {
  369. buffer_sequence.data();
  370. }
  371. static Buffer first(
  372. const boost::asio::mutable_registered_buffer& buffer_sequence)
  373. {
  374. return Buffer(buffer_sequence.buffer());
  375. }
  376. enum { linearisation_storage_size = 1 };
  377. static Buffer linearise(
  378. const boost::asio::mutable_registered_buffer& buffer_sequence,
  379. const Buffer&)
  380. {
  381. return Buffer(buffer_sequence.buffer());
  382. }
  383. private:
  384. native_buffer_type buffer_;
  385. std::size_t total_buffer_size_;
  386. registered_buffer_id registered_id_;
  387. };
  388. template <typename Buffer>
  389. class buffer_sequence_adapter<Buffer, boost::asio::const_registered_buffer>
  390. : buffer_sequence_adapter_base
  391. {
  392. public:
  393. enum { is_single_buffer = true };
  394. enum { is_registered_buffer = true };
  395. explicit buffer_sequence_adapter(
  396. const boost::asio::const_registered_buffer& buffer_sequence)
  397. {
  398. init_native_buffer(buffer_, buffer_sequence.buffer());
  399. total_buffer_size_ = buffer_sequence.size();
  400. registered_id_ = buffer_sequence.id();
  401. }
  402. native_buffer_type* buffers()
  403. {
  404. return &buffer_;
  405. }
  406. std::size_t count() const
  407. {
  408. return 1;
  409. }
  410. std::size_t total_size() const
  411. {
  412. return total_buffer_size_;
  413. }
  414. registered_buffer_id registered_id() const
  415. {
  416. return registered_id_;
  417. }
  418. bool all_empty() const
  419. {
  420. return total_buffer_size_ == 0;
  421. }
  422. static bool all_empty(
  423. const boost::asio::const_registered_buffer& buffer_sequence)
  424. {
  425. return buffer_sequence.size() == 0;
  426. }
  427. static void validate(
  428. const boost::asio::const_registered_buffer& buffer_sequence)
  429. {
  430. buffer_sequence.data();
  431. }
  432. static Buffer first(
  433. const boost::asio::const_registered_buffer& buffer_sequence)
  434. {
  435. return Buffer(buffer_sequence.buffer());
  436. }
  437. enum { linearisation_storage_size = 1 };
  438. static Buffer linearise(
  439. const boost::asio::const_registered_buffer& buffer_sequence,
  440. const Buffer&)
  441. {
  442. return Buffer(buffer_sequence.buffer());
  443. }
  444. private:
  445. native_buffer_type buffer_;
  446. std::size_t total_buffer_size_;
  447. registered_buffer_id registered_id_;
  448. };
  449. template <typename Buffer, typename Elem>
  450. class buffer_sequence_adapter<Buffer, boost::array<Elem, 2>>
  451. : buffer_sequence_adapter_base
  452. {
  453. public:
  454. enum { is_single_buffer = false };
  455. enum { is_registered_buffer = false };
  456. explicit buffer_sequence_adapter(
  457. const boost::array<Elem, 2>& buffer_sequence)
  458. {
  459. init_native_buffer(buffers_[0], Buffer(buffer_sequence[0]));
  460. init_native_buffer(buffers_[1], Buffer(buffer_sequence[1]));
  461. total_buffer_size_ = buffer_sequence[0].size() + buffer_sequence[1].size();
  462. }
  463. native_buffer_type* buffers()
  464. {
  465. return buffers_;
  466. }
  467. std::size_t count() const
  468. {
  469. return 2;
  470. }
  471. std::size_t total_size() const
  472. {
  473. return total_buffer_size_;
  474. }
  475. registered_buffer_id registered_id() const
  476. {
  477. return registered_buffer_id();
  478. }
  479. bool all_empty() const
  480. {
  481. return total_buffer_size_ == 0;
  482. }
  483. static bool all_empty(const boost::array<Elem, 2>& buffer_sequence)
  484. {
  485. return buffer_sequence[0].size() == 0 && buffer_sequence[1].size() == 0;
  486. }
  487. static void validate(const boost::array<Elem, 2>& buffer_sequence)
  488. {
  489. buffer_sequence[0].data();
  490. buffer_sequence[1].data();
  491. }
  492. static Buffer first(const boost::array<Elem, 2>& buffer_sequence)
  493. {
  494. return Buffer(buffer_sequence[0].size() != 0
  495. ? buffer_sequence[0] : buffer_sequence[1]);
  496. }
  497. enum { linearisation_storage_size = 8192 };
  498. static Buffer linearise(const boost::array<Elem, 2>& buffer_sequence,
  499. const boost::asio::mutable_buffer& storage)
  500. {
  501. if (buffer_sequence[0].size() == 0)
  502. return Buffer(buffer_sequence[1]);
  503. if (buffer_sequence[1].size() == 0)
  504. return Buffer(buffer_sequence[0]);
  505. return Buffer(storage.data(),
  506. boost::asio::buffer_copy(storage, buffer_sequence));
  507. }
  508. private:
  509. native_buffer_type buffers_[2];
  510. std::size_t total_buffer_size_;
  511. };
  512. template <typename Buffer, typename Elem>
  513. class buffer_sequence_adapter<Buffer, std::array<Elem, 2>>
  514. : buffer_sequence_adapter_base
  515. {
  516. public:
  517. enum { is_single_buffer = false };
  518. enum { is_registered_buffer = false };
  519. explicit buffer_sequence_adapter(
  520. const std::array<Elem, 2>& buffer_sequence)
  521. {
  522. init_native_buffer(buffers_[0], Buffer(buffer_sequence[0]));
  523. init_native_buffer(buffers_[1], Buffer(buffer_sequence[1]));
  524. total_buffer_size_ = buffer_sequence[0].size() + buffer_sequence[1].size();
  525. }
  526. native_buffer_type* buffers()
  527. {
  528. return buffers_;
  529. }
  530. std::size_t count() const
  531. {
  532. return 2;
  533. }
  534. std::size_t total_size() const
  535. {
  536. return total_buffer_size_;
  537. }
  538. registered_buffer_id registered_id() const
  539. {
  540. return registered_buffer_id();
  541. }
  542. bool all_empty() const
  543. {
  544. return total_buffer_size_ == 0;
  545. }
  546. static bool all_empty(const std::array<Elem, 2>& buffer_sequence)
  547. {
  548. return buffer_sequence[0].size() == 0 && buffer_sequence[1].size() == 0;
  549. }
  550. static void validate(const std::array<Elem, 2>& buffer_sequence)
  551. {
  552. buffer_sequence[0].data();
  553. buffer_sequence[1].data();
  554. }
  555. static Buffer first(const std::array<Elem, 2>& buffer_sequence)
  556. {
  557. return Buffer(buffer_sequence[0].size() != 0
  558. ? buffer_sequence[0] : buffer_sequence[1]);
  559. }
  560. enum { linearisation_storage_size = 8192 };
  561. static Buffer linearise(const std::array<Elem, 2>& buffer_sequence,
  562. const boost::asio::mutable_buffer& storage)
  563. {
  564. if (buffer_sequence[0].size() == 0)
  565. return Buffer(buffer_sequence[1]);
  566. if (buffer_sequence[1].size() == 0)
  567. return Buffer(buffer_sequence[0]);
  568. return Buffer(storage.data(),
  569. boost::asio::buffer_copy(storage, buffer_sequence));
  570. }
  571. private:
  572. native_buffer_type buffers_[2];
  573. std::size_t total_buffer_size_;
  574. };
  575. } // namespace detail
  576. } // namespace asio
  577. } // namespace boost
  578. #include <boost/asio/detail/pop_options.hpp>
  579. #if defined(BOOST_ASIO_HEADER_ONLY)
  580. # include <boost/asio/detail/impl/buffer_sequence_adapter.ipp>
  581. #endif // defined(BOOST_ASIO_HEADER_ONLY)
  582. #endif // BOOST_ASIO_DETAIL_BUFFER_SEQUENCE_ADAPTER_HPP