blob: 79779bfdeafd3ad9f5f3512da75f9b4b8b4a6b32 [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
Victor Stinner317bab02020-06-02 18:44:54 +0200473 PyThreadState *tstate = _PyThreadState_GET();
474 _Py_EnsureTstateNotNULL(tstate);
475
476 status = _PyEval_ReInitThreads(tstate);
Victor Stinner26881c82020-06-02 15:51:37 +0200477 if (_PyStatus_EXCEPTION(status)) {
478 goto fatal_error;
479 }
480
481 status = _PyImport_ReInitLock();
482 if (_PyStatus_EXCEPTION(status)) {
483 goto fatal_error;
484 }
485
Antoine Pitrou346cbd32017-05-27 17:50:54 +0200486 _PySignal_AfterFork();
Victor Stinner26881c82020-06-02 15:51:37 +0200487
488 status = _PyRuntimeState_ReInitThreads(runtime);
489 if (_PyStatus_EXCEPTION(status)) {
490 goto fatal_error;
491 }
492
493 status = _PyInterpreterState_DeleteExceptMain(runtime);
494 if (_PyStatus_EXCEPTION(status)) {
495 goto fatal_error;
496 }
Victor Stinner317bab02020-06-02 18:44:54 +0200497 assert(_PyThreadState_GET() == tstate);
Antoine Pitrou346cbd32017-05-27 17:50:54 +0200498
Victor Stinner317bab02020-06-02 18:44:54 +0200499 run_at_forkers(tstate->interp->after_forkers_child, 0);
Victor Stinner26881c82020-06-02 15:51:37 +0200500 return;
501
502fatal_error:
503 Py_ExitStatusException(status);
Antoine Pitrou346cbd32017-05-27 17:50:54 +0200504}
505
506static int
507register_at_forker(PyObject **lst, PyObject *func)
508{
Gregory P. Smith163468a2017-05-29 10:03:41 -0700509 if (func == NULL) /* nothing to register? do nothing. */
510 return 0;
Antoine Pitrou346cbd32017-05-27 17:50:54 +0200511 if (*lst == NULL) {
512 *lst = PyList_New(0);
513 if (*lst == NULL)
514 return -1;
515 }
516 return PyList_Append(*lst, func);
517}
Victor Stinner87255be2020-04-07 23:11:49 +0200518#endif /* HAVE_FORK */
519
Antoine Pitrou346cbd32017-05-27 17:50:54 +0200520
521/* Legacy wrapper */
522void
523PyOS_AfterFork(void)
524{
525#ifdef HAVE_FORK
526 PyOS_AfterFork_Child();
527#endif
528}
529
530
Victor Stinner6036e442015-03-08 01:58:04 +0100531#ifdef MS_WINDOWS
Serhiy Storchaka06a13f82015-02-22 21:34:54 +0200532/* defined in fileutils.c */
Benjamin Petersone5024512018-09-12 12:06:42 -0700533void _Py_time_t_to_FILE_TIME(time_t, int, FILETIME *);
534void _Py_attribute_data_to_stat(BY_HANDLE_FILE_INFORMATION *,
Serhiy Storchaka06a13f82015-02-22 21:34:54 +0200535 ULONG, struct _Py_stat_struct *);
536#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -0700537
Larry Hastings9cf065c2012-06-22 16:30:09 -0700538
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200539#ifndef MS_WINDOWS
540PyObject *
541_PyLong_FromUid(uid_t uid)
542{
543 if (uid == (uid_t)-1)
544 return PyLong_FromLong(-1);
545 return PyLong_FromUnsignedLong(uid);
546}
547
548PyObject *
549_PyLong_FromGid(gid_t gid)
550{
551 if (gid == (gid_t)-1)
552 return PyLong_FromLong(-1);
553 return PyLong_FromUnsignedLong(gid);
554}
555
556int
557_Py_Uid_Converter(PyObject *obj, void *p)
558{
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700559 uid_t uid;
560 PyObject *index;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200561 int overflow;
Serhiy Storchakab4621892013-02-10 23:28:02 +0200562 long result;
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700563 unsigned long uresult;
564
Serhiy Storchaka5f4b229d2020-05-28 10:33:45 +0300565 index = _PyNumber_Index(obj);
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700566 if (index == NULL) {
567 PyErr_Format(PyExc_TypeError,
568 "uid should be integer, not %.200s",
Eddie Elizondob3966632019-11-05 07:16:14 -0800569 _PyType_Name(Py_TYPE(obj)));
Serhiy Storchakab4621892013-02-10 23:28:02 +0200570 return 0;
571 }
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700572
573 /*
574 * Handling uid_t is complicated for two reasons:
575 * * Although uid_t is (always?) unsigned, it still
576 * accepts -1.
577 * * We don't know its size in advance--it may be
578 * bigger than an int, or it may be smaller than
579 * a long.
580 *
581 * So a bit of defensive programming is in order.
582 * Start with interpreting the value passed
583 * in as a signed long and see if it works.
584 */
585
586 result = PyLong_AsLongAndOverflow(index, &overflow);
587
588 if (!overflow) {
589 uid = (uid_t)result;
590
591 if (result == -1) {
592 if (PyErr_Occurred())
593 goto fail;
594 /* It's a legitimate -1, we're done. */
595 goto success;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200596 }
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700597
598 /* Any other negative number is disallowed. */
599 if (result < 0)
600 goto underflow;
601
602 /* Ensure the value wasn't truncated. */
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200603 if (sizeof(uid_t) < sizeof(long) &&
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700604 (long)uid != result)
605 goto underflow;
606 goto success;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200607 }
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700608
609 if (overflow < 0)
610 goto underflow;
611
612 /*
613 * Okay, the value overflowed a signed long. If it
614 * fits in an *unsigned* long, it may still be okay,
615 * as uid_t may be unsigned long on this platform.
616 */
617 uresult = PyLong_AsUnsignedLong(index);
618 if (PyErr_Occurred()) {
619 if (PyErr_ExceptionMatches(PyExc_OverflowError))
620 goto overflow;
621 goto fail;
622 }
623
624 uid = (uid_t)uresult;
625
626 /*
627 * If uid == (uid_t)-1, the user actually passed in ULONG_MAX,
628 * but this value would get interpreted as (uid_t)-1 by chown
629 * and its siblings. That's not what the user meant! So we
630 * throw an overflow exception instead. (We already
Tim Golden23005082013-10-25 11:22:37 +0100631 * handled a real -1 with PyLong_AsLongAndOverflow() above.)
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700632 */
633 if (uid == (uid_t)-1)
634 goto overflow;
635
636 /* Ensure the value wasn't truncated. */
637 if (sizeof(uid_t) < sizeof(long) &&
638 (unsigned long)uid != uresult)
639 goto overflow;
640 /* fallthrough */
641
642success:
643 Py_DECREF(index);
644 *(uid_t *)p = uid;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200645 return 1;
646
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700647underflow:
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200648 PyErr_SetString(PyExc_OverflowError,
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700649 "uid is less than minimum");
650 goto fail;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200651
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700652overflow:
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200653 PyErr_SetString(PyExc_OverflowError,
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700654 "uid is greater than maximum");
655 /* fallthrough */
656
657fail:
658 Py_DECREF(index);
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200659 return 0;
660}
661
662int
663_Py_Gid_Converter(PyObject *obj, void *p)
664{
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700665 gid_t gid;
666 PyObject *index;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200667 int overflow;
Serhiy Storchakab4621892013-02-10 23:28:02 +0200668 long result;
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700669 unsigned long uresult;
670
Serhiy Storchaka5f4b229d2020-05-28 10:33:45 +0300671 index = _PyNumber_Index(obj);
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700672 if (index == NULL) {
673 PyErr_Format(PyExc_TypeError,
674 "gid should be integer, not %.200s",
Eddie Elizondob3966632019-11-05 07:16:14 -0800675 _PyType_Name(Py_TYPE(obj)));
Serhiy Storchakab4621892013-02-10 23:28:02 +0200676 return 0;
677 }
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700678
679 /*
680 * Handling gid_t is complicated for two reasons:
681 * * Although gid_t is (always?) unsigned, it still
682 * accepts -1.
683 * * We don't know its size in advance--it may be
684 * bigger than an int, or it may be smaller than
685 * a long.
686 *
687 * So a bit of defensive programming is in order.
688 * Start with interpreting the value passed
689 * in as a signed long and see if it works.
690 */
691
692 result = PyLong_AsLongAndOverflow(index, &overflow);
693
694 if (!overflow) {
695 gid = (gid_t)result;
696
697 if (result == -1) {
698 if (PyErr_Occurred())
699 goto fail;
700 /* It's a legitimate -1, we're done. */
701 goto success;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200702 }
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700703
704 /* Any other negative number is disallowed. */
705 if (result < 0) {
706 goto underflow;
707 }
708
709 /* Ensure the value wasn't truncated. */
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200710 if (sizeof(gid_t) < sizeof(long) &&
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700711 (long)gid != result)
712 goto underflow;
713 goto success;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200714 }
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700715
716 if (overflow < 0)
717 goto underflow;
718
719 /*
720 * Okay, the value overflowed a signed long. If it
721 * fits in an *unsigned* long, it may still be okay,
722 * as gid_t may be unsigned long on this platform.
723 */
724 uresult = PyLong_AsUnsignedLong(index);
725 if (PyErr_Occurred()) {
726 if (PyErr_ExceptionMatches(PyExc_OverflowError))
727 goto overflow;
728 goto fail;
729 }
730
731 gid = (gid_t)uresult;
732
733 /*
734 * If gid == (gid_t)-1, the user actually passed in ULONG_MAX,
735 * but this value would get interpreted as (gid_t)-1 by chown
736 * and its siblings. That's not what the user meant! So we
737 * throw an overflow exception instead. (We already
Tim Golden23005082013-10-25 11:22:37 +0100738 * handled a real -1 with PyLong_AsLongAndOverflow() above.)
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700739 */
740 if (gid == (gid_t)-1)
741 goto overflow;
742
743 /* Ensure the value wasn't truncated. */
744 if (sizeof(gid_t) < sizeof(long) &&
745 (unsigned long)gid != uresult)
746 goto overflow;
747 /* fallthrough */
748
749success:
750 Py_DECREF(index);
751 *(gid_t *)p = gid;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200752 return 1;
753
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700754underflow:
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200755 PyErr_SetString(PyExc_OverflowError,
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700756 "gid is less than minimum");
757 goto fail;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200758
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700759overflow:
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200760 PyErr_SetString(PyExc_OverflowError,
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700761 "gid is greater than maximum");
762 /* fallthrough */
763
764fail:
765 Py_DECREF(index);
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200766 return 0;
767}
768#endif /* MS_WINDOWS */
769
770
Benjamin Petersoned4aa832016-09-05 17:44:18 -0700771#define _PyLong_FromDev PyLong_FromLongLong
Gregory P. Smith702dada2015-01-28 16:07:52 -0800772
773
Serhiy Storchakab2653b32015-01-18 11:12:11 +0200774#if defined(HAVE_MKNOD) && defined(HAVE_MAKEDEV)
775static int
776_Py_Dev_Converter(PyObject *obj, void *p)
777{
Serhiy Storchakab2653b32015-01-18 11:12:11 +0200778 *((dev_t *)p) = PyLong_AsUnsignedLongLong(obj);
Serhiy Storchakab2653b32015-01-18 11:12:11 +0200779 if (PyErr_Occurred())
780 return 0;
781 return 1;
782}
Gregory P. Smith702dada2015-01-28 16:07:52 -0800783#endif /* HAVE_MKNOD && HAVE_MAKEDEV */
Serhiy Storchakab2653b32015-01-18 11:12:11 +0200784
785
Larry Hastings9cf065c2012-06-22 16:30:09 -0700786#ifdef AT_FDCWD
Trent Nelson9a461052012-09-18 21:50:06 -0400787/*
788 * Why the (int) cast? Solaris 10 defines AT_FDCWD as 0xffd19553 (-3041965);
789 * without the int cast, the value gets interpreted as uint (4291925331),
790 * which doesn't play nicely with all the initializer lines in this file that
791 * look like this:
792 * int dir_fd = DEFAULT_DIR_FD;
793 */
794#define DEFAULT_DIR_FD (int)AT_FDCWD
Larry Hastings9cf065c2012-06-22 16:30:09 -0700795#else
796#define DEFAULT_DIR_FD (-100)
797#endif
798
799static int
Serhiy Storchaka819399b2016-04-06 22:17:52 +0300800_fd_converter(PyObject *o, int *p)
Serhiy Storchakaa2ad5c32013-01-07 23:13:46 +0200801{
802 int overflow;
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700803 long long_value;
804
Serhiy Storchaka5f4b229d2020-05-28 10:33:45 +0300805 PyObject *index = _PyNumber_Index(o);
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700806 if (index == NULL) {
Larry Hastings9cf065c2012-06-22 16:30:09 -0700807 return 0;
808 }
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700809
Serhiy Storchaka819399b2016-04-06 22:17:52 +0300810 assert(PyLong_Check(index));
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700811 long_value = PyLong_AsLongAndOverflow(index, &overflow);
812 Py_DECREF(index);
Serhiy Storchaka819399b2016-04-06 22:17:52 +0300813 assert(!PyErr_Occurred());
Serhiy Storchakaa2ad5c32013-01-07 23:13:46 +0200814 if (overflow > 0 || long_value > INT_MAX) {
Larry Hastings9cf065c2012-06-22 16:30:09 -0700815 PyErr_SetString(PyExc_OverflowError,
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700816 "fd is greater than maximum");
Larry Hastings9cf065c2012-06-22 16:30:09 -0700817 return 0;
818 }
Serhiy Storchakaa2ad5c32013-01-07 23:13:46 +0200819 if (overflow < 0 || long_value < INT_MIN) {
Larry Hastings9cf065c2012-06-22 16:30:09 -0700820 PyErr_SetString(PyExc_OverflowError,
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700821 "fd is less than minimum");
Larry Hastings9cf065c2012-06-22 16:30:09 -0700822 return 0;
823 }
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700824
Larry Hastings9cf065c2012-06-22 16:30:09 -0700825 *p = (int)long_value;
826 return 1;
827}
828
829static int
Serhiy Storchakaa2ad5c32013-01-07 23:13:46 +0200830dir_fd_converter(PyObject *o, void *p)
831{
832 if (o == Py_None) {
833 *(int *)p = DEFAULT_DIR_FD;
834 return 1;
835 }
Serhiy Storchaka819399b2016-04-06 22:17:52 +0300836 else if (PyIndex_Check(o)) {
837 return _fd_converter(o, (int *)p);
838 }
839 else {
840 PyErr_Format(PyExc_TypeError,
841 "argument should be integer or None, not %.200s",
Eddie Elizondob3966632019-11-05 07:16:14 -0800842 _PyType_Name(Py_TYPE(o)));
Serhiy Storchaka819399b2016-04-06 22:17:52 +0300843 return 0;
844 }
Larry Hastings9cf065c2012-06-22 16:30:09 -0700845}
846
Eddie Elizondob3966632019-11-05 07:16:14 -0800847typedef struct {
848 PyObject *billion;
Eddie Elizondob3966632019-11-05 07:16:14 -0800849 PyObject *DirEntryType;
850 PyObject *ScandirIteratorType;
851#if defined(HAVE_SCHED_SETPARAM) || defined(HAVE_SCHED_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDPARAM)
852 PyObject *SchedParamType;
853#endif
854 PyObject *StatResultType;
855 PyObject *StatVFSResultType;
856 PyObject *TerminalSizeType;
857 PyObject *TimesResultType;
858 PyObject *UnameResultType;
859#if defined(HAVE_WAITID) && !defined(__APPLE__)
860 PyObject *WaitidResultType;
861#endif
862#if defined(HAVE_WAIT3) || defined(HAVE_WAIT4)
863 PyObject *struct_rusage;
864#endif
865 PyObject *st_mode;
866} _posixstate;
867
Eddie Elizondob3966632019-11-05 07:16:14 -0800868
Hai Shif707d942020-03-16 21:15:01 +0800869static inline _posixstate*
870get_posix_state(PyObject *module)
871{
872 void *state = PyModule_GetState(module);
873 assert(state != NULL);
874 return (_posixstate *)state;
875}
876
Larry Hastings9cf065c2012-06-22 16:30:09 -0700877/*
878 * A PyArg_ParseTuple "converter" function
879 * that handles filesystem paths in the manner
880 * preferred by the os module.
881 *
882 * path_converter accepts (Unicode) strings and their
883 * subclasses, and bytes and their subclasses. What
884 * it does with the argument depends on the platform:
885 *
886 * * On Windows, if we get a (Unicode) string we
887 * extract the wchar_t * and return it; if we get
Steve Dowercc16be82016-09-08 10:35:16 -0700888 * bytes we decode to wchar_t * and return that.
Larry Hastings9cf065c2012-06-22 16:30:09 -0700889 *
890 * * On all other platforms, strings are encoded
891 * to bytes using PyUnicode_FSConverter, then we
892 * extract the char * from the bytes object and
893 * return that.
894 *
895 * path_converter also optionally accepts signed
896 * integers (representing open file descriptors) instead
897 * of path strings.
898 *
899 * Input fields:
900 * path.nullable
901 * If nonzero, the path is permitted to be None.
902 * path.allow_fd
903 * If nonzero, the path is permitted to be a file handle
904 * (a signed int) instead of a string.
905 * path.function_name
906 * If non-NULL, path_converter will use that as the name
907 * of the function in error messages.
Larry Hastings31826802013-10-19 00:09:25 -0700908 * (If path.function_name is NULL it omits the function name.)
Larry Hastings9cf065c2012-06-22 16:30:09 -0700909 * path.argument_name
910 * If non-NULL, path_converter will use that as the name
911 * of the parameter in error messages.
912 * (If path.argument_name is NULL it uses "path".)
913 *
914 * Output fields:
915 * path.wide
916 * Points to the path if it was expressed as Unicode
917 * and was not encoded. (Only used on Windows.)
918 * path.narrow
919 * Points to the path if it was expressed as bytes,
Steve Dowercc16be82016-09-08 10:35:16 -0700920 * or it was Unicode and was encoded to bytes. (On Windows,
Martin Panterb1321fb2016-10-10 00:38:21 +0000921 * is a non-zero integer if the path was expressed as bytes.
Steve Dowercc16be82016-09-08 10:35:16 -0700922 * The type is deliberately incompatible to prevent misuse.)
Larry Hastings9cf065c2012-06-22 16:30:09 -0700923 * path.fd
924 * Contains a file descriptor if path.accept_fd was true
925 * and the caller provided a signed integer instead of any
926 * sort of string.
927 *
928 * WARNING: if your "path" parameter is optional, and is
929 * unspecified, path_converter will never get called.
930 * So if you set allow_fd, you *MUST* initialize path.fd = -1
931 * yourself!
932 * path.length
933 * The length of the path in characters, if specified as
934 * a string.
935 * path.object
Xiang Zhang04316c42017-01-08 23:26:57 +0800936 * The original object passed in (if get a PathLike object,
937 * the result of PyOS_FSPath() is treated as the original object).
938 * Own a reference to the object.
Larry Hastings9cf065c2012-06-22 16:30:09 -0700939 * path.cleanup
940 * For internal use only. May point to a temporary object.
941 * (Pay no attention to the man behind the curtain.)
942 *
943 * At most one of path.wide or path.narrow will be non-NULL.
944 * If path was None and path.nullable was set,
945 * or if path was an integer and path.allow_fd was set,
946 * both path.wide and path.narrow will be NULL
947 * and path.length will be 0.
Georg Brandlf7875592012-06-24 13:58:31 +0200948 *
Larry Hastings9cf065c2012-06-22 16:30:09 -0700949 * path_converter takes care to not write to the path_t
950 * unless it's successful. However it must reset the
951 * "cleanup" field each time it's called.
952 *
953 * Use as follows:
954 * path_t path;
955 * memset(&path, 0, sizeof(path));
956 * PyArg_ParseTuple(args, "O&", path_converter, &path);
957 * // ... use values from path ...
958 * path_cleanup(&path);
959 *
960 * (Note that if PyArg_Parse fails you don't need to call
961 * path_cleanup(). However it is safe to do so.)
962 */
963typedef struct {
Victor Stinner292c8352012-10-30 02:17:38 +0100964 const char *function_name;
965 const char *argument_name;
Larry Hastings9cf065c2012-06-22 16:30:09 -0700966 int nullable;
967 int allow_fd;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +0300968 const wchar_t *wide;
Steve Dowercc16be82016-09-08 10:35:16 -0700969#ifdef MS_WINDOWS
970 BOOL narrow;
971#else
Serhiy Storchakadeab18d2016-05-07 16:45:18 +0300972 const char *narrow;
Steve Dowercc16be82016-09-08 10:35:16 -0700973#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -0700974 int fd;
975 Py_ssize_t length;
976 PyObject *object;
977 PyObject *cleanup;
978} path_t;
979
Steve Dowercc16be82016-09-08 10:35:16 -0700980#ifdef MS_WINDOWS
981#define PATH_T_INITIALIZE(function_name, argument_name, nullable, allow_fd) \
982 {function_name, argument_name, nullable, allow_fd, NULL, FALSE, -1, 0, NULL, NULL}
983#else
Larry Hastings2f936352014-08-05 14:04:04 +1000984#define PATH_T_INITIALIZE(function_name, argument_name, nullable, allow_fd) \
985 {function_name, argument_name, nullable, allow_fd, NULL, NULL, -1, 0, NULL, NULL}
Steve Dowercc16be82016-09-08 10:35:16 -0700986#endif
Larry Hastings31826802013-10-19 00:09:25 -0700987
Larry Hastings9cf065c2012-06-22 16:30:09 -0700988static void
Xiang Zhang04316c42017-01-08 23:26:57 +0800989path_cleanup(path_t *path)
990{
991 Py_CLEAR(path->object);
992 Py_CLEAR(path->cleanup);
Larry Hastings9cf065c2012-06-22 16:30:09 -0700993}
994
995static int
Serhiy Storchaka819399b2016-04-06 22:17:52 +0300996path_converter(PyObject *o, void *p)
997{
Larry Hastings9cf065c2012-06-22 16:30:09 -0700998 path_t *path = (path_t *)p;
Xiang Zhang04316c42017-01-08 23:26:57 +0800999 PyObject *bytes = NULL;
1000 Py_ssize_t length = 0;
Brett Cannon3f9183b2016-08-26 14:44:48 -07001001 int is_index, is_buffer, is_bytes, is_unicode;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03001002 const char *narrow;
Steve Dowercc16be82016-09-08 10:35:16 -07001003#ifdef MS_WINDOWS
Xiang Zhang04316c42017-01-08 23:26:57 +08001004 PyObject *wo = NULL;
Steve Dowercc16be82016-09-08 10:35:16 -07001005 const wchar_t *wide;
1006#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07001007
1008#define FORMAT_EXCEPTION(exc, fmt) \
1009 PyErr_Format(exc, "%s%s" fmt, \
1010 path->function_name ? path->function_name : "", \
1011 path->function_name ? ": " : "", \
1012 path->argument_name ? path->argument_name : "path")
1013
1014 /* Py_CLEANUP_SUPPORTED support */
1015 if (o == NULL) {
1016 path_cleanup(path);
1017 return 1;
1018 }
1019
Brett Cannon3f9183b2016-08-26 14:44:48 -07001020 /* Ensure it's always safe to call path_cleanup(). */
Xiang Zhang04316c42017-01-08 23:26:57 +08001021 path->object = path->cleanup = NULL;
1022 /* path->object owns a reference to the original object */
1023 Py_INCREF(o);
Larry Hastings9cf065c2012-06-22 16:30:09 -07001024
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001025 if ((o == Py_None) && path->nullable) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07001026 path->wide = NULL;
Steve Dowercc16be82016-09-08 10:35:16 -07001027#ifdef MS_WINDOWS
1028 path->narrow = FALSE;
1029#else
Larry Hastings9cf065c2012-06-22 16:30:09 -07001030 path->narrow = NULL;
Steve Dowercc16be82016-09-08 10:35:16 -07001031#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07001032 path->fd = -1;
Xiang Zhang04316c42017-01-08 23:26:57 +08001033 goto success_exit;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001034 }
1035
Brett Cannon3f9183b2016-08-26 14:44:48 -07001036 /* Only call this here so that we don't treat the return value of
1037 os.fspath() as an fd or buffer. */
1038 is_index = path->allow_fd && PyIndex_Check(o);
1039 is_buffer = PyObject_CheckBuffer(o);
1040 is_bytes = PyBytes_Check(o);
1041 is_unicode = PyUnicode_Check(o);
1042
1043 if (!is_index && !is_buffer && !is_unicode && !is_bytes) {
1044 /* Inline PyOS_FSPath() for better error messages. */
Pablo Galindo09fbcd62019-02-18 10:46:34 +00001045 PyObject *func, *res;
Brett Cannon3f9183b2016-08-26 14:44:48 -07001046
1047 func = _PyObject_LookupSpecial(o, &PyId___fspath__);
1048 if (NULL == func) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001049 goto error_format;
Brett Cannon3f9183b2016-08-26 14:44:48 -07001050 }
Pablo Galindo09fbcd62019-02-18 10:46:34 +00001051 res = _PyObject_CallNoArg(func);
Brett Cannon3f9183b2016-08-26 14:44:48 -07001052 Py_DECREF(func);
Pablo Galindo09fbcd62019-02-18 10:46:34 +00001053 if (NULL == res) {
Brett Cannon3f9183b2016-08-26 14:44:48 -07001054 goto error_exit;
1055 }
Pablo Galindo09fbcd62019-02-18 10:46:34 +00001056 else if (PyUnicode_Check(res)) {
Brett Cannon3f9183b2016-08-26 14:44:48 -07001057 is_unicode = 1;
1058 }
Pablo Galindo09fbcd62019-02-18 10:46:34 +00001059 else if (PyBytes_Check(res)) {
Brett Cannon3f9183b2016-08-26 14:44:48 -07001060 is_bytes = 1;
1061 }
1062 else {
Pablo Galindo09fbcd62019-02-18 10:46:34 +00001063 PyErr_Format(PyExc_TypeError,
1064 "expected %.200s.__fspath__() to return str or bytes, "
Eddie Elizondob3966632019-11-05 07:16:14 -08001065 "not %.200s", _PyType_Name(Py_TYPE(o)),
1066 _PyType_Name(Py_TYPE(res)));
Pablo Galindo09fbcd62019-02-18 10:46:34 +00001067 Py_DECREF(res);
1068 goto error_exit;
Brett Cannon3f9183b2016-08-26 14:44:48 -07001069 }
Pablo Galindo09fbcd62019-02-18 10:46:34 +00001070
1071 /* still owns a reference to the original object */
1072 Py_DECREF(o);
1073 o = res;
Brett Cannon3f9183b2016-08-26 14:44:48 -07001074 }
1075
1076 if (is_unicode) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07001077#ifdef MS_WINDOWS
Victor Stinner26c03bd2016-09-19 11:55:44 +02001078 wide = PyUnicode_AsUnicodeAndSize(o, &length);
Victor Stinner59799a82013-11-13 14:17:30 +01001079 if (!wide) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001080 goto error_exit;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001081 }
Victor Stinner59799a82013-11-13 14:17:30 +01001082 if (length > 32767) {
1083 FORMAT_EXCEPTION(PyExc_ValueError, "%s too long for Windows");
Xiang Zhang04316c42017-01-08 23:26:57 +08001084 goto error_exit;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001085 }
Serhiy Storchaka2b0d2002015-04-20 09:53:58 +03001086 if (wcslen(wide) != length) {
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001087 FORMAT_EXCEPTION(PyExc_ValueError, "embedded null character in %s");
Xiang Zhang04316c42017-01-08 23:26:57 +08001088 goto error_exit;
Serhiy Storchaka2b0d2002015-04-20 09:53:58 +03001089 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07001090
1091 path->wide = wide;
Xiang Zhang04316c42017-01-08 23:26:57 +08001092 path->narrow = FALSE;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001093 path->fd = -1;
Xiang Zhang04316c42017-01-08 23:26:57 +08001094 goto success_exit;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001095#else
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001096 if (!PyUnicode_FSConverter(o, &bytes)) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001097 goto error_exit;
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001098 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07001099#endif
1100 }
Brett Cannon3f9183b2016-08-26 14:44:48 -07001101 else if (is_bytes) {
Serhiy Storchakad73c3182016-08-06 23:22:08 +03001102 bytes = o;
1103 Py_INCREF(bytes);
1104 }
Brett Cannon3f9183b2016-08-26 14:44:48 -07001105 else if (is_buffer) {
Serhiy Storchaka1180e5a2017-07-11 06:36:46 +03001106 /* XXX Replace PyObject_CheckBuffer with PyBytes_Check in other code
Ville Skyttä49b27342017-08-03 09:00:59 +03001107 after removing support of non-bytes buffer objects. */
Serhiy Storchakad73c3182016-08-06 23:22:08 +03001108 if (PyErr_WarnFormat(PyExc_DeprecationWarning, 1,
1109 "%s%s%s should be %s, not %.200s",
1110 path->function_name ? path->function_name : "",
1111 path->function_name ? ": " : "",
1112 path->argument_name ? path->argument_name : "path",
Brett Cannon3f9183b2016-08-26 14:44:48 -07001113 path->allow_fd && path->nullable ? "string, bytes, os.PathLike, "
1114 "integer or None" :
1115 path->allow_fd ? "string, bytes, os.PathLike or integer" :
1116 path->nullable ? "string, bytes, os.PathLike or None" :
1117 "string, bytes or os.PathLike",
Eddie Elizondob3966632019-11-05 07:16:14 -08001118 _PyType_Name(Py_TYPE(o)))) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001119 goto error_exit;
Serhiy Storchakad73c3182016-08-06 23:22:08 +03001120 }
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001121 bytes = PyBytes_FromObject(o);
Larry Hastings9cf065c2012-06-22 16:30:09 -07001122 if (!bytes) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001123 goto error_exit;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001124 }
1125 }
Steve Dowercc16be82016-09-08 10:35:16 -07001126 else if (is_index) {
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001127 if (!_fd_converter(o, &path->fd)) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001128 goto error_exit;
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001129 }
1130 path->wide = NULL;
Steve Dowercc16be82016-09-08 10:35:16 -07001131#ifdef MS_WINDOWS
1132 path->narrow = FALSE;
1133#else
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001134 path->narrow = NULL;
Steve Dowercc16be82016-09-08 10:35:16 -07001135#endif
Xiang Zhang04316c42017-01-08 23:26:57 +08001136 goto success_exit;
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001137 }
1138 else {
Xiang Zhang04316c42017-01-08 23:26:57 +08001139 error_format:
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001140 PyErr_Format(PyExc_TypeError, "%s%s%s should be %s, not %.200s",
1141 path->function_name ? path->function_name : "",
1142 path->function_name ? ": " : "",
1143 path->argument_name ? path->argument_name : "path",
Brett Cannon3f9183b2016-08-26 14:44:48 -07001144 path->allow_fd && path->nullable ? "string, bytes, os.PathLike, "
1145 "integer or None" :
1146 path->allow_fd ? "string, bytes, os.PathLike or integer" :
1147 path->nullable ? "string, bytes, os.PathLike or None" :
1148 "string, bytes or os.PathLike",
Eddie Elizondob3966632019-11-05 07:16:14 -08001149 _PyType_Name(Py_TYPE(o)));
Xiang Zhang04316c42017-01-08 23:26:57 +08001150 goto error_exit;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001151 }
1152
Larry Hastings9cf065c2012-06-22 16:30:09 -07001153 length = PyBytes_GET_SIZE(bytes);
Larry Hastings9cf065c2012-06-22 16:30:09 -07001154 narrow = PyBytes_AS_STRING(bytes);
Victor Stinner706768c2014-08-16 01:03:39 +02001155 if ((size_t)length != strlen(narrow)) {
Serhiy Storchakad8a14472014-09-06 20:07:17 +03001156 FORMAT_EXCEPTION(PyExc_ValueError, "embedded null character in %s");
Xiang Zhang04316c42017-01-08 23:26:57 +08001157 goto error_exit;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001158 }
1159
Steve Dowercc16be82016-09-08 10:35:16 -07001160#ifdef MS_WINDOWS
1161 wo = PyUnicode_DecodeFSDefaultAndSize(
1162 narrow,
1163 length
1164 );
1165 if (!wo) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001166 goto error_exit;
Steve Dowercc16be82016-09-08 10:35:16 -07001167 }
1168
Xiang Zhang04316c42017-01-08 23:26:57 +08001169 wide = PyUnicode_AsUnicodeAndSize(wo, &length);
Steve Dowercc16be82016-09-08 10:35:16 -07001170 if (!wide) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001171 goto error_exit;
Steve Dowercc16be82016-09-08 10:35:16 -07001172 }
1173 if (length > 32767) {
1174 FORMAT_EXCEPTION(PyExc_ValueError, "%s too long for Windows");
Xiang Zhang04316c42017-01-08 23:26:57 +08001175 goto error_exit;
Steve Dowercc16be82016-09-08 10:35:16 -07001176 }
1177 if (wcslen(wide) != length) {
1178 FORMAT_EXCEPTION(PyExc_ValueError, "embedded null character in %s");
Xiang Zhang04316c42017-01-08 23:26:57 +08001179 goto error_exit;
Steve Dowercc16be82016-09-08 10:35:16 -07001180 }
1181 path->wide = wide;
1182 path->narrow = TRUE;
Xiang Zhang04316c42017-01-08 23:26:57 +08001183 path->cleanup = wo;
1184 Py_DECREF(bytes);
Steve Dowercc16be82016-09-08 10:35:16 -07001185#else
Larry Hastings9cf065c2012-06-22 16:30:09 -07001186 path->wide = NULL;
1187 path->narrow = narrow;
Serhiy Storchakad73c3182016-08-06 23:22:08 +03001188 if (bytes == o) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001189 /* Still a reference owned by path->object, don't have to
1190 worry about path->narrow is used after free. */
Serhiy Storchakad73c3182016-08-06 23:22:08 +03001191 Py_DECREF(bytes);
Serhiy Storchakad73c3182016-08-06 23:22:08 +03001192 }
1193 else {
1194 path->cleanup = bytes;
Serhiy Storchakad73c3182016-08-06 23:22:08 +03001195 }
Xiang Zhang04316c42017-01-08 23:26:57 +08001196#endif
1197 path->fd = -1;
1198
1199 success_exit:
1200 path->length = length;
1201 path->object = o;
1202 return Py_CLEANUP_SUPPORTED;
1203
1204 error_exit:
1205 Py_XDECREF(o);
1206 Py_XDECREF(bytes);
1207#ifdef MS_WINDOWS
1208 Py_XDECREF(wo);
1209#endif
1210 return 0;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001211}
1212
1213static void
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001214argument_unavailable_error(const char *function_name, const char *argument_name)
1215{
Larry Hastings9cf065c2012-06-22 16:30:09 -07001216 PyErr_Format(PyExc_NotImplementedError,
1217 "%s%s%s unavailable on this platform",
1218 (function_name != NULL) ? function_name : "",
1219 (function_name != NULL) ? ": ": "",
1220 argument_name);
1221}
1222
1223static int
Serhiy Storchakaa2ad5c32013-01-07 23:13:46 +02001224dir_fd_unavailable(PyObject *o, void *p)
1225{
1226 int dir_fd;
1227 if (!dir_fd_converter(o, &dir_fd))
Larry Hastings9cf065c2012-06-22 16:30:09 -07001228 return 0;
Serhiy Storchakaa2ad5c32013-01-07 23:13:46 +02001229 if (dir_fd != DEFAULT_DIR_FD) {
1230 argument_unavailable_error(NULL, "dir_fd");
1231 return 0;
1232 }
1233 *(int *)p = dir_fd;
1234 return 1;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001235}
1236
1237static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001238fd_specified(const char *function_name, int fd)
1239{
Larry Hastings9cf065c2012-06-22 16:30:09 -07001240 if (fd == -1)
1241 return 0;
1242
1243 argument_unavailable_error(function_name, "fd");
1244 return 1;
1245}
1246
1247static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001248follow_symlinks_specified(const char *function_name, int follow_symlinks)
1249{
Larry Hastings9cf065c2012-06-22 16:30:09 -07001250 if (follow_symlinks)
1251 return 0;
1252
1253 argument_unavailable_error(function_name, "follow_symlinks");
1254 return 1;
1255}
1256
1257static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001258path_and_dir_fd_invalid(const char *function_name, path_t *path, int dir_fd)
1259{
Steve Dowercc16be82016-09-08 10:35:16 -07001260 if (!path->wide && (dir_fd != DEFAULT_DIR_FD)
1261#ifndef MS_WINDOWS
1262 && !path->narrow
1263#endif
1264 ) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07001265 PyErr_Format(PyExc_ValueError,
1266 "%s: can't specify dir_fd without matching path",
1267 function_name);
1268 return 1;
1269 }
1270 return 0;
1271}
1272
1273static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001274dir_fd_and_fd_invalid(const char *function_name, int dir_fd, int fd)
1275{
Larry Hastings9cf065c2012-06-22 16:30:09 -07001276 if ((dir_fd != DEFAULT_DIR_FD) && (fd != -1)) {
1277 PyErr_Format(PyExc_ValueError,
1278 "%s: can't specify both dir_fd and fd",
1279 function_name);
1280 return 1;
1281 }
1282 return 0;
1283}
1284
1285static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001286fd_and_follow_symlinks_invalid(const char *function_name, int fd,
1287 int follow_symlinks)
1288{
Larry Hastings9cf065c2012-06-22 16:30:09 -07001289 if ((fd > 0) && (!follow_symlinks)) {
1290 PyErr_Format(PyExc_ValueError,
1291 "%s: cannot use fd and follow_symlinks together",
1292 function_name);
1293 return 1;
1294 }
1295 return 0;
1296}
1297
1298static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001299dir_fd_and_follow_symlinks_invalid(const char *function_name, int dir_fd,
1300 int follow_symlinks)
1301{
Larry Hastings9cf065c2012-06-22 16:30:09 -07001302 if ((dir_fd != DEFAULT_DIR_FD) && (!follow_symlinks)) {
1303 PyErr_Format(PyExc_ValueError,
1304 "%s: cannot use dir_fd and follow_symlinks together",
1305 function_name);
1306 return 1;
1307 }
1308 return 0;
1309}
1310
Larry Hastings2f936352014-08-05 14:04:04 +10001311#ifdef MS_WINDOWS
Benjamin Petersonaf580df2016-09-06 10:46:49 -07001312 typedef long long Py_off_t;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00001313#else
Larry Hastings2f936352014-08-05 14:04:04 +10001314 typedef off_t Py_off_t;
1315#endif
1316
1317static int
1318Py_off_t_converter(PyObject *arg, void *addr)
1319{
1320#ifdef HAVE_LARGEFILE_SUPPORT
1321 *((Py_off_t *)addr) = PyLong_AsLongLong(arg);
1322#else
1323 *((Py_off_t *)addr) = PyLong_AsLong(arg);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00001324#endif
1325 if (PyErr_Occurred())
1326 return 0;
1327 return 1;
1328}
Larry Hastings2f936352014-08-05 14:04:04 +10001329
1330static PyObject *
1331PyLong_FromPy_off_t(Py_off_t offset)
1332{
1333#ifdef HAVE_LARGEFILE_SUPPORT
1334 return PyLong_FromLongLong(offset);
1335#else
1336 return PyLong_FromLong(offset);
Ross Lagerwallb1e5d592011-09-19 08:30:43 +02001337#endif
Larry Hastings2f936352014-08-05 14:04:04 +10001338}
1339
Serhiy Storchakad54cfb12018-05-08 07:48:50 +03001340#ifdef HAVE_SIGSET_T
1341/* Convert an iterable of integers to a sigset.
1342 Return 1 on success, return 0 and raise an exception on error. */
1343int
1344_Py_Sigset_Converter(PyObject *obj, void *addr)
1345{
1346 sigset_t *mask = (sigset_t *)addr;
1347 PyObject *iterator, *item;
1348 long signum;
1349 int overflow;
1350
Rémi Lapeyref0900192019-05-04 01:30:53 +02001351 // The extra parens suppress the unreachable-code warning with clang on MacOS
1352 if (sigemptyset(mask) < (0)) {
Serhiy Storchakad54cfb12018-05-08 07:48:50 +03001353 /* Probably only if mask == NULL. */
1354 PyErr_SetFromErrno(PyExc_OSError);
1355 return 0;
1356 }
1357
1358 iterator = PyObject_GetIter(obj);
1359 if (iterator == NULL) {
1360 return 0;
1361 }
1362
1363 while ((item = PyIter_Next(iterator)) != NULL) {
1364 signum = PyLong_AsLongAndOverflow(item, &overflow);
1365 Py_DECREF(item);
1366 if (signum <= 0 || signum >= NSIG) {
1367 if (overflow || signum != -1 || !PyErr_Occurred()) {
1368 PyErr_Format(PyExc_ValueError,
1369 "signal number %ld out of range", signum);
1370 }
1371 goto error;
1372 }
1373 if (sigaddset(mask, (int)signum)) {
1374 if (errno != EINVAL) {
1375 /* Probably impossible */
1376 PyErr_SetFromErrno(PyExc_OSError);
1377 goto error;
1378 }
1379 /* For backwards compatibility, allow idioms such as
1380 * `range(1, NSIG)` but warn about invalid signal numbers
1381 */
1382 const char msg[] =
1383 "invalid signal number %ld, please use valid_signals()";
1384 if (PyErr_WarnFormat(PyExc_RuntimeWarning, 1, msg, signum)) {
1385 goto error;
1386 }
1387 }
1388 }
1389 if (!PyErr_Occurred()) {
1390 Py_DECREF(iterator);
1391 return 1;
1392 }
1393
1394error:
1395 Py_DECREF(iterator);
1396 return 0;
1397}
1398#endif /* HAVE_SIGSET_T */
1399
Brian Curtinfc1be6d2010-11-24 13:23:18 +00001400#ifdef MS_WINDOWS
Brian Curtinf5e76d02010-11-24 13:14:05 +00001401
1402static int
Brian Curtind25aef52011-06-13 15:16:04 -05001403win32_get_reparse_tag(HANDLE reparse_point_handle, ULONG *reparse_tag)
Brian Curtinf5e76d02010-11-24 13:14:05 +00001404{
Martin Panter70214ad2016-08-04 02:38:59 +00001405 char target_buffer[_Py_MAXIMUM_REPARSE_DATA_BUFFER_SIZE];
1406 _Py_REPARSE_DATA_BUFFER *rdb = (_Py_REPARSE_DATA_BUFFER *)target_buffer;
Brian Curtinf5e76d02010-11-24 13:14:05 +00001407 DWORD n_bytes_returned;
Brian Curtinf5e76d02010-11-24 13:14:05 +00001408
1409 if (0 == DeviceIoControl(
1410 reparse_point_handle,
1411 FSCTL_GET_REPARSE_POINT,
1412 NULL, 0, /* in buffer */
1413 target_buffer, sizeof(target_buffer),
1414 &n_bytes_returned,
1415 NULL)) /* we're not using OVERLAPPED_IO */
Brian Curtind25aef52011-06-13 15:16:04 -05001416 return FALSE;
Brian Curtinf5e76d02010-11-24 13:14:05 +00001417
1418 if (reparse_tag)
1419 *reparse_tag = rdb->ReparseTag;
1420
Brian Curtind25aef52011-06-13 15:16:04 -05001421 return TRUE;
Brian Curtinf5e76d02010-11-24 13:14:05 +00001422}
Victor Stinner1ab6c2d2011-11-15 22:27:41 +01001423
Brian Curtinfc1be6d2010-11-24 13:23:18 +00001424#endif /* MS_WINDOWS */
Brian Curtinf5e76d02010-11-24 13:14:05 +00001425
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001426/* Return a dictionary corresponding to the POSIX environment table */
Ronald Oussoren697e56d2013-01-25 17:57:13 +01001427#if defined(WITH_NEXT_FRAMEWORK) || (defined(__APPLE__) && defined(Py_ENABLE_SHARED))
Jack Jansenea0c3822002-08-01 21:57:49 +00001428/* On Darwin/MacOSX a shared library or framework has no access to
Ronald Oussoren697e56d2013-01-25 17:57:13 +01001429** environ directly, we must obtain it with _NSGetEnviron(). See also
1430** man environ(7).
Jack Jansenea0c3822002-08-01 21:57:49 +00001431*/
1432#include <crt_externs.h>
pxinwrf2d7ac72019-05-21 18:46:37 +08001433#elif !defined(_MSC_VER) && (!defined(__WATCOMC__) || defined(__QNX__) || defined(__VXWORKS__))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001434extern char **environ;
Guido van Rossuma4916fa1996-05-23 22:58:55 +00001435#endif /* !_MSC_VER */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001436
Barry Warsaw53699e91996-12-10 23:23:01 +00001437static PyObject *
Thomas Woutersf3f33dc2000-07-21 06:00:07 +00001438convertenviron(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001439{
Victor Stinner8c62be82010-05-06 00:08:46 +00001440 PyObject *d;
Thomas Hellerf78f12a2007-11-08 19:33:05 +00001441#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00001442 wchar_t **e;
Thomas Hellerf78f12a2007-11-08 19:33:05 +00001443#else
Victor Stinner8c62be82010-05-06 00:08:46 +00001444 char **e;
Thomas Hellerf78f12a2007-11-08 19:33:05 +00001445#endif
Guido van Rossumd48f2521997-12-05 22:19:34 +00001446
Victor Stinner8c62be82010-05-06 00:08:46 +00001447 d = PyDict_New();
1448 if (d == NULL)
1449 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00001450#ifdef MS_WINDOWS
1451 /* _wenviron must be initialized in this way if the program is started
1452 through main() instead of wmain(). */
1453 _wgetenv(L"");
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001454 e = _wenviron;
Benoit Hudson723f71a2019-12-06 14:15:03 -05001455#elif defined(WITH_NEXT_FRAMEWORK) || (defined(__APPLE__) && defined(Py_ENABLE_SHARED))
1456 /* environ is not accessible as an extern in a shared object on OSX; use
1457 _NSGetEnviron to resolve it. The value changes if you add environment
1458 variables between calls to Py_Initialize, so don't cache the value. */
1459 e = *_NSGetEnviron();
Victor Stinner8c62be82010-05-06 00:08:46 +00001460#else
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001461 e = environ;
1462#endif
1463 if (e == NULL)
Victor Stinner8c62be82010-05-06 00:08:46 +00001464 return d;
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001465 for (; *e != NULL; e++) {
Victor Stinner8c62be82010-05-06 00:08:46 +00001466 PyObject *k;
1467 PyObject *v;
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001468#ifdef MS_WINDOWS
1469 const wchar_t *p = wcschr(*e, L'=');
1470#else
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03001471 const char *p = strchr(*e, '=');
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001472#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00001473 if (p == NULL)
1474 continue;
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001475#ifdef MS_WINDOWS
1476 k = PyUnicode_FromWideChar(*e, (Py_ssize_t)(p-*e));
1477#else
Victor Stinner84ae1182010-05-06 22:05:07 +00001478 k = PyBytes_FromStringAndSize(*e, (int)(p-*e));
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001479#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00001480 if (k == NULL) {
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001481 Py_DECREF(d);
1482 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00001483 }
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001484#ifdef MS_WINDOWS
1485 v = PyUnicode_FromWideChar(p+1, wcslen(p+1));
1486#else
Victor Stinner84ae1182010-05-06 22:05:07 +00001487 v = PyBytes_FromStringAndSize(p+1, strlen(p+1));
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001488#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00001489 if (v == NULL) {
Victor Stinner8c62be82010-05-06 00:08:46 +00001490 Py_DECREF(k);
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001491 Py_DECREF(d);
1492 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00001493 }
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001494 if (PyDict_GetItemWithError(d, k) == NULL) {
1495 if (PyErr_Occurred() || PyDict_SetItem(d, k, v) != 0) {
1496 Py_DECREF(v);
1497 Py_DECREF(k);
1498 Py_DECREF(d);
1499 return NULL;
1500 }
Victor Stinner8c62be82010-05-06 00:08:46 +00001501 }
1502 Py_DECREF(k);
1503 Py_DECREF(v);
Guido van Rossumd48f2521997-12-05 22:19:34 +00001504 }
Victor Stinner8c62be82010-05-06 00:08:46 +00001505 return d;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001506}
1507
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001508/* Set a POSIX-specific error from errno, and return NULL */
1509
Barry Warsawd58d7641998-07-23 16:14:40 +00001510static PyObject *
Thomas Woutersf3f33dc2000-07-21 06:00:07 +00001511posix_error(void)
Guido van Rossumad0ee831995-03-01 10:34:45 +00001512{
Victor Stinner8c62be82010-05-06 00:08:46 +00001513 return PyErr_SetFromErrno(PyExc_OSError);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001514}
Mark Hammondef8b6542001-05-13 08:04:26 +00001515
Martin v. Löwis6238d2b2002-06-30 15:26:10 +00001516#ifdef MS_WINDOWS
Fredrik Lundhffb9c772000-07-09 14:49:51 +00001517static PyObject *
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001518win32_error(const char* function, const char* filename)
Fredrik Lundhffb9c772000-07-09 14:49:51 +00001519{
Victor Stinner8c62be82010-05-06 00:08:46 +00001520 /* XXX We should pass the function name along in the future.
1521 (winreg.c also wants to pass the function name.)
1522 This would however require an additional param to the
1523 Windows error object, which is non-trivial.
1524 */
1525 errno = GetLastError();
1526 if (filename)
1527 return PyErr_SetFromWindowsErrWithFilename(errno, filename);
1528 else
1529 return PyErr_SetFromWindowsErr(errno);
Fredrik Lundhffb9c772000-07-09 14:49:51 +00001530}
Mark Hammondc2e85bd2002-10-03 05:10:39 +00001531
Mark Hammondc2e85bd2002-10-03 05:10:39 +00001532static PyObject *
Steve Dower2438cdf2019-03-29 16:37:16 -07001533win32_error_object_err(const char* function, PyObject* filename, DWORD err)
Victor Stinnereb5657a2011-09-30 01:44:27 +02001534{
1535 /* XXX - see win32_error for comments on 'function' */
Victor Stinnereb5657a2011-09-30 01:44:27 +02001536 if (filename)
1537 return PyErr_SetExcFromWindowsErrWithFilenameObject(
Andrew Svetlov2606a6f2012-12-19 14:33:35 +02001538 PyExc_OSError,
Steve Dower2438cdf2019-03-29 16:37:16 -07001539 err,
Victor Stinnereb5657a2011-09-30 01:44:27 +02001540 filename);
1541 else
Steve Dower2438cdf2019-03-29 16:37:16 -07001542 return PyErr_SetFromWindowsErr(err);
1543}
1544
1545static PyObject *
1546win32_error_object(const char* function, PyObject* filename)
1547{
1548 errno = GetLastError();
1549 return win32_error_object_err(function, filename, errno);
Victor Stinnereb5657a2011-09-30 01:44:27 +02001550}
1551
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00001552#endif /* MS_WINDOWS */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001553
Larry Hastings9cf065c2012-06-22 16:30:09 -07001554static PyObject *
Alexey Izbyshev83460312018-10-20 03:28:22 +03001555posix_path_object_error(PyObject *path)
1556{
1557 return PyErr_SetFromErrnoWithFilenameObject(PyExc_OSError, path);
1558}
1559
1560static PyObject *
Serhiy Storchaka2674bc72016-10-08 20:16:57 +03001561path_object_error(PyObject *path)
Larry Hastings9cf065c2012-06-22 16:30:09 -07001562{
1563#ifdef MS_WINDOWS
Serhiy Storchaka2674bc72016-10-08 20:16:57 +03001564 return PyErr_SetExcFromWindowsErrWithFilenameObject(
1565 PyExc_OSError, 0, path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07001566#else
Alexey Izbyshev83460312018-10-20 03:28:22 +03001567 return posix_path_object_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07001568#endif
1569}
1570
Serhiy Storchaka2674bc72016-10-08 20:16:57 +03001571static PyObject *
1572path_object_error2(PyObject *path, PyObject *path2)
1573{
1574#ifdef MS_WINDOWS
1575 return PyErr_SetExcFromWindowsErrWithFilenameObjects(
1576 PyExc_OSError, 0, path, path2);
1577#else
1578 return PyErr_SetFromErrnoWithFilenameObjects(PyExc_OSError, path, path2);
1579#endif
1580}
1581
1582static PyObject *
1583path_error(path_t *path)
1584{
1585 return path_object_error(path->object);
1586}
Larry Hastings31826802013-10-19 00:09:25 -07001587
Larry Hastingsb0827312014-02-09 22:05:19 -08001588static PyObject *
Alexey Izbyshev83460312018-10-20 03:28:22 +03001589posix_path_error(path_t *path)
1590{
1591 return posix_path_object_error(path->object);
1592}
1593
1594static PyObject *
Larry Hastingsb0827312014-02-09 22:05:19 -08001595path_error2(path_t *path, path_t *path2)
1596{
Serhiy Storchaka2674bc72016-10-08 20:16:57 +03001597 return path_object_error2(path->object, path2->object);
Larry Hastingsb0827312014-02-09 22:05:19 -08001598}
1599
1600
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001601/* POSIX generic methods */
1602
Larry Hastings2f936352014-08-05 14:04:04 +10001603static int
1604fildes_converter(PyObject *o, void *p)
Fred Drake4d1e64b2002-04-15 19:40:07 +00001605{
Victor Stinner8c62be82010-05-06 00:08:46 +00001606 int fd;
Larry Hastings2f936352014-08-05 14:04:04 +10001607 int *pointer = (int *)p;
1608 fd = PyObject_AsFileDescriptor(o);
Victor Stinner8c62be82010-05-06 00:08:46 +00001609 if (fd < 0)
Larry Hastings2f936352014-08-05 14:04:04 +10001610 return 0;
Larry Hastings2f936352014-08-05 14:04:04 +10001611 *pointer = fd;
1612 return 1;
1613}
1614
1615static PyObject *
1616posix_fildes_fd(int fd, int (*func)(int))
1617{
1618 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00001619 int async_err = 0;
1620
1621 do {
1622 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04001623 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00001624 res = (*func)(fd);
Steve Dower8fc89802015-04-12 00:26:27 -04001625 _Py_END_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00001626 Py_END_ALLOW_THREADS
1627 } while (res != 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
1628 if (res != 0)
1629 return (!async_err) ? posix_error() : NULL;
1630 Py_RETURN_NONE;
Fred Drake4d1e64b2002-04-15 19:40:07 +00001631}
Guido van Rossum21142a01999-01-08 21:05:37 +00001632
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001633
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00001634#ifdef MS_WINDOWS
Thomas Wouters477c8d52006-05-27 19:21:47 +00001635/* This is a reimplementation of the C library's chdir function,
1636 but one that produces Win32 errors instead of DOS error codes.
1637 chdir is essentially a wrapper around SetCurrentDirectory; however,
1638 it also needs to set "magic" environment variables indicating
1639 the per-drive current directory, which are of the form =<drive>: */
Benjamin Peterson206e3072008-10-19 14:07:49 +00001640static BOOL __stdcall
Thomas Wouters477c8d52006-05-27 19:21:47 +00001641win32_wchdir(LPCWSTR path)
1642{
Victor Stinnered537822015-12-13 21:40:26 +01001643 wchar_t path_buf[MAX_PATH], *new_path = path_buf;
Victor Stinner8c62be82010-05-06 00:08:46 +00001644 int result;
1645 wchar_t env[4] = L"=x:";
Thomas Wouters477c8d52006-05-27 19:21:47 +00001646
Victor Stinner8c62be82010-05-06 00:08:46 +00001647 if(!SetCurrentDirectoryW(path))
1648 return FALSE;
Victor Stinnered537822015-12-13 21:40:26 +01001649 result = GetCurrentDirectoryW(Py_ARRAY_LENGTH(path_buf), new_path);
Victor Stinner8c62be82010-05-06 00:08:46 +00001650 if (!result)
1651 return FALSE;
Victor Stinnere847d712015-12-14 00:21:50 +01001652 if (result > Py_ARRAY_LENGTH(path_buf)) {
Victor Stinnerb6404912013-07-07 16:21:41 +02001653 new_path = PyMem_RawMalloc(result * sizeof(wchar_t));
Victor Stinner8c62be82010-05-06 00:08:46 +00001654 if (!new_path) {
1655 SetLastError(ERROR_OUTOFMEMORY);
1656 return FALSE;
1657 }
1658 result = GetCurrentDirectoryW(result, new_path);
1659 if (!result) {
Victor Stinnerb6404912013-07-07 16:21:41 +02001660 PyMem_RawFree(new_path);
Victor Stinner8c62be82010-05-06 00:08:46 +00001661 return FALSE;
1662 }
1663 }
Alexey Izbyshev3e197c72018-03-01 12:13:56 +03001664 int is_unc_like_path = (wcsncmp(new_path, L"\\\\", 2) == 0 ||
1665 wcsncmp(new_path, L"//", 2) == 0);
1666 if (!is_unc_like_path) {
1667 env[1] = new_path[0];
1668 result = SetEnvironmentVariableW(env, new_path);
1669 }
Victor Stinnered537822015-12-13 21:40:26 +01001670 if (new_path != path_buf)
Victor Stinnerb6404912013-07-07 16:21:41 +02001671 PyMem_RawFree(new_path);
Alexey Izbyshev3e197c72018-03-01 12:13:56 +03001672 return result ? TRUE : FALSE;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001673}
1674#endif
1675
Martin v. Löwis14694662006-02-03 12:54:16 +00001676#ifdef MS_WINDOWS
1677/* The CRT of Windows has a number of flaws wrt. its stat() implementation:
1678 - time stamps are restricted to second resolution
1679 - file modification times suffer from forth-and-back conversions between
1680 UTC and local time
1681 Therefore, we implement our own stat, based on the Win32 API directly.
1682*/
Victor Stinner8c62be82010-05-06 00:08:46 +00001683#define HAVE_STAT_NSEC 1
Zachary Ware63f277b2014-06-19 09:46:37 -05001684#define HAVE_STRUCT_STAT_ST_FILE_ATTRIBUTES 1
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001685#define HAVE_STRUCT_STAT_ST_REPARSE_TAG 1
Martin v. Löwis14694662006-02-03 12:54:16 +00001686
Victor Stinner6036e442015-03-08 01:58:04 +01001687static void
Steve Dowercc16be82016-09-08 10:35:16 -07001688find_data_to_file_info(WIN32_FIND_DATAW *pFileData,
1689 BY_HANDLE_FILE_INFORMATION *info,
1690 ULONG *reparse_tag)
Victor Stinner6036e442015-03-08 01:58:04 +01001691{
1692 memset(info, 0, sizeof(*info));
1693 info->dwFileAttributes = pFileData->dwFileAttributes;
1694 info->ftCreationTime = pFileData->ftCreationTime;
1695 info->ftLastAccessTime = pFileData->ftLastAccessTime;
1696 info->ftLastWriteTime = pFileData->ftLastWriteTime;
1697 info->nFileSizeHigh = pFileData->nFileSizeHigh;
1698 info->nFileSizeLow = pFileData->nFileSizeLow;
1699/* info->nNumberOfLinks = 1; */
1700 if (pFileData->dwFileAttributes & FILE_ATTRIBUTE_REPARSE_POINT)
1701 *reparse_tag = pFileData->dwReserved0;
1702 else
1703 *reparse_tag = 0;
1704}
1705
Guido van Rossumd8faa362007-04-27 19:54:29 +00001706static BOOL
Steve Dowercc16be82016-09-08 10:35:16 -07001707attributes_from_dir(LPCWSTR pszFile, BY_HANDLE_FILE_INFORMATION *info, ULONG *reparse_tag)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001708{
Victor Stinner8c62be82010-05-06 00:08:46 +00001709 HANDLE hFindFile;
1710 WIN32_FIND_DATAW FileData;
1711 hFindFile = FindFirstFileW(pszFile, &FileData);
1712 if (hFindFile == INVALID_HANDLE_VALUE)
1713 return FALSE;
1714 FindClose(hFindFile);
Steve Dowercc16be82016-09-08 10:35:16 -07001715 find_data_to_file_info(&FileData, info, reparse_tag);
Victor Stinner8c62be82010-05-06 00:08:46 +00001716 return TRUE;
Guido van Rossumd8faa362007-04-27 19:54:29 +00001717}
1718
Brian Curtind25aef52011-06-13 15:16:04 -05001719static int
Steve Dowercc16be82016-09-08 10:35:16 -07001720win32_xstat_impl(const wchar_t *path, struct _Py_stat_struct *result,
Brian Curtind25aef52011-06-13 15:16:04 -05001721 BOOL traverse)
1722{
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001723 HANDLE hFile;
1724 BY_HANDLE_FILE_INFORMATION fileInfo;
1725 FILE_ATTRIBUTE_TAG_INFO tagInfo = { 0 };
1726 DWORD fileType, error;
1727 BOOL isUnhandledTag = FALSE;
1728 int retval = 0;
Brian Curtinf5e76d02010-11-24 13:14:05 +00001729
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001730 DWORD access = FILE_READ_ATTRIBUTES;
1731 DWORD flags = FILE_FLAG_BACKUP_SEMANTICS; /* Allow opening directories. */
1732 if (!traverse) {
1733 flags |= FILE_FLAG_OPEN_REPARSE_POINT;
1734 }
Brian Curtinf5e76d02010-11-24 13:14:05 +00001735
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001736 hFile = CreateFileW(path, access, 0, NULL, OPEN_EXISTING, flags, NULL);
Hirokazu Yamamoto427d3142010-12-04 10:16:05 +00001737 if (hFile == INVALID_HANDLE_VALUE) {
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001738 /* Either the path doesn't exist, or the caller lacks access. */
1739 error = GetLastError();
1740 switch (error) {
1741 case ERROR_ACCESS_DENIED: /* Cannot sync or read attributes. */
1742 case ERROR_SHARING_VIOLATION: /* It's a paging file. */
1743 /* Try reading the parent directory. */
1744 if (!attributes_from_dir(path, &fileInfo, &tagInfo.ReparseTag)) {
1745 /* Cannot read the parent directory. */
1746 SetLastError(error);
Hirokazu Yamamoto427d3142010-12-04 10:16:05 +00001747 return -1;
Brian Curtinf5e76d02010-11-24 13:14:05 +00001748 }
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001749 if (fileInfo.dwFileAttributes & FILE_ATTRIBUTE_REPARSE_POINT) {
1750 if (traverse ||
1751 !IsReparseTagNameSurrogate(tagInfo.ReparseTag)) {
1752 /* The stat call has to traverse but cannot, so fail. */
1753 SetLastError(error);
Brian Curtind25aef52011-06-13 15:16:04 -05001754 return -1;
Mark Becwarb82bfac2019-02-02 16:08:23 -05001755 }
Hirokazu Yamamoto427d3142010-12-04 10:16:05 +00001756 }
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001757 break;
Brian Curtinf5e76d02010-11-24 13:14:05 +00001758
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001759 case ERROR_INVALID_PARAMETER:
1760 /* \\.\con requires read or write access. */
1761 hFile = CreateFileW(path, access | GENERIC_READ,
1762 FILE_SHARE_READ | FILE_SHARE_WRITE, NULL,
1763 OPEN_EXISTING, flags, NULL);
1764 if (hFile == INVALID_HANDLE_VALUE) {
1765 SetLastError(error);
1766 return -1;
1767 }
1768 break;
1769
1770 case ERROR_CANT_ACCESS_FILE:
1771 /* bpo37834: open unhandled reparse points if traverse fails. */
1772 if (traverse) {
1773 traverse = FALSE;
1774 isUnhandledTag = TRUE;
1775 hFile = CreateFileW(path, access, 0, NULL, OPEN_EXISTING,
1776 flags | FILE_FLAG_OPEN_REPARSE_POINT, NULL);
1777 }
1778 if (hFile == INVALID_HANDLE_VALUE) {
1779 SetLastError(error);
1780 return -1;
1781 }
1782 break;
1783
1784 default:
1785 return -1;
1786 }
Brian Curtinf5e76d02010-11-24 13:14:05 +00001787 }
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001788
1789 if (hFile != INVALID_HANDLE_VALUE) {
1790 /* Handle types other than files on disk. */
1791 fileType = GetFileType(hFile);
1792 if (fileType != FILE_TYPE_DISK) {
1793 if (fileType == FILE_TYPE_UNKNOWN && GetLastError() != 0) {
1794 retval = -1;
1795 goto cleanup;
1796 }
1797 DWORD fileAttributes = GetFileAttributesW(path);
1798 memset(result, 0, sizeof(*result));
1799 if (fileAttributes != INVALID_FILE_ATTRIBUTES &&
1800 fileAttributes & FILE_ATTRIBUTE_DIRECTORY) {
1801 /* \\.\pipe\ or \\.\mailslot\ */
1802 result->st_mode = _S_IFDIR;
1803 } else if (fileType == FILE_TYPE_CHAR) {
1804 /* \\.\nul */
1805 result->st_mode = _S_IFCHR;
1806 } else if (fileType == FILE_TYPE_PIPE) {
1807 /* \\.\pipe\spam */
1808 result->st_mode = _S_IFIFO;
1809 }
1810 /* FILE_TYPE_UNKNOWN, e.g. \\.\mailslot\waitfor.exe\spam */
1811 goto cleanup;
1812 }
1813
1814 /* Query the reparse tag, and traverse a non-link. */
1815 if (!traverse) {
1816 if (!GetFileInformationByHandleEx(hFile, FileAttributeTagInfo,
1817 &tagInfo, sizeof(tagInfo))) {
1818 /* Allow devices that do not support FileAttributeTagInfo. */
1819 switch (GetLastError()) {
1820 case ERROR_INVALID_PARAMETER:
1821 case ERROR_INVALID_FUNCTION:
1822 case ERROR_NOT_SUPPORTED:
1823 tagInfo.FileAttributes = FILE_ATTRIBUTE_NORMAL;
1824 tagInfo.ReparseTag = 0;
1825 break;
1826 default:
1827 retval = -1;
1828 goto cleanup;
1829 }
1830 } else if (tagInfo.FileAttributes &
1831 FILE_ATTRIBUTE_REPARSE_POINT) {
1832 if (IsReparseTagNameSurrogate(tagInfo.ReparseTag)) {
1833 if (isUnhandledTag) {
1834 /* Traversing previously failed for either this link
1835 or its target. */
1836 SetLastError(ERROR_CANT_ACCESS_FILE);
1837 retval = -1;
1838 goto cleanup;
1839 }
1840 /* Traverse a non-link, but not if traversing already failed
1841 for an unhandled tag. */
1842 } else if (!isUnhandledTag) {
1843 CloseHandle(hFile);
1844 return win32_xstat_impl(path, result, TRUE);
1845 }
1846 }
1847 }
1848
1849 if (!GetFileInformationByHandle(hFile, &fileInfo)) {
1850 switch (GetLastError()) {
1851 case ERROR_INVALID_PARAMETER:
1852 case ERROR_INVALID_FUNCTION:
1853 case ERROR_NOT_SUPPORTED:
Steve Dower772ec0f2019-09-04 14:42:54 -07001854 /* Volumes and physical disks are block devices, e.g.
1855 \\.\C: and \\.\PhysicalDrive0. */
1856 memset(result, 0, sizeof(*result));
1857 result->st_mode = 0x6000; /* S_IFBLK */
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001858 goto cleanup;
1859 }
Steve Dower772ec0f2019-09-04 14:42:54 -07001860 retval = -1;
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001861 goto cleanup;
1862 }
1863 }
1864
1865 _Py_attribute_data_to_stat(&fileInfo, tagInfo.ReparseTag, result);
1866
1867 if (!(fileInfo.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)) {
1868 /* Fix the file execute permissions. This hack sets S_IEXEC if
1869 the filename has an extension that is commonly used by files
1870 that CreateProcessW can execute. A real implementation calls
1871 GetSecurityInfo, OpenThreadToken/OpenProcessToken, and
1872 AccessCheck to check for generic read, write, and execute
1873 access. */
1874 const wchar_t *fileExtension = wcsrchr(path, '.');
1875 if (fileExtension) {
1876 if (_wcsicmp(fileExtension, L".exe") == 0 ||
1877 _wcsicmp(fileExtension, L".bat") == 0 ||
1878 _wcsicmp(fileExtension, L".cmd") == 0 ||
1879 _wcsicmp(fileExtension, L".com") == 0) {
1880 result->st_mode |= 0111;
1881 }
1882 }
1883 }
1884
1885cleanup:
1886 if (hFile != INVALID_HANDLE_VALUE) {
Steve Dower772ec0f2019-09-04 14:42:54 -07001887 /* Preserve last error if we are failing */
1888 error = retval ? GetLastError() : 0;
1889 if (!CloseHandle(hFile)) {
1890 retval = -1;
1891 } else if (retval) {
1892 /* Restore last error */
1893 SetLastError(error);
1894 }
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001895 }
1896
1897 return retval;
Brian Curtinf5e76d02010-11-24 13:14:05 +00001898}
1899
1900static int
Steve Dowercc16be82016-09-08 10:35:16 -07001901win32_xstat(const wchar_t *path, struct _Py_stat_struct *result, BOOL traverse)
Brian Curtinf5e76d02010-11-24 13:14:05 +00001902{
Hirokazu Yamamoto427d3142010-12-04 10:16:05 +00001903 /* Protocol violation: we explicitly clear errno, instead of
1904 setting it to a POSIX error. Callers should use GetLastError. */
Brian Curtind25aef52011-06-13 15:16:04 -05001905 int code = win32_xstat_impl(path, result, traverse);
Hirokazu Yamamoto427d3142010-12-04 10:16:05 +00001906 errno = 0;
1907 return code;
1908}
Brian Curtind25aef52011-06-13 15:16:04 -05001909/* About the following functions: win32_lstat_w, win32_stat, win32_stat_w
Brian Curtind40e6f72010-07-08 21:39:08 +00001910
1911 In Posix, stat automatically traverses symlinks and returns the stat
1912 structure for the target. In Windows, the equivalent GetFileAttributes by
1913 default does not traverse symlinks and instead returns attributes for
1914 the symlink.
1915
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001916 Instead, we will open the file (which *does* traverse symlinks by default)
1917 and GetFileInformationByHandle(). */
Brian Curtind40e6f72010-07-08 21:39:08 +00001918
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00001919static int
Steve Dowercc16be82016-09-08 10:35:16 -07001920win32_lstat(const wchar_t* path, struct _Py_stat_struct *result)
Martin v. Löwis14694662006-02-03 12:54:16 +00001921{
Hirokazu Yamamoto427d3142010-12-04 10:16:05 +00001922 return win32_xstat(path, result, FALSE);
Martin v. Löwis14694662006-02-03 12:54:16 +00001923}
1924
Victor Stinner8c62be82010-05-06 00:08:46 +00001925static int
Steve Dowercc16be82016-09-08 10:35:16 -07001926win32_stat(const wchar_t* path, struct _Py_stat_struct *result)
Brian Curtind40e6f72010-07-08 21:39:08 +00001927{
Hirokazu Yamamoto427d3142010-12-04 10:16:05 +00001928 return win32_xstat(path, result, TRUE);
Brian Curtind40e6f72010-07-08 21:39:08 +00001929}
1930
Martin v. Löwis14694662006-02-03 12:54:16 +00001931#endif /* MS_WINDOWS */
1932
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001933PyDoc_STRVAR(stat_result__doc__,
Larry Hastings9cf065c2012-06-22 16:30:09 -07001934"stat_result: Result from stat, fstat, or lstat.\n\n\
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001935This object may be accessed either as a tuple of\n\
Fred Drakef7ce04d2002-06-20 18:31:21 +00001936 (mode, ino, dev, nlink, uid, gid, size, atime, mtime, ctime)\n\
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001937or via the attributes st_mode, st_ino, st_dev, st_nlink, st_uid, and so on.\n\
1938\n\
Hye-Shik Chang5f937a72005-06-02 13:09:30 +00001939Posix/windows: If your platform supports st_blksize, st_blocks, st_rdev,\n\
1940or st_flags, they are available as attributes only.\n\
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001941\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001942See os.stat for more information.");
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001943
1944static PyStructSequence_Field stat_result_fields[] = {
Victor Stinner8c62be82010-05-06 00:08:46 +00001945 {"st_mode", "protection bits"},
1946 {"st_ino", "inode"},
1947 {"st_dev", "device"},
1948 {"st_nlink", "number of hard links"},
1949 {"st_uid", "user ID of owner"},
1950 {"st_gid", "group ID of owner"},
1951 {"st_size", "total size, in bytes"},
1952 /* The NULL is replaced with PyStructSequence_UnnamedField later. */
1953 {NULL, "integer time of last access"},
1954 {NULL, "integer time of last modification"},
1955 {NULL, "integer time of last change"},
1956 {"st_atime", "time of last access"},
1957 {"st_mtime", "time of last modification"},
1958 {"st_ctime", "time of last change"},
Larry Hastings6fe20b32012-04-19 15:07:49 -07001959 {"st_atime_ns", "time of last access in nanoseconds"},
1960 {"st_mtime_ns", "time of last modification in nanoseconds"},
1961 {"st_ctime_ns", "time of last change in nanoseconds"},
Martin v. Löwis60a5d722002-10-16 20:28:25 +00001962#ifdef HAVE_STRUCT_STAT_ST_BLKSIZE
Victor Stinner8c62be82010-05-06 00:08:46 +00001963 {"st_blksize", "blocksize for filesystem I/O"},
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001964#endif
Martin v. Löwis60a5d722002-10-16 20:28:25 +00001965#ifdef HAVE_STRUCT_STAT_ST_BLOCKS
Victor Stinner8c62be82010-05-06 00:08:46 +00001966 {"st_blocks", "number of blocks allocated"},
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001967#endif
Martin v. Löwis60a5d722002-10-16 20:28:25 +00001968#ifdef HAVE_STRUCT_STAT_ST_RDEV
Victor Stinner8c62be82010-05-06 00:08:46 +00001969 {"st_rdev", "device type (if inode device)"},
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001970#endif
Hye-Shik Chang5f937a72005-06-02 13:09:30 +00001971#ifdef HAVE_STRUCT_STAT_ST_FLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +00001972 {"st_flags", "user defined flags for file"},
Hye-Shik Chang5f937a72005-06-02 13:09:30 +00001973#endif
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00001974#ifdef HAVE_STRUCT_STAT_ST_GEN
Victor Stinner8c62be82010-05-06 00:08:46 +00001975 {"st_gen", "generation number"},
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00001976#endif
1977#ifdef HAVE_STRUCT_STAT_ST_BIRTHTIME
Victor Stinner8c62be82010-05-06 00:08:46 +00001978 {"st_birthtime", "time of creation"},
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00001979#endif
Zachary Ware63f277b2014-06-19 09:46:37 -05001980#ifdef HAVE_STRUCT_STAT_ST_FILE_ATTRIBUTES
1981 {"st_file_attributes", "Windows file attribute bits"},
1982#endif
jcea6c51d512018-01-28 14:00:08 +01001983#ifdef HAVE_STRUCT_STAT_ST_FSTYPE
1984 {"st_fstype", "Type of filesystem"},
1985#endif
Steve Dowerdf2d4a62019-08-21 15:27:33 -07001986#ifdef HAVE_STRUCT_STAT_ST_REPARSE_TAG
1987 {"st_reparse_tag", "Windows reparse tag"},
1988#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00001989 {0}
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001990};
1991
Martin v. Löwis60a5d722002-10-16 20:28:25 +00001992#ifdef HAVE_STRUCT_STAT_ST_BLKSIZE
Larry Hastings6fe20b32012-04-19 15:07:49 -07001993#define ST_BLKSIZE_IDX 16
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001994#else
Larry Hastings6fe20b32012-04-19 15:07:49 -07001995#define ST_BLKSIZE_IDX 15
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001996#endif
1997
Martin v. Löwis60a5d722002-10-16 20:28:25 +00001998#ifdef HAVE_STRUCT_STAT_ST_BLOCKS
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001999#define ST_BLOCKS_IDX (ST_BLKSIZE_IDX+1)
2000#else
2001#define ST_BLOCKS_IDX ST_BLKSIZE_IDX
2002#endif
2003
Martin v. Löwis60a5d722002-10-16 20:28:25 +00002004#ifdef HAVE_STRUCT_STAT_ST_RDEV
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002005#define ST_RDEV_IDX (ST_BLOCKS_IDX+1)
2006#else
2007#define ST_RDEV_IDX ST_BLOCKS_IDX
2008#endif
2009
Hye-Shik Chang5f937a72005-06-02 13:09:30 +00002010#ifdef HAVE_STRUCT_STAT_ST_FLAGS
2011#define ST_FLAGS_IDX (ST_RDEV_IDX+1)
2012#else
2013#define ST_FLAGS_IDX ST_RDEV_IDX
2014#endif
2015
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002016#ifdef HAVE_STRUCT_STAT_ST_GEN
Martin v. Löwisf09582e2005-08-14 21:42:34 +00002017#define ST_GEN_IDX (ST_FLAGS_IDX+1)
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002018#else
Martin v. Löwisf09582e2005-08-14 21:42:34 +00002019#define ST_GEN_IDX ST_FLAGS_IDX
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002020#endif
2021
2022#ifdef HAVE_STRUCT_STAT_ST_BIRTHTIME
2023#define ST_BIRTHTIME_IDX (ST_GEN_IDX+1)
2024#else
2025#define ST_BIRTHTIME_IDX ST_GEN_IDX
2026#endif
2027
Zachary Ware63f277b2014-06-19 09:46:37 -05002028#ifdef HAVE_STRUCT_STAT_ST_FILE_ATTRIBUTES
2029#define ST_FILE_ATTRIBUTES_IDX (ST_BIRTHTIME_IDX+1)
2030#else
2031#define ST_FILE_ATTRIBUTES_IDX ST_BIRTHTIME_IDX
2032#endif
2033
jcea6c51d512018-01-28 14:00:08 +01002034#ifdef HAVE_STRUCT_STAT_ST_FSTYPE
2035#define ST_FSTYPE_IDX (ST_FILE_ATTRIBUTES_IDX+1)
2036#else
2037#define ST_FSTYPE_IDX ST_FILE_ATTRIBUTES_IDX
2038#endif
2039
Steve Dowerdf2d4a62019-08-21 15:27:33 -07002040#ifdef HAVE_STRUCT_STAT_ST_REPARSE_TAG
2041#define ST_REPARSE_TAG_IDX (ST_FSTYPE_IDX+1)
2042#else
2043#define ST_REPARSE_TAG_IDX ST_FSTYPE_IDX
2044#endif
2045
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002046static PyStructSequence_Desc stat_result_desc = {
Victor Stinner8c62be82010-05-06 00:08:46 +00002047 "stat_result", /* name */
2048 stat_result__doc__, /* doc */
2049 stat_result_fields,
2050 10
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002051};
2052
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002053PyDoc_STRVAR(statvfs_result__doc__,
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002054"statvfs_result: Result from statvfs or fstatvfs.\n\n\
2055This object may be accessed either as a tuple of\n\
Fred Drakef7ce04d2002-06-20 18:31:21 +00002056 (bsize, frsize, blocks, bfree, bavail, files, ffree, favail, flag, namemax),\n\
Guido van Rossuma4dc73e2001-10-18 20:53:15 +00002057or via the attributes f_bsize, f_frsize, f_blocks, f_bfree, and so on.\n\
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002058\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002059See os.statvfs for more information.");
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002060
2061static PyStructSequence_Field statvfs_result_fields[] = {
Victor Stinner8c62be82010-05-06 00:08:46 +00002062 {"f_bsize", },
2063 {"f_frsize", },
2064 {"f_blocks", },
2065 {"f_bfree", },
2066 {"f_bavail", },
2067 {"f_files", },
2068 {"f_ffree", },
2069 {"f_favail", },
2070 {"f_flag", },
2071 {"f_namemax",},
Giuseppe Scrivano96a5e502017-12-14 23:46:46 +01002072 {"f_fsid", },
Victor Stinner8c62be82010-05-06 00:08:46 +00002073 {0}
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002074};
2075
2076static PyStructSequence_Desc statvfs_result_desc = {
Victor Stinner8c62be82010-05-06 00:08:46 +00002077 "statvfs_result", /* name */
2078 statvfs_result__doc__, /* doc */
2079 statvfs_result_fields,
2080 10
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002081};
2082
Ross Lagerwall7807c352011-03-17 20:20:30 +02002083#if defined(HAVE_WAITID) && !defined(__APPLE__)
2084PyDoc_STRVAR(waitid_result__doc__,
2085"waitid_result: Result from waitid.\n\n\
2086This object may be accessed either as a tuple of\n\
2087 (si_pid, si_uid, si_signo, si_status, si_code),\n\
2088or via the attributes si_pid, si_uid, and so on.\n\
2089\n\
2090See os.waitid for more information.");
2091
2092static PyStructSequence_Field waitid_result_fields[] = {
2093 {"si_pid", },
2094 {"si_uid", },
2095 {"si_signo", },
2096 {"si_status", },
2097 {"si_code", },
2098 {0}
2099};
2100
2101static PyStructSequence_Desc waitid_result_desc = {
2102 "waitid_result", /* name */
2103 waitid_result__doc__, /* doc */
2104 waitid_result_fields,
2105 5
2106};
Benjamin Petersonbad9c2f2011-08-02 18:42:14 -05002107#endif
Martin v. Löwisf607bda2002-10-16 18:27:39 +00002108static newfunc structseq_new;
2109
2110static PyObject *
2111statresult_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
2112{
Victor Stinner8c62be82010-05-06 00:08:46 +00002113 PyStructSequence *result;
2114 int i;
Martin v. Löwisf607bda2002-10-16 18:27:39 +00002115
Victor Stinner8c62be82010-05-06 00:08:46 +00002116 result = (PyStructSequence*)structseq_new(type, args, kwds);
2117 if (!result)
2118 return NULL;
2119 /* If we have been initialized from a tuple,
2120 st_?time might be set to None. Initialize it
2121 from the int slots. */
2122 for (i = 7; i <= 9; i++) {
2123 if (result->ob_item[i+3] == Py_None) {
2124 Py_DECREF(Py_None);
2125 Py_INCREF(result->ob_item[i]);
2126 result->ob_item[i+3] = result->ob_item[i];
2127 }
2128 }
2129 return (PyObject*)result;
Martin v. Löwisf607bda2002-10-16 18:27:39 +00002130}
2131
Eddie Elizondob3966632019-11-05 07:16:14 -08002132static int
2133_posix_clear(PyObject *module)
2134{
Victor Stinner97f33c32020-05-14 18:05:58 +02002135 _posixstate *state = get_posix_state(module);
2136 Py_CLEAR(state->billion);
2137 Py_CLEAR(state->DirEntryType);
2138 Py_CLEAR(state->ScandirIteratorType);
Eddie Elizondob3966632019-11-05 07:16:14 -08002139#if defined(HAVE_SCHED_SETPARAM) || defined(HAVE_SCHED_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDPARAM)
Victor Stinner97f33c32020-05-14 18:05:58 +02002140 Py_CLEAR(state->SchedParamType);
Eddie Elizondob3966632019-11-05 07:16:14 -08002141#endif
Victor Stinner97f33c32020-05-14 18:05:58 +02002142 Py_CLEAR(state->StatResultType);
2143 Py_CLEAR(state->StatVFSResultType);
2144 Py_CLEAR(state->TerminalSizeType);
2145 Py_CLEAR(state->TimesResultType);
2146 Py_CLEAR(state->UnameResultType);
Eddie Elizondob3966632019-11-05 07:16:14 -08002147#if defined(HAVE_WAITID) && !defined(__APPLE__)
Victor Stinner97f33c32020-05-14 18:05:58 +02002148 Py_CLEAR(state->WaitidResultType);
Eddie Elizondob3966632019-11-05 07:16:14 -08002149#endif
2150#if defined(HAVE_WAIT3) || defined(HAVE_WAIT4)
Victor Stinner97f33c32020-05-14 18:05:58 +02002151 Py_CLEAR(state->struct_rusage);
Eddie Elizondob3966632019-11-05 07:16:14 -08002152#endif
Victor Stinner97f33c32020-05-14 18:05:58 +02002153 Py_CLEAR(state->st_mode);
Eddie Elizondob3966632019-11-05 07:16:14 -08002154 return 0;
2155}
Martin v. Löwisf607bda2002-10-16 18:27:39 +00002156
Eddie Elizondob3966632019-11-05 07:16:14 -08002157static int
2158_posix_traverse(PyObject *module, visitproc visit, void *arg)
2159{
Victor Stinner97f33c32020-05-14 18:05:58 +02002160 _posixstate *state = get_posix_state(module);
2161 Py_VISIT(state->billion);
2162 Py_VISIT(state->DirEntryType);
2163 Py_VISIT(state->ScandirIteratorType);
Eddie Elizondob3966632019-11-05 07:16:14 -08002164#if defined(HAVE_SCHED_SETPARAM) || defined(HAVE_SCHED_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDPARAM)
Victor Stinner97f33c32020-05-14 18:05:58 +02002165 Py_VISIT(state->SchedParamType);
Eddie Elizondob3966632019-11-05 07:16:14 -08002166#endif
Victor Stinner97f33c32020-05-14 18:05:58 +02002167 Py_VISIT(state->StatResultType);
2168 Py_VISIT(state->StatVFSResultType);
2169 Py_VISIT(state->TerminalSizeType);
2170 Py_VISIT(state->TimesResultType);
2171 Py_VISIT(state->UnameResultType);
Eddie Elizondob3966632019-11-05 07:16:14 -08002172#if defined(HAVE_WAITID) && !defined(__APPLE__)
Victor Stinner97f33c32020-05-14 18:05:58 +02002173 Py_VISIT(state->WaitidResultType);
Eddie Elizondob3966632019-11-05 07:16:14 -08002174#endif
2175#if defined(HAVE_WAIT3) || defined(HAVE_WAIT4)
Victor Stinner97f33c32020-05-14 18:05:58 +02002176 Py_VISIT(state->struct_rusage);
Eddie Elizondob3966632019-11-05 07:16:14 -08002177#endif
Victor Stinner97f33c32020-05-14 18:05:58 +02002178 Py_VISIT(state->st_mode);
Eddie Elizondob3966632019-11-05 07:16:14 -08002179 return 0;
2180}
2181
2182static void
2183_posix_free(void *module)
2184{
2185 _posix_clear((PyObject *)module);
2186}
Larry Hastings6fe20b32012-04-19 15:07:49 -07002187
Martin v. Löwis94717ed2002-09-09 14:24:16 +00002188static void
Victor Stinner1c2fa782020-05-10 11:05:29 +02002189fill_time(PyObject *module, PyObject *v, int index, time_t sec, unsigned long nsec)
Martin v. Löwis94717ed2002-09-09 14:24:16 +00002190{
Larry Hastings6fe20b32012-04-19 15:07:49 -07002191 PyObject *s = _PyLong_FromTime_t(sec);
2192 PyObject *ns_fractional = PyLong_FromUnsignedLong(nsec);
2193 PyObject *s_in_ns = NULL;
2194 PyObject *ns_total = NULL;
2195 PyObject *float_s = NULL;
2196
2197 if (!(s && ns_fractional))
2198 goto exit;
2199
Victor Stinner1c2fa782020-05-10 11:05:29 +02002200 s_in_ns = PyNumber_Multiply(s, get_posix_state(module)->billion);
Larry Hastings6fe20b32012-04-19 15:07:49 -07002201 if (!s_in_ns)
2202 goto exit;
2203
2204 ns_total = PyNumber_Add(s_in_ns, ns_fractional);
2205 if (!ns_total)
2206 goto exit;
2207
Victor Stinner01b5aab2017-10-24 02:02:00 -07002208 float_s = PyFloat_FromDouble(sec + 1e-9*nsec);
2209 if (!float_s) {
2210 goto exit;
Larry Hastings6fe20b32012-04-19 15:07:49 -07002211 }
2212
2213 PyStructSequence_SET_ITEM(v, index, s);
2214 PyStructSequence_SET_ITEM(v, index+3, float_s);
2215 PyStructSequence_SET_ITEM(v, index+6, ns_total);
2216 s = NULL;
2217 float_s = NULL;
2218 ns_total = NULL;
2219exit:
2220 Py_XDECREF(s);
2221 Py_XDECREF(ns_fractional);
2222 Py_XDECREF(s_in_ns);
2223 Py_XDECREF(ns_total);
2224 Py_XDECREF(float_s);
Martin v. Löwis94717ed2002-09-09 14:24:16 +00002225}
2226
Tim Peters5aa91602002-01-30 05:46:57 +00002227/* pack a system stat C structure into the Python stat tuple
Fred Drake699f3522000-06-29 21:12:41 +00002228 (used by posix_stat() and posix_fstat()) */
2229static PyObject*
Victor Stinner1c2fa782020-05-10 11:05:29 +02002230_pystat_fromstructstat(PyObject *module, STRUCT_STAT *st)
Fred Drake699f3522000-06-29 21:12:41 +00002231{
Victor Stinner8c62be82010-05-06 00:08:46 +00002232 unsigned long ansec, mnsec, cnsec;
Victor Stinner1c2fa782020-05-10 11:05:29 +02002233 PyObject *StatResultType = get_posix_state(module)->StatResultType;
Eddie Elizondob3966632019-11-05 07:16:14 -08002234 PyObject *v = PyStructSequence_New((PyTypeObject *)StatResultType);
Victor Stinner8c62be82010-05-06 00:08:46 +00002235 if (v == NULL)
2236 return NULL;
Fred Drake699f3522000-06-29 21:12:41 +00002237
Victor Stinner8c62be82010-05-06 00:08:46 +00002238 PyStructSequence_SET_ITEM(v, 0, PyLong_FromLong((long)st->st_mode));
Victor Stinner0f6d7332017-03-09 17:34:28 +01002239 Py_BUILD_ASSERT(sizeof(unsigned long long) >= sizeof(st->st_ino));
xdegaye50e86032017-05-22 11:15:08 +02002240 PyStructSequence_SET_ITEM(v, 1, PyLong_FromUnsignedLongLong(st->st_ino));
Serhiy Storchaka404fa922013-01-02 18:22:23 +02002241#ifdef MS_WINDOWS
2242 PyStructSequence_SET_ITEM(v, 2, PyLong_FromUnsignedLong(st->st_dev));
Fred Drake699f3522000-06-29 21:12:41 +00002243#else
Serhiy Storchakab2653b32015-01-18 11:12:11 +02002244 PyStructSequence_SET_ITEM(v, 2, _PyLong_FromDev(st->st_dev));
Fred Drake699f3522000-06-29 21:12:41 +00002245#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00002246 PyStructSequence_SET_ITEM(v, 3, PyLong_FromLong((long)st->st_nlink));
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02002247#if defined(MS_WINDOWS)
2248 PyStructSequence_SET_ITEM(v, 4, PyLong_FromLong(0));
2249 PyStructSequence_SET_ITEM(v, 5, PyLong_FromLong(0));
2250#else
2251 PyStructSequence_SET_ITEM(v, 4, _PyLong_FromUid(st->st_uid));
2252 PyStructSequence_SET_ITEM(v, 5, _PyLong_FromGid(st->st_gid));
2253#endif
xdegaye50e86032017-05-22 11:15:08 +02002254 Py_BUILD_ASSERT(sizeof(long long) >= sizeof(st->st_size));
2255 PyStructSequence_SET_ITEM(v, 6, PyLong_FromLongLong(st->st_size));
Martin v. Löwis94717ed2002-09-09 14:24:16 +00002256
Martin v. Löwis14694662006-02-03 12:54:16 +00002257#if defined(HAVE_STAT_TV_NSEC)
Victor Stinner8c62be82010-05-06 00:08:46 +00002258 ansec = st->st_atim.tv_nsec;
2259 mnsec = st->st_mtim.tv_nsec;
2260 cnsec = st->st_ctim.tv_nsec;
Martin v. Löwis14694662006-02-03 12:54:16 +00002261#elif defined(HAVE_STAT_TV_NSEC2)
Victor Stinner8c62be82010-05-06 00:08:46 +00002262 ansec = st->st_atimespec.tv_nsec;
2263 mnsec = st->st_mtimespec.tv_nsec;
2264 cnsec = st->st_ctimespec.tv_nsec;
Martin v. Löwis14694662006-02-03 12:54:16 +00002265#elif defined(HAVE_STAT_NSEC)
Victor Stinner8c62be82010-05-06 00:08:46 +00002266 ansec = st->st_atime_nsec;
2267 mnsec = st->st_mtime_nsec;
2268 cnsec = st->st_ctime_nsec;
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002269#else
Victor Stinner8c62be82010-05-06 00:08:46 +00002270 ansec = mnsec = cnsec = 0;
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002271#endif
Victor Stinner1c2fa782020-05-10 11:05:29 +02002272 fill_time(module, v, 7, st->st_atime, ansec);
2273 fill_time(module, v, 8, st->st_mtime, mnsec);
2274 fill_time(module, v, 9, st->st_ctime, cnsec);
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002275
Martin v. Löwis60a5d722002-10-16 20:28:25 +00002276#ifdef HAVE_STRUCT_STAT_ST_BLKSIZE
Victor Stinner8c62be82010-05-06 00:08:46 +00002277 PyStructSequence_SET_ITEM(v, ST_BLKSIZE_IDX,
2278 PyLong_FromLong((long)st->st_blksize));
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_BLOCKS
Victor Stinner8c62be82010-05-06 00:08:46 +00002281 PyStructSequence_SET_ITEM(v, ST_BLOCKS_IDX,
2282 PyLong_FromLong((long)st->st_blocks));
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002283#endif
Martin v. Löwis60a5d722002-10-16 20:28:25 +00002284#ifdef HAVE_STRUCT_STAT_ST_RDEV
Victor Stinner8c62be82010-05-06 00:08:46 +00002285 PyStructSequence_SET_ITEM(v, ST_RDEV_IDX,
2286 PyLong_FromLong((long)st->st_rdev));
Fred Drake699f3522000-06-29 21:12:41 +00002287#endif
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002288#ifdef HAVE_STRUCT_STAT_ST_GEN
Victor Stinner8c62be82010-05-06 00:08:46 +00002289 PyStructSequence_SET_ITEM(v, ST_GEN_IDX,
2290 PyLong_FromLong((long)st->st_gen));
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002291#endif
2292#ifdef HAVE_STRUCT_STAT_ST_BIRTHTIME
Victor Stinner8c62be82010-05-06 00:08:46 +00002293 {
Victor Stinner4195b5c2012-02-08 23:03:19 +01002294 PyObject *val;
2295 unsigned long bsec,bnsec;
2296 bsec = (long)st->st_birthtime;
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002297#ifdef HAVE_STAT_TV_NSEC2
Victor Stinner4195b5c2012-02-08 23:03:19 +01002298 bnsec = st->st_birthtimespec.tv_nsec;
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002299#else
Victor Stinner4195b5c2012-02-08 23:03:19 +01002300 bnsec = 0;
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002301#endif
Victor Stinner01b5aab2017-10-24 02:02:00 -07002302 val = PyFloat_FromDouble(bsec + 1e-9*bnsec);
Victor Stinner4195b5c2012-02-08 23:03:19 +01002303 PyStructSequence_SET_ITEM(v, ST_BIRTHTIME_IDX,
2304 val);
Victor Stinner8c62be82010-05-06 00:08:46 +00002305 }
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002306#endif
Hye-Shik Chang5f937a72005-06-02 13:09:30 +00002307#ifdef HAVE_STRUCT_STAT_ST_FLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +00002308 PyStructSequence_SET_ITEM(v, ST_FLAGS_IDX,
2309 PyLong_FromLong((long)st->st_flags));
Hye-Shik Chang5f937a72005-06-02 13:09:30 +00002310#endif
Zachary Ware63f277b2014-06-19 09:46:37 -05002311#ifdef HAVE_STRUCT_STAT_ST_FILE_ATTRIBUTES
2312 PyStructSequence_SET_ITEM(v, ST_FILE_ATTRIBUTES_IDX,
2313 PyLong_FromUnsignedLong(st->st_file_attributes));
2314#endif
jcea6c51d512018-01-28 14:00:08 +01002315#ifdef HAVE_STRUCT_STAT_ST_FSTYPE
2316 PyStructSequence_SET_ITEM(v, ST_FSTYPE_IDX,
2317 PyUnicode_FromString(st->st_fstype));
2318#endif
Steve Dowerdf2d4a62019-08-21 15:27:33 -07002319#ifdef HAVE_STRUCT_STAT_ST_REPARSE_TAG
2320 PyStructSequence_SET_ITEM(v, ST_REPARSE_TAG_IDX,
2321 PyLong_FromUnsignedLong(st->st_reparse_tag));
2322#endif
Fred Drake699f3522000-06-29 21:12:41 +00002323
Victor Stinner8c62be82010-05-06 00:08:46 +00002324 if (PyErr_Occurred()) {
2325 Py_DECREF(v);
2326 return NULL;
2327 }
Fred Drake699f3522000-06-29 21:12:41 +00002328
Victor Stinner8c62be82010-05-06 00:08:46 +00002329 return v;
Fred Drake699f3522000-06-29 21:12:41 +00002330}
2331
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002332/* POSIX methods */
2333
Guido van Rossum94f6f721999-01-06 18:42:14 +00002334
2335static PyObject *
Victor Stinner1c2fa782020-05-10 11:05:29 +02002336posix_do_stat(PyObject *module, const char *function_name, path_t *path,
Larry Hastings9cf065c2012-06-22 16:30:09 -07002337 int dir_fd, int follow_symlinks)
Guido van Rossum94f6f721999-01-06 18:42:14 +00002338{
Larry Hastings9cf065c2012-06-22 16:30:09 -07002339 STRUCT_STAT st;
2340 int result;
2341
2342#if !defined(MS_WINDOWS) && !defined(HAVE_FSTATAT) && !defined(HAVE_LSTAT)
2343 if (follow_symlinks_specified(function_name, follow_symlinks))
2344 return NULL;
2345#endif
2346
2347 if (path_and_dir_fd_invalid("stat", path, dir_fd) ||
2348 dir_fd_and_fd_invalid("stat", dir_fd, path->fd) ||
2349 fd_and_follow_symlinks_invalid("stat", path->fd, follow_symlinks))
2350 return NULL;
2351
2352 Py_BEGIN_ALLOW_THREADS
2353 if (path->fd != -1)
2354 result = FSTAT(path->fd, &st);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002355#ifdef MS_WINDOWS
Steve Dower513d7472016-09-08 10:41:50 -07002356 else if (follow_symlinks)
Steve Dowercc16be82016-09-08 10:35:16 -07002357 result = win32_stat(path->wide, &st);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002358 else
Steve Dowercc16be82016-09-08 10:35:16 -07002359 result = win32_lstat(path->wide, &st);
2360#else
2361 else
2362#if defined(HAVE_LSTAT)
Larry Hastings9cf065c2012-06-22 16:30:09 -07002363 if ((!follow_symlinks) && (dir_fd == DEFAULT_DIR_FD))
2364 result = LSTAT(path->narrow, &st);
2365 else
Steve Dowercc16be82016-09-08 10:35:16 -07002366#endif /* HAVE_LSTAT */
Larry Hastings9cf065c2012-06-22 16:30:09 -07002367#ifdef HAVE_FSTATAT
2368 if ((dir_fd != DEFAULT_DIR_FD) || !follow_symlinks)
2369 result = fstatat(dir_fd, path->narrow, &st,
2370 follow_symlinks ? 0 : AT_SYMLINK_NOFOLLOW);
2371 else
Steve Dowercc16be82016-09-08 10:35:16 -07002372#endif /* HAVE_FSTATAT */
Larry Hastings9cf065c2012-06-22 16:30:09 -07002373 result = STAT(path->narrow, &st);
Steve Dowercc16be82016-09-08 10:35:16 -07002374#endif /* MS_WINDOWS */
Larry Hastings9cf065c2012-06-22 16:30:09 -07002375 Py_END_ALLOW_THREADS
2376
Victor Stinner292c8352012-10-30 02:17:38 +01002377 if (result != 0) {
2378 return path_error(path);
2379 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07002380
Victor Stinner1c2fa782020-05-10 11:05:29 +02002381 return _pystat_fromstructstat(module, &st);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002382}
2383
Larry Hastings2f936352014-08-05 14:04:04 +10002384/*[python input]
2385
2386for s in """
2387
2388FACCESSAT
2389FCHMODAT
2390FCHOWNAT
2391FSTATAT
2392LINKAT
2393MKDIRAT
2394MKFIFOAT
2395MKNODAT
2396OPENAT
2397READLINKAT
2398SYMLINKAT
2399UNLINKAT
2400
2401""".strip().split():
2402 s = s.strip()
2403 print("""
2404#ifdef HAVE_{s}
2405 #define {s}_DIR_FD_CONVERTER dir_fd_converter
Larry Hastings31826802013-10-19 00:09:25 -07002406#else
Larry Hastings2f936352014-08-05 14:04:04 +10002407 #define {s}_DIR_FD_CONVERTER dir_fd_unavailable
Larry Hastings31826802013-10-19 00:09:25 -07002408#endif
Larry Hastings2f936352014-08-05 14:04:04 +10002409""".rstrip().format(s=s))
2410
2411for s in """
2412
2413FCHDIR
2414FCHMOD
2415FCHOWN
2416FDOPENDIR
2417FEXECVE
2418FPATHCONF
2419FSTATVFS
2420FTRUNCATE
2421
2422""".strip().split():
2423 s = s.strip()
2424 print("""
2425#ifdef HAVE_{s}
2426 #define PATH_HAVE_{s} 1
2427#else
2428 #define PATH_HAVE_{s} 0
2429#endif
2430
2431""".rstrip().format(s=s))
2432[python start generated code]*/
2433
2434#ifdef HAVE_FACCESSAT
2435 #define FACCESSAT_DIR_FD_CONVERTER dir_fd_converter
2436#else
2437 #define FACCESSAT_DIR_FD_CONVERTER dir_fd_unavailable
2438#endif
2439
2440#ifdef HAVE_FCHMODAT
2441 #define FCHMODAT_DIR_FD_CONVERTER dir_fd_converter
2442#else
2443 #define FCHMODAT_DIR_FD_CONVERTER dir_fd_unavailable
2444#endif
2445
2446#ifdef HAVE_FCHOWNAT
2447 #define FCHOWNAT_DIR_FD_CONVERTER dir_fd_converter
2448#else
2449 #define FCHOWNAT_DIR_FD_CONVERTER dir_fd_unavailable
2450#endif
2451
2452#ifdef HAVE_FSTATAT
2453 #define FSTATAT_DIR_FD_CONVERTER dir_fd_converter
2454#else
2455 #define FSTATAT_DIR_FD_CONVERTER dir_fd_unavailable
2456#endif
2457
2458#ifdef HAVE_LINKAT
2459 #define LINKAT_DIR_FD_CONVERTER dir_fd_converter
2460#else
2461 #define LINKAT_DIR_FD_CONVERTER dir_fd_unavailable
2462#endif
2463
2464#ifdef HAVE_MKDIRAT
2465 #define MKDIRAT_DIR_FD_CONVERTER dir_fd_converter
2466#else
2467 #define MKDIRAT_DIR_FD_CONVERTER dir_fd_unavailable
2468#endif
2469
2470#ifdef HAVE_MKFIFOAT
2471 #define MKFIFOAT_DIR_FD_CONVERTER dir_fd_converter
2472#else
2473 #define MKFIFOAT_DIR_FD_CONVERTER dir_fd_unavailable
2474#endif
2475
2476#ifdef HAVE_MKNODAT
2477 #define MKNODAT_DIR_FD_CONVERTER dir_fd_converter
2478#else
2479 #define MKNODAT_DIR_FD_CONVERTER dir_fd_unavailable
2480#endif
2481
2482#ifdef HAVE_OPENAT
2483 #define OPENAT_DIR_FD_CONVERTER dir_fd_converter
2484#else
2485 #define OPENAT_DIR_FD_CONVERTER dir_fd_unavailable
2486#endif
2487
2488#ifdef HAVE_READLINKAT
2489 #define READLINKAT_DIR_FD_CONVERTER dir_fd_converter
2490#else
2491 #define READLINKAT_DIR_FD_CONVERTER dir_fd_unavailable
2492#endif
2493
2494#ifdef HAVE_SYMLINKAT
2495 #define SYMLINKAT_DIR_FD_CONVERTER dir_fd_converter
2496#else
2497 #define SYMLINKAT_DIR_FD_CONVERTER dir_fd_unavailable
2498#endif
2499
2500#ifdef HAVE_UNLINKAT
2501 #define UNLINKAT_DIR_FD_CONVERTER dir_fd_converter
2502#else
2503 #define UNLINKAT_DIR_FD_CONVERTER dir_fd_unavailable
2504#endif
2505
2506#ifdef HAVE_FCHDIR
2507 #define PATH_HAVE_FCHDIR 1
2508#else
2509 #define PATH_HAVE_FCHDIR 0
2510#endif
2511
2512#ifdef HAVE_FCHMOD
2513 #define PATH_HAVE_FCHMOD 1
2514#else
2515 #define PATH_HAVE_FCHMOD 0
2516#endif
2517
2518#ifdef HAVE_FCHOWN
2519 #define PATH_HAVE_FCHOWN 1
2520#else
2521 #define PATH_HAVE_FCHOWN 0
2522#endif
2523
2524#ifdef HAVE_FDOPENDIR
2525 #define PATH_HAVE_FDOPENDIR 1
2526#else
2527 #define PATH_HAVE_FDOPENDIR 0
2528#endif
2529
2530#ifdef HAVE_FEXECVE
2531 #define PATH_HAVE_FEXECVE 1
2532#else
2533 #define PATH_HAVE_FEXECVE 0
2534#endif
2535
2536#ifdef HAVE_FPATHCONF
2537 #define PATH_HAVE_FPATHCONF 1
2538#else
2539 #define PATH_HAVE_FPATHCONF 0
2540#endif
2541
2542#ifdef HAVE_FSTATVFS
2543 #define PATH_HAVE_FSTATVFS 1
2544#else
2545 #define PATH_HAVE_FSTATVFS 0
2546#endif
2547
2548#ifdef HAVE_FTRUNCATE
2549 #define PATH_HAVE_FTRUNCATE 1
2550#else
2551 #define PATH_HAVE_FTRUNCATE 0
2552#endif
2553/*[python end generated code: output=4bd4f6f7d41267f1 input=80b4c890b6774ea5]*/
Larry Hastings31826802013-10-19 00:09:25 -07002554
Steve Dowerfe0a41a2015-03-20 19:50:46 -07002555#ifdef MS_WINDOWS
2556 #undef PATH_HAVE_FTRUNCATE
2557 #define PATH_HAVE_FTRUNCATE 1
2558#endif
Larry Hastings31826802013-10-19 00:09:25 -07002559
Larry Hastings61272b72014-01-07 12:41:53 -08002560/*[python input]
Larry Hastings31826802013-10-19 00:09:25 -07002561
2562class path_t_converter(CConverter):
2563
2564 type = "path_t"
2565 impl_by_reference = True
2566 parse_by_reference = True
2567
2568 converter = 'path_converter'
2569
2570 def converter_init(self, *, allow_fd=False, nullable=False):
Larry Hastings31826802013-10-19 00:09:25 -07002571 # right now path_t doesn't support default values.
2572 # to support a default value, you'll need to override initialize().
Larry Hastings2f936352014-08-05 14:04:04 +10002573 if self.default not in (unspecified, None):
Larry Hastings7726ac92014-01-31 22:03:12 -08002574 fail("Can't specify a default to the path_t converter!")
Larry Hastings31826802013-10-19 00:09:25 -07002575
Larry Hastings2f936352014-08-05 14:04:04 +10002576 if self.c_default not in (None, 'Py_None'):
2577 raise RuntimeError("Can't specify a c_default to the path_t converter!")
Larry Hastings31826802013-10-19 00:09:25 -07002578
2579 self.nullable = nullable
2580 self.allow_fd = allow_fd
2581
Larry Hastings7726ac92014-01-31 22:03:12 -08002582 def pre_render(self):
2583 def strify(value):
Larry Hastings2f936352014-08-05 14:04:04 +10002584 if isinstance(value, str):
2585 return value
Larry Hastings7726ac92014-01-31 22:03:12 -08002586 return str(int(bool(value)))
2587
2588 # add self.py_name here when merging with posixmodule conversion
Larry Hastings2f936352014-08-05 14:04:04 +10002589 self.c_default = 'PATH_T_INITIALIZE("{}", "{}", {}, {})'.format(
Larry Hastings31826802013-10-19 00:09:25 -07002590 self.function.name,
Larry Hastings2f936352014-08-05 14:04:04 +10002591 self.name,
Larry Hastings7726ac92014-01-31 22:03:12 -08002592 strify(self.nullable),
2593 strify(self.allow_fd),
Larry Hastings31826802013-10-19 00:09:25 -07002594 )
2595
2596 def cleanup(self):
2597 return "path_cleanup(&" + self.name + ");\n"
2598
2599
2600class dir_fd_converter(CConverter):
2601 type = 'int'
Larry Hastings31826802013-10-19 00:09:25 -07002602
Larry Hastings2f936352014-08-05 14:04:04 +10002603 def converter_init(self, requires=None):
Larry Hastings31826802013-10-19 00:09:25 -07002604 if self.default in (unspecified, None):
2605 self.c_default = 'DEFAULT_DIR_FD'
Larry Hastings2f936352014-08-05 14:04:04 +10002606 if isinstance(requires, str):
2607 self.converter = requires.upper() + '_DIR_FD_CONVERTER'
2608 else:
2609 self.converter = 'dir_fd_converter'
Larry Hastings31826802013-10-19 00:09:25 -07002610
Larry Hastings2f936352014-08-05 14:04:04 +10002611class fildes_converter(CConverter):
2612 type = 'int'
2613 converter = 'fildes_converter'
2614
2615class uid_t_converter(CConverter):
2616 type = "uid_t"
2617 converter = '_Py_Uid_Converter'
2618
2619class gid_t_converter(CConverter):
2620 type = "gid_t"
2621 converter = '_Py_Gid_Converter'
2622
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +02002623class dev_t_converter(CConverter):
2624 type = 'dev_t'
2625 converter = '_Py_Dev_Converter'
2626
2627class dev_t_return_converter(unsigned_long_return_converter):
2628 type = 'dev_t'
2629 conversion_fn = '_PyLong_FromDev'
2630 unsigned_cast = '(dev_t)'
2631
Larry Hastings2f936352014-08-05 14:04:04 +10002632class FSConverter_converter(CConverter):
2633 type = 'PyObject *'
2634 converter = 'PyUnicode_FSConverter'
2635 def converter_init(self):
2636 if self.default is not unspecified:
2637 fail("FSConverter_converter does not support default values")
2638 self.c_default = 'NULL'
2639
2640 def cleanup(self):
2641 return "Py_XDECREF(" + self.name + ");\n"
2642
2643class pid_t_converter(CConverter):
2644 type = 'pid_t'
2645 format_unit = '" _Py_PARSE_PID "'
2646
2647class idtype_t_converter(int_converter):
2648 type = 'idtype_t'
2649
2650class id_t_converter(CConverter):
2651 type = 'id_t'
2652 format_unit = '" _Py_PARSE_PID "'
2653
Benjamin Petersonca470632016-09-06 13:47:26 -07002654class intptr_t_converter(CConverter):
2655 type = 'intptr_t'
Larry Hastings2f936352014-08-05 14:04:04 +10002656 format_unit = '" _Py_PARSE_INTPTR "'
2657
2658class Py_off_t_converter(CConverter):
2659 type = 'Py_off_t'
2660 converter = 'Py_off_t_converter'
2661
2662class Py_off_t_return_converter(long_return_converter):
2663 type = 'Py_off_t'
2664 conversion_fn = 'PyLong_FromPy_off_t'
2665
2666class path_confname_converter(CConverter):
2667 type="int"
2668 converter="conv_path_confname"
2669
2670class confstr_confname_converter(path_confname_converter):
2671 converter='conv_confstr_confname'
2672
2673class sysconf_confname_converter(path_confname_converter):
2674 converter="conv_sysconf_confname"
2675
Larry Hastings61272b72014-01-07 12:41:53 -08002676[python start generated code]*/
Victor Stinner1c2fa782020-05-10 11:05:29 +02002677/*[python end generated code: output=da39a3ee5e6b4b0d input=f1c8ae8d744f6c8b]*/
Larry Hastings31826802013-10-19 00:09:25 -07002678
Larry Hastings61272b72014-01-07 12:41:53 -08002679/*[clinic input]
Larry Hastings31826802013-10-19 00:09:25 -07002680
Larry Hastings2a727912014-01-16 11:32:01 -08002681os.stat
Larry Hastings31826802013-10-19 00:09:25 -07002682
2683 path : path_t(allow_fd=True)
BNMetricsb9427072018-11-02 15:20:19 +00002684 Path to be examined; can be string, bytes, a path-like object or
Xiang Zhang4459e002017-01-22 13:04:17 +08002685 open-file-descriptor int.
Larry Hastings31826802013-10-19 00:09:25 -07002686
2687 *
2688
Larry Hastings2f936352014-08-05 14:04:04 +10002689 dir_fd : dir_fd(requires='fstatat') = None
Larry Hastings31826802013-10-19 00:09:25 -07002690 If not None, it should be a file descriptor open to a directory,
2691 and path should be a relative string; path will then be relative to
2692 that directory.
2693
2694 follow_symlinks: bool = True
2695 If False, and the last element of the path is a symbolic link,
2696 stat will examine the symbolic link itself instead of the file
2697 the link points to.
2698
2699Perform a stat system call on the given path.
2700
2701dir_fd and follow_symlinks may not be implemented
2702 on your platform. If they are unavailable, using them will raise a
2703 NotImplementedError.
2704
2705It's an error to use dir_fd or follow_symlinks when specifying path as
2706 an open file descriptor.
2707
Larry Hastings61272b72014-01-07 12:41:53 -08002708[clinic start generated code]*/
Larry Hastings31826802013-10-19 00:09:25 -07002709
Larry Hastings31826802013-10-19 00:09:25 -07002710static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002711os_stat_impl(PyObject *module, path_t *path, int dir_fd, int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +00002712/*[clinic end generated code: output=7d4976e6f18a59c5 input=01d362ebcc06996b]*/
Larry Hastings31826802013-10-19 00:09:25 -07002713{
Victor Stinner1c2fa782020-05-10 11:05:29 +02002714 return posix_do_stat(module, "stat", path, dir_fd, follow_symlinks);
Larry Hastings31826802013-10-19 00:09:25 -07002715}
2716
Larry Hastings2f936352014-08-05 14:04:04 +10002717
2718/*[clinic input]
2719os.lstat
2720
2721 path : path_t
2722
2723 *
2724
2725 dir_fd : dir_fd(requires='fstatat') = None
2726
2727Perform a stat system call on the given path, without following symbolic links.
2728
2729Like stat(), but do not follow symbolic links.
2730Equivalent to stat(path, follow_symlinks=False).
2731[clinic start generated code]*/
2732
Larry Hastings2f936352014-08-05 14:04:04 +10002733static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002734os_lstat_impl(PyObject *module, path_t *path, int dir_fd)
2735/*[clinic end generated code: output=ef82a5d35ce8ab37 input=0b7474765927b925]*/
Larry Hastings2f936352014-08-05 14:04:04 +10002736{
2737 int follow_symlinks = 0;
Victor Stinner1c2fa782020-05-10 11:05:29 +02002738 return posix_do_stat(module, "lstat", path, dir_fd, follow_symlinks);
Larry Hastings2f936352014-08-05 14:04:04 +10002739}
Larry Hastings31826802013-10-19 00:09:25 -07002740
Larry Hastings2f936352014-08-05 14:04:04 +10002741
Larry Hastings61272b72014-01-07 12:41:53 -08002742/*[clinic input]
Larry Hastings2f936352014-08-05 14:04:04 +10002743os.access -> bool
Larry Hastings31826802013-10-19 00:09:25 -07002744
Benjamin Peterson768f3b42016-09-05 15:29:33 -07002745 path: path_t
BNMetricsb9427072018-11-02 15:20:19 +00002746 Path to be tested; can be string, bytes, or a path-like object.
Larry Hastings31826802013-10-19 00:09:25 -07002747
2748 mode: int
2749 Operating-system mode bitfield. Can be F_OK to test existence,
2750 or the inclusive-OR of R_OK, W_OK, and X_OK.
2751
2752 *
2753
Larry Hastings2f936352014-08-05 14:04:04 +10002754 dir_fd : dir_fd(requires='faccessat') = None
Larry Hastings31826802013-10-19 00:09:25 -07002755 If not None, it should be a file descriptor open to a directory,
2756 and path should be relative; path will then be relative to that
2757 directory.
2758
2759 effective_ids: bool = False
2760 If True, access will use the effective uid/gid instead of
2761 the real uid/gid.
2762
2763 follow_symlinks: bool = True
2764 If False, and the last element of the path is a symbolic link,
2765 access will examine the symbolic link itself instead of the file
2766 the link points to.
2767
2768Use the real uid/gid to test for access to a path.
2769
2770{parameters}
2771dir_fd, effective_ids, and follow_symlinks may not be implemented
2772 on your platform. If they are unavailable, using them will raise a
2773 NotImplementedError.
2774
2775Note that most operations will use the effective uid/gid, therefore this
2776 routine can be used in a suid/sgid environment to test if the invoking user
2777 has the specified access to the path.
2778
Larry Hastings61272b72014-01-07 12:41:53 -08002779[clinic start generated code]*/
Larry Hastings31826802013-10-19 00:09:25 -07002780
Larry Hastings2f936352014-08-05 14:04:04 +10002781static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002782os_access_impl(PyObject *module, path_t *path, int mode, int dir_fd,
Larry Hastings89964c42015-04-14 18:07:59 -04002783 int effective_ids, int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +00002784/*[clinic end generated code: output=cf84158bc90b1a77 input=3ffe4e650ee3bf20]*/
Larry Hastings31826802013-10-19 00:09:25 -07002785{
Larry Hastings2f936352014-08-05 14:04:04 +10002786 int return_value;
Victor Stinner8c62be82010-05-06 00:08:46 +00002787
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00002788#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00002789 DWORD attr;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002790#else
Larry Hastings9cf065c2012-06-22 16:30:09 -07002791 int result;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002792#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07002793
Larry Hastings9cf065c2012-06-22 16:30:09 -07002794#ifndef HAVE_FACCESSAT
2795 if (follow_symlinks_specified("access", follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10002796 return -1;
Larry Hastings9cf065c2012-06-22 16:30:09 -07002797
2798 if (effective_ids) {
2799 argument_unavailable_error("access", "effective_ids");
Larry Hastings2f936352014-08-05 14:04:04 +10002800 return -1;
Larry Hastings9cf065c2012-06-22 16:30:09 -07002801 }
2802#endif
2803
2804#ifdef MS_WINDOWS
2805 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07002806 attr = GetFileAttributesW(path->wide);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002807 Py_END_ALLOW_THREADS
2808
2809 /*
Georg Brandlf7875592012-06-24 13:58:31 +02002810 * Access is possible if
Larry Hastings9cf065c2012-06-22 16:30:09 -07002811 * * we didn't get a -1, and
2812 * * write access wasn't requested,
2813 * * or the file isn't read-only,
2814 * * or it's a directory.
2815 * (Directories cannot be read-only on Windows.)
2816 */
Larry Hastings2f936352014-08-05 14:04:04 +10002817 return_value = (attr != INVALID_FILE_ATTRIBUTES) &&
Georg Brandl5bb7aa92012-06-23 12:48:40 +02002818 (!(mode & 2) ||
Larry Hastings9cf065c2012-06-22 16:30:09 -07002819 !(attr & FILE_ATTRIBUTE_READONLY) ||
Larry Hastings2f936352014-08-05 14:04:04 +10002820 (attr & FILE_ATTRIBUTE_DIRECTORY));
Larry Hastings9cf065c2012-06-22 16:30:09 -07002821#else
2822
2823 Py_BEGIN_ALLOW_THREADS
2824#ifdef HAVE_FACCESSAT
2825 if ((dir_fd != DEFAULT_DIR_FD) ||
2826 effective_ids ||
2827 !follow_symlinks) {
2828 int flags = 0;
2829 if (!follow_symlinks)
2830 flags |= AT_SYMLINK_NOFOLLOW;
2831 if (effective_ids)
2832 flags |= AT_EACCESS;
Larry Hastings31826802013-10-19 00:09:25 -07002833 result = faccessat(dir_fd, path->narrow, mode, flags);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002834 }
2835 else
2836#endif
Larry Hastings31826802013-10-19 00:09:25 -07002837 result = access(path->narrow, mode);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002838 Py_END_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10002839 return_value = !result;
Larry Hastings9cf065c2012-06-22 16:30:09 -07002840#endif
2841
Larry Hastings9cf065c2012-06-22 16:30:09 -07002842 return return_value;
Guido van Rossum94f6f721999-01-06 18:42:14 +00002843}
2844
Guido van Rossumd371ff11999-01-25 16:12:23 +00002845#ifndef F_OK
2846#define F_OK 0
2847#endif
2848#ifndef R_OK
2849#define R_OK 4
2850#endif
2851#ifndef W_OK
2852#define W_OK 2
2853#endif
2854#ifndef X_OK
2855#define X_OK 1
2856#endif
2857
Larry Hastings31826802013-10-19 00:09:25 -07002858
Guido van Rossumd371ff11999-01-25 16:12:23 +00002859#ifdef HAVE_TTYNAME
Larry Hastings61272b72014-01-07 12:41:53 -08002860/*[clinic input]
Serhiy Storchaka4db62e12018-12-17 16:47:45 +02002861os.ttyname
Larry Hastings31826802013-10-19 00:09:25 -07002862
2863 fd: int
2864 Integer file descriptor handle.
2865
2866 /
2867
2868Return the name of the terminal device connected to 'fd'.
Larry Hastings61272b72014-01-07 12:41:53 -08002869[clinic start generated code]*/
Larry Hastings31826802013-10-19 00:09:25 -07002870
Serhiy Storchaka4db62e12018-12-17 16:47:45 +02002871static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002872os_ttyname_impl(PyObject *module, int fd)
Serhiy Storchaka4db62e12018-12-17 16:47:45 +02002873/*[clinic end generated code: output=c424d2e9d1cd636a input=9ff5a58b08115c55]*/
Larry Hastings31826802013-10-19 00:09:25 -07002874{
Guido van Rossum94f6f721999-01-06 18:42:14 +00002875
Antonio Gutierrez594e2ed2019-10-09 04:19:48 +02002876 long size = sysconf(_SC_TTY_NAME_MAX);
2877 if (size == -1) {
Serhiy Storchaka4db62e12018-12-17 16:47:45 +02002878 return posix_error();
2879 }
Antonio Gutierrez594e2ed2019-10-09 04:19:48 +02002880 char *buffer = (char *)PyMem_RawMalloc(size);
2881 if (buffer == NULL) {
2882 return PyErr_NoMemory();
2883 }
2884 int ret = ttyname_r(fd, buffer, size);
2885 if (ret != 0) {
2886 PyMem_RawFree(buffer);
2887 errno = ret;
2888 return posix_error();
2889 }
2890 PyObject *res = PyUnicode_DecodeFSDefault(buffer);
2891 PyMem_RawFree(buffer);
2892 return res;
Guido van Rossum94f6f721999-01-06 18:42:14 +00002893}
Guido van Rossumd371ff11999-01-25 16:12:23 +00002894#endif
Guido van Rossum94f6f721999-01-06 18:42:14 +00002895
Fred Drake5ab8eaf1999-12-09 21:13:07 +00002896#ifdef HAVE_CTERMID
Larry Hastings2f936352014-08-05 14:04:04 +10002897/*[clinic input]
2898os.ctermid
2899
2900Return the name of the controlling terminal for this process.
2901[clinic start generated code]*/
2902
Larry Hastings2f936352014-08-05 14:04:04 +10002903static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002904os_ctermid_impl(PyObject *module)
2905/*[clinic end generated code: output=02f017e6c9e620db input=3b87fdd52556382d]*/
Fred Drake5ab8eaf1999-12-09 21:13:07 +00002906{
Victor Stinner8c62be82010-05-06 00:08:46 +00002907 char *ret;
2908 char buffer[L_ctermid];
Fred Drake5ab8eaf1999-12-09 21:13:07 +00002909
Greg Wardb48bc172000-03-01 21:51:56 +00002910#ifdef USE_CTERMID_R
Victor Stinner8c62be82010-05-06 00:08:46 +00002911 ret = ctermid_r(buffer);
Fred Drake5ab8eaf1999-12-09 21:13:07 +00002912#else
Victor Stinner8c62be82010-05-06 00:08:46 +00002913 ret = ctermid(buffer);
Fred Drake5ab8eaf1999-12-09 21:13:07 +00002914#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00002915 if (ret == NULL)
2916 return posix_error();
Victor Stinner5fe6de82010-08-15 09:12:51 +00002917 return PyUnicode_DecodeFSDefault(buffer);
Fred Drake5ab8eaf1999-12-09 21:13:07 +00002918}
Larry Hastings2f936352014-08-05 14:04:04 +10002919#endif /* HAVE_CTERMID */
Fred Drake5ab8eaf1999-12-09 21:13:07 +00002920
Larry Hastings2f936352014-08-05 14:04:04 +10002921
2922/*[clinic input]
2923os.chdir
2924
2925 path: path_t(allow_fd='PATH_HAVE_FCHDIR')
2926
2927Change the current working directory to the specified path.
2928
2929path may always be specified as a string.
2930On some platforms, path may also be specified as an open file descriptor.
2931 If this functionality is unavailable, using it raises an exception.
2932[clinic start generated code]*/
2933
Larry Hastings2f936352014-08-05 14:04:04 +10002934static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002935os_chdir_impl(PyObject *module, path_t *path)
2936/*[clinic end generated code: output=3be6400eee26eaae input=1a4a15b4d12cb15d]*/
Larry Hastings2f936352014-08-05 14:04:04 +10002937{
2938 int result;
Larry Hastings9cf065c2012-06-22 16:30:09 -07002939
Saiyang Gou7514f4f2020-02-12 23:47:42 -08002940 if (PySys_Audit("os.chdir", "(O)", path->object) < 0) {
2941 return NULL;
2942 }
2943
Larry Hastings9cf065c2012-06-22 16:30:09 -07002944 Py_BEGIN_ALLOW_THREADS
2945#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07002946 /* on unix, success = 0, on windows, success = !0 */
2947 result = !win32_wchdir(path->wide);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002948#else
2949#ifdef HAVE_FCHDIR
Larry Hastings2f936352014-08-05 14:04:04 +10002950 if (path->fd != -1)
2951 result = fchdir(path->fd);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002952 else
2953#endif
Larry Hastings2f936352014-08-05 14:04:04 +10002954 result = chdir(path->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002955#endif
2956 Py_END_ALLOW_THREADS
2957
2958 if (result) {
Larry Hastings2f936352014-08-05 14:04:04 +10002959 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002960 }
2961
Larry Hastings2f936352014-08-05 14:04:04 +10002962 Py_RETURN_NONE;
2963}
2964
2965
2966#ifdef HAVE_FCHDIR
2967/*[clinic input]
2968os.fchdir
2969
2970 fd: fildes
2971
2972Change to the directory of the given file descriptor.
2973
2974fd must be opened on a directory, not a file.
2975Equivalent to os.chdir(fd).
2976
2977[clinic start generated code]*/
2978
Fred Drake4d1e64b2002-04-15 19:40:07 +00002979static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002980os_fchdir_impl(PyObject *module, int fd)
2981/*[clinic end generated code: output=42e064ec4dc00ab0 input=18e816479a2fa985]*/
Fred Drake4d1e64b2002-04-15 19:40:07 +00002982{
Saiyang Gou7514f4f2020-02-12 23:47:42 -08002983 if (PySys_Audit("os.chdir", "(i)", fd) < 0) {
2984 return NULL;
2985 }
Larry Hastings2f936352014-08-05 14:04:04 +10002986 return posix_fildes_fd(fd, fchdir);
Fred Drake4d1e64b2002-04-15 19:40:07 +00002987}
2988#endif /* HAVE_FCHDIR */
2989
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00002990
Larry Hastings2f936352014-08-05 14:04:04 +10002991/*[clinic input]
2992os.chmod
2993
2994 path: path_t(allow_fd='PATH_HAVE_FCHMOD')
BNMetricsb9427072018-11-02 15:20:19 +00002995 Path to be modified. May always be specified as a str, bytes, or a path-like object.
Larry Hastings2f936352014-08-05 14:04:04 +10002996 On some platforms, path may also be specified as an open file descriptor.
2997 If this functionality is unavailable, using it raises an exception.
2998
2999 mode: int
3000 Operating-system mode bitfield.
3001
3002 *
3003
3004 dir_fd : dir_fd(requires='fchmodat') = None
3005 If not None, it should be a file descriptor open to a directory,
3006 and path should be relative; path will then be relative to that
3007 directory.
3008
3009 follow_symlinks: bool = True
3010 If False, and the last element of the path is a symbolic link,
3011 chmod will modify the symbolic link itself instead of the file
3012 the link points to.
3013
3014Change the access permissions of a file.
3015
3016It is an error to use dir_fd or follow_symlinks when specifying path as
3017 an open file descriptor.
3018dir_fd and follow_symlinks may not be implemented on your platform.
3019 If they are unavailable, using them will raise a NotImplementedError.
3020
3021[clinic start generated code]*/
3022
Larry Hastings2f936352014-08-05 14:04:04 +10003023static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003024os_chmod_impl(PyObject *module, path_t *path, int mode, int dir_fd,
Larry Hastings89964c42015-04-14 18:07:59 -04003025 int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +00003026/*[clinic end generated code: output=5cf6a94915cc7bff input=989081551c00293b]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003027{
Larry Hastings9cf065c2012-06-22 16:30:09 -07003028 int result;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003029
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00003030#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00003031 DWORD attr;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003032#endif
Hirokazu Yamamoto892a37a2009-06-28 11:07:03 +00003033
Larry Hastings9cf065c2012-06-22 16:30:09 -07003034#ifdef HAVE_FCHMODAT
3035 int fchmodat_nofollow_unsupported = 0;
3036#endif
3037
Larry Hastings9cf065c2012-06-22 16:30:09 -07003038#if !(defined(HAVE_FCHMODAT) || defined(HAVE_LCHMOD))
3039 if (follow_symlinks_specified("chmod", follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10003040 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003041#endif
3042
Saiyang Gou7514f4f2020-02-12 23:47:42 -08003043 if (PySys_Audit("os.chmod", "Oii", path->object, mode,
3044 dir_fd == DEFAULT_DIR_FD ? -1 : dir_fd) < 0) {
3045 return NULL;
3046 }
3047
Larry Hastings9cf065c2012-06-22 16:30:09 -07003048#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00003049 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07003050 attr = GetFileAttributesW(path->wide);
Tim Golden23005082013-10-25 11:22:37 +01003051 if (attr == INVALID_FILE_ATTRIBUTES)
Larry Hastings9cf065c2012-06-22 16:30:09 -07003052 result = 0;
3053 else {
3054 if (mode & _S_IWRITE)
Victor Stinner8c62be82010-05-06 00:08:46 +00003055 attr &= ~FILE_ATTRIBUTE_READONLY;
3056 else
3057 attr |= FILE_ATTRIBUTE_READONLY;
Steve Dowercc16be82016-09-08 10:35:16 -07003058 result = SetFileAttributesW(path->wide, attr);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003059 }
3060 Py_END_ALLOW_THREADS
3061
3062 if (!result) {
Larry Hastings2f936352014-08-05 14:04:04 +10003063 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003064 }
3065#else /* MS_WINDOWS */
3066 Py_BEGIN_ALLOW_THREADS
3067#ifdef HAVE_FCHMOD
Larry Hastings2f936352014-08-05 14:04:04 +10003068 if (path->fd != -1)
3069 result = fchmod(path->fd, mode);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003070 else
3071#endif
3072#ifdef HAVE_LCHMOD
3073 if ((!follow_symlinks) && (dir_fd == DEFAULT_DIR_FD))
Larry Hastings2f936352014-08-05 14:04:04 +10003074 result = lchmod(path->narrow, mode);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003075 else
3076#endif
3077#ifdef HAVE_FCHMODAT
3078 if ((dir_fd != DEFAULT_DIR_FD) || !follow_symlinks) {
3079 /*
3080 * fchmodat() doesn't currently support AT_SYMLINK_NOFOLLOW!
3081 * The documentation specifically shows how to use it,
Larry Hastingsdbbc0c82012-06-22 19:50:21 -07003082 * and then says it isn't implemented yet.
3083 * (true on linux with glibc 2.15, and openindiana 3.x)
Larry Hastings9cf065c2012-06-22 16:30:09 -07003084 *
3085 * Once it is supported, os.chmod will automatically
3086 * support dir_fd and follow_symlinks=False. (Hopefully.)
3087 * Until then, we need to be careful what exception we raise.
3088 */
Larry Hastings2f936352014-08-05 14:04:04 +10003089 result = fchmodat(dir_fd, path->narrow, mode,
Larry Hastings9cf065c2012-06-22 16:30:09 -07003090 follow_symlinks ? 0 : AT_SYMLINK_NOFOLLOW);
3091 /*
3092 * But wait! We can't throw the exception without allowing threads,
3093 * and we can't do that in this nested scope. (Macro trickery, sigh.)
3094 */
3095 fchmodat_nofollow_unsupported =
Larry Hastingsdbbc0c82012-06-22 19:50:21 -07003096 result &&
3097 ((errno == ENOTSUP) || (errno == EOPNOTSUPP)) &&
3098 !follow_symlinks;
Victor Stinner8c62be82010-05-06 00:08:46 +00003099 }
3100 else
Thomas Wouters477c8d52006-05-27 19:21:47 +00003101#endif
Larry Hastings2f936352014-08-05 14:04:04 +10003102 result = chmod(path->narrow, mode);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003103 Py_END_ALLOW_THREADS
3104
3105 if (result) {
3106#ifdef HAVE_FCHMODAT
3107 if (fchmodat_nofollow_unsupported) {
3108 if (dir_fd != DEFAULT_DIR_FD)
3109 dir_fd_and_follow_symlinks_invalid("chmod",
3110 dir_fd, follow_symlinks);
3111 else
3112 follow_symlinks_specified("chmod", follow_symlinks);
Anthony Sottile233ef242017-12-14 08:57:55 -08003113 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003114 }
3115 else
3116#endif
Larry Hastings2f936352014-08-05 14:04:04 +10003117 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003118 }
3119#endif
3120
Larry Hastings2f936352014-08-05 14:04:04 +10003121 Py_RETURN_NONE;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003122}
3123
Larry Hastings9cf065c2012-06-22 16:30:09 -07003124
Christian Heimes4e30a842007-11-30 22:12:06 +00003125#ifdef HAVE_FCHMOD
Larry Hastings2f936352014-08-05 14:04:04 +10003126/*[clinic input]
3127os.fchmod
3128
3129 fd: int
3130 mode: int
3131
3132Change the access permissions of the file given by file descriptor fd.
3133
3134Equivalent to os.chmod(fd, mode).
3135[clinic start generated code]*/
3136
Larry Hastings2f936352014-08-05 14:04:04 +10003137static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003138os_fchmod_impl(PyObject *module, int fd, int mode)
3139/*[clinic end generated code: output=afd9bc05b4e426b3 input=8ab11975ca01ee5b]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003140{
3141 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003142 int async_err = 0;
3143
Saiyang Gou7514f4f2020-02-12 23:47:42 -08003144 if (PySys_Audit("os.chmod", "iii", fd, mode, -1) < 0) {
3145 return NULL;
3146 }
3147
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003148 do {
3149 Py_BEGIN_ALLOW_THREADS
3150 res = fchmod(fd, mode);
3151 Py_END_ALLOW_THREADS
3152 } while (res != 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
3153 if (res != 0)
3154 return (!async_err) ? posix_error() : NULL;
3155
Victor Stinner8c62be82010-05-06 00:08:46 +00003156 Py_RETURN_NONE;
Christian Heimes4e30a842007-11-30 22:12:06 +00003157}
3158#endif /* HAVE_FCHMOD */
3159
Larry Hastings2f936352014-08-05 14:04:04 +10003160
Christian Heimes4e30a842007-11-30 22:12:06 +00003161#ifdef HAVE_LCHMOD
Larry Hastings2f936352014-08-05 14:04:04 +10003162/*[clinic input]
3163os.lchmod
3164
3165 path: path_t
3166 mode: int
3167
3168Change the access permissions of a file, without following symbolic links.
3169
3170If path is a symlink, this affects the link itself rather than the target.
3171Equivalent to chmod(path, mode, follow_symlinks=False)."
3172[clinic start generated code]*/
3173
Larry Hastings2f936352014-08-05 14:04:04 +10003174static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003175os_lchmod_impl(PyObject *module, path_t *path, int mode)
3176/*[clinic end generated code: output=082344022b51a1d5 input=90c5663c7465d24f]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003177{
Victor Stinner8c62be82010-05-06 00:08:46 +00003178 int res;
Saiyang Gou7514f4f2020-02-12 23:47:42 -08003179 if (PySys_Audit("os.chmod", "Oii", path->object, mode, -1) < 0) {
3180 return NULL;
3181 }
Victor Stinner8c62be82010-05-06 00:08:46 +00003182 Py_BEGIN_ALLOW_THREADS
Larry Hastingsb1dc1122014-08-05 16:06:16 +10003183 res = lchmod(path->narrow, mode);
Victor Stinner8c62be82010-05-06 00:08:46 +00003184 Py_END_ALLOW_THREADS
Victor Stinner292c8352012-10-30 02:17:38 +01003185 if (res < 0) {
Larry Hastings2f936352014-08-05 14:04:04 +10003186 path_error(path);
Victor Stinner292c8352012-10-30 02:17:38 +01003187 return NULL;
3188 }
Victor Stinner8c62be82010-05-06 00:08:46 +00003189 Py_RETURN_NONE;
Christian Heimes4e30a842007-11-30 22:12:06 +00003190}
3191#endif /* HAVE_LCHMOD */
3192
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00003193
Thomas Wouterscf297e42007-02-23 15:07:44 +00003194#ifdef HAVE_CHFLAGS
Larry Hastings2f936352014-08-05 14:04:04 +10003195/*[clinic input]
3196os.chflags
3197
3198 path: path_t
3199 flags: unsigned_long(bitwise=True)
3200 follow_symlinks: bool=True
3201
3202Set file flags.
3203
3204If follow_symlinks is False, and the last element of the path is a symbolic
3205 link, chflags will change flags on the symbolic link itself instead of the
3206 file the link points to.
3207follow_symlinks may not be implemented on your platform. If it is
3208unavailable, using it will raise a NotImplementedError.
3209
3210[clinic start generated code]*/
3211
Larry Hastings2f936352014-08-05 14:04:04 +10003212static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003213os_chflags_impl(PyObject *module, path_t *path, unsigned long flags,
Larry Hastings89964c42015-04-14 18:07:59 -04003214 int follow_symlinks)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003215/*[clinic end generated code: output=85571c6737661ce9 input=0327e29feb876236]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003216{
3217 int result;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003218
3219#ifndef HAVE_LCHFLAGS
3220 if (follow_symlinks_specified("chflags", follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10003221 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003222#endif
3223
Saiyang Gou7514f4f2020-02-12 23:47:42 -08003224 if (PySys_Audit("os.chflags", "Ok", path->object, flags) < 0) {
3225 return NULL;
3226 }
3227
Victor Stinner8c62be82010-05-06 00:08:46 +00003228 Py_BEGIN_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07003229#ifdef HAVE_LCHFLAGS
3230 if (!follow_symlinks)
Larry Hastings2f936352014-08-05 14:04:04 +10003231 result = lchflags(path->narrow, flags);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003232 else
3233#endif
Larry Hastings2f936352014-08-05 14:04:04 +10003234 result = chflags(path->narrow, flags);
Victor Stinner8c62be82010-05-06 00:08:46 +00003235 Py_END_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07003236
Larry Hastings2f936352014-08-05 14:04:04 +10003237 if (result)
3238 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003239
Larry Hastings2f936352014-08-05 14:04:04 +10003240 Py_RETURN_NONE;
Thomas Wouterscf297e42007-02-23 15:07:44 +00003241}
3242#endif /* HAVE_CHFLAGS */
3243
Larry Hastings2f936352014-08-05 14:04:04 +10003244
Thomas Wouterscf297e42007-02-23 15:07:44 +00003245#ifdef HAVE_LCHFLAGS
Larry Hastings2f936352014-08-05 14:04:04 +10003246/*[clinic input]
3247os.lchflags
3248
3249 path: path_t
3250 flags: unsigned_long(bitwise=True)
3251
3252Set file flags.
3253
3254This function will not follow symbolic links.
3255Equivalent to chflags(path, flags, follow_symlinks=False).
3256[clinic start generated code]*/
3257
Larry Hastings2f936352014-08-05 14:04:04 +10003258static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003259os_lchflags_impl(PyObject *module, path_t *path, unsigned long flags)
3260/*[clinic end generated code: output=30ae958695c07316 input=f9f82ea8b585ca9d]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003261{
Victor Stinner8c62be82010-05-06 00:08:46 +00003262 int res;
Saiyang Gou7514f4f2020-02-12 23:47:42 -08003263 if (PySys_Audit("os.chflags", "Ok", path->object, flags) < 0) {
3264 return NULL;
3265 }
Victor Stinner8c62be82010-05-06 00:08:46 +00003266 Py_BEGIN_ALLOW_THREADS
Larry Hastingsb1dc1122014-08-05 16:06:16 +10003267 res = lchflags(path->narrow, flags);
Victor Stinner8c62be82010-05-06 00:08:46 +00003268 Py_END_ALLOW_THREADS
Victor Stinner292c8352012-10-30 02:17:38 +01003269 if (res < 0) {
Larry Hastings2f936352014-08-05 14:04:04 +10003270 return path_error(path);
Victor Stinner292c8352012-10-30 02:17:38 +01003271 }
Victor Stinner292c8352012-10-30 02:17:38 +01003272 Py_RETURN_NONE;
Thomas Wouterscf297e42007-02-23 15:07:44 +00003273}
3274#endif /* HAVE_LCHFLAGS */
3275
Larry Hastings2f936352014-08-05 14:04:04 +10003276
Martin v. Löwis244edc82001-10-04 22:44:26 +00003277#ifdef HAVE_CHROOT
Larry Hastings2f936352014-08-05 14:04:04 +10003278/*[clinic input]
3279os.chroot
3280 path: path_t
3281
3282Change root directory to path.
3283
3284[clinic start generated code]*/
3285
Larry Hastings2f936352014-08-05 14:04:04 +10003286static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003287os_chroot_impl(PyObject *module, path_t *path)
3288/*[clinic end generated code: output=de80befc763a4475 input=14822965652c3dc3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003289{
3290 int res;
3291 Py_BEGIN_ALLOW_THREADS
3292 res = chroot(path->narrow);
3293 Py_END_ALLOW_THREADS
3294 if (res < 0)
3295 return path_error(path);
3296 Py_RETURN_NONE;
3297}
3298#endif /* HAVE_CHROOT */
3299
Martin v. Löwis244edc82001-10-04 22:44:26 +00003300
Guido van Rossum21142a01999-01-08 21:05:37 +00003301#ifdef HAVE_FSYNC
Larry Hastings2f936352014-08-05 14:04:04 +10003302/*[clinic input]
3303os.fsync
3304
3305 fd: fildes
3306
3307Force write of fd to disk.
3308[clinic start generated code]*/
3309
Larry Hastings2f936352014-08-05 14:04:04 +10003310static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003311os_fsync_impl(PyObject *module, int fd)
3312/*[clinic end generated code: output=4a10d773f52b3584 input=21c3645c056967f2]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003313{
3314 return posix_fildes_fd(fd, fsync);
Guido van Rossum21142a01999-01-08 21:05:37 +00003315}
3316#endif /* HAVE_FSYNC */
3317
Larry Hastings2f936352014-08-05 14:04:04 +10003318
Ross Lagerwall7807c352011-03-17 20:20:30 +02003319#ifdef HAVE_SYNC
Larry Hastings2f936352014-08-05 14:04:04 +10003320/*[clinic input]
3321os.sync
3322
3323Force write of everything to disk.
3324[clinic start generated code]*/
3325
Larry Hastings2f936352014-08-05 14:04:04 +10003326static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003327os_sync_impl(PyObject *module)
3328/*[clinic end generated code: output=2796b1f0818cd71c input=84749fe5e9b404ff]*/
Ross Lagerwall7807c352011-03-17 20:20:30 +02003329{
3330 Py_BEGIN_ALLOW_THREADS
3331 sync();
3332 Py_END_ALLOW_THREADS
3333 Py_RETURN_NONE;
3334}
Larry Hastings2f936352014-08-05 14:04:04 +10003335#endif /* HAVE_SYNC */
3336
Ross Lagerwall7807c352011-03-17 20:20:30 +02003337
Guido van Rossum21142a01999-01-08 21:05:37 +00003338#ifdef HAVE_FDATASYNC
Guido van Rossum7f58e2e2000-09-22 17:26:14 +00003339#ifdef __hpux
Guido van Rossumecc23b02000-09-22 16:01:05 +00003340extern int fdatasync(int); /* On HP-UX, in libc but not in unistd.h */
3341#endif
3342
Larry Hastings2f936352014-08-05 14:04:04 +10003343/*[clinic input]
3344os.fdatasync
3345
3346 fd: fildes
3347
3348Force write of fd to disk without forcing update of metadata.
3349[clinic start generated code]*/
3350
Larry Hastings2f936352014-08-05 14:04:04 +10003351static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003352os_fdatasync_impl(PyObject *module, int fd)
3353/*[clinic end generated code: output=b4b9698b5d7e26dd input=bc74791ee54dd291]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003354{
3355 return posix_fildes_fd(fd, fdatasync);
Guido van Rossum21142a01999-01-08 21:05:37 +00003356}
3357#endif /* HAVE_FDATASYNC */
3358
3359
Fredrik Lundh10723342000-07-10 16:38:09 +00003360#ifdef HAVE_CHOWN
Larry Hastings2f936352014-08-05 14:04:04 +10003361/*[clinic input]
3362os.chown
3363
3364 path : path_t(allow_fd='PATH_HAVE_FCHOWN')
BNMetricsb9427072018-11-02 15:20:19 +00003365 Path to be examined; can be string, bytes, a path-like object, or open-file-descriptor int.
Larry Hastings2f936352014-08-05 14:04:04 +10003366
3367 uid: uid_t
3368
3369 gid: gid_t
3370
3371 *
3372
3373 dir_fd : dir_fd(requires='fchownat') = None
3374 If not None, it should be a file descriptor open to a directory,
3375 and path should be relative; path will then be relative to that
3376 directory.
3377
3378 follow_symlinks: bool = True
3379 If False, and the last element of the path is a symbolic link,
3380 stat will examine the symbolic link itself instead of the file
3381 the link points to.
3382
3383Change the owner and group id of path to the numeric uid and gid.\
3384
3385path may always be specified as a string.
3386On some platforms, path may also be specified as an open file descriptor.
3387 If this functionality is unavailable, using it raises an exception.
3388If dir_fd is not None, it should be a file descriptor open to a directory,
3389 and path should be relative; path will then be relative to that directory.
3390If follow_symlinks is False, and the last element of the path is a symbolic
3391 link, chown will modify the symbolic link itself instead of the file the
3392 link points to.
3393It is an error to use dir_fd or follow_symlinks when specifying path as
3394 an open file descriptor.
3395dir_fd and follow_symlinks may not be implemented on your platform.
3396 If they are unavailable, using them will raise a NotImplementedError.
3397
3398[clinic start generated code]*/
3399
Larry Hastings2f936352014-08-05 14:04:04 +10003400static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003401os_chown_impl(PyObject *module, path_t *path, uid_t uid, gid_t gid,
Larry Hastings89964c42015-04-14 18:07:59 -04003402 int dir_fd, int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +00003403/*[clinic end generated code: output=4beadab0db5f70cd input=b08c5ec67996a97d]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003404{
3405 int result;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003406
3407#if !(defined(HAVE_LCHOWN) || defined(HAVE_FCHOWNAT))
3408 if (follow_symlinks_specified("chown", follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10003409 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003410#endif
Larry Hastings2f936352014-08-05 14:04:04 +10003411 if (dir_fd_and_fd_invalid("chown", dir_fd, path->fd) ||
3412 fd_and_follow_symlinks_invalid("chown", path->fd, follow_symlinks))
3413 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003414
3415#ifdef __APPLE__
3416 /*
3417 * This is for Mac OS X 10.3, which doesn't have lchown.
3418 * (But we still have an lchown symbol because of weak-linking.)
3419 * It doesn't have fchownat either. So there's no possibility
3420 * of a graceful failover.
Georg Brandlf7875592012-06-24 13:58:31 +02003421 */
Larry Hastings9cf065c2012-06-22 16:30:09 -07003422 if ((!follow_symlinks) && (lchown == NULL)) {
3423 follow_symlinks_specified("chown", follow_symlinks);
Larry Hastings2f936352014-08-05 14:04:04 +10003424 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003425 }
3426#endif
3427
Saiyang Gou7514f4f2020-02-12 23:47:42 -08003428 if (PySys_Audit("os.chown", "OIIi", path->object, uid, gid,
3429 dir_fd == DEFAULT_DIR_FD ? -1 : dir_fd) < 0) {
3430 return NULL;
3431 }
3432
Victor Stinner8c62be82010-05-06 00:08:46 +00003433 Py_BEGIN_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07003434#ifdef HAVE_FCHOWN
Larry Hastings2f936352014-08-05 14:04:04 +10003435 if (path->fd != -1)
3436 result = fchown(path->fd, uid, gid);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003437 else
3438#endif
3439#ifdef HAVE_LCHOWN
3440 if ((!follow_symlinks) && (dir_fd == DEFAULT_DIR_FD))
Larry Hastings2f936352014-08-05 14:04:04 +10003441 result = lchown(path->narrow, uid, gid);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003442 else
3443#endif
3444#ifdef HAVE_FCHOWNAT
3445 if ((dir_fd != DEFAULT_DIR_FD) || (!follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10003446 result = fchownat(dir_fd, path->narrow, uid, gid,
Larry Hastings9cf065c2012-06-22 16:30:09 -07003447 follow_symlinks ? 0 : AT_SYMLINK_NOFOLLOW);
3448 else
3449#endif
Larry Hastings2f936352014-08-05 14:04:04 +10003450 result = chown(path->narrow, uid, gid);
Victor Stinner8c62be82010-05-06 00:08:46 +00003451 Py_END_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07003452
Larry Hastings2f936352014-08-05 14:04:04 +10003453 if (result)
3454 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003455
Larry Hastings2f936352014-08-05 14:04:04 +10003456 Py_RETURN_NONE;
Guido van Rossumb6775db1994-08-01 11:34:53 +00003457}
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00003458#endif /* HAVE_CHOWN */
Guido van Rossumb6775db1994-08-01 11:34:53 +00003459
Larry Hastings2f936352014-08-05 14:04:04 +10003460
Christian Heimes4e30a842007-11-30 22:12:06 +00003461#ifdef HAVE_FCHOWN
Larry Hastings2f936352014-08-05 14:04:04 +10003462/*[clinic input]
3463os.fchown
3464
3465 fd: int
3466 uid: uid_t
3467 gid: gid_t
3468
3469Change the owner and group id of the file specified by file descriptor.
3470
3471Equivalent to os.chown(fd, uid, gid).
3472
3473[clinic start generated code]*/
3474
Larry Hastings2f936352014-08-05 14:04:04 +10003475static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003476os_fchown_impl(PyObject *module, int fd, uid_t uid, gid_t gid)
3477/*[clinic end generated code: output=97d21cbd5a4350a6 input=3af544ba1b13a0d7]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003478{
Victor Stinner8c62be82010-05-06 00:08:46 +00003479 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003480 int async_err = 0;
3481
Saiyang Gou7514f4f2020-02-12 23:47:42 -08003482 if (PySys_Audit("os.chown", "iIIi", fd, uid, gid, -1) < 0) {
3483 return NULL;
3484 }
3485
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003486 do {
3487 Py_BEGIN_ALLOW_THREADS
3488 res = fchown(fd, uid, gid);
3489 Py_END_ALLOW_THREADS
3490 } while (res != 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
3491 if (res != 0)
3492 return (!async_err) ? posix_error() : NULL;
3493
Victor Stinner8c62be82010-05-06 00:08:46 +00003494 Py_RETURN_NONE;
Christian Heimes4e30a842007-11-30 22:12:06 +00003495}
3496#endif /* HAVE_FCHOWN */
3497
Larry Hastings2f936352014-08-05 14:04:04 +10003498
Martin v. Löwis0cec0ff2002-07-28 16:33:45 +00003499#ifdef HAVE_LCHOWN
Larry Hastings2f936352014-08-05 14:04:04 +10003500/*[clinic input]
3501os.lchown
3502
3503 path : path_t
3504 uid: uid_t
3505 gid: gid_t
3506
3507Change the owner and group id of path to the numeric uid and gid.
3508
3509This function will not follow symbolic links.
3510Equivalent to os.chown(path, uid, gid, follow_symlinks=False).
3511[clinic start generated code]*/
3512
Larry Hastings2f936352014-08-05 14:04:04 +10003513static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003514os_lchown_impl(PyObject *module, path_t *path, uid_t uid, gid_t gid)
3515/*[clinic end generated code: output=25eaf6af412fdf2f input=b1c6014d563a7161]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003516{
Victor Stinner8c62be82010-05-06 00:08:46 +00003517 int res;
Saiyang Gou7514f4f2020-02-12 23:47:42 -08003518 if (PySys_Audit("os.chown", "OIIi", path->object, uid, gid, -1) < 0) {
3519 return NULL;
3520 }
Victor Stinner8c62be82010-05-06 00:08:46 +00003521 Py_BEGIN_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10003522 res = lchown(path->narrow, uid, gid);
Victor Stinner8c62be82010-05-06 00:08:46 +00003523 Py_END_ALLOW_THREADS
Victor Stinner292c8352012-10-30 02:17:38 +01003524 if (res < 0) {
Larry Hastings2f936352014-08-05 14:04:04 +10003525 return path_error(path);
Victor Stinner292c8352012-10-30 02:17:38 +01003526 }
Larry Hastings2f936352014-08-05 14:04:04 +10003527 Py_RETURN_NONE;
Martin v. Löwis0cec0ff2002-07-28 16:33:45 +00003528}
3529#endif /* HAVE_LCHOWN */
3530
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00003531
Barry Warsaw53699e91996-12-10 23:23:01 +00003532static PyObject *
Guido van Rossumf0af3e32008-10-02 18:55:37 +00003533posix_getcwd(int use_bytes)
Mark Hammondc2e85bd2002-10-03 05:10:39 +00003534{
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00003535#ifdef MS_WINDOWS
Victor Stinner689830e2019-06-26 17:31:12 +02003536 wchar_t wbuf[MAXPATHLEN];
3537 wchar_t *wbuf2 = wbuf;
3538 DWORD len;
3539
3540 Py_BEGIN_ALLOW_THREADS
3541 len = GetCurrentDirectoryW(Py_ARRAY_LENGTH(wbuf), wbuf);
3542 /* If the buffer is large enough, len does not include the
3543 terminating \0. If the buffer is too small, len includes
3544 the space needed for the terminator. */
3545 if (len >= Py_ARRAY_LENGTH(wbuf)) {
Victor Stinnerec3e20a2019-06-28 18:01:59 +02003546 if (len <= PY_SSIZE_T_MAX / sizeof(wchar_t)) {
Victor Stinnerb6404912013-07-07 16:21:41 +02003547 wbuf2 = PyMem_RawMalloc(len * sizeof(wchar_t));
Victor Stinner8c62be82010-05-06 00:08:46 +00003548 }
Victor Stinner689830e2019-06-26 17:31:12 +02003549 else {
3550 wbuf2 = NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00003551 }
Victor Stinner689830e2019-06-26 17:31:12 +02003552 if (wbuf2) {
3553 len = GetCurrentDirectoryW(len, wbuf2);
Victor Stinner8c62be82010-05-06 00:08:46 +00003554 }
Victor Stinner689830e2019-06-26 17:31:12 +02003555 }
3556 Py_END_ALLOW_THREADS
3557
3558 if (!wbuf2) {
3559 PyErr_NoMemory();
3560 return NULL;
3561 }
3562 if (!len) {
Victor Stinnerb024e842012-10-31 22:24:06 +01003563 if (wbuf2 != wbuf)
Victor Stinnerb6404912013-07-07 16:21:41 +02003564 PyMem_RawFree(wbuf2);
Victor Stinner689830e2019-06-26 17:31:12 +02003565 return PyErr_SetFromWindowsErr(0);
Victor Stinner8c62be82010-05-06 00:08:46 +00003566 }
Victor Stinnerf7c5ae22011-11-16 23:43:07 +01003567
Victor Stinner689830e2019-06-26 17:31:12 +02003568 PyObject *resobj = PyUnicode_FromWideChar(wbuf2, len);
3569 if (wbuf2 != wbuf) {
3570 PyMem_RawFree(wbuf2);
3571 }
Mark Hammondc2e85bd2002-10-03 05:10:39 +00003572
Victor Stinner689830e2019-06-26 17:31:12 +02003573 if (use_bytes) {
3574 if (resobj == NULL) {
3575 return NULL;
3576 }
3577 Py_SETREF(resobj, PyUnicode_EncodeFSDefault(resobj));
3578 }
3579
3580 return resobj;
3581#else
3582 const size_t chunk = 1024;
3583
3584 char *buf = NULL;
3585 char *cwd = NULL;
3586 size_t buflen = 0;
3587
Victor Stinner8c62be82010-05-06 00:08:46 +00003588 Py_BEGIN_ALLOW_THREADS
Victor Stinner4403d7d2015-04-25 00:16:10 +02003589 do {
Victor Stinner689830e2019-06-26 17:31:12 +02003590 char *newbuf;
3591 if (buflen <= PY_SSIZE_T_MAX - chunk) {
3592 buflen += chunk;
3593 newbuf = PyMem_RawRealloc(buf, buflen);
3594 }
3595 else {
3596 newbuf = NULL;
3597 }
3598 if (newbuf == NULL) {
3599 PyMem_RawFree(buf);
3600 buf = NULL;
Victor Stinnerc44f7072016-03-14 18:07:53 +01003601 break;
3602 }
Victor Stinner689830e2019-06-26 17:31:12 +02003603 buf = newbuf;
Victor Stinner4403d7d2015-04-25 00:16:10 +02003604
Victor Stinner4403d7d2015-04-25 00:16:10 +02003605 cwd = getcwd(buf, buflen);
3606 } while (cwd == NULL && errno == ERANGE);
Victor Stinner8c62be82010-05-06 00:08:46 +00003607 Py_END_ALLOW_THREADS
Victor Stinner4403d7d2015-04-25 00:16:10 +02003608
Victor Stinner689830e2019-06-26 17:31:12 +02003609 if (buf == NULL) {
3610 return PyErr_NoMemory();
3611 }
Victor Stinner4403d7d2015-04-25 00:16:10 +02003612 if (cwd == NULL) {
3613 PyMem_RawFree(buf);
Victor Stinner8c62be82010-05-06 00:08:46 +00003614 return posix_error();
Victor Stinner4403d7d2015-04-25 00:16:10 +02003615 }
3616
Victor Stinner689830e2019-06-26 17:31:12 +02003617 PyObject *obj;
3618 if (use_bytes) {
Victor Stinner4403d7d2015-04-25 00:16:10 +02003619 obj = PyBytes_FromStringAndSize(buf, strlen(buf));
Victor Stinner689830e2019-06-26 17:31:12 +02003620 }
3621 else {
Victor Stinner4403d7d2015-04-25 00:16:10 +02003622 obj = PyUnicode_DecodeFSDefault(buf);
Victor Stinner689830e2019-06-26 17:31:12 +02003623 }
Victor Stinner4403d7d2015-04-25 00:16:10 +02003624 PyMem_RawFree(buf);
3625
3626 return obj;
Victor Stinner689830e2019-06-26 17:31:12 +02003627#endif /* !MS_WINDOWS */
Mark Hammondc2e85bd2002-10-03 05:10:39 +00003628}
Guido van Rossumf0af3e32008-10-02 18:55:37 +00003629
Larry Hastings2f936352014-08-05 14:04:04 +10003630
3631/*[clinic input]
3632os.getcwd
3633
3634Return a unicode string representing the current working directory.
3635[clinic start generated code]*/
3636
Larry Hastings2f936352014-08-05 14:04:04 +10003637static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003638os_getcwd_impl(PyObject *module)
3639/*[clinic end generated code: output=21badfae2ea99ddc input=f069211bb70e3d39]*/
Guido van Rossumf0af3e32008-10-02 18:55:37 +00003640{
3641 return posix_getcwd(0);
3642}
3643
Larry Hastings2f936352014-08-05 14:04:04 +10003644
3645/*[clinic input]
3646os.getcwdb
3647
3648Return a bytes string representing the current working directory.
3649[clinic start generated code]*/
3650
Larry Hastings2f936352014-08-05 14:04:04 +10003651static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003652os_getcwdb_impl(PyObject *module)
3653/*[clinic end generated code: output=3dd47909480e4824 input=f6f6a378dad3d9cb]*/
Guido van Rossumf0af3e32008-10-02 18:55:37 +00003654{
3655 return posix_getcwd(1);
3656}
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003657
Larry Hastings2f936352014-08-05 14:04:04 +10003658
Larry Hastings9cf065c2012-06-22 16:30:09 -07003659#if ((!defined(HAVE_LINK)) && defined(MS_WINDOWS))
3660#define HAVE_LINK 1
3661#endif
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00003662
Guido van Rossumb6775db1994-08-01 11:34:53 +00003663#ifdef HAVE_LINK
Larry Hastings2f936352014-08-05 14:04:04 +10003664/*[clinic input]
3665
3666os.link
3667
3668 src : path_t
3669 dst : path_t
3670 *
3671 src_dir_fd : dir_fd = None
3672 dst_dir_fd : dir_fd = None
3673 follow_symlinks: bool = True
3674
3675Create a hard link to a file.
3676
3677If either src_dir_fd or dst_dir_fd is not None, it should be a file
3678 descriptor open to a directory, and the respective path string (src or dst)
3679 should be relative; the path will then be relative to that directory.
3680If follow_symlinks is False, and the last element of src is a symbolic
3681 link, link will create a link to the symbolic link itself instead of the
3682 file the link points to.
3683src_dir_fd, dst_dir_fd, and follow_symlinks may not be implemented on your
3684 platform. If they are unavailable, using them will raise a
3685 NotImplementedError.
3686[clinic start generated code]*/
3687
Larry Hastings2f936352014-08-05 14:04:04 +10003688static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003689os_link_impl(PyObject *module, path_t *src, path_t *dst, int src_dir_fd,
Larry Hastings89964c42015-04-14 18:07:59 -04003690 int dst_dir_fd, int follow_symlinks)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003691/*[clinic end generated code: output=7f00f6007fd5269a input=b0095ebbcbaa7e04]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003692{
Larry Hastings9cf065c2012-06-22 16:30:09 -07003693#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07003694 BOOL result = FALSE;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003695#else
3696 int result;
3697#endif
3698
Larry Hastings9cf065c2012-06-22 16:30:09 -07003699#ifndef HAVE_LINKAT
3700 if ((src_dir_fd != DEFAULT_DIR_FD) || (dst_dir_fd != DEFAULT_DIR_FD)) {
3701 argument_unavailable_error("link", "src_dir_fd and dst_dir_fd");
Larry Hastings2f936352014-08-05 14:04:04 +10003702 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003703 }
3704#endif
3705
Steve Dowercc16be82016-09-08 10:35:16 -07003706#ifndef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10003707 if ((src->narrow && dst->wide) || (src->wide && dst->narrow)) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07003708 PyErr_SetString(PyExc_NotImplementedError,
3709 "link: src and dst must be the same type");
Larry Hastings2f936352014-08-05 14:04:04 +10003710 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003711 }
Steve Dowercc16be82016-09-08 10:35:16 -07003712#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003713
Saiyang Gou7514f4f2020-02-12 23:47:42 -08003714 if (PySys_Audit("os.link", "OOii", src->object, dst->object,
3715 src_dir_fd == DEFAULT_DIR_FD ? -1 : src_dir_fd,
3716 dst_dir_fd == DEFAULT_DIR_FD ? -1 : dst_dir_fd) < 0) {
3717 return NULL;
3718 }
3719
Brian Curtin1b9df392010-11-24 20:24:31 +00003720#ifdef MS_WINDOWS
Larry Hastings9cf065c2012-06-22 16:30:09 -07003721 Py_BEGIN_ALLOW_THREADS
Steve Dowerc3630612016-11-19 18:41:16 -08003722 result = CreateHardLinkW(dst->wide, src->wide, NULL);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003723 Py_END_ALLOW_THREADS
Brian Curtin1b9df392010-11-24 20:24:31 +00003724
Larry Hastings2f936352014-08-05 14:04:04 +10003725 if (!result)
3726 return path_error2(src, dst);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003727#else
3728 Py_BEGIN_ALLOW_THREADS
Larry Hastings67cbf7b2012-06-22 17:06:48 -07003729#ifdef HAVE_LINKAT
Larry Hastings9cf065c2012-06-22 16:30:09 -07003730 if ((src_dir_fd != DEFAULT_DIR_FD) ||
3731 (dst_dir_fd != DEFAULT_DIR_FD) ||
3732 (!follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10003733 result = linkat(src_dir_fd, src->narrow,
3734 dst_dir_fd, dst->narrow,
Larry Hastings9cf065c2012-06-22 16:30:09 -07003735 follow_symlinks ? AT_SYMLINK_FOLLOW : 0);
3736 else
Steve Dowercc16be82016-09-08 10:35:16 -07003737#endif /* HAVE_LINKAT */
Larry Hastings2f936352014-08-05 14:04:04 +10003738 result = link(src->narrow, dst->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003739 Py_END_ALLOW_THREADS
Brian Curtinfc889c42010-11-28 23:59:46 +00003740
Larry Hastings2f936352014-08-05 14:04:04 +10003741 if (result)
3742 return path_error2(src, dst);
Steve Dowercc16be82016-09-08 10:35:16 -07003743#endif /* MS_WINDOWS */
Larry Hastings9cf065c2012-06-22 16:30:09 -07003744
Larry Hastings2f936352014-08-05 14:04:04 +10003745 Py_RETURN_NONE;
Brian Curtin1b9df392010-11-24 20:24:31 +00003746}
Larry Hastings9cf065c2012-06-22 16:30:09 -07003747#endif
3748
Brian Curtin1b9df392010-11-24 20:24:31 +00003749
Gregory P. Smith16ea14a2013-03-20 18:51:33 -07003750#if defined(MS_WINDOWS) && !defined(HAVE_OPENDIR)
Barry Warsaw53699e91996-12-10 23:23:01 +00003751static PyObject *
Gregory P. Smith40a21602013-03-20 20:52:50 -07003752_listdir_windows_no_opendir(path_t *path, PyObject *list)
Guido van Rossumb6775db1994-08-01 11:34:53 +00003753{
Larry Hastings9cf065c2012-06-22 16:30:09 -07003754 PyObject *v;
3755 HANDLE hFindFile = INVALID_HANDLE_VALUE;
3756 BOOL result;
Steve Dowercc16be82016-09-08 10:35:16 -07003757 wchar_t namebuf[MAX_PATH+4]; /* Overallocate for "\*.*" */
Larry Hastings9cf065c2012-06-22 16:30:09 -07003758 /* only claim to have space for MAX_PATH */
Victor Stinner75875072013-11-24 19:23:25 +01003759 Py_ssize_t len = Py_ARRAY_LENGTH(namebuf)-4;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003760 wchar_t *wnamebuf = NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003761
Steve Dowercc16be82016-09-08 10:35:16 -07003762 WIN32_FIND_DATAW wFileData;
3763 const wchar_t *po_wchars;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00003764
Steve Dowercc16be82016-09-08 10:35:16 -07003765 if (!path->wide) { /* Default arg: "." */
3766 po_wchars = L".";
3767 len = 1;
3768 } else {
3769 po_wchars = path->wide;
3770 len = wcslen(path->wide);
3771 }
3772 /* The +5 is so we can append "\\*.*\0" */
3773 wnamebuf = PyMem_New(wchar_t, len + 5);
3774 if (!wnamebuf) {
3775 PyErr_NoMemory();
Larry Hastings9cf065c2012-06-22 16:30:09 -07003776 goto exit;
Victor Stinner8c62be82010-05-06 00:08:46 +00003777 }
Steve Dowercc16be82016-09-08 10:35:16 -07003778 wcscpy(wnamebuf, po_wchars);
Victor Stinner8c62be82010-05-06 00:08:46 +00003779 if (len > 0) {
Steve Dowercc16be82016-09-08 10:35:16 -07003780 wchar_t wch = wnamebuf[len-1];
3781 if (wch != SEP && wch != ALTSEP && wch != L':')
3782 wnamebuf[len++] = SEP;
3783 wcscpy(wnamebuf + len, L"*.*");
Victor Stinner8c62be82010-05-06 00:08:46 +00003784 }
Steve Dowercc16be82016-09-08 10:35:16 -07003785 if ((list = PyList_New(0)) == NULL) {
3786 goto exit;
3787 }
Antoine Pitroub73caab2010-08-09 23:39:31 +00003788 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07003789 hFindFile = FindFirstFileW(wnamebuf, &wFileData);
Antoine Pitroub73caab2010-08-09 23:39:31 +00003790 Py_END_ALLOW_THREADS
Victor Stinner8c62be82010-05-06 00:08:46 +00003791 if (hFindFile == INVALID_HANDLE_VALUE) {
3792 int error = GetLastError();
3793 if (error == ERROR_FILE_NOT_FOUND)
Larry Hastings9cf065c2012-06-22 16:30:09 -07003794 goto exit;
3795 Py_DECREF(list);
Gregory P. Smith40a21602013-03-20 20:52:50 -07003796 list = path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003797 goto exit;
Victor Stinner8c62be82010-05-06 00:08:46 +00003798 }
3799 do {
3800 /* Skip over . and .. */
Steve Dowercc16be82016-09-08 10:35:16 -07003801 if (wcscmp(wFileData.cFileName, L".") != 0 &&
3802 wcscmp(wFileData.cFileName, L"..") != 0) {
3803 v = PyUnicode_FromWideChar(wFileData.cFileName,
3804 wcslen(wFileData.cFileName));
3805 if (path->narrow && v) {
3806 Py_SETREF(v, PyUnicode_EncodeFSDefault(v));
3807 }
Victor Stinner8c62be82010-05-06 00:08:46 +00003808 if (v == NULL) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07003809 Py_DECREF(list);
3810 list = NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00003811 break;
3812 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07003813 if (PyList_Append(list, v) != 0) {
Victor Stinner8c62be82010-05-06 00:08:46 +00003814 Py_DECREF(v);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003815 Py_DECREF(list);
3816 list = NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00003817 break;
3818 }
3819 Py_DECREF(v);
3820 }
3821 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07003822 result = FindNextFileW(hFindFile, &wFileData);
Victor Stinner8c62be82010-05-06 00:08:46 +00003823 Py_END_ALLOW_THREADS
3824 /* FindNextFile sets error to ERROR_NO_MORE_FILES if
3825 it got to the end of the directory. */
3826 if (!result && GetLastError() != ERROR_NO_MORE_FILES) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07003827 Py_DECREF(list);
Gregory P. Smith40a21602013-03-20 20:52:50 -07003828 list = path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003829 goto exit;
Victor Stinner8c62be82010-05-06 00:08:46 +00003830 }
3831 } while (result == TRUE);
Guido van Rossumb6775db1994-08-01 11:34:53 +00003832
Larry Hastings9cf065c2012-06-22 16:30:09 -07003833exit:
3834 if (hFindFile != INVALID_HANDLE_VALUE) {
3835 if (FindClose(hFindFile) == FALSE) {
3836 if (list != NULL) {
3837 Py_DECREF(list);
Gregory P. Smith40a21602013-03-20 20:52:50 -07003838 list = path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003839 }
3840 }
Victor Stinner8c62be82010-05-06 00:08:46 +00003841 }
Victor Stinnerb6404912013-07-07 16:21:41 +02003842 PyMem_Free(wnamebuf);
Guido van Rossumb6775db1994-08-01 11:34:53 +00003843
Larry Hastings9cf065c2012-06-22 16:30:09 -07003844 return list;
Gregory P. Smith16ea14a2013-03-20 18:51:33 -07003845} /* end of _listdir_windows_no_opendir */
3846
3847#else /* thus POSIX, ie: not (MS_WINDOWS and not HAVE_OPENDIR) */
3848
3849static PyObject *
Gregory P. Smith40a21602013-03-20 20:52:50 -07003850_posix_listdir(path_t *path, PyObject *list)
Gregory P. Smith16ea14a2013-03-20 18:51:33 -07003851{
Gregory P. Smith16ea14a2013-03-20 18:51:33 -07003852 PyObject *v;
3853 DIR *dirp = NULL;
3854 struct dirent *ep;
3855 int return_str; /* if false, return bytes */
Larry Hastings4dbc95e2013-08-01 18:18:56 -07003856#ifdef HAVE_FDOPENDIR
3857 int fd = -1;
3858#endif
Gregory P. Smith16ea14a2013-03-20 18:51:33 -07003859
Victor Stinner8c62be82010-05-06 00:08:46 +00003860 errno = 0;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003861#ifdef HAVE_FDOPENDIR
Gregory P. Smith40a21602013-03-20 20:52:50 -07003862 if (path->fd != -1) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07003863 /* closedir() closes the FD, so we duplicate it */
Victor Stinnerdaf45552013-08-28 00:53:59 +02003864 fd = _Py_dup(path->fd);
Victor Stinnerf3266652013-12-19 13:24:49 +01003865 if (fd == -1)
3866 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003867
Larry Hastingsfdaea062012-06-25 04:42:23 -07003868 return_str = 1;
3869
Larry Hastings9cf065c2012-06-22 16:30:09 -07003870 Py_BEGIN_ALLOW_THREADS
3871 dirp = fdopendir(fd);
3872 Py_END_ALLOW_THREADS
3873 }
3874 else
3875#endif
3876 {
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03003877 const char *name;
Gregory P. Smith40a21602013-03-20 20:52:50 -07003878 if (path->narrow) {
3879 name = path->narrow;
Serhiy Storchaka1180e5a2017-07-11 06:36:46 +03003880 /* only return bytes if they specified a bytes-like object */
3881 return_str = !PyObject_CheckBuffer(path->object);
Larry Hastingsfdaea062012-06-25 04:42:23 -07003882 }
3883 else {
3884 name = ".";
3885 return_str = 1;
3886 }
3887
Larry Hastings9cf065c2012-06-22 16:30:09 -07003888 Py_BEGIN_ALLOW_THREADS
3889 dirp = opendir(name);
3890 Py_END_ALLOW_THREADS
3891 }
3892
3893 if (dirp == NULL) {
Gregory P. Smith40a21602013-03-20 20:52:50 -07003894 list = path_error(path);
Larry Hastings4dbc95e2013-08-01 18:18:56 -07003895#ifdef HAVE_FDOPENDIR
3896 if (fd != -1) {
3897 Py_BEGIN_ALLOW_THREADS
3898 close(fd);
3899 Py_END_ALLOW_THREADS
3900 }
3901#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07003902 goto exit;
3903 }
3904 if ((list = PyList_New(0)) == NULL) {
3905 goto exit;
Victor Stinner8c62be82010-05-06 00:08:46 +00003906 }
3907 for (;;) {
3908 errno = 0;
3909 Py_BEGIN_ALLOW_THREADS
3910 ep = readdir(dirp);
3911 Py_END_ALLOW_THREADS
3912 if (ep == NULL) {
3913 if (errno == 0) {
3914 break;
3915 } else {
Larry Hastings9cf065c2012-06-22 16:30:09 -07003916 Py_DECREF(list);
Gregory P. Smith40a21602013-03-20 20:52:50 -07003917 list = path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003918 goto exit;
Victor Stinner8c62be82010-05-06 00:08:46 +00003919 }
3920 }
3921 if (ep->d_name[0] == '.' &&
3922 (NAMLEN(ep) == 1 ||
3923 (ep->d_name[1] == '.' && NAMLEN(ep) == 2)))
3924 continue;
Larry Hastingsfdaea062012-06-25 04:42:23 -07003925 if (return_str)
Victor Stinnera45598a2010-05-14 16:35:39 +00003926 v = PyUnicode_DecodeFSDefaultAndSize(ep->d_name, NAMLEN(ep));
3927 else
3928 v = PyBytes_FromStringAndSize(ep->d_name, NAMLEN(ep));
Victor Stinner8c62be82010-05-06 00:08:46 +00003929 if (v == NULL) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07003930 Py_CLEAR(list);
Victor Stinner8c62be82010-05-06 00:08:46 +00003931 break;
3932 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07003933 if (PyList_Append(list, v) != 0) {
Victor Stinner8c62be82010-05-06 00:08:46 +00003934 Py_DECREF(v);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003935 Py_CLEAR(list);
Victor Stinner8c62be82010-05-06 00:08:46 +00003936 break;
3937 }
3938 Py_DECREF(v);
3939 }
Guido van Rossum0ee42cd1991-04-08 21:01:03 +00003940
Larry Hastings9cf065c2012-06-22 16:30:09 -07003941exit:
3942 if (dirp != NULL) {
3943 Py_BEGIN_ALLOW_THREADS
Larry Hastings4dbc95e2013-08-01 18:18:56 -07003944#ifdef HAVE_FDOPENDIR
Larry Hastings9cf065c2012-06-22 16:30:09 -07003945 if (fd > -1)
3946 rewinddir(dirp);
Larry Hastings4dbc95e2013-08-01 18:18:56 -07003947#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07003948 closedir(dirp);
3949 Py_END_ALLOW_THREADS
3950 }
3951
Larry Hastings9cf065c2012-06-22 16:30:09 -07003952 return list;
Gregory P. Smith16ea14a2013-03-20 18:51:33 -07003953} /* end of _posix_listdir */
3954#endif /* which OS */
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00003955
Larry Hastings2f936352014-08-05 14:04:04 +10003956
3957/*[clinic input]
3958os.listdir
3959
3960 path : path_t(nullable=True, allow_fd='PATH_HAVE_FDOPENDIR') = None
3961
3962Return a list containing the names of the files in the directory.
3963
BNMetricsb9427072018-11-02 15:20:19 +00003964path can be specified as either str, bytes, or a path-like object. If path is bytes,
Larry Hastings2f936352014-08-05 14:04:04 +10003965 the filenames returned will also be bytes; in all other circumstances
3966 the filenames returned will be str.
3967If path is None, uses the path='.'.
3968On some platforms, path may also be specified as an open file descriptor;\
3969 the file descriptor must refer to a directory.
3970 If this functionality is unavailable, using it raises NotImplementedError.
3971
3972The list is in arbitrary order. It does not include the special
3973entries '.' and '..' even if they are present in the directory.
3974
3975
3976[clinic start generated code]*/
3977
Larry Hastings2f936352014-08-05 14:04:04 +10003978static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003979os_listdir_impl(PyObject *module, path_t *path)
BNMetricsb9427072018-11-02 15:20:19 +00003980/*[clinic end generated code: output=293045673fcd1a75 input=e3f58030f538295d]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003981{
Steve Dower60419a72019-06-24 08:42:54 -07003982 if (PySys_Audit("os.listdir", "O",
3983 path->object ? path->object : Py_None) < 0) {
3984 return NULL;
3985 }
Larry Hastings2f936352014-08-05 14:04:04 +10003986#if defined(MS_WINDOWS) && !defined(HAVE_OPENDIR)
3987 return _listdir_windows_no_opendir(path, NULL);
3988#else
3989 return _posix_listdir(path, NULL);
3990#endif
3991}
3992
Martin v. Löwis6238d2b2002-06-30 15:26:10 +00003993#ifdef MS_WINDOWS
Mark Hammondef8b6542001-05-13 08:04:26 +00003994/* A helper function for abspath on win32 */
Serhiy Storchakaf0b50152015-05-13 00:52:39 +03003995/*[clinic input]
3996os._getfullpathname
Victor Stinnereb5657a2011-09-30 01:44:27 +02003997
Serhiy Storchakaf0b50152015-05-13 00:52:39 +03003998 path: path_t
3999 /
4000
4001[clinic start generated code]*/
4002
4003static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004004os__getfullpathname_impl(PyObject *module, path_t *path)
4005/*[clinic end generated code: output=bb8679d56845bc9b input=332ed537c29d0a3e]*/
Serhiy Storchakaf0b50152015-05-13 00:52:39 +03004006{
Victor Stinner3939c322019-06-25 15:02:43 +02004007 wchar_t *abspath;
Victor Stinnereb5657a2011-09-30 01:44:27 +02004008
Victor Stinner3939c322019-06-25 15:02:43 +02004009 /* _Py_abspath() is implemented with GetFullPathNameW() on Windows */
4010 if (_Py_abspath(path->wide, &abspath) < 0) {
4011 return win32_error_object("GetFullPathNameW", path->object);
Victor Stinner8c62be82010-05-06 00:08:46 +00004012 }
Victor Stinner3939c322019-06-25 15:02:43 +02004013 if (abspath == NULL) {
4014 return PyErr_NoMemory();
4015 }
4016
4017 PyObject *str = PyUnicode_FromWideChar(abspath, wcslen(abspath));
4018 PyMem_RawFree(abspath);
4019 if (str == NULL) {
4020 return NULL;
4021 }
4022 if (path->narrow) {
4023 Py_SETREF(str, PyUnicode_EncodeFSDefault(str));
4024 }
4025 return str;
Larry Hastings2f936352014-08-05 14:04:04 +10004026}
Brian Curtind40e6f72010-07-08 21:39:08 +00004027
Brian Curtind25aef52011-06-13 15:16:04 -05004028
Larry Hastings2f936352014-08-05 14:04:04 +10004029/*[clinic input]
4030os._getfinalpathname
Brian Curtinf5e76d02010-11-24 13:14:05 +00004031
Steve Dower23ad6d02018-02-22 10:39:10 -08004032 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +10004033 /
4034
4035A helper function for samepath on windows.
4036[clinic start generated code]*/
4037
Larry Hastings2f936352014-08-05 14:04:04 +10004038static PyObject *
Steve Dower23ad6d02018-02-22 10:39:10 -08004039os__getfinalpathname_impl(PyObject *module, path_t *path)
4040/*[clinic end generated code: output=621a3c79bc29ebfa input=2b6b6c7cbad5fb84]*/
Brian Curtind40e6f72010-07-08 21:39:08 +00004041{
4042 HANDLE hFile;
Alexey Izbyshev3b20d342018-03-08 19:03:25 +03004043 wchar_t buf[MAXPATHLEN], *target_path = buf;
4044 int buf_size = Py_ARRAY_LENGTH(buf);
Brian Curtind40e6f72010-07-08 21:39:08 +00004045 int result_length;
Larry Hastings2f936352014-08-05 14:04:04 +10004046 PyObject *result;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00004047
Steve Dower23ad6d02018-02-22 10:39:10 -08004048 Py_BEGIN_ALLOW_THREADS
Brian Curtind40e6f72010-07-08 21:39:08 +00004049 hFile = CreateFileW(
Steve Dower23ad6d02018-02-22 10:39:10 -08004050 path->wide,
Brian Curtind40e6f72010-07-08 21:39:08 +00004051 0, /* desired access */
4052 0, /* share mode */
4053 NULL, /* security attributes */
4054 OPEN_EXISTING,
4055 /* FILE_FLAG_BACKUP_SEMANTICS is required to open a directory */
4056 FILE_FLAG_BACKUP_SEMANTICS,
4057 NULL);
Alexey Izbyshev3b20d342018-03-08 19:03:25 +03004058 Py_END_ALLOW_THREADS
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00004059
Steve Dower23ad6d02018-02-22 10:39:10 -08004060 if (hFile == INVALID_HANDLE_VALUE) {
Alexey Izbyshev3b20d342018-03-08 19:03:25 +03004061 return win32_error_object("CreateFileW", path->object);
Steve Dower23ad6d02018-02-22 10:39:10 -08004062 }
Brian Curtind40e6f72010-07-08 21:39:08 +00004063
4064 /* We have a good handle to the target, use it to determine the
4065 target path name. */
Alexey Izbyshev3b20d342018-03-08 19:03:25 +03004066 while (1) {
4067 Py_BEGIN_ALLOW_THREADS
4068 result_length = GetFinalPathNameByHandleW(hFile, target_path,
4069 buf_size, VOLUME_NAME_DOS);
4070 Py_END_ALLOW_THREADS
Brian Curtind40e6f72010-07-08 21:39:08 +00004071
Alexey Izbyshev3b20d342018-03-08 19:03:25 +03004072 if (!result_length) {
4073 result = win32_error_object("GetFinalPathNameByHandleW",
4074 path->object);
4075 goto cleanup;
4076 }
Brian Curtind40e6f72010-07-08 21:39:08 +00004077
Alexey Izbyshev3b20d342018-03-08 19:03:25 +03004078 if (result_length < buf_size) {
4079 break;
4080 }
Brian Curtind40e6f72010-07-08 21:39:08 +00004081
Alexey Izbyshev3b20d342018-03-08 19:03:25 +03004082 wchar_t *tmp;
4083 tmp = PyMem_Realloc(target_path != buf ? target_path : NULL,
4084 result_length * sizeof(*tmp));
4085 if (!tmp) {
4086 result = PyErr_NoMemory();
4087 goto cleanup;
4088 }
4089
4090 buf_size = result_length;
4091 target_path = tmp;
Steve Dower23ad6d02018-02-22 10:39:10 -08004092 }
Brian Curtind40e6f72010-07-08 21:39:08 +00004093
Victor Stinner9d3b93b2011-11-22 02:27:30 +01004094 result = PyUnicode_FromWideChar(target_path, result_length);
Steve Dowerdf2d4a62019-08-21 15:27:33 -07004095 if (result && path->narrow) {
Steve Dower23ad6d02018-02-22 10:39:10 -08004096 Py_SETREF(result, PyUnicode_EncodeFSDefault(result));
Steve Dowerdf2d4a62019-08-21 15:27:33 -07004097 }
Steve Dower23ad6d02018-02-22 10:39:10 -08004098
Alexey Izbyshev3b20d342018-03-08 19:03:25 +03004099cleanup:
4100 if (target_path != buf) {
4101 PyMem_Free(target_path);
4102 }
4103 CloseHandle(hFile);
4104 return result;
Larry Hastings2f936352014-08-05 14:04:04 +10004105}
Brian Curtin62857742010-09-06 17:07:27 +00004106
Tim Golden6b528062013-08-01 12:44:00 +01004107
Larry Hastings2f936352014-08-05 14:04:04 +10004108/*[clinic input]
4109os._getvolumepathname
4110
Steve Dower23ad6d02018-02-22 10:39:10 -08004111 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +10004112
4113A helper function for ismount on Win32.
4114[clinic start generated code]*/
4115
Larry Hastings2f936352014-08-05 14:04:04 +10004116static PyObject *
Steve Dower23ad6d02018-02-22 10:39:10 -08004117os__getvolumepathname_impl(PyObject *module, path_t *path)
4118/*[clinic end generated code: output=804c63fd13a1330b input=722b40565fa21552]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004119{
4120 PyObject *result;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03004121 wchar_t *mountpath=NULL;
Victor Stinner6edddfa2013-11-24 19:22:57 +01004122 size_t buflen;
Tim Golden6b528062013-08-01 12:44:00 +01004123 BOOL ret;
4124
Tim Golden6b528062013-08-01 12:44:00 +01004125 /* Volume path should be shorter than entire path */
Steve Dower23ad6d02018-02-22 10:39:10 -08004126 buflen = Py_MAX(path->length, MAX_PATH);
Victor Stinner6edddfa2013-11-24 19:22:57 +01004127
Victor Stinner850a18e2017-10-24 16:53:32 -07004128 if (buflen > PY_DWORD_MAX) {
Victor Stinner6edddfa2013-11-24 19:22:57 +01004129 PyErr_SetString(PyExc_OverflowError, "path too long");
4130 return NULL;
4131 }
4132
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02004133 mountpath = PyMem_New(wchar_t, buflen);
Tim Golden6b528062013-08-01 12:44:00 +01004134 if (mountpath == NULL)
4135 return PyErr_NoMemory();
4136
4137 Py_BEGIN_ALLOW_THREADS
Steve Dower23ad6d02018-02-22 10:39:10 -08004138 ret = GetVolumePathNameW(path->wide, mountpath,
Victor Stinner6edddfa2013-11-24 19:22:57 +01004139 Py_SAFE_DOWNCAST(buflen, size_t, DWORD));
Tim Golden6b528062013-08-01 12:44:00 +01004140 Py_END_ALLOW_THREADS
4141
4142 if (!ret) {
Steve Dower23ad6d02018-02-22 10:39:10 -08004143 result = win32_error_object("_getvolumepathname", path->object);
Tim Golden6b528062013-08-01 12:44:00 +01004144 goto exit;
4145 }
4146 result = PyUnicode_FromWideChar(mountpath, wcslen(mountpath));
Steve Dower23ad6d02018-02-22 10:39:10 -08004147 if (path->narrow)
4148 Py_SETREF(result, PyUnicode_EncodeFSDefault(result));
Tim Golden6b528062013-08-01 12:44:00 +01004149
4150exit:
4151 PyMem_Free(mountpath);
4152 return result;
4153}
Tim Golden6b528062013-08-01 12:44:00 +01004154
Martin v. Löwis6238d2b2002-06-30 15:26:10 +00004155#endif /* MS_WINDOWS */
Mark Hammondef8b6542001-05-13 08:04:26 +00004156
Larry Hastings2f936352014-08-05 14:04:04 +10004157
4158/*[clinic input]
4159os.mkdir
4160
4161 path : path_t
4162
4163 mode: int = 0o777
4164
4165 *
4166
4167 dir_fd : dir_fd(requires='mkdirat') = None
4168
4169# "mkdir(path, mode=0o777, *, dir_fd=None)\n\n\
4170
4171Create a directory.
4172
4173If dir_fd is not None, it should be a file descriptor open to a directory,
4174 and path should be relative; path will then be relative to that directory.
4175dir_fd may not be implemented on your platform.
4176 If it is unavailable, using it will raise a NotImplementedError.
4177
4178The mode argument is ignored on Windows.
4179[clinic start generated code]*/
4180
Larry Hastings2f936352014-08-05 14:04:04 +10004181static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004182os_mkdir_impl(PyObject *module, path_t *path, int mode, int dir_fd)
4183/*[clinic end generated code: output=a70446903abe821f input=e965f68377e9b1ce]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004184{
4185 int result;
Mark Hammondc2e85bd2002-10-03 05:10:39 +00004186
Saiyang Gou7514f4f2020-02-12 23:47:42 -08004187 if (PySys_Audit("os.mkdir", "Oii", path->object, mode,
4188 dir_fd == DEFAULT_DIR_FD ? -1 : dir_fd) < 0) {
4189 return NULL;
4190 }
4191
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00004192#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00004193 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07004194 result = CreateDirectoryW(path->wide, NULL);
Victor Stinner8c62be82010-05-06 00:08:46 +00004195 Py_END_ALLOW_THREADS
Mark Hammondc2e85bd2002-10-03 05:10:39 +00004196
Larry Hastings2f936352014-08-05 14:04:04 +10004197 if (!result)
4198 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004199#else
Victor Stinner8c62be82010-05-06 00:08:46 +00004200 Py_BEGIN_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07004201#if HAVE_MKDIRAT
4202 if (dir_fd != DEFAULT_DIR_FD)
Larry Hastings2f936352014-08-05 14:04:04 +10004203 result = mkdirat(dir_fd, path->narrow, mode);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004204 else
4205#endif
Erik Bray03eb11f2017-10-27 14:27:06 +02004206#if defined(__WATCOMC__) && !defined(__QNX__)
Larry Hastings2f936352014-08-05 14:04:04 +10004207 result = mkdir(path->narrow);
Guido van Rossuma4916fa1996-05-23 22:58:55 +00004208#else
Larry Hastings2f936352014-08-05 14:04:04 +10004209 result = mkdir(path->narrow, mode);
Guido van Rossuma4916fa1996-05-23 22:58:55 +00004210#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00004211 Py_END_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10004212 if (result < 0)
4213 return path_error(path);
Steve Dowercc16be82016-09-08 10:35:16 -07004214#endif /* MS_WINDOWS */
Larry Hastings2f936352014-08-05 14:04:04 +10004215 Py_RETURN_NONE;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004216}
4217
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004218
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004219/* sys/resource.h is needed for at least: wait3(), wait4(), broken nice. */
4220#if defined(HAVE_SYS_RESOURCE_H)
Thomas Wouterse38b2f12001-07-11 22:35:31 +00004221#include <sys/resource.h>
4222#endif
Thomas Wouterse38b2f12001-07-11 22:35:31 +00004223
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004224
4225#ifdef HAVE_NICE
Larry Hastings2f936352014-08-05 14:04:04 +10004226/*[clinic input]
4227os.nice
4228
4229 increment: int
4230 /
4231
4232Add increment to the priority of process and return the new priority.
4233[clinic start generated code]*/
4234
Larry Hastings2f936352014-08-05 14:04:04 +10004235static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004236os_nice_impl(PyObject *module, int increment)
4237/*[clinic end generated code: output=9dad8a9da8109943 input=864be2d402a21da2]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004238{
4239 int value;
Thomas Woutersc2c12dc2001-07-11 14:45:34 +00004240
Victor Stinner8c62be82010-05-06 00:08:46 +00004241 /* There are two flavours of 'nice': one that returns the new
4242 priority (as required by almost all standards out there) and the
Benjamin Peterson288d1da2017-09-28 22:44:27 -07004243 Linux/FreeBSD one, which returns '0' on success and advices
Victor Stinner8c62be82010-05-06 00:08:46 +00004244 the use of getpriority() to get the new priority.
Tim Peters5aa91602002-01-30 05:46:57 +00004245
Victor Stinner8c62be82010-05-06 00:08:46 +00004246 If we are of the nice family that returns the new priority, we
4247 need to clear errno before the call, and check if errno is filled
4248 before calling posix_error() on a returnvalue of -1, because the
4249 -1 may be the actual new priority! */
Thomas Woutersc2c12dc2001-07-11 14:45:34 +00004250
Victor Stinner8c62be82010-05-06 00:08:46 +00004251 errno = 0;
4252 value = nice(increment);
Thomas Wouterse38b2f12001-07-11 22:35:31 +00004253#if defined(HAVE_BROKEN_NICE) && defined(HAVE_GETPRIORITY)
Victor Stinner8c62be82010-05-06 00:08:46 +00004254 if (value == 0)
4255 value = getpriority(PRIO_PROCESS, 0);
Thomas Woutersc2c12dc2001-07-11 14:45:34 +00004256#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00004257 if (value == -1 && errno != 0)
4258 /* either nice() or getpriority() returned an error */
4259 return posix_error();
4260 return PyLong_FromLong((long) value);
Guido van Rossum775f4da1993-01-09 17:18:52 +00004261}
Guido van Rossumb6775db1994-08-01 11:34:53 +00004262#endif /* HAVE_NICE */
Guido van Rossum1ff6cb41991-04-08 20:59:13 +00004263
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00004264
4265#ifdef HAVE_GETPRIORITY
Larry Hastings2f936352014-08-05 14:04:04 +10004266/*[clinic input]
4267os.getpriority
4268
4269 which: int
4270 who: int
4271
4272Return program scheduling priority.
4273[clinic start generated code]*/
4274
Larry Hastings2f936352014-08-05 14:04:04 +10004275static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004276os_getpriority_impl(PyObject *module, int which, int who)
4277/*[clinic end generated code: output=c41b7b63c7420228 input=9be615d40e2544ef]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004278{
4279 int retval;
4280
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00004281 errno = 0;
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00004282 retval = getpriority(which, who);
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00004283 if (errno != 0)
4284 return posix_error();
4285 return PyLong_FromLong((long)retval);
4286}
4287#endif /* HAVE_GETPRIORITY */
4288
4289
4290#ifdef HAVE_SETPRIORITY
Larry Hastings2f936352014-08-05 14:04:04 +10004291/*[clinic input]
4292os.setpriority
4293
4294 which: int
4295 who: int
4296 priority: int
4297
4298Set program scheduling priority.
4299[clinic start generated code]*/
4300
Larry Hastings2f936352014-08-05 14:04:04 +10004301static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004302os_setpriority_impl(PyObject *module, int which, int who, int priority)
4303/*[clinic end generated code: output=3d910d95a7771eb2 input=710ccbf65b9dc513]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004304{
4305 int retval;
4306
4307 retval = setpriority(which, who, priority);
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00004308 if (retval == -1)
4309 return posix_error();
4310 Py_RETURN_NONE;
4311}
4312#endif /* HAVE_SETPRIORITY */
4313
4314
Barry Warsaw53699e91996-12-10 23:23:01 +00004315static PyObject *
Larry Hastings2f936352014-08-05 14:04:04 +10004316internal_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 +00004317{
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03004318 const char *function_name = is_replace ? "replace" : "rename";
Larry Hastings9cf065c2012-06-22 16:30:09 -07004319 int dir_fd_specified;
Larry Hastings9cf065c2012-06-22 16:30:09 -07004320
Mark Hammondc2e85bd2002-10-03 05:10:39 +00004321#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00004322 BOOL result;
Antoine Pitrouf3b2d882012-01-30 22:08:52 +01004323 int flags = is_replace ? MOVEFILE_REPLACE_EXISTING : 0;
Mark Hammondc2e85bd2002-10-03 05:10:39 +00004324#else
Larry Hastings9cf065c2012-06-22 16:30:09 -07004325 int result;
Mark Hammondc2e85bd2002-10-03 05:10:39 +00004326#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07004327
Larry Hastings9cf065c2012-06-22 16:30:09 -07004328 dir_fd_specified = (src_dir_fd != DEFAULT_DIR_FD) ||
4329 (dst_dir_fd != DEFAULT_DIR_FD);
4330#ifndef HAVE_RENAMEAT
4331 if (dir_fd_specified) {
4332 argument_unavailable_error(function_name, "src_dir_fd and dst_dir_fd");
Larry Hastings2f936352014-08-05 14:04:04 +10004333 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07004334 }
4335#endif
4336
Saiyang Gou7514f4f2020-02-12 23:47:42 -08004337 if (PySys_Audit("os.rename", "OOii", src->object, dst->object,
4338 src_dir_fd == DEFAULT_DIR_FD ? -1 : src_dir_fd,
4339 dst_dir_fd == DEFAULT_DIR_FD ? -1 : dst_dir_fd) < 0) {
4340 return NULL;
4341 }
4342
Larry Hastings9cf065c2012-06-22 16:30:09 -07004343#ifdef MS_WINDOWS
4344 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07004345 result = MoveFileExW(src->wide, dst->wide, flags);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004346 Py_END_ALLOW_THREADS
4347
Larry Hastings2f936352014-08-05 14:04:04 +10004348 if (!result)
4349 return path_error2(src, dst);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004350
4351#else
Steve Dowercc16be82016-09-08 10:35:16 -07004352 if ((src->narrow && dst->wide) || (src->wide && dst->narrow)) {
4353 PyErr_Format(PyExc_ValueError,
4354 "%s: src and dst must be the same type", function_name);
4355 return NULL;
4356 }
4357
Larry Hastings9cf065c2012-06-22 16:30:09 -07004358 Py_BEGIN_ALLOW_THREADS
4359#ifdef HAVE_RENAMEAT
4360 if (dir_fd_specified)
Larry Hastings2f936352014-08-05 14:04:04 +10004361 result = renameat(src_dir_fd, src->narrow, dst_dir_fd, dst->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004362 else
4363#endif
Steve Dowercc16be82016-09-08 10:35:16 -07004364 result = rename(src->narrow, dst->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004365 Py_END_ALLOW_THREADS
4366
Larry Hastings2f936352014-08-05 14:04:04 +10004367 if (result)
4368 return path_error2(src, dst);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004369#endif
Larry Hastings2f936352014-08-05 14:04:04 +10004370 Py_RETURN_NONE;
4371}
Larry Hastings9cf065c2012-06-22 16:30:09 -07004372
Larry Hastings2f936352014-08-05 14:04:04 +10004373
4374/*[clinic input]
4375os.rename
4376
4377 src : path_t
4378 dst : path_t
4379 *
4380 src_dir_fd : dir_fd = None
4381 dst_dir_fd : dir_fd = None
4382
4383Rename a file or directory.
4384
4385If either src_dir_fd or dst_dir_fd is not None, it should be a file
4386 descriptor open to a directory, and the respective path string (src or dst)
4387 should be relative; the path will then be relative to that directory.
4388src_dir_fd and dst_dir_fd, may not be implemented on your platform.
4389 If they are unavailable, using them will raise a NotImplementedError.
4390[clinic start generated code]*/
4391
Antoine Pitrouf3b2d882012-01-30 22:08:52 +01004392static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004393os_rename_impl(PyObject *module, path_t *src, path_t *dst, int src_dir_fd,
Larry Hastings89964c42015-04-14 18:07:59 -04004394 int dst_dir_fd)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004395/*[clinic end generated code: output=59e803072cf41230 input=faa61c847912c850]*/
Antoine Pitrouf3b2d882012-01-30 22:08:52 +01004396{
Larry Hastings2f936352014-08-05 14:04:04 +10004397 return internal_rename(src, dst, src_dir_fd, dst_dir_fd, 0);
Antoine Pitrouf3b2d882012-01-30 22:08:52 +01004398}
4399
Larry Hastings2f936352014-08-05 14:04:04 +10004400
4401/*[clinic input]
4402os.replace = os.rename
4403
4404Rename a file or directory, overwriting the destination.
4405
4406If either src_dir_fd or dst_dir_fd is not None, it should be a file
4407 descriptor open to a directory, and the respective path string (src or dst)
4408 should be relative; the path will then be relative to that directory.
4409src_dir_fd and dst_dir_fd, may not be implemented on your platform.
Anthony Sottile73d60022019-02-12 23:15:54 -05004410 If they are unavailable, using them will raise a NotImplementedError.
Larry Hastings2f936352014-08-05 14:04:04 +10004411[clinic start generated code]*/
4412
Larry Hastings2f936352014-08-05 14:04:04 +10004413static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004414os_replace_impl(PyObject *module, path_t *src, path_t *dst, int src_dir_fd,
4415 int dst_dir_fd)
Anthony Sottile73d60022019-02-12 23:15:54 -05004416/*[clinic end generated code: output=1968c02e7857422b input=c003f0def43378ef]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004417{
4418 return internal_rename(src, dst, src_dir_fd, dst_dir_fd, 1);
4419}
4420
4421
4422/*[clinic input]
4423os.rmdir
4424
4425 path: path_t
4426 *
4427 dir_fd: dir_fd(requires='unlinkat') = None
4428
4429Remove a directory.
4430
4431If dir_fd is not None, it should be a file descriptor open to a directory,
4432 and path should be relative; path will then be relative to that directory.
4433dir_fd may not be implemented on your platform.
4434 If it is unavailable, using it will raise a NotImplementedError.
4435[clinic start generated code]*/
4436
Larry Hastings2f936352014-08-05 14:04:04 +10004437static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004438os_rmdir_impl(PyObject *module, path_t *path, int dir_fd)
4439/*[clinic end generated code: output=080eb54f506e8301 input=38c8b375ca34a7e2]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004440{
4441 int result;
Larry Hastingsb698d8e2012-06-23 16:55:07 -07004442
Saiyang Gou7514f4f2020-02-12 23:47:42 -08004443 if (PySys_Audit("os.rmdir", "Oi", path->object,
4444 dir_fd == DEFAULT_DIR_FD ? -1 : dir_fd) < 0) {
4445 return NULL;
4446 }
4447
Larry Hastingsb698d8e2012-06-23 16:55:07 -07004448 Py_BEGIN_ALLOW_THREADS
4449#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07004450 /* Windows, success=1, UNIX, success=0 */
4451 result = !RemoveDirectoryW(path->wide);
Larry Hastingsb698d8e2012-06-23 16:55:07 -07004452#else
4453#ifdef HAVE_UNLINKAT
4454 if (dir_fd != DEFAULT_DIR_FD)
Larry Hastings2f936352014-08-05 14:04:04 +10004455 result = unlinkat(dir_fd, path->narrow, AT_REMOVEDIR);
Larry Hastingsb698d8e2012-06-23 16:55:07 -07004456 else
4457#endif
Larry Hastings2f936352014-08-05 14:04:04 +10004458 result = rmdir(path->narrow);
Larry Hastingsb698d8e2012-06-23 16:55:07 -07004459#endif
4460 Py_END_ALLOW_THREADS
4461
Larry Hastings2f936352014-08-05 14:04:04 +10004462 if (result)
4463 return path_error(path);
Larry Hastingsb698d8e2012-06-23 16:55:07 -07004464
Larry Hastings2f936352014-08-05 14:04:04 +10004465 Py_RETURN_NONE;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004466}
4467
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004468
Guido van Rossuma4916fa1996-05-23 22:58:55 +00004469#ifdef HAVE_SYSTEM
Larry Hastings2f936352014-08-05 14:04:04 +10004470#ifdef MS_WINDOWS
4471/*[clinic input]
4472os.system -> long
4473
4474 command: Py_UNICODE
4475
4476Execute the command in a subshell.
4477[clinic start generated code]*/
4478
Larry Hastings2f936352014-08-05 14:04:04 +10004479static long
Serhiy Storchakaafb3e712018-12-14 11:19:51 +02004480os_system_impl(PyObject *module, const Py_UNICODE *command)
4481/*[clinic end generated code: output=5b7c3599c068ca42 input=303f5ce97df606b0]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004482{
4483 long result;
Steve Dowerb82e17e2019-05-23 08:45:22 -07004484
Steve Dowerfbe3c762019-10-18 00:52:15 -07004485 if (PySys_Audit("os.system", "(u)", command) < 0) {
Steve Dowerb82e17e2019-05-23 08:45:22 -07004486 return -1;
4487 }
4488
Victor Stinner8c62be82010-05-06 00:08:46 +00004489 Py_BEGIN_ALLOW_THREADS
Steve Dowerc3630612016-11-19 18:41:16 -08004490 _Py_BEGIN_SUPPRESS_IPH
Larry Hastings2f936352014-08-05 14:04:04 +10004491 result = _wsystem(command);
Steve Dowerc3630612016-11-19 18:41:16 -08004492 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00004493 Py_END_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10004494 return result;
4495}
4496#else /* MS_WINDOWS */
4497/*[clinic input]
4498os.system -> long
4499
4500 command: FSConverter
4501
4502Execute the command in a subshell.
4503[clinic start generated code]*/
4504
Larry Hastings2f936352014-08-05 14:04:04 +10004505static long
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004506os_system_impl(PyObject *module, PyObject *command)
4507/*[clinic end generated code: output=290fc437dd4f33a0 input=86a58554ba6094af]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004508{
4509 long result;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03004510 const char *bytes = PyBytes_AsString(command);
Steve Dowerb82e17e2019-05-23 08:45:22 -07004511
Steve Dowerfbe3c762019-10-18 00:52:15 -07004512 if (PySys_Audit("os.system", "(O)", command) < 0) {
Steve Dowerb82e17e2019-05-23 08:45:22 -07004513 return -1;
4514 }
4515
Larry Hastings2f936352014-08-05 14:04:04 +10004516 Py_BEGIN_ALLOW_THREADS
4517 result = system(bytes);
4518 Py_END_ALLOW_THREADS
4519 return result;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004520}
Guido van Rossuma4916fa1996-05-23 22:58:55 +00004521#endif
Larry Hastings2f936352014-08-05 14:04:04 +10004522#endif /* HAVE_SYSTEM */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004523
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004524
Larry Hastings2f936352014-08-05 14:04:04 +10004525/*[clinic input]
4526os.umask
4527
4528 mask: int
4529 /
4530
4531Set the current numeric umask and return the previous umask.
4532[clinic start generated code]*/
4533
Larry Hastings2f936352014-08-05 14:04:04 +10004534static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004535os_umask_impl(PyObject *module, int mask)
4536/*[clinic end generated code: output=a2e33ce3bc1a6e33 input=ab6bfd9b24d8a7e8]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004537{
4538 int i = (int)umask(mask);
Victor Stinner8c62be82010-05-06 00:08:46 +00004539 if (i < 0)
4540 return posix_error();
4541 return PyLong_FromLong((long)i);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004542}
4543
Brian Curtind40e6f72010-07-08 21:39:08 +00004544#ifdef MS_WINDOWS
4545
4546/* override the default DeleteFileW behavior so that directory
4547symlinks can be removed with this function, the same as with
4548Unix symlinks */
4549BOOL WINAPI Py_DeleteFileW(LPCWSTR lpFileName)
4550{
4551 WIN32_FILE_ATTRIBUTE_DATA info;
4552 WIN32_FIND_DATAW find_data;
4553 HANDLE find_data_handle;
4554 int is_directory = 0;
4555 int is_link = 0;
4556
4557 if (GetFileAttributesExW(lpFileName, GetFileExInfoStandard, &info)) {
4558 is_directory = info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00004559
Brian Curtind40e6f72010-07-08 21:39:08 +00004560 /* Get WIN32_FIND_DATA structure for the path to determine if
4561 it is a symlink */
4562 if(is_directory &&
4563 info.dwFileAttributes & FILE_ATTRIBUTE_REPARSE_POINT) {
4564 find_data_handle = FindFirstFileW(lpFileName, &find_data);
4565
4566 if(find_data_handle != INVALID_HANDLE_VALUE) {
Tim Golden0321cf22014-05-05 19:46:17 +01004567 /* IO_REPARSE_TAG_SYMLINK if it is a symlink and
4568 IO_REPARSE_TAG_MOUNT_POINT if it is a junction point. */
4569 is_link = find_data.dwReserved0 == IO_REPARSE_TAG_SYMLINK ||
4570 find_data.dwReserved0 == IO_REPARSE_TAG_MOUNT_POINT;
Brian Curtind40e6f72010-07-08 21:39:08 +00004571 FindClose(find_data_handle);
4572 }
4573 }
4574 }
4575
4576 if (is_directory && is_link)
4577 return RemoveDirectoryW(lpFileName);
4578
4579 return DeleteFileW(lpFileName);
4580}
4581#endif /* MS_WINDOWS */
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004582
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004583
Larry Hastings2f936352014-08-05 14:04:04 +10004584/*[clinic input]
4585os.unlink
4586
4587 path: path_t
4588 *
4589 dir_fd: dir_fd(requires='unlinkat')=None
4590
4591Remove a file (same as remove()).
4592
4593If dir_fd is not None, it should be a file descriptor open to a directory,
4594 and path should be relative; path will then be relative to that directory.
4595dir_fd may not be implemented on your platform.
4596 If it is unavailable, using it will raise a NotImplementedError.
4597
4598[clinic start generated code]*/
4599
Larry Hastings2f936352014-08-05 14:04:04 +10004600static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004601os_unlink_impl(PyObject *module, path_t *path, int dir_fd)
4602/*[clinic end generated code: output=621797807b9963b1 input=d7bcde2b1b2a2552]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004603{
4604 int result;
Larry Hastings9cf065c2012-06-22 16:30:09 -07004605
Saiyang Gou7514f4f2020-02-12 23:47:42 -08004606 if (PySys_Audit("os.remove", "Oi", path->object,
4607 dir_fd == DEFAULT_DIR_FD ? -1 : dir_fd) < 0) {
4608 return NULL;
4609 }
4610
Larry Hastings9cf065c2012-06-22 16:30:09 -07004611 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04004612 _Py_BEGIN_SUPPRESS_IPH
Larry Hastings9cf065c2012-06-22 16:30:09 -07004613#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07004614 /* Windows, success=1, UNIX, success=0 */
4615 result = !Py_DeleteFileW(path->wide);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004616#else
Larry Hastings9cf065c2012-06-22 16:30:09 -07004617#ifdef HAVE_UNLINKAT
4618 if (dir_fd != DEFAULT_DIR_FD)
Larry Hastings2f936352014-08-05 14:04:04 +10004619 result = unlinkat(dir_fd, path->narrow, 0);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004620 else
4621#endif /* HAVE_UNLINKAT */
Larry Hastings2f936352014-08-05 14:04:04 +10004622 result = unlink(path->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004623#endif
Steve Dower8fc89802015-04-12 00:26:27 -04004624 _Py_END_SUPPRESS_IPH
Larry Hastings9cf065c2012-06-22 16:30:09 -07004625 Py_END_ALLOW_THREADS
4626
Larry Hastings2f936352014-08-05 14:04:04 +10004627 if (result)
4628 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004629
Larry Hastings2f936352014-08-05 14:04:04 +10004630 Py_RETURN_NONE;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004631}
4632
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004633
Larry Hastings2f936352014-08-05 14:04:04 +10004634/*[clinic input]
4635os.remove = os.unlink
4636
4637Remove a file (same as unlink()).
4638
4639If dir_fd is not None, it should be a file descriptor open to a directory,
4640 and path should be relative; path will then be relative to that directory.
4641dir_fd may not be implemented on your platform.
4642 If it is unavailable, using it will raise a NotImplementedError.
4643[clinic start generated code]*/
4644
Larry Hastings2f936352014-08-05 14:04:04 +10004645static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004646os_remove_impl(PyObject *module, path_t *path, int dir_fd)
4647/*[clinic end generated code: output=a8535b28f0068883 input=e05c5ab55cd30983]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004648{
4649 return os_unlink_impl(module, path, dir_fd);
4650}
4651
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004652
Larry Hastings605a62d2012-06-24 04:33:36 -07004653static PyStructSequence_Field uname_result_fields[] = {
4654 {"sysname", "operating system name"},
4655 {"nodename", "name of machine on network (implementation-defined)"},
4656 {"release", "operating system release"},
4657 {"version", "operating system version"},
4658 {"machine", "hardware identifier"},
4659 {NULL}
4660};
4661
4662PyDoc_STRVAR(uname_result__doc__,
4663"uname_result: Result from os.uname().\n\n\
4664This object may be accessed either as a tuple of\n\
4665 (sysname, nodename, release, version, machine),\n\
4666or via the attributes sysname, nodename, release, version, and machine.\n\
4667\n\
4668See os.uname for more information.");
4669
4670static PyStructSequence_Desc uname_result_desc = {
Eddie Elizondob3966632019-11-05 07:16:14 -08004671 MODNAME ".uname_result", /* name */
Larry Hastings605a62d2012-06-24 04:33:36 -07004672 uname_result__doc__, /* doc */
4673 uname_result_fields,
4674 5
4675};
4676
Larry Hastings605a62d2012-06-24 04:33:36 -07004677#ifdef HAVE_UNAME
Larry Hastings2f936352014-08-05 14:04:04 +10004678/*[clinic input]
4679os.uname
4680
4681Return an object identifying the current operating system.
4682
4683The object behaves like a named tuple with the following fields:
4684 (sysname, nodename, release, version, machine)
4685
4686[clinic start generated code]*/
4687
Larry Hastings2f936352014-08-05 14:04:04 +10004688static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004689os_uname_impl(PyObject *module)
4690/*[clinic end generated code: output=e6a49cf1a1508a19 input=e68bd246db3043ed]*/
Guido van Rossumc39de5f1992-02-05 11:15:54 +00004691{
Victor Stinner8c62be82010-05-06 00:08:46 +00004692 struct utsname u;
4693 int res;
Larry Hastings605a62d2012-06-24 04:33:36 -07004694 PyObject *value;
Neal Norwitze241ce82003-02-17 18:17:05 +00004695
Victor Stinner8c62be82010-05-06 00:08:46 +00004696 Py_BEGIN_ALLOW_THREADS
4697 res = uname(&u);
4698 Py_END_ALLOW_THREADS
4699 if (res < 0)
4700 return posix_error();
Larry Hastings605a62d2012-06-24 04:33:36 -07004701
Hai Shif707d942020-03-16 21:15:01 +08004702 PyObject *UnameResultType = get_posix_state(module)->UnameResultType;
Eddie Elizondob3966632019-11-05 07:16:14 -08004703 value = PyStructSequence_New((PyTypeObject *)UnameResultType);
Larry Hastings605a62d2012-06-24 04:33:36 -07004704 if (value == NULL)
4705 return NULL;
4706
4707#define SET(i, field) \
4708 { \
Victor Stinnera534fc42013-06-03 22:07:27 +02004709 PyObject *o = PyUnicode_DecodeFSDefault(field); \
Larry Hastings605a62d2012-06-24 04:33:36 -07004710 if (!o) { \
4711 Py_DECREF(value); \
4712 return NULL; \
4713 } \
4714 PyStructSequence_SET_ITEM(value, i, o); \
4715 } \
4716
4717 SET(0, u.sysname);
4718 SET(1, u.nodename);
4719 SET(2, u.release);
4720 SET(3, u.version);
4721 SET(4, u.machine);
4722
4723#undef SET
4724
4725 return value;
Guido van Rossumc39de5f1992-02-05 11:15:54 +00004726}
Guido van Rossumb6775db1994-08-01 11:34:53 +00004727#endif /* HAVE_UNAME */
Guido van Rossum1ff6cb41991-04-08 20:59:13 +00004728
Larry Hastings9e3e70b2011-09-08 19:29:07 -07004729
Larry Hastings9cf065c2012-06-22 16:30:09 -07004730
4731typedef struct {
4732 int now;
4733 time_t atime_s;
4734 long atime_ns;
4735 time_t mtime_s;
4736 long mtime_ns;
4737} utime_t;
4738
4739/*
Victor Stinner484df002014-10-09 13:52:31 +02004740 * these macros assume that "ut" is a pointer to a utime_t
Larry Hastings9cf065c2012-06-22 16:30:09 -07004741 * they also intentionally leak the declaration of a pointer named "time"
4742 */
4743#define UTIME_TO_TIMESPEC \
4744 struct timespec ts[2]; \
4745 struct timespec *time; \
Victor Stinner484df002014-10-09 13:52:31 +02004746 if (ut->now) \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004747 time = NULL; \
4748 else { \
Victor Stinner484df002014-10-09 13:52:31 +02004749 ts[0].tv_sec = ut->atime_s; \
4750 ts[0].tv_nsec = ut->atime_ns; \
4751 ts[1].tv_sec = ut->mtime_s; \
4752 ts[1].tv_nsec = ut->mtime_ns; \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004753 time = ts; \
4754 } \
4755
4756#define UTIME_TO_TIMEVAL \
4757 struct timeval tv[2]; \
4758 struct timeval *time; \
Victor Stinner484df002014-10-09 13:52:31 +02004759 if (ut->now) \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004760 time = NULL; \
4761 else { \
Victor Stinner484df002014-10-09 13:52:31 +02004762 tv[0].tv_sec = ut->atime_s; \
4763 tv[0].tv_usec = ut->atime_ns / 1000; \
4764 tv[1].tv_sec = ut->mtime_s; \
4765 tv[1].tv_usec = ut->mtime_ns / 1000; \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004766 time = tv; \
4767 } \
4768
4769#define UTIME_TO_UTIMBUF \
Georg Brandle1a7d9d2014-10-12 08:45:15 +02004770 struct utimbuf u; \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004771 struct utimbuf *time; \
Victor Stinner484df002014-10-09 13:52:31 +02004772 if (ut->now) \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004773 time = NULL; \
4774 else { \
Georg Brandle1a7d9d2014-10-12 08:45:15 +02004775 u.actime = ut->atime_s; \
4776 u.modtime = ut->mtime_s; \
4777 time = &u; \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004778 }
4779
4780#define UTIME_TO_TIME_T \
4781 time_t timet[2]; \
Georg Brandle1a7d9d2014-10-12 08:45:15 +02004782 time_t *time; \
Victor Stinner484df002014-10-09 13:52:31 +02004783 if (ut->now) \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004784 time = NULL; \
4785 else { \
Victor Stinner484df002014-10-09 13:52:31 +02004786 timet[0] = ut->atime_s; \
4787 timet[1] = ut->mtime_s; \
Georg Brandle1a7d9d2014-10-12 08:45:15 +02004788 time = timet; \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004789 } \
4790
4791
Victor Stinner528a9ab2015-09-03 21:30:26 +02004792#if defined(HAVE_FUTIMESAT) || defined(HAVE_UTIMENSAT)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004793
4794static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02004795utime_dir_fd(utime_t *ut, int dir_fd, const char *path, int follow_symlinks)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004796{
4797#ifdef HAVE_UTIMENSAT
4798 int flags = follow_symlinks ? 0 : AT_SYMLINK_NOFOLLOW;
4799 UTIME_TO_TIMESPEC;
4800 return utimensat(dir_fd, path, time, flags);
4801#elif defined(HAVE_FUTIMESAT)
4802 UTIME_TO_TIMEVAL;
4803 /*
4804 * follow_symlinks will never be false here;
4805 * we only allow !follow_symlinks and dir_fd together
4806 * if we have utimensat()
4807 */
4808 assert(follow_symlinks);
4809 return futimesat(dir_fd, path, time);
4810#endif
4811}
4812
Larry Hastings2f936352014-08-05 14:04:04 +10004813 #define FUTIMENSAT_DIR_FD_CONVERTER dir_fd_converter
4814#else
4815 #define FUTIMENSAT_DIR_FD_CONVERTER dir_fd_unavailable
Larry Hastings9cf065c2012-06-22 16:30:09 -07004816#endif
4817
Victor Stinner528a9ab2015-09-03 21:30:26 +02004818#if defined(HAVE_FUTIMES) || defined(HAVE_FUTIMENS)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004819
4820static int
Victor Stinner484df002014-10-09 13:52:31 +02004821utime_fd(utime_t *ut, int fd)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004822{
4823#ifdef HAVE_FUTIMENS
4824 UTIME_TO_TIMESPEC;
4825 return futimens(fd, time);
4826#else
4827 UTIME_TO_TIMEVAL;
4828 return futimes(fd, time);
4829#endif
4830}
4831
Larry Hastings2f936352014-08-05 14:04:04 +10004832 #define PATH_UTIME_HAVE_FD 1
4833#else
4834 #define PATH_UTIME_HAVE_FD 0
Larry Hastings9cf065c2012-06-22 16:30:09 -07004835#endif
4836
Victor Stinner5ebae872015-09-22 01:29:33 +02004837#if defined(HAVE_UTIMENSAT) || defined(HAVE_LUTIMES)
4838# define UTIME_HAVE_NOFOLLOW_SYMLINKS
4839#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07004840
Victor Stinner4552ced2015-09-21 22:37:15 +02004841#ifdef UTIME_HAVE_NOFOLLOW_SYMLINKS
Larry Hastings9cf065c2012-06-22 16:30:09 -07004842
4843static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02004844utime_nofollow_symlinks(utime_t *ut, const char *path)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004845{
4846#ifdef HAVE_UTIMENSAT
4847 UTIME_TO_TIMESPEC;
4848 return utimensat(DEFAULT_DIR_FD, path, time, AT_SYMLINK_NOFOLLOW);
4849#else
4850 UTIME_TO_TIMEVAL;
4851 return lutimes(path, time);
4852#endif
4853}
4854
4855#endif
4856
4857#ifndef MS_WINDOWS
4858
4859static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02004860utime_default(utime_t *ut, const char *path)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004861{
4862#ifdef HAVE_UTIMENSAT
4863 UTIME_TO_TIMESPEC;
4864 return utimensat(DEFAULT_DIR_FD, path, time, 0);
4865#elif defined(HAVE_UTIMES)
4866 UTIME_TO_TIMEVAL;
4867 return utimes(path, time);
4868#elif defined(HAVE_UTIME_H)
4869 UTIME_TO_UTIMBUF;
4870 return utime(path, time);
4871#else
4872 UTIME_TO_TIME_T;
4873 return utime(path, time);
4874#endif
4875}
4876
4877#endif
4878
Larry Hastings76ad59b2012-05-03 00:30:07 -07004879static int
Victor Stinner1c2fa782020-05-10 11:05:29 +02004880split_py_long_to_s_and_ns(PyObject *module, PyObject *py_long, time_t *s, long *ns)
Larry Hastings76ad59b2012-05-03 00:30:07 -07004881{
4882 int result = 0;
Benjamin Petersonfbd85a02012-05-04 11:06:09 -04004883 PyObject *divmod;
Victor Stinner1c2fa782020-05-10 11:05:29 +02004884 divmod = PyNumber_Divmod(py_long, get_posix_state(module)->billion);
Larry Hastings76ad59b2012-05-03 00:30:07 -07004885 if (!divmod)
4886 goto exit;
Oren Milman0bd1a2d2018-09-12 22:14:35 +03004887 if (!PyTuple_Check(divmod) || PyTuple_GET_SIZE(divmod) != 2) {
4888 PyErr_Format(PyExc_TypeError,
4889 "%.200s.__divmod__() must return a 2-tuple, not %.200s",
Eddie Elizondob3966632019-11-05 07:16:14 -08004890 _PyType_Name(Py_TYPE(py_long)), _PyType_Name(Py_TYPE(divmod)));
Oren Milman0bd1a2d2018-09-12 22:14:35 +03004891 goto exit;
4892 }
Larry Hastings76ad59b2012-05-03 00:30:07 -07004893 *s = _PyLong_AsTime_t(PyTuple_GET_ITEM(divmod, 0));
4894 if ((*s == -1) && PyErr_Occurred())
4895 goto exit;
4896 *ns = PyLong_AsLong(PyTuple_GET_ITEM(divmod, 1));
Benjamin Peterson35a8f0d2012-05-04 01:10:59 -04004897 if ((*ns == -1) && PyErr_Occurred())
Larry Hastings76ad59b2012-05-03 00:30:07 -07004898 goto exit;
4899
4900 result = 1;
4901exit:
4902 Py_XDECREF(divmod);
4903 return result;
4904}
4905
Larry Hastings2f936352014-08-05 14:04:04 +10004906
4907/*[clinic input]
4908os.utime
4909
4910 path: path_t(allow_fd='PATH_UTIME_HAVE_FD')
Serhiy Storchaka279f4462019-09-14 12:24:05 +03004911 times: object = None
Larry Hastings2f936352014-08-05 14:04:04 +10004912 *
4913 ns: object = NULL
4914 dir_fd: dir_fd(requires='futimensat') = None
4915 follow_symlinks: bool=True
4916
Martin Panter0ff89092015-09-09 01:56:53 +00004917# "utime(path, times=None, *[, ns], dir_fd=None, follow_symlinks=True)\n\
Larry Hastings2f936352014-08-05 14:04:04 +10004918
4919Set the access and modified time of path.
4920
4921path may always be specified as a string.
4922On some platforms, path may also be specified as an open file descriptor.
4923 If this functionality is unavailable, using it raises an exception.
4924
4925If times is not None, it must be a tuple (atime, mtime);
4926 atime and mtime should be expressed as float seconds since the epoch.
Martin Panter0ff89092015-09-09 01:56:53 +00004927If ns is specified, it must be a tuple (atime_ns, mtime_ns);
Larry Hastings2f936352014-08-05 14:04:04 +10004928 atime_ns and mtime_ns should be expressed as integer nanoseconds
4929 since the epoch.
Martin Panter0ff89092015-09-09 01:56:53 +00004930If times is None and ns is unspecified, utime uses the current time.
Larry Hastings2f936352014-08-05 14:04:04 +10004931Specifying tuples for both times and ns is an error.
4932
4933If dir_fd is not None, it should be a file descriptor open to a directory,
4934 and path should be relative; path will then be relative to that directory.
4935If follow_symlinks is False, and the last element of the path is a symbolic
4936 link, utime will modify the symbolic link itself instead of the file the
4937 link points to.
4938It is an error to use dir_fd or follow_symlinks when specifying path
4939 as an open file descriptor.
4940dir_fd and follow_symlinks may not be available on your platform.
4941 If they are unavailable, using them will raise a NotImplementedError.
4942
4943[clinic start generated code]*/
4944
Larry Hastings2f936352014-08-05 14:04:04 +10004945static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004946os_utime_impl(PyObject *module, path_t *path, PyObject *times, PyObject *ns,
4947 int dir_fd, int follow_symlinks)
Serhiy Storchaka279f4462019-09-14 12:24:05 +03004948/*[clinic end generated code: output=cfcac69d027b82cf input=2fbd62a2f228f8f4]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004949{
Larry Hastings9cf065c2012-06-22 16:30:09 -07004950#ifdef MS_WINDOWS
4951 HANDLE hFile;
4952 FILETIME atime, mtime;
4953#else
4954 int result;
4955#endif
Larry Hastings76ad59b2012-05-03 00:30:07 -07004956
Larry Hastings2f936352014-08-05 14:04:04 +10004957 utime_t utime;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004958
Christian Heimesb3c87242013-08-01 00:08:16 +02004959 memset(&utime, 0, sizeof(utime_t));
Larry Hastings76ad59b2012-05-03 00:30:07 -07004960
Serhiy Storchaka279f4462019-09-14 12:24:05 +03004961 if (times != Py_None && ns) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07004962 PyErr_SetString(PyExc_ValueError,
4963 "utime: you may specify either 'times'"
4964 " or 'ns' but not both");
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004965 return NULL;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004966 }
4967
Serhiy Storchaka279f4462019-09-14 12:24:05 +03004968 if (times != Py_None) {
Antoine Pitroucf8a1e52013-04-17 22:06:44 +02004969 time_t a_sec, m_sec;
4970 long a_nsec, m_nsec;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004971 if (!PyTuple_CheckExact(times) || (PyTuple_Size(times) != 2)) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07004972 PyErr_SetString(PyExc_TypeError,
4973 "utime: 'times' must be either"
4974 " a tuple of two ints or None");
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004975 return NULL;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004976 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07004977 utime.now = 0;
Benjamin Petersonb399ab22012-05-04 01:31:13 -04004978 if (_PyTime_ObjectToTimespec(PyTuple_GET_ITEM(times, 0),
Victor Stinnerdca028b2015-03-30 01:02:57 +02004979 &a_sec, &a_nsec, _PyTime_ROUND_FLOOR) == -1 ||
Benjamin Petersonb399ab22012-05-04 01:31:13 -04004980 _PyTime_ObjectToTimespec(PyTuple_GET_ITEM(times, 1),
Victor Stinnerdca028b2015-03-30 01:02:57 +02004981 &m_sec, &m_nsec, _PyTime_ROUND_FLOOR) == -1) {
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004982 return NULL;
Larry Hastingsb3336402012-05-04 02:31:57 -07004983 }
Antoine Pitroucf8a1e52013-04-17 22:06:44 +02004984 utime.atime_s = a_sec;
4985 utime.atime_ns = a_nsec;
4986 utime.mtime_s = m_sec;
4987 utime.mtime_ns = m_nsec;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004988 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07004989 else if (ns) {
Larry Hastings76ad59b2012-05-03 00:30:07 -07004990 if (!PyTuple_CheckExact(ns) || (PyTuple_Size(ns) != 2)) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07004991 PyErr_SetString(PyExc_TypeError,
4992 "utime: 'ns' must be a tuple of two ints");
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004993 return NULL;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004994 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07004995 utime.now = 0;
Victor Stinner1c2fa782020-05-10 11:05:29 +02004996 if (!split_py_long_to_s_and_ns(module, PyTuple_GET_ITEM(ns, 0),
Larry Hastings9cf065c2012-06-22 16:30:09 -07004997 &utime.atime_s, &utime.atime_ns) ||
Victor Stinner1c2fa782020-05-10 11:05:29 +02004998 !split_py_long_to_s_and_ns(module, PyTuple_GET_ITEM(ns, 1),
Larry Hastings9cf065c2012-06-22 16:30:09 -07004999 &utime.mtime_s, &utime.mtime_ns)) {
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02005000 return NULL;
Larry Hastingsb3336402012-05-04 02:31:57 -07005001 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07005002 }
5003 else {
5004 /* times and ns are both None/unspecified. use "now". */
5005 utime.now = 1;
Larry Hastings76ad59b2012-05-03 00:30:07 -07005006 }
5007
Victor Stinner4552ced2015-09-21 22:37:15 +02005008#if !defined(UTIME_HAVE_NOFOLLOW_SYMLINKS)
Larry Hastings9cf065c2012-06-22 16:30:09 -07005009 if (follow_symlinks_specified("utime", follow_symlinks))
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02005010 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07005011#endif
Benjamin Petersonb399ab22012-05-04 01:31:13 -04005012
Larry Hastings2f936352014-08-05 14:04:04 +10005013 if (path_and_dir_fd_invalid("utime", path, dir_fd) ||
5014 dir_fd_and_fd_invalid("utime", dir_fd, path->fd) ||
5015 fd_and_follow_symlinks_invalid("utime", path->fd, follow_symlinks))
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02005016 return NULL;
Larry Hastings76ad59b2012-05-03 00:30:07 -07005017
Larry Hastings9cf065c2012-06-22 16:30:09 -07005018#if !defined(HAVE_UTIMENSAT)
5019 if ((dir_fd != DEFAULT_DIR_FD) && (!follow_symlinks)) {
Georg Brandl969288e2012-06-26 09:25:44 +02005020 PyErr_SetString(PyExc_ValueError,
Larry Hastings9cf065c2012-06-22 16:30:09 -07005021 "utime: cannot use dir_fd and follow_symlinks "
5022 "together on this platform");
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02005023 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07005024 }
5025#endif
Larry Hastings76ad59b2012-05-03 00:30:07 -07005026
Saiyang Gou7514f4f2020-02-12 23:47:42 -08005027 if (PySys_Audit("os.utime", "OOOi", path->object, times, ns ? ns : Py_None,
5028 dir_fd == DEFAULT_DIR_FD ? -1 : dir_fd) < 0) {
5029 return NULL;
5030 }
5031
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00005032#ifdef MS_WINDOWS
Larry Hastings9cf065c2012-06-22 16:30:09 -07005033 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07005034 hFile = CreateFileW(path->wide, FILE_WRITE_ATTRIBUTES, 0,
5035 NULL, OPEN_EXISTING,
5036 FILE_FLAG_BACKUP_SEMANTICS, NULL);
Larry Hastings9cf065c2012-06-22 16:30:09 -07005037 Py_END_ALLOW_THREADS
5038 if (hFile == INVALID_HANDLE_VALUE) {
Larry Hastings2f936352014-08-05 14:04:04 +10005039 path_error(path);
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02005040 return NULL;
Larry Hastingsb3336402012-05-04 02:31:57 -07005041 }
5042
Larry Hastings9cf065c2012-06-22 16:30:09 -07005043 if (utime.now) {
Antoine Pitrou91a7af32013-11-23 15:23:26 +01005044 GetSystemTimeAsFileTime(&mtime);
5045 atime = mtime;
Victor Stinner8c62be82010-05-06 00:08:46 +00005046 }
Victor Stinner8c62be82010-05-06 00:08:46 +00005047 else {
Steve Dowerbf1f3762015-02-21 15:26:02 -08005048 _Py_time_t_to_FILE_TIME(utime.atime_s, utime.atime_ns, &atime);
5049 _Py_time_t_to_FILE_TIME(utime.mtime_s, utime.mtime_ns, &mtime);
Victor Stinner8c62be82010-05-06 00:08:46 +00005050 }
5051 if (!SetFileTime(hFile, NULL, &atime, &mtime)) {
5052 /* Avoid putting the file name into the error here,
5053 as that may confuse the user into believing that
5054 something is wrong with the file, when it also
5055 could be the time stamp that gives a problem. */
Victor Stinnerb024e842012-10-31 22:24:06 +01005056 PyErr_SetFromWindowsErr(0);
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02005057 CloseHandle(hFile);
5058 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00005059 }
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02005060 CloseHandle(hFile);
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00005061#else /* MS_WINDOWS */
Larry Hastings9cf065c2012-06-22 16:30:09 -07005062 Py_BEGIN_ALLOW_THREADS
Guido van Rossum1ff6cb41991-04-08 20:59:13 +00005063
Victor Stinner4552ced2015-09-21 22:37:15 +02005064#ifdef UTIME_HAVE_NOFOLLOW_SYMLINKS
Larry Hastings9cf065c2012-06-22 16:30:09 -07005065 if ((!follow_symlinks) && (dir_fd == DEFAULT_DIR_FD))
Larry Hastings2f936352014-08-05 14:04:04 +10005066 result = utime_nofollow_symlinks(&utime, path->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07005067 else
Larry Hastings9e3e70b2011-09-08 19:29:07 -07005068#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07005069
Victor Stinner528a9ab2015-09-03 21:30:26 +02005070#if defined(HAVE_FUTIMESAT) || defined(HAVE_UTIMENSAT)
Larry Hastings9cf065c2012-06-22 16:30:09 -07005071 if ((dir_fd != DEFAULT_DIR_FD) || (!follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10005072 result = utime_dir_fd(&utime, dir_fd, path->narrow, follow_symlinks);
Larry Hastings9cf065c2012-06-22 16:30:09 -07005073 else
5074#endif
5075
Victor Stinner528a9ab2015-09-03 21:30:26 +02005076#if defined(HAVE_FUTIMES) || defined(HAVE_FUTIMENS)
Larry Hastings2f936352014-08-05 14:04:04 +10005077 if (path->fd != -1)
5078 result = utime_fd(&utime, path->fd);
Larry Hastings9cf065c2012-06-22 16:30:09 -07005079 else
5080#endif
5081
Larry Hastings2f936352014-08-05 14:04:04 +10005082 result = utime_default(&utime, path->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07005083
5084 Py_END_ALLOW_THREADS
5085
5086 if (result < 0) {
5087 /* see previous comment about not putting filename in error here */
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02005088 posix_error();
5089 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00005090 }
Larry Hastings76ad59b2012-05-03 00:30:07 -07005091
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00005092#endif /* MS_WINDOWS */
Larry Hastings9cf065c2012-06-22 16:30:09 -07005093
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02005094 Py_RETURN_NONE;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00005095}
5096
Guido van Rossum3b066191991-06-04 19:40:25 +00005097/* Process operations */
Guido van Rossum85e3b011991-06-03 12:42:10 +00005098
Larry Hastings2f936352014-08-05 14:04:04 +10005099
5100/*[clinic input]
5101os._exit
5102
5103 status: int
5104
5105Exit to the system with specified status, without normal exit processing.
5106[clinic start generated code]*/
5107
Larry Hastings2f936352014-08-05 14:04:04 +10005108static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005109os__exit_impl(PyObject *module, int status)
5110/*[clinic end generated code: output=116e52d9c2260d54 input=5e6d57556b0c4a62]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005111{
5112 _exit(status);
Victor Stinner8c62be82010-05-06 00:08:46 +00005113 return NULL; /* Make gcc -Wall happy */
Guido van Rossum85e3b011991-06-03 12:42:10 +00005114}
5115
Steve Dowercc16be82016-09-08 10:35:16 -07005116#if defined(HAVE_WEXECV) || defined(HAVE_WSPAWNV)
5117#define EXECV_CHAR wchar_t
5118#else
5119#define EXECV_CHAR char
5120#endif
5121
pxinwrf2d7ac72019-05-21 18:46:37 +08005122#if defined(HAVE_EXECV) || defined(HAVE_SPAWNV) || defined(HAVE_RTPSPAWN)
Martin v. Löwis114619e2002-10-07 06:44:21 +00005123static void
Steve Dowercc16be82016-09-08 10:35:16 -07005124free_string_array(EXECV_CHAR **array, Py_ssize_t count)
Martin v. Löwis114619e2002-10-07 06:44:21 +00005125{
Victor Stinner8c62be82010-05-06 00:08:46 +00005126 Py_ssize_t i;
5127 for (i = 0; i < count; i++)
5128 PyMem_Free(array[i]);
5129 PyMem_DEL(array);
Martin v. Löwis114619e2002-10-07 06:44:21 +00005130}
Martin v. Löwis011e8422009-05-05 04:43:17 +00005131
Berker Peksag81816462016-09-15 20:19:47 +03005132static int
5133fsconvert_strdup(PyObject *o, EXECV_CHAR **out)
Martin v. Löwis011e8422009-05-05 04:43:17 +00005134{
Victor Stinner8c62be82010-05-06 00:08:46 +00005135 Py_ssize_t size;
Berker Peksag81816462016-09-15 20:19:47 +03005136 PyObject *ub;
5137 int result = 0;
Steve Dowercc16be82016-09-08 10:35:16 -07005138#if defined(HAVE_WEXECV) || defined(HAVE_WSPAWNV)
Berker Peksag81816462016-09-15 20:19:47 +03005139 if (!PyUnicode_FSDecoder(o, &ub))
Steve Dowercc16be82016-09-08 10:35:16 -07005140 return 0;
Berker Peksag81816462016-09-15 20:19:47 +03005141 *out = PyUnicode_AsWideCharString(ub, &size);
5142 if (*out)
5143 result = 1;
Steve Dowercc16be82016-09-08 10:35:16 -07005144#else
Berker Peksag81816462016-09-15 20:19:47 +03005145 if (!PyUnicode_FSConverter(o, &ub))
Victor Stinner8c62be82010-05-06 00:08:46 +00005146 return 0;
Berker Peksag81816462016-09-15 20:19:47 +03005147 size = PyBytes_GET_SIZE(ub);
5148 *out = PyMem_Malloc(size + 1);
5149 if (*out) {
5150 memcpy(*out, PyBytes_AS_STRING(ub), size + 1);
5151 result = 1;
5152 } else
Victor Stinner50abf222013-11-07 23:56:10 +01005153 PyErr_NoMemory();
Steve Dowercc16be82016-09-08 10:35:16 -07005154#endif
Berker Peksag81816462016-09-15 20:19:47 +03005155 Py_DECREF(ub);
5156 return result;
Martin v. Löwis011e8422009-05-05 04:43:17 +00005157}
Martin v. Löwis114619e2002-10-07 06:44:21 +00005158#endif
5159
pxinwrf2d7ac72019-05-21 18:46:37 +08005160#if defined(HAVE_EXECV) || defined (HAVE_FEXECVE) || defined(HAVE_RTPSPAWN)
Steve Dowercc16be82016-09-08 10:35:16 -07005161static EXECV_CHAR**
Victor Stinner13bb71c2010-04-23 21:41:56 +00005162parse_envlist(PyObject* env, Py_ssize_t *envc_ptr)
5163{
Victor Stinner8c62be82010-05-06 00:08:46 +00005164 Py_ssize_t i, pos, envc;
5165 PyObject *keys=NULL, *vals=NULL;
Berker Peksag81816462016-09-15 20:19:47 +03005166 PyObject *key, *val, *key2, *val2, *keyval;
Steve Dowercc16be82016-09-08 10:35:16 -07005167 EXECV_CHAR **envlist;
Victor Stinner13bb71c2010-04-23 21:41:56 +00005168
Victor Stinner8c62be82010-05-06 00:08:46 +00005169 i = PyMapping_Size(env);
5170 if (i < 0)
5171 return NULL;
Steve Dowercc16be82016-09-08 10:35:16 -07005172 envlist = PyMem_NEW(EXECV_CHAR *, i + 1);
Victor Stinner8c62be82010-05-06 00:08:46 +00005173 if (envlist == NULL) {
5174 PyErr_NoMemory();
5175 return NULL;
5176 }
5177 envc = 0;
5178 keys = PyMapping_Keys(env);
Victor Stinnerb0314272013-11-14 21:37:05 +01005179 if (!keys)
5180 goto error;
Victor Stinner8c62be82010-05-06 00:08:46 +00005181 vals = PyMapping_Values(env);
Victor Stinnerb0314272013-11-14 21:37:05 +01005182 if (!vals)
Victor Stinner8c62be82010-05-06 00:08:46 +00005183 goto error;
5184 if (!PyList_Check(keys) || !PyList_Check(vals)) {
5185 PyErr_Format(PyExc_TypeError,
5186 "env.keys() or env.values() is not a list");
5187 goto error;
5188 }
Victor Stinner13bb71c2010-04-23 21:41:56 +00005189
Victor Stinner8c62be82010-05-06 00:08:46 +00005190 for (pos = 0; pos < i; pos++) {
5191 key = PyList_GetItem(keys, pos);
5192 val = PyList_GetItem(vals, pos);
5193 if (!key || !val)
5194 goto error;
Victor Stinner13bb71c2010-04-23 21:41:56 +00005195
Berker Peksag81816462016-09-15 20:19:47 +03005196#if defined(HAVE_WEXECV) || defined(HAVE_WSPAWNV)
5197 if (!PyUnicode_FSDecoder(key, &key2))
5198 goto error;
5199 if (!PyUnicode_FSDecoder(val, &val2)) {
5200 Py_DECREF(key2);
5201 goto error;
5202 }
Serhiy Storchaka77703942017-06-25 07:33:01 +03005203 /* Search from index 1 because on Windows starting '=' is allowed for
5204 defining hidden environment variables. */
5205 if (PyUnicode_GET_LENGTH(key2) == 0 ||
5206 PyUnicode_FindChar(key2, '=', 1, PyUnicode_GET_LENGTH(key2), 1) != -1)
5207 {
5208 PyErr_SetString(PyExc_ValueError, "illegal environment variable name");
Eric N. Vander Weelea7874c72017-06-26 21:35:20 -04005209 Py_DECREF(key2);
5210 Py_DECREF(val2);
Serhiy Storchaka77703942017-06-25 07:33:01 +03005211 goto error;
5212 }
Berker Peksag81816462016-09-15 20:19:47 +03005213 keyval = PyUnicode_FromFormat("%U=%U", key2, val2);
5214#else
5215 if (!PyUnicode_FSConverter(key, &key2))
5216 goto error;
5217 if (!PyUnicode_FSConverter(val, &val2)) {
5218 Py_DECREF(key2);
5219 goto error;
5220 }
Serhiy Storchaka77703942017-06-25 07:33:01 +03005221 if (PyBytes_GET_SIZE(key2) == 0 ||
5222 strchr(PyBytes_AS_STRING(key2) + 1, '=') != NULL)
5223 {
5224 PyErr_SetString(PyExc_ValueError, "illegal environment variable name");
Eric N. Vander Weelea7874c72017-06-26 21:35:20 -04005225 Py_DECREF(key2);
5226 Py_DECREF(val2);
Serhiy Storchaka77703942017-06-25 07:33:01 +03005227 goto error;
5228 }
Berker Peksag81816462016-09-15 20:19:47 +03005229 keyval = PyBytes_FromFormat("%s=%s", PyBytes_AS_STRING(key2),
5230 PyBytes_AS_STRING(val2));
5231#endif
5232 Py_DECREF(key2);
5233 Py_DECREF(val2);
Steve Dowercc16be82016-09-08 10:35:16 -07005234 if (!keyval)
Victor Stinner8c62be82010-05-06 00:08:46 +00005235 goto error;
Steve Dowercc16be82016-09-08 10:35:16 -07005236
5237 if (!fsconvert_strdup(keyval, &envlist[envc++])) {
5238 Py_DECREF(keyval);
Victor Stinner8c62be82010-05-06 00:08:46 +00005239 goto error;
5240 }
Berker Peksag81816462016-09-15 20:19:47 +03005241
Steve Dowercc16be82016-09-08 10:35:16 -07005242 Py_DECREF(keyval);
Victor Stinner8c62be82010-05-06 00:08:46 +00005243 }
5244 Py_DECREF(vals);
5245 Py_DECREF(keys);
Victor Stinner13bb71c2010-04-23 21:41:56 +00005246
Victor Stinner8c62be82010-05-06 00:08:46 +00005247 envlist[envc] = 0;
5248 *envc_ptr = envc;
5249 return envlist;
Victor Stinner13bb71c2010-04-23 21:41:56 +00005250
5251error:
Victor Stinner8c62be82010-05-06 00:08:46 +00005252 Py_XDECREF(keys);
5253 Py_XDECREF(vals);
Steve Dowercc16be82016-09-08 10:35:16 -07005254 free_string_array(envlist, envc);
Victor Stinner8c62be82010-05-06 00:08:46 +00005255 return NULL;
Victor Stinner13bb71c2010-04-23 21:41:56 +00005256}
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00005257
Steve Dowercc16be82016-09-08 10:35:16 -07005258static EXECV_CHAR**
Ross Lagerwall7807c352011-03-17 20:20:30 +02005259parse_arglist(PyObject* argv, Py_ssize_t *argc)
5260{
5261 int i;
Steve Dowercc16be82016-09-08 10:35:16 -07005262 EXECV_CHAR **argvlist = PyMem_NEW(EXECV_CHAR *, *argc+1);
Ross Lagerwall7807c352011-03-17 20:20:30 +02005263 if (argvlist == NULL) {
5264 PyErr_NoMemory();
5265 return NULL;
5266 }
5267 for (i = 0; i < *argc; i++) {
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02005268 PyObject* item = PySequence_ITEM(argv, i);
5269 if (item == NULL)
5270 goto fail;
5271 if (!fsconvert_strdup(item, &argvlist[i])) {
5272 Py_DECREF(item);
Ross Lagerwall7807c352011-03-17 20:20:30 +02005273 goto fail;
5274 }
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02005275 Py_DECREF(item);
Ross Lagerwall7807c352011-03-17 20:20:30 +02005276 }
5277 argvlist[*argc] = NULL;
5278 return argvlist;
5279fail:
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02005280 *argc = i;
Ross Lagerwall7807c352011-03-17 20:20:30 +02005281 free_string_array(argvlist, *argc);
5282 return NULL;
5283}
Steve Dowercc16be82016-09-08 10:35:16 -07005284
Ross Lagerwall7807c352011-03-17 20:20:30 +02005285#endif
5286
Larry Hastings2f936352014-08-05 14:04:04 +10005287
Ross Lagerwall7807c352011-03-17 20:20:30 +02005288#ifdef HAVE_EXECV
Larry Hastings2f936352014-08-05 14:04:04 +10005289/*[clinic input]
5290os.execv
5291
Steve Dowercc16be82016-09-08 10:35:16 -07005292 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +10005293 Path of executable file.
5294 argv: object
5295 Tuple or list of strings.
5296 /
5297
5298Execute an executable path with arguments, replacing current process.
5299[clinic start generated code]*/
5300
Larry Hastings2f936352014-08-05 14:04:04 +10005301static PyObject *
Steve Dowercc16be82016-09-08 10:35:16 -07005302os_execv_impl(PyObject *module, path_t *path, PyObject *argv)
5303/*[clinic end generated code: output=3b52fec34cd0dafd input=9bac31efae07dac7]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005304{
Steve Dowercc16be82016-09-08 10:35:16 -07005305 EXECV_CHAR **argvlist;
Ross Lagerwall7807c352011-03-17 20:20:30 +02005306 Py_ssize_t argc;
5307
5308 /* execv has two arguments: (path, argv), where
5309 argv is a list or tuple of strings. */
5310
Ross Lagerwall7807c352011-03-17 20:20:30 +02005311 if (!PyList_Check(argv) && !PyTuple_Check(argv)) {
5312 PyErr_SetString(PyExc_TypeError,
5313 "execv() arg 2 must be a tuple or list");
Ross Lagerwall7807c352011-03-17 20:20:30 +02005314 return NULL;
5315 }
5316 argc = PySequence_Size(argv);
5317 if (argc < 1) {
5318 PyErr_SetString(PyExc_ValueError, "execv() arg 2 must not be empty");
Ross Lagerwall7807c352011-03-17 20:20:30 +02005319 return NULL;
5320 }
5321
5322 argvlist = parse_arglist(argv, &argc);
5323 if (argvlist == NULL) {
Ross Lagerwall7807c352011-03-17 20:20:30 +02005324 return NULL;
5325 }
Steve Dowerbce26262016-11-19 19:17:26 -08005326 if (!argvlist[0][0]) {
5327 PyErr_SetString(PyExc_ValueError,
5328 "execv() arg 2 first element cannot be empty");
5329 free_string_array(argvlist, argc);
5330 return NULL;
5331 }
Ross Lagerwall7807c352011-03-17 20:20:30 +02005332
Saiyang Gou7514f4f2020-02-12 23:47:42 -08005333 if (PySys_Audit("os.exec", "OOO", path->object, argv, Py_None) < 0) {
Saiyang Gou95f60012020-02-04 16:15:00 -08005334 free_string_array(argvlist, argc);
5335 return NULL;
5336 }
5337
Steve Dowerbce26262016-11-19 19:17:26 -08005338 _Py_BEGIN_SUPPRESS_IPH
Steve Dowercc16be82016-09-08 10:35:16 -07005339#ifdef HAVE_WEXECV
5340 _wexecv(path->wide, argvlist);
5341#else
5342 execv(path->narrow, argvlist);
5343#endif
Steve Dowerbce26262016-11-19 19:17:26 -08005344 _Py_END_SUPPRESS_IPH
Ross Lagerwall7807c352011-03-17 20:20:30 +02005345
5346 /* If we get here it's definitely an error */
5347
5348 free_string_array(argvlist, argc);
Ross Lagerwall7807c352011-03-17 20:20:30 +02005349 return posix_error();
5350}
5351
Larry Hastings2f936352014-08-05 14:04:04 +10005352
5353/*[clinic input]
5354os.execve
5355
5356 path: path_t(allow_fd='PATH_HAVE_FEXECVE')
5357 Path of executable file.
5358 argv: object
5359 Tuple or list of strings.
5360 env: object
5361 Dictionary of strings mapping to strings.
5362
5363Execute an executable path with arguments, replacing current process.
5364[clinic start generated code]*/
5365
Larry Hastings2f936352014-08-05 14:04:04 +10005366static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005367os_execve_impl(PyObject *module, path_t *path, PyObject *argv, PyObject *env)
5368/*[clinic end generated code: output=ff9fa8e4da8bde58 input=626804fa092606d9]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005369{
Steve Dowercc16be82016-09-08 10:35:16 -07005370 EXECV_CHAR **argvlist = NULL;
5371 EXECV_CHAR **envlist;
Ross Lagerwall7807c352011-03-17 20:20:30 +02005372 Py_ssize_t argc, envc;
Guido van Rossumc6dcc9f1993-11-05 10:15:19 +00005373
Victor Stinner8c62be82010-05-06 00:08:46 +00005374 /* execve has three arguments: (path, argv, env), where
5375 argv is a list or tuple of strings and env is a dictionary
5376 like posix.environ. */
Guido van Rossumc6dcc9f1993-11-05 10:15:19 +00005377
Ross Lagerwall7807c352011-03-17 20:20:30 +02005378 if (!PyList_Check(argv) && !PyTuple_Check(argv)) {
Victor Stinner8c62be82010-05-06 00:08:46 +00005379 PyErr_SetString(PyExc_TypeError,
Larry Hastings9cf065c2012-06-22 16:30:09 -07005380 "execve: argv must be a tuple or list");
Saiyang Gou95f60012020-02-04 16:15:00 -08005381 goto fail_0;
Victor Stinner8c62be82010-05-06 00:08:46 +00005382 }
Ross Lagerwall7807c352011-03-17 20:20:30 +02005383 argc = PySequence_Size(argv);
Steve Dowerbce26262016-11-19 19:17:26 -08005384 if (argc < 1) {
5385 PyErr_SetString(PyExc_ValueError, "execve: argv must not be empty");
5386 return NULL;
5387 }
5388
Victor Stinner8c62be82010-05-06 00:08:46 +00005389 if (!PyMapping_Check(env)) {
5390 PyErr_SetString(PyExc_TypeError,
Larry Hastings9cf065c2012-06-22 16:30:09 -07005391 "execve: environment must be a mapping object");
Saiyang Gou95f60012020-02-04 16:15:00 -08005392 goto fail_0;
Victor Stinner8c62be82010-05-06 00:08:46 +00005393 }
Guido van Rossumc6dcc9f1993-11-05 10:15:19 +00005394
Ross Lagerwall7807c352011-03-17 20:20:30 +02005395 argvlist = parse_arglist(argv, &argc);
Victor Stinner8c62be82010-05-06 00:08:46 +00005396 if (argvlist == NULL) {
Saiyang Gou95f60012020-02-04 16:15:00 -08005397 goto fail_0;
Victor Stinner8c62be82010-05-06 00:08:46 +00005398 }
Steve Dowerbce26262016-11-19 19:17:26 -08005399 if (!argvlist[0][0]) {
5400 PyErr_SetString(PyExc_ValueError,
5401 "execve: argv first element cannot be empty");
Saiyang Gou95f60012020-02-04 16:15:00 -08005402 goto fail_0;
Steve Dowerbce26262016-11-19 19:17:26 -08005403 }
Guido van Rossumc6dcc9f1993-11-05 10:15:19 +00005404
Victor Stinner8c62be82010-05-06 00:08:46 +00005405 envlist = parse_envlist(env, &envc);
5406 if (envlist == NULL)
Saiyang Gou95f60012020-02-04 16:15:00 -08005407 goto fail_0;
5408
Saiyang Gou7514f4f2020-02-12 23:47:42 -08005409 if (PySys_Audit("os.exec", "OOO", path->object, argv, env) < 0) {
Saiyang Gou95f60012020-02-04 16:15:00 -08005410 goto fail_1;
5411 }
Ross Lagerwall7807c352011-03-17 20:20:30 +02005412
Steve Dowerbce26262016-11-19 19:17:26 -08005413 _Py_BEGIN_SUPPRESS_IPH
Larry Hastings9cf065c2012-06-22 16:30:09 -07005414#ifdef HAVE_FEXECVE
Larry Hastings2f936352014-08-05 14:04:04 +10005415 if (path->fd > -1)
5416 fexecve(path->fd, argvlist, envlist);
Larry Hastings9cf065c2012-06-22 16:30:09 -07005417 else
5418#endif
Steve Dowercc16be82016-09-08 10:35:16 -07005419#ifdef HAVE_WEXECV
5420 _wexecve(path->wide, argvlist, envlist);
5421#else
Larry Hastings2f936352014-08-05 14:04:04 +10005422 execve(path->narrow, argvlist, envlist);
Steve Dowercc16be82016-09-08 10:35:16 -07005423#endif
Steve Dowerbce26262016-11-19 19:17:26 -08005424 _Py_END_SUPPRESS_IPH
Ross Lagerwall7807c352011-03-17 20:20:30 +02005425
5426 /* If we get here it's definitely an error */
5427
Alexey Izbyshev83460312018-10-20 03:28:22 +03005428 posix_path_error(path);
Saiyang Gou95f60012020-02-04 16:15:00 -08005429 fail_1:
Steve Dowercc16be82016-09-08 10:35:16 -07005430 free_string_array(envlist, envc);
Saiyang Gou95f60012020-02-04 16:15:00 -08005431 fail_0:
Larry Hastings9cf065c2012-06-22 16:30:09 -07005432 if (argvlist)
5433 free_string_array(argvlist, argc);
Ross Lagerwall7807c352011-03-17 20:20:30 +02005434 return NULL;
5435}
Steve Dowercc16be82016-09-08 10:35:16 -07005436
Larry Hastings9cf065c2012-06-22 16:30:09 -07005437#endif /* HAVE_EXECV */
5438
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005439#ifdef HAVE_POSIX_SPAWN
5440
5441enum posix_spawn_file_actions_identifier {
5442 POSIX_SPAWN_OPEN,
5443 POSIX_SPAWN_CLOSE,
5444 POSIX_SPAWN_DUP2
5445};
5446
William Orr81574b82018-10-01 22:19:56 -07005447#if defined(HAVE_SCHED_SETPARAM) || defined(HAVE_SCHED_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDPARAM)
Serhiy Storchakaef347532018-05-01 16:45:04 +03005448static int
Victor Stinner1c2fa782020-05-10 11:05:29 +02005449convert_sched_param(PyObject *module, PyObject *param, struct sched_param *res);
William Orr81574b82018-10-01 22:19:56 -07005450#endif
Pablo Galindo254a4662018-09-07 16:44:24 +01005451
5452static int
Victor Stinner1c2fa782020-05-10 11:05:29 +02005453parse_posix_spawn_flags(PyObject *module, const char *func_name, PyObject *setpgroup,
Victor Stinner325e4ba2019-02-01 15:47:24 +01005454 int resetids, int setsid, PyObject *setsigmask,
Pablo Galindo254a4662018-09-07 16:44:24 +01005455 PyObject *setsigdef, PyObject *scheduler,
5456 posix_spawnattr_t *attrp)
5457{
5458 long all_flags = 0;
5459
5460 errno = posix_spawnattr_init(attrp);
5461 if (errno) {
5462 posix_error();
5463 return -1;
5464 }
5465
5466 if (setpgroup) {
5467 pid_t pgid = PyLong_AsPid(setpgroup);
5468 if (pgid == (pid_t)-1 && PyErr_Occurred()) {
5469 goto fail;
5470 }
5471 errno = posix_spawnattr_setpgroup(attrp, pgid);
5472 if (errno) {
5473 posix_error();
5474 goto fail;
5475 }
5476 all_flags |= POSIX_SPAWN_SETPGROUP;
5477 }
5478
5479 if (resetids) {
5480 all_flags |= POSIX_SPAWN_RESETIDS;
5481 }
5482
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005483 if (setsid) {
5484#ifdef POSIX_SPAWN_SETSID
5485 all_flags |= POSIX_SPAWN_SETSID;
5486#elif defined(POSIX_SPAWN_SETSID_NP)
5487 all_flags |= POSIX_SPAWN_SETSID_NP;
5488#else
5489 argument_unavailable_error(func_name, "setsid");
5490 return -1;
5491#endif
5492 }
5493
Pablo Galindo254a4662018-09-07 16:44:24 +01005494 if (setsigmask) {
5495 sigset_t set;
5496 if (!_Py_Sigset_Converter(setsigmask, &set)) {
5497 goto fail;
5498 }
5499 errno = posix_spawnattr_setsigmask(attrp, &set);
5500 if (errno) {
5501 posix_error();
5502 goto fail;
5503 }
5504 all_flags |= POSIX_SPAWN_SETSIGMASK;
5505 }
5506
5507 if (setsigdef) {
5508 sigset_t set;
5509 if (!_Py_Sigset_Converter(setsigdef, &set)) {
5510 goto fail;
5511 }
5512 errno = posix_spawnattr_setsigdefault(attrp, &set);
5513 if (errno) {
5514 posix_error();
5515 goto fail;
5516 }
5517 all_flags |= POSIX_SPAWN_SETSIGDEF;
5518 }
5519
5520 if (scheduler) {
5521#ifdef POSIX_SPAWN_SETSCHEDULER
5522 PyObject *py_schedpolicy;
Victor Stinner1c2fa782020-05-10 11:05:29 +02005523 PyObject *schedparam_obj;
Pablo Galindo254a4662018-09-07 16:44:24 +01005524 struct sched_param schedparam;
5525
Victor Stinner1c2fa782020-05-10 11:05:29 +02005526 if (!PyArg_ParseTuple(scheduler, "OO"
Pablo Galindo254a4662018-09-07 16:44:24 +01005527 ";A scheduler tuple must have two elements",
Victor Stinner1c2fa782020-05-10 11:05:29 +02005528 &py_schedpolicy, &schedparam_obj)) {
5529 goto fail;
5530 }
5531 if (!convert_sched_param(module, schedparam_obj, &schedparam)) {
Pablo Galindo254a4662018-09-07 16:44:24 +01005532 goto fail;
5533 }
5534 if (py_schedpolicy != Py_None) {
5535 int schedpolicy = _PyLong_AsInt(py_schedpolicy);
5536
5537 if (schedpolicy == -1 && PyErr_Occurred()) {
5538 goto fail;
5539 }
5540 errno = posix_spawnattr_setschedpolicy(attrp, schedpolicy);
5541 if (errno) {
5542 posix_error();
5543 goto fail;
5544 }
5545 all_flags |= POSIX_SPAWN_SETSCHEDULER;
5546 }
5547 errno = posix_spawnattr_setschedparam(attrp, &schedparam);
5548 if (errno) {
5549 posix_error();
5550 goto fail;
5551 }
5552 all_flags |= POSIX_SPAWN_SETSCHEDPARAM;
5553#else
5554 PyErr_SetString(PyExc_NotImplementedError,
5555 "The scheduler option is not supported in this system.");
5556 goto fail;
5557#endif
5558 }
5559
5560 errno = posix_spawnattr_setflags(attrp, all_flags);
5561 if (errno) {
5562 posix_error();
5563 goto fail;
5564 }
5565
5566 return 0;
5567
5568fail:
5569 (void)posix_spawnattr_destroy(attrp);
5570 return -1;
5571}
5572
5573static int
Serhiy Storchakaef347532018-05-01 16:45:04 +03005574parse_file_actions(PyObject *file_actions,
Pablo Galindocb970732018-06-19 09:19:50 +01005575 posix_spawn_file_actions_t *file_actionsp,
5576 PyObject *temp_buffer)
Serhiy Storchakaef347532018-05-01 16:45:04 +03005577{
5578 PyObject *seq;
5579 PyObject *file_action = NULL;
5580 PyObject *tag_obj;
5581
5582 seq = PySequence_Fast(file_actions,
5583 "file_actions must be a sequence or None");
5584 if (seq == NULL) {
5585 return -1;
5586 }
5587
5588 errno = posix_spawn_file_actions_init(file_actionsp);
5589 if (errno) {
5590 posix_error();
5591 Py_DECREF(seq);
5592 return -1;
5593 }
5594
Zackery Spytzd52a83a2019-06-26 14:54:20 -06005595 for (Py_ssize_t i = 0; i < PySequence_Fast_GET_SIZE(seq); ++i) {
Serhiy Storchakaef347532018-05-01 16:45:04 +03005596 file_action = PySequence_Fast_GET_ITEM(seq, i);
5597 Py_INCREF(file_action);
5598 if (!PyTuple_Check(file_action) || !PyTuple_GET_SIZE(file_action)) {
5599 PyErr_SetString(PyExc_TypeError,
5600 "Each file_actions element must be a non-empty tuple");
5601 goto fail;
5602 }
5603 long tag = PyLong_AsLong(PyTuple_GET_ITEM(file_action, 0));
5604 if (tag == -1 && PyErr_Occurred()) {
5605 goto fail;
5606 }
5607
5608 /* Populate the file_actions object */
5609 switch (tag) {
5610 case POSIX_SPAWN_OPEN: {
5611 int fd, oflag;
5612 PyObject *path;
5613 unsigned long mode;
5614 if (!PyArg_ParseTuple(file_action, "OiO&ik"
5615 ";A open file_action tuple must have 5 elements",
5616 &tag_obj, &fd, PyUnicode_FSConverter, &path,
5617 &oflag, &mode))
5618 {
5619 goto fail;
5620 }
Pablo Galindocb970732018-06-19 09:19:50 +01005621 if (PyList_Append(temp_buffer, path)) {
5622 Py_DECREF(path);
5623 goto fail;
5624 }
Serhiy Storchakaef347532018-05-01 16:45:04 +03005625 errno = posix_spawn_file_actions_addopen(file_actionsp,
5626 fd, PyBytes_AS_STRING(path), oflag, (mode_t)mode);
Pablo Galindocb970732018-06-19 09:19:50 +01005627 Py_DECREF(path);
Serhiy Storchakaef347532018-05-01 16:45:04 +03005628 if (errno) {
5629 posix_error();
5630 goto fail;
5631 }
5632 break;
5633 }
5634 case POSIX_SPAWN_CLOSE: {
5635 int fd;
5636 if (!PyArg_ParseTuple(file_action, "Oi"
5637 ";A close file_action tuple must have 2 elements",
5638 &tag_obj, &fd))
5639 {
5640 goto fail;
5641 }
5642 errno = posix_spawn_file_actions_addclose(file_actionsp, fd);
5643 if (errno) {
5644 posix_error();
5645 goto fail;
5646 }
5647 break;
5648 }
5649 case POSIX_SPAWN_DUP2: {
5650 int fd1, fd2;
5651 if (!PyArg_ParseTuple(file_action, "Oii"
5652 ";A dup2 file_action tuple must have 3 elements",
5653 &tag_obj, &fd1, &fd2))
5654 {
5655 goto fail;
5656 }
5657 errno = posix_spawn_file_actions_adddup2(file_actionsp,
5658 fd1, fd2);
5659 if (errno) {
5660 posix_error();
5661 goto fail;
5662 }
5663 break;
5664 }
5665 default: {
5666 PyErr_SetString(PyExc_TypeError,
5667 "Unknown file_actions identifier");
5668 goto fail;
5669 }
5670 }
5671 Py_DECREF(file_action);
5672 }
Pablo Galindo254a4662018-09-07 16:44:24 +01005673
Serhiy Storchakaef347532018-05-01 16:45:04 +03005674 Py_DECREF(seq);
5675 return 0;
5676
5677fail:
5678 Py_DECREF(seq);
5679 Py_DECREF(file_action);
5680 (void)posix_spawn_file_actions_destroy(file_actionsp);
5681 return -1;
5682}
5683
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005684
5685static PyObject *
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005686py_posix_spawn(int use_posix_spawnp, PyObject *module, path_t *path, PyObject *argv,
5687 PyObject *env, PyObject *file_actions,
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005688 PyObject *setpgroup, int resetids, int setsid, PyObject *setsigmask,
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005689 PyObject *setsigdef, PyObject *scheduler)
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005690{
Victor Stinner325e4ba2019-02-01 15:47:24 +01005691 const char *func_name = use_posix_spawnp ? "posix_spawnp" : "posix_spawn";
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005692 EXECV_CHAR **argvlist = NULL;
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005693 EXECV_CHAR **envlist = NULL;
Serhiy Storchakaef347532018-05-01 16:45:04 +03005694 posix_spawn_file_actions_t file_actions_buf;
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005695 posix_spawn_file_actions_t *file_actionsp = NULL;
Pablo Galindo254a4662018-09-07 16:44:24 +01005696 posix_spawnattr_t attr;
5697 posix_spawnattr_t *attrp = NULL;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005698 Py_ssize_t argc, envc;
Serhiy Storchakaef347532018-05-01 16:45:04 +03005699 PyObject *result = NULL;
Pablo Galindocb970732018-06-19 09:19:50 +01005700 PyObject *temp_buffer = NULL;
Serhiy Storchakaef347532018-05-01 16:45:04 +03005701 pid_t pid;
5702 int err_code;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005703
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005704 /* posix_spawn and posix_spawnp have three arguments: (path, argv, env), where
Serhiy Storchakaef347532018-05-01 16:45:04 +03005705 argv is a list or tuple of strings and env is a dictionary
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005706 like posix.environ. */
5707
Serhiy Storchakaef347532018-05-01 16:45:04 +03005708 if (!PyList_Check(argv) && !PyTuple_Check(argv)) {
Victor Stinner325e4ba2019-02-01 15:47:24 +01005709 PyErr_Format(PyExc_TypeError,
5710 "%s: argv must be a tuple or list", func_name);
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005711 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005712 }
5713 argc = PySequence_Size(argv);
5714 if (argc < 1) {
Victor Stinner325e4ba2019-02-01 15:47:24 +01005715 PyErr_Format(PyExc_ValueError,
5716 "%s: argv must not be empty", func_name);
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005717 return NULL;
5718 }
5719
5720 if (!PyMapping_Check(env)) {
Victor Stinner325e4ba2019-02-01 15:47:24 +01005721 PyErr_Format(PyExc_TypeError,
5722 "%s: environment must be a mapping object", func_name);
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005723 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005724 }
5725
5726 argvlist = parse_arglist(argv, &argc);
5727 if (argvlist == NULL) {
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005728 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005729 }
5730 if (!argvlist[0][0]) {
Victor Stinner325e4ba2019-02-01 15:47:24 +01005731 PyErr_Format(PyExc_ValueError,
5732 "%s: argv first element cannot be empty", func_name);
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005733 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005734 }
5735
5736 envlist = parse_envlist(env, &envc);
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005737 if (envlist == NULL) {
5738 goto exit;
5739 }
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005740
Anthony Shaw948ed8c2019-05-10 12:00:06 +10005741 if (file_actions != NULL && file_actions != Py_None) {
Pablo Galindocb970732018-06-19 09:19:50 +01005742 /* There is a bug in old versions of glibc that makes some of the
5743 * helper functions for manipulating file actions not copy the provided
5744 * buffers. The problem is that posix_spawn_file_actions_addopen does not
5745 * copy the value of path for some old versions of glibc (<2.20).
5746 * The use of temp_buffer here is a workaround that keeps the
5747 * python objects that own the buffers alive until posix_spawn gets called.
5748 * Check https://bugs.python.org/issue33630 and
5749 * https://sourceware.org/bugzilla/show_bug.cgi?id=17048 for more info.*/
5750 temp_buffer = PyList_New(0);
5751 if (!temp_buffer) {
5752 goto exit;
5753 }
5754 if (parse_file_actions(file_actions, &file_actions_buf, temp_buffer)) {
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005755 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005756 }
Serhiy Storchakaef347532018-05-01 16:45:04 +03005757 file_actionsp = &file_actions_buf;
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005758 }
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005759
Victor Stinner1c2fa782020-05-10 11:05:29 +02005760 if (parse_posix_spawn_flags(module, func_name, setpgroup, resetids, setsid,
Victor Stinner325e4ba2019-02-01 15:47:24 +01005761 setsigmask, setsigdef, scheduler, &attr)) {
Pablo Galindo254a4662018-09-07 16:44:24 +01005762 goto exit;
5763 }
5764 attrp = &attr;
5765
Saiyang Gou7514f4f2020-02-12 23:47:42 -08005766 if (PySys_Audit("os.posix_spawn", "OOO", path->object, argv, env) < 0) {
Saiyang Gou95f60012020-02-04 16:15:00 -08005767 goto exit;
5768 }
5769
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005770 _Py_BEGIN_SUPPRESS_IPH
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005771#ifdef HAVE_POSIX_SPAWNP
5772 if (use_posix_spawnp) {
5773 err_code = posix_spawnp(&pid, path->narrow,
5774 file_actionsp, attrp, argvlist, envlist);
5775 }
5776 else
5777#endif /* HAVE_POSIX_SPAWNP */
5778 {
5779 err_code = posix_spawn(&pid, path->narrow,
5780 file_actionsp, attrp, argvlist, envlist);
5781 }
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005782 _Py_END_SUPPRESS_IPH
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005783
Serhiy Storchakaef347532018-05-01 16:45:04 +03005784 if (err_code) {
5785 errno = err_code;
5786 PyErr_SetFromErrnoWithFilenameObject(PyExc_OSError, path->object);
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005787 goto exit;
5788 }
Gregory P. Smith1d300ce2018-12-30 21:13:02 -08005789#ifdef _Py_MEMORY_SANITIZER
5790 __msan_unpoison(&pid, sizeof(pid));
5791#endif
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005792 result = PyLong_FromPid(pid);
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005793
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005794exit:
Serhiy Storchakaef347532018-05-01 16:45:04 +03005795 if (file_actionsp) {
5796 (void)posix_spawn_file_actions_destroy(file_actionsp);
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005797 }
Pablo Galindo254a4662018-09-07 16:44:24 +01005798 if (attrp) {
5799 (void)posix_spawnattr_destroy(attrp);
5800 }
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005801 if (envlist) {
5802 free_string_array(envlist, envc);
5803 }
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005804 if (argvlist) {
5805 free_string_array(argvlist, argc);
5806 }
Pablo Galindocb970732018-06-19 09:19:50 +01005807 Py_XDECREF(temp_buffer);
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005808 return result;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005809}
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005810
5811
5812/*[clinic input]
5813
5814os.posix_spawn
5815 path: path_t
5816 Path of executable file.
5817 argv: object
5818 Tuple or list of strings.
5819 env: object
5820 Dictionary of strings mapping to strings.
5821 /
5822 *
5823 file_actions: object(c_default='NULL') = ()
5824 A sequence of file action tuples.
5825 setpgroup: object = NULL
5826 The pgroup to use with the POSIX_SPAWN_SETPGROUP flag.
5827 resetids: bool(accept={int}) = False
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005828 If the value is `true` the POSIX_SPAWN_RESETIDS will be activated.
5829 setsid: bool(accept={int}) = False
5830 If the value is `true` the POSIX_SPAWN_SETSID or POSIX_SPAWN_SETSID_NP will be activated.
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005831 setsigmask: object(c_default='NULL') = ()
5832 The sigmask to use with the POSIX_SPAWN_SETSIGMASK flag.
5833 setsigdef: object(c_default='NULL') = ()
5834 The sigmask to use with the POSIX_SPAWN_SETSIGDEF flag.
5835 scheduler: object = NULL
5836 A tuple with the scheduler policy (optional) and parameters.
5837
5838Execute the program specified by path in a new process.
5839[clinic start generated code]*/
5840
5841static PyObject *
5842os_posix_spawn_impl(PyObject *module, path_t *path, PyObject *argv,
5843 PyObject *env, PyObject *file_actions,
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005844 PyObject *setpgroup, int resetids, int setsid,
5845 PyObject *setsigmask, PyObject *setsigdef,
5846 PyObject *scheduler)
5847/*[clinic end generated code: output=14a1098c566bc675 input=8c6305619a00ad04]*/
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005848{
5849 return py_posix_spawn(0, module, path, argv, env, file_actions,
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005850 setpgroup, resetids, setsid, setsigmask, setsigdef,
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005851 scheduler);
5852}
5853 #endif /* HAVE_POSIX_SPAWN */
5854
5855
5856
5857#ifdef HAVE_POSIX_SPAWNP
5858/*[clinic input]
5859
5860os.posix_spawnp
5861 path: path_t
5862 Path of executable file.
5863 argv: object
5864 Tuple or list of strings.
5865 env: object
5866 Dictionary of strings mapping to strings.
5867 /
5868 *
5869 file_actions: object(c_default='NULL') = ()
5870 A sequence of file action tuples.
5871 setpgroup: object = NULL
5872 The pgroup to use with the POSIX_SPAWN_SETPGROUP flag.
5873 resetids: bool(accept={int}) = False
5874 If the value is `True` the POSIX_SPAWN_RESETIDS will be activated.
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005875 setsid: bool(accept={int}) = False
5876 If the value is `True` the POSIX_SPAWN_SETSID or POSIX_SPAWN_SETSID_NP will be activated.
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005877 setsigmask: object(c_default='NULL') = ()
5878 The sigmask to use with the POSIX_SPAWN_SETSIGMASK flag.
5879 setsigdef: object(c_default='NULL') = ()
5880 The sigmask to use with the POSIX_SPAWN_SETSIGDEF flag.
5881 scheduler: object = NULL
5882 A tuple with the scheduler policy (optional) and parameters.
5883
5884Execute the program specified by path in a new process.
5885[clinic start generated code]*/
5886
5887static PyObject *
5888os_posix_spawnp_impl(PyObject *module, path_t *path, PyObject *argv,
5889 PyObject *env, PyObject *file_actions,
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005890 PyObject *setpgroup, int resetids, int setsid,
5891 PyObject *setsigmask, PyObject *setsigdef,
5892 PyObject *scheduler)
5893/*[clinic end generated code: output=7b9aaefe3031238d input=c1911043a22028da]*/
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005894{
5895 return py_posix_spawn(1, module, path, argv, env, file_actions,
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005896 setpgroup, resetids, setsid, setsigmask, setsigdef,
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005897 scheduler);
5898}
5899#endif /* HAVE_POSIX_SPAWNP */
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005900
pxinwrf2d7ac72019-05-21 18:46:37 +08005901#ifdef HAVE_RTPSPAWN
5902static intptr_t
5903_rtp_spawn(int mode, const char *rtpFileName, const char *argv[],
5904 const char *envp[])
5905{
5906 RTP_ID rtpid;
5907 int status;
5908 pid_t res;
5909 int async_err = 0;
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00005910
pxinwrf2d7ac72019-05-21 18:46:37 +08005911 /* Set priority=100 and uStackSize=16 MiB (0x1000000) for new processes.
5912 uStackSize=0 cannot be used, the default stack size is too small for
5913 Python. */
5914 if (envp) {
5915 rtpid = rtpSpawn(rtpFileName, argv, envp,
5916 100, 0x1000000, 0, VX_FP_TASK);
5917 }
5918 else {
5919 rtpid = rtpSpawn(rtpFileName, argv, (const char **)environ,
5920 100, 0x1000000, 0, VX_FP_TASK);
5921 }
5922 if ((rtpid != RTP_ID_ERROR) && (mode == _P_WAIT)) {
5923 do {
5924 res = waitpid((pid_t)rtpid, &status, 0);
5925 } while (res < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
5926
5927 if (res < 0)
5928 return RTP_ID_ERROR;
5929 return ((intptr_t)status);
5930 }
5931 return ((intptr_t)rtpid);
5932}
5933#endif
5934
5935#if defined(HAVE_SPAWNV) || defined(HAVE_WSPAWNV) || defined(HAVE_RTPSPAWN)
Larry Hastings2f936352014-08-05 14:04:04 +10005936/*[clinic input]
5937os.spawnv
5938
5939 mode: int
5940 Mode of process creation.
Steve Dowercc16be82016-09-08 10:35:16 -07005941 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +10005942 Path of executable file.
5943 argv: object
5944 Tuple or list of strings.
5945 /
5946
5947Execute the program specified by path in a new process.
5948[clinic start generated code]*/
5949
Larry Hastings2f936352014-08-05 14:04:04 +10005950static PyObject *
Steve Dowercc16be82016-09-08 10:35:16 -07005951os_spawnv_impl(PyObject *module, int mode, path_t *path, PyObject *argv)
5952/*[clinic end generated code: output=71cd037a9d96b816 input=43224242303291be]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005953{
Steve Dowercc16be82016-09-08 10:35:16 -07005954 EXECV_CHAR **argvlist;
Larry Hastings2f936352014-08-05 14:04:04 +10005955 int i;
Victor Stinner8c62be82010-05-06 00:08:46 +00005956 Py_ssize_t argc;
Benjamin Petersonca470632016-09-06 13:47:26 -07005957 intptr_t spawnval;
Victor Stinner8c62be82010-05-06 00:08:46 +00005958 PyObject *(*getitem)(PyObject *, Py_ssize_t);
Guido van Rossuma1065681999-01-25 23:20:23 +00005959
Victor Stinner8c62be82010-05-06 00:08:46 +00005960 /* spawnv has three arguments: (mode, path, argv), where
5961 argv is a list or tuple of strings. */
Guido van Rossuma1065681999-01-25 23:20:23 +00005962
Victor Stinner8c62be82010-05-06 00:08:46 +00005963 if (PyList_Check(argv)) {
5964 argc = PyList_Size(argv);
5965 getitem = PyList_GetItem;
5966 }
5967 else if (PyTuple_Check(argv)) {
5968 argc = PyTuple_Size(argv);
5969 getitem = PyTuple_GetItem;
5970 }
5971 else {
5972 PyErr_SetString(PyExc_TypeError,
5973 "spawnv() arg 2 must be a tuple or list");
Victor Stinner8c62be82010-05-06 00:08:46 +00005974 return NULL;
5975 }
Steve Dower859fd7b2016-11-19 18:53:19 -08005976 if (argc == 0) {
5977 PyErr_SetString(PyExc_ValueError,
5978 "spawnv() arg 2 cannot be empty");
5979 return NULL;
5980 }
Guido van Rossuma1065681999-01-25 23:20:23 +00005981
Steve Dowercc16be82016-09-08 10:35:16 -07005982 argvlist = PyMem_NEW(EXECV_CHAR *, argc+1);
Victor Stinner8c62be82010-05-06 00:08:46 +00005983 if (argvlist == NULL) {
Victor Stinner8c62be82010-05-06 00:08:46 +00005984 return PyErr_NoMemory();
5985 }
5986 for (i = 0; i < argc; i++) {
5987 if (!fsconvert_strdup((*getitem)(argv, i),
5988 &argvlist[i])) {
5989 free_string_array(argvlist, i);
5990 PyErr_SetString(
5991 PyExc_TypeError,
5992 "spawnv() arg 2 must contain only strings");
Victor Stinner8c62be82010-05-06 00:08:46 +00005993 return NULL;
5994 }
Steve Dower93ff8722016-11-19 19:03:54 -08005995 if (i == 0 && !argvlist[0][0]) {
Victor Stinner8acb4cf2017-06-15 15:30:40 +02005996 free_string_array(argvlist, i + 1);
Steve Dower93ff8722016-11-19 19:03:54 -08005997 PyErr_SetString(
5998 PyExc_ValueError,
5999 "spawnv() arg 2 first element cannot be empty");
6000 return NULL;
6001 }
Victor Stinner8c62be82010-05-06 00:08:46 +00006002 }
6003 argvlist[argc] = NULL;
Guido van Rossuma1065681999-01-25 23:20:23 +00006004
pxinwrf2d7ac72019-05-21 18:46:37 +08006005#if !defined(HAVE_RTPSPAWN)
Victor Stinner8c62be82010-05-06 00:08:46 +00006006 if (mode == _OLD_P_OVERLAY)
6007 mode = _P_OVERLAY;
pxinwrf2d7ac72019-05-21 18:46:37 +08006008#endif
Tim Peters5aa91602002-01-30 05:46:57 +00006009
Saiyang Gou7514f4f2020-02-12 23:47:42 -08006010 if (PySys_Audit("os.spawn", "iOOO", mode, path->object, argv,
Saiyang Gou95f60012020-02-04 16:15:00 -08006011 Py_None) < 0) {
6012 free_string_array(argvlist, argc);
6013 return NULL;
6014 }
6015
Victor Stinner8c62be82010-05-06 00:08:46 +00006016 Py_BEGIN_ALLOW_THREADS
Steve Dower654a7bd2016-09-11 20:19:32 -07006017 _Py_BEGIN_SUPPRESS_IPH
Steve Dowercc16be82016-09-08 10:35:16 -07006018#ifdef HAVE_WSPAWNV
6019 spawnval = _wspawnv(mode, path->wide, argvlist);
pxinwrf2d7ac72019-05-21 18:46:37 +08006020#elif defined(HAVE_RTPSPAWN)
6021 spawnval = _rtp_spawn(mode, path->narrow, (const char **)argvlist, NULL);
Steve Dowercc16be82016-09-08 10:35:16 -07006022#else
6023 spawnval = _spawnv(mode, path->narrow, argvlist);
6024#endif
Steve Dower654a7bd2016-09-11 20:19:32 -07006025 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00006026 Py_END_ALLOW_THREADS
Tim Peters5aa91602002-01-30 05:46:57 +00006027
Victor Stinner8c62be82010-05-06 00:08:46 +00006028 free_string_array(argvlist, argc);
Guido van Rossuma1065681999-01-25 23:20:23 +00006029
Victor Stinner8c62be82010-05-06 00:08:46 +00006030 if (spawnval == -1)
6031 return posix_error();
6032 else
Richard Oudkerkac0ad882013-06-05 23:29:30 +01006033 return Py_BuildValue(_Py_PARSE_INTPTR, spawnval);
Guido van Rossuma1065681999-01-25 23:20:23 +00006034}
6035
Larry Hastings2f936352014-08-05 14:04:04 +10006036/*[clinic input]
6037os.spawnve
6038
6039 mode: int
6040 Mode of process creation.
Steve Dowercc16be82016-09-08 10:35:16 -07006041 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +10006042 Path of executable file.
6043 argv: object
6044 Tuple or list of strings.
6045 env: object
6046 Dictionary of strings mapping to strings.
6047 /
6048
6049Execute the program specified by path in a new process.
6050[clinic start generated code]*/
6051
Larry Hastings2f936352014-08-05 14:04:04 +10006052static PyObject *
Steve Dowercc16be82016-09-08 10:35:16 -07006053os_spawnve_impl(PyObject *module, int mode, path_t *path, PyObject *argv,
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006054 PyObject *env)
Steve Dowercc16be82016-09-08 10:35:16 -07006055/*[clinic end generated code: output=30fe85be56fe37ad input=3e40803ee7c4c586]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006056{
Steve Dowercc16be82016-09-08 10:35:16 -07006057 EXECV_CHAR **argvlist;
6058 EXECV_CHAR **envlist;
Victor Stinner8c62be82010-05-06 00:08:46 +00006059 PyObject *res = NULL;
Antoine Pitrou22e41552010-08-15 18:07:50 +00006060 Py_ssize_t argc, i, envc;
Benjamin Petersonca470632016-09-06 13:47:26 -07006061 intptr_t spawnval;
Victor Stinner8c62be82010-05-06 00:08:46 +00006062 PyObject *(*getitem)(PyObject *, Py_ssize_t);
Victor Stinnerc8d6ab22017-06-23 15:04:46 +02006063 Py_ssize_t lastarg = 0;
Guido van Rossuma1065681999-01-25 23:20:23 +00006064
Victor Stinner8c62be82010-05-06 00:08:46 +00006065 /* spawnve has four arguments: (mode, path, argv, env), where
6066 argv is a list or tuple of strings and env is a dictionary
6067 like posix.environ. */
Guido van Rossuma1065681999-01-25 23:20:23 +00006068
Victor Stinner8c62be82010-05-06 00:08:46 +00006069 if (PyList_Check(argv)) {
6070 argc = PyList_Size(argv);
6071 getitem = PyList_GetItem;
6072 }
6073 else if (PyTuple_Check(argv)) {
6074 argc = PyTuple_Size(argv);
6075 getitem = PyTuple_GetItem;
6076 }
6077 else {
6078 PyErr_SetString(PyExc_TypeError,
6079 "spawnve() arg 2 must be a tuple or list");
6080 goto fail_0;
6081 }
Steve Dower859fd7b2016-11-19 18:53:19 -08006082 if (argc == 0) {
6083 PyErr_SetString(PyExc_ValueError,
6084 "spawnve() arg 2 cannot be empty");
6085 goto fail_0;
6086 }
Victor Stinner8c62be82010-05-06 00:08:46 +00006087 if (!PyMapping_Check(env)) {
6088 PyErr_SetString(PyExc_TypeError,
6089 "spawnve() arg 3 must be a mapping object");
6090 goto fail_0;
6091 }
Guido van Rossuma1065681999-01-25 23:20:23 +00006092
Steve Dowercc16be82016-09-08 10:35:16 -07006093 argvlist = PyMem_NEW(EXECV_CHAR *, argc+1);
Victor Stinner8c62be82010-05-06 00:08:46 +00006094 if (argvlist == NULL) {
6095 PyErr_NoMemory();
6096 goto fail_0;
6097 }
6098 for (i = 0; i < argc; i++) {
6099 if (!fsconvert_strdup((*getitem)(argv, i),
6100 &argvlist[i]))
6101 {
6102 lastarg = i;
6103 goto fail_1;
6104 }
Steve Dowerbce26262016-11-19 19:17:26 -08006105 if (i == 0 && !argvlist[0][0]) {
Victor Stinnerc8d6ab22017-06-23 15:04:46 +02006106 lastarg = i + 1;
Steve Dowerbce26262016-11-19 19:17:26 -08006107 PyErr_SetString(
6108 PyExc_ValueError,
6109 "spawnv() arg 2 first element cannot be empty");
6110 goto fail_1;
6111 }
Victor Stinner8c62be82010-05-06 00:08:46 +00006112 }
6113 lastarg = argc;
6114 argvlist[argc] = NULL;
Guido van Rossuma1065681999-01-25 23:20:23 +00006115
Victor Stinner8c62be82010-05-06 00:08:46 +00006116 envlist = parse_envlist(env, &envc);
6117 if (envlist == NULL)
6118 goto fail_1;
Guido van Rossuma1065681999-01-25 23:20:23 +00006119
pxinwrf2d7ac72019-05-21 18:46:37 +08006120#if !defined(HAVE_RTPSPAWN)
Victor Stinner8c62be82010-05-06 00:08:46 +00006121 if (mode == _OLD_P_OVERLAY)
6122 mode = _P_OVERLAY;
pxinwrf2d7ac72019-05-21 18:46:37 +08006123#endif
Tim Peters25059d32001-12-07 20:35:43 +00006124
Saiyang Gou7514f4f2020-02-12 23:47:42 -08006125 if (PySys_Audit("os.spawn", "iOOO", mode, path->object, argv, env) < 0) {
Saiyang Gou95f60012020-02-04 16:15:00 -08006126 goto fail_2;
6127 }
6128
Victor Stinner8c62be82010-05-06 00:08:46 +00006129 Py_BEGIN_ALLOW_THREADS
Steve Dower654a7bd2016-09-11 20:19:32 -07006130 _Py_BEGIN_SUPPRESS_IPH
Steve Dowercc16be82016-09-08 10:35:16 -07006131#ifdef HAVE_WSPAWNV
6132 spawnval = _wspawnve(mode, path->wide, argvlist, envlist);
pxinwrf2d7ac72019-05-21 18:46:37 +08006133#elif defined(HAVE_RTPSPAWN)
6134 spawnval = _rtp_spawn(mode, path->narrow, (const char **)argvlist,
6135 (const char **)envlist);
Steve Dowercc16be82016-09-08 10:35:16 -07006136#else
6137 spawnval = _spawnve(mode, path->narrow, argvlist, envlist);
6138#endif
Steve Dower654a7bd2016-09-11 20:19:32 -07006139 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00006140 Py_END_ALLOW_THREADS
Tim Peters25059d32001-12-07 20:35:43 +00006141
Victor Stinner8c62be82010-05-06 00:08:46 +00006142 if (spawnval == -1)
6143 (void) posix_error();
6144 else
Richard Oudkerkac0ad882013-06-05 23:29:30 +01006145 res = Py_BuildValue(_Py_PARSE_INTPTR, spawnval);
Guido van Rossuma1065681999-01-25 23:20:23 +00006146
Saiyang Gou95f60012020-02-04 16:15:00 -08006147 fail_2:
Victor Stinner8c62be82010-05-06 00:08:46 +00006148 while (--envc >= 0)
6149 PyMem_DEL(envlist[envc]);
6150 PyMem_DEL(envlist);
Guido van Rossum0847c5c2002-12-13 18:36:22 +00006151 fail_1:
Victor Stinnerc8d6ab22017-06-23 15:04:46 +02006152 free_string_array(argvlist, lastarg);
Martin v. Löwis114619e2002-10-07 06:44:21 +00006153 fail_0:
Victor Stinner8c62be82010-05-06 00:08:46 +00006154 return res;
Guido van Rossuma1065681999-01-25 23:20:23 +00006155}
Andrew MacIntyre69e18c92004-04-04 07:11:43 +00006156
Guido van Rossuma1065681999-01-25 23:20:23 +00006157#endif /* HAVE_SPAWNV */
6158
6159
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006160#ifdef HAVE_FORK
Gregory P. Smith163468a2017-05-29 10:03:41 -07006161
6162/* Helper function to validate arguments.
6163 Returns 0 on success. non-zero on failure with a TypeError raised.
6164 If obj is non-NULL it must be callable. */
6165static int
6166check_null_or_callable(PyObject *obj, const char* obj_name)
6167{
6168 if (obj && !PyCallable_Check(obj)) {
6169 PyErr_Format(PyExc_TypeError, "'%s' must be callable, not %s",
Eddie Elizondob3966632019-11-05 07:16:14 -08006170 obj_name, _PyType_Name(Py_TYPE(obj)));
Gregory P. Smith163468a2017-05-29 10:03:41 -07006171 return -1;
6172 }
6173 return 0;
6174}
6175
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006176/*[clinic input]
6177os.register_at_fork
6178
Gregory P. Smith163468a2017-05-29 10:03:41 -07006179 *
6180 before: object=NULL
6181 A callable to be called in the parent before the fork() syscall.
6182 after_in_child: object=NULL
6183 A callable to be called in the child after fork().
6184 after_in_parent: object=NULL
6185 A callable to be called in the parent after fork().
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006186
Gregory P. Smith163468a2017-05-29 10:03:41 -07006187Register callables to be called when forking a new process.
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006188
Gregory P. Smith163468a2017-05-29 10:03:41 -07006189'before' callbacks are called in reverse order.
6190'after_in_child' and 'after_in_parent' callbacks are called in order.
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006191
6192[clinic start generated code]*/
6193
6194static PyObject *
Gregory P. Smith163468a2017-05-29 10:03:41 -07006195os_register_at_fork_impl(PyObject *module, PyObject *before,
6196 PyObject *after_in_child, PyObject *after_in_parent)
6197/*[clinic end generated code: output=5398ac75e8e97625 input=cd1187aa85d2312e]*/
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006198{
6199 PyInterpreterState *interp;
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006200
Gregory P. Smith163468a2017-05-29 10:03:41 -07006201 if (!before && !after_in_child && !after_in_parent) {
6202 PyErr_SetString(PyExc_TypeError, "At least one argument is required.");
6203 return NULL;
6204 }
6205 if (check_null_or_callable(before, "before") ||
6206 check_null_or_callable(after_in_child, "after_in_child") ||
6207 check_null_or_callable(after_in_parent, "after_in_parent")) {
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006208 return NULL;
6209 }
Victor Stinner81a7be32020-04-14 15:14:01 +02006210 interp = _PyInterpreterState_GET();
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006211
Gregory P. Smith163468a2017-05-29 10:03:41 -07006212 if (register_at_forker(&interp->before_forkers, before)) {
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006213 return NULL;
6214 }
Gregory P. Smith163468a2017-05-29 10:03:41 -07006215 if (register_at_forker(&interp->after_forkers_child, after_in_child)) {
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006216 return NULL;
Gregory P. Smith163468a2017-05-29 10:03:41 -07006217 }
6218 if (register_at_forker(&interp->after_forkers_parent, after_in_parent)) {
6219 return NULL;
6220 }
6221 Py_RETURN_NONE;
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006222}
6223#endif /* HAVE_FORK */
6224
6225
Guido van Rossum2242f2f2001-04-11 20:58:20 +00006226#ifdef HAVE_FORK1
Larry Hastings2f936352014-08-05 14:04:04 +10006227/*[clinic input]
6228os.fork1
6229
6230Fork a child process with a single multiplexed (i.e., not bound) thread.
6231
6232Return 0 to child process and PID of child to parent process.
6233[clinic start generated code]*/
6234
Larry Hastings2f936352014-08-05 14:04:04 +10006235static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006236os_fork1_impl(PyObject *module)
6237/*[clinic end generated code: output=0de8e67ce2a310bc input=12db02167893926e]*/
Guido van Rossum2242f2f2001-04-11 20:58:20 +00006238{
Victor Stinner8c62be82010-05-06 00:08:46 +00006239 pid_t pid;
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006240
Victor Stinner81a7be32020-04-14 15:14:01 +02006241 if (_PyInterpreterState_GET() != PyInterpreterState_Main()) {
Eric Snow59032962018-09-14 14:17:20 -07006242 PyErr_SetString(PyExc_RuntimeError, "fork not supported for subinterpreters");
6243 return NULL;
6244 }
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006245 PyOS_BeforeFork();
Victor Stinner8c62be82010-05-06 00:08:46 +00006246 pid = fork1();
6247 if (pid == 0) {
6248 /* child: this clobbers and resets the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006249 PyOS_AfterFork_Child();
Victor Stinner8c62be82010-05-06 00:08:46 +00006250 } else {
6251 /* parent: release the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006252 PyOS_AfterFork_Parent();
Victor Stinner8c62be82010-05-06 00:08:46 +00006253 }
6254 if (pid == -1)
6255 return posix_error();
Victor Stinner8c62be82010-05-06 00:08:46 +00006256 return PyLong_FromPid(pid);
Guido van Rossum2242f2f2001-04-11 20:58:20 +00006257}
Larry Hastings2f936352014-08-05 14:04:04 +10006258#endif /* HAVE_FORK1 */
Guido van Rossum2242f2f2001-04-11 20:58:20 +00006259
6260
Guido van Rossumad0ee831995-03-01 10:34:45 +00006261#ifdef HAVE_FORK
Larry Hastings2f936352014-08-05 14:04:04 +10006262/*[clinic input]
6263os.fork
6264
6265Fork a child process.
6266
6267Return 0 to child process and PID of child to parent process.
6268[clinic start generated code]*/
6269
Larry Hastings2f936352014-08-05 14:04:04 +10006270static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006271os_fork_impl(PyObject *module)
6272/*[clinic end generated code: output=3626c81f98985d49 input=13c956413110eeaa]*/
Guido van Rossum85e3b011991-06-03 12:42:10 +00006273{
Victor Stinner8c62be82010-05-06 00:08:46 +00006274 pid_t pid;
Victor Stinner252346a2020-05-01 11:33:44 +02006275 PyInterpreterState *interp = _PyInterpreterState_GET();
6276 if (interp->config._isolated_interpreter) {
6277 PyErr_SetString(PyExc_RuntimeError,
6278 "fork not supported for isolated subinterpreters");
Eric Snow59032962018-09-14 14:17:20 -07006279 return NULL;
6280 }
Saiyang Gou7514f4f2020-02-12 23:47:42 -08006281 if (PySys_Audit("os.fork", NULL) < 0) {
6282 return NULL;
6283 }
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006284 PyOS_BeforeFork();
Victor Stinner8c62be82010-05-06 00:08:46 +00006285 pid = fork();
6286 if (pid == 0) {
6287 /* child: this clobbers and resets the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006288 PyOS_AfterFork_Child();
Victor Stinner8c62be82010-05-06 00:08:46 +00006289 } else {
6290 /* parent: release the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006291 PyOS_AfterFork_Parent();
Victor Stinner8c62be82010-05-06 00:08:46 +00006292 }
6293 if (pid == -1)
6294 return posix_error();
Victor Stinner8c62be82010-05-06 00:08:46 +00006295 return PyLong_FromPid(pid);
Guido van Rossum85e3b011991-06-03 12:42:10 +00006296}
Larry Hastings2f936352014-08-05 14:04:04 +10006297#endif /* HAVE_FORK */
6298
Guido van Rossum85e3b011991-06-03 12:42:10 +00006299
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006300#ifdef HAVE_SCHED_H
Charles-François Nataliea0d5fc2011-09-06 19:03:35 +02006301#ifdef HAVE_SCHED_GET_PRIORITY_MAX
Larry Hastings2f936352014-08-05 14:04:04 +10006302/*[clinic input]
6303os.sched_get_priority_max
Charles-François Nataliea0d5fc2011-09-06 19:03:35 +02006304
Larry Hastings2f936352014-08-05 14:04:04 +10006305 policy: int
6306
6307Get the maximum scheduling priority for policy.
6308[clinic start generated code]*/
6309
Larry Hastings2f936352014-08-05 14:04:04 +10006310static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006311os_sched_get_priority_max_impl(PyObject *module, int policy)
6312/*[clinic end generated code: output=9e465c6e43130521 input=2097b7998eca6874]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006313{
6314 int max;
6315
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006316 max = sched_get_priority_max(policy);
6317 if (max < 0)
6318 return posix_error();
6319 return PyLong_FromLong(max);
6320}
6321
Larry Hastings2f936352014-08-05 14:04:04 +10006322
6323/*[clinic input]
6324os.sched_get_priority_min
6325
6326 policy: int
6327
6328Get the minimum scheduling priority for policy.
6329[clinic start generated code]*/
6330
Larry Hastings2f936352014-08-05 14:04:04 +10006331static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006332os_sched_get_priority_min_impl(PyObject *module, int policy)
6333/*[clinic end generated code: output=7595c1138cc47a6d input=21bc8fa0d70983bf]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006334{
6335 int min = sched_get_priority_min(policy);
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006336 if (min < 0)
6337 return posix_error();
6338 return PyLong_FromLong(min);
6339}
Charles-François Nataliea0d5fc2011-09-06 19:03:35 +02006340#endif /* HAVE_SCHED_GET_PRIORITY_MAX */
6341
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006342
Larry Hastings2f936352014-08-05 14:04:04 +10006343#ifdef HAVE_SCHED_SETSCHEDULER
6344/*[clinic input]
6345os.sched_getscheduler
6346 pid: pid_t
6347 /
6348
Min ho Kimc4cacc82019-07-31 08:16:13 +10006349Get the scheduling policy for the process identified by pid.
Larry Hastings2f936352014-08-05 14:04:04 +10006350
6351Passing 0 for pid returns the scheduling policy for the calling process.
6352[clinic start generated code]*/
6353
Larry Hastings2f936352014-08-05 14:04:04 +10006354static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006355os_sched_getscheduler_impl(PyObject *module, pid_t pid)
Min ho Kimc4cacc82019-07-31 08:16:13 +10006356/*[clinic end generated code: output=dce4c0bd3f1b34c8 input=8d99dac505485ac8]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006357{
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006358 int policy;
6359
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006360 policy = sched_getscheduler(pid);
6361 if (policy < 0)
6362 return posix_error();
6363 return PyLong_FromLong(policy);
6364}
Larry Hastings2f936352014-08-05 14:04:04 +10006365#endif /* HAVE_SCHED_SETSCHEDULER */
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006366
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006367
William Orr81574b82018-10-01 22:19:56 -07006368#if defined(HAVE_SCHED_SETPARAM) || defined(HAVE_SCHED_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDPARAM)
Larry Hastings2f936352014-08-05 14:04:04 +10006369/*[clinic input]
Eddie Elizondo474eedf2018-11-13 04:09:31 -08006370class os.sched_param "PyObject *" "SchedParamType"
Larry Hastings2f936352014-08-05 14:04:04 +10006371
6372@classmethod
6373os.sched_param.__new__
6374
6375 sched_priority: object
6376 A scheduling parameter.
6377
Eddie Elizondob3966632019-11-05 07:16:14 -08006378Currently has only one field: sched_priority
Larry Hastings2f936352014-08-05 14:04:04 +10006379[clinic start generated code]*/
6380
Larry Hastings2f936352014-08-05 14:04:04 +10006381static PyObject *
6382os_sched_param_impl(PyTypeObject *type, PyObject *sched_priority)
Eddie Elizondob3966632019-11-05 07:16:14 -08006383/*[clinic end generated code: output=48f4067d60f48c13 input=eb42909a2c0e3e6c]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006384{
6385 PyObject *res;
6386
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006387 res = PyStructSequence_New(type);
6388 if (!res)
6389 return NULL;
Larry Hastings2f936352014-08-05 14:04:04 +10006390 Py_INCREF(sched_priority);
6391 PyStructSequence_SET_ITEM(res, 0, sched_priority);
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006392 return res;
6393}
6394
Serhiy Storchaka1009bf12015-04-03 23:53:51 +03006395PyDoc_VAR(os_sched_param__doc__);
6396
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006397static PyStructSequence_Field sched_param_fields[] = {
6398 {"sched_priority", "the scheduling priority"},
6399 {0}
6400};
6401
6402static PyStructSequence_Desc sched_param_desc = {
6403 "sched_param", /* name */
Larry Hastings2f936352014-08-05 14:04:04 +10006404 os_sched_param__doc__, /* doc */
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006405 sched_param_fields,
6406 1
6407};
6408
6409static int
Victor Stinner1c2fa782020-05-10 11:05:29 +02006410convert_sched_param(PyObject *module, PyObject *param, struct sched_param *res)
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006411{
6412 long priority;
6413
Victor Stinner1c2fa782020-05-10 11:05:29 +02006414 if (!Py_IS_TYPE(param, (PyTypeObject *)get_posix_state(module)->SchedParamType)) {
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006415 PyErr_SetString(PyExc_TypeError, "must have a sched_param object");
6416 return 0;
6417 }
6418 priority = PyLong_AsLong(PyStructSequence_GET_ITEM(param, 0));
6419 if (priority == -1 && PyErr_Occurred())
6420 return 0;
6421 if (priority > INT_MAX || priority < INT_MIN) {
6422 PyErr_SetString(PyExc_OverflowError, "sched_priority out of range");
6423 return 0;
6424 }
6425 res->sched_priority = Py_SAFE_DOWNCAST(priority, long, int);
6426 return 1;
6427}
William Orr81574b82018-10-01 22:19:56 -07006428#endif /* defined(HAVE_SCHED_SETPARAM) || defined(HAVE_SCHED_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDPARAM) */
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006429
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006430
6431#ifdef HAVE_SCHED_SETSCHEDULER
Larry Hastings2f936352014-08-05 14:04:04 +10006432/*[clinic input]
6433os.sched_setscheduler
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006434
Larry Hastings2f936352014-08-05 14:04:04 +10006435 pid: pid_t
6436 policy: int
Victor Stinner1c2fa782020-05-10 11:05:29 +02006437 param as param_obj: object
Larry Hastings2f936352014-08-05 14:04:04 +10006438 /
6439
6440Set the scheduling policy for the process identified by pid.
6441
6442If pid is 0, the calling process is changed.
6443param is an instance of sched_param.
6444[clinic start generated code]*/
6445
Larry Hastings2f936352014-08-05 14:04:04 +10006446static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006447os_sched_setscheduler_impl(PyObject *module, pid_t pid, int policy,
Victor Stinner1c2fa782020-05-10 11:05:29 +02006448 PyObject *param_obj)
6449/*[clinic end generated code: output=cde27faa55dc993e input=73013d731bd8fbe9]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006450{
Victor Stinner1c2fa782020-05-10 11:05:29 +02006451 struct sched_param param;
6452 if (!convert_sched_param(module, param_obj, &param)) {
6453 return NULL;
6454 }
6455
Jesus Cea9c822272011-09-10 01:40:52 +02006456 /*
Jesus Cea54b01492011-09-10 01:53:19 +02006457 ** sched_setscheduler() returns 0 in Linux, but the previous
6458 ** scheduling policy under Solaris/Illumos, and others.
6459 ** On error, -1 is returned in all Operating Systems.
Jesus Cea9c822272011-09-10 01:40:52 +02006460 */
Victor Stinner1c2fa782020-05-10 11:05:29 +02006461 if (sched_setscheduler(pid, policy, &param) == -1)
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006462 return posix_error();
6463 Py_RETURN_NONE;
6464}
Larry Hastings2f936352014-08-05 14:04:04 +10006465#endif /* HAVE_SCHED_SETSCHEDULER*/
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006466
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006467
6468#ifdef HAVE_SCHED_SETPARAM
Larry Hastings2f936352014-08-05 14:04:04 +10006469/*[clinic input]
6470os.sched_getparam
6471 pid: pid_t
6472 /
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006473
Larry Hastings2f936352014-08-05 14:04:04 +10006474Returns scheduling parameters for the process identified by pid.
6475
6476If pid is 0, returns parameters for the calling process.
6477Return value is an instance of sched_param.
6478[clinic start generated code]*/
6479
Larry Hastings2f936352014-08-05 14:04:04 +10006480static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006481os_sched_getparam_impl(PyObject *module, pid_t pid)
6482/*[clinic end generated code: output=b194e8708dcf2db8 input=18a1ef9c2efae296]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006483{
6484 struct sched_param param;
6485 PyObject *result;
6486 PyObject *priority;
6487
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006488 if (sched_getparam(pid, &param))
6489 return posix_error();
Victor Stinner1c2fa782020-05-10 11:05:29 +02006490 PyObject *SchedParamType = get_posix_state(module)->SchedParamType;
Eddie Elizondob3966632019-11-05 07:16:14 -08006491 result = PyStructSequence_New((PyTypeObject *)SchedParamType);
Larry Hastings2f936352014-08-05 14:04:04 +10006492 if (!result)
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006493 return NULL;
6494 priority = PyLong_FromLong(param.sched_priority);
6495 if (!priority) {
Larry Hastings2f936352014-08-05 14:04:04 +10006496 Py_DECREF(result);
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006497 return NULL;
6498 }
Larry Hastings2f936352014-08-05 14:04:04 +10006499 PyStructSequence_SET_ITEM(result, 0, priority);
6500 return result;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006501}
6502
Larry Hastings2f936352014-08-05 14:04:04 +10006503
6504/*[clinic input]
6505os.sched_setparam
6506 pid: pid_t
Victor Stinner1c2fa782020-05-10 11:05:29 +02006507 param as param_obj: object
Larry Hastings2f936352014-08-05 14:04:04 +10006508 /
6509
6510Set scheduling parameters for the process identified by pid.
6511
6512If pid is 0, sets parameters for the calling process.
6513param should be an instance of sched_param.
6514[clinic start generated code]*/
6515
Larry Hastings2f936352014-08-05 14:04:04 +10006516static PyObject *
Victor Stinner1c2fa782020-05-10 11:05:29 +02006517os_sched_setparam_impl(PyObject *module, pid_t pid, PyObject *param_obj)
6518/*[clinic end generated code: output=f19fe020a53741c1 input=27b98337c8b2dcc7]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006519{
Victor Stinner1c2fa782020-05-10 11:05:29 +02006520 struct sched_param param;
6521 if (!convert_sched_param(module, param_obj, &param)) {
6522 return NULL;
6523 }
6524
6525 if (sched_setparam(pid, &param))
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006526 return posix_error();
6527 Py_RETURN_NONE;
6528}
Larry Hastings2f936352014-08-05 14:04:04 +10006529#endif /* HAVE_SCHED_SETPARAM */
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006530
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006531
6532#ifdef HAVE_SCHED_RR_GET_INTERVAL
Larry Hastings2f936352014-08-05 14:04:04 +10006533/*[clinic input]
6534os.sched_rr_get_interval -> double
6535 pid: pid_t
6536 /
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006537
Larry Hastings2f936352014-08-05 14:04:04 +10006538Return the round-robin quantum for the process identified by pid, in seconds.
6539
6540Value returned is a float.
6541[clinic start generated code]*/
6542
Larry Hastings2f936352014-08-05 14:04:04 +10006543static double
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006544os_sched_rr_get_interval_impl(PyObject *module, pid_t pid)
6545/*[clinic end generated code: output=7e2d935833ab47dc input=2a973da15cca6fae]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006546{
6547 struct timespec interval;
6548 if (sched_rr_get_interval(pid, &interval)) {
6549 posix_error();
6550 return -1.0;
6551 }
Gregory P. Smith1d300ce2018-12-30 21:13:02 -08006552#ifdef _Py_MEMORY_SANITIZER
6553 __msan_unpoison(&interval, sizeof(interval));
6554#endif
Larry Hastings2f936352014-08-05 14:04:04 +10006555 return (double)interval.tv_sec + 1e-9*interval.tv_nsec;
6556}
6557#endif /* HAVE_SCHED_RR_GET_INTERVAL */
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006558
Larry Hastings2f936352014-08-05 14:04:04 +10006559
6560/*[clinic input]
6561os.sched_yield
6562
6563Voluntarily relinquish the CPU.
6564[clinic start generated code]*/
6565
Larry Hastings2f936352014-08-05 14:04:04 +10006566static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006567os_sched_yield_impl(PyObject *module)
6568/*[clinic end generated code: output=902323500f222cac input=e54d6f98189391d4]*/
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006569{
6570 if (sched_yield())
6571 return posix_error();
6572 Py_RETURN_NONE;
6573}
6574
Benjamin Peterson2740af82011-08-02 17:41:34 -05006575#ifdef HAVE_SCHED_SETAFFINITY
Antoine Pitrou84869872012-08-04 16:16:35 +02006576/* The minimum number of CPUs allocated in a cpu_set_t */
6577static const int NCPUS_START = sizeof(unsigned long) * CHAR_BIT;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006578
Larry Hastings2f936352014-08-05 14:04:04 +10006579/*[clinic input]
6580os.sched_setaffinity
6581 pid: pid_t
6582 mask : object
6583 /
6584
6585Set the CPU affinity of the process identified by pid to mask.
6586
6587mask should be an iterable of integers identifying CPUs.
6588[clinic start generated code]*/
6589
Larry Hastings2f936352014-08-05 14:04:04 +10006590static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006591os_sched_setaffinity_impl(PyObject *module, pid_t pid, PyObject *mask)
6592/*[clinic end generated code: output=882d7dd9a229335b input=a0791a597c7085ba]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006593{
Antoine Pitrou84869872012-08-04 16:16:35 +02006594 int ncpus;
6595 size_t setsize;
Larry Hastings2f936352014-08-05 14:04:04 +10006596 cpu_set_t *cpu_set = NULL;
6597 PyObject *iterator = NULL, *item;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006598
Larry Hastings2f936352014-08-05 14:04:04 +10006599 iterator = PyObject_GetIter(mask);
Antoine Pitrou84869872012-08-04 16:16:35 +02006600 if (iterator == NULL)
6601 return NULL;
6602
6603 ncpus = NCPUS_START;
6604 setsize = CPU_ALLOC_SIZE(ncpus);
Larry Hastings2f936352014-08-05 14:04:04 +10006605 cpu_set = CPU_ALLOC(ncpus);
6606 if (cpu_set == NULL) {
Antoine Pitrou84869872012-08-04 16:16:35 +02006607 PyErr_NoMemory();
6608 goto error;
6609 }
Larry Hastings2f936352014-08-05 14:04:04 +10006610 CPU_ZERO_S(setsize, cpu_set);
Antoine Pitrou84869872012-08-04 16:16:35 +02006611
6612 while ((item = PyIter_Next(iterator))) {
6613 long cpu;
6614 if (!PyLong_Check(item)) {
6615 PyErr_Format(PyExc_TypeError,
6616 "expected an iterator of ints, "
6617 "but iterator yielded %R",
6618 Py_TYPE(item));
6619 Py_DECREF(item);
6620 goto error;
6621 }
6622 cpu = PyLong_AsLong(item);
6623 Py_DECREF(item);
6624 if (cpu < 0) {
6625 if (!PyErr_Occurred())
6626 PyErr_SetString(PyExc_ValueError, "negative CPU number");
6627 goto error;
6628 }
6629 if (cpu > INT_MAX - 1) {
6630 PyErr_SetString(PyExc_OverflowError, "CPU number too large");
6631 goto error;
6632 }
6633 if (cpu >= ncpus) {
6634 /* Grow CPU mask to fit the CPU number */
6635 int newncpus = ncpus;
6636 cpu_set_t *newmask;
6637 size_t newsetsize;
6638 while (newncpus <= cpu) {
6639 if (newncpus > INT_MAX / 2)
6640 newncpus = cpu + 1;
6641 else
6642 newncpus = newncpus * 2;
6643 }
6644 newmask = CPU_ALLOC(newncpus);
6645 if (newmask == NULL) {
6646 PyErr_NoMemory();
6647 goto error;
6648 }
6649 newsetsize = CPU_ALLOC_SIZE(newncpus);
6650 CPU_ZERO_S(newsetsize, newmask);
Larry Hastings2f936352014-08-05 14:04:04 +10006651 memcpy(newmask, cpu_set, setsize);
6652 CPU_FREE(cpu_set);
Antoine Pitrou84869872012-08-04 16:16:35 +02006653 setsize = newsetsize;
Larry Hastings2f936352014-08-05 14:04:04 +10006654 cpu_set = newmask;
Antoine Pitrou84869872012-08-04 16:16:35 +02006655 ncpus = newncpus;
6656 }
Larry Hastings2f936352014-08-05 14:04:04 +10006657 CPU_SET_S(cpu, setsize, cpu_set);
Antoine Pitrou84869872012-08-04 16:16:35 +02006658 }
Brandt Bucher45a30af2019-06-27 09:10:57 -07006659 if (PyErr_Occurred()) {
6660 goto error;
6661 }
Antoine Pitrou84869872012-08-04 16:16:35 +02006662 Py_CLEAR(iterator);
6663
Larry Hastings2f936352014-08-05 14:04:04 +10006664 if (sched_setaffinity(pid, setsize, cpu_set)) {
Antoine Pitrou84869872012-08-04 16:16:35 +02006665 posix_error();
6666 goto error;
6667 }
Larry Hastings2f936352014-08-05 14:04:04 +10006668 CPU_FREE(cpu_set);
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006669 Py_RETURN_NONE;
Antoine Pitrou84869872012-08-04 16:16:35 +02006670
6671error:
Larry Hastings2f936352014-08-05 14:04:04 +10006672 if (cpu_set)
6673 CPU_FREE(cpu_set);
Antoine Pitrou84869872012-08-04 16:16:35 +02006674 Py_XDECREF(iterator);
6675 return NULL;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006676}
6677
Larry Hastings2f936352014-08-05 14:04:04 +10006678
6679/*[clinic input]
6680os.sched_getaffinity
6681 pid: pid_t
6682 /
6683
Charles-François Natalidc87e4b2015-07-13 21:01:39 +01006684Return the affinity of the process identified by pid (or the current process if zero).
Larry Hastings2f936352014-08-05 14:04:04 +10006685
6686The affinity is returned as a set of CPU identifiers.
6687[clinic start generated code]*/
6688
Larry Hastings2f936352014-08-05 14:04:04 +10006689static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006690os_sched_getaffinity_impl(PyObject *module, pid_t pid)
Serhiy Storchaka2954f832016-07-07 18:20:03 +03006691/*[clinic end generated code: output=f726f2c193c17a4f input=983ce7cb4a565980]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006692{
Antoine Pitrou84869872012-08-04 16:16:35 +02006693 int cpu, ncpus, count;
6694 size_t setsize;
6695 cpu_set_t *mask = NULL;
6696 PyObject *res = NULL;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006697
Antoine Pitrou84869872012-08-04 16:16:35 +02006698 ncpus = NCPUS_START;
6699 while (1) {
6700 setsize = CPU_ALLOC_SIZE(ncpus);
6701 mask = CPU_ALLOC(ncpus);
6702 if (mask == NULL)
6703 return PyErr_NoMemory();
6704 if (sched_getaffinity(pid, setsize, mask) == 0)
6705 break;
6706 CPU_FREE(mask);
6707 if (errno != EINVAL)
6708 return posix_error();
6709 if (ncpus > INT_MAX / 2) {
6710 PyErr_SetString(PyExc_OverflowError, "could not allocate "
6711 "a large enough CPU set");
6712 return NULL;
6713 }
6714 ncpus = ncpus * 2;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006715 }
Antoine Pitrou84869872012-08-04 16:16:35 +02006716
6717 res = PySet_New(NULL);
6718 if (res == NULL)
6719 goto error;
6720 for (cpu = 0, count = CPU_COUNT_S(setsize, mask); count; cpu++) {
6721 if (CPU_ISSET_S(cpu, setsize, mask)) {
6722 PyObject *cpu_num = PyLong_FromLong(cpu);
6723 --count;
6724 if (cpu_num == NULL)
6725 goto error;
6726 if (PySet_Add(res, cpu_num)) {
6727 Py_DECREF(cpu_num);
6728 goto error;
6729 }
6730 Py_DECREF(cpu_num);
6731 }
6732 }
6733 CPU_FREE(mask);
6734 return res;
6735
6736error:
6737 if (mask)
6738 CPU_FREE(mask);
6739 Py_XDECREF(res);
6740 return NULL;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006741}
6742
Benjamin Peterson2740af82011-08-02 17:41:34 -05006743#endif /* HAVE_SCHED_SETAFFINITY */
6744
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006745#endif /* HAVE_SCHED_H */
6746
Larry Hastings2f936352014-08-05 14:04:04 +10006747
Neal Norwitzb59798b2003-03-21 01:43:31 +00006748/* AIX uses /dev/ptc but is otherwise the same as /dev/ptmx */
Neal Norwitz2deaddb2003-03-21 03:08:31 +00006749/* IRIX has both /dev/ptc and /dev/ptmx, use ptmx */
6750#if defined(HAVE_DEV_PTC) && !defined(HAVE_DEV_PTMX)
Neal Norwitzb59798b2003-03-21 01:43:31 +00006751#define DEV_PTY_FILE "/dev/ptc"
6752#define HAVE_DEV_PTMX
6753#else
6754#define DEV_PTY_FILE "/dev/ptmx"
6755#endif
6756
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006757#if defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) || defined(HAVE_DEV_PTMX)
Fred Drake8cef4cf2000-06-28 16:40:38 +00006758#ifdef HAVE_PTY_H
6759#include <pty.h>
6760#else
6761#ifdef HAVE_LIBUTIL_H
6762#include <libutil.h>
Ronald Oussoren755740f2010-02-07 19:56:39 +00006763#else
6764#ifdef HAVE_UTIL_H
6765#include <util.h>
6766#endif /* HAVE_UTIL_H */
Fred Drake8cef4cf2000-06-28 16:40:38 +00006767#endif /* HAVE_LIBUTIL_H */
6768#endif /* HAVE_PTY_H */
Martin v. Löwis14e73b12003-01-01 09:51:12 +00006769#ifdef HAVE_STROPTS_H
6770#include <stropts.h>
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006771#endif
ngie-eign7745ec42018-02-14 11:54:28 -08006772#endif /* defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) || defined(HAVE_DEV_PTMX) */
Fred Drake8cef4cf2000-06-28 16:40:38 +00006773
Larry Hastings2f936352014-08-05 14:04:04 +10006774
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006775#if defined(HAVE_OPENPTY) || defined(HAVE__GETPTY) || defined(HAVE_DEV_PTMX)
Larry Hastings2f936352014-08-05 14:04:04 +10006776/*[clinic input]
6777os.openpty
6778
6779Open a pseudo-terminal.
6780
6781Return a tuple of (master_fd, slave_fd) containing open file descriptors
6782for both the master and slave ends.
6783[clinic start generated code]*/
6784
Larry Hastings2f936352014-08-05 14:04:04 +10006785static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006786os_openpty_impl(PyObject *module)
6787/*[clinic end generated code: output=98841ce5ec9cef3c input=f3d99fd99e762907]*/
Fred Drake8cef4cf2000-06-28 16:40:38 +00006788{
Victor Stinnerdaf45552013-08-28 00:53:59 +02006789 int master_fd = -1, slave_fd = -1;
Thomas Wouters70c21a12000-07-14 14:28:33 +00006790#ifndef HAVE_OPENPTY
Victor Stinner8c62be82010-05-06 00:08:46 +00006791 char * slave_name;
Thomas Wouters70c21a12000-07-14 14:28:33 +00006792#endif
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006793#if defined(HAVE_DEV_PTMX) && !defined(HAVE_OPENPTY) && !defined(HAVE__GETPTY)
Victor Stinner8c62be82010-05-06 00:08:46 +00006794 PyOS_sighandler_t sig_saved;
Jakub Kulík6f9bc722018-12-31 03:16:40 +01006795#if defined(__sun) && defined(__SVR4)
Victor Stinner8c62be82010-05-06 00:08:46 +00006796 extern char *ptsname(int fildes);
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006797#endif
6798#endif
Thomas Wouters70c21a12000-07-14 14:28:33 +00006799
Thomas Wouters70c21a12000-07-14 14:28:33 +00006800#ifdef HAVE_OPENPTY
Victor Stinner8c62be82010-05-06 00:08:46 +00006801 if (openpty(&master_fd, &slave_fd, NULL, NULL, NULL) != 0)
Victor Stinnerdaf45552013-08-28 00:53:59 +02006802 goto posix_error;
6803
6804 if (_Py_set_inheritable(master_fd, 0, NULL) < 0)
6805 goto error;
6806 if (_Py_set_inheritable(slave_fd, 0, NULL) < 0)
6807 goto error;
6808
Neal Norwitzb59798b2003-03-21 01:43:31 +00006809#elif defined(HAVE__GETPTY)
Victor Stinner8c62be82010-05-06 00:08:46 +00006810 slave_name = _getpty(&master_fd, O_RDWR, 0666, 0);
6811 if (slave_name == NULL)
Victor Stinnerdaf45552013-08-28 00:53:59 +02006812 goto posix_error;
6813 if (_Py_set_inheritable(master_fd, 0, NULL) < 0)
6814 goto error;
Thomas Wouters70c21a12000-07-14 14:28:33 +00006815
Victor Stinnerdaf45552013-08-28 00:53:59 +02006816 slave_fd = _Py_open(slave_name, O_RDWR);
Victor Stinner8c62be82010-05-06 00:08:46 +00006817 if (slave_fd < 0)
Victor Stinnera555cfc2015-03-18 00:22:14 +01006818 goto error;
Victor Stinnerdaf45552013-08-28 00:53:59 +02006819
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006820#else
Victor Stinner000de532013-11-25 23:19:58 +01006821 master_fd = open(DEV_PTY_FILE, O_RDWR | O_NOCTTY); /* open master */
Victor Stinner8c62be82010-05-06 00:08:46 +00006822 if (master_fd < 0)
Victor Stinnerdaf45552013-08-28 00:53:59 +02006823 goto posix_error;
6824
Victor Stinner8c62be82010-05-06 00:08:46 +00006825 sig_saved = PyOS_setsig(SIGCHLD, SIG_DFL);
Victor Stinnerdaf45552013-08-28 00:53:59 +02006826
Victor Stinner8c62be82010-05-06 00:08:46 +00006827 /* change permission of slave */
6828 if (grantpt(master_fd) < 0) {
6829 PyOS_setsig(SIGCHLD, sig_saved);
Victor Stinnerdaf45552013-08-28 00:53:59 +02006830 goto posix_error;
Victor Stinner8c62be82010-05-06 00:08:46 +00006831 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02006832
Victor Stinner8c62be82010-05-06 00:08:46 +00006833 /* unlock slave */
6834 if (unlockpt(master_fd) < 0) {
6835 PyOS_setsig(SIGCHLD, sig_saved);
Victor Stinnerdaf45552013-08-28 00:53:59 +02006836 goto posix_error;
Victor Stinner8c62be82010-05-06 00:08:46 +00006837 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02006838
Victor Stinner8c62be82010-05-06 00:08:46 +00006839 PyOS_setsig(SIGCHLD, sig_saved);
Victor Stinnerdaf45552013-08-28 00:53:59 +02006840
Victor Stinner8c62be82010-05-06 00:08:46 +00006841 slave_name = ptsname(master_fd); /* get name of slave */
6842 if (slave_name == NULL)
Victor Stinnerdaf45552013-08-28 00:53:59 +02006843 goto posix_error;
6844
6845 slave_fd = _Py_open(slave_name, O_RDWR | O_NOCTTY); /* open slave */
Victor Stinnera555cfc2015-03-18 00:22:14 +01006846 if (slave_fd == -1)
6847 goto error;
Victor Stinner000de532013-11-25 23:19:58 +01006848
6849 if (_Py_set_inheritable(master_fd, 0, NULL) < 0)
6850 goto posix_error;
6851
Stefan Krahfb7c8ae2016-04-26 17:04:18 +02006852#if !defined(__CYGWIN__) && !defined(__ANDROID__) && !defined(HAVE_DEV_PTC)
Victor Stinner8c62be82010-05-06 00:08:46 +00006853 ioctl(slave_fd, I_PUSH, "ptem"); /* push ptem */
6854 ioctl(slave_fd, I_PUSH, "ldterm"); /* push ldterm */
Neal Norwitz6700e472002-12-31 16:16:07 +00006855#ifndef __hpux
Victor Stinner8c62be82010-05-06 00:08:46 +00006856 ioctl(slave_fd, I_PUSH, "ttcompat"); /* push ttcompat */
Neal Norwitz6700e472002-12-31 16:16:07 +00006857#endif /* __hpux */
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006858#endif /* HAVE_CYGWIN */
Thomas Wouters1e0c2f42000-07-24 16:06:23 +00006859#endif /* HAVE_OPENPTY */
Thomas Wouters70c21a12000-07-14 14:28:33 +00006860
Victor Stinner8c62be82010-05-06 00:08:46 +00006861 return Py_BuildValue("(ii)", master_fd, slave_fd);
Thomas Wouters70c21a12000-07-14 14:28:33 +00006862
Victor Stinnerdaf45552013-08-28 00:53:59 +02006863posix_error:
6864 posix_error();
6865error:
6866 if (master_fd != -1)
6867 close(master_fd);
6868 if (slave_fd != -1)
6869 close(slave_fd);
6870 return NULL;
Fred Drake8cef4cf2000-06-28 16:40:38 +00006871}
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006872#endif /* defined(HAVE_OPENPTY) || defined(HAVE__GETPTY) || defined(HAVE_DEV_PTMX) */
Fred Drake8cef4cf2000-06-28 16:40:38 +00006873
Larry Hastings2f936352014-08-05 14:04:04 +10006874
Fred Drake8cef4cf2000-06-28 16:40:38 +00006875#ifdef HAVE_FORKPTY
Larry Hastings2f936352014-08-05 14:04:04 +10006876/*[clinic input]
6877os.forkpty
6878
6879Fork a new process with a new pseudo-terminal as controlling tty.
6880
6881Returns a tuple of (pid, master_fd).
6882Like fork(), return pid of 0 to the child process,
6883and pid of child to the parent process.
6884To both, return fd of newly opened pseudo-terminal.
6885[clinic start generated code]*/
6886
Larry Hastings2f936352014-08-05 14:04:04 +10006887static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006888os_forkpty_impl(PyObject *module)
6889/*[clinic end generated code: output=60d0a5c7512e4087 input=f1f7f4bae3966010]*/
Fred Drake8cef4cf2000-06-28 16:40:38 +00006890{
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006891 int master_fd = -1;
Victor Stinner8c62be82010-05-06 00:08:46 +00006892 pid_t pid;
Tim Peters5aa91602002-01-30 05:46:57 +00006893
Victor Stinner81a7be32020-04-14 15:14:01 +02006894 if (_PyInterpreterState_GET() != PyInterpreterState_Main()) {
Eric Snow59032962018-09-14 14:17:20 -07006895 PyErr_SetString(PyExc_RuntimeError, "fork not supported for subinterpreters");
6896 return NULL;
6897 }
Saiyang Gou7514f4f2020-02-12 23:47:42 -08006898 if (PySys_Audit("os.forkpty", NULL) < 0) {
6899 return NULL;
6900 }
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006901 PyOS_BeforeFork();
Victor Stinner8c62be82010-05-06 00:08:46 +00006902 pid = forkpty(&master_fd, NULL, NULL, NULL);
6903 if (pid == 0) {
6904 /* child: this clobbers and resets the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006905 PyOS_AfterFork_Child();
Victor Stinner8c62be82010-05-06 00:08:46 +00006906 } else {
6907 /* parent: release the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006908 PyOS_AfterFork_Parent();
Victor Stinner8c62be82010-05-06 00:08:46 +00006909 }
6910 if (pid == -1)
6911 return posix_error();
Victor Stinner8c62be82010-05-06 00:08:46 +00006912 return Py_BuildValue("(Ni)", PyLong_FromPid(pid), master_fd);
Fred Drake8cef4cf2000-06-28 16:40:38 +00006913}
Larry Hastings2f936352014-08-05 14:04:04 +10006914#endif /* HAVE_FORKPTY */
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006915
Ross Lagerwall7807c352011-03-17 20:20:30 +02006916
Guido van Rossumad0ee831995-03-01 10:34:45 +00006917#ifdef HAVE_GETEGID
Larry Hastings2f936352014-08-05 14:04:04 +10006918/*[clinic input]
6919os.getegid
6920
6921Return the current process's effective group id.
6922[clinic start generated code]*/
6923
Larry Hastings2f936352014-08-05 14:04:04 +10006924static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006925os_getegid_impl(PyObject *module)
6926/*[clinic end generated code: output=67d9be7ac68898a2 input=1596f79ad1107d5d]*/
Guido van Rossum46003ff1992-05-15 11:05:24 +00006927{
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006928 return _PyLong_FromGid(getegid());
Guido van Rossum46003ff1992-05-15 11:05:24 +00006929}
Larry Hastings2f936352014-08-05 14:04:04 +10006930#endif /* HAVE_GETEGID */
Guido van Rossum46003ff1992-05-15 11:05:24 +00006931
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006932
Guido van Rossumad0ee831995-03-01 10:34:45 +00006933#ifdef HAVE_GETEUID
Larry Hastings2f936352014-08-05 14:04:04 +10006934/*[clinic input]
6935os.geteuid
6936
6937Return the current process's effective user id.
6938[clinic start generated code]*/
6939
Larry Hastings2f936352014-08-05 14:04:04 +10006940static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006941os_geteuid_impl(PyObject *module)
6942/*[clinic end generated code: output=ea1b60f0d6abb66e input=4644c662d3bd9f19]*/
Guido van Rossum46003ff1992-05-15 11:05:24 +00006943{
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006944 return _PyLong_FromUid(geteuid());
Guido van Rossum46003ff1992-05-15 11:05:24 +00006945}
Larry Hastings2f936352014-08-05 14:04:04 +10006946#endif /* HAVE_GETEUID */
Guido van Rossum46003ff1992-05-15 11:05:24 +00006947
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006948
Guido van Rossumad0ee831995-03-01 10:34:45 +00006949#ifdef HAVE_GETGID
Larry Hastings2f936352014-08-05 14:04:04 +10006950/*[clinic input]
6951os.getgid
6952
6953Return the current process's group id.
6954[clinic start generated code]*/
6955
Larry Hastings2f936352014-08-05 14:04:04 +10006956static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006957os_getgid_impl(PyObject *module)
6958/*[clinic end generated code: output=4f28ebc9d3e5dfcf input=58796344cd87c0f6]*/
Guido van Rossum46003ff1992-05-15 11:05:24 +00006959{
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006960 return _PyLong_FromGid(getgid());
Guido van Rossum46003ff1992-05-15 11:05:24 +00006961}
Larry Hastings2f936352014-08-05 14:04:04 +10006962#endif /* HAVE_GETGID */
Guido van Rossum46003ff1992-05-15 11:05:24 +00006963
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006964
Berker Peksag39404992016-09-15 20:45:16 +03006965#ifdef HAVE_GETPID
Larry Hastings2f936352014-08-05 14:04:04 +10006966/*[clinic input]
6967os.getpid
6968
6969Return the current process id.
6970[clinic start generated code]*/
6971
Larry Hastings2f936352014-08-05 14:04:04 +10006972static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006973os_getpid_impl(PyObject *module)
6974/*[clinic end generated code: output=9ea6fdac01ed2b3c input=5a9a00f0ab68aa00]*/
Guido van Rossum85e3b011991-06-03 12:42:10 +00006975{
Victor Stinner8c62be82010-05-06 00:08:46 +00006976 return PyLong_FromPid(getpid());
Guido van Rossum85e3b011991-06-03 12:42:10 +00006977}
Berker Peksag39404992016-09-15 20:45:16 +03006978#endif /* HAVE_GETPID */
Guido van Rossum85e3b011991-06-03 12:42:10 +00006979
Jeffrey Kintscher8725c832019-06-13 00:01:29 -07006980#ifdef NGROUPS_MAX
6981#define MAX_GROUPS NGROUPS_MAX
6982#else
6983 /* defined to be 16 on Solaris7, so this should be a small number */
6984#define MAX_GROUPS 64
6985#endif
6986
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006987#ifdef HAVE_GETGROUPLIST
Larry Hastings2f936352014-08-05 14:04:04 +10006988
Serhiy Storchaka2b560312020-04-18 19:14:10 +03006989#ifdef __APPLE__
6990/*[clinic input]
6991os.getgrouplist
6992
6993 user: str
6994 username to lookup
6995 group as basegid: int
6996 base group id of the user
6997 /
6998
6999Returns a list of groups to which a user belongs.
7000[clinic start generated code]*/
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02007001
7002static PyObject *
Serhiy Storchaka2b560312020-04-18 19:14:10 +03007003os_getgrouplist_impl(PyObject *module, const char *user, int basegid)
7004/*[clinic end generated code: output=6e734697b8c26de0 input=f8d870374b09a490]*/
7005#else
7006/*[clinic input]
7007os.getgrouplist
7008
7009 user: str
7010 username to lookup
7011 group as basegid: gid_t
7012 base group id of the user
7013 /
7014
7015Returns a list of groups to which a user belongs.
7016[clinic start generated code]*/
7017
7018static PyObject *
7019os_getgrouplist_impl(PyObject *module, const char *user, gid_t basegid)
7020/*[clinic end generated code: output=0ebd7fb70115575b input=cc61d5c20b08958d]*/
7021#endif
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02007022{
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02007023 int i, ngroups;
7024 PyObject *list;
7025#ifdef __APPLE__
Serhiy Storchaka2b560312020-04-18 19:14:10 +03007026 int *groups;
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02007027#else
Serhiy Storchaka2b560312020-04-18 19:14:10 +03007028 gid_t *groups;
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02007029#endif
Jeffrey Kintscher8725c832019-06-13 00:01:29 -07007030
7031 /*
7032 * NGROUPS_MAX is defined by POSIX.1 as the maximum
7033 * number of supplimental groups a users can belong to.
7034 * We have to increment it by one because
7035 * getgrouplist() returns both the supplemental groups
7036 * and the primary group, i.e. all of the groups the
7037 * user belongs to.
7038 */
7039 ngroups = 1 + MAX_GROUPS;
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02007040
Victor Stinnerf5c7cab2020-03-24 18:22:10 +01007041 while (1) {
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02007042#ifdef __APPLE__
Victor Stinner8ec73702020-03-23 20:00:57 +01007043 groups = PyMem_New(int, ngroups);
Victor Stinnerf5c7cab2020-03-24 18:22:10 +01007044#else
7045 groups = PyMem_New(gid_t, ngroups);
7046#endif
Victor Stinner8ec73702020-03-23 20:00:57 +01007047 if (groups == NULL) {
7048 return PyErr_NoMemory();
7049 }
Victor Stinnerf5c7cab2020-03-24 18:22:10 +01007050
7051 int old_ngroups = ngroups;
7052 if (getgrouplist(user, basegid, groups, &ngroups) != -1) {
7053 /* Success */
7054 break;
7055 }
7056
7057 /* getgrouplist() fails if the group list is too small */
7058 PyMem_Free(groups);
7059
7060 if (ngroups > old_ngroups) {
7061 /* If the group list is too small, the glibc implementation of
7062 getgrouplist() sets ngroups to the total number of groups and
7063 returns -1. */
7064 }
7065 else {
7066 /* Double the group list size */
7067 if (ngroups > INT_MAX / 2) {
7068 return PyErr_NoMemory();
7069 }
7070 ngroups *= 2;
7071 }
7072
7073 /* Retry getgrouplist() with a larger group list */
Victor Stinner8ec73702020-03-23 20:00:57 +01007074 }
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02007075
Gregory P. Smith1d300ce2018-12-30 21:13:02 -08007076#ifdef _Py_MEMORY_SANITIZER
7077 /* Clang memory sanitizer libc intercepts don't know getgrouplist. */
7078 __msan_unpoison(&ngroups, sizeof(ngroups));
7079 __msan_unpoison(groups, ngroups*sizeof(*groups));
7080#endif
7081
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02007082 list = PyList_New(ngroups);
7083 if (list == NULL) {
7084 PyMem_Del(groups);
7085 return NULL;
7086 }
7087
7088 for (i = 0; i < ngroups; i++) {
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02007089#ifdef __APPLE__
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02007090 PyObject *o = PyLong_FromUnsignedLong((unsigned long)groups[i]);
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02007091#else
7092 PyObject *o = _PyLong_FromGid(groups[i]);
7093#endif
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02007094 if (o == NULL) {
7095 Py_DECREF(list);
7096 PyMem_Del(groups);
7097 return NULL;
7098 }
7099 PyList_SET_ITEM(list, i, o);
7100 }
7101
7102 PyMem_Del(groups);
7103
7104 return list;
7105}
Larry Hastings2f936352014-08-05 14:04:04 +10007106#endif /* HAVE_GETGROUPLIST */
7107
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007108
Fred Drakec9680921999-12-13 16:37:25 +00007109#ifdef HAVE_GETGROUPS
Larry Hastings2f936352014-08-05 14:04:04 +10007110/*[clinic input]
7111os.getgroups
7112
7113Return list of supplemental group IDs for the process.
7114[clinic start generated code]*/
7115
Larry Hastings2f936352014-08-05 14:04:04 +10007116static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007117os_getgroups_impl(PyObject *module)
7118/*[clinic end generated code: output=42b0c17758561b56 input=d3f109412e6a155c]*/
Fred Drakec9680921999-12-13 16:37:25 +00007119{
7120 PyObject *result = NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00007121 gid_t grouplist[MAX_GROUPS];
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00007122
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00007123 /* On MacOSX getgroups(2) can return more than MAX_GROUPS results
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00007124 * This is a helper variable to store the intermediate result when
7125 * that happens.
7126 *
7127 * To keep the code readable the OSX behaviour is unconditional,
7128 * according to the POSIX spec this should be safe on all unix-y
7129 * systems.
7130 */
7131 gid_t* alt_grouplist = grouplist;
Victor Stinner8c62be82010-05-06 00:08:46 +00007132 int n;
Fred Drakec9680921999-12-13 16:37:25 +00007133
Ned Deilyb5dd6d22013-08-01 21:21:15 -07007134#ifdef __APPLE__
7135 /* Issue #17557: As of OS X 10.8, getgroups(2) no longer raises EINVAL if
7136 * there are more groups than can fit in grouplist. Therefore, on OS X
7137 * always first call getgroups with length 0 to get the actual number
7138 * of groups.
7139 */
7140 n = getgroups(0, NULL);
7141 if (n < 0) {
7142 return posix_error();
7143 } else if (n <= MAX_GROUPS) {
7144 /* groups will fit in existing array */
7145 alt_grouplist = grouplist;
7146 } else {
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02007147 alt_grouplist = PyMem_New(gid_t, n);
Ned Deilyb5dd6d22013-08-01 21:21:15 -07007148 if (alt_grouplist == NULL) {
Zackery Spytz4c49da02018-12-07 03:11:30 -07007149 return PyErr_NoMemory();
Ned Deilyb5dd6d22013-08-01 21:21:15 -07007150 }
7151 }
7152
7153 n = getgroups(n, alt_grouplist);
7154 if (n == -1) {
7155 if (alt_grouplist != grouplist) {
7156 PyMem_Free(alt_grouplist);
7157 }
7158 return posix_error();
7159 }
7160#else
Victor Stinner8c62be82010-05-06 00:08:46 +00007161 n = getgroups(MAX_GROUPS, grouplist);
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00007162 if (n < 0) {
7163 if (errno == EINVAL) {
7164 n = getgroups(0, NULL);
7165 if (n == -1) {
7166 return posix_error();
7167 }
7168 if (n == 0) {
7169 /* Avoid malloc(0) */
7170 alt_grouplist = grouplist;
7171 } else {
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02007172 alt_grouplist = PyMem_New(gid_t, n);
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00007173 if (alt_grouplist == NULL) {
Zackery Spytz4c49da02018-12-07 03:11:30 -07007174 return PyErr_NoMemory();
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00007175 }
7176 n = getgroups(n, alt_grouplist);
7177 if (n == -1) {
7178 PyMem_Free(alt_grouplist);
7179 return posix_error();
7180 }
7181 }
7182 } else {
7183 return posix_error();
7184 }
7185 }
Ned Deilyb5dd6d22013-08-01 21:21:15 -07007186#endif
7187
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00007188 result = PyList_New(n);
7189 if (result != NULL) {
Victor Stinner8c62be82010-05-06 00:08:46 +00007190 int i;
7191 for (i = 0; i < n; ++i) {
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02007192 PyObject *o = _PyLong_FromGid(alt_grouplist[i]);
Victor Stinner8c62be82010-05-06 00:08:46 +00007193 if (o == NULL) {
Stefan Krah0e803b32010-11-26 16:16:47 +00007194 Py_DECREF(result);
7195 result = NULL;
7196 break;
Fred Drakec9680921999-12-13 16:37:25 +00007197 }
Victor Stinner8c62be82010-05-06 00:08:46 +00007198 PyList_SET_ITEM(result, i, o);
Fred Drakec9680921999-12-13 16:37:25 +00007199 }
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00007200 }
7201
7202 if (alt_grouplist != grouplist) {
7203 PyMem_Free(alt_grouplist);
Victor Stinner8c62be82010-05-06 00:08:46 +00007204 }
Neal Norwitze241ce82003-02-17 18:17:05 +00007205
Fred Drakec9680921999-12-13 16:37:25 +00007206 return result;
7207}
Larry Hastings2f936352014-08-05 14:04:04 +10007208#endif /* HAVE_GETGROUPS */
Fred Drakec9680921999-12-13 16:37:25 +00007209
Antoine Pitroub7572f02009-12-02 20:46:48 +00007210#ifdef HAVE_INITGROUPS
Serhiy Storchaka2b560312020-04-18 19:14:10 +03007211#ifdef __APPLE__
7212/*[clinic input]
7213os.initgroups
Antoine Pitroub7572f02009-12-02 20:46:48 +00007214
Serhiy Storchaka2b560312020-04-18 19:14:10 +03007215 username as oname: FSConverter
7216 gid: int
7217 /
7218
7219Initialize the group access list.
7220
7221Call the system initgroups() to initialize the group access list with all of
7222the groups of which the specified username is a member, plus the specified
7223group id.
7224[clinic start generated code]*/
7225
Antoine Pitroub7572f02009-12-02 20:46:48 +00007226static PyObject *
Serhiy Storchaka2b560312020-04-18 19:14:10 +03007227os_initgroups_impl(PyObject *module, PyObject *oname, int gid)
7228/*[clinic end generated code: output=7f074d30a425fd3a input=df3d54331b0af204]*/
7229#else
7230/*[clinic input]
7231os.initgroups
7232
7233 username as oname: FSConverter
7234 gid: gid_t
7235 /
7236
7237Initialize the group access list.
7238
7239Call the system initgroups() to initialize the group access list with all of
7240the groups of which the specified username is a member, plus the specified
7241group id.
7242[clinic start generated code]*/
7243
7244static PyObject *
7245os_initgroups_impl(PyObject *module, PyObject *oname, gid_t gid)
7246/*[clinic end generated code: output=59341244521a9e3f input=0cb91bdc59a4c564]*/
7247#endif
Antoine Pitroub7572f02009-12-02 20:46:48 +00007248{
Serhiy Storchaka2b560312020-04-18 19:14:10 +03007249 const char *username = PyBytes_AS_STRING(oname);
Antoine Pitroub7572f02009-12-02 20:46:48 +00007250
Serhiy Storchaka2b560312020-04-18 19:14:10 +03007251 if (initgroups(username, gid) == -1)
Victor Stinner8c62be82010-05-06 00:08:46 +00007252 return PyErr_SetFromErrno(PyExc_OSError);
Antoine Pitroub7572f02009-12-02 20:46:48 +00007253
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02007254 Py_RETURN_NONE;
Antoine Pitroub7572f02009-12-02 20:46:48 +00007255}
Larry Hastings2f936352014-08-05 14:04:04 +10007256#endif /* HAVE_INITGROUPS */
7257
Antoine Pitroub7572f02009-12-02 20:46:48 +00007258
Martin v. Löwis606edc12002-06-13 21:09:11 +00007259#ifdef HAVE_GETPGID
Larry Hastings2f936352014-08-05 14:04:04 +10007260/*[clinic input]
7261os.getpgid
7262
7263 pid: pid_t
7264
7265Call the system call getpgid(), and return the result.
7266[clinic start generated code]*/
7267
Larry Hastings2f936352014-08-05 14:04:04 +10007268static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007269os_getpgid_impl(PyObject *module, pid_t pid)
7270/*[clinic end generated code: output=1db95a97be205d18 input=39d710ae3baaf1c7]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007271{
7272 pid_t pgid = getpgid(pid);
Victor Stinner8c62be82010-05-06 00:08:46 +00007273 if (pgid < 0)
7274 return posix_error();
7275 return PyLong_FromPid(pgid);
Martin v. Löwis606edc12002-06-13 21:09:11 +00007276}
7277#endif /* HAVE_GETPGID */
7278
7279
Guido van Rossumb6775db1994-08-01 11:34:53 +00007280#ifdef HAVE_GETPGRP
Larry Hastings2f936352014-08-05 14:04:04 +10007281/*[clinic input]
7282os.getpgrp
7283
7284Return the current process group id.
7285[clinic start generated code]*/
7286
Larry Hastings2f936352014-08-05 14:04:04 +10007287static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007288os_getpgrp_impl(PyObject *module)
7289/*[clinic end generated code: output=c4fc381e51103cf3 input=6846fb2bb9a3705e]*/
Guido van Rossum04814471991-06-04 20:23:49 +00007290{
Guido van Rossumb6775db1994-08-01 11:34:53 +00007291#ifdef GETPGRP_HAVE_ARG
Victor Stinner8c62be82010-05-06 00:08:46 +00007292 return PyLong_FromPid(getpgrp(0));
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00007293#else /* GETPGRP_HAVE_ARG */
Victor Stinner8c62be82010-05-06 00:08:46 +00007294 return PyLong_FromPid(getpgrp());
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00007295#endif /* GETPGRP_HAVE_ARG */
Guido van Rossum04814471991-06-04 20:23:49 +00007296}
Guido van Rossumb6775db1994-08-01 11:34:53 +00007297#endif /* HAVE_GETPGRP */
Guido van Rossum04814471991-06-04 20:23:49 +00007298
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007299
Guido van Rossumb6775db1994-08-01 11:34:53 +00007300#ifdef HAVE_SETPGRP
Larry Hastings2f936352014-08-05 14:04:04 +10007301/*[clinic input]
7302os.setpgrp
7303
7304Make the current process the leader of its process group.
7305[clinic start generated code]*/
7306
Larry Hastings2f936352014-08-05 14:04:04 +10007307static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007308os_setpgrp_impl(PyObject *module)
7309/*[clinic end generated code: output=2554735b0a60f0a0 input=1f0619fcb5731e7e]*/
Guido van Rossumc2670a01992-09-13 20:07:29 +00007310{
Guido van Rossum64933891994-10-20 21:56:42 +00007311#ifdef SETPGRP_HAVE_ARG
Victor Stinner8c62be82010-05-06 00:08:46 +00007312 if (setpgrp(0, 0) < 0)
Guido van Rossum64933891994-10-20 21:56:42 +00007313#else /* SETPGRP_HAVE_ARG */
Victor Stinner8c62be82010-05-06 00:08:46 +00007314 if (setpgrp() < 0)
Guido van Rossum64933891994-10-20 21:56:42 +00007315#endif /* SETPGRP_HAVE_ARG */
Victor Stinner8c62be82010-05-06 00:08:46 +00007316 return posix_error();
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02007317 Py_RETURN_NONE;
Guido van Rossumc2670a01992-09-13 20:07:29 +00007318}
Guido van Rossumb6775db1994-08-01 11:34:53 +00007319#endif /* HAVE_SETPGRP */
7320
Guido van Rossumad0ee831995-03-01 10:34:45 +00007321#ifdef HAVE_GETPPID
Amaury Forgeot d'Arc4b6fdf32010-09-07 21:31:17 +00007322
7323#ifdef MS_WINDOWS
7324#include <tlhelp32.h>
7325
7326static PyObject*
7327win32_getppid()
7328{
7329 HANDLE snapshot;
7330 pid_t mypid;
7331 PyObject* result = NULL;
7332 BOOL have_record;
7333 PROCESSENTRY32 pe;
7334
7335 mypid = getpid(); /* This function never fails */
7336
7337 snapshot = CreateToolhelp32Snapshot(TH32CS_SNAPPROCESS, 0);
7338 if (snapshot == INVALID_HANDLE_VALUE)
7339 return PyErr_SetFromWindowsErr(GetLastError());
7340
7341 pe.dwSize = sizeof(pe);
7342 have_record = Process32First(snapshot, &pe);
7343 while (have_record) {
7344 if (mypid == (pid_t)pe.th32ProcessID) {
7345 /* We could cache the ulong value in a static variable. */
7346 result = PyLong_FromPid((pid_t)pe.th32ParentProcessID);
7347 break;
7348 }
7349
7350 have_record = Process32Next(snapshot, &pe);
7351 }
7352
7353 /* If our loop exits and our pid was not found (result will be NULL)
7354 * then GetLastError will return ERROR_NO_MORE_FILES. This is an
7355 * error anyway, so let's raise it. */
7356 if (!result)
7357 result = PyErr_SetFromWindowsErr(GetLastError());
7358
7359 CloseHandle(snapshot);
7360
7361 return result;
7362}
7363#endif /*MS_WINDOWS*/
7364
Larry Hastings2f936352014-08-05 14:04:04 +10007365
7366/*[clinic input]
7367os.getppid
7368
7369Return the parent's process id.
7370
7371If the parent process has already exited, Windows machines will still
7372return its id; others systems will return the id of the 'init' process (1).
7373[clinic start generated code]*/
7374
Larry Hastings2f936352014-08-05 14:04:04 +10007375static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007376os_getppid_impl(PyObject *module)
7377/*[clinic end generated code: output=43b2a946a8c603b4 input=e637cb87539c030e]*/
Guido van Rossum85e3b011991-06-03 12:42:10 +00007378{
Amaury Forgeot d'Arc4b6fdf32010-09-07 21:31:17 +00007379#ifdef MS_WINDOWS
7380 return win32_getppid();
7381#else
Victor Stinner8c62be82010-05-06 00:08:46 +00007382 return PyLong_FromPid(getppid());
Guido van Rossumad0ee831995-03-01 10:34:45 +00007383#endif
Amaury Forgeot d'Arc4b6fdf32010-09-07 21:31:17 +00007384}
7385#endif /* HAVE_GETPPID */
Guido van Rossum85e3b011991-06-03 12:42:10 +00007386
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007387
Fred Drake12c6e2d1999-12-14 21:25:03 +00007388#ifdef HAVE_GETLOGIN
Larry Hastings2f936352014-08-05 14:04:04 +10007389/*[clinic input]
7390os.getlogin
7391
7392Return the actual login name.
7393[clinic start generated code]*/
7394
Larry Hastings2f936352014-08-05 14:04:04 +10007395static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007396os_getlogin_impl(PyObject *module)
7397/*[clinic end generated code: output=a32e66a7e5715dac input=2a21ab1e917163df]*/
Fred Drake12c6e2d1999-12-14 21:25:03 +00007398{
Victor Stinner8c62be82010-05-06 00:08:46 +00007399 PyObject *result = NULL;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00007400#ifdef MS_WINDOWS
Brian Curtine8e4b3b2010-09-23 20:04:14 +00007401 wchar_t user_name[UNLEN + 1];
Victor Stinner63941882011-09-29 00:42:28 +02007402 DWORD num_chars = Py_ARRAY_LENGTH(user_name);
Brian Curtine8e4b3b2010-09-23 20:04:14 +00007403
7404 if (GetUserNameW(user_name, &num_chars)) {
7405 /* num_chars is the number of unicode chars plus null terminator */
7406 result = PyUnicode_FromWideChar(user_name, num_chars - 1);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00007407 }
7408 else
Brian Curtine8e4b3b2010-09-23 20:04:14 +00007409 result = PyErr_SetFromWindowsErr(GetLastError());
7410#else
Victor Stinner8c62be82010-05-06 00:08:46 +00007411 char *name;
7412 int old_errno = errno;
Fred Drake12c6e2d1999-12-14 21:25:03 +00007413
Victor Stinner8c62be82010-05-06 00:08:46 +00007414 errno = 0;
7415 name = getlogin();
7416 if (name == NULL) {
7417 if (errno)
Victor Stinnere039ffe2010-08-15 09:33:08 +00007418 posix_error();
Fred Drake12c6e2d1999-12-14 21:25:03 +00007419 else
Victor Stinnere039ffe2010-08-15 09:33:08 +00007420 PyErr_SetString(PyExc_OSError, "unable to determine login name");
Victor Stinner8c62be82010-05-06 00:08:46 +00007421 }
7422 else
Victor Stinnere039ffe2010-08-15 09:33:08 +00007423 result = PyUnicode_DecodeFSDefault(name);
Victor Stinner8c62be82010-05-06 00:08:46 +00007424 errno = old_errno;
Brian Curtine8e4b3b2010-09-23 20:04:14 +00007425#endif
Fred Drake12c6e2d1999-12-14 21:25:03 +00007426 return result;
7427}
Brian Curtine8e4b3b2010-09-23 20:04:14 +00007428#endif /* HAVE_GETLOGIN */
Fred Drake12c6e2d1999-12-14 21:25:03 +00007429
Larry Hastings2f936352014-08-05 14:04:04 +10007430
Guido van Rossumad0ee831995-03-01 10:34:45 +00007431#ifdef HAVE_GETUID
Larry Hastings2f936352014-08-05 14:04:04 +10007432/*[clinic input]
7433os.getuid
7434
7435Return the current process's user id.
7436[clinic start generated code]*/
7437
Larry Hastings2f936352014-08-05 14:04:04 +10007438static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007439os_getuid_impl(PyObject *module)
7440/*[clinic end generated code: output=415c0b401ebed11a input=b53c8b35f110a516]*/
Guido van Rossum46003ff1992-05-15 11:05:24 +00007441{
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02007442 return _PyLong_FromUid(getuid());
Guido van Rossum46003ff1992-05-15 11:05:24 +00007443}
Larry Hastings2f936352014-08-05 14:04:04 +10007444#endif /* HAVE_GETUID */
Guido van Rossum46003ff1992-05-15 11:05:24 +00007445
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007446
Brian Curtineb24d742010-04-12 17:16:38 +00007447#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10007448#define HAVE_KILL
7449#endif /* MS_WINDOWS */
7450
7451#ifdef HAVE_KILL
7452/*[clinic input]
7453os.kill
7454
7455 pid: pid_t
7456 signal: Py_ssize_t
7457 /
7458
7459Kill a process with a signal.
7460[clinic start generated code]*/
7461
Larry Hastings2f936352014-08-05 14:04:04 +10007462static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007463os_kill_impl(PyObject *module, pid_t pid, Py_ssize_t signal)
7464/*[clinic end generated code: output=8e346a6701c88568 input=61a36b86ca275ab9]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007465{
Saiyang Gou7514f4f2020-02-12 23:47:42 -08007466 if (PySys_Audit("os.kill", "in", pid, signal) < 0) {
7467 return NULL;
7468 }
7469#ifndef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10007470 if (kill(pid, (int)signal) == -1)
7471 return posix_error();
7472 Py_RETURN_NONE;
Larry Hastings2f936352014-08-05 14:04:04 +10007473#else /* !MS_WINDOWS */
Amaury Forgeot d'Arc0a589c92010-05-15 20:35:12 +00007474 PyObject *result;
Larry Hastings2f936352014-08-05 14:04:04 +10007475 DWORD sig = (DWORD)signal;
7476 DWORD err;
Victor Stinner8c62be82010-05-06 00:08:46 +00007477 HANDLE handle;
Brian Curtineb24d742010-04-12 17:16:38 +00007478
Victor Stinner8c62be82010-05-06 00:08:46 +00007479 /* Console processes which share a common console can be sent CTRL+C or
7480 CTRL+BREAK events, provided they handle said events. */
7481 if (sig == CTRL_C_EVENT || sig == CTRL_BREAK_EVENT) {
Richard Oudkerkac0ad882013-06-05 23:29:30 +01007482 if (GenerateConsoleCtrlEvent(sig, (DWORD)pid) == 0) {
Victor Stinner8c62be82010-05-06 00:08:46 +00007483 err = GetLastError();
7484 PyErr_SetFromWindowsErr(err);
7485 }
7486 else
7487 Py_RETURN_NONE;
7488 }
Brian Curtineb24d742010-04-12 17:16:38 +00007489
Victor Stinner8c62be82010-05-06 00:08:46 +00007490 /* If the signal is outside of what GenerateConsoleCtrlEvent can use,
7491 attempt to open and terminate the process. */
Richard Oudkerkac0ad882013-06-05 23:29:30 +01007492 handle = OpenProcess(PROCESS_ALL_ACCESS, FALSE, (DWORD)pid);
Victor Stinner8c62be82010-05-06 00:08:46 +00007493 if (handle == NULL) {
7494 err = GetLastError();
7495 return PyErr_SetFromWindowsErr(err);
7496 }
Brian Curtineb24d742010-04-12 17:16:38 +00007497
Victor Stinner8c62be82010-05-06 00:08:46 +00007498 if (TerminateProcess(handle, sig) == 0) {
7499 err = GetLastError();
7500 result = PyErr_SetFromWindowsErr(err);
7501 } else {
7502 Py_INCREF(Py_None);
7503 result = Py_None;
7504 }
Brian Curtineb24d742010-04-12 17:16:38 +00007505
Victor Stinner8c62be82010-05-06 00:08:46 +00007506 CloseHandle(handle);
7507 return result;
Larry Hastings2f936352014-08-05 14:04:04 +10007508#endif /* !MS_WINDOWS */
Saiyang Gou7514f4f2020-02-12 23:47:42 -08007509}
Larry Hastings2f936352014-08-05 14:04:04 +10007510#endif /* HAVE_KILL */
7511
7512
7513#ifdef HAVE_KILLPG
7514/*[clinic input]
7515os.killpg
7516
7517 pgid: pid_t
7518 signal: int
7519 /
7520
7521Kill a process group with a signal.
7522[clinic start generated code]*/
7523
Larry Hastings2f936352014-08-05 14:04:04 +10007524static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007525os_killpg_impl(PyObject *module, pid_t pgid, int signal)
7526/*[clinic end generated code: output=6dbcd2f1fdf5fdba input=38b5449eb8faec19]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007527{
Saiyang Gou7514f4f2020-02-12 23:47:42 -08007528 if (PySys_Audit("os.killpg", "ii", pgid, signal) < 0) {
7529 return NULL;
7530 }
Larry Hastings2f936352014-08-05 14:04:04 +10007531 /* XXX some man pages make the `pgid` parameter an int, others
7532 a pid_t. Since getpgrp() returns a pid_t, we assume killpg should
7533 take the same type. Moreover, pid_t is always at least as wide as
7534 int (else compilation of this module fails), which is safe. */
7535 if (killpg(pgid, signal) == -1)
7536 return posix_error();
7537 Py_RETURN_NONE;
7538}
7539#endif /* HAVE_KILLPG */
7540
Brian Curtineb24d742010-04-12 17:16:38 +00007541
Guido van Rossumc0125471996-06-28 18:55:32 +00007542#ifdef HAVE_PLOCK
Guido van Rossumc0125471996-06-28 18:55:32 +00007543#ifdef HAVE_SYS_LOCK_H
7544#include <sys/lock.h>
7545#endif
7546
Larry Hastings2f936352014-08-05 14:04:04 +10007547/*[clinic input]
7548os.plock
7549 op: int
7550 /
7551
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00007552Lock program segments into memory.");
Larry Hastings2f936352014-08-05 14:04:04 +10007553[clinic start generated code]*/
7554
Larry Hastings2f936352014-08-05 14:04:04 +10007555static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007556os_plock_impl(PyObject *module, int op)
7557/*[clinic end generated code: output=81424167033b168e input=e6e5e348e1525f60]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007558{
Victor Stinner8c62be82010-05-06 00:08:46 +00007559 if (plock(op) == -1)
7560 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007561 Py_RETURN_NONE;
Guido van Rossumc0125471996-06-28 18:55:32 +00007562}
Larry Hastings2f936352014-08-05 14:04:04 +10007563#endif /* HAVE_PLOCK */
7564
Guido van Rossumc0125471996-06-28 18:55:32 +00007565
Guido van Rossumb6775db1994-08-01 11:34:53 +00007566#ifdef HAVE_SETUID
Larry Hastings2f936352014-08-05 14:04:04 +10007567/*[clinic input]
7568os.setuid
7569
7570 uid: uid_t
7571 /
7572
7573Set the current process's user id.
7574[clinic start generated code]*/
7575
Larry Hastings2f936352014-08-05 14:04:04 +10007576static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007577os_setuid_impl(PyObject *module, uid_t uid)
7578/*[clinic end generated code: output=a0a41fd0d1ec555f input=c921a3285aa22256]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007579{
Victor Stinner8c62be82010-05-06 00:08:46 +00007580 if (setuid(uid) < 0)
7581 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007582 Py_RETURN_NONE;
Guido van Rossuma3d78fb1993-11-10 09:23:53 +00007583}
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00007584#endif /* HAVE_SETUID */
Guido van Rossuma3d78fb1993-11-10 09:23:53 +00007585
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007586
Andrew M. Kuchling8d2f2b22000-07-13 01:26:58 +00007587#ifdef HAVE_SETEUID
Larry Hastings2f936352014-08-05 14:04:04 +10007588/*[clinic input]
7589os.seteuid
7590
7591 euid: uid_t
7592 /
7593
7594Set the current process's effective user id.
7595[clinic start generated code]*/
7596
Larry Hastings2f936352014-08-05 14:04:04 +10007597static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007598os_seteuid_impl(PyObject *module, uid_t euid)
7599/*[clinic end generated code: output=102e3ad98361519a input=ba93d927e4781aa9]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007600{
7601 if (seteuid(euid) < 0)
Victor Stinner8c62be82010-05-06 00:08:46 +00007602 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007603 Py_RETURN_NONE;
Andrew M. Kuchling8d2f2b22000-07-13 01:26:58 +00007604}
7605#endif /* HAVE_SETEUID */
7606
Larry Hastings2f936352014-08-05 14:04:04 +10007607
Andrew M. Kuchling8d2f2b22000-07-13 01:26:58 +00007608#ifdef HAVE_SETEGID
Larry Hastings2f936352014-08-05 14:04:04 +10007609/*[clinic input]
7610os.setegid
7611
7612 egid: gid_t
7613 /
7614
7615Set the current process's effective group id.
7616[clinic start generated code]*/
7617
Larry Hastings2f936352014-08-05 14:04:04 +10007618static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007619os_setegid_impl(PyObject *module, gid_t egid)
7620/*[clinic end generated code: output=4e4b825a6a10258d input=4080526d0ccd6ce3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007621{
7622 if (setegid(egid) < 0)
Victor Stinner8c62be82010-05-06 00:08:46 +00007623 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007624 Py_RETURN_NONE;
Andrew M. Kuchling8d2f2b22000-07-13 01:26:58 +00007625}
7626#endif /* HAVE_SETEGID */
7627
Larry Hastings2f936352014-08-05 14:04:04 +10007628
Andrew M. Kuchling8d2f2b22000-07-13 01:26:58 +00007629#ifdef HAVE_SETREUID
Larry Hastings2f936352014-08-05 14:04:04 +10007630/*[clinic input]
7631os.setreuid
7632
7633 ruid: uid_t
7634 euid: uid_t
7635 /
7636
7637Set the current process's real and effective user ids.
7638[clinic start generated code]*/
7639
Larry Hastings2f936352014-08-05 14:04:04 +10007640static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007641os_setreuid_impl(PyObject *module, uid_t ruid, uid_t euid)
7642/*[clinic end generated code: output=62d991210006530a input=0ca8978de663880c]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007643{
Victor Stinner8c62be82010-05-06 00:08:46 +00007644 if (setreuid(ruid, euid) < 0) {
7645 return posix_error();
7646 } else {
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02007647 Py_RETURN_NONE;
Victor Stinner8c62be82010-05-06 00:08:46 +00007648 }
Andrew M. Kuchling8d2f2b22000-07-13 01:26:58 +00007649}
7650#endif /* HAVE_SETREUID */
7651
Larry Hastings2f936352014-08-05 14:04:04 +10007652
Andrew M. Kuchling8d2f2b22000-07-13 01:26:58 +00007653#ifdef HAVE_SETREGID
Larry Hastings2f936352014-08-05 14:04:04 +10007654/*[clinic input]
7655os.setregid
7656
7657 rgid: gid_t
7658 egid: gid_t
7659 /
7660
7661Set the current process's real and effective group ids.
7662[clinic start generated code]*/
7663
Larry Hastings2f936352014-08-05 14:04:04 +10007664static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007665os_setregid_impl(PyObject *module, gid_t rgid, gid_t egid)
7666/*[clinic end generated code: output=aa803835cf5342f3 input=c59499f72846db78]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007667{
7668 if (setregid(rgid, egid) < 0)
Victor Stinner8c62be82010-05-06 00:08:46 +00007669 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007670 Py_RETURN_NONE;
Andrew M. Kuchling8d2f2b22000-07-13 01:26:58 +00007671}
7672#endif /* HAVE_SETREGID */
7673
Larry Hastings2f936352014-08-05 14:04:04 +10007674
Guido van Rossumb6775db1994-08-01 11:34:53 +00007675#ifdef HAVE_SETGID
Larry Hastings2f936352014-08-05 14:04:04 +10007676/*[clinic input]
7677os.setgid
7678 gid: gid_t
7679 /
7680
7681Set the current process's group id.
7682[clinic start generated code]*/
7683
Larry Hastings2f936352014-08-05 14:04:04 +10007684static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007685os_setgid_impl(PyObject *module, gid_t gid)
7686/*[clinic end generated code: output=bdccd7403f6ad8c3 input=27d30c4059045dc6]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007687{
Victor Stinner8c62be82010-05-06 00:08:46 +00007688 if (setgid(gid) < 0)
7689 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007690 Py_RETURN_NONE;
Guido van Rossuma3d78fb1993-11-10 09:23:53 +00007691}
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00007692#endif /* HAVE_SETGID */
Guido van Rossuma3d78fb1993-11-10 09:23:53 +00007693
Larry Hastings2f936352014-08-05 14:04:04 +10007694
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00007695#ifdef HAVE_SETGROUPS
Larry Hastings2f936352014-08-05 14:04:04 +10007696/*[clinic input]
7697os.setgroups
7698
7699 groups: object
7700 /
7701
7702Set the groups of the current process to list.
7703[clinic start generated code]*/
7704
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00007705static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007706os_setgroups(PyObject *module, PyObject *groups)
7707/*[clinic end generated code: output=3fcb32aad58c5ecd input=fa742ca3daf85a7e]*/
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00007708{
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03007709 Py_ssize_t i, len;
Victor Stinner8c62be82010-05-06 00:08:46 +00007710 gid_t grouplist[MAX_GROUPS];
Tim Peters5aa91602002-01-30 05:46:57 +00007711
Victor Stinner8c62be82010-05-06 00:08:46 +00007712 if (!PySequence_Check(groups)) {
7713 PyErr_SetString(PyExc_TypeError, "setgroups argument must be a sequence");
7714 return NULL;
7715 }
7716 len = PySequence_Size(groups);
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03007717 if (len < 0) {
7718 return NULL;
7719 }
Victor Stinner8c62be82010-05-06 00:08:46 +00007720 if (len > MAX_GROUPS) {
7721 PyErr_SetString(PyExc_ValueError, "too many groups");
7722 return NULL;
7723 }
7724 for(i = 0; i < len; i++) {
7725 PyObject *elem;
7726 elem = PySequence_GetItem(groups, i);
7727 if (!elem)
7728 return NULL;
7729 if (!PyLong_Check(elem)) {
7730 PyErr_SetString(PyExc_TypeError,
7731 "groups must be integers");
7732 Py_DECREF(elem);
7733 return NULL;
7734 } else {
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02007735 if (!_Py_Gid_Converter(elem, &grouplist[i])) {
Victor Stinner8c62be82010-05-06 00:08:46 +00007736 Py_DECREF(elem);
7737 return NULL;
7738 }
7739 }
7740 Py_DECREF(elem);
7741 }
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00007742
Victor Stinner8c62be82010-05-06 00:08:46 +00007743 if (setgroups(len, grouplist) < 0)
7744 return posix_error();
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02007745 Py_RETURN_NONE;
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00007746}
7747#endif /* HAVE_SETGROUPS */
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007748
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007749#if defined(HAVE_WAIT3) || defined(HAVE_WAIT4)
7750static PyObject *
Victor Stinner1c2fa782020-05-10 11:05:29 +02007751wait_helper(PyObject *module, pid_t pid, int status, struct rusage *ru)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007752{
Victor Stinner8c62be82010-05-06 00:08:46 +00007753 PyObject *result;
Eddie Elizondob3966632019-11-05 07:16:14 -08007754 PyObject *struct_rusage;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007755
Victor Stinner8c62be82010-05-06 00:08:46 +00007756 if (pid == -1)
7757 return posix_error();
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007758
Zackery Spytz682107c2019-09-09 09:48:32 -06007759 // If wait succeeded but no child was ready to report status, ru will not
7760 // have been populated.
7761 if (pid == 0) {
7762 memset(ru, 0, sizeof(*ru));
7763 }
7764
Eddie Elizondob3966632019-11-05 07:16:14 -08007765 PyObject *m = PyImport_ImportModuleNoBlock("resource");
7766 if (m == NULL)
7767 return NULL;
Victor Stinner1c2fa782020-05-10 11:05:29 +02007768 struct_rusage = PyObject_GetAttr(m, get_posix_state(module)->struct_rusage);
Eddie Elizondob3966632019-11-05 07:16:14 -08007769 Py_DECREF(m);
7770 if (struct_rusage == NULL)
7771 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007772
Victor Stinner8c62be82010-05-06 00:08:46 +00007773 /* XXX(nnorwitz): Copied (w/mods) from resource.c, there should be only one. */
7774 result = PyStructSequence_New((PyTypeObject*) struct_rusage);
Eddie Elizondoe4db1f02019-11-25 19:07:37 -08007775 Py_DECREF(struct_rusage);
Victor Stinner8c62be82010-05-06 00:08:46 +00007776 if (!result)
7777 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007778
7779#ifndef doubletime
7780#define doubletime(TV) ((double)(TV).tv_sec + (TV).tv_usec * 0.000001)
7781#endif
7782
Victor Stinner8c62be82010-05-06 00:08:46 +00007783 PyStructSequence_SET_ITEM(result, 0,
Victor Stinner4195b5c2012-02-08 23:03:19 +01007784 PyFloat_FromDouble(doubletime(ru->ru_utime)));
Victor Stinner8c62be82010-05-06 00:08:46 +00007785 PyStructSequence_SET_ITEM(result, 1,
Victor Stinner4195b5c2012-02-08 23:03:19 +01007786 PyFloat_FromDouble(doubletime(ru->ru_stime)));
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007787#define SET_INT(result, index, value)\
Victor Stinner8c62be82010-05-06 00:08:46 +00007788 PyStructSequence_SET_ITEM(result, index, PyLong_FromLong(value))
7789 SET_INT(result, 2, ru->ru_maxrss);
7790 SET_INT(result, 3, ru->ru_ixrss);
7791 SET_INT(result, 4, ru->ru_idrss);
7792 SET_INT(result, 5, ru->ru_isrss);
7793 SET_INT(result, 6, ru->ru_minflt);
7794 SET_INT(result, 7, ru->ru_majflt);
7795 SET_INT(result, 8, ru->ru_nswap);
7796 SET_INT(result, 9, ru->ru_inblock);
7797 SET_INT(result, 10, ru->ru_oublock);
7798 SET_INT(result, 11, ru->ru_msgsnd);
7799 SET_INT(result, 12, ru->ru_msgrcv);
7800 SET_INT(result, 13, ru->ru_nsignals);
7801 SET_INT(result, 14, ru->ru_nvcsw);
7802 SET_INT(result, 15, ru->ru_nivcsw);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007803#undef SET_INT
7804
Victor Stinner8c62be82010-05-06 00:08:46 +00007805 if (PyErr_Occurred()) {
7806 Py_DECREF(result);
7807 return NULL;
7808 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007809
Victor Stinner8c62be82010-05-06 00:08:46 +00007810 return Py_BuildValue("NiN", PyLong_FromPid(pid), status, result);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007811}
7812#endif /* HAVE_WAIT3 || HAVE_WAIT4 */
7813
Larry Hastings2f936352014-08-05 14:04:04 +10007814
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007815#ifdef HAVE_WAIT3
Larry Hastings2f936352014-08-05 14:04:04 +10007816/*[clinic input]
7817os.wait3
7818
7819 options: int
7820Wait for completion of a child process.
7821
7822Returns a tuple of information about the child process:
7823 (pid, status, rusage)
7824[clinic start generated code]*/
7825
Larry Hastings2f936352014-08-05 14:04:04 +10007826static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007827os_wait3_impl(PyObject *module, int options)
7828/*[clinic end generated code: output=92c3224e6f28217a input=8ac4c56956b61710]*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007829{
Victor Stinner8c62be82010-05-06 00:08:46 +00007830 pid_t pid;
Victor Stinner8c62be82010-05-06 00:08:46 +00007831 struct rusage ru;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007832 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00007833 WAIT_TYPE status;
7834 WAIT_STATUS_INT(status) = 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007835
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007836 do {
7837 Py_BEGIN_ALLOW_THREADS
7838 pid = wait3(&status, options, &ru);
7839 Py_END_ALLOW_THREADS
7840 } while (pid < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
7841 if (pid < 0)
7842 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007843
Victor Stinner1c2fa782020-05-10 11:05:29 +02007844 return wait_helper(module, pid, WAIT_STATUS_INT(status), &ru);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007845}
7846#endif /* HAVE_WAIT3 */
7847
Larry Hastings2f936352014-08-05 14:04:04 +10007848
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007849#ifdef HAVE_WAIT4
Larry Hastings2f936352014-08-05 14:04:04 +10007850/*[clinic input]
7851
7852os.wait4
7853
7854 pid: pid_t
7855 options: int
7856
7857Wait for completion of a specific child process.
7858
7859Returns a tuple of information about the child process:
7860 (pid, status, rusage)
7861[clinic start generated code]*/
7862
Larry Hastings2f936352014-08-05 14:04:04 +10007863static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007864os_wait4_impl(PyObject *module, pid_t pid, int options)
7865/*[clinic end generated code: output=66195aa507b35f70 input=d11deed0750600ba]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007866{
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007867 pid_t res;
Victor Stinner8c62be82010-05-06 00:08:46 +00007868 struct rusage ru;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007869 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00007870 WAIT_TYPE status;
7871 WAIT_STATUS_INT(status) = 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007872
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007873 do {
7874 Py_BEGIN_ALLOW_THREADS
7875 res = wait4(pid, &status, options, &ru);
7876 Py_END_ALLOW_THREADS
7877 } while (res < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
7878 if (res < 0)
7879 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007880
Victor Stinner1c2fa782020-05-10 11:05:29 +02007881 return wait_helper(module, res, WAIT_STATUS_INT(status), &ru);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007882}
7883#endif /* HAVE_WAIT4 */
7884
Larry Hastings2f936352014-08-05 14:04:04 +10007885
Ross Lagerwall7807c352011-03-17 20:20:30 +02007886#if defined(HAVE_WAITID) && !defined(__APPLE__)
Larry Hastings2f936352014-08-05 14:04:04 +10007887/*[clinic input]
7888os.waitid
7889
7890 idtype: idtype_t
7891 Must be one of be P_PID, P_PGID or P_ALL.
7892 id: id_t
7893 The id to wait on.
7894 options: int
7895 Constructed from the ORing of one or more of WEXITED, WSTOPPED
7896 or WCONTINUED and additionally may be ORed with WNOHANG or WNOWAIT.
7897 /
7898
7899Returns the result of waiting for a process or processes.
7900
7901Returns either waitid_result or None if WNOHANG is specified and there are
7902no children in a waitable state.
7903[clinic start generated code]*/
7904
Larry Hastings2f936352014-08-05 14:04:04 +10007905static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007906os_waitid_impl(PyObject *module, idtype_t idtype, id_t id, int options)
7907/*[clinic end generated code: output=5d2e1c0bde61f4d8 input=d8e7f76e052b7920]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007908{
7909 PyObject *result;
7910 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007911 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02007912 siginfo_t si;
7913 si.si_pid = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10007914
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007915 do {
7916 Py_BEGIN_ALLOW_THREADS
7917 res = waitid(idtype, id, &si, options);
7918 Py_END_ALLOW_THREADS
7919 } while (res < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
7920 if (res < 0)
7921 return (!async_err) ? posix_error() : NULL;
Ross Lagerwall7807c352011-03-17 20:20:30 +02007922
7923 if (si.si_pid == 0)
7924 Py_RETURN_NONE;
7925
Hai Shif707d942020-03-16 21:15:01 +08007926 PyObject *WaitidResultType = get_posix_state(module)->WaitidResultType;
Eddie Elizondob3966632019-11-05 07:16:14 -08007927 result = PyStructSequence_New((PyTypeObject *)WaitidResultType);
Ross Lagerwall7807c352011-03-17 20:20:30 +02007928 if (!result)
7929 return NULL;
7930
7931 PyStructSequence_SET_ITEM(result, 0, PyLong_FromPid(si.si_pid));
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02007932 PyStructSequence_SET_ITEM(result, 1, _PyLong_FromUid(si.si_uid));
Ross Lagerwall7807c352011-03-17 20:20:30 +02007933 PyStructSequence_SET_ITEM(result, 2, PyLong_FromLong((long)(si.si_signo)));
7934 PyStructSequence_SET_ITEM(result, 3, PyLong_FromLong((long)(si.si_status)));
7935 PyStructSequence_SET_ITEM(result, 4, PyLong_FromLong((long)(si.si_code)));
7936 if (PyErr_Occurred()) {
7937 Py_DECREF(result);
7938 return NULL;
7939 }
7940
7941 return result;
7942}
Larry Hastings2f936352014-08-05 14:04:04 +10007943#endif /* defined(HAVE_WAITID) && !defined(__APPLE__) */
Ross Lagerwall7807c352011-03-17 20:20:30 +02007944
Larry Hastings2f936352014-08-05 14:04:04 +10007945
7946#if defined(HAVE_WAITPID)
7947/*[clinic input]
7948os.waitpid
7949 pid: pid_t
7950 options: int
7951 /
7952
7953Wait for completion of a given child process.
7954
7955Returns a tuple of information regarding the child process:
7956 (pid, status)
7957
7958The options argument is ignored on Windows.
7959[clinic start generated code]*/
7960
Larry Hastings2f936352014-08-05 14:04:04 +10007961static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007962os_waitpid_impl(PyObject *module, pid_t pid, int options)
7963/*[clinic end generated code: output=5c37c06887a20270 input=0bf1666b8758fda3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007964{
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007965 pid_t res;
7966 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00007967 WAIT_TYPE status;
7968 WAIT_STATUS_INT(status) = 0;
Guido van Rossum54ecc3d1999-01-27 17:53:11 +00007969
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007970 do {
7971 Py_BEGIN_ALLOW_THREADS
7972 res = waitpid(pid, &status, options);
7973 Py_END_ALLOW_THREADS
7974 } while (res < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
7975 if (res < 0)
7976 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007977
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007978 return Py_BuildValue("Ni", PyLong_FromPid(res), WAIT_STATUS_INT(status));
Guido van Rossum21803b81992-08-09 12:55:27 +00007979}
Tim Petersab034fa2002-02-01 11:27:43 +00007980#elif defined(HAVE_CWAIT)
Tim Petersab034fa2002-02-01 11:27:43 +00007981/* MS C has a variant of waitpid() that's usable for most purposes. */
Larry Hastings2f936352014-08-05 14:04:04 +10007982/*[clinic input]
7983os.waitpid
Benjamin Petersonca470632016-09-06 13:47:26 -07007984 pid: intptr_t
Larry Hastings2f936352014-08-05 14:04:04 +10007985 options: int
7986 /
7987
7988Wait for completion of a given process.
7989
7990Returns a tuple of information regarding the process:
7991 (pid, status << 8)
7992
7993The options argument is ignored on Windows.
7994[clinic start generated code]*/
7995
Larry Hastings2f936352014-08-05 14:04:04 +10007996static PyObject *
Benjamin Petersonca470632016-09-06 13:47:26 -07007997os_waitpid_impl(PyObject *module, intptr_t pid, int options)
Victor Stinner581139c2016-09-06 15:54:20 -07007998/*[clinic end generated code: output=be836b221271d538 input=40f2440c515410f8]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007999{
8000 int status;
Benjamin Petersonca470632016-09-06 13:47:26 -07008001 intptr_t res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008002 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10008003
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008004 do {
8005 Py_BEGIN_ALLOW_THREADS
Steve Dower11f43262016-11-19 18:33:39 -08008006 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008007 res = _cwait(&status, pid, options);
Steve Dower11f43262016-11-19 18:33:39 -08008008 _Py_END_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008009 Py_END_ALLOW_THREADS
8010 } while (res < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Victor Stinnerd3ffd322015-09-15 10:11:03 +02008011 if (res < 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008012 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00008013
Victor Stinner9bee32b2020-04-22 16:30:35 +02008014 unsigned long long ustatus = (unsigned int)status;
8015
Victor Stinner8c62be82010-05-06 00:08:46 +00008016 /* shift the status left a byte so this is more like the POSIX waitpid */
Victor Stinner9bee32b2020-04-22 16:30:35 +02008017 return Py_BuildValue(_Py_PARSE_INTPTR "K", res, ustatus << 8);
Tim Petersab034fa2002-02-01 11:27:43 +00008018}
Larry Hastings2f936352014-08-05 14:04:04 +10008019#endif
8020
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008021
Guido van Rossumad0ee831995-03-01 10:34:45 +00008022#ifdef HAVE_WAIT
Larry Hastings2f936352014-08-05 14:04:04 +10008023/*[clinic input]
8024os.wait
8025
8026Wait for completion of a child process.
8027
8028Returns a tuple of information about the child process:
8029 (pid, status)
8030[clinic start generated code]*/
8031
Larry Hastings2f936352014-08-05 14:04:04 +10008032static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008033os_wait_impl(PyObject *module)
8034/*[clinic end generated code: output=6bc419ac32fb364b input=03b0182d4a4700ce]*/
Guido van Rossum21803b81992-08-09 12:55:27 +00008035{
Victor Stinner8c62be82010-05-06 00:08:46 +00008036 pid_t pid;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008037 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00008038 WAIT_TYPE status;
8039 WAIT_STATUS_INT(status) = 0;
Neal Norwitze241ce82003-02-17 18:17:05 +00008040
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008041 do {
8042 Py_BEGIN_ALLOW_THREADS
8043 pid = wait(&status);
8044 Py_END_ALLOW_THREADS
8045 } while (pid < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
8046 if (pid < 0)
8047 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00008048
Victor Stinner8c62be82010-05-06 00:08:46 +00008049 return Py_BuildValue("Ni", PyLong_FromPid(pid), WAIT_STATUS_INT(status));
Guido van Rossum85e3b011991-06-03 12:42:10 +00008050}
Larry Hastings2f936352014-08-05 14:04:04 +10008051#endif /* HAVE_WAIT */
Guido van Rossum85e3b011991-06-03 12:42:10 +00008052
Benjamin Peterson6c4c45e2019-11-05 19:21:29 -08008053#if defined(__linux__) && defined(__NR_pidfd_open)
8054/*[clinic input]
8055os.pidfd_open
8056 pid: pid_t
8057 flags: unsigned_int = 0
8058
8059Return a file descriptor referring to the process *pid*.
8060
8061The descriptor can be used to perform process management without races and
8062signals.
8063[clinic start generated code]*/
8064
8065static PyObject *
8066os_pidfd_open_impl(PyObject *module, pid_t pid, unsigned int flags)
8067/*[clinic end generated code: output=5c7252698947dc41 input=c3fd99ce947ccfef]*/
8068{
8069 int fd = syscall(__NR_pidfd_open, pid, flags);
8070 if (fd < 0) {
8071 return posix_error();
8072 }
8073 return PyLong_FromLong(fd);
8074}
8075#endif
8076
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008077
Larry Hastings9cf065c2012-06-22 16:30:09 -07008078#if defined(HAVE_READLINK) || defined(MS_WINDOWS)
Serhiy Storchaka12a69db2018-09-17 15:38:27 +03008079/*[clinic input]
8080os.readlink
8081
8082 path: path_t
8083 *
8084 dir_fd: dir_fd(requires='readlinkat') = None
8085
8086Return a string representing the path to which the symbolic link points.
8087
8088If dir_fd is not None, it should be a file descriptor open to a directory,
8089and path should be relative; path will then be relative to that directory.
8090
8091dir_fd may not be implemented on your platform. If it is unavailable,
8092using it will raise a NotImplementedError.
8093[clinic start generated code]*/
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008094
Barry Warsaw53699e91996-12-10 23:23:01 +00008095static PyObject *
Serhiy Storchaka12a69db2018-09-17 15:38:27 +03008096os_readlink_impl(PyObject *module, path_t *path, int dir_fd)
8097/*[clinic end generated code: output=d21b732a2e814030 input=113c87e0db1ecaf2]*/
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00008098{
Berker Peksage0b5b202018-08-15 13:03:41 +03008099#if defined(HAVE_READLINK)
Christian Heimes3cb091e2016-09-23 20:24:28 +02008100 char buffer[MAXPATHLEN+1];
Larry Hastings9cf065c2012-06-22 16:30:09 -07008101 ssize_t length;
Serhiy Storchaka12a69db2018-09-17 15:38:27 +03008102
8103 Py_BEGIN_ALLOW_THREADS
8104#ifdef HAVE_READLINKAT
8105 if (dir_fd != DEFAULT_DIR_FD)
8106 length = readlinkat(dir_fd, path->narrow, buffer, MAXPATHLEN);
8107 else
8108#endif
8109 length = readlink(path->narrow, buffer, MAXPATHLEN);
8110 Py_END_ALLOW_THREADS
8111
8112 if (length < 0) {
8113 return path_error(path);
8114 }
8115 buffer[length] = '\0';
8116
8117 if (PyUnicode_Check(path->object))
8118 return PyUnicode_DecodeFSDefaultAndSize(buffer, length);
8119 else
8120 return PyBytes_FromStringAndSize(buffer, length);
Berker Peksage0b5b202018-08-15 13:03:41 +03008121#elif defined(MS_WINDOWS)
8122 DWORD n_bytes_returned;
Steve Dowerdf2d4a62019-08-21 15:27:33 -07008123 DWORD io_result = 0;
Berker Peksage0b5b202018-08-15 13:03:41 +03008124 HANDLE reparse_point_handle;
Berker Peksage0b5b202018-08-15 13:03:41 +03008125 char target_buffer[_Py_MAXIMUM_REPARSE_DATA_BUFFER_SIZE];
8126 _Py_REPARSE_DATA_BUFFER *rdb = (_Py_REPARSE_DATA_BUFFER *)target_buffer;
Steve Dower993ac922019-09-03 12:50:51 -07008127 PyObject *result = NULL;
Thomas Wouters89f507f2006-12-13 04:49:30 +00008128
Larry Hastings2f936352014-08-05 14:04:04 +10008129 /* First get a handle to the reparse point */
8130 Py_BEGIN_ALLOW_THREADS
8131 reparse_point_handle = CreateFileW(
Serhiy Storchaka12a69db2018-09-17 15:38:27 +03008132 path->wide,
Larry Hastings2f936352014-08-05 14:04:04 +10008133 0,
8134 0,
8135 0,
8136 OPEN_EXISTING,
8137 FILE_FLAG_OPEN_REPARSE_POINT|FILE_FLAG_BACKUP_SEMANTICS,
8138 0);
Steve Dowerdf2d4a62019-08-21 15:27:33 -07008139 if (reparse_point_handle != INVALID_HANDLE_VALUE) {
8140 /* New call DeviceIoControl to read the reparse point */
8141 io_result = DeviceIoControl(
8142 reparse_point_handle,
8143 FSCTL_GET_REPARSE_POINT,
8144 0, 0, /* in buffer */
8145 target_buffer, sizeof(target_buffer),
8146 &n_bytes_returned,
8147 0 /* we're not using OVERLAPPED_IO */
8148 );
8149 CloseHandle(reparse_point_handle);
Berker Peksage0b5b202018-08-15 13:03:41 +03008150 }
Larry Hastings2f936352014-08-05 14:04:04 +10008151 Py_END_ALLOW_THREADS
8152
Berker Peksage0b5b202018-08-15 13:03:41 +03008153 if (io_result == 0) {
Serhiy Storchaka12a69db2018-09-17 15:38:27 +03008154 return path_error(path);
Berker Peksage0b5b202018-08-15 13:03:41 +03008155 }
Larry Hastings2f936352014-08-05 14:04:04 +10008156
Steve Dowerdf2d4a62019-08-21 15:27:33 -07008157 wchar_t *name = NULL;
8158 Py_ssize_t nameLen = 0;
8159 if (rdb->ReparseTag == IO_REPARSE_TAG_SYMLINK)
Larry Hastings2f936352014-08-05 14:04:04 +10008160 {
Steve Dowerdf2d4a62019-08-21 15:27:33 -07008161 name = (wchar_t *)((char*)rdb->SymbolicLinkReparseBuffer.PathBuffer +
8162 rdb->SymbolicLinkReparseBuffer.SubstituteNameOffset);
8163 nameLen = rdb->SymbolicLinkReparseBuffer.SubstituteNameLength / sizeof(wchar_t);
Larry Hastings2f936352014-08-05 14:04:04 +10008164 }
Steve Dowerdf2d4a62019-08-21 15:27:33 -07008165 else if (rdb->ReparseTag == IO_REPARSE_TAG_MOUNT_POINT)
8166 {
8167 name = (wchar_t *)((char*)rdb->MountPointReparseBuffer.PathBuffer +
8168 rdb->MountPointReparseBuffer.SubstituteNameOffset);
8169 nameLen = rdb->MountPointReparseBuffer.SubstituteNameLength / sizeof(wchar_t);
8170 }
8171 else
8172 {
8173 PyErr_SetString(PyExc_ValueError, "not a symbolic link");
8174 }
8175 if (name) {
8176 if (nameLen > 4 && wcsncmp(name, L"\\??\\", 4) == 0) {
8177 /* Our buffer is mutable, so this is okay */
8178 name[1] = L'\\';
8179 }
8180 result = PyUnicode_FromWideChar(name, nameLen);
Steve Dower993ac922019-09-03 12:50:51 -07008181 if (result && path->narrow) {
Steve Dowerdf2d4a62019-08-21 15:27:33 -07008182 Py_SETREF(result, PyUnicode_EncodeFSDefault(result));
8183 }
Berker Peksage0b5b202018-08-15 13:03:41 +03008184 }
Serhiy Storchaka12a69db2018-09-17 15:38:27 +03008185 return result;
Berker Peksage0b5b202018-08-15 13:03:41 +03008186#endif
Larry Hastings2f936352014-08-05 14:04:04 +10008187}
Berker Peksage0b5b202018-08-15 13:03:41 +03008188#endif /* defined(HAVE_READLINK) || defined(MS_WINDOWS) */
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008189
Larry Hastings9cf065c2012-06-22 16:30:09 -07008190#if defined(MS_WINDOWS)
8191
Steve Dower6921e732018-03-05 14:26:08 -08008192/* Remove the last portion of the path - return 0 on success */
8193static int
Victor Stinner31b3b922013-06-05 01:49:17 +02008194_dirnameW(WCHAR *path)
8195{
Jason R. Coombs3a092862013-05-27 23:21:28 -04008196 WCHAR *ptr;
Steve Dower6921e732018-03-05 14:26:08 -08008197 size_t length = wcsnlen_s(path, MAX_PATH);
8198 if (length == MAX_PATH) {
8199 return -1;
8200 }
Jason R. Coombs3a092862013-05-27 23:21:28 -04008201
8202 /* walk the path from the end until a backslash is encountered */
Steve Dower6921e732018-03-05 14:26:08 -08008203 for(ptr = path + length; ptr != path; ptr--) {
8204 if (*ptr == L'\\' || *ptr == L'/') {
Jason R. Coombs3a092862013-05-27 23:21:28 -04008205 break;
Steve Dower6921e732018-03-05 14:26:08 -08008206 }
Jason R. Coombs3a092862013-05-27 23:21:28 -04008207 }
8208 *ptr = 0;
Steve Dower6921e732018-03-05 14:26:08 -08008209 return 0;
Jason R. Coombs3a092862013-05-27 23:21:28 -04008210}
8211
Minmin Gong7f21c9a2020-05-18 09:17:19 -07008212#endif
8213
8214#ifdef HAVE_SYMLINK
8215
8216#if defined(MS_WINDOWS)
8217
Victor Stinner31b3b922013-06-05 01:49:17 +02008218/* Is this path absolute? */
8219static int
8220_is_absW(const WCHAR *path)
8221{
Steve Dower6921e732018-03-05 14:26:08 -08008222 return path[0] == L'\\' || path[0] == L'/' ||
8223 (path[0] && path[1] == L':');
Jason R. Coombs3a092862013-05-27 23:21:28 -04008224}
8225
Steve Dower6921e732018-03-05 14:26:08 -08008226/* join root and rest with a backslash - return 0 on success */
8227static int
Victor Stinner31b3b922013-06-05 01:49:17 +02008228_joinW(WCHAR *dest_path, const WCHAR *root, const WCHAR *rest)
8229{
Victor Stinner31b3b922013-06-05 01:49:17 +02008230 if (_is_absW(rest)) {
Steve Dower6921e732018-03-05 14:26:08 -08008231 return wcscpy_s(dest_path, MAX_PATH, rest);
Jason R. Coombs3a092862013-05-27 23:21:28 -04008232 }
8233
Steve Dower6921e732018-03-05 14:26:08 -08008234 if (wcscpy_s(dest_path, MAX_PATH, root)) {
8235 return -1;
Jason R. Coombs3a092862013-05-27 23:21:28 -04008236 }
Steve Dower6921e732018-03-05 14:26:08 -08008237
8238 if (dest_path[0] && wcscat_s(dest_path, MAX_PATH, L"\\")) {
8239 return -1;
8240 }
8241
8242 return wcscat_s(dest_path, MAX_PATH, rest);
Jason R. Coombs3a092862013-05-27 23:21:28 -04008243}
8244
Victor Stinner31b3b922013-06-05 01:49:17 +02008245/* Return True if the path at src relative to dest is a directory */
8246static int
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03008247_check_dirW(LPCWSTR src, LPCWSTR dest)
Jason R. Coombs3a092862013-05-27 23:21:28 -04008248{
Jason R. Coombs3a092862013-05-27 23:21:28 -04008249 WIN32_FILE_ATTRIBUTE_DATA src_info;
8250 WCHAR dest_parent[MAX_PATH];
8251 WCHAR src_resolved[MAX_PATH] = L"";
8252
8253 /* dest_parent = os.path.dirname(dest) */
Steve Dower6921e732018-03-05 14:26:08 -08008254 if (wcscpy_s(dest_parent, MAX_PATH, dest) ||
8255 _dirnameW(dest_parent)) {
8256 return 0;
8257 }
Jason R. Coombs3a092862013-05-27 23:21:28 -04008258 /* src_resolved = os.path.join(dest_parent, src) */
Steve Dower6921e732018-03-05 14:26:08 -08008259 if (_joinW(src_resolved, dest_parent, src)) {
8260 return 0;
8261 }
Jason R. Coombs3a092862013-05-27 23:21:28 -04008262 return (
8263 GetFileAttributesExW(src_resolved, GetFileExInfoStandard, &src_info)
8264 && src_info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY
8265 );
8266}
Larry Hastings9cf065c2012-06-22 16:30:09 -07008267#endif
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008268
Larry Hastings2f936352014-08-05 14:04:04 +10008269
8270/*[clinic input]
8271os.symlink
8272 src: path_t
8273 dst: path_t
8274 target_is_directory: bool = False
8275 *
8276 dir_fd: dir_fd(requires='symlinkat')=None
8277
8278# "symlink(src, dst, target_is_directory=False, *, dir_fd=None)\n\n\
8279
8280Create a symbolic link pointing to src named dst.
8281
8282target_is_directory is required on Windows if the target is to be
8283 interpreted as a directory. (On Windows, symlink requires
8284 Windows 6.0 or greater, and raises a NotImplementedError otherwise.)
8285 target_is_directory is ignored on non-Windows platforms.
8286
8287If dir_fd is not None, it should be a file descriptor open to a directory,
8288 and path should be relative; path will then be relative to that directory.
8289dir_fd may not be implemented on your platform.
8290 If it is unavailable, using it will raise a NotImplementedError.
8291
8292[clinic start generated code]*/
8293
Larry Hastings2f936352014-08-05 14:04:04 +10008294static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008295os_symlink_impl(PyObject *module, path_t *src, path_t *dst,
Larry Hastings89964c42015-04-14 18:07:59 -04008296 int target_is_directory, int dir_fd)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008297/*[clinic end generated code: output=08ca9f3f3cf960f6 input=e820ec4472547bc3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008298{
Larry Hastings9cf065c2012-06-22 16:30:09 -07008299#ifdef MS_WINDOWS
8300 DWORD result;
Vidar Tonaas Fauske0e107662019-04-09 20:19:46 +02008301 DWORD flags = 0;
8302
8303 /* Assumed true, set to false if detected to not be available. */
8304 static int windows_has_symlink_unprivileged_flag = TRUE;
Larry Hastings9cf065c2012-06-22 16:30:09 -07008305#else
8306 int result;
8307#endif
8308
Saiyang Gou7514f4f2020-02-12 23:47:42 -08008309 if (PySys_Audit("os.symlink", "OOi", src->object, dst->object,
8310 dir_fd == DEFAULT_DIR_FD ? -1 : dir_fd) < 0) {
8311 return NULL;
8312 }
8313
Larry Hastings9cf065c2012-06-22 16:30:09 -07008314#ifdef MS_WINDOWS
Larry Hastings9cf065c2012-06-22 16:30:09 -07008315
Vidar Tonaas Fauske0e107662019-04-09 20:19:46 +02008316 if (windows_has_symlink_unprivileged_flag) {
8317 /* Allow non-admin symlinks if system allows it. */
8318 flags |= SYMBOLIC_LINK_FLAG_ALLOW_UNPRIVILEGED_CREATE;
8319 }
Jason R. Coombs3a092862013-05-27 23:21:28 -04008320
Larry Hastings9cf065c2012-06-22 16:30:09 -07008321 Py_BEGIN_ALLOW_THREADS
Steve Dower6921e732018-03-05 14:26:08 -08008322 _Py_BEGIN_SUPPRESS_IPH
Vidar Tonaas Fauske0e107662019-04-09 20:19:46 +02008323 /* if src is a directory, ensure flags==1 (target_is_directory bit) */
8324 if (target_is_directory || _check_dirW(src->wide, dst->wide)) {
8325 flags |= SYMBOLIC_LINK_FLAG_DIRECTORY;
8326 }
8327
8328 result = CreateSymbolicLinkW(dst->wide, src->wide, flags);
Steve Dower6921e732018-03-05 14:26:08 -08008329 _Py_END_SUPPRESS_IPH
Larry Hastings9cf065c2012-06-22 16:30:09 -07008330 Py_END_ALLOW_THREADS
8331
Vidar Tonaas Fauske0e107662019-04-09 20:19:46 +02008332 if (windows_has_symlink_unprivileged_flag && !result &&
8333 ERROR_INVALID_PARAMETER == GetLastError()) {
8334
8335 Py_BEGIN_ALLOW_THREADS
8336 _Py_BEGIN_SUPPRESS_IPH
8337 /* This error might be caused by
8338 SYMBOLIC_LINK_FLAG_ALLOW_UNPRIVILEGED_CREATE not being supported.
8339 Try again, and update windows_has_symlink_unprivileged_flag if we
8340 are successful this time.
8341
8342 NOTE: There is a risk of a race condition here if there are other
8343 conditions than the flag causing ERROR_INVALID_PARAMETER, and
8344 another process (or thread) changes that condition in between our
8345 calls to CreateSymbolicLink.
8346 */
8347 flags &= ~(SYMBOLIC_LINK_FLAG_ALLOW_UNPRIVILEGED_CREATE);
8348 result = CreateSymbolicLinkW(dst->wide, src->wide, flags);
8349 _Py_END_SUPPRESS_IPH
8350 Py_END_ALLOW_THREADS
8351
8352 if (result || ERROR_INVALID_PARAMETER != GetLastError()) {
8353 windows_has_symlink_unprivileged_flag = FALSE;
8354 }
8355 }
8356
Larry Hastings2f936352014-08-05 14:04:04 +10008357 if (!result)
8358 return path_error2(src, dst);
Larry Hastings9cf065c2012-06-22 16:30:09 -07008359
8360#else
8361
Steve Dower6921e732018-03-05 14:26:08 -08008362 if ((src->narrow && dst->wide) || (src->wide && dst->narrow)) {
8363 PyErr_SetString(PyExc_ValueError,
8364 "symlink: src and dst must be the same type");
8365 return NULL;
8366 }
8367
Larry Hastings9cf065c2012-06-22 16:30:09 -07008368 Py_BEGIN_ALLOW_THREADS
8369#if HAVE_SYMLINKAT
8370 if (dir_fd != DEFAULT_DIR_FD)
Larry Hastings2f936352014-08-05 14:04:04 +10008371 result = symlinkat(src->narrow, dir_fd, dst->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07008372 else
8373#endif
Larry Hastings2f936352014-08-05 14:04:04 +10008374 result = symlink(src->narrow, dst->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07008375 Py_END_ALLOW_THREADS
8376
Larry Hastings2f936352014-08-05 14:04:04 +10008377 if (result)
8378 return path_error2(src, dst);
Larry Hastings9cf065c2012-06-22 16:30:09 -07008379#endif
8380
Larry Hastings2f936352014-08-05 14:04:04 +10008381 Py_RETURN_NONE;
Guido van Rossumbfaf3d61997-12-29 20:02:27 +00008382}
8383#endif /* HAVE_SYMLINK */
8384
Larry Hastings9cf065c2012-06-22 16:30:09 -07008385
Brian Curtind40e6f72010-07-08 21:39:08 +00008386
Guido van Rossumbfaf3d61997-12-29 20:02:27 +00008387
Larry Hastings605a62d2012-06-24 04:33:36 -07008388static PyStructSequence_Field times_result_fields[] = {
8389 {"user", "user time"},
8390 {"system", "system time"},
8391 {"children_user", "user time of children"},
8392 {"children_system", "system time of children"},
8393 {"elapsed", "elapsed time since an arbitrary point in the past"},
8394 {NULL}
8395};
8396
8397PyDoc_STRVAR(times_result__doc__,
8398"times_result: Result from os.times().\n\n\
8399This object may be accessed either as a tuple of\n\
8400 (user, system, children_user, children_system, elapsed),\n\
8401or via the attributes user, system, children_user, children_system,\n\
8402and elapsed.\n\
8403\n\
8404See os.times for more information.");
8405
8406static PyStructSequence_Desc times_result_desc = {
8407 "times_result", /* name */
8408 times_result__doc__, /* doc */
8409 times_result_fields,
8410 5
8411};
8412
Antoine Pitrouf3923e92012-07-24 21:23:53 +02008413#ifdef MS_WINDOWS
8414#define HAVE_TIMES /* mandatory, for the method table */
8415#endif
Larry Hastings605a62d2012-06-24 04:33:36 -07008416
Antoine Pitrouf3923e92012-07-24 21:23:53 +02008417#ifdef HAVE_TIMES
Larry Hastings605a62d2012-06-24 04:33:36 -07008418
8419static PyObject *
Victor Stinner1c2fa782020-05-10 11:05:29 +02008420build_times_result(PyObject *module, double user, double system,
Larry Hastings605a62d2012-06-24 04:33:36 -07008421 double children_user, double children_system,
8422 double elapsed)
8423{
Victor Stinner1c2fa782020-05-10 11:05:29 +02008424 PyObject *TimesResultType = get_posix_state(module)->TimesResultType;
Eddie Elizondob3966632019-11-05 07:16:14 -08008425 PyObject *value = PyStructSequence_New((PyTypeObject *)TimesResultType);
Larry Hastings605a62d2012-06-24 04:33:36 -07008426 if (value == NULL)
8427 return NULL;
8428
8429#define SET(i, field) \
8430 { \
8431 PyObject *o = PyFloat_FromDouble(field); \
8432 if (!o) { \
8433 Py_DECREF(value); \
8434 return NULL; \
8435 } \
8436 PyStructSequence_SET_ITEM(value, i, o); \
8437 } \
8438
8439 SET(0, user);
8440 SET(1, system);
8441 SET(2, children_user);
8442 SET(3, children_system);
8443 SET(4, elapsed);
8444
8445#undef SET
8446
8447 return value;
8448}
8449
Larry Hastings605a62d2012-06-24 04:33:36 -07008450
Larry Hastings2f936352014-08-05 14:04:04 +10008451#ifndef MS_WINDOWS
8452#define NEED_TICKS_PER_SECOND
8453static long ticks_per_second = -1;
8454#endif /* MS_WINDOWS */
8455
8456/*[clinic input]
8457os.times
8458
8459Return a collection containing process timing information.
8460
8461The object returned behaves like a named tuple with these fields:
8462 (utime, stime, cutime, cstime, elapsed_time)
8463All fields are floating point numbers.
8464[clinic start generated code]*/
8465
Larry Hastings2f936352014-08-05 14:04:04 +10008466static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008467os_times_impl(PyObject *module)
8468/*[clinic end generated code: output=35f640503557d32a input=2bf9df3d6ab2e48b]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008469#ifdef MS_WINDOWS
Guido van Rossum14ed0b21994-09-29 09:50:09 +00008470{
Victor Stinner8c62be82010-05-06 00:08:46 +00008471 FILETIME create, exit, kernel, user;
8472 HANDLE hProc;
8473 hProc = GetCurrentProcess();
8474 GetProcessTimes(hProc, &create, &exit, &kernel, &user);
8475 /* The fields of a FILETIME structure are the hi and lo part
8476 of a 64-bit value expressed in 100 nanosecond units.
8477 1e7 is one second in such units; 1e-7 the inverse.
8478 429.4967296 is 2**32 / 1e7 or 2**32 * 1e-7.
8479 */
Victor Stinner1c2fa782020-05-10 11:05:29 +02008480 return build_times_result(module,
Victor Stinner8c62be82010-05-06 00:08:46 +00008481 (double)(user.dwHighDateTime*429.4967296 +
8482 user.dwLowDateTime*1e-7),
8483 (double)(kernel.dwHighDateTime*429.4967296 +
8484 kernel.dwLowDateTime*1e-7),
8485 (double)0,
8486 (double)0,
8487 (double)0);
Guido van Rossum14ed0b21994-09-29 09:50:09 +00008488}
Larry Hastings2f936352014-08-05 14:04:04 +10008489#else /* MS_WINDOWS */
Antoine Pitrouf3923e92012-07-24 21:23:53 +02008490{
Larry Hastings2f936352014-08-05 14:04:04 +10008491
8492
Antoine Pitrouf3923e92012-07-24 21:23:53 +02008493 struct tms t;
8494 clock_t c;
8495 errno = 0;
8496 c = times(&t);
8497 if (c == (clock_t) -1)
8498 return posix_error();
Victor Stinner1c2fa782020-05-10 11:05:29 +02008499 return build_times_result(module,
Antoine Pitrouf3923e92012-07-24 21:23:53 +02008500 (double)t.tms_utime / ticks_per_second,
8501 (double)t.tms_stime / ticks_per_second,
8502 (double)t.tms_cutime / ticks_per_second,
8503 (double)t.tms_cstime / ticks_per_second,
8504 (double)c / ticks_per_second);
8505}
Larry Hastings2f936352014-08-05 14:04:04 +10008506#endif /* MS_WINDOWS */
Antoine Pitrouf3923e92012-07-24 21:23:53 +02008507#endif /* HAVE_TIMES */
8508
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008509
Martin v. Löwis49ee14d2003-11-10 06:35:36 +00008510#ifdef HAVE_GETSID
Larry Hastings2f936352014-08-05 14:04:04 +10008511/*[clinic input]
8512os.getsid
8513
8514 pid: pid_t
8515 /
8516
8517Call the system call getsid(pid) and return the result.
8518[clinic start generated code]*/
8519
Larry Hastings2f936352014-08-05 14:04:04 +10008520static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008521os_getsid_impl(PyObject *module, pid_t pid)
8522/*[clinic end generated code: output=112deae56b306460 input=eeb2b923a30ce04e]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008523{
Victor Stinner8c62be82010-05-06 00:08:46 +00008524 int sid;
Victor Stinner8c62be82010-05-06 00:08:46 +00008525 sid = getsid(pid);
8526 if (sid < 0)
8527 return posix_error();
8528 return PyLong_FromLong((long)sid);
Martin v. Löwis49ee14d2003-11-10 06:35:36 +00008529}
8530#endif /* HAVE_GETSID */
8531
8532
Guido van Rossumb6775db1994-08-01 11:34:53 +00008533#ifdef HAVE_SETSID
Larry Hastings2f936352014-08-05 14:04:04 +10008534/*[clinic input]
8535os.setsid
8536
8537Call the system call setsid().
8538[clinic start generated code]*/
8539
Larry Hastings2f936352014-08-05 14:04:04 +10008540static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008541os_setsid_impl(PyObject *module)
8542/*[clinic end generated code: output=e2ddedd517086d77 input=5fff45858e2f0776]*/
Guido van Rossumc2670a01992-09-13 20:07:29 +00008543{
Victor Stinner8c62be82010-05-06 00:08:46 +00008544 if (setsid() < 0)
8545 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10008546 Py_RETURN_NONE;
Guido van Rossumc2670a01992-09-13 20:07:29 +00008547}
Guido van Rossumb6775db1994-08-01 11:34:53 +00008548#endif /* HAVE_SETSID */
Guido van Rossumc2670a01992-09-13 20:07:29 +00008549
Larry Hastings2f936352014-08-05 14:04:04 +10008550
Guido van Rossumb6775db1994-08-01 11:34:53 +00008551#ifdef HAVE_SETPGID
Larry Hastings2f936352014-08-05 14:04:04 +10008552/*[clinic input]
8553os.setpgid
8554
8555 pid: pid_t
8556 pgrp: pid_t
8557 /
8558
8559Call the system call setpgid(pid, pgrp).
8560[clinic start generated code]*/
8561
Larry Hastings2f936352014-08-05 14:04:04 +10008562static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008563os_setpgid_impl(PyObject *module, pid_t pid, pid_t pgrp)
8564/*[clinic end generated code: output=6461160319a43d6a input=fceb395eca572e1a]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008565{
Victor Stinner8c62be82010-05-06 00:08:46 +00008566 if (setpgid(pid, pgrp) < 0)
8567 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10008568 Py_RETURN_NONE;
Guido van Rossumc2670a01992-09-13 20:07:29 +00008569}
Guido van Rossumb6775db1994-08-01 11:34:53 +00008570#endif /* HAVE_SETPGID */
Guido van Rossumc2670a01992-09-13 20:07:29 +00008571
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008572
Guido van Rossumb6775db1994-08-01 11:34:53 +00008573#ifdef HAVE_TCGETPGRP
Larry Hastings2f936352014-08-05 14:04:04 +10008574/*[clinic input]
8575os.tcgetpgrp
8576
8577 fd: int
8578 /
8579
8580Return the process group associated with the terminal specified by fd.
8581[clinic start generated code]*/
8582
Larry Hastings2f936352014-08-05 14:04:04 +10008583static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008584os_tcgetpgrp_impl(PyObject *module, int fd)
8585/*[clinic end generated code: output=f865e88be86c272b input=7f6c18eac10ada86]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008586{
8587 pid_t pgid = tcgetpgrp(fd);
Victor Stinner8c62be82010-05-06 00:08:46 +00008588 if (pgid < 0)
8589 return posix_error();
8590 return PyLong_FromPid(pgid);
Guido van Rossum7066dd71992-09-17 17:54:56 +00008591}
Guido van Rossumb6775db1994-08-01 11:34:53 +00008592#endif /* HAVE_TCGETPGRP */
Guido van Rossum7066dd71992-09-17 17:54:56 +00008593
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008594
Guido van Rossumb6775db1994-08-01 11:34:53 +00008595#ifdef HAVE_TCSETPGRP
Larry Hastings2f936352014-08-05 14:04:04 +10008596/*[clinic input]
8597os.tcsetpgrp
8598
8599 fd: int
8600 pgid: pid_t
8601 /
8602
8603Set the process group associated with the terminal specified by fd.
8604[clinic start generated code]*/
8605
Larry Hastings2f936352014-08-05 14:04:04 +10008606static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008607os_tcsetpgrp_impl(PyObject *module, int fd, pid_t pgid)
8608/*[clinic end generated code: output=f1821a381b9daa39 input=5bdc997c6a619020]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008609{
Victor Stinner8c62be82010-05-06 00:08:46 +00008610 if (tcsetpgrp(fd, pgid) < 0)
8611 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10008612 Py_RETURN_NONE;
Guido van Rossum7066dd71992-09-17 17:54:56 +00008613}
Guido van Rossumb6775db1994-08-01 11:34:53 +00008614#endif /* HAVE_TCSETPGRP */
Guido van Rossum22db57e1992-04-05 14:25:30 +00008615
Guido van Rossum687dd131993-05-17 08:34:16 +00008616/* Functions acting on file descriptors */
8617
Victor Stinnerdaf45552013-08-28 00:53:59 +02008618#ifdef O_CLOEXEC
8619extern int _Py_open_cloexec_works;
8620#endif
8621
Larry Hastings2f936352014-08-05 14:04:04 +10008622
8623/*[clinic input]
8624os.open -> int
8625 path: path_t
8626 flags: int
8627 mode: int = 0o777
8628 *
8629 dir_fd: dir_fd(requires='openat') = None
8630
8631# "open(path, flags, mode=0o777, *, dir_fd=None)\n\n\
8632
8633Open a file for low level IO. Returns a file descriptor (integer).
8634
8635If dir_fd is not None, it should be a file descriptor open to a directory,
8636 and path should be relative; path will then be relative to that directory.
8637dir_fd may not be implemented on your platform.
8638 If it is unavailable, using it will raise a NotImplementedError.
8639[clinic start generated code]*/
8640
Larry Hastings2f936352014-08-05 14:04:04 +10008641static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008642os_open_impl(PyObject *module, path_t *path, int flags, int mode, int dir_fd)
8643/*[clinic end generated code: output=abc7227888c8bc73 input=ad8623b29acd2934]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008644{
8645 int fd;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008646 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10008647
Victor Stinnerdaf45552013-08-28 00:53:59 +02008648#ifdef O_CLOEXEC
8649 int *atomic_flag_works = &_Py_open_cloexec_works;
8650#elif !defined(MS_WINDOWS)
8651 int *atomic_flag_works = NULL;
8652#endif
Mark Hammondc2e85bd2002-10-03 05:10:39 +00008653
Victor Stinnerdaf45552013-08-28 00:53:59 +02008654#ifdef MS_WINDOWS
8655 flags |= O_NOINHERIT;
8656#elif defined(O_CLOEXEC)
8657 flags |= O_CLOEXEC;
8658#endif
8659
Steve Dowerb82e17e2019-05-23 08:45:22 -07008660 if (PySys_Audit("open", "OOi", path->object, Py_None, flags) < 0) {
8661 return -1;
8662 }
8663
Steve Dower8fc89802015-04-12 00:26:27 -04008664 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008665 do {
8666 Py_BEGIN_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07008667#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07008668 fd = _wopen(path->wide, flags, mode);
Steve Dower6230aaf2016-09-09 09:03:15 -07008669#else
Larry Hastings9cf065c2012-06-22 16:30:09 -07008670#ifdef HAVE_OPENAT
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008671 if (dir_fd != DEFAULT_DIR_FD)
8672 fd = openat(dir_fd, path->narrow, flags, mode);
8673 else
Steve Dower6230aaf2016-09-09 09:03:15 -07008674#endif /* HAVE_OPENAT */
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008675 fd = open(path->narrow, flags, mode);
Steve Dower6230aaf2016-09-09 09:03:15 -07008676#endif /* !MS_WINDOWS */
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008677 Py_END_ALLOW_THREADS
8678 } while (fd < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Steve Dower8fc89802015-04-12 00:26:27 -04008679 _Py_END_SUPPRESS_IPH
Guido van Rossum687dd131993-05-17 08:34:16 +00008680
Victor Stinnerd3ffd322015-09-15 10:11:03 +02008681 if (fd < 0) {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008682 if (!async_err)
8683 PyErr_SetFromErrnoWithFilenameObject(PyExc_OSError, path->object);
Larry Hastings2f936352014-08-05 14:04:04 +10008684 return -1;
Larry Hastings9cf065c2012-06-22 16:30:09 -07008685 }
8686
Victor Stinnerdaf45552013-08-28 00:53:59 +02008687#ifndef MS_WINDOWS
8688 if (_Py_set_inheritable(fd, 0, atomic_flag_works) < 0) {
8689 close(fd);
Larry Hastings2f936352014-08-05 14:04:04 +10008690 return -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008691 }
8692#endif
8693
Larry Hastings2f936352014-08-05 14:04:04 +10008694 return fd;
8695}
8696
8697
8698/*[clinic input]
8699os.close
8700
8701 fd: int
8702
8703Close a file descriptor.
8704[clinic start generated code]*/
8705
Barry Warsaw53699e91996-12-10 23:23:01 +00008706static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008707os_close_impl(PyObject *module, int fd)
8708/*[clinic end generated code: output=2fe4e93602822c14 input=2bc42451ca5c3223]*/
Guido van Rossum687dd131993-05-17 08:34:16 +00008709{
Larry Hastings2f936352014-08-05 14:04:04 +10008710 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008711 /* We do not want to retry upon EINTR: see http://lwn.net/Articles/576478/
8712 * and http://linux.derkeiler.com/Mailing-Lists/Kernel/2005-09/3000.html
8713 * for more details.
8714 */
Victor Stinner8c62be82010-05-06 00:08:46 +00008715 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04008716 _Py_BEGIN_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00008717 res = close(fd);
Steve Dower8fc89802015-04-12 00:26:27 -04008718 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00008719 Py_END_ALLOW_THREADS
8720 if (res < 0)
8721 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10008722 Py_RETURN_NONE;
Guido van Rossum687dd131993-05-17 08:34:16 +00008723}
8724
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008725
Jakub Kulíke20134f2019-09-11 17:11:57 +02008726#ifdef HAVE_FDWALK
8727static int
8728_fdwalk_close_func(void *lohi, int fd)
8729{
8730 int lo = ((int *)lohi)[0];
8731 int hi = ((int *)lohi)[1];
8732
Victor Stinner162c5672020-04-24 12:00:51 +02008733 if (fd >= hi) {
Jakub Kulíke20134f2019-09-11 17:11:57 +02008734 return 1;
Victor Stinner162c5672020-04-24 12:00:51 +02008735 }
8736 else if (fd >= lo) {
8737 /* Ignore errors */
8738 (void)close(fd);
8739 }
Jakub Kulíke20134f2019-09-11 17:11:57 +02008740 return 0;
8741}
8742#endif /* HAVE_FDWALK */
8743
Larry Hastings2f936352014-08-05 14:04:04 +10008744/*[clinic input]
8745os.closerange
8746
8747 fd_low: int
8748 fd_high: int
8749 /
8750
8751Closes all file descriptors in [fd_low, fd_high), ignoring errors.
8752[clinic start generated code]*/
8753
Larry Hastings2f936352014-08-05 14:04:04 +10008754static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008755os_closerange_impl(PyObject *module, int fd_low, int fd_high)
8756/*[clinic end generated code: output=0ce5c20fcda681c2 input=5855a3d053ebd4ec]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008757{
Jakub Kulíke20134f2019-09-11 17:11:57 +02008758#ifdef HAVE_FDWALK
8759 int lohi[2];
Jakub Kulíke20134f2019-09-11 17:11:57 +02008760#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00008761 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04008762 _Py_BEGIN_SUPPRESS_IPH
Jakub Kulíke20134f2019-09-11 17:11:57 +02008763#ifdef HAVE_FDWALK
8764 lohi[0] = Py_MAX(fd_low, 0);
8765 lohi[1] = fd_high;
8766 fdwalk(_fdwalk_close_func, lohi);
8767#else
Victor Stinner162c5672020-04-24 12:00:51 +02008768 fd_low = Py_MAX(fd_low, 0);
8769#ifdef __FreeBSD__
8770 if (fd_high >= sysconf(_SC_OPEN_MAX)) {
8771 /* Any errors encountered while closing file descriptors are ignored */
8772 closefrom(fd_low);
8773 }
8774 else
8775#endif
8776 {
8777 for (int i = fd_low; i < fd_high; i++) {
8778 /* Ignore errors */
8779 (void)close(i);
8780 }
8781 }
Jakub Kulíke20134f2019-09-11 17:11:57 +02008782#endif
Steve Dower8fc89802015-04-12 00:26:27 -04008783 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00008784 Py_END_ALLOW_THREADS
8785 Py_RETURN_NONE;
Christian Heimesfdab48e2008-01-20 09:06:41 +00008786}
8787
8788
Larry Hastings2f936352014-08-05 14:04:04 +10008789/*[clinic input]
8790os.dup -> int
8791
8792 fd: int
8793 /
8794
8795Return a duplicate of a file descriptor.
8796[clinic start generated code]*/
8797
Larry Hastings2f936352014-08-05 14:04:04 +10008798static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008799os_dup_impl(PyObject *module, int fd)
8800/*[clinic end generated code: output=486f4860636b2a9f input=6f10f7ea97f7852a]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008801{
8802 return _Py_dup(fd);
Guido van Rossum687dd131993-05-17 08:34:16 +00008803}
8804
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008805
Larry Hastings2f936352014-08-05 14:04:04 +10008806/*[clinic input]
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008807os.dup2 -> int
Larry Hastings2f936352014-08-05 14:04:04 +10008808 fd: int
8809 fd2: int
8810 inheritable: bool=True
8811
8812Duplicate file descriptor.
8813[clinic start generated code]*/
8814
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008815static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008816os_dup2_impl(PyObject *module, int fd, int fd2, int inheritable)
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008817/*[clinic end generated code: output=bc059d34a73404d1 input=c3cddda8922b038d]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008818{
Stéphane Wirtel3d86e482018-01-30 07:04:36 +01008819 int res = 0;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008820#if defined(HAVE_DUP3) && \
8821 !(defined(HAVE_FCNTL_H) && defined(F_DUP2FD_CLOEXEC))
8822 /* dup3() is available on Linux 2.6.27+ and glibc 2.9 */
Alexey Izbyshevb3caf382018-02-20 10:25:46 +03008823 static int dup3_works = -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008824#endif
8825
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008826 if (fd < 0 || fd2 < 0) {
8827 posix_error();
8828 return -1;
8829 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02008830
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008831 /* dup2() can fail with EINTR if the target FD is already open, because it
8832 * then has to be closed. See os_close_impl() for why we don't handle EINTR
8833 * upon close(), and therefore below.
8834 */
Victor Stinnerdaf45552013-08-28 00:53:59 +02008835#ifdef MS_WINDOWS
8836 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04008837 _Py_BEGIN_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00008838 res = dup2(fd, fd2);
Steve Dower8fc89802015-04-12 00:26:27 -04008839 _Py_END_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02008840 Py_END_ALLOW_THREADS
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008841 if (res < 0) {
8842 posix_error();
8843 return -1;
8844 }
8845 res = fd2; // msvcrt dup2 returns 0 on success.
Victor Stinnerdaf45552013-08-28 00:53:59 +02008846
8847 /* Character files like console cannot be make non-inheritable */
8848 if (!inheritable && _Py_set_inheritable(fd2, 0, NULL) < 0) {
8849 close(fd2);
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008850 return -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008851 }
8852
8853#elif defined(HAVE_FCNTL_H) && defined(F_DUP2FD_CLOEXEC)
8854 Py_BEGIN_ALLOW_THREADS
8855 if (!inheritable)
8856 res = fcntl(fd, F_DUP2FD_CLOEXEC, fd2);
8857 else
8858 res = dup2(fd, fd2);
8859 Py_END_ALLOW_THREADS
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008860 if (res < 0) {
8861 posix_error();
8862 return -1;
8863 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02008864
8865#else
8866
8867#ifdef HAVE_DUP3
8868 if (!inheritable && dup3_works != 0) {
8869 Py_BEGIN_ALLOW_THREADS
8870 res = dup3(fd, fd2, O_CLOEXEC);
8871 Py_END_ALLOW_THREADS
8872 if (res < 0) {
8873 if (dup3_works == -1)
8874 dup3_works = (errno != ENOSYS);
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008875 if (dup3_works) {
8876 posix_error();
8877 return -1;
8878 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02008879 }
8880 }
8881
8882 if (inheritable || dup3_works == 0)
8883 {
8884#endif
8885 Py_BEGIN_ALLOW_THREADS
8886 res = dup2(fd, fd2);
8887 Py_END_ALLOW_THREADS
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008888 if (res < 0) {
8889 posix_error();
8890 return -1;
8891 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02008892
8893 if (!inheritable && _Py_set_inheritable(fd2, 0, NULL) < 0) {
8894 close(fd2);
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008895 return -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008896 }
8897#ifdef HAVE_DUP3
8898 }
8899#endif
8900
8901#endif
8902
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008903 return res;
Guido van Rossum687dd131993-05-17 08:34:16 +00008904}
8905
Larry Hastings2f936352014-08-05 14:04:04 +10008906
Ross Lagerwall7807c352011-03-17 20:20:30 +02008907#ifdef HAVE_LOCKF
Larry Hastings2f936352014-08-05 14:04:04 +10008908/*[clinic input]
8909os.lockf
8910
8911 fd: int
8912 An open file descriptor.
8913 command: int
8914 One of F_LOCK, F_TLOCK, F_ULOCK or F_TEST.
8915 length: Py_off_t
8916 The number of bytes to lock, starting at the current position.
8917 /
8918
8919Apply, test or remove a POSIX lock on an open file descriptor.
8920
8921[clinic start generated code]*/
8922
Larry Hastings2f936352014-08-05 14:04:04 +10008923static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008924os_lockf_impl(PyObject *module, int fd, int command, Py_off_t length)
8925/*[clinic end generated code: output=af7051f3e7c29651 input=65da41d2106e9b79]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008926{
8927 int res;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008928
Saiyang Gou7514f4f2020-02-12 23:47:42 -08008929 if (PySys_Audit("os.lockf", "iiL", fd, command, length) < 0) {
8930 return NULL;
8931 }
8932
Ross Lagerwall7807c352011-03-17 20:20:30 +02008933 Py_BEGIN_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10008934 res = lockf(fd, command, length);
Ross Lagerwall7807c352011-03-17 20:20:30 +02008935 Py_END_ALLOW_THREADS
8936
8937 if (res < 0)
8938 return posix_error();
8939
8940 Py_RETURN_NONE;
8941}
Larry Hastings2f936352014-08-05 14:04:04 +10008942#endif /* HAVE_LOCKF */
Ross Lagerwall7807c352011-03-17 20:20:30 +02008943
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008944
Larry Hastings2f936352014-08-05 14:04:04 +10008945/*[clinic input]
8946os.lseek -> Py_off_t
8947
8948 fd: int
8949 position: Py_off_t
8950 how: int
8951 /
8952
8953Set the position of a file descriptor. Return the new position.
8954
8955Return the new cursor position in number of bytes
8956relative to the beginning of the file.
8957[clinic start generated code]*/
8958
Larry Hastings2f936352014-08-05 14:04:04 +10008959static Py_off_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008960os_lseek_impl(PyObject *module, int fd, Py_off_t position, int how)
8961/*[clinic end generated code: output=971e1efb6b30bd2f input=902654ad3f96a6d3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008962{
8963 Py_off_t result;
8964
Guido van Rossum687dd131993-05-17 08:34:16 +00008965#ifdef SEEK_SET
Victor Stinner8c62be82010-05-06 00:08:46 +00008966 /* Turn 0, 1, 2 into SEEK_{SET,CUR,END} */
8967 switch (how) {
Larry Hastings2f936352014-08-05 14:04:04 +10008968 case 0: how = SEEK_SET; break;
8969 case 1: how = SEEK_CUR; break;
8970 case 2: how = SEEK_END; break;
Victor Stinner8c62be82010-05-06 00:08:46 +00008971 }
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00008972#endif /* SEEK_END */
Guido van Rossum94f6f721999-01-06 18:42:14 +00008973
Victor Stinner8c62be82010-05-06 00:08:46 +00008974 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04008975 _Py_BEGIN_SUPPRESS_IPH
Victor Stinner14b9b112013-06-25 00:37:25 +02008976#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10008977 result = _lseeki64(fd, position, how);
Fred Drake699f3522000-06-29 21:12:41 +00008978#else
Larry Hastings2f936352014-08-05 14:04:04 +10008979 result = lseek(fd, position, how);
Fred Drake699f3522000-06-29 21:12:41 +00008980#endif
Steve Dower8fc89802015-04-12 00:26:27 -04008981 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00008982 Py_END_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10008983 if (result < 0)
8984 posix_error();
Guido van Rossum94f6f721999-01-06 18:42:14 +00008985
Larry Hastings2f936352014-08-05 14:04:04 +10008986 return result;
Guido van Rossum687dd131993-05-17 08:34:16 +00008987}
8988
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008989
Larry Hastings2f936352014-08-05 14:04:04 +10008990/*[clinic input]
8991os.read
8992 fd: int
8993 length: Py_ssize_t
8994 /
8995
8996Read from a file descriptor. Returns a bytes object.
8997[clinic start generated code]*/
8998
Larry Hastings2f936352014-08-05 14:04:04 +10008999static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009000os_read_impl(PyObject *module, int fd, Py_ssize_t length)
9001/*[clinic end generated code: output=dafbe9a5cddb987b input=1df2eaa27c0bf1d3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009002{
Victor Stinner8c62be82010-05-06 00:08:46 +00009003 Py_ssize_t n;
9004 PyObject *buffer;
Larry Hastings2f936352014-08-05 14:04:04 +10009005
9006 if (length < 0) {
Victor Stinner8c62be82010-05-06 00:08:46 +00009007 errno = EINVAL;
9008 return posix_error();
9009 }
Larry Hastings2f936352014-08-05 14:04:04 +10009010
Victor Stinner9a0d7a72018-11-22 15:03:40 +01009011 length = Py_MIN(length, _PY_READ_MAX);
Larry Hastings2f936352014-08-05 14:04:04 +10009012
9013 buffer = PyBytes_FromStringAndSize((char *)NULL, length);
Victor Stinner8c62be82010-05-06 00:08:46 +00009014 if (buffer == NULL)
9015 return NULL;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009016
Victor Stinner66aab0c2015-03-19 22:53:20 +01009017 n = _Py_read(fd, PyBytes_AS_STRING(buffer), length);
9018 if (n == -1) {
Victor Stinner8c62be82010-05-06 00:08:46 +00009019 Py_DECREF(buffer);
Victor Stinner66aab0c2015-03-19 22:53:20 +01009020 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00009021 }
Larry Hastings2f936352014-08-05 14:04:04 +10009022
9023 if (n != length)
Victor Stinner8c62be82010-05-06 00:08:46 +00009024 _PyBytes_Resize(&buffer, n);
Larry Hastings2f936352014-08-05 14:04:04 +10009025
Victor Stinner8c62be82010-05-06 00:08:46 +00009026 return buffer;
Guido van Rossum687dd131993-05-17 08:34:16 +00009027}
9028
Ross Lagerwall7807c352011-03-17 20:20:30 +02009029#if (defined(HAVE_SENDFILE) && (defined(__FreeBSD__) || defined(__DragonFly__) \
Serhiy Storchaka9d572732018-07-31 10:24:54 +03009030 || defined(__APPLE__))) \
9031 || defined(HAVE_READV) || defined(HAVE_PREADV) || defined (HAVE_PREADV2) \
9032 || defined(HAVE_WRITEV) || defined(HAVE_PWRITEV) || defined (HAVE_PWRITEV2)
9033static int
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009034iov_setup(struct iovec **iov, Py_buffer **buf, PyObject *seq, Py_ssize_t cnt, int type)
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009035{
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009036 Py_ssize_t i, j;
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00009037
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009038 *iov = PyMem_New(struct iovec, cnt);
9039 if (*iov == NULL) {
9040 PyErr_NoMemory();
Victor Stinner57ddf782014-01-08 15:21:28 +01009041 return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009042 }
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00009043
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009044 *buf = PyMem_New(Py_buffer, cnt);
9045 if (*buf == NULL) {
9046 PyMem_Del(*iov);
9047 PyErr_NoMemory();
Victor Stinner57ddf782014-01-08 15:21:28 +01009048 return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009049 }
9050
9051 for (i = 0; i < cnt; i++) {
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02009052 PyObject *item = PySequence_GetItem(seq, i);
9053 if (item == NULL)
9054 goto fail;
9055 if (PyObject_GetBuffer(item, &(*buf)[i], type) == -1) {
9056 Py_DECREF(item);
9057 goto fail;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009058 }
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02009059 Py_DECREF(item);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009060 (*iov)[i].iov_base = (*buf)[i].buf;
Serhiy Storchaka9d572732018-07-31 10:24:54 +03009061 (*iov)[i].iov_len = (*buf)[i].len;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009062 }
Serhiy Storchaka9d572732018-07-31 10:24:54 +03009063 return 0;
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02009064
9065fail:
9066 PyMem_Del(*iov);
9067 for (j = 0; j < i; j++) {
9068 PyBuffer_Release(&(*buf)[j]);
9069 }
9070 PyMem_Del(*buf);
Victor Stinner57ddf782014-01-08 15:21:28 +01009071 return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009072}
9073
9074static void
9075iov_cleanup(struct iovec *iov, Py_buffer *buf, int cnt)
9076{
9077 int i;
9078 PyMem_Del(iov);
9079 for (i = 0; i < cnt; i++) {
9080 PyBuffer_Release(&buf[i]);
9081 }
9082 PyMem_Del(buf);
9083}
9084#endif
9085
Larry Hastings2f936352014-08-05 14:04:04 +10009086
Ross Lagerwall7807c352011-03-17 20:20:30 +02009087#ifdef HAVE_READV
Larry Hastings2f936352014-08-05 14:04:04 +10009088/*[clinic input]
9089os.readv -> Py_ssize_t
9090
9091 fd: int
9092 buffers: object
9093 /
9094
9095Read from a file descriptor fd into an iterable of buffers.
9096
9097The buffers should be mutable buffers accepting bytes.
9098readv will transfer data into each buffer until it is full
9099and then move on to the next buffer in the sequence to hold
9100the rest of the data.
9101
9102readv returns the total number of bytes read,
9103which may be less than the total capacity of all the buffers.
9104[clinic start generated code]*/
9105
Larry Hastings2f936352014-08-05 14:04:04 +10009106static Py_ssize_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009107os_readv_impl(PyObject *module, int fd, PyObject *buffers)
9108/*[clinic end generated code: output=792da062d3fcebdb input=e679eb5dbfa0357d]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009109{
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009110 Py_ssize_t cnt, n;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009111 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009112 struct iovec *iov;
9113 Py_buffer *buf;
9114
Larry Hastings2f936352014-08-05 14:04:04 +10009115 if (!PySequence_Check(buffers)) {
Ross Lagerwall7807c352011-03-17 20:20:30 +02009116 PyErr_SetString(PyExc_TypeError,
9117 "readv() arg 2 must be a sequence");
Larry Hastings2f936352014-08-05 14:04:04 +10009118 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009119 }
Ross Lagerwall7807c352011-03-17 20:20:30 +02009120
Larry Hastings2f936352014-08-05 14:04:04 +10009121 cnt = PySequence_Size(buffers);
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009122 if (cnt < 0)
9123 return -1;
Larry Hastings2f936352014-08-05 14:04:04 +10009124
9125 if (iov_setup(&iov, &buf, buffers, cnt, PyBUF_WRITABLE) < 0)
9126 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009127
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009128 do {
9129 Py_BEGIN_ALLOW_THREADS
9130 n = readv(fd, iov, cnt);
9131 Py_END_ALLOW_THREADS
9132 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Ross Lagerwall7807c352011-03-17 20:20:30 +02009133
9134 iov_cleanup(iov, buf, cnt);
Larry Hastings2f936352014-08-05 14:04:04 +10009135 if (n < 0) {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009136 if (!async_err)
9137 posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10009138 return -1;
9139 }
Victor Stinner57ddf782014-01-08 15:21:28 +01009140
Larry Hastings2f936352014-08-05 14:04:04 +10009141 return n;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009142}
Larry Hastings2f936352014-08-05 14:04:04 +10009143#endif /* HAVE_READV */
9144
Ross Lagerwall7807c352011-03-17 20:20:30 +02009145
9146#ifdef HAVE_PREAD
Larry Hastings2f936352014-08-05 14:04:04 +10009147/*[clinic input]
Larry Hastings2f936352014-08-05 14:04:04 +10009148os.pread
9149
9150 fd: int
Dong-hee Naad7736f2019-09-25 14:47:04 +09009151 length: Py_ssize_t
Larry Hastings2f936352014-08-05 14:04:04 +10009152 offset: Py_off_t
9153 /
9154
9155Read a number of bytes from a file descriptor starting at a particular offset.
9156
9157Read length bytes from file descriptor fd, starting at offset bytes from
9158the beginning of the file. The file offset remains unchanged.
9159[clinic start generated code]*/
9160
Larry Hastings2f936352014-08-05 14:04:04 +10009161static PyObject *
Dong-hee Naad7736f2019-09-25 14:47:04 +09009162os_pread_impl(PyObject *module, int fd, Py_ssize_t length, Py_off_t offset)
9163/*[clinic end generated code: output=3f875c1eef82e32f input=85cb4a5589627144]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009164{
Ross Lagerwall7807c352011-03-17 20:20:30 +02009165 Py_ssize_t n;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009166 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009167 PyObject *buffer;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009168
Larry Hastings2f936352014-08-05 14:04:04 +10009169 if (length < 0) {
Ross Lagerwall7807c352011-03-17 20:20:30 +02009170 errno = EINVAL;
9171 return posix_error();
9172 }
Larry Hastings2f936352014-08-05 14:04:04 +10009173 buffer = PyBytes_FromStringAndSize((char *)NULL, length);
Ross Lagerwall7807c352011-03-17 20:20:30 +02009174 if (buffer == NULL)
9175 return NULL;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009176
9177 do {
9178 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04009179 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009180 n = pread(fd, PyBytes_AS_STRING(buffer), length, offset);
Steve Dower8fc89802015-04-12 00:26:27 -04009181 _Py_END_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009182 Py_END_ALLOW_THREADS
9183 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
9184
Ross Lagerwall7807c352011-03-17 20:20:30 +02009185 if (n < 0) {
9186 Py_DECREF(buffer);
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009187 return (!async_err) ? posix_error() : NULL;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009188 }
Larry Hastings2f936352014-08-05 14:04:04 +10009189 if (n != length)
Ross Lagerwall7807c352011-03-17 20:20:30 +02009190 _PyBytes_Resize(&buffer, n);
9191 return buffer;
9192}
Larry Hastings2f936352014-08-05 14:04:04 +10009193#endif /* HAVE_PREAD */
Ross Lagerwall7807c352011-03-17 20:20:30 +02009194
Pablo Galindo4defba32018-01-27 16:16:37 +00009195#if defined(HAVE_PREADV) || defined (HAVE_PREADV2)
9196/*[clinic input]
9197os.preadv -> Py_ssize_t
9198
9199 fd: int
9200 buffers: object
9201 offset: Py_off_t
9202 flags: int = 0
9203 /
9204
9205Reads from a file descriptor into a number of mutable bytes-like objects.
9206
9207Combines the functionality of readv() and pread(). As readv(), it will
9208transfer data into each buffer until it is full and then move on to the next
9209buffer in the sequence to hold the rest of the data. Its fourth argument,
9210specifies the file offset at which the input operation is to be performed. It
9211will return the total number of bytes read (which can be less than the total
9212capacity of all the objects).
9213
9214The flags argument contains a bitwise OR of zero or more of the following flags:
9215
9216- RWF_HIPRI
9217- RWF_NOWAIT
9218
9219Using non-zero flags requires Linux 4.6 or newer.
9220[clinic start generated code]*/
9221
9222static Py_ssize_t
9223os_preadv_impl(PyObject *module, int fd, PyObject *buffers, Py_off_t offset,
9224 int flags)
9225/*[clinic end generated code: output=26fc9c6e58e7ada5 input=4173919dc1f7ed99]*/
9226{
9227 Py_ssize_t cnt, n;
9228 int async_err = 0;
9229 struct iovec *iov;
9230 Py_buffer *buf;
9231
9232 if (!PySequence_Check(buffers)) {
9233 PyErr_SetString(PyExc_TypeError,
9234 "preadv2() arg 2 must be a sequence");
9235 return -1;
9236 }
9237
9238 cnt = PySequence_Size(buffers);
9239 if (cnt < 0) {
9240 return -1;
9241 }
9242
9243#ifndef HAVE_PREADV2
9244 if(flags != 0) {
9245 argument_unavailable_error("preadv2", "flags");
9246 return -1;
9247 }
9248#endif
9249
9250 if (iov_setup(&iov, &buf, buffers, cnt, PyBUF_WRITABLE) < 0) {
9251 return -1;
9252 }
9253#ifdef HAVE_PREADV2
9254 do {
9255 Py_BEGIN_ALLOW_THREADS
9256 _Py_BEGIN_SUPPRESS_IPH
9257 n = preadv2(fd, iov, cnt, offset, flags);
9258 _Py_END_SUPPRESS_IPH
9259 Py_END_ALLOW_THREADS
9260 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
9261#else
9262 do {
9263 Py_BEGIN_ALLOW_THREADS
9264 _Py_BEGIN_SUPPRESS_IPH
9265 n = preadv(fd, iov, cnt, offset);
9266 _Py_END_SUPPRESS_IPH
9267 Py_END_ALLOW_THREADS
9268 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
9269#endif
9270
9271 iov_cleanup(iov, buf, cnt);
9272 if (n < 0) {
9273 if (!async_err) {
9274 posix_error();
9275 }
9276 return -1;
9277 }
9278
9279 return n;
9280}
9281#endif /* HAVE_PREADV */
9282
Larry Hastings2f936352014-08-05 14:04:04 +10009283
9284/*[clinic input]
9285os.write -> Py_ssize_t
9286
9287 fd: int
9288 data: Py_buffer
9289 /
9290
9291Write a bytes object to a file descriptor.
9292[clinic start generated code]*/
9293
Larry Hastings2f936352014-08-05 14:04:04 +10009294static Py_ssize_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009295os_write_impl(PyObject *module, int fd, Py_buffer *data)
9296/*[clinic end generated code: output=e4ef5bc904b58ef9 input=3207e28963234f3c]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009297{
Victor Stinner66aab0c2015-03-19 22:53:20 +01009298 return _Py_write(fd, data->buf, data->len);
Ross Lagerwall7807c352011-03-17 20:20:30 +02009299}
9300
9301#ifdef HAVE_SENDFILE
Serhiy Storchaka2b560312020-04-18 19:14:10 +03009302#ifdef __APPLE__
9303/*[clinic input]
9304os.sendfile
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009305
Serhiy Storchaka2b560312020-04-18 19:14:10 +03009306 out_fd: int
9307 in_fd: int
9308 offset: Py_off_t
9309 count as sbytes: Py_off_t
9310 headers: object(c_default="NULL") = ()
9311 trailers: object(c_default="NULL") = ()
9312 flags: int = 0
9313
9314Copy count bytes from file descriptor in_fd to file descriptor out_fd.
9315[clinic start generated code]*/
9316
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009317static PyObject *
Serhiy Storchaka2b560312020-04-18 19:14:10 +03009318os_sendfile_impl(PyObject *module, int out_fd, int in_fd, Py_off_t offset,
9319 Py_off_t sbytes, PyObject *headers, PyObject *trailers,
9320 int flags)
9321/*[clinic end generated code: output=81c4bcd143f5c82b input=b0d72579d4c69afa]*/
9322#elif defined(__FreeBSD__) || defined(__DragonFly__)
9323/*[clinic input]
9324os.sendfile
9325
9326 out_fd: int
9327 in_fd: int
9328 offset: Py_off_t
9329 count: Py_ssize_t
9330 headers: object(c_default="NULL") = ()
9331 trailers: object(c_default="NULL") = ()
9332 flags: int = 0
9333
9334Copy count bytes from file descriptor in_fd to file descriptor out_fd.
9335[clinic start generated code]*/
9336
9337static PyObject *
9338os_sendfile_impl(PyObject *module, int out_fd, int in_fd, Py_off_t offset,
9339 Py_ssize_t count, PyObject *headers, PyObject *trailers,
9340 int flags)
9341/*[clinic end generated code: output=329ea009bdd55afc input=338adb8ff84ae8cd]*/
9342#else
9343/*[clinic input]
9344os.sendfile
9345
9346 out_fd: int
9347 in_fd: int
9348 offset as offobj: object
9349 count: Py_ssize_t
9350
9351Copy count bytes from file descriptor in_fd to file descriptor out_fd.
9352[clinic start generated code]*/
9353
9354static PyObject *
9355os_sendfile_impl(PyObject *module, int out_fd, int in_fd, PyObject *offobj,
9356 Py_ssize_t count)
9357/*[clinic end generated code: output=ae81216e40f167d8 input=76d64058c74477ba]*/
9358#endif
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009359{
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009360 Py_ssize_t ret;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009361 int async_err = 0;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009362
9363#if defined(__FreeBSD__) || defined(__DragonFly__) || defined(__APPLE__)
9364#ifndef __APPLE__
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009365 off_t sbytes;
Serhiy Storchaka2b560312020-04-18 19:14:10 +03009366#endif
9367 Py_buffer *hbuf, *tbuf;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009368 struct sf_hdtr sf;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009369
Victor Stinner6ce0dbf2013-07-07 16:32:36 +02009370 sf.headers = NULL;
9371 sf.trailers = NULL;
9372
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009373 if (headers != NULL) {
9374 if (!PySequence_Check(headers)) {
9375 PyErr_SetString(PyExc_TypeError,
Martin Panter94994132015-09-09 05:29:24 +00009376 "sendfile() headers must be a sequence");
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009377 return NULL;
9378 } else {
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009379 Py_ssize_t i = PySequence_Size(headers);
9380 if (i < 0)
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009381 return NULL;
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009382 if (i > INT_MAX) {
9383 PyErr_SetString(PyExc_OverflowError,
9384 "sendfile() header is too large");
9385 return NULL;
9386 }
9387 if (i > 0) {
9388 sf.hdr_cnt = (int)i;
Serhiy Storchaka9d572732018-07-31 10:24:54 +03009389 if (iov_setup(&(sf.headers), &hbuf,
9390 headers, sf.hdr_cnt, PyBUF_SIMPLE) < 0)
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009391 return NULL;
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00009392#ifdef __APPLE__
Serhiy Storchaka9d572732018-07-31 10:24:54 +03009393 for (i = 0; i < sf.hdr_cnt; i++) {
9394 Py_ssize_t blen = sf.headers[i].iov_len;
9395# define OFF_T_MAX 0x7fffffffffffffff
9396 if (sbytes >= OFF_T_MAX - blen) {
9397 PyErr_SetString(PyExc_OverflowError,
9398 "sendfile() header is too large");
9399 return NULL;
9400 }
9401 sbytes += blen;
9402 }
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00009403#endif
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009404 }
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009405 }
9406 }
9407 if (trailers != NULL) {
9408 if (!PySequence_Check(trailers)) {
9409 PyErr_SetString(PyExc_TypeError,
Martin Panter94994132015-09-09 05:29:24 +00009410 "sendfile() trailers must be a sequence");
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009411 return NULL;
9412 } else {
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009413 Py_ssize_t i = PySequence_Size(trailers);
9414 if (i < 0)
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009415 return NULL;
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009416 if (i > INT_MAX) {
9417 PyErr_SetString(PyExc_OverflowError,
9418 "sendfile() trailer is too large");
9419 return NULL;
9420 }
9421 if (i > 0) {
9422 sf.trl_cnt = (int)i;
Serhiy Storchaka9d572732018-07-31 10:24:54 +03009423 if (iov_setup(&(sf.trailers), &tbuf,
9424 trailers, sf.trl_cnt, PyBUF_SIMPLE) < 0)
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009425 return NULL;
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009426 }
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009427 }
9428 }
9429
Steve Dower8fc89802015-04-12 00:26:27 -04009430 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009431 do {
9432 Py_BEGIN_ALLOW_THREADS
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009433#ifdef __APPLE__
Serhiy Storchaka2b560312020-04-18 19:14:10 +03009434 ret = sendfile(in_fd, out_fd, offset, &sbytes, &sf, flags);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009435#else
Serhiy Storchaka2b560312020-04-18 19:14:10 +03009436 ret = sendfile(in_fd, out_fd, offset, count, &sf, &sbytes, flags);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009437#endif
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009438 Py_END_ALLOW_THREADS
9439 } while (ret < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Steve Dower8fc89802015-04-12 00:26:27 -04009440 _Py_END_SUPPRESS_IPH
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009441
9442 if (sf.headers != NULL)
9443 iov_cleanup(sf.headers, hbuf, sf.hdr_cnt);
9444 if (sf.trailers != NULL)
9445 iov_cleanup(sf.trailers, tbuf, sf.trl_cnt);
9446
9447 if (ret < 0) {
9448 if ((errno == EAGAIN) || (errno == EBUSY)) {
9449 if (sbytes != 0) {
9450 // some data has been sent
9451 goto done;
9452 }
9453 else {
9454 // no data has been sent; upper application is supposed
9455 // to retry on EAGAIN or EBUSY
9456 return posix_error();
9457 }
9458 }
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009459 return (!async_err) ? posix_error() : NULL;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009460 }
9461 goto done;
9462
9463done:
9464 #if !defined(HAVE_LARGEFILE_SUPPORT)
9465 return Py_BuildValue("l", sbytes);
9466 #else
9467 return Py_BuildValue("L", sbytes);
9468 #endif
9469
9470#else
Benjamin Peterson840ef8f2016-09-07 14:45:10 -07009471#ifdef __linux__
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009472 if (offobj == Py_None) {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009473 do {
9474 Py_BEGIN_ALLOW_THREADS
Serhiy Storchaka2b560312020-04-18 19:14:10 +03009475 ret = sendfile(out_fd, in_fd, NULL, count);
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009476 Py_END_ALLOW_THREADS
9477 } while (ret < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009478 if (ret < 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009479 return (!async_err) ? posix_error() : NULL;
Giampaolo Rodola'ff1a7352011-04-19 09:47:16 +02009480 return Py_BuildValue("n", ret);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009481 }
9482#endif
Serhiy Storchaka2b560312020-04-18 19:14:10 +03009483 off_t offset;
Larry Hastings2f936352014-08-05 14:04:04 +10009484 if (!Py_off_t_converter(offobj, &offset))
Antoine Pitroudcc20b82011-02-26 13:38:35 +00009485 return NULL;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009486
9487 do {
9488 Py_BEGIN_ALLOW_THREADS
Serhiy Storchaka2b560312020-04-18 19:14:10 +03009489 ret = sendfile(out_fd, in_fd, &offset, count);
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009490 Py_END_ALLOW_THREADS
9491 } while (ret < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009492 if (ret < 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009493 return (!async_err) ? posix_error() : NULL;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009494 return Py_BuildValue("n", ret);
9495#endif
9496}
Larry Hastings2f936352014-08-05 14:04:04 +10009497#endif /* HAVE_SENDFILE */
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00009498
Larry Hastings2f936352014-08-05 14:04:04 +10009499
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +02009500#if defined(__APPLE__)
9501/*[clinic input]
9502os._fcopyfile
9503
Serhiy Storchaka140a7d12019-10-13 11:59:31 +03009504 in_fd: int
9505 out_fd: int
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +02009506 flags: int
9507 /
9508
Giampaolo Rodolac7f02a92018-06-19 08:27:29 -07009509Efficiently copy content or metadata of 2 regular file descriptors (macOS).
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +02009510[clinic start generated code]*/
9511
9512static PyObject *
Serhiy Storchaka140a7d12019-10-13 11:59:31 +03009513os__fcopyfile_impl(PyObject *module, int in_fd, int out_fd, int flags)
9514/*[clinic end generated code: output=c9d1a35a992e401b input=1e34638a86948795]*/
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +02009515{
9516 int ret;
9517
9518 Py_BEGIN_ALLOW_THREADS
Serhiy Storchaka140a7d12019-10-13 11:59:31 +03009519 ret = fcopyfile(in_fd, out_fd, NULL, flags);
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +02009520 Py_END_ALLOW_THREADS
9521 if (ret < 0)
9522 return posix_error();
9523 Py_RETURN_NONE;
9524}
9525#endif
9526
9527
Larry Hastings2f936352014-08-05 14:04:04 +10009528/*[clinic input]
9529os.fstat
9530
9531 fd : int
9532
9533Perform a stat system call on the given file descriptor.
9534
9535Like stat(), but for an open file descriptor.
9536Equivalent to os.stat(fd).
9537[clinic start generated code]*/
9538
Larry Hastings2f936352014-08-05 14:04:04 +10009539static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009540os_fstat_impl(PyObject *module, int fd)
9541/*[clinic end generated code: output=efc038cb5f654492 input=27e0e0ebbe5600c9]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009542{
Victor Stinner8c62be82010-05-06 00:08:46 +00009543 STRUCT_STAT st;
9544 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009545 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10009546
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009547 do {
9548 Py_BEGIN_ALLOW_THREADS
9549 res = FSTAT(fd, &st);
9550 Py_END_ALLOW_THREADS
9551 } while (res != 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Victor Stinner8c62be82010-05-06 00:08:46 +00009552 if (res != 0) {
Martin v. Löwis14694662006-02-03 12:54:16 +00009553#ifdef MS_WINDOWS
Victor Stinnerb024e842012-10-31 22:24:06 +01009554 return PyErr_SetFromWindowsErr(0);
Martin v. Löwis14694662006-02-03 12:54:16 +00009555#else
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009556 return (!async_err) ? posix_error() : NULL;
Martin v. Löwis14694662006-02-03 12:54:16 +00009557#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00009558 }
Tim Peters5aa91602002-01-30 05:46:57 +00009559
Victor Stinner1c2fa782020-05-10 11:05:29 +02009560 return _pystat_fromstructstat(module, &st);
Guido van Rossum687dd131993-05-17 08:34:16 +00009561}
9562
Larry Hastings2f936352014-08-05 14:04:04 +10009563
9564/*[clinic input]
9565os.isatty -> bool
9566 fd: int
9567 /
9568
9569Return True if the fd is connected to a terminal.
9570
9571Return True if the file descriptor is an open file descriptor
9572connected to the slave end of a terminal.
9573[clinic start generated code]*/
9574
Larry Hastings2f936352014-08-05 14:04:04 +10009575static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009576os_isatty_impl(PyObject *module, int fd)
9577/*[clinic end generated code: output=6a48c8b4e644ca00 input=08ce94aa1eaf7b5e]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009578{
Steve Dower8fc89802015-04-12 00:26:27 -04009579 int return_value;
Steve Dower8fc89802015-04-12 00:26:27 -04009580 _Py_BEGIN_SUPPRESS_IPH
9581 return_value = isatty(fd);
9582 _Py_END_SUPPRESS_IPH
9583 return return_value;
Larry Hastings2f936352014-08-05 14:04:04 +10009584}
9585
9586
Guido van Rossuma4916fa1996-05-23 22:58:55 +00009587#ifdef HAVE_PIPE
Larry Hastings2f936352014-08-05 14:04:04 +10009588/*[clinic input]
9589os.pipe
9590
9591Create a pipe.
9592
9593Returns a tuple of two file descriptors:
9594 (read_fd, write_fd)
9595[clinic start generated code]*/
9596
Larry Hastings2f936352014-08-05 14:04:04 +10009597static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009598os_pipe_impl(PyObject *module)
9599/*[clinic end generated code: output=ff9b76255793b440 input=02535e8c8fa6c4d4]*/
Guido van Rossum687dd131993-05-17 08:34:16 +00009600{
Victor Stinner8c62be82010-05-06 00:08:46 +00009601 int fds[2];
Victor Stinnerdaf45552013-08-28 00:53:59 +02009602#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00009603 HANDLE read, write;
Victor Stinnerdaf45552013-08-28 00:53:59 +02009604 SECURITY_ATTRIBUTES attr;
Victor Stinner8c62be82010-05-06 00:08:46 +00009605 BOOL ok;
Victor Stinnerdaf45552013-08-28 00:53:59 +02009606#else
9607 int res;
9608#endif
9609
9610#ifdef MS_WINDOWS
9611 attr.nLength = sizeof(attr);
9612 attr.lpSecurityDescriptor = NULL;
9613 attr.bInheritHandle = FALSE;
9614
9615 Py_BEGIN_ALLOW_THREADS
Steve Dowerc3630612016-11-19 18:41:16 -08009616 _Py_BEGIN_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02009617 ok = CreatePipe(&read, &write, &attr, 0);
9618 if (ok) {
Benjamin Petersonca470632016-09-06 13:47:26 -07009619 fds[0] = _open_osfhandle((intptr_t)read, _O_RDONLY);
9620 fds[1] = _open_osfhandle((intptr_t)write, _O_WRONLY);
Victor Stinnerdaf45552013-08-28 00:53:59 +02009621 if (fds[0] == -1 || fds[1] == -1) {
9622 CloseHandle(read);
9623 CloseHandle(write);
9624 ok = 0;
9625 }
9626 }
Steve Dowerc3630612016-11-19 18:41:16 -08009627 _Py_END_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02009628 Py_END_ALLOW_THREADS
9629
Victor Stinner8c62be82010-05-06 00:08:46 +00009630 if (!ok)
Victor Stinnerb024e842012-10-31 22:24:06 +01009631 return PyErr_SetFromWindowsErr(0);
Victor Stinnerdaf45552013-08-28 00:53:59 +02009632#else
9633
9634#ifdef HAVE_PIPE2
9635 Py_BEGIN_ALLOW_THREADS
9636 res = pipe2(fds, O_CLOEXEC);
9637 Py_END_ALLOW_THREADS
9638
9639 if (res != 0 && errno == ENOSYS)
9640 {
9641#endif
9642 Py_BEGIN_ALLOW_THREADS
9643 res = pipe(fds);
9644 Py_END_ALLOW_THREADS
9645
9646 if (res == 0) {
9647 if (_Py_set_inheritable(fds[0], 0, NULL) < 0) {
9648 close(fds[0]);
9649 close(fds[1]);
9650 return NULL;
9651 }
9652 if (_Py_set_inheritable(fds[1], 0, NULL) < 0) {
9653 close(fds[0]);
9654 close(fds[1]);
9655 return NULL;
9656 }
9657 }
9658#ifdef HAVE_PIPE2
9659 }
9660#endif
9661
9662 if (res != 0)
9663 return PyErr_SetFromErrno(PyExc_OSError);
9664#endif /* !MS_WINDOWS */
9665 return Py_BuildValue("(ii)", fds[0], fds[1]);
Guido van Rossum687dd131993-05-17 08:34:16 +00009666}
Guido van Rossuma4916fa1996-05-23 22:58:55 +00009667#endif /* HAVE_PIPE */
9668
Larry Hastings2f936352014-08-05 14:04:04 +10009669
Charles-François Natalidaafdd52011-05-29 20:07:40 +02009670#ifdef HAVE_PIPE2
Larry Hastings2f936352014-08-05 14:04:04 +10009671/*[clinic input]
9672os.pipe2
9673
9674 flags: int
9675 /
9676
9677Create a pipe with flags set atomically.
9678
9679Returns a tuple of two file descriptors:
9680 (read_fd, write_fd)
9681
9682flags can be constructed by ORing together one or more of these values:
9683O_NONBLOCK, O_CLOEXEC.
9684[clinic start generated code]*/
9685
Larry Hastings2f936352014-08-05 14:04:04 +10009686static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009687os_pipe2_impl(PyObject *module, int flags)
9688/*[clinic end generated code: output=25751fb43a45540f input=f261b6e7e63c6817]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009689{
Charles-François Natalidaafdd52011-05-29 20:07:40 +02009690 int fds[2];
9691 int res;
9692
Charles-François Natalidaafdd52011-05-29 20:07:40 +02009693 res = pipe2(fds, flags);
9694 if (res != 0)
9695 return posix_error();
9696 return Py_BuildValue("(ii)", fds[0], fds[1]);
9697}
9698#endif /* HAVE_PIPE2 */
9699
Larry Hastings2f936352014-08-05 14:04:04 +10009700
Ross Lagerwall7807c352011-03-17 20:20:30 +02009701#ifdef HAVE_WRITEV
Larry Hastings2f936352014-08-05 14:04:04 +10009702/*[clinic input]
9703os.writev -> Py_ssize_t
9704 fd: int
9705 buffers: object
9706 /
9707
9708Iterate over buffers, and write the contents of each to a file descriptor.
9709
9710Returns the total number of bytes written.
9711buffers must be a sequence of bytes-like objects.
9712[clinic start generated code]*/
9713
Larry Hastings2f936352014-08-05 14:04:04 +10009714static Py_ssize_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009715os_writev_impl(PyObject *module, int fd, PyObject *buffers)
9716/*[clinic end generated code: output=56565cfac3aac15b input=5b8d17fe4189d2fe]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009717{
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009718 Py_ssize_t cnt;
Larry Hastings2f936352014-08-05 14:04:04 +10009719 Py_ssize_t result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009720 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009721 struct iovec *iov;
9722 Py_buffer *buf;
Larry Hastings2f936352014-08-05 14:04:04 +10009723
9724 if (!PySequence_Check(buffers)) {
Ross Lagerwall7807c352011-03-17 20:20:30 +02009725 PyErr_SetString(PyExc_TypeError,
9726 "writev() arg 2 must be a sequence");
Larry Hastings2f936352014-08-05 14:04:04 +10009727 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009728 }
Larry Hastings2f936352014-08-05 14:04:04 +10009729 cnt = PySequence_Size(buffers);
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009730 if (cnt < 0)
9731 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009732
Larry Hastings2f936352014-08-05 14:04:04 +10009733 if (iov_setup(&iov, &buf, buffers, cnt, PyBUF_SIMPLE) < 0) {
9734 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009735 }
9736
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009737 do {
9738 Py_BEGIN_ALLOW_THREADS
9739 result = writev(fd, iov, cnt);
9740 Py_END_ALLOW_THREADS
9741 } while (result < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Ross Lagerwall7807c352011-03-17 20:20:30 +02009742
9743 iov_cleanup(iov, buf, cnt);
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009744 if (result < 0 && !async_err)
Larry Hastings2f936352014-08-05 14:04:04 +10009745 posix_error();
Victor Stinner57ddf782014-01-08 15:21:28 +01009746
Georg Brandl306336b2012-06-24 12:55:33 +02009747 return result;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009748}
Larry Hastings2f936352014-08-05 14:04:04 +10009749#endif /* HAVE_WRITEV */
9750
9751
9752#ifdef HAVE_PWRITE
9753/*[clinic input]
9754os.pwrite -> Py_ssize_t
9755
9756 fd: int
9757 buffer: Py_buffer
9758 offset: Py_off_t
9759 /
9760
9761Write bytes to a file descriptor starting at a particular offset.
9762
9763Write buffer to fd, starting at offset bytes from the beginning of
9764the file. Returns the number of bytes writte. Does not change the
9765current file offset.
9766[clinic start generated code]*/
9767
Larry Hastings2f936352014-08-05 14:04:04 +10009768static Py_ssize_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009769os_pwrite_impl(PyObject *module, int fd, Py_buffer *buffer, Py_off_t offset)
9770/*[clinic end generated code: output=c74da630758ee925 input=19903f1b3dd26377]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009771{
9772 Py_ssize_t size;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009773 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10009774
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009775 do {
9776 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04009777 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009778 size = pwrite(fd, buffer->buf, (size_t)buffer->len, offset);
Steve Dower8fc89802015-04-12 00:26:27 -04009779 _Py_END_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009780 Py_END_ALLOW_THREADS
9781 } while (size < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Larry Hastings2f936352014-08-05 14:04:04 +10009782
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009783 if (size < 0 && !async_err)
Larry Hastings2f936352014-08-05 14:04:04 +10009784 posix_error();
9785 return size;
9786}
9787#endif /* HAVE_PWRITE */
9788
Pablo Galindo4defba32018-01-27 16:16:37 +00009789#if defined(HAVE_PWRITEV) || defined (HAVE_PWRITEV2)
9790/*[clinic input]
9791os.pwritev -> Py_ssize_t
9792
9793 fd: int
9794 buffers: object
9795 offset: Py_off_t
9796 flags: int = 0
9797 /
9798
9799Writes the contents of bytes-like objects to a file descriptor at a given offset.
9800
9801Combines the functionality of writev() and pwrite(). All buffers must be a sequence
9802of bytes-like objects. Buffers are processed in array order. Entire contents of first
9803buffer is written before proceeding to second, and so on. The operating system may
9804set a limit (sysconf() value SC_IOV_MAX) on the number of buffers that can be used.
9805This function writes the contents of each object to the file descriptor and returns
9806the total number of bytes written.
9807
9808The flags argument contains a bitwise OR of zero or more of the following flags:
9809
9810- RWF_DSYNC
9811- RWF_SYNC
YoSTEALTH76ef2552020-05-27 15:32:22 -06009812- RWF_APPEND
Pablo Galindo4defba32018-01-27 16:16:37 +00009813
9814Using non-zero flags requires Linux 4.7 or newer.
9815[clinic start generated code]*/
9816
9817static Py_ssize_t
9818os_pwritev_impl(PyObject *module, int fd, PyObject *buffers, Py_off_t offset,
9819 int flags)
YoSTEALTH76ef2552020-05-27 15:32:22 -06009820/*[clinic end generated code: output=e3dd3e9d11a6a5c7 input=35358c327e1a2a8e]*/
Pablo Galindo4defba32018-01-27 16:16:37 +00009821{
9822 Py_ssize_t cnt;
9823 Py_ssize_t result;
9824 int async_err = 0;
9825 struct iovec *iov;
9826 Py_buffer *buf;
9827
9828 if (!PySequence_Check(buffers)) {
9829 PyErr_SetString(PyExc_TypeError,
9830 "pwritev() arg 2 must be a sequence");
9831 return -1;
9832 }
9833
9834 cnt = PySequence_Size(buffers);
9835 if (cnt < 0) {
9836 return -1;
9837 }
9838
9839#ifndef HAVE_PWRITEV2
9840 if(flags != 0) {
9841 argument_unavailable_error("pwritev2", "flags");
9842 return -1;
9843 }
9844#endif
9845
9846 if (iov_setup(&iov, &buf, buffers, cnt, PyBUF_SIMPLE) < 0) {
9847 return -1;
9848 }
9849#ifdef HAVE_PWRITEV2
9850 do {
9851 Py_BEGIN_ALLOW_THREADS
9852 _Py_BEGIN_SUPPRESS_IPH
9853 result = pwritev2(fd, iov, cnt, offset, flags);
9854 _Py_END_SUPPRESS_IPH
9855 Py_END_ALLOW_THREADS
9856 } while (result < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
9857#else
9858 do {
9859 Py_BEGIN_ALLOW_THREADS
9860 _Py_BEGIN_SUPPRESS_IPH
9861 result = pwritev(fd, iov, cnt, offset);
9862 _Py_END_SUPPRESS_IPH
9863 Py_END_ALLOW_THREADS
9864 } while (result < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
9865#endif
9866
9867 iov_cleanup(iov, buf, cnt);
9868 if (result < 0) {
9869 if (!async_err) {
9870 posix_error();
9871 }
9872 return -1;
9873 }
9874
9875 return result;
9876}
9877#endif /* HAVE_PWRITEV */
9878
Pablo Galindoaac4d032019-05-31 19:39:47 +01009879#ifdef HAVE_COPY_FILE_RANGE
9880/*[clinic input]
9881
9882os.copy_file_range
9883 src: int
9884 Source file descriptor.
9885 dst: int
9886 Destination file descriptor.
9887 count: Py_ssize_t
9888 Number of bytes to copy.
9889 offset_src: object = None
9890 Starting offset in src.
9891 offset_dst: object = None
9892 Starting offset in dst.
9893
9894Copy count bytes from one file descriptor to another.
9895
9896If offset_src is None, then src is read from the current position;
9897respectively for offset_dst.
9898[clinic start generated code]*/
9899
9900static PyObject *
9901os_copy_file_range_impl(PyObject *module, int src, int dst, Py_ssize_t count,
9902 PyObject *offset_src, PyObject *offset_dst)
9903/*[clinic end generated code: output=1a91713a1d99fc7a input=42fdce72681b25a9]*/
9904{
9905 off_t offset_src_val, offset_dst_val;
9906 off_t *p_offset_src = NULL;
9907 off_t *p_offset_dst = NULL;
9908 Py_ssize_t ret;
9909 int async_err = 0;
9910 /* The flags argument is provided to allow
9911 * for future extensions and currently must be to 0. */
9912 int flags = 0;
Pablo Galindo4defba32018-01-27 16:16:37 +00009913
9914
Pablo Galindoaac4d032019-05-31 19:39:47 +01009915 if (count < 0) {
9916 PyErr_SetString(PyExc_ValueError, "negative value for 'count' not allowed");
9917 return NULL;
9918 }
9919
9920 if (offset_src != Py_None) {
9921 if (!Py_off_t_converter(offset_src, &offset_src_val)) {
9922 return NULL;
9923 }
9924 p_offset_src = &offset_src_val;
9925 }
9926
9927 if (offset_dst != Py_None) {
9928 if (!Py_off_t_converter(offset_dst, &offset_dst_val)) {
9929 return NULL;
9930 }
9931 p_offset_dst = &offset_dst_val;
9932 }
9933
9934 do {
9935 Py_BEGIN_ALLOW_THREADS
9936 ret = copy_file_range(src, p_offset_src, dst, p_offset_dst, count, flags);
9937 Py_END_ALLOW_THREADS
9938 } while (ret < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
9939
9940 if (ret < 0) {
9941 return (!async_err) ? posix_error() : NULL;
9942 }
9943
9944 return PyLong_FromSsize_t(ret);
9945}
9946#endif /* HAVE_COPY_FILE_RANGE*/
Larry Hastings2f936352014-08-05 14:04:04 +10009947
9948#ifdef HAVE_MKFIFO
9949/*[clinic input]
9950os.mkfifo
9951
9952 path: path_t
9953 mode: int=0o666
9954 *
9955 dir_fd: dir_fd(requires='mkfifoat')=None
9956
9957Create a "fifo" (a POSIX named pipe).
9958
9959If dir_fd is not None, it should be a file descriptor open to a directory,
9960 and path should be relative; path will then be relative to that directory.
9961dir_fd may not be implemented on your platform.
9962 If it is unavailable, using it will raise a NotImplementedError.
9963[clinic start generated code]*/
9964
Larry Hastings2f936352014-08-05 14:04:04 +10009965static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009966os_mkfifo_impl(PyObject *module, path_t *path, int mode, int dir_fd)
9967/*[clinic end generated code: output=ce41cfad0e68c940 input=73032e98a36e0e19]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009968{
9969 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009970 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10009971
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009972 do {
9973 Py_BEGIN_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10009974#ifdef HAVE_MKFIFOAT
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009975 if (dir_fd != DEFAULT_DIR_FD)
9976 result = mkfifoat(dir_fd, path->narrow, mode);
9977 else
Ross Lagerwall7807c352011-03-17 20:20:30 +02009978#endif
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009979 result = mkfifo(path->narrow, mode);
9980 Py_END_ALLOW_THREADS
9981 } while (result != 0 && errno == EINTR &&
9982 !(async_err = PyErr_CheckSignals()));
9983 if (result != 0)
9984 return (!async_err) ? posix_error() : NULL;
Larry Hastings2f936352014-08-05 14:04:04 +10009985
9986 Py_RETURN_NONE;
9987}
9988#endif /* HAVE_MKFIFO */
9989
9990
9991#if defined(HAVE_MKNOD) && defined(HAVE_MAKEDEV)
9992/*[clinic input]
9993os.mknod
9994
9995 path: path_t
9996 mode: int=0o600
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +02009997 device: dev_t=0
Larry Hastings2f936352014-08-05 14:04:04 +10009998 *
9999 dir_fd: dir_fd(requires='mknodat')=None
10000
10001Create a node in the file system.
10002
10003Create a node in the file system (file, device special file or named pipe)
10004at path. mode specifies both the permissions to use and the
10005type of node to be created, being combined (bitwise OR) with one of
10006S_IFREG, S_IFCHR, S_IFBLK, and S_IFIFO. If S_IFCHR or S_IFBLK is set on mode,
10007device defines the newly created device special file (probably using
10008os.makedev()). Otherwise device is ignored.
10009
10010If dir_fd is not None, it should be a file descriptor open to a directory,
10011 and path should be relative; path will then be relative to that directory.
10012dir_fd may not be implemented on your platform.
10013 If it is unavailable, using it will raise a NotImplementedError.
10014[clinic start generated code]*/
10015
Larry Hastings2f936352014-08-05 14:04:04 +100010016static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010017os_mknod_impl(PyObject *module, path_t *path, int mode, dev_t device,
Larry Hastings89964c42015-04-14 18:07:59 -040010018 int dir_fd)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010019/*[clinic end generated code: output=92e55d3ca8917461 input=ee44531551a4d83b]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010020{
10021 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010022 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +100010023
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010024 do {
10025 Py_BEGIN_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +100010026#ifdef HAVE_MKNODAT
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010027 if (dir_fd != DEFAULT_DIR_FD)
10028 result = mknodat(dir_fd, path->narrow, mode, device);
10029 else
Larry Hastings2f936352014-08-05 14:04:04 +100010030#endif
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010031 result = mknod(path->narrow, mode, device);
10032 Py_END_ALLOW_THREADS
10033 } while (result != 0 && errno == EINTR &&
10034 !(async_err = PyErr_CheckSignals()));
10035 if (result != 0)
10036 return (!async_err) ? posix_error() : NULL;
Larry Hastings2f936352014-08-05 14:04:04 +100010037
10038 Py_RETURN_NONE;
10039}
10040#endif /* defined(HAVE_MKNOD) && defined(HAVE_MAKEDEV) */
10041
10042
10043#ifdef HAVE_DEVICE_MACROS
10044/*[clinic input]
10045os.major -> unsigned_int
10046
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +020010047 device: dev_t
Larry Hastings2f936352014-08-05 14:04:04 +100010048 /
10049
10050Extracts a device major number from a raw device number.
10051[clinic start generated code]*/
10052
Larry Hastings2f936352014-08-05 14:04:04 +100010053static unsigned int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010054os_major_impl(PyObject *module, dev_t device)
10055/*[clinic end generated code: output=5b3b2589bafb498e input=1e16a4d30c4d4462]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010056{
10057 return major(device);
10058}
10059
10060
10061/*[clinic input]
10062os.minor -> unsigned_int
10063
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +020010064 device: dev_t
Larry Hastings2f936352014-08-05 14:04:04 +100010065 /
10066
10067Extracts a device minor number from a raw device number.
10068[clinic start generated code]*/
10069
Larry Hastings2f936352014-08-05 14:04:04 +100010070static unsigned int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010071os_minor_impl(PyObject *module, dev_t device)
10072/*[clinic end generated code: output=5e1a25e630b0157d input=0842c6d23f24c65e]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010073{
10074 return minor(device);
10075}
10076
10077
10078/*[clinic input]
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +020010079os.makedev -> dev_t
Larry Hastings2f936352014-08-05 14:04:04 +100010080
10081 major: int
10082 minor: int
10083 /
10084
10085Composes a raw device number from the major and minor device numbers.
10086[clinic start generated code]*/
10087
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +020010088static dev_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010089os_makedev_impl(PyObject *module, int major, int minor)
10090/*[clinic end generated code: output=881aaa4aba6f6a52 input=4b9fd8fc73cbe48f]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010091{
10092 return makedev(major, minor);
10093}
10094#endif /* HAVE_DEVICE_MACROS */
10095
10096
Steve Dowerfe0a41a2015-03-20 19:50:46 -070010097#if defined HAVE_FTRUNCATE || defined MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +100010098/*[clinic input]
10099os.ftruncate
10100
10101 fd: int
10102 length: Py_off_t
10103 /
10104
10105Truncate a file, specified by file descriptor, to a specific length.
10106[clinic start generated code]*/
10107
Larry Hastings2f936352014-08-05 14:04:04 +100010108static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010109os_ftruncate_impl(PyObject *module, int fd, Py_off_t length)
10110/*[clinic end generated code: output=fba15523721be7e4 input=63b43641e52818f2]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010111{
10112 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010113 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +100010114
Steve Dowerb82e17e2019-05-23 08:45:22 -070010115 if (PySys_Audit("os.truncate", "in", fd, length) < 0) {
10116 return NULL;
10117 }
10118
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010119 do {
10120 Py_BEGIN_ALLOW_THREADS
Steve Dowera1c7e722015-04-12 00:26:43 -040010121 _Py_BEGIN_SUPPRESS_IPH
Steve Dowerfe0a41a2015-03-20 19:50:46 -070010122#ifdef MS_WINDOWS
10123 result = _chsize_s(fd, length);
10124#else
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010125 result = ftruncate(fd, length);
Steve Dowerfe0a41a2015-03-20 19:50:46 -070010126#endif
Steve Dowera1c7e722015-04-12 00:26:43 -040010127 _Py_END_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010128 Py_END_ALLOW_THREADS
10129 } while (result != 0 && errno == EINTR &&
10130 !(async_err = PyErr_CheckSignals()));
10131 if (result != 0)
10132 return (!async_err) ? posix_error() : NULL;
Larry Hastings2f936352014-08-05 14:04:04 +100010133 Py_RETURN_NONE;
10134}
Steve Dowerfe0a41a2015-03-20 19:50:46 -070010135#endif /* HAVE_FTRUNCATE || MS_WINDOWS */
Larry Hastings2f936352014-08-05 14:04:04 +100010136
10137
Steve Dowerfe0a41a2015-03-20 19:50:46 -070010138#if defined HAVE_TRUNCATE || defined MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +100010139/*[clinic input]
10140os.truncate
10141 path: path_t(allow_fd='PATH_HAVE_FTRUNCATE')
10142 length: Py_off_t
10143
10144Truncate a file, specified by path, to a specific length.
10145
10146On some platforms, path may also be specified as an open file descriptor.
10147 If this functionality is unavailable, using it raises an exception.
10148[clinic start generated code]*/
10149
Larry Hastings2f936352014-08-05 14:04:04 +100010150static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010151os_truncate_impl(PyObject *module, path_t *path, Py_off_t length)
10152/*[clinic end generated code: output=43009c8df5c0a12b input=77229cf0b50a9b77]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010153{
10154 int result;
Steve Dowerfe0a41a2015-03-20 19:50:46 -070010155#ifdef MS_WINDOWS
10156 int fd;
10157#endif
10158
10159 if (path->fd != -1)
10160 return os_ftruncate_impl(module, path->fd, length);
Larry Hastings2f936352014-08-05 14:04:04 +100010161
Steve Dowerb82e17e2019-05-23 08:45:22 -070010162 if (PySys_Audit("os.truncate", "On", path->object, length) < 0) {
10163 return NULL;
10164 }
10165
Larry Hastings2f936352014-08-05 14:04:04 +100010166 Py_BEGIN_ALLOW_THREADS
Steve Dowera1c7e722015-04-12 00:26:43 -040010167 _Py_BEGIN_SUPPRESS_IPH
Steve Dowerfe0a41a2015-03-20 19:50:46 -070010168#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -070010169 fd = _wopen(path->wide, _O_WRONLY | _O_BINARY | _O_NOINHERIT);
Victor Stinnercc0bbbc2015-04-25 00:21:52 +020010170 if (fd < 0)
Steve Dowerfe0a41a2015-03-20 19:50:46 -070010171 result = -1;
10172 else {
10173 result = _chsize_s(fd, length);
10174 close(fd);
10175 if (result < 0)
10176 errno = result;
10177 }
10178#else
10179 result = truncate(path->narrow, length);
Larry Hastings2f936352014-08-05 14:04:04 +100010180#endif
Steve Dowera1c7e722015-04-12 00:26:43 -040010181 _Py_END_SUPPRESS_IPH
Larry Hastings2f936352014-08-05 14:04:04 +100010182 Py_END_ALLOW_THREADS
10183 if (result < 0)
Alexey Izbyshev83460312018-10-20 03:28:22 +030010184 return posix_path_error(path);
Larry Hastings2f936352014-08-05 14:04:04 +100010185
10186 Py_RETURN_NONE;
10187}
Steve Dowerfe0a41a2015-03-20 19:50:46 -070010188#endif /* HAVE_TRUNCATE || MS_WINDOWS */
Larry Hastings2f936352014-08-05 14:04:04 +100010189
Ross Lagerwall7807c352011-03-17 20:20:30 +020010190
Victor Stinnerd6b17692014-09-30 12:20:05 +020010191/* Issue #22396: On 32-bit AIX platform, the prototypes of os.posix_fadvise()
10192 and os.posix_fallocate() in system headers are wrong if _LARGE_FILES is
10193 defined, which is the case in Python on AIX. AIX bug report:
10194 http://www-01.ibm.com/support/docview.wss?uid=isg1IV56170 */
10195#if defined(_AIX) && defined(_LARGE_FILES) && !defined(__64BIT__)
10196# define POSIX_FADVISE_AIX_BUG
10197#endif
10198
Victor Stinnerec39e262014-09-30 12:35:58 +020010199
Victor Stinnerd6b17692014-09-30 12:20:05 +020010200#if defined(HAVE_POSIX_FALLOCATE) && !defined(POSIX_FADVISE_AIX_BUG)
Larry Hastings2f936352014-08-05 14:04:04 +100010201/*[clinic input]
10202os.posix_fallocate
10203
10204 fd: int
10205 offset: Py_off_t
10206 length: Py_off_t
10207 /
10208
10209Ensure a file has allocated at least a particular number of bytes on disk.
10210
10211Ensure that the file specified by fd encompasses a range of bytes
10212starting at offset bytes from the beginning and continuing for length bytes.
10213[clinic start generated code]*/
10214
Larry Hastings2f936352014-08-05 14:04:04 +100010215static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010216os_posix_fallocate_impl(PyObject *module, int fd, Py_off_t offset,
Larry Hastings89964c42015-04-14 18:07:59 -040010217 Py_off_t length)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010218/*[clinic end generated code: output=73f107139564aa9d input=d7a2ef0ab2ca52fb]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010219{
10220 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010221 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +020010222
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010223 do {
10224 Py_BEGIN_ALLOW_THREADS
10225 result = posix_fallocate(fd, offset, length);
10226 Py_END_ALLOW_THREADS
Коренберг Маркd4b93e22017-08-14 18:55:16 +050010227 } while (result == EINTR && !(async_err = PyErr_CheckSignals()));
10228
10229 if (result == 0)
10230 Py_RETURN_NONE;
10231
10232 if (async_err)
10233 return NULL;
10234
10235 errno = result;
10236 return posix_error();
Ross Lagerwall7807c352011-03-17 20:20:30 +020010237}
Victor Stinnerec39e262014-09-30 12:35:58 +020010238#endif /* HAVE_POSIX_FALLOCATE) && !POSIX_FADVISE_AIX_BUG */
Larry Hastings2f936352014-08-05 14:04:04 +100010239
Ross Lagerwall7807c352011-03-17 20:20:30 +020010240
Victor Stinnerd6b17692014-09-30 12:20:05 +020010241#if defined(HAVE_POSIX_FADVISE) && !defined(POSIX_FADVISE_AIX_BUG)
Larry Hastings2f936352014-08-05 14:04:04 +100010242/*[clinic input]
10243os.posix_fadvise
10244
10245 fd: int
10246 offset: Py_off_t
10247 length: Py_off_t
10248 advice: int
10249 /
10250
10251Announce an intention to access data in a specific pattern.
10252
10253Announce an intention to access data in a specific pattern, thus allowing
10254the kernel to make optimizations.
10255The advice applies to the region of the file specified by fd starting at
10256offset and continuing for length bytes.
10257advice is one of POSIX_FADV_NORMAL, POSIX_FADV_SEQUENTIAL,
10258POSIX_FADV_RANDOM, POSIX_FADV_NOREUSE, POSIX_FADV_WILLNEED, or
10259POSIX_FADV_DONTNEED.
10260[clinic start generated code]*/
10261
Larry Hastings2f936352014-08-05 14:04:04 +100010262static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010263os_posix_fadvise_impl(PyObject *module, int fd, Py_off_t offset,
Larry Hastings89964c42015-04-14 18:07:59 -040010264 Py_off_t length, int advice)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010265/*[clinic end generated code: output=412ef4aa70c98642 input=0fbe554edc2f04b5]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010266{
10267 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010268 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +020010269
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010270 do {
10271 Py_BEGIN_ALLOW_THREADS
10272 result = posix_fadvise(fd, offset, length, advice);
10273 Py_END_ALLOW_THREADS
Коренберг Маркd4b93e22017-08-14 18:55:16 +050010274 } while (result == EINTR && !(async_err = PyErr_CheckSignals()));
10275
10276 if (result == 0)
10277 Py_RETURN_NONE;
10278
10279 if (async_err)
10280 return NULL;
10281
10282 errno = result;
10283 return posix_error();
Ross Lagerwall7807c352011-03-17 20:20:30 +020010284}
Victor Stinnerec39e262014-09-30 12:35:58 +020010285#endif /* HAVE_POSIX_FADVISE && !POSIX_FADVISE_AIX_BUG */
Ross Lagerwall7807c352011-03-17 20:20:30 +020010286
Guido van Rossumec4f4ac1997-06-02 22:20:51 +000010287
Thomas Hellerf78f12a2007-11-08 19:33:05 +000010288#ifdef MS_WINDOWS
Victor Stinner161e7b32020-01-24 11:53:44 +010010289static PyObject*
10290win32_putenv(PyObject *name, PyObject *value)
10291{
10292 /* Search from index 1 because on Windows starting '=' is allowed for
10293 defining hidden environment variables. */
10294 if (PyUnicode_GET_LENGTH(name) == 0 ||
10295 PyUnicode_FindChar(name, '=', 1, PyUnicode_GET_LENGTH(name), 1) != -1)
10296 {
10297 PyErr_SetString(PyExc_ValueError, "illegal environment variable name");
10298 return NULL;
10299 }
10300 PyObject *unicode;
10301 if (value != NULL) {
10302 unicode = PyUnicode_FromFormat("%U=%U", name, value);
10303 }
10304 else {
10305 unicode = PyUnicode_FromFormat("%U=", name);
10306 }
10307 if (unicode == NULL) {
10308 return NULL;
10309 }
10310
10311 Py_ssize_t size;
10312 /* PyUnicode_AsWideCharString() rejects embedded null characters */
10313 wchar_t *env = PyUnicode_AsWideCharString(unicode, &size);
10314 Py_DECREF(unicode);
10315
10316 if (env == NULL) {
10317 return NULL;
10318 }
10319 if (size > _MAX_ENV) {
10320 PyErr_Format(PyExc_ValueError,
10321 "the environment variable is longer than %u characters",
10322 _MAX_ENV);
10323 PyMem_Free(env);
10324 return NULL;
10325 }
10326
10327 /* _wputenv() and SetEnvironmentVariableW() update the environment in the
10328 Process Environment Block (PEB). _wputenv() also updates CRT 'environ'
10329 and '_wenviron' variables, whereas SetEnvironmentVariableW() does not.
10330
10331 Prefer _wputenv() to be compatible with C libraries using CRT
10332 variables and CRT functions using these variables (ex: getenv()). */
10333 int err = _wputenv(env);
10334 PyMem_Free(env);
10335
10336 if (err) {
10337 posix_error();
10338 return NULL;
10339 }
10340
10341 Py_RETURN_NONE;
10342}
10343#endif
10344
10345
10346#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +100010347/*[clinic input]
10348os.putenv
10349
10350 name: unicode
10351 value: unicode
10352 /
10353
10354Change or add an environment variable.
10355[clinic start generated code]*/
10356
Larry Hastings2f936352014-08-05 14:04:04 +100010357static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010358os_putenv_impl(PyObject *module, PyObject *name, PyObject *value)
10359/*[clinic end generated code: output=d29a567d6b2327d2 input=ba586581c2e6105f]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010360{
Saiyang Gou7514f4f2020-02-12 23:47:42 -080010361 if (PySys_Audit("os.putenv", "OO", name, value) < 0) {
10362 return NULL;
10363 }
Victor Stinner161e7b32020-01-24 11:53:44 +010010364 return win32_putenv(name, value);
Guido van Rossumf1af3fe1996-07-23 19:18:10 +000010365}
Victor Stinnerb8d12622020-01-24 14:05:48 +010010366#else
Larry Hastings2f936352014-08-05 14:04:04 +100010367/*[clinic input]
10368os.putenv
Guido van Rossumb6a47161997-09-15 22:54:34 +000010369
Larry Hastings2f936352014-08-05 14:04:04 +100010370 name: FSConverter
10371 value: FSConverter
10372 /
10373
10374Change or add an environment variable.
10375[clinic start generated code]*/
10376
Larry Hastings2f936352014-08-05 14:04:04 +100010377static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010378os_putenv_impl(PyObject *module, PyObject *name, PyObject *value)
10379/*[clinic end generated code: output=d29a567d6b2327d2 input=a97bc6152f688d31]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010380{
Serhiy Storchaka77703942017-06-25 07:33:01 +030010381 const char *name_string = PyBytes_AS_STRING(name);
10382 const char *value_string = PyBytes_AS_STRING(value);
Larry Hastings2f936352014-08-05 14:04:04 +100010383
Serhiy Storchaka77703942017-06-25 07:33:01 +030010384 if (strchr(name_string, '=') != NULL) {
10385 PyErr_SetString(PyExc_ValueError, "illegal environment variable name");
10386 return NULL;
10387 }
Victor Stinnerb477d192020-01-22 22:48:16 +010010388
Saiyang Gou7514f4f2020-02-12 23:47:42 -080010389 if (PySys_Audit("os.putenv", "OO", name, value) < 0) {
10390 return NULL;
10391 }
10392
Victor Stinnerb477d192020-01-22 22:48:16 +010010393 if (setenv(name_string, value_string, 1)) {
10394 return posix_error();
10395 }
Larry Hastings2f936352014-08-05 14:04:04 +100010396 Py_RETURN_NONE;
10397}
Victor Stinnerb8d12622020-01-24 14:05:48 +010010398#endif /* !defined(MS_WINDOWS) */
Larry Hastings2f936352014-08-05 14:04:04 +100010399
10400
Victor Stinner161e7b32020-01-24 11:53:44 +010010401#ifdef MS_WINDOWS
10402/*[clinic input]
10403os.unsetenv
10404 name: unicode
10405 /
10406
10407Delete an environment variable.
10408[clinic start generated code]*/
10409
10410static PyObject *
10411os_unsetenv_impl(PyObject *module, PyObject *name)
10412/*[clinic end generated code: output=54c4137ab1834f02 input=4d6a1747cc526d2f]*/
10413{
Saiyang Gou7514f4f2020-02-12 23:47:42 -080010414 if (PySys_Audit("os.unsetenv", "(O)", name) < 0) {
10415 return NULL;
10416 }
Victor Stinner161e7b32020-01-24 11:53:44 +010010417 return win32_putenv(name, NULL);
10418}
Victor Stinnerb8d12622020-01-24 14:05:48 +010010419#else
Larry Hastings2f936352014-08-05 14:04:04 +100010420/*[clinic input]
10421os.unsetenv
10422 name: FSConverter
10423 /
10424
10425Delete an environment variable.
10426[clinic start generated code]*/
10427
Larry Hastings2f936352014-08-05 14:04:04 +100010428static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010429os_unsetenv_impl(PyObject *module, PyObject *name)
10430/*[clinic end generated code: output=54c4137ab1834f02 input=2bb5288a599c7107]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010431{
Saiyang Gou7514f4f2020-02-12 23:47:42 -080010432 if (PySys_Audit("os.unsetenv", "(O)", name) < 0) {
10433 return NULL;
10434 }
Victor Stinner984890f2011-11-24 13:53:38 +010010435#ifdef HAVE_BROKEN_UNSETENV
10436 unsetenv(PyBytes_AS_STRING(name));
10437#else
Victor Stinner161e7b32020-01-24 11:53:44 +010010438 int err = unsetenv(PyBytes_AS_STRING(name));
10439 if (err) {
Victor Stinner60b385e2011-11-22 22:01:28 +010010440 return posix_error();
Victor Stinner161e7b32020-01-24 11:53:44 +010010441 }
Victor Stinner984890f2011-11-24 13:53:38 +010010442#endif
Guido van Rossumc524d952001-10-19 01:31:59 +000010443
Victor Stinner84ae1182010-05-06 22:05:07 +000010444 Py_RETURN_NONE;
Guido van Rossumc524d952001-10-19 01:31:59 +000010445}
Victor Stinnerb8d12622020-01-24 14:05:48 +010010446#endif /* !MS_WINDOWS */
Guido van Rossumc524d952001-10-19 01:31:59 +000010447
Larry Hastings2f936352014-08-05 14:04:04 +100010448
10449/*[clinic input]
10450os.strerror
10451
10452 code: int
10453 /
10454
10455Translate an error code to a message string.
10456[clinic start generated code]*/
10457
Larry Hastings2f936352014-08-05 14:04:04 +100010458static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010459os_strerror_impl(PyObject *module, int code)
10460/*[clinic end generated code: output=baebf09fa02a78f2 input=75a8673d97915a91]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010461{
10462 char *message = strerror(code);
Victor Stinner8c62be82010-05-06 00:08:46 +000010463 if (message == NULL) {
10464 PyErr_SetString(PyExc_ValueError,
10465 "strerror() argument out of range");
10466 return NULL;
10467 }
Victor Stinner1b579672011-12-17 05:47:23 +010010468 return PyUnicode_DecodeLocale(message, "surrogateescape");
Guido van Rossumb6a47161997-09-15 22:54:34 +000010469}
Guido van Rossumb6a47161997-09-15 22:54:34 +000010470
Guido van Rossumf1af3fe1996-07-23 19:18:10 +000010471
Guido van Rossumc9641791998-08-04 15:26:23 +000010472#ifdef HAVE_SYS_WAIT_H
Fred Drake106c1a02002-04-23 15:58:02 +000010473#ifdef WCOREDUMP
Larry Hastings2f936352014-08-05 14:04:04 +100010474/*[clinic input]
10475os.WCOREDUMP -> bool
10476
10477 status: int
10478 /
10479
10480Return True if the process returning status was dumped to a core file.
10481[clinic start generated code]*/
10482
Larry Hastings2f936352014-08-05 14:04:04 +100010483static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010484os_WCOREDUMP_impl(PyObject *module, int status)
10485/*[clinic end generated code: output=1a584b147b16bd18 input=8b05e7ab38528d04]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010486{
10487 WAIT_TYPE wait_status;
10488 WAIT_STATUS_INT(wait_status) = status;
10489 return WCOREDUMP(wait_status);
Fred Drake106c1a02002-04-23 15:58:02 +000010490}
10491#endif /* WCOREDUMP */
10492
Larry Hastings2f936352014-08-05 14:04:04 +100010493
Fred Drake106c1a02002-04-23 15:58:02 +000010494#ifdef WIFCONTINUED
Larry Hastings2f936352014-08-05 14:04:04 +100010495/*[clinic input]
10496os.WIFCONTINUED -> bool
10497
10498 status: int
10499
10500Return True if a particular process was continued from a job control stop.
10501
10502Return True if the process returning status was continued from a
10503job control stop.
10504[clinic start generated code]*/
10505
Larry Hastings2f936352014-08-05 14:04:04 +100010506static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010507os_WIFCONTINUED_impl(PyObject *module, int status)
10508/*[clinic end generated code: output=1e35295d844364bd input=e777e7d38eb25bd9]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010509{
10510 WAIT_TYPE wait_status;
10511 WAIT_STATUS_INT(wait_status) = status;
10512 return WIFCONTINUED(wait_status);
Fred Drake106c1a02002-04-23 15:58:02 +000010513}
10514#endif /* WIFCONTINUED */
10515
Larry Hastings2f936352014-08-05 14:04:04 +100010516
Guido van Rossumc9641791998-08-04 15:26:23 +000010517#ifdef WIFSTOPPED
Larry Hastings2f936352014-08-05 14:04:04 +100010518/*[clinic input]
10519os.WIFSTOPPED -> bool
10520
10521 status: int
10522
10523Return True if the process returning status was stopped.
10524[clinic start generated code]*/
10525
Larry Hastings2f936352014-08-05 14:04:04 +100010526static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010527os_WIFSTOPPED_impl(PyObject *module, int status)
10528/*[clinic end generated code: output=fdb57122a5c9b4cb input=043cb7f1289ef904]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010529{
10530 WAIT_TYPE wait_status;
10531 WAIT_STATUS_INT(wait_status) = status;
10532 return WIFSTOPPED(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +000010533}
10534#endif /* WIFSTOPPED */
10535
Larry Hastings2f936352014-08-05 14:04:04 +100010536
Guido van Rossumc9641791998-08-04 15:26:23 +000010537#ifdef WIFSIGNALED
Larry Hastings2f936352014-08-05 14:04:04 +100010538/*[clinic input]
10539os.WIFSIGNALED -> bool
10540
10541 status: int
10542
10543Return True if the process returning status was terminated by a signal.
10544[clinic start generated code]*/
10545
Larry Hastings2f936352014-08-05 14:04:04 +100010546static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010547os_WIFSIGNALED_impl(PyObject *module, int status)
10548/*[clinic end generated code: output=d1dde4dcc819a5f5 input=d55ba7cc9ce5dc43]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010549{
10550 WAIT_TYPE wait_status;
10551 WAIT_STATUS_INT(wait_status) = status;
10552 return WIFSIGNALED(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +000010553}
10554#endif /* WIFSIGNALED */
10555
Larry Hastings2f936352014-08-05 14:04:04 +100010556
Guido van Rossumc9641791998-08-04 15:26:23 +000010557#ifdef WIFEXITED
Larry Hastings2f936352014-08-05 14:04:04 +100010558/*[clinic input]
10559os.WIFEXITED -> bool
10560
10561 status: int
10562
10563Return True if the process returning status exited via the exit() system call.
10564[clinic start generated code]*/
10565
Larry Hastings2f936352014-08-05 14:04:04 +100010566static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010567os_WIFEXITED_impl(PyObject *module, int status)
10568/*[clinic end generated code: output=01c09d6ebfeea397 input=d63775a6791586c0]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010569{
10570 WAIT_TYPE wait_status;
10571 WAIT_STATUS_INT(wait_status) = status;
10572 return WIFEXITED(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +000010573}
10574#endif /* WIFEXITED */
10575
Larry Hastings2f936352014-08-05 14:04:04 +100010576
Guido van Rossum54ecc3d1999-01-27 17:53:11 +000010577#ifdef WEXITSTATUS
Larry Hastings2f936352014-08-05 14:04:04 +100010578/*[clinic input]
10579os.WEXITSTATUS -> int
10580
10581 status: int
10582
10583Return the process return code from status.
10584[clinic start generated code]*/
10585
Larry Hastings2f936352014-08-05 14:04:04 +100010586static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010587os_WEXITSTATUS_impl(PyObject *module, int status)
10588/*[clinic end generated code: output=6e3efbba11f6488d input=e1fb4944e377585b]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010589{
10590 WAIT_TYPE wait_status;
10591 WAIT_STATUS_INT(wait_status) = status;
10592 return WEXITSTATUS(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +000010593}
10594#endif /* WEXITSTATUS */
10595
Larry Hastings2f936352014-08-05 14:04:04 +100010596
Guido van Rossumc9641791998-08-04 15:26:23 +000010597#ifdef WTERMSIG
Larry Hastings2f936352014-08-05 14:04:04 +100010598/*[clinic input]
10599os.WTERMSIG -> int
10600
10601 status: int
10602
10603Return the signal that terminated the process that provided the status value.
10604[clinic start generated code]*/
10605
Larry Hastings2f936352014-08-05 14:04:04 +100010606static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010607os_WTERMSIG_impl(PyObject *module, int status)
10608/*[clinic end generated code: output=172f7dfc8dcfc3ad input=727fd7f84ec3f243]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010609{
10610 WAIT_TYPE wait_status;
10611 WAIT_STATUS_INT(wait_status) = status;
10612 return WTERMSIG(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +000010613}
10614#endif /* WTERMSIG */
10615
Larry Hastings2f936352014-08-05 14:04:04 +100010616
Guido van Rossumc9641791998-08-04 15:26:23 +000010617#ifdef WSTOPSIG
Larry Hastings2f936352014-08-05 14:04:04 +100010618/*[clinic input]
10619os.WSTOPSIG -> int
10620
10621 status: int
10622
10623Return the signal that stopped the process that provided the status value.
10624[clinic start generated code]*/
10625
Larry Hastings2f936352014-08-05 14:04:04 +100010626static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010627os_WSTOPSIG_impl(PyObject *module, int status)
10628/*[clinic end generated code: output=0ab7586396f5d82b input=46ebf1d1b293c5c1]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010629{
10630 WAIT_TYPE wait_status;
10631 WAIT_STATUS_INT(wait_status) = status;
10632 return WSTOPSIG(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +000010633}
10634#endif /* WSTOPSIG */
Guido van Rossumc9641791998-08-04 15:26:23 +000010635#endif /* HAVE_SYS_WAIT_H */
10636
10637
Thomas Wouters477c8d52006-05-27 19:21:47 +000010638#if defined(HAVE_FSTATVFS) && defined(HAVE_SYS_STATVFS_H)
Guido van Rossumd5753e11999-10-19 13:29:23 +000010639#ifdef _SCO_DS
10640/* SCO OpenServer 5.0 and later requires _SVID3 before it reveals the
10641 needed definitions in sys/statvfs.h */
10642#define _SVID3
10643#endif
Guido van Rossum94f6f721999-01-06 18:42:14 +000010644#include <sys/statvfs.h>
10645
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010646static PyObject*
Victor Stinner1c2fa782020-05-10 11:05:29 +020010647_pystatvfs_fromstructstatvfs(PyObject *module, struct statvfs st) {
10648 PyObject *StatVFSResultType = get_posix_state(module)->StatVFSResultType;
Eddie Elizondob3966632019-11-05 07:16:14 -080010649 PyObject *v = PyStructSequence_New((PyTypeObject *)StatVFSResultType);
Victor Stinner8c62be82010-05-06 00:08:46 +000010650 if (v == NULL)
10651 return NULL;
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010652
10653#if !defined(HAVE_LARGEFILE_SUPPORT)
Victor Stinner8c62be82010-05-06 00:08:46 +000010654 PyStructSequence_SET_ITEM(v, 0, PyLong_FromLong((long) st.f_bsize));
10655 PyStructSequence_SET_ITEM(v, 1, PyLong_FromLong((long) st.f_frsize));
10656 PyStructSequence_SET_ITEM(v, 2, PyLong_FromLong((long) st.f_blocks));
10657 PyStructSequence_SET_ITEM(v, 3, PyLong_FromLong((long) st.f_bfree));
10658 PyStructSequence_SET_ITEM(v, 4, PyLong_FromLong((long) st.f_bavail));
10659 PyStructSequence_SET_ITEM(v, 5, PyLong_FromLong((long) st.f_files));
10660 PyStructSequence_SET_ITEM(v, 6, PyLong_FromLong((long) st.f_ffree));
10661 PyStructSequence_SET_ITEM(v, 7, PyLong_FromLong((long) st.f_favail));
10662 PyStructSequence_SET_ITEM(v, 8, PyLong_FromLong((long) st.f_flag));
10663 PyStructSequence_SET_ITEM(v, 9, PyLong_FromLong((long) st.f_namemax));
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010664#else
Victor Stinner8c62be82010-05-06 00:08:46 +000010665 PyStructSequence_SET_ITEM(v, 0, PyLong_FromLong((long) st.f_bsize));
10666 PyStructSequence_SET_ITEM(v, 1, PyLong_FromLong((long) st.f_frsize));
10667 PyStructSequence_SET_ITEM(v, 2,
Benjamin Petersonaf580df2016-09-06 10:46:49 -070010668 PyLong_FromLongLong((long long) st.f_blocks));
Victor Stinner8c62be82010-05-06 00:08:46 +000010669 PyStructSequence_SET_ITEM(v, 3,
Benjamin Petersonaf580df2016-09-06 10:46:49 -070010670 PyLong_FromLongLong((long long) st.f_bfree));
Victor Stinner8c62be82010-05-06 00:08:46 +000010671 PyStructSequence_SET_ITEM(v, 4,
Benjamin Petersonaf580df2016-09-06 10:46:49 -070010672 PyLong_FromLongLong((long long) st.f_bavail));
Victor Stinner8c62be82010-05-06 00:08:46 +000010673 PyStructSequence_SET_ITEM(v, 5,
Benjamin Petersonaf580df2016-09-06 10:46:49 -070010674 PyLong_FromLongLong((long long) st.f_files));
Victor Stinner8c62be82010-05-06 00:08:46 +000010675 PyStructSequence_SET_ITEM(v, 6,
Benjamin Petersonaf580df2016-09-06 10:46:49 -070010676 PyLong_FromLongLong((long long) st.f_ffree));
Victor Stinner8c62be82010-05-06 00:08:46 +000010677 PyStructSequence_SET_ITEM(v, 7,
Benjamin Petersonaf580df2016-09-06 10:46:49 -070010678 PyLong_FromLongLong((long long) st.f_favail));
Victor Stinner8c62be82010-05-06 00:08:46 +000010679 PyStructSequence_SET_ITEM(v, 8, PyLong_FromLong((long) st.f_flag));
10680 PyStructSequence_SET_ITEM(v, 9, PyLong_FromLong((long) st.f_namemax));
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010681#endif
Michael Felt502d5512018-01-05 13:01:58 +010010682/* The _ALL_SOURCE feature test macro defines f_fsid as a structure
10683 * (issue #32390). */
10684#if defined(_AIX) && defined(_ALL_SOURCE)
10685 PyStructSequence_SET_ITEM(v, 10, PyLong_FromUnsignedLong(st.f_fsid.val[0]));
10686#else
Giuseppe Scrivano96a5e502017-12-14 23:46:46 +010010687 PyStructSequence_SET_ITEM(v, 10, PyLong_FromUnsignedLong(st.f_fsid));
Michael Felt502d5512018-01-05 13:01:58 +010010688#endif
Victor Stinnerf0a7bac2013-10-30 18:55:24 +010010689 if (PyErr_Occurred()) {
10690 Py_DECREF(v);
10691 return NULL;
10692 }
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010693
Victor Stinner8c62be82010-05-06 00:08:46 +000010694 return v;
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010695}
10696
Larry Hastings2f936352014-08-05 14:04:04 +100010697
10698/*[clinic input]
10699os.fstatvfs
10700 fd: int
10701 /
10702
10703Perform an fstatvfs system call on the given fd.
10704
10705Equivalent to statvfs(fd).
10706[clinic start generated code]*/
10707
Larry Hastings2f936352014-08-05 14:04:04 +100010708static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010709os_fstatvfs_impl(PyObject *module, int fd)
10710/*[clinic end generated code: output=53547cf0cc55e6c5 input=d8122243ac50975e]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010711{
10712 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010713 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +000010714 struct statvfs st;
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010715
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010716 do {
10717 Py_BEGIN_ALLOW_THREADS
10718 result = fstatvfs(fd, &st);
10719 Py_END_ALLOW_THREADS
10720 } while (result != 0 && errno == EINTR &&
10721 !(async_err = PyErr_CheckSignals()));
Larry Hastings2f936352014-08-05 14:04:04 +100010722 if (result != 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010723 return (!async_err) ? posix_error() : NULL;
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010724
Victor Stinner1c2fa782020-05-10 11:05:29 +020010725 return _pystatvfs_fromstructstatvfs(module, st);
Guido van Rossum94f6f721999-01-06 18:42:14 +000010726}
Larry Hastings2f936352014-08-05 14:04:04 +100010727#endif /* defined(HAVE_FSTATVFS) && defined(HAVE_SYS_STATVFS_H) */
Guido van Rossum94f6f721999-01-06 18:42:14 +000010728
10729
Thomas Wouters477c8d52006-05-27 19:21:47 +000010730#if defined(HAVE_STATVFS) && defined(HAVE_SYS_STATVFS_H)
Guido van Rossum94f6f721999-01-06 18:42:14 +000010731#include <sys/statvfs.h>
Larry Hastings2f936352014-08-05 14:04:04 +100010732/*[clinic input]
10733os.statvfs
Guido van Rossum94f6f721999-01-06 18:42:14 +000010734
Larry Hastings2f936352014-08-05 14:04:04 +100010735 path: path_t(allow_fd='PATH_HAVE_FSTATVFS')
10736
10737Perform a statvfs system call on the given path.
10738
10739path may always be specified as a string.
10740On some platforms, path may also be specified as an open file descriptor.
10741 If this functionality is unavailable, using it raises an exception.
10742[clinic start generated code]*/
10743
Larry Hastings2f936352014-08-05 14:04:04 +100010744static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010745os_statvfs_impl(PyObject *module, path_t *path)
10746/*[clinic end generated code: output=87106dd1beb8556e input=3f5c35791c669bd9]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010747{
10748 int result;
10749 struct statvfs st;
Larry Hastings9cf065c2012-06-22 16:30:09 -070010750
10751 Py_BEGIN_ALLOW_THREADS
10752#ifdef HAVE_FSTATVFS
Larry Hastings2f936352014-08-05 14:04:04 +100010753 if (path->fd != -1) {
Larry Hastings9cf065c2012-06-22 16:30:09 -070010754#ifdef __APPLE__
10755 /* handle weak-linking on Mac OS X 10.3 */
10756 if (fstatvfs == NULL) {
Larry Hastings2f936352014-08-05 14:04:04 +100010757 fd_specified("statvfs", path->fd);
10758 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070010759 }
10760#endif
Larry Hastings2f936352014-08-05 14:04:04 +100010761 result = fstatvfs(path->fd, &st);
Larry Hastings9cf065c2012-06-22 16:30:09 -070010762 }
10763 else
10764#endif
Larry Hastings2f936352014-08-05 14:04:04 +100010765 result = statvfs(path->narrow, &st);
Larry Hastings9cf065c2012-06-22 16:30:09 -070010766 Py_END_ALLOW_THREADS
10767
10768 if (result) {
Larry Hastings2f936352014-08-05 14:04:04 +100010769 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -070010770 }
10771
Victor Stinner1c2fa782020-05-10 11:05:29 +020010772 return _pystatvfs_fromstructstatvfs(module, st);
Guido van Rossum94f6f721999-01-06 18:42:14 +000010773}
Larry Hastings2f936352014-08-05 14:04:04 +100010774#endif /* defined(HAVE_STATVFS) && defined(HAVE_SYS_STATVFS_H) */
10775
Guido van Rossum94f6f721999-01-06 18:42:14 +000010776
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010777#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +100010778/*[clinic input]
10779os._getdiskusage
10780
Steve Dower23ad6d02018-02-22 10:39:10 -080010781 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +100010782
10783Return disk usage statistics about the given path as a (total, free) tuple.
10784[clinic start generated code]*/
10785
Larry Hastings2f936352014-08-05 14:04:04 +100010786static PyObject *
Steve Dower23ad6d02018-02-22 10:39:10 -080010787os__getdiskusage_impl(PyObject *module, path_t *path)
10788/*[clinic end generated code: output=3bd3991f5e5c5dfb input=6af8d1b7781cc042]*/
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010789{
10790 BOOL retval;
10791 ULARGE_INTEGER _, total, free;
Joe Pamerc8c02492018-09-25 10:57:36 -040010792 DWORD err = 0;
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010793
10794 Py_BEGIN_ALLOW_THREADS
Steve Dower23ad6d02018-02-22 10:39:10 -080010795 retval = GetDiskFreeSpaceExW(path->wide, &_, &total, &free);
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010796 Py_END_ALLOW_THREADS
Joe Pamerc8c02492018-09-25 10:57:36 -040010797 if (retval == 0) {
10798 if (GetLastError() == ERROR_DIRECTORY) {
10799 wchar_t *dir_path = NULL;
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010800
Joe Pamerc8c02492018-09-25 10:57:36 -040010801 dir_path = PyMem_New(wchar_t, path->length + 1);
10802 if (dir_path == NULL) {
10803 return PyErr_NoMemory();
10804 }
10805
10806 wcscpy_s(dir_path, path->length + 1, path->wide);
10807
10808 if (_dirnameW(dir_path) != -1) {
10809 Py_BEGIN_ALLOW_THREADS
10810 retval = GetDiskFreeSpaceExW(dir_path, &_, &total, &free);
10811 Py_END_ALLOW_THREADS
10812 }
10813 /* Record the last error in case it's modified by PyMem_Free. */
10814 err = GetLastError();
10815 PyMem_Free(dir_path);
10816 if (retval) {
10817 goto success;
10818 }
10819 }
10820 return PyErr_SetFromWindowsErr(err);
10821 }
10822
10823success:
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010824 return Py_BuildValue("(LL)", total.QuadPart, free.QuadPart);
10825}
Larry Hastings2f936352014-08-05 14:04:04 +100010826#endif /* MS_WINDOWS */
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010827
10828
Fred Drakec9680921999-12-13 16:37:25 +000010829/* This is used for fpathconf(), pathconf(), confstr() and sysconf().
10830 * It maps strings representing configuration variable names to
10831 * integer values, allowing those functions to be called with the
Thomas Wouters7e474022000-07-16 12:04:32 +000010832 * magic names instead of polluting the module's namespace with tons of
Fred Drake12c6e2d1999-12-14 21:25:03 +000010833 * rarely-used constants. There are three separate tables that use
10834 * these definitions.
Fred Drakebec628d1999-12-15 18:31:10 +000010835 *
10836 * This code is always included, even if none of the interfaces that
10837 * need it are included. The #if hackery needed to avoid it would be
10838 * sufficiently pervasive that it's not worth the loss of readability.
Fred Drakec9680921999-12-13 16:37:25 +000010839 */
10840struct constdef {
Serhiy Storchaka2d06e842015-12-25 19:53:18 +020010841 const char *name;
Serhiy Storchaka56f6e762015-09-06 21:25:30 +030010842 int value;
Fred Drakec9680921999-12-13 16:37:25 +000010843};
10844
Fred Drake12c6e2d1999-12-14 21:25:03 +000010845static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000010846conv_confname(PyObject *arg, int *valuep, struct constdef *table,
Guido van Rossum7d5baac2007-08-27 23:24:46 +000010847 size_t tablesize)
Fred Drake12c6e2d1999-12-14 21:25:03 +000010848{
Christian Heimes217cfd12007-12-02 14:31:20 +000010849 if (PyLong_Check(arg)) {
Serhiy Storchaka56f6e762015-09-06 21:25:30 +030010850 int value = _PyLong_AsInt(arg);
10851 if (value == -1 && PyErr_Occurred())
10852 return 0;
10853 *valuep = value;
Stefan Krah0e803b32010-11-26 16:16:47 +000010854 return 1;
Fred Drake12c6e2d1999-12-14 21:25:03 +000010855 }
Guido van Rossumbce56a62007-05-10 18:04:33 +000010856 else {
Stefan Krah0e803b32010-11-26 16:16:47 +000010857 /* look up the value in the table using a binary search */
10858 size_t lo = 0;
10859 size_t mid;
10860 size_t hi = tablesize;
10861 int cmp;
10862 const char *confname;
10863 if (!PyUnicode_Check(arg)) {
10864 PyErr_SetString(PyExc_TypeError,
10865 "configuration names must be strings or integers");
10866 return 0;
Victor Stinner8c62be82010-05-06 00:08:46 +000010867 }
Serhiy Storchaka06515832016-11-20 09:13:07 +020010868 confname = PyUnicode_AsUTF8(arg);
Stefan Krah0e803b32010-11-26 16:16:47 +000010869 if (confname == NULL)
10870 return 0;
10871 while (lo < hi) {
10872 mid = (lo + hi) / 2;
10873 cmp = strcmp(confname, table[mid].name);
10874 if (cmp < 0)
10875 hi = mid;
10876 else if (cmp > 0)
10877 lo = mid + 1;
10878 else {
10879 *valuep = table[mid].value;
10880 return 1;
10881 }
10882 }
10883 PyErr_SetString(PyExc_ValueError, "unrecognized configuration name");
10884 return 0;
Victor Stinner8c62be82010-05-06 00:08:46 +000010885 }
Fred Drake12c6e2d1999-12-14 21:25:03 +000010886}
10887
10888
10889#if defined(HAVE_FPATHCONF) || defined(HAVE_PATHCONF)
10890static struct constdef posix_constants_pathconf[] = {
Fred Draked86ed291999-12-15 15:34:33 +000010891#ifdef _PC_ABI_AIO_XFER_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010892 {"PC_ABI_AIO_XFER_MAX", _PC_ABI_AIO_XFER_MAX},
Fred Draked86ed291999-12-15 15:34:33 +000010893#endif
10894#ifdef _PC_ABI_ASYNC_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000010895 {"PC_ABI_ASYNC_IO", _PC_ABI_ASYNC_IO},
Fred Draked86ed291999-12-15 15:34:33 +000010896#endif
Fred Drakec9680921999-12-13 16:37:25 +000010897#ifdef _PC_ASYNC_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000010898 {"PC_ASYNC_IO", _PC_ASYNC_IO},
Fred Drakec9680921999-12-13 16:37:25 +000010899#endif
10900#ifdef _PC_CHOWN_RESTRICTED
Victor Stinner8c62be82010-05-06 00:08:46 +000010901 {"PC_CHOWN_RESTRICTED", _PC_CHOWN_RESTRICTED},
Fred Drakec9680921999-12-13 16:37:25 +000010902#endif
10903#ifdef _PC_FILESIZEBITS
Victor Stinner8c62be82010-05-06 00:08:46 +000010904 {"PC_FILESIZEBITS", _PC_FILESIZEBITS},
Fred Drakec9680921999-12-13 16:37:25 +000010905#endif
10906#ifdef _PC_LAST
Victor Stinner8c62be82010-05-06 00:08:46 +000010907 {"PC_LAST", _PC_LAST},
Fred Drakec9680921999-12-13 16:37:25 +000010908#endif
10909#ifdef _PC_LINK_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010910 {"PC_LINK_MAX", _PC_LINK_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010911#endif
10912#ifdef _PC_MAX_CANON
Victor Stinner8c62be82010-05-06 00:08:46 +000010913 {"PC_MAX_CANON", _PC_MAX_CANON},
Fred Drakec9680921999-12-13 16:37:25 +000010914#endif
10915#ifdef _PC_MAX_INPUT
Victor Stinner8c62be82010-05-06 00:08:46 +000010916 {"PC_MAX_INPUT", _PC_MAX_INPUT},
Fred Drakec9680921999-12-13 16:37:25 +000010917#endif
10918#ifdef _PC_NAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010919 {"PC_NAME_MAX", _PC_NAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010920#endif
10921#ifdef _PC_NO_TRUNC
Victor Stinner8c62be82010-05-06 00:08:46 +000010922 {"PC_NO_TRUNC", _PC_NO_TRUNC},
Fred Drakec9680921999-12-13 16:37:25 +000010923#endif
10924#ifdef _PC_PATH_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010925 {"PC_PATH_MAX", _PC_PATH_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010926#endif
10927#ifdef _PC_PIPE_BUF
Victor Stinner8c62be82010-05-06 00:08:46 +000010928 {"PC_PIPE_BUF", _PC_PIPE_BUF},
Fred Drakec9680921999-12-13 16:37:25 +000010929#endif
10930#ifdef _PC_PRIO_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000010931 {"PC_PRIO_IO", _PC_PRIO_IO},
Fred Drakec9680921999-12-13 16:37:25 +000010932#endif
10933#ifdef _PC_SOCK_MAXBUF
Victor Stinner8c62be82010-05-06 00:08:46 +000010934 {"PC_SOCK_MAXBUF", _PC_SOCK_MAXBUF},
Fred Drakec9680921999-12-13 16:37:25 +000010935#endif
10936#ifdef _PC_SYNC_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000010937 {"PC_SYNC_IO", _PC_SYNC_IO},
Fred Drakec9680921999-12-13 16:37:25 +000010938#endif
10939#ifdef _PC_VDISABLE
Victor Stinner8c62be82010-05-06 00:08:46 +000010940 {"PC_VDISABLE", _PC_VDISABLE},
Fred Drakec9680921999-12-13 16:37:25 +000010941#endif
Jesus Cea7e9065c2010-10-25 13:02:04 +000010942#ifdef _PC_ACL_ENABLED
10943 {"PC_ACL_ENABLED", _PC_ACL_ENABLED},
10944#endif
10945#ifdef _PC_MIN_HOLE_SIZE
10946 {"PC_MIN_HOLE_SIZE", _PC_MIN_HOLE_SIZE},
10947#endif
10948#ifdef _PC_ALLOC_SIZE_MIN
10949 {"PC_ALLOC_SIZE_MIN", _PC_ALLOC_SIZE_MIN},
10950#endif
10951#ifdef _PC_REC_INCR_XFER_SIZE
10952 {"PC_REC_INCR_XFER_SIZE", _PC_REC_INCR_XFER_SIZE},
10953#endif
10954#ifdef _PC_REC_MAX_XFER_SIZE
10955 {"PC_REC_MAX_XFER_SIZE", _PC_REC_MAX_XFER_SIZE},
10956#endif
10957#ifdef _PC_REC_MIN_XFER_SIZE
10958 {"PC_REC_MIN_XFER_SIZE", _PC_REC_MIN_XFER_SIZE},
10959#endif
10960#ifdef _PC_REC_XFER_ALIGN
10961 {"PC_REC_XFER_ALIGN", _PC_REC_XFER_ALIGN},
10962#endif
10963#ifdef _PC_SYMLINK_MAX
10964 {"PC_SYMLINK_MAX", _PC_SYMLINK_MAX},
10965#endif
10966#ifdef _PC_XATTR_ENABLED
10967 {"PC_XATTR_ENABLED", _PC_XATTR_ENABLED},
10968#endif
10969#ifdef _PC_XATTR_EXISTS
10970 {"PC_XATTR_EXISTS", _PC_XATTR_EXISTS},
10971#endif
10972#ifdef _PC_TIMESTAMP_RESOLUTION
10973 {"PC_TIMESTAMP_RESOLUTION", _PC_TIMESTAMP_RESOLUTION},
10974#endif
Fred Drakec9680921999-12-13 16:37:25 +000010975};
10976
Fred Drakec9680921999-12-13 16:37:25 +000010977static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000010978conv_path_confname(PyObject *arg, int *valuep)
Fred Drakec9680921999-12-13 16:37:25 +000010979{
10980 return conv_confname(arg, valuep, posix_constants_pathconf,
10981 sizeof(posix_constants_pathconf)
10982 / sizeof(struct constdef));
10983}
10984#endif
10985
Larry Hastings2f936352014-08-05 14:04:04 +100010986
Fred Drakec9680921999-12-13 16:37:25 +000010987#ifdef HAVE_FPATHCONF
Larry Hastings2f936352014-08-05 14:04:04 +100010988/*[clinic input]
10989os.fpathconf -> long
10990
10991 fd: int
10992 name: path_confname
10993 /
10994
10995Return the configuration limit name for the file descriptor fd.
10996
10997If there is no limit, return -1.
10998[clinic start generated code]*/
10999
Larry Hastings2f936352014-08-05 14:04:04 +100011000static long
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011001os_fpathconf_impl(PyObject *module, int fd, int name)
11002/*[clinic end generated code: output=d5b7042425fc3e21 input=5942a024d3777810]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011003{
11004 long limit;
11005
11006 errno = 0;
11007 limit = fpathconf(fd, name);
11008 if (limit == -1 && errno != 0)
11009 posix_error();
11010
11011 return limit;
11012}
11013#endif /* HAVE_FPATHCONF */
Fred Drakec9680921999-12-13 16:37:25 +000011014
11015
11016#ifdef HAVE_PATHCONF
Larry Hastings2f936352014-08-05 14:04:04 +100011017/*[clinic input]
11018os.pathconf -> long
11019 path: path_t(allow_fd='PATH_HAVE_FPATHCONF')
11020 name: path_confname
11021
11022Return the configuration limit name for the file or directory path.
11023
11024If there is no limit, return -1.
11025On some platforms, path may also be specified as an open file descriptor.
11026 If this functionality is unavailable, using it raises an exception.
11027[clinic start generated code]*/
11028
Larry Hastings2f936352014-08-05 14:04:04 +100011029static long
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011030os_pathconf_impl(PyObject *module, path_t *path, int name)
11031/*[clinic end generated code: output=5bedee35b293a089 input=bc3e2a985af27e5e]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011032{
Victor Stinner8c62be82010-05-06 00:08:46 +000011033 long limit;
Fred Drakec9680921999-12-13 16:37:25 +000011034
Victor Stinner8c62be82010-05-06 00:08:46 +000011035 errno = 0;
Georg Brandl306336b2012-06-24 12:55:33 +020011036#ifdef HAVE_FPATHCONF
Larry Hastings2f936352014-08-05 14:04:04 +100011037 if (path->fd != -1)
11038 limit = fpathconf(path->fd, name);
Georg Brandl306336b2012-06-24 12:55:33 +020011039 else
11040#endif
Larry Hastings2f936352014-08-05 14:04:04 +100011041 limit = pathconf(path->narrow, name);
Victor Stinner8c62be82010-05-06 00:08:46 +000011042 if (limit == -1 && errno != 0) {
11043 if (errno == EINVAL)
Stefan Krah99439262010-11-26 12:58:05 +000011044 /* could be a path or name problem */
11045 posix_error();
Fred Drakec9680921999-12-13 16:37:25 +000011046 else
Larry Hastings2f936352014-08-05 14:04:04 +100011047 path_error(path);
Victor Stinner8c62be82010-05-06 00:08:46 +000011048 }
Larry Hastings2f936352014-08-05 14:04:04 +100011049
11050 return limit;
Fred Drakec9680921999-12-13 16:37:25 +000011051}
Larry Hastings2f936352014-08-05 14:04:04 +100011052#endif /* HAVE_PATHCONF */
Fred Drakec9680921999-12-13 16:37:25 +000011053
11054#ifdef HAVE_CONFSTR
11055static struct constdef posix_constants_confstr[] = {
Fred Draked86ed291999-12-15 15:34:33 +000011056#ifdef _CS_ARCHITECTURE
Victor Stinner8c62be82010-05-06 00:08:46 +000011057 {"CS_ARCHITECTURE", _CS_ARCHITECTURE},
Fred Draked86ed291999-12-15 15:34:33 +000011058#endif
Mark Dickinson876d7c82010-04-16 12:47:52 +000011059#ifdef _CS_GNU_LIBC_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000011060 {"CS_GNU_LIBC_VERSION", _CS_GNU_LIBC_VERSION},
Mark Dickinson876d7c82010-04-16 12:47:52 +000011061#endif
11062#ifdef _CS_GNU_LIBPTHREAD_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000011063 {"CS_GNU_LIBPTHREAD_VERSION", _CS_GNU_LIBPTHREAD_VERSION},
Mark Dickinson876d7c82010-04-16 12:47:52 +000011064#endif
Fred Draked86ed291999-12-15 15:34:33 +000011065#ifdef _CS_HOSTNAME
Victor Stinner8c62be82010-05-06 00:08:46 +000011066 {"CS_HOSTNAME", _CS_HOSTNAME},
Fred Draked86ed291999-12-15 15:34:33 +000011067#endif
11068#ifdef _CS_HW_PROVIDER
Victor Stinner8c62be82010-05-06 00:08:46 +000011069 {"CS_HW_PROVIDER", _CS_HW_PROVIDER},
Fred Draked86ed291999-12-15 15:34:33 +000011070#endif
11071#ifdef _CS_HW_SERIAL
Victor Stinner8c62be82010-05-06 00:08:46 +000011072 {"CS_HW_SERIAL", _CS_HW_SERIAL},
Fred Draked86ed291999-12-15 15:34:33 +000011073#endif
11074#ifdef _CS_INITTAB_NAME
Victor Stinner8c62be82010-05-06 00:08:46 +000011075 {"CS_INITTAB_NAME", _CS_INITTAB_NAME},
Fred Draked86ed291999-12-15 15:34:33 +000011076#endif
Fred Drakec9680921999-12-13 16:37:25 +000011077#ifdef _CS_LFS64_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011078 {"CS_LFS64_CFLAGS", _CS_LFS64_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011079#endif
11080#ifdef _CS_LFS64_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011081 {"CS_LFS64_LDFLAGS", _CS_LFS64_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011082#endif
11083#ifdef _CS_LFS64_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000011084 {"CS_LFS64_LIBS", _CS_LFS64_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000011085#endif
11086#ifdef _CS_LFS64_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011087 {"CS_LFS64_LINTFLAGS", _CS_LFS64_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011088#endif
11089#ifdef _CS_LFS_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011090 {"CS_LFS_CFLAGS", _CS_LFS_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011091#endif
11092#ifdef _CS_LFS_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011093 {"CS_LFS_LDFLAGS", _CS_LFS_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011094#endif
11095#ifdef _CS_LFS_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000011096 {"CS_LFS_LIBS", _CS_LFS_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000011097#endif
11098#ifdef _CS_LFS_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011099 {"CS_LFS_LINTFLAGS", _CS_LFS_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011100#endif
Fred Draked86ed291999-12-15 15:34:33 +000011101#ifdef _CS_MACHINE
Victor Stinner8c62be82010-05-06 00:08:46 +000011102 {"CS_MACHINE", _CS_MACHINE},
Fred Draked86ed291999-12-15 15:34:33 +000011103#endif
Fred Drakec9680921999-12-13 16:37:25 +000011104#ifdef _CS_PATH
Victor Stinner8c62be82010-05-06 00:08:46 +000011105 {"CS_PATH", _CS_PATH},
Fred Drakec9680921999-12-13 16:37:25 +000011106#endif
Fred Draked86ed291999-12-15 15:34:33 +000011107#ifdef _CS_RELEASE
Victor Stinner8c62be82010-05-06 00:08:46 +000011108 {"CS_RELEASE", _CS_RELEASE},
Fred Draked86ed291999-12-15 15:34:33 +000011109#endif
11110#ifdef _CS_SRPC_DOMAIN
Victor Stinner8c62be82010-05-06 00:08:46 +000011111 {"CS_SRPC_DOMAIN", _CS_SRPC_DOMAIN},
Fred Draked86ed291999-12-15 15:34:33 +000011112#endif
11113#ifdef _CS_SYSNAME
Victor Stinner8c62be82010-05-06 00:08:46 +000011114 {"CS_SYSNAME", _CS_SYSNAME},
Fred Draked86ed291999-12-15 15:34:33 +000011115#endif
11116#ifdef _CS_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000011117 {"CS_VERSION", _CS_VERSION},
Fred Draked86ed291999-12-15 15:34:33 +000011118#endif
Fred Drakec9680921999-12-13 16:37:25 +000011119#ifdef _CS_XBS5_ILP32_OFF32_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011120 {"CS_XBS5_ILP32_OFF32_CFLAGS", _CS_XBS5_ILP32_OFF32_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011121#endif
11122#ifdef _CS_XBS5_ILP32_OFF32_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011123 {"CS_XBS5_ILP32_OFF32_LDFLAGS", _CS_XBS5_ILP32_OFF32_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011124#endif
11125#ifdef _CS_XBS5_ILP32_OFF32_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000011126 {"CS_XBS5_ILP32_OFF32_LIBS", _CS_XBS5_ILP32_OFF32_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000011127#endif
11128#ifdef _CS_XBS5_ILP32_OFF32_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011129 {"CS_XBS5_ILP32_OFF32_LINTFLAGS", _CS_XBS5_ILP32_OFF32_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011130#endif
11131#ifdef _CS_XBS5_ILP32_OFFBIG_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011132 {"CS_XBS5_ILP32_OFFBIG_CFLAGS", _CS_XBS5_ILP32_OFFBIG_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011133#endif
11134#ifdef _CS_XBS5_ILP32_OFFBIG_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011135 {"CS_XBS5_ILP32_OFFBIG_LDFLAGS", _CS_XBS5_ILP32_OFFBIG_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011136#endif
11137#ifdef _CS_XBS5_ILP32_OFFBIG_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000011138 {"CS_XBS5_ILP32_OFFBIG_LIBS", _CS_XBS5_ILP32_OFFBIG_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000011139#endif
11140#ifdef _CS_XBS5_ILP32_OFFBIG_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011141 {"CS_XBS5_ILP32_OFFBIG_LINTFLAGS", _CS_XBS5_ILP32_OFFBIG_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011142#endif
11143#ifdef _CS_XBS5_LP64_OFF64_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011144 {"CS_XBS5_LP64_OFF64_CFLAGS", _CS_XBS5_LP64_OFF64_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011145#endif
11146#ifdef _CS_XBS5_LP64_OFF64_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011147 {"CS_XBS5_LP64_OFF64_LDFLAGS", _CS_XBS5_LP64_OFF64_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011148#endif
11149#ifdef _CS_XBS5_LP64_OFF64_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000011150 {"CS_XBS5_LP64_OFF64_LIBS", _CS_XBS5_LP64_OFF64_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000011151#endif
11152#ifdef _CS_XBS5_LP64_OFF64_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011153 {"CS_XBS5_LP64_OFF64_LINTFLAGS", _CS_XBS5_LP64_OFF64_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011154#endif
11155#ifdef _CS_XBS5_LPBIG_OFFBIG_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011156 {"CS_XBS5_LPBIG_OFFBIG_CFLAGS", _CS_XBS5_LPBIG_OFFBIG_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011157#endif
11158#ifdef _CS_XBS5_LPBIG_OFFBIG_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011159 {"CS_XBS5_LPBIG_OFFBIG_LDFLAGS", _CS_XBS5_LPBIG_OFFBIG_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011160#endif
11161#ifdef _CS_XBS5_LPBIG_OFFBIG_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000011162 {"CS_XBS5_LPBIG_OFFBIG_LIBS", _CS_XBS5_LPBIG_OFFBIG_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000011163#endif
11164#ifdef _CS_XBS5_LPBIG_OFFBIG_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000011165 {"CS_XBS5_LPBIG_OFFBIG_LINTFLAGS", _CS_XBS5_LPBIG_OFFBIG_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000011166#endif
Fred Draked86ed291999-12-15 15:34:33 +000011167#ifdef _MIPS_CS_AVAIL_PROCESSORS
Victor Stinner8c62be82010-05-06 00:08:46 +000011168 {"MIPS_CS_AVAIL_PROCESSORS", _MIPS_CS_AVAIL_PROCESSORS},
Fred Draked86ed291999-12-15 15:34:33 +000011169#endif
11170#ifdef _MIPS_CS_BASE
Victor Stinner8c62be82010-05-06 00:08:46 +000011171 {"MIPS_CS_BASE", _MIPS_CS_BASE},
Fred Draked86ed291999-12-15 15:34:33 +000011172#endif
11173#ifdef _MIPS_CS_HOSTID
Victor Stinner8c62be82010-05-06 00:08:46 +000011174 {"MIPS_CS_HOSTID", _MIPS_CS_HOSTID},
Fred Draked86ed291999-12-15 15:34:33 +000011175#endif
11176#ifdef _MIPS_CS_HW_NAME
Victor Stinner8c62be82010-05-06 00:08:46 +000011177 {"MIPS_CS_HW_NAME", _MIPS_CS_HW_NAME},
Fred Draked86ed291999-12-15 15:34:33 +000011178#endif
11179#ifdef _MIPS_CS_NUM_PROCESSORS
Victor Stinner8c62be82010-05-06 00:08:46 +000011180 {"MIPS_CS_NUM_PROCESSORS", _MIPS_CS_NUM_PROCESSORS},
Fred Draked86ed291999-12-15 15:34:33 +000011181#endif
11182#ifdef _MIPS_CS_OSREL_MAJ
Victor Stinner8c62be82010-05-06 00:08:46 +000011183 {"MIPS_CS_OSREL_MAJ", _MIPS_CS_OSREL_MAJ},
Fred Draked86ed291999-12-15 15:34:33 +000011184#endif
11185#ifdef _MIPS_CS_OSREL_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000011186 {"MIPS_CS_OSREL_MIN", _MIPS_CS_OSREL_MIN},
Fred Draked86ed291999-12-15 15:34:33 +000011187#endif
11188#ifdef _MIPS_CS_OSREL_PATCH
Victor Stinner8c62be82010-05-06 00:08:46 +000011189 {"MIPS_CS_OSREL_PATCH", _MIPS_CS_OSREL_PATCH},
Fred Draked86ed291999-12-15 15:34:33 +000011190#endif
11191#ifdef _MIPS_CS_OS_NAME
Victor Stinner8c62be82010-05-06 00:08:46 +000011192 {"MIPS_CS_OS_NAME", _MIPS_CS_OS_NAME},
Fred Draked86ed291999-12-15 15:34:33 +000011193#endif
11194#ifdef _MIPS_CS_OS_PROVIDER
Victor Stinner8c62be82010-05-06 00:08:46 +000011195 {"MIPS_CS_OS_PROVIDER", _MIPS_CS_OS_PROVIDER},
Fred Draked86ed291999-12-15 15:34:33 +000011196#endif
11197#ifdef _MIPS_CS_PROCESSORS
Victor Stinner8c62be82010-05-06 00:08:46 +000011198 {"MIPS_CS_PROCESSORS", _MIPS_CS_PROCESSORS},
Fred Draked86ed291999-12-15 15:34:33 +000011199#endif
11200#ifdef _MIPS_CS_SERIAL
Victor Stinner8c62be82010-05-06 00:08:46 +000011201 {"MIPS_CS_SERIAL", _MIPS_CS_SERIAL},
Fred Draked86ed291999-12-15 15:34:33 +000011202#endif
11203#ifdef _MIPS_CS_VENDOR
Victor Stinner8c62be82010-05-06 00:08:46 +000011204 {"MIPS_CS_VENDOR", _MIPS_CS_VENDOR},
Fred Draked86ed291999-12-15 15:34:33 +000011205#endif
Fred Drakec9680921999-12-13 16:37:25 +000011206};
11207
11208static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000011209conv_confstr_confname(PyObject *arg, int *valuep)
Fred Drakec9680921999-12-13 16:37:25 +000011210{
11211 return conv_confname(arg, valuep, posix_constants_confstr,
11212 sizeof(posix_constants_confstr)
11213 / sizeof(struct constdef));
11214}
11215
Larry Hastings2f936352014-08-05 14:04:04 +100011216
11217/*[clinic input]
11218os.confstr
11219
11220 name: confstr_confname
11221 /
11222
11223Return a string-valued system configuration variable.
11224[clinic start generated code]*/
11225
Larry Hastings2f936352014-08-05 14:04:04 +100011226static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011227os_confstr_impl(PyObject *module, int name)
11228/*[clinic end generated code: output=bfb0b1b1e49b9383 input=18fb4d0567242e65]*/
Fred Drakec9680921999-12-13 16:37:25 +000011229{
11230 PyObject *result = NULL;
Victor Stinnercb043522010-09-10 23:49:04 +000011231 char buffer[255];
Victor Stinnerdd3a6a52013-06-25 23:13:47 +020011232 size_t len;
Fred Drakec9680921999-12-13 16:37:25 +000011233
Victor Stinnercb043522010-09-10 23:49:04 +000011234 errno = 0;
11235 len = confstr(name, buffer, sizeof(buffer));
11236 if (len == 0) {
11237 if (errno) {
11238 posix_error();
11239 return NULL;
Fred Drakec9680921999-12-13 16:37:25 +000011240 }
11241 else {
Victor Stinnercb043522010-09-10 23:49:04 +000011242 Py_RETURN_NONE;
Fred Drakec9680921999-12-13 16:37:25 +000011243 }
11244 }
Victor Stinnercb043522010-09-10 23:49:04 +000011245
Victor Stinnerdd3a6a52013-06-25 23:13:47 +020011246 if (len >= sizeof(buffer)) {
Victor Stinnercbc18f32014-12-05 22:51:51 +010011247 size_t len2;
Victor Stinnercb043522010-09-10 23:49:04 +000011248 char *buf = PyMem_Malloc(len);
11249 if (buf == NULL)
11250 return PyErr_NoMemory();
Victor Stinnercbc18f32014-12-05 22:51:51 +010011251 len2 = confstr(name, buf, len);
11252 assert(len == len2);
Christian Heimes8714cfd2015-04-21 10:57:41 +020011253 result = PyUnicode_DecodeFSDefaultAndSize(buf, len2-1);
Victor Stinnercb043522010-09-10 23:49:04 +000011254 PyMem_Free(buf);
11255 }
11256 else
11257 result = PyUnicode_DecodeFSDefaultAndSize(buffer, len-1);
Fred Drakec9680921999-12-13 16:37:25 +000011258 return result;
11259}
Larry Hastings2f936352014-08-05 14:04:04 +100011260#endif /* HAVE_CONFSTR */
Fred Drakec9680921999-12-13 16:37:25 +000011261
11262
11263#ifdef HAVE_SYSCONF
11264static struct constdef posix_constants_sysconf[] = {
11265#ifdef _SC_2_CHAR_TERM
Victor Stinner8c62be82010-05-06 00:08:46 +000011266 {"SC_2_CHAR_TERM", _SC_2_CHAR_TERM},
Fred Drakec9680921999-12-13 16:37:25 +000011267#endif
11268#ifdef _SC_2_C_BIND
Victor Stinner8c62be82010-05-06 00:08:46 +000011269 {"SC_2_C_BIND", _SC_2_C_BIND},
Fred Drakec9680921999-12-13 16:37:25 +000011270#endif
11271#ifdef _SC_2_C_DEV
Victor Stinner8c62be82010-05-06 00:08:46 +000011272 {"SC_2_C_DEV", _SC_2_C_DEV},
Fred Drakec9680921999-12-13 16:37:25 +000011273#endif
11274#ifdef _SC_2_C_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000011275 {"SC_2_C_VERSION", _SC_2_C_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000011276#endif
11277#ifdef _SC_2_FORT_DEV
Victor Stinner8c62be82010-05-06 00:08:46 +000011278 {"SC_2_FORT_DEV", _SC_2_FORT_DEV},
Fred Drakec9680921999-12-13 16:37:25 +000011279#endif
11280#ifdef _SC_2_FORT_RUN
Victor Stinner8c62be82010-05-06 00:08:46 +000011281 {"SC_2_FORT_RUN", _SC_2_FORT_RUN},
Fred Drakec9680921999-12-13 16:37:25 +000011282#endif
11283#ifdef _SC_2_LOCALEDEF
Victor Stinner8c62be82010-05-06 00:08:46 +000011284 {"SC_2_LOCALEDEF", _SC_2_LOCALEDEF},
Fred Drakec9680921999-12-13 16:37:25 +000011285#endif
11286#ifdef _SC_2_SW_DEV
Victor Stinner8c62be82010-05-06 00:08:46 +000011287 {"SC_2_SW_DEV", _SC_2_SW_DEV},
Fred Drakec9680921999-12-13 16:37:25 +000011288#endif
11289#ifdef _SC_2_UPE
Victor Stinner8c62be82010-05-06 00:08:46 +000011290 {"SC_2_UPE", _SC_2_UPE},
Fred Drakec9680921999-12-13 16:37:25 +000011291#endif
11292#ifdef _SC_2_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000011293 {"SC_2_VERSION", _SC_2_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000011294#endif
Fred Draked86ed291999-12-15 15:34:33 +000011295#ifdef _SC_ABI_ASYNCHRONOUS_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000011296 {"SC_ABI_ASYNCHRONOUS_IO", _SC_ABI_ASYNCHRONOUS_IO},
Fred Draked86ed291999-12-15 15:34:33 +000011297#endif
11298#ifdef _SC_ACL
Victor Stinner8c62be82010-05-06 00:08:46 +000011299 {"SC_ACL", _SC_ACL},
Fred Draked86ed291999-12-15 15:34:33 +000011300#endif
Fred Drakec9680921999-12-13 16:37:25 +000011301#ifdef _SC_AIO_LISTIO_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011302 {"SC_AIO_LISTIO_MAX", _SC_AIO_LISTIO_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011303#endif
Fred Drakec9680921999-12-13 16:37:25 +000011304#ifdef _SC_AIO_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011305 {"SC_AIO_MAX", _SC_AIO_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011306#endif
11307#ifdef _SC_AIO_PRIO_DELTA_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011308 {"SC_AIO_PRIO_DELTA_MAX", _SC_AIO_PRIO_DELTA_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011309#endif
11310#ifdef _SC_ARG_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011311 {"SC_ARG_MAX", _SC_ARG_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011312#endif
11313#ifdef _SC_ASYNCHRONOUS_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000011314 {"SC_ASYNCHRONOUS_IO", _SC_ASYNCHRONOUS_IO},
Fred Drakec9680921999-12-13 16:37:25 +000011315#endif
11316#ifdef _SC_ATEXIT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011317 {"SC_ATEXIT_MAX", _SC_ATEXIT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011318#endif
Fred Draked86ed291999-12-15 15:34:33 +000011319#ifdef _SC_AUDIT
Victor Stinner8c62be82010-05-06 00:08:46 +000011320 {"SC_AUDIT", _SC_AUDIT},
Fred Draked86ed291999-12-15 15:34:33 +000011321#endif
Fred Drakec9680921999-12-13 16:37:25 +000011322#ifdef _SC_AVPHYS_PAGES
Victor Stinner8c62be82010-05-06 00:08:46 +000011323 {"SC_AVPHYS_PAGES", _SC_AVPHYS_PAGES},
Fred Drakec9680921999-12-13 16:37:25 +000011324#endif
11325#ifdef _SC_BC_BASE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011326 {"SC_BC_BASE_MAX", _SC_BC_BASE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011327#endif
11328#ifdef _SC_BC_DIM_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011329 {"SC_BC_DIM_MAX", _SC_BC_DIM_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011330#endif
11331#ifdef _SC_BC_SCALE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011332 {"SC_BC_SCALE_MAX", _SC_BC_SCALE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011333#endif
11334#ifdef _SC_BC_STRING_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011335 {"SC_BC_STRING_MAX", _SC_BC_STRING_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011336#endif
Fred Draked86ed291999-12-15 15:34:33 +000011337#ifdef _SC_CAP
Victor Stinner8c62be82010-05-06 00:08:46 +000011338 {"SC_CAP", _SC_CAP},
Fred Draked86ed291999-12-15 15:34:33 +000011339#endif
Fred Drakec9680921999-12-13 16:37:25 +000011340#ifdef _SC_CHARCLASS_NAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011341 {"SC_CHARCLASS_NAME_MAX", _SC_CHARCLASS_NAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011342#endif
11343#ifdef _SC_CHAR_BIT
Victor Stinner8c62be82010-05-06 00:08:46 +000011344 {"SC_CHAR_BIT", _SC_CHAR_BIT},
Fred Drakec9680921999-12-13 16:37:25 +000011345#endif
11346#ifdef _SC_CHAR_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011347 {"SC_CHAR_MAX", _SC_CHAR_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011348#endif
11349#ifdef _SC_CHAR_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000011350 {"SC_CHAR_MIN", _SC_CHAR_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000011351#endif
11352#ifdef _SC_CHILD_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011353 {"SC_CHILD_MAX", _SC_CHILD_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011354#endif
11355#ifdef _SC_CLK_TCK
Victor Stinner8c62be82010-05-06 00:08:46 +000011356 {"SC_CLK_TCK", _SC_CLK_TCK},
Fred Drakec9680921999-12-13 16:37:25 +000011357#endif
11358#ifdef _SC_COHER_BLKSZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011359 {"SC_COHER_BLKSZ", _SC_COHER_BLKSZ},
Fred Drakec9680921999-12-13 16:37:25 +000011360#endif
11361#ifdef _SC_COLL_WEIGHTS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011362 {"SC_COLL_WEIGHTS_MAX", _SC_COLL_WEIGHTS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011363#endif
11364#ifdef _SC_DCACHE_ASSOC
Victor Stinner8c62be82010-05-06 00:08:46 +000011365 {"SC_DCACHE_ASSOC", _SC_DCACHE_ASSOC},
Fred Drakec9680921999-12-13 16:37:25 +000011366#endif
11367#ifdef _SC_DCACHE_BLKSZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011368 {"SC_DCACHE_BLKSZ", _SC_DCACHE_BLKSZ},
Fred Drakec9680921999-12-13 16:37:25 +000011369#endif
11370#ifdef _SC_DCACHE_LINESZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011371 {"SC_DCACHE_LINESZ", _SC_DCACHE_LINESZ},
Fred Drakec9680921999-12-13 16:37:25 +000011372#endif
11373#ifdef _SC_DCACHE_SZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011374 {"SC_DCACHE_SZ", _SC_DCACHE_SZ},
Fred Drakec9680921999-12-13 16:37:25 +000011375#endif
11376#ifdef _SC_DCACHE_TBLKSZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011377 {"SC_DCACHE_TBLKSZ", _SC_DCACHE_TBLKSZ},
Fred Drakec9680921999-12-13 16:37:25 +000011378#endif
11379#ifdef _SC_DELAYTIMER_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011380 {"SC_DELAYTIMER_MAX", _SC_DELAYTIMER_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011381#endif
11382#ifdef _SC_EQUIV_CLASS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011383 {"SC_EQUIV_CLASS_MAX", _SC_EQUIV_CLASS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011384#endif
11385#ifdef _SC_EXPR_NEST_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011386 {"SC_EXPR_NEST_MAX", _SC_EXPR_NEST_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011387#endif
11388#ifdef _SC_FSYNC
Victor Stinner8c62be82010-05-06 00:08:46 +000011389 {"SC_FSYNC", _SC_FSYNC},
Fred Drakec9680921999-12-13 16:37:25 +000011390#endif
11391#ifdef _SC_GETGR_R_SIZE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011392 {"SC_GETGR_R_SIZE_MAX", _SC_GETGR_R_SIZE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011393#endif
11394#ifdef _SC_GETPW_R_SIZE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011395 {"SC_GETPW_R_SIZE_MAX", _SC_GETPW_R_SIZE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011396#endif
11397#ifdef _SC_ICACHE_ASSOC
Victor Stinner8c62be82010-05-06 00:08:46 +000011398 {"SC_ICACHE_ASSOC", _SC_ICACHE_ASSOC},
Fred Drakec9680921999-12-13 16:37:25 +000011399#endif
11400#ifdef _SC_ICACHE_BLKSZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011401 {"SC_ICACHE_BLKSZ", _SC_ICACHE_BLKSZ},
Fred Drakec9680921999-12-13 16:37:25 +000011402#endif
11403#ifdef _SC_ICACHE_LINESZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011404 {"SC_ICACHE_LINESZ", _SC_ICACHE_LINESZ},
Fred Drakec9680921999-12-13 16:37:25 +000011405#endif
11406#ifdef _SC_ICACHE_SZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011407 {"SC_ICACHE_SZ", _SC_ICACHE_SZ},
Fred Drakec9680921999-12-13 16:37:25 +000011408#endif
Fred Draked86ed291999-12-15 15:34:33 +000011409#ifdef _SC_INF
Victor Stinner8c62be82010-05-06 00:08:46 +000011410 {"SC_INF", _SC_INF},
Fred Draked86ed291999-12-15 15:34:33 +000011411#endif
Fred Drakec9680921999-12-13 16:37:25 +000011412#ifdef _SC_INT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011413 {"SC_INT_MAX", _SC_INT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011414#endif
11415#ifdef _SC_INT_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000011416 {"SC_INT_MIN", _SC_INT_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000011417#endif
11418#ifdef _SC_IOV_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011419 {"SC_IOV_MAX", _SC_IOV_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011420#endif
Fred Draked86ed291999-12-15 15:34:33 +000011421#ifdef _SC_IP_SECOPTS
Victor Stinner8c62be82010-05-06 00:08:46 +000011422 {"SC_IP_SECOPTS", _SC_IP_SECOPTS},
Fred Draked86ed291999-12-15 15:34:33 +000011423#endif
Fred Drakec9680921999-12-13 16:37:25 +000011424#ifdef _SC_JOB_CONTROL
Victor Stinner8c62be82010-05-06 00:08:46 +000011425 {"SC_JOB_CONTROL", _SC_JOB_CONTROL},
Fred Drakec9680921999-12-13 16:37:25 +000011426#endif
Fred Draked86ed291999-12-15 15:34:33 +000011427#ifdef _SC_KERN_POINTERS
Victor Stinner8c62be82010-05-06 00:08:46 +000011428 {"SC_KERN_POINTERS", _SC_KERN_POINTERS},
Fred Draked86ed291999-12-15 15:34:33 +000011429#endif
11430#ifdef _SC_KERN_SIM
Victor Stinner8c62be82010-05-06 00:08:46 +000011431 {"SC_KERN_SIM", _SC_KERN_SIM},
Fred Draked86ed291999-12-15 15:34:33 +000011432#endif
Fred Drakec9680921999-12-13 16:37:25 +000011433#ifdef _SC_LINE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011434 {"SC_LINE_MAX", _SC_LINE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011435#endif
11436#ifdef _SC_LOGIN_NAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011437 {"SC_LOGIN_NAME_MAX", _SC_LOGIN_NAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011438#endif
11439#ifdef _SC_LOGNAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011440 {"SC_LOGNAME_MAX", _SC_LOGNAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011441#endif
11442#ifdef _SC_LONG_BIT
Victor Stinner8c62be82010-05-06 00:08:46 +000011443 {"SC_LONG_BIT", _SC_LONG_BIT},
Fred Drakec9680921999-12-13 16:37:25 +000011444#endif
Fred Draked86ed291999-12-15 15:34:33 +000011445#ifdef _SC_MAC
Victor Stinner8c62be82010-05-06 00:08:46 +000011446 {"SC_MAC", _SC_MAC},
Fred Draked86ed291999-12-15 15:34:33 +000011447#endif
Fred Drakec9680921999-12-13 16:37:25 +000011448#ifdef _SC_MAPPED_FILES
Victor Stinner8c62be82010-05-06 00:08:46 +000011449 {"SC_MAPPED_FILES", _SC_MAPPED_FILES},
Fred Drakec9680921999-12-13 16:37:25 +000011450#endif
11451#ifdef _SC_MAXPID
Victor Stinner8c62be82010-05-06 00:08:46 +000011452 {"SC_MAXPID", _SC_MAXPID},
Fred Drakec9680921999-12-13 16:37:25 +000011453#endif
11454#ifdef _SC_MB_LEN_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011455 {"SC_MB_LEN_MAX", _SC_MB_LEN_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011456#endif
11457#ifdef _SC_MEMLOCK
Victor Stinner8c62be82010-05-06 00:08:46 +000011458 {"SC_MEMLOCK", _SC_MEMLOCK},
Fred Drakec9680921999-12-13 16:37:25 +000011459#endif
11460#ifdef _SC_MEMLOCK_RANGE
Victor Stinner8c62be82010-05-06 00:08:46 +000011461 {"SC_MEMLOCK_RANGE", _SC_MEMLOCK_RANGE},
Fred Drakec9680921999-12-13 16:37:25 +000011462#endif
11463#ifdef _SC_MEMORY_PROTECTION
Victor Stinner8c62be82010-05-06 00:08:46 +000011464 {"SC_MEMORY_PROTECTION", _SC_MEMORY_PROTECTION},
Fred Drakec9680921999-12-13 16:37:25 +000011465#endif
11466#ifdef _SC_MESSAGE_PASSING
Victor Stinner8c62be82010-05-06 00:08:46 +000011467 {"SC_MESSAGE_PASSING", _SC_MESSAGE_PASSING},
Fred Drakec9680921999-12-13 16:37:25 +000011468#endif
Fred Draked86ed291999-12-15 15:34:33 +000011469#ifdef _SC_MMAP_FIXED_ALIGNMENT
Victor Stinner8c62be82010-05-06 00:08:46 +000011470 {"SC_MMAP_FIXED_ALIGNMENT", _SC_MMAP_FIXED_ALIGNMENT},
Fred Draked86ed291999-12-15 15:34:33 +000011471#endif
Fred Drakec9680921999-12-13 16:37:25 +000011472#ifdef _SC_MQ_OPEN_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011473 {"SC_MQ_OPEN_MAX", _SC_MQ_OPEN_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011474#endif
11475#ifdef _SC_MQ_PRIO_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011476 {"SC_MQ_PRIO_MAX", _SC_MQ_PRIO_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011477#endif
Fred Draked86ed291999-12-15 15:34:33 +000011478#ifdef _SC_NACLS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011479 {"SC_NACLS_MAX", _SC_NACLS_MAX},
Fred Draked86ed291999-12-15 15:34:33 +000011480#endif
Fred Drakec9680921999-12-13 16:37:25 +000011481#ifdef _SC_NGROUPS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011482 {"SC_NGROUPS_MAX", _SC_NGROUPS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011483#endif
11484#ifdef _SC_NL_ARGMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011485 {"SC_NL_ARGMAX", _SC_NL_ARGMAX},
Fred Drakec9680921999-12-13 16:37:25 +000011486#endif
11487#ifdef _SC_NL_LANGMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011488 {"SC_NL_LANGMAX", _SC_NL_LANGMAX},
Fred Drakec9680921999-12-13 16:37:25 +000011489#endif
11490#ifdef _SC_NL_MSGMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011491 {"SC_NL_MSGMAX", _SC_NL_MSGMAX},
Fred Drakec9680921999-12-13 16:37:25 +000011492#endif
11493#ifdef _SC_NL_NMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011494 {"SC_NL_NMAX", _SC_NL_NMAX},
Fred Drakec9680921999-12-13 16:37:25 +000011495#endif
11496#ifdef _SC_NL_SETMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011497 {"SC_NL_SETMAX", _SC_NL_SETMAX},
Fred Drakec9680921999-12-13 16:37:25 +000011498#endif
11499#ifdef _SC_NL_TEXTMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011500 {"SC_NL_TEXTMAX", _SC_NL_TEXTMAX},
Fred Drakec9680921999-12-13 16:37:25 +000011501#endif
11502#ifdef _SC_NPROCESSORS_CONF
Victor Stinner8c62be82010-05-06 00:08:46 +000011503 {"SC_NPROCESSORS_CONF", _SC_NPROCESSORS_CONF},
Fred Drakec9680921999-12-13 16:37:25 +000011504#endif
11505#ifdef _SC_NPROCESSORS_ONLN
Victor Stinner8c62be82010-05-06 00:08:46 +000011506 {"SC_NPROCESSORS_ONLN", _SC_NPROCESSORS_ONLN},
Fred Drakec9680921999-12-13 16:37:25 +000011507#endif
Fred Draked86ed291999-12-15 15:34:33 +000011508#ifdef _SC_NPROC_CONF
Victor Stinner8c62be82010-05-06 00:08:46 +000011509 {"SC_NPROC_CONF", _SC_NPROC_CONF},
Fred Draked86ed291999-12-15 15:34:33 +000011510#endif
11511#ifdef _SC_NPROC_ONLN
Victor Stinner8c62be82010-05-06 00:08:46 +000011512 {"SC_NPROC_ONLN", _SC_NPROC_ONLN},
Fred Draked86ed291999-12-15 15:34:33 +000011513#endif
Fred Drakec9680921999-12-13 16:37:25 +000011514#ifdef _SC_NZERO
Victor Stinner8c62be82010-05-06 00:08:46 +000011515 {"SC_NZERO", _SC_NZERO},
Fred Drakec9680921999-12-13 16:37:25 +000011516#endif
11517#ifdef _SC_OPEN_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011518 {"SC_OPEN_MAX", _SC_OPEN_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011519#endif
11520#ifdef _SC_PAGESIZE
Victor Stinner8c62be82010-05-06 00:08:46 +000011521 {"SC_PAGESIZE", _SC_PAGESIZE},
Fred Drakec9680921999-12-13 16:37:25 +000011522#endif
11523#ifdef _SC_PAGE_SIZE
Victor Stinner8c62be82010-05-06 00:08:46 +000011524 {"SC_PAGE_SIZE", _SC_PAGE_SIZE},
Fred Drakec9680921999-12-13 16:37:25 +000011525#endif
Batuhan Taşkaya909f4a32020-04-05 03:40:49 +030011526#ifdef _SC_AIX_REALMEM
11527 {"SC_AIX_REALMEM", _SC_AIX_REALMEM},
11528#endif
Fred Drakec9680921999-12-13 16:37:25 +000011529#ifdef _SC_PASS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011530 {"SC_PASS_MAX", _SC_PASS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011531#endif
11532#ifdef _SC_PHYS_PAGES
Victor Stinner8c62be82010-05-06 00:08:46 +000011533 {"SC_PHYS_PAGES", _SC_PHYS_PAGES},
Fred Drakec9680921999-12-13 16:37:25 +000011534#endif
11535#ifdef _SC_PII
Victor Stinner8c62be82010-05-06 00:08:46 +000011536 {"SC_PII", _SC_PII},
Fred Drakec9680921999-12-13 16:37:25 +000011537#endif
11538#ifdef _SC_PII_INTERNET
Victor Stinner8c62be82010-05-06 00:08:46 +000011539 {"SC_PII_INTERNET", _SC_PII_INTERNET},
Fred Drakec9680921999-12-13 16:37:25 +000011540#endif
11541#ifdef _SC_PII_INTERNET_DGRAM
Victor Stinner8c62be82010-05-06 00:08:46 +000011542 {"SC_PII_INTERNET_DGRAM", _SC_PII_INTERNET_DGRAM},
Fred Drakec9680921999-12-13 16:37:25 +000011543#endif
11544#ifdef _SC_PII_INTERNET_STREAM
Victor Stinner8c62be82010-05-06 00:08:46 +000011545 {"SC_PII_INTERNET_STREAM", _SC_PII_INTERNET_STREAM},
Fred Drakec9680921999-12-13 16:37:25 +000011546#endif
11547#ifdef _SC_PII_OSI
Victor Stinner8c62be82010-05-06 00:08:46 +000011548 {"SC_PII_OSI", _SC_PII_OSI},
Fred Drakec9680921999-12-13 16:37:25 +000011549#endif
11550#ifdef _SC_PII_OSI_CLTS
Victor Stinner8c62be82010-05-06 00:08:46 +000011551 {"SC_PII_OSI_CLTS", _SC_PII_OSI_CLTS},
Fred Drakec9680921999-12-13 16:37:25 +000011552#endif
11553#ifdef _SC_PII_OSI_COTS
Victor Stinner8c62be82010-05-06 00:08:46 +000011554 {"SC_PII_OSI_COTS", _SC_PII_OSI_COTS},
Fred Drakec9680921999-12-13 16:37:25 +000011555#endif
11556#ifdef _SC_PII_OSI_M
Victor Stinner8c62be82010-05-06 00:08:46 +000011557 {"SC_PII_OSI_M", _SC_PII_OSI_M},
Fred Drakec9680921999-12-13 16:37:25 +000011558#endif
11559#ifdef _SC_PII_SOCKET
Victor Stinner8c62be82010-05-06 00:08:46 +000011560 {"SC_PII_SOCKET", _SC_PII_SOCKET},
Fred Drakec9680921999-12-13 16:37:25 +000011561#endif
11562#ifdef _SC_PII_XTI
Victor Stinner8c62be82010-05-06 00:08:46 +000011563 {"SC_PII_XTI", _SC_PII_XTI},
Fred Drakec9680921999-12-13 16:37:25 +000011564#endif
11565#ifdef _SC_POLL
Victor Stinner8c62be82010-05-06 00:08:46 +000011566 {"SC_POLL", _SC_POLL},
Fred Drakec9680921999-12-13 16:37:25 +000011567#endif
11568#ifdef _SC_PRIORITIZED_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000011569 {"SC_PRIORITIZED_IO", _SC_PRIORITIZED_IO},
Fred Drakec9680921999-12-13 16:37:25 +000011570#endif
11571#ifdef _SC_PRIORITY_SCHEDULING
Victor Stinner8c62be82010-05-06 00:08:46 +000011572 {"SC_PRIORITY_SCHEDULING", _SC_PRIORITY_SCHEDULING},
Fred Drakec9680921999-12-13 16:37:25 +000011573#endif
11574#ifdef _SC_REALTIME_SIGNALS
Victor Stinner8c62be82010-05-06 00:08:46 +000011575 {"SC_REALTIME_SIGNALS", _SC_REALTIME_SIGNALS},
Fred Drakec9680921999-12-13 16:37:25 +000011576#endif
11577#ifdef _SC_RE_DUP_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011578 {"SC_RE_DUP_MAX", _SC_RE_DUP_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011579#endif
11580#ifdef _SC_RTSIG_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011581 {"SC_RTSIG_MAX", _SC_RTSIG_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011582#endif
11583#ifdef _SC_SAVED_IDS
Victor Stinner8c62be82010-05-06 00:08:46 +000011584 {"SC_SAVED_IDS", _SC_SAVED_IDS},
Fred Drakec9680921999-12-13 16:37:25 +000011585#endif
11586#ifdef _SC_SCHAR_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011587 {"SC_SCHAR_MAX", _SC_SCHAR_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011588#endif
11589#ifdef _SC_SCHAR_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000011590 {"SC_SCHAR_MIN", _SC_SCHAR_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000011591#endif
11592#ifdef _SC_SELECT
Victor Stinner8c62be82010-05-06 00:08:46 +000011593 {"SC_SELECT", _SC_SELECT},
Fred Drakec9680921999-12-13 16:37:25 +000011594#endif
11595#ifdef _SC_SEMAPHORES
Victor Stinner8c62be82010-05-06 00:08:46 +000011596 {"SC_SEMAPHORES", _SC_SEMAPHORES},
Fred Drakec9680921999-12-13 16:37:25 +000011597#endif
11598#ifdef _SC_SEM_NSEMS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011599 {"SC_SEM_NSEMS_MAX", _SC_SEM_NSEMS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011600#endif
11601#ifdef _SC_SEM_VALUE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011602 {"SC_SEM_VALUE_MAX", _SC_SEM_VALUE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011603#endif
11604#ifdef _SC_SHARED_MEMORY_OBJECTS
Victor Stinner8c62be82010-05-06 00:08:46 +000011605 {"SC_SHARED_MEMORY_OBJECTS", _SC_SHARED_MEMORY_OBJECTS},
Fred Drakec9680921999-12-13 16:37:25 +000011606#endif
11607#ifdef _SC_SHRT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011608 {"SC_SHRT_MAX", _SC_SHRT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011609#endif
11610#ifdef _SC_SHRT_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000011611 {"SC_SHRT_MIN", _SC_SHRT_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000011612#endif
11613#ifdef _SC_SIGQUEUE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011614 {"SC_SIGQUEUE_MAX", _SC_SIGQUEUE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011615#endif
11616#ifdef _SC_SIGRT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011617 {"SC_SIGRT_MAX", _SC_SIGRT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011618#endif
11619#ifdef _SC_SIGRT_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000011620 {"SC_SIGRT_MIN", _SC_SIGRT_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000011621#endif
Fred Draked86ed291999-12-15 15:34:33 +000011622#ifdef _SC_SOFTPOWER
Victor Stinner8c62be82010-05-06 00:08:46 +000011623 {"SC_SOFTPOWER", _SC_SOFTPOWER},
Fred Draked86ed291999-12-15 15:34:33 +000011624#endif
Fred Drakec9680921999-12-13 16:37:25 +000011625#ifdef _SC_SPLIT_CACHE
Victor Stinner8c62be82010-05-06 00:08:46 +000011626 {"SC_SPLIT_CACHE", _SC_SPLIT_CACHE},
Fred Drakec9680921999-12-13 16:37:25 +000011627#endif
11628#ifdef _SC_SSIZE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011629 {"SC_SSIZE_MAX", _SC_SSIZE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011630#endif
11631#ifdef _SC_STACK_PROT
Victor Stinner8c62be82010-05-06 00:08:46 +000011632 {"SC_STACK_PROT", _SC_STACK_PROT},
Fred Drakec9680921999-12-13 16:37:25 +000011633#endif
11634#ifdef _SC_STREAM_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011635 {"SC_STREAM_MAX", _SC_STREAM_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011636#endif
11637#ifdef _SC_SYNCHRONIZED_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000011638 {"SC_SYNCHRONIZED_IO", _SC_SYNCHRONIZED_IO},
Fred Drakec9680921999-12-13 16:37:25 +000011639#endif
11640#ifdef _SC_THREADS
Victor Stinner8c62be82010-05-06 00:08:46 +000011641 {"SC_THREADS", _SC_THREADS},
Fred Drakec9680921999-12-13 16:37:25 +000011642#endif
11643#ifdef _SC_THREAD_ATTR_STACKADDR
Victor Stinner8c62be82010-05-06 00:08:46 +000011644 {"SC_THREAD_ATTR_STACKADDR", _SC_THREAD_ATTR_STACKADDR},
Fred Drakec9680921999-12-13 16:37:25 +000011645#endif
11646#ifdef _SC_THREAD_ATTR_STACKSIZE
Victor Stinner8c62be82010-05-06 00:08:46 +000011647 {"SC_THREAD_ATTR_STACKSIZE", _SC_THREAD_ATTR_STACKSIZE},
Fred Drakec9680921999-12-13 16:37:25 +000011648#endif
11649#ifdef _SC_THREAD_DESTRUCTOR_ITERATIONS
Victor Stinner8c62be82010-05-06 00:08:46 +000011650 {"SC_THREAD_DESTRUCTOR_ITERATIONS", _SC_THREAD_DESTRUCTOR_ITERATIONS},
Fred Drakec9680921999-12-13 16:37:25 +000011651#endif
11652#ifdef _SC_THREAD_KEYS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011653 {"SC_THREAD_KEYS_MAX", _SC_THREAD_KEYS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011654#endif
11655#ifdef _SC_THREAD_PRIORITY_SCHEDULING
Victor Stinner8c62be82010-05-06 00:08:46 +000011656 {"SC_THREAD_PRIORITY_SCHEDULING", _SC_THREAD_PRIORITY_SCHEDULING},
Fred Drakec9680921999-12-13 16:37:25 +000011657#endif
11658#ifdef _SC_THREAD_PRIO_INHERIT
Victor Stinner8c62be82010-05-06 00:08:46 +000011659 {"SC_THREAD_PRIO_INHERIT", _SC_THREAD_PRIO_INHERIT},
Fred Drakec9680921999-12-13 16:37:25 +000011660#endif
11661#ifdef _SC_THREAD_PRIO_PROTECT
Victor Stinner8c62be82010-05-06 00:08:46 +000011662 {"SC_THREAD_PRIO_PROTECT", _SC_THREAD_PRIO_PROTECT},
Fred Drakec9680921999-12-13 16:37:25 +000011663#endif
11664#ifdef _SC_THREAD_PROCESS_SHARED
Victor Stinner8c62be82010-05-06 00:08:46 +000011665 {"SC_THREAD_PROCESS_SHARED", _SC_THREAD_PROCESS_SHARED},
Fred Drakec9680921999-12-13 16:37:25 +000011666#endif
11667#ifdef _SC_THREAD_SAFE_FUNCTIONS
Victor Stinner8c62be82010-05-06 00:08:46 +000011668 {"SC_THREAD_SAFE_FUNCTIONS", _SC_THREAD_SAFE_FUNCTIONS},
Fred Drakec9680921999-12-13 16:37:25 +000011669#endif
11670#ifdef _SC_THREAD_STACK_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000011671 {"SC_THREAD_STACK_MIN", _SC_THREAD_STACK_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000011672#endif
11673#ifdef _SC_THREAD_THREADS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011674 {"SC_THREAD_THREADS_MAX", _SC_THREAD_THREADS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011675#endif
11676#ifdef _SC_TIMERS
Victor Stinner8c62be82010-05-06 00:08:46 +000011677 {"SC_TIMERS", _SC_TIMERS},
Fred Drakec9680921999-12-13 16:37:25 +000011678#endif
11679#ifdef _SC_TIMER_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011680 {"SC_TIMER_MAX", _SC_TIMER_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011681#endif
11682#ifdef _SC_TTY_NAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011683 {"SC_TTY_NAME_MAX", _SC_TTY_NAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011684#endif
11685#ifdef _SC_TZNAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011686 {"SC_TZNAME_MAX", _SC_TZNAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011687#endif
11688#ifdef _SC_T_IOV_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011689 {"SC_T_IOV_MAX", _SC_T_IOV_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011690#endif
11691#ifdef _SC_UCHAR_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011692 {"SC_UCHAR_MAX", _SC_UCHAR_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011693#endif
11694#ifdef _SC_UINT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011695 {"SC_UINT_MAX", _SC_UINT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011696#endif
11697#ifdef _SC_UIO_MAXIOV
Victor Stinner8c62be82010-05-06 00:08:46 +000011698 {"SC_UIO_MAXIOV", _SC_UIO_MAXIOV},
Fred Drakec9680921999-12-13 16:37:25 +000011699#endif
11700#ifdef _SC_ULONG_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011701 {"SC_ULONG_MAX", _SC_ULONG_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011702#endif
11703#ifdef _SC_USHRT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011704 {"SC_USHRT_MAX", _SC_USHRT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011705#endif
11706#ifdef _SC_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000011707 {"SC_VERSION", _SC_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000011708#endif
11709#ifdef _SC_WORD_BIT
Victor Stinner8c62be82010-05-06 00:08:46 +000011710 {"SC_WORD_BIT", _SC_WORD_BIT},
Fred Drakec9680921999-12-13 16:37:25 +000011711#endif
11712#ifdef _SC_XBS5_ILP32_OFF32
Victor Stinner8c62be82010-05-06 00:08:46 +000011713 {"SC_XBS5_ILP32_OFF32", _SC_XBS5_ILP32_OFF32},
Fred Drakec9680921999-12-13 16:37:25 +000011714#endif
11715#ifdef _SC_XBS5_ILP32_OFFBIG
Victor Stinner8c62be82010-05-06 00:08:46 +000011716 {"SC_XBS5_ILP32_OFFBIG", _SC_XBS5_ILP32_OFFBIG},
Fred Drakec9680921999-12-13 16:37:25 +000011717#endif
11718#ifdef _SC_XBS5_LP64_OFF64
Victor Stinner8c62be82010-05-06 00:08:46 +000011719 {"SC_XBS5_LP64_OFF64", _SC_XBS5_LP64_OFF64},
Fred Drakec9680921999-12-13 16:37:25 +000011720#endif
11721#ifdef _SC_XBS5_LPBIG_OFFBIG
Victor Stinner8c62be82010-05-06 00:08:46 +000011722 {"SC_XBS5_LPBIG_OFFBIG", _SC_XBS5_LPBIG_OFFBIG},
Fred Drakec9680921999-12-13 16:37:25 +000011723#endif
11724#ifdef _SC_XOPEN_CRYPT
Victor Stinner8c62be82010-05-06 00:08:46 +000011725 {"SC_XOPEN_CRYPT", _SC_XOPEN_CRYPT},
Fred Drakec9680921999-12-13 16:37:25 +000011726#endif
11727#ifdef _SC_XOPEN_ENH_I18N
Victor Stinner8c62be82010-05-06 00:08:46 +000011728 {"SC_XOPEN_ENH_I18N", _SC_XOPEN_ENH_I18N},
Fred Drakec9680921999-12-13 16:37:25 +000011729#endif
11730#ifdef _SC_XOPEN_LEGACY
Victor Stinner8c62be82010-05-06 00:08:46 +000011731 {"SC_XOPEN_LEGACY", _SC_XOPEN_LEGACY},
Fred Drakec9680921999-12-13 16:37:25 +000011732#endif
11733#ifdef _SC_XOPEN_REALTIME
Victor Stinner8c62be82010-05-06 00:08:46 +000011734 {"SC_XOPEN_REALTIME", _SC_XOPEN_REALTIME},
Fred Drakec9680921999-12-13 16:37:25 +000011735#endif
11736#ifdef _SC_XOPEN_REALTIME_THREADS
Victor Stinner8c62be82010-05-06 00:08:46 +000011737 {"SC_XOPEN_REALTIME_THREADS", _SC_XOPEN_REALTIME_THREADS},
Fred Drakec9680921999-12-13 16:37:25 +000011738#endif
11739#ifdef _SC_XOPEN_SHM
Victor Stinner8c62be82010-05-06 00:08:46 +000011740 {"SC_XOPEN_SHM", _SC_XOPEN_SHM},
Fred Drakec9680921999-12-13 16:37:25 +000011741#endif
11742#ifdef _SC_XOPEN_UNIX
Victor Stinner8c62be82010-05-06 00:08:46 +000011743 {"SC_XOPEN_UNIX", _SC_XOPEN_UNIX},
Fred Drakec9680921999-12-13 16:37:25 +000011744#endif
11745#ifdef _SC_XOPEN_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000011746 {"SC_XOPEN_VERSION", _SC_XOPEN_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000011747#endif
11748#ifdef _SC_XOPEN_XCU_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000011749 {"SC_XOPEN_XCU_VERSION", _SC_XOPEN_XCU_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000011750#endif
11751#ifdef _SC_XOPEN_XPG2
Victor Stinner8c62be82010-05-06 00:08:46 +000011752 {"SC_XOPEN_XPG2", _SC_XOPEN_XPG2},
Fred Drakec9680921999-12-13 16:37:25 +000011753#endif
11754#ifdef _SC_XOPEN_XPG3
Victor Stinner8c62be82010-05-06 00:08:46 +000011755 {"SC_XOPEN_XPG3", _SC_XOPEN_XPG3},
Fred Drakec9680921999-12-13 16:37:25 +000011756#endif
11757#ifdef _SC_XOPEN_XPG4
Victor Stinner8c62be82010-05-06 00:08:46 +000011758 {"SC_XOPEN_XPG4", _SC_XOPEN_XPG4},
Fred Drakec9680921999-12-13 16:37:25 +000011759#endif
11760};
11761
11762static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000011763conv_sysconf_confname(PyObject *arg, int *valuep)
Fred Drakec9680921999-12-13 16:37:25 +000011764{
11765 return conv_confname(arg, valuep, posix_constants_sysconf,
11766 sizeof(posix_constants_sysconf)
11767 / sizeof(struct constdef));
11768}
11769
Larry Hastings2f936352014-08-05 14:04:04 +100011770
11771/*[clinic input]
11772os.sysconf -> long
11773 name: sysconf_confname
11774 /
11775
11776Return an integer-valued system configuration variable.
11777[clinic start generated code]*/
11778
Larry Hastings2f936352014-08-05 14:04:04 +100011779static long
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011780os_sysconf_impl(PyObject *module, int name)
11781/*[clinic end generated code: output=3662f945fc0cc756 input=279e3430a33f29e4]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011782{
11783 long value;
11784
11785 errno = 0;
11786 value = sysconf(name);
11787 if (value == -1 && errno != 0)
11788 posix_error();
11789 return value;
11790}
11791#endif /* HAVE_SYSCONF */
Fred Drakec9680921999-12-13 16:37:25 +000011792
11793
Fred Drakebec628d1999-12-15 18:31:10 +000011794/* This code is used to ensure that the tables of configuration value names
Serhiy Storchaka56a6d852014-12-01 18:28:43 +020011795 * are in sorted order as required by conv_confname(), and also to build
Fred Drakebec628d1999-12-15 18:31:10 +000011796 * the exported dictionaries that are used to publish information about the
11797 * names available on the host platform.
11798 *
11799 * Sorting the table at runtime ensures that the table is properly ordered
11800 * when used, even for platforms we're not able to test on. It also makes
11801 * it easier to add additional entries to the tables.
Fred Draked86ed291999-12-15 15:34:33 +000011802 */
Fred Drakebec628d1999-12-15 18:31:10 +000011803
11804static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000011805cmp_constdefs(const void *v1, const void *v2)
Fred Drakebec628d1999-12-15 18:31:10 +000011806{
11807 const struct constdef *c1 =
Victor Stinner8c62be82010-05-06 00:08:46 +000011808 (const struct constdef *) v1;
Fred Drakebec628d1999-12-15 18:31:10 +000011809 const struct constdef *c2 =
Victor Stinner8c62be82010-05-06 00:08:46 +000011810 (const struct constdef *) v2;
Fred Drakebec628d1999-12-15 18:31:10 +000011811
11812 return strcmp(c1->name, c2->name);
11813}
11814
11815static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000011816setup_confname_table(struct constdef *table, size_t tablesize,
Serhiy Storchakadeab18d2016-05-07 16:45:18 +030011817 const char *tablename, PyObject *module)
Fred Draked86ed291999-12-15 15:34:33 +000011818{
Fred Drakebec628d1999-12-15 18:31:10 +000011819 PyObject *d = NULL;
Barry Warsaw3155db32000-04-13 15:20:40 +000011820 size_t i;
Fred Drakebec628d1999-12-15 18:31:10 +000011821
11822 qsort(table, tablesize, sizeof(struct constdef), cmp_constdefs);
11823 d = PyDict_New();
Barry Warsaw3155db32000-04-13 15:20:40 +000011824 if (d == NULL)
Victor Stinner8c62be82010-05-06 00:08:46 +000011825 return -1;
Fred Draked86ed291999-12-15 15:34:33 +000011826
Barry Warsaw3155db32000-04-13 15:20:40 +000011827 for (i=0; i < tablesize; ++i) {
Victor Stinner8c62be82010-05-06 00:08:46 +000011828 PyObject *o = PyLong_FromLong(table[i].value);
11829 if (o == NULL || PyDict_SetItemString(d, table[i].name, o) == -1) {
11830 Py_XDECREF(o);
11831 Py_DECREF(d);
11832 return -1;
11833 }
11834 Py_DECREF(o);
Fred Draked86ed291999-12-15 15:34:33 +000011835 }
Fred Drake4d1e64b2002-04-15 19:40:07 +000011836 return PyModule_AddObject(module, tablename, d);
Fred Draked86ed291999-12-15 15:34:33 +000011837}
11838
Fred Drakebec628d1999-12-15 18:31:10 +000011839/* Return -1 on failure, 0 on success. */
11840static int
Fred Drake4d1e64b2002-04-15 19:40:07 +000011841setup_confname_tables(PyObject *module)
Fred Draked86ed291999-12-15 15:34:33 +000011842{
11843#if defined(HAVE_FPATHCONF) || defined(HAVE_PATHCONF)
Fred Drakebec628d1999-12-15 18:31:10 +000011844 if (setup_confname_table(posix_constants_pathconf,
Fred Draked86ed291999-12-15 15:34:33 +000011845 sizeof(posix_constants_pathconf)
11846 / sizeof(struct constdef),
Fred Drake4d1e64b2002-04-15 19:40:07 +000011847 "pathconf_names", module))
Stefan Krah0e803b32010-11-26 16:16:47 +000011848 return -1;
Fred Draked86ed291999-12-15 15:34:33 +000011849#endif
11850#ifdef HAVE_CONFSTR
Fred Drakebec628d1999-12-15 18:31:10 +000011851 if (setup_confname_table(posix_constants_confstr,
Fred Draked86ed291999-12-15 15:34:33 +000011852 sizeof(posix_constants_confstr)
11853 / sizeof(struct constdef),
Fred Drake4d1e64b2002-04-15 19:40:07 +000011854 "confstr_names", module))
Stefan Krah0e803b32010-11-26 16:16:47 +000011855 return -1;
Fred Draked86ed291999-12-15 15:34:33 +000011856#endif
11857#ifdef HAVE_SYSCONF
Fred Drakebec628d1999-12-15 18:31:10 +000011858 if (setup_confname_table(posix_constants_sysconf,
Fred Draked86ed291999-12-15 15:34:33 +000011859 sizeof(posix_constants_sysconf)
11860 / sizeof(struct constdef),
Fred Drake4d1e64b2002-04-15 19:40:07 +000011861 "sysconf_names", module))
Stefan Krah0e803b32010-11-26 16:16:47 +000011862 return -1;
Fred Draked86ed291999-12-15 15:34:33 +000011863#endif
Fred Drakebec628d1999-12-15 18:31:10 +000011864 return 0;
Fred Draked86ed291999-12-15 15:34:33 +000011865}
Fred Draked86ed291999-12-15 15:34:33 +000011866
11867
Larry Hastings2f936352014-08-05 14:04:04 +100011868/*[clinic input]
11869os.abort
11870
11871Abort the interpreter immediately.
11872
11873This function 'dumps core' or otherwise fails in the hardest way possible
11874on the hosting operating system. This function never returns.
11875[clinic start generated code]*/
11876
Larry Hastings2f936352014-08-05 14:04:04 +100011877static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011878os_abort_impl(PyObject *module)
11879/*[clinic end generated code: output=dcf52586dad2467c input=cf2c7d98bc504047]*/
Fred Drake5ab8eaf1999-12-09 21:13:07 +000011880{
Fred Drake5ab8eaf1999-12-09 21:13:07 +000011881 abort();
11882 /*NOTREACHED*/
Victor Stinner9a2329f2016-12-05 17:56:36 +010011883#ifndef __clang__
11884 /* Issue #28152: abort() is declared with __attribute__((__noreturn__)).
11885 GCC emits a warning without "return NULL;" (compiler bug?), but Clang
11886 is smarter and emits a warning on the return. */
Fred Drake5ab8eaf1999-12-09 21:13:07 +000011887 Py_FatalError("abort() called from Python code didn't abort!");
11888 return NULL;
Victor Stinner9a2329f2016-12-05 17:56:36 +010011889#endif
Fred Drake5ab8eaf1999-12-09 21:13:07 +000011890}
Fred Drakebec628d1999-12-15 18:31:10 +000011891
Martin v. Löwis6238d2b2002-06-30 15:26:10 +000011892#ifdef MS_WINDOWS
Steve Dower7d0e0c92015-01-24 08:18:24 -080011893/* Grab ShellExecute dynamically from shell32 */
11894static int has_ShellExecute = -1;
Steve Dower7d0e0c92015-01-24 08:18:24 -080011895static HINSTANCE (CALLBACK *Py_ShellExecuteW)(HWND, LPCWSTR, LPCWSTR, LPCWSTR,
11896 LPCWSTR, INT);
11897static int
11898check_ShellExecute()
11899{
11900 HINSTANCE hShell32;
11901
11902 /* only recheck */
11903 if (-1 == has_ShellExecute) {
11904 Py_BEGIN_ALLOW_THREADS
Victor Stinnera9912152017-10-13 13:46:57 -070011905 /* Security note: this call is not vulnerable to "DLL hijacking".
11906 SHELL32 is part of "KnownDLLs" and so Windows always load
11907 the system SHELL32.DLL, even if there is another SHELL32.DLL
11908 in the DLL search path. */
Steve Dower7d0e0c92015-01-24 08:18:24 -080011909 hShell32 = LoadLibraryW(L"SHELL32");
Steve Dower7d0e0c92015-01-24 08:18:24 -080011910 if (hShell32) {
Steve Dower7d0e0c92015-01-24 08:18:24 -080011911 *(FARPROC*)&Py_ShellExecuteW = GetProcAddress(hShell32,
11912 "ShellExecuteW");
Steve Dowercc16be82016-09-08 10:35:16 -070011913 has_ShellExecute = Py_ShellExecuteW != NULL;
Steve Dower7d0e0c92015-01-24 08:18:24 -080011914 } else {
11915 has_ShellExecute = 0;
11916 }
Tony Roberts4860f012019-02-02 18:16:42 +010011917 Py_END_ALLOW_THREADS
Steve Dower7d0e0c92015-01-24 08:18:24 -080011918 }
11919 return has_ShellExecute;
11920}
11921
11922
Steve Dowercc16be82016-09-08 10:35:16 -070011923/*[clinic input]
11924os.startfile
11925 filepath: path_t
11926 operation: Py_UNICODE = NULL
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +000011927
Steve Dowercc16be82016-09-08 10:35:16 -070011928Start a file with its associated application.
11929
11930When "operation" is not specified or "open", this acts like
11931double-clicking the file in Explorer, or giving the file name as an
11932argument to the DOS "start" command: the file is opened with whatever
11933application (if any) its extension is associated.
11934When another "operation" is given, it specifies what should be done with
11935the file. A typical operation is "print".
11936
11937startfile returns as soon as the associated application is launched.
11938There is no option to wait for the application to close, and no way
11939to retrieve the application's exit status.
11940
11941The filepath is relative to the current directory. If you want to use
11942an absolute path, make sure the first character is not a slash ("/");
11943the underlying Win32 ShellExecute function doesn't work if it is.
11944[clinic start generated code]*/
11945
11946static PyObject *
Serhiy Storchakaafb3e712018-12-14 11:19:51 +020011947os_startfile_impl(PyObject *module, path_t *filepath,
11948 const Py_UNICODE *operation)
Serhiy Storchaka279f4462019-09-14 12:24:05 +030011949/*[clinic end generated code: output=66dc311c94d50797 input=c940888a5390f039]*/
Steve Dowercc16be82016-09-08 10:35:16 -070011950{
11951 HINSTANCE rc;
Steve Dower7d0e0c92015-01-24 08:18:24 -080011952
11953 if(!check_ShellExecute()) {
11954 /* If the OS doesn't have ShellExecute, return a
11955 NotImplementedError. */
11956 return PyErr_Format(PyExc_NotImplementedError,
11957 "startfile not available on this platform");
11958 }
11959
Saiyang Gou7514f4f2020-02-12 23:47:42 -080011960 if (PySys_Audit("os.startfile", "Ou", filepath->object, operation) < 0) {
Saiyang Gou95f60012020-02-04 16:15:00 -080011961 return NULL;
11962 }
11963
Victor Stinner8c62be82010-05-06 00:08:46 +000011964 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -070011965 rc = Py_ShellExecuteW((HWND)0, operation, filepath->wide,
Steve Dower7d0e0c92015-01-24 08:18:24 -080011966 NULL, NULL, SW_SHOWNORMAL);
Victor Stinner8c62be82010-05-06 00:08:46 +000011967 Py_END_ALLOW_THREADS
11968
Victor Stinner8c62be82010-05-06 00:08:46 +000011969 if (rc <= (HINSTANCE)32) {
Steve Dowercc16be82016-09-08 10:35:16 -070011970 win32_error_object("startfile", filepath->object);
Victor Stinnereb5657a2011-09-30 01:44:27 +020011971 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +000011972 }
Steve Dowercc16be82016-09-08 10:35:16 -070011973 Py_RETURN_NONE;
Tim Petersf58a7aa2000-09-22 10:05:54 +000011974}
Larry Hastings2f936352014-08-05 14:04:04 +100011975#endif /* MS_WINDOWS */
11976
Fred Drake5ab8eaf1999-12-09 21:13:07 +000011977
Martin v. Löwis438b5342002-12-27 10:16:42 +000011978#ifdef HAVE_GETLOADAVG
Larry Hastings2f936352014-08-05 14:04:04 +100011979/*[clinic input]
11980os.getloadavg
11981
11982Return average recent system load information.
11983
11984Return the number of processes in the system run queue averaged over
11985the last 1, 5, and 15 minutes as a tuple of three floats.
11986Raises OSError if the load average was unobtainable.
11987[clinic start generated code]*/
11988
Larry Hastings2f936352014-08-05 14:04:04 +100011989static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011990os_getloadavg_impl(PyObject *module)
11991/*[clinic end generated code: output=9ad3a11bfb4f4bd2 input=3d6d826b76d8a34e]*/
Martin v. Löwis438b5342002-12-27 10:16:42 +000011992{
11993 double loadavg[3];
Martin v. Löwis438b5342002-12-27 10:16:42 +000011994 if (getloadavg(loadavg, 3)!=3) {
Stefan Krah0e803b32010-11-26 16:16:47 +000011995 PyErr_SetString(PyExc_OSError, "Load averages are unobtainable");
11996 return NULL;
Martin v. Löwis438b5342002-12-27 10:16:42 +000011997 } else
Stefan Krah0e803b32010-11-26 16:16:47 +000011998 return Py_BuildValue("ddd", loadavg[0], loadavg[1], loadavg[2]);
Martin v. Löwis438b5342002-12-27 10:16:42 +000011999}
Larry Hastings2f936352014-08-05 14:04:04 +100012000#endif /* HAVE_GETLOADAVG */
Martin v. Löwis438b5342002-12-27 10:16:42 +000012001
Larry Hastings2f936352014-08-05 14:04:04 +100012002
12003/*[clinic input]
12004os.device_encoding
12005 fd: int
12006
12007Return a string describing the encoding of a terminal's file descriptor.
12008
12009The file descriptor must be attached to a terminal.
12010If the device is not a terminal, return None.
12011[clinic start generated code]*/
12012
Larry Hastings2f936352014-08-05 14:04:04 +100012013static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012014os_device_encoding_impl(PyObject *module, int fd)
12015/*[clinic end generated code: output=e0d294bbab7e8c2b input=9e1d4a42b66df312]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012016{
Brett Cannonefb00c02012-02-29 18:31:31 -050012017 return _Py_device_encoding(fd);
Martin v. Löwisd1cd4d42007-08-11 14:02:14 +000012018}
12019
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000012020
Larry Hastings2f936352014-08-05 14:04:04 +100012021#ifdef HAVE_SETRESUID
12022/*[clinic input]
12023os.setresuid
12024
12025 ruid: uid_t
12026 euid: uid_t
12027 suid: uid_t
12028 /
12029
12030Set the current process's real, effective, and saved user ids.
12031[clinic start generated code]*/
12032
Larry Hastings2f936352014-08-05 14:04:04 +100012033static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012034os_setresuid_impl(PyObject *module, uid_t ruid, uid_t euid, uid_t suid)
12035/*[clinic end generated code: output=834a641e15373e97 input=9e33cb79a82792f3]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012036{
Victor Stinner8c62be82010-05-06 00:08:46 +000012037 if (setresuid(ruid, euid, suid) < 0)
12038 return posix_error();
12039 Py_RETURN_NONE;
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000012040}
Larry Hastings2f936352014-08-05 14:04:04 +100012041#endif /* HAVE_SETRESUID */
12042
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000012043
12044#ifdef HAVE_SETRESGID
Larry Hastings2f936352014-08-05 14:04:04 +100012045/*[clinic input]
12046os.setresgid
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000012047
Larry Hastings2f936352014-08-05 14:04:04 +100012048 rgid: gid_t
12049 egid: gid_t
12050 sgid: gid_t
12051 /
12052
12053Set the current process's real, effective, and saved group ids.
12054[clinic start generated code]*/
12055
Larry Hastings2f936352014-08-05 14:04:04 +100012056static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012057os_setresgid_impl(PyObject *module, gid_t rgid, gid_t egid, gid_t sgid)
12058/*[clinic end generated code: output=6aa402f3d2e514a9 input=33e9e0785ef426b1]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012059{
Victor Stinner8c62be82010-05-06 00:08:46 +000012060 if (setresgid(rgid, egid, sgid) < 0)
12061 return posix_error();
12062 Py_RETURN_NONE;
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000012063}
Larry Hastings2f936352014-08-05 14:04:04 +100012064#endif /* HAVE_SETRESGID */
12065
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000012066
12067#ifdef HAVE_GETRESUID
Larry Hastings2f936352014-08-05 14:04:04 +100012068/*[clinic input]
12069os.getresuid
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000012070
Larry Hastings2f936352014-08-05 14:04:04 +100012071Return a tuple of the current process's real, effective, and saved user ids.
12072[clinic start generated code]*/
12073
Larry Hastings2f936352014-08-05 14:04:04 +100012074static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012075os_getresuid_impl(PyObject *module)
12076/*[clinic end generated code: output=8e0becff5dece5bf input=41ccfa8e1f6517ad]*/
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000012077{
Victor Stinner8c62be82010-05-06 00:08:46 +000012078 uid_t ruid, euid, suid;
Victor Stinner8c62be82010-05-06 00:08:46 +000012079 if (getresuid(&ruid, &euid, &suid) < 0)
12080 return posix_error();
Serhiy Storchaka7cf55992013-02-10 21:56:49 +020012081 return Py_BuildValue("(NNN)", _PyLong_FromUid(ruid),
12082 _PyLong_FromUid(euid),
12083 _PyLong_FromUid(suid));
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000012084}
Larry Hastings2f936352014-08-05 14:04:04 +100012085#endif /* HAVE_GETRESUID */
12086
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000012087
12088#ifdef HAVE_GETRESGID
Larry Hastings2f936352014-08-05 14:04:04 +100012089/*[clinic input]
12090os.getresgid
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000012091
Larry Hastings2f936352014-08-05 14:04:04 +100012092Return a tuple of the current process's real, effective, and saved group ids.
12093[clinic start generated code]*/
12094
Larry Hastings2f936352014-08-05 14:04:04 +100012095static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012096os_getresgid_impl(PyObject *module)
12097/*[clinic end generated code: output=2719c4bfcf27fb9f input=517e68db9ca32df6]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012098{
12099 gid_t rgid, egid, sgid;
Victor Stinner8c62be82010-05-06 00:08:46 +000012100 if (getresgid(&rgid, &egid, &sgid) < 0)
12101 return posix_error();
Serhiy Storchaka7cf55992013-02-10 21:56:49 +020012102 return Py_BuildValue("(NNN)", _PyLong_FromGid(rgid),
12103 _PyLong_FromGid(egid),
12104 _PyLong_FromGid(sgid));
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000012105}
Larry Hastings2f936352014-08-05 14:04:04 +100012106#endif /* HAVE_GETRESGID */
12107
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000012108
Benjamin Peterson9428d532011-09-14 11:45:52 -040012109#ifdef USE_XATTRS
Larry Hastings2f936352014-08-05 14:04:04 +100012110/*[clinic input]
12111os.getxattr
Benjamin Peterson799bd802011-08-31 22:15:17 -040012112
Larry Hastings2f936352014-08-05 14:04:04 +100012113 path: path_t(allow_fd=True)
12114 attribute: path_t
12115 *
12116 follow_symlinks: bool = True
12117
12118Return the value of extended attribute attribute on path.
12119
BNMetricsb9427072018-11-02 15:20:19 +000012120path may be either a string, a path-like object, or an open file descriptor.
Larry Hastings2f936352014-08-05 14:04:04 +100012121If follow_symlinks is False, and the last element of the path is a symbolic
12122 link, getxattr will examine the symbolic link itself instead of the file
12123 the link points to.
12124
12125[clinic start generated code]*/
12126
Larry Hastings2f936352014-08-05 14:04:04 +100012127static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012128os_getxattr_impl(PyObject *module, path_t *path, path_t *attribute,
Larry Hastings89964c42015-04-14 18:07:59 -040012129 int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +000012130/*[clinic end generated code: output=5f2f44200a43cff2 input=025789491708f7eb]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012131{
12132 Py_ssize_t i;
12133 PyObject *buffer = NULL;
12134
12135 if (fd_and_follow_symlinks_invalid("getxattr", path->fd, follow_symlinks))
12136 return NULL;
Benjamin Peterson799bd802011-08-31 22:15:17 -040012137
Saiyang Gou7514f4f2020-02-12 23:47:42 -080012138 if (PySys_Audit("os.getxattr", "OO", path->object, attribute->object) < 0) {
12139 return NULL;
12140 }
12141
Larry Hastings9cf065c2012-06-22 16:30:09 -070012142 for (i = 0; ; i++) {
12143 void *ptr;
12144 ssize_t result;
Serhiy Storchaka2d06e842015-12-25 19:53:18 +020012145 static const Py_ssize_t buffer_sizes[] = {128, XATTR_SIZE_MAX, 0};
Larry Hastings9cf065c2012-06-22 16:30:09 -070012146 Py_ssize_t buffer_size = buffer_sizes[i];
12147 if (!buffer_size) {
Larry Hastings2f936352014-08-05 14:04:04 +100012148 path_error(path);
12149 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070012150 }
12151 buffer = PyBytes_FromStringAndSize(NULL, buffer_size);
12152 if (!buffer)
Larry Hastings2f936352014-08-05 14:04:04 +100012153 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070012154 ptr = PyBytes_AS_STRING(buffer);
Benjamin Peterson799bd802011-08-31 22:15:17 -040012155
Larry Hastings9cf065c2012-06-22 16:30:09 -070012156 Py_BEGIN_ALLOW_THREADS;
Larry Hastings2f936352014-08-05 14:04:04 +100012157 if (path->fd >= 0)
12158 result = fgetxattr(path->fd, attribute->narrow, ptr, buffer_size);
Larry Hastings9cf065c2012-06-22 16:30:09 -070012159 else if (follow_symlinks)
Larry Hastings2f936352014-08-05 14:04:04 +100012160 result = getxattr(path->narrow, attribute->narrow, ptr, buffer_size);
Larry Hastings9cf065c2012-06-22 16:30:09 -070012161 else
Larry Hastings2f936352014-08-05 14:04:04 +100012162 result = lgetxattr(path->narrow, attribute->narrow, ptr, buffer_size);
Larry Hastings9cf065c2012-06-22 16:30:09 -070012163 Py_END_ALLOW_THREADS;
Benjamin Peterson799bd802011-08-31 22:15:17 -040012164
Larry Hastings9cf065c2012-06-22 16:30:09 -070012165 if (result < 0) {
12166 Py_DECREF(buffer);
Larry Hastings9cf065c2012-06-22 16:30:09 -070012167 if (errno == ERANGE)
12168 continue;
Larry Hastings2f936352014-08-05 14:04:04 +100012169 path_error(path);
12170 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070012171 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040012172
Larry Hastings9cf065c2012-06-22 16:30:09 -070012173 if (result != buffer_size) {
12174 /* Can only shrink. */
12175 _PyBytes_Resize(&buffer, result);
12176 }
12177 break;
12178 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040012179
Larry Hastings9cf065c2012-06-22 16:30:09 -070012180 return buffer;
Benjamin Peterson799bd802011-08-31 22:15:17 -040012181}
12182
Larry Hastings2f936352014-08-05 14:04:04 +100012183
12184/*[clinic input]
12185os.setxattr
12186
12187 path: path_t(allow_fd=True)
12188 attribute: path_t
12189 value: Py_buffer
12190 flags: int = 0
12191 *
12192 follow_symlinks: bool = True
12193
12194Set extended attribute attribute on path to value.
12195
BNMetricsb9427072018-11-02 15:20:19 +000012196path may be either a string, a path-like object, or an open file descriptor.
Larry Hastings2f936352014-08-05 14:04:04 +100012197If follow_symlinks is False, and the last element of the path is a symbolic
12198 link, setxattr will modify the symbolic link itself instead of the file
12199 the link points to.
12200
12201[clinic start generated code]*/
12202
Benjamin Peterson799bd802011-08-31 22:15:17 -040012203static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012204os_setxattr_impl(PyObject *module, path_t *path, path_t *attribute,
Larry Hastings89964c42015-04-14 18:07:59 -040012205 Py_buffer *value, int flags, int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +000012206/*[clinic end generated code: output=98b83f63fdde26bb input=c17c0103009042f0]*/
Benjamin Peterson799bd802011-08-31 22:15:17 -040012207{
Larry Hastings2f936352014-08-05 14:04:04 +100012208 ssize_t result;
Benjamin Peterson799bd802011-08-31 22:15:17 -040012209
Larry Hastings2f936352014-08-05 14:04:04 +100012210 if (fd_and_follow_symlinks_invalid("setxattr", path->fd, follow_symlinks))
Benjamin Peterson799bd802011-08-31 22:15:17 -040012211 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070012212
Saiyang Gou7514f4f2020-02-12 23:47:42 -080012213 if (PySys_Audit("os.setxattr", "OOy#i", path->object, attribute->object,
12214 value->buf, value->len, flags) < 0) {
12215 return NULL;
12216 }
12217
Benjamin Peterson799bd802011-08-31 22:15:17 -040012218 Py_BEGIN_ALLOW_THREADS;
Larry Hastings2f936352014-08-05 14:04:04 +100012219 if (path->fd > -1)
12220 result = fsetxattr(path->fd, attribute->narrow,
12221 value->buf, value->len, flags);
Larry Hastings9cf065c2012-06-22 16:30:09 -070012222 else if (follow_symlinks)
Larry Hastings2f936352014-08-05 14:04:04 +100012223 result = setxattr(path->narrow, attribute->narrow,
12224 value->buf, value->len, flags);
Larry Hastings9cf065c2012-06-22 16:30:09 -070012225 else
Larry Hastings2f936352014-08-05 14:04:04 +100012226 result = lsetxattr(path->narrow, attribute->narrow,
12227 value->buf, value->len, flags);
Benjamin Peterson799bd802011-08-31 22:15:17 -040012228 Py_END_ALLOW_THREADS;
Benjamin Peterson799bd802011-08-31 22:15:17 -040012229
Larry Hastings9cf065c2012-06-22 16:30:09 -070012230 if (result) {
Larry Hastings2f936352014-08-05 14:04:04 +100012231 path_error(path);
12232 return NULL;
Benjamin Peterson799bd802011-08-31 22:15:17 -040012233 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040012234
Larry Hastings2f936352014-08-05 14:04:04 +100012235 Py_RETURN_NONE;
12236}
12237
12238
12239/*[clinic input]
12240os.removexattr
12241
12242 path: path_t(allow_fd=True)
12243 attribute: path_t
12244 *
12245 follow_symlinks: bool = True
12246
12247Remove extended attribute attribute on path.
12248
BNMetricsb9427072018-11-02 15:20:19 +000012249path may be either a string, a path-like object, or an open file descriptor.
Larry Hastings2f936352014-08-05 14:04:04 +100012250If follow_symlinks is False, and the last element of the path is a symbolic
12251 link, removexattr will modify the symbolic link itself instead of the file
12252 the link points to.
12253
12254[clinic start generated code]*/
12255
Larry Hastings2f936352014-08-05 14:04:04 +100012256static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012257os_removexattr_impl(PyObject *module, path_t *path, path_t *attribute,
Larry Hastings89964c42015-04-14 18:07:59 -040012258 int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +000012259/*[clinic end generated code: output=521a51817980cda6 input=3d9a7d36fe2f7c4e]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012260{
12261 ssize_t result;
12262
12263 if (fd_and_follow_symlinks_invalid("removexattr", path->fd, follow_symlinks))
12264 return NULL;
12265
Saiyang Gou7514f4f2020-02-12 23:47:42 -080012266 if (PySys_Audit("os.removexattr", "OO", path->object, attribute->object) < 0) {
12267 return NULL;
12268 }
12269
Larry Hastings2f936352014-08-05 14:04:04 +100012270 Py_BEGIN_ALLOW_THREADS;
12271 if (path->fd > -1)
12272 result = fremovexattr(path->fd, attribute->narrow);
12273 else if (follow_symlinks)
12274 result = removexattr(path->narrow, attribute->narrow);
12275 else
12276 result = lremovexattr(path->narrow, attribute->narrow);
12277 Py_END_ALLOW_THREADS;
12278
12279 if (result) {
12280 return path_error(path);
12281 }
12282
12283 Py_RETURN_NONE;
12284}
12285
12286
12287/*[clinic input]
12288os.listxattr
12289
12290 path: path_t(allow_fd=True, nullable=True) = None
12291 *
12292 follow_symlinks: bool = True
12293
12294Return a list of extended attributes on path.
12295
BNMetricsb9427072018-11-02 15:20:19 +000012296path may be either None, a string, a path-like object, or an open file descriptor.
Larry Hastings2f936352014-08-05 14:04:04 +100012297if path is None, listxattr will examine the current directory.
12298If follow_symlinks is False, and the last element of the path is a symbolic
12299 link, listxattr will examine the symbolic link itself instead of the file
12300 the link points to.
12301[clinic start generated code]*/
12302
Larry Hastings2f936352014-08-05 14:04:04 +100012303static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012304os_listxattr_impl(PyObject *module, path_t *path, int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +000012305/*[clinic end generated code: output=bebdb4e2ad0ce435 input=9826edf9fdb90869]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012306{
Larry Hastings9cf065c2012-06-22 16:30:09 -070012307 Py_ssize_t i;
12308 PyObject *result = NULL;
Larry Hastings2f936352014-08-05 14:04:04 +100012309 const char *name;
Larry Hastings9cf065c2012-06-22 16:30:09 -070012310 char *buffer = NULL;
Benjamin Peterson799bd802011-08-31 22:15:17 -040012311
Larry Hastings2f936352014-08-05 14:04:04 +100012312 if (fd_and_follow_symlinks_invalid("listxattr", path->fd, follow_symlinks))
Larry Hastings9cf065c2012-06-22 16:30:09 -070012313 goto exit;
Benjamin Peterson799bd802011-08-31 22:15:17 -040012314
Saiyang Gou7514f4f2020-02-12 23:47:42 -080012315 if (PySys_Audit("os.listxattr", "(O)",
12316 path->object ? path->object : Py_None) < 0) {
12317 return NULL;
12318 }
12319
Larry Hastings2f936352014-08-05 14:04:04 +100012320 name = path->narrow ? path->narrow : ".";
12321
Larry Hastings9cf065c2012-06-22 16:30:09 -070012322 for (i = 0; ; i++) {
Serhiy Storchakadeab18d2016-05-07 16:45:18 +030012323 const char *start, *trace, *end;
Larry Hastings9cf065c2012-06-22 16:30:09 -070012324 ssize_t length;
Serhiy Storchaka2d06e842015-12-25 19:53:18 +020012325 static const Py_ssize_t buffer_sizes[] = { 256, XATTR_LIST_MAX, 0 };
Larry Hastings9cf065c2012-06-22 16:30:09 -070012326 Py_ssize_t buffer_size = buffer_sizes[i];
12327 if (!buffer_size) {
Christian Heimes3b9493b2012-09-23 16:11:15 +020012328 /* ERANGE */
Larry Hastings2f936352014-08-05 14:04:04 +100012329 path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -070012330 break;
12331 }
12332 buffer = PyMem_MALLOC(buffer_size);
12333 if (!buffer) {
12334 PyErr_NoMemory();
12335 break;
12336 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040012337
Larry Hastings9cf065c2012-06-22 16:30:09 -070012338 Py_BEGIN_ALLOW_THREADS;
Larry Hastings2f936352014-08-05 14:04:04 +100012339 if (path->fd > -1)
12340 length = flistxattr(path->fd, buffer, buffer_size);
Larry Hastings9cf065c2012-06-22 16:30:09 -070012341 else if (follow_symlinks)
12342 length = listxattr(name, buffer, buffer_size);
12343 else
12344 length = llistxattr(name, buffer, buffer_size);
12345 Py_END_ALLOW_THREADS;
Benjamin Peterson799bd802011-08-31 22:15:17 -040012346
Larry Hastings9cf065c2012-06-22 16:30:09 -070012347 if (length < 0) {
Antoine Pitrou7f987392013-05-13 19:46:29 +020012348 if (errno == ERANGE) {
12349 PyMem_FREE(buffer);
Benjamin Petersondedac522013-05-13 19:55:40 -050012350 buffer = NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070012351 continue;
Antoine Pitrou7f987392013-05-13 19:46:29 +020012352 }
Larry Hastings2f936352014-08-05 14:04:04 +100012353 path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -070012354 break;
12355 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040012356
Larry Hastings9cf065c2012-06-22 16:30:09 -070012357 result = PyList_New(0);
12358 if (!result) {
12359 goto exit;
12360 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040012361
Larry Hastings9cf065c2012-06-22 16:30:09 -070012362 end = buffer + length;
12363 for (trace = start = buffer; trace != end; trace++) {
12364 if (!*trace) {
12365 int error;
12366 PyObject *attribute = PyUnicode_DecodeFSDefaultAndSize(start,
12367 trace - start);
12368 if (!attribute) {
12369 Py_DECREF(result);
12370 result = NULL;
12371 goto exit;
12372 }
12373 error = PyList_Append(result, attribute);
12374 Py_DECREF(attribute);
12375 if (error) {
12376 Py_DECREF(result);
12377 result = NULL;
12378 goto exit;
12379 }
12380 start = trace + 1;
12381 }
12382 }
12383 break;
12384 }
12385exit:
Larry Hastings9cf065c2012-06-22 16:30:09 -070012386 if (buffer)
12387 PyMem_FREE(buffer);
12388 return result;
Benjamin Peterson799bd802011-08-31 22:15:17 -040012389}
Benjamin Peterson9428d532011-09-14 11:45:52 -040012390#endif /* USE_XATTRS */
Benjamin Peterson799bd802011-08-31 22:15:17 -040012391
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012392
Larry Hastings2f936352014-08-05 14:04:04 +100012393/*[clinic input]
12394os.urandom
12395
12396 size: Py_ssize_t
12397 /
12398
12399Return a bytes object containing random bytes suitable for cryptographic use.
12400[clinic start generated code]*/
12401
Larry Hastings2f936352014-08-05 14:04:04 +100012402static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012403os_urandom_impl(PyObject *module, Py_ssize_t size)
12404/*[clinic end generated code: output=42c5cca9d18068e9 input=4067cdb1b6776c29]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012405{
12406 PyObject *bytes;
12407 int result;
12408
Georg Brandl2fb477c2012-02-21 00:33:36 +010012409 if (size < 0)
12410 return PyErr_Format(PyExc_ValueError,
12411 "negative argument not allowed");
Larry Hastings2f936352014-08-05 14:04:04 +100012412 bytes = PyBytes_FromStringAndSize(NULL, size);
12413 if (bytes == NULL)
Georg Brandl2fb477c2012-02-21 00:33:36 +010012414 return NULL;
12415
Victor Stinnere66987e2016-09-06 16:33:52 -070012416 result = _PyOS_URandom(PyBytes_AS_STRING(bytes), PyBytes_GET_SIZE(bytes));
Larry Hastings2f936352014-08-05 14:04:04 +100012417 if (result == -1) {
12418 Py_DECREF(bytes);
Georg Brandl2fb477c2012-02-21 00:33:36 +010012419 return NULL;
12420 }
Larry Hastings2f936352014-08-05 14:04:04 +100012421 return bytes;
Georg Brandl2fb477c2012-02-21 00:33:36 +010012422}
12423
Zackery Spytz43fdbd22019-05-29 13:57:07 -060012424#ifdef HAVE_MEMFD_CREATE
12425/*[clinic input]
12426os.memfd_create
12427
12428 name: FSConverter
12429 flags: unsigned_int(bitwise=True, c_default="MFD_CLOEXEC") = MFD_CLOEXEC
12430
12431[clinic start generated code]*/
12432
12433static PyObject *
12434os_memfd_create_impl(PyObject *module, PyObject *name, unsigned int flags)
12435/*[clinic end generated code: output=6681ede983bdb9a6 input=a42cfc199bcd56e9]*/
12436{
12437 int fd;
12438 const char *bytes = PyBytes_AS_STRING(name);
12439 Py_BEGIN_ALLOW_THREADS
12440 fd = memfd_create(bytes, flags);
12441 Py_END_ALLOW_THREADS
12442 if (fd == -1) {
12443 return PyErr_SetFromErrno(PyExc_OSError);
12444 }
12445 return PyLong_FromLong(fd);
12446}
12447#endif
12448
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012449/* Terminal size querying */
12450
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012451PyDoc_STRVAR(TerminalSize_docstring,
12452 "A tuple of (columns, lines) for holding terminal window size");
12453
12454static PyStructSequence_Field TerminalSize_fields[] = {
12455 {"columns", "width of the terminal window in characters"},
12456 {"lines", "height of the terminal window in characters"},
12457 {NULL, NULL}
12458};
12459
12460static PyStructSequence_Desc TerminalSize_desc = {
12461 "os.terminal_size",
12462 TerminalSize_docstring,
12463 TerminalSize_fields,
12464 2,
12465};
12466
12467#if defined(TERMSIZE_USE_CONIO) || defined(TERMSIZE_USE_IOCTL)
Serhiy Storchaka2b560312020-04-18 19:14:10 +030012468/*[clinic input]
12469os.get_terminal_size
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012470
Serhiy Storchaka2b560312020-04-18 19:14:10 +030012471 fd: int(c_default="fileno(stdout)", py_default="<unrepresentable>") = -1
12472 /
12473
12474Return the size of the terminal window as (columns, lines).
12475
12476The optional argument fd (default standard output) specifies
12477which file descriptor should be queried.
12478
12479If the file descriptor is not connected to a terminal, an OSError
12480is thrown.
12481
12482This function will only be defined if an implementation is
12483available for this system.
12484
12485shutil.get_terminal_size is the high-level function which should
12486normally be used, os.get_terminal_size is the low-level implementation.
12487[clinic start generated code]*/
12488
12489static PyObject *
12490os_get_terminal_size_impl(PyObject *module, int fd)
12491/*[clinic end generated code: output=fbab93acef980508 input=ead5679b82ddb920]*/
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012492{
12493 int columns, lines;
12494 PyObject *termsize;
12495
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012496 /* Under some conditions stdout may not be connected and
12497 * fileno(stdout) may point to an invalid file descriptor. For example
12498 * GUI apps don't have valid standard streams by default.
12499 *
12500 * If this happens, and the optional fd argument is not present,
12501 * the ioctl below will fail returning EBADF. This is what we want.
12502 */
12503
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012504#ifdef TERMSIZE_USE_IOCTL
12505 {
12506 struct winsize w;
12507 if (ioctl(fd, TIOCGWINSZ, &w))
12508 return PyErr_SetFromErrno(PyExc_OSError);
12509 columns = w.ws_col;
12510 lines = w.ws_row;
12511 }
12512#endif /* TERMSIZE_USE_IOCTL */
12513
12514#ifdef TERMSIZE_USE_CONIO
12515 {
12516 DWORD nhandle;
12517 HANDLE handle;
12518 CONSOLE_SCREEN_BUFFER_INFO csbi;
12519 switch (fd) {
12520 case 0: nhandle = STD_INPUT_HANDLE;
12521 break;
12522 case 1: nhandle = STD_OUTPUT_HANDLE;
12523 break;
12524 case 2: nhandle = STD_ERROR_HANDLE;
12525 break;
12526 default:
12527 return PyErr_Format(PyExc_ValueError, "bad file descriptor");
12528 }
12529 handle = GetStdHandle(nhandle);
12530 if (handle == NULL)
12531 return PyErr_Format(PyExc_OSError, "handle cannot be retrieved");
12532 if (handle == INVALID_HANDLE_VALUE)
12533 return PyErr_SetFromWindowsErr(0);
12534
12535 if (!GetConsoleScreenBufferInfo(handle, &csbi))
12536 return PyErr_SetFromWindowsErr(0);
12537
12538 columns = csbi.srWindow.Right - csbi.srWindow.Left + 1;
12539 lines = csbi.srWindow.Bottom - csbi.srWindow.Top + 1;
12540 }
12541#endif /* TERMSIZE_USE_CONIO */
12542
Serhiy Storchaka2b560312020-04-18 19:14:10 +030012543 PyObject *TerminalSizeType = get_posix_state(module)->TerminalSizeType;
Eddie Elizondob3966632019-11-05 07:16:14 -080012544 termsize = PyStructSequence_New((PyTypeObject *)TerminalSizeType);
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012545 if (termsize == NULL)
12546 return NULL;
12547 PyStructSequence_SET_ITEM(termsize, 0, PyLong_FromLong(columns));
12548 PyStructSequence_SET_ITEM(termsize, 1, PyLong_FromLong(lines));
12549 if (PyErr_Occurred()) {
12550 Py_DECREF(termsize);
12551 return NULL;
12552 }
12553 return termsize;
12554}
12555#endif /* defined(TERMSIZE_USE_CONIO) || defined(TERMSIZE_USE_IOCTL) */
12556
Larry Hastings2f936352014-08-05 14:04:04 +100012557
12558/*[clinic input]
12559os.cpu_count
12560
Charles-François Natali80d62e62015-08-13 20:37:08 +010012561Return the number of CPUs in the system; return None if indeterminable.
12562
12563This number is not equivalent to the number of CPUs the current process can
12564use. The number of usable CPUs can be obtained with
12565``len(os.sched_getaffinity(0))``
Larry Hastings2f936352014-08-05 14:04:04 +100012566[clinic start generated code]*/
12567
Larry Hastings2f936352014-08-05 14:04:04 +100012568static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012569os_cpu_count_impl(PyObject *module)
Serhiy Storchaka2954f832016-07-07 18:20:03 +030012570/*[clinic end generated code: output=5fc29463c3936a9c input=e7c8f4ba6dbbadd3]*/
Charles-Francois Natali44feda32013-05-20 14:40:46 +020012571{
Charles-Francois Natalid59087d2013-05-20 17:31:06 +020012572 int ncpu = 0;
Charles-Francois Natali44feda32013-05-20 14:40:46 +020012573#ifdef MS_WINDOWS
Steve Doweraa929272019-09-11 16:15:39 +010012574 ncpu = GetActiveProcessorCount(ALL_PROCESSOR_GROUPS);
Charles-Francois Natali44feda32013-05-20 14:40:46 +020012575#elif defined(__hpux)
12576 ncpu = mpctl(MPC_GETNUMSPUS, NULL, NULL);
12577#elif defined(HAVE_SYSCONF) && defined(_SC_NPROCESSORS_ONLN)
12578 ncpu = sysconf(_SC_NPROCESSORS_ONLN);
Charles-Francois Natali44feda32013-05-20 14:40:46 +020012579#elif defined(__DragonFly__) || \
12580 defined(__OpenBSD__) || \
12581 defined(__FreeBSD__) || \
Charles-Francois Natalid59087d2013-05-20 17:31:06 +020012582 defined(__NetBSD__) || \
12583 defined(__APPLE__)
Charles-Francois Natali7c4f8da2013-05-20 17:40:32 +020012584 int mib[2];
12585 size_t len = sizeof(ncpu);
12586 mib[0] = CTL_HW;
12587 mib[1] = HW_NCPU;
12588 if (sysctl(mib, 2, &ncpu, &len, NULL, 0) != 0)
12589 ncpu = 0;
Charles-Francois Natali44feda32013-05-20 14:40:46 +020012590#endif
12591 if (ncpu >= 1)
12592 return PyLong_FromLong(ncpu);
12593 else
12594 Py_RETURN_NONE;
12595}
12596
Victor Stinnerdaf45552013-08-28 00:53:59 +020012597
Larry Hastings2f936352014-08-05 14:04:04 +100012598/*[clinic input]
12599os.get_inheritable -> bool
12600
12601 fd: int
12602 /
12603
12604Get the close-on-exe flag of the specified file descriptor.
12605[clinic start generated code]*/
12606
Larry Hastings2f936352014-08-05 14:04:04 +100012607static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012608os_get_inheritable_impl(PyObject *module, int fd)
12609/*[clinic end generated code: output=0445e20e149aa5b8 input=89ac008dc9ab6b95]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012610{
Steve Dower8fc89802015-04-12 00:26:27 -040012611 int return_value;
Steve Dower8fc89802015-04-12 00:26:27 -040012612 _Py_BEGIN_SUPPRESS_IPH
12613 return_value = _Py_get_inheritable(fd);
12614 _Py_END_SUPPRESS_IPH
12615 return return_value;
Larry Hastings2f936352014-08-05 14:04:04 +100012616}
12617
12618
12619/*[clinic input]
12620os.set_inheritable
12621 fd: int
12622 inheritable: int
12623 /
12624
12625Set the inheritable flag of the specified file descriptor.
12626[clinic start generated code]*/
12627
Larry Hastings2f936352014-08-05 14:04:04 +100012628static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012629os_set_inheritable_impl(PyObject *module, int fd, int inheritable)
12630/*[clinic end generated code: output=f1b1918a2f3c38c2 input=9ceaead87a1e2402]*/
Victor Stinnerdaf45552013-08-28 00:53:59 +020012631{
Steve Dower8fc89802015-04-12 00:26:27 -040012632 int result;
Victor Stinnerdaf45552013-08-28 00:53:59 +020012633
Steve Dower8fc89802015-04-12 00:26:27 -040012634 _Py_BEGIN_SUPPRESS_IPH
12635 result = _Py_set_inheritable(fd, inheritable, NULL);
12636 _Py_END_SUPPRESS_IPH
12637 if (result < 0)
Victor Stinnerdaf45552013-08-28 00:53:59 +020012638 return NULL;
12639 Py_RETURN_NONE;
12640}
12641
12642
12643#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +100012644/*[clinic input]
12645os.get_handle_inheritable -> bool
Benjamin Petersonca470632016-09-06 13:47:26 -070012646 handle: intptr_t
Larry Hastings2f936352014-08-05 14:04:04 +100012647 /
Victor Stinnerdaf45552013-08-28 00:53:59 +020012648
Larry Hastings2f936352014-08-05 14:04:04 +100012649Get the close-on-exe flag of the specified file descriptor.
12650[clinic start generated code]*/
12651
Larry Hastings2f936352014-08-05 14:04:04 +100012652static int
Benjamin Petersonca470632016-09-06 13:47:26 -070012653os_get_handle_inheritable_impl(PyObject *module, intptr_t handle)
Victor Stinner581139c2016-09-06 15:54:20 -070012654/*[clinic end generated code: output=36be5afca6ea84d8 input=cfe99f9c05c70ad1]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012655{
12656 DWORD flags;
Victor Stinnerdaf45552013-08-28 00:53:59 +020012657
12658 if (!GetHandleInformation((HANDLE)handle, &flags)) {
12659 PyErr_SetFromWindowsErr(0);
Larry Hastings2f936352014-08-05 14:04:04 +100012660 return -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +020012661 }
12662
Larry Hastings2f936352014-08-05 14:04:04 +100012663 return flags & HANDLE_FLAG_INHERIT;
Victor Stinnerdaf45552013-08-28 00:53:59 +020012664}
12665
Victor Stinnerdaf45552013-08-28 00:53:59 +020012666
Larry Hastings2f936352014-08-05 14:04:04 +100012667/*[clinic input]
12668os.set_handle_inheritable
Benjamin Petersonca470632016-09-06 13:47:26 -070012669 handle: intptr_t
Larry Hastings2f936352014-08-05 14:04:04 +100012670 inheritable: bool
12671 /
12672
12673Set the inheritable flag of the specified handle.
12674[clinic start generated code]*/
12675
Larry Hastings2f936352014-08-05 14:04:04 +100012676static PyObject *
Benjamin Petersonca470632016-09-06 13:47:26 -070012677os_set_handle_inheritable_impl(PyObject *module, intptr_t handle,
Larry Hastings89964c42015-04-14 18:07:59 -040012678 int inheritable)
Victor Stinner581139c2016-09-06 15:54:20 -070012679/*[clinic end generated code: output=021d74fe6c96baa3 input=7a7641390d8364fc]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012680{
12681 DWORD flags = inheritable ? HANDLE_FLAG_INHERIT : 0;
Victor Stinnerdaf45552013-08-28 00:53:59 +020012682 if (!SetHandleInformation((HANDLE)handle, HANDLE_FLAG_INHERIT, flags)) {
12683 PyErr_SetFromWindowsErr(0);
12684 return NULL;
12685 }
12686 Py_RETURN_NONE;
12687}
Larry Hastings2f936352014-08-05 14:04:04 +100012688#endif /* MS_WINDOWS */
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012689
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012690#ifndef MS_WINDOWS
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030012691/*[clinic input]
12692os.get_blocking -> bool
12693 fd: int
12694 /
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012695
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030012696Get the blocking mode of the file descriptor.
12697
12698Return False if the O_NONBLOCK flag is set, True if the flag is cleared.
12699[clinic start generated code]*/
12700
12701static int
12702os_get_blocking_impl(PyObject *module, int fd)
12703/*[clinic end generated code: output=336a12ad76a61482 input=f4afb59d51560179]*/
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012704{
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012705 int blocking;
12706
Steve Dower8fc89802015-04-12 00:26:27 -040012707 _Py_BEGIN_SUPPRESS_IPH
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012708 blocking = _Py_get_blocking(fd);
Steve Dower8fc89802015-04-12 00:26:27 -040012709 _Py_END_SUPPRESS_IPH
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030012710 return blocking;
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012711}
12712
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030012713/*[clinic input]
12714os.set_blocking
12715 fd: int
12716 blocking: bool(accept={int})
12717 /
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012718
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030012719Set the blocking mode of the specified file descriptor.
12720
12721Set the O_NONBLOCK flag if blocking is False,
12722clear the O_NONBLOCK flag otherwise.
12723[clinic start generated code]*/
12724
12725static PyObject *
12726os_set_blocking_impl(PyObject *module, int fd, int blocking)
12727/*[clinic end generated code: output=384eb43aa0762a9d input=bf5c8efdc5860ff3]*/
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012728{
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030012729 int result;
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012730
Steve Dower8fc89802015-04-12 00:26:27 -040012731 _Py_BEGIN_SUPPRESS_IPH
12732 result = _Py_set_blocking(fd, blocking);
12733 _Py_END_SUPPRESS_IPH
12734 if (result < 0)
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012735 return NULL;
12736 Py_RETURN_NONE;
12737}
12738#endif /* !MS_WINDOWS */
12739
12740
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012741/*[clinic input]
Eddie Elizondob3966632019-11-05 07:16:14 -080012742class os.DirEntry "DirEntry *" "DirEntryType"
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012743[clinic start generated code]*/
Eddie Elizondob3966632019-11-05 07:16:14 -080012744/*[clinic end generated code: output=da39a3ee5e6b4b0d input=3c18c7a448247980]*/
Victor Stinner6036e442015-03-08 01:58:04 +010012745
12746typedef struct {
12747 PyObject_HEAD
12748 PyObject *name;
12749 PyObject *path;
12750 PyObject *stat;
12751 PyObject *lstat;
12752#ifdef MS_WINDOWS
12753 struct _Py_stat_struct win32_lstat;
Victor Stinner0f6d7332017-03-09 17:34:28 +010012754 uint64_t win32_file_index;
Victor Stinner6036e442015-03-08 01:58:04 +010012755 int got_file_index;
12756#else /* POSIX */
Victor Stinner35a97c02015-03-08 02:59:09 +010012757#ifdef HAVE_DIRENT_D_TYPE
Victor Stinner6036e442015-03-08 01:58:04 +010012758 unsigned char d_type;
Victor Stinner35a97c02015-03-08 02:59:09 +010012759#endif
Victor Stinner6036e442015-03-08 01:58:04 +010012760 ino_t d_ino;
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012761 int dir_fd;
Victor Stinner6036e442015-03-08 01:58:04 +010012762#endif
12763} DirEntry;
12764
Eddie Elizondob3966632019-11-05 07:16:14 -080012765static PyObject *
12766_disabled_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
12767{
12768 PyErr_Format(PyExc_TypeError,
12769 "cannot create '%.100s' instances", _PyType_Name(type));
12770 return NULL;
12771}
12772
Victor Stinner6036e442015-03-08 01:58:04 +010012773static void
12774DirEntry_dealloc(DirEntry *entry)
12775{
Eddie Elizondob3966632019-11-05 07:16:14 -080012776 PyTypeObject *tp = Py_TYPE(entry);
Victor Stinner6036e442015-03-08 01:58:04 +010012777 Py_XDECREF(entry->name);
12778 Py_XDECREF(entry->path);
12779 Py_XDECREF(entry->stat);
12780 Py_XDECREF(entry->lstat);
Eddie Elizondob3966632019-11-05 07:16:14 -080012781 freefunc free_func = PyType_GetSlot(tp, Py_tp_free);
12782 free_func(entry);
12783 Py_DECREF(tp);
Victor Stinner6036e442015-03-08 01:58:04 +010012784}
12785
12786/* Forward reference */
12787static int
Victor Stinner97f33c32020-05-14 18:05:58 +020012788DirEntry_test_mode(PyTypeObject *defining_class, DirEntry *self,
12789 int follow_symlinks, unsigned short mode_bits);
Victor Stinner6036e442015-03-08 01:58:04 +010012790
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012791/*[clinic input]
12792os.DirEntry.is_symlink -> bool
Victor Stinner97f33c32020-05-14 18:05:58 +020012793 defining_class: defining_class
12794 /
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012795
12796Return True if the entry is a symbolic link; cached per entry.
12797[clinic start generated code]*/
12798
Victor Stinner6036e442015-03-08 01:58:04 +010012799static int
Victor Stinner97f33c32020-05-14 18:05:58 +020012800os_DirEntry_is_symlink_impl(DirEntry *self, PyTypeObject *defining_class)
12801/*[clinic end generated code: output=293096d589b6d47c input=e9acc5ee4d511113]*/
Victor Stinner6036e442015-03-08 01:58:04 +010012802{
12803#ifdef MS_WINDOWS
12804 return (self->win32_lstat.st_mode & S_IFMT) == S_IFLNK;
Victor Stinner35a97c02015-03-08 02:59:09 +010012805#elif defined(HAVE_DIRENT_D_TYPE)
12806 /* POSIX */
Victor Stinner6036e442015-03-08 01:58:04 +010012807 if (self->d_type != DT_UNKNOWN)
12808 return self->d_type == DT_LNK;
12809 else
Victor Stinner97f33c32020-05-14 18:05:58 +020012810 return DirEntry_test_mode(defining_class, self, 0, S_IFLNK);
Victor Stinner35a97c02015-03-08 02:59:09 +010012811#else
12812 /* POSIX without d_type */
Victor Stinner97f33c32020-05-14 18:05:58 +020012813 return DirEntry_test_mode(defining_class, self, 0, S_IFLNK);
Victor Stinner6036e442015-03-08 01:58:04 +010012814#endif
12815}
12816
12817static PyObject *
Victor Stinner97f33c32020-05-14 18:05:58 +020012818DirEntry_fetch_stat(PyObject *module, DirEntry *self, int follow_symlinks)
Victor Stinner6036e442015-03-08 01:58:04 +010012819{
12820 int result;
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012821 STRUCT_STAT st;
12822 PyObject *ub;
Victor Stinner6036e442015-03-08 01:58:04 +010012823
12824#ifdef MS_WINDOWS
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012825 if (!PyUnicode_FSDecoder(self->path, &ub))
12826 return NULL;
12827 const wchar_t *path = PyUnicode_AsUnicode(ub);
Victor Stinner6036e442015-03-08 01:58:04 +010012828#else /* POSIX */
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012829 if (!PyUnicode_FSConverter(self->path, &ub))
12830 return NULL;
12831 const char *path = PyBytes_AS_STRING(ub);
12832 if (self->dir_fd != DEFAULT_DIR_FD) {
12833#ifdef HAVE_FSTATAT
12834 result = fstatat(self->dir_fd, path, &st,
12835 follow_symlinks ? 0 : AT_SYMLINK_NOFOLLOW);
12836#else
12837 PyErr_SetString(PyExc_NotImplementedError, "can't fetch stat");
12838 return NULL;
12839#endif /* HAVE_FSTATAT */
12840 }
12841 else
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012842#endif
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012843 {
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012844 if (follow_symlinks)
12845 result = STAT(path, &st);
12846 else
12847 result = LSTAT(path, &st);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012848 }
12849 Py_DECREF(ub);
Victor Stinner6036e442015-03-08 01:58:04 +010012850
12851 if (result != 0)
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012852 return path_object_error(self->path);
Victor Stinner6036e442015-03-08 01:58:04 +010012853
Victor Stinner97f33c32020-05-14 18:05:58 +020012854 return _pystat_fromstructstat(module, &st);
Victor Stinner6036e442015-03-08 01:58:04 +010012855}
12856
12857static PyObject *
Victor Stinner97f33c32020-05-14 18:05:58 +020012858DirEntry_get_lstat(PyTypeObject *defining_class, DirEntry *self)
Victor Stinner6036e442015-03-08 01:58:04 +010012859{
12860 if (!self->lstat) {
Victor Stinner97f33c32020-05-14 18:05:58 +020012861 PyObject *module = PyType_GetModule(defining_class);
Victor Stinner6036e442015-03-08 01:58:04 +010012862#ifdef MS_WINDOWS
Victor Stinner97f33c32020-05-14 18:05:58 +020012863 self->lstat = _pystat_fromstructstat(module, &self->win32_lstat);
Victor Stinner6036e442015-03-08 01:58:04 +010012864#else /* POSIX */
Victor Stinner97f33c32020-05-14 18:05:58 +020012865 self->lstat = DirEntry_fetch_stat(module, self, 0);
Victor Stinner6036e442015-03-08 01:58:04 +010012866#endif
12867 }
12868 Py_XINCREF(self->lstat);
12869 return self->lstat;
12870}
12871
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012872/*[clinic input]
12873os.DirEntry.stat
Victor Stinner97f33c32020-05-14 18:05:58 +020012874 defining_class: defining_class
12875 /
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012876 *
12877 follow_symlinks: bool = True
12878
12879Return stat_result object for the entry; cached per entry.
12880[clinic start generated code]*/
12881
Victor Stinner6036e442015-03-08 01:58:04 +010012882static PyObject *
Victor Stinner97f33c32020-05-14 18:05:58 +020012883os_DirEntry_stat_impl(DirEntry *self, PyTypeObject *defining_class,
12884 int follow_symlinks)
12885/*[clinic end generated code: output=23f803e19c3e780e input=e816273c4e67ee98]*/
Victor Stinner6036e442015-03-08 01:58:04 +010012886{
Victor Stinner97f33c32020-05-14 18:05:58 +020012887 if (!follow_symlinks) {
12888 return DirEntry_get_lstat(defining_class, self);
12889 }
Victor Stinner6036e442015-03-08 01:58:04 +010012890
12891 if (!self->stat) {
Victor Stinner97f33c32020-05-14 18:05:58 +020012892 int result = os_DirEntry_is_symlink_impl(self, defining_class);
12893 if (result == -1) {
Victor Stinner6036e442015-03-08 01:58:04 +010012894 return NULL;
Victor Stinner97f33c32020-05-14 18:05:58 +020012895 }
12896 if (result) {
12897 PyObject *module = PyType_GetModule(defining_class);
12898 self->stat = DirEntry_fetch_stat(module, self, 1);
12899 }
12900 else {
12901 self->stat = DirEntry_get_lstat(defining_class, self);
12902 }
Victor Stinner6036e442015-03-08 01:58:04 +010012903 }
12904
12905 Py_XINCREF(self->stat);
12906 return self->stat;
12907}
12908
Victor Stinner6036e442015-03-08 01:58:04 +010012909/* Set exception and return -1 on error, 0 for False, 1 for True */
12910static int
Victor Stinner97f33c32020-05-14 18:05:58 +020012911DirEntry_test_mode(PyTypeObject *defining_class, DirEntry *self,
12912 int follow_symlinks, unsigned short mode_bits)
Victor Stinner6036e442015-03-08 01:58:04 +010012913{
12914 PyObject *stat = NULL;
12915 PyObject *st_mode = NULL;
12916 long mode;
12917 int result;
Victor Stinner35a97c02015-03-08 02:59:09 +010012918#if defined(MS_WINDOWS) || defined(HAVE_DIRENT_D_TYPE)
Victor Stinner6036e442015-03-08 01:58:04 +010012919 int is_symlink;
12920 int need_stat;
Victor Stinner35a97c02015-03-08 02:59:09 +010012921#endif
Victor Stinner6036e442015-03-08 01:58:04 +010012922#ifdef MS_WINDOWS
12923 unsigned long dir_bits;
12924#endif
12925
12926#ifdef MS_WINDOWS
12927 is_symlink = (self->win32_lstat.st_mode & S_IFMT) == S_IFLNK;
12928 need_stat = follow_symlinks && is_symlink;
Victor Stinner35a97c02015-03-08 02:59:09 +010012929#elif defined(HAVE_DIRENT_D_TYPE)
Victor Stinner6036e442015-03-08 01:58:04 +010012930 is_symlink = self->d_type == DT_LNK;
12931 need_stat = self->d_type == DT_UNKNOWN || (follow_symlinks && is_symlink);
12932#endif
12933
Victor Stinner35a97c02015-03-08 02:59:09 +010012934#if defined(MS_WINDOWS) || defined(HAVE_DIRENT_D_TYPE)
Victor Stinner6036e442015-03-08 01:58:04 +010012935 if (need_stat) {
Victor Stinner35a97c02015-03-08 02:59:09 +010012936#endif
Victor Stinner97f33c32020-05-14 18:05:58 +020012937 stat = os_DirEntry_stat_impl(self, defining_class, follow_symlinks);
Victor Stinner6036e442015-03-08 01:58:04 +010012938 if (!stat) {
12939 if (PyErr_ExceptionMatches(PyExc_FileNotFoundError)) {
12940 /* If file doesn't exist (anymore), then return False
12941 (i.e., say it's not a file/directory) */
12942 PyErr_Clear();
12943 return 0;
12944 }
12945 goto error;
12946 }
Victor Stinner97f33c32020-05-14 18:05:58 +020012947 _posixstate* state = get_posix_state(PyType_GetModule(defining_class));
12948 st_mode = PyObject_GetAttr(stat, state->st_mode);
Victor Stinner6036e442015-03-08 01:58:04 +010012949 if (!st_mode)
12950 goto error;
12951
12952 mode = PyLong_AsLong(st_mode);
12953 if (mode == -1 && PyErr_Occurred())
12954 goto error;
12955 Py_CLEAR(st_mode);
12956 Py_CLEAR(stat);
12957 result = (mode & S_IFMT) == mode_bits;
Victor Stinner35a97c02015-03-08 02:59:09 +010012958#if defined(MS_WINDOWS) || defined(HAVE_DIRENT_D_TYPE)
Victor Stinner6036e442015-03-08 01:58:04 +010012959 }
12960 else if (is_symlink) {
12961 assert(mode_bits != S_IFLNK);
12962 result = 0;
12963 }
12964 else {
12965 assert(mode_bits == S_IFDIR || mode_bits == S_IFREG);
12966#ifdef MS_WINDOWS
12967 dir_bits = self->win32_lstat.st_file_attributes & FILE_ATTRIBUTE_DIRECTORY;
12968 if (mode_bits == S_IFDIR)
12969 result = dir_bits != 0;
12970 else
12971 result = dir_bits == 0;
12972#else /* POSIX */
12973 if (mode_bits == S_IFDIR)
12974 result = self->d_type == DT_DIR;
12975 else
12976 result = self->d_type == DT_REG;
12977#endif
12978 }
Victor Stinner35a97c02015-03-08 02:59:09 +010012979#endif
Victor Stinner6036e442015-03-08 01:58:04 +010012980
12981 return result;
12982
12983error:
12984 Py_XDECREF(st_mode);
12985 Py_XDECREF(stat);
12986 return -1;
12987}
12988
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012989/*[clinic input]
12990os.DirEntry.is_dir -> bool
Victor Stinner97f33c32020-05-14 18:05:58 +020012991 defining_class: defining_class
12992 /
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012993 *
12994 follow_symlinks: bool = True
Victor Stinner6036e442015-03-08 01:58:04 +010012995
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012996Return True if the entry is a directory; cached per entry.
12997[clinic start generated code]*/
12998
12999static int
Victor Stinner97f33c32020-05-14 18:05:58 +020013000os_DirEntry_is_dir_impl(DirEntry *self, PyTypeObject *defining_class,
13001 int follow_symlinks)
13002/*[clinic end generated code: output=0cd453b9c0987fdf input=1a4ffd6dec9920cb]*/
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013003{
Victor Stinner97f33c32020-05-14 18:05:58 +020013004 return DirEntry_test_mode(defining_class, self, follow_symlinks, S_IFDIR);
Victor Stinner6036e442015-03-08 01:58:04 +010013005}
13006
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013007/*[clinic input]
13008os.DirEntry.is_file -> bool
Victor Stinner97f33c32020-05-14 18:05:58 +020013009 defining_class: defining_class
13010 /
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013011 *
13012 follow_symlinks: bool = True
13013
13014Return True if the entry is a file; cached per entry.
13015[clinic start generated code]*/
13016
13017static int
Victor Stinner97f33c32020-05-14 18:05:58 +020013018os_DirEntry_is_file_impl(DirEntry *self, PyTypeObject *defining_class,
13019 int follow_symlinks)
13020/*[clinic end generated code: output=f7c277ab5ba80908 input=0a64c5a12e802e3b]*/
Victor Stinner6036e442015-03-08 01:58:04 +010013021{
Victor Stinner97f33c32020-05-14 18:05:58 +020013022 return DirEntry_test_mode(defining_class, self, follow_symlinks, S_IFREG);
Victor Stinner6036e442015-03-08 01:58:04 +010013023}
13024
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013025/*[clinic input]
13026os.DirEntry.inode
Victor Stinner6036e442015-03-08 01:58:04 +010013027
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013028Return inode of the entry; cached per entry.
13029[clinic start generated code]*/
Victor Stinner6036e442015-03-08 01:58:04 +010013030
13031static PyObject *
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013032os_DirEntry_inode_impl(DirEntry *self)
13033/*[clinic end generated code: output=156bb3a72162440e input=3ee7b872ae8649f0]*/
Victor Stinner6036e442015-03-08 01:58:04 +010013034{
13035#ifdef MS_WINDOWS
13036 if (!self->got_file_index) {
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030013037 PyObject *unicode;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +030013038 const wchar_t *path;
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030013039 STRUCT_STAT stat;
13040 int result;
Victor Stinner6036e442015-03-08 01:58:04 +010013041
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030013042 if (!PyUnicode_FSDecoder(self->path, &unicode))
Victor Stinner6036e442015-03-08 01:58:04 +010013043 return NULL;
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030013044 path = PyUnicode_AsUnicode(unicode);
13045 result = LSTAT(path, &stat);
13046 Py_DECREF(unicode);
Victor Stinner6036e442015-03-08 01:58:04 +010013047
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030013048 if (result != 0)
13049 return path_object_error(self->path);
Victor Stinner6036e442015-03-08 01:58:04 +010013050
13051 self->win32_file_index = stat.st_ino;
13052 self->got_file_index = 1;
13053 }
Victor Stinner0f6d7332017-03-09 17:34:28 +010013054 Py_BUILD_ASSERT(sizeof(unsigned long long) >= sizeof(self->win32_file_index));
13055 return PyLong_FromUnsignedLongLong(self->win32_file_index);
Victor Stinner6036e442015-03-08 01:58:04 +010013056#else /* POSIX */
xdegaye50e86032017-05-22 11:15:08 +020013057 Py_BUILD_ASSERT(sizeof(unsigned long long) >= sizeof(self->d_ino));
13058 return PyLong_FromUnsignedLongLong(self->d_ino);
Victor Stinner6036e442015-03-08 01:58:04 +010013059#endif
13060}
13061
13062static PyObject *
13063DirEntry_repr(DirEntry *self)
13064{
13065 return PyUnicode_FromFormat("<DirEntry %R>", self->name);
13066}
13067
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013068/*[clinic input]
13069os.DirEntry.__fspath__
13070
13071Returns the path for the entry.
13072[clinic start generated code]*/
13073
Brett Cannon96881cd2016-06-10 14:37:21 -070013074static PyObject *
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013075os_DirEntry___fspath___impl(DirEntry *self)
13076/*[clinic end generated code: output=6dd7f7ef752e6f4f input=3c49d0cf38df4fac]*/
Brett Cannon96881cd2016-06-10 14:37:21 -070013077{
13078 Py_INCREF(self->path);
13079 return self->path;
13080}
13081
Victor Stinner6036e442015-03-08 01:58:04 +010013082static PyMemberDef DirEntry_members[] = {
13083 {"name", T_OBJECT_EX, offsetof(DirEntry, name), READONLY,
13084 "the entry's base filename, relative to scandir() \"path\" argument"},
13085 {"path", T_OBJECT_EX, offsetof(DirEntry, path), READONLY,
13086 "the entry's full path name; equivalent to os.path.join(scandir_path, entry.name)"},
13087 {NULL}
13088};
13089
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013090#include "clinic/posixmodule.c.h"
13091
Victor Stinner6036e442015-03-08 01:58:04 +010013092static PyMethodDef DirEntry_methods[] = {
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013093 OS_DIRENTRY_IS_DIR_METHODDEF
13094 OS_DIRENTRY_IS_FILE_METHODDEF
13095 OS_DIRENTRY_IS_SYMLINK_METHODDEF
13096 OS_DIRENTRY_STAT_METHODDEF
13097 OS_DIRENTRY_INODE_METHODDEF
13098 OS_DIRENTRY___FSPATH___METHODDEF
Batuhan Taşkayaf9dd51e2020-04-08 00:37:19 +030013099 {"__class_getitem__", (PyCFunction)Py_GenericAlias,
13100 METH_O|METH_CLASS, PyDoc_STR("See PEP 585")},
Victor Stinner6036e442015-03-08 01:58:04 +010013101 {NULL}
13102};
13103
Eddie Elizondob3966632019-11-05 07:16:14 -080013104static PyType_Slot DirEntryType_slots[] = {
13105 {Py_tp_new, _disabled_new},
13106 {Py_tp_dealloc, DirEntry_dealloc},
13107 {Py_tp_repr, DirEntry_repr},
13108 {Py_tp_methods, DirEntry_methods},
13109 {Py_tp_members, DirEntry_members},
13110 {0, 0},
Victor Stinner6036e442015-03-08 01:58:04 +010013111};
13112
Eddie Elizondob3966632019-11-05 07:16:14 -080013113static PyType_Spec DirEntryType_spec = {
13114 MODNAME ".DirEntry",
13115 sizeof(DirEntry),
13116 0,
13117 Py_TPFLAGS_DEFAULT,
13118 DirEntryType_slots
13119};
13120
13121
Victor Stinner6036e442015-03-08 01:58:04 +010013122#ifdef MS_WINDOWS
13123
13124static wchar_t *
Serhiy Storchakadeab18d2016-05-07 16:45:18 +030013125join_path_filenameW(const wchar_t *path_wide, const wchar_t *filename)
Victor Stinner6036e442015-03-08 01:58:04 +010013126{
13127 Py_ssize_t path_len;
13128 Py_ssize_t size;
13129 wchar_t *result;
13130 wchar_t ch;
13131
13132 if (!path_wide) { /* Default arg: "." */
13133 path_wide = L".";
13134 path_len = 1;
13135 }
13136 else {
13137 path_len = wcslen(path_wide);
13138 }
13139
13140 /* The +1's are for the path separator and the NUL */
13141 size = path_len + 1 + wcslen(filename) + 1;
13142 result = PyMem_New(wchar_t, size);
13143 if (!result) {
13144 PyErr_NoMemory();
13145 return NULL;
13146 }
13147 wcscpy(result, path_wide);
13148 if (path_len > 0) {
13149 ch = result[path_len - 1];
13150 if (ch != SEP && ch != ALTSEP && ch != L':')
13151 result[path_len++] = SEP;
13152 wcscpy(result + path_len, filename);
13153 }
13154 return result;
13155}
13156
13157static PyObject *
Victor Stinner1c2fa782020-05-10 11:05:29 +020013158DirEntry_from_find_data(PyObject *module, path_t *path, WIN32_FIND_DATAW *dataW)
Victor Stinner6036e442015-03-08 01:58:04 +010013159{
13160 DirEntry *entry;
13161 BY_HANDLE_FILE_INFORMATION file_info;
13162 ULONG reparse_tag;
13163 wchar_t *joined_path;
13164
Victor Stinner1c2fa782020-05-10 11:05:29 +020013165 PyObject *DirEntryType = get_posix_state(module)->DirEntryType;
Eddie Elizondob3966632019-11-05 07:16:14 -080013166 entry = PyObject_New(DirEntry, (PyTypeObject *)DirEntryType);
Victor Stinner6036e442015-03-08 01:58:04 +010013167 if (!entry)
13168 return NULL;
13169 entry->name = NULL;
13170 entry->path = NULL;
13171 entry->stat = NULL;
13172 entry->lstat = NULL;
13173 entry->got_file_index = 0;
13174
13175 entry->name = PyUnicode_FromWideChar(dataW->cFileName, -1);
13176 if (!entry->name)
13177 goto error;
Steve Dowercc16be82016-09-08 10:35:16 -070013178 if (path->narrow) {
13179 Py_SETREF(entry->name, PyUnicode_EncodeFSDefault(entry->name));
13180 if (!entry->name)
13181 goto error;
13182 }
Victor Stinner6036e442015-03-08 01:58:04 +010013183
13184 joined_path = join_path_filenameW(path->wide, dataW->cFileName);
13185 if (!joined_path)
13186 goto error;
13187
13188 entry->path = PyUnicode_FromWideChar(joined_path, -1);
13189 PyMem_Free(joined_path);
13190 if (!entry->path)
13191 goto error;
Steve Dowercc16be82016-09-08 10:35:16 -070013192 if (path->narrow) {
13193 Py_SETREF(entry->path, PyUnicode_EncodeFSDefault(entry->path));
13194 if (!entry->path)
13195 goto error;
13196 }
Victor Stinner6036e442015-03-08 01:58:04 +010013197
Steve Dowercc16be82016-09-08 10:35:16 -070013198 find_data_to_file_info(dataW, &file_info, &reparse_tag);
Victor Stinner6036e442015-03-08 01:58:04 +010013199 _Py_attribute_data_to_stat(&file_info, reparse_tag, &entry->win32_lstat);
13200
13201 return (PyObject *)entry;
13202
13203error:
13204 Py_DECREF(entry);
13205 return NULL;
13206}
13207
13208#else /* POSIX */
13209
13210static char *
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020013211join_path_filename(const char *path_narrow, const char* filename, Py_ssize_t filename_len)
Victor Stinner6036e442015-03-08 01:58:04 +010013212{
13213 Py_ssize_t path_len;
13214 Py_ssize_t size;
13215 char *result;
13216
13217 if (!path_narrow) { /* Default arg: "." */
13218 path_narrow = ".";
13219 path_len = 1;
13220 }
13221 else {
13222 path_len = strlen(path_narrow);
13223 }
13224
13225 if (filename_len == -1)
13226 filename_len = strlen(filename);
13227
13228 /* The +1's are for the path separator and the NUL */
13229 size = path_len + 1 + filename_len + 1;
13230 result = PyMem_New(char, size);
13231 if (!result) {
13232 PyErr_NoMemory();
13233 return NULL;
13234 }
13235 strcpy(result, path_narrow);
13236 if (path_len > 0 && result[path_len - 1] != '/')
13237 result[path_len++] = '/';
13238 strcpy(result + path_len, filename);
13239 return result;
13240}
13241
13242static PyObject *
Victor Stinner1c2fa782020-05-10 11:05:29 +020013243DirEntry_from_posix_info(PyObject *module, path_t *path, const char *name,
13244 Py_ssize_t name_len, ino_t d_ino
Victor Stinner35a97c02015-03-08 02:59:09 +010013245#ifdef HAVE_DIRENT_D_TYPE
13246 , unsigned char d_type
13247#endif
13248 )
Victor Stinner6036e442015-03-08 01:58:04 +010013249{
13250 DirEntry *entry;
13251 char *joined_path;
13252
Victor Stinner1c2fa782020-05-10 11:05:29 +020013253 PyObject *DirEntryType = get_posix_state(module)->DirEntryType;
Eddie Elizondob3966632019-11-05 07:16:14 -080013254 entry = PyObject_New(DirEntry, (PyTypeObject *)DirEntryType);
Victor Stinner6036e442015-03-08 01:58:04 +010013255 if (!entry)
13256 return NULL;
13257 entry->name = NULL;
13258 entry->path = NULL;
13259 entry->stat = NULL;
13260 entry->lstat = NULL;
13261
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013262 if (path->fd != -1) {
13263 entry->dir_fd = path->fd;
13264 joined_path = NULL;
13265 }
13266 else {
13267 entry->dir_fd = DEFAULT_DIR_FD;
13268 joined_path = join_path_filename(path->narrow, name, name_len);
13269 if (!joined_path)
13270 goto error;
13271 }
Victor Stinner6036e442015-03-08 01:58:04 +010013272
Serhiy Storchaka1180e5a2017-07-11 06:36:46 +030013273 if (!path->narrow || !PyObject_CheckBuffer(path->object)) {
Victor Stinner6036e442015-03-08 01:58:04 +010013274 entry->name = PyUnicode_DecodeFSDefaultAndSize(name, name_len);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013275 if (joined_path)
13276 entry->path = PyUnicode_DecodeFSDefault(joined_path);
Victor Stinner6036e442015-03-08 01:58:04 +010013277 }
13278 else {
13279 entry->name = PyBytes_FromStringAndSize(name, name_len);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013280 if (joined_path)
13281 entry->path = PyBytes_FromString(joined_path);
Victor Stinner6036e442015-03-08 01:58:04 +010013282 }
13283 PyMem_Free(joined_path);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013284 if (!entry->name)
13285 goto error;
13286
13287 if (path->fd != -1) {
13288 entry->path = entry->name;
13289 Py_INCREF(entry->path);
13290 }
13291 else if (!entry->path)
Victor Stinner6036e442015-03-08 01:58:04 +010013292 goto error;
13293
Victor Stinner35a97c02015-03-08 02:59:09 +010013294#ifdef HAVE_DIRENT_D_TYPE
Victor Stinner6036e442015-03-08 01:58:04 +010013295 entry->d_type = d_type;
Victor Stinner35a97c02015-03-08 02:59:09 +010013296#endif
Victor Stinner6036e442015-03-08 01:58:04 +010013297 entry->d_ino = d_ino;
13298
13299 return (PyObject *)entry;
13300
13301error:
13302 Py_XDECREF(entry);
13303 return NULL;
13304}
13305
13306#endif
13307
13308
13309typedef struct {
13310 PyObject_HEAD
13311 path_t path;
13312#ifdef MS_WINDOWS
13313 HANDLE handle;
13314 WIN32_FIND_DATAW file_data;
13315 int first_time;
13316#else /* POSIX */
13317 DIR *dirp;
13318#endif
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013319#ifdef HAVE_FDOPENDIR
13320 int fd;
13321#endif
Victor Stinner6036e442015-03-08 01:58:04 +010013322} ScandirIterator;
13323
13324#ifdef MS_WINDOWS
13325
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013326static int
13327ScandirIterator_is_closed(ScandirIterator *iterator)
13328{
13329 return iterator->handle == INVALID_HANDLE_VALUE;
13330}
13331
Victor Stinner6036e442015-03-08 01:58:04 +010013332static void
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013333ScandirIterator_closedir(ScandirIterator *iterator)
Victor Stinner6036e442015-03-08 01:58:04 +010013334{
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030013335 HANDLE handle = iterator->handle;
13336
13337 if (handle == INVALID_HANDLE_VALUE)
Victor Stinner6036e442015-03-08 01:58:04 +010013338 return;
13339
Victor Stinner6036e442015-03-08 01:58:04 +010013340 iterator->handle = INVALID_HANDLE_VALUE;
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030013341 Py_BEGIN_ALLOW_THREADS
13342 FindClose(handle);
13343 Py_END_ALLOW_THREADS
Victor Stinner6036e442015-03-08 01:58:04 +010013344}
13345
13346static PyObject *
13347ScandirIterator_iternext(ScandirIterator *iterator)
13348{
13349 WIN32_FIND_DATAW *file_data = &iterator->file_data;
13350 BOOL success;
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013351 PyObject *entry;
Victor Stinner6036e442015-03-08 01:58:04 +010013352
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013353 /* Happens if the iterator is iterated twice, or closed explicitly */
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013354 if (iterator->handle == INVALID_HANDLE_VALUE)
Victor Stinner6036e442015-03-08 01:58:04 +010013355 return NULL;
Victor Stinner6036e442015-03-08 01:58:04 +010013356
13357 while (1) {
13358 if (!iterator->first_time) {
13359 Py_BEGIN_ALLOW_THREADS
13360 success = FindNextFileW(iterator->handle, file_data);
13361 Py_END_ALLOW_THREADS
13362 if (!success) {
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013363 /* Error or no more files */
Victor Stinner6036e442015-03-08 01:58:04 +010013364 if (GetLastError() != ERROR_NO_MORE_FILES)
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013365 path_error(&iterator->path);
Victor Stinner6036e442015-03-08 01:58:04 +010013366 break;
13367 }
13368 }
13369 iterator->first_time = 0;
13370
13371 /* Skip over . and .. */
13372 if (wcscmp(file_data->cFileName, L".") != 0 &&
Victor Stinner1c2fa782020-05-10 11:05:29 +020013373 wcscmp(file_data->cFileName, L"..") != 0)
13374 {
13375 PyObject *module = PyType_GetModule(Py_TYPE(iterator));
13376 entry = DirEntry_from_find_data(module, &iterator->path, file_data);
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013377 if (!entry)
13378 break;
13379 return entry;
13380 }
Victor Stinner6036e442015-03-08 01:58:04 +010013381
13382 /* Loop till we get a non-dot directory or finish iterating */
13383 }
13384
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013385 /* Error or no more files */
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013386 ScandirIterator_closedir(iterator);
Victor Stinner6036e442015-03-08 01:58:04 +010013387 return NULL;
13388}
13389
13390#else /* POSIX */
13391
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013392static int
13393ScandirIterator_is_closed(ScandirIterator *iterator)
13394{
13395 return !iterator->dirp;
13396}
13397
Victor Stinner6036e442015-03-08 01:58:04 +010013398static void
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013399ScandirIterator_closedir(ScandirIterator *iterator)
Victor Stinner6036e442015-03-08 01:58:04 +010013400{
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030013401 DIR *dirp = iterator->dirp;
13402
13403 if (!dirp)
Victor Stinner6036e442015-03-08 01:58:04 +010013404 return;
13405
Victor Stinner6036e442015-03-08 01:58:04 +010013406 iterator->dirp = NULL;
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030013407 Py_BEGIN_ALLOW_THREADS
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013408#ifdef HAVE_FDOPENDIR
13409 if (iterator->path.fd != -1)
13410 rewinddir(dirp);
13411#endif
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030013412 closedir(dirp);
13413 Py_END_ALLOW_THREADS
Victor Stinner6036e442015-03-08 01:58:04 +010013414 return;
13415}
13416
13417static PyObject *
13418ScandirIterator_iternext(ScandirIterator *iterator)
13419{
13420 struct dirent *direntp;
13421 Py_ssize_t name_len;
13422 int is_dot;
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013423 PyObject *entry;
Victor Stinner6036e442015-03-08 01:58:04 +010013424
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013425 /* Happens if the iterator is iterated twice, or closed explicitly */
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013426 if (!iterator->dirp)
Victor Stinner6036e442015-03-08 01:58:04 +010013427 return NULL;
Victor Stinner6036e442015-03-08 01:58:04 +010013428
13429 while (1) {
13430 errno = 0;
13431 Py_BEGIN_ALLOW_THREADS
13432 direntp = readdir(iterator->dirp);
13433 Py_END_ALLOW_THREADS
13434
13435 if (!direntp) {
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013436 /* Error or no more files */
Victor Stinner6036e442015-03-08 01:58:04 +010013437 if (errno != 0)
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013438 path_error(&iterator->path);
Victor Stinner6036e442015-03-08 01:58:04 +010013439 break;
13440 }
13441
13442 /* Skip over . and .. */
13443 name_len = NAMLEN(direntp);
13444 is_dot = direntp->d_name[0] == '.' &&
13445 (name_len == 1 || (direntp->d_name[1] == '.' && name_len == 2));
13446 if (!is_dot) {
Victor Stinner1c2fa782020-05-10 11:05:29 +020013447 PyObject *module = PyType_GetModule(Py_TYPE(iterator));
13448 entry = DirEntry_from_posix_info(module,
13449 &iterator->path, direntp->d_name,
13450 name_len, direntp->d_ino
Victor Stinner35a97c02015-03-08 02:59:09 +010013451#ifdef HAVE_DIRENT_D_TYPE
Victor Stinner1c2fa782020-05-10 11:05:29 +020013452 , direntp->d_type
Victor Stinner35a97c02015-03-08 02:59:09 +010013453#endif
13454 );
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013455 if (!entry)
13456 break;
13457 return entry;
Victor Stinner6036e442015-03-08 01:58:04 +010013458 }
13459
13460 /* Loop till we get a non-dot directory or finish iterating */
13461 }
13462
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013463 /* Error or no more files */
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013464 ScandirIterator_closedir(iterator);
Victor Stinner6036e442015-03-08 01:58:04 +010013465 return NULL;
13466}
13467
13468#endif
13469
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013470static PyObject *
13471ScandirIterator_close(ScandirIterator *self, PyObject *args)
13472{
13473 ScandirIterator_closedir(self);
13474 Py_RETURN_NONE;
13475}
13476
13477static PyObject *
13478ScandirIterator_enter(PyObject *self, PyObject *args)
13479{
13480 Py_INCREF(self);
13481 return self;
13482}
13483
13484static PyObject *
13485ScandirIterator_exit(ScandirIterator *self, PyObject *args)
13486{
13487 ScandirIterator_closedir(self);
13488 Py_RETURN_NONE;
13489}
13490
Victor Stinner6036e442015-03-08 01:58:04 +010013491static void
Victor Stinner7bfa4092016-03-23 00:43:54 +010013492ScandirIterator_finalize(ScandirIterator *iterator)
13493{
13494 PyObject *error_type, *error_value, *error_traceback;
13495
13496 /* Save the current exception, if any. */
13497 PyErr_Fetch(&error_type, &error_value, &error_traceback);
13498
13499 if (!ScandirIterator_is_closed(iterator)) {
13500 ScandirIterator_closedir(iterator);
13501
13502 if (PyErr_ResourceWarning((PyObject *)iterator, 1,
13503 "unclosed scandir iterator %R", iterator)) {
13504 /* Spurious errors can appear at shutdown */
13505 if (PyErr_ExceptionMatches(PyExc_Warning)) {
13506 PyErr_WriteUnraisable((PyObject *) iterator);
13507 }
13508 }
13509 }
13510
Victor Stinner7bfa4092016-03-23 00:43:54 +010013511 path_cleanup(&iterator->path);
13512
13513 /* Restore the saved exception. */
13514 PyErr_Restore(error_type, error_value, error_traceback);
13515}
13516
13517static void
Victor Stinner6036e442015-03-08 01:58:04 +010013518ScandirIterator_dealloc(ScandirIterator *iterator)
13519{
Eddie Elizondob3966632019-11-05 07:16:14 -080013520 PyTypeObject *tp = Py_TYPE(iterator);
Victor Stinner7bfa4092016-03-23 00:43:54 +010013521 if (PyObject_CallFinalizerFromDealloc((PyObject *)iterator) < 0)
13522 return;
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013523
Eddie Elizondob3966632019-11-05 07:16:14 -080013524 freefunc free_func = PyType_GetSlot(tp, Py_tp_free);
13525 free_func(iterator);
13526 Py_DECREF(tp);
Victor Stinner6036e442015-03-08 01:58:04 +010013527}
13528
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013529static PyMethodDef ScandirIterator_methods[] = {
13530 {"__enter__", (PyCFunction)ScandirIterator_enter, METH_NOARGS},
13531 {"__exit__", (PyCFunction)ScandirIterator_exit, METH_VARARGS},
13532 {"close", (PyCFunction)ScandirIterator_close, METH_NOARGS},
13533 {NULL}
13534};
13535
Eddie Elizondob3966632019-11-05 07:16:14 -080013536static PyType_Slot ScandirIteratorType_slots[] = {
13537 {Py_tp_new, _disabled_new},
13538 {Py_tp_dealloc, ScandirIterator_dealloc},
13539 {Py_tp_finalize, ScandirIterator_finalize},
13540 {Py_tp_iter, PyObject_SelfIter},
13541 {Py_tp_iternext, ScandirIterator_iternext},
13542 {Py_tp_methods, ScandirIterator_methods},
13543 {0, 0},
13544};
13545
13546static PyType_Spec ScandirIteratorType_spec = {
13547 MODNAME ".ScandirIterator",
13548 sizeof(ScandirIterator),
13549 0,
Victor Stinner97f33c32020-05-14 18:05:58 +020013550 // bpo-40549: Py_TPFLAGS_BASETYPE should not be used, since
13551 // PyType_GetModule(Py_TYPE(self)) doesn't work on a subclass instance.
Eddie Elizondob3966632019-11-05 07:16:14 -080013552 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_FINALIZE,
13553 ScandirIteratorType_slots
Victor Stinner6036e442015-03-08 01:58:04 +010013554};
13555
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013556/*[clinic input]
13557os.scandir
13558
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013559 path : path_t(nullable=True, allow_fd='PATH_HAVE_FDOPENDIR') = None
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013560
13561Return an iterator of DirEntry objects for given path.
13562
BNMetricsb9427072018-11-02 15:20:19 +000013563path can be specified as either str, bytes, or a path-like object. If path
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013564is bytes, the names of yielded DirEntry objects will also be bytes; in
13565all other circumstances they will be str.
13566
13567If path is None, uses the path='.'.
13568[clinic start generated code]*/
13569
Victor Stinner6036e442015-03-08 01:58:04 +010013570static PyObject *
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013571os_scandir_impl(PyObject *module, path_t *path)
BNMetricsb9427072018-11-02 15:20:19 +000013572/*[clinic end generated code: output=6eb2668b675ca89e input=6bdd312708fc3bb0]*/
Victor Stinner6036e442015-03-08 01:58:04 +010013573{
13574 ScandirIterator *iterator;
Victor Stinner6036e442015-03-08 01:58:04 +010013575#ifdef MS_WINDOWS
13576 wchar_t *path_strW;
13577#else
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013578 const char *path_str;
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013579#ifdef HAVE_FDOPENDIR
13580 int fd = -1;
13581#endif
Victor Stinner6036e442015-03-08 01:58:04 +010013582#endif
13583
Steve Dower60419a72019-06-24 08:42:54 -070013584 if (PySys_Audit("os.scandir", "O",
13585 path->object ? path->object : Py_None) < 0) {
13586 return NULL;
13587 }
13588
Hai Shif707d942020-03-16 21:15:01 +080013589 PyObject *ScandirIteratorType = get_posix_state(module)->ScandirIteratorType;
Eddie Elizondob3966632019-11-05 07:16:14 -080013590 iterator = PyObject_New(ScandirIterator, (PyTypeObject *)ScandirIteratorType);
Victor Stinner6036e442015-03-08 01:58:04 +010013591 if (!iterator)
13592 return NULL;
Victor Stinner6036e442015-03-08 01:58:04 +010013593
13594#ifdef MS_WINDOWS
13595 iterator->handle = INVALID_HANDLE_VALUE;
13596#else
13597 iterator->dirp = NULL;
13598#endif
13599
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013600 memcpy(&iterator->path, path, sizeof(path_t));
Serhiy Storchaka095ef732017-02-09 20:05:51 +020013601 /* Move the ownership to iterator->path */
13602 path->object = NULL;
13603 path->cleanup = NULL;
Victor Stinner6036e442015-03-08 01:58:04 +010013604
13605#ifdef MS_WINDOWS
Victor Stinner6036e442015-03-08 01:58:04 +010013606 iterator->first_time = 1;
13607
13608 path_strW = join_path_filenameW(iterator->path.wide, L"*.*");
13609 if (!path_strW)
13610 goto error;
13611
13612 Py_BEGIN_ALLOW_THREADS
13613 iterator->handle = FindFirstFileW(path_strW, &iterator->file_data);
13614 Py_END_ALLOW_THREADS
13615
13616 PyMem_Free(path_strW);
13617
13618 if (iterator->handle == INVALID_HANDLE_VALUE) {
13619 path_error(&iterator->path);
13620 goto error;
13621 }
13622#else /* POSIX */
Victor Stinner6036e442015-03-08 01:58:04 +010013623 errno = 0;
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013624#ifdef HAVE_FDOPENDIR
13625 if (path->fd != -1) {
13626 /* closedir() closes the FD, so we duplicate it */
13627 fd = _Py_dup(path->fd);
13628 if (fd == -1)
13629 goto error;
13630
13631 Py_BEGIN_ALLOW_THREADS
13632 iterator->dirp = fdopendir(fd);
13633 Py_END_ALLOW_THREADS
13634 }
13635 else
13636#endif
13637 {
13638 if (iterator->path.narrow)
13639 path_str = iterator->path.narrow;
13640 else
13641 path_str = ".";
13642
13643 Py_BEGIN_ALLOW_THREADS
13644 iterator->dirp = opendir(path_str);
13645 Py_END_ALLOW_THREADS
13646 }
Victor Stinner6036e442015-03-08 01:58:04 +010013647
13648 if (!iterator->dirp) {
13649 path_error(&iterator->path);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013650#ifdef HAVE_FDOPENDIR
13651 if (fd != -1) {
13652 Py_BEGIN_ALLOW_THREADS
13653 close(fd);
13654 Py_END_ALLOW_THREADS
13655 }
13656#endif
Victor Stinner6036e442015-03-08 01:58:04 +010013657 goto error;
13658 }
13659#endif
13660
13661 return (PyObject *)iterator;
13662
13663error:
13664 Py_DECREF(iterator);
13665 return NULL;
13666}
13667
Ethan Furman410ef8e2016-06-04 12:06:26 -070013668/*
13669 Return the file system path representation of the object.
13670
13671 If the object is str or bytes, then allow it to pass through with
13672 an incremented refcount. If the object defines __fspath__(), then
13673 return the result of that method. All other types raise a TypeError.
13674*/
13675PyObject *
13676PyOS_FSPath(PyObject *path)
13677{
Brett Cannon3f9183b2016-08-26 14:44:48 -070013678 /* For error message reasons, this function is manually inlined in
13679 path_converter(). */
Ethan Furman410ef8e2016-06-04 12:06:26 -070013680 PyObject *func = NULL;
13681 PyObject *path_repr = NULL;
13682
13683 if (PyUnicode_Check(path) || PyBytes_Check(path)) {
13684 Py_INCREF(path);
13685 return path;
13686 }
13687
13688 func = _PyObject_LookupSpecial(path, &PyId___fspath__);
13689 if (NULL == func) {
13690 return PyErr_Format(PyExc_TypeError,
13691 "expected str, bytes or os.PathLike object, "
Brett Cannonc78ca1e2016-06-24 12:03:43 -070013692 "not %.200s",
Eddie Elizondob3966632019-11-05 07:16:14 -080013693 _PyType_Name(Py_TYPE(path)));
Ethan Furman410ef8e2016-06-04 12:06:26 -070013694 }
13695
Victor Stinnerf17c3de2016-12-06 18:46:19 +010013696 path_repr = _PyObject_CallNoArg(func);
Ethan Furman410ef8e2016-06-04 12:06:26 -070013697 Py_DECREF(func);
Brett Cannon044283a2016-07-15 10:41:49 -070013698 if (NULL == path_repr) {
13699 return NULL;
13700 }
13701
Brett Cannonc78ca1e2016-06-24 12:03:43 -070013702 if (!(PyUnicode_Check(path_repr) || PyBytes_Check(path_repr))) {
13703 PyErr_Format(PyExc_TypeError,
13704 "expected %.200s.__fspath__() to return str or bytes, "
Eddie Elizondob3966632019-11-05 07:16:14 -080013705 "not %.200s", _PyType_Name(Py_TYPE(path)),
13706 _PyType_Name(Py_TYPE(path_repr)));
Brett Cannonc78ca1e2016-06-24 12:03:43 -070013707 Py_DECREF(path_repr);
13708 return NULL;
13709 }
13710
Ethan Furman410ef8e2016-06-04 12:06:26 -070013711 return path_repr;
13712}
13713
13714/*[clinic input]
13715os.fspath
13716
13717 path: object
13718
13719Return the file system path representation of the object.
13720
Brett Cannonb4f43e92016-06-09 14:32:08 -070013721If the object is str or bytes, then allow it to pass through as-is. If the
13722object defines __fspath__(), then return the result of that method. All other
13723types raise a TypeError.
Ethan Furman410ef8e2016-06-04 12:06:26 -070013724[clinic start generated code]*/
13725
13726static PyObject *
Serhiy Storchaka2954f832016-07-07 18:20:03 +030013727os_fspath_impl(PyObject *module, PyObject *path)
13728/*[clinic end generated code: output=c3c3b78ecff2914f input=e357165f7b22490f]*/
Ethan Furman410ef8e2016-06-04 12:06:26 -070013729{
13730 return PyOS_FSPath(path);
13731}
Victor Stinner6036e442015-03-08 01:58:04 +010013732
Victor Stinner9b1f4742016-09-06 16:18:52 -070013733#ifdef HAVE_GETRANDOM_SYSCALL
13734/*[clinic input]
13735os.getrandom
13736
13737 size: Py_ssize_t
13738 flags: int=0
13739
13740Obtain a series of random bytes.
13741[clinic start generated code]*/
13742
13743static PyObject *
13744os_getrandom_impl(PyObject *module, Py_ssize_t size, int flags)
13745/*[clinic end generated code: output=b3a618196a61409c input=59bafac39c594947]*/
13746{
Victor Stinner9b1f4742016-09-06 16:18:52 -070013747 PyObject *bytes;
Victor Stinnerec2319c2016-09-20 23:00:59 +020013748 Py_ssize_t n;
Victor Stinner9b1f4742016-09-06 16:18:52 -070013749
13750 if (size < 0) {
13751 errno = EINVAL;
13752 return posix_error();
13753 }
13754
Victor Stinnerec2319c2016-09-20 23:00:59 +020013755 bytes = PyBytes_FromStringAndSize(NULL, size);
13756 if (bytes == NULL) {
Victor Stinner9b1f4742016-09-06 16:18:52 -070013757 PyErr_NoMemory();
13758 return NULL;
13759 }
13760
13761 while (1) {
Victor Stinnerec2319c2016-09-20 23:00:59 +020013762 n = syscall(SYS_getrandom,
13763 PyBytes_AS_STRING(bytes),
13764 PyBytes_GET_SIZE(bytes),
13765 flags);
Victor Stinner9b1f4742016-09-06 16:18:52 -070013766 if (n < 0 && errno == EINTR) {
13767 if (PyErr_CheckSignals() < 0) {
Victor Stinnerec2319c2016-09-20 23:00:59 +020013768 goto error;
Victor Stinner9b1f4742016-09-06 16:18:52 -070013769 }
Victor Stinnerec2319c2016-09-20 23:00:59 +020013770
13771 /* getrandom() was interrupted by a signal: retry */
Victor Stinner9b1f4742016-09-06 16:18:52 -070013772 continue;
13773 }
13774 break;
13775 }
13776
13777 if (n < 0) {
Victor Stinner9b1f4742016-09-06 16:18:52 -070013778 PyErr_SetFromErrno(PyExc_OSError);
Victor Stinnerec2319c2016-09-20 23:00:59 +020013779 goto error;
Victor Stinner9b1f4742016-09-06 16:18:52 -070013780 }
13781
Victor Stinnerec2319c2016-09-20 23:00:59 +020013782 if (n != size) {
13783 _PyBytes_Resize(&bytes, n);
13784 }
Victor Stinner9b1f4742016-09-06 16:18:52 -070013785
13786 return bytes;
Victor Stinnerec2319c2016-09-20 23:00:59 +020013787
13788error:
13789 Py_DECREF(bytes);
13790 return NULL;
Victor Stinner9b1f4742016-09-06 16:18:52 -070013791}
13792#endif /* HAVE_GETRANDOM_SYSCALL */
13793
Steve Dower2438cdf2019-03-29 16:37:16 -070013794#ifdef MS_WINDOWS
13795/* bpo-36085: Helper functions for managing DLL search directories
13796 * on win32
13797 */
13798
13799typedef DLL_DIRECTORY_COOKIE (WINAPI *PAddDllDirectory)(PCWSTR newDirectory);
13800typedef BOOL (WINAPI *PRemoveDllDirectory)(DLL_DIRECTORY_COOKIE cookie);
13801
13802/*[clinic input]
13803os._add_dll_directory
13804
13805 path: path_t
13806
13807Add a path to the DLL search path.
13808
13809This search path is used when resolving dependencies for imported
13810extension modules (the module itself is resolved through sys.path),
13811and also by ctypes.
13812
13813Returns an opaque value that may be passed to os.remove_dll_directory
13814to remove this directory from the search path.
13815[clinic start generated code]*/
13816
13817static PyObject *
13818os__add_dll_directory_impl(PyObject *module, path_t *path)
13819/*[clinic end generated code: output=80b025daebb5d683 input=1de3e6c13a5808c8]*/
13820{
13821 HMODULE hKernel32;
13822 PAddDllDirectory AddDllDirectory;
13823 DLL_DIRECTORY_COOKIE cookie = 0;
13824 DWORD err = 0;
13825
Saiyang Gou7514f4f2020-02-12 23:47:42 -080013826 if (PySys_Audit("os.add_dll_directory", "(O)", path->object) < 0) {
13827 return NULL;
13828 }
13829
Steve Dower2438cdf2019-03-29 16:37:16 -070013830 /* For Windows 7, we have to load this. As this will be a fairly
13831 infrequent operation, just do it each time. Kernel32 is always
13832 loaded. */
13833 Py_BEGIN_ALLOW_THREADS
13834 if (!(hKernel32 = GetModuleHandleW(L"kernel32")) ||
13835 !(AddDllDirectory = (PAddDllDirectory)GetProcAddress(
13836 hKernel32, "AddDllDirectory")) ||
13837 !(cookie = (*AddDllDirectory)(path->wide))) {
13838 err = GetLastError();
13839 }
13840 Py_END_ALLOW_THREADS
13841
13842 if (err) {
13843 return win32_error_object_err("add_dll_directory",
13844 path->object, err);
13845 }
13846
13847 return PyCapsule_New(cookie, "DLL directory cookie", NULL);
13848}
13849
13850/*[clinic input]
13851os._remove_dll_directory
13852
13853 cookie: object
13854
13855Removes a path from the DLL search path.
13856
13857The parameter is an opaque value that was returned from
13858os.add_dll_directory. You can only remove directories that you added
13859yourself.
13860[clinic start generated code]*/
13861
13862static PyObject *
13863os__remove_dll_directory_impl(PyObject *module, PyObject *cookie)
13864/*[clinic end generated code: output=594350433ae535bc input=c1d16a7e7d9dc5dc]*/
13865{
13866 HMODULE hKernel32;
13867 PRemoveDllDirectory RemoveDllDirectory;
13868 DLL_DIRECTORY_COOKIE cookieValue;
13869 DWORD err = 0;
13870
13871 if (!PyCapsule_IsValid(cookie, "DLL directory cookie")) {
13872 PyErr_SetString(PyExc_TypeError,
13873 "Provided cookie was not returned from os.add_dll_directory");
13874 return NULL;
13875 }
13876
13877 cookieValue = (DLL_DIRECTORY_COOKIE)PyCapsule_GetPointer(
13878 cookie, "DLL directory cookie");
13879
13880 /* For Windows 7, we have to load this. As this will be a fairly
13881 infrequent operation, just do it each time. Kernel32 is always
13882 loaded. */
13883 Py_BEGIN_ALLOW_THREADS
13884 if (!(hKernel32 = GetModuleHandleW(L"kernel32")) ||
13885 !(RemoveDllDirectory = (PRemoveDllDirectory)GetProcAddress(
13886 hKernel32, "RemoveDllDirectory")) ||
13887 !(*RemoveDllDirectory)(cookieValue)) {
13888 err = GetLastError();
13889 }
13890 Py_END_ALLOW_THREADS
13891
13892 if (err) {
13893 return win32_error_object_err("remove_dll_directory",
13894 NULL, err);
13895 }
13896
13897 if (PyCapsule_SetName(cookie, NULL)) {
13898 return NULL;
13899 }
13900
13901 Py_RETURN_NONE;
13902}
13903
13904#endif
Larry Hastings31826802013-10-19 00:09:25 -070013905
Victor Stinner65a796e2020-04-01 18:49:29 +020013906
13907/* Only check if WIFEXITED is available: expect that it comes
13908 with WEXITSTATUS, WIFSIGNALED, etc.
13909
13910 os.waitstatus_to_exitcode() is implemented in C and not in Python, so
13911 subprocess can safely call it during late Python finalization without
13912 risking that used os attributes were set to None by _PyImport_Cleanup(). */
13913#if defined(WIFEXITED) || defined(MS_WINDOWS)
13914/*[clinic input]
13915os.waitstatus_to_exitcode
13916
Victor Stinner9bee32b2020-04-22 16:30:35 +020013917 status as status_obj: object
Victor Stinner65a796e2020-04-01 18:49:29 +020013918
13919Convert a wait status to an exit code.
13920
13921On Unix:
13922
13923* If WIFEXITED(status) is true, return WEXITSTATUS(status).
13924* If WIFSIGNALED(status) is true, return -WTERMSIG(status).
13925* Otherwise, raise a ValueError.
13926
13927On Windows, return status shifted right by 8 bits.
13928
13929On Unix, if the process is being traced or if waitpid() was called with
13930WUNTRACED option, the caller must first check if WIFSTOPPED(status) is true.
13931This function must not be called if WIFSTOPPED(status) is true.
13932[clinic start generated code]*/
13933
13934static PyObject *
Victor Stinner9bee32b2020-04-22 16:30:35 +020013935os_waitstatus_to_exitcode_impl(PyObject *module, PyObject *status_obj)
13936/*[clinic end generated code: output=db50b1b0ba3c7153 input=7fe2d7fdaea3db42]*/
Victor Stinner65a796e2020-04-01 18:49:29 +020013937{
13938#ifndef MS_WINDOWS
Victor Stinner9bee32b2020-04-22 16:30:35 +020013939 int status = _PyLong_AsInt(status_obj);
13940 if (status == -1 && PyErr_Occurred()) {
13941 return NULL;
13942 }
13943
Victor Stinner65a796e2020-04-01 18:49:29 +020013944 WAIT_TYPE wait_status;
13945 WAIT_STATUS_INT(wait_status) = status;
13946 int exitcode;
13947 if (WIFEXITED(wait_status)) {
13948 exitcode = WEXITSTATUS(wait_status);
13949 /* Sanity check to provide warranty on the function behavior.
13950 It should not occur in practice */
13951 if (exitcode < 0) {
13952 PyErr_Format(PyExc_ValueError, "invalid WEXITSTATUS: %i", exitcode);
13953 return NULL;
13954 }
13955 }
13956 else if (WIFSIGNALED(wait_status)) {
13957 int signum = WTERMSIG(wait_status);
13958 /* Sanity check to provide warranty on the function behavior.
13959 It should not occurs in practice */
13960 if (signum <= 0) {
13961 PyErr_Format(PyExc_ValueError, "invalid WTERMSIG: %i", signum);
13962 return NULL;
13963 }
13964 exitcode = -signum;
13965 } else if (WIFSTOPPED(wait_status)) {
13966 /* Status only received if the process is being traced
13967 or if waitpid() was called with WUNTRACED option. */
13968 int signum = WSTOPSIG(wait_status);
13969 PyErr_Format(PyExc_ValueError,
13970 "process stopped by delivery of signal %i",
13971 signum);
13972 return NULL;
13973 }
13974 else {
13975 PyErr_Format(PyExc_ValueError, "invalid wait status: %i", status);
13976 return NULL;
13977 }
13978 return PyLong_FromLong(exitcode);
13979#else
13980 /* Windows implementation: see os.waitpid() implementation
13981 which uses _cwait(). */
Victor Stinner9bee32b2020-04-22 16:30:35 +020013982 unsigned long long status = PyLong_AsUnsignedLongLong(status_obj);
13983 if (status == (unsigned long long)-1 && PyErr_Occurred()) {
13984 return NULL;
13985 }
13986
13987 unsigned long long exitcode = (status >> 8);
13988 /* ExitProcess() accepts an UINT type:
13989 reject exit code which doesn't fit in an UINT */
13990 if (exitcode > UINT_MAX) {
13991 PyErr_Format(PyExc_ValueError, "invalid exit code: %llu", exitcode);
13992 return NULL;
13993 }
13994 return PyLong_FromUnsignedLong((unsigned long)exitcode);
Victor Stinner65a796e2020-04-01 18:49:29 +020013995#endif
13996}
13997#endif
13998
13999
Fred Drake5ab8eaf1999-12-09 21:13:07 +000014000static PyMethodDef posix_methods[] = {
Larry Hastings31826802013-10-19 00:09:25 -070014001
14002 OS_STAT_METHODDEF
14003 OS_ACCESS_METHODDEF
14004 OS_TTYNAME_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100014005 OS_CHDIR_METHODDEF
14006 OS_CHFLAGS_METHODDEF
14007 OS_CHMOD_METHODDEF
14008 OS_FCHMOD_METHODDEF
14009 OS_LCHMOD_METHODDEF
14010 OS_CHOWN_METHODDEF
14011 OS_FCHOWN_METHODDEF
14012 OS_LCHOWN_METHODDEF
14013 OS_LCHFLAGS_METHODDEF
14014 OS_CHROOT_METHODDEF
14015 OS_CTERMID_METHODDEF
14016 OS_GETCWD_METHODDEF
14017 OS_GETCWDB_METHODDEF
14018 OS_LINK_METHODDEF
14019 OS_LISTDIR_METHODDEF
14020 OS_LSTAT_METHODDEF
14021 OS_MKDIR_METHODDEF
14022 OS_NICE_METHODDEF
14023 OS_GETPRIORITY_METHODDEF
14024 OS_SETPRIORITY_METHODDEF
Pablo Galindo6c6ddf92018-01-29 01:56:10 +000014025 OS_POSIX_SPAWN_METHODDEF
Joannah Nanjekye92b83222019-01-16 16:29:26 +030014026 OS_POSIX_SPAWNP_METHODDEF
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030014027 OS_READLINK_METHODDEF
Pablo Galindoaac4d032019-05-31 19:39:47 +010014028 OS_COPY_FILE_RANGE_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100014029 OS_RENAME_METHODDEF
14030 OS_REPLACE_METHODDEF
14031 OS_RMDIR_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100014032 OS_SYMLINK_METHODDEF
14033 OS_SYSTEM_METHODDEF
14034 OS_UMASK_METHODDEF
14035 OS_UNAME_METHODDEF
14036 OS_UNLINK_METHODDEF
14037 OS_REMOVE_METHODDEF
14038 OS_UTIME_METHODDEF
14039 OS_TIMES_METHODDEF
14040 OS__EXIT_METHODDEF
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +020014041 OS__FCOPYFILE_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100014042 OS_EXECV_METHODDEF
14043 OS_EXECVE_METHODDEF
14044 OS_SPAWNV_METHODDEF
14045 OS_SPAWNVE_METHODDEF
14046 OS_FORK1_METHODDEF
14047 OS_FORK_METHODDEF
Antoine Pitrou346cbd32017-05-27 17:50:54 +020014048 OS_REGISTER_AT_FORK_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100014049 OS_SCHED_GET_PRIORITY_MAX_METHODDEF
14050 OS_SCHED_GET_PRIORITY_MIN_METHODDEF
14051 OS_SCHED_GETPARAM_METHODDEF
14052 OS_SCHED_GETSCHEDULER_METHODDEF
14053 OS_SCHED_RR_GET_INTERVAL_METHODDEF
14054 OS_SCHED_SETPARAM_METHODDEF
14055 OS_SCHED_SETSCHEDULER_METHODDEF
14056 OS_SCHED_YIELD_METHODDEF
14057 OS_SCHED_SETAFFINITY_METHODDEF
14058 OS_SCHED_GETAFFINITY_METHODDEF
14059 OS_OPENPTY_METHODDEF
14060 OS_FORKPTY_METHODDEF
14061 OS_GETEGID_METHODDEF
14062 OS_GETEUID_METHODDEF
14063 OS_GETGID_METHODDEF
Serhiy Storchaka2b560312020-04-18 19:14:10 +030014064 OS_GETGROUPLIST_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100014065 OS_GETGROUPS_METHODDEF
14066 OS_GETPID_METHODDEF
14067 OS_GETPGRP_METHODDEF
14068 OS_GETPPID_METHODDEF
14069 OS_GETUID_METHODDEF
14070 OS_GETLOGIN_METHODDEF
14071 OS_KILL_METHODDEF
14072 OS_KILLPG_METHODDEF
14073 OS_PLOCK_METHODDEF
Steve Dowercc16be82016-09-08 10:35:16 -070014074 OS_STARTFILE_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100014075 OS_SETUID_METHODDEF
14076 OS_SETEUID_METHODDEF
14077 OS_SETREUID_METHODDEF
14078 OS_SETGID_METHODDEF
14079 OS_SETEGID_METHODDEF
14080 OS_SETREGID_METHODDEF
14081 OS_SETGROUPS_METHODDEF
Serhiy Storchaka2b560312020-04-18 19:14:10 +030014082 OS_INITGROUPS_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100014083 OS_GETPGID_METHODDEF
14084 OS_SETPGRP_METHODDEF
14085 OS_WAIT_METHODDEF
14086 OS_WAIT3_METHODDEF
14087 OS_WAIT4_METHODDEF
14088 OS_WAITID_METHODDEF
14089 OS_WAITPID_METHODDEF
Benjamin Peterson6c4c45e2019-11-05 19:21:29 -080014090 OS_PIDFD_OPEN_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100014091 OS_GETSID_METHODDEF
14092 OS_SETSID_METHODDEF
14093 OS_SETPGID_METHODDEF
14094 OS_TCGETPGRP_METHODDEF
14095 OS_TCSETPGRP_METHODDEF
14096 OS_OPEN_METHODDEF
14097 OS_CLOSE_METHODDEF
14098 OS_CLOSERANGE_METHODDEF
14099 OS_DEVICE_ENCODING_METHODDEF
14100 OS_DUP_METHODDEF
14101 OS_DUP2_METHODDEF
14102 OS_LOCKF_METHODDEF
14103 OS_LSEEK_METHODDEF
14104 OS_READ_METHODDEF
14105 OS_READV_METHODDEF
14106 OS_PREAD_METHODDEF
Pablo Galindo4defba32018-01-27 16:16:37 +000014107 OS_PREADV_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100014108 OS_WRITE_METHODDEF
14109 OS_WRITEV_METHODDEF
14110 OS_PWRITE_METHODDEF
Pablo Galindo4defba32018-01-27 16:16:37 +000014111 OS_PWRITEV_METHODDEF
Serhiy Storchaka2b560312020-04-18 19:14:10 +030014112 OS_SENDFILE_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100014113 OS_FSTAT_METHODDEF
14114 OS_ISATTY_METHODDEF
14115 OS_PIPE_METHODDEF
14116 OS_PIPE2_METHODDEF
14117 OS_MKFIFO_METHODDEF
14118 OS_MKNOD_METHODDEF
14119 OS_MAJOR_METHODDEF
14120 OS_MINOR_METHODDEF
14121 OS_MAKEDEV_METHODDEF
14122 OS_FTRUNCATE_METHODDEF
14123 OS_TRUNCATE_METHODDEF
14124 OS_POSIX_FALLOCATE_METHODDEF
14125 OS_POSIX_FADVISE_METHODDEF
14126 OS_PUTENV_METHODDEF
14127 OS_UNSETENV_METHODDEF
14128 OS_STRERROR_METHODDEF
14129 OS_FCHDIR_METHODDEF
14130 OS_FSYNC_METHODDEF
14131 OS_SYNC_METHODDEF
14132 OS_FDATASYNC_METHODDEF
14133 OS_WCOREDUMP_METHODDEF
14134 OS_WIFCONTINUED_METHODDEF
14135 OS_WIFSTOPPED_METHODDEF
14136 OS_WIFSIGNALED_METHODDEF
14137 OS_WIFEXITED_METHODDEF
14138 OS_WEXITSTATUS_METHODDEF
14139 OS_WTERMSIG_METHODDEF
14140 OS_WSTOPSIG_METHODDEF
14141 OS_FSTATVFS_METHODDEF
14142 OS_STATVFS_METHODDEF
14143 OS_CONFSTR_METHODDEF
14144 OS_SYSCONF_METHODDEF
14145 OS_FPATHCONF_METHODDEF
14146 OS_PATHCONF_METHODDEF
14147 OS_ABORT_METHODDEF
Serhiy Storchakaf0b50152015-05-13 00:52:39 +030014148 OS__GETFULLPATHNAME_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100014149 OS__GETDISKUSAGE_METHODDEF
14150 OS__GETFINALPATHNAME_METHODDEF
14151 OS__GETVOLUMEPATHNAME_METHODDEF
14152 OS_GETLOADAVG_METHODDEF
14153 OS_URANDOM_METHODDEF
14154 OS_SETRESUID_METHODDEF
14155 OS_SETRESGID_METHODDEF
14156 OS_GETRESUID_METHODDEF
14157 OS_GETRESGID_METHODDEF
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000014158
Larry Hastings2f936352014-08-05 14:04:04 +100014159 OS_GETXATTR_METHODDEF
14160 OS_SETXATTR_METHODDEF
14161 OS_REMOVEXATTR_METHODDEF
14162 OS_LISTXATTR_METHODDEF
14163
Serhiy Storchaka2b560312020-04-18 19:14:10 +030014164 OS_GET_TERMINAL_SIZE_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100014165 OS_CPU_COUNT_METHODDEF
14166 OS_GET_INHERITABLE_METHODDEF
14167 OS_SET_INHERITABLE_METHODDEF
14168 OS_GET_HANDLE_INHERITABLE_METHODDEF
14169 OS_SET_HANDLE_INHERITABLE_METHODDEF
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030014170 OS_GET_BLOCKING_METHODDEF
14171 OS_SET_BLOCKING_METHODDEF
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020014172 OS_SCANDIR_METHODDEF
Ethan Furman410ef8e2016-06-04 12:06:26 -070014173 OS_FSPATH_METHODDEF
Victor Stinner9b1f4742016-09-06 16:18:52 -070014174 OS_GETRANDOM_METHODDEF
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014175 OS_MEMFD_CREATE_METHODDEF
Steve Dower2438cdf2019-03-29 16:37:16 -070014176 OS__ADD_DLL_DIRECTORY_METHODDEF
14177 OS__REMOVE_DLL_DIRECTORY_METHODDEF
Victor Stinner65a796e2020-04-01 18:49:29 +020014178 OS_WAITSTATUS_TO_EXITCODE_METHODDEF
Victor Stinner8c62be82010-05-06 00:08:46 +000014179 {NULL, NULL} /* Sentinel */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000014180};
14181
Barry Warsaw4a342091996-12-19 23:50:02 +000014182static int
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014183all_ins(PyObject *m)
Barry Warsaw4a342091996-12-19 23:50:02 +000014184{
Guido van Rossum94f6f721999-01-06 18:42:14 +000014185#ifdef F_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014186 if (PyModule_AddIntMacro(m, F_OK)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000014187#endif
Guido van Rossum94f6f721999-01-06 18:42:14 +000014188#ifdef R_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014189 if (PyModule_AddIntMacro(m, R_OK)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000014190#endif
Guido van Rossum94f6f721999-01-06 18:42:14 +000014191#ifdef W_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014192 if (PyModule_AddIntMacro(m, W_OK)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000014193#endif
Guido van Rossum94f6f721999-01-06 18:42:14 +000014194#ifdef X_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014195 if (PyModule_AddIntMacro(m, X_OK)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000014196#endif
Fred Drakec9680921999-12-13 16:37:25 +000014197#ifdef NGROUPS_MAX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014198 if (PyModule_AddIntMacro(m, NGROUPS_MAX)) return -1;
Fred Drakec9680921999-12-13 16:37:25 +000014199#endif
Fred Drake5ab8eaf1999-12-09 21:13:07 +000014200#ifdef TMP_MAX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014201 if (PyModule_AddIntMacro(m, TMP_MAX)) return -1;
Fred Drake5ab8eaf1999-12-09 21:13:07 +000014202#endif
Fred Drake106c1a02002-04-23 15:58:02 +000014203#ifdef WCONTINUED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014204 if (PyModule_AddIntMacro(m, WCONTINUED)) return -1;
Fred Drake106c1a02002-04-23 15:58:02 +000014205#endif
Barry Warsaw4a342091996-12-19 23:50:02 +000014206#ifdef WNOHANG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014207 if (PyModule_AddIntMacro(m, WNOHANG)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000014208#endif
Fred Drake106c1a02002-04-23 15:58:02 +000014209#ifdef WUNTRACED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014210 if (PyModule_AddIntMacro(m, WUNTRACED)) return -1;
Fred Drake106c1a02002-04-23 15:58:02 +000014211#endif
Barry Warsaw4a342091996-12-19 23:50:02 +000014212#ifdef O_RDONLY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014213 if (PyModule_AddIntMacro(m, O_RDONLY)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000014214#endif
14215#ifdef O_WRONLY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014216 if (PyModule_AddIntMacro(m, O_WRONLY)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000014217#endif
14218#ifdef O_RDWR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014219 if (PyModule_AddIntMacro(m, O_RDWR)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000014220#endif
14221#ifdef O_NDELAY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014222 if (PyModule_AddIntMacro(m, O_NDELAY)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000014223#endif
14224#ifdef O_NONBLOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014225 if (PyModule_AddIntMacro(m, O_NONBLOCK)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000014226#endif
14227#ifdef O_APPEND
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014228 if (PyModule_AddIntMacro(m, O_APPEND)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000014229#endif
14230#ifdef O_DSYNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014231 if (PyModule_AddIntMacro(m, O_DSYNC)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000014232#endif
14233#ifdef O_RSYNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014234 if (PyModule_AddIntMacro(m, O_RSYNC)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000014235#endif
14236#ifdef O_SYNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014237 if (PyModule_AddIntMacro(m, O_SYNC)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000014238#endif
14239#ifdef O_NOCTTY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014240 if (PyModule_AddIntMacro(m, O_NOCTTY)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000014241#endif
14242#ifdef O_CREAT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014243 if (PyModule_AddIntMacro(m, O_CREAT)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000014244#endif
14245#ifdef O_EXCL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014246 if (PyModule_AddIntMacro(m, O_EXCL)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000014247#endif
14248#ifdef O_TRUNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014249 if (PyModule_AddIntMacro(m, O_TRUNC)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000014250#endif
Guido van Rossum98d9d091997-08-08 21:48:51 +000014251#ifdef O_BINARY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014252 if (PyModule_AddIntMacro(m, O_BINARY)) return -1;
Guido van Rossum98d9d091997-08-08 21:48:51 +000014253#endif
14254#ifdef O_TEXT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014255 if (PyModule_AddIntMacro(m, O_TEXT)) return -1;
Guido van Rossum98d9d091997-08-08 21:48:51 +000014256#endif
Jesus Cea1d642d22012-04-24 20:59:17 +020014257#ifdef O_XATTR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014258 if (PyModule_AddIntMacro(m, O_XATTR)) return -1;
Jesus Cea1d642d22012-04-24 20:59:17 +020014259#endif
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000014260#ifdef O_LARGEFILE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014261 if (PyModule_AddIntMacro(m, O_LARGEFILE)) return -1;
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000014262#endif
doko@ubuntu.comfcff4372016-06-13 16:33:04 +020014263#ifndef __GNU__
Skip Montanaro5ff14922005-05-16 02:42:22 +000014264#ifdef O_SHLOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014265 if (PyModule_AddIntMacro(m, O_SHLOCK)) return -1;
Skip Montanaro5ff14922005-05-16 02:42:22 +000014266#endif
14267#ifdef O_EXLOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014268 if (PyModule_AddIntMacro(m, O_EXLOCK)) return -1;
Skip Montanaro5ff14922005-05-16 02:42:22 +000014269#endif
doko@ubuntu.comfcff4372016-06-13 16:33:04 +020014270#endif
Jesus Ceacf381202012-04-24 20:44:40 +020014271#ifdef O_EXEC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014272 if (PyModule_AddIntMacro(m, O_EXEC)) return -1;
Jesus Ceacf381202012-04-24 20:44:40 +020014273#endif
14274#ifdef O_SEARCH
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014275 if (PyModule_AddIntMacro(m, O_SEARCH)) return -1;
Jesus Ceacf381202012-04-24 20:44:40 +020014276#endif
Benjamin Peterson3b965a22013-03-13 10:27:41 -050014277#ifdef O_PATH
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014278 if (PyModule_AddIntMacro(m, O_PATH)) return -1;
Benjamin Peterson3b965a22013-03-13 10:27:41 -050014279#endif
Jesus Ceacf381202012-04-24 20:44:40 +020014280#ifdef O_TTY_INIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014281 if (PyModule_AddIntMacro(m, O_TTY_INIT)) return -1;
Jesus Ceacf381202012-04-24 20:44:40 +020014282#endif
Christian Heimes177b3f92013-08-16 14:35:09 +020014283#ifdef O_TMPFILE
14284 if (PyModule_AddIntMacro(m, O_TMPFILE)) return -1;
14285#endif
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000014286#ifdef PRIO_PROCESS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014287 if (PyModule_AddIntMacro(m, PRIO_PROCESS)) return -1;
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000014288#endif
14289#ifdef PRIO_PGRP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014290 if (PyModule_AddIntMacro(m, PRIO_PGRP)) return -1;
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000014291#endif
14292#ifdef PRIO_USER
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014293 if (PyModule_AddIntMacro(m, PRIO_USER)) return -1;
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000014294#endif
Charles-François Natali1e045b12011-05-22 20:42:32 +020014295#ifdef O_CLOEXEC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014296 if (PyModule_AddIntMacro(m, O_CLOEXEC)) return -1;
Charles-François Natali1e045b12011-05-22 20:42:32 +020014297#endif
Jesus Cea1d642d22012-04-24 20:59:17 +020014298#ifdef O_ACCMODE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014299 if (PyModule_AddIntMacro(m, O_ACCMODE)) return -1;
Jesus Cea1d642d22012-04-24 20:59:17 +020014300#endif
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000014301
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000014302
Jesus Cea94363612012-06-22 18:32:07 +020014303#ifdef SEEK_HOLE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014304 if (PyModule_AddIntMacro(m, SEEK_HOLE)) return -1;
Jesus Cea94363612012-06-22 18:32:07 +020014305#endif
14306#ifdef SEEK_DATA
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014307 if (PyModule_AddIntMacro(m, SEEK_DATA)) return -1;
Jesus Cea94363612012-06-22 18:32:07 +020014308#endif
14309
Tim Peters5aa91602002-01-30 05:46:57 +000014310/* MS Windows */
14311#ifdef O_NOINHERIT
Victor Stinner8c62be82010-05-06 00:08:46 +000014312 /* Don't inherit in child processes. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014313 if (PyModule_AddIntMacro(m, O_NOINHERIT)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000014314#endif
14315#ifdef _O_SHORT_LIVED
Victor Stinner8c62be82010-05-06 00:08:46 +000014316 /* Optimize for short life (keep in memory). */
14317 /* MS forgot to define this one with a non-underscore form too. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014318 if (PyModule_AddIntConstant(m, "O_SHORT_LIVED", _O_SHORT_LIVED)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000014319#endif
14320#ifdef O_TEMPORARY
Victor Stinner8c62be82010-05-06 00:08:46 +000014321 /* Automatically delete when last handle is closed. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014322 if (PyModule_AddIntMacro(m, O_TEMPORARY)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000014323#endif
14324#ifdef O_RANDOM
Victor Stinner8c62be82010-05-06 00:08:46 +000014325 /* Optimize for random access. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014326 if (PyModule_AddIntMacro(m, O_RANDOM)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000014327#endif
14328#ifdef O_SEQUENTIAL
Victor Stinner8c62be82010-05-06 00:08:46 +000014329 /* Optimize for sequential access. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014330 if (PyModule_AddIntMacro(m, O_SEQUENTIAL)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000014331#endif
14332
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000014333/* GNU extensions. */
Alexandre Vassalottibee32532008-05-16 18:15:12 +000014334#ifdef O_ASYNC
Victor Stinner8c62be82010-05-06 00:08:46 +000014335 /* Send a SIGIO signal whenever input or output
14336 becomes available on file descriptor */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014337 if (PyModule_AddIntMacro(m, O_ASYNC)) return -1;
Alexandre Vassalottibee32532008-05-16 18:15:12 +000014338#endif
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000014339#ifdef O_DIRECT
Victor Stinner8c62be82010-05-06 00:08:46 +000014340 /* Direct disk access. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014341 if (PyModule_AddIntMacro(m, O_DIRECT)) return -1;
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000014342#endif
14343#ifdef O_DIRECTORY
Victor Stinner8c62be82010-05-06 00:08:46 +000014344 /* Must be a directory. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014345 if (PyModule_AddIntMacro(m, O_DIRECTORY)) return -1;
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000014346#endif
14347#ifdef O_NOFOLLOW
Victor Stinner8c62be82010-05-06 00:08:46 +000014348 /* Do not follow links. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014349 if (PyModule_AddIntMacro(m, O_NOFOLLOW)) return -1;
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000014350#endif
Jesus Cea1d642d22012-04-24 20:59:17 +020014351#ifdef O_NOLINKS
14352 /* Fails if link count of the named file is greater than 1 */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014353 if (PyModule_AddIntMacro(m, O_NOLINKS)) return -1;
Jesus Cea1d642d22012-04-24 20:59:17 +020014354#endif
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +000014355#ifdef O_NOATIME
Victor Stinner8c62be82010-05-06 00:08:46 +000014356 /* Do not update the access time. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014357 if (PyModule_AddIntMacro(m, O_NOATIME)) return -1;
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +000014358#endif
Guido van Rossumd48f2521997-12-05 22:19:34 +000014359
Victor Stinner8c62be82010-05-06 00:08:46 +000014360 /* These come from sysexits.h */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014361#ifdef EX_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014362 if (PyModule_AddIntMacro(m, EX_OK)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014363#endif /* EX_OK */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014364#ifdef EX_USAGE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014365 if (PyModule_AddIntMacro(m, EX_USAGE)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014366#endif /* EX_USAGE */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014367#ifdef EX_DATAERR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014368 if (PyModule_AddIntMacro(m, EX_DATAERR)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014369#endif /* EX_DATAERR */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014370#ifdef EX_NOINPUT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014371 if (PyModule_AddIntMacro(m, EX_NOINPUT)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014372#endif /* EX_NOINPUT */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014373#ifdef EX_NOUSER
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014374 if (PyModule_AddIntMacro(m, EX_NOUSER)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014375#endif /* EX_NOUSER */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014376#ifdef EX_NOHOST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014377 if (PyModule_AddIntMacro(m, EX_NOHOST)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014378#endif /* EX_NOHOST */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014379#ifdef EX_UNAVAILABLE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014380 if (PyModule_AddIntMacro(m, EX_UNAVAILABLE)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014381#endif /* EX_UNAVAILABLE */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014382#ifdef EX_SOFTWARE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014383 if (PyModule_AddIntMacro(m, EX_SOFTWARE)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014384#endif /* EX_SOFTWARE */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014385#ifdef EX_OSERR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014386 if (PyModule_AddIntMacro(m, EX_OSERR)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014387#endif /* EX_OSERR */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014388#ifdef EX_OSFILE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014389 if (PyModule_AddIntMacro(m, EX_OSFILE)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014390#endif /* EX_OSFILE */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014391#ifdef EX_CANTCREAT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014392 if (PyModule_AddIntMacro(m, EX_CANTCREAT)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014393#endif /* EX_CANTCREAT */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014394#ifdef EX_IOERR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014395 if (PyModule_AddIntMacro(m, EX_IOERR)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014396#endif /* EX_IOERR */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014397#ifdef EX_TEMPFAIL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014398 if (PyModule_AddIntMacro(m, EX_TEMPFAIL)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014399#endif /* EX_TEMPFAIL */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014400#ifdef EX_PROTOCOL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014401 if (PyModule_AddIntMacro(m, EX_PROTOCOL)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014402#endif /* EX_PROTOCOL */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014403#ifdef EX_NOPERM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014404 if (PyModule_AddIntMacro(m, EX_NOPERM)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014405#endif /* EX_NOPERM */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014406#ifdef EX_CONFIG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014407 if (PyModule_AddIntMacro(m, EX_CONFIG)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014408#endif /* EX_CONFIG */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014409#ifdef EX_NOTFOUND
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014410 if (PyModule_AddIntMacro(m, EX_NOTFOUND)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014411#endif /* EX_NOTFOUND */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014412
Amaury Forgeot d'Arc66d00ad2010-09-10 18:11:45 +000014413 /* statvfs */
Andrew M. Kuchling4ea04a32010-08-18 22:30:34 +000014414#ifdef ST_RDONLY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014415 if (PyModule_AddIntMacro(m, ST_RDONLY)) return -1;
Andrew M. Kuchling4ea04a32010-08-18 22:30:34 +000014416#endif /* ST_RDONLY */
14417#ifdef ST_NOSUID
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014418 if (PyModule_AddIntMacro(m, ST_NOSUID)) return -1;
Andrew M. Kuchling4ea04a32010-08-18 22:30:34 +000014419#endif /* ST_NOSUID */
14420
doko@ubuntu.comca616a22013-12-08 15:23:07 +010014421 /* GNU extensions */
14422#ifdef ST_NODEV
14423 if (PyModule_AddIntMacro(m, ST_NODEV)) return -1;
14424#endif /* ST_NODEV */
14425#ifdef ST_NOEXEC
14426 if (PyModule_AddIntMacro(m, ST_NOEXEC)) return -1;
14427#endif /* ST_NOEXEC */
14428#ifdef ST_SYNCHRONOUS
14429 if (PyModule_AddIntMacro(m, ST_SYNCHRONOUS)) return -1;
14430#endif /* ST_SYNCHRONOUS */
14431#ifdef ST_MANDLOCK
14432 if (PyModule_AddIntMacro(m, ST_MANDLOCK)) return -1;
14433#endif /* ST_MANDLOCK */
14434#ifdef ST_WRITE
14435 if (PyModule_AddIntMacro(m, ST_WRITE)) return -1;
14436#endif /* ST_WRITE */
14437#ifdef ST_APPEND
14438 if (PyModule_AddIntMacro(m, ST_APPEND)) return -1;
14439#endif /* ST_APPEND */
14440#ifdef ST_NOATIME
14441 if (PyModule_AddIntMacro(m, ST_NOATIME)) return -1;
14442#endif /* ST_NOATIME */
14443#ifdef ST_NODIRATIME
14444 if (PyModule_AddIntMacro(m, ST_NODIRATIME)) return -1;
14445#endif /* ST_NODIRATIME */
14446#ifdef ST_RELATIME
14447 if (PyModule_AddIntMacro(m, ST_RELATIME)) return -1;
14448#endif /* ST_RELATIME */
14449
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000014450 /* FreeBSD sendfile() constants */
14451#ifdef SF_NODISKIO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014452 if (PyModule_AddIntMacro(m, SF_NODISKIO)) return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000014453#endif
14454#ifdef SF_MNOWAIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014455 if (PyModule_AddIntMacro(m, SF_MNOWAIT)) return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000014456#endif
14457#ifdef SF_SYNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014458 if (PyModule_AddIntMacro(m, SF_SYNC)) return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000014459#endif
14460
Ross Lagerwall7807c352011-03-17 20:20:30 +020014461 /* constants for posix_fadvise */
14462#ifdef POSIX_FADV_NORMAL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014463 if (PyModule_AddIntMacro(m, POSIX_FADV_NORMAL)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014464#endif
14465#ifdef POSIX_FADV_SEQUENTIAL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014466 if (PyModule_AddIntMacro(m, POSIX_FADV_SEQUENTIAL)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014467#endif
14468#ifdef POSIX_FADV_RANDOM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014469 if (PyModule_AddIntMacro(m, POSIX_FADV_RANDOM)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014470#endif
14471#ifdef POSIX_FADV_NOREUSE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014472 if (PyModule_AddIntMacro(m, POSIX_FADV_NOREUSE)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014473#endif
14474#ifdef POSIX_FADV_WILLNEED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014475 if (PyModule_AddIntMacro(m, POSIX_FADV_WILLNEED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014476#endif
14477#ifdef POSIX_FADV_DONTNEED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014478 if (PyModule_AddIntMacro(m, POSIX_FADV_DONTNEED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014479#endif
14480
14481 /* constants for waitid */
14482#if defined(HAVE_SYS_WAIT_H) && defined(HAVE_WAITID)
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014483 if (PyModule_AddIntMacro(m, P_PID)) return -1;
14484 if (PyModule_AddIntMacro(m, P_PGID)) return -1;
14485 if (PyModule_AddIntMacro(m, P_ALL)) return -1;
Benjamin Peterson5c0c3252019-11-05 21:58:31 -080014486#ifdef P_PIDFD
14487 if (PyModule_AddIntMacro(m, P_PIDFD)) return -1;
14488#endif
Ross Lagerwall7807c352011-03-17 20:20:30 +020014489#endif
14490#ifdef WEXITED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014491 if (PyModule_AddIntMacro(m, WEXITED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014492#endif
14493#ifdef WNOWAIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014494 if (PyModule_AddIntMacro(m, WNOWAIT)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014495#endif
14496#ifdef WSTOPPED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014497 if (PyModule_AddIntMacro(m, WSTOPPED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014498#endif
14499#ifdef CLD_EXITED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014500 if (PyModule_AddIntMacro(m, CLD_EXITED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014501#endif
Dong-hee Na2eba6ad2019-10-21 16:01:05 +090014502#ifdef CLD_KILLED
14503 if (PyModule_AddIntMacro(m, CLD_KILLED)) return -1;
14504#endif
Ross Lagerwall7807c352011-03-17 20:20:30 +020014505#ifdef CLD_DUMPED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014506 if (PyModule_AddIntMacro(m, CLD_DUMPED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014507#endif
14508#ifdef CLD_TRAPPED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014509 if (PyModule_AddIntMacro(m, CLD_TRAPPED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014510#endif
Dong-hee Na2eba6ad2019-10-21 16:01:05 +090014511#ifdef CLD_STOPPED
14512 if (PyModule_AddIntMacro(m, CLD_STOPPED)) return -1;
14513#endif
Ross Lagerwall7807c352011-03-17 20:20:30 +020014514#ifdef CLD_CONTINUED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014515 if (PyModule_AddIntMacro(m, CLD_CONTINUED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014516#endif
14517
14518 /* constants for lockf */
14519#ifdef F_LOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014520 if (PyModule_AddIntMacro(m, F_LOCK)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014521#endif
14522#ifdef F_TLOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014523 if (PyModule_AddIntMacro(m, F_TLOCK)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014524#endif
14525#ifdef F_ULOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014526 if (PyModule_AddIntMacro(m, F_ULOCK)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014527#endif
14528#ifdef F_TEST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014529 if (PyModule_AddIntMacro(m, F_TEST)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014530#endif
14531
Pablo Galindo4defba32018-01-27 16:16:37 +000014532#ifdef RWF_DSYNC
14533 if (PyModule_AddIntConstant(m, "RWF_DSYNC", RWF_DSYNC)) return -1;
14534#endif
14535#ifdef RWF_HIPRI
14536 if (PyModule_AddIntConstant(m, "RWF_HIPRI", RWF_HIPRI)) return -1;
14537#endif
14538#ifdef RWF_SYNC
14539 if (PyModule_AddIntConstant(m, "RWF_SYNC", RWF_SYNC)) return -1;
14540#endif
14541#ifdef RWF_NOWAIT
14542 if (PyModule_AddIntConstant(m, "RWF_NOWAIT", RWF_NOWAIT)) return -1;
14543#endif
YoSTEALTH76ef2552020-05-27 15:32:22 -060014544#ifdef RWF_APPEND
14545 if (PyModule_AddIntConstant(m, "RWF_APPEND", RWF_APPEND)) return -1;
14546#endif
Pablo Galindo4defba32018-01-27 16:16:37 +000014547
Pablo Galindo6c6ddf92018-01-29 01:56:10 +000014548/* constants for posix_spawn */
14549#ifdef HAVE_POSIX_SPAWN
14550 if (PyModule_AddIntConstant(m, "POSIX_SPAWN_OPEN", POSIX_SPAWN_OPEN)) return -1;
14551 if (PyModule_AddIntConstant(m, "POSIX_SPAWN_CLOSE", POSIX_SPAWN_CLOSE)) return -1;
14552 if (PyModule_AddIntConstant(m, "POSIX_SPAWN_DUP2", POSIX_SPAWN_DUP2)) return -1;
14553#endif
14554
pxinwrf2d7ac72019-05-21 18:46:37 +080014555#if defined(HAVE_SPAWNV) || defined (HAVE_RTPSPAWN)
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014556 if (PyModule_AddIntConstant(m, "P_WAIT", _P_WAIT)) return -1;
14557 if (PyModule_AddIntConstant(m, "P_NOWAIT", _P_NOWAIT)) return -1;
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014558 if (PyModule_AddIntConstant(m, "P_NOWAITO", _P_NOWAITO)) return -1;
pxinwrf2d7ac72019-05-21 18:46:37 +080014559#endif
14560#ifdef HAVE_SPAWNV
14561 if (PyModule_AddIntConstant(m, "P_OVERLAY", _OLD_P_OVERLAY)) return -1;
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014562 if (PyModule_AddIntConstant(m, "P_DETACH", _P_DETACH)) return -1;
Guido van Rossum246bc171999-02-01 23:54:31 +000014563#endif
14564
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014565#ifdef HAVE_SCHED_H
Benjamin Petersondbaa5592016-07-30 23:21:50 -070014566#ifdef SCHED_OTHER
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014567 if (PyModule_AddIntMacro(m, SCHED_OTHER)) return -1;
Benjamin Petersondbaa5592016-07-30 23:21:50 -070014568#endif
14569#ifdef SCHED_FIFO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014570 if (PyModule_AddIntMacro(m, SCHED_FIFO)) return -1;
Benjamin Petersondbaa5592016-07-30 23:21:50 -070014571#endif
14572#ifdef SCHED_RR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014573 if (PyModule_AddIntMacro(m, SCHED_RR)) return -1;
Benjamin Petersondbaa5592016-07-30 23:21:50 -070014574#endif
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014575#ifdef SCHED_SPORADIC
messi Liao0d322182017-06-13 22:30:43 +080014576 if (PyModule_AddIntMacro(m, SCHED_SPORADIC)) return -1;
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014577#endif
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014578#ifdef SCHED_BATCH
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014579 if (PyModule_AddIntMacro(m, SCHED_BATCH)) return -1;
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014580#endif
14581#ifdef SCHED_IDLE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014582 if (PyModule_AddIntMacro(m, SCHED_IDLE)) return -1;
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014583#endif
14584#ifdef SCHED_RESET_ON_FORK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014585 if (PyModule_AddIntMacro(m, SCHED_RESET_ON_FORK)) return -1;
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014586#endif
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020014587#ifdef SCHED_SYS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014588 if (PyModule_AddIntMacro(m, SCHED_SYS)) return -1;
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020014589#endif
14590#ifdef SCHED_IA
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014591 if (PyModule_AddIntMacro(m, SCHED_IA)) return -1;
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020014592#endif
14593#ifdef SCHED_FSS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014594 if (PyModule_AddIntMacro(m, SCHED_FSS)) return -1;
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020014595#endif
14596#ifdef SCHED_FX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014597 if (PyModule_AddIntConstant(m, "SCHED_FX", SCHED_FSS)) return -1;
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020014598#endif
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014599#endif
14600
Benjamin Peterson9428d532011-09-14 11:45:52 -040014601#ifdef USE_XATTRS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014602 if (PyModule_AddIntMacro(m, XATTR_CREATE)) return -1;
14603 if (PyModule_AddIntMacro(m, XATTR_REPLACE)) return -1;
14604 if (PyModule_AddIntMacro(m, XATTR_SIZE_MAX)) return -1;
Benjamin Peterson799bd802011-08-31 22:15:17 -040014605#endif
14606
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014607#if HAVE_DECL_RTLD_LAZY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014608 if (PyModule_AddIntMacro(m, RTLD_LAZY)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014609#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014610#if HAVE_DECL_RTLD_NOW
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014611 if (PyModule_AddIntMacro(m, RTLD_NOW)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014612#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014613#if HAVE_DECL_RTLD_GLOBAL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014614 if (PyModule_AddIntMacro(m, RTLD_GLOBAL)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014615#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014616#if HAVE_DECL_RTLD_LOCAL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014617 if (PyModule_AddIntMacro(m, RTLD_LOCAL)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014618#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014619#if HAVE_DECL_RTLD_NODELETE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014620 if (PyModule_AddIntMacro(m, RTLD_NODELETE)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014621#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014622#if HAVE_DECL_RTLD_NOLOAD
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014623 if (PyModule_AddIntMacro(m, RTLD_NOLOAD)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014624#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014625#if HAVE_DECL_RTLD_DEEPBIND
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014626 if (PyModule_AddIntMacro(m, RTLD_DEEPBIND)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014627#endif
Michael Feltc5ae1692017-12-19 13:58:49 +010014628#if HAVE_DECL_RTLD_MEMBER
14629 if (PyModule_AddIntMacro(m, RTLD_MEMBER)) return -1;
14630#endif
Victor Stinner8b905bd2011-10-25 13:34:04 +020014631
Victor Stinner9b1f4742016-09-06 16:18:52 -070014632#ifdef HAVE_GETRANDOM_SYSCALL
14633 if (PyModule_AddIntMacro(m, GRND_RANDOM)) return -1;
14634 if (PyModule_AddIntMacro(m, GRND_NONBLOCK)) return -1;
14635#endif
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014636#ifdef HAVE_MEMFD_CREATE
14637 if (PyModule_AddIntMacro(m, MFD_CLOEXEC)) return -1;
14638 if (PyModule_AddIntMacro(m, MFD_ALLOW_SEALING)) return -1;
14639#ifdef MFD_HUGETLB
14640 if (PyModule_AddIntMacro(m, MFD_HUGETLB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014641#endif
14642#ifdef MFD_HUGE_SHIFT
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014643 if (PyModule_AddIntMacro(m, MFD_HUGE_SHIFT)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014644#endif
14645#ifdef MFD_HUGE_MASK
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014646 if (PyModule_AddIntMacro(m, MFD_HUGE_MASK)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014647#endif
14648#ifdef MFD_HUGE_64KB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014649 if (PyModule_AddIntMacro(m, MFD_HUGE_64KB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014650#endif
14651#ifdef MFD_HUGE_512KB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014652 if (PyModule_AddIntMacro(m, MFD_HUGE_512KB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014653#endif
14654#ifdef MFD_HUGE_1MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014655 if (PyModule_AddIntMacro(m, MFD_HUGE_1MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014656#endif
14657#ifdef MFD_HUGE_2MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014658 if (PyModule_AddIntMacro(m, MFD_HUGE_2MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014659#endif
14660#ifdef MFD_HUGE_8MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014661 if (PyModule_AddIntMacro(m, MFD_HUGE_8MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014662#endif
14663#ifdef MFD_HUGE_16MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014664 if (PyModule_AddIntMacro(m, MFD_HUGE_16MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014665#endif
14666#ifdef MFD_HUGE_32MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014667 if (PyModule_AddIntMacro(m, MFD_HUGE_32MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014668#endif
14669#ifdef MFD_HUGE_256MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014670 if (PyModule_AddIntMacro(m, MFD_HUGE_256MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014671#endif
14672#ifdef MFD_HUGE_512MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014673 if (PyModule_AddIntMacro(m, MFD_HUGE_512MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014674#endif
14675#ifdef MFD_HUGE_1GB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014676 if (PyModule_AddIntMacro(m, MFD_HUGE_1GB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014677#endif
14678#ifdef MFD_HUGE_2GB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014679 if (PyModule_AddIntMacro(m, MFD_HUGE_2GB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014680#endif
14681#ifdef MFD_HUGE_16GB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014682 if (PyModule_AddIntMacro(m, MFD_HUGE_16GB)) return -1;
14683#endif
14684#endif
Victor Stinner9b1f4742016-09-06 16:18:52 -070014685
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +020014686#if defined(__APPLE__)
14687 if (PyModule_AddIntConstant(m, "_COPYFILE_DATA", COPYFILE_DATA)) return -1;
14688#endif
14689
Steve Dower2438cdf2019-03-29 16:37:16 -070014690#ifdef MS_WINDOWS
14691 if (PyModule_AddIntConstant(m, "_LOAD_LIBRARY_SEARCH_DEFAULT_DIRS", LOAD_LIBRARY_SEARCH_DEFAULT_DIRS)) return -1;
14692 if (PyModule_AddIntConstant(m, "_LOAD_LIBRARY_SEARCH_APPLICATION_DIR", LOAD_LIBRARY_SEARCH_APPLICATION_DIR)) return -1;
14693 if (PyModule_AddIntConstant(m, "_LOAD_LIBRARY_SEARCH_SYSTEM32", LOAD_LIBRARY_SEARCH_SYSTEM32)) return -1;
14694 if (PyModule_AddIntConstant(m, "_LOAD_LIBRARY_SEARCH_USER_DIRS", LOAD_LIBRARY_SEARCH_USER_DIRS)) return -1;
14695 if (PyModule_AddIntConstant(m, "_LOAD_LIBRARY_SEARCH_DLL_LOAD_DIR", LOAD_LIBRARY_SEARCH_DLL_LOAD_DIR)) return -1;
14696#endif
14697
Victor Stinner8c62be82010-05-06 00:08:46 +000014698 return 0;
Barry Warsaw4a342091996-12-19 23:50:02 +000014699}
14700
14701
Serhiy Storchaka2d06e842015-12-25 19:53:18 +020014702static const char * const have_functions[] = {
Larry Hastings9cf065c2012-06-22 16:30:09 -070014703
14704#ifdef HAVE_FACCESSAT
14705 "HAVE_FACCESSAT",
14706#endif
14707
14708#ifdef HAVE_FCHDIR
14709 "HAVE_FCHDIR",
14710#endif
14711
14712#ifdef HAVE_FCHMOD
14713 "HAVE_FCHMOD",
14714#endif
14715
14716#ifdef HAVE_FCHMODAT
14717 "HAVE_FCHMODAT",
14718#endif
14719
14720#ifdef HAVE_FCHOWN
14721 "HAVE_FCHOWN",
14722#endif
14723
Larry Hastings00964ed2013-08-12 13:49:30 -040014724#ifdef HAVE_FCHOWNAT
14725 "HAVE_FCHOWNAT",
14726#endif
14727
Larry Hastings9cf065c2012-06-22 16:30:09 -070014728#ifdef HAVE_FEXECVE
14729 "HAVE_FEXECVE",
14730#endif
14731
14732#ifdef HAVE_FDOPENDIR
14733 "HAVE_FDOPENDIR",
14734#endif
14735
Georg Brandl306336b2012-06-24 12:55:33 +020014736#ifdef HAVE_FPATHCONF
14737 "HAVE_FPATHCONF",
14738#endif
14739
Larry Hastings9cf065c2012-06-22 16:30:09 -070014740#ifdef HAVE_FSTATAT
14741 "HAVE_FSTATAT",
14742#endif
14743
14744#ifdef HAVE_FSTATVFS
14745 "HAVE_FSTATVFS",
14746#endif
14747
Steve Dowerfe0a41a2015-03-20 19:50:46 -070014748#if defined HAVE_FTRUNCATE || defined MS_WINDOWS
Georg Brandl306336b2012-06-24 12:55:33 +020014749 "HAVE_FTRUNCATE",
14750#endif
14751
Larry Hastings9cf065c2012-06-22 16:30:09 -070014752#ifdef HAVE_FUTIMENS
14753 "HAVE_FUTIMENS",
14754#endif
14755
14756#ifdef HAVE_FUTIMES
14757 "HAVE_FUTIMES",
14758#endif
14759
14760#ifdef HAVE_FUTIMESAT
14761 "HAVE_FUTIMESAT",
14762#endif
14763
14764#ifdef HAVE_LINKAT
14765 "HAVE_LINKAT",
14766#endif
14767
14768#ifdef HAVE_LCHFLAGS
14769 "HAVE_LCHFLAGS",
14770#endif
14771
14772#ifdef HAVE_LCHMOD
14773 "HAVE_LCHMOD",
14774#endif
14775
14776#ifdef HAVE_LCHOWN
14777 "HAVE_LCHOWN",
14778#endif
14779
14780#ifdef HAVE_LSTAT
14781 "HAVE_LSTAT",
14782#endif
14783
14784#ifdef HAVE_LUTIMES
14785 "HAVE_LUTIMES",
14786#endif
14787
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014788#ifdef HAVE_MEMFD_CREATE
14789 "HAVE_MEMFD_CREATE",
14790#endif
14791
Larry Hastings9cf065c2012-06-22 16:30:09 -070014792#ifdef HAVE_MKDIRAT
14793 "HAVE_MKDIRAT",
14794#endif
14795
14796#ifdef HAVE_MKFIFOAT
14797 "HAVE_MKFIFOAT",
14798#endif
14799
14800#ifdef HAVE_MKNODAT
14801 "HAVE_MKNODAT",
14802#endif
14803
14804#ifdef HAVE_OPENAT
14805 "HAVE_OPENAT",
14806#endif
14807
14808#ifdef HAVE_READLINKAT
14809 "HAVE_READLINKAT",
14810#endif
14811
14812#ifdef HAVE_RENAMEAT
14813 "HAVE_RENAMEAT",
14814#endif
14815
14816#ifdef HAVE_SYMLINKAT
14817 "HAVE_SYMLINKAT",
14818#endif
14819
14820#ifdef HAVE_UNLINKAT
14821 "HAVE_UNLINKAT",
14822#endif
14823
14824#ifdef HAVE_UTIMENSAT
14825 "HAVE_UTIMENSAT",
14826#endif
14827
14828#ifdef MS_WINDOWS
14829 "MS_WINDOWS",
14830#endif
14831
14832 NULL
14833};
14834
14835
Victor Stinner1c2fa782020-05-10 11:05:29 +020014836static int
14837posixmodule_exec(PyObject *m)
Guido van Rossumb6775db1994-08-01 11:34:53 +000014838{
Victor Stinner97f33c32020-05-14 18:05:58 +020014839 _posixstate *state = get_posix_state(m);
Tim Peters5aa91602002-01-30 05:46:57 +000014840
Victor Stinner8c62be82010-05-06 00:08:46 +000014841 /* Initialize environ dictionary */
Victor Stinner97f33c32020-05-14 18:05:58 +020014842 PyObject *v = convertenviron();
Victor Stinner8c62be82010-05-06 00:08:46 +000014843 Py_XINCREF(v);
14844 if (v == NULL || PyModule_AddObject(m, "environ", v) != 0)
Victor Stinner1c2fa782020-05-10 11:05:29 +020014845 return -1;
Victor Stinner8c62be82010-05-06 00:08:46 +000014846 Py_DECREF(v);
Fred Drakec9680921999-12-13 16:37:25 +000014847
Victor Stinner8c62be82010-05-06 00:08:46 +000014848 if (all_ins(m))
Victor Stinner1c2fa782020-05-10 11:05:29 +020014849 return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000014850
Victor Stinner8c62be82010-05-06 00:08:46 +000014851 if (setup_confname_tables(m))
Victor Stinner1c2fa782020-05-10 11:05:29 +020014852 return -1;
Fred Drakebec628d1999-12-15 18:31:10 +000014853
Victor Stinner8c62be82010-05-06 00:08:46 +000014854 Py_INCREF(PyExc_OSError);
14855 PyModule_AddObject(m, "error", PyExc_OSError);
Fred Drake762e2061999-08-26 17:23:54 +000014856
Ross Lagerwall7807c352011-03-17 20:20:30 +020014857#if defined(HAVE_WAITID) && !defined(__APPLE__)
Eddie Elizondob3966632019-11-05 07:16:14 -080014858 waitid_result_desc.name = MODNAME ".waitid_result";
14859 PyObject *WaitidResultType = (PyObject *)PyStructSequence_NewType(&waitid_result_desc);
14860 if (WaitidResultType == NULL) {
Victor Stinner1c2fa782020-05-10 11:05:29 +020014861 return -1;
Eddie Elizondob3966632019-11-05 07:16:14 -080014862 }
14863 Py_INCREF(WaitidResultType);
14864 PyModule_AddObject(m, "waitid_result", WaitidResultType);
Victor Stinner97f33c32020-05-14 18:05:58 +020014865 state->WaitidResultType = WaitidResultType;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014866#endif
14867
Eddie Elizondob3966632019-11-05 07:16:14 -080014868 stat_result_desc.name = "os.stat_result"; /* see issue #19209 */
14869 stat_result_desc.fields[7].name = PyStructSequence_UnnamedField;
14870 stat_result_desc.fields[8].name = PyStructSequence_UnnamedField;
14871 stat_result_desc.fields[9].name = PyStructSequence_UnnamedField;
14872 PyObject *StatResultType = (PyObject *)PyStructSequence_NewType(&stat_result_desc);
14873 if (StatResultType == NULL) {
Victor Stinner1c2fa782020-05-10 11:05:29 +020014874 return -1;
Eddie Elizondob3966632019-11-05 07:16:14 -080014875 }
14876 Py_INCREF(StatResultType);
14877 PyModule_AddObject(m, "stat_result", StatResultType);
Victor Stinner97f33c32020-05-14 18:05:58 +020014878 state->StatResultType = StatResultType;
Eddie Elizondob3966632019-11-05 07:16:14 -080014879 structseq_new = ((PyTypeObject *)StatResultType)->tp_new;
14880 ((PyTypeObject *)StatResultType)->tp_new = statresult_new;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000014881
Eddie Elizondob3966632019-11-05 07:16:14 -080014882 statvfs_result_desc.name = "os.statvfs_result"; /* see issue #19209 */
14883 PyObject *StatVFSResultType = (PyObject *)PyStructSequence_NewType(&statvfs_result_desc);
14884 if (StatVFSResultType == NULL) {
Victor Stinner1c2fa782020-05-10 11:05:29 +020014885 return -1;
Eddie Elizondob3966632019-11-05 07:16:14 -080014886 }
14887 Py_INCREF(StatVFSResultType);
14888 PyModule_AddObject(m, "statvfs_result", StatVFSResultType);
Victor Stinner97f33c32020-05-14 18:05:58 +020014889 state->StatVFSResultType = StatVFSResultType;
Martin v. Löwis05bfe1f2008-12-29 18:21:47 +000014890#ifdef NEED_TICKS_PER_SECOND
14891# if defined(HAVE_SYSCONF) && defined(_SC_CLK_TCK)
Eddie Elizondob3966632019-11-05 07:16:14 -080014892 ticks_per_second = sysconf(_SC_CLK_TCK);
Martin v. Löwis05bfe1f2008-12-29 18:21:47 +000014893# elif defined(HZ)
Eddie Elizondob3966632019-11-05 07:16:14 -080014894 ticks_per_second = HZ;
Martin v. Löwis05bfe1f2008-12-29 18:21:47 +000014895# else
Eddie Elizondob3966632019-11-05 07:16:14 -080014896 ticks_per_second = 60; /* magic fallback value; may be bogus */
Martin v. Löwis05bfe1f2008-12-29 18:21:47 +000014897# endif
14898#endif
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014899
William Orr81574b82018-10-01 22:19:56 -070014900#if defined(HAVE_SCHED_SETPARAM) || defined(HAVE_SCHED_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDPARAM)
Eddie Elizondob3966632019-11-05 07:16:14 -080014901 sched_param_desc.name = MODNAME ".sched_param";
14902 PyObject *SchedParamType = (PyObject *)PyStructSequence_NewType(&sched_param_desc);
14903 if (SchedParamType == NULL) {
Victor Stinner1c2fa782020-05-10 11:05:29 +020014904 return -1;
Victor Stinner8c62be82010-05-06 00:08:46 +000014905 }
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014906 Py_INCREF(SchedParamType);
Eddie Elizondob3966632019-11-05 07:16:14 -080014907 PyModule_AddObject(m, "sched_param", SchedParamType);
Victor Stinner97f33c32020-05-14 18:05:58 +020014908 state->SchedParamType = SchedParamType;
Eddie Elizondob3966632019-11-05 07:16:14 -080014909 ((PyTypeObject *)SchedParamType)->tp_new = os_sched_param;
Benjamin Petersone3298dd2011-08-02 18:40:46 -050014910#endif
Thomas Wouters477c8d52006-05-27 19:21:47 +000014911
Eddie Elizondob3966632019-11-05 07:16:14 -080014912 /* initialize TerminalSize_info */
14913 PyObject *TerminalSizeType = (PyObject *)PyStructSequence_NewType(&TerminalSize_desc);
14914 if (TerminalSizeType == NULL) {
Victor Stinner1c2fa782020-05-10 11:05:29 +020014915 return -1;
Eddie Elizondob3966632019-11-05 07:16:14 -080014916 }
14917 Py_INCREF(TerminalSizeType);
14918 PyModule_AddObject(m, "terminal_size", TerminalSizeType);
Victor Stinner97f33c32020-05-14 18:05:58 +020014919 state->TerminalSizeType = TerminalSizeType;
Eddie Elizondob3966632019-11-05 07:16:14 -080014920
14921 /* initialize scandir types */
Victor Stinner1c2fa782020-05-10 11:05:29 +020014922 PyObject *ScandirIteratorType = PyType_FromModuleAndSpec(m, &ScandirIteratorType_spec, NULL);
Eddie Elizondob3966632019-11-05 07:16:14 -080014923 if (ScandirIteratorType == NULL) {
Victor Stinner1c2fa782020-05-10 11:05:29 +020014924 return -1;
Eddie Elizondob3966632019-11-05 07:16:14 -080014925 }
Victor Stinner97f33c32020-05-14 18:05:58 +020014926 state->ScandirIteratorType = ScandirIteratorType;
Eddie Elizondob3966632019-11-05 07:16:14 -080014927
Victor Stinner1c2fa782020-05-10 11:05:29 +020014928 PyObject *DirEntryType = PyType_FromModuleAndSpec(m, &DirEntryType_spec, NULL);
Eddie Elizondob3966632019-11-05 07:16:14 -080014929 if (DirEntryType == NULL) {
Victor Stinner1c2fa782020-05-10 11:05:29 +020014930 return -1;
Eddie Elizondob3966632019-11-05 07:16:14 -080014931 }
14932 Py_INCREF(DirEntryType);
14933 PyModule_AddObject(m, "DirEntry", DirEntryType);
Victor Stinner97f33c32020-05-14 18:05:58 +020014934 state->DirEntryType = DirEntryType;
Eddie Elizondob3966632019-11-05 07:16:14 -080014935
Larry Hastings605a62d2012-06-24 04:33:36 -070014936 times_result_desc.name = MODNAME ".times_result";
Eddie Elizondob3966632019-11-05 07:16:14 -080014937 PyObject *TimesResultType = (PyObject *)PyStructSequence_NewType(&times_result_desc);
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014938 if (TimesResultType == NULL) {
Victor Stinner1c2fa782020-05-10 11:05:29 +020014939 return -1;
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014940 }
Eddie Elizondob3966632019-11-05 07:16:14 -080014941 Py_INCREF(TimesResultType);
14942 PyModule_AddObject(m, "times_result", TimesResultType);
Victor Stinner97f33c32020-05-14 18:05:58 +020014943 state->TimesResultType = TimesResultType;
Larry Hastings605a62d2012-06-24 04:33:36 -070014944
Eddie Elizondob3966632019-11-05 07:16:14 -080014945 PyTypeObject *UnameResultType = PyStructSequence_NewType(&uname_result_desc);
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014946 if (UnameResultType == NULL) {
Victor Stinner1c2fa782020-05-10 11:05:29 +020014947 return -1;
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014948 }
Eddie Elizondob3966632019-11-05 07:16:14 -080014949 Py_INCREF(UnameResultType);
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014950 PyModule_AddObject(m, "uname_result", (PyObject *)UnameResultType);
Victor Stinner97f33c32020-05-14 18:05:58 +020014951 state->UnameResultType = (PyObject *)UnameResultType;
Larry Hastings605a62d2012-06-24 04:33:36 -070014952
Thomas Wouters477c8d52006-05-27 19:21:47 +000014953#ifdef __APPLE__
Victor Stinner8c62be82010-05-06 00:08:46 +000014954 /*
14955 * Step 2 of weak-linking support on Mac OS X.
14956 *
14957 * The code below removes functions that are not available on the
14958 * currently active platform.
14959 *
14960 * This block allow one to use a python binary that was build on
Larry Hastings9cf065c2012-06-22 16:30:09 -070014961 * OSX 10.4 on OSX 10.3, without losing access to new APIs on
Victor Stinner8c62be82010-05-06 00:08:46 +000014962 * OSX 10.4.
14963 */
Thomas Wouters477c8d52006-05-27 19:21:47 +000014964#ifdef HAVE_FSTATVFS
Victor Stinner8c62be82010-05-06 00:08:46 +000014965 if (fstatvfs == NULL) {
14966 if (PyObject_DelAttrString(m, "fstatvfs") == -1) {
Victor Stinner1c2fa782020-05-10 11:05:29 +020014967 return -1;
Victor Stinner8c62be82010-05-06 00:08:46 +000014968 }
14969 }
Thomas Wouters477c8d52006-05-27 19:21:47 +000014970#endif /* HAVE_FSTATVFS */
14971
14972#ifdef HAVE_STATVFS
Victor Stinner8c62be82010-05-06 00:08:46 +000014973 if (statvfs == NULL) {
14974 if (PyObject_DelAttrString(m, "statvfs") == -1) {
Victor Stinner1c2fa782020-05-10 11:05:29 +020014975 return -1;
Victor Stinner8c62be82010-05-06 00:08:46 +000014976 }
14977 }
Thomas Wouters477c8d52006-05-27 19:21:47 +000014978#endif /* HAVE_STATVFS */
14979
14980# ifdef HAVE_LCHOWN
Victor Stinner8c62be82010-05-06 00:08:46 +000014981 if (lchown == NULL) {
14982 if (PyObject_DelAttrString(m, "lchown") == -1) {
Victor Stinner1c2fa782020-05-10 11:05:29 +020014983 return -1;
Victor Stinner8c62be82010-05-06 00:08:46 +000014984 }
14985 }
Thomas Wouters477c8d52006-05-27 19:21:47 +000014986#endif /* HAVE_LCHOWN */
14987
14988
14989#endif /* __APPLE__ */
Antoine Pitroubcf2b592012-02-08 23:28:36 +010014990
Victor Stinner97f33c32020-05-14 18:05:58 +020014991 if ((state->billion = PyLong_FromLong(1000000000)) == NULL)
Victor Stinner1c2fa782020-05-10 11:05:29 +020014992 return -1;
Eddie Elizondob3966632019-11-05 07:16:14 -080014993#if defined(HAVE_WAIT3) || defined(HAVE_WAIT4)
Victor Stinner97f33c32020-05-14 18:05:58 +020014994 state->struct_rusage = PyUnicode_InternFromString("struct_rusage");
14995 if (state->struct_rusage == NULL)
Victor Stinner1c2fa782020-05-10 11:05:29 +020014996 return -1;
Eddie Elizondob3966632019-11-05 07:16:14 -080014997#endif
Victor Stinner97f33c32020-05-14 18:05:58 +020014998 state->st_mode = PyUnicode_InternFromString("st_mode");
14999 if (state->st_mode == NULL)
Victor Stinner1c2fa782020-05-10 11:05:29 +020015000 return -1;
Larry Hastings6fe20b32012-04-19 15:07:49 -070015001
Larry Hastings9cf065c2012-06-22 16:30:09 -070015002 /* suppress "function not used" warnings */
15003 {
15004 int ignored;
15005 fd_specified("", -1);
15006 follow_symlinks_specified("", 1);
15007 dir_fd_and_follow_symlinks_invalid("chmod", DEFAULT_DIR_FD, 1);
15008 dir_fd_converter(Py_None, &ignored);
15009 dir_fd_unavailable(Py_None, &ignored);
15010 }
15011
15012 /*
15013 * provide list of locally available functions
15014 * so os.py can populate support_* lists
15015 */
Victor Stinner97f33c32020-05-14 18:05:58 +020015016 PyObject *list = PyList_New(0);
15017 if (!list) {
Victor Stinner1c2fa782020-05-10 11:05:29 +020015018 return -1;
Victor Stinner97f33c32020-05-14 18:05:58 +020015019 }
15020 for (const char * const *trace = have_functions; *trace; trace++) {
Larry Hastings9cf065c2012-06-22 16:30:09 -070015021 PyObject *unicode = PyUnicode_DecodeASCII(*trace, strlen(*trace), NULL);
15022 if (!unicode)
Victor Stinner1c2fa782020-05-10 11:05:29 +020015023 return -1;
Larry Hastings9cf065c2012-06-22 16:30:09 -070015024 if (PyList_Append(list, unicode))
Victor Stinner1c2fa782020-05-10 11:05:29 +020015025 return -1;
Larry Hastings9cf065c2012-06-22 16:30:09 -070015026 Py_DECREF(unicode);
15027 }
15028 PyModule_AddObject(m, "_have_functions", list);
Ned Deilyeb3be662016-08-15 14:40:38 -040015029
Victor Stinner1c2fa782020-05-10 11:05:29 +020015030 return 0;
15031}
15032
15033
15034static PyModuleDef_Slot posixmodile_slots[] = {
15035 {Py_mod_exec, posixmodule_exec},
15036 {0, NULL}
15037};
15038
15039static struct PyModuleDef posixmodule = {
15040 PyModuleDef_HEAD_INIT,
15041 .m_name = MODNAME,
15042 .m_doc = posix__doc__,
15043 .m_size = sizeof(_posixstate),
15044 .m_methods = posix_methods,
15045 .m_slots = posixmodile_slots,
15046 .m_traverse = _posix_traverse,
15047 .m_clear = _posix_clear,
15048 .m_free = _posix_free,
15049};
15050
15051PyMODINIT_FUNC
15052INITFUNC(void)
15053{
15054 return PyModuleDef_Init(&posixmodule);
Guido van Rossumb6775db1994-08-01 11:34:53 +000015055}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000015056
15057#ifdef __cplusplus
15058}
15059#endif