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