pipe.hpp 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631
  1. // Copyright (c) 2006, 2007 Julio M. Merino Vidal
  2. // Copyright (c) 2008 Ilya Sokolov, Boris Schaeling
  3. // Copyright (c) 2009 Boris Schaeling
  4. // Copyright (c) 2010 Felipe Tanus, Boris Schaeling
  5. // Copyright (c) 2011, 2012 Jeff Flinn, Boris Schaeling
  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. #ifndef BOOST_PROCESS_PIPE_HPP
  10. #define BOOST_PROCESS_PIPE_HPP
  11. #include <boost/config.hpp>
  12. #include <boost/process/detail/config.hpp>
  13. #include <streambuf>
  14. #include <istream>
  15. #include <ostream>
  16. #include <vector>
  17. #if defined(BOOST_POSIX_API)
  18. #include <boost/process/detail/posix/basic_pipe.hpp>
  19. #elif defined(BOOST_WINDOWS_API)
  20. #include <boost/process/detail/windows/basic_pipe.hpp>
  21. #endif
  22. namespace boost { namespace process {
  23. using ::boost::process::detail::api::basic_pipe;
  24. #if defined(BOOST_PROCESS_DOXYGEN)
  25. /** Class implementation of a pipe.
  26. *
  27. */
  28. template<class CharT, class Traits = std::char_traits<CharT>>
  29. class basic_pipe
  30. {
  31. public:
  32. typedef CharT char_type ;
  33. typedef Traits traits_type;
  34. typedef typename Traits::int_type int_type ;
  35. typedef typename Traits::pos_type pos_type ;
  36. typedef typename Traits::off_type off_type ;
  37. typedef ::boost::detail::winapi::HANDLE_ native_handle;
  38. /// Default construct the pipe. Will be opened.
  39. basic_pipe();
  40. ///Construct a named pipe.
  41. inline explicit basic_pipe(const std::string & name);
  42. /** Copy construct the pipe.
  43. * \note Duplicated the handles.
  44. */
  45. inline basic_pipe(const basic_pipe& p);
  46. /** Move construct the pipe. */
  47. basic_pipe(basic_pipe&& lhs);
  48. /** Copy assign the pipe.
  49. * \note Duplicated the handles.
  50. */
  51. inline basic_pipe& operator=(const basic_pipe& p);
  52. /** Move assign the pipe. */
  53. basic_pipe& operator=(basic_pipe&& lhs);
  54. /** Destructor closes the handles. */
  55. ~basic_pipe();
  56. /** Get the native handle of the source. */
  57. native_handle native_source() const;
  58. /** Get the native handle of the sink. */
  59. native_handle native_sink () const;
  60. /** Assign a new value to the source */
  61. void assign_source(native_handle h);
  62. /** Assign a new value to the sink */
  63. void assign_sink (native_handle h);
  64. ///Write data to the pipe.
  65. int_type write(const char_type * data, int_type count);
  66. ///Read data from the pipe.
  67. int_type read(char_type * data, int_type count);
  68. ///Check if the pipe is open.
  69. bool is_open();
  70. ///Close the pipe
  71. void close();
  72. };
  73. #endif
  74. typedef basic_pipe<char> pipe;
  75. typedef basic_pipe<wchar_t> wpipe;
  76. /** Implementation of the stream buffer for a pipe.
  77. */
  78. template<
  79. class CharT,
  80. class Traits = std::char_traits<CharT>
  81. >
  82. struct basic_pipebuf : std::basic_streambuf<CharT, Traits>
  83. {
  84. typedef basic_pipe<CharT, Traits> pipe_type;
  85. typedef CharT char_type ;
  86. typedef Traits traits_type;
  87. typedef typename Traits::int_type int_type ;
  88. typedef typename Traits::pos_type pos_type ;
  89. typedef typename Traits::off_type off_type ;
  90. constexpr static int default_buffer_size = BOOST_PROCESS_PIPE_SIZE;
  91. ///Default constructor, will also construct the pipe.
  92. basic_pipebuf() : _write(default_buffer_size), _read(default_buffer_size)
  93. {
  94. this->setg(_read.data(), _read.data()+ 128, _read.data() + 128);
  95. this->setp(_write.data(), _write.data() + _write.size());
  96. }
  97. ///Copy Constructor.
  98. basic_pipebuf(const basic_pipebuf & ) = default;
  99. ///Move Constructor
  100. basic_pipebuf(basic_pipebuf && ) = default;
  101. ///Destructor -> writes the frest of the data
  102. ~basic_pipebuf()
  103. {
  104. try
  105. {
  106. if (basic_pipebuf::is_open())
  107. basic_pipebuf::overflow(Traits::eof());
  108. }
  109. catch (process_error & )
  110. {
  111. }
  112. }
  113. ///Move construct from a pipe.
  114. basic_pipebuf(pipe_type && p) : _pipe(std::move(p)),
  115. _write(default_buffer_size),
  116. _read(default_buffer_size)
  117. {
  118. this->setg(_read.data(), _read.data()+ 128, _read.data() + 128);
  119. this->setp(_write.data(), _write.data() + _write.size());
  120. }
  121. ///Construct from a pipe.
  122. basic_pipebuf(const pipe_type & p) : _pipe(p),
  123. _write(default_buffer_size),
  124. _read(default_buffer_size)
  125. {
  126. this->setg(_read.data(), _read.data()+ 128, _read.data() + 128);
  127. this->setp(_write.data(), _write.data() + _write.size());
  128. }
  129. ///Copy assign.
  130. basic_pipebuf& operator=(const basic_pipebuf & ) = delete;
  131. ///Move assign.
  132. basic_pipebuf& operator=(basic_pipebuf && ) = default;
  133. ///Move assign a pipe.
  134. basic_pipebuf& operator=(pipe_type && p)
  135. {
  136. _pipe = std::move(p);
  137. return *this;
  138. }
  139. ///Copy assign a pipe.
  140. basic_pipebuf& operator=(const pipe_type & p)
  141. {
  142. _pipe = p;
  143. return *this;
  144. }
  145. ///Writes characters to the associated output sequence from the put area
  146. int_type overflow(int_type ch = traits_type::eof()) override
  147. {
  148. if (_pipe.is_open() && (ch != traits_type::eof()))
  149. {
  150. if (this->pptr() == this->epptr())
  151. {
  152. bool wr = this->_write_impl();
  153. if (wr)
  154. {
  155. *this->pptr() = ch;
  156. this->pbump(1);
  157. return ch;
  158. }
  159. }
  160. else
  161. {
  162. *this->pptr() = ch;
  163. this->pbump(1);
  164. if (this->_write_impl())
  165. return ch;
  166. }
  167. }
  168. else if (ch == traits_type::eof())
  169. this->sync();
  170. return traits_type::eof();
  171. }
  172. ///Synchronizes the buffers with the associated character sequence
  173. int sync() override { return this->_write_impl() ? 0 : -1; }
  174. ///Reads characters from the associated input sequence to the get area
  175. int_type underflow() override
  176. {
  177. if (!_pipe.is_open())
  178. return traits_type::eof();
  179. if (this->egptr() == &_read.back()) //ok, so we're at the end of the buffer
  180. this->setg(_read.data(), _read.data()+ 10, _read.data() + 10);
  181. auto len = &_read.back() - this->egptr() ;
  182. auto res = _pipe.read(
  183. this->egptr(),
  184. static_cast<typename pipe_type::int_type>(len));
  185. if (res == 0)
  186. return traits_type::eof();
  187. this->setg(this->eback(), this->gptr(), this->egptr() + res);
  188. auto val = *this->gptr();
  189. return traits_type::to_int_type(val);
  190. }
  191. ///Set the pipe of the streambuf.
  192. void pipe(pipe_type&& p) {_pipe = std::move(p); }
  193. ///Set the pipe of the streambuf.
  194. void pipe(const pipe_type& p) {_pipe = p; }
  195. ///Get a reference to the pipe.
  196. pipe_type & pipe() & {return _pipe;}
  197. ///Get a const reference to the pipe.
  198. const pipe_type &pipe() const & {return _pipe;}
  199. ///Get a rvalue reference to the pipe. Qualified as rvalue.
  200. pipe_type && pipe() && {return std::move(_pipe);}
  201. ///Check if the pipe is open
  202. bool is_open() const {return _pipe.is_open(); }
  203. ///Open a new pipe
  204. basic_pipebuf<CharT, Traits>* open()
  205. {
  206. if (is_open())
  207. return nullptr;
  208. _pipe = pipe();
  209. return this;
  210. }
  211. ///Open a new named pipe
  212. basic_pipebuf<CharT, Traits>* open(const std::string & name)
  213. {
  214. if (is_open())
  215. return nullptr;
  216. _pipe = pipe(name);
  217. return this;
  218. }
  219. ///Flush the buffer & close the pipe
  220. basic_pipebuf<CharT, Traits>* close()
  221. {
  222. if (!is_open())
  223. return nullptr;
  224. overflow(Traits::eof());
  225. return this;
  226. }
  227. private:
  228. pipe_type _pipe;
  229. std::vector<char_type> _write;
  230. std::vector<char_type> _read;
  231. bool _write_impl()
  232. {
  233. if (!_pipe.is_open())
  234. return false;
  235. auto base = this->pbase();
  236. if (base == this->pptr())
  237. return true;
  238. std::ptrdiff_t wrt = _pipe.write(base,
  239. static_cast<typename pipe_type::int_type>(this->pptr() - base));
  240. std::ptrdiff_t diff = this->pptr() - base;
  241. if (wrt < diff)
  242. std::move(base + wrt, base + diff, base);
  243. else if (wrt == 0) //broken pipe
  244. return false;
  245. this->pbump(static_cast<int>(-wrt));
  246. return true;
  247. }
  248. };
  249. typedef basic_pipebuf<char> pipebuf;
  250. typedef basic_pipebuf<wchar_t> wpipebuf;
  251. /** Implementation of a reading pipe stream.
  252. *
  253. */
  254. template<
  255. class CharT,
  256. class Traits = std::char_traits<CharT>
  257. >
  258. class basic_ipstream : public std::basic_istream<CharT, Traits>
  259. {
  260. mutable basic_pipebuf<CharT, Traits> _buf;
  261. public:
  262. typedef basic_pipe<CharT, Traits> pipe_type;
  263. typedef CharT char_type ;
  264. typedef Traits traits_type;
  265. typedef typename Traits::int_type int_type ;
  266. typedef typename Traits::pos_type pos_type ;
  267. typedef typename Traits::off_type off_type ;
  268. ///Get access to the underlying stream_buf
  269. basic_pipebuf<CharT, Traits>* rdbuf() const {return &_buf;};
  270. ///Default constructor.
  271. basic_ipstream() : std::basic_istream<CharT, Traits>(nullptr)
  272. {
  273. std::basic_istream<CharT, Traits>::rdbuf(&_buf);
  274. };
  275. ///Copy constructor.
  276. basic_ipstream(const basic_ipstream & ) = delete;
  277. ///Move constructor.
  278. basic_ipstream(basic_ipstream && lhs) : std::basic_istream<CharT, Traits>(nullptr), _buf(std::move(lhs._buf))
  279. {
  280. std::basic_istream<CharT, Traits>::rdbuf(&_buf);
  281. }
  282. ///Move construct from a pipe.
  283. basic_ipstream(pipe_type && p) : std::basic_istream<CharT, Traits>(nullptr), _buf(std::move(p))
  284. {
  285. std::basic_istream<CharT, Traits>::rdbuf(&_buf);
  286. }
  287. ///Copy construct from a pipe.
  288. basic_ipstream(const pipe_type & p) : std::basic_istream<CharT, Traits>(nullptr), _buf(p)
  289. {
  290. std::basic_istream<CharT, Traits>::rdbuf(&_buf);
  291. }
  292. ///Copy assignment.
  293. basic_ipstream& operator=(const basic_ipstream & ) = delete;
  294. ///Move assignment
  295. basic_ipstream& operator=(basic_ipstream && lhs)
  296. {
  297. std::basic_istream<CharT, Traits>::operator=(std::move(lhs));
  298. _buf = std::move(lhs._buf);
  299. std::basic_istream<CharT, Traits>::rdbuf(&_buf);
  300. return *this;
  301. };
  302. ///Move assignment of a pipe.
  303. basic_ipstream& operator=(pipe_type && p)
  304. {
  305. _buf = std::move(p);
  306. return *this;
  307. }
  308. ///Copy assignment of a pipe.
  309. basic_ipstream& operator=(const pipe_type & p)
  310. {
  311. _buf = p;
  312. return *this;
  313. }
  314. ///Set the pipe of the streambuf.
  315. void pipe(pipe_type&& p) {_buf.pipe(std::move(p)); }
  316. ///Set the pipe of the streambuf.
  317. void pipe(const pipe_type& p) {_buf.pipe(p); }
  318. ///Get a reference to the pipe.
  319. pipe_type & pipe() & {return _buf.pipe();}
  320. ///Get a const reference to the pipe.
  321. const pipe_type &pipe() const & {return _buf.pipe();}
  322. ///Get a rvalue reference to the pipe. Qualified as rvalue.
  323. pipe_type && pipe() && {return std::move(_buf).pipe();}
  324. ///Check if the pipe is open
  325. bool is_open() const {return _buf.is_open();}
  326. ///Open a new pipe
  327. void open()
  328. {
  329. if (_buf.open() == nullptr)
  330. this->setstate(std::ios_base::failbit);
  331. else
  332. this->clear();
  333. }
  334. ///Open a new named pipe
  335. void open(const std::string & name)
  336. {
  337. if (_buf.open() == nullptr)
  338. this->setstate(std::ios_base::failbit);
  339. else
  340. this->clear();
  341. }
  342. ///Flush the buffer & close the pipe
  343. void close()
  344. {
  345. if (_buf.close() == nullptr)
  346. this->setstate(std::ios_base::failbit);
  347. }
  348. };
  349. typedef basic_ipstream<char> ipstream;
  350. typedef basic_ipstream<wchar_t> wipstream;
  351. /** Implementation of a write pipe stream.
  352. *
  353. */
  354. template<
  355. class CharT,
  356. class Traits = std::char_traits<CharT>
  357. >
  358. class basic_opstream : public std::basic_ostream<CharT, Traits>
  359. {
  360. mutable basic_pipebuf<CharT, Traits> _buf;
  361. public:
  362. typedef basic_pipe<CharT, Traits> pipe_type;
  363. typedef CharT char_type ;
  364. typedef Traits traits_type;
  365. typedef typename Traits::int_type int_type ;
  366. typedef typename Traits::pos_type pos_type ;
  367. typedef typename Traits::off_type off_type ;
  368. ///Get access to the underlying stream_buf
  369. basic_pipebuf<CharT, Traits>* rdbuf() const {return &_buf;};
  370. ///Default constructor.
  371. basic_opstream() : std::basic_ostream<CharT, Traits>(nullptr)
  372. {
  373. std::basic_ostream<CharT, Traits>::rdbuf(&_buf);
  374. };
  375. ///Copy constructor.
  376. basic_opstream(const basic_opstream & ) = delete;
  377. ///Move constructor.
  378. basic_opstream(basic_opstream && lhs) : std::basic_ostream<CharT, Traits>(nullptr), _buf(std::move(lhs._buf))
  379. {
  380. std::basic_ostream<CharT, Traits>::rdbuf(&_buf);
  381. }
  382. ///Move construct from a pipe.
  383. basic_opstream(pipe_type && p) : std::basic_ostream<CharT, Traits>(nullptr), _buf(std::move(p))
  384. {
  385. std::basic_ostream<CharT, Traits>::rdbuf(&_buf);
  386. };
  387. ///Copy construct from a pipe.
  388. basic_opstream(const pipe_type & p) : std::basic_ostream<CharT, Traits>(nullptr), _buf(p)
  389. {
  390. std::basic_ostream<CharT, Traits>::rdbuf(&_buf);
  391. };
  392. ///Copy assignment.
  393. basic_opstream& operator=(const basic_opstream & ) = delete;
  394. ///Move assignment
  395. basic_opstream& operator=(basic_opstream && lhs)
  396. {
  397. std::basic_ostream<CharT, Traits>::operator=(std::move(lhs));
  398. _buf = std::move(lhs._buf);
  399. std::basic_ostream<CharT, Traits>::rdbuf(&_buf);
  400. return *this;
  401. };
  402. ///Move assignment of a pipe.
  403. basic_opstream& operator=(pipe_type && p)
  404. {
  405. _buf = std::move(p);
  406. return *this;
  407. }
  408. ///Copy assignment of a pipe.
  409. basic_opstream& operator=(const pipe_type & p)
  410. {
  411. _buf = p;
  412. return *this;
  413. }
  414. ///Set the pipe of the streambuf.
  415. void pipe(pipe_type&& p) {_buf.pipe(std::move(p)); }
  416. ///Set the pipe of the streambuf.
  417. void pipe(const pipe_type& p) {_buf.pipe(p); }
  418. ///Get a reference to the pipe.
  419. pipe_type & pipe() & {return _buf.pipe();}
  420. ///Get a const reference to the pipe.
  421. const pipe_type &pipe() const & {return _buf.pipe();}
  422. ///Get a rvalue reference to the pipe. Qualified as rvalue.
  423. pipe_type && pipe() && {return std::move(_buf).pipe();}
  424. ///Open a new pipe
  425. void open()
  426. {
  427. if (_buf.open() == nullptr)
  428. this->setstate(std::ios_base::failbit);
  429. else
  430. this->clear();
  431. }
  432. ///Open a new named pipe
  433. void open(const std::string & name)
  434. {
  435. if (_buf.open() == nullptr)
  436. this->setstate(std::ios_base::failbit);
  437. else
  438. this->clear();
  439. }
  440. ///Flush the buffer & close the pipe
  441. void close()
  442. {
  443. if (_buf.close() == nullptr)
  444. this->setstate(std::ios_base::failbit);
  445. }
  446. };
  447. typedef basic_opstream<char> opstream;
  448. typedef basic_opstream<wchar_t> wopstream;
  449. /** Implementation of a read-write pipe stream.
  450. *
  451. */
  452. template<
  453. class CharT,
  454. class Traits = std::char_traits<CharT>
  455. >
  456. class basic_pstream : public std::basic_iostream<CharT, Traits>
  457. {
  458. mutable basic_pipebuf<CharT, Traits> _buf;
  459. public:
  460. typedef basic_pipe<CharT, Traits> pipe_type;
  461. typedef CharT char_type ;
  462. typedef Traits traits_type;
  463. typedef typename Traits::int_type int_type ;
  464. typedef typename Traits::pos_type pos_type ;
  465. typedef typename Traits::off_type off_type ;
  466. ///Get access to the underlying stream_buf
  467. basic_pipebuf<CharT, Traits>* rdbuf() const {return &_buf;};
  468. ///Default constructor.
  469. basic_pstream() : std::basic_iostream<CharT, Traits>(nullptr)
  470. {
  471. std::basic_iostream<CharT, Traits>::rdbuf(&_buf);
  472. };
  473. ///Copy constructor.
  474. basic_pstream(const basic_pstream & ) = delete;
  475. ///Move constructor.
  476. basic_pstream(basic_pstream && lhs) : std::basic_iostream<CharT, Traits>(nullptr), _buf(std::move(lhs._buf))
  477. {
  478. std::basic_iostream<CharT, Traits>::rdbuf(&_buf);
  479. }
  480. ///Move construct from a pipe.
  481. basic_pstream(pipe_type && p) : std::basic_iostream<CharT, Traits>(nullptr), _buf(std::move(p))
  482. {
  483. std::basic_iostream<CharT, Traits>::rdbuf(&_buf);
  484. };
  485. ///Copy construct from a pipe.
  486. basic_pstream(const pipe_type & p) : std::basic_iostream<CharT, Traits>(nullptr), _buf(p)
  487. {
  488. std::basic_iostream<CharT, Traits>::rdbuf(&_buf);
  489. };
  490. ///Copy assignment.
  491. basic_pstream& operator=(const basic_pstream & ) = delete;
  492. ///Move assignment
  493. basic_pstream& operator=(basic_pstream && lhs)
  494. {
  495. std::basic_istream<CharT, Traits>::operator=(std::move(lhs));
  496. _buf = std::move(lhs._buf);
  497. std::basic_iostream<CharT, Traits>::rdbuf(&_buf);
  498. return *this;
  499. };
  500. ///Move assignment of a pipe.
  501. basic_pstream& operator=(pipe_type && p)
  502. {
  503. _buf = std::move(p);
  504. return *this;
  505. }
  506. ///Copy assignment of a pipe.
  507. basic_pstream& operator=(const pipe_type & p)
  508. {
  509. _buf = p;
  510. return *this;
  511. }
  512. ///Set the pipe of the streambuf.
  513. void pipe(pipe_type&& p) {_buf.pipe(std::move(p)); }
  514. ///Set the pipe of the streambuf.
  515. void pipe(const pipe_type& p) {_buf.pipe(p); }
  516. ///Get a reference to the pipe.
  517. pipe_type & pipe() & {return _buf.pipe();}
  518. ///Get a const reference to the pipe.
  519. const pipe_type &pipe() const & {return _buf.pipe();}
  520. ///Get a rvalue reference to the pipe. Qualified as rvalue.
  521. pipe_type && pipe() && {return std::move(_buf).pipe();}
  522. ///Open a new pipe
  523. void open()
  524. {
  525. if (_buf.open() == nullptr)
  526. this->setstate(std::ios_base::failbit);
  527. else
  528. this->clear();
  529. }
  530. ///Open a new named pipe
  531. void open(const std::string & name)
  532. {
  533. if (_buf.open() == nullptr)
  534. this->setstate(std::ios_base::failbit);
  535. else
  536. this->clear();
  537. }
  538. ///Flush the buffer & close the pipe
  539. void close()
  540. {
  541. if (_buf.close() == nullptr)
  542. this->setstate(std::ios_base::failbit);
  543. }
  544. };
  545. typedef basic_pstream<char> pstream;
  546. typedef basic_pstream<wchar_t> wpstream;
  547. }}
  548. #endif