summaryrefslogtreecommitdiff
path: root/runtime/exec_utils.h
diff options
context:
space:
mode:
Diffstat (limited to 'runtime/exec_utils.h')
-rw-r--r--runtime/exec_utils.h115
1 files changed, 88 insertions, 27 deletions
diff --git a/runtime/exec_utils.h b/runtime/exec_utils.h
index 7ce0a9c20a..b83722fd62 100644
--- a/runtime/exec_utils.h
+++ b/runtime/exec_utils.h
@@ -19,48 +19,109 @@
#include <time.h>
+#include <functional>
#include <string>
#include <vector>
+#include "android-base/unique_fd.h"
+
namespace art {
+struct ProcessStat {
+ // The total wall time, in milliseconds, that the process spent, or 0 if failed to get the value.
+ int wall_time_ms = 0;
+ // The total CPU time, in milliseconds, that the process and any waited-for children spent, or 0
+ // if failed to get the value.
+ int cpu_time_ms = 0;
+};
+
+struct ExecCallbacks {
+ // Called in the parent process as soon as the child process is forked.
+ std::function<void(pid_t pid)> on_start = [](pid_t) {};
+ // Called in the parent process after the child process exits while still in a waitable state, no
+ // matter the child process succeeds or not.
+ std::function<void(pid_t pid)> on_end = [](pid_t) {};
+};
+
+struct ExecResult {
+ // This struct needs to be in sync with the ExecResultStatus enum contained within the
+ // OdrefreshReported atom in frameworks/proto_logging/atoms/art/odrefresh_extension_atoms.proto.
+ enum Status {
+ // Unable to get the status.
+ kUnknown = 0,
+ // Process exited normally with an exit code.
+ kExited = 1,
+ // Process terminated by a signal.
+ kSignaled = 2,
+ // Process timed out and killed.
+ kTimedOut = 3,
+ // Failed to start the process.
+ kStartFailed = 4,
+ kLast = kStartFailed
+ };
+
+ Status status = kUnknown;
+
+ // The process exit code, if `status` is `kExited`, or -1.
+ int exit_code = -1;
+
+ // The signal that terminated the process, if `status` is `kSignaled`, or 0.
+ int signal = 0;
+};
+
// Wrapper on fork/execv to run a command in a subprocess.
// These spawn child processes using the environment as it was set when the single instance
// of the runtime (Runtime::Current()) was started. If no instance of the runtime was started, it
// will use the current environment settings.
-
-bool Exec(std::vector<std::string>& arg_vector, /*out*/ std::string* error_msg);
-int ExecAndReturnCode(std::vector<std::string>& arg_vector, /*out*/ std::string* error_msg);
-
-// Execute the command specified in `argv_vector` in a subprocess with a timeout.
-// Returns the process exit code on success, -1 otherwise.
-int ExecAndReturnCode(std::vector<std::string>& arg_vector,
- time_t timeout_secs,
- /*out*/ bool* timed_out,
- /*out*/ std::string* error_msg);
-
-// A wrapper class to make the functions above mockable.
class ExecUtils {
public:
virtual ~ExecUtils() = default;
- virtual bool Exec(std::vector<std::string>& arg_vector, /*out*/ std::string* error_msg) const {
- return art::Exec(arg_vector, error_msg);
- }
-
- virtual int ExecAndReturnCode(std::vector<std::string>& arg_vector,
- /*out*/ std::string* error_msg) const {
- return art::ExecAndReturnCode(arg_vector, error_msg);
- }
-
- virtual int ExecAndReturnCode(std::vector<std::string>& arg_vector,
- time_t timeout_secs,
- /*out*/ bool* timed_out,
- /*out*/ std::string* error_msg) const {
- return art::ExecAndReturnCode(arg_vector, timeout_secs, timed_out, error_msg);
- }
+ virtual bool Exec(const std::vector<std::string>& arg_vector,
+ /*out*/ std::string* error_msg) const;
+
+ virtual int ExecAndReturnCode(const std::vector<std::string>& arg_vector,
+ /*out*/ std::string* error_msg) const;
+
+ // Executes the command specified in `arg_vector` in a subprocess with a timeout.
+ // If `timeout_sec` is negative, blocks until the subprocess exits.
+ // Returns a structured result. If the status is not `kExited`, also returns a non-empty
+ // `error_msg`.
+ virtual ExecResult ExecAndReturnResult(const std::vector<std::string>& arg_vector,
+ int timeout_sec,
+ /*out*/ std::string* error_msg) const;
+
+ // Same as above, but also collects stat of the process and calls callbacks. The stat is collected
+ // no matter the child process succeeds or not.
+ virtual ExecResult ExecAndReturnResult(const std::vector<std::string>& arg_vector,
+ int timeout_sec,
+ const ExecCallbacks& callbacks,
+ /*out*/ ProcessStat* stat,
+ /*out*/ std::string* error_msg) const;
+
+ protected:
+ virtual android::base::unique_fd PidfdOpen(pid_t pid) const;
+
+ // Returns the content of `/proc/<pid>/stat`, or an empty string if failed.
+ virtual std::string GetProcStat(pid_t pid) const;
+
+ virtual int64_t GetUptimeMs() const;
+
+ virtual int64_t GetTicksPerSec() const;
+
+ private:
+ bool GetStat(pid_t pid, /*out*/ ProcessStat* stat, /*out*/ std::string* error_msg) const;
};
+inline bool Exec(const std::vector<std::string>& arg_vector, /*out*/ std::string* error_msg) {
+ return ExecUtils().Exec(arg_vector, error_msg);
+}
+
+inline int ExecAndReturnCode(const std::vector<std::string>& arg_vector,
+ /*out*/ std::string* error_msg) {
+ return ExecUtils().ExecAndReturnCode(arg_vector, error_msg);
+}
+
} // namespace art
#endif // ART_RUNTIME_EXEC_UTILS_H_