erg@google.com | a502bbe7 | 2011-01-07 18:06:45 | [diff] [blame] | 1 | // Copyright (c) 2011 The Chromium Authors. All rights reserved. |
license.bot | bf09a50 | 2008-08-24 00:55:55 | [diff] [blame] | 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 4 | |
| 5 | // This file/namespace contains utility functions for enumerating, ending and |
| 6 | // computing statistics of processes. |
| 7 | |
deanm@google.com | db71728 | 2008-08-27 13:48:03 | [diff] [blame] | 8 | #ifndef BASE_PROCESS_UTIL_H_ |
| 9 | #define BASE_PROCESS_UTIL_H_ |
thakis@chromium.org | 32b76ef | 2010-07-26 23:08:24 | [diff] [blame] | 10 | #pragma once |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 11 | |
paulg@google.com | 6165906 | 2008-08-06 01:04:18 | [diff] [blame] | 12 | #include "base/basictypes.h" |
| 13 | |
dkegel@google.com | ab0e222 | 2008-10-31 20:19:43 | [diff] [blame] | 14 | #if defined(OS_WIN) |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 15 | #include <windows.h> |
| 16 | #include <tlhelp32.h> |
wtc@chromium.org | 4a34ce0 | 2009-08-31 22:25:00 | [diff] [blame] | 17 | #elif defined(OS_MACOSX) |
| 18 | // kinfo_proc is defined in <sys/sysctl.h>, but this forward declaration |
| 19 | // is sufficient for the vector<kinfo_proc> below. |
| 20 | struct kinfo_proc; |
avi@chromium.org | 6cfa339 | 2010-07-01 20:11:43 | [diff] [blame] | 21 | // malloc_zone_t is defined in <malloc/malloc.h>, but this forward declaration |
| 22 | // is sufficient for GetPurgeableZone() below. |
| 23 | typedef struct _malloc_zone_t malloc_zone_t; |
thakis@chromium.org | c002879 | 2010-01-12 00:39:15 | [diff] [blame] | 24 | #include <mach/mach.h> |
wtc@chromium.org | 4a34ce0 | 2009-08-31 22:25:00 | [diff] [blame] | 25 | #elif defined(OS_POSIX) |
dkegel@google.com | ab0e222 | 2008-10-31 20:19:43 | [diff] [blame] | 26 | #include <dirent.h> |
| 27 | #include <limits.h> |
| 28 | #include <sys/types.h> |
paulg@google.com | 6165906 | 2008-08-06 01:04:18 | [diff] [blame] | 29 | #endif |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 30 | |
maruel@chromium.org | b6128aa | 2010-04-29 17:44:42 | [diff] [blame] | 31 | #include <list> |
paulg@google.com | 6165906 | 2008-08-06 01:04:18 | [diff] [blame] | 32 | #include <string> |
thestig@chromium.org | 9ec8db0 | 2009-07-21 07:00:13 | [diff] [blame] | 33 | #include <utility> |
mark@chromium.org | 962dd31 | 2009-02-05 21:44:13 | [diff] [blame] | 34 | #include <vector> |
paulg@google.com | 6165906 | 2008-08-06 01:04:18 | [diff] [blame] | 35 | |
rvargas@google.com | f5661ca | 2011-03-24 19:00:20 | [diff] [blame] | 36 | #include "base/base_api.h" |
maruel@chromium.org | a5a00b1d | 2010-04-08 15:52:45 | [diff] [blame] | 37 | #include "base/file_descriptor_shuffle.h" |
avi@chromium.org | 4f260d0 | 2010-12-23 18:35:42 | [diff] [blame] | 38 | #include "base/file_path.h" |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 39 | #include "base/process.h" |
| 40 | |
erg@google.com | 5d91c9e | 2010-07-28 17:25:28 | [diff] [blame] | 41 | class CommandLine; |
erg@google.com | 5d91c9e | 2010-07-28 17:25:28 | [diff] [blame] | 42 | |
maruel@chromium.org | a5a00b1d | 2010-04-08 15:52:45 | [diff] [blame] | 43 | namespace base { |
| 44 | |
paulg@google.com | 6165906 | 2008-08-06 01:04:18 | [diff] [blame] | 45 | #if defined(OS_WIN) |
maruel@chromium.org | a5a00b1d | 2010-04-08 15:52:45 | [diff] [blame] | 46 | struct ProcessEntry : public PROCESSENTRY32 { |
maruel@chromium.org | b6128aa | 2010-04-29 17:44:42 | [diff] [blame] | 47 | ProcessId pid() const { return th32ProcessID; } |
| 48 | ProcessId parent_pid() const { return th32ParentProcessID; } |
| 49 | const wchar_t* exe_file() const { return szExeFile; } |
maruel@chromium.org | a5a00b1d | 2010-04-08 15:52:45 | [diff] [blame] | 50 | }; |
maruel@chromium.org | b6128aa | 2010-04-29 17:44:42 | [diff] [blame] | 51 | |
maruel@chromium.org | a5a00b1d | 2010-04-08 15:52:45 | [diff] [blame] | 52 | struct IoCounters : public IO_COUNTERS { |
| 53 | }; |
| 54 | |
sanjeevr@chromium.org | 7d11f6d5 | 2010-10-12 21:44:23 | [diff] [blame] | 55 | // Process access masks. These constants provide platform-independent |
| 56 | // definitions for the standard Windows access masks. |
| 57 | // See http://msdn.microsoft.com/en-us/library/ms684880(VS.85).aspx for |
| 58 | // the specific semantics of each mask value. |
| 59 | const uint32 kProcessAccessTerminate = PROCESS_TERMINATE; |
| 60 | const uint32 kProcessAccessCreateThread = PROCESS_CREATE_THREAD; |
| 61 | const uint32 kProcessAccessSetSessionId = PROCESS_SET_SESSIONID; |
| 62 | const uint32 kProcessAccessVMOperation = PROCESS_VM_OPERATION; |
| 63 | const uint32 kProcessAccessVMRead = PROCESS_VM_READ; |
| 64 | const uint32 kProcessAccessVMWrite = PROCESS_VM_WRITE; |
| 65 | const uint32 kProcessAccessDuplicateHandle = PROCESS_DUP_HANDLE; |
| 66 | const uint32 kProcessAccessCreateProcess = PROCESS_CREATE_PROCESS; |
| 67 | const uint32 kProcessAccessSetQuota = PROCESS_SET_QUOTA; |
| 68 | const uint32 kProcessAccessSetInformation = PROCESS_SET_INFORMATION; |
| 69 | const uint32 kProcessAccessQueryInformation = PROCESS_QUERY_INFORMATION; |
| 70 | const uint32 kProcessAccessSuspendResume = PROCESS_SUSPEND_RESUME; |
| 71 | const uint32 kProcessAccessQueryLimitedInfomation = |
| 72 | PROCESS_QUERY_LIMITED_INFORMATION; |
| 73 | const uint32 kProcessAccessWaitForTermination = SYNCHRONIZE; |
paulg@google.com | 6165906 | 2008-08-06 01:04:18 | [diff] [blame] | 74 | #elif defined(OS_POSIX) |
maruel@chromium.org | a5a00b1d | 2010-04-08 15:52:45 | [diff] [blame] | 75 | |
dkegel@google.com | ab0e222 | 2008-10-31 20:19:43 | [diff] [blame] | 76 | struct ProcessEntry { |
erg@google.com | bbf94a3 | 2010-10-13 17:44:15 | [diff] [blame] | 77 | ProcessEntry(); |
| 78 | ~ProcessEntry(); |
| 79 | |
maruel@chromium.org | b6128aa | 2010-04-29 17:44:42 | [diff] [blame] | 80 | ProcessId pid() const { return pid_; } |
| 81 | ProcessId parent_pid() const { return ppid_; } |
rsimha@chromium.org | c47d81d | 2010-10-05 23:41:04 | [diff] [blame] | 82 | ProcessId gid() const { return gid_; } |
maruel@chromium.org | b6128aa | 2010-04-29 17:44:42 | [diff] [blame] | 83 | const char* exe_file() const { return exe_file_.c_str(); } |
rsimha@chromium.org | c47d81d | 2010-10-05 23:41:04 | [diff] [blame] | 84 | const std::vector<std::string>& cmd_line_args() const { |
| 85 | return cmd_line_args_; |
| 86 | } |
erg@google.com | a502bbe7 | 2011-01-07 18:06:45 | [diff] [blame] | 87 | |
| 88 | ProcessId pid_; |
| 89 | ProcessId ppid_; |
| 90 | ProcessId gid_; |
| 91 | std::string exe_file_; |
| 92 | std::vector<std::string> cmd_line_args_; |
dkegel@google.com | ab0e222 | 2008-10-31 20:19:43 | [diff] [blame] | 93 | }; |
| 94 | |
evanm@google.com | 0b100bc8 | 2008-10-14 20:49:16 | [diff] [blame] | 95 | struct IoCounters { |
evan@chromium.org | 34b2b00 | 2009-11-20 06:53:28 | [diff] [blame] | 96 | uint64_t ReadOperationCount; |
| 97 | uint64_t WriteOperationCount; |
| 98 | uint64_t OtherOperationCount; |
| 99 | uint64_t ReadTransferCount; |
| 100 | uint64_t WriteTransferCount; |
| 101 | uint64_t OtherTransferCount; |
evanm@google.com | 0b100bc8 | 2008-10-14 20:49:16 | [diff] [blame] | 102 | }; |
agl@chromium.org | 3f04f2b | 2009-04-30 19:40:03 | [diff] [blame] | 103 | |
sanjeevr@chromium.org | 7d11f6d5 | 2010-10-12 21:44:23 | [diff] [blame] | 104 | // Process access masks. They are not used on Posix because access checking |
| 105 | // does not happen during handle creation. |
| 106 | const uint32 kProcessAccessTerminate = 0; |
| 107 | const uint32 kProcessAccessCreateThread = 0; |
| 108 | const uint32 kProcessAccessSetSessionId = 0; |
| 109 | const uint32 kProcessAccessVMOperation = 0; |
| 110 | const uint32 kProcessAccessVMRead = 0; |
| 111 | const uint32 kProcessAccessVMWrite = 0; |
| 112 | const uint32 kProcessAccessDuplicateHandle = 0; |
| 113 | const uint32 kProcessAccessCreateProcess = 0; |
| 114 | const uint32 kProcessAccessSetQuota = 0; |
| 115 | const uint32 kProcessAccessSetInformation = 0; |
| 116 | const uint32 kProcessAccessQueryInformation = 0; |
| 117 | const uint32 kProcessAccessSuspendResume = 0; |
| 118 | const uint32 kProcessAccessQueryLimitedInfomation = 0; |
| 119 | const uint32 kProcessAccessWaitForTermination = 0; |
maruel@chromium.org | a5a00b1d | 2010-04-08 15:52:45 | [diff] [blame] | 120 | #endif // defined(OS_POSIX) |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 121 | |
gspencer@chromium.org | 443b80e | 2010-12-14 00:42:23 | [diff] [blame] | 122 | // Return status values from GetTerminationStatus. Don't use these as |
| 123 | // exit code arguments to KillProcess*(), use platform/application |
| 124 | // specific values instead. |
| 125 | enum TerminationStatus { |
| 126 | TERMINATION_STATUS_NORMAL_TERMINATION, // zero exit status |
| 127 | TERMINATION_STATUS_ABNORMAL_TERMINATION, // non-zero exit status |
| 128 | TERMINATION_STATUS_PROCESS_WAS_KILLED, // e.g. SIGKILL or task manager kill |
| 129 | TERMINATION_STATUS_PROCESS_CRASHED, // e.g. Segmentation fault |
scheib@chromium.org | bcb2c77 | 2011-04-01 20:20:53 | [diff] [blame] | 130 | TERMINATION_STATUS_STILL_RUNNING, // child hasn't exited yet |
| 131 | TERMINATION_STATUS_MAX_ENUM |
cpu@google.com | eef576f | 2008-11-03 23:28:06 | [diff] [blame] | 132 | }; |
| 133 | |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 134 | // Returns the id of the current process. |
rvargas@google.com | 26fbf80 | 2011-03-25 18:48:03 | [diff] [blame] | 135 | BASE_API ProcessId GetCurrentProcId(); |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 136 | |
erikkay@google.com | 113ab13 | 2008-09-18 20:42:55 | [diff] [blame] | 137 | // Returns the ProcessHandle of the current process. |
rvargas@google.com | 26fbf80 | 2011-03-25 18:48:03 | [diff] [blame] | 138 | BASE_API ProcessHandle GetCurrentProcessHandle(); |
maruel@chromium.org | 52a261f | 2009-03-03 15:01:12 | [diff] [blame] | 139 | |
brettw@google.com | 5986ed2 | 2009-02-06 00:19:17 | [diff] [blame] | 140 | // Converts a PID to a process handle. This handle must be closed by |
phajdan.jr@chromium.org | 6c6cc80 | 2009-04-03 17:01:36 | [diff] [blame] | 141 | // CloseProcessHandle when you are done with it. Returns true on success. |
rvargas@google.com | 26fbf80 | 2011-03-25 18:48:03 | [diff] [blame] | 142 | BASE_API bool OpenProcessHandle(ProcessId pid, ProcessHandle* handle); |
maruel@chromium.org | 52a261f | 2009-03-03 15:01:12 | [diff] [blame] | 143 | |
phajdan.jr@chromium.org | 5d438dbad | 2009-04-30 08:59:39 | [diff] [blame] | 144 | // Converts a PID to a process handle. On Windows the handle is opened |
| 145 | // with more access rights and must only be used by trusted code. |
| 146 | // You have to close returned handle using CloseProcessHandle. Returns true |
| 147 | // on success. |
sanjeevr@chromium.org | 7d11f6d5 | 2010-10-12 21:44:23 | [diff] [blame] | 148 | // TODO(sanjeevr): Replace all calls to OpenPrivilegedProcessHandle with the |
| 149 | // more specific OpenProcessHandleWithAccess method and delete this. |
rvargas@google.com | 26fbf80 | 2011-03-25 18:48:03 | [diff] [blame] | 150 | BASE_API bool OpenPrivilegedProcessHandle(ProcessId pid, ProcessHandle* handle); |
phajdan.jr@chromium.org | 5d438dbad | 2009-04-30 08:59:39 | [diff] [blame] | 151 | |
sanjeevr@chromium.org | 7d11f6d5 | 2010-10-12 21:44:23 | [diff] [blame] | 152 | // Converts a PID to a process handle using the desired access flags. Use a |
| 153 | // combination of the kProcessAccess* flags defined above for |access_flags|. |
rvargas@google.com | 26fbf80 | 2011-03-25 18:48:03 | [diff] [blame] | 154 | BASE_API bool OpenProcessHandleWithAccess(ProcessId pid, |
| 155 | uint32 access_flags, |
| 156 | ProcessHandle* handle); |
sanjeevr@chromium.org | 7d11f6d5 | 2010-10-12 21:44:23 | [diff] [blame] | 157 | |
brettw@google.com | 5986ed2 | 2009-02-06 00:19:17 | [diff] [blame] | 158 | // Closes the process handle opened by OpenProcessHandle. |
rvargas@google.com | 26fbf80 | 2011-03-25 18:48:03 | [diff] [blame] | 159 | BASE_API void CloseProcessHandle(ProcessHandle process); |
erikkay@google.com | 113ab13 | 2008-09-18 20:42:55 | [diff] [blame] | 160 | |
cpu@google.com | eef576f | 2008-11-03 23:28:06 | [diff] [blame] | 161 | // Returns the unique ID for the specified process. This is functionally the |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 162 | // same as Windows' GetProcessId(), but works on versions of Windows before |
| 163 | // Win XP SP1 as well. |
rvargas@google.com | 26fbf80 | 2011-03-25 18:48:03 | [diff] [blame] | 164 | BASE_API ProcessId GetProcId(ProcessHandle process); |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 165 | |
dkegel@google.com | 78c6dd6 | 2009-06-08 23:29:11 | [diff] [blame] | 166 | #if defined(OS_LINUX) |
dkegel@google.com | 78c6dd6 | 2009-06-08 23:29:11 | [diff] [blame] | 167 | // Returns the path to the executable of the given process. |
evan@chromium.org | 68a008e | 2011-05-02 17:54:14 | [diff] [blame] | 168 | BASE_API FilePath GetProcessExecutablePath(ProcessHandle process); |
evan@chromium.org | d2ed2383 | 2009-09-19 01:57:39 | [diff] [blame] | 169 | |
| 170 | // Parse the data found in /proc/<pid>/stat and return the sum of the |
| 171 | // CPU-related ticks. Returns -1 on parse error. |
| 172 | // Exposed for testing. |
evan@chromium.org | 91d91fa | 2011-04-29 20:45:22 | [diff] [blame] | 173 | BASE_API int ParseProcStatCPU(const std::string& input); |
thestig@chromium.org | e5856a7a | 2009-12-10 02:08:10 | [diff] [blame] | 174 | |
| 175 | static const char kAdjustOOMScoreSwitch[] = "--adjust-oom-score"; |
| 176 | |
| 177 | // This adjusts /proc/process/oom_adj so the Linux OOM killer will prefer |
| 178 | // certain process types over others. The range for the adjustment is |
| 179 | // [-17,15], with [0,15] being user accessible. |
evan@chromium.org | 68a008e | 2011-05-02 17:54:14 | [diff] [blame] | 180 | BASE_API bool AdjustOOMScore(ProcessId process, int score); |
dkegel@google.com | 78c6dd6 | 2009-06-08 23:29:11 | [diff] [blame] | 181 | #endif |
| 182 | |
jeremy@chromium.org | fa3097a6a5 | 2008-12-17 22:41:50 | [diff] [blame] | 183 | #if defined(OS_POSIX) |
dmaclach@chromium.org | 56f0f26 | 2011-02-24 17:14:36 | [diff] [blame] | 184 | // Returns the ID for the parent of the given process. |
evan@chromium.org | 91d91fa | 2011-04-29 20:45:22 | [diff] [blame] | 185 | BASE_API ProcessId GetParentProcessId(ProcessHandle process); |
dmaclach@chromium.org | 56f0f26 | 2011-02-24 17:14:36 | [diff] [blame] | 186 | |
gspencer@chromium.org | 443b80e | 2010-12-14 00:42:23 | [diff] [blame] | 187 | // Close all file descriptors, except those which are a destination in the |
agl@chromium.org | 3f04f2b | 2009-04-30 19:40:03 | [diff] [blame] | 188 | // given multimap. Only call this function in a child process where you know |
| 189 | // that there aren't any other threads. |
evan@chromium.org | 68a008e | 2011-05-02 17:54:14 | [diff] [blame] | 190 | BASE_API void CloseSuperfluousFds(const InjectiveMultimap& saved_map); |
jeremy@chromium.org | fa3097a6a5 | 2008-12-17 22:41:50 | [diff] [blame] | 191 | #endif |
| 192 | |
evan@chromium.org | 898a81a | 2011-06-30 22:56:15 | [diff] [blame] | 193 | // TODO(evan): rename these to use StudlyCaps. |
| 194 | typedef std::vector<std::pair<std::string, std::string> > environment_vector; |
| 195 | typedef std::vector<std::pair<int, int> > file_handle_mapping_vector; |
| 196 | |
| 197 | // Options for launching a subprocess that are passed to LaunchApp(). |
| 198 | struct LaunchOptions { |
| 199 | LaunchOptions() : wait(false), process_handle(NULL), |
| 200 | #if defined(OS_WIN) |
| 201 | start_hidden(false), inherit_handles(false), as_user(NULL), |
| 202 | empty_desktop_name(false) |
| 203 | #else |
| 204 | environ(NULL), fds_to_remap(NULL), new_process_group(false) |
| 205 | #endif |
| 206 | {} |
| 207 | |
| 208 | // If true, wait for the process to complete. |
| 209 | bool wait; |
| 210 | |
| 211 | // If non-NULL, will be filled in with the handle of the launched process. |
| 212 | // NOTE: In this case, the caller is responsible for closing the handle so |
| 213 | // that it doesn't leak! Otherwise, the handle will be implicitly |
| 214 | // closed. |
| 215 | // Not especially useful unless |wait| is false. |
| 216 | ProcessHandle* process_handle; |
| 217 | |
| 218 | #if defined(OS_WIN) |
| 219 | bool start_hidden; |
| 220 | |
| 221 | // If true, the new process inherits handles from the parent. |
| 222 | bool inherit_handles; |
| 223 | |
| 224 | // If non-NULL, runs as if the user represented by the token had launched it. |
| 225 | // Whether the application is visible on the interactive desktop depends on |
| 226 | // the token belonging to an interactive logon session. |
| 227 | // |
| 228 | // To avoid hard to diagnose problems, when specified this loads the |
| 229 | // environment variables associated with the user and if this operation fails |
| 230 | // the entire call fails as well. |
| 231 | UserTokenHandle as_user; |
| 232 | |
| 233 | // If true, use an empty string for the desktop name. |
| 234 | bool empty_desktop_name; |
| 235 | #else |
| 236 | // If non-NULL, set/unset environment variables. |
| 237 | // See documentation of AlterEnvironment(). |
| 238 | // This pointer is owned by the caller and must live through the |
| 239 | // call to LaunchProcess(). |
| 240 | const environment_vector* environ; |
| 241 | |
| 242 | // If non-NULL, remap file descriptors according to the mapping of |
| 243 | // src fd->dest fd to propagate FDs into the child process. |
| 244 | // This pointer is owned by the caller and must live through the |
| 245 | // call to LaunchProcess(). |
| 246 | const file_handle_mapping_vector* fds_to_remap; |
| 247 | |
| 248 | // If true, start the process in a new process group, instead of |
| 249 | // inheriting the parent's process group. The pgid of the child process |
| 250 | // will be the same as its pid. |
| 251 | bool new_process_group; |
| 252 | #endif |
| 253 | }; |
| 254 | |
| 255 | // Launch a process via the command line |cmdline|. |
| 256 | // See the documentation of LaunchOptions for details on launching options. |
| 257 | // |
| 258 | // Unix-specific notes: |
| 259 | // - Before launching, all FDs open in the parent process will be marked as |
| 260 | // close-on-exec. |
| 261 | // - If the first argument on the command line does not contain a slash, |
| 262 | // PATH will be searched. (See man execvp.) |
| 263 | BASE_API bool LaunchProcess(const CommandLine& cmdline, |
| 264 | const LaunchOptions& options); |
| 265 | |
estade@chromium.org | fb7f9be | 2008-10-22 01:15:47 | [diff] [blame] | 266 | #if defined(OS_WIN) |
tommi@chromium.org | 48dc9e1 | 2010-08-26 19:49:57 | [diff] [blame] | 267 | |
| 268 | enum IntegrityLevel { |
| 269 | INTEGRITY_UNKNOWN, |
| 270 | LOW_INTEGRITY, |
| 271 | MEDIUM_INTEGRITY, |
| 272 | HIGH_INTEGRITY, |
| 273 | }; |
| 274 | // Determine the integrity level of the specified process. Returns false |
| 275 | // if the system does not support integrity levels (pre-Vista) or in the case |
| 276 | // of an underlying system failure. |
rvargas@google.com | 26fbf80 | 2011-03-25 18:48:03 | [diff] [blame] | 277 | BASE_API bool GetProcessIntegrityLevel(ProcessHandle process, |
| 278 | IntegrityLevel *level); |
tommi@chromium.org | 48dc9e1 | 2010-08-26 19:49:57 | [diff] [blame] | 279 | |
evan@chromium.org | 898a81a | 2011-06-30 22:56:15 | [diff] [blame] | 280 | // Windows-specific LaunchProcess that takes the command line as a |
| 281 | // string. Useful for situations where you need to control the |
| 282 | // command line arguments directly, but prefer the CommandLine version |
| 283 | // if launching Chrome itself. |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 284 | // |
evan@chromium.org | 898a81a | 2011-06-30 22:56:15 | [diff] [blame] | 285 | // The first command line argument should be the path to the process, |
| 286 | // and don't forget to quote it. |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 287 | // |
| 288 | // Example (including literal quotes) |
| 289 | // cmdline = "c:\windows\explorer.exe" -foo "c:\bar\" |
evan@chromium.org | 898a81a | 2011-06-30 22:56:15 | [diff] [blame] | 290 | BASE_API bool LaunchProcess(const string16& cmdline, |
| 291 | const LaunchOptions& options); |
cpu@chromium.org | e50130b | 2010-02-01 03:28:47 | [diff] [blame] | 292 | |
evan@chromium.org | 898a81a | 2011-06-30 22:56:15 | [diff] [blame] | 293 | // TODO(evan): deprecated; change callers to use LaunchProcess, remove. |
| 294 | inline bool LaunchApp(const std::wstring& cmdline, |
| 295 | bool wait, bool start_hidden, |
| 296 | ProcessHandle* process_handle) { |
| 297 | LaunchOptions options; |
| 298 | options.wait = wait; |
| 299 | options.start_hidden = start_hidden; |
| 300 | options.process_handle = process_handle; |
| 301 | return LaunchProcess(cmdline, options); |
| 302 | } |
finnur@chromium.org | 81e3260 | 2010-09-07 14:01:31 | [diff] [blame] | 303 | |
evan@chromium.org | 898a81a | 2011-06-30 22:56:15 | [diff] [blame] | 304 | // TODO(evan): deprecated; change callers to use LaunchProcess, remove. |
| 305 | inline bool LaunchAppWithHandleInheritance(const std::wstring& cmdline, |
| 306 | bool wait, bool start_hidden, |
| 307 | ProcessHandle* process_handle) { |
| 308 | LaunchOptions options; |
| 309 | options.wait = wait; |
| 310 | options.start_hidden = start_hidden; |
| 311 | options.process_handle = process_handle; |
| 312 | options.inherit_handles = true; |
| 313 | return LaunchProcess(cmdline, options); |
| 314 | } |
cpu@chromium.org | e50130b | 2010-02-01 03:28:47 | [diff] [blame] | 315 | |
evan@chromium.org | 898a81a | 2011-06-30 22:56:15 | [diff] [blame] | 316 | // TODO(evan): deprecated; change callers to use LaunchProcess, remove. |
| 317 | inline bool LaunchAppAsUser(UserTokenHandle token, |
| 318 | const std::wstring& cmdline, |
| 319 | bool start_hidden, |
| 320 | ProcessHandle* process_handle) { |
| 321 | LaunchOptions options; |
| 322 | options.start_hidden = start_hidden; |
| 323 | options.process_handle = process_handle; |
| 324 | options.as_user = token; |
| 325 | return LaunchProcess(cmdline, options); |
| 326 | } |
gwilson@google.com | c020ddc | 2010-02-18 23:01:52 | [diff] [blame] | 327 | |
evan@chromium.org | 898a81a | 2011-06-30 22:56:15 | [diff] [blame] | 328 | // TODO(evan): deprecated; change callers to use LaunchProcess, remove. |
| 329 | inline bool LaunchAppAsUser(UserTokenHandle token, |
| 330 | const std::wstring& cmdline, |
| 331 | bool start_hidden, ProcessHandle* process_handle, |
| 332 | bool empty_desktop_name, bool inherit_handles) { |
| 333 | LaunchOptions options; |
| 334 | options.start_hidden = start_hidden; |
| 335 | options.process_handle = process_handle; |
| 336 | options.as_user = token; |
| 337 | options.empty_desktop_name = empty_desktop_name; |
| 338 | options.inherit_handles = inherit_handles; |
| 339 | return LaunchProcess(cmdline, options); |
| 340 | } |
gwilson@google.com | c020ddc | 2010-02-18 23:01:52 | [diff] [blame] | 341 | |
estade@chromium.org | fb7f9be | 2008-10-22 01:15:47 | [diff] [blame] | 342 | #elif defined(OS_POSIX) |
evan@chromium.org | 898a81a | 2011-06-30 22:56:15 | [diff] [blame] | 343 | // A POSIX-specific version of LaunchProcess that takes an argv array |
| 344 | // instead of a CommandLine. Useful for situations where you need to |
| 345 | // control the command line arguments directly, but prefer the |
| 346 | // CommandLine version if launching Chrome itself. |
| 347 | BASE_API bool LaunchProcess(const std::vector<std::string>& argv, |
| 348 | const LaunchOptions& options); |
stuartmorgan@google.com | 2aea9e09 | 2009-08-06 20:03:01 | [diff] [blame] | 349 | |
evan@chromium.org | 898a81a | 2011-06-30 22:56:15 | [diff] [blame] | 350 | // TODO(evan): deprecated; change callers to use LaunchProcess, remove. |
| 351 | inline bool LaunchApp(const std::vector<std::string>& argv, |
| 352 | const file_handle_mapping_vector& fds_to_remap, |
| 353 | bool wait, ProcessHandle* process_handle) { |
| 354 | LaunchOptions options; |
| 355 | options.fds_to_remap = &fds_to_remap; |
| 356 | options.wait = wait; |
| 357 | options.process_handle = process_handle; |
| 358 | return LaunchProcess(argv, options); |
| 359 | } |
thakis@chromium.org | c002879 | 2010-01-12 00:39:15 | [diff] [blame] | 360 | |
evan@chromium.org | 898a81a | 2011-06-30 22:56:15 | [diff] [blame] | 361 | // TODO(evan): deprecated; change callers to use LaunchProcess, remove. |
| 362 | inline bool LaunchApp(const std::vector<std::string>& argv, |
| 363 | const environment_vector& environ, |
| 364 | const file_handle_mapping_vector& fds_to_remap, |
| 365 | bool wait, ProcessHandle* process_handle) { |
| 366 | LaunchOptions options; |
| 367 | options.environ = &environ; |
| 368 | options.fds_to_remap = &fds_to_remap; |
| 369 | options.wait = wait; |
| 370 | options.process_handle = process_handle; |
| 371 | return LaunchProcess(argv, options); |
| 372 | } |
| 373 | |
| 374 | // TODO(evan): deprecated; change callers to use LaunchProcess, remove. |
| 375 | inline bool LaunchAppInNewProcessGroup( |
evan@chromium.org | c48d860 | 2011-05-09 21:46:08 | [diff] [blame] | 376 | const std::vector<std::string>& argv, |
| 377 | const environment_vector& environ, |
| 378 | const file_handle_mapping_vector& fds_to_remap, |
| 379 | bool wait, |
evan@chromium.org | 898a81a | 2011-06-30 22:56:15 | [diff] [blame] | 380 | ProcessHandle* process_handle) { |
| 381 | LaunchOptions options; |
| 382 | options.environ = &environ; |
| 383 | options.fds_to_remap = &fds_to_remap; |
| 384 | options.wait = wait; |
| 385 | options.process_handle = process_handle; |
| 386 | options.new_process_group = true; |
| 387 | return LaunchProcess(argv, options); |
| 388 | } |
rsimha@chromium.org | 61b93f88f | 2010-09-22 17:28:30 | [diff] [blame] | 389 | |
agl@chromium.org | ef73044e | 2010-03-11 15:25:54 | [diff] [blame] | 390 | // AlterEnvironment returns a modified environment vector, constructed from the |
| 391 | // given environment and the list of changes given in |changes|. Each key in |
| 392 | // the environment is matched against the first element of the pairs. In the |
| 393 | // event of a match, the value is replaced by the second of the pair, unless |
| 394 | // the second is empty, in which case the key-value is removed. |
| 395 | // |
| 396 | // The returned array is allocated using new[] and must be freed by the caller. |
evan@chromium.org | 91d91fa | 2011-04-29 20:45:22 | [diff] [blame] | 397 | BASE_API char** AlterEnvironment(const environment_vector& changes, |
| 398 | const char* const* const env); |
thestig@chromium.org | 9ec8db0 | 2009-07-21 07:00:13 | [diff] [blame] | 399 | #endif // defined(OS_POSIX) |
estade@chromium.org | fb7f9be | 2008-10-22 01:15:47 | [diff] [blame] | 400 | |
jcampan@chromium.org | 1e31211 | 2009-04-21 21:44:12 | [diff] [blame] | 401 | // Executes the application specified by cl. This function delegates to one |
evan@chromium.org | 898a81a | 2011-06-30 22:56:15 | [diff] [blame] | 402 | // of the above platform-specific functions. |
| 403 | // TODO(evan): deprecated; change callers to use LaunchProcess, remove. |
| 404 | inline bool LaunchApp(const CommandLine& cl, bool wait, bool start_hidden, |
| 405 | ProcessHandle* process_handle) { |
| 406 | LaunchOptions options; |
| 407 | options.wait = wait; |
| 408 | options.process_handle = process_handle; |
| 409 | |
| 410 | return LaunchProcess(cl, options); |
| 411 | } |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 412 | |
jcampan@chromium.org | 1e31211 | 2009-04-21 21:44:12 | [diff] [blame] | 413 | // Executes the application specified by |cl| and wait for it to exit. Stores |
phajdan.jr@chromium.org | 1912cfe | 2009-04-21 08:09:30 | [diff] [blame] | 414 | // the output (stdout) in |output|. Redirects stderr to /dev/null. Returns true |
| 415 | // on success (application launched and exited cleanly, with exit code |
maruel@chromium.org | 96878a21 | 2010-06-10 18:26:33 | [diff] [blame] | 416 | // indicating success). |
rvargas@google.com | 26fbf80 | 2011-03-25 18:48:03 | [diff] [blame] | 417 | BASE_API bool GetAppOutput(const CommandLine& cl, std::string* output); |
phajdan.jr@chromium.org | c0b210ee | 2009-04-17 09:57:52 | [diff] [blame] | 418 | |
viettrungluu@chromium.org | f164cea | 2009-11-05 23:37:40 | [diff] [blame] | 419 | #if defined(OS_POSIX) |
| 420 | // A restricted version of |GetAppOutput()| which (a) clears the environment, |
| 421 | // and (b) stores at most |max_output| bytes; also, it doesn't search the path |
| 422 | // for the command. |
evan@chromium.org | 91d91fa | 2011-04-29 20:45:22 | [diff] [blame] | 423 | BASE_API bool GetAppOutputRestricted(const CommandLine& cl, |
| 424 | std::string* output, size_t max_output); |
benwells@chromium.org | d03b05c | 2011-07-06 06:14:48 | [diff] [blame^] | 425 | |
| 426 | // A version of |GetAppOutput()| which also returns the exit code of the |
| 427 | // executed command. Returns true if the application runs and exits cleanly. If |
| 428 | // this is the case the exit code of the application is available in |
| 429 | // |*exit_code|. |
| 430 | BASE_API bool GetAppOutputWithExitCode(const CommandLine& cl, |
| 431 | std::string* output, int* exit_code); |
viettrungluu@chromium.org | f164cea | 2009-11-05 23:37:40 | [diff] [blame] | 432 | #endif |
| 433 | |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 434 | // Used to filter processes by process ID. |
| 435 | class ProcessFilter { |
| 436 | public: |
| 437 | // Returns true to indicate set-inclusion and false otherwise. This method |
| 438 | // should not have side-effects and should be idempotent. |
maruel@chromium.org | b6128aa | 2010-04-29 17:44:42 | [diff] [blame] | 439 | virtual bool Includes(const ProcessEntry& entry) const = 0; |
ziadh@chromium.org | 695092f | 2010-08-02 16:34:16 | [diff] [blame] | 440 | |
| 441 | protected: |
| 442 | virtual ~ProcessFilter() {} |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 443 | }; |
| 444 | |
| 445 | // Returns the number of processes on the machine that are running from the |
| 446 | // given executable name. If filter is non-null, then only processes selected |
| 447 | // by the filter will be counted. |
rvargas@google.com | 26fbf80 | 2011-03-25 18:48:03 | [diff] [blame] | 448 | BASE_API int GetProcessCount(const FilePath::StringType& executable_name, |
| 449 | const ProcessFilter* filter); |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 450 | |
| 451 | // Attempts to kill all the processes on the current machine that were launched |
| 452 | // from the given executable name, ending them with the given exit code. If |
| 453 | // filter is non-null, then only processes selected by the filter are killed. |
rsimha@chromium.org | 61b93f88f | 2010-09-22 17:28:30 | [diff] [blame] | 454 | // Returns true if all processes were able to be killed off, false if at least |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 455 | // one couldn't be killed. |
rvargas@google.com | 26fbf80 | 2011-03-25 18:48:03 | [diff] [blame] | 456 | BASE_API bool KillProcesses(const FilePath::StringType& executable_name, |
| 457 | int exit_code, const ProcessFilter* filter); |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 458 | |
| 459 | // Attempts to kill the process identified by the given process |
| 460 | // entry structure, giving it the specified exit code. If |wait| is true, wait |
| 461 | // for the process to be actually terminated before returning. |
| 462 | // Returns true if this is successful, false otherwise. |
rvargas@google.com | 26fbf80 | 2011-03-25 18:48:03 | [diff] [blame] | 463 | BASE_API bool KillProcess(ProcessHandle process, int exit_code, bool wait); |
rsimha@chromium.org | 61b93f88f | 2010-09-22 17:28:30 | [diff] [blame] | 464 | |
| 465 | #if defined(OS_POSIX) |
| 466 | // Attempts to kill the process group identified by |process_group_id|. Returns |
| 467 | // true on success. |
evan@chromium.org | c48d860 | 2011-05-09 21:46:08 | [diff] [blame] | 468 | BASE_API bool KillProcessGroup(ProcessHandle process_group_id); |
rsimha@chromium.org | 61b93f88f | 2010-09-22 17:28:30 | [diff] [blame] | 469 | #endif |
| 470 | |
agl@chromium.org | dfe1486 | 2009-01-22 01:23:11 | [diff] [blame] | 471 | #if defined(OS_WIN) |
rvargas@google.com | 26fbf80 | 2011-03-25 18:48:03 | [diff] [blame] | 472 | BASE_API bool KillProcessById(ProcessId process_id, int exit_code, bool wait); |
agl@chromium.org | dfe1486 | 2009-01-22 01:23:11 | [diff] [blame] | 473 | #endif |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 474 | |
gspencer@chromium.org | 443b80e | 2010-12-14 00:42:23 | [diff] [blame] | 475 | // Get the termination status of the process by interpreting the |
| 476 | // circumstances of the child process' death. |exit_code| is set to |
| 477 | // the status returned by waitpid() on POSIX, and from |
| 478 | // GetExitCodeProcess() on Windows. |exit_code| may be NULL if the |
| 479 | // caller is not interested in it. Note that on Linux, this function |
| 480 | // will only return a useful result the first time it is called after |
| 481 | // the child exits (because it will reap the child and the information |
| 482 | // will no longer be available). |
rvargas@google.com | 26fbf80 | 2011-03-25 18:48:03 | [diff] [blame] | 483 | BASE_API TerminationStatus GetTerminationStatus(ProcessHandle handle, |
| 484 | int* exit_code); |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 485 | |
dmaclach@chromium.org | 56f0f26 | 2011-02-24 17:14:36 | [diff] [blame] | 486 | // Waits for process to exit. On POSIX systems, if the process hasn't been |
phajdan.jr@chromium.org | c785663 | 2009-01-13 17:38:49 | [diff] [blame] | 487 | // signaled then puts the exit code in |exit_code|; otherwise it's considered |
| 488 | // a failure. On Windows |exit_code| is always filled. Returns true on success, |
| 489 | // and closes |handle| in any case. |
rvargas@google.com | 26fbf80 | 2011-03-25 18:48:03 | [diff] [blame] | 490 | BASE_API bool WaitForExitCode(ProcessHandle handle, int* exit_code); |
phajdan.jr@chromium.org | c785663 | 2009-01-13 17:38:49 | [diff] [blame] | 491 | |
phajdan.jr@chromium.org | 8004e68 | 2010-03-16 07:41:22 | [diff] [blame] | 492 | // Waits for process to exit. If it did exit within |timeout_milliseconds|, |
phajdan.jr@chromium.org | 40bbe59 | 2011-04-06 12:18:20 | [diff] [blame] | 493 | // then puts the exit code in |exit_code|, and returns true. |
phajdan.jr@chromium.org | 8004e68 | 2010-03-16 07:41:22 | [diff] [blame] | 494 | // In POSIX systems, if the process has been signaled then |exit_code| is set |
| 495 | // to -1. Returns false on failure (the caller is then responsible for closing |
| 496 | // |handle|). |
phajdan.jr@chromium.org | 40bbe59 | 2011-04-06 12:18:20 | [diff] [blame] | 497 | // The caller is always responsible for closing the |handle|. |
rvargas@google.com | 26fbf80 | 2011-03-25 18:48:03 | [diff] [blame] | 498 | BASE_API bool WaitForExitCodeWithTimeout(ProcessHandle handle, int* exit_code, |
| 499 | int64 timeout_milliseconds); |
phajdan.jr@chromium.org | 8004e68 | 2010-03-16 07:41:22 | [diff] [blame] | 500 | |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 501 | // Wait for all the processes based on the named executable to exit. If filter |
| 502 | // is non-null, then only processes selected by the filter are waited on. |
| 503 | // Returns after all processes have exited or wait_milliseconds have expired. |
| 504 | // Returns true if all the processes exited, false otherwise. |
rvargas@google.com | 26fbf80 | 2011-03-25 18:48:03 | [diff] [blame] | 505 | BASE_API bool WaitForProcessesToExit( |
| 506 | const FilePath::StringType& executable_name, |
| 507 | int64 wait_milliseconds, |
| 508 | const ProcessFilter* filter); |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 509 | |
estade@chromium.org | fb7f9be | 2008-10-22 01:15:47 | [diff] [blame] | 510 | // Wait for a single process to exit. Return true if it exited cleanly within |
dmaclach@chromium.org | 56f0f26 | 2011-02-24 17:14:36 | [diff] [blame] | 511 | // the given time limit. On Linux |handle| must be a child process, however |
| 512 | // on Mac and Windows it can be any process. |
rvargas@google.com | 26fbf80 | 2011-03-25 18:48:03 | [diff] [blame] | 513 | BASE_API bool WaitForSingleProcess(ProcessHandle handle, |
| 514 | int64 wait_milliseconds); |
phajdan.jr@chromium.org | c7c98097 | 2011-04-05 18:05:34 | [diff] [blame] | 515 | |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 516 | // Waits a certain amount of time (can be 0) for all the processes with a given |
| 517 | // executable name to exit, then kills off any of them that are still around. |
| 518 | // If filter is non-null, then only processes selected by the filter are waited |
| 519 | // on. Killed processes are ended with the given exit code. Returns false if |
| 520 | // any processes needed to be killed, true if they all exited cleanly within |
| 521 | // the wait_milliseconds delay. |
rvargas@google.com | 26fbf80 | 2011-03-25 18:48:03 | [diff] [blame] | 522 | BASE_API bool CleanupProcesses(const FilePath::StringType& executable_name, |
| 523 | int64 wait_milliseconds, |
| 524 | int exit_code, |
| 525 | const ProcessFilter* filter); |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 526 | |
maruel@chromium.org | b6128aa | 2010-04-29 17:44:42 | [diff] [blame] | 527 | // This class provides a way to iterate through a list of processes on the |
| 528 | // current machine with a specified filter. |
| 529 | // To use, create an instance and then call NextProcessEntry() until it returns |
| 530 | // false. |
rvargas@google.com | 26fbf80 | 2011-03-25 18:48:03 | [diff] [blame] | 531 | class BASE_API ProcessIterator { |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 532 | public: |
maruel@chromium.org | baead4f | 2010-06-11 19:10:30 | [diff] [blame] | 533 | typedef std::list<ProcessEntry> ProcessEntries; |
| 534 | |
maruel@chromium.org | b6128aa | 2010-04-29 17:44:42 | [diff] [blame] | 535 | explicit ProcessIterator(const ProcessFilter* filter); |
| 536 | virtual ~ProcessIterator(); |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 537 | |
| 538 | // If there's another process that matches the given executable name, |
| 539 | // returns a const pointer to the corresponding PROCESSENTRY32. |
| 540 | // If there are no more matching processes, returns NULL. |
| 541 | // The returned pointer will remain valid until NextProcessEntry() |
| 542 | // is called again or this NamedProcessIterator goes out of scope. |
| 543 | const ProcessEntry* NextProcessEntry(); |
| 544 | |
maruel@chromium.org | b6128aa | 2010-04-29 17:44:42 | [diff] [blame] | 545 | // Takes a snapshot of all the ProcessEntry found. |
maruel@chromium.org | baead4f | 2010-06-11 19:10:30 | [diff] [blame] | 546 | ProcessEntries Snapshot(); |
maruel@chromium.org | b6128aa | 2010-04-29 17:44:42 | [diff] [blame] | 547 | |
| 548 | protected: |
| 549 | virtual bool IncludeEntry(); |
| 550 | const ProcessEntry& entry() { return entry_; } |
| 551 | |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 552 | private: |
| 553 | // Determines whether there's another process (regardless of executable) |
| 554 | // left in the list of all processes. Returns true and sets entry_ to |
| 555 | // that process's info if there is one, false otherwise. |
| 556 | bool CheckForNextProcess(); |
| 557 | |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 558 | // Initializes a PROCESSENTRY32 data structure so that it's ready for |
| 559 | // use with Process32First/Process32Next. |
| 560 | void InitProcessEntry(ProcessEntry* entry); |
dkegel@google.com | ab0e222 | 2008-10-31 20:19:43 | [diff] [blame] | 561 | |
| 562 | #if defined(OS_WIN) |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 563 | HANDLE snapshot_; |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 564 | bool started_iteration_; |
dkegel@google.com | ab0e222 | 2008-10-31 20:19:43 | [diff] [blame] | 565 | #elif defined(OS_MACOSX) |
mark@chromium.org | 962dd31 | 2009-02-05 21:44:13 | [diff] [blame] | 566 | std::vector<kinfo_proc> kinfo_procs_; |
| 567 | size_t index_of_kinfo_proc_; |
wtc@chromium.org | 4a34ce0 | 2009-08-31 22:25:00 | [diff] [blame] | 568 | #elif defined(OS_POSIX) |
| 569 | DIR *procfs_dir_; |
dkegel@google.com | ab0e222 | 2008-10-31 20:19:43 | [diff] [blame] | 570 | #endif |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 571 | ProcessEntry entry_; |
| 572 | const ProcessFilter* filter_; |
| 573 | |
maruel@chromium.org | b6128aa | 2010-04-29 17:44:42 | [diff] [blame] | 574 | DISALLOW_COPY_AND_ASSIGN(ProcessIterator); |
| 575 | }; |
| 576 | |
| 577 | // This class provides a way to iterate through the list of processes |
| 578 | // on the current machine that were started from the given executable |
| 579 | // name. To use, create an instance and then call NextProcessEntry() |
| 580 | // until it returns false. |
rvargas@google.com | 26fbf80 | 2011-03-25 18:48:03 | [diff] [blame] | 581 | class BASE_API NamedProcessIterator : public ProcessIterator { |
maruel@chromium.org | b6128aa | 2010-04-29 17:44:42 | [diff] [blame] | 582 | public: |
avi@chromium.org | 4f260d0 | 2010-12-23 18:35:42 | [diff] [blame] | 583 | NamedProcessIterator(const FilePath::StringType& executable_name, |
maruel@chromium.org | b6128aa | 2010-04-29 17:44:42 | [diff] [blame] | 584 | const ProcessFilter* filter); |
| 585 | virtual ~NamedProcessIterator(); |
| 586 | |
| 587 | protected: |
| 588 | virtual bool IncludeEntry(); |
| 589 | |
| 590 | private: |
avi@chromium.org | 4f260d0 | 2010-12-23 18:35:42 | [diff] [blame] | 591 | FilePath::StringType executable_name_; |
maruel@chromium.org | b6128aa | 2010-04-29 17:44:42 | [diff] [blame] | 592 | |
| 593 | DISALLOW_COPY_AND_ASSIGN(NamedProcessIterator); |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 594 | }; |
| 595 | |
| 596 | // Working Set (resident) memory usage broken down by |
agl@chromium.org | 54fd1d3 | 2009-09-01 00:12:58 | [diff] [blame] | 597 | // |
| 598 | // On Windows: |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 599 | // priv (private): These pages (kbytes) cannot be shared with any other process. |
| 600 | // shareable: These pages (kbytes) can be shared with other processes under |
| 601 | // the right circumstances. |
| 602 | // shared : These pages (kbytes) are currently shared with at least one |
| 603 | // other process. |
agl@chromium.org | 54fd1d3 | 2009-09-01 00:12:58 | [diff] [blame] | 604 | // |
| 605 | // On Linux: |
| 606 | // priv: Pages mapped only by this process |
| 607 | // shared: PSS or 0 if the kernel doesn't support this |
| 608 | // shareable: 0 |
viettrungluu@chromium.org | 3740cb9b5 | 2009-12-19 04:50:04 | [diff] [blame] | 609 | // |
| 610 | // On OS X: TODO(thakis): Revise. |
| 611 | // priv: Memory. |
| 612 | // shared: 0 |
| 613 | // shareable: 0 |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 614 | struct WorkingSetKBytes { |
agl@chromium.org | 54fd1d3 | 2009-09-01 00:12:58 | [diff] [blame] | 615 | WorkingSetKBytes() : priv(0), shareable(0), shared(0) {} |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 616 | size_t priv; |
| 617 | size_t shareable; |
| 618 | size_t shared; |
| 619 | }; |
| 620 | |
| 621 | // Committed (resident + paged) memory usage broken down by |
| 622 | // private: These pages cannot be shared with any other process. |
| 623 | // mapped: These pages are mapped into the view of a section (backed by |
| 624 | // pagefile.sys) |
| 625 | // image: These pages are mapped into the view of an image section (backed by |
| 626 | // file system) |
| 627 | struct CommittedKBytes { |
agl@chromium.org | 54fd1d3 | 2009-09-01 00:12:58 | [diff] [blame] | 628 | CommittedKBytes() : priv(0), mapped(0), image(0) {} |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 629 | size_t priv; |
| 630 | size_t mapped; |
| 631 | size_t image; |
| 632 | }; |
| 633 | |
| 634 | // Free memory (Megabytes marked as free) in the 2G process address space. |
| 635 | // total : total amount in megabytes marked as free. Maximum value is 2048. |
| 636 | // largest : size of the largest contiguous amount of memory found. It is |
| 637 | // always smaller or equal to FreeMBytes::total. |
| 638 | // largest_ptr: starting address of the largest memory block. |
| 639 | struct FreeMBytes { |
| 640 | size_t total; |
| 641 | size_t largest; |
| 642 | void* largest_ptr; |
| 643 | }; |
| 644 | |
evan@chromium.org | d2ed2383 | 2009-09-19 01:57:39 | [diff] [blame] | 645 | // Convert a POSIX timeval to microseconds. |
rvargas@google.com | 26fbf80 | 2011-03-25 18:48:03 | [diff] [blame] | 646 | BASE_API int64 TimeValToMicroseconds(const struct timeval& tv); |
evan@chromium.org | d2ed2383 | 2009-09-19 01:57:39 | [diff] [blame] | 647 | |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 648 | // Provides performance metrics for a specified process (CPU usage, memory and |
| 649 | // IO counters). To use it, invoke CreateProcessMetrics() to get an instance |
| 650 | // for a specific process, then access the information with the different get |
| 651 | // methods. |
rvargas@google.com | 26fbf80 | 2011-03-25 18:48:03 | [diff] [blame] | 652 | class BASE_API ProcessMetrics { |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 653 | public: |
erg@google.com | a502bbe7 | 2011-01-07 18:06:45 | [diff] [blame] | 654 | ~ProcessMetrics(); |
| 655 | |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 656 | // Creates a ProcessMetrics for the specified process. |
| 657 | // The caller owns the returned object. |
viettrungluu@chromium.org | 3740cb9b5 | 2009-12-19 04:50:04 | [diff] [blame] | 658 | #if !defined(OS_MACOSX) |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 659 | static ProcessMetrics* CreateProcessMetrics(ProcessHandle process); |
viettrungluu@chromium.org | 3740cb9b5 | 2009-12-19 04:50:04 | [diff] [blame] | 660 | #else |
| 661 | class PortProvider { |
| 662 | public: |
thakis@chromium.org | b2e8e08 | 2009-12-21 17:44:20 | [diff] [blame] | 663 | // Should return the mach task for |process| if possible, or else |
| 664 | // |MACH_PORT_NULL|. Only processes that this returns tasks for will have |
| 665 | // metrics on OS X (except for the current process, which always gets |
| 666 | // metrics). |
viettrungluu@chromium.org | 3740cb9b5 | 2009-12-19 04:50:04 | [diff] [blame] | 667 | virtual mach_port_t TaskForPid(ProcessHandle process) const = 0; |
| 668 | }; |
| 669 | |
| 670 | // The port provider needs to outlive the ProcessMetrics object returned by |
| 671 | // this function. If NULL is passed as provider, the returned object |
| 672 | // only returns valid metrics if |process| is the current process. |
| 673 | static ProcessMetrics* CreateProcessMetrics(ProcessHandle process, |
| 674 | PortProvider* port_provider); |
maruel@chromium.org | b6128aa | 2010-04-29 17:44:42 | [diff] [blame] | 675 | #endif // !defined(OS_MACOSX) |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 676 | |
| 677 | // Returns the current space allocated for the pagefile, in bytes (these pages |
thomasvl@chromium.org | 796da7c | 2009-06-11 12:45:45 | [diff] [blame] | 678 | // may or may not be in memory). On Linux, this returns the total virtual |
| 679 | // memory size. |
phajdan.jr@chromium.org | d043c2cc | 2009-03-25 18:30:45 | [diff] [blame] | 680 | size_t GetPagefileUsage() const; |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 681 | // Returns the peak space allocated for the pagefile, in bytes. |
phajdan.jr@chromium.org | d043c2cc | 2009-03-25 18:30:45 | [diff] [blame] | 682 | size_t GetPeakPagefileUsage() const; |
thomasvl@chromium.org | 796da7c | 2009-06-11 12:45:45 | [diff] [blame] | 683 | // Returns the current working set size, in bytes. On Linux, this returns |
| 684 | // the resident set size. |
phajdan.jr@chromium.org | d043c2cc | 2009-03-25 18:30:45 | [diff] [blame] | 685 | size_t GetWorkingSetSize() const; |
tc@google.com | 0c557f1 | 2009-05-11 23:35:52 | [diff] [blame] | 686 | // Returns the peak working set size, in bytes. |
| 687 | size_t GetPeakWorkingSetSize() const; |
erg@chromium.org | 98947a0 | 2010-05-11 17:46:08 | [diff] [blame] | 688 | // Returns private and sharedusage, in bytes. Private bytes is the amount of |
| 689 | // memory currently allocated to a process that cannot be shared. Returns |
| 690 | // false on platform specific error conditions. Note: |private_bytes| |
| 691 | // returns 0 on unsupported OSes: prior to XP SP2. |
| 692 | bool GetMemoryBytes(size_t* private_bytes, |
| 693 | size_t* shared_bytes); |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 694 | // Fills a CommittedKBytes with both resident and paged |
| 695 | // memory usage as per definition of CommittedBytes. |
phajdan.jr@chromium.org | d043c2cc | 2009-03-25 18:30:45 | [diff] [blame] | 696 | void GetCommittedKBytes(CommittedKBytes* usage) const; |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 697 | // Fills a WorkingSetKBytes containing resident private and shared memory |
| 698 | // usage in bytes, as per definition of WorkingSetBytes. |
phajdan.jr@chromium.org | d043c2cc | 2009-03-25 18:30:45 | [diff] [blame] | 699 | bool GetWorkingSetKBytes(WorkingSetKBytes* ws_usage) const; |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 700 | |
| 701 | // Computes the current process available memory for allocation. |
| 702 | // It does a linear scan of the address space querying each memory region |
| 703 | // for its free (unallocated) status. It is useful for estimating the memory |
| 704 | // load and fragmentation. |
phajdan.jr@chromium.org | d043c2cc | 2009-03-25 18:30:45 | [diff] [blame] | 705 | bool CalculateFreeMemory(FreeMBytes* free) const; |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 706 | |
| 707 | // Returns the CPU usage in percent since the last time this method was |
| 708 | // called. The first time this method is called it returns 0 and will return |
| 709 | // the actual CPU info on subsequent calls. |
thakis@chromium.org | 022eab6 | 2010-01-13 04:55:06 | [diff] [blame] | 710 | // On Windows, the CPU usage value is for all CPUs. So if you have 2 CPUs and |
| 711 | // your process is using all the cycles of 1 CPU and not the other CPU, this |
| 712 | // method returns 50. |
| 713 | double GetCPUUsage(); |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 714 | |
| 715 | // Retrieves accounting information for all I/O operations performed by the |
| 716 | // process. |
| 717 | // If IO information is retrieved successfully, the function returns true |
| 718 | // and fills in the IO_COUNTERS passed in. The function returns false |
| 719 | // otherwise. |
phajdan.jr@chromium.org | d043c2cc | 2009-03-25 18:30:45 | [diff] [blame] | 720 | bool GetIOCounters(IoCounters* io_counters) const; |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 721 | |
| 722 | private: |
viettrungluu@chromium.org | 3740cb9b5 | 2009-12-19 04:50:04 | [diff] [blame] | 723 | #if !defined(OS_MACOSX) |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 724 | explicit ProcessMetrics(ProcessHandle process); |
viettrungluu@chromium.org | 3740cb9b5 | 2009-12-19 04:50:04 | [diff] [blame] | 725 | #else |
| 726 | ProcessMetrics(ProcessHandle process, PortProvider* port_provider); |
maruel@chromium.org | b6128aa | 2010-04-29 17:44:42 | [diff] [blame] | 727 | #endif // !defined(OS_MACOSX) |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 728 | |
| 729 | ProcessHandle process_; |
| 730 | |
| 731 | int processor_count_; |
| 732 | |
evan@chromium.org | d2ed2383 | 2009-09-19 01:57:39 | [diff] [blame] | 733 | // Used to store the previous times and CPU usage counts so we can |
| 734 | // compute the CPU usage between calls. |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 735 | int64 last_time_; |
| 736 | int64 last_system_time_; |
| 737 | |
viettrungluu@chromium.org | 3740cb9b5 | 2009-12-19 04:50:04 | [diff] [blame] | 738 | #if defined(OS_MACOSX) |
| 739 | // Queries the port provider if it's set. |
| 740 | mach_port_t TaskForPid(ProcessHandle process) const; |
| 741 | |
| 742 | PortProvider* port_provider_; |
pvalchev@google.com | 66700d4 | 2010-03-10 07:46:43 | [diff] [blame] | 743 | #elif defined(OS_POSIX) |
| 744 | // Jiffie count at the last_time_ we updated. |
| 745 | int last_cpu_; |
maruel@chromium.org | b6128aa | 2010-04-29 17:44:42 | [diff] [blame] | 746 | #endif // defined(OS_MACOSX) |
viettrungluu@chromium.org | 3740cb9b5 | 2009-12-19 04:50:04 | [diff] [blame] | 747 | |
maruel@chromium.org | b6128aa | 2010-04-29 17:44:42 | [diff] [blame] | 748 | DISALLOW_COPY_AND_ASSIGN(ProcessMetrics); |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 749 | }; |
| 750 | |
sgk@chromium.org | ed26d94 | 2009-11-09 06:57:28 | [diff] [blame] | 751 | // Returns the memory commited by the system in KBytes. |
| 752 | // Returns 0 if it can't compute the commit charge. |
rvargas@google.com | 26fbf80 | 2011-03-25 18:48:03 | [diff] [blame] | 753 | BASE_API size_t GetSystemCommitCharge(); |
sgk@chromium.org | ed26d94 | 2009-11-09 06:57:28 | [diff] [blame] | 754 | |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 755 | // Enables low fragmentation heap (LFH) for every heaps of this process. This |
| 756 | // won't have any effect on heaps created after this function call. It will not |
| 757 | // modify data allocated in the heaps before calling this function. So it is |
| 758 | // better to call this function early in initialization and again before |
| 759 | // entering the main loop. |
| 760 | // Note: Returns true on Windows 2000 without doing anything. |
rvargas@google.com | 26fbf80 | 2011-03-25 18:48:03 | [diff] [blame] | 761 | BASE_API bool EnableLowFragmentationHeap(); |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 762 | |
maruel@chromium.org | d6fc9fd | 2009-10-27 18:03:47 | [diff] [blame] | 763 | // Enables 'terminate on heap corruption' flag. Helps protect against heap |
maruel@google.com | c9d4087 | 2008-09-24 12:58:37 | [diff] [blame] | 764 | // overflow. Has no effect if the OS doesn't provide the necessary facility. |
rvargas@google.com | f5661ca | 2011-03-24 19:00:20 | [diff] [blame] | 765 | BASE_API void EnableTerminationOnHeapCorruption(); |
maruel@google.com | c9d4087 | 2008-09-24 12:58:37 | [diff] [blame] | 766 | |
avi@chromium.org | cccb2121 | 2009-11-12 20:39:56 | [diff] [blame] | 767 | #if !defined(OS_WIN) |
| 768 | // Turns on process termination if memory runs out. This is handled on Windows |
| 769 | // inside RegisterInvalidParamHandler(). |
evan@chromium.org | 91d91fa | 2011-04-29 20:45:22 | [diff] [blame] | 770 | BASE_API void EnableTerminationOnOutOfMemory(); |
avi@chromium.org | 6cfa339 | 2010-07-01 20:11:43 | [diff] [blame] | 771 | #if defined(OS_MACOSX) |
| 772 | // Exposed for testing. |
| 773 | malloc_zone_t* GetPurgeableZone(); |
| 774 | #endif |
avi@chromium.org | cccb2121 | 2009-11-12 20:39:56 | [diff] [blame] | 775 | #endif |
| 776 | |
maruel@chromium.org | d6fc9fd | 2009-10-27 18:03:47 | [diff] [blame] | 777 | // Enables stack dump to console output on exception and signals. |
| 778 | // When enabled, the process will quit immediately. This is meant to be used in |
| 779 | // unit_tests only! |
rvargas@google.com | 26fbf80 | 2011-03-25 18:48:03 | [diff] [blame] | 780 | BASE_API bool EnableInProcessStackDumping(); |
maruel@chromium.org | d6fc9fd | 2009-10-27 18:03:47 | [diff] [blame] | 781 | |
deanm@google.com | db71728 | 2008-08-27 13:48:03 | [diff] [blame] | 782 | // If supported on the platform, and the user has sufficent rights, increase |
| 783 | // the current process's scheduling priority to a high priority. |
rvargas@google.com | 26fbf80 | 2011-03-25 18:48:03 | [diff] [blame] | 784 | BASE_API void RaiseProcessToHighPriority(); |
deanm@google.com | db71728 | 2008-08-27 13:48:03 | [diff] [blame] | 785 | |
mark@chromium.org | e9a8c19f | 2009-09-03 21:27:36 | [diff] [blame] | 786 | #if defined(OS_MACOSX) |
| 787 | // Restore the default exception handler, setting it to Apple Crash Reporter |
| 788 | // (ReportCrash). When forking and execing a new process, the child will |
| 789 | // inherit the parent's exception ports, which may be set to the Breakpad |
| 790 | // instance running inside the parent. The parent's Breakpad instance should |
| 791 | // not handle the child's exceptions. Calling RestoreDefaultExceptionHandler |
| 792 | // in the child after forking will restore the standard exception handler. |
| 793 | // See http://crbug.com/20371/ for more details. |
| 794 | void RestoreDefaultExceptionHandler(); |
maruel@chromium.org | b6128aa | 2010-04-29 17:44:42 | [diff] [blame] | 795 | #endif // defined(OS_MACOSX) |
mark@chromium.org | e9a8c19f | 2009-09-03 21:27:36 | [diff] [blame] | 796 | |
brettw@google.com | 176aa48 | 2008-11-14 03:25:15 | [diff] [blame] | 797 | } // namespace base |
initial.commit | d7cae12 | 2008-07-26 21:49:38 | [diff] [blame] | 798 | |
deanm@google.com | db71728 | 2008-08-27 13:48:03 | [diff] [blame] | 799 | #endif // BASE_PROCESS_UTIL_H_ |