2
0
mirror of https://github.com/boostorg/process.git synced 2026-01-19 16:32:15 +00:00

Compare commits

...

120 Commits

Author SHA1 Message Date
Klemens Morgenstern
1dcf21fbde doc typo fixes 2026-01-11 07:32:02 +08:00
Klemens Morgenstern
2a41d0a0dc batch file execution is forbidden by default 2025-10-21 21:42:14 -07:00
Klemens Morgenstern
dc00bf81d6 Fixes args & inherited handles. 2025-10-21 21:41:11 -07:00
Klemens Morgenstern
47b5c3c191 [win] Added escaping for \ followed by space 2025-10-21 21:41:11 -07:00
Klemens Morgenstern
60affa362c Reworked arg handling on windows (v2) 2025-10-21 21:41:11 -07:00
Klemens Morgenstern
aa40c138ed Windows arg escape is handling internal quotes. 2025-10-21 21:41:11 -07:00
Klemens Morgenstern
c5986d7f57 Added test for combined stdout/stderr
Addresses #522.
2025-10-21 21:41:11 -07:00
Klemens Morgenstern
1e572e1756 Added more docs about pipes & process_stdio.
Closes #522.
2025-10-21 15:30:13 +08:00
Konvicka Filip
635c226066 Fix: corrected empty double quotes being added to cmd.exe /c on Windows with bp::shell and bp::args (caused by PR #256) 2025-10-21 14:46:50 +08:00
EelisVP
773ac747d5 Fix 'unused variable' warning 2025-10-21 10:58:45 +08:00
Klemens Morgenstern
322f581d1f Increased version range to 3.31 2025-10-09 23:38:18 +08:00
Klemens Morgenstern
9df0ee099b target_link_Libraries signature fix 2025-10-09 21:25:32 +08:00
Klemens Morgenstern
01c9a5b60f removed v2/test_impl target 2025-10-09 09:29:37 +08:00
Klemens Morgenstern
ed7099687a Removed filesystem::path from ABI
Closes #516.
2025-10-06 13:17:13 +08:00
chn
7fb5049feb fix typo in stdio move constructor 2025-10-06 12:49:38 +08:00
Klemens Morgenstern
02e14e8fff Fixed cmake for tests
Closes #515
2025-10-06 12:44:33 +08:00
Klemens Morgenstern
484d6e7a90 added test for special args to tests 2025-10-06 12:44:33 +08:00
Alexander Grund
878a9e6ee9 Fix required CMake version 2025-10-03 10:12:02 +08:00
Klemens Morgenstern
1bfe21baa3 Failed pidfd_open causes an exception
Closes #513.
2025-09-07 17:44:47 +08:00
Klemens Morgenstern
1765cd57bb Launchers use _exit instead of exit on error.
Closes #514
2025-09-07 17:44:47 +08:00
Alexander Grund
7212471b57 Update Link to regression test matrix in README 2025-09-07 17:30:30 +08:00
Klemens Morgenstern
5597aa0055 changed env example for windows wchar_t. 2025-07-01 18:59:19 +08:00
Klemens Morgenstern
31d6b5c9f8 process_handle.async_wait accepts ref to exit_code
Closes #503.
2025-07-01 18:59:19 +08:00
Klemens Morgenstern
f5c83eb9c5 wait checks the error code first.
See #499.
2025-07-01 18:59:19 +08:00
Klemens Morgenstern
224e3cf9aa [windows] fixed escaping of path without args.
Closes #501. Credit to @melak47 for the solution.
2025-07-01 18:59:19 +08:00
Klemens Morgenstern
bd450f9831 fixed wrong comment/doc using .stderr
Closes #500
2025-06-26 23:17:08 +08:00
Klemens Morgenstern
c72650df30 added example for modifying inherited environment. 2025-06-26 22:48:16 +08:00
Klemens Morgenstern
0c3c79672f added v1.hpp. 2025-06-26 22:14:16 +08:00
Klemens Morgenstern
a7e4fe99c1 stdio.hpp name fix. 2025-06-21 00:54:03 +08:00
Klemens Morgenstern
f9fd327546 added const_iterator alias to current_view.
Closes #497.
2025-06-21 00:37:03 +08:00
Klemens Morgenstern
f372a9a119 fixed MultiByteToWideChar use for empty strings
Closes #495
2025-06-21 00:25:10 +08:00
Klemens Morgenstern
921bd599b2 Fixed wrong type in probe_on_error on windows.
Closes #491.
2025-06-21 00:02:12 +08:00
Klemens Morgenstern
3999facdd3 unused variable fixes. 2025-06-21 00:00:22 +08:00
high on tantor
0ea2eaed27 Support child_pids() Even When PROC_PPID_ONLY is Undefined on Mac
Needs testing...
2025-06-20 23:59:27 +08:00
high on tantor
677d94f3a2 Correct Samuel Venable Link In Acknowledgements Document 2025-06-20 23:56:40 +08:00
Klemens Morgenstern
b8b8d27ac5 fix STD_INPUT_HANDLE issue in stdio.hpp 2025-06-20 23:56:01 +08:00
Dirk Stolle
15555b9664 Fix some typos 2025-05-06 10:11:41 +08:00
Petter Reinholdtsen
09555dac5f Add cmd & env support on GNU/Hurd 2025-05-05 22:32:56 +08:00
Petter Reinholdtsen
818e11672e Fix build on systems without cmd() implementation 2025-05-05 22:31:38 +08:00
Dirk Stolle
06946018d6 Remove Ubuntu 20.04 builds from CI
The Ubuntu 20.04 image on GitHub Actions has been unavailable
since 2025-04-15. See <https://github.com/actions/runner-images/issues/11101>
for more information on the deprecation and removal.

Therefore all build jobs that use the Ubuntu 20.04 runner image
of GHA will fail and have to be replaced by newer images or have
to move into Ubuntu 20.04 containers.
2025-05-05 22:30:26 +08:00
Klemens Morgenstern
cd1621b197 fixed major resume/suspend typo
Closes #481.
2025-04-28 23:57:20 +08:00
Klemens Morgenstern
1baccf76cd pipe bindings use a type_trait. 2025-04-15 00:31:56 +08:00
Klemens Morgenstern
06595a2070 added BOOST_PROCESS_V2_DISABLE_SIGNALSET option 2025-04-14 23:55:23 +08:00
Klemens Morgenstern
7e712985c1 added BOOST_PROCESS_V2_PIPEFORK option 2025-04-14 23:55:23 +08:00
Klemens Morgenstern
da08060021 Set ENOTSUP when PROC_PPID_ONLY is undefined
closes #452
2025-04-14 23:54:14 +08:00
Klemens Morgenstern
afdbab734e Removed char_count
Closes #473
2025-04-14 23:53:30 +08:00
Klemens Morgenstern
9dcd1a2775 added duplication check for SIGINFO
Closes #474
2025-04-14 23:51:35 +08:00
Osyotr
5756891558 Fix wide strings conversion on POSIX
This commit effectively reverts #179 which shouldn't have been merged in the first place. See https://github.com/boostorg/filesystem/pull/163#issuecomment-786794483 for more info.
2025-04-14 23:49:00 +08:00
RK-BFX
1d6c9ed0ec Fix conflicting pipe name in independent plug-in DLLs
Include numerical representation of local static variable's address into the pipe name to discriminate Boost.Process instances in independent DLLs.

Fixes #476

Also (auto-)remove excessive concurrent empty lines.
2025-04-14 23:48:00 +08:00
Yury Bura
a941c8e89c Add BOOST_PROCESS_USE_STD_FS option 2025-04-14 23:46:36 +08:00
Klemens Morgenstern
89d2cc325a Update index.html
Fixes #479
2025-04-11 23:31:02 +08:00
js-nano
e637f8483d Fix up usage of std::move_backward
The destinations should point to the *end* of the destination range

https://en.cppreference.com/w/cpp/algorithm/move_backward
2025-03-06 17:39:28 +08:00
Klemens Morgenstern
94aa3b6b43 fixed environ for OSX
closes #453
2025-02-27 10:13:22 +08:00
Klemens Morgenstern
d7df711628 remove :: from dirfd
closes #461
2025-02-27 10:12:55 +08:00
SimonMaracine
8ae055bfbd Remove optional dependency on filesystem when not meant to be
Build previously failed when BOOST_PROCESS_USE_STD_FS was ON, because filesystem was linked to regardless.
2025-02-21 08:09:42 +08:00
Jonas Greitemann
ab28b511a9 fix v1 tests after v2 became the default
As of 2ccd97cd48, v2 is the default when using the unversioned includes.
This broke the v1 tests which were still using those.
2025-02-21 08:08:36 +08:00
SimonMaracine
529fb1e222 Fix include directives from boost/process/posix/*.hpp having wrong paths 2025-02-21 08:08:17 +08:00
Jens Diewald
d534ed6c34 Fix small yet confusing Typo in Doc 2025-02-05 19:27:55 +08:00
Dirk Stolle
bb375f50bd Fix several typos 2025-01-23 07:45:16 +08:00
Dirk Stolle
c329e05fb6 chore: remove executable flags from .cpp files
See <https://github.com/boostorg/admin/issues/47#issuecomment-2575165830>.

[ci skip]
2025-01-21 21:55:11 +08:00
Ryan Zoeller
b781b49a97 doc: fix typo in stdio 2025-01-21 07:40:31 +08:00
Klemens Morgenstern
a2d2753aa8 zombie process fixes
closes #445, #447
2025-01-13 09:31:48 +08:00
Klemens Morgenstern
1b5272a9e1 changed cwd comparison to equivalent. 2025-01-13 08:36:36 +08:00
Jonas Greitemann
e842a060f1 implement move operations for process_io_binding and delete copy operations
This makes the test added in the previous commit pass.
2025-01-13 08:13:33 +08:00
Jonas Greitemann
4bb842564f add a (failing) test for process_stdio move semantics
This test currently fails on POSIX, as `process_io_binding` does not
explicitly implement move operations but holds on to a file descriptor
which exhibits reference semantics and has a non-trivial destructor.

The same test should pass on Windows as the Windows implementation makes
use of `unique_ptr` which gives it correct move semantics by virtue of
the rule of zero.
2025-01-13 08:13:33 +08:00
Jonas Greitemann
359820097b add test case for initializing process_stdio with complementary pipe ends
`process_stdio` holds on to the handles for `in`/`out`/`err`. In case of
pipes, `in` needs the handles of a `readable_pipe`, whereas `out` and
`err` need the handles of `writable_pipe`s. So far, the tests all create
a new pair using `connect_pipe`, pass the "correct" end into
`process_stdio`, and use the other end to interface with the process.

However, `process_io_binding` also supports construction from the
complementary pipe types, i.e., constructing `in`'s binding from a
`writable_pipe` and `out`/`err`'s bindings from `readable_pipe`s.
In this case, the constructor will create the corresponding pipe itself
and keep ownership of it. This mode was thus far not tested.
2025-01-13 08:13:33 +08:00
Klemens Morgenstern
b529769eb5 removed boost::system:: scope spec for error_code. 2024-12-20 20:53:29 +08:00
Klemens Morgenstern
d75ffb30ee windows link fixes. 2024-12-20 20:53:29 +08:00
Klemens Morgenstern
a6f2a1d005 windows fixes. 2024-12-20 20:53:29 +08:00
Klemens Morgenstern
e1c6a9b09b attempting to fix msvc build. 2024-12-20 20:53:29 +08:00
Klemens Morgenstern
9bd57d66b7 aded missing include to example/env.cpp 2024-12-20 20:53:29 +08:00
Klemens Morgenstern
65251a2316 replace png with svg in install. 2024-12-20 20:53:29 +08:00
Klemens Morgenstern
298b60caca fixed for v2 namespace inlining. 2024-12-20 20:53:29 +08:00
Klemens Morgenstern
3fd8b2608c examples are compiled & included. 2024-12-20 20:53:29 +08:00
Klemens Morgenstern
c33828a166 reference docs 2024-12-20 20:53:29 +08:00
Klemens Morgenstern
2ccd97cd48 made v2 the default 2024-12-20 20:53:29 +08:00
Klemens Morgenstern
7874a04958 switched to asciidoc 2024-12-20 20:53:29 +08:00
Klemens Morgenstern
b5eacaca51 disabled shell for android
Closes #440.
2024-12-20 10:09:54 +08:00
Klemens Morgenstern
2275057574 v2 uses PROC_THREAD_ATTRIBUTE_HANDLE_LIST for limiting fd
thanks @NVCherney for bring this to my attention.
2024-12-20 09:52:57 +08:00
Klemens Morgenstern
09a978d896 disabled gcc11 on freebsd 2024-12-20 09:50:51 +08:00
مهدي شينون (Mehdi Chinoune)
5cfdf3ec4c Fix building with CMake on MinGW-w64. (#439) 2024-12-20 09:49:55 +08:00
Alexander Grund
c0a23ae2c3 Fix Github Actions CI (#437)
* Fix Github Actions CI

Containerize old compiler jobs
Fix Node20 Glibc
Reformat job list to make it easier to update

* Fix install of packages

* Remove macos-12
2024-12-20 09:49:30 +08:00
tomy2105
64fc05c55d Add ability to auto link process library 2024-12-20 09:45:27 +08:00
Klemens Morgenstern
0f9dd52f02 added BOOST_PROCESS_V2_DISABLE_NOTIFY_FORK
See #430
2024-12-13 12:26:46 +08:00
Klemens Morgenstern
3fe2033062 fixes #431 2024-12-13 12:26:25 +08:00
Klemens Morgenstern
662c0b10e3 warning fixes
Closes #436, #437
2024-12-13 11:58:39 +08:00
Klemens Morgenstern
fa83c2f9ff fixes the exit-code error on osx builds. 2024-11-19 07:41:31 +08:00
Klemens Morgenstern
9925e82a5f fixed UB in limit_handles.
Closes #200.
2024-11-19 07:41:31 +08:00
Samuel Venable
7f03295c93 Solaris Fixes (#425)
* solaris fixes
2024-11-19 07:41:31 +08:00
Klemens Morgenstern
64c4cdac83 windows gcc compile fix 2024-11-13 08:26:07 +08:00
Klemens Morgenstern
58586e420c added deprecation notice for v1. 2024-10-30 09:05:20 +08:00
Samuel Venable
7e5dd4075f bp2::ext::env() Fixes (#415)
* Implement OpenBSD Executable PatH
* Static Cast Device and iNode
* Add Name Spaces to Exe Checker
* Strings to File System Paths

---------

Co-authored-by: freebsd <freebsd@freebsd.lan>
2024-10-30 09:05:20 +08:00
Samuel Venable
3ad68a3f2a [OpenBSD] Add Missing Semicolons (#414)
* [OpenBSD] Add Missing Semicolons
2024-10-30 09:05:20 +08:00
Samuel Venable
8a8ca8b7ab OpenBSD fix & Solaris fixes
[DragonFly BSD] Use Proper CWD From PID Code
2024-10-30 09:05:20 +08:00
Klemens Morgenstern
817128108a changed error macros to require a ; at the end. 2024-10-30 09:05:20 +08:00
Klemens Morgenstern
941e93b587 removed definition of NOMINMAX 2024-10-30 08:09:28 +08:00
Klemens Morgenstern
e827d14542 reduced asio related macro usage. 2024-10-30 08:09:28 +08:00
Klemens Morgenstern
f218a6a6c1 added pthread to test linking for freebsd on v1 as well. 2024-10-30 08:09:28 +08:00
Klemens Morgenstern
11a0d0d7c1 added pthread to test linking for freebsd 2024-10-30 08:09:28 +08:00
Klemens Morgenstern
fdfb5043cb add kvm to process target on bsd 2024-10-30 08:09:28 +08:00
Klemens Morgenstern
e46a514629 replaced deadline_timer with steady_timer. 2024-10-30 08:09:28 +08:00
Klemens Morgenstern
36954338d8 remove test_impl lib 2024-10-30 08:09:28 +08:00
Klemens Morgenstern
a44fd24523 unified cancellation on process.async_wait() 2024-10-30 08:09:28 +08:00
Klemens Morgenstern
eb6b49c090 disabled /boost//coroutine dependent tests 2024-10-30 08:09:28 +08:00
Klemens Morgenstern
928674d2e3 added test async_wait cancellation test. 2024-10-30 08:09:28 +08:00
Klemens Morgenstern
894f371898 typo fixes. 2024-10-30 08:09:28 +08:00
Klemens Morgenstern
7ed1648032 removed filesystem from the compiled lib.
Shuold fix #390.
2024-10-30 08:09:28 +08:00
Klemens Morgenstern
a96f7a04e0 Wrapped proc_info.h functions with IOS check. Using the ext functions will yield a operation_not_supported at runtime.
Closes #401.
2024-10-30 08:09:28 +08:00
Klemens Morgenstern
46b71d5e96 Switched #error to ENOTSUP for ext libs. Should help #413
Closes #358.
2024-10-30 08:09:28 +08:00
Klemens Morgenstern
9f104634a9 Typo fix.
Closes #365
2024-10-30 08:09:28 +08:00
Klemens Morgenstern
c492c93062 Added BOOST_PROCESS_V2_POSIX_FORCE_DISABLE_CLOSE_RANGE
Implements #378.
2024-10-30 08:09:27 +08:00
Klemens Morgenstern
12192d35d3 Applying @sehe's patch.
closes #317
2024-10-30 08:09:27 +08:00
Samuel Venable
f741b0d120 [DragonFly BSD] Use Proper CWD From PID Code 2024-10-30 08:09:27 +08:00
Brad Smith
211a3134b6 Fix building on OpenBSD
OpenBSD does not have close_range() nor does NetBSD.

OpenBSD needs environ like the other *BSD's.

The build was erroring on kp_pid, it looks like p_pid is appropriate.
2024-10-30 08:09:27 +08:00
Klemens Morgenstern
642bd7cf5c removed more faulty V2_DECLs 2024-10-30 08:09:27 +08:00
Julien Schueller
8df45b8f68 Fix undefined reference to ws2_32
else it fails to link on mingw:
```
process_handle_windows.o:process_handle_windows.cpp:(.text+0x25): undefined reference to `_imp__WSACleanup@0'
```
2024-10-30 08:09:27 +08:00
Benjamin Buch
54479a7372 remove dllimport from utf8.hpp to fix MSVC build 2024-10-30 08:09:27 +08:00
René Ferdinand Rivera Morell
9761be99bb Add support for modular build structure. (#389)
* Make the library modular usable.

* Switch to library requirements instead of source. As source puts extra source in install targets.

* Add requires-b2 check to top-level build file.

* Add missing test deps.

* Bump B2 require to 5.2

* Fix duplicate def of boost.process.fs feature.

* Add missing boost_test dependency.

* Move inter-lib dependencies to a project variable and into the build targets.

* Switch to /boost/test//included target for header only mode of Boost.Test.

* Adjust doc build to avoid boost-root references.

* Update build deps.

* Fix link and build of deps.
2024-10-30 08:09:27 +08:00
Klemens Morgenstern
e5e898f363 fixed v1 reference include. 2024-09-26 18:48:51 +08:00
Jackarain
9561ebad1c Fix mingw cross-compile 2024-07-31 08:19:56 +08:00
254 changed files with 5203 additions and 3653 deletions

View File

@@ -14,7 +14,7 @@ windowsglobalimage="cppalliance/dronevs2019"
def main(ctx):
return [
freebsd_cxx("gcc 11 freebsd", "g++-11", buildtype="boost", buildscript="drone", freebsd_version="13.1", environment={'B2_TOOLSET': 'gcc-11', 'B2_CXXSTD': '17,20', 'B2_LINKFLAGS': '-Wl,-rpath=/usr/local/lib/gcc11'}, globalenv=globalenv),
#freebsd_cxx("gcc 11 freebsd", "g++-11", buildtype="boost", buildscript="drone", freebsd_version="13.1", environment={'B2_TOOLSET': 'gcc-11', 'B2_CXXSTD': '17,20', 'B2_LINKFLAGS': '-Wl,-rpath=/usr/local/lib/gcc11'}, globalenv=globalenv),
freebsd_cxx("clang 14 freebsd", "clang++-14", buildtype="boost", buildscript="drone", freebsd_version="13.1", environment={'B2_TOOLSET': 'clang-14', 'B2_CXXSTD': '17,20'}, globalenv=globalenv),
linux_cxx("docs", "", packages="docbook docbook-xml docbook-xsl xsltproc libsaxonhe-java default-jre-headless flex libfl-dev bison unzip rsync", image="cppalliance/droneubuntu1804:1", buildtype="docs", buildscript="drone", environment={"COMMENT": "docs"}, globalenv=globalenv),
linux_cxx("asan", "g++-8", packages="g++-8", buildtype="boost", buildscript="drone", image=linuxglobalimage, environment={'COMMENT': 'asan', 'B2_VARIANT': 'debug', 'B2_TOOLSET': 'gcc-8', 'B2_CXXSTD': '11', 'B2_ASAN': '1', 'B2_DEFINES': 'BOOST_NO_STRESS_TEST=1', 'DRONE_EXTRA_PRIVILEGED': 'True', 'DRONE_JOB_UUID': '356a192b79'}, globalenv=globalenv, privileged=True),

View File

@@ -13,101 +13,56 @@ env:
jobs:
posix:
defaults:
run:
shell: bash
strategy:
fail-fast: false
matrix:
include:
- toolset: gcc-5
cxxstd: "11,14,1z"
os: ubuntu-18.04
install: g++-5
- toolset: gcc-6
cxxstd: "11,14,1z"
os: ubuntu-18.04
install: g++-6
- toolset: gcc-7
cxxstd: "11,14,17"
os: ubuntu-18.04
- toolset: gcc-10
cxxstd: "11,14,17,2a"
os: ubuntu-20.04
install: g++-10
- toolset: gcc-12
cxxstd: "11,14,17,20,2b"
os: ubuntu-22.04
install: g++-12
- toolset: clang
compiler: clang++-3.9
cxxstd: "11,14"
os: ubuntu-18.04
install: clang-3.9
- toolset: clang
compiler: clang++-4.0
cxxstd: "11,14"
os: ubuntu-18.04
install: clang-4.0
- toolset: clang
compiler: clang++-5.0
cxxstd: "11,14,1z"
os: ubuntu-18.04
install: clang-5.0
- toolset: clang
compiler: clang++-6.0
cxxstd: "11,14,17"
os: ubuntu-18.04
install: clang-6.0
- toolset: clang
compiler: clang++-7
cxxstd: "11,14,17"
os: ubuntu-18.04
install: clang-7
- toolset: clang
compiler: clang++-8
cxxstd: "11,14,17"
os: ubuntu-20.04
install: clang-8
- toolset: clang
compiler: clang++-9
cxxstd: "11,14,17,2a"
os: ubuntu-20.04
install: clang-9
- toolset: clang
compiler: clang++-10
cxxstd: "11,14,17,2a"
os: ubuntu-20.04
install: clang-10
- toolset: clang
compiler: clang++-11
cxxstd: "11,14,17,2a"
os: ubuntu-20.04
install: clang-11
- toolset: clang
compiler: clang++-12
cxxstd: "11,14,17,2a"
os: ubuntu-20.04
install: clang-12
- toolset: clang
compiler: clang++-13
cxxstd: "11,14,17,20,2b"
os: ubuntu-22.04
install: clang-13
- toolset: clang
compiler: clang++-14
cxxstd: "11,14,17,20,2b"
os: ubuntu-22.04
install: clang-14
- toolset: clang
cxxstd: "11,14,17,2a"
os: macos-11
- { toolset: gcc-5, cxxstd: "11,14,1z", os: ubuntu-latest, container: 'ubuntu:18.04', install: g++-5 }
- { toolset: gcc-6, cxxstd: "11,14,1z", os: ubuntu-latest, container: 'ubuntu:18.04', install: g++-6 }
- { toolset: gcc-7, cxxstd: "11,14,17", os: ubuntu-latest, container: 'ubuntu:20.04', install: g++-7 }
- { toolset: gcc-10, cxxstd: "11,14,17,2a", os: ubuntu-22.04, install: g++-10 }
- { toolset: gcc-12, cxxstd: "11,14,17,20,2b", os: ubuntu-22.04, install: g++-12 }
- { toolset: clang, compiler: clang++-3.9, cxxstd: "11,14", os: ubuntu-latest, container: 'ubuntu:18.04', install: clang-3.9 }
- { toolset: clang, compiler: clang++-4.0, cxxstd: "11,14", os: ubuntu-latest, container: 'ubuntu:18.04', install: clang-4.0 }
- { toolset: clang, compiler: clang++-5.0, cxxstd: "11,14,1z", os: ubuntu-latest, container: 'ubuntu:18.04', install: clang-5.0 }
- { toolset: clang, compiler: clang++-6.0, cxxstd: "11,14,17", os: ubuntu-latest, container: 'ubuntu:20.04', install: clang-6.0 }
- { toolset: clang, compiler: clang++-7, cxxstd: "11,14,17", os: ubuntu-latest, container: 'ubuntu:20.04', install: clang-7 }
- { toolset: clang, compiler: clang++-8, cxxstd: "11,14,17", os: ubuntu-latest, container: 'ubuntu:20.04', install: clang-8 }
- { toolset: clang, compiler: clang++-9, cxxstd: "11,14,17,2a", os: ubuntu-latest, container: 'ubuntu:20.04', install: clang-9 }
- { toolset: clang, compiler: clang++-10, cxxstd: "11,14,17,2a", os: ubuntu-latest, container: 'ubuntu:20.04', install: clang-10 }
- { toolset: clang, compiler: clang++-11, cxxstd: "11,14,17,2a", os: ubuntu-22.04, install: clang-11 }
- { toolset: clang, compiler: clang++-12, cxxstd: "11,14,17,2a", os: ubuntu-22.04, install: clang-12 }
- { toolset: clang, compiler: clang++-13, cxxstd: "11,14,17,20,2b", os: ubuntu-22.04, install: clang-13 }
- { toolset: clang, compiler: clang++-14, cxxstd: "11,14,17,20,2b", os: ubuntu-22.04, install: clang-14 }
- { toolset: clang, cxxstd: "11,14,17,2a", os: macos-13 }
runs-on: ${{matrix.os}}
container:
image: ${{matrix.container}}
volumes:
- /node20217:/node20217:rw,rshared
- ${{ startsWith(matrix.container, 'ubuntu:1') && '/node20217:/__e/node20:ro,rshared' || ' ' }}
steps:
- uses: actions/checkout@v2
- name: Setup container environment
if: matrix.container
run: |
apt-get update
apt-get -y install sudo python3 git g++ curl
if [[ "${{matrix.container}}" == "ubuntu:1"* ]]; then
# Node 20 doesn't work with Ubuntu 16/18 glibc: https://github.com/actions/checkout/issues/1590
curl -sL https://archives.boost.io/misc/node/node-v20.9.0-linux-x64-glibc-217.tar.xz | tar -xJ --strip-components 1 -C /node20217
fi
- uses: actions/checkout@v4
- name: Install packages
if: matrix.install
run: sudo apt install ${{matrix.install}}
run: sudo apt-get -y install ${{matrix.install}}
- name: Setup Boost
run: |
@@ -127,7 +82,7 @@ jobs:
cd boost-root
cp -r $GITHUB_WORKSPACE/* libs/$LIBRARY
git submodule update --init tools/boostdep
python tools/boostdep/depinst/depinst.py --git_args "--jobs 3" $LIBRARY
python3 tools/boostdep/depinst/depinst.py --git_args "--jobs 3" $LIBRARY
./bootstrap.sh
./b2 -d0 headers
@@ -207,7 +162,7 @@ jobs:
runs-on: ${{matrix.os}}
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
- name: Setup Boost
shell: cmd

View File

@@ -3,10 +3,12 @@
# Distributed under the Boost Software License, Version 1.0.
# https://www.boost.org/LICENSE_1_0.txt
cmake_minimum_required(VERSION 3.5...3.16)
cmake_minimum_required(VERSION 3.8...3.31)
project(boost_process VERSION "${BOOST_SUPERPROJECT_VERSION}" LANGUAGES CXX)
option(BOOST_PROCESS_USE_STD_FS "Use std::filesystem instead of Boost.Filesystem" OFF)
add_library(boost_process
src/detail/environment_posix.cpp
src/detail/environment_win.cpp
@@ -35,7 +37,6 @@ target_link_libraries(boost_process
Boost::asio
Boost::config
Boost::core
Boost::filesystem
Boost::fusion
Boost::iterator
Boost::move
@@ -50,14 +51,15 @@ target_compile_definitions(boost_process
PRIVATE BOOST_PROCESS_SOURCE=1
)
if (BOOST_PROCESS_USE_STD_FS)
target_compile_definitions(boost_process PUBLIC BOOST_PROCESS_USE_STD_FS=1 )
if(BOOST_PROCESS_USE_STD_FS)
target_compile_definitions(boost_process PUBLIC BOOST_PROCESS_USE_STD_FS)
target_compile_features(boost_process PUBLIC cxx_std_17)
else()
target_link_libraries(boost_process PUBLIC Boost::filesystem)
endif()
if (WIN32)
target_link_libraries(boost_process PUBLIC ntdll shell32 Advapi32 user32)
if(WIN32)
target_link_libraries(boost_process PUBLIC ntdll shell32 advapi32 user32 ws2_32)
endif()
if(BUILD_SHARED_LIBS)

View File

@@ -6,8 +6,8 @@ Boost.process is a library for comfortable management of processes, released wit
| Branches | Linux / Windows | Code coverage | Matrix |
|----------|----------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
| Develop: | [![Build Status](https://drone.cpp.al/api/badges/boostorg/process/status.svg)](https://drone.cpp.al/boostorg/process) | [![codecov](https://codecov.io/gh/boostorg/process/branch/develop/graph/badge.svg?token=AhunMqTSpA)](https://codecov.io/gh/boostorg/process) | [![Matrix](https://img.shields.io/badge/matrix-develop-lightgray.svg)](http://www.boost.org/development/tests/develop/developer/process.html) |
| Master: | [![Build Status](https://drone.cpp.al/api/badges/boostorg/process/status.svg?ref=refs/heads/develop)](https://drone.cpp.al/boostorg/process) | [![codecov](https://codecov.io/gh/boostorg/process/branch/master/graph/badge.svg?token=AhunMqTSpA)](https://codecov.io/gh/boostorg/process) | [![Matrix](https://img.shields.io/badge/matrix-master-lightgray.svg)](http://www.boost.org/development/tests/master/developer/process.html) |
| Develop: | [![Build Status](https://drone.cpp.al/api/badges/boostorg/process/status.svg)](https://drone.cpp.al/boostorg/process) | [![codecov](https://codecov.io/gh/boostorg/process/branch/develop/graph/badge.svg?token=AhunMqTSpA)](https://codecov.io/gh/boostorg/process) | [![Matrix](https://img.shields.io/badge/matrix-develop-lightgray.svg)](https://regression.boost.io/develop/developer/process.html) |
| Master: | [![Build Status](https://drone.cpp.al/api/badges/boostorg/process/status.svg?ref=refs/heads/develop)](https://drone.cpp.al/boostorg/process) | [![codecov](https://codecov.io/gh/boostorg/process/branch/master/graph/badge.svg?token=AhunMqTSpA)](https://codecov.io/gh/boostorg/process) | [![Matrix](https://img.shields.io/badge/matrix-master-lightgray.svg)](https://regression.boost.io/master/developer/process.html) |

47
build.jam Normal file
View File

@@ -0,0 +1,47 @@
# Copyright René Ferdinand Rivera Morell 2024
# Distributed under the Boost Software License, Version 1.0.
# (See accompanying file LICENSE_1_0.txt or copy at
# http://www.boost.org/LICENSE_1_0.txt)
require-b2 5.2 ;
import feature : feature ;
feature boost.process.fs : boost std : optional propagated ;
feature boost.process.disable-close-range : on off : optional ;
constant boost_dependencies :
/boost/algorithm//boost_algorithm
/boost/asio//boost_asio
/boost/assert//boost_assert
/boost/config//boost_config
/boost/core//boost_core
/boost/fusion//boost_fusion
/boost/io//boost_io
/boost/iterator//boost_iterator
/boost/move//boost_move
/boost/optional//boost_optional
/boost/system//boost_system
/boost/throw_exception//boost_throw_exception
/boost/tokenizer//boost_tokenizer
/boost/type_index//boost_type_index
/boost/type_traits//boost_type_traits
/boost/utility//boost_utility
/boost/winapi//boost_winapi ;
project /boost/process
: common-requirements
<include>include
: default-build
<boost.process.fs>boost
;
explicit
[ alias boost_process : build//boost_process ]
[ alias all : boost_process example example/v2 test ]
;
call-if : boost-library process
: install boost_process
;

View File

@@ -5,7 +5,8 @@
import os ;
import feature ;
import ../../config/checks/config : requires ;
import-search /boost/config/checks ;
import config : requires ;
project : requirements
<define>BOOST_ASIO_NO_DEPRECATED
@@ -15,11 +16,11 @@ project : requirements
<target-os>windows:<define>WIN32_LEAN_AND_MEAN
<target-os>linux:<linkflags>-lpthread
: source-location ../src
: common-requirements
<library>$(boost_dependencies)
<boost.process.fs>std:<define>BOOST_PROCESS_USE_STD_FS=1
;
feature.feature boost.process.fs : boost std : propagated composite ;
feature.compose <boost.process.fs>std : <define>BOOST_PROCESS_USE_STD_FS=1 ;
alias process_sources
: detail/environment_posix.cpp
detail/environment_win.cpp
@@ -40,26 +41,33 @@ alias process_sources
shell.cpp
;
if [ os.name ] = NT
{
lib shell32 ;
lib advapi32 ;
lib ntdll ;
lib user32 ;
explicit shell32 advapi32 ntdll user32 ;
}
lib shell32 ;
lib advapi32 ;
lib ntdll ;
lib user32 ;
lib ws2_32 ;
lib kvm ;
lib procstat ;
lib boost_process
: process_sources
: requirements <define>BOOST_PROCESS_SOURCE=1
<link>shared:<define>BOOST_PROCESS_DYN_LINK=1
<boost.process.fs>boost:<library>/boost//filesystem
<boost.process.fs>boost:<library>/boost/filesystem//boost_filesystem
<boost.process.disable-close-range>on:<define>BOOST_PROCESS_V2_POSIX_FORCE_DISABLE_CLOSE_RANGE=1
<target-os>windows:<library>shell32
<target-os>windows:<library>user32
<target-os>windows:<library>ntdll
<target-os>windows:<library>advapi32
<target-os>windows:<library>ws2_32
<target-os>bsd:<library>kvm
<target-os>freebsd:<library>kvm
<target-os>freebsd:<library>procstat
<target-os>netbsd:<library>kvm
<target-os>openbsd:<library>kvm
<target-os>solaris:<library>kvm
: usage-requirements
<link>shared:<define>BOOST_PROCESS_DYN_LINK=1
<boost.process.fs>boost:<library>/boost/filesystem//boost_filesystem
;
boost-install boost_process ;

View File

@@ -1,106 +1,31 @@
# Copyright (c) 2006, 2007 Julio M. Merino Vidal
# Copyright (c) 2008 Ilya Sokolov, Boris Schaeling
# Copyright (c) 2009 Boris Schaeling
# Copyright (c) 2010 Felipe Tanus, Boris Schaeling
# Copyright (c) 2011, 2012 Jeff Flinn, Boris Schaeling
#
# Distributed under the Boost Software License, Version 1.0. (See accompanying
# file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
# Copyright 2022 Klemens D. Morgenstern
# Distributed under the Boost Software License, Version 1.0.
# https://www.boost.org/LICENSE_1_0.txt
using boostbook ;
using quickbook ;
using doxygen ;
import asciidoctor ;
html index.html : index.adoc ;
local images = [ glob images/*.svg ] ;
install images : $(images) : <location>html/boost_process ;
install images_glob : $(images) : <location>$(BOOST_ROOT)/doc/html/boost_process ;
install html_ : index.html : <location>html ;
import type ;
type.register XMLPROCESSWORKAROUND : : XML ;
import generators ;
generators.register-standard common.copy : XML : XMLPROCESSWORKAROUND ;
pdf process.pdf : index.adoc ;
explicit process.pdf ;
xmlprocessworkaround posix_pseudocode : v1/posix_pseudocode.xml ;
xmlprocessworkaround windows_pseudocode : v1/windows_pseudocode.xml ;
install pdf_ : process.pdf : <location>pdf ;
explicit pdf_ ;
path-constant INCLUDES : ../../.. ;
install images
:
images/posix_exec_err.svg
images/posix_fork_err.svg
images/posix_success.svg
images/windows_exec.svg
:
<location>html/images
;
doxygen reference_v1
:
$(INCLUDES)/boost/process/v1.hpp
[ glob $(INCLUDES)/boost/process/v1/*.hpp ]
:
<doxygen:param>EXCLUDE_SYMBOLS=BOOST_ASIO_INITFN_RESULT_TYPE
<doxygen:param>"PREDEFINED=\\
BOOST_PROCESS_DOXYGEN=1 \\
BOOST_PROCESS_V1_INLINE=
"
<doxygen:param>HIDE_UNDOC_CLASSES=YES
<doxygen:param>HIDE_UNDOC_MEMBERS=YES
<doxygen:param>EXAMPLE_PATH=.
<dependency>posix_pseudocode
<dependency>windows_pseudocode
<xsl:path>.
;
doxygen reference_v2
:
$(INCLUDES)/boost/process/v2.hpp
[ glob $(INCLUDES)/boost/process/v2/*.hpp ]
:
<doxygen:param>EXCLUDE_SYMBOLS=BOOST_ASIO_INITFN_RESULT_TYPE
<doxygen:param>PROJECT_NAME="Process V2"
<doxygen:param>PROJECT_BRIEF="The process library"
<doxygen:param>MACRO_EXPANSION=YES
<doxygen:param>EXPAND_ONLY_PREDEF=YES
<doxygen:param>"PREDEFINED=\\
GENERATING_DOCUMENTATION=1 \\
BOOST_PROCESS_V2_ASIO_NAMESPACE=boost::asio \\
\"BOOST_PROCESS_V2_BEGIN_NAMESPACE=namespace boost { namespace process { namespace v2 { \" \\
\"BOOST_PROCESS_V2_END_NAMESPACE= } } }\" \\
BOOST_PROCESS_V2_NAMESPACE=boost::process::v2 \\
BOOST_PROCESS_V2_DECL \\
BOOST_PROCESS_V2_INITFN_AUTO_RESULT_TYPE(x,y)=deduced \\
BOOST_PROCESS_V2_COMPLETION_TOKEN_FOR(X)=Token \\
BOOST_PROCESS_V2_DEFAULT_COMPLETION_TOKEN_TYPE(E)=DEFAULT_TYPE \\
BOOST_ASIO_DEFAULT_COMPLETION_TOKEN=DEFAULT \\
BOOST_CONSTEXPR=constexpr \\
BOOST_CXX14_CONSTEXPR=constexpr \\
BOOST_PROCESS_V2_INLINE= \\
BOOST_ATTRIBUTE_NODISCARD=[[nodiscard]]
"
<doxygen.doxproc.id>reference_v2
<doxygen:param>SHOW_USED_FILES=NO
<doxygen:param>SHOW_FILES=NO
<doxygen:param>SHOW_NAMESPACES=YES
<doxygen:param>CLASS_DIAGRAMS=NO
<doxygen:param>SORT_MEMBERS_CTORS_1ST=YES
<doxygen:param>HIDE_UNDOC_CLASSES=NO
<xsl:path>.
;
boostbook standalone
:
process.qbk
:
<dependency>reference_v1
<dependency>reference_v2
<dependency>images
<dependency>images_glob
<xsl:param>boost.root=../../../..
<xsl:param>html.stylesheet=../../../../doc/src/boostbook.css
;
###############################################################################
alias boostdoc
: standalone/<format>docbook
:
: <dependency>images_glob
: ;
alias boostdoc ;
explicit boostdoc ;
alias boostrelease ;
explicit boostrelease ;
alias boostrelease : html_ ;
explicit boostrelease ;

View File

@@ -1,13 +1,13 @@
[section Acknowledgements]
= Acknowledgements
The first Boost.Process draft was created in 2006. A lof of people have worked on various drafts since then. Especially Merino Vidal, Ilya Sokolov and Felipe Tanus spent a lot of time working on early drafts. They influenced Boost.Process over the years and wrote code which, to various extents, is still around in the library today.
The design of earlier versions of Boost.Process was not always satisfying. In 2011 Jeff Flinn proposed the executor and initializer concepts Boost.Process is based on today. Without Jeff's idea the overall design of Boost.Process would not look like it does today.
A special thank you goes to [@http://www.intra2net.com/ Intra2net AG] (especially Thomas Jarosch) who sponsored a project to support the development of Boost.Process. It was this sponsorship which made it possible to create a new Boost.Process version in 2012.
A special thank you goes to [http://www.intra2net.com/(Intra2net AG) (especially Thomas Jarosch) who sponsored a project to support the development of Boost.Process. It was this sponsorship which made it possible to create a new Boost.Process version in 2012.
Great thanks also goes to Boris Schaeling, who despite having boost.process rejected, went on to work on it and maintained it up until this day and participated in the development of the current version.
Many Thanks, to [@https://github.com/time-killer-games Samuel Venable] for contributing the v2::ext functionality and all the research that went into it.
Many Thanks, to [https://github.com/samuelvenable](Samuel Venable) for contributing the <<v2::ext>> functionality and all the research that went into it.
[endsect]

11
doc/configuration.adoc Normal file
View File

@@ -0,0 +1,11 @@
= Configuration
Boost process v2 can be configured in the following ways:
[cols="1,1"]
|===
| Macro | Description
| `BOOST_PROCESS_V2_STANDALONE` | Build boost.process for standalone asio
| `BOOST_PROCESS_USE_STD_FS` | Use std::filesystem instead of boost::filesystem
| `BOOST_PROCESS_V2_POSIX_FORCE_DISABLE_CLOSE_RANGE` | Disable usage of `close_range`.

View File

@@ -1,4 +1,4 @@
[section:env Environment]
== Environment
The `environment` namespace provides all sorts of facilities to query and manipulate the environment of the current process.
@@ -14,35 +14,39 @@ as to have the right value comparisons.
To note is the `find_executable` functions, which searches in an environment for an executable.
```
// search in the current environment
auto exe = environment::find_executable("g++");
.example/env.cpp:19-28
[source,cpp]
----
include::../example/env.cpp[tag=current_env]
----
std::unordered_map<environment::key, environment::value> my_env =
{
{"SECRET", "THIS_IS_A_TEST"},
{"PATH", {"/bin", "/usr/bin"}}
};
auto other_exe = environment::find_executable("g++", my_env);
```
[section:process_env Subprocess environment]
== Subprocess environment
The subprocess environment assignment follows the same constraints:
```
asio::io_context ctx;
std::unordered_map<environment::key, environment::value> my_env =
{
{"SECRET", "THIS_IS_A_TEST"},
{"PATH", {"/bin", "/usr/bin"}}
};
auto exe = find_executable("g++");
process proc(ctx, exe, {"main.cpp"}, process_environment(my_env));
process pro2(ctx, exe, {"test.cpp"}, process_environment(my_env));
```
.example/env.cpp:34-42
[source,cpp,indent=0]
----
include::../example/env.cpp[tag=subprocess_env]
----
== Inheriting an environment
The current environment can be obtained by calling `environment::current` which returns
a forward range of `environment::key_value_pair_view`.
.example/env.cpp:48-54
[source,cpp,indent=0]
----
include::../example/env.cpp[tag=vector_env]
----
Alternatively you can use a map container for the environment.
.example/env.cpp:61-68
[source,cpp,indent=0]
----
include::../example/env.cpp[tag=map_env]
----
[endsect]
[endsect]

51
doc/index.adoc Normal file
View File

@@ -0,0 +1,51 @@
= boost.process
Klemens Morgenstern <klemens.morgenstern@gmx.net>
Version 2.0, 19.11.2024
:source-highlighter: rouge
:toc: left
:toclevels: 4
:icons: font
:idprefix:
:docinfo: private-footer
:source-highlighter: rouge
:source-language: c++
:example-caption: Example
:imagesdir: ./images
:leveloffset: +1
include::quickstart.adoc[]
include::launcher.adoc[]
= Initializers
include::start_dir.adoc[]
include::stdio.adoc[]
include::env.adoc[]
= Reference
include::reference/bind_launcher.adoc[]
include::reference/cstring_ref.adoc[]
include::reference/default_launcher.adoc[]
include::reference/environment.adoc[]
include::reference/error.adoc[]
include::reference/execute.adoc[]
include::reference/exit_code.adoc[]
include::reference/ext.adoc[]
include::reference/pid.adoc[]
include::reference/popen.adoc[]
include::reference/process.adoc[]
include::reference/process_handle.adoc[]
include::reference/shell.adoc[]
include::reference/start_dir.adoc[]
include::reference/stdio.adoc[]
include::reference/ext.adoc[]
include::reference/posix/bind_fd.adoc[]
include::reference/windows/creation_flags.adoc[]
include::reference/windows/show_window.adoc[]
include::version2.adoc[]
include::acknowledgements.adoc[]

126
doc/launcher.adoc Normal file
View File

@@ -0,0 +1,126 @@
= Launcher
The process creation is done by a process_launcher.
The constructor of `process` will use the default_launcher, which varies by system.
There are additional launcher available on most systems.
[cols="1,1,1,1"]
|===
|Name | Summary | Default on | Available on
|`windows::default_launcher` | `CreateProcessW` | windows |windows
|`windows::as_user_launcher` | `CreateProcessAsUserW` | |windows
|`windows::with_logon_launcher` | `CreateProcessWithLogonW` | |windows
|`windows::with_token_launcher` | `CreateProcessWithTokenW` | |windows
|`posix::default_launcher` | fork & an error pipe | most of posix |posix
|`posix::fork_and_forget` | fork without error pipe | |posix
|`posix::vfork_launcher` | vfork | |posix
|===
A launcher is invoked through the call operator.
[source,cpp]
----
auto l = windows::as_user_launcher((HANDLE)0xDEADBEEF);
asio::io_context ctx;
boost::system::error_code ec;
auto proc = l(ctx, ec, "C:\\User\\boost\\Downloads\\totally_not_a_virus.exe", {});
----
The launcher will call certain functions on the initializer if they're present, as documented below.
The initializer are used to modify the process behaviour.
== Linux Launchers
The default launchers on linux open an internal pipe to communicate errors that occur after forking back to the parent process.
NOTE: A pipe can be used if one end is open on the parent, the other on the child.
This allows the parents to select on his pipe-end to know if the child exited.
This can be prevented by using the `fork_and_forget_launcher`.
Alternatively, the `vfork_launcher` can report errors directly back to the parent process.
Thus some calls to the initializers occur after forking from the child process.
[source,cpp]
----
struct custom_initializer
{
// called before a call to fork. A returned error will cancel the launch.
template<typename Launcher>
error_code on_setup(Launcher & launcher, const filesystem::path &executable, const char * const * (&cmd_line));
// called for every initializer if an error occurred during setup or process creation
template<typename Launcher>
void on_error(Launcher & launcher, const filesystem::path &executable, const char * const * (&cmd_line),
const error_code & ec);
// called after successful process creation
template<typename Launcher>
void on_success(Launcher & launcher, const filesystem::path &executable, const char * const * (&cmd_line));
// called for every initializer if an error occurred when forking, in addition to on_error.
template<typename Launcher>
void on_fork_error(Launcher & launcher, const filesystem::path &executable, const char * const * (&cmd_line),
const error_code & ec);
// called before a call to execve. A returned error will cancel the launch. Called from the child process.
template<typename Launcher>
error_code on_exec_setup(Launcher & launcher, const filesystem::path &executable, const char * const * (&cmd_line));
// called after a failed call to execve from the child process.
template<typename Launcher>
void on_exec_error(Launcher & launcher, const filesystem::path &executable, const char * const * (&cmd_line));
};
----
The call sequence on success:
image::posix_success.svg[]
The call sequence when fork fails:
image::posix_fork_err.svg[]
The call sequence when exec fails:
image::posix_exec_err.svg[]
The launcher will close all non-whitelisted file descriptors after `on_exec_setup`.
== Windows Launchers
Windows launchers are pretty straight forward, they will call the following functions on the initializer if present.
[source,cpp]
----
struct custom_initializer
{
// called before a call to CreateProcess. A returned error will cancel the launch.
template<typename Launcher>
error_code on_setup(Launcher & launcher, const filesystem::path &executable, std::wstring &cmd_line);
// called for every initializer if an error occurred during setup or process creation
template<typename Launcher>
void on_error(Launcher & launcher, const filesystem::path &executable, std::wstring &cmd_line,
const error_code & ec);
// called after successful process creation
template<typename Launcher>
void on_success(Launcher & launcher, const filesystem::path &executable, std::wstring &cmd_line);
};
----
NOTE: All the additional launchers for windows inherit `default_launcher`.
The call sequence is as follows:
image::windows_exec.svg
'''

View File

@@ -1,18 +0,0 @@
[library Boost.Process
[quickbook 1.5]
[authors [Morgenstern, Klemens David]]
[copyright 2006, 2007, 2008, 2009, 2010, 2011, 2012 Julio M. Merino Vidal, Ilya Sokolov, Felipe Tanus, Jeff Flinn, Boris Schaeling, 2016 Klemens D. Morgenstern]
[id process]
[dirname process]
[license
Distributed under the Boost Software License, Version 1.0.
(See accompanying file LICENSE_1_0.txt or copy at
http://www.boost.org/LICENSE_1_0.txt)
]
]
[note Process v1 will be deprecated in the future. Use v2 for new projects.]
[include v1.qbk]
[include v2.qbk]
[include acknowledgements.qbk]

104
doc/quickstart.adoc Normal file
View File

@@ -0,0 +1,104 @@
= Quickstart
A process needs four things to be launched:
* an asio execution_context / executor
* a path to an executable
* a list of arguments
* a variadic set of initializers
.example/quickstart.cpp:13-17
[source,cpp,indent=0]
----
include::../example/quickstart.cpp[tag=cp]
----
<1> The executor for the process handle
<2> The Path to the executable
<3> The argument list in the form of an `std::initializer_list`.
<4> Not additional initializers
The started process can then be awaited or terminated.
== Lifetime
If the process handle goes out of scope, it will terminate the subprocess.
You can prevent this, by calling `proc.detach()`; do however note that this
can lead to zombie processes.
A process that completed will deliver an exit-code,
which can be obtained by calling `.exit_code` on the exited process and which is
also returned from `.wait()`.
.example/quickstart.cpp:22-23
[source,cpp, indent=0]
----
include::../example/quickstart.cpp[tag=ls]
----
The normal exit-code is what the subprocess returned from `main`;
posix will however add additional information about the process.
This is called the `native_exit_code`.
The `.running()` function can be used to detect if the process is still active.
== Signalling the subprocess
The parent process can signal the subprocess demanding certain actions.
`.terminate` will cause the subprocess to exit immediately (`SIGKILL` on posix).
This is the only reliable & portable way to end a subprocess.
.example/quickstart.cpp:28-29
[source,cpp,indent=0]
----
include::../example/quickstart.cpp[tag=terminate]
----
`.request_exit` will ask the subprocess to shutdown (`SIGTERM` on posix),
which the subprocess might ignore.
.example/quickstart.cpp:34-36
[source,cpp]
----
include::../example/quickstart.cpp[tag=request_exit]
----
`.interrupt` will send an SIGINT to the subprocess, which a subprocess might
interpret as a signal for shutdown.
WARNING: interrupt requires the initializer `windows::create_new_process_group` to be set on windows
.example/quickstart.cpp:41-43
[source,cpp]
----
include::../example/quickstart.cpp[tag=interrupt]
----
[endsect]
[section:execute Execute functions]
Process v2 provides `execute` and `async_execute` functions that can be used for managed executions.
.example/quickstart.cpp:48
[source,cpp]
----
include::../example/quickstart.cpp[tag=execute]
----
The async version supports cancellation and will forward cancellation types as follows:
- `asio::cancellation_type::total` -> interrupt
- `asio::cancellation_type::partial` -> request_exit
- `asio::cancellation_type::terminal` -> terminate
.example/quickstart.cpp:53-56
[source,cpp]
----
include::../example/quickstart.cpp[tag=async_execute]
----
<1> After 10 seconds send a request_exit.
<2> After 20 seconds terminate

View File

@@ -0,0 +1,16 @@
== `bind_launcher.hpp`
The `bind_launcher` utilities allow on the fly construction of a launcher with bound initializers.
[source,cpp]
----
// Creates a new launcher with the bound initializer.
template<typename Launcher, typename ... Init>
auto bind_launcher(Launcher && launcher, Init && ... init);
// Calls bind_launcher with the default_launcher as the first parameter.
// The new launcher with bound parameters
template<typename ... Init>
auto bind_default_launcher(Init && ... init);
----

View File

@@ -0,0 +1,3 @@
== `cstring_ref.hpp`
The `cstring_ref` is a string-view like type that holds a null-terminated string.

View File

@@ -0,0 +1,22 @@
== `default_launcher.hpp`
[#default_launcher]
The `default_launcher` is the standard way of creating a process.
[source,cpp]
----
asio::io_context ctx;
process proc(ctx.get_executor(), "test", {});
// equivalent to
process proc = default_launcher()(ctx.get_executor(), "test", {});
----
It has four overloads:
[source,cpp]
----
(ExecutionContext &, filesystem::path, Args && args, Inits && ... inits) -> basic_process<typename ExecutionContext::executor_type>
(Executor &, filesystem::path, Args && args, Inits && ... inits) -> basic_process<Executor>;
(ExecutionContext &, error_code&, filesystem::path, Args && args, Inits && ... inits) -> basic_process<typename ExecutionContext::executor_type>;`
(Executor &, error_code&, filesystem::path, Args && args, Inits && ... inits) -> basic_process<Executor>
----

View File

@@ -0,0 +1,735 @@
== `environment.hpp`
[#environment]
=== `environment`
The `environment` header provides facilities to manipulate the current environment and set it for new processes.
An environment is a a `range` of `T` fulfilling these requirements:
For `T value`
* - std::get<0>(value) must return a type comparable to `key_view`.
* - std::get<1>(value) must return a type convertible to `value_view`.
[source,cpp]
----
// Namespace for information and functions regarding the calling process.
namespace environment
{
// A char traits type that reflects the OS rules for string representing environment keys.
/* Can be an alias of std::char_traits. May only be defined for `char` and `wchar_t`.
*
* Windows treats keys as case-insensitive yet preserving. The char traits are made to reflect
* that behaviour.
*/
template<typename Char>
using key_char_traits = implementation_defined ;
// A char traits type that reflects the OS rules for string representing environment values.
/* Can be an alias of std::char_traits. May only be defined for `char` and `wchar_t`.
*/
template<typename Char>
using value_char_traits = implementation_defined ;
// The character type used by the environment. Either `char` or `wchar_t`.
using char_type = implementation_defined ;
// The equal character in an environment string used to separate key and value.
constexpr char_type equality_sign = implementation_defined;
// The delimiter in environemtn lists. Commonly used by the `PATH` variable.
constexpr char_type delimiter = implementation_defined;
// The native handle of an environment. Note that this can be an owning pointer and is generally not thread safe.
using native_handle = implementation_defined;
// A forward iterator over string_view used by a value or value_view to iterator through environments that are lists.
struct value_iterator;
// A view type for a key of an environment
struct key_view
{
using value_type = char_type;
using traits_type = key_char_traits<char_type>;
using string_view_type = basic_string_view<char_type, traits_type>;
using string_type = std::basic_string<char_type, key_char_traits<char_type>>;
key_view() noexcept = default;
key_view( const key_view& p ) = default;
key_view( key_view&& p ) noexcept = default;
template<typename Source>
key_view( const Source& source );
key_view( const char_type * p);
key_view( char_type * p);
~key_view() = default;
key_view& operator=( const key_view& p ) = default;
key_view& operator=( key_view&& p ) noexcept = default;
key_view& operator=( string_view_type source );
void swap( key_view& other ) noexcept;
string_view_type native() const noexcept;
operator string_view_type() const;
int compare( const key_view& p ) const noexcept;
int compare( string_view_type str ) const;
int compare( const value_type* s ) const;
template< class CharT, class Traits = std::char_traits<CharT>,
class Alloc = std::allocator<CharT> >
std::basic_string<CharT,Traits,Alloc>
basic_string( const Alloc& alloc = Alloc()) const;
std::string string() const;
std::wstring wstring() const;
string_type native_string() const;
friend bool operator==(key_view l, key_view r);
friend bool operator!=(key_view l, key_view r);
friend bool operator<=(key_view l, key_view r);
friend bool operator>=(key_view l, key_view r);
friend bool operator< (key_view l, key_view r);
friend bool operator> (key_view l, key_view r);
bool empty() const;
template< class CharT, class Traits >
friend std::basic_ostream<CharT,Traits>&
operator<<( std::basic_ostream<CharT,Traits>& os, const key_view& p );
template< class CharT, class Traits >
friend std::basic_istream<CharT,Traits>&
operator>>( std::basic_istream<CharT,Traits>& is, key_view& p );
const value_type * data() const;
std::size_t size() const;
};
// A view for a value in an environment
struct value_view
{
using value_type = char_type;
using string_view_type = basic_cstring_ref<char_type, value_char_traits<char_type>>;
using string_type = std::basic_string<char_type, value_char_traits<char_type>>;
using traits_type = value_char_traits<char_type>;
value_view() noexcept = default;
value_view( const value_view& p ) = default;
value_view( value_view&& p ) noexcept = default;
template<typename Source>
value_view( const Source& source );
value_view( const char_type * p);
value_view( char_type * p);
~value_view() = default;
value_view& operator=( const value_view& p ) = default;
value_view& operator=( value_view&& p ) noexcept = default;
value_view& operator=( string_view_type source );
void swap( value_view& other ) noexcept;
string_view_type native() const noexcept ;
operator string_view_type() const;
operator typename string_view_type::string_view_type() const;
int compare( const value_view& p ) const noexcept;
int compare( string_view_type str ) const;
int compare( const value_type* s ) const;
template< class CharT, class Traits = std::char_traits<CharT>,
class Alloc = std::allocator<CharT> >
std::basic_string<CharT,Traits,Alloc>
basic_string( const Alloc& alloc = Alloc() ) const;
std::string string() const;
std::wstring wstring() const;
string_type native_string() const;
bool empty() const;
friend bool operator==(value_view l, value_view r);
friend bool operator!=(value_view l, value_view r);
friend bool operator<=(value_view l, value_view r);
friend bool operator>=(value_view l, value_view r);
friend bool operator< (value_view l, value_view r);
friend bool operator> (value_view l, value_view r);
template< class CharT, class Traits >
friend std::basic_ostream<CharT,Traits>&
operator<<( std::basic_ostream<CharT,Traits>& os, const value_view& p );
template< class CharT, class Traits >
friend std::basic_istream<CharT,Traits>&
operator>>( std::basic_istream<CharT,Traits>& is, value_view& p );
value_iterator begin() const;
value_iterator end() const;
const char_type * c_str();
const value_type * data() const;
std::size_t size() const;
};
// A view for a key value pair in an environment
struct key_value_pair_view
{
using value_type = char_type;
using string_type = std::basic_string<char_type>;
using string_view_type = basic_cstring_ref<char_type>;
using traits_type = std::char_traits<char_type>;
key_value_pair_view() noexcept = default;
key_value_pair_view( const key_value_pair_view& p ) = default;
key_value_pair_view( key_value_pair_view&& p ) noexcept = default;
template<typename Source,
typename = typename std::enable_if<is_constructible<string_view_type, Source>::value>::type>
key_value_pair_view( const Source& source );
key_value_pair_view( const char_type * p);
key_value_pair_view( char_type * p);
~key_value_pair_view() = default;
key_value_pair_view& operator=( const key_value_pair_view& p ) = default;
key_value_pair_view& operator=( key_value_pair_view&& p ) noexcept = default;
void swap( key_value_pair_view& other ) noexcept;
string_view_type native() const noexcept;
operator string_view_type() const;
operator typename string_view_type::string_view_type() const;
int compare( key_value_pair_view p ) const noexcept;
int compare( const string_type& str ) const;
int compare( string_view_type str ) const;
int compare( const value_type* s ) const;
template< class CharT, class Traits = std::char_traits<CharT>, class Alloc = std::allocator<CharT> >
std::basic_string<CharT,Traits,Alloc>
basic_string( const Alloc& alloc = Alloc()) const;
std::string string() const;
std::wstring wstring() const;
string_type native_string() const;
bool empty() const;
key_view key() const;
value_view value() const;
friend bool operator==(key_value_pair_view l, key_value_pair_view r);
friend bool operator!=(key_value_pair_view l, key_value_pair_view r);
friend bool operator<=(key_value_pair_view l, key_value_pair_view r);
friend bool operator>=(key_value_pair_view l, key_value_pair_view r);
friend bool operator< (key_value_pair_view l, key_value_pair_view r);
friend bool operator> (key_value_pair_view l, key_value_pair_view r);
template< class CharT, class Traits >
friend std::basic_ostream<CharT,Traits>&
operator<<( std::basic_ostream<CharT,Traits>& os, const key_value_pair_view& p );
template< class CharT, class Traits >
friend std::basic_istream<CharT,Traits>&
operator>>( std::basic_istream<CharT,Traits>& is, key_value_pair_view& p );
template<std::size_t Idx>
inline auto get() const -> typename conditional<Idx == 0u, key_view,
value_view>::type;
const value_type * c_str() const noexcept;
const value_type * data() const;
std::size_t size() const;
};
// Allow tuple-likg getters & structured bindings.
template<> key_view key_value_pair_view::get<0u>() const;
template<> value_view key_value_pair_view::get<1u>() const;
// A class representing a key within an environment.
struct key
{
using value_type = char_type;
using traits_type = key_char_traits<char_type>;
using string_type = std::basic_string<char_type, traits_type>;
using string_view_type = basic_string_view<char_type, traits_type>;
key();
key( const key& p ) = default;
key( key&& p ) noexcept = default;
key( const string_type& source );
key( string_type&& source );
key( const value_type * raw );
key( value_type * raw );
explicit key(key_view kv);
template< class Source >
key( const Source& source);
key(const typename conditional<is_same<value_type, char>::value, wchar_t, char>::type * raw);
template< class InputIt >
key( InputIt first, InputIt last);
~key() = default;
key& operator=( const key& p ) = default;
key& operator=( key&& p );
key& operator=( string_type&& source );
template< class Source >
key& operator=( const Source& source );
key& assign( string_type&& source );
template< class Source >
key& assign( const Source& source );
template< class InputIt >
key& assign( InputIt first, InputIt last );
void clear();
void swap( key& other ) noexcept;
const value_type* c_str() const noexcept;
const string_type& native() const noexcept;
string_view_type native_view() const noexcept;
operator string_type() const;
operator string_view_type() const;
int compare( const key& p ) const noexcept;
int compare( const string_type& str ) const;
int compare( string_view_type str ) const;
int compare( const value_type* s ) const;
template< class CharT, class Traits = std::char_traits<CharT>,
class Alloc = std::allocator<CharT> >
std::basic_string<CharT,Traits,Alloc>
basic_string( const Alloc& alloc = Alloc()) const;
std::string string() const;
std::wstring wstring() const;
const string_type & native_string() const;
bool empty() const;
friend bool operator==(const key & l, const key & r);
friend bool operator!=(const key & l, const key & r);
friend bool operator<=(const key & l, const key & r);
friend bool operator>=(const key & l, const key & r);
friend bool operator< (const key & l, const key & r);
friend bool operator> (const key & l, const key & r);
template< class CharT, class Traits >
friend std::basic_ostream<CharT,Traits>&
operator<<( std::basic_ostream<CharT,Traits>& os, const key& p );
template< class CharT, class Traits >
friend std::basic_istream<CharT,Traits>&
operator>>( std::basic_istream<CharT,Traits>& is, key& p );
const value_type * data() const;
std::size_t size() const;
};
bool operator==(const value_view &, const value_view);
bool operator!=(const value_view &, const value_view);
bool operator<=(const value_view &, const value_view);
bool operator< (const value_view &, const value_view);
bool operator> (const value_view &, const value_view);
bool operator>=(const value_view &, const value_view);
struct value
{
using value_type = char_type;
using traits_type = value_char_traits<char_type>;
using string_type = std::basic_string<char_type, traits_type>;
using string_view_type = basic_cstring_ref<char_type, traits_type>;
value();
value( const value& p ) = default;
value( const string_type& source );
value( string_type&& source );
value( const value_type * raw );
value( value_type * raw );
explicit value(value_view kv);
template< class Source >
value( const Source& source );
value(const typename conditional<is_same<value_type, char>::value, wchar_t, char>::type * raw);
template< class InputIt >
value( InputIt first, InputIt last);
~value() = default;
value& operator=( const value& p ) = default;
value& operator=( value&& p );
value& operator=( string_type&& source );
template< class Source >
value& operator=( const Source& source );
value& assign( string_type&& source );
template< class Source >
value& assign( const Source& source );
template< class InputIt >
value& assign( InputIt first, InputIt last );
void push_back(const value & sv);
void clear() {value_.clear();}
void swap( value& other ) noexcept;
const value_type* c_str() const noexcept;
const string_type& native() const noexcept;
string_view_type native_view() const noexcept;
operator string_type() const;
operator string_view_type() const;
operator typename string_view_type::string_view_type() const;
int compare( const value& p ) const noexcept;
int compare( const string_type& str ) const;
int compare( string_view_type str ) const;
int compare( const value_type* s ) const;
template< class CharT, class Traits = std::char_traits<CharT>,
class Alloc = std::allocator<CharT> >
std::basic_string<CharT,Traits,Alloc>
basic_string( const Alloc& alloc = Alloc()) const;
std::string string() const;
std::wstring wstring() const;
const string_type & native_string() const;
bool empty() const;
friend bool operator==(const value & l, const value & r);
friend bool operator!=(const value & l, const value & r);
friend bool operator<=(const value & l, const value & r);
friend bool operator>=(const value & l, const value & r);
friend bool operator< (const value & l, const value & r);
friend bool operator> (const value & l, const value & r);
template< class CharT, class Traits >
friend std::basic_ostream<CharT,Traits>&
operator<<( std::basic_ostream<CharT,Traits>& os, const value& p );
template< class CharT, class Traits >
friend std::basic_istream<CharT,Traits>&
operator>>( std::basic_istream<CharT,Traits>& is, value& p );
value_iterator begin() const;
value_iterator end() const;
const value_type * data() const;
std::size_t size() const;
};
bool operator==(const value_view &, const value_view);
bool operator!=(const value_view &, const value_view);
bool operator<=(const value_view &, const value_view);
bool operator< (const value_view &, const value_view);
bool operator> (const value_view &, const value_view);
bool operator>=(const value_view &, const value_view);
struct key_value_pair
{
using value_type = char_type;
using traits_type = std::char_traits<char_type>;
using string_type = std::basic_string<char_type>;
using string_view_type = basic_cstring_ref<char_type>;
key_value_pair()l
key_value_pair( const key_value_pair& p ) = default;
key_value_pair( key_value_pair&& p ) noexcept = default;
key_value_pair(key_view key, value_view value);
key_value_pair(key_view key, std::initializer_list<basic_string_view<char_type>> values);
key_value_pair( const string_type& source );
key_value_pair( string_type&& source );
key_value_pair( const value_type * raw );
key_value_pair( value_type * raw );
explicit key_value_pair(key_value_pair_view kv) : value_(kv.c_str()) {}
template< class Source >
key_value_pair( const Source& source);
template< typename Key,
typename Value >
key_value_pair(
const std::pair<Key, Value> & kv);
key_value_pair(const typename conditional<is_same<value_type, char>::value, wchar_t, char>::type * raw);
template< class InputIt , typename std::iterator_traits<InputIt>::iterator_category>
key_value_pair( InputIt first, InputIt last );
~key_value_pair() = default;
key_value_pair& operator=( const key_value_pair& p ) = default;
key_value_pair& operator=( key_value_pair&& p );
key_value_pair& operator=( string_type&& source );
template< class Source >
key_value_pair& operator=( const Source& source );
key_value_pair& assign( string_type&& source );
template< class Source >
key_value_pair& assign( const Source& source );
template< class InputIt >
key_value_pair& assign( InputIt first, InputIt last );
void clear();
void swap( key_value_pair& other ) noexcept;
const value_type* c_str() const noexcept;
const string_type& native() const noexcept;
string_view_type native_view() const noexcept;
operator string_type() const;
operator string_view_type() const;
operator typename string_view_type::string_view_type() const;
operator key_value_pair_view() const;
int compare( const key_value_pair& p ) const noexcept;
int compare( const string_type& str ) const;
int compare( string_view_type str ) const;
int compare( const value_type* s ) const;
template< class CharT, class Traits = std::char_traits<CharT>, class Alloc = std::allocator<CharT> >
std::basic_string<CharT,Traits,Alloc>
basic_string( const Alloc& alloc = Alloc() ) const;
std::string string() const {return basic_string<char>();}
std::wstring wstring() const {return basic_string<wchar_t>();}
const string_type & native_string() const;
friend bool operator==(const key_value_pair & l, const key_value_pair & r);
friend bool operator!=(const key_value_pair & l, const key_value_pair & r);
friend bool operator<=(const key_value_pair & l, const key_value_pair & r);
friend bool operator>=(const key_value_pair & l, const key_value_pair & r);
friend bool operator< (const key_value_pair & l, const key_value_pair & r);
friend bool operator> (const key_value_pair & l, const key_value_pair & r);
bool empty() const;
struct key_view key() const;
struct value_view value() const;
template< class CharT, class Traits >
friend std::basic_ostream<CharT,Traits>&
operator<<( std::basic_ostream<CharT,Traits>& os, const key_value_pair& p );
template< class CharT, class Traits >
friend std::basic_istream<CharT,Traits>&
operator>>( std::basic_istream<CharT,Traits>& is, key_value_pair& p );
const value_type * data() const;
std::size_t size() const;
template<std::size_t Idx>
inline auto get() const -> typename conditional<Idx == 0u,environment::key_view, environment::value_view>::type;
};
bool operator==(const key_value_pair_view &, const key_value_pair_view);
bool operator!=(const key_value_pair_view &, const key_value_pair_view);
bool operator<=(const key_value_pair_view &, const key_value_pair_view);
bool operator< (const key_value_pair_view &, const key_value_pair_view);
bool operator> (const key_value_pair_view &, const key_value_pair_view);
bool operator>=(const key_value_pair_view &, const key_value_pair_view);
// Allow tuple-likg getters & structured bindings.
template<>
key_view key_value_pair::get<0u>() const;
template<>
value_view key_value_pair::get<1u>() const;
// A view object for the current environment of this process.
/*
* The view might (windows) or might not (posix) be owning;
* if it owns it will deallocate the on destruction, like a unique_ptr.
*
* Note that accessing the environment in this way is not thread-safe.
*
* @code
*
* void dump_my_env(current_view env = current())
* {
* for (auto & [k, v] : env)
* std::cout << k.string() << " = " << v.string() << std::endl;
* }
*
* @endcode
*
*
*/
struct current_view
{
using native_handle_type = environment::native_handle_type;
using value_type = key_value_pair_view;
current_view() = default;
current_view(current_view && nt) = default;
native_handle_type native_handle() { return handle_.get(); }
struct iterator
{
using value_type = key_value_pair_view;
using difference_type = int;
using reference = key_value_pair_view;
using pointer = key_value_pair_view;
using iterator_category = std::forward_iterator_tag;
iterator() = default;
iterator(const iterator & ) = default;
iterator(const native_iterator &native_handle) : iterator_(native_handle) {}
iterator & operator++()
{
iterator_ = detail::next(iterator_);
return *this;
}
iterator operator++(int)
{
auto last = *this;
iterator_ = detail::next(iterator_);
return last;
}
key_value_pair_view operator*() const
{
return detail::dereference(iterator_);
}
friend bool operator==(const iterator & l, const iterator & r) {return l.iterator_ == r.iterator_;}
friend bool operator!=(const iterator & l, const iterator & r) {return l.iterator_ != r.iterator_;}
private:
environment::native_iterator iterator_;
};
iterator begin() const {return iterator(handle_.get());}
iterator end() const {return iterator(detail::find_end(handle_.get()));}
private:
std::unique_ptr<typename remove_pointer<native_handle_type>::type,
detail::native_handle_deleter> handle_{environment::detail::load_native_handle()};
};
// Obtain a handle to the current environment
inline current_view current() {return current_view();}
// Find the home folder in an environment-like type.
/*
* @param env The environment to search. Defaults to the current environment of this process
*
* The environment type passed in must be a range with value T that fulfills the following requirements:
*
* For `T value`
*
* - std::get<0>(value) must return a type comparable to `key_view`.
* - std::get<1>(value) must return a type convertible to filesystem::path.
*
* @return A filesystem::path to the home directory or an empty path if it cannot be found.
*
*/
template<typename Environment = current_view>
inline filesystem::path home(Environment && env = current());
// Find the executable `name` in an environment-like type.
template<typename Environment = current_view>
filesystem::path find_executable(BOOST_PROCESS_V2_NAMESPACE::filesystem::path name,
Environment && env = current());
// Get an environment variable from the current process.
value get(const key & k, error_code & ec);
value get(const key & k);
value get(basic_cstring_ref<char_type, key_char_traits<char_type>> k, error_code & ec);
value get(basic_cstring_ref<char_type, key_char_traits<char_type>> k);
value get(const char_type * c, error_code & ec);
value get(const char_type * c);
// Set an environment variable for the current process.
void set(const key & k, value_view vw, error_code & ec);
void set(const key & k, value_view vw);
void set(basic_cstring_ref<char_type, key_char_traits<char_type>> k, value_view vw, error_code & ec);
void set(basic_cstring_ref<char_type, key_char_traits<char_type>> k, value_view vw);
void set(const char_type * k, value_view vw, error_code & ec);
void set(const char_type * k, value_view vw);
template<typename Char>
void set(const key & k, const Char * vw, error_code & ec);
template<typename Char>
void set(const key & k, const Char * vw);
template<typename Char>
void set(basic_cstring_ref<char_type, key_char_traits<char_type>> k, const Char * vw, error_code & ec);
template<typename Char>
void set(basic_cstring_ref<char_type, key_char_traits<char_type>> k, const Char * vw);
template<typename Char>
void set(const char_type * k, const Char * vw, error_code & ec);
template<typename Char>
void set(const char_type * k, const Char * vw);
// Remove an environment variable from the current process.
void unset(const key & k, error_code & ec);
void unset(const key & k);
void unset(basic_cstring_ref<char_type, key_char_traits<char_type>> k, error_code & ec);
void unset(basic_cstring_ref<char_type, key_char_traits<char_type>> k);
void unset(const char_type * c, error_code & ec);
void unset(const char_type * c);
}
----
=== `process_environment`
In order to set the environment of a child process, `process_environment` can be used.
[source, cpp]
.This will set the environment in a subprocess:
----
process proc{executor, find_executable("printenv"), {"foo"}, process_environment{"foo=bar"}};
----
The environment initializer will persist it's state, so that it can
be used multiple times. Do however note the the Operating System is
allowed to modify the internal state.
[source,cpp]
----
auto exe = find_executable("printenv");
process_environment env = {"FOO=BAR", "BAR=FOO"};
process proc1(executor, exe, {"FOO"}, env);
process proc2(executor, exe, {"BAR"}, env);
----

36
doc/reference/error.adoc Normal file
View File

@@ -0,0 +1,36 @@
== `error.hpp`
[#error]
The error header provides two error categories:
[source,cpp]
----
// Errors used for utf8 <-> UCS-2 conversions.
enum utf8_conv_error
{
insufficient_buffer = 1,
invalid_character,
};
extern const error_category& get_utf8_category();
static const error_category& utf8_category = get_utf8_category();
extern const error_category& get_exit_code_category();
/// An error category that can be used to interpret exit codes of subprocesses.
static const error_category& exit_code_category = get_exit_code_category();
}
----
The `get_exit_code_category` can be used as follows:
[source,cpp]
----
void run_my_process(filesystem::path pt, error_code & ec)
{
process proc(pt, {});
proc.wait();
ec.assign(proc.native_exit_code(), error::get_exit_code_category());
}
----

View File

@@ -0,0 +1,33 @@
== `execute.hpp`
[#execute]
The execute header provides two error categories:
[source,cpp]
----
// Run a process and wait for it to complete.
template<typename Executor> int execute(basic_process<Executor> proc);
template<typename Executor> int execute(basic_process<Executor> proc, error_code & ec)
// Execute a process asynchronously
template<typename Executor = net::any_io_executor,
BOOST_PROCESS_V2_COMPLETION_TOKEN_FOR(void (error_code, int))
WaitHandler = net::default_completion_token_t<Executor>>
auto async_execute(basic_process<Executor> proc,
WaitHandler && handler = net::default_completion_token_t<Executor>());
----
The `async_execute` function asynchronously for a process to complete.
Cancelling the execution will signal the child process to exit
with the following interpretations:
- `cancellation_type::total` -> interrupt
- `cancellation_type::partial` -> request_exit
- `cancellation_type::terminal` -> terminate
It is to note that `async_execute` will use the lowest selected cancellation
type. A subprocess might ignore anything not terminal.

View File

@@ -0,0 +1,43 @@
== `exit_code.hpp`
[#exit_code]
The exit code header provides portable handles for exit codes.
[source,cpp]
----
// The native exit-code type, usually an integral value
/* The OS may have a value different from `int` to represent
* the exit codes of subprocesses. It might also
* contain additional information.
*/
typedef implementation_defined native_exit_code_type;
// Check if the native exit code indicates the process is still running
bool process_is_running(native_exit_code_type code);
// Obtain the portable part of the exit code, i.e. what the subprocess has returned from main.
int evaluate_exit_code(native_exit_code_type code);
// Helper to subsume an exit-code into an error_code if there's no actual error isn't set.
error_code check_exit_code(
error_code &ec, native_exit_code_type native_code,
const error_category & category = error::get_exit_code_category());
----
The `check_exit_code` can be used like this:
[source,cpp]
----
process proc{co_await this_coro::executor, "exit", {"1"}};
co_await proc.async_wait(
asio::deferred(
[&proc](error_code ec, int)
{
return asio::deferred.values(
check_exit_code(ec, proc.native_exit_code())
);
----

46
doc/reference/ext.adoc Normal file
View File

@@ -0,0 +1,46 @@
== `ext`
The headers in `process/ext` provides features to obtain information about third part processes.
[source,cpp]
----
// Get the cmd line used to launche the process
template<typename Executor>
shell cmd(basic_process_handle<Executor> & handle, error_code & ec);
template<typename Executor>
shell cmd(basic_process_handle<Executor> & handle);
shell cmd(pid_type pid, error_code & ec);
shell cmd(pid_type pid);
// Get the current working directory of the process.
template<typename Executor>
filesystem::path cwd(basic_process_handle<Executor> & handle, error_code & ec);
template<typename Executor>
filesystem::path cwd(basic_process_handle<Executor> & handle)
filesystem::path cwd(pid_type pid, error_code & ec);
filesystem::path cwd(pid_type pid);
// Get the current environment of the process.
template<typename Executor>
env_view cwd(basic_process_handle<Executor> & handle, error_code & ec);
template<typename Executor>
env_view cwd(basic_process_handle<Executor> & handle)
env_view env(pid_type pid, error_code & ec);
env_view env(pid_type pid);
// Get the executable of the process.
template<typename Executor>
filesystem::path exe(basic_process_handle<Executor> & handle, error_code & ec);
template<typename Executor>
filesystem::path exe(basic_process_handle<Executor> & handle)
filesystem::path exe(pid_type pid, error_code & ec);
filesystem::path exe(pid_type pid);
----
WARNING: The function may fail with "operation_not_supported" on some niche platforms.
NOTE: On windows overloads taking a `HANDLE` are also available.

23
doc/reference/pid.adoc Normal file
View File

@@ -0,0 +1,23 @@
== `pid.hpp`
[#pid]
[source,cpp]
----
//An integral type representing a process id.
typedef implementation_defined pid_type;
// Get the process id of the current process.
pid_type current_pid();
// List all available pids.
std::vector<pid_type> all_pids(boost::system::error_code & ec);
std::vector<pid_type> all_pids();
// return parent pid of pid.
pid_type parent_pid(pid_type pid, boost::system::error_code & ec);
pid_type parent_pid(pid_type pid);
// return child pids of pid.
std::vector<pid_type> child_pids(pid_type pid, boost::system::error_code & ec);
std::vector<pid_type> child_pids(pid_type pid);
----

163
doc/reference/popen.adoc Normal file
View File

@@ -0,0 +1,163 @@
== `popen.hpp`
[#popen]
`popen` is a class that launches a process and connect stdin & stdout to pipes.
[source,cpp]
----
popen proc(executor, find_executable("addr2line"), {argv[0]});
asio::write(proc, asio::buffer("main\n"));
std::string line;
asio::read_until(proc, asio::dynamic_buffer(line), '\n');
----
[source,cpp]
----
// A subprocess with automatically assigned pipes.
template<typename Executor = net::any_io_executor>
struct basic_popen : basic_process<Executor>
{
// The executor of the process
using executor_type = Executor;
// Rebinds the popen type to another executor.
template <typename Executor1>
struct rebind_executor
{
// The pipe type when rebound to the specified executor.
typedef basic_popen<Executor1> other;
};
// Move construct a popen
basic_popen(basic_popen &&) = default;
// Move assign a popen
basic_popen& operator=(basic_popen &&) = default;
// Move construct a popen and change the executor type.
template<typename Executor1>
basic_popen(basic_popen<Executor1>&& lhs)
: basic_process<Executor>(std::move(lhs)),
stdin_(std::move(lhs.stdin_)), stdout_(std::move(lhs.stdout_))
{
}
// Create a closed process handle
explicit basic_popen(executor_type exec);
// Create a closed process handle
template <typename ExecutionContext>
explicit basic_popen(ExecutionContext & context);
// Construct a child from a property list and launch it using the default process launcher.
template<typename ... Inits>
explicit basic_popen(
executor_type executor,
const filesystem::path& exe,
std::initializer_list<string_view> args,
Inits&&... inits);
// Construct a child from a property list and launch it using the default process launcher.
template<typename Launcher, typename ... Inits>
explicit basic_popen(
Launcher && launcher,
executor_type executor,
const filesystem::path& exe,
std::initializer_list<string_view> args,
Inits&&... inits);
// Construct a child from a property list and launch it using the default process launcher.
template<typename Args, typename ... Inits>
explicit basic_popen(
executor_type executor,
const filesystem::path& exe,
Args&& args, Inits&&... inits);
// Construct a child from a property list and launch it using the default process launcher.
template<typename Launcher, typename Args, typename ... Inits>
explicit basic_popen(
Launcher && launcher,
executor_type executor,
const filesystem::path& exe,
Args&& args, Inits&&... inits);
// Construct a child from a property list and launch it using the default process launcher.
template<typename ExecutionContext, typename ... Inits>
explicit basic_popen(
ExecutionContext & context,
const filesystem::path& exe,
std::initializer_list<string_view> args,
Inits&&... inits);
// Construct a child from a property list and launch it using the default process launcher.
template<typename Launcher, typename ExecutionContext, typename ... Inits>
explicit basic_popen(
Launcher && launcher,
ExecutionContext & context,
const filesystem::path& exe,
std::initializer_list<string_view> args,
Inits&&... inits);
// Construct a child from a property list and launch it using the default process launcher.
template<typename ExecutionContext, typename Args, typename ... Inits>
explicit basic_popen(
ExecutionContext & context,
const filesystem::path& exe,
Args&& args, Inits&&... inits);
// Construct a child from a property list and launch it using the default process launcher.
template<typename Launcher, typename ExecutionContext, typename Args, typename ... Inits>
explicit basic_popen(
Launcher && launcher,
ExecutionContext & context,
const filesystem::path& exe,
Args&& args, Inits&&... inits);
// The type used for stdin on the parent process side.
using stdin_type = net::basic_writable_pipe<Executor>;
// The type used for stdout on the parent process side.
using stdout_type = net::basic_readable_pipe<Executor>;
// Get the stdin pipe.
// Get the stdout pipe.
// Get the stdin pipe.
stdin_type & get_stdin();
const stdin_type & get_stdin() const;
// Get the stdout pipe.
stdout_type & get_stdout();
const stdout_type & get_stdout() const;
// Write some data to the stdin pipe.
template <typename ConstBufferSequence>
std::size_t write_some(const ConstBufferSequence& buffers);
template <typename ConstBufferSequence>
std::size_t write_some(const ConstBufferSequence& buffers,
boost::system::error_code& ec);
// Start an asynchronous write.
template <typename ConstBufferSequence,
BOOST_ASIO_COMPLETION_TOKEN_FOR(void (boost::system::error_code, std::size_t))
WriteToken = net::default_completion_token_t<executor_type>>
auto async_write_some(const ConstBufferSequence& buffers,
WriteToken && token = net::default_completion_token_t<executor_type>());
// Read some data from the stdout pipe.
template <typename MutableBufferSequence>
std::size_t read_some(const MutableBufferSequence& buffers);
template <typename MutableBufferSequence>
std::size_t read_some(const MutableBufferSequence& buffers,
boost::system::error_code& ec)
// Start an asynchronous read. template <typename MutableBufferSequence,
BOOST_PROCESS_V2_COMPLETION_TOKEN_FOR(void (boost::system::error_code, std::size_t))
ReadToken = net::default_completion_token_t<executor_type>>
auto async_read_some(const MutableBufferSequence& buffers,
BOOST_ASIO_MOVE_ARG(ReadToken) token
= net::default_completion_token_t<executor_type>());
};
// A popen object with the default executor.
using popen = basic_popen<>;
----

View File

@@ -0,0 +1,70 @@
== `posix/bind_fd.hpp`
`bind_fd` is a utility class to bind a file descriptor to an explicit file descriptor for the child process.
[source,cpp]
----
struct bind_fd
{
// Inherit file descriptor with the same value.
/*
* This will pass descriptor 42 as 42 to the child process:
* @code
* process p{"test", {}, posix::bind_fd(42)};
* @endcode
*/
bind_fd(int target);
// Inherit an asio io-object as a given file descriptor to the child process.
/*
* This will pass the tcp::socket, as 42 to the child process:
* @code
* extern tcp::socket sock;
* process p{"test", {}, posix::bind_fd(42, sock)};
* @endcode
*/
template<typename Stream>
bind_fd(int target, Stream && str);
// Inherit a `FILE` as a given file descriptor to the child process.
/* This will pass the given `FILE*`, as 42 to the child process:
process p{"test", {}, posix::bind_fd(42, stderr)};
*/
bind_fd(int target, FILE * f);
// Inherit a file descriptor with as a different value.
/* This will pass 24 as 42 to the child process:
process p{"test", {}, posix::bind_fd(42, 24)};
*/
bind_fd(int target, int fd);
// Inherit a null device as a set descriptor.
/* This will a null device as 42 to the child process:
process p{"test", {}, posix::bind_fd(42, nullptr)};
*/
bind_fd(int target, std::nullptr_t);
// Inherit a newly opened-file as a set descriptor.
/* This will pass a descriptor to "extra-output.txt" as 42 to the child process:
process p{"test", {}, posix::bind_fd(42, "extra-output.txt")};
*/
bind_fd(int target, const filesystem::path & pth, int flags = O_RDWR | O_CREAT);
};
----
Using `bind_fd` can be used to inherit file descriptors explicitly, because no unused one will be.
[source,cpp]
----
----

174
doc/reference/process.adoc Normal file
View File

@@ -0,0 +1,174 @@
== `process.hpp`
[#process]
[source,cpp]
----
// A class managing a subprocess
/* A `basic_process` object manages a subprocess; it tracks the status and exit-code,
* and will terminate the process on destruction if `detach` was not called.
*/
template<typename Executor = net::any_io_executor>
struct basic_process
{
// The executor of the process
using executor_type = Executor;
// Get the executor of the process
executor_type get_executor() {return process_handle_.get_executor();}
// The non-closing handle type
using handle_type = basic_process_handle<executor_type>;
// Get the underlying non-closing handle
handle_type & handle() { return process_handle_; }
// Get the underlying non-closing handle
const handle_type & handle() const { return process_handle_; }
// Provides access to underlying operating system facilities
using native_handle_type = typename handle_type::native_handle_type;
// Rebinds the process_handle to another executor.
template <typename Executor1>
struct rebind_executor
{
// The socket type when rebound to the specified executor.
typedef basic_process<Executor1> other;
};
/** An empty process is similar to a default constructed thread. It holds an empty
handle and is a place holder for a process that is to be launched later. */
basic_process() = default;
basic_process(const basic_process&) = delete;
basic_process& operator=(const basic_process&) = delete;
// Move construct the process. It will be detached from `lhs`.
basic_process(basic_process&& lhs) = default;
// Move assign a process. It will be detached from `lhs`.
basic_process& operator=(basic_process&& lhs) = default;
// Move construct and rebind the executor.
template<typename Executor1>
basic_process(basic_process<Executor1>&& lhs);
// Construct a child from a property list and launch it using the default launcher..
template<typename ... Inits>
explicit basic_process(
executor_type executor,
const filesystem::path& exe,
std::initializer_list<string_view> args,
Inits&&... inits);
// Construct a child from a property list and launch it using the default launcher..
template<typename Args, typename ... Inits>
explicit basic_process(
executor_type executor,
const filesystem::path& exe,
Args&& args, Inits&&... inits);
// Construct a child from a property list and launch it using the default launcher..
template<typename ExecutionContext, typename ... Inits>
explicit basic_process(
ExecutionContext & context,
const filesystem::path& exe,
std::initializer_list<string_view> args,
Inits&&... inits);
// Construct a child from a property list and launch it using the default launcher.
template<typename ExecutionContext, typename Args, typename ... Inits>
explicit basic_process(
ExecutionContext & context,
const filesystem::path& exe,
Args&& args, Inits&&... inits);
// Attach to an existing process
explicit basic_process(executor_type exec, pid_type pid);
// Attach to an existing process and the internal handle
explicit basic_process(executor_type exec, pid_type pid, native_handle_type native_handle);
// Create an invalid handle
explicit basic_process(executor_type exec);
// Attach to an existing process
template <typename ExecutionContext>
explicit basic_process(ExecutionContext & context, pid_type pid);
// Attach to an existing process and the internal handle
template <typename ExecutionContext>
explicit basic_process(ExecutionContext & context, pid_type pid, native_handle_type native_handle);
// Create an invalid handle
template <typename ExecutionContext>
explicit basic_process(ExecutionContext & context);
// Destruct the handle and terminate the process if it wasn't detached.
~basic_process();
// Sends the process a signal to ask for an interrupt, which the process may interpret as a shutdown.
/** Maybe be ignored by the subprocess. */
void interrupt(error_code & ec);
void interrupt();
// Throwing @overload void interrupt()
// Sends the process a signal to ask for a graceful shutdown. Maybe be ignored by the subprocess.
void request_exit(error_code & ec);
void request_exit();
// Send the process a signal requesting it to stop. This may rely on undocumented functions.
void suspend(error_code &ec);
void suspend();
// Send the process a signal requesting it to resume. This may rely on undocumented functions.
void resume(error_code &ec);
void resume();
// Unconditionally terminates the process and stores the exit code in exit_status.
void terminate(error_code & ec);
void terminate();
// Waits for the process to exit, store the exit code internally and return it.
int wait(error_code & ec);
int wait();
// Detach the process.
handle_type detach();
// Get the native
native_handle_type native_handle() {return process_handle_.native_handle(); }
// Return the evaluated exit_code.
int exit_code() const;
// Get the id of the process;
pid_type id() const;
// The native handle of the process.
/** This might be undefined on posix systems that only support signals */
native_exit_code_type native_exit_code() const;
// Checks if the current process is running.
/* If it has already completed the exit code will be stored internally
* and can be obtained by calling `exit_code.
*/
bool running();
bool running(error_code & ec) noexcept;
// Check if the process is referring to an existing process.
/** Note that this might be a process that already exited.*/
bool is_open() const;
// Asynchronously wait for the process to exit and deliver the native exit-code in the completion handler.
template <BOOST_PROCESS_V2_COMPLETION_TOKEN_FOR(void (error_code, int))
WaitHandler = net::default_completion_token_t<executor_type>>
auto async_wait(WaitHandler && handler = net::default_completion_token_t<executor_type>());
};
// Process with the default executor.
typedef basic_process<> process;
----

View File

@@ -0,0 +1,109 @@
== `process_handle.hpp`
[#process_handle]
A process handle is an unmanaged version of a process.
This means it does not terminate the process on destruction and
will not keep track of the exit-code.
NOTE: that the exit code might be discovered early, during a call to `running`.
Thus it can only be discovered that process has exited already.
[source,cpp]
----
template<typename Executor = net::any_io_executor>
struct basic_process_handle
{
// The native handle of the process.
/* This might be undefined on posix systems that only support signals */
using native_handle_type = implementation_defined;
// The executor_type of the process_handle
using executor_type = Executor;
// Getter for the executor
executor_type get_executor();
// Rebinds the process_handle to another executor.
template<typename Executor1>
struct rebind_executor
{
// The socket type when rebound to the specified executor.
typedef basic_process_handle<Executor1> other;
};
// Construct a basic_process_handle from an execution_context.
/*
* @tparam ExecutionContext The context must fulfill the asio::execution_context requirements
*/
template<typename ExecutionContext>
basic_process_handle(ExecutionContext &context);
// Construct an empty process_handle from an executor.
basic_process_handle(executor_type executor);
// Construct an empty process_handle from an executor and bind it to a pid.
/* On NON-linux posix systems this call is not able to obtain a file-descriptor and will thus
* rely on signals.
*/
basic_process_handle(executor_type executor, pid_type pid);
// Construct an empty process_handle from an executor and bind it to a pid and the native-handle
/* On some non-linux posix systems this overload is not present.
*/
basic_process_handle(executor_type executor, pid_type pid, native_handle_type process_handle);
// Move construct and rebind the executor.
template<typename Executor1>
basic_process_handle(basic_process_handle<Executor1> &&handle);
// Get the id of the process
pid_type id() const
{ return pid_; }
// Terminate the process if it's still running and ignore the result
void terminate_if_running(error_code &);
// Throwing @overload void terminate_if_running(error_code & ec;
void terminate_if_running();
// wait for the process to exit and store the exit code in exit_status.
void wait(native_exit_code_type &exit_status, error_code &ec);
// Throwing @overload wait(native_exit_code_type &exit_code, error_code & ec)
void wait(native_exit_code_type &exit_status);
// Sends the process a signal to ask for an interrupt, which the process may interpret as a shutdown.
/* Maybe be ignored by the subprocess. */
void interrupt(error_code &ec);
// Throwing @overload void interrupt()
void interrupt();
// Sends the process a signal to ask for a graceful shutdown. Maybe be ignored by the subprocess.
void request_exit(error_code &ec);
// Throwing @overload void request_exit(error_code & ec)
void request_exit()
// Unconditionally terminates the process and stores the exit code in exit_status.
void terminate(native_exit_code_type &exit_status, error_code &ec);\
// Throwing @overload void terminate(native_exit_code_type &exit_code, error_code & ec)
void terminate(native_exit_code_type &exit_status);/
// Checks if the current process is running.
/*If it has already completed, it assigns the exit code to `exit_code`.
*/
bool running(native_exit_code_type &exit_code, error_code &ec);
// Throwing @overload bool running(native_exit_code_type &exit_code, error_code & ec)
bool running(native_exit_code_type &exit_code);
// Check if the process handle is referring to an existing process.
bool is_open() const;
// Asynchronously wait for the process to exit and assign the native exit-code to the reference.
// The exit_status can indicate that a process has already be waited for, e.g. when terminate is called.
template<BOOST_PROCESS_V2_COMPLETION_TOKEN_FOR(void(error_code))
WaitHandler = net::default_completion_token_t<executor_type>>
auto async_wait(native_exit_code_type &exit_status, WaitHandler &&handler = net::default_completion_token_t<executor_type>());
};
----

57
doc/reference/shell.adoc Normal file
View File

@@ -0,0 +1,57 @@
== `shell.hpp`
[#shell]
This utility class parses command lines into tokens
and allows users to execute processes based on textual inputs.
In v1, this was possible directly when starting a process,
but has been removed based on the security risks associated with this.
By making the shell parsing explicitly, it encourages
a user to run a sanity check on the executable before launching it.
.Example
[source,cpp]
----
asio::io_context ctx;
auto cmd = shell("my-app --help");
auto exe = cmd.exe();
check_if_malicious(exe);
process proc{ctx, exe, cmd.args()};
----
[source,cpp]
----
/// Utility to parse commands
struct shell
{
shell() = default;
template<typename Char, typename Traits>
shell(basic_string_view<Char, Traits> input);
shell(basic_cstring_ref<char_type> input);
shell(const shell &) = delete;
shell(shell && lhs) noexcept;
shell& operator=(const shell &) = delete;
shell& operator=(shell && lhs) noexcept;
// the length of the parsed shell, including the executable
int argc() const ;
char_type** argv() const;
char_type** begin() const;
char_type** end() const;
bool empty() const;
std::size_t size() const;
// Native representation of the arguments to be used - excluding the executable
args_type args() const;
template<typename Environment = environment::current_view>
filesystem::path exe(Environment && env = environment::current()) const;
};
----

View File

@@ -0,0 +1,16 @@
== `start_dir.hpp`
[#start_dir]
[source,cpp]
----
/// Initializer for the starting directory of a subprocess to be launched.
struct process_start_dir
{
filesystem::path start_dir;
process_start_dir(filesystem::path start_dir);
{
}
};
----

100
doc/reference/stdio.adoc Normal file
View File

@@ -0,0 +1,100 @@
== `stdio.hpp`
[#stdio]
The initializer for the stdio of a subprocess
The subprocess stdio initializer has three members:
- in for stdin
- out for stdout
- err for stderr
If the initializer is present all three will be set for the subprocess.
By default they will inherit the stdio handles from the parent process.
This means that this will forward stdio to the subprocess:
[source,cpp]
----
asio::io_context ctx;
v2::process proc(ctx, "/bin/bash", {}, v2::process_stdio{});
----
No constructors are provided in order to support designated initializers
in later version of C++.
[source,cpp]
----
asio::io_context ctx;
/// C++17
v2::process proc17(ctx, "/bin/bash", {}, v2::process_stdio{.err=nullptr});
/// C++11 & C++14
v2::process proc17(ctx, "/bin/bash", {}, v2::process_stdio{ {}, {}, nullptr});
----
Valid initializers for any stdio are:
- `std::nullptr_t` assigning a null-device
- `FILE*` any open file, including `stdin`, `stdout` and `stderr`
- `native_handle` any native file handle (`HANDLE` on windows) or file descriptor (`int` on posix)
- any io-object with a `.native_handle()` function that is compatible with the above. E.g. a `asio::ip::tcp::socket`, or a pipe object.
- a filesystem::path, which will open a readable or writable depending on the direction of the stream
- an `asio::basic_writeable_pipe` for stdin or `asio::basic_readable_pipe` for stderr/stdout.
When passing a `FILE*`, a `native_handle` or an io-object with a `native_handle`,
the initializer will assign the handle as is to the child process.
That is the file descriptor/handle gets cloned into the subprocess and used without modification.
When passing a filesystem::path, the initializer will attempt to open the file and then pass the handle
to the subprocess.
When passing a `readable_pipe` to stdout/stderr or a `writable_pipe` to stdin by reference,
the initializer to create the other side of the pipe (`writable_pipe` for stdout/stderr, `readable_pipe` for `stdin`),
connect the pair and pass the native_handle to the child process.
That is, these two are equivalent:
.Implicit construction of the readable pipe.
[source,cpp]
----
asio::io_context ctx;
asio::writable_pipe wp{ctx};
// create a readable pipe internally and connect it to wp
process proc{ctx, "/bin/bash", {}, process_stdio{.in=wp}};
// create it explicitly
{
// the pipe the child process reads from
asio::readable_pipe rp{ctx};
asio::connect_pipe(rp, wp);
// `rp.native_handle()` will be assigned to the child processes stdin
process proc{ctx, "/bin/bash", {}, process_stdio{.in=rp}};
rp.close(); // close it so the pipe closes when the `proc exits.
}
----
The explicit version allows you to assign the same `writable_pipe` to `stdout` and `stderr`:
[source,cpp]
----
// the pipe the parent process reads from and both
// stderr & stdout of the child process write to
asio::readable_pipe rp{ctx};
asio::writable_pipe wp{ctx};
asio::connect_pipe(rp, wp);
process proc{ctx, "/bin/bash", {}, process_stdio{.out=wp, .err=wp}};
wp.close(); // close it so the pipe closes when the `proc exits.
----
NOTE: If the child writes to a pipe, the parent reads from it et vice versa.
[source,cpp]
----
/// The initializer for the stdio of a subprocess
struct process_stdio
{
__implementation_defined__ in;
__implementation_defined__ out;
__implementation_defined__ err;
};
----

View File

@@ -0,0 +1,27 @@
== `windows/creation_flags.hpp`
Creation flags allows explicitly setting `dwFlags`
[source,cpp]
----
// An initializer to add to the dwFlags in the startup-info
template<DWORD Flags>
struct process_creation_flags;
// A flag to create a new process group. Necessary to allow interrupts for the subprocess.
constexpr static process_creation_flags<CREATE_NEW_PROCESS_GROUP> create_new_process_group;
// Breakaway from the current job object.
constexpr static process_creation_flags<CREATE_BREAKAWAY_FROM_JOB> create_breakaway_from_job;
// Allocate a new console.
constexpr static process_creation_flags<CREATE_NEW_CONSOLE> create_new_console;
----
The flags can be used like this:
[source,cpp]
----
process p{"C:\\not-a-virus.exe", {}, process::windows::create_new_console};
----

View File

@@ -0,0 +1,32 @@
== `windows/show_window.hpp`
Creation flags allows explicitly setting `wShowWindow` options
[source,cpp]
----
/// A templated initializer to set wShowWindow flags.
template<DWORD Flags>
struct process_show_window;
//Hides the window and activates another window.
constexpr static process_show_window<SW_HIDE > show_window_hide;
//Activates the window and displays it as a maximized window.
constexpr static process_show_window<SW_SHOWMAXIMIZED > show_window_maximized;
//Activates the window and displays it as a minimized window.
constexpr static process_show_window<SW_SHOWMINIMIZED > show_window_minimized;
//Displays the window as a minimized window. This value is similar to `minimized`, except the window is not activated.
constexpr static process_show_window<SW_SHOWMINNOACTIVE> show_window_minimized_not_active;
//Displays a window in its most recent size and position. This value is similar to show_normal`, except that the window is not activated.
constexpr static process_show_window<SW_SHOWNOACTIVATE > show_window_not_active;
//Activates and displays a window. If the window is minimized or maximized, the system restores it to its original size and position. An application should specify this flag when displaying the window for the first time.
constexpr static process_show_window<SW_SHOWNORMAL > show_window_normal;
----
The flags can be used like this:
[source,cpp]
----
process p{"C:\\not-a-virus.exe", {}, process::windows::show_window_minimized};
----

13
doc/start_dir.adoc Normal file
View File

@@ -0,0 +1,13 @@
== `process_start_dir`
The easier initializer to use is `process_start_dir`:
.example/start_dir.cpp:17-20
[source,cpp,indent=0]
----
include::../example/start_dir.cpp[tag=start_dir]
----
This will run `ls` in the folder `/home` instead of the current folder.
WARNING: If your path is relative, it may fail on posix, because the directory is changed before a call to execve.

65
doc/stdio.adoc Normal file
View File

@@ -0,0 +1,65 @@
= stdio
When using io with a subprocess, all three standard streams (stdin, stdout, stderr) get set for the child-process.
The default setting is to inherit the parent process.
This feature meant to be flexible, which is why there is little checking on the arguments assigned to one of those streams.
== Pipes
asio pipes can be used for io. When using in process_stdio they will get
automatically connected and the other side will get assigned to the child process:
.example/stdio.cpp:20-29
[source,cpp,indent=0]
----
include::../example/stdio.cpp[tag=readable_pipe]
----
readable pipes can be assigned to `out` and `err`, while writable_pipes can be assigned to `in`.
== `FILE*`
`FILE*` can also be used for either side; this allows the `stdin`, `stderr`, `stdout` macros to be used:
.example/stdio.cpp:35-38
[source,cpp]
----
include::../example/stdio.cpp[tag=file]
----
== `nullptr`
`nullptr` may be used to set a given stream to be opened on the null-device (`/dev/null` on posix, `NUL` on windows).
This is used to ignore output or give only EOF as input.
.example/stdio.cpp:43-46
[source,cpp]
----
include::../example/stdio.cpp[tag=null]
----
== `native_handle`
A native handle can be used as well, which means an `int` on posix or a `HANDLE` on windows.
Furthermore, any object that has a `native_handle` function which returns a valid type for a stdio stream.
E.g. a domain socket on linux.
.example/stdio.cpp:52-57
[source,cpp]
----
include::../example/stdio.cpp[tag=native_handle]
----
== popen
Additionally, process v2 provides a `popen` class.
It starts a process and connects pipes for stdin and stdout, so that the popen object can be used as a stream.
.example/stdio.cpp:63-66
[source,cpp]
----
include::../example/stdio.cpp[tag=popen]
----

View File

@@ -1,11 +0,0 @@
[section:v1 Process V1]
[include v1/introduction.qbk]
[include v1/concepts.qbk]
[include v1/tutorial.qbk]
[include v1/design.qbk]
[include v1/extend.qbk]
[include v1/faq.qbk]
[xinclude reference_v2.xml]
[endsect]

View File

@@ -1,82 +0,0 @@
[section:concepts Concepts]
In this section, some of the underlying concepts of the operating system used in this library, will be explained.
In the following chapters we will presume knowledge of that. Though please note,
that this is a short summary and not conclusive of everything that can be done.
The goal of this library is to implement a portable wrapper, so that we will explain mostly what
windows and posix have in common.
[section:pipes Pipes]
Pipes are a facility for communication between different threads, processes and in some cases machines, the operating system provides.
The typical feature of a pipe is, that it is one channel, to which two handles are given, one for reading (source), one for writing (sink).
In that it is different than other facilities (like sockets) and provides another way to manage the connectivity: if one side of the pipe is closed
(i.e. the pipe is broken), the other is notified.
Pipes are typically used for interprocess communication. The main reason is, that pipes can be directly assigned to the process stdio, i.e. stderr, stdin and stdout.
Additionally, half of the pipe can be inherited to the child process and closed in the father process. This will cause the pipe to be broken when the child process exits.
Though please note, that if the same thread reads and writes to a pipe, it will only talk to itself.
[section:anonymous Anonymous Pipes]
The most common pipes are anonymous. Since they have no name,
a handle to them can only be obtained from duplicating either handle.
In this library the following functions are used for the creation of unnamed pipes:
* [@http://pubs.opengroup.org/onlinepubs/7908799/xsh/pipe.html posix]
* [@https://msdn.microsoft.com/de-de/library/windows/desktop/aa365152.aspx windows]
[endsect]
[section:named Named Pipes]
As the name suggests, named pipes have a string identifier. This means that a
handle to them can be obtained with the identifier, too.
The implementation on posix uses [@http://pubs.opengroup.org/onlinepubs/009695399/functions/mkfifo.html fifos],
which means, that the named pipe behaves like a file.
Windows does provide a facility called [@https://msdn.microsoft.com/en-us/library/windows/desktop/aa365150(v=vs.85).aspx named pipes],
which also have file-like names, but are in a different scope than the actual file system.
[note The main reason named pipes are part of this library, is because they need to be internally used for asynchronous communication on windows.]
[endsect]
[endsect]
[section:process Processes]
A process is an independently executable entity, which is different from a thread, in that it has its own resources.
Those include memory and hardware resources.
Every process is identified by a unique number[footnote it is unique as long as the process is active], called the process identification digit, `pid`.
[section:exit_code Exit code]
A process will return an integer value indicating whether it was successful. On posix
there are more codes associated with that, but not so on windows. Therefore there is no such encoding currently in the library.
However an exit code of zero means the process was successful, while one different than zero indicates an error.
[endsect]
[section:termination Termination]
Processes can also be forced to exit. There are two ways to do this, signal the process to do so and wait, and just terminate the process without conditions.
Usually the first approach is to signal an exit request, but windows - unlike posix - does not provide a consistent way to do this. Hence this is not part of the
library and only the hard terminate is.
[endsect]
[endsect]
[section:env Environment]
The environment is a map of variables local to every process. The most significant one for this library
is the `PATH` variable, which contains a list of paths, that ought to be searched for executables. A shell will do this automatically,
while this library provides a function for that.
[endsect]
[endsect]

View File

@@ -1,94 +0,0 @@
[section:design Design Rationale]
[section Scope]
This library is meant to give a wrapper around the different OS-specific methods
to launch processes. Its aim is to provide all functionality that is available on
those systems and allow the user to do all related things, which require using the OS APIs.
[*This library does not try to provide a full library for everything process related.]
In many discussions the proposal was made to build boost.process into a DSEL [footnote Domain Specific Embedded Language] of some sort.
This is not the goal, it rather provides the facilities to build such a DSEL-library on top of it.
Therefore the library also does [*not] force any particular use (such as only asynchronous communication) on its user.
It rather could be integrated with such a library.
[endsect]
[section Interface Style]
Boost.Process does use a very particular style when constructing a process.
This is because a process holds many properties, which are not members of the actual child class.
Those properties are in many cases not accessible by the father process, for example when using environments.
Here the child process can modify its own environment, but there is no way for the father process to know.
That means, that a child process has properties that cannot be accessed in C++.
This now leads to the two styles supported and mixed by this library. Overloading and properties.
Consider that you may want to launch a process passing a number of arguments. This is supported in both styles, and would look like this:
```
system("gcc", "--version"); //overloading
system("gcc", args={"--version"}); //property style.
```
Both styles can also be mixed in some cases.
```
system("gcc", "-c", args+={"main.cpp"});
```
In the following section the available styles will be described. Note that the
overload style is implemented via type traits, so the types will be listed.
[caution There is no guarantee in which order the arguments will be applied!
There is however a guarantee for arguments belonging together, i.e. the string
argument and the args property will be evaluated in the order given.]
[endsect]
[section:arg_cmd_style Arguments/Command Style]
When passing arguments to the process, two styles are provided, the cmd-style and the exe-/args-style.
The cmd style will interpret the string as a sequence of the exe and arguments and parse them as such, while the exe-/args-style will
interpret each string as an argument.
[table:id Cmd vs Exe/Args
[[String] [Cmd] [Exe/Args]]
[["gcc --version"] [{"gcc", "--version"}] [{"\\"gcc --version\\""}]]
]
When using the overloading variant, a single string will result in a cmd interpretation,
several strings will yield a exe-args interpretation. Both versions can be set explicitly:
```
system("grep -c false /etc/passwd"); //cmd style
system("grep", "-c", "false", "/etc/passwd"); //exe-/args-
system(cmd="grep -c false /etc/passwd"); //cmd style
system(exe="grep", args={"-c", "false", "/etc/passwd"}); //exe-/args-
```
[note If a '"' sign is used in the argument style, it will be passed as part of the argument.
If the same effect is wanted with the cmd syntax, it ought to be escaped, i.e. '\\\"'. ]
[note The `PATH` variable will automatically be searched in the command style,
but the one of the launching process, not the one passed to the child process.]
[endsect]
[section:plat_ext Extensions]
The simplest form to extend functionality is to provide another handler, which
will be called on the respective events on process launching. The names are:
*`boost::process::v1::on_setup`
*`boost::process::v1::on_error`
*`boost::process::v1::on_success`
As an example:
```
child c("ls", on_setup([](){cout << "On Setup" << endl;}));
```
[note On posix all those callbacks will be handled by this process, not the created one.
This is different for the posix extensions, which can be executed on the forked process.]
[endsect]
[endsect]

View File

@@ -1,212 +0,0 @@
[def __on_exit__ [globalref boost::process::v1::on_exit on_exit]]
[def __on_success__ [globalref boost::process::v1::extend::on_success ex::on_success]]
[def __child__ [classref boost::process::v1::child child]]
[def __handler__ [classref boost::process::v1::extend::handler handler]]
[def __on_success__ [memberref boost::process::v1::extend::handler::on_success on_success]]
[def __posix_executor__ [classref boost::process::v1::extend::posix_executor ex::posix_executor]]
[def __windows_executor__ [classref boost::process::v1::extend::windows_executor ex::windows_executor]]
[def __io_context__ [@http://www.boost.org/doc/libs/release/doc/html/boost_asio/reference/io_context.html boost::asio::io_context]]
[def __require_io_context__ [classref boost::process::v1::extend::require_io_context ex::require_io_context]]
[def __async_handler__ [classref boost::process::v1::extend::async_handler ex::async_handler]]
[def __get_io_context__ [funcref boost::process::v1::extend::get_io_context ex::get_io_context]]
[section:extend Extensions]
To extend the library, the header [headerref boost/process/extend.hpp extend] is provided.
It only provides the explicit style for custom properties, but no implicit style.
What this means is, that a custom initializer can be implemented, a reference which can be passed to one of the launching functions.
If a class inherits [classref boost::process::v1::extend::handler] it will be regarded as an initializer and thus directly put into the sequence
the executor gets passed.
[section:structure Structure]
The executor calls different handlers of the initializers during the process launch.
The basic structure consists of three functions, as given below:
* [globalref boost::process::v1::extend::on_setup on_setup]
* [globalref boost::process::v1::extend::on_error on_error]
* [globalref boost::process::v1::extend::on_success on_success]
'''
<imagedata fileref="boost_process/windows_exec.svg"/>
'''
Additionally posix provides three more handlers, listed below:
* [globalref boost::process::v1::extend::on_fork_error on_fork_error]
* [globalref boost::process::v1::extend::on_exec_setup on_exec_setup]
* [globalref boost::process::v1::extend::on_exec_error on_exec_error]
For more information see the reference of [classref boost::process::v1::extend::posix_executor posix_executor].
[endsect]
[section:simple Simple extensions]
The simplest extension just takes a single handler, which can be done in a functional style.
So let's start with a simple hello-world example, while we use a C++14 generic lambda.
```
using namespace boost::process;
namespace ex = bp::extend;
__child__ c("foo", __on_success__=[](auto & exec) {std::cout << "hello world" << std::endl;});
```
Considering that lambdas can also capture values, data can easily be shared between handlers.
To see which members the executor has, refer to [classref boost::process::v1::extend::windows_executor windows_executor]
and [classref boost::process::v1::extend::posix_executor posix_executor].
[note Combined with __on_exit__ this can also handle the process exit.]
[caution The posix handler symbols are not defined on windows.]
[endsect]
[section:handler Handler Types]
Since the previous example is in a functional style, it is not very reusable.
To solve that problem, the [classref boost::process::v1::extend::handler handler] has an alias in the `boost::process::v1::extend` namespace, to be inherited.
So let's implement the hello world example in a class.
```
struct hello_world : __handler__
{
template<typename Executor>
void __on_success__(Executor & exec) const
{
std::cout << "hello world" << std::endl;
}
};
//in our function
__child__ c("foo", hello_world());
```
[note The implementation is done via overloading, not overriding.]
Every handler not implemented defaults to [classref boost::process::v1::extend::handler handler], where an empty handler is defined for each event.
[endsect]
[section:async Asynchronous Functionality]
Since `boost.process` provides an interface for [@http://www.boost.org/doc/libs/release/libs/asio/ boost.asio],
this functionality is also available for extensions. If the class needs the __io_context__ for some reason, the following code will do that.
```
struct async_foo : __handler__, __require_io_context__
{
template<typename Executor>
void on_setup(Executor & exec)
{
__io_context__ & ios = __get_io_context__(exec.seq); //gives us a reference and a compiler error if not present.
//do something with ios
}
};
```
[note Inheriting [globalref boost::process::v1::extend::require_io_context require_io_context] is necessary, so [funcref boost::process::v1::system system] provides one.]
Additionally the handler can provide a function that is invoked when the child process exits. This is done through __async_handler__.
[note [globalref boost::process::v1::extend::async_handler async_handler] implies [globalref boost::process::v1::extend::require_io_context require_io_context] .]
```
struct async_bar : __handler, __async_handler__
{
template<typename Executor>
std::function<void(int, const std::error_code&)> on_exit_handler(Executor & exec)
{
auto handler_ = this->handler;
return [handler_](int exit_code, const std::error_code & ec)
{
std::cout << "hello world, I exited with " << exit_code << std::endl;
};
}
};
```
[caution `on_exit_handler` does not default and is always required when [classref boost::process::v1::extend::async_handler async_handler] is inherited. ]
[caution `on_exit_handler` uses `boost::asio::signal_set` to listen for SIGCHLD on posix. The application must not also register a signal handler for SIGCHLD using functions such as `signal()` or `sigaction()` (but using `boost::asio::signal_set` is fine). ]
[endsect]
[section:error Error handling]
If an error occurs in the initializers it shall be told to the executor and not handled directly. This is because
the behaviour can be changed through arguments passed to the launching function. Hence the executor
has the function `set_error`, which takes an [@http://en.cppreference.com/w/cpp/error/error_code std::error_code] and a string.
Depending on the configuration of the executor, this may either throw, set an internal `error_code`, or do nothing.
So let's take a simple example, where we set a randomly chosen `error_code`.
```
auto set_error = [](auto & exec)
{
std::error_code ec{42, std::system_category()};
exec.set_error(ec, "a fake error");
};
__child__ c("foo", on_setup=set_error);
```
Since we do not specify the error-handling mode in this example, this will throw [classref boost::process::v1::process_error process_error].
[endsect]
[section:exec_over Executor Overloading]
Now that we have a custom initializer, let's consider how we can handle differences between different executors.
The distinction is between posix and windows and `char` and `wchar_t` on windows.
One solution is to use the [@http://www.boost.org/doc/libs/master/boost/system/api_config.hpp BOOST_WINDOWS_API and BOOST_POSIX_API] macros,
which are automatically available as soon as any process-header is included.
Another variant are the type aliases __posix_executor__ and __windows_executor__, where the executor, not on the current system is a forward-declaration.
This works fine, because the function will never get invoked. So let's implement another example, which prints the executable name __on_success__.
```
struct hello_exe : __handler__
{
template<typename Sequence>
void __on_success__(__posix_executor__<Sequence> & exec)
{
std::cout << "posix-exe: " << exec.exe << std::endl;
}
template<typename Sequence>
void __on_success__(__windows_executor__<char, Sequence> & exec)
{
//note: exe might be a nullptr on windows.
if (exec.exe != nullptr)
std::cout << "windows-exe: " << exec.exe << std::endl;
else
std::cout << "windows didn't use exe" << std::endl;
}
template<typename Sequence>
void __on_success__(__windows_executor__<wchar_t, Sequence> & exec)
{
//note: exe might be a nullptr on windows.
if (exec.exe != nullptr)
std::wcout << L"windows-exe: " << exec.exe << std::endl;
else
std::cout << "windows didn't use exe" << std::endl;
}
};
```
So given our example, the definitions with the non-native executor are still a template so that they will not be evaluated if not used. Hence this provides a
way to implement system-specific code without using the preprocessor.
[note If you only write a partial implementation, e.g. only for __posix_executor__, the other variants will default to __handler__].
[endsect]
[endsect]

View File

@@ -1,87 +0,0 @@
[section:faq Frequently Asked Questions]
[section:dead_lock Why does this produce a deadlock?]
Now let's revisit our c++filt example and we will put in an obvious mistake.
This might however be not as obvious for more complex applications.
```
vector<string> demangle(vector<string> in)
{
ipstream is;
opstream os;
child c("c++filt", std_out > is, std_in < os);
vector<string> data;
for (auto & elem : data)
{
string line;
getline(is, line);
os << elem;
}
}
```
We switched the read and write operation up, so that's causing a dead-lock.
This locks immediately. This is because `c++filt` expects input, before
outputting any data. The launching process on the other hand waits for its output.
[endsect]
[section:closep Why does the pipe not close?]
Now for another example, which might look correct, let's consider you want
to use `ls` to read the current directory.
```
ipstream is;
child c("ls", std_out > is);
std::string file;
while (is >> file)
cout << "File: " << file << endl;
```
This will also deadlock, because the pipe does not close when the subprocess exits.
So the `ipstream` will still look for data even though the process has ended.
[note It is not possible to use automatic pipe-closing in this library, because
a pipe might be a file-handle (as for async pipes on windows).]
But, since pipes are buffered, you might get incomplete data if you do this:
```
ipstream is;
child c("ls", std_out > is);
std::string file;
while (c.running())
{
is >> file;
cout << "File: " << file << endl;
}
```
It is therefore highly recommended that you use the asynchronous API if you are
not absolutely sure how the output will look.
[endsect]
[section:wchar_t When will the codecvt be used?]
Since windows does not use UTF-8 it is sometimes unavoidable to use the `wchar_t` version of the WinApi.
To keep this library consistent it provides `wchar_t` support on posix also.
Since the posix api is purely `char` every `wchar_t` based type will be converted into `char`.
Windows on the other hand is more selective; the default is to use `char`,
but if any parameter requires `wchar_t`, everything will be converted to `wchar_t`.
This also includes `boost::filesystem::path`. Additionally, if the system does not provide
the `char` api (as is the case with Windows CE) everything will also be converted.
[endsect]
[endsect]

View File

@@ -1,24 +0,0 @@
[section:introduction Introduction]
Boost.Process is a library to manage system processes. It can be used to:
* create child processes
* setup streams for child processes
* communicate with child processes through streams (synchronously or asynchronously)
* wait for processes to exit (synchronously or asynchronously)
* terminate processes
Here's a simple example of how to start a program with Boost.Process:
[def ipstream [classref boost::process::v1::ipstream ipstream]]
[def system [funcref boost::process::v1::system system]]
[def std_out [globalref boost::process::v1::std_out std_out]]
[def child [globalref boost::process::v1::child child]]
[def boost/process.hpp [headerref boost/process.hpp boost/process.hpp]]
[def std::string [@http://en.cppreference.com/w/cpp/string/basic_string std::string]]
[def std::getline [@http://en.cppreference.com/w/cpp/string/basic_string/getline std::getline]]
[import ../../example/intro.cpp]
[intro]
[endsect]

View File

@@ -1,60 +0,0 @@
<?xml version="1.0" standalone="yes"?>
<programlisting>
for (auto &amp; s : seq)
s.<methodname alt="boost::process::v1::extend::handler::on_setup">on_setup</methodname>(*this);
if (<methodname alt="boost::process::v1::extend::posix_executor::error">error</methodname>())
{
for (auto &amp; s : seq)
s.<methodname alt="boost::process::v1::extend::handler::on_error">on_error</methodname>(*this, <methodname alt="boost::process::v1::extend::posix_executor::error">error</methodname>());
return <classname alt="boost::process::v1::child">child</classname>();
}
pid = <ulink url="http://pubs.opengroup.org/onlinepubs/009695399/functions/fork.html">fork()</ulink>
<methodname alt="boost::process::v1::extend::handler::on_setup">on_setup</methodname>(*this);
if (pid == -1) //fork error
{
<methodname alt="boost::process::v1::extend::posix_executor::set_error">set_error</methodname>(<functionname alt="boost::process::v1::extend::get_last_error">get_last_error</functionname>());
for (auto &amp; s : seq)
s.<methodname alt="boost::process::v1::extend::handler::on_fork_error">on_fork_error</methodname>(*this, <methodname alt="boost::process::v1::extend::posix_executor::error">error</methodname>());
for (auto &amp; s : seq)
s.<methodname alt="boost::process::v1::extend::handler::on_error">on_error</methodname>(*this, <methodname alt="boost::process::v1::extend::posix_executor::error">error</methodname>());
return <classname alt="boost::process::v1::child">child</classname>()
}
else if (pid == 0) //child process
{
for (auto &amp; s : seq)
s.<methodname alt="boost::process::v1::extend::handler::on_exec_setup">on_exec_setup</methodname>(*this);
<ulink url="http://pubs.opengroup.org/onlinepubs/009695399/functions/exec.html">execve</ulink>(exe, cmd_line, env);
auto ec = <functionname alt="boost::process::v1::extend::get_last_error">get_last_error</functionname>();
for (auto &amp; s : seq)
s.<methodname alt="boost::process::v1::extend::handler::on_exec_error">on_exec_error</methodname>(*this);
<emphasis>unspecified();</emphasis>//here the error is sent to the father process internally
<ulink url="http://en.cppreference.com/w/cpp/utility/program/exit">std::exit</ulink>(<ulink url="http://en.cppreference.com/w/c/program/EXIT_status">EXIT_FAILURE</ulink>);
return <classname alt="boost::process::v1::child">child</classname>(); //for C++ compliance
}
<classname alt="boost::process::v1::child">child</classname> c(pid, exit_code);
<emphasis>unspecified();</emphasis>//here, we read the error from the child process
if (<methodname alt="boost::process::v1::extend::posix_executor::error">error</methodname>())
for (auto &amp; s : seq)
s.<methodname alt="boost::process::v1::extend::handler::on_error">on_error</methodname>(*this, <methodname alt="boost::process::v1::extend::posix_executor::error">error</methodname>());
else
for (auto &amp; s : seq)
s.<methodname alt="boost::process::v1::extend::handler::on_error">on_success</methodname>(*this);
//now we check again, because an on_success handler might've errored.
if (<methodname alt="boost::process::v1::extend::posix_executor::error">error</methodname>())
{
for (auto &amp; s : seq)
s.<methodname alt="boost::process::v1::extend::handler::on_error">on_error</methodname>(*this, <methodname alt="boost::process::v1::extend::posix_executor::error">error</methodname>());
return <classname alt="boost::process::v1::child">child</classname>();
}
else
return c;
</programlisting>

View File

@@ -1,425 +0,0 @@
[def bp::system [funcref boost::process::v1::system bp::system]]
[def bp::async_system [funcref boost::process::v1::async_system bp::async_system]]
[def bp::spawn [funcref boost::process::v1::spawn bp::spawn]]
[def bp::child [classref boost::process::v1::child bp::child]]
[def bp::cmd [classref boost::process::v1::cmd bp::cmd]]
[def bp::group [classref boost::process::v1::group bp::group]]
[def bp::ipstream [classref boost::process::v1::ipstream bp::ipstream]]
[def bp::opstream [classref boost::process::v1::opstream bp::opstream]]
[def bp::pstream [classref boost::process::v1::pstream bp::pstream]]
[def bp::pipe [classref boost::process::v1::pipe bp::pipe]]
[def bp::async_pipe [classref boost::process::v1::async_pipe bp::async_pipe]]
[def bp::search_path [funcref boost::process::v1::search_path bp::search_path]]
[def boost_org [@www.boost.org "www.boost.org"]]
[def std::system [@http://en.cppreference.com/w/cpp/utility/program/system std::system]]
[def child_running [memberref boost::process::v1::child::running running]]
[def child_wait [memberref boost::process::v1::child::wait wait]]
[def child_wait_for [memberref boost::process::v1::child::wait_for wait_for]]
[def child_exit_code [memberref boost::process::v1::child::exit_code exit_code]]
[def group_wait_for [memberref boost::process::v1::group::wait_for wait_for]]
[def bp::on_exit [globalref boost::process::v1::on_exit bp::on_exit]]
[def bp::null [globalref boost::process::v1::null bp::null]]
[def child_terminate [memberref boost::process::v1::child::terminate terminate]]
[def group_terminate [memberref boost::process::v1::group::terminate terminate]]
[def group_wait [memberref boost::process::v1::group::wait wait]]
[def bp::std_in [globalref boost::process::v1::std_in bp::std_in]]
[def bp::std_out [globalref boost::process::v1::std_out bp::std_out]]
[def bp::std_err [globalref boost::process::v1::std_err bp::std_err]]
[def io_service [@http://www.boost.org/doc/libs/release/doc/html/boost_asio/reference/io_service.html boost::asio::io_service]]
[def asio_buffer [@http://www.boost.org/doc/libs/release/doc/html/boost_asio/reference/buffer.html boost::asio::buffer]]
[def asio_async_read [@http://www.boost.org/doc/libs/release/doc/html/boost_asio/reference/async_read.html boost::asio::async_read]]
[def bp::environment [classref boost::process::v1::basic_environment bp::environment]]
[def bp::native_environment [classref boost::process::v1::basic_native_environment bp::native_environment]]
[def boost::this_process::environment [funcref boost::this_process::environment boost::this_process::environment]]
[def std::chrono::seconds [@http://en.cppreference.com/w/cpp/chrono/duration std::chrono::seconds]]
[def std::vector [@http://en.cppreference.com/w/cpp/container/vector std::vector]]
[def __wait_for__ [memberref boost::process::v1::child::wait_for wait_for]]
[def __wait_until__ [memberref boost::process::v1::child::wait_until wait_until]]
[def __detach__ [memberref boost::process::v1::child::detach detach]]
[def __reference__ [link process.reference reference]]
[def __concepts__ [link boost_process.concepts concepts]]
[def boost::asio::yield_context [@http://www.boost.org/doc/libs/release/doc/html/boost_asio/reference/yield_context.html boost::asio::yield_context]]
[def boost::asio::coroutine [@http://www.boost.org/doc/libs/release/doc/html/boost_asio/reference/coroutine.html boost::asio::coroutine]]
[def bp::env [globalref boost::process::v1::env bp::env]]
[section:tutorial Tutorial]
In this section we will go step by step through the different features of
boost.process. For a full description see the __reference__ and the __concepts__ sections.
[section Starting a process]
We want to start a process, so let's start with a simple process. We will
invoke the gcc compiler to compile a simple program.
With the standard library this looks like this.
```
int result = std::system("g++ main.cpp");
```
Which we can write exactly like this in boost.process.
```
namespace bp = boost::process; //we will assume this for all further examples
int result = bp::system("g++ main.cpp");
```
If a single string is given (or the explicit form bp::cmd), it will be interpreted as a command line.
That will cause the execution function to search the `PATH` variable to find the executable.
The alternative is the `exe-args` style, where the first string will be interpreted as a filename (including the path),
and the rest as arguments passed to said function.
[note For more details on the `cmd`/`exe-args` style look [link boost_process.design.arg_cmd_style here].]
So as a first step, we'll use the `exe-args` style.
```
int result = bp::system("/usr/bin/g++", "main.cpp");
```
With that syntax we still have "g++" hard-coded, so let's assume we get the string
from an external source as `boost::process::v1::filesystem::path`, we can do this too.
```
boost::process::v1::filesystem::path p = "/usr/bin/g++"; //or get it from somewhere else.
int result = bp::system(p, "main.cpp");
```
Now we might want to find the `g++` executable in the `PATH`-variable, as the `cmd` syntax would do.
`Boost.process` provides a function to this end: bp::search_path.
```
boost::process::v1::filesystem::path p = bp::search_path("g++"); //or get it from somewhere else.
int result = bp::system(p, "main.cpp");
```
[note [funcref boost::process::v1::search_path search_path] will search for any executable with that name.
This also includes to add a file suffix on windows, such as `.exe` or `.bat`.]
[endsect]
[section:launch_mode Launch functions]
Given that our example used the [funcref boost::process::v1::system system] function,
our program will wait until the child process is completed. This may be unwanted,
especially since compiling can take a while.
In order to avoid that, boost.process provides several ways to launch a process.
Besides the already mentioned [funcref boost::process::v1::system system] function and its
asynchronous version [funcref boost::process::v1::async_system async_system],
we can also use the [funcref boost::process::v1::spawn spawn] function or the
[classref boost::process::v1::child child] class.
The [funcref boost::process::v1::spawn spawn] function launches a process and
immediately detaches it, so no handle will be returned and the process will be ignored.
This is not what we need for compiling, but maybe we want to entertain the user,
while compiling:
```
bp::spawn(bp::search_path("chrome"), boost_org);
```
Now for the more sensible approach for compiling: a non-blocking execution.
To implement that, we directly call the constructor of [classref boost::process::v1::child child].
```
bp::child c(bp::search_path("g++"), "main.cpp");
while (c.child_running())
do_some_stuff();
c.child_wait(); //wait for the process to exit
int result = c.child_exit_code();
```
So we launch the process, by calling the child constructor. Then we check and do other
things while the process is running and afterwards get the exit code. The call
to child_wait is necessary, to obtain it and tell the operating system, that no
one is waiting for the process anymore.
[note You can also wait for a time span or until a time point with __wait_for__ and __wait_until__.]
[warning If you don't call wait on a child object, it will be terminated on destruction.
This can be avoided by calling __detach__ beforehand]
[endsect]
[section:error_handling Error]
Until now, we have assumed that everything works out, but it is not impossible,
that "g++" is not present. That will cause the launch of the process to fail.
The default behaviour of all functions is to throw a
[@http://en.cppreference.com/w/cpp/error/system_error std::system_error] on failure.
As with many other functions in this library, passing an [@http://en.cppreference.com/w/cpp/error/error_code std::error_code]
will change the behaviour, so that instead of throwing an exception, the error will be assigned to the error code.
```
std::error_code ec;
bp::system("g++ main.cpp", ec);
```
[endsect]
[section:io Synchronous I/O]
In the examples given above, we have only started a program, but did not consider the output.
The default depends on the system, but usually this will just write it to the same output as the launching process.
If this shall be guaranteed, the streams can be explicitly forwarded like this.
```
bp::system("g++ main.cpp", bp::std_out > stdout, bp::std_err > stderr, bp::std_in < stdin);
```
Now for the first example, we might want to just ignore the output, which can be done by redirecting it to the null-device.
This can be achieved this way:
```
bp::system("g++ main.cpp", bp::std_out > bp::null);
```
Alternatively we can also easily redirect the output to a file:
```
bp::system("g++ main.cpp", bp::std_out > "gcc_out.log");
```
Now, let's take a more visual example for reading data.
[@http://pubs.opengroup.org/onlinepubs/009696699/utilities/nm.html nm] is a tool on posix,
which reads the outline, i.e. a list of all entry points, of a binary.
Every entry point will be put into a single line, and we will use a pipe to read it.
At the end an empty line is appended, which we use as the indication to stop reading.
Boost.process provides the pipestream ([classref boost::process::v1::ipstream ipstream],
[classref boost::process::v1::opstream opstream], [classref boost::process::v1::pstream pstream]) to
wrap around the [classref boost::process::v1::pipe pipe] and provide an implementation of the
[@http://en.cppreference.com/w/cpp/io/basic_istream std::istream],
[@http://en.cppreference.com/w/cpp/io/basic_ostream std::ostream] and
[@http://en.cppreference.com/w/cpp/io/basic_iostream std::iostream] interface.
```
std::vector<std::string> read_outline(std::string & file)
{
bp::ipstream is; //reading pipe-stream
bp::child c(bp::search_path("nm"), file, bp::std_out > is);
std::vector<std::string> data;
std::string line;
while (c.child_running() && std::getline(is, line) && !line.empty())
data.push_back(line);
c.child_wait();
return data;
}
```
What this does is redirect the `stdout` of the process into a pipe and we read this
synchronously.
[note You can do the same thing with [globalref boost::process::v1::std_err std_err].]
Now we get the name from `nm` and we might want to demangle it, so we use input and output.
`nm` has a demangle option, but for the sake of the example, we'll use
[@https://sourceware.org/binutils/docs/binutils/c_002b_002bfilt.html c++filt] for this.
```
bp::opstream in;
bp::ipstream out;
bp::child c("c++filt", std_out > out, std_in < in);
in << "_ZN5boost7process8tutorialE" << endl;
std::string value;
out >> value;
c.child_terminate();
```
Now you might want to forward output from one process to another processes input.
```
std::vector<std::string> read_demangled_outline(const std::string & file)
{
bp::pipe p;
bp::ipstream is;
std::vector<std::string> outline;
//we just use the same pipe, so the output of nm is directly passed as input to c++filt
bp::child nm(bp::search_path("nm"), file, bp::std_out > p);
bp::child filt(bp::search_path("c++filt"), bp::std_in < p, bp::std_out > is);
std::string line;
while (filt.running() && std::getline(is, line)) //when nm finished the pipe closes and c++filt exits
outline.push_back(line);
nm.child_wait();
filt.wait();
}
```
This forwards the data from `nm` to `c++filt` without your process needing to do anything.
[endsect]
[section:async_io Asynchronous I/O]
Boost.process allows the usage of boost.asio to implement asynchronous I/O.
If you are familiar with [@http://www.boost.org/doc/libs/release/libs/asio/ boost.asio] (which we highly recommend),
you can use [classref boost::process::v1::async_pipe async_pipe] which is implemented
as an I/O-Object and can be used like [classref boost::process::v1::pipe pipe] as shown above.
Now we get back to our compiling example. For `nm` we might analyze the output line by line,
but the compiler output will just be put into one large buffer.
With [@http://www.boost.org/doc/libs/release/libs/asio/ boost.asio] this is what it looks like.
```
io_service ios;
std::vector<char> buf(4096);
bp::async_pipe ap(ios);
bp::child c(bp::search_path("g++"), "main.cpp", bp::std_out > ap);
asio_async_read(ap, asio_buffer(buf),
[](const boost::system::error_code &ec, std::size_t size){});
ios.run();
int result = c.exit_code();
```
To make it easier, boost.process provides a simpler interface for that, so that the buffer can be passed directly,
provided we also pass a reference to an io_service.
```
io_service ios;
std::vector<char> buf(4096);
bp::child c(bp::search_path("g++"), "main.cpp", bp::std_out > asio_buffer(buf), ios);
ios.run();
int result = c.exit_code();
```
[note Passing an instance of io_service to the launching function automatically cause it to wait asynchronously for the exit, so no call of
[memberref boost::process::v1::child::wait wait] is needed.]
To make it even easier, you can use [@http://en.cppreference.com/w/cpp/thread/future std::future] for asynchronous operations
(you will still need to pass a reference to a io_service) to the launching function, unless you use bp::system or bp::async_system.
Now we will revisit our first example and read the compiler output asynchronously:
```
boost::asio::io_service ios;
std::future<std::string> data;
child c("g++", "main.cpp", //set the input
bp::std_in.close(),
bp::std_out > bp::null, //so it can be written without anything
bp::std_err > data,
ios);
ios.run(); //this will actually block until the compiler is finished
auto err = data.get();
```
[endsect]
[section:group Groups]
When launching several processes, they can be grouped together.
This will also apply for a child process, that launches other processes,
if they do not modify the group membership. E.g. if you call `make` which
launches other processes and call terminate on it,
it will not terminate all the child processes of the child unless you use a group.
The two main reasons to use groups are:
# Being able to terminate child processes of the child process
# Grouping several processes into one, just so they can be terminated at once
If we have a program like `make`, which does launch its own child processes,
a call of child_terminate might not suffice. I.e. if we have a makefile launching `gcc`
and use the following code, the `gcc` process will still run afterwards:
```
bp::child c("make");
if (!c.child_wait_for(std::chrono::seconds(10))) //give it 10 seconds
c.child_terminate(); //then terminate
```
So in order to also terminate `gcc` we can use a group.
```
bp::group g;
bp::child c("make", g);
if (!g.group_wait_for(std::chrono::seconds(10)))
g.group_terminate();
c.child_wait(); //to avoid a zombie process & get the exit code
```
Now given the example, we still call child_wait to avoid a zombie process.
An easier solution for that might be to use [funcref boost::process::v1::spawn spawn].
To put two processes into one group, the following code suffices. Spawn already
launches a detached process (i.e. without a child-handle), but they can be grouped,
to that in the case of a problem, RAII is still a given.
```
void f()
{
bp::group g;
bp::spawn("foo", g);
bp::spawn("bar", g);
do_something();
g.group_wait();
};
```
In the example, it will wait for both processes at the end of the function unless
an exception occurs. I.e. if an exception is thrown, the group will be terminated.
Please see the [headerref boost/process/group.hpp reference] for more information.
[endsect]
[section:env Environment]
This library provides access to the environment of the current process and allows
setting it for the child process.
```
//get a handle to the current environment
auto env = boost::this_process::environment();
//add a variable to the current environment
env["VALUE_1"] = "foo";
//copy it into an environment separate to the one of this process
bp::environment env_ = env;
//append two values to a variable in the new env
env_["VALUE_2"] += {"bar1", "bar2"};
//launch a process with `env_`
bp::system("stuff", env_);
```
A more convenient way to modify the environment for the child is the
[globalref boost::process::v1::env env] property, which can be used in the example as following:
```
bp::system("stuff", bp::env["VALUE_1"]="foo", bp::env["VALUE_2"]+={"bar1", "bar2"});
```
Please see the [headerref boost/process/environment.hpp reference] for more information.
[endsect]
[endsect]

View File

@@ -1,42 +0,0 @@
<?xml version="1.0" standalone="yes"?>
<programlisting>
for (auto &amp; s : seq)
s.<methodname alt="boost::process::v1::extend::handler::on_setup">on_setup</methodname>(*this);
if (<methodname alt="boost::process::v1::extend::windows_executor::error">error</methodname>())
{
for (auto &amp; s : seq)
s.<methodname alt="boost::process::v1::extend::handler::on_error">on_error</methodname>(*this, <methodname alt="boost::process::v1::extend::windows_executor::error">error</methodname>());
return <classname alt="boost::process::v1::child">child</classname>();
}
int err_code = <ulink url="https://msdn.microsoft.com/en-us/library/windows/desktop/ms682425.aspx">CreateProcess</ulink>(
exe,
cmd_line,
proc_attrs,
thread_attrs,
creation_flags,
env,
work_dir,
startup_info,
proc_info);
<classname alt="boost::process::v1::child">child</classname> c(proc_info, exit_code);
if (<methodname alt="boost::process::v1::extend::windows_executor::error">error</methodname>())
for (auto &amp; s : seq)
s.<methodname alt="boost::process::v1::extend::handler::on_error">on_error</methodname>(*this, <methodname alt="boost::process::v1::extend::windows_executor::error">error</methodname>());
else
for (auto &amp; s : seq)
s.<methodname alt="boost::process::v1::extend::handler::on_error">on_success</methodname>(*this);
//now we check again, because an on_success handler might've errored.
if (<methodname alt="boost::process::v1::extend::windows_executor::error">error</methodname>())
{
for (auto &amp; s : seq)
s.<methodname alt="boost::process::v1::extend::handler::on_error">on_error</methodname>(*this, <methodname alt="boost::process::v1::extend::windows_executor::error">error</methodname>());
return <classname alt="boost::process::v1::child">child</classname>();
}
else
return c;
</programlisting>

View File

@@ -1,11 +0,0 @@
[section:v2 Process V2]
[include v2/introduction.qbk]
[include v2/quickstart.qbk]
[include v2/launcher.qbk]
[include v2/start_dir.qbk]
[include v2/stdio.qbk]
[include v2/env.qbk]
[xinclude reference_v2.xml]
[endsect]

View File

@@ -1,128 +0,0 @@
[section:launchers Launcher]
The process creation is done by a process_launcher.
The constructor of `process` will use the default_launcher, which varies by system.
There are additional launcher available on most systems.
[table:launchers Launcher overview
[[Name] [Summary] [Default on] [Available on]]
[[`windows::default_launcher`] [Launcher using `CreateProcessW`] [windows] [windows]]
[[`windows::as_user_launcher`] [Launcher using `CreateProcessAsUserW`] [] [windows]]
[[`windows::with_logon_launcher`] [Launcher using `CreateProcessWithLogonW`] [] [windows]]
[[`windows::with_token_launcher`] [Launcher using `CreateProcessWithTokenW`] [] [windows]]
[[`posix::default_launcher`] [Launcher using fork & an error pipe] [most of posix] [posix]]
[[`posix::fork_and_forget`] [Launcher using fork without error pipe] [] [posix]]
[[`posix::pdfork_launcher`] [Launcher using pdfork with an error pipe] [FreeBSD] [FreeBSD]]
[[`posix::vfork_launcher`] [Launcher using vfork] [] [posix]]
]
A launcher is invoked through the call operator.
```
auto l = windows::as_user_launcher((HANDLE)0xDEADBEEF);
asio::io_context ctx;
boost::system::error_code ec;
auto proc = l(ctx, ec, "C:\\User\\boost\\Downloads\\totally_not_a_virus.exe", {});
```
The launcher will call certain functions on the initializer if they're present, as documented below.
The initializer are used to modify the process behaviour.
[section:linux Linux Launchers]
The default and pdfork launchers on linux open an internal pipe to communicate errors that occur after forking back to the parent process.
This can be prevented by using the `fork_and_forget_launcher`.
Alternatively, the `vfork_launcher` can report errors directly back to the parent process.
Thus some calls to the initializers occur after forking from the child process.
```
struct custom_initializer
{
// functions called from the parent process:
// called before a call to fork. A returned error will cancel the launch.
template<typename Launcher>
error_code on_setup(Launcher & launcher, const filesystem::path &executable, const char * const * (&cmd_line));
// called for every initializer if an error occurred during setup or process creation
template<typename Launcher>
void on_error(Launcher & launcher, const filesystem::path &executable, const char * const * (&cmd_line),
const error_code & ec);
// called after successful process creation
template<typename Launcher>
void on_success(Launcher & launcher, const filesystem::path &executable, const char * const * (&cmd_line));
// called for every initializer if an error occurred when forking, in addition to on_error.
template<typename Launcher>
void on_fork_error(Launcher & launcher, const filesystem::path &executable, const char * const * (&cmd_line),
const error_code & ec);
// called before a call to execve. A returned error will cancel the launch. Called from the child process.
template<typename Launcher>
error_code on_exec_setup(Launcher & launcher, const filesystem::path &executable, const char * const * (&cmd_line));
// called after a failed call to execve from the child process.
template<typename Launcher>
void on_exec_error(Launcher & launcher, const filesystem::path &executable, const char * const * (&cmd_line));
};
```
The call sequence on success:
'''
<imagedata fileref="boost_process/posix_success.svg"/>
'''
The call sequence when fork fails:
'''
<imagedata fileref="boost_process/posix_fork_err.svg"/>
'''
The call sequence when exec fails:
'''
<imagedata fileref="boost_process/posix_exec_err.svg"/>
'''
The launcher will close all non-whitelisted file descriptors after `on_exec_setup`.
[endsect]
[section:windows Windows Launchers]
Windows launchers are pretty straight forward, they will call the following functions on the initializer if present.
```
struct custom_initializer
{
// called before a call to CreateProcess. A returned error will cancel the launch.
template<typename Launcher>
error_code on_setup(Launcher & launcher, const filesystem::path &executable, std::wstring &cmd_line);
// called for every initializer if an error occurred during setup or process creation
template<typename Launcher>
void on_error(Launcher & launcher, const filesystem::path &executable, std::wstring &cmd_line,
const error_code & ec);
// called after successful process creation
template<typename Launcher>
void on_success(Launcher & launcher, const filesystem::path &executable, std::wstring &cmd_line);
};
```
[note All the additional launchers for windows inherit `default_launcher`]
The call sequence is as follows:
'''
<imagedata fileref="boost_process/windows_exec.svg"/>
'''
[endsect]
[endsect]

View File

@@ -1,123 +0,0 @@
[section:quickstart Quickstart]
A process needs four things to be launched:
* an asio execution_context / executor
* a path to an executable
* a list of arguments
* a variadic set of initializers
```
// process(asio::any_io_executor, filesystem::path, range<string> args, AdditionalInitializers...)
asio::io_context ctx;
process proc(ctx, "/usr/bin/cp", {"source.txt", "target.txt"});
```
The started process can then be awaited or terminated.
[section:lifetime Lifetime]
If the process handle goes out of scope, it will terminate the subprocess.
You can prevent this, by calling `proc.detach()`; do however note that this
can lead to zombie processes.
A process that completed will deliver an exit-code,
which can be obtained by calling `.exit_code` on the exited process and which is
also returned from `.wait()`.
```
process proc("/bin/ls", {});
assert(proc.wait() == 0);
```
The normal exit-code is what the subprocess returned from `main`;
posix will however add additional information about the process.
This is called the `native_exit_code`.
The `.running()` function can be used to detect if the process is still active.
[endsect]
[section:signal Signalling the subprocess]
The parent process can signal the subprocess demanding certain actions.
`.terminate` will cause the subprocess to exit immediately (`SIGKILL` on posix).
This is the only reliable & portable way to end a subprocess.
```
process proc("/bin/totally-not-a-virus", {});
proc.terminate();
```
`.request_exit` will ask the subprocess to shutdown (`SIGTERM` on posix),
which the subprocess might ignore.
```
process proc("/bin/bash", {});
proc.request_exit();
proc.wait();
```
`.interrupt` will send an SIGINT to the subprocess, which a subprocess might
interpret as a signal to shutdown.
[warning interrupt requires the initializer `windows::create_new_process_group` to be set]
```
process proc("/usr/bin/addr2line", {});
proc.request_exit();
proc.wait();
```
[endsect]
[section:execute Execute functions]
Process v2 provides `execute` and `async_execute` functions that can be used for managed executions.
```
assert(execute(process("/bin/ls", {}) == 0));
```
The async version supports cancellation and will forward cancellation types as follows:
- asio::cancellation_type::total -> interrupt
- asio::cancellation_type::partial -> request_exit
- asio::cancellation_type::terminal -> terminate
```
asio::io_context ctx;
asio::steady_timer timeout{ctx, std::chrono::seconds(10)};
asio::cancellation_signal sig;
async_execute(process("/usr/bin/g++", {"hello_world.cpp"}),
asio::bind_cancellation_slot(sig.slot(),
[&](error_code ec, int exit_code)
{
timeout.cancel(); // we're done earlier
}));
timeout.async_wait(
[&](error_code ec)
{
if (ec) // we were cancelled, do nothing
return ;
sig.emit(asio::cancellation_type::partial);
// request exit first, but terminate after another 10 sec
timeout.expires_after(std::chrono::seconds(10));
timeout.async_wait(
[&](error_code ec)
{
if (!ec)
sig.emit(asio::cancellation_type::terminal);
});
});
```
[endsect]
[endsect]

View File

@@ -1,16 +0,0 @@
[section:start_dir process_start_dir]
The easier initializer to use is `process_start_dir`:
```
asio::io_context ctx;
process ls(ctx, "/ls", {}, process_start_dir("/home"));
ls.wait();
```
This will run `ls` in the folder `/home` instead of the current folder.
[warning If your path is relative, it may fail on posix, because the directory is changed before a call to execve.]
[endsect]

View File

@@ -1,89 +0,0 @@
[section:stdio stdio]
When using io with a subprocess, all three standard streams (stdin, stdout, stderr) get set for the child-process.
The default setting is to inherit the parent process.
This feature meant to be flexible, which is why there is little checking on the arguments assigned to one of those streams.
[section:pipe Pipe]
asio pipes can be used for io. When using in process_stdio they will get
automatically connected and the other side will get assigned to the child process:
```
asio::io_context ctx;
asio::readable_pipe rp{ctx};
process proc(ctx, "/usr/bin/g++", {"--version"}, process_stdio{{ /* in to default */}, rp, { /* err to default */ }});
std::string output;
system::error_code ec;
rp.read(asio::dynamic_buffer(output), ec);
assert(ec == asio::eof);
proc.wait();
```
readable pipes can be assigned to `out` an `err`, while writable_pipes can be assigned to `in`.
[endsect]
[section:file `FILE*`]
`FILE*` can also be used for either side; this allows the `stdin`, `stderr`, `stdout` macros to be used:
```
asio::io_context ctx;
// forward both stderr & stdout to stdout of the parent process
process proc(ctx, "/usr/bin/g++", {"--version"}, process_stdio{{ /* in to default */}, stdout, stdout});
proc.wait();
```
[endsect]
[section:null `nullptr`]
`nullptr` may be used to set a given stream to be opened on the null-device (`/dev/null` on posix, `NUL` on windows).
This is used to ignore output or give only EOF as input.
```
asio::io_context ctx;
// ignore stderr
process proc(ctx, "/usr/bin/g++", {"--version"}, process_stdio{{ /* in to default */}, {}, nullptr});
proc.wait();
```
[endsect]
[section:native_handle `native_handle`]
A native handle can be used as well, which means an `int` on posix or a `HANDLE` on windows.
Furthermore, any object that has a `native_handle` returning that native handle type is valid, too.
```
asio::io_context ctx;
// ignore stderr
asio::ip::tcp::socket sock{ctx};
connect_my_socket(sock);
process proc(ctx, "~/not-a-virus", {}, process_stdio{sock, sock, nullptr});
proc.wait();
```
[endsect]
[section:popen popen]
Additionally, process v2 provides a `popen` class.
It starts a process and connects pipes for stdin and stdout, so that the popen object can be used as a stream.
```
popen proc(executor, "/usr/bin/addr2line, {argv[0]});
asio::write(proc, asio::buffer("main\n"));
std::string line;
asio::read_until(proc, asio::dynamic_buffer(line), '\n');
```
[endsect]
[endsect]

View File

@@ -1,4 +1,4 @@
[section:introduction Introduction]
= Version 2
Boost.process V2 is an redesign of boost.process, based on previous
design mistakes & improved system APIs.
@@ -13,47 +13,50 @@ The major changes are
* separate compilation
* fd safe by default
[section:simplified Simplified Interface]
Version 2 is now the default. In order to discourage usage of the deprecated v1, it's documentation has been removed.
== Simplified Interface
In process v1 one can define partial settings in the constructor of the process,
which has lead to a small DSL.
child c{exe="test", args+="--help", std_in < null(), env["FOO"] += "BAR"};
[source,cpp]
----
child c{exe="test", args+="--help", std_in < null(), env["FOO"] += "BAR"};
----
While this looks fancy at first, it really does not scale well with more parameters.
For process v2, the interfaces is simple:
For process v2, the interfaces is simple:
extern std::unordered_map<std::string, std::string> my_env;
extern asio::io_context ctx;
process proc(ctx, "./test", {"--help"}, process_io{nullptr, {}, {}}, process_environment(my_env));
[source,cpp]
----
extern std::unordered_map<std::string, std::string> my_env;
extern asio::io_context ctx;
process proc(ctx, "./test", {"--help"}, process_stdio{nullptr, {}, {}}, process_environment(my_env));
----
Every initializer addresses one logical component (e.g. stdio) instead of multiple ones accumulating.
Furthermore, every process has a path and arguments, instead of a confusing mixture of cmd-style and
exe-args that can be randomly spread out.
[endsect]
[section:pidfd_open pidfd_open]
== `pidfd_open`
Since process v1 came out, linux has moved along and added pidfd_open which allows users to get a
file descriptor for a process. This is much more reliable since it is not as easy to miss as a `SIGCHLD`.
FreeBSD has a similar feature with `pdfork` which is also supported, while windows has provided `HANDLE`s
for processes all along.
Since process v1 came out, linux has moved along and added [pidfd_open](https://man7.org/linux/man-pages/man2/pidfd_open.2.html)
which allows users to obtain a descriptor for a process.
This is much more reliable since it is not as easy to miss as a `SIGCHLD`.
Windows has provided `HANDLE`s for processes all along.
Unless the OS doesn't support it, process v2 will use file descriptors and handles to implement waiting
for processes.
[endsect]
[section:asio Full asio integration]
== Full asio integration
Process v1 aimed to make asio optional, but synchronous IO with subprocesses usually means one is begging
for deadlocks.
Since asio added pipes in boost 1.78, boost process V2 is fully asio based and uses it's pipes and
file-handles for the subprocess.
[endsect]
[section:unreliable Unreliable functionality]
== Unreliable functionality
Certain parts of boost.process were not as reliable as they should've been.
@@ -61,27 +64,14 @@ This concerns especially the `wait_for` and `wait_until` functions on the proces
The latter are easy to do on windows, but posix does not provide an API for this.
Thus the wait_for used signals or fork, which was all but safe.
Since process v2 is based on asio and thus supports cancellation,
a wait_for can not safely be implemented with an async_wait + timeout.
a wait_for can now safely be implemented with an async_wait + timeout.
[endsect]
== UTF-8
[section:utf8 UTF-8]
Instead of using ascii-APIs on windows, process V2 just assumes UTF-8 everywhere
and uses the UTF-16 APIs.
["UTF-8 or GTFO]--Vinnie Falco
Instead of using ascii-APIs on windows, process V2 just assumes UTF-8 everywhere.
[endsect]
[section:src Separate compilation]
Boost.process v2 supports separate compilation similar to other boost libraries.
It can be achieved by defining `BOOST_PROCESS_V2_SEPARATE_COMPILATION` and including
`<process/v2/src.hpp>` in a single compile unit.
[endsect]
[section:limit_fd Fd safe by default]
== Fd safe by default
While not a problem on windows (since HANDLEs get manually enabled for inheritance),
posix systems create a problem with inheriting file handles by default.
@@ -89,6 +79,3 @@ posix systems create a problem with inheriting file handles by default.
Process V2 will automatically close all non-whitelisted descriptors,
without needing any option to enable it.
[endsect]
[endsect]

View File

@@ -1,28 +1,19 @@
# Copyright (c) 2006, 2007 Julio M. Merino Vidal
# Copyright (c) 2008 Ilya Sokolov, Boris Schaeling
# Copyright (c) 2009 Boris Schaeling
# Copyright (c) 2010 Felipe Tanus, Boris Schaeling
# Copyright (c) 2011, 2012 Jeff Flinn, Boris Schaeling
# Copyright (c) 2022 Klemens Morgenstern
#
# Distributed under the Boost Software License, Version 1.0. (See accompanying
# file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
project : requirements
<include>../../..
<toolset>msvc:<define>_SCL_SECURE_NO_WARNINGS
<target-os>windows:<define>WIN32_LEAN_AND_MEAN
<link>static
;
import testing ;
compile args.cpp ;
compile async_io.cpp ;
compile env.cpp ;
compile error_handling.cpp ;
compile io.cpp ;
compile posix.cpp : <build>no <target-os>linux:<build>yes ;
compile start_dir.cpp ;
compile sync_io.cpp ;
compile terminate.cpp ;
compile wait.cpp ;
compile windows.cpp : <build>no <target-os>windows:<build>yes ;
exe intro : intro.cpp /boost//process : <boost.process.fs>boost ;
exe intro_popen : intro_popen.cpp /boost//process : <boost.process.fs>boost ;
exe quickstart : quickstart.cpp /boost//process : <boost.process.fs>boost ;
exe env : env.cpp /boost//process : <boost.process.fs>boost ;
exe start_dir : start_dir.cpp /boost//process : <boost.process.fs>boost ;
exe stdio : stdio.cpp /boost//process : <boost.process.fs>boost ;

View File

@@ -1,29 +0,0 @@
// Copyright (c) 2006, 2007 Julio M. Merino Vidal
// Copyright (c) 2008 Ilya Sokolov, Boris Schaeling
// Copyright (c) 2009 Boris Schaeling
// Copyright (c) 2010 Felipe Tanus, Boris Schaeling
// Copyright (c) 2011, 2012 Jeff Flinn, Boris Schaeling
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/process.hpp>
#include <vector>
#include <string>
namespace bp = boost::process;
int main()
{
bp::child c("test.exe", "--foo", "/bar");
//or explicit
bp::child c2(
bp::exe="test.exe",
bp::args={"--foo", "/bar"}
);
c.wait();
c2.wait();
}

View File

@@ -1,30 +0,0 @@
// Copyright (c) 2006, 2007 Julio M. Merino Vidal
// Copyright (c) 2008 Ilya Sokolov, Boris Schaeling
// Copyright (c) 2009 Boris Schaeling
// Copyright (c) 2010 Felipe Tanus, Boris Schaeling
// Copyright (c) 2011, 2012 Jeff Flinn, Boris Schaeling
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/process.hpp>
#include <boost/asio.hpp>
#include <boost/array.hpp>
#include <string>
namespace bp = boost::process;
int main()
{
boost::asio::io_context ios;
boost::asio::streambuf buffer;
bp::child c(
"test.exe",
bp::std_out > buffer,
ios
);
ios.run();
}

View File

@@ -8,17 +8,64 @@
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/process.hpp>
#include <unordered_map>
namespace bp = boost::process;
using namespace boost::process;
namespace asio = boost::asio;
int main()
{
bp::environment my_env = boost::this_process::environment();
{ // tag::current_env[]
// search in the current environment
auto exe = environment::find_executable("g++");
my_env["PATH"] += "/foo";
bp::system("test.exe", my_env);
std::unordered_map <environment::key, environment::value> my_env =
{
{"SECRET", "THIS_IS_A_TEST"},
{"PATH", {"/bin", "/usr/bin"}}
};
auto other_exe = environment::find_executable("g++", my_env);
//end::current_env[]
}
{
// tag::subprocess_env[]
asio::io_context ctx;
std::unordered_map<environment::key, environment::value> my_env =
{
{"SECRET", "THIS_IS_A_TEST"},
{"PATH", {"/bin", "/usr/bin"}}
};
auto exe = environment::find_executable("g++", my_env);
process proc(ctx, exe, {"main.cpp"}, process_environment(my_env));
process pro2(ctx, exe, {"test.cpp"}, process_environment(my_env));
// end::subprocess_env[]
}
bp::system("test.exe", bp::env["PATH"]+="/bar");
{
// tag::vector_env[]
asio::io_context ctx;
auto c = environment::current();
// we need to use a value, since windows needs wchar_t.
std::vector<environment::key_value_pair> my_env{c.begin(), c.end()};
my_env.push_back("SECRET=THIS_IS_A_TEST");
auto exe = environment::find_executable("g++", my_env);
process proc(ctx, exe, {"main.cpp"}, process_environment(my_env));
// end::vector_env[]
}
{
// tag::map_env[]
asio::io_context ctx;
std::unordered_map<environment::key, environment::value> my_env;
for (const auto & kv : environment::current())
if (kv.key().string() != "SECRET")
my_env[kv.key()] = kv.value();
auto exe = environment::find_executable("g++", my_env);
process proc(ctx, exe, {"main.cpp"}, process_environment(my_env));
// end::map_env[]
}
}

View File

@@ -1,24 +0,0 @@
// Copyright (c) 2006, 2007 Julio M. Merino Vidal
// Copyright (c) 2008 Ilya Sokolov, Boris Schaeling
// Copyright (c) 2009 Boris Schaeling
// Copyright (c) 2010 Felipe Tanus, Boris Schaeling
// Copyright (c) 2011, 2012 Jeff Flinn, Boris Schaeling
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/process.hpp>
#include <system_error>
namespace bp = boost::process;
int main()
{
std::error_code ec;
bp::child c1("test.exe", ec);
bp::child c2("test.exe", bp::ignore_error);
}

View File

@@ -1,8 +1,4 @@
// Copyright (c) 2006, 2007 Julio M. Merino Vidal
// Copyright (c) 2008 Ilya Sokolov, Boris Schaeling
// Copyright (c) 2009 Boris Schaeling
// Copyright (c) 2010 Felipe Tanus, Boris Schaeling
// Copyright (c) 2011, 2012 Jeff Flinn, Boris Schaeling
// Copyright (c) 2022 Klemens Morgenstern
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
@@ -10,21 +6,35 @@
//[intro
#include <boost/process.hpp>
#include <boost/asio/read.hpp>
#include <boost/asio/readable_pipe.hpp>
#include <boost/system/error_code.hpp>
#include <string>
#include <iostream>
using namespace boost::process;
namespace proc = boost::process;
namespace asio = boost::asio;
int main()
{
ipstream pipe_stream;
child c("gcc --version", std_out > pipe_stream);
asio::io_context ctx;
asio::readable_pipe p{ctx};
const auto exe = proc::environment::find_executable("gcc");
proc::process c{ctx, exe, {"--version"}, proc::process_stdio{nullptr, p}};
std::string line;
boost::system::error_code ec;
while (pipe_stream && std::getline(pipe_stream, line) && !line.empty())
std::cerr << line << std::endl;
auto sz = asio::read(p, asio::dynamic_buffer(line), ec);
assert(ec == asio::error::eof);
std::cout << "Gcc version: '" << line << "'" << std::endl;
c.wait();
return c.exit_code();
}
//]

View File

@@ -3,8 +3,10 @@
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/core/ignore_unused.hpp>
//[intro
#include <boost/process/v2.hpp>
#include <boost/process.hpp>
#include <boost/asio/read.hpp>
#include <boost/asio/readable_pipe.hpp>
@@ -13,7 +15,7 @@
#include <string>
#include <iostream>
namespace proc = boost::process::v2;
namespace proc = boost::process;
namespace asio = boost::asio;
@@ -29,8 +31,11 @@ int main()
auto sz = asio::read(c, asio::dynamic_buffer(line), ec);
assert(ec == asio::error::eof);
boost::ignore_unused(sz);
std::cout << "Gcc version: '" << line << "'" << std::endl;
c.wait();
return c.exit_code();
}
//]

View File

@@ -1,91 +0,0 @@
// Copyright (c) 2006, 2007 Julio M. Merino Vidal
// Copyright (c) 2008 Ilya Sokolov, Boris Schaeling
// Copyright (c) 2009 Boris Schaeling
// Copyright (c) 2010 Felipe Tanus, Boris Schaeling
// Copyright (c) 2011, 2012 Jeff Flinn, Boris Schaeling
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/process.hpp>
#include <string>
namespace bp = boost::process;
int main()
{
//
bp::system(
"test.exe",
bp::std_out > stdout, //forward
bp::std_err.close(), //close
bp::std_in < bp::null //null in
);
boost::process::v1::filesystem::path p = "input.txt";
bp::system(
"test.exe",
(bp::std_out & bp::std_err) > "output.txt", //redirect both to one file
bp::std_in < p //read input from file
);
{
bp::opstream p1;
bp::ipstream p2;
bp::system(
"test.exe",
bp::std_out > p2,
bp::std_in < p1
);
p1 << "my_text";
int i = 0;
p2 >> i;
}
{
boost::asio::io_context io_context;
bp::async_pipe p1(io_context);
bp::async_pipe p2(io_context);
bp::system(
"test.exe",
bp::std_out > p2,
bp::std_in < p1,
io_context,
bp::on_exit([&](int exit, const std::error_code& ec_in)
{
p1.async_close();
p2.async_close();
})
);
std::vector<char> in_buf;
std::string value = "my_string";
boost::asio::async_write(p1, boost::asio::buffer(value), []( const boost::system::error_code&, std::size_t){});
boost::asio::async_read (p2, boost::asio::buffer(in_buf), []( const boost::system::error_code&, std::size_t){});
}
{
boost::asio::io_context io_context;
std::vector<char> in_buf;
std::string value = "my_string";
bp::system(
"test.exe",
bp::std_out > bp::buffer(in_buf),
bp::std_in < bp::buffer(value)
);
}
{
boost::asio::io_context io_context;
std::future<std::vector<char>> in_buf;
std::future<void> write_fut;
std::string value = "my_string";
bp::system(
"test.exe",
bp::std_out > in_buf,
bp::std_in < bp::buffer(value) > write_fut
);
write_fut.get();
in_buf.get();
}
}

View File

@@ -1,47 +0,0 @@
// Copyright (c) 2006, 2007 Julio M. Merino Vidal
// Copyright (c) 2008 Ilya Sokolov, Boris Schaeling
// Copyright (c) 2009 Boris Schaeling
// Copyright (c) 2010 Felipe Tanus, Boris Schaeling
// Copyright (c) 2011, 2012 Jeff Flinn, Boris Schaeling
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/process.hpp>
#include <boost/process/v1/posix.hpp>
#include <boost/process/v1/extend.hpp>
#include <iostream>
#include <fstream>
#include <unistd.h>
#include <errno.h>
namespace bp = boost::process;
int main()
{
//duplicate our pipe descriptor into literal position 4
bp::pipe p;
bp::system("test", bp::posix::fd.bind(4, p.native_sink()));
//close file-descriptor from explicit integral value
bp::system("test", bp::posix::fd.close(STDIN_FILENO));
//close file-descriptors from explicit integral values
bp::system("test", bp::posix::fd.close({STDIN_FILENO, STDOUT_FILENO}));
//add custom handlers
const char *env[2] = { 0 };
env[0] = "LANG=de";
bp::system("test",
bp::extend::on_setup([env](auto &e) { e.env = const_cast<char**>(env); }),
bp::extend::on_fork_error([](auto&, const std::error_code & ec)
{ std::cerr << errno << std::endl; }),
bp::extend::on_exec_setup([](auto&)
{ ::chroot("/new/root/directory/"); }),
bp::extend::on_exec_error([](auto&, const std::error_code & ec)
{ std::ofstream ofs("log.txt"); if (ofs) ofs << errno; })
);
}

63
example/quickstart.cpp Normal file
View File

@@ -0,0 +1,63 @@
#include <boost/process.hpp>
#include <boost/asio.hpp>
namespace asio = boost::asio;
using boost::process::process;
int main(int /*argv*/, char ** /*argv*/)
{
asio::io_context ctx;
{
//tag::cp[]
// process(asio::any_io_executor, filesystem::path, range<string> args, AdditionalInitializers...)
process proc(ctx.get_executor(), // <1>
"/usr/bin/cp", // <2>
{"source.txt", "target.txt"} // <3>
); // <4>
//end::cp[]
}
{
//tag::ls[]
process proc(ctx, "/bin/ls", {});
assert(proc.wait() == 0);
//end::ls[]
}
{
//tag::terminate[]
process proc(ctx, "/bin/totally-not-a-virus", {});
proc.terminate();
//end::terminate[]
}
{
//tag::request_exit[]
process proc(ctx, "/bin/bash", {});
proc.request_exit();
proc.wait();
//end::request_exit[]
}
{
//tag::interrupt[]
process proc(ctx, "/usr/bin/addr2line", {});
proc.interrupt();
proc.wait();
//end::interrupt[]
}
{
//tag::execute[]
assert(execute(process(ctx, "/bin/ls", {})) == 0);
//end::execute[]
}
{
//tag::async_execute[]
async_execute(process(ctx, "/usr/bin/g++", {"hello_world.cpp"}))
(asio::cancel_after(std::chrono::seconds(10), asio::cancellation_type::partial)) // <1>
(asio::cancel_after(std::chrono::seconds(10), asio::cancellation_type::terminal)) //<2>
(asio::detached);
//end::async_execute[]
ctx.run();
}
return 0;
}

View File

@@ -8,20 +8,15 @@
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/process.hpp>
#include <boost/process/v1/filesystem.hpp>
namespace bp = boost::process;
using namespace boost::process;
namespace asio = boost::asio;
int main()
{
bp::system(
"test.exe",
bp::start_dir="../foo"
);
boost::process::v1::filesystem::path exe = "test.exe";
bp::system(
boost::process::v1::filesystem::absolute(exe),
bp::start_dir="../foo"
);
// tag::start_dir[]
asio::io_context ctx;
process ls(ctx.get_executor(), "/ls", {}, process_start_dir("/home"));
ls.wait();
// end::start_dir[]
}

70
example/stdio.cpp Normal file
View File

@@ -0,0 +1,70 @@
// Copyright (c) 2006, 2007 Julio M. Merino Vidal
// Copyright (c) 2008 Ilya Sokolov, Boris Schaeling
// Copyright (c) 2009 Boris Schaeling
// Copyright (c) 2010 Felipe Tanus, Boris Schaeling
// Copyright (c) 2011, 2012 Jeff Flinn, Boris Schaeling
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/process.hpp>
#include <boost/asio.hpp>
using namespace boost::process;
namespace asio = boost::asio;
int main(int argc, char *argv[])
{
{
//tag::readable_pipe[]
asio::io_context ctx;
asio::readable_pipe rp{ctx};
process proc(ctx, "/usr/bin/g++", {"--version"}, process_stdio{{ /* in to default */}, rp, { /* err to default */ }});
std::string output;
boost::system::error_code ec;
asio::read(rp, asio::dynamic_buffer(output), ec);
assert(!ec || (ec == asio::error::eof));
proc.wait();
//end::readable_pipe[]
}
{
//tag::file[]
asio::io_context ctx;
// forward both stderr & stdout to stdout of the parent process
process proc(ctx, "/usr/bin/g++", {"--version"}, process_stdio{{ /* in to default */}, stdout, stdout});
proc.wait();
//end::file[]
}
{
//tag::null[]
asio::io_context ctx;
// forward stderr to /dev/null or NUL
process proc(ctx, "/usr/bin/g++", {"--version"}, process_stdio{{ /* in to default */}, {}, nullptr});
proc.wait();
//end::null[]
}
#if defined(BOOST_POSIX_API)
{
//tag::native_handle[]
asio::io_context ctx;
// ignore stderr
asio::local::stream_protocol::socket sock{ctx}, other{ctx};
asio::local::connect_pair(sock, other);
process proc(ctx, "~/not-a-virus", {}, process_stdio{sock, sock, nullptr});
proc.wait();
//end::native_handle[]
}
#endif
{
//tag::popen[]
asio::io_context ctx;
boost::process::popen proc(ctx, "/usr/bin/addr2line", {argv[0]});
asio::write(proc, asio::buffer("main\n"));
std::string line;
asio::read_until(proc, asio::dynamic_buffer(line), '\n');
//end::popen[]
}
}

View File

@@ -1,28 +0,0 @@
// Copyright (c) 2006, 2007 Julio M. Merino Vidal
// Copyright (c) 2008 Ilya Sokolov, Boris Schaeling
// Copyright (c) 2009 Boris Schaeling
// Copyright (c) 2010 Felipe Tanus, Boris Schaeling
// Copyright (c) 2011, 2012 Jeff Flinn, Boris Schaeling
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/process.hpp>
#include <string>
namespace bp = boost::process;
int main()
{
bp::ipstream p;
bp::child c(
"test.exe",
bp::std_out > p
);
std::string s;
std::getline(p, s);
c.wait();
}

View File

@@ -1,18 +0,0 @@
// Copyright (c) 2006, 2007 Julio M. Merino Vidal
// Copyright (c) 2008 Ilya Sokolov, Boris Schaeling
// Copyright (c) 2009 Boris Schaeling
// Copyright (c) 2010 Felipe Tanus, Boris Schaeling
// Copyright (c) 2011, 2012 Jeff Flinn, Boris Schaeling
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/process.hpp>
namespace bp = boost::process;
int main()
{
bp::child c("test.exe");
c.terminate();
}

View File

@@ -1,17 +0,0 @@
# Copyright (c) 2022 Klemens Morgenstern
#
# Distributed under the Boost Software License, Version 1.0. (See accompanying
# file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
project : requirements
<include>../../..
<toolset>msvc:<define>_SCL_SECURE_NO_WARNINGS
<target-os>windows:<define>WIN32_LEAN_AND_MEAN
;
import testing ;
alias filesystem : /boost//filesystem : <link>static ;
exe intro : intro.cpp filesystem ;
exe intro_popen : intro_popen.cpp filesystem ;

View File

@@ -1,39 +0,0 @@
// Copyright (c) 2022 Klemens Morgenstern
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
//[intro
#include <boost/process/v2.hpp>
#include <boost/asio/read.hpp>
#include <boost/asio/readable_pipe.hpp>
#include <boost/system/error_code.hpp>
#include <string>
#include <iostream>
namespace proc = boost::process::v2;
namespace asio = boost::asio;
int main()
{
asio::io_context ctx;
asio::readable_pipe p{ctx};
const auto exe = proc::environment::find_executable("gcc");
proc::process c{ctx, exe, {"--version"}, proc::process_stdio{nullptr, p}};
std::string line;
boost::system::error_code ec;
auto sz = asio::read(p, asio::dynamic_buffer(line), ec);
assert(ec == asio::error::eof);
std::cout << "Gcc version: '" << line << "'" << std::endl;
c.wait();
}
//]

View File

@@ -1,34 +0,0 @@
// Copyright (c) 2006, 2007 Julio M. Merino Vidal
// Copyright (c) 2008 Ilya Sokolov, Boris Schaeling
// Copyright (c) 2009 Boris Schaeling
// Copyright (c) 2010 Felipe Tanus, Boris Schaeling
// Copyright (c) 2011, 2012 Jeff Flinn, Boris Schaeling
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/process.hpp>
#include <boost/asio.hpp>
namespace bp = boost::process;
int main()
{
{
bp::child c("test.exe");
c.wait();
auto exit_code = c.exit_code();
}
{
boost::asio::io_context io_context;
bp::child c(
"test.exe",
io_context,
bp::on_exit([&](int exit, const std::error_code& ec_in){})
);
io_context.run();
}
}

View File

@@ -1,31 +0,0 @@
// Copyright (c) 2006, 2007 Julio M. Merino Vidal
// Copyright (c) 2008 Ilya Sokolov, Boris Schaeling
// Copyright (c) 2009 Boris Schaeling
// Copyright (c) 2010 Felipe Tanus, Boris Schaeling
// Copyright (c) 2011, 2012 Jeff Flinn, Boris Schaeling
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/process.hpp>
#include <boost/process/v1/extend.hpp>
#include <boost/process/v1/windows.hpp>
#include <iostream>
#include <windows.h>
namespace bp = boost::process;
int main()
{
bp::system("test.exe",
bp::windows::show);
bp::system("test.exe",
bp::extend::on_setup([](auto &e)
{ e.startup_info.dwFlags = STARTF_RUNFULLSCREEN; }),
bp::extend::on_error([](auto&, const std::error_code & ec)
{ std::cerr << ec.message() << std::endl; })
);
}

View File

@@ -12,23 +12,18 @@
#ifndef BOOST_PROCESS_HPP
#define BOOST_PROCESS_HPP
/**
* \file boost/process.hpp
*
* Convenience header which includes all public and platform-independent
* boost.process header files.
*/
#if !defined(BOOST_PROCESS_VERSION)
#define BOOST_PROCESS_VERSION 1
#endif
#if BOOST_PROCESS_VERSION == 1
#include <boost/process/v1.hpp>
#elif BOOST_PROCESS_VERSION == 2
#include <boost/process/v2.hpp>
#else
#error "Unknown boost process version"
#endif
#include <boost/process/bind_launcher.hpp>
#include <boost/process/default_launcher.hpp>
#include <boost/process/environment.hpp>
#include <boost/process/error.hpp>
#include <boost/process/execute.hpp>
#include <boost/process/exit_code.hpp>
#include <boost/process/ext.hpp>
#include <boost/process/pid.hpp>
#include <boost/process/popen.hpp>
#include <boost/process/process.hpp>
#include <boost/process/shell.hpp>
#include <boost/process/start_dir.hpp>
#include <boost/process/stdio.hpp>
#endif

View File

@@ -1,9 +0,0 @@
// Copyright (c) 2024 Klemens D. Morgenstern
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/config/header_deprecated.hpp>
BOOST_HEADER_DEPRECATED("<boost/process/v1/args.hpp>")
#include <boost/process/v1/args.hpp>

View File

@@ -1,9 +0,0 @@
// Copyright (c) 2024 Klemens D. Morgenstern
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/config/header_deprecated.hpp>
BOOST_HEADER_DEPRECATED("<boost/process/v1/async.hpp>")
#include <boost/process/v1/async.hpp>

View File

@@ -1,9 +0,0 @@
// Copyright (c) 2024 Klemens D. Morgenstern
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/config/header_deprecated.hpp>
BOOST_HEADER_DEPRECATED("<boost/process/v1/async_pipe.hpp>")
#include <boost/process/v1/async_pipe.hpp>

View File

@@ -1,9 +0,0 @@
// Copyright (c) 2024 Klemens D. Morgenstern
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/config/header_deprecated.hpp>
BOOST_HEADER_DEPRECATED("<boost/process/v1/async_system.hpp>")
#include <boost/process/v1/async_system.hpp>

View File

@@ -0,0 +1 @@
#include <boost/process/v2/bind_launcher.hpp>

View File

@@ -1,9 +0,0 @@
// Copyright (c) 2024 Klemens D. Morgenstern
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/config/header_deprecated.hpp>
BOOST_HEADER_DEPRECATED("<boost/process/v1/child.hpp>")
#include <boost/process/v1/child.hpp>

View File

@@ -1,9 +0,0 @@
// Copyright (c) 2024 Klemens D. Morgenstern
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/config/header_deprecated.hpp>
BOOST_HEADER_DEPRECATED("<boost/process/v1/cmd.hpp>")
#include <boost/process/v1/cmd.hpp>

View File

@@ -0,0 +1 @@
#include <boost/process/v2/cstring_ref.hpp>

View File

@@ -0,0 +1 @@
#include <boost/process/v2/default_launcher.hpp>

View File

@@ -1,9 +0,0 @@
// Copyright (c) 2024 Klemens D. Morgenstern
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/config/header_deprecated.hpp>
BOOST_HEADER_DEPRECATED("<boost/process/v1/env.hpp>")
#include <boost/process/v1/env.hpp>

View File

@@ -1,9 +1 @@
// Copyright (c) 2024 Klemens D. Morgenstern
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/config/header_deprecated.hpp>
BOOST_HEADER_DEPRECATED("<boost/process/v1/environment.hpp>")
#include <boost/process/v1/environment.hpp>
#include <boost/process/v2/environment.hpp>

View File

@@ -1,9 +1 @@
// Copyright (c) 2024 Klemens D. Morgenstern
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/config/header_deprecated.hpp>
BOOST_HEADER_DEPRECATED("<boost/process/v1/error.hpp>")
#include <boost/process/v1/error.hpp>
#include <boost/process/v2/error.hpp>

View File

@@ -1,9 +0,0 @@
// Copyright (c) 2024 Klemens D. Morgenstern
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/config/header_deprecated.hpp>
BOOST_HEADER_DEPRECATED("<boost/process/v1/exception.hpp>")
#include <boost/process/v1/exception.hpp>

View File

@@ -1,9 +0,0 @@
// Copyright (c) 2024 Klemens D. Morgenstern
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/config/header_deprecated.hpp>
BOOST_HEADER_DEPRECATED("<boost/process/v1/exe.hpp>")
#include <boost/process/v1/exe.hpp>

View File

@@ -0,0 +1 @@
#include <boost/process/v2/execute.hpp>

View File

@@ -0,0 +1 @@
#include <boost/process/v2/exit_code.hpp>

View File

@@ -0,0 +1 @@
#include <boost/process/v2/ext.hpp>

View File

@@ -0,0 +1 @@
#include <boost/process/v2/ext/cmd.hpp>

View File

@@ -0,0 +1 @@
#include <boost/process/v2/ext/cwd.hpp>

View File

@@ -0,0 +1 @@
#include <boost/process/v2/ext/env.hpp>

View File

@@ -0,0 +1 @@
#include <boost/process/v2/ext/exe.hpp>

View File

@@ -1,9 +0,0 @@
// Copyright (c) 2024 Klemens D. Morgenstern
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/config/header_deprecated.hpp>
BOOST_HEADER_DEPRECATED("<boost/process/v1/extend.hpp>")
#include <boost/process/v1/extend.hpp>

View File

@@ -1,9 +0,0 @@
// Copyright (c) 2024 Klemens D. Morgenstern
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/config/header_deprecated.hpp>
BOOST_HEADER_DEPRECATED("<boost/process/v1/filesystem.hpp>")
#include <boost/process/v1/filesystem.hpp>

View File

@@ -1,9 +0,0 @@
// Copyright (c) 2024 Klemens D. Morgenstern
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/config/header_deprecated.hpp>
BOOST_HEADER_DEPRECATED("<boost/process/v1/group.hpp>")
#include <boost/process/v1/group.hpp>

View File

@@ -1,9 +0,0 @@
// Copyright (c) 2024 Klemens D. Morgenstern
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/config/header_deprecated.hpp>
BOOST_HEADER_DEPRECATED("<boost/process/v1/handles.hpp>")
#include <boost/process/v1/handles.hpp>

View File

@@ -1,9 +0,0 @@
// Copyright (c) 2024 Klemens D. Morgenstern
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/config/header_deprecated.hpp>
BOOST_HEADER_DEPRECATED("<boost/process/v1/io.hpp>")
#include <boost/process/v1/io.hpp>

View File

@@ -1,9 +0,0 @@
// Copyright (c) 2024 Klemens D. Morgenstern
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/config/header_deprecated.hpp>
BOOST_HEADER_DEPRECATED("<boost/process/v1/locale.hpp>")
#include <boost/process/v1/locale.hpp>

View File

@@ -0,0 +1 @@
#include <boost/process/v2/pid.hpp>

View File

@@ -1,9 +0,0 @@
// Copyright (c) 2024 Klemens D. Morgenstern
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/config/header_deprecated.hpp>
BOOST_HEADER_DEPRECATED("<boost/process/v1/pipe.hpp>")
#include <boost/process/v1/pipe.hpp>

View File

@@ -0,0 +1 @@
#include <boost/process/v2/popen.hpp>

View File

@@ -1,9 +0,0 @@
// Copyright (c) 2024 Klemens D. Morgenstern
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/config/header_deprecated.hpp>
BOOST_HEADER_DEPRECATED("<boost/process/v1/posix.hpp>")
#include <boost/process/v1/posix.hpp>

View File

@@ -0,0 +1 @@
#include <boost/process/v2/posix/bind_fd.hpp>

Some files were not shown because too many files have changed in this diff Show More