• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2017 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef ART_RUNTIME_EXEC_UTILS_H_
18 #define ART_RUNTIME_EXEC_UTILS_H_
19 
20 #include <time.h>
21 
22 #include <string>
23 #include <vector>
24 
25 namespace art {
26 
27 // Wrapper on fork/execv to run a command in a subprocess.
28 // These spawn child processes using the environment as it was set when the single instance
29 // of the runtime (Runtime::Current()) was started.  If no instance of the runtime was started, it
30 // will use the current environment settings.
31 
32 bool Exec(std::vector<std::string>& arg_vector, /*out*/ std::string* error_msg);
33 int ExecAndReturnCode(std::vector<std::string>& arg_vector, /*out*/ std::string* error_msg);
34 
35 // Execute the command specified in `argv_vector` in a subprocess with a timeout.
36 // Returns the process exit code on success, -1 otherwise.
37 int ExecAndReturnCode(std::vector<std::string>& arg_vector,
38                       time_t timeout_secs,
39                       /*out*/ bool* timed_out,
40                       /*out*/ std::string* error_msg);
41 
42 // A wrapper class to make the functions above mockable.
43 class ExecUtils {
44  public:
45   virtual ~ExecUtils() = default;
46 
Exec(std::vector<std::string> & arg_vector,std::string * error_msg)47   virtual bool Exec(std::vector<std::string>& arg_vector, /*out*/ std::string* error_msg) const {
48     return art::Exec(arg_vector, error_msg);
49   }
50 
ExecAndReturnCode(std::vector<std::string> & arg_vector,std::string * error_msg)51   virtual int ExecAndReturnCode(std::vector<std::string>& arg_vector,
52                                 /*out*/ std::string* error_msg) const {
53     return art::ExecAndReturnCode(arg_vector, error_msg);
54   }
55 
ExecAndReturnCode(std::vector<std::string> & arg_vector,time_t timeout_secs,bool * timed_out,std::string * error_msg)56   virtual int ExecAndReturnCode(std::vector<std::string>& arg_vector,
57                                 time_t timeout_secs,
58                                 /*out*/ bool* timed_out,
59                                 /*out*/ std::string* error_msg) const {
60     return art::ExecAndReturnCode(arg_vector, timeout_secs, timed_out, error_msg);
61   }
62 };
63 
64 }  // namespace art
65 
66 #endif  // ART_RUNTIME_EXEC_UTILS_H_
67