xref: /freebsd/contrib/kyua/os/freebsd/utils/jail.hpp (revision 257e70f1d5ee61037c8c59b116538d3b6b1427a2)
1 // Copyright 2024 The Kyua Authors.
2 // All rights reserved.
3 //
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
6 // met:
7 //
8 // * Redistributions of source code must retain the above copyright
9 //   notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 //   notice, this list of conditions and the following disclaimer in the
12 //   documentation and/or other materials provided with the distribution.
13 // * Neither the name of Google Inc. nor the names of its contributors
14 //   may be used to endorse or promote products derived from this software
15 //   without specific prior written permission.
16 //
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 
29 /// \file os/freebsd/utils/jail.hpp
30 /// FreeBSD jail utilities.
31 
32 #if !defined(FREEBSD_UTILS_JAIL_HPP)
33 #define FREEBSD_UTILS_JAIL_HPP
34 
35 #include "utils/defs.hpp"
36 #include "utils/fs/path_fwd.hpp"
37 #include "utils/process/operations_fwd.hpp"
38 
39 namespace fs = utils::fs;
40 
41 using utils::process::args_vector;
42 
43 namespace freebsd {
44 namespace utils {
45 
46 
47 class jail {
48 public:
49     std::vector< std::string > parse_params_string(const std::string& str);
50     std::string make_name(const fs::path& program,
51                           const std::string& test_case_name);
52     void create(const std::string& jail_name,
53                 const std::string& jail_params);
54     void exec(const std::string& jail_name,
55               const fs::path& program,
56               const args_vector& args) throw() UTILS_NORETURN;
57     void remove(const std::string& jail_name);
58 };
59 
60 
61 }  // namespace utils
62 }  // namespace freebsd
63 
64 #endif  // !defined(FREEBSD_UTILS_JAIL_HPP)
65