blob: 93c093f89b4b376c3fa1b62b59804c155a7f2a2f [file] [log] [blame]
Victor Stinner4e314432010-10-07 21:45:39 +00001#include "Python.h"
Victor Stinner9fc57a32018-11-07 00:44:03 +01002#include "pycore_fileutils.h"
Stefan Krah6df5cae2012-11-12 20:14:36 +01003#include "osdefs.h"
Stefan Krah6c01e382014-01-20 15:31:08 +01004#include <locale.h>
5
Victor Stinnerb306d752010-10-07 22:09:40 +00006#ifdef MS_WINDOWS
Steve Dowerd81431f2015-03-06 14:47:02 -08007# include <malloc.h>
Victor Stinnerb306d752010-10-07 22:09:40 +00008# include <windows.h>
Steve Dower8fc89802015-04-12 00:26:27 -04009extern int winerror_to_errno(int);
Victor Stinnerb306d752010-10-07 22:09:40 +000010#endif
Victor Stinner4e314432010-10-07 21:45:39 +000011
Brett Cannonefb00c02012-02-29 18:31:31 -050012#ifdef HAVE_LANGINFO_H
13#include <langinfo.h>
14#endif
15
Victor Stinnerdaf45552013-08-28 00:53:59 +020016#ifdef HAVE_SYS_IOCTL_H
17#include <sys/ioctl.h>
18#endif
19
20#ifdef HAVE_FCNTL_H
21#include <fcntl.h>
22#endif /* HAVE_FCNTL_H */
23
Victor Stinnerdaf45552013-08-28 00:53:59 +020024#ifdef O_CLOEXEC
Victor Stinnerb034eee2013-09-07 10:36:04 +020025/* Does open() support the O_CLOEXEC flag? Possible values:
Victor Stinnerdaf45552013-08-28 00:53:59 +020026
27 -1: unknown
28 0: open() ignores O_CLOEXEC flag, ex: Linux kernel older than 2.6.23
29 1: open() supports O_CLOEXEC flag, close-on-exec is set
30
Victor Stinnera555cfc2015-03-18 00:22:14 +010031 The flag is used by _Py_open(), _Py_open_noraise(), io.FileIO
32 and os.open(). */
Victor Stinnerdaf45552013-08-28 00:53:59 +020033int _Py_open_cloexec_works = -1;
34#endif
35
Victor Stinner3d4226a2018-08-29 22:21:32 +020036
37static int
38get_surrogateescape(_Py_error_handler errors, int *surrogateescape)
39{
40 switch (errors)
41 {
42 case _Py_ERROR_STRICT:
43 *surrogateescape = 0;
44 return 0;
45 case _Py_ERROR_SURROGATEESCAPE:
46 *surrogateescape = 1;
47 return 0;
48 default:
49 return -1;
50 }
51}
52
53
Brett Cannonefb00c02012-02-29 18:31:31 -050054PyObject *
55_Py_device_encoding(int fd)
56{
Victor Stinner14b9b112013-06-25 00:37:25 +020057#if defined(MS_WINDOWS)
Brett Cannonefb00c02012-02-29 18:31:31 -050058 UINT cp;
59#endif
Steve Dower8fc89802015-04-12 00:26:27 -040060 int valid;
61 _Py_BEGIN_SUPPRESS_IPH
Steve Dower940f33a2016-09-08 11:21:54 -070062 valid = isatty(fd);
Steve Dower8fc89802015-04-12 00:26:27 -040063 _Py_END_SUPPRESS_IPH
64 if (!valid)
Brett Cannonefb00c02012-02-29 18:31:31 -050065 Py_RETURN_NONE;
Steve Dower8fc89802015-04-12 00:26:27 -040066
Victor Stinner14b9b112013-06-25 00:37:25 +020067#if defined(MS_WINDOWS)
Brett Cannonefb00c02012-02-29 18:31:31 -050068 if (fd == 0)
69 cp = GetConsoleCP();
70 else if (fd == 1 || fd == 2)
71 cp = GetConsoleOutputCP();
72 else
73 cp = 0;
74 /* GetConsoleCP() and GetConsoleOutputCP() return 0 if the application
75 has no console */
76 if (cp != 0)
77 return PyUnicode_FromFormat("cp%u", (unsigned int)cp);
78#elif defined(CODESET)
79 {
80 char *codeset = nl_langinfo(CODESET);
81 if (codeset != NULL && codeset[0] != 0)
82 return PyUnicode_FromString(codeset);
83 }
84#endif
85 Py_RETURN_NONE;
86}
87
Victor Stinnere2510952019-05-02 11:28:57 -040088#if !defined(_Py_FORCE_UTF8_FS_ENCODING) && !defined(MS_WINDOWS)
Victor Stinner7ed7aea2018-01-15 10:45:49 +010089
90#define USE_FORCE_ASCII
91
Victor Stinnerd45c7f82012-12-04 01:34:47 +010092extern int _Py_normalize_encoding(const char *, char *, size_t);
93
Victor Stinnerd500e532018-08-28 17:27:36 +020094/* Workaround FreeBSD and OpenIndiana locale encoding issue with the C locale
95 and POSIX locale. nl_langinfo(CODESET) announces an alias of the
Victor Stinnerd45c7f82012-12-04 01:34:47 +010096 ASCII encoding, whereas mbstowcs() and wcstombs() functions use the
97 ISO-8859-1 encoding. The problem is that os.fsencode() and os.fsdecode() use
98 locale.getpreferredencoding() codec. For example, if command line arguments
99 are decoded by mbstowcs() and encoded back by os.fsencode(), we get a
100 UnicodeEncodeError instead of retrieving the original byte string.
101
102 The workaround is enabled if setlocale(LC_CTYPE, NULL) returns "C",
103 nl_langinfo(CODESET) announces "ascii" (or an alias to ASCII), and at least
104 one byte in range 0x80-0xff can be decoded from the locale encoding. The
105 workaround is also enabled on error, for example if getting the locale
106 failed.
107
Victor Stinnerd500e532018-08-28 17:27:36 +0200108 On HP-UX with the C locale or the POSIX locale, nl_langinfo(CODESET)
109 announces "roman8" but mbstowcs() uses Latin1 in practice. Force also the
110 ASCII encoding in this case.
111
Philip Jenvey215c49a2013-01-15 13:24:12 -0800112 Values of force_ascii:
Victor Stinnerd45c7f82012-12-04 01:34:47 +0100113
Victor Stinnerf6a271a2014-08-01 12:28:48 +0200114 1: the workaround is used: Py_EncodeLocale() uses
115 encode_ascii_surrogateescape() and Py_DecodeLocale() uses
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100116 decode_ascii()
Victor Stinnerf6a271a2014-08-01 12:28:48 +0200117 0: the workaround is not used: Py_EncodeLocale() uses wcstombs() and
118 Py_DecodeLocale() uses mbstowcs()
Victor Stinnerd45c7f82012-12-04 01:34:47 +0100119 -1: unknown, need to call check_force_ascii() to get the value
120*/
121static int force_ascii = -1;
122
123static int
124check_force_ascii(void)
125{
Victor Stinnerd500e532018-08-28 17:27:36 +0200126 char *loc = setlocale(LC_CTYPE, NULL);
127 if (loc == NULL) {
128 goto error;
129 }
130 if (strcmp(loc, "C") != 0 && strcmp(loc, "POSIX") != 0) {
131 /* the LC_CTYPE locale is different than C and POSIX */
132 return 0;
133 }
134
Victor Stinnerd45c7f82012-12-04 01:34:47 +0100135#if defined(HAVE_LANGINFO_H) && defined(CODESET)
Victor Stinnerd500e532018-08-28 17:27:36 +0200136 const char *codeset = nl_langinfo(CODESET);
137 if (!codeset || codeset[0] == '\0') {
138 /* CODESET is not set or empty */
139 goto error;
140 }
141
Victor Stinner54de2b12016-09-09 23:11:52 -0700142 char encoding[20]; /* longest name: "iso_646.irv_1991\0" */
Victor Stinnerd500e532018-08-28 17:27:36 +0200143 if (!_Py_normalize_encoding(codeset, encoding, sizeof(encoding))) {
144 goto error;
145 }
146
147#ifdef __hpux
148 if (strcmp(encoding, "roman8") == 0) {
149 unsigned char ch;
150 wchar_t wch;
151 size_t res;
152
153 ch = (unsigned char)0xA7;
154 res = mbstowcs(&wch, (char*)&ch, 1);
155 if (res != (size_t)-1 && wch == L'\xA7') {
156 /* On HP-UX withe C locale or the POSIX locale,
157 nl_langinfo(CODESET) announces "roman8", whereas mbstowcs() uses
158 Latin1 encoding in practice. Force ASCII in this case.
159
160 Roman8 decodes 0xA7 to U+00CF. Latin1 decodes 0xA7 to U+00A7. */
161 return 1;
162 }
163 }
164#else
165 const char* ascii_aliases[] = {
Victor Stinnerd45c7f82012-12-04 01:34:47 +0100166 "ascii",
Victor Stinner54de2b12016-09-09 23:11:52 -0700167 /* Aliases from Lib/encodings/aliases.py */
Victor Stinnerd45c7f82012-12-04 01:34:47 +0100168 "646",
Victor Stinner54de2b12016-09-09 23:11:52 -0700169 "ansi_x3.4_1968",
170 "ansi_x3.4_1986",
171 "ansi_x3_4_1968",
Victor Stinnerd45c7f82012-12-04 01:34:47 +0100172 "cp367",
173 "csascii",
174 "ibm367",
Victor Stinner54de2b12016-09-09 23:11:52 -0700175 "iso646_us",
176 "iso_646.irv_1991",
177 "iso_ir_6",
Victor Stinnerd45c7f82012-12-04 01:34:47 +0100178 "us",
Victor Stinner54de2b12016-09-09 23:11:52 -0700179 "us_ascii",
Victor Stinnerd45c7f82012-12-04 01:34:47 +0100180 NULL
181 };
Victor Stinnerd45c7f82012-12-04 01:34:47 +0100182
Victor Stinnerd500e532018-08-28 17:27:36 +0200183 int is_ascii = 0;
184 for (const char **alias=ascii_aliases; *alias != NULL; alias++) {
Victor Stinnerd45c7f82012-12-04 01:34:47 +0100185 if (strcmp(encoding, *alias) == 0) {
186 is_ascii = 1;
187 break;
188 }
189 }
190 if (!is_ascii) {
191 /* nl_langinfo(CODESET) is not "ascii" or an alias of ASCII */
192 return 0;
193 }
194
Victor Stinnerd500e532018-08-28 17:27:36 +0200195 for (unsigned int i=0x80; i<=0xff; i++) {
196 char ch[1];
197 wchar_t wch[1];
Victor Stinnerd45c7f82012-12-04 01:34:47 +0100198 size_t res;
199
Victor Stinnerd500e532018-08-28 17:27:36 +0200200 unsigned uch = (unsigned char)i;
201 ch[0] = (char)uch;
202 res = mbstowcs(wch, ch, 1);
Victor Stinnerd45c7f82012-12-04 01:34:47 +0100203 if (res != (size_t)-1) {
204 /* decoding a non-ASCII character from the locale encoding succeed:
205 the locale encoding is not ASCII, force ASCII */
206 return 1;
207 }
208 }
209 /* None of the bytes in the range 0x80-0xff can be decoded from the locale
210 encoding: the locale encoding is really ASCII */
Victor Stinnerd500e532018-08-28 17:27:36 +0200211#endif /* !defined(__hpux) */
Victor Stinnerd45c7f82012-12-04 01:34:47 +0100212 return 0;
213#else
214 /* nl_langinfo(CODESET) is not available: always force ASCII */
215 return 1;
Victor Stinnerd500e532018-08-28 17:27:36 +0200216#endif /* defined(HAVE_LANGINFO_H) && defined(CODESET) */
Victor Stinnerd45c7f82012-12-04 01:34:47 +0100217
218error:
Martin Panter46f50722016-05-26 05:35:26 +0000219 /* if an error occurred, force the ASCII encoding */
Victor Stinnerd45c7f82012-12-04 01:34:47 +0100220 return 1;
221}
222
Victor Stinnerd500e532018-08-28 17:27:36 +0200223
224int
225_Py_GetForceASCII(void)
226{
227 if (force_ascii == -1) {
228 force_ascii = check_force_ascii();
229 }
230 return force_ascii;
231}
232
233
Victor Stinner353933e2018-11-23 13:08:26 +0100234void
235_Py_ResetForceASCII(void)
236{
237 force_ascii = -1;
238}
239
240
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100241static int
242encode_ascii(const wchar_t *text, char **str,
243 size_t *error_pos, const char **reason,
Victor Stinner3d4226a2018-08-29 22:21:32 +0200244 int raw_malloc, _Py_error_handler errors)
Victor Stinnerd45c7f82012-12-04 01:34:47 +0100245{
246 char *result = NULL, *out;
247 size_t len, i;
248 wchar_t ch;
249
Victor Stinner3d4226a2018-08-29 22:21:32 +0200250 int surrogateescape;
251 if (get_surrogateescape(errors, &surrogateescape) < 0) {
252 return -3;
253 }
254
Victor Stinnerd45c7f82012-12-04 01:34:47 +0100255 len = wcslen(text);
256
Victor Stinner9bee3292017-12-21 16:49:13 +0100257 /* +1 for NULL byte */
Victor Stinner9dd76202017-12-21 16:20:32 +0100258 if (raw_malloc) {
259 result = PyMem_RawMalloc(len + 1);
260 }
261 else {
262 result = PyMem_Malloc(len + 1);
263 }
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100264 if (result == NULL) {
265 return -1;
266 }
Victor Stinnerd45c7f82012-12-04 01:34:47 +0100267
268 out = result;
269 for (i=0; i<len; i++) {
270 ch = text[i];
271
272 if (ch <= 0x7f) {
273 /* ASCII character */
274 *out++ = (char)ch;
275 }
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100276 else if (surrogateescape && 0xdc80 <= ch && ch <= 0xdcff) {
Victor Stinnerd45c7f82012-12-04 01:34:47 +0100277 /* UTF-8b surrogate */
278 *out++ = (char)(ch - 0xdc00);
279 }
280 else {
Victor Stinner9dd76202017-12-21 16:20:32 +0100281 if (raw_malloc) {
282 PyMem_RawFree(result);
283 }
284 else {
285 PyMem_Free(result);
286 }
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100287 if (error_pos != NULL) {
288 *error_pos = i;
289 }
290 if (reason) {
291 *reason = "encoding error";
292 }
293 return -2;
Victor Stinnerd45c7f82012-12-04 01:34:47 +0100294 }
295 }
296 *out = '\0';
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100297 *str = result;
298 return 0;
Victor Stinnerd45c7f82012-12-04 01:34:47 +0100299}
Victor Stinnerd500e532018-08-28 17:27:36 +0200300#else
301int
302_Py_GetForceASCII(void)
303{
304 return 0;
305}
Victor Stinner353933e2018-11-23 13:08:26 +0100306
307void
308_Py_ResetForceASCII(void)
309{
310 /* nothing to do */
311}
Victor Stinnere2510952019-05-02 11:28:57 -0400312#endif /* !defined(_Py_FORCE_UTF8_FS_ENCODING) && !defined(MS_WINDOWS) */
Victor Stinnerd45c7f82012-12-04 01:34:47 +0100313
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100314
315#if !defined(HAVE_MBRTOWC) || defined(USE_FORCE_ASCII)
316static int
317decode_ascii(const char *arg, wchar_t **wstr, size_t *wlen,
Victor Stinner3d4226a2018-08-29 22:21:32 +0200318 const char **reason, _Py_error_handler errors)
Victor Stinnerd45c7f82012-12-04 01:34:47 +0100319{
320 wchar_t *res;
321 unsigned char *in;
322 wchar_t *out;
Benjamin Petersonf18bf6f2015-01-04 16:03:17 -0600323 size_t argsize = strlen(arg) + 1;
Victor Stinnerd45c7f82012-12-04 01:34:47 +0100324
Victor Stinner3d4226a2018-08-29 22:21:32 +0200325 int surrogateescape;
326 if (get_surrogateescape(errors, &surrogateescape) < 0) {
327 return -3;
328 }
329
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100330 if (argsize > PY_SSIZE_T_MAX / sizeof(wchar_t)) {
331 return -1;
332 }
333 res = PyMem_RawMalloc(argsize * sizeof(wchar_t));
334 if (!res) {
335 return -1;
336 }
Victor Stinnerd45c7f82012-12-04 01:34:47 +0100337
Victor Stinnerd45c7f82012-12-04 01:34:47 +0100338 out = res;
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100339 for (in = (unsigned char*)arg; *in; in++) {
340 unsigned char ch = *in;
341 if (ch < 128) {
342 *out++ = ch;
343 }
344 else {
345 if (!surrogateescape) {
346 PyMem_RawFree(res);
347 if (wlen) {
348 *wlen = in - (unsigned char*)arg;
349 }
350 if (reason) {
351 *reason = "decoding error";
352 }
353 return -2;
354 }
355 *out++ = 0xdc00 + ch;
356 }
357 }
Victor Stinnerd45c7f82012-12-04 01:34:47 +0100358 *out = 0;
Victor Stinnerd45c7f82012-12-04 01:34:47 +0100359
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100360 if (wlen != NULL) {
361 *wlen = out - res;
362 }
363 *wstr = res;
364 return 0;
365}
366#endif /* !HAVE_MBRTOWC */
367
368static int
369decode_current_locale(const char* arg, wchar_t **wstr, size_t *wlen,
Victor Stinner3d4226a2018-08-29 22:21:32 +0200370 const char **reason, _Py_error_handler errors)
Victor Stinner4e314432010-10-07 21:45:39 +0000371{
372 wchar_t *res;
Victor Stinnerd45c7f82012-12-04 01:34:47 +0100373 size_t argsize;
Victor Stinner4e314432010-10-07 21:45:39 +0000374 size_t count;
Victor Stinner313f10c2013-05-07 23:48:56 +0200375#ifdef HAVE_MBRTOWC
Victor Stinner4e314432010-10-07 21:45:39 +0000376 unsigned char *in;
377 wchar_t *out;
Victor Stinner4e314432010-10-07 21:45:39 +0000378 mbstate_t mbs;
379#endif
Victor Stinnerd45c7f82012-12-04 01:34:47 +0100380
Victor Stinner3d4226a2018-08-29 22:21:32 +0200381 int surrogateescape;
382 if (get_surrogateescape(errors, &surrogateescape) < 0) {
383 return -3;
384 }
385
Victor Stinnerd45c7f82012-12-04 01:34:47 +0100386#ifdef HAVE_BROKEN_MBSTOWCS
387 /* Some platforms have a broken implementation of
388 * mbstowcs which does not count the characters that
389 * would result from conversion. Use an upper bound.
390 */
391 argsize = strlen(arg);
392#else
393 argsize = mbstowcs(NULL, arg, 0);
394#endif
Victor Stinner4e314432010-10-07 21:45:39 +0000395 if (argsize != (size_t)-1) {
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100396 if (argsize > PY_SSIZE_T_MAX / sizeof(wchar_t) - 1) {
397 return -1;
398 }
399 res = (wchar_t *)PyMem_RawMalloc((argsize + 1) * sizeof(wchar_t));
400 if (!res) {
401 return -1;
402 }
403
404 count = mbstowcs(res, arg, argsize + 1);
Victor Stinner4e314432010-10-07 21:45:39 +0000405 if (count != (size_t)-1) {
406 wchar_t *tmp;
407 /* Only use the result if it contains no
408 surrogate characters. */
409 for (tmp = res; *tmp != 0 &&
Victor Stinner76df43d2012-10-30 01:42:39 +0100410 !Py_UNICODE_IS_SURROGATE(*tmp); tmp++)
Victor Stinner4e314432010-10-07 21:45:39 +0000411 ;
Victor Stinner168e1172010-10-16 23:16:16 +0000412 if (*tmp == 0) {
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100413 if (wlen != NULL) {
414 *wlen = count;
415 }
416 *wstr = res;
417 return 0;
Victor Stinner168e1172010-10-16 23:16:16 +0000418 }
Victor Stinner4e314432010-10-07 21:45:39 +0000419 }
Victor Stinner1a7425f2013-07-07 16:25:15 +0200420 PyMem_RawFree(res);
Victor Stinner4e314432010-10-07 21:45:39 +0000421 }
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100422
Victor Stinner4e314432010-10-07 21:45:39 +0000423 /* Conversion failed. Fall back to escaping with surrogateescape. */
424#ifdef HAVE_MBRTOWC
425 /* Try conversion with mbrtwoc (C99), and escape non-decodable bytes. */
426
427 /* Overallocate; as multi-byte characters are in the argument, the
428 actual output could use less memory. */
429 argsize = strlen(arg) + 1;
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100430 if (argsize > PY_SSIZE_T_MAX / sizeof(wchar_t)) {
431 return -1;
432 }
433 res = (wchar_t*)PyMem_RawMalloc(argsize * sizeof(wchar_t));
434 if (!res) {
435 return -1;
436 }
437
Victor Stinner4e314432010-10-07 21:45:39 +0000438 in = (unsigned char*)arg;
439 out = res;
440 memset(&mbs, 0, sizeof mbs);
441 while (argsize) {
442 size_t converted = mbrtowc(out, (char*)in, argsize, &mbs);
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100443 if (converted == 0) {
Victor Stinner4e314432010-10-07 21:45:39 +0000444 /* Reached end of string; null char stored. */
445 break;
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100446 }
447
Victor Stinner4e314432010-10-07 21:45:39 +0000448 if (converted == (size_t)-2) {
449 /* Incomplete character. This should never happen,
450 since we provide everything that we have -
451 unless there is a bug in the C library, or I
452 misunderstood how mbrtowc works. */
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100453 goto decode_error;
Victor Stinner4e314432010-10-07 21:45:39 +0000454 }
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100455
Victor Stinner4e314432010-10-07 21:45:39 +0000456 if (converted == (size_t)-1) {
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100457 if (!surrogateescape) {
458 goto decode_error;
459 }
460
Victor Stinner4e314432010-10-07 21:45:39 +0000461 /* Conversion error. Escape as UTF-8b, and start over
462 in the initial shift state. */
463 *out++ = 0xdc00 + *in++;
464 argsize--;
465 memset(&mbs, 0, sizeof mbs);
466 continue;
467 }
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100468
Victor Stinner76df43d2012-10-30 01:42:39 +0100469 if (Py_UNICODE_IS_SURROGATE(*out)) {
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100470 if (!surrogateescape) {
471 goto decode_error;
472 }
473
Victor Stinner4e314432010-10-07 21:45:39 +0000474 /* Surrogate character. Escape the original
475 byte sequence with surrogateescape. */
476 argsize -= converted;
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100477 while (converted--) {
Victor Stinner4e314432010-10-07 21:45:39 +0000478 *out++ = 0xdc00 + *in++;
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100479 }
Victor Stinner4e314432010-10-07 21:45:39 +0000480 continue;
481 }
482 /* successfully converted some bytes */
483 in += converted;
484 argsize -= converted;
485 out++;
486 }
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100487 if (wlen != NULL) {
488 *wlen = out - res;
489 }
490 *wstr = res;
491 return 0;
492
493decode_error:
494 PyMem_RawFree(res);
495 if (wlen) {
496 *wlen = in - (unsigned char*)arg;
497 }
498 if (reason) {
499 *reason = "decoding error";
500 }
501 return -2;
Victor Stinnere2623772012-11-12 23:04:02 +0100502#else /* HAVE_MBRTOWC */
Victor Stinner4e314432010-10-07 21:45:39 +0000503 /* Cannot use C locale for escaping; manually escape as if charset
504 is ASCII (i.e. escape all bytes > 128. This will still roundtrip
505 correctly in the locale's charset, which must be an ASCII superset. */
Victor Stinner3d4226a2018-08-29 22:21:32 +0200506 return decode_ascii(arg, wstr, wlen, reason, errors);
Victor Stinnere2623772012-11-12 23:04:02 +0100507#endif /* HAVE_MBRTOWC */
Victor Stinner91106cd2017-12-13 12:29:09 +0100508}
509
510
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100511/* Decode a byte string from the locale encoding.
512
513 Use the strict error handler if 'surrogateescape' is zero. Use the
514 surrogateescape error handler if 'surrogateescape' is non-zero: undecodable
515 bytes are decoded as characters in range U+DC80..U+DCFF. If a byte sequence
516 can be decoded as a surrogate character, escape the bytes using the
517 surrogateescape error handler instead of decoding them.
518
Ville Skyttä61f82e02018-04-20 23:08:45 +0300519 On success, return 0 and write the newly allocated wide character string into
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100520 *wstr (use PyMem_RawFree() to free the memory). If wlen is not NULL, write
521 the number of wide characters excluding the null character into *wlen.
522
523 On memory allocation failure, return -1.
524
525 On decoding error, return -2. If wlen is not NULL, write the start of
526 invalid byte sequence in the input string into *wlen. If reason is not NULL,
527 write the decoding error message into *reason.
528
Victor Stinner3d4226a2018-08-29 22:21:32 +0200529 Return -3 if the error handler 'errors' is not supported.
530
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100531 Use the Py_EncodeLocaleEx() function to encode the character string back to
532 a byte string. */
533int
534_Py_DecodeLocaleEx(const char* arg, wchar_t **wstr, size_t *wlen,
535 const char **reason,
Victor Stinner3d4226a2018-08-29 22:21:32 +0200536 int current_locale, _Py_error_handler errors)
Victor Stinner2cba6b82018-01-10 22:46:15 +0100537{
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100538 if (current_locale) {
Victor Stinnere2510952019-05-02 11:28:57 -0400539#ifdef _Py_FORCE_UTF8_LOCALE
Victor Stinner9089a262018-01-22 19:07:32 +0100540 return _Py_DecodeUTF8Ex(arg, strlen(arg), wstr, wlen, reason,
Victor Stinner3d4226a2018-08-29 22:21:32 +0200541 errors);
Victor Stinner9089a262018-01-22 19:07:32 +0100542#else
Victor Stinner3d4226a2018-08-29 22:21:32 +0200543 return decode_current_locale(arg, wstr, wlen, reason, errors);
Victor Stinner9089a262018-01-22 19:07:32 +0100544#endif
Victor Stinner2cba6b82018-01-10 22:46:15 +0100545 }
546
Victor Stinnere2510952019-05-02 11:28:57 -0400547#ifdef _Py_FORCE_UTF8_FS_ENCODING
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100548 return _Py_DecodeUTF8Ex(arg, strlen(arg), wstr, wlen, reason,
Victor Stinner3d4226a2018-08-29 22:21:32 +0200549 errors);
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100550#else
Victor Stinnerc5989cd2018-08-29 19:32:47 +0200551 int use_utf8 = (Py_UTF8Mode == 1);
552#ifdef MS_WINDOWS
553 use_utf8 |= !Py_LegacyWindowsFSEncodingFlag;
554#endif
555 if (use_utf8) {
Victor Stinner3d4226a2018-08-29 22:21:32 +0200556 return _Py_DecodeUTF8Ex(arg, strlen(arg), wstr, wlen, reason,
557 errors);
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100558 }
559
560#ifdef USE_FORCE_ASCII
561 if (force_ascii == -1) {
Victor Stinner2cba6b82018-01-10 22:46:15 +0100562 force_ascii = check_force_ascii();
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100563 }
Victor Stinner2cba6b82018-01-10 22:46:15 +0100564
565 if (force_ascii) {
566 /* force ASCII encoding to workaround mbstowcs() issue */
Victor Stinner3d4226a2018-08-29 22:21:32 +0200567 return decode_ascii(arg, wstr, wlen, reason, errors);
Victor Stinner2cba6b82018-01-10 22:46:15 +0100568 }
569#endif
570
Victor Stinner3d4226a2018-08-29 22:21:32 +0200571 return decode_current_locale(arg, wstr, wlen, reason, errors);
Victor Stinnere2510952019-05-02 11:28:57 -0400572#endif /* !_Py_FORCE_UTF8_FS_ENCODING */
Victor Stinner2cba6b82018-01-10 22:46:15 +0100573}
574
575
Victor Stinner91106cd2017-12-13 12:29:09 +0100576/* Decode a byte string from the locale encoding with the
577 surrogateescape error handler: undecodable bytes are decoded as characters
578 in range U+DC80..U+DCFF. If a byte sequence can be decoded as a surrogate
579 character, escape the bytes using the surrogateescape error handler instead
580 of decoding them.
581
582 Return a pointer to a newly allocated wide character string, use
583 PyMem_RawFree() to free the memory. If size is not NULL, write the number of
584 wide characters excluding the null character into *size
585
586 Return NULL on decoding error or memory allocation error. If *size* is not
587 NULL, *size is set to (size_t)-1 on memory error or set to (size_t)-2 on
588 decoding error.
589
590 Decoding errors should never happen, unless there is a bug in the C
591 library.
592
593 Use the Py_EncodeLocale() function to encode the character string back to a
594 byte string. */
595wchar_t*
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100596Py_DecodeLocale(const char* arg, size_t *wlen)
Victor Stinner91106cd2017-12-13 12:29:09 +0100597{
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100598 wchar_t *wstr;
Victor Stinner3d4226a2018-08-29 22:21:32 +0200599 int res = _Py_DecodeLocaleEx(arg, &wstr, wlen,
600 NULL, 0,
601 _Py_ERROR_SURROGATEESCAPE);
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100602 if (res != 0) {
Victor Stinner3d4226a2018-08-29 22:21:32 +0200603 assert(res != -3);
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100604 if (wlen != NULL) {
605 *wlen = (size_t)res;
606 }
607 return NULL;
608 }
609 return wstr;
Victor Stinner2cba6b82018-01-10 22:46:15 +0100610}
Victor Stinner91106cd2017-12-13 12:29:09 +0100611
Victor Stinner91106cd2017-12-13 12:29:09 +0100612
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100613static int
614encode_current_locale(const wchar_t *text, char **str,
615 size_t *error_pos, const char **reason,
Victor Stinner3d4226a2018-08-29 22:21:32 +0200616 int raw_malloc, _Py_error_handler errors)
Victor Stinner91106cd2017-12-13 12:29:09 +0100617{
Victor Stinner4e314432010-10-07 21:45:39 +0000618 const size_t len = wcslen(text);
619 char *result = NULL, *bytes = NULL;
620 size_t i, size, converted;
621 wchar_t c, buf[2];
622
Victor Stinner3d4226a2018-08-29 22:21:32 +0200623 int surrogateescape;
624 if (get_surrogateescape(errors, &surrogateescape) < 0) {
625 return -3;
626 }
627
Victor Stinner4e314432010-10-07 21:45:39 +0000628 /* The function works in two steps:
629 1. compute the length of the output buffer in bytes (size)
630 2. outputs the bytes */
631 size = 0;
632 buf[1] = 0;
633 while (1) {
634 for (i=0; i < len; i++) {
635 c = text[i];
636 if (c >= 0xdc80 && c <= 0xdcff) {
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100637 if (!surrogateescape) {
638 goto encode_error;
639 }
Victor Stinner4e314432010-10-07 21:45:39 +0000640 /* UTF-8b surrogate */
641 if (bytes != NULL) {
642 *bytes++ = c - 0xdc00;
643 size--;
644 }
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100645 else {
Victor Stinner4e314432010-10-07 21:45:39 +0000646 size++;
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100647 }
Victor Stinner4e314432010-10-07 21:45:39 +0000648 continue;
649 }
650 else {
651 buf[0] = c;
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100652 if (bytes != NULL) {
Victor Stinner4e314432010-10-07 21:45:39 +0000653 converted = wcstombs(bytes, buf, size);
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100654 }
655 else {
Victor Stinner4e314432010-10-07 21:45:39 +0000656 converted = wcstombs(NULL, buf, 0);
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100657 }
Victor Stinner4e314432010-10-07 21:45:39 +0000658 if (converted == (size_t)-1) {
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100659 goto encode_error;
Victor Stinner4e314432010-10-07 21:45:39 +0000660 }
661 if (bytes != NULL) {
662 bytes += converted;
663 size -= converted;
664 }
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100665 else {
Victor Stinner4e314432010-10-07 21:45:39 +0000666 size += converted;
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100667 }
Victor Stinner4e314432010-10-07 21:45:39 +0000668 }
669 }
670 if (result != NULL) {
Victor Stinnerd45c7f82012-12-04 01:34:47 +0100671 *bytes = '\0';
Victor Stinner4e314432010-10-07 21:45:39 +0000672 break;
673 }
674
675 size += 1; /* nul byte at the end */
Victor Stinner9dd76202017-12-21 16:20:32 +0100676 if (raw_malloc) {
677 result = PyMem_RawMalloc(size);
678 }
679 else {
680 result = PyMem_Malloc(size);
681 }
Victor Stinner0d92c4f2012-11-12 23:32:21 +0100682 if (result == NULL) {
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100683 return -1;
Victor Stinner0d92c4f2012-11-12 23:32:21 +0100684 }
Victor Stinner4e314432010-10-07 21:45:39 +0000685 bytes = result;
686 }
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100687 *str = result;
688 return 0;
689
690encode_error:
691 if (raw_malloc) {
692 PyMem_RawFree(result);
693 }
694 else {
695 PyMem_Free(result);
696 }
697 if (error_pos != NULL) {
698 *error_pos = i;
699 }
700 if (reason) {
701 *reason = "encoding error";
702 }
703 return -2;
Victor Stinner91106cd2017-12-13 12:29:09 +0100704}
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100705
Victor Stinner3d4226a2018-08-29 22:21:32 +0200706
707/* Encode a string to the locale encoding.
708
709 Parameters:
710
711 * raw_malloc: if non-zero, allocate memory using PyMem_RawMalloc() instead
712 of PyMem_Malloc().
713 * current_locale: if non-zero, use the current LC_CTYPE, otherwise use
714 Python filesystem encoding.
715 * errors: error handler like "strict" or "surrogateescape".
716
717 Return value:
718
719 0: success, *str is set to a newly allocated decoded string.
720 -1: memory allocation failure
721 -2: encoding error, set *error_pos and *reason (if set).
722 -3: the error handler 'errors' is not supported.
723 */
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100724static int
725encode_locale_ex(const wchar_t *text, char **str, size_t *error_pos,
726 const char **reason,
Victor Stinner3d4226a2018-08-29 22:21:32 +0200727 int raw_malloc, int current_locale, _Py_error_handler errors)
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100728{
729 if (current_locale) {
Victor Stinnere2510952019-05-02 11:28:57 -0400730#ifdef _Py_FORCE_UTF8_LOCALE
Victor Stinner9089a262018-01-22 19:07:32 +0100731 return _Py_EncodeUTF8Ex(text, str, error_pos, reason,
Victor Stinner3d4226a2018-08-29 22:21:32 +0200732 raw_malloc, errors);
Victor Stinner9089a262018-01-22 19:07:32 +0100733#else
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100734 return encode_current_locale(text, str, error_pos, reason,
Victor Stinner3d4226a2018-08-29 22:21:32 +0200735 raw_malloc, errors);
Victor Stinner9089a262018-01-22 19:07:32 +0100736#endif
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100737 }
738
Victor Stinnere2510952019-05-02 11:28:57 -0400739#ifdef _Py_FORCE_UTF8_FS_ENCODING
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100740 return _Py_EncodeUTF8Ex(text, str, error_pos, reason,
Victor Stinner3d4226a2018-08-29 22:21:32 +0200741 raw_malloc, errors);
742#else
Victor Stinnerc5989cd2018-08-29 19:32:47 +0200743 int use_utf8 = (Py_UTF8Mode == 1);
744#ifdef MS_WINDOWS
745 use_utf8 |= !Py_LegacyWindowsFSEncodingFlag;
746#endif
747 if (use_utf8) {
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100748 return _Py_EncodeUTF8Ex(text, str, error_pos, reason,
Victor Stinner3d4226a2018-08-29 22:21:32 +0200749 raw_malloc, errors);
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100750 }
751
752#ifdef USE_FORCE_ASCII
753 if (force_ascii == -1) {
754 force_ascii = check_force_ascii();
755 }
756
757 if (force_ascii) {
758 return encode_ascii(text, str, error_pos, reason,
Victor Stinner3d4226a2018-08-29 22:21:32 +0200759 raw_malloc, errors);
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100760 }
Victor Stinnerd2b02312017-12-15 23:06:17 +0100761#endif
Victor Stinner91106cd2017-12-13 12:29:09 +0100762
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100763 return encode_current_locale(text, str, error_pos, reason,
Victor Stinner3d4226a2018-08-29 22:21:32 +0200764 raw_malloc, errors);
Victor Stinnere2510952019-05-02 11:28:57 -0400765#endif /* _Py_FORCE_UTF8_FS_ENCODING */
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100766}
767
Victor Stinner9dd76202017-12-21 16:20:32 +0100768static char*
Victor Stinner2cba6b82018-01-10 22:46:15 +0100769encode_locale(const wchar_t *text, size_t *error_pos,
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100770 int raw_malloc, int current_locale)
Victor Stinner9dd76202017-12-21 16:20:32 +0100771{
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100772 char *str;
773 int res = encode_locale_ex(text, &str, error_pos, NULL,
Victor Stinner3d4226a2018-08-29 22:21:32 +0200774 raw_malloc, current_locale,
775 _Py_ERROR_SURROGATEESCAPE);
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100776 if (res != -2 && error_pos) {
777 *error_pos = (size_t)-1;
Victor Stinner9dd76202017-12-21 16:20:32 +0100778 }
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100779 if (res != 0) {
780 return NULL;
781 }
782 return str;
Victor Stinner9dd76202017-12-21 16:20:32 +0100783}
784
Victor Stinner91106cd2017-12-13 12:29:09 +0100785/* Encode a wide character string to the locale encoding with the
786 surrogateescape error handler: surrogate characters in the range
787 U+DC80..U+DCFF are converted to bytes 0x80..0xFF.
788
789 Return a pointer to a newly allocated byte string, use PyMem_Free() to free
790 the memory. Return NULL on encoding or memory allocation error.
791
792 If error_pos is not NULL, *error_pos is set to (size_t)-1 on success, or set
793 to the index of the invalid character on encoding error.
794
795 Use the Py_DecodeLocale() function to decode the bytes string back to a wide
796 character string. */
797char*
798Py_EncodeLocale(const wchar_t *text, size_t *error_pos)
799{
Victor Stinner2cba6b82018-01-10 22:46:15 +0100800 return encode_locale(text, error_pos, 0, 0);
Victor Stinner9dd76202017-12-21 16:20:32 +0100801}
Victor Stinner91106cd2017-12-13 12:29:09 +0100802
Victor Stinner91106cd2017-12-13 12:29:09 +0100803
Victor Stinner9dd76202017-12-21 16:20:32 +0100804/* Similar to Py_EncodeLocale(), but result must be freed by PyMem_RawFree()
805 instead of PyMem_Free(). */
806char*
807_Py_EncodeLocaleRaw(const wchar_t *text, size_t *error_pos)
808{
Victor Stinner2cba6b82018-01-10 22:46:15 +0100809 return encode_locale(text, error_pos, 1, 0);
810}
811
812
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100813int
814_Py_EncodeLocaleEx(const wchar_t *text, char **str,
815 size_t *error_pos, const char **reason,
Victor Stinner3d4226a2018-08-29 22:21:32 +0200816 int current_locale, _Py_error_handler errors)
Victor Stinner2cba6b82018-01-10 22:46:15 +0100817{
Victor Stinner7ed7aea2018-01-15 10:45:49 +0100818 return encode_locale_ex(text, str, error_pos, reason, 1,
Victor Stinner3d4226a2018-08-29 22:21:32 +0200819 current_locale, errors);
Victor Stinner4e314432010-10-07 21:45:39 +0000820}
821
Victor Stinner6672d0c2010-10-07 22:53:43 +0000822
Steve Dowerf2f373f2015-02-21 08:44:05 -0800823#ifdef MS_WINDOWS
824static __int64 secs_between_epochs = 11644473600; /* Seconds between 1.1.1601 and 1.1.1970 */
825
826static void
827FILE_TIME_to_time_t_nsec(FILETIME *in_ptr, time_t *time_out, int* nsec_out)
828{
829 /* XXX endianness. Shouldn't matter, as all Windows implementations are little-endian */
830 /* Cannot simply cast and dereference in_ptr,
831 since it might not be aligned properly */
832 __int64 in;
833 memcpy(&in, in_ptr, sizeof(in));
834 *nsec_out = (int)(in % 10000000) * 100; /* FILETIME is in units of 100 nsec. */
835 *time_out = Py_SAFE_DOWNCAST((in / 10000000) - secs_between_epochs, __int64, time_t);
836}
837
838void
Steve Dowerbf1f3762015-02-21 15:26:02 -0800839_Py_time_t_to_FILE_TIME(time_t time_in, int nsec_in, FILETIME *out_ptr)
Steve Dowerf2f373f2015-02-21 08:44:05 -0800840{
841 /* XXX endianness */
842 __int64 out;
843 out = time_in + secs_between_epochs;
844 out = out * 10000000 + nsec_in / 100;
845 memcpy(out_ptr, &out, sizeof(out));
846}
847
848/* Below, we *know* that ugo+r is 0444 */
849#if _S_IREAD != 0400
850#error Unsupported C library
851#endif
852static int
853attributes_to_mode(DWORD attr)
854{
855 int m = 0;
856 if (attr & FILE_ATTRIBUTE_DIRECTORY)
857 m |= _S_IFDIR | 0111; /* IFEXEC for user,group,other */
858 else
859 m |= _S_IFREG;
860 if (attr & FILE_ATTRIBUTE_READONLY)
861 m |= 0444;
862 else
863 m |= 0666;
864 return m;
865}
866
Steve Dowerbf1f3762015-02-21 15:26:02 -0800867void
Victor Stinnere134a7f2015-03-30 10:09:31 +0200868_Py_attribute_data_to_stat(BY_HANDLE_FILE_INFORMATION *info, ULONG reparse_tag,
869 struct _Py_stat_struct *result)
Steve Dowerf2f373f2015-02-21 08:44:05 -0800870{
871 memset(result, 0, sizeof(*result));
872 result->st_mode = attributes_to_mode(info->dwFileAttributes);
873 result->st_size = (((__int64)info->nFileSizeHigh)<<32) + info->nFileSizeLow;
874 result->st_dev = info->dwVolumeSerialNumber;
875 result->st_rdev = result->st_dev;
876 FILE_TIME_to_time_t_nsec(&info->ftCreationTime, &result->st_ctime, &result->st_ctime_nsec);
877 FILE_TIME_to_time_t_nsec(&info->ftLastWriteTime, &result->st_mtime, &result->st_mtime_nsec);
878 FILE_TIME_to_time_t_nsec(&info->ftLastAccessTime, &result->st_atime, &result->st_atime_nsec);
879 result->st_nlink = info->nNumberOfLinks;
Victor Stinner0f6d7332017-03-09 17:34:28 +0100880 result->st_ino = (((uint64_t)info->nFileIndexHigh) << 32) + info->nFileIndexLow;
Steve Dowerf2f373f2015-02-21 08:44:05 -0800881 if (reparse_tag == IO_REPARSE_TAG_SYMLINK) {
882 /* first clear the S_IFMT bits */
883 result->st_mode ^= (result->st_mode & S_IFMT);
884 /* now set the bits that make this a symlink */
885 result->st_mode |= S_IFLNK;
886 }
887 result->st_file_attributes = info->dwFileAttributes;
Steve Dowerf2f373f2015-02-21 08:44:05 -0800888}
889#endif
890
891/* Return information about a file.
892
893 On POSIX, use fstat().
894
895 On Windows, use GetFileType() and GetFileInformationByHandle() which support
Victor Stinner8c663fd2017-11-08 14:44:44 -0800896 files larger than 2 GiB. fstat() may fail with EOVERFLOW on files larger
897 than 2 GiB because the file size type is a signed 32-bit integer: see issue
Steve Dowerf2f373f2015-02-21 08:44:05 -0800898 #23152.
Victor Stinnere134a7f2015-03-30 10:09:31 +0200899
900 On Windows, set the last Windows error and return nonzero on error. On
901 POSIX, set errno and return nonzero on error. Fill status and return 0 on
902 success. */
Steve Dowerf2f373f2015-02-21 08:44:05 -0800903int
Victor Stinnere134a7f2015-03-30 10:09:31 +0200904_Py_fstat_noraise(int fd, struct _Py_stat_struct *status)
Steve Dowerf2f373f2015-02-21 08:44:05 -0800905{
906#ifdef MS_WINDOWS
907 BY_HANDLE_FILE_INFORMATION info;
908 HANDLE h;
909 int type;
910
Steve Dower940f33a2016-09-08 11:21:54 -0700911 _Py_BEGIN_SUPPRESS_IPH
912 h = (HANDLE)_get_osfhandle(fd);
913 _Py_END_SUPPRESS_IPH
Steve Dowerf2f373f2015-02-21 08:44:05 -0800914
915 if (h == INVALID_HANDLE_VALUE) {
Steve Dower8fc89802015-04-12 00:26:27 -0400916 /* errno is already set by _get_osfhandle, but we also set
917 the Win32 error for callers who expect that */
Steve Dower8acde7d2015-03-07 18:14:07 -0800918 SetLastError(ERROR_INVALID_HANDLE);
Steve Dowerf2f373f2015-02-21 08:44:05 -0800919 return -1;
920 }
Victor Stinnere134a7f2015-03-30 10:09:31 +0200921 memset(status, 0, sizeof(*status));
Steve Dowerf2f373f2015-02-21 08:44:05 -0800922
923 type = GetFileType(h);
924 if (type == FILE_TYPE_UNKNOWN) {
925 DWORD error = GetLastError();
Steve Dower8fc89802015-04-12 00:26:27 -0400926 if (error != 0) {
927 errno = winerror_to_errno(error);
Steve Dowerf2f373f2015-02-21 08:44:05 -0800928 return -1;
Steve Dower8fc89802015-04-12 00:26:27 -0400929 }
Steve Dowerf2f373f2015-02-21 08:44:05 -0800930 /* else: valid but unknown file */
931 }
932
933 if (type != FILE_TYPE_DISK) {
934 if (type == FILE_TYPE_CHAR)
Victor Stinnere134a7f2015-03-30 10:09:31 +0200935 status->st_mode = _S_IFCHR;
Steve Dowerf2f373f2015-02-21 08:44:05 -0800936 else if (type == FILE_TYPE_PIPE)
Victor Stinnere134a7f2015-03-30 10:09:31 +0200937 status->st_mode = _S_IFIFO;
Steve Dowerf2f373f2015-02-21 08:44:05 -0800938 return 0;
939 }
940
941 if (!GetFileInformationByHandle(h, &info)) {
Steve Dower8fc89802015-04-12 00:26:27 -0400942 /* The Win32 error is already set, but we also set errno for
943 callers who expect it */
944 errno = winerror_to_errno(GetLastError());
Steve Dowerf2f373f2015-02-21 08:44:05 -0800945 return -1;
946 }
947
Victor Stinnere134a7f2015-03-30 10:09:31 +0200948 _Py_attribute_data_to_stat(&info, 0, status);
Steve Dowerf2f373f2015-02-21 08:44:05 -0800949 /* specific to fstat() */
Victor Stinner0f6d7332017-03-09 17:34:28 +0100950 status->st_ino = (((uint64_t)info.nFileIndexHigh) << 32) + info.nFileIndexLow;
Steve Dowerf2f373f2015-02-21 08:44:05 -0800951 return 0;
952#else
Victor Stinnere134a7f2015-03-30 10:09:31 +0200953 return fstat(fd, status);
Steve Dowerf2f373f2015-02-21 08:44:05 -0800954#endif
955}
Steve Dowerf2f373f2015-02-21 08:44:05 -0800956
Victor Stinnere134a7f2015-03-30 10:09:31 +0200957/* Return information about a file.
958
959 On POSIX, use fstat().
960
961 On Windows, use GetFileType() and GetFileInformationByHandle() which support
Victor Stinner8c663fd2017-11-08 14:44:44 -0800962 files larger than 2 GiB. fstat() may fail with EOVERFLOW on files larger
963 than 2 GiB because the file size type is a signed 32-bit integer: see issue
Victor Stinnere134a7f2015-03-30 10:09:31 +0200964 #23152.
965
966 Raise an exception and return -1 on error. On Windows, set the last Windows
967 error on error. On POSIX, set errno on error. Fill status and return 0 on
968 success.
969
Victor Stinner6f4fae82015-04-01 18:34:32 +0200970 Release the GIL to call GetFileType() and GetFileInformationByHandle(), or
971 to call fstat(). The caller must hold the GIL. */
Victor Stinnere134a7f2015-03-30 10:09:31 +0200972int
973_Py_fstat(int fd, struct _Py_stat_struct *status)
974{
975 int res;
976
Victor Stinner8a1be612016-03-14 22:07:55 +0100977 assert(PyGILState_Check());
Victor Stinner8a1be612016-03-14 22:07:55 +0100978
Victor Stinnere134a7f2015-03-30 10:09:31 +0200979 Py_BEGIN_ALLOW_THREADS
980 res = _Py_fstat_noraise(fd, status);
981 Py_END_ALLOW_THREADS
982
983 if (res != 0) {
984#ifdef MS_WINDOWS
985 PyErr_SetFromWindowsErr(0);
986#else
987 PyErr_SetFromErrno(PyExc_OSError);
988#endif
989 return -1;
990 }
991 return 0;
992}
Steve Dowerf2f373f2015-02-21 08:44:05 -0800993
Victor Stinner6672d0c2010-10-07 22:53:43 +0000994/* Call _wstat() on Windows, or encode the path to the filesystem encoding and
995 call stat() otherwise. Only fill st_mode attribute on Windows.
996
Victor Stinnerbd0850b2011-12-18 20:47:30 +0100997 Return 0 on success, -1 on _wstat() / stat() error, -2 if an exception was
998 raised. */
Victor Stinner4e314432010-10-07 21:45:39 +0000999
1000int
Victor Stinnera4a75952010-10-07 22:23:10 +00001001_Py_stat(PyObject *path, struct stat *statbuf)
Victor Stinner4e314432010-10-07 21:45:39 +00001002{
1003#ifdef MS_WINDOWS
Victor Stinner4e314432010-10-07 21:45:39 +00001004 int err;
1005 struct _stat wstatbuf;
Serhiy Storchakaf7eae0a2017-06-28 08:30:06 +03001006 const wchar_t *wpath;
Victor Stinner4e314432010-10-07 21:45:39 +00001007
Serhiy Storchakaf7eae0a2017-06-28 08:30:06 +03001008 wpath = _PyUnicode_AsUnicode(path);
Victor Stinneree587ea2011-11-17 00:51:38 +01001009 if (wpath == NULL)
Victor Stinnerbd0850b2011-12-18 20:47:30 +01001010 return -2;
Serhiy Storchakaf7eae0a2017-06-28 08:30:06 +03001011
Victor Stinneree587ea2011-11-17 00:51:38 +01001012 err = _wstat(wpath, &wstatbuf);
Victor Stinner4e314432010-10-07 21:45:39 +00001013 if (!err)
1014 statbuf->st_mode = wstatbuf.st_mode;
1015 return err;
1016#else
1017 int ret;
Serhiy Storchakaf7eae0a2017-06-28 08:30:06 +03001018 PyObject *bytes;
1019 char *cpath;
1020
1021 bytes = PyUnicode_EncodeFSDefault(path);
Victor Stinner4e314432010-10-07 21:45:39 +00001022 if (bytes == NULL)
Victor Stinnerbd0850b2011-12-18 20:47:30 +01001023 return -2;
Serhiy Storchakaf7eae0a2017-06-28 08:30:06 +03001024
1025 /* check for embedded null bytes */
1026 if (PyBytes_AsStringAndSize(bytes, &cpath, NULL) == -1) {
1027 Py_DECREF(bytes);
1028 return -2;
1029 }
1030
1031 ret = stat(cpath, statbuf);
Victor Stinner4e314432010-10-07 21:45:39 +00001032 Py_DECREF(bytes);
1033 return ret;
1034#endif
1035}
1036
Victor Stinnerd45c7f82012-12-04 01:34:47 +01001037
Alexey Izbyshevc1e46e92018-02-06 09:09:34 +03001038/* This function MUST be kept async-signal-safe on POSIX when raise=0. */
Antoine Pitrou409b5382013-10-12 22:41:17 +02001039static int
Victor Stinnerdaf45552013-08-28 00:53:59 +02001040get_inheritable(int fd, int raise)
1041{
1042#ifdef MS_WINDOWS
1043 HANDLE handle;
1044 DWORD flags;
Victor Stinner6672d0c2010-10-07 22:53:43 +00001045
Steve Dower8fc89802015-04-12 00:26:27 -04001046 _Py_BEGIN_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02001047 handle = (HANDLE)_get_osfhandle(fd);
Steve Dower8fc89802015-04-12 00:26:27 -04001048 _Py_END_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02001049 if (handle == INVALID_HANDLE_VALUE) {
1050 if (raise)
Steve Dower41e72442015-03-14 11:38:27 -07001051 PyErr_SetFromErrno(PyExc_OSError);
Victor Stinnerdaf45552013-08-28 00:53:59 +02001052 return -1;
1053 }
1054
1055 if (!GetHandleInformation(handle, &flags)) {
1056 if (raise)
1057 PyErr_SetFromWindowsErr(0);
1058 return -1;
1059 }
1060
1061 return (flags & HANDLE_FLAG_INHERIT);
1062#else
1063 int flags;
1064
1065 flags = fcntl(fd, F_GETFD, 0);
1066 if (flags == -1) {
1067 if (raise)
1068 PyErr_SetFromErrno(PyExc_OSError);
1069 return -1;
1070 }
1071 return !(flags & FD_CLOEXEC);
1072#endif
1073}
1074
1075/* Get the inheritable flag of the specified file descriptor.
Victor Stinnerb034eee2013-09-07 10:36:04 +02001076 Return 1 if the file descriptor can be inherited, 0 if it cannot,
Victor Stinnerdaf45552013-08-28 00:53:59 +02001077 raise an exception and return -1 on error. */
1078int
1079_Py_get_inheritable(int fd)
1080{
1081 return get_inheritable(fd, 1);
1082}
1083
Alexey Izbyshevc1e46e92018-02-06 09:09:34 +03001084
1085/* This function MUST be kept async-signal-safe on POSIX when raise=0. */
Victor Stinnerdaf45552013-08-28 00:53:59 +02001086static int
1087set_inheritable(int fd, int inheritable, int raise, int *atomic_flag_works)
1088{
1089#ifdef MS_WINDOWS
1090 HANDLE handle;
1091 DWORD flags;
Victor Stinner282124b2014-09-02 11:41:04 +02001092#else
1093#if defined(HAVE_SYS_IOCTL_H) && defined(FIOCLEX) && defined(FIONCLEX)
1094 static int ioctl_works = -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +02001095 int request;
1096 int err;
Victor Stinner282124b2014-09-02 11:41:04 +02001097#endif
Victor Stinnera858bbd2016-04-17 16:51:52 +02001098 int flags, new_flags;
Victor Stinnerdaf45552013-08-28 00:53:59 +02001099 int res;
1100#endif
1101
1102 /* atomic_flag_works can only be used to make the file descriptor
1103 non-inheritable */
1104 assert(!(atomic_flag_works != NULL && inheritable));
1105
1106 if (atomic_flag_works != NULL && !inheritable) {
1107 if (*atomic_flag_works == -1) {
Steve Dower41e72442015-03-14 11:38:27 -07001108 int isInheritable = get_inheritable(fd, raise);
1109 if (isInheritable == -1)
Victor Stinnerdaf45552013-08-28 00:53:59 +02001110 return -1;
Steve Dower41e72442015-03-14 11:38:27 -07001111 *atomic_flag_works = !isInheritable;
Victor Stinnerdaf45552013-08-28 00:53:59 +02001112 }
1113
1114 if (*atomic_flag_works)
1115 return 0;
1116 }
1117
1118#ifdef MS_WINDOWS
Steve Dower8fc89802015-04-12 00:26:27 -04001119 _Py_BEGIN_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02001120 handle = (HANDLE)_get_osfhandle(fd);
Steve Dower8fc89802015-04-12 00:26:27 -04001121 _Py_END_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02001122 if (handle == INVALID_HANDLE_VALUE) {
1123 if (raise)
Steve Dower41e72442015-03-14 11:38:27 -07001124 PyErr_SetFromErrno(PyExc_OSError);
Victor Stinnerdaf45552013-08-28 00:53:59 +02001125 return -1;
1126 }
1127
1128 if (inheritable)
1129 flags = HANDLE_FLAG_INHERIT;
1130 else
1131 flags = 0;
1132 if (!SetHandleInformation(handle, HANDLE_FLAG_INHERIT, flags)) {
1133 if (raise)
1134 PyErr_SetFromWindowsErr(0);
1135 return -1;
1136 }
1137 return 0;
1138
Victor Stinnerdaf45552013-08-28 00:53:59 +02001139#else
Victor Stinner282124b2014-09-02 11:41:04 +02001140
1141#if defined(HAVE_SYS_IOCTL_H) && defined(FIOCLEX) && defined(FIONCLEX)
Alexey Izbyshevc1e46e92018-02-06 09:09:34 +03001142 if (ioctl_works != 0 && raise != 0) {
Victor Stinner282124b2014-09-02 11:41:04 +02001143 /* fast-path: ioctl() only requires one syscall */
Alexey Izbyshevc1e46e92018-02-06 09:09:34 +03001144 /* caveat: raise=0 is an indicator that we must be async-signal-safe
1145 * thus avoid using ioctl() so we skip the fast-path. */
Victor Stinner282124b2014-09-02 11:41:04 +02001146 if (inheritable)
1147 request = FIONCLEX;
1148 else
1149 request = FIOCLEX;
1150 err = ioctl(fd, request, NULL);
1151 if (!err) {
1152 ioctl_works = 1;
1153 return 0;
1154 }
1155
Victor Stinner3116cc42016-05-19 16:46:18 +02001156 if (errno != ENOTTY && errno != EACCES) {
Victor Stinner282124b2014-09-02 11:41:04 +02001157 if (raise)
1158 PyErr_SetFromErrno(PyExc_OSError);
1159 return -1;
1160 }
1161 else {
1162 /* Issue #22258: Here, ENOTTY means "Inappropriate ioctl for
1163 device". The ioctl is declared but not supported by the kernel.
1164 Remember that ioctl() doesn't work. It is the case on
Victor Stinner3116cc42016-05-19 16:46:18 +02001165 Illumos-based OS for example.
1166
1167 Issue #27057: When SELinux policy disallows ioctl it will fail
1168 with EACCES. While FIOCLEX is safe operation it may be
1169 unavailable because ioctl was denied altogether.
1170 This can be the case on Android. */
Victor Stinner282124b2014-09-02 11:41:04 +02001171 ioctl_works = 0;
1172 }
1173 /* fallback to fcntl() if ioctl() does not work */
1174 }
1175#endif
1176
1177 /* slow-path: fcntl() requires two syscalls */
Victor Stinnerdaf45552013-08-28 00:53:59 +02001178 flags = fcntl(fd, F_GETFD);
1179 if (flags < 0) {
1180 if (raise)
1181 PyErr_SetFromErrno(PyExc_OSError);
1182 return -1;
1183 }
1184
Victor Stinnera858bbd2016-04-17 16:51:52 +02001185 if (inheritable) {
1186 new_flags = flags & ~FD_CLOEXEC;
1187 }
1188 else {
1189 new_flags = flags | FD_CLOEXEC;
1190 }
1191
1192 if (new_flags == flags) {
1193 /* FD_CLOEXEC flag already set/cleared: nothing to do */
1194 return 0;
1195 }
1196
Xavier de Gayeec5d3cd2016-11-19 16:19:29 +01001197 res = fcntl(fd, F_SETFD, new_flags);
Victor Stinnerdaf45552013-08-28 00:53:59 +02001198 if (res < 0) {
1199 if (raise)
1200 PyErr_SetFromErrno(PyExc_OSError);
1201 return -1;
1202 }
1203 return 0;
1204#endif
1205}
1206
1207/* Make the file descriptor non-inheritable.
Victor Stinnerb034eee2013-09-07 10:36:04 +02001208 Return 0 on success, set errno and return -1 on error. */
Victor Stinnerdaf45552013-08-28 00:53:59 +02001209static int
1210make_non_inheritable(int fd)
1211{
1212 return set_inheritable(fd, 0, 0, NULL);
1213}
1214
1215/* Set the inheritable flag of the specified file descriptor.
Alexey Izbyshevc1e46e92018-02-06 09:09:34 +03001216 On success: return 0, on error: raise an exception and return -1.
Victor Stinnerdaf45552013-08-28 00:53:59 +02001217
1218 If atomic_flag_works is not NULL:
1219
1220 * if *atomic_flag_works==-1, check if the inheritable is set on the file
1221 descriptor: if yes, set *atomic_flag_works to 1, otherwise set to 0 and
1222 set the inheritable flag
1223 * if *atomic_flag_works==1: do nothing
1224 * if *atomic_flag_works==0: set inheritable flag to False
1225
1226 Set atomic_flag_works to NULL if no atomic flag was used to create the
1227 file descriptor.
1228
1229 atomic_flag_works can only be used to make a file descriptor
1230 non-inheritable: atomic_flag_works must be NULL if inheritable=1. */
1231int
1232_Py_set_inheritable(int fd, int inheritable, int *atomic_flag_works)
1233{
1234 return set_inheritable(fd, inheritable, 1, atomic_flag_works);
1235}
1236
Alexey Izbyshevc1e46e92018-02-06 09:09:34 +03001237/* Same as _Py_set_inheritable() but on error, set errno and
1238 don't raise an exception.
1239 This function is async-signal-safe. */
1240int
1241_Py_set_inheritable_async_safe(int fd, int inheritable, int *atomic_flag_works)
1242{
1243 return set_inheritable(fd, inheritable, 0, atomic_flag_works);
1244}
1245
Victor Stinnera555cfc2015-03-18 00:22:14 +01001246static int
1247_Py_open_impl(const char *pathname, int flags, int gil_held)
Victor Stinnerdaf45552013-08-28 00:53:59 +02001248{
1249 int fd;
Victor Stinnera47fc5c2015-03-18 09:52:54 +01001250 int async_err = 0;
Victor Stinnera555cfc2015-03-18 00:22:14 +01001251#ifndef MS_WINDOWS
Victor Stinnerdaf45552013-08-28 00:53:59 +02001252 int *atomic_flag_works;
Victor Stinnera555cfc2015-03-18 00:22:14 +01001253#endif
1254
1255#ifdef MS_WINDOWS
1256 flags |= O_NOINHERIT;
1257#elif defined(O_CLOEXEC)
Victor Stinnerdaf45552013-08-28 00:53:59 +02001258 atomic_flag_works = &_Py_open_cloexec_works;
1259 flags |= O_CLOEXEC;
1260#else
1261 atomic_flag_works = NULL;
1262#endif
Victor Stinnerdaf45552013-08-28 00:53:59 +02001263
Victor Stinnera555cfc2015-03-18 00:22:14 +01001264 if (gil_held) {
Steve Dowerb82e17e2019-05-23 08:45:22 -07001265 if (PySys_Audit("open", "sOi", pathname, Py_None, flags) < 0) {
1266 return -1;
1267 }
1268
Victor Stinnera47fc5c2015-03-18 09:52:54 +01001269 do {
1270 Py_BEGIN_ALLOW_THREADS
1271 fd = open(pathname, flags);
1272 Py_END_ALLOW_THREADS
1273 } while (fd < 0
1274 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
1275 if (async_err)
1276 return -1;
Victor Stinnera555cfc2015-03-18 00:22:14 +01001277 if (fd < 0) {
1278 PyErr_SetFromErrnoWithFilename(PyExc_OSError, pathname);
1279 return -1;
1280 }
1281 }
1282 else {
1283 fd = open(pathname, flags);
1284 if (fd < 0)
1285 return -1;
1286 }
1287
1288#ifndef MS_WINDOWS
1289 if (set_inheritable(fd, 0, gil_held, atomic_flag_works) < 0) {
Victor Stinnerdaf45552013-08-28 00:53:59 +02001290 close(fd);
1291 return -1;
1292 }
Victor Stinnera555cfc2015-03-18 00:22:14 +01001293#endif
1294
Victor Stinnerdaf45552013-08-28 00:53:59 +02001295 return fd;
1296}
1297
Victor Stinnera555cfc2015-03-18 00:22:14 +01001298/* Open a file with the specified flags (wrapper to open() function).
1299 Return a file descriptor on success. Raise an exception and return -1 on
1300 error.
1301
1302 The file descriptor is created non-inheritable.
1303
Victor Stinnera47fc5c2015-03-18 09:52:54 +01001304 When interrupted by a signal (open() fails with EINTR), retry the syscall,
1305 except if the Python signal handler raises an exception.
1306
Victor Stinner6f4fae82015-04-01 18:34:32 +02001307 Release the GIL to call open(). The caller must hold the GIL. */
Victor Stinnera555cfc2015-03-18 00:22:14 +01001308int
1309_Py_open(const char *pathname, int flags)
1310{
1311 /* _Py_open() must be called with the GIL held. */
1312 assert(PyGILState_Check());
1313 return _Py_open_impl(pathname, flags, 1);
1314}
1315
1316/* Open a file with the specified flags (wrapper to open() function).
1317 Return a file descriptor on success. Set errno and return -1 on error.
1318
Victor Stinnera47fc5c2015-03-18 09:52:54 +01001319 The file descriptor is created non-inheritable.
1320
1321 If interrupted by a signal, fail with EINTR. */
Victor Stinnera555cfc2015-03-18 00:22:14 +01001322int
1323_Py_open_noraise(const char *pathname, int flags)
1324{
1325 return _Py_open_impl(pathname, flags, 0);
1326}
1327
Victor Stinnerdaf45552013-08-28 00:53:59 +02001328/* Open a file. Use _wfopen() on Windows, encode the path to the locale
Victor Stinnere42ccd22015-03-18 01:39:23 +01001329 encoding and use fopen() otherwise.
1330
Victor Stinnera47fc5c2015-03-18 09:52:54 +01001331 The file descriptor is created non-inheritable.
1332
1333 If interrupted by a signal, fail with EINTR. */
Victor Stinner4e314432010-10-07 21:45:39 +00001334FILE *
1335_Py_wfopen(const wchar_t *path, const wchar_t *mode)
1336{
Victor Stinner4e314432010-10-07 21:45:39 +00001337 FILE *f;
Steve Dowerb82e17e2019-05-23 08:45:22 -07001338 if (PySys_Audit("open", "uui", path, mode, 0) < 0) {
1339 return NULL;
1340 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02001341#ifndef MS_WINDOWS
Victor Stinner4e314432010-10-07 21:45:39 +00001342 char *cpath;
1343 char cmode[10];
1344 size_t r;
1345 r = wcstombs(cmode, mode, 10);
1346 if (r == (size_t)-1 || r >= 10) {
1347 errno = EINVAL;
1348 return NULL;
1349 }
Victor Stinner9dd76202017-12-21 16:20:32 +01001350 cpath = _Py_EncodeLocaleRaw(path, NULL);
1351 if (cpath == NULL) {
Victor Stinner4e314432010-10-07 21:45:39 +00001352 return NULL;
Victor Stinner9dd76202017-12-21 16:20:32 +01001353 }
Victor Stinner4e314432010-10-07 21:45:39 +00001354 f = fopen(cpath, cmode);
Victor Stinner9dd76202017-12-21 16:20:32 +01001355 PyMem_RawFree(cpath);
Victor Stinner4e314432010-10-07 21:45:39 +00001356#else
Victor Stinnerdaf45552013-08-28 00:53:59 +02001357 f = _wfopen(path, mode);
Victor Stinner4e314432010-10-07 21:45:39 +00001358#endif
Victor Stinnerdaf45552013-08-28 00:53:59 +02001359 if (f == NULL)
1360 return NULL;
1361 if (make_non_inheritable(fileno(f)) < 0) {
1362 fclose(f);
1363 return NULL;
1364 }
1365 return f;
Victor Stinner4e314432010-10-07 21:45:39 +00001366}
1367
Victor Stinnere42ccd22015-03-18 01:39:23 +01001368/* Wrapper to fopen().
1369
Victor Stinnera47fc5c2015-03-18 09:52:54 +01001370 The file descriptor is created non-inheritable.
1371
1372 If interrupted by a signal, fail with EINTR. */
Victor Stinnerdaf45552013-08-28 00:53:59 +02001373FILE*
1374_Py_fopen(const char *pathname, const char *mode)
1375{
Steve Dowerb82e17e2019-05-23 08:45:22 -07001376 if (PySys_Audit("open", "ssi", pathname, mode, 0) < 0) {
1377 return NULL;
1378 }
1379
Victor Stinnerdaf45552013-08-28 00:53:59 +02001380 FILE *f = fopen(pathname, mode);
1381 if (f == NULL)
1382 return NULL;
1383 if (make_non_inheritable(fileno(f)) < 0) {
1384 fclose(f);
1385 return NULL;
1386 }
1387 return f;
1388}
1389
1390/* Open a file. Call _wfopen() on Windows, or encode the path to the filesystem
Victor Stinnere42ccd22015-03-18 01:39:23 +01001391 encoding and call fopen() otherwise.
Victor Stinner6672d0c2010-10-07 22:53:43 +00001392
Victor Stinnere42ccd22015-03-18 01:39:23 +01001393 Return the new file object on success. Raise an exception and return NULL
1394 on error.
1395
1396 The file descriptor is created non-inheritable.
1397
Victor Stinnera47fc5c2015-03-18 09:52:54 +01001398 When interrupted by a signal (open() fails with EINTR), retry the syscall,
1399 except if the Python signal handler raises an exception.
1400
Victor Stinner6f4fae82015-04-01 18:34:32 +02001401 Release the GIL to call _wfopen() or fopen(). The caller must hold
1402 the GIL. */
Victor Stinner4e314432010-10-07 21:45:39 +00001403FILE*
Victor Stinnerdaf45552013-08-28 00:53:59 +02001404_Py_fopen_obj(PyObject *path, const char *mode)
Victor Stinner4e314432010-10-07 21:45:39 +00001405{
Victor Stinnerdaf45552013-08-28 00:53:59 +02001406 FILE *f;
Victor Stinnera47fc5c2015-03-18 09:52:54 +01001407 int async_err = 0;
Victor Stinner4e314432010-10-07 21:45:39 +00001408#ifdef MS_WINDOWS
Serhiy Storchakaf7eae0a2017-06-28 08:30:06 +03001409 const wchar_t *wpath;
Victor Stinner4e314432010-10-07 21:45:39 +00001410 wchar_t wmode[10];
1411 int usize;
Victor Stinner4e314432010-10-07 21:45:39 +00001412
Victor Stinnere42ccd22015-03-18 01:39:23 +01001413 assert(PyGILState_Check());
1414
Steve Dowerb82e17e2019-05-23 08:45:22 -07001415 if (PySys_Audit("open", "Osi", path, mode, 0) < 0) {
1416 return NULL;
1417 }
Antoine Pitrou0e576f12011-12-22 10:03:38 +01001418 if (!PyUnicode_Check(path)) {
1419 PyErr_Format(PyExc_TypeError,
1420 "str file path expected under Windows, got %R",
1421 Py_TYPE(path));
1422 return NULL;
1423 }
Serhiy Storchakaf7eae0a2017-06-28 08:30:06 +03001424 wpath = _PyUnicode_AsUnicode(path);
Victor Stinneree587ea2011-11-17 00:51:38 +01001425 if (wpath == NULL)
1426 return NULL;
1427
Alexey Izbyshevb3b4a9d2018-02-18 20:57:24 +03001428 usize = MultiByteToWideChar(CP_ACP, 0, mode, -1,
1429 wmode, Py_ARRAY_LENGTH(wmode));
Victor Stinnere42ccd22015-03-18 01:39:23 +01001430 if (usize == 0) {
1431 PyErr_SetFromWindowsErr(0);
Victor Stinner4e314432010-10-07 21:45:39 +00001432 return NULL;
Victor Stinnere42ccd22015-03-18 01:39:23 +01001433 }
Victor Stinner4e314432010-10-07 21:45:39 +00001434
Victor Stinnera47fc5c2015-03-18 09:52:54 +01001435 do {
1436 Py_BEGIN_ALLOW_THREADS
1437 f = _wfopen(wpath, wmode);
1438 Py_END_ALLOW_THREADS
1439 } while (f == NULL
1440 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Victor Stinner4e314432010-10-07 21:45:39 +00001441#else
Antoine Pitrou2b1cc892011-12-19 18:19:06 +01001442 PyObject *bytes;
Victor Stinnere42ccd22015-03-18 01:39:23 +01001443 char *path_bytes;
1444
1445 assert(PyGILState_Check());
1446
Antoine Pitrou2b1cc892011-12-19 18:19:06 +01001447 if (!PyUnicode_FSConverter(path, &bytes))
Victor Stinner4e314432010-10-07 21:45:39 +00001448 return NULL;
Victor Stinnere42ccd22015-03-18 01:39:23 +01001449 path_bytes = PyBytes_AS_STRING(bytes);
1450
Steve Dowerb82e17e2019-05-23 08:45:22 -07001451 if (PySys_Audit("open", "Osi", path, mode, 0) < 0) {
1452 return NULL;
1453 }
1454
Victor Stinnera47fc5c2015-03-18 09:52:54 +01001455 do {
1456 Py_BEGIN_ALLOW_THREADS
1457 f = fopen(path_bytes, mode);
1458 Py_END_ALLOW_THREADS
1459 } while (f == NULL
1460 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Victor Stinnere42ccd22015-03-18 01:39:23 +01001461
Victor Stinner4e314432010-10-07 21:45:39 +00001462 Py_DECREF(bytes);
Victor Stinner4e314432010-10-07 21:45:39 +00001463#endif
Victor Stinnera47fc5c2015-03-18 09:52:54 +01001464 if (async_err)
1465 return NULL;
1466
Victor Stinnere42ccd22015-03-18 01:39:23 +01001467 if (f == NULL) {
1468 PyErr_SetFromErrnoWithFilenameObject(PyExc_OSError, path);
Victor Stinnerdaf45552013-08-28 00:53:59 +02001469 return NULL;
Victor Stinnere42ccd22015-03-18 01:39:23 +01001470 }
1471
1472 if (set_inheritable(fileno(f), 0, 1, NULL) < 0) {
Victor Stinnerdaf45552013-08-28 00:53:59 +02001473 fclose(f);
1474 return NULL;
1475 }
1476 return f;
Victor Stinner4e314432010-10-07 21:45:39 +00001477}
1478
Victor Stinner66aab0c2015-03-19 22:53:20 +01001479/* Read count bytes from fd into buf.
Victor Stinner82c3e452015-04-01 18:34:45 +02001480
1481 On success, return the number of read bytes, it can be lower than count.
1482 If the current file offset is at or past the end of file, no bytes are read,
1483 and read() returns zero.
1484
1485 On error, raise an exception, set errno and return -1.
1486
1487 When interrupted by a signal (read() fails with EINTR), retry the syscall.
1488 If the Python signal handler raises an exception, the function returns -1
1489 (the syscall is not retried).
1490
1491 Release the GIL to call read(). The caller must hold the GIL. */
Victor Stinner66aab0c2015-03-19 22:53:20 +01001492Py_ssize_t
1493_Py_read(int fd, void *buf, size_t count)
1494{
1495 Py_ssize_t n;
Victor Stinnera3c02022015-03-20 11:58:18 +01001496 int err;
Victor Stinner66aab0c2015-03-19 22:53:20 +01001497 int async_err = 0;
1498
Victor Stinner8a1be612016-03-14 22:07:55 +01001499 assert(PyGILState_Check());
Victor Stinner8a1be612016-03-14 22:07:55 +01001500
Victor Stinner66aab0c2015-03-19 22:53:20 +01001501 /* _Py_read() must not be called with an exception set, otherwise the
1502 * caller may think that read() was interrupted by a signal and the signal
1503 * handler raised an exception. */
1504 assert(!PyErr_Occurred());
1505
Stéphane Wirtel74a8b6e2018-10-18 01:05:04 +02001506 if (count > _PY_READ_MAX) {
1507 count = _PY_READ_MAX;
Victor Stinner66aab0c2015-03-19 22:53:20 +01001508 }
Victor Stinner66aab0c2015-03-19 22:53:20 +01001509
Steve Dower8fc89802015-04-12 00:26:27 -04001510 _Py_BEGIN_SUPPRESS_IPH
Victor Stinner66aab0c2015-03-19 22:53:20 +01001511 do {
1512 Py_BEGIN_ALLOW_THREADS
1513 errno = 0;
1514#ifdef MS_WINDOWS
1515 n = read(fd, buf, (int)count);
1516#else
1517 n = read(fd, buf, count);
1518#endif
Victor Stinnera3c02022015-03-20 11:58:18 +01001519 /* save/restore errno because PyErr_CheckSignals()
1520 * and PyErr_SetFromErrno() can modify it */
1521 err = errno;
Victor Stinner66aab0c2015-03-19 22:53:20 +01001522 Py_END_ALLOW_THREADS
Victor Stinnera3c02022015-03-20 11:58:18 +01001523 } while (n < 0 && err == EINTR &&
Victor Stinner66aab0c2015-03-19 22:53:20 +01001524 !(async_err = PyErr_CheckSignals()));
Steve Dower8fc89802015-04-12 00:26:27 -04001525 _Py_END_SUPPRESS_IPH
Victor Stinner66aab0c2015-03-19 22:53:20 +01001526
1527 if (async_err) {
1528 /* read() was interrupted by a signal (failed with EINTR)
1529 * and the Python signal handler raised an exception */
Victor Stinnera3c02022015-03-20 11:58:18 +01001530 errno = err;
1531 assert(errno == EINTR && PyErr_Occurred());
Victor Stinner66aab0c2015-03-19 22:53:20 +01001532 return -1;
1533 }
1534 if (n < 0) {
Victor Stinner66aab0c2015-03-19 22:53:20 +01001535 PyErr_SetFromErrno(PyExc_OSError);
Victor Stinnera3c02022015-03-20 11:58:18 +01001536 errno = err;
Victor Stinner66aab0c2015-03-19 22:53:20 +01001537 return -1;
1538 }
1539
1540 return n;
1541}
1542
Victor Stinner82c3e452015-04-01 18:34:45 +02001543static Py_ssize_t
1544_Py_write_impl(int fd, const void *buf, size_t count, int gil_held)
Victor Stinner66aab0c2015-03-19 22:53:20 +01001545{
1546 Py_ssize_t n;
Victor Stinnera3c02022015-03-20 11:58:18 +01001547 int err;
Victor Stinner66aab0c2015-03-19 22:53:20 +01001548 int async_err = 0;
1549
Steve Dower8fc89802015-04-12 00:26:27 -04001550 _Py_BEGIN_SUPPRESS_IPH
Victor Stinner66aab0c2015-03-19 22:53:20 +01001551#ifdef MS_WINDOWS
1552 if (count > 32767 && isatty(fd)) {
1553 /* Issue #11395: the Windows console returns an error (12: not
1554 enough space error) on writing into stdout if stdout mode is
1555 binary and the length is greater than 66,000 bytes (or less,
1556 depending on heap usage). */
1557 count = 32767;
1558 }
Victor Stinner66aab0c2015-03-19 22:53:20 +01001559#endif
Stéphane Wirtel74a8b6e2018-10-18 01:05:04 +02001560 if (count > _PY_WRITE_MAX) {
1561 count = _PY_WRITE_MAX;
1562 }
Victor Stinner66aab0c2015-03-19 22:53:20 +01001563
Victor Stinner82c3e452015-04-01 18:34:45 +02001564 if (gil_held) {
1565 do {
1566 Py_BEGIN_ALLOW_THREADS
1567 errno = 0;
Victor Stinner66aab0c2015-03-19 22:53:20 +01001568#ifdef MS_WINDOWS
Victor Stinner82c3e452015-04-01 18:34:45 +02001569 n = write(fd, buf, (int)count);
Victor Stinner66aab0c2015-03-19 22:53:20 +01001570#else
Victor Stinner82c3e452015-04-01 18:34:45 +02001571 n = write(fd, buf, count);
Victor Stinner66aab0c2015-03-19 22:53:20 +01001572#endif
Victor Stinner82c3e452015-04-01 18:34:45 +02001573 /* save/restore errno because PyErr_CheckSignals()
1574 * and PyErr_SetFromErrno() can modify it */
1575 err = errno;
1576 Py_END_ALLOW_THREADS
1577 } while (n < 0 && err == EINTR &&
1578 !(async_err = PyErr_CheckSignals()));
1579 }
1580 else {
1581 do {
1582 errno = 0;
1583#ifdef MS_WINDOWS
1584 n = write(fd, buf, (int)count);
1585#else
1586 n = write(fd, buf, count);
1587#endif
1588 err = errno;
1589 } while (n < 0 && err == EINTR);
1590 }
Steve Dower8fc89802015-04-12 00:26:27 -04001591 _Py_END_SUPPRESS_IPH
Victor Stinner66aab0c2015-03-19 22:53:20 +01001592
1593 if (async_err) {
1594 /* write() was interrupted by a signal (failed with EINTR)
Victor Stinner82c3e452015-04-01 18:34:45 +02001595 and the Python signal handler raised an exception (if gil_held is
1596 nonzero). */
Victor Stinnera3c02022015-03-20 11:58:18 +01001597 errno = err;
Victor Stinner82c3e452015-04-01 18:34:45 +02001598 assert(errno == EINTR && (!gil_held || PyErr_Occurred()));
Victor Stinner66aab0c2015-03-19 22:53:20 +01001599 return -1;
1600 }
1601 if (n < 0) {
Victor Stinner82c3e452015-04-01 18:34:45 +02001602 if (gil_held)
1603 PyErr_SetFromErrno(PyExc_OSError);
Victor Stinnera3c02022015-03-20 11:58:18 +01001604 errno = err;
Victor Stinner66aab0c2015-03-19 22:53:20 +01001605 return -1;
1606 }
1607
1608 return n;
1609}
1610
Victor Stinner82c3e452015-04-01 18:34:45 +02001611/* Write count bytes of buf into fd.
1612
1613 On success, return the number of written bytes, it can be lower than count
1614 including 0. On error, raise an exception, set errno and return -1.
1615
1616 When interrupted by a signal (write() fails with EINTR), retry the syscall.
1617 If the Python signal handler raises an exception, the function returns -1
1618 (the syscall is not retried).
1619
1620 Release the GIL to call write(). The caller must hold the GIL. */
1621Py_ssize_t
1622_Py_write(int fd, const void *buf, size_t count)
1623{
Victor Stinner8a1be612016-03-14 22:07:55 +01001624 assert(PyGILState_Check());
Victor Stinner8a1be612016-03-14 22:07:55 +01001625
Victor Stinner82c3e452015-04-01 18:34:45 +02001626 /* _Py_write() must not be called with an exception set, otherwise the
1627 * caller may think that write() was interrupted by a signal and the signal
1628 * handler raised an exception. */
1629 assert(!PyErr_Occurred());
1630
1631 return _Py_write_impl(fd, buf, count, 1);
1632}
1633
1634/* Write count bytes of buf into fd.
1635 *
1636 * On success, return the number of written bytes, it can be lower than count
1637 * including 0. On error, set errno and return -1.
1638 *
1639 * When interrupted by a signal (write() fails with EINTR), retry the syscall
1640 * without calling the Python signal handler. */
1641Py_ssize_t
1642_Py_write_noraise(int fd, const void *buf, size_t count)
1643{
1644 return _Py_write_impl(fd, buf, count, 0);
1645}
1646
Victor Stinner4e314432010-10-07 21:45:39 +00001647#ifdef HAVE_READLINK
Victor Stinner6672d0c2010-10-07 22:53:43 +00001648
1649/* Read value of symbolic link. Encode the path to the locale encoding, decode
Victor Stinner1be0d112019-03-18 17:47:26 +01001650 the result from the locale encoding.
Victor Stinner6672d0c2010-10-07 22:53:43 +00001651
Victor Stinner1be0d112019-03-18 17:47:26 +01001652 Return -1 on encoding error, on readlink() error, if the internal buffer is
1653 too short, on decoding error, or if 'buf' is too short. */
Victor Stinner4e314432010-10-07 21:45:39 +00001654int
Victor Stinner1be0d112019-03-18 17:47:26 +01001655_Py_wreadlink(const wchar_t *path, wchar_t *buf, size_t buflen)
Victor Stinner4e314432010-10-07 21:45:39 +00001656{
1657 char *cpath;
Victor Stinnerb11d6cb2013-11-15 18:14:11 +01001658 char cbuf[MAXPATHLEN];
Victor Stinner3f711f42010-10-16 22:47:37 +00001659 wchar_t *wbuf;
Victor Stinner4e314432010-10-07 21:45:39 +00001660 int res;
1661 size_t r1;
1662
Victor Stinner9dd76202017-12-21 16:20:32 +01001663 cpath = _Py_EncodeLocaleRaw(path, NULL);
Victor Stinner4e314432010-10-07 21:45:39 +00001664 if (cpath == NULL) {
1665 errno = EINVAL;
1666 return -1;
1667 }
Victor Stinnerb11d6cb2013-11-15 18:14:11 +01001668 res = (int)readlink(cpath, cbuf, Py_ARRAY_LENGTH(cbuf));
Victor Stinner9dd76202017-12-21 16:20:32 +01001669 PyMem_RawFree(cpath);
Victor Stinner4e314432010-10-07 21:45:39 +00001670 if (res == -1)
1671 return -1;
Victor Stinnerb11d6cb2013-11-15 18:14:11 +01001672 if (res == Py_ARRAY_LENGTH(cbuf)) {
Victor Stinner4e314432010-10-07 21:45:39 +00001673 errno = EINVAL;
1674 return -1;
1675 }
1676 cbuf[res] = '\0'; /* buf will be null terminated */
Victor Stinnerf6a271a2014-08-01 12:28:48 +02001677 wbuf = Py_DecodeLocale(cbuf, &r1);
Victor Stinner350147b2010-10-16 22:52:09 +00001678 if (wbuf == NULL) {
1679 errno = EINVAL;
1680 return -1;
1681 }
Victor Stinner1be0d112019-03-18 17:47:26 +01001682 /* wbuf must have space to store the trailing NUL character */
1683 if (buflen <= r1) {
Victor Stinner1a7425f2013-07-07 16:25:15 +02001684 PyMem_RawFree(wbuf);
Victor Stinner4e314432010-10-07 21:45:39 +00001685 errno = EINVAL;
1686 return -1;
1687 }
Victor Stinner1be0d112019-03-18 17:47:26 +01001688 wcsncpy(buf, wbuf, buflen);
Victor Stinner1a7425f2013-07-07 16:25:15 +02001689 PyMem_RawFree(wbuf);
Victor Stinner4e314432010-10-07 21:45:39 +00001690 return (int)r1;
1691}
1692#endif
1693
1694#ifdef HAVE_REALPATH
Victor Stinner6672d0c2010-10-07 22:53:43 +00001695
1696/* Return the canonicalized absolute pathname. Encode path to the locale
Victor Stinneraf02e1c2011-12-16 23:56:01 +01001697 encoding, decode the result from the locale encoding.
Victor Stinner6672d0c2010-10-07 22:53:43 +00001698
Victor Stinner1be0d112019-03-18 17:47:26 +01001699 Return NULL on encoding error, realpath() error, decoding error
1700 or if 'resolved_path' is too short. */
Victor Stinner4e314432010-10-07 21:45:39 +00001701wchar_t*
Victor Stinner015f4d82010-10-07 22:29:53 +00001702_Py_wrealpath(const wchar_t *path,
Victor Stinner1be0d112019-03-18 17:47:26 +01001703 wchar_t *resolved_path, size_t resolved_path_len)
Victor Stinner4e314432010-10-07 21:45:39 +00001704{
1705 char *cpath;
Victor Stinnerb11d6cb2013-11-15 18:14:11 +01001706 char cresolved_path[MAXPATHLEN];
Victor Stinner0a1b8cb2010-10-16 22:55:47 +00001707 wchar_t *wresolved_path;
Victor Stinner4e314432010-10-07 21:45:39 +00001708 char *res;
1709 size_t r;
Victor Stinner9dd76202017-12-21 16:20:32 +01001710 cpath = _Py_EncodeLocaleRaw(path, NULL);
Victor Stinner4e314432010-10-07 21:45:39 +00001711 if (cpath == NULL) {
1712 errno = EINVAL;
1713 return NULL;
1714 }
1715 res = realpath(cpath, cresolved_path);
Victor Stinner9dd76202017-12-21 16:20:32 +01001716 PyMem_RawFree(cpath);
Victor Stinner4e314432010-10-07 21:45:39 +00001717 if (res == NULL)
1718 return NULL;
Victor Stinner0a1b8cb2010-10-16 22:55:47 +00001719
Victor Stinnerf6a271a2014-08-01 12:28:48 +02001720 wresolved_path = Py_DecodeLocale(cresolved_path, &r);
Victor Stinner0a1b8cb2010-10-16 22:55:47 +00001721 if (wresolved_path == NULL) {
Victor Stinner4e314432010-10-07 21:45:39 +00001722 errno = EINVAL;
1723 return NULL;
1724 }
Victor Stinner1be0d112019-03-18 17:47:26 +01001725 /* wresolved_path must have space to store the trailing NUL character */
1726 if (resolved_path_len <= r) {
Victor Stinner1a7425f2013-07-07 16:25:15 +02001727 PyMem_RawFree(wresolved_path);
Victor Stinner0a1b8cb2010-10-16 22:55:47 +00001728 errno = EINVAL;
1729 return NULL;
1730 }
Victor Stinner1be0d112019-03-18 17:47:26 +01001731 wcsncpy(resolved_path, wresolved_path, resolved_path_len);
Victor Stinner1a7425f2013-07-07 16:25:15 +02001732 PyMem_RawFree(wresolved_path);
Victor Stinner4e314432010-10-07 21:45:39 +00001733 return resolved_path;
1734}
1735#endif
1736
Victor Stinnerfaddaed2019-03-19 02:58:14 +01001737/* Get the current directory. buflen is the buffer size in wide characters
Victor Stinneraf02e1c2011-12-16 23:56:01 +01001738 including the null character. Decode the path from the locale encoding.
Victor Stinner6672d0c2010-10-07 22:53:43 +00001739
Victor Stinner1be0d112019-03-18 17:47:26 +01001740 Return NULL on getcwd() error, on decoding error, or if 'buf' is
1741 too short. */
Victor Stinner4e314432010-10-07 21:45:39 +00001742wchar_t*
Victor Stinner1be0d112019-03-18 17:47:26 +01001743_Py_wgetcwd(wchar_t *buf, size_t buflen)
Victor Stinner4e314432010-10-07 21:45:39 +00001744{
1745#ifdef MS_WINDOWS
Victor Stinner1be0d112019-03-18 17:47:26 +01001746 int ibuflen = (int)Py_MIN(buflen, INT_MAX);
1747 return _wgetcwd(buf, ibuflen);
Victor Stinner4e314432010-10-07 21:45:39 +00001748#else
Victor Stinnerb11d6cb2013-11-15 18:14:11 +01001749 char fname[MAXPATHLEN];
Victor Stinnerf4061da2010-10-14 12:37:19 +00001750 wchar_t *wname;
Victor Stinner168e1172010-10-16 23:16:16 +00001751 size_t len;
Victor Stinnerf4061da2010-10-14 12:37:19 +00001752
Victor Stinnerb11d6cb2013-11-15 18:14:11 +01001753 if (getcwd(fname, Py_ARRAY_LENGTH(fname)) == NULL)
Victor Stinner4e314432010-10-07 21:45:39 +00001754 return NULL;
Victor Stinnerf6a271a2014-08-01 12:28:48 +02001755 wname = Py_DecodeLocale(fname, &len);
Victor Stinnerf4061da2010-10-14 12:37:19 +00001756 if (wname == NULL)
1757 return NULL;
Victor Stinner1be0d112019-03-18 17:47:26 +01001758 /* wname must have space to store the trailing NUL character */
1759 if (buflen <= len) {
Victor Stinner1a7425f2013-07-07 16:25:15 +02001760 PyMem_RawFree(wname);
Victor Stinner4e314432010-10-07 21:45:39 +00001761 return NULL;
1762 }
Victor Stinner1be0d112019-03-18 17:47:26 +01001763 wcsncpy(buf, wname, buflen);
Victor Stinner1a7425f2013-07-07 16:25:15 +02001764 PyMem_RawFree(wname);
Victor Stinner4e314432010-10-07 21:45:39 +00001765 return buf;
1766#endif
1767}
1768
Victor Stinnerdaf45552013-08-28 00:53:59 +02001769/* Duplicate a file descriptor. The new file descriptor is created as
1770 non-inheritable. Return a new file descriptor on success, raise an OSError
1771 exception and return -1 on error.
1772
1773 The GIL is released to call dup(). The caller must hold the GIL. */
1774int
1775_Py_dup(int fd)
1776{
1777#ifdef MS_WINDOWS
1778 HANDLE handle;
Victor Stinnerdaf45552013-08-28 00:53:59 +02001779#endif
1780
Victor Stinner8a1be612016-03-14 22:07:55 +01001781 assert(PyGILState_Check());
Victor Stinner8a1be612016-03-14 22:07:55 +01001782
Victor Stinnerdaf45552013-08-28 00:53:59 +02001783#ifdef MS_WINDOWS
Steve Dower8fc89802015-04-12 00:26:27 -04001784 _Py_BEGIN_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02001785 handle = (HANDLE)_get_osfhandle(fd);
Steve Dower8fc89802015-04-12 00:26:27 -04001786 _Py_END_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02001787 if (handle == INVALID_HANDLE_VALUE) {
Steve Dower41e72442015-03-14 11:38:27 -07001788 PyErr_SetFromErrno(PyExc_OSError);
Victor Stinnerdaf45552013-08-28 00:53:59 +02001789 return -1;
1790 }
1791
Victor Stinnerdaf45552013-08-28 00:53:59 +02001792 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04001793 _Py_BEGIN_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02001794 fd = dup(fd);
Steve Dower8fc89802015-04-12 00:26:27 -04001795 _Py_END_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02001796 Py_END_ALLOW_THREADS
1797 if (fd < 0) {
1798 PyErr_SetFromErrno(PyExc_OSError);
1799 return -1;
1800 }
1801
Miss Islington (bot)693945d2019-06-17 01:45:26 -07001802 if (_Py_set_inheritable(fd, 0, NULL) < 0) {
1803 _Py_BEGIN_SUPPRESS_IPH
1804 close(fd);
1805 _Py_END_SUPPRESS_IPH
1806 return -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +02001807 }
1808#elif defined(HAVE_FCNTL_H) && defined(F_DUPFD_CLOEXEC)
1809 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04001810 _Py_BEGIN_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02001811 fd = fcntl(fd, F_DUPFD_CLOEXEC, 0);
Steve Dower8fc89802015-04-12 00:26:27 -04001812 _Py_END_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02001813 Py_END_ALLOW_THREADS
1814 if (fd < 0) {
1815 PyErr_SetFromErrno(PyExc_OSError);
1816 return -1;
1817 }
1818
1819#else
1820 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04001821 _Py_BEGIN_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02001822 fd = dup(fd);
Steve Dower8fc89802015-04-12 00:26:27 -04001823 _Py_END_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02001824 Py_END_ALLOW_THREADS
1825 if (fd < 0) {
1826 PyErr_SetFromErrno(PyExc_OSError);
1827 return -1;
1828 }
1829
1830 if (_Py_set_inheritable(fd, 0, NULL) < 0) {
Steve Dower8fc89802015-04-12 00:26:27 -04001831 _Py_BEGIN_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02001832 close(fd);
Steve Dower8fc89802015-04-12 00:26:27 -04001833 _Py_END_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02001834 return -1;
1835 }
1836#endif
1837 return fd;
1838}
1839
Victor Stinner1db9e7b2014-07-29 22:32:47 +02001840#ifndef MS_WINDOWS
1841/* Get the blocking mode of the file descriptor.
1842 Return 0 if the O_NONBLOCK flag is set, 1 if the flag is cleared,
1843 raise an exception and return -1 on error. */
1844int
1845_Py_get_blocking(int fd)
1846{
Steve Dower8fc89802015-04-12 00:26:27 -04001847 int flags;
1848 _Py_BEGIN_SUPPRESS_IPH
1849 flags = fcntl(fd, F_GETFL, 0);
1850 _Py_END_SUPPRESS_IPH
Victor Stinner1db9e7b2014-07-29 22:32:47 +02001851 if (flags < 0) {
1852 PyErr_SetFromErrno(PyExc_OSError);
1853 return -1;
1854 }
1855
1856 return !(flags & O_NONBLOCK);
1857}
1858
1859/* Set the blocking mode of the specified file descriptor.
1860
1861 Set the O_NONBLOCK flag if blocking is False, clear the O_NONBLOCK flag
1862 otherwise.
1863
1864 Return 0 on success, raise an exception and return -1 on error. */
1865int
1866_Py_set_blocking(int fd, int blocking)
1867{
1868#if defined(HAVE_SYS_IOCTL_H) && defined(FIONBIO)
1869 int arg = !blocking;
1870 if (ioctl(fd, FIONBIO, &arg) < 0)
1871 goto error;
1872#else
1873 int flags, res;
1874
Steve Dower8fc89802015-04-12 00:26:27 -04001875 _Py_BEGIN_SUPPRESS_IPH
Victor Stinner1db9e7b2014-07-29 22:32:47 +02001876 flags = fcntl(fd, F_GETFL, 0);
Steve Dower8fc89802015-04-12 00:26:27 -04001877 if (flags >= 0) {
1878 if (blocking)
1879 flags = flags & (~O_NONBLOCK);
1880 else
1881 flags = flags | O_NONBLOCK;
Victor Stinner1db9e7b2014-07-29 22:32:47 +02001882
Steve Dower8fc89802015-04-12 00:26:27 -04001883 res = fcntl(fd, F_SETFL, flags);
1884 } else {
1885 res = -1;
1886 }
1887 _Py_END_SUPPRESS_IPH
Victor Stinner1db9e7b2014-07-29 22:32:47 +02001888
Victor Stinner1db9e7b2014-07-29 22:32:47 +02001889 if (res < 0)
1890 goto error;
1891#endif
1892 return 0;
1893
1894error:
1895 PyErr_SetFromErrno(PyExc_OSError);
1896 return -1;
1897}
1898#endif
Victor Stinnercb064fc2018-01-15 15:58:02 +01001899
1900
1901int
Victor Stinner02e6bf72018-11-20 16:20:16 +01001902_Py_GetLocaleconvNumeric(struct lconv *lc,
1903 PyObject **decimal_point, PyObject **thousands_sep)
Victor Stinnercb064fc2018-01-15 15:58:02 +01001904{
Victor Stinner02e6bf72018-11-20 16:20:16 +01001905 assert(decimal_point != NULL);
1906 assert(thousands_sep != NULL);
Victor Stinnercb064fc2018-01-15 15:58:02 +01001907
1908 int change_locale = 0;
Victor Stinner02e6bf72018-11-20 16:20:16 +01001909 if ((strlen(lc->decimal_point) > 1 || ((unsigned char)lc->decimal_point[0]) > 127)) {
Victor Stinnercb064fc2018-01-15 15:58:02 +01001910 change_locale = 1;
1911 }
Victor Stinner02e6bf72018-11-20 16:20:16 +01001912 if ((strlen(lc->thousands_sep) > 1 || ((unsigned char)lc->thousands_sep[0]) > 127)) {
Victor Stinnercb064fc2018-01-15 15:58:02 +01001913 change_locale = 1;
1914 }
1915
1916 /* Keep a copy of the LC_CTYPE locale */
1917 char *oldloc = NULL, *loc = NULL;
1918 if (change_locale) {
1919 oldloc = setlocale(LC_CTYPE, NULL);
1920 if (!oldloc) {
Victor Stinner02e6bf72018-11-20 16:20:16 +01001921 PyErr_SetString(PyExc_RuntimeWarning,
1922 "failed to get LC_CTYPE locale");
Victor Stinnercb064fc2018-01-15 15:58:02 +01001923 return -1;
1924 }
1925
1926 oldloc = _PyMem_Strdup(oldloc);
1927 if (!oldloc) {
1928 PyErr_NoMemory();
1929 return -1;
1930 }
1931
1932 loc = setlocale(LC_NUMERIC, NULL);
1933 if (loc != NULL && strcmp(loc, oldloc) == 0) {
1934 loc = NULL;
1935 }
1936
1937 if (loc != NULL) {
Victor Stinner02e6bf72018-11-20 16:20:16 +01001938 /* Only set the locale temporarily the LC_CTYPE locale
Victor Stinnercb064fc2018-01-15 15:58:02 +01001939 if LC_NUMERIC locale is different than LC_CTYPE locale and
1940 decimal_point and/or thousands_sep are non-ASCII or longer than
1941 1 byte */
1942 setlocale(LC_CTYPE, loc);
1943 }
1944 }
1945
Victor Stinner02e6bf72018-11-20 16:20:16 +01001946 int res = -1;
1947
1948 *decimal_point = PyUnicode_DecodeLocale(lc->decimal_point, NULL);
1949 if (*decimal_point == NULL) {
1950 goto done;
Victor Stinnercb064fc2018-01-15 15:58:02 +01001951 }
1952
Victor Stinner02e6bf72018-11-20 16:20:16 +01001953 *thousands_sep = PyUnicode_DecodeLocale(lc->thousands_sep, NULL);
1954 if (*thousands_sep == NULL) {
1955 goto done;
Victor Stinnercb064fc2018-01-15 15:58:02 +01001956 }
1957
1958 res = 0;
1959
Victor Stinner02e6bf72018-11-20 16:20:16 +01001960done:
Victor Stinnercb064fc2018-01-15 15:58:02 +01001961 if (loc != NULL) {
1962 setlocale(LC_CTYPE, oldloc);
1963 }
1964 PyMem_Free(oldloc);
1965 return res;
1966}