bpo-40826: Fix GIL usage in PyOS_Readline() (GH-20579)

Fix GIL usage in PyOS_Readline(): lock the GIL to set an exception.

Pass tstate to my_fgets() and _PyOS_WindowsConsoleReadline(). Cleanup
these functions.
This commit is contained in:
Victor Stinner 2020-06-01 20:59:35 +02:00 committed by GitHub
parent b4d5a5cca2
commit c353764fd5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 73 additions and 29 deletions

View File

@ -0,0 +1 @@
Fix GIL usage in :c:func:`PyOS_Readline`: lock the GIL to set an exception.

View File

@ -27,22 +27,24 @@ int (*PyOS_InputHook)(void) = NULL;
except if PyOS_InterruptOccurred() returns true. */ except if PyOS_InterruptOccurred() returns true. */
static int static int
my_fgets(char *buf, int len, FILE *fp) my_fgets(PyThreadState* tstate, char *buf, int len, FILE *fp)
{ {
#ifdef MS_WINDOWS #ifdef MS_WINDOWS
HANDLE hInterruptEvent; HANDLE hInterruptEvent;
#endif #endif
char *p;
int err;
while (1) { while (1) {
if (PyOS_InputHook != NULL) if (PyOS_InputHook != NULL) {
(void)(PyOS_InputHook)(); (void)(PyOS_InputHook)();
}
errno = 0; errno = 0;
clearerr(fp); clearerr(fp);
p = fgets(buf, len, fp); char *p = fgets(buf, len, fp);
if (p != NULL) if (p != NULL) {
return 0; /* No error */ return 0; /* No error */
err = errno; }
int err = errno;
#ifdef MS_WINDOWS #ifdef MS_WINDOWS
/* Ctrl-C anywhere on the line or Ctrl-Z if the only character /* Ctrl-C anywhere on the line or Ctrl-Z if the only character
on a line will set ERROR_OPERATION_ABORTED. Under normal on a line will set ERROR_OPERATION_ABORTED. Under normal
@ -68,22 +70,26 @@ my_fgets(char *buf, int len, FILE *fp)
} }
} }
#endif /* MS_WINDOWS */ #endif /* MS_WINDOWS */
if (feof(fp)) { if (feof(fp)) {
clearerr(fp); clearerr(fp);
return -1; /* EOF */ return -1; /* EOF */
} }
#ifdef EINTR #ifdef EINTR
if (err == EINTR) { if (err == EINTR) {
int s; PyEval_RestoreThread(tstate);
PyEval_RestoreThread(_PyOS_ReadlineTState); int s = PyErr_CheckSignals();
s = PyErr_CheckSignals();
PyEval_SaveThread(); PyEval_SaveThread();
if (s < 0)
return 1; if (s < 0) {
/* try again */ return 1;
}
/* try again */
continue; continue;
} }
#endif #endif
if (PyOS_InterruptOccurred()) { if (PyOS_InterruptOccurred()) {
return 1; /* Interrupt */ return 1; /* Interrupt */
} }
@ -98,7 +104,7 @@ my_fgets(char *buf, int len, FILE *fp)
extern char _get_console_type(HANDLE handle); extern char _get_console_type(HANDLE handle);
char * char *
_PyOS_WindowsConsoleReadline(HANDLE hStdIn) _PyOS_WindowsConsoleReadline(PyThreadState *tstate, HANDLE hStdIn)
{ {
static wchar_t wbuf_local[1024 * 16]; static wchar_t wbuf_local[1024 * 16];
const DWORD chunk_size = 1024; const DWORD chunk_size = 1024;
@ -133,11 +139,12 @@ _PyOS_WindowsConsoleReadline(HANDLE hStdIn)
if (WaitForSingleObjectEx(hInterruptEvent, 100, FALSE) if (WaitForSingleObjectEx(hInterruptEvent, 100, FALSE)
== WAIT_OBJECT_0) { == WAIT_OBJECT_0) {
ResetEvent(hInterruptEvent); ResetEvent(hInterruptEvent);
PyEval_RestoreThread(_PyOS_ReadlineTState); PyEval_RestoreThread(tstate);
s = PyErr_CheckSignals(); s = PyErr_CheckSignals();
PyEval_SaveThread(); PyEval_SaveThread();
if (s < 0) if (s < 0) {
goto exit; goto exit;
}
} }
break; break;
} }
@ -150,17 +157,22 @@ _PyOS_WindowsConsoleReadline(HANDLE hStdIn)
if (wbuf == wbuf_local) { if (wbuf == wbuf_local) {
wbuf[total_read] = '\0'; wbuf[total_read] = '\0';
wbuf = (wchar_t*)PyMem_RawMalloc(wbuflen * sizeof(wchar_t)); wbuf = (wchar_t*)PyMem_RawMalloc(wbuflen * sizeof(wchar_t));
if (wbuf) if (wbuf) {
wcscpy_s(wbuf, wbuflen, wbuf_local); wcscpy_s(wbuf, wbuflen, wbuf_local);
}
else { else {
PyEval_RestoreThread(tstate);
PyErr_NoMemory(); PyErr_NoMemory();
PyEval_SaveThread();
goto exit; goto exit;
} }
} }
else { else {
wchar_t *tmp = PyMem_RawRealloc(wbuf, wbuflen * sizeof(wchar_t)); wchar_t *tmp = PyMem_RawRealloc(wbuf, wbuflen * sizeof(wchar_t));
if (tmp == NULL) { if (tmp == NULL) {
PyEval_RestoreThread(tstate);
PyErr_NoMemory(); PyErr_NoMemory();
PyEval_SaveThread();
goto exit; goto exit;
} }
wbuf = tmp; wbuf = tmp;
@ -169,33 +181,45 @@ _PyOS_WindowsConsoleReadline(HANDLE hStdIn)
if (wbuf[0] == '\x1a') { if (wbuf[0] == '\x1a') {
buf = PyMem_RawMalloc(1); buf = PyMem_RawMalloc(1);
if (buf) if (buf) {
buf[0] = '\0'; buf[0] = '\0';
}
else { else {
PyEval_RestoreThread(tstate);
PyErr_NoMemory(); PyErr_NoMemory();
PyEval_SaveThread();
} }
goto exit; goto exit;
} }
u8len = WideCharToMultiByte(CP_UTF8, 0, wbuf, total_read, NULL, 0, NULL, NULL); u8len = WideCharToMultiByte(CP_UTF8, 0,
wbuf, total_read,
NULL, 0,
NULL, NULL);
buf = PyMem_RawMalloc(u8len + 1); buf = PyMem_RawMalloc(u8len + 1);
if (buf == NULL) { if (buf == NULL) {
PyEval_RestoreThread(tstate);
PyErr_NoMemory(); PyErr_NoMemory();
PyEval_SaveThread();
goto exit; goto exit;
} }
u8len = WideCharToMultiByte(CP_UTF8, 0, wbuf, total_read, buf, u8len, NULL, NULL);
u8len = WideCharToMultiByte(CP_UTF8, 0,
wbuf, total_read,
buf, u8len,
NULL, NULL);
buf[u8len] = '\0'; buf[u8len] = '\0';
exit: exit:
if (wbuf != wbuf_local) if (wbuf != wbuf_local) {
PyMem_RawFree(wbuf); PyMem_RawFree(wbuf);
}
if (err) { if (err) {
PyEval_RestoreThread(_PyOS_ReadlineTState); PyEval_RestoreThread(tstate);
PyErr_SetFromWindowsErr(err); PyErr_SetFromWindowsErr(err);
PyEval_SaveThread(); PyEval_SaveThread();
} }
return buf; return buf;
} }
@ -209,6 +233,8 @@ PyOS_StdioReadline(FILE *sys_stdin, FILE *sys_stdout, const char *prompt)
{ {
size_t n; size_t n;
char *p, *pr; char *p, *pr;
PyThreadState *tstate = _PyOS_ReadlineTState;
assert(tstate != NULL);
#ifdef MS_WINDOWS #ifdef MS_WINDOWS
if (!Py_LegacyWindowsStdioFlag && sys_stdin == stdin) { if (!Py_LegacyWindowsStdioFlag && sys_stdin == stdin) {
@ -230,7 +256,9 @@ PyOS_StdioReadline(FILE *sys_stdin, FILE *sys_stdout, const char *prompt)
if (wlen) { if (wlen) {
wbuf = PyMem_RawMalloc(wlen * sizeof(wchar_t)); wbuf = PyMem_RawMalloc(wlen * sizeof(wchar_t));
if (wbuf == NULL) { if (wbuf == NULL) {
PyEval_RestoreThread(tstate);
PyErr_NoMemory(); PyErr_NoMemory();
PyEval_SaveThread();
return NULL; return NULL;
} }
wlen = MultiByteToWideChar(CP_UTF8, 0, prompt, -1, wlen = MultiByteToWideChar(CP_UTF8, 0, prompt, -1,
@ -249,7 +277,7 @@ PyOS_StdioReadline(FILE *sys_stdin, FILE *sys_stdout, const char *prompt)
} }
} }
clearerr(sys_stdin); clearerr(sys_stdin);
return _PyOS_WindowsConsoleReadline(hStdIn); return _PyOS_WindowsConsoleReadline(tstate, hStdIn);
} }
} }
#endif #endif
@ -257,16 +285,19 @@ PyOS_StdioReadline(FILE *sys_stdin, FILE *sys_stdout, const char *prompt)
n = 100; n = 100;
p = (char *)PyMem_RawMalloc(n); p = (char *)PyMem_RawMalloc(n);
if (p == NULL) { if (p == NULL) {
PyEval_RestoreThread(tstate);
PyErr_NoMemory(); PyErr_NoMemory();
PyEval_SaveThread();
return NULL; return NULL;
} }
fflush(sys_stdout); fflush(sys_stdout);
if (prompt) if (prompt) {
fprintf(stderr, "%s", prompt); fprintf(stderr, "%s", prompt);
}
fflush(stderr); fflush(stderr);
switch (my_fgets(p, (int)n, sys_stdin)) { switch (my_fgets(tstate, p, (int)n, sys_stdin)) {
case 0: /* Normal case */ case 0: /* Normal case */
break; break;
case 1: /* Interrupt */ case 1: /* Interrupt */
@ -278,29 +309,40 @@ PyOS_StdioReadline(FILE *sys_stdin, FILE *sys_stdout, const char *prompt)
*p = '\0'; *p = '\0';
break; break;
} }
n = strlen(p); n = strlen(p);
while (n > 0 && p[n-1] != '\n') { while (n > 0 && p[n-1] != '\n') {
size_t incr = n+2; size_t incr = n+2;
if (incr > INT_MAX) { if (incr > INT_MAX) {
PyMem_RawFree(p); PyMem_RawFree(p);
PyEval_RestoreThread(tstate);
PyErr_SetString(PyExc_OverflowError, "input line too long"); PyErr_SetString(PyExc_OverflowError, "input line too long");
PyEval_SaveThread();
return NULL; return NULL;
} }
pr = (char *)PyMem_RawRealloc(p, n + incr); pr = (char *)PyMem_RawRealloc(p, n + incr);
if (pr == NULL) { if (pr == NULL) {
PyMem_RawFree(p); PyMem_RawFree(p);
PyEval_RestoreThread(tstate);
PyErr_NoMemory(); PyErr_NoMemory();
PyEval_SaveThread();
return NULL; return NULL;
} }
p = pr; p = pr;
if (my_fgets(p+n, (int)incr, sys_stdin) != 0)
if (my_fgets(tstate, p+n, (int)incr, sys_stdin) != 0) {
break; break;
}
n += strlen(p+n); n += strlen(p+n);
} }
pr = (char *)PyMem_RawRealloc(p, n+1); pr = (char *)PyMem_RawRealloc(p, n+1);
if (pr == NULL) { if (pr == NULL) {
PyMem_RawFree(p); PyMem_RawFree(p);
PyEval_RestoreThread(tstate);
PyErr_NoMemory(); PyErr_NoMemory();
PyEval_SaveThread();
return NULL; return NULL;
} }
return pr; return pr;
@ -323,7 +365,8 @@ PyOS_Readline(FILE *sys_stdin, FILE *sys_stdout, const char *prompt)
char *rv, *res; char *rv, *res;
size_t len; size_t len;
if (_PyOS_ReadlineTState == _PyThreadState_GET()) { PyThreadState *tstate = _PyThreadState_GET();
if (_PyOS_ReadlineTState == tstate) {
PyErr_SetString(PyExc_RuntimeError, PyErr_SetString(PyExc_RuntimeError,
"can't re-enter readline"); "can't re-enter readline");
return NULL; return NULL;
@ -342,7 +385,7 @@ PyOS_Readline(FILE *sys_stdin, FILE *sys_stdout, const char *prompt)
} }
} }
_PyOS_ReadlineTState = _PyThreadState_GET(); _PyOS_ReadlineTState = tstate;
Py_BEGIN_ALLOW_THREADS Py_BEGIN_ALLOW_THREADS
PyThread_acquire_lock(_PyOS_ReadlineLock, 1); PyThread_acquire_lock(_PyOS_ReadlineLock, 1);