blob: afb6d183077a1f4fd17acbfa45b709d2ec9cfe0c [file] [log] [blame]
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001/* POSIX module implementation */
2
Jesus Ceaab70e2a2012-10-05 01:48:08 +02003/* This file is also used for Windows NT/MS-Win. In that case the
4 module actually calls itself 'nt', not 'posix', and a few
Andrew MacIntyre6c73af22002-03-03 03:07:07 +00005 functions are either unimplemented or implemented differently. The source
Martin v. Löwis6238d2b2002-06-30 15:26:10 +00006 assumes that for Windows NT, the macro 'MS_WINDOWS' is defined independent
Guido van Rossumad0ee831995-03-01 10:34:45 +00007 of the compiler used. Different compilers define their own feature
Victor Stinnerf427a142014-10-22 12:33:23 +02008 test macro, e.g. '_MSC_VER'. */
Guido van Rossumad0ee831995-03-01 10:34:45 +00009
Thomas Wouters477c8d52006-05-27 19:21:47 +000010#ifdef __APPLE__
11 /*
Victor Stinner8c62be82010-05-06 00:08:46 +000012 * Step 1 of support for weak-linking a number of symbols existing on
Thomas Wouters477c8d52006-05-27 19:21:47 +000013 * OSX 10.4 and later, see the comment in the #ifdef __APPLE__ block
14 * at the end of this file for more information.
15 */
16# pragma weak lchown
17# pragma weak statvfs
18# pragma weak fstatvfs
19
20#endif /* __APPLE__ */
21
Thomas Wouters68bc4f92006-03-01 01:05:10 +000022#define PY_SSIZE_T_CLEAN
23
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000024#include "Python.h"
Victor Stinnerd5d9e812019-05-13 12:35:37 +020025#ifdef MS_WINDOWS
26 /* include <windows.h> early to avoid conflict with pycore_condvar.h:
27
28 #define WIN32_LEAN_AND_MEAN
29 #include <windows.h>
30
31 FSCTL_GET_REPARSE_POINT is not exported with WIN32_LEAN_AND_MEAN. */
32# include <windows.h>
33#endif
34
Victor Stinner4a21e572020-04-15 02:35:41 +020035#include "pycore_ceval.h" // _PyEval_ReInitThreads()
36#include "pycore_import.h" // _PyImport_ReInitLock()
Victor Stinner26881c82020-06-02 15:51:37 +020037#include "pycore_initconfig.h" // _PyStatus_EXCEPTION()
Victor Stinner4a21e572020-04-15 02:35:41 +020038#include "pycore_pystate.h" // _PyInterpreterState_GET()
39#include "structmember.h" // PyMemberDef
Serhiy Storchaka7cf55992013-02-10 21:56:49 +020040#ifndef MS_WINDOWS
Victor Stinnerd5d9e812019-05-13 12:35:37 +020041# include "posixmodule.h"
Tim Golden0321cf22014-05-05 19:46:17 +010042#else
Victor Stinnerd5d9e812019-05-13 12:35:37 +020043# include "winreparse.h"
Serhiy Storchaka7cf55992013-02-10 21:56:49 +020044#endif
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000045
Stefan Krahfb7c8ae2016-04-26 17:04:18 +020046/* On android API level 21, 'AT_EACCESS' is not declared although
47 * HAVE_FACCESSAT is defined. */
48#ifdef __ANDROID__
Victor Stinner5eca75d2020-04-15 15:07:31 +020049# undef HAVE_FACCESSAT
Stefan Krahfb7c8ae2016-04-26 17:04:18 +020050#endif
51
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D)fa76eee2016-05-28 21:03:48 +000052#include <stdio.h> /* needed for ctermid() */
53
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000054#ifdef __cplusplus
55extern "C" {
56#endif
57
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000058PyDoc_STRVAR(posix__doc__,
Guido van Rossumec4f4ac1997-06-02 22:20:51 +000059"This module provides access to operating system functionality that is\n\
60standardized by the C Standard and the POSIX standard (a thinly\n\
61disguised Unix interface). Refer to the library manual and\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000062corresponding Unix manual entries for more information on calls.");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000063
Martin v. Löwis0073f2e2002-11-21 23:52:35 +000064
Ross Lagerwall4d076da2011-03-18 06:56:53 +020065#ifdef HAVE_SYS_UIO_H
Victor Stinner5eca75d2020-04-15 15:07:31 +020066# include <sys/uio.h>
Ross Lagerwall4d076da2011-03-18 06:56:53 +020067#endif
68
Christian Heimes75b96182017-09-05 15:53:09 +020069#ifdef HAVE_SYS_SYSMACROS_H
70/* GNU C Library: major(), minor(), makedev() */
Victor Stinner5eca75d2020-04-15 15:07:31 +020071# include <sys/sysmacros.h>
Christian Heimes75b96182017-09-05 15:53:09 +020072#endif
73
Thomas Wouters0e3f5912006-08-11 14:57:12 +000074#ifdef HAVE_SYS_TYPES_H
Victor Stinner5eca75d2020-04-15 15:07:31 +020075# include <sys/types.h>
Thomas Wouters0e3f5912006-08-11 14:57:12 +000076#endif /* HAVE_SYS_TYPES_H */
77
78#ifdef HAVE_SYS_STAT_H
Victor Stinner5eca75d2020-04-15 15:07:31 +020079# include <sys/stat.h>
Thomas Wouters0e3f5912006-08-11 14:57:12 +000080#endif /* HAVE_SYS_STAT_H */
Guido van Rossuma6535fd2001-10-18 19:44:10 +000081
Guido van Rossum36bc6801995-06-14 22:54:23 +000082#ifdef HAVE_SYS_WAIT_H
Victor Stinner5eca75d2020-04-15 15:07:31 +020083# include <sys/wait.h> // WNOHANG
Guido van Rossum36bc6801995-06-14 22:54:23 +000084#endif
Benjamin Peterson5c0c3252019-11-05 21:58:31 -080085#ifdef HAVE_LINUX_WAIT_H
Victor Stinner5eca75d2020-04-15 15:07:31 +020086# include <linux/wait.h> // P_PIDFD
Benjamin Peterson5c0c3252019-11-05 21:58:31 -080087#endif
Guido van Rossumb6775db1994-08-01 11:34:53 +000088
Thomas Wouters0e3f5912006-08-11 14:57:12 +000089#ifdef HAVE_SIGNAL_H
Victor Stinner5eca75d2020-04-15 15:07:31 +020090# include <signal.h>
Thomas Wouters0e3f5912006-08-11 14:57:12 +000091#endif
Guido van Rossuma376cc51996-12-05 23:43:35 +000092
Guido van Rossumb6775db1994-08-01 11:34:53 +000093#ifdef HAVE_FCNTL_H
Victor Stinner5eca75d2020-04-15 15:07:31 +020094# include <fcntl.h>
95#endif
Guido van Rossumb6775db1994-08-01 11:34:53 +000096
Guido van Rossuma6535fd2001-10-18 19:44:10 +000097#ifdef HAVE_GRP_H
Victor Stinner5eca75d2020-04-15 15:07:31 +020098# include <grp.h>
Guido van Rossuma6535fd2001-10-18 19:44:10 +000099#endif
100
Barry Warsaw5676bd12003-01-07 20:57:09 +0000101#ifdef HAVE_SYSEXITS_H
Victor Stinner5eca75d2020-04-15 15:07:31 +0200102# include <sysexits.h>
103#endif
Barry Warsaw5676bd12003-01-07 20:57:09 +0000104
Anthony Baxter8a560de2004-10-13 15:30:56 +0000105#ifdef HAVE_SYS_LOADAVG_H
Victor Stinner5eca75d2020-04-15 15:07:31 +0200106# include <sys/loadavg.h>
Anthony Baxter8a560de2004-10-13 15:30:56 +0000107#endif
108
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +0000109#ifdef HAVE_SYS_SENDFILE_H
Victor Stinner5eca75d2020-04-15 15:07:31 +0200110# include <sys/sendfile.h>
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +0000111#endif
112
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +0200113#if defined(__APPLE__)
Victor Stinner5eca75d2020-04-15 15:07:31 +0200114# include <copyfile.h>
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +0200115#endif
116
Benjamin Peterson94b580d2011-08-02 17:30:04 -0500117#ifdef HAVE_SCHED_H
Victor Stinner5eca75d2020-04-15 15:07:31 +0200118# include <sched.h>
Benjamin Peterson94b580d2011-08-02 17:30:04 -0500119#endif
120
Pablo Galindoaac4d032019-05-31 19:39:47 +0100121#ifdef HAVE_COPY_FILE_RANGE
Victor Stinner5eca75d2020-04-15 15:07:31 +0200122# include <unistd.h>
Pablo Galindoaac4d032019-05-31 19:39:47 +0100123#endif
124
Benjamin Peterson2dbda072012-03-16 10:12:55 -0500125#if !defined(CPU_ALLOC) && defined(HAVE_SCHED_SETAFFINITY)
Victor Stinner5eca75d2020-04-15 15:07:31 +0200126# undef HAVE_SCHED_SETAFFINITY
Benjamin Peterson7b51b8d2012-03-14 22:28:25 -0500127#endif
128
doko@ubuntu.com4a173bc2014-04-17 19:47:16 +0200129#if defined(HAVE_SYS_XATTR_H) && defined(__GLIBC__) && !defined(__FreeBSD_kernel__) && !defined(__GNU__)
Victor Stinner5eca75d2020-04-15 15:07:31 +0200130# define USE_XATTRS
Benjamin Peterson9428d532011-09-14 11:45:52 -0400131#endif
132
133#ifdef USE_XATTRS
Victor Stinner5eca75d2020-04-15 15:07:31 +0200134# include <sys/xattr.h>
Benjamin Peterson799bd802011-08-31 22:15:17 -0400135#endif
136
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +0000137#if defined(__FreeBSD__) || defined(__DragonFly__) || defined(__APPLE__)
Victor Stinner5eca75d2020-04-15 15:07:31 +0200138# ifdef HAVE_SYS_SOCKET_H
139# include <sys/socket.h>
140# endif
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +0000141#endif
142
Victor Stinner8b905bd2011-10-25 13:34:04 +0200143#ifdef HAVE_DLFCN_H
Victor Stinner5eca75d2020-04-15 15:07:31 +0200144# include <dlfcn.h>
Victor Stinner8b905bd2011-10-25 13:34:04 +0200145#endif
146
Charles-Francois Natali44feda32013-05-20 14:40:46 +0200147#ifdef __hpux
Victor Stinner5eca75d2020-04-15 15:07:31 +0200148# include <sys/mpctl.h>
Charles-Francois Natali44feda32013-05-20 14:40:46 +0200149#endif
150
151#if defined(__DragonFly__) || \
152 defined(__OpenBSD__) || \
153 defined(__FreeBSD__) || \
154 defined(__NetBSD__) || \
155 defined(__APPLE__)
Victor Stinner5eca75d2020-04-15 15:07:31 +0200156# include <sys/sysctl.h>
Charles-Francois Natali44feda32013-05-20 14:40:46 +0200157#endif
158
Victor Stinner9b1f4742016-09-06 16:18:52 -0700159#ifdef HAVE_LINUX_RANDOM_H
160# include <linux/random.h>
161#endif
162#ifdef HAVE_GETRANDOM_SYSCALL
163# include <sys/syscall.h>
164#endif
165
Antoine Pitroubcf2b592012-02-08 23:28:36 +0100166#if defined(MS_WINDOWS)
167# define TERMSIZE_USE_CONIO
168#elif defined(HAVE_SYS_IOCTL_H)
169# include <sys/ioctl.h>
170# if defined(HAVE_TERMIOS_H)
171# include <termios.h>
172# endif
173# if defined(TIOCGWINSZ)
174# define TERMSIZE_USE_IOCTL
175# endif
176#endif /* MS_WINDOWS */
177
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000178/* Various compilers have only certain posix functions */
Martin v. Löwis4f1cd8b2001-07-26 13:41:06 +0000179/* XXX Gosh I wish these were all moved into pyconfig.h */
Victor Stinner8c62be82010-05-06 00:08:46 +0000180#if defined(__WATCOMC__) && !defined(__QNX__) /* Watcom compiler */
Victor Stinner5eca75d2020-04-15 15:07:31 +0200181# define HAVE_OPENDIR 1
182# define HAVE_SYSTEM 1
183# include <process.h>
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000184#else
Victor Stinner5eca75d2020-04-15 15:07:31 +0200185# ifdef _MSC_VER
186 /* Microsoft compiler */
187# define HAVE_GETPPID 1
188# define HAVE_GETLOGIN 1
189# define HAVE_SPAWNV 1
190# define HAVE_EXECV 1
191# define HAVE_WSPAWNV 1
192# define HAVE_WEXECV 1
193# define HAVE_PIPE 1
194# define HAVE_SYSTEM 1
195# define HAVE_CWAIT 1
196# define HAVE_FSYNC 1
197# define fsync _commit
198# else
199 /* Unix functions that the configure script doesn't check for */
200# ifndef __VXWORKS__
201# define HAVE_EXECV 1
202# define HAVE_FORK 1
203# if defined(__USLC__) && defined(__SCO_VERSION__) /* SCO UDK Compiler */
204# define HAVE_FORK1 1
205# endif
206# endif
207# define HAVE_GETEGID 1
208# define HAVE_GETEUID 1
209# define HAVE_GETGID 1
210# define HAVE_GETPPID 1
211# define HAVE_GETUID 1
212# define HAVE_KILL 1
213# define HAVE_OPENDIR 1
214# define HAVE_PIPE 1
215# define HAVE_SYSTEM 1
216# define HAVE_WAIT 1
217# define HAVE_TTYNAME 1
218# endif /* _MSC_VER */
Guido van Rossumc5a0f531997-12-02 20:36:02 +0000219#endif /* ! __WATCOMC__ || __QNX__ */
Guido van Rossumad0ee831995-03-01 10:34:45 +0000220
Eddie Elizondob3966632019-11-05 07:16:14 -0800221_Py_IDENTIFIER(__fspath__);
Victor Stinnera2f7c002012-02-08 03:36:25 +0100222
Larry Hastings61272b72014-01-07 12:41:53 -0800223/*[clinic input]
Larry Hastings2f936352014-08-05 14:04:04 +1000224# one of the few times we lie about this name!
Larry Hastings44e2eaa2013-11-23 15:37:55 -0800225module os
Larry Hastings61272b72014-01-07 12:41:53 -0800226[clinic start generated code]*/
Larry Hastings2f936352014-08-05 14:04:04 +1000227/*[clinic end generated code: output=da39a3ee5e6b4b0d input=94a0f0f978acae17]*/
Victor Stinnera2f7c002012-02-08 03:36:25 +0100228
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000229#ifndef _MSC_VER
Guido van Rossum36bc6801995-06-14 22:54:23 +0000230
Martin v. Löwis8eb92a02002-09-19 08:03:21 +0000231#if defined(__sgi)&&_COMPILER_VERSION>=700
232/* declare ctermid_r if compiling with MIPSPro 7.x in ANSI C mode
233 (default) */
234extern char *ctermid_r(char *);
235#endif
236
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000237#endif /* !_MSC_VER */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000238
pxinwrf2d7ac72019-05-21 18:46:37 +0800239#if defined(__VXWORKS__)
Victor Stinner5eca75d2020-04-15 15:07:31 +0200240# include <vxCpuLib.h>
241# include <rtpLib.h>
242# include <wait.h>
243# include <taskLib.h>
244# ifndef _P_WAIT
245# define _P_WAIT 0
246# define _P_NOWAIT 1
247# define _P_NOWAITO 1
248# endif
pxinwrf2d7ac72019-05-21 18:46:37 +0800249#endif /* __VXWORKS__ */
250
Pablo Galindo6c6ddf92018-01-29 01:56:10 +0000251#ifdef HAVE_POSIX_SPAWN
Victor Stinner5eca75d2020-04-15 15:07:31 +0200252# include <spawn.h>
Pablo Galindo6c6ddf92018-01-29 01:56:10 +0000253#endif
254
Guido van Rossumb6775db1994-08-01 11:34:53 +0000255#ifdef HAVE_UTIME_H
Victor Stinner5eca75d2020-04-15 15:07:31 +0200256# include <utime.h>
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +0000257#endif /* HAVE_UTIME_H */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000258
Guido van Rossum14ed0b21994-09-29 09:50:09 +0000259#ifdef HAVE_SYS_UTIME_H
Victor Stinner5eca75d2020-04-15 15:07:31 +0200260# include <sys/utime.h>
261# define HAVE_UTIME_H /* pretend we do for the rest of this file */
Guido van Rossum14ed0b21994-09-29 09:50:09 +0000262#endif /* HAVE_SYS_UTIME_H */
263
Guido van Rossumb6775db1994-08-01 11:34:53 +0000264#ifdef HAVE_SYS_TIMES_H
Victor Stinner5eca75d2020-04-15 15:07:31 +0200265# include <sys/times.h>
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +0000266#endif /* HAVE_SYS_TIMES_H */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000267
268#ifdef HAVE_SYS_PARAM_H
Victor Stinner5eca75d2020-04-15 15:07:31 +0200269# include <sys/param.h>
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +0000270#endif /* HAVE_SYS_PARAM_H */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000271
272#ifdef HAVE_SYS_UTSNAME_H
Victor Stinner5eca75d2020-04-15 15:07:31 +0200273# include <sys/utsname.h>
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +0000274#endif /* HAVE_SYS_UTSNAME_H */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000275
Guido van Rossum3bbc62e1995-01-02 19:30:30 +0000276#ifdef HAVE_DIRENT_H
Victor Stinner5eca75d2020-04-15 15:07:31 +0200277# include <dirent.h>
278# define NAMLEN(dirent) strlen((dirent)->d_name)
Guido van Rossum3bbc62e1995-01-02 19:30:30 +0000279#else
Victor Stinner5eca75d2020-04-15 15:07:31 +0200280# if defined(__WATCOMC__) && !defined(__QNX__)
281# include <direct.h>
282# define NAMLEN(dirent) strlen((dirent)->d_name)
283# else
284# define dirent direct
285# define NAMLEN(dirent) (dirent)->d_namlen
286# endif
287# ifdef HAVE_SYS_NDIR_H
288# include <sys/ndir.h>
289# endif
290# ifdef HAVE_SYS_DIR_H
291# include <sys/dir.h>
292# endif
293# ifdef HAVE_NDIR_H
294# include <ndir.h>
295# endif
Guido van Rossum3bbc62e1995-01-02 19:30:30 +0000296#endif
Guido van Rossumb6775db1994-08-01 11:34:53 +0000297
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000298#ifdef _MSC_VER
Victor Stinner5eca75d2020-04-15 15:07:31 +0200299# ifdef HAVE_DIRECT_H
300# include <direct.h>
301# endif
302# ifdef HAVE_IO_H
303# include <io.h>
304# endif
305# ifdef HAVE_PROCESS_H
306# include <process.h>
307# endif
308# ifndef IO_REPARSE_TAG_SYMLINK
309# define IO_REPARSE_TAG_SYMLINK (0xA000000CL)
310# endif
311# ifndef IO_REPARSE_TAG_MOUNT_POINT
312# define IO_REPARSE_TAG_MOUNT_POINT (0xA0000003L)
313# endif
314# include "osdefs.h" // SEP
315# include <malloc.h>
316# include <windows.h>
317# include <shellapi.h> // ShellExecute()
318# include <lmcons.h> // UNLEN
319# define HAVE_SYMLINK
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000320#endif /* _MSC_VER */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000321
Tim Petersbc2e10e2002-03-03 23:17:02 +0000322#ifndef MAXPATHLEN
Victor Stinner5eca75d2020-04-15 15:07:31 +0200323# if defined(PATH_MAX) && PATH_MAX > 1024
324# define MAXPATHLEN PATH_MAX
325# else
326# define MAXPATHLEN 1024
327# endif
Tim Petersbc2e10e2002-03-03 23:17:02 +0000328#endif /* MAXPATHLEN */
329
Guido van Rossum54ecc3d1999-01-27 17:53:11 +0000330#ifdef UNION_WAIT
Victor Stinner5eca75d2020-04-15 15:07:31 +0200331 /* Emulate some macros on systems that have a union instead of macros */
332# ifndef WIFEXITED
333# define WIFEXITED(u_wait) (!(u_wait).w_termsig && !(u_wait).w_coredump)
334# endif
335# ifndef WEXITSTATUS
336# define WEXITSTATUS(u_wait) (WIFEXITED(u_wait)?((u_wait).w_retcode):-1)
337# endif
338# ifndef WTERMSIG
339# define WTERMSIG(u_wait) ((u_wait).w_termsig)
340# endif
341# define WAIT_TYPE union wait
342# define WAIT_STATUS_INT(s) (s.w_status)
343#else
344 /* !UNION_WAIT */
345# define WAIT_TYPE int
346# define WAIT_STATUS_INT(s) (s)
Guido van Rossum54ecc3d1999-01-27 17:53:11 +0000347#endif /* UNION_WAIT */
348
Greg Wardb48bc172000-03-01 21:51:56 +0000349/* Don't use the "_r" form if we don't need it (also, won't have a
350 prototype for it, at least on Solaris -- maybe others as well?). */
Antoine Pitroua6a4dc82017-09-07 18:56:24 +0200351#if defined(HAVE_CTERMID_R)
Victor Stinner5eca75d2020-04-15 15:07:31 +0200352# define USE_CTERMID_R
Greg Wardb48bc172000-03-01 21:51:56 +0000353#endif
354
Fred Drake699f3522000-06-29 21:12:41 +0000355/* choose the appropriate stat and fstat functions and return structs */
Guido van Rossum64529cd2000-06-30 22:45:12 +0000356#undef STAT
Antoine Pitroue47e0932011-01-19 15:21:35 +0000357#undef FSTAT
358#undef STRUCT_STAT
Victor Stinner14b9b112013-06-25 00:37:25 +0200359#ifdef MS_WINDOWS
Victor Stinner5eca75d2020-04-15 15:07:31 +0200360# define STAT win32_stat
361# define LSTAT win32_lstat
362# define FSTAT _Py_fstat_noraise
363# define STRUCT_STAT struct _Py_stat_struct
Fred Drake699f3522000-06-29 21:12:41 +0000364#else
Victor Stinner5eca75d2020-04-15 15:07:31 +0200365# define STAT stat
366# define LSTAT lstat
367# define FSTAT fstat
368# define STRUCT_STAT struct stat
Fred Drake699f3522000-06-29 21:12:41 +0000369#endif
370
Tim Peters11b23062003-04-23 02:39:17 +0000371#if defined(MAJOR_IN_MKDEV)
Victor Stinner5eca75d2020-04-15 15:07:31 +0200372# include <sys/mkdev.h>
Martin v. Löwisdbe3f762002-10-10 14:27:30 +0000373#else
Victor Stinner5eca75d2020-04-15 15:07:31 +0200374# if defined(MAJOR_IN_SYSMACROS)
375# include <sys/sysmacros.h>
376# endif
377# if defined(HAVE_MKNOD) && defined(HAVE_SYS_MKDEV_H)
378# include <sys/mkdev.h>
379# endif
Martin v. Löwisdbe3f762002-10-10 14:27:30 +0000380#endif
Fred Drake699f3522000-06-29 21:12:41 +0000381
Serhiy Storchaka06a13f82015-02-22 21:34:54 +0200382#ifdef MS_WINDOWS
Victor Stinner5eca75d2020-04-15 15:07:31 +0200383# define INITFUNC PyInit_nt
384# define MODNAME "nt"
Victor Stinner6036e442015-03-08 01:58:04 +0100385#else
Victor Stinner5eca75d2020-04-15 15:07:31 +0200386# define INITFUNC PyInit_posix
387# define MODNAME "posix"
Victor Stinner6036e442015-03-08 01:58:04 +0100388#endif
389
jcea6c51d512018-01-28 14:00:08 +0100390#if defined(__sun)
391/* Something to implement in autoconf, not present in autoconf 2.69 */
Victor Stinner5eca75d2020-04-15 15:07:31 +0200392# define HAVE_STRUCT_STAT_ST_FSTYPE 1
jcea6c51d512018-01-28 14:00:08 +0100393#endif
Antoine Pitrou346cbd32017-05-27 17:50:54 +0200394
Zackery Spytz43fdbd22019-05-29 13:57:07 -0600395/* memfd_create is either defined in sys/mman.h or sys/memfd.h
396 * linux/memfd.h defines additional flags
397 */
398#ifdef HAVE_SYS_MMAN_H
Victor Stinner5eca75d2020-04-15 15:07:31 +0200399# include <sys/mman.h>
Zackery Spytz43fdbd22019-05-29 13:57:07 -0600400#endif
401#ifdef HAVE_SYS_MEMFD_H
Victor Stinner5eca75d2020-04-15 15:07:31 +0200402# include <sys/memfd.h>
Zackery Spytz43fdbd22019-05-29 13:57:07 -0600403#endif
404#ifdef HAVE_LINUX_MEMFD_H
Victor Stinner5eca75d2020-04-15 15:07:31 +0200405# include <linux/memfd.h>
Zackery Spytz43fdbd22019-05-29 13:57:07 -0600406#endif
407
Gregory P. Smith1d300ce2018-12-30 21:13:02 -0800408#ifdef _Py_MEMORY_SANITIZER
Victor Stinner5eca75d2020-04-15 15:07:31 +0200409# include <sanitizer/msan_interface.h>
Gregory P. Smith1d300ce2018-12-30 21:13:02 -0800410#endif
411
Antoine Pitrou346cbd32017-05-27 17:50:54 +0200412#ifdef HAVE_FORK
413static void
414run_at_forkers(PyObject *lst, int reverse)
415{
416 Py_ssize_t i;
417 PyObject *cpy;
418
419 if (lst != NULL) {
420 assert(PyList_CheckExact(lst));
421
422 /* Use a list copy in case register_at_fork() is called from
423 * one of the callbacks.
424 */
425 cpy = PyList_GetSlice(lst, 0, PyList_GET_SIZE(lst));
426 if (cpy == NULL)
427 PyErr_WriteUnraisable(lst);
428 else {
429 if (reverse)
430 PyList_Reverse(cpy);
431 for (i = 0; i < PyList_GET_SIZE(cpy); i++) {
432 PyObject *func, *res;
433 func = PyList_GET_ITEM(cpy, i);
Jeroen Demeyer7f41c8e2019-07-04 12:35:31 +0200434 res = _PyObject_CallNoArg(func);
Antoine Pitrou346cbd32017-05-27 17:50:54 +0200435 if (res == NULL)
436 PyErr_WriteUnraisable(func);
437 else
438 Py_DECREF(res);
439 }
440 Py_DECREF(cpy);
441 }
442 }
443}
444
445void
446PyOS_BeforeFork(void)
447{
Victor Stinner81a7be32020-04-14 15:14:01 +0200448 run_at_forkers(_PyInterpreterState_GET()->before_forkers, 1);
Antoine Pitrou346cbd32017-05-27 17:50:54 +0200449
450 _PyImport_AcquireLock();
451}
452
453void
454PyOS_AfterFork_Parent(void)
455{
456 if (_PyImport_ReleaseLock() <= 0)
457 Py_FatalError("failed releasing import lock after fork");
458
Victor Stinner81a7be32020-04-14 15:14:01 +0200459 run_at_forkers(_PyInterpreterState_GET()->after_forkers_parent, 0);
Antoine Pitrou346cbd32017-05-27 17:50:54 +0200460}
461
462void
463PyOS_AfterFork_Child(void)
464{
Victor Stinner26881c82020-06-02 15:51:37 +0200465 PyStatus status;
Victor Stinnerb930a2d2019-04-24 17:14:33 +0200466 _PyRuntimeState *runtime = &_PyRuntime;
Victor Stinner26881c82020-06-02 15:51:37 +0200467
468 status = _PyGILState_Reinit(runtime);
469 if (_PyStatus_EXCEPTION(status)) {
470 goto fatal_error;
471 }
472
473 status = _PyEval_ReInitThreads(runtime);
474 if (_PyStatus_EXCEPTION(status)) {
475 goto fatal_error;
476 }
477
478 status = _PyImport_ReInitLock();
479 if (_PyStatus_EXCEPTION(status)) {
480 goto fatal_error;
481 }
482
Antoine Pitrou346cbd32017-05-27 17:50:54 +0200483 _PySignal_AfterFork();
Victor Stinner26881c82020-06-02 15:51:37 +0200484
485 status = _PyRuntimeState_ReInitThreads(runtime);
486 if (_PyStatus_EXCEPTION(status)) {
487 goto fatal_error;
488 }
489
490 status = _PyInterpreterState_DeleteExceptMain(runtime);
491 if (_PyStatus_EXCEPTION(status)) {
492 goto fatal_error;
493 }
Antoine Pitrou346cbd32017-05-27 17:50:54 +0200494
Victor Stinner81a7be32020-04-14 15:14:01 +0200495 run_at_forkers(_PyInterpreterState_GET()->after_forkers_child, 0);
Victor Stinner26881c82020-06-02 15:51:37 +0200496 return;
497
498fatal_error:
499 Py_ExitStatusException(status);
Antoine Pitrou346cbd32017-05-27 17:50:54 +0200500}
501
502static int
503register_at_forker(PyObject **lst, PyObject *func)
504{
Gregory P. Smith163468a2017-05-29 10:03:41 -0700505 if (func == NULL) /* nothing to register? do nothing. */
506 return 0;
Antoine Pitrou346cbd32017-05-27 17:50:54 +0200507 if (*lst == NULL) {
508 *lst = PyList_New(0);
509 if (*lst == NULL)
510 return -1;
511 }
512 return PyList_Append(*lst, func);
513}
Victor Stinner87255be2020-04-07 23:11:49 +0200514#endif /* HAVE_FORK */
515
Antoine Pitrou346cbd32017-05-27 17:50:54 +0200516
517/* Legacy wrapper */
518void
519PyOS_AfterFork(void)
520{
521#ifdef HAVE_FORK
522 PyOS_AfterFork_Child();
523#endif
524}
525
526
Victor Stinner6036e442015-03-08 01:58:04 +0100527#ifdef MS_WINDOWS
Serhiy Storchaka06a13f82015-02-22 21:34:54 +0200528/* defined in fileutils.c */
Benjamin Petersone5024512018-09-12 12:06:42 -0700529void _Py_time_t_to_FILE_TIME(time_t, int, FILETIME *);
530void _Py_attribute_data_to_stat(BY_HANDLE_FILE_INFORMATION *,
Serhiy Storchaka06a13f82015-02-22 21:34:54 +0200531 ULONG, struct _Py_stat_struct *);
532#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -0700533
Larry Hastings9cf065c2012-06-22 16:30:09 -0700534
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200535#ifndef MS_WINDOWS
536PyObject *
537_PyLong_FromUid(uid_t uid)
538{
539 if (uid == (uid_t)-1)
540 return PyLong_FromLong(-1);
541 return PyLong_FromUnsignedLong(uid);
542}
543
544PyObject *
545_PyLong_FromGid(gid_t gid)
546{
547 if (gid == (gid_t)-1)
548 return PyLong_FromLong(-1);
549 return PyLong_FromUnsignedLong(gid);
550}
551
552int
553_Py_Uid_Converter(PyObject *obj, void *p)
554{
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700555 uid_t uid;
556 PyObject *index;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200557 int overflow;
Serhiy Storchakab4621892013-02-10 23:28:02 +0200558 long result;
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700559 unsigned long uresult;
560
Serhiy Storchaka5f4b229d2020-05-28 10:33:45 +0300561 index = _PyNumber_Index(obj);
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700562 if (index == NULL) {
563 PyErr_Format(PyExc_TypeError,
564 "uid should be integer, not %.200s",
Eddie Elizondob3966632019-11-05 07:16:14 -0800565 _PyType_Name(Py_TYPE(obj)));
Serhiy Storchakab4621892013-02-10 23:28:02 +0200566 return 0;
567 }
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700568
569 /*
570 * Handling uid_t is complicated for two reasons:
571 * * Although uid_t is (always?) unsigned, it still
572 * accepts -1.
573 * * We don't know its size in advance--it may be
574 * bigger than an int, or it may be smaller than
575 * a long.
576 *
577 * So a bit of defensive programming is in order.
578 * Start with interpreting the value passed
579 * in as a signed long and see if it works.
580 */
581
582 result = PyLong_AsLongAndOverflow(index, &overflow);
583
584 if (!overflow) {
585 uid = (uid_t)result;
586
587 if (result == -1) {
588 if (PyErr_Occurred())
589 goto fail;
590 /* It's a legitimate -1, we're done. */
591 goto success;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200592 }
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700593
594 /* Any other negative number is disallowed. */
595 if (result < 0)
596 goto underflow;
597
598 /* Ensure the value wasn't truncated. */
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200599 if (sizeof(uid_t) < sizeof(long) &&
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700600 (long)uid != result)
601 goto underflow;
602 goto success;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200603 }
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700604
605 if (overflow < 0)
606 goto underflow;
607
608 /*
609 * Okay, the value overflowed a signed long. If it
610 * fits in an *unsigned* long, it may still be okay,
611 * as uid_t may be unsigned long on this platform.
612 */
613 uresult = PyLong_AsUnsignedLong(index);
614 if (PyErr_Occurred()) {
615 if (PyErr_ExceptionMatches(PyExc_OverflowError))
616 goto overflow;
617 goto fail;
618 }
619
620 uid = (uid_t)uresult;
621
622 /*
623 * If uid == (uid_t)-1, the user actually passed in ULONG_MAX,
624 * but this value would get interpreted as (uid_t)-1 by chown
625 * and its siblings. That's not what the user meant! So we
626 * throw an overflow exception instead. (We already
Tim Golden23005082013-10-25 11:22:37 +0100627 * handled a real -1 with PyLong_AsLongAndOverflow() above.)
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700628 */
629 if (uid == (uid_t)-1)
630 goto overflow;
631
632 /* Ensure the value wasn't truncated. */
633 if (sizeof(uid_t) < sizeof(long) &&
634 (unsigned long)uid != uresult)
635 goto overflow;
636 /* fallthrough */
637
638success:
639 Py_DECREF(index);
640 *(uid_t *)p = uid;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200641 return 1;
642
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700643underflow:
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200644 PyErr_SetString(PyExc_OverflowError,
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700645 "uid is less than minimum");
646 goto fail;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200647
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700648overflow:
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200649 PyErr_SetString(PyExc_OverflowError,
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700650 "uid is greater than maximum");
651 /* fallthrough */
652
653fail:
654 Py_DECREF(index);
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200655 return 0;
656}
657
658int
659_Py_Gid_Converter(PyObject *obj, void *p)
660{
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700661 gid_t gid;
662 PyObject *index;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200663 int overflow;
Serhiy Storchakab4621892013-02-10 23:28:02 +0200664 long result;
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700665 unsigned long uresult;
666
Serhiy Storchaka5f4b229d2020-05-28 10:33:45 +0300667 index = _PyNumber_Index(obj);
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700668 if (index == NULL) {
669 PyErr_Format(PyExc_TypeError,
670 "gid should be integer, not %.200s",
Eddie Elizondob3966632019-11-05 07:16:14 -0800671 _PyType_Name(Py_TYPE(obj)));
Serhiy Storchakab4621892013-02-10 23:28:02 +0200672 return 0;
673 }
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700674
675 /*
676 * Handling gid_t is complicated for two reasons:
677 * * Although gid_t is (always?) unsigned, it still
678 * accepts -1.
679 * * We don't know its size in advance--it may be
680 * bigger than an int, or it may be smaller than
681 * a long.
682 *
683 * So a bit of defensive programming is in order.
684 * Start with interpreting the value passed
685 * in as a signed long and see if it works.
686 */
687
688 result = PyLong_AsLongAndOverflow(index, &overflow);
689
690 if (!overflow) {
691 gid = (gid_t)result;
692
693 if (result == -1) {
694 if (PyErr_Occurred())
695 goto fail;
696 /* It's a legitimate -1, we're done. */
697 goto success;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200698 }
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700699
700 /* Any other negative number is disallowed. */
701 if (result < 0) {
702 goto underflow;
703 }
704
705 /* Ensure the value wasn't truncated. */
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200706 if (sizeof(gid_t) < sizeof(long) &&
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700707 (long)gid != result)
708 goto underflow;
709 goto success;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200710 }
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700711
712 if (overflow < 0)
713 goto underflow;
714
715 /*
716 * Okay, the value overflowed a signed long. If it
717 * fits in an *unsigned* long, it may still be okay,
718 * as gid_t may be unsigned long on this platform.
719 */
720 uresult = PyLong_AsUnsignedLong(index);
721 if (PyErr_Occurred()) {
722 if (PyErr_ExceptionMatches(PyExc_OverflowError))
723 goto overflow;
724 goto fail;
725 }
726
727 gid = (gid_t)uresult;
728
729 /*
730 * If gid == (gid_t)-1, the user actually passed in ULONG_MAX,
731 * but this value would get interpreted as (gid_t)-1 by chown
732 * and its siblings. That's not what the user meant! So we
733 * throw an overflow exception instead. (We already
Tim Golden23005082013-10-25 11:22:37 +0100734 * handled a real -1 with PyLong_AsLongAndOverflow() above.)
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700735 */
736 if (gid == (gid_t)-1)
737 goto overflow;
738
739 /* Ensure the value wasn't truncated. */
740 if (sizeof(gid_t) < sizeof(long) &&
741 (unsigned long)gid != uresult)
742 goto overflow;
743 /* fallthrough */
744
745success:
746 Py_DECREF(index);
747 *(gid_t *)p = gid;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200748 return 1;
749
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700750underflow:
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200751 PyErr_SetString(PyExc_OverflowError,
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700752 "gid is less than minimum");
753 goto fail;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200754
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700755overflow:
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200756 PyErr_SetString(PyExc_OverflowError,
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700757 "gid is greater than maximum");
758 /* fallthrough */
759
760fail:
761 Py_DECREF(index);
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200762 return 0;
763}
764#endif /* MS_WINDOWS */
765
766
Benjamin Petersoned4aa832016-09-05 17:44:18 -0700767#define _PyLong_FromDev PyLong_FromLongLong
Gregory P. Smith702dada2015-01-28 16:07:52 -0800768
769
Serhiy Storchakab2653b32015-01-18 11:12:11 +0200770#if defined(HAVE_MKNOD) && defined(HAVE_MAKEDEV)
771static int
772_Py_Dev_Converter(PyObject *obj, void *p)
773{
Serhiy Storchakab2653b32015-01-18 11:12:11 +0200774 *((dev_t *)p) = PyLong_AsUnsignedLongLong(obj);
Serhiy Storchakab2653b32015-01-18 11:12:11 +0200775 if (PyErr_Occurred())
776 return 0;
777 return 1;
778}
Gregory P. Smith702dada2015-01-28 16:07:52 -0800779#endif /* HAVE_MKNOD && HAVE_MAKEDEV */
Serhiy Storchakab2653b32015-01-18 11:12:11 +0200780
781
Larry Hastings9cf065c2012-06-22 16:30:09 -0700782#ifdef AT_FDCWD
Trent Nelson9a461052012-09-18 21:50:06 -0400783/*
784 * Why the (int) cast? Solaris 10 defines AT_FDCWD as 0xffd19553 (-3041965);
785 * without the int cast, the value gets interpreted as uint (4291925331),
786 * which doesn't play nicely with all the initializer lines in this file that
787 * look like this:
788 * int dir_fd = DEFAULT_DIR_FD;
789 */
790#define DEFAULT_DIR_FD (int)AT_FDCWD
Larry Hastings9cf065c2012-06-22 16:30:09 -0700791#else
792#define DEFAULT_DIR_FD (-100)
793#endif
794
795static int
Serhiy Storchaka819399b2016-04-06 22:17:52 +0300796_fd_converter(PyObject *o, int *p)
Serhiy Storchakaa2ad5c32013-01-07 23:13:46 +0200797{
798 int overflow;
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700799 long long_value;
800
Serhiy Storchaka5f4b229d2020-05-28 10:33:45 +0300801 PyObject *index = _PyNumber_Index(o);
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700802 if (index == NULL) {
Larry Hastings9cf065c2012-06-22 16:30:09 -0700803 return 0;
804 }
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700805
Serhiy Storchaka819399b2016-04-06 22:17:52 +0300806 assert(PyLong_Check(index));
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700807 long_value = PyLong_AsLongAndOverflow(index, &overflow);
808 Py_DECREF(index);
Serhiy Storchaka819399b2016-04-06 22:17:52 +0300809 assert(!PyErr_Occurred());
Serhiy Storchakaa2ad5c32013-01-07 23:13:46 +0200810 if (overflow > 0 || long_value > INT_MAX) {
Larry Hastings9cf065c2012-06-22 16:30:09 -0700811 PyErr_SetString(PyExc_OverflowError,
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700812 "fd is greater than maximum");
Larry Hastings9cf065c2012-06-22 16:30:09 -0700813 return 0;
814 }
Serhiy Storchakaa2ad5c32013-01-07 23:13:46 +0200815 if (overflow < 0 || long_value < INT_MIN) {
Larry Hastings9cf065c2012-06-22 16:30:09 -0700816 PyErr_SetString(PyExc_OverflowError,
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700817 "fd is less than minimum");
Larry Hastings9cf065c2012-06-22 16:30:09 -0700818 return 0;
819 }
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700820
Larry Hastings9cf065c2012-06-22 16:30:09 -0700821 *p = (int)long_value;
822 return 1;
823}
824
825static int
Serhiy Storchakaa2ad5c32013-01-07 23:13:46 +0200826dir_fd_converter(PyObject *o, void *p)
827{
828 if (o == Py_None) {
829 *(int *)p = DEFAULT_DIR_FD;
830 return 1;
831 }
Serhiy Storchaka819399b2016-04-06 22:17:52 +0300832 else if (PyIndex_Check(o)) {
833 return _fd_converter(o, (int *)p);
834 }
835 else {
836 PyErr_Format(PyExc_TypeError,
837 "argument should be integer or None, not %.200s",
Eddie Elizondob3966632019-11-05 07:16:14 -0800838 _PyType_Name(Py_TYPE(o)));
Serhiy Storchaka819399b2016-04-06 22:17:52 +0300839 return 0;
840 }
Larry Hastings9cf065c2012-06-22 16:30:09 -0700841}
842
Eddie Elizondob3966632019-11-05 07:16:14 -0800843typedef struct {
844 PyObject *billion;
Eddie Elizondob3966632019-11-05 07:16:14 -0800845 PyObject *DirEntryType;
846 PyObject *ScandirIteratorType;
847#if defined(HAVE_SCHED_SETPARAM) || defined(HAVE_SCHED_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDPARAM)
848 PyObject *SchedParamType;
849#endif
850 PyObject *StatResultType;
851 PyObject *StatVFSResultType;
852 PyObject *TerminalSizeType;
853 PyObject *TimesResultType;
854 PyObject *UnameResultType;
855#if defined(HAVE_WAITID) && !defined(__APPLE__)
856 PyObject *WaitidResultType;
857#endif
858#if defined(HAVE_WAIT3) || defined(HAVE_WAIT4)
859 PyObject *struct_rusage;
860#endif
861 PyObject *st_mode;
862} _posixstate;
863
Eddie Elizondob3966632019-11-05 07:16:14 -0800864
Hai Shif707d942020-03-16 21:15:01 +0800865static inline _posixstate*
866get_posix_state(PyObject *module)
867{
868 void *state = PyModule_GetState(module);
869 assert(state != NULL);
870 return (_posixstate *)state;
871}
872
Larry Hastings9cf065c2012-06-22 16:30:09 -0700873/*
874 * A PyArg_ParseTuple "converter" function
875 * that handles filesystem paths in the manner
876 * preferred by the os module.
877 *
878 * path_converter accepts (Unicode) strings and their
879 * subclasses, and bytes and their subclasses. What
880 * it does with the argument depends on the platform:
881 *
882 * * On Windows, if we get a (Unicode) string we
883 * extract the wchar_t * and return it; if we get
Steve Dowercc16be82016-09-08 10:35:16 -0700884 * bytes we decode to wchar_t * and return that.
Larry Hastings9cf065c2012-06-22 16:30:09 -0700885 *
886 * * On all other platforms, strings are encoded
887 * to bytes using PyUnicode_FSConverter, then we
888 * extract the char * from the bytes object and
889 * return that.
890 *
891 * path_converter also optionally accepts signed
892 * integers (representing open file descriptors) instead
893 * of path strings.
894 *
895 * Input fields:
896 * path.nullable
897 * If nonzero, the path is permitted to be None.
898 * path.allow_fd
899 * If nonzero, the path is permitted to be a file handle
900 * (a signed int) instead of a string.
901 * path.function_name
902 * If non-NULL, path_converter will use that as the name
903 * of the function in error messages.
Larry Hastings31826802013-10-19 00:09:25 -0700904 * (If path.function_name is NULL it omits the function name.)
Larry Hastings9cf065c2012-06-22 16:30:09 -0700905 * path.argument_name
906 * If non-NULL, path_converter will use that as the name
907 * of the parameter in error messages.
908 * (If path.argument_name is NULL it uses "path".)
909 *
910 * Output fields:
911 * path.wide
912 * Points to the path if it was expressed as Unicode
913 * and was not encoded. (Only used on Windows.)
914 * path.narrow
915 * Points to the path if it was expressed as bytes,
Steve Dowercc16be82016-09-08 10:35:16 -0700916 * or it was Unicode and was encoded to bytes. (On Windows,
Martin Panterb1321fb2016-10-10 00:38:21 +0000917 * is a non-zero integer if the path was expressed as bytes.
Steve Dowercc16be82016-09-08 10:35:16 -0700918 * The type is deliberately incompatible to prevent misuse.)
Larry Hastings9cf065c2012-06-22 16:30:09 -0700919 * path.fd
920 * Contains a file descriptor if path.accept_fd was true
921 * and the caller provided a signed integer instead of any
922 * sort of string.
923 *
924 * WARNING: if your "path" parameter is optional, and is
925 * unspecified, path_converter will never get called.
926 * So if you set allow_fd, you *MUST* initialize path.fd = -1
927 * yourself!
928 * path.length
929 * The length of the path in characters, if specified as
930 * a string.
931 * path.object
Xiang Zhang04316c42017-01-08 23:26:57 +0800932 * The original object passed in (if get a PathLike object,
933 * the result of PyOS_FSPath() is treated as the original object).
934 * Own a reference to the object.
Larry Hastings9cf065c2012-06-22 16:30:09 -0700935 * path.cleanup
936 * For internal use only. May point to a temporary object.
937 * (Pay no attention to the man behind the curtain.)
938 *
939 * At most one of path.wide or path.narrow will be non-NULL.
940 * If path was None and path.nullable was set,
941 * or if path was an integer and path.allow_fd was set,
942 * both path.wide and path.narrow will be NULL
943 * and path.length will be 0.
Georg Brandlf7875592012-06-24 13:58:31 +0200944 *
Larry Hastings9cf065c2012-06-22 16:30:09 -0700945 * path_converter takes care to not write to the path_t
946 * unless it's successful. However it must reset the
947 * "cleanup" field each time it's called.
948 *
949 * Use as follows:
950 * path_t path;
951 * memset(&path, 0, sizeof(path));
952 * PyArg_ParseTuple(args, "O&", path_converter, &path);
953 * // ... use values from path ...
954 * path_cleanup(&path);
955 *
956 * (Note that if PyArg_Parse fails you don't need to call
957 * path_cleanup(). However it is safe to do so.)
958 */
959typedef struct {
Victor Stinner292c8352012-10-30 02:17:38 +0100960 const char *function_name;
961 const char *argument_name;
Larry Hastings9cf065c2012-06-22 16:30:09 -0700962 int nullable;
963 int allow_fd;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +0300964 const wchar_t *wide;
Steve Dowercc16be82016-09-08 10:35:16 -0700965#ifdef MS_WINDOWS
966 BOOL narrow;
967#else
Serhiy Storchakadeab18d2016-05-07 16:45:18 +0300968 const char *narrow;
Steve Dowercc16be82016-09-08 10:35:16 -0700969#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -0700970 int fd;
971 Py_ssize_t length;
972 PyObject *object;
973 PyObject *cleanup;
974} path_t;
975
Steve Dowercc16be82016-09-08 10:35:16 -0700976#ifdef MS_WINDOWS
977#define PATH_T_INITIALIZE(function_name, argument_name, nullable, allow_fd) \
978 {function_name, argument_name, nullable, allow_fd, NULL, FALSE, -1, 0, NULL, NULL}
979#else
Larry Hastings2f936352014-08-05 14:04:04 +1000980#define PATH_T_INITIALIZE(function_name, argument_name, nullable, allow_fd) \
981 {function_name, argument_name, nullable, allow_fd, NULL, NULL, -1, 0, NULL, NULL}
Steve Dowercc16be82016-09-08 10:35:16 -0700982#endif
Larry Hastings31826802013-10-19 00:09:25 -0700983
Larry Hastings9cf065c2012-06-22 16:30:09 -0700984static void
Xiang Zhang04316c42017-01-08 23:26:57 +0800985path_cleanup(path_t *path)
986{
987 Py_CLEAR(path->object);
988 Py_CLEAR(path->cleanup);
Larry Hastings9cf065c2012-06-22 16:30:09 -0700989}
990
991static int
Serhiy Storchaka819399b2016-04-06 22:17:52 +0300992path_converter(PyObject *o, void *p)
993{
Larry Hastings9cf065c2012-06-22 16:30:09 -0700994 path_t *path = (path_t *)p;
Xiang Zhang04316c42017-01-08 23:26:57 +0800995 PyObject *bytes = NULL;
996 Py_ssize_t length = 0;
Brett Cannon3f9183b2016-08-26 14:44:48 -0700997 int is_index, is_buffer, is_bytes, is_unicode;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +0300998 const char *narrow;
Steve Dowercc16be82016-09-08 10:35:16 -0700999#ifdef MS_WINDOWS
Xiang Zhang04316c42017-01-08 23:26:57 +08001000 PyObject *wo = NULL;
Steve Dowercc16be82016-09-08 10:35:16 -07001001 const wchar_t *wide;
1002#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07001003
1004#define FORMAT_EXCEPTION(exc, fmt) \
1005 PyErr_Format(exc, "%s%s" fmt, \
1006 path->function_name ? path->function_name : "", \
1007 path->function_name ? ": " : "", \
1008 path->argument_name ? path->argument_name : "path")
1009
1010 /* Py_CLEANUP_SUPPORTED support */
1011 if (o == NULL) {
1012 path_cleanup(path);
1013 return 1;
1014 }
1015
Brett Cannon3f9183b2016-08-26 14:44:48 -07001016 /* Ensure it's always safe to call path_cleanup(). */
Xiang Zhang04316c42017-01-08 23:26:57 +08001017 path->object = path->cleanup = NULL;
1018 /* path->object owns a reference to the original object */
1019 Py_INCREF(o);
Larry Hastings9cf065c2012-06-22 16:30:09 -07001020
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001021 if ((o == Py_None) && path->nullable) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07001022 path->wide = NULL;
Steve Dowercc16be82016-09-08 10:35:16 -07001023#ifdef MS_WINDOWS
1024 path->narrow = FALSE;
1025#else
Larry Hastings9cf065c2012-06-22 16:30:09 -07001026 path->narrow = NULL;
Steve Dowercc16be82016-09-08 10:35:16 -07001027#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07001028 path->fd = -1;
Xiang Zhang04316c42017-01-08 23:26:57 +08001029 goto success_exit;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001030 }
1031
Brett Cannon3f9183b2016-08-26 14:44:48 -07001032 /* Only call this here so that we don't treat the return value of
1033 os.fspath() as an fd or buffer. */
1034 is_index = path->allow_fd && PyIndex_Check(o);
1035 is_buffer = PyObject_CheckBuffer(o);
1036 is_bytes = PyBytes_Check(o);
1037 is_unicode = PyUnicode_Check(o);
1038
1039 if (!is_index && !is_buffer && !is_unicode && !is_bytes) {
1040 /* Inline PyOS_FSPath() for better error messages. */
Pablo Galindo09fbcd62019-02-18 10:46:34 +00001041 PyObject *func, *res;
Brett Cannon3f9183b2016-08-26 14:44:48 -07001042
1043 func = _PyObject_LookupSpecial(o, &PyId___fspath__);
1044 if (NULL == func) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001045 goto error_format;
Brett Cannon3f9183b2016-08-26 14:44:48 -07001046 }
Pablo Galindo09fbcd62019-02-18 10:46:34 +00001047 res = _PyObject_CallNoArg(func);
Brett Cannon3f9183b2016-08-26 14:44:48 -07001048 Py_DECREF(func);
Pablo Galindo09fbcd62019-02-18 10:46:34 +00001049 if (NULL == res) {
Brett Cannon3f9183b2016-08-26 14:44:48 -07001050 goto error_exit;
1051 }
Pablo Galindo09fbcd62019-02-18 10:46:34 +00001052 else if (PyUnicode_Check(res)) {
Brett Cannon3f9183b2016-08-26 14:44:48 -07001053 is_unicode = 1;
1054 }
Pablo Galindo09fbcd62019-02-18 10:46:34 +00001055 else if (PyBytes_Check(res)) {
Brett Cannon3f9183b2016-08-26 14:44:48 -07001056 is_bytes = 1;
1057 }
1058 else {
Pablo Galindo09fbcd62019-02-18 10:46:34 +00001059 PyErr_Format(PyExc_TypeError,
1060 "expected %.200s.__fspath__() to return str or bytes, "
Eddie Elizondob3966632019-11-05 07:16:14 -08001061 "not %.200s", _PyType_Name(Py_TYPE(o)),
1062 _PyType_Name(Py_TYPE(res)));
Pablo Galindo09fbcd62019-02-18 10:46:34 +00001063 Py_DECREF(res);
1064 goto error_exit;
Brett Cannon3f9183b2016-08-26 14:44:48 -07001065 }
Pablo Galindo09fbcd62019-02-18 10:46:34 +00001066
1067 /* still owns a reference to the original object */
1068 Py_DECREF(o);
1069 o = res;
Brett Cannon3f9183b2016-08-26 14:44:48 -07001070 }
1071
1072 if (is_unicode) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07001073#ifdef MS_WINDOWS
Victor Stinner26c03bd2016-09-19 11:55:44 +02001074 wide = PyUnicode_AsUnicodeAndSize(o, &length);
Victor Stinner59799a82013-11-13 14:17:30 +01001075 if (!wide) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001076 goto error_exit;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001077 }
Victor Stinner59799a82013-11-13 14:17:30 +01001078 if (length > 32767) {
1079 FORMAT_EXCEPTION(PyExc_ValueError, "%s too long for Windows");
Xiang Zhang04316c42017-01-08 23:26:57 +08001080 goto error_exit;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001081 }
Serhiy Storchaka2b0d2002015-04-20 09:53:58 +03001082 if (wcslen(wide) != length) {
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001083 FORMAT_EXCEPTION(PyExc_ValueError, "embedded null character in %s");
Xiang Zhang04316c42017-01-08 23:26:57 +08001084 goto error_exit;
Serhiy Storchaka2b0d2002015-04-20 09:53:58 +03001085 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07001086
1087 path->wide = wide;
Xiang Zhang04316c42017-01-08 23:26:57 +08001088 path->narrow = FALSE;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001089 path->fd = -1;
Xiang Zhang04316c42017-01-08 23:26:57 +08001090 goto success_exit;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001091#else
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001092 if (!PyUnicode_FSConverter(o, &bytes)) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001093 goto error_exit;
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001094 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07001095#endif
1096 }
Brett Cannon3f9183b2016-08-26 14:44:48 -07001097 else if (is_bytes) {
Serhiy Storchakad73c3182016-08-06 23:22:08 +03001098 bytes = o;
1099 Py_INCREF(bytes);
1100 }
Brett Cannon3f9183b2016-08-26 14:44:48 -07001101 else if (is_buffer) {
Serhiy Storchaka1180e5a2017-07-11 06:36:46 +03001102 /* XXX Replace PyObject_CheckBuffer with PyBytes_Check in other code
Ville Skyttä49b27342017-08-03 09:00:59 +03001103 after removing support of non-bytes buffer objects. */
Serhiy Storchakad73c3182016-08-06 23:22:08 +03001104 if (PyErr_WarnFormat(PyExc_DeprecationWarning, 1,
1105 "%s%s%s should be %s, not %.200s",
1106 path->function_name ? path->function_name : "",
1107 path->function_name ? ": " : "",
1108 path->argument_name ? path->argument_name : "path",
Brett Cannon3f9183b2016-08-26 14:44:48 -07001109 path->allow_fd && path->nullable ? "string, bytes, os.PathLike, "
1110 "integer or None" :
1111 path->allow_fd ? "string, bytes, os.PathLike or integer" :
1112 path->nullable ? "string, bytes, os.PathLike or None" :
1113 "string, bytes or os.PathLike",
Eddie Elizondob3966632019-11-05 07:16:14 -08001114 _PyType_Name(Py_TYPE(o)))) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001115 goto error_exit;
Serhiy Storchakad73c3182016-08-06 23:22:08 +03001116 }
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001117 bytes = PyBytes_FromObject(o);
Larry Hastings9cf065c2012-06-22 16:30:09 -07001118 if (!bytes) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001119 goto error_exit;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001120 }
1121 }
Steve Dowercc16be82016-09-08 10:35:16 -07001122 else if (is_index) {
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001123 if (!_fd_converter(o, &path->fd)) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001124 goto error_exit;
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001125 }
1126 path->wide = NULL;
Steve Dowercc16be82016-09-08 10:35:16 -07001127#ifdef MS_WINDOWS
1128 path->narrow = FALSE;
1129#else
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001130 path->narrow = NULL;
Steve Dowercc16be82016-09-08 10:35:16 -07001131#endif
Xiang Zhang04316c42017-01-08 23:26:57 +08001132 goto success_exit;
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001133 }
1134 else {
Xiang Zhang04316c42017-01-08 23:26:57 +08001135 error_format:
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001136 PyErr_Format(PyExc_TypeError, "%s%s%s should be %s, not %.200s",
1137 path->function_name ? path->function_name : "",
1138 path->function_name ? ": " : "",
1139 path->argument_name ? path->argument_name : "path",
Brett Cannon3f9183b2016-08-26 14:44:48 -07001140 path->allow_fd && path->nullable ? "string, bytes, os.PathLike, "
1141 "integer or None" :
1142 path->allow_fd ? "string, bytes, os.PathLike or integer" :
1143 path->nullable ? "string, bytes, os.PathLike or None" :
1144 "string, bytes or os.PathLike",
Eddie Elizondob3966632019-11-05 07:16:14 -08001145 _PyType_Name(Py_TYPE(o)));
Xiang Zhang04316c42017-01-08 23:26:57 +08001146 goto error_exit;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001147 }
1148
Larry Hastings9cf065c2012-06-22 16:30:09 -07001149 length = PyBytes_GET_SIZE(bytes);
Larry Hastings9cf065c2012-06-22 16:30:09 -07001150 narrow = PyBytes_AS_STRING(bytes);
Victor Stinner706768c2014-08-16 01:03:39 +02001151 if ((size_t)length != strlen(narrow)) {
Serhiy Storchakad8a14472014-09-06 20:07:17 +03001152 FORMAT_EXCEPTION(PyExc_ValueError, "embedded null character in %s");
Xiang Zhang04316c42017-01-08 23:26:57 +08001153 goto error_exit;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001154 }
1155
Steve Dowercc16be82016-09-08 10:35:16 -07001156#ifdef MS_WINDOWS
1157 wo = PyUnicode_DecodeFSDefaultAndSize(
1158 narrow,
1159 length
1160 );
1161 if (!wo) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001162 goto error_exit;
Steve Dowercc16be82016-09-08 10:35:16 -07001163 }
1164
Xiang Zhang04316c42017-01-08 23:26:57 +08001165 wide = PyUnicode_AsUnicodeAndSize(wo, &length);
Steve Dowercc16be82016-09-08 10:35:16 -07001166 if (!wide) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001167 goto error_exit;
Steve Dowercc16be82016-09-08 10:35:16 -07001168 }
1169 if (length > 32767) {
1170 FORMAT_EXCEPTION(PyExc_ValueError, "%s too long for Windows");
Xiang Zhang04316c42017-01-08 23:26:57 +08001171 goto error_exit;
Steve Dowercc16be82016-09-08 10:35:16 -07001172 }
1173 if (wcslen(wide) != length) {
1174 FORMAT_EXCEPTION(PyExc_ValueError, "embedded null character in %s");
Xiang Zhang04316c42017-01-08 23:26:57 +08001175 goto error_exit;
Steve Dowercc16be82016-09-08 10:35:16 -07001176 }
1177 path->wide = wide;
1178 path->narrow = TRUE;
Xiang Zhang04316c42017-01-08 23:26:57 +08001179 path->cleanup = wo;
1180 Py_DECREF(bytes);
Steve Dowercc16be82016-09-08 10:35:16 -07001181#else
Larry Hastings9cf065c2012-06-22 16:30:09 -07001182 path->wide = NULL;
1183 path->narrow = narrow;
Serhiy Storchakad73c3182016-08-06 23:22:08 +03001184 if (bytes == o) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001185 /* Still a reference owned by path->object, don't have to
1186 worry about path->narrow is used after free. */
Serhiy Storchakad73c3182016-08-06 23:22:08 +03001187 Py_DECREF(bytes);
Serhiy Storchakad73c3182016-08-06 23:22:08 +03001188 }
1189 else {
1190 path->cleanup = bytes;
Serhiy Storchakad73c3182016-08-06 23:22:08 +03001191 }
Xiang Zhang04316c42017-01-08 23:26:57 +08001192#endif
1193 path->fd = -1;
1194
1195 success_exit:
1196 path->length = length;
1197 path->object = o;
1198 return Py_CLEANUP_SUPPORTED;
1199
1200 error_exit:
1201 Py_XDECREF(o);
1202 Py_XDECREF(bytes);
1203#ifdef MS_WINDOWS
1204 Py_XDECREF(wo);
1205#endif
1206 return 0;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001207}
1208
1209static void
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001210argument_unavailable_error(const char *function_name, const char *argument_name)
1211{
Larry Hastings9cf065c2012-06-22 16:30:09 -07001212 PyErr_Format(PyExc_NotImplementedError,
1213 "%s%s%s unavailable on this platform",
1214 (function_name != NULL) ? function_name : "",
1215 (function_name != NULL) ? ": ": "",
1216 argument_name);
1217}
1218
1219static int
Serhiy Storchakaa2ad5c32013-01-07 23:13:46 +02001220dir_fd_unavailable(PyObject *o, void *p)
1221{
1222 int dir_fd;
1223 if (!dir_fd_converter(o, &dir_fd))
Larry Hastings9cf065c2012-06-22 16:30:09 -07001224 return 0;
Serhiy Storchakaa2ad5c32013-01-07 23:13:46 +02001225 if (dir_fd != DEFAULT_DIR_FD) {
1226 argument_unavailable_error(NULL, "dir_fd");
1227 return 0;
1228 }
1229 *(int *)p = dir_fd;
1230 return 1;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001231}
1232
1233static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001234fd_specified(const char *function_name, int fd)
1235{
Larry Hastings9cf065c2012-06-22 16:30:09 -07001236 if (fd == -1)
1237 return 0;
1238
1239 argument_unavailable_error(function_name, "fd");
1240 return 1;
1241}
1242
1243static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001244follow_symlinks_specified(const char *function_name, int follow_symlinks)
1245{
Larry Hastings9cf065c2012-06-22 16:30:09 -07001246 if (follow_symlinks)
1247 return 0;
1248
1249 argument_unavailable_error(function_name, "follow_symlinks");
1250 return 1;
1251}
1252
1253static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001254path_and_dir_fd_invalid(const char *function_name, path_t *path, int dir_fd)
1255{
Steve Dowercc16be82016-09-08 10:35:16 -07001256 if (!path->wide && (dir_fd != DEFAULT_DIR_FD)
1257#ifndef MS_WINDOWS
1258 && !path->narrow
1259#endif
1260 ) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07001261 PyErr_Format(PyExc_ValueError,
1262 "%s: can't specify dir_fd without matching path",
1263 function_name);
1264 return 1;
1265 }
1266 return 0;
1267}
1268
1269static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001270dir_fd_and_fd_invalid(const char *function_name, int dir_fd, int fd)
1271{
Larry Hastings9cf065c2012-06-22 16:30:09 -07001272 if ((dir_fd != DEFAULT_DIR_FD) && (fd != -1)) {
1273 PyErr_Format(PyExc_ValueError,
1274 "%s: can't specify both dir_fd and fd",
1275 function_name);
1276 return 1;
1277 }
1278 return 0;
1279}
1280
1281static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001282fd_and_follow_symlinks_invalid(const char *function_name, int fd,
1283 int follow_symlinks)
1284{
Larry Hastings9cf065c2012-06-22 16:30:09 -07001285 if ((fd > 0) && (!follow_symlinks)) {
1286 PyErr_Format(PyExc_ValueError,
1287 "%s: cannot use fd and follow_symlinks together",
1288 function_name);
1289 return 1;
1290 }
1291 return 0;
1292}
1293
1294static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001295dir_fd_and_follow_symlinks_invalid(const char *function_name, int dir_fd,
1296 int follow_symlinks)
1297{
Larry Hastings9cf065c2012-06-22 16:30:09 -07001298 if ((dir_fd != DEFAULT_DIR_FD) && (!follow_symlinks)) {
1299 PyErr_Format(PyExc_ValueError,
1300 "%s: cannot use dir_fd and follow_symlinks together",
1301 function_name);
1302 return 1;
1303 }
1304 return 0;
1305}
1306
Larry Hastings2f936352014-08-05 14:04:04 +10001307#ifdef MS_WINDOWS
Benjamin Petersonaf580df2016-09-06 10:46:49 -07001308 typedef long long Py_off_t;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00001309#else
Larry Hastings2f936352014-08-05 14:04:04 +10001310 typedef off_t Py_off_t;
1311#endif
1312
1313static int
1314Py_off_t_converter(PyObject *arg, void *addr)
1315{
1316#ifdef HAVE_LARGEFILE_SUPPORT
1317 *((Py_off_t *)addr) = PyLong_AsLongLong(arg);
1318#else
1319 *((Py_off_t *)addr) = PyLong_AsLong(arg);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00001320#endif
1321 if (PyErr_Occurred())
1322 return 0;
1323 return 1;
1324}
Larry Hastings2f936352014-08-05 14:04:04 +10001325
1326static PyObject *
1327PyLong_FromPy_off_t(Py_off_t offset)
1328{
1329#ifdef HAVE_LARGEFILE_SUPPORT
1330 return PyLong_FromLongLong(offset);
1331#else
1332 return PyLong_FromLong(offset);
Ross Lagerwallb1e5d592011-09-19 08:30:43 +02001333#endif
Larry Hastings2f936352014-08-05 14:04:04 +10001334}
1335
Serhiy Storchakad54cfb12018-05-08 07:48:50 +03001336#ifdef HAVE_SIGSET_T
1337/* Convert an iterable of integers to a sigset.
1338 Return 1 on success, return 0 and raise an exception on error. */
1339int
1340_Py_Sigset_Converter(PyObject *obj, void *addr)
1341{
1342 sigset_t *mask = (sigset_t *)addr;
1343 PyObject *iterator, *item;
1344 long signum;
1345 int overflow;
1346
Rémi Lapeyref0900192019-05-04 01:30:53 +02001347 // The extra parens suppress the unreachable-code warning with clang on MacOS
1348 if (sigemptyset(mask) < (0)) {
Serhiy Storchakad54cfb12018-05-08 07:48:50 +03001349 /* Probably only if mask == NULL. */
1350 PyErr_SetFromErrno(PyExc_OSError);
1351 return 0;
1352 }
1353
1354 iterator = PyObject_GetIter(obj);
1355 if (iterator == NULL) {
1356 return 0;
1357 }
1358
1359 while ((item = PyIter_Next(iterator)) != NULL) {
1360 signum = PyLong_AsLongAndOverflow(item, &overflow);
1361 Py_DECREF(item);
1362 if (signum <= 0 || signum >= NSIG) {
1363 if (overflow || signum != -1 || !PyErr_Occurred()) {
1364 PyErr_Format(PyExc_ValueError,
1365 "signal number %ld out of range", signum);
1366 }
1367 goto error;
1368 }
1369 if (sigaddset(mask, (int)signum)) {
1370 if (errno != EINVAL) {
1371 /* Probably impossible */
1372 PyErr_SetFromErrno(PyExc_OSError);
1373 goto error;
1374 }
1375 /* For backwards compatibility, allow idioms such as
1376 * `range(1, NSIG)` but warn about invalid signal numbers
1377 */
1378 const char msg[] =
1379 "invalid signal number %ld, please use valid_signals()";
1380 if (PyErr_WarnFormat(PyExc_RuntimeWarning, 1, msg, signum)) {
1381 goto error;
1382 }
1383 }
1384 }
1385 if (!PyErr_Occurred()) {
1386 Py_DECREF(iterator);
1387 return 1;
1388 }
1389
1390error:
1391 Py_DECREF(iterator);
1392 return 0;
1393}
1394#endif /* HAVE_SIGSET_T */
1395
Brian Curtinfc1be6d2010-11-24 13:23:18 +00001396#ifdef MS_WINDOWS
Brian Curtinf5e76d02010-11-24 13:14:05 +00001397
1398static int
Brian Curtind25aef52011-06-13 15:16:04 -05001399win32_get_reparse_tag(HANDLE reparse_point_handle, ULONG *reparse_tag)
Brian Curtinf5e76d02010-11-24 13:14:05 +00001400{
Martin Panter70214ad2016-08-04 02:38:59 +00001401 char target_buffer[_Py_MAXIMUM_REPARSE_DATA_BUFFER_SIZE];
1402 _Py_REPARSE_DATA_BUFFER *rdb = (_Py_REPARSE_DATA_BUFFER *)target_buffer;
Brian Curtinf5e76d02010-11-24 13:14:05 +00001403 DWORD n_bytes_returned;
Brian Curtinf5e76d02010-11-24 13:14:05 +00001404
1405 if (0 == DeviceIoControl(
1406 reparse_point_handle,
1407 FSCTL_GET_REPARSE_POINT,
1408 NULL, 0, /* in buffer */
1409 target_buffer, sizeof(target_buffer),
1410 &n_bytes_returned,
1411 NULL)) /* we're not using OVERLAPPED_IO */
Brian Curtind25aef52011-06-13 15:16:04 -05001412 return FALSE;
Brian Curtinf5e76d02010-11-24 13:14:05 +00001413
1414 if (reparse_tag)
1415 *reparse_tag = rdb->ReparseTag;
1416
Brian Curtind25aef52011-06-13 15:16:04 -05001417 return TRUE;
Brian Curtinf5e76d02010-11-24 13:14:05 +00001418}
Victor Stinner1ab6c2d2011-11-15 22:27:41 +01001419
Brian Curtinfc1be6d2010-11-24 13:23:18 +00001420#endif /* MS_WINDOWS */
Brian Curtinf5e76d02010-11-24 13:14:05 +00001421
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001422/* Return a dictionary corresponding to the POSIX environment table */
Ronald Oussoren697e56d2013-01-25 17:57:13 +01001423#if defined(WITH_NEXT_FRAMEWORK) || (defined(__APPLE__) && defined(Py_ENABLE_SHARED))
Jack Jansenea0c3822002-08-01 21:57:49 +00001424/* On Darwin/MacOSX a shared library or framework has no access to
Ronald Oussoren697e56d2013-01-25 17:57:13 +01001425** environ directly, we must obtain it with _NSGetEnviron(). See also
1426** man environ(7).
Jack Jansenea0c3822002-08-01 21:57:49 +00001427*/
1428#include <crt_externs.h>
pxinwrf2d7ac72019-05-21 18:46:37 +08001429#elif !defined(_MSC_VER) && (!defined(__WATCOMC__) || defined(__QNX__) || defined(__VXWORKS__))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001430extern char **environ;
Guido van Rossuma4916fa1996-05-23 22:58:55 +00001431#endif /* !_MSC_VER */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001432
Barry Warsaw53699e91996-12-10 23:23:01 +00001433static PyObject *
Thomas Woutersf3f33dc2000-07-21 06:00:07 +00001434convertenviron(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001435{
Victor Stinner8c62be82010-05-06 00:08:46 +00001436 PyObject *d;
Thomas Hellerf78f12a2007-11-08 19:33:05 +00001437#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00001438 wchar_t **e;
Thomas Hellerf78f12a2007-11-08 19:33:05 +00001439#else
Victor Stinner8c62be82010-05-06 00:08:46 +00001440 char **e;
Thomas Hellerf78f12a2007-11-08 19:33:05 +00001441#endif
Guido van Rossumd48f2521997-12-05 22:19:34 +00001442
Victor Stinner8c62be82010-05-06 00:08:46 +00001443 d = PyDict_New();
1444 if (d == NULL)
1445 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00001446#ifdef MS_WINDOWS
1447 /* _wenviron must be initialized in this way if the program is started
1448 through main() instead of wmain(). */
1449 _wgetenv(L"");
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001450 e = _wenviron;
Benoit Hudson723f71a2019-12-06 14:15:03 -05001451#elif defined(WITH_NEXT_FRAMEWORK) || (defined(__APPLE__) && defined(Py_ENABLE_SHARED))
1452 /* environ is not accessible as an extern in a shared object on OSX; use
1453 _NSGetEnviron to resolve it. The value changes if you add environment
1454 variables between calls to Py_Initialize, so don't cache the value. */
1455 e = *_NSGetEnviron();
Victor Stinner8c62be82010-05-06 00:08:46 +00001456#else
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001457 e = environ;
1458#endif
1459 if (e == NULL)
Victor Stinner8c62be82010-05-06 00:08:46 +00001460 return d;
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001461 for (; *e != NULL; e++) {
Victor Stinner8c62be82010-05-06 00:08:46 +00001462 PyObject *k;
1463 PyObject *v;
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001464#ifdef MS_WINDOWS
1465 const wchar_t *p = wcschr(*e, L'=');
1466#else
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03001467 const char *p = strchr(*e, '=');
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001468#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00001469 if (p == NULL)
1470 continue;
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001471#ifdef MS_WINDOWS
1472 k = PyUnicode_FromWideChar(*e, (Py_ssize_t)(p-*e));
1473#else
Victor Stinner84ae1182010-05-06 22:05:07 +00001474 k = PyBytes_FromStringAndSize(*e, (int)(p-*e));
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001475#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00001476 if (k == NULL) {
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001477 Py_DECREF(d);
1478 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00001479 }
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001480#ifdef MS_WINDOWS
1481 v = PyUnicode_FromWideChar(p+1, wcslen(p+1));
1482#else
Victor Stinner84ae1182010-05-06 22:05:07 +00001483 v = PyBytes_FromStringAndSize(p+1, strlen(p+1));
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001484#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00001485 if (v == NULL) {
Victor Stinner8c62be82010-05-06 00:08:46 +00001486 Py_DECREF(k);
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001487 Py_DECREF(d);
1488 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00001489 }
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001490 if (PyDict_GetItemWithError(d, k) == NULL) {
1491 if (PyErr_Occurred() || PyDict_SetItem(d, k, v) != 0) {
1492 Py_DECREF(v);
1493 Py_DECREF(k);
1494 Py_DECREF(d);
1495 return NULL;
1496 }
Victor Stinner8c62be82010-05-06 00:08:46 +00001497 }
1498 Py_DECREF(k);
1499 Py_DECREF(v);
Guido van Rossumd48f2521997-12-05 22:19:34 +00001500 }
Victor Stinner8c62be82010-05-06 00:08:46 +00001501 return d;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001502}
1503
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001504/* Set a POSIX-specific error from errno, and return NULL */
1505
Barry Warsawd58d7641998-07-23 16:14:40 +00001506static PyObject *
Thomas Woutersf3f33dc2000-07-21 06:00:07 +00001507posix_error(void)
Guido van Rossumad0ee831995-03-01 10:34:45 +00001508{
Victor Stinner8c62be82010-05-06 00:08:46 +00001509 return PyErr_SetFromErrno(PyExc_OSError);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001510}
Mark Hammondef8b6542001-05-13 08:04:26 +00001511
Martin v. Löwis6238d2b2002-06-30 15:26:10 +00001512#ifdef MS_WINDOWS
Fredrik Lundhffb9c772000-07-09 14:49:51 +00001513static PyObject *
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001514win32_error(const char* function, const char* filename)
Fredrik Lundhffb9c772000-07-09 14:49:51 +00001515{
Victor Stinner8c62be82010-05-06 00:08:46 +00001516 /* XXX We should pass the function name along in the future.
1517 (winreg.c also wants to pass the function name.)
1518 This would however require an additional param to the
1519 Windows error object, which is non-trivial.
1520 */
1521 errno = GetLastError();
1522 if (filename)
1523 return PyErr_SetFromWindowsErrWithFilename(errno, filename);
1524 else
1525 return PyErr_SetFromWindowsErr(errno);
Fredrik Lundhffb9c772000-07-09 14:49:51 +00001526}
Mark Hammondc2e85bd2002-10-03 05:10:39 +00001527
Mark Hammondc2e85bd2002-10-03 05:10:39 +00001528static PyObject *
Steve Dower2438cdf2019-03-29 16:37:16 -07001529win32_error_object_err(const char* function, PyObject* filename, DWORD err)
Victor Stinnereb5657a2011-09-30 01:44:27 +02001530{
1531 /* XXX - see win32_error for comments on 'function' */
Victor Stinnereb5657a2011-09-30 01:44:27 +02001532 if (filename)
1533 return PyErr_SetExcFromWindowsErrWithFilenameObject(
Andrew Svetlov2606a6f2012-12-19 14:33:35 +02001534 PyExc_OSError,
Steve Dower2438cdf2019-03-29 16:37:16 -07001535 err,
Victor Stinnereb5657a2011-09-30 01:44:27 +02001536 filename);
1537 else
Steve Dower2438cdf2019-03-29 16:37:16 -07001538 return PyErr_SetFromWindowsErr(err);
1539}
1540
1541static PyObject *
1542win32_error_object(const char* function, PyObject* filename)
1543{
1544 errno = GetLastError();
1545 return win32_error_object_err(function, filename, errno);
Victor Stinnereb5657a2011-09-30 01:44:27 +02001546}
1547
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00001548#endif /* MS_WINDOWS */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001549
Larry Hastings9cf065c2012-06-22 16:30:09 -07001550static PyObject *
Alexey Izbyshev83460312018-10-20 03:28:22 +03001551posix_path_object_error(PyObject *path)
1552{
1553 return PyErr_SetFromErrnoWithFilenameObject(PyExc_OSError, path);
1554}
1555
1556static PyObject *
Serhiy Storchaka2674bc72016-10-08 20:16:57 +03001557path_object_error(PyObject *path)
Larry Hastings9cf065c2012-06-22 16:30:09 -07001558{
1559#ifdef MS_WINDOWS
Serhiy Storchaka2674bc72016-10-08 20:16:57 +03001560 return PyErr_SetExcFromWindowsErrWithFilenameObject(
1561 PyExc_OSError, 0, path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07001562#else
Alexey Izbyshev83460312018-10-20 03:28:22 +03001563 return posix_path_object_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07001564#endif
1565}
1566
Serhiy Storchaka2674bc72016-10-08 20:16:57 +03001567static PyObject *
1568path_object_error2(PyObject *path, PyObject *path2)
1569{
1570#ifdef MS_WINDOWS
1571 return PyErr_SetExcFromWindowsErrWithFilenameObjects(
1572 PyExc_OSError, 0, path, path2);
1573#else
1574 return PyErr_SetFromErrnoWithFilenameObjects(PyExc_OSError, path, path2);
1575#endif
1576}
1577
1578static PyObject *
1579path_error(path_t *path)
1580{
1581 return path_object_error(path->object);
1582}
Larry Hastings31826802013-10-19 00:09:25 -07001583
Larry Hastingsb0827312014-02-09 22:05:19 -08001584static PyObject *
Alexey Izbyshev83460312018-10-20 03:28:22 +03001585posix_path_error(path_t *path)
1586{
1587 return posix_path_object_error(path->object);
1588}
1589
1590static PyObject *
Larry Hastingsb0827312014-02-09 22:05:19 -08001591path_error2(path_t *path, path_t *path2)
1592{
Serhiy Storchaka2674bc72016-10-08 20:16:57 +03001593 return path_object_error2(path->object, path2->object);
Larry Hastingsb0827312014-02-09 22:05:19 -08001594}
1595
1596
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001597/* POSIX generic methods */
1598
Larry Hastings2f936352014-08-05 14:04:04 +10001599static int
1600fildes_converter(PyObject *o, void *p)
Fred Drake4d1e64b2002-04-15 19:40:07 +00001601{
Victor Stinner8c62be82010-05-06 00:08:46 +00001602 int fd;
Larry Hastings2f936352014-08-05 14:04:04 +10001603 int *pointer = (int *)p;
1604 fd = PyObject_AsFileDescriptor(o);
Victor Stinner8c62be82010-05-06 00:08:46 +00001605 if (fd < 0)
Larry Hastings2f936352014-08-05 14:04:04 +10001606 return 0;
Larry Hastings2f936352014-08-05 14:04:04 +10001607 *pointer = fd;
1608 return 1;
1609}
1610
1611static PyObject *
1612posix_fildes_fd(int fd, int (*func)(int))
1613{
1614 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00001615 int async_err = 0;
1616
1617 do {
1618 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04001619 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00001620 res = (*func)(fd);
Steve Dower8fc89802015-04-12 00:26:27 -04001621 _Py_END_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00001622 Py_END_ALLOW_THREADS
1623 } while (res != 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
1624 if (res != 0)
1625 return (!async_err) ? posix_error() : NULL;
1626 Py_RETURN_NONE;
Fred Drake4d1e64b2002-04-15 19:40:07 +00001627}
Guido van Rossum21142a01999-01-08 21:05:37 +00001628
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001629
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00001630#ifdef MS_WINDOWS
Thomas Wouters477c8d52006-05-27 19:21:47 +00001631/* This is a reimplementation of the C library's chdir function,
1632 but one that produces Win32 errors instead of DOS error codes.
1633 chdir is essentially a wrapper around SetCurrentDirectory; however,
1634 it also needs to set "magic" environment variables indicating
1635 the per-drive current directory, which are of the form =<drive>: */
Benjamin Peterson206e3072008-10-19 14:07:49 +00001636static BOOL __stdcall
Thomas Wouters477c8d52006-05-27 19:21:47 +00001637win32_wchdir(LPCWSTR path)
1638{
Victor Stinnered537822015-12-13 21:40:26 +01001639 wchar_t path_buf[MAX_PATH], *new_path = path_buf;
Victor Stinner8c62be82010-05-06 00:08:46 +00001640 int result;
1641 wchar_t env[4] = L"=x:";
Thomas Wouters477c8d52006-05-27 19:21:47 +00001642
Victor Stinner8c62be82010-05-06 00:08:46 +00001643 if(!SetCurrentDirectoryW(path))
1644 return FALSE;
Victor Stinnered537822015-12-13 21:40:26 +01001645 result = GetCurrentDirectoryW(Py_ARRAY_LENGTH(path_buf), new_path);
Victor Stinner8c62be82010-05-06 00:08:46 +00001646 if (!result)
1647 return FALSE;
Victor Stinnere847d712015-12-14 00:21:50 +01001648 if (result > Py_ARRAY_LENGTH(path_buf)) {
Victor Stinnerb6404912013-07-07 16:21:41 +02001649 new_path = PyMem_RawMalloc(result * sizeof(wchar_t));
Victor Stinner8c62be82010-05-06 00:08:46 +00001650 if (!new_path) {
1651 SetLastError(ERROR_OUTOFMEMORY);
1652 return FALSE;
1653 }
1654 result = GetCurrentDirectoryW(result, new_path);
1655 if (!result) {
Victor Stinnerb6404912013-07-07 16:21:41 +02001656 PyMem_RawFree(new_path);
Victor Stinner8c62be82010-05-06 00:08:46 +00001657 return FALSE;
1658 }
1659 }
Alexey Izbyshev3e197c72018-03-01 12:13:56 +03001660 int is_unc_like_path = (wcsncmp(new_path, L"\\\\", 2) == 0 ||
1661 wcsncmp(new_path, L"//", 2) == 0);
1662 if (!is_unc_like_path) {
1663 env[1] = new_path[0];
1664 result = SetEnvironmentVariableW(env, new_path);
1665 }
Victor Stinnered537822015-12-13 21:40:26 +01001666 if (new_path != path_buf)
Victor Stinnerb6404912013-07-07 16:21:41 +02001667 PyMem_RawFree(new_path);
Alexey Izbyshev3e197c72018-03-01 12:13:56 +03001668 return result ? TRUE : FALSE;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001669}
1670#endif
1671
Martin v. Löwis14694662006-02-03 12:54:16 +00001672#ifdef MS_WINDOWS
1673/* The CRT of Windows has a number of flaws wrt. its stat() implementation:
1674 - time stamps are restricted to second resolution
1675 - file modification times suffer from forth-and-back conversions between
1676 UTC and local time
1677 Therefore, we implement our own stat, based on the Win32 API directly.
1678*/
Victor Stinner8c62be82010-05-06 00:08:46 +00001679#define HAVE_STAT_NSEC 1
Zachary Ware63f277b2014-06-19 09:46:37 -05001680#define HAVE_STRUCT_STAT_ST_FILE_ATTRIBUTES 1
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001681#define HAVE_STRUCT_STAT_ST_REPARSE_TAG 1
Martin v. Löwis14694662006-02-03 12:54:16 +00001682
Victor Stinner6036e442015-03-08 01:58:04 +01001683static void
Steve Dowercc16be82016-09-08 10:35:16 -07001684find_data_to_file_info(WIN32_FIND_DATAW *pFileData,
1685 BY_HANDLE_FILE_INFORMATION *info,
1686 ULONG *reparse_tag)
Victor Stinner6036e442015-03-08 01:58:04 +01001687{
1688 memset(info, 0, sizeof(*info));
1689 info->dwFileAttributes = pFileData->dwFileAttributes;
1690 info->ftCreationTime = pFileData->ftCreationTime;
1691 info->ftLastAccessTime = pFileData->ftLastAccessTime;
1692 info->ftLastWriteTime = pFileData->ftLastWriteTime;
1693 info->nFileSizeHigh = pFileData->nFileSizeHigh;
1694 info->nFileSizeLow = pFileData->nFileSizeLow;
1695/* info->nNumberOfLinks = 1; */
1696 if (pFileData->dwFileAttributes & FILE_ATTRIBUTE_REPARSE_POINT)
1697 *reparse_tag = pFileData->dwReserved0;
1698 else
1699 *reparse_tag = 0;
1700}
1701
Guido van Rossumd8faa362007-04-27 19:54:29 +00001702static BOOL
Steve Dowercc16be82016-09-08 10:35:16 -07001703attributes_from_dir(LPCWSTR pszFile, BY_HANDLE_FILE_INFORMATION *info, ULONG *reparse_tag)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001704{
Victor Stinner8c62be82010-05-06 00:08:46 +00001705 HANDLE hFindFile;
1706 WIN32_FIND_DATAW FileData;
1707 hFindFile = FindFirstFileW(pszFile, &FileData);
1708 if (hFindFile == INVALID_HANDLE_VALUE)
1709 return FALSE;
1710 FindClose(hFindFile);
Steve Dowercc16be82016-09-08 10:35:16 -07001711 find_data_to_file_info(&FileData, info, reparse_tag);
Victor Stinner8c62be82010-05-06 00:08:46 +00001712 return TRUE;
Guido van Rossumd8faa362007-04-27 19:54:29 +00001713}
1714
Brian Curtind25aef52011-06-13 15:16:04 -05001715static int
Steve Dowercc16be82016-09-08 10:35:16 -07001716win32_xstat_impl(const wchar_t *path, struct _Py_stat_struct *result,
Brian Curtind25aef52011-06-13 15:16:04 -05001717 BOOL traverse)
1718{
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001719 HANDLE hFile;
1720 BY_HANDLE_FILE_INFORMATION fileInfo;
1721 FILE_ATTRIBUTE_TAG_INFO tagInfo = { 0 };
1722 DWORD fileType, error;
1723 BOOL isUnhandledTag = FALSE;
1724 int retval = 0;
Brian Curtinf5e76d02010-11-24 13:14:05 +00001725
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001726 DWORD access = FILE_READ_ATTRIBUTES;
1727 DWORD flags = FILE_FLAG_BACKUP_SEMANTICS; /* Allow opening directories. */
1728 if (!traverse) {
1729 flags |= FILE_FLAG_OPEN_REPARSE_POINT;
1730 }
Brian Curtinf5e76d02010-11-24 13:14:05 +00001731
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001732 hFile = CreateFileW(path, access, 0, NULL, OPEN_EXISTING, flags, NULL);
Hirokazu Yamamoto427d3142010-12-04 10:16:05 +00001733 if (hFile == INVALID_HANDLE_VALUE) {
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001734 /* Either the path doesn't exist, or the caller lacks access. */
1735 error = GetLastError();
1736 switch (error) {
1737 case ERROR_ACCESS_DENIED: /* Cannot sync or read attributes. */
1738 case ERROR_SHARING_VIOLATION: /* It's a paging file. */
1739 /* Try reading the parent directory. */
1740 if (!attributes_from_dir(path, &fileInfo, &tagInfo.ReparseTag)) {
1741 /* Cannot read the parent directory. */
1742 SetLastError(error);
Hirokazu Yamamoto427d3142010-12-04 10:16:05 +00001743 return -1;
Brian Curtinf5e76d02010-11-24 13:14:05 +00001744 }
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001745 if (fileInfo.dwFileAttributes & FILE_ATTRIBUTE_REPARSE_POINT) {
1746 if (traverse ||
1747 !IsReparseTagNameSurrogate(tagInfo.ReparseTag)) {
1748 /* The stat call has to traverse but cannot, so fail. */
1749 SetLastError(error);
Brian Curtind25aef52011-06-13 15:16:04 -05001750 return -1;
Mark Becwarb82bfac2019-02-02 16:08:23 -05001751 }
Hirokazu Yamamoto427d3142010-12-04 10:16:05 +00001752 }
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001753 break;
Brian Curtinf5e76d02010-11-24 13:14:05 +00001754
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001755 case ERROR_INVALID_PARAMETER:
1756 /* \\.\con requires read or write access. */
1757 hFile = CreateFileW(path, access | GENERIC_READ,
1758 FILE_SHARE_READ | FILE_SHARE_WRITE, NULL,
1759 OPEN_EXISTING, flags, NULL);
1760 if (hFile == INVALID_HANDLE_VALUE) {
1761 SetLastError(error);
1762 return -1;
1763 }
1764 break;
1765
1766 case ERROR_CANT_ACCESS_FILE:
1767 /* bpo37834: open unhandled reparse points if traverse fails. */
1768 if (traverse) {
1769 traverse = FALSE;
1770 isUnhandledTag = TRUE;
1771 hFile = CreateFileW(path, access, 0, NULL, OPEN_EXISTING,
1772 flags | FILE_FLAG_OPEN_REPARSE_POINT, NULL);
1773 }
1774 if (hFile == INVALID_HANDLE_VALUE) {
1775 SetLastError(error);
1776 return -1;
1777 }
1778 break;
1779
1780 default:
1781 return -1;
1782 }
Brian Curtinf5e76d02010-11-24 13:14:05 +00001783 }
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001784
1785 if (hFile != INVALID_HANDLE_VALUE) {
1786 /* Handle types other than files on disk. */
1787 fileType = GetFileType(hFile);
1788 if (fileType != FILE_TYPE_DISK) {
1789 if (fileType == FILE_TYPE_UNKNOWN && GetLastError() != 0) {
1790 retval = -1;
1791 goto cleanup;
1792 }
1793 DWORD fileAttributes = GetFileAttributesW(path);
1794 memset(result, 0, sizeof(*result));
1795 if (fileAttributes != INVALID_FILE_ATTRIBUTES &&
1796 fileAttributes & FILE_ATTRIBUTE_DIRECTORY) {
1797 /* \\.\pipe\ or \\.\mailslot\ */
1798 result->st_mode = _S_IFDIR;
1799 } else if (fileType == FILE_TYPE_CHAR) {
1800 /* \\.\nul */
1801 result->st_mode = _S_IFCHR;
1802 } else if (fileType == FILE_TYPE_PIPE) {
1803 /* \\.\pipe\spam */
1804 result->st_mode = _S_IFIFO;
1805 }
1806 /* FILE_TYPE_UNKNOWN, e.g. \\.\mailslot\waitfor.exe\spam */
1807 goto cleanup;
1808 }
1809
1810 /* Query the reparse tag, and traverse a non-link. */
1811 if (!traverse) {
1812 if (!GetFileInformationByHandleEx(hFile, FileAttributeTagInfo,
1813 &tagInfo, sizeof(tagInfo))) {
1814 /* Allow devices that do not support FileAttributeTagInfo. */
1815 switch (GetLastError()) {
1816 case ERROR_INVALID_PARAMETER:
1817 case ERROR_INVALID_FUNCTION:
1818 case ERROR_NOT_SUPPORTED:
1819 tagInfo.FileAttributes = FILE_ATTRIBUTE_NORMAL;
1820 tagInfo.ReparseTag = 0;
1821 break;
1822 default:
1823 retval = -1;
1824 goto cleanup;
1825 }
1826 } else if (tagInfo.FileAttributes &
1827 FILE_ATTRIBUTE_REPARSE_POINT) {
1828 if (IsReparseTagNameSurrogate(tagInfo.ReparseTag)) {
1829 if (isUnhandledTag) {
1830 /* Traversing previously failed for either this link
1831 or its target. */
1832 SetLastError(ERROR_CANT_ACCESS_FILE);
1833 retval = -1;
1834 goto cleanup;
1835 }
1836 /* Traverse a non-link, but not if traversing already failed
1837 for an unhandled tag. */
1838 } else if (!isUnhandledTag) {
1839 CloseHandle(hFile);
1840 return win32_xstat_impl(path, result, TRUE);
1841 }
1842 }
1843 }
1844
1845 if (!GetFileInformationByHandle(hFile, &fileInfo)) {
1846 switch (GetLastError()) {
1847 case ERROR_INVALID_PARAMETER:
1848 case ERROR_INVALID_FUNCTION:
1849 case ERROR_NOT_SUPPORTED:
Steve Dower772ec0f2019-09-04 14:42:54 -07001850 /* Volumes and physical disks are block devices, e.g.
1851 \\.\C: and \\.\PhysicalDrive0. */
1852 memset(result, 0, sizeof(*result));
1853 result->st_mode = 0x6000; /* S_IFBLK */
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001854 goto cleanup;
1855 }
Steve Dower772ec0f2019-09-04 14:42:54 -07001856 retval = -1;
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001857 goto cleanup;
1858 }
1859 }
1860
1861 _Py_attribute_data_to_stat(&fileInfo, tagInfo.ReparseTag, result);
1862
1863 if (!(fileInfo.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)) {
1864 /* Fix the file execute permissions. This hack sets S_IEXEC if
1865 the filename has an extension that is commonly used by files
1866 that CreateProcessW can execute. A real implementation calls
1867 GetSecurityInfo, OpenThreadToken/OpenProcessToken, and
1868 AccessCheck to check for generic read, write, and execute
1869 access. */
1870 const wchar_t *fileExtension = wcsrchr(path, '.');
1871 if (fileExtension) {
1872 if (_wcsicmp(fileExtension, L".exe") == 0 ||
1873 _wcsicmp(fileExtension, L".bat") == 0 ||
1874 _wcsicmp(fileExtension, L".cmd") == 0 ||
1875 _wcsicmp(fileExtension, L".com") == 0) {
1876 result->st_mode |= 0111;
1877 }
1878 }
1879 }
1880
1881cleanup:
1882 if (hFile != INVALID_HANDLE_VALUE) {
Steve Dower772ec0f2019-09-04 14:42:54 -07001883 /* Preserve last error if we are failing */
1884 error = retval ? GetLastError() : 0;
1885 if (!CloseHandle(hFile)) {
1886 retval = -1;
1887 } else if (retval) {
1888 /* Restore last error */
1889 SetLastError(error);
1890 }
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001891 }
1892
1893 return retval;
Brian Curtinf5e76d02010-11-24 13:14:05 +00001894}
1895
1896static int
Steve Dowercc16be82016-09-08 10:35:16 -07001897win32_xstat(const wchar_t *path, struct _Py_stat_struct *result, BOOL traverse)
Brian Curtinf5e76d02010-11-24 13:14:05 +00001898{
Hirokazu Yamamoto427d3142010-12-04 10:16:05 +00001899 /* Protocol violation: we explicitly clear errno, instead of
1900 setting it to a POSIX error. Callers should use GetLastError. */
Brian Curtind25aef52011-06-13 15:16:04 -05001901 int code = win32_xstat_impl(path, result, traverse);
Hirokazu Yamamoto427d3142010-12-04 10:16:05 +00001902 errno = 0;
1903 return code;
1904}
Brian Curtind25aef52011-06-13 15:16:04 -05001905/* About the following functions: win32_lstat_w, win32_stat, win32_stat_w
Brian Curtind40e6f72010-07-08 21:39:08 +00001906
1907 In Posix, stat automatically traverses symlinks and returns the stat
1908 structure for the target. In Windows, the equivalent GetFileAttributes by
1909 default does not traverse symlinks and instead returns attributes for
1910 the symlink.
1911
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001912 Instead, we will open the file (which *does* traverse symlinks by default)
1913 and GetFileInformationByHandle(). */
Brian Curtind40e6f72010-07-08 21:39:08 +00001914
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00001915static int
Steve Dowercc16be82016-09-08 10:35:16 -07001916win32_lstat(const wchar_t* path, struct _Py_stat_struct *result)
Martin v. Löwis14694662006-02-03 12:54:16 +00001917{
Hirokazu Yamamoto427d3142010-12-04 10:16:05 +00001918 return win32_xstat(path, result, FALSE);
Martin v. Löwis14694662006-02-03 12:54:16 +00001919}
1920
Victor Stinner8c62be82010-05-06 00:08:46 +00001921static int
Steve Dowercc16be82016-09-08 10:35:16 -07001922win32_stat(const wchar_t* path, struct _Py_stat_struct *result)
Brian Curtind40e6f72010-07-08 21:39:08 +00001923{
Hirokazu Yamamoto427d3142010-12-04 10:16:05 +00001924 return win32_xstat(path, result, TRUE);
Brian Curtind40e6f72010-07-08 21:39:08 +00001925}
1926
Martin v. Löwis14694662006-02-03 12:54:16 +00001927#endif /* MS_WINDOWS */
1928
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001929PyDoc_STRVAR(stat_result__doc__,
Larry Hastings9cf065c2012-06-22 16:30:09 -07001930"stat_result: Result from stat, fstat, or lstat.\n\n\
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001931This object may be accessed either as a tuple of\n\
Fred Drakef7ce04d2002-06-20 18:31:21 +00001932 (mode, ino, dev, nlink, uid, gid, size, atime, mtime, ctime)\n\
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001933or via the attributes st_mode, st_ino, st_dev, st_nlink, st_uid, and so on.\n\
1934\n\
Hye-Shik Chang5f937a72005-06-02 13:09:30 +00001935Posix/windows: If your platform supports st_blksize, st_blocks, st_rdev,\n\
1936or st_flags, they are available as attributes only.\n\
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001937\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001938See os.stat for more information.");
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001939
1940static PyStructSequence_Field stat_result_fields[] = {
Victor Stinner8c62be82010-05-06 00:08:46 +00001941 {"st_mode", "protection bits"},
1942 {"st_ino", "inode"},
1943 {"st_dev", "device"},
1944 {"st_nlink", "number of hard links"},
1945 {"st_uid", "user ID of owner"},
1946 {"st_gid", "group ID of owner"},
1947 {"st_size", "total size, in bytes"},
1948 /* The NULL is replaced with PyStructSequence_UnnamedField later. */
1949 {NULL, "integer time of last access"},
1950 {NULL, "integer time of last modification"},
1951 {NULL, "integer time of last change"},
1952 {"st_atime", "time of last access"},
1953 {"st_mtime", "time of last modification"},
1954 {"st_ctime", "time of last change"},
Larry Hastings6fe20b32012-04-19 15:07:49 -07001955 {"st_atime_ns", "time of last access in nanoseconds"},
1956 {"st_mtime_ns", "time of last modification in nanoseconds"},
1957 {"st_ctime_ns", "time of last change in nanoseconds"},
Martin v. Löwis60a5d722002-10-16 20:28:25 +00001958#ifdef HAVE_STRUCT_STAT_ST_BLKSIZE
Victor Stinner8c62be82010-05-06 00:08:46 +00001959 {"st_blksize", "blocksize for filesystem I/O"},
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001960#endif
Martin v. Löwis60a5d722002-10-16 20:28:25 +00001961#ifdef HAVE_STRUCT_STAT_ST_BLOCKS
Victor Stinner8c62be82010-05-06 00:08:46 +00001962 {"st_blocks", "number of blocks allocated"},
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001963#endif
Martin v. Löwis60a5d722002-10-16 20:28:25 +00001964#ifdef HAVE_STRUCT_STAT_ST_RDEV
Victor Stinner8c62be82010-05-06 00:08:46 +00001965 {"st_rdev", "device type (if inode device)"},
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001966#endif
Hye-Shik Chang5f937a72005-06-02 13:09:30 +00001967#ifdef HAVE_STRUCT_STAT_ST_FLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +00001968 {"st_flags", "user defined flags for file"},
Hye-Shik Chang5f937a72005-06-02 13:09:30 +00001969#endif
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00001970#ifdef HAVE_STRUCT_STAT_ST_GEN
Victor Stinner8c62be82010-05-06 00:08:46 +00001971 {"st_gen", "generation number"},
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00001972#endif
1973#ifdef HAVE_STRUCT_STAT_ST_BIRTHTIME
Victor Stinner8c62be82010-05-06 00:08:46 +00001974 {"st_birthtime", "time of creation"},
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00001975#endif
Zachary Ware63f277b2014-06-19 09:46:37 -05001976#ifdef HAVE_STRUCT_STAT_ST_FILE_ATTRIBUTES
1977 {"st_file_attributes", "Windows file attribute bits"},
1978#endif
jcea6c51d512018-01-28 14:00:08 +01001979#ifdef HAVE_STRUCT_STAT_ST_FSTYPE
1980 {"st_fstype", "Type of filesystem"},
1981#endif
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001982#ifdef HAVE_STRUCT_STAT_ST_REPARSE_TAG
1983 {"st_reparse_tag", "Windows reparse tag"},
1984#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00001985 {0}
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001986};
1987
Martin v. Löwis60a5d722002-10-16 20:28:25 +00001988#ifdef HAVE_STRUCT_STAT_ST_BLKSIZE
Larry Hastings6fe20b32012-04-19 15:07:49 -07001989#define ST_BLKSIZE_IDX 16
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001990#else
Larry Hastings6fe20b32012-04-19 15:07:49 -07001991#define ST_BLKSIZE_IDX 15
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001992#endif
1993
Martin v. Löwis60a5d722002-10-16 20:28:25 +00001994#ifdef HAVE_STRUCT_STAT_ST_BLOCKS
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001995#define ST_BLOCKS_IDX (ST_BLKSIZE_IDX+1)
1996#else
1997#define ST_BLOCKS_IDX ST_BLKSIZE_IDX
1998#endif
1999
Martin v. Löwis60a5d722002-10-16 20:28:25 +00002000#ifdef HAVE_STRUCT_STAT_ST_RDEV
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002001#define ST_RDEV_IDX (ST_BLOCKS_IDX+1)
2002#else
2003#define ST_RDEV_IDX ST_BLOCKS_IDX
2004#endif
2005
Hye-Shik Chang5f937a72005-06-02 13:09:30 +00002006#ifdef HAVE_STRUCT_STAT_ST_FLAGS
2007#define ST_FLAGS_IDX (ST_RDEV_IDX+1)
2008#else
2009#define ST_FLAGS_IDX ST_RDEV_IDX
2010#endif
2011
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002012#ifdef HAVE_STRUCT_STAT_ST_GEN
Martin v. Löwisf09582e2005-08-14 21:42:34 +00002013#define ST_GEN_IDX (ST_FLAGS_IDX+1)
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002014#else
Martin v. Löwisf09582e2005-08-14 21:42:34 +00002015#define ST_GEN_IDX ST_FLAGS_IDX
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002016#endif
2017
2018#ifdef HAVE_STRUCT_STAT_ST_BIRTHTIME
2019#define ST_BIRTHTIME_IDX (ST_GEN_IDX+1)
2020#else
2021#define ST_BIRTHTIME_IDX ST_GEN_IDX
2022#endif
2023
Zachary Ware63f277b2014-06-19 09:46:37 -05002024#ifdef HAVE_STRUCT_STAT_ST_FILE_ATTRIBUTES
2025#define ST_FILE_ATTRIBUTES_IDX (ST_BIRTHTIME_IDX+1)
2026#else
2027#define ST_FILE_ATTRIBUTES_IDX ST_BIRTHTIME_IDX
2028#endif
2029
jcea6c51d512018-01-28 14:00:08 +01002030#ifdef HAVE_STRUCT_STAT_ST_FSTYPE
2031#define ST_FSTYPE_IDX (ST_FILE_ATTRIBUTES_IDX+1)
2032#else
2033#define ST_FSTYPE_IDX ST_FILE_ATTRIBUTES_IDX
2034#endif
2035
Steve Dowerdf2d4a62019-08-21 15:27:33 -07002036#ifdef HAVE_STRUCT_STAT_ST_REPARSE_TAG
2037#define ST_REPARSE_TAG_IDX (ST_FSTYPE_IDX+1)
2038#else
2039#define ST_REPARSE_TAG_IDX ST_FSTYPE_IDX
2040#endif
2041
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002042static PyStructSequence_Desc stat_result_desc = {
Victor Stinner8c62be82010-05-06 00:08:46 +00002043 "stat_result", /* name */
2044 stat_result__doc__, /* doc */
2045 stat_result_fields,
2046 10
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002047};
2048
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002049PyDoc_STRVAR(statvfs_result__doc__,
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002050"statvfs_result: Result from statvfs or fstatvfs.\n\n\
2051This object may be accessed either as a tuple of\n\
Fred Drakef7ce04d2002-06-20 18:31:21 +00002052 (bsize, frsize, blocks, bfree, bavail, files, ffree, favail, flag, namemax),\n\
Guido van Rossuma4dc73e2001-10-18 20:53:15 +00002053or via the attributes f_bsize, f_frsize, f_blocks, f_bfree, and so on.\n\
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002054\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002055See os.statvfs for more information.");
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002056
2057static PyStructSequence_Field statvfs_result_fields[] = {
Victor Stinner8c62be82010-05-06 00:08:46 +00002058 {"f_bsize", },
2059 {"f_frsize", },
2060 {"f_blocks", },
2061 {"f_bfree", },
2062 {"f_bavail", },
2063 {"f_files", },
2064 {"f_ffree", },
2065 {"f_favail", },
2066 {"f_flag", },
2067 {"f_namemax",},
Giuseppe Scrivano96a5e502017-12-14 23:46:46 +01002068 {"f_fsid", },
Victor Stinner8c62be82010-05-06 00:08:46 +00002069 {0}
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002070};
2071
2072static PyStructSequence_Desc statvfs_result_desc = {
Victor Stinner8c62be82010-05-06 00:08:46 +00002073 "statvfs_result", /* name */
2074 statvfs_result__doc__, /* doc */
2075 statvfs_result_fields,
2076 10
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002077};
2078
Ross Lagerwall7807c352011-03-17 20:20:30 +02002079#if defined(HAVE_WAITID) && !defined(__APPLE__)
2080PyDoc_STRVAR(waitid_result__doc__,
2081"waitid_result: Result from waitid.\n\n\
2082This object may be accessed either as a tuple of\n\
2083 (si_pid, si_uid, si_signo, si_status, si_code),\n\
2084or via the attributes si_pid, si_uid, and so on.\n\
2085\n\
2086See os.waitid for more information.");
2087
2088static PyStructSequence_Field waitid_result_fields[] = {
2089 {"si_pid", },
2090 {"si_uid", },
2091 {"si_signo", },
2092 {"si_status", },
2093 {"si_code", },
2094 {0}
2095};
2096
2097static PyStructSequence_Desc waitid_result_desc = {
2098 "waitid_result", /* name */
2099 waitid_result__doc__, /* doc */
2100 waitid_result_fields,
2101 5
2102};
Benjamin Petersonbad9c2f2011-08-02 18:42:14 -05002103#endif
Martin v. Löwisf607bda2002-10-16 18:27:39 +00002104static newfunc structseq_new;
2105
2106static PyObject *
2107statresult_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
2108{
Victor Stinner8c62be82010-05-06 00:08:46 +00002109 PyStructSequence *result;
2110 int i;
Martin v. Löwisf607bda2002-10-16 18:27:39 +00002111
Victor Stinner8c62be82010-05-06 00:08:46 +00002112 result = (PyStructSequence*)structseq_new(type, args, kwds);
2113 if (!result)
2114 return NULL;
2115 /* If we have been initialized from a tuple,
2116 st_?time might be set to None. Initialize it
2117 from the int slots. */
2118 for (i = 7; i <= 9; i++) {
2119 if (result->ob_item[i+3] == Py_None) {
2120 Py_DECREF(Py_None);
2121 Py_INCREF(result->ob_item[i]);
2122 result->ob_item[i+3] = result->ob_item[i];
2123 }
2124 }
2125 return (PyObject*)result;
Martin v. Löwisf607bda2002-10-16 18:27:39 +00002126}
2127
Eddie Elizondob3966632019-11-05 07:16:14 -08002128static int
2129_posix_clear(PyObject *module)
2130{
Victor Stinner97f33c32020-05-14 18:05:58 +02002131 _posixstate *state = get_posix_state(module);
2132 Py_CLEAR(state->billion);
2133 Py_CLEAR(state->DirEntryType);
2134 Py_CLEAR(state->ScandirIteratorType);
Eddie Elizondob3966632019-11-05 07:16:14 -08002135#if defined(HAVE_SCHED_SETPARAM) || defined(HAVE_SCHED_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDPARAM)
Victor Stinner97f33c32020-05-14 18:05:58 +02002136 Py_CLEAR(state->SchedParamType);
Eddie Elizondob3966632019-11-05 07:16:14 -08002137#endif
Victor Stinner97f33c32020-05-14 18:05:58 +02002138 Py_CLEAR(state->StatResultType);
2139 Py_CLEAR(state->StatVFSResultType);
2140 Py_CLEAR(state->TerminalSizeType);
2141 Py_CLEAR(state->TimesResultType);
2142 Py_CLEAR(state->UnameResultType);
Eddie Elizondob3966632019-11-05 07:16:14 -08002143#if defined(HAVE_WAITID) && !defined(__APPLE__)
Victor Stinner97f33c32020-05-14 18:05:58 +02002144 Py_CLEAR(state->WaitidResultType);
Eddie Elizondob3966632019-11-05 07:16:14 -08002145#endif
2146#if defined(HAVE_WAIT3) || defined(HAVE_WAIT4)
Victor Stinner97f33c32020-05-14 18:05:58 +02002147 Py_CLEAR(state->struct_rusage);
Eddie Elizondob3966632019-11-05 07:16:14 -08002148#endif
Victor Stinner97f33c32020-05-14 18:05:58 +02002149 Py_CLEAR(state->st_mode);
Eddie Elizondob3966632019-11-05 07:16:14 -08002150 return 0;
2151}
Martin v. Löwisf607bda2002-10-16 18:27:39 +00002152
Eddie Elizondob3966632019-11-05 07:16:14 -08002153static int
2154_posix_traverse(PyObject *module, visitproc visit, void *arg)
2155{
Victor Stinner97f33c32020-05-14 18:05:58 +02002156 _posixstate *state = get_posix_state(module);
2157 Py_VISIT(state->billion);
2158 Py_VISIT(state->DirEntryType);
2159 Py_VISIT(state->ScandirIteratorType);
Eddie Elizondob3966632019-11-05 07:16:14 -08002160#if defined(HAVE_SCHED_SETPARAM) || defined(HAVE_SCHED_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDPARAM)
Victor Stinner97f33c32020-05-14 18:05:58 +02002161 Py_VISIT(state->SchedParamType);
Eddie Elizondob3966632019-11-05 07:16:14 -08002162#endif
Victor Stinner97f33c32020-05-14 18:05:58 +02002163 Py_VISIT(state->StatResultType);
2164 Py_VISIT(state->StatVFSResultType);
2165 Py_VISIT(state->TerminalSizeType);
2166 Py_VISIT(state->TimesResultType);
2167 Py_VISIT(state->UnameResultType);
Eddie Elizondob3966632019-11-05 07:16:14 -08002168#if defined(HAVE_WAITID) && !defined(__APPLE__)
Victor Stinner97f33c32020-05-14 18:05:58 +02002169 Py_VISIT(state->WaitidResultType);
Eddie Elizondob3966632019-11-05 07:16:14 -08002170#endif
2171#if defined(HAVE_WAIT3) || defined(HAVE_WAIT4)
Victor Stinner97f33c32020-05-14 18:05:58 +02002172 Py_VISIT(state->struct_rusage);
Eddie Elizondob3966632019-11-05 07:16:14 -08002173#endif
Victor Stinner97f33c32020-05-14 18:05:58 +02002174 Py_VISIT(state->st_mode);
Eddie Elizondob3966632019-11-05 07:16:14 -08002175 return 0;
2176}
2177
2178static void
2179_posix_free(void *module)
2180{
2181 _posix_clear((PyObject *)module);
2182}
Larry Hastings6fe20b32012-04-19 15:07:49 -07002183
Martin v. Löwis94717ed2002-09-09 14:24:16 +00002184static void
Victor Stinner1c2fa782020-05-10 11:05:29 +02002185fill_time(PyObject *module, PyObject *v, int index, time_t sec, unsigned long nsec)
Martin v. Löwis94717ed2002-09-09 14:24:16 +00002186{
Larry Hastings6fe20b32012-04-19 15:07:49 -07002187 PyObject *s = _PyLong_FromTime_t(sec);
2188 PyObject *ns_fractional = PyLong_FromUnsignedLong(nsec);
2189 PyObject *s_in_ns = NULL;
2190 PyObject *ns_total = NULL;
2191 PyObject *float_s = NULL;
2192
2193 if (!(s && ns_fractional))
2194 goto exit;
2195
Victor Stinner1c2fa782020-05-10 11:05:29 +02002196 s_in_ns = PyNumber_Multiply(s, get_posix_state(module)->billion);
Larry Hastings6fe20b32012-04-19 15:07:49 -07002197 if (!s_in_ns)
2198 goto exit;
2199
2200 ns_total = PyNumber_Add(s_in_ns, ns_fractional);
2201 if (!ns_total)
2202 goto exit;
2203
Victor Stinner01b5aab2017-10-24 02:02:00 -07002204 float_s = PyFloat_FromDouble(sec + 1e-9*nsec);
2205 if (!float_s) {
2206 goto exit;
Larry Hastings6fe20b32012-04-19 15:07:49 -07002207 }
2208
2209 PyStructSequence_SET_ITEM(v, index, s);
2210 PyStructSequence_SET_ITEM(v, index+3, float_s);
2211 PyStructSequence_SET_ITEM(v, index+6, ns_total);
2212 s = NULL;
2213 float_s = NULL;
2214 ns_total = NULL;
2215exit:
2216 Py_XDECREF(s);
2217 Py_XDECREF(ns_fractional);
2218 Py_XDECREF(s_in_ns);
2219 Py_XDECREF(ns_total);
2220 Py_XDECREF(float_s);
Martin v. Löwis94717ed2002-09-09 14:24:16 +00002221}
2222
Tim Peters5aa91602002-01-30 05:46:57 +00002223/* pack a system stat C structure into the Python stat tuple
Fred Drake699f3522000-06-29 21:12:41 +00002224 (used by posix_stat() and posix_fstat()) */
2225static PyObject*
Victor Stinner1c2fa782020-05-10 11:05:29 +02002226_pystat_fromstructstat(PyObject *module, STRUCT_STAT *st)
Fred Drake699f3522000-06-29 21:12:41 +00002227{
Victor Stinner8c62be82010-05-06 00:08:46 +00002228 unsigned long ansec, mnsec, cnsec;
Victor Stinner1c2fa782020-05-10 11:05:29 +02002229 PyObject *StatResultType = get_posix_state(module)->StatResultType;
Eddie Elizondob3966632019-11-05 07:16:14 -08002230 PyObject *v = PyStructSequence_New((PyTypeObject *)StatResultType);
Victor Stinner8c62be82010-05-06 00:08:46 +00002231 if (v == NULL)
2232 return NULL;
Fred Drake699f3522000-06-29 21:12:41 +00002233
Victor Stinner8c62be82010-05-06 00:08:46 +00002234 PyStructSequence_SET_ITEM(v, 0, PyLong_FromLong((long)st->st_mode));
Victor Stinner0f6d7332017-03-09 17:34:28 +01002235 Py_BUILD_ASSERT(sizeof(unsigned long long) >= sizeof(st->st_ino));
xdegaye50e86032017-05-22 11:15:08 +02002236 PyStructSequence_SET_ITEM(v, 1, PyLong_FromUnsignedLongLong(st->st_ino));
Serhiy Storchaka404fa922013-01-02 18:22:23 +02002237#ifdef MS_WINDOWS
2238 PyStructSequence_SET_ITEM(v, 2, PyLong_FromUnsignedLong(st->st_dev));
Fred Drake699f3522000-06-29 21:12:41 +00002239#else
Serhiy Storchakab2653b32015-01-18 11:12:11 +02002240 PyStructSequence_SET_ITEM(v, 2, _PyLong_FromDev(st->st_dev));
Fred Drake699f3522000-06-29 21:12:41 +00002241#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00002242 PyStructSequence_SET_ITEM(v, 3, PyLong_FromLong((long)st->st_nlink));
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02002243#if defined(MS_WINDOWS)
2244 PyStructSequence_SET_ITEM(v, 4, PyLong_FromLong(0));
2245 PyStructSequence_SET_ITEM(v, 5, PyLong_FromLong(0));
2246#else
2247 PyStructSequence_SET_ITEM(v, 4, _PyLong_FromUid(st->st_uid));
2248 PyStructSequence_SET_ITEM(v, 5, _PyLong_FromGid(st->st_gid));
2249#endif
xdegaye50e86032017-05-22 11:15:08 +02002250 Py_BUILD_ASSERT(sizeof(long long) >= sizeof(st->st_size));
2251 PyStructSequence_SET_ITEM(v, 6, PyLong_FromLongLong(st->st_size));
Martin v. Löwis94717ed2002-09-09 14:24:16 +00002252
Martin v. Löwis14694662006-02-03 12:54:16 +00002253#if defined(HAVE_STAT_TV_NSEC)
Victor Stinner8c62be82010-05-06 00:08:46 +00002254 ansec = st->st_atim.tv_nsec;
2255 mnsec = st->st_mtim.tv_nsec;
2256 cnsec = st->st_ctim.tv_nsec;
Martin v. Löwis14694662006-02-03 12:54:16 +00002257#elif defined(HAVE_STAT_TV_NSEC2)
Victor Stinner8c62be82010-05-06 00:08:46 +00002258 ansec = st->st_atimespec.tv_nsec;
2259 mnsec = st->st_mtimespec.tv_nsec;
2260 cnsec = st->st_ctimespec.tv_nsec;
Martin v. Löwis14694662006-02-03 12:54:16 +00002261#elif defined(HAVE_STAT_NSEC)
Victor Stinner8c62be82010-05-06 00:08:46 +00002262 ansec = st->st_atime_nsec;
2263 mnsec = st->st_mtime_nsec;
2264 cnsec = st->st_ctime_nsec;
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002265#else
Victor Stinner8c62be82010-05-06 00:08:46 +00002266 ansec = mnsec = cnsec = 0;
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002267#endif
Victor Stinner1c2fa782020-05-10 11:05:29 +02002268 fill_time(module, v, 7, st->st_atime, ansec);
2269 fill_time(module, v, 8, st->st_mtime, mnsec);
2270 fill_time(module, v, 9, st->st_ctime, cnsec);
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002271
Martin v. Löwis60a5d722002-10-16 20:28:25 +00002272#ifdef HAVE_STRUCT_STAT_ST_BLKSIZE
Victor Stinner8c62be82010-05-06 00:08:46 +00002273 PyStructSequence_SET_ITEM(v, ST_BLKSIZE_IDX,
2274 PyLong_FromLong((long)st->st_blksize));
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002275#endif
Martin v. Löwis60a5d722002-10-16 20:28:25 +00002276#ifdef HAVE_STRUCT_STAT_ST_BLOCKS
Victor Stinner8c62be82010-05-06 00:08:46 +00002277 PyStructSequence_SET_ITEM(v, ST_BLOCKS_IDX,
2278 PyLong_FromLong((long)st->st_blocks));
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002279#endif
Martin v. Löwis60a5d722002-10-16 20:28:25 +00002280#ifdef HAVE_STRUCT_STAT_ST_RDEV
Victor Stinner8c62be82010-05-06 00:08:46 +00002281 PyStructSequence_SET_ITEM(v, ST_RDEV_IDX,
2282 PyLong_FromLong((long)st->st_rdev));
Fred Drake699f3522000-06-29 21:12:41 +00002283#endif
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002284#ifdef HAVE_STRUCT_STAT_ST_GEN
Victor Stinner8c62be82010-05-06 00:08:46 +00002285 PyStructSequence_SET_ITEM(v, ST_GEN_IDX,
2286 PyLong_FromLong((long)st->st_gen));
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002287#endif
2288#ifdef HAVE_STRUCT_STAT_ST_BIRTHTIME
Victor Stinner8c62be82010-05-06 00:08:46 +00002289 {
Victor Stinner4195b5c2012-02-08 23:03:19 +01002290 PyObject *val;
2291 unsigned long bsec,bnsec;
2292 bsec = (long)st->st_birthtime;
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002293#ifdef HAVE_STAT_TV_NSEC2
Victor Stinner4195b5c2012-02-08 23:03:19 +01002294 bnsec = st->st_birthtimespec.tv_nsec;
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002295#else
Victor Stinner4195b5c2012-02-08 23:03:19 +01002296 bnsec = 0;
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002297#endif
Victor Stinner01b5aab2017-10-24 02:02:00 -07002298 val = PyFloat_FromDouble(bsec + 1e-9*bnsec);
Victor Stinner4195b5c2012-02-08 23:03:19 +01002299 PyStructSequence_SET_ITEM(v, ST_BIRTHTIME_IDX,
2300 val);
Victor Stinner8c62be82010-05-06 00:08:46 +00002301 }
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002302#endif
Hye-Shik Chang5f937a72005-06-02 13:09:30 +00002303#ifdef HAVE_STRUCT_STAT_ST_FLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +00002304 PyStructSequence_SET_ITEM(v, ST_FLAGS_IDX,
2305 PyLong_FromLong((long)st->st_flags));
Hye-Shik Chang5f937a72005-06-02 13:09:30 +00002306#endif
Zachary Ware63f277b2014-06-19 09:46:37 -05002307#ifdef HAVE_STRUCT_STAT_ST_FILE_ATTRIBUTES
2308 PyStructSequence_SET_ITEM(v, ST_FILE_ATTRIBUTES_IDX,
2309 PyLong_FromUnsignedLong(st->st_file_attributes));
2310#endif
jcea6c51d512018-01-28 14:00:08 +01002311#ifdef HAVE_STRUCT_STAT_ST_FSTYPE
2312 PyStructSequence_SET_ITEM(v, ST_FSTYPE_IDX,
2313 PyUnicode_FromString(st->st_fstype));
2314#endif
Steve Dowerdf2d4a62019-08-21 15:27:33 -07002315#ifdef HAVE_STRUCT_STAT_ST_REPARSE_TAG
2316 PyStructSequence_SET_ITEM(v, ST_REPARSE_TAG_IDX,
2317 PyLong_FromUnsignedLong(st->st_reparse_tag));
2318#endif
Fred Drake699f3522000-06-29 21:12:41 +00002319
Victor Stinner8c62be82010-05-06 00:08:46 +00002320 if (PyErr_Occurred()) {
2321 Py_DECREF(v);
2322 return NULL;
2323 }
Fred Drake699f3522000-06-29 21:12:41 +00002324
Victor Stinner8c62be82010-05-06 00:08:46 +00002325 return v;
Fred Drake699f3522000-06-29 21:12:41 +00002326}
2327
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002328/* POSIX methods */
2329
Guido van Rossum94f6f721999-01-06 18:42:14 +00002330
2331static PyObject *
Victor Stinner1c2fa782020-05-10 11:05:29 +02002332posix_do_stat(PyObject *module, const char *function_name, path_t *path,
Larry Hastings9cf065c2012-06-22 16:30:09 -07002333 int dir_fd, int follow_symlinks)
Guido van Rossum94f6f721999-01-06 18:42:14 +00002334{
Larry Hastings9cf065c2012-06-22 16:30:09 -07002335 STRUCT_STAT st;
2336 int result;
2337
2338#if !defined(MS_WINDOWS) && !defined(HAVE_FSTATAT) && !defined(HAVE_LSTAT)
2339 if (follow_symlinks_specified(function_name, follow_symlinks))
2340 return NULL;
2341#endif
2342
2343 if (path_and_dir_fd_invalid("stat", path, dir_fd) ||
2344 dir_fd_and_fd_invalid("stat", dir_fd, path->fd) ||
2345 fd_and_follow_symlinks_invalid("stat", path->fd, follow_symlinks))
2346 return NULL;
2347
2348 Py_BEGIN_ALLOW_THREADS
2349 if (path->fd != -1)
2350 result = FSTAT(path->fd, &st);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002351#ifdef MS_WINDOWS
Steve Dower513d7472016-09-08 10:41:50 -07002352 else if (follow_symlinks)
Steve Dowercc16be82016-09-08 10:35:16 -07002353 result = win32_stat(path->wide, &st);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002354 else
Steve Dowercc16be82016-09-08 10:35:16 -07002355 result = win32_lstat(path->wide, &st);
2356#else
2357 else
2358#if defined(HAVE_LSTAT)
Larry Hastings9cf065c2012-06-22 16:30:09 -07002359 if ((!follow_symlinks) && (dir_fd == DEFAULT_DIR_FD))
2360 result = LSTAT(path->narrow, &st);
2361 else
Steve Dowercc16be82016-09-08 10:35:16 -07002362#endif /* HAVE_LSTAT */
Larry Hastings9cf065c2012-06-22 16:30:09 -07002363#ifdef HAVE_FSTATAT
2364 if ((dir_fd != DEFAULT_DIR_FD) || !follow_symlinks)
2365 result = fstatat(dir_fd, path->narrow, &st,
2366 follow_symlinks ? 0 : AT_SYMLINK_NOFOLLOW);
2367 else
Steve Dowercc16be82016-09-08 10:35:16 -07002368#endif /* HAVE_FSTATAT */
Larry Hastings9cf065c2012-06-22 16:30:09 -07002369 result = STAT(path->narrow, &st);
Steve Dowercc16be82016-09-08 10:35:16 -07002370#endif /* MS_WINDOWS */
Larry Hastings9cf065c2012-06-22 16:30:09 -07002371 Py_END_ALLOW_THREADS
2372
Victor Stinner292c8352012-10-30 02:17:38 +01002373 if (result != 0) {
2374 return path_error(path);
2375 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07002376
Victor Stinner1c2fa782020-05-10 11:05:29 +02002377 return _pystat_fromstructstat(module, &st);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002378}
2379
Larry Hastings2f936352014-08-05 14:04:04 +10002380/*[python input]
2381
2382for s in """
2383
2384FACCESSAT
2385FCHMODAT
2386FCHOWNAT
2387FSTATAT
2388LINKAT
2389MKDIRAT
2390MKFIFOAT
2391MKNODAT
2392OPENAT
2393READLINKAT
2394SYMLINKAT
2395UNLINKAT
2396
2397""".strip().split():
2398 s = s.strip()
2399 print("""
2400#ifdef HAVE_{s}
2401 #define {s}_DIR_FD_CONVERTER dir_fd_converter
Larry Hastings31826802013-10-19 00:09:25 -07002402#else
Larry Hastings2f936352014-08-05 14:04:04 +10002403 #define {s}_DIR_FD_CONVERTER dir_fd_unavailable
Larry Hastings31826802013-10-19 00:09:25 -07002404#endif
Larry Hastings2f936352014-08-05 14:04:04 +10002405""".rstrip().format(s=s))
2406
2407for s in """
2408
2409FCHDIR
2410FCHMOD
2411FCHOWN
2412FDOPENDIR
2413FEXECVE
2414FPATHCONF
2415FSTATVFS
2416FTRUNCATE
2417
2418""".strip().split():
2419 s = s.strip()
2420 print("""
2421#ifdef HAVE_{s}
2422 #define PATH_HAVE_{s} 1
2423#else
2424 #define PATH_HAVE_{s} 0
2425#endif
2426
2427""".rstrip().format(s=s))
2428[python start generated code]*/
2429
2430#ifdef HAVE_FACCESSAT
2431 #define FACCESSAT_DIR_FD_CONVERTER dir_fd_converter
2432#else
2433 #define FACCESSAT_DIR_FD_CONVERTER dir_fd_unavailable
2434#endif
2435
2436#ifdef HAVE_FCHMODAT
2437 #define FCHMODAT_DIR_FD_CONVERTER dir_fd_converter
2438#else
2439 #define FCHMODAT_DIR_FD_CONVERTER dir_fd_unavailable
2440#endif
2441
2442#ifdef HAVE_FCHOWNAT
2443 #define FCHOWNAT_DIR_FD_CONVERTER dir_fd_converter
2444#else
2445 #define FCHOWNAT_DIR_FD_CONVERTER dir_fd_unavailable
2446#endif
2447
2448#ifdef HAVE_FSTATAT
2449 #define FSTATAT_DIR_FD_CONVERTER dir_fd_converter
2450#else
2451 #define FSTATAT_DIR_FD_CONVERTER dir_fd_unavailable
2452#endif
2453
2454#ifdef HAVE_LINKAT
2455 #define LINKAT_DIR_FD_CONVERTER dir_fd_converter
2456#else
2457 #define LINKAT_DIR_FD_CONVERTER dir_fd_unavailable
2458#endif
2459
2460#ifdef HAVE_MKDIRAT
2461 #define MKDIRAT_DIR_FD_CONVERTER dir_fd_converter
2462#else
2463 #define MKDIRAT_DIR_FD_CONVERTER dir_fd_unavailable
2464#endif
2465
2466#ifdef HAVE_MKFIFOAT
2467 #define MKFIFOAT_DIR_FD_CONVERTER dir_fd_converter
2468#else
2469 #define MKFIFOAT_DIR_FD_CONVERTER dir_fd_unavailable
2470#endif
2471
2472#ifdef HAVE_MKNODAT
2473 #define MKNODAT_DIR_FD_CONVERTER dir_fd_converter
2474#else
2475 #define MKNODAT_DIR_FD_CONVERTER dir_fd_unavailable
2476#endif
2477
2478#ifdef HAVE_OPENAT
2479 #define OPENAT_DIR_FD_CONVERTER dir_fd_converter
2480#else
2481 #define OPENAT_DIR_FD_CONVERTER dir_fd_unavailable
2482#endif
2483
2484#ifdef HAVE_READLINKAT
2485 #define READLINKAT_DIR_FD_CONVERTER dir_fd_converter
2486#else
2487 #define READLINKAT_DIR_FD_CONVERTER dir_fd_unavailable
2488#endif
2489
2490#ifdef HAVE_SYMLINKAT
2491 #define SYMLINKAT_DIR_FD_CONVERTER dir_fd_converter
2492#else
2493 #define SYMLINKAT_DIR_FD_CONVERTER dir_fd_unavailable
2494#endif
2495
2496#ifdef HAVE_UNLINKAT
2497 #define UNLINKAT_DIR_FD_CONVERTER dir_fd_converter
2498#else
2499 #define UNLINKAT_DIR_FD_CONVERTER dir_fd_unavailable
2500#endif
2501
2502#ifdef HAVE_FCHDIR
2503 #define PATH_HAVE_FCHDIR 1
2504#else
2505 #define PATH_HAVE_FCHDIR 0
2506#endif
2507
2508#ifdef HAVE_FCHMOD
2509 #define PATH_HAVE_FCHMOD 1
2510#else
2511 #define PATH_HAVE_FCHMOD 0
2512#endif
2513
2514#ifdef HAVE_FCHOWN
2515 #define PATH_HAVE_FCHOWN 1
2516#else
2517 #define PATH_HAVE_FCHOWN 0
2518#endif
2519
2520#ifdef HAVE_FDOPENDIR
2521 #define PATH_HAVE_FDOPENDIR 1
2522#else
2523 #define PATH_HAVE_FDOPENDIR 0
2524#endif
2525
2526#ifdef HAVE_FEXECVE
2527 #define PATH_HAVE_FEXECVE 1
2528#else
2529 #define PATH_HAVE_FEXECVE 0
2530#endif
2531
2532#ifdef HAVE_FPATHCONF
2533 #define PATH_HAVE_FPATHCONF 1
2534#else
2535 #define PATH_HAVE_FPATHCONF 0
2536#endif
2537
2538#ifdef HAVE_FSTATVFS
2539 #define PATH_HAVE_FSTATVFS 1
2540#else
2541 #define PATH_HAVE_FSTATVFS 0
2542#endif
2543
2544#ifdef HAVE_FTRUNCATE
2545 #define PATH_HAVE_FTRUNCATE 1
2546#else
2547 #define PATH_HAVE_FTRUNCATE 0
2548#endif
2549/*[python end generated code: output=4bd4f6f7d41267f1 input=80b4c890b6774ea5]*/
Larry Hastings31826802013-10-19 00:09:25 -07002550
Steve Dowerfe0a41a2015-03-20 19:50:46 -07002551#ifdef MS_WINDOWS
2552 #undef PATH_HAVE_FTRUNCATE
2553 #define PATH_HAVE_FTRUNCATE 1
2554#endif
Larry Hastings31826802013-10-19 00:09:25 -07002555
Larry Hastings61272b72014-01-07 12:41:53 -08002556/*[python input]
Larry Hastings31826802013-10-19 00:09:25 -07002557
2558class path_t_converter(CConverter):
2559
2560 type = "path_t"
2561 impl_by_reference = True
2562 parse_by_reference = True
2563
2564 converter = 'path_converter'
2565
2566 def converter_init(self, *, allow_fd=False, nullable=False):
Larry Hastings31826802013-10-19 00:09:25 -07002567 # right now path_t doesn't support default values.
2568 # to support a default value, you'll need to override initialize().
Larry Hastings2f936352014-08-05 14:04:04 +10002569 if self.default not in (unspecified, None):
Larry Hastings7726ac92014-01-31 22:03:12 -08002570 fail("Can't specify a default to the path_t converter!")
Larry Hastings31826802013-10-19 00:09:25 -07002571
Larry Hastings2f936352014-08-05 14:04:04 +10002572 if self.c_default not in (None, 'Py_None'):
2573 raise RuntimeError("Can't specify a c_default to the path_t converter!")
Larry Hastings31826802013-10-19 00:09:25 -07002574
2575 self.nullable = nullable
2576 self.allow_fd = allow_fd
2577
Larry Hastings7726ac92014-01-31 22:03:12 -08002578 def pre_render(self):
2579 def strify(value):
Larry Hastings2f936352014-08-05 14:04:04 +10002580 if isinstance(value, str):
2581 return value
Larry Hastings7726ac92014-01-31 22:03:12 -08002582 return str(int(bool(value)))
2583
2584 # add self.py_name here when merging with posixmodule conversion
Larry Hastings2f936352014-08-05 14:04:04 +10002585 self.c_default = 'PATH_T_INITIALIZE("{}", "{}", {}, {})'.format(
Larry Hastings31826802013-10-19 00:09:25 -07002586 self.function.name,
Larry Hastings2f936352014-08-05 14:04:04 +10002587 self.name,
Larry Hastings7726ac92014-01-31 22:03:12 -08002588 strify(self.nullable),
2589 strify(self.allow_fd),
Larry Hastings31826802013-10-19 00:09:25 -07002590 )
2591
2592 def cleanup(self):
2593 return "path_cleanup(&" + self.name + ");\n"
2594
2595
2596class dir_fd_converter(CConverter):
2597 type = 'int'
Larry Hastings31826802013-10-19 00:09:25 -07002598
Larry Hastings2f936352014-08-05 14:04:04 +10002599 def converter_init(self, requires=None):
Larry Hastings31826802013-10-19 00:09:25 -07002600 if self.default in (unspecified, None):
2601 self.c_default = 'DEFAULT_DIR_FD'
Larry Hastings2f936352014-08-05 14:04:04 +10002602 if isinstance(requires, str):
2603 self.converter = requires.upper() + '_DIR_FD_CONVERTER'
2604 else:
2605 self.converter = 'dir_fd_converter'
Larry Hastings31826802013-10-19 00:09:25 -07002606
Larry Hastings2f936352014-08-05 14:04:04 +10002607class fildes_converter(CConverter):
2608 type = 'int'
2609 converter = 'fildes_converter'
2610
2611class uid_t_converter(CConverter):
2612 type = "uid_t"
2613 converter = '_Py_Uid_Converter'
2614
2615class gid_t_converter(CConverter):
2616 type = "gid_t"
2617 converter = '_Py_Gid_Converter'
2618
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +02002619class dev_t_converter(CConverter):
2620 type = 'dev_t'
2621 converter = '_Py_Dev_Converter'
2622
2623class dev_t_return_converter(unsigned_long_return_converter):
2624 type = 'dev_t'
2625 conversion_fn = '_PyLong_FromDev'
2626 unsigned_cast = '(dev_t)'
2627
Larry Hastings2f936352014-08-05 14:04:04 +10002628class FSConverter_converter(CConverter):
2629 type = 'PyObject *'
2630 converter = 'PyUnicode_FSConverter'
2631 def converter_init(self):
2632 if self.default is not unspecified:
2633 fail("FSConverter_converter does not support default values")
2634 self.c_default = 'NULL'
2635
2636 def cleanup(self):
2637 return "Py_XDECREF(" + self.name + ");\n"
2638
2639class pid_t_converter(CConverter):
2640 type = 'pid_t'
2641 format_unit = '" _Py_PARSE_PID "'
2642
2643class idtype_t_converter(int_converter):
2644 type = 'idtype_t'
2645
2646class id_t_converter(CConverter):
2647 type = 'id_t'
2648 format_unit = '" _Py_PARSE_PID "'
2649
Benjamin Petersonca470632016-09-06 13:47:26 -07002650class intptr_t_converter(CConverter):
2651 type = 'intptr_t'
Larry Hastings2f936352014-08-05 14:04:04 +10002652 format_unit = '" _Py_PARSE_INTPTR "'
2653
2654class Py_off_t_converter(CConverter):
2655 type = 'Py_off_t'
2656 converter = 'Py_off_t_converter'
2657
2658class Py_off_t_return_converter(long_return_converter):
2659 type = 'Py_off_t'
2660 conversion_fn = 'PyLong_FromPy_off_t'
2661
2662class path_confname_converter(CConverter):
2663 type="int"
2664 converter="conv_path_confname"
2665
2666class confstr_confname_converter(path_confname_converter):
2667 converter='conv_confstr_confname'
2668
2669class sysconf_confname_converter(path_confname_converter):
2670 converter="conv_sysconf_confname"
2671
Larry Hastings61272b72014-01-07 12:41:53 -08002672[python start generated code]*/
Victor Stinner1c2fa782020-05-10 11:05:29 +02002673/*[python end generated code: output=da39a3ee5e6b4b0d input=f1c8ae8d744f6c8b]*/
Larry Hastings31826802013-10-19 00:09:25 -07002674
Larry Hastings61272b72014-01-07 12:41:53 -08002675/*[clinic input]
Larry Hastings31826802013-10-19 00:09:25 -07002676
Larry Hastings2a727912014-01-16 11:32:01 -08002677os.stat
Larry Hastings31826802013-10-19 00:09:25 -07002678
2679 path : path_t(allow_fd=True)
BNMetricsb9427072018-11-02 15:20:19 +00002680 Path to be examined; can be string, bytes, a path-like object or
Xiang Zhang4459e002017-01-22 13:04:17 +08002681 open-file-descriptor int.
Larry Hastings31826802013-10-19 00:09:25 -07002682
2683 *
2684
Larry Hastings2f936352014-08-05 14:04:04 +10002685 dir_fd : dir_fd(requires='fstatat') = None
Larry Hastings31826802013-10-19 00:09:25 -07002686 If not None, it should be a file descriptor open to a directory,
2687 and path should be a relative string; path will then be relative to
2688 that directory.
2689
2690 follow_symlinks: bool = True
2691 If False, and the last element of the path is a symbolic link,
2692 stat will examine the symbolic link itself instead of the file
2693 the link points to.
2694
2695Perform a stat system call on the given path.
2696
2697dir_fd and follow_symlinks may not be implemented
2698 on your platform. If they are unavailable, using them will raise a
2699 NotImplementedError.
2700
2701It's an error to use dir_fd or follow_symlinks when specifying path as
2702 an open file descriptor.
2703
Larry Hastings61272b72014-01-07 12:41:53 -08002704[clinic start generated code]*/
Larry Hastings31826802013-10-19 00:09:25 -07002705
Larry Hastings31826802013-10-19 00:09:25 -07002706static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002707os_stat_impl(PyObject *module, path_t *path, int dir_fd, int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +00002708/*[clinic end generated code: output=7d4976e6f18a59c5 input=01d362ebcc06996b]*/
Larry Hastings31826802013-10-19 00:09:25 -07002709{
Victor Stinner1c2fa782020-05-10 11:05:29 +02002710 return posix_do_stat(module, "stat", path, dir_fd, follow_symlinks);
Larry Hastings31826802013-10-19 00:09:25 -07002711}
2712
Larry Hastings2f936352014-08-05 14:04:04 +10002713
2714/*[clinic input]
2715os.lstat
2716
2717 path : path_t
2718
2719 *
2720
2721 dir_fd : dir_fd(requires='fstatat') = None
2722
2723Perform a stat system call on the given path, without following symbolic links.
2724
2725Like stat(), but do not follow symbolic links.
2726Equivalent to stat(path, follow_symlinks=False).
2727[clinic start generated code]*/
2728
Larry Hastings2f936352014-08-05 14:04:04 +10002729static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002730os_lstat_impl(PyObject *module, path_t *path, int dir_fd)
2731/*[clinic end generated code: output=ef82a5d35ce8ab37 input=0b7474765927b925]*/
Larry Hastings2f936352014-08-05 14:04:04 +10002732{
2733 int follow_symlinks = 0;
Victor Stinner1c2fa782020-05-10 11:05:29 +02002734 return posix_do_stat(module, "lstat", path, dir_fd, follow_symlinks);
Larry Hastings2f936352014-08-05 14:04:04 +10002735}
Larry Hastings31826802013-10-19 00:09:25 -07002736
Larry Hastings2f936352014-08-05 14:04:04 +10002737
Larry Hastings61272b72014-01-07 12:41:53 -08002738/*[clinic input]
Larry Hastings2f936352014-08-05 14:04:04 +10002739os.access -> bool
Larry Hastings31826802013-10-19 00:09:25 -07002740
Benjamin Peterson768f3b42016-09-05 15:29:33 -07002741 path: path_t
BNMetricsb9427072018-11-02 15:20:19 +00002742 Path to be tested; can be string, bytes, or a path-like object.
Larry Hastings31826802013-10-19 00:09:25 -07002743
2744 mode: int
2745 Operating-system mode bitfield. Can be F_OK to test existence,
2746 or the inclusive-OR of R_OK, W_OK, and X_OK.
2747
2748 *
2749
Larry Hastings2f936352014-08-05 14:04:04 +10002750 dir_fd : dir_fd(requires='faccessat') = None
Larry Hastings31826802013-10-19 00:09:25 -07002751 If not None, it should be a file descriptor open to a directory,
2752 and path should be relative; path will then be relative to that
2753 directory.
2754
2755 effective_ids: bool = False
2756 If True, access will use the effective uid/gid instead of
2757 the real uid/gid.
2758
2759 follow_symlinks: bool = True
2760 If False, and the last element of the path is a symbolic link,
2761 access will examine the symbolic link itself instead of the file
2762 the link points to.
2763
2764Use the real uid/gid to test for access to a path.
2765
2766{parameters}
2767dir_fd, effective_ids, and follow_symlinks may not be implemented
2768 on your platform. If they are unavailable, using them will raise a
2769 NotImplementedError.
2770
2771Note that most operations will use the effective uid/gid, therefore this
2772 routine can be used in a suid/sgid environment to test if the invoking user
2773 has the specified access to the path.
2774
Larry Hastings61272b72014-01-07 12:41:53 -08002775[clinic start generated code]*/
Larry Hastings31826802013-10-19 00:09:25 -07002776
Larry Hastings2f936352014-08-05 14:04:04 +10002777static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002778os_access_impl(PyObject *module, path_t *path, int mode, int dir_fd,
Larry Hastings89964c42015-04-14 18:07:59 -04002779 int effective_ids, int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +00002780/*[clinic end generated code: output=cf84158bc90b1a77 input=3ffe4e650ee3bf20]*/
Larry Hastings31826802013-10-19 00:09:25 -07002781{
Larry Hastings2f936352014-08-05 14:04:04 +10002782 int return_value;
Victor Stinner8c62be82010-05-06 00:08:46 +00002783
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00002784#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00002785 DWORD attr;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002786#else
Larry Hastings9cf065c2012-06-22 16:30:09 -07002787 int result;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002788#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07002789
Larry Hastings9cf065c2012-06-22 16:30:09 -07002790#ifndef HAVE_FACCESSAT
2791 if (follow_symlinks_specified("access", follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10002792 return -1;
Larry Hastings9cf065c2012-06-22 16:30:09 -07002793
2794 if (effective_ids) {
2795 argument_unavailable_error("access", "effective_ids");
Larry Hastings2f936352014-08-05 14:04:04 +10002796 return -1;
Larry Hastings9cf065c2012-06-22 16:30:09 -07002797 }
2798#endif
2799
2800#ifdef MS_WINDOWS
2801 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07002802 attr = GetFileAttributesW(path->wide);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002803 Py_END_ALLOW_THREADS
2804
2805 /*
Georg Brandlf7875592012-06-24 13:58:31 +02002806 * Access is possible if
Larry Hastings9cf065c2012-06-22 16:30:09 -07002807 * * we didn't get a -1, and
2808 * * write access wasn't requested,
2809 * * or the file isn't read-only,
2810 * * or it's a directory.
2811 * (Directories cannot be read-only on Windows.)
2812 */
Larry Hastings2f936352014-08-05 14:04:04 +10002813 return_value = (attr != INVALID_FILE_ATTRIBUTES) &&
Georg Brandl5bb7aa92012-06-23 12:48:40 +02002814 (!(mode & 2) ||
Larry Hastings9cf065c2012-06-22 16:30:09 -07002815 !(attr & FILE_ATTRIBUTE_READONLY) ||
Larry Hastings2f936352014-08-05 14:04:04 +10002816 (attr & FILE_ATTRIBUTE_DIRECTORY));
Larry Hastings9cf065c2012-06-22 16:30:09 -07002817#else
2818
2819 Py_BEGIN_ALLOW_THREADS
2820#ifdef HAVE_FACCESSAT
2821 if ((dir_fd != DEFAULT_DIR_FD) ||
2822 effective_ids ||
2823 !follow_symlinks) {
2824 int flags = 0;
2825 if (!follow_symlinks)
2826 flags |= AT_SYMLINK_NOFOLLOW;
2827 if (effective_ids)
2828 flags |= AT_EACCESS;
Larry Hastings31826802013-10-19 00:09:25 -07002829 result = faccessat(dir_fd, path->narrow, mode, flags);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002830 }
2831 else
2832#endif
Larry Hastings31826802013-10-19 00:09:25 -07002833 result = access(path->narrow, mode);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002834 Py_END_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10002835 return_value = !result;
Larry Hastings9cf065c2012-06-22 16:30:09 -07002836#endif
2837
Larry Hastings9cf065c2012-06-22 16:30:09 -07002838 return return_value;
Guido van Rossum94f6f721999-01-06 18:42:14 +00002839}
2840
Guido van Rossumd371ff11999-01-25 16:12:23 +00002841#ifndef F_OK
2842#define F_OK 0
2843#endif
2844#ifndef R_OK
2845#define R_OK 4
2846#endif
2847#ifndef W_OK
2848#define W_OK 2
2849#endif
2850#ifndef X_OK
2851#define X_OK 1
2852#endif
2853
Larry Hastings31826802013-10-19 00:09:25 -07002854
Guido van Rossumd371ff11999-01-25 16:12:23 +00002855#ifdef HAVE_TTYNAME
Larry Hastings61272b72014-01-07 12:41:53 -08002856/*[clinic input]
Serhiy Storchaka4db62e12018-12-17 16:47:45 +02002857os.ttyname
Larry Hastings31826802013-10-19 00:09:25 -07002858
2859 fd: int
2860 Integer file descriptor handle.
2861
2862 /
2863
2864Return the name of the terminal device connected to 'fd'.
Larry Hastings61272b72014-01-07 12:41:53 -08002865[clinic start generated code]*/
Larry Hastings31826802013-10-19 00:09:25 -07002866
Serhiy Storchaka4db62e12018-12-17 16:47:45 +02002867static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002868os_ttyname_impl(PyObject *module, int fd)
Serhiy Storchaka4db62e12018-12-17 16:47:45 +02002869/*[clinic end generated code: output=c424d2e9d1cd636a input=9ff5a58b08115c55]*/
Larry Hastings31826802013-10-19 00:09:25 -07002870{
Guido van Rossum94f6f721999-01-06 18:42:14 +00002871
Antonio Gutierrez594e2ed2019-10-09 04:19:48 +02002872 long size = sysconf(_SC_TTY_NAME_MAX);
2873 if (size == -1) {
Serhiy Storchaka4db62e12018-12-17 16:47:45 +02002874 return posix_error();
2875 }
Antonio Gutierrez594e2ed2019-10-09 04:19:48 +02002876 char *buffer = (char *)PyMem_RawMalloc(size);
2877 if (buffer == NULL) {
2878 return PyErr_NoMemory();
2879 }
2880 int ret = ttyname_r(fd, buffer, size);
2881 if (ret != 0) {
2882 PyMem_RawFree(buffer);
2883 errno = ret;
2884 return posix_error();
2885 }
2886 PyObject *res = PyUnicode_DecodeFSDefault(buffer);
2887 PyMem_RawFree(buffer);
2888 return res;
Guido van Rossum94f6f721999-01-06 18:42:14 +00002889}
Guido van Rossumd371ff11999-01-25 16:12:23 +00002890#endif
Guido van Rossum94f6f721999-01-06 18:42:14 +00002891
Fred Drake5ab8eaf1999-12-09 21:13:07 +00002892#ifdef HAVE_CTERMID
Larry Hastings2f936352014-08-05 14:04:04 +10002893/*[clinic input]
2894os.ctermid
2895
2896Return the name of the controlling terminal for this process.
2897[clinic start generated code]*/
2898
Larry Hastings2f936352014-08-05 14:04:04 +10002899static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002900os_ctermid_impl(PyObject *module)
2901/*[clinic end generated code: output=02f017e6c9e620db input=3b87fdd52556382d]*/
Fred Drake5ab8eaf1999-12-09 21:13:07 +00002902{
Victor Stinner8c62be82010-05-06 00:08:46 +00002903 char *ret;
2904 char buffer[L_ctermid];
Fred Drake5ab8eaf1999-12-09 21:13:07 +00002905
Greg Wardb48bc172000-03-01 21:51:56 +00002906#ifdef USE_CTERMID_R
Victor Stinner8c62be82010-05-06 00:08:46 +00002907 ret = ctermid_r(buffer);
Fred Drake5ab8eaf1999-12-09 21:13:07 +00002908#else
Victor Stinner8c62be82010-05-06 00:08:46 +00002909 ret = ctermid(buffer);
Fred Drake5ab8eaf1999-12-09 21:13:07 +00002910#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00002911 if (ret == NULL)
2912 return posix_error();
Victor Stinner5fe6de82010-08-15 09:12:51 +00002913 return PyUnicode_DecodeFSDefault(buffer);
Fred Drake5ab8eaf1999-12-09 21:13:07 +00002914}
Larry Hastings2f936352014-08-05 14:04:04 +10002915#endif /* HAVE_CTERMID */
Fred Drake5ab8eaf1999-12-09 21:13:07 +00002916
Larry Hastings2f936352014-08-05 14:04:04 +10002917
2918/*[clinic input]
2919os.chdir
2920
2921 path: path_t(allow_fd='PATH_HAVE_FCHDIR')
2922
2923Change the current working directory to the specified path.
2924
2925path may always be specified as a string.
2926On some platforms, path may also be specified as an open file descriptor.
2927 If this functionality is unavailable, using it raises an exception.
2928[clinic start generated code]*/
2929
Larry Hastings2f936352014-08-05 14:04:04 +10002930static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002931os_chdir_impl(PyObject *module, path_t *path)
2932/*[clinic end generated code: output=3be6400eee26eaae input=1a4a15b4d12cb15d]*/
Larry Hastings2f936352014-08-05 14:04:04 +10002933{
2934 int result;
Larry Hastings9cf065c2012-06-22 16:30:09 -07002935
Saiyang Gou7514f4f2020-02-12 23:47:42 -08002936 if (PySys_Audit("os.chdir", "(O)", path->object) < 0) {
2937 return NULL;
2938 }
2939
Larry Hastings9cf065c2012-06-22 16:30:09 -07002940 Py_BEGIN_ALLOW_THREADS
2941#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07002942 /* on unix, success = 0, on windows, success = !0 */
2943 result = !win32_wchdir(path->wide);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002944#else
2945#ifdef HAVE_FCHDIR
Larry Hastings2f936352014-08-05 14:04:04 +10002946 if (path->fd != -1)
2947 result = fchdir(path->fd);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002948 else
2949#endif
Larry Hastings2f936352014-08-05 14:04:04 +10002950 result = chdir(path->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002951#endif
2952 Py_END_ALLOW_THREADS
2953
2954 if (result) {
Larry Hastings2f936352014-08-05 14:04:04 +10002955 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002956 }
2957
Larry Hastings2f936352014-08-05 14:04:04 +10002958 Py_RETURN_NONE;
2959}
2960
2961
2962#ifdef HAVE_FCHDIR
2963/*[clinic input]
2964os.fchdir
2965
2966 fd: fildes
2967
2968Change to the directory of the given file descriptor.
2969
2970fd must be opened on a directory, not a file.
2971Equivalent to os.chdir(fd).
2972
2973[clinic start generated code]*/
2974
Fred Drake4d1e64b2002-04-15 19:40:07 +00002975static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002976os_fchdir_impl(PyObject *module, int fd)
2977/*[clinic end generated code: output=42e064ec4dc00ab0 input=18e816479a2fa985]*/
Fred Drake4d1e64b2002-04-15 19:40:07 +00002978{
Saiyang Gou7514f4f2020-02-12 23:47:42 -08002979 if (PySys_Audit("os.chdir", "(i)", fd) < 0) {
2980 return NULL;
2981 }
Larry Hastings2f936352014-08-05 14:04:04 +10002982 return posix_fildes_fd(fd, fchdir);
Fred Drake4d1e64b2002-04-15 19:40:07 +00002983}
2984#endif /* HAVE_FCHDIR */
2985
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00002986
Larry Hastings2f936352014-08-05 14:04:04 +10002987/*[clinic input]
2988os.chmod
2989
2990 path: path_t(allow_fd='PATH_HAVE_FCHMOD')
BNMetricsb9427072018-11-02 15:20:19 +00002991 Path to be modified. May always be specified as a str, bytes, or a path-like object.
Larry Hastings2f936352014-08-05 14:04:04 +10002992 On some platforms, path may also be specified as an open file descriptor.
2993 If this functionality is unavailable, using it raises an exception.
2994
2995 mode: int
2996 Operating-system mode bitfield.
2997
2998 *
2999
3000 dir_fd : dir_fd(requires='fchmodat') = None
3001 If not None, it should be a file descriptor open to a directory,
3002 and path should be relative; path will then be relative to that
3003 directory.
3004
3005 follow_symlinks: bool = True
3006 If False, and the last element of the path is a symbolic link,
3007 chmod will modify the symbolic link itself instead of the file
3008 the link points to.
3009
3010Change the access permissions of a file.
3011
3012It is an error to use dir_fd or follow_symlinks when specifying path as
3013 an open file descriptor.
3014dir_fd and follow_symlinks may not be implemented on your platform.
3015 If they are unavailable, using them will raise a NotImplementedError.
3016
3017[clinic start generated code]*/
3018
Larry Hastings2f936352014-08-05 14:04:04 +10003019static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003020os_chmod_impl(PyObject *module, path_t *path, int mode, int dir_fd,
Larry Hastings89964c42015-04-14 18:07:59 -04003021 int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +00003022/*[clinic end generated code: output=5cf6a94915cc7bff input=989081551c00293b]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003023{
Larry Hastings9cf065c2012-06-22 16:30:09 -07003024 int result;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003025
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00003026#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00003027 DWORD attr;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003028#endif
Hirokazu Yamamoto892a37a2009-06-28 11:07:03 +00003029
Larry Hastings9cf065c2012-06-22 16:30:09 -07003030#ifdef HAVE_FCHMODAT
3031 int fchmodat_nofollow_unsupported = 0;
3032#endif
3033
Larry Hastings9cf065c2012-06-22 16:30:09 -07003034#if !(defined(HAVE_FCHMODAT) || defined(HAVE_LCHMOD))
3035 if (follow_symlinks_specified("chmod", follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10003036 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003037#endif
3038
Saiyang Gou7514f4f2020-02-12 23:47:42 -08003039 if (PySys_Audit("os.chmod", "Oii", path->object, mode,
3040 dir_fd == DEFAULT_DIR_FD ? -1 : dir_fd) < 0) {
3041 return NULL;
3042 }
3043
Larry Hastings9cf065c2012-06-22 16:30:09 -07003044#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00003045 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07003046 attr = GetFileAttributesW(path->wide);
Tim Golden23005082013-10-25 11:22:37 +01003047 if (attr == INVALID_FILE_ATTRIBUTES)
Larry Hastings9cf065c2012-06-22 16:30:09 -07003048 result = 0;
3049 else {
3050 if (mode & _S_IWRITE)
Victor Stinner8c62be82010-05-06 00:08:46 +00003051 attr &= ~FILE_ATTRIBUTE_READONLY;
3052 else
3053 attr |= FILE_ATTRIBUTE_READONLY;
Steve Dowercc16be82016-09-08 10:35:16 -07003054 result = SetFileAttributesW(path->wide, attr);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003055 }
3056 Py_END_ALLOW_THREADS
3057
3058 if (!result) {
Larry Hastings2f936352014-08-05 14:04:04 +10003059 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003060 }
3061#else /* MS_WINDOWS */
3062 Py_BEGIN_ALLOW_THREADS
3063#ifdef HAVE_FCHMOD
Larry Hastings2f936352014-08-05 14:04:04 +10003064 if (path->fd != -1)
3065 result = fchmod(path->fd, mode);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003066 else
3067#endif
3068#ifdef HAVE_LCHMOD
3069 if ((!follow_symlinks) && (dir_fd == DEFAULT_DIR_FD))
Larry Hastings2f936352014-08-05 14:04:04 +10003070 result = lchmod(path->narrow, mode);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003071 else
3072#endif
3073#ifdef HAVE_FCHMODAT
3074 if ((dir_fd != DEFAULT_DIR_FD) || !follow_symlinks) {
3075 /*
3076 * fchmodat() doesn't currently support AT_SYMLINK_NOFOLLOW!
3077 * The documentation specifically shows how to use it,
Larry Hastingsdbbc0c82012-06-22 19:50:21 -07003078 * and then says it isn't implemented yet.
3079 * (true on linux with glibc 2.15, and openindiana 3.x)
Larry Hastings9cf065c2012-06-22 16:30:09 -07003080 *
3081 * Once it is supported, os.chmod will automatically
3082 * support dir_fd and follow_symlinks=False. (Hopefully.)
3083 * Until then, we need to be careful what exception we raise.
3084 */
Larry Hastings2f936352014-08-05 14:04:04 +10003085 result = fchmodat(dir_fd, path->narrow, mode,
Larry Hastings9cf065c2012-06-22 16:30:09 -07003086 follow_symlinks ? 0 : AT_SYMLINK_NOFOLLOW);
3087 /*
3088 * But wait! We can't throw the exception without allowing threads,
3089 * and we can't do that in this nested scope. (Macro trickery, sigh.)
3090 */
3091 fchmodat_nofollow_unsupported =
Larry Hastingsdbbc0c82012-06-22 19:50:21 -07003092 result &&
3093 ((errno == ENOTSUP) || (errno == EOPNOTSUPP)) &&
3094 !follow_symlinks;
Victor Stinner8c62be82010-05-06 00:08:46 +00003095 }
3096 else
Thomas Wouters477c8d52006-05-27 19:21:47 +00003097#endif
Larry Hastings2f936352014-08-05 14:04:04 +10003098 result = chmod(path->narrow, mode);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003099 Py_END_ALLOW_THREADS
3100
3101 if (result) {
3102#ifdef HAVE_FCHMODAT
3103 if (fchmodat_nofollow_unsupported) {
3104 if (dir_fd != DEFAULT_DIR_FD)
3105 dir_fd_and_follow_symlinks_invalid("chmod",
3106 dir_fd, follow_symlinks);
3107 else
3108 follow_symlinks_specified("chmod", follow_symlinks);
Anthony Sottile233ef242017-12-14 08:57:55 -08003109 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003110 }
3111 else
3112#endif
Larry Hastings2f936352014-08-05 14:04:04 +10003113 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003114 }
3115#endif
3116
Larry Hastings2f936352014-08-05 14:04:04 +10003117 Py_RETURN_NONE;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003118}
3119
Larry Hastings9cf065c2012-06-22 16:30:09 -07003120
Christian Heimes4e30a842007-11-30 22:12:06 +00003121#ifdef HAVE_FCHMOD
Larry Hastings2f936352014-08-05 14:04:04 +10003122/*[clinic input]
3123os.fchmod
3124
3125 fd: int
3126 mode: int
3127
3128Change the access permissions of the file given by file descriptor fd.
3129
3130Equivalent to os.chmod(fd, mode).
3131[clinic start generated code]*/
3132
Larry Hastings2f936352014-08-05 14:04:04 +10003133static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003134os_fchmod_impl(PyObject *module, int fd, int mode)
3135/*[clinic end generated code: output=afd9bc05b4e426b3 input=8ab11975ca01ee5b]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003136{
3137 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003138 int async_err = 0;
3139
Saiyang Gou7514f4f2020-02-12 23:47:42 -08003140 if (PySys_Audit("os.chmod", "iii", fd, mode, -1) < 0) {
3141 return NULL;
3142 }
3143
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003144 do {
3145 Py_BEGIN_ALLOW_THREADS
3146 res = fchmod(fd, mode);
3147 Py_END_ALLOW_THREADS
3148 } while (res != 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
3149 if (res != 0)
3150 return (!async_err) ? posix_error() : NULL;
3151
Victor Stinner8c62be82010-05-06 00:08:46 +00003152 Py_RETURN_NONE;
Christian Heimes4e30a842007-11-30 22:12:06 +00003153}
3154#endif /* HAVE_FCHMOD */
3155
Larry Hastings2f936352014-08-05 14:04:04 +10003156
Christian Heimes4e30a842007-11-30 22:12:06 +00003157#ifdef HAVE_LCHMOD
Larry Hastings2f936352014-08-05 14:04:04 +10003158/*[clinic input]
3159os.lchmod
3160
3161 path: path_t
3162 mode: int
3163
3164Change the access permissions of a file, without following symbolic links.
3165
3166If path is a symlink, this affects the link itself rather than the target.
3167Equivalent to chmod(path, mode, follow_symlinks=False)."
3168[clinic start generated code]*/
3169
Larry Hastings2f936352014-08-05 14:04:04 +10003170static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003171os_lchmod_impl(PyObject *module, path_t *path, int mode)
3172/*[clinic end generated code: output=082344022b51a1d5 input=90c5663c7465d24f]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003173{
Victor Stinner8c62be82010-05-06 00:08:46 +00003174 int res;
Saiyang Gou7514f4f2020-02-12 23:47:42 -08003175 if (PySys_Audit("os.chmod", "Oii", path->object, mode, -1) < 0) {
3176 return NULL;
3177 }
Victor Stinner8c62be82010-05-06 00:08:46 +00003178 Py_BEGIN_ALLOW_THREADS
Larry Hastingsb1dc1122014-08-05 16:06:16 +10003179 res = lchmod(path->narrow, mode);
Victor Stinner8c62be82010-05-06 00:08:46 +00003180 Py_END_ALLOW_THREADS
Victor Stinner292c8352012-10-30 02:17:38 +01003181 if (res < 0) {
Larry Hastings2f936352014-08-05 14:04:04 +10003182 path_error(path);
Victor Stinner292c8352012-10-30 02:17:38 +01003183 return NULL;
3184 }
Victor Stinner8c62be82010-05-06 00:08:46 +00003185 Py_RETURN_NONE;
Christian Heimes4e30a842007-11-30 22:12:06 +00003186}
3187#endif /* HAVE_LCHMOD */
3188
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00003189
Thomas Wouterscf297e42007-02-23 15:07:44 +00003190#ifdef HAVE_CHFLAGS
Larry Hastings2f936352014-08-05 14:04:04 +10003191/*[clinic input]
3192os.chflags
3193
3194 path: path_t
3195 flags: unsigned_long(bitwise=True)
3196 follow_symlinks: bool=True
3197
3198Set file flags.
3199
3200If follow_symlinks is False, and the last element of the path is a symbolic
3201 link, chflags will change flags on the symbolic link itself instead of the
3202 file the link points to.
3203follow_symlinks may not be implemented on your platform. If it is
3204unavailable, using it will raise a NotImplementedError.
3205
3206[clinic start generated code]*/
3207
Larry Hastings2f936352014-08-05 14:04:04 +10003208static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003209os_chflags_impl(PyObject *module, path_t *path, unsigned long flags,
Larry Hastings89964c42015-04-14 18:07:59 -04003210 int follow_symlinks)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003211/*[clinic end generated code: output=85571c6737661ce9 input=0327e29feb876236]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003212{
3213 int result;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003214
3215#ifndef HAVE_LCHFLAGS
3216 if (follow_symlinks_specified("chflags", follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10003217 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003218#endif
3219
Saiyang Gou7514f4f2020-02-12 23:47:42 -08003220 if (PySys_Audit("os.chflags", "Ok", path->object, flags) < 0) {
3221 return NULL;
3222 }
3223
Victor Stinner8c62be82010-05-06 00:08:46 +00003224 Py_BEGIN_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07003225#ifdef HAVE_LCHFLAGS
3226 if (!follow_symlinks)
Larry Hastings2f936352014-08-05 14:04:04 +10003227 result = lchflags(path->narrow, flags);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003228 else
3229#endif
Larry Hastings2f936352014-08-05 14:04:04 +10003230 result = chflags(path->narrow, flags);
Victor Stinner8c62be82010-05-06 00:08:46 +00003231 Py_END_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07003232
Larry Hastings2f936352014-08-05 14:04:04 +10003233 if (result)
3234 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003235
Larry Hastings2f936352014-08-05 14:04:04 +10003236 Py_RETURN_NONE;
Thomas Wouterscf297e42007-02-23 15:07:44 +00003237}
3238#endif /* HAVE_CHFLAGS */
3239
Larry Hastings2f936352014-08-05 14:04:04 +10003240
Thomas Wouterscf297e42007-02-23 15:07:44 +00003241#ifdef HAVE_LCHFLAGS
Larry Hastings2f936352014-08-05 14:04:04 +10003242/*[clinic input]
3243os.lchflags
3244
3245 path: path_t
3246 flags: unsigned_long(bitwise=True)
3247
3248Set file flags.
3249
3250This function will not follow symbolic links.
3251Equivalent to chflags(path, flags, follow_symlinks=False).
3252[clinic start generated code]*/
3253
Larry Hastings2f936352014-08-05 14:04:04 +10003254static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003255os_lchflags_impl(PyObject *module, path_t *path, unsigned long flags)
3256/*[clinic end generated code: output=30ae958695c07316 input=f9f82ea8b585ca9d]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003257{
Victor Stinner8c62be82010-05-06 00:08:46 +00003258 int res;
Saiyang Gou7514f4f2020-02-12 23:47:42 -08003259 if (PySys_Audit("os.chflags", "Ok", path->object, flags) < 0) {
3260 return NULL;
3261 }
Victor Stinner8c62be82010-05-06 00:08:46 +00003262 Py_BEGIN_ALLOW_THREADS
Larry Hastingsb1dc1122014-08-05 16:06:16 +10003263 res = lchflags(path->narrow, flags);
Victor Stinner8c62be82010-05-06 00:08:46 +00003264 Py_END_ALLOW_THREADS
Victor Stinner292c8352012-10-30 02:17:38 +01003265 if (res < 0) {
Larry Hastings2f936352014-08-05 14:04:04 +10003266 return path_error(path);
Victor Stinner292c8352012-10-30 02:17:38 +01003267 }
Victor Stinner292c8352012-10-30 02:17:38 +01003268 Py_RETURN_NONE;
Thomas Wouterscf297e42007-02-23 15:07:44 +00003269}
3270#endif /* HAVE_LCHFLAGS */
3271
Larry Hastings2f936352014-08-05 14:04:04 +10003272
Martin v. Löwis244edc82001-10-04 22:44:26 +00003273#ifdef HAVE_CHROOT
Larry Hastings2f936352014-08-05 14:04:04 +10003274/*[clinic input]
3275os.chroot
3276 path: path_t
3277
3278Change root directory to path.
3279
3280[clinic start generated code]*/
3281
Larry Hastings2f936352014-08-05 14:04:04 +10003282static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003283os_chroot_impl(PyObject *module, path_t *path)
3284/*[clinic end generated code: output=de80befc763a4475 input=14822965652c3dc3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003285{
3286 int res;
3287 Py_BEGIN_ALLOW_THREADS
3288 res = chroot(path->narrow);
3289 Py_END_ALLOW_THREADS
3290 if (res < 0)
3291 return path_error(path);
3292 Py_RETURN_NONE;
3293}
3294#endif /* HAVE_CHROOT */
3295
Martin v. Löwis244edc82001-10-04 22:44:26 +00003296
Guido van Rossum21142a01999-01-08 21:05:37 +00003297#ifdef HAVE_FSYNC
Larry Hastings2f936352014-08-05 14:04:04 +10003298/*[clinic input]
3299os.fsync
3300
3301 fd: fildes
3302
3303Force write of fd to disk.
3304[clinic start generated code]*/
3305
Larry Hastings2f936352014-08-05 14:04:04 +10003306static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003307os_fsync_impl(PyObject *module, int fd)
3308/*[clinic end generated code: output=4a10d773f52b3584 input=21c3645c056967f2]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003309{
3310 return posix_fildes_fd(fd, fsync);
Guido van Rossum21142a01999-01-08 21:05:37 +00003311}
3312#endif /* HAVE_FSYNC */
3313
Larry Hastings2f936352014-08-05 14:04:04 +10003314
Ross Lagerwall7807c352011-03-17 20:20:30 +02003315#ifdef HAVE_SYNC
Larry Hastings2f936352014-08-05 14:04:04 +10003316/*[clinic input]
3317os.sync
3318
3319Force write of everything to disk.
3320[clinic start generated code]*/
3321
Larry Hastings2f936352014-08-05 14:04:04 +10003322static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003323os_sync_impl(PyObject *module)
3324/*[clinic end generated code: output=2796b1f0818cd71c input=84749fe5e9b404ff]*/
Ross Lagerwall7807c352011-03-17 20:20:30 +02003325{
3326 Py_BEGIN_ALLOW_THREADS
3327 sync();
3328 Py_END_ALLOW_THREADS
3329 Py_RETURN_NONE;
3330}
Larry Hastings2f936352014-08-05 14:04:04 +10003331#endif /* HAVE_SYNC */
3332
Ross Lagerwall7807c352011-03-17 20:20:30 +02003333
Guido van Rossum21142a01999-01-08 21:05:37 +00003334#ifdef HAVE_FDATASYNC
Guido van Rossum7f58e2e2000-09-22 17:26:14 +00003335#ifdef __hpux
Guido van Rossumecc23b02000-09-22 16:01:05 +00003336extern int fdatasync(int); /* On HP-UX, in libc but not in unistd.h */
3337#endif
3338
Larry Hastings2f936352014-08-05 14:04:04 +10003339/*[clinic input]
3340os.fdatasync
3341
3342 fd: fildes
3343
3344Force write of fd to disk without forcing update of metadata.
3345[clinic start generated code]*/
3346
Larry Hastings2f936352014-08-05 14:04:04 +10003347static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003348os_fdatasync_impl(PyObject *module, int fd)
3349/*[clinic end generated code: output=b4b9698b5d7e26dd input=bc74791ee54dd291]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003350{
3351 return posix_fildes_fd(fd, fdatasync);
Guido van Rossum21142a01999-01-08 21:05:37 +00003352}
3353#endif /* HAVE_FDATASYNC */
3354
3355
Fredrik Lundh10723342000-07-10 16:38:09 +00003356#ifdef HAVE_CHOWN
Larry Hastings2f936352014-08-05 14:04:04 +10003357/*[clinic input]
3358os.chown
3359
3360 path : path_t(allow_fd='PATH_HAVE_FCHOWN')
BNMetricsb9427072018-11-02 15:20:19 +00003361 Path to be examined; can be string, bytes, a path-like object, or open-file-descriptor int.
Larry Hastings2f936352014-08-05 14:04:04 +10003362
3363 uid: uid_t
3364
3365 gid: gid_t
3366
3367 *
3368
3369 dir_fd : dir_fd(requires='fchownat') = None
3370 If not None, it should be a file descriptor open to a directory,
3371 and path should be relative; path will then be relative to that
3372 directory.
3373
3374 follow_symlinks: bool = True
3375 If False, and the last element of the path is a symbolic link,
3376 stat will examine the symbolic link itself instead of the file
3377 the link points to.
3378
3379Change the owner and group id of path to the numeric uid and gid.\
3380
3381path may always be specified as a string.
3382On some platforms, path may also be specified as an open file descriptor.
3383 If this functionality is unavailable, using it raises an exception.
3384If dir_fd is not None, it should be a file descriptor open to a directory,
3385 and path should be relative; path will then be relative to that directory.
3386If follow_symlinks is False, and the last element of the path is a symbolic
3387 link, chown will modify the symbolic link itself instead of the file the
3388 link points to.
3389It is an error to use dir_fd or follow_symlinks when specifying path as
3390 an open file descriptor.
3391dir_fd and follow_symlinks may not be implemented on your platform.
3392 If they are unavailable, using them will raise a NotImplementedError.
3393
3394[clinic start generated code]*/
3395
Larry Hastings2f936352014-08-05 14:04:04 +10003396static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003397os_chown_impl(PyObject *module, path_t *path, uid_t uid, gid_t gid,
Larry Hastings89964c42015-04-14 18:07:59 -04003398 int dir_fd, int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +00003399/*[clinic end generated code: output=4beadab0db5f70cd input=b08c5ec67996a97d]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003400{
3401 int result;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003402
3403#if !(defined(HAVE_LCHOWN) || defined(HAVE_FCHOWNAT))
3404 if (follow_symlinks_specified("chown", follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10003405 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003406#endif
Larry Hastings2f936352014-08-05 14:04:04 +10003407 if (dir_fd_and_fd_invalid("chown", dir_fd, path->fd) ||
3408 fd_and_follow_symlinks_invalid("chown", path->fd, follow_symlinks))
3409 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003410
3411#ifdef __APPLE__
3412 /*
3413 * This is for Mac OS X 10.3, which doesn't have lchown.
3414 * (But we still have an lchown symbol because of weak-linking.)
3415 * It doesn't have fchownat either. So there's no possibility
3416 * of a graceful failover.
Georg Brandlf7875592012-06-24 13:58:31 +02003417 */
Larry Hastings9cf065c2012-06-22 16:30:09 -07003418 if ((!follow_symlinks) && (lchown == NULL)) {
3419 follow_symlinks_specified("chown", follow_symlinks);
Larry Hastings2f936352014-08-05 14:04:04 +10003420 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003421 }
3422#endif
3423
Saiyang Gou7514f4f2020-02-12 23:47:42 -08003424 if (PySys_Audit("os.chown", "OIIi", path->object, uid, gid,
3425 dir_fd == DEFAULT_DIR_FD ? -1 : dir_fd) < 0) {
3426 return NULL;
3427 }
3428
Victor Stinner8c62be82010-05-06 00:08:46 +00003429 Py_BEGIN_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07003430#ifdef HAVE_FCHOWN
Larry Hastings2f936352014-08-05 14:04:04 +10003431 if (path->fd != -1)
3432 result = fchown(path->fd, uid, gid);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003433 else
3434#endif
3435#ifdef HAVE_LCHOWN
3436 if ((!follow_symlinks) && (dir_fd == DEFAULT_DIR_FD))
Larry Hastings2f936352014-08-05 14:04:04 +10003437 result = lchown(path->narrow, uid, gid);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003438 else
3439#endif
3440#ifdef HAVE_FCHOWNAT
3441 if ((dir_fd != DEFAULT_DIR_FD) || (!follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10003442 result = fchownat(dir_fd, path->narrow, uid, gid,
Larry Hastings9cf065c2012-06-22 16:30:09 -07003443 follow_symlinks ? 0 : AT_SYMLINK_NOFOLLOW);
3444 else
3445#endif
Larry Hastings2f936352014-08-05 14:04:04 +10003446 result = chown(path->narrow, uid, gid);
Victor Stinner8c62be82010-05-06 00:08:46 +00003447 Py_END_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07003448
Larry Hastings2f936352014-08-05 14:04:04 +10003449 if (result)
3450 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003451
Larry Hastings2f936352014-08-05 14:04:04 +10003452 Py_RETURN_NONE;
Guido van Rossumb6775db1994-08-01 11:34:53 +00003453}
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00003454#endif /* HAVE_CHOWN */
Guido van Rossumb6775db1994-08-01 11:34:53 +00003455
Larry Hastings2f936352014-08-05 14:04:04 +10003456
Christian Heimes4e30a842007-11-30 22:12:06 +00003457#ifdef HAVE_FCHOWN
Larry Hastings2f936352014-08-05 14:04:04 +10003458/*[clinic input]
3459os.fchown
3460
3461 fd: int
3462 uid: uid_t
3463 gid: gid_t
3464
3465Change the owner and group id of the file specified by file descriptor.
3466
3467Equivalent to os.chown(fd, uid, gid).
3468
3469[clinic start generated code]*/
3470
Larry Hastings2f936352014-08-05 14:04:04 +10003471static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003472os_fchown_impl(PyObject *module, int fd, uid_t uid, gid_t gid)
3473/*[clinic end generated code: output=97d21cbd5a4350a6 input=3af544ba1b13a0d7]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003474{
Victor Stinner8c62be82010-05-06 00:08:46 +00003475 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003476 int async_err = 0;
3477
Saiyang Gou7514f4f2020-02-12 23:47:42 -08003478 if (PySys_Audit("os.chown", "iIIi", fd, uid, gid, -1) < 0) {
3479 return NULL;
3480 }
3481
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003482 do {
3483 Py_BEGIN_ALLOW_THREADS
3484 res = fchown(fd, uid, gid);
3485 Py_END_ALLOW_THREADS
3486 } while (res != 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
3487 if (res != 0)
3488 return (!async_err) ? posix_error() : NULL;
3489
Victor Stinner8c62be82010-05-06 00:08:46 +00003490 Py_RETURN_NONE;
Christian Heimes4e30a842007-11-30 22:12:06 +00003491}
3492#endif /* HAVE_FCHOWN */
3493
Larry Hastings2f936352014-08-05 14:04:04 +10003494
Martin v. Löwis0cec0ff2002-07-28 16:33:45 +00003495#ifdef HAVE_LCHOWN
Larry Hastings2f936352014-08-05 14:04:04 +10003496/*[clinic input]
3497os.lchown
3498
3499 path : path_t
3500 uid: uid_t
3501 gid: gid_t
3502
3503Change the owner and group id of path to the numeric uid and gid.
3504
3505This function will not follow symbolic links.
3506Equivalent to os.chown(path, uid, gid, follow_symlinks=False).
3507[clinic start generated code]*/
3508
Larry Hastings2f936352014-08-05 14:04:04 +10003509static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003510os_lchown_impl(PyObject *module, path_t *path, uid_t uid, gid_t gid)
3511/*[clinic end generated code: output=25eaf6af412fdf2f input=b1c6014d563a7161]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003512{
Victor Stinner8c62be82010-05-06 00:08:46 +00003513 int res;
Saiyang Gou7514f4f2020-02-12 23:47:42 -08003514 if (PySys_Audit("os.chown", "OIIi", path->object, uid, gid, -1) < 0) {
3515 return NULL;
3516 }
Victor Stinner8c62be82010-05-06 00:08:46 +00003517 Py_BEGIN_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10003518 res = lchown(path->narrow, uid, gid);
Victor Stinner8c62be82010-05-06 00:08:46 +00003519 Py_END_ALLOW_THREADS
Victor Stinner292c8352012-10-30 02:17:38 +01003520 if (res < 0) {
Larry Hastings2f936352014-08-05 14:04:04 +10003521 return path_error(path);
Victor Stinner292c8352012-10-30 02:17:38 +01003522 }
Larry Hastings2f936352014-08-05 14:04:04 +10003523 Py_RETURN_NONE;
Martin v. Löwis0cec0ff2002-07-28 16:33:45 +00003524}
3525#endif /* HAVE_LCHOWN */
3526
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00003527
Barry Warsaw53699e91996-12-10 23:23:01 +00003528static PyObject *
Guido van Rossumf0af3e32008-10-02 18:55:37 +00003529posix_getcwd(int use_bytes)
Mark Hammondc2e85bd2002-10-03 05:10:39 +00003530{
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00003531#ifdef MS_WINDOWS
Victor Stinner689830e2019-06-26 17:31:12 +02003532 wchar_t wbuf[MAXPATHLEN];
3533 wchar_t *wbuf2 = wbuf;
3534 DWORD len;
3535
3536 Py_BEGIN_ALLOW_THREADS
3537 len = GetCurrentDirectoryW(Py_ARRAY_LENGTH(wbuf), wbuf);
3538 /* If the buffer is large enough, len does not include the
3539 terminating \0. If the buffer is too small, len includes
3540 the space needed for the terminator. */
3541 if (len >= Py_ARRAY_LENGTH(wbuf)) {
Victor Stinnerec3e20a2019-06-28 18:01:59 +02003542 if (len <= PY_SSIZE_T_MAX / sizeof(wchar_t)) {
Victor Stinnerb6404912013-07-07 16:21:41 +02003543 wbuf2 = PyMem_RawMalloc(len * sizeof(wchar_t));
Victor Stinner8c62be82010-05-06 00:08:46 +00003544 }
Victor Stinner689830e2019-06-26 17:31:12 +02003545 else {
3546 wbuf2 = NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00003547 }
Victor Stinner689830e2019-06-26 17:31:12 +02003548 if (wbuf2) {
3549 len = GetCurrentDirectoryW(len, wbuf2);
Victor Stinner8c62be82010-05-06 00:08:46 +00003550 }
Victor Stinner689830e2019-06-26 17:31:12 +02003551 }
3552 Py_END_ALLOW_THREADS
3553
3554 if (!wbuf2) {
3555 PyErr_NoMemory();
3556 return NULL;
3557 }
3558 if (!len) {
Victor Stinnerb024e842012-10-31 22:24:06 +01003559 if (wbuf2 != wbuf)
Victor Stinnerb6404912013-07-07 16:21:41 +02003560 PyMem_RawFree(wbuf2);
Victor Stinner689830e2019-06-26 17:31:12 +02003561 return PyErr_SetFromWindowsErr(0);
Victor Stinner8c62be82010-05-06 00:08:46 +00003562 }
Victor Stinnerf7c5ae22011-11-16 23:43:07 +01003563
Victor Stinner689830e2019-06-26 17:31:12 +02003564 PyObject *resobj = PyUnicode_FromWideChar(wbuf2, len);
3565 if (wbuf2 != wbuf) {
3566 PyMem_RawFree(wbuf2);
3567 }
Mark Hammondc2e85bd2002-10-03 05:10:39 +00003568
Victor Stinner689830e2019-06-26 17:31:12 +02003569 if (use_bytes) {
3570 if (resobj == NULL) {
3571 return NULL;
3572 }
3573 Py_SETREF(resobj, PyUnicode_EncodeFSDefault(resobj));
3574 }
3575
3576 return resobj;
3577#else
3578 const size_t chunk = 1024;
3579
3580 char *buf = NULL;
3581 char *cwd = NULL;
3582 size_t buflen = 0;
3583
Victor Stinner8c62be82010-05-06 00:08:46 +00003584 Py_BEGIN_ALLOW_THREADS
Victor Stinner4403d7d2015-04-25 00:16:10 +02003585 do {
Victor Stinner689830e2019-06-26 17:31:12 +02003586 char *newbuf;
3587 if (buflen <= PY_SSIZE_T_MAX - chunk) {
3588 buflen += chunk;
3589 newbuf = PyMem_RawRealloc(buf, buflen);
3590 }
3591 else {
3592 newbuf = NULL;
3593 }
3594 if (newbuf == NULL) {
3595 PyMem_RawFree(buf);
3596 buf = NULL;
Victor Stinnerc44f7072016-03-14 18:07:53 +01003597 break;
3598 }
Victor Stinner689830e2019-06-26 17:31:12 +02003599 buf = newbuf;
Victor Stinner4403d7d2015-04-25 00:16:10 +02003600
Victor Stinner4403d7d2015-04-25 00:16:10 +02003601 cwd = getcwd(buf, buflen);
3602 } while (cwd == NULL && errno == ERANGE);
Victor Stinner8c62be82010-05-06 00:08:46 +00003603 Py_END_ALLOW_THREADS
Victor Stinner4403d7d2015-04-25 00:16:10 +02003604
Victor Stinner689830e2019-06-26 17:31:12 +02003605 if (buf == NULL) {
3606 return PyErr_NoMemory();
3607 }
Victor Stinner4403d7d2015-04-25 00:16:10 +02003608 if (cwd == NULL) {
3609 PyMem_RawFree(buf);
Victor Stinner8c62be82010-05-06 00:08:46 +00003610 return posix_error();
Victor Stinner4403d7d2015-04-25 00:16:10 +02003611 }
3612
Victor Stinner689830e2019-06-26 17:31:12 +02003613 PyObject *obj;
3614 if (use_bytes) {
Victor Stinner4403d7d2015-04-25 00:16:10 +02003615 obj = PyBytes_FromStringAndSize(buf, strlen(buf));
Victor Stinner689830e2019-06-26 17:31:12 +02003616 }
3617 else {
Victor Stinner4403d7d2015-04-25 00:16:10 +02003618 obj = PyUnicode_DecodeFSDefault(buf);
Victor Stinner689830e2019-06-26 17:31:12 +02003619 }
Victor Stinner4403d7d2015-04-25 00:16:10 +02003620 PyMem_RawFree(buf);
3621
3622 return obj;
Victor Stinner689830e2019-06-26 17:31:12 +02003623#endif /* !MS_WINDOWS */
Mark Hammondc2e85bd2002-10-03 05:10:39 +00003624}
Guido van Rossumf0af3e32008-10-02 18:55:37 +00003625
Larry Hastings2f936352014-08-05 14:04:04 +10003626
3627/*[clinic input]
3628os.getcwd
3629
3630Return a unicode string representing the current working directory.
3631[clinic start generated code]*/
3632
Larry Hastings2f936352014-08-05 14:04:04 +10003633static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003634os_getcwd_impl(PyObject *module)
3635/*[clinic end generated code: output=21badfae2ea99ddc input=f069211bb70e3d39]*/
Guido van Rossumf0af3e32008-10-02 18:55:37 +00003636{
3637 return posix_getcwd(0);
3638}
3639
Larry Hastings2f936352014-08-05 14:04:04 +10003640
3641/*[clinic input]
3642os.getcwdb
3643
3644Return a bytes string representing the current working directory.
3645[clinic start generated code]*/
3646
Larry Hastings2f936352014-08-05 14:04:04 +10003647static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003648os_getcwdb_impl(PyObject *module)
3649/*[clinic end generated code: output=3dd47909480e4824 input=f6f6a378dad3d9cb]*/
Guido van Rossumf0af3e32008-10-02 18:55:37 +00003650{
3651 return posix_getcwd(1);
3652}
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003653
Larry Hastings2f936352014-08-05 14:04:04 +10003654
Larry Hastings9cf065c2012-06-22 16:30:09 -07003655#if ((!defined(HAVE_LINK)) && defined(MS_WINDOWS))
3656#define HAVE_LINK 1
3657#endif
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00003658
Guido van Rossumb6775db1994-08-01 11:34:53 +00003659#ifdef HAVE_LINK
Larry Hastings2f936352014-08-05 14:04:04 +10003660/*[clinic input]
3661
3662os.link
3663
3664 src : path_t
3665 dst : path_t
3666 *
3667 src_dir_fd : dir_fd = None
3668 dst_dir_fd : dir_fd = None
3669 follow_symlinks: bool = True
3670
3671Create a hard link to a file.
3672
3673If either src_dir_fd or dst_dir_fd is not None, it should be a file
3674 descriptor open to a directory, and the respective path string (src or dst)
3675 should be relative; the path will then be relative to that directory.
3676If follow_symlinks is False, and the last element of src is a symbolic
3677 link, link will create a link to the symbolic link itself instead of the
3678 file the link points to.
3679src_dir_fd, dst_dir_fd, and follow_symlinks may not be implemented on your
3680 platform. If they are unavailable, using them will raise a
3681 NotImplementedError.
3682[clinic start generated code]*/
3683
Larry Hastings2f936352014-08-05 14:04:04 +10003684static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003685os_link_impl(PyObject *module, path_t *src, path_t *dst, int src_dir_fd,
Larry Hastings89964c42015-04-14 18:07:59 -04003686 int dst_dir_fd, int follow_symlinks)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003687/*[clinic end generated code: output=7f00f6007fd5269a input=b0095ebbcbaa7e04]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003688{
Larry Hastings9cf065c2012-06-22 16:30:09 -07003689#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07003690 BOOL result = FALSE;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003691#else
3692 int result;
3693#endif
3694
Larry Hastings9cf065c2012-06-22 16:30:09 -07003695#ifndef HAVE_LINKAT
3696 if ((src_dir_fd != DEFAULT_DIR_FD) || (dst_dir_fd != DEFAULT_DIR_FD)) {
3697 argument_unavailable_error("link", "src_dir_fd and dst_dir_fd");
Larry Hastings2f936352014-08-05 14:04:04 +10003698 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003699 }
3700#endif
3701
Steve Dowercc16be82016-09-08 10:35:16 -07003702#ifndef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10003703 if ((src->narrow && dst->wide) || (src->wide && dst->narrow)) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07003704 PyErr_SetString(PyExc_NotImplementedError,
3705 "link: src and dst must be the same type");
Larry Hastings2f936352014-08-05 14:04:04 +10003706 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003707 }
Steve Dowercc16be82016-09-08 10:35:16 -07003708#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003709
Saiyang Gou7514f4f2020-02-12 23:47:42 -08003710 if (PySys_Audit("os.link", "OOii", src->object, dst->object,
3711 src_dir_fd == DEFAULT_DIR_FD ? -1 : src_dir_fd,
3712 dst_dir_fd == DEFAULT_DIR_FD ? -1 : dst_dir_fd) < 0) {
3713 return NULL;
3714 }
3715
Brian Curtin1b9df392010-11-24 20:24:31 +00003716#ifdef MS_WINDOWS
Larry Hastings9cf065c2012-06-22 16:30:09 -07003717 Py_BEGIN_ALLOW_THREADS
Steve Dowerc3630612016-11-19 18:41:16 -08003718 result = CreateHardLinkW(dst->wide, src->wide, NULL);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003719 Py_END_ALLOW_THREADS
Brian Curtin1b9df392010-11-24 20:24:31 +00003720
Larry Hastings2f936352014-08-05 14:04:04 +10003721 if (!result)
3722 return path_error2(src, dst);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003723#else
3724 Py_BEGIN_ALLOW_THREADS
Larry Hastings67cbf7b2012-06-22 17:06:48 -07003725#ifdef HAVE_LINKAT
Larry Hastings9cf065c2012-06-22 16:30:09 -07003726 if ((src_dir_fd != DEFAULT_DIR_FD) ||
3727 (dst_dir_fd != DEFAULT_DIR_FD) ||
3728 (!follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10003729 result = linkat(src_dir_fd, src->narrow,
3730 dst_dir_fd, dst->narrow,
Larry Hastings9cf065c2012-06-22 16:30:09 -07003731 follow_symlinks ? AT_SYMLINK_FOLLOW : 0);
3732 else
Steve Dowercc16be82016-09-08 10:35:16 -07003733#endif /* HAVE_LINKAT */
Larry Hastings2f936352014-08-05 14:04:04 +10003734 result = link(src->narrow, dst->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003735 Py_END_ALLOW_THREADS
Brian Curtinfc889c42010-11-28 23:59:46 +00003736
Larry Hastings2f936352014-08-05 14:04:04 +10003737 if (result)
3738 return path_error2(src, dst);
Steve Dowercc16be82016-09-08 10:35:16 -07003739#endif /* MS_WINDOWS */
Larry Hastings9cf065c2012-06-22 16:30:09 -07003740
Larry Hastings2f936352014-08-05 14:04:04 +10003741 Py_RETURN_NONE;
Brian Curtin1b9df392010-11-24 20:24:31 +00003742}
Larry Hastings9cf065c2012-06-22 16:30:09 -07003743#endif
3744
Brian Curtin1b9df392010-11-24 20:24:31 +00003745
Gregory P. Smith16ea14a2013-03-20 18:51:33 -07003746#if defined(MS_WINDOWS) && !defined(HAVE_OPENDIR)
Barry Warsaw53699e91996-12-10 23:23:01 +00003747static PyObject *
Gregory P. Smith40a21602013-03-20 20:52:50 -07003748_listdir_windows_no_opendir(path_t *path, PyObject *list)
Guido van Rossumb6775db1994-08-01 11:34:53 +00003749{
Larry Hastings9cf065c2012-06-22 16:30:09 -07003750 PyObject *v;
3751 HANDLE hFindFile = INVALID_HANDLE_VALUE;
3752 BOOL result;
Steve Dowercc16be82016-09-08 10:35:16 -07003753 wchar_t namebuf[MAX_PATH+4]; /* Overallocate for "\*.*" */
Larry Hastings9cf065c2012-06-22 16:30:09 -07003754 /* only claim to have space for MAX_PATH */
Victor Stinner75875072013-11-24 19:23:25 +01003755 Py_ssize_t len = Py_ARRAY_LENGTH(namebuf)-4;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003756 wchar_t *wnamebuf = NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003757
Steve Dowercc16be82016-09-08 10:35:16 -07003758 WIN32_FIND_DATAW wFileData;
3759 const wchar_t *po_wchars;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00003760
Steve Dowercc16be82016-09-08 10:35:16 -07003761 if (!path->wide) { /* Default arg: "." */
3762 po_wchars = L".";
3763 len = 1;
3764 } else {
3765 po_wchars = path->wide;
3766 len = wcslen(path->wide);
3767 }
3768 /* The +5 is so we can append "\\*.*\0" */
3769 wnamebuf = PyMem_New(wchar_t, len + 5);
3770 if (!wnamebuf) {
3771 PyErr_NoMemory();
Larry Hastings9cf065c2012-06-22 16:30:09 -07003772 goto exit;
Victor Stinner8c62be82010-05-06 00:08:46 +00003773 }
Steve Dowercc16be82016-09-08 10:35:16 -07003774 wcscpy(wnamebuf, po_wchars);
Victor Stinner8c62be82010-05-06 00:08:46 +00003775 if (len > 0) {
Steve Dowercc16be82016-09-08 10:35:16 -07003776 wchar_t wch = wnamebuf[len-1];
3777 if (wch != SEP && wch != ALTSEP && wch != L':')
3778 wnamebuf[len++] = SEP;
3779 wcscpy(wnamebuf + len, L"*.*");
Victor Stinner8c62be82010-05-06 00:08:46 +00003780 }
Steve Dowercc16be82016-09-08 10:35:16 -07003781 if ((list = PyList_New(0)) == NULL) {
3782 goto exit;
3783 }
Antoine Pitroub73caab2010-08-09 23:39:31 +00003784 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07003785 hFindFile = FindFirstFileW(wnamebuf, &wFileData);
Antoine Pitroub73caab2010-08-09 23:39:31 +00003786 Py_END_ALLOW_THREADS
Victor Stinner8c62be82010-05-06 00:08:46 +00003787 if (hFindFile == INVALID_HANDLE_VALUE) {
3788 int error = GetLastError();
3789 if (error == ERROR_FILE_NOT_FOUND)
Larry Hastings9cf065c2012-06-22 16:30:09 -07003790 goto exit;
3791 Py_DECREF(list);
Gregory P. Smith40a21602013-03-20 20:52:50 -07003792 list = path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003793 goto exit;
Victor Stinner8c62be82010-05-06 00:08:46 +00003794 }
3795 do {
3796 /* Skip over . and .. */
Steve Dowercc16be82016-09-08 10:35:16 -07003797 if (wcscmp(wFileData.cFileName, L".") != 0 &&
3798 wcscmp(wFileData.cFileName, L"..") != 0) {
3799 v = PyUnicode_FromWideChar(wFileData.cFileName,
3800 wcslen(wFileData.cFileName));
3801 if (path->narrow && v) {
3802 Py_SETREF(v, PyUnicode_EncodeFSDefault(v));
3803 }
Victor Stinner8c62be82010-05-06 00:08:46 +00003804 if (v == NULL) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07003805 Py_DECREF(list);
3806 list = NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00003807 break;
3808 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07003809 if (PyList_Append(list, v) != 0) {
Victor Stinner8c62be82010-05-06 00:08:46 +00003810 Py_DECREF(v);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003811 Py_DECREF(list);
3812 list = NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00003813 break;
3814 }
3815 Py_DECREF(v);
3816 }
3817 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07003818 result = FindNextFileW(hFindFile, &wFileData);
Victor Stinner8c62be82010-05-06 00:08:46 +00003819 Py_END_ALLOW_THREADS
3820 /* FindNextFile sets error to ERROR_NO_MORE_FILES if
3821 it got to the end of the directory. */
3822 if (!result && GetLastError() != ERROR_NO_MORE_FILES) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07003823 Py_DECREF(list);
Gregory P. Smith40a21602013-03-20 20:52:50 -07003824 list = path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003825 goto exit;
Victor Stinner8c62be82010-05-06 00:08:46 +00003826 }
3827 } while (result == TRUE);
Guido van Rossumb6775db1994-08-01 11:34:53 +00003828
Larry Hastings9cf065c2012-06-22 16:30:09 -07003829exit:
3830 if (hFindFile != INVALID_HANDLE_VALUE) {
3831 if (FindClose(hFindFile) == FALSE) {
3832 if (list != NULL) {
3833 Py_DECREF(list);
Gregory P. Smith40a21602013-03-20 20:52:50 -07003834 list = path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003835 }
3836 }
Victor Stinner8c62be82010-05-06 00:08:46 +00003837 }
Victor Stinnerb6404912013-07-07 16:21:41 +02003838 PyMem_Free(wnamebuf);
Guido van Rossumb6775db1994-08-01 11:34:53 +00003839
Larry Hastings9cf065c2012-06-22 16:30:09 -07003840 return list;
Gregory P. Smith16ea14a2013-03-20 18:51:33 -07003841} /* end of _listdir_windows_no_opendir */
3842
3843#else /* thus POSIX, ie: not (MS_WINDOWS and not HAVE_OPENDIR) */
3844
3845static PyObject *
Gregory P. Smith40a21602013-03-20 20:52:50 -07003846_posix_listdir(path_t *path, PyObject *list)
Gregory P. Smith16ea14a2013-03-20 18:51:33 -07003847{
Gregory P. Smith16ea14a2013-03-20 18:51:33 -07003848 PyObject *v;
3849 DIR *dirp = NULL;
3850 struct dirent *ep;
3851 int return_str; /* if false, return bytes */
Larry Hastings4dbc95e2013-08-01 18:18:56 -07003852#ifdef HAVE_FDOPENDIR
3853 int fd = -1;
3854#endif
Gregory P. Smith16ea14a2013-03-20 18:51:33 -07003855
Victor Stinner8c62be82010-05-06 00:08:46 +00003856 errno = 0;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003857#ifdef HAVE_FDOPENDIR
Gregory P. Smith40a21602013-03-20 20:52:50 -07003858 if (path->fd != -1) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07003859 /* closedir() closes the FD, so we duplicate it */
Victor Stinnerdaf45552013-08-28 00:53:59 +02003860 fd = _Py_dup(path->fd);
Victor Stinnerf3266652013-12-19 13:24:49 +01003861 if (fd == -1)
3862 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003863
Larry Hastingsfdaea062012-06-25 04:42:23 -07003864 return_str = 1;
3865
Larry Hastings9cf065c2012-06-22 16:30:09 -07003866 Py_BEGIN_ALLOW_THREADS
3867 dirp = fdopendir(fd);
3868 Py_END_ALLOW_THREADS
3869 }
3870 else
3871#endif
3872 {
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03003873 const char *name;
Gregory P. Smith40a21602013-03-20 20:52:50 -07003874 if (path->narrow) {
3875 name = path->narrow;
Serhiy Storchaka1180e5a2017-07-11 06:36:46 +03003876 /* only return bytes if they specified a bytes-like object */
3877 return_str = !PyObject_CheckBuffer(path->object);
Larry Hastingsfdaea062012-06-25 04:42:23 -07003878 }
3879 else {
3880 name = ".";
3881 return_str = 1;
3882 }
3883
Larry Hastings9cf065c2012-06-22 16:30:09 -07003884 Py_BEGIN_ALLOW_THREADS
3885 dirp = opendir(name);
3886 Py_END_ALLOW_THREADS
3887 }
3888
3889 if (dirp == NULL) {
Gregory P. Smith40a21602013-03-20 20:52:50 -07003890 list = path_error(path);
Larry Hastings4dbc95e2013-08-01 18:18:56 -07003891#ifdef HAVE_FDOPENDIR
3892 if (fd != -1) {
3893 Py_BEGIN_ALLOW_THREADS
3894 close(fd);
3895 Py_END_ALLOW_THREADS
3896 }
3897#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07003898 goto exit;
3899 }
3900 if ((list = PyList_New(0)) == NULL) {
3901 goto exit;
Victor Stinner8c62be82010-05-06 00:08:46 +00003902 }
3903 for (;;) {
3904 errno = 0;
3905 Py_BEGIN_ALLOW_THREADS
3906 ep = readdir(dirp);
3907 Py_END_ALLOW_THREADS
3908 if (ep == NULL) {
3909 if (errno == 0) {
3910 break;
3911 } else {
Larry Hastings9cf065c2012-06-22 16:30:09 -07003912 Py_DECREF(list);
Gregory P. Smith40a21602013-03-20 20:52:50 -07003913 list = path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003914 goto exit;
Victor Stinner8c62be82010-05-06 00:08:46 +00003915 }
3916 }
3917 if (ep->d_name[0] == '.' &&
3918 (NAMLEN(ep) == 1 ||
3919 (ep->d_name[1] == '.' && NAMLEN(ep) == 2)))
3920 continue;
Larry Hastingsfdaea062012-06-25 04:42:23 -07003921 if (return_str)
Victor Stinnera45598a2010-05-14 16:35:39 +00003922 v = PyUnicode_DecodeFSDefaultAndSize(ep->d_name, NAMLEN(ep));
3923 else
3924 v = PyBytes_FromStringAndSize(ep->d_name, NAMLEN(ep));
Victor Stinner8c62be82010-05-06 00:08:46 +00003925 if (v == NULL) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07003926 Py_CLEAR(list);
Victor Stinner8c62be82010-05-06 00:08:46 +00003927 break;
3928 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07003929 if (PyList_Append(list, v) != 0) {
Victor Stinner8c62be82010-05-06 00:08:46 +00003930 Py_DECREF(v);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003931 Py_CLEAR(list);
Victor Stinner8c62be82010-05-06 00:08:46 +00003932 break;
3933 }
3934 Py_DECREF(v);
3935 }
Guido van Rossum0ee42cd1991-04-08 21:01:03 +00003936
Larry Hastings9cf065c2012-06-22 16:30:09 -07003937exit:
3938 if (dirp != NULL) {
3939 Py_BEGIN_ALLOW_THREADS
Larry Hastings4dbc95e2013-08-01 18:18:56 -07003940#ifdef HAVE_FDOPENDIR
Larry Hastings9cf065c2012-06-22 16:30:09 -07003941 if (fd > -1)
3942 rewinddir(dirp);
Larry Hastings4dbc95e2013-08-01 18:18:56 -07003943#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07003944 closedir(dirp);
3945 Py_END_ALLOW_THREADS
3946 }
3947
Larry Hastings9cf065c2012-06-22 16:30:09 -07003948 return list;
Gregory P. Smith16ea14a2013-03-20 18:51:33 -07003949} /* end of _posix_listdir */
3950#endif /* which OS */
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00003951
Larry Hastings2f936352014-08-05 14:04:04 +10003952
3953/*[clinic input]
3954os.listdir
3955
3956 path : path_t(nullable=True, allow_fd='PATH_HAVE_FDOPENDIR') = None
3957
3958Return a list containing the names of the files in the directory.
3959
BNMetricsb9427072018-11-02 15:20:19 +00003960path can be specified as either str, bytes, or a path-like object. If path is bytes,
Larry Hastings2f936352014-08-05 14:04:04 +10003961 the filenames returned will also be bytes; in all other circumstances
3962 the filenames returned will be str.
3963If path is None, uses the path='.'.
3964On some platforms, path may also be specified as an open file descriptor;\
3965 the file descriptor must refer to a directory.
3966 If this functionality is unavailable, using it raises NotImplementedError.
3967
3968The list is in arbitrary order. It does not include the special
3969entries '.' and '..' even if they are present in the directory.
3970
3971
3972[clinic start generated code]*/
3973
Larry Hastings2f936352014-08-05 14:04:04 +10003974static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003975os_listdir_impl(PyObject *module, path_t *path)
BNMetricsb9427072018-11-02 15:20:19 +00003976/*[clinic end generated code: output=293045673fcd1a75 input=e3f58030f538295d]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003977{
Steve Dower60419a72019-06-24 08:42:54 -07003978 if (PySys_Audit("os.listdir", "O",
3979 path->object ? path->object : Py_None) < 0) {
3980 return NULL;
3981 }
Larry Hastings2f936352014-08-05 14:04:04 +10003982#if defined(MS_WINDOWS) && !defined(HAVE_OPENDIR)
3983 return _listdir_windows_no_opendir(path, NULL);
3984#else
3985 return _posix_listdir(path, NULL);
3986#endif
3987}
3988
Martin v. Löwis6238d2b2002-06-30 15:26:10 +00003989#ifdef MS_WINDOWS
Mark Hammondef8b6542001-05-13 08:04:26 +00003990/* A helper function for abspath on win32 */
Serhiy Storchakaf0b50152015-05-13 00:52:39 +03003991/*[clinic input]
3992os._getfullpathname
Victor Stinnereb5657a2011-09-30 01:44:27 +02003993
Serhiy Storchakaf0b50152015-05-13 00:52:39 +03003994 path: path_t
3995 /
3996
3997[clinic start generated code]*/
3998
3999static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004000os__getfullpathname_impl(PyObject *module, path_t *path)
4001/*[clinic end generated code: output=bb8679d56845bc9b input=332ed537c29d0a3e]*/
Serhiy Storchakaf0b50152015-05-13 00:52:39 +03004002{
Victor Stinner3939c322019-06-25 15:02:43 +02004003 wchar_t *abspath;
Victor Stinnereb5657a2011-09-30 01:44:27 +02004004
Victor Stinner3939c322019-06-25 15:02:43 +02004005 /* _Py_abspath() is implemented with GetFullPathNameW() on Windows */
4006 if (_Py_abspath(path->wide, &abspath) < 0) {
4007 return win32_error_object("GetFullPathNameW", path->object);
Victor Stinner8c62be82010-05-06 00:08:46 +00004008 }
Victor Stinner3939c322019-06-25 15:02:43 +02004009 if (abspath == NULL) {
4010 return PyErr_NoMemory();
4011 }
4012
4013 PyObject *str = PyUnicode_FromWideChar(abspath, wcslen(abspath));
4014 PyMem_RawFree(abspath);
4015 if (str == NULL) {
4016 return NULL;
4017 }
4018 if (path->narrow) {
4019 Py_SETREF(str, PyUnicode_EncodeFSDefault(str));
4020 }
4021 return str;
Larry Hastings2f936352014-08-05 14:04:04 +10004022}
Brian Curtind40e6f72010-07-08 21:39:08 +00004023
Brian Curtind25aef52011-06-13 15:16:04 -05004024
Larry Hastings2f936352014-08-05 14:04:04 +10004025/*[clinic input]
4026os._getfinalpathname
Brian Curtinf5e76d02010-11-24 13:14:05 +00004027
Steve Dower23ad6d02018-02-22 10:39:10 -08004028 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +10004029 /
4030
4031A helper function for samepath on windows.
4032[clinic start generated code]*/
4033
Larry Hastings2f936352014-08-05 14:04:04 +10004034static PyObject *
Steve Dower23ad6d02018-02-22 10:39:10 -08004035os__getfinalpathname_impl(PyObject *module, path_t *path)
4036/*[clinic end generated code: output=621a3c79bc29ebfa input=2b6b6c7cbad5fb84]*/
Brian Curtind40e6f72010-07-08 21:39:08 +00004037{
4038 HANDLE hFile;
Alexey Izbyshev3b20d342018-03-08 19:03:25 +03004039 wchar_t buf[MAXPATHLEN], *target_path = buf;
4040 int buf_size = Py_ARRAY_LENGTH(buf);
Brian Curtind40e6f72010-07-08 21:39:08 +00004041 int result_length;
Larry Hastings2f936352014-08-05 14:04:04 +10004042 PyObject *result;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00004043
Steve Dower23ad6d02018-02-22 10:39:10 -08004044 Py_BEGIN_ALLOW_THREADS
Brian Curtind40e6f72010-07-08 21:39:08 +00004045 hFile = CreateFileW(
Steve Dower23ad6d02018-02-22 10:39:10 -08004046 path->wide,
Brian Curtind40e6f72010-07-08 21:39:08 +00004047 0, /* desired access */
4048 0, /* share mode */
4049 NULL, /* security attributes */
4050 OPEN_EXISTING,
4051 /* FILE_FLAG_BACKUP_SEMANTICS is required to open a directory */
4052 FILE_FLAG_BACKUP_SEMANTICS,
4053 NULL);
Alexey Izbyshev3b20d342018-03-08 19:03:25 +03004054 Py_END_ALLOW_THREADS
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00004055
Steve Dower23ad6d02018-02-22 10:39:10 -08004056 if (hFile == INVALID_HANDLE_VALUE) {
Alexey Izbyshev3b20d342018-03-08 19:03:25 +03004057 return win32_error_object("CreateFileW", path->object);
Steve Dower23ad6d02018-02-22 10:39:10 -08004058 }
Brian Curtind40e6f72010-07-08 21:39:08 +00004059
4060 /* We have a good handle to the target, use it to determine the
4061 target path name. */
Alexey Izbyshev3b20d342018-03-08 19:03:25 +03004062 while (1) {
4063 Py_BEGIN_ALLOW_THREADS
4064 result_length = GetFinalPathNameByHandleW(hFile, target_path,
4065 buf_size, VOLUME_NAME_DOS);
4066 Py_END_ALLOW_THREADS
Brian Curtind40e6f72010-07-08 21:39:08 +00004067
Alexey Izbyshev3b20d342018-03-08 19:03:25 +03004068 if (!result_length) {
4069 result = win32_error_object("GetFinalPathNameByHandleW",
4070 path->object);
4071 goto cleanup;
4072 }
Brian Curtind40e6f72010-07-08 21:39:08 +00004073
Alexey Izbyshev3b20d342018-03-08 19:03:25 +03004074 if (result_length < buf_size) {
4075 break;
4076 }
Brian Curtind40e6f72010-07-08 21:39:08 +00004077
Alexey Izbyshev3b20d342018-03-08 19:03:25 +03004078 wchar_t *tmp;
4079 tmp = PyMem_Realloc(target_path != buf ? target_path : NULL,
4080 result_length * sizeof(*tmp));
4081 if (!tmp) {
4082 result = PyErr_NoMemory();
4083 goto cleanup;
4084 }
4085
4086 buf_size = result_length;
4087 target_path = tmp;
Steve Dower23ad6d02018-02-22 10:39:10 -08004088 }
Brian Curtind40e6f72010-07-08 21:39:08 +00004089
Victor Stinner9d3b93b2011-11-22 02:27:30 +01004090 result = PyUnicode_FromWideChar(target_path, result_length);
Steve Dowerdf2d4a62019-08-21 15:27:33 -07004091 if (result && path->narrow) {
Steve Dower23ad6d02018-02-22 10:39:10 -08004092 Py_SETREF(result, PyUnicode_EncodeFSDefault(result));
Steve Dowerdf2d4a62019-08-21 15:27:33 -07004093 }
Steve Dower23ad6d02018-02-22 10:39:10 -08004094
Alexey Izbyshev3b20d342018-03-08 19:03:25 +03004095cleanup:
4096 if (target_path != buf) {
4097 PyMem_Free(target_path);
4098 }
4099 CloseHandle(hFile);
4100 return result;
Larry Hastings2f936352014-08-05 14:04:04 +10004101}
Brian Curtin62857742010-09-06 17:07:27 +00004102
Tim Golden6b528062013-08-01 12:44:00 +01004103
Larry Hastings2f936352014-08-05 14:04:04 +10004104/*[clinic input]
4105os._getvolumepathname
4106
Steve Dower23ad6d02018-02-22 10:39:10 -08004107 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +10004108
4109A helper function for ismount on Win32.
4110[clinic start generated code]*/
4111
Larry Hastings2f936352014-08-05 14:04:04 +10004112static PyObject *
Steve Dower23ad6d02018-02-22 10:39:10 -08004113os__getvolumepathname_impl(PyObject *module, path_t *path)
4114/*[clinic end generated code: output=804c63fd13a1330b input=722b40565fa21552]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004115{
4116 PyObject *result;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03004117 wchar_t *mountpath=NULL;
Victor Stinner6edddfa2013-11-24 19:22:57 +01004118 size_t buflen;
Tim Golden6b528062013-08-01 12:44:00 +01004119 BOOL ret;
4120
Tim Golden6b528062013-08-01 12:44:00 +01004121 /* Volume path should be shorter than entire path */
Steve Dower23ad6d02018-02-22 10:39:10 -08004122 buflen = Py_MAX(path->length, MAX_PATH);
Victor Stinner6edddfa2013-11-24 19:22:57 +01004123
Victor Stinner850a18e2017-10-24 16:53:32 -07004124 if (buflen > PY_DWORD_MAX) {
Victor Stinner6edddfa2013-11-24 19:22:57 +01004125 PyErr_SetString(PyExc_OverflowError, "path too long");
4126 return NULL;
4127 }
4128
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02004129 mountpath = PyMem_New(wchar_t, buflen);
Tim Golden6b528062013-08-01 12:44:00 +01004130 if (mountpath == NULL)
4131 return PyErr_NoMemory();
4132
4133 Py_BEGIN_ALLOW_THREADS
Steve Dower23ad6d02018-02-22 10:39:10 -08004134 ret = GetVolumePathNameW(path->wide, mountpath,
Victor Stinner6edddfa2013-11-24 19:22:57 +01004135 Py_SAFE_DOWNCAST(buflen, size_t, DWORD));
Tim Golden6b528062013-08-01 12:44:00 +01004136 Py_END_ALLOW_THREADS
4137
4138 if (!ret) {
Steve Dower23ad6d02018-02-22 10:39:10 -08004139 result = win32_error_object("_getvolumepathname", path->object);
Tim Golden6b528062013-08-01 12:44:00 +01004140 goto exit;
4141 }
4142 result = PyUnicode_FromWideChar(mountpath, wcslen(mountpath));
Steve Dower23ad6d02018-02-22 10:39:10 -08004143 if (path->narrow)
4144 Py_SETREF(result, PyUnicode_EncodeFSDefault(result));
Tim Golden6b528062013-08-01 12:44:00 +01004145
4146exit:
4147 PyMem_Free(mountpath);
4148 return result;
4149}
Tim Golden6b528062013-08-01 12:44:00 +01004150
Martin v. Löwis6238d2b2002-06-30 15:26:10 +00004151#endif /* MS_WINDOWS */
Mark Hammondef8b6542001-05-13 08:04:26 +00004152
Larry Hastings2f936352014-08-05 14:04:04 +10004153
4154/*[clinic input]
4155os.mkdir
4156
4157 path : path_t
4158
4159 mode: int = 0o777
4160
4161 *
4162
4163 dir_fd : dir_fd(requires='mkdirat') = None
4164
4165# "mkdir(path, mode=0o777, *, dir_fd=None)\n\n\
4166
4167Create a directory.
4168
4169If dir_fd is not None, it should be a file descriptor open to a directory,
4170 and path should be relative; path will then be relative to that directory.
4171dir_fd may not be implemented on your platform.
4172 If it is unavailable, using it will raise a NotImplementedError.
4173
4174The mode argument is ignored on Windows.
4175[clinic start generated code]*/
4176
Larry Hastings2f936352014-08-05 14:04:04 +10004177static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004178os_mkdir_impl(PyObject *module, path_t *path, int mode, int dir_fd)
4179/*[clinic end generated code: output=a70446903abe821f input=e965f68377e9b1ce]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004180{
4181 int result;
Mark Hammondc2e85bd2002-10-03 05:10:39 +00004182
Saiyang Gou7514f4f2020-02-12 23:47:42 -08004183 if (PySys_Audit("os.mkdir", "Oii", path->object, mode,
4184 dir_fd == DEFAULT_DIR_FD ? -1 : dir_fd) < 0) {
4185 return NULL;
4186 }
4187
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00004188#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00004189 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07004190 result = CreateDirectoryW(path->wide, NULL);
Victor Stinner8c62be82010-05-06 00:08:46 +00004191 Py_END_ALLOW_THREADS
Mark Hammondc2e85bd2002-10-03 05:10:39 +00004192
Larry Hastings2f936352014-08-05 14:04:04 +10004193 if (!result)
4194 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004195#else
Victor Stinner8c62be82010-05-06 00:08:46 +00004196 Py_BEGIN_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07004197#if HAVE_MKDIRAT
4198 if (dir_fd != DEFAULT_DIR_FD)
Larry Hastings2f936352014-08-05 14:04:04 +10004199 result = mkdirat(dir_fd, path->narrow, mode);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004200 else
4201#endif
Erik Bray03eb11f2017-10-27 14:27:06 +02004202#if defined(__WATCOMC__) && !defined(__QNX__)
Larry Hastings2f936352014-08-05 14:04:04 +10004203 result = mkdir(path->narrow);
Guido van Rossuma4916fa1996-05-23 22:58:55 +00004204#else
Larry Hastings2f936352014-08-05 14:04:04 +10004205 result = mkdir(path->narrow, mode);
Guido van Rossuma4916fa1996-05-23 22:58:55 +00004206#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00004207 Py_END_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10004208 if (result < 0)
4209 return path_error(path);
Steve Dowercc16be82016-09-08 10:35:16 -07004210#endif /* MS_WINDOWS */
Larry Hastings2f936352014-08-05 14:04:04 +10004211 Py_RETURN_NONE;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004212}
4213
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004214
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004215/* sys/resource.h is needed for at least: wait3(), wait4(), broken nice. */
4216#if defined(HAVE_SYS_RESOURCE_H)
Thomas Wouterse38b2f12001-07-11 22:35:31 +00004217#include <sys/resource.h>
4218#endif
Thomas Wouterse38b2f12001-07-11 22:35:31 +00004219
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004220
4221#ifdef HAVE_NICE
Larry Hastings2f936352014-08-05 14:04:04 +10004222/*[clinic input]
4223os.nice
4224
4225 increment: int
4226 /
4227
4228Add increment to the priority of process and return the new priority.
4229[clinic start generated code]*/
4230
Larry Hastings2f936352014-08-05 14:04:04 +10004231static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004232os_nice_impl(PyObject *module, int increment)
4233/*[clinic end generated code: output=9dad8a9da8109943 input=864be2d402a21da2]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004234{
4235 int value;
Thomas Woutersc2c12dc2001-07-11 14:45:34 +00004236
Victor Stinner8c62be82010-05-06 00:08:46 +00004237 /* There are two flavours of 'nice': one that returns the new
4238 priority (as required by almost all standards out there) and the
Benjamin Peterson288d1da2017-09-28 22:44:27 -07004239 Linux/FreeBSD one, which returns '0' on success and advices
Victor Stinner8c62be82010-05-06 00:08:46 +00004240 the use of getpriority() to get the new priority.
Tim Peters5aa91602002-01-30 05:46:57 +00004241
Victor Stinner8c62be82010-05-06 00:08:46 +00004242 If we are of the nice family that returns the new priority, we
4243 need to clear errno before the call, and check if errno is filled
4244 before calling posix_error() on a returnvalue of -1, because the
4245 -1 may be the actual new priority! */
Thomas Woutersc2c12dc2001-07-11 14:45:34 +00004246
Victor Stinner8c62be82010-05-06 00:08:46 +00004247 errno = 0;
4248 value = nice(increment);
Thomas Wouterse38b2f12001-07-11 22:35:31 +00004249#if defined(HAVE_BROKEN_NICE) && defined(HAVE_GETPRIORITY)
Victor Stinner8c62be82010-05-06 00:08:46 +00004250 if (value == 0)
4251 value = getpriority(PRIO_PROCESS, 0);
Thomas Woutersc2c12dc2001-07-11 14:45:34 +00004252#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00004253 if (value == -1 && errno != 0)
4254 /* either nice() or getpriority() returned an error */
4255 return posix_error();
4256 return PyLong_FromLong((long) value);
Guido van Rossum775f4da1993-01-09 17:18:52 +00004257}
Guido van Rossumb6775db1994-08-01 11:34:53 +00004258#endif /* HAVE_NICE */
Guido van Rossum1ff6cb41991-04-08 20:59:13 +00004259
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00004260
4261#ifdef HAVE_GETPRIORITY
Larry Hastings2f936352014-08-05 14:04:04 +10004262/*[clinic input]
4263os.getpriority
4264
4265 which: int
4266 who: int
4267
4268Return program scheduling priority.
4269[clinic start generated code]*/
4270
Larry Hastings2f936352014-08-05 14:04:04 +10004271static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004272os_getpriority_impl(PyObject *module, int which, int who)
4273/*[clinic end generated code: output=c41b7b63c7420228 input=9be615d40e2544ef]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004274{
4275 int retval;
4276
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00004277 errno = 0;
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00004278 retval = getpriority(which, who);
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00004279 if (errno != 0)
4280 return posix_error();
4281 return PyLong_FromLong((long)retval);
4282}
4283#endif /* HAVE_GETPRIORITY */
4284
4285
4286#ifdef HAVE_SETPRIORITY
Larry Hastings2f936352014-08-05 14:04:04 +10004287/*[clinic input]
4288os.setpriority
4289
4290 which: int
4291 who: int
4292 priority: int
4293
4294Set program scheduling priority.
4295[clinic start generated code]*/
4296
Larry Hastings2f936352014-08-05 14:04:04 +10004297static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004298os_setpriority_impl(PyObject *module, int which, int who, int priority)
4299/*[clinic end generated code: output=3d910d95a7771eb2 input=710ccbf65b9dc513]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004300{
4301 int retval;
4302
4303 retval = setpriority(which, who, priority);
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00004304 if (retval == -1)
4305 return posix_error();
4306 Py_RETURN_NONE;
4307}
4308#endif /* HAVE_SETPRIORITY */
4309
4310
Barry Warsaw53699e91996-12-10 23:23:01 +00004311static PyObject *
Larry Hastings2f936352014-08-05 14:04:04 +10004312internal_rename(path_t *src, path_t *dst, int src_dir_fd, int dst_dir_fd, int is_replace)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004313{
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03004314 const char *function_name = is_replace ? "replace" : "rename";
Larry Hastings9cf065c2012-06-22 16:30:09 -07004315 int dir_fd_specified;
Larry Hastings9cf065c2012-06-22 16:30:09 -07004316
Mark Hammondc2e85bd2002-10-03 05:10:39 +00004317#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00004318 BOOL result;
Antoine Pitrouf3b2d882012-01-30 22:08:52 +01004319 int flags = is_replace ? MOVEFILE_REPLACE_EXISTING : 0;
Mark Hammondc2e85bd2002-10-03 05:10:39 +00004320#else
Larry Hastings9cf065c2012-06-22 16:30:09 -07004321 int result;
Mark Hammondc2e85bd2002-10-03 05:10:39 +00004322#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07004323
Larry Hastings9cf065c2012-06-22 16:30:09 -07004324 dir_fd_specified = (src_dir_fd != DEFAULT_DIR_FD) ||
4325 (dst_dir_fd != DEFAULT_DIR_FD);
4326#ifndef HAVE_RENAMEAT
4327 if (dir_fd_specified) {
4328 argument_unavailable_error(function_name, "src_dir_fd and dst_dir_fd");
Larry Hastings2f936352014-08-05 14:04:04 +10004329 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07004330 }
4331#endif
4332
Saiyang Gou7514f4f2020-02-12 23:47:42 -08004333 if (PySys_Audit("os.rename", "OOii", src->object, dst->object,
4334 src_dir_fd == DEFAULT_DIR_FD ? -1 : src_dir_fd,
4335 dst_dir_fd == DEFAULT_DIR_FD ? -1 : dst_dir_fd) < 0) {
4336 return NULL;
4337 }
4338
Larry Hastings9cf065c2012-06-22 16:30:09 -07004339#ifdef MS_WINDOWS
4340 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07004341 result = MoveFileExW(src->wide, dst->wide, flags);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004342 Py_END_ALLOW_THREADS
4343
Larry Hastings2f936352014-08-05 14:04:04 +10004344 if (!result)
4345 return path_error2(src, dst);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004346
4347#else
Steve Dowercc16be82016-09-08 10:35:16 -07004348 if ((src->narrow && dst->wide) || (src->wide && dst->narrow)) {
4349 PyErr_Format(PyExc_ValueError,
4350 "%s: src and dst must be the same type", function_name);
4351 return NULL;
4352 }
4353
Larry Hastings9cf065c2012-06-22 16:30:09 -07004354 Py_BEGIN_ALLOW_THREADS
4355#ifdef HAVE_RENAMEAT
4356 if (dir_fd_specified)
Larry Hastings2f936352014-08-05 14:04:04 +10004357 result = renameat(src_dir_fd, src->narrow, dst_dir_fd, dst->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004358 else
4359#endif
Steve Dowercc16be82016-09-08 10:35:16 -07004360 result = rename(src->narrow, dst->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004361 Py_END_ALLOW_THREADS
4362
Larry Hastings2f936352014-08-05 14:04:04 +10004363 if (result)
4364 return path_error2(src, dst);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004365#endif
Larry Hastings2f936352014-08-05 14:04:04 +10004366 Py_RETURN_NONE;
4367}
Larry Hastings9cf065c2012-06-22 16:30:09 -07004368
Larry Hastings2f936352014-08-05 14:04:04 +10004369
4370/*[clinic input]
4371os.rename
4372
4373 src : path_t
4374 dst : path_t
4375 *
4376 src_dir_fd : dir_fd = None
4377 dst_dir_fd : dir_fd = None
4378
4379Rename a file or directory.
4380
4381If either src_dir_fd or dst_dir_fd is not None, it should be a file
4382 descriptor open to a directory, and the respective path string (src or dst)
4383 should be relative; the path will then be relative to that directory.
4384src_dir_fd and dst_dir_fd, may not be implemented on your platform.
4385 If they are unavailable, using them will raise a NotImplementedError.
4386[clinic start generated code]*/
4387
Antoine Pitrouf3b2d882012-01-30 22:08:52 +01004388static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004389os_rename_impl(PyObject *module, path_t *src, path_t *dst, int src_dir_fd,
Larry Hastings89964c42015-04-14 18:07:59 -04004390 int dst_dir_fd)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004391/*[clinic end generated code: output=59e803072cf41230 input=faa61c847912c850]*/
Antoine Pitrouf3b2d882012-01-30 22:08:52 +01004392{
Larry Hastings2f936352014-08-05 14:04:04 +10004393 return internal_rename(src, dst, src_dir_fd, dst_dir_fd, 0);
Antoine Pitrouf3b2d882012-01-30 22:08:52 +01004394}
4395
Larry Hastings2f936352014-08-05 14:04:04 +10004396
4397/*[clinic input]
4398os.replace = os.rename
4399
4400Rename a file or directory, overwriting the destination.
4401
4402If either src_dir_fd or dst_dir_fd is not None, it should be a file
4403 descriptor open to a directory, and the respective path string (src or dst)
4404 should be relative; the path will then be relative to that directory.
4405src_dir_fd and dst_dir_fd, may not be implemented on your platform.
Anthony Sottile73d60022019-02-12 23:15:54 -05004406 If they are unavailable, using them will raise a NotImplementedError.
Larry Hastings2f936352014-08-05 14:04:04 +10004407[clinic start generated code]*/
4408
Larry Hastings2f936352014-08-05 14:04:04 +10004409static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004410os_replace_impl(PyObject *module, path_t *src, path_t *dst, int src_dir_fd,
4411 int dst_dir_fd)
Anthony Sottile73d60022019-02-12 23:15:54 -05004412/*[clinic end generated code: output=1968c02e7857422b input=c003f0def43378ef]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004413{
4414 return internal_rename(src, dst, src_dir_fd, dst_dir_fd, 1);
4415}
4416
4417
4418/*[clinic input]
4419os.rmdir
4420
4421 path: path_t
4422 *
4423 dir_fd: dir_fd(requires='unlinkat') = None
4424
4425Remove a directory.
4426
4427If dir_fd is not None, it should be a file descriptor open to a directory,
4428 and path should be relative; path will then be relative to that directory.
4429dir_fd may not be implemented on your platform.
4430 If it is unavailable, using it will raise a NotImplementedError.
4431[clinic start generated code]*/
4432
Larry Hastings2f936352014-08-05 14:04:04 +10004433static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004434os_rmdir_impl(PyObject *module, path_t *path, int dir_fd)
4435/*[clinic end generated code: output=080eb54f506e8301 input=38c8b375ca34a7e2]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004436{
4437 int result;
Larry Hastingsb698d8e2012-06-23 16:55:07 -07004438
Saiyang Gou7514f4f2020-02-12 23:47:42 -08004439 if (PySys_Audit("os.rmdir", "Oi", path->object,
4440 dir_fd == DEFAULT_DIR_FD ? -1 : dir_fd) < 0) {
4441 return NULL;
4442 }
4443
Larry Hastingsb698d8e2012-06-23 16:55:07 -07004444 Py_BEGIN_ALLOW_THREADS
4445#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07004446 /* Windows, success=1, UNIX, success=0 */
4447 result = !RemoveDirectoryW(path->wide);
Larry Hastingsb698d8e2012-06-23 16:55:07 -07004448#else
4449#ifdef HAVE_UNLINKAT
4450 if (dir_fd != DEFAULT_DIR_FD)
Larry Hastings2f936352014-08-05 14:04:04 +10004451 result = unlinkat(dir_fd, path->narrow, AT_REMOVEDIR);
Larry Hastingsb698d8e2012-06-23 16:55:07 -07004452 else
4453#endif
Larry Hastings2f936352014-08-05 14:04:04 +10004454 result = rmdir(path->narrow);
Larry Hastingsb698d8e2012-06-23 16:55:07 -07004455#endif
4456 Py_END_ALLOW_THREADS
4457
Larry Hastings2f936352014-08-05 14:04:04 +10004458 if (result)
4459 return path_error(path);
Larry Hastingsb698d8e2012-06-23 16:55:07 -07004460
Larry Hastings2f936352014-08-05 14:04:04 +10004461 Py_RETURN_NONE;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004462}
4463
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004464
Guido van Rossuma4916fa1996-05-23 22:58:55 +00004465#ifdef HAVE_SYSTEM
Larry Hastings2f936352014-08-05 14:04:04 +10004466#ifdef MS_WINDOWS
4467/*[clinic input]
4468os.system -> long
4469
4470 command: Py_UNICODE
4471
4472Execute the command in a subshell.
4473[clinic start generated code]*/
4474
Larry Hastings2f936352014-08-05 14:04:04 +10004475static long
Serhiy Storchakaafb3e712018-12-14 11:19:51 +02004476os_system_impl(PyObject *module, const Py_UNICODE *command)
4477/*[clinic end generated code: output=5b7c3599c068ca42 input=303f5ce97df606b0]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004478{
4479 long result;
Steve Dowerb82e17e2019-05-23 08:45:22 -07004480
Steve Dowerfbe3c762019-10-18 00:52:15 -07004481 if (PySys_Audit("os.system", "(u)", command) < 0) {
Steve Dowerb82e17e2019-05-23 08:45:22 -07004482 return -1;
4483 }
4484
Victor Stinner8c62be82010-05-06 00:08:46 +00004485 Py_BEGIN_ALLOW_THREADS
Steve Dowerc3630612016-11-19 18:41:16 -08004486 _Py_BEGIN_SUPPRESS_IPH
Larry Hastings2f936352014-08-05 14:04:04 +10004487 result = _wsystem(command);
Steve Dowerc3630612016-11-19 18:41:16 -08004488 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00004489 Py_END_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10004490 return result;
4491}
4492#else /* MS_WINDOWS */
4493/*[clinic input]
4494os.system -> long
4495
4496 command: FSConverter
4497
4498Execute the command in a subshell.
4499[clinic start generated code]*/
4500
Larry Hastings2f936352014-08-05 14:04:04 +10004501static long
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004502os_system_impl(PyObject *module, PyObject *command)
4503/*[clinic end generated code: output=290fc437dd4f33a0 input=86a58554ba6094af]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004504{
4505 long result;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03004506 const char *bytes = PyBytes_AsString(command);
Steve Dowerb82e17e2019-05-23 08:45:22 -07004507
Steve Dowerfbe3c762019-10-18 00:52:15 -07004508 if (PySys_Audit("os.system", "(O)", command) < 0) {
Steve Dowerb82e17e2019-05-23 08:45:22 -07004509 return -1;
4510 }
4511
Larry Hastings2f936352014-08-05 14:04:04 +10004512 Py_BEGIN_ALLOW_THREADS
4513 result = system(bytes);
4514 Py_END_ALLOW_THREADS
4515 return result;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004516}
Guido van Rossuma4916fa1996-05-23 22:58:55 +00004517#endif
Larry Hastings2f936352014-08-05 14:04:04 +10004518#endif /* HAVE_SYSTEM */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004519
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004520
Larry Hastings2f936352014-08-05 14:04:04 +10004521/*[clinic input]
4522os.umask
4523
4524 mask: int
4525 /
4526
4527Set the current numeric umask and return the previous umask.
4528[clinic start generated code]*/
4529
Larry Hastings2f936352014-08-05 14:04:04 +10004530static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004531os_umask_impl(PyObject *module, int mask)
4532/*[clinic end generated code: output=a2e33ce3bc1a6e33 input=ab6bfd9b24d8a7e8]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004533{
4534 int i = (int)umask(mask);
Victor Stinner8c62be82010-05-06 00:08:46 +00004535 if (i < 0)
4536 return posix_error();
4537 return PyLong_FromLong((long)i);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004538}
4539
Brian Curtind40e6f72010-07-08 21:39:08 +00004540#ifdef MS_WINDOWS
4541
4542/* override the default DeleteFileW behavior so that directory
4543symlinks can be removed with this function, the same as with
4544Unix symlinks */
4545BOOL WINAPI Py_DeleteFileW(LPCWSTR lpFileName)
4546{
4547 WIN32_FILE_ATTRIBUTE_DATA info;
4548 WIN32_FIND_DATAW find_data;
4549 HANDLE find_data_handle;
4550 int is_directory = 0;
4551 int is_link = 0;
4552
4553 if (GetFileAttributesExW(lpFileName, GetFileExInfoStandard, &info)) {
4554 is_directory = info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00004555
Brian Curtind40e6f72010-07-08 21:39:08 +00004556 /* Get WIN32_FIND_DATA structure for the path to determine if
4557 it is a symlink */
4558 if(is_directory &&
4559 info.dwFileAttributes & FILE_ATTRIBUTE_REPARSE_POINT) {
4560 find_data_handle = FindFirstFileW(lpFileName, &find_data);
4561
4562 if(find_data_handle != INVALID_HANDLE_VALUE) {
Tim Golden0321cf22014-05-05 19:46:17 +01004563 /* IO_REPARSE_TAG_SYMLINK if it is a symlink and
4564 IO_REPARSE_TAG_MOUNT_POINT if it is a junction point. */
4565 is_link = find_data.dwReserved0 == IO_REPARSE_TAG_SYMLINK ||
4566 find_data.dwReserved0 == IO_REPARSE_TAG_MOUNT_POINT;
Brian Curtind40e6f72010-07-08 21:39:08 +00004567 FindClose(find_data_handle);
4568 }
4569 }
4570 }
4571
4572 if (is_directory && is_link)
4573 return RemoveDirectoryW(lpFileName);
4574
4575 return DeleteFileW(lpFileName);
4576}
4577#endif /* MS_WINDOWS */
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004578
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004579
Larry Hastings2f936352014-08-05 14:04:04 +10004580/*[clinic input]
4581os.unlink
4582
4583 path: path_t
4584 *
4585 dir_fd: dir_fd(requires='unlinkat')=None
4586
4587Remove a file (same as remove()).
4588
4589If dir_fd is not None, it should be a file descriptor open to a directory,
4590 and path should be relative; path will then be relative to that directory.
4591dir_fd may not be implemented on your platform.
4592 If it is unavailable, using it will raise a NotImplementedError.
4593
4594[clinic start generated code]*/
4595
Larry Hastings2f936352014-08-05 14:04:04 +10004596static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004597os_unlink_impl(PyObject *module, path_t *path, int dir_fd)
4598/*[clinic end generated code: output=621797807b9963b1 input=d7bcde2b1b2a2552]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004599{
4600 int result;
Larry Hastings9cf065c2012-06-22 16:30:09 -07004601
Saiyang Gou7514f4f2020-02-12 23:47:42 -08004602 if (PySys_Audit("os.remove", "Oi", path->object,
4603 dir_fd == DEFAULT_DIR_FD ? -1 : dir_fd) < 0) {
4604 return NULL;
4605 }
4606
Larry Hastings9cf065c2012-06-22 16:30:09 -07004607 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04004608 _Py_BEGIN_SUPPRESS_IPH
Larry Hastings9cf065c2012-06-22 16:30:09 -07004609#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07004610 /* Windows, success=1, UNIX, success=0 */
4611 result = !Py_DeleteFileW(path->wide);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004612#else
Larry Hastings9cf065c2012-06-22 16:30:09 -07004613#ifdef HAVE_UNLINKAT
4614 if (dir_fd != DEFAULT_DIR_FD)
Larry Hastings2f936352014-08-05 14:04:04 +10004615 result = unlinkat(dir_fd, path->narrow, 0);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004616 else
4617#endif /* HAVE_UNLINKAT */
Larry Hastings2f936352014-08-05 14:04:04 +10004618 result = unlink(path->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004619#endif
Steve Dower8fc89802015-04-12 00:26:27 -04004620 _Py_END_SUPPRESS_IPH
Larry Hastings9cf065c2012-06-22 16:30:09 -07004621 Py_END_ALLOW_THREADS
4622
Larry Hastings2f936352014-08-05 14:04:04 +10004623 if (result)
4624 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004625
Larry Hastings2f936352014-08-05 14:04:04 +10004626 Py_RETURN_NONE;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004627}
4628
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004629
Larry Hastings2f936352014-08-05 14:04:04 +10004630/*[clinic input]
4631os.remove = os.unlink
4632
4633Remove a file (same as unlink()).
4634
4635If dir_fd is not None, it should be a file descriptor open to a directory,
4636 and path should be relative; path will then be relative to that directory.
4637dir_fd may not be implemented on your platform.
4638 If it is unavailable, using it will raise a NotImplementedError.
4639[clinic start generated code]*/
4640
Larry Hastings2f936352014-08-05 14:04:04 +10004641static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004642os_remove_impl(PyObject *module, path_t *path, int dir_fd)
4643/*[clinic end generated code: output=a8535b28f0068883 input=e05c5ab55cd30983]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004644{
4645 return os_unlink_impl(module, path, dir_fd);
4646}
4647
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004648
Larry Hastings605a62d2012-06-24 04:33:36 -07004649static PyStructSequence_Field uname_result_fields[] = {
4650 {"sysname", "operating system name"},
4651 {"nodename", "name of machine on network (implementation-defined)"},
4652 {"release", "operating system release"},
4653 {"version", "operating system version"},
4654 {"machine", "hardware identifier"},
4655 {NULL}
4656};
4657
4658PyDoc_STRVAR(uname_result__doc__,
4659"uname_result: Result from os.uname().\n\n\
4660This object may be accessed either as a tuple of\n\
4661 (sysname, nodename, release, version, machine),\n\
4662or via the attributes sysname, nodename, release, version, and machine.\n\
4663\n\
4664See os.uname for more information.");
4665
4666static PyStructSequence_Desc uname_result_desc = {
Eddie Elizondob3966632019-11-05 07:16:14 -08004667 MODNAME ".uname_result", /* name */
Larry Hastings605a62d2012-06-24 04:33:36 -07004668 uname_result__doc__, /* doc */
4669 uname_result_fields,
4670 5
4671};
4672
Larry Hastings605a62d2012-06-24 04:33:36 -07004673#ifdef HAVE_UNAME
Larry Hastings2f936352014-08-05 14:04:04 +10004674/*[clinic input]
4675os.uname
4676
4677Return an object identifying the current operating system.
4678
4679The object behaves like a named tuple with the following fields:
4680 (sysname, nodename, release, version, machine)
4681
4682[clinic start generated code]*/
4683
Larry Hastings2f936352014-08-05 14:04:04 +10004684static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004685os_uname_impl(PyObject *module)
4686/*[clinic end generated code: output=e6a49cf1a1508a19 input=e68bd246db3043ed]*/
Guido van Rossumc39de5f1992-02-05 11:15:54 +00004687{
Victor Stinner8c62be82010-05-06 00:08:46 +00004688 struct utsname u;
4689 int res;
Larry Hastings605a62d2012-06-24 04:33:36 -07004690 PyObject *value;
Neal Norwitze241ce82003-02-17 18:17:05 +00004691
Victor Stinner8c62be82010-05-06 00:08:46 +00004692 Py_BEGIN_ALLOW_THREADS
4693 res = uname(&u);
4694 Py_END_ALLOW_THREADS
4695 if (res < 0)
4696 return posix_error();
Larry Hastings605a62d2012-06-24 04:33:36 -07004697
Hai Shif707d942020-03-16 21:15:01 +08004698 PyObject *UnameResultType = get_posix_state(module)->UnameResultType;
Eddie Elizondob3966632019-11-05 07:16:14 -08004699 value = PyStructSequence_New((PyTypeObject *)UnameResultType);
Larry Hastings605a62d2012-06-24 04:33:36 -07004700 if (value == NULL)
4701 return NULL;
4702
4703#define SET(i, field) \
4704 { \
Victor Stinnera534fc42013-06-03 22:07:27 +02004705 PyObject *o = PyUnicode_DecodeFSDefault(field); \
Larry Hastings605a62d2012-06-24 04:33:36 -07004706 if (!o) { \
4707 Py_DECREF(value); \
4708 return NULL; \
4709 } \
4710 PyStructSequence_SET_ITEM(value, i, o); \
4711 } \
4712
4713 SET(0, u.sysname);
4714 SET(1, u.nodename);
4715 SET(2, u.release);
4716 SET(3, u.version);
4717 SET(4, u.machine);
4718
4719#undef SET
4720
4721 return value;
Guido van Rossumc39de5f1992-02-05 11:15:54 +00004722}
Guido van Rossumb6775db1994-08-01 11:34:53 +00004723#endif /* HAVE_UNAME */
Guido van Rossum1ff6cb41991-04-08 20:59:13 +00004724
Larry Hastings9e3e70b2011-09-08 19:29:07 -07004725
Larry Hastings9cf065c2012-06-22 16:30:09 -07004726
4727typedef struct {
4728 int now;
4729 time_t atime_s;
4730 long atime_ns;
4731 time_t mtime_s;
4732 long mtime_ns;
4733} utime_t;
4734
4735/*
Victor Stinner484df002014-10-09 13:52:31 +02004736 * these macros assume that "ut" is a pointer to a utime_t
Larry Hastings9cf065c2012-06-22 16:30:09 -07004737 * they also intentionally leak the declaration of a pointer named "time"
4738 */
4739#define UTIME_TO_TIMESPEC \
4740 struct timespec ts[2]; \
4741 struct timespec *time; \
Victor Stinner484df002014-10-09 13:52:31 +02004742 if (ut->now) \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004743 time = NULL; \
4744 else { \
Victor Stinner484df002014-10-09 13:52:31 +02004745 ts[0].tv_sec = ut->atime_s; \
4746 ts[0].tv_nsec = ut->atime_ns; \
4747 ts[1].tv_sec = ut->mtime_s; \
4748 ts[1].tv_nsec = ut->mtime_ns; \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004749 time = ts; \
4750 } \
4751
4752#define UTIME_TO_TIMEVAL \
4753 struct timeval tv[2]; \
4754 struct timeval *time; \
Victor Stinner484df002014-10-09 13:52:31 +02004755 if (ut->now) \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004756 time = NULL; \
4757 else { \
Victor Stinner484df002014-10-09 13:52:31 +02004758 tv[0].tv_sec = ut->atime_s; \
4759 tv[0].tv_usec = ut->atime_ns / 1000; \
4760 tv[1].tv_sec = ut->mtime_s; \
4761 tv[1].tv_usec = ut->mtime_ns / 1000; \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004762 time = tv; \
4763 } \
4764
4765#define UTIME_TO_UTIMBUF \
Georg Brandle1a7d9d2014-10-12 08:45:15 +02004766 struct utimbuf u; \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004767 struct utimbuf *time; \
Victor Stinner484df002014-10-09 13:52:31 +02004768 if (ut->now) \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004769 time = NULL; \
4770 else { \
Georg Brandle1a7d9d2014-10-12 08:45:15 +02004771 u.actime = ut->atime_s; \
4772 u.modtime = ut->mtime_s; \
4773 time = &u; \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004774 }
4775
4776#define UTIME_TO_TIME_T \
4777 time_t timet[2]; \
Georg Brandle1a7d9d2014-10-12 08:45:15 +02004778 time_t *time; \
Victor Stinner484df002014-10-09 13:52:31 +02004779 if (ut->now) \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004780 time = NULL; \
4781 else { \
Victor Stinner484df002014-10-09 13:52:31 +02004782 timet[0] = ut->atime_s; \
4783 timet[1] = ut->mtime_s; \
Georg Brandle1a7d9d2014-10-12 08:45:15 +02004784 time = timet; \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004785 } \
4786
4787
Victor Stinner528a9ab2015-09-03 21:30:26 +02004788#if defined(HAVE_FUTIMESAT) || defined(HAVE_UTIMENSAT)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004789
4790static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02004791utime_dir_fd(utime_t *ut, int dir_fd, const char *path, int follow_symlinks)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004792{
4793#ifdef HAVE_UTIMENSAT
4794 int flags = follow_symlinks ? 0 : AT_SYMLINK_NOFOLLOW;
4795 UTIME_TO_TIMESPEC;
4796 return utimensat(dir_fd, path, time, flags);
4797#elif defined(HAVE_FUTIMESAT)
4798 UTIME_TO_TIMEVAL;
4799 /*
4800 * follow_symlinks will never be false here;
4801 * we only allow !follow_symlinks and dir_fd together
4802 * if we have utimensat()
4803 */
4804 assert(follow_symlinks);
4805 return futimesat(dir_fd, path, time);
4806#endif
4807}
4808
Larry Hastings2f936352014-08-05 14:04:04 +10004809 #define FUTIMENSAT_DIR_FD_CONVERTER dir_fd_converter
4810#else
4811 #define FUTIMENSAT_DIR_FD_CONVERTER dir_fd_unavailable
Larry Hastings9cf065c2012-06-22 16:30:09 -07004812#endif
4813
Victor Stinner528a9ab2015-09-03 21:30:26 +02004814#if defined(HAVE_FUTIMES) || defined(HAVE_FUTIMENS)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004815
4816static int
Victor Stinner484df002014-10-09 13:52:31 +02004817utime_fd(utime_t *ut, int fd)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004818{
4819#ifdef HAVE_FUTIMENS
4820 UTIME_TO_TIMESPEC;
4821 return futimens(fd, time);
4822#else
4823 UTIME_TO_TIMEVAL;
4824 return futimes(fd, time);
4825#endif
4826}
4827
Larry Hastings2f936352014-08-05 14:04:04 +10004828 #define PATH_UTIME_HAVE_FD 1
4829#else
4830 #define PATH_UTIME_HAVE_FD 0
Larry Hastings9cf065c2012-06-22 16:30:09 -07004831#endif
4832
Victor Stinner5ebae872015-09-22 01:29:33 +02004833#if defined(HAVE_UTIMENSAT) || defined(HAVE_LUTIMES)
4834# define UTIME_HAVE_NOFOLLOW_SYMLINKS
4835#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07004836
Victor Stinner4552ced2015-09-21 22:37:15 +02004837#ifdef UTIME_HAVE_NOFOLLOW_SYMLINKS
Larry Hastings9cf065c2012-06-22 16:30:09 -07004838
4839static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02004840utime_nofollow_symlinks(utime_t *ut, const char *path)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004841{
4842#ifdef HAVE_UTIMENSAT
4843 UTIME_TO_TIMESPEC;
4844 return utimensat(DEFAULT_DIR_FD, path, time, AT_SYMLINK_NOFOLLOW);
4845#else
4846 UTIME_TO_TIMEVAL;
4847 return lutimes(path, time);
4848#endif
4849}
4850
4851#endif
4852
4853#ifndef MS_WINDOWS
4854
4855static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02004856utime_default(utime_t *ut, const char *path)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004857{
4858#ifdef HAVE_UTIMENSAT
4859 UTIME_TO_TIMESPEC;
4860 return utimensat(DEFAULT_DIR_FD, path, time, 0);
4861#elif defined(HAVE_UTIMES)
4862 UTIME_TO_TIMEVAL;
4863 return utimes(path, time);
4864#elif defined(HAVE_UTIME_H)
4865 UTIME_TO_UTIMBUF;
4866 return utime(path, time);
4867#else
4868 UTIME_TO_TIME_T;
4869 return utime(path, time);
4870#endif
4871}
4872
4873#endif
4874
Larry Hastings76ad59b2012-05-03 00:30:07 -07004875static int
Victor Stinner1c2fa782020-05-10 11:05:29 +02004876split_py_long_to_s_and_ns(PyObject *module, PyObject *py_long, time_t *s, long *ns)
Larry Hastings76ad59b2012-05-03 00:30:07 -07004877{
4878 int result = 0;
Benjamin Petersonfbd85a02012-05-04 11:06:09 -04004879 PyObject *divmod;
Victor Stinner1c2fa782020-05-10 11:05:29 +02004880 divmod = PyNumber_Divmod(py_long, get_posix_state(module)->billion);
Larry Hastings76ad59b2012-05-03 00:30:07 -07004881 if (!divmod)
4882 goto exit;
Oren Milman0bd1a2d2018-09-12 22:14:35 +03004883 if (!PyTuple_Check(divmod) || PyTuple_GET_SIZE(divmod) != 2) {
4884 PyErr_Format(PyExc_TypeError,
4885 "%.200s.__divmod__() must return a 2-tuple, not %.200s",
Eddie Elizondob3966632019-11-05 07:16:14 -08004886 _PyType_Name(Py_TYPE(py_long)), _PyType_Name(Py_TYPE(divmod)));
Oren Milman0bd1a2d2018-09-12 22:14:35 +03004887 goto exit;
4888 }
Larry Hastings76ad59b2012-05-03 00:30:07 -07004889 *s = _PyLong_AsTime_t(PyTuple_GET_ITEM(divmod, 0));
4890 if ((*s == -1) && PyErr_Occurred())
4891 goto exit;
4892 *ns = PyLong_AsLong(PyTuple_GET_ITEM(divmod, 1));
Benjamin Peterson35a8f0d2012-05-04 01:10:59 -04004893 if ((*ns == -1) && PyErr_Occurred())
Larry Hastings76ad59b2012-05-03 00:30:07 -07004894 goto exit;
4895
4896 result = 1;
4897exit:
4898 Py_XDECREF(divmod);
4899 return result;
4900}
4901
Larry Hastings2f936352014-08-05 14:04:04 +10004902
4903/*[clinic input]
4904os.utime
4905
4906 path: path_t(allow_fd='PATH_UTIME_HAVE_FD')
Serhiy Storchaka279f4462019-09-14 12:24:05 +03004907 times: object = None
Larry Hastings2f936352014-08-05 14:04:04 +10004908 *
4909 ns: object = NULL
4910 dir_fd: dir_fd(requires='futimensat') = None
4911 follow_symlinks: bool=True
4912
Martin Panter0ff89092015-09-09 01:56:53 +00004913# "utime(path, times=None, *[, ns], dir_fd=None, follow_symlinks=True)\n\
Larry Hastings2f936352014-08-05 14:04:04 +10004914
4915Set the access and modified time of path.
4916
4917path may always be specified as a string.
4918On some platforms, path may also be specified as an open file descriptor.
4919 If this functionality is unavailable, using it raises an exception.
4920
4921If times is not None, it must be a tuple (atime, mtime);
4922 atime and mtime should be expressed as float seconds since the epoch.
Martin Panter0ff89092015-09-09 01:56:53 +00004923If ns is specified, it must be a tuple (atime_ns, mtime_ns);
Larry Hastings2f936352014-08-05 14:04:04 +10004924 atime_ns and mtime_ns should be expressed as integer nanoseconds
4925 since the epoch.
Martin Panter0ff89092015-09-09 01:56:53 +00004926If times is None and ns is unspecified, utime uses the current time.
Larry Hastings2f936352014-08-05 14:04:04 +10004927Specifying tuples for both times and ns is an error.
4928
4929If dir_fd is not None, it should be a file descriptor open to a directory,
4930 and path should be relative; path will then be relative to that directory.
4931If follow_symlinks is False, and the last element of the path is a symbolic
4932 link, utime will modify the symbolic link itself instead of the file the
4933 link points to.
4934It is an error to use dir_fd or follow_symlinks when specifying path
4935 as an open file descriptor.
4936dir_fd and follow_symlinks may not be available on your platform.
4937 If they are unavailable, using them will raise a NotImplementedError.
4938
4939[clinic start generated code]*/
4940
Larry Hastings2f936352014-08-05 14:04:04 +10004941static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004942os_utime_impl(PyObject *module, path_t *path, PyObject *times, PyObject *ns,
4943 int dir_fd, int follow_symlinks)
Serhiy Storchaka279f4462019-09-14 12:24:05 +03004944/*[clinic end generated code: output=cfcac69d027b82cf input=2fbd62a2f228f8f4]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004945{
Larry Hastings9cf065c2012-06-22 16:30:09 -07004946#ifdef MS_WINDOWS
4947 HANDLE hFile;
4948 FILETIME atime, mtime;
4949#else
4950 int result;
4951#endif
Larry Hastings76ad59b2012-05-03 00:30:07 -07004952
Larry Hastings2f936352014-08-05 14:04:04 +10004953 utime_t utime;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004954
Christian Heimesb3c87242013-08-01 00:08:16 +02004955 memset(&utime, 0, sizeof(utime_t));
Larry Hastings76ad59b2012-05-03 00:30:07 -07004956
Serhiy Storchaka279f4462019-09-14 12:24:05 +03004957 if (times != Py_None && ns) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07004958 PyErr_SetString(PyExc_ValueError,
4959 "utime: you may specify either 'times'"
4960 " or 'ns' but not both");
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004961 return NULL;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004962 }
4963
Serhiy Storchaka279f4462019-09-14 12:24:05 +03004964 if (times != Py_None) {
Antoine Pitroucf8a1e52013-04-17 22:06:44 +02004965 time_t a_sec, m_sec;
4966 long a_nsec, m_nsec;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004967 if (!PyTuple_CheckExact(times) || (PyTuple_Size(times) != 2)) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07004968 PyErr_SetString(PyExc_TypeError,
4969 "utime: 'times' must be either"
4970 " a tuple of two ints or None");
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004971 return NULL;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004972 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07004973 utime.now = 0;
Benjamin Petersonb399ab22012-05-04 01:31:13 -04004974 if (_PyTime_ObjectToTimespec(PyTuple_GET_ITEM(times, 0),
Victor Stinnerdca028b2015-03-30 01:02:57 +02004975 &a_sec, &a_nsec, _PyTime_ROUND_FLOOR) == -1 ||
Benjamin Petersonb399ab22012-05-04 01:31:13 -04004976 _PyTime_ObjectToTimespec(PyTuple_GET_ITEM(times, 1),
Victor Stinnerdca028b2015-03-30 01:02:57 +02004977 &m_sec, &m_nsec, _PyTime_ROUND_FLOOR) == -1) {
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004978 return NULL;
Larry Hastingsb3336402012-05-04 02:31:57 -07004979 }
Antoine Pitroucf8a1e52013-04-17 22:06:44 +02004980 utime.atime_s = a_sec;
4981 utime.atime_ns = a_nsec;
4982 utime.mtime_s = m_sec;
4983 utime.mtime_ns = m_nsec;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004984 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07004985 else if (ns) {
Larry Hastings76ad59b2012-05-03 00:30:07 -07004986 if (!PyTuple_CheckExact(ns) || (PyTuple_Size(ns) != 2)) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07004987 PyErr_SetString(PyExc_TypeError,
4988 "utime: 'ns' must be a tuple of two ints");
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004989 return NULL;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004990 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07004991 utime.now = 0;
Victor Stinner1c2fa782020-05-10 11:05:29 +02004992 if (!split_py_long_to_s_and_ns(module, PyTuple_GET_ITEM(ns, 0),
Larry Hastings9cf065c2012-06-22 16:30:09 -07004993 &utime.atime_s, &utime.atime_ns) ||
Victor Stinner1c2fa782020-05-10 11:05:29 +02004994 !split_py_long_to_s_and_ns(module, PyTuple_GET_ITEM(ns, 1),
Larry Hastings9cf065c2012-06-22 16:30:09 -07004995 &utime.mtime_s, &utime.mtime_ns)) {
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004996 return NULL;
Larry Hastingsb3336402012-05-04 02:31:57 -07004997 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07004998 }
4999 else {
5000 /* times and ns are both None/unspecified. use "now". */
5001 utime.now = 1;
Larry Hastings76ad59b2012-05-03 00:30:07 -07005002 }
5003
Victor Stinner4552ced2015-09-21 22:37:15 +02005004#if !defined(UTIME_HAVE_NOFOLLOW_SYMLINKS)
Larry Hastings9cf065c2012-06-22 16:30:09 -07005005 if (follow_symlinks_specified("utime", follow_symlinks))
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02005006 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07005007#endif
Benjamin Petersonb399ab22012-05-04 01:31:13 -04005008
Larry Hastings2f936352014-08-05 14:04:04 +10005009 if (path_and_dir_fd_invalid("utime", path, dir_fd) ||
5010 dir_fd_and_fd_invalid("utime", dir_fd, path->fd) ||
5011 fd_and_follow_symlinks_invalid("utime", path->fd, follow_symlinks))
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02005012 return NULL;
Larry Hastings76ad59b2012-05-03 00:30:07 -07005013
Larry Hastings9cf065c2012-06-22 16:30:09 -07005014#if !defined(HAVE_UTIMENSAT)
5015 if ((dir_fd != DEFAULT_DIR_FD) && (!follow_symlinks)) {
Georg Brandl969288e2012-06-26 09:25:44 +02005016 PyErr_SetString(PyExc_ValueError,
Larry Hastings9cf065c2012-06-22 16:30:09 -07005017 "utime: cannot use dir_fd and follow_symlinks "
5018 "together on this platform");
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02005019 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07005020 }
5021#endif
Larry Hastings76ad59b2012-05-03 00:30:07 -07005022
Saiyang Gou7514f4f2020-02-12 23:47:42 -08005023 if (PySys_Audit("os.utime", "OOOi", path->object, times, ns ? ns : Py_None,
5024 dir_fd == DEFAULT_DIR_FD ? -1 : dir_fd) < 0) {
5025 return NULL;
5026 }
5027
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00005028#ifdef MS_WINDOWS
Larry Hastings9cf065c2012-06-22 16:30:09 -07005029 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07005030 hFile = CreateFileW(path->wide, FILE_WRITE_ATTRIBUTES, 0,
5031 NULL, OPEN_EXISTING,
5032 FILE_FLAG_BACKUP_SEMANTICS, NULL);
Larry Hastings9cf065c2012-06-22 16:30:09 -07005033 Py_END_ALLOW_THREADS
5034 if (hFile == INVALID_HANDLE_VALUE) {
Larry Hastings2f936352014-08-05 14:04:04 +10005035 path_error(path);
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02005036 return NULL;
Larry Hastingsb3336402012-05-04 02:31:57 -07005037 }
5038
Larry Hastings9cf065c2012-06-22 16:30:09 -07005039 if (utime.now) {
Antoine Pitrou91a7af32013-11-23 15:23:26 +01005040 GetSystemTimeAsFileTime(&mtime);
5041 atime = mtime;
Victor Stinner8c62be82010-05-06 00:08:46 +00005042 }
Victor Stinner8c62be82010-05-06 00:08:46 +00005043 else {
Steve Dowerbf1f3762015-02-21 15:26:02 -08005044 _Py_time_t_to_FILE_TIME(utime.atime_s, utime.atime_ns, &atime);
5045 _Py_time_t_to_FILE_TIME(utime.mtime_s, utime.mtime_ns, &mtime);
Victor Stinner8c62be82010-05-06 00:08:46 +00005046 }
5047 if (!SetFileTime(hFile, NULL, &atime, &mtime)) {
5048 /* Avoid putting the file name into the error here,
5049 as that may confuse the user into believing that
5050 something is wrong with the file, when it also
5051 could be the time stamp that gives a problem. */
Victor Stinnerb024e842012-10-31 22:24:06 +01005052 PyErr_SetFromWindowsErr(0);
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02005053 CloseHandle(hFile);
5054 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00005055 }
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02005056 CloseHandle(hFile);
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00005057#else /* MS_WINDOWS */
Larry Hastings9cf065c2012-06-22 16:30:09 -07005058 Py_BEGIN_ALLOW_THREADS
Guido van Rossum1ff6cb41991-04-08 20:59:13 +00005059
Victor Stinner4552ced2015-09-21 22:37:15 +02005060#ifdef UTIME_HAVE_NOFOLLOW_SYMLINKS
Larry Hastings9cf065c2012-06-22 16:30:09 -07005061 if ((!follow_symlinks) && (dir_fd == DEFAULT_DIR_FD))
Larry Hastings2f936352014-08-05 14:04:04 +10005062 result = utime_nofollow_symlinks(&utime, path->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07005063 else
Larry Hastings9e3e70b2011-09-08 19:29:07 -07005064#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07005065
Victor Stinner528a9ab2015-09-03 21:30:26 +02005066#if defined(HAVE_FUTIMESAT) || defined(HAVE_UTIMENSAT)
Larry Hastings9cf065c2012-06-22 16:30:09 -07005067 if ((dir_fd != DEFAULT_DIR_FD) || (!follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10005068 result = utime_dir_fd(&utime, dir_fd, path->narrow, follow_symlinks);
Larry Hastings9cf065c2012-06-22 16:30:09 -07005069 else
5070#endif
5071
Victor Stinner528a9ab2015-09-03 21:30:26 +02005072#if defined(HAVE_FUTIMES) || defined(HAVE_FUTIMENS)
Larry Hastings2f936352014-08-05 14:04:04 +10005073 if (path->fd != -1)
5074 result = utime_fd(&utime, path->fd);
Larry Hastings9cf065c2012-06-22 16:30:09 -07005075 else
5076#endif
5077
Larry Hastings2f936352014-08-05 14:04:04 +10005078 result = utime_default(&utime, path->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07005079
5080 Py_END_ALLOW_THREADS
5081
5082 if (result < 0) {
5083 /* see previous comment about not putting filename in error here */
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02005084 posix_error();
5085 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00005086 }
Larry Hastings76ad59b2012-05-03 00:30:07 -07005087
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00005088#endif /* MS_WINDOWS */
Larry Hastings9cf065c2012-06-22 16:30:09 -07005089
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02005090 Py_RETURN_NONE;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00005091}
5092
Guido van Rossum3b066191991-06-04 19:40:25 +00005093/* Process operations */
Guido van Rossum85e3b011991-06-03 12:42:10 +00005094
Larry Hastings2f936352014-08-05 14:04:04 +10005095
5096/*[clinic input]
5097os._exit
5098
5099 status: int
5100
5101Exit to the system with specified status, without normal exit processing.
5102[clinic start generated code]*/
5103
Larry Hastings2f936352014-08-05 14:04:04 +10005104static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005105os__exit_impl(PyObject *module, int status)
5106/*[clinic end generated code: output=116e52d9c2260d54 input=5e6d57556b0c4a62]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005107{
5108 _exit(status);
Victor Stinner8c62be82010-05-06 00:08:46 +00005109 return NULL; /* Make gcc -Wall happy */
Guido van Rossum85e3b011991-06-03 12:42:10 +00005110}
5111
Steve Dowercc16be82016-09-08 10:35:16 -07005112#if defined(HAVE_WEXECV) || defined(HAVE_WSPAWNV)
5113#define EXECV_CHAR wchar_t
5114#else
5115#define EXECV_CHAR char
5116#endif
5117
pxinwrf2d7ac72019-05-21 18:46:37 +08005118#if defined(HAVE_EXECV) || defined(HAVE_SPAWNV) || defined(HAVE_RTPSPAWN)
Martin v. Löwis114619e2002-10-07 06:44:21 +00005119static void
Steve Dowercc16be82016-09-08 10:35:16 -07005120free_string_array(EXECV_CHAR **array, Py_ssize_t count)
Martin v. Löwis114619e2002-10-07 06:44:21 +00005121{
Victor Stinner8c62be82010-05-06 00:08:46 +00005122 Py_ssize_t i;
5123 for (i = 0; i < count; i++)
5124 PyMem_Free(array[i]);
5125 PyMem_DEL(array);
Martin v. Löwis114619e2002-10-07 06:44:21 +00005126}
Martin v. Löwis011e8422009-05-05 04:43:17 +00005127
Berker Peksag81816462016-09-15 20:19:47 +03005128static int
5129fsconvert_strdup(PyObject *o, EXECV_CHAR **out)
Martin v. Löwis011e8422009-05-05 04:43:17 +00005130{
Victor Stinner8c62be82010-05-06 00:08:46 +00005131 Py_ssize_t size;
Berker Peksag81816462016-09-15 20:19:47 +03005132 PyObject *ub;
5133 int result = 0;
Steve Dowercc16be82016-09-08 10:35:16 -07005134#if defined(HAVE_WEXECV) || defined(HAVE_WSPAWNV)
Berker Peksag81816462016-09-15 20:19:47 +03005135 if (!PyUnicode_FSDecoder(o, &ub))
Steve Dowercc16be82016-09-08 10:35:16 -07005136 return 0;
Berker Peksag81816462016-09-15 20:19:47 +03005137 *out = PyUnicode_AsWideCharString(ub, &size);
5138 if (*out)
5139 result = 1;
Steve Dowercc16be82016-09-08 10:35:16 -07005140#else
Berker Peksag81816462016-09-15 20:19:47 +03005141 if (!PyUnicode_FSConverter(o, &ub))
Victor Stinner8c62be82010-05-06 00:08:46 +00005142 return 0;
Berker Peksag81816462016-09-15 20:19:47 +03005143 size = PyBytes_GET_SIZE(ub);
5144 *out = PyMem_Malloc(size + 1);
5145 if (*out) {
5146 memcpy(*out, PyBytes_AS_STRING(ub), size + 1);
5147 result = 1;
5148 } else
Victor Stinner50abf222013-11-07 23:56:10 +01005149 PyErr_NoMemory();
Steve Dowercc16be82016-09-08 10:35:16 -07005150#endif
Berker Peksag81816462016-09-15 20:19:47 +03005151 Py_DECREF(ub);
5152 return result;
Martin v. Löwis011e8422009-05-05 04:43:17 +00005153}
Martin v. Löwis114619e2002-10-07 06:44:21 +00005154#endif
5155
pxinwrf2d7ac72019-05-21 18:46:37 +08005156#if defined(HAVE_EXECV) || defined (HAVE_FEXECVE) || defined(HAVE_RTPSPAWN)
Steve Dowercc16be82016-09-08 10:35:16 -07005157static EXECV_CHAR**
Victor Stinner13bb71c2010-04-23 21:41:56 +00005158parse_envlist(PyObject* env, Py_ssize_t *envc_ptr)
5159{
Victor Stinner8c62be82010-05-06 00:08:46 +00005160 Py_ssize_t i, pos, envc;
5161 PyObject *keys=NULL, *vals=NULL;
Berker Peksag81816462016-09-15 20:19:47 +03005162 PyObject *key, *val, *key2, *val2, *keyval;
Steve Dowercc16be82016-09-08 10:35:16 -07005163 EXECV_CHAR **envlist;
Victor Stinner13bb71c2010-04-23 21:41:56 +00005164
Victor Stinner8c62be82010-05-06 00:08:46 +00005165 i = PyMapping_Size(env);
5166 if (i < 0)
5167 return NULL;
Steve Dowercc16be82016-09-08 10:35:16 -07005168 envlist = PyMem_NEW(EXECV_CHAR *, i + 1);
Victor Stinner8c62be82010-05-06 00:08:46 +00005169 if (envlist == NULL) {
5170 PyErr_NoMemory();
5171 return NULL;
5172 }
5173 envc = 0;
5174 keys = PyMapping_Keys(env);
Victor Stinnerb0314272013-11-14 21:37:05 +01005175 if (!keys)
5176 goto error;
Victor Stinner8c62be82010-05-06 00:08:46 +00005177 vals = PyMapping_Values(env);
Victor Stinnerb0314272013-11-14 21:37:05 +01005178 if (!vals)
Victor Stinner8c62be82010-05-06 00:08:46 +00005179 goto error;
5180 if (!PyList_Check(keys) || !PyList_Check(vals)) {
5181 PyErr_Format(PyExc_TypeError,
5182 "env.keys() or env.values() is not a list");
5183 goto error;
5184 }
Victor Stinner13bb71c2010-04-23 21:41:56 +00005185
Victor Stinner8c62be82010-05-06 00:08:46 +00005186 for (pos = 0; pos < i; pos++) {
5187 key = PyList_GetItem(keys, pos);
5188 val = PyList_GetItem(vals, pos);
5189 if (!key || !val)
5190 goto error;
Victor Stinner13bb71c2010-04-23 21:41:56 +00005191
Berker Peksag81816462016-09-15 20:19:47 +03005192#if defined(HAVE_WEXECV) || defined(HAVE_WSPAWNV)
5193 if (!PyUnicode_FSDecoder(key, &key2))
5194 goto error;
5195 if (!PyUnicode_FSDecoder(val, &val2)) {
5196 Py_DECREF(key2);
5197 goto error;
5198 }
Serhiy Storchaka77703942017-06-25 07:33:01 +03005199 /* Search from index 1 because on Windows starting '=' is allowed for
5200 defining hidden environment variables. */
5201 if (PyUnicode_GET_LENGTH(key2) == 0 ||
5202 PyUnicode_FindChar(key2, '=', 1, PyUnicode_GET_LENGTH(key2), 1) != -1)
5203 {
5204 PyErr_SetString(PyExc_ValueError, "illegal environment variable name");
Eric N. Vander Weelea7874c72017-06-26 21:35:20 -04005205 Py_DECREF(key2);
5206 Py_DECREF(val2);
Serhiy Storchaka77703942017-06-25 07:33:01 +03005207 goto error;
5208 }
Berker Peksag81816462016-09-15 20:19:47 +03005209 keyval = PyUnicode_FromFormat("%U=%U", key2, val2);
5210#else
5211 if (!PyUnicode_FSConverter(key, &key2))
5212 goto error;
5213 if (!PyUnicode_FSConverter(val, &val2)) {
5214 Py_DECREF(key2);
5215 goto error;
5216 }
Serhiy Storchaka77703942017-06-25 07:33:01 +03005217 if (PyBytes_GET_SIZE(key2) == 0 ||
5218 strchr(PyBytes_AS_STRING(key2) + 1, '=') != NULL)
5219 {
5220 PyErr_SetString(PyExc_ValueError, "illegal environment variable name");
Eric N. Vander Weelea7874c72017-06-26 21:35:20 -04005221 Py_DECREF(key2);
5222 Py_DECREF(val2);
Serhiy Storchaka77703942017-06-25 07:33:01 +03005223 goto error;
5224 }
Berker Peksag81816462016-09-15 20:19:47 +03005225 keyval = PyBytes_FromFormat("%s=%s", PyBytes_AS_STRING(key2),
5226 PyBytes_AS_STRING(val2));
5227#endif
5228 Py_DECREF(key2);
5229 Py_DECREF(val2);
Steve Dowercc16be82016-09-08 10:35:16 -07005230 if (!keyval)
Victor Stinner8c62be82010-05-06 00:08:46 +00005231 goto error;
Steve Dowercc16be82016-09-08 10:35:16 -07005232
5233 if (!fsconvert_strdup(keyval, &envlist[envc++])) {
5234 Py_DECREF(keyval);
Victor Stinner8c62be82010-05-06 00:08:46 +00005235 goto error;
5236 }
Berker Peksag81816462016-09-15 20:19:47 +03005237
Steve Dowercc16be82016-09-08 10:35:16 -07005238 Py_DECREF(keyval);
Victor Stinner8c62be82010-05-06 00:08:46 +00005239 }
5240 Py_DECREF(vals);
5241 Py_DECREF(keys);
Victor Stinner13bb71c2010-04-23 21:41:56 +00005242
Victor Stinner8c62be82010-05-06 00:08:46 +00005243 envlist[envc] = 0;
5244 *envc_ptr = envc;
5245 return envlist;
Victor Stinner13bb71c2010-04-23 21:41:56 +00005246
5247error:
Victor Stinner8c62be82010-05-06 00:08:46 +00005248 Py_XDECREF(keys);
5249 Py_XDECREF(vals);
Steve Dowercc16be82016-09-08 10:35:16 -07005250 free_string_array(envlist, envc);
Victor Stinner8c62be82010-05-06 00:08:46 +00005251 return NULL;
Victor Stinner13bb71c2010-04-23 21:41:56 +00005252}
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00005253
Steve Dowercc16be82016-09-08 10:35:16 -07005254static EXECV_CHAR**
Ross Lagerwall7807c352011-03-17 20:20:30 +02005255parse_arglist(PyObject* argv, Py_ssize_t *argc)
5256{
5257 int i;
Steve Dowercc16be82016-09-08 10:35:16 -07005258 EXECV_CHAR **argvlist = PyMem_NEW(EXECV_CHAR *, *argc+1);
Ross Lagerwall7807c352011-03-17 20:20:30 +02005259 if (argvlist == NULL) {
5260 PyErr_NoMemory();
5261 return NULL;
5262 }
5263 for (i = 0; i < *argc; i++) {
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02005264 PyObject* item = PySequence_ITEM(argv, i);
5265 if (item == NULL)
5266 goto fail;
5267 if (!fsconvert_strdup(item, &argvlist[i])) {
5268 Py_DECREF(item);
Ross Lagerwall7807c352011-03-17 20:20:30 +02005269 goto fail;
5270 }
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02005271 Py_DECREF(item);
Ross Lagerwall7807c352011-03-17 20:20:30 +02005272 }
5273 argvlist[*argc] = NULL;
5274 return argvlist;
5275fail:
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02005276 *argc = i;
Ross Lagerwall7807c352011-03-17 20:20:30 +02005277 free_string_array(argvlist, *argc);
5278 return NULL;
5279}
Steve Dowercc16be82016-09-08 10:35:16 -07005280
Ross Lagerwall7807c352011-03-17 20:20:30 +02005281#endif
5282
Larry Hastings2f936352014-08-05 14:04:04 +10005283
Ross Lagerwall7807c352011-03-17 20:20:30 +02005284#ifdef HAVE_EXECV
Larry Hastings2f936352014-08-05 14:04:04 +10005285/*[clinic input]
5286os.execv
5287
Steve Dowercc16be82016-09-08 10:35:16 -07005288 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +10005289 Path of executable file.
5290 argv: object
5291 Tuple or list of strings.
5292 /
5293
5294Execute an executable path with arguments, replacing current process.
5295[clinic start generated code]*/
5296
Larry Hastings2f936352014-08-05 14:04:04 +10005297static PyObject *
Steve Dowercc16be82016-09-08 10:35:16 -07005298os_execv_impl(PyObject *module, path_t *path, PyObject *argv)
5299/*[clinic end generated code: output=3b52fec34cd0dafd input=9bac31efae07dac7]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005300{
Steve Dowercc16be82016-09-08 10:35:16 -07005301 EXECV_CHAR **argvlist;
Ross Lagerwall7807c352011-03-17 20:20:30 +02005302 Py_ssize_t argc;
5303
5304 /* execv has two arguments: (path, argv), where
5305 argv is a list or tuple of strings. */
5306
Ross Lagerwall7807c352011-03-17 20:20:30 +02005307 if (!PyList_Check(argv) && !PyTuple_Check(argv)) {
5308 PyErr_SetString(PyExc_TypeError,
5309 "execv() arg 2 must be a tuple or list");
Ross Lagerwall7807c352011-03-17 20:20:30 +02005310 return NULL;
5311 }
5312 argc = PySequence_Size(argv);
5313 if (argc < 1) {
5314 PyErr_SetString(PyExc_ValueError, "execv() arg 2 must not be empty");
Ross Lagerwall7807c352011-03-17 20:20:30 +02005315 return NULL;
5316 }
5317
5318 argvlist = parse_arglist(argv, &argc);
5319 if (argvlist == NULL) {
Ross Lagerwall7807c352011-03-17 20:20:30 +02005320 return NULL;
5321 }
Steve Dowerbce26262016-11-19 19:17:26 -08005322 if (!argvlist[0][0]) {
5323 PyErr_SetString(PyExc_ValueError,
5324 "execv() arg 2 first element cannot be empty");
5325 free_string_array(argvlist, argc);
5326 return NULL;
5327 }
Ross Lagerwall7807c352011-03-17 20:20:30 +02005328
Saiyang Gou7514f4f2020-02-12 23:47:42 -08005329 if (PySys_Audit("os.exec", "OOO", path->object, argv, Py_None) < 0) {
Saiyang Gou95f60012020-02-04 16:15:00 -08005330 free_string_array(argvlist, argc);
5331 return NULL;
5332 }
5333
Steve Dowerbce26262016-11-19 19:17:26 -08005334 _Py_BEGIN_SUPPRESS_IPH
Steve Dowercc16be82016-09-08 10:35:16 -07005335#ifdef HAVE_WEXECV
5336 _wexecv(path->wide, argvlist);
5337#else
5338 execv(path->narrow, argvlist);
5339#endif
Steve Dowerbce26262016-11-19 19:17:26 -08005340 _Py_END_SUPPRESS_IPH
Ross Lagerwall7807c352011-03-17 20:20:30 +02005341
5342 /* If we get here it's definitely an error */
5343
5344 free_string_array(argvlist, argc);
Ross Lagerwall7807c352011-03-17 20:20:30 +02005345 return posix_error();
5346}
5347
Larry Hastings2f936352014-08-05 14:04:04 +10005348
5349/*[clinic input]
5350os.execve
5351
5352 path: path_t(allow_fd='PATH_HAVE_FEXECVE')
5353 Path of executable file.
5354 argv: object
5355 Tuple or list of strings.
5356 env: object
5357 Dictionary of strings mapping to strings.
5358
5359Execute an executable path with arguments, replacing current process.
5360[clinic start generated code]*/
5361
Larry Hastings2f936352014-08-05 14:04:04 +10005362static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005363os_execve_impl(PyObject *module, path_t *path, PyObject *argv, PyObject *env)
5364/*[clinic end generated code: output=ff9fa8e4da8bde58 input=626804fa092606d9]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005365{
Steve Dowercc16be82016-09-08 10:35:16 -07005366 EXECV_CHAR **argvlist = NULL;
5367 EXECV_CHAR **envlist;
Ross Lagerwall7807c352011-03-17 20:20:30 +02005368 Py_ssize_t argc, envc;
Guido van Rossumc6dcc9f1993-11-05 10:15:19 +00005369
Victor Stinner8c62be82010-05-06 00:08:46 +00005370 /* execve has three arguments: (path, argv, env), where
5371 argv is a list or tuple of strings and env is a dictionary
5372 like posix.environ. */
Guido van Rossumc6dcc9f1993-11-05 10:15:19 +00005373
Ross Lagerwall7807c352011-03-17 20:20:30 +02005374 if (!PyList_Check(argv) && !PyTuple_Check(argv)) {
Victor Stinner8c62be82010-05-06 00:08:46 +00005375 PyErr_SetString(PyExc_TypeError,
Larry Hastings9cf065c2012-06-22 16:30:09 -07005376 "execve: argv must be a tuple or list");
Saiyang Gou95f60012020-02-04 16:15:00 -08005377 goto fail_0;
Victor Stinner8c62be82010-05-06 00:08:46 +00005378 }
Ross Lagerwall7807c352011-03-17 20:20:30 +02005379 argc = PySequence_Size(argv);
Steve Dowerbce26262016-11-19 19:17:26 -08005380 if (argc < 1) {
5381 PyErr_SetString(PyExc_ValueError, "execve: argv must not be empty");
5382 return NULL;
5383 }
5384
Victor Stinner8c62be82010-05-06 00:08:46 +00005385 if (!PyMapping_Check(env)) {
5386 PyErr_SetString(PyExc_TypeError,
Larry Hastings9cf065c2012-06-22 16:30:09 -07005387 "execve: environment must be a mapping object");
Saiyang Gou95f60012020-02-04 16:15:00 -08005388 goto fail_0;
Victor Stinner8c62be82010-05-06 00:08:46 +00005389 }
Guido van Rossumc6dcc9f1993-11-05 10:15:19 +00005390
Ross Lagerwall7807c352011-03-17 20:20:30 +02005391 argvlist = parse_arglist(argv, &argc);
Victor Stinner8c62be82010-05-06 00:08:46 +00005392 if (argvlist == NULL) {
Saiyang Gou95f60012020-02-04 16:15:00 -08005393 goto fail_0;
Victor Stinner8c62be82010-05-06 00:08:46 +00005394 }
Steve Dowerbce26262016-11-19 19:17:26 -08005395 if (!argvlist[0][0]) {
5396 PyErr_SetString(PyExc_ValueError,
5397 "execve: argv first element cannot be empty");
Saiyang Gou95f60012020-02-04 16:15:00 -08005398 goto fail_0;
Steve Dowerbce26262016-11-19 19:17:26 -08005399 }
Guido van Rossumc6dcc9f1993-11-05 10:15:19 +00005400
Victor Stinner8c62be82010-05-06 00:08:46 +00005401 envlist = parse_envlist(env, &envc);
5402 if (envlist == NULL)
Saiyang Gou95f60012020-02-04 16:15:00 -08005403 goto fail_0;
5404
Saiyang Gou7514f4f2020-02-12 23:47:42 -08005405 if (PySys_Audit("os.exec", "OOO", path->object, argv, env) < 0) {
Saiyang Gou95f60012020-02-04 16:15:00 -08005406 goto fail_1;
5407 }
Ross Lagerwall7807c352011-03-17 20:20:30 +02005408
Steve Dowerbce26262016-11-19 19:17:26 -08005409 _Py_BEGIN_SUPPRESS_IPH
Larry Hastings9cf065c2012-06-22 16:30:09 -07005410#ifdef HAVE_FEXECVE
Larry Hastings2f936352014-08-05 14:04:04 +10005411 if (path->fd > -1)
5412 fexecve(path->fd, argvlist, envlist);
Larry Hastings9cf065c2012-06-22 16:30:09 -07005413 else
5414#endif
Steve Dowercc16be82016-09-08 10:35:16 -07005415#ifdef HAVE_WEXECV
5416 _wexecve(path->wide, argvlist, envlist);
5417#else
Larry Hastings2f936352014-08-05 14:04:04 +10005418 execve(path->narrow, argvlist, envlist);
Steve Dowercc16be82016-09-08 10:35:16 -07005419#endif
Steve Dowerbce26262016-11-19 19:17:26 -08005420 _Py_END_SUPPRESS_IPH
Ross Lagerwall7807c352011-03-17 20:20:30 +02005421
5422 /* If we get here it's definitely an error */
5423
Alexey Izbyshev83460312018-10-20 03:28:22 +03005424 posix_path_error(path);
Saiyang Gou95f60012020-02-04 16:15:00 -08005425 fail_1:
Steve Dowercc16be82016-09-08 10:35:16 -07005426 free_string_array(envlist, envc);
Saiyang Gou95f60012020-02-04 16:15:00 -08005427 fail_0:
Larry Hastings9cf065c2012-06-22 16:30:09 -07005428 if (argvlist)
5429 free_string_array(argvlist, argc);
Ross Lagerwall7807c352011-03-17 20:20:30 +02005430 return NULL;
5431}
Steve Dowercc16be82016-09-08 10:35:16 -07005432
Larry Hastings9cf065c2012-06-22 16:30:09 -07005433#endif /* HAVE_EXECV */
5434
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005435#ifdef HAVE_POSIX_SPAWN
5436
5437enum posix_spawn_file_actions_identifier {
5438 POSIX_SPAWN_OPEN,
5439 POSIX_SPAWN_CLOSE,
5440 POSIX_SPAWN_DUP2
5441};
5442
William Orr81574b82018-10-01 22:19:56 -07005443#if defined(HAVE_SCHED_SETPARAM) || defined(HAVE_SCHED_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDPARAM)
Serhiy Storchakaef347532018-05-01 16:45:04 +03005444static int
Victor Stinner1c2fa782020-05-10 11:05:29 +02005445convert_sched_param(PyObject *module, PyObject *param, struct sched_param *res);
William Orr81574b82018-10-01 22:19:56 -07005446#endif
Pablo Galindo254a4662018-09-07 16:44:24 +01005447
5448static int
Victor Stinner1c2fa782020-05-10 11:05:29 +02005449parse_posix_spawn_flags(PyObject *module, const char *func_name, PyObject *setpgroup,
Victor Stinner325e4ba2019-02-01 15:47:24 +01005450 int resetids, int setsid, PyObject *setsigmask,
Pablo Galindo254a4662018-09-07 16:44:24 +01005451 PyObject *setsigdef, PyObject *scheduler,
5452 posix_spawnattr_t *attrp)
5453{
5454 long all_flags = 0;
5455
5456 errno = posix_spawnattr_init(attrp);
5457 if (errno) {
5458 posix_error();
5459 return -1;
5460 }
5461
5462 if (setpgroup) {
5463 pid_t pgid = PyLong_AsPid(setpgroup);
5464 if (pgid == (pid_t)-1 && PyErr_Occurred()) {
5465 goto fail;
5466 }
5467 errno = posix_spawnattr_setpgroup(attrp, pgid);
5468 if (errno) {
5469 posix_error();
5470 goto fail;
5471 }
5472 all_flags |= POSIX_SPAWN_SETPGROUP;
5473 }
5474
5475 if (resetids) {
5476 all_flags |= POSIX_SPAWN_RESETIDS;
5477 }
5478
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005479 if (setsid) {
5480#ifdef POSIX_SPAWN_SETSID
5481 all_flags |= POSIX_SPAWN_SETSID;
5482#elif defined(POSIX_SPAWN_SETSID_NP)
5483 all_flags |= POSIX_SPAWN_SETSID_NP;
5484#else
5485 argument_unavailable_error(func_name, "setsid");
5486 return -1;
5487#endif
5488 }
5489
Pablo Galindo254a4662018-09-07 16:44:24 +01005490 if (setsigmask) {
5491 sigset_t set;
5492 if (!_Py_Sigset_Converter(setsigmask, &set)) {
5493 goto fail;
5494 }
5495 errno = posix_spawnattr_setsigmask(attrp, &set);
5496 if (errno) {
5497 posix_error();
5498 goto fail;
5499 }
5500 all_flags |= POSIX_SPAWN_SETSIGMASK;
5501 }
5502
5503 if (setsigdef) {
5504 sigset_t set;
5505 if (!_Py_Sigset_Converter(setsigdef, &set)) {
5506 goto fail;
5507 }
5508 errno = posix_spawnattr_setsigdefault(attrp, &set);
5509 if (errno) {
5510 posix_error();
5511 goto fail;
5512 }
5513 all_flags |= POSIX_SPAWN_SETSIGDEF;
5514 }
5515
5516 if (scheduler) {
5517#ifdef POSIX_SPAWN_SETSCHEDULER
5518 PyObject *py_schedpolicy;
Victor Stinner1c2fa782020-05-10 11:05:29 +02005519 PyObject *schedparam_obj;
Pablo Galindo254a4662018-09-07 16:44:24 +01005520 struct sched_param schedparam;
5521
Victor Stinner1c2fa782020-05-10 11:05:29 +02005522 if (!PyArg_ParseTuple(scheduler, "OO"
Pablo Galindo254a4662018-09-07 16:44:24 +01005523 ";A scheduler tuple must have two elements",
Victor Stinner1c2fa782020-05-10 11:05:29 +02005524 &py_schedpolicy, &schedparam_obj)) {
5525 goto fail;
5526 }
5527 if (!convert_sched_param(module, schedparam_obj, &schedparam)) {
Pablo Galindo254a4662018-09-07 16:44:24 +01005528 goto fail;
5529 }
5530 if (py_schedpolicy != Py_None) {
5531 int schedpolicy = _PyLong_AsInt(py_schedpolicy);
5532
5533 if (schedpolicy == -1 && PyErr_Occurred()) {
5534 goto fail;
5535 }
5536 errno = posix_spawnattr_setschedpolicy(attrp, schedpolicy);
5537 if (errno) {
5538 posix_error();
5539 goto fail;
5540 }
5541 all_flags |= POSIX_SPAWN_SETSCHEDULER;
5542 }
5543 errno = posix_spawnattr_setschedparam(attrp, &schedparam);
5544 if (errno) {
5545 posix_error();
5546 goto fail;
5547 }
5548 all_flags |= POSIX_SPAWN_SETSCHEDPARAM;
5549#else
5550 PyErr_SetString(PyExc_NotImplementedError,
5551 "The scheduler option is not supported in this system.");
5552 goto fail;
5553#endif
5554 }
5555
5556 errno = posix_spawnattr_setflags(attrp, all_flags);
5557 if (errno) {
5558 posix_error();
5559 goto fail;
5560 }
5561
5562 return 0;
5563
5564fail:
5565 (void)posix_spawnattr_destroy(attrp);
5566 return -1;
5567}
5568
5569static int
Serhiy Storchakaef347532018-05-01 16:45:04 +03005570parse_file_actions(PyObject *file_actions,
Pablo Galindocb970732018-06-19 09:19:50 +01005571 posix_spawn_file_actions_t *file_actionsp,
5572 PyObject *temp_buffer)
Serhiy Storchakaef347532018-05-01 16:45:04 +03005573{
5574 PyObject *seq;
5575 PyObject *file_action = NULL;
5576 PyObject *tag_obj;
5577
5578 seq = PySequence_Fast(file_actions,
5579 "file_actions must be a sequence or None");
5580 if (seq == NULL) {
5581 return -1;
5582 }
5583
5584 errno = posix_spawn_file_actions_init(file_actionsp);
5585 if (errno) {
5586 posix_error();
5587 Py_DECREF(seq);
5588 return -1;
5589 }
5590
Zackery Spytzd52a83a2019-06-26 14:54:20 -06005591 for (Py_ssize_t i = 0; i < PySequence_Fast_GET_SIZE(seq); ++i) {
Serhiy Storchakaef347532018-05-01 16:45:04 +03005592 file_action = PySequence_Fast_GET_ITEM(seq, i);
5593 Py_INCREF(file_action);
5594 if (!PyTuple_Check(file_action) || !PyTuple_GET_SIZE(file_action)) {
5595 PyErr_SetString(PyExc_TypeError,
5596 "Each file_actions element must be a non-empty tuple");
5597 goto fail;
5598 }
5599 long tag = PyLong_AsLong(PyTuple_GET_ITEM(file_action, 0));
5600 if (tag == -1 && PyErr_Occurred()) {
5601 goto fail;
5602 }
5603
5604 /* Populate the file_actions object */
5605 switch (tag) {
5606 case POSIX_SPAWN_OPEN: {
5607 int fd, oflag;
5608 PyObject *path;
5609 unsigned long mode;
5610 if (!PyArg_ParseTuple(file_action, "OiO&ik"
5611 ";A open file_action tuple must have 5 elements",
5612 &tag_obj, &fd, PyUnicode_FSConverter, &path,
5613 &oflag, &mode))
5614 {
5615 goto fail;
5616 }
Pablo Galindocb970732018-06-19 09:19:50 +01005617 if (PyList_Append(temp_buffer, path)) {
5618 Py_DECREF(path);
5619 goto fail;
5620 }
Serhiy Storchakaef347532018-05-01 16:45:04 +03005621 errno = posix_spawn_file_actions_addopen(file_actionsp,
5622 fd, PyBytes_AS_STRING(path), oflag, (mode_t)mode);
Pablo Galindocb970732018-06-19 09:19:50 +01005623 Py_DECREF(path);
Serhiy Storchakaef347532018-05-01 16:45:04 +03005624 if (errno) {
5625 posix_error();
5626 goto fail;
5627 }
5628 break;
5629 }
5630 case POSIX_SPAWN_CLOSE: {
5631 int fd;
5632 if (!PyArg_ParseTuple(file_action, "Oi"
5633 ";A close file_action tuple must have 2 elements",
5634 &tag_obj, &fd))
5635 {
5636 goto fail;
5637 }
5638 errno = posix_spawn_file_actions_addclose(file_actionsp, fd);
5639 if (errno) {
5640 posix_error();
5641 goto fail;
5642 }
5643 break;
5644 }
5645 case POSIX_SPAWN_DUP2: {
5646 int fd1, fd2;
5647 if (!PyArg_ParseTuple(file_action, "Oii"
5648 ";A dup2 file_action tuple must have 3 elements",
5649 &tag_obj, &fd1, &fd2))
5650 {
5651 goto fail;
5652 }
5653 errno = posix_spawn_file_actions_adddup2(file_actionsp,
5654 fd1, fd2);
5655 if (errno) {
5656 posix_error();
5657 goto fail;
5658 }
5659 break;
5660 }
5661 default: {
5662 PyErr_SetString(PyExc_TypeError,
5663 "Unknown file_actions identifier");
5664 goto fail;
5665 }
5666 }
5667 Py_DECREF(file_action);
5668 }
Pablo Galindo254a4662018-09-07 16:44:24 +01005669
Serhiy Storchakaef347532018-05-01 16:45:04 +03005670 Py_DECREF(seq);
5671 return 0;
5672
5673fail:
5674 Py_DECREF(seq);
5675 Py_DECREF(file_action);
5676 (void)posix_spawn_file_actions_destroy(file_actionsp);
5677 return -1;
5678}
5679
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005680
5681static PyObject *
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005682py_posix_spawn(int use_posix_spawnp, PyObject *module, path_t *path, PyObject *argv,
5683 PyObject *env, PyObject *file_actions,
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005684 PyObject *setpgroup, int resetids, int setsid, PyObject *setsigmask,
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005685 PyObject *setsigdef, PyObject *scheduler)
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005686{
Victor Stinner325e4ba2019-02-01 15:47:24 +01005687 const char *func_name = use_posix_spawnp ? "posix_spawnp" : "posix_spawn";
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005688 EXECV_CHAR **argvlist = NULL;
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005689 EXECV_CHAR **envlist = NULL;
Serhiy Storchakaef347532018-05-01 16:45:04 +03005690 posix_spawn_file_actions_t file_actions_buf;
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005691 posix_spawn_file_actions_t *file_actionsp = NULL;
Pablo Galindo254a4662018-09-07 16:44:24 +01005692 posix_spawnattr_t attr;
5693 posix_spawnattr_t *attrp = NULL;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005694 Py_ssize_t argc, envc;
Serhiy Storchakaef347532018-05-01 16:45:04 +03005695 PyObject *result = NULL;
Pablo Galindocb970732018-06-19 09:19:50 +01005696 PyObject *temp_buffer = NULL;
Serhiy Storchakaef347532018-05-01 16:45:04 +03005697 pid_t pid;
5698 int err_code;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005699
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005700 /* posix_spawn and posix_spawnp have three arguments: (path, argv, env), where
Serhiy Storchakaef347532018-05-01 16:45:04 +03005701 argv is a list or tuple of strings and env is a dictionary
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005702 like posix.environ. */
5703
Serhiy Storchakaef347532018-05-01 16:45:04 +03005704 if (!PyList_Check(argv) && !PyTuple_Check(argv)) {
Victor Stinner325e4ba2019-02-01 15:47:24 +01005705 PyErr_Format(PyExc_TypeError,
5706 "%s: argv must be a tuple or list", func_name);
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005707 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005708 }
5709 argc = PySequence_Size(argv);
5710 if (argc < 1) {
Victor Stinner325e4ba2019-02-01 15:47:24 +01005711 PyErr_Format(PyExc_ValueError,
5712 "%s: argv must not be empty", func_name);
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005713 return NULL;
5714 }
5715
5716 if (!PyMapping_Check(env)) {
Victor Stinner325e4ba2019-02-01 15:47:24 +01005717 PyErr_Format(PyExc_TypeError,
5718 "%s: environment must be a mapping object", func_name);
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005719 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005720 }
5721
5722 argvlist = parse_arglist(argv, &argc);
5723 if (argvlist == NULL) {
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005724 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005725 }
5726 if (!argvlist[0][0]) {
Victor Stinner325e4ba2019-02-01 15:47:24 +01005727 PyErr_Format(PyExc_ValueError,
5728 "%s: argv first element cannot be empty", func_name);
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005729 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005730 }
5731
5732 envlist = parse_envlist(env, &envc);
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005733 if (envlist == NULL) {
5734 goto exit;
5735 }
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005736
Anthony Shaw948ed8c2019-05-10 12:00:06 +10005737 if (file_actions != NULL && file_actions != Py_None) {
Pablo Galindocb970732018-06-19 09:19:50 +01005738 /* There is a bug in old versions of glibc that makes some of the
5739 * helper functions for manipulating file actions not copy the provided
5740 * buffers. The problem is that posix_spawn_file_actions_addopen does not
5741 * copy the value of path for some old versions of glibc (<2.20).
5742 * The use of temp_buffer here is a workaround that keeps the
5743 * python objects that own the buffers alive until posix_spawn gets called.
5744 * Check https://bugs.python.org/issue33630 and
5745 * https://sourceware.org/bugzilla/show_bug.cgi?id=17048 for more info.*/
5746 temp_buffer = PyList_New(0);
5747 if (!temp_buffer) {
5748 goto exit;
5749 }
5750 if (parse_file_actions(file_actions, &file_actions_buf, temp_buffer)) {
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005751 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005752 }
Serhiy Storchakaef347532018-05-01 16:45:04 +03005753 file_actionsp = &file_actions_buf;
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005754 }
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005755
Victor Stinner1c2fa782020-05-10 11:05:29 +02005756 if (parse_posix_spawn_flags(module, func_name, setpgroup, resetids, setsid,
Victor Stinner325e4ba2019-02-01 15:47:24 +01005757 setsigmask, setsigdef, scheduler, &attr)) {
Pablo Galindo254a4662018-09-07 16:44:24 +01005758 goto exit;
5759 }
5760 attrp = &attr;
5761
Saiyang Gou7514f4f2020-02-12 23:47:42 -08005762 if (PySys_Audit("os.posix_spawn", "OOO", path->object, argv, env) < 0) {
Saiyang Gou95f60012020-02-04 16:15:00 -08005763 goto exit;
5764 }
5765
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005766 _Py_BEGIN_SUPPRESS_IPH
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005767#ifdef HAVE_POSIX_SPAWNP
5768 if (use_posix_spawnp) {
5769 err_code = posix_spawnp(&pid, path->narrow,
5770 file_actionsp, attrp, argvlist, envlist);
5771 }
5772 else
5773#endif /* HAVE_POSIX_SPAWNP */
5774 {
5775 err_code = posix_spawn(&pid, path->narrow,
5776 file_actionsp, attrp, argvlist, envlist);
5777 }
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005778 _Py_END_SUPPRESS_IPH
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005779
Serhiy Storchakaef347532018-05-01 16:45:04 +03005780 if (err_code) {
5781 errno = err_code;
5782 PyErr_SetFromErrnoWithFilenameObject(PyExc_OSError, path->object);
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005783 goto exit;
5784 }
Gregory P. Smith1d300ce2018-12-30 21:13:02 -08005785#ifdef _Py_MEMORY_SANITIZER
5786 __msan_unpoison(&pid, sizeof(pid));
5787#endif
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005788 result = PyLong_FromPid(pid);
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005789
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005790exit:
Serhiy Storchakaef347532018-05-01 16:45:04 +03005791 if (file_actionsp) {
5792 (void)posix_spawn_file_actions_destroy(file_actionsp);
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005793 }
Pablo Galindo254a4662018-09-07 16:44:24 +01005794 if (attrp) {
5795 (void)posix_spawnattr_destroy(attrp);
5796 }
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005797 if (envlist) {
5798 free_string_array(envlist, envc);
5799 }
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005800 if (argvlist) {
5801 free_string_array(argvlist, argc);
5802 }
Pablo Galindocb970732018-06-19 09:19:50 +01005803 Py_XDECREF(temp_buffer);
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005804 return result;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005805}
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005806
5807
5808/*[clinic input]
5809
5810os.posix_spawn
5811 path: path_t
5812 Path of executable file.
5813 argv: object
5814 Tuple or list of strings.
5815 env: object
5816 Dictionary of strings mapping to strings.
5817 /
5818 *
5819 file_actions: object(c_default='NULL') = ()
5820 A sequence of file action tuples.
5821 setpgroup: object = NULL
5822 The pgroup to use with the POSIX_SPAWN_SETPGROUP flag.
5823 resetids: bool(accept={int}) = False
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005824 If the value is `true` the POSIX_SPAWN_RESETIDS will be activated.
5825 setsid: bool(accept={int}) = False
5826 If the value is `true` the POSIX_SPAWN_SETSID or POSIX_SPAWN_SETSID_NP will be activated.
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005827 setsigmask: object(c_default='NULL') = ()
5828 The sigmask to use with the POSIX_SPAWN_SETSIGMASK flag.
5829 setsigdef: object(c_default='NULL') = ()
5830 The sigmask to use with the POSIX_SPAWN_SETSIGDEF flag.
5831 scheduler: object = NULL
5832 A tuple with the scheduler policy (optional) and parameters.
5833
5834Execute the program specified by path in a new process.
5835[clinic start generated code]*/
5836
5837static PyObject *
5838os_posix_spawn_impl(PyObject *module, path_t *path, PyObject *argv,
5839 PyObject *env, PyObject *file_actions,
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005840 PyObject *setpgroup, int resetids, int setsid,
5841 PyObject *setsigmask, PyObject *setsigdef,
5842 PyObject *scheduler)
5843/*[clinic end generated code: output=14a1098c566bc675 input=8c6305619a00ad04]*/
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005844{
5845 return py_posix_spawn(0, module, path, argv, env, file_actions,
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005846 setpgroup, resetids, setsid, setsigmask, setsigdef,
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005847 scheduler);
5848}
5849 #endif /* HAVE_POSIX_SPAWN */
5850
5851
5852
5853#ifdef HAVE_POSIX_SPAWNP
5854/*[clinic input]
5855
5856os.posix_spawnp
5857 path: path_t
5858 Path of executable file.
5859 argv: object
5860 Tuple or list of strings.
5861 env: object
5862 Dictionary of strings mapping to strings.
5863 /
5864 *
5865 file_actions: object(c_default='NULL') = ()
5866 A sequence of file action tuples.
5867 setpgroup: object = NULL
5868 The pgroup to use with the POSIX_SPAWN_SETPGROUP flag.
5869 resetids: bool(accept={int}) = False
5870 If the value is `True` the POSIX_SPAWN_RESETIDS will be activated.
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005871 setsid: bool(accept={int}) = False
5872 If the value is `True` the POSIX_SPAWN_SETSID or POSIX_SPAWN_SETSID_NP will be activated.
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005873 setsigmask: object(c_default='NULL') = ()
5874 The sigmask to use with the POSIX_SPAWN_SETSIGMASK flag.
5875 setsigdef: object(c_default='NULL') = ()
5876 The sigmask to use with the POSIX_SPAWN_SETSIGDEF flag.
5877 scheduler: object = NULL
5878 A tuple with the scheduler policy (optional) and parameters.
5879
5880Execute the program specified by path in a new process.
5881[clinic start generated code]*/
5882
5883static PyObject *
5884os_posix_spawnp_impl(PyObject *module, path_t *path, PyObject *argv,
5885 PyObject *env, PyObject *file_actions,
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005886 PyObject *setpgroup, int resetids, int setsid,
5887 PyObject *setsigmask, PyObject *setsigdef,
5888 PyObject *scheduler)
5889/*[clinic end generated code: output=7b9aaefe3031238d input=c1911043a22028da]*/
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005890{
5891 return py_posix_spawn(1, module, path, argv, env, file_actions,
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005892 setpgroup, resetids, setsid, setsigmask, setsigdef,
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005893 scheduler);
5894}
5895#endif /* HAVE_POSIX_SPAWNP */
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005896
pxinwrf2d7ac72019-05-21 18:46:37 +08005897#ifdef HAVE_RTPSPAWN
5898static intptr_t
5899_rtp_spawn(int mode, const char *rtpFileName, const char *argv[],
5900 const char *envp[])
5901{
5902 RTP_ID rtpid;
5903 int status;
5904 pid_t res;
5905 int async_err = 0;
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00005906
pxinwrf2d7ac72019-05-21 18:46:37 +08005907 /* Set priority=100 and uStackSize=16 MiB (0x1000000) for new processes.
5908 uStackSize=0 cannot be used, the default stack size is too small for
5909 Python. */
5910 if (envp) {
5911 rtpid = rtpSpawn(rtpFileName, argv, envp,
5912 100, 0x1000000, 0, VX_FP_TASK);
5913 }
5914 else {
5915 rtpid = rtpSpawn(rtpFileName, argv, (const char **)environ,
5916 100, 0x1000000, 0, VX_FP_TASK);
5917 }
5918 if ((rtpid != RTP_ID_ERROR) && (mode == _P_WAIT)) {
5919 do {
5920 res = waitpid((pid_t)rtpid, &status, 0);
5921 } while (res < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
5922
5923 if (res < 0)
5924 return RTP_ID_ERROR;
5925 return ((intptr_t)status);
5926 }
5927 return ((intptr_t)rtpid);
5928}
5929#endif
5930
5931#if defined(HAVE_SPAWNV) || defined(HAVE_WSPAWNV) || defined(HAVE_RTPSPAWN)
Larry Hastings2f936352014-08-05 14:04:04 +10005932/*[clinic input]
5933os.spawnv
5934
5935 mode: int
5936 Mode of process creation.
Steve Dowercc16be82016-09-08 10:35:16 -07005937 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +10005938 Path of executable file.
5939 argv: object
5940 Tuple or list of strings.
5941 /
5942
5943Execute the program specified by path in a new process.
5944[clinic start generated code]*/
5945
Larry Hastings2f936352014-08-05 14:04:04 +10005946static PyObject *
Steve Dowercc16be82016-09-08 10:35:16 -07005947os_spawnv_impl(PyObject *module, int mode, path_t *path, PyObject *argv)
5948/*[clinic end generated code: output=71cd037a9d96b816 input=43224242303291be]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005949{
Steve Dowercc16be82016-09-08 10:35:16 -07005950 EXECV_CHAR **argvlist;
Larry Hastings2f936352014-08-05 14:04:04 +10005951 int i;
Victor Stinner8c62be82010-05-06 00:08:46 +00005952 Py_ssize_t argc;
Benjamin Petersonca470632016-09-06 13:47:26 -07005953 intptr_t spawnval;
Victor Stinner8c62be82010-05-06 00:08:46 +00005954 PyObject *(*getitem)(PyObject *, Py_ssize_t);
Guido van Rossuma1065681999-01-25 23:20:23 +00005955
Victor Stinner8c62be82010-05-06 00:08:46 +00005956 /* spawnv has three arguments: (mode, path, argv), where
5957 argv is a list or tuple of strings. */
Guido van Rossuma1065681999-01-25 23:20:23 +00005958
Victor Stinner8c62be82010-05-06 00:08:46 +00005959 if (PyList_Check(argv)) {
5960 argc = PyList_Size(argv);
5961 getitem = PyList_GetItem;
5962 }
5963 else if (PyTuple_Check(argv)) {
5964 argc = PyTuple_Size(argv);
5965 getitem = PyTuple_GetItem;
5966 }
5967 else {
5968 PyErr_SetString(PyExc_TypeError,
5969 "spawnv() arg 2 must be a tuple or list");
Victor Stinner8c62be82010-05-06 00:08:46 +00005970 return NULL;
5971 }
Steve Dower859fd7b2016-11-19 18:53:19 -08005972 if (argc == 0) {
5973 PyErr_SetString(PyExc_ValueError,
5974 "spawnv() arg 2 cannot be empty");
5975 return NULL;
5976 }
Guido van Rossuma1065681999-01-25 23:20:23 +00005977
Steve Dowercc16be82016-09-08 10:35:16 -07005978 argvlist = PyMem_NEW(EXECV_CHAR *, argc+1);
Victor Stinner8c62be82010-05-06 00:08:46 +00005979 if (argvlist == NULL) {
Victor Stinner8c62be82010-05-06 00:08:46 +00005980 return PyErr_NoMemory();
5981 }
5982 for (i = 0; i < argc; i++) {
5983 if (!fsconvert_strdup((*getitem)(argv, i),
5984 &argvlist[i])) {
5985 free_string_array(argvlist, i);
5986 PyErr_SetString(
5987 PyExc_TypeError,
5988 "spawnv() arg 2 must contain only strings");
Victor Stinner8c62be82010-05-06 00:08:46 +00005989 return NULL;
5990 }
Steve Dower93ff8722016-11-19 19:03:54 -08005991 if (i == 0 && !argvlist[0][0]) {
Victor Stinner8acb4cf2017-06-15 15:30:40 +02005992 free_string_array(argvlist, i + 1);
Steve Dower93ff8722016-11-19 19:03:54 -08005993 PyErr_SetString(
5994 PyExc_ValueError,
5995 "spawnv() arg 2 first element cannot be empty");
5996 return NULL;
5997 }
Victor Stinner8c62be82010-05-06 00:08:46 +00005998 }
5999 argvlist[argc] = NULL;
Guido van Rossuma1065681999-01-25 23:20:23 +00006000
pxinwrf2d7ac72019-05-21 18:46:37 +08006001#if !defined(HAVE_RTPSPAWN)
Victor Stinner8c62be82010-05-06 00:08:46 +00006002 if (mode == _OLD_P_OVERLAY)
6003 mode = _P_OVERLAY;
pxinwrf2d7ac72019-05-21 18:46:37 +08006004#endif
Tim Peters5aa91602002-01-30 05:46:57 +00006005
Saiyang Gou7514f4f2020-02-12 23:47:42 -08006006 if (PySys_Audit("os.spawn", "iOOO", mode, path->object, argv,
Saiyang Gou95f60012020-02-04 16:15:00 -08006007 Py_None) < 0) {
6008 free_string_array(argvlist, argc);
6009 return NULL;
6010 }
6011
Victor Stinner8c62be82010-05-06 00:08:46 +00006012 Py_BEGIN_ALLOW_THREADS
Steve Dower654a7bd2016-09-11 20:19:32 -07006013 _Py_BEGIN_SUPPRESS_IPH
Steve Dowercc16be82016-09-08 10:35:16 -07006014#ifdef HAVE_WSPAWNV
6015 spawnval = _wspawnv(mode, path->wide, argvlist);
pxinwrf2d7ac72019-05-21 18:46:37 +08006016#elif defined(HAVE_RTPSPAWN)
6017 spawnval = _rtp_spawn(mode, path->narrow, (const char **)argvlist, NULL);
Steve Dowercc16be82016-09-08 10:35:16 -07006018#else
6019 spawnval = _spawnv(mode, path->narrow, argvlist);
6020#endif
Steve Dower654a7bd2016-09-11 20:19:32 -07006021 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00006022 Py_END_ALLOW_THREADS
Tim Peters5aa91602002-01-30 05:46:57 +00006023
Victor Stinner8c62be82010-05-06 00:08:46 +00006024 free_string_array(argvlist, argc);
Guido van Rossuma1065681999-01-25 23:20:23 +00006025
Victor Stinner8c62be82010-05-06 00:08:46 +00006026 if (spawnval == -1)
6027 return posix_error();
6028 else
Richard Oudkerkac0ad882013-06-05 23:29:30 +01006029 return Py_BuildValue(_Py_PARSE_INTPTR, spawnval);
Guido van Rossuma1065681999-01-25 23:20:23 +00006030}
6031
Larry Hastings2f936352014-08-05 14:04:04 +10006032/*[clinic input]
6033os.spawnve
6034
6035 mode: int
6036 Mode of process creation.
Steve Dowercc16be82016-09-08 10:35:16 -07006037 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +10006038 Path of executable file.
6039 argv: object
6040 Tuple or list of strings.
6041 env: object
6042 Dictionary of strings mapping to strings.
6043 /
6044
6045Execute the program specified by path in a new process.
6046[clinic start generated code]*/
6047
Larry Hastings2f936352014-08-05 14:04:04 +10006048static PyObject *
Steve Dowercc16be82016-09-08 10:35:16 -07006049os_spawnve_impl(PyObject *module, int mode, path_t *path, PyObject *argv,
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006050 PyObject *env)
Steve Dowercc16be82016-09-08 10:35:16 -07006051/*[clinic end generated code: output=30fe85be56fe37ad input=3e40803ee7c4c586]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006052{
Steve Dowercc16be82016-09-08 10:35:16 -07006053 EXECV_CHAR **argvlist;
6054 EXECV_CHAR **envlist;
Victor Stinner8c62be82010-05-06 00:08:46 +00006055 PyObject *res = NULL;
Antoine Pitrou22e41552010-08-15 18:07:50 +00006056 Py_ssize_t argc, i, envc;
Benjamin Petersonca470632016-09-06 13:47:26 -07006057 intptr_t spawnval;
Victor Stinner8c62be82010-05-06 00:08:46 +00006058 PyObject *(*getitem)(PyObject *, Py_ssize_t);
Victor Stinnerc8d6ab22017-06-23 15:04:46 +02006059 Py_ssize_t lastarg = 0;
Guido van Rossuma1065681999-01-25 23:20:23 +00006060
Victor Stinner8c62be82010-05-06 00:08:46 +00006061 /* spawnve has four arguments: (mode, path, argv, env), where
6062 argv is a list or tuple of strings and env is a dictionary
6063 like posix.environ. */
Guido van Rossuma1065681999-01-25 23:20:23 +00006064
Victor Stinner8c62be82010-05-06 00:08:46 +00006065 if (PyList_Check(argv)) {
6066 argc = PyList_Size(argv);
6067 getitem = PyList_GetItem;
6068 }
6069 else if (PyTuple_Check(argv)) {
6070 argc = PyTuple_Size(argv);
6071 getitem = PyTuple_GetItem;
6072 }
6073 else {
6074 PyErr_SetString(PyExc_TypeError,
6075 "spawnve() arg 2 must be a tuple or list");
6076 goto fail_0;
6077 }
Steve Dower859fd7b2016-11-19 18:53:19 -08006078 if (argc == 0) {
6079 PyErr_SetString(PyExc_ValueError,
6080 "spawnve() arg 2 cannot be empty");
6081 goto fail_0;
6082 }
Victor Stinner8c62be82010-05-06 00:08:46 +00006083 if (!PyMapping_Check(env)) {
6084 PyErr_SetString(PyExc_TypeError,
6085 "spawnve() arg 3 must be a mapping object");
6086 goto fail_0;
6087 }
Guido van Rossuma1065681999-01-25 23:20:23 +00006088
Steve Dowercc16be82016-09-08 10:35:16 -07006089 argvlist = PyMem_NEW(EXECV_CHAR *, argc+1);
Victor Stinner8c62be82010-05-06 00:08:46 +00006090 if (argvlist == NULL) {
6091 PyErr_NoMemory();
6092 goto fail_0;
6093 }
6094 for (i = 0; i < argc; i++) {
6095 if (!fsconvert_strdup((*getitem)(argv, i),
6096 &argvlist[i]))
6097 {
6098 lastarg = i;
6099 goto fail_1;
6100 }
Steve Dowerbce26262016-11-19 19:17:26 -08006101 if (i == 0 && !argvlist[0][0]) {
Victor Stinnerc8d6ab22017-06-23 15:04:46 +02006102 lastarg = i + 1;
Steve Dowerbce26262016-11-19 19:17:26 -08006103 PyErr_SetString(
6104 PyExc_ValueError,
6105 "spawnv() arg 2 first element cannot be empty");
6106 goto fail_1;
6107 }
Victor Stinner8c62be82010-05-06 00:08:46 +00006108 }
6109 lastarg = argc;
6110 argvlist[argc] = NULL;
Guido van Rossuma1065681999-01-25 23:20:23 +00006111
Victor Stinner8c62be82010-05-06 00:08:46 +00006112 envlist = parse_envlist(env, &envc);
6113 if (envlist == NULL)
6114 goto fail_1;
Guido van Rossuma1065681999-01-25 23:20:23 +00006115
pxinwrf2d7ac72019-05-21 18:46:37 +08006116#if !defined(HAVE_RTPSPAWN)
Victor Stinner8c62be82010-05-06 00:08:46 +00006117 if (mode == _OLD_P_OVERLAY)
6118 mode = _P_OVERLAY;
pxinwrf2d7ac72019-05-21 18:46:37 +08006119#endif
Tim Peters25059d32001-12-07 20:35:43 +00006120
Saiyang Gou7514f4f2020-02-12 23:47:42 -08006121 if (PySys_Audit("os.spawn", "iOOO", mode, path->object, argv, env) < 0) {
Saiyang Gou95f60012020-02-04 16:15:00 -08006122 goto fail_2;
6123 }
6124
Victor Stinner8c62be82010-05-06 00:08:46 +00006125 Py_BEGIN_ALLOW_THREADS
Steve Dower654a7bd2016-09-11 20:19:32 -07006126 _Py_BEGIN_SUPPRESS_IPH
Steve Dowercc16be82016-09-08 10:35:16 -07006127#ifdef HAVE_WSPAWNV
6128 spawnval = _wspawnve(mode, path->wide, argvlist, envlist);
pxinwrf2d7ac72019-05-21 18:46:37 +08006129#elif defined(HAVE_RTPSPAWN)
6130 spawnval = _rtp_spawn(mode, path->narrow, (const char **)argvlist,
6131 (const char **)envlist);
Steve Dowercc16be82016-09-08 10:35:16 -07006132#else
6133 spawnval = _spawnve(mode, path->narrow, argvlist, envlist);
6134#endif
Steve Dower654a7bd2016-09-11 20:19:32 -07006135 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00006136 Py_END_ALLOW_THREADS
Tim Peters25059d32001-12-07 20:35:43 +00006137
Victor Stinner8c62be82010-05-06 00:08:46 +00006138 if (spawnval == -1)
6139 (void) posix_error();
6140 else
Richard Oudkerkac0ad882013-06-05 23:29:30 +01006141 res = Py_BuildValue(_Py_PARSE_INTPTR, spawnval);
Guido van Rossuma1065681999-01-25 23:20:23 +00006142
Saiyang Gou95f60012020-02-04 16:15:00 -08006143 fail_2:
Victor Stinner8c62be82010-05-06 00:08:46 +00006144 while (--envc >= 0)
6145 PyMem_DEL(envlist[envc]);
6146 PyMem_DEL(envlist);
Guido van Rossum0847c5c2002-12-13 18:36:22 +00006147 fail_1:
Victor Stinnerc8d6ab22017-06-23 15:04:46 +02006148 free_string_array(argvlist, lastarg);
Martin v. Löwis114619e2002-10-07 06:44:21 +00006149 fail_0:
Victor Stinner8c62be82010-05-06 00:08:46 +00006150 return res;
Guido van Rossuma1065681999-01-25 23:20:23 +00006151}
Andrew MacIntyre69e18c92004-04-04 07:11:43 +00006152
Guido van Rossuma1065681999-01-25 23:20:23 +00006153#endif /* HAVE_SPAWNV */
6154
6155
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006156#ifdef HAVE_FORK
Gregory P. Smith163468a2017-05-29 10:03:41 -07006157
6158/* Helper function to validate arguments.
6159 Returns 0 on success. non-zero on failure with a TypeError raised.
6160 If obj is non-NULL it must be callable. */
6161static int
6162check_null_or_callable(PyObject *obj, const char* obj_name)
6163{
6164 if (obj && !PyCallable_Check(obj)) {
6165 PyErr_Format(PyExc_TypeError, "'%s' must be callable, not %s",
Eddie Elizondob3966632019-11-05 07:16:14 -08006166 obj_name, _PyType_Name(Py_TYPE(obj)));
Gregory P. Smith163468a2017-05-29 10:03:41 -07006167 return -1;
6168 }
6169 return 0;
6170}
6171
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006172/*[clinic input]
6173os.register_at_fork
6174
Gregory P. Smith163468a2017-05-29 10:03:41 -07006175 *
6176 before: object=NULL
6177 A callable to be called in the parent before the fork() syscall.
6178 after_in_child: object=NULL
6179 A callable to be called in the child after fork().
6180 after_in_parent: object=NULL
6181 A callable to be called in the parent after fork().
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006182
Gregory P. Smith163468a2017-05-29 10:03:41 -07006183Register callables to be called when forking a new process.
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006184
Gregory P. Smith163468a2017-05-29 10:03:41 -07006185'before' callbacks are called in reverse order.
6186'after_in_child' and 'after_in_parent' callbacks are called in order.
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006187
6188[clinic start generated code]*/
6189
6190static PyObject *
Gregory P. Smith163468a2017-05-29 10:03:41 -07006191os_register_at_fork_impl(PyObject *module, PyObject *before,
6192 PyObject *after_in_child, PyObject *after_in_parent)
6193/*[clinic end generated code: output=5398ac75e8e97625 input=cd1187aa85d2312e]*/
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006194{
6195 PyInterpreterState *interp;
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006196
Gregory P. Smith163468a2017-05-29 10:03:41 -07006197 if (!before && !after_in_child && !after_in_parent) {
6198 PyErr_SetString(PyExc_TypeError, "At least one argument is required.");
6199 return NULL;
6200 }
6201 if (check_null_or_callable(before, "before") ||
6202 check_null_or_callable(after_in_child, "after_in_child") ||
6203 check_null_or_callable(after_in_parent, "after_in_parent")) {
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006204 return NULL;
6205 }
Victor Stinner81a7be32020-04-14 15:14:01 +02006206 interp = _PyInterpreterState_GET();
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006207
Gregory P. Smith163468a2017-05-29 10:03:41 -07006208 if (register_at_forker(&interp->before_forkers, before)) {
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006209 return NULL;
6210 }
Gregory P. Smith163468a2017-05-29 10:03:41 -07006211 if (register_at_forker(&interp->after_forkers_child, after_in_child)) {
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006212 return NULL;
Gregory P. Smith163468a2017-05-29 10:03:41 -07006213 }
6214 if (register_at_forker(&interp->after_forkers_parent, after_in_parent)) {
6215 return NULL;
6216 }
6217 Py_RETURN_NONE;
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006218}
6219#endif /* HAVE_FORK */
6220
6221
Guido van Rossum2242f2f2001-04-11 20:58:20 +00006222#ifdef HAVE_FORK1
Larry Hastings2f936352014-08-05 14:04:04 +10006223/*[clinic input]
6224os.fork1
6225
6226Fork a child process with a single multiplexed (i.e., not bound) thread.
6227
6228Return 0 to child process and PID of child to parent process.
6229[clinic start generated code]*/
6230
Larry Hastings2f936352014-08-05 14:04:04 +10006231static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006232os_fork1_impl(PyObject *module)
6233/*[clinic end generated code: output=0de8e67ce2a310bc input=12db02167893926e]*/
Guido van Rossum2242f2f2001-04-11 20:58:20 +00006234{
Victor Stinner8c62be82010-05-06 00:08:46 +00006235 pid_t pid;
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006236
Victor Stinner81a7be32020-04-14 15:14:01 +02006237 if (_PyInterpreterState_GET() != PyInterpreterState_Main()) {
Eric Snow59032962018-09-14 14:17:20 -07006238 PyErr_SetString(PyExc_RuntimeError, "fork not supported for subinterpreters");
6239 return NULL;
6240 }
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006241 PyOS_BeforeFork();
Victor Stinner8c62be82010-05-06 00:08:46 +00006242 pid = fork1();
6243 if (pid == 0) {
6244 /* child: this clobbers and resets the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006245 PyOS_AfterFork_Child();
Victor Stinner8c62be82010-05-06 00:08:46 +00006246 } else {
6247 /* parent: release the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006248 PyOS_AfterFork_Parent();
Victor Stinner8c62be82010-05-06 00:08:46 +00006249 }
6250 if (pid == -1)
6251 return posix_error();
Victor Stinner8c62be82010-05-06 00:08:46 +00006252 return PyLong_FromPid(pid);
Guido van Rossum2242f2f2001-04-11 20:58:20 +00006253}
Larry Hastings2f936352014-08-05 14:04:04 +10006254#endif /* HAVE_FORK1 */
Guido van Rossum2242f2f2001-04-11 20:58:20 +00006255
6256
Guido van Rossumad0ee831995-03-01 10:34:45 +00006257#ifdef HAVE_FORK
Larry Hastings2f936352014-08-05 14:04:04 +10006258/*[clinic input]
6259os.fork
6260
6261Fork a child process.
6262
6263Return 0 to child process and PID of child to parent process.
6264[clinic start generated code]*/
6265
Larry Hastings2f936352014-08-05 14:04:04 +10006266static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006267os_fork_impl(PyObject *module)
6268/*[clinic end generated code: output=3626c81f98985d49 input=13c956413110eeaa]*/
Guido van Rossum85e3b011991-06-03 12:42:10 +00006269{
Victor Stinner8c62be82010-05-06 00:08:46 +00006270 pid_t pid;
Victor Stinner252346a2020-05-01 11:33:44 +02006271 PyInterpreterState *interp = _PyInterpreterState_GET();
6272 if (interp->config._isolated_interpreter) {
6273 PyErr_SetString(PyExc_RuntimeError,
6274 "fork not supported for isolated subinterpreters");
Eric Snow59032962018-09-14 14:17:20 -07006275 return NULL;
6276 }
Saiyang Gou7514f4f2020-02-12 23:47:42 -08006277 if (PySys_Audit("os.fork", NULL) < 0) {
6278 return NULL;
6279 }
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006280 PyOS_BeforeFork();
Victor Stinner8c62be82010-05-06 00:08:46 +00006281 pid = fork();
6282 if (pid == 0) {
6283 /* child: this clobbers and resets the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006284 PyOS_AfterFork_Child();
Victor Stinner8c62be82010-05-06 00:08:46 +00006285 } else {
6286 /* parent: release the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006287 PyOS_AfterFork_Parent();
Victor Stinner8c62be82010-05-06 00:08:46 +00006288 }
6289 if (pid == -1)
6290 return posix_error();
Victor Stinner8c62be82010-05-06 00:08:46 +00006291 return PyLong_FromPid(pid);
Guido van Rossum85e3b011991-06-03 12:42:10 +00006292}
Larry Hastings2f936352014-08-05 14:04:04 +10006293#endif /* HAVE_FORK */
6294
Guido van Rossum85e3b011991-06-03 12:42:10 +00006295
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006296#ifdef HAVE_SCHED_H
Charles-François Nataliea0d5fc2011-09-06 19:03:35 +02006297#ifdef HAVE_SCHED_GET_PRIORITY_MAX
Larry Hastings2f936352014-08-05 14:04:04 +10006298/*[clinic input]
6299os.sched_get_priority_max
Charles-François Nataliea0d5fc2011-09-06 19:03:35 +02006300
Larry Hastings2f936352014-08-05 14:04:04 +10006301 policy: int
6302
6303Get the maximum scheduling priority for policy.
6304[clinic start generated code]*/
6305
Larry Hastings2f936352014-08-05 14:04:04 +10006306static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006307os_sched_get_priority_max_impl(PyObject *module, int policy)
6308/*[clinic end generated code: output=9e465c6e43130521 input=2097b7998eca6874]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006309{
6310 int max;
6311
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006312 max = sched_get_priority_max(policy);
6313 if (max < 0)
6314 return posix_error();
6315 return PyLong_FromLong(max);
6316}
6317
Larry Hastings2f936352014-08-05 14:04:04 +10006318
6319/*[clinic input]
6320os.sched_get_priority_min
6321
6322 policy: int
6323
6324Get the minimum scheduling priority for policy.
6325[clinic start generated code]*/
6326
Larry Hastings2f936352014-08-05 14:04:04 +10006327static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006328os_sched_get_priority_min_impl(PyObject *module, int policy)
6329/*[clinic end generated code: output=7595c1138cc47a6d input=21bc8fa0d70983bf]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006330{
6331 int min = sched_get_priority_min(policy);
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006332 if (min < 0)
6333 return posix_error();
6334 return PyLong_FromLong(min);
6335}
Charles-François Nataliea0d5fc2011-09-06 19:03:35 +02006336#endif /* HAVE_SCHED_GET_PRIORITY_MAX */
6337
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006338
Larry Hastings2f936352014-08-05 14:04:04 +10006339#ifdef HAVE_SCHED_SETSCHEDULER
6340/*[clinic input]
6341os.sched_getscheduler
6342 pid: pid_t
6343 /
6344
Min ho Kimc4cacc82019-07-31 08:16:13 +10006345Get the scheduling policy for the process identified by pid.
Larry Hastings2f936352014-08-05 14:04:04 +10006346
6347Passing 0 for pid returns the scheduling policy for the calling process.
6348[clinic start generated code]*/
6349
Larry Hastings2f936352014-08-05 14:04:04 +10006350static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006351os_sched_getscheduler_impl(PyObject *module, pid_t pid)
Min ho Kimc4cacc82019-07-31 08:16:13 +10006352/*[clinic end generated code: output=dce4c0bd3f1b34c8 input=8d99dac505485ac8]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006353{
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006354 int policy;
6355
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006356 policy = sched_getscheduler(pid);
6357 if (policy < 0)
6358 return posix_error();
6359 return PyLong_FromLong(policy);
6360}
Larry Hastings2f936352014-08-05 14:04:04 +10006361#endif /* HAVE_SCHED_SETSCHEDULER */
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006362
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006363
William Orr81574b82018-10-01 22:19:56 -07006364#if defined(HAVE_SCHED_SETPARAM) || defined(HAVE_SCHED_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDPARAM)
Larry Hastings2f936352014-08-05 14:04:04 +10006365/*[clinic input]
Eddie Elizondo474eedf2018-11-13 04:09:31 -08006366class os.sched_param "PyObject *" "SchedParamType"
Larry Hastings2f936352014-08-05 14:04:04 +10006367
6368@classmethod
6369os.sched_param.__new__
6370
6371 sched_priority: object
6372 A scheduling parameter.
6373
Eddie Elizondob3966632019-11-05 07:16:14 -08006374Currently has only one field: sched_priority
Larry Hastings2f936352014-08-05 14:04:04 +10006375[clinic start generated code]*/
6376
Larry Hastings2f936352014-08-05 14:04:04 +10006377static PyObject *
6378os_sched_param_impl(PyTypeObject *type, PyObject *sched_priority)
Eddie Elizondob3966632019-11-05 07:16:14 -08006379/*[clinic end generated code: output=48f4067d60f48c13 input=eb42909a2c0e3e6c]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006380{
6381 PyObject *res;
6382
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006383 res = PyStructSequence_New(type);
6384 if (!res)
6385 return NULL;
Larry Hastings2f936352014-08-05 14:04:04 +10006386 Py_INCREF(sched_priority);
6387 PyStructSequence_SET_ITEM(res, 0, sched_priority);
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006388 return res;
6389}
6390
Serhiy Storchaka1009bf12015-04-03 23:53:51 +03006391PyDoc_VAR(os_sched_param__doc__);
6392
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006393static PyStructSequence_Field sched_param_fields[] = {
6394 {"sched_priority", "the scheduling priority"},
6395 {0}
6396};
6397
6398static PyStructSequence_Desc sched_param_desc = {
6399 "sched_param", /* name */
Larry Hastings2f936352014-08-05 14:04:04 +10006400 os_sched_param__doc__, /* doc */
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006401 sched_param_fields,
6402 1
6403};
6404
6405static int
Victor Stinner1c2fa782020-05-10 11:05:29 +02006406convert_sched_param(PyObject *module, PyObject *param, struct sched_param *res)
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006407{
6408 long priority;
6409
Victor Stinner1c2fa782020-05-10 11:05:29 +02006410 if (!Py_IS_TYPE(param, (PyTypeObject *)get_posix_state(module)->SchedParamType)) {
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006411 PyErr_SetString(PyExc_TypeError, "must have a sched_param object");
6412 return 0;
6413 }
6414 priority = PyLong_AsLong(PyStructSequence_GET_ITEM(param, 0));
6415 if (priority == -1 && PyErr_Occurred())
6416 return 0;
6417 if (priority > INT_MAX || priority < INT_MIN) {
6418 PyErr_SetString(PyExc_OverflowError, "sched_priority out of range");
6419 return 0;
6420 }
6421 res->sched_priority = Py_SAFE_DOWNCAST(priority, long, int);
6422 return 1;
6423}
William Orr81574b82018-10-01 22:19:56 -07006424#endif /* defined(HAVE_SCHED_SETPARAM) || defined(HAVE_SCHED_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDPARAM) */
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006425
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006426
6427#ifdef HAVE_SCHED_SETSCHEDULER
Larry Hastings2f936352014-08-05 14:04:04 +10006428/*[clinic input]
6429os.sched_setscheduler
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006430
Larry Hastings2f936352014-08-05 14:04:04 +10006431 pid: pid_t
6432 policy: int
Victor Stinner1c2fa782020-05-10 11:05:29 +02006433 param as param_obj: object
Larry Hastings2f936352014-08-05 14:04:04 +10006434 /
6435
6436Set the scheduling policy for the process identified by pid.
6437
6438If pid is 0, the calling process is changed.
6439param is an instance of sched_param.
6440[clinic start generated code]*/
6441
Larry Hastings2f936352014-08-05 14:04:04 +10006442static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006443os_sched_setscheduler_impl(PyObject *module, pid_t pid, int policy,
Victor Stinner1c2fa782020-05-10 11:05:29 +02006444 PyObject *param_obj)
6445/*[clinic end generated code: output=cde27faa55dc993e input=73013d731bd8fbe9]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006446{
Victor Stinner1c2fa782020-05-10 11:05:29 +02006447 struct sched_param param;
6448 if (!convert_sched_param(module, param_obj, &param)) {
6449 return NULL;
6450 }
6451
Jesus Cea9c822272011-09-10 01:40:52 +02006452 /*
Jesus Cea54b01492011-09-10 01:53:19 +02006453 ** sched_setscheduler() returns 0 in Linux, but the previous
6454 ** scheduling policy under Solaris/Illumos, and others.
6455 ** On error, -1 is returned in all Operating Systems.
Jesus Cea9c822272011-09-10 01:40:52 +02006456 */
Victor Stinner1c2fa782020-05-10 11:05:29 +02006457 if (sched_setscheduler(pid, policy, &param) == -1)
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006458 return posix_error();
6459 Py_RETURN_NONE;
6460}
Larry Hastings2f936352014-08-05 14:04:04 +10006461#endif /* HAVE_SCHED_SETSCHEDULER*/
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006462
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006463
6464#ifdef HAVE_SCHED_SETPARAM
Larry Hastings2f936352014-08-05 14:04:04 +10006465/*[clinic input]
6466os.sched_getparam
6467 pid: pid_t
6468 /
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006469
Larry Hastings2f936352014-08-05 14:04:04 +10006470Returns scheduling parameters for the process identified by pid.
6471
6472If pid is 0, returns parameters for the calling process.
6473Return value is an instance of sched_param.
6474[clinic start generated code]*/
6475
Larry Hastings2f936352014-08-05 14:04:04 +10006476static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006477os_sched_getparam_impl(PyObject *module, pid_t pid)
6478/*[clinic end generated code: output=b194e8708dcf2db8 input=18a1ef9c2efae296]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006479{
6480 struct sched_param param;
6481 PyObject *result;
6482 PyObject *priority;
6483
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006484 if (sched_getparam(pid, &param))
6485 return posix_error();
Victor Stinner1c2fa782020-05-10 11:05:29 +02006486 PyObject *SchedParamType = get_posix_state(module)->SchedParamType;
Eddie Elizondob3966632019-11-05 07:16:14 -08006487 result = PyStructSequence_New((PyTypeObject *)SchedParamType);
Larry Hastings2f936352014-08-05 14:04:04 +10006488 if (!result)
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006489 return NULL;
6490 priority = PyLong_FromLong(param.sched_priority);
6491 if (!priority) {
Larry Hastings2f936352014-08-05 14:04:04 +10006492 Py_DECREF(result);
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006493 return NULL;
6494 }
Larry Hastings2f936352014-08-05 14:04:04 +10006495 PyStructSequence_SET_ITEM(result, 0, priority);
6496 return result;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006497}
6498
Larry Hastings2f936352014-08-05 14:04:04 +10006499
6500/*[clinic input]
6501os.sched_setparam
6502 pid: pid_t
Victor Stinner1c2fa782020-05-10 11:05:29 +02006503 param as param_obj: object
Larry Hastings2f936352014-08-05 14:04:04 +10006504 /
6505
6506Set scheduling parameters for the process identified by pid.
6507
6508If pid is 0, sets parameters for the calling process.
6509param should be an instance of sched_param.
6510[clinic start generated code]*/
6511
Larry Hastings2f936352014-08-05 14:04:04 +10006512static PyObject *
Victor Stinner1c2fa782020-05-10 11:05:29 +02006513os_sched_setparam_impl(PyObject *module, pid_t pid, PyObject *param_obj)
6514/*[clinic end generated code: output=f19fe020a53741c1 input=27b98337c8b2dcc7]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006515{
Victor Stinner1c2fa782020-05-10 11:05:29 +02006516 struct sched_param param;
6517 if (!convert_sched_param(module, param_obj, &param)) {
6518 return NULL;
6519 }
6520
6521 if (sched_setparam(pid, &param))
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006522 return posix_error();
6523 Py_RETURN_NONE;
6524}
Larry Hastings2f936352014-08-05 14:04:04 +10006525#endif /* HAVE_SCHED_SETPARAM */
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006526
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006527
6528#ifdef HAVE_SCHED_RR_GET_INTERVAL
Larry Hastings2f936352014-08-05 14:04:04 +10006529/*[clinic input]
6530os.sched_rr_get_interval -> double
6531 pid: pid_t
6532 /
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006533
Larry Hastings2f936352014-08-05 14:04:04 +10006534Return the round-robin quantum for the process identified by pid, in seconds.
6535
6536Value returned is a float.
6537[clinic start generated code]*/
6538
Larry Hastings2f936352014-08-05 14:04:04 +10006539static double
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006540os_sched_rr_get_interval_impl(PyObject *module, pid_t pid)
6541/*[clinic end generated code: output=7e2d935833ab47dc input=2a973da15cca6fae]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006542{
6543 struct timespec interval;
6544 if (sched_rr_get_interval(pid, &interval)) {
6545 posix_error();
6546 return -1.0;
6547 }
Gregory P. Smith1d300ce2018-12-30 21:13:02 -08006548#ifdef _Py_MEMORY_SANITIZER
6549 __msan_unpoison(&interval, sizeof(interval));
6550#endif
Larry Hastings2f936352014-08-05 14:04:04 +10006551 return (double)interval.tv_sec + 1e-9*interval.tv_nsec;
6552}
6553#endif /* HAVE_SCHED_RR_GET_INTERVAL */
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006554
Larry Hastings2f936352014-08-05 14:04:04 +10006555
6556/*[clinic input]
6557os.sched_yield
6558
6559Voluntarily relinquish the CPU.
6560[clinic start generated code]*/
6561
Larry Hastings2f936352014-08-05 14:04:04 +10006562static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006563os_sched_yield_impl(PyObject *module)
6564/*[clinic end generated code: output=902323500f222cac input=e54d6f98189391d4]*/
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006565{
6566 if (sched_yield())
6567 return posix_error();
6568 Py_RETURN_NONE;
6569}
6570
Benjamin Peterson2740af82011-08-02 17:41:34 -05006571#ifdef HAVE_SCHED_SETAFFINITY
Antoine Pitrou84869872012-08-04 16:16:35 +02006572/* The minimum number of CPUs allocated in a cpu_set_t */
6573static const int NCPUS_START = sizeof(unsigned long) * CHAR_BIT;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006574
Larry Hastings2f936352014-08-05 14:04:04 +10006575/*[clinic input]
6576os.sched_setaffinity
6577 pid: pid_t
6578 mask : object
6579 /
6580
6581Set the CPU affinity of the process identified by pid to mask.
6582
6583mask should be an iterable of integers identifying CPUs.
6584[clinic start generated code]*/
6585
Larry Hastings2f936352014-08-05 14:04:04 +10006586static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006587os_sched_setaffinity_impl(PyObject *module, pid_t pid, PyObject *mask)
6588/*[clinic end generated code: output=882d7dd9a229335b input=a0791a597c7085ba]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006589{
Antoine Pitrou84869872012-08-04 16:16:35 +02006590 int ncpus;
6591 size_t setsize;
Larry Hastings2f936352014-08-05 14:04:04 +10006592 cpu_set_t *cpu_set = NULL;
6593 PyObject *iterator = NULL, *item;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006594
Larry Hastings2f936352014-08-05 14:04:04 +10006595 iterator = PyObject_GetIter(mask);
Antoine Pitrou84869872012-08-04 16:16:35 +02006596 if (iterator == NULL)
6597 return NULL;
6598
6599 ncpus = NCPUS_START;
6600 setsize = CPU_ALLOC_SIZE(ncpus);
Larry Hastings2f936352014-08-05 14:04:04 +10006601 cpu_set = CPU_ALLOC(ncpus);
6602 if (cpu_set == NULL) {
Antoine Pitrou84869872012-08-04 16:16:35 +02006603 PyErr_NoMemory();
6604 goto error;
6605 }
Larry Hastings2f936352014-08-05 14:04:04 +10006606 CPU_ZERO_S(setsize, cpu_set);
Antoine Pitrou84869872012-08-04 16:16:35 +02006607
6608 while ((item = PyIter_Next(iterator))) {
6609 long cpu;
6610 if (!PyLong_Check(item)) {
6611 PyErr_Format(PyExc_TypeError,
6612 "expected an iterator of ints, "
6613 "but iterator yielded %R",
6614 Py_TYPE(item));
6615 Py_DECREF(item);
6616 goto error;
6617 }
6618 cpu = PyLong_AsLong(item);
6619 Py_DECREF(item);
6620 if (cpu < 0) {
6621 if (!PyErr_Occurred())
6622 PyErr_SetString(PyExc_ValueError, "negative CPU number");
6623 goto error;
6624 }
6625 if (cpu > INT_MAX - 1) {
6626 PyErr_SetString(PyExc_OverflowError, "CPU number too large");
6627 goto error;
6628 }
6629 if (cpu >= ncpus) {
6630 /* Grow CPU mask to fit the CPU number */
6631 int newncpus = ncpus;
6632 cpu_set_t *newmask;
6633 size_t newsetsize;
6634 while (newncpus <= cpu) {
6635 if (newncpus > INT_MAX / 2)
6636 newncpus = cpu + 1;
6637 else
6638 newncpus = newncpus * 2;
6639 }
6640 newmask = CPU_ALLOC(newncpus);
6641 if (newmask == NULL) {
6642 PyErr_NoMemory();
6643 goto error;
6644 }
6645 newsetsize = CPU_ALLOC_SIZE(newncpus);
6646 CPU_ZERO_S(newsetsize, newmask);
Larry Hastings2f936352014-08-05 14:04:04 +10006647 memcpy(newmask, cpu_set, setsize);
6648 CPU_FREE(cpu_set);
Antoine Pitrou84869872012-08-04 16:16:35 +02006649 setsize = newsetsize;
Larry Hastings2f936352014-08-05 14:04:04 +10006650 cpu_set = newmask;
Antoine Pitrou84869872012-08-04 16:16:35 +02006651 ncpus = newncpus;
6652 }
Larry Hastings2f936352014-08-05 14:04:04 +10006653 CPU_SET_S(cpu, setsize, cpu_set);
Antoine Pitrou84869872012-08-04 16:16:35 +02006654 }
Brandt Bucher45a30af2019-06-27 09:10:57 -07006655 if (PyErr_Occurred()) {
6656 goto error;
6657 }
Antoine Pitrou84869872012-08-04 16:16:35 +02006658 Py_CLEAR(iterator);
6659
Larry Hastings2f936352014-08-05 14:04:04 +10006660 if (sched_setaffinity(pid, setsize, cpu_set)) {
Antoine Pitrou84869872012-08-04 16:16:35 +02006661 posix_error();
6662 goto error;
6663 }
Larry Hastings2f936352014-08-05 14:04:04 +10006664 CPU_FREE(cpu_set);
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006665 Py_RETURN_NONE;
Antoine Pitrou84869872012-08-04 16:16:35 +02006666
6667error:
Larry Hastings2f936352014-08-05 14:04:04 +10006668 if (cpu_set)
6669 CPU_FREE(cpu_set);
Antoine Pitrou84869872012-08-04 16:16:35 +02006670 Py_XDECREF(iterator);
6671 return NULL;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006672}
6673
Larry Hastings2f936352014-08-05 14:04:04 +10006674
6675/*[clinic input]
6676os.sched_getaffinity
6677 pid: pid_t
6678 /
6679
Charles-François Natalidc87e4b2015-07-13 21:01:39 +01006680Return the affinity of the process identified by pid (or the current process if zero).
Larry Hastings2f936352014-08-05 14:04:04 +10006681
6682The affinity is returned as a set of CPU identifiers.
6683[clinic start generated code]*/
6684
Larry Hastings2f936352014-08-05 14:04:04 +10006685static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006686os_sched_getaffinity_impl(PyObject *module, pid_t pid)
Serhiy Storchaka2954f832016-07-07 18:20:03 +03006687/*[clinic end generated code: output=f726f2c193c17a4f input=983ce7cb4a565980]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006688{
Antoine Pitrou84869872012-08-04 16:16:35 +02006689 int cpu, ncpus, count;
6690 size_t setsize;
6691 cpu_set_t *mask = NULL;
6692 PyObject *res = NULL;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006693
Antoine Pitrou84869872012-08-04 16:16:35 +02006694 ncpus = NCPUS_START;
6695 while (1) {
6696 setsize = CPU_ALLOC_SIZE(ncpus);
6697 mask = CPU_ALLOC(ncpus);
6698 if (mask == NULL)
6699 return PyErr_NoMemory();
6700 if (sched_getaffinity(pid, setsize, mask) == 0)
6701 break;
6702 CPU_FREE(mask);
6703 if (errno != EINVAL)
6704 return posix_error();
6705 if (ncpus > INT_MAX / 2) {
6706 PyErr_SetString(PyExc_OverflowError, "could not allocate "
6707 "a large enough CPU set");
6708 return NULL;
6709 }
6710 ncpus = ncpus * 2;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006711 }
Antoine Pitrou84869872012-08-04 16:16:35 +02006712
6713 res = PySet_New(NULL);
6714 if (res == NULL)
6715 goto error;
6716 for (cpu = 0, count = CPU_COUNT_S(setsize, mask); count; cpu++) {
6717 if (CPU_ISSET_S(cpu, setsize, mask)) {
6718 PyObject *cpu_num = PyLong_FromLong(cpu);
6719 --count;
6720 if (cpu_num == NULL)
6721 goto error;
6722 if (PySet_Add(res, cpu_num)) {
6723 Py_DECREF(cpu_num);
6724 goto error;
6725 }
6726 Py_DECREF(cpu_num);
6727 }
6728 }
6729 CPU_FREE(mask);
6730 return res;
6731
6732error:
6733 if (mask)
6734 CPU_FREE(mask);
6735 Py_XDECREF(res);
6736 return NULL;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006737}
6738
Benjamin Peterson2740af82011-08-02 17:41:34 -05006739#endif /* HAVE_SCHED_SETAFFINITY */
6740
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006741#endif /* HAVE_SCHED_H */
6742
Larry Hastings2f936352014-08-05 14:04:04 +10006743
Neal Norwitzb59798b2003-03-21 01:43:31 +00006744/* AIX uses /dev/ptc but is otherwise the same as /dev/ptmx */
Neal Norwitz2deaddb2003-03-21 03:08:31 +00006745/* IRIX has both /dev/ptc and /dev/ptmx, use ptmx */
6746#if defined(HAVE_DEV_PTC) && !defined(HAVE_DEV_PTMX)
Neal Norwitzb59798b2003-03-21 01:43:31 +00006747#define DEV_PTY_FILE "/dev/ptc"
6748#define HAVE_DEV_PTMX
6749#else
6750#define DEV_PTY_FILE "/dev/ptmx"
6751#endif
6752
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006753#if defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) || defined(HAVE_DEV_PTMX)
Fred Drake8cef4cf2000-06-28 16:40:38 +00006754#ifdef HAVE_PTY_H
6755#include <pty.h>
6756#else
6757#ifdef HAVE_LIBUTIL_H
6758#include <libutil.h>
Ronald Oussoren755740f2010-02-07 19:56:39 +00006759#else
6760#ifdef HAVE_UTIL_H
6761#include <util.h>
6762#endif /* HAVE_UTIL_H */
Fred Drake8cef4cf2000-06-28 16:40:38 +00006763#endif /* HAVE_LIBUTIL_H */
6764#endif /* HAVE_PTY_H */
Martin v. Löwis14e73b12003-01-01 09:51:12 +00006765#ifdef HAVE_STROPTS_H
6766#include <stropts.h>
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006767#endif
ngie-eign7745ec42018-02-14 11:54:28 -08006768#endif /* defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) || defined(HAVE_DEV_PTMX) */
Fred Drake8cef4cf2000-06-28 16:40:38 +00006769
Larry Hastings2f936352014-08-05 14:04:04 +10006770
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006771#if defined(HAVE_OPENPTY) || defined(HAVE__GETPTY) || defined(HAVE_DEV_PTMX)
Larry Hastings2f936352014-08-05 14:04:04 +10006772/*[clinic input]
6773os.openpty
6774
6775Open a pseudo-terminal.
6776
6777Return a tuple of (master_fd, slave_fd) containing open file descriptors
6778for both the master and slave ends.
6779[clinic start generated code]*/
6780
Larry Hastings2f936352014-08-05 14:04:04 +10006781static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006782os_openpty_impl(PyObject *module)
6783/*[clinic end generated code: output=98841ce5ec9cef3c input=f3d99fd99e762907]*/
Fred Drake8cef4cf2000-06-28 16:40:38 +00006784{
Victor Stinnerdaf45552013-08-28 00:53:59 +02006785 int master_fd = -1, slave_fd = -1;
Thomas Wouters70c21a12000-07-14 14:28:33 +00006786#ifndef HAVE_OPENPTY
Victor Stinner8c62be82010-05-06 00:08:46 +00006787 char * slave_name;
Thomas Wouters70c21a12000-07-14 14:28:33 +00006788#endif
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006789#if defined(HAVE_DEV_PTMX) && !defined(HAVE_OPENPTY) && !defined(HAVE__GETPTY)
Victor Stinner8c62be82010-05-06 00:08:46 +00006790 PyOS_sighandler_t sig_saved;
Jakub Kulík6f9bc722018-12-31 03:16:40 +01006791#if defined(__sun) && defined(__SVR4)
Victor Stinner8c62be82010-05-06 00:08:46 +00006792 extern char *ptsname(int fildes);
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006793#endif
6794#endif
Thomas Wouters70c21a12000-07-14 14:28:33 +00006795
Thomas Wouters70c21a12000-07-14 14:28:33 +00006796#ifdef HAVE_OPENPTY
Victor Stinner8c62be82010-05-06 00:08:46 +00006797 if (openpty(&master_fd, &slave_fd, NULL, NULL, NULL) != 0)
Victor Stinnerdaf45552013-08-28 00:53:59 +02006798 goto posix_error;
6799
6800 if (_Py_set_inheritable(master_fd, 0, NULL) < 0)
6801 goto error;
6802 if (_Py_set_inheritable(slave_fd, 0, NULL) < 0)
6803 goto error;
6804
Neal Norwitzb59798b2003-03-21 01:43:31 +00006805#elif defined(HAVE__GETPTY)
Victor Stinner8c62be82010-05-06 00:08:46 +00006806 slave_name = _getpty(&master_fd, O_RDWR, 0666, 0);
6807 if (slave_name == NULL)
Victor Stinnerdaf45552013-08-28 00:53:59 +02006808 goto posix_error;
6809 if (_Py_set_inheritable(master_fd, 0, NULL) < 0)
6810 goto error;
Thomas Wouters70c21a12000-07-14 14:28:33 +00006811
Victor Stinnerdaf45552013-08-28 00:53:59 +02006812 slave_fd = _Py_open(slave_name, O_RDWR);
Victor Stinner8c62be82010-05-06 00:08:46 +00006813 if (slave_fd < 0)
Victor Stinnera555cfc2015-03-18 00:22:14 +01006814 goto error;
Victor Stinnerdaf45552013-08-28 00:53:59 +02006815
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006816#else
Victor Stinner000de532013-11-25 23:19:58 +01006817 master_fd = open(DEV_PTY_FILE, O_RDWR | O_NOCTTY); /* open master */
Victor Stinner8c62be82010-05-06 00:08:46 +00006818 if (master_fd < 0)
Victor Stinnerdaf45552013-08-28 00:53:59 +02006819 goto posix_error;
6820
Victor Stinner8c62be82010-05-06 00:08:46 +00006821 sig_saved = PyOS_setsig(SIGCHLD, SIG_DFL);
Victor Stinnerdaf45552013-08-28 00:53:59 +02006822
Victor Stinner8c62be82010-05-06 00:08:46 +00006823 /* change permission of slave */
6824 if (grantpt(master_fd) < 0) {
6825 PyOS_setsig(SIGCHLD, sig_saved);
Victor Stinnerdaf45552013-08-28 00:53:59 +02006826 goto posix_error;
Victor Stinner8c62be82010-05-06 00:08:46 +00006827 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02006828
Victor Stinner8c62be82010-05-06 00:08:46 +00006829 /* unlock slave */
6830 if (unlockpt(master_fd) < 0) {
6831 PyOS_setsig(SIGCHLD, sig_saved);
Victor Stinnerdaf45552013-08-28 00:53:59 +02006832 goto posix_error;
Victor Stinner8c62be82010-05-06 00:08:46 +00006833 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02006834
Victor Stinner8c62be82010-05-06 00:08:46 +00006835 PyOS_setsig(SIGCHLD, sig_saved);
Victor Stinnerdaf45552013-08-28 00:53:59 +02006836
Victor Stinner8c62be82010-05-06 00:08:46 +00006837 slave_name = ptsname(master_fd); /* get name of slave */
6838 if (slave_name == NULL)
Victor Stinnerdaf45552013-08-28 00:53:59 +02006839 goto posix_error;
6840
6841 slave_fd = _Py_open(slave_name, O_RDWR | O_NOCTTY); /* open slave */
Victor Stinnera555cfc2015-03-18 00:22:14 +01006842 if (slave_fd == -1)
6843 goto error;
Victor Stinner000de532013-11-25 23:19:58 +01006844
6845 if (_Py_set_inheritable(master_fd, 0, NULL) < 0)
6846 goto posix_error;
6847
Stefan Krahfb7c8ae2016-04-26 17:04:18 +02006848#if !defined(__CYGWIN__) && !defined(__ANDROID__) && !defined(HAVE_DEV_PTC)
Victor Stinner8c62be82010-05-06 00:08:46 +00006849 ioctl(slave_fd, I_PUSH, "ptem"); /* push ptem */
6850 ioctl(slave_fd, I_PUSH, "ldterm"); /* push ldterm */
Neal Norwitz6700e472002-12-31 16:16:07 +00006851#ifndef __hpux
Victor Stinner8c62be82010-05-06 00:08:46 +00006852 ioctl(slave_fd, I_PUSH, "ttcompat"); /* push ttcompat */
Neal Norwitz6700e472002-12-31 16:16:07 +00006853#endif /* __hpux */
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006854#endif /* HAVE_CYGWIN */
Thomas Wouters1e0c2f42000-07-24 16:06:23 +00006855#endif /* HAVE_OPENPTY */
Thomas Wouters70c21a12000-07-14 14:28:33 +00006856
Victor Stinner8c62be82010-05-06 00:08:46 +00006857 return Py_BuildValue("(ii)", master_fd, slave_fd);
Thomas Wouters70c21a12000-07-14 14:28:33 +00006858
Victor Stinnerdaf45552013-08-28 00:53:59 +02006859posix_error:
6860 posix_error();
6861error:
6862 if (master_fd != -1)
6863 close(master_fd);
6864 if (slave_fd != -1)
6865 close(slave_fd);
6866 return NULL;
Fred Drake8cef4cf2000-06-28 16:40:38 +00006867}
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006868#endif /* defined(HAVE_OPENPTY) || defined(HAVE__GETPTY) || defined(HAVE_DEV_PTMX) */
Fred Drake8cef4cf2000-06-28 16:40:38 +00006869
Larry Hastings2f936352014-08-05 14:04:04 +10006870
Fred Drake8cef4cf2000-06-28 16:40:38 +00006871#ifdef HAVE_FORKPTY
Larry Hastings2f936352014-08-05 14:04:04 +10006872/*[clinic input]
6873os.forkpty
6874
6875Fork a new process with a new pseudo-terminal as controlling tty.
6876
6877Returns a tuple of (pid, master_fd).
6878Like fork(), return pid of 0 to the child process,
6879and pid of child to the parent process.
6880To both, return fd of newly opened pseudo-terminal.
6881[clinic start generated code]*/
6882
Larry Hastings2f936352014-08-05 14:04:04 +10006883static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006884os_forkpty_impl(PyObject *module)
6885/*[clinic end generated code: output=60d0a5c7512e4087 input=f1f7f4bae3966010]*/
Fred Drake8cef4cf2000-06-28 16:40:38 +00006886{
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006887 int master_fd = -1;
Victor Stinner8c62be82010-05-06 00:08:46 +00006888 pid_t pid;
Tim Peters5aa91602002-01-30 05:46:57 +00006889
Victor Stinner81a7be32020-04-14 15:14:01 +02006890 if (_PyInterpreterState_GET() != PyInterpreterState_Main()) {
Eric Snow59032962018-09-14 14:17:20 -07006891 PyErr_SetString(PyExc_RuntimeError, "fork not supported for subinterpreters");
6892 return NULL;
6893 }
Saiyang Gou7514f4f2020-02-12 23:47:42 -08006894 if (PySys_Audit("os.forkpty", NULL) < 0) {
6895 return NULL;
6896 }
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006897 PyOS_BeforeFork();
Victor Stinner8c62be82010-05-06 00:08:46 +00006898 pid = forkpty(&master_fd, NULL, NULL, NULL);
6899 if (pid == 0) {
6900 /* child: this clobbers and resets the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006901 PyOS_AfterFork_Child();
Victor Stinner8c62be82010-05-06 00:08:46 +00006902 } else {
6903 /* parent: release the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006904 PyOS_AfterFork_Parent();
Victor Stinner8c62be82010-05-06 00:08:46 +00006905 }
6906 if (pid == -1)
6907 return posix_error();
Victor Stinner8c62be82010-05-06 00:08:46 +00006908 return Py_BuildValue("(Ni)", PyLong_FromPid(pid), master_fd);
Fred Drake8cef4cf2000-06-28 16:40:38 +00006909}
Larry Hastings2f936352014-08-05 14:04:04 +10006910#endif /* HAVE_FORKPTY */
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006911
Ross Lagerwall7807c352011-03-17 20:20:30 +02006912
Guido van Rossumad0ee831995-03-01 10:34:45 +00006913#ifdef HAVE_GETEGID
Larry Hastings2f936352014-08-05 14:04:04 +10006914/*[clinic input]
6915os.getegid
6916
6917Return the current process's effective group id.
6918[clinic start generated code]*/
6919
Larry Hastings2f936352014-08-05 14:04:04 +10006920static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006921os_getegid_impl(PyObject *module)
6922/*[clinic end generated code: output=67d9be7ac68898a2 input=1596f79ad1107d5d]*/
Guido van Rossum46003ff1992-05-15 11:05:24 +00006923{
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006924 return _PyLong_FromGid(getegid());
Guido van Rossum46003ff1992-05-15 11:05:24 +00006925}
Larry Hastings2f936352014-08-05 14:04:04 +10006926#endif /* HAVE_GETEGID */
Guido van Rossum46003ff1992-05-15 11:05:24 +00006927
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006928
Guido van Rossumad0ee831995-03-01 10:34:45 +00006929#ifdef HAVE_GETEUID
Larry Hastings2f936352014-08-05 14:04:04 +10006930/*[clinic input]
6931os.geteuid
6932
6933Return the current process's effective user id.
6934[clinic start generated code]*/
6935
Larry Hastings2f936352014-08-05 14:04:04 +10006936static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006937os_geteuid_impl(PyObject *module)
6938/*[clinic end generated code: output=ea1b60f0d6abb66e input=4644c662d3bd9f19]*/
Guido van Rossum46003ff1992-05-15 11:05:24 +00006939{
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006940 return _PyLong_FromUid(geteuid());
Guido van Rossum46003ff1992-05-15 11:05:24 +00006941}
Larry Hastings2f936352014-08-05 14:04:04 +10006942#endif /* HAVE_GETEUID */
Guido van Rossum46003ff1992-05-15 11:05:24 +00006943
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006944
Guido van Rossumad0ee831995-03-01 10:34:45 +00006945#ifdef HAVE_GETGID
Larry Hastings2f936352014-08-05 14:04:04 +10006946/*[clinic input]
6947os.getgid
6948
6949Return the current process's group id.
6950[clinic start generated code]*/
6951
Larry Hastings2f936352014-08-05 14:04:04 +10006952static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006953os_getgid_impl(PyObject *module)
6954/*[clinic end generated code: output=4f28ebc9d3e5dfcf input=58796344cd87c0f6]*/
Guido van Rossum46003ff1992-05-15 11:05:24 +00006955{
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006956 return _PyLong_FromGid(getgid());
Guido van Rossum46003ff1992-05-15 11:05:24 +00006957}
Larry Hastings2f936352014-08-05 14:04:04 +10006958#endif /* HAVE_GETGID */
Guido van Rossum46003ff1992-05-15 11:05:24 +00006959
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006960
Berker Peksag39404992016-09-15 20:45:16 +03006961#ifdef HAVE_GETPID
Larry Hastings2f936352014-08-05 14:04:04 +10006962/*[clinic input]
6963os.getpid
6964
6965Return the current process id.
6966[clinic start generated code]*/
6967
Larry Hastings2f936352014-08-05 14:04:04 +10006968static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006969os_getpid_impl(PyObject *module)
6970/*[clinic end generated code: output=9ea6fdac01ed2b3c input=5a9a00f0ab68aa00]*/
Guido van Rossum85e3b011991-06-03 12:42:10 +00006971{
Victor Stinner8c62be82010-05-06 00:08:46 +00006972 return PyLong_FromPid(getpid());
Guido van Rossum85e3b011991-06-03 12:42:10 +00006973}
Berker Peksag39404992016-09-15 20:45:16 +03006974#endif /* HAVE_GETPID */
Guido van Rossum85e3b011991-06-03 12:42:10 +00006975
Jeffrey Kintscher8725c832019-06-13 00:01:29 -07006976#ifdef NGROUPS_MAX
6977#define MAX_GROUPS NGROUPS_MAX
6978#else
6979 /* defined to be 16 on Solaris7, so this should be a small number */
6980#define MAX_GROUPS 64
6981#endif
6982
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006983#ifdef HAVE_GETGROUPLIST
Larry Hastings2f936352014-08-05 14:04:04 +10006984
Serhiy Storchaka2b560312020-04-18 19:14:10 +03006985#ifdef __APPLE__
6986/*[clinic input]
6987os.getgrouplist
6988
6989 user: str
6990 username to lookup
6991 group as basegid: int
6992 base group id of the user
6993 /
6994
6995Returns a list of groups to which a user belongs.
6996[clinic start generated code]*/
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006997
6998static PyObject *
Serhiy Storchaka2b560312020-04-18 19:14:10 +03006999os_getgrouplist_impl(PyObject *module, const char *user, int basegid)
7000/*[clinic end generated code: output=6e734697b8c26de0 input=f8d870374b09a490]*/
7001#else
7002/*[clinic input]
7003os.getgrouplist
7004
7005 user: str
7006 username to lookup
7007 group as basegid: gid_t
7008 base group id of the user
7009 /
7010
7011Returns a list of groups to which a user belongs.
7012[clinic start generated code]*/
7013
7014static PyObject *
7015os_getgrouplist_impl(PyObject *module, const char *user, gid_t basegid)
7016/*[clinic end generated code: output=0ebd7fb70115575b input=cc61d5c20b08958d]*/
7017#endif
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02007018{
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02007019 int i, ngroups;
7020 PyObject *list;
7021#ifdef __APPLE__
Serhiy Storchaka2b560312020-04-18 19:14:10 +03007022 int *groups;
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02007023#else
Serhiy Storchaka2b560312020-04-18 19:14:10 +03007024 gid_t *groups;
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02007025#endif
Jeffrey Kintscher8725c832019-06-13 00:01:29 -07007026
7027 /*
7028 * NGROUPS_MAX is defined by POSIX.1 as the maximum
7029 * number of supplimental groups a users can belong to.
7030 * We have to increment it by one because
7031 * getgrouplist() returns both the supplemental groups
7032 * and the primary group, i.e. all of the groups the
7033 * user belongs to.
7034 */
7035 ngroups = 1 + MAX_GROUPS;
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02007036
Victor Stinnerf5c7cab2020-03-24 18:22:10 +01007037 while (1) {
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02007038#ifdef __APPLE__
Victor Stinner8ec73702020-03-23 20:00:57 +01007039 groups = PyMem_New(int, ngroups);
Victor Stinnerf5c7cab2020-03-24 18:22:10 +01007040#else
7041 groups = PyMem_New(gid_t, ngroups);
7042#endif
Victor Stinner8ec73702020-03-23 20:00:57 +01007043 if (groups == NULL) {
7044 return PyErr_NoMemory();
7045 }
Victor Stinnerf5c7cab2020-03-24 18:22:10 +01007046
7047 int old_ngroups = ngroups;
7048 if (getgrouplist(user, basegid, groups, &ngroups) != -1) {
7049 /* Success */
7050 break;
7051 }
7052
7053 /* getgrouplist() fails if the group list is too small */
7054 PyMem_Free(groups);
7055
7056 if (ngroups > old_ngroups) {
7057 /* If the group list is too small, the glibc implementation of
7058 getgrouplist() sets ngroups to the total number of groups and
7059 returns -1. */
7060 }
7061 else {
7062 /* Double the group list size */
7063 if (ngroups > INT_MAX / 2) {
7064 return PyErr_NoMemory();
7065 }
7066 ngroups *= 2;
7067 }
7068
7069 /* Retry getgrouplist() with a larger group list */
Victor Stinner8ec73702020-03-23 20:00:57 +01007070 }
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02007071
Gregory P. Smith1d300ce2018-12-30 21:13:02 -08007072#ifdef _Py_MEMORY_SANITIZER
7073 /* Clang memory sanitizer libc intercepts don't know getgrouplist. */
7074 __msan_unpoison(&ngroups, sizeof(ngroups));
7075 __msan_unpoison(groups, ngroups*sizeof(*groups));
7076#endif
7077
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02007078 list = PyList_New(ngroups);
7079 if (list == NULL) {
7080 PyMem_Del(groups);
7081 return NULL;
7082 }
7083
7084 for (i = 0; i < ngroups; i++) {
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02007085#ifdef __APPLE__
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02007086 PyObject *o = PyLong_FromUnsignedLong((unsigned long)groups[i]);
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02007087#else
7088 PyObject *o = _PyLong_FromGid(groups[i]);
7089#endif
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02007090 if (o == NULL) {
7091 Py_DECREF(list);
7092 PyMem_Del(groups);
7093 return NULL;
7094 }
7095 PyList_SET_ITEM(list, i, o);
7096 }
7097
7098 PyMem_Del(groups);
7099
7100 return list;
7101}
Larry Hastings2f936352014-08-05 14:04:04 +10007102#endif /* HAVE_GETGROUPLIST */
7103
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007104
Fred Drakec9680921999-12-13 16:37:25 +00007105#ifdef HAVE_GETGROUPS
Larry Hastings2f936352014-08-05 14:04:04 +10007106/*[clinic input]
7107os.getgroups
7108
7109Return list of supplemental group IDs for the process.
7110[clinic start generated code]*/
7111
Larry Hastings2f936352014-08-05 14:04:04 +10007112static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007113os_getgroups_impl(PyObject *module)
7114/*[clinic end generated code: output=42b0c17758561b56 input=d3f109412e6a155c]*/
Fred Drakec9680921999-12-13 16:37:25 +00007115{
7116 PyObject *result = NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00007117 gid_t grouplist[MAX_GROUPS];
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00007118
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00007119 /* On MacOSX getgroups(2) can return more than MAX_GROUPS results
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00007120 * This is a helper variable to store the intermediate result when
7121 * that happens.
7122 *
7123 * To keep the code readable the OSX behaviour is unconditional,
7124 * according to the POSIX spec this should be safe on all unix-y
7125 * systems.
7126 */
7127 gid_t* alt_grouplist = grouplist;
Victor Stinner8c62be82010-05-06 00:08:46 +00007128 int n;
Fred Drakec9680921999-12-13 16:37:25 +00007129
Ned Deilyb5dd6d22013-08-01 21:21:15 -07007130#ifdef __APPLE__
7131 /* Issue #17557: As of OS X 10.8, getgroups(2) no longer raises EINVAL if
7132 * there are more groups than can fit in grouplist. Therefore, on OS X
7133 * always first call getgroups with length 0 to get the actual number
7134 * of groups.
7135 */
7136 n = getgroups(0, NULL);
7137 if (n < 0) {
7138 return posix_error();
7139 } else if (n <= MAX_GROUPS) {
7140 /* groups will fit in existing array */
7141 alt_grouplist = grouplist;
7142 } else {
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02007143 alt_grouplist = PyMem_New(gid_t, n);
Ned Deilyb5dd6d22013-08-01 21:21:15 -07007144 if (alt_grouplist == NULL) {
Zackery Spytz4c49da02018-12-07 03:11:30 -07007145 return PyErr_NoMemory();
Ned Deilyb5dd6d22013-08-01 21:21:15 -07007146 }
7147 }
7148
7149 n = getgroups(n, alt_grouplist);
7150 if (n == -1) {
7151 if (alt_grouplist != grouplist) {
7152 PyMem_Free(alt_grouplist);
7153 }
7154 return posix_error();
7155 }
7156#else
Victor Stinner8c62be82010-05-06 00:08:46 +00007157 n = getgroups(MAX_GROUPS, grouplist);
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00007158 if (n < 0) {
7159 if (errno == EINVAL) {
7160 n = getgroups(0, NULL);
7161 if (n == -1) {
7162 return posix_error();
7163 }
7164 if (n == 0) {
7165 /* Avoid malloc(0) */
7166 alt_grouplist = grouplist;
7167 } else {
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02007168 alt_grouplist = PyMem_New(gid_t, n);
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00007169 if (alt_grouplist == NULL) {
Zackery Spytz4c49da02018-12-07 03:11:30 -07007170 return PyErr_NoMemory();
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00007171 }
7172 n = getgroups(n, alt_grouplist);
7173 if (n == -1) {
7174 PyMem_Free(alt_grouplist);
7175 return posix_error();
7176 }
7177 }
7178 } else {
7179 return posix_error();
7180 }
7181 }
Ned Deilyb5dd6d22013-08-01 21:21:15 -07007182#endif
7183
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00007184 result = PyList_New(n);
7185 if (result != NULL) {
Victor Stinner8c62be82010-05-06 00:08:46 +00007186 int i;
7187 for (i = 0; i < n; ++i) {
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02007188 PyObject *o = _PyLong_FromGid(alt_grouplist[i]);
Victor Stinner8c62be82010-05-06 00:08:46 +00007189 if (o == NULL) {
Stefan Krah0e803b32010-11-26 16:16:47 +00007190 Py_DECREF(result);
7191 result = NULL;
7192 break;
Fred Drakec9680921999-12-13 16:37:25 +00007193 }
Victor Stinner8c62be82010-05-06 00:08:46 +00007194 PyList_SET_ITEM(result, i, o);
Fred Drakec9680921999-12-13 16:37:25 +00007195 }
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00007196 }
7197
7198 if (alt_grouplist != grouplist) {
7199 PyMem_Free(alt_grouplist);
Victor Stinner8c62be82010-05-06 00:08:46 +00007200 }
Neal Norwitze241ce82003-02-17 18:17:05 +00007201
Fred Drakec9680921999-12-13 16:37:25 +00007202 return result;
7203}
Larry Hastings2f936352014-08-05 14:04:04 +10007204#endif /* HAVE_GETGROUPS */
Fred Drakec9680921999-12-13 16:37:25 +00007205
Antoine Pitroub7572f02009-12-02 20:46:48 +00007206#ifdef HAVE_INITGROUPS
Serhiy Storchaka2b560312020-04-18 19:14:10 +03007207#ifdef __APPLE__
7208/*[clinic input]
7209os.initgroups
Antoine Pitroub7572f02009-12-02 20:46:48 +00007210
Serhiy Storchaka2b560312020-04-18 19:14:10 +03007211 username as oname: FSConverter
7212 gid: int
7213 /
7214
7215Initialize the group access list.
7216
7217Call the system initgroups() to initialize the group access list with all of
7218the groups of which the specified username is a member, plus the specified
7219group id.
7220[clinic start generated code]*/
7221
Antoine Pitroub7572f02009-12-02 20:46:48 +00007222static PyObject *
Serhiy Storchaka2b560312020-04-18 19:14:10 +03007223os_initgroups_impl(PyObject *module, PyObject *oname, int gid)
7224/*[clinic end generated code: output=7f074d30a425fd3a input=df3d54331b0af204]*/
7225#else
7226/*[clinic input]
7227os.initgroups
7228
7229 username as oname: FSConverter
7230 gid: gid_t
7231 /
7232
7233Initialize the group access list.
7234
7235Call the system initgroups() to initialize the group access list with all of
7236the groups of which the specified username is a member, plus the specified
7237group id.
7238[clinic start generated code]*/
7239
7240static PyObject *
7241os_initgroups_impl(PyObject *module, PyObject *oname, gid_t gid)
7242/*[clinic end generated code: output=59341244521a9e3f input=0cb91bdc59a4c564]*/
7243#endif
Antoine Pitroub7572f02009-12-02 20:46:48 +00007244{
Serhiy Storchaka2b560312020-04-18 19:14:10 +03007245 const char *username = PyBytes_AS_STRING(oname);
Antoine Pitroub7572f02009-12-02 20:46:48 +00007246
Serhiy Storchaka2b560312020-04-18 19:14:10 +03007247 if (initgroups(username, gid) == -1)
Victor Stinner8c62be82010-05-06 00:08:46 +00007248 return PyErr_SetFromErrno(PyExc_OSError);
Antoine Pitroub7572f02009-12-02 20:46:48 +00007249
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02007250 Py_RETURN_NONE;
Antoine Pitroub7572f02009-12-02 20:46:48 +00007251}
Larry Hastings2f936352014-08-05 14:04:04 +10007252#endif /* HAVE_INITGROUPS */
7253
Antoine Pitroub7572f02009-12-02 20:46:48 +00007254
Martin v. Löwis606edc12002-06-13 21:09:11 +00007255#ifdef HAVE_GETPGID
Larry Hastings2f936352014-08-05 14:04:04 +10007256/*[clinic input]
7257os.getpgid
7258
7259 pid: pid_t
7260
7261Call the system call getpgid(), and return the result.
7262[clinic start generated code]*/
7263
Larry Hastings2f936352014-08-05 14:04:04 +10007264static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007265os_getpgid_impl(PyObject *module, pid_t pid)
7266/*[clinic end generated code: output=1db95a97be205d18 input=39d710ae3baaf1c7]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007267{
7268 pid_t pgid = getpgid(pid);
Victor Stinner8c62be82010-05-06 00:08:46 +00007269 if (pgid < 0)
7270 return posix_error();
7271 return PyLong_FromPid(pgid);
Martin v. Löwis606edc12002-06-13 21:09:11 +00007272}
7273#endif /* HAVE_GETPGID */
7274
7275
Guido van Rossumb6775db1994-08-01 11:34:53 +00007276#ifdef HAVE_GETPGRP
Larry Hastings2f936352014-08-05 14:04:04 +10007277/*[clinic input]
7278os.getpgrp
7279
7280Return the current process group id.
7281[clinic start generated code]*/
7282
Larry Hastings2f936352014-08-05 14:04:04 +10007283static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007284os_getpgrp_impl(PyObject *module)
7285/*[clinic end generated code: output=c4fc381e51103cf3 input=6846fb2bb9a3705e]*/
Guido van Rossum04814471991-06-04 20:23:49 +00007286{
Guido van Rossumb6775db1994-08-01 11:34:53 +00007287#ifdef GETPGRP_HAVE_ARG
Victor Stinner8c62be82010-05-06 00:08:46 +00007288 return PyLong_FromPid(getpgrp(0));
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00007289#else /* GETPGRP_HAVE_ARG */
Victor Stinner8c62be82010-05-06 00:08:46 +00007290 return PyLong_FromPid(getpgrp());
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00007291#endif /* GETPGRP_HAVE_ARG */
Guido van Rossum04814471991-06-04 20:23:49 +00007292}
Guido van Rossumb6775db1994-08-01 11:34:53 +00007293#endif /* HAVE_GETPGRP */
Guido van Rossum04814471991-06-04 20:23:49 +00007294
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007295
Guido van Rossumb6775db1994-08-01 11:34:53 +00007296#ifdef HAVE_SETPGRP
Larry Hastings2f936352014-08-05 14:04:04 +10007297/*[clinic input]
7298os.setpgrp
7299
7300Make the current process the leader of its process group.
7301[clinic start generated code]*/
7302
Larry Hastings2f936352014-08-05 14:04:04 +10007303static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007304os_setpgrp_impl(PyObject *module)
7305/*[clinic end generated code: output=2554735b0a60f0a0 input=1f0619fcb5731e7e]*/
Guido van Rossumc2670a01992-09-13 20:07:29 +00007306{
Guido van Rossum64933891994-10-20 21:56:42 +00007307#ifdef SETPGRP_HAVE_ARG
Victor Stinner8c62be82010-05-06 00:08:46 +00007308 if (setpgrp(0, 0) < 0)
Guido van Rossum64933891994-10-20 21:56:42 +00007309#else /* SETPGRP_HAVE_ARG */
Victor Stinner8c62be82010-05-06 00:08:46 +00007310 if (setpgrp() < 0)
Guido van Rossum64933891994-10-20 21:56:42 +00007311#endif /* SETPGRP_HAVE_ARG */
Victor Stinner8c62be82010-05-06 00:08:46 +00007312 return posix_error();
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02007313 Py_RETURN_NONE;
Guido van Rossumc2670a01992-09-13 20:07:29 +00007314}
Guido van Rossumb6775db1994-08-01 11:34:53 +00007315#endif /* HAVE_SETPGRP */
7316
Guido van Rossumad0ee831995-03-01 10:34:45 +00007317#ifdef HAVE_GETPPID
Amaury Forgeot d'Arc4b6fdf32010-09-07 21:31:17 +00007318
7319#ifdef MS_WINDOWS
7320#include <tlhelp32.h>
7321
7322static PyObject*
7323win32_getppid()
7324{
7325 HANDLE snapshot;
7326 pid_t mypid;
7327 PyObject* result = NULL;
7328 BOOL have_record;
7329 PROCESSENTRY32 pe;
7330
7331 mypid = getpid(); /* This function never fails */
7332
7333 snapshot = CreateToolhelp32Snapshot(TH32CS_SNAPPROCESS, 0);
7334 if (snapshot == INVALID_HANDLE_VALUE)
7335 return PyErr_SetFromWindowsErr(GetLastError());
7336
7337 pe.dwSize = sizeof(pe);
7338 have_record = Process32First(snapshot, &pe);
7339 while (have_record) {
7340 if (mypid == (pid_t)pe.th32ProcessID) {
7341 /* We could cache the ulong value in a static variable. */
7342 result = PyLong_FromPid((pid_t)pe.th32ParentProcessID);
7343 break;
7344 }
7345
7346 have_record = Process32Next(snapshot, &pe);
7347 }
7348
7349 /* If our loop exits and our pid was not found (result will be NULL)
7350 * then GetLastError will return ERROR_NO_MORE_FILES. This is an
7351 * error anyway, so let's raise it. */
7352 if (!result)
7353 result = PyErr_SetFromWindowsErr(GetLastError());
7354
7355 CloseHandle(snapshot);
7356
7357 return result;
7358}
7359#endif /*MS_WINDOWS*/
7360
Larry Hastings2f936352014-08-05 14:04:04 +10007361
7362/*[clinic input]
7363os.getppid
7364
7365Return the parent's process id.
7366
7367If the parent process has already exited, Windows machines will still
7368return its id; others systems will return the id of the 'init' process (1).
7369[clinic start generated code]*/
7370
Larry Hastings2f936352014-08-05 14:04:04 +10007371static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007372os_getppid_impl(PyObject *module)
7373/*[clinic end generated code: output=43b2a946a8c603b4 input=e637cb87539c030e]*/
Guido van Rossum85e3b011991-06-03 12:42:10 +00007374{
Amaury Forgeot d'Arc4b6fdf32010-09-07 21:31:17 +00007375#ifdef MS_WINDOWS
7376 return win32_getppid();
7377#else
Victor Stinner8c62be82010-05-06 00:08:46 +00007378 return PyLong_FromPid(getppid());
Guido van Rossumad0ee831995-03-01 10:34:45 +00007379#endif
Amaury Forgeot d'Arc4b6fdf32010-09-07 21:31:17 +00007380}
7381#endif /* HAVE_GETPPID */
Guido van Rossum85e3b011991-06-03 12:42:10 +00007382
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007383
Fred Drake12c6e2d1999-12-14 21:25:03 +00007384#ifdef HAVE_GETLOGIN
Larry Hastings2f936352014-08-05 14:04:04 +10007385/*[clinic input]
7386os.getlogin
7387
7388Return the actual login name.
7389[clinic start generated code]*/
7390
Larry Hastings2f936352014-08-05 14:04:04 +10007391static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007392os_getlogin_impl(PyObject *module)
7393/*[clinic end generated code: output=a32e66a7e5715dac input=2a21ab1e917163df]*/
Fred Drake12c6e2d1999-12-14 21:25:03 +00007394{
Victor Stinner8c62be82010-05-06 00:08:46 +00007395 PyObject *result = NULL;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00007396#ifdef MS_WINDOWS
Brian Curtine8e4b3b2010-09-23 20:04:14 +00007397 wchar_t user_name[UNLEN + 1];
Victor Stinner63941882011-09-29 00:42:28 +02007398 DWORD num_chars = Py_ARRAY_LENGTH(user_name);
Brian Curtine8e4b3b2010-09-23 20:04:14 +00007399
7400 if (GetUserNameW(user_name, &num_chars)) {
7401 /* num_chars is the number of unicode chars plus null terminator */
7402 result = PyUnicode_FromWideChar(user_name, num_chars - 1);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00007403 }
7404 else
Brian Curtine8e4b3b2010-09-23 20:04:14 +00007405 result = PyErr_SetFromWindowsErr(GetLastError());
7406#else
Victor Stinner8c62be82010-05-06 00:08:46 +00007407 char *name;
7408 int old_errno = errno;
Fred Drake12c6e2d1999-12-14 21:25:03 +00007409
Victor Stinner8c62be82010-05-06 00:08:46 +00007410 errno = 0;
7411 name = getlogin();
7412 if (name == NULL) {
7413 if (errno)
Victor Stinnere039ffe2010-08-15 09:33:08 +00007414 posix_error();
Fred Drake12c6e2d1999-12-14 21:25:03 +00007415 else
Victor Stinnere039ffe2010-08-15 09:33:08 +00007416 PyErr_SetString(PyExc_OSError, "unable to determine login name");
Victor Stinner8c62be82010-05-06 00:08:46 +00007417 }
7418 else
Victor Stinnere039ffe2010-08-15 09:33:08 +00007419 result = PyUnicode_DecodeFSDefault(name);
Victor Stinner8c62be82010-05-06 00:08:46 +00007420 errno = old_errno;
Brian Curtine8e4b3b2010-09-23 20:04:14 +00007421#endif
Fred Drake12c6e2d1999-12-14 21:25:03 +00007422 return result;
7423}
Brian Curtine8e4b3b2010-09-23 20:04:14 +00007424#endif /* HAVE_GETLOGIN */
Fred Drake12c6e2d1999-12-14 21:25:03 +00007425
Larry Hastings2f936352014-08-05 14:04:04 +10007426
Guido van Rossumad0ee831995-03-01 10:34:45 +00007427#ifdef HAVE_GETUID
Larry Hastings2f936352014-08-05 14:04:04 +10007428/*[clinic input]
7429os.getuid
7430
7431Return the current process's user id.
7432[clinic start generated code]*/
7433
Larry Hastings2f936352014-08-05 14:04:04 +10007434static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007435os_getuid_impl(PyObject *module)
7436/*[clinic end generated code: output=415c0b401ebed11a input=b53c8b35f110a516]*/
Guido van Rossum46003ff1992-05-15 11:05:24 +00007437{
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02007438 return _PyLong_FromUid(getuid());
Guido van Rossum46003ff1992-05-15 11:05:24 +00007439}
Larry Hastings2f936352014-08-05 14:04:04 +10007440#endif /* HAVE_GETUID */
Guido van Rossum46003ff1992-05-15 11:05:24 +00007441
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007442
Brian Curtineb24d742010-04-12 17:16:38 +00007443#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10007444#define HAVE_KILL
7445#endif /* MS_WINDOWS */
7446
7447#ifdef HAVE_KILL
7448/*[clinic input]
7449os.kill
7450
7451 pid: pid_t
7452 signal: Py_ssize_t
7453 /
7454
7455Kill a process with a signal.
7456[clinic start generated code]*/
7457
Larry Hastings2f936352014-08-05 14:04:04 +10007458static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007459os_kill_impl(PyObject *module, pid_t pid, Py_ssize_t signal)
7460/*[clinic end generated code: output=8e346a6701c88568 input=61a36b86ca275ab9]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007461{
Saiyang Gou7514f4f2020-02-12 23:47:42 -08007462 if (PySys_Audit("os.kill", "in", pid, signal) < 0) {
7463 return NULL;
7464 }
7465#ifndef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10007466 if (kill(pid, (int)signal) == -1)
7467 return posix_error();
7468 Py_RETURN_NONE;
Larry Hastings2f936352014-08-05 14:04:04 +10007469#else /* !MS_WINDOWS */
Amaury Forgeot d'Arc0a589c92010-05-15 20:35:12 +00007470 PyObject *result;
Larry Hastings2f936352014-08-05 14:04:04 +10007471 DWORD sig = (DWORD)signal;
7472 DWORD err;
Victor Stinner8c62be82010-05-06 00:08:46 +00007473 HANDLE handle;
Brian Curtineb24d742010-04-12 17:16:38 +00007474
Victor Stinner8c62be82010-05-06 00:08:46 +00007475 /* Console processes which share a common console can be sent CTRL+C or
7476 CTRL+BREAK events, provided they handle said events. */
7477 if (sig == CTRL_C_EVENT || sig == CTRL_BREAK_EVENT) {
Richard Oudkerkac0ad882013-06-05 23:29:30 +01007478 if (GenerateConsoleCtrlEvent(sig, (DWORD)pid) == 0) {
Victor Stinner8c62be82010-05-06 00:08:46 +00007479 err = GetLastError();
7480 PyErr_SetFromWindowsErr(err);
7481 }
7482 else
7483 Py_RETURN_NONE;
7484 }
Brian Curtineb24d742010-04-12 17:16:38 +00007485
Victor Stinner8c62be82010-05-06 00:08:46 +00007486 /* If the signal is outside of what GenerateConsoleCtrlEvent can use,
7487 attempt to open and terminate the process. */
Richard Oudkerkac0ad882013-06-05 23:29:30 +01007488 handle = OpenProcess(PROCESS_ALL_ACCESS, FALSE, (DWORD)pid);
Victor Stinner8c62be82010-05-06 00:08:46 +00007489 if (handle == NULL) {
7490 err = GetLastError();
7491 return PyErr_SetFromWindowsErr(err);
7492 }
Brian Curtineb24d742010-04-12 17:16:38 +00007493
Victor Stinner8c62be82010-05-06 00:08:46 +00007494 if (TerminateProcess(handle, sig) == 0) {
7495 err = GetLastError();
7496 result = PyErr_SetFromWindowsErr(err);
7497 } else {
7498 Py_INCREF(Py_None);
7499 result = Py_None;
7500 }
Brian Curtineb24d742010-04-12 17:16:38 +00007501
Victor Stinner8c62be82010-05-06 00:08:46 +00007502 CloseHandle(handle);
7503 return result;
Larry Hastings2f936352014-08-05 14:04:04 +10007504#endif /* !MS_WINDOWS */
Saiyang Gou7514f4f2020-02-12 23:47:42 -08007505}
Larry Hastings2f936352014-08-05 14:04:04 +10007506#endif /* HAVE_KILL */
7507
7508
7509#ifdef HAVE_KILLPG
7510/*[clinic input]
7511os.killpg
7512
7513 pgid: pid_t
7514 signal: int
7515 /
7516
7517Kill a process group with a signal.
7518[clinic start generated code]*/
7519
Larry Hastings2f936352014-08-05 14:04:04 +10007520static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007521os_killpg_impl(PyObject *module, pid_t pgid, int signal)
7522/*[clinic end generated code: output=6dbcd2f1fdf5fdba input=38b5449eb8faec19]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007523{
Saiyang Gou7514f4f2020-02-12 23:47:42 -08007524 if (PySys_Audit("os.killpg", "ii", pgid, signal) < 0) {
7525 return NULL;
7526 }
Larry Hastings2f936352014-08-05 14:04:04 +10007527 /* XXX some man pages make the `pgid` parameter an int, others
7528 a pid_t. Since getpgrp() returns a pid_t, we assume killpg should
7529 take the same type. Moreover, pid_t is always at least as wide as
7530 int (else compilation of this module fails), which is safe. */
7531 if (killpg(pgid, signal) == -1)
7532 return posix_error();
7533 Py_RETURN_NONE;
7534}
7535#endif /* HAVE_KILLPG */
7536
Brian Curtineb24d742010-04-12 17:16:38 +00007537
Guido van Rossumc0125471996-06-28 18:55:32 +00007538#ifdef HAVE_PLOCK
Guido van Rossumc0125471996-06-28 18:55:32 +00007539#ifdef HAVE_SYS_LOCK_H
7540#include <sys/lock.h>
7541#endif
7542
Larry Hastings2f936352014-08-05 14:04:04 +10007543/*[clinic input]
7544os.plock
7545 op: int
7546 /
7547
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00007548Lock program segments into memory.");
Larry Hastings2f936352014-08-05 14:04:04 +10007549[clinic start generated code]*/
7550
Larry Hastings2f936352014-08-05 14:04:04 +10007551static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007552os_plock_impl(PyObject *module, int op)
7553/*[clinic end generated code: output=81424167033b168e input=e6e5e348e1525f60]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007554{
Victor Stinner8c62be82010-05-06 00:08:46 +00007555 if (plock(op) == -1)
7556 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007557 Py_RETURN_NONE;
Guido van Rossumc0125471996-06-28 18:55:32 +00007558}
Larry Hastings2f936352014-08-05 14:04:04 +10007559#endif /* HAVE_PLOCK */
7560
Guido van Rossumc0125471996-06-28 18:55:32 +00007561
Guido van Rossumb6775db1994-08-01 11:34:53 +00007562#ifdef HAVE_SETUID
Larry Hastings2f936352014-08-05 14:04:04 +10007563/*[clinic input]
7564os.setuid
7565
7566 uid: uid_t
7567 /
7568
7569Set the current process's user id.
7570[clinic start generated code]*/
7571
Larry Hastings2f936352014-08-05 14:04:04 +10007572static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007573os_setuid_impl(PyObject *module, uid_t uid)
7574/*[clinic end generated code: output=a0a41fd0d1ec555f input=c921a3285aa22256]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007575{
Victor Stinner8c62be82010-05-06 00:08:46 +00007576 if (setuid(uid) < 0)
7577 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007578 Py_RETURN_NONE;
Guido van Rossuma3d78fb1993-11-10 09:23:53 +00007579}
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00007580#endif /* HAVE_SETUID */
Guido van Rossuma3d78fb1993-11-10 09:23:53 +00007581
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007582
Andrew M. Kuchling8d2f2b22000-07-13 01:26:58 +00007583#ifdef HAVE_SETEUID
Larry Hastings2f936352014-08-05 14:04:04 +10007584/*[clinic input]
7585os.seteuid
7586
7587 euid: uid_t
7588 /
7589
7590Set the current process's effective user id.
7591[clinic start generated code]*/
7592
Larry Hastings2f936352014-08-05 14:04:04 +10007593static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007594os_seteuid_impl(PyObject *module, uid_t euid)
7595/*[clinic end generated code: output=102e3ad98361519a input=ba93d927e4781aa9]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007596{
7597 if (seteuid(euid) < 0)
Victor Stinner8c62be82010-05-06 00:08:46 +00007598 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007599 Py_RETURN_NONE;
Andrew M. Kuchling8d2f2b22000-07-13 01:26:58 +00007600}
7601#endif /* HAVE_SETEUID */
7602
Larry Hastings2f936352014-08-05 14:04:04 +10007603
Andrew M. Kuchling8d2f2b22000-07-13 01:26:58 +00007604#ifdef HAVE_SETEGID
Larry Hastings2f936352014-08-05 14:04:04 +10007605/*[clinic input]
7606os.setegid
7607
7608 egid: gid_t
7609 /
7610
7611Set the current process's effective group id.
7612[clinic start generated code]*/
7613
Larry Hastings2f936352014-08-05 14:04:04 +10007614static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007615os_setegid_impl(PyObject *module, gid_t egid)
7616/*[clinic end generated code: output=4e4b825a6a10258d input=4080526d0ccd6ce3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007617{
7618 if (setegid(egid) < 0)
Victor Stinner8c62be82010-05-06 00:08:46 +00007619 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007620 Py_RETURN_NONE;
Andrew M. Kuchling8d2f2b22000-07-13 01:26:58 +00007621}
7622#endif /* HAVE_SETEGID */
7623
Larry Hastings2f936352014-08-05 14:04:04 +10007624
Andrew M. Kuchling8d2f2b22000-07-13 01:26:58 +00007625#ifdef HAVE_SETREUID
Larry Hastings2f936352014-08-05 14:04:04 +10007626/*[clinic input]
7627os.setreuid
7628
7629 ruid: uid_t
7630 euid: uid_t
7631 /
7632
7633Set the current process's real and effective user ids.
7634[clinic start generated code]*/
7635
Larry Hastings2f936352014-08-05 14:04:04 +10007636static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007637os_setreuid_impl(PyObject *module, uid_t ruid, uid_t euid)
7638/*[clinic end generated code: output=62d991210006530a input=0ca8978de663880c]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007639{
Victor Stinner8c62be82010-05-06 00:08:46 +00007640 if (setreuid(ruid, euid) < 0) {
7641 return posix_error();
7642 } else {
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02007643 Py_RETURN_NONE;
Victor Stinner8c62be82010-05-06 00:08:46 +00007644 }
Andrew M. Kuchling8d2f2b22000-07-13 01:26:58 +00007645}
7646#endif /* HAVE_SETREUID */
7647
Larry Hastings2f936352014-08-05 14:04:04 +10007648
Andrew M. Kuchling8d2f2b22000-07-13 01:26:58 +00007649#ifdef HAVE_SETREGID
Larry Hastings2f936352014-08-05 14:04:04 +10007650/*[clinic input]
7651os.setregid
7652
7653 rgid: gid_t
7654 egid: gid_t
7655 /
7656
7657Set the current process's real and effective group ids.
7658[clinic start generated code]*/
7659
Larry Hastings2f936352014-08-05 14:04:04 +10007660static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007661os_setregid_impl(PyObject *module, gid_t rgid, gid_t egid)
7662/*[clinic end generated code: output=aa803835cf5342f3 input=c59499f72846db78]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007663{
7664 if (setregid(rgid, egid) < 0)
Victor Stinner8c62be82010-05-06 00:08:46 +00007665 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007666 Py_RETURN_NONE;
Andrew M. Kuchling8d2f2b22000-07-13 01:26:58 +00007667}
7668#endif /* HAVE_SETREGID */
7669
Larry Hastings2f936352014-08-05 14:04:04 +10007670
Guido van Rossumb6775db1994-08-01 11:34:53 +00007671#ifdef HAVE_SETGID
Larry Hastings2f936352014-08-05 14:04:04 +10007672/*[clinic input]
7673os.setgid
7674 gid: gid_t
7675 /
7676
7677Set the current process's group id.
7678[clinic start generated code]*/
7679
Larry Hastings2f936352014-08-05 14:04:04 +10007680static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007681os_setgid_impl(PyObject *module, gid_t gid)
7682/*[clinic end generated code: output=bdccd7403f6ad8c3 input=27d30c4059045dc6]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007683{
Victor Stinner8c62be82010-05-06 00:08:46 +00007684 if (setgid(gid) < 0)
7685 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007686 Py_RETURN_NONE;
Guido van Rossuma3d78fb1993-11-10 09:23:53 +00007687}
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00007688#endif /* HAVE_SETGID */
Guido van Rossuma3d78fb1993-11-10 09:23:53 +00007689
Larry Hastings2f936352014-08-05 14:04:04 +10007690
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00007691#ifdef HAVE_SETGROUPS
Larry Hastings2f936352014-08-05 14:04:04 +10007692/*[clinic input]
7693os.setgroups
7694
7695 groups: object
7696 /
7697
7698Set the groups of the current process to list.
7699[clinic start generated code]*/
7700
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00007701static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007702os_setgroups(PyObject *module, PyObject *groups)
7703/*[clinic end generated code: output=3fcb32aad58c5ecd input=fa742ca3daf85a7e]*/
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00007704{
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03007705 Py_ssize_t i, len;
Victor Stinner8c62be82010-05-06 00:08:46 +00007706 gid_t grouplist[MAX_GROUPS];
Tim Peters5aa91602002-01-30 05:46:57 +00007707
Victor Stinner8c62be82010-05-06 00:08:46 +00007708 if (!PySequence_Check(groups)) {
7709 PyErr_SetString(PyExc_TypeError, "setgroups argument must be a sequence");
7710 return NULL;
7711 }
7712 len = PySequence_Size(groups);
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03007713 if (len < 0) {
7714 return NULL;
7715 }
Victor Stinner8c62be82010-05-06 00:08:46 +00007716 if (len > MAX_GROUPS) {
7717 PyErr_SetString(PyExc_ValueError, "too many groups");
7718 return NULL;
7719 }
7720 for(i = 0; i < len; i++) {
7721 PyObject *elem;
7722 elem = PySequence_GetItem(groups, i);
7723 if (!elem)
7724 return NULL;
7725 if (!PyLong_Check(elem)) {
7726 PyErr_SetString(PyExc_TypeError,
7727 "groups must be integers");
7728 Py_DECREF(elem);
7729 return NULL;
7730 } else {
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02007731 if (!_Py_Gid_Converter(elem, &grouplist[i])) {
Victor Stinner8c62be82010-05-06 00:08:46 +00007732 Py_DECREF(elem);
7733 return NULL;
7734 }
7735 }
7736 Py_DECREF(elem);
7737 }
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00007738
Victor Stinner8c62be82010-05-06 00:08:46 +00007739 if (setgroups(len, grouplist) < 0)
7740 return posix_error();
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02007741 Py_RETURN_NONE;
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00007742}
7743#endif /* HAVE_SETGROUPS */
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007744
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007745#if defined(HAVE_WAIT3) || defined(HAVE_WAIT4)
7746static PyObject *
Victor Stinner1c2fa782020-05-10 11:05:29 +02007747wait_helper(PyObject *module, pid_t pid, int status, struct rusage *ru)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007748{
Victor Stinner8c62be82010-05-06 00:08:46 +00007749 PyObject *result;
Eddie Elizondob3966632019-11-05 07:16:14 -08007750 PyObject *struct_rusage;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007751
Victor Stinner8c62be82010-05-06 00:08:46 +00007752 if (pid == -1)
7753 return posix_error();
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007754
Zackery Spytz682107c2019-09-09 09:48:32 -06007755 // If wait succeeded but no child was ready to report status, ru will not
7756 // have been populated.
7757 if (pid == 0) {
7758 memset(ru, 0, sizeof(*ru));
7759 }
7760
Eddie Elizondob3966632019-11-05 07:16:14 -08007761 PyObject *m = PyImport_ImportModuleNoBlock("resource");
7762 if (m == NULL)
7763 return NULL;
Victor Stinner1c2fa782020-05-10 11:05:29 +02007764 struct_rusage = PyObject_GetAttr(m, get_posix_state(module)->struct_rusage);
Eddie Elizondob3966632019-11-05 07:16:14 -08007765 Py_DECREF(m);
7766 if (struct_rusage == NULL)
7767 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007768
Victor Stinner8c62be82010-05-06 00:08:46 +00007769 /* XXX(nnorwitz): Copied (w/mods) from resource.c, there should be only one. */
7770 result = PyStructSequence_New((PyTypeObject*) struct_rusage);
Eddie Elizondoe4db1f02019-11-25 19:07:37 -08007771 Py_DECREF(struct_rusage);
Victor Stinner8c62be82010-05-06 00:08:46 +00007772 if (!result)
7773 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007774
7775#ifndef doubletime
7776#define doubletime(TV) ((double)(TV).tv_sec + (TV).tv_usec * 0.000001)
7777#endif
7778
Victor Stinner8c62be82010-05-06 00:08:46 +00007779 PyStructSequence_SET_ITEM(result, 0,
Victor Stinner4195b5c2012-02-08 23:03:19 +01007780 PyFloat_FromDouble(doubletime(ru->ru_utime)));
Victor Stinner8c62be82010-05-06 00:08:46 +00007781 PyStructSequence_SET_ITEM(result, 1,
Victor Stinner4195b5c2012-02-08 23:03:19 +01007782 PyFloat_FromDouble(doubletime(ru->ru_stime)));
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007783#define SET_INT(result, index, value)\
Victor Stinner8c62be82010-05-06 00:08:46 +00007784 PyStructSequence_SET_ITEM(result, index, PyLong_FromLong(value))
7785 SET_INT(result, 2, ru->ru_maxrss);
7786 SET_INT(result, 3, ru->ru_ixrss);
7787 SET_INT(result, 4, ru->ru_idrss);
7788 SET_INT(result, 5, ru->ru_isrss);
7789 SET_INT(result, 6, ru->ru_minflt);
7790 SET_INT(result, 7, ru->ru_majflt);
7791 SET_INT(result, 8, ru->ru_nswap);
7792 SET_INT(result, 9, ru->ru_inblock);
7793 SET_INT(result, 10, ru->ru_oublock);
7794 SET_INT(result, 11, ru->ru_msgsnd);
7795 SET_INT(result, 12, ru->ru_msgrcv);
7796 SET_INT(result, 13, ru->ru_nsignals);
7797 SET_INT(result, 14, ru->ru_nvcsw);
7798 SET_INT(result, 15, ru->ru_nivcsw);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007799#undef SET_INT
7800
Victor Stinner8c62be82010-05-06 00:08:46 +00007801 if (PyErr_Occurred()) {
7802 Py_DECREF(result);
7803 return NULL;
7804 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007805
Victor Stinner8c62be82010-05-06 00:08:46 +00007806 return Py_BuildValue("NiN", PyLong_FromPid(pid), status, result);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007807}
7808#endif /* HAVE_WAIT3 || HAVE_WAIT4 */
7809
Larry Hastings2f936352014-08-05 14:04:04 +10007810
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007811#ifdef HAVE_WAIT3
Larry Hastings2f936352014-08-05 14:04:04 +10007812/*[clinic input]
7813os.wait3
7814
7815 options: int
7816Wait for completion of a child process.
7817
7818Returns a tuple of information about the child process:
7819 (pid, status, rusage)
7820[clinic start generated code]*/
7821
Larry Hastings2f936352014-08-05 14:04:04 +10007822static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007823os_wait3_impl(PyObject *module, int options)
7824/*[clinic end generated code: output=92c3224e6f28217a input=8ac4c56956b61710]*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007825{
Victor Stinner8c62be82010-05-06 00:08:46 +00007826 pid_t pid;
Victor Stinner8c62be82010-05-06 00:08:46 +00007827 struct rusage ru;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007828 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00007829 WAIT_TYPE status;
7830 WAIT_STATUS_INT(status) = 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007831
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007832 do {
7833 Py_BEGIN_ALLOW_THREADS
7834 pid = wait3(&status, options, &ru);
7835 Py_END_ALLOW_THREADS
7836 } while (pid < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
7837 if (pid < 0)
7838 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007839
Victor Stinner1c2fa782020-05-10 11:05:29 +02007840 return wait_helper(module, pid, WAIT_STATUS_INT(status), &ru);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007841}
7842#endif /* HAVE_WAIT3 */
7843
Larry Hastings2f936352014-08-05 14:04:04 +10007844
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007845#ifdef HAVE_WAIT4
Larry Hastings2f936352014-08-05 14:04:04 +10007846/*[clinic input]
7847
7848os.wait4
7849
7850 pid: pid_t
7851 options: int
7852
7853Wait for completion of a specific child process.
7854
7855Returns a tuple of information about the child process:
7856 (pid, status, rusage)
7857[clinic start generated code]*/
7858
Larry Hastings2f936352014-08-05 14:04:04 +10007859static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007860os_wait4_impl(PyObject *module, pid_t pid, int options)
7861/*[clinic end generated code: output=66195aa507b35f70 input=d11deed0750600ba]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007862{
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007863 pid_t res;
Victor Stinner8c62be82010-05-06 00:08:46 +00007864 struct rusage ru;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007865 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00007866 WAIT_TYPE status;
7867 WAIT_STATUS_INT(status) = 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007868
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007869 do {
7870 Py_BEGIN_ALLOW_THREADS
7871 res = wait4(pid, &status, options, &ru);
7872 Py_END_ALLOW_THREADS
7873 } while (res < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
7874 if (res < 0)
7875 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007876
Victor Stinner1c2fa782020-05-10 11:05:29 +02007877 return wait_helper(module, res, WAIT_STATUS_INT(status), &ru);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007878}
7879#endif /* HAVE_WAIT4 */
7880
Larry Hastings2f936352014-08-05 14:04:04 +10007881
Ross Lagerwall7807c352011-03-17 20:20:30 +02007882#if defined(HAVE_WAITID) && !defined(__APPLE__)
Larry Hastings2f936352014-08-05 14:04:04 +10007883/*[clinic input]
7884os.waitid
7885
7886 idtype: idtype_t
7887 Must be one of be P_PID, P_PGID or P_ALL.
7888 id: id_t
7889 The id to wait on.
7890 options: int
7891 Constructed from the ORing of one or more of WEXITED, WSTOPPED
7892 or WCONTINUED and additionally may be ORed with WNOHANG or WNOWAIT.
7893 /
7894
7895Returns the result of waiting for a process or processes.
7896
7897Returns either waitid_result or None if WNOHANG is specified and there are
7898no children in a waitable state.
7899[clinic start generated code]*/
7900
Larry Hastings2f936352014-08-05 14:04:04 +10007901static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007902os_waitid_impl(PyObject *module, idtype_t idtype, id_t id, int options)
7903/*[clinic end generated code: output=5d2e1c0bde61f4d8 input=d8e7f76e052b7920]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007904{
7905 PyObject *result;
7906 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007907 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02007908 siginfo_t si;
7909 si.si_pid = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10007910
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007911 do {
7912 Py_BEGIN_ALLOW_THREADS
7913 res = waitid(idtype, id, &si, options);
7914 Py_END_ALLOW_THREADS
7915 } while (res < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
7916 if (res < 0)
7917 return (!async_err) ? posix_error() : NULL;
Ross Lagerwall7807c352011-03-17 20:20:30 +02007918
7919 if (si.si_pid == 0)
7920 Py_RETURN_NONE;
7921
Hai Shif707d942020-03-16 21:15:01 +08007922 PyObject *WaitidResultType = get_posix_state(module)->WaitidResultType;
Eddie Elizondob3966632019-11-05 07:16:14 -08007923 result = PyStructSequence_New((PyTypeObject *)WaitidResultType);
Ross Lagerwall7807c352011-03-17 20:20:30 +02007924 if (!result)
7925 return NULL;
7926
7927 PyStructSequence_SET_ITEM(result, 0, PyLong_FromPid(si.si_pid));
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02007928 PyStructSequence_SET_ITEM(result, 1, _PyLong_FromUid(si.si_uid));
Ross Lagerwall7807c352011-03-17 20:20:30 +02007929 PyStructSequence_SET_ITEM(result, 2, PyLong_FromLong((long)(si.si_signo)));
7930 PyStructSequence_SET_ITEM(result, 3, PyLong_FromLong((long)(si.si_status)));
7931 PyStructSequence_SET_ITEM(result, 4, PyLong_FromLong((long)(si.si_code)));
7932 if (PyErr_Occurred()) {
7933 Py_DECREF(result);
7934 return NULL;
7935 }
7936
7937 return result;
7938}
Larry Hastings2f936352014-08-05 14:04:04 +10007939#endif /* defined(HAVE_WAITID) && !defined(__APPLE__) */
Ross Lagerwall7807c352011-03-17 20:20:30 +02007940
Larry Hastings2f936352014-08-05 14:04:04 +10007941
7942#if defined(HAVE_WAITPID)
7943/*[clinic input]
7944os.waitpid
7945 pid: pid_t
7946 options: int
7947 /
7948
7949Wait for completion of a given child process.
7950
7951Returns a tuple of information regarding the child process:
7952 (pid, status)
7953
7954The options argument is ignored on Windows.
7955[clinic start generated code]*/
7956
Larry Hastings2f936352014-08-05 14:04:04 +10007957static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007958os_waitpid_impl(PyObject *module, pid_t pid, int options)
7959/*[clinic end generated code: output=5c37c06887a20270 input=0bf1666b8758fda3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007960{
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007961 pid_t res;
7962 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00007963 WAIT_TYPE status;
7964 WAIT_STATUS_INT(status) = 0;
Guido van Rossum54ecc3d1999-01-27 17:53:11 +00007965
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007966 do {
7967 Py_BEGIN_ALLOW_THREADS
7968 res = waitpid(pid, &status, options);
7969 Py_END_ALLOW_THREADS
7970 } while (res < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
7971 if (res < 0)
7972 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007973
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007974 return Py_BuildValue("Ni", PyLong_FromPid(res), WAIT_STATUS_INT(status));
Guido van Rossum21803b81992-08-09 12:55:27 +00007975}
Tim Petersab034fa2002-02-01 11:27:43 +00007976#elif defined(HAVE_CWAIT)
Tim Petersab034fa2002-02-01 11:27:43 +00007977/* MS C has a variant of waitpid() that's usable for most purposes. */
Larry Hastings2f936352014-08-05 14:04:04 +10007978/*[clinic input]
7979os.waitpid
Benjamin Petersonca470632016-09-06 13:47:26 -07007980 pid: intptr_t
Larry Hastings2f936352014-08-05 14:04:04 +10007981 options: int
7982 /
7983
7984Wait for completion of a given process.
7985
7986Returns a tuple of information regarding the process:
7987 (pid, status << 8)
7988
7989The options argument is ignored on Windows.
7990[clinic start generated code]*/
7991
Larry Hastings2f936352014-08-05 14:04:04 +10007992static PyObject *
Benjamin Petersonca470632016-09-06 13:47:26 -07007993os_waitpid_impl(PyObject *module, intptr_t pid, int options)
Victor Stinner581139c2016-09-06 15:54:20 -07007994/*[clinic end generated code: output=be836b221271d538 input=40f2440c515410f8]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007995{
7996 int status;
Benjamin Petersonca470632016-09-06 13:47:26 -07007997 intptr_t res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007998 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10007999
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008000 do {
8001 Py_BEGIN_ALLOW_THREADS
Steve Dower11f43262016-11-19 18:33:39 -08008002 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008003 res = _cwait(&status, pid, options);
Steve Dower11f43262016-11-19 18:33:39 -08008004 _Py_END_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008005 Py_END_ALLOW_THREADS
8006 } while (res < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Victor Stinnerd3ffd322015-09-15 10:11:03 +02008007 if (res < 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008008 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00008009
Victor Stinner9bee32b2020-04-22 16:30:35 +02008010 unsigned long long ustatus = (unsigned int)status;
8011
Victor Stinner8c62be82010-05-06 00:08:46 +00008012 /* shift the status left a byte so this is more like the POSIX waitpid */
Victor Stinner9bee32b2020-04-22 16:30:35 +02008013 return Py_BuildValue(_Py_PARSE_INTPTR "K", res, ustatus << 8);
Tim Petersab034fa2002-02-01 11:27:43 +00008014}
Larry Hastings2f936352014-08-05 14:04:04 +10008015#endif
8016
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008017
Guido van Rossumad0ee831995-03-01 10:34:45 +00008018#ifdef HAVE_WAIT
Larry Hastings2f936352014-08-05 14:04:04 +10008019/*[clinic input]
8020os.wait
8021
8022Wait for completion of a child process.
8023
8024Returns a tuple of information about the child process:
8025 (pid, status)
8026[clinic start generated code]*/
8027
Larry Hastings2f936352014-08-05 14:04:04 +10008028static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008029os_wait_impl(PyObject *module)
8030/*[clinic end generated code: output=6bc419ac32fb364b input=03b0182d4a4700ce]*/
Guido van Rossum21803b81992-08-09 12:55:27 +00008031{
Victor Stinner8c62be82010-05-06 00:08:46 +00008032 pid_t pid;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008033 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00008034 WAIT_TYPE status;
8035 WAIT_STATUS_INT(status) = 0;
Neal Norwitze241ce82003-02-17 18:17:05 +00008036
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008037 do {
8038 Py_BEGIN_ALLOW_THREADS
8039 pid = wait(&status);
8040 Py_END_ALLOW_THREADS
8041 } while (pid < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
8042 if (pid < 0)
8043 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00008044
Victor Stinner8c62be82010-05-06 00:08:46 +00008045 return Py_BuildValue("Ni", PyLong_FromPid(pid), WAIT_STATUS_INT(status));
Guido van Rossum85e3b011991-06-03 12:42:10 +00008046}
Larry Hastings2f936352014-08-05 14:04:04 +10008047#endif /* HAVE_WAIT */
Guido van Rossum85e3b011991-06-03 12:42:10 +00008048
Benjamin Peterson6c4c45e2019-11-05 19:21:29 -08008049#if defined(__linux__) && defined(__NR_pidfd_open)
8050/*[clinic input]
8051os.pidfd_open
8052 pid: pid_t
8053 flags: unsigned_int = 0
8054
8055Return a file descriptor referring to the process *pid*.
8056
8057The descriptor can be used to perform process management without races and
8058signals.
8059[clinic start generated code]*/
8060
8061static PyObject *
8062os_pidfd_open_impl(PyObject *module, pid_t pid, unsigned int flags)
8063/*[clinic end generated code: output=5c7252698947dc41 input=c3fd99ce947ccfef]*/
8064{
8065 int fd = syscall(__NR_pidfd_open, pid, flags);
8066 if (fd < 0) {
8067 return posix_error();
8068 }
8069 return PyLong_FromLong(fd);
8070}
8071#endif
8072
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008073
Larry Hastings9cf065c2012-06-22 16:30:09 -07008074#if defined(HAVE_READLINK) || defined(MS_WINDOWS)
Serhiy Storchaka12a69db2018-09-17 15:38:27 +03008075/*[clinic input]
8076os.readlink
8077
8078 path: path_t
8079 *
8080 dir_fd: dir_fd(requires='readlinkat') = None
8081
8082Return a string representing the path to which the symbolic link points.
8083
8084If dir_fd is not None, it should be a file descriptor open to a directory,
8085and path should be relative; path will then be relative to that directory.
8086
8087dir_fd may not be implemented on your platform. If it is unavailable,
8088using it will raise a NotImplementedError.
8089[clinic start generated code]*/
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008090
Barry Warsaw53699e91996-12-10 23:23:01 +00008091static PyObject *
Serhiy Storchaka12a69db2018-09-17 15:38:27 +03008092os_readlink_impl(PyObject *module, path_t *path, int dir_fd)
8093/*[clinic end generated code: output=d21b732a2e814030 input=113c87e0db1ecaf2]*/
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00008094{
Berker Peksage0b5b202018-08-15 13:03:41 +03008095#if defined(HAVE_READLINK)
Christian Heimes3cb091e2016-09-23 20:24:28 +02008096 char buffer[MAXPATHLEN+1];
Larry Hastings9cf065c2012-06-22 16:30:09 -07008097 ssize_t length;
Serhiy Storchaka12a69db2018-09-17 15:38:27 +03008098
8099 Py_BEGIN_ALLOW_THREADS
8100#ifdef HAVE_READLINKAT
8101 if (dir_fd != DEFAULT_DIR_FD)
8102 length = readlinkat(dir_fd, path->narrow, buffer, MAXPATHLEN);
8103 else
8104#endif
8105 length = readlink(path->narrow, buffer, MAXPATHLEN);
8106 Py_END_ALLOW_THREADS
8107
8108 if (length < 0) {
8109 return path_error(path);
8110 }
8111 buffer[length] = '\0';
8112
8113 if (PyUnicode_Check(path->object))
8114 return PyUnicode_DecodeFSDefaultAndSize(buffer, length);
8115 else
8116 return PyBytes_FromStringAndSize(buffer, length);
Berker Peksage0b5b202018-08-15 13:03:41 +03008117#elif defined(MS_WINDOWS)
8118 DWORD n_bytes_returned;
Steve Dowerdf2d4a62019-08-21 15:27:33 -07008119 DWORD io_result = 0;
Berker Peksage0b5b202018-08-15 13:03:41 +03008120 HANDLE reparse_point_handle;
Berker Peksage0b5b202018-08-15 13:03:41 +03008121 char target_buffer[_Py_MAXIMUM_REPARSE_DATA_BUFFER_SIZE];
8122 _Py_REPARSE_DATA_BUFFER *rdb = (_Py_REPARSE_DATA_BUFFER *)target_buffer;
Steve Dower993ac922019-09-03 12:50:51 -07008123 PyObject *result = NULL;
Thomas Wouters89f507f2006-12-13 04:49:30 +00008124
Larry Hastings2f936352014-08-05 14:04:04 +10008125 /* First get a handle to the reparse point */
8126 Py_BEGIN_ALLOW_THREADS
8127 reparse_point_handle = CreateFileW(
Serhiy Storchaka12a69db2018-09-17 15:38:27 +03008128 path->wide,
Larry Hastings2f936352014-08-05 14:04:04 +10008129 0,
8130 0,
8131 0,
8132 OPEN_EXISTING,
8133 FILE_FLAG_OPEN_REPARSE_POINT|FILE_FLAG_BACKUP_SEMANTICS,
8134 0);
Steve Dowerdf2d4a62019-08-21 15:27:33 -07008135 if (reparse_point_handle != INVALID_HANDLE_VALUE) {
8136 /* New call DeviceIoControl to read the reparse point */
8137 io_result = DeviceIoControl(
8138 reparse_point_handle,
8139 FSCTL_GET_REPARSE_POINT,
8140 0, 0, /* in buffer */
8141 target_buffer, sizeof(target_buffer),
8142 &n_bytes_returned,
8143 0 /* we're not using OVERLAPPED_IO */
8144 );
8145 CloseHandle(reparse_point_handle);
Berker Peksage0b5b202018-08-15 13:03:41 +03008146 }
Larry Hastings2f936352014-08-05 14:04:04 +10008147 Py_END_ALLOW_THREADS
8148
Berker Peksage0b5b202018-08-15 13:03:41 +03008149 if (io_result == 0) {
Serhiy Storchaka12a69db2018-09-17 15:38:27 +03008150 return path_error(path);
Berker Peksage0b5b202018-08-15 13:03:41 +03008151 }
Larry Hastings2f936352014-08-05 14:04:04 +10008152
Steve Dowerdf2d4a62019-08-21 15:27:33 -07008153 wchar_t *name = NULL;
8154 Py_ssize_t nameLen = 0;
8155 if (rdb->ReparseTag == IO_REPARSE_TAG_SYMLINK)
Larry Hastings2f936352014-08-05 14:04:04 +10008156 {
Steve Dowerdf2d4a62019-08-21 15:27:33 -07008157 name = (wchar_t *)((char*)rdb->SymbolicLinkReparseBuffer.PathBuffer +
8158 rdb->SymbolicLinkReparseBuffer.SubstituteNameOffset);
8159 nameLen = rdb->SymbolicLinkReparseBuffer.SubstituteNameLength / sizeof(wchar_t);
Larry Hastings2f936352014-08-05 14:04:04 +10008160 }
Steve Dowerdf2d4a62019-08-21 15:27:33 -07008161 else if (rdb->ReparseTag == IO_REPARSE_TAG_MOUNT_POINT)
8162 {
8163 name = (wchar_t *)((char*)rdb->MountPointReparseBuffer.PathBuffer +
8164 rdb->MountPointReparseBuffer.SubstituteNameOffset);
8165 nameLen = rdb->MountPointReparseBuffer.SubstituteNameLength / sizeof(wchar_t);
8166 }
8167 else
8168 {
8169 PyErr_SetString(PyExc_ValueError, "not a symbolic link");
8170 }
8171 if (name) {
8172 if (nameLen > 4 && wcsncmp(name, L"\\??\\", 4) == 0) {
8173 /* Our buffer is mutable, so this is okay */
8174 name[1] = L'\\';
8175 }
8176 result = PyUnicode_FromWideChar(name, nameLen);
Steve Dower993ac922019-09-03 12:50:51 -07008177 if (result && path->narrow) {
Steve Dowerdf2d4a62019-08-21 15:27:33 -07008178 Py_SETREF(result, PyUnicode_EncodeFSDefault(result));
8179 }
Berker Peksage0b5b202018-08-15 13:03:41 +03008180 }
Serhiy Storchaka12a69db2018-09-17 15:38:27 +03008181 return result;
Berker Peksage0b5b202018-08-15 13:03:41 +03008182#endif
Larry Hastings2f936352014-08-05 14:04:04 +10008183}
Berker Peksage0b5b202018-08-15 13:03:41 +03008184#endif /* defined(HAVE_READLINK) || defined(MS_WINDOWS) */
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008185
Larry Hastings9cf065c2012-06-22 16:30:09 -07008186#if defined(MS_WINDOWS)
8187
Steve Dower6921e732018-03-05 14:26:08 -08008188/* Remove the last portion of the path - return 0 on success */
8189static int
Victor Stinner31b3b922013-06-05 01:49:17 +02008190_dirnameW(WCHAR *path)
8191{
Jason R. Coombs3a092862013-05-27 23:21:28 -04008192 WCHAR *ptr;
Steve Dower6921e732018-03-05 14:26:08 -08008193 size_t length = wcsnlen_s(path, MAX_PATH);
8194 if (length == MAX_PATH) {
8195 return -1;
8196 }
Jason R. Coombs3a092862013-05-27 23:21:28 -04008197
8198 /* walk the path from the end until a backslash is encountered */
Steve Dower6921e732018-03-05 14:26:08 -08008199 for(ptr = path + length; ptr != path; ptr--) {
8200 if (*ptr == L'\\' || *ptr == L'/') {
Jason R. Coombs3a092862013-05-27 23:21:28 -04008201 break;
Steve Dower6921e732018-03-05 14:26:08 -08008202 }
Jason R. Coombs3a092862013-05-27 23:21:28 -04008203 }
8204 *ptr = 0;
Steve Dower6921e732018-03-05 14:26:08 -08008205 return 0;
Jason R. Coombs3a092862013-05-27 23:21:28 -04008206}
8207
Minmin Gong7f21c9a2020-05-18 09:17:19 -07008208#endif
8209
8210#ifdef HAVE_SYMLINK
8211
8212#if defined(MS_WINDOWS)
8213
Victor Stinner31b3b922013-06-05 01:49:17 +02008214/* Is this path absolute? */
8215static int
8216_is_absW(const WCHAR *path)
8217{
Steve Dower6921e732018-03-05 14:26:08 -08008218 return path[0] == L'\\' || path[0] == L'/' ||
8219 (path[0] && path[1] == L':');
Jason R. Coombs3a092862013-05-27 23:21:28 -04008220}
8221
Steve Dower6921e732018-03-05 14:26:08 -08008222/* join root and rest with a backslash - return 0 on success */
8223static int
Victor Stinner31b3b922013-06-05 01:49:17 +02008224_joinW(WCHAR *dest_path, const WCHAR *root, const WCHAR *rest)
8225{
Victor Stinner31b3b922013-06-05 01:49:17 +02008226 if (_is_absW(rest)) {
Steve Dower6921e732018-03-05 14:26:08 -08008227 return wcscpy_s(dest_path, MAX_PATH, rest);
Jason R. Coombs3a092862013-05-27 23:21:28 -04008228 }
8229
Steve Dower6921e732018-03-05 14:26:08 -08008230 if (wcscpy_s(dest_path, MAX_PATH, root)) {
8231 return -1;
Jason R. Coombs3a092862013-05-27 23:21:28 -04008232 }
Steve Dower6921e732018-03-05 14:26:08 -08008233
8234 if (dest_path[0] && wcscat_s(dest_path, MAX_PATH, L"\\")) {
8235 return -1;
8236 }
8237
8238 return wcscat_s(dest_path, MAX_PATH, rest);
Jason R. Coombs3a092862013-05-27 23:21:28 -04008239}
8240
Victor Stinner31b3b922013-06-05 01:49:17 +02008241/* Return True if the path at src relative to dest is a directory */
8242static int
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03008243_check_dirW(LPCWSTR src, LPCWSTR dest)
Jason R. Coombs3a092862013-05-27 23:21:28 -04008244{
Jason R. Coombs3a092862013-05-27 23:21:28 -04008245 WIN32_FILE_ATTRIBUTE_DATA src_info;
8246 WCHAR dest_parent[MAX_PATH];
8247 WCHAR src_resolved[MAX_PATH] = L"";
8248
8249 /* dest_parent = os.path.dirname(dest) */
Steve Dower6921e732018-03-05 14:26:08 -08008250 if (wcscpy_s(dest_parent, MAX_PATH, dest) ||
8251 _dirnameW(dest_parent)) {
8252 return 0;
8253 }
Jason R. Coombs3a092862013-05-27 23:21:28 -04008254 /* src_resolved = os.path.join(dest_parent, src) */
Steve Dower6921e732018-03-05 14:26:08 -08008255 if (_joinW(src_resolved, dest_parent, src)) {
8256 return 0;
8257 }
Jason R. Coombs3a092862013-05-27 23:21:28 -04008258 return (
8259 GetFileAttributesExW(src_resolved, GetFileExInfoStandard, &src_info)
8260 && src_info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY
8261 );
8262}
Larry Hastings9cf065c2012-06-22 16:30:09 -07008263#endif
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008264
Larry Hastings2f936352014-08-05 14:04:04 +10008265
8266/*[clinic input]
8267os.symlink
8268 src: path_t
8269 dst: path_t
8270 target_is_directory: bool = False
8271 *
8272 dir_fd: dir_fd(requires='symlinkat')=None
8273
8274# "symlink(src, dst, target_is_directory=False, *, dir_fd=None)\n\n\
8275
8276Create a symbolic link pointing to src named dst.
8277
8278target_is_directory is required on Windows if the target is to be
8279 interpreted as a directory. (On Windows, symlink requires
8280 Windows 6.0 or greater, and raises a NotImplementedError otherwise.)
8281 target_is_directory is ignored on non-Windows platforms.
8282
8283If dir_fd is not None, it should be a file descriptor open to a directory,
8284 and path should be relative; path will then be relative to that directory.
8285dir_fd may not be implemented on your platform.
8286 If it is unavailable, using it will raise a NotImplementedError.
8287
8288[clinic start generated code]*/
8289
Larry Hastings2f936352014-08-05 14:04:04 +10008290static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008291os_symlink_impl(PyObject *module, path_t *src, path_t *dst,
Larry Hastings89964c42015-04-14 18:07:59 -04008292 int target_is_directory, int dir_fd)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008293/*[clinic end generated code: output=08ca9f3f3cf960f6 input=e820ec4472547bc3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008294{
Larry Hastings9cf065c2012-06-22 16:30:09 -07008295#ifdef MS_WINDOWS
8296 DWORD result;
Vidar Tonaas Fauske0e107662019-04-09 20:19:46 +02008297 DWORD flags = 0;
8298
8299 /* Assumed true, set to false if detected to not be available. */
8300 static int windows_has_symlink_unprivileged_flag = TRUE;
Larry Hastings9cf065c2012-06-22 16:30:09 -07008301#else
8302 int result;
8303#endif
8304
Saiyang Gou7514f4f2020-02-12 23:47:42 -08008305 if (PySys_Audit("os.symlink", "OOi", src->object, dst->object,
8306 dir_fd == DEFAULT_DIR_FD ? -1 : dir_fd) < 0) {
8307 return NULL;
8308 }
8309
Larry Hastings9cf065c2012-06-22 16:30:09 -07008310#ifdef MS_WINDOWS
Larry Hastings9cf065c2012-06-22 16:30:09 -07008311
Vidar Tonaas Fauske0e107662019-04-09 20:19:46 +02008312 if (windows_has_symlink_unprivileged_flag) {
8313 /* Allow non-admin symlinks if system allows it. */
8314 flags |= SYMBOLIC_LINK_FLAG_ALLOW_UNPRIVILEGED_CREATE;
8315 }
Jason R. Coombs3a092862013-05-27 23:21:28 -04008316
Larry Hastings9cf065c2012-06-22 16:30:09 -07008317 Py_BEGIN_ALLOW_THREADS
Steve Dower6921e732018-03-05 14:26:08 -08008318 _Py_BEGIN_SUPPRESS_IPH
Vidar Tonaas Fauske0e107662019-04-09 20:19:46 +02008319 /* if src is a directory, ensure flags==1 (target_is_directory bit) */
8320 if (target_is_directory || _check_dirW(src->wide, dst->wide)) {
8321 flags |= SYMBOLIC_LINK_FLAG_DIRECTORY;
8322 }
8323
8324 result = CreateSymbolicLinkW(dst->wide, src->wide, flags);
Steve Dower6921e732018-03-05 14:26:08 -08008325 _Py_END_SUPPRESS_IPH
Larry Hastings9cf065c2012-06-22 16:30:09 -07008326 Py_END_ALLOW_THREADS
8327
Vidar Tonaas Fauske0e107662019-04-09 20:19:46 +02008328 if (windows_has_symlink_unprivileged_flag && !result &&
8329 ERROR_INVALID_PARAMETER == GetLastError()) {
8330
8331 Py_BEGIN_ALLOW_THREADS
8332 _Py_BEGIN_SUPPRESS_IPH
8333 /* This error might be caused by
8334 SYMBOLIC_LINK_FLAG_ALLOW_UNPRIVILEGED_CREATE not being supported.
8335 Try again, and update windows_has_symlink_unprivileged_flag if we
8336 are successful this time.
8337
8338 NOTE: There is a risk of a race condition here if there are other
8339 conditions than the flag causing ERROR_INVALID_PARAMETER, and
8340 another process (or thread) changes that condition in between our
8341 calls to CreateSymbolicLink.
8342 */
8343 flags &= ~(SYMBOLIC_LINK_FLAG_ALLOW_UNPRIVILEGED_CREATE);
8344 result = CreateSymbolicLinkW(dst->wide, src->wide, flags);
8345 _Py_END_SUPPRESS_IPH
8346 Py_END_ALLOW_THREADS
8347
8348 if (result || ERROR_INVALID_PARAMETER != GetLastError()) {
8349 windows_has_symlink_unprivileged_flag = FALSE;
8350 }
8351 }
8352
Larry Hastings2f936352014-08-05 14:04:04 +10008353 if (!result)
8354 return path_error2(src, dst);
Larry Hastings9cf065c2012-06-22 16:30:09 -07008355
8356#else
8357
Steve Dower6921e732018-03-05 14:26:08 -08008358 if ((src->narrow && dst->wide) || (src->wide && dst->narrow)) {
8359 PyErr_SetString(PyExc_ValueError,
8360 "symlink: src and dst must be the same type");
8361 return NULL;
8362 }
8363
Larry Hastings9cf065c2012-06-22 16:30:09 -07008364 Py_BEGIN_ALLOW_THREADS
8365#if HAVE_SYMLINKAT
8366 if (dir_fd != DEFAULT_DIR_FD)
Larry Hastings2f936352014-08-05 14:04:04 +10008367 result = symlinkat(src->narrow, dir_fd, dst->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07008368 else
8369#endif
Larry Hastings2f936352014-08-05 14:04:04 +10008370 result = symlink(src->narrow, dst->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07008371 Py_END_ALLOW_THREADS
8372
Larry Hastings2f936352014-08-05 14:04:04 +10008373 if (result)
8374 return path_error2(src, dst);
Larry Hastings9cf065c2012-06-22 16:30:09 -07008375#endif
8376
Larry Hastings2f936352014-08-05 14:04:04 +10008377 Py_RETURN_NONE;
Guido van Rossumbfaf3d61997-12-29 20:02:27 +00008378}
8379#endif /* HAVE_SYMLINK */
8380
Larry Hastings9cf065c2012-06-22 16:30:09 -07008381
Brian Curtind40e6f72010-07-08 21:39:08 +00008382
Guido van Rossumbfaf3d61997-12-29 20:02:27 +00008383
Larry Hastings605a62d2012-06-24 04:33:36 -07008384static PyStructSequence_Field times_result_fields[] = {
8385 {"user", "user time"},
8386 {"system", "system time"},
8387 {"children_user", "user time of children"},
8388 {"children_system", "system time of children"},
8389 {"elapsed", "elapsed time since an arbitrary point in the past"},
8390 {NULL}
8391};
8392
8393PyDoc_STRVAR(times_result__doc__,
8394"times_result: Result from os.times().\n\n\
8395This object may be accessed either as a tuple of\n\
8396 (user, system, children_user, children_system, elapsed),\n\
8397or via the attributes user, system, children_user, children_system,\n\
8398and elapsed.\n\
8399\n\
8400See os.times for more information.");
8401
8402static PyStructSequence_Desc times_result_desc = {
8403 "times_result", /* name */
8404 times_result__doc__, /* doc */
8405 times_result_fields,
8406 5
8407};
8408
Antoine Pitrouf3923e92012-07-24 21:23:53 +02008409#ifdef MS_WINDOWS
8410#define HAVE_TIMES /* mandatory, for the method table */
8411#endif
Larry Hastings605a62d2012-06-24 04:33:36 -07008412
Antoine Pitrouf3923e92012-07-24 21:23:53 +02008413#ifdef HAVE_TIMES
Larry Hastings605a62d2012-06-24 04:33:36 -07008414
8415static PyObject *
Victor Stinner1c2fa782020-05-10 11:05:29 +02008416build_times_result(PyObject *module, double user, double system,
Larry Hastings605a62d2012-06-24 04:33:36 -07008417 double children_user, double children_system,
8418 double elapsed)
8419{
Victor Stinner1c2fa782020-05-10 11:05:29 +02008420 PyObject *TimesResultType = get_posix_state(module)->TimesResultType;
Eddie Elizondob3966632019-11-05 07:16:14 -08008421 PyObject *value = PyStructSequence_New((PyTypeObject *)TimesResultType);
Larry Hastings605a62d2012-06-24 04:33:36 -07008422 if (value == NULL)
8423 return NULL;
8424
8425#define SET(i, field) \
8426 { \
8427 PyObject *o = PyFloat_FromDouble(field); \
8428 if (!o) { \
8429 Py_DECREF(value); \
8430 return NULL; \
8431 } \
8432 PyStructSequence_SET_ITEM(value, i, o); \
8433 } \
8434
8435 SET(0, user);
8436 SET(1, system);
8437 SET(2, children_user);
8438 SET(3, children_system);
8439 SET(4, elapsed);
8440
8441#undef SET
8442
8443 return value;
8444}
8445
Larry Hastings605a62d2012-06-24 04:33:36 -07008446
Larry Hastings2f936352014-08-05 14:04:04 +10008447#ifndef MS_WINDOWS
8448#define NEED_TICKS_PER_SECOND
8449static long ticks_per_second = -1;
8450#endif /* MS_WINDOWS */
8451
8452/*[clinic input]
8453os.times
8454
8455Return a collection containing process timing information.
8456
8457The object returned behaves like a named tuple with these fields:
8458 (utime, stime, cutime, cstime, elapsed_time)
8459All fields are floating point numbers.
8460[clinic start generated code]*/
8461
Larry Hastings2f936352014-08-05 14:04:04 +10008462static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008463os_times_impl(PyObject *module)
8464/*[clinic end generated code: output=35f640503557d32a input=2bf9df3d6ab2e48b]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008465#ifdef MS_WINDOWS
Guido van Rossum14ed0b21994-09-29 09:50:09 +00008466{
Victor Stinner8c62be82010-05-06 00:08:46 +00008467 FILETIME create, exit, kernel, user;
8468 HANDLE hProc;
8469 hProc = GetCurrentProcess();
8470 GetProcessTimes(hProc, &create, &exit, &kernel, &user);
8471 /* The fields of a FILETIME structure are the hi and lo part
8472 of a 64-bit value expressed in 100 nanosecond units.
8473 1e7 is one second in such units; 1e-7 the inverse.
8474 429.4967296 is 2**32 / 1e7 or 2**32 * 1e-7.
8475 */
Victor Stinner1c2fa782020-05-10 11:05:29 +02008476 return build_times_result(module,
Victor Stinner8c62be82010-05-06 00:08:46 +00008477 (double)(user.dwHighDateTime*429.4967296 +
8478 user.dwLowDateTime*1e-7),
8479 (double)(kernel.dwHighDateTime*429.4967296 +
8480 kernel.dwLowDateTime*1e-7),
8481 (double)0,
8482 (double)0,
8483 (double)0);
Guido van Rossum14ed0b21994-09-29 09:50:09 +00008484}
Larry Hastings2f936352014-08-05 14:04:04 +10008485#else /* MS_WINDOWS */
Antoine Pitrouf3923e92012-07-24 21:23:53 +02008486{
Larry Hastings2f936352014-08-05 14:04:04 +10008487
8488
Antoine Pitrouf3923e92012-07-24 21:23:53 +02008489 struct tms t;
8490 clock_t c;
8491 errno = 0;
8492 c = times(&t);
8493 if (c == (clock_t) -1)
8494 return posix_error();
Victor Stinner1c2fa782020-05-10 11:05:29 +02008495 return build_times_result(module,
Antoine Pitrouf3923e92012-07-24 21:23:53 +02008496 (double)t.tms_utime / ticks_per_second,
8497 (double)t.tms_stime / ticks_per_second,
8498 (double)t.tms_cutime / ticks_per_second,
8499 (double)t.tms_cstime / ticks_per_second,
8500 (double)c / ticks_per_second);
8501}
Larry Hastings2f936352014-08-05 14:04:04 +10008502#endif /* MS_WINDOWS */
Antoine Pitrouf3923e92012-07-24 21:23:53 +02008503#endif /* HAVE_TIMES */
8504
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008505
Martin v. Löwis49ee14d2003-11-10 06:35:36 +00008506#ifdef HAVE_GETSID
Larry Hastings2f936352014-08-05 14:04:04 +10008507/*[clinic input]
8508os.getsid
8509
8510 pid: pid_t
8511 /
8512
8513Call the system call getsid(pid) and return the result.
8514[clinic start generated code]*/
8515
Larry Hastings2f936352014-08-05 14:04:04 +10008516static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008517os_getsid_impl(PyObject *module, pid_t pid)
8518/*[clinic end generated code: output=112deae56b306460 input=eeb2b923a30ce04e]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008519{
Victor Stinner8c62be82010-05-06 00:08:46 +00008520 int sid;
Victor Stinner8c62be82010-05-06 00:08:46 +00008521 sid = getsid(pid);
8522 if (sid < 0)
8523 return posix_error();
8524 return PyLong_FromLong((long)sid);
Martin v. Löwis49ee14d2003-11-10 06:35:36 +00008525}
8526#endif /* HAVE_GETSID */
8527
8528
Guido van Rossumb6775db1994-08-01 11:34:53 +00008529#ifdef HAVE_SETSID
Larry Hastings2f936352014-08-05 14:04:04 +10008530/*[clinic input]
8531os.setsid
8532
8533Call the system call setsid().
8534[clinic start generated code]*/
8535
Larry Hastings2f936352014-08-05 14:04:04 +10008536static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008537os_setsid_impl(PyObject *module)
8538/*[clinic end generated code: output=e2ddedd517086d77 input=5fff45858e2f0776]*/
Guido van Rossumc2670a01992-09-13 20:07:29 +00008539{
Victor Stinner8c62be82010-05-06 00:08:46 +00008540 if (setsid() < 0)
8541 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10008542 Py_RETURN_NONE;
Guido van Rossumc2670a01992-09-13 20:07:29 +00008543}
Guido van Rossumb6775db1994-08-01 11:34:53 +00008544#endif /* HAVE_SETSID */
Guido van Rossumc2670a01992-09-13 20:07:29 +00008545
Larry Hastings2f936352014-08-05 14:04:04 +10008546
Guido van Rossumb6775db1994-08-01 11:34:53 +00008547#ifdef HAVE_SETPGID
Larry Hastings2f936352014-08-05 14:04:04 +10008548/*[clinic input]
8549os.setpgid
8550
8551 pid: pid_t
8552 pgrp: pid_t
8553 /
8554
8555Call the system call setpgid(pid, pgrp).
8556[clinic start generated code]*/
8557
Larry Hastings2f936352014-08-05 14:04:04 +10008558static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008559os_setpgid_impl(PyObject *module, pid_t pid, pid_t pgrp)
8560/*[clinic end generated code: output=6461160319a43d6a input=fceb395eca572e1a]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008561{
Victor Stinner8c62be82010-05-06 00:08:46 +00008562 if (setpgid(pid, pgrp) < 0)
8563 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10008564 Py_RETURN_NONE;
Guido van Rossumc2670a01992-09-13 20:07:29 +00008565}
Guido van Rossumb6775db1994-08-01 11:34:53 +00008566#endif /* HAVE_SETPGID */
Guido van Rossumc2670a01992-09-13 20:07:29 +00008567
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008568
Guido van Rossumb6775db1994-08-01 11:34:53 +00008569#ifdef HAVE_TCGETPGRP
Larry Hastings2f936352014-08-05 14:04:04 +10008570/*[clinic input]
8571os.tcgetpgrp
8572
8573 fd: int
8574 /
8575
8576Return the process group associated with the terminal specified by fd.
8577[clinic start generated code]*/
8578
Larry Hastings2f936352014-08-05 14:04:04 +10008579static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008580os_tcgetpgrp_impl(PyObject *module, int fd)
8581/*[clinic end generated code: output=f865e88be86c272b input=7f6c18eac10ada86]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008582{
8583 pid_t pgid = tcgetpgrp(fd);
Victor Stinner8c62be82010-05-06 00:08:46 +00008584 if (pgid < 0)
8585 return posix_error();
8586 return PyLong_FromPid(pgid);
Guido van Rossum7066dd71992-09-17 17:54:56 +00008587}
Guido van Rossumb6775db1994-08-01 11:34:53 +00008588#endif /* HAVE_TCGETPGRP */
Guido van Rossum7066dd71992-09-17 17:54:56 +00008589
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008590
Guido van Rossumb6775db1994-08-01 11:34:53 +00008591#ifdef HAVE_TCSETPGRP
Larry Hastings2f936352014-08-05 14:04:04 +10008592/*[clinic input]
8593os.tcsetpgrp
8594
8595 fd: int
8596 pgid: pid_t
8597 /
8598
8599Set the process group associated with the terminal specified by fd.
8600[clinic start generated code]*/
8601
Larry Hastings2f936352014-08-05 14:04:04 +10008602static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008603os_tcsetpgrp_impl(PyObject *module, int fd, pid_t pgid)
8604/*[clinic end generated code: output=f1821a381b9daa39 input=5bdc997c6a619020]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008605{
Victor Stinner8c62be82010-05-06 00:08:46 +00008606 if (tcsetpgrp(fd, pgid) < 0)
8607 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10008608 Py_RETURN_NONE;
Guido van Rossum7066dd71992-09-17 17:54:56 +00008609}
Guido van Rossumb6775db1994-08-01 11:34:53 +00008610#endif /* HAVE_TCSETPGRP */
Guido van Rossum22db57e1992-04-05 14:25:30 +00008611
Guido van Rossum687dd131993-05-17 08:34:16 +00008612/* Functions acting on file descriptors */
8613
Victor Stinnerdaf45552013-08-28 00:53:59 +02008614#ifdef O_CLOEXEC
8615extern int _Py_open_cloexec_works;
8616#endif
8617
Larry Hastings2f936352014-08-05 14:04:04 +10008618
8619/*[clinic input]
8620os.open -> int
8621 path: path_t
8622 flags: int
8623 mode: int = 0o777
8624 *
8625 dir_fd: dir_fd(requires='openat') = None
8626
8627# "open(path, flags, mode=0o777, *, dir_fd=None)\n\n\
8628
8629Open a file for low level IO. Returns a file descriptor (integer).
8630
8631If dir_fd is not None, it should be a file descriptor open to a directory,
8632 and path should be relative; path will then be relative to that directory.
8633dir_fd may not be implemented on your platform.
8634 If it is unavailable, using it will raise a NotImplementedError.
8635[clinic start generated code]*/
8636
Larry Hastings2f936352014-08-05 14:04:04 +10008637static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008638os_open_impl(PyObject *module, path_t *path, int flags, int mode, int dir_fd)
8639/*[clinic end generated code: output=abc7227888c8bc73 input=ad8623b29acd2934]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008640{
8641 int fd;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008642 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10008643
Victor Stinnerdaf45552013-08-28 00:53:59 +02008644#ifdef O_CLOEXEC
8645 int *atomic_flag_works = &_Py_open_cloexec_works;
8646#elif !defined(MS_WINDOWS)
8647 int *atomic_flag_works = NULL;
8648#endif
Mark Hammondc2e85bd2002-10-03 05:10:39 +00008649
Victor Stinnerdaf45552013-08-28 00:53:59 +02008650#ifdef MS_WINDOWS
8651 flags |= O_NOINHERIT;
8652#elif defined(O_CLOEXEC)
8653 flags |= O_CLOEXEC;
8654#endif
8655
Steve Dowerb82e17e2019-05-23 08:45:22 -07008656 if (PySys_Audit("open", "OOi", path->object, Py_None, flags) < 0) {
8657 return -1;
8658 }
8659
Steve Dower8fc89802015-04-12 00:26:27 -04008660 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008661 do {
8662 Py_BEGIN_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07008663#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07008664 fd = _wopen(path->wide, flags, mode);
Steve Dower6230aaf2016-09-09 09:03:15 -07008665#else
Larry Hastings9cf065c2012-06-22 16:30:09 -07008666#ifdef HAVE_OPENAT
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008667 if (dir_fd != DEFAULT_DIR_FD)
8668 fd = openat(dir_fd, path->narrow, flags, mode);
8669 else
Steve Dower6230aaf2016-09-09 09:03:15 -07008670#endif /* HAVE_OPENAT */
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008671 fd = open(path->narrow, flags, mode);
Steve Dower6230aaf2016-09-09 09:03:15 -07008672#endif /* !MS_WINDOWS */
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008673 Py_END_ALLOW_THREADS
8674 } while (fd < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Steve Dower8fc89802015-04-12 00:26:27 -04008675 _Py_END_SUPPRESS_IPH
Guido van Rossum687dd131993-05-17 08:34:16 +00008676
Victor Stinnerd3ffd322015-09-15 10:11:03 +02008677 if (fd < 0) {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008678 if (!async_err)
8679 PyErr_SetFromErrnoWithFilenameObject(PyExc_OSError, path->object);
Larry Hastings2f936352014-08-05 14:04:04 +10008680 return -1;
Larry Hastings9cf065c2012-06-22 16:30:09 -07008681 }
8682
Victor Stinnerdaf45552013-08-28 00:53:59 +02008683#ifndef MS_WINDOWS
8684 if (_Py_set_inheritable(fd, 0, atomic_flag_works) < 0) {
8685 close(fd);
Larry Hastings2f936352014-08-05 14:04:04 +10008686 return -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008687 }
8688#endif
8689
Larry Hastings2f936352014-08-05 14:04:04 +10008690 return fd;
8691}
8692
8693
8694/*[clinic input]
8695os.close
8696
8697 fd: int
8698
8699Close a file descriptor.
8700[clinic start generated code]*/
8701
Barry Warsaw53699e91996-12-10 23:23:01 +00008702static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008703os_close_impl(PyObject *module, int fd)
8704/*[clinic end generated code: output=2fe4e93602822c14 input=2bc42451ca5c3223]*/
Guido van Rossum687dd131993-05-17 08:34:16 +00008705{
Larry Hastings2f936352014-08-05 14:04:04 +10008706 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008707 /* We do not want to retry upon EINTR: see http://lwn.net/Articles/576478/
8708 * and http://linux.derkeiler.com/Mailing-Lists/Kernel/2005-09/3000.html
8709 * for more details.
8710 */
Victor Stinner8c62be82010-05-06 00:08:46 +00008711 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04008712 _Py_BEGIN_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00008713 res = close(fd);
Steve Dower8fc89802015-04-12 00:26:27 -04008714 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00008715 Py_END_ALLOW_THREADS
8716 if (res < 0)
8717 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10008718 Py_RETURN_NONE;
Guido van Rossum687dd131993-05-17 08:34:16 +00008719}
8720
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008721
Jakub Kulíke20134f2019-09-11 17:11:57 +02008722#ifdef HAVE_FDWALK
8723static int
8724_fdwalk_close_func(void *lohi, int fd)
8725{
8726 int lo = ((int *)lohi)[0];
8727 int hi = ((int *)lohi)[1];
8728
Victor Stinner162c5672020-04-24 12:00:51 +02008729 if (fd >= hi) {
Jakub Kulíke20134f2019-09-11 17:11:57 +02008730 return 1;
Victor Stinner162c5672020-04-24 12:00:51 +02008731 }
8732 else if (fd >= lo) {
8733 /* Ignore errors */
8734 (void)close(fd);
8735 }
Jakub Kulíke20134f2019-09-11 17:11:57 +02008736 return 0;
8737}
8738#endif /* HAVE_FDWALK */
8739
Larry Hastings2f936352014-08-05 14:04:04 +10008740/*[clinic input]
8741os.closerange
8742
8743 fd_low: int
8744 fd_high: int
8745 /
8746
8747Closes all file descriptors in [fd_low, fd_high), ignoring errors.
8748[clinic start generated code]*/
8749
Larry Hastings2f936352014-08-05 14:04:04 +10008750static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008751os_closerange_impl(PyObject *module, int fd_low, int fd_high)
8752/*[clinic end generated code: output=0ce5c20fcda681c2 input=5855a3d053ebd4ec]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008753{
Jakub Kulíke20134f2019-09-11 17:11:57 +02008754#ifdef HAVE_FDWALK
8755 int lohi[2];
Jakub Kulíke20134f2019-09-11 17:11:57 +02008756#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00008757 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04008758 _Py_BEGIN_SUPPRESS_IPH
Jakub Kulíke20134f2019-09-11 17:11:57 +02008759#ifdef HAVE_FDWALK
8760 lohi[0] = Py_MAX(fd_low, 0);
8761 lohi[1] = fd_high;
8762 fdwalk(_fdwalk_close_func, lohi);
8763#else
Victor Stinner162c5672020-04-24 12:00:51 +02008764 fd_low = Py_MAX(fd_low, 0);
8765#ifdef __FreeBSD__
8766 if (fd_high >= sysconf(_SC_OPEN_MAX)) {
8767 /* Any errors encountered while closing file descriptors are ignored */
8768 closefrom(fd_low);
8769 }
8770 else
8771#endif
8772 {
8773 for (int i = fd_low; i < fd_high; i++) {
8774 /* Ignore errors */
8775 (void)close(i);
8776 }
8777 }
Jakub Kulíke20134f2019-09-11 17:11:57 +02008778#endif
Steve Dower8fc89802015-04-12 00:26:27 -04008779 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00008780 Py_END_ALLOW_THREADS
8781 Py_RETURN_NONE;
Christian Heimesfdab48e2008-01-20 09:06:41 +00008782}
8783
8784
Larry Hastings2f936352014-08-05 14:04:04 +10008785/*[clinic input]
8786os.dup -> int
8787
8788 fd: int
8789 /
8790
8791Return a duplicate of a file descriptor.
8792[clinic start generated code]*/
8793
Larry Hastings2f936352014-08-05 14:04:04 +10008794static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008795os_dup_impl(PyObject *module, int fd)
8796/*[clinic end generated code: output=486f4860636b2a9f input=6f10f7ea97f7852a]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008797{
8798 return _Py_dup(fd);
Guido van Rossum687dd131993-05-17 08:34:16 +00008799}
8800
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008801
Larry Hastings2f936352014-08-05 14:04:04 +10008802/*[clinic input]
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008803os.dup2 -> int
Larry Hastings2f936352014-08-05 14:04:04 +10008804 fd: int
8805 fd2: int
8806 inheritable: bool=True
8807
8808Duplicate file descriptor.
8809[clinic start generated code]*/
8810
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008811static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008812os_dup2_impl(PyObject *module, int fd, int fd2, int inheritable)
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008813/*[clinic end generated code: output=bc059d34a73404d1 input=c3cddda8922b038d]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008814{
Stéphane Wirtel3d86e482018-01-30 07:04:36 +01008815 int res = 0;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008816#if defined(HAVE_DUP3) && \
8817 !(defined(HAVE_FCNTL_H) && defined(F_DUP2FD_CLOEXEC))
8818 /* dup3() is available on Linux 2.6.27+ and glibc 2.9 */
Alexey Izbyshevb3caf382018-02-20 10:25:46 +03008819 static int dup3_works = -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008820#endif
8821
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008822 if (fd < 0 || fd2 < 0) {
8823 posix_error();
8824 return -1;
8825 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02008826
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008827 /* dup2() can fail with EINTR if the target FD is already open, because it
8828 * then has to be closed. See os_close_impl() for why we don't handle EINTR
8829 * upon close(), and therefore below.
8830 */
Victor Stinnerdaf45552013-08-28 00:53:59 +02008831#ifdef MS_WINDOWS
8832 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04008833 _Py_BEGIN_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00008834 res = dup2(fd, fd2);
Steve Dower8fc89802015-04-12 00:26:27 -04008835 _Py_END_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02008836 Py_END_ALLOW_THREADS
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008837 if (res < 0) {
8838 posix_error();
8839 return -1;
8840 }
8841 res = fd2; // msvcrt dup2 returns 0 on success.
Victor Stinnerdaf45552013-08-28 00:53:59 +02008842
8843 /* Character files like console cannot be make non-inheritable */
8844 if (!inheritable && _Py_set_inheritable(fd2, 0, NULL) < 0) {
8845 close(fd2);
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008846 return -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008847 }
8848
8849#elif defined(HAVE_FCNTL_H) && defined(F_DUP2FD_CLOEXEC)
8850 Py_BEGIN_ALLOW_THREADS
8851 if (!inheritable)
8852 res = fcntl(fd, F_DUP2FD_CLOEXEC, fd2);
8853 else
8854 res = dup2(fd, fd2);
8855 Py_END_ALLOW_THREADS
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008856 if (res < 0) {
8857 posix_error();
8858 return -1;
8859 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02008860
8861#else
8862
8863#ifdef HAVE_DUP3
8864 if (!inheritable && dup3_works != 0) {
8865 Py_BEGIN_ALLOW_THREADS
8866 res = dup3(fd, fd2, O_CLOEXEC);
8867 Py_END_ALLOW_THREADS
8868 if (res < 0) {
8869 if (dup3_works == -1)
8870 dup3_works = (errno != ENOSYS);
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008871 if (dup3_works) {
8872 posix_error();
8873 return -1;
8874 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02008875 }
8876 }
8877
8878 if (inheritable || dup3_works == 0)
8879 {
8880#endif
8881 Py_BEGIN_ALLOW_THREADS
8882 res = dup2(fd, fd2);
8883 Py_END_ALLOW_THREADS
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008884 if (res < 0) {
8885 posix_error();
8886 return -1;
8887 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02008888
8889 if (!inheritable && _Py_set_inheritable(fd2, 0, NULL) < 0) {
8890 close(fd2);
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008891 return -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008892 }
8893#ifdef HAVE_DUP3
8894 }
8895#endif
8896
8897#endif
8898
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008899 return res;
Guido van Rossum687dd131993-05-17 08:34:16 +00008900}
8901
Larry Hastings2f936352014-08-05 14:04:04 +10008902
Ross Lagerwall7807c352011-03-17 20:20:30 +02008903#ifdef HAVE_LOCKF
Larry Hastings2f936352014-08-05 14:04:04 +10008904/*[clinic input]
8905os.lockf
8906
8907 fd: int
8908 An open file descriptor.
8909 command: int
8910 One of F_LOCK, F_TLOCK, F_ULOCK or F_TEST.
8911 length: Py_off_t
8912 The number of bytes to lock, starting at the current position.
8913 /
8914
8915Apply, test or remove a POSIX lock on an open file descriptor.
8916
8917[clinic start generated code]*/
8918
Larry Hastings2f936352014-08-05 14:04:04 +10008919static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008920os_lockf_impl(PyObject *module, int fd, int command, Py_off_t length)
8921/*[clinic end generated code: output=af7051f3e7c29651 input=65da41d2106e9b79]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008922{
8923 int res;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008924
Saiyang Gou7514f4f2020-02-12 23:47:42 -08008925 if (PySys_Audit("os.lockf", "iiL", fd, command, length) < 0) {
8926 return NULL;
8927 }
8928
Ross Lagerwall7807c352011-03-17 20:20:30 +02008929 Py_BEGIN_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10008930 res = lockf(fd, command, length);
Ross Lagerwall7807c352011-03-17 20:20:30 +02008931 Py_END_ALLOW_THREADS
8932
8933 if (res < 0)
8934 return posix_error();
8935
8936 Py_RETURN_NONE;
8937}
Larry Hastings2f936352014-08-05 14:04:04 +10008938#endif /* HAVE_LOCKF */
Ross Lagerwall7807c352011-03-17 20:20:30 +02008939
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008940
Larry Hastings2f936352014-08-05 14:04:04 +10008941/*[clinic input]
8942os.lseek -> Py_off_t
8943
8944 fd: int
8945 position: Py_off_t
8946 how: int
8947 /
8948
8949Set the position of a file descriptor. Return the new position.
8950
8951Return the new cursor position in number of bytes
8952relative to the beginning of the file.
8953[clinic start generated code]*/
8954
Larry Hastings2f936352014-08-05 14:04:04 +10008955static Py_off_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008956os_lseek_impl(PyObject *module, int fd, Py_off_t position, int how)
8957/*[clinic end generated code: output=971e1efb6b30bd2f input=902654ad3f96a6d3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008958{
8959 Py_off_t result;
8960
Guido van Rossum687dd131993-05-17 08:34:16 +00008961#ifdef SEEK_SET
Victor Stinner8c62be82010-05-06 00:08:46 +00008962 /* Turn 0, 1, 2 into SEEK_{SET,CUR,END} */
8963 switch (how) {
Larry Hastings2f936352014-08-05 14:04:04 +10008964 case 0: how = SEEK_SET; break;
8965 case 1: how = SEEK_CUR; break;
8966 case 2: how = SEEK_END; break;
Victor Stinner8c62be82010-05-06 00:08:46 +00008967 }
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00008968#endif /* SEEK_END */
Guido van Rossum94f6f721999-01-06 18:42:14 +00008969
Victor Stinner8c62be82010-05-06 00:08:46 +00008970 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04008971 _Py_BEGIN_SUPPRESS_IPH
Victor Stinner14b9b112013-06-25 00:37:25 +02008972#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10008973 result = _lseeki64(fd, position, how);
Fred Drake699f3522000-06-29 21:12:41 +00008974#else
Larry Hastings2f936352014-08-05 14:04:04 +10008975 result = lseek(fd, position, how);
Fred Drake699f3522000-06-29 21:12:41 +00008976#endif
Steve Dower8fc89802015-04-12 00:26:27 -04008977 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00008978 Py_END_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10008979 if (result < 0)
8980 posix_error();
Guido van Rossum94f6f721999-01-06 18:42:14 +00008981
Larry Hastings2f936352014-08-05 14:04:04 +10008982 return result;
Guido van Rossum687dd131993-05-17 08:34:16 +00008983}
8984
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008985
Larry Hastings2f936352014-08-05 14:04:04 +10008986/*[clinic input]
8987os.read
8988 fd: int
8989 length: Py_ssize_t
8990 /
8991
8992Read from a file descriptor. Returns a bytes object.
8993[clinic start generated code]*/
8994
Larry Hastings2f936352014-08-05 14:04:04 +10008995static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008996os_read_impl(PyObject *module, int fd, Py_ssize_t length)
8997/*[clinic end generated code: output=dafbe9a5cddb987b input=1df2eaa27c0bf1d3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008998{
Victor Stinner8c62be82010-05-06 00:08:46 +00008999 Py_ssize_t n;
9000 PyObject *buffer;
Larry Hastings2f936352014-08-05 14:04:04 +10009001
9002 if (length < 0) {
Victor Stinner8c62be82010-05-06 00:08:46 +00009003 errno = EINVAL;
9004 return posix_error();
9005 }
Larry Hastings2f936352014-08-05 14:04:04 +10009006
Victor Stinner9a0d7a72018-11-22 15:03:40 +01009007 length = Py_MIN(length, _PY_READ_MAX);
Larry Hastings2f936352014-08-05 14:04:04 +10009008
9009 buffer = PyBytes_FromStringAndSize((char *)NULL, length);
Victor Stinner8c62be82010-05-06 00:08:46 +00009010 if (buffer == NULL)
9011 return NULL;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009012
Victor Stinner66aab0c2015-03-19 22:53:20 +01009013 n = _Py_read(fd, PyBytes_AS_STRING(buffer), length);
9014 if (n == -1) {
Victor Stinner8c62be82010-05-06 00:08:46 +00009015 Py_DECREF(buffer);
Victor Stinner66aab0c2015-03-19 22:53:20 +01009016 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00009017 }
Larry Hastings2f936352014-08-05 14:04:04 +10009018
9019 if (n != length)
Victor Stinner8c62be82010-05-06 00:08:46 +00009020 _PyBytes_Resize(&buffer, n);
Larry Hastings2f936352014-08-05 14:04:04 +10009021
Victor Stinner8c62be82010-05-06 00:08:46 +00009022 return buffer;
Guido van Rossum687dd131993-05-17 08:34:16 +00009023}
9024
Ross Lagerwall7807c352011-03-17 20:20:30 +02009025#if (defined(HAVE_SENDFILE) && (defined(__FreeBSD__) || defined(__DragonFly__) \
Serhiy Storchaka9d572732018-07-31 10:24:54 +03009026 || defined(__APPLE__))) \
9027 || defined(HAVE_READV) || defined(HAVE_PREADV) || defined (HAVE_PREADV2) \
9028 || defined(HAVE_WRITEV) || defined(HAVE_PWRITEV) || defined (HAVE_PWRITEV2)
9029static int
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009030iov_setup(struct iovec **iov, Py_buffer **buf, PyObject *seq, Py_ssize_t cnt, int type)
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009031{
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009032 Py_ssize_t i, j;
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00009033
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009034 *iov = PyMem_New(struct iovec, cnt);
9035 if (*iov == NULL) {
9036 PyErr_NoMemory();
Victor Stinner57ddf782014-01-08 15:21:28 +01009037 return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009038 }
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00009039
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009040 *buf = PyMem_New(Py_buffer, cnt);
9041 if (*buf == NULL) {
9042 PyMem_Del(*iov);
9043 PyErr_NoMemory();
Victor Stinner57ddf782014-01-08 15:21:28 +01009044 return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009045 }
9046
9047 for (i = 0; i < cnt; i++) {
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02009048 PyObject *item = PySequence_GetItem(seq, i);
9049 if (item == NULL)
9050 goto fail;
9051 if (PyObject_GetBuffer(item, &(*buf)[i], type) == -1) {
9052 Py_DECREF(item);
9053 goto fail;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009054 }
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02009055 Py_DECREF(item);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009056 (*iov)[i].iov_base = (*buf)[i].buf;
Serhiy Storchaka9d572732018-07-31 10:24:54 +03009057 (*iov)[i].iov_len = (*buf)[i].len;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009058 }
Serhiy Storchaka9d572732018-07-31 10:24:54 +03009059 return 0;
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02009060
9061fail:
9062 PyMem_Del(*iov);
9063 for (j = 0; j < i; j++) {
9064 PyBuffer_Release(&(*buf)[j]);
9065 }
9066 PyMem_Del(*buf);
Victor Stinner57ddf782014-01-08 15:21:28 +01009067 return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009068}
9069
9070static void
9071iov_cleanup(struct iovec *iov, Py_buffer *buf, int cnt)
9072{
9073 int i;
9074 PyMem_Del(iov);
9075 for (i = 0; i < cnt; i++) {
9076 PyBuffer_Release(&buf[i]);
9077 }
9078 PyMem_Del(buf);
9079}
9080#endif
9081
Larry Hastings2f936352014-08-05 14:04:04 +10009082
Ross Lagerwall7807c352011-03-17 20:20:30 +02009083#ifdef HAVE_READV
Larry Hastings2f936352014-08-05 14:04:04 +10009084/*[clinic input]
9085os.readv -> Py_ssize_t
9086
9087 fd: int
9088 buffers: object
9089 /
9090
9091Read from a file descriptor fd into an iterable of buffers.
9092
9093The buffers should be mutable buffers accepting bytes.
9094readv will transfer data into each buffer until it is full
9095and then move on to the next buffer in the sequence to hold
9096the rest of the data.
9097
9098readv returns the total number of bytes read,
9099which may be less than the total capacity of all the buffers.
9100[clinic start generated code]*/
9101
Larry Hastings2f936352014-08-05 14:04:04 +10009102static Py_ssize_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009103os_readv_impl(PyObject *module, int fd, PyObject *buffers)
9104/*[clinic end generated code: output=792da062d3fcebdb input=e679eb5dbfa0357d]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009105{
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009106 Py_ssize_t cnt, n;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009107 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009108 struct iovec *iov;
9109 Py_buffer *buf;
9110
Larry Hastings2f936352014-08-05 14:04:04 +10009111 if (!PySequence_Check(buffers)) {
Ross Lagerwall7807c352011-03-17 20:20:30 +02009112 PyErr_SetString(PyExc_TypeError,
9113 "readv() arg 2 must be a sequence");
Larry Hastings2f936352014-08-05 14:04:04 +10009114 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009115 }
Ross Lagerwall7807c352011-03-17 20:20:30 +02009116
Larry Hastings2f936352014-08-05 14:04:04 +10009117 cnt = PySequence_Size(buffers);
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009118 if (cnt < 0)
9119 return -1;
Larry Hastings2f936352014-08-05 14:04:04 +10009120
9121 if (iov_setup(&iov, &buf, buffers, cnt, PyBUF_WRITABLE) < 0)
9122 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009123
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009124 do {
9125 Py_BEGIN_ALLOW_THREADS
9126 n = readv(fd, iov, cnt);
9127 Py_END_ALLOW_THREADS
9128 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Ross Lagerwall7807c352011-03-17 20:20:30 +02009129
9130 iov_cleanup(iov, buf, cnt);
Larry Hastings2f936352014-08-05 14:04:04 +10009131 if (n < 0) {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009132 if (!async_err)
9133 posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10009134 return -1;
9135 }
Victor Stinner57ddf782014-01-08 15:21:28 +01009136
Larry Hastings2f936352014-08-05 14:04:04 +10009137 return n;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009138}
Larry Hastings2f936352014-08-05 14:04:04 +10009139#endif /* HAVE_READV */
9140
Ross Lagerwall7807c352011-03-17 20:20:30 +02009141
9142#ifdef HAVE_PREAD
Larry Hastings2f936352014-08-05 14:04:04 +10009143/*[clinic input]
Larry Hastings2f936352014-08-05 14:04:04 +10009144os.pread
9145
9146 fd: int
Dong-hee Naad7736f2019-09-25 14:47:04 +09009147 length: Py_ssize_t
Larry Hastings2f936352014-08-05 14:04:04 +10009148 offset: Py_off_t
9149 /
9150
9151Read a number of bytes from a file descriptor starting at a particular offset.
9152
9153Read length bytes from file descriptor fd, starting at offset bytes from
9154the beginning of the file. The file offset remains unchanged.
9155[clinic start generated code]*/
9156
Larry Hastings2f936352014-08-05 14:04:04 +10009157static PyObject *
Dong-hee Naad7736f2019-09-25 14:47:04 +09009158os_pread_impl(PyObject *module, int fd, Py_ssize_t length, Py_off_t offset)
9159/*[clinic end generated code: output=3f875c1eef82e32f input=85cb4a5589627144]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009160{
Ross Lagerwall7807c352011-03-17 20:20:30 +02009161 Py_ssize_t n;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009162 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009163 PyObject *buffer;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009164
Larry Hastings2f936352014-08-05 14:04:04 +10009165 if (length < 0) {
Ross Lagerwall7807c352011-03-17 20:20:30 +02009166 errno = EINVAL;
9167 return posix_error();
9168 }
Larry Hastings2f936352014-08-05 14:04:04 +10009169 buffer = PyBytes_FromStringAndSize((char *)NULL, length);
Ross Lagerwall7807c352011-03-17 20:20:30 +02009170 if (buffer == NULL)
9171 return NULL;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009172
9173 do {
9174 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04009175 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009176 n = pread(fd, PyBytes_AS_STRING(buffer), length, offset);
Steve Dower8fc89802015-04-12 00:26:27 -04009177 _Py_END_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009178 Py_END_ALLOW_THREADS
9179 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
9180
Ross Lagerwall7807c352011-03-17 20:20:30 +02009181 if (n < 0) {
9182 Py_DECREF(buffer);
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009183 return (!async_err) ? posix_error() : NULL;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009184 }
Larry Hastings2f936352014-08-05 14:04:04 +10009185 if (n != length)
Ross Lagerwall7807c352011-03-17 20:20:30 +02009186 _PyBytes_Resize(&buffer, n);
9187 return buffer;
9188}
Larry Hastings2f936352014-08-05 14:04:04 +10009189#endif /* HAVE_PREAD */
Ross Lagerwall7807c352011-03-17 20:20:30 +02009190
Pablo Galindo4defba32018-01-27 16:16:37 +00009191#if defined(HAVE_PREADV) || defined (HAVE_PREADV2)
9192/*[clinic input]
9193os.preadv -> Py_ssize_t
9194
9195 fd: int
9196 buffers: object
9197 offset: Py_off_t
9198 flags: int = 0
9199 /
9200
9201Reads from a file descriptor into a number of mutable bytes-like objects.
9202
9203Combines the functionality of readv() and pread(). As readv(), it will
9204transfer data into each buffer until it is full and then move on to the next
9205buffer in the sequence to hold the rest of the data. Its fourth argument,
9206specifies the file offset at which the input operation is to be performed. It
9207will return the total number of bytes read (which can be less than the total
9208capacity of all the objects).
9209
9210The flags argument contains a bitwise OR of zero or more of the following flags:
9211
9212- RWF_HIPRI
9213- RWF_NOWAIT
9214
9215Using non-zero flags requires Linux 4.6 or newer.
9216[clinic start generated code]*/
9217
9218static Py_ssize_t
9219os_preadv_impl(PyObject *module, int fd, PyObject *buffers, Py_off_t offset,
9220 int flags)
9221/*[clinic end generated code: output=26fc9c6e58e7ada5 input=4173919dc1f7ed99]*/
9222{
9223 Py_ssize_t cnt, n;
9224 int async_err = 0;
9225 struct iovec *iov;
9226 Py_buffer *buf;
9227
9228 if (!PySequence_Check(buffers)) {
9229 PyErr_SetString(PyExc_TypeError,
9230 "preadv2() arg 2 must be a sequence");
9231 return -1;
9232 }
9233
9234 cnt = PySequence_Size(buffers);
9235 if (cnt < 0) {
9236 return -1;
9237 }
9238
9239#ifndef HAVE_PREADV2
9240 if(flags != 0) {
9241 argument_unavailable_error("preadv2", "flags");
9242 return -1;
9243 }
9244#endif
9245
9246 if (iov_setup(&iov, &buf, buffers, cnt, PyBUF_WRITABLE) < 0) {
9247 return -1;
9248 }
9249#ifdef HAVE_PREADV2
9250 do {
9251 Py_BEGIN_ALLOW_THREADS
9252 _Py_BEGIN_SUPPRESS_IPH
9253 n = preadv2(fd, iov, cnt, offset, flags);
9254 _Py_END_SUPPRESS_IPH
9255 Py_END_ALLOW_THREADS
9256 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
9257#else
9258 do {
9259 Py_BEGIN_ALLOW_THREADS
9260 _Py_BEGIN_SUPPRESS_IPH
9261 n = preadv(fd, iov, cnt, offset);
9262 _Py_END_SUPPRESS_IPH
9263 Py_END_ALLOW_THREADS
9264 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
9265#endif
9266
9267 iov_cleanup(iov, buf, cnt);
9268 if (n < 0) {
9269 if (!async_err) {
9270 posix_error();
9271 }
9272 return -1;
9273 }
9274
9275 return n;
9276}
9277#endif /* HAVE_PREADV */
9278
Larry Hastings2f936352014-08-05 14:04:04 +10009279
9280/*[clinic input]
9281os.write -> Py_ssize_t
9282
9283 fd: int
9284 data: Py_buffer
9285 /
9286
9287Write a bytes object to a file descriptor.
9288[clinic start generated code]*/
9289
Larry Hastings2f936352014-08-05 14:04:04 +10009290static Py_ssize_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009291os_write_impl(PyObject *module, int fd, Py_buffer *data)
9292/*[clinic end generated code: output=e4ef5bc904b58ef9 input=3207e28963234f3c]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009293{
Victor Stinner66aab0c2015-03-19 22:53:20 +01009294 return _Py_write(fd, data->buf, data->len);
Ross Lagerwall7807c352011-03-17 20:20:30 +02009295}
9296
9297#ifdef HAVE_SENDFILE
Serhiy Storchaka2b560312020-04-18 19:14:10 +03009298#ifdef __APPLE__
9299/*[clinic input]
9300os.sendfile
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009301
Serhiy Storchaka2b560312020-04-18 19:14:10 +03009302 out_fd: int
9303 in_fd: int
9304 offset: Py_off_t
9305 count as sbytes: Py_off_t
9306 headers: object(c_default="NULL") = ()
9307 trailers: object(c_default="NULL") = ()
9308 flags: int = 0
9309
9310Copy count bytes from file descriptor in_fd to file descriptor out_fd.
9311[clinic start generated code]*/
9312
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009313static PyObject *
Serhiy Storchaka2b560312020-04-18 19:14:10 +03009314os_sendfile_impl(PyObject *module, int out_fd, int in_fd, Py_off_t offset,
9315 Py_off_t sbytes, PyObject *headers, PyObject *trailers,
9316 int flags)
9317/*[clinic end generated code: output=81c4bcd143f5c82b input=b0d72579d4c69afa]*/
9318#elif defined(__FreeBSD__) || defined(__DragonFly__)
9319/*[clinic input]
9320os.sendfile
9321
9322 out_fd: int
9323 in_fd: int
9324 offset: Py_off_t
9325 count: Py_ssize_t
9326 headers: object(c_default="NULL") = ()
9327 trailers: object(c_default="NULL") = ()
9328 flags: int = 0
9329
9330Copy count bytes from file descriptor in_fd to file descriptor out_fd.
9331[clinic start generated code]*/
9332
9333static PyObject *
9334os_sendfile_impl(PyObject *module, int out_fd, int in_fd, Py_off_t offset,
9335 Py_ssize_t count, PyObject *headers, PyObject *trailers,
9336 int flags)
9337/*[clinic end generated code: output=329ea009bdd55afc input=338adb8ff84ae8cd]*/
9338#else
9339/*[clinic input]
9340os.sendfile
9341
9342 out_fd: int
9343 in_fd: int
9344 offset as offobj: object
9345 count: Py_ssize_t
9346
9347Copy count bytes from file descriptor in_fd to file descriptor out_fd.
9348[clinic start generated code]*/
9349
9350static PyObject *
9351os_sendfile_impl(PyObject *module, int out_fd, int in_fd, PyObject *offobj,
9352 Py_ssize_t count)
9353/*[clinic end generated code: output=ae81216e40f167d8 input=76d64058c74477ba]*/
9354#endif
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009355{
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009356 Py_ssize_t ret;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009357 int async_err = 0;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009358
9359#if defined(__FreeBSD__) || defined(__DragonFly__) || defined(__APPLE__)
9360#ifndef __APPLE__
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009361 off_t sbytes;
Serhiy Storchaka2b560312020-04-18 19:14:10 +03009362#endif
9363 Py_buffer *hbuf, *tbuf;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009364 struct sf_hdtr sf;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009365
Victor Stinner6ce0dbf2013-07-07 16:32:36 +02009366 sf.headers = NULL;
9367 sf.trailers = NULL;
9368
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009369 if (headers != NULL) {
9370 if (!PySequence_Check(headers)) {
9371 PyErr_SetString(PyExc_TypeError,
Martin Panter94994132015-09-09 05:29:24 +00009372 "sendfile() headers must be a sequence");
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009373 return NULL;
9374 } else {
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009375 Py_ssize_t i = PySequence_Size(headers);
9376 if (i < 0)
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009377 return NULL;
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009378 if (i > INT_MAX) {
9379 PyErr_SetString(PyExc_OverflowError,
9380 "sendfile() header is too large");
9381 return NULL;
9382 }
9383 if (i > 0) {
9384 sf.hdr_cnt = (int)i;
Serhiy Storchaka9d572732018-07-31 10:24:54 +03009385 if (iov_setup(&(sf.headers), &hbuf,
9386 headers, sf.hdr_cnt, PyBUF_SIMPLE) < 0)
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009387 return NULL;
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00009388#ifdef __APPLE__
Serhiy Storchaka9d572732018-07-31 10:24:54 +03009389 for (i = 0; i < sf.hdr_cnt; i++) {
9390 Py_ssize_t blen = sf.headers[i].iov_len;
9391# define OFF_T_MAX 0x7fffffffffffffff
9392 if (sbytes >= OFF_T_MAX - blen) {
9393 PyErr_SetString(PyExc_OverflowError,
9394 "sendfile() header is too large");
9395 return NULL;
9396 }
9397 sbytes += blen;
9398 }
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00009399#endif
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009400 }
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009401 }
9402 }
9403 if (trailers != NULL) {
9404 if (!PySequence_Check(trailers)) {
9405 PyErr_SetString(PyExc_TypeError,
Martin Panter94994132015-09-09 05:29:24 +00009406 "sendfile() trailers must be a sequence");
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009407 return NULL;
9408 } else {
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009409 Py_ssize_t i = PySequence_Size(trailers);
9410 if (i < 0)
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009411 return NULL;
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009412 if (i > INT_MAX) {
9413 PyErr_SetString(PyExc_OverflowError,
9414 "sendfile() trailer is too large");
9415 return NULL;
9416 }
9417 if (i > 0) {
9418 sf.trl_cnt = (int)i;
Serhiy Storchaka9d572732018-07-31 10:24:54 +03009419 if (iov_setup(&(sf.trailers), &tbuf,
9420 trailers, sf.trl_cnt, PyBUF_SIMPLE) < 0)
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009421 return NULL;
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009422 }
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009423 }
9424 }
9425
Steve Dower8fc89802015-04-12 00:26:27 -04009426 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009427 do {
9428 Py_BEGIN_ALLOW_THREADS
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009429#ifdef __APPLE__
Serhiy Storchaka2b560312020-04-18 19:14:10 +03009430 ret = sendfile(in_fd, out_fd, offset, &sbytes, &sf, flags);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009431#else
Serhiy Storchaka2b560312020-04-18 19:14:10 +03009432 ret = sendfile(in_fd, out_fd, offset, count, &sf, &sbytes, flags);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009433#endif
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009434 Py_END_ALLOW_THREADS
9435 } while (ret < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Steve Dower8fc89802015-04-12 00:26:27 -04009436 _Py_END_SUPPRESS_IPH
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009437
9438 if (sf.headers != NULL)
9439 iov_cleanup(sf.headers, hbuf, sf.hdr_cnt);
9440 if (sf.trailers != NULL)
9441 iov_cleanup(sf.trailers, tbuf, sf.trl_cnt);
9442
9443 if (ret < 0) {
9444 if ((errno == EAGAIN) || (errno == EBUSY)) {
9445 if (sbytes != 0) {
9446 // some data has been sent
9447 goto done;
9448 }
9449 else {
9450 // no data has been sent; upper application is supposed
9451 // to retry on EAGAIN or EBUSY
9452 return posix_error();
9453 }
9454 }
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009455 return (!async_err) ? posix_error() : NULL;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009456 }
9457 goto done;
9458
9459done:
9460 #if !defined(HAVE_LARGEFILE_SUPPORT)
9461 return Py_BuildValue("l", sbytes);
9462 #else
9463 return Py_BuildValue("L", sbytes);
9464 #endif
9465
9466#else
Benjamin Peterson840ef8f2016-09-07 14:45:10 -07009467#ifdef __linux__
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009468 if (offobj == Py_None) {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009469 do {
9470 Py_BEGIN_ALLOW_THREADS
Serhiy Storchaka2b560312020-04-18 19:14:10 +03009471 ret = sendfile(out_fd, in_fd, NULL, count);
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009472 Py_END_ALLOW_THREADS
9473 } while (ret < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009474 if (ret < 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009475 return (!async_err) ? posix_error() : NULL;
Giampaolo Rodola'ff1a7352011-04-19 09:47:16 +02009476 return Py_BuildValue("n", ret);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009477 }
9478#endif
Serhiy Storchaka2b560312020-04-18 19:14:10 +03009479 off_t offset;
Larry Hastings2f936352014-08-05 14:04:04 +10009480 if (!Py_off_t_converter(offobj, &offset))
Antoine Pitroudcc20b82011-02-26 13:38:35 +00009481 return NULL;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009482
9483 do {
9484 Py_BEGIN_ALLOW_THREADS
Serhiy Storchaka2b560312020-04-18 19:14:10 +03009485 ret = sendfile(out_fd, in_fd, &offset, count);
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009486 Py_END_ALLOW_THREADS
9487 } while (ret < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009488 if (ret < 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009489 return (!async_err) ? posix_error() : NULL;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009490 return Py_BuildValue("n", ret);
9491#endif
9492}
Larry Hastings2f936352014-08-05 14:04:04 +10009493#endif /* HAVE_SENDFILE */
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00009494
Larry Hastings2f936352014-08-05 14:04:04 +10009495
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +02009496#if defined(__APPLE__)
9497/*[clinic input]
9498os._fcopyfile
9499
Serhiy Storchaka140a7d12019-10-13 11:59:31 +03009500 in_fd: int
9501 out_fd: int
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +02009502 flags: int
9503 /
9504
Giampaolo Rodolac7f02a92018-06-19 08:27:29 -07009505Efficiently copy content or metadata of 2 regular file descriptors (macOS).
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +02009506[clinic start generated code]*/
9507
9508static PyObject *
Serhiy Storchaka140a7d12019-10-13 11:59:31 +03009509os__fcopyfile_impl(PyObject *module, int in_fd, int out_fd, int flags)
9510/*[clinic end generated code: output=c9d1a35a992e401b input=1e34638a86948795]*/
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +02009511{
9512 int ret;
9513
9514 Py_BEGIN_ALLOW_THREADS
Serhiy Storchaka140a7d12019-10-13 11:59:31 +03009515 ret = fcopyfile(in_fd, out_fd, NULL, flags);
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +02009516 Py_END_ALLOW_THREADS
9517 if (ret < 0)
9518 return posix_error();
9519 Py_RETURN_NONE;
9520}
9521#endif
9522
9523
Larry Hastings2f936352014-08-05 14:04:04 +10009524/*[clinic input]
9525os.fstat
9526
9527 fd : int
9528
9529Perform a stat system call on the given file descriptor.
9530
9531Like stat(), but for an open file descriptor.
9532Equivalent to os.stat(fd).
9533[clinic start generated code]*/
9534
Larry Hastings2f936352014-08-05 14:04:04 +10009535static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009536os_fstat_impl(PyObject *module, int fd)
9537/*[clinic end generated code: output=efc038cb5f654492 input=27e0e0ebbe5600c9]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009538{
Victor Stinner8c62be82010-05-06 00:08:46 +00009539 STRUCT_STAT st;
9540 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009541 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10009542
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009543 do {
9544 Py_BEGIN_ALLOW_THREADS
9545 res = FSTAT(fd, &st);
9546 Py_END_ALLOW_THREADS
9547 } while (res != 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Victor Stinner8c62be82010-05-06 00:08:46 +00009548 if (res != 0) {
Martin v. Löwis14694662006-02-03 12:54:16 +00009549#ifdef MS_WINDOWS
Victor Stinnerb024e842012-10-31 22:24:06 +01009550 return PyErr_SetFromWindowsErr(0);
Martin v. Löwis14694662006-02-03 12:54:16 +00009551#else
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009552 return (!async_err) ? posix_error() : NULL;
Martin v. Löwis14694662006-02-03 12:54:16 +00009553#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00009554 }
Tim Peters5aa91602002-01-30 05:46:57 +00009555
Victor Stinner1c2fa782020-05-10 11:05:29 +02009556 return _pystat_fromstructstat(module, &st);
Guido van Rossum687dd131993-05-17 08:34:16 +00009557}
9558
Larry Hastings2f936352014-08-05 14:04:04 +10009559
9560/*[clinic input]
9561os.isatty -> bool
9562 fd: int
9563 /
9564
9565Return True if the fd is connected to a terminal.
9566
9567Return True if the file descriptor is an open file descriptor
9568connected to the slave end of a terminal.
9569[clinic start generated code]*/
9570
Larry Hastings2f936352014-08-05 14:04:04 +10009571static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009572os_isatty_impl(PyObject *module, int fd)
9573/*[clinic end generated code: output=6a48c8b4e644ca00 input=08ce94aa1eaf7b5e]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009574{
Steve Dower8fc89802015-04-12 00:26:27 -04009575 int return_value;
Steve Dower8fc89802015-04-12 00:26:27 -04009576 _Py_BEGIN_SUPPRESS_IPH
9577 return_value = isatty(fd);
9578 _Py_END_SUPPRESS_IPH
9579 return return_value;
Larry Hastings2f936352014-08-05 14:04:04 +10009580}
9581
9582
Guido van Rossuma4916fa1996-05-23 22:58:55 +00009583#ifdef HAVE_PIPE
Larry Hastings2f936352014-08-05 14:04:04 +10009584/*[clinic input]
9585os.pipe
9586
9587Create a pipe.
9588
9589Returns a tuple of two file descriptors:
9590 (read_fd, write_fd)
9591[clinic start generated code]*/
9592
Larry Hastings2f936352014-08-05 14:04:04 +10009593static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009594os_pipe_impl(PyObject *module)
9595/*[clinic end generated code: output=ff9b76255793b440 input=02535e8c8fa6c4d4]*/
Guido van Rossum687dd131993-05-17 08:34:16 +00009596{
Victor Stinner8c62be82010-05-06 00:08:46 +00009597 int fds[2];
Victor Stinnerdaf45552013-08-28 00:53:59 +02009598#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00009599 HANDLE read, write;
Victor Stinnerdaf45552013-08-28 00:53:59 +02009600 SECURITY_ATTRIBUTES attr;
Victor Stinner8c62be82010-05-06 00:08:46 +00009601 BOOL ok;
Victor Stinnerdaf45552013-08-28 00:53:59 +02009602#else
9603 int res;
9604#endif
9605
9606#ifdef MS_WINDOWS
9607 attr.nLength = sizeof(attr);
9608 attr.lpSecurityDescriptor = NULL;
9609 attr.bInheritHandle = FALSE;
9610
9611 Py_BEGIN_ALLOW_THREADS
Steve Dowerc3630612016-11-19 18:41:16 -08009612 _Py_BEGIN_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02009613 ok = CreatePipe(&read, &write, &attr, 0);
9614 if (ok) {
Benjamin Petersonca470632016-09-06 13:47:26 -07009615 fds[0] = _open_osfhandle((intptr_t)read, _O_RDONLY);
9616 fds[1] = _open_osfhandle((intptr_t)write, _O_WRONLY);
Victor Stinnerdaf45552013-08-28 00:53:59 +02009617 if (fds[0] == -1 || fds[1] == -1) {
9618 CloseHandle(read);
9619 CloseHandle(write);
9620 ok = 0;
9621 }
9622 }
Steve Dowerc3630612016-11-19 18:41:16 -08009623 _Py_END_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02009624 Py_END_ALLOW_THREADS
9625
Victor Stinner8c62be82010-05-06 00:08:46 +00009626 if (!ok)
Victor Stinnerb024e842012-10-31 22:24:06 +01009627 return PyErr_SetFromWindowsErr(0);
Victor Stinnerdaf45552013-08-28 00:53:59 +02009628#else
9629
9630#ifdef HAVE_PIPE2
9631 Py_BEGIN_ALLOW_THREADS
9632 res = pipe2(fds, O_CLOEXEC);
9633 Py_END_ALLOW_THREADS
9634
9635 if (res != 0 && errno == ENOSYS)
9636 {
9637#endif
9638 Py_BEGIN_ALLOW_THREADS
9639 res = pipe(fds);
9640 Py_END_ALLOW_THREADS
9641
9642 if (res == 0) {
9643 if (_Py_set_inheritable(fds[0], 0, NULL) < 0) {
9644 close(fds[0]);
9645 close(fds[1]);
9646 return NULL;
9647 }
9648 if (_Py_set_inheritable(fds[1], 0, NULL) < 0) {
9649 close(fds[0]);
9650 close(fds[1]);
9651 return NULL;
9652 }
9653 }
9654#ifdef HAVE_PIPE2
9655 }
9656#endif
9657
9658 if (res != 0)
9659 return PyErr_SetFromErrno(PyExc_OSError);
9660#endif /* !MS_WINDOWS */
9661 return Py_BuildValue("(ii)", fds[0], fds[1]);
Guido van Rossum687dd131993-05-17 08:34:16 +00009662}
Guido van Rossuma4916fa1996-05-23 22:58:55 +00009663#endif /* HAVE_PIPE */
9664
Larry Hastings2f936352014-08-05 14:04:04 +10009665
Charles-François Natalidaafdd52011-05-29 20:07:40 +02009666#ifdef HAVE_PIPE2
Larry Hastings2f936352014-08-05 14:04:04 +10009667/*[clinic input]
9668os.pipe2
9669
9670 flags: int
9671 /
9672
9673Create a pipe with flags set atomically.
9674
9675Returns a tuple of two file descriptors:
9676 (read_fd, write_fd)
9677
9678flags can be constructed by ORing together one or more of these values:
9679O_NONBLOCK, O_CLOEXEC.
9680[clinic start generated code]*/
9681
Larry Hastings2f936352014-08-05 14:04:04 +10009682static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009683os_pipe2_impl(PyObject *module, int flags)
9684/*[clinic end generated code: output=25751fb43a45540f input=f261b6e7e63c6817]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009685{
Charles-François Natalidaafdd52011-05-29 20:07:40 +02009686 int fds[2];
9687 int res;
9688
Charles-François Natalidaafdd52011-05-29 20:07:40 +02009689 res = pipe2(fds, flags);
9690 if (res != 0)
9691 return posix_error();
9692 return Py_BuildValue("(ii)", fds[0], fds[1]);
9693}
9694#endif /* HAVE_PIPE2 */
9695
Larry Hastings2f936352014-08-05 14:04:04 +10009696
Ross Lagerwall7807c352011-03-17 20:20:30 +02009697#ifdef HAVE_WRITEV
Larry Hastings2f936352014-08-05 14:04:04 +10009698/*[clinic input]
9699os.writev -> Py_ssize_t
9700 fd: int
9701 buffers: object
9702 /
9703
9704Iterate over buffers, and write the contents of each to a file descriptor.
9705
9706Returns the total number of bytes written.
9707buffers must be a sequence of bytes-like objects.
9708[clinic start generated code]*/
9709
Larry Hastings2f936352014-08-05 14:04:04 +10009710static Py_ssize_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009711os_writev_impl(PyObject *module, int fd, PyObject *buffers)
9712/*[clinic end generated code: output=56565cfac3aac15b input=5b8d17fe4189d2fe]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009713{
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009714 Py_ssize_t cnt;
Larry Hastings2f936352014-08-05 14:04:04 +10009715 Py_ssize_t result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009716 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009717 struct iovec *iov;
9718 Py_buffer *buf;
Larry Hastings2f936352014-08-05 14:04:04 +10009719
9720 if (!PySequence_Check(buffers)) {
Ross Lagerwall7807c352011-03-17 20:20:30 +02009721 PyErr_SetString(PyExc_TypeError,
9722 "writev() arg 2 must be a sequence");
Larry Hastings2f936352014-08-05 14:04:04 +10009723 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009724 }
Larry Hastings2f936352014-08-05 14:04:04 +10009725 cnt = PySequence_Size(buffers);
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009726 if (cnt < 0)
9727 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009728
Larry Hastings2f936352014-08-05 14:04:04 +10009729 if (iov_setup(&iov, &buf, buffers, cnt, PyBUF_SIMPLE) < 0) {
9730 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009731 }
9732
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009733 do {
9734 Py_BEGIN_ALLOW_THREADS
9735 result = writev(fd, iov, cnt);
9736 Py_END_ALLOW_THREADS
9737 } while (result < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Ross Lagerwall7807c352011-03-17 20:20:30 +02009738
9739 iov_cleanup(iov, buf, cnt);
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009740 if (result < 0 && !async_err)
Larry Hastings2f936352014-08-05 14:04:04 +10009741 posix_error();
Victor Stinner57ddf782014-01-08 15:21:28 +01009742
Georg Brandl306336b2012-06-24 12:55:33 +02009743 return result;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009744}
Larry Hastings2f936352014-08-05 14:04:04 +10009745#endif /* HAVE_WRITEV */
9746
9747
9748#ifdef HAVE_PWRITE
9749/*[clinic input]
9750os.pwrite -> Py_ssize_t
9751
9752 fd: int
9753 buffer: Py_buffer
9754 offset: Py_off_t
9755 /
9756
9757Write bytes to a file descriptor starting at a particular offset.
9758
9759Write buffer to fd, starting at offset bytes from the beginning of
9760the file. Returns the number of bytes writte. Does not change the
9761current file offset.
9762[clinic start generated code]*/
9763
Larry Hastings2f936352014-08-05 14:04:04 +10009764static Py_ssize_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009765os_pwrite_impl(PyObject *module, int fd, Py_buffer *buffer, Py_off_t offset)
9766/*[clinic end generated code: output=c74da630758ee925 input=19903f1b3dd26377]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009767{
9768 Py_ssize_t size;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009769 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10009770
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009771 do {
9772 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04009773 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009774 size = pwrite(fd, buffer->buf, (size_t)buffer->len, offset);
Steve Dower8fc89802015-04-12 00:26:27 -04009775 _Py_END_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009776 Py_END_ALLOW_THREADS
9777 } while (size < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Larry Hastings2f936352014-08-05 14:04:04 +10009778
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009779 if (size < 0 && !async_err)
Larry Hastings2f936352014-08-05 14:04:04 +10009780 posix_error();
9781 return size;
9782}
9783#endif /* HAVE_PWRITE */
9784
Pablo Galindo4defba32018-01-27 16:16:37 +00009785#if defined(HAVE_PWRITEV) || defined (HAVE_PWRITEV2)
9786/*[clinic input]
9787os.pwritev -> Py_ssize_t
9788
9789 fd: int
9790 buffers: object
9791 offset: Py_off_t
9792 flags: int = 0
9793 /
9794
9795Writes the contents of bytes-like objects to a file descriptor at a given offset.
9796
9797Combines the functionality of writev() and pwrite(). All buffers must be a sequence
9798of bytes-like objects. Buffers are processed in array order. Entire contents of first
9799buffer is written before proceeding to second, and so on. The operating system may
9800set a limit (sysconf() value SC_IOV_MAX) on the number of buffers that can be used.
9801This function writes the contents of each object to the file descriptor and returns
9802the total number of bytes written.
9803
9804The flags argument contains a bitwise OR of zero or more of the following flags:
9805
9806- RWF_DSYNC
9807- RWF_SYNC
YoSTEALTH76ef2552020-05-27 15:32:22 -06009808- RWF_APPEND
Pablo Galindo4defba32018-01-27 16:16:37 +00009809
9810Using non-zero flags requires Linux 4.7 or newer.
9811[clinic start generated code]*/
9812
9813static Py_ssize_t
9814os_pwritev_impl(PyObject *module, int fd, PyObject *buffers, Py_off_t offset,
9815 int flags)
YoSTEALTH76ef2552020-05-27 15:32:22 -06009816/*[clinic end generated code: output=e3dd3e9d11a6a5c7 input=35358c327e1a2a8e]*/
Pablo Galindo4defba32018-01-27 16:16:37 +00009817{
9818 Py_ssize_t cnt;
9819 Py_ssize_t result;
9820 int async_err = 0;
9821 struct iovec *iov;
9822 Py_buffer *buf;
9823
9824 if (!PySequence_Check(buffers)) {
9825 PyErr_SetString(PyExc_TypeError,
9826 "pwritev() arg 2 must be a sequence");
9827 return -1;
9828 }
9829
9830 cnt = PySequence_Size(buffers);
9831 if (cnt < 0) {
9832 return -1;
9833 }
9834
9835#ifndef HAVE_PWRITEV2
9836 if(flags != 0) {
9837 argument_unavailable_error("pwritev2", "flags");
9838 return -1;
9839 }
9840#endif
9841
9842 if (iov_setup(&iov, &buf, buffers, cnt, PyBUF_SIMPLE) < 0) {
9843 return -1;
9844 }
9845#ifdef HAVE_PWRITEV2
9846 do {
9847 Py_BEGIN_ALLOW_THREADS
9848 _Py_BEGIN_SUPPRESS_IPH
9849 result = pwritev2(fd, iov, cnt, offset, flags);
9850 _Py_END_SUPPRESS_IPH
9851 Py_END_ALLOW_THREADS
9852 } while (result < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
9853#else
9854 do {
9855 Py_BEGIN_ALLOW_THREADS
9856 _Py_BEGIN_SUPPRESS_IPH
9857 result = pwritev(fd, iov, cnt, offset);
9858 _Py_END_SUPPRESS_IPH
9859 Py_END_ALLOW_THREADS
9860 } while (result < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
9861#endif
9862
9863 iov_cleanup(iov, buf, cnt);
9864 if (result < 0) {
9865 if (!async_err) {
9866 posix_error();
9867 }
9868 return -1;
9869 }
9870
9871 return result;
9872}
9873#endif /* HAVE_PWRITEV */
9874
Pablo Galindoaac4d032019-05-31 19:39:47 +01009875#ifdef HAVE_COPY_FILE_RANGE
9876/*[clinic input]
9877
9878os.copy_file_range
9879 src: int
9880 Source file descriptor.
9881 dst: int
9882 Destination file descriptor.
9883 count: Py_ssize_t
9884 Number of bytes to copy.
9885 offset_src: object = None
9886 Starting offset in src.
9887 offset_dst: object = None
9888 Starting offset in dst.
9889
9890Copy count bytes from one file descriptor to another.
9891
9892If offset_src is None, then src is read from the current position;
9893respectively for offset_dst.
9894[clinic start generated code]*/
9895
9896static PyObject *
9897os_copy_file_range_impl(PyObject *module, int src, int dst, Py_ssize_t count,
9898 PyObject *offset_src, PyObject *offset_dst)
9899/*[clinic end generated code: output=1a91713a1d99fc7a input=42fdce72681b25a9]*/
9900{
9901 off_t offset_src_val, offset_dst_val;
9902 off_t *p_offset_src = NULL;
9903 off_t *p_offset_dst = NULL;
9904 Py_ssize_t ret;
9905 int async_err = 0;
9906 /* The flags argument is provided to allow
9907 * for future extensions and currently must be to 0. */
9908 int flags = 0;
Pablo Galindo4defba32018-01-27 16:16:37 +00009909
9910
Pablo Galindoaac4d032019-05-31 19:39:47 +01009911 if (count < 0) {
9912 PyErr_SetString(PyExc_ValueError, "negative value for 'count' not allowed");
9913 return NULL;
9914 }
9915
9916 if (offset_src != Py_None) {
9917 if (!Py_off_t_converter(offset_src, &offset_src_val)) {
9918 return NULL;
9919 }
9920 p_offset_src = &offset_src_val;
9921 }
9922
9923 if (offset_dst != Py_None) {
9924 if (!Py_off_t_converter(offset_dst, &offset_dst_val)) {
9925 return NULL;
9926 }
9927 p_offset_dst = &offset_dst_val;
9928 }
9929
9930 do {
9931 Py_BEGIN_ALLOW_THREADS
9932 ret = copy_file_range(src, p_offset_src, dst, p_offset_dst, count, flags);
9933 Py_END_ALLOW_THREADS
9934 } while (ret < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
9935
9936 if (ret < 0) {
9937 return (!async_err) ? posix_error() : NULL;
9938 }
9939
9940 return PyLong_FromSsize_t(ret);
9941}
9942#endif /* HAVE_COPY_FILE_RANGE*/
Larry Hastings2f936352014-08-05 14:04:04 +10009943
9944#ifdef HAVE_MKFIFO
9945/*[clinic input]
9946os.mkfifo
9947
9948 path: path_t
9949 mode: int=0o666
9950 *
9951 dir_fd: dir_fd(requires='mkfifoat')=None
9952
9953Create a "fifo" (a POSIX named pipe).
9954
9955If dir_fd is not None, it should be a file descriptor open to a directory,
9956 and path should be relative; path will then be relative to that directory.
9957dir_fd may not be implemented on your platform.
9958 If it is unavailable, using it will raise a NotImplementedError.
9959[clinic start generated code]*/
9960
Larry Hastings2f936352014-08-05 14:04:04 +10009961static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009962os_mkfifo_impl(PyObject *module, path_t *path, int mode, int dir_fd)
9963/*[clinic end generated code: output=ce41cfad0e68c940 input=73032e98a36e0e19]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009964{
9965 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009966 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10009967
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009968 do {
9969 Py_BEGIN_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10009970#ifdef HAVE_MKFIFOAT
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009971 if (dir_fd != DEFAULT_DIR_FD)
9972 result = mkfifoat(dir_fd, path->narrow, mode);
9973 else
Ross Lagerwall7807c352011-03-17 20:20:30 +02009974#endif
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009975 result = mkfifo(path->narrow, mode);
9976 Py_END_ALLOW_THREADS
9977 } while (result != 0 && errno == EINTR &&
9978 !(async_err = PyErr_CheckSignals()));
9979 if (result != 0)
9980 return (!async_err) ? posix_error() : NULL;
Larry Hastings2f936352014-08-05 14:04:04 +10009981
9982 Py_RETURN_NONE;
9983}
9984#endif /* HAVE_MKFIFO */
9985
9986
9987#if defined(HAVE_MKNOD) && defined(HAVE_MAKEDEV)
9988/*[clinic input]
9989os.mknod
9990
9991 path: path_t
9992 mode: int=0o600
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +02009993 device: dev_t=0
Larry Hastings2f936352014-08-05 14:04:04 +10009994 *
9995 dir_fd: dir_fd(requires='mknodat')=None
9996
9997Create a node in the file system.
9998
9999Create a node in the file system (file, device special file or named pipe)
10000at path. mode specifies both the permissions to use and the
10001type of node to be created, being combined (bitwise OR) with one of
10002S_IFREG, S_IFCHR, S_IFBLK, and S_IFIFO. If S_IFCHR or S_IFBLK is set on mode,
10003device defines the newly created device special file (probably using
10004os.makedev()). Otherwise device is ignored.
10005
10006If dir_fd is not None, it should be a file descriptor open to a directory,
10007 and path should be relative; path will then be relative to that directory.
10008dir_fd may not be implemented on your platform.
10009 If it is unavailable, using it will raise a NotImplementedError.
10010[clinic start generated code]*/
10011
Larry Hastings2f936352014-08-05 14:04:04 +100010012static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010013os_mknod_impl(PyObject *module, path_t *path, int mode, dev_t device,
Larry Hastings89964c42015-04-14 18:07:59 -040010014 int dir_fd)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010015/*[clinic end generated code: output=92e55d3ca8917461 input=ee44531551a4d83b]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010016{
10017 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010018 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +100010019
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010020 do {
10021 Py_BEGIN_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +100010022#ifdef HAVE_MKNODAT
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010023 if (dir_fd != DEFAULT_DIR_FD)
10024 result = mknodat(dir_fd, path->narrow, mode, device);
10025 else
Larry Hastings2f936352014-08-05 14:04:04 +100010026#endif
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010027 result = mknod(path->narrow, mode, device);
10028 Py_END_ALLOW_THREADS
10029 } while (result != 0 && errno == EINTR &&
10030 !(async_err = PyErr_CheckSignals()));
10031 if (result != 0)
10032 return (!async_err) ? posix_error() : NULL;
Larry Hastings2f936352014-08-05 14:04:04 +100010033
10034 Py_RETURN_NONE;
10035}
10036#endif /* defined(HAVE_MKNOD) && defined(HAVE_MAKEDEV) */
10037
10038
10039#ifdef HAVE_DEVICE_MACROS
10040/*[clinic input]
10041os.major -> unsigned_int
10042
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +020010043 device: dev_t
Larry Hastings2f936352014-08-05 14:04:04 +100010044 /
10045
10046Extracts a device major number from a raw device number.
10047[clinic start generated code]*/
10048
Larry Hastings2f936352014-08-05 14:04:04 +100010049static unsigned int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010050os_major_impl(PyObject *module, dev_t device)
10051/*[clinic end generated code: output=5b3b2589bafb498e input=1e16a4d30c4d4462]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010052{
10053 return major(device);
10054}
10055
10056
10057/*[clinic input]
10058os.minor -> unsigned_int
10059
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +020010060 device: dev_t
Larry Hastings2f936352014-08-05 14:04:04 +100010061 /
10062
10063Extracts a device minor number from a raw device number.
10064[clinic start generated code]*/
10065
Larry Hastings2f936352014-08-05 14:04:04 +100010066static unsigned int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010067os_minor_impl(PyObject *module, dev_t device)
10068/*[clinic end generated code: output=5e1a25e630b0157d input=0842c6d23f24c65e]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010069{
10070 return minor(device);
10071}
10072
10073
10074/*[clinic input]
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +020010075os.makedev -> dev_t
Larry Hastings2f936352014-08-05 14:04:04 +100010076
10077 major: int
10078 minor: int
10079 /
10080
10081Composes a raw device number from the major and minor device numbers.
10082[clinic start generated code]*/
10083
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +020010084static dev_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010085os_makedev_impl(PyObject *module, int major, int minor)
10086/*[clinic end generated code: output=881aaa4aba6f6a52 input=4b9fd8fc73cbe48f]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010087{
10088 return makedev(major, minor);
10089}
10090#endif /* HAVE_DEVICE_MACROS */
10091
10092
Steve Dowerfe0a41a2015-03-20 19:50:46 -070010093#if defined HAVE_FTRUNCATE || defined MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +100010094/*[clinic input]
10095os.ftruncate
10096
10097 fd: int
10098 length: Py_off_t
10099 /
10100
10101Truncate a file, specified by file descriptor, to a specific length.
10102[clinic start generated code]*/
10103
Larry Hastings2f936352014-08-05 14:04:04 +100010104static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010105os_ftruncate_impl(PyObject *module, int fd, Py_off_t length)
10106/*[clinic end generated code: output=fba15523721be7e4 input=63b43641e52818f2]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010107{
10108 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010109 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +100010110
Steve Dowerb82e17e2019-05-23 08:45:22 -070010111 if (PySys_Audit("os.truncate", "in", fd, length) < 0) {
10112 return NULL;
10113 }
10114
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010115 do {
10116 Py_BEGIN_ALLOW_THREADS
Steve Dowera1c7e722015-04-12 00:26:43 -040010117 _Py_BEGIN_SUPPRESS_IPH
Steve Dowerfe0a41a2015-03-20 19:50:46 -070010118#ifdef MS_WINDOWS
10119 result = _chsize_s(fd, length);
10120#else
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010121 result = ftruncate(fd, length);
Steve Dowerfe0a41a2015-03-20 19:50:46 -070010122#endif
Steve Dowera1c7e722015-04-12 00:26:43 -040010123 _Py_END_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010124 Py_END_ALLOW_THREADS
10125 } while (result != 0 && errno == EINTR &&
10126 !(async_err = PyErr_CheckSignals()));
10127 if (result != 0)
10128 return (!async_err) ? posix_error() : NULL;
Larry Hastings2f936352014-08-05 14:04:04 +100010129 Py_RETURN_NONE;
10130}
Steve Dowerfe0a41a2015-03-20 19:50:46 -070010131#endif /* HAVE_FTRUNCATE || MS_WINDOWS */
Larry Hastings2f936352014-08-05 14:04:04 +100010132
10133
Steve Dowerfe0a41a2015-03-20 19:50:46 -070010134#if defined HAVE_TRUNCATE || defined MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +100010135/*[clinic input]
10136os.truncate
10137 path: path_t(allow_fd='PATH_HAVE_FTRUNCATE')
10138 length: Py_off_t
10139
10140Truncate a file, specified by path, to a specific length.
10141
10142On some platforms, path may also be specified as an open file descriptor.
10143 If this functionality is unavailable, using it raises an exception.
10144[clinic start generated code]*/
10145
Larry Hastings2f936352014-08-05 14:04:04 +100010146static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010147os_truncate_impl(PyObject *module, path_t *path, Py_off_t length)
10148/*[clinic end generated code: output=43009c8df5c0a12b input=77229cf0b50a9b77]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010149{
10150 int result;
Steve Dowerfe0a41a2015-03-20 19:50:46 -070010151#ifdef MS_WINDOWS
10152 int fd;
10153#endif
10154
10155 if (path->fd != -1)
10156 return os_ftruncate_impl(module, path->fd, length);
Larry Hastings2f936352014-08-05 14:04:04 +100010157
Steve Dowerb82e17e2019-05-23 08:45:22 -070010158 if (PySys_Audit("os.truncate", "On", path->object, length) < 0) {
10159 return NULL;
10160 }
10161
Larry Hastings2f936352014-08-05 14:04:04 +100010162 Py_BEGIN_ALLOW_THREADS
Steve Dowera1c7e722015-04-12 00:26:43 -040010163 _Py_BEGIN_SUPPRESS_IPH
Steve Dowerfe0a41a2015-03-20 19:50:46 -070010164#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -070010165 fd = _wopen(path->wide, _O_WRONLY | _O_BINARY | _O_NOINHERIT);
Victor Stinnercc0bbbc2015-04-25 00:21:52 +020010166 if (fd < 0)
Steve Dowerfe0a41a2015-03-20 19:50:46 -070010167 result = -1;
10168 else {
10169 result = _chsize_s(fd, length);
10170 close(fd);
10171 if (result < 0)
10172 errno = result;
10173 }
10174#else
10175 result = truncate(path->narrow, length);
Larry Hastings2f936352014-08-05 14:04:04 +100010176#endif
Steve Dowera1c7e722015-04-12 00:26:43 -040010177 _Py_END_SUPPRESS_IPH
Larry Hastings2f936352014-08-05 14:04:04 +100010178 Py_END_ALLOW_THREADS
10179 if (result < 0)
Alexey Izbyshev83460312018-10-20 03:28:22 +030010180 return posix_path_error(path);
Larry Hastings2f936352014-08-05 14:04:04 +100010181
10182 Py_RETURN_NONE;
10183}
Steve Dowerfe0a41a2015-03-20 19:50:46 -070010184#endif /* HAVE_TRUNCATE || MS_WINDOWS */
Larry Hastings2f936352014-08-05 14:04:04 +100010185
Ross Lagerwall7807c352011-03-17 20:20:30 +020010186
Victor Stinnerd6b17692014-09-30 12:20:05 +020010187/* Issue #22396: On 32-bit AIX platform, the prototypes of os.posix_fadvise()
10188 and os.posix_fallocate() in system headers are wrong if _LARGE_FILES is
10189 defined, which is the case in Python on AIX. AIX bug report:
10190 http://www-01.ibm.com/support/docview.wss?uid=isg1IV56170 */
10191#if defined(_AIX) && defined(_LARGE_FILES) && !defined(__64BIT__)
10192# define POSIX_FADVISE_AIX_BUG
10193#endif
10194
Victor Stinnerec39e262014-09-30 12:35:58 +020010195
Victor Stinnerd6b17692014-09-30 12:20:05 +020010196#if defined(HAVE_POSIX_FALLOCATE) && !defined(POSIX_FADVISE_AIX_BUG)
Larry Hastings2f936352014-08-05 14:04:04 +100010197/*[clinic input]
10198os.posix_fallocate
10199
10200 fd: int
10201 offset: Py_off_t
10202 length: Py_off_t
10203 /
10204
10205Ensure a file has allocated at least a particular number of bytes on disk.
10206
10207Ensure that the file specified by fd encompasses a range of bytes
10208starting at offset bytes from the beginning and continuing for length bytes.
10209[clinic start generated code]*/
10210
Larry Hastings2f936352014-08-05 14:04:04 +100010211static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010212os_posix_fallocate_impl(PyObject *module, int fd, Py_off_t offset,
Larry Hastings89964c42015-04-14 18:07:59 -040010213 Py_off_t length)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010214/*[clinic end generated code: output=73f107139564aa9d input=d7a2ef0ab2ca52fb]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010215{
10216 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010217 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +020010218
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010219 do {
10220 Py_BEGIN_ALLOW_THREADS
10221 result = posix_fallocate(fd, offset, length);
10222 Py_END_ALLOW_THREADS
Коренберг Маркd4b93e22017-08-14 18:55:16 +050010223 } while (result == EINTR && !(async_err = PyErr_CheckSignals()));
10224
10225 if (result == 0)
10226 Py_RETURN_NONE;
10227
10228 if (async_err)
10229 return NULL;
10230
10231 errno = result;
10232 return posix_error();
Ross Lagerwall7807c352011-03-17 20:20:30 +020010233}
Victor Stinnerec39e262014-09-30 12:35:58 +020010234#endif /* HAVE_POSIX_FALLOCATE) && !POSIX_FADVISE_AIX_BUG */
Larry Hastings2f936352014-08-05 14:04:04 +100010235
Ross Lagerwall7807c352011-03-17 20:20:30 +020010236
Victor Stinnerd6b17692014-09-30 12:20:05 +020010237#if defined(HAVE_POSIX_FADVISE) && !defined(POSIX_FADVISE_AIX_BUG)
Larry Hastings2f936352014-08-05 14:04:04 +100010238/*[clinic input]
10239os.posix_fadvise
10240
10241 fd: int
10242 offset: Py_off_t
10243 length: Py_off_t
10244 advice: int
10245 /
10246
10247Announce an intention to access data in a specific pattern.
10248
10249Announce an intention to access data in a specific pattern, thus allowing
10250the kernel to make optimizations.
10251The advice applies to the region of the file specified by fd starting at
10252offset and continuing for length bytes.
10253advice is one of POSIX_FADV_NORMAL, POSIX_FADV_SEQUENTIAL,
10254POSIX_FADV_RANDOM, POSIX_FADV_NOREUSE, POSIX_FADV_WILLNEED, or
10255POSIX_FADV_DONTNEED.
10256[clinic start generated code]*/
10257
Larry Hastings2f936352014-08-05 14:04:04 +100010258static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010259os_posix_fadvise_impl(PyObject *module, int fd, Py_off_t offset,
Larry Hastings89964c42015-04-14 18:07:59 -040010260 Py_off_t length, int advice)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010261/*[clinic end generated code: output=412ef4aa70c98642 input=0fbe554edc2f04b5]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010262{
10263 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010264 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +020010265
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010266 do {
10267 Py_BEGIN_ALLOW_THREADS
10268 result = posix_fadvise(fd, offset, length, advice);
10269 Py_END_ALLOW_THREADS
Коренберг Маркd4b93e22017-08-14 18:55:16 +050010270 } while (result == EINTR && !(async_err = PyErr_CheckSignals()));
10271
10272 if (result == 0)
10273 Py_RETURN_NONE;
10274
10275 if (async_err)
10276 return NULL;
10277
10278 errno = result;
10279 return posix_error();
Ross Lagerwall7807c352011-03-17 20:20:30 +020010280}
Victor Stinnerec39e262014-09-30 12:35:58 +020010281#endif /* HAVE_POSIX_FADVISE && !POSIX_FADVISE_AIX_BUG */
Ross Lagerwall7807c352011-03-17 20:20:30 +020010282
Guido van Rossumec4f4ac1997-06-02 22:20:51 +000010283
Thomas Hellerf78f12a2007-11-08 19:33:05 +000010284#ifdef MS_WINDOWS
Victor Stinner161e7b32020-01-24 11:53:44 +010010285static PyObject*
10286win32_putenv(PyObject *name, PyObject *value)
10287{
10288 /* Search from index 1 because on Windows starting '=' is allowed for
10289 defining hidden environment variables. */
10290 if (PyUnicode_GET_LENGTH(name) == 0 ||
10291 PyUnicode_FindChar(name, '=', 1, PyUnicode_GET_LENGTH(name), 1) != -1)
10292 {
10293 PyErr_SetString(PyExc_ValueError, "illegal environment variable name");
10294 return NULL;
10295 }
10296 PyObject *unicode;
10297 if (value != NULL) {
10298 unicode = PyUnicode_FromFormat("%U=%U", name, value);
10299 }
10300 else {
10301 unicode = PyUnicode_FromFormat("%U=", name);
10302 }
10303 if (unicode == NULL) {
10304 return NULL;
10305 }
10306
10307 Py_ssize_t size;
10308 /* PyUnicode_AsWideCharString() rejects embedded null characters */
10309 wchar_t *env = PyUnicode_AsWideCharString(unicode, &size);
10310 Py_DECREF(unicode);
10311
10312 if (env == NULL) {
10313 return NULL;
10314 }
10315 if (size > _MAX_ENV) {
10316 PyErr_Format(PyExc_ValueError,
10317 "the environment variable is longer than %u characters",
10318 _MAX_ENV);
10319 PyMem_Free(env);
10320 return NULL;
10321 }
10322
10323 /* _wputenv() and SetEnvironmentVariableW() update the environment in the
10324 Process Environment Block (PEB). _wputenv() also updates CRT 'environ'
10325 and '_wenviron' variables, whereas SetEnvironmentVariableW() does not.
10326
10327 Prefer _wputenv() to be compatible with C libraries using CRT
10328 variables and CRT functions using these variables (ex: getenv()). */
10329 int err = _wputenv(env);
10330 PyMem_Free(env);
10331
10332 if (err) {
10333 posix_error();
10334 return NULL;
10335 }
10336
10337 Py_RETURN_NONE;
10338}
10339#endif
10340
10341
10342#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +100010343/*[clinic input]
10344os.putenv
10345
10346 name: unicode
10347 value: unicode
10348 /
10349
10350Change or add an environment variable.
10351[clinic start generated code]*/
10352
Larry Hastings2f936352014-08-05 14:04:04 +100010353static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010354os_putenv_impl(PyObject *module, PyObject *name, PyObject *value)
10355/*[clinic end generated code: output=d29a567d6b2327d2 input=ba586581c2e6105f]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010356{
Saiyang Gou7514f4f2020-02-12 23:47:42 -080010357 if (PySys_Audit("os.putenv", "OO", name, value) < 0) {
10358 return NULL;
10359 }
Victor Stinner161e7b32020-01-24 11:53:44 +010010360 return win32_putenv(name, value);
Guido van Rossumf1af3fe1996-07-23 19:18:10 +000010361}
Victor Stinnerb8d12622020-01-24 14:05:48 +010010362#else
Larry Hastings2f936352014-08-05 14:04:04 +100010363/*[clinic input]
10364os.putenv
Guido van Rossumb6a47161997-09-15 22:54:34 +000010365
Larry Hastings2f936352014-08-05 14:04:04 +100010366 name: FSConverter
10367 value: FSConverter
10368 /
10369
10370Change or add an environment variable.
10371[clinic start generated code]*/
10372
Larry Hastings2f936352014-08-05 14:04:04 +100010373static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010374os_putenv_impl(PyObject *module, PyObject *name, PyObject *value)
10375/*[clinic end generated code: output=d29a567d6b2327d2 input=a97bc6152f688d31]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010376{
Serhiy Storchaka77703942017-06-25 07:33:01 +030010377 const char *name_string = PyBytes_AS_STRING(name);
10378 const char *value_string = PyBytes_AS_STRING(value);
Larry Hastings2f936352014-08-05 14:04:04 +100010379
Serhiy Storchaka77703942017-06-25 07:33:01 +030010380 if (strchr(name_string, '=') != NULL) {
10381 PyErr_SetString(PyExc_ValueError, "illegal environment variable name");
10382 return NULL;
10383 }
Victor Stinnerb477d192020-01-22 22:48:16 +010010384
Saiyang Gou7514f4f2020-02-12 23:47:42 -080010385 if (PySys_Audit("os.putenv", "OO", name, value) < 0) {
10386 return NULL;
10387 }
10388
Victor Stinnerb477d192020-01-22 22:48:16 +010010389 if (setenv(name_string, value_string, 1)) {
10390 return posix_error();
10391 }
Larry Hastings2f936352014-08-05 14:04:04 +100010392 Py_RETURN_NONE;
10393}
Victor Stinnerb8d12622020-01-24 14:05:48 +010010394#endif /* !defined(MS_WINDOWS) */
Larry Hastings2f936352014-08-05 14:04:04 +100010395
10396
Victor Stinner161e7b32020-01-24 11:53:44 +010010397#ifdef MS_WINDOWS
10398/*[clinic input]
10399os.unsetenv
10400 name: unicode
10401 /
10402
10403Delete an environment variable.
10404[clinic start generated code]*/
10405
10406static PyObject *
10407os_unsetenv_impl(PyObject *module, PyObject *name)
10408/*[clinic end generated code: output=54c4137ab1834f02 input=4d6a1747cc526d2f]*/
10409{
Saiyang Gou7514f4f2020-02-12 23:47:42 -080010410 if (PySys_Audit("os.unsetenv", "(O)", name) < 0) {
10411 return NULL;
10412 }
Victor Stinner161e7b32020-01-24 11:53:44 +010010413 return win32_putenv(name, NULL);
10414}
Victor Stinnerb8d12622020-01-24 14:05:48 +010010415#else
Larry Hastings2f936352014-08-05 14:04:04 +100010416/*[clinic input]
10417os.unsetenv
10418 name: FSConverter
10419 /
10420
10421Delete an environment variable.
10422[clinic start generated code]*/
10423
Larry Hastings2f936352014-08-05 14:04:04 +100010424static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010425os_unsetenv_impl(PyObject *module, PyObject *name)
10426/*[clinic end generated code: output=54c4137ab1834f02 input=2bb5288a599c7107]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010427{
Saiyang Gou7514f4f2020-02-12 23:47:42 -080010428 if (PySys_Audit("os.unsetenv", "(O)", name) < 0) {
10429 return NULL;
10430 }
Victor Stinner984890f2011-11-24 13:53:38 +010010431#ifdef HAVE_BROKEN_UNSETENV
10432 unsetenv(PyBytes_AS_STRING(name));
10433#else
Victor Stinner161e7b32020-01-24 11:53:44 +010010434 int err = unsetenv(PyBytes_AS_STRING(name));
10435 if (err) {
Victor Stinner60b385e2011-11-22 22:01:28 +010010436 return posix_error();
Victor Stinner161e7b32020-01-24 11:53:44 +010010437 }
Victor Stinner984890f2011-11-24 13:53:38 +010010438#endif
Guido van Rossumc524d952001-10-19 01:31:59 +000010439
Victor Stinner84ae1182010-05-06 22:05:07 +000010440 Py_RETURN_NONE;
Guido van Rossumc524d952001-10-19 01:31:59 +000010441}
Victor Stinnerb8d12622020-01-24 14:05:48 +010010442#endif /* !MS_WINDOWS */
Guido van Rossumc524d952001-10-19 01:31:59 +000010443
Larry Hastings2f936352014-08-05 14:04:04 +100010444
10445/*[clinic input]
10446os.strerror
10447
10448 code: int
10449 /
10450
10451Translate an error code to a message string.
10452[clinic start generated code]*/
10453
Larry Hastings2f936352014-08-05 14:04:04 +100010454static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010455os_strerror_impl(PyObject *module, int code)
10456/*[clinic end generated code: output=baebf09fa02a78f2 input=75a8673d97915a91]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010457{
10458 char *message = strerror(code);
Victor Stinner8c62be82010-05-06 00:08:46 +000010459 if (message == NULL) {
10460 PyErr_SetString(PyExc_ValueError,
10461 "strerror() argument out of range");
10462 return NULL;
10463 }
Victor Stinner1b579672011-12-17 05:47:23 +010010464 return PyUnicode_DecodeLocale(message, "surrogateescape");
Guido van Rossumb6a47161997-09-15 22:54:34 +000010465}
Guido van Rossumb6a47161997-09-15 22:54:34 +000010466
Guido van Rossumf1af3fe1996-07-23 19:18:10 +000010467
Guido van Rossumc9641791998-08-04 15:26:23 +000010468#ifdef HAVE_SYS_WAIT_H
Fred Drake106c1a02002-04-23 15:58:02 +000010469#ifdef WCOREDUMP
Larry Hastings2f936352014-08-05 14:04:04 +100010470/*[clinic input]
10471os.WCOREDUMP -> bool
10472
10473 status: int
10474 /
10475
10476Return True if the process returning status was dumped to a core file.
10477[clinic start generated code]*/
10478
Larry Hastings2f936352014-08-05 14:04:04 +100010479static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010480os_WCOREDUMP_impl(PyObject *module, int status)
10481/*[clinic end generated code: output=1a584b147b16bd18 input=8b05e7ab38528d04]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010482{
10483 WAIT_TYPE wait_status;
10484 WAIT_STATUS_INT(wait_status) = status;
10485 return WCOREDUMP(wait_status);
Fred Drake106c1a02002-04-23 15:58:02 +000010486}
10487#endif /* WCOREDUMP */
10488
Larry Hastings2f936352014-08-05 14:04:04 +100010489
Fred Drake106c1a02002-04-23 15:58:02 +000010490#ifdef WIFCONTINUED
Larry Hastings2f936352014-08-05 14:04:04 +100010491/*[clinic input]
10492os.WIFCONTINUED -> bool
10493
10494 status: int
10495
10496Return True if a particular process was continued from a job control stop.
10497
10498Return True if the process returning status was continued from a
10499job control stop.
10500[clinic start generated code]*/
10501
Larry Hastings2f936352014-08-05 14:04:04 +100010502static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010503os_WIFCONTINUED_impl(PyObject *module, int status)
10504/*[clinic end generated code: output=1e35295d844364bd input=e777e7d38eb25bd9]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010505{
10506 WAIT_TYPE wait_status;
10507 WAIT_STATUS_INT(wait_status) = status;
10508 return WIFCONTINUED(wait_status);
Fred Drake106c1a02002-04-23 15:58:02 +000010509}
10510#endif /* WIFCONTINUED */
10511
Larry Hastings2f936352014-08-05 14:04:04 +100010512
Guido van Rossumc9641791998-08-04 15:26:23 +000010513#ifdef WIFSTOPPED
Larry Hastings2f936352014-08-05 14:04:04 +100010514/*[clinic input]
10515os.WIFSTOPPED -> bool
10516
10517 status: int
10518
10519Return True if the process returning status was stopped.
10520[clinic start generated code]*/
10521
Larry Hastings2f936352014-08-05 14:04:04 +100010522static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010523os_WIFSTOPPED_impl(PyObject *module, int status)
10524/*[clinic end generated code: output=fdb57122a5c9b4cb input=043cb7f1289ef904]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010525{
10526 WAIT_TYPE wait_status;
10527 WAIT_STATUS_INT(wait_status) = status;
10528 return WIFSTOPPED(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +000010529}
10530#endif /* WIFSTOPPED */
10531
Larry Hastings2f936352014-08-05 14:04:04 +100010532
Guido van Rossumc9641791998-08-04 15:26:23 +000010533#ifdef WIFSIGNALED
Larry Hastings2f936352014-08-05 14:04:04 +100010534/*[clinic input]
10535os.WIFSIGNALED -> bool
10536
10537 status: int
10538
10539Return True if the process returning status was terminated by a signal.
10540[clinic start generated code]*/
10541
Larry Hastings2f936352014-08-05 14:04:04 +100010542static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010543os_WIFSIGNALED_impl(PyObject *module, int status)
10544/*[clinic end generated code: output=d1dde4dcc819a5f5 input=d55ba7cc9ce5dc43]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010545{
10546 WAIT_TYPE wait_status;
10547 WAIT_STATUS_INT(wait_status) = status;
10548 return WIFSIGNALED(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +000010549}
10550#endif /* WIFSIGNALED */
10551
Larry Hastings2f936352014-08-05 14:04:04 +100010552
Guido van Rossumc9641791998-08-04 15:26:23 +000010553#ifdef WIFEXITED
Larry Hastings2f936352014-08-05 14:04:04 +100010554/*[clinic input]
10555os.WIFEXITED -> bool
10556
10557 status: int
10558
10559Return True if the process returning status exited via the exit() system call.
10560[clinic start generated code]*/
10561
Larry Hastings2f936352014-08-05 14:04:04 +100010562static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010563os_WIFEXITED_impl(PyObject *module, int status)
10564/*[clinic end generated code: output=01c09d6ebfeea397 input=d63775a6791586c0]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010565{
10566 WAIT_TYPE wait_status;
10567 WAIT_STATUS_INT(wait_status) = status;
10568 return WIFEXITED(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +000010569}
10570#endif /* WIFEXITED */
10571
Larry Hastings2f936352014-08-05 14:04:04 +100010572
Guido van Rossum54ecc3d1999-01-27 17:53:11 +000010573#ifdef WEXITSTATUS
Larry Hastings2f936352014-08-05 14:04:04 +100010574/*[clinic input]
10575os.WEXITSTATUS -> int
10576
10577 status: int
10578
10579Return the process return code from status.
10580[clinic start generated code]*/
10581
Larry Hastings2f936352014-08-05 14:04:04 +100010582static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010583os_WEXITSTATUS_impl(PyObject *module, int status)
10584/*[clinic end generated code: output=6e3efbba11f6488d input=e1fb4944e377585b]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010585{
10586 WAIT_TYPE wait_status;
10587 WAIT_STATUS_INT(wait_status) = status;
10588 return WEXITSTATUS(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +000010589}
10590#endif /* WEXITSTATUS */
10591
Larry Hastings2f936352014-08-05 14:04:04 +100010592
Guido van Rossumc9641791998-08-04 15:26:23 +000010593#ifdef WTERMSIG
Larry Hastings2f936352014-08-05 14:04:04 +100010594/*[clinic input]
10595os.WTERMSIG -> int
10596
10597 status: int
10598
10599Return the signal that terminated the process that provided the status value.
10600[clinic start generated code]*/
10601
Larry Hastings2f936352014-08-05 14:04:04 +100010602static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010603os_WTERMSIG_impl(PyObject *module, int status)
10604/*[clinic end generated code: output=172f7dfc8dcfc3ad input=727fd7f84ec3f243]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010605{
10606 WAIT_TYPE wait_status;
10607 WAIT_STATUS_INT(wait_status) = status;
10608 return WTERMSIG(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +000010609}
10610#endif /* WTERMSIG */
10611
Larry Hastings2f936352014-08-05 14:04:04 +100010612
Guido van Rossumc9641791998-08-04 15:26:23 +000010613#ifdef WSTOPSIG
Larry Hastings2f936352014-08-05 14:04:04 +100010614/*[clinic input]
10615os.WSTOPSIG -> int
10616
10617 status: int
10618
10619Return the signal that stopped the process that provided the status value.
10620[clinic start generated code]*/
10621
Larry Hastings2f936352014-08-05 14:04:04 +100010622static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010623os_WSTOPSIG_impl(PyObject *module, int status)
10624/*[clinic end generated code: output=0ab7586396f5d82b input=46ebf1d1b293c5c1]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010625{
10626 WAIT_TYPE wait_status;
10627 WAIT_STATUS_INT(wait_status) = status;
10628 return WSTOPSIG(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +000010629}
10630#endif /* WSTOPSIG */
Guido van Rossumc9641791998-08-04 15:26:23 +000010631#endif /* HAVE_SYS_WAIT_H */
10632
10633
Thomas Wouters477c8d52006-05-27 19:21:47 +000010634#if defined(HAVE_FSTATVFS) && defined(HAVE_SYS_STATVFS_H)
Guido van Rossumd5753e11999-10-19 13:29:23 +000010635#ifdef _SCO_DS
10636/* SCO OpenServer 5.0 and later requires _SVID3 before it reveals the
10637 needed definitions in sys/statvfs.h */
10638#define _SVID3
10639#endif
Guido van Rossum94f6f721999-01-06 18:42:14 +000010640#include <sys/statvfs.h>
10641
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010642static PyObject*
Victor Stinner1c2fa782020-05-10 11:05:29 +020010643_pystatvfs_fromstructstatvfs(PyObject *module, struct statvfs st) {
10644 PyObject *StatVFSResultType = get_posix_state(module)->StatVFSResultType;
Eddie Elizondob3966632019-11-05 07:16:14 -080010645 PyObject *v = PyStructSequence_New((PyTypeObject *)StatVFSResultType);
Victor Stinner8c62be82010-05-06 00:08:46 +000010646 if (v == NULL)
10647 return NULL;
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010648
10649#if !defined(HAVE_LARGEFILE_SUPPORT)
Victor Stinner8c62be82010-05-06 00:08:46 +000010650 PyStructSequence_SET_ITEM(v, 0, PyLong_FromLong((long) st.f_bsize));
10651 PyStructSequence_SET_ITEM(v, 1, PyLong_FromLong((long) st.f_frsize));
10652 PyStructSequence_SET_ITEM(v, 2, PyLong_FromLong((long) st.f_blocks));
10653 PyStructSequence_SET_ITEM(v, 3, PyLong_FromLong((long) st.f_bfree));
10654 PyStructSequence_SET_ITEM(v, 4, PyLong_FromLong((long) st.f_bavail));
10655 PyStructSequence_SET_ITEM(v, 5, PyLong_FromLong((long) st.f_files));
10656 PyStructSequence_SET_ITEM(v, 6, PyLong_FromLong((long) st.f_ffree));
10657 PyStructSequence_SET_ITEM(v, 7, PyLong_FromLong((long) st.f_favail));
10658 PyStructSequence_SET_ITEM(v, 8, PyLong_FromLong((long) st.f_flag));
10659 PyStructSequence_SET_ITEM(v, 9, PyLong_FromLong((long) st.f_namemax));
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010660#else
Victor Stinner8c62be82010-05-06 00:08:46 +000010661 PyStructSequence_SET_ITEM(v, 0, PyLong_FromLong((long) st.f_bsize));
10662 PyStructSequence_SET_ITEM(v, 1, PyLong_FromLong((long) st.f_frsize));
10663 PyStructSequence_SET_ITEM(v, 2,
Benjamin Petersonaf580df2016-09-06 10:46:49 -070010664 PyLong_FromLongLong((long long) st.f_blocks));
Victor Stinner8c62be82010-05-06 00:08:46 +000010665 PyStructSequence_SET_ITEM(v, 3,
Benjamin Petersonaf580df2016-09-06 10:46:49 -070010666 PyLong_FromLongLong((long long) st.f_bfree));
Victor Stinner8c62be82010-05-06 00:08:46 +000010667 PyStructSequence_SET_ITEM(v, 4,
Benjamin Petersonaf580df2016-09-06 10:46:49 -070010668 PyLong_FromLongLong((long long) st.f_bavail));
Victor Stinner8c62be82010-05-06 00:08:46 +000010669 PyStructSequence_SET_ITEM(v, 5,
Benjamin Petersonaf580df2016-09-06 10:46:49 -070010670 PyLong_FromLongLong((long long) st.f_files));
Victor Stinner8c62be82010-05-06 00:08:46 +000010671 PyStructSequence_SET_ITEM(v, 6,
Benjamin Petersonaf580df2016-09-06 10:46:49 -070010672 PyLong_FromLongLong((long long) st.f_ffree));
Victor Stinner8c62be82010-05-06 00:08:46 +000010673 PyStructSequence_SET_ITEM(v, 7,
Benjamin Petersonaf580df2016-09-06 10:46:49 -070010674 PyLong_FromLongLong((long long) st.f_favail));
Victor Stinner8c62be82010-05-06 00:08:46 +000010675 PyStructSequence_SET_ITEM(v, 8, PyLong_FromLong((long) st.f_flag));
10676 PyStructSequence_SET_ITEM(v, 9, PyLong_FromLong((long) st.f_namemax));
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010677#endif
Michael Felt502d5512018-01-05 13:01:58 +010010678/* The _ALL_SOURCE feature test macro defines f_fsid as a structure
10679 * (issue #32390). */
10680#if defined(_AIX) && defined(_ALL_SOURCE)
10681 PyStructSequence_SET_ITEM(v, 10, PyLong_FromUnsignedLong(st.f_fsid.val[0]));
10682#else
Giuseppe Scrivano96a5e502017-12-14 23:46:46 +010010683 PyStructSequence_SET_ITEM(v, 10, PyLong_FromUnsignedLong(st.f_fsid));
Michael Felt502d5512018-01-05 13:01:58 +010010684#endif
Victor Stinnerf0a7bac2013-10-30 18:55:24 +010010685 if (PyErr_Occurred()) {
10686 Py_DECREF(v);
10687 return NULL;
10688 }
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010689
Victor Stinner8c62be82010-05-06 00:08:46 +000010690 return v;
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010691}
10692
Larry Hastings2f936352014-08-05 14:04:04 +100010693
10694/*[clinic input]
10695os.fstatvfs
10696 fd: int
10697 /
10698
10699Perform an fstatvfs system call on the given fd.
10700
10701Equivalent to statvfs(fd).
10702[clinic start generated code]*/
10703
Larry Hastings2f936352014-08-05 14:04:04 +100010704static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010705os_fstatvfs_impl(PyObject *module, int fd)
10706/*[clinic end generated code: output=53547cf0cc55e6c5 input=d8122243ac50975e]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010707{
10708 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010709 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +000010710 struct statvfs st;
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010711
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010712 do {
10713 Py_BEGIN_ALLOW_THREADS
10714 result = fstatvfs(fd, &st);
10715 Py_END_ALLOW_THREADS
10716 } while (result != 0 && errno == EINTR &&
10717 !(async_err = PyErr_CheckSignals()));
Larry Hastings2f936352014-08-05 14:04:04 +100010718 if (result != 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010719 return (!async_err) ? posix_error() : NULL;
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010720
Victor Stinner1c2fa782020-05-10 11:05:29 +020010721 return _pystatvfs_fromstructstatvfs(module, st);
Guido van Rossum94f6f721999-01-06 18:42:14 +000010722}
Larry Hastings2f936352014-08-05 14:04:04 +100010723#endif /* defined(HAVE_FSTATVFS) && defined(HAVE_SYS_STATVFS_H) */
Guido van Rossum94f6f721999-01-06 18:42:14 +000010724
10725
Thomas Wouters477c8d52006-05-27 19:21:47 +000010726#if defined(HAVE_STATVFS) && defined(HAVE_SYS_STATVFS_H)
Guido van Rossum94f6f721999-01-06 18:42:14 +000010727#include <sys/statvfs.h>
Larry Hastings2f936352014-08-05 14:04:04 +100010728/*[clinic input]
10729os.statvfs
Guido van Rossum94f6f721999-01-06 18:42:14 +000010730
Larry Hastings2f936352014-08-05 14:04:04 +100010731 path: path_t(allow_fd='PATH_HAVE_FSTATVFS')
10732
10733Perform a statvfs system call on the given path.
10734
10735path may always be specified as a string.
10736On some platforms, path may also be specified as an open file descriptor.
10737 If this functionality is unavailable, using it raises an exception.
10738[clinic start generated code]*/
10739
Larry Hastings2f936352014-08-05 14:04:04 +100010740static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010741os_statvfs_impl(PyObject *module, path_t *path)
10742/*[clinic end generated code: output=87106dd1beb8556e input=3f5c35791c669bd9]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010743{
10744 int result;
10745 struct statvfs st;
Larry Hastings9cf065c2012-06-22 16:30:09 -070010746
10747 Py_BEGIN_ALLOW_THREADS
10748#ifdef HAVE_FSTATVFS
Larry Hastings2f936352014-08-05 14:04:04 +100010749 if (path->fd != -1) {
Larry Hastings9cf065c2012-06-22 16:30:09 -070010750#ifdef __APPLE__
10751 /* handle weak-linking on Mac OS X 10.3 */
10752 if (fstatvfs == NULL) {
Larry Hastings2f936352014-08-05 14:04:04 +100010753 fd_specified("statvfs", path->fd);
10754 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070010755 }
10756#endif
Larry Hastings2f936352014-08-05 14:04:04 +100010757 result = fstatvfs(path->fd, &st);
Larry Hastings9cf065c2012-06-22 16:30:09 -070010758 }
10759 else
10760#endif
Larry Hastings2f936352014-08-05 14:04:04 +100010761 result = statvfs(path->narrow, &st);
Larry Hastings9cf065c2012-06-22 16:30:09 -070010762 Py_END_ALLOW_THREADS
10763
10764 if (result) {
Larry Hastings2f936352014-08-05 14:04:04 +100010765 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -070010766 }
10767
Victor Stinner1c2fa782020-05-10 11:05:29 +020010768 return _pystatvfs_fromstructstatvfs(module, st);
Guido van Rossum94f6f721999-01-06 18:42:14 +000010769}
Larry Hastings2f936352014-08-05 14:04:04 +100010770#endif /* defined(HAVE_STATVFS) && defined(HAVE_SYS_STATVFS_H) */
10771
Guido van Rossum94f6f721999-01-06 18:42:14 +000010772
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010773#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +100010774/*[clinic input]
10775os._getdiskusage
10776
Steve Dower23ad6d02018-02-22 10:39:10 -080010777 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +100010778
10779Return disk usage statistics about the given path as a (total, free) tuple.
10780[clinic start generated code]*/
10781
Larry Hastings2f936352014-08-05 14:04:04 +100010782static PyObject *
Steve Dower23ad6d02018-02-22 10:39:10 -080010783os__getdiskusage_impl(PyObject *module, path_t *path)
10784/*[clinic end generated code: output=3bd3991f5e5c5dfb input=6af8d1b7781cc042]*/
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010785{
10786 BOOL retval;
10787 ULARGE_INTEGER _, total, free;
Joe Pamerc8c02492018-09-25 10:57:36 -040010788 DWORD err = 0;
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010789
10790 Py_BEGIN_ALLOW_THREADS
Steve Dower23ad6d02018-02-22 10:39:10 -080010791 retval = GetDiskFreeSpaceExW(path->wide, &_, &total, &free);
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010792 Py_END_ALLOW_THREADS
Joe Pamerc8c02492018-09-25 10:57:36 -040010793 if (retval == 0) {
10794 if (GetLastError() == ERROR_DIRECTORY) {
10795 wchar_t *dir_path = NULL;
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010796
Joe Pamerc8c02492018-09-25 10:57:36 -040010797 dir_path = PyMem_New(wchar_t, path->length + 1);
10798 if (dir_path == NULL) {
10799 return PyErr_NoMemory();
10800 }
10801
10802 wcscpy_s(dir_path, path->length + 1, path->wide);
10803
10804 if (_dirnameW(dir_path) != -1) {
10805 Py_BEGIN_ALLOW_THREADS
10806 retval = GetDiskFreeSpaceExW(dir_path, &_, &total, &free);
10807 Py_END_ALLOW_THREADS
10808 }
10809 /* Record the last error in case it's modified by PyMem_Free. */
10810 err = GetLastError();
10811 PyMem_Free(dir_path);
10812 if (retval) {
10813 goto success;
10814 }
10815 }
10816 return PyErr_SetFromWindowsErr(err);
10817 }
10818
10819success:
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010820 return Py_BuildValue("(LL)", total.QuadPart, free.QuadPart);
10821}
Larry Hastings2f936352014-08-05 14:04:04 +100010822#endif /* MS_WINDOWS */
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010823
10824
Fred Drakec9680921999-12-13 16:37:25 +000010825/* This is used for fpathconf(), pathconf(), confstr() and sysconf().
10826 * It maps strings representing configuration variable names to
10827 * integer values, allowing those functions to be called with the
Thomas Wouters7e474022000-07-16 12:04:32 +000010828 * magic names instead of polluting the module's namespace with tons of
Fred Drake12c6e2d1999-12-14 21:25:03 +000010829 * rarely-used constants. There are three separate tables that use
10830 * these definitions.
Fred Drakebec628d1999-12-15 18:31:10 +000010831 *
10832 * This code is always included, even if none of the interfaces that
10833 * need it are included. The #if hackery needed to avoid it would be
10834 * sufficiently pervasive that it's not worth the loss of readability.
Fred Drakec9680921999-12-13 16:37:25 +000010835 */
10836struct constdef {
Serhiy Storchaka2d06e842015-12-25 19:53:18 +020010837 const char *name;
Serhiy Storchaka56f6e762015-09-06 21:25:30 +030010838 int value;
Fred Drakec9680921999-12-13 16:37:25 +000010839};
10840
Fred Drake12c6e2d1999-12-14 21:25:03 +000010841static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000010842conv_confname(PyObject *arg, int *valuep, struct constdef *table,
Guido van Rossum7d5baac2007-08-27 23:24:46 +000010843 size_t tablesize)
Fred Drake12c6e2d1999-12-14 21:25:03 +000010844{
Christian Heimes217cfd12007-12-02 14:31:20 +000010845 if (PyLong_Check(arg)) {
Serhiy Storchaka56f6e762015-09-06 21:25:30 +030010846 int value = _PyLong_AsInt(arg);
10847 if (value == -1 && PyErr_Occurred())
10848 return 0;
10849 *valuep = value;
Stefan Krah0e803b32010-11-26 16:16:47 +000010850 return 1;
Fred Drake12c6e2d1999-12-14 21:25:03 +000010851 }
Guido van Rossumbce56a62007-05-10 18:04:33 +000010852 else {
Stefan Krah0e803b32010-11-26 16:16:47 +000010853 /* look up the value in the table using a binary search */
10854 size_t lo = 0;
10855 size_t mid;
10856 size_t hi = tablesize;
10857 int cmp;
10858 const char *confname;
10859 if (!PyUnicode_Check(arg)) {
10860 PyErr_SetString(PyExc_TypeError,
10861 "configuration names must be strings or integers");
10862 return 0;
Victor Stinner8c62be82010-05-06 00:08:46 +000010863 }
Serhiy Storchaka06515832016-11-20 09:13:07 +020010864 confname = PyUnicode_AsUTF8(arg);
Stefan Krah0e803b32010-11-26 16:16:47 +000010865 if (confname == NULL)
10866 return 0;
10867 while (lo < hi) {
10868 mid = (lo + hi) / 2;
10869 cmp = strcmp(confname, table[mid].name);
10870 if (cmp < 0)
10871 hi = mid;
10872 else if (cmp > 0)
10873 lo = mid + 1;
10874 else {
10875 *valuep = table[mid].value;
10876 return 1;
10877 }
10878 }
10879 PyErr_SetString(PyExc_ValueError, "unrecognized configuration name");
10880 return 0;
Victor Stinner8c62be82010-05-06 00:08:46 +000010881 }
Fred Drake12c6e2d1999-12-14 21:25:03 +000010882}
10883
10884
10885#if defined(HAVE_FPATHCONF) || defined(HAVE_PATHCONF)
10886static struct constdef posix_constants_pathconf[] = {
Fred Draked86ed291999-12-15 15:34:33 +000010887#ifdef _PC_ABI_AIO_XFER_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010888 {"PC_ABI_AIO_XFER_MAX", _PC_ABI_AIO_XFER_MAX},
Fred Draked86ed291999-12-15 15:34:33 +000010889#endif
10890#ifdef _PC_ABI_ASYNC_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000010891 {"PC_ABI_ASYNC_IO", _PC_ABI_ASYNC_IO},
Fred Draked86ed291999-12-15 15:34:33 +000010892#endif
Fred Drakec9680921999-12-13 16:37:25 +000010893#ifdef _PC_ASYNC_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000010894 {"PC_ASYNC_IO", _PC_ASYNC_IO},
Fred Drakec9680921999-12-13 16:37:25 +000010895#endif
10896#ifdef _PC_CHOWN_RESTRICTED
Victor Stinner8c62be82010-05-06 00:08:46 +000010897 {"PC_CHOWN_RESTRICTED", _PC_CHOWN_RESTRICTED},
Fred Drakec9680921999-12-13 16:37:25 +000010898#endif
10899#ifdef _PC_FILESIZEBITS
Victor Stinner8c62be82010-05-06 00:08:46 +000010900 {"PC_FILESIZEBITS", _PC_FILESIZEBITS},
Fred Drakec9680921999-12-13 16:37:25 +000010901#endif
10902#ifdef _PC_LAST
Victor Stinner8c62be82010-05-06 00:08:46 +000010903 {"PC_LAST", _PC_LAST},
Fred Drakec9680921999-12-13 16:37:25 +000010904#endif
10905#ifdef _PC_LINK_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010906 {"PC_LINK_MAX", _PC_LINK_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010907#endif
10908#ifdef _PC_MAX_CANON
Victor Stinner8c62be82010-05-06 00:08:46 +000010909 {"PC_MAX_CANON", _PC_MAX_CANON},
Fred Drakec9680921999-12-13 16:37:25 +000010910#endif
10911#ifdef _PC_MAX_INPUT
Victor Stinner8c62be82010-05-06 00:08:46 +000010912 {"PC_MAX_INPUT", _PC_MAX_INPUT},
Fred Drakec9680921999-12-13 16:37:25 +000010913#endif
10914#ifdef _PC_NAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010915 {"PC_NAME_MAX", _PC_NAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010916#endif
10917#ifdef _PC_NO_TRUNC
Victor Stinner8c62be82010-05-06 00:08:46 +000010918 {"PC_NO_TRUNC", _PC_NO_TRUNC},
Fred Drakec9680921999-12-13 16:37:25 +000010919#endif
10920#ifdef _PC_PATH_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010921 {"PC_PATH_MAX", _PC_PATH_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010922#endif
10923#ifdef _PC_PIPE_BUF
Victor Stinner8c62be82010-05-06 00:08:46 +000010924 {"PC_PIPE_BUF", _PC_PIPE_BUF},
Fred Drakec9680921999-12-13 16:37:25 +000010925#endif
10926#ifdef _PC_PRIO_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000010927 {"PC_PRIO_IO", _PC_PRIO_IO},
Fred Drakec9680921999-12-13 16:37:25 +000010928#endif
10929#ifdef _PC_SOCK_MAXBUF
Victor Stinner8c62be82010-05-06 00:08:46 +000010930 {"PC_SOCK_MAXBUF", _PC_SOCK_MAXBUF},
Fred Drakec9680921999-12-13 16:37:25 +000010931#endif
10932#ifdef _PC_SYNC_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000010933 {"PC_SYNC_IO", _PC_SYNC_IO},
Fred Drakec9680921999-12-13 16:37:25 +000010934#endif
10935#ifdef _PC_VDISABLE
Victor Stinner8c62be82010-05-06 00:08:46 +000010936 {"PC_VDISABLE", _PC_VDISABLE},
Fred Drakec9680921999-12-13 16:37:25 +000010937#endif
Jesus Cea7e9065c2010-10-25 13:02:04 +000010938#ifdef _PC_ACL_ENABLED
10939 {"PC_ACL_ENABLED", _PC_ACL_ENABLED},
10940#endif
10941#ifdef _PC_MIN_HOLE_SIZE
10942 {"PC_MIN_HOLE_SIZE", _PC_MIN_HOLE_SIZE},
10943#endif
10944#ifdef _PC_ALLOC_SIZE_MIN
10945 {"PC_ALLOC_SIZE_MIN", _PC_ALLOC_SIZE_MIN},
10946#endif
10947#ifdef _PC_REC_INCR_XFER_SIZE
10948 {"PC_REC_INCR_XFER_SIZE", _PC_REC_INCR_XFER_SIZE},
10949#endif
10950#ifdef _PC_REC_MAX_XFER_SIZE
10951 {"PC_REC_MAX_XFER_SIZE", _PC_REC_MAX_XFER_SIZE},
10952#endif
10953#ifdef _PC_REC_MIN_XFER_SIZE
10954 {"PC_REC_MIN_XFER_SIZE", _PC_REC_MIN_XFER_SIZE},
10955#endif
10956#ifdef _PC_REC_XFER_ALIGN
10957 {"PC_REC_XFER_ALIGN", _PC_REC_XFER_ALIGN},
10958#endif
10959#ifdef _PC_SYMLINK_MAX
10960 {"PC_SYMLINK_MAX", _PC_SYMLINK_MAX},
10961#endif
10962#ifdef _PC_XATTR_ENABLED
10963 {"PC_XATTR_ENABLED", _PC_XATTR_ENABLED},
10964#endif
10965#ifdef _PC_XATTR_EXISTS
10966 {"PC_XATTR_EXISTS", _PC_XATTR_EXISTS},
10967#endif
10968#ifdef _PC_TIMESTAMP_RESOLUTION
10969 {"PC_TIMESTAMP_RESOLUTION", _PC_TIMESTAMP_RESOLUTION},
10970#endif
Fred Drakec9680921999-12-13 16:37:25 +000010971};
10972
Fred Drakec9680921999-12-13 16:37:25 +000010973static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000010974conv_path_confname(PyObject *arg, int *valuep)
Fred Drakec9680921999-12-13 16:37:25 +000010975{
10976 return conv_confname(arg, valuep, posix_constants_pathconf,
10977 sizeof(posix_constants_pathconf)
10978 / sizeof(struct constdef));
10979}
10980#endif
10981
Larry Hastings2f936352014-08-05 14:04:04 +100010982
Fred Drakec9680921999-12-13 16:37:25 +000010983#ifdef HAVE_FPATHCONF
Larry Hastings2f936352014-08-05 14:04:04 +100010984/*[clinic input]
10985os.fpathconf -> long
10986
10987 fd: int
10988 name: path_confname
10989 /
10990
10991Return the configuration limit name for the file descriptor fd.
10992
10993If there is no limit, return -1.
10994[clinic start generated code]*/
10995
Larry Hastings2f936352014-08-05 14:04:04 +100010996static long
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010997os_fpathconf_impl(PyObject *module, int fd, int name)
10998/*[clinic end generated code: output=d5b7042425fc3e21 input=5942a024d3777810]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010999{
11000 long limit;
11001
11002 errno = 0;
11003 limit = fpathconf(fd, name);
11004 if (limit == -1 && errno != 0)
11005 posix_error();
11006
11007 return limit;
11008}
11009#endif /* HAVE_FPATHCONF */
Fred Drakec9680921999-12-13 16:37:25 +000011010
11011
11012#ifdef HAVE_PATHCONF
Larry Hastings2f936352014-08-05 14:04:04 +100011013/*[clinic input]
11014os.pathconf -> long
11015 path: path_t(allow_fd='PATH_HAVE_FPATHCONF')
11016 name: path_confname
11017
11018Return the configuration limit name for the file or directory path.
11019
11020If there is no limit, return -1.
11021On some platforms, path may also be specified as an open file descriptor.
11022 If this functionality is unavailable, using it raises an exception.
11023[clinic start generated code]*/
11024
Larry Hastings2f936352014-08-05 14:04:04 +100011025static long
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011026os_pathconf_impl(PyObject *module, path_t *path, int name)
11027/*[clinic end generated code: output=5bedee35b293a089 input=bc3e2a985af27e5e]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011028{
Victor Stinner8c62be82010-05-06 00:08:46 +000011029 long limit;
Fred Drakec9680921999-12-13 16:37:25 +000011030
Victor Stinner8c62be82010-05-06 00:08:46 +000011031 errno = 0;
Georg Brandl306336b2012-06-24 12:55:33 +020011032#ifdef HAVE_FPATHCONF
Larry Hastings2f936352014-08-05 14:04:04 +100011033 if (path->fd != -1)
11034 limit = fpathconf(path->fd, name);
Georg Brandl306336b2012-06-24 12:55:33 +020011035 else
11036#endif
Larry Hastings2f936352014-08-05 14:04:04 +100011037 limit = pathconf(path->narrow, name);
Victor Stinner8c62be82010-05-06 00:08:46 +000011038 if (limit == -1 && errno != 0) {
11039 if (errno == EINVAL)
Stefan Krah99439262010-11-26 12:58:05 +000011040 /* could be a path or name problem */
11041 posix_error();
Fred Drakec9680921999-12-13 16:37:25 +000011042 else
Larry Hastings2f936352014-08-05 14:04:04 +100011043 path_error(path);
Victor Stinner8c62be82010-05-06 00:08:46 +000011044 }
Larry Hastings2f936352014-08-05 14:04:04 +100011045
11046 return limit;
Fred Drakec9680921999-12-13 16:37:25 +000011047}
Larry Hastings2f936352014-08-05 14:04:04 +100011048#endif /* HAVE_PATHCONF */
Fred Drakec9680921999-12-13 16:37:25 +000011049
11050#ifdef HAVE_CONFSTR
11051static struct constdef posix_constants_confstr[] = {
Fred Draked86ed291999-12-15 15:34:33 +000011052#ifdef _CS_ARCHITECTURE
Victor Stinner8c62be82010-05-06 00:08:46 +000011053 {"CS_ARCHITECTURE", _CS_ARCHITECTURE},
Fred Draked86ed291999-12-15 15:34:33 +000011054#endif
Mark Dickinson876d7c82010-04-16 12:47:52 +000011055#ifdef _CS_GNU_LIBC_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000011056 {"CS_GNU_LIBC_VERSION", _CS_GNU_LIBC_VERSION},
Mark Dickinson876d7c82010-04-16 12:47:52 +000011057#endif
11058#ifdef _CS_GNU_LIBPTHREAD_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000011059 {"CS_GNU_LIBPTHREAD_VERSION", _CS_GNU_LIBPTHREAD_VERSION},
Mark Dickinson876d7c82010-04-16 12:47:52 +000011060#endif
Fred Draked86ed291999-12-15 15:34:33 +000011061#ifdef _CS_HOSTNAME
Victor Stinner8c62be82010-05-06 00:08:46 +000011062 {"CS_HOSTNAME", _CS_HOSTNAME},
Fred Draked86ed291999-12-15 15:34:33 +000011063#endif
11064#ifdef _CS_HW_PROVIDER
Victor Stinner8c62be82010-05-06 00:08:46 +000011065 {"CS_HW_PROVIDER", _CS_HW_PROVIDER},
Fred Draked86ed291999-12-15 15:34:33 +000011066#endif
11067#ifdef _CS_HW_SERIAL
Victor Stinner8c62be82010-05-06 00:08:46 +000011068 {"CS_HW_SERIAL", _CS_HW_SERIAL},
Fred Draked86ed291999-12-15 15:34:33 +000011069#endif
11070#ifdef _CS_INITTAB_NAME
Victor Stinner8c62be82010-05-06 00:08:46 +000011071 {"CS_INITTAB_NAME", _CS_INITTAB_NAME},
Fred Draked86ed291999-12-15 15:34:33 +000011072#endif
Fred Drakec9680921999-12-13 16:37:25 +000011073#ifdef _CS_LFS64_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011074 {"CS_LFS64_CFLAGS", _CS_LFS64_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011075#endif
11076#ifdef _CS_LFS64_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011077 {"CS_LFS64_LDFLAGS", _CS_LFS64_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011078#endif
11079#ifdef _CS_LFS64_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000011080 {"CS_LFS64_LIBS", _CS_LFS64_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000011081#endif
11082#ifdef _CS_LFS64_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011083 {"CS_LFS64_LINTFLAGS", _CS_LFS64_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011084#endif
11085#ifdef _CS_LFS_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011086 {"CS_LFS_CFLAGS", _CS_LFS_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011087#endif
11088#ifdef _CS_LFS_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011089 {"CS_LFS_LDFLAGS", _CS_LFS_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011090#endif
11091#ifdef _CS_LFS_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000011092 {"CS_LFS_LIBS", _CS_LFS_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000011093#endif
11094#ifdef _CS_LFS_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011095 {"CS_LFS_LINTFLAGS", _CS_LFS_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011096#endif
Fred Draked86ed291999-12-15 15:34:33 +000011097#ifdef _CS_MACHINE
Victor Stinner8c62be82010-05-06 00:08:46 +000011098 {"CS_MACHINE", _CS_MACHINE},
Fred Draked86ed291999-12-15 15:34:33 +000011099#endif
Fred Drakec9680921999-12-13 16:37:25 +000011100#ifdef _CS_PATH
Victor Stinner8c62be82010-05-06 00:08:46 +000011101 {"CS_PATH", _CS_PATH},
Fred Drakec9680921999-12-13 16:37:25 +000011102#endif
Fred Draked86ed291999-12-15 15:34:33 +000011103#ifdef _CS_RELEASE
Victor Stinner8c62be82010-05-06 00:08:46 +000011104 {"CS_RELEASE", _CS_RELEASE},
Fred Draked86ed291999-12-15 15:34:33 +000011105#endif
11106#ifdef _CS_SRPC_DOMAIN
Victor Stinner8c62be82010-05-06 00:08:46 +000011107 {"CS_SRPC_DOMAIN", _CS_SRPC_DOMAIN},
Fred Draked86ed291999-12-15 15:34:33 +000011108#endif
11109#ifdef _CS_SYSNAME
Victor Stinner8c62be82010-05-06 00:08:46 +000011110 {"CS_SYSNAME", _CS_SYSNAME},
Fred Draked86ed291999-12-15 15:34:33 +000011111#endif
11112#ifdef _CS_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000011113 {"CS_VERSION", _CS_VERSION},
Fred Draked86ed291999-12-15 15:34:33 +000011114#endif
Fred Drakec9680921999-12-13 16:37:25 +000011115#ifdef _CS_XBS5_ILP32_OFF32_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011116 {"CS_XBS5_ILP32_OFF32_CFLAGS", _CS_XBS5_ILP32_OFF32_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011117#endif
11118#ifdef _CS_XBS5_ILP32_OFF32_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011119 {"CS_XBS5_ILP32_OFF32_LDFLAGS", _CS_XBS5_ILP32_OFF32_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011120#endif
11121#ifdef _CS_XBS5_ILP32_OFF32_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000011122 {"CS_XBS5_ILP32_OFF32_LIBS", _CS_XBS5_ILP32_OFF32_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000011123#endif
11124#ifdef _CS_XBS5_ILP32_OFF32_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011125 {"CS_XBS5_ILP32_OFF32_LINTFLAGS", _CS_XBS5_ILP32_OFF32_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011126#endif
11127#ifdef _CS_XBS5_ILP32_OFFBIG_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011128 {"CS_XBS5_ILP32_OFFBIG_CFLAGS", _CS_XBS5_ILP32_OFFBIG_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011129#endif
11130#ifdef _CS_XBS5_ILP32_OFFBIG_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011131 {"CS_XBS5_ILP32_OFFBIG_LDFLAGS", _CS_XBS5_ILP32_OFFBIG_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011132#endif
11133#ifdef _CS_XBS5_ILP32_OFFBIG_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000011134 {"CS_XBS5_ILP32_OFFBIG_LIBS", _CS_XBS5_ILP32_OFFBIG_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000011135#endif
11136#ifdef _CS_XBS5_ILP32_OFFBIG_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011137 {"CS_XBS5_ILP32_OFFBIG_LINTFLAGS", _CS_XBS5_ILP32_OFFBIG_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011138#endif
11139#ifdef _CS_XBS5_LP64_OFF64_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011140 {"CS_XBS5_LP64_OFF64_CFLAGS", _CS_XBS5_LP64_OFF64_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011141#endif
11142#ifdef _CS_XBS5_LP64_OFF64_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011143 {"CS_XBS5_LP64_OFF64_LDFLAGS", _CS_XBS5_LP64_OFF64_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011144#endif
11145#ifdef _CS_XBS5_LP64_OFF64_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000011146 {"CS_XBS5_LP64_OFF64_LIBS", _CS_XBS5_LP64_OFF64_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000011147#endif
11148#ifdef _CS_XBS5_LP64_OFF64_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011149 {"CS_XBS5_LP64_OFF64_LINTFLAGS", _CS_XBS5_LP64_OFF64_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011150#endif
11151#ifdef _CS_XBS5_LPBIG_OFFBIG_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011152 {"CS_XBS5_LPBIG_OFFBIG_CFLAGS", _CS_XBS5_LPBIG_OFFBIG_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011153#endif
11154#ifdef _CS_XBS5_LPBIG_OFFBIG_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011155 {"CS_XBS5_LPBIG_OFFBIG_LDFLAGS", _CS_XBS5_LPBIG_OFFBIG_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011156#endif
11157#ifdef _CS_XBS5_LPBIG_OFFBIG_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000011158 {"CS_XBS5_LPBIG_OFFBIG_LIBS", _CS_XBS5_LPBIG_OFFBIG_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000011159#endif
11160#ifdef _CS_XBS5_LPBIG_OFFBIG_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011161 {"CS_XBS5_LPBIG_OFFBIG_LINTFLAGS", _CS_XBS5_LPBIG_OFFBIG_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011162#endif
Fred Draked86ed291999-12-15 15:34:33 +000011163#ifdef _MIPS_CS_AVAIL_PROCESSORS
Victor Stinner8c62be82010-05-06 00:08:46 +000011164 {"MIPS_CS_AVAIL_PROCESSORS", _MIPS_CS_AVAIL_PROCESSORS},
Fred Draked86ed291999-12-15 15:34:33 +000011165#endif
11166#ifdef _MIPS_CS_BASE
Victor Stinner8c62be82010-05-06 00:08:46 +000011167 {"MIPS_CS_BASE", _MIPS_CS_BASE},
Fred Draked86ed291999-12-15 15:34:33 +000011168#endif
11169#ifdef _MIPS_CS_HOSTID
Victor Stinner8c62be82010-05-06 00:08:46 +000011170 {"MIPS_CS_HOSTID", _MIPS_CS_HOSTID},
Fred Draked86ed291999-12-15 15:34:33 +000011171#endif
11172#ifdef _MIPS_CS_HW_NAME
Victor Stinner8c62be82010-05-06 00:08:46 +000011173 {"MIPS_CS_HW_NAME", _MIPS_CS_HW_NAME},
Fred Draked86ed291999-12-15 15:34:33 +000011174#endif
11175#ifdef _MIPS_CS_NUM_PROCESSORS
Victor Stinner8c62be82010-05-06 00:08:46 +000011176 {"MIPS_CS_NUM_PROCESSORS", _MIPS_CS_NUM_PROCESSORS},
Fred Draked86ed291999-12-15 15:34:33 +000011177#endif
11178#ifdef _MIPS_CS_OSREL_MAJ
Victor Stinner8c62be82010-05-06 00:08:46 +000011179 {"MIPS_CS_OSREL_MAJ", _MIPS_CS_OSREL_MAJ},
Fred Draked86ed291999-12-15 15:34:33 +000011180#endif
11181#ifdef _MIPS_CS_OSREL_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000011182 {"MIPS_CS_OSREL_MIN", _MIPS_CS_OSREL_MIN},
Fred Draked86ed291999-12-15 15:34:33 +000011183#endif
11184#ifdef _MIPS_CS_OSREL_PATCH
Victor Stinner8c62be82010-05-06 00:08:46 +000011185 {"MIPS_CS_OSREL_PATCH", _MIPS_CS_OSREL_PATCH},
Fred Draked86ed291999-12-15 15:34:33 +000011186#endif
11187#ifdef _MIPS_CS_OS_NAME
Victor Stinner8c62be82010-05-06 00:08:46 +000011188 {"MIPS_CS_OS_NAME", _MIPS_CS_OS_NAME},
Fred Draked86ed291999-12-15 15:34:33 +000011189#endif
11190#ifdef _MIPS_CS_OS_PROVIDER
Victor Stinner8c62be82010-05-06 00:08:46 +000011191 {"MIPS_CS_OS_PROVIDER", _MIPS_CS_OS_PROVIDER},
Fred Draked86ed291999-12-15 15:34:33 +000011192#endif
11193#ifdef _MIPS_CS_PROCESSORS
Victor Stinner8c62be82010-05-06 00:08:46 +000011194 {"MIPS_CS_PROCESSORS", _MIPS_CS_PROCESSORS},
Fred Draked86ed291999-12-15 15:34:33 +000011195#endif
11196#ifdef _MIPS_CS_SERIAL
Victor Stinner8c62be82010-05-06 00:08:46 +000011197 {"MIPS_CS_SERIAL", _MIPS_CS_SERIAL},
Fred Draked86ed291999-12-15 15:34:33 +000011198#endif
11199#ifdef _MIPS_CS_VENDOR
Victor Stinner8c62be82010-05-06 00:08:46 +000011200 {"MIPS_CS_VENDOR", _MIPS_CS_VENDOR},
Fred Draked86ed291999-12-15 15:34:33 +000011201#endif
Fred Drakec9680921999-12-13 16:37:25 +000011202};
11203
11204static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000011205conv_confstr_confname(PyObject *arg, int *valuep)
Fred Drakec9680921999-12-13 16:37:25 +000011206{
11207 return conv_confname(arg, valuep, posix_constants_confstr,
11208 sizeof(posix_constants_confstr)
11209 / sizeof(struct constdef));
11210}
11211
Larry Hastings2f936352014-08-05 14:04:04 +100011212
11213/*[clinic input]
11214os.confstr
11215
11216 name: confstr_confname
11217 /
11218
11219Return a string-valued system configuration variable.
11220[clinic start generated code]*/
11221
Larry Hastings2f936352014-08-05 14:04:04 +100011222static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011223os_confstr_impl(PyObject *module, int name)
11224/*[clinic end generated code: output=bfb0b1b1e49b9383 input=18fb4d0567242e65]*/
Fred Drakec9680921999-12-13 16:37:25 +000011225{
11226 PyObject *result = NULL;
Victor Stinnercb043522010-09-10 23:49:04 +000011227 char buffer[255];
Victor Stinnerdd3a6a52013-06-25 23:13:47 +020011228 size_t len;
Fred Drakec9680921999-12-13 16:37:25 +000011229
Victor Stinnercb043522010-09-10 23:49:04 +000011230 errno = 0;
11231 len = confstr(name, buffer, sizeof(buffer));
11232 if (len == 0) {
11233 if (errno) {
11234 posix_error();
11235 return NULL;
Fred Drakec9680921999-12-13 16:37:25 +000011236 }
11237 else {
Victor Stinnercb043522010-09-10 23:49:04 +000011238 Py_RETURN_NONE;
Fred Drakec9680921999-12-13 16:37:25 +000011239 }
11240 }
Victor Stinnercb043522010-09-10 23:49:04 +000011241
Victor Stinnerdd3a6a52013-06-25 23:13:47 +020011242 if (len >= sizeof(buffer)) {
Victor Stinnercbc18f32014-12-05 22:51:51 +010011243 size_t len2;
Victor Stinnercb043522010-09-10 23:49:04 +000011244 char *buf = PyMem_Malloc(len);
11245 if (buf == NULL)
11246 return PyErr_NoMemory();
Victor Stinnercbc18f32014-12-05 22:51:51 +010011247 len2 = confstr(name, buf, len);
11248 assert(len == len2);
Christian Heimes8714cfd2015-04-21 10:57:41 +020011249 result = PyUnicode_DecodeFSDefaultAndSize(buf, len2-1);
Victor Stinnercb043522010-09-10 23:49:04 +000011250 PyMem_Free(buf);
11251 }
11252 else
11253 result = PyUnicode_DecodeFSDefaultAndSize(buffer, len-1);
Fred Drakec9680921999-12-13 16:37:25 +000011254 return result;
11255}
Larry Hastings2f936352014-08-05 14:04:04 +100011256#endif /* HAVE_CONFSTR */
Fred Drakec9680921999-12-13 16:37:25 +000011257
11258
11259#ifdef HAVE_SYSCONF
11260static struct constdef posix_constants_sysconf[] = {
11261#ifdef _SC_2_CHAR_TERM
Victor Stinner8c62be82010-05-06 00:08:46 +000011262 {"SC_2_CHAR_TERM", _SC_2_CHAR_TERM},
Fred Drakec9680921999-12-13 16:37:25 +000011263#endif
11264#ifdef _SC_2_C_BIND
Victor Stinner8c62be82010-05-06 00:08:46 +000011265 {"SC_2_C_BIND", _SC_2_C_BIND},
Fred Drakec9680921999-12-13 16:37:25 +000011266#endif
11267#ifdef _SC_2_C_DEV
Victor Stinner8c62be82010-05-06 00:08:46 +000011268 {"SC_2_C_DEV", _SC_2_C_DEV},
Fred Drakec9680921999-12-13 16:37:25 +000011269#endif
11270#ifdef _SC_2_C_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000011271 {"SC_2_C_VERSION", _SC_2_C_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000011272#endif
11273#ifdef _SC_2_FORT_DEV
Victor Stinner8c62be82010-05-06 00:08:46 +000011274 {"SC_2_FORT_DEV", _SC_2_FORT_DEV},
Fred Drakec9680921999-12-13 16:37:25 +000011275#endif
11276#ifdef _SC_2_FORT_RUN
Victor Stinner8c62be82010-05-06 00:08:46 +000011277 {"SC_2_FORT_RUN", _SC_2_FORT_RUN},
Fred Drakec9680921999-12-13 16:37:25 +000011278#endif
11279#ifdef _SC_2_LOCALEDEF
Victor Stinner8c62be82010-05-06 00:08:46 +000011280 {"SC_2_LOCALEDEF", _SC_2_LOCALEDEF},
Fred Drakec9680921999-12-13 16:37:25 +000011281#endif
11282#ifdef _SC_2_SW_DEV
Victor Stinner8c62be82010-05-06 00:08:46 +000011283 {"SC_2_SW_DEV", _SC_2_SW_DEV},
Fred Drakec9680921999-12-13 16:37:25 +000011284#endif
11285#ifdef _SC_2_UPE
Victor Stinner8c62be82010-05-06 00:08:46 +000011286 {"SC_2_UPE", _SC_2_UPE},
Fred Drakec9680921999-12-13 16:37:25 +000011287#endif
11288#ifdef _SC_2_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000011289 {"SC_2_VERSION", _SC_2_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000011290#endif
Fred Draked86ed291999-12-15 15:34:33 +000011291#ifdef _SC_ABI_ASYNCHRONOUS_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000011292 {"SC_ABI_ASYNCHRONOUS_IO", _SC_ABI_ASYNCHRONOUS_IO},
Fred Draked86ed291999-12-15 15:34:33 +000011293#endif
11294#ifdef _SC_ACL
Victor Stinner8c62be82010-05-06 00:08:46 +000011295 {"SC_ACL", _SC_ACL},
Fred Draked86ed291999-12-15 15:34:33 +000011296#endif
Fred Drakec9680921999-12-13 16:37:25 +000011297#ifdef _SC_AIO_LISTIO_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011298 {"SC_AIO_LISTIO_MAX", _SC_AIO_LISTIO_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011299#endif
Fred Drakec9680921999-12-13 16:37:25 +000011300#ifdef _SC_AIO_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011301 {"SC_AIO_MAX", _SC_AIO_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011302#endif
11303#ifdef _SC_AIO_PRIO_DELTA_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011304 {"SC_AIO_PRIO_DELTA_MAX", _SC_AIO_PRIO_DELTA_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011305#endif
11306#ifdef _SC_ARG_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011307 {"SC_ARG_MAX", _SC_ARG_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011308#endif
11309#ifdef _SC_ASYNCHRONOUS_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000011310 {"SC_ASYNCHRONOUS_IO", _SC_ASYNCHRONOUS_IO},
Fred Drakec9680921999-12-13 16:37:25 +000011311#endif
11312#ifdef _SC_ATEXIT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011313 {"SC_ATEXIT_MAX", _SC_ATEXIT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011314#endif
Fred Draked86ed291999-12-15 15:34:33 +000011315#ifdef _SC_AUDIT
Victor Stinner8c62be82010-05-06 00:08:46 +000011316 {"SC_AUDIT", _SC_AUDIT},
Fred Draked86ed291999-12-15 15:34:33 +000011317#endif
Fred Drakec9680921999-12-13 16:37:25 +000011318#ifdef _SC_AVPHYS_PAGES
Victor Stinner8c62be82010-05-06 00:08:46 +000011319 {"SC_AVPHYS_PAGES", _SC_AVPHYS_PAGES},
Fred Drakec9680921999-12-13 16:37:25 +000011320#endif
11321#ifdef _SC_BC_BASE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011322 {"SC_BC_BASE_MAX", _SC_BC_BASE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011323#endif
11324#ifdef _SC_BC_DIM_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011325 {"SC_BC_DIM_MAX", _SC_BC_DIM_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011326#endif
11327#ifdef _SC_BC_SCALE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011328 {"SC_BC_SCALE_MAX", _SC_BC_SCALE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011329#endif
11330#ifdef _SC_BC_STRING_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011331 {"SC_BC_STRING_MAX", _SC_BC_STRING_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011332#endif
Fred Draked86ed291999-12-15 15:34:33 +000011333#ifdef _SC_CAP
Victor Stinner8c62be82010-05-06 00:08:46 +000011334 {"SC_CAP", _SC_CAP},
Fred Draked86ed291999-12-15 15:34:33 +000011335#endif
Fred Drakec9680921999-12-13 16:37:25 +000011336#ifdef _SC_CHARCLASS_NAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011337 {"SC_CHARCLASS_NAME_MAX", _SC_CHARCLASS_NAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011338#endif
11339#ifdef _SC_CHAR_BIT
Victor Stinner8c62be82010-05-06 00:08:46 +000011340 {"SC_CHAR_BIT", _SC_CHAR_BIT},
Fred Drakec9680921999-12-13 16:37:25 +000011341#endif
11342#ifdef _SC_CHAR_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011343 {"SC_CHAR_MAX", _SC_CHAR_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011344#endif
11345#ifdef _SC_CHAR_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000011346 {"SC_CHAR_MIN", _SC_CHAR_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000011347#endif
11348#ifdef _SC_CHILD_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011349 {"SC_CHILD_MAX", _SC_CHILD_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011350#endif
11351#ifdef _SC_CLK_TCK
Victor Stinner8c62be82010-05-06 00:08:46 +000011352 {"SC_CLK_TCK", _SC_CLK_TCK},
Fred Drakec9680921999-12-13 16:37:25 +000011353#endif
11354#ifdef _SC_COHER_BLKSZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011355 {"SC_COHER_BLKSZ", _SC_COHER_BLKSZ},
Fred Drakec9680921999-12-13 16:37:25 +000011356#endif
11357#ifdef _SC_COLL_WEIGHTS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011358 {"SC_COLL_WEIGHTS_MAX", _SC_COLL_WEIGHTS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011359#endif
11360#ifdef _SC_DCACHE_ASSOC
Victor Stinner8c62be82010-05-06 00:08:46 +000011361 {"SC_DCACHE_ASSOC", _SC_DCACHE_ASSOC},
Fred Drakec9680921999-12-13 16:37:25 +000011362#endif
11363#ifdef _SC_DCACHE_BLKSZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011364 {"SC_DCACHE_BLKSZ", _SC_DCACHE_BLKSZ},
Fred Drakec9680921999-12-13 16:37:25 +000011365#endif
11366#ifdef _SC_DCACHE_LINESZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011367 {"SC_DCACHE_LINESZ", _SC_DCACHE_LINESZ},
Fred Drakec9680921999-12-13 16:37:25 +000011368#endif
11369#ifdef _SC_DCACHE_SZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011370 {"SC_DCACHE_SZ", _SC_DCACHE_SZ},
Fred Drakec9680921999-12-13 16:37:25 +000011371#endif
11372#ifdef _SC_DCACHE_TBLKSZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011373 {"SC_DCACHE_TBLKSZ", _SC_DCACHE_TBLKSZ},
Fred Drakec9680921999-12-13 16:37:25 +000011374#endif
11375#ifdef _SC_DELAYTIMER_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011376 {"SC_DELAYTIMER_MAX", _SC_DELAYTIMER_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011377#endif
11378#ifdef _SC_EQUIV_CLASS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011379 {"SC_EQUIV_CLASS_MAX", _SC_EQUIV_CLASS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011380#endif
11381#ifdef _SC_EXPR_NEST_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011382 {"SC_EXPR_NEST_MAX", _SC_EXPR_NEST_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011383#endif
11384#ifdef _SC_FSYNC
Victor Stinner8c62be82010-05-06 00:08:46 +000011385 {"SC_FSYNC", _SC_FSYNC},
Fred Drakec9680921999-12-13 16:37:25 +000011386#endif
11387#ifdef _SC_GETGR_R_SIZE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011388 {"SC_GETGR_R_SIZE_MAX", _SC_GETGR_R_SIZE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011389#endif
11390#ifdef _SC_GETPW_R_SIZE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011391 {"SC_GETPW_R_SIZE_MAX", _SC_GETPW_R_SIZE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011392#endif
11393#ifdef _SC_ICACHE_ASSOC
Victor Stinner8c62be82010-05-06 00:08:46 +000011394 {"SC_ICACHE_ASSOC", _SC_ICACHE_ASSOC},
Fred Drakec9680921999-12-13 16:37:25 +000011395#endif
11396#ifdef _SC_ICACHE_BLKSZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011397 {"SC_ICACHE_BLKSZ", _SC_ICACHE_BLKSZ},
Fred Drakec9680921999-12-13 16:37:25 +000011398#endif
11399#ifdef _SC_ICACHE_LINESZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011400 {"SC_ICACHE_LINESZ", _SC_ICACHE_LINESZ},
Fred Drakec9680921999-12-13 16:37:25 +000011401#endif
11402#ifdef _SC_ICACHE_SZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011403 {"SC_ICACHE_SZ", _SC_ICACHE_SZ},
Fred Drakec9680921999-12-13 16:37:25 +000011404#endif
Fred Draked86ed291999-12-15 15:34:33 +000011405#ifdef _SC_INF
Victor Stinner8c62be82010-05-06 00:08:46 +000011406 {"SC_INF", _SC_INF},
Fred Draked86ed291999-12-15 15:34:33 +000011407#endif
Fred Drakec9680921999-12-13 16:37:25 +000011408#ifdef _SC_INT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011409 {"SC_INT_MAX", _SC_INT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011410#endif
11411#ifdef _SC_INT_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000011412 {"SC_INT_MIN", _SC_INT_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000011413#endif
11414#ifdef _SC_IOV_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011415 {"SC_IOV_MAX", _SC_IOV_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011416#endif
Fred Draked86ed291999-12-15 15:34:33 +000011417#ifdef _SC_IP_SECOPTS
Victor Stinner8c62be82010-05-06 00:08:46 +000011418 {"SC_IP_SECOPTS", _SC_IP_SECOPTS},
Fred Draked86ed291999-12-15 15:34:33 +000011419#endif
Fred Drakec9680921999-12-13 16:37:25 +000011420#ifdef _SC_JOB_CONTROL
Victor Stinner8c62be82010-05-06 00:08:46 +000011421 {"SC_JOB_CONTROL", _SC_JOB_CONTROL},
Fred Drakec9680921999-12-13 16:37:25 +000011422#endif
Fred Draked86ed291999-12-15 15:34:33 +000011423#ifdef _SC_KERN_POINTERS
Victor Stinner8c62be82010-05-06 00:08:46 +000011424 {"SC_KERN_POINTERS", _SC_KERN_POINTERS},
Fred Draked86ed291999-12-15 15:34:33 +000011425#endif
11426#ifdef _SC_KERN_SIM
Victor Stinner8c62be82010-05-06 00:08:46 +000011427 {"SC_KERN_SIM", _SC_KERN_SIM},
Fred Draked86ed291999-12-15 15:34:33 +000011428#endif
Fred Drakec9680921999-12-13 16:37:25 +000011429#ifdef _SC_LINE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011430 {"SC_LINE_MAX", _SC_LINE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011431#endif
11432#ifdef _SC_LOGIN_NAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011433 {"SC_LOGIN_NAME_MAX", _SC_LOGIN_NAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011434#endif
11435#ifdef _SC_LOGNAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011436 {"SC_LOGNAME_MAX", _SC_LOGNAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011437#endif
11438#ifdef _SC_LONG_BIT
Victor Stinner8c62be82010-05-06 00:08:46 +000011439 {"SC_LONG_BIT", _SC_LONG_BIT},
Fred Drakec9680921999-12-13 16:37:25 +000011440#endif
Fred Draked86ed291999-12-15 15:34:33 +000011441#ifdef _SC_MAC
Victor Stinner8c62be82010-05-06 00:08:46 +000011442 {"SC_MAC", _SC_MAC},
Fred Draked86ed291999-12-15 15:34:33 +000011443#endif
Fred Drakec9680921999-12-13 16:37:25 +000011444#ifdef _SC_MAPPED_FILES
Victor Stinner8c62be82010-05-06 00:08:46 +000011445 {"SC_MAPPED_FILES", _SC_MAPPED_FILES},
Fred Drakec9680921999-12-13 16:37:25 +000011446#endif
11447#ifdef _SC_MAXPID
Victor Stinner8c62be82010-05-06 00:08:46 +000011448 {"SC_MAXPID", _SC_MAXPID},
Fred Drakec9680921999-12-13 16:37:25 +000011449#endif
11450#ifdef _SC_MB_LEN_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011451 {"SC_MB_LEN_MAX", _SC_MB_LEN_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011452#endif
11453#ifdef _SC_MEMLOCK
Victor Stinner8c62be82010-05-06 00:08:46 +000011454 {"SC_MEMLOCK", _SC_MEMLOCK},
Fred Drakec9680921999-12-13 16:37:25 +000011455#endif
11456#ifdef _SC_MEMLOCK_RANGE
Victor Stinner8c62be82010-05-06 00:08:46 +000011457 {"SC_MEMLOCK_RANGE", _SC_MEMLOCK_RANGE},
Fred Drakec9680921999-12-13 16:37:25 +000011458#endif
11459#ifdef _SC_MEMORY_PROTECTION
Victor Stinner8c62be82010-05-06 00:08:46 +000011460 {"SC_MEMORY_PROTECTION", _SC_MEMORY_PROTECTION},
Fred Drakec9680921999-12-13 16:37:25 +000011461#endif
11462#ifdef _SC_MESSAGE_PASSING
Victor Stinner8c62be82010-05-06 00:08:46 +000011463 {"SC_MESSAGE_PASSING", _SC_MESSAGE_PASSING},
Fred Drakec9680921999-12-13 16:37:25 +000011464#endif
Fred Draked86ed291999-12-15 15:34:33 +000011465#ifdef _SC_MMAP_FIXED_ALIGNMENT
Victor Stinner8c62be82010-05-06 00:08:46 +000011466 {"SC_MMAP_FIXED_ALIGNMENT", _SC_MMAP_FIXED_ALIGNMENT},
Fred Draked86ed291999-12-15 15:34:33 +000011467#endif
Fred Drakec9680921999-12-13 16:37:25 +000011468#ifdef _SC_MQ_OPEN_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011469 {"SC_MQ_OPEN_MAX", _SC_MQ_OPEN_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011470#endif
11471#ifdef _SC_MQ_PRIO_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011472 {"SC_MQ_PRIO_MAX", _SC_MQ_PRIO_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011473#endif
Fred Draked86ed291999-12-15 15:34:33 +000011474#ifdef _SC_NACLS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011475 {"SC_NACLS_MAX", _SC_NACLS_MAX},
Fred Draked86ed291999-12-15 15:34:33 +000011476#endif
Fred Drakec9680921999-12-13 16:37:25 +000011477#ifdef _SC_NGROUPS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011478 {"SC_NGROUPS_MAX", _SC_NGROUPS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011479#endif
11480#ifdef _SC_NL_ARGMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011481 {"SC_NL_ARGMAX", _SC_NL_ARGMAX},
Fred Drakec9680921999-12-13 16:37:25 +000011482#endif
11483#ifdef _SC_NL_LANGMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011484 {"SC_NL_LANGMAX", _SC_NL_LANGMAX},
Fred Drakec9680921999-12-13 16:37:25 +000011485#endif
11486#ifdef _SC_NL_MSGMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011487 {"SC_NL_MSGMAX", _SC_NL_MSGMAX},
Fred Drakec9680921999-12-13 16:37:25 +000011488#endif
11489#ifdef _SC_NL_NMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011490 {"SC_NL_NMAX", _SC_NL_NMAX},
Fred Drakec9680921999-12-13 16:37:25 +000011491#endif
11492#ifdef _SC_NL_SETMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011493 {"SC_NL_SETMAX", _SC_NL_SETMAX},
Fred Drakec9680921999-12-13 16:37:25 +000011494#endif
11495#ifdef _SC_NL_TEXTMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011496 {"SC_NL_TEXTMAX", _SC_NL_TEXTMAX},
Fred Drakec9680921999-12-13 16:37:25 +000011497#endif
11498#ifdef _SC_NPROCESSORS_CONF
Victor Stinner8c62be82010-05-06 00:08:46 +000011499 {"SC_NPROCESSORS_CONF", _SC_NPROCESSORS_CONF},
Fred Drakec9680921999-12-13 16:37:25 +000011500#endif
11501#ifdef _SC_NPROCESSORS_ONLN
Victor Stinner8c62be82010-05-06 00:08:46 +000011502 {"SC_NPROCESSORS_ONLN", _SC_NPROCESSORS_ONLN},
Fred Drakec9680921999-12-13 16:37:25 +000011503#endif
Fred Draked86ed291999-12-15 15:34:33 +000011504#ifdef _SC_NPROC_CONF
Victor Stinner8c62be82010-05-06 00:08:46 +000011505 {"SC_NPROC_CONF", _SC_NPROC_CONF},
Fred Draked86ed291999-12-15 15:34:33 +000011506#endif
11507#ifdef _SC_NPROC_ONLN
Victor Stinner8c62be82010-05-06 00:08:46 +000011508 {"SC_NPROC_ONLN", _SC_NPROC_ONLN},
Fred Draked86ed291999-12-15 15:34:33 +000011509#endif
Fred Drakec9680921999-12-13 16:37:25 +000011510#ifdef _SC_NZERO
Victor Stinner8c62be82010-05-06 00:08:46 +000011511 {"SC_NZERO", _SC_NZERO},
Fred Drakec9680921999-12-13 16:37:25 +000011512#endif
11513#ifdef _SC_OPEN_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011514 {"SC_OPEN_MAX", _SC_OPEN_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011515#endif
11516#ifdef _SC_PAGESIZE
Victor Stinner8c62be82010-05-06 00:08:46 +000011517 {"SC_PAGESIZE", _SC_PAGESIZE},
Fred Drakec9680921999-12-13 16:37:25 +000011518#endif
11519#ifdef _SC_PAGE_SIZE
Victor Stinner8c62be82010-05-06 00:08:46 +000011520 {"SC_PAGE_SIZE", _SC_PAGE_SIZE},
Fred Drakec9680921999-12-13 16:37:25 +000011521#endif
Batuhan Taşkaya909f4a32020-04-05 03:40:49 +030011522#ifdef _SC_AIX_REALMEM
11523 {"SC_AIX_REALMEM", _SC_AIX_REALMEM},
11524#endif
Fred Drakec9680921999-12-13 16:37:25 +000011525#ifdef _SC_PASS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011526 {"SC_PASS_MAX", _SC_PASS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011527#endif
11528#ifdef _SC_PHYS_PAGES
Victor Stinner8c62be82010-05-06 00:08:46 +000011529 {"SC_PHYS_PAGES", _SC_PHYS_PAGES},
Fred Drakec9680921999-12-13 16:37:25 +000011530#endif
11531#ifdef _SC_PII
Victor Stinner8c62be82010-05-06 00:08:46 +000011532 {"SC_PII", _SC_PII},
Fred Drakec9680921999-12-13 16:37:25 +000011533#endif
11534#ifdef _SC_PII_INTERNET
Victor Stinner8c62be82010-05-06 00:08:46 +000011535 {"SC_PII_INTERNET", _SC_PII_INTERNET},
Fred Drakec9680921999-12-13 16:37:25 +000011536#endif
11537#ifdef _SC_PII_INTERNET_DGRAM
Victor Stinner8c62be82010-05-06 00:08:46 +000011538 {"SC_PII_INTERNET_DGRAM", _SC_PII_INTERNET_DGRAM},
Fred Drakec9680921999-12-13 16:37:25 +000011539#endif
11540#ifdef _SC_PII_INTERNET_STREAM
Victor Stinner8c62be82010-05-06 00:08:46 +000011541 {"SC_PII_INTERNET_STREAM", _SC_PII_INTERNET_STREAM},
Fred Drakec9680921999-12-13 16:37:25 +000011542#endif
11543#ifdef _SC_PII_OSI
Victor Stinner8c62be82010-05-06 00:08:46 +000011544 {"SC_PII_OSI", _SC_PII_OSI},
Fred Drakec9680921999-12-13 16:37:25 +000011545#endif
11546#ifdef _SC_PII_OSI_CLTS
Victor Stinner8c62be82010-05-06 00:08:46 +000011547 {"SC_PII_OSI_CLTS", _SC_PII_OSI_CLTS},
Fred Drakec9680921999-12-13 16:37:25 +000011548#endif
11549#ifdef _SC_PII_OSI_COTS
Victor Stinner8c62be82010-05-06 00:08:46 +000011550 {"SC_PII_OSI_COTS", _SC_PII_OSI_COTS},
Fred Drakec9680921999-12-13 16:37:25 +000011551#endif
11552#ifdef _SC_PII_OSI_M
Victor Stinner8c62be82010-05-06 00:08:46 +000011553 {"SC_PII_OSI_M", _SC_PII_OSI_M},
Fred Drakec9680921999-12-13 16:37:25 +000011554#endif
11555#ifdef _SC_PII_SOCKET
Victor Stinner8c62be82010-05-06 00:08:46 +000011556 {"SC_PII_SOCKET", _SC_PII_SOCKET},
Fred Drakec9680921999-12-13 16:37:25 +000011557#endif
11558#ifdef _SC_PII_XTI
Victor Stinner8c62be82010-05-06 00:08:46 +000011559 {"SC_PII_XTI", _SC_PII_XTI},
Fred Drakec9680921999-12-13 16:37:25 +000011560#endif
11561#ifdef _SC_POLL
Victor Stinner8c62be82010-05-06 00:08:46 +000011562 {"SC_POLL", _SC_POLL},
Fred Drakec9680921999-12-13 16:37:25 +000011563#endif
11564#ifdef _SC_PRIORITIZED_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000011565 {"SC_PRIORITIZED_IO", _SC_PRIORITIZED_IO},
Fred Drakec9680921999-12-13 16:37:25 +000011566#endif
11567#ifdef _SC_PRIORITY_SCHEDULING
Victor Stinner8c62be82010-05-06 00:08:46 +000011568 {"SC_PRIORITY_SCHEDULING", _SC_PRIORITY_SCHEDULING},
Fred Drakec9680921999-12-13 16:37:25 +000011569#endif
11570#ifdef _SC_REALTIME_SIGNALS
Victor Stinner8c62be82010-05-06 00:08:46 +000011571 {"SC_REALTIME_SIGNALS", _SC_REALTIME_SIGNALS},
Fred Drakec9680921999-12-13 16:37:25 +000011572#endif
11573#ifdef _SC_RE_DUP_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011574 {"SC_RE_DUP_MAX", _SC_RE_DUP_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011575#endif
11576#ifdef _SC_RTSIG_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011577 {"SC_RTSIG_MAX", _SC_RTSIG_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011578#endif
11579#ifdef _SC_SAVED_IDS
Victor Stinner8c62be82010-05-06 00:08:46 +000011580 {"SC_SAVED_IDS", _SC_SAVED_IDS},
Fred Drakec9680921999-12-13 16:37:25 +000011581#endif
11582#ifdef _SC_SCHAR_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011583 {"SC_SCHAR_MAX", _SC_SCHAR_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011584#endif
11585#ifdef _SC_SCHAR_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000011586 {"SC_SCHAR_MIN", _SC_SCHAR_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000011587#endif
11588#ifdef _SC_SELECT
Victor Stinner8c62be82010-05-06 00:08:46 +000011589 {"SC_SELECT", _SC_SELECT},
Fred Drakec9680921999-12-13 16:37:25 +000011590#endif
11591#ifdef _SC_SEMAPHORES
Victor Stinner8c62be82010-05-06 00:08:46 +000011592 {"SC_SEMAPHORES", _SC_SEMAPHORES},
Fred Drakec9680921999-12-13 16:37:25 +000011593#endif
11594#ifdef _SC_SEM_NSEMS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011595 {"SC_SEM_NSEMS_MAX", _SC_SEM_NSEMS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011596#endif
11597#ifdef _SC_SEM_VALUE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011598 {"SC_SEM_VALUE_MAX", _SC_SEM_VALUE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011599#endif
11600#ifdef _SC_SHARED_MEMORY_OBJECTS
Victor Stinner8c62be82010-05-06 00:08:46 +000011601 {"SC_SHARED_MEMORY_OBJECTS", _SC_SHARED_MEMORY_OBJECTS},
Fred Drakec9680921999-12-13 16:37:25 +000011602#endif
11603#ifdef _SC_SHRT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011604 {"SC_SHRT_MAX", _SC_SHRT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011605#endif
11606#ifdef _SC_SHRT_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000011607 {"SC_SHRT_MIN", _SC_SHRT_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000011608#endif
11609#ifdef _SC_SIGQUEUE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011610 {"SC_SIGQUEUE_MAX", _SC_SIGQUEUE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011611#endif
11612#ifdef _SC_SIGRT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011613 {"SC_SIGRT_MAX", _SC_SIGRT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011614#endif
11615#ifdef _SC_SIGRT_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000011616 {"SC_SIGRT_MIN", _SC_SIGRT_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000011617#endif
Fred Draked86ed291999-12-15 15:34:33 +000011618#ifdef _SC_SOFTPOWER
Victor Stinner8c62be82010-05-06 00:08:46 +000011619 {"SC_SOFTPOWER", _SC_SOFTPOWER},
Fred Draked86ed291999-12-15 15:34:33 +000011620#endif
Fred Drakec9680921999-12-13 16:37:25 +000011621#ifdef _SC_SPLIT_CACHE
Victor Stinner8c62be82010-05-06 00:08:46 +000011622 {"SC_SPLIT_CACHE", _SC_SPLIT_CACHE},
Fred Drakec9680921999-12-13 16:37:25 +000011623#endif
11624#ifdef _SC_SSIZE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011625 {"SC_SSIZE_MAX", _SC_SSIZE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011626#endif
11627#ifdef _SC_STACK_PROT
Victor Stinner8c62be82010-05-06 00:08:46 +000011628 {"SC_STACK_PROT", _SC_STACK_PROT},
Fred Drakec9680921999-12-13 16:37:25 +000011629#endif
11630#ifdef _SC_STREAM_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011631 {"SC_STREAM_MAX", _SC_STREAM_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011632#endif
11633#ifdef _SC_SYNCHRONIZED_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000011634 {"SC_SYNCHRONIZED_IO", _SC_SYNCHRONIZED_IO},
Fred Drakec9680921999-12-13 16:37:25 +000011635#endif
11636#ifdef _SC_THREADS
Victor Stinner8c62be82010-05-06 00:08:46 +000011637 {"SC_THREADS", _SC_THREADS},
Fred Drakec9680921999-12-13 16:37:25 +000011638#endif
11639#ifdef _SC_THREAD_ATTR_STACKADDR
Victor Stinner8c62be82010-05-06 00:08:46 +000011640 {"SC_THREAD_ATTR_STACKADDR", _SC_THREAD_ATTR_STACKADDR},
Fred Drakec9680921999-12-13 16:37:25 +000011641#endif
11642#ifdef _SC_THREAD_ATTR_STACKSIZE
Victor Stinner8c62be82010-05-06 00:08:46 +000011643 {"SC_THREAD_ATTR_STACKSIZE", _SC_THREAD_ATTR_STACKSIZE},
Fred Drakec9680921999-12-13 16:37:25 +000011644#endif
11645#ifdef _SC_THREAD_DESTRUCTOR_ITERATIONS
Victor Stinner8c62be82010-05-06 00:08:46 +000011646 {"SC_THREAD_DESTRUCTOR_ITERATIONS", _SC_THREAD_DESTRUCTOR_ITERATIONS},
Fred Drakec9680921999-12-13 16:37:25 +000011647#endif
11648#ifdef _SC_THREAD_KEYS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011649 {"SC_THREAD_KEYS_MAX", _SC_THREAD_KEYS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011650#endif
11651#ifdef _SC_THREAD_PRIORITY_SCHEDULING
Victor Stinner8c62be82010-05-06 00:08:46 +000011652 {"SC_THREAD_PRIORITY_SCHEDULING", _SC_THREAD_PRIORITY_SCHEDULING},
Fred Drakec9680921999-12-13 16:37:25 +000011653#endif
11654#ifdef _SC_THREAD_PRIO_INHERIT
Victor Stinner8c62be82010-05-06 00:08:46 +000011655 {"SC_THREAD_PRIO_INHERIT", _SC_THREAD_PRIO_INHERIT},
Fred Drakec9680921999-12-13 16:37:25 +000011656#endif
11657#ifdef _SC_THREAD_PRIO_PROTECT
Victor Stinner8c62be82010-05-06 00:08:46 +000011658 {"SC_THREAD_PRIO_PROTECT", _SC_THREAD_PRIO_PROTECT},
Fred Drakec9680921999-12-13 16:37:25 +000011659#endif
11660#ifdef _SC_THREAD_PROCESS_SHARED
Victor Stinner8c62be82010-05-06 00:08:46 +000011661 {"SC_THREAD_PROCESS_SHARED", _SC_THREAD_PROCESS_SHARED},
Fred Drakec9680921999-12-13 16:37:25 +000011662#endif
11663#ifdef _SC_THREAD_SAFE_FUNCTIONS
Victor Stinner8c62be82010-05-06 00:08:46 +000011664 {"SC_THREAD_SAFE_FUNCTIONS", _SC_THREAD_SAFE_FUNCTIONS},
Fred Drakec9680921999-12-13 16:37:25 +000011665#endif
11666#ifdef _SC_THREAD_STACK_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000011667 {"SC_THREAD_STACK_MIN", _SC_THREAD_STACK_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000011668#endif
11669#ifdef _SC_THREAD_THREADS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011670 {"SC_THREAD_THREADS_MAX", _SC_THREAD_THREADS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011671#endif
11672#ifdef _SC_TIMERS
Victor Stinner8c62be82010-05-06 00:08:46 +000011673 {"SC_TIMERS", _SC_TIMERS},
Fred Drakec9680921999-12-13 16:37:25 +000011674#endif
11675#ifdef _SC_TIMER_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011676 {"SC_TIMER_MAX", _SC_TIMER_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011677#endif
11678#ifdef _SC_TTY_NAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011679 {"SC_TTY_NAME_MAX", _SC_TTY_NAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011680#endif
11681#ifdef _SC_TZNAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011682 {"SC_TZNAME_MAX", _SC_TZNAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011683#endif
11684#ifdef _SC_T_IOV_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011685 {"SC_T_IOV_MAX", _SC_T_IOV_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011686#endif
11687#ifdef _SC_UCHAR_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011688 {"SC_UCHAR_MAX", _SC_UCHAR_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011689#endif
11690#ifdef _SC_UINT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011691 {"SC_UINT_MAX", _SC_UINT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011692#endif
11693#ifdef _SC_UIO_MAXIOV
Victor Stinner8c62be82010-05-06 00:08:46 +000011694 {"SC_UIO_MAXIOV", _SC_UIO_MAXIOV},
Fred Drakec9680921999-12-13 16:37:25 +000011695#endif
11696#ifdef _SC_ULONG_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011697 {"SC_ULONG_MAX", _SC_ULONG_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011698#endif
11699#ifdef _SC_USHRT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011700 {"SC_USHRT_MAX", _SC_USHRT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011701#endif
11702#ifdef _SC_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000011703 {"SC_VERSION", _SC_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000011704#endif
11705#ifdef _SC_WORD_BIT
Victor Stinner8c62be82010-05-06 00:08:46 +000011706 {"SC_WORD_BIT", _SC_WORD_BIT},
Fred Drakec9680921999-12-13 16:37:25 +000011707#endif
11708#ifdef _SC_XBS5_ILP32_OFF32
Victor Stinner8c62be82010-05-06 00:08:46 +000011709 {"SC_XBS5_ILP32_OFF32", _SC_XBS5_ILP32_OFF32},
Fred Drakec9680921999-12-13 16:37:25 +000011710#endif
11711#ifdef _SC_XBS5_ILP32_OFFBIG
Victor Stinner8c62be82010-05-06 00:08:46 +000011712 {"SC_XBS5_ILP32_OFFBIG", _SC_XBS5_ILP32_OFFBIG},
Fred Drakec9680921999-12-13 16:37:25 +000011713#endif
11714#ifdef _SC_XBS5_LP64_OFF64
Victor Stinner8c62be82010-05-06 00:08:46 +000011715 {"SC_XBS5_LP64_OFF64", _SC_XBS5_LP64_OFF64},
Fred Drakec9680921999-12-13 16:37:25 +000011716#endif
11717#ifdef _SC_XBS5_LPBIG_OFFBIG
Victor Stinner8c62be82010-05-06 00:08:46 +000011718 {"SC_XBS5_LPBIG_OFFBIG", _SC_XBS5_LPBIG_OFFBIG},
Fred Drakec9680921999-12-13 16:37:25 +000011719#endif
11720#ifdef _SC_XOPEN_CRYPT
Victor Stinner8c62be82010-05-06 00:08:46 +000011721 {"SC_XOPEN_CRYPT", _SC_XOPEN_CRYPT},
Fred Drakec9680921999-12-13 16:37:25 +000011722#endif
11723#ifdef _SC_XOPEN_ENH_I18N
Victor Stinner8c62be82010-05-06 00:08:46 +000011724 {"SC_XOPEN_ENH_I18N", _SC_XOPEN_ENH_I18N},
Fred Drakec9680921999-12-13 16:37:25 +000011725#endif
11726#ifdef _SC_XOPEN_LEGACY
Victor Stinner8c62be82010-05-06 00:08:46 +000011727 {"SC_XOPEN_LEGACY", _SC_XOPEN_LEGACY},
Fred Drakec9680921999-12-13 16:37:25 +000011728#endif
11729#ifdef _SC_XOPEN_REALTIME
Victor Stinner8c62be82010-05-06 00:08:46 +000011730 {"SC_XOPEN_REALTIME", _SC_XOPEN_REALTIME},
Fred Drakec9680921999-12-13 16:37:25 +000011731#endif
11732#ifdef _SC_XOPEN_REALTIME_THREADS
Victor Stinner8c62be82010-05-06 00:08:46 +000011733 {"SC_XOPEN_REALTIME_THREADS", _SC_XOPEN_REALTIME_THREADS},
Fred Drakec9680921999-12-13 16:37:25 +000011734#endif
11735#ifdef _SC_XOPEN_SHM
Victor Stinner8c62be82010-05-06 00:08:46 +000011736 {"SC_XOPEN_SHM", _SC_XOPEN_SHM},
Fred Drakec9680921999-12-13 16:37:25 +000011737#endif
11738#ifdef _SC_XOPEN_UNIX
Victor Stinner8c62be82010-05-06 00:08:46 +000011739 {"SC_XOPEN_UNIX", _SC_XOPEN_UNIX},
Fred Drakec9680921999-12-13 16:37:25 +000011740#endif
11741#ifdef _SC_XOPEN_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000011742 {"SC_XOPEN_VERSION", _SC_XOPEN_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000011743#endif
11744#ifdef _SC_XOPEN_XCU_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000011745 {"SC_XOPEN_XCU_VERSION", _SC_XOPEN_XCU_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000011746#endif
11747#ifdef _SC_XOPEN_XPG2
Victor Stinner8c62be82010-05-06 00:08:46 +000011748 {"SC_XOPEN_XPG2", _SC_XOPEN_XPG2},
Fred Drakec9680921999-12-13 16:37:25 +000011749#endif
11750#ifdef _SC_XOPEN_XPG3
Victor Stinner8c62be82010-05-06 00:08:46 +000011751 {"SC_XOPEN_XPG3", _SC_XOPEN_XPG3},
Fred Drakec9680921999-12-13 16:37:25 +000011752#endif
11753#ifdef _SC_XOPEN_XPG4
Victor Stinner8c62be82010-05-06 00:08:46 +000011754 {"SC_XOPEN_XPG4", _SC_XOPEN_XPG4},
Fred Drakec9680921999-12-13 16:37:25 +000011755#endif
11756};
11757
11758static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000011759conv_sysconf_confname(PyObject *arg, int *valuep)
Fred Drakec9680921999-12-13 16:37:25 +000011760{
11761 return conv_confname(arg, valuep, posix_constants_sysconf,
11762 sizeof(posix_constants_sysconf)
11763 / sizeof(struct constdef));
11764}
11765
Larry Hastings2f936352014-08-05 14:04:04 +100011766
11767/*[clinic input]
11768os.sysconf -> long
11769 name: sysconf_confname
11770 /
11771
11772Return an integer-valued system configuration variable.
11773[clinic start generated code]*/
11774
Larry Hastings2f936352014-08-05 14:04:04 +100011775static long
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011776os_sysconf_impl(PyObject *module, int name)
11777/*[clinic end generated code: output=3662f945fc0cc756 input=279e3430a33f29e4]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011778{
11779 long value;
11780
11781 errno = 0;
11782 value = sysconf(name);
11783 if (value == -1 && errno != 0)
11784 posix_error();
11785 return value;
11786}
11787#endif /* HAVE_SYSCONF */
Fred Drakec9680921999-12-13 16:37:25 +000011788
11789
Fred Drakebec628d1999-12-15 18:31:10 +000011790/* This code is used to ensure that the tables of configuration value names
Serhiy Storchaka56a6d852014-12-01 18:28:43 +020011791 * are in sorted order as required by conv_confname(), and also to build
Fred Drakebec628d1999-12-15 18:31:10 +000011792 * the exported dictionaries that are used to publish information about the
11793 * names available on the host platform.
11794 *
11795 * Sorting the table at runtime ensures that the table is properly ordered
11796 * when used, even for platforms we're not able to test on. It also makes
11797 * it easier to add additional entries to the tables.
Fred Draked86ed291999-12-15 15:34:33 +000011798 */
Fred Drakebec628d1999-12-15 18:31:10 +000011799
11800static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000011801cmp_constdefs(const void *v1, const void *v2)
Fred Drakebec628d1999-12-15 18:31:10 +000011802{
11803 const struct constdef *c1 =
Victor Stinner8c62be82010-05-06 00:08:46 +000011804 (const struct constdef *) v1;
Fred Drakebec628d1999-12-15 18:31:10 +000011805 const struct constdef *c2 =
Victor Stinner8c62be82010-05-06 00:08:46 +000011806 (const struct constdef *) v2;
Fred Drakebec628d1999-12-15 18:31:10 +000011807
11808 return strcmp(c1->name, c2->name);
11809}
11810
11811static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000011812setup_confname_table(struct constdef *table, size_t tablesize,
Serhiy Storchakadeab18d2016-05-07 16:45:18 +030011813 const char *tablename, PyObject *module)
Fred Draked86ed291999-12-15 15:34:33 +000011814{
Fred Drakebec628d1999-12-15 18:31:10 +000011815 PyObject *d = NULL;
Barry Warsaw3155db32000-04-13 15:20:40 +000011816 size_t i;
Fred Drakebec628d1999-12-15 18:31:10 +000011817
11818 qsort(table, tablesize, sizeof(struct constdef), cmp_constdefs);
11819 d = PyDict_New();
Barry Warsaw3155db32000-04-13 15:20:40 +000011820 if (d == NULL)
Victor Stinner8c62be82010-05-06 00:08:46 +000011821 return -1;
Fred Draked86ed291999-12-15 15:34:33 +000011822
Barry Warsaw3155db32000-04-13 15:20:40 +000011823 for (i=0; i < tablesize; ++i) {
Victor Stinner8c62be82010-05-06 00:08:46 +000011824 PyObject *o = PyLong_FromLong(table[i].value);
11825 if (o == NULL || PyDict_SetItemString(d, table[i].name, o) == -1) {
11826 Py_XDECREF(o);
11827 Py_DECREF(d);
11828 return -1;
11829 }
11830 Py_DECREF(o);
Fred Draked86ed291999-12-15 15:34:33 +000011831 }
Fred Drake4d1e64b2002-04-15 19:40:07 +000011832 return PyModule_AddObject(module, tablename, d);
Fred Draked86ed291999-12-15 15:34:33 +000011833}
11834
Fred Drakebec628d1999-12-15 18:31:10 +000011835/* Return -1 on failure, 0 on success. */
11836static int
Fred Drake4d1e64b2002-04-15 19:40:07 +000011837setup_confname_tables(PyObject *module)
Fred Draked86ed291999-12-15 15:34:33 +000011838{
11839#if defined(HAVE_FPATHCONF) || defined(HAVE_PATHCONF)
Fred Drakebec628d1999-12-15 18:31:10 +000011840 if (setup_confname_table(posix_constants_pathconf,
Fred Draked86ed291999-12-15 15:34:33 +000011841 sizeof(posix_constants_pathconf)
11842 / sizeof(struct constdef),
Fred Drake4d1e64b2002-04-15 19:40:07 +000011843 "pathconf_names", module))
Stefan Krah0e803b32010-11-26 16:16:47 +000011844 return -1;
Fred Draked86ed291999-12-15 15:34:33 +000011845#endif
11846#ifdef HAVE_CONFSTR
Fred Drakebec628d1999-12-15 18:31:10 +000011847 if (setup_confname_table(posix_constants_confstr,
Fred Draked86ed291999-12-15 15:34:33 +000011848 sizeof(posix_constants_confstr)
11849 / sizeof(struct constdef),
Fred Drake4d1e64b2002-04-15 19:40:07 +000011850 "confstr_names", module))
Stefan Krah0e803b32010-11-26 16:16:47 +000011851 return -1;
Fred Draked86ed291999-12-15 15:34:33 +000011852#endif
11853#ifdef HAVE_SYSCONF
Fred Drakebec628d1999-12-15 18:31:10 +000011854 if (setup_confname_table(posix_constants_sysconf,
Fred Draked86ed291999-12-15 15:34:33 +000011855 sizeof(posix_constants_sysconf)
11856 / sizeof(struct constdef),
Fred Drake4d1e64b2002-04-15 19:40:07 +000011857 "sysconf_names", module))
Stefan Krah0e803b32010-11-26 16:16:47 +000011858 return -1;
Fred Draked86ed291999-12-15 15:34:33 +000011859#endif
Fred Drakebec628d1999-12-15 18:31:10 +000011860 return 0;
Fred Draked86ed291999-12-15 15:34:33 +000011861}
Fred Draked86ed291999-12-15 15:34:33 +000011862
11863
Larry Hastings2f936352014-08-05 14:04:04 +100011864/*[clinic input]
11865os.abort
11866
11867Abort the interpreter immediately.
11868
11869This function 'dumps core' or otherwise fails in the hardest way possible
11870on the hosting operating system. This function never returns.
11871[clinic start generated code]*/
11872
Larry Hastings2f936352014-08-05 14:04:04 +100011873static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011874os_abort_impl(PyObject *module)
11875/*[clinic end generated code: output=dcf52586dad2467c input=cf2c7d98bc504047]*/
Fred Drake5ab8eaf1999-12-09 21:13:07 +000011876{
Fred Drake5ab8eaf1999-12-09 21:13:07 +000011877 abort();
11878 /*NOTREACHED*/
Victor Stinner9a2329f2016-12-05 17:56:36 +010011879#ifndef __clang__
11880 /* Issue #28152: abort() is declared with __attribute__((__noreturn__)).
11881 GCC emits a warning without "return NULL;" (compiler bug?), but Clang
11882 is smarter and emits a warning on the return. */
Fred Drake5ab8eaf1999-12-09 21:13:07 +000011883 Py_FatalError("abort() called from Python code didn't abort!");
11884 return NULL;
Victor Stinner9a2329f2016-12-05 17:56:36 +010011885#endif
Fred Drake5ab8eaf1999-12-09 21:13:07 +000011886}
Fred Drakebec628d1999-12-15 18:31:10 +000011887
Martin v. Löwis6238d2b2002-06-30 15:26:10 +000011888#ifdef MS_WINDOWS
Steve Dower7d0e0c92015-01-24 08:18:24 -080011889/* Grab ShellExecute dynamically from shell32 */
11890static int has_ShellExecute = -1;
Steve Dower7d0e0c92015-01-24 08:18:24 -080011891static HINSTANCE (CALLBACK *Py_ShellExecuteW)(HWND, LPCWSTR, LPCWSTR, LPCWSTR,
11892 LPCWSTR, INT);
11893static int
11894check_ShellExecute()
11895{
11896 HINSTANCE hShell32;
11897
11898 /* only recheck */
11899 if (-1 == has_ShellExecute) {
11900 Py_BEGIN_ALLOW_THREADS
Victor Stinnera9912152017-10-13 13:46:57 -070011901 /* Security note: this call is not vulnerable to "DLL hijacking".
11902 SHELL32 is part of "KnownDLLs" and so Windows always load
11903 the system SHELL32.DLL, even if there is another SHELL32.DLL
11904 in the DLL search path. */
Steve Dower7d0e0c92015-01-24 08:18:24 -080011905 hShell32 = LoadLibraryW(L"SHELL32");
Steve Dower7d0e0c92015-01-24 08:18:24 -080011906 if (hShell32) {
Steve Dower7d0e0c92015-01-24 08:18:24 -080011907 *(FARPROC*)&Py_ShellExecuteW = GetProcAddress(hShell32,
11908 "ShellExecuteW");
Steve Dowercc16be82016-09-08 10:35:16 -070011909 has_ShellExecute = Py_ShellExecuteW != NULL;
Steve Dower7d0e0c92015-01-24 08:18:24 -080011910 } else {
11911 has_ShellExecute = 0;
11912 }
Tony Roberts4860f012019-02-02 18:16:42 +010011913 Py_END_ALLOW_THREADS
Steve Dower7d0e0c92015-01-24 08:18:24 -080011914 }
11915 return has_ShellExecute;
11916}
11917
11918
Steve Dowercc16be82016-09-08 10:35:16 -070011919/*[clinic input]
11920os.startfile
11921 filepath: path_t
11922 operation: Py_UNICODE = NULL
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +000011923
Steve Dowercc16be82016-09-08 10:35:16 -070011924Start a file with its associated application.
11925
11926When "operation" is not specified or "open", this acts like
11927double-clicking the file in Explorer, or giving the file name as an
11928argument to the DOS "start" command: the file is opened with whatever
11929application (if any) its extension is associated.
11930When another "operation" is given, it specifies what should be done with
11931the file. A typical operation is "print".
11932
11933startfile returns as soon as the associated application is launched.
11934There is no option to wait for the application to close, and no way
11935to retrieve the application's exit status.
11936
11937The filepath is relative to the current directory. If you want to use
11938an absolute path, make sure the first character is not a slash ("/");
11939the underlying Win32 ShellExecute function doesn't work if it is.
11940[clinic start generated code]*/
11941
11942static PyObject *
Serhiy Storchakaafb3e712018-12-14 11:19:51 +020011943os_startfile_impl(PyObject *module, path_t *filepath,
11944 const Py_UNICODE *operation)
Serhiy Storchaka279f4462019-09-14 12:24:05 +030011945/*[clinic end generated code: output=66dc311c94d50797 input=c940888a5390f039]*/
Steve Dowercc16be82016-09-08 10:35:16 -070011946{
11947 HINSTANCE rc;
Steve Dower7d0e0c92015-01-24 08:18:24 -080011948
11949 if(!check_ShellExecute()) {
11950 /* If the OS doesn't have ShellExecute, return a
11951 NotImplementedError. */
11952 return PyErr_Format(PyExc_NotImplementedError,
11953 "startfile not available on this platform");
11954 }
11955
Saiyang Gou7514f4f2020-02-12 23:47:42 -080011956 if (PySys_Audit("os.startfile", "Ou", filepath->object, operation) < 0) {
Saiyang Gou95f60012020-02-04 16:15:00 -080011957 return NULL;
11958 }
11959
Victor Stinner8c62be82010-05-06 00:08:46 +000011960 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -070011961 rc = Py_ShellExecuteW((HWND)0, operation, filepath->wide,
Steve Dower7d0e0c92015-01-24 08:18:24 -080011962 NULL, NULL, SW_SHOWNORMAL);
Victor Stinner8c62be82010-05-06 00:08:46 +000011963 Py_END_ALLOW_THREADS
11964
Victor Stinner8c62be82010-05-06 00:08:46 +000011965 if (rc <= (HINSTANCE)32) {
Steve Dowercc16be82016-09-08 10:35:16 -070011966 win32_error_object("startfile", filepath->object);
Victor Stinnereb5657a2011-09-30 01:44:27 +020011967 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +000011968 }
Steve Dowercc16be82016-09-08 10:35:16 -070011969 Py_RETURN_NONE;
Tim Petersf58a7aa2000-09-22 10:05:54 +000011970}
Larry Hastings2f936352014-08-05 14:04:04 +100011971#endif /* MS_WINDOWS */
11972
Fred Drake5ab8eaf1999-12-09 21:13:07 +000011973
Martin v. Löwis438b5342002-12-27 10:16:42 +000011974#ifdef HAVE_GETLOADAVG
Larry Hastings2f936352014-08-05 14:04:04 +100011975/*[clinic input]
11976os.getloadavg
11977
11978Return average recent system load information.
11979
11980Return the number of processes in the system run queue averaged over
11981the last 1, 5, and 15 minutes as a tuple of three floats.
11982Raises OSError if the load average was unobtainable.
11983[clinic start generated code]*/
11984
Larry Hastings2f936352014-08-05 14:04:04 +100011985static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011986os_getloadavg_impl(PyObject *module)
11987/*[clinic end generated code: output=9ad3a11bfb4f4bd2 input=3d6d826b76d8a34e]*/
Martin v. Löwis438b5342002-12-27 10:16:42 +000011988{
11989 double loadavg[3];
Martin v. Löwis438b5342002-12-27 10:16:42 +000011990 if (getloadavg(loadavg, 3)!=3) {
Stefan Krah0e803b32010-11-26 16:16:47 +000011991 PyErr_SetString(PyExc_OSError, "Load averages are unobtainable");
11992 return NULL;
Martin v. Löwis438b5342002-12-27 10:16:42 +000011993 } else
Stefan Krah0e803b32010-11-26 16:16:47 +000011994 return Py_BuildValue("ddd", loadavg[0], loadavg[1], loadavg[2]);
Martin v. Löwis438b5342002-12-27 10:16:42 +000011995}
Larry Hastings2f936352014-08-05 14:04:04 +100011996#endif /* HAVE_GETLOADAVG */
Martin v. Löwis438b5342002-12-27 10:16:42 +000011997
Larry Hastings2f936352014-08-05 14:04:04 +100011998
11999/*[clinic input]
12000os.device_encoding
12001 fd: int
12002
12003Return a string describing the encoding of a terminal's file descriptor.
12004
12005The file descriptor must be attached to a terminal.
12006If the device is not a terminal, return None.
12007[clinic start generated code]*/
12008
Larry Hastings2f936352014-08-05 14:04:04 +100012009static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012010os_device_encoding_impl(PyObject *module, int fd)
12011/*[clinic end generated code: output=e0d294bbab7e8c2b input=9e1d4a42b66df312]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012012{
Brett Cannonefb00c02012-02-29 18:31:31 -050012013 return _Py_device_encoding(fd);
Martin v. Löwisd1cd4d42007-08-11 14:02:14 +000012014}
12015
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000012016
Larry Hastings2f936352014-08-05 14:04:04 +100012017#ifdef HAVE_SETRESUID
12018/*[clinic input]
12019os.setresuid
12020
12021 ruid: uid_t
12022 euid: uid_t
12023 suid: uid_t
12024 /
12025
12026Set the current process's real, effective, and saved user ids.
12027[clinic start generated code]*/
12028
Larry Hastings2f936352014-08-05 14:04:04 +100012029static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012030os_setresuid_impl(PyObject *module, uid_t ruid, uid_t euid, uid_t suid)
12031/*[clinic end generated code: output=834a641e15373e97 input=9e33cb79a82792f3]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012032{
Victor Stinner8c62be82010-05-06 00:08:46 +000012033 if (setresuid(ruid, euid, suid) < 0)
12034 return posix_error();
12035 Py_RETURN_NONE;
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000012036}
Larry Hastings2f936352014-08-05 14:04:04 +100012037#endif /* HAVE_SETRESUID */
12038
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000012039
12040#ifdef HAVE_SETRESGID
Larry Hastings2f936352014-08-05 14:04:04 +100012041/*[clinic input]
12042os.setresgid
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000012043
Larry Hastings2f936352014-08-05 14:04:04 +100012044 rgid: gid_t
12045 egid: gid_t
12046 sgid: gid_t
12047 /
12048
12049Set the current process's real, effective, and saved group ids.
12050[clinic start generated code]*/
12051
Larry Hastings2f936352014-08-05 14:04:04 +100012052static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012053os_setresgid_impl(PyObject *module, gid_t rgid, gid_t egid, gid_t sgid)
12054/*[clinic end generated code: output=6aa402f3d2e514a9 input=33e9e0785ef426b1]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012055{
Victor Stinner8c62be82010-05-06 00:08:46 +000012056 if (setresgid(rgid, egid, sgid) < 0)
12057 return posix_error();
12058 Py_RETURN_NONE;
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000012059}
Larry Hastings2f936352014-08-05 14:04:04 +100012060#endif /* HAVE_SETRESGID */
12061
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000012062
12063#ifdef HAVE_GETRESUID
Larry Hastings2f936352014-08-05 14:04:04 +100012064/*[clinic input]
12065os.getresuid
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000012066
Larry Hastings2f936352014-08-05 14:04:04 +100012067Return a tuple of the current process's real, effective, and saved user ids.
12068[clinic start generated code]*/
12069
Larry Hastings2f936352014-08-05 14:04:04 +100012070static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012071os_getresuid_impl(PyObject *module)
12072/*[clinic end generated code: output=8e0becff5dece5bf input=41ccfa8e1f6517ad]*/
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000012073{
Victor Stinner8c62be82010-05-06 00:08:46 +000012074 uid_t ruid, euid, suid;
Victor Stinner8c62be82010-05-06 00:08:46 +000012075 if (getresuid(&ruid, &euid, &suid) < 0)
12076 return posix_error();
Serhiy Storchaka7cf55992013-02-10 21:56:49 +020012077 return Py_BuildValue("(NNN)", _PyLong_FromUid(ruid),
12078 _PyLong_FromUid(euid),
12079 _PyLong_FromUid(suid));
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000012080}
Larry Hastings2f936352014-08-05 14:04:04 +100012081#endif /* HAVE_GETRESUID */
12082
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000012083
12084#ifdef HAVE_GETRESGID
Larry Hastings2f936352014-08-05 14:04:04 +100012085/*[clinic input]
12086os.getresgid
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000012087
Larry Hastings2f936352014-08-05 14:04:04 +100012088Return a tuple of the current process's real, effective, and saved group ids.
12089[clinic start generated code]*/
12090
Larry Hastings2f936352014-08-05 14:04:04 +100012091static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012092os_getresgid_impl(PyObject *module)
12093/*[clinic end generated code: output=2719c4bfcf27fb9f input=517e68db9ca32df6]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012094{
12095 gid_t rgid, egid, sgid;
Victor Stinner8c62be82010-05-06 00:08:46 +000012096 if (getresgid(&rgid, &egid, &sgid) < 0)
12097 return posix_error();
Serhiy Storchaka7cf55992013-02-10 21:56:49 +020012098 return Py_BuildValue("(NNN)", _PyLong_FromGid(rgid),
12099 _PyLong_FromGid(egid),
12100 _PyLong_FromGid(sgid));
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000012101}
Larry Hastings2f936352014-08-05 14:04:04 +100012102#endif /* HAVE_GETRESGID */
12103
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000012104
Benjamin Peterson9428d532011-09-14 11:45:52 -040012105#ifdef USE_XATTRS
Larry Hastings2f936352014-08-05 14:04:04 +100012106/*[clinic input]
12107os.getxattr
Benjamin Peterson799bd802011-08-31 22:15:17 -040012108
Larry Hastings2f936352014-08-05 14:04:04 +100012109 path: path_t(allow_fd=True)
12110 attribute: path_t
12111 *
12112 follow_symlinks: bool = True
12113
12114Return the value of extended attribute attribute on path.
12115
BNMetricsb9427072018-11-02 15:20:19 +000012116path may be either a string, a path-like object, or an open file descriptor.
Larry Hastings2f936352014-08-05 14:04:04 +100012117If follow_symlinks is False, and the last element of the path is a symbolic
12118 link, getxattr will examine the symbolic link itself instead of the file
12119 the link points to.
12120
12121[clinic start generated code]*/
12122
Larry Hastings2f936352014-08-05 14:04:04 +100012123static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012124os_getxattr_impl(PyObject *module, path_t *path, path_t *attribute,
Larry Hastings89964c42015-04-14 18:07:59 -040012125 int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +000012126/*[clinic end generated code: output=5f2f44200a43cff2 input=025789491708f7eb]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012127{
12128 Py_ssize_t i;
12129 PyObject *buffer = NULL;
12130
12131 if (fd_and_follow_symlinks_invalid("getxattr", path->fd, follow_symlinks))
12132 return NULL;
Benjamin Peterson799bd802011-08-31 22:15:17 -040012133
Saiyang Gou7514f4f2020-02-12 23:47:42 -080012134 if (PySys_Audit("os.getxattr", "OO", path->object, attribute->object) < 0) {
12135 return NULL;
12136 }
12137
Larry Hastings9cf065c2012-06-22 16:30:09 -070012138 for (i = 0; ; i++) {
12139 void *ptr;
12140 ssize_t result;
Serhiy Storchaka2d06e842015-12-25 19:53:18 +020012141 static const Py_ssize_t buffer_sizes[] = {128, XATTR_SIZE_MAX, 0};
Larry Hastings9cf065c2012-06-22 16:30:09 -070012142 Py_ssize_t buffer_size = buffer_sizes[i];
12143 if (!buffer_size) {
Larry Hastings2f936352014-08-05 14:04:04 +100012144 path_error(path);
12145 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070012146 }
12147 buffer = PyBytes_FromStringAndSize(NULL, buffer_size);
12148 if (!buffer)
Larry Hastings2f936352014-08-05 14:04:04 +100012149 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070012150 ptr = PyBytes_AS_STRING(buffer);
Benjamin Peterson799bd802011-08-31 22:15:17 -040012151
Larry Hastings9cf065c2012-06-22 16:30:09 -070012152 Py_BEGIN_ALLOW_THREADS;
Larry Hastings2f936352014-08-05 14:04:04 +100012153 if (path->fd >= 0)
12154 result = fgetxattr(path->fd, attribute->narrow, ptr, buffer_size);
Larry Hastings9cf065c2012-06-22 16:30:09 -070012155 else if (follow_symlinks)
Larry Hastings2f936352014-08-05 14:04:04 +100012156 result = getxattr(path->narrow, attribute->narrow, ptr, buffer_size);
Larry Hastings9cf065c2012-06-22 16:30:09 -070012157 else
Larry Hastings2f936352014-08-05 14:04:04 +100012158 result = lgetxattr(path->narrow, attribute->narrow, ptr, buffer_size);
Larry Hastings9cf065c2012-06-22 16:30:09 -070012159 Py_END_ALLOW_THREADS;
Benjamin Peterson799bd802011-08-31 22:15:17 -040012160
Larry Hastings9cf065c2012-06-22 16:30:09 -070012161 if (result < 0) {
12162 Py_DECREF(buffer);
Larry Hastings9cf065c2012-06-22 16:30:09 -070012163 if (errno == ERANGE)
12164 continue;
Larry Hastings2f936352014-08-05 14:04:04 +100012165 path_error(path);
12166 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070012167 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040012168
Larry Hastings9cf065c2012-06-22 16:30:09 -070012169 if (result != buffer_size) {
12170 /* Can only shrink. */
12171 _PyBytes_Resize(&buffer, result);
12172 }
12173 break;
12174 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040012175
Larry Hastings9cf065c2012-06-22 16:30:09 -070012176 return buffer;
Benjamin Peterson799bd802011-08-31 22:15:17 -040012177}
12178
Larry Hastings2f936352014-08-05 14:04:04 +100012179
12180/*[clinic input]
12181os.setxattr
12182
12183 path: path_t(allow_fd=True)
12184 attribute: path_t
12185 value: Py_buffer
12186 flags: int = 0
12187 *
12188 follow_symlinks: bool = True
12189
12190Set extended attribute attribute on path to value.
12191
BNMetricsb9427072018-11-02 15:20:19 +000012192path may be either a string, a path-like object, or an open file descriptor.
Larry Hastings2f936352014-08-05 14:04:04 +100012193If follow_symlinks is False, and the last element of the path is a symbolic
12194 link, setxattr will modify the symbolic link itself instead of the file
12195 the link points to.
12196
12197[clinic start generated code]*/
12198
Benjamin Peterson799bd802011-08-31 22:15:17 -040012199static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012200os_setxattr_impl(PyObject *module, path_t *path, path_t *attribute,
Larry Hastings89964c42015-04-14 18:07:59 -040012201 Py_buffer *value, int flags, int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +000012202/*[clinic end generated code: output=98b83f63fdde26bb input=c17c0103009042f0]*/
Benjamin Peterson799bd802011-08-31 22:15:17 -040012203{
Larry Hastings2f936352014-08-05 14:04:04 +100012204 ssize_t result;
Benjamin Peterson799bd802011-08-31 22:15:17 -040012205
Larry Hastings2f936352014-08-05 14:04:04 +100012206 if (fd_and_follow_symlinks_invalid("setxattr", path->fd, follow_symlinks))
Benjamin Peterson799bd802011-08-31 22:15:17 -040012207 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070012208
Saiyang Gou7514f4f2020-02-12 23:47:42 -080012209 if (PySys_Audit("os.setxattr", "OOy#i", path->object, attribute->object,
12210 value->buf, value->len, flags) < 0) {
12211 return NULL;
12212 }
12213
Benjamin Peterson799bd802011-08-31 22:15:17 -040012214 Py_BEGIN_ALLOW_THREADS;
Larry Hastings2f936352014-08-05 14:04:04 +100012215 if (path->fd > -1)
12216 result = fsetxattr(path->fd, attribute->narrow,
12217 value->buf, value->len, flags);
Larry Hastings9cf065c2012-06-22 16:30:09 -070012218 else if (follow_symlinks)
Larry Hastings2f936352014-08-05 14:04:04 +100012219 result = setxattr(path->narrow, attribute->narrow,
12220 value->buf, value->len, flags);
Larry Hastings9cf065c2012-06-22 16:30:09 -070012221 else
Larry Hastings2f936352014-08-05 14:04:04 +100012222 result = lsetxattr(path->narrow, attribute->narrow,
12223 value->buf, value->len, flags);
Benjamin Peterson799bd802011-08-31 22:15:17 -040012224 Py_END_ALLOW_THREADS;
Benjamin Peterson799bd802011-08-31 22:15:17 -040012225
Larry Hastings9cf065c2012-06-22 16:30:09 -070012226 if (result) {
Larry Hastings2f936352014-08-05 14:04:04 +100012227 path_error(path);
12228 return NULL;
Benjamin Peterson799bd802011-08-31 22:15:17 -040012229 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040012230
Larry Hastings2f936352014-08-05 14:04:04 +100012231 Py_RETURN_NONE;
12232}
12233
12234
12235/*[clinic input]
12236os.removexattr
12237
12238 path: path_t(allow_fd=True)
12239 attribute: path_t
12240 *
12241 follow_symlinks: bool = True
12242
12243Remove extended attribute attribute on path.
12244
BNMetricsb9427072018-11-02 15:20:19 +000012245path may be either a string, a path-like object, or an open file descriptor.
Larry Hastings2f936352014-08-05 14:04:04 +100012246If follow_symlinks is False, and the last element of the path is a symbolic
12247 link, removexattr will modify the symbolic link itself instead of the file
12248 the link points to.
12249
12250[clinic start generated code]*/
12251
Larry Hastings2f936352014-08-05 14:04:04 +100012252static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012253os_removexattr_impl(PyObject *module, path_t *path, path_t *attribute,
Larry Hastings89964c42015-04-14 18:07:59 -040012254 int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +000012255/*[clinic end generated code: output=521a51817980cda6 input=3d9a7d36fe2f7c4e]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012256{
12257 ssize_t result;
12258
12259 if (fd_and_follow_symlinks_invalid("removexattr", path->fd, follow_symlinks))
12260 return NULL;
12261
Saiyang Gou7514f4f2020-02-12 23:47:42 -080012262 if (PySys_Audit("os.removexattr", "OO", path->object, attribute->object) < 0) {
12263 return NULL;
12264 }
12265
Larry Hastings2f936352014-08-05 14:04:04 +100012266 Py_BEGIN_ALLOW_THREADS;
12267 if (path->fd > -1)
12268 result = fremovexattr(path->fd, attribute->narrow);
12269 else if (follow_symlinks)
12270 result = removexattr(path->narrow, attribute->narrow);
12271 else
12272 result = lremovexattr(path->narrow, attribute->narrow);
12273 Py_END_ALLOW_THREADS;
12274
12275 if (result) {
12276 return path_error(path);
12277 }
12278
12279 Py_RETURN_NONE;
12280}
12281
12282
12283/*[clinic input]
12284os.listxattr
12285
12286 path: path_t(allow_fd=True, nullable=True) = None
12287 *
12288 follow_symlinks: bool = True
12289
12290Return a list of extended attributes on path.
12291
BNMetricsb9427072018-11-02 15:20:19 +000012292path may be either None, a string, a path-like object, or an open file descriptor.
Larry Hastings2f936352014-08-05 14:04:04 +100012293if path is None, listxattr will examine the current directory.
12294If follow_symlinks is False, and the last element of the path is a symbolic
12295 link, listxattr will examine the symbolic link itself instead of the file
12296 the link points to.
12297[clinic start generated code]*/
12298
Larry Hastings2f936352014-08-05 14:04:04 +100012299static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012300os_listxattr_impl(PyObject *module, path_t *path, int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +000012301/*[clinic end generated code: output=bebdb4e2ad0ce435 input=9826edf9fdb90869]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012302{
Larry Hastings9cf065c2012-06-22 16:30:09 -070012303 Py_ssize_t i;
12304 PyObject *result = NULL;
Larry Hastings2f936352014-08-05 14:04:04 +100012305 const char *name;
Larry Hastings9cf065c2012-06-22 16:30:09 -070012306 char *buffer = NULL;
Benjamin Peterson799bd802011-08-31 22:15:17 -040012307
Larry Hastings2f936352014-08-05 14:04:04 +100012308 if (fd_and_follow_symlinks_invalid("listxattr", path->fd, follow_symlinks))
Larry Hastings9cf065c2012-06-22 16:30:09 -070012309 goto exit;
Benjamin Peterson799bd802011-08-31 22:15:17 -040012310
Saiyang Gou7514f4f2020-02-12 23:47:42 -080012311 if (PySys_Audit("os.listxattr", "(O)",
12312 path->object ? path->object : Py_None) < 0) {
12313 return NULL;
12314 }
12315
Larry Hastings2f936352014-08-05 14:04:04 +100012316 name = path->narrow ? path->narrow : ".";
12317
Larry Hastings9cf065c2012-06-22 16:30:09 -070012318 for (i = 0; ; i++) {
Serhiy Storchakadeab18d2016-05-07 16:45:18 +030012319 const char *start, *trace, *end;
Larry Hastings9cf065c2012-06-22 16:30:09 -070012320 ssize_t length;
Serhiy Storchaka2d06e842015-12-25 19:53:18 +020012321 static const Py_ssize_t buffer_sizes[] = { 256, XATTR_LIST_MAX, 0 };
Larry Hastings9cf065c2012-06-22 16:30:09 -070012322 Py_ssize_t buffer_size = buffer_sizes[i];
12323 if (!buffer_size) {
Christian Heimes3b9493b2012-09-23 16:11:15 +020012324 /* ERANGE */
Larry Hastings2f936352014-08-05 14:04:04 +100012325 path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -070012326 break;
12327 }
12328 buffer = PyMem_MALLOC(buffer_size);
12329 if (!buffer) {
12330 PyErr_NoMemory();
12331 break;
12332 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040012333
Larry Hastings9cf065c2012-06-22 16:30:09 -070012334 Py_BEGIN_ALLOW_THREADS;
Larry Hastings2f936352014-08-05 14:04:04 +100012335 if (path->fd > -1)
12336 length = flistxattr(path->fd, buffer, buffer_size);
Larry Hastings9cf065c2012-06-22 16:30:09 -070012337 else if (follow_symlinks)
12338 length = listxattr(name, buffer, buffer_size);
12339 else
12340 length = llistxattr(name, buffer, buffer_size);
12341 Py_END_ALLOW_THREADS;
Benjamin Peterson799bd802011-08-31 22:15:17 -040012342
Larry Hastings9cf065c2012-06-22 16:30:09 -070012343 if (length < 0) {
Antoine Pitrou7f987392013-05-13 19:46:29 +020012344 if (errno == ERANGE) {
12345 PyMem_FREE(buffer);
Benjamin Petersondedac522013-05-13 19:55:40 -050012346 buffer = NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070012347 continue;
Antoine Pitrou7f987392013-05-13 19:46:29 +020012348 }
Larry Hastings2f936352014-08-05 14:04:04 +100012349 path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -070012350 break;
12351 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040012352
Larry Hastings9cf065c2012-06-22 16:30:09 -070012353 result = PyList_New(0);
12354 if (!result) {
12355 goto exit;
12356 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040012357
Larry Hastings9cf065c2012-06-22 16:30:09 -070012358 end = buffer + length;
12359 for (trace = start = buffer; trace != end; trace++) {
12360 if (!*trace) {
12361 int error;
12362 PyObject *attribute = PyUnicode_DecodeFSDefaultAndSize(start,
12363 trace - start);
12364 if (!attribute) {
12365 Py_DECREF(result);
12366 result = NULL;
12367 goto exit;
12368 }
12369 error = PyList_Append(result, attribute);
12370 Py_DECREF(attribute);
12371 if (error) {
12372 Py_DECREF(result);
12373 result = NULL;
12374 goto exit;
12375 }
12376 start = trace + 1;
12377 }
12378 }
12379 break;
12380 }
12381exit:
Larry Hastings9cf065c2012-06-22 16:30:09 -070012382 if (buffer)
12383 PyMem_FREE(buffer);
12384 return result;
Benjamin Peterson799bd802011-08-31 22:15:17 -040012385}
Benjamin Peterson9428d532011-09-14 11:45:52 -040012386#endif /* USE_XATTRS */
Benjamin Peterson799bd802011-08-31 22:15:17 -040012387
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012388
Larry Hastings2f936352014-08-05 14:04:04 +100012389/*[clinic input]
12390os.urandom
12391
12392 size: Py_ssize_t
12393 /
12394
12395Return a bytes object containing random bytes suitable for cryptographic use.
12396[clinic start generated code]*/
12397
Larry Hastings2f936352014-08-05 14:04:04 +100012398static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012399os_urandom_impl(PyObject *module, Py_ssize_t size)
12400/*[clinic end generated code: output=42c5cca9d18068e9 input=4067cdb1b6776c29]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012401{
12402 PyObject *bytes;
12403 int result;
12404
Georg Brandl2fb477c2012-02-21 00:33:36 +010012405 if (size < 0)
12406 return PyErr_Format(PyExc_ValueError,
12407 "negative argument not allowed");
Larry Hastings2f936352014-08-05 14:04:04 +100012408 bytes = PyBytes_FromStringAndSize(NULL, size);
12409 if (bytes == NULL)
Georg Brandl2fb477c2012-02-21 00:33:36 +010012410 return NULL;
12411
Victor Stinnere66987e2016-09-06 16:33:52 -070012412 result = _PyOS_URandom(PyBytes_AS_STRING(bytes), PyBytes_GET_SIZE(bytes));
Larry Hastings2f936352014-08-05 14:04:04 +100012413 if (result == -1) {
12414 Py_DECREF(bytes);
Georg Brandl2fb477c2012-02-21 00:33:36 +010012415 return NULL;
12416 }
Larry Hastings2f936352014-08-05 14:04:04 +100012417 return bytes;
Georg Brandl2fb477c2012-02-21 00:33:36 +010012418}
12419
Zackery Spytz43fdbd22019-05-29 13:57:07 -060012420#ifdef HAVE_MEMFD_CREATE
12421/*[clinic input]
12422os.memfd_create
12423
12424 name: FSConverter
12425 flags: unsigned_int(bitwise=True, c_default="MFD_CLOEXEC") = MFD_CLOEXEC
12426
12427[clinic start generated code]*/
12428
12429static PyObject *
12430os_memfd_create_impl(PyObject *module, PyObject *name, unsigned int flags)
12431/*[clinic end generated code: output=6681ede983bdb9a6 input=a42cfc199bcd56e9]*/
12432{
12433 int fd;
12434 const char *bytes = PyBytes_AS_STRING(name);
12435 Py_BEGIN_ALLOW_THREADS
12436 fd = memfd_create(bytes, flags);
12437 Py_END_ALLOW_THREADS
12438 if (fd == -1) {
12439 return PyErr_SetFromErrno(PyExc_OSError);
12440 }
12441 return PyLong_FromLong(fd);
12442}
12443#endif
12444
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012445/* Terminal size querying */
12446
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012447PyDoc_STRVAR(TerminalSize_docstring,
12448 "A tuple of (columns, lines) for holding terminal window size");
12449
12450static PyStructSequence_Field TerminalSize_fields[] = {
12451 {"columns", "width of the terminal window in characters"},
12452 {"lines", "height of the terminal window in characters"},
12453 {NULL, NULL}
12454};
12455
12456static PyStructSequence_Desc TerminalSize_desc = {
12457 "os.terminal_size",
12458 TerminalSize_docstring,
12459 TerminalSize_fields,
12460 2,
12461};
12462
12463#if defined(TERMSIZE_USE_CONIO) || defined(TERMSIZE_USE_IOCTL)
Serhiy Storchaka2b560312020-04-18 19:14:10 +030012464/*[clinic input]
12465os.get_terminal_size
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012466
Serhiy Storchaka2b560312020-04-18 19:14:10 +030012467 fd: int(c_default="fileno(stdout)", py_default="<unrepresentable>") = -1
12468 /
12469
12470Return the size of the terminal window as (columns, lines).
12471
12472The optional argument fd (default standard output) specifies
12473which file descriptor should be queried.
12474
12475If the file descriptor is not connected to a terminal, an OSError
12476is thrown.
12477
12478This function will only be defined if an implementation is
12479available for this system.
12480
12481shutil.get_terminal_size is the high-level function which should
12482normally be used, os.get_terminal_size is the low-level implementation.
12483[clinic start generated code]*/
12484
12485static PyObject *
12486os_get_terminal_size_impl(PyObject *module, int fd)
12487/*[clinic end generated code: output=fbab93acef980508 input=ead5679b82ddb920]*/
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012488{
12489 int columns, lines;
12490 PyObject *termsize;
12491
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012492 /* Under some conditions stdout may not be connected and
12493 * fileno(stdout) may point to an invalid file descriptor. For example
12494 * GUI apps don't have valid standard streams by default.
12495 *
12496 * If this happens, and the optional fd argument is not present,
12497 * the ioctl below will fail returning EBADF. This is what we want.
12498 */
12499
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012500#ifdef TERMSIZE_USE_IOCTL
12501 {
12502 struct winsize w;
12503 if (ioctl(fd, TIOCGWINSZ, &w))
12504 return PyErr_SetFromErrno(PyExc_OSError);
12505 columns = w.ws_col;
12506 lines = w.ws_row;
12507 }
12508#endif /* TERMSIZE_USE_IOCTL */
12509
12510#ifdef TERMSIZE_USE_CONIO
12511 {
12512 DWORD nhandle;
12513 HANDLE handle;
12514 CONSOLE_SCREEN_BUFFER_INFO csbi;
12515 switch (fd) {
12516 case 0: nhandle = STD_INPUT_HANDLE;
12517 break;
12518 case 1: nhandle = STD_OUTPUT_HANDLE;
12519 break;
12520 case 2: nhandle = STD_ERROR_HANDLE;
12521 break;
12522 default:
12523 return PyErr_Format(PyExc_ValueError, "bad file descriptor");
12524 }
12525 handle = GetStdHandle(nhandle);
12526 if (handle == NULL)
12527 return PyErr_Format(PyExc_OSError, "handle cannot be retrieved");
12528 if (handle == INVALID_HANDLE_VALUE)
12529 return PyErr_SetFromWindowsErr(0);
12530
12531 if (!GetConsoleScreenBufferInfo(handle, &csbi))
12532 return PyErr_SetFromWindowsErr(0);
12533
12534 columns = csbi.srWindow.Right - csbi.srWindow.Left + 1;
12535 lines = csbi.srWindow.Bottom - csbi.srWindow.Top + 1;
12536 }
12537#endif /* TERMSIZE_USE_CONIO */
12538
Serhiy Storchaka2b560312020-04-18 19:14:10 +030012539 PyObject *TerminalSizeType = get_posix_state(module)->TerminalSizeType;
Eddie Elizondob3966632019-11-05 07:16:14 -080012540 termsize = PyStructSequence_New((PyTypeObject *)TerminalSizeType);
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012541 if (termsize == NULL)
12542 return NULL;
12543 PyStructSequence_SET_ITEM(termsize, 0, PyLong_FromLong(columns));
12544 PyStructSequence_SET_ITEM(termsize, 1, PyLong_FromLong(lines));
12545 if (PyErr_Occurred()) {
12546 Py_DECREF(termsize);
12547 return NULL;
12548 }
12549 return termsize;
12550}
12551#endif /* defined(TERMSIZE_USE_CONIO) || defined(TERMSIZE_USE_IOCTL) */
12552
Larry Hastings2f936352014-08-05 14:04:04 +100012553
12554/*[clinic input]
12555os.cpu_count
12556
Charles-François Natali80d62e62015-08-13 20:37:08 +010012557Return the number of CPUs in the system; return None if indeterminable.
12558
12559This number is not equivalent to the number of CPUs the current process can
12560use. The number of usable CPUs can be obtained with
12561``len(os.sched_getaffinity(0))``
Larry Hastings2f936352014-08-05 14:04:04 +100012562[clinic start generated code]*/
12563
Larry Hastings2f936352014-08-05 14:04:04 +100012564static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012565os_cpu_count_impl(PyObject *module)
Serhiy Storchaka2954f832016-07-07 18:20:03 +030012566/*[clinic end generated code: output=5fc29463c3936a9c input=e7c8f4ba6dbbadd3]*/
Charles-Francois Natali44feda32013-05-20 14:40:46 +020012567{
Charles-Francois Natalid59087d2013-05-20 17:31:06 +020012568 int ncpu = 0;
Charles-Francois Natali44feda32013-05-20 14:40:46 +020012569#ifdef MS_WINDOWS
Steve Doweraa929272019-09-11 16:15:39 +010012570 ncpu = GetActiveProcessorCount(ALL_PROCESSOR_GROUPS);
Charles-Francois Natali44feda32013-05-20 14:40:46 +020012571#elif defined(__hpux)
12572 ncpu = mpctl(MPC_GETNUMSPUS, NULL, NULL);
12573#elif defined(HAVE_SYSCONF) && defined(_SC_NPROCESSORS_ONLN)
12574 ncpu = sysconf(_SC_NPROCESSORS_ONLN);
Charles-Francois Natali44feda32013-05-20 14:40:46 +020012575#elif defined(__DragonFly__) || \
12576 defined(__OpenBSD__) || \
12577 defined(__FreeBSD__) || \
Charles-Francois Natalid59087d2013-05-20 17:31:06 +020012578 defined(__NetBSD__) || \
12579 defined(__APPLE__)
Charles-Francois Natali7c4f8da2013-05-20 17:40:32 +020012580 int mib[2];
12581 size_t len = sizeof(ncpu);
12582 mib[0] = CTL_HW;
12583 mib[1] = HW_NCPU;
12584 if (sysctl(mib, 2, &ncpu, &len, NULL, 0) != 0)
12585 ncpu = 0;
Charles-Francois Natali44feda32013-05-20 14:40:46 +020012586#endif
12587 if (ncpu >= 1)
12588 return PyLong_FromLong(ncpu);
12589 else
12590 Py_RETURN_NONE;
12591}
12592
Victor Stinnerdaf45552013-08-28 00:53:59 +020012593
Larry Hastings2f936352014-08-05 14:04:04 +100012594/*[clinic input]
12595os.get_inheritable -> bool
12596
12597 fd: int
12598 /
12599
12600Get the close-on-exe flag of the specified file descriptor.
12601[clinic start generated code]*/
12602
Larry Hastings2f936352014-08-05 14:04:04 +100012603static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012604os_get_inheritable_impl(PyObject *module, int fd)
12605/*[clinic end generated code: output=0445e20e149aa5b8 input=89ac008dc9ab6b95]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012606{
Steve Dower8fc89802015-04-12 00:26:27 -040012607 int return_value;
Steve Dower8fc89802015-04-12 00:26:27 -040012608 _Py_BEGIN_SUPPRESS_IPH
12609 return_value = _Py_get_inheritable(fd);
12610 _Py_END_SUPPRESS_IPH
12611 return return_value;
Larry Hastings2f936352014-08-05 14:04:04 +100012612}
12613
12614
12615/*[clinic input]
12616os.set_inheritable
12617 fd: int
12618 inheritable: int
12619 /
12620
12621Set the inheritable flag of the specified file descriptor.
12622[clinic start generated code]*/
12623
Larry Hastings2f936352014-08-05 14:04:04 +100012624static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012625os_set_inheritable_impl(PyObject *module, int fd, int inheritable)
12626/*[clinic end generated code: output=f1b1918a2f3c38c2 input=9ceaead87a1e2402]*/
Victor Stinnerdaf45552013-08-28 00:53:59 +020012627{
Steve Dower8fc89802015-04-12 00:26:27 -040012628 int result;
Victor Stinnerdaf45552013-08-28 00:53:59 +020012629
Steve Dower8fc89802015-04-12 00:26:27 -040012630 _Py_BEGIN_SUPPRESS_IPH
12631 result = _Py_set_inheritable(fd, inheritable, NULL);
12632 _Py_END_SUPPRESS_IPH
12633 if (result < 0)
Victor Stinnerdaf45552013-08-28 00:53:59 +020012634 return NULL;
12635 Py_RETURN_NONE;
12636}
12637
12638
12639#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +100012640/*[clinic input]
12641os.get_handle_inheritable -> bool
Benjamin Petersonca470632016-09-06 13:47:26 -070012642 handle: intptr_t
Larry Hastings2f936352014-08-05 14:04:04 +100012643 /
Victor Stinnerdaf45552013-08-28 00:53:59 +020012644
Larry Hastings2f936352014-08-05 14:04:04 +100012645Get the close-on-exe flag of the specified file descriptor.
12646[clinic start generated code]*/
12647
Larry Hastings2f936352014-08-05 14:04:04 +100012648static int
Benjamin Petersonca470632016-09-06 13:47:26 -070012649os_get_handle_inheritable_impl(PyObject *module, intptr_t handle)
Victor Stinner581139c2016-09-06 15:54:20 -070012650/*[clinic end generated code: output=36be5afca6ea84d8 input=cfe99f9c05c70ad1]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012651{
12652 DWORD flags;
Victor Stinnerdaf45552013-08-28 00:53:59 +020012653
12654 if (!GetHandleInformation((HANDLE)handle, &flags)) {
12655 PyErr_SetFromWindowsErr(0);
Larry Hastings2f936352014-08-05 14:04:04 +100012656 return -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +020012657 }
12658
Larry Hastings2f936352014-08-05 14:04:04 +100012659 return flags & HANDLE_FLAG_INHERIT;
Victor Stinnerdaf45552013-08-28 00:53:59 +020012660}
12661
Victor Stinnerdaf45552013-08-28 00:53:59 +020012662
Larry Hastings2f936352014-08-05 14:04:04 +100012663/*[clinic input]
12664os.set_handle_inheritable
Benjamin Petersonca470632016-09-06 13:47:26 -070012665 handle: intptr_t
Larry Hastings2f936352014-08-05 14:04:04 +100012666 inheritable: bool
12667 /
12668
12669Set the inheritable flag of the specified handle.
12670[clinic start generated code]*/
12671
Larry Hastings2f936352014-08-05 14:04:04 +100012672static PyObject *
Benjamin Petersonca470632016-09-06 13:47:26 -070012673os_set_handle_inheritable_impl(PyObject *module, intptr_t handle,
Larry Hastings89964c42015-04-14 18:07:59 -040012674 int inheritable)
Victor Stinner581139c2016-09-06 15:54:20 -070012675/*[clinic end generated code: output=021d74fe6c96baa3 input=7a7641390d8364fc]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012676{
12677 DWORD flags = inheritable ? HANDLE_FLAG_INHERIT : 0;
Victor Stinnerdaf45552013-08-28 00:53:59 +020012678 if (!SetHandleInformation((HANDLE)handle, HANDLE_FLAG_INHERIT, flags)) {
12679 PyErr_SetFromWindowsErr(0);
12680 return NULL;
12681 }
12682 Py_RETURN_NONE;
12683}
Larry Hastings2f936352014-08-05 14:04:04 +100012684#endif /* MS_WINDOWS */
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012685
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012686#ifndef MS_WINDOWS
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030012687/*[clinic input]
12688os.get_blocking -> bool
12689 fd: int
12690 /
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012691
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030012692Get the blocking mode of the file descriptor.
12693
12694Return False if the O_NONBLOCK flag is set, True if the flag is cleared.
12695[clinic start generated code]*/
12696
12697static int
12698os_get_blocking_impl(PyObject *module, int fd)
12699/*[clinic end generated code: output=336a12ad76a61482 input=f4afb59d51560179]*/
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012700{
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012701 int blocking;
12702
Steve Dower8fc89802015-04-12 00:26:27 -040012703 _Py_BEGIN_SUPPRESS_IPH
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012704 blocking = _Py_get_blocking(fd);
Steve Dower8fc89802015-04-12 00:26:27 -040012705 _Py_END_SUPPRESS_IPH
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030012706 return blocking;
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012707}
12708
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030012709/*[clinic input]
12710os.set_blocking
12711 fd: int
12712 blocking: bool(accept={int})
12713 /
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012714
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030012715Set the blocking mode of the specified file descriptor.
12716
12717Set the O_NONBLOCK flag if blocking is False,
12718clear the O_NONBLOCK flag otherwise.
12719[clinic start generated code]*/
12720
12721static PyObject *
12722os_set_blocking_impl(PyObject *module, int fd, int blocking)
12723/*[clinic end generated code: output=384eb43aa0762a9d input=bf5c8efdc5860ff3]*/
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012724{
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030012725 int result;
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012726
Steve Dower8fc89802015-04-12 00:26:27 -040012727 _Py_BEGIN_SUPPRESS_IPH
12728 result = _Py_set_blocking(fd, blocking);
12729 _Py_END_SUPPRESS_IPH
12730 if (result < 0)
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012731 return NULL;
12732 Py_RETURN_NONE;
12733}
12734#endif /* !MS_WINDOWS */
12735
12736
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012737/*[clinic input]
Eddie Elizondob3966632019-11-05 07:16:14 -080012738class os.DirEntry "DirEntry *" "DirEntryType"
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012739[clinic start generated code]*/
Eddie Elizondob3966632019-11-05 07:16:14 -080012740/*[clinic end generated code: output=da39a3ee5e6b4b0d input=3c18c7a448247980]*/
Victor Stinner6036e442015-03-08 01:58:04 +010012741
12742typedef struct {
12743 PyObject_HEAD
12744 PyObject *name;
12745 PyObject *path;
12746 PyObject *stat;
12747 PyObject *lstat;
12748#ifdef MS_WINDOWS
12749 struct _Py_stat_struct win32_lstat;
Victor Stinner0f6d7332017-03-09 17:34:28 +010012750 uint64_t win32_file_index;
Victor Stinner6036e442015-03-08 01:58:04 +010012751 int got_file_index;
12752#else /* POSIX */
Victor Stinner35a97c02015-03-08 02:59:09 +010012753#ifdef HAVE_DIRENT_D_TYPE
Victor Stinner6036e442015-03-08 01:58:04 +010012754 unsigned char d_type;
Victor Stinner35a97c02015-03-08 02:59:09 +010012755#endif
Victor Stinner6036e442015-03-08 01:58:04 +010012756 ino_t d_ino;
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012757 int dir_fd;
Victor Stinner6036e442015-03-08 01:58:04 +010012758#endif
12759} DirEntry;
12760
Eddie Elizondob3966632019-11-05 07:16:14 -080012761static PyObject *
12762_disabled_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
12763{
12764 PyErr_Format(PyExc_TypeError,
12765 "cannot create '%.100s' instances", _PyType_Name(type));
12766 return NULL;
12767}
12768
Victor Stinner6036e442015-03-08 01:58:04 +010012769static void
12770DirEntry_dealloc(DirEntry *entry)
12771{
Eddie Elizondob3966632019-11-05 07:16:14 -080012772 PyTypeObject *tp = Py_TYPE(entry);
Victor Stinner6036e442015-03-08 01:58:04 +010012773 Py_XDECREF(entry->name);
12774 Py_XDECREF(entry->path);
12775 Py_XDECREF(entry->stat);
12776 Py_XDECREF(entry->lstat);
Eddie Elizondob3966632019-11-05 07:16:14 -080012777 freefunc free_func = PyType_GetSlot(tp, Py_tp_free);
12778 free_func(entry);
12779 Py_DECREF(tp);
Victor Stinner6036e442015-03-08 01:58:04 +010012780}
12781
12782/* Forward reference */
12783static int
Victor Stinner97f33c32020-05-14 18:05:58 +020012784DirEntry_test_mode(PyTypeObject *defining_class, DirEntry *self,
12785 int follow_symlinks, unsigned short mode_bits);
Victor Stinner6036e442015-03-08 01:58:04 +010012786
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012787/*[clinic input]
12788os.DirEntry.is_symlink -> bool
Victor Stinner97f33c32020-05-14 18:05:58 +020012789 defining_class: defining_class
12790 /
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012791
12792Return True if the entry is a symbolic link; cached per entry.
12793[clinic start generated code]*/
12794
Victor Stinner6036e442015-03-08 01:58:04 +010012795static int
Victor Stinner97f33c32020-05-14 18:05:58 +020012796os_DirEntry_is_symlink_impl(DirEntry *self, PyTypeObject *defining_class)
12797/*[clinic end generated code: output=293096d589b6d47c input=e9acc5ee4d511113]*/
Victor Stinner6036e442015-03-08 01:58:04 +010012798{
12799#ifdef MS_WINDOWS
12800 return (self->win32_lstat.st_mode & S_IFMT) == S_IFLNK;
Victor Stinner35a97c02015-03-08 02:59:09 +010012801#elif defined(HAVE_DIRENT_D_TYPE)
12802 /* POSIX */
Victor Stinner6036e442015-03-08 01:58:04 +010012803 if (self->d_type != DT_UNKNOWN)
12804 return self->d_type == DT_LNK;
12805 else
Victor Stinner97f33c32020-05-14 18:05:58 +020012806 return DirEntry_test_mode(defining_class, self, 0, S_IFLNK);
Victor Stinner35a97c02015-03-08 02:59:09 +010012807#else
12808 /* POSIX without d_type */
Victor Stinner97f33c32020-05-14 18:05:58 +020012809 return DirEntry_test_mode(defining_class, self, 0, S_IFLNK);
Victor Stinner6036e442015-03-08 01:58:04 +010012810#endif
12811}
12812
12813static PyObject *
Victor Stinner97f33c32020-05-14 18:05:58 +020012814DirEntry_fetch_stat(PyObject *module, DirEntry *self, int follow_symlinks)
Victor Stinner6036e442015-03-08 01:58:04 +010012815{
12816 int result;
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012817 STRUCT_STAT st;
12818 PyObject *ub;
Victor Stinner6036e442015-03-08 01:58:04 +010012819
12820#ifdef MS_WINDOWS
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012821 if (!PyUnicode_FSDecoder(self->path, &ub))
12822 return NULL;
12823 const wchar_t *path = PyUnicode_AsUnicode(ub);
Victor Stinner6036e442015-03-08 01:58:04 +010012824#else /* POSIX */
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012825 if (!PyUnicode_FSConverter(self->path, &ub))
12826 return NULL;
12827 const char *path = PyBytes_AS_STRING(ub);
12828 if (self->dir_fd != DEFAULT_DIR_FD) {
12829#ifdef HAVE_FSTATAT
12830 result = fstatat(self->dir_fd, path, &st,
12831 follow_symlinks ? 0 : AT_SYMLINK_NOFOLLOW);
12832#else
12833 PyErr_SetString(PyExc_NotImplementedError, "can't fetch stat");
12834 return NULL;
12835#endif /* HAVE_FSTATAT */
12836 }
12837 else
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012838#endif
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012839 {
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012840 if (follow_symlinks)
12841 result = STAT(path, &st);
12842 else
12843 result = LSTAT(path, &st);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012844 }
12845 Py_DECREF(ub);
Victor Stinner6036e442015-03-08 01:58:04 +010012846
12847 if (result != 0)
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012848 return path_object_error(self->path);
Victor Stinner6036e442015-03-08 01:58:04 +010012849
Victor Stinner97f33c32020-05-14 18:05:58 +020012850 return _pystat_fromstructstat(module, &st);
Victor Stinner6036e442015-03-08 01:58:04 +010012851}
12852
12853static PyObject *
Victor Stinner97f33c32020-05-14 18:05:58 +020012854DirEntry_get_lstat(PyTypeObject *defining_class, DirEntry *self)
Victor Stinner6036e442015-03-08 01:58:04 +010012855{
12856 if (!self->lstat) {
Victor Stinner97f33c32020-05-14 18:05:58 +020012857 PyObject *module = PyType_GetModule(defining_class);
Victor Stinner6036e442015-03-08 01:58:04 +010012858#ifdef MS_WINDOWS
Victor Stinner97f33c32020-05-14 18:05:58 +020012859 self->lstat = _pystat_fromstructstat(module, &self->win32_lstat);
Victor Stinner6036e442015-03-08 01:58:04 +010012860#else /* POSIX */
Victor Stinner97f33c32020-05-14 18:05:58 +020012861 self->lstat = DirEntry_fetch_stat(module, self, 0);
Victor Stinner6036e442015-03-08 01:58:04 +010012862#endif
12863 }
12864 Py_XINCREF(self->lstat);
12865 return self->lstat;
12866}
12867
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012868/*[clinic input]
12869os.DirEntry.stat
Victor Stinner97f33c32020-05-14 18:05:58 +020012870 defining_class: defining_class
12871 /
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012872 *
12873 follow_symlinks: bool = True
12874
12875Return stat_result object for the entry; cached per entry.
12876[clinic start generated code]*/
12877
Victor Stinner6036e442015-03-08 01:58:04 +010012878static PyObject *
Victor Stinner97f33c32020-05-14 18:05:58 +020012879os_DirEntry_stat_impl(DirEntry *self, PyTypeObject *defining_class,
12880 int follow_symlinks)
12881/*[clinic end generated code: output=23f803e19c3e780e input=e816273c4e67ee98]*/
Victor Stinner6036e442015-03-08 01:58:04 +010012882{
Victor Stinner97f33c32020-05-14 18:05:58 +020012883 if (!follow_symlinks) {
12884 return DirEntry_get_lstat(defining_class, self);
12885 }
Victor Stinner6036e442015-03-08 01:58:04 +010012886
12887 if (!self->stat) {
Victor Stinner97f33c32020-05-14 18:05:58 +020012888 int result = os_DirEntry_is_symlink_impl(self, defining_class);
12889 if (result == -1) {
Victor Stinner6036e442015-03-08 01:58:04 +010012890 return NULL;
Victor Stinner97f33c32020-05-14 18:05:58 +020012891 }
12892 if (result) {
12893 PyObject *module = PyType_GetModule(defining_class);
12894 self->stat = DirEntry_fetch_stat(module, self, 1);
12895 }
12896 else {
12897 self->stat = DirEntry_get_lstat(defining_class, self);
12898 }
Victor Stinner6036e442015-03-08 01:58:04 +010012899 }
12900
12901 Py_XINCREF(self->stat);
12902 return self->stat;
12903}
12904
Victor Stinner6036e442015-03-08 01:58:04 +010012905/* Set exception and return -1 on error, 0 for False, 1 for True */
12906static int
Victor Stinner97f33c32020-05-14 18:05:58 +020012907DirEntry_test_mode(PyTypeObject *defining_class, DirEntry *self,
12908 int follow_symlinks, unsigned short mode_bits)
Victor Stinner6036e442015-03-08 01:58:04 +010012909{
12910 PyObject *stat = NULL;
12911 PyObject *st_mode = NULL;
12912 long mode;
12913 int result;
Victor Stinner35a97c02015-03-08 02:59:09 +010012914#if defined(MS_WINDOWS) || defined(HAVE_DIRENT_D_TYPE)
Victor Stinner6036e442015-03-08 01:58:04 +010012915 int is_symlink;
12916 int need_stat;
Victor Stinner35a97c02015-03-08 02:59:09 +010012917#endif
Victor Stinner6036e442015-03-08 01:58:04 +010012918#ifdef MS_WINDOWS
12919 unsigned long dir_bits;
12920#endif
12921
12922#ifdef MS_WINDOWS
12923 is_symlink = (self->win32_lstat.st_mode & S_IFMT) == S_IFLNK;
12924 need_stat = follow_symlinks && is_symlink;
Victor Stinner35a97c02015-03-08 02:59:09 +010012925#elif defined(HAVE_DIRENT_D_TYPE)
Victor Stinner6036e442015-03-08 01:58:04 +010012926 is_symlink = self->d_type == DT_LNK;
12927 need_stat = self->d_type == DT_UNKNOWN || (follow_symlinks && is_symlink);
12928#endif
12929
Victor Stinner35a97c02015-03-08 02:59:09 +010012930#if defined(MS_WINDOWS) || defined(HAVE_DIRENT_D_TYPE)
Victor Stinner6036e442015-03-08 01:58:04 +010012931 if (need_stat) {
Victor Stinner35a97c02015-03-08 02:59:09 +010012932#endif
Victor Stinner97f33c32020-05-14 18:05:58 +020012933 stat = os_DirEntry_stat_impl(self, defining_class, follow_symlinks);
Victor Stinner6036e442015-03-08 01:58:04 +010012934 if (!stat) {
12935 if (PyErr_ExceptionMatches(PyExc_FileNotFoundError)) {
12936 /* If file doesn't exist (anymore), then return False
12937 (i.e., say it's not a file/directory) */
12938 PyErr_Clear();
12939 return 0;
12940 }
12941 goto error;
12942 }
Victor Stinner97f33c32020-05-14 18:05:58 +020012943 _posixstate* state = get_posix_state(PyType_GetModule(defining_class));
12944 st_mode = PyObject_GetAttr(stat, state->st_mode);
Victor Stinner6036e442015-03-08 01:58:04 +010012945 if (!st_mode)
12946 goto error;
12947
12948 mode = PyLong_AsLong(st_mode);
12949 if (mode == -1 && PyErr_Occurred())
12950 goto error;
12951 Py_CLEAR(st_mode);
12952 Py_CLEAR(stat);
12953 result = (mode & S_IFMT) == mode_bits;
Victor Stinner35a97c02015-03-08 02:59:09 +010012954#if defined(MS_WINDOWS) || defined(HAVE_DIRENT_D_TYPE)
Victor Stinner6036e442015-03-08 01:58:04 +010012955 }
12956 else if (is_symlink) {
12957 assert(mode_bits != S_IFLNK);
12958 result = 0;
12959 }
12960 else {
12961 assert(mode_bits == S_IFDIR || mode_bits == S_IFREG);
12962#ifdef MS_WINDOWS
12963 dir_bits = self->win32_lstat.st_file_attributes & FILE_ATTRIBUTE_DIRECTORY;
12964 if (mode_bits == S_IFDIR)
12965 result = dir_bits != 0;
12966 else
12967 result = dir_bits == 0;
12968#else /* POSIX */
12969 if (mode_bits == S_IFDIR)
12970 result = self->d_type == DT_DIR;
12971 else
12972 result = self->d_type == DT_REG;
12973#endif
12974 }
Victor Stinner35a97c02015-03-08 02:59:09 +010012975#endif
Victor Stinner6036e442015-03-08 01:58:04 +010012976
12977 return result;
12978
12979error:
12980 Py_XDECREF(st_mode);
12981 Py_XDECREF(stat);
12982 return -1;
12983}
12984
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012985/*[clinic input]
12986os.DirEntry.is_dir -> bool
Victor Stinner97f33c32020-05-14 18:05:58 +020012987 defining_class: defining_class
12988 /
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012989 *
12990 follow_symlinks: bool = True
Victor Stinner6036e442015-03-08 01:58:04 +010012991
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012992Return True if the entry is a directory; cached per entry.
12993[clinic start generated code]*/
12994
12995static int
Victor Stinner97f33c32020-05-14 18:05:58 +020012996os_DirEntry_is_dir_impl(DirEntry *self, PyTypeObject *defining_class,
12997 int follow_symlinks)
12998/*[clinic end generated code: output=0cd453b9c0987fdf input=1a4ffd6dec9920cb]*/
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012999{
Victor Stinner97f33c32020-05-14 18:05:58 +020013000 return DirEntry_test_mode(defining_class, self, follow_symlinks, S_IFDIR);
Victor Stinner6036e442015-03-08 01:58:04 +010013001}
13002
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013003/*[clinic input]
13004os.DirEntry.is_file -> bool
Victor Stinner97f33c32020-05-14 18:05:58 +020013005 defining_class: defining_class
13006 /
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013007 *
13008 follow_symlinks: bool = True
13009
13010Return True if the entry is a file; cached per entry.
13011[clinic start generated code]*/
13012
13013static int
Victor Stinner97f33c32020-05-14 18:05:58 +020013014os_DirEntry_is_file_impl(DirEntry *self, PyTypeObject *defining_class,
13015 int follow_symlinks)
13016/*[clinic end generated code: output=f7c277ab5ba80908 input=0a64c5a12e802e3b]*/
Victor Stinner6036e442015-03-08 01:58:04 +010013017{
Victor Stinner97f33c32020-05-14 18:05:58 +020013018 return DirEntry_test_mode(defining_class, self, follow_symlinks, S_IFREG);
Victor Stinner6036e442015-03-08 01:58:04 +010013019}
13020
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013021/*[clinic input]
13022os.DirEntry.inode
Victor Stinner6036e442015-03-08 01:58:04 +010013023
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013024Return inode of the entry; cached per entry.
13025[clinic start generated code]*/
Victor Stinner6036e442015-03-08 01:58:04 +010013026
13027static PyObject *
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013028os_DirEntry_inode_impl(DirEntry *self)
13029/*[clinic end generated code: output=156bb3a72162440e input=3ee7b872ae8649f0]*/
Victor Stinner6036e442015-03-08 01:58:04 +010013030{
13031#ifdef MS_WINDOWS
13032 if (!self->got_file_index) {
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030013033 PyObject *unicode;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +030013034 const wchar_t *path;
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030013035 STRUCT_STAT stat;
13036 int result;
Victor Stinner6036e442015-03-08 01:58:04 +010013037
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030013038 if (!PyUnicode_FSDecoder(self->path, &unicode))
Victor Stinner6036e442015-03-08 01:58:04 +010013039 return NULL;
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030013040 path = PyUnicode_AsUnicode(unicode);
13041 result = LSTAT(path, &stat);
13042 Py_DECREF(unicode);
Victor Stinner6036e442015-03-08 01:58:04 +010013043
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030013044 if (result != 0)
13045 return path_object_error(self->path);
Victor Stinner6036e442015-03-08 01:58:04 +010013046
13047 self->win32_file_index = stat.st_ino;
13048 self->got_file_index = 1;
13049 }
Victor Stinner0f6d7332017-03-09 17:34:28 +010013050 Py_BUILD_ASSERT(sizeof(unsigned long long) >= sizeof(self->win32_file_index));
13051 return PyLong_FromUnsignedLongLong(self->win32_file_index);
Victor Stinner6036e442015-03-08 01:58:04 +010013052#else /* POSIX */
xdegaye50e86032017-05-22 11:15:08 +020013053 Py_BUILD_ASSERT(sizeof(unsigned long long) >= sizeof(self->d_ino));
13054 return PyLong_FromUnsignedLongLong(self->d_ino);
Victor Stinner6036e442015-03-08 01:58:04 +010013055#endif
13056}
13057
13058static PyObject *
13059DirEntry_repr(DirEntry *self)
13060{
13061 return PyUnicode_FromFormat("<DirEntry %R>", self->name);
13062}
13063
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013064/*[clinic input]
13065os.DirEntry.__fspath__
13066
13067Returns the path for the entry.
13068[clinic start generated code]*/
13069
Brett Cannon96881cd2016-06-10 14:37:21 -070013070static PyObject *
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013071os_DirEntry___fspath___impl(DirEntry *self)
13072/*[clinic end generated code: output=6dd7f7ef752e6f4f input=3c49d0cf38df4fac]*/
Brett Cannon96881cd2016-06-10 14:37:21 -070013073{
13074 Py_INCREF(self->path);
13075 return self->path;
13076}
13077
Victor Stinner6036e442015-03-08 01:58:04 +010013078static PyMemberDef DirEntry_members[] = {
13079 {"name", T_OBJECT_EX, offsetof(DirEntry, name), READONLY,
13080 "the entry's base filename, relative to scandir() \"path\" argument"},
13081 {"path", T_OBJECT_EX, offsetof(DirEntry, path), READONLY,
13082 "the entry's full path name; equivalent to os.path.join(scandir_path, entry.name)"},
13083 {NULL}
13084};
13085
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013086#include "clinic/posixmodule.c.h"
13087
Victor Stinner6036e442015-03-08 01:58:04 +010013088static PyMethodDef DirEntry_methods[] = {
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013089 OS_DIRENTRY_IS_DIR_METHODDEF
13090 OS_DIRENTRY_IS_FILE_METHODDEF
13091 OS_DIRENTRY_IS_SYMLINK_METHODDEF
13092 OS_DIRENTRY_STAT_METHODDEF
13093 OS_DIRENTRY_INODE_METHODDEF
13094 OS_DIRENTRY___FSPATH___METHODDEF
Batuhan Taşkayaf9dd51e2020-04-08 00:37:19 +030013095 {"__class_getitem__", (PyCFunction)Py_GenericAlias,
13096 METH_O|METH_CLASS, PyDoc_STR("See PEP 585")},
Victor Stinner6036e442015-03-08 01:58:04 +010013097 {NULL}
13098};
13099
Eddie Elizondob3966632019-11-05 07:16:14 -080013100static PyType_Slot DirEntryType_slots[] = {
13101 {Py_tp_new, _disabled_new},
13102 {Py_tp_dealloc, DirEntry_dealloc},
13103 {Py_tp_repr, DirEntry_repr},
13104 {Py_tp_methods, DirEntry_methods},
13105 {Py_tp_members, DirEntry_members},
13106 {0, 0},
Victor Stinner6036e442015-03-08 01:58:04 +010013107};
13108
Eddie Elizondob3966632019-11-05 07:16:14 -080013109static PyType_Spec DirEntryType_spec = {
13110 MODNAME ".DirEntry",
13111 sizeof(DirEntry),
13112 0,
13113 Py_TPFLAGS_DEFAULT,
13114 DirEntryType_slots
13115};
13116
13117
Victor Stinner6036e442015-03-08 01:58:04 +010013118#ifdef MS_WINDOWS
13119
13120static wchar_t *
Serhiy Storchakadeab18d2016-05-07 16:45:18 +030013121join_path_filenameW(const wchar_t *path_wide, const wchar_t *filename)
Victor Stinner6036e442015-03-08 01:58:04 +010013122{
13123 Py_ssize_t path_len;
13124 Py_ssize_t size;
13125 wchar_t *result;
13126 wchar_t ch;
13127
13128 if (!path_wide) { /* Default arg: "." */
13129 path_wide = L".";
13130 path_len = 1;
13131 }
13132 else {
13133 path_len = wcslen(path_wide);
13134 }
13135
13136 /* The +1's are for the path separator and the NUL */
13137 size = path_len + 1 + wcslen(filename) + 1;
13138 result = PyMem_New(wchar_t, size);
13139 if (!result) {
13140 PyErr_NoMemory();
13141 return NULL;
13142 }
13143 wcscpy(result, path_wide);
13144 if (path_len > 0) {
13145 ch = result[path_len - 1];
13146 if (ch != SEP && ch != ALTSEP && ch != L':')
13147 result[path_len++] = SEP;
13148 wcscpy(result + path_len, filename);
13149 }
13150 return result;
13151}
13152
13153static PyObject *
Victor Stinner1c2fa782020-05-10 11:05:29 +020013154DirEntry_from_find_data(PyObject *module, path_t *path, WIN32_FIND_DATAW *dataW)
Victor Stinner6036e442015-03-08 01:58:04 +010013155{
13156 DirEntry *entry;
13157 BY_HANDLE_FILE_INFORMATION file_info;
13158 ULONG reparse_tag;
13159 wchar_t *joined_path;
13160
Victor Stinner1c2fa782020-05-10 11:05:29 +020013161 PyObject *DirEntryType = get_posix_state(module)->DirEntryType;
Eddie Elizondob3966632019-11-05 07:16:14 -080013162 entry = PyObject_New(DirEntry, (PyTypeObject *)DirEntryType);
Victor Stinner6036e442015-03-08 01:58:04 +010013163 if (!entry)
13164 return NULL;
13165 entry->name = NULL;
13166 entry->path = NULL;
13167 entry->stat = NULL;
13168 entry->lstat = NULL;
13169 entry->got_file_index = 0;
13170
13171 entry->name = PyUnicode_FromWideChar(dataW->cFileName, -1);
13172 if (!entry->name)
13173 goto error;
Steve Dowercc16be82016-09-08 10:35:16 -070013174 if (path->narrow) {
13175 Py_SETREF(entry->name, PyUnicode_EncodeFSDefault(entry->name));
13176 if (!entry->name)
13177 goto error;
13178 }
Victor Stinner6036e442015-03-08 01:58:04 +010013179
13180 joined_path = join_path_filenameW(path->wide, dataW->cFileName);
13181 if (!joined_path)
13182 goto error;
13183
13184 entry->path = PyUnicode_FromWideChar(joined_path, -1);
13185 PyMem_Free(joined_path);
13186 if (!entry->path)
13187 goto error;
Steve Dowercc16be82016-09-08 10:35:16 -070013188 if (path->narrow) {
13189 Py_SETREF(entry->path, PyUnicode_EncodeFSDefault(entry->path));
13190 if (!entry->path)
13191 goto error;
13192 }
Victor Stinner6036e442015-03-08 01:58:04 +010013193
Steve Dowercc16be82016-09-08 10:35:16 -070013194 find_data_to_file_info(dataW, &file_info, &reparse_tag);
Victor Stinner6036e442015-03-08 01:58:04 +010013195 _Py_attribute_data_to_stat(&file_info, reparse_tag, &entry->win32_lstat);
13196
13197 return (PyObject *)entry;
13198
13199error:
13200 Py_DECREF(entry);
13201 return NULL;
13202}
13203
13204#else /* POSIX */
13205
13206static char *
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020013207join_path_filename(const char *path_narrow, const char* filename, Py_ssize_t filename_len)
Victor Stinner6036e442015-03-08 01:58:04 +010013208{
13209 Py_ssize_t path_len;
13210 Py_ssize_t size;
13211 char *result;
13212
13213 if (!path_narrow) { /* Default arg: "." */
13214 path_narrow = ".";
13215 path_len = 1;
13216 }
13217 else {
13218 path_len = strlen(path_narrow);
13219 }
13220
13221 if (filename_len == -1)
13222 filename_len = strlen(filename);
13223
13224 /* The +1's are for the path separator and the NUL */
13225 size = path_len + 1 + filename_len + 1;
13226 result = PyMem_New(char, size);
13227 if (!result) {
13228 PyErr_NoMemory();
13229 return NULL;
13230 }
13231 strcpy(result, path_narrow);
13232 if (path_len > 0 && result[path_len - 1] != '/')
13233 result[path_len++] = '/';
13234 strcpy(result + path_len, filename);
13235 return result;
13236}
13237
13238static PyObject *
Victor Stinner1c2fa782020-05-10 11:05:29 +020013239DirEntry_from_posix_info(PyObject *module, path_t *path, const char *name,
13240 Py_ssize_t name_len, ino_t d_ino
Victor Stinner35a97c02015-03-08 02:59:09 +010013241#ifdef HAVE_DIRENT_D_TYPE
13242 , unsigned char d_type
13243#endif
13244 )
Victor Stinner6036e442015-03-08 01:58:04 +010013245{
13246 DirEntry *entry;
13247 char *joined_path;
13248
Victor Stinner1c2fa782020-05-10 11:05:29 +020013249 PyObject *DirEntryType = get_posix_state(module)->DirEntryType;
Eddie Elizondob3966632019-11-05 07:16:14 -080013250 entry = PyObject_New(DirEntry, (PyTypeObject *)DirEntryType);
Victor Stinner6036e442015-03-08 01:58:04 +010013251 if (!entry)
13252 return NULL;
13253 entry->name = NULL;
13254 entry->path = NULL;
13255 entry->stat = NULL;
13256 entry->lstat = NULL;
13257
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013258 if (path->fd != -1) {
13259 entry->dir_fd = path->fd;
13260 joined_path = NULL;
13261 }
13262 else {
13263 entry->dir_fd = DEFAULT_DIR_FD;
13264 joined_path = join_path_filename(path->narrow, name, name_len);
13265 if (!joined_path)
13266 goto error;
13267 }
Victor Stinner6036e442015-03-08 01:58:04 +010013268
Serhiy Storchaka1180e5a2017-07-11 06:36:46 +030013269 if (!path->narrow || !PyObject_CheckBuffer(path->object)) {
Victor Stinner6036e442015-03-08 01:58:04 +010013270 entry->name = PyUnicode_DecodeFSDefaultAndSize(name, name_len);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013271 if (joined_path)
13272 entry->path = PyUnicode_DecodeFSDefault(joined_path);
Victor Stinner6036e442015-03-08 01:58:04 +010013273 }
13274 else {
13275 entry->name = PyBytes_FromStringAndSize(name, name_len);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013276 if (joined_path)
13277 entry->path = PyBytes_FromString(joined_path);
Victor Stinner6036e442015-03-08 01:58:04 +010013278 }
13279 PyMem_Free(joined_path);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013280 if (!entry->name)
13281 goto error;
13282
13283 if (path->fd != -1) {
13284 entry->path = entry->name;
13285 Py_INCREF(entry->path);
13286 }
13287 else if (!entry->path)
Victor Stinner6036e442015-03-08 01:58:04 +010013288 goto error;
13289
Victor Stinner35a97c02015-03-08 02:59:09 +010013290#ifdef HAVE_DIRENT_D_TYPE
Victor Stinner6036e442015-03-08 01:58:04 +010013291 entry->d_type = d_type;
Victor Stinner35a97c02015-03-08 02:59:09 +010013292#endif
Victor Stinner6036e442015-03-08 01:58:04 +010013293 entry->d_ino = d_ino;
13294
13295 return (PyObject *)entry;
13296
13297error:
13298 Py_XDECREF(entry);
13299 return NULL;
13300}
13301
13302#endif
13303
13304
13305typedef struct {
13306 PyObject_HEAD
13307 path_t path;
13308#ifdef MS_WINDOWS
13309 HANDLE handle;
13310 WIN32_FIND_DATAW file_data;
13311 int first_time;
13312#else /* POSIX */
13313 DIR *dirp;
13314#endif
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013315#ifdef HAVE_FDOPENDIR
13316 int fd;
13317#endif
Victor Stinner6036e442015-03-08 01:58:04 +010013318} ScandirIterator;
13319
13320#ifdef MS_WINDOWS
13321
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013322static int
13323ScandirIterator_is_closed(ScandirIterator *iterator)
13324{
13325 return iterator->handle == INVALID_HANDLE_VALUE;
13326}
13327
Victor Stinner6036e442015-03-08 01:58:04 +010013328static void
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013329ScandirIterator_closedir(ScandirIterator *iterator)
Victor Stinner6036e442015-03-08 01:58:04 +010013330{
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030013331 HANDLE handle = iterator->handle;
13332
13333 if (handle == INVALID_HANDLE_VALUE)
Victor Stinner6036e442015-03-08 01:58:04 +010013334 return;
13335
Victor Stinner6036e442015-03-08 01:58:04 +010013336 iterator->handle = INVALID_HANDLE_VALUE;
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030013337 Py_BEGIN_ALLOW_THREADS
13338 FindClose(handle);
13339 Py_END_ALLOW_THREADS
Victor Stinner6036e442015-03-08 01:58:04 +010013340}
13341
13342static PyObject *
13343ScandirIterator_iternext(ScandirIterator *iterator)
13344{
13345 WIN32_FIND_DATAW *file_data = &iterator->file_data;
13346 BOOL success;
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013347 PyObject *entry;
Victor Stinner6036e442015-03-08 01:58:04 +010013348
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013349 /* Happens if the iterator is iterated twice, or closed explicitly */
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013350 if (iterator->handle == INVALID_HANDLE_VALUE)
Victor Stinner6036e442015-03-08 01:58:04 +010013351 return NULL;
Victor Stinner6036e442015-03-08 01:58:04 +010013352
13353 while (1) {
13354 if (!iterator->first_time) {
13355 Py_BEGIN_ALLOW_THREADS
13356 success = FindNextFileW(iterator->handle, file_data);
13357 Py_END_ALLOW_THREADS
13358 if (!success) {
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013359 /* Error or no more files */
Victor Stinner6036e442015-03-08 01:58:04 +010013360 if (GetLastError() != ERROR_NO_MORE_FILES)
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013361 path_error(&iterator->path);
Victor Stinner6036e442015-03-08 01:58:04 +010013362 break;
13363 }
13364 }
13365 iterator->first_time = 0;
13366
13367 /* Skip over . and .. */
13368 if (wcscmp(file_data->cFileName, L".") != 0 &&
Victor Stinner1c2fa782020-05-10 11:05:29 +020013369 wcscmp(file_data->cFileName, L"..") != 0)
13370 {
13371 PyObject *module = PyType_GetModule(Py_TYPE(iterator));
13372 entry = DirEntry_from_find_data(module, &iterator->path, file_data);
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013373 if (!entry)
13374 break;
13375 return entry;
13376 }
Victor Stinner6036e442015-03-08 01:58:04 +010013377
13378 /* Loop till we get a non-dot directory or finish iterating */
13379 }
13380
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013381 /* Error or no more files */
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013382 ScandirIterator_closedir(iterator);
Victor Stinner6036e442015-03-08 01:58:04 +010013383 return NULL;
13384}
13385
13386#else /* POSIX */
13387
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013388static int
13389ScandirIterator_is_closed(ScandirIterator *iterator)
13390{
13391 return !iterator->dirp;
13392}
13393
Victor Stinner6036e442015-03-08 01:58:04 +010013394static void
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013395ScandirIterator_closedir(ScandirIterator *iterator)
Victor Stinner6036e442015-03-08 01:58:04 +010013396{
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030013397 DIR *dirp = iterator->dirp;
13398
13399 if (!dirp)
Victor Stinner6036e442015-03-08 01:58:04 +010013400 return;
13401
Victor Stinner6036e442015-03-08 01:58:04 +010013402 iterator->dirp = NULL;
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030013403 Py_BEGIN_ALLOW_THREADS
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013404#ifdef HAVE_FDOPENDIR
13405 if (iterator->path.fd != -1)
13406 rewinddir(dirp);
13407#endif
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030013408 closedir(dirp);
13409 Py_END_ALLOW_THREADS
Victor Stinner6036e442015-03-08 01:58:04 +010013410 return;
13411}
13412
13413static PyObject *
13414ScandirIterator_iternext(ScandirIterator *iterator)
13415{
13416 struct dirent *direntp;
13417 Py_ssize_t name_len;
13418 int is_dot;
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013419 PyObject *entry;
Victor Stinner6036e442015-03-08 01:58:04 +010013420
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013421 /* Happens if the iterator is iterated twice, or closed explicitly */
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013422 if (!iterator->dirp)
Victor Stinner6036e442015-03-08 01:58:04 +010013423 return NULL;
Victor Stinner6036e442015-03-08 01:58:04 +010013424
13425 while (1) {
13426 errno = 0;
13427 Py_BEGIN_ALLOW_THREADS
13428 direntp = readdir(iterator->dirp);
13429 Py_END_ALLOW_THREADS
13430
13431 if (!direntp) {
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013432 /* Error or no more files */
Victor Stinner6036e442015-03-08 01:58:04 +010013433 if (errno != 0)
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013434 path_error(&iterator->path);
Victor Stinner6036e442015-03-08 01:58:04 +010013435 break;
13436 }
13437
13438 /* Skip over . and .. */
13439 name_len = NAMLEN(direntp);
13440 is_dot = direntp->d_name[0] == '.' &&
13441 (name_len == 1 || (direntp->d_name[1] == '.' && name_len == 2));
13442 if (!is_dot) {
Victor Stinner1c2fa782020-05-10 11:05:29 +020013443 PyObject *module = PyType_GetModule(Py_TYPE(iterator));
13444 entry = DirEntry_from_posix_info(module,
13445 &iterator->path, direntp->d_name,
13446 name_len, direntp->d_ino
Victor Stinner35a97c02015-03-08 02:59:09 +010013447#ifdef HAVE_DIRENT_D_TYPE
Victor Stinner1c2fa782020-05-10 11:05:29 +020013448 , direntp->d_type
Victor Stinner35a97c02015-03-08 02:59:09 +010013449#endif
13450 );
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013451 if (!entry)
13452 break;
13453 return entry;
Victor Stinner6036e442015-03-08 01:58:04 +010013454 }
13455
13456 /* Loop till we get a non-dot directory or finish iterating */
13457 }
13458
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013459 /* Error or no more files */
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013460 ScandirIterator_closedir(iterator);
Victor Stinner6036e442015-03-08 01:58:04 +010013461 return NULL;
13462}
13463
13464#endif
13465
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013466static PyObject *
13467ScandirIterator_close(ScandirIterator *self, PyObject *args)
13468{
13469 ScandirIterator_closedir(self);
13470 Py_RETURN_NONE;
13471}
13472
13473static PyObject *
13474ScandirIterator_enter(PyObject *self, PyObject *args)
13475{
13476 Py_INCREF(self);
13477 return self;
13478}
13479
13480static PyObject *
13481ScandirIterator_exit(ScandirIterator *self, PyObject *args)
13482{
13483 ScandirIterator_closedir(self);
13484 Py_RETURN_NONE;
13485}
13486
Victor Stinner6036e442015-03-08 01:58:04 +010013487static void
Victor Stinner7bfa4092016-03-23 00:43:54 +010013488ScandirIterator_finalize(ScandirIterator *iterator)
13489{
13490 PyObject *error_type, *error_value, *error_traceback;
13491
13492 /* Save the current exception, if any. */
13493 PyErr_Fetch(&error_type, &error_value, &error_traceback);
13494
13495 if (!ScandirIterator_is_closed(iterator)) {
13496 ScandirIterator_closedir(iterator);
13497
13498 if (PyErr_ResourceWarning((PyObject *)iterator, 1,
13499 "unclosed scandir iterator %R", iterator)) {
13500 /* Spurious errors can appear at shutdown */
13501 if (PyErr_ExceptionMatches(PyExc_Warning)) {
13502 PyErr_WriteUnraisable((PyObject *) iterator);
13503 }
13504 }
13505 }
13506
Victor Stinner7bfa4092016-03-23 00:43:54 +010013507 path_cleanup(&iterator->path);
13508
13509 /* Restore the saved exception. */
13510 PyErr_Restore(error_type, error_value, error_traceback);
13511}
13512
13513static void
Victor Stinner6036e442015-03-08 01:58:04 +010013514ScandirIterator_dealloc(ScandirIterator *iterator)
13515{
Eddie Elizondob3966632019-11-05 07:16:14 -080013516 PyTypeObject *tp = Py_TYPE(iterator);
Victor Stinner7bfa4092016-03-23 00:43:54 +010013517 if (PyObject_CallFinalizerFromDealloc((PyObject *)iterator) < 0)
13518 return;
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013519
Eddie Elizondob3966632019-11-05 07:16:14 -080013520 freefunc free_func = PyType_GetSlot(tp, Py_tp_free);
13521 free_func(iterator);
13522 Py_DECREF(tp);
Victor Stinner6036e442015-03-08 01:58:04 +010013523}
13524
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013525static PyMethodDef ScandirIterator_methods[] = {
13526 {"__enter__", (PyCFunction)ScandirIterator_enter, METH_NOARGS},
13527 {"__exit__", (PyCFunction)ScandirIterator_exit, METH_VARARGS},
13528 {"close", (PyCFunction)ScandirIterator_close, METH_NOARGS},
13529 {NULL}
13530};
13531
Eddie Elizondob3966632019-11-05 07:16:14 -080013532static PyType_Slot ScandirIteratorType_slots[] = {
13533 {Py_tp_new, _disabled_new},
13534 {Py_tp_dealloc, ScandirIterator_dealloc},
13535 {Py_tp_finalize, ScandirIterator_finalize},
13536 {Py_tp_iter, PyObject_SelfIter},
13537 {Py_tp_iternext, ScandirIterator_iternext},
13538 {Py_tp_methods, ScandirIterator_methods},
13539 {0, 0},
13540};
13541
13542static PyType_Spec ScandirIteratorType_spec = {
13543 MODNAME ".ScandirIterator",
13544 sizeof(ScandirIterator),
13545 0,
Victor Stinner97f33c32020-05-14 18:05:58 +020013546 // bpo-40549: Py_TPFLAGS_BASETYPE should not be used, since
13547 // PyType_GetModule(Py_TYPE(self)) doesn't work on a subclass instance.
Eddie Elizondob3966632019-11-05 07:16:14 -080013548 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_FINALIZE,
13549 ScandirIteratorType_slots
Victor Stinner6036e442015-03-08 01:58:04 +010013550};
13551
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013552/*[clinic input]
13553os.scandir
13554
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013555 path : path_t(nullable=True, allow_fd='PATH_HAVE_FDOPENDIR') = None
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013556
13557Return an iterator of DirEntry objects for given path.
13558
BNMetricsb9427072018-11-02 15:20:19 +000013559path can be specified as either str, bytes, or a path-like object. If path
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013560is bytes, the names of yielded DirEntry objects will also be bytes; in
13561all other circumstances they will be str.
13562
13563If path is None, uses the path='.'.
13564[clinic start generated code]*/
13565
Victor Stinner6036e442015-03-08 01:58:04 +010013566static PyObject *
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013567os_scandir_impl(PyObject *module, path_t *path)
BNMetricsb9427072018-11-02 15:20:19 +000013568/*[clinic end generated code: output=6eb2668b675ca89e input=6bdd312708fc3bb0]*/
Victor Stinner6036e442015-03-08 01:58:04 +010013569{
13570 ScandirIterator *iterator;
Victor Stinner6036e442015-03-08 01:58:04 +010013571#ifdef MS_WINDOWS
13572 wchar_t *path_strW;
13573#else
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013574 const char *path_str;
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013575#ifdef HAVE_FDOPENDIR
13576 int fd = -1;
13577#endif
Victor Stinner6036e442015-03-08 01:58:04 +010013578#endif
13579
Steve Dower60419a72019-06-24 08:42:54 -070013580 if (PySys_Audit("os.scandir", "O",
13581 path->object ? path->object : Py_None) < 0) {
13582 return NULL;
13583 }
13584
Hai Shif707d942020-03-16 21:15:01 +080013585 PyObject *ScandirIteratorType = get_posix_state(module)->ScandirIteratorType;
Eddie Elizondob3966632019-11-05 07:16:14 -080013586 iterator = PyObject_New(ScandirIterator, (PyTypeObject *)ScandirIteratorType);
Victor Stinner6036e442015-03-08 01:58:04 +010013587 if (!iterator)
13588 return NULL;
Victor Stinner6036e442015-03-08 01:58:04 +010013589
13590#ifdef MS_WINDOWS
13591 iterator->handle = INVALID_HANDLE_VALUE;
13592#else
13593 iterator->dirp = NULL;
13594#endif
13595
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013596 memcpy(&iterator->path, path, sizeof(path_t));
Serhiy Storchaka095ef732017-02-09 20:05:51 +020013597 /* Move the ownership to iterator->path */
13598 path->object = NULL;
13599 path->cleanup = NULL;
Victor Stinner6036e442015-03-08 01:58:04 +010013600
13601#ifdef MS_WINDOWS
Victor Stinner6036e442015-03-08 01:58:04 +010013602 iterator->first_time = 1;
13603
13604 path_strW = join_path_filenameW(iterator->path.wide, L"*.*");
13605 if (!path_strW)
13606 goto error;
13607
13608 Py_BEGIN_ALLOW_THREADS
13609 iterator->handle = FindFirstFileW(path_strW, &iterator->file_data);
13610 Py_END_ALLOW_THREADS
13611
13612 PyMem_Free(path_strW);
13613
13614 if (iterator->handle == INVALID_HANDLE_VALUE) {
13615 path_error(&iterator->path);
13616 goto error;
13617 }
13618#else /* POSIX */
Victor Stinner6036e442015-03-08 01:58:04 +010013619 errno = 0;
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013620#ifdef HAVE_FDOPENDIR
13621 if (path->fd != -1) {
13622 /* closedir() closes the FD, so we duplicate it */
13623 fd = _Py_dup(path->fd);
13624 if (fd == -1)
13625 goto error;
13626
13627 Py_BEGIN_ALLOW_THREADS
13628 iterator->dirp = fdopendir(fd);
13629 Py_END_ALLOW_THREADS
13630 }
13631 else
13632#endif
13633 {
13634 if (iterator->path.narrow)
13635 path_str = iterator->path.narrow;
13636 else
13637 path_str = ".";
13638
13639 Py_BEGIN_ALLOW_THREADS
13640 iterator->dirp = opendir(path_str);
13641 Py_END_ALLOW_THREADS
13642 }
Victor Stinner6036e442015-03-08 01:58:04 +010013643
13644 if (!iterator->dirp) {
13645 path_error(&iterator->path);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013646#ifdef HAVE_FDOPENDIR
13647 if (fd != -1) {
13648 Py_BEGIN_ALLOW_THREADS
13649 close(fd);
13650 Py_END_ALLOW_THREADS
13651 }
13652#endif
Victor Stinner6036e442015-03-08 01:58:04 +010013653 goto error;
13654 }
13655#endif
13656
13657 return (PyObject *)iterator;
13658
13659error:
13660 Py_DECREF(iterator);
13661 return NULL;
13662}
13663
Ethan Furman410ef8e2016-06-04 12:06:26 -070013664/*
13665 Return the file system path representation of the object.
13666
13667 If the object is str or bytes, then allow it to pass through with
13668 an incremented refcount. If the object defines __fspath__(), then
13669 return the result of that method. All other types raise a TypeError.
13670*/
13671PyObject *
13672PyOS_FSPath(PyObject *path)
13673{
Brett Cannon3f9183b2016-08-26 14:44:48 -070013674 /* For error message reasons, this function is manually inlined in
13675 path_converter(). */
Ethan Furman410ef8e2016-06-04 12:06:26 -070013676 PyObject *func = NULL;
13677 PyObject *path_repr = NULL;
13678
13679 if (PyUnicode_Check(path) || PyBytes_Check(path)) {
13680 Py_INCREF(path);
13681 return path;
13682 }
13683
13684 func = _PyObject_LookupSpecial(path, &PyId___fspath__);
13685 if (NULL == func) {
13686 return PyErr_Format(PyExc_TypeError,
13687 "expected str, bytes or os.PathLike object, "
Brett Cannonc78ca1e2016-06-24 12:03:43 -070013688 "not %.200s",
Eddie Elizondob3966632019-11-05 07:16:14 -080013689 _PyType_Name(Py_TYPE(path)));
Ethan Furman410ef8e2016-06-04 12:06:26 -070013690 }
13691
Victor Stinnerf17c3de2016-12-06 18:46:19 +010013692 path_repr = _PyObject_CallNoArg(func);
Ethan Furman410ef8e2016-06-04 12:06:26 -070013693 Py_DECREF(func);
Brett Cannon044283a2016-07-15 10:41:49 -070013694 if (NULL == path_repr) {
13695 return NULL;
13696 }
13697
Brett Cannonc78ca1e2016-06-24 12:03:43 -070013698 if (!(PyUnicode_Check(path_repr) || PyBytes_Check(path_repr))) {
13699 PyErr_Format(PyExc_TypeError,
13700 "expected %.200s.__fspath__() to return str or bytes, "
Eddie Elizondob3966632019-11-05 07:16:14 -080013701 "not %.200s", _PyType_Name(Py_TYPE(path)),
13702 _PyType_Name(Py_TYPE(path_repr)));
Brett Cannonc78ca1e2016-06-24 12:03:43 -070013703 Py_DECREF(path_repr);
13704 return NULL;
13705 }
13706
Ethan Furman410ef8e2016-06-04 12:06:26 -070013707 return path_repr;
13708}
13709
13710/*[clinic input]
13711os.fspath
13712
13713 path: object
13714
13715Return the file system path representation of the object.
13716
Brett Cannonb4f43e92016-06-09 14:32:08 -070013717If the object is str or bytes, then allow it to pass through as-is. If the
13718object defines __fspath__(), then return the result of that method. All other
13719types raise a TypeError.
Ethan Furman410ef8e2016-06-04 12:06:26 -070013720[clinic start generated code]*/
13721
13722static PyObject *
Serhiy Storchaka2954f832016-07-07 18:20:03 +030013723os_fspath_impl(PyObject *module, PyObject *path)
13724/*[clinic end generated code: output=c3c3b78ecff2914f input=e357165f7b22490f]*/
Ethan Furman410ef8e2016-06-04 12:06:26 -070013725{
13726 return PyOS_FSPath(path);
13727}
Victor Stinner6036e442015-03-08 01:58:04 +010013728
Victor Stinner9b1f4742016-09-06 16:18:52 -070013729#ifdef HAVE_GETRANDOM_SYSCALL
13730/*[clinic input]
13731os.getrandom
13732
13733 size: Py_ssize_t
13734 flags: int=0
13735
13736Obtain a series of random bytes.
13737[clinic start generated code]*/
13738
13739static PyObject *
13740os_getrandom_impl(PyObject *module, Py_ssize_t size, int flags)
13741/*[clinic end generated code: output=b3a618196a61409c input=59bafac39c594947]*/
13742{
Victor Stinner9b1f4742016-09-06 16:18:52 -070013743 PyObject *bytes;
Victor Stinnerec2319c2016-09-20 23:00:59 +020013744 Py_ssize_t n;
Victor Stinner9b1f4742016-09-06 16:18:52 -070013745
13746 if (size < 0) {
13747 errno = EINVAL;
13748 return posix_error();
13749 }
13750
Victor Stinnerec2319c2016-09-20 23:00:59 +020013751 bytes = PyBytes_FromStringAndSize(NULL, size);
13752 if (bytes == NULL) {
Victor Stinner9b1f4742016-09-06 16:18:52 -070013753 PyErr_NoMemory();
13754 return NULL;
13755 }
13756
13757 while (1) {
Victor Stinnerec2319c2016-09-20 23:00:59 +020013758 n = syscall(SYS_getrandom,
13759 PyBytes_AS_STRING(bytes),
13760 PyBytes_GET_SIZE(bytes),
13761 flags);
Victor Stinner9b1f4742016-09-06 16:18:52 -070013762 if (n < 0 && errno == EINTR) {
13763 if (PyErr_CheckSignals() < 0) {
Victor Stinnerec2319c2016-09-20 23:00:59 +020013764 goto error;
Victor Stinner9b1f4742016-09-06 16:18:52 -070013765 }
Victor Stinnerec2319c2016-09-20 23:00:59 +020013766
13767 /* getrandom() was interrupted by a signal: retry */
Victor Stinner9b1f4742016-09-06 16:18:52 -070013768 continue;
13769 }
13770 break;
13771 }
13772
13773 if (n < 0) {
Victor Stinner9b1f4742016-09-06 16:18:52 -070013774 PyErr_SetFromErrno(PyExc_OSError);
Victor Stinnerec2319c2016-09-20 23:00:59 +020013775 goto error;
Victor Stinner9b1f4742016-09-06 16:18:52 -070013776 }
13777
Victor Stinnerec2319c2016-09-20 23:00:59 +020013778 if (n != size) {
13779 _PyBytes_Resize(&bytes, n);
13780 }
Victor Stinner9b1f4742016-09-06 16:18:52 -070013781
13782 return bytes;
Victor Stinnerec2319c2016-09-20 23:00:59 +020013783
13784error:
13785 Py_DECREF(bytes);
13786 return NULL;
Victor Stinner9b1f4742016-09-06 16:18:52 -070013787}
13788#endif /* HAVE_GETRANDOM_SYSCALL */
13789
Steve Dower2438cdf2019-03-29 16:37:16 -070013790#ifdef MS_WINDOWS
13791/* bpo-36085: Helper functions for managing DLL search directories
13792 * on win32
13793 */
13794
13795typedef DLL_DIRECTORY_COOKIE (WINAPI *PAddDllDirectory)(PCWSTR newDirectory);
13796typedef BOOL (WINAPI *PRemoveDllDirectory)(DLL_DIRECTORY_COOKIE cookie);
13797
13798/*[clinic input]
13799os._add_dll_directory
13800
13801 path: path_t
13802
13803Add a path to the DLL search path.
13804
13805This search path is used when resolving dependencies for imported
13806extension modules (the module itself is resolved through sys.path),
13807and also by ctypes.
13808
13809Returns an opaque value that may be passed to os.remove_dll_directory
13810to remove this directory from the search path.
13811[clinic start generated code]*/
13812
13813static PyObject *
13814os__add_dll_directory_impl(PyObject *module, path_t *path)
13815/*[clinic end generated code: output=80b025daebb5d683 input=1de3e6c13a5808c8]*/
13816{
13817 HMODULE hKernel32;
13818 PAddDllDirectory AddDllDirectory;
13819 DLL_DIRECTORY_COOKIE cookie = 0;
13820 DWORD err = 0;
13821
Saiyang Gou7514f4f2020-02-12 23:47:42 -080013822 if (PySys_Audit("os.add_dll_directory", "(O)", path->object) < 0) {
13823 return NULL;
13824 }
13825
Steve Dower2438cdf2019-03-29 16:37:16 -070013826 /* For Windows 7, we have to load this. As this will be a fairly
13827 infrequent operation, just do it each time. Kernel32 is always
13828 loaded. */
13829 Py_BEGIN_ALLOW_THREADS
13830 if (!(hKernel32 = GetModuleHandleW(L"kernel32")) ||
13831 !(AddDllDirectory = (PAddDllDirectory)GetProcAddress(
13832 hKernel32, "AddDllDirectory")) ||
13833 !(cookie = (*AddDllDirectory)(path->wide))) {
13834 err = GetLastError();
13835 }
13836 Py_END_ALLOW_THREADS
13837
13838 if (err) {
13839 return win32_error_object_err("add_dll_directory",
13840 path->object, err);
13841 }
13842
13843 return PyCapsule_New(cookie, "DLL directory cookie", NULL);
13844}
13845
13846/*[clinic input]
13847os._remove_dll_directory
13848
13849 cookie: object
13850
13851Removes a path from the DLL search path.
13852
13853The parameter is an opaque value that was returned from
13854os.add_dll_directory. You can only remove directories that you added
13855yourself.
13856[clinic start generated code]*/
13857
13858static PyObject *
13859os__remove_dll_directory_impl(PyObject *module, PyObject *cookie)
13860/*[clinic end generated code: output=594350433ae535bc input=c1d16a7e7d9dc5dc]*/
13861{
13862 HMODULE hKernel32;
13863 PRemoveDllDirectory RemoveDllDirectory;
13864 DLL_DIRECTORY_COOKIE cookieValue;
13865 DWORD err = 0;
13866
13867 if (!PyCapsule_IsValid(cookie, "DLL directory cookie")) {
13868 PyErr_SetString(PyExc_TypeError,
13869 "Provided cookie was not returned from os.add_dll_directory");
13870 return NULL;
13871 }
13872
13873 cookieValue = (DLL_DIRECTORY_COOKIE)PyCapsule_GetPointer(
13874 cookie, "DLL directory cookie");
13875
13876 /* For Windows 7, we have to load this. As this will be a fairly
13877 infrequent operation, just do it each time. Kernel32 is always
13878 loaded. */
13879 Py_BEGIN_ALLOW_THREADS
13880 if (!(hKernel32 = GetModuleHandleW(L"kernel32")) ||
13881 !(RemoveDllDirectory = (PRemoveDllDirectory)GetProcAddress(
13882 hKernel32, "RemoveDllDirectory")) ||
13883 !(*RemoveDllDirectory)(cookieValue)) {
13884 err = GetLastError();
13885 }
13886 Py_END_ALLOW_THREADS
13887
13888 if (err) {
13889 return win32_error_object_err("remove_dll_directory",
13890 NULL, err);
13891 }
13892
13893 if (PyCapsule_SetName(cookie, NULL)) {
13894 return NULL;
13895 }
13896
13897 Py_RETURN_NONE;
13898}
13899
13900#endif
Larry Hastings31826802013-10-19 00:09:25 -070013901
Victor Stinner65a796e2020-04-01 18:49:29 +020013902
13903/* Only check if WIFEXITED is available: expect that it comes
13904 with WEXITSTATUS, WIFSIGNALED, etc.
13905
13906 os.waitstatus_to_exitcode() is implemented in C and not in Python, so
13907 subprocess can safely call it during late Python finalization without
13908 risking that used os attributes were set to None by _PyImport_Cleanup(). */
13909#if defined(WIFEXITED) || defined(MS_WINDOWS)
13910/*[clinic input]
13911os.waitstatus_to_exitcode
13912
Victor Stinner9bee32b2020-04-22 16:30:35 +020013913 status as status_obj: object
Victor Stinner65a796e2020-04-01 18:49:29 +020013914
13915Convert a wait status to an exit code.
13916
13917On Unix:
13918
13919* If WIFEXITED(status) is true, return WEXITSTATUS(status).
13920* If WIFSIGNALED(status) is true, return -WTERMSIG(status).
13921* Otherwise, raise a ValueError.
13922
13923On Windows, return status shifted right by 8 bits.
13924
13925On Unix, if the process is being traced or if waitpid() was called with
13926WUNTRACED option, the caller must first check if WIFSTOPPED(status) is true.
13927This function must not be called if WIFSTOPPED(status) is true.
13928[clinic start generated code]*/
13929
13930static PyObject *
Victor Stinner9bee32b2020-04-22 16:30:35 +020013931os_waitstatus_to_exitcode_impl(PyObject *module, PyObject *status_obj)
13932/*[clinic end generated code: output=db50b1b0ba3c7153 input=7fe2d7fdaea3db42]*/
Victor Stinner65a796e2020-04-01 18:49:29 +020013933{
13934#ifndef MS_WINDOWS
Victor Stinner9bee32b2020-04-22 16:30:35 +020013935 int status = _PyLong_AsInt(status_obj);
13936 if (status == -1 && PyErr_Occurred()) {
13937 return NULL;
13938 }
13939
Victor Stinner65a796e2020-04-01 18:49:29 +020013940 WAIT_TYPE wait_status;
13941 WAIT_STATUS_INT(wait_status) = status;
13942 int exitcode;
13943 if (WIFEXITED(wait_status)) {
13944 exitcode = WEXITSTATUS(wait_status);
13945 /* Sanity check to provide warranty on the function behavior.
13946 It should not occur in practice */
13947 if (exitcode < 0) {
13948 PyErr_Format(PyExc_ValueError, "invalid WEXITSTATUS: %i", exitcode);
13949 return NULL;
13950 }
13951 }
13952 else if (WIFSIGNALED(wait_status)) {
13953 int signum = WTERMSIG(wait_status);
13954 /* Sanity check to provide warranty on the function behavior.
13955 It should not occurs in practice */
13956 if (signum <= 0) {
13957 PyErr_Format(PyExc_ValueError, "invalid WTERMSIG: %i", signum);
13958 return NULL;
13959 }
13960 exitcode = -signum;
13961 } else if (WIFSTOPPED(wait_status)) {
13962 /* Status only received if the process is being traced
13963 or if waitpid() was called with WUNTRACED option. */
13964 int signum = WSTOPSIG(wait_status);
13965 PyErr_Format(PyExc_ValueError,
13966 "process stopped by delivery of signal %i",
13967 signum);
13968 return NULL;
13969 }
13970 else {
13971 PyErr_Format(PyExc_ValueError, "invalid wait status: %i", status);
13972 return NULL;
13973 }
13974 return PyLong_FromLong(exitcode);
13975#else
13976 /* Windows implementation: see os.waitpid() implementation
13977 which uses _cwait(). */
Victor Stinner9bee32b2020-04-22 16:30:35 +020013978 unsigned long long status = PyLong_AsUnsignedLongLong(status_obj);
13979 if (status == (unsigned long long)-1 && PyErr_Occurred()) {
13980 return NULL;
13981 }
13982
13983 unsigned long long exitcode = (status >> 8);
13984 /* ExitProcess() accepts an UINT type:
13985 reject exit code which doesn't fit in an UINT */
13986 if (exitcode > UINT_MAX) {
13987 PyErr_Format(PyExc_ValueError, "invalid exit code: %llu", exitcode);
13988 return NULL;
13989 }
13990 return PyLong_FromUnsignedLong((unsigned long)exitcode);
Victor Stinner65a796e2020-04-01 18:49:29 +020013991#endif
13992}
13993#endif
13994
13995
Fred Drake5ab8eaf1999-12-09 21:13:07 +000013996static PyMethodDef posix_methods[] = {
Larry Hastings31826802013-10-19 00:09:25 -070013997
13998 OS_STAT_METHODDEF
13999 OS_ACCESS_METHODDEF
14000 OS_TTYNAME_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100014001 OS_CHDIR_METHODDEF
14002 OS_CHFLAGS_METHODDEF
14003 OS_CHMOD_METHODDEF
14004 OS_FCHMOD_METHODDEF
14005 OS_LCHMOD_METHODDEF
14006 OS_CHOWN_METHODDEF
14007 OS_FCHOWN_METHODDEF
14008 OS_LCHOWN_METHODDEF
14009 OS_LCHFLAGS_METHODDEF
14010 OS_CHROOT_METHODDEF
14011 OS_CTERMID_METHODDEF
14012 OS_GETCWD_METHODDEF
14013 OS_GETCWDB_METHODDEF
14014 OS_LINK_METHODDEF
14015 OS_LISTDIR_METHODDEF
14016 OS_LSTAT_METHODDEF
14017 OS_MKDIR_METHODDEF
14018 OS_NICE_METHODDEF
14019 OS_GETPRIORITY_METHODDEF
14020 OS_SETPRIORITY_METHODDEF
Pablo Galindo6c6ddf92018-01-29 01:56:10 +000014021 OS_POSIX_SPAWN_METHODDEF
Joannah Nanjekye92b83222019-01-16 16:29:26 +030014022 OS_POSIX_SPAWNP_METHODDEF
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030014023 OS_READLINK_METHODDEF
Pablo Galindoaac4d032019-05-31 19:39:47 +010014024 OS_COPY_FILE_RANGE_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100014025 OS_RENAME_METHODDEF
14026 OS_REPLACE_METHODDEF
14027 OS_RMDIR_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100014028 OS_SYMLINK_METHODDEF
14029 OS_SYSTEM_METHODDEF
14030 OS_UMASK_METHODDEF
14031 OS_UNAME_METHODDEF
14032 OS_UNLINK_METHODDEF
14033 OS_REMOVE_METHODDEF
14034 OS_UTIME_METHODDEF
14035 OS_TIMES_METHODDEF
14036 OS__EXIT_METHODDEF
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +020014037 OS__FCOPYFILE_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100014038 OS_EXECV_METHODDEF
14039 OS_EXECVE_METHODDEF
14040 OS_SPAWNV_METHODDEF
14041 OS_SPAWNVE_METHODDEF
14042 OS_FORK1_METHODDEF
14043 OS_FORK_METHODDEF
Antoine Pitrou346cbd32017-05-27 17:50:54 +020014044 OS_REGISTER_AT_FORK_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100014045 OS_SCHED_GET_PRIORITY_MAX_METHODDEF
14046 OS_SCHED_GET_PRIORITY_MIN_METHODDEF
14047 OS_SCHED_GETPARAM_METHODDEF
14048 OS_SCHED_GETSCHEDULER_METHODDEF
14049 OS_SCHED_RR_GET_INTERVAL_METHODDEF
14050 OS_SCHED_SETPARAM_METHODDEF
14051 OS_SCHED_SETSCHEDULER_METHODDEF
14052 OS_SCHED_YIELD_METHODDEF
14053 OS_SCHED_SETAFFINITY_METHODDEF
14054 OS_SCHED_GETAFFINITY_METHODDEF
14055 OS_OPENPTY_METHODDEF
14056 OS_FORKPTY_METHODDEF
14057 OS_GETEGID_METHODDEF
14058 OS_GETEUID_METHODDEF
14059 OS_GETGID_METHODDEF
Serhiy Storchaka2b560312020-04-18 19:14:10 +030014060 OS_GETGROUPLIST_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100014061 OS_GETGROUPS_METHODDEF
14062 OS_GETPID_METHODDEF
14063 OS_GETPGRP_METHODDEF
14064 OS_GETPPID_METHODDEF
14065 OS_GETUID_METHODDEF
14066 OS_GETLOGIN_METHODDEF
14067 OS_KILL_METHODDEF
14068 OS_KILLPG_METHODDEF
14069 OS_PLOCK_METHODDEF
Steve Dowercc16be82016-09-08 10:35:16 -070014070 OS_STARTFILE_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100014071 OS_SETUID_METHODDEF
14072 OS_SETEUID_METHODDEF
14073 OS_SETREUID_METHODDEF
14074 OS_SETGID_METHODDEF
14075 OS_SETEGID_METHODDEF
14076 OS_SETREGID_METHODDEF
14077 OS_SETGROUPS_METHODDEF
Serhiy Storchaka2b560312020-04-18 19:14:10 +030014078 OS_INITGROUPS_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100014079 OS_GETPGID_METHODDEF
14080 OS_SETPGRP_METHODDEF
14081 OS_WAIT_METHODDEF
14082 OS_WAIT3_METHODDEF
14083 OS_WAIT4_METHODDEF
14084 OS_WAITID_METHODDEF
14085 OS_WAITPID_METHODDEF
Benjamin Peterson6c4c45e2019-11-05 19:21:29 -080014086 OS_PIDFD_OPEN_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100014087 OS_GETSID_METHODDEF
14088 OS_SETSID_METHODDEF
14089 OS_SETPGID_METHODDEF
14090 OS_TCGETPGRP_METHODDEF
14091 OS_TCSETPGRP_METHODDEF
14092 OS_OPEN_METHODDEF
14093 OS_CLOSE_METHODDEF
14094 OS_CLOSERANGE_METHODDEF
14095 OS_DEVICE_ENCODING_METHODDEF
14096 OS_DUP_METHODDEF
14097 OS_DUP2_METHODDEF
14098 OS_LOCKF_METHODDEF
14099 OS_LSEEK_METHODDEF
14100 OS_READ_METHODDEF
14101 OS_READV_METHODDEF
14102 OS_PREAD_METHODDEF
Pablo Galindo4defba32018-01-27 16:16:37 +000014103 OS_PREADV_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100014104 OS_WRITE_METHODDEF
14105 OS_WRITEV_METHODDEF
14106 OS_PWRITE_METHODDEF
Pablo Galindo4defba32018-01-27 16:16:37 +000014107 OS_PWRITEV_METHODDEF
Serhiy Storchaka2b560312020-04-18 19:14:10 +030014108 OS_SENDFILE_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100014109 OS_FSTAT_METHODDEF
14110 OS_ISATTY_METHODDEF
14111 OS_PIPE_METHODDEF
14112 OS_PIPE2_METHODDEF
14113 OS_MKFIFO_METHODDEF
14114 OS_MKNOD_METHODDEF
14115 OS_MAJOR_METHODDEF
14116 OS_MINOR_METHODDEF
14117 OS_MAKEDEV_METHODDEF
14118 OS_FTRUNCATE_METHODDEF
14119 OS_TRUNCATE_METHODDEF
14120 OS_POSIX_FALLOCATE_METHODDEF
14121 OS_POSIX_FADVISE_METHODDEF
14122 OS_PUTENV_METHODDEF
14123 OS_UNSETENV_METHODDEF
14124 OS_STRERROR_METHODDEF
14125 OS_FCHDIR_METHODDEF
14126 OS_FSYNC_METHODDEF
14127 OS_SYNC_METHODDEF
14128 OS_FDATASYNC_METHODDEF
14129 OS_WCOREDUMP_METHODDEF
14130 OS_WIFCONTINUED_METHODDEF
14131 OS_WIFSTOPPED_METHODDEF
14132 OS_WIFSIGNALED_METHODDEF
14133 OS_WIFEXITED_METHODDEF
14134 OS_WEXITSTATUS_METHODDEF
14135 OS_WTERMSIG_METHODDEF
14136 OS_WSTOPSIG_METHODDEF
14137 OS_FSTATVFS_METHODDEF
14138 OS_STATVFS_METHODDEF
14139 OS_CONFSTR_METHODDEF
14140 OS_SYSCONF_METHODDEF
14141 OS_FPATHCONF_METHODDEF
14142 OS_PATHCONF_METHODDEF
14143 OS_ABORT_METHODDEF
Serhiy Storchakaf0b50152015-05-13 00:52:39 +030014144 OS__GETFULLPATHNAME_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100014145 OS__GETDISKUSAGE_METHODDEF
14146 OS__GETFINALPATHNAME_METHODDEF
14147 OS__GETVOLUMEPATHNAME_METHODDEF
14148 OS_GETLOADAVG_METHODDEF
14149 OS_URANDOM_METHODDEF
14150 OS_SETRESUID_METHODDEF
14151 OS_SETRESGID_METHODDEF
14152 OS_GETRESUID_METHODDEF
14153 OS_GETRESGID_METHODDEF
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000014154
Larry Hastings2f936352014-08-05 14:04:04 +100014155 OS_GETXATTR_METHODDEF
14156 OS_SETXATTR_METHODDEF
14157 OS_REMOVEXATTR_METHODDEF
14158 OS_LISTXATTR_METHODDEF
14159
Serhiy Storchaka2b560312020-04-18 19:14:10 +030014160 OS_GET_TERMINAL_SIZE_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100014161 OS_CPU_COUNT_METHODDEF
14162 OS_GET_INHERITABLE_METHODDEF
14163 OS_SET_INHERITABLE_METHODDEF
14164 OS_GET_HANDLE_INHERITABLE_METHODDEF
14165 OS_SET_HANDLE_INHERITABLE_METHODDEF
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030014166 OS_GET_BLOCKING_METHODDEF
14167 OS_SET_BLOCKING_METHODDEF
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020014168 OS_SCANDIR_METHODDEF
Ethan Furman410ef8e2016-06-04 12:06:26 -070014169 OS_FSPATH_METHODDEF
Victor Stinner9b1f4742016-09-06 16:18:52 -070014170 OS_GETRANDOM_METHODDEF
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014171 OS_MEMFD_CREATE_METHODDEF
Steve Dower2438cdf2019-03-29 16:37:16 -070014172 OS__ADD_DLL_DIRECTORY_METHODDEF
14173 OS__REMOVE_DLL_DIRECTORY_METHODDEF
Victor Stinner65a796e2020-04-01 18:49:29 +020014174 OS_WAITSTATUS_TO_EXITCODE_METHODDEF
Victor Stinner8c62be82010-05-06 00:08:46 +000014175 {NULL, NULL} /* Sentinel */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000014176};
14177
Barry Warsaw4a342091996-12-19 23:50:02 +000014178static int
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014179all_ins(PyObject *m)
Barry Warsaw4a342091996-12-19 23:50:02 +000014180{
Guido van Rossum94f6f721999-01-06 18:42:14 +000014181#ifdef F_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014182 if (PyModule_AddIntMacro(m, F_OK)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000014183#endif
Guido van Rossum94f6f721999-01-06 18:42:14 +000014184#ifdef R_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014185 if (PyModule_AddIntMacro(m, R_OK)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000014186#endif
Guido van Rossum94f6f721999-01-06 18:42:14 +000014187#ifdef W_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014188 if (PyModule_AddIntMacro(m, W_OK)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000014189#endif
Guido van Rossum94f6f721999-01-06 18:42:14 +000014190#ifdef X_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014191 if (PyModule_AddIntMacro(m, X_OK)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000014192#endif
Fred Drakec9680921999-12-13 16:37:25 +000014193#ifdef NGROUPS_MAX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014194 if (PyModule_AddIntMacro(m, NGROUPS_MAX)) return -1;
Fred Drakec9680921999-12-13 16:37:25 +000014195#endif
Fred Drake5ab8eaf1999-12-09 21:13:07 +000014196#ifdef TMP_MAX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014197 if (PyModule_AddIntMacro(m, TMP_MAX)) return -1;
Fred Drake5ab8eaf1999-12-09 21:13:07 +000014198#endif
Fred Drake106c1a02002-04-23 15:58:02 +000014199#ifdef WCONTINUED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014200 if (PyModule_AddIntMacro(m, WCONTINUED)) return -1;
Fred Drake106c1a02002-04-23 15:58:02 +000014201#endif
Barry Warsaw4a342091996-12-19 23:50:02 +000014202#ifdef WNOHANG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014203 if (PyModule_AddIntMacro(m, WNOHANG)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000014204#endif
Fred Drake106c1a02002-04-23 15:58:02 +000014205#ifdef WUNTRACED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014206 if (PyModule_AddIntMacro(m, WUNTRACED)) return -1;
Fred Drake106c1a02002-04-23 15:58:02 +000014207#endif
Barry Warsaw4a342091996-12-19 23:50:02 +000014208#ifdef O_RDONLY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014209 if (PyModule_AddIntMacro(m, O_RDONLY)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000014210#endif
14211#ifdef O_WRONLY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014212 if (PyModule_AddIntMacro(m, O_WRONLY)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000014213#endif
14214#ifdef O_RDWR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014215 if (PyModule_AddIntMacro(m, O_RDWR)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000014216#endif
14217#ifdef O_NDELAY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014218 if (PyModule_AddIntMacro(m, O_NDELAY)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000014219#endif
14220#ifdef O_NONBLOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014221 if (PyModule_AddIntMacro(m, O_NONBLOCK)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000014222#endif
14223#ifdef O_APPEND
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014224 if (PyModule_AddIntMacro(m, O_APPEND)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000014225#endif
14226#ifdef O_DSYNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014227 if (PyModule_AddIntMacro(m, O_DSYNC)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000014228#endif
14229#ifdef O_RSYNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014230 if (PyModule_AddIntMacro(m, O_RSYNC)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000014231#endif
14232#ifdef O_SYNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014233 if (PyModule_AddIntMacro(m, O_SYNC)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000014234#endif
14235#ifdef O_NOCTTY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014236 if (PyModule_AddIntMacro(m, O_NOCTTY)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000014237#endif
14238#ifdef O_CREAT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014239 if (PyModule_AddIntMacro(m, O_CREAT)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000014240#endif
14241#ifdef O_EXCL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014242 if (PyModule_AddIntMacro(m, O_EXCL)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000014243#endif
14244#ifdef O_TRUNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014245 if (PyModule_AddIntMacro(m, O_TRUNC)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000014246#endif
Guido van Rossum98d9d091997-08-08 21:48:51 +000014247#ifdef O_BINARY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014248 if (PyModule_AddIntMacro(m, O_BINARY)) return -1;
Guido van Rossum98d9d091997-08-08 21:48:51 +000014249#endif
14250#ifdef O_TEXT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014251 if (PyModule_AddIntMacro(m, O_TEXT)) return -1;
Guido van Rossum98d9d091997-08-08 21:48:51 +000014252#endif
Jesus Cea1d642d22012-04-24 20:59:17 +020014253#ifdef O_XATTR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014254 if (PyModule_AddIntMacro(m, O_XATTR)) return -1;
Jesus Cea1d642d22012-04-24 20:59:17 +020014255#endif
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000014256#ifdef O_LARGEFILE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014257 if (PyModule_AddIntMacro(m, O_LARGEFILE)) return -1;
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000014258#endif
doko@ubuntu.comfcff4372016-06-13 16:33:04 +020014259#ifndef __GNU__
Skip Montanaro5ff14922005-05-16 02:42:22 +000014260#ifdef O_SHLOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014261 if (PyModule_AddIntMacro(m, O_SHLOCK)) return -1;
Skip Montanaro5ff14922005-05-16 02:42:22 +000014262#endif
14263#ifdef O_EXLOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014264 if (PyModule_AddIntMacro(m, O_EXLOCK)) return -1;
Skip Montanaro5ff14922005-05-16 02:42:22 +000014265#endif
doko@ubuntu.comfcff4372016-06-13 16:33:04 +020014266#endif
Jesus Ceacf381202012-04-24 20:44:40 +020014267#ifdef O_EXEC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014268 if (PyModule_AddIntMacro(m, O_EXEC)) return -1;
Jesus Ceacf381202012-04-24 20:44:40 +020014269#endif
14270#ifdef O_SEARCH
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014271 if (PyModule_AddIntMacro(m, O_SEARCH)) return -1;
Jesus Ceacf381202012-04-24 20:44:40 +020014272#endif
Benjamin Peterson3b965a22013-03-13 10:27:41 -050014273#ifdef O_PATH
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014274 if (PyModule_AddIntMacro(m, O_PATH)) return -1;
Benjamin Peterson3b965a22013-03-13 10:27:41 -050014275#endif
Jesus Ceacf381202012-04-24 20:44:40 +020014276#ifdef O_TTY_INIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014277 if (PyModule_AddIntMacro(m, O_TTY_INIT)) return -1;
Jesus Ceacf381202012-04-24 20:44:40 +020014278#endif
Christian Heimes177b3f92013-08-16 14:35:09 +020014279#ifdef O_TMPFILE
14280 if (PyModule_AddIntMacro(m, O_TMPFILE)) return -1;
14281#endif
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000014282#ifdef PRIO_PROCESS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014283 if (PyModule_AddIntMacro(m, PRIO_PROCESS)) return -1;
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000014284#endif
14285#ifdef PRIO_PGRP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014286 if (PyModule_AddIntMacro(m, PRIO_PGRP)) return -1;
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000014287#endif
14288#ifdef PRIO_USER
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014289 if (PyModule_AddIntMacro(m, PRIO_USER)) return -1;
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000014290#endif
Charles-François Natali1e045b12011-05-22 20:42:32 +020014291#ifdef O_CLOEXEC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014292 if (PyModule_AddIntMacro(m, O_CLOEXEC)) return -1;
Charles-François Natali1e045b12011-05-22 20:42:32 +020014293#endif
Jesus Cea1d642d22012-04-24 20:59:17 +020014294#ifdef O_ACCMODE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014295 if (PyModule_AddIntMacro(m, O_ACCMODE)) return -1;
Jesus Cea1d642d22012-04-24 20:59:17 +020014296#endif
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000014297
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000014298
Jesus Cea94363612012-06-22 18:32:07 +020014299#ifdef SEEK_HOLE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014300 if (PyModule_AddIntMacro(m, SEEK_HOLE)) return -1;
Jesus Cea94363612012-06-22 18:32:07 +020014301#endif
14302#ifdef SEEK_DATA
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014303 if (PyModule_AddIntMacro(m, SEEK_DATA)) return -1;
Jesus Cea94363612012-06-22 18:32:07 +020014304#endif
14305
Tim Peters5aa91602002-01-30 05:46:57 +000014306/* MS Windows */
14307#ifdef O_NOINHERIT
Victor Stinner8c62be82010-05-06 00:08:46 +000014308 /* Don't inherit in child processes. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014309 if (PyModule_AddIntMacro(m, O_NOINHERIT)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000014310#endif
14311#ifdef _O_SHORT_LIVED
Victor Stinner8c62be82010-05-06 00:08:46 +000014312 /* Optimize for short life (keep in memory). */
14313 /* MS forgot to define this one with a non-underscore form too. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014314 if (PyModule_AddIntConstant(m, "O_SHORT_LIVED", _O_SHORT_LIVED)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000014315#endif
14316#ifdef O_TEMPORARY
Victor Stinner8c62be82010-05-06 00:08:46 +000014317 /* Automatically delete when last handle is closed. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014318 if (PyModule_AddIntMacro(m, O_TEMPORARY)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000014319#endif
14320#ifdef O_RANDOM
Victor Stinner8c62be82010-05-06 00:08:46 +000014321 /* Optimize for random access. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014322 if (PyModule_AddIntMacro(m, O_RANDOM)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000014323#endif
14324#ifdef O_SEQUENTIAL
Victor Stinner8c62be82010-05-06 00:08:46 +000014325 /* Optimize for sequential access. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014326 if (PyModule_AddIntMacro(m, O_SEQUENTIAL)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000014327#endif
14328
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000014329/* GNU extensions. */
Alexandre Vassalottibee32532008-05-16 18:15:12 +000014330#ifdef O_ASYNC
Victor Stinner8c62be82010-05-06 00:08:46 +000014331 /* Send a SIGIO signal whenever input or output
14332 becomes available on file descriptor */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014333 if (PyModule_AddIntMacro(m, O_ASYNC)) return -1;
Alexandre Vassalottibee32532008-05-16 18:15:12 +000014334#endif
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000014335#ifdef O_DIRECT
Victor Stinner8c62be82010-05-06 00:08:46 +000014336 /* Direct disk access. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014337 if (PyModule_AddIntMacro(m, O_DIRECT)) return -1;
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000014338#endif
14339#ifdef O_DIRECTORY
Victor Stinner8c62be82010-05-06 00:08:46 +000014340 /* Must be a directory. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014341 if (PyModule_AddIntMacro(m, O_DIRECTORY)) return -1;
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000014342#endif
14343#ifdef O_NOFOLLOW
Victor Stinner8c62be82010-05-06 00:08:46 +000014344 /* Do not follow links. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014345 if (PyModule_AddIntMacro(m, O_NOFOLLOW)) return -1;
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000014346#endif
Jesus Cea1d642d22012-04-24 20:59:17 +020014347#ifdef O_NOLINKS
14348 /* Fails if link count of the named file is greater than 1 */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014349 if (PyModule_AddIntMacro(m, O_NOLINKS)) return -1;
Jesus Cea1d642d22012-04-24 20:59:17 +020014350#endif
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +000014351#ifdef O_NOATIME
Victor Stinner8c62be82010-05-06 00:08:46 +000014352 /* Do not update the access time. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014353 if (PyModule_AddIntMacro(m, O_NOATIME)) return -1;
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +000014354#endif
Guido van Rossumd48f2521997-12-05 22:19:34 +000014355
Victor Stinner8c62be82010-05-06 00:08:46 +000014356 /* These come from sysexits.h */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014357#ifdef EX_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014358 if (PyModule_AddIntMacro(m, EX_OK)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014359#endif /* EX_OK */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014360#ifdef EX_USAGE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014361 if (PyModule_AddIntMacro(m, EX_USAGE)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014362#endif /* EX_USAGE */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014363#ifdef EX_DATAERR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014364 if (PyModule_AddIntMacro(m, EX_DATAERR)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014365#endif /* EX_DATAERR */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014366#ifdef EX_NOINPUT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014367 if (PyModule_AddIntMacro(m, EX_NOINPUT)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014368#endif /* EX_NOINPUT */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014369#ifdef EX_NOUSER
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014370 if (PyModule_AddIntMacro(m, EX_NOUSER)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014371#endif /* EX_NOUSER */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014372#ifdef EX_NOHOST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014373 if (PyModule_AddIntMacro(m, EX_NOHOST)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014374#endif /* EX_NOHOST */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014375#ifdef EX_UNAVAILABLE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014376 if (PyModule_AddIntMacro(m, EX_UNAVAILABLE)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014377#endif /* EX_UNAVAILABLE */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014378#ifdef EX_SOFTWARE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014379 if (PyModule_AddIntMacro(m, EX_SOFTWARE)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014380#endif /* EX_SOFTWARE */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014381#ifdef EX_OSERR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014382 if (PyModule_AddIntMacro(m, EX_OSERR)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014383#endif /* EX_OSERR */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014384#ifdef EX_OSFILE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014385 if (PyModule_AddIntMacro(m, EX_OSFILE)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014386#endif /* EX_OSFILE */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014387#ifdef EX_CANTCREAT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014388 if (PyModule_AddIntMacro(m, EX_CANTCREAT)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014389#endif /* EX_CANTCREAT */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014390#ifdef EX_IOERR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014391 if (PyModule_AddIntMacro(m, EX_IOERR)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014392#endif /* EX_IOERR */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014393#ifdef EX_TEMPFAIL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014394 if (PyModule_AddIntMacro(m, EX_TEMPFAIL)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014395#endif /* EX_TEMPFAIL */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014396#ifdef EX_PROTOCOL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014397 if (PyModule_AddIntMacro(m, EX_PROTOCOL)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014398#endif /* EX_PROTOCOL */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014399#ifdef EX_NOPERM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014400 if (PyModule_AddIntMacro(m, EX_NOPERM)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014401#endif /* EX_NOPERM */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014402#ifdef EX_CONFIG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014403 if (PyModule_AddIntMacro(m, EX_CONFIG)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014404#endif /* EX_CONFIG */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014405#ifdef EX_NOTFOUND
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014406 if (PyModule_AddIntMacro(m, EX_NOTFOUND)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014407#endif /* EX_NOTFOUND */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014408
Amaury Forgeot d'Arc66d00ad2010-09-10 18:11:45 +000014409 /* statvfs */
Andrew M. Kuchling4ea04a32010-08-18 22:30:34 +000014410#ifdef ST_RDONLY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014411 if (PyModule_AddIntMacro(m, ST_RDONLY)) return -1;
Andrew M. Kuchling4ea04a32010-08-18 22:30:34 +000014412#endif /* ST_RDONLY */
14413#ifdef ST_NOSUID
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014414 if (PyModule_AddIntMacro(m, ST_NOSUID)) return -1;
Andrew M. Kuchling4ea04a32010-08-18 22:30:34 +000014415#endif /* ST_NOSUID */
14416
doko@ubuntu.comca616a22013-12-08 15:23:07 +010014417 /* GNU extensions */
14418#ifdef ST_NODEV
14419 if (PyModule_AddIntMacro(m, ST_NODEV)) return -1;
14420#endif /* ST_NODEV */
14421#ifdef ST_NOEXEC
14422 if (PyModule_AddIntMacro(m, ST_NOEXEC)) return -1;
14423#endif /* ST_NOEXEC */
14424#ifdef ST_SYNCHRONOUS
14425 if (PyModule_AddIntMacro(m, ST_SYNCHRONOUS)) return -1;
14426#endif /* ST_SYNCHRONOUS */
14427#ifdef ST_MANDLOCK
14428 if (PyModule_AddIntMacro(m, ST_MANDLOCK)) return -1;
14429#endif /* ST_MANDLOCK */
14430#ifdef ST_WRITE
14431 if (PyModule_AddIntMacro(m, ST_WRITE)) return -1;
14432#endif /* ST_WRITE */
14433#ifdef ST_APPEND
14434 if (PyModule_AddIntMacro(m, ST_APPEND)) return -1;
14435#endif /* ST_APPEND */
14436#ifdef ST_NOATIME
14437 if (PyModule_AddIntMacro(m, ST_NOATIME)) return -1;
14438#endif /* ST_NOATIME */
14439#ifdef ST_NODIRATIME
14440 if (PyModule_AddIntMacro(m, ST_NODIRATIME)) return -1;
14441#endif /* ST_NODIRATIME */
14442#ifdef ST_RELATIME
14443 if (PyModule_AddIntMacro(m, ST_RELATIME)) return -1;
14444#endif /* ST_RELATIME */
14445
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000014446 /* FreeBSD sendfile() constants */
14447#ifdef SF_NODISKIO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014448 if (PyModule_AddIntMacro(m, SF_NODISKIO)) return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000014449#endif
14450#ifdef SF_MNOWAIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014451 if (PyModule_AddIntMacro(m, SF_MNOWAIT)) return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000014452#endif
14453#ifdef SF_SYNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014454 if (PyModule_AddIntMacro(m, SF_SYNC)) return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000014455#endif
14456
Ross Lagerwall7807c352011-03-17 20:20:30 +020014457 /* constants for posix_fadvise */
14458#ifdef POSIX_FADV_NORMAL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014459 if (PyModule_AddIntMacro(m, POSIX_FADV_NORMAL)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014460#endif
14461#ifdef POSIX_FADV_SEQUENTIAL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014462 if (PyModule_AddIntMacro(m, POSIX_FADV_SEQUENTIAL)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014463#endif
14464#ifdef POSIX_FADV_RANDOM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014465 if (PyModule_AddIntMacro(m, POSIX_FADV_RANDOM)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014466#endif
14467#ifdef POSIX_FADV_NOREUSE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014468 if (PyModule_AddIntMacro(m, POSIX_FADV_NOREUSE)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014469#endif
14470#ifdef POSIX_FADV_WILLNEED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014471 if (PyModule_AddIntMacro(m, POSIX_FADV_WILLNEED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014472#endif
14473#ifdef POSIX_FADV_DONTNEED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014474 if (PyModule_AddIntMacro(m, POSIX_FADV_DONTNEED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014475#endif
14476
14477 /* constants for waitid */
14478#if defined(HAVE_SYS_WAIT_H) && defined(HAVE_WAITID)
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014479 if (PyModule_AddIntMacro(m, P_PID)) return -1;
14480 if (PyModule_AddIntMacro(m, P_PGID)) return -1;
14481 if (PyModule_AddIntMacro(m, P_ALL)) return -1;
Benjamin Peterson5c0c3252019-11-05 21:58:31 -080014482#ifdef P_PIDFD
14483 if (PyModule_AddIntMacro(m, P_PIDFD)) return -1;
14484#endif
Ross Lagerwall7807c352011-03-17 20:20:30 +020014485#endif
14486#ifdef WEXITED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014487 if (PyModule_AddIntMacro(m, WEXITED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014488#endif
14489#ifdef WNOWAIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014490 if (PyModule_AddIntMacro(m, WNOWAIT)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014491#endif
14492#ifdef WSTOPPED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014493 if (PyModule_AddIntMacro(m, WSTOPPED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014494#endif
14495#ifdef CLD_EXITED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014496 if (PyModule_AddIntMacro(m, CLD_EXITED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014497#endif
Dong-hee Na2eba6ad2019-10-21 16:01:05 +090014498#ifdef CLD_KILLED
14499 if (PyModule_AddIntMacro(m, CLD_KILLED)) return -1;
14500#endif
Ross Lagerwall7807c352011-03-17 20:20:30 +020014501#ifdef CLD_DUMPED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014502 if (PyModule_AddIntMacro(m, CLD_DUMPED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014503#endif
14504#ifdef CLD_TRAPPED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014505 if (PyModule_AddIntMacro(m, CLD_TRAPPED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014506#endif
Dong-hee Na2eba6ad2019-10-21 16:01:05 +090014507#ifdef CLD_STOPPED
14508 if (PyModule_AddIntMacro(m, CLD_STOPPED)) return -1;
14509#endif
Ross Lagerwall7807c352011-03-17 20:20:30 +020014510#ifdef CLD_CONTINUED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014511 if (PyModule_AddIntMacro(m, CLD_CONTINUED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014512#endif
14513
14514 /* constants for lockf */
14515#ifdef F_LOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014516 if (PyModule_AddIntMacro(m, F_LOCK)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014517#endif
14518#ifdef F_TLOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014519 if (PyModule_AddIntMacro(m, F_TLOCK)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014520#endif
14521#ifdef F_ULOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014522 if (PyModule_AddIntMacro(m, F_ULOCK)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014523#endif
14524#ifdef F_TEST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014525 if (PyModule_AddIntMacro(m, F_TEST)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014526#endif
14527
Pablo Galindo4defba32018-01-27 16:16:37 +000014528#ifdef RWF_DSYNC
14529 if (PyModule_AddIntConstant(m, "RWF_DSYNC", RWF_DSYNC)) return -1;
14530#endif
14531#ifdef RWF_HIPRI
14532 if (PyModule_AddIntConstant(m, "RWF_HIPRI", RWF_HIPRI)) return -1;
14533#endif
14534#ifdef RWF_SYNC
14535 if (PyModule_AddIntConstant(m, "RWF_SYNC", RWF_SYNC)) return -1;
14536#endif
14537#ifdef RWF_NOWAIT
14538 if (PyModule_AddIntConstant(m, "RWF_NOWAIT", RWF_NOWAIT)) return -1;
14539#endif
YoSTEALTH76ef2552020-05-27 15:32:22 -060014540#ifdef RWF_APPEND
14541 if (PyModule_AddIntConstant(m, "RWF_APPEND", RWF_APPEND)) return -1;
14542#endif
Pablo Galindo4defba32018-01-27 16:16:37 +000014543
Pablo Galindo6c6ddf92018-01-29 01:56:10 +000014544/* constants for posix_spawn */
14545#ifdef HAVE_POSIX_SPAWN
14546 if (PyModule_AddIntConstant(m, "POSIX_SPAWN_OPEN", POSIX_SPAWN_OPEN)) return -1;
14547 if (PyModule_AddIntConstant(m, "POSIX_SPAWN_CLOSE", POSIX_SPAWN_CLOSE)) return -1;
14548 if (PyModule_AddIntConstant(m, "POSIX_SPAWN_DUP2", POSIX_SPAWN_DUP2)) return -1;
14549#endif
14550
pxinwrf2d7ac72019-05-21 18:46:37 +080014551#if defined(HAVE_SPAWNV) || defined (HAVE_RTPSPAWN)
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014552 if (PyModule_AddIntConstant(m, "P_WAIT", _P_WAIT)) return -1;
14553 if (PyModule_AddIntConstant(m, "P_NOWAIT", _P_NOWAIT)) return -1;
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014554 if (PyModule_AddIntConstant(m, "P_NOWAITO", _P_NOWAITO)) return -1;
pxinwrf2d7ac72019-05-21 18:46:37 +080014555#endif
14556#ifdef HAVE_SPAWNV
14557 if (PyModule_AddIntConstant(m, "P_OVERLAY", _OLD_P_OVERLAY)) return -1;
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014558 if (PyModule_AddIntConstant(m, "P_DETACH", _P_DETACH)) return -1;
Guido van Rossum246bc171999-02-01 23:54:31 +000014559#endif
14560
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014561#ifdef HAVE_SCHED_H
Benjamin Petersondbaa5592016-07-30 23:21:50 -070014562#ifdef SCHED_OTHER
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014563 if (PyModule_AddIntMacro(m, SCHED_OTHER)) return -1;
Benjamin Petersondbaa5592016-07-30 23:21:50 -070014564#endif
14565#ifdef SCHED_FIFO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014566 if (PyModule_AddIntMacro(m, SCHED_FIFO)) return -1;
Benjamin Petersondbaa5592016-07-30 23:21:50 -070014567#endif
14568#ifdef SCHED_RR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014569 if (PyModule_AddIntMacro(m, SCHED_RR)) return -1;
Benjamin Petersondbaa5592016-07-30 23:21:50 -070014570#endif
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014571#ifdef SCHED_SPORADIC
messi Liao0d322182017-06-13 22:30:43 +080014572 if (PyModule_AddIntMacro(m, SCHED_SPORADIC)) return -1;
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014573#endif
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014574#ifdef SCHED_BATCH
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014575 if (PyModule_AddIntMacro(m, SCHED_BATCH)) return -1;
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014576#endif
14577#ifdef SCHED_IDLE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014578 if (PyModule_AddIntMacro(m, SCHED_IDLE)) return -1;
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014579#endif
14580#ifdef SCHED_RESET_ON_FORK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014581 if (PyModule_AddIntMacro(m, SCHED_RESET_ON_FORK)) return -1;
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014582#endif
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020014583#ifdef SCHED_SYS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014584 if (PyModule_AddIntMacro(m, SCHED_SYS)) return -1;
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020014585#endif
14586#ifdef SCHED_IA
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014587 if (PyModule_AddIntMacro(m, SCHED_IA)) return -1;
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020014588#endif
14589#ifdef SCHED_FSS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014590 if (PyModule_AddIntMacro(m, SCHED_FSS)) return -1;
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020014591#endif
14592#ifdef SCHED_FX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014593 if (PyModule_AddIntConstant(m, "SCHED_FX", SCHED_FSS)) return -1;
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020014594#endif
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014595#endif
14596
Benjamin Peterson9428d532011-09-14 11:45:52 -040014597#ifdef USE_XATTRS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014598 if (PyModule_AddIntMacro(m, XATTR_CREATE)) return -1;
14599 if (PyModule_AddIntMacro(m, XATTR_REPLACE)) return -1;
14600 if (PyModule_AddIntMacro(m, XATTR_SIZE_MAX)) return -1;
Benjamin Peterson799bd802011-08-31 22:15:17 -040014601#endif
14602
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014603#if HAVE_DECL_RTLD_LAZY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014604 if (PyModule_AddIntMacro(m, RTLD_LAZY)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014605#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014606#if HAVE_DECL_RTLD_NOW
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014607 if (PyModule_AddIntMacro(m, RTLD_NOW)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014608#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014609#if HAVE_DECL_RTLD_GLOBAL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014610 if (PyModule_AddIntMacro(m, RTLD_GLOBAL)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014611#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014612#if HAVE_DECL_RTLD_LOCAL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014613 if (PyModule_AddIntMacro(m, RTLD_LOCAL)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014614#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014615#if HAVE_DECL_RTLD_NODELETE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014616 if (PyModule_AddIntMacro(m, RTLD_NODELETE)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014617#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014618#if HAVE_DECL_RTLD_NOLOAD
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014619 if (PyModule_AddIntMacro(m, RTLD_NOLOAD)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014620#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014621#if HAVE_DECL_RTLD_DEEPBIND
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014622 if (PyModule_AddIntMacro(m, RTLD_DEEPBIND)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014623#endif
Michael Feltc5ae1692017-12-19 13:58:49 +010014624#if HAVE_DECL_RTLD_MEMBER
14625 if (PyModule_AddIntMacro(m, RTLD_MEMBER)) return -1;
14626#endif
Victor Stinner8b905bd2011-10-25 13:34:04 +020014627
Victor Stinner9b1f4742016-09-06 16:18:52 -070014628#ifdef HAVE_GETRANDOM_SYSCALL
14629 if (PyModule_AddIntMacro(m, GRND_RANDOM)) return -1;
14630 if (PyModule_AddIntMacro(m, GRND_NONBLOCK)) return -1;
14631#endif
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014632#ifdef HAVE_MEMFD_CREATE
14633 if (PyModule_AddIntMacro(m, MFD_CLOEXEC)) return -1;
14634 if (PyModule_AddIntMacro(m, MFD_ALLOW_SEALING)) return -1;
14635#ifdef MFD_HUGETLB
14636 if (PyModule_AddIntMacro(m, MFD_HUGETLB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014637#endif
14638#ifdef MFD_HUGE_SHIFT
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014639 if (PyModule_AddIntMacro(m, MFD_HUGE_SHIFT)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014640#endif
14641#ifdef MFD_HUGE_MASK
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014642 if (PyModule_AddIntMacro(m, MFD_HUGE_MASK)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014643#endif
14644#ifdef MFD_HUGE_64KB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014645 if (PyModule_AddIntMacro(m, MFD_HUGE_64KB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014646#endif
14647#ifdef MFD_HUGE_512KB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014648 if (PyModule_AddIntMacro(m, MFD_HUGE_512KB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014649#endif
14650#ifdef MFD_HUGE_1MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014651 if (PyModule_AddIntMacro(m, MFD_HUGE_1MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014652#endif
14653#ifdef MFD_HUGE_2MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014654 if (PyModule_AddIntMacro(m, MFD_HUGE_2MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014655#endif
14656#ifdef MFD_HUGE_8MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014657 if (PyModule_AddIntMacro(m, MFD_HUGE_8MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014658#endif
14659#ifdef MFD_HUGE_16MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014660 if (PyModule_AddIntMacro(m, MFD_HUGE_16MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014661#endif
14662#ifdef MFD_HUGE_32MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014663 if (PyModule_AddIntMacro(m, MFD_HUGE_32MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014664#endif
14665#ifdef MFD_HUGE_256MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014666 if (PyModule_AddIntMacro(m, MFD_HUGE_256MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014667#endif
14668#ifdef MFD_HUGE_512MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014669 if (PyModule_AddIntMacro(m, MFD_HUGE_512MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014670#endif
14671#ifdef MFD_HUGE_1GB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014672 if (PyModule_AddIntMacro(m, MFD_HUGE_1GB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014673#endif
14674#ifdef MFD_HUGE_2GB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014675 if (PyModule_AddIntMacro(m, MFD_HUGE_2GB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014676#endif
14677#ifdef MFD_HUGE_16GB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014678 if (PyModule_AddIntMacro(m, MFD_HUGE_16GB)) return -1;
14679#endif
14680#endif
Victor Stinner9b1f4742016-09-06 16:18:52 -070014681
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +020014682#if defined(__APPLE__)
14683 if (PyModule_AddIntConstant(m, "_COPYFILE_DATA", COPYFILE_DATA)) return -1;
14684#endif
14685
Steve Dower2438cdf2019-03-29 16:37:16 -070014686#ifdef MS_WINDOWS
14687 if (PyModule_AddIntConstant(m, "_LOAD_LIBRARY_SEARCH_DEFAULT_DIRS", LOAD_LIBRARY_SEARCH_DEFAULT_DIRS)) return -1;
14688 if (PyModule_AddIntConstant(m, "_LOAD_LIBRARY_SEARCH_APPLICATION_DIR", LOAD_LIBRARY_SEARCH_APPLICATION_DIR)) return -1;
14689 if (PyModule_AddIntConstant(m, "_LOAD_LIBRARY_SEARCH_SYSTEM32", LOAD_LIBRARY_SEARCH_SYSTEM32)) return -1;
14690 if (PyModule_AddIntConstant(m, "_LOAD_LIBRARY_SEARCH_USER_DIRS", LOAD_LIBRARY_SEARCH_USER_DIRS)) return -1;
14691 if (PyModule_AddIntConstant(m, "_LOAD_LIBRARY_SEARCH_DLL_LOAD_DIR", LOAD_LIBRARY_SEARCH_DLL_LOAD_DIR)) return -1;
14692#endif
14693
Victor Stinner8c62be82010-05-06 00:08:46 +000014694 return 0;
Barry Warsaw4a342091996-12-19 23:50:02 +000014695}
14696
14697
Serhiy Storchaka2d06e842015-12-25 19:53:18 +020014698static const char * const have_functions[] = {
Larry Hastings9cf065c2012-06-22 16:30:09 -070014699
14700#ifdef HAVE_FACCESSAT
14701 "HAVE_FACCESSAT",
14702#endif
14703
14704#ifdef HAVE_FCHDIR
14705 "HAVE_FCHDIR",
14706#endif
14707
14708#ifdef HAVE_FCHMOD
14709 "HAVE_FCHMOD",
14710#endif
14711
14712#ifdef HAVE_FCHMODAT
14713 "HAVE_FCHMODAT",
14714#endif
14715
14716#ifdef HAVE_FCHOWN
14717 "HAVE_FCHOWN",
14718#endif
14719
Larry Hastings00964ed2013-08-12 13:49:30 -040014720#ifdef HAVE_FCHOWNAT
14721 "HAVE_FCHOWNAT",
14722#endif
14723
Larry Hastings9cf065c2012-06-22 16:30:09 -070014724#ifdef HAVE_FEXECVE
14725 "HAVE_FEXECVE",
14726#endif
14727
14728#ifdef HAVE_FDOPENDIR
14729 "HAVE_FDOPENDIR",
14730#endif
14731
Georg Brandl306336b2012-06-24 12:55:33 +020014732#ifdef HAVE_FPATHCONF
14733 "HAVE_FPATHCONF",
14734#endif
14735
Larry Hastings9cf065c2012-06-22 16:30:09 -070014736#ifdef HAVE_FSTATAT
14737 "HAVE_FSTATAT",
14738#endif
14739
14740#ifdef HAVE_FSTATVFS
14741 "HAVE_FSTATVFS",
14742#endif
14743
Steve Dowerfe0a41a2015-03-20 19:50:46 -070014744#if defined HAVE_FTRUNCATE || defined MS_WINDOWS
Georg Brandl306336b2012-06-24 12:55:33 +020014745 "HAVE_FTRUNCATE",
14746#endif
14747
Larry Hastings9cf065c2012-06-22 16:30:09 -070014748#ifdef HAVE_FUTIMENS
14749 "HAVE_FUTIMENS",
14750#endif
14751
14752#ifdef HAVE_FUTIMES
14753 "HAVE_FUTIMES",
14754#endif
14755
14756#ifdef HAVE_FUTIMESAT
14757 "HAVE_FUTIMESAT",
14758#endif
14759
14760#ifdef HAVE_LINKAT
14761 "HAVE_LINKAT",
14762#endif
14763
14764#ifdef HAVE_LCHFLAGS
14765 "HAVE_LCHFLAGS",
14766#endif
14767
14768#ifdef HAVE_LCHMOD
14769 "HAVE_LCHMOD",
14770#endif
14771
14772#ifdef HAVE_LCHOWN
14773 "HAVE_LCHOWN",
14774#endif
14775
14776#ifdef HAVE_LSTAT
14777 "HAVE_LSTAT",
14778#endif
14779
14780#ifdef HAVE_LUTIMES
14781 "HAVE_LUTIMES",
14782#endif
14783
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014784#ifdef HAVE_MEMFD_CREATE
14785 "HAVE_MEMFD_CREATE",
14786#endif
14787
Larry Hastings9cf065c2012-06-22 16:30:09 -070014788#ifdef HAVE_MKDIRAT
14789 "HAVE_MKDIRAT",
14790#endif
14791
14792#ifdef HAVE_MKFIFOAT
14793 "HAVE_MKFIFOAT",
14794#endif
14795
14796#ifdef HAVE_MKNODAT
14797 "HAVE_MKNODAT",
14798#endif
14799
14800#ifdef HAVE_OPENAT
14801 "HAVE_OPENAT",
14802#endif
14803
14804#ifdef HAVE_READLINKAT
14805 "HAVE_READLINKAT",
14806#endif
14807
14808#ifdef HAVE_RENAMEAT
14809 "HAVE_RENAMEAT",
14810#endif
14811
14812#ifdef HAVE_SYMLINKAT
14813 "HAVE_SYMLINKAT",
14814#endif
14815
14816#ifdef HAVE_UNLINKAT
14817 "HAVE_UNLINKAT",
14818#endif
14819
14820#ifdef HAVE_UTIMENSAT
14821 "HAVE_UTIMENSAT",
14822#endif
14823
14824#ifdef MS_WINDOWS
14825 "MS_WINDOWS",
14826#endif
14827
14828 NULL
14829};
14830
14831
Victor Stinner1c2fa782020-05-10 11:05:29 +020014832static int
14833posixmodule_exec(PyObject *m)
Guido van Rossumb6775db1994-08-01 11:34:53 +000014834{
Victor Stinner97f33c32020-05-14 18:05:58 +020014835 _posixstate *state = get_posix_state(m);
Tim Peters5aa91602002-01-30 05:46:57 +000014836
Victor Stinner8c62be82010-05-06 00:08:46 +000014837 /* Initialize environ dictionary */
Victor Stinner97f33c32020-05-14 18:05:58 +020014838 PyObject *v = convertenviron();
Victor Stinner8c62be82010-05-06 00:08:46 +000014839 Py_XINCREF(v);
14840 if (v == NULL || PyModule_AddObject(m, "environ", v) != 0)
Victor Stinner1c2fa782020-05-10 11:05:29 +020014841 return -1;
Victor Stinner8c62be82010-05-06 00:08:46 +000014842 Py_DECREF(v);
Fred Drakec9680921999-12-13 16:37:25 +000014843
Victor Stinner8c62be82010-05-06 00:08:46 +000014844 if (all_ins(m))
Victor Stinner1c2fa782020-05-10 11:05:29 +020014845 return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000014846
Victor Stinner8c62be82010-05-06 00:08:46 +000014847 if (setup_confname_tables(m))
Victor Stinner1c2fa782020-05-10 11:05:29 +020014848 return -1;
Fred Drakebec628d1999-12-15 18:31:10 +000014849
Victor Stinner8c62be82010-05-06 00:08:46 +000014850 Py_INCREF(PyExc_OSError);
14851 PyModule_AddObject(m, "error", PyExc_OSError);
Fred Drake762e2061999-08-26 17:23:54 +000014852
Ross Lagerwall7807c352011-03-17 20:20:30 +020014853#if defined(HAVE_WAITID) && !defined(__APPLE__)
Eddie Elizondob3966632019-11-05 07:16:14 -080014854 waitid_result_desc.name = MODNAME ".waitid_result";
14855 PyObject *WaitidResultType = (PyObject *)PyStructSequence_NewType(&waitid_result_desc);
14856 if (WaitidResultType == NULL) {
Victor Stinner1c2fa782020-05-10 11:05:29 +020014857 return -1;
Eddie Elizondob3966632019-11-05 07:16:14 -080014858 }
14859 Py_INCREF(WaitidResultType);
14860 PyModule_AddObject(m, "waitid_result", WaitidResultType);
Victor Stinner97f33c32020-05-14 18:05:58 +020014861 state->WaitidResultType = WaitidResultType;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014862#endif
14863
Eddie Elizondob3966632019-11-05 07:16:14 -080014864 stat_result_desc.name = "os.stat_result"; /* see issue #19209 */
14865 stat_result_desc.fields[7].name = PyStructSequence_UnnamedField;
14866 stat_result_desc.fields[8].name = PyStructSequence_UnnamedField;
14867 stat_result_desc.fields[9].name = PyStructSequence_UnnamedField;
14868 PyObject *StatResultType = (PyObject *)PyStructSequence_NewType(&stat_result_desc);
14869 if (StatResultType == NULL) {
Victor Stinner1c2fa782020-05-10 11:05:29 +020014870 return -1;
Eddie Elizondob3966632019-11-05 07:16:14 -080014871 }
14872 Py_INCREF(StatResultType);
14873 PyModule_AddObject(m, "stat_result", StatResultType);
Victor Stinner97f33c32020-05-14 18:05:58 +020014874 state->StatResultType = StatResultType;
Eddie Elizondob3966632019-11-05 07:16:14 -080014875 structseq_new = ((PyTypeObject *)StatResultType)->tp_new;
14876 ((PyTypeObject *)StatResultType)->tp_new = statresult_new;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000014877
Eddie Elizondob3966632019-11-05 07:16:14 -080014878 statvfs_result_desc.name = "os.statvfs_result"; /* see issue #19209 */
14879 PyObject *StatVFSResultType = (PyObject *)PyStructSequence_NewType(&statvfs_result_desc);
14880 if (StatVFSResultType == NULL) {
Victor Stinner1c2fa782020-05-10 11:05:29 +020014881 return -1;
Eddie Elizondob3966632019-11-05 07:16:14 -080014882 }
14883 Py_INCREF(StatVFSResultType);
14884 PyModule_AddObject(m, "statvfs_result", StatVFSResultType);
Victor Stinner97f33c32020-05-14 18:05:58 +020014885 state->StatVFSResultType = StatVFSResultType;
Martin v. Löwis05bfe1f2008-12-29 18:21:47 +000014886#ifdef NEED_TICKS_PER_SECOND
14887# if defined(HAVE_SYSCONF) && defined(_SC_CLK_TCK)
Eddie Elizondob3966632019-11-05 07:16:14 -080014888 ticks_per_second = sysconf(_SC_CLK_TCK);
Martin v. Löwis05bfe1f2008-12-29 18:21:47 +000014889# elif defined(HZ)
Eddie Elizondob3966632019-11-05 07:16:14 -080014890 ticks_per_second = HZ;
Martin v. Löwis05bfe1f2008-12-29 18:21:47 +000014891# else
Eddie Elizondob3966632019-11-05 07:16:14 -080014892 ticks_per_second = 60; /* magic fallback value; may be bogus */
Martin v. Löwis05bfe1f2008-12-29 18:21:47 +000014893# endif
14894#endif
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014895
William Orr81574b82018-10-01 22:19:56 -070014896#if defined(HAVE_SCHED_SETPARAM) || defined(HAVE_SCHED_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDPARAM)
Eddie Elizondob3966632019-11-05 07:16:14 -080014897 sched_param_desc.name = MODNAME ".sched_param";
14898 PyObject *SchedParamType = (PyObject *)PyStructSequence_NewType(&sched_param_desc);
14899 if (SchedParamType == NULL) {
Victor Stinner1c2fa782020-05-10 11:05:29 +020014900 return -1;
Victor Stinner8c62be82010-05-06 00:08:46 +000014901 }
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014902 Py_INCREF(SchedParamType);
Eddie Elizondob3966632019-11-05 07:16:14 -080014903 PyModule_AddObject(m, "sched_param", SchedParamType);
Victor Stinner97f33c32020-05-14 18:05:58 +020014904 state->SchedParamType = SchedParamType;
Eddie Elizondob3966632019-11-05 07:16:14 -080014905 ((PyTypeObject *)SchedParamType)->tp_new = os_sched_param;
Benjamin Petersone3298dd2011-08-02 18:40:46 -050014906#endif
Thomas Wouters477c8d52006-05-27 19:21:47 +000014907
Eddie Elizondob3966632019-11-05 07:16:14 -080014908 /* initialize TerminalSize_info */
14909 PyObject *TerminalSizeType = (PyObject *)PyStructSequence_NewType(&TerminalSize_desc);
14910 if (TerminalSizeType == NULL) {
Victor Stinner1c2fa782020-05-10 11:05:29 +020014911 return -1;
Eddie Elizondob3966632019-11-05 07:16:14 -080014912 }
14913 Py_INCREF(TerminalSizeType);
14914 PyModule_AddObject(m, "terminal_size", TerminalSizeType);
Victor Stinner97f33c32020-05-14 18:05:58 +020014915 state->TerminalSizeType = TerminalSizeType;
Eddie Elizondob3966632019-11-05 07:16:14 -080014916
14917 /* initialize scandir types */
Victor Stinner1c2fa782020-05-10 11:05:29 +020014918 PyObject *ScandirIteratorType = PyType_FromModuleAndSpec(m, &ScandirIteratorType_spec, NULL);
Eddie Elizondob3966632019-11-05 07:16:14 -080014919 if (ScandirIteratorType == NULL) {
Victor Stinner1c2fa782020-05-10 11:05:29 +020014920 return -1;
Eddie Elizondob3966632019-11-05 07:16:14 -080014921 }
Victor Stinner97f33c32020-05-14 18:05:58 +020014922 state->ScandirIteratorType = ScandirIteratorType;
Eddie Elizondob3966632019-11-05 07:16:14 -080014923
Victor Stinner1c2fa782020-05-10 11:05:29 +020014924 PyObject *DirEntryType = PyType_FromModuleAndSpec(m, &DirEntryType_spec, NULL);
Eddie Elizondob3966632019-11-05 07:16:14 -080014925 if (DirEntryType == NULL) {
Victor Stinner1c2fa782020-05-10 11:05:29 +020014926 return -1;
Eddie Elizondob3966632019-11-05 07:16:14 -080014927 }
14928 Py_INCREF(DirEntryType);
14929 PyModule_AddObject(m, "DirEntry", DirEntryType);
Victor Stinner97f33c32020-05-14 18:05:58 +020014930 state->DirEntryType = DirEntryType;
Eddie Elizondob3966632019-11-05 07:16:14 -080014931
Larry Hastings605a62d2012-06-24 04:33:36 -070014932 times_result_desc.name = MODNAME ".times_result";
Eddie Elizondob3966632019-11-05 07:16:14 -080014933 PyObject *TimesResultType = (PyObject *)PyStructSequence_NewType(&times_result_desc);
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014934 if (TimesResultType == NULL) {
Victor Stinner1c2fa782020-05-10 11:05:29 +020014935 return -1;
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014936 }
Eddie Elizondob3966632019-11-05 07:16:14 -080014937 Py_INCREF(TimesResultType);
14938 PyModule_AddObject(m, "times_result", TimesResultType);
Victor Stinner97f33c32020-05-14 18:05:58 +020014939 state->TimesResultType = TimesResultType;
Larry Hastings605a62d2012-06-24 04:33:36 -070014940
Eddie Elizondob3966632019-11-05 07:16:14 -080014941 PyTypeObject *UnameResultType = PyStructSequence_NewType(&uname_result_desc);
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014942 if (UnameResultType == NULL) {
Victor Stinner1c2fa782020-05-10 11:05:29 +020014943 return -1;
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014944 }
Eddie Elizondob3966632019-11-05 07:16:14 -080014945 Py_INCREF(UnameResultType);
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014946 PyModule_AddObject(m, "uname_result", (PyObject *)UnameResultType);
Victor Stinner97f33c32020-05-14 18:05:58 +020014947 state->UnameResultType = (PyObject *)UnameResultType;
Larry Hastings605a62d2012-06-24 04:33:36 -070014948
Thomas Wouters477c8d52006-05-27 19:21:47 +000014949#ifdef __APPLE__
Victor Stinner8c62be82010-05-06 00:08:46 +000014950 /*
14951 * Step 2 of weak-linking support on Mac OS X.
14952 *
14953 * The code below removes functions that are not available on the
14954 * currently active platform.
14955 *
14956 * This block allow one to use a python binary that was build on
Larry Hastings9cf065c2012-06-22 16:30:09 -070014957 * OSX 10.4 on OSX 10.3, without losing access to new APIs on
Victor Stinner8c62be82010-05-06 00:08:46 +000014958 * OSX 10.4.
14959 */
Thomas Wouters477c8d52006-05-27 19:21:47 +000014960#ifdef HAVE_FSTATVFS
Victor Stinner8c62be82010-05-06 00:08:46 +000014961 if (fstatvfs == NULL) {
14962 if (PyObject_DelAttrString(m, "fstatvfs") == -1) {
Victor Stinner1c2fa782020-05-10 11:05:29 +020014963 return -1;
Victor Stinner8c62be82010-05-06 00:08:46 +000014964 }
14965 }
Thomas Wouters477c8d52006-05-27 19:21:47 +000014966#endif /* HAVE_FSTATVFS */
14967
14968#ifdef HAVE_STATVFS
Victor Stinner8c62be82010-05-06 00:08:46 +000014969 if (statvfs == NULL) {
14970 if (PyObject_DelAttrString(m, "statvfs") == -1) {
Victor Stinner1c2fa782020-05-10 11:05:29 +020014971 return -1;
Victor Stinner8c62be82010-05-06 00:08:46 +000014972 }
14973 }
Thomas Wouters477c8d52006-05-27 19:21:47 +000014974#endif /* HAVE_STATVFS */
14975
14976# ifdef HAVE_LCHOWN
Victor Stinner8c62be82010-05-06 00:08:46 +000014977 if (lchown == NULL) {
14978 if (PyObject_DelAttrString(m, "lchown") == -1) {
Victor Stinner1c2fa782020-05-10 11:05:29 +020014979 return -1;
Victor Stinner8c62be82010-05-06 00:08:46 +000014980 }
14981 }
Thomas Wouters477c8d52006-05-27 19:21:47 +000014982#endif /* HAVE_LCHOWN */
14983
14984
14985#endif /* __APPLE__ */
Antoine Pitroubcf2b592012-02-08 23:28:36 +010014986
Victor Stinner97f33c32020-05-14 18:05:58 +020014987 if ((state->billion = PyLong_FromLong(1000000000)) == NULL)
Victor Stinner1c2fa782020-05-10 11:05:29 +020014988 return -1;
Eddie Elizondob3966632019-11-05 07:16:14 -080014989#if defined(HAVE_WAIT3) || defined(HAVE_WAIT4)
Victor Stinner97f33c32020-05-14 18:05:58 +020014990 state->struct_rusage = PyUnicode_InternFromString("struct_rusage");
14991 if (state->struct_rusage == NULL)
Victor Stinner1c2fa782020-05-10 11:05:29 +020014992 return -1;
Eddie Elizondob3966632019-11-05 07:16:14 -080014993#endif
Victor Stinner97f33c32020-05-14 18:05:58 +020014994 state->st_mode = PyUnicode_InternFromString("st_mode");
14995 if (state->st_mode == NULL)
Victor Stinner1c2fa782020-05-10 11:05:29 +020014996 return -1;
Larry Hastings6fe20b32012-04-19 15:07:49 -070014997
Larry Hastings9cf065c2012-06-22 16:30:09 -070014998 /* suppress "function not used" warnings */
14999 {
15000 int ignored;
15001 fd_specified("", -1);
15002 follow_symlinks_specified("", 1);
15003 dir_fd_and_follow_symlinks_invalid("chmod", DEFAULT_DIR_FD, 1);
15004 dir_fd_converter(Py_None, &ignored);
15005 dir_fd_unavailable(Py_None, &ignored);
15006 }
15007
15008 /*
15009 * provide list of locally available functions
15010 * so os.py can populate support_* lists
15011 */
Victor Stinner97f33c32020-05-14 18:05:58 +020015012 PyObject *list = PyList_New(0);
15013 if (!list) {
Victor Stinner1c2fa782020-05-10 11:05:29 +020015014 return -1;
Victor Stinner97f33c32020-05-14 18:05:58 +020015015 }
15016 for (const char * const *trace = have_functions; *trace; trace++) {
Larry Hastings9cf065c2012-06-22 16:30:09 -070015017 PyObject *unicode = PyUnicode_DecodeASCII(*trace, strlen(*trace), NULL);
15018 if (!unicode)
Victor Stinner1c2fa782020-05-10 11:05:29 +020015019 return -1;
Larry Hastings9cf065c2012-06-22 16:30:09 -070015020 if (PyList_Append(list, unicode))
Victor Stinner1c2fa782020-05-10 11:05:29 +020015021 return -1;
Larry Hastings9cf065c2012-06-22 16:30:09 -070015022 Py_DECREF(unicode);
15023 }
15024 PyModule_AddObject(m, "_have_functions", list);
Ned Deilyeb3be662016-08-15 14:40:38 -040015025
Victor Stinner1c2fa782020-05-10 11:05:29 +020015026 return 0;
15027}
15028
15029
15030static PyModuleDef_Slot posixmodile_slots[] = {
15031 {Py_mod_exec, posixmodule_exec},
15032 {0, NULL}
15033};
15034
15035static struct PyModuleDef posixmodule = {
15036 PyModuleDef_HEAD_INIT,
15037 .m_name = MODNAME,
15038 .m_doc = posix__doc__,
15039 .m_size = sizeof(_posixstate),
15040 .m_methods = posix_methods,
15041 .m_slots = posixmodile_slots,
15042 .m_traverse = _posix_traverse,
15043 .m_clear = _posix_clear,
15044 .m_free = _posix_free,
15045};
15046
15047PyMODINIT_FUNC
15048INITFUNC(void)
15049{
15050 return PyModuleDef_Init(&posixmodule);
Guido van Rossumb6775db1994-08-01 11:34:53 +000015051}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000015052
15053#ifdef __cplusplus
15054}
15055#endif