Skip to content

Commit 03b3bdb

Browse files
dschodscho
committed
Merge pull request #1170 from dscho/mingw-kill-process
Handle Ctrl+C in Git Bash nicely
2 parents 0fa0411 + e9b966d commit 03b3bdb

File tree

2 files changed

+230
-8
lines changed

2 files changed

+230
-8
lines changed

‎compat/mingw.c

+66-8
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
#include "../strbuf.h"
77
#include "../run-command.h"
88
#include "../cache.h"
9+
#include "win32/exit-process.h"
910

1011
#define HCAST(type, handle) ((type)(intptr_t)handle)
1112

@@ -1458,10 +1459,44 @@ struct pinfo_t {
14581459
static struct pinfo_t *pinfo = NULL;
14591460
CRITICAL_SECTION pinfo_cs;
14601461

1462+
#ifndef SIGRTMAX
1463+
#define SIGRTMAX 63
1464+
#endif
1465+
1466+
static void kill_child_processes_on_signal(void)
1467+
{
1468+
DWORD status;
1469+
1470+
/*
1471+
* Only continue if the process was terminated by a signal, as
1472+
* indicated by the exit status (128 + sig_no).
1473+
*
1474+
* As we are running in an atexit() handler, the exit code has been
1475+
* set at this stage by the ExitProcess() function already.
1476+
*/
1477+
if (!GetExitCodeProcess(GetCurrentProcess(), &status) ||
1478+
status <= 128 || status > 128 + SIGRTMAX)
1479+
return;
1480+
1481+
EnterCriticalSection(&pinfo_cs);
1482+
1483+
while (pinfo) {
1484+
struct pinfo_t *info = pinfo;
1485+
pinfo = pinfo->next;
1486+
if (exit_process(info->proc, status))
1487+
/* the handle is still valid in case of error */
1488+
CloseHandle(info->proc);
1489+
free(info);
1490+
}
1491+
1492+
LeaveCriticalSection(&pinfo_cs);
1493+
}
1494+
14611495
static pid_t mingw_spawnve_fd(const char *cmd, const char **argv, char **deltaenv,
14621496
const char *dir,
14631497
int prepend_cmd, int fhin, int fhout, int fherr)
14641498
{
1499+
static int atexit_handler_initialized;
14651500
STARTUPINFOW si;
14661501
PROCESS_INFORMATION pi;
14671502
struct strbuf args;
@@ -1471,6 +1506,17 @@ static pid_t mingw_spawnve_fd(const char *cmd, const char **argv, char **deltaen
14711506
HANDLE cons;
14721507
const char *strace_env;
14731508

1509+
if (!atexit_handler_initialized) {
1510+
atexit_handler_initialized = 1;
1511+
/*
1512+
* On Windows, there is no POSIX signaling. Instead, we inject
1513+
* a thread calling ExitProcess(128 + sig_no); and that calls
1514+
* the *atexit* handlers. Catch this condition and kill child
1515+
* processes with the same signal.
1516+
*/
1517+
atexit(kill_child_processes_on_signal);
1518+
}
1519+
14741520
do_unset_environment_variables();
14751521

14761522
/* Determine whether or not we are associated to a console */
@@ -1705,16 +1751,28 @@ int mingw_execvp(const char *cmd, char *const *argv)
17051751
int mingw_kill(pid_t pid, int sig)
17061752
{
17071753
if (pid > 0 && sig == SIGTERM) {
1708-
HANDLE h = OpenProcess(PROCESS_TERMINATE, FALSE, pid);
1709-
1710-
if (TerminateProcess(h, -1)) {
1754+
HANDLE h = OpenProcess(PROCESS_CREATE_THREAD |
1755+
PROCESS_QUERY_INFORMATION |
1756+
PROCESS_VM_OPERATION | PROCESS_VM_WRITE |
1757+
PROCESS_VM_READ | PROCESS_TERMINATE,
1758+
FALSE, pid);
1759+
int ret;
1760+
1761+
if (h)
1762+
ret = exit_process(h, 128 + sig);
1763+
else {
1764+
h = OpenProcess(PROCESS_TERMINATE, FALSE, pid);
1765+
if (!h) {
1766+
errno = err_win_to_posix(GetLastError());
1767+
return -1;
1768+
}
1769+
ret = terminate_process_tree(h, 128 + sig);
1770+
}
1771+
if (ret) {
1772+
errno = err_win_to_posix(GetLastError());
17111773
CloseHandle(h);
1712-
return 0;
17131774
}
1714-
1715-
errno = err_win_to_posix(GetLastError());
1716-
CloseHandle(h);
1717-
return -1;
1775+
return ret;
17181776
} else if (pid > 0 && sig == 0) {
17191777
HANDLE h = OpenProcess(PROCESS_QUERY_INFORMATION, FALSE, pid);
17201778
if (h) {

‎compat/win32/exit-process.h

+164
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,164 @@
1+
#ifndef EXIT_PROCESS_H
2+
#define EXIT_PROCESS_H
3+
4+
/*
5+
* This file contains functions to terminate a Win32 process, as gently as
6+
* possible.
7+
*
8+
* At first, we will attempt to inject a thread that calls ExitProcess(). If
9+
* that fails, we will fall back to terminating the entire process tree.
10+
*
11+
* For simplicity, these functions are marked as file-local.
12+
*/
13+
14+
#include <tlhelp32.h>
15+
16+
/*
17+
* Terminates the process corresponding to the process ID and all of its
18+
* directly and indirectly spawned subprocesses.
19+
*
20+
* This way of terminating the processes is not gentle: the processes get
21+
* no chance of cleaning up after themselves (closing file handles, removing
22+
* .lock files, terminating spawned processes (if any), etc).
23+
*/
24+
static int terminate_process_tree(HANDLE main_process, int exit_status)
25+
{
26+
HANDLE snapshot = CreateToolhelp32Snapshot(TH32CS_SNAPPROCESS, 0);
27+
PROCESSENTRY32 entry;
28+
DWORD pids[16384];
29+
int max_len = sizeof(pids) / sizeof(*pids), i, len, ret = 0;
30+
pid_t pid = GetProcessId(main_process);
31+
32+
pids[0] = (DWORD)pid;
33+
len = 1;
34+
35+
/*
36+
* Even if Process32First()/Process32Next() seem to traverse the
37+
* processes in topological order (i.e. parent processes before
38+
* child processes), there is nothing in the Win32 API documentation
39+
* suggesting that this is guaranteed.
40+
*
41+
* Therefore, run through them at least twice and stop when no more
42+
* process IDs were added to the list.
43+
*/
44+
for (;;) {
45+
int orig_len = len;
46+
47+
memset(&entry, 0, sizeof(entry));
48+
entry.dwSize = sizeof(entry);
49+
50+
if (!Process32First(snapshot, &entry))
51+
break;
52+
53+
do {
54+
for (i = len - 1; i >= 0; i--) {
55+
if (pids[i] == entry.th32ProcessID)
56+
break;
57+
if (pids[i] == entry.th32ParentProcessID)
58+
pids[len++] = entry.th32ProcessID;
59+
}
60+
} while (len < max_len && Process32Next(snapshot, &entry));
61+
62+
if (orig_len == len || len >= max_len)
63+
break;
64+
}
65+
66+
for (i = len - 1; i > 0; i--) {
67+
HANDLE process = OpenProcess(PROCESS_TERMINATE, FALSE, pids[i]);
68+
69+
if (process) {
70+
if (!TerminateProcess(process, exit_status))
71+
ret = -1;
72+
CloseHandle(process);
73+
}
74+
}
75+
if (!TerminateProcess(main_process, exit_status))
76+
ret = -1;
77+
CloseHandle(main_process);
78+
79+
return ret;
80+
}
81+
82+
/**
83+
* Determine whether a process runs in the same architecture as the current
84+
* one. That test is required before we assume that GetProcAddress() returns
85+
* a valid address *for the target process*.
86+
*/
87+
static inline int process_architecture_matches_current(HANDLE process)
88+
{
89+
static BOOL current_is_wow = -1;
90+
BOOL is_wow;
91+
92+
if (current_is_wow == -1 &&
93+
!IsWow64Process (GetCurrentProcess(), &current_is_wow))
94+
current_is_wow = -2;
95+
if (current_is_wow == -2)
96+
return 0; /* could not determine current process' WoW-ness */
97+
if (!IsWow64Process (process, &is_wow))
98+
return 0; /* cannot determine */
99+
return is_wow == current_is_wow;
100+
}
101+
102+
/**
103+
* Inject a thread into the given process that runs ExitProcess().
104+
*
105+
* Note: as kernel32.dll is loaded before any process, the other process and
106+
* this process will have ExitProcess() at the same address.
107+
*
108+
* This function expects the process handle to have the access rights for
109+
* CreateRemoteThread(): PROCESS_CREATE_THREAD, PROCESS_QUERY_INFORMATION,
110+
* PROCESS_VM_OPERATION, PROCESS_VM_WRITE, and PROCESS_VM_READ.
111+
*
112+
* The idea comes from the Dr Dobb's article "A Safer Alternative to
113+
* TerminateProcess()" by Andrew Tucker (July 1, 1999),
114+
* http://www.drdobbs.com/a-safer-alternative-to-terminateprocess/184416547
115+
*
116+
* If this method fails, we fall back to running terminate_process_tree().
117+
*/
118+
static int exit_process(HANDLE process, int exit_code)
119+
{
120+
DWORD code;
121+
122+
if (GetExitCodeProcess(process, &code) && code == STILL_ACTIVE) {
123+
static int initialized;
124+
static LPTHREAD_START_ROUTINE exit_process_address;
125+
PVOID arg = (PVOID)(intptr_t)exit_code;
126+
DWORD thread_id;
127+
HANDLE thread = NULL;
128+
129+
if (!initialized) {
130+
HINSTANCE kernel32 = GetModuleHandle("kernel32");
131+
if (!kernel32)
132+
die("BUG: cannot find kernel32");
133+
exit_process_address = (LPTHREAD_START_ROUTINE)
134+
GetProcAddress(kernel32, "ExitProcess");
135+
initialized = 1;
136+
}
137+
if (!exit_process_address ||
138+
!process_architecture_matches_current(process))
139+
return terminate_process_tree(process, exit_code);
140+
141+
thread = CreateRemoteThread(process, NULL, 0,
142+
exit_process_address,
143+
arg, 0, &thread_id);
144+
if (thread) {
145+
CloseHandle(thread);
146+
/*
147+
* If the process survives for 10 seconds (a completely
148+
* arbitrary value picked from thin air), fall back to
149+
* killing the process tree via TerminateProcess().
150+
*/
151+
if (WaitForSingleObject(process, 10000) ==
152+
WAIT_OBJECT_0) {
153+
CloseHandle(process);
154+
return 0;
155+
}
156+
}
157+
158+
return terminate_process_tree(process, exit_code);
159+
}
160+
161+
return 0;
162+
}
163+
164+
#endif

0 commit comments

Comments
 (0)