Thanks to visit codestin.com
Credit goes to chromium.googlesource.com

Google Git
Sign in
chromium / chromium / src / main / . / base / process / kill.h
blob: 112d6c4b67f0e10252c2b9cc428e3a161ac30629 [file] [log] [blame]
Avi Drissmane4622aa2022-09-08 20:36:06[diff] [blame]1// Copyright 2013 The Chromium Authors
[email protected]307af212013-07-10 18:36:09[diff] [blame]2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5// This file contains routines to kill processes and get the exit code and
6// termination status.
7
8#ifndef BASE_PROCESS_KILL_H_
9#define BASE_PROCESS_KILL_H_
10
David Sanders6e709942022-04-05 06:49:26[diff] [blame]11#include "base/base_export.h"
[email protected]307af212013-07-10 18:36:09[diff] [blame]12#include "base/files/file_path.h"
rvargas61812772014-12-05 03:14:54[diff] [blame]13#include "base/process/process.h"
[email protected]dd4b51262013-07-25 21:38:23[diff] [blame]14#include "base/process/process_handle.h"
[email protected]307af212013-07-10 18:36:09[diff] [blame]15#include "base/time/time.h"
avibeced7c2015-12-24 06:47:59[diff] [blame]16#include "build/build_config.h"
[email protected]307af212013-07-10 18:36:09[diff] [blame]17
18namespace base {
19
20class ProcessFilter;
21
Xiaohan Wang37e81612022-01-15 18:27:00[diff] [blame]22#if BUILDFLAG(IS_WIN)
wfh48c487e62016-07-27 22:48:47[diff] [blame]23namespace win {
24
25// See definition in sandbox/win/src/sandbox_types.h
26const DWORD kSandboxFatalMemoryExceeded = 7012;
27
Bruce Dawsonec0158512017-11-16 09:10:40[diff] [blame]28// Exit codes with special meanings on Windows.
29const DWORD kNormalTerminationExitCode = 0;
30const DWORD kDebuggerInactiveExitCode = 0xC0000354;
31const DWORD kKeyboardInterruptExitCode = 0xC000013A;
32const DWORD kDebuggerTerminatedExitCode = 0x40010004;
Will Harris07925d12019-10-31 03:03:05[diff] [blame]33const DWORD kStatusInvalidImageHashExitCode = 0xC0000428;
Bruce Dawsonec0158512017-11-16 09:10:40[diff] [blame]34
35// This exit code is used by the Windows task manager when it kills a
36// process. It's value is obviously not that unique, and it's
37// surprising to me that the task manager uses this value, but it
38// seems to be common practice on Windows to test for it as an
39// indication that the task manager has killed something if the
40// process goes away.
41const DWORD kProcessKilledExitCode = 1;
42
wfh48c487e62016-07-27 22:48:47[diff] [blame]43} // namespace win
44
Xiaohan Wang37e81612022-01-15 18:27:00[diff] [blame]45#endif // BUILDFLAG(IS_WIN)
wfh48c487e62016-07-27 22:48:47[diff] [blame]46
François Doray8cadc162023-12-06 11:18:14[diff] [blame]47// Return status values from GetTerminationStatus. Don't use these as exit code
48// arguments to KillProcess*(), use platform/application specific values
49// instead.
50//
51// Used for metrics. Keep in sync with the "TerminationStatus" histogram enum.
52// Do not repurpose previously used indexes.
Andrew Williams92dcbea2024-04-26 14:23:33[diff] [blame]53// GENERATED_JAVA_ENUM_PACKAGE: org.chromium.base
54// GENERATED_JAVA_PREFIX_TO_STRIP: TERMINATION_STATUS_
S. Ganesh4e21a58a2025-04-15 17:13:34[diff] [blame]55enum TerminationStatus : int {
François Doray8cadc162023-12-06 11:18:14[diff] [blame]56 // Zero exit status.
57 TERMINATION_STATUS_NORMAL_TERMINATION = 0,
58 // Other abnormal termination reason.
59 TERMINATION_STATUS_ABNORMAL_TERMINATION = 1,
60 // E.g. SIGKILL or task manager kill.
61 TERMINATION_STATUS_PROCESS_WAS_KILLED = 2,
62 // E.g. Segmentation fault.
63 TERMINATION_STATUS_PROCESS_CRASHED = 3,
64 // Child hasn't exited yet.
65 TERMINATION_STATUS_STILL_RUNNING = 4,
Xiaohan Wang37e81612022-01-15 18:27:00[diff] [blame]66#if BUILDFLAG(IS_CHROMEOS)
François Doray8cadc162023-12-06 11:18:14[diff] [blame]67 // OOM-killer killed the process on ChromeOS.
68 TERMINATION_STATUS_PROCESS_WAS_KILLED_BY_OOM = 5,
oshima620225722015-06-04 19:45:27[diff] [blame]69#endif
Xiaohan Wang37e81612022-01-15 18:27:00[diff] [blame]70#if BUILDFLAG(IS_ANDROID)
[email protected]6bf2f782013-11-08 15:52:53[diff] [blame]71 // On Android processes are spawned from the system Zygote and we do not get
François Doray8cadc162023-12-06 11:18:14[diff] [blame]72 // the termination status. We can't know if the termination was a crash or an
[email protected]6bf2f782013-11-08 15:52:53[diff] [blame]73 // oom kill for sure, but we can use status of the strong process bindings as
74 // a hint.
François Doray8cadc162023-12-06 11:18:14[diff] [blame]75 TERMINATION_STATUS_OOM_PROTECTED = 6,
[email protected]6bf2f782013-11-08 15:52:53[diff] [blame]76#endif
François Doray8cadc162023-12-06 11:18:14[diff] [blame]77 // Child process never launched.
78 TERMINATION_STATUS_LAUNCH_FAILED = 7,
79 // Out of memory.
80 TERMINATION_STATUS_OOM = 8,
Xiaohan Wang37e81612022-01-15 18:27:00[diff] [blame]81#if BUILDFLAG(IS_WIN)
Will Harris07925d12019-10-31 03:03:05[diff] [blame]82 // On Windows, the OS terminated process due to code integrity failure.
François Doray8cadc162023-12-06 11:18:14[diff] [blame]83 TERMINATION_STATUS_INTEGRITY_FAILURE = 9,
Will Harris07925d12019-10-31 03:03:05[diff] [blame]84#endif
Alex Attara2100e2ad2025-09-29 17:13:13[diff] [blame]85 // The process was proactively terminated by the browser to reclaim memory.
86 TERMINATION_STATUS_EVICTED_FOR_MEMORY = 10,
87 TERMINATION_STATUS_MAX_ENUM = 11,
[email protected]307af212013-07-10 18:36:09[diff] [blame]88};
89
90// Attempts to kill all the processes on the current machine that were launched
91// from the given executable name, ending them with the given exit code. If
92// filter is non-null, then only processes selected by the filter are killed.
93// Returns true if all processes were able to be killed off, false if at least
94// one couldn't be killed.
95BASE_EXPORT bool KillProcesses(const FilePath::StringType& executable_name,
96 int exit_code,
97 const ProcessFilter* filter);
98
[email protected]307af212013-07-10 18:36:09[diff] [blame]99// Get the termination status of the process by interpreting the
100// circumstances of the child process' death. |exit_code| is set to
Wez05c2c682017-08-17 16:20:11[diff] [blame]101// the status returned by waitpid() on POSIX, and from GetExitCodeProcess() on
102// Windows, and may not be null. Note that on Linux, this function
[email protected]307af212013-07-10 18:36:09[diff] [blame]103// will only return a useful result the first time it is called after
104// the child exits (because it will reap the child and the information
105// will no longer be available).
106BASE_EXPORT TerminationStatus GetTerminationStatus(ProcessHandle handle,
107 int* exit_code);
108
Xiaohan Wang37e81612022-01-15 18:27:00[diff] [blame]109#if BUILDFLAG(IS_POSIX)
[email protected]0dac68b42013-09-17 03:50:22[diff] [blame]110// Send a kill signal to the process and then wait for the process to exit
111// and get the termination status.
112//
113// This is used in situations where it is believed that the process is dead
114// or dying (because communication with the child process has been cut).
115// In order to avoid erroneously returning that the process is still running
116// because the kernel is still cleaning it up, this will wait for the process
117// to terminate. In order to avoid the risk of hanging while waiting for the
118// process to terminate, send a SIGKILL to the process before waiting for the
119// termination status.
120//
121// Note that it is not an option to call WaitForExitCode and then
122// GetTerminationStatus as the child will be reaped when WaitForExitCode
123// returns, and this information will be lost.
124//
Peter Kasting134ef9af2024-12-28 02:30:09[diff] [blame]125BASE_EXPORT TerminationStatus
126GetKnownDeadTerminationStatus(ProcessHandle handle, int* exit_code);
Wezc18a57c2018-04-02 20:20:14[diff] [blame]127
Xiaohan Wang37e81612022-01-15 18:27:00[diff] [blame]128#if BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS)
Wezc18a57c2018-04-02 20:20:14[diff] [blame]129// Spawns a thread to wait asynchronously for the child |process| to exit
130// and then reaps it.
131BASE_EXPORT void EnsureProcessGetsReaped(Process process);
Xiaohan Wang37e81612022-01-15 18:27:00[diff] [blame]132#endif // BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS)
133#endif // BUILDFLAG(IS_POSIX)
[email protected]307af212013-07-10 18:36:09[diff] [blame]134
Wezc18a57c2018-04-02 20:20:14[diff] [blame]135// Registers |process| to be asynchronously monitored for termination, forcibly
136// terminated if necessary, and reaped on exit. The caller should have signalled
137// |process| to exit before calling this API. The API will allow a couple of
138// seconds grace period before forcibly terminating |process|.
Alison Gale923a33e2024-04-22 23:34:28[diff] [blame]139// TODO(crbug.com/41367359): The Mac implementation currently blocks the
Wezc18a57c2018-04-02 20:20:14[diff] [blame]140// calling thread for up to two seconds.
141BASE_EXPORT void EnsureProcessTerminated(Process process);
142
Dave Tapuska31c385c2024-04-12 18:43:11[diff] [blame]143// These are only sparingly used, and not needed on Fuchsia or iOS. They could
144// be implemented if necessary.
145#if !BUILDFLAG(IS_FUCHSIA) && !BUILDFLAG(IS_IOS)
[email protected]307af212013-07-10 18:36:09[diff] [blame]146// Wait for all the processes based on the named executable to exit. If filter
147// is non-null, then only processes selected by the filter are waited on.
148// Returns after all processes have exited or wait_milliseconds have expired.
149// Returns true if all the processes exited, false otherwise.
150BASE_EXPORT bool WaitForProcessesToExit(
151 const FilePath::StringType& executable_name,
152 base::TimeDelta wait,
153 const ProcessFilter* filter);
154
[email protected]307af212013-07-10 18:36:09[diff] [blame]155// Waits a certain amount of time (can be 0) for all the processes with a given
156// executable name to exit, then kills off any of them that are still around.
157// If filter is non-null, then only processes selected by the filter are waited
158// on. Killed processes are ended with the given exit code. Returns false if
159// any processes needed to be killed, true if they all exited cleanly within
160// the wait_milliseconds delay.
161BASE_EXPORT bool CleanupProcesses(const FilePath::StringType& executable_name,
162 base::TimeDelta wait,
163 int exit_code,
164 const ProcessFilter* filter);
Dave Tapuska31c385c2024-04-12 18:43:11[diff] [blame]165#endif // !BUILDFLAG(IS_FUCHSIA) && !BUILDFLAG(IS_IOS)
166
167#if BUILDFLAG(IS_MAC) || (BUILDFLAG(IS_IOS) && TARGET_OS_SIMULATOR)
168// This is common code used by kill_ios.cc when building with iOS simulator it
169// does not need to be exported.
170void WaitForChildToDie(pid_t child, int timeout_seconds);
171#endif // BUILDFLAG(IS_MAC) || (BUILDFLAG(IS_IOS) && TARGET_OS_SIMULATOR)
[email protected]307af212013-07-10 18:36:09[diff] [blame]172
[email protected]307af212013-07-10 18:36:09[diff] [blame]173} // namespace base
174
175#endif // BASE_PROCESS_KILL_H_