blob: 726e3723f99d396a50cacd88fa1aa9a1e537af7f [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002/* POSIX module implementation */
3
Jesus Ceaab70e2a2012-10-05 01:48:08 +02004/* This file is also used for Windows NT/MS-Win. In that case the
5 module actually calls itself 'nt', not 'posix', and a few
Andrew MacIntyre6c73af22002-03-03 03:07:07 +00006 functions are either unimplemented or implemented differently. The source
Martin v. Löwis6238d2b2002-06-30 15:26:10 +00007 assumes that for Windows NT, the macro 'MS_WINDOWS' is defined independent
Guido van Rossumad0ee831995-03-01 10:34:45 +00008 of the compiler used. Different compilers define their own feature
Victor Stinnerf427a142014-10-22 12:33:23 +02009 test macro, e.g. '_MSC_VER'. */
Guido van Rossumad0ee831995-03-01 10:34:45 +000010
Larry Hastings31826802013-10-19 00:09:25 -070011
12
Thomas Wouters477c8d52006-05-27 19:21:47 +000013#ifdef __APPLE__
14 /*
Victor Stinner8c62be82010-05-06 00:08:46 +000015 * Step 1 of support for weak-linking a number of symbols existing on
Thomas Wouters477c8d52006-05-27 19:21:47 +000016 * OSX 10.4 and later, see the comment in the #ifdef __APPLE__ block
17 * at the end of this file for more information.
18 */
19# pragma weak lchown
20# pragma weak statvfs
21# pragma weak fstatvfs
22
23#endif /* __APPLE__ */
24
Thomas Wouters68bc4f92006-03-01 01:05:10 +000025#define PY_SSIZE_T_CLEAN
26
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000027#include "Python.h"
Victor Stinnerd5d9e812019-05-13 12:35:37 +020028#ifdef MS_WINDOWS
29 /* include <windows.h> early to avoid conflict with pycore_condvar.h:
30
31 #define WIN32_LEAN_AND_MEAN
32 #include <windows.h>
33
34 FSCTL_GET_REPARSE_POINT is not exported with WIN32_LEAN_AND_MEAN. */
35# include <windows.h>
36#endif
37
38#include "pycore_ceval.h" /* _PyEval_ReInitThreads() */
39#include "pycore_pystate.h" /* _PyRuntime */
Antoine Pitrou346cbd32017-05-27 17:50:54 +020040#include "pythread.h"
Victor Stinner6036e442015-03-08 01:58:04 +010041#include "structmember.h"
Serhiy Storchaka7cf55992013-02-10 21:56:49 +020042#ifndef MS_WINDOWS
Victor Stinnerd5d9e812019-05-13 12:35:37 +020043# include "posixmodule.h"
Tim Golden0321cf22014-05-05 19:46:17 +010044#else
Victor Stinnerd5d9e812019-05-13 12:35:37 +020045# include "winreparse.h"
Serhiy Storchaka7cf55992013-02-10 21:56:49 +020046#endif
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000047
Stefan Krahfb7c8ae2016-04-26 17:04:18 +020048/* On android API level 21, 'AT_EACCESS' is not declared although
49 * HAVE_FACCESSAT is defined. */
50#ifdef __ANDROID__
51#undef HAVE_FACCESSAT
52#endif
53
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D)fa76eee2016-05-28 21:03:48 +000054#include <stdio.h> /* needed for ctermid() */
55
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000056#ifdef __cplusplus
57extern "C" {
58#endif
59
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000060PyDoc_STRVAR(posix__doc__,
Guido van Rossumec4f4ac1997-06-02 22:20:51 +000061"This module provides access to operating system functionality that is\n\
62standardized by the C Standard and the POSIX standard (a thinly\n\
63disguised Unix interface). Refer to the library manual and\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000064corresponding Unix manual entries for more information on calls.");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000065
Martin v. Löwis0073f2e2002-11-21 23:52:35 +000066
Ross Lagerwall4d076da2011-03-18 06:56:53 +020067#ifdef HAVE_SYS_UIO_H
68#include <sys/uio.h>
69#endif
70
Christian Heimes75b96182017-09-05 15:53:09 +020071#ifdef HAVE_SYS_SYSMACROS_H
72/* GNU C Library: major(), minor(), makedev() */
73#include <sys/sysmacros.h>
74#endif
75
Thomas Wouters0e3f5912006-08-11 14:57:12 +000076#ifdef HAVE_SYS_TYPES_H
Guido van Rossumb6775db1994-08-01 11:34:53 +000077#include <sys/types.h>
Thomas Wouters0e3f5912006-08-11 14:57:12 +000078#endif /* HAVE_SYS_TYPES_H */
79
80#ifdef HAVE_SYS_STAT_H
Guido van Rossumb6775db1994-08-01 11:34:53 +000081#include <sys/stat.h>
Thomas Wouters0e3f5912006-08-11 14:57:12 +000082#endif /* HAVE_SYS_STAT_H */
Guido van Rossuma6535fd2001-10-18 19:44:10 +000083
Guido van Rossum36bc6801995-06-14 22:54:23 +000084#ifdef HAVE_SYS_WAIT_H
Victor Stinner8c62be82010-05-06 00:08:46 +000085#include <sys/wait.h> /* For WNOHANG */
Guido van Rossum36bc6801995-06-14 22:54:23 +000086#endif
Guido van Rossumb6775db1994-08-01 11:34:53 +000087
Thomas Wouters0e3f5912006-08-11 14:57:12 +000088#ifdef HAVE_SIGNAL_H
Guido van Rossuma376cc51996-12-05 23:43:35 +000089#include <signal.h>
Thomas Wouters0e3f5912006-08-11 14:57:12 +000090#endif
Guido van Rossuma376cc51996-12-05 23:43:35 +000091
Guido van Rossumb6775db1994-08-01 11:34:53 +000092#ifdef HAVE_FCNTL_H
93#include <fcntl.h>
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +000094#endif /* HAVE_FCNTL_H */
Guido van Rossumb6775db1994-08-01 11:34:53 +000095
Guido van Rossuma6535fd2001-10-18 19:44:10 +000096#ifdef HAVE_GRP_H
97#include <grp.h>
98#endif
99
Barry Warsaw5676bd12003-01-07 20:57:09 +0000100#ifdef HAVE_SYSEXITS_H
101#include <sysexits.h>
102#endif /* HAVE_SYSEXITS_H */
103
Anthony Baxter8a560de2004-10-13 15:30:56 +0000104#ifdef HAVE_SYS_LOADAVG_H
105#include <sys/loadavg.h>
106#endif
107
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +0000108#ifdef HAVE_SYS_SENDFILE_H
109#include <sys/sendfile.h>
110#endif
111
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +0200112#if defined(__APPLE__)
113#include <copyfile.h>
114#endif
115
Benjamin Peterson94b580d2011-08-02 17:30:04 -0500116#ifdef HAVE_SCHED_H
117#include <sched.h>
118#endif
119
Pablo Galindoaac4d032019-05-31 19:39:47 +0100120#ifdef HAVE_COPY_FILE_RANGE
121#include <unistd.h>
122#endif
123
Benjamin Peterson2dbda072012-03-16 10:12:55 -0500124#if !defined(CPU_ALLOC) && defined(HAVE_SCHED_SETAFFINITY)
Benjamin Peterson7b51b8d2012-03-14 22:28:25 -0500125#undef HAVE_SCHED_SETAFFINITY
126#endif
127
doko@ubuntu.com4a173bc2014-04-17 19:47:16 +0200128#if defined(HAVE_SYS_XATTR_H) && defined(__GLIBC__) && !defined(__FreeBSD_kernel__) && !defined(__GNU__)
Benjamin Peterson9428d532011-09-14 11:45:52 -0400129#define USE_XATTRS
130#endif
131
132#ifdef USE_XATTRS
Benjamin Petersonb77fe172011-09-13 17:20:47 -0400133#include <sys/xattr.h>
Benjamin Peterson799bd802011-08-31 22:15:17 -0400134#endif
135
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +0000136#if defined(__FreeBSD__) || defined(__DragonFly__) || defined(__APPLE__)
137#ifdef HAVE_SYS_SOCKET_H
138#include <sys/socket.h>
139#endif
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +0000140#endif
141
Victor Stinner8b905bd2011-10-25 13:34:04 +0200142#ifdef HAVE_DLFCN_H
143#include <dlfcn.h>
144#endif
145
Charles-Francois Natali44feda32013-05-20 14:40:46 +0200146#ifdef __hpux
147#include <sys/mpctl.h>
148#endif
149
150#if defined(__DragonFly__) || \
151 defined(__OpenBSD__) || \
152 defined(__FreeBSD__) || \
153 defined(__NetBSD__) || \
154 defined(__APPLE__)
155#include <sys/sysctl.h>
156#endif
157
Victor Stinner9b1f4742016-09-06 16:18:52 -0700158#ifdef HAVE_LINUX_RANDOM_H
159# include <linux/random.h>
160#endif
161#ifdef HAVE_GETRANDOM_SYSCALL
162# include <sys/syscall.h>
163#endif
164
Antoine Pitroubcf2b592012-02-08 23:28:36 +0100165#if defined(MS_WINDOWS)
166# define TERMSIZE_USE_CONIO
167#elif defined(HAVE_SYS_IOCTL_H)
168# include <sys/ioctl.h>
169# if defined(HAVE_TERMIOS_H)
170# include <termios.h>
171# endif
172# if defined(TIOCGWINSZ)
173# define TERMSIZE_USE_IOCTL
174# endif
175#endif /* MS_WINDOWS */
176
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000177/* Various compilers have only certain posix functions */
Martin v. Löwis4f1cd8b2001-07-26 13:41:06 +0000178/* XXX Gosh I wish these were all moved into pyconfig.h */
Victor Stinner8c62be82010-05-06 00:08:46 +0000179#if defined(__WATCOMC__) && !defined(__QNX__) /* Watcom compiler */
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000180#define HAVE_OPENDIR 1
Victor Stinner8c62be82010-05-06 00:08:46 +0000181#define HAVE_SYSTEM 1
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000182#include <process.h>
183#else
Victor Stinner8c62be82010-05-06 00:08:46 +0000184#ifdef _MSC_VER /* Microsoft compiler */
Amaury Forgeot d'Arc4b6fdf32010-09-07 21:31:17 +0000185#define HAVE_GETPPID 1
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +0000186#define HAVE_GETLOGIN 1
Victor Stinner8c62be82010-05-06 00:08:46 +0000187#define HAVE_SPAWNV 1
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000188#define HAVE_EXECV 1
Steve Dowercc16be82016-09-08 10:35:16 -0700189#define HAVE_WSPAWNV 1
190#define HAVE_WEXECV 1
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000191#define HAVE_PIPE 1
Victor Stinner8c62be82010-05-06 00:08:46 +0000192#define HAVE_SYSTEM 1
193#define HAVE_CWAIT 1
194#define HAVE_FSYNC 1
Tim Peters11b23062003-04-23 02:39:17 +0000195#define fsync _commit
Andrew MacIntyre6c73af22002-03-03 03:07:07 +0000196#else
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000197/* Unix functions that the configure script doesn't check for */
pxinwrf2d7ac72019-05-21 18:46:37 +0800198#ifndef __VXWORKS__
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000199#define HAVE_EXECV 1
200#define HAVE_FORK 1
Victor Stinner8c62be82010-05-06 00:08:46 +0000201#if defined(__USLC__) && defined(__SCO_VERSION__) /* SCO UDK Compiler */
Guido van Rossum2242f2f2001-04-11 20:58:20 +0000202#define HAVE_FORK1 1
203#endif
pxinwrf2d7ac72019-05-21 18:46:37 +0800204#endif
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000205#define HAVE_GETEGID 1
206#define HAVE_GETEUID 1
207#define HAVE_GETGID 1
208#define HAVE_GETPPID 1
209#define HAVE_GETUID 1
210#define HAVE_KILL 1
211#define HAVE_OPENDIR 1
212#define HAVE_PIPE 1
Victor Stinner8c62be82010-05-06 00:08:46 +0000213#define HAVE_SYSTEM 1
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000214#define HAVE_WAIT 1
Victor Stinner8c62be82010-05-06 00:08:46 +0000215#define HAVE_TTYNAME 1
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000216#endif /* _MSC_VER */
Guido van Rossumc5a0f531997-12-02 20:36:02 +0000217#endif /* ! __WATCOMC__ || __QNX__ */
Guido van Rossumad0ee831995-03-01 10:34:45 +0000218
Victor Stinnera2f7c002012-02-08 03:36:25 +0100219
Larry Hastings61272b72014-01-07 12:41:53 -0800220/*[clinic input]
Larry Hastings2f936352014-08-05 14:04:04 +1000221# one of the few times we lie about this name!
Larry Hastings44e2eaa2013-11-23 15:37:55 -0800222module os
Larry Hastings61272b72014-01-07 12:41:53 -0800223[clinic start generated code]*/
Larry Hastings2f936352014-08-05 14:04:04 +1000224/*[clinic end generated code: output=da39a3ee5e6b4b0d input=94a0f0f978acae17]*/
Victor Stinnera2f7c002012-02-08 03:36:25 +0100225
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000226#ifndef _MSC_VER
Guido van Rossum36bc6801995-06-14 22:54:23 +0000227
Martin v. Löwis8eb92a02002-09-19 08:03:21 +0000228#if defined(__sgi)&&_COMPILER_VERSION>=700
229/* declare ctermid_r if compiling with MIPSPro 7.x in ANSI C mode
230 (default) */
231extern char *ctermid_r(char *);
232#endif
233
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000234#endif /* !_MSC_VER */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000235
pxinwrf2d7ac72019-05-21 18:46:37 +0800236#if defined(__VXWORKS__)
237#include <vxCpuLib.h>
238#include <rtpLib.h>
239#include <wait.h>
240#include <taskLib.h>
241#ifndef _P_WAIT
242#define _P_WAIT 0
243#define _P_NOWAIT 1
244#define _P_NOWAITO 1
245#endif
246#endif /* __VXWORKS__ */
247
Pablo Galindo6c6ddf92018-01-29 01:56:10 +0000248#ifdef HAVE_POSIX_SPAWN
249#include <spawn.h>
250#endif
251
Guido van Rossumb6775db1994-08-01 11:34:53 +0000252#ifdef HAVE_UTIME_H
253#include <utime.h>
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +0000254#endif /* HAVE_UTIME_H */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000255
Guido van Rossum14ed0b21994-09-29 09:50:09 +0000256#ifdef HAVE_SYS_UTIME_H
257#include <sys/utime.h>
258#define HAVE_UTIME_H /* pretend we do for the rest of this file */
259#endif /* HAVE_SYS_UTIME_H */
260
Guido van Rossumb6775db1994-08-01 11:34:53 +0000261#ifdef HAVE_SYS_TIMES_H
262#include <sys/times.h>
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +0000263#endif /* HAVE_SYS_TIMES_H */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000264
265#ifdef HAVE_SYS_PARAM_H
266#include <sys/param.h>
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +0000267#endif /* HAVE_SYS_PARAM_H */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000268
269#ifdef HAVE_SYS_UTSNAME_H
270#include <sys/utsname.h>
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +0000271#endif /* HAVE_SYS_UTSNAME_H */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000272
Guido van Rossum3bbc62e1995-01-02 19:30:30 +0000273#ifdef HAVE_DIRENT_H
Guido van Rossumb6775db1994-08-01 11:34:53 +0000274#include <dirent.h>
Guido van Rossum3bbc62e1995-01-02 19:30:30 +0000275#define NAMLEN(dirent) strlen((dirent)->d_name)
276#else
Guido van Rossumc5a0f531997-12-02 20:36:02 +0000277#if defined(__WATCOMC__) && !defined(__QNX__)
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000278#include <direct.h>
279#define NAMLEN(dirent) strlen((dirent)->d_name)
280#else
Guido van Rossumb6775db1994-08-01 11:34:53 +0000281#define dirent direct
Guido van Rossum3bbc62e1995-01-02 19:30:30 +0000282#define NAMLEN(dirent) (dirent)->d_namlen
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000283#endif
Guido van Rossum3bbc62e1995-01-02 19:30:30 +0000284#ifdef HAVE_SYS_NDIR_H
Guido van Rossumb6775db1994-08-01 11:34:53 +0000285#include <sys/ndir.h>
Guido van Rossum3bbc62e1995-01-02 19:30:30 +0000286#endif
287#ifdef HAVE_SYS_DIR_H
Guido van Rossumb6775db1994-08-01 11:34:53 +0000288#include <sys/dir.h>
Guido van Rossum3bbc62e1995-01-02 19:30:30 +0000289#endif
290#ifdef HAVE_NDIR_H
Guido van Rossumb6775db1994-08-01 11:34:53 +0000291#include <ndir.h>
Guido van Rossum3bbc62e1995-01-02 19:30:30 +0000292#endif
293#endif
Guido van Rossumb6775db1994-08-01 11:34:53 +0000294
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000295#ifdef _MSC_VER
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000296#ifdef HAVE_DIRECT_H
Guido van Rossumb6775db1994-08-01 11:34:53 +0000297#include <direct.h>
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000298#endif
299#ifdef HAVE_IO_H
Guido van Rossumb6775db1994-08-01 11:34:53 +0000300#include <io.h>
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000301#endif
302#ifdef HAVE_PROCESS_H
Guido van Rossumb6775db1994-08-01 11:34:53 +0000303#include <process.h>
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000304#endif
Raymond Hettinger0291c9f2010-08-01 21:10:35 +0000305#ifndef IO_REPARSE_TAG_SYMLINK
Amaury Forgeot d'Arc844807e2010-08-16 22:16:51 +0000306#define IO_REPARSE_TAG_SYMLINK (0xA000000CL)
Raymond Hettinger0291c9f2010-08-01 21:10:35 +0000307#endif
Tim Golden0321cf22014-05-05 19:46:17 +0100308#ifndef IO_REPARSE_TAG_MOUNT_POINT
309#define IO_REPARSE_TAG_MOUNT_POINT (0xA0000003L)
310#endif
Tim Petersbc2e10e2002-03-03 23:17:02 +0000311#include "osdefs.h"
Kristján Valur Jónssonf64e6512009-04-13 10:16:14 +0000312#include <malloc.h>
Guido van Rossumb6775db1994-08-01 11:34:53 +0000313#include <windows.h>
Victor Stinner8c62be82010-05-06 00:08:46 +0000314#include <shellapi.h> /* for ShellExecute() */
Brian Curtine8e4b3b2010-09-23 20:04:14 +0000315#include <lmcons.h> /* for UNLEN */
Brian Curtin52173d42010-12-02 18:29:18 +0000316#define HAVE_SYMLINK
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000317#endif /* _MSC_VER */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000318
Tim Petersbc2e10e2002-03-03 23:17:02 +0000319#ifndef MAXPATHLEN
Thomas Wouters477c8d52006-05-27 19:21:47 +0000320#if defined(PATH_MAX) && PATH_MAX > 1024
321#define MAXPATHLEN PATH_MAX
322#else
Tim Petersbc2e10e2002-03-03 23:17:02 +0000323#define MAXPATHLEN 1024
Thomas Wouters477c8d52006-05-27 19:21:47 +0000324#endif
Tim Petersbc2e10e2002-03-03 23:17:02 +0000325#endif /* MAXPATHLEN */
326
Guido van Rossum54ecc3d1999-01-27 17:53:11 +0000327#ifdef UNION_WAIT
328/* Emulate some macros on systems that have a union instead of macros */
329
330#ifndef WIFEXITED
331#define WIFEXITED(u_wait) (!(u_wait).w_termsig && !(u_wait).w_coredump)
332#endif
333
334#ifndef WEXITSTATUS
335#define WEXITSTATUS(u_wait) (WIFEXITED(u_wait)?((u_wait).w_retcode):-1)
336#endif
337
338#ifndef WTERMSIG
339#define WTERMSIG(u_wait) ((u_wait).w_termsig)
340#endif
341
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000342#define WAIT_TYPE union wait
343#define WAIT_STATUS_INT(s) (s.w_status)
344
345#else /* !UNION_WAIT */
346#define WAIT_TYPE int
347#define WAIT_STATUS_INT(s) (s)
Guido van Rossum54ecc3d1999-01-27 17:53:11 +0000348#endif /* UNION_WAIT */
349
Greg Wardb48bc172000-03-01 21:51:56 +0000350/* Don't use the "_r" form if we don't need it (also, won't have a
351 prototype for it, at least on Solaris -- maybe others as well?). */
Antoine Pitroua6a4dc82017-09-07 18:56:24 +0200352#if defined(HAVE_CTERMID_R)
Greg Wardb48bc172000-03-01 21:51:56 +0000353#define USE_CTERMID_R
354#endif
355
Fred Drake699f3522000-06-29 21:12:41 +0000356/* choose the appropriate stat and fstat functions and return structs */
Guido van Rossum64529cd2000-06-30 22:45:12 +0000357#undef STAT
Antoine Pitroue47e0932011-01-19 15:21:35 +0000358#undef FSTAT
359#undef STRUCT_STAT
Victor Stinner14b9b112013-06-25 00:37:25 +0200360#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +0000361# define STAT win32_stat
Larry Hastings9cf065c2012-06-22 16:30:09 -0700362# define LSTAT win32_lstat
Victor Stinnere134a7f2015-03-30 10:09:31 +0200363# define FSTAT _Py_fstat_noraise
Steve Dowerf2f373f2015-02-21 08:44:05 -0800364# define STRUCT_STAT struct _Py_stat_struct
Fred Drake699f3522000-06-29 21:12:41 +0000365#else
Victor Stinner8c62be82010-05-06 00:08:46 +0000366# define STAT stat
Larry Hastings9cf065c2012-06-22 16:30:09 -0700367# define LSTAT lstat
Victor Stinner8c62be82010-05-06 00:08:46 +0000368# define FSTAT fstat
369# define STRUCT_STAT struct stat
Fred Drake699f3522000-06-29 21:12:41 +0000370#endif
371
Tim Peters11b23062003-04-23 02:39:17 +0000372#if defined(MAJOR_IN_MKDEV)
Martin v. Löwisdbe3f762002-10-10 14:27:30 +0000373#include <sys/mkdev.h>
374#else
375#if defined(MAJOR_IN_SYSMACROS)
376#include <sys/sysmacros.h>
377#endif
Neal Norwitz3d949422002-04-20 13:46:43 +0000378#if defined(HAVE_MKNOD) && defined(HAVE_SYS_MKDEV_H)
379#include <sys/mkdev.h>
380#endif
Martin v. Löwisdbe3f762002-10-10 14:27:30 +0000381#endif
Fred Drake699f3522000-06-29 21:12:41 +0000382
Serhiy Storchaka06a13f82015-02-22 21:34:54 +0200383#ifdef MS_WINDOWS
Victor Stinner6036e442015-03-08 01:58:04 +0100384#define INITFUNC PyInit_nt
385#define MODNAME "nt"
386#else
387#define INITFUNC PyInit_posix
388#define MODNAME "posix"
389#endif
390
jcea6c51d512018-01-28 14:00:08 +0100391#if defined(__sun)
392/* Something to implement in autoconf, not present in autoconf 2.69 */
393#define HAVE_STRUCT_STAT_ST_FSTYPE 1
394#endif
Antoine Pitrou346cbd32017-05-27 17:50:54 +0200395
Zackery Spytz43fdbd22019-05-29 13:57:07 -0600396/* memfd_create is either defined in sys/mman.h or sys/memfd.h
397 * linux/memfd.h defines additional flags
398 */
399#ifdef HAVE_SYS_MMAN_H
400#include <sys/mman.h>
401#endif
402#ifdef HAVE_SYS_MEMFD_H
403#include <sys/memfd.h>
404#endif
405#ifdef HAVE_LINUX_MEMFD_H
406#include <linux/memfd.h>
407#endif
408
Gregory P. Smith1d300ce2018-12-30 21:13:02 -0800409#ifdef _Py_MEMORY_SANITIZER
410# include <sanitizer/msan_interface.h>
411#endif
412
Antoine Pitrou346cbd32017-05-27 17:50:54 +0200413#ifdef HAVE_FORK
414static void
415run_at_forkers(PyObject *lst, int reverse)
416{
417 Py_ssize_t i;
418 PyObject *cpy;
419
420 if (lst != NULL) {
421 assert(PyList_CheckExact(lst));
422
423 /* Use a list copy in case register_at_fork() is called from
424 * one of the callbacks.
425 */
426 cpy = PyList_GetSlice(lst, 0, PyList_GET_SIZE(lst));
427 if (cpy == NULL)
428 PyErr_WriteUnraisable(lst);
429 else {
430 if (reverse)
431 PyList_Reverse(cpy);
432 for (i = 0; i < PyList_GET_SIZE(cpy); i++) {
433 PyObject *func, *res;
434 func = PyList_GET_ITEM(cpy, i);
435 res = PyObject_CallObject(func, NULL);
436 if (res == NULL)
437 PyErr_WriteUnraisable(func);
438 else
439 Py_DECREF(res);
440 }
441 Py_DECREF(cpy);
442 }
443 }
444}
445
446void
447PyOS_BeforeFork(void)
448{
Victor Stinnercaba55b2018-08-03 15:33:52 +0200449 run_at_forkers(_PyInterpreterState_Get()->before_forkers, 1);
Antoine Pitrou346cbd32017-05-27 17:50:54 +0200450
451 _PyImport_AcquireLock();
452}
453
454void
455PyOS_AfterFork_Parent(void)
456{
457 if (_PyImport_ReleaseLock() <= 0)
458 Py_FatalError("failed releasing import lock after fork");
459
Victor Stinnercaba55b2018-08-03 15:33:52 +0200460 run_at_forkers(_PyInterpreterState_Get()->after_forkers_parent, 0);
Antoine Pitrou346cbd32017-05-27 17:50:54 +0200461}
462
463void
464PyOS_AfterFork_Child(void)
465{
Victor Stinnerb930a2d2019-04-24 17:14:33 +0200466 _PyRuntimeState *runtime = &_PyRuntime;
467 _PyGILState_Reinit(runtime);
Victor Stinnerd5d9e812019-05-13 12:35:37 +0200468 _PyEval_ReInitThreads(runtime);
Antoine Pitrou346cbd32017-05-27 17:50:54 +0200469 _PyImport_ReInitLock();
Antoine Pitrou346cbd32017-05-27 17:50:54 +0200470 _PySignal_AfterFork();
Victor Stinnerb930a2d2019-04-24 17:14:33 +0200471 _PyRuntimeState_ReInitThreads(runtime);
Victor Stinnerb49858b2019-05-24 15:20:23 +0200472 _PyInterpreterState_DeleteExceptMain(runtime);
Antoine Pitrou346cbd32017-05-27 17:50:54 +0200473
Victor Stinnercaba55b2018-08-03 15:33:52 +0200474 run_at_forkers(_PyInterpreterState_Get()->after_forkers_child, 0);
Antoine Pitrou346cbd32017-05-27 17:50:54 +0200475}
476
477static int
478register_at_forker(PyObject **lst, PyObject *func)
479{
Gregory P. Smith163468a2017-05-29 10:03:41 -0700480 if (func == NULL) /* nothing to register? do nothing. */
481 return 0;
Antoine Pitrou346cbd32017-05-27 17:50:54 +0200482 if (*lst == NULL) {
483 *lst = PyList_New(0);
484 if (*lst == NULL)
485 return -1;
486 }
487 return PyList_Append(*lst, func);
488}
489#endif
490
491/* Legacy wrapper */
492void
493PyOS_AfterFork(void)
494{
495#ifdef HAVE_FORK
496 PyOS_AfterFork_Child();
497#endif
498}
499
500
Victor Stinner6036e442015-03-08 01:58:04 +0100501#ifdef MS_WINDOWS
Serhiy Storchaka06a13f82015-02-22 21:34:54 +0200502/* defined in fileutils.c */
Benjamin Petersone5024512018-09-12 12:06:42 -0700503void _Py_time_t_to_FILE_TIME(time_t, int, FILETIME *);
504void _Py_attribute_data_to_stat(BY_HANDLE_FILE_INFORMATION *,
Serhiy Storchaka06a13f82015-02-22 21:34:54 +0200505 ULONG, struct _Py_stat_struct *);
506#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -0700507
Larry Hastings9cf065c2012-06-22 16:30:09 -0700508
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200509#ifndef MS_WINDOWS
510PyObject *
511_PyLong_FromUid(uid_t uid)
512{
513 if (uid == (uid_t)-1)
514 return PyLong_FromLong(-1);
515 return PyLong_FromUnsignedLong(uid);
516}
517
518PyObject *
519_PyLong_FromGid(gid_t gid)
520{
521 if (gid == (gid_t)-1)
522 return PyLong_FromLong(-1);
523 return PyLong_FromUnsignedLong(gid);
524}
525
526int
527_Py_Uid_Converter(PyObject *obj, void *p)
528{
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700529 uid_t uid;
530 PyObject *index;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200531 int overflow;
Serhiy Storchakab4621892013-02-10 23:28:02 +0200532 long result;
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700533 unsigned long uresult;
534
535 index = PyNumber_Index(obj);
536 if (index == NULL) {
537 PyErr_Format(PyExc_TypeError,
538 "uid should be integer, not %.200s",
539 Py_TYPE(obj)->tp_name);
Serhiy Storchakab4621892013-02-10 23:28:02 +0200540 return 0;
541 }
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700542
543 /*
544 * Handling uid_t is complicated for two reasons:
545 * * Although uid_t is (always?) unsigned, it still
546 * accepts -1.
547 * * We don't know its size in advance--it may be
548 * bigger than an int, or it may be smaller than
549 * a long.
550 *
551 * So a bit of defensive programming is in order.
552 * Start with interpreting the value passed
553 * in as a signed long and see if it works.
554 */
555
556 result = PyLong_AsLongAndOverflow(index, &overflow);
557
558 if (!overflow) {
559 uid = (uid_t)result;
560
561 if (result == -1) {
562 if (PyErr_Occurred())
563 goto fail;
564 /* It's a legitimate -1, we're done. */
565 goto success;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200566 }
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700567
568 /* Any other negative number is disallowed. */
569 if (result < 0)
570 goto underflow;
571
572 /* Ensure the value wasn't truncated. */
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200573 if (sizeof(uid_t) < sizeof(long) &&
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700574 (long)uid != result)
575 goto underflow;
576 goto success;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200577 }
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700578
579 if (overflow < 0)
580 goto underflow;
581
582 /*
583 * Okay, the value overflowed a signed long. If it
584 * fits in an *unsigned* long, it may still be okay,
585 * as uid_t may be unsigned long on this platform.
586 */
587 uresult = PyLong_AsUnsignedLong(index);
588 if (PyErr_Occurred()) {
589 if (PyErr_ExceptionMatches(PyExc_OverflowError))
590 goto overflow;
591 goto fail;
592 }
593
594 uid = (uid_t)uresult;
595
596 /*
597 * If uid == (uid_t)-1, the user actually passed in ULONG_MAX,
598 * but this value would get interpreted as (uid_t)-1 by chown
599 * and its siblings. That's not what the user meant! So we
600 * throw an overflow exception instead. (We already
Tim Golden23005082013-10-25 11:22:37 +0100601 * handled a real -1 with PyLong_AsLongAndOverflow() above.)
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700602 */
603 if (uid == (uid_t)-1)
604 goto overflow;
605
606 /* Ensure the value wasn't truncated. */
607 if (sizeof(uid_t) < sizeof(long) &&
608 (unsigned long)uid != uresult)
609 goto overflow;
610 /* fallthrough */
611
612success:
613 Py_DECREF(index);
614 *(uid_t *)p = uid;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200615 return 1;
616
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700617underflow:
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200618 PyErr_SetString(PyExc_OverflowError,
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700619 "uid is less than minimum");
620 goto fail;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200621
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700622overflow:
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200623 PyErr_SetString(PyExc_OverflowError,
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700624 "uid is greater than maximum");
625 /* fallthrough */
626
627fail:
628 Py_DECREF(index);
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200629 return 0;
630}
631
632int
633_Py_Gid_Converter(PyObject *obj, void *p)
634{
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700635 gid_t gid;
636 PyObject *index;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200637 int overflow;
Serhiy Storchakab4621892013-02-10 23:28:02 +0200638 long result;
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700639 unsigned long uresult;
640
641 index = PyNumber_Index(obj);
642 if (index == NULL) {
643 PyErr_Format(PyExc_TypeError,
644 "gid should be integer, not %.200s",
645 Py_TYPE(obj)->tp_name);
Serhiy Storchakab4621892013-02-10 23:28:02 +0200646 return 0;
647 }
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700648
649 /*
650 * Handling gid_t is complicated for two reasons:
651 * * Although gid_t is (always?) unsigned, it still
652 * accepts -1.
653 * * We don't know its size in advance--it may be
654 * bigger than an int, or it may be smaller than
655 * a long.
656 *
657 * So a bit of defensive programming is in order.
658 * Start with interpreting the value passed
659 * in as a signed long and see if it works.
660 */
661
662 result = PyLong_AsLongAndOverflow(index, &overflow);
663
664 if (!overflow) {
665 gid = (gid_t)result;
666
667 if (result == -1) {
668 if (PyErr_Occurred())
669 goto fail;
670 /* It's a legitimate -1, we're done. */
671 goto success;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200672 }
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700673
674 /* Any other negative number is disallowed. */
675 if (result < 0) {
676 goto underflow;
677 }
678
679 /* Ensure the value wasn't truncated. */
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200680 if (sizeof(gid_t) < sizeof(long) &&
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700681 (long)gid != result)
682 goto underflow;
683 goto success;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200684 }
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700685
686 if (overflow < 0)
687 goto underflow;
688
689 /*
690 * Okay, the value overflowed a signed long. If it
691 * fits in an *unsigned* long, it may still be okay,
692 * as gid_t may be unsigned long on this platform.
693 */
694 uresult = PyLong_AsUnsignedLong(index);
695 if (PyErr_Occurred()) {
696 if (PyErr_ExceptionMatches(PyExc_OverflowError))
697 goto overflow;
698 goto fail;
699 }
700
701 gid = (gid_t)uresult;
702
703 /*
704 * If gid == (gid_t)-1, the user actually passed in ULONG_MAX,
705 * but this value would get interpreted as (gid_t)-1 by chown
706 * and its siblings. That's not what the user meant! So we
707 * throw an overflow exception instead. (We already
Tim Golden23005082013-10-25 11:22:37 +0100708 * handled a real -1 with PyLong_AsLongAndOverflow() above.)
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700709 */
710 if (gid == (gid_t)-1)
711 goto overflow;
712
713 /* Ensure the value wasn't truncated. */
714 if (sizeof(gid_t) < sizeof(long) &&
715 (unsigned long)gid != uresult)
716 goto overflow;
717 /* fallthrough */
718
719success:
720 Py_DECREF(index);
721 *(gid_t *)p = gid;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200722 return 1;
723
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700724underflow:
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200725 PyErr_SetString(PyExc_OverflowError,
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700726 "gid is less than minimum");
727 goto fail;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200728
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700729overflow:
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200730 PyErr_SetString(PyExc_OverflowError,
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700731 "gid is greater than maximum");
732 /* fallthrough */
733
734fail:
735 Py_DECREF(index);
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200736 return 0;
737}
738#endif /* MS_WINDOWS */
739
740
Benjamin Petersoned4aa832016-09-05 17:44:18 -0700741#define _PyLong_FromDev PyLong_FromLongLong
Gregory P. Smith702dada2015-01-28 16:07:52 -0800742
743
Serhiy Storchakab2653b32015-01-18 11:12:11 +0200744#if defined(HAVE_MKNOD) && defined(HAVE_MAKEDEV)
745static int
746_Py_Dev_Converter(PyObject *obj, void *p)
747{
Serhiy Storchakab2653b32015-01-18 11:12:11 +0200748 *((dev_t *)p) = PyLong_AsUnsignedLongLong(obj);
Serhiy Storchakab2653b32015-01-18 11:12:11 +0200749 if (PyErr_Occurred())
750 return 0;
751 return 1;
752}
Gregory P. Smith702dada2015-01-28 16:07:52 -0800753#endif /* HAVE_MKNOD && HAVE_MAKEDEV */
Serhiy Storchakab2653b32015-01-18 11:12:11 +0200754
755
Larry Hastings9cf065c2012-06-22 16:30:09 -0700756#ifdef AT_FDCWD
Trent Nelson9a461052012-09-18 21:50:06 -0400757/*
758 * Why the (int) cast? Solaris 10 defines AT_FDCWD as 0xffd19553 (-3041965);
759 * without the int cast, the value gets interpreted as uint (4291925331),
760 * which doesn't play nicely with all the initializer lines in this file that
761 * look like this:
762 * int dir_fd = DEFAULT_DIR_FD;
763 */
764#define DEFAULT_DIR_FD (int)AT_FDCWD
Larry Hastings9cf065c2012-06-22 16:30:09 -0700765#else
766#define DEFAULT_DIR_FD (-100)
767#endif
768
769static int
Serhiy Storchaka819399b2016-04-06 22:17:52 +0300770_fd_converter(PyObject *o, int *p)
Serhiy Storchakaa2ad5c32013-01-07 23:13:46 +0200771{
772 int overflow;
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700773 long long_value;
774
775 PyObject *index = PyNumber_Index(o);
776 if (index == NULL) {
Larry Hastings9cf065c2012-06-22 16:30:09 -0700777 return 0;
778 }
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700779
Serhiy Storchaka819399b2016-04-06 22:17:52 +0300780 assert(PyLong_Check(index));
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700781 long_value = PyLong_AsLongAndOverflow(index, &overflow);
782 Py_DECREF(index);
Serhiy Storchaka819399b2016-04-06 22:17:52 +0300783 assert(!PyErr_Occurred());
Serhiy Storchakaa2ad5c32013-01-07 23:13:46 +0200784 if (overflow > 0 || long_value > INT_MAX) {
Larry Hastings9cf065c2012-06-22 16:30:09 -0700785 PyErr_SetString(PyExc_OverflowError,
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700786 "fd is greater than maximum");
Larry Hastings9cf065c2012-06-22 16:30:09 -0700787 return 0;
788 }
Serhiy Storchakaa2ad5c32013-01-07 23:13:46 +0200789 if (overflow < 0 || long_value < INT_MIN) {
Larry Hastings9cf065c2012-06-22 16:30:09 -0700790 PyErr_SetString(PyExc_OverflowError,
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700791 "fd is less than minimum");
Larry Hastings9cf065c2012-06-22 16:30:09 -0700792 return 0;
793 }
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700794
Larry Hastings9cf065c2012-06-22 16:30:09 -0700795 *p = (int)long_value;
796 return 1;
797}
798
799static int
Serhiy Storchakaa2ad5c32013-01-07 23:13:46 +0200800dir_fd_converter(PyObject *o, void *p)
801{
802 if (o == Py_None) {
803 *(int *)p = DEFAULT_DIR_FD;
804 return 1;
805 }
Serhiy Storchaka819399b2016-04-06 22:17:52 +0300806 else if (PyIndex_Check(o)) {
807 return _fd_converter(o, (int *)p);
808 }
809 else {
810 PyErr_Format(PyExc_TypeError,
811 "argument should be integer or None, not %.200s",
812 Py_TYPE(o)->tp_name);
813 return 0;
814 }
Larry Hastings9cf065c2012-06-22 16:30:09 -0700815}
816
817
Larry Hastings9cf065c2012-06-22 16:30:09 -0700818/*
819 * A PyArg_ParseTuple "converter" function
820 * that handles filesystem paths in the manner
821 * preferred by the os module.
822 *
823 * path_converter accepts (Unicode) strings and their
824 * subclasses, and bytes and their subclasses. What
825 * it does with the argument depends on the platform:
826 *
827 * * On Windows, if we get a (Unicode) string we
828 * extract the wchar_t * and return it; if we get
Steve Dowercc16be82016-09-08 10:35:16 -0700829 * bytes we decode to wchar_t * and return that.
Larry Hastings9cf065c2012-06-22 16:30:09 -0700830 *
831 * * On all other platforms, strings are encoded
832 * to bytes using PyUnicode_FSConverter, then we
833 * extract the char * from the bytes object and
834 * return that.
835 *
836 * path_converter also optionally accepts signed
837 * integers (representing open file descriptors) instead
838 * of path strings.
839 *
840 * Input fields:
841 * path.nullable
842 * If nonzero, the path is permitted to be None.
843 * path.allow_fd
844 * If nonzero, the path is permitted to be a file handle
845 * (a signed int) instead of a string.
846 * path.function_name
847 * If non-NULL, path_converter will use that as the name
848 * of the function in error messages.
Larry Hastings31826802013-10-19 00:09:25 -0700849 * (If path.function_name is NULL it omits the function name.)
Larry Hastings9cf065c2012-06-22 16:30:09 -0700850 * path.argument_name
851 * If non-NULL, path_converter will use that as the name
852 * of the parameter in error messages.
853 * (If path.argument_name is NULL it uses "path".)
854 *
855 * Output fields:
856 * path.wide
857 * Points to the path if it was expressed as Unicode
858 * and was not encoded. (Only used on Windows.)
859 * path.narrow
860 * Points to the path if it was expressed as bytes,
Steve Dowercc16be82016-09-08 10:35:16 -0700861 * or it was Unicode and was encoded to bytes. (On Windows,
Martin Panterb1321fb2016-10-10 00:38:21 +0000862 * is a non-zero integer if the path was expressed as bytes.
Steve Dowercc16be82016-09-08 10:35:16 -0700863 * The type is deliberately incompatible to prevent misuse.)
Larry Hastings9cf065c2012-06-22 16:30:09 -0700864 * path.fd
865 * Contains a file descriptor if path.accept_fd was true
866 * and the caller provided a signed integer instead of any
867 * sort of string.
868 *
869 * WARNING: if your "path" parameter is optional, and is
870 * unspecified, path_converter will never get called.
871 * So if you set allow_fd, you *MUST* initialize path.fd = -1
872 * yourself!
873 * path.length
874 * The length of the path in characters, if specified as
875 * a string.
876 * path.object
Xiang Zhang04316c42017-01-08 23:26:57 +0800877 * The original object passed in (if get a PathLike object,
878 * the result of PyOS_FSPath() is treated as the original object).
879 * Own a reference to the object.
Larry Hastings9cf065c2012-06-22 16:30:09 -0700880 * path.cleanup
881 * For internal use only. May point to a temporary object.
882 * (Pay no attention to the man behind the curtain.)
883 *
884 * At most one of path.wide or path.narrow will be non-NULL.
885 * If path was None and path.nullable was set,
886 * or if path was an integer and path.allow_fd was set,
887 * both path.wide and path.narrow will be NULL
888 * and path.length will be 0.
Georg Brandlf7875592012-06-24 13:58:31 +0200889 *
Larry Hastings9cf065c2012-06-22 16:30:09 -0700890 * path_converter takes care to not write to the path_t
891 * unless it's successful. However it must reset the
892 * "cleanup" field each time it's called.
893 *
894 * Use as follows:
895 * path_t path;
896 * memset(&path, 0, sizeof(path));
897 * PyArg_ParseTuple(args, "O&", path_converter, &path);
898 * // ... use values from path ...
899 * path_cleanup(&path);
900 *
901 * (Note that if PyArg_Parse fails you don't need to call
902 * path_cleanup(). However it is safe to do so.)
903 */
904typedef struct {
Victor Stinner292c8352012-10-30 02:17:38 +0100905 const char *function_name;
906 const char *argument_name;
Larry Hastings9cf065c2012-06-22 16:30:09 -0700907 int nullable;
908 int allow_fd;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +0300909 const wchar_t *wide;
Steve Dowercc16be82016-09-08 10:35:16 -0700910#ifdef MS_WINDOWS
911 BOOL narrow;
912#else
Serhiy Storchakadeab18d2016-05-07 16:45:18 +0300913 const char *narrow;
Steve Dowercc16be82016-09-08 10:35:16 -0700914#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -0700915 int fd;
916 Py_ssize_t length;
917 PyObject *object;
918 PyObject *cleanup;
919} path_t;
920
Steve Dowercc16be82016-09-08 10:35:16 -0700921#ifdef MS_WINDOWS
922#define PATH_T_INITIALIZE(function_name, argument_name, nullable, allow_fd) \
923 {function_name, argument_name, nullable, allow_fd, NULL, FALSE, -1, 0, NULL, NULL}
924#else
Larry Hastings2f936352014-08-05 14:04:04 +1000925#define PATH_T_INITIALIZE(function_name, argument_name, nullable, allow_fd) \
926 {function_name, argument_name, nullable, allow_fd, NULL, NULL, -1, 0, NULL, NULL}
Steve Dowercc16be82016-09-08 10:35:16 -0700927#endif
Larry Hastings31826802013-10-19 00:09:25 -0700928
Larry Hastings9cf065c2012-06-22 16:30:09 -0700929static void
Xiang Zhang04316c42017-01-08 23:26:57 +0800930path_cleanup(path_t *path)
931{
932 Py_CLEAR(path->object);
933 Py_CLEAR(path->cleanup);
Larry Hastings9cf065c2012-06-22 16:30:09 -0700934}
935
936static int
Serhiy Storchaka819399b2016-04-06 22:17:52 +0300937path_converter(PyObject *o, void *p)
938{
Larry Hastings9cf065c2012-06-22 16:30:09 -0700939 path_t *path = (path_t *)p;
Xiang Zhang04316c42017-01-08 23:26:57 +0800940 PyObject *bytes = NULL;
941 Py_ssize_t length = 0;
Brett Cannon3f9183b2016-08-26 14:44:48 -0700942 int is_index, is_buffer, is_bytes, is_unicode;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +0300943 const char *narrow;
Steve Dowercc16be82016-09-08 10:35:16 -0700944#ifdef MS_WINDOWS
Xiang Zhang04316c42017-01-08 23:26:57 +0800945 PyObject *wo = NULL;
Steve Dowercc16be82016-09-08 10:35:16 -0700946 const wchar_t *wide;
947#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -0700948
949#define FORMAT_EXCEPTION(exc, fmt) \
950 PyErr_Format(exc, "%s%s" fmt, \
951 path->function_name ? path->function_name : "", \
952 path->function_name ? ": " : "", \
953 path->argument_name ? path->argument_name : "path")
954
955 /* Py_CLEANUP_SUPPORTED support */
956 if (o == NULL) {
957 path_cleanup(path);
958 return 1;
959 }
960
Brett Cannon3f9183b2016-08-26 14:44:48 -0700961 /* Ensure it's always safe to call path_cleanup(). */
Xiang Zhang04316c42017-01-08 23:26:57 +0800962 path->object = path->cleanup = NULL;
963 /* path->object owns a reference to the original object */
964 Py_INCREF(o);
Larry Hastings9cf065c2012-06-22 16:30:09 -0700965
Serhiy Storchaka819399b2016-04-06 22:17:52 +0300966 if ((o == Py_None) && path->nullable) {
Larry Hastings9cf065c2012-06-22 16:30:09 -0700967 path->wide = NULL;
Steve Dowercc16be82016-09-08 10:35:16 -0700968#ifdef MS_WINDOWS
969 path->narrow = FALSE;
970#else
Larry Hastings9cf065c2012-06-22 16:30:09 -0700971 path->narrow = NULL;
Steve Dowercc16be82016-09-08 10:35:16 -0700972#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -0700973 path->fd = -1;
Xiang Zhang04316c42017-01-08 23:26:57 +0800974 goto success_exit;
Larry Hastings9cf065c2012-06-22 16:30:09 -0700975 }
976
Brett Cannon3f9183b2016-08-26 14:44:48 -0700977 /* Only call this here so that we don't treat the return value of
978 os.fspath() as an fd or buffer. */
979 is_index = path->allow_fd && PyIndex_Check(o);
980 is_buffer = PyObject_CheckBuffer(o);
981 is_bytes = PyBytes_Check(o);
982 is_unicode = PyUnicode_Check(o);
983
984 if (!is_index && !is_buffer && !is_unicode && !is_bytes) {
985 /* Inline PyOS_FSPath() for better error messages. */
986 _Py_IDENTIFIER(__fspath__);
Pablo Galindo09fbcd62019-02-18 10:46:34 +0000987 PyObject *func, *res;
Brett Cannon3f9183b2016-08-26 14:44:48 -0700988
989 func = _PyObject_LookupSpecial(o, &PyId___fspath__);
990 if (NULL == func) {
Xiang Zhang04316c42017-01-08 23:26:57 +0800991 goto error_format;
Brett Cannon3f9183b2016-08-26 14:44:48 -0700992 }
Pablo Galindo09fbcd62019-02-18 10:46:34 +0000993 res = _PyObject_CallNoArg(func);
Brett Cannon3f9183b2016-08-26 14:44:48 -0700994 Py_DECREF(func);
Pablo Galindo09fbcd62019-02-18 10:46:34 +0000995 if (NULL == res) {
Brett Cannon3f9183b2016-08-26 14:44:48 -0700996 goto error_exit;
997 }
Pablo Galindo09fbcd62019-02-18 10:46:34 +0000998 else if (PyUnicode_Check(res)) {
Brett Cannon3f9183b2016-08-26 14:44:48 -0700999 is_unicode = 1;
1000 }
Pablo Galindo09fbcd62019-02-18 10:46:34 +00001001 else if (PyBytes_Check(res)) {
Brett Cannon3f9183b2016-08-26 14:44:48 -07001002 is_bytes = 1;
1003 }
1004 else {
Pablo Galindo09fbcd62019-02-18 10:46:34 +00001005 PyErr_Format(PyExc_TypeError,
1006 "expected %.200s.__fspath__() to return str or bytes, "
1007 "not %.200s", Py_TYPE(o)->tp_name,
1008 Py_TYPE(res)->tp_name);
1009 Py_DECREF(res);
1010 goto error_exit;
Brett Cannon3f9183b2016-08-26 14:44:48 -07001011 }
Pablo Galindo09fbcd62019-02-18 10:46:34 +00001012
1013 /* still owns a reference to the original object */
1014 Py_DECREF(o);
1015 o = res;
Brett Cannon3f9183b2016-08-26 14:44:48 -07001016 }
1017
1018 if (is_unicode) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07001019#ifdef MS_WINDOWS
Victor Stinner26c03bd2016-09-19 11:55:44 +02001020 wide = PyUnicode_AsUnicodeAndSize(o, &length);
Victor Stinner59799a82013-11-13 14:17:30 +01001021 if (!wide) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001022 goto error_exit;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001023 }
Victor Stinner59799a82013-11-13 14:17:30 +01001024 if (length > 32767) {
1025 FORMAT_EXCEPTION(PyExc_ValueError, "%s too long for Windows");
Xiang Zhang04316c42017-01-08 23:26:57 +08001026 goto error_exit;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001027 }
Serhiy Storchaka2b0d2002015-04-20 09:53:58 +03001028 if (wcslen(wide) != length) {
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001029 FORMAT_EXCEPTION(PyExc_ValueError, "embedded null character in %s");
Xiang Zhang04316c42017-01-08 23:26:57 +08001030 goto error_exit;
Serhiy Storchaka2b0d2002015-04-20 09:53:58 +03001031 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07001032
1033 path->wide = wide;
Xiang Zhang04316c42017-01-08 23:26:57 +08001034 path->narrow = FALSE;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001035 path->fd = -1;
Xiang Zhang04316c42017-01-08 23:26:57 +08001036 goto success_exit;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001037#else
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001038 if (!PyUnicode_FSConverter(o, &bytes)) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001039 goto error_exit;
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001040 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07001041#endif
1042 }
Brett Cannon3f9183b2016-08-26 14:44:48 -07001043 else if (is_bytes) {
Serhiy Storchakad73c3182016-08-06 23:22:08 +03001044 bytes = o;
1045 Py_INCREF(bytes);
1046 }
Brett Cannon3f9183b2016-08-26 14:44:48 -07001047 else if (is_buffer) {
Serhiy Storchaka1180e5a2017-07-11 06:36:46 +03001048 /* XXX Replace PyObject_CheckBuffer with PyBytes_Check in other code
Ville Skyttä49b27342017-08-03 09:00:59 +03001049 after removing support of non-bytes buffer objects. */
Serhiy Storchakad73c3182016-08-06 23:22:08 +03001050 if (PyErr_WarnFormat(PyExc_DeprecationWarning, 1,
1051 "%s%s%s should be %s, not %.200s",
1052 path->function_name ? path->function_name : "",
1053 path->function_name ? ": " : "",
1054 path->argument_name ? path->argument_name : "path",
Brett Cannon3f9183b2016-08-26 14:44:48 -07001055 path->allow_fd && path->nullable ? "string, bytes, os.PathLike, "
1056 "integer or None" :
1057 path->allow_fd ? "string, bytes, os.PathLike or integer" :
1058 path->nullable ? "string, bytes, os.PathLike or None" :
1059 "string, bytes or os.PathLike",
Serhiy Storchakad73c3182016-08-06 23:22:08 +03001060 Py_TYPE(o)->tp_name)) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001061 goto error_exit;
Serhiy Storchakad73c3182016-08-06 23:22:08 +03001062 }
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001063 bytes = PyBytes_FromObject(o);
Larry Hastings9cf065c2012-06-22 16:30:09 -07001064 if (!bytes) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001065 goto error_exit;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001066 }
1067 }
Steve Dowercc16be82016-09-08 10:35:16 -07001068 else if (is_index) {
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001069 if (!_fd_converter(o, &path->fd)) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001070 goto error_exit;
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001071 }
1072 path->wide = NULL;
Steve Dowercc16be82016-09-08 10:35:16 -07001073#ifdef MS_WINDOWS
1074 path->narrow = FALSE;
1075#else
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001076 path->narrow = NULL;
Steve Dowercc16be82016-09-08 10:35:16 -07001077#endif
Xiang Zhang04316c42017-01-08 23:26:57 +08001078 goto success_exit;
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001079 }
1080 else {
Xiang Zhang04316c42017-01-08 23:26:57 +08001081 error_format:
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001082 PyErr_Format(PyExc_TypeError, "%s%s%s should be %s, not %.200s",
1083 path->function_name ? path->function_name : "",
1084 path->function_name ? ": " : "",
1085 path->argument_name ? path->argument_name : "path",
Brett Cannon3f9183b2016-08-26 14:44:48 -07001086 path->allow_fd && path->nullable ? "string, bytes, os.PathLike, "
1087 "integer or None" :
1088 path->allow_fd ? "string, bytes, os.PathLike or integer" :
1089 path->nullable ? "string, bytes, os.PathLike or None" :
1090 "string, bytes or os.PathLike",
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001091 Py_TYPE(o)->tp_name);
Xiang Zhang04316c42017-01-08 23:26:57 +08001092 goto error_exit;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001093 }
1094
Larry Hastings9cf065c2012-06-22 16:30:09 -07001095 length = PyBytes_GET_SIZE(bytes);
Larry Hastings9cf065c2012-06-22 16:30:09 -07001096 narrow = PyBytes_AS_STRING(bytes);
Victor Stinner706768c2014-08-16 01:03:39 +02001097 if ((size_t)length != strlen(narrow)) {
Serhiy Storchakad8a14472014-09-06 20:07:17 +03001098 FORMAT_EXCEPTION(PyExc_ValueError, "embedded null character in %s");
Xiang Zhang04316c42017-01-08 23:26:57 +08001099 goto error_exit;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001100 }
1101
Steve Dowercc16be82016-09-08 10:35:16 -07001102#ifdef MS_WINDOWS
1103 wo = PyUnicode_DecodeFSDefaultAndSize(
1104 narrow,
1105 length
1106 );
1107 if (!wo) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001108 goto error_exit;
Steve Dowercc16be82016-09-08 10:35:16 -07001109 }
1110
Xiang Zhang04316c42017-01-08 23:26:57 +08001111 wide = PyUnicode_AsUnicodeAndSize(wo, &length);
Steve Dowercc16be82016-09-08 10:35:16 -07001112 if (!wide) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001113 goto error_exit;
Steve Dowercc16be82016-09-08 10:35:16 -07001114 }
1115 if (length > 32767) {
1116 FORMAT_EXCEPTION(PyExc_ValueError, "%s too long for Windows");
Xiang Zhang04316c42017-01-08 23:26:57 +08001117 goto error_exit;
Steve Dowercc16be82016-09-08 10:35:16 -07001118 }
1119 if (wcslen(wide) != length) {
1120 FORMAT_EXCEPTION(PyExc_ValueError, "embedded null character in %s");
Xiang Zhang04316c42017-01-08 23:26:57 +08001121 goto error_exit;
Steve Dowercc16be82016-09-08 10:35:16 -07001122 }
1123 path->wide = wide;
1124 path->narrow = TRUE;
Xiang Zhang04316c42017-01-08 23:26:57 +08001125 path->cleanup = wo;
1126 Py_DECREF(bytes);
Steve Dowercc16be82016-09-08 10:35:16 -07001127#else
Larry Hastings9cf065c2012-06-22 16:30:09 -07001128 path->wide = NULL;
1129 path->narrow = narrow;
Serhiy Storchakad73c3182016-08-06 23:22:08 +03001130 if (bytes == o) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001131 /* Still a reference owned by path->object, don't have to
1132 worry about path->narrow is used after free. */
Serhiy Storchakad73c3182016-08-06 23:22:08 +03001133 Py_DECREF(bytes);
Serhiy Storchakad73c3182016-08-06 23:22:08 +03001134 }
1135 else {
1136 path->cleanup = bytes;
Serhiy Storchakad73c3182016-08-06 23:22:08 +03001137 }
Xiang Zhang04316c42017-01-08 23:26:57 +08001138#endif
1139 path->fd = -1;
1140
1141 success_exit:
1142 path->length = length;
1143 path->object = o;
1144 return Py_CLEANUP_SUPPORTED;
1145
1146 error_exit:
1147 Py_XDECREF(o);
1148 Py_XDECREF(bytes);
1149#ifdef MS_WINDOWS
1150 Py_XDECREF(wo);
1151#endif
1152 return 0;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001153}
1154
1155static void
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001156argument_unavailable_error(const char *function_name, const char *argument_name)
1157{
Larry Hastings9cf065c2012-06-22 16:30:09 -07001158 PyErr_Format(PyExc_NotImplementedError,
1159 "%s%s%s unavailable on this platform",
1160 (function_name != NULL) ? function_name : "",
1161 (function_name != NULL) ? ": ": "",
1162 argument_name);
1163}
1164
1165static int
Serhiy Storchakaa2ad5c32013-01-07 23:13:46 +02001166dir_fd_unavailable(PyObject *o, void *p)
1167{
1168 int dir_fd;
1169 if (!dir_fd_converter(o, &dir_fd))
Larry Hastings9cf065c2012-06-22 16:30:09 -07001170 return 0;
Serhiy Storchakaa2ad5c32013-01-07 23:13:46 +02001171 if (dir_fd != DEFAULT_DIR_FD) {
1172 argument_unavailable_error(NULL, "dir_fd");
1173 return 0;
1174 }
1175 *(int *)p = dir_fd;
1176 return 1;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001177}
1178
1179static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001180fd_specified(const char *function_name, int fd)
1181{
Larry Hastings9cf065c2012-06-22 16:30:09 -07001182 if (fd == -1)
1183 return 0;
1184
1185 argument_unavailable_error(function_name, "fd");
1186 return 1;
1187}
1188
1189static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001190follow_symlinks_specified(const char *function_name, int follow_symlinks)
1191{
Larry Hastings9cf065c2012-06-22 16:30:09 -07001192 if (follow_symlinks)
1193 return 0;
1194
1195 argument_unavailable_error(function_name, "follow_symlinks");
1196 return 1;
1197}
1198
1199static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001200path_and_dir_fd_invalid(const char *function_name, path_t *path, int dir_fd)
1201{
Steve Dowercc16be82016-09-08 10:35:16 -07001202 if (!path->wide && (dir_fd != DEFAULT_DIR_FD)
1203#ifndef MS_WINDOWS
1204 && !path->narrow
1205#endif
1206 ) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07001207 PyErr_Format(PyExc_ValueError,
1208 "%s: can't specify dir_fd without matching path",
1209 function_name);
1210 return 1;
1211 }
1212 return 0;
1213}
1214
1215static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001216dir_fd_and_fd_invalid(const char *function_name, int dir_fd, int fd)
1217{
Larry Hastings9cf065c2012-06-22 16:30:09 -07001218 if ((dir_fd != DEFAULT_DIR_FD) && (fd != -1)) {
1219 PyErr_Format(PyExc_ValueError,
1220 "%s: can't specify both dir_fd and fd",
1221 function_name);
1222 return 1;
1223 }
1224 return 0;
1225}
1226
1227static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001228fd_and_follow_symlinks_invalid(const char *function_name, int fd,
1229 int follow_symlinks)
1230{
Larry Hastings9cf065c2012-06-22 16:30:09 -07001231 if ((fd > 0) && (!follow_symlinks)) {
1232 PyErr_Format(PyExc_ValueError,
1233 "%s: cannot use fd and follow_symlinks together",
1234 function_name);
1235 return 1;
1236 }
1237 return 0;
1238}
1239
1240static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001241dir_fd_and_follow_symlinks_invalid(const char *function_name, int dir_fd,
1242 int follow_symlinks)
1243{
Larry Hastings9cf065c2012-06-22 16:30:09 -07001244 if ((dir_fd != DEFAULT_DIR_FD) && (!follow_symlinks)) {
1245 PyErr_Format(PyExc_ValueError,
1246 "%s: cannot use dir_fd and follow_symlinks together",
1247 function_name);
1248 return 1;
1249 }
1250 return 0;
1251}
1252
Larry Hastings2f936352014-08-05 14:04:04 +10001253#ifdef MS_WINDOWS
Benjamin Petersonaf580df2016-09-06 10:46:49 -07001254 typedef long long Py_off_t;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00001255#else
Larry Hastings2f936352014-08-05 14:04:04 +10001256 typedef off_t Py_off_t;
1257#endif
1258
1259static int
1260Py_off_t_converter(PyObject *arg, void *addr)
1261{
1262#ifdef HAVE_LARGEFILE_SUPPORT
1263 *((Py_off_t *)addr) = PyLong_AsLongLong(arg);
1264#else
1265 *((Py_off_t *)addr) = PyLong_AsLong(arg);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00001266#endif
1267 if (PyErr_Occurred())
1268 return 0;
1269 return 1;
1270}
Larry Hastings2f936352014-08-05 14:04:04 +10001271
1272static PyObject *
1273PyLong_FromPy_off_t(Py_off_t offset)
1274{
1275#ifdef HAVE_LARGEFILE_SUPPORT
1276 return PyLong_FromLongLong(offset);
1277#else
1278 return PyLong_FromLong(offset);
Ross Lagerwallb1e5d592011-09-19 08:30:43 +02001279#endif
Larry Hastings2f936352014-08-05 14:04:04 +10001280}
1281
Serhiy Storchakad54cfb12018-05-08 07:48:50 +03001282#ifdef HAVE_SIGSET_T
1283/* Convert an iterable of integers to a sigset.
1284 Return 1 on success, return 0 and raise an exception on error. */
1285int
1286_Py_Sigset_Converter(PyObject *obj, void *addr)
1287{
1288 sigset_t *mask = (sigset_t *)addr;
1289 PyObject *iterator, *item;
1290 long signum;
1291 int overflow;
1292
Rémi Lapeyref0900192019-05-04 01:30:53 +02001293 // The extra parens suppress the unreachable-code warning with clang on MacOS
1294 if (sigemptyset(mask) < (0)) {
Serhiy Storchakad54cfb12018-05-08 07:48:50 +03001295 /* Probably only if mask == NULL. */
1296 PyErr_SetFromErrno(PyExc_OSError);
1297 return 0;
1298 }
1299
1300 iterator = PyObject_GetIter(obj);
1301 if (iterator == NULL) {
1302 return 0;
1303 }
1304
1305 while ((item = PyIter_Next(iterator)) != NULL) {
1306 signum = PyLong_AsLongAndOverflow(item, &overflow);
1307 Py_DECREF(item);
1308 if (signum <= 0 || signum >= NSIG) {
1309 if (overflow || signum != -1 || !PyErr_Occurred()) {
1310 PyErr_Format(PyExc_ValueError,
1311 "signal number %ld out of range", signum);
1312 }
1313 goto error;
1314 }
1315 if (sigaddset(mask, (int)signum)) {
1316 if (errno != EINVAL) {
1317 /* Probably impossible */
1318 PyErr_SetFromErrno(PyExc_OSError);
1319 goto error;
1320 }
1321 /* For backwards compatibility, allow idioms such as
1322 * `range(1, NSIG)` but warn about invalid signal numbers
1323 */
1324 const char msg[] =
1325 "invalid signal number %ld, please use valid_signals()";
1326 if (PyErr_WarnFormat(PyExc_RuntimeWarning, 1, msg, signum)) {
1327 goto error;
1328 }
1329 }
1330 }
1331 if (!PyErr_Occurred()) {
1332 Py_DECREF(iterator);
1333 return 1;
1334 }
1335
1336error:
1337 Py_DECREF(iterator);
1338 return 0;
1339}
1340#endif /* HAVE_SIGSET_T */
1341
Brian Curtinfc1be6d2010-11-24 13:23:18 +00001342#ifdef MS_WINDOWS
Brian Curtinf5e76d02010-11-24 13:14:05 +00001343
1344static int
Brian Curtind25aef52011-06-13 15:16:04 -05001345win32_get_reparse_tag(HANDLE reparse_point_handle, ULONG *reparse_tag)
Brian Curtinf5e76d02010-11-24 13:14:05 +00001346{
Martin Panter70214ad2016-08-04 02:38:59 +00001347 char target_buffer[_Py_MAXIMUM_REPARSE_DATA_BUFFER_SIZE];
1348 _Py_REPARSE_DATA_BUFFER *rdb = (_Py_REPARSE_DATA_BUFFER *)target_buffer;
Brian Curtinf5e76d02010-11-24 13:14:05 +00001349 DWORD n_bytes_returned;
Brian Curtinf5e76d02010-11-24 13:14:05 +00001350
1351 if (0 == DeviceIoControl(
1352 reparse_point_handle,
1353 FSCTL_GET_REPARSE_POINT,
1354 NULL, 0, /* in buffer */
1355 target_buffer, sizeof(target_buffer),
1356 &n_bytes_returned,
1357 NULL)) /* we're not using OVERLAPPED_IO */
Brian Curtind25aef52011-06-13 15:16:04 -05001358 return FALSE;
Brian Curtinf5e76d02010-11-24 13:14:05 +00001359
1360 if (reparse_tag)
1361 *reparse_tag = rdb->ReparseTag;
1362
Brian Curtind25aef52011-06-13 15:16:04 -05001363 return TRUE;
Brian Curtinf5e76d02010-11-24 13:14:05 +00001364}
Victor Stinner1ab6c2d2011-11-15 22:27:41 +01001365
Brian Curtinfc1be6d2010-11-24 13:23:18 +00001366#endif /* MS_WINDOWS */
Brian Curtinf5e76d02010-11-24 13:14:05 +00001367
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001368/* Return a dictionary corresponding to the POSIX environment table */
Ronald Oussoren697e56d2013-01-25 17:57:13 +01001369#if defined(WITH_NEXT_FRAMEWORK) || (defined(__APPLE__) && defined(Py_ENABLE_SHARED))
Jack Jansenea0c3822002-08-01 21:57:49 +00001370/* On Darwin/MacOSX a shared library or framework has no access to
Ronald Oussoren697e56d2013-01-25 17:57:13 +01001371** environ directly, we must obtain it with _NSGetEnviron(). See also
1372** man environ(7).
Jack Jansenea0c3822002-08-01 21:57:49 +00001373*/
1374#include <crt_externs.h>
pxinwrf2d7ac72019-05-21 18:46:37 +08001375#elif !defined(_MSC_VER) && (!defined(__WATCOMC__) || defined(__QNX__) || defined(__VXWORKS__))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001376extern char **environ;
Guido van Rossuma4916fa1996-05-23 22:58:55 +00001377#endif /* !_MSC_VER */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001378
Barry Warsaw53699e91996-12-10 23:23:01 +00001379static PyObject *
Thomas Woutersf3f33dc2000-07-21 06:00:07 +00001380convertenviron(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001381{
Victor Stinner8c62be82010-05-06 00:08:46 +00001382 PyObject *d;
Thomas Hellerf78f12a2007-11-08 19:33:05 +00001383#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00001384 wchar_t **e;
Thomas Hellerf78f12a2007-11-08 19:33:05 +00001385#else
Victor Stinner8c62be82010-05-06 00:08:46 +00001386 char **e;
Thomas Hellerf78f12a2007-11-08 19:33:05 +00001387#endif
Guido van Rossumd48f2521997-12-05 22:19:34 +00001388
Victor Stinner8c62be82010-05-06 00:08:46 +00001389 d = PyDict_New();
1390 if (d == NULL)
1391 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00001392#ifdef MS_WINDOWS
1393 /* _wenviron must be initialized in this way if the program is started
1394 through main() instead of wmain(). */
1395 _wgetenv(L"");
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001396 e = _wenviron;
Miss Islington (bot)836cf312019-12-06 11:32:33 -08001397#elif defined(WITH_NEXT_FRAMEWORK) || (defined(__APPLE__) && defined(Py_ENABLE_SHARED))
1398 /* environ is not accessible as an extern in a shared object on OSX; use
1399 _NSGetEnviron to resolve it. The value changes if you add environment
1400 variables between calls to Py_Initialize, so don't cache the value. */
1401 e = *_NSGetEnviron();
Victor Stinner8c62be82010-05-06 00:08:46 +00001402#else
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001403 e = environ;
1404#endif
1405 if (e == NULL)
Victor Stinner8c62be82010-05-06 00:08:46 +00001406 return d;
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001407 for (; *e != NULL; e++) {
Victor Stinner8c62be82010-05-06 00:08:46 +00001408 PyObject *k;
1409 PyObject *v;
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001410#ifdef MS_WINDOWS
1411 const wchar_t *p = wcschr(*e, L'=');
1412#else
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03001413 const char *p = strchr(*e, '=');
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001414#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00001415 if (p == NULL)
1416 continue;
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001417#ifdef MS_WINDOWS
1418 k = PyUnicode_FromWideChar(*e, (Py_ssize_t)(p-*e));
1419#else
Victor Stinner84ae1182010-05-06 22:05:07 +00001420 k = PyBytes_FromStringAndSize(*e, (int)(p-*e));
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001421#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00001422 if (k == NULL) {
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001423 Py_DECREF(d);
1424 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00001425 }
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001426#ifdef MS_WINDOWS
1427 v = PyUnicode_FromWideChar(p+1, wcslen(p+1));
1428#else
Victor Stinner84ae1182010-05-06 22:05:07 +00001429 v = PyBytes_FromStringAndSize(p+1, strlen(p+1));
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001430#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00001431 if (v == NULL) {
Victor Stinner8c62be82010-05-06 00:08:46 +00001432 Py_DECREF(k);
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001433 Py_DECREF(d);
1434 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00001435 }
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001436 if (PyDict_GetItemWithError(d, k) == NULL) {
1437 if (PyErr_Occurred() || PyDict_SetItem(d, k, v) != 0) {
1438 Py_DECREF(v);
1439 Py_DECREF(k);
1440 Py_DECREF(d);
1441 return NULL;
1442 }
Victor Stinner8c62be82010-05-06 00:08:46 +00001443 }
1444 Py_DECREF(k);
1445 Py_DECREF(v);
Guido van Rossumd48f2521997-12-05 22:19:34 +00001446 }
Victor Stinner8c62be82010-05-06 00:08:46 +00001447 return d;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001448}
1449
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001450/* Set a POSIX-specific error from errno, and return NULL */
1451
Barry Warsawd58d7641998-07-23 16:14:40 +00001452static PyObject *
Thomas Woutersf3f33dc2000-07-21 06:00:07 +00001453posix_error(void)
Guido van Rossumad0ee831995-03-01 10:34:45 +00001454{
Victor Stinner8c62be82010-05-06 00:08:46 +00001455 return PyErr_SetFromErrno(PyExc_OSError);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001456}
Mark Hammondef8b6542001-05-13 08:04:26 +00001457
Martin v. Löwis6238d2b2002-06-30 15:26:10 +00001458#ifdef MS_WINDOWS
Fredrik Lundhffb9c772000-07-09 14:49:51 +00001459static PyObject *
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001460win32_error(const char* function, const char* filename)
Fredrik Lundhffb9c772000-07-09 14:49:51 +00001461{
Victor Stinner8c62be82010-05-06 00:08:46 +00001462 /* XXX We should pass the function name along in the future.
1463 (winreg.c also wants to pass the function name.)
1464 This would however require an additional param to the
1465 Windows error object, which is non-trivial.
1466 */
1467 errno = GetLastError();
1468 if (filename)
1469 return PyErr_SetFromWindowsErrWithFilename(errno, filename);
1470 else
1471 return PyErr_SetFromWindowsErr(errno);
Fredrik Lundhffb9c772000-07-09 14:49:51 +00001472}
Mark Hammondc2e85bd2002-10-03 05:10:39 +00001473
Mark Hammondc2e85bd2002-10-03 05:10:39 +00001474static PyObject *
Steve Dower2438cdf2019-03-29 16:37:16 -07001475win32_error_object_err(const char* function, PyObject* filename, DWORD err)
Victor Stinnereb5657a2011-09-30 01:44:27 +02001476{
1477 /* XXX - see win32_error for comments on 'function' */
Victor Stinnereb5657a2011-09-30 01:44:27 +02001478 if (filename)
1479 return PyErr_SetExcFromWindowsErrWithFilenameObject(
Andrew Svetlov2606a6f2012-12-19 14:33:35 +02001480 PyExc_OSError,
Steve Dower2438cdf2019-03-29 16:37:16 -07001481 err,
Victor Stinnereb5657a2011-09-30 01:44:27 +02001482 filename);
1483 else
Steve Dower2438cdf2019-03-29 16:37:16 -07001484 return PyErr_SetFromWindowsErr(err);
1485}
1486
1487static PyObject *
1488win32_error_object(const char* function, PyObject* filename)
1489{
1490 errno = GetLastError();
1491 return win32_error_object_err(function, filename, errno);
Victor Stinnereb5657a2011-09-30 01:44:27 +02001492}
1493
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00001494#endif /* MS_WINDOWS */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001495
Larry Hastings9cf065c2012-06-22 16:30:09 -07001496static PyObject *
Alexey Izbyshev83460312018-10-20 03:28:22 +03001497posix_path_object_error(PyObject *path)
1498{
1499 return PyErr_SetFromErrnoWithFilenameObject(PyExc_OSError, path);
1500}
1501
1502static PyObject *
Serhiy Storchaka2674bc72016-10-08 20:16:57 +03001503path_object_error(PyObject *path)
Larry Hastings9cf065c2012-06-22 16:30:09 -07001504{
1505#ifdef MS_WINDOWS
Serhiy Storchaka2674bc72016-10-08 20:16:57 +03001506 return PyErr_SetExcFromWindowsErrWithFilenameObject(
1507 PyExc_OSError, 0, path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07001508#else
Alexey Izbyshev83460312018-10-20 03:28:22 +03001509 return posix_path_object_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07001510#endif
1511}
1512
Serhiy Storchaka2674bc72016-10-08 20:16:57 +03001513static PyObject *
1514path_object_error2(PyObject *path, PyObject *path2)
1515{
1516#ifdef MS_WINDOWS
1517 return PyErr_SetExcFromWindowsErrWithFilenameObjects(
1518 PyExc_OSError, 0, path, path2);
1519#else
1520 return PyErr_SetFromErrnoWithFilenameObjects(PyExc_OSError, path, path2);
1521#endif
1522}
1523
1524static PyObject *
1525path_error(path_t *path)
1526{
1527 return path_object_error(path->object);
1528}
Larry Hastings31826802013-10-19 00:09:25 -07001529
Larry Hastingsb0827312014-02-09 22:05:19 -08001530static PyObject *
Alexey Izbyshev83460312018-10-20 03:28:22 +03001531posix_path_error(path_t *path)
1532{
1533 return posix_path_object_error(path->object);
1534}
1535
1536static PyObject *
Larry Hastingsb0827312014-02-09 22:05:19 -08001537path_error2(path_t *path, path_t *path2)
1538{
Serhiy Storchaka2674bc72016-10-08 20:16:57 +03001539 return path_object_error2(path->object, path2->object);
Larry Hastingsb0827312014-02-09 22:05:19 -08001540}
1541
1542
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001543/* POSIX generic methods */
1544
Larry Hastings2f936352014-08-05 14:04:04 +10001545static int
1546fildes_converter(PyObject *o, void *p)
Fred Drake4d1e64b2002-04-15 19:40:07 +00001547{
Victor Stinner8c62be82010-05-06 00:08:46 +00001548 int fd;
Larry Hastings2f936352014-08-05 14:04:04 +10001549 int *pointer = (int *)p;
1550 fd = PyObject_AsFileDescriptor(o);
Victor Stinner8c62be82010-05-06 00:08:46 +00001551 if (fd < 0)
Larry Hastings2f936352014-08-05 14:04:04 +10001552 return 0;
Larry Hastings2f936352014-08-05 14:04:04 +10001553 *pointer = fd;
1554 return 1;
1555}
1556
1557static PyObject *
1558posix_fildes_fd(int fd, int (*func)(int))
1559{
1560 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00001561 int async_err = 0;
1562
1563 do {
1564 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04001565 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00001566 res = (*func)(fd);
Steve Dower8fc89802015-04-12 00:26:27 -04001567 _Py_END_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00001568 Py_END_ALLOW_THREADS
1569 } while (res != 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
1570 if (res != 0)
1571 return (!async_err) ? posix_error() : NULL;
1572 Py_RETURN_NONE;
Fred Drake4d1e64b2002-04-15 19:40:07 +00001573}
Guido van Rossum21142a01999-01-08 21:05:37 +00001574
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001575
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00001576#ifdef MS_WINDOWS
Thomas Wouters477c8d52006-05-27 19:21:47 +00001577/* This is a reimplementation of the C library's chdir function,
1578 but one that produces Win32 errors instead of DOS error codes.
1579 chdir is essentially a wrapper around SetCurrentDirectory; however,
1580 it also needs to set "magic" environment variables indicating
1581 the per-drive current directory, which are of the form =<drive>: */
Benjamin Peterson206e3072008-10-19 14:07:49 +00001582static BOOL __stdcall
Thomas Wouters477c8d52006-05-27 19:21:47 +00001583win32_wchdir(LPCWSTR path)
1584{
Victor Stinnered537822015-12-13 21:40:26 +01001585 wchar_t path_buf[MAX_PATH], *new_path = path_buf;
Victor Stinner8c62be82010-05-06 00:08:46 +00001586 int result;
1587 wchar_t env[4] = L"=x:";
Thomas Wouters477c8d52006-05-27 19:21:47 +00001588
Victor Stinner8c62be82010-05-06 00:08:46 +00001589 if(!SetCurrentDirectoryW(path))
1590 return FALSE;
Victor Stinnered537822015-12-13 21:40:26 +01001591 result = GetCurrentDirectoryW(Py_ARRAY_LENGTH(path_buf), new_path);
Victor Stinner8c62be82010-05-06 00:08:46 +00001592 if (!result)
1593 return FALSE;
Victor Stinnere847d712015-12-14 00:21:50 +01001594 if (result > Py_ARRAY_LENGTH(path_buf)) {
Victor Stinnerb6404912013-07-07 16:21:41 +02001595 new_path = PyMem_RawMalloc(result * sizeof(wchar_t));
Victor Stinner8c62be82010-05-06 00:08:46 +00001596 if (!new_path) {
1597 SetLastError(ERROR_OUTOFMEMORY);
1598 return FALSE;
1599 }
1600 result = GetCurrentDirectoryW(result, new_path);
1601 if (!result) {
Victor Stinnerb6404912013-07-07 16:21:41 +02001602 PyMem_RawFree(new_path);
Victor Stinner8c62be82010-05-06 00:08:46 +00001603 return FALSE;
1604 }
1605 }
Alexey Izbyshev3e197c72018-03-01 12:13:56 +03001606 int is_unc_like_path = (wcsncmp(new_path, L"\\\\", 2) == 0 ||
1607 wcsncmp(new_path, L"//", 2) == 0);
1608 if (!is_unc_like_path) {
1609 env[1] = new_path[0];
1610 result = SetEnvironmentVariableW(env, new_path);
1611 }
Victor Stinnered537822015-12-13 21:40:26 +01001612 if (new_path != path_buf)
Victor Stinnerb6404912013-07-07 16:21:41 +02001613 PyMem_RawFree(new_path);
Alexey Izbyshev3e197c72018-03-01 12:13:56 +03001614 return result ? TRUE : FALSE;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001615}
1616#endif
1617
Martin v. Löwis14694662006-02-03 12:54:16 +00001618#ifdef MS_WINDOWS
1619/* The CRT of Windows has a number of flaws wrt. its stat() implementation:
1620 - time stamps are restricted to second resolution
1621 - file modification times suffer from forth-and-back conversions between
1622 UTC and local time
1623 Therefore, we implement our own stat, based on the Win32 API directly.
1624*/
Victor Stinner8c62be82010-05-06 00:08:46 +00001625#define HAVE_STAT_NSEC 1
Zachary Ware63f277b2014-06-19 09:46:37 -05001626#define HAVE_STRUCT_STAT_ST_FILE_ATTRIBUTES 1
Steve Dower9eb3d542019-08-21 15:52:42 -07001627#define HAVE_STRUCT_STAT_ST_REPARSE_TAG 1
Martin v. Löwis14694662006-02-03 12:54:16 +00001628
Victor Stinner6036e442015-03-08 01:58:04 +01001629static void
Steve Dowercc16be82016-09-08 10:35:16 -07001630find_data_to_file_info(WIN32_FIND_DATAW *pFileData,
1631 BY_HANDLE_FILE_INFORMATION *info,
1632 ULONG *reparse_tag)
Victor Stinner6036e442015-03-08 01:58:04 +01001633{
1634 memset(info, 0, sizeof(*info));
1635 info->dwFileAttributes = pFileData->dwFileAttributes;
1636 info->ftCreationTime = pFileData->ftCreationTime;
1637 info->ftLastAccessTime = pFileData->ftLastAccessTime;
1638 info->ftLastWriteTime = pFileData->ftLastWriteTime;
1639 info->nFileSizeHigh = pFileData->nFileSizeHigh;
1640 info->nFileSizeLow = pFileData->nFileSizeLow;
1641/* info->nNumberOfLinks = 1; */
1642 if (pFileData->dwFileAttributes & FILE_ATTRIBUTE_REPARSE_POINT)
1643 *reparse_tag = pFileData->dwReserved0;
1644 else
1645 *reparse_tag = 0;
1646}
1647
Guido van Rossumd8faa362007-04-27 19:54:29 +00001648static BOOL
Steve Dowercc16be82016-09-08 10:35:16 -07001649attributes_from_dir(LPCWSTR pszFile, BY_HANDLE_FILE_INFORMATION *info, ULONG *reparse_tag)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001650{
Victor Stinner8c62be82010-05-06 00:08:46 +00001651 HANDLE hFindFile;
1652 WIN32_FIND_DATAW FileData;
1653 hFindFile = FindFirstFileW(pszFile, &FileData);
1654 if (hFindFile == INVALID_HANDLE_VALUE)
1655 return FALSE;
1656 FindClose(hFindFile);
Steve Dowercc16be82016-09-08 10:35:16 -07001657 find_data_to_file_info(&FileData, info, reparse_tag);
Victor Stinner8c62be82010-05-06 00:08:46 +00001658 return TRUE;
Guido van Rossumd8faa362007-04-27 19:54:29 +00001659}
1660
Brian Curtind25aef52011-06-13 15:16:04 -05001661static int
Steve Dowercc16be82016-09-08 10:35:16 -07001662win32_xstat_impl(const wchar_t *path, struct _Py_stat_struct *result,
Brian Curtind25aef52011-06-13 15:16:04 -05001663 BOOL traverse)
1664{
Steve Dower9eb3d542019-08-21 15:52:42 -07001665 HANDLE hFile;
1666 BY_HANDLE_FILE_INFORMATION fileInfo;
1667 FILE_ATTRIBUTE_TAG_INFO tagInfo = { 0 };
1668 DWORD fileType, error;
1669 BOOL isUnhandledTag = FALSE;
1670 int retval = 0;
Brian Curtinf5e76d02010-11-24 13:14:05 +00001671
Steve Dower9eb3d542019-08-21 15:52:42 -07001672 DWORD access = FILE_READ_ATTRIBUTES;
1673 DWORD flags = FILE_FLAG_BACKUP_SEMANTICS; /* Allow opening directories. */
1674 if (!traverse) {
1675 flags |= FILE_FLAG_OPEN_REPARSE_POINT;
1676 }
Brian Curtinf5e76d02010-11-24 13:14:05 +00001677
Steve Dower9eb3d542019-08-21 15:52:42 -07001678 hFile = CreateFileW(path, access, 0, NULL, OPEN_EXISTING, flags, NULL);
Hirokazu Yamamoto427d3142010-12-04 10:16:05 +00001679 if (hFile == INVALID_HANDLE_VALUE) {
Steve Dower9eb3d542019-08-21 15:52:42 -07001680 /* Either the path doesn't exist, or the caller lacks access. */
1681 error = GetLastError();
1682 switch (error) {
1683 case ERROR_ACCESS_DENIED: /* Cannot sync or read attributes. */
1684 case ERROR_SHARING_VIOLATION: /* It's a paging file. */
1685 /* Try reading the parent directory. */
1686 if (!attributes_from_dir(path, &fileInfo, &tagInfo.ReparseTag)) {
1687 /* Cannot read the parent directory. */
1688 SetLastError(error);
Hirokazu Yamamoto427d3142010-12-04 10:16:05 +00001689 return -1;
Brian Curtinf5e76d02010-11-24 13:14:05 +00001690 }
Steve Dower9eb3d542019-08-21 15:52:42 -07001691 if (fileInfo.dwFileAttributes & FILE_ATTRIBUTE_REPARSE_POINT) {
1692 if (traverse ||
1693 !IsReparseTagNameSurrogate(tagInfo.ReparseTag)) {
1694 /* The stat call has to traverse but cannot, so fail. */
1695 SetLastError(error);
Brian Curtind25aef52011-06-13 15:16:04 -05001696 return -1;
Mark Becwarb82bfac2019-02-02 16:08:23 -05001697 }
Hirokazu Yamamoto427d3142010-12-04 10:16:05 +00001698 }
Steve Dower9eb3d542019-08-21 15:52:42 -07001699 break;
Brian Curtinf5e76d02010-11-24 13:14:05 +00001700
Steve Dower9eb3d542019-08-21 15:52:42 -07001701 case ERROR_INVALID_PARAMETER:
1702 /* \\.\con requires read or write access. */
1703 hFile = CreateFileW(path, access | GENERIC_READ,
1704 FILE_SHARE_READ | FILE_SHARE_WRITE, NULL,
1705 OPEN_EXISTING, flags, NULL);
1706 if (hFile == INVALID_HANDLE_VALUE) {
1707 SetLastError(error);
1708 return -1;
1709 }
1710 break;
1711
1712 case ERROR_CANT_ACCESS_FILE:
1713 /* bpo37834: open unhandled reparse points if traverse fails. */
1714 if (traverse) {
1715 traverse = FALSE;
1716 isUnhandledTag = TRUE;
1717 hFile = CreateFileW(path, access, 0, NULL, OPEN_EXISTING,
1718 flags | FILE_FLAG_OPEN_REPARSE_POINT, NULL);
1719 }
1720 if (hFile == INVALID_HANDLE_VALUE) {
1721 SetLastError(error);
1722 return -1;
1723 }
1724 break;
1725
1726 default:
1727 return -1;
1728 }
Brian Curtinf5e76d02010-11-24 13:14:05 +00001729 }
Steve Dower9eb3d542019-08-21 15:52:42 -07001730
1731 if (hFile != INVALID_HANDLE_VALUE) {
1732 /* Handle types other than files on disk. */
1733 fileType = GetFileType(hFile);
1734 if (fileType != FILE_TYPE_DISK) {
1735 if (fileType == FILE_TYPE_UNKNOWN && GetLastError() != 0) {
1736 retval = -1;
1737 goto cleanup;
1738 }
1739 DWORD fileAttributes = GetFileAttributesW(path);
1740 memset(result, 0, sizeof(*result));
1741 if (fileAttributes != INVALID_FILE_ATTRIBUTES &&
1742 fileAttributes & FILE_ATTRIBUTE_DIRECTORY) {
1743 /* \\.\pipe\ or \\.\mailslot\ */
1744 result->st_mode = _S_IFDIR;
1745 } else if (fileType == FILE_TYPE_CHAR) {
1746 /* \\.\nul */
1747 result->st_mode = _S_IFCHR;
1748 } else if (fileType == FILE_TYPE_PIPE) {
1749 /* \\.\pipe\spam */
1750 result->st_mode = _S_IFIFO;
1751 }
1752 /* FILE_TYPE_UNKNOWN, e.g. \\.\mailslot\waitfor.exe\spam */
1753 goto cleanup;
1754 }
1755
1756 /* Query the reparse tag, and traverse a non-link. */
1757 if (!traverse) {
1758 if (!GetFileInformationByHandleEx(hFile, FileAttributeTagInfo,
1759 &tagInfo, sizeof(tagInfo))) {
1760 /* Allow devices that do not support FileAttributeTagInfo. */
1761 switch (GetLastError()) {
1762 case ERROR_INVALID_PARAMETER:
1763 case ERROR_INVALID_FUNCTION:
1764 case ERROR_NOT_SUPPORTED:
1765 tagInfo.FileAttributes = FILE_ATTRIBUTE_NORMAL;
1766 tagInfo.ReparseTag = 0;
1767 break;
1768 default:
1769 retval = -1;
1770 goto cleanup;
1771 }
1772 } else if (tagInfo.FileAttributes &
1773 FILE_ATTRIBUTE_REPARSE_POINT) {
1774 if (IsReparseTagNameSurrogate(tagInfo.ReparseTag)) {
1775 if (isUnhandledTag) {
1776 /* Traversing previously failed for either this link
1777 or its target. */
1778 SetLastError(ERROR_CANT_ACCESS_FILE);
1779 retval = -1;
1780 goto cleanup;
1781 }
1782 /* Traverse a non-link, but not if traversing already failed
1783 for an unhandled tag. */
1784 } else if (!isUnhandledTag) {
1785 CloseHandle(hFile);
1786 return win32_xstat_impl(path, result, TRUE);
1787 }
1788 }
1789 }
1790
1791 if (!GetFileInformationByHandle(hFile, &fileInfo)) {
1792 switch (GetLastError()) {
1793 case ERROR_INVALID_PARAMETER:
1794 case ERROR_INVALID_FUNCTION:
1795 case ERROR_NOT_SUPPORTED:
Miss Islington (bot)cad7abf2019-09-04 15:18:05 -07001796 /* Volumes and physical disks are block devices, e.g.
1797 \\.\C: and \\.\PhysicalDrive0. */
1798 memset(result, 0, sizeof(*result));
1799 result->st_mode = 0x6000; /* S_IFBLK */
Steve Dower9eb3d542019-08-21 15:52:42 -07001800 goto cleanup;
1801 }
Miss Islington (bot)cad7abf2019-09-04 15:18:05 -07001802 retval = -1;
Steve Dower9eb3d542019-08-21 15:52:42 -07001803 goto cleanup;
1804 }
1805 }
1806
1807 _Py_attribute_data_to_stat(&fileInfo, tagInfo.ReparseTag, result);
1808
1809 if (!(fileInfo.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)) {
1810 /* Fix the file execute permissions. This hack sets S_IEXEC if
1811 the filename has an extension that is commonly used by files
1812 that CreateProcessW can execute. A real implementation calls
1813 GetSecurityInfo, OpenThreadToken/OpenProcessToken, and
1814 AccessCheck to check for generic read, write, and execute
1815 access. */
1816 const wchar_t *fileExtension = wcsrchr(path, '.');
1817 if (fileExtension) {
1818 if (_wcsicmp(fileExtension, L".exe") == 0 ||
1819 _wcsicmp(fileExtension, L".bat") == 0 ||
1820 _wcsicmp(fileExtension, L".cmd") == 0 ||
1821 _wcsicmp(fileExtension, L".com") == 0) {
1822 result->st_mode |= 0111;
1823 }
1824 }
1825 }
1826
1827cleanup:
1828 if (hFile != INVALID_HANDLE_VALUE) {
Miss Islington (bot)cad7abf2019-09-04 15:18:05 -07001829 /* Preserve last error if we are failing */
1830 error = retval ? GetLastError() : 0;
1831 if (!CloseHandle(hFile)) {
1832 retval = -1;
1833 } else if (retval) {
1834 /* Restore last error */
1835 SetLastError(error);
1836 }
Steve Dower9eb3d542019-08-21 15:52:42 -07001837 }
1838
1839 return retval;
Brian Curtinf5e76d02010-11-24 13:14:05 +00001840}
1841
1842static int
Steve Dowercc16be82016-09-08 10:35:16 -07001843win32_xstat(const wchar_t *path, struct _Py_stat_struct *result, BOOL traverse)
Brian Curtinf5e76d02010-11-24 13:14:05 +00001844{
Hirokazu Yamamoto427d3142010-12-04 10:16:05 +00001845 /* Protocol violation: we explicitly clear errno, instead of
1846 setting it to a POSIX error. Callers should use GetLastError. */
Brian Curtind25aef52011-06-13 15:16:04 -05001847 int code = win32_xstat_impl(path, result, traverse);
Hirokazu Yamamoto427d3142010-12-04 10:16:05 +00001848 errno = 0;
1849 return code;
1850}
Brian Curtind25aef52011-06-13 15:16:04 -05001851/* About the following functions: win32_lstat_w, win32_stat, win32_stat_w
Brian Curtind40e6f72010-07-08 21:39:08 +00001852
1853 In Posix, stat automatically traverses symlinks and returns the stat
1854 structure for the target. In Windows, the equivalent GetFileAttributes by
1855 default does not traverse symlinks and instead returns attributes for
1856 the symlink.
1857
Steve Dower9eb3d542019-08-21 15:52:42 -07001858 Instead, we will open the file (which *does* traverse symlinks by default)
1859 and GetFileInformationByHandle(). */
Brian Curtind40e6f72010-07-08 21:39:08 +00001860
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00001861static int
Steve Dowercc16be82016-09-08 10:35:16 -07001862win32_lstat(const wchar_t* path, struct _Py_stat_struct *result)
Martin v. Löwis14694662006-02-03 12:54:16 +00001863{
Hirokazu Yamamoto427d3142010-12-04 10:16:05 +00001864 return win32_xstat(path, result, FALSE);
Martin v. Löwis14694662006-02-03 12:54:16 +00001865}
1866
Victor Stinner8c62be82010-05-06 00:08:46 +00001867static int
Steve Dowercc16be82016-09-08 10:35:16 -07001868win32_stat(const wchar_t* path, struct _Py_stat_struct *result)
Brian Curtind40e6f72010-07-08 21:39:08 +00001869{
Hirokazu Yamamoto427d3142010-12-04 10:16:05 +00001870 return win32_xstat(path, result, TRUE);
Brian Curtind40e6f72010-07-08 21:39:08 +00001871}
1872
Martin v. Löwis14694662006-02-03 12:54:16 +00001873#endif /* MS_WINDOWS */
1874
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001875PyDoc_STRVAR(stat_result__doc__,
Larry Hastings9cf065c2012-06-22 16:30:09 -07001876"stat_result: Result from stat, fstat, or lstat.\n\n\
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001877This object may be accessed either as a tuple of\n\
Fred Drakef7ce04d2002-06-20 18:31:21 +00001878 (mode, ino, dev, nlink, uid, gid, size, atime, mtime, ctime)\n\
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001879or via the attributes st_mode, st_ino, st_dev, st_nlink, st_uid, and so on.\n\
1880\n\
Hye-Shik Chang5f937a72005-06-02 13:09:30 +00001881Posix/windows: If your platform supports st_blksize, st_blocks, st_rdev,\n\
1882or st_flags, they are available as attributes only.\n\
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001883\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001884See os.stat for more information.");
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001885
1886static PyStructSequence_Field stat_result_fields[] = {
Victor Stinner8c62be82010-05-06 00:08:46 +00001887 {"st_mode", "protection bits"},
1888 {"st_ino", "inode"},
1889 {"st_dev", "device"},
1890 {"st_nlink", "number of hard links"},
1891 {"st_uid", "user ID of owner"},
1892 {"st_gid", "group ID of owner"},
1893 {"st_size", "total size, in bytes"},
1894 /* The NULL is replaced with PyStructSequence_UnnamedField later. */
1895 {NULL, "integer time of last access"},
1896 {NULL, "integer time of last modification"},
1897 {NULL, "integer time of last change"},
1898 {"st_atime", "time of last access"},
1899 {"st_mtime", "time of last modification"},
1900 {"st_ctime", "time of last change"},
Larry Hastings6fe20b32012-04-19 15:07:49 -07001901 {"st_atime_ns", "time of last access in nanoseconds"},
1902 {"st_mtime_ns", "time of last modification in nanoseconds"},
1903 {"st_ctime_ns", "time of last change in nanoseconds"},
Martin v. Löwis60a5d722002-10-16 20:28:25 +00001904#ifdef HAVE_STRUCT_STAT_ST_BLKSIZE
Victor Stinner8c62be82010-05-06 00:08:46 +00001905 {"st_blksize", "blocksize for filesystem I/O"},
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001906#endif
Martin v. Löwis60a5d722002-10-16 20:28:25 +00001907#ifdef HAVE_STRUCT_STAT_ST_BLOCKS
Victor Stinner8c62be82010-05-06 00:08:46 +00001908 {"st_blocks", "number of blocks allocated"},
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001909#endif
Martin v. Löwis60a5d722002-10-16 20:28:25 +00001910#ifdef HAVE_STRUCT_STAT_ST_RDEV
Victor Stinner8c62be82010-05-06 00:08:46 +00001911 {"st_rdev", "device type (if inode device)"},
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001912#endif
Hye-Shik Chang5f937a72005-06-02 13:09:30 +00001913#ifdef HAVE_STRUCT_STAT_ST_FLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +00001914 {"st_flags", "user defined flags for file"},
Hye-Shik Chang5f937a72005-06-02 13:09:30 +00001915#endif
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00001916#ifdef HAVE_STRUCT_STAT_ST_GEN
Victor Stinner8c62be82010-05-06 00:08:46 +00001917 {"st_gen", "generation number"},
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00001918#endif
1919#ifdef HAVE_STRUCT_STAT_ST_BIRTHTIME
Victor Stinner8c62be82010-05-06 00:08:46 +00001920 {"st_birthtime", "time of creation"},
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00001921#endif
Zachary Ware63f277b2014-06-19 09:46:37 -05001922#ifdef HAVE_STRUCT_STAT_ST_FILE_ATTRIBUTES
1923 {"st_file_attributes", "Windows file attribute bits"},
1924#endif
jcea6c51d512018-01-28 14:00:08 +01001925#ifdef HAVE_STRUCT_STAT_ST_FSTYPE
1926 {"st_fstype", "Type of filesystem"},
1927#endif
Steve Dower9eb3d542019-08-21 15:52:42 -07001928#ifdef HAVE_STRUCT_STAT_ST_REPARSE_TAG
1929 {"st_reparse_tag", "Windows reparse tag"},
1930#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00001931 {0}
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001932};
1933
Martin v. Löwis60a5d722002-10-16 20:28:25 +00001934#ifdef HAVE_STRUCT_STAT_ST_BLKSIZE
Larry Hastings6fe20b32012-04-19 15:07:49 -07001935#define ST_BLKSIZE_IDX 16
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001936#else
Larry Hastings6fe20b32012-04-19 15:07:49 -07001937#define ST_BLKSIZE_IDX 15
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001938#endif
1939
Martin v. Löwis60a5d722002-10-16 20:28:25 +00001940#ifdef HAVE_STRUCT_STAT_ST_BLOCKS
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001941#define ST_BLOCKS_IDX (ST_BLKSIZE_IDX+1)
1942#else
1943#define ST_BLOCKS_IDX ST_BLKSIZE_IDX
1944#endif
1945
Martin v. Löwis60a5d722002-10-16 20:28:25 +00001946#ifdef HAVE_STRUCT_STAT_ST_RDEV
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001947#define ST_RDEV_IDX (ST_BLOCKS_IDX+1)
1948#else
1949#define ST_RDEV_IDX ST_BLOCKS_IDX
1950#endif
1951
Hye-Shik Chang5f937a72005-06-02 13:09:30 +00001952#ifdef HAVE_STRUCT_STAT_ST_FLAGS
1953#define ST_FLAGS_IDX (ST_RDEV_IDX+1)
1954#else
1955#define ST_FLAGS_IDX ST_RDEV_IDX
1956#endif
1957
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00001958#ifdef HAVE_STRUCT_STAT_ST_GEN
Martin v. Löwisf09582e2005-08-14 21:42:34 +00001959#define ST_GEN_IDX (ST_FLAGS_IDX+1)
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00001960#else
Martin v. Löwisf09582e2005-08-14 21:42:34 +00001961#define ST_GEN_IDX ST_FLAGS_IDX
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00001962#endif
1963
1964#ifdef HAVE_STRUCT_STAT_ST_BIRTHTIME
1965#define ST_BIRTHTIME_IDX (ST_GEN_IDX+1)
1966#else
1967#define ST_BIRTHTIME_IDX ST_GEN_IDX
1968#endif
1969
Zachary Ware63f277b2014-06-19 09:46:37 -05001970#ifdef HAVE_STRUCT_STAT_ST_FILE_ATTRIBUTES
1971#define ST_FILE_ATTRIBUTES_IDX (ST_BIRTHTIME_IDX+1)
1972#else
1973#define ST_FILE_ATTRIBUTES_IDX ST_BIRTHTIME_IDX
1974#endif
1975
jcea6c51d512018-01-28 14:00:08 +01001976#ifdef HAVE_STRUCT_STAT_ST_FSTYPE
1977#define ST_FSTYPE_IDX (ST_FILE_ATTRIBUTES_IDX+1)
1978#else
1979#define ST_FSTYPE_IDX ST_FILE_ATTRIBUTES_IDX
1980#endif
1981
Steve Dower9eb3d542019-08-21 15:52:42 -07001982#ifdef HAVE_STRUCT_STAT_ST_REPARSE_TAG
1983#define ST_REPARSE_TAG_IDX (ST_FSTYPE_IDX+1)
1984#else
1985#define ST_REPARSE_TAG_IDX ST_FSTYPE_IDX
1986#endif
1987
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001988static PyStructSequence_Desc stat_result_desc = {
Victor Stinner8c62be82010-05-06 00:08:46 +00001989 "stat_result", /* name */
1990 stat_result__doc__, /* doc */
1991 stat_result_fields,
1992 10
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001993};
1994
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001995PyDoc_STRVAR(statvfs_result__doc__,
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001996"statvfs_result: Result from statvfs or fstatvfs.\n\n\
1997This object may be accessed either as a tuple of\n\
Fred Drakef7ce04d2002-06-20 18:31:21 +00001998 (bsize, frsize, blocks, bfree, bavail, files, ffree, favail, flag, namemax),\n\
Guido van Rossuma4dc73e2001-10-18 20:53:15 +00001999or via the attributes f_bsize, f_frsize, f_blocks, f_bfree, and so on.\n\
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002000\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002001See os.statvfs for more information.");
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002002
2003static PyStructSequence_Field statvfs_result_fields[] = {
Victor Stinner8c62be82010-05-06 00:08:46 +00002004 {"f_bsize", },
2005 {"f_frsize", },
2006 {"f_blocks", },
2007 {"f_bfree", },
2008 {"f_bavail", },
2009 {"f_files", },
2010 {"f_ffree", },
2011 {"f_favail", },
2012 {"f_flag", },
2013 {"f_namemax",},
Giuseppe Scrivano96a5e502017-12-14 23:46:46 +01002014 {"f_fsid", },
Victor Stinner8c62be82010-05-06 00:08:46 +00002015 {0}
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002016};
2017
2018static PyStructSequence_Desc statvfs_result_desc = {
Victor Stinner8c62be82010-05-06 00:08:46 +00002019 "statvfs_result", /* name */
2020 statvfs_result__doc__, /* doc */
2021 statvfs_result_fields,
2022 10
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002023};
2024
Ross Lagerwall7807c352011-03-17 20:20:30 +02002025#if defined(HAVE_WAITID) && !defined(__APPLE__)
2026PyDoc_STRVAR(waitid_result__doc__,
2027"waitid_result: Result from waitid.\n\n\
2028This object may be accessed either as a tuple of\n\
2029 (si_pid, si_uid, si_signo, si_status, si_code),\n\
2030or via the attributes si_pid, si_uid, and so on.\n\
2031\n\
2032See os.waitid for more information.");
2033
2034static PyStructSequence_Field waitid_result_fields[] = {
2035 {"si_pid", },
2036 {"si_uid", },
2037 {"si_signo", },
2038 {"si_status", },
2039 {"si_code", },
2040 {0}
2041};
2042
2043static PyStructSequence_Desc waitid_result_desc = {
2044 "waitid_result", /* name */
2045 waitid_result__doc__, /* doc */
2046 waitid_result_fields,
2047 5
2048};
Eddie Elizondo474eedf2018-11-13 04:09:31 -08002049static PyTypeObject* WaitidResultType;
Ross Lagerwall7807c352011-03-17 20:20:30 +02002050#endif
2051
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002052static int initialized;
Eddie Elizondo474eedf2018-11-13 04:09:31 -08002053static PyTypeObject* StatResultType;
2054static PyTypeObject* StatVFSResultType;
William Orr81574b82018-10-01 22:19:56 -07002055#if defined(HAVE_SCHED_SETPARAM) || defined(HAVE_SCHED_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDPARAM)
Eddie Elizondo474eedf2018-11-13 04:09:31 -08002056static PyTypeObject* SchedParamType;
Benjamin Petersonbad9c2f2011-08-02 18:42:14 -05002057#endif
Martin v. Löwisf607bda2002-10-16 18:27:39 +00002058static newfunc structseq_new;
2059
2060static PyObject *
2061statresult_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
2062{
Victor Stinner8c62be82010-05-06 00:08:46 +00002063 PyStructSequence *result;
2064 int i;
Martin v. Löwisf607bda2002-10-16 18:27:39 +00002065
Victor Stinner8c62be82010-05-06 00:08:46 +00002066 result = (PyStructSequence*)structseq_new(type, args, kwds);
2067 if (!result)
2068 return NULL;
2069 /* If we have been initialized from a tuple,
2070 st_?time might be set to None. Initialize it
2071 from the int slots. */
2072 for (i = 7; i <= 9; i++) {
2073 if (result->ob_item[i+3] == Py_None) {
2074 Py_DECREF(Py_None);
2075 Py_INCREF(result->ob_item[i]);
2076 result->ob_item[i+3] = result->ob_item[i];
2077 }
2078 }
2079 return (PyObject*)result;
Martin v. Löwisf607bda2002-10-16 18:27:39 +00002080}
2081
2082
Larry Hastings6fe20b32012-04-19 15:07:49 -07002083static PyObject *billion = NULL;
2084
Martin v. Löwis94717ed2002-09-09 14:24:16 +00002085static void
Victor Stinner4195b5c2012-02-08 23:03:19 +01002086fill_time(PyObject *v, int index, time_t sec, unsigned long nsec)
Martin v. Löwis94717ed2002-09-09 14:24:16 +00002087{
Larry Hastings6fe20b32012-04-19 15:07:49 -07002088 PyObject *s = _PyLong_FromTime_t(sec);
2089 PyObject *ns_fractional = PyLong_FromUnsignedLong(nsec);
2090 PyObject *s_in_ns = NULL;
2091 PyObject *ns_total = NULL;
2092 PyObject *float_s = NULL;
2093
2094 if (!(s && ns_fractional))
2095 goto exit;
2096
2097 s_in_ns = PyNumber_Multiply(s, billion);
2098 if (!s_in_ns)
2099 goto exit;
2100
2101 ns_total = PyNumber_Add(s_in_ns, ns_fractional);
2102 if (!ns_total)
2103 goto exit;
2104
Victor Stinner01b5aab2017-10-24 02:02:00 -07002105 float_s = PyFloat_FromDouble(sec + 1e-9*nsec);
2106 if (!float_s) {
2107 goto exit;
Larry Hastings6fe20b32012-04-19 15:07:49 -07002108 }
2109
2110 PyStructSequence_SET_ITEM(v, index, s);
2111 PyStructSequence_SET_ITEM(v, index+3, float_s);
2112 PyStructSequence_SET_ITEM(v, index+6, ns_total);
2113 s = NULL;
2114 float_s = NULL;
2115 ns_total = NULL;
2116exit:
2117 Py_XDECREF(s);
2118 Py_XDECREF(ns_fractional);
2119 Py_XDECREF(s_in_ns);
2120 Py_XDECREF(ns_total);
2121 Py_XDECREF(float_s);
Martin v. Löwis94717ed2002-09-09 14:24:16 +00002122}
2123
Tim Peters5aa91602002-01-30 05:46:57 +00002124/* pack a system stat C structure into the Python stat tuple
Fred Drake699f3522000-06-29 21:12:41 +00002125 (used by posix_stat() and posix_fstat()) */
2126static PyObject*
Victor Stinner4195b5c2012-02-08 23:03:19 +01002127_pystat_fromstructstat(STRUCT_STAT *st)
Fred Drake699f3522000-06-29 21:12:41 +00002128{
Victor Stinner8c62be82010-05-06 00:08:46 +00002129 unsigned long ansec, mnsec, cnsec;
Eddie Elizondo474eedf2018-11-13 04:09:31 -08002130 PyObject *v = PyStructSequence_New(StatResultType);
Victor Stinner8c62be82010-05-06 00:08:46 +00002131 if (v == NULL)
2132 return NULL;
Fred Drake699f3522000-06-29 21:12:41 +00002133
Victor Stinner8c62be82010-05-06 00:08:46 +00002134 PyStructSequence_SET_ITEM(v, 0, PyLong_FromLong((long)st->st_mode));
Victor Stinner0f6d7332017-03-09 17:34:28 +01002135 Py_BUILD_ASSERT(sizeof(unsigned long long) >= sizeof(st->st_ino));
xdegaye50e86032017-05-22 11:15:08 +02002136 PyStructSequence_SET_ITEM(v, 1, PyLong_FromUnsignedLongLong(st->st_ino));
Serhiy Storchaka404fa922013-01-02 18:22:23 +02002137#ifdef MS_WINDOWS
2138 PyStructSequence_SET_ITEM(v, 2, PyLong_FromUnsignedLong(st->st_dev));
Fred Drake699f3522000-06-29 21:12:41 +00002139#else
Serhiy Storchakab2653b32015-01-18 11:12:11 +02002140 PyStructSequence_SET_ITEM(v, 2, _PyLong_FromDev(st->st_dev));
Fred Drake699f3522000-06-29 21:12:41 +00002141#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00002142 PyStructSequence_SET_ITEM(v, 3, PyLong_FromLong((long)st->st_nlink));
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02002143#if defined(MS_WINDOWS)
2144 PyStructSequence_SET_ITEM(v, 4, PyLong_FromLong(0));
2145 PyStructSequence_SET_ITEM(v, 5, PyLong_FromLong(0));
2146#else
2147 PyStructSequence_SET_ITEM(v, 4, _PyLong_FromUid(st->st_uid));
2148 PyStructSequence_SET_ITEM(v, 5, _PyLong_FromGid(st->st_gid));
2149#endif
xdegaye50e86032017-05-22 11:15:08 +02002150 Py_BUILD_ASSERT(sizeof(long long) >= sizeof(st->st_size));
2151 PyStructSequence_SET_ITEM(v, 6, PyLong_FromLongLong(st->st_size));
Martin v. Löwis94717ed2002-09-09 14:24:16 +00002152
Martin v. Löwis14694662006-02-03 12:54:16 +00002153#if defined(HAVE_STAT_TV_NSEC)
Victor Stinner8c62be82010-05-06 00:08:46 +00002154 ansec = st->st_atim.tv_nsec;
2155 mnsec = st->st_mtim.tv_nsec;
2156 cnsec = st->st_ctim.tv_nsec;
Martin v. Löwis14694662006-02-03 12:54:16 +00002157#elif defined(HAVE_STAT_TV_NSEC2)
Victor Stinner8c62be82010-05-06 00:08:46 +00002158 ansec = st->st_atimespec.tv_nsec;
2159 mnsec = st->st_mtimespec.tv_nsec;
2160 cnsec = st->st_ctimespec.tv_nsec;
Martin v. Löwis14694662006-02-03 12:54:16 +00002161#elif defined(HAVE_STAT_NSEC)
Victor Stinner8c62be82010-05-06 00:08:46 +00002162 ansec = st->st_atime_nsec;
2163 mnsec = st->st_mtime_nsec;
2164 cnsec = st->st_ctime_nsec;
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002165#else
Victor Stinner8c62be82010-05-06 00:08:46 +00002166 ansec = mnsec = cnsec = 0;
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002167#endif
Victor Stinner4195b5c2012-02-08 23:03:19 +01002168 fill_time(v, 7, st->st_atime, ansec);
2169 fill_time(v, 8, st->st_mtime, mnsec);
2170 fill_time(v, 9, st->st_ctime, cnsec);
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002171
Martin v. Löwis60a5d722002-10-16 20:28:25 +00002172#ifdef HAVE_STRUCT_STAT_ST_BLKSIZE
Victor Stinner8c62be82010-05-06 00:08:46 +00002173 PyStructSequence_SET_ITEM(v, ST_BLKSIZE_IDX,
2174 PyLong_FromLong((long)st->st_blksize));
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002175#endif
Martin v. Löwis60a5d722002-10-16 20:28:25 +00002176#ifdef HAVE_STRUCT_STAT_ST_BLOCKS
Victor Stinner8c62be82010-05-06 00:08:46 +00002177 PyStructSequence_SET_ITEM(v, ST_BLOCKS_IDX,
2178 PyLong_FromLong((long)st->st_blocks));
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002179#endif
Martin v. Löwis60a5d722002-10-16 20:28:25 +00002180#ifdef HAVE_STRUCT_STAT_ST_RDEV
Victor Stinner8c62be82010-05-06 00:08:46 +00002181 PyStructSequence_SET_ITEM(v, ST_RDEV_IDX,
2182 PyLong_FromLong((long)st->st_rdev));
Fred Drake699f3522000-06-29 21:12:41 +00002183#endif
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002184#ifdef HAVE_STRUCT_STAT_ST_GEN
Victor Stinner8c62be82010-05-06 00:08:46 +00002185 PyStructSequence_SET_ITEM(v, ST_GEN_IDX,
2186 PyLong_FromLong((long)st->st_gen));
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002187#endif
2188#ifdef HAVE_STRUCT_STAT_ST_BIRTHTIME
Victor Stinner8c62be82010-05-06 00:08:46 +00002189 {
Victor Stinner4195b5c2012-02-08 23:03:19 +01002190 PyObject *val;
2191 unsigned long bsec,bnsec;
2192 bsec = (long)st->st_birthtime;
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002193#ifdef HAVE_STAT_TV_NSEC2
Victor Stinner4195b5c2012-02-08 23:03:19 +01002194 bnsec = st->st_birthtimespec.tv_nsec;
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002195#else
Victor Stinner4195b5c2012-02-08 23:03:19 +01002196 bnsec = 0;
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002197#endif
Victor Stinner01b5aab2017-10-24 02:02:00 -07002198 val = PyFloat_FromDouble(bsec + 1e-9*bnsec);
Victor Stinner4195b5c2012-02-08 23:03:19 +01002199 PyStructSequence_SET_ITEM(v, ST_BIRTHTIME_IDX,
2200 val);
Victor Stinner8c62be82010-05-06 00:08:46 +00002201 }
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002202#endif
Hye-Shik Chang5f937a72005-06-02 13:09:30 +00002203#ifdef HAVE_STRUCT_STAT_ST_FLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +00002204 PyStructSequence_SET_ITEM(v, ST_FLAGS_IDX,
2205 PyLong_FromLong((long)st->st_flags));
Hye-Shik Chang5f937a72005-06-02 13:09:30 +00002206#endif
Zachary Ware63f277b2014-06-19 09:46:37 -05002207#ifdef HAVE_STRUCT_STAT_ST_FILE_ATTRIBUTES
2208 PyStructSequence_SET_ITEM(v, ST_FILE_ATTRIBUTES_IDX,
2209 PyLong_FromUnsignedLong(st->st_file_attributes));
2210#endif
jcea6c51d512018-01-28 14:00:08 +01002211#ifdef HAVE_STRUCT_STAT_ST_FSTYPE
2212 PyStructSequence_SET_ITEM(v, ST_FSTYPE_IDX,
2213 PyUnicode_FromString(st->st_fstype));
2214#endif
Steve Dower9eb3d542019-08-21 15:52:42 -07002215#ifdef HAVE_STRUCT_STAT_ST_REPARSE_TAG
2216 PyStructSequence_SET_ITEM(v, ST_REPARSE_TAG_IDX,
2217 PyLong_FromUnsignedLong(st->st_reparse_tag));
2218#endif
Fred Drake699f3522000-06-29 21:12:41 +00002219
Victor Stinner8c62be82010-05-06 00:08:46 +00002220 if (PyErr_Occurred()) {
2221 Py_DECREF(v);
2222 return NULL;
2223 }
Fred Drake699f3522000-06-29 21:12:41 +00002224
Victor Stinner8c62be82010-05-06 00:08:46 +00002225 return v;
Fred Drake699f3522000-06-29 21:12:41 +00002226}
2227
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002228/* POSIX methods */
2229
Guido van Rossum94f6f721999-01-06 18:42:14 +00002230
2231static PyObject *
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02002232posix_do_stat(const char *function_name, path_t *path,
Larry Hastings9cf065c2012-06-22 16:30:09 -07002233 int dir_fd, int follow_symlinks)
Guido van Rossum94f6f721999-01-06 18:42:14 +00002234{
Larry Hastings9cf065c2012-06-22 16:30:09 -07002235 STRUCT_STAT st;
2236 int result;
2237
2238#if !defined(MS_WINDOWS) && !defined(HAVE_FSTATAT) && !defined(HAVE_LSTAT)
2239 if (follow_symlinks_specified(function_name, follow_symlinks))
2240 return NULL;
2241#endif
2242
2243 if (path_and_dir_fd_invalid("stat", path, dir_fd) ||
2244 dir_fd_and_fd_invalid("stat", dir_fd, path->fd) ||
2245 fd_and_follow_symlinks_invalid("stat", path->fd, follow_symlinks))
2246 return NULL;
2247
2248 Py_BEGIN_ALLOW_THREADS
2249 if (path->fd != -1)
2250 result = FSTAT(path->fd, &st);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002251#ifdef MS_WINDOWS
Steve Dower513d7472016-09-08 10:41:50 -07002252 else if (follow_symlinks)
Steve Dowercc16be82016-09-08 10:35:16 -07002253 result = win32_stat(path->wide, &st);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002254 else
Steve Dowercc16be82016-09-08 10:35:16 -07002255 result = win32_lstat(path->wide, &st);
2256#else
2257 else
2258#if defined(HAVE_LSTAT)
Larry Hastings9cf065c2012-06-22 16:30:09 -07002259 if ((!follow_symlinks) && (dir_fd == DEFAULT_DIR_FD))
2260 result = LSTAT(path->narrow, &st);
2261 else
Steve Dowercc16be82016-09-08 10:35:16 -07002262#endif /* HAVE_LSTAT */
Larry Hastings9cf065c2012-06-22 16:30:09 -07002263#ifdef HAVE_FSTATAT
2264 if ((dir_fd != DEFAULT_DIR_FD) || !follow_symlinks)
2265 result = fstatat(dir_fd, path->narrow, &st,
2266 follow_symlinks ? 0 : AT_SYMLINK_NOFOLLOW);
2267 else
Steve Dowercc16be82016-09-08 10:35:16 -07002268#endif /* HAVE_FSTATAT */
Larry Hastings9cf065c2012-06-22 16:30:09 -07002269 result = STAT(path->narrow, &st);
Steve Dowercc16be82016-09-08 10:35:16 -07002270#endif /* MS_WINDOWS */
Larry Hastings9cf065c2012-06-22 16:30:09 -07002271 Py_END_ALLOW_THREADS
2272
Victor Stinner292c8352012-10-30 02:17:38 +01002273 if (result != 0) {
2274 return path_error(path);
2275 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07002276
2277 return _pystat_fromstructstat(&st);
2278}
2279
Larry Hastings2f936352014-08-05 14:04:04 +10002280/*[python input]
2281
2282for s in """
2283
2284FACCESSAT
2285FCHMODAT
2286FCHOWNAT
2287FSTATAT
2288LINKAT
2289MKDIRAT
2290MKFIFOAT
2291MKNODAT
2292OPENAT
2293READLINKAT
2294SYMLINKAT
2295UNLINKAT
2296
2297""".strip().split():
2298 s = s.strip()
2299 print("""
2300#ifdef HAVE_{s}
2301 #define {s}_DIR_FD_CONVERTER dir_fd_converter
Larry Hastings31826802013-10-19 00:09:25 -07002302#else
Larry Hastings2f936352014-08-05 14:04:04 +10002303 #define {s}_DIR_FD_CONVERTER dir_fd_unavailable
Larry Hastings31826802013-10-19 00:09:25 -07002304#endif
Larry Hastings2f936352014-08-05 14:04:04 +10002305""".rstrip().format(s=s))
2306
2307for s in """
2308
2309FCHDIR
2310FCHMOD
2311FCHOWN
2312FDOPENDIR
2313FEXECVE
2314FPATHCONF
2315FSTATVFS
2316FTRUNCATE
2317
2318""".strip().split():
2319 s = s.strip()
2320 print("""
2321#ifdef HAVE_{s}
2322 #define PATH_HAVE_{s} 1
2323#else
2324 #define PATH_HAVE_{s} 0
2325#endif
2326
2327""".rstrip().format(s=s))
2328[python start generated code]*/
2329
2330#ifdef HAVE_FACCESSAT
2331 #define FACCESSAT_DIR_FD_CONVERTER dir_fd_converter
2332#else
2333 #define FACCESSAT_DIR_FD_CONVERTER dir_fd_unavailable
2334#endif
2335
2336#ifdef HAVE_FCHMODAT
2337 #define FCHMODAT_DIR_FD_CONVERTER dir_fd_converter
2338#else
2339 #define FCHMODAT_DIR_FD_CONVERTER dir_fd_unavailable
2340#endif
2341
2342#ifdef HAVE_FCHOWNAT
2343 #define FCHOWNAT_DIR_FD_CONVERTER dir_fd_converter
2344#else
2345 #define FCHOWNAT_DIR_FD_CONVERTER dir_fd_unavailable
2346#endif
2347
2348#ifdef HAVE_FSTATAT
2349 #define FSTATAT_DIR_FD_CONVERTER dir_fd_converter
2350#else
2351 #define FSTATAT_DIR_FD_CONVERTER dir_fd_unavailable
2352#endif
2353
2354#ifdef HAVE_LINKAT
2355 #define LINKAT_DIR_FD_CONVERTER dir_fd_converter
2356#else
2357 #define LINKAT_DIR_FD_CONVERTER dir_fd_unavailable
2358#endif
2359
2360#ifdef HAVE_MKDIRAT
2361 #define MKDIRAT_DIR_FD_CONVERTER dir_fd_converter
2362#else
2363 #define MKDIRAT_DIR_FD_CONVERTER dir_fd_unavailable
2364#endif
2365
2366#ifdef HAVE_MKFIFOAT
2367 #define MKFIFOAT_DIR_FD_CONVERTER dir_fd_converter
2368#else
2369 #define MKFIFOAT_DIR_FD_CONVERTER dir_fd_unavailable
2370#endif
2371
2372#ifdef HAVE_MKNODAT
2373 #define MKNODAT_DIR_FD_CONVERTER dir_fd_converter
2374#else
2375 #define MKNODAT_DIR_FD_CONVERTER dir_fd_unavailable
2376#endif
2377
2378#ifdef HAVE_OPENAT
2379 #define OPENAT_DIR_FD_CONVERTER dir_fd_converter
2380#else
2381 #define OPENAT_DIR_FD_CONVERTER dir_fd_unavailable
2382#endif
2383
2384#ifdef HAVE_READLINKAT
2385 #define READLINKAT_DIR_FD_CONVERTER dir_fd_converter
2386#else
2387 #define READLINKAT_DIR_FD_CONVERTER dir_fd_unavailable
2388#endif
2389
2390#ifdef HAVE_SYMLINKAT
2391 #define SYMLINKAT_DIR_FD_CONVERTER dir_fd_converter
2392#else
2393 #define SYMLINKAT_DIR_FD_CONVERTER dir_fd_unavailable
2394#endif
2395
2396#ifdef HAVE_UNLINKAT
2397 #define UNLINKAT_DIR_FD_CONVERTER dir_fd_converter
2398#else
2399 #define UNLINKAT_DIR_FD_CONVERTER dir_fd_unavailable
2400#endif
2401
2402#ifdef HAVE_FCHDIR
2403 #define PATH_HAVE_FCHDIR 1
2404#else
2405 #define PATH_HAVE_FCHDIR 0
2406#endif
2407
2408#ifdef HAVE_FCHMOD
2409 #define PATH_HAVE_FCHMOD 1
2410#else
2411 #define PATH_HAVE_FCHMOD 0
2412#endif
2413
2414#ifdef HAVE_FCHOWN
2415 #define PATH_HAVE_FCHOWN 1
2416#else
2417 #define PATH_HAVE_FCHOWN 0
2418#endif
2419
2420#ifdef HAVE_FDOPENDIR
2421 #define PATH_HAVE_FDOPENDIR 1
2422#else
2423 #define PATH_HAVE_FDOPENDIR 0
2424#endif
2425
2426#ifdef HAVE_FEXECVE
2427 #define PATH_HAVE_FEXECVE 1
2428#else
2429 #define PATH_HAVE_FEXECVE 0
2430#endif
2431
2432#ifdef HAVE_FPATHCONF
2433 #define PATH_HAVE_FPATHCONF 1
2434#else
2435 #define PATH_HAVE_FPATHCONF 0
2436#endif
2437
2438#ifdef HAVE_FSTATVFS
2439 #define PATH_HAVE_FSTATVFS 1
2440#else
2441 #define PATH_HAVE_FSTATVFS 0
2442#endif
2443
2444#ifdef HAVE_FTRUNCATE
2445 #define PATH_HAVE_FTRUNCATE 1
2446#else
2447 #define PATH_HAVE_FTRUNCATE 0
2448#endif
2449/*[python end generated code: output=4bd4f6f7d41267f1 input=80b4c890b6774ea5]*/
Larry Hastings31826802013-10-19 00:09:25 -07002450
Steve Dowerfe0a41a2015-03-20 19:50:46 -07002451#ifdef MS_WINDOWS
2452 #undef PATH_HAVE_FTRUNCATE
2453 #define PATH_HAVE_FTRUNCATE 1
2454#endif
Larry Hastings31826802013-10-19 00:09:25 -07002455
Larry Hastings61272b72014-01-07 12:41:53 -08002456/*[python input]
Larry Hastings31826802013-10-19 00:09:25 -07002457
2458class path_t_converter(CConverter):
2459
2460 type = "path_t"
2461 impl_by_reference = True
2462 parse_by_reference = True
2463
2464 converter = 'path_converter'
2465
2466 def converter_init(self, *, allow_fd=False, nullable=False):
Larry Hastings31826802013-10-19 00:09:25 -07002467 # right now path_t doesn't support default values.
2468 # to support a default value, you'll need to override initialize().
Larry Hastings2f936352014-08-05 14:04:04 +10002469 if self.default not in (unspecified, None):
Larry Hastings7726ac92014-01-31 22:03:12 -08002470 fail("Can't specify a default to the path_t converter!")
Larry Hastings31826802013-10-19 00:09:25 -07002471
Larry Hastings2f936352014-08-05 14:04:04 +10002472 if self.c_default not in (None, 'Py_None'):
2473 raise RuntimeError("Can't specify a c_default to the path_t converter!")
Larry Hastings31826802013-10-19 00:09:25 -07002474
2475 self.nullable = nullable
2476 self.allow_fd = allow_fd
2477
Larry Hastings7726ac92014-01-31 22:03:12 -08002478 def pre_render(self):
2479 def strify(value):
Larry Hastings2f936352014-08-05 14:04:04 +10002480 if isinstance(value, str):
2481 return value
Larry Hastings7726ac92014-01-31 22:03:12 -08002482 return str(int(bool(value)))
2483
2484 # add self.py_name here when merging with posixmodule conversion
Larry Hastings2f936352014-08-05 14:04:04 +10002485 self.c_default = 'PATH_T_INITIALIZE("{}", "{}", {}, {})'.format(
Larry Hastings31826802013-10-19 00:09:25 -07002486 self.function.name,
Larry Hastings2f936352014-08-05 14:04:04 +10002487 self.name,
Larry Hastings7726ac92014-01-31 22:03:12 -08002488 strify(self.nullable),
2489 strify(self.allow_fd),
Larry Hastings31826802013-10-19 00:09:25 -07002490 )
2491
2492 def cleanup(self):
2493 return "path_cleanup(&" + self.name + ");\n"
2494
2495
2496class dir_fd_converter(CConverter):
2497 type = 'int'
Larry Hastings31826802013-10-19 00:09:25 -07002498
Larry Hastings2f936352014-08-05 14:04:04 +10002499 def converter_init(self, requires=None):
Larry Hastings31826802013-10-19 00:09:25 -07002500 if self.default in (unspecified, None):
2501 self.c_default = 'DEFAULT_DIR_FD'
Larry Hastings2f936352014-08-05 14:04:04 +10002502 if isinstance(requires, str):
2503 self.converter = requires.upper() + '_DIR_FD_CONVERTER'
2504 else:
2505 self.converter = 'dir_fd_converter'
Larry Hastings31826802013-10-19 00:09:25 -07002506
Larry Hastings2f936352014-08-05 14:04:04 +10002507class fildes_converter(CConverter):
2508 type = 'int'
2509 converter = 'fildes_converter'
2510
2511class uid_t_converter(CConverter):
2512 type = "uid_t"
2513 converter = '_Py_Uid_Converter'
2514
2515class gid_t_converter(CConverter):
2516 type = "gid_t"
2517 converter = '_Py_Gid_Converter'
2518
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +02002519class dev_t_converter(CConverter):
2520 type = 'dev_t'
2521 converter = '_Py_Dev_Converter'
2522
2523class dev_t_return_converter(unsigned_long_return_converter):
2524 type = 'dev_t'
2525 conversion_fn = '_PyLong_FromDev'
2526 unsigned_cast = '(dev_t)'
2527
Larry Hastings2f936352014-08-05 14:04:04 +10002528class FSConverter_converter(CConverter):
2529 type = 'PyObject *'
2530 converter = 'PyUnicode_FSConverter'
2531 def converter_init(self):
2532 if self.default is not unspecified:
2533 fail("FSConverter_converter does not support default values")
2534 self.c_default = 'NULL'
2535
2536 def cleanup(self):
2537 return "Py_XDECREF(" + self.name + ");\n"
2538
2539class pid_t_converter(CConverter):
2540 type = 'pid_t'
2541 format_unit = '" _Py_PARSE_PID "'
2542
2543class idtype_t_converter(int_converter):
2544 type = 'idtype_t'
2545
2546class id_t_converter(CConverter):
2547 type = 'id_t'
2548 format_unit = '" _Py_PARSE_PID "'
2549
Benjamin Petersonca470632016-09-06 13:47:26 -07002550class intptr_t_converter(CConverter):
2551 type = 'intptr_t'
Larry Hastings2f936352014-08-05 14:04:04 +10002552 format_unit = '" _Py_PARSE_INTPTR "'
2553
2554class Py_off_t_converter(CConverter):
2555 type = 'Py_off_t'
2556 converter = 'Py_off_t_converter'
2557
2558class Py_off_t_return_converter(long_return_converter):
2559 type = 'Py_off_t'
2560 conversion_fn = 'PyLong_FromPy_off_t'
2561
2562class path_confname_converter(CConverter):
2563 type="int"
2564 converter="conv_path_confname"
2565
2566class confstr_confname_converter(path_confname_converter):
2567 converter='conv_confstr_confname'
2568
2569class sysconf_confname_converter(path_confname_converter):
2570 converter="conv_sysconf_confname"
2571
2572class sched_param_converter(CConverter):
2573 type = 'struct sched_param'
2574 converter = 'convert_sched_param'
2575 impl_by_reference = True;
Larry Hastings31826802013-10-19 00:09:25 -07002576
Larry Hastings61272b72014-01-07 12:41:53 -08002577[python start generated code]*/
Victor Stinner581139c2016-09-06 15:54:20 -07002578/*[python end generated code: output=da39a3ee5e6b4b0d input=418fce0e01144461]*/
Larry Hastings31826802013-10-19 00:09:25 -07002579
Larry Hastings61272b72014-01-07 12:41:53 -08002580/*[clinic input]
Larry Hastings31826802013-10-19 00:09:25 -07002581
Larry Hastings2a727912014-01-16 11:32:01 -08002582os.stat
Larry Hastings31826802013-10-19 00:09:25 -07002583
2584 path : path_t(allow_fd=True)
BNMetricsb9427072018-11-02 15:20:19 +00002585 Path to be examined; can be string, bytes, a path-like object or
Xiang Zhang4459e002017-01-22 13:04:17 +08002586 open-file-descriptor int.
Larry Hastings31826802013-10-19 00:09:25 -07002587
2588 *
2589
Larry Hastings2f936352014-08-05 14:04:04 +10002590 dir_fd : dir_fd(requires='fstatat') = None
Larry Hastings31826802013-10-19 00:09:25 -07002591 If not None, it should be a file descriptor open to a directory,
2592 and path should be a relative string; path will then be relative to
2593 that directory.
2594
2595 follow_symlinks: bool = True
2596 If False, and the last element of the path is a symbolic link,
2597 stat will examine the symbolic link itself instead of the file
2598 the link points to.
2599
2600Perform a stat system call on the given path.
2601
2602dir_fd and follow_symlinks may not be implemented
2603 on your platform. If they are unavailable, using them will raise a
2604 NotImplementedError.
2605
2606It's an error to use dir_fd or follow_symlinks when specifying path as
2607 an open file descriptor.
2608
Larry Hastings61272b72014-01-07 12:41:53 -08002609[clinic start generated code]*/
Larry Hastings31826802013-10-19 00:09:25 -07002610
Larry Hastings31826802013-10-19 00:09:25 -07002611static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002612os_stat_impl(PyObject *module, path_t *path, int dir_fd, int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +00002613/*[clinic end generated code: output=7d4976e6f18a59c5 input=01d362ebcc06996b]*/
Larry Hastings31826802013-10-19 00:09:25 -07002614{
2615 return posix_do_stat("stat", path, dir_fd, follow_symlinks);
2616}
2617
Larry Hastings2f936352014-08-05 14:04:04 +10002618
2619/*[clinic input]
2620os.lstat
2621
2622 path : path_t
2623
2624 *
2625
2626 dir_fd : dir_fd(requires='fstatat') = None
2627
2628Perform a stat system call on the given path, without following symbolic links.
2629
2630Like stat(), but do not follow symbolic links.
2631Equivalent to stat(path, follow_symlinks=False).
2632[clinic start generated code]*/
2633
Larry Hastings2f936352014-08-05 14:04:04 +10002634static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002635os_lstat_impl(PyObject *module, path_t *path, int dir_fd)
2636/*[clinic end generated code: output=ef82a5d35ce8ab37 input=0b7474765927b925]*/
Larry Hastings2f936352014-08-05 14:04:04 +10002637{
2638 int follow_symlinks = 0;
2639 return posix_do_stat("lstat", path, dir_fd, follow_symlinks);
2640}
Larry Hastings31826802013-10-19 00:09:25 -07002641
Larry Hastings2f936352014-08-05 14:04:04 +10002642
Larry Hastings61272b72014-01-07 12:41:53 -08002643/*[clinic input]
Larry Hastings2f936352014-08-05 14:04:04 +10002644os.access -> bool
Larry Hastings31826802013-10-19 00:09:25 -07002645
Benjamin Peterson768f3b42016-09-05 15:29:33 -07002646 path: path_t
BNMetricsb9427072018-11-02 15:20:19 +00002647 Path to be tested; can be string, bytes, or a path-like object.
Larry Hastings31826802013-10-19 00:09:25 -07002648
2649 mode: int
2650 Operating-system mode bitfield. Can be F_OK to test existence,
2651 or the inclusive-OR of R_OK, W_OK, and X_OK.
2652
2653 *
2654
Larry Hastings2f936352014-08-05 14:04:04 +10002655 dir_fd : dir_fd(requires='faccessat') = None
Larry Hastings31826802013-10-19 00:09:25 -07002656 If not None, it should be a file descriptor open to a directory,
2657 and path should be relative; path will then be relative to that
2658 directory.
2659
2660 effective_ids: bool = False
2661 If True, access will use the effective uid/gid instead of
2662 the real uid/gid.
2663
2664 follow_symlinks: bool = True
2665 If False, and the last element of the path is a symbolic link,
2666 access will examine the symbolic link itself instead of the file
2667 the link points to.
2668
2669Use the real uid/gid to test for access to a path.
2670
2671{parameters}
2672dir_fd, effective_ids, and follow_symlinks may not be implemented
2673 on your platform. If they are unavailable, using them will raise a
2674 NotImplementedError.
2675
2676Note that most operations will use the effective uid/gid, therefore this
2677 routine can be used in a suid/sgid environment to test if the invoking user
2678 has the specified access to the path.
2679
Larry Hastings61272b72014-01-07 12:41:53 -08002680[clinic start generated code]*/
Larry Hastings31826802013-10-19 00:09:25 -07002681
Larry Hastings2f936352014-08-05 14:04:04 +10002682static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002683os_access_impl(PyObject *module, path_t *path, int mode, int dir_fd,
Larry Hastings89964c42015-04-14 18:07:59 -04002684 int effective_ids, int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +00002685/*[clinic end generated code: output=cf84158bc90b1a77 input=3ffe4e650ee3bf20]*/
Larry Hastings31826802013-10-19 00:09:25 -07002686{
Larry Hastings2f936352014-08-05 14:04:04 +10002687 int return_value;
Victor Stinner8c62be82010-05-06 00:08:46 +00002688
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00002689#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00002690 DWORD attr;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002691#else
Larry Hastings9cf065c2012-06-22 16:30:09 -07002692 int result;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002693#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07002694
Larry Hastings9cf065c2012-06-22 16:30:09 -07002695#ifndef HAVE_FACCESSAT
2696 if (follow_symlinks_specified("access", follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10002697 return -1;
Larry Hastings9cf065c2012-06-22 16:30:09 -07002698
2699 if (effective_ids) {
2700 argument_unavailable_error("access", "effective_ids");
Larry Hastings2f936352014-08-05 14:04:04 +10002701 return -1;
Larry Hastings9cf065c2012-06-22 16:30:09 -07002702 }
2703#endif
2704
2705#ifdef MS_WINDOWS
2706 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07002707 attr = GetFileAttributesW(path->wide);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002708 Py_END_ALLOW_THREADS
2709
2710 /*
Georg Brandlf7875592012-06-24 13:58:31 +02002711 * Access is possible if
Larry Hastings9cf065c2012-06-22 16:30:09 -07002712 * * we didn't get a -1, and
2713 * * write access wasn't requested,
2714 * * or the file isn't read-only,
2715 * * or it's a directory.
2716 * (Directories cannot be read-only on Windows.)
2717 */
Larry Hastings2f936352014-08-05 14:04:04 +10002718 return_value = (attr != INVALID_FILE_ATTRIBUTES) &&
Georg Brandl5bb7aa92012-06-23 12:48:40 +02002719 (!(mode & 2) ||
Larry Hastings9cf065c2012-06-22 16:30:09 -07002720 !(attr & FILE_ATTRIBUTE_READONLY) ||
Larry Hastings2f936352014-08-05 14:04:04 +10002721 (attr & FILE_ATTRIBUTE_DIRECTORY));
Larry Hastings9cf065c2012-06-22 16:30:09 -07002722#else
2723
2724 Py_BEGIN_ALLOW_THREADS
2725#ifdef HAVE_FACCESSAT
2726 if ((dir_fd != DEFAULT_DIR_FD) ||
2727 effective_ids ||
2728 !follow_symlinks) {
2729 int flags = 0;
2730 if (!follow_symlinks)
2731 flags |= AT_SYMLINK_NOFOLLOW;
2732 if (effective_ids)
2733 flags |= AT_EACCESS;
Larry Hastings31826802013-10-19 00:09:25 -07002734 result = faccessat(dir_fd, path->narrow, mode, flags);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002735 }
2736 else
2737#endif
Larry Hastings31826802013-10-19 00:09:25 -07002738 result = access(path->narrow, mode);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002739 Py_END_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10002740 return_value = !result;
Larry Hastings9cf065c2012-06-22 16:30:09 -07002741#endif
2742
Larry Hastings9cf065c2012-06-22 16:30:09 -07002743 return return_value;
Guido van Rossum94f6f721999-01-06 18:42:14 +00002744}
2745
Guido van Rossumd371ff11999-01-25 16:12:23 +00002746#ifndef F_OK
2747#define F_OK 0
2748#endif
2749#ifndef R_OK
2750#define R_OK 4
2751#endif
2752#ifndef W_OK
2753#define W_OK 2
2754#endif
2755#ifndef X_OK
2756#define X_OK 1
2757#endif
2758
Larry Hastings31826802013-10-19 00:09:25 -07002759
Guido van Rossumd371ff11999-01-25 16:12:23 +00002760#ifdef HAVE_TTYNAME
Larry Hastings61272b72014-01-07 12:41:53 -08002761/*[clinic input]
Serhiy Storchaka4db62e12018-12-17 16:47:45 +02002762os.ttyname
Larry Hastings31826802013-10-19 00:09:25 -07002763
2764 fd: int
2765 Integer file descriptor handle.
2766
2767 /
2768
2769Return the name of the terminal device connected to 'fd'.
Larry Hastings61272b72014-01-07 12:41:53 -08002770[clinic start generated code]*/
Larry Hastings31826802013-10-19 00:09:25 -07002771
Serhiy Storchaka4db62e12018-12-17 16:47:45 +02002772static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002773os_ttyname_impl(PyObject *module, int fd)
Serhiy Storchaka4db62e12018-12-17 16:47:45 +02002774/*[clinic end generated code: output=c424d2e9d1cd636a input=9ff5a58b08115c55]*/
Larry Hastings31826802013-10-19 00:09:25 -07002775{
2776 char *ret;
Guido van Rossum94f6f721999-01-06 18:42:14 +00002777
Larry Hastings31826802013-10-19 00:09:25 -07002778 ret = ttyname(fd);
Serhiy Storchaka4db62e12018-12-17 16:47:45 +02002779 if (ret == NULL) {
2780 return posix_error();
2781 }
2782 return PyUnicode_DecodeFSDefault(ret);
Guido van Rossum94f6f721999-01-06 18:42:14 +00002783}
Guido van Rossumd371ff11999-01-25 16:12:23 +00002784#endif
Guido van Rossum94f6f721999-01-06 18:42:14 +00002785
Fred Drake5ab8eaf1999-12-09 21:13:07 +00002786#ifdef HAVE_CTERMID
Larry Hastings2f936352014-08-05 14:04:04 +10002787/*[clinic input]
2788os.ctermid
2789
2790Return the name of the controlling terminal for this process.
2791[clinic start generated code]*/
2792
Larry Hastings2f936352014-08-05 14:04:04 +10002793static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002794os_ctermid_impl(PyObject *module)
2795/*[clinic end generated code: output=02f017e6c9e620db input=3b87fdd52556382d]*/
Fred Drake5ab8eaf1999-12-09 21:13:07 +00002796{
Victor Stinner8c62be82010-05-06 00:08:46 +00002797 char *ret;
2798 char buffer[L_ctermid];
Fred Drake5ab8eaf1999-12-09 21:13:07 +00002799
Greg Wardb48bc172000-03-01 21:51:56 +00002800#ifdef USE_CTERMID_R
Victor Stinner8c62be82010-05-06 00:08:46 +00002801 ret = ctermid_r(buffer);
Fred Drake5ab8eaf1999-12-09 21:13:07 +00002802#else
Victor Stinner8c62be82010-05-06 00:08:46 +00002803 ret = ctermid(buffer);
Fred Drake5ab8eaf1999-12-09 21:13:07 +00002804#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00002805 if (ret == NULL)
2806 return posix_error();
Victor Stinner5fe6de82010-08-15 09:12:51 +00002807 return PyUnicode_DecodeFSDefault(buffer);
Fred Drake5ab8eaf1999-12-09 21:13:07 +00002808}
Larry Hastings2f936352014-08-05 14:04:04 +10002809#endif /* HAVE_CTERMID */
Fred Drake5ab8eaf1999-12-09 21:13:07 +00002810
Larry Hastings2f936352014-08-05 14:04:04 +10002811
2812/*[clinic input]
2813os.chdir
2814
2815 path: path_t(allow_fd='PATH_HAVE_FCHDIR')
2816
2817Change the current working directory to the specified path.
2818
2819path may always be specified as a string.
2820On some platforms, path may also be specified as an open file descriptor.
2821 If this functionality is unavailable, using it raises an exception.
2822[clinic start generated code]*/
2823
Larry Hastings2f936352014-08-05 14:04:04 +10002824static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002825os_chdir_impl(PyObject *module, path_t *path)
2826/*[clinic end generated code: output=3be6400eee26eaae input=1a4a15b4d12cb15d]*/
Larry Hastings2f936352014-08-05 14:04:04 +10002827{
2828 int result;
Larry Hastings9cf065c2012-06-22 16:30:09 -07002829
Steve Dowera00b5be2020-02-13 08:30:27 +00002830 if (PySys_Audit("os.chdir", "(O)", path->object) < 0) {
2831 return NULL;
2832 }
2833
Larry Hastings9cf065c2012-06-22 16:30:09 -07002834 Py_BEGIN_ALLOW_THREADS
2835#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07002836 /* on unix, success = 0, on windows, success = !0 */
2837 result = !win32_wchdir(path->wide);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002838#else
2839#ifdef HAVE_FCHDIR
Larry Hastings2f936352014-08-05 14:04:04 +10002840 if (path->fd != -1)
2841 result = fchdir(path->fd);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002842 else
2843#endif
Larry Hastings2f936352014-08-05 14:04:04 +10002844 result = chdir(path->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002845#endif
2846 Py_END_ALLOW_THREADS
2847
2848 if (result) {
Larry Hastings2f936352014-08-05 14:04:04 +10002849 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002850 }
2851
Larry Hastings2f936352014-08-05 14:04:04 +10002852 Py_RETURN_NONE;
2853}
2854
2855
2856#ifdef HAVE_FCHDIR
2857/*[clinic input]
2858os.fchdir
2859
2860 fd: fildes
2861
2862Change to the directory of the given file descriptor.
2863
2864fd must be opened on a directory, not a file.
2865Equivalent to os.chdir(fd).
2866
2867[clinic start generated code]*/
2868
Fred Drake4d1e64b2002-04-15 19:40:07 +00002869static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002870os_fchdir_impl(PyObject *module, int fd)
2871/*[clinic end generated code: output=42e064ec4dc00ab0 input=18e816479a2fa985]*/
Fred Drake4d1e64b2002-04-15 19:40:07 +00002872{
Steve Dowera00b5be2020-02-13 08:30:27 +00002873 if (PySys_Audit("os.chdir", "(i)", fd) < 0) {
2874 return NULL;
2875 }
Larry Hastings2f936352014-08-05 14:04:04 +10002876 return posix_fildes_fd(fd, fchdir);
Fred Drake4d1e64b2002-04-15 19:40:07 +00002877}
2878#endif /* HAVE_FCHDIR */
2879
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00002880
Larry Hastings2f936352014-08-05 14:04:04 +10002881/*[clinic input]
2882os.chmod
2883
2884 path: path_t(allow_fd='PATH_HAVE_FCHMOD')
BNMetricsb9427072018-11-02 15:20:19 +00002885 Path to be modified. May always be specified as a str, bytes, or a path-like object.
Larry Hastings2f936352014-08-05 14:04:04 +10002886 On some platforms, path may also be specified as an open file descriptor.
2887 If this functionality is unavailable, using it raises an exception.
2888
2889 mode: int
2890 Operating-system mode bitfield.
2891
2892 *
2893
2894 dir_fd : dir_fd(requires='fchmodat') = None
2895 If not None, it should be a file descriptor open to a directory,
2896 and path should be relative; path will then be relative to that
2897 directory.
2898
2899 follow_symlinks: bool = True
2900 If False, and the last element of the path is a symbolic link,
2901 chmod will modify the symbolic link itself instead of the file
2902 the link points to.
2903
2904Change the access permissions of a file.
2905
2906It is an error to use dir_fd or follow_symlinks when specifying path as
2907 an open file descriptor.
2908dir_fd and follow_symlinks may not be implemented on your platform.
2909 If they are unavailable, using them will raise a NotImplementedError.
2910
2911[clinic start generated code]*/
2912
Larry Hastings2f936352014-08-05 14:04:04 +10002913static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002914os_chmod_impl(PyObject *module, path_t *path, int mode, int dir_fd,
Larry Hastings89964c42015-04-14 18:07:59 -04002915 int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +00002916/*[clinic end generated code: output=5cf6a94915cc7bff input=989081551c00293b]*/
Larry Hastings2f936352014-08-05 14:04:04 +10002917{
Larry Hastings9cf065c2012-06-22 16:30:09 -07002918 int result;
Larry Hastings9cf065c2012-06-22 16:30:09 -07002919
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00002920#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00002921 DWORD attr;
Larry Hastings9cf065c2012-06-22 16:30:09 -07002922#endif
Hirokazu Yamamoto892a37a2009-06-28 11:07:03 +00002923
Larry Hastings9cf065c2012-06-22 16:30:09 -07002924#ifdef HAVE_FCHMODAT
2925 int fchmodat_nofollow_unsupported = 0;
2926#endif
2927
Larry Hastings9cf065c2012-06-22 16:30:09 -07002928#if !(defined(HAVE_FCHMODAT) || defined(HAVE_LCHMOD))
2929 if (follow_symlinks_specified("chmod", follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10002930 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07002931#endif
2932
Steve Dowera00b5be2020-02-13 08:30:27 +00002933 if (PySys_Audit("os.chmod", "Oii", path->object, mode,
2934 dir_fd == DEFAULT_DIR_FD ? -1 : dir_fd) < 0) {
2935 return NULL;
2936 }
2937
Larry Hastings9cf065c2012-06-22 16:30:09 -07002938#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00002939 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07002940 attr = GetFileAttributesW(path->wide);
Tim Golden23005082013-10-25 11:22:37 +01002941 if (attr == INVALID_FILE_ATTRIBUTES)
Larry Hastings9cf065c2012-06-22 16:30:09 -07002942 result = 0;
2943 else {
2944 if (mode & _S_IWRITE)
Victor Stinner8c62be82010-05-06 00:08:46 +00002945 attr &= ~FILE_ATTRIBUTE_READONLY;
2946 else
2947 attr |= FILE_ATTRIBUTE_READONLY;
Steve Dowercc16be82016-09-08 10:35:16 -07002948 result = SetFileAttributesW(path->wide, attr);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002949 }
2950 Py_END_ALLOW_THREADS
2951
2952 if (!result) {
Larry Hastings2f936352014-08-05 14:04:04 +10002953 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002954 }
2955#else /* MS_WINDOWS */
2956 Py_BEGIN_ALLOW_THREADS
2957#ifdef HAVE_FCHMOD
Larry Hastings2f936352014-08-05 14:04:04 +10002958 if (path->fd != -1)
2959 result = fchmod(path->fd, mode);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002960 else
2961#endif
2962#ifdef HAVE_LCHMOD
2963 if ((!follow_symlinks) && (dir_fd == DEFAULT_DIR_FD))
Larry Hastings2f936352014-08-05 14:04:04 +10002964 result = lchmod(path->narrow, mode);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002965 else
2966#endif
2967#ifdef HAVE_FCHMODAT
2968 if ((dir_fd != DEFAULT_DIR_FD) || !follow_symlinks) {
2969 /*
2970 * fchmodat() doesn't currently support AT_SYMLINK_NOFOLLOW!
2971 * The documentation specifically shows how to use it,
Larry Hastingsdbbc0c82012-06-22 19:50:21 -07002972 * and then says it isn't implemented yet.
2973 * (true on linux with glibc 2.15, and openindiana 3.x)
Larry Hastings9cf065c2012-06-22 16:30:09 -07002974 *
2975 * Once it is supported, os.chmod will automatically
2976 * support dir_fd and follow_symlinks=False. (Hopefully.)
2977 * Until then, we need to be careful what exception we raise.
2978 */
Larry Hastings2f936352014-08-05 14:04:04 +10002979 result = fchmodat(dir_fd, path->narrow, mode,
Larry Hastings9cf065c2012-06-22 16:30:09 -07002980 follow_symlinks ? 0 : AT_SYMLINK_NOFOLLOW);
2981 /*
2982 * But wait! We can't throw the exception without allowing threads,
2983 * and we can't do that in this nested scope. (Macro trickery, sigh.)
2984 */
2985 fchmodat_nofollow_unsupported =
Larry Hastingsdbbc0c82012-06-22 19:50:21 -07002986 result &&
2987 ((errno == ENOTSUP) || (errno == EOPNOTSUPP)) &&
2988 !follow_symlinks;
Victor Stinner8c62be82010-05-06 00:08:46 +00002989 }
2990 else
Thomas Wouters477c8d52006-05-27 19:21:47 +00002991#endif
Larry Hastings2f936352014-08-05 14:04:04 +10002992 result = chmod(path->narrow, mode);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002993 Py_END_ALLOW_THREADS
2994
2995 if (result) {
2996#ifdef HAVE_FCHMODAT
2997 if (fchmodat_nofollow_unsupported) {
2998 if (dir_fd != DEFAULT_DIR_FD)
2999 dir_fd_and_follow_symlinks_invalid("chmod",
3000 dir_fd, follow_symlinks);
3001 else
3002 follow_symlinks_specified("chmod", follow_symlinks);
Anthony Sottile233ef242017-12-14 08:57:55 -08003003 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003004 }
3005 else
3006#endif
Larry Hastings2f936352014-08-05 14:04:04 +10003007 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003008 }
3009#endif
3010
Larry Hastings2f936352014-08-05 14:04:04 +10003011 Py_RETURN_NONE;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003012}
3013
Larry Hastings9cf065c2012-06-22 16:30:09 -07003014
Christian Heimes4e30a842007-11-30 22:12:06 +00003015#ifdef HAVE_FCHMOD
Larry Hastings2f936352014-08-05 14:04:04 +10003016/*[clinic input]
3017os.fchmod
3018
3019 fd: int
3020 mode: int
3021
3022Change the access permissions of the file given by file descriptor fd.
3023
3024Equivalent to os.chmod(fd, mode).
3025[clinic start generated code]*/
3026
Larry Hastings2f936352014-08-05 14:04:04 +10003027static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003028os_fchmod_impl(PyObject *module, int fd, int mode)
3029/*[clinic end generated code: output=afd9bc05b4e426b3 input=8ab11975ca01ee5b]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003030{
3031 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003032 int async_err = 0;
3033
Steve Dowera00b5be2020-02-13 08:30:27 +00003034 if (PySys_Audit("os.chmod", "iii", fd, mode, -1) < 0) {
3035 return NULL;
3036 }
3037
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003038 do {
3039 Py_BEGIN_ALLOW_THREADS
3040 res = fchmod(fd, mode);
3041 Py_END_ALLOW_THREADS
3042 } while (res != 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
3043 if (res != 0)
3044 return (!async_err) ? posix_error() : NULL;
3045
Victor Stinner8c62be82010-05-06 00:08:46 +00003046 Py_RETURN_NONE;
Christian Heimes4e30a842007-11-30 22:12:06 +00003047}
3048#endif /* HAVE_FCHMOD */
3049
Larry Hastings2f936352014-08-05 14:04:04 +10003050
Christian Heimes4e30a842007-11-30 22:12:06 +00003051#ifdef HAVE_LCHMOD
Larry Hastings2f936352014-08-05 14:04:04 +10003052/*[clinic input]
3053os.lchmod
3054
3055 path: path_t
3056 mode: int
3057
3058Change the access permissions of a file, without following symbolic links.
3059
3060If path is a symlink, this affects the link itself rather than the target.
3061Equivalent to chmod(path, mode, follow_symlinks=False)."
3062[clinic start generated code]*/
3063
Larry Hastings2f936352014-08-05 14:04:04 +10003064static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003065os_lchmod_impl(PyObject *module, path_t *path, int mode)
3066/*[clinic end generated code: output=082344022b51a1d5 input=90c5663c7465d24f]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003067{
Victor Stinner8c62be82010-05-06 00:08:46 +00003068 int res;
Steve Dowera00b5be2020-02-13 08:30:27 +00003069 if (PySys_Audit("os.chmod", "Oii", path->object, mode, -1) < 0) {
3070 return NULL;
3071 }
Victor Stinner8c62be82010-05-06 00:08:46 +00003072 Py_BEGIN_ALLOW_THREADS
Larry Hastingsb1dc1122014-08-05 16:06:16 +10003073 res = lchmod(path->narrow, mode);
Victor Stinner8c62be82010-05-06 00:08:46 +00003074 Py_END_ALLOW_THREADS
Victor Stinner292c8352012-10-30 02:17:38 +01003075 if (res < 0) {
Larry Hastings2f936352014-08-05 14:04:04 +10003076 path_error(path);
Victor Stinner292c8352012-10-30 02:17:38 +01003077 return NULL;
3078 }
Victor Stinner8c62be82010-05-06 00:08:46 +00003079 Py_RETURN_NONE;
Christian Heimes4e30a842007-11-30 22:12:06 +00003080}
3081#endif /* HAVE_LCHMOD */
3082
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00003083
Thomas Wouterscf297e42007-02-23 15:07:44 +00003084#ifdef HAVE_CHFLAGS
Larry Hastings2f936352014-08-05 14:04:04 +10003085/*[clinic input]
3086os.chflags
3087
3088 path: path_t
3089 flags: unsigned_long(bitwise=True)
3090 follow_symlinks: bool=True
3091
3092Set file flags.
3093
3094If follow_symlinks is False, and the last element of the path is a symbolic
3095 link, chflags will change flags on the symbolic link itself instead of the
3096 file the link points to.
3097follow_symlinks may not be implemented on your platform. If it is
3098unavailable, using it will raise a NotImplementedError.
3099
3100[clinic start generated code]*/
3101
Larry Hastings2f936352014-08-05 14:04:04 +10003102static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003103os_chflags_impl(PyObject *module, path_t *path, unsigned long flags,
Larry Hastings89964c42015-04-14 18:07:59 -04003104 int follow_symlinks)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003105/*[clinic end generated code: output=85571c6737661ce9 input=0327e29feb876236]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003106{
3107 int result;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003108
3109#ifndef HAVE_LCHFLAGS
3110 if (follow_symlinks_specified("chflags", follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10003111 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003112#endif
3113
Steve Dowera00b5be2020-02-13 08:30:27 +00003114 if (PySys_Audit("os.chflags", "Ok", path->object, flags) < 0) {
3115 return NULL;
3116 }
3117
Victor Stinner8c62be82010-05-06 00:08:46 +00003118 Py_BEGIN_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07003119#ifdef HAVE_LCHFLAGS
3120 if (!follow_symlinks)
Larry Hastings2f936352014-08-05 14:04:04 +10003121 result = lchflags(path->narrow, flags);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003122 else
3123#endif
Larry Hastings2f936352014-08-05 14:04:04 +10003124 result = chflags(path->narrow, flags);
Victor Stinner8c62be82010-05-06 00:08:46 +00003125 Py_END_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07003126
Larry Hastings2f936352014-08-05 14:04:04 +10003127 if (result)
3128 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003129
Larry Hastings2f936352014-08-05 14:04:04 +10003130 Py_RETURN_NONE;
Thomas Wouterscf297e42007-02-23 15:07:44 +00003131}
3132#endif /* HAVE_CHFLAGS */
3133
Larry Hastings2f936352014-08-05 14:04:04 +10003134
Thomas Wouterscf297e42007-02-23 15:07:44 +00003135#ifdef HAVE_LCHFLAGS
Larry Hastings2f936352014-08-05 14:04:04 +10003136/*[clinic input]
3137os.lchflags
3138
3139 path: path_t
3140 flags: unsigned_long(bitwise=True)
3141
3142Set file flags.
3143
3144This function will not follow symbolic links.
3145Equivalent to chflags(path, flags, follow_symlinks=False).
3146[clinic start generated code]*/
3147
Larry Hastings2f936352014-08-05 14:04:04 +10003148static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003149os_lchflags_impl(PyObject *module, path_t *path, unsigned long flags)
3150/*[clinic end generated code: output=30ae958695c07316 input=f9f82ea8b585ca9d]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003151{
Victor Stinner8c62be82010-05-06 00:08:46 +00003152 int res;
Steve Dowera00b5be2020-02-13 08:30:27 +00003153 if (PySys_Audit("os.chflags", "Ok", path->object, flags) < 0) {
3154 return NULL;
3155 }
Victor Stinner8c62be82010-05-06 00:08:46 +00003156 Py_BEGIN_ALLOW_THREADS
Larry Hastingsb1dc1122014-08-05 16:06:16 +10003157 res = lchflags(path->narrow, flags);
Victor Stinner8c62be82010-05-06 00:08:46 +00003158 Py_END_ALLOW_THREADS
Victor Stinner292c8352012-10-30 02:17:38 +01003159 if (res < 0) {
Larry Hastings2f936352014-08-05 14:04:04 +10003160 return path_error(path);
Victor Stinner292c8352012-10-30 02:17:38 +01003161 }
Victor Stinner292c8352012-10-30 02:17:38 +01003162 Py_RETURN_NONE;
Thomas Wouterscf297e42007-02-23 15:07:44 +00003163}
3164#endif /* HAVE_LCHFLAGS */
3165
Larry Hastings2f936352014-08-05 14:04:04 +10003166
Martin v. Löwis244edc82001-10-04 22:44:26 +00003167#ifdef HAVE_CHROOT
Larry Hastings2f936352014-08-05 14:04:04 +10003168/*[clinic input]
3169os.chroot
3170 path: path_t
3171
3172Change root directory to path.
3173
3174[clinic start generated code]*/
3175
Larry Hastings2f936352014-08-05 14:04:04 +10003176static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003177os_chroot_impl(PyObject *module, path_t *path)
3178/*[clinic end generated code: output=de80befc763a4475 input=14822965652c3dc3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003179{
3180 int res;
3181 Py_BEGIN_ALLOW_THREADS
3182 res = chroot(path->narrow);
3183 Py_END_ALLOW_THREADS
3184 if (res < 0)
3185 return path_error(path);
3186 Py_RETURN_NONE;
3187}
3188#endif /* HAVE_CHROOT */
3189
Martin v. Löwis244edc82001-10-04 22:44:26 +00003190
Guido van Rossum21142a01999-01-08 21:05:37 +00003191#ifdef HAVE_FSYNC
Larry Hastings2f936352014-08-05 14:04:04 +10003192/*[clinic input]
3193os.fsync
3194
3195 fd: fildes
3196
3197Force write of fd to disk.
3198[clinic start generated code]*/
3199
Larry Hastings2f936352014-08-05 14:04:04 +10003200static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003201os_fsync_impl(PyObject *module, int fd)
3202/*[clinic end generated code: output=4a10d773f52b3584 input=21c3645c056967f2]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003203{
3204 return posix_fildes_fd(fd, fsync);
Guido van Rossum21142a01999-01-08 21:05:37 +00003205}
3206#endif /* HAVE_FSYNC */
3207
Larry Hastings2f936352014-08-05 14:04:04 +10003208
Ross Lagerwall7807c352011-03-17 20:20:30 +02003209#ifdef HAVE_SYNC
Larry Hastings2f936352014-08-05 14:04:04 +10003210/*[clinic input]
3211os.sync
3212
3213Force write of everything to disk.
3214[clinic start generated code]*/
3215
Larry Hastings2f936352014-08-05 14:04:04 +10003216static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003217os_sync_impl(PyObject *module)
3218/*[clinic end generated code: output=2796b1f0818cd71c input=84749fe5e9b404ff]*/
Ross Lagerwall7807c352011-03-17 20:20:30 +02003219{
3220 Py_BEGIN_ALLOW_THREADS
3221 sync();
3222 Py_END_ALLOW_THREADS
3223 Py_RETURN_NONE;
3224}
Larry Hastings2f936352014-08-05 14:04:04 +10003225#endif /* HAVE_SYNC */
3226
Ross Lagerwall7807c352011-03-17 20:20:30 +02003227
Guido van Rossum21142a01999-01-08 21:05:37 +00003228#ifdef HAVE_FDATASYNC
Guido van Rossum7f58e2e2000-09-22 17:26:14 +00003229#ifdef __hpux
Guido van Rossumecc23b02000-09-22 16:01:05 +00003230extern int fdatasync(int); /* On HP-UX, in libc but not in unistd.h */
3231#endif
3232
Larry Hastings2f936352014-08-05 14:04:04 +10003233/*[clinic input]
3234os.fdatasync
3235
3236 fd: fildes
3237
3238Force write of fd to disk without forcing update of metadata.
3239[clinic start generated code]*/
3240
Larry Hastings2f936352014-08-05 14:04:04 +10003241static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003242os_fdatasync_impl(PyObject *module, int fd)
3243/*[clinic end generated code: output=b4b9698b5d7e26dd input=bc74791ee54dd291]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003244{
3245 return posix_fildes_fd(fd, fdatasync);
Guido van Rossum21142a01999-01-08 21:05:37 +00003246}
3247#endif /* HAVE_FDATASYNC */
3248
3249
Fredrik Lundh10723342000-07-10 16:38:09 +00003250#ifdef HAVE_CHOWN
Larry Hastings2f936352014-08-05 14:04:04 +10003251/*[clinic input]
3252os.chown
3253
3254 path : path_t(allow_fd='PATH_HAVE_FCHOWN')
BNMetricsb9427072018-11-02 15:20:19 +00003255 Path to be examined; can be string, bytes, a path-like object, or open-file-descriptor int.
Larry Hastings2f936352014-08-05 14:04:04 +10003256
3257 uid: uid_t
3258
3259 gid: gid_t
3260
3261 *
3262
3263 dir_fd : dir_fd(requires='fchownat') = None
3264 If not None, it should be a file descriptor open to a directory,
3265 and path should be relative; path will then be relative to that
3266 directory.
3267
3268 follow_symlinks: bool = True
3269 If False, and the last element of the path is a symbolic link,
3270 stat will examine the symbolic link itself instead of the file
3271 the link points to.
3272
3273Change the owner and group id of path to the numeric uid and gid.\
3274
3275path may always be specified as a string.
3276On some platforms, path may also be specified as an open file descriptor.
3277 If this functionality is unavailable, using it raises an exception.
3278If dir_fd is not None, it should be a file descriptor open to a directory,
3279 and path should be relative; path will then be relative to that directory.
3280If follow_symlinks is False, and the last element of the path is a symbolic
3281 link, chown will modify the symbolic link itself instead of the file the
3282 link points to.
3283It is an error to use dir_fd or follow_symlinks when specifying path as
3284 an open file descriptor.
3285dir_fd and follow_symlinks may not be implemented on your platform.
3286 If they are unavailable, using them will raise a NotImplementedError.
3287
3288[clinic start generated code]*/
3289
Larry Hastings2f936352014-08-05 14:04:04 +10003290static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003291os_chown_impl(PyObject *module, path_t *path, uid_t uid, gid_t gid,
Larry Hastings89964c42015-04-14 18:07:59 -04003292 int dir_fd, int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +00003293/*[clinic end generated code: output=4beadab0db5f70cd input=b08c5ec67996a97d]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003294{
3295 int result;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003296
3297#if !(defined(HAVE_LCHOWN) || defined(HAVE_FCHOWNAT))
3298 if (follow_symlinks_specified("chown", follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10003299 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003300#endif
Larry Hastings2f936352014-08-05 14:04:04 +10003301 if (dir_fd_and_fd_invalid("chown", dir_fd, path->fd) ||
3302 fd_and_follow_symlinks_invalid("chown", path->fd, follow_symlinks))
3303 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003304
3305#ifdef __APPLE__
3306 /*
3307 * This is for Mac OS X 10.3, which doesn't have lchown.
3308 * (But we still have an lchown symbol because of weak-linking.)
3309 * It doesn't have fchownat either. So there's no possibility
3310 * of a graceful failover.
Georg Brandlf7875592012-06-24 13:58:31 +02003311 */
Larry Hastings9cf065c2012-06-22 16:30:09 -07003312 if ((!follow_symlinks) && (lchown == NULL)) {
3313 follow_symlinks_specified("chown", follow_symlinks);
Larry Hastings2f936352014-08-05 14:04:04 +10003314 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003315 }
3316#endif
3317
Steve Dowera00b5be2020-02-13 08:30:27 +00003318 if (PySys_Audit("os.chown", "OIIi", path->object, uid, gid,
3319 dir_fd == DEFAULT_DIR_FD ? -1 : dir_fd) < 0) {
3320 return NULL;
3321 }
3322
Victor Stinner8c62be82010-05-06 00:08:46 +00003323 Py_BEGIN_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07003324#ifdef HAVE_FCHOWN
Larry Hastings2f936352014-08-05 14:04:04 +10003325 if (path->fd != -1)
3326 result = fchown(path->fd, uid, gid);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003327 else
3328#endif
3329#ifdef HAVE_LCHOWN
3330 if ((!follow_symlinks) && (dir_fd == DEFAULT_DIR_FD))
Larry Hastings2f936352014-08-05 14:04:04 +10003331 result = lchown(path->narrow, uid, gid);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003332 else
3333#endif
3334#ifdef HAVE_FCHOWNAT
3335 if ((dir_fd != DEFAULT_DIR_FD) || (!follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10003336 result = fchownat(dir_fd, path->narrow, uid, gid,
Larry Hastings9cf065c2012-06-22 16:30:09 -07003337 follow_symlinks ? 0 : AT_SYMLINK_NOFOLLOW);
3338 else
3339#endif
Larry Hastings2f936352014-08-05 14:04:04 +10003340 result = chown(path->narrow, uid, gid);
Victor Stinner8c62be82010-05-06 00:08:46 +00003341 Py_END_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07003342
Larry Hastings2f936352014-08-05 14:04:04 +10003343 if (result)
3344 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003345
Larry Hastings2f936352014-08-05 14:04:04 +10003346 Py_RETURN_NONE;
Guido van Rossumb6775db1994-08-01 11:34:53 +00003347}
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00003348#endif /* HAVE_CHOWN */
Guido van Rossumb6775db1994-08-01 11:34:53 +00003349
Larry Hastings2f936352014-08-05 14:04:04 +10003350
Christian Heimes4e30a842007-11-30 22:12:06 +00003351#ifdef HAVE_FCHOWN
Larry Hastings2f936352014-08-05 14:04:04 +10003352/*[clinic input]
3353os.fchown
3354
3355 fd: int
3356 uid: uid_t
3357 gid: gid_t
3358
3359Change the owner and group id of the file specified by file descriptor.
3360
3361Equivalent to os.chown(fd, uid, gid).
3362
3363[clinic start generated code]*/
3364
Larry Hastings2f936352014-08-05 14:04:04 +10003365static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003366os_fchown_impl(PyObject *module, int fd, uid_t uid, gid_t gid)
3367/*[clinic end generated code: output=97d21cbd5a4350a6 input=3af544ba1b13a0d7]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003368{
Victor Stinner8c62be82010-05-06 00:08:46 +00003369 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003370 int async_err = 0;
3371
Steve Dowera00b5be2020-02-13 08:30:27 +00003372 if (PySys_Audit("os.chown", "iIIi", fd, uid, gid, -1) < 0) {
3373 return NULL;
3374 }
3375
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003376 do {
3377 Py_BEGIN_ALLOW_THREADS
3378 res = fchown(fd, uid, gid);
3379 Py_END_ALLOW_THREADS
3380 } while (res != 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
3381 if (res != 0)
3382 return (!async_err) ? posix_error() : NULL;
3383
Victor Stinner8c62be82010-05-06 00:08:46 +00003384 Py_RETURN_NONE;
Christian Heimes4e30a842007-11-30 22:12:06 +00003385}
3386#endif /* HAVE_FCHOWN */
3387
Larry Hastings2f936352014-08-05 14:04:04 +10003388
Martin v. Löwis0cec0ff2002-07-28 16:33:45 +00003389#ifdef HAVE_LCHOWN
Larry Hastings2f936352014-08-05 14:04:04 +10003390/*[clinic input]
3391os.lchown
3392
3393 path : path_t
3394 uid: uid_t
3395 gid: gid_t
3396
3397Change the owner and group id of path to the numeric uid and gid.
3398
3399This function will not follow symbolic links.
3400Equivalent to os.chown(path, uid, gid, follow_symlinks=False).
3401[clinic start generated code]*/
3402
Larry Hastings2f936352014-08-05 14:04:04 +10003403static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003404os_lchown_impl(PyObject *module, path_t *path, uid_t uid, gid_t gid)
3405/*[clinic end generated code: output=25eaf6af412fdf2f input=b1c6014d563a7161]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003406{
Victor Stinner8c62be82010-05-06 00:08:46 +00003407 int res;
Steve Dowera00b5be2020-02-13 08:30:27 +00003408 if (PySys_Audit("os.chown", "OIIi", path->object, uid, gid, -1) < 0) {
3409 return NULL;
3410 }
Victor Stinner8c62be82010-05-06 00:08:46 +00003411 Py_BEGIN_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10003412 res = lchown(path->narrow, uid, gid);
Victor Stinner8c62be82010-05-06 00:08:46 +00003413 Py_END_ALLOW_THREADS
Victor Stinner292c8352012-10-30 02:17:38 +01003414 if (res < 0) {
Larry Hastings2f936352014-08-05 14:04:04 +10003415 return path_error(path);
Victor Stinner292c8352012-10-30 02:17:38 +01003416 }
Larry Hastings2f936352014-08-05 14:04:04 +10003417 Py_RETURN_NONE;
Martin v. Löwis0cec0ff2002-07-28 16:33:45 +00003418}
3419#endif /* HAVE_LCHOWN */
3420
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00003421
Barry Warsaw53699e91996-12-10 23:23:01 +00003422static PyObject *
Guido van Rossumf0af3e32008-10-02 18:55:37 +00003423posix_getcwd(int use_bytes)
Mark Hammondc2e85bd2002-10-03 05:10:39 +00003424{
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00003425#ifdef MS_WINDOWS
Miss Islington (bot)63429c82019-06-26 09:14:30 -07003426 wchar_t wbuf[MAXPATHLEN];
3427 wchar_t *wbuf2 = wbuf;
3428 DWORD len;
3429
3430 Py_BEGIN_ALLOW_THREADS
3431 len = GetCurrentDirectoryW(Py_ARRAY_LENGTH(wbuf), wbuf);
3432 /* If the buffer is large enough, len does not include the
3433 terminating \0. If the buffer is too small, len includes
3434 the space needed for the terminator. */
3435 if (len >= Py_ARRAY_LENGTH(wbuf)) {
Miss Islington (bot)68c1c392019-06-28 09:23:06 -07003436 if (len <= PY_SSIZE_T_MAX / sizeof(wchar_t)) {
Victor Stinnerb6404912013-07-07 16:21:41 +02003437 wbuf2 = PyMem_RawMalloc(len * sizeof(wchar_t));
Victor Stinner8c62be82010-05-06 00:08:46 +00003438 }
Miss Islington (bot)63429c82019-06-26 09:14:30 -07003439 else {
3440 wbuf2 = NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00003441 }
Miss Islington (bot)63429c82019-06-26 09:14:30 -07003442 if (wbuf2) {
3443 len = GetCurrentDirectoryW(len, wbuf2);
Victor Stinner8c62be82010-05-06 00:08:46 +00003444 }
Miss Islington (bot)63429c82019-06-26 09:14:30 -07003445 }
3446 Py_END_ALLOW_THREADS
3447
3448 if (!wbuf2) {
3449 PyErr_NoMemory();
3450 return NULL;
3451 }
3452 if (!len) {
Victor Stinnerb024e842012-10-31 22:24:06 +01003453 if (wbuf2 != wbuf)
Victor Stinnerb6404912013-07-07 16:21:41 +02003454 PyMem_RawFree(wbuf2);
Miss Islington (bot)63429c82019-06-26 09:14:30 -07003455 return PyErr_SetFromWindowsErr(0);
Victor Stinner8c62be82010-05-06 00:08:46 +00003456 }
Victor Stinnerf7c5ae22011-11-16 23:43:07 +01003457
Miss Islington (bot)63429c82019-06-26 09:14:30 -07003458 PyObject *resobj = PyUnicode_FromWideChar(wbuf2, len);
3459 if (wbuf2 != wbuf) {
3460 PyMem_RawFree(wbuf2);
3461 }
Mark Hammondc2e85bd2002-10-03 05:10:39 +00003462
Miss Islington (bot)63429c82019-06-26 09:14:30 -07003463 if (use_bytes) {
3464 if (resobj == NULL) {
3465 return NULL;
3466 }
3467 Py_SETREF(resobj, PyUnicode_EncodeFSDefault(resobj));
3468 }
3469
3470 return resobj;
3471#else
3472 const size_t chunk = 1024;
3473
3474 char *buf = NULL;
3475 char *cwd = NULL;
3476 size_t buflen = 0;
3477
Victor Stinner8c62be82010-05-06 00:08:46 +00003478 Py_BEGIN_ALLOW_THREADS
Victor Stinner4403d7d2015-04-25 00:16:10 +02003479 do {
Miss Islington (bot)63429c82019-06-26 09:14:30 -07003480 char *newbuf;
3481 if (buflen <= PY_SSIZE_T_MAX - chunk) {
3482 buflen += chunk;
3483 newbuf = PyMem_RawRealloc(buf, buflen);
3484 }
3485 else {
3486 newbuf = NULL;
3487 }
3488 if (newbuf == NULL) {
3489 PyMem_RawFree(buf);
3490 buf = NULL;
Victor Stinnerc44f7072016-03-14 18:07:53 +01003491 break;
3492 }
Miss Islington (bot)63429c82019-06-26 09:14:30 -07003493 buf = newbuf;
Victor Stinner4403d7d2015-04-25 00:16:10 +02003494
Victor Stinner4403d7d2015-04-25 00:16:10 +02003495 cwd = getcwd(buf, buflen);
3496 } while (cwd == NULL && errno == ERANGE);
Victor Stinner8c62be82010-05-06 00:08:46 +00003497 Py_END_ALLOW_THREADS
Victor Stinner4403d7d2015-04-25 00:16:10 +02003498
Miss Islington (bot)63429c82019-06-26 09:14:30 -07003499 if (buf == NULL) {
3500 return PyErr_NoMemory();
3501 }
Victor Stinner4403d7d2015-04-25 00:16:10 +02003502 if (cwd == NULL) {
3503 PyMem_RawFree(buf);
Victor Stinner8c62be82010-05-06 00:08:46 +00003504 return posix_error();
Victor Stinner4403d7d2015-04-25 00:16:10 +02003505 }
3506
Miss Islington (bot)63429c82019-06-26 09:14:30 -07003507 PyObject *obj;
3508 if (use_bytes) {
Victor Stinner4403d7d2015-04-25 00:16:10 +02003509 obj = PyBytes_FromStringAndSize(buf, strlen(buf));
Miss Islington (bot)63429c82019-06-26 09:14:30 -07003510 }
3511 else {
Victor Stinner4403d7d2015-04-25 00:16:10 +02003512 obj = PyUnicode_DecodeFSDefault(buf);
Miss Islington (bot)63429c82019-06-26 09:14:30 -07003513 }
Victor Stinner4403d7d2015-04-25 00:16:10 +02003514 PyMem_RawFree(buf);
3515
3516 return obj;
Miss Islington (bot)63429c82019-06-26 09:14:30 -07003517#endif /* !MS_WINDOWS */
Mark Hammondc2e85bd2002-10-03 05:10:39 +00003518}
Guido van Rossumf0af3e32008-10-02 18:55:37 +00003519
Larry Hastings2f936352014-08-05 14:04:04 +10003520
3521/*[clinic input]
3522os.getcwd
3523
3524Return a unicode string representing the current working directory.
3525[clinic start generated code]*/
3526
Larry Hastings2f936352014-08-05 14:04:04 +10003527static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003528os_getcwd_impl(PyObject *module)
3529/*[clinic end generated code: output=21badfae2ea99ddc input=f069211bb70e3d39]*/
Guido van Rossumf0af3e32008-10-02 18:55:37 +00003530{
3531 return posix_getcwd(0);
3532}
3533
Larry Hastings2f936352014-08-05 14:04:04 +10003534
3535/*[clinic input]
3536os.getcwdb
3537
3538Return a bytes string representing the current working directory.
3539[clinic start generated code]*/
3540
Larry Hastings2f936352014-08-05 14:04:04 +10003541static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003542os_getcwdb_impl(PyObject *module)
3543/*[clinic end generated code: output=3dd47909480e4824 input=f6f6a378dad3d9cb]*/
Guido van Rossumf0af3e32008-10-02 18:55:37 +00003544{
3545 return posix_getcwd(1);
3546}
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003547
Larry Hastings2f936352014-08-05 14:04:04 +10003548
Larry Hastings9cf065c2012-06-22 16:30:09 -07003549#if ((!defined(HAVE_LINK)) && defined(MS_WINDOWS))
3550#define HAVE_LINK 1
3551#endif
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00003552
Guido van Rossumb6775db1994-08-01 11:34:53 +00003553#ifdef HAVE_LINK
Larry Hastings2f936352014-08-05 14:04:04 +10003554/*[clinic input]
3555
3556os.link
3557
3558 src : path_t
3559 dst : path_t
3560 *
3561 src_dir_fd : dir_fd = None
3562 dst_dir_fd : dir_fd = None
3563 follow_symlinks: bool = True
3564
3565Create a hard link to a file.
3566
3567If either src_dir_fd or dst_dir_fd is not None, it should be a file
3568 descriptor open to a directory, and the respective path string (src or dst)
3569 should be relative; the path will then be relative to that directory.
3570If follow_symlinks is False, and the last element of src is a symbolic
3571 link, link will create a link to the symbolic link itself instead of the
3572 file the link points to.
3573src_dir_fd, dst_dir_fd, and follow_symlinks may not be implemented on your
3574 platform. If they are unavailable, using them will raise a
3575 NotImplementedError.
3576[clinic start generated code]*/
3577
Larry Hastings2f936352014-08-05 14:04:04 +10003578static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003579os_link_impl(PyObject *module, path_t *src, path_t *dst, int src_dir_fd,
Larry Hastings89964c42015-04-14 18:07:59 -04003580 int dst_dir_fd, int follow_symlinks)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003581/*[clinic end generated code: output=7f00f6007fd5269a input=b0095ebbcbaa7e04]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003582{
Larry Hastings9cf065c2012-06-22 16:30:09 -07003583#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07003584 BOOL result = FALSE;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003585#else
3586 int result;
3587#endif
3588
Larry Hastings9cf065c2012-06-22 16:30:09 -07003589#ifndef HAVE_LINKAT
3590 if ((src_dir_fd != DEFAULT_DIR_FD) || (dst_dir_fd != DEFAULT_DIR_FD)) {
3591 argument_unavailable_error("link", "src_dir_fd and dst_dir_fd");
Larry Hastings2f936352014-08-05 14:04:04 +10003592 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003593 }
3594#endif
3595
Steve Dowercc16be82016-09-08 10:35:16 -07003596#ifndef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10003597 if ((src->narrow && dst->wide) || (src->wide && dst->narrow)) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07003598 PyErr_SetString(PyExc_NotImplementedError,
3599 "link: src and dst must be the same type");
Larry Hastings2f936352014-08-05 14:04:04 +10003600 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003601 }
Steve Dowercc16be82016-09-08 10:35:16 -07003602#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003603
Steve Dowera00b5be2020-02-13 08:30:27 +00003604 if (PySys_Audit("os.link", "OOii", src->object, dst->object,
3605 src_dir_fd == DEFAULT_DIR_FD ? -1 : src_dir_fd,
3606 dst_dir_fd == DEFAULT_DIR_FD ? -1 : dst_dir_fd) < 0) {
3607 return NULL;
3608 }
3609
Brian Curtin1b9df392010-11-24 20:24:31 +00003610#ifdef MS_WINDOWS
Larry Hastings9cf065c2012-06-22 16:30:09 -07003611 Py_BEGIN_ALLOW_THREADS
Steve Dowerc3630612016-11-19 18:41:16 -08003612 result = CreateHardLinkW(dst->wide, src->wide, NULL);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003613 Py_END_ALLOW_THREADS
Brian Curtin1b9df392010-11-24 20:24:31 +00003614
Larry Hastings2f936352014-08-05 14:04:04 +10003615 if (!result)
3616 return path_error2(src, dst);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003617#else
3618 Py_BEGIN_ALLOW_THREADS
Larry Hastings67cbf7b2012-06-22 17:06:48 -07003619#ifdef HAVE_LINKAT
Larry Hastings9cf065c2012-06-22 16:30:09 -07003620 if ((src_dir_fd != DEFAULT_DIR_FD) ||
3621 (dst_dir_fd != DEFAULT_DIR_FD) ||
3622 (!follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10003623 result = linkat(src_dir_fd, src->narrow,
3624 dst_dir_fd, dst->narrow,
Larry Hastings9cf065c2012-06-22 16:30:09 -07003625 follow_symlinks ? AT_SYMLINK_FOLLOW : 0);
3626 else
Steve Dowercc16be82016-09-08 10:35:16 -07003627#endif /* HAVE_LINKAT */
Larry Hastings2f936352014-08-05 14:04:04 +10003628 result = link(src->narrow, dst->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003629 Py_END_ALLOW_THREADS
Brian Curtinfc889c42010-11-28 23:59:46 +00003630
Larry Hastings2f936352014-08-05 14:04:04 +10003631 if (result)
3632 return path_error2(src, dst);
Steve Dowercc16be82016-09-08 10:35:16 -07003633#endif /* MS_WINDOWS */
Larry Hastings9cf065c2012-06-22 16:30:09 -07003634
Larry Hastings2f936352014-08-05 14:04:04 +10003635 Py_RETURN_NONE;
Brian Curtin1b9df392010-11-24 20:24:31 +00003636}
Larry Hastings9cf065c2012-06-22 16:30:09 -07003637#endif
3638
Brian Curtin1b9df392010-11-24 20:24:31 +00003639
Gregory P. Smith16ea14a2013-03-20 18:51:33 -07003640#if defined(MS_WINDOWS) && !defined(HAVE_OPENDIR)
Barry Warsaw53699e91996-12-10 23:23:01 +00003641static PyObject *
Gregory P. Smith40a21602013-03-20 20:52:50 -07003642_listdir_windows_no_opendir(path_t *path, PyObject *list)
Guido van Rossumb6775db1994-08-01 11:34:53 +00003643{
Larry Hastings9cf065c2012-06-22 16:30:09 -07003644 PyObject *v;
3645 HANDLE hFindFile = INVALID_HANDLE_VALUE;
3646 BOOL result;
Steve Dowercc16be82016-09-08 10:35:16 -07003647 wchar_t namebuf[MAX_PATH+4]; /* Overallocate for "\*.*" */
Larry Hastings9cf065c2012-06-22 16:30:09 -07003648 /* only claim to have space for MAX_PATH */
Victor Stinner75875072013-11-24 19:23:25 +01003649 Py_ssize_t len = Py_ARRAY_LENGTH(namebuf)-4;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003650 wchar_t *wnamebuf = NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003651
Steve Dowercc16be82016-09-08 10:35:16 -07003652 WIN32_FIND_DATAW wFileData;
3653 const wchar_t *po_wchars;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00003654
Steve Dowercc16be82016-09-08 10:35:16 -07003655 if (!path->wide) { /* Default arg: "." */
3656 po_wchars = L".";
3657 len = 1;
3658 } else {
3659 po_wchars = path->wide;
3660 len = wcslen(path->wide);
3661 }
3662 /* The +5 is so we can append "\\*.*\0" */
3663 wnamebuf = PyMem_New(wchar_t, len + 5);
3664 if (!wnamebuf) {
3665 PyErr_NoMemory();
Larry Hastings9cf065c2012-06-22 16:30:09 -07003666 goto exit;
Victor Stinner8c62be82010-05-06 00:08:46 +00003667 }
Steve Dowercc16be82016-09-08 10:35:16 -07003668 wcscpy(wnamebuf, po_wchars);
Victor Stinner8c62be82010-05-06 00:08:46 +00003669 if (len > 0) {
Steve Dowercc16be82016-09-08 10:35:16 -07003670 wchar_t wch = wnamebuf[len-1];
3671 if (wch != SEP && wch != ALTSEP && wch != L':')
3672 wnamebuf[len++] = SEP;
3673 wcscpy(wnamebuf + len, L"*.*");
Victor Stinner8c62be82010-05-06 00:08:46 +00003674 }
Steve Dowercc16be82016-09-08 10:35:16 -07003675 if ((list = PyList_New(0)) == NULL) {
3676 goto exit;
3677 }
Antoine Pitroub73caab2010-08-09 23:39:31 +00003678 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07003679 hFindFile = FindFirstFileW(wnamebuf, &wFileData);
Antoine Pitroub73caab2010-08-09 23:39:31 +00003680 Py_END_ALLOW_THREADS
Victor Stinner8c62be82010-05-06 00:08:46 +00003681 if (hFindFile == INVALID_HANDLE_VALUE) {
3682 int error = GetLastError();
3683 if (error == ERROR_FILE_NOT_FOUND)
Larry Hastings9cf065c2012-06-22 16:30:09 -07003684 goto exit;
3685 Py_DECREF(list);
Gregory P. Smith40a21602013-03-20 20:52:50 -07003686 list = path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003687 goto exit;
Victor Stinner8c62be82010-05-06 00:08:46 +00003688 }
3689 do {
3690 /* Skip over . and .. */
Steve Dowercc16be82016-09-08 10:35:16 -07003691 if (wcscmp(wFileData.cFileName, L".") != 0 &&
3692 wcscmp(wFileData.cFileName, L"..") != 0) {
3693 v = PyUnicode_FromWideChar(wFileData.cFileName,
3694 wcslen(wFileData.cFileName));
3695 if (path->narrow && v) {
3696 Py_SETREF(v, PyUnicode_EncodeFSDefault(v));
3697 }
Victor Stinner8c62be82010-05-06 00:08:46 +00003698 if (v == NULL) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07003699 Py_DECREF(list);
3700 list = NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00003701 break;
3702 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07003703 if (PyList_Append(list, v) != 0) {
Victor Stinner8c62be82010-05-06 00:08:46 +00003704 Py_DECREF(v);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003705 Py_DECREF(list);
3706 list = NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00003707 break;
3708 }
3709 Py_DECREF(v);
3710 }
3711 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07003712 result = FindNextFileW(hFindFile, &wFileData);
Victor Stinner8c62be82010-05-06 00:08:46 +00003713 Py_END_ALLOW_THREADS
3714 /* FindNextFile sets error to ERROR_NO_MORE_FILES if
3715 it got to the end of the directory. */
3716 if (!result && GetLastError() != ERROR_NO_MORE_FILES) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07003717 Py_DECREF(list);
Gregory P. Smith40a21602013-03-20 20:52:50 -07003718 list = path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003719 goto exit;
Victor Stinner8c62be82010-05-06 00:08:46 +00003720 }
3721 } while (result == TRUE);
Guido van Rossumb6775db1994-08-01 11:34:53 +00003722
Larry Hastings9cf065c2012-06-22 16:30:09 -07003723exit:
3724 if (hFindFile != INVALID_HANDLE_VALUE) {
3725 if (FindClose(hFindFile) == FALSE) {
3726 if (list != NULL) {
3727 Py_DECREF(list);
Gregory P. Smith40a21602013-03-20 20:52:50 -07003728 list = path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003729 }
3730 }
Victor Stinner8c62be82010-05-06 00:08:46 +00003731 }
Victor Stinnerb6404912013-07-07 16:21:41 +02003732 PyMem_Free(wnamebuf);
Guido van Rossumb6775db1994-08-01 11:34:53 +00003733
Larry Hastings9cf065c2012-06-22 16:30:09 -07003734 return list;
Gregory P. Smith16ea14a2013-03-20 18:51:33 -07003735} /* end of _listdir_windows_no_opendir */
3736
3737#else /* thus POSIX, ie: not (MS_WINDOWS and not HAVE_OPENDIR) */
3738
3739static PyObject *
Gregory P. Smith40a21602013-03-20 20:52:50 -07003740_posix_listdir(path_t *path, PyObject *list)
Gregory P. Smith16ea14a2013-03-20 18:51:33 -07003741{
Gregory P. Smith16ea14a2013-03-20 18:51:33 -07003742 PyObject *v;
3743 DIR *dirp = NULL;
3744 struct dirent *ep;
3745 int return_str; /* if false, return bytes */
Larry Hastings4dbc95e2013-08-01 18:18:56 -07003746#ifdef HAVE_FDOPENDIR
3747 int fd = -1;
3748#endif
Gregory P. Smith16ea14a2013-03-20 18:51:33 -07003749
Victor Stinner8c62be82010-05-06 00:08:46 +00003750 errno = 0;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003751#ifdef HAVE_FDOPENDIR
Gregory P. Smith40a21602013-03-20 20:52:50 -07003752 if (path->fd != -1) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07003753 /* closedir() closes the FD, so we duplicate it */
Victor Stinnerdaf45552013-08-28 00:53:59 +02003754 fd = _Py_dup(path->fd);
Victor Stinnerf3266652013-12-19 13:24:49 +01003755 if (fd == -1)
3756 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003757
Larry Hastingsfdaea062012-06-25 04:42:23 -07003758 return_str = 1;
3759
Larry Hastings9cf065c2012-06-22 16:30:09 -07003760 Py_BEGIN_ALLOW_THREADS
3761 dirp = fdopendir(fd);
3762 Py_END_ALLOW_THREADS
3763 }
3764 else
3765#endif
3766 {
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03003767 const char *name;
Gregory P. Smith40a21602013-03-20 20:52:50 -07003768 if (path->narrow) {
3769 name = path->narrow;
Serhiy Storchaka1180e5a2017-07-11 06:36:46 +03003770 /* only return bytes if they specified a bytes-like object */
3771 return_str = !PyObject_CheckBuffer(path->object);
Larry Hastingsfdaea062012-06-25 04:42:23 -07003772 }
3773 else {
3774 name = ".";
3775 return_str = 1;
3776 }
3777
Larry Hastings9cf065c2012-06-22 16:30:09 -07003778 Py_BEGIN_ALLOW_THREADS
3779 dirp = opendir(name);
3780 Py_END_ALLOW_THREADS
3781 }
3782
3783 if (dirp == NULL) {
Gregory P. Smith40a21602013-03-20 20:52:50 -07003784 list = path_error(path);
Larry Hastings4dbc95e2013-08-01 18:18:56 -07003785#ifdef HAVE_FDOPENDIR
3786 if (fd != -1) {
3787 Py_BEGIN_ALLOW_THREADS
3788 close(fd);
3789 Py_END_ALLOW_THREADS
3790 }
3791#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07003792 goto exit;
3793 }
3794 if ((list = PyList_New(0)) == NULL) {
3795 goto exit;
Victor Stinner8c62be82010-05-06 00:08:46 +00003796 }
3797 for (;;) {
3798 errno = 0;
3799 Py_BEGIN_ALLOW_THREADS
3800 ep = readdir(dirp);
3801 Py_END_ALLOW_THREADS
3802 if (ep == NULL) {
3803 if (errno == 0) {
3804 break;
3805 } else {
Larry Hastings9cf065c2012-06-22 16:30:09 -07003806 Py_DECREF(list);
Gregory P. Smith40a21602013-03-20 20:52:50 -07003807 list = path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003808 goto exit;
Victor Stinner8c62be82010-05-06 00:08:46 +00003809 }
3810 }
3811 if (ep->d_name[0] == '.' &&
3812 (NAMLEN(ep) == 1 ||
3813 (ep->d_name[1] == '.' && NAMLEN(ep) == 2)))
3814 continue;
Larry Hastingsfdaea062012-06-25 04:42:23 -07003815 if (return_str)
Victor Stinnera45598a2010-05-14 16:35:39 +00003816 v = PyUnicode_DecodeFSDefaultAndSize(ep->d_name, NAMLEN(ep));
3817 else
3818 v = PyBytes_FromStringAndSize(ep->d_name, NAMLEN(ep));
Victor Stinner8c62be82010-05-06 00:08:46 +00003819 if (v == NULL) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07003820 Py_CLEAR(list);
Victor Stinner8c62be82010-05-06 00:08:46 +00003821 break;
3822 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07003823 if (PyList_Append(list, v) != 0) {
Victor Stinner8c62be82010-05-06 00:08:46 +00003824 Py_DECREF(v);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003825 Py_CLEAR(list);
Victor Stinner8c62be82010-05-06 00:08:46 +00003826 break;
3827 }
3828 Py_DECREF(v);
3829 }
Guido van Rossum0ee42cd1991-04-08 21:01:03 +00003830
Larry Hastings9cf065c2012-06-22 16:30:09 -07003831exit:
3832 if (dirp != NULL) {
3833 Py_BEGIN_ALLOW_THREADS
Larry Hastings4dbc95e2013-08-01 18:18:56 -07003834#ifdef HAVE_FDOPENDIR
Larry Hastings9cf065c2012-06-22 16:30:09 -07003835 if (fd > -1)
3836 rewinddir(dirp);
Larry Hastings4dbc95e2013-08-01 18:18:56 -07003837#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07003838 closedir(dirp);
3839 Py_END_ALLOW_THREADS
3840 }
3841
Larry Hastings9cf065c2012-06-22 16:30:09 -07003842 return list;
Gregory P. Smith16ea14a2013-03-20 18:51:33 -07003843} /* end of _posix_listdir */
3844#endif /* which OS */
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00003845
Larry Hastings2f936352014-08-05 14:04:04 +10003846
3847/*[clinic input]
3848os.listdir
3849
3850 path : path_t(nullable=True, allow_fd='PATH_HAVE_FDOPENDIR') = None
3851
3852Return a list containing the names of the files in the directory.
3853
BNMetricsb9427072018-11-02 15:20:19 +00003854path can be specified as either str, bytes, or a path-like object. If path is bytes,
Larry Hastings2f936352014-08-05 14:04:04 +10003855 the filenames returned will also be bytes; in all other circumstances
3856 the filenames returned will be str.
3857If path is None, uses the path='.'.
3858On some platforms, path may also be specified as an open file descriptor;\
3859 the file descriptor must refer to a directory.
3860 If this functionality is unavailable, using it raises NotImplementedError.
3861
3862The list is in arbitrary order. It does not include the special
3863entries '.' and '..' even if they are present in the directory.
3864
3865
3866[clinic start generated code]*/
3867
Larry Hastings2f936352014-08-05 14:04:04 +10003868static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003869os_listdir_impl(PyObject *module, path_t *path)
BNMetricsb9427072018-11-02 15:20:19 +00003870/*[clinic end generated code: output=293045673fcd1a75 input=e3f58030f538295d]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003871{
Miss Islington (bot)8763d432019-06-24 09:09:47 -07003872 if (PySys_Audit("os.listdir", "O",
3873 path->object ? path->object : Py_None) < 0) {
3874 return NULL;
3875 }
Larry Hastings2f936352014-08-05 14:04:04 +10003876#if defined(MS_WINDOWS) && !defined(HAVE_OPENDIR)
3877 return _listdir_windows_no_opendir(path, NULL);
3878#else
3879 return _posix_listdir(path, NULL);
3880#endif
3881}
3882
Martin v. Löwis6238d2b2002-06-30 15:26:10 +00003883#ifdef MS_WINDOWS
Mark Hammondef8b6542001-05-13 08:04:26 +00003884/* A helper function for abspath on win32 */
Serhiy Storchakaf0b50152015-05-13 00:52:39 +03003885/*[clinic input]
3886os._getfullpathname
Victor Stinnereb5657a2011-09-30 01:44:27 +02003887
Serhiy Storchakaf0b50152015-05-13 00:52:39 +03003888 path: path_t
3889 /
3890
3891[clinic start generated code]*/
3892
3893static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003894os__getfullpathname_impl(PyObject *module, path_t *path)
3895/*[clinic end generated code: output=bb8679d56845bc9b input=332ed537c29d0a3e]*/
Serhiy Storchakaf0b50152015-05-13 00:52:39 +03003896{
Steve Dowercc16be82016-09-08 10:35:16 -07003897 wchar_t woutbuf[MAX_PATH], *woutbufp = woutbuf;
3898 wchar_t *wtemp;
3899 DWORD result;
3900 PyObject *v;
Victor Stinnereb5657a2011-09-30 01:44:27 +02003901
Steve Dowercc16be82016-09-08 10:35:16 -07003902 result = GetFullPathNameW(path->wide,
3903 Py_ARRAY_LENGTH(woutbuf),
3904 woutbuf, &wtemp);
3905 if (result > Py_ARRAY_LENGTH(woutbuf)) {
3906 woutbufp = PyMem_New(wchar_t, result);
3907 if (!woutbufp)
3908 return PyErr_NoMemory();
3909 result = GetFullPathNameW(path->wide, result, woutbufp, &wtemp);
Victor Stinner8c62be82010-05-06 00:08:46 +00003910 }
Steve Dowercc16be82016-09-08 10:35:16 -07003911 if (result) {
3912 v = PyUnicode_FromWideChar(woutbufp, wcslen(woutbufp));
3913 if (path->narrow)
3914 Py_SETREF(v, PyUnicode_EncodeFSDefault(v));
3915 } else
3916 v = win32_error_object("GetFullPathNameW", path->object);
3917 if (woutbufp != woutbuf)
3918 PyMem_Free(woutbufp);
3919 return v;
Larry Hastings2f936352014-08-05 14:04:04 +10003920}
Brian Curtind40e6f72010-07-08 21:39:08 +00003921
Brian Curtind25aef52011-06-13 15:16:04 -05003922
Larry Hastings2f936352014-08-05 14:04:04 +10003923/*[clinic input]
3924os._getfinalpathname
Brian Curtinf5e76d02010-11-24 13:14:05 +00003925
Steve Dower23ad6d02018-02-22 10:39:10 -08003926 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +10003927 /
3928
3929A helper function for samepath on windows.
3930[clinic start generated code]*/
3931
Larry Hastings2f936352014-08-05 14:04:04 +10003932static PyObject *
Steve Dower23ad6d02018-02-22 10:39:10 -08003933os__getfinalpathname_impl(PyObject *module, path_t *path)
3934/*[clinic end generated code: output=621a3c79bc29ebfa input=2b6b6c7cbad5fb84]*/
Brian Curtind40e6f72010-07-08 21:39:08 +00003935{
3936 HANDLE hFile;
Alexey Izbyshev3b20d342018-03-08 19:03:25 +03003937 wchar_t buf[MAXPATHLEN], *target_path = buf;
3938 int buf_size = Py_ARRAY_LENGTH(buf);
Brian Curtind40e6f72010-07-08 21:39:08 +00003939 int result_length;
Larry Hastings2f936352014-08-05 14:04:04 +10003940 PyObject *result;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00003941
Steve Dower23ad6d02018-02-22 10:39:10 -08003942 Py_BEGIN_ALLOW_THREADS
Brian Curtind40e6f72010-07-08 21:39:08 +00003943 hFile = CreateFileW(
Steve Dower23ad6d02018-02-22 10:39:10 -08003944 path->wide,
Brian Curtind40e6f72010-07-08 21:39:08 +00003945 0, /* desired access */
3946 0, /* share mode */
3947 NULL, /* security attributes */
3948 OPEN_EXISTING,
3949 /* FILE_FLAG_BACKUP_SEMANTICS is required to open a directory */
3950 FILE_FLAG_BACKUP_SEMANTICS,
3951 NULL);
Alexey Izbyshev3b20d342018-03-08 19:03:25 +03003952 Py_END_ALLOW_THREADS
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00003953
Steve Dower23ad6d02018-02-22 10:39:10 -08003954 if (hFile == INVALID_HANDLE_VALUE) {
Alexey Izbyshev3b20d342018-03-08 19:03:25 +03003955 return win32_error_object("CreateFileW", path->object);
Steve Dower23ad6d02018-02-22 10:39:10 -08003956 }
Brian Curtind40e6f72010-07-08 21:39:08 +00003957
3958 /* We have a good handle to the target, use it to determine the
3959 target path name. */
Alexey Izbyshev3b20d342018-03-08 19:03:25 +03003960 while (1) {
3961 Py_BEGIN_ALLOW_THREADS
3962 result_length = GetFinalPathNameByHandleW(hFile, target_path,
3963 buf_size, VOLUME_NAME_DOS);
3964 Py_END_ALLOW_THREADS
Brian Curtind40e6f72010-07-08 21:39:08 +00003965
Alexey Izbyshev3b20d342018-03-08 19:03:25 +03003966 if (!result_length) {
3967 result = win32_error_object("GetFinalPathNameByHandleW",
3968 path->object);
3969 goto cleanup;
3970 }
Brian Curtind40e6f72010-07-08 21:39:08 +00003971
Alexey Izbyshev3b20d342018-03-08 19:03:25 +03003972 if (result_length < buf_size) {
3973 break;
3974 }
Brian Curtind40e6f72010-07-08 21:39:08 +00003975
Alexey Izbyshev3b20d342018-03-08 19:03:25 +03003976 wchar_t *tmp;
3977 tmp = PyMem_Realloc(target_path != buf ? target_path : NULL,
3978 result_length * sizeof(*tmp));
3979 if (!tmp) {
3980 result = PyErr_NoMemory();
3981 goto cleanup;
3982 }
3983
3984 buf_size = result_length;
3985 target_path = tmp;
Steve Dower23ad6d02018-02-22 10:39:10 -08003986 }
Brian Curtind40e6f72010-07-08 21:39:08 +00003987
Victor Stinner9d3b93b2011-11-22 02:27:30 +01003988 result = PyUnicode_FromWideChar(target_path, result_length);
Steve Dower9eb3d542019-08-21 15:52:42 -07003989 if (result && path->narrow) {
Steve Dower23ad6d02018-02-22 10:39:10 -08003990 Py_SETREF(result, PyUnicode_EncodeFSDefault(result));
Steve Dower9eb3d542019-08-21 15:52:42 -07003991 }
Steve Dower23ad6d02018-02-22 10:39:10 -08003992
Alexey Izbyshev3b20d342018-03-08 19:03:25 +03003993cleanup:
3994 if (target_path != buf) {
3995 PyMem_Free(target_path);
3996 }
3997 CloseHandle(hFile);
3998 return result;
Larry Hastings2f936352014-08-05 14:04:04 +10003999}
Brian Curtin62857742010-09-06 17:07:27 +00004000
Tim Golden6b528062013-08-01 12:44:00 +01004001
Larry Hastings2f936352014-08-05 14:04:04 +10004002/*[clinic input]
4003os._getvolumepathname
4004
Steve Dower23ad6d02018-02-22 10:39:10 -08004005 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +10004006
4007A helper function for ismount on Win32.
4008[clinic start generated code]*/
4009
Larry Hastings2f936352014-08-05 14:04:04 +10004010static PyObject *
Steve Dower23ad6d02018-02-22 10:39:10 -08004011os__getvolumepathname_impl(PyObject *module, path_t *path)
4012/*[clinic end generated code: output=804c63fd13a1330b input=722b40565fa21552]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004013{
4014 PyObject *result;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03004015 wchar_t *mountpath=NULL;
Victor Stinner6edddfa2013-11-24 19:22:57 +01004016 size_t buflen;
Tim Golden6b528062013-08-01 12:44:00 +01004017 BOOL ret;
4018
Tim Golden6b528062013-08-01 12:44:00 +01004019 /* Volume path should be shorter than entire path */
Steve Dower23ad6d02018-02-22 10:39:10 -08004020 buflen = Py_MAX(path->length, MAX_PATH);
Victor Stinner6edddfa2013-11-24 19:22:57 +01004021
Victor Stinner850a18e2017-10-24 16:53:32 -07004022 if (buflen > PY_DWORD_MAX) {
Victor Stinner6edddfa2013-11-24 19:22:57 +01004023 PyErr_SetString(PyExc_OverflowError, "path too long");
4024 return NULL;
4025 }
4026
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02004027 mountpath = PyMem_New(wchar_t, buflen);
Tim Golden6b528062013-08-01 12:44:00 +01004028 if (mountpath == NULL)
4029 return PyErr_NoMemory();
4030
4031 Py_BEGIN_ALLOW_THREADS
Steve Dower23ad6d02018-02-22 10:39:10 -08004032 ret = GetVolumePathNameW(path->wide, mountpath,
Victor Stinner6edddfa2013-11-24 19:22:57 +01004033 Py_SAFE_DOWNCAST(buflen, size_t, DWORD));
Tim Golden6b528062013-08-01 12:44:00 +01004034 Py_END_ALLOW_THREADS
4035
4036 if (!ret) {
Steve Dower23ad6d02018-02-22 10:39:10 -08004037 result = win32_error_object("_getvolumepathname", path->object);
Tim Golden6b528062013-08-01 12:44:00 +01004038 goto exit;
4039 }
4040 result = PyUnicode_FromWideChar(mountpath, wcslen(mountpath));
Steve Dower23ad6d02018-02-22 10:39:10 -08004041 if (path->narrow)
4042 Py_SETREF(result, PyUnicode_EncodeFSDefault(result));
Tim Golden6b528062013-08-01 12:44:00 +01004043
4044exit:
4045 PyMem_Free(mountpath);
4046 return result;
4047}
Tim Golden6b528062013-08-01 12:44:00 +01004048
Martin v. Löwis6238d2b2002-06-30 15:26:10 +00004049#endif /* MS_WINDOWS */
Mark Hammondef8b6542001-05-13 08:04:26 +00004050
Larry Hastings2f936352014-08-05 14:04:04 +10004051
4052/*[clinic input]
4053os.mkdir
4054
4055 path : path_t
4056
4057 mode: int = 0o777
4058
4059 *
4060
4061 dir_fd : dir_fd(requires='mkdirat') = None
4062
4063# "mkdir(path, mode=0o777, *, dir_fd=None)\n\n\
4064
4065Create a directory.
4066
4067If dir_fd is not None, it should be a file descriptor open to a directory,
4068 and path should be relative; path will then be relative to that directory.
4069dir_fd may not be implemented on your platform.
4070 If it is unavailable, using it will raise a NotImplementedError.
4071
4072The mode argument is ignored on Windows.
4073[clinic start generated code]*/
4074
Larry Hastings2f936352014-08-05 14:04:04 +10004075static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004076os_mkdir_impl(PyObject *module, path_t *path, int mode, int dir_fd)
4077/*[clinic end generated code: output=a70446903abe821f input=e965f68377e9b1ce]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004078{
4079 int result;
Mark Hammondc2e85bd2002-10-03 05:10:39 +00004080
Steve Dowera00b5be2020-02-13 08:30:27 +00004081 if (PySys_Audit("os.mkdir", "Oii", path->object, mode,
4082 dir_fd == DEFAULT_DIR_FD ? -1 : dir_fd) < 0) {
4083 return NULL;
4084 }
4085
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00004086#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00004087 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07004088 result = CreateDirectoryW(path->wide, NULL);
Victor Stinner8c62be82010-05-06 00:08:46 +00004089 Py_END_ALLOW_THREADS
Mark Hammondc2e85bd2002-10-03 05:10:39 +00004090
Larry Hastings2f936352014-08-05 14:04:04 +10004091 if (!result)
4092 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004093#else
Victor Stinner8c62be82010-05-06 00:08:46 +00004094 Py_BEGIN_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07004095#if HAVE_MKDIRAT
4096 if (dir_fd != DEFAULT_DIR_FD)
Larry Hastings2f936352014-08-05 14:04:04 +10004097 result = mkdirat(dir_fd, path->narrow, mode);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004098 else
4099#endif
Erik Bray03eb11f2017-10-27 14:27:06 +02004100#if defined(__WATCOMC__) && !defined(__QNX__)
Larry Hastings2f936352014-08-05 14:04:04 +10004101 result = mkdir(path->narrow);
Guido van Rossuma4916fa1996-05-23 22:58:55 +00004102#else
Larry Hastings2f936352014-08-05 14:04:04 +10004103 result = mkdir(path->narrow, mode);
Guido van Rossuma4916fa1996-05-23 22:58:55 +00004104#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00004105 Py_END_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10004106 if (result < 0)
4107 return path_error(path);
Steve Dowercc16be82016-09-08 10:35:16 -07004108#endif /* MS_WINDOWS */
Larry Hastings2f936352014-08-05 14:04:04 +10004109 Py_RETURN_NONE;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004110}
4111
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004112
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004113/* sys/resource.h is needed for at least: wait3(), wait4(), broken nice. */
4114#if defined(HAVE_SYS_RESOURCE_H)
Thomas Wouterse38b2f12001-07-11 22:35:31 +00004115#include <sys/resource.h>
4116#endif
Thomas Wouterse38b2f12001-07-11 22:35:31 +00004117
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004118
4119#ifdef HAVE_NICE
Larry Hastings2f936352014-08-05 14:04:04 +10004120/*[clinic input]
4121os.nice
4122
4123 increment: int
4124 /
4125
4126Add increment to the priority of process and return the new priority.
4127[clinic start generated code]*/
4128
Larry Hastings2f936352014-08-05 14:04:04 +10004129static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004130os_nice_impl(PyObject *module, int increment)
4131/*[clinic end generated code: output=9dad8a9da8109943 input=864be2d402a21da2]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004132{
4133 int value;
Thomas Woutersc2c12dc2001-07-11 14:45:34 +00004134
Victor Stinner8c62be82010-05-06 00:08:46 +00004135 /* There are two flavours of 'nice': one that returns the new
4136 priority (as required by almost all standards out there) and the
Benjamin Peterson288d1da2017-09-28 22:44:27 -07004137 Linux/FreeBSD one, which returns '0' on success and advices
Victor Stinner8c62be82010-05-06 00:08:46 +00004138 the use of getpriority() to get the new priority.
Tim Peters5aa91602002-01-30 05:46:57 +00004139
Victor Stinner8c62be82010-05-06 00:08:46 +00004140 If we are of the nice family that returns the new priority, we
4141 need to clear errno before the call, and check if errno is filled
4142 before calling posix_error() on a returnvalue of -1, because the
4143 -1 may be the actual new priority! */
Thomas Woutersc2c12dc2001-07-11 14:45:34 +00004144
Victor Stinner8c62be82010-05-06 00:08:46 +00004145 errno = 0;
4146 value = nice(increment);
Thomas Wouterse38b2f12001-07-11 22:35:31 +00004147#if defined(HAVE_BROKEN_NICE) && defined(HAVE_GETPRIORITY)
Victor Stinner8c62be82010-05-06 00:08:46 +00004148 if (value == 0)
4149 value = getpriority(PRIO_PROCESS, 0);
Thomas Woutersc2c12dc2001-07-11 14:45:34 +00004150#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00004151 if (value == -1 && errno != 0)
4152 /* either nice() or getpriority() returned an error */
4153 return posix_error();
4154 return PyLong_FromLong((long) value);
Guido van Rossum775f4da1993-01-09 17:18:52 +00004155}
Guido van Rossumb6775db1994-08-01 11:34:53 +00004156#endif /* HAVE_NICE */
Guido van Rossum1ff6cb41991-04-08 20:59:13 +00004157
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00004158
4159#ifdef HAVE_GETPRIORITY
Larry Hastings2f936352014-08-05 14:04:04 +10004160/*[clinic input]
4161os.getpriority
4162
4163 which: int
4164 who: int
4165
4166Return program scheduling priority.
4167[clinic start generated code]*/
4168
Larry Hastings2f936352014-08-05 14:04:04 +10004169static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004170os_getpriority_impl(PyObject *module, int which, int who)
4171/*[clinic end generated code: output=c41b7b63c7420228 input=9be615d40e2544ef]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004172{
4173 int retval;
4174
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00004175 errno = 0;
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00004176 retval = getpriority(which, who);
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00004177 if (errno != 0)
4178 return posix_error();
4179 return PyLong_FromLong((long)retval);
4180}
4181#endif /* HAVE_GETPRIORITY */
4182
4183
4184#ifdef HAVE_SETPRIORITY
Larry Hastings2f936352014-08-05 14:04:04 +10004185/*[clinic input]
4186os.setpriority
4187
4188 which: int
4189 who: int
4190 priority: int
4191
4192Set program scheduling priority.
4193[clinic start generated code]*/
4194
Larry Hastings2f936352014-08-05 14:04:04 +10004195static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004196os_setpriority_impl(PyObject *module, int which, int who, int priority)
4197/*[clinic end generated code: output=3d910d95a7771eb2 input=710ccbf65b9dc513]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004198{
4199 int retval;
4200
4201 retval = setpriority(which, who, priority);
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00004202 if (retval == -1)
4203 return posix_error();
4204 Py_RETURN_NONE;
4205}
4206#endif /* HAVE_SETPRIORITY */
4207
4208
Barry Warsaw53699e91996-12-10 23:23:01 +00004209static PyObject *
Larry Hastings2f936352014-08-05 14:04:04 +10004210internal_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 +00004211{
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03004212 const char *function_name = is_replace ? "replace" : "rename";
Larry Hastings9cf065c2012-06-22 16:30:09 -07004213 int dir_fd_specified;
Larry Hastings9cf065c2012-06-22 16:30:09 -07004214
Mark Hammondc2e85bd2002-10-03 05:10:39 +00004215#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00004216 BOOL result;
Antoine Pitrouf3b2d882012-01-30 22:08:52 +01004217 int flags = is_replace ? MOVEFILE_REPLACE_EXISTING : 0;
Mark Hammondc2e85bd2002-10-03 05:10:39 +00004218#else
Larry Hastings9cf065c2012-06-22 16:30:09 -07004219 int result;
Mark Hammondc2e85bd2002-10-03 05:10:39 +00004220#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07004221
Larry Hastings9cf065c2012-06-22 16:30:09 -07004222 dir_fd_specified = (src_dir_fd != DEFAULT_DIR_FD) ||
4223 (dst_dir_fd != DEFAULT_DIR_FD);
4224#ifndef HAVE_RENAMEAT
4225 if (dir_fd_specified) {
4226 argument_unavailable_error(function_name, "src_dir_fd and dst_dir_fd");
Larry Hastings2f936352014-08-05 14:04:04 +10004227 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07004228 }
4229#endif
4230
Steve Dowera00b5be2020-02-13 08:30:27 +00004231 if (PySys_Audit("os.rename", "OOii", src->object, dst->object,
4232 src_dir_fd == DEFAULT_DIR_FD ? -1 : src_dir_fd,
4233 dst_dir_fd == DEFAULT_DIR_FD ? -1 : dst_dir_fd) < 0) {
4234 return NULL;
4235 }
4236
Larry Hastings9cf065c2012-06-22 16:30:09 -07004237#ifdef MS_WINDOWS
4238 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07004239 result = MoveFileExW(src->wide, dst->wide, flags);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004240 Py_END_ALLOW_THREADS
4241
Larry Hastings2f936352014-08-05 14:04:04 +10004242 if (!result)
4243 return path_error2(src, dst);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004244
4245#else
Steve Dowercc16be82016-09-08 10:35:16 -07004246 if ((src->narrow && dst->wide) || (src->wide && dst->narrow)) {
4247 PyErr_Format(PyExc_ValueError,
4248 "%s: src and dst must be the same type", function_name);
4249 return NULL;
4250 }
4251
Larry Hastings9cf065c2012-06-22 16:30:09 -07004252 Py_BEGIN_ALLOW_THREADS
4253#ifdef HAVE_RENAMEAT
4254 if (dir_fd_specified)
Larry Hastings2f936352014-08-05 14:04:04 +10004255 result = renameat(src_dir_fd, src->narrow, dst_dir_fd, dst->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004256 else
4257#endif
Steve Dowercc16be82016-09-08 10:35:16 -07004258 result = rename(src->narrow, dst->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004259 Py_END_ALLOW_THREADS
4260
Larry Hastings2f936352014-08-05 14:04:04 +10004261 if (result)
4262 return path_error2(src, dst);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004263#endif
Larry Hastings2f936352014-08-05 14:04:04 +10004264 Py_RETURN_NONE;
4265}
Larry Hastings9cf065c2012-06-22 16:30:09 -07004266
Larry Hastings2f936352014-08-05 14:04:04 +10004267
4268/*[clinic input]
4269os.rename
4270
4271 src : path_t
4272 dst : path_t
4273 *
4274 src_dir_fd : dir_fd = None
4275 dst_dir_fd : dir_fd = None
4276
4277Rename a file or directory.
4278
4279If either src_dir_fd or dst_dir_fd is not None, it should be a file
4280 descriptor open to a directory, and the respective path string (src or dst)
4281 should be relative; the path will then be relative to that directory.
4282src_dir_fd and dst_dir_fd, may not be implemented on your platform.
4283 If they are unavailable, using them will raise a NotImplementedError.
4284[clinic start generated code]*/
4285
Antoine Pitrouf3b2d882012-01-30 22:08:52 +01004286static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004287os_rename_impl(PyObject *module, path_t *src, path_t *dst, int src_dir_fd,
Larry Hastings89964c42015-04-14 18:07:59 -04004288 int dst_dir_fd)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004289/*[clinic end generated code: output=59e803072cf41230 input=faa61c847912c850]*/
Antoine Pitrouf3b2d882012-01-30 22:08:52 +01004290{
Larry Hastings2f936352014-08-05 14:04:04 +10004291 return internal_rename(src, dst, src_dir_fd, dst_dir_fd, 0);
Antoine Pitrouf3b2d882012-01-30 22:08:52 +01004292}
4293
Larry Hastings2f936352014-08-05 14:04:04 +10004294
4295/*[clinic input]
4296os.replace = os.rename
4297
4298Rename a file or directory, overwriting the destination.
4299
4300If either src_dir_fd or dst_dir_fd is not None, it should be a file
4301 descriptor open to a directory, and the respective path string (src or dst)
4302 should be relative; the path will then be relative to that directory.
4303src_dir_fd and dst_dir_fd, may not be implemented on your platform.
Anthony Sottile73d60022019-02-12 23:15:54 -05004304 If they are unavailable, using them will raise a NotImplementedError.
Larry Hastings2f936352014-08-05 14:04:04 +10004305[clinic start generated code]*/
4306
Larry Hastings2f936352014-08-05 14:04:04 +10004307static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004308os_replace_impl(PyObject *module, path_t *src, path_t *dst, int src_dir_fd,
4309 int dst_dir_fd)
Anthony Sottile73d60022019-02-12 23:15:54 -05004310/*[clinic end generated code: output=1968c02e7857422b input=c003f0def43378ef]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004311{
4312 return internal_rename(src, dst, src_dir_fd, dst_dir_fd, 1);
4313}
4314
4315
4316/*[clinic input]
4317os.rmdir
4318
4319 path: path_t
4320 *
4321 dir_fd: dir_fd(requires='unlinkat') = None
4322
4323Remove a directory.
4324
4325If dir_fd is not None, it should be a file descriptor open to a directory,
4326 and path should be relative; path will then be relative to that directory.
4327dir_fd may not be implemented on your platform.
4328 If it is unavailable, using it will raise a NotImplementedError.
4329[clinic start generated code]*/
4330
Larry Hastings2f936352014-08-05 14:04:04 +10004331static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004332os_rmdir_impl(PyObject *module, path_t *path, int dir_fd)
4333/*[clinic end generated code: output=080eb54f506e8301 input=38c8b375ca34a7e2]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004334{
4335 int result;
Larry Hastingsb698d8e2012-06-23 16:55:07 -07004336
Steve Dowera00b5be2020-02-13 08:30:27 +00004337 if (PySys_Audit("os.rmdir", "Oi", path->object,
4338 dir_fd == DEFAULT_DIR_FD ? -1 : dir_fd) < 0) {
4339 return NULL;
4340 }
4341
Larry Hastingsb698d8e2012-06-23 16:55:07 -07004342 Py_BEGIN_ALLOW_THREADS
4343#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07004344 /* Windows, success=1, UNIX, success=0 */
4345 result = !RemoveDirectoryW(path->wide);
Larry Hastingsb698d8e2012-06-23 16:55:07 -07004346#else
4347#ifdef HAVE_UNLINKAT
4348 if (dir_fd != DEFAULT_DIR_FD)
Larry Hastings2f936352014-08-05 14:04:04 +10004349 result = unlinkat(dir_fd, path->narrow, AT_REMOVEDIR);
Larry Hastingsb698d8e2012-06-23 16:55:07 -07004350 else
4351#endif
Larry Hastings2f936352014-08-05 14:04:04 +10004352 result = rmdir(path->narrow);
Larry Hastingsb698d8e2012-06-23 16:55:07 -07004353#endif
4354 Py_END_ALLOW_THREADS
4355
Larry Hastings2f936352014-08-05 14:04:04 +10004356 if (result)
4357 return path_error(path);
Larry Hastingsb698d8e2012-06-23 16:55:07 -07004358
Larry Hastings2f936352014-08-05 14:04:04 +10004359 Py_RETURN_NONE;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004360}
4361
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004362
Guido van Rossuma4916fa1996-05-23 22:58:55 +00004363#ifdef HAVE_SYSTEM
Larry Hastings2f936352014-08-05 14:04:04 +10004364#ifdef MS_WINDOWS
4365/*[clinic input]
4366os.system -> long
4367
4368 command: Py_UNICODE
4369
4370Execute the command in a subshell.
4371[clinic start generated code]*/
4372
Larry Hastings2f936352014-08-05 14:04:04 +10004373static long
Serhiy Storchakaafb3e712018-12-14 11:19:51 +02004374os_system_impl(PyObject *module, const Py_UNICODE *command)
4375/*[clinic end generated code: output=5b7c3599c068ca42 input=303f5ce97df606b0]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004376{
4377 long result;
Steve Dowerb82e17e2019-05-23 08:45:22 -07004378
Miss Islington (bot)5fb81422019-10-18 09:32:14 -07004379 if (PySys_Audit("os.system", "(u)", command) < 0) {
Steve Dowerb82e17e2019-05-23 08:45:22 -07004380 return -1;
4381 }
4382
Victor Stinner8c62be82010-05-06 00:08:46 +00004383 Py_BEGIN_ALLOW_THREADS
Steve Dowerc3630612016-11-19 18:41:16 -08004384 _Py_BEGIN_SUPPRESS_IPH
Larry Hastings2f936352014-08-05 14:04:04 +10004385 result = _wsystem(command);
Steve Dowerc3630612016-11-19 18:41:16 -08004386 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00004387 Py_END_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10004388 return result;
4389}
4390#else /* MS_WINDOWS */
4391/*[clinic input]
4392os.system -> long
4393
4394 command: FSConverter
4395
4396Execute the command in a subshell.
4397[clinic start generated code]*/
4398
Larry Hastings2f936352014-08-05 14:04:04 +10004399static long
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004400os_system_impl(PyObject *module, PyObject *command)
4401/*[clinic end generated code: output=290fc437dd4f33a0 input=86a58554ba6094af]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004402{
4403 long result;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03004404 const char *bytes = PyBytes_AsString(command);
Steve Dowerb82e17e2019-05-23 08:45:22 -07004405
Miss Islington (bot)5fb81422019-10-18 09:32:14 -07004406 if (PySys_Audit("os.system", "(O)", command) < 0) {
Steve Dowerb82e17e2019-05-23 08:45:22 -07004407 return -1;
4408 }
4409
Larry Hastings2f936352014-08-05 14:04:04 +10004410 Py_BEGIN_ALLOW_THREADS
4411 result = system(bytes);
4412 Py_END_ALLOW_THREADS
4413 return result;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004414}
Guido van Rossuma4916fa1996-05-23 22:58:55 +00004415#endif
Larry Hastings2f936352014-08-05 14:04:04 +10004416#endif /* HAVE_SYSTEM */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004417
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004418
Larry Hastings2f936352014-08-05 14:04:04 +10004419/*[clinic input]
4420os.umask
4421
4422 mask: int
4423 /
4424
4425Set the current numeric umask and return the previous umask.
4426[clinic start generated code]*/
4427
Larry Hastings2f936352014-08-05 14:04:04 +10004428static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004429os_umask_impl(PyObject *module, int mask)
4430/*[clinic end generated code: output=a2e33ce3bc1a6e33 input=ab6bfd9b24d8a7e8]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004431{
4432 int i = (int)umask(mask);
Victor Stinner8c62be82010-05-06 00:08:46 +00004433 if (i < 0)
4434 return posix_error();
4435 return PyLong_FromLong((long)i);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004436}
4437
Brian Curtind40e6f72010-07-08 21:39:08 +00004438#ifdef MS_WINDOWS
4439
4440/* override the default DeleteFileW behavior so that directory
4441symlinks can be removed with this function, the same as with
4442Unix symlinks */
4443BOOL WINAPI Py_DeleteFileW(LPCWSTR lpFileName)
4444{
4445 WIN32_FILE_ATTRIBUTE_DATA info;
4446 WIN32_FIND_DATAW find_data;
4447 HANDLE find_data_handle;
4448 int is_directory = 0;
4449 int is_link = 0;
4450
4451 if (GetFileAttributesExW(lpFileName, GetFileExInfoStandard, &info)) {
4452 is_directory = info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00004453
Brian Curtind40e6f72010-07-08 21:39:08 +00004454 /* Get WIN32_FIND_DATA structure for the path to determine if
4455 it is a symlink */
4456 if(is_directory &&
4457 info.dwFileAttributes & FILE_ATTRIBUTE_REPARSE_POINT) {
4458 find_data_handle = FindFirstFileW(lpFileName, &find_data);
4459
4460 if(find_data_handle != INVALID_HANDLE_VALUE) {
Tim Golden0321cf22014-05-05 19:46:17 +01004461 /* IO_REPARSE_TAG_SYMLINK if it is a symlink and
4462 IO_REPARSE_TAG_MOUNT_POINT if it is a junction point. */
4463 is_link = find_data.dwReserved0 == IO_REPARSE_TAG_SYMLINK ||
4464 find_data.dwReserved0 == IO_REPARSE_TAG_MOUNT_POINT;
Brian Curtind40e6f72010-07-08 21:39:08 +00004465 FindClose(find_data_handle);
4466 }
4467 }
4468 }
4469
4470 if (is_directory && is_link)
4471 return RemoveDirectoryW(lpFileName);
4472
4473 return DeleteFileW(lpFileName);
4474}
4475#endif /* MS_WINDOWS */
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004476
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004477
Larry Hastings2f936352014-08-05 14:04:04 +10004478/*[clinic input]
4479os.unlink
4480
4481 path: path_t
4482 *
4483 dir_fd: dir_fd(requires='unlinkat')=None
4484
4485Remove a file (same as remove()).
4486
4487If dir_fd is not None, it should be a file descriptor open to a directory,
4488 and path should be relative; path will then be relative to that directory.
4489dir_fd may not be implemented on your platform.
4490 If it is unavailable, using it will raise a NotImplementedError.
4491
4492[clinic start generated code]*/
4493
Larry Hastings2f936352014-08-05 14:04:04 +10004494static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004495os_unlink_impl(PyObject *module, path_t *path, int dir_fd)
4496/*[clinic end generated code: output=621797807b9963b1 input=d7bcde2b1b2a2552]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004497{
4498 int result;
Larry Hastings9cf065c2012-06-22 16:30:09 -07004499
Steve Dowera00b5be2020-02-13 08:30:27 +00004500 if (PySys_Audit("os.remove", "Oi", path->object,
4501 dir_fd == DEFAULT_DIR_FD ? -1 : dir_fd) < 0) {
4502 return NULL;
4503 }
4504
Larry Hastings9cf065c2012-06-22 16:30:09 -07004505 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04004506 _Py_BEGIN_SUPPRESS_IPH
Larry Hastings9cf065c2012-06-22 16:30:09 -07004507#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07004508 /* Windows, success=1, UNIX, success=0 */
4509 result = !Py_DeleteFileW(path->wide);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004510#else
Larry Hastings9cf065c2012-06-22 16:30:09 -07004511#ifdef HAVE_UNLINKAT
4512 if (dir_fd != DEFAULT_DIR_FD)
Larry Hastings2f936352014-08-05 14:04:04 +10004513 result = unlinkat(dir_fd, path->narrow, 0);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004514 else
4515#endif /* HAVE_UNLINKAT */
Larry Hastings2f936352014-08-05 14:04:04 +10004516 result = unlink(path->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004517#endif
Steve Dower8fc89802015-04-12 00:26:27 -04004518 _Py_END_SUPPRESS_IPH
Larry Hastings9cf065c2012-06-22 16:30:09 -07004519 Py_END_ALLOW_THREADS
4520
Larry Hastings2f936352014-08-05 14:04:04 +10004521 if (result)
4522 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004523
Larry Hastings2f936352014-08-05 14:04:04 +10004524 Py_RETURN_NONE;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004525}
4526
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004527
Larry Hastings2f936352014-08-05 14:04:04 +10004528/*[clinic input]
4529os.remove = os.unlink
4530
4531Remove a file (same as unlink()).
4532
4533If dir_fd is not None, it should be a file descriptor open to a directory,
4534 and path should be relative; path will then be relative to that directory.
4535dir_fd may not be implemented on your platform.
4536 If it is unavailable, using it will raise a NotImplementedError.
4537[clinic start generated code]*/
4538
Larry Hastings2f936352014-08-05 14:04:04 +10004539static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004540os_remove_impl(PyObject *module, path_t *path, int dir_fd)
4541/*[clinic end generated code: output=a8535b28f0068883 input=e05c5ab55cd30983]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004542{
4543 return os_unlink_impl(module, path, dir_fd);
4544}
4545
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004546
Larry Hastings605a62d2012-06-24 04:33:36 -07004547static PyStructSequence_Field uname_result_fields[] = {
4548 {"sysname", "operating system name"},
4549 {"nodename", "name of machine on network (implementation-defined)"},
4550 {"release", "operating system release"},
4551 {"version", "operating system version"},
4552 {"machine", "hardware identifier"},
4553 {NULL}
4554};
4555
4556PyDoc_STRVAR(uname_result__doc__,
4557"uname_result: Result from os.uname().\n\n\
4558This object may be accessed either as a tuple of\n\
4559 (sysname, nodename, release, version, machine),\n\
4560or via the attributes sysname, nodename, release, version, and machine.\n\
4561\n\
4562See os.uname for more information.");
4563
4564static PyStructSequence_Desc uname_result_desc = {
4565 "uname_result", /* name */
4566 uname_result__doc__, /* doc */
4567 uname_result_fields,
4568 5
4569};
4570
Eddie Elizondo474eedf2018-11-13 04:09:31 -08004571static PyTypeObject* UnameResultType;
Larry Hastings605a62d2012-06-24 04:33:36 -07004572
4573
4574#ifdef HAVE_UNAME
Larry Hastings2f936352014-08-05 14:04:04 +10004575/*[clinic input]
4576os.uname
4577
4578Return an object identifying the current operating system.
4579
4580The object behaves like a named tuple with the following fields:
4581 (sysname, nodename, release, version, machine)
4582
4583[clinic start generated code]*/
4584
Larry Hastings2f936352014-08-05 14:04:04 +10004585static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004586os_uname_impl(PyObject *module)
4587/*[clinic end generated code: output=e6a49cf1a1508a19 input=e68bd246db3043ed]*/
Guido van Rossumc39de5f1992-02-05 11:15:54 +00004588{
Victor Stinner8c62be82010-05-06 00:08:46 +00004589 struct utsname u;
4590 int res;
Larry Hastings605a62d2012-06-24 04:33:36 -07004591 PyObject *value;
Neal Norwitze241ce82003-02-17 18:17:05 +00004592
Victor Stinner8c62be82010-05-06 00:08:46 +00004593 Py_BEGIN_ALLOW_THREADS
4594 res = uname(&u);
4595 Py_END_ALLOW_THREADS
4596 if (res < 0)
4597 return posix_error();
Larry Hastings605a62d2012-06-24 04:33:36 -07004598
Eddie Elizondo474eedf2018-11-13 04:09:31 -08004599 value = PyStructSequence_New(UnameResultType);
Larry Hastings605a62d2012-06-24 04:33:36 -07004600 if (value == NULL)
4601 return NULL;
4602
4603#define SET(i, field) \
4604 { \
Victor Stinnera534fc42013-06-03 22:07:27 +02004605 PyObject *o = PyUnicode_DecodeFSDefault(field); \
Larry Hastings605a62d2012-06-24 04:33:36 -07004606 if (!o) { \
4607 Py_DECREF(value); \
4608 return NULL; \
4609 } \
4610 PyStructSequence_SET_ITEM(value, i, o); \
4611 } \
4612
4613 SET(0, u.sysname);
4614 SET(1, u.nodename);
4615 SET(2, u.release);
4616 SET(3, u.version);
4617 SET(4, u.machine);
4618
4619#undef SET
4620
4621 return value;
Guido van Rossumc39de5f1992-02-05 11:15:54 +00004622}
Guido van Rossumb6775db1994-08-01 11:34:53 +00004623#endif /* HAVE_UNAME */
Guido van Rossum1ff6cb41991-04-08 20:59:13 +00004624
Larry Hastings9e3e70b2011-09-08 19:29:07 -07004625
Larry Hastings9cf065c2012-06-22 16:30:09 -07004626
4627typedef struct {
4628 int now;
4629 time_t atime_s;
4630 long atime_ns;
4631 time_t mtime_s;
4632 long mtime_ns;
4633} utime_t;
4634
4635/*
Victor Stinner484df002014-10-09 13:52:31 +02004636 * these macros assume that "ut" is a pointer to a utime_t
Larry Hastings9cf065c2012-06-22 16:30:09 -07004637 * they also intentionally leak the declaration of a pointer named "time"
4638 */
4639#define UTIME_TO_TIMESPEC \
4640 struct timespec ts[2]; \
4641 struct timespec *time; \
Victor Stinner484df002014-10-09 13:52:31 +02004642 if (ut->now) \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004643 time = NULL; \
4644 else { \
Victor Stinner484df002014-10-09 13:52:31 +02004645 ts[0].tv_sec = ut->atime_s; \
4646 ts[0].tv_nsec = ut->atime_ns; \
4647 ts[1].tv_sec = ut->mtime_s; \
4648 ts[1].tv_nsec = ut->mtime_ns; \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004649 time = ts; \
4650 } \
4651
4652#define UTIME_TO_TIMEVAL \
4653 struct timeval tv[2]; \
4654 struct timeval *time; \
Victor Stinner484df002014-10-09 13:52:31 +02004655 if (ut->now) \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004656 time = NULL; \
4657 else { \
Victor Stinner484df002014-10-09 13:52:31 +02004658 tv[0].tv_sec = ut->atime_s; \
4659 tv[0].tv_usec = ut->atime_ns / 1000; \
4660 tv[1].tv_sec = ut->mtime_s; \
4661 tv[1].tv_usec = ut->mtime_ns / 1000; \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004662 time = tv; \
4663 } \
4664
4665#define UTIME_TO_UTIMBUF \
Georg Brandle1a7d9d2014-10-12 08:45:15 +02004666 struct utimbuf u; \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004667 struct utimbuf *time; \
Victor Stinner484df002014-10-09 13:52:31 +02004668 if (ut->now) \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004669 time = NULL; \
4670 else { \
Georg Brandle1a7d9d2014-10-12 08:45:15 +02004671 u.actime = ut->atime_s; \
4672 u.modtime = ut->mtime_s; \
4673 time = &u; \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004674 }
4675
4676#define UTIME_TO_TIME_T \
4677 time_t timet[2]; \
Georg Brandle1a7d9d2014-10-12 08:45:15 +02004678 time_t *time; \
Victor Stinner484df002014-10-09 13:52:31 +02004679 if (ut->now) \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004680 time = NULL; \
4681 else { \
Victor Stinner484df002014-10-09 13:52:31 +02004682 timet[0] = ut->atime_s; \
4683 timet[1] = ut->mtime_s; \
Georg Brandle1a7d9d2014-10-12 08:45:15 +02004684 time = timet; \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004685 } \
4686
4687
Victor Stinner528a9ab2015-09-03 21:30:26 +02004688#if defined(HAVE_FUTIMESAT) || defined(HAVE_UTIMENSAT)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004689
4690static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02004691utime_dir_fd(utime_t *ut, int dir_fd, const char *path, int follow_symlinks)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004692{
4693#ifdef HAVE_UTIMENSAT
4694 int flags = follow_symlinks ? 0 : AT_SYMLINK_NOFOLLOW;
4695 UTIME_TO_TIMESPEC;
4696 return utimensat(dir_fd, path, time, flags);
4697#elif defined(HAVE_FUTIMESAT)
4698 UTIME_TO_TIMEVAL;
4699 /*
4700 * follow_symlinks will never be false here;
4701 * we only allow !follow_symlinks and dir_fd together
4702 * if we have utimensat()
4703 */
4704 assert(follow_symlinks);
4705 return futimesat(dir_fd, path, time);
4706#endif
4707}
4708
Larry Hastings2f936352014-08-05 14:04:04 +10004709 #define FUTIMENSAT_DIR_FD_CONVERTER dir_fd_converter
4710#else
4711 #define FUTIMENSAT_DIR_FD_CONVERTER dir_fd_unavailable
Larry Hastings9cf065c2012-06-22 16:30:09 -07004712#endif
4713
Victor Stinner528a9ab2015-09-03 21:30:26 +02004714#if defined(HAVE_FUTIMES) || defined(HAVE_FUTIMENS)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004715
4716static int
Victor Stinner484df002014-10-09 13:52:31 +02004717utime_fd(utime_t *ut, int fd)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004718{
4719#ifdef HAVE_FUTIMENS
4720 UTIME_TO_TIMESPEC;
4721 return futimens(fd, time);
4722#else
4723 UTIME_TO_TIMEVAL;
4724 return futimes(fd, time);
4725#endif
4726}
4727
Larry Hastings2f936352014-08-05 14:04:04 +10004728 #define PATH_UTIME_HAVE_FD 1
4729#else
4730 #define PATH_UTIME_HAVE_FD 0
Larry Hastings9cf065c2012-06-22 16:30:09 -07004731#endif
4732
Victor Stinner5ebae872015-09-22 01:29:33 +02004733#if defined(HAVE_UTIMENSAT) || defined(HAVE_LUTIMES)
4734# define UTIME_HAVE_NOFOLLOW_SYMLINKS
4735#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07004736
Victor Stinner4552ced2015-09-21 22:37:15 +02004737#ifdef UTIME_HAVE_NOFOLLOW_SYMLINKS
Larry Hastings9cf065c2012-06-22 16:30:09 -07004738
4739static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02004740utime_nofollow_symlinks(utime_t *ut, const char *path)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004741{
4742#ifdef HAVE_UTIMENSAT
4743 UTIME_TO_TIMESPEC;
4744 return utimensat(DEFAULT_DIR_FD, path, time, AT_SYMLINK_NOFOLLOW);
4745#else
4746 UTIME_TO_TIMEVAL;
4747 return lutimes(path, time);
4748#endif
4749}
4750
4751#endif
4752
4753#ifndef MS_WINDOWS
4754
4755static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02004756utime_default(utime_t *ut, const char *path)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004757{
4758#ifdef HAVE_UTIMENSAT
4759 UTIME_TO_TIMESPEC;
4760 return utimensat(DEFAULT_DIR_FD, path, time, 0);
4761#elif defined(HAVE_UTIMES)
4762 UTIME_TO_TIMEVAL;
4763 return utimes(path, time);
4764#elif defined(HAVE_UTIME_H)
4765 UTIME_TO_UTIMBUF;
4766 return utime(path, time);
4767#else
4768 UTIME_TO_TIME_T;
4769 return utime(path, time);
4770#endif
4771}
4772
4773#endif
4774
Larry Hastings76ad59b2012-05-03 00:30:07 -07004775static int
4776split_py_long_to_s_and_ns(PyObject *py_long, time_t *s, long *ns)
4777{
4778 int result = 0;
Benjamin Petersonfbd85a02012-05-04 11:06:09 -04004779 PyObject *divmod;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004780 divmod = PyNumber_Divmod(py_long, billion);
4781 if (!divmod)
4782 goto exit;
Oren Milman0bd1a2d2018-09-12 22:14:35 +03004783 if (!PyTuple_Check(divmod) || PyTuple_GET_SIZE(divmod) != 2) {
4784 PyErr_Format(PyExc_TypeError,
4785 "%.200s.__divmod__() must return a 2-tuple, not %.200s",
4786 Py_TYPE(py_long)->tp_name, Py_TYPE(divmod)->tp_name);
4787 goto exit;
4788 }
Larry Hastings76ad59b2012-05-03 00:30:07 -07004789 *s = _PyLong_AsTime_t(PyTuple_GET_ITEM(divmod, 0));
4790 if ((*s == -1) && PyErr_Occurred())
4791 goto exit;
4792 *ns = PyLong_AsLong(PyTuple_GET_ITEM(divmod, 1));
Benjamin Peterson35a8f0d2012-05-04 01:10:59 -04004793 if ((*ns == -1) && PyErr_Occurred())
Larry Hastings76ad59b2012-05-03 00:30:07 -07004794 goto exit;
4795
4796 result = 1;
4797exit:
4798 Py_XDECREF(divmod);
4799 return result;
4800}
4801
Larry Hastings2f936352014-08-05 14:04:04 +10004802
4803/*[clinic input]
4804os.utime
4805
4806 path: path_t(allow_fd='PATH_UTIME_HAVE_FD')
Serhiy Storchakad322abb2019-09-14 13:31:50 +03004807 times: object = None
Larry Hastings2f936352014-08-05 14:04:04 +10004808 *
4809 ns: object = NULL
4810 dir_fd: dir_fd(requires='futimensat') = None
4811 follow_symlinks: bool=True
4812
Martin Panter0ff89092015-09-09 01:56:53 +00004813# "utime(path, times=None, *[, ns], dir_fd=None, follow_symlinks=True)\n\
Larry Hastings2f936352014-08-05 14:04:04 +10004814
4815Set the access and modified time of path.
4816
4817path may always be specified as a string.
4818On some platforms, path may also be specified as an open file descriptor.
4819 If this functionality is unavailable, using it raises an exception.
4820
4821If times is not None, it must be a tuple (atime, mtime);
4822 atime and mtime should be expressed as float seconds since the epoch.
Martin Panter0ff89092015-09-09 01:56:53 +00004823If ns is specified, it must be a tuple (atime_ns, mtime_ns);
Larry Hastings2f936352014-08-05 14:04:04 +10004824 atime_ns and mtime_ns should be expressed as integer nanoseconds
4825 since the epoch.
Martin Panter0ff89092015-09-09 01:56:53 +00004826If times is None and ns is unspecified, utime uses the current time.
Larry Hastings2f936352014-08-05 14:04:04 +10004827Specifying tuples for both times and ns is an error.
4828
4829If dir_fd is not None, it should be a file descriptor open to a directory,
4830 and path should be relative; path will then be relative to that directory.
4831If follow_symlinks is False, and the last element of the path is a symbolic
4832 link, utime will modify the symbolic link itself instead of the file the
4833 link points to.
4834It is an error to use dir_fd or follow_symlinks when specifying path
4835 as an open file descriptor.
4836dir_fd and follow_symlinks may not be available on your platform.
4837 If they are unavailable, using them will raise a NotImplementedError.
4838
4839[clinic start generated code]*/
4840
Larry Hastings2f936352014-08-05 14:04:04 +10004841static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004842os_utime_impl(PyObject *module, path_t *path, PyObject *times, PyObject *ns,
4843 int dir_fd, int follow_symlinks)
Serhiy Storchakad322abb2019-09-14 13:31:50 +03004844/*[clinic end generated code: output=cfcac69d027b82cf input=2fbd62a2f228f8f4]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004845{
Larry Hastings9cf065c2012-06-22 16:30:09 -07004846#ifdef MS_WINDOWS
4847 HANDLE hFile;
4848 FILETIME atime, mtime;
4849#else
4850 int result;
4851#endif
Larry Hastings76ad59b2012-05-03 00:30:07 -07004852
Larry Hastings2f936352014-08-05 14:04:04 +10004853 utime_t utime;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004854
Christian Heimesb3c87242013-08-01 00:08:16 +02004855 memset(&utime, 0, sizeof(utime_t));
Larry Hastings76ad59b2012-05-03 00:30:07 -07004856
Serhiy Storchakad322abb2019-09-14 13:31:50 +03004857 if (times != Py_None && ns) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07004858 PyErr_SetString(PyExc_ValueError,
4859 "utime: you may specify either 'times'"
4860 " or 'ns' but not both");
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004861 return NULL;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004862 }
4863
Serhiy Storchakad322abb2019-09-14 13:31:50 +03004864 if (times != Py_None) {
Antoine Pitroucf8a1e52013-04-17 22:06:44 +02004865 time_t a_sec, m_sec;
4866 long a_nsec, m_nsec;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004867 if (!PyTuple_CheckExact(times) || (PyTuple_Size(times) != 2)) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07004868 PyErr_SetString(PyExc_TypeError,
4869 "utime: 'times' must be either"
4870 " a tuple of two ints or None");
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004871 return NULL;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004872 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07004873 utime.now = 0;
Benjamin Petersonb399ab22012-05-04 01:31:13 -04004874 if (_PyTime_ObjectToTimespec(PyTuple_GET_ITEM(times, 0),
Victor Stinnerdca028b2015-03-30 01:02:57 +02004875 &a_sec, &a_nsec, _PyTime_ROUND_FLOOR) == -1 ||
Benjamin Petersonb399ab22012-05-04 01:31:13 -04004876 _PyTime_ObjectToTimespec(PyTuple_GET_ITEM(times, 1),
Victor Stinnerdca028b2015-03-30 01:02:57 +02004877 &m_sec, &m_nsec, _PyTime_ROUND_FLOOR) == -1) {
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004878 return NULL;
Larry Hastingsb3336402012-05-04 02:31:57 -07004879 }
Antoine Pitroucf8a1e52013-04-17 22:06:44 +02004880 utime.atime_s = a_sec;
4881 utime.atime_ns = a_nsec;
4882 utime.mtime_s = m_sec;
4883 utime.mtime_ns = m_nsec;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004884 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07004885 else if (ns) {
Larry Hastings76ad59b2012-05-03 00:30:07 -07004886 if (!PyTuple_CheckExact(ns) || (PyTuple_Size(ns) != 2)) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07004887 PyErr_SetString(PyExc_TypeError,
4888 "utime: 'ns' must be a tuple of two ints");
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004889 return NULL;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004890 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07004891 utime.now = 0;
Benjamin Petersonb399ab22012-05-04 01:31:13 -04004892 if (!split_py_long_to_s_and_ns(PyTuple_GET_ITEM(ns, 0),
Larry Hastings9cf065c2012-06-22 16:30:09 -07004893 &utime.atime_s, &utime.atime_ns) ||
Benjamin Petersonb399ab22012-05-04 01:31:13 -04004894 !split_py_long_to_s_and_ns(PyTuple_GET_ITEM(ns, 1),
Larry Hastings9cf065c2012-06-22 16:30:09 -07004895 &utime.mtime_s, &utime.mtime_ns)) {
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004896 return NULL;
Larry Hastingsb3336402012-05-04 02:31:57 -07004897 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07004898 }
4899 else {
4900 /* times and ns are both None/unspecified. use "now". */
4901 utime.now = 1;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004902 }
4903
Victor Stinner4552ced2015-09-21 22:37:15 +02004904#if !defined(UTIME_HAVE_NOFOLLOW_SYMLINKS)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004905 if (follow_symlinks_specified("utime", follow_symlinks))
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004906 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07004907#endif
Benjamin Petersonb399ab22012-05-04 01:31:13 -04004908
Larry Hastings2f936352014-08-05 14:04:04 +10004909 if (path_and_dir_fd_invalid("utime", path, dir_fd) ||
4910 dir_fd_and_fd_invalid("utime", dir_fd, path->fd) ||
4911 fd_and_follow_symlinks_invalid("utime", path->fd, follow_symlinks))
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004912 return NULL;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004913
Larry Hastings9cf065c2012-06-22 16:30:09 -07004914#if !defined(HAVE_UTIMENSAT)
4915 if ((dir_fd != DEFAULT_DIR_FD) && (!follow_symlinks)) {
Georg Brandl969288e2012-06-26 09:25:44 +02004916 PyErr_SetString(PyExc_ValueError,
Larry Hastings9cf065c2012-06-22 16:30:09 -07004917 "utime: cannot use dir_fd and follow_symlinks "
4918 "together on this platform");
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004919 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07004920 }
4921#endif
Larry Hastings76ad59b2012-05-03 00:30:07 -07004922
Steve Dowera00b5be2020-02-13 08:30:27 +00004923 if (PySys_Audit("os.utime", "OOOi", path->object, times, ns ? ns : Py_None,
4924 dir_fd == DEFAULT_DIR_FD ? -1 : dir_fd) < 0) {
4925 return NULL;
4926 }
4927
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00004928#ifdef MS_WINDOWS
Larry Hastings9cf065c2012-06-22 16:30:09 -07004929 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07004930 hFile = CreateFileW(path->wide, FILE_WRITE_ATTRIBUTES, 0,
4931 NULL, OPEN_EXISTING,
4932 FILE_FLAG_BACKUP_SEMANTICS, NULL);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004933 Py_END_ALLOW_THREADS
4934 if (hFile == INVALID_HANDLE_VALUE) {
Larry Hastings2f936352014-08-05 14:04:04 +10004935 path_error(path);
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004936 return NULL;
Larry Hastingsb3336402012-05-04 02:31:57 -07004937 }
4938
Larry Hastings9cf065c2012-06-22 16:30:09 -07004939 if (utime.now) {
Antoine Pitrou91a7af32013-11-23 15:23:26 +01004940 GetSystemTimeAsFileTime(&mtime);
4941 atime = mtime;
Victor Stinner8c62be82010-05-06 00:08:46 +00004942 }
Victor Stinner8c62be82010-05-06 00:08:46 +00004943 else {
Steve Dowerbf1f3762015-02-21 15:26:02 -08004944 _Py_time_t_to_FILE_TIME(utime.atime_s, utime.atime_ns, &atime);
4945 _Py_time_t_to_FILE_TIME(utime.mtime_s, utime.mtime_ns, &mtime);
Victor Stinner8c62be82010-05-06 00:08:46 +00004946 }
4947 if (!SetFileTime(hFile, NULL, &atime, &mtime)) {
4948 /* Avoid putting the file name into the error here,
4949 as that may confuse the user into believing that
4950 something is wrong with the file, when it also
4951 could be the time stamp that gives a problem. */
Victor Stinnerb024e842012-10-31 22:24:06 +01004952 PyErr_SetFromWindowsErr(0);
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004953 CloseHandle(hFile);
4954 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00004955 }
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004956 CloseHandle(hFile);
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00004957#else /* MS_WINDOWS */
Larry Hastings9cf065c2012-06-22 16:30:09 -07004958 Py_BEGIN_ALLOW_THREADS
Guido van Rossum1ff6cb41991-04-08 20:59:13 +00004959
Victor Stinner4552ced2015-09-21 22:37:15 +02004960#ifdef UTIME_HAVE_NOFOLLOW_SYMLINKS
Larry Hastings9cf065c2012-06-22 16:30:09 -07004961 if ((!follow_symlinks) && (dir_fd == DEFAULT_DIR_FD))
Larry Hastings2f936352014-08-05 14:04:04 +10004962 result = utime_nofollow_symlinks(&utime, path->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004963 else
Larry Hastings9e3e70b2011-09-08 19:29:07 -07004964#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07004965
Victor Stinner528a9ab2015-09-03 21:30:26 +02004966#if defined(HAVE_FUTIMESAT) || defined(HAVE_UTIMENSAT)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004967 if ((dir_fd != DEFAULT_DIR_FD) || (!follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10004968 result = utime_dir_fd(&utime, dir_fd, path->narrow, follow_symlinks);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004969 else
4970#endif
4971
Victor Stinner528a9ab2015-09-03 21:30:26 +02004972#if defined(HAVE_FUTIMES) || defined(HAVE_FUTIMENS)
Larry Hastings2f936352014-08-05 14:04:04 +10004973 if (path->fd != -1)
4974 result = utime_fd(&utime, path->fd);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004975 else
4976#endif
4977
Larry Hastings2f936352014-08-05 14:04:04 +10004978 result = utime_default(&utime, path->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004979
4980 Py_END_ALLOW_THREADS
4981
4982 if (result < 0) {
4983 /* see previous comment about not putting filename in error here */
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004984 posix_error();
4985 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00004986 }
Larry Hastings76ad59b2012-05-03 00:30:07 -07004987
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00004988#endif /* MS_WINDOWS */
Larry Hastings9cf065c2012-06-22 16:30:09 -07004989
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004990 Py_RETURN_NONE;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004991}
4992
Guido van Rossum3b066191991-06-04 19:40:25 +00004993/* Process operations */
Guido van Rossum85e3b011991-06-03 12:42:10 +00004994
Larry Hastings2f936352014-08-05 14:04:04 +10004995
4996/*[clinic input]
4997os._exit
4998
4999 status: int
5000
5001Exit to the system with specified status, without normal exit processing.
5002[clinic start generated code]*/
5003
Larry Hastings2f936352014-08-05 14:04:04 +10005004static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005005os__exit_impl(PyObject *module, int status)
5006/*[clinic end generated code: output=116e52d9c2260d54 input=5e6d57556b0c4a62]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005007{
5008 _exit(status);
Victor Stinner8c62be82010-05-06 00:08:46 +00005009 return NULL; /* Make gcc -Wall happy */
Guido van Rossum85e3b011991-06-03 12:42:10 +00005010}
5011
Steve Dowercc16be82016-09-08 10:35:16 -07005012#if defined(HAVE_WEXECV) || defined(HAVE_WSPAWNV)
5013#define EXECV_CHAR wchar_t
5014#else
5015#define EXECV_CHAR char
5016#endif
5017
pxinwrf2d7ac72019-05-21 18:46:37 +08005018#if defined(HAVE_EXECV) || defined(HAVE_SPAWNV) || defined(HAVE_RTPSPAWN)
Martin v. Löwis114619e2002-10-07 06:44:21 +00005019static void
Steve Dowercc16be82016-09-08 10:35:16 -07005020free_string_array(EXECV_CHAR **array, Py_ssize_t count)
Martin v. Löwis114619e2002-10-07 06:44:21 +00005021{
Victor Stinner8c62be82010-05-06 00:08:46 +00005022 Py_ssize_t i;
5023 for (i = 0; i < count; i++)
5024 PyMem_Free(array[i]);
5025 PyMem_DEL(array);
Martin v. Löwis114619e2002-10-07 06:44:21 +00005026}
Martin v. Löwis011e8422009-05-05 04:43:17 +00005027
Berker Peksag81816462016-09-15 20:19:47 +03005028static int
5029fsconvert_strdup(PyObject *o, EXECV_CHAR **out)
Martin v. Löwis011e8422009-05-05 04:43:17 +00005030{
Victor Stinner8c62be82010-05-06 00:08:46 +00005031 Py_ssize_t size;
Berker Peksag81816462016-09-15 20:19:47 +03005032 PyObject *ub;
5033 int result = 0;
Steve Dowercc16be82016-09-08 10:35:16 -07005034#if defined(HAVE_WEXECV) || defined(HAVE_WSPAWNV)
Berker Peksag81816462016-09-15 20:19:47 +03005035 if (!PyUnicode_FSDecoder(o, &ub))
Steve Dowercc16be82016-09-08 10:35:16 -07005036 return 0;
Berker Peksag81816462016-09-15 20:19:47 +03005037 *out = PyUnicode_AsWideCharString(ub, &size);
5038 if (*out)
5039 result = 1;
Steve Dowercc16be82016-09-08 10:35:16 -07005040#else
Berker Peksag81816462016-09-15 20:19:47 +03005041 if (!PyUnicode_FSConverter(o, &ub))
Victor Stinner8c62be82010-05-06 00:08:46 +00005042 return 0;
Berker Peksag81816462016-09-15 20:19:47 +03005043 size = PyBytes_GET_SIZE(ub);
5044 *out = PyMem_Malloc(size + 1);
5045 if (*out) {
5046 memcpy(*out, PyBytes_AS_STRING(ub), size + 1);
5047 result = 1;
5048 } else
Victor Stinner50abf222013-11-07 23:56:10 +01005049 PyErr_NoMemory();
Steve Dowercc16be82016-09-08 10:35:16 -07005050#endif
Berker Peksag81816462016-09-15 20:19:47 +03005051 Py_DECREF(ub);
5052 return result;
Martin v. Löwis011e8422009-05-05 04:43:17 +00005053}
Martin v. Löwis114619e2002-10-07 06:44:21 +00005054#endif
5055
pxinwrf2d7ac72019-05-21 18:46:37 +08005056#if defined(HAVE_EXECV) || defined (HAVE_FEXECVE) || defined(HAVE_RTPSPAWN)
Steve Dowercc16be82016-09-08 10:35:16 -07005057static EXECV_CHAR**
Victor Stinner13bb71c2010-04-23 21:41:56 +00005058parse_envlist(PyObject* env, Py_ssize_t *envc_ptr)
5059{
Victor Stinner8c62be82010-05-06 00:08:46 +00005060 Py_ssize_t i, pos, envc;
5061 PyObject *keys=NULL, *vals=NULL;
Berker Peksag81816462016-09-15 20:19:47 +03005062 PyObject *key, *val, *key2, *val2, *keyval;
Steve Dowercc16be82016-09-08 10:35:16 -07005063 EXECV_CHAR **envlist;
Victor Stinner13bb71c2010-04-23 21:41:56 +00005064
Victor Stinner8c62be82010-05-06 00:08:46 +00005065 i = PyMapping_Size(env);
5066 if (i < 0)
5067 return NULL;
Steve Dowercc16be82016-09-08 10:35:16 -07005068 envlist = PyMem_NEW(EXECV_CHAR *, i + 1);
Victor Stinner8c62be82010-05-06 00:08:46 +00005069 if (envlist == NULL) {
5070 PyErr_NoMemory();
5071 return NULL;
5072 }
5073 envc = 0;
5074 keys = PyMapping_Keys(env);
Victor Stinnerb0314272013-11-14 21:37:05 +01005075 if (!keys)
5076 goto error;
Victor Stinner8c62be82010-05-06 00:08:46 +00005077 vals = PyMapping_Values(env);
Victor Stinnerb0314272013-11-14 21:37:05 +01005078 if (!vals)
Victor Stinner8c62be82010-05-06 00:08:46 +00005079 goto error;
5080 if (!PyList_Check(keys) || !PyList_Check(vals)) {
5081 PyErr_Format(PyExc_TypeError,
5082 "env.keys() or env.values() is not a list");
5083 goto error;
5084 }
Victor Stinner13bb71c2010-04-23 21:41:56 +00005085
Victor Stinner8c62be82010-05-06 00:08:46 +00005086 for (pos = 0; pos < i; pos++) {
5087 key = PyList_GetItem(keys, pos);
5088 val = PyList_GetItem(vals, pos);
5089 if (!key || !val)
5090 goto error;
Victor Stinner13bb71c2010-04-23 21:41:56 +00005091
Berker Peksag81816462016-09-15 20:19:47 +03005092#if defined(HAVE_WEXECV) || defined(HAVE_WSPAWNV)
5093 if (!PyUnicode_FSDecoder(key, &key2))
5094 goto error;
5095 if (!PyUnicode_FSDecoder(val, &val2)) {
5096 Py_DECREF(key2);
5097 goto error;
5098 }
Serhiy Storchaka77703942017-06-25 07:33:01 +03005099 /* Search from index 1 because on Windows starting '=' is allowed for
5100 defining hidden environment variables. */
5101 if (PyUnicode_GET_LENGTH(key2) == 0 ||
5102 PyUnicode_FindChar(key2, '=', 1, PyUnicode_GET_LENGTH(key2), 1) != -1)
5103 {
5104 PyErr_SetString(PyExc_ValueError, "illegal environment variable name");
Eric N. Vander Weelea7874c72017-06-26 21:35:20 -04005105 Py_DECREF(key2);
5106 Py_DECREF(val2);
Serhiy Storchaka77703942017-06-25 07:33:01 +03005107 goto error;
5108 }
Berker Peksag81816462016-09-15 20:19:47 +03005109 keyval = PyUnicode_FromFormat("%U=%U", key2, val2);
5110#else
5111 if (!PyUnicode_FSConverter(key, &key2))
5112 goto error;
5113 if (!PyUnicode_FSConverter(val, &val2)) {
5114 Py_DECREF(key2);
5115 goto error;
5116 }
Serhiy Storchaka77703942017-06-25 07:33:01 +03005117 if (PyBytes_GET_SIZE(key2) == 0 ||
5118 strchr(PyBytes_AS_STRING(key2) + 1, '=') != NULL)
5119 {
5120 PyErr_SetString(PyExc_ValueError, "illegal environment variable name");
Eric N. Vander Weelea7874c72017-06-26 21:35:20 -04005121 Py_DECREF(key2);
5122 Py_DECREF(val2);
Serhiy Storchaka77703942017-06-25 07:33:01 +03005123 goto error;
5124 }
Berker Peksag81816462016-09-15 20:19:47 +03005125 keyval = PyBytes_FromFormat("%s=%s", PyBytes_AS_STRING(key2),
5126 PyBytes_AS_STRING(val2));
5127#endif
5128 Py_DECREF(key2);
5129 Py_DECREF(val2);
Steve Dowercc16be82016-09-08 10:35:16 -07005130 if (!keyval)
Victor Stinner8c62be82010-05-06 00:08:46 +00005131 goto error;
Steve Dowercc16be82016-09-08 10:35:16 -07005132
5133 if (!fsconvert_strdup(keyval, &envlist[envc++])) {
5134 Py_DECREF(keyval);
Victor Stinner8c62be82010-05-06 00:08:46 +00005135 goto error;
5136 }
Berker Peksag81816462016-09-15 20:19:47 +03005137
Steve Dowercc16be82016-09-08 10:35:16 -07005138 Py_DECREF(keyval);
Victor Stinner8c62be82010-05-06 00:08:46 +00005139 }
5140 Py_DECREF(vals);
5141 Py_DECREF(keys);
Victor Stinner13bb71c2010-04-23 21:41:56 +00005142
Victor Stinner8c62be82010-05-06 00:08:46 +00005143 envlist[envc] = 0;
5144 *envc_ptr = envc;
5145 return envlist;
Victor Stinner13bb71c2010-04-23 21:41:56 +00005146
5147error:
Victor Stinner8c62be82010-05-06 00:08:46 +00005148 Py_XDECREF(keys);
5149 Py_XDECREF(vals);
Steve Dowercc16be82016-09-08 10:35:16 -07005150 free_string_array(envlist, envc);
Victor Stinner8c62be82010-05-06 00:08:46 +00005151 return NULL;
Victor Stinner13bb71c2010-04-23 21:41:56 +00005152}
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00005153
Steve Dowercc16be82016-09-08 10:35:16 -07005154static EXECV_CHAR**
Ross Lagerwall7807c352011-03-17 20:20:30 +02005155parse_arglist(PyObject* argv, Py_ssize_t *argc)
5156{
5157 int i;
Steve Dowercc16be82016-09-08 10:35:16 -07005158 EXECV_CHAR **argvlist = PyMem_NEW(EXECV_CHAR *, *argc+1);
Ross Lagerwall7807c352011-03-17 20:20:30 +02005159 if (argvlist == NULL) {
5160 PyErr_NoMemory();
5161 return NULL;
5162 }
5163 for (i = 0; i < *argc; i++) {
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02005164 PyObject* item = PySequence_ITEM(argv, i);
5165 if (item == NULL)
5166 goto fail;
5167 if (!fsconvert_strdup(item, &argvlist[i])) {
5168 Py_DECREF(item);
Ross Lagerwall7807c352011-03-17 20:20:30 +02005169 goto fail;
5170 }
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02005171 Py_DECREF(item);
Ross Lagerwall7807c352011-03-17 20:20:30 +02005172 }
5173 argvlist[*argc] = NULL;
5174 return argvlist;
5175fail:
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02005176 *argc = i;
Ross Lagerwall7807c352011-03-17 20:20:30 +02005177 free_string_array(argvlist, *argc);
5178 return NULL;
5179}
Steve Dowercc16be82016-09-08 10:35:16 -07005180
Ross Lagerwall7807c352011-03-17 20:20:30 +02005181#endif
5182
Larry Hastings2f936352014-08-05 14:04:04 +10005183
Ross Lagerwall7807c352011-03-17 20:20:30 +02005184#ifdef HAVE_EXECV
Larry Hastings2f936352014-08-05 14:04:04 +10005185/*[clinic input]
5186os.execv
5187
Steve Dowercc16be82016-09-08 10:35:16 -07005188 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +10005189 Path of executable file.
5190 argv: object
5191 Tuple or list of strings.
5192 /
5193
5194Execute an executable path with arguments, replacing current process.
5195[clinic start generated code]*/
5196
Larry Hastings2f936352014-08-05 14:04:04 +10005197static PyObject *
Steve Dowercc16be82016-09-08 10:35:16 -07005198os_execv_impl(PyObject *module, path_t *path, PyObject *argv)
5199/*[clinic end generated code: output=3b52fec34cd0dafd input=9bac31efae07dac7]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005200{
Steve Dowercc16be82016-09-08 10:35:16 -07005201 EXECV_CHAR **argvlist;
Ross Lagerwall7807c352011-03-17 20:20:30 +02005202 Py_ssize_t argc;
5203
5204 /* execv has two arguments: (path, argv), where
5205 argv is a list or tuple of strings. */
5206
Ross Lagerwall7807c352011-03-17 20:20:30 +02005207 if (!PyList_Check(argv) && !PyTuple_Check(argv)) {
5208 PyErr_SetString(PyExc_TypeError,
5209 "execv() arg 2 must be a tuple or list");
Ross Lagerwall7807c352011-03-17 20:20:30 +02005210 return NULL;
5211 }
5212 argc = PySequence_Size(argv);
5213 if (argc < 1) {
5214 PyErr_SetString(PyExc_ValueError, "execv() arg 2 must not be empty");
Ross Lagerwall7807c352011-03-17 20:20:30 +02005215 return NULL;
5216 }
5217
5218 argvlist = parse_arglist(argv, &argc);
5219 if (argvlist == NULL) {
Ross Lagerwall7807c352011-03-17 20:20:30 +02005220 return NULL;
5221 }
Steve Dowerbce26262016-11-19 19:17:26 -08005222 if (!argvlist[0][0]) {
5223 PyErr_SetString(PyExc_ValueError,
5224 "execv() arg 2 first element cannot be empty");
5225 free_string_array(argvlist, argc);
5226 return NULL;
5227 }
Ross Lagerwall7807c352011-03-17 20:20:30 +02005228
Steve Dowera00b5be2020-02-13 08:30:27 +00005229 if (PySys_Audit("os.exec", "OOO", path->object, argv, Py_None) < 0) {
Miss Islington (bot)3498ac52020-02-04 16:32:32 -08005230 free_string_array(argvlist, argc);
5231 return NULL;
5232 }
5233
Steve Dowerbce26262016-11-19 19:17:26 -08005234 _Py_BEGIN_SUPPRESS_IPH
Steve Dowercc16be82016-09-08 10:35:16 -07005235#ifdef HAVE_WEXECV
5236 _wexecv(path->wide, argvlist);
5237#else
5238 execv(path->narrow, argvlist);
5239#endif
Steve Dowerbce26262016-11-19 19:17:26 -08005240 _Py_END_SUPPRESS_IPH
Ross Lagerwall7807c352011-03-17 20:20:30 +02005241
5242 /* If we get here it's definitely an error */
5243
5244 free_string_array(argvlist, argc);
Ross Lagerwall7807c352011-03-17 20:20:30 +02005245 return posix_error();
5246}
5247
Larry Hastings2f936352014-08-05 14:04:04 +10005248
5249/*[clinic input]
5250os.execve
5251
5252 path: path_t(allow_fd='PATH_HAVE_FEXECVE')
5253 Path of executable file.
5254 argv: object
5255 Tuple or list of strings.
5256 env: object
5257 Dictionary of strings mapping to strings.
5258
5259Execute an executable path with arguments, replacing current process.
5260[clinic start generated code]*/
5261
Larry Hastings2f936352014-08-05 14:04:04 +10005262static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005263os_execve_impl(PyObject *module, path_t *path, PyObject *argv, PyObject *env)
5264/*[clinic end generated code: output=ff9fa8e4da8bde58 input=626804fa092606d9]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005265{
Steve Dowercc16be82016-09-08 10:35:16 -07005266 EXECV_CHAR **argvlist = NULL;
5267 EXECV_CHAR **envlist;
Ross Lagerwall7807c352011-03-17 20:20:30 +02005268 Py_ssize_t argc, envc;
Guido van Rossumc6dcc9f1993-11-05 10:15:19 +00005269
Victor Stinner8c62be82010-05-06 00:08:46 +00005270 /* execve has three arguments: (path, argv, env), where
5271 argv is a list or tuple of strings and env is a dictionary
5272 like posix.environ. */
Guido van Rossumc6dcc9f1993-11-05 10:15:19 +00005273
Ross Lagerwall7807c352011-03-17 20:20:30 +02005274 if (!PyList_Check(argv) && !PyTuple_Check(argv)) {
Victor Stinner8c62be82010-05-06 00:08:46 +00005275 PyErr_SetString(PyExc_TypeError,
Larry Hastings9cf065c2012-06-22 16:30:09 -07005276 "execve: argv must be a tuple or list");
Miss Islington (bot)3498ac52020-02-04 16:32:32 -08005277 goto fail_0;
Victor Stinner8c62be82010-05-06 00:08:46 +00005278 }
Ross Lagerwall7807c352011-03-17 20:20:30 +02005279 argc = PySequence_Size(argv);
Steve Dowerbce26262016-11-19 19:17:26 -08005280 if (argc < 1) {
5281 PyErr_SetString(PyExc_ValueError, "execve: argv must not be empty");
5282 return NULL;
5283 }
5284
Victor Stinner8c62be82010-05-06 00:08:46 +00005285 if (!PyMapping_Check(env)) {
5286 PyErr_SetString(PyExc_TypeError,
Larry Hastings9cf065c2012-06-22 16:30:09 -07005287 "execve: environment must be a mapping object");
Miss Islington (bot)3498ac52020-02-04 16:32:32 -08005288 goto fail_0;
Victor Stinner8c62be82010-05-06 00:08:46 +00005289 }
Guido van Rossumc6dcc9f1993-11-05 10:15:19 +00005290
Ross Lagerwall7807c352011-03-17 20:20:30 +02005291 argvlist = parse_arglist(argv, &argc);
Victor Stinner8c62be82010-05-06 00:08:46 +00005292 if (argvlist == NULL) {
Miss Islington (bot)3498ac52020-02-04 16:32:32 -08005293 goto fail_0;
Victor Stinner8c62be82010-05-06 00:08:46 +00005294 }
Steve Dowerbce26262016-11-19 19:17:26 -08005295 if (!argvlist[0][0]) {
5296 PyErr_SetString(PyExc_ValueError,
5297 "execve: argv first element cannot be empty");
Miss Islington (bot)3498ac52020-02-04 16:32:32 -08005298 goto fail_0;
Steve Dowerbce26262016-11-19 19:17:26 -08005299 }
Guido van Rossumc6dcc9f1993-11-05 10:15:19 +00005300
Victor Stinner8c62be82010-05-06 00:08:46 +00005301 envlist = parse_envlist(env, &envc);
5302 if (envlist == NULL)
Miss Islington (bot)3498ac52020-02-04 16:32:32 -08005303 goto fail_0;
5304
Steve Dowera00b5be2020-02-13 08:30:27 +00005305 if (PySys_Audit("os.exec", "OOO", path->object, argv, env) < 0) {
Miss Islington (bot)3498ac52020-02-04 16:32:32 -08005306 goto fail_1;
5307 }
Ross Lagerwall7807c352011-03-17 20:20:30 +02005308
Steve Dowerbce26262016-11-19 19:17:26 -08005309 _Py_BEGIN_SUPPRESS_IPH
Larry Hastings9cf065c2012-06-22 16:30:09 -07005310#ifdef HAVE_FEXECVE
Larry Hastings2f936352014-08-05 14:04:04 +10005311 if (path->fd > -1)
5312 fexecve(path->fd, argvlist, envlist);
Larry Hastings9cf065c2012-06-22 16:30:09 -07005313 else
5314#endif
Steve Dowercc16be82016-09-08 10:35:16 -07005315#ifdef HAVE_WEXECV
5316 _wexecve(path->wide, argvlist, envlist);
5317#else
Larry Hastings2f936352014-08-05 14:04:04 +10005318 execve(path->narrow, argvlist, envlist);
Steve Dowercc16be82016-09-08 10:35:16 -07005319#endif
Steve Dowerbce26262016-11-19 19:17:26 -08005320 _Py_END_SUPPRESS_IPH
Ross Lagerwall7807c352011-03-17 20:20:30 +02005321
5322 /* If we get here it's definitely an error */
5323
Alexey Izbyshev83460312018-10-20 03:28:22 +03005324 posix_path_error(path);
Miss Islington (bot)3498ac52020-02-04 16:32:32 -08005325 fail_1:
Steve Dowercc16be82016-09-08 10:35:16 -07005326 free_string_array(envlist, envc);
Miss Islington (bot)3498ac52020-02-04 16:32:32 -08005327 fail_0:
Larry Hastings9cf065c2012-06-22 16:30:09 -07005328 if (argvlist)
5329 free_string_array(argvlist, argc);
Ross Lagerwall7807c352011-03-17 20:20:30 +02005330 return NULL;
5331}
Steve Dowercc16be82016-09-08 10:35:16 -07005332
Larry Hastings9cf065c2012-06-22 16:30:09 -07005333#endif /* HAVE_EXECV */
5334
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005335#ifdef HAVE_POSIX_SPAWN
5336
5337enum posix_spawn_file_actions_identifier {
5338 POSIX_SPAWN_OPEN,
5339 POSIX_SPAWN_CLOSE,
5340 POSIX_SPAWN_DUP2
5341};
5342
William Orr81574b82018-10-01 22:19:56 -07005343#if defined(HAVE_SCHED_SETPARAM) || defined(HAVE_SCHED_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDPARAM)
Serhiy Storchakaef347532018-05-01 16:45:04 +03005344static int
Pablo Galindo254a4662018-09-07 16:44:24 +01005345convert_sched_param(PyObject *param, struct sched_param *res);
William Orr81574b82018-10-01 22:19:56 -07005346#endif
Pablo Galindo254a4662018-09-07 16:44:24 +01005347
5348static int
Victor Stinner325e4ba2019-02-01 15:47:24 +01005349parse_posix_spawn_flags(const char *func_name, PyObject *setpgroup,
5350 int resetids, int setsid, PyObject *setsigmask,
Pablo Galindo254a4662018-09-07 16:44:24 +01005351 PyObject *setsigdef, PyObject *scheduler,
5352 posix_spawnattr_t *attrp)
5353{
5354 long all_flags = 0;
5355
5356 errno = posix_spawnattr_init(attrp);
5357 if (errno) {
5358 posix_error();
5359 return -1;
5360 }
5361
5362 if (setpgroup) {
5363 pid_t pgid = PyLong_AsPid(setpgroup);
5364 if (pgid == (pid_t)-1 && PyErr_Occurred()) {
5365 goto fail;
5366 }
5367 errno = posix_spawnattr_setpgroup(attrp, pgid);
5368 if (errno) {
5369 posix_error();
5370 goto fail;
5371 }
5372 all_flags |= POSIX_SPAWN_SETPGROUP;
5373 }
5374
5375 if (resetids) {
5376 all_flags |= POSIX_SPAWN_RESETIDS;
5377 }
5378
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005379 if (setsid) {
5380#ifdef POSIX_SPAWN_SETSID
5381 all_flags |= POSIX_SPAWN_SETSID;
5382#elif defined(POSIX_SPAWN_SETSID_NP)
5383 all_flags |= POSIX_SPAWN_SETSID_NP;
5384#else
5385 argument_unavailable_error(func_name, "setsid");
5386 return -1;
5387#endif
5388 }
5389
Pablo Galindo254a4662018-09-07 16:44:24 +01005390 if (setsigmask) {
5391 sigset_t set;
5392 if (!_Py_Sigset_Converter(setsigmask, &set)) {
5393 goto fail;
5394 }
5395 errno = posix_spawnattr_setsigmask(attrp, &set);
5396 if (errno) {
5397 posix_error();
5398 goto fail;
5399 }
5400 all_flags |= POSIX_SPAWN_SETSIGMASK;
5401 }
5402
5403 if (setsigdef) {
5404 sigset_t set;
5405 if (!_Py_Sigset_Converter(setsigdef, &set)) {
5406 goto fail;
5407 }
5408 errno = posix_spawnattr_setsigdefault(attrp, &set);
5409 if (errno) {
5410 posix_error();
5411 goto fail;
5412 }
5413 all_flags |= POSIX_SPAWN_SETSIGDEF;
5414 }
5415
5416 if (scheduler) {
5417#ifdef POSIX_SPAWN_SETSCHEDULER
5418 PyObject *py_schedpolicy;
5419 struct sched_param schedparam;
5420
5421 if (!PyArg_ParseTuple(scheduler, "OO&"
5422 ";A scheduler tuple must have two elements",
5423 &py_schedpolicy, convert_sched_param, &schedparam)) {
5424 goto fail;
5425 }
5426 if (py_schedpolicy != Py_None) {
5427 int schedpolicy = _PyLong_AsInt(py_schedpolicy);
5428
5429 if (schedpolicy == -1 && PyErr_Occurred()) {
5430 goto fail;
5431 }
5432 errno = posix_spawnattr_setschedpolicy(attrp, schedpolicy);
5433 if (errno) {
5434 posix_error();
5435 goto fail;
5436 }
5437 all_flags |= POSIX_SPAWN_SETSCHEDULER;
5438 }
5439 errno = posix_spawnattr_setschedparam(attrp, &schedparam);
5440 if (errno) {
5441 posix_error();
5442 goto fail;
5443 }
5444 all_flags |= POSIX_SPAWN_SETSCHEDPARAM;
5445#else
5446 PyErr_SetString(PyExc_NotImplementedError,
5447 "The scheduler option is not supported in this system.");
5448 goto fail;
5449#endif
5450 }
5451
5452 errno = posix_spawnattr_setflags(attrp, all_flags);
5453 if (errno) {
5454 posix_error();
5455 goto fail;
5456 }
5457
5458 return 0;
5459
5460fail:
5461 (void)posix_spawnattr_destroy(attrp);
5462 return -1;
5463}
5464
5465static int
Serhiy Storchakaef347532018-05-01 16:45:04 +03005466parse_file_actions(PyObject *file_actions,
Pablo Galindocb970732018-06-19 09:19:50 +01005467 posix_spawn_file_actions_t *file_actionsp,
5468 PyObject *temp_buffer)
Serhiy Storchakaef347532018-05-01 16:45:04 +03005469{
5470 PyObject *seq;
5471 PyObject *file_action = NULL;
5472 PyObject *tag_obj;
5473
5474 seq = PySequence_Fast(file_actions,
5475 "file_actions must be a sequence or None");
5476 if (seq == NULL) {
5477 return -1;
5478 }
5479
5480 errno = posix_spawn_file_actions_init(file_actionsp);
5481 if (errno) {
5482 posix_error();
5483 Py_DECREF(seq);
5484 return -1;
5485 }
5486
Miss Islington (bot)04d46922019-06-26 14:20:09 -07005487 for (Py_ssize_t i = 0; i < PySequence_Fast_GET_SIZE(seq); ++i) {
Serhiy Storchakaef347532018-05-01 16:45:04 +03005488 file_action = PySequence_Fast_GET_ITEM(seq, i);
5489 Py_INCREF(file_action);
5490 if (!PyTuple_Check(file_action) || !PyTuple_GET_SIZE(file_action)) {
5491 PyErr_SetString(PyExc_TypeError,
5492 "Each file_actions element must be a non-empty tuple");
5493 goto fail;
5494 }
5495 long tag = PyLong_AsLong(PyTuple_GET_ITEM(file_action, 0));
5496 if (tag == -1 && PyErr_Occurred()) {
5497 goto fail;
5498 }
5499
5500 /* Populate the file_actions object */
5501 switch (tag) {
5502 case POSIX_SPAWN_OPEN: {
5503 int fd, oflag;
5504 PyObject *path;
5505 unsigned long mode;
5506 if (!PyArg_ParseTuple(file_action, "OiO&ik"
5507 ";A open file_action tuple must have 5 elements",
5508 &tag_obj, &fd, PyUnicode_FSConverter, &path,
5509 &oflag, &mode))
5510 {
5511 goto fail;
5512 }
Pablo Galindocb970732018-06-19 09:19:50 +01005513 if (PyList_Append(temp_buffer, path)) {
5514 Py_DECREF(path);
5515 goto fail;
5516 }
Serhiy Storchakaef347532018-05-01 16:45:04 +03005517 errno = posix_spawn_file_actions_addopen(file_actionsp,
5518 fd, PyBytes_AS_STRING(path), oflag, (mode_t)mode);
Pablo Galindocb970732018-06-19 09:19:50 +01005519 Py_DECREF(path);
Serhiy Storchakaef347532018-05-01 16:45:04 +03005520 if (errno) {
5521 posix_error();
5522 goto fail;
5523 }
5524 break;
5525 }
5526 case POSIX_SPAWN_CLOSE: {
5527 int fd;
5528 if (!PyArg_ParseTuple(file_action, "Oi"
5529 ";A close file_action tuple must have 2 elements",
5530 &tag_obj, &fd))
5531 {
5532 goto fail;
5533 }
5534 errno = posix_spawn_file_actions_addclose(file_actionsp, fd);
5535 if (errno) {
5536 posix_error();
5537 goto fail;
5538 }
5539 break;
5540 }
5541 case POSIX_SPAWN_DUP2: {
5542 int fd1, fd2;
5543 if (!PyArg_ParseTuple(file_action, "Oii"
5544 ";A dup2 file_action tuple must have 3 elements",
5545 &tag_obj, &fd1, &fd2))
5546 {
5547 goto fail;
5548 }
5549 errno = posix_spawn_file_actions_adddup2(file_actionsp,
5550 fd1, fd2);
5551 if (errno) {
5552 posix_error();
5553 goto fail;
5554 }
5555 break;
5556 }
5557 default: {
5558 PyErr_SetString(PyExc_TypeError,
5559 "Unknown file_actions identifier");
5560 goto fail;
5561 }
5562 }
5563 Py_DECREF(file_action);
5564 }
Pablo Galindo254a4662018-09-07 16:44:24 +01005565
Serhiy Storchakaef347532018-05-01 16:45:04 +03005566 Py_DECREF(seq);
5567 return 0;
5568
5569fail:
5570 Py_DECREF(seq);
5571 Py_DECREF(file_action);
5572 (void)posix_spawn_file_actions_destroy(file_actionsp);
5573 return -1;
5574}
5575
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005576
5577static PyObject *
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005578py_posix_spawn(int use_posix_spawnp, PyObject *module, path_t *path, PyObject *argv,
5579 PyObject *env, PyObject *file_actions,
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005580 PyObject *setpgroup, int resetids, int setsid, PyObject *setsigmask,
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005581 PyObject *setsigdef, PyObject *scheduler)
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005582{
Victor Stinner325e4ba2019-02-01 15:47:24 +01005583 const char *func_name = use_posix_spawnp ? "posix_spawnp" : "posix_spawn";
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005584 EXECV_CHAR **argvlist = NULL;
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005585 EXECV_CHAR **envlist = NULL;
Serhiy Storchakaef347532018-05-01 16:45:04 +03005586 posix_spawn_file_actions_t file_actions_buf;
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005587 posix_spawn_file_actions_t *file_actionsp = NULL;
Pablo Galindo254a4662018-09-07 16:44:24 +01005588 posix_spawnattr_t attr;
5589 posix_spawnattr_t *attrp = NULL;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005590 Py_ssize_t argc, envc;
Serhiy Storchakaef347532018-05-01 16:45:04 +03005591 PyObject *result = NULL;
Pablo Galindocb970732018-06-19 09:19:50 +01005592 PyObject *temp_buffer = NULL;
Serhiy Storchakaef347532018-05-01 16:45:04 +03005593 pid_t pid;
5594 int err_code;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005595
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005596 /* posix_spawn and posix_spawnp have three arguments: (path, argv, env), where
Serhiy Storchakaef347532018-05-01 16:45:04 +03005597 argv is a list or tuple of strings and env is a dictionary
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005598 like posix.environ. */
5599
Serhiy Storchakaef347532018-05-01 16:45:04 +03005600 if (!PyList_Check(argv) && !PyTuple_Check(argv)) {
Victor Stinner325e4ba2019-02-01 15:47:24 +01005601 PyErr_Format(PyExc_TypeError,
5602 "%s: argv must be a tuple or list", func_name);
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005603 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005604 }
5605 argc = PySequence_Size(argv);
5606 if (argc < 1) {
Victor Stinner325e4ba2019-02-01 15:47:24 +01005607 PyErr_Format(PyExc_ValueError,
5608 "%s: argv must not be empty", func_name);
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005609 return NULL;
5610 }
5611
5612 if (!PyMapping_Check(env)) {
Victor Stinner325e4ba2019-02-01 15:47:24 +01005613 PyErr_Format(PyExc_TypeError,
5614 "%s: environment must be a mapping object", func_name);
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005615 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005616 }
5617
5618 argvlist = parse_arglist(argv, &argc);
5619 if (argvlist == NULL) {
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005620 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005621 }
5622 if (!argvlist[0][0]) {
Victor Stinner325e4ba2019-02-01 15:47:24 +01005623 PyErr_Format(PyExc_ValueError,
5624 "%s: argv first element cannot be empty", func_name);
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005625 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005626 }
5627
5628 envlist = parse_envlist(env, &envc);
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005629 if (envlist == NULL) {
5630 goto exit;
5631 }
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005632
Anthony Shaw948ed8c2019-05-10 12:00:06 +10005633 if (file_actions != NULL && file_actions != Py_None) {
Pablo Galindocb970732018-06-19 09:19:50 +01005634 /* There is a bug in old versions of glibc that makes some of the
5635 * helper functions for manipulating file actions not copy the provided
5636 * buffers. The problem is that posix_spawn_file_actions_addopen does not
5637 * copy the value of path for some old versions of glibc (<2.20).
5638 * The use of temp_buffer here is a workaround that keeps the
5639 * python objects that own the buffers alive until posix_spawn gets called.
5640 * Check https://bugs.python.org/issue33630 and
5641 * https://sourceware.org/bugzilla/show_bug.cgi?id=17048 for more info.*/
5642 temp_buffer = PyList_New(0);
5643 if (!temp_buffer) {
5644 goto exit;
5645 }
5646 if (parse_file_actions(file_actions, &file_actions_buf, temp_buffer)) {
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005647 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005648 }
Serhiy Storchakaef347532018-05-01 16:45:04 +03005649 file_actionsp = &file_actions_buf;
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005650 }
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005651
Victor Stinner325e4ba2019-02-01 15:47:24 +01005652 if (parse_posix_spawn_flags(func_name, setpgroup, resetids, setsid,
5653 setsigmask, setsigdef, scheduler, &attr)) {
Pablo Galindo254a4662018-09-07 16:44:24 +01005654 goto exit;
5655 }
5656 attrp = &attr;
5657
Steve Dowera00b5be2020-02-13 08:30:27 +00005658 if (PySys_Audit("os.posix_spawn", "OOO", path->object, argv, env) < 0) {
Miss Islington (bot)3498ac52020-02-04 16:32:32 -08005659 goto exit;
5660 }
5661
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005662 _Py_BEGIN_SUPPRESS_IPH
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005663#ifdef HAVE_POSIX_SPAWNP
5664 if (use_posix_spawnp) {
5665 err_code = posix_spawnp(&pid, path->narrow,
5666 file_actionsp, attrp, argvlist, envlist);
5667 }
5668 else
5669#endif /* HAVE_POSIX_SPAWNP */
5670 {
5671 err_code = posix_spawn(&pid, path->narrow,
5672 file_actionsp, attrp, argvlist, envlist);
5673 }
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005674 _Py_END_SUPPRESS_IPH
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005675
Serhiy Storchakaef347532018-05-01 16:45:04 +03005676 if (err_code) {
5677 errno = err_code;
5678 PyErr_SetFromErrnoWithFilenameObject(PyExc_OSError, path->object);
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005679 goto exit;
5680 }
Gregory P. Smith1d300ce2018-12-30 21:13:02 -08005681#ifdef _Py_MEMORY_SANITIZER
5682 __msan_unpoison(&pid, sizeof(pid));
5683#endif
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005684 result = PyLong_FromPid(pid);
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005685
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005686exit:
Serhiy Storchakaef347532018-05-01 16:45:04 +03005687 if (file_actionsp) {
5688 (void)posix_spawn_file_actions_destroy(file_actionsp);
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005689 }
Pablo Galindo254a4662018-09-07 16:44:24 +01005690 if (attrp) {
5691 (void)posix_spawnattr_destroy(attrp);
5692 }
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005693 if (envlist) {
5694 free_string_array(envlist, envc);
5695 }
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005696 if (argvlist) {
5697 free_string_array(argvlist, argc);
5698 }
Pablo Galindocb970732018-06-19 09:19:50 +01005699 Py_XDECREF(temp_buffer);
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005700 return result;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005701}
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005702
5703
5704/*[clinic input]
5705
5706os.posix_spawn
5707 path: path_t
5708 Path of executable file.
5709 argv: object
5710 Tuple or list of strings.
5711 env: object
5712 Dictionary of strings mapping to strings.
5713 /
5714 *
5715 file_actions: object(c_default='NULL') = ()
5716 A sequence of file action tuples.
5717 setpgroup: object = NULL
5718 The pgroup to use with the POSIX_SPAWN_SETPGROUP flag.
5719 resetids: bool(accept={int}) = False
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005720 If the value is `true` the POSIX_SPAWN_RESETIDS will be activated.
5721 setsid: bool(accept={int}) = False
5722 If the value is `true` the POSIX_SPAWN_SETSID or POSIX_SPAWN_SETSID_NP will be activated.
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005723 setsigmask: object(c_default='NULL') = ()
5724 The sigmask to use with the POSIX_SPAWN_SETSIGMASK flag.
5725 setsigdef: object(c_default='NULL') = ()
5726 The sigmask to use with the POSIX_SPAWN_SETSIGDEF flag.
5727 scheduler: object = NULL
5728 A tuple with the scheduler policy (optional) and parameters.
5729
5730Execute the program specified by path in a new process.
5731[clinic start generated code]*/
5732
5733static PyObject *
5734os_posix_spawn_impl(PyObject *module, path_t *path, PyObject *argv,
5735 PyObject *env, PyObject *file_actions,
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005736 PyObject *setpgroup, int resetids, int setsid,
5737 PyObject *setsigmask, PyObject *setsigdef,
5738 PyObject *scheduler)
5739/*[clinic end generated code: output=14a1098c566bc675 input=8c6305619a00ad04]*/
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005740{
5741 return py_posix_spawn(0, module, path, argv, env, file_actions,
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005742 setpgroup, resetids, setsid, setsigmask, setsigdef,
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005743 scheduler);
5744}
5745 #endif /* HAVE_POSIX_SPAWN */
5746
5747
5748
5749#ifdef HAVE_POSIX_SPAWNP
5750/*[clinic input]
5751
5752os.posix_spawnp
5753 path: path_t
5754 Path of executable file.
5755 argv: object
5756 Tuple or list of strings.
5757 env: object
5758 Dictionary of strings mapping to strings.
5759 /
5760 *
5761 file_actions: object(c_default='NULL') = ()
5762 A sequence of file action tuples.
5763 setpgroup: object = NULL
5764 The pgroup to use with the POSIX_SPAWN_SETPGROUP flag.
5765 resetids: bool(accept={int}) = False
5766 If the value is `True` the POSIX_SPAWN_RESETIDS will be activated.
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005767 setsid: bool(accept={int}) = False
5768 If the value is `True` the POSIX_SPAWN_SETSID or POSIX_SPAWN_SETSID_NP will be activated.
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005769 setsigmask: object(c_default='NULL') = ()
5770 The sigmask to use with the POSIX_SPAWN_SETSIGMASK flag.
5771 setsigdef: object(c_default='NULL') = ()
5772 The sigmask to use with the POSIX_SPAWN_SETSIGDEF flag.
5773 scheduler: object = NULL
5774 A tuple with the scheduler policy (optional) and parameters.
5775
5776Execute the program specified by path in a new process.
5777[clinic start generated code]*/
5778
5779static PyObject *
5780os_posix_spawnp_impl(PyObject *module, path_t *path, PyObject *argv,
5781 PyObject *env, PyObject *file_actions,
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005782 PyObject *setpgroup, int resetids, int setsid,
5783 PyObject *setsigmask, PyObject *setsigdef,
5784 PyObject *scheduler)
5785/*[clinic end generated code: output=7b9aaefe3031238d input=c1911043a22028da]*/
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005786{
5787 return py_posix_spawn(1, module, path, argv, env, file_actions,
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005788 setpgroup, resetids, setsid, setsigmask, setsigdef,
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005789 scheduler);
5790}
5791#endif /* HAVE_POSIX_SPAWNP */
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005792
pxinwrf2d7ac72019-05-21 18:46:37 +08005793#ifdef HAVE_RTPSPAWN
5794static intptr_t
5795_rtp_spawn(int mode, const char *rtpFileName, const char *argv[],
5796 const char *envp[])
5797{
5798 RTP_ID rtpid;
5799 int status;
5800 pid_t res;
5801 int async_err = 0;
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00005802
pxinwrf2d7ac72019-05-21 18:46:37 +08005803 /* Set priority=100 and uStackSize=16 MiB (0x1000000) for new processes.
5804 uStackSize=0 cannot be used, the default stack size is too small for
5805 Python. */
5806 if (envp) {
5807 rtpid = rtpSpawn(rtpFileName, argv, envp,
5808 100, 0x1000000, 0, VX_FP_TASK);
5809 }
5810 else {
5811 rtpid = rtpSpawn(rtpFileName, argv, (const char **)environ,
5812 100, 0x1000000, 0, VX_FP_TASK);
5813 }
5814 if ((rtpid != RTP_ID_ERROR) && (mode == _P_WAIT)) {
5815 do {
5816 res = waitpid((pid_t)rtpid, &status, 0);
5817 } while (res < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
5818
5819 if (res < 0)
5820 return RTP_ID_ERROR;
5821 return ((intptr_t)status);
5822 }
5823 return ((intptr_t)rtpid);
5824}
5825#endif
5826
5827#if defined(HAVE_SPAWNV) || defined(HAVE_WSPAWNV) || defined(HAVE_RTPSPAWN)
Larry Hastings2f936352014-08-05 14:04:04 +10005828/*[clinic input]
5829os.spawnv
5830
5831 mode: int
5832 Mode of process creation.
Steve Dowercc16be82016-09-08 10:35:16 -07005833 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +10005834 Path of executable file.
5835 argv: object
5836 Tuple or list of strings.
5837 /
5838
5839Execute the program specified by path in a new process.
5840[clinic start generated code]*/
5841
Larry Hastings2f936352014-08-05 14:04:04 +10005842static PyObject *
Steve Dowercc16be82016-09-08 10:35:16 -07005843os_spawnv_impl(PyObject *module, int mode, path_t *path, PyObject *argv)
5844/*[clinic end generated code: output=71cd037a9d96b816 input=43224242303291be]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005845{
Steve Dowercc16be82016-09-08 10:35:16 -07005846 EXECV_CHAR **argvlist;
Larry Hastings2f936352014-08-05 14:04:04 +10005847 int i;
Victor Stinner8c62be82010-05-06 00:08:46 +00005848 Py_ssize_t argc;
Benjamin Petersonca470632016-09-06 13:47:26 -07005849 intptr_t spawnval;
Victor Stinner8c62be82010-05-06 00:08:46 +00005850 PyObject *(*getitem)(PyObject *, Py_ssize_t);
Guido van Rossuma1065681999-01-25 23:20:23 +00005851
Victor Stinner8c62be82010-05-06 00:08:46 +00005852 /* spawnv has three arguments: (mode, path, argv), where
5853 argv is a list or tuple of strings. */
Guido van Rossuma1065681999-01-25 23:20:23 +00005854
Victor Stinner8c62be82010-05-06 00:08:46 +00005855 if (PyList_Check(argv)) {
5856 argc = PyList_Size(argv);
5857 getitem = PyList_GetItem;
5858 }
5859 else if (PyTuple_Check(argv)) {
5860 argc = PyTuple_Size(argv);
5861 getitem = PyTuple_GetItem;
5862 }
5863 else {
5864 PyErr_SetString(PyExc_TypeError,
5865 "spawnv() arg 2 must be a tuple or list");
Victor Stinner8c62be82010-05-06 00:08:46 +00005866 return NULL;
5867 }
Steve Dower859fd7b2016-11-19 18:53:19 -08005868 if (argc == 0) {
5869 PyErr_SetString(PyExc_ValueError,
5870 "spawnv() arg 2 cannot be empty");
5871 return NULL;
5872 }
Guido van Rossuma1065681999-01-25 23:20:23 +00005873
Steve Dowercc16be82016-09-08 10:35:16 -07005874 argvlist = PyMem_NEW(EXECV_CHAR *, argc+1);
Victor Stinner8c62be82010-05-06 00:08:46 +00005875 if (argvlist == NULL) {
Victor Stinner8c62be82010-05-06 00:08:46 +00005876 return PyErr_NoMemory();
5877 }
5878 for (i = 0; i < argc; i++) {
5879 if (!fsconvert_strdup((*getitem)(argv, i),
5880 &argvlist[i])) {
5881 free_string_array(argvlist, i);
5882 PyErr_SetString(
5883 PyExc_TypeError,
5884 "spawnv() arg 2 must contain only strings");
Victor Stinner8c62be82010-05-06 00:08:46 +00005885 return NULL;
5886 }
Steve Dower93ff8722016-11-19 19:03:54 -08005887 if (i == 0 && !argvlist[0][0]) {
Victor Stinner8acb4cf2017-06-15 15:30:40 +02005888 free_string_array(argvlist, i + 1);
Steve Dower93ff8722016-11-19 19:03:54 -08005889 PyErr_SetString(
5890 PyExc_ValueError,
5891 "spawnv() arg 2 first element cannot be empty");
5892 return NULL;
5893 }
Victor Stinner8c62be82010-05-06 00:08:46 +00005894 }
5895 argvlist[argc] = NULL;
Guido van Rossuma1065681999-01-25 23:20:23 +00005896
pxinwrf2d7ac72019-05-21 18:46:37 +08005897#if !defined(HAVE_RTPSPAWN)
Victor Stinner8c62be82010-05-06 00:08:46 +00005898 if (mode == _OLD_P_OVERLAY)
5899 mode = _P_OVERLAY;
pxinwrf2d7ac72019-05-21 18:46:37 +08005900#endif
Tim Peters5aa91602002-01-30 05:46:57 +00005901
Steve Dowera00b5be2020-02-13 08:30:27 +00005902 if (PySys_Audit("os.spawn", "iOOO", mode, path->object, argv,
Miss Islington (bot)3498ac52020-02-04 16:32:32 -08005903 Py_None) < 0) {
5904 free_string_array(argvlist, argc);
5905 return NULL;
5906 }
5907
Victor Stinner8c62be82010-05-06 00:08:46 +00005908 Py_BEGIN_ALLOW_THREADS
Steve Dower654a7bd2016-09-11 20:19:32 -07005909 _Py_BEGIN_SUPPRESS_IPH
Steve Dowercc16be82016-09-08 10:35:16 -07005910#ifdef HAVE_WSPAWNV
5911 spawnval = _wspawnv(mode, path->wide, argvlist);
pxinwrf2d7ac72019-05-21 18:46:37 +08005912#elif defined(HAVE_RTPSPAWN)
5913 spawnval = _rtp_spawn(mode, path->narrow, (const char **)argvlist, NULL);
Steve Dowercc16be82016-09-08 10:35:16 -07005914#else
5915 spawnval = _spawnv(mode, path->narrow, argvlist);
5916#endif
Steve Dower654a7bd2016-09-11 20:19:32 -07005917 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00005918 Py_END_ALLOW_THREADS
Tim Peters5aa91602002-01-30 05:46:57 +00005919
Victor Stinner8c62be82010-05-06 00:08:46 +00005920 free_string_array(argvlist, argc);
Guido van Rossuma1065681999-01-25 23:20:23 +00005921
Victor Stinner8c62be82010-05-06 00:08:46 +00005922 if (spawnval == -1)
5923 return posix_error();
5924 else
Richard Oudkerkac0ad882013-06-05 23:29:30 +01005925 return Py_BuildValue(_Py_PARSE_INTPTR, spawnval);
Guido van Rossuma1065681999-01-25 23:20:23 +00005926}
5927
Larry Hastings2f936352014-08-05 14:04:04 +10005928/*[clinic input]
5929os.spawnve
5930
5931 mode: int
5932 Mode of process creation.
Steve Dowercc16be82016-09-08 10:35:16 -07005933 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +10005934 Path of executable file.
5935 argv: object
5936 Tuple or list of strings.
5937 env: object
5938 Dictionary of strings mapping to strings.
5939 /
5940
5941Execute the program specified by path in a new process.
5942[clinic start generated code]*/
5943
Larry Hastings2f936352014-08-05 14:04:04 +10005944static PyObject *
Steve Dowercc16be82016-09-08 10:35:16 -07005945os_spawnve_impl(PyObject *module, int mode, path_t *path, PyObject *argv,
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005946 PyObject *env)
Steve Dowercc16be82016-09-08 10:35:16 -07005947/*[clinic end generated code: output=30fe85be56fe37ad input=3e40803ee7c4c586]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005948{
Steve Dowercc16be82016-09-08 10:35:16 -07005949 EXECV_CHAR **argvlist;
5950 EXECV_CHAR **envlist;
Victor Stinner8c62be82010-05-06 00:08:46 +00005951 PyObject *res = NULL;
Antoine Pitrou22e41552010-08-15 18:07:50 +00005952 Py_ssize_t argc, i, envc;
Benjamin Petersonca470632016-09-06 13:47:26 -07005953 intptr_t spawnval;
Victor Stinner8c62be82010-05-06 00:08:46 +00005954 PyObject *(*getitem)(PyObject *, Py_ssize_t);
Victor Stinnerc8d6ab22017-06-23 15:04:46 +02005955 Py_ssize_t lastarg = 0;
Guido van Rossuma1065681999-01-25 23:20:23 +00005956
Victor Stinner8c62be82010-05-06 00:08:46 +00005957 /* spawnve has four arguments: (mode, path, argv, env), where
5958 argv is a list or tuple of strings and env is a dictionary
5959 like posix.environ. */
Guido van Rossuma1065681999-01-25 23:20:23 +00005960
Victor Stinner8c62be82010-05-06 00:08:46 +00005961 if (PyList_Check(argv)) {
5962 argc = PyList_Size(argv);
5963 getitem = PyList_GetItem;
5964 }
5965 else if (PyTuple_Check(argv)) {
5966 argc = PyTuple_Size(argv);
5967 getitem = PyTuple_GetItem;
5968 }
5969 else {
5970 PyErr_SetString(PyExc_TypeError,
5971 "spawnve() arg 2 must be a tuple or list");
5972 goto fail_0;
5973 }
Steve Dower859fd7b2016-11-19 18:53:19 -08005974 if (argc == 0) {
5975 PyErr_SetString(PyExc_ValueError,
5976 "spawnve() arg 2 cannot be empty");
5977 goto fail_0;
5978 }
Victor Stinner8c62be82010-05-06 00:08:46 +00005979 if (!PyMapping_Check(env)) {
5980 PyErr_SetString(PyExc_TypeError,
5981 "spawnve() arg 3 must be a mapping object");
5982 goto fail_0;
5983 }
Guido van Rossuma1065681999-01-25 23:20:23 +00005984
Steve Dowercc16be82016-09-08 10:35:16 -07005985 argvlist = PyMem_NEW(EXECV_CHAR *, argc+1);
Victor Stinner8c62be82010-05-06 00:08:46 +00005986 if (argvlist == NULL) {
5987 PyErr_NoMemory();
5988 goto fail_0;
5989 }
5990 for (i = 0; i < argc; i++) {
5991 if (!fsconvert_strdup((*getitem)(argv, i),
5992 &argvlist[i]))
5993 {
5994 lastarg = i;
5995 goto fail_1;
5996 }
Steve Dowerbce26262016-11-19 19:17:26 -08005997 if (i == 0 && !argvlist[0][0]) {
Victor Stinnerc8d6ab22017-06-23 15:04:46 +02005998 lastarg = i + 1;
Steve Dowerbce26262016-11-19 19:17:26 -08005999 PyErr_SetString(
6000 PyExc_ValueError,
6001 "spawnv() arg 2 first element cannot be empty");
6002 goto fail_1;
6003 }
Victor Stinner8c62be82010-05-06 00:08:46 +00006004 }
6005 lastarg = argc;
6006 argvlist[argc] = NULL;
Guido van Rossuma1065681999-01-25 23:20:23 +00006007
Victor Stinner8c62be82010-05-06 00:08:46 +00006008 envlist = parse_envlist(env, &envc);
6009 if (envlist == NULL)
6010 goto fail_1;
Guido van Rossuma1065681999-01-25 23:20:23 +00006011
pxinwrf2d7ac72019-05-21 18:46:37 +08006012#if !defined(HAVE_RTPSPAWN)
Victor Stinner8c62be82010-05-06 00:08:46 +00006013 if (mode == _OLD_P_OVERLAY)
6014 mode = _P_OVERLAY;
pxinwrf2d7ac72019-05-21 18:46:37 +08006015#endif
Tim Peters25059d32001-12-07 20:35:43 +00006016
Steve Dowera00b5be2020-02-13 08:30:27 +00006017 if (PySys_Audit("os.spawn", "iOOO", mode, path->object, argv, env) < 0) {
Miss Islington (bot)3498ac52020-02-04 16:32:32 -08006018 goto fail_2;
6019 }
6020
Victor Stinner8c62be82010-05-06 00:08:46 +00006021 Py_BEGIN_ALLOW_THREADS
Steve Dower654a7bd2016-09-11 20:19:32 -07006022 _Py_BEGIN_SUPPRESS_IPH
Steve Dowercc16be82016-09-08 10:35:16 -07006023#ifdef HAVE_WSPAWNV
6024 spawnval = _wspawnve(mode, path->wide, argvlist, envlist);
pxinwrf2d7ac72019-05-21 18:46:37 +08006025#elif defined(HAVE_RTPSPAWN)
6026 spawnval = _rtp_spawn(mode, path->narrow, (const char **)argvlist,
6027 (const char **)envlist);
Steve Dowercc16be82016-09-08 10:35:16 -07006028#else
6029 spawnval = _spawnve(mode, path->narrow, argvlist, envlist);
6030#endif
Steve Dower654a7bd2016-09-11 20:19:32 -07006031 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00006032 Py_END_ALLOW_THREADS
Tim Peters25059d32001-12-07 20:35:43 +00006033
Victor Stinner8c62be82010-05-06 00:08:46 +00006034 if (spawnval == -1)
6035 (void) posix_error();
6036 else
Richard Oudkerkac0ad882013-06-05 23:29:30 +01006037 res = Py_BuildValue(_Py_PARSE_INTPTR, spawnval);
Guido van Rossuma1065681999-01-25 23:20:23 +00006038
Miss Islington (bot)3498ac52020-02-04 16:32:32 -08006039 fail_2:
Victor Stinner8c62be82010-05-06 00:08:46 +00006040 while (--envc >= 0)
6041 PyMem_DEL(envlist[envc]);
6042 PyMem_DEL(envlist);
Guido van Rossum0847c5c2002-12-13 18:36:22 +00006043 fail_1:
Victor Stinnerc8d6ab22017-06-23 15:04:46 +02006044 free_string_array(argvlist, lastarg);
Martin v. Löwis114619e2002-10-07 06:44:21 +00006045 fail_0:
Victor Stinner8c62be82010-05-06 00:08:46 +00006046 return res;
Guido van Rossuma1065681999-01-25 23:20:23 +00006047}
Andrew MacIntyre69e18c92004-04-04 07:11:43 +00006048
Guido van Rossuma1065681999-01-25 23:20:23 +00006049#endif /* HAVE_SPAWNV */
6050
6051
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006052#ifdef HAVE_FORK
Gregory P. Smith163468a2017-05-29 10:03:41 -07006053
6054/* Helper function to validate arguments.
6055 Returns 0 on success. non-zero on failure with a TypeError raised.
6056 If obj is non-NULL it must be callable. */
6057static int
6058check_null_or_callable(PyObject *obj, const char* obj_name)
6059{
6060 if (obj && !PyCallable_Check(obj)) {
6061 PyErr_Format(PyExc_TypeError, "'%s' must be callable, not %s",
6062 obj_name, Py_TYPE(obj)->tp_name);
6063 return -1;
6064 }
6065 return 0;
6066}
6067
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006068/*[clinic input]
6069os.register_at_fork
6070
Gregory P. Smith163468a2017-05-29 10:03:41 -07006071 *
6072 before: object=NULL
6073 A callable to be called in the parent before the fork() syscall.
6074 after_in_child: object=NULL
6075 A callable to be called in the child after fork().
6076 after_in_parent: object=NULL
6077 A callable to be called in the parent after fork().
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006078
Gregory P. Smith163468a2017-05-29 10:03:41 -07006079Register callables to be called when forking a new process.
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006080
Gregory P. Smith163468a2017-05-29 10:03:41 -07006081'before' callbacks are called in reverse order.
6082'after_in_child' and 'after_in_parent' callbacks are called in order.
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006083
6084[clinic start generated code]*/
6085
6086static PyObject *
Gregory P. Smith163468a2017-05-29 10:03:41 -07006087os_register_at_fork_impl(PyObject *module, PyObject *before,
6088 PyObject *after_in_child, PyObject *after_in_parent)
6089/*[clinic end generated code: output=5398ac75e8e97625 input=cd1187aa85d2312e]*/
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006090{
6091 PyInterpreterState *interp;
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006092
Gregory P. Smith163468a2017-05-29 10:03:41 -07006093 if (!before && !after_in_child && !after_in_parent) {
6094 PyErr_SetString(PyExc_TypeError, "At least one argument is required.");
6095 return NULL;
6096 }
6097 if (check_null_or_callable(before, "before") ||
6098 check_null_or_callable(after_in_child, "after_in_child") ||
6099 check_null_or_callable(after_in_parent, "after_in_parent")) {
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006100 return NULL;
6101 }
Victor Stinnercaba55b2018-08-03 15:33:52 +02006102 interp = _PyInterpreterState_Get();
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006103
Gregory P. Smith163468a2017-05-29 10:03:41 -07006104 if (register_at_forker(&interp->before_forkers, before)) {
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006105 return NULL;
6106 }
Gregory P. Smith163468a2017-05-29 10:03:41 -07006107 if (register_at_forker(&interp->after_forkers_child, after_in_child)) {
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006108 return NULL;
Gregory P. Smith163468a2017-05-29 10:03:41 -07006109 }
6110 if (register_at_forker(&interp->after_forkers_parent, after_in_parent)) {
6111 return NULL;
6112 }
6113 Py_RETURN_NONE;
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006114}
6115#endif /* HAVE_FORK */
6116
6117
Guido van Rossum2242f2f2001-04-11 20:58:20 +00006118#ifdef HAVE_FORK1
Larry Hastings2f936352014-08-05 14:04:04 +10006119/*[clinic input]
6120os.fork1
6121
6122Fork a child process with a single multiplexed (i.e., not bound) thread.
6123
6124Return 0 to child process and PID of child to parent process.
6125[clinic start generated code]*/
6126
Larry Hastings2f936352014-08-05 14:04:04 +10006127static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006128os_fork1_impl(PyObject *module)
6129/*[clinic end generated code: output=0de8e67ce2a310bc input=12db02167893926e]*/
Guido van Rossum2242f2f2001-04-11 20:58:20 +00006130{
Victor Stinner8c62be82010-05-06 00:08:46 +00006131 pid_t pid;
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006132
Eric Snow59032962018-09-14 14:17:20 -07006133 if (_PyInterpreterState_Get() != PyInterpreterState_Main()) {
6134 PyErr_SetString(PyExc_RuntimeError, "fork not supported for subinterpreters");
6135 return NULL;
6136 }
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006137 PyOS_BeforeFork();
Victor Stinner8c62be82010-05-06 00:08:46 +00006138 pid = fork1();
6139 if (pid == 0) {
6140 /* child: this clobbers and resets the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006141 PyOS_AfterFork_Child();
Victor Stinner8c62be82010-05-06 00:08:46 +00006142 } else {
6143 /* parent: release the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006144 PyOS_AfterFork_Parent();
Victor Stinner8c62be82010-05-06 00:08:46 +00006145 }
6146 if (pid == -1)
6147 return posix_error();
Victor Stinner8c62be82010-05-06 00:08:46 +00006148 return PyLong_FromPid(pid);
Guido van Rossum2242f2f2001-04-11 20:58:20 +00006149}
Larry Hastings2f936352014-08-05 14:04:04 +10006150#endif /* HAVE_FORK1 */
Guido van Rossum2242f2f2001-04-11 20:58:20 +00006151
6152
Guido van Rossumad0ee831995-03-01 10:34:45 +00006153#ifdef HAVE_FORK
Larry Hastings2f936352014-08-05 14:04:04 +10006154/*[clinic input]
6155os.fork
6156
6157Fork a child process.
6158
6159Return 0 to child process and PID of child to parent process.
6160[clinic start generated code]*/
6161
Larry Hastings2f936352014-08-05 14:04:04 +10006162static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006163os_fork_impl(PyObject *module)
6164/*[clinic end generated code: output=3626c81f98985d49 input=13c956413110eeaa]*/
Guido van Rossum85e3b011991-06-03 12:42:10 +00006165{
Victor Stinner8c62be82010-05-06 00:08:46 +00006166 pid_t pid;
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006167
Eric Snow59032962018-09-14 14:17:20 -07006168 if (_PyInterpreterState_Get() != PyInterpreterState_Main()) {
6169 PyErr_SetString(PyExc_RuntimeError, "fork not supported for subinterpreters");
6170 return NULL;
6171 }
Steve Dowera00b5be2020-02-13 08:30:27 +00006172 if (PySys_Audit("os.fork", NULL) < 0) {
6173 return NULL;
6174 }
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006175 PyOS_BeforeFork();
Victor Stinner8c62be82010-05-06 00:08:46 +00006176 pid = fork();
6177 if (pid == 0) {
6178 /* child: this clobbers and resets the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006179 PyOS_AfterFork_Child();
Victor Stinner8c62be82010-05-06 00:08:46 +00006180 } else {
6181 /* parent: release the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006182 PyOS_AfterFork_Parent();
Victor Stinner8c62be82010-05-06 00:08:46 +00006183 }
6184 if (pid == -1)
6185 return posix_error();
Victor Stinner8c62be82010-05-06 00:08:46 +00006186 return PyLong_FromPid(pid);
Guido van Rossum85e3b011991-06-03 12:42:10 +00006187}
Larry Hastings2f936352014-08-05 14:04:04 +10006188#endif /* HAVE_FORK */
6189
Guido van Rossum85e3b011991-06-03 12:42:10 +00006190
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006191#ifdef HAVE_SCHED_H
Charles-François Nataliea0d5fc2011-09-06 19:03:35 +02006192#ifdef HAVE_SCHED_GET_PRIORITY_MAX
Larry Hastings2f936352014-08-05 14:04:04 +10006193/*[clinic input]
6194os.sched_get_priority_max
Charles-François Nataliea0d5fc2011-09-06 19:03:35 +02006195
Larry Hastings2f936352014-08-05 14:04:04 +10006196 policy: int
6197
6198Get the maximum scheduling priority for policy.
6199[clinic start generated code]*/
6200
Larry Hastings2f936352014-08-05 14:04:04 +10006201static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006202os_sched_get_priority_max_impl(PyObject *module, int policy)
6203/*[clinic end generated code: output=9e465c6e43130521 input=2097b7998eca6874]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006204{
6205 int max;
6206
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006207 max = sched_get_priority_max(policy);
6208 if (max < 0)
6209 return posix_error();
6210 return PyLong_FromLong(max);
6211}
6212
Larry Hastings2f936352014-08-05 14:04:04 +10006213
6214/*[clinic input]
6215os.sched_get_priority_min
6216
6217 policy: int
6218
6219Get the minimum scheduling priority for policy.
6220[clinic start generated code]*/
6221
Larry Hastings2f936352014-08-05 14:04:04 +10006222static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006223os_sched_get_priority_min_impl(PyObject *module, int policy)
6224/*[clinic end generated code: output=7595c1138cc47a6d input=21bc8fa0d70983bf]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006225{
6226 int min = sched_get_priority_min(policy);
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006227 if (min < 0)
6228 return posix_error();
6229 return PyLong_FromLong(min);
6230}
Charles-François Nataliea0d5fc2011-09-06 19:03:35 +02006231#endif /* HAVE_SCHED_GET_PRIORITY_MAX */
6232
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006233
Larry Hastings2f936352014-08-05 14:04:04 +10006234#ifdef HAVE_SCHED_SETSCHEDULER
6235/*[clinic input]
6236os.sched_getscheduler
6237 pid: pid_t
6238 /
6239
6240Get the scheduling policy for the process identifiedy by pid.
6241
6242Passing 0 for pid returns the scheduling policy for the calling process.
6243[clinic start generated code]*/
6244
Larry Hastings2f936352014-08-05 14:04:04 +10006245static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006246os_sched_getscheduler_impl(PyObject *module, pid_t pid)
6247/*[clinic end generated code: output=dce4c0bd3f1b34c8 input=5f14cfd1f189e1a0]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006248{
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006249 int policy;
6250
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006251 policy = sched_getscheduler(pid);
6252 if (policy < 0)
6253 return posix_error();
6254 return PyLong_FromLong(policy);
6255}
Larry Hastings2f936352014-08-05 14:04:04 +10006256#endif /* HAVE_SCHED_SETSCHEDULER */
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006257
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006258
William Orr81574b82018-10-01 22:19:56 -07006259#if defined(HAVE_SCHED_SETPARAM) || defined(HAVE_SCHED_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDPARAM)
Larry Hastings2f936352014-08-05 14:04:04 +10006260/*[clinic input]
Eddie Elizondo474eedf2018-11-13 04:09:31 -08006261class os.sched_param "PyObject *" "SchedParamType"
Larry Hastings2f936352014-08-05 14:04:04 +10006262
6263@classmethod
6264os.sched_param.__new__
6265
6266 sched_priority: object
6267 A scheduling parameter.
6268
6269Current has only one field: sched_priority");
6270[clinic start generated code]*/
6271
Larry Hastings2f936352014-08-05 14:04:04 +10006272static PyObject *
6273os_sched_param_impl(PyTypeObject *type, PyObject *sched_priority)
Eddie Elizondo474eedf2018-11-13 04:09:31 -08006274/*[clinic end generated code: output=48f4067d60f48c13 input=ab4de35a9a7811f2]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006275{
6276 PyObject *res;
6277
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006278 res = PyStructSequence_New(type);
6279 if (!res)
6280 return NULL;
Larry Hastings2f936352014-08-05 14:04:04 +10006281 Py_INCREF(sched_priority);
6282 PyStructSequence_SET_ITEM(res, 0, sched_priority);
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006283 return res;
6284}
6285
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006286
Serhiy Storchaka1009bf12015-04-03 23:53:51 +03006287PyDoc_VAR(os_sched_param__doc__);
6288
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006289static PyStructSequence_Field sched_param_fields[] = {
6290 {"sched_priority", "the scheduling priority"},
6291 {0}
6292};
6293
6294static PyStructSequence_Desc sched_param_desc = {
6295 "sched_param", /* name */
Larry Hastings2f936352014-08-05 14:04:04 +10006296 os_sched_param__doc__, /* doc */
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006297 sched_param_fields,
6298 1
6299};
6300
6301static int
6302convert_sched_param(PyObject *param, struct sched_param *res)
6303{
6304 long priority;
6305
Eddie Elizondo474eedf2018-11-13 04:09:31 -08006306 if (Py_TYPE(param) != SchedParamType) {
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006307 PyErr_SetString(PyExc_TypeError, "must have a sched_param object");
6308 return 0;
6309 }
6310 priority = PyLong_AsLong(PyStructSequence_GET_ITEM(param, 0));
6311 if (priority == -1 && PyErr_Occurred())
6312 return 0;
6313 if (priority > INT_MAX || priority < INT_MIN) {
6314 PyErr_SetString(PyExc_OverflowError, "sched_priority out of range");
6315 return 0;
6316 }
6317 res->sched_priority = Py_SAFE_DOWNCAST(priority, long, int);
6318 return 1;
6319}
William Orr81574b82018-10-01 22:19:56 -07006320#endif /* defined(HAVE_SCHED_SETPARAM) || defined(HAVE_SCHED_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDPARAM) */
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006321
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006322
6323#ifdef HAVE_SCHED_SETSCHEDULER
Larry Hastings2f936352014-08-05 14:04:04 +10006324/*[clinic input]
6325os.sched_setscheduler
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006326
Larry Hastings2f936352014-08-05 14:04:04 +10006327 pid: pid_t
6328 policy: int
6329 param: sched_param
6330 /
6331
6332Set the scheduling policy for the process identified by pid.
6333
6334If pid is 0, the calling process is changed.
6335param is an instance of sched_param.
6336[clinic start generated code]*/
6337
Larry Hastings2f936352014-08-05 14:04:04 +10006338static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006339os_sched_setscheduler_impl(PyObject *module, pid_t pid, int policy,
Larry Hastings89964c42015-04-14 18:07:59 -04006340 struct sched_param *param)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006341/*[clinic end generated code: output=b0ac0a70d3b1d705 input=c581f9469a5327dd]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006342{
Jesus Cea9c822272011-09-10 01:40:52 +02006343 /*
Jesus Cea54b01492011-09-10 01:53:19 +02006344 ** sched_setscheduler() returns 0 in Linux, but the previous
6345 ** scheduling policy under Solaris/Illumos, and others.
6346 ** On error, -1 is returned in all Operating Systems.
Jesus Cea9c822272011-09-10 01:40:52 +02006347 */
Larry Hastings2f936352014-08-05 14:04:04 +10006348 if (sched_setscheduler(pid, policy, param) == -1)
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006349 return posix_error();
6350 Py_RETURN_NONE;
6351}
Larry Hastings2f936352014-08-05 14:04:04 +10006352#endif /* HAVE_SCHED_SETSCHEDULER*/
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006353
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006354
6355#ifdef HAVE_SCHED_SETPARAM
Larry Hastings2f936352014-08-05 14:04:04 +10006356/*[clinic input]
6357os.sched_getparam
6358 pid: pid_t
6359 /
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006360
Larry Hastings2f936352014-08-05 14:04:04 +10006361Returns scheduling parameters for the process identified by pid.
6362
6363If pid is 0, returns parameters for the calling process.
6364Return value is an instance of sched_param.
6365[clinic start generated code]*/
6366
Larry Hastings2f936352014-08-05 14:04:04 +10006367static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006368os_sched_getparam_impl(PyObject *module, pid_t pid)
6369/*[clinic end generated code: output=b194e8708dcf2db8 input=18a1ef9c2efae296]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006370{
6371 struct sched_param param;
6372 PyObject *result;
6373 PyObject *priority;
6374
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006375 if (sched_getparam(pid, &param))
6376 return posix_error();
Eddie Elizondo474eedf2018-11-13 04:09:31 -08006377 result = PyStructSequence_New(SchedParamType);
Larry Hastings2f936352014-08-05 14:04:04 +10006378 if (!result)
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006379 return NULL;
6380 priority = PyLong_FromLong(param.sched_priority);
6381 if (!priority) {
Larry Hastings2f936352014-08-05 14:04:04 +10006382 Py_DECREF(result);
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006383 return NULL;
6384 }
Larry Hastings2f936352014-08-05 14:04:04 +10006385 PyStructSequence_SET_ITEM(result, 0, priority);
6386 return result;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006387}
6388
Larry Hastings2f936352014-08-05 14:04:04 +10006389
6390/*[clinic input]
6391os.sched_setparam
6392 pid: pid_t
6393 param: sched_param
6394 /
6395
6396Set scheduling parameters for the process identified by pid.
6397
6398If pid is 0, sets parameters for the calling process.
6399param should be an instance of sched_param.
6400[clinic start generated code]*/
6401
Larry Hastings2f936352014-08-05 14:04:04 +10006402static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006403os_sched_setparam_impl(PyObject *module, pid_t pid,
Larry Hastings89964c42015-04-14 18:07:59 -04006404 struct sched_param *param)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006405/*[clinic end generated code: output=8af013f78a32b591 input=6b8d6dfcecdc21bd]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006406{
6407 if (sched_setparam(pid, param))
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006408 return posix_error();
6409 Py_RETURN_NONE;
6410}
Larry Hastings2f936352014-08-05 14:04:04 +10006411#endif /* HAVE_SCHED_SETPARAM */
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006412
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006413
6414#ifdef HAVE_SCHED_RR_GET_INTERVAL
Larry Hastings2f936352014-08-05 14:04:04 +10006415/*[clinic input]
6416os.sched_rr_get_interval -> double
6417 pid: pid_t
6418 /
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006419
Larry Hastings2f936352014-08-05 14:04:04 +10006420Return the round-robin quantum for the process identified by pid, in seconds.
6421
6422Value returned is a float.
6423[clinic start generated code]*/
6424
Larry Hastings2f936352014-08-05 14:04:04 +10006425static double
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006426os_sched_rr_get_interval_impl(PyObject *module, pid_t pid)
6427/*[clinic end generated code: output=7e2d935833ab47dc input=2a973da15cca6fae]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006428{
6429 struct timespec interval;
6430 if (sched_rr_get_interval(pid, &interval)) {
6431 posix_error();
6432 return -1.0;
6433 }
Gregory P. Smith1d300ce2018-12-30 21:13:02 -08006434#ifdef _Py_MEMORY_SANITIZER
6435 __msan_unpoison(&interval, sizeof(interval));
6436#endif
Larry Hastings2f936352014-08-05 14:04:04 +10006437 return (double)interval.tv_sec + 1e-9*interval.tv_nsec;
6438}
6439#endif /* HAVE_SCHED_RR_GET_INTERVAL */
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006440
Larry Hastings2f936352014-08-05 14:04:04 +10006441
6442/*[clinic input]
6443os.sched_yield
6444
6445Voluntarily relinquish the CPU.
6446[clinic start generated code]*/
6447
Larry Hastings2f936352014-08-05 14:04:04 +10006448static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006449os_sched_yield_impl(PyObject *module)
6450/*[clinic end generated code: output=902323500f222cac input=e54d6f98189391d4]*/
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006451{
6452 if (sched_yield())
6453 return posix_error();
6454 Py_RETURN_NONE;
6455}
6456
Benjamin Peterson2740af82011-08-02 17:41:34 -05006457#ifdef HAVE_SCHED_SETAFFINITY
Antoine Pitrou84869872012-08-04 16:16:35 +02006458/* The minimum number of CPUs allocated in a cpu_set_t */
6459static const int NCPUS_START = sizeof(unsigned long) * CHAR_BIT;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006460
Larry Hastings2f936352014-08-05 14:04:04 +10006461/*[clinic input]
6462os.sched_setaffinity
6463 pid: pid_t
6464 mask : object
6465 /
6466
6467Set the CPU affinity of the process identified by pid to mask.
6468
6469mask should be an iterable of integers identifying CPUs.
6470[clinic start generated code]*/
6471
Larry Hastings2f936352014-08-05 14:04:04 +10006472static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006473os_sched_setaffinity_impl(PyObject *module, pid_t pid, PyObject *mask)
6474/*[clinic end generated code: output=882d7dd9a229335b input=a0791a597c7085ba]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006475{
Antoine Pitrou84869872012-08-04 16:16:35 +02006476 int ncpus;
6477 size_t setsize;
Larry Hastings2f936352014-08-05 14:04:04 +10006478 cpu_set_t *cpu_set = NULL;
6479 PyObject *iterator = NULL, *item;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006480
Larry Hastings2f936352014-08-05 14:04:04 +10006481 iterator = PyObject_GetIter(mask);
Antoine Pitrou84869872012-08-04 16:16:35 +02006482 if (iterator == NULL)
6483 return NULL;
6484
6485 ncpus = NCPUS_START;
6486 setsize = CPU_ALLOC_SIZE(ncpus);
Larry Hastings2f936352014-08-05 14:04:04 +10006487 cpu_set = CPU_ALLOC(ncpus);
6488 if (cpu_set == NULL) {
Antoine Pitrou84869872012-08-04 16:16:35 +02006489 PyErr_NoMemory();
6490 goto error;
6491 }
Larry Hastings2f936352014-08-05 14:04:04 +10006492 CPU_ZERO_S(setsize, cpu_set);
Antoine Pitrou84869872012-08-04 16:16:35 +02006493
6494 while ((item = PyIter_Next(iterator))) {
6495 long cpu;
6496 if (!PyLong_Check(item)) {
6497 PyErr_Format(PyExc_TypeError,
6498 "expected an iterator of ints, "
6499 "but iterator yielded %R",
6500 Py_TYPE(item));
6501 Py_DECREF(item);
6502 goto error;
6503 }
6504 cpu = PyLong_AsLong(item);
6505 Py_DECREF(item);
6506 if (cpu < 0) {
6507 if (!PyErr_Occurred())
6508 PyErr_SetString(PyExc_ValueError, "negative CPU number");
6509 goto error;
6510 }
6511 if (cpu > INT_MAX - 1) {
6512 PyErr_SetString(PyExc_OverflowError, "CPU number too large");
6513 goto error;
6514 }
6515 if (cpu >= ncpus) {
6516 /* Grow CPU mask to fit the CPU number */
6517 int newncpus = ncpus;
6518 cpu_set_t *newmask;
6519 size_t newsetsize;
6520 while (newncpus <= cpu) {
6521 if (newncpus > INT_MAX / 2)
6522 newncpus = cpu + 1;
6523 else
6524 newncpus = newncpus * 2;
6525 }
6526 newmask = CPU_ALLOC(newncpus);
6527 if (newmask == NULL) {
6528 PyErr_NoMemory();
6529 goto error;
6530 }
6531 newsetsize = CPU_ALLOC_SIZE(newncpus);
6532 CPU_ZERO_S(newsetsize, newmask);
Larry Hastings2f936352014-08-05 14:04:04 +10006533 memcpy(newmask, cpu_set, setsize);
6534 CPU_FREE(cpu_set);
Antoine Pitrou84869872012-08-04 16:16:35 +02006535 setsize = newsetsize;
Larry Hastings2f936352014-08-05 14:04:04 +10006536 cpu_set = newmask;
Antoine Pitrou84869872012-08-04 16:16:35 +02006537 ncpus = newncpus;
6538 }
Larry Hastings2f936352014-08-05 14:04:04 +10006539 CPU_SET_S(cpu, setsize, cpu_set);
Antoine Pitrou84869872012-08-04 16:16:35 +02006540 }
Miss Islington (bot)6fbed532019-06-27 09:45:30 -07006541 if (PyErr_Occurred()) {
6542 goto error;
6543 }
Antoine Pitrou84869872012-08-04 16:16:35 +02006544 Py_CLEAR(iterator);
6545
Larry Hastings2f936352014-08-05 14:04:04 +10006546 if (sched_setaffinity(pid, setsize, cpu_set)) {
Antoine Pitrou84869872012-08-04 16:16:35 +02006547 posix_error();
6548 goto error;
6549 }
Larry Hastings2f936352014-08-05 14:04:04 +10006550 CPU_FREE(cpu_set);
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006551 Py_RETURN_NONE;
Antoine Pitrou84869872012-08-04 16:16:35 +02006552
6553error:
Larry Hastings2f936352014-08-05 14:04:04 +10006554 if (cpu_set)
6555 CPU_FREE(cpu_set);
Antoine Pitrou84869872012-08-04 16:16:35 +02006556 Py_XDECREF(iterator);
6557 return NULL;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006558}
6559
Larry Hastings2f936352014-08-05 14:04:04 +10006560
6561/*[clinic input]
6562os.sched_getaffinity
6563 pid: pid_t
6564 /
6565
Charles-François Natalidc87e4b2015-07-13 21:01:39 +01006566Return the affinity of the process identified by pid (or the current process if zero).
Larry Hastings2f936352014-08-05 14:04:04 +10006567
6568The affinity is returned as a set of CPU identifiers.
6569[clinic start generated code]*/
6570
Larry Hastings2f936352014-08-05 14:04:04 +10006571static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006572os_sched_getaffinity_impl(PyObject *module, pid_t pid)
Serhiy Storchaka2954f832016-07-07 18:20:03 +03006573/*[clinic end generated code: output=f726f2c193c17a4f input=983ce7cb4a565980]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006574{
Antoine Pitrou84869872012-08-04 16:16:35 +02006575 int cpu, ncpus, count;
6576 size_t setsize;
6577 cpu_set_t *mask = NULL;
6578 PyObject *res = NULL;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006579
Antoine Pitrou84869872012-08-04 16:16:35 +02006580 ncpus = NCPUS_START;
6581 while (1) {
6582 setsize = CPU_ALLOC_SIZE(ncpus);
6583 mask = CPU_ALLOC(ncpus);
6584 if (mask == NULL)
6585 return PyErr_NoMemory();
6586 if (sched_getaffinity(pid, setsize, mask) == 0)
6587 break;
6588 CPU_FREE(mask);
6589 if (errno != EINVAL)
6590 return posix_error();
6591 if (ncpus > INT_MAX / 2) {
6592 PyErr_SetString(PyExc_OverflowError, "could not allocate "
6593 "a large enough CPU set");
6594 return NULL;
6595 }
6596 ncpus = ncpus * 2;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006597 }
Antoine Pitrou84869872012-08-04 16:16:35 +02006598
6599 res = PySet_New(NULL);
6600 if (res == NULL)
6601 goto error;
6602 for (cpu = 0, count = CPU_COUNT_S(setsize, mask); count; cpu++) {
6603 if (CPU_ISSET_S(cpu, setsize, mask)) {
6604 PyObject *cpu_num = PyLong_FromLong(cpu);
6605 --count;
6606 if (cpu_num == NULL)
6607 goto error;
6608 if (PySet_Add(res, cpu_num)) {
6609 Py_DECREF(cpu_num);
6610 goto error;
6611 }
6612 Py_DECREF(cpu_num);
6613 }
6614 }
6615 CPU_FREE(mask);
6616 return res;
6617
6618error:
6619 if (mask)
6620 CPU_FREE(mask);
6621 Py_XDECREF(res);
6622 return NULL;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006623}
6624
Benjamin Peterson2740af82011-08-02 17:41:34 -05006625#endif /* HAVE_SCHED_SETAFFINITY */
6626
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006627#endif /* HAVE_SCHED_H */
6628
Larry Hastings2f936352014-08-05 14:04:04 +10006629
Neal Norwitzb59798b2003-03-21 01:43:31 +00006630/* AIX uses /dev/ptc but is otherwise the same as /dev/ptmx */
Neal Norwitz2deaddb2003-03-21 03:08:31 +00006631/* IRIX has both /dev/ptc and /dev/ptmx, use ptmx */
6632#if defined(HAVE_DEV_PTC) && !defined(HAVE_DEV_PTMX)
Neal Norwitzb59798b2003-03-21 01:43:31 +00006633#define DEV_PTY_FILE "/dev/ptc"
6634#define HAVE_DEV_PTMX
6635#else
6636#define DEV_PTY_FILE "/dev/ptmx"
6637#endif
6638
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006639#if defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) || defined(HAVE_DEV_PTMX)
Fred Drake8cef4cf2000-06-28 16:40:38 +00006640#ifdef HAVE_PTY_H
6641#include <pty.h>
6642#else
6643#ifdef HAVE_LIBUTIL_H
6644#include <libutil.h>
Ronald Oussoren755740f2010-02-07 19:56:39 +00006645#else
6646#ifdef HAVE_UTIL_H
6647#include <util.h>
6648#endif /* HAVE_UTIL_H */
Fred Drake8cef4cf2000-06-28 16:40:38 +00006649#endif /* HAVE_LIBUTIL_H */
6650#endif /* HAVE_PTY_H */
Martin v. Löwis14e73b12003-01-01 09:51:12 +00006651#ifdef HAVE_STROPTS_H
6652#include <stropts.h>
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006653#endif
ngie-eign7745ec42018-02-14 11:54:28 -08006654#endif /* defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) || defined(HAVE_DEV_PTMX) */
Fred Drake8cef4cf2000-06-28 16:40:38 +00006655
Larry Hastings2f936352014-08-05 14:04:04 +10006656
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006657#if defined(HAVE_OPENPTY) || defined(HAVE__GETPTY) || defined(HAVE_DEV_PTMX)
Larry Hastings2f936352014-08-05 14:04:04 +10006658/*[clinic input]
6659os.openpty
6660
6661Open a pseudo-terminal.
6662
6663Return a tuple of (master_fd, slave_fd) containing open file descriptors
6664for both the master and slave ends.
6665[clinic start generated code]*/
6666
Larry Hastings2f936352014-08-05 14:04:04 +10006667static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006668os_openpty_impl(PyObject *module)
6669/*[clinic end generated code: output=98841ce5ec9cef3c input=f3d99fd99e762907]*/
Fred Drake8cef4cf2000-06-28 16:40:38 +00006670{
Victor Stinnerdaf45552013-08-28 00:53:59 +02006671 int master_fd = -1, slave_fd = -1;
Thomas Wouters70c21a12000-07-14 14:28:33 +00006672#ifndef HAVE_OPENPTY
Victor Stinner8c62be82010-05-06 00:08:46 +00006673 char * slave_name;
Thomas Wouters70c21a12000-07-14 14:28:33 +00006674#endif
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006675#if defined(HAVE_DEV_PTMX) && !defined(HAVE_OPENPTY) && !defined(HAVE__GETPTY)
Victor Stinner8c62be82010-05-06 00:08:46 +00006676 PyOS_sighandler_t sig_saved;
Jakub Kulík6f9bc722018-12-31 03:16:40 +01006677#if defined(__sun) && defined(__SVR4)
Victor Stinner8c62be82010-05-06 00:08:46 +00006678 extern char *ptsname(int fildes);
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006679#endif
6680#endif
Thomas Wouters70c21a12000-07-14 14:28:33 +00006681
Thomas Wouters70c21a12000-07-14 14:28:33 +00006682#ifdef HAVE_OPENPTY
Victor Stinner8c62be82010-05-06 00:08:46 +00006683 if (openpty(&master_fd, &slave_fd, NULL, NULL, NULL) != 0)
Victor Stinnerdaf45552013-08-28 00:53:59 +02006684 goto posix_error;
6685
6686 if (_Py_set_inheritable(master_fd, 0, NULL) < 0)
6687 goto error;
6688 if (_Py_set_inheritable(slave_fd, 0, NULL) < 0)
6689 goto error;
6690
Neal Norwitzb59798b2003-03-21 01:43:31 +00006691#elif defined(HAVE__GETPTY)
Victor Stinner8c62be82010-05-06 00:08:46 +00006692 slave_name = _getpty(&master_fd, O_RDWR, 0666, 0);
6693 if (slave_name == NULL)
Victor Stinnerdaf45552013-08-28 00:53:59 +02006694 goto posix_error;
6695 if (_Py_set_inheritable(master_fd, 0, NULL) < 0)
6696 goto error;
Thomas Wouters70c21a12000-07-14 14:28:33 +00006697
Victor Stinnerdaf45552013-08-28 00:53:59 +02006698 slave_fd = _Py_open(slave_name, O_RDWR);
Victor Stinner8c62be82010-05-06 00:08:46 +00006699 if (slave_fd < 0)
Victor Stinnera555cfc2015-03-18 00:22:14 +01006700 goto error;
Victor Stinnerdaf45552013-08-28 00:53:59 +02006701
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006702#else
Victor Stinner000de532013-11-25 23:19:58 +01006703 master_fd = open(DEV_PTY_FILE, O_RDWR | O_NOCTTY); /* open master */
Victor Stinner8c62be82010-05-06 00:08:46 +00006704 if (master_fd < 0)
Victor Stinnerdaf45552013-08-28 00:53:59 +02006705 goto posix_error;
6706
Victor Stinner8c62be82010-05-06 00:08:46 +00006707 sig_saved = PyOS_setsig(SIGCHLD, SIG_DFL);
Victor Stinnerdaf45552013-08-28 00:53:59 +02006708
Victor Stinner8c62be82010-05-06 00:08:46 +00006709 /* change permission of slave */
6710 if (grantpt(master_fd) < 0) {
6711 PyOS_setsig(SIGCHLD, sig_saved);
Victor Stinnerdaf45552013-08-28 00:53:59 +02006712 goto posix_error;
Victor Stinner8c62be82010-05-06 00:08:46 +00006713 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02006714
Victor Stinner8c62be82010-05-06 00:08:46 +00006715 /* unlock slave */
6716 if (unlockpt(master_fd) < 0) {
6717 PyOS_setsig(SIGCHLD, sig_saved);
Victor Stinnerdaf45552013-08-28 00:53:59 +02006718 goto posix_error;
Victor Stinner8c62be82010-05-06 00:08:46 +00006719 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02006720
Victor Stinner8c62be82010-05-06 00:08:46 +00006721 PyOS_setsig(SIGCHLD, sig_saved);
Victor Stinnerdaf45552013-08-28 00:53:59 +02006722
Victor Stinner8c62be82010-05-06 00:08:46 +00006723 slave_name = ptsname(master_fd); /* get name of slave */
6724 if (slave_name == NULL)
Victor Stinnerdaf45552013-08-28 00:53:59 +02006725 goto posix_error;
6726
6727 slave_fd = _Py_open(slave_name, O_RDWR | O_NOCTTY); /* open slave */
Victor Stinnera555cfc2015-03-18 00:22:14 +01006728 if (slave_fd == -1)
6729 goto error;
Victor Stinner000de532013-11-25 23:19:58 +01006730
6731 if (_Py_set_inheritable(master_fd, 0, NULL) < 0)
6732 goto posix_error;
6733
Stefan Krahfb7c8ae2016-04-26 17:04:18 +02006734#if !defined(__CYGWIN__) && !defined(__ANDROID__) && !defined(HAVE_DEV_PTC)
Victor Stinner8c62be82010-05-06 00:08:46 +00006735 ioctl(slave_fd, I_PUSH, "ptem"); /* push ptem */
6736 ioctl(slave_fd, I_PUSH, "ldterm"); /* push ldterm */
Neal Norwitz6700e472002-12-31 16:16:07 +00006737#ifndef __hpux
Victor Stinner8c62be82010-05-06 00:08:46 +00006738 ioctl(slave_fd, I_PUSH, "ttcompat"); /* push ttcompat */
Neal Norwitz6700e472002-12-31 16:16:07 +00006739#endif /* __hpux */
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006740#endif /* HAVE_CYGWIN */
Thomas Wouters1e0c2f42000-07-24 16:06:23 +00006741#endif /* HAVE_OPENPTY */
Thomas Wouters70c21a12000-07-14 14:28:33 +00006742
Victor Stinner8c62be82010-05-06 00:08:46 +00006743 return Py_BuildValue("(ii)", master_fd, slave_fd);
Thomas Wouters70c21a12000-07-14 14:28:33 +00006744
Victor Stinnerdaf45552013-08-28 00:53:59 +02006745posix_error:
6746 posix_error();
6747error:
6748 if (master_fd != -1)
6749 close(master_fd);
6750 if (slave_fd != -1)
6751 close(slave_fd);
6752 return NULL;
Fred Drake8cef4cf2000-06-28 16:40:38 +00006753}
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006754#endif /* defined(HAVE_OPENPTY) || defined(HAVE__GETPTY) || defined(HAVE_DEV_PTMX) */
Fred Drake8cef4cf2000-06-28 16:40:38 +00006755
Larry Hastings2f936352014-08-05 14:04:04 +10006756
Fred Drake8cef4cf2000-06-28 16:40:38 +00006757#ifdef HAVE_FORKPTY
Larry Hastings2f936352014-08-05 14:04:04 +10006758/*[clinic input]
6759os.forkpty
6760
6761Fork a new process with a new pseudo-terminal as controlling tty.
6762
6763Returns a tuple of (pid, master_fd).
6764Like fork(), return pid of 0 to the child process,
6765and pid of child to the parent process.
6766To both, return fd of newly opened pseudo-terminal.
6767[clinic start generated code]*/
6768
Larry Hastings2f936352014-08-05 14:04:04 +10006769static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006770os_forkpty_impl(PyObject *module)
6771/*[clinic end generated code: output=60d0a5c7512e4087 input=f1f7f4bae3966010]*/
Fred Drake8cef4cf2000-06-28 16:40:38 +00006772{
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006773 int master_fd = -1;
Victor Stinner8c62be82010-05-06 00:08:46 +00006774 pid_t pid;
Tim Peters5aa91602002-01-30 05:46:57 +00006775
Eric Snow59032962018-09-14 14:17:20 -07006776 if (_PyInterpreterState_Get() != PyInterpreterState_Main()) {
6777 PyErr_SetString(PyExc_RuntimeError, "fork not supported for subinterpreters");
6778 return NULL;
6779 }
Steve Dowera00b5be2020-02-13 08:30:27 +00006780 if (PySys_Audit("os.forkpty", NULL) < 0) {
6781 return NULL;
6782 }
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006783 PyOS_BeforeFork();
Victor Stinner8c62be82010-05-06 00:08:46 +00006784 pid = forkpty(&master_fd, NULL, NULL, NULL);
6785 if (pid == 0) {
6786 /* child: this clobbers and resets the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006787 PyOS_AfterFork_Child();
Victor Stinner8c62be82010-05-06 00:08:46 +00006788 } else {
6789 /* parent: release the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006790 PyOS_AfterFork_Parent();
Victor Stinner8c62be82010-05-06 00:08:46 +00006791 }
6792 if (pid == -1)
6793 return posix_error();
Victor Stinner8c62be82010-05-06 00:08:46 +00006794 return Py_BuildValue("(Ni)", PyLong_FromPid(pid), master_fd);
Fred Drake8cef4cf2000-06-28 16:40:38 +00006795}
Larry Hastings2f936352014-08-05 14:04:04 +10006796#endif /* HAVE_FORKPTY */
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006797
Ross Lagerwall7807c352011-03-17 20:20:30 +02006798
Guido van Rossumad0ee831995-03-01 10:34:45 +00006799#ifdef HAVE_GETEGID
Larry Hastings2f936352014-08-05 14:04:04 +10006800/*[clinic input]
6801os.getegid
6802
6803Return the current process's effective group id.
6804[clinic start generated code]*/
6805
Larry Hastings2f936352014-08-05 14:04:04 +10006806static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006807os_getegid_impl(PyObject *module)
6808/*[clinic end generated code: output=67d9be7ac68898a2 input=1596f79ad1107d5d]*/
Guido van Rossum46003ff1992-05-15 11:05:24 +00006809{
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006810 return _PyLong_FromGid(getegid());
Guido van Rossum46003ff1992-05-15 11:05:24 +00006811}
Larry Hastings2f936352014-08-05 14:04:04 +10006812#endif /* HAVE_GETEGID */
Guido van Rossum46003ff1992-05-15 11:05:24 +00006813
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006814
Guido van Rossumad0ee831995-03-01 10:34:45 +00006815#ifdef HAVE_GETEUID
Larry Hastings2f936352014-08-05 14:04:04 +10006816/*[clinic input]
6817os.geteuid
6818
6819Return the current process's effective user id.
6820[clinic start generated code]*/
6821
Larry Hastings2f936352014-08-05 14:04:04 +10006822static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006823os_geteuid_impl(PyObject *module)
6824/*[clinic end generated code: output=ea1b60f0d6abb66e input=4644c662d3bd9f19]*/
Guido van Rossum46003ff1992-05-15 11:05:24 +00006825{
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006826 return _PyLong_FromUid(geteuid());
Guido van Rossum46003ff1992-05-15 11:05:24 +00006827}
Larry Hastings2f936352014-08-05 14:04:04 +10006828#endif /* HAVE_GETEUID */
Guido van Rossum46003ff1992-05-15 11:05:24 +00006829
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006830
Guido van Rossumad0ee831995-03-01 10:34:45 +00006831#ifdef HAVE_GETGID
Larry Hastings2f936352014-08-05 14:04:04 +10006832/*[clinic input]
6833os.getgid
6834
6835Return the current process's group id.
6836[clinic start generated code]*/
6837
Larry Hastings2f936352014-08-05 14:04:04 +10006838static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006839os_getgid_impl(PyObject *module)
6840/*[clinic end generated code: output=4f28ebc9d3e5dfcf input=58796344cd87c0f6]*/
Guido van Rossum46003ff1992-05-15 11:05:24 +00006841{
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006842 return _PyLong_FromGid(getgid());
Guido van Rossum46003ff1992-05-15 11:05:24 +00006843}
Larry Hastings2f936352014-08-05 14:04:04 +10006844#endif /* HAVE_GETGID */
Guido van Rossum46003ff1992-05-15 11:05:24 +00006845
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006846
Berker Peksag39404992016-09-15 20:45:16 +03006847#ifdef HAVE_GETPID
Larry Hastings2f936352014-08-05 14:04:04 +10006848/*[clinic input]
6849os.getpid
6850
6851Return the current process id.
6852[clinic start generated code]*/
6853
Larry Hastings2f936352014-08-05 14:04:04 +10006854static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006855os_getpid_impl(PyObject *module)
6856/*[clinic end generated code: output=9ea6fdac01ed2b3c input=5a9a00f0ab68aa00]*/
Guido van Rossum85e3b011991-06-03 12:42:10 +00006857{
Victor Stinner8c62be82010-05-06 00:08:46 +00006858 return PyLong_FromPid(getpid());
Guido van Rossum85e3b011991-06-03 12:42:10 +00006859}
Berker Peksag39404992016-09-15 20:45:16 +03006860#endif /* HAVE_GETPID */
Guido van Rossum85e3b011991-06-03 12:42:10 +00006861
Miss Islington (bot)c80183e2019-06-13 00:27:23 -07006862#ifdef NGROUPS_MAX
6863#define MAX_GROUPS NGROUPS_MAX
6864#else
6865 /* defined to be 16 on Solaris7, so this should be a small number */
6866#define MAX_GROUPS 64
6867#endif
6868
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006869#ifdef HAVE_GETGROUPLIST
Larry Hastings2f936352014-08-05 14:04:04 +10006870
6871/* AC 3.5: funny apple logic below */
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006872PyDoc_STRVAR(posix_getgrouplist__doc__,
6873"getgrouplist(user, group) -> list of groups to which a user belongs\n\n\
6874Returns a list of groups to which a user belongs.\n\n\
6875 user: username to lookup\n\
6876 group: base group id of the user");
6877
6878static PyObject *
6879posix_getgrouplist(PyObject *self, PyObject *args)
6880{
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006881 const char *user;
6882 int i, ngroups;
6883 PyObject *list;
6884#ifdef __APPLE__
6885 int *groups, basegid;
6886#else
6887 gid_t *groups, basegid;
6888#endif
Miss Islington (bot)c80183e2019-06-13 00:27:23 -07006889
6890 /*
6891 * NGROUPS_MAX is defined by POSIX.1 as the maximum
6892 * number of supplimental groups a users can belong to.
6893 * We have to increment it by one because
6894 * getgrouplist() returns both the supplemental groups
6895 * and the primary group, i.e. all of the groups the
6896 * user belongs to.
6897 */
6898 ngroups = 1 + MAX_GROUPS;
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006899
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006900#ifdef __APPLE__
6901 if (!PyArg_ParseTuple(args, "si:getgrouplist", &user, &basegid))
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006902 return NULL;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006903#else
6904 if (!PyArg_ParseTuple(args, "sO&:getgrouplist", &user,
6905 _Py_Gid_Converter, &basegid))
6906 return NULL;
6907#endif
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006908
Miss Islington (bot)af6fd1f2020-03-24 10:40:31 -07006909 while (1) {
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006910#ifdef __APPLE__
Miss Islington (bot)21bee0b2020-03-23 12:18:41 -07006911 groups = PyMem_New(int, ngroups);
Miss Islington (bot)af6fd1f2020-03-24 10:40:31 -07006912#else
6913 groups = PyMem_New(gid_t, ngroups);
6914#endif
Miss Islington (bot)21bee0b2020-03-23 12:18:41 -07006915 if (groups == NULL) {
6916 return PyErr_NoMemory();
6917 }
Miss Islington (bot)af6fd1f2020-03-24 10:40:31 -07006918
6919 int old_ngroups = ngroups;
6920 if (getgrouplist(user, basegid, groups, &ngroups) != -1) {
6921 /* Success */
6922 break;
6923 }
6924
6925 /* getgrouplist() fails if the group list is too small */
6926 PyMem_Free(groups);
6927
6928 if (ngroups > old_ngroups) {
6929 /* If the group list is too small, the glibc implementation of
6930 getgrouplist() sets ngroups to the total number of groups and
6931 returns -1. */
6932 }
6933 else {
6934 /* Double the group list size */
6935 if (ngroups > INT_MAX / 2) {
6936 return PyErr_NoMemory();
6937 }
6938 ngroups *= 2;
6939 }
6940
6941 /* Retry getgrouplist() with a larger group list */
Miss Islington (bot)21bee0b2020-03-23 12:18:41 -07006942 }
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006943
Gregory P. Smith1d300ce2018-12-30 21:13:02 -08006944#ifdef _Py_MEMORY_SANITIZER
6945 /* Clang memory sanitizer libc intercepts don't know getgrouplist. */
6946 __msan_unpoison(&ngroups, sizeof(ngroups));
6947 __msan_unpoison(groups, ngroups*sizeof(*groups));
6948#endif
6949
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006950 list = PyList_New(ngroups);
6951 if (list == NULL) {
6952 PyMem_Del(groups);
6953 return NULL;
6954 }
6955
6956 for (i = 0; i < ngroups; i++) {
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006957#ifdef __APPLE__
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006958 PyObject *o = PyLong_FromUnsignedLong((unsigned long)groups[i]);
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006959#else
6960 PyObject *o = _PyLong_FromGid(groups[i]);
6961#endif
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006962 if (o == NULL) {
6963 Py_DECREF(list);
6964 PyMem_Del(groups);
6965 return NULL;
6966 }
6967 PyList_SET_ITEM(list, i, o);
6968 }
6969
6970 PyMem_Del(groups);
6971
6972 return list;
6973}
Larry Hastings2f936352014-08-05 14:04:04 +10006974#endif /* HAVE_GETGROUPLIST */
6975
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006976
Fred Drakec9680921999-12-13 16:37:25 +00006977#ifdef HAVE_GETGROUPS
Larry Hastings2f936352014-08-05 14:04:04 +10006978/*[clinic input]
6979os.getgroups
6980
6981Return list of supplemental group IDs for the process.
6982[clinic start generated code]*/
6983
Larry Hastings2f936352014-08-05 14:04:04 +10006984static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006985os_getgroups_impl(PyObject *module)
6986/*[clinic end generated code: output=42b0c17758561b56 input=d3f109412e6a155c]*/
Fred Drakec9680921999-12-13 16:37:25 +00006987{
6988 PyObject *result = NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00006989 gid_t grouplist[MAX_GROUPS];
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00006990
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00006991 /* On MacOSX getgroups(2) can return more than MAX_GROUPS results
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00006992 * This is a helper variable to store the intermediate result when
6993 * that happens.
6994 *
6995 * To keep the code readable the OSX behaviour is unconditional,
6996 * according to the POSIX spec this should be safe on all unix-y
6997 * systems.
6998 */
6999 gid_t* alt_grouplist = grouplist;
Victor Stinner8c62be82010-05-06 00:08:46 +00007000 int n;
Fred Drakec9680921999-12-13 16:37:25 +00007001
Ned Deilyb5dd6d22013-08-01 21:21:15 -07007002#ifdef __APPLE__
7003 /* Issue #17557: As of OS X 10.8, getgroups(2) no longer raises EINVAL if
7004 * there are more groups than can fit in grouplist. Therefore, on OS X
7005 * always first call getgroups with length 0 to get the actual number
7006 * of groups.
7007 */
7008 n = getgroups(0, NULL);
7009 if (n < 0) {
7010 return posix_error();
7011 } else if (n <= MAX_GROUPS) {
7012 /* groups will fit in existing array */
7013 alt_grouplist = grouplist;
7014 } else {
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02007015 alt_grouplist = PyMem_New(gid_t, n);
Ned Deilyb5dd6d22013-08-01 21:21:15 -07007016 if (alt_grouplist == NULL) {
Zackery Spytz4c49da02018-12-07 03:11:30 -07007017 return PyErr_NoMemory();
Ned Deilyb5dd6d22013-08-01 21:21:15 -07007018 }
7019 }
7020
7021 n = getgroups(n, alt_grouplist);
7022 if (n == -1) {
7023 if (alt_grouplist != grouplist) {
7024 PyMem_Free(alt_grouplist);
7025 }
7026 return posix_error();
7027 }
7028#else
Victor Stinner8c62be82010-05-06 00:08:46 +00007029 n = getgroups(MAX_GROUPS, grouplist);
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00007030 if (n < 0) {
7031 if (errno == EINVAL) {
7032 n = getgroups(0, NULL);
7033 if (n == -1) {
7034 return posix_error();
7035 }
7036 if (n == 0) {
7037 /* Avoid malloc(0) */
7038 alt_grouplist = grouplist;
7039 } else {
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02007040 alt_grouplist = PyMem_New(gid_t, n);
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00007041 if (alt_grouplist == NULL) {
Zackery Spytz4c49da02018-12-07 03:11:30 -07007042 return PyErr_NoMemory();
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00007043 }
7044 n = getgroups(n, alt_grouplist);
7045 if (n == -1) {
7046 PyMem_Free(alt_grouplist);
7047 return posix_error();
7048 }
7049 }
7050 } else {
7051 return posix_error();
7052 }
7053 }
Ned Deilyb5dd6d22013-08-01 21:21:15 -07007054#endif
7055
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00007056 result = PyList_New(n);
7057 if (result != NULL) {
Victor Stinner8c62be82010-05-06 00:08:46 +00007058 int i;
7059 for (i = 0; i < n; ++i) {
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02007060 PyObject *o = _PyLong_FromGid(alt_grouplist[i]);
Victor Stinner8c62be82010-05-06 00:08:46 +00007061 if (o == NULL) {
Stefan Krah0e803b32010-11-26 16:16:47 +00007062 Py_DECREF(result);
7063 result = NULL;
7064 break;
Fred Drakec9680921999-12-13 16:37:25 +00007065 }
Victor Stinner8c62be82010-05-06 00:08:46 +00007066 PyList_SET_ITEM(result, i, o);
Fred Drakec9680921999-12-13 16:37:25 +00007067 }
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00007068 }
7069
7070 if (alt_grouplist != grouplist) {
7071 PyMem_Free(alt_grouplist);
Victor Stinner8c62be82010-05-06 00:08:46 +00007072 }
Neal Norwitze241ce82003-02-17 18:17:05 +00007073
Fred Drakec9680921999-12-13 16:37:25 +00007074 return result;
7075}
Larry Hastings2f936352014-08-05 14:04:04 +10007076#endif /* HAVE_GETGROUPS */
Fred Drakec9680921999-12-13 16:37:25 +00007077
Antoine Pitroub7572f02009-12-02 20:46:48 +00007078#ifdef HAVE_INITGROUPS
7079PyDoc_STRVAR(posix_initgroups__doc__,
7080"initgroups(username, gid) -> None\n\n\
7081Call the system initgroups() to initialize the group access list with all of\n\
7082the groups of which the specified username is a member, plus the specified\n\
7083group id.");
7084
Larry Hastings2f936352014-08-05 14:04:04 +10007085/* AC 3.5: funny apple logic */
Antoine Pitroub7572f02009-12-02 20:46:48 +00007086static PyObject *
7087posix_initgroups(PyObject *self, PyObject *args)
7088{
Victor Stinner61ec5dc2010-08-15 09:22:44 +00007089 PyObject *oname;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03007090 const char *username;
Victor Stinner61ec5dc2010-08-15 09:22:44 +00007091 int res;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02007092#ifdef __APPLE__
7093 int gid;
7094#else
7095 gid_t gid;
7096#endif
Antoine Pitroub7572f02009-12-02 20:46:48 +00007097
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02007098#ifdef __APPLE__
7099 if (!PyArg_ParseTuple(args, "O&i:initgroups",
7100 PyUnicode_FSConverter, &oname,
7101 &gid))
7102#else
7103 if (!PyArg_ParseTuple(args, "O&O&:initgroups",
7104 PyUnicode_FSConverter, &oname,
7105 _Py_Gid_Converter, &gid))
7106#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00007107 return NULL;
Victor Stinner61ec5dc2010-08-15 09:22:44 +00007108 username = PyBytes_AS_STRING(oname);
Antoine Pitroub7572f02009-12-02 20:46:48 +00007109
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02007110 res = initgroups(username, gid);
Victor Stinner61ec5dc2010-08-15 09:22:44 +00007111 Py_DECREF(oname);
7112 if (res == -1)
Victor Stinner8c62be82010-05-06 00:08:46 +00007113 return PyErr_SetFromErrno(PyExc_OSError);
Antoine Pitroub7572f02009-12-02 20:46:48 +00007114
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02007115 Py_RETURN_NONE;
Antoine Pitroub7572f02009-12-02 20:46:48 +00007116}
Larry Hastings2f936352014-08-05 14:04:04 +10007117#endif /* HAVE_INITGROUPS */
7118
Antoine Pitroub7572f02009-12-02 20:46:48 +00007119
Martin v. Löwis606edc12002-06-13 21:09:11 +00007120#ifdef HAVE_GETPGID
Larry Hastings2f936352014-08-05 14:04:04 +10007121/*[clinic input]
7122os.getpgid
7123
7124 pid: pid_t
7125
7126Call the system call getpgid(), and return the result.
7127[clinic start generated code]*/
7128
Larry Hastings2f936352014-08-05 14:04:04 +10007129static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007130os_getpgid_impl(PyObject *module, pid_t pid)
7131/*[clinic end generated code: output=1db95a97be205d18 input=39d710ae3baaf1c7]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007132{
7133 pid_t pgid = getpgid(pid);
Victor Stinner8c62be82010-05-06 00:08:46 +00007134 if (pgid < 0)
7135 return posix_error();
7136 return PyLong_FromPid(pgid);
Martin v. Löwis606edc12002-06-13 21:09:11 +00007137}
7138#endif /* HAVE_GETPGID */
7139
7140
Guido van Rossumb6775db1994-08-01 11:34:53 +00007141#ifdef HAVE_GETPGRP
Larry Hastings2f936352014-08-05 14:04:04 +10007142/*[clinic input]
7143os.getpgrp
7144
7145Return the current process group id.
7146[clinic start generated code]*/
7147
Larry Hastings2f936352014-08-05 14:04:04 +10007148static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007149os_getpgrp_impl(PyObject *module)
7150/*[clinic end generated code: output=c4fc381e51103cf3 input=6846fb2bb9a3705e]*/
Guido van Rossum04814471991-06-04 20:23:49 +00007151{
Guido van Rossumb6775db1994-08-01 11:34:53 +00007152#ifdef GETPGRP_HAVE_ARG
Victor Stinner8c62be82010-05-06 00:08:46 +00007153 return PyLong_FromPid(getpgrp(0));
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00007154#else /* GETPGRP_HAVE_ARG */
Victor Stinner8c62be82010-05-06 00:08:46 +00007155 return PyLong_FromPid(getpgrp());
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00007156#endif /* GETPGRP_HAVE_ARG */
Guido van Rossum04814471991-06-04 20:23:49 +00007157}
Guido van Rossumb6775db1994-08-01 11:34:53 +00007158#endif /* HAVE_GETPGRP */
Guido van Rossum04814471991-06-04 20:23:49 +00007159
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007160
Guido van Rossumb6775db1994-08-01 11:34:53 +00007161#ifdef HAVE_SETPGRP
Larry Hastings2f936352014-08-05 14:04:04 +10007162/*[clinic input]
7163os.setpgrp
7164
7165Make the current process the leader of its process group.
7166[clinic start generated code]*/
7167
Larry Hastings2f936352014-08-05 14:04:04 +10007168static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007169os_setpgrp_impl(PyObject *module)
7170/*[clinic end generated code: output=2554735b0a60f0a0 input=1f0619fcb5731e7e]*/
Guido van Rossumc2670a01992-09-13 20:07:29 +00007171{
Guido van Rossum64933891994-10-20 21:56:42 +00007172#ifdef SETPGRP_HAVE_ARG
Victor Stinner8c62be82010-05-06 00:08:46 +00007173 if (setpgrp(0, 0) < 0)
Guido van Rossum64933891994-10-20 21:56:42 +00007174#else /* SETPGRP_HAVE_ARG */
Victor Stinner8c62be82010-05-06 00:08:46 +00007175 if (setpgrp() < 0)
Guido van Rossum64933891994-10-20 21:56:42 +00007176#endif /* SETPGRP_HAVE_ARG */
Victor Stinner8c62be82010-05-06 00:08:46 +00007177 return posix_error();
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02007178 Py_RETURN_NONE;
Guido van Rossumc2670a01992-09-13 20:07:29 +00007179}
Guido van Rossumb6775db1994-08-01 11:34:53 +00007180#endif /* HAVE_SETPGRP */
7181
Guido van Rossumad0ee831995-03-01 10:34:45 +00007182#ifdef HAVE_GETPPID
Amaury Forgeot d'Arc4b6fdf32010-09-07 21:31:17 +00007183
7184#ifdef MS_WINDOWS
7185#include <tlhelp32.h>
7186
7187static PyObject*
7188win32_getppid()
7189{
7190 HANDLE snapshot;
7191 pid_t mypid;
7192 PyObject* result = NULL;
7193 BOOL have_record;
7194 PROCESSENTRY32 pe;
7195
7196 mypid = getpid(); /* This function never fails */
7197
7198 snapshot = CreateToolhelp32Snapshot(TH32CS_SNAPPROCESS, 0);
7199 if (snapshot == INVALID_HANDLE_VALUE)
7200 return PyErr_SetFromWindowsErr(GetLastError());
7201
7202 pe.dwSize = sizeof(pe);
7203 have_record = Process32First(snapshot, &pe);
7204 while (have_record) {
7205 if (mypid == (pid_t)pe.th32ProcessID) {
7206 /* We could cache the ulong value in a static variable. */
7207 result = PyLong_FromPid((pid_t)pe.th32ParentProcessID);
7208 break;
7209 }
7210
7211 have_record = Process32Next(snapshot, &pe);
7212 }
7213
7214 /* If our loop exits and our pid was not found (result will be NULL)
7215 * then GetLastError will return ERROR_NO_MORE_FILES. This is an
7216 * error anyway, so let's raise it. */
7217 if (!result)
7218 result = PyErr_SetFromWindowsErr(GetLastError());
7219
7220 CloseHandle(snapshot);
7221
7222 return result;
7223}
7224#endif /*MS_WINDOWS*/
7225
Larry Hastings2f936352014-08-05 14:04:04 +10007226
7227/*[clinic input]
7228os.getppid
7229
7230Return the parent's process id.
7231
7232If the parent process has already exited, Windows machines will still
7233return its id; others systems will return the id of the 'init' process (1).
7234[clinic start generated code]*/
7235
Larry Hastings2f936352014-08-05 14:04:04 +10007236static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007237os_getppid_impl(PyObject *module)
7238/*[clinic end generated code: output=43b2a946a8c603b4 input=e637cb87539c030e]*/
Guido van Rossum85e3b011991-06-03 12:42:10 +00007239{
Amaury Forgeot d'Arc4b6fdf32010-09-07 21:31:17 +00007240#ifdef MS_WINDOWS
7241 return win32_getppid();
7242#else
Victor Stinner8c62be82010-05-06 00:08:46 +00007243 return PyLong_FromPid(getppid());
Guido van Rossumad0ee831995-03-01 10:34:45 +00007244#endif
Amaury Forgeot d'Arc4b6fdf32010-09-07 21:31:17 +00007245}
7246#endif /* HAVE_GETPPID */
Guido van Rossum85e3b011991-06-03 12:42:10 +00007247
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007248
Fred Drake12c6e2d1999-12-14 21:25:03 +00007249#ifdef HAVE_GETLOGIN
Larry Hastings2f936352014-08-05 14:04:04 +10007250/*[clinic input]
7251os.getlogin
7252
7253Return the actual login name.
7254[clinic start generated code]*/
7255
Larry Hastings2f936352014-08-05 14:04:04 +10007256static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007257os_getlogin_impl(PyObject *module)
7258/*[clinic end generated code: output=a32e66a7e5715dac input=2a21ab1e917163df]*/
Fred Drake12c6e2d1999-12-14 21:25:03 +00007259{
Victor Stinner8c62be82010-05-06 00:08:46 +00007260 PyObject *result = NULL;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00007261#ifdef MS_WINDOWS
Brian Curtine8e4b3b2010-09-23 20:04:14 +00007262 wchar_t user_name[UNLEN + 1];
Victor Stinner63941882011-09-29 00:42:28 +02007263 DWORD num_chars = Py_ARRAY_LENGTH(user_name);
Brian Curtine8e4b3b2010-09-23 20:04:14 +00007264
7265 if (GetUserNameW(user_name, &num_chars)) {
7266 /* num_chars is the number of unicode chars plus null terminator */
7267 result = PyUnicode_FromWideChar(user_name, num_chars - 1);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00007268 }
7269 else
Brian Curtine8e4b3b2010-09-23 20:04:14 +00007270 result = PyErr_SetFromWindowsErr(GetLastError());
7271#else
Victor Stinner8c62be82010-05-06 00:08:46 +00007272 char *name;
7273 int old_errno = errno;
Fred Drake12c6e2d1999-12-14 21:25:03 +00007274
Victor Stinner8c62be82010-05-06 00:08:46 +00007275 errno = 0;
7276 name = getlogin();
7277 if (name == NULL) {
7278 if (errno)
Victor Stinnere039ffe2010-08-15 09:33:08 +00007279 posix_error();
Fred Drake12c6e2d1999-12-14 21:25:03 +00007280 else
Victor Stinnere039ffe2010-08-15 09:33:08 +00007281 PyErr_SetString(PyExc_OSError, "unable to determine login name");
Victor Stinner8c62be82010-05-06 00:08:46 +00007282 }
7283 else
Victor Stinnere039ffe2010-08-15 09:33:08 +00007284 result = PyUnicode_DecodeFSDefault(name);
Victor Stinner8c62be82010-05-06 00:08:46 +00007285 errno = old_errno;
Brian Curtine8e4b3b2010-09-23 20:04:14 +00007286#endif
Fred Drake12c6e2d1999-12-14 21:25:03 +00007287 return result;
7288}
Brian Curtine8e4b3b2010-09-23 20:04:14 +00007289#endif /* HAVE_GETLOGIN */
Fred Drake12c6e2d1999-12-14 21:25:03 +00007290
Larry Hastings2f936352014-08-05 14:04:04 +10007291
Guido van Rossumad0ee831995-03-01 10:34:45 +00007292#ifdef HAVE_GETUID
Larry Hastings2f936352014-08-05 14:04:04 +10007293/*[clinic input]
7294os.getuid
7295
7296Return the current process's user id.
7297[clinic start generated code]*/
7298
Larry Hastings2f936352014-08-05 14:04:04 +10007299static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007300os_getuid_impl(PyObject *module)
7301/*[clinic end generated code: output=415c0b401ebed11a input=b53c8b35f110a516]*/
Guido van Rossum46003ff1992-05-15 11:05:24 +00007302{
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02007303 return _PyLong_FromUid(getuid());
Guido van Rossum46003ff1992-05-15 11:05:24 +00007304}
Larry Hastings2f936352014-08-05 14:04:04 +10007305#endif /* HAVE_GETUID */
Guido van Rossum46003ff1992-05-15 11:05:24 +00007306
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007307
Brian Curtineb24d742010-04-12 17:16:38 +00007308#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10007309#define HAVE_KILL
7310#endif /* MS_WINDOWS */
7311
7312#ifdef HAVE_KILL
7313/*[clinic input]
7314os.kill
7315
7316 pid: pid_t
7317 signal: Py_ssize_t
7318 /
7319
7320Kill a process with a signal.
7321[clinic start generated code]*/
7322
Larry Hastings2f936352014-08-05 14:04:04 +10007323static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007324os_kill_impl(PyObject *module, pid_t pid, Py_ssize_t signal)
7325/*[clinic end generated code: output=8e346a6701c88568 input=61a36b86ca275ab9]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007326{
Steve Dowera00b5be2020-02-13 08:30:27 +00007327 if (PySys_Audit("os.kill", "in", pid, signal) < 0) {
7328 return NULL;
7329 }
7330#ifndef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10007331 if (kill(pid, (int)signal) == -1)
7332 return posix_error();
7333 Py_RETURN_NONE;
Larry Hastings2f936352014-08-05 14:04:04 +10007334#else /* !MS_WINDOWS */
Amaury Forgeot d'Arc0a589c92010-05-15 20:35:12 +00007335 PyObject *result;
Larry Hastings2f936352014-08-05 14:04:04 +10007336 DWORD sig = (DWORD)signal;
7337 DWORD err;
Victor Stinner8c62be82010-05-06 00:08:46 +00007338 HANDLE handle;
Brian Curtineb24d742010-04-12 17:16:38 +00007339
Victor Stinner8c62be82010-05-06 00:08:46 +00007340 /* Console processes which share a common console can be sent CTRL+C or
7341 CTRL+BREAK events, provided they handle said events. */
7342 if (sig == CTRL_C_EVENT || sig == CTRL_BREAK_EVENT) {
Richard Oudkerkac0ad882013-06-05 23:29:30 +01007343 if (GenerateConsoleCtrlEvent(sig, (DWORD)pid) == 0) {
Victor Stinner8c62be82010-05-06 00:08:46 +00007344 err = GetLastError();
7345 PyErr_SetFromWindowsErr(err);
7346 }
7347 else
7348 Py_RETURN_NONE;
7349 }
Brian Curtineb24d742010-04-12 17:16:38 +00007350
Victor Stinner8c62be82010-05-06 00:08:46 +00007351 /* If the signal is outside of what GenerateConsoleCtrlEvent can use,
7352 attempt to open and terminate the process. */
Richard Oudkerkac0ad882013-06-05 23:29:30 +01007353 handle = OpenProcess(PROCESS_ALL_ACCESS, FALSE, (DWORD)pid);
Victor Stinner8c62be82010-05-06 00:08:46 +00007354 if (handle == NULL) {
7355 err = GetLastError();
7356 return PyErr_SetFromWindowsErr(err);
7357 }
Brian Curtineb24d742010-04-12 17:16:38 +00007358
Victor Stinner8c62be82010-05-06 00:08:46 +00007359 if (TerminateProcess(handle, sig) == 0) {
7360 err = GetLastError();
7361 result = PyErr_SetFromWindowsErr(err);
7362 } else {
7363 Py_INCREF(Py_None);
7364 result = Py_None;
7365 }
Brian Curtineb24d742010-04-12 17:16:38 +00007366
Victor Stinner8c62be82010-05-06 00:08:46 +00007367 CloseHandle(handle);
7368 return result;
Larry Hastings2f936352014-08-05 14:04:04 +10007369#endif /* !MS_WINDOWS */
Steve Dowera00b5be2020-02-13 08:30:27 +00007370}
Larry Hastings2f936352014-08-05 14:04:04 +10007371#endif /* HAVE_KILL */
7372
7373
7374#ifdef HAVE_KILLPG
7375/*[clinic input]
7376os.killpg
7377
7378 pgid: pid_t
7379 signal: int
7380 /
7381
7382Kill a process group with a signal.
7383[clinic start generated code]*/
7384
Larry Hastings2f936352014-08-05 14:04:04 +10007385static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007386os_killpg_impl(PyObject *module, pid_t pgid, int signal)
7387/*[clinic end generated code: output=6dbcd2f1fdf5fdba input=38b5449eb8faec19]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007388{
Steve Dowera00b5be2020-02-13 08:30:27 +00007389 if (PySys_Audit("os.killpg", "ii", pgid, signal) < 0) {
7390 return NULL;
7391 }
Larry Hastings2f936352014-08-05 14:04:04 +10007392 /* XXX some man pages make the `pgid` parameter an int, others
7393 a pid_t. Since getpgrp() returns a pid_t, we assume killpg should
7394 take the same type. Moreover, pid_t is always at least as wide as
7395 int (else compilation of this module fails), which is safe. */
7396 if (killpg(pgid, signal) == -1)
7397 return posix_error();
7398 Py_RETURN_NONE;
7399}
7400#endif /* HAVE_KILLPG */
7401
Brian Curtineb24d742010-04-12 17:16:38 +00007402
Guido van Rossumc0125471996-06-28 18:55:32 +00007403#ifdef HAVE_PLOCK
Guido van Rossumc0125471996-06-28 18:55:32 +00007404#ifdef HAVE_SYS_LOCK_H
7405#include <sys/lock.h>
7406#endif
7407
Larry Hastings2f936352014-08-05 14:04:04 +10007408/*[clinic input]
7409os.plock
7410 op: int
7411 /
7412
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00007413Lock program segments into memory.");
Larry Hastings2f936352014-08-05 14:04:04 +10007414[clinic start generated code]*/
7415
Larry Hastings2f936352014-08-05 14:04:04 +10007416static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007417os_plock_impl(PyObject *module, int op)
7418/*[clinic end generated code: output=81424167033b168e input=e6e5e348e1525f60]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007419{
Victor Stinner8c62be82010-05-06 00:08:46 +00007420 if (plock(op) == -1)
7421 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007422 Py_RETURN_NONE;
Guido van Rossumc0125471996-06-28 18:55:32 +00007423}
Larry Hastings2f936352014-08-05 14:04:04 +10007424#endif /* HAVE_PLOCK */
7425
Guido van Rossumc0125471996-06-28 18:55:32 +00007426
Guido van Rossumb6775db1994-08-01 11:34:53 +00007427#ifdef HAVE_SETUID
Larry Hastings2f936352014-08-05 14:04:04 +10007428/*[clinic input]
7429os.setuid
7430
7431 uid: uid_t
7432 /
7433
7434Set the current process's user id.
7435[clinic start generated code]*/
7436
Larry Hastings2f936352014-08-05 14:04:04 +10007437static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007438os_setuid_impl(PyObject *module, uid_t uid)
7439/*[clinic end generated code: output=a0a41fd0d1ec555f input=c921a3285aa22256]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007440{
Victor Stinner8c62be82010-05-06 00:08:46 +00007441 if (setuid(uid) < 0)
7442 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007443 Py_RETURN_NONE;
Guido van Rossuma3d78fb1993-11-10 09:23:53 +00007444}
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00007445#endif /* HAVE_SETUID */
Guido van Rossuma3d78fb1993-11-10 09:23:53 +00007446
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007447
Andrew M. Kuchling8d2f2b2d2000-07-13 01:26:58 +00007448#ifdef HAVE_SETEUID
Larry Hastings2f936352014-08-05 14:04:04 +10007449/*[clinic input]
7450os.seteuid
7451
7452 euid: uid_t
7453 /
7454
7455Set the current process's effective user id.
7456[clinic start generated code]*/
7457
Larry Hastings2f936352014-08-05 14:04:04 +10007458static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007459os_seteuid_impl(PyObject *module, uid_t euid)
7460/*[clinic end generated code: output=102e3ad98361519a input=ba93d927e4781aa9]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007461{
7462 if (seteuid(euid) < 0)
Victor Stinner8c62be82010-05-06 00:08:46 +00007463 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007464 Py_RETURN_NONE;
Andrew M. Kuchling8d2f2b2d2000-07-13 01:26:58 +00007465}
7466#endif /* HAVE_SETEUID */
7467
Larry Hastings2f936352014-08-05 14:04:04 +10007468
Andrew M. Kuchling8d2f2b2d2000-07-13 01:26:58 +00007469#ifdef HAVE_SETEGID
Larry Hastings2f936352014-08-05 14:04:04 +10007470/*[clinic input]
7471os.setegid
7472
7473 egid: gid_t
7474 /
7475
7476Set the current process's effective group id.
7477[clinic start generated code]*/
7478
Larry Hastings2f936352014-08-05 14:04:04 +10007479static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007480os_setegid_impl(PyObject *module, gid_t egid)
7481/*[clinic end generated code: output=4e4b825a6a10258d input=4080526d0ccd6ce3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007482{
7483 if (setegid(egid) < 0)
Victor Stinner8c62be82010-05-06 00:08:46 +00007484 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007485 Py_RETURN_NONE;
Andrew M. Kuchling8d2f2b2d2000-07-13 01:26:58 +00007486}
7487#endif /* HAVE_SETEGID */
7488
Larry Hastings2f936352014-08-05 14:04:04 +10007489
Andrew M. Kuchling8d2f2b2d2000-07-13 01:26:58 +00007490#ifdef HAVE_SETREUID
Larry Hastings2f936352014-08-05 14:04:04 +10007491/*[clinic input]
7492os.setreuid
7493
7494 ruid: uid_t
7495 euid: uid_t
7496 /
7497
7498Set the current process's real and effective user ids.
7499[clinic start generated code]*/
7500
Larry Hastings2f936352014-08-05 14:04:04 +10007501static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007502os_setreuid_impl(PyObject *module, uid_t ruid, uid_t euid)
7503/*[clinic end generated code: output=62d991210006530a input=0ca8978de663880c]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007504{
Victor Stinner8c62be82010-05-06 00:08:46 +00007505 if (setreuid(ruid, euid) < 0) {
7506 return posix_error();
7507 } else {
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02007508 Py_RETURN_NONE;
Victor Stinner8c62be82010-05-06 00:08:46 +00007509 }
Andrew M. Kuchling8d2f2b2d2000-07-13 01:26:58 +00007510}
7511#endif /* HAVE_SETREUID */
7512
Larry Hastings2f936352014-08-05 14:04:04 +10007513
Andrew M. Kuchling8d2f2b2d2000-07-13 01:26:58 +00007514#ifdef HAVE_SETREGID
Larry Hastings2f936352014-08-05 14:04:04 +10007515/*[clinic input]
7516os.setregid
7517
7518 rgid: gid_t
7519 egid: gid_t
7520 /
7521
7522Set the current process's real and effective group ids.
7523[clinic start generated code]*/
7524
Larry Hastings2f936352014-08-05 14:04:04 +10007525static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007526os_setregid_impl(PyObject *module, gid_t rgid, gid_t egid)
7527/*[clinic end generated code: output=aa803835cf5342f3 input=c59499f72846db78]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007528{
7529 if (setregid(rgid, egid) < 0)
Victor Stinner8c62be82010-05-06 00:08:46 +00007530 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007531 Py_RETURN_NONE;
Andrew M. Kuchling8d2f2b2d2000-07-13 01:26:58 +00007532}
7533#endif /* HAVE_SETREGID */
7534
Larry Hastings2f936352014-08-05 14:04:04 +10007535
Guido van Rossumb6775db1994-08-01 11:34:53 +00007536#ifdef HAVE_SETGID
Larry Hastings2f936352014-08-05 14:04:04 +10007537/*[clinic input]
7538os.setgid
7539 gid: gid_t
7540 /
7541
7542Set the current process's group id.
7543[clinic start generated code]*/
7544
Larry Hastings2f936352014-08-05 14:04:04 +10007545static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007546os_setgid_impl(PyObject *module, gid_t gid)
7547/*[clinic end generated code: output=bdccd7403f6ad8c3 input=27d30c4059045dc6]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007548{
Victor Stinner8c62be82010-05-06 00:08:46 +00007549 if (setgid(gid) < 0)
7550 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007551 Py_RETURN_NONE;
Guido van Rossuma3d78fb1993-11-10 09:23:53 +00007552}
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00007553#endif /* HAVE_SETGID */
Guido van Rossuma3d78fb1993-11-10 09:23:53 +00007554
Larry Hastings2f936352014-08-05 14:04:04 +10007555
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00007556#ifdef HAVE_SETGROUPS
Larry Hastings2f936352014-08-05 14:04:04 +10007557/*[clinic input]
7558os.setgroups
7559
7560 groups: object
7561 /
7562
7563Set the groups of the current process to list.
7564[clinic start generated code]*/
7565
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00007566static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007567os_setgroups(PyObject *module, PyObject *groups)
7568/*[clinic end generated code: output=3fcb32aad58c5ecd input=fa742ca3daf85a7e]*/
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00007569{
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03007570 Py_ssize_t i, len;
Victor Stinner8c62be82010-05-06 00:08:46 +00007571 gid_t grouplist[MAX_GROUPS];
Tim Peters5aa91602002-01-30 05:46:57 +00007572
Victor Stinner8c62be82010-05-06 00:08:46 +00007573 if (!PySequence_Check(groups)) {
7574 PyErr_SetString(PyExc_TypeError, "setgroups argument must be a sequence");
7575 return NULL;
7576 }
7577 len = PySequence_Size(groups);
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03007578 if (len < 0) {
7579 return NULL;
7580 }
Victor Stinner8c62be82010-05-06 00:08:46 +00007581 if (len > MAX_GROUPS) {
7582 PyErr_SetString(PyExc_ValueError, "too many groups");
7583 return NULL;
7584 }
7585 for(i = 0; i < len; i++) {
7586 PyObject *elem;
7587 elem = PySequence_GetItem(groups, i);
7588 if (!elem)
7589 return NULL;
7590 if (!PyLong_Check(elem)) {
7591 PyErr_SetString(PyExc_TypeError,
7592 "groups must be integers");
7593 Py_DECREF(elem);
7594 return NULL;
7595 } else {
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02007596 if (!_Py_Gid_Converter(elem, &grouplist[i])) {
Victor Stinner8c62be82010-05-06 00:08:46 +00007597 Py_DECREF(elem);
7598 return NULL;
7599 }
7600 }
7601 Py_DECREF(elem);
7602 }
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00007603
Victor Stinner8c62be82010-05-06 00:08:46 +00007604 if (setgroups(len, grouplist) < 0)
7605 return posix_error();
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02007606 Py_RETURN_NONE;
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00007607}
7608#endif /* HAVE_SETGROUPS */
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007609
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007610#if defined(HAVE_WAIT3) || defined(HAVE_WAIT4)
7611static PyObject *
Victor Stinner4195b5c2012-02-08 23:03:19 +01007612wait_helper(pid_t pid, int status, struct rusage *ru)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007613{
Victor Stinner8c62be82010-05-06 00:08:46 +00007614 PyObject *result;
7615 static PyObject *struct_rusage;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02007616 _Py_IDENTIFIER(struct_rusage);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007617
Victor Stinner8c62be82010-05-06 00:08:46 +00007618 if (pid == -1)
7619 return posix_error();
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007620
Victor Stinner8c62be82010-05-06 00:08:46 +00007621 if (struct_rusage == NULL) {
7622 PyObject *m = PyImport_ImportModuleNoBlock("resource");
7623 if (m == NULL)
7624 return NULL;
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02007625 struct_rusage = _PyObject_GetAttrId(m, &PyId_struct_rusage);
Victor Stinner8c62be82010-05-06 00:08:46 +00007626 Py_DECREF(m);
7627 if (struct_rusage == NULL)
7628 return NULL;
7629 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007630
Victor Stinner8c62be82010-05-06 00:08:46 +00007631 /* XXX(nnorwitz): Copied (w/mods) from resource.c, there should be only one. */
7632 result = PyStructSequence_New((PyTypeObject*) struct_rusage);
7633 if (!result)
7634 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007635
7636#ifndef doubletime
7637#define doubletime(TV) ((double)(TV).tv_sec + (TV).tv_usec * 0.000001)
7638#endif
7639
Victor Stinner8c62be82010-05-06 00:08:46 +00007640 PyStructSequence_SET_ITEM(result, 0,
Victor Stinner4195b5c2012-02-08 23:03:19 +01007641 PyFloat_FromDouble(doubletime(ru->ru_utime)));
Victor Stinner8c62be82010-05-06 00:08:46 +00007642 PyStructSequence_SET_ITEM(result, 1,
Victor Stinner4195b5c2012-02-08 23:03:19 +01007643 PyFloat_FromDouble(doubletime(ru->ru_stime)));
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007644#define SET_INT(result, index, value)\
Victor Stinner8c62be82010-05-06 00:08:46 +00007645 PyStructSequence_SET_ITEM(result, index, PyLong_FromLong(value))
7646 SET_INT(result, 2, ru->ru_maxrss);
7647 SET_INT(result, 3, ru->ru_ixrss);
7648 SET_INT(result, 4, ru->ru_idrss);
7649 SET_INT(result, 5, ru->ru_isrss);
7650 SET_INT(result, 6, ru->ru_minflt);
7651 SET_INT(result, 7, ru->ru_majflt);
7652 SET_INT(result, 8, ru->ru_nswap);
7653 SET_INT(result, 9, ru->ru_inblock);
7654 SET_INT(result, 10, ru->ru_oublock);
7655 SET_INT(result, 11, ru->ru_msgsnd);
7656 SET_INT(result, 12, ru->ru_msgrcv);
7657 SET_INT(result, 13, ru->ru_nsignals);
7658 SET_INT(result, 14, ru->ru_nvcsw);
7659 SET_INT(result, 15, ru->ru_nivcsw);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007660#undef SET_INT
7661
Victor Stinner8c62be82010-05-06 00:08:46 +00007662 if (PyErr_Occurred()) {
7663 Py_DECREF(result);
7664 return NULL;
7665 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007666
Victor Stinner8c62be82010-05-06 00:08:46 +00007667 return Py_BuildValue("NiN", PyLong_FromPid(pid), status, result);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007668}
7669#endif /* HAVE_WAIT3 || HAVE_WAIT4 */
7670
Larry Hastings2f936352014-08-05 14:04:04 +10007671
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007672#ifdef HAVE_WAIT3
Larry Hastings2f936352014-08-05 14:04:04 +10007673/*[clinic input]
7674os.wait3
7675
7676 options: int
7677Wait for completion of a child process.
7678
7679Returns a tuple of information about the child process:
7680 (pid, status, rusage)
7681[clinic start generated code]*/
7682
Larry Hastings2f936352014-08-05 14:04:04 +10007683static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007684os_wait3_impl(PyObject *module, int options)
7685/*[clinic end generated code: output=92c3224e6f28217a input=8ac4c56956b61710]*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007686{
Victor Stinner8c62be82010-05-06 00:08:46 +00007687 pid_t pid;
Victor Stinner8c62be82010-05-06 00:08:46 +00007688 struct rusage ru;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007689 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00007690 WAIT_TYPE status;
7691 WAIT_STATUS_INT(status) = 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007692
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007693 do {
7694 Py_BEGIN_ALLOW_THREADS
7695 pid = wait3(&status, options, &ru);
7696 Py_END_ALLOW_THREADS
7697 } while (pid < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
7698 if (pid < 0)
7699 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007700
Victor Stinner4195b5c2012-02-08 23:03:19 +01007701 return wait_helper(pid, WAIT_STATUS_INT(status), &ru);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007702}
7703#endif /* HAVE_WAIT3 */
7704
Larry Hastings2f936352014-08-05 14:04:04 +10007705
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007706#ifdef HAVE_WAIT4
Larry Hastings2f936352014-08-05 14:04:04 +10007707/*[clinic input]
7708
7709os.wait4
7710
7711 pid: pid_t
7712 options: int
7713
7714Wait for completion of a specific child process.
7715
7716Returns a tuple of information about the child process:
7717 (pid, status, rusage)
7718[clinic start generated code]*/
7719
Larry Hastings2f936352014-08-05 14:04:04 +10007720static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007721os_wait4_impl(PyObject *module, pid_t pid, int options)
7722/*[clinic end generated code: output=66195aa507b35f70 input=d11deed0750600ba]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007723{
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007724 pid_t res;
Victor Stinner8c62be82010-05-06 00:08:46 +00007725 struct rusage ru;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007726 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00007727 WAIT_TYPE status;
7728 WAIT_STATUS_INT(status) = 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007729
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007730 do {
7731 Py_BEGIN_ALLOW_THREADS
7732 res = wait4(pid, &status, options, &ru);
7733 Py_END_ALLOW_THREADS
7734 } while (res < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
7735 if (res < 0)
7736 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007737
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007738 return wait_helper(res, WAIT_STATUS_INT(status), &ru);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007739}
7740#endif /* HAVE_WAIT4 */
7741
Larry Hastings2f936352014-08-05 14:04:04 +10007742
Ross Lagerwall7807c352011-03-17 20:20:30 +02007743#if defined(HAVE_WAITID) && !defined(__APPLE__)
Larry Hastings2f936352014-08-05 14:04:04 +10007744/*[clinic input]
7745os.waitid
7746
7747 idtype: idtype_t
7748 Must be one of be P_PID, P_PGID or P_ALL.
7749 id: id_t
7750 The id to wait on.
7751 options: int
7752 Constructed from the ORing of one or more of WEXITED, WSTOPPED
7753 or WCONTINUED and additionally may be ORed with WNOHANG or WNOWAIT.
7754 /
7755
7756Returns the result of waiting for a process or processes.
7757
7758Returns either waitid_result or None if WNOHANG is specified and there are
7759no children in a waitable state.
7760[clinic start generated code]*/
7761
Larry Hastings2f936352014-08-05 14:04:04 +10007762static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007763os_waitid_impl(PyObject *module, idtype_t idtype, id_t id, int options)
7764/*[clinic end generated code: output=5d2e1c0bde61f4d8 input=d8e7f76e052b7920]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007765{
7766 PyObject *result;
7767 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007768 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02007769 siginfo_t si;
7770 si.si_pid = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10007771
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007772 do {
7773 Py_BEGIN_ALLOW_THREADS
7774 res = waitid(idtype, id, &si, options);
7775 Py_END_ALLOW_THREADS
7776 } while (res < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
7777 if (res < 0)
7778 return (!async_err) ? posix_error() : NULL;
Ross Lagerwall7807c352011-03-17 20:20:30 +02007779
7780 if (si.si_pid == 0)
7781 Py_RETURN_NONE;
7782
Eddie Elizondo474eedf2018-11-13 04:09:31 -08007783 result = PyStructSequence_New(WaitidResultType);
Ross Lagerwall7807c352011-03-17 20:20:30 +02007784 if (!result)
7785 return NULL;
7786
7787 PyStructSequence_SET_ITEM(result, 0, PyLong_FromPid(si.si_pid));
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02007788 PyStructSequence_SET_ITEM(result, 1, _PyLong_FromUid(si.si_uid));
Ross Lagerwall7807c352011-03-17 20:20:30 +02007789 PyStructSequence_SET_ITEM(result, 2, PyLong_FromLong((long)(si.si_signo)));
7790 PyStructSequence_SET_ITEM(result, 3, PyLong_FromLong((long)(si.si_status)));
7791 PyStructSequence_SET_ITEM(result, 4, PyLong_FromLong((long)(si.si_code)));
7792 if (PyErr_Occurred()) {
7793 Py_DECREF(result);
7794 return NULL;
7795 }
7796
7797 return result;
7798}
Larry Hastings2f936352014-08-05 14:04:04 +10007799#endif /* defined(HAVE_WAITID) && !defined(__APPLE__) */
Ross Lagerwall7807c352011-03-17 20:20:30 +02007800
Larry Hastings2f936352014-08-05 14:04:04 +10007801
7802#if defined(HAVE_WAITPID)
7803/*[clinic input]
7804os.waitpid
7805 pid: pid_t
7806 options: int
7807 /
7808
7809Wait for completion of a given child process.
7810
7811Returns a tuple of information regarding the child process:
7812 (pid, status)
7813
7814The options argument is ignored on Windows.
7815[clinic start generated code]*/
7816
Larry Hastings2f936352014-08-05 14:04:04 +10007817static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007818os_waitpid_impl(PyObject *module, pid_t pid, int options)
7819/*[clinic end generated code: output=5c37c06887a20270 input=0bf1666b8758fda3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007820{
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007821 pid_t res;
7822 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00007823 WAIT_TYPE status;
7824 WAIT_STATUS_INT(status) = 0;
Guido van Rossum54ecc3d1999-01-27 17:53:11 +00007825
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007826 do {
7827 Py_BEGIN_ALLOW_THREADS
7828 res = waitpid(pid, &status, options);
7829 Py_END_ALLOW_THREADS
7830 } while (res < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
7831 if (res < 0)
7832 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007833
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007834 return Py_BuildValue("Ni", PyLong_FromPid(res), WAIT_STATUS_INT(status));
Guido van Rossum21803b81992-08-09 12:55:27 +00007835}
Tim Petersab034fa2002-02-01 11:27:43 +00007836#elif defined(HAVE_CWAIT)
Tim Petersab034fa2002-02-01 11:27:43 +00007837/* MS C has a variant of waitpid() that's usable for most purposes. */
Larry Hastings2f936352014-08-05 14:04:04 +10007838/*[clinic input]
7839os.waitpid
Benjamin Petersonca470632016-09-06 13:47:26 -07007840 pid: intptr_t
Larry Hastings2f936352014-08-05 14:04:04 +10007841 options: int
7842 /
7843
7844Wait for completion of a given process.
7845
7846Returns a tuple of information regarding the process:
7847 (pid, status << 8)
7848
7849The options argument is ignored on Windows.
7850[clinic start generated code]*/
7851
Larry Hastings2f936352014-08-05 14:04:04 +10007852static PyObject *
Benjamin Petersonca470632016-09-06 13:47:26 -07007853os_waitpid_impl(PyObject *module, intptr_t pid, int options)
Victor Stinner581139c2016-09-06 15:54:20 -07007854/*[clinic end generated code: output=be836b221271d538 input=40f2440c515410f8]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007855{
7856 int status;
Benjamin Petersonca470632016-09-06 13:47:26 -07007857 intptr_t res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007858 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10007859
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007860 do {
7861 Py_BEGIN_ALLOW_THREADS
Steve Dower11f43262016-11-19 18:33:39 -08007862 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007863 res = _cwait(&status, pid, options);
Steve Dower11f43262016-11-19 18:33:39 -08007864 _Py_END_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007865 Py_END_ALLOW_THREADS
7866 } while (res < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Victor Stinnerd3ffd322015-09-15 10:11:03 +02007867 if (res < 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007868 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007869
Victor Stinnerb0735092020-04-22 17:57:59 +02007870 unsigned long long ustatus = (unsigned int)status;
7871
Victor Stinner8c62be82010-05-06 00:08:46 +00007872 /* shift the status left a byte so this is more like the POSIX waitpid */
Victor Stinnerb0735092020-04-22 17:57:59 +02007873 return Py_BuildValue(_Py_PARSE_INTPTR "K", res, ustatus << 8);
Tim Petersab034fa2002-02-01 11:27:43 +00007874}
Larry Hastings2f936352014-08-05 14:04:04 +10007875#endif
7876
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007877
Guido van Rossumad0ee831995-03-01 10:34:45 +00007878#ifdef HAVE_WAIT
Larry Hastings2f936352014-08-05 14:04:04 +10007879/*[clinic input]
7880os.wait
7881
7882Wait for completion of a child process.
7883
7884Returns a tuple of information about the child process:
7885 (pid, status)
7886[clinic start generated code]*/
7887
Larry Hastings2f936352014-08-05 14:04:04 +10007888static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007889os_wait_impl(PyObject *module)
7890/*[clinic end generated code: output=6bc419ac32fb364b input=03b0182d4a4700ce]*/
Guido van Rossum21803b81992-08-09 12:55:27 +00007891{
Victor Stinner8c62be82010-05-06 00:08:46 +00007892 pid_t pid;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007893 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00007894 WAIT_TYPE status;
7895 WAIT_STATUS_INT(status) = 0;
Neal Norwitze241ce82003-02-17 18:17:05 +00007896
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007897 do {
7898 Py_BEGIN_ALLOW_THREADS
7899 pid = wait(&status);
7900 Py_END_ALLOW_THREADS
7901 } while (pid < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
7902 if (pid < 0)
7903 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007904
Victor Stinner8c62be82010-05-06 00:08:46 +00007905 return Py_BuildValue("Ni", PyLong_FromPid(pid), WAIT_STATUS_INT(status));
Guido van Rossum85e3b011991-06-03 12:42:10 +00007906}
Larry Hastings2f936352014-08-05 14:04:04 +10007907#endif /* HAVE_WAIT */
Guido van Rossum85e3b011991-06-03 12:42:10 +00007908
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007909
Larry Hastings9cf065c2012-06-22 16:30:09 -07007910#if defined(HAVE_READLINK) || defined(MS_WINDOWS)
Serhiy Storchaka12a69db2018-09-17 15:38:27 +03007911/*[clinic input]
7912os.readlink
7913
7914 path: path_t
7915 *
7916 dir_fd: dir_fd(requires='readlinkat') = None
7917
7918Return a string representing the path to which the symbolic link points.
7919
7920If dir_fd is not None, it should be a file descriptor open to a directory,
7921and path should be relative; path will then be relative to that directory.
7922
7923dir_fd may not be implemented on your platform. If it is unavailable,
7924using it will raise a NotImplementedError.
7925[clinic start generated code]*/
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007926
Barry Warsaw53699e91996-12-10 23:23:01 +00007927static PyObject *
Serhiy Storchaka12a69db2018-09-17 15:38:27 +03007928os_readlink_impl(PyObject *module, path_t *path, int dir_fd)
7929/*[clinic end generated code: output=d21b732a2e814030 input=113c87e0db1ecaf2]*/
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00007930{
Berker Peksage0b5b202018-08-15 13:03:41 +03007931#if defined(HAVE_READLINK)
Christian Heimes3cb091e2016-09-23 20:24:28 +02007932 char buffer[MAXPATHLEN+1];
Larry Hastings9cf065c2012-06-22 16:30:09 -07007933 ssize_t length;
Serhiy Storchaka12a69db2018-09-17 15:38:27 +03007934
7935 Py_BEGIN_ALLOW_THREADS
7936#ifdef HAVE_READLINKAT
7937 if (dir_fd != DEFAULT_DIR_FD)
7938 length = readlinkat(dir_fd, path->narrow, buffer, MAXPATHLEN);
7939 else
7940#endif
7941 length = readlink(path->narrow, buffer, MAXPATHLEN);
7942 Py_END_ALLOW_THREADS
7943
7944 if (length < 0) {
7945 return path_error(path);
7946 }
7947 buffer[length] = '\0';
7948
7949 if (PyUnicode_Check(path->object))
7950 return PyUnicode_DecodeFSDefaultAndSize(buffer, length);
7951 else
7952 return PyBytes_FromStringAndSize(buffer, length);
Berker Peksage0b5b202018-08-15 13:03:41 +03007953#elif defined(MS_WINDOWS)
7954 DWORD n_bytes_returned;
Steve Dower9eb3d542019-08-21 15:52:42 -07007955 DWORD io_result = 0;
Berker Peksage0b5b202018-08-15 13:03:41 +03007956 HANDLE reparse_point_handle;
Berker Peksage0b5b202018-08-15 13:03:41 +03007957 char target_buffer[_Py_MAXIMUM_REPARSE_DATA_BUFFER_SIZE];
7958 _Py_REPARSE_DATA_BUFFER *rdb = (_Py_REPARSE_DATA_BUFFER *)target_buffer;
Miss Islington (bot)54dac6c2019-09-03 13:13:41 -07007959 PyObject *result = NULL;
Thomas Wouters89f507f2006-12-13 04:49:30 +00007960
Larry Hastings2f936352014-08-05 14:04:04 +10007961 /* First get a handle to the reparse point */
7962 Py_BEGIN_ALLOW_THREADS
7963 reparse_point_handle = CreateFileW(
Serhiy Storchaka12a69db2018-09-17 15:38:27 +03007964 path->wide,
Larry Hastings2f936352014-08-05 14:04:04 +10007965 0,
7966 0,
7967 0,
7968 OPEN_EXISTING,
7969 FILE_FLAG_OPEN_REPARSE_POINT|FILE_FLAG_BACKUP_SEMANTICS,
7970 0);
Steve Dower9eb3d542019-08-21 15:52:42 -07007971 if (reparse_point_handle != INVALID_HANDLE_VALUE) {
7972 /* New call DeviceIoControl to read the reparse point */
7973 io_result = DeviceIoControl(
7974 reparse_point_handle,
7975 FSCTL_GET_REPARSE_POINT,
7976 0, 0, /* in buffer */
7977 target_buffer, sizeof(target_buffer),
7978 &n_bytes_returned,
7979 0 /* we're not using OVERLAPPED_IO */
7980 );
7981 CloseHandle(reparse_point_handle);
Berker Peksage0b5b202018-08-15 13:03:41 +03007982 }
Larry Hastings2f936352014-08-05 14:04:04 +10007983 Py_END_ALLOW_THREADS
7984
Berker Peksage0b5b202018-08-15 13:03:41 +03007985 if (io_result == 0) {
Serhiy Storchaka12a69db2018-09-17 15:38:27 +03007986 return path_error(path);
Berker Peksage0b5b202018-08-15 13:03:41 +03007987 }
Larry Hastings2f936352014-08-05 14:04:04 +10007988
Steve Dower9eb3d542019-08-21 15:52:42 -07007989 wchar_t *name = NULL;
7990 Py_ssize_t nameLen = 0;
7991 if (rdb->ReparseTag == IO_REPARSE_TAG_SYMLINK)
Larry Hastings2f936352014-08-05 14:04:04 +10007992 {
Steve Dower9eb3d542019-08-21 15:52:42 -07007993 name = (wchar_t *)((char*)rdb->SymbolicLinkReparseBuffer.PathBuffer +
7994 rdb->SymbolicLinkReparseBuffer.SubstituteNameOffset);
7995 nameLen = rdb->SymbolicLinkReparseBuffer.SubstituteNameLength / sizeof(wchar_t);
Larry Hastings2f936352014-08-05 14:04:04 +10007996 }
Steve Dower9eb3d542019-08-21 15:52:42 -07007997 else if (rdb->ReparseTag == IO_REPARSE_TAG_MOUNT_POINT)
7998 {
7999 name = (wchar_t *)((char*)rdb->MountPointReparseBuffer.PathBuffer +
8000 rdb->MountPointReparseBuffer.SubstituteNameOffset);
8001 nameLen = rdb->MountPointReparseBuffer.SubstituteNameLength / sizeof(wchar_t);
8002 }
8003 else
8004 {
8005 PyErr_SetString(PyExc_ValueError, "not a symbolic link");
8006 }
8007 if (name) {
8008 if (nameLen > 4 && wcsncmp(name, L"\\??\\", 4) == 0) {
8009 /* Our buffer is mutable, so this is okay */
8010 name[1] = L'\\';
8011 }
8012 result = PyUnicode_FromWideChar(name, nameLen);
Miss Islington (bot)54dac6c2019-09-03 13:13:41 -07008013 if (result && path->narrow) {
Steve Dower9eb3d542019-08-21 15:52:42 -07008014 Py_SETREF(result, PyUnicode_EncodeFSDefault(result));
8015 }
Berker Peksage0b5b202018-08-15 13:03:41 +03008016 }
Serhiy Storchaka12a69db2018-09-17 15:38:27 +03008017 return result;
Berker Peksage0b5b202018-08-15 13:03:41 +03008018#endif
Larry Hastings2f936352014-08-05 14:04:04 +10008019}
Berker Peksage0b5b202018-08-15 13:03:41 +03008020#endif /* defined(HAVE_READLINK) || defined(MS_WINDOWS) */
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008021
Larry Hastings9cf065c2012-06-22 16:30:09 -07008022#if defined(MS_WINDOWS)
8023
Steve Dower6921e732018-03-05 14:26:08 -08008024/* Remove the last portion of the path - return 0 on success */
8025static int
Victor Stinner31b3b922013-06-05 01:49:17 +02008026_dirnameW(WCHAR *path)
8027{
Jason R. Coombs3a092862013-05-27 23:21:28 -04008028 WCHAR *ptr;
Steve Dower6921e732018-03-05 14:26:08 -08008029 size_t length = wcsnlen_s(path, MAX_PATH);
8030 if (length == MAX_PATH) {
8031 return -1;
8032 }
Jason R. Coombs3a092862013-05-27 23:21:28 -04008033
8034 /* walk the path from the end until a backslash is encountered */
Steve Dower6921e732018-03-05 14:26:08 -08008035 for(ptr = path + length; ptr != path; ptr--) {
8036 if (*ptr == L'\\' || *ptr == L'/') {
Jason R. Coombs3a092862013-05-27 23:21:28 -04008037 break;
Steve Dower6921e732018-03-05 14:26:08 -08008038 }
Jason R. Coombs3a092862013-05-27 23:21:28 -04008039 }
8040 *ptr = 0;
Steve Dower6921e732018-03-05 14:26:08 -08008041 return 0;
Jason R. Coombs3a092862013-05-27 23:21:28 -04008042}
8043
Miss Islington (bot)ddd5bbd2020-05-18 09:36:02 -07008044#endif
8045
8046#ifdef HAVE_SYMLINK
8047
8048#if defined(MS_WINDOWS)
8049
Victor Stinner31b3b922013-06-05 01:49:17 +02008050/* Is this path absolute? */
8051static int
8052_is_absW(const WCHAR *path)
8053{
Steve Dower6921e732018-03-05 14:26:08 -08008054 return path[0] == L'\\' || path[0] == L'/' ||
8055 (path[0] && path[1] == L':');
Jason R. Coombs3a092862013-05-27 23:21:28 -04008056}
8057
Steve Dower6921e732018-03-05 14:26:08 -08008058/* join root and rest with a backslash - return 0 on success */
8059static int
Victor Stinner31b3b922013-06-05 01:49:17 +02008060_joinW(WCHAR *dest_path, const WCHAR *root, const WCHAR *rest)
8061{
Victor Stinner31b3b922013-06-05 01:49:17 +02008062 if (_is_absW(rest)) {
Steve Dower6921e732018-03-05 14:26:08 -08008063 return wcscpy_s(dest_path, MAX_PATH, rest);
Jason R. Coombs3a092862013-05-27 23:21:28 -04008064 }
8065
Steve Dower6921e732018-03-05 14:26:08 -08008066 if (wcscpy_s(dest_path, MAX_PATH, root)) {
8067 return -1;
Jason R. Coombs3a092862013-05-27 23:21:28 -04008068 }
Steve Dower6921e732018-03-05 14:26:08 -08008069
8070 if (dest_path[0] && wcscat_s(dest_path, MAX_PATH, L"\\")) {
8071 return -1;
8072 }
8073
8074 return wcscat_s(dest_path, MAX_PATH, rest);
Jason R. Coombs3a092862013-05-27 23:21:28 -04008075}
8076
Victor Stinner31b3b922013-06-05 01:49:17 +02008077/* Return True if the path at src relative to dest is a directory */
8078static int
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03008079_check_dirW(LPCWSTR src, LPCWSTR dest)
Jason R. Coombs3a092862013-05-27 23:21:28 -04008080{
Jason R. Coombs3a092862013-05-27 23:21:28 -04008081 WIN32_FILE_ATTRIBUTE_DATA src_info;
8082 WCHAR dest_parent[MAX_PATH];
8083 WCHAR src_resolved[MAX_PATH] = L"";
8084
8085 /* dest_parent = os.path.dirname(dest) */
Steve Dower6921e732018-03-05 14:26:08 -08008086 if (wcscpy_s(dest_parent, MAX_PATH, dest) ||
8087 _dirnameW(dest_parent)) {
8088 return 0;
8089 }
Jason R. Coombs3a092862013-05-27 23:21:28 -04008090 /* src_resolved = os.path.join(dest_parent, src) */
Steve Dower6921e732018-03-05 14:26:08 -08008091 if (_joinW(src_resolved, dest_parent, src)) {
8092 return 0;
8093 }
Jason R. Coombs3a092862013-05-27 23:21:28 -04008094 return (
8095 GetFileAttributesExW(src_resolved, GetFileExInfoStandard, &src_info)
8096 && src_info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY
8097 );
8098}
Larry Hastings9cf065c2012-06-22 16:30:09 -07008099#endif
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008100
Larry Hastings2f936352014-08-05 14:04:04 +10008101
8102/*[clinic input]
8103os.symlink
8104 src: path_t
8105 dst: path_t
8106 target_is_directory: bool = False
8107 *
8108 dir_fd: dir_fd(requires='symlinkat')=None
8109
8110# "symlink(src, dst, target_is_directory=False, *, dir_fd=None)\n\n\
8111
8112Create a symbolic link pointing to src named dst.
8113
8114target_is_directory is required on Windows if the target is to be
8115 interpreted as a directory. (On Windows, symlink requires
8116 Windows 6.0 or greater, and raises a NotImplementedError otherwise.)
8117 target_is_directory is ignored on non-Windows platforms.
8118
8119If dir_fd is not None, it should be a file descriptor open to a directory,
8120 and path should be relative; path will then be relative to that directory.
8121dir_fd may not be implemented on your platform.
8122 If it is unavailable, using it will raise a NotImplementedError.
8123
8124[clinic start generated code]*/
8125
Larry Hastings2f936352014-08-05 14:04:04 +10008126static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008127os_symlink_impl(PyObject *module, path_t *src, path_t *dst,
Larry Hastings89964c42015-04-14 18:07:59 -04008128 int target_is_directory, int dir_fd)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008129/*[clinic end generated code: output=08ca9f3f3cf960f6 input=e820ec4472547bc3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008130{
Larry Hastings9cf065c2012-06-22 16:30:09 -07008131#ifdef MS_WINDOWS
8132 DWORD result;
Vidar Tonaas Fauske0e107662019-04-09 20:19:46 +02008133 DWORD flags = 0;
8134
8135 /* Assumed true, set to false if detected to not be available. */
8136 static int windows_has_symlink_unprivileged_flag = TRUE;
Larry Hastings9cf065c2012-06-22 16:30:09 -07008137#else
8138 int result;
8139#endif
8140
Steve Dowera00b5be2020-02-13 08:30:27 +00008141 if (PySys_Audit("os.symlink", "OOi", src->object, dst->object,
8142 dir_fd == DEFAULT_DIR_FD ? -1 : dir_fd) < 0) {
8143 return NULL;
8144 }
8145
Larry Hastings9cf065c2012-06-22 16:30:09 -07008146#ifdef MS_WINDOWS
Larry Hastings9cf065c2012-06-22 16:30:09 -07008147
Vidar Tonaas Fauske0e107662019-04-09 20:19:46 +02008148 if (windows_has_symlink_unprivileged_flag) {
8149 /* Allow non-admin symlinks if system allows it. */
8150 flags |= SYMBOLIC_LINK_FLAG_ALLOW_UNPRIVILEGED_CREATE;
8151 }
Jason R. Coombs3a092862013-05-27 23:21:28 -04008152
Larry Hastings9cf065c2012-06-22 16:30:09 -07008153 Py_BEGIN_ALLOW_THREADS
Steve Dower6921e732018-03-05 14:26:08 -08008154 _Py_BEGIN_SUPPRESS_IPH
Vidar Tonaas Fauske0e107662019-04-09 20:19:46 +02008155 /* if src is a directory, ensure flags==1 (target_is_directory bit) */
8156 if (target_is_directory || _check_dirW(src->wide, dst->wide)) {
8157 flags |= SYMBOLIC_LINK_FLAG_DIRECTORY;
8158 }
8159
8160 result = CreateSymbolicLinkW(dst->wide, src->wide, flags);
Steve Dower6921e732018-03-05 14:26:08 -08008161 _Py_END_SUPPRESS_IPH
Larry Hastings9cf065c2012-06-22 16:30:09 -07008162 Py_END_ALLOW_THREADS
8163
Vidar Tonaas Fauske0e107662019-04-09 20:19:46 +02008164 if (windows_has_symlink_unprivileged_flag && !result &&
8165 ERROR_INVALID_PARAMETER == GetLastError()) {
8166
8167 Py_BEGIN_ALLOW_THREADS
8168 _Py_BEGIN_SUPPRESS_IPH
8169 /* This error might be caused by
8170 SYMBOLIC_LINK_FLAG_ALLOW_UNPRIVILEGED_CREATE not being supported.
8171 Try again, and update windows_has_symlink_unprivileged_flag if we
8172 are successful this time.
8173
8174 NOTE: There is a risk of a race condition here if there are other
8175 conditions than the flag causing ERROR_INVALID_PARAMETER, and
8176 another process (or thread) changes that condition in between our
8177 calls to CreateSymbolicLink.
8178 */
8179 flags &= ~(SYMBOLIC_LINK_FLAG_ALLOW_UNPRIVILEGED_CREATE);
8180 result = CreateSymbolicLinkW(dst->wide, src->wide, flags);
8181 _Py_END_SUPPRESS_IPH
8182 Py_END_ALLOW_THREADS
8183
8184 if (result || ERROR_INVALID_PARAMETER != GetLastError()) {
8185 windows_has_symlink_unprivileged_flag = FALSE;
8186 }
8187 }
8188
Larry Hastings2f936352014-08-05 14:04:04 +10008189 if (!result)
8190 return path_error2(src, dst);
Larry Hastings9cf065c2012-06-22 16:30:09 -07008191
8192#else
8193
Steve Dower6921e732018-03-05 14:26:08 -08008194 if ((src->narrow && dst->wide) || (src->wide && dst->narrow)) {
8195 PyErr_SetString(PyExc_ValueError,
8196 "symlink: src and dst must be the same type");
8197 return NULL;
8198 }
8199
Larry Hastings9cf065c2012-06-22 16:30:09 -07008200 Py_BEGIN_ALLOW_THREADS
8201#if HAVE_SYMLINKAT
8202 if (dir_fd != DEFAULT_DIR_FD)
Larry Hastings2f936352014-08-05 14:04:04 +10008203 result = symlinkat(src->narrow, dir_fd, dst->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07008204 else
8205#endif
Larry Hastings2f936352014-08-05 14:04:04 +10008206 result = symlink(src->narrow, dst->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07008207 Py_END_ALLOW_THREADS
8208
Larry Hastings2f936352014-08-05 14:04:04 +10008209 if (result)
8210 return path_error2(src, dst);
Larry Hastings9cf065c2012-06-22 16:30:09 -07008211#endif
8212
Larry Hastings2f936352014-08-05 14:04:04 +10008213 Py_RETURN_NONE;
Guido van Rossumbfaf3d61997-12-29 20:02:27 +00008214}
8215#endif /* HAVE_SYMLINK */
8216
Larry Hastings9cf065c2012-06-22 16:30:09 -07008217
Brian Curtind40e6f72010-07-08 21:39:08 +00008218
Guido van Rossumbfaf3d61997-12-29 20:02:27 +00008219
Larry Hastings605a62d2012-06-24 04:33:36 -07008220static PyStructSequence_Field times_result_fields[] = {
8221 {"user", "user time"},
8222 {"system", "system time"},
8223 {"children_user", "user time of children"},
8224 {"children_system", "system time of children"},
8225 {"elapsed", "elapsed time since an arbitrary point in the past"},
8226 {NULL}
8227};
8228
8229PyDoc_STRVAR(times_result__doc__,
8230"times_result: Result from os.times().\n\n\
8231This object may be accessed either as a tuple of\n\
8232 (user, system, children_user, children_system, elapsed),\n\
8233or via the attributes user, system, children_user, children_system,\n\
8234and elapsed.\n\
8235\n\
8236See os.times for more information.");
8237
8238static PyStructSequence_Desc times_result_desc = {
8239 "times_result", /* name */
8240 times_result__doc__, /* doc */
8241 times_result_fields,
8242 5
8243};
8244
Eddie Elizondo474eedf2018-11-13 04:09:31 -08008245static PyTypeObject* TimesResultType;
Larry Hastings605a62d2012-06-24 04:33:36 -07008246
Antoine Pitrouf3923e92012-07-24 21:23:53 +02008247#ifdef MS_WINDOWS
8248#define HAVE_TIMES /* mandatory, for the method table */
8249#endif
Larry Hastings605a62d2012-06-24 04:33:36 -07008250
Antoine Pitrouf3923e92012-07-24 21:23:53 +02008251#ifdef HAVE_TIMES
Larry Hastings605a62d2012-06-24 04:33:36 -07008252
8253static PyObject *
8254build_times_result(double user, double system,
8255 double children_user, double children_system,
8256 double elapsed)
8257{
Eddie Elizondo474eedf2018-11-13 04:09:31 -08008258 PyObject *value = PyStructSequence_New(TimesResultType);
Larry Hastings605a62d2012-06-24 04:33:36 -07008259 if (value == NULL)
8260 return NULL;
8261
8262#define SET(i, field) \
8263 { \
8264 PyObject *o = PyFloat_FromDouble(field); \
8265 if (!o) { \
8266 Py_DECREF(value); \
8267 return NULL; \
8268 } \
8269 PyStructSequence_SET_ITEM(value, i, o); \
8270 } \
8271
8272 SET(0, user);
8273 SET(1, system);
8274 SET(2, children_user);
8275 SET(3, children_system);
8276 SET(4, elapsed);
8277
8278#undef SET
8279
8280 return value;
8281}
8282
Larry Hastings605a62d2012-06-24 04:33:36 -07008283
Larry Hastings2f936352014-08-05 14:04:04 +10008284#ifndef MS_WINDOWS
8285#define NEED_TICKS_PER_SECOND
8286static long ticks_per_second = -1;
8287#endif /* MS_WINDOWS */
8288
8289/*[clinic input]
8290os.times
8291
8292Return a collection containing process timing information.
8293
8294The object returned behaves like a named tuple with these fields:
8295 (utime, stime, cutime, cstime, elapsed_time)
8296All fields are floating point numbers.
8297[clinic start generated code]*/
8298
Larry Hastings2f936352014-08-05 14:04:04 +10008299static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008300os_times_impl(PyObject *module)
8301/*[clinic end generated code: output=35f640503557d32a input=2bf9df3d6ab2e48b]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008302#ifdef MS_WINDOWS
Guido van Rossum14ed0b21994-09-29 09:50:09 +00008303{
Victor Stinner8c62be82010-05-06 00:08:46 +00008304 FILETIME create, exit, kernel, user;
8305 HANDLE hProc;
8306 hProc = GetCurrentProcess();
8307 GetProcessTimes(hProc, &create, &exit, &kernel, &user);
8308 /* The fields of a FILETIME structure are the hi and lo part
8309 of a 64-bit value expressed in 100 nanosecond units.
8310 1e7 is one second in such units; 1e-7 the inverse.
8311 429.4967296 is 2**32 / 1e7 or 2**32 * 1e-7.
8312 */
Larry Hastings605a62d2012-06-24 04:33:36 -07008313 return build_times_result(
Victor Stinner8c62be82010-05-06 00:08:46 +00008314 (double)(user.dwHighDateTime*429.4967296 +
8315 user.dwLowDateTime*1e-7),
8316 (double)(kernel.dwHighDateTime*429.4967296 +
8317 kernel.dwLowDateTime*1e-7),
8318 (double)0,
8319 (double)0,
8320 (double)0);
Guido van Rossum14ed0b21994-09-29 09:50:09 +00008321}
Larry Hastings2f936352014-08-05 14:04:04 +10008322#else /* MS_WINDOWS */
Antoine Pitrouf3923e92012-07-24 21:23:53 +02008323{
Larry Hastings2f936352014-08-05 14:04:04 +10008324
8325
Antoine Pitrouf3923e92012-07-24 21:23:53 +02008326 struct tms t;
8327 clock_t c;
8328 errno = 0;
8329 c = times(&t);
8330 if (c == (clock_t) -1)
8331 return posix_error();
8332 return build_times_result(
8333 (double)t.tms_utime / ticks_per_second,
8334 (double)t.tms_stime / ticks_per_second,
8335 (double)t.tms_cutime / ticks_per_second,
8336 (double)t.tms_cstime / ticks_per_second,
8337 (double)c / ticks_per_second);
8338}
Larry Hastings2f936352014-08-05 14:04:04 +10008339#endif /* MS_WINDOWS */
Antoine Pitrouf3923e92012-07-24 21:23:53 +02008340#endif /* HAVE_TIMES */
8341
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008342
Martin v. Löwis49ee14d2003-11-10 06:35:36 +00008343#ifdef HAVE_GETSID
Larry Hastings2f936352014-08-05 14:04:04 +10008344/*[clinic input]
8345os.getsid
8346
8347 pid: pid_t
8348 /
8349
8350Call the system call getsid(pid) and return the result.
8351[clinic start generated code]*/
8352
Larry Hastings2f936352014-08-05 14:04:04 +10008353static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008354os_getsid_impl(PyObject *module, pid_t pid)
8355/*[clinic end generated code: output=112deae56b306460 input=eeb2b923a30ce04e]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008356{
Victor Stinner8c62be82010-05-06 00:08:46 +00008357 int sid;
Victor Stinner8c62be82010-05-06 00:08:46 +00008358 sid = getsid(pid);
8359 if (sid < 0)
8360 return posix_error();
8361 return PyLong_FromLong((long)sid);
Martin v. Löwis49ee14d2003-11-10 06:35:36 +00008362}
8363#endif /* HAVE_GETSID */
8364
8365
Guido van Rossumb6775db1994-08-01 11:34:53 +00008366#ifdef HAVE_SETSID
Larry Hastings2f936352014-08-05 14:04:04 +10008367/*[clinic input]
8368os.setsid
8369
8370Call the system call setsid().
8371[clinic start generated code]*/
8372
Larry Hastings2f936352014-08-05 14:04:04 +10008373static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008374os_setsid_impl(PyObject *module)
8375/*[clinic end generated code: output=e2ddedd517086d77 input=5fff45858e2f0776]*/
Guido van Rossumc2670a01992-09-13 20:07:29 +00008376{
Victor Stinner8c62be82010-05-06 00:08:46 +00008377 if (setsid() < 0)
8378 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10008379 Py_RETURN_NONE;
Guido van Rossumc2670a01992-09-13 20:07:29 +00008380}
Guido van Rossumb6775db1994-08-01 11:34:53 +00008381#endif /* HAVE_SETSID */
Guido van Rossumc2670a01992-09-13 20:07:29 +00008382
Larry Hastings2f936352014-08-05 14:04:04 +10008383
Guido van Rossumb6775db1994-08-01 11:34:53 +00008384#ifdef HAVE_SETPGID
Larry Hastings2f936352014-08-05 14:04:04 +10008385/*[clinic input]
8386os.setpgid
8387
8388 pid: pid_t
8389 pgrp: pid_t
8390 /
8391
8392Call the system call setpgid(pid, pgrp).
8393[clinic start generated code]*/
8394
Larry Hastings2f936352014-08-05 14:04:04 +10008395static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008396os_setpgid_impl(PyObject *module, pid_t pid, pid_t pgrp)
8397/*[clinic end generated code: output=6461160319a43d6a input=fceb395eca572e1a]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008398{
Victor Stinner8c62be82010-05-06 00:08:46 +00008399 if (setpgid(pid, pgrp) < 0)
8400 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10008401 Py_RETURN_NONE;
Guido van Rossumc2670a01992-09-13 20:07:29 +00008402}
Guido van Rossumb6775db1994-08-01 11:34:53 +00008403#endif /* HAVE_SETPGID */
Guido van Rossumc2670a01992-09-13 20:07:29 +00008404
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008405
Guido van Rossumb6775db1994-08-01 11:34:53 +00008406#ifdef HAVE_TCGETPGRP
Larry Hastings2f936352014-08-05 14:04:04 +10008407/*[clinic input]
8408os.tcgetpgrp
8409
8410 fd: int
8411 /
8412
8413Return the process group associated with the terminal specified by fd.
8414[clinic start generated code]*/
8415
Larry Hastings2f936352014-08-05 14:04:04 +10008416static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008417os_tcgetpgrp_impl(PyObject *module, int fd)
8418/*[clinic end generated code: output=f865e88be86c272b input=7f6c18eac10ada86]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008419{
8420 pid_t pgid = tcgetpgrp(fd);
Victor Stinner8c62be82010-05-06 00:08:46 +00008421 if (pgid < 0)
8422 return posix_error();
8423 return PyLong_FromPid(pgid);
Guido van Rossum7066dd71992-09-17 17:54:56 +00008424}
Guido van Rossumb6775db1994-08-01 11:34:53 +00008425#endif /* HAVE_TCGETPGRP */
Guido van Rossum7066dd71992-09-17 17:54:56 +00008426
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008427
Guido van Rossumb6775db1994-08-01 11:34:53 +00008428#ifdef HAVE_TCSETPGRP
Larry Hastings2f936352014-08-05 14:04:04 +10008429/*[clinic input]
8430os.tcsetpgrp
8431
8432 fd: int
8433 pgid: pid_t
8434 /
8435
8436Set the process group associated with the terminal specified by fd.
8437[clinic start generated code]*/
8438
Larry Hastings2f936352014-08-05 14:04:04 +10008439static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008440os_tcsetpgrp_impl(PyObject *module, int fd, pid_t pgid)
8441/*[clinic end generated code: output=f1821a381b9daa39 input=5bdc997c6a619020]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008442{
Victor Stinner8c62be82010-05-06 00:08:46 +00008443 if (tcsetpgrp(fd, pgid) < 0)
8444 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10008445 Py_RETURN_NONE;
Guido van Rossum7066dd71992-09-17 17:54:56 +00008446}
Guido van Rossumb6775db1994-08-01 11:34:53 +00008447#endif /* HAVE_TCSETPGRP */
Guido van Rossum22db57e1992-04-05 14:25:30 +00008448
Guido van Rossum687dd131993-05-17 08:34:16 +00008449/* Functions acting on file descriptors */
8450
Victor Stinnerdaf45552013-08-28 00:53:59 +02008451#ifdef O_CLOEXEC
8452extern int _Py_open_cloexec_works;
8453#endif
8454
Larry Hastings2f936352014-08-05 14:04:04 +10008455
8456/*[clinic input]
8457os.open -> int
8458 path: path_t
8459 flags: int
8460 mode: int = 0o777
8461 *
8462 dir_fd: dir_fd(requires='openat') = None
8463
8464# "open(path, flags, mode=0o777, *, dir_fd=None)\n\n\
8465
8466Open a file for low level IO. Returns a file descriptor (integer).
8467
8468If dir_fd is not None, it should be a file descriptor open to a directory,
8469 and path should be relative; path will then be relative to that directory.
8470dir_fd may not be implemented on your platform.
8471 If it is unavailable, using it will raise a NotImplementedError.
8472[clinic start generated code]*/
8473
Larry Hastings2f936352014-08-05 14:04:04 +10008474static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008475os_open_impl(PyObject *module, path_t *path, int flags, int mode, int dir_fd)
8476/*[clinic end generated code: output=abc7227888c8bc73 input=ad8623b29acd2934]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008477{
8478 int fd;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008479 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10008480
Victor Stinnerdaf45552013-08-28 00:53:59 +02008481#ifdef O_CLOEXEC
8482 int *atomic_flag_works = &_Py_open_cloexec_works;
8483#elif !defined(MS_WINDOWS)
8484 int *atomic_flag_works = NULL;
8485#endif
Mark Hammondc2e85bd2002-10-03 05:10:39 +00008486
Victor Stinnerdaf45552013-08-28 00:53:59 +02008487#ifdef MS_WINDOWS
8488 flags |= O_NOINHERIT;
8489#elif defined(O_CLOEXEC)
8490 flags |= O_CLOEXEC;
8491#endif
8492
Steve Dowerb82e17e2019-05-23 08:45:22 -07008493 if (PySys_Audit("open", "OOi", path->object, Py_None, flags) < 0) {
8494 return -1;
8495 }
8496
Steve Dower8fc89802015-04-12 00:26:27 -04008497 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008498 do {
8499 Py_BEGIN_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07008500#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07008501 fd = _wopen(path->wide, flags, mode);
Steve Dower6230aaf2016-09-09 09:03:15 -07008502#else
Larry Hastings9cf065c2012-06-22 16:30:09 -07008503#ifdef HAVE_OPENAT
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008504 if (dir_fd != DEFAULT_DIR_FD)
8505 fd = openat(dir_fd, path->narrow, flags, mode);
8506 else
Steve Dower6230aaf2016-09-09 09:03:15 -07008507#endif /* HAVE_OPENAT */
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008508 fd = open(path->narrow, flags, mode);
Steve Dower6230aaf2016-09-09 09:03:15 -07008509#endif /* !MS_WINDOWS */
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008510 Py_END_ALLOW_THREADS
8511 } while (fd < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Steve Dower8fc89802015-04-12 00:26:27 -04008512 _Py_END_SUPPRESS_IPH
Guido van Rossum687dd131993-05-17 08:34:16 +00008513
Victor Stinnerd3ffd322015-09-15 10:11:03 +02008514 if (fd < 0) {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008515 if (!async_err)
8516 PyErr_SetFromErrnoWithFilenameObject(PyExc_OSError, path->object);
Larry Hastings2f936352014-08-05 14:04:04 +10008517 return -1;
Larry Hastings9cf065c2012-06-22 16:30:09 -07008518 }
8519
Victor Stinnerdaf45552013-08-28 00:53:59 +02008520#ifndef MS_WINDOWS
8521 if (_Py_set_inheritable(fd, 0, atomic_flag_works) < 0) {
8522 close(fd);
Larry Hastings2f936352014-08-05 14:04:04 +10008523 return -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008524 }
8525#endif
8526
Larry Hastings2f936352014-08-05 14:04:04 +10008527 return fd;
8528}
8529
8530
8531/*[clinic input]
8532os.close
8533
8534 fd: int
8535
8536Close a file descriptor.
8537[clinic start generated code]*/
8538
Barry Warsaw53699e91996-12-10 23:23:01 +00008539static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008540os_close_impl(PyObject *module, int fd)
8541/*[clinic end generated code: output=2fe4e93602822c14 input=2bc42451ca5c3223]*/
Guido van Rossum687dd131993-05-17 08:34:16 +00008542{
Larry Hastings2f936352014-08-05 14:04:04 +10008543 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008544 /* We do not want to retry upon EINTR: see http://lwn.net/Articles/576478/
8545 * and http://linux.derkeiler.com/Mailing-Lists/Kernel/2005-09/3000.html
8546 * for more details.
8547 */
Victor Stinner8c62be82010-05-06 00:08:46 +00008548 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04008549 _Py_BEGIN_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00008550 res = close(fd);
Steve Dower8fc89802015-04-12 00:26:27 -04008551 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00008552 Py_END_ALLOW_THREADS
8553 if (res < 0)
8554 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10008555 Py_RETURN_NONE;
Guido van Rossum687dd131993-05-17 08:34:16 +00008556}
8557
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008558
Miss Islington (bot)84eb42e2019-09-12 04:19:21 -07008559#ifdef HAVE_FDWALK
8560static int
8561_fdwalk_close_func(void *lohi, int fd)
8562{
8563 int lo = ((int *)lohi)[0];
8564 int hi = ((int *)lohi)[1];
8565
8566 if (fd >= hi)
8567 return 1;
8568 else if (fd >= lo)
8569 close(fd);
8570 return 0;
8571}
8572#endif /* HAVE_FDWALK */
8573
Larry Hastings2f936352014-08-05 14:04:04 +10008574/*[clinic input]
8575os.closerange
8576
8577 fd_low: int
8578 fd_high: int
8579 /
8580
8581Closes all file descriptors in [fd_low, fd_high), ignoring errors.
8582[clinic start generated code]*/
8583
Larry Hastings2f936352014-08-05 14:04:04 +10008584static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008585os_closerange_impl(PyObject *module, int fd_low, int fd_high)
8586/*[clinic end generated code: output=0ce5c20fcda681c2 input=5855a3d053ebd4ec]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008587{
Miss Islington (bot)84eb42e2019-09-12 04:19:21 -07008588#ifdef HAVE_FDWALK
8589 int lohi[2];
8590#else
Larry Hastings2f936352014-08-05 14:04:04 +10008591 int i;
Miss Islington (bot)84eb42e2019-09-12 04:19:21 -07008592#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00008593 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04008594 _Py_BEGIN_SUPPRESS_IPH
Miss Islington (bot)84eb42e2019-09-12 04:19:21 -07008595#ifdef HAVE_FDWALK
8596 lohi[0] = Py_MAX(fd_low, 0);
8597 lohi[1] = fd_high;
8598 fdwalk(_fdwalk_close_func, lohi);
8599#else
Benjamin Peterson207116b2016-09-08 11:28:06 -07008600 for (i = Py_MAX(fd_low, 0); i < fd_high; i++)
Steve Dower940f33a2016-09-08 11:21:54 -07008601 close(i);
Miss Islington (bot)84eb42e2019-09-12 04:19:21 -07008602#endif
Steve Dower8fc89802015-04-12 00:26:27 -04008603 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00008604 Py_END_ALLOW_THREADS
8605 Py_RETURN_NONE;
Christian Heimesfdab48e2008-01-20 09:06:41 +00008606}
8607
8608
Larry Hastings2f936352014-08-05 14:04:04 +10008609/*[clinic input]
8610os.dup -> int
8611
8612 fd: int
8613 /
8614
8615Return a duplicate of a file descriptor.
8616[clinic start generated code]*/
8617
Larry Hastings2f936352014-08-05 14:04:04 +10008618static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008619os_dup_impl(PyObject *module, int fd)
8620/*[clinic end generated code: output=486f4860636b2a9f input=6f10f7ea97f7852a]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008621{
8622 return _Py_dup(fd);
Guido van Rossum687dd131993-05-17 08:34:16 +00008623}
8624
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008625
Larry Hastings2f936352014-08-05 14:04:04 +10008626/*[clinic input]
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008627os.dup2 -> int
Larry Hastings2f936352014-08-05 14:04:04 +10008628 fd: int
8629 fd2: int
8630 inheritable: bool=True
8631
8632Duplicate file descriptor.
8633[clinic start generated code]*/
8634
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008635static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008636os_dup2_impl(PyObject *module, int fd, int fd2, int inheritable)
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008637/*[clinic end generated code: output=bc059d34a73404d1 input=c3cddda8922b038d]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008638{
Stéphane Wirtel3d86e482018-01-30 07:04:36 +01008639 int res = 0;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008640#if defined(HAVE_DUP3) && \
8641 !(defined(HAVE_FCNTL_H) && defined(F_DUP2FD_CLOEXEC))
8642 /* dup3() is available on Linux 2.6.27+ and glibc 2.9 */
Alexey Izbyshevb3caf382018-02-20 10:25:46 +03008643 static int dup3_works = -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008644#endif
8645
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008646 if (fd < 0 || fd2 < 0) {
8647 posix_error();
8648 return -1;
8649 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02008650
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008651 /* dup2() can fail with EINTR if the target FD is already open, because it
8652 * then has to be closed. See os_close_impl() for why we don't handle EINTR
8653 * upon close(), and therefore below.
8654 */
Victor Stinnerdaf45552013-08-28 00:53:59 +02008655#ifdef MS_WINDOWS
8656 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04008657 _Py_BEGIN_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00008658 res = dup2(fd, fd2);
Steve Dower8fc89802015-04-12 00:26:27 -04008659 _Py_END_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02008660 Py_END_ALLOW_THREADS
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008661 if (res < 0) {
8662 posix_error();
8663 return -1;
8664 }
8665 res = fd2; // msvcrt dup2 returns 0 on success.
Victor Stinnerdaf45552013-08-28 00:53:59 +02008666
8667 /* Character files like console cannot be make non-inheritable */
8668 if (!inheritable && _Py_set_inheritable(fd2, 0, NULL) < 0) {
8669 close(fd2);
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008670 return -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008671 }
8672
8673#elif defined(HAVE_FCNTL_H) && defined(F_DUP2FD_CLOEXEC)
8674 Py_BEGIN_ALLOW_THREADS
8675 if (!inheritable)
8676 res = fcntl(fd, F_DUP2FD_CLOEXEC, fd2);
8677 else
8678 res = dup2(fd, fd2);
8679 Py_END_ALLOW_THREADS
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008680 if (res < 0) {
8681 posix_error();
8682 return -1;
8683 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02008684
8685#else
8686
8687#ifdef HAVE_DUP3
8688 if (!inheritable && dup3_works != 0) {
8689 Py_BEGIN_ALLOW_THREADS
8690 res = dup3(fd, fd2, O_CLOEXEC);
8691 Py_END_ALLOW_THREADS
8692 if (res < 0) {
8693 if (dup3_works == -1)
8694 dup3_works = (errno != ENOSYS);
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008695 if (dup3_works) {
8696 posix_error();
8697 return -1;
8698 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02008699 }
8700 }
8701
8702 if (inheritable || dup3_works == 0)
8703 {
8704#endif
8705 Py_BEGIN_ALLOW_THREADS
8706 res = dup2(fd, fd2);
8707 Py_END_ALLOW_THREADS
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008708 if (res < 0) {
8709 posix_error();
8710 return -1;
8711 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02008712
8713 if (!inheritable && _Py_set_inheritable(fd2, 0, NULL) < 0) {
8714 close(fd2);
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008715 return -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008716 }
8717#ifdef HAVE_DUP3
8718 }
8719#endif
8720
8721#endif
8722
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008723 return res;
Guido van Rossum687dd131993-05-17 08:34:16 +00008724}
8725
Larry Hastings2f936352014-08-05 14:04:04 +10008726
Ross Lagerwall7807c352011-03-17 20:20:30 +02008727#ifdef HAVE_LOCKF
Larry Hastings2f936352014-08-05 14:04:04 +10008728/*[clinic input]
8729os.lockf
8730
8731 fd: int
8732 An open file descriptor.
8733 command: int
8734 One of F_LOCK, F_TLOCK, F_ULOCK or F_TEST.
8735 length: Py_off_t
8736 The number of bytes to lock, starting at the current position.
8737 /
8738
8739Apply, test or remove a POSIX lock on an open file descriptor.
8740
8741[clinic start generated code]*/
8742
Larry Hastings2f936352014-08-05 14:04:04 +10008743static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008744os_lockf_impl(PyObject *module, int fd, int command, Py_off_t length)
8745/*[clinic end generated code: output=af7051f3e7c29651 input=65da41d2106e9b79]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008746{
8747 int res;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008748
Steve Dowera00b5be2020-02-13 08:30:27 +00008749 if (PySys_Audit("os.lockf", "iiL", fd, command, length) < 0) {
8750 return NULL;
8751 }
8752
Ross Lagerwall7807c352011-03-17 20:20:30 +02008753 Py_BEGIN_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10008754 res = lockf(fd, command, length);
Ross Lagerwall7807c352011-03-17 20:20:30 +02008755 Py_END_ALLOW_THREADS
8756
8757 if (res < 0)
8758 return posix_error();
8759
8760 Py_RETURN_NONE;
8761}
Larry Hastings2f936352014-08-05 14:04:04 +10008762#endif /* HAVE_LOCKF */
Ross Lagerwall7807c352011-03-17 20:20:30 +02008763
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008764
Larry Hastings2f936352014-08-05 14:04:04 +10008765/*[clinic input]
8766os.lseek -> Py_off_t
8767
8768 fd: int
8769 position: Py_off_t
8770 how: int
8771 /
8772
8773Set the position of a file descriptor. Return the new position.
8774
8775Return the new cursor position in number of bytes
8776relative to the beginning of the file.
8777[clinic start generated code]*/
8778
Larry Hastings2f936352014-08-05 14:04:04 +10008779static Py_off_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008780os_lseek_impl(PyObject *module, int fd, Py_off_t position, int how)
8781/*[clinic end generated code: output=971e1efb6b30bd2f input=902654ad3f96a6d3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008782{
8783 Py_off_t result;
8784
Guido van Rossum687dd131993-05-17 08:34:16 +00008785#ifdef SEEK_SET
Victor Stinner8c62be82010-05-06 00:08:46 +00008786 /* Turn 0, 1, 2 into SEEK_{SET,CUR,END} */
8787 switch (how) {
Larry Hastings2f936352014-08-05 14:04:04 +10008788 case 0: how = SEEK_SET; break;
8789 case 1: how = SEEK_CUR; break;
8790 case 2: how = SEEK_END; break;
Victor Stinner8c62be82010-05-06 00:08:46 +00008791 }
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00008792#endif /* SEEK_END */
Guido van Rossum94f6f721999-01-06 18:42:14 +00008793
Victor Stinner8c62be82010-05-06 00:08:46 +00008794 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04008795 _Py_BEGIN_SUPPRESS_IPH
Victor Stinner14b9b112013-06-25 00:37:25 +02008796#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10008797 result = _lseeki64(fd, position, how);
Fred Drake699f3522000-06-29 21:12:41 +00008798#else
Larry Hastings2f936352014-08-05 14:04:04 +10008799 result = lseek(fd, position, how);
Fred Drake699f3522000-06-29 21:12:41 +00008800#endif
Steve Dower8fc89802015-04-12 00:26:27 -04008801 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00008802 Py_END_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10008803 if (result < 0)
8804 posix_error();
Guido van Rossum94f6f721999-01-06 18:42:14 +00008805
Larry Hastings2f936352014-08-05 14:04:04 +10008806 return result;
Guido van Rossum687dd131993-05-17 08:34:16 +00008807}
8808
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008809
Larry Hastings2f936352014-08-05 14:04:04 +10008810/*[clinic input]
8811os.read
8812 fd: int
8813 length: Py_ssize_t
8814 /
8815
8816Read from a file descriptor. Returns a bytes object.
8817[clinic start generated code]*/
8818
Larry Hastings2f936352014-08-05 14:04:04 +10008819static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008820os_read_impl(PyObject *module, int fd, Py_ssize_t length)
8821/*[clinic end generated code: output=dafbe9a5cddb987b input=1df2eaa27c0bf1d3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008822{
Victor Stinner8c62be82010-05-06 00:08:46 +00008823 Py_ssize_t n;
8824 PyObject *buffer;
Larry Hastings2f936352014-08-05 14:04:04 +10008825
8826 if (length < 0) {
Victor Stinner8c62be82010-05-06 00:08:46 +00008827 errno = EINVAL;
8828 return posix_error();
8829 }
Larry Hastings2f936352014-08-05 14:04:04 +10008830
Victor Stinner9a0d7a72018-11-22 15:03:40 +01008831 length = Py_MIN(length, _PY_READ_MAX);
Larry Hastings2f936352014-08-05 14:04:04 +10008832
8833 buffer = PyBytes_FromStringAndSize((char *)NULL, length);
Victor Stinner8c62be82010-05-06 00:08:46 +00008834 if (buffer == NULL)
8835 return NULL;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008836
Victor Stinner66aab0c2015-03-19 22:53:20 +01008837 n = _Py_read(fd, PyBytes_AS_STRING(buffer), length);
8838 if (n == -1) {
Victor Stinner8c62be82010-05-06 00:08:46 +00008839 Py_DECREF(buffer);
Victor Stinner66aab0c2015-03-19 22:53:20 +01008840 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00008841 }
Larry Hastings2f936352014-08-05 14:04:04 +10008842
8843 if (n != length)
Victor Stinner8c62be82010-05-06 00:08:46 +00008844 _PyBytes_Resize(&buffer, n);
Larry Hastings2f936352014-08-05 14:04:04 +10008845
Victor Stinner8c62be82010-05-06 00:08:46 +00008846 return buffer;
Guido van Rossum687dd131993-05-17 08:34:16 +00008847}
8848
Ross Lagerwall7807c352011-03-17 20:20:30 +02008849#if (defined(HAVE_SENDFILE) && (defined(__FreeBSD__) || defined(__DragonFly__) \
Serhiy Storchaka9d572732018-07-31 10:24:54 +03008850 || defined(__APPLE__))) \
8851 || defined(HAVE_READV) || defined(HAVE_PREADV) || defined (HAVE_PREADV2) \
8852 || defined(HAVE_WRITEV) || defined(HAVE_PWRITEV) || defined (HAVE_PWRITEV2)
8853static int
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008854iov_setup(struct iovec **iov, Py_buffer **buf, PyObject *seq, Py_ssize_t cnt, int type)
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008855{
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008856 Py_ssize_t i, j;
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00008857
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008858 *iov = PyMem_New(struct iovec, cnt);
8859 if (*iov == NULL) {
8860 PyErr_NoMemory();
Victor Stinner57ddf782014-01-08 15:21:28 +01008861 return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008862 }
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00008863
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008864 *buf = PyMem_New(Py_buffer, cnt);
8865 if (*buf == NULL) {
8866 PyMem_Del(*iov);
8867 PyErr_NoMemory();
Victor Stinner57ddf782014-01-08 15:21:28 +01008868 return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008869 }
8870
8871 for (i = 0; i < cnt; i++) {
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02008872 PyObject *item = PySequence_GetItem(seq, i);
8873 if (item == NULL)
8874 goto fail;
8875 if (PyObject_GetBuffer(item, &(*buf)[i], type) == -1) {
8876 Py_DECREF(item);
8877 goto fail;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008878 }
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02008879 Py_DECREF(item);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008880 (*iov)[i].iov_base = (*buf)[i].buf;
Serhiy Storchaka9d572732018-07-31 10:24:54 +03008881 (*iov)[i].iov_len = (*buf)[i].len;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008882 }
Serhiy Storchaka9d572732018-07-31 10:24:54 +03008883 return 0;
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02008884
8885fail:
8886 PyMem_Del(*iov);
8887 for (j = 0; j < i; j++) {
8888 PyBuffer_Release(&(*buf)[j]);
8889 }
8890 PyMem_Del(*buf);
Victor Stinner57ddf782014-01-08 15:21:28 +01008891 return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008892}
8893
8894static void
8895iov_cleanup(struct iovec *iov, Py_buffer *buf, int cnt)
8896{
8897 int i;
8898 PyMem_Del(iov);
8899 for (i = 0; i < cnt; i++) {
8900 PyBuffer_Release(&buf[i]);
8901 }
8902 PyMem_Del(buf);
8903}
8904#endif
8905
Larry Hastings2f936352014-08-05 14:04:04 +10008906
Ross Lagerwall7807c352011-03-17 20:20:30 +02008907#ifdef HAVE_READV
Larry Hastings2f936352014-08-05 14:04:04 +10008908/*[clinic input]
8909os.readv -> Py_ssize_t
8910
8911 fd: int
8912 buffers: object
8913 /
8914
8915Read from a file descriptor fd into an iterable of buffers.
8916
8917The buffers should be mutable buffers accepting bytes.
8918readv will transfer data into each buffer until it is full
8919and then move on to the next buffer in the sequence to hold
8920the rest of the data.
8921
8922readv returns the total number of bytes read,
8923which may be less than the total capacity of all the buffers.
8924[clinic start generated code]*/
8925
Larry Hastings2f936352014-08-05 14:04:04 +10008926static Py_ssize_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008927os_readv_impl(PyObject *module, int fd, PyObject *buffers)
8928/*[clinic end generated code: output=792da062d3fcebdb input=e679eb5dbfa0357d]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008929{
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008930 Py_ssize_t cnt, n;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008931 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008932 struct iovec *iov;
8933 Py_buffer *buf;
8934
Larry Hastings2f936352014-08-05 14:04:04 +10008935 if (!PySequence_Check(buffers)) {
Ross Lagerwall7807c352011-03-17 20:20:30 +02008936 PyErr_SetString(PyExc_TypeError,
8937 "readv() arg 2 must be a sequence");
Larry Hastings2f936352014-08-05 14:04:04 +10008938 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008939 }
Ross Lagerwall7807c352011-03-17 20:20:30 +02008940
Larry Hastings2f936352014-08-05 14:04:04 +10008941 cnt = PySequence_Size(buffers);
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008942 if (cnt < 0)
8943 return -1;
Larry Hastings2f936352014-08-05 14:04:04 +10008944
8945 if (iov_setup(&iov, &buf, buffers, cnt, PyBUF_WRITABLE) < 0)
8946 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008947
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008948 do {
8949 Py_BEGIN_ALLOW_THREADS
8950 n = readv(fd, iov, cnt);
8951 Py_END_ALLOW_THREADS
8952 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Ross Lagerwall7807c352011-03-17 20:20:30 +02008953
8954 iov_cleanup(iov, buf, cnt);
Larry Hastings2f936352014-08-05 14:04:04 +10008955 if (n < 0) {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008956 if (!async_err)
8957 posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10008958 return -1;
8959 }
Victor Stinner57ddf782014-01-08 15:21:28 +01008960
Larry Hastings2f936352014-08-05 14:04:04 +10008961 return n;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008962}
Larry Hastings2f936352014-08-05 14:04:04 +10008963#endif /* HAVE_READV */
8964
Ross Lagerwall7807c352011-03-17 20:20:30 +02008965
8966#ifdef HAVE_PREAD
Larry Hastings2f936352014-08-05 14:04:04 +10008967/*[clinic input]
8968# TODO length should be size_t! but Python doesn't support parsing size_t yet.
8969os.pread
8970
8971 fd: int
8972 length: int
8973 offset: Py_off_t
8974 /
8975
8976Read a number of bytes from a file descriptor starting at a particular offset.
8977
8978Read length bytes from file descriptor fd, starting at offset bytes from
8979the beginning of the file. The file offset remains unchanged.
8980[clinic start generated code]*/
8981
Larry Hastings2f936352014-08-05 14:04:04 +10008982static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008983os_pread_impl(PyObject *module, int fd, int length, Py_off_t offset)
8984/*[clinic end generated code: output=435b29ee32b54a78 input=084948dcbaa35d4c]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008985{
Ross Lagerwall7807c352011-03-17 20:20:30 +02008986 Py_ssize_t n;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008987 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008988 PyObject *buffer;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008989
Larry Hastings2f936352014-08-05 14:04:04 +10008990 if (length < 0) {
Ross Lagerwall7807c352011-03-17 20:20:30 +02008991 errno = EINVAL;
8992 return posix_error();
8993 }
Larry Hastings2f936352014-08-05 14:04:04 +10008994 buffer = PyBytes_FromStringAndSize((char *)NULL, length);
Ross Lagerwall7807c352011-03-17 20:20:30 +02008995 if (buffer == NULL)
8996 return NULL;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008997
8998 do {
8999 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04009000 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009001 n = pread(fd, PyBytes_AS_STRING(buffer), length, offset);
Steve Dower8fc89802015-04-12 00:26:27 -04009002 _Py_END_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009003 Py_END_ALLOW_THREADS
9004 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
9005
Ross Lagerwall7807c352011-03-17 20:20:30 +02009006 if (n < 0) {
9007 Py_DECREF(buffer);
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009008 return (!async_err) ? posix_error() : NULL;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009009 }
Larry Hastings2f936352014-08-05 14:04:04 +10009010 if (n != length)
Ross Lagerwall7807c352011-03-17 20:20:30 +02009011 _PyBytes_Resize(&buffer, n);
9012 return buffer;
9013}
Larry Hastings2f936352014-08-05 14:04:04 +10009014#endif /* HAVE_PREAD */
Ross Lagerwall7807c352011-03-17 20:20:30 +02009015
Pablo Galindo4defba32018-01-27 16:16:37 +00009016#if defined(HAVE_PREADV) || defined (HAVE_PREADV2)
9017/*[clinic input]
9018os.preadv -> Py_ssize_t
9019
9020 fd: int
9021 buffers: object
9022 offset: Py_off_t
9023 flags: int = 0
9024 /
9025
9026Reads from a file descriptor into a number of mutable bytes-like objects.
9027
9028Combines the functionality of readv() and pread(). As readv(), it will
9029transfer data into each buffer until it is full and then move on to the next
9030buffer in the sequence to hold the rest of the data. Its fourth argument,
9031specifies the file offset at which the input operation is to be performed. It
9032will return the total number of bytes read (which can be less than the total
9033capacity of all the objects).
9034
9035The flags argument contains a bitwise OR of zero or more of the following flags:
9036
9037- RWF_HIPRI
9038- RWF_NOWAIT
9039
9040Using non-zero flags requires Linux 4.6 or newer.
9041[clinic start generated code]*/
9042
9043static Py_ssize_t
9044os_preadv_impl(PyObject *module, int fd, PyObject *buffers, Py_off_t offset,
9045 int flags)
9046/*[clinic end generated code: output=26fc9c6e58e7ada5 input=4173919dc1f7ed99]*/
9047{
9048 Py_ssize_t cnt, n;
9049 int async_err = 0;
9050 struct iovec *iov;
9051 Py_buffer *buf;
9052
9053 if (!PySequence_Check(buffers)) {
9054 PyErr_SetString(PyExc_TypeError,
9055 "preadv2() arg 2 must be a sequence");
9056 return -1;
9057 }
9058
9059 cnt = PySequence_Size(buffers);
9060 if (cnt < 0) {
9061 return -1;
9062 }
9063
9064#ifndef HAVE_PREADV2
9065 if(flags != 0) {
9066 argument_unavailable_error("preadv2", "flags");
9067 return -1;
9068 }
9069#endif
9070
9071 if (iov_setup(&iov, &buf, buffers, cnt, PyBUF_WRITABLE) < 0) {
9072 return -1;
9073 }
9074#ifdef HAVE_PREADV2
9075 do {
9076 Py_BEGIN_ALLOW_THREADS
9077 _Py_BEGIN_SUPPRESS_IPH
9078 n = preadv2(fd, iov, cnt, offset, flags);
9079 _Py_END_SUPPRESS_IPH
9080 Py_END_ALLOW_THREADS
9081 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
9082#else
9083 do {
9084 Py_BEGIN_ALLOW_THREADS
9085 _Py_BEGIN_SUPPRESS_IPH
9086 n = preadv(fd, iov, cnt, offset);
9087 _Py_END_SUPPRESS_IPH
9088 Py_END_ALLOW_THREADS
9089 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
9090#endif
9091
9092 iov_cleanup(iov, buf, cnt);
9093 if (n < 0) {
9094 if (!async_err) {
9095 posix_error();
9096 }
9097 return -1;
9098 }
9099
9100 return n;
9101}
9102#endif /* HAVE_PREADV */
9103
Larry Hastings2f936352014-08-05 14:04:04 +10009104
9105/*[clinic input]
9106os.write -> Py_ssize_t
9107
9108 fd: int
9109 data: Py_buffer
9110 /
9111
9112Write a bytes object to a file descriptor.
9113[clinic start generated code]*/
9114
Larry Hastings2f936352014-08-05 14:04:04 +10009115static Py_ssize_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009116os_write_impl(PyObject *module, int fd, Py_buffer *data)
9117/*[clinic end generated code: output=e4ef5bc904b58ef9 input=3207e28963234f3c]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009118{
Victor Stinner66aab0c2015-03-19 22:53:20 +01009119 return _Py_write(fd, data->buf, data->len);
Ross Lagerwall7807c352011-03-17 20:20:30 +02009120}
9121
9122#ifdef HAVE_SENDFILE
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009123PyDoc_STRVAR(posix_sendfile__doc__,
Martin Panterbf19d162015-09-09 01:01:13 +00009124"sendfile(out, in, offset, count) -> byteswritten\n\
Martin Panter94994132015-09-09 05:29:24 +00009125sendfile(out, in, offset, count[, headers][, trailers], flags=0)\n\
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009126 -> byteswritten\n\
Martin Panterbf19d162015-09-09 01:01:13 +00009127Copy count bytes from file descriptor in to file descriptor out.");
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009128
Larry Hastings2f936352014-08-05 14:04:04 +10009129/* AC 3.5: don't bother converting, has optional group*/
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009130static PyObject *
9131posix_sendfile(PyObject *self, PyObject *args, PyObject *kwdict)
9132{
9133 int in, out;
9134 Py_ssize_t ret;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009135 int async_err = 0;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009136 off_t offset;
9137
9138#if defined(__FreeBSD__) || defined(__DragonFly__) || defined(__APPLE__)
9139#ifndef __APPLE__
9140 Py_ssize_t len;
9141#endif
9142 PyObject *headers = NULL, *trailers = NULL;
9143 Py_buffer *hbuf, *tbuf;
9144 off_t sbytes;
9145 struct sf_hdtr sf;
9146 int flags = 0;
Martin Panterbf19d162015-09-09 01:01:13 +00009147 /* Beware that "in" clashes with Python's own "in" operator keyword */
Benjamin Petersond8a43b42011-02-26 21:35:16 +00009148 static char *keywords[] = {"out", "in",
9149 "offset", "count",
9150 "headers", "trailers", "flags", NULL};
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009151
Victor Stinner6ce0dbf2013-07-07 16:32:36 +02009152 sf.headers = NULL;
9153 sf.trailers = NULL;
9154
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009155#ifdef __APPLE__
9156 if (!PyArg_ParseTupleAndKeywords(args, kwdict, "iiO&O&|OOi:sendfile",
Larry Hastings2f936352014-08-05 14:04:04 +10009157 keywords, &out, &in, Py_off_t_converter, &offset, Py_off_t_converter, &sbytes,
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009158#else
9159 if (!PyArg_ParseTupleAndKeywords(args, kwdict, "iiO&n|OOi:sendfile",
Larry Hastings2f936352014-08-05 14:04:04 +10009160 keywords, &out, &in, Py_off_t_converter, &offset, &len,
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009161#endif
9162 &headers, &trailers, &flags))
9163 return NULL;
9164 if (headers != NULL) {
9165 if (!PySequence_Check(headers)) {
9166 PyErr_SetString(PyExc_TypeError,
Martin Panter94994132015-09-09 05:29:24 +00009167 "sendfile() headers must be a sequence");
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009168 return NULL;
9169 } else {
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009170 Py_ssize_t i = PySequence_Size(headers);
9171 if (i < 0)
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009172 return NULL;
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009173 if (i > INT_MAX) {
9174 PyErr_SetString(PyExc_OverflowError,
9175 "sendfile() header is too large");
9176 return NULL;
9177 }
9178 if (i > 0) {
9179 sf.hdr_cnt = (int)i;
Serhiy Storchaka9d572732018-07-31 10:24:54 +03009180 if (iov_setup(&(sf.headers), &hbuf,
9181 headers, sf.hdr_cnt, PyBUF_SIMPLE) < 0)
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009182 return NULL;
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00009183#ifdef __APPLE__
Serhiy Storchaka9d572732018-07-31 10:24:54 +03009184 for (i = 0; i < sf.hdr_cnt; i++) {
9185 Py_ssize_t blen = sf.headers[i].iov_len;
9186# define OFF_T_MAX 0x7fffffffffffffff
9187 if (sbytes >= OFF_T_MAX - blen) {
9188 PyErr_SetString(PyExc_OverflowError,
9189 "sendfile() header is too large");
9190 return NULL;
9191 }
9192 sbytes += blen;
9193 }
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00009194#endif
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009195 }
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009196 }
9197 }
9198 if (trailers != NULL) {
9199 if (!PySequence_Check(trailers)) {
9200 PyErr_SetString(PyExc_TypeError,
Martin Panter94994132015-09-09 05:29:24 +00009201 "sendfile() trailers must be a sequence");
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009202 return NULL;
9203 } else {
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009204 Py_ssize_t i = PySequence_Size(trailers);
9205 if (i < 0)
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009206 return NULL;
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009207 if (i > INT_MAX) {
9208 PyErr_SetString(PyExc_OverflowError,
9209 "sendfile() trailer is too large");
9210 return NULL;
9211 }
9212 if (i > 0) {
9213 sf.trl_cnt = (int)i;
Serhiy Storchaka9d572732018-07-31 10:24:54 +03009214 if (iov_setup(&(sf.trailers), &tbuf,
9215 trailers, sf.trl_cnt, PyBUF_SIMPLE) < 0)
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009216 return NULL;
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009217 }
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009218 }
9219 }
9220
Steve Dower8fc89802015-04-12 00:26:27 -04009221 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009222 do {
9223 Py_BEGIN_ALLOW_THREADS
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009224#ifdef __APPLE__
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009225 ret = sendfile(in, out, offset, &sbytes, &sf, flags);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009226#else
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009227 ret = sendfile(in, out, offset, len, &sf, &sbytes, flags);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009228#endif
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009229 Py_END_ALLOW_THREADS
9230 } while (ret < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Steve Dower8fc89802015-04-12 00:26:27 -04009231 _Py_END_SUPPRESS_IPH
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009232
9233 if (sf.headers != NULL)
9234 iov_cleanup(sf.headers, hbuf, sf.hdr_cnt);
9235 if (sf.trailers != NULL)
9236 iov_cleanup(sf.trailers, tbuf, sf.trl_cnt);
9237
9238 if (ret < 0) {
9239 if ((errno == EAGAIN) || (errno == EBUSY)) {
9240 if (sbytes != 0) {
9241 // some data has been sent
9242 goto done;
9243 }
9244 else {
9245 // no data has been sent; upper application is supposed
9246 // to retry on EAGAIN or EBUSY
9247 return posix_error();
9248 }
9249 }
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009250 return (!async_err) ? posix_error() : NULL;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009251 }
9252 goto done;
9253
9254done:
9255 #if !defined(HAVE_LARGEFILE_SUPPORT)
9256 return Py_BuildValue("l", sbytes);
9257 #else
9258 return Py_BuildValue("L", sbytes);
9259 #endif
9260
9261#else
9262 Py_ssize_t count;
9263 PyObject *offobj;
9264 static char *keywords[] = {"out", "in",
9265 "offset", "count", NULL};
9266 if (!PyArg_ParseTupleAndKeywords(args, kwdict, "iiOn:sendfile",
9267 keywords, &out, &in, &offobj, &count))
9268 return NULL;
Benjamin Peterson840ef8f2016-09-07 14:45:10 -07009269#ifdef __linux__
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009270 if (offobj == Py_None) {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009271 do {
9272 Py_BEGIN_ALLOW_THREADS
9273 ret = sendfile(out, in, NULL, count);
9274 Py_END_ALLOW_THREADS
9275 } while (ret < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009276 if (ret < 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009277 return (!async_err) ? posix_error() : NULL;
Giampaolo Rodola'ff1a7352011-04-19 09:47:16 +02009278 return Py_BuildValue("n", ret);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009279 }
9280#endif
Larry Hastings2f936352014-08-05 14:04:04 +10009281 if (!Py_off_t_converter(offobj, &offset))
Antoine Pitroudcc20b82011-02-26 13:38:35 +00009282 return NULL;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009283
9284 do {
9285 Py_BEGIN_ALLOW_THREADS
9286 ret = sendfile(out, in, &offset, count);
9287 Py_END_ALLOW_THREADS
9288 } while (ret < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009289 if (ret < 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009290 return (!async_err) ? posix_error() : NULL;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009291 return Py_BuildValue("n", ret);
9292#endif
9293}
Larry Hastings2f936352014-08-05 14:04:04 +10009294#endif /* HAVE_SENDFILE */
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00009295
Larry Hastings2f936352014-08-05 14:04:04 +10009296
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +02009297#if defined(__APPLE__)
9298/*[clinic input]
9299os._fcopyfile
9300
9301 infd: int
9302 outfd: int
9303 flags: int
9304 /
9305
Giampaolo Rodolac7f02a92018-06-19 08:27:29 -07009306Efficiently copy content or metadata of 2 regular file descriptors (macOS).
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +02009307[clinic start generated code]*/
9308
9309static PyObject *
9310os__fcopyfile_impl(PyObject *module, int infd, int outfd, int flags)
Giampaolo Rodolac7f02a92018-06-19 08:27:29 -07009311/*[clinic end generated code: output=8e8885c721ec38e3 input=69e0770e600cb44f]*/
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +02009312{
9313 int ret;
9314
9315 Py_BEGIN_ALLOW_THREADS
9316 ret = fcopyfile(infd, outfd, NULL, flags);
9317 Py_END_ALLOW_THREADS
9318 if (ret < 0)
9319 return posix_error();
9320 Py_RETURN_NONE;
9321}
9322#endif
9323
9324
Larry Hastings2f936352014-08-05 14:04:04 +10009325/*[clinic input]
9326os.fstat
9327
9328 fd : int
9329
9330Perform a stat system call on the given file descriptor.
9331
9332Like stat(), but for an open file descriptor.
9333Equivalent to os.stat(fd).
9334[clinic start generated code]*/
9335
Larry Hastings2f936352014-08-05 14:04:04 +10009336static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009337os_fstat_impl(PyObject *module, int fd)
9338/*[clinic end generated code: output=efc038cb5f654492 input=27e0e0ebbe5600c9]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009339{
Victor Stinner8c62be82010-05-06 00:08:46 +00009340 STRUCT_STAT st;
9341 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009342 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10009343
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009344 do {
9345 Py_BEGIN_ALLOW_THREADS
9346 res = FSTAT(fd, &st);
9347 Py_END_ALLOW_THREADS
9348 } while (res != 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Victor Stinner8c62be82010-05-06 00:08:46 +00009349 if (res != 0) {
Martin v. Löwis14694662006-02-03 12:54:16 +00009350#ifdef MS_WINDOWS
Victor Stinnerb024e842012-10-31 22:24:06 +01009351 return PyErr_SetFromWindowsErr(0);
Martin v. Löwis14694662006-02-03 12:54:16 +00009352#else
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009353 return (!async_err) ? posix_error() : NULL;
Martin v. Löwis14694662006-02-03 12:54:16 +00009354#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00009355 }
Tim Peters5aa91602002-01-30 05:46:57 +00009356
Victor Stinner4195b5c2012-02-08 23:03:19 +01009357 return _pystat_fromstructstat(&st);
Guido van Rossum687dd131993-05-17 08:34:16 +00009358}
9359
Larry Hastings2f936352014-08-05 14:04:04 +10009360
9361/*[clinic input]
9362os.isatty -> bool
9363 fd: int
9364 /
9365
9366Return True if the fd is connected to a terminal.
9367
9368Return True if the file descriptor is an open file descriptor
9369connected to the slave end of a terminal.
9370[clinic start generated code]*/
9371
Larry Hastings2f936352014-08-05 14:04:04 +10009372static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009373os_isatty_impl(PyObject *module, int fd)
9374/*[clinic end generated code: output=6a48c8b4e644ca00 input=08ce94aa1eaf7b5e]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009375{
Steve Dower8fc89802015-04-12 00:26:27 -04009376 int return_value;
Steve Dower8fc89802015-04-12 00:26:27 -04009377 _Py_BEGIN_SUPPRESS_IPH
9378 return_value = isatty(fd);
9379 _Py_END_SUPPRESS_IPH
9380 return return_value;
Larry Hastings2f936352014-08-05 14:04:04 +10009381}
9382
9383
Guido van Rossuma4916fa1996-05-23 22:58:55 +00009384#ifdef HAVE_PIPE
Larry Hastings2f936352014-08-05 14:04:04 +10009385/*[clinic input]
9386os.pipe
9387
9388Create a pipe.
9389
9390Returns a tuple of two file descriptors:
9391 (read_fd, write_fd)
9392[clinic start generated code]*/
9393
Larry Hastings2f936352014-08-05 14:04:04 +10009394static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009395os_pipe_impl(PyObject *module)
9396/*[clinic end generated code: output=ff9b76255793b440 input=02535e8c8fa6c4d4]*/
Guido van Rossum687dd131993-05-17 08:34:16 +00009397{
Victor Stinner8c62be82010-05-06 00:08:46 +00009398 int fds[2];
Victor Stinnerdaf45552013-08-28 00:53:59 +02009399#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00009400 HANDLE read, write;
Victor Stinnerdaf45552013-08-28 00:53:59 +02009401 SECURITY_ATTRIBUTES attr;
Victor Stinner8c62be82010-05-06 00:08:46 +00009402 BOOL ok;
Victor Stinnerdaf45552013-08-28 00:53:59 +02009403#else
9404 int res;
9405#endif
9406
9407#ifdef MS_WINDOWS
9408 attr.nLength = sizeof(attr);
9409 attr.lpSecurityDescriptor = NULL;
9410 attr.bInheritHandle = FALSE;
9411
9412 Py_BEGIN_ALLOW_THREADS
Steve Dowerc3630612016-11-19 18:41:16 -08009413 _Py_BEGIN_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02009414 ok = CreatePipe(&read, &write, &attr, 0);
9415 if (ok) {
Benjamin Petersonca470632016-09-06 13:47:26 -07009416 fds[0] = _open_osfhandle((intptr_t)read, _O_RDONLY);
9417 fds[1] = _open_osfhandle((intptr_t)write, _O_WRONLY);
Victor Stinnerdaf45552013-08-28 00:53:59 +02009418 if (fds[0] == -1 || fds[1] == -1) {
9419 CloseHandle(read);
9420 CloseHandle(write);
9421 ok = 0;
9422 }
9423 }
Steve Dowerc3630612016-11-19 18:41:16 -08009424 _Py_END_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02009425 Py_END_ALLOW_THREADS
9426
Victor Stinner8c62be82010-05-06 00:08:46 +00009427 if (!ok)
Victor Stinnerb024e842012-10-31 22:24:06 +01009428 return PyErr_SetFromWindowsErr(0);
Victor Stinnerdaf45552013-08-28 00:53:59 +02009429#else
9430
9431#ifdef HAVE_PIPE2
9432 Py_BEGIN_ALLOW_THREADS
9433 res = pipe2(fds, O_CLOEXEC);
9434 Py_END_ALLOW_THREADS
9435
9436 if (res != 0 && errno == ENOSYS)
9437 {
9438#endif
9439 Py_BEGIN_ALLOW_THREADS
9440 res = pipe(fds);
9441 Py_END_ALLOW_THREADS
9442
9443 if (res == 0) {
9444 if (_Py_set_inheritable(fds[0], 0, NULL) < 0) {
9445 close(fds[0]);
9446 close(fds[1]);
9447 return NULL;
9448 }
9449 if (_Py_set_inheritable(fds[1], 0, NULL) < 0) {
9450 close(fds[0]);
9451 close(fds[1]);
9452 return NULL;
9453 }
9454 }
9455#ifdef HAVE_PIPE2
9456 }
9457#endif
9458
9459 if (res != 0)
9460 return PyErr_SetFromErrno(PyExc_OSError);
9461#endif /* !MS_WINDOWS */
9462 return Py_BuildValue("(ii)", fds[0], fds[1]);
Guido van Rossum687dd131993-05-17 08:34:16 +00009463}
Guido van Rossuma4916fa1996-05-23 22:58:55 +00009464#endif /* HAVE_PIPE */
9465
Larry Hastings2f936352014-08-05 14:04:04 +10009466
Charles-François Natalidaafdd52011-05-29 20:07:40 +02009467#ifdef HAVE_PIPE2
Larry Hastings2f936352014-08-05 14:04:04 +10009468/*[clinic input]
9469os.pipe2
9470
9471 flags: int
9472 /
9473
9474Create a pipe with flags set atomically.
9475
9476Returns a tuple of two file descriptors:
9477 (read_fd, write_fd)
9478
9479flags can be constructed by ORing together one or more of these values:
9480O_NONBLOCK, O_CLOEXEC.
9481[clinic start generated code]*/
9482
Larry Hastings2f936352014-08-05 14:04:04 +10009483static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009484os_pipe2_impl(PyObject *module, int flags)
9485/*[clinic end generated code: output=25751fb43a45540f input=f261b6e7e63c6817]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009486{
Charles-François Natalidaafdd52011-05-29 20:07:40 +02009487 int fds[2];
9488 int res;
9489
Charles-François Natalidaafdd52011-05-29 20:07:40 +02009490 res = pipe2(fds, flags);
9491 if (res != 0)
9492 return posix_error();
9493 return Py_BuildValue("(ii)", fds[0], fds[1]);
9494}
9495#endif /* HAVE_PIPE2 */
9496
Larry Hastings2f936352014-08-05 14:04:04 +10009497
Ross Lagerwall7807c352011-03-17 20:20:30 +02009498#ifdef HAVE_WRITEV
Larry Hastings2f936352014-08-05 14:04:04 +10009499/*[clinic input]
9500os.writev -> Py_ssize_t
9501 fd: int
9502 buffers: object
9503 /
9504
9505Iterate over buffers, and write the contents of each to a file descriptor.
9506
9507Returns the total number of bytes written.
9508buffers must be a sequence of bytes-like objects.
9509[clinic start generated code]*/
9510
Larry Hastings2f936352014-08-05 14:04:04 +10009511static Py_ssize_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009512os_writev_impl(PyObject *module, int fd, PyObject *buffers)
9513/*[clinic end generated code: output=56565cfac3aac15b input=5b8d17fe4189d2fe]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009514{
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009515 Py_ssize_t cnt;
Larry Hastings2f936352014-08-05 14:04:04 +10009516 Py_ssize_t result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009517 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009518 struct iovec *iov;
9519 Py_buffer *buf;
Larry Hastings2f936352014-08-05 14:04:04 +10009520
9521 if (!PySequence_Check(buffers)) {
Ross Lagerwall7807c352011-03-17 20:20:30 +02009522 PyErr_SetString(PyExc_TypeError,
9523 "writev() arg 2 must be a sequence");
Larry Hastings2f936352014-08-05 14:04:04 +10009524 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009525 }
Larry Hastings2f936352014-08-05 14:04:04 +10009526 cnt = PySequence_Size(buffers);
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009527 if (cnt < 0)
9528 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009529
Larry Hastings2f936352014-08-05 14:04:04 +10009530 if (iov_setup(&iov, &buf, buffers, cnt, PyBUF_SIMPLE) < 0) {
9531 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009532 }
9533
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009534 do {
9535 Py_BEGIN_ALLOW_THREADS
9536 result = writev(fd, iov, cnt);
9537 Py_END_ALLOW_THREADS
9538 } while (result < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Ross Lagerwall7807c352011-03-17 20:20:30 +02009539
9540 iov_cleanup(iov, buf, cnt);
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009541 if (result < 0 && !async_err)
Larry Hastings2f936352014-08-05 14:04:04 +10009542 posix_error();
Victor Stinner57ddf782014-01-08 15:21:28 +01009543
Georg Brandl306336b2012-06-24 12:55:33 +02009544 return result;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009545}
Larry Hastings2f936352014-08-05 14:04:04 +10009546#endif /* HAVE_WRITEV */
9547
9548
9549#ifdef HAVE_PWRITE
9550/*[clinic input]
9551os.pwrite -> Py_ssize_t
9552
9553 fd: int
9554 buffer: Py_buffer
9555 offset: Py_off_t
9556 /
9557
9558Write bytes to a file descriptor starting at a particular offset.
9559
9560Write buffer to fd, starting at offset bytes from the beginning of
9561the file. Returns the number of bytes writte. Does not change the
9562current file offset.
9563[clinic start generated code]*/
9564
Larry Hastings2f936352014-08-05 14:04:04 +10009565static Py_ssize_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009566os_pwrite_impl(PyObject *module, int fd, Py_buffer *buffer, Py_off_t offset)
9567/*[clinic end generated code: output=c74da630758ee925 input=19903f1b3dd26377]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009568{
9569 Py_ssize_t size;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009570 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10009571
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009572 do {
9573 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04009574 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009575 size = pwrite(fd, buffer->buf, (size_t)buffer->len, offset);
Steve Dower8fc89802015-04-12 00:26:27 -04009576 _Py_END_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009577 Py_END_ALLOW_THREADS
9578 } while (size < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Larry Hastings2f936352014-08-05 14:04:04 +10009579
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009580 if (size < 0 && !async_err)
Larry Hastings2f936352014-08-05 14:04:04 +10009581 posix_error();
9582 return size;
9583}
9584#endif /* HAVE_PWRITE */
9585
Pablo Galindo4defba32018-01-27 16:16:37 +00009586#if defined(HAVE_PWRITEV) || defined (HAVE_PWRITEV2)
9587/*[clinic input]
9588os.pwritev -> Py_ssize_t
9589
9590 fd: int
9591 buffers: object
9592 offset: Py_off_t
9593 flags: int = 0
9594 /
9595
9596Writes the contents of bytes-like objects to a file descriptor at a given offset.
9597
9598Combines the functionality of writev() and pwrite(). All buffers must be a sequence
9599of bytes-like objects. Buffers are processed in array order. Entire contents of first
9600buffer is written before proceeding to second, and so on. The operating system may
9601set a limit (sysconf() value SC_IOV_MAX) on the number of buffers that can be used.
9602This function writes the contents of each object to the file descriptor and returns
9603the total number of bytes written.
9604
9605The flags argument contains a bitwise OR of zero or more of the following flags:
9606
9607- RWF_DSYNC
9608- RWF_SYNC
9609
9610Using non-zero flags requires Linux 4.7 or newer.
9611[clinic start generated code]*/
9612
9613static Py_ssize_t
9614os_pwritev_impl(PyObject *module, int fd, PyObject *buffers, Py_off_t offset,
9615 int flags)
9616/*[clinic end generated code: output=e3dd3e9d11a6a5c7 input=803dc5ddbf0cfd3b]*/
9617{
9618 Py_ssize_t cnt;
9619 Py_ssize_t result;
9620 int async_err = 0;
9621 struct iovec *iov;
9622 Py_buffer *buf;
9623
9624 if (!PySequence_Check(buffers)) {
9625 PyErr_SetString(PyExc_TypeError,
9626 "pwritev() arg 2 must be a sequence");
9627 return -1;
9628 }
9629
9630 cnt = PySequence_Size(buffers);
9631 if (cnt < 0) {
9632 return -1;
9633 }
9634
9635#ifndef HAVE_PWRITEV2
9636 if(flags != 0) {
9637 argument_unavailable_error("pwritev2", "flags");
9638 return -1;
9639 }
9640#endif
9641
9642 if (iov_setup(&iov, &buf, buffers, cnt, PyBUF_SIMPLE) < 0) {
9643 return -1;
9644 }
9645#ifdef HAVE_PWRITEV2
9646 do {
9647 Py_BEGIN_ALLOW_THREADS
9648 _Py_BEGIN_SUPPRESS_IPH
9649 result = pwritev2(fd, iov, cnt, offset, flags);
9650 _Py_END_SUPPRESS_IPH
9651 Py_END_ALLOW_THREADS
9652 } while (result < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
9653#else
9654 do {
9655 Py_BEGIN_ALLOW_THREADS
9656 _Py_BEGIN_SUPPRESS_IPH
9657 result = pwritev(fd, iov, cnt, offset);
9658 _Py_END_SUPPRESS_IPH
9659 Py_END_ALLOW_THREADS
9660 } while (result < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
9661#endif
9662
9663 iov_cleanup(iov, buf, cnt);
9664 if (result < 0) {
9665 if (!async_err) {
9666 posix_error();
9667 }
9668 return -1;
9669 }
9670
9671 return result;
9672}
9673#endif /* HAVE_PWRITEV */
9674
Pablo Galindoaac4d032019-05-31 19:39:47 +01009675#ifdef HAVE_COPY_FILE_RANGE
9676/*[clinic input]
9677
9678os.copy_file_range
9679 src: int
9680 Source file descriptor.
9681 dst: int
9682 Destination file descriptor.
9683 count: Py_ssize_t
9684 Number of bytes to copy.
9685 offset_src: object = None
9686 Starting offset in src.
9687 offset_dst: object = None
9688 Starting offset in dst.
9689
9690Copy count bytes from one file descriptor to another.
9691
9692If offset_src is None, then src is read from the current position;
9693respectively for offset_dst.
9694[clinic start generated code]*/
9695
9696static PyObject *
9697os_copy_file_range_impl(PyObject *module, int src, int dst, Py_ssize_t count,
9698 PyObject *offset_src, PyObject *offset_dst)
9699/*[clinic end generated code: output=1a91713a1d99fc7a input=42fdce72681b25a9]*/
9700{
9701 off_t offset_src_val, offset_dst_val;
9702 off_t *p_offset_src = NULL;
9703 off_t *p_offset_dst = NULL;
9704 Py_ssize_t ret;
9705 int async_err = 0;
9706 /* The flags argument is provided to allow
9707 * for future extensions and currently must be to 0. */
9708 int flags = 0;
Pablo Galindo4defba32018-01-27 16:16:37 +00009709
9710
Pablo Galindoaac4d032019-05-31 19:39:47 +01009711 if (count < 0) {
9712 PyErr_SetString(PyExc_ValueError, "negative value for 'count' not allowed");
9713 return NULL;
9714 }
9715
9716 if (offset_src != Py_None) {
9717 if (!Py_off_t_converter(offset_src, &offset_src_val)) {
9718 return NULL;
9719 }
9720 p_offset_src = &offset_src_val;
9721 }
9722
9723 if (offset_dst != Py_None) {
9724 if (!Py_off_t_converter(offset_dst, &offset_dst_val)) {
9725 return NULL;
9726 }
9727 p_offset_dst = &offset_dst_val;
9728 }
9729
9730 do {
9731 Py_BEGIN_ALLOW_THREADS
9732 ret = copy_file_range(src, p_offset_src, dst, p_offset_dst, count, flags);
9733 Py_END_ALLOW_THREADS
9734 } while (ret < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
9735
9736 if (ret < 0) {
9737 return (!async_err) ? posix_error() : NULL;
9738 }
9739
9740 return PyLong_FromSsize_t(ret);
9741}
9742#endif /* HAVE_COPY_FILE_RANGE*/
Larry Hastings2f936352014-08-05 14:04:04 +10009743
9744#ifdef HAVE_MKFIFO
9745/*[clinic input]
9746os.mkfifo
9747
9748 path: path_t
9749 mode: int=0o666
9750 *
9751 dir_fd: dir_fd(requires='mkfifoat')=None
9752
9753Create a "fifo" (a POSIX named pipe).
9754
9755If dir_fd is not None, it should be a file descriptor open to a directory,
9756 and path should be relative; path will then be relative to that directory.
9757dir_fd may not be implemented on your platform.
9758 If it is unavailable, using it will raise a NotImplementedError.
9759[clinic start generated code]*/
9760
Larry Hastings2f936352014-08-05 14:04:04 +10009761static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009762os_mkfifo_impl(PyObject *module, path_t *path, int mode, int dir_fd)
9763/*[clinic end generated code: output=ce41cfad0e68c940 input=73032e98a36e0e19]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009764{
9765 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009766 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10009767
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009768 do {
9769 Py_BEGIN_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10009770#ifdef HAVE_MKFIFOAT
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009771 if (dir_fd != DEFAULT_DIR_FD)
9772 result = mkfifoat(dir_fd, path->narrow, mode);
9773 else
Ross Lagerwall7807c352011-03-17 20:20:30 +02009774#endif
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009775 result = mkfifo(path->narrow, mode);
9776 Py_END_ALLOW_THREADS
9777 } while (result != 0 && errno == EINTR &&
9778 !(async_err = PyErr_CheckSignals()));
9779 if (result != 0)
9780 return (!async_err) ? posix_error() : NULL;
Larry Hastings2f936352014-08-05 14:04:04 +10009781
9782 Py_RETURN_NONE;
9783}
9784#endif /* HAVE_MKFIFO */
9785
9786
9787#if defined(HAVE_MKNOD) && defined(HAVE_MAKEDEV)
9788/*[clinic input]
9789os.mknod
9790
9791 path: path_t
9792 mode: int=0o600
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +02009793 device: dev_t=0
Larry Hastings2f936352014-08-05 14:04:04 +10009794 *
9795 dir_fd: dir_fd(requires='mknodat')=None
9796
9797Create a node in the file system.
9798
9799Create a node in the file system (file, device special file or named pipe)
9800at path. mode specifies both the permissions to use and the
9801type of node to be created, being combined (bitwise OR) with one of
9802S_IFREG, S_IFCHR, S_IFBLK, and S_IFIFO. If S_IFCHR or S_IFBLK is set on mode,
9803device defines the newly created device special file (probably using
9804os.makedev()). Otherwise device is ignored.
9805
9806If dir_fd is not None, it should be a file descriptor open to a directory,
9807 and path should be relative; path will then be relative to that directory.
9808dir_fd may not be implemented on your platform.
9809 If it is unavailable, using it will raise a NotImplementedError.
9810[clinic start generated code]*/
9811
Larry Hastings2f936352014-08-05 14:04:04 +10009812static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009813os_mknod_impl(PyObject *module, path_t *path, int mode, dev_t device,
Larry Hastings89964c42015-04-14 18:07:59 -04009814 int dir_fd)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009815/*[clinic end generated code: output=92e55d3ca8917461 input=ee44531551a4d83b]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009816{
9817 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009818 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10009819
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009820 do {
9821 Py_BEGIN_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10009822#ifdef HAVE_MKNODAT
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009823 if (dir_fd != DEFAULT_DIR_FD)
9824 result = mknodat(dir_fd, path->narrow, mode, device);
9825 else
Larry Hastings2f936352014-08-05 14:04:04 +10009826#endif
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009827 result = mknod(path->narrow, mode, device);
9828 Py_END_ALLOW_THREADS
9829 } while (result != 0 && errno == EINTR &&
9830 !(async_err = PyErr_CheckSignals()));
9831 if (result != 0)
9832 return (!async_err) ? posix_error() : NULL;
Larry Hastings2f936352014-08-05 14:04:04 +10009833
9834 Py_RETURN_NONE;
9835}
9836#endif /* defined(HAVE_MKNOD) && defined(HAVE_MAKEDEV) */
9837
9838
9839#ifdef HAVE_DEVICE_MACROS
9840/*[clinic input]
9841os.major -> unsigned_int
9842
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +02009843 device: dev_t
Larry Hastings2f936352014-08-05 14:04:04 +10009844 /
9845
9846Extracts a device major number from a raw device number.
9847[clinic start generated code]*/
9848
Larry Hastings2f936352014-08-05 14:04:04 +10009849static unsigned int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009850os_major_impl(PyObject *module, dev_t device)
9851/*[clinic end generated code: output=5b3b2589bafb498e input=1e16a4d30c4d4462]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009852{
9853 return major(device);
9854}
9855
9856
9857/*[clinic input]
9858os.minor -> unsigned_int
9859
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +02009860 device: dev_t
Larry Hastings2f936352014-08-05 14:04:04 +10009861 /
9862
9863Extracts a device minor number from a raw device number.
9864[clinic start generated code]*/
9865
Larry Hastings2f936352014-08-05 14:04:04 +10009866static unsigned int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009867os_minor_impl(PyObject *module, dev_t device)
9868/*[clinic end generated code: output=5e1a25e630b0157d input=0842c6d23f24c65e]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009869{
9870 return minor(device);
9871}
9872
9873
9874/*[clinic input]
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +02009875os.makedev -> dev_t
Larry Hastings2f936352014-08-05 14:04:04 +10009876
9877 major: int
9878 minor: int
9879 /
9880
9881Composes a raw device number from the major and minor device numbers.
9882[clinic start generated code]*/
9883
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +02009884static dev_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009885os_makedev_impl(PyObject *module, int major, int minor)
9886/*[clinic end generated code: output=881aaa4aba6f6a52 input=4b9fd8fc73cbe48f]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009887{
9888 return makedev(major, minor);
9889}
9890#endif /* HAVE_DEVICE_MACROS */
9891
9892
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009893#if defined HAVE_FTRUNCATE || defined MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10009894/*[clinic input]
9895os.ftruncate
9896
9897 fd: int
9898 length: Py_off_t
9899 /
9900
9901Truncate a file, specified by file descriptor, to a specific length.
9902[clinic start generated code]*/
9903
Larry Hastings2f936352014-08-05 14:04:04 +10009904static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009905os_ftruncate_impl(PyObject *module, int fd, Py_off_t length)
9906/*[clinic end generated code: output=fba15523721be7e4 input=63b43641e52818f2]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009907{
9908 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009909 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10009910
Steve Dowerb82e17e2019-05-23 08:45:22 -07009911 if (PySys_Audit("os.truncate", "in", fd, length) < 0) {
9912 return NULL;
9913 }
9914
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009915 do {
9916 Py_BEGIN_ALLOW_THREADS
Steve Dowera1c7e722015-04-12 00:26:43 -04009917 _Py_BEGIN_SUPPRESS_IPH
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009918#ifdef MS_WINDOWS
9919 result = _chsize_s(fd, length);
9920#else
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009921 result = ftruncate(fd, length);
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009922#endif
Steve Dowera1c7e722015-04-12 00:26:43 -04009923 _Py_END_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009924 Py_END_ALLOW_THREADS
9925 } while (result != 0 && errno == EINTR &&
9926 !(async_err = PyErr_CheckSignals()));
9927 if (result != 0)
9928 return (!async_err) ? posix_error() : NULL;
Larry Hastings2f936352014-08-05 14:04:04 +10009929 Py_RETURN_NONE;
9930}
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009931#endif /* HAVE_FTRUNCATE || MS_WINDOWS */
Larry Hastings2f936352014-08-05 14:04:04 +10009932
9933
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009934#if defined HAVE_TRUNCATE || defined MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10009935/*[clinic input]
9936os.truncate
9937 path: path_t(allow_fd='PATH_HAVE_FTRUNCATE')
9938 length: Py_off_t
9939
9940Truncate a file, specified by path, to a specific length.
9941
9942On some platforms, path may also be specified as an open file descriptor.
9943 If this functionality is unavailable, using it raises an exception.
9944[clinic start generated code]*/
9945
Larry Hastings2f936352014-08-05 14:04:04 +10009946static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009947os_truncate_impl(PyObject *module, path_t *path, Py_off_t length)
9948/*[clinic end generated code: output=43009c8df5c0a12b input=77229cf0b50a9b77]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009949{
9950 int result;
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009951#ifdef MS_WINDOWS
9952 int fd;
9953#endif
9954
9955 if (path->fd != -1)
9956 return os_ftruncate_impl(module, path->fd, length);
Larry Hastings2f936352014-08-05 14:04:04 +10009957
Steve Dowerb82e17e2019-05-23 08:45:22 -07009958 if (PySys_Audit("os.truncate", "On", path->object, length) < 0) {
9959 return NULL;
9960 }
9961
Larry Hastings2f936352014-08-05 14:04:04 +10009962 Py_BEGIN_ALLOW_THREADS
Steve Dowera1c7e722015-04-12 00:26:43 -04009963 _Py_BEGIN_SUPPRESS_IPH
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009964#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07009965 fd = _wopen(path->wide, _O_WRONLY | _O_BINARY | _O_NOINHERIT);
Victor Stinnercc0bbbc2015-04-25 00:21:52 +02009966 if (fd < 0)
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009967 result = -1;
9968 else {
9969 result = _chsize_s(fd, length);
9970 close(fd);
9971 if (result < 0)
9972 errno = result;
9973 }
9974#else
9975 result = truncate(path->narrow, length);
Larry Hastings2f936352014-08-05 14:04:04 +10009976#endif
Steve Dowera1c7e722015-04-12 00:26:43 -04009977 _Py_END_SUPPRESS_IPH
Larry Hastings2f936352014-08-05 14:04:04 +10009978 Py_END_ALLOW_THREADS
9979 if (result < 0)
Alexey Izbyshev83460312018-10-20 03:28:22 +03009980 return posix_path_error(path);
Larry Hastings2f936352014-08-05 14:04:04 +10009981
9982 Py_RETURN_NONE;
9983}
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009984#endif /* HAVE_TRUNCATE || MS_WINDOWS */
Larry Hastings2f936352014-08-05 14:04:04 +10009985
Ross Lagerwall7807c352011-03-17 20:20:30 +02009986
Victor Stinnerd6b17692014-09-30 12:20:05 +02009987/* Issue #22396: On 32-bit AIX platform, the prototypes of os.posix_fadvise()
9988 and os.posix_fallocate() in system headers are wrong if _LARGE_FILES is
9989 defined, which is the case in Python on AIX. AIX bug report:
9990 http://www-01.ibm.com/support/docview.wss?uid=isg1IV56170 */
9991#if defined(_AIX) && defined(_LARGE_FILES) && !defined(__64BIT__)
9992# define POSIX_FADVISE_AIX_BUG
9993#endif
9994
Victor Stinnerec39e262014-09-30 12:35:58 +02009995
Victor Stinnerd6b17692014-09-30 12:20:05 +02009996#if defined(HAVE_POSIX_FALLOCATE) && !defined(POSIX_FADVISE_AIX_BUG)
Larry Hastings2f936352014-08-05 14:04:04 +10009997/*[clinic input]
9998os.posix_fallocate
9999
10000 fd: int
10001 offset: Py_off_t
10002 length: Py_off_t
10003 /
10004
10005Ensure a file has allocated at least a particular number of bytes on disk.
10006
10007Ensure that the file specified by fd encompasses a range of bytes
10008starting at offset bytes from the beginning and continuing for length bytes.
10009[clinic start generated code]*/
10010
Larry Hastings2f936352014-08-05 14:04:04 +100010011static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010012os_posix_fallocate_impl(PyObject *module, int fd, Py_off_t offset,
Larry Hastings89964c42015-04-14 18:07:59 -040010013 Py_off_t length)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010014/*[clinic end generated code: output=73f107139564aa9d input=d7a2ef0ab2ca52fb]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010015{
10016 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010017 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +020010018
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010019 do {
10020 Py_BEGIN_ALLOW_THREADS
10021 result = posix_fallocate(fd, offset, length);
10022 Py_END_ALLOW_THREADS
Коренберг Маркd4b93e22017-08-14 18:55:16 +050010023 } while (result == EINTR && !(async_err = PyErr_CheckSignals()));
10024
10025 if (result == 0)
10026 Py_RETURN_NONE;
10027
10028 if (async_err)
10029 return NULL;
10030
10031 errno = result;
10032 return posix_error();
Ross Lagerwall7807c352011-03-17 20:20:30 +020010033}
Victor Stinnerec39e262014-09-30 12:35:58 +020010034#endif /* HAVE_POSIX_FALLOCATE) && !POSIX_FADVISE_AIX_BUG */
Larry Hastings2f936352014-08-05 14:04:04 +100010035
Ross Lagerwall7807c352011-03-17 20:20:30 +020010036
Victor Stinnerd6b17692014-09-30 12:20:05 +020010037#if defined(HAVE_POSIX_FADVISE) && !defined(POSIX_FADVISE_AIX_BUG)
Larry Hastings2f936352014-08-05 14:04:04 +100010038/*[clinic input]
10039os.posix_fadvise
10040
10041 fd: int
10042 offset: Py_off_t
10043 length: Py_off_t
10044 advice: int
10045 /
10046
10047Announce an intention to access data in a specific pattern.
10048
10049Announce an intention to access data in a specific pattern, thus allowing
10050the kernel to make optimizations.
10051The advice applies to the region of the file specified by fd starting at
10052offset and continuing for length bytes.
10053advice is one of POSIX_FADV_NORMAL, POSIX_FADV_SEQUENTIAL,
10054POSIX_FADV_RANDOM, POSIX_FADV_NOREUSE, POSIX_FADV_WILLNEED, or
10055POSIX_FADV_DONTNEED.
10056[clinic start generated code]*/
10057
Larry Hastings2f936352014-08-05 14:04:04 +100010058static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010059os_posix_fadvise_impl(PyObject *module, int fd, Py_off_t offset,
Larry Hastings89964c42015-04-14 18:07:59 -040010060 Py_off_t length, int advice)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010061/*[clinic end generated code: output=412ef4aa70c98642 input=0fbe554edc2f04b5]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010062{
10063 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010064 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +020010065
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010066 do {
10067 Py_BEGIN_ALLOW_THREADS
10068 result = posix_fadvise(fd, offset, length, advice);
10069 Py_END_ALLOW_THREADS
Коренберг Маркd4b93e22017-08-14 18:55:16 +050010070 } while (result == EINTR && !(async_err = PyErr_CheckSignals()));
10071
10072 if (result == 0)
10073 Py_RETURN_NONE;
10074
10075 if (async_err)
10076 return NULL;
10077
10078 errno = result;
10079 return posix_error();
Ross Lagerwall7807c352011-03-17 20:20:30 +020010080}
Victor Stinnerec39e262014-09-30 12:35:58 +020010081#endif /* HAVE_POSIX_FADVISE && !POSIX_FADVISE_AIX_BUG */
Ross Lagerwall7807c352011-03-17 20:20:30 +020010082
Guido van Rossumf1af3fe1996-07-23 19:18:10 +000010083#ifdef HAVE_PUTENV
Guido van Rossumec4f4ac1997-06-02 22:20:51 +000010084
Fred Drake762e2061999-08-26 17:23:54 +000010085/* Save putenv() parameters as values here, so we can collect them when they
10086 * get re-set with another call for the same key. */
10087static PyObject *posix_putenv_garbage;
10088
Larry Hastings2f936352014-08-05 14:04:04 +100010089static void
10090posix_putenv_garbage_setitem(PyObject *name, PyObject *value)
Guido van Rossumf1af3fe1996-07-23 19:18:10 +000010091{
Larry Hastings2f936352014-08-05 14:04:04 +100010092 /* Install the first arg and newstr in posix_putenv_garbage;
10093 * this will cause previous value to be collected. This has to
10094 * happen after the real putenv() call because the old value
10095 * was still accessible until then. */
10096 if (PyDict_SetItem(posix_putenv_garbage, name, value))
10097 /* really not much we can do; just leak */
10098 PyErr_Clear();
10099 else
10100 Py_DECREF(value);
10101}
10102
10103
Thomas Hellerf78f12a2007-11-08 19:33:05 +000010104#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +100010105/*[clinic input]
10106os.putenv
10107
10108 name: unicode
10109 value: unicode
10110 /
10111
10112Change or add an environment variable.
10113[clinic start generated code]*/
10114
Larry Hastings2f936352014-08-05 14:04:04 +100010115static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010116os_putenv_impl(PyObject *module, PyObject *name, PyObject *value)
10117/*[clinic end generated code: output=d29a567d6b2327d2 input=ba586581c2e6105f]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010118{
Serhiy Storchakadeab18d2016-05-07 16:45:18 +030010119 const wchar_t *env;
Serhiy Storchakaf7eae0a2017-06-28 08:30:06 +030010120 Py_ssize_t size;
Larry Hastings2f936352014-08-05 14:04:04 +100010121
Serhiy Storchaka77703942017-06-25 07:33:01 +030010122 /* Search from index 1 because on Windows starting '=' is allowed for
10123 defining hidden environment variables. */
10124 if (PyUnicode_GET_LENGTH(name) == 0 ||
10125 PyUnicode_FindChar(name, '=', 1, PyUnicode_GET_LENGTH(name), 1) != -1)
10126 {
10127 PyErr_SetString(PyExc_ValueError, "illegal environment variable name");
10128 return NULL;
10129 }
Larry Hastings2f936352014-08-05 14:04:04 +100010130 PyObject *unicode = PyUnicode_FromFormat("%U=%U", name, value);
10131 if (unicode == NULL) {
Larry Hastings2f936352014-08-05 14:04:04 +100010132 return NULL;
Victor Stinner84ae1182010-05-06 22:05:07 +000010133 }
Serhiy Storchakaf7eae0a2017-06-28 08:30:06 +030010134
10135 env = PyUnicode_AsUnicodeAndSize(unicode, &size);
10136 if (env == NULL)
10137 goto error;
10138 if (size > _MAX_ENV) {
Victor Stinner65170952011-11-22 22:16:17 +010010139 PyErr_Format(PyExc_ValueError,
10140 "the environment variable is longer than %u characters",
10141 _MAX_ENV);
10142 goto error;
10143 }
Serhiy Storchakaf7eae0a2017-06-28 08:30:06 +030010144 if (wcslen(env) != (size_t)size) {
10145 PyErr_SetString(PyExc_ValueError, "embedded null character");
Victor Stinnereb5657a2011-09-30 01:44:27 +020010146 goto error;
Serhiy Storchakaf7eae0a2017-06-28 08:30:06 +030010147 }
10148
Larry Hastings2f936352014-08-05 14:04:04 +100010149 if (_wputenv(env)) {
Victor Stinner8c62be82010-05-06 00:08:46 +000010150 posix_error();
Victor Stinner84ae1182010-05-06 22:05:07 +000010151 goto error;
Victor Stinner8c62be82010-05-06 00:08:46 +000010152 }
Guido van Rossumf1af3fe1996-07-23 19:18:10 +000010153
Larry Hastings2f936352014-08-05 14:04:04 +100010154 posix_putenv_garbage_setitem(name, unicode);
Victor Stinner84ae1182010-05-06 22:05:07 +000010155 Py_RETURN_NONE;
10156
10157error:
Larry Hastings2f936352014-08-05 14:04:04 +100010158 Py_DECREF(unicode);
Victor Stinner84ae1182010-05-06 22:05:07 +000010159 return NULL;
Guido van Rossumf1af3fe1996-07-23 19:18:10 +000010160}
Larry Hastings2f936352014-08-05 14:04:04 +100010161#else /* MS_WINDOWS */
10162/*[clinic input]
10163os.putenv
Guido van Rossumb6a47161997-09-15 22:54:34 +000010164
Larry Hastings2f936352014-08-05 14:04:04 +100010165 name: FSConverter
10166 value: FSConverter
10167 /
10168
10169Change or add an environment variable.
10170[clinic start generated code]*/
10171
Larry Hastings2f936352014-08-05 14:04:04 +100010172static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010173os_putenv_impl(PyObject *module, PyObject *name, PyObject *value)
10174/*[clinic end generated code: output=d29a567d6b2327d2 input=a97bc6152f688d31]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010175{
10176 PyObject *bytes = NULL;
10177 char *env;
Serhiy Storchaka77703942017-06-25 07:33:01 +030010178 const char *name_string = PyBytes_AS_STRING(name);
10179 const char *value_string = PyBytes_AS_STRING(value);
Larry Hastings2f936352014-08-05 14:04:04 +100010180
Serhiy Storchaka77703942017-06-25 07:33:01 +030010181 if (strchr(name_string, '=') != NULL) {
10182 PyErr_SetString(PyExc_ValueError, "illegal environment variable name");
10183 return NULL;
10184 }
Steve Dowera00b5be2020-02-13 08:30:27 +000010185 if (PySys_Audit("os.putenv", "OO", name, value) < 0) {
10186 return NULL;
10187 }
Larry Hastings2f936352014-08-05 14:04:04 +100010188 bytes = PyBytes_FromFormat("%s=%s", name_string, value_string);
10189 if (bytes == NULL) {
Larry Hastings2f936352014-08-05 14:04:04 +100010190 return NULL;
10191 }
10192
10193 env = PyBytes_AS_STRING(bytes);
10194 if (putenv(env)) {
10195 Py_DECREF(bytes);
10196 return posix_error();
10197 }
10198
10199 posix_putenv_garbage_setitem(name, bytes);
10200 Py_RETURN_NONE;
10201}
10202#endif /* MS_WINDOWS */
10203#endif /* HAVE_PUTENV */
10204
10205
10206#ifdef HAVE_UNSETENV
10207/*[clinic input]
10208os.unsetenv
10209 name: FSConverter
10210 /
10211
10212Delete an environment variable.
10213[clinic start generated code]*/
10214
Larry Hastings2f936352014-08-05 14:04:04 +100010215static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010216os_unsetenv_impl(PyObject *module, PyObject *name)
10217/*[clinic end generated code: output=54c4137ab1834f02 input=2bb5288a599c7107]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010218{
Victor Stinner984890f2011-11-24 13:53:38 +010010219#ifndef HAVE_BROKEN_UNSETENV
Victor Stinner60b385e2011-11-22 22:01:28 +010010220 int err;
Victor Stinner984890f2011-11-24 13:53:38 +010010221#endif
Victor Stinner84ae1182010-05-06 22:05:07 +000010222
Steve Dowera00b5be2020-02-13 08:30:27 +000010223 if (PySys_Audit("os.unsetenv", "(O)", name) < 0) {
10224 return NULL;
10225 }
10226
Victor Stinner984890f2011-11-24 13:53:38 +010010227#ifdef HAVE_BROKEN_UNSETENV
10228 unsetenv(PyBytes_AS_STRING(name));
10229#else
Victor Stinner65170952011-11-22 22:16:17 +010010230 err = unsetenv(PyBytes_AS_STRING(name));
Larry Hastings2f936352014-08-05 14:04:04 +100010231 if (err)
Victor Stinner60b385e2011-11-22 22:01:28 +010010232 return posix_error();
Victor Stinner984890f2011-11-24 13:53:38 +010010233#endif
Guido van Rossumc524d952001-10-19 01:31:59 +000010234
Victor Stinner8c62be82010-05-06 00:08:46 +000010235 /* Remove the key from posix_putenv_garbage;
10236 * this will cause it to be collected. This has to
10237 * happen after the real unsetenv() call because the
10238 * old value was still accessible until then.
10239 */
Victor Stinner65170952011-11-22 22:16:17 +010010240 if (PyDict_DelItem(posix_putenv_garbage, name)) {
Victor Stinner8c62be82010-05-06 00:08:46 +000010241 /* really not much we can do; just leak */
Serhiy Storchakaa24107b2019-02-25 17:59:46 +020010242 if (!PyErr_ExceptionMatches(PyExc_KeyError)) {
10243 return NULL;
10244 }
Victor Stinner8c62be82010-05-06 00:08:46 +000010245 PyErr_Clear();
10246 }
Victor Stinner84ae1182010-05-06 22:05:07 +000010247 Py_RETURN_NONE;
Guido van Rossumc524d952001-10-19 01:31:59 +000010248}
Larry Hastings2f936352014-08-05 14:04:04 +100010249#endif /* HAVE_UNSETENV */
Guido van Rossumc524d952001-10-19 01:31:59 +000010250
Larry Hastings2f936352014-08-05 14:04:04 +100010251
10252/*[clinic input]
10253os.strerror
10254
10255 code: int
10256 /
10257
10258Translate an error code to a message string.
10259[clinic start generated code]*/
10260
Larry Hastings2f936352014-08-05 14:04:04 +100010261static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010262os_strerror_impl(PyObject *module, int code)
10263/*[clinic end generated code: output=baebf09fa02a78f2 input=75a8673d97915a91]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010264{
10265 char *message = strerror(code);
Victor Stinner8c62be82010-05-06 00:08:46 +000010266 if (message == NULL) {
10267 PyErr_SetString(PyExc_ValueError,
10268 "strerror() argument out of range");
10269 return NULL;
10270 }
Victor Stinner1b579672011-12-17 05:47:23 +010010271 return PyUnicode_DecodeLocale(message, "surrogateescape");
Guido van Rossumb6a47161997-09-15 22:54:34 +000010272}
Guido van Rossumb6a47161997-09-15 22:54:34 +000010273
Guido van Rossumf1af3fe1996-07-23 19:18:10 +000010274
Guido van Rossumc9641791998-08-04 15:26:23 +000010275#ifdef HAVE_SYS_WAIT_H
Fred Drake106c1a02002-04-23 15:58:02 +000010276#ifdef WCOREDUMP
Larry Hastings2f936352014-08-05 14:04:04 +100010277/*[clinic input]
10278os.WCOREDUMP -> bool
10279
10280 status: int
10281 /
10282
10283Return True if the process returning status was dumped to a core file.
10284[clinic start generated code]*/
10285
Larry Hastings2f936352014-08-05 14:04:04 +100010286static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010287os_WCOREDUMP_impl(PyObject *module, int status)
10288/*[clinic end generated code: output=1a584b147b16bd18 input=8b05e7ab38528d04]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010289{
10290 WAIT_TYPE wait_status;
10291 WAIT_STATUS_INT(wait_status) = status;
10292 return WCOREDUMP(wait_status);
Fred Drake106c1a02002-04-23 15:58:02 +000010293}
10294#endif /* WCOREDUMP */
10295
Larry Hastings2f936352014-08-05 14:04:04 +100010296
Fred Drake106c1a02002-04-23 15:58:02 +000010297#ifdef WIFCONTINUED
Larry Hastings2f936352014-08-05 14:04:04 +100010298/*[clinic input]
10299os.WIFCONTINUED -> bool
10300
10301 status: int
10302
10303Return True if a particular process was continued from a job control stop.
10304
10305Return True if the process returning status was continued from a
10306job control stop.
10307[clinic start generated code]*/
10308
Larry Hastings2f936352014-08-05 14:04:04 +100010309static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010310os_WIFCONTINUED_impl(PyObject *module, int status)
10311/*[clinic end generated code: output=1e35295d844364bd input=e777e7d38eb25bd9]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010312{
10313 WAIT_TYPE wait_status;
10314 WAIT_STATUS_INT(wait_status) = status;
10315 return WIFCONTINUED(wait_status);
Fred Drake106c1a02002-04-23 15:58:02 +000010316}
10317#endif /* WIFCONTINUED */
10318
Larry Hastings2f936352014-08-05 14:04:04 +100010319
Guido van Rossumc9641791998-08-04 15:26:23 +000010320#ifdef WIFSTOPPED
Larry Hastings2f936352014-08-05 14:04:04 +100010321/*[clinic input]
10322os.WIFSTOPPED -> bool
10323
10324 status: int
10325
10326Return True if the process returning status was stopped.
10327[clinic start generated code]*/
10328
Larry Hastings2f936352014-08-05 14:04:04 +100010329static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010330os_WIFSTOPPED_impl(PyObject *module, int status)
10331/*[clinic end generated code: output=fdb57122a5c9b4cb input=043cb7f1289ef904]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010332{
10333 WAIT_TYPE wait_status;
10334 WAIT_STATUS_INT(wait_status) = status;
10335 return WIFSTOPPED(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +000010336}
10337#endif /* WIFSTOPPED */
10338
Larry Hastings2f936352014-08-05 14:04:04 +100010339
Guido van Rossumc9641791998-08-04 15:26:23 +000010340#ifdef WIFSIGNALED
Larry Hastings2f936352014-08-05 14:04:04 +100010341/*[clinic input]
10342os.WIFSIGNALED -> bool
10343
10344 status: int
10345
10346Return True if the process returning status was terminated by a signal.
10347[clinic start generated code]*/
10348
Larry Hastings2f936352014-08-05 14:04:04 +100010349static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010350os_WIFSIGNALED_impl(PyObject *module, int status)
10351/*[clinic end generated code: output=d1dde4dcc819a5f5 input=d55ba7cc9ce5dc43]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010352{
10353 WAIT_TYPE wait_status;
10354 WAIT_STATUS_INT(wait_status) = status;
10355 return WIFSIGNALED(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +000010356}
10357#endif /* WIFSIGNALED */
10358
Larry Hastings2f936352014-08-05 14:04:04 +100010359
Guido van Rossumc9641791998-08-04 15:26:23 +000010360#ifdef WIFEXITED
Larry Hastings2f936352014-08-05 14:04:04 +100010361/*[clinic input]
10362os.WIFEXITED -> bool
10363
10364 status: int
10365
10366Return True if the process returning status exited via the exit() system call.
10367[clinic start generated code]*/
10368
Larry Hastings2f936352014-08-05 14:04:04 +100010369static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010370os_WIFEXITED_impl(PyObject *module, int status)
10371/*[clinic end generated code: output=01c09d6ebfeea397 input=d63775a6791586c0]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010372{
10373 WAIT_TYPE wait_status;
10374 WAIT_STATUS_INT(wait_status) = status;
10375 return WIFEXITED(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +000010376}
10377#endif /* WIFEXITED */
10378
Larry Hastings2f936352014-08-05 14:04:04 +100010379
Guido van Rossum54ecc3d1999-01-27 17:53:11 +000010380#ifdef WEXITSTATUS
Larry Hastings2f936352014-08-05 14:04:04 +100010381/*[clinic input]
10382os.WEXITSTATUS -> int
10383
10384 status: int
10385
10386Return the process return code from status.
10387[clinic start generated code]*/
10388
Larry Hastings2f936352014-08-05 14:04:04 +100010389static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010390os_WEXITSTATUS_impl(PyObject *module, int status)
10391/*[clinic end generated code: output=6e3efbba11f6488d input=e1fb4944e377585b]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010392{
10393 WAIT_TYPE wait_status;
10394 WAIT_STATUS_INT(wait_status) = status;
10395 return WEXITSTATUS(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +000010396}
10397#endif /* WEXITSTATUS */
10398
Larry Hastings2f936352014-08-05 14:04:04 +100010399
Guido van Rossumc9641791998-08-04 15:26:23 +000010400#ifdef WTERMSIG
Larry Hastings2f936352014-08-05 14:04:04 +100010401/*[clinic input]
10402os.WTERMSIG -> int
10403
10404 status: int
10405
10406Return the signal that terminated the process that provided the status value.
10407[clinic start generated code]*/
10408
Larry Hastings2f936352014-08-05 14:04:04 +100010409static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010410os_WTERMSIG_impl(PyObject *module, int status)
10411/*[clinic end generated code: output=172f7dfc8dcfc3ad input=727fd7f84ec3f243]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010412{
10413 WAIT_TYPE wait_status;
10414 WAIT_STATUS_INT(wait_status) = status;
10415 return WTERMSIG(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +000010416}
10417#endif /* WTERMSIG */
10418
Larry Hastings2f936352014-08-05 14:04:04 +100010419
Guido van Rossumc9641791998-08-04 15:26:23 +000010420#ifdef WSTOPSIG
Larry Hastings2f936352014-08-05 14:04:04 +100010421/*[clinic input]
10422os.WSTOPSIG -> int
10423
10424 status: int
10425
10426Return the signal that stopped the process that provided the status value.
10427[clinic start generated code]*/
10428
Larry Hastings2f936352014-08-05 14:04:04 +100010429static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010430os_WSTOPSIG_impl(PyObject *module, int status)
10431/*[clinic end generated code: output=0ab7586396f5d82b input=46ebf1d1b293c5c1]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010432{
10433 WAIT_TYPE wait_status;
10434 WAIT_STATUS_INT(wait_status) = status;
10435 return WSTOPSIG(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +000010436}
10437#endif /* WSTOPSIG */
Guido van Rossumc9641791998-08-04 15:26:23 +000010438#endif /* HAVE_SYS_WAIT_H */
10439
10440
Thomas Wouters477c8d52006-05-27 19:21:47 +000010441#if defined(HAVE_FSTATVFS) && defined(HAVE_SYS_STATVFS_H)
Guido van Rossumd5753e11999-10-19 13:29:23 +000010442#ifdef _SCO_DS
10443/* SCO OpenServer 5.0 and later requires _SVID3 before it reveals the
10444 needed definitions in sys/statvfs.h */
10445#define _SVID3
10446#endif
Guido van Rossum94f6f721999-01-06 18:42:14 +000010447#include <sys/statvfs.h>
10448
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010449static PyObject*
10450_pystatvfs_fromstructstatvfs(struct statvfs st) {
Eddie Elizondo474eedf2018-11-13 04:09:31 -080010451 PyObject *v = PyStructSequence_New(StatVFSResultType);
Victor Stinner8c62be82010-05-06 00:08:46 +000010452 if (v == NULL)
10453 return NULL;
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010454
10455#if !defined(HAVE_LARGEFILE_SUPPORT)
Victor Stinner8c62be82010-05-06 00:08:46 +000010456 PyStructSequence_SET_ITEM(v, 0, PyLong_FromLong((long) st.f_bsize));
10457 PyStructSequence_SET_ITEM(v, 1, PyLong_FromLong((long) st.f_frsize));
10458 PyStructSequence_SET_ITEM(v, 2, PyLong_FromLong((long) st.f_blocks));
10459 PyStructSequence_SET_ITEM(v, 3, PyLong_FromLong((long) st.f_bfree));
10460 PyStructSequence_SET_ITEM(v, 4, PyLong_FromLong((long) st.f_bavail));
10461 PyStructSequence_SET_ITEM(v, 5, PyLong_FromLong((long) st.f_files));
10462 PyStructSequence_SET_ITEM(v, 6, PyLong_FromLong((long) st.f_ffree));
10463 PyStructSequence_SET_ITEM(v, 7, PyLong_FromLong((long) st.f_favail));
10464 PyStructSequence_SET_ITEM(v, 8, PyLong_FromLong((long) st.f_flag));
10465 PyStructSequence_SET_ITEM(v, 9, PyLong_FromLong((long) st.f_namemax));
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010466#else
Victor Stinner8c62be82010-05-06 00:08:46 +000010467 PyStructSequence_SET_ITEM(v, 0, PyLong_FromLong((long) st.f_bsize));
10468 PyStructSequence_SET_ITEM(v, 1, PyLong_FromLong((long) st.f_frsize));
10469 PyStructSequence_SET_ITEM(v, 2,
Benjamin Petersonaf580df2016-09-06 10:46:49 -070010470 PyLong_FromLongLong((long long) st.f_blocks));
Victor Stinner8c62be82010-05-06 00:08:46 +000010471 PyStructSequence_SET_ITEM(v, 3,
Benjamin Petersonaf580df2016-09-06 10:46:49 -070010472 PyLong_FromLongLong((long long) st.f_bfree));
Victor Stinner8c62be82010-05-06 00:08:46 +000010473 PyStructSequence_SET_ITEM(v, 4,
Benjamin Petersonaf580df2016-09-06 10:46:49 -070010474 PyLong_FromLongLong((long long) st.f_bavail));
Victor Stinner8c62be82010-05-06 00:08:46 +000010475 PyStructSequence_SET_ITEM(v, 5,
Benjamin Petersonaf580df2016-09-06 10:46:49 -070010476 PyLong_FromLongLong((long long) st.f_files));
Victor Stinner8c62be82010-05-06 00:08:46 +000010477 PyStructSequence_SET_ITEM(v, 6,
Benjamin Petersonaf580df2016-09-06 10:46:49 -070010478 PyLong_FromLongLong((long long) st.f_ffree));
Victor Stinner8c62be82010-05-06 00:08:46 +000010479 PyStructSequence_SET_ITEM(v, 7,
Benjamin Petersonaf580df2016-09-06 10:46:49 -070010480 PyLong_FromLongLong((long long) st.f_favail));
Victor Stinner8c62be82010-05-06 00:08:46 +000010481 PyStructSequence_SET_ITEM(v, 8, PyLong_FromLong((long) st.f_flag));
10482 PyStructSequence_SET_ITEM(v, 9, PyLong_FromLong((long) st.f_namemax));
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010483#endif
Michael Felt502d5512018-01-05 13:01:58 +010010484/* The _ALL_SOURCE feature test macro defines f_fsid as a structure
10485 * (issue #32390). */
10486#if defined(_AIX) && defined(_ALL_SOURCE)
10487 PyStructSequence_SET_ITEM(v, 10, PyLong_FromUnsignedLong(st.f_fsid.val[0]));
10488#else
Giuseppe Scrivano96a5e502017-12-14 23:46:46 +010010489 PyStructSequence_SET_ITEM(v, 10, PyLong_FromUnsignedLong(st.f_fsid));
Michael Felt502d5512018-01-05 13:01:58 +010010490#endif
Victor Stinnerf0a7bac2013-10-30 18:55:24 +010010491 if (PyErr_Occurred()) {
10492 Py_DECREF(v);
10493 return NULL;
10494 }
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010495
Victor Stinner8c62be82010-05-06 00:08:46 +000010496 return v;
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010497}
10498
Larry Hastings2f936352014-08-05 14:04:04 +100010499
10500/*[clinic input]
10501os.fstatvfs
10502 fd: int
10503 /
10504
10505Perform an fstatvfs system call on the given fd.
10506
10507Equivalent to statvfs(fd).
10508[clinic start generated code]*/
10509
Larry Hastings2f936352014-08-05 14:04:04 +100010510static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010511os_fstatvfs_impl(PyObject *module, int fd)
10512/*[clinic end generated code: output=53547cf0cc55e6c5 input=d8122243ac50975e]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010513{
10514 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010515 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +000010516 struct statvfs st;
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010517
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010518 do {
10519 Py_BEGIN_ALLOW_THREADS
10520 result = fstatvfs(fd, &st);
10521 Py_END_ALLOW_THREADS
10522 } while (result != 0 && errno == EINTR &&
10523 !(async_err = PyErr_CheckSignals()));
Larry Hastings2f936352014-08-05 14:04:04 +100010524 if (result != 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010525 return (!async_err) ? posix_error() : NULL;
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010526
Victor Stinner8c62be82010-05-06 00:08:46 +000010527 return _pystatvfs_fromstructstatvfs(st);
Guido van Rossum94f6f721999-01-06 18:42:14 +000010528}
Larry Hastings2f936352014-08-05 14:04:04 +100010529#endif /* defined(HAVE_FSTATVFS) && defined(HAVE_SYS_STATVFS_H) */
Guido van Rossum94f6f721999-01-06 18:42:14 +000010530
10531
Thomas Wouters477c8d52006-05-27 19:21:47 +000010532#if defined(HAVE_STATVFS) && defined(HAVE_SYS_STATVFS_H)
Guido van Rossum94f6f721999-01-06 18:42:14 +000010533#include <sys/statvfs.h>
Larry Hastings2f936352014-08-05 14:04:04 +100010534/*[clinic input]
10535os.statvfs
Guido van Rossum94f6f721999-01-06 18:42:14 +000010536
Larry Hastings2f936352014-08-05 14:04:04 +100010537 path: path_t(allow_fd='PATH_HAVE_FSTATVFS')
10538
10539Perform a statvfs system call on the given path.
10540
10541path may always be specified as a string.
10542On some platforms, path may also be specified as an open file descriptor.
10543 If this functionality is unavailable, using it raises an exception.
10544[clinic start generated code]*/
10545
Larry Hastings2f936352014-08-05 14:04:04 +100010546static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010547os_statvfs_impl(PyObject *module, path_t *path)
10548/*[clinic end generated code: output=87106dd1beb8556e input=3f5c35791c669bd9]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010549{
10550 int result;
10551 struct statvfs st;
Larry Hastings9cf065c2012-06-22 16:30:09 -070010552
10553 Py_BEGIN_ALLOW_THREADS
10554#ifdef HAVE_FSTATVFS
Larry Hastings2f936352014-08-05 14:04:04 +100010555 if (path->fd != -1) {
Larry Hastings9cf065c2012-06-22 16:30:09 -070010556#ifdef __APPLE__
10557 /* handle weak-linking on Mac OS X 10.3 */
10558 if (fstatvfs == NULL) {
Larry Hastings2f936352014-08-05 14:04:04 +100010559 fd_specified("statvfs", path->fd);
10560 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070010561 }
10562#endif
Larry Hastings2f936352014-08-05 14:04:04 +100010563 result = fstatvfs(path->fd, &st);
Larry Hastings9cf065c2012-06-22 16:30:09 -070010564 }
10565 else
10566#endif
Larry Hastings2f936352014-08-05 14:04:04 +100010567 result = statvfs(path->narrow, &st);
Larry Hastings9cf065c2012-06-22 16:30:09 -070010568 Py_END_ALLOW_THREADS
10569
10570 if (result) {
Larry Hastings2f936352014-08-05 14:04:04 +100010571 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -070010572 }
10573
Larry Hastings2f936352014-08-05 14:04:04 +100010574 return _pystatvfs_fromstructstatvfs(st);
Guido van Rossum94f6f721999-01-06 18:42:14 +000010575}
Larry Hastings2f936352014-08-05 14:04:04 +100010576#endif /* defined(HAVE_STATVFS) && defined(HAVE_SYS_STATVFS_H) */
10577
Guido van Rossum94f6f721999-01-06 18:42:14 +000010578
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010579#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +100010580/*[clinic input]
10581os._getdiskusage
10582
Steve Dower23ad6d02018-02-22 10:39:10 -080010583 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +100010584
10585Return disk usage statistics about the given path as a (total, free) tuple.
10586[clinic start generated code]*/
10587
Larry Hastings2f936352014-08-05 14:04:04 +100010588static PyObject *
Steve Dower23ad6d02018-02-22 10:39:10 -080010589os__getdiskusage_impl(PyObject *module, path_t *path)
10590/*[clinic end generated code: output=3bd3991f5e5c5dfb input=6af8d1b7781cc042]*/
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010591{
10592 BOOL retval;
10593 ULARGE_INTEGER _, total, free;
Joe Pamerc8c02492018-09-25 10:57:36 -040010594 DWORD err = 0;
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010595
10596 Py_BEGIN_ALLOW_THREADS
Steve Dower23ad6d02018-02-22 10:39:10 -080010597 retval = GetDiskFreeSpaceExW(path->wide, &_, &total, &free);
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010598 Py_END_ALLOW_THREADS
Joe Pamerc8c02492018-09-25 10:57:36 -040010599 if (retval == 0) {
10600 if (GetLastError() == ERROR_DIRECTORY) {
10601 wchar_t *dir_path = NULL;
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010602
Joe Pamerc8c02492018-09-25 10:57:36 -040010603 dir_path = PyMem_New(wchar_t, path->length + 1);
10604 if (dir_path == NULL) {
10605 return PyErr_NoMemory();
10606 }
10607
10608 wcscpy_s(dir_path, path->length + 1, path->wide);
10609
10610 if (_dirnameW(dir_path) != -1) {
10611 Py_BEGIN_ALLOW_THREADS
10612 retval = GetDiskFreeSpaceExW(dir_path, &_, &total, &free);
10613 Py_END_ALLOW_THREADS
10614 }
10615 /* Record the last error in case it's modified by PyMem_Free. */
10616 err = GetLastError();
10617 PyMem_Free(dir_path);
10618 if (retval) {
10619 goto success;
10620 }
10621 }
10622 return PyErr_SetFromWindowsErr(err);
10623 }
10624
10625success:
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010626 return Py_BuildValue("(LL)", total.QuadPart, free.QuadPart);
10627}
Larry Hastings2f936352014-08-05 14:04:04 +100010628#endif /* MS_WINDOWS */
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010629
10630
Fred Drakec9680921999-12-13 16:37:25 +000010631/* This is used for fpathconf(), pathconf(), confstr() and sysconf().
10632 * It maps strings representing configuration variable names to
10633 * integer values, allowing those functions to be called with the
Thomas Wouters7e474022000-07-16 12:04:32 +000010634 * magic names instead of polluting the module's namespace with tons of
Fred Drake12c6e2d1999-12-14 21:25:03 +000010635 * rarely-used constants. There are three separate tables that use
10636 * these definitions.
Fred Drakebec628d1999-12-15 18:31:10 +000010637 *
10638 * This code is always included, even if none of the interfaces that
10639 * need it are included. The #if hackery needed to avoid it would be
10640 * sufficiently pervasive that it's not worth the loss of readability.
Fred Drakec9680921999-12-13 16:37:25 +000010641 */
10642struct constdef {
Serhiy Storchaka2d06e842015-12-25 19:53:18 +020010643 const char *name;
Serhiy Storchaka56f6e762015-09-06 21:25:30 +030010644 int value;
Fred Drakec9680921999-12-13 16:37:25 +000010645};
10646
Fred Drake12c6e2d1999-12-14 21:25:03 +000010647static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000010648conv_confname(PyObject *arg, int *valuep, struct constdef *table,
Guido van Rossum7d5baac2007-08-27 23:24:46 +000010649 size_t tablesize)
Fred Drake12c6e2d1999-12-14 21:25:03 +000010650{
Christian Heimes217cfd12007-12-02 14:31:20 +000010651 if (PyLong_Check(arg)) {
Serhiy Storchaka56f6e762015-09-06 21:25:30 +030010652 int value = _PyLong_AsInt(arg);
10653 if (value == -1 && PyErr_Occurred())
10654 return 0;
10655 *valuep = value;
Stefan Krah0e803b32010-11-26 16:16:47 +000010656 return 1;
Fred Drake12c6e2d1999-12-14 21:25:03 +000010657 }
Guido van Rossumbce56a62007-05-10 18:04:33 +000010658 else {
Stefan Krah0e803b32010-11-26 16:16:47 +000010659 /* look up the value in the table using a binary search */
10660 size_t lo = 0;
10661 size_t mid;
10662 size_t hi = tablesize;
10663 int cmp;
10664 const char *confname;
10665 if (!PyUnicode_Check(arg)) {
10666 PyErr_SetString(PyExc_TypeError,
10667 "configuration names must be strings or integers");
10668 return 0;
Victor Stinner8c62be82010-05-06 00:08:46 +000010669 }
Serhiy Storchaka06515832016-11-20 09:13:07 +020010670 confname = PyUnicode_AsUTF8(arg);
Stefan Krah0e803b32010-11-26 16:16:47 +000010671 if (confname == NULL)
10672 return 0;
10673 while (lo < hi) {
10674 mid = (lo + hi) / 2;
10675 cmp = strcmp(confname, table[mid].name);
10676 if (cmp < 0)
10677 hi = mid;
10678 else if (cmp > 0)
10679 lo = mid + 1;
10680 else {
10681 *valuep = table[mid].value;
10682 return 1;
10683 }
10684 }
10685 PyErr_SetString(PyExc_ValueError, "unrecognized configuration name");
10686 return 0;
Victor Stinner8c62be82010-05-06 00:08:46 +000010687 }
Fred Drake12c6e2d1999-12-14 21:25:03 +000010688}
10689
10690
10691#if defined(HAVE_FPATHCONF) || defined(HAVE_PATHCONF)
10692static struct constdef posix_constants_pathconf[] = {
Fred Draked86ed291999-12-15 15:34:33 +000010693#ifdef _PC_ABI_AIO_XFER_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010694 {"PC_ABI_AIO_XFER_MAX", _PC_ABI_AIO_XFER_MAX},
Fred Draked86ed291999-12-15 15:34:33 +000010695#endif
10696#ifdef _PC_ABI_ASYNC_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000010697 {"PC_ABI_ASYNC_IO", _PC_ABI_ASYNC_IO},
Fred Draked86ed291999-12-15 15:34:33 +000010698#endif
Fred Drakec9680921999-12-13 16:37:25 +000010699#ifdef _PC_ASYNC_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000010700 {"PC_ASYNC_IO", _PC_ASYNC_IO},
Fred Drakec9680921999-12-13 16:37:25 +000010701#endif
10702#ifdef _PC_CHOWN_RESTRICTED
Victor Stinner8c62be82010-05-06 00:08:46 +000010703 {"PC_CHOWN_RESTRICTED", _PC_CHOWN_RESTRICTED},
Fred Drakec9680921999-12-13 16:37:25 +000010704#endif
10705#ifdef _PC_FILESIZEBITS
Victor Stinner8c62be82010-05-06 00:08:46 +000010706 {"PC_FILESIZEBITS", _PC_FILESIZEBITS},
Fred Drakec9680921999-12-13 16:37:25 +000010707#endif
10708#ifdef _PC_LAST
Victor Stinner8c62be82010-05-06 00:08:46 +000010709 {"PC_LAST", _PC_LAST},
Fred Drakec9680921999-12-13 16:37:25 +000010710#endif
10711#ifdef _PC_LINK_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010712 {"PC_LINK_MAX", _PC_LINK_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010713#endif
10714#ifdef _PC_MAX_CANON
Victor Stinner8c62be82010-05-06 00:08:46 +000010715 {"PC_MAX_CANON", _PC_MAX_CANON},
Fred Drakec9680921999-12-13 16:37:25 +000010716#endif
10717#ifdef _PC_MAX_INPUT
Victor Stinner8c62be82010-05-06 00:08:46 +000010718 {"PC_MAX_INPUT", _PC_MAX_INPUT},
Fred Drakec9680921999-12-13 16:37:25 +000010719#endif
10720#ifdef _PC_NAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010721 {"PC_NAME_MAX", _PC_NAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010722#endif
10723#ifdef _PC_NO_TRUNC
Victor Stinner8c62be82010-05-06 00:08:46 +000010724 {"PC_NO_TRUNC", _PC_NO_TRUNC},
Fred Drakec9680921999-12-13 16:37:25 +000010725#endif
10726#ifdef _PC_PATH_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010727 {"PC_PATH_MAX", _PC_PATH_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010728#endif
10729#ifdef _PC_PIPE_BUF
Victor Stinner8c62be82010-05-06 00:08:46 +000010730 {"PC_PIPE_BUF", _PC_PIPE_BUF},
Fred Drakec9680921999-12-13 16:37:25 +000010731#endif
10732#ifdef _PC_PRIO_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000010733 {"PC_PRIO_IO", _PC_PRIO_IO},
Fred Drakec9680921999-12-13 16:37:25 +000010734#endif
10735#ifdef _PC_SOCK_MAXBUF
Victor Stinner8c62be82010-05-06 00:08:46 +000010736 {"PC_SOCK_MAXBUF", _PC_SOCK_MAXBUF},
Fred Drakec9680921999-12-13 16:37:25 +000010737#endif
10738#ifdef _PC_SYNC_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000010739 {"PC_SYNC_IO", _PC_SYNC_IO},
Fred Drakec9680921999-12-13 16:37:25 +000010740#endif
10741#ifdef _PC_VDISABLE
Victor Stinner8c62be82010-05-06 00:08:46 +000010742 {"PC_VDISABLE", _PC_VDISABLE},
Fred Drakec9680921999-12-13 16:37:25 +000010743#endif
Jesus Cea7e9065c2010-10-25 13:02:04 +000010744#ifdef _PC_ACL_ENABLED
10745 {"PC_ACL_ENABLED", _PC_ACL_ENABLED},
10746#endif
10747#ifdef _PC_MIN_HOLE_SIZE
10748 {"PC_MIN_HOLE_SIZE", _PC_MIN_HOLE_SIZE},
10749#endif
10750#ifdef _PC_ALLOC_SIZE_MIN
10751 {"PC_ALLOC_SIZE_MIN", _PC_ALLOC_SIZE_MIN},
10752#endif
10753#ifdef _PC_REC_INCR_XFER_SIZE
10754 {"PC_REC_INCR_XFER_SIZE", _PC_REC_INCR_XFER_SIZE},
10755#endif
10756#ifdef _PC_REC_MAX_XFER_SIZE
10757 {"PC_REC_MAX_XFER_SIZE", _PC_REC_MAX_XFER_SIZE},
10758#endif
10759#ifdef _PC_REC_MIN_XFER_SIZE
10760 {"PC_REC_MIN_XFER_SIZE", _PC_REC_MIN_XFER_SIZE},
10761#endif
10762#ifdef _PC_REC_XFER_ALIGN
10763 {"PC_REC_XFER_ALIGN", _PC_REC_XFER_ALIGN},
10764#endif
10765#ifdef _PC_SYMLINK_MAX
10766 {"PC_SYMLINK_MAX", _PC_SYMLINK_MAX},
10767#endif
10768#ifdef _PC_XATTR_ENABLED
10769 {"PC_XATTR_ENABLED", _PC_XATTR_ENABLED},
10770#endif
10771#ifdef _PC_XATTR_EXISTS
10772 {"PC_XATTR_EXISTS", _PC_XATTR_EXISTS},
10773#endif
10774#ifdef _PC_TIMESTAMP_RESOLUTION
10775 {"PC_TIMESTAMP_RESOLUTION", _PC_TIMESTAMP_RESOLUTION},
10776#endif
Fred Drakec9680921999-12-13 16:37:25 +000010777};
10778
Fred Drakec9680921999-12-13 16:37:25 +000010779static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000010780conv_path_confname(PyObject *arg, int *valuep)
Fred Drakec9680921999-12-13 16:37:25 +000010781{
10782 return conv_confname(arg, valuep, posix_constants_pathconf,
10783 sizeof(posix_constants_pathconf)
10784 / sizeof(struct constdef));
10785}
10786#endif
10787
Larry Hastings2f936352014-08-05 14:04:04 +100010788
Fred Drakec9680921999-12-13 16:37:25 +000010789#ifdef HAVE_FPATHCONF
Larry Hastings2f936352014-08-05 14:04:04 +100010790/*[clinic input]
10791os.fpathconf -> long
10792
10793 fd: int
10794 name: path_confname
10795 /
10796
10797Return the configuration limit name for the file descriptor fd.
10798
10799If there is no limit, return -1.
10800[clinic start generated code]*/
10801
Larry Hastings2f936352014-08-05 14:04:04 +100010802static long
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010803os_fpathconf_impl(PyObject *module, int fd, int name)
10804/*[clinic end generated code: output=d5b7042425fc3e21 input=5942a024d3777810]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010805{
10806 long limit;
10807
10808 errno = 0;
10809 limit = fpathconf(fd, name);
10810 if (limit == -1 && errno != 0)
10811 posix_error();
10812
10813 return limit;
10814}
10815#endif /* HAVE_FPATHCONF */
Fred Drakec9680921999-12-13 16:37:25 +000010816
10817
10818#ifdef HAVE_PATHCONF
Larry Hastings2f936352014-08-05 14:04:04 +100010819/*[clinic input]
10820os.pathconf -> long
10821 path: path_t(allow_fd='PATH_HAVE_FPATHCONF')
10822 name: path_confname
10823
10824Return the configuration limit name for the file or directory path.
10825
10826If there is no limit, return -1.
10827On some platforms, path may also be specified as an open file descriptor.
10828 If this functionality is unavailable, using it raises an exception.
10829[clinic start generated code]*/
10830
Larry Hastings2f936352014-08-05 14:04:04 +100010831static long
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010832os_pathconf_impl(PyObject *module, path_t *path, int name)
10833/*[clinic end generated code: output=5bedee35b293a089 input=bc3e2a985af27e5e]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010834{
Victor Stinner8c62be82010-05-06 00:08:46 +000010835 long limit;
Fred Drakec9680921999-12-13 16:37:25 +000010836
Victor Stinner8c62be82010-05-06 00:08:46 +000010837 errno = 0;
Georg Brandl306336b2012-06-24 12:55:33 +020010838#ifdef HAVE_FPATHCONF
Larry Hastings2f936352014-08-05 14:04:04 +100010839 if (path->fd != -1)
10840 limit = fpathconf(path->fd, name);
Georg Brandl306336b2012-06-24 12:55:33 +020010841 else
10842#endif
Larry Hastings2f936352014-08-05 14:04:04 +100010843 limit = pathconf(path->narrow, name);
Victor Stinner8c62be82010-05-06 00:08:46 +000010844 if (limit == -1 && errno != 0) {
10845 if (errno == EINVAL)
Stefan Krah99439262010-11-26 12:58:05 +000010846 /* could be a path or name problem */
10847 posix_error();
Fred Drakec9680921999-12-13 16:37:25 +000010848 else
Larry Hastings2f936352014-08-05 14:04:04 +100010849 path_error(path);
Victor Stinner8c62be82010-05-06 00:08:46 +000010850 }
Larry Hastings2f936352014-08-05 14:04:04 +100010851
10852 return limit;
Fred Drakec9680921999-12-13 16:37:25 +000010853}
Larry Hastings2f936352014-08-05 14:04:04 +100010854#endif /* HAVE_PATHCONF */
Fred Drakec9680921999-12-13 16:37:25 +000010855
10856#ifdef HAVE_CONFSTR
10857static struct constdef posix_constants_confstr[] = {
Fred Draked86ed291999-12-15 15:34:33 +000010858#ifdef _CS_ARCHITECTURE
Victor Stinner8c62be82010-05-06 00:08:46 +000010859 {"CS_ARCHITECTURE", _CS_ARCHITECTURE},
Fred Draked86ed291999-12-15 15:34:33 +000010860#endif
Mark Dickinson876d7c82010-04-16 12:47:52 +000010861#ifdef _CS_GNU_LIBC_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000010862 {"CS_GNU_LIBC_VERSION", _CS_GNU_LIBC_VERSION},
Mark Dickinson876d7c82010-04-16 12:47:52 +000010863#endif
10864#ifdef _CS_GNU_LIBPTHREAD_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000010865 {"CS_GNU_LIBPTHREAD_VERSION", _CS_GNU_LIBPTHREAD_VERSION},
Mark Dickinson876d7c82010-04-16 12:47:52 +000010866#endif
Fred Draked86ed291999-12-15 15:34:33 +000010867#ifdef _CS_HOSTNAME
Victor Stinner8c62be82010-05-06 00:08:46 +000010868 {"CS_HOSTNAME", _CS_HOSTNAME},
Fred Draked86ed291999-12-15 15:34:33 +000010869#endif
10870#ifdef _CS_HW_PROVIDER
Victor Stinner8c62be82010-05-06 00:08:46 +000010871 {"CS_HW_PROVIDER", _CS_HW_PROVIDER},
Fred Draked86ed291999-12-15 15:34:33 +000010872#endif
10873#ifdef _CS_HW_SERIAL
Victor Stinner8c62be82010-05-06 00:08:46 +000010874 {"CS_HW_SERIAL", _CS_HW_SERIAL},
Fred Draked86ed291999-12-15 15:34:33 +000010875#endif
10876#ifdef _CS_INITTAB_NAME
Victor Stinner8c62be82010-05-06 00:08:46 +000010877 {"CS_INITTAB_NAME", _CS_INITTAB_NAME},
Fred Draked86ed291999-12-15 15:34:33 +000010878#endif
Fred Drakec9680921999-12-13 16:37:25 +000010879#ifdef _CS_LFS64_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010880 {"CS_LFS64_CFLAGS", _CS_LFS64_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010881#endif
10882#ifdef _CS_LFS64_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010883 {"CS_LFS64_LDFLAGS", _CS_LFS64_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010884#endif
10885#ifdef _CS_LFS64_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000010886 {"CS_LFS64_LIBS", _CS_LFS64_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000010887#endif
10888#ifdef _CS_LFS64_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010889 {"CS_LFS64_LINTFLAGS", _CS_LFS64_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010890#endif
10891#ifdef _CS_LFS_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010892 {"CS_LFS_CFLAGS", _CS_LFS_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010893#endif
10894#ifdef _CS_LFS_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010895 {"CS_LFS_LDFLAGS", _CS_LFS_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010896#endif
10897#ifdef _CS_LFS_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000010898 {"CS_LFS_LIBS", _CS_LFS_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000010899#endif
10900#ifdef _CS_LFS_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010901 {"CS_LFS_LINTFLAGS", _CS_LFS_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010902#endif
Fred Draked86ed291999-12-15 15:34:33 +000010903#ifdef _CS_MACHINE
Victor Stinner8c62be82010-05-06 00:08:46 +000010904 {"CS_MACHINE", _CS_MACHINE},
Fred Draked86ed291999-12-15 15:34:33 +000010905#endif
Fred Drakec9680921999-12-13 16:37:25 +000010906#ifdef _CS_PATH
Victor Stinner8c62be82010-05-06 00:08:46 +000010907 {"CS_PATH", _CS_PATH},
Fred Drakec9680921999-12-13 16:37:25 +000010908#endif
Fred Draked86ed291999-12-15 15:34:33 +000010909#ifdef _CS_RELEASE
Victor Stinner8c62be82010-05-06 00:08:46 +000010910 {"CS_RELEASE", _CS_RELEASE},
Fred Draked86ed291999-12-15 15:34:33 +000010911#endif
10912#ifdef _CS_SRPC_DOMAIN
Victor Stinner8c62be82010-05-06 00:08:46 +000010913 {"CS_SRPC_DOMAIN", _CS_SRPC_DOMAIN},
Fred Draked86ed291999-12-15 15:34:33 +000010914#endif
10915#ifdef _CS_SYSNAME
Victor Stinner8c62be82010-05-06 00:08:46 +000010916 {"CS_SYSNAME", _CS_SYSNAME},
Fred Draked86ed291999-12-15 15:34:33 +000010917#endif
10918#ifdef _CS_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000010919 {"CS_VERSION", _CS_VERSION},
Fred Draked86ed291999-12-15 15:34:33 +000010920#endif
Fred Drakec9680921999-12-13 16:37:25 +000010921#ifdef _CS_XBS5_ILP32_OFF32_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010922 {"CS_XBS5_ILP32_OFF32_CFLAGS", _CS_XBS5_ILP32_OFF32_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010923#endif
10924#ifdef _CS_XBS5_ILP32_OFF32_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010925 {"CS_XBS5_ILP32_OFF32_LDFLAGS", _CS_XBS5_ILP32_OFF32_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010926#endif
10927#ifdef _CS_XBS5_ILP32_OFF32_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000010928 {"CS_XBS5_ILP32_OFF32_LIBS", _CS_XBS5_ILP32_OFF32_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000010929#endif
10930#ifdef _CS_XBS5_ILP32_OFF32_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010931 {"CS_XBS5_ILP32_OFF32_LINTFLAGS", _CS_XBS5_ILP32_OFF32_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010932#endif
10933#ifdef _CS_XBS5_ILP32_OFFBIG_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010934 {"CS_XBS5_ILP32_OFFBIG_CFLAGS", _CS_XBS5_ILP32_OFFBIG_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010935#endif
10936#ifdef _CS_XBS5_ILP32_OFFBIG_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010937 {"CS_XBS5_ILP32_OFFBIG_LDFLAGS", _CS_XBS5_ILP32_OFFBIG_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010938#endif
10939#ifdef _CS_XBS5_ILP32_OFFBIG_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000010940 {"CS_XBS5_ILP32_OFFBIG_LIBS", _CS_XBS5_ILP32_OFFBIG_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000010941#endif
10942#ifdef _CS_XBS5_ILP32_OFFBIG_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010943 {"CS_XBS5_ILP32_OFFBIG_LINTFLAGS", _CS_XBS5_ILP32_OFFBIG_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010944#endif
10945#ifdef _CS_XBS5_LP64_OFF64_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010946 {"CS_XBS5_LP64_OFF64_CFLAGS", _CS_XBS5_LP64_OFF64_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010947#endif
10948#ifdef _CS_XBS5_LP64_OFF64_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010949 {"CS_XBS5_LP64_OFF64_LDFLAGS", _CS_XBS5_LP64_OFF64_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010950#endif
10951#ifdef _CS_XBS5_LP64_OFF64_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000010952 {"CS_XBS5_LP64_OFF64_LIBS", _CS_XBS5_LP64_OFF64_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000010953#endif
10954#ifdef _CS_XBS5_LP64_OFF64_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010955 {"CS_XBS5_LP64_OFF64_LINTFLAGS", _CS_XBS5_LP64_OFF64_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010956#endif
10957#ifdef _CS_XBS5_LPBIG_OFFBIG_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010958 {"CS_XBS5_LPBIG_OFFBIG_CFLAGS", _CS_XBS5_LPBIG_OFFBIG_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010959#endif
10960#ifdef _CS_XBS5_LPBIG_OFFBIG_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010961 {"CS_XBS5_LPBIG_OFFBIG_LDFLAGS", _CS_XBS5_LPBIG_OFFBIG_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010962#endif
10963#ifdef _CS_XBS5_LPBIG_OFFBIG_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000010964 {"CS_XBS5_LPBIG_OFFBIG_LIBS", _CS_XBS5_LPBIG_OFFBIG_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000010965#endif
10966#ifdef _CS_XBS5_LPBIG_OFFBIG_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010967 {"CS_XBS5_LPBIG_OFFBIG_LINTFLAGS", _CS_XBS5_LPBIG_OFFBIG_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010968#endif
Fred Draked86ed291999-12-15 15:34:33 +000010969#ifdef _MIPS_CS_AVAIL_PROCESSORS
Victor Stinner8c62be82010-05-06 00:08:46 +000010970 {"MIPS_CS_AVAIL_PROCESSORS", _MIPS_CS_AVAIL_PROCESSORS},
Fred Draked86ed291999-12-15 15:34:33 +000010971#endif
10972#ifdef _MIPS_CS_BASE
Victor Stinner8c62be82010-05-06 00:08:46 +000010973 {"MIPS_CS_BASE", _MIPS_CS_BASE},
Fred Draked86ed291999-12-15 15:34:33 +000010974#endif
10975#ifdef _MIPS_CS_HOSTID
Victor Stinner8c62be82010-05-06 00:08:46 +000010976 {"MIPS_CS_HOSTID", _MIPS_CS_HOSTID},
Fred Draked86ed291999-12-15 15:34:33 +000010977#endif
10978#ifdef _MIPS_CS_HW_NAME
Victor Stinner8c62be82010-05-06 00:08:46 +000010979 {"MIPS_CS_HW_NAME", _MIPS_CS_HW_NAME},
Fred Draked86ed291999-12-15 15:34:33 +000010980#endif
10981#ifdef _MIPS_CS_NUM_PROCESSORS
Victor Stinner8c62be82010-05-06 00:08:46 +000010982 {"MIPS_CS_NUM_PROCESSORS", _MIPS_CS_NUM_PROCESSORS},
Fred Draked86ed291999-12-15 15:34:33 +000010983#endif
10984#ifdef _MIPS_CS_OSREL_MAJ
Victor Stinner8c62be82010-05-06 00:08:46 +000010985 {"MIPS_CS_OSREL_MAJ", _MIPS_CS_OSREL_MAJ},
Fred Draked86ed291999-12-15 15:34:33 +000010986#endif
10987#ifdef _MIPS_CS_OSREL_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000010988 {"MIPS_CS_OSREL_MIN", _MIPS_CS_OSREL_MIN},
Fred Draked86ed291999-12-15 15:34:33 +000010989#endif
10990#ifdef _MIPS_CS_OSREL_PATCH
Victor Stinner8c62be82010-05-06 00:08:46 +000010991 {"MIPS_CS_OSREL_PATCH", _MIPS_CS_OSREL_PATCH},
Fred Draked86ed291999-12-15 15:34:33 +000010992#endif
10993#ifdef _MIPS_CS_OS_NAME
Victor Stinner8c62be82010-05-06 00:08:46 +000010994 {"MIPS_CS_OS_NAME", _MIPS_CS_OS_NAME},
Fred Draked86ed291999-12-15 15:34:33 +000010995#endif
10996#ifdef _MIPS_CS_OS_PROVIDER
Victor Stinner8c62be82010-05-06 00:08:46 +000010997 {"MIPS_CS_OS_PROVIDER", _MIPS_CS_OS_PROVIDER},
Fred Draked86ed291999-12-15 15:34:33 +000010998#endif
10999#ifdef _MIPS_CS_PROCESSORS
Victor Stinner8c62be82010-05-06 00:08:46 +000011000 {"MIPS_CS_PROCESSORS", _MIPS_CS_PROCESSORS},
Fred Draked86ed291999-12-15 15:34:33 +000011001#endif
11002#ifdef _MIPS_CS_SERIAL
Victor Stinner8c62be82010-05-06 00:08:46 +000011003 {"MIPS_CS_SERIAL", _MIPS_CS_SERIAL},
Fred Draked86ed291999-12-15 15:34:33 +000011004#endif
11005#ifdef _MIPS_CS_VENDOR
Victor Stinner8c62be82010-05-06 00:08:46 +000011006 {"MIPS_CS_VENDOR", _MIPS_CS_VENDOR},
Fred Draked86ed291999-12-15 15:34:33 +000011007#endif
Fred Drakec9680921999-12-13 16:37:25 +000011008};
11009
11010static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000011011conv_confstr_confname(PyObject *arg, int *valuep)
Fred Drakec9680921999-12-13 16:37:25 +000011012{
11013 return conv_confname(arg, valuep, posix_constants_confstr,
11014 sizeof(posix_constants_confstr)
11015 / sizeof(struct constdef));
11016}
11017
Larry Hastings2f936352014-08-05 14:04:04 +100011018
11019/*[clinic input]
11020os.confstr
11021
11022 name: confstr_confname
11023 /
11024
11025Return a string-valued system configuration variable.
11026[clinic start generated code]*/
11027
Larry Hastings2f936352014-08-05 14:04:04 +100011028static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011029os_confstr_impl(PyObject *module, int name)
11030/*[clinic end generated code: output=bfb0b1b1e49b9383 input=18fb4d0567242e65]*/
Fred Drakec9680921999-12-13 16:37:25 +000011031{
11032 PyObject *result = NULL;
Victor Stinnercb043522010-09-10 23:49:04 +000011033 char buffer[255];
Victor Stinnerdd3a6a52013-06-25 23:13:47 +020011034 size_t len;
Fred Drakec9680921999-12-13 16:37:25 +000011035
Victor Stinnercb043522010-09-10 23:49:04 +000011036 errno = 0;
11037 len = confstr(name, buffer, sizeof(buffer));
11038 if (len == 0) {
11039 if (errno) {
11040 posix_error();
11041 return NULL;
Fred Drakec9680921999-12-13 16:37:25 +000011042 }
11043 else {
Victor Stinnercb043522010-09-10 23:49:04 +000011044 Py_RETURN_NONE;
Fred Drakec9680921999-12-13 16:37:25 +000011045 }
11046 }
Victor Stinnercb043522010-09-10 23:49:04 +000011047
Victor Stinnerdd3a6a52013-06-25 23:13:47 +020011048 if (len >= sizeof(buffer)) {
Victor Stinnercbc18f32014-12-05 22:51:51 +010011049 size_t len2;
Victor Stinnercb043522010-09-10 23:49:04 +000011050 char *buf = PyMem_Malloc(len);
11051 if (buf == NULL)
11052 return PyErr_NoMemory();
Victor Stinnercbc18f32014-12-05 22:51:51 +010011053 len2 = confstr(name, buf, len);
11054 assert(len == len2);
Christian Heimes8714cfd2015-04-21 10:57:41 +020011055 result = PyUnicode_DecodeFSDefaultAndSize(buf, len2-1);
Victor Stinnercb043522010-09-10 23:49:04 +000011056 PyMem_Free(buf);
11057 }
11058 else
11059 result = PyUnicode_DecodeFSDefaultAndSize(buffer, len-1);
Fred Drakec9680921999-12-13 16:37:25 +000011060 return result;
11061}
Larry Hastings2f936352014-08-05 14:04:04 +100011062#endif /* HAVE_CONFSTR */
Fred Drakec9680921999-12-13 16:37:25 +000011063
11064
11065#ifdef HAVE_SYSCONF
11066static struct constdef posix_constants_sysconf[] = {
11067#ifdef _SC_2_CHAR_TERM
Victor Stinner8c62be82010-05-06 00:08:46 +000011068 {"SC_2_CHAR_TERM", _SC_2_CHAR_TERM},
Fred Drakec9680921999-12-13 16:37:25 +000011069#endif
11070#ifdef _SC_2_C_BIND
Victor Stinner8c62be82010-05-06 00:08:46 +000011071 {"SC_2_C_BIND", _SC_2_C_BIND},
Fred Drakec9680921999-12-13 16:37:25 +000011072#endif
11073#ifdef _SC_2_C_DEV
Victor Stinner8c62be82010-05-06 00:08:46 +000011074 {"SC_2_C_DEV", _SC_2_C_DEV},
Fred Drakec9680921999-12-13 16:37:25 +000011075#endif
11076#ifdef _SC_2_C_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000011077 {"SC_2_C_VERSION", _SC_2_C_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000011078#endif
11079#ifdef _SC_2_FORT_DEV
Victor Stinner8c62be82010-05-06 00:08:46 +000011080 {"SC_2_FORT_DEV", _SC_2_FORT_DEV},
Fred Drakec9680921999-12-13 16:37:25 +000011081#endif
11082#ifdef _SC_2_FORT_RUN
Victor Stinner8c62be82010-05-06 00:08:46 +000011083 {"SC_2_FORT_RUN", _SC_2_FORT_RUN},
Fred Drakec9680921999-12-13 16:37:25 +000011084#endif
11085#ifdef _SC_2_LOCALEDEF
Victor Stinner8c62be82010-05-06 00:08:46 +000011086 {"SC_2_LOCALEDEF", _SC_2_LOCALEDEF},
Fred Drakec9680921999-12-13 16:37:25 +000011087#endif
11088#ifdef _SC_2_SW_DEV
Victor Stinner8c62be82010-05-06 00:08:46 +000011089 {"SC_2_SW_DEV", _SC_2_SW_DEV},
Fred Drakec9680921999-12-13 16:37:25 +000011090#endif
11091#ifdef _SC_2_UPE
Victor Stinner8c62be82010-05-06 00:08:46 +000011092 {"SC_2_UPE", _SC_2_UPE},
Fred Drakec9680921999-12-13 16:37:25 +000011093#endif
11094#ifdef _SC_2_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000011095 {"SC_2_VERSION", _SC_2_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000011096#endif
Fred Draked86ed291999-12-15 15:34:33 +000011097#ifdef _SC_ABI_ASYNCHRONOUS_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000011098 {"SC_ABI_ASYNCHRONOUS_IO", _SC_ABI_ASYNCHRONOUS_IO},
Fred Draked86ed291999-12-15 15:34:33 +000011099#endif
11100#ifdef _SC_ACL
Victor Stinner8c62be82010-05-06 00:08:46 +000011101 {"SC_ACL", _SC_ACL},
Fred Draked86ed291999-12-15 15:34:33 +000011102#endif
Fred Drakec9680921999-12-13 16:37:25 +000011103#ifdef _SC_AIO_LISTIO_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011104 {"SC_AIO_LISTIO_MAX", _SC_AIO_LISTIO_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011105#endif
Fred Drakec9680921999-12-13 16:37:25 +000011106#ifdef _SC_AIO_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011107 {"SC_AIO_MAX", _SC_AIO_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011108#endif
11109#ifdef _SC_AIO_PRIO_DELTA_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011110 {"SC_AIO_PRIO_DELTA_MAX", _SC_AIO_PRIO_DELTA_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011111#endif
11112#ifdef _SC_ARG_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011113 {"SC_ARG_MAX", _SC_ARG_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011114#endif
11115#ifdef _SC_ASYNCHRONOUS_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000011116 {"SC_ASYNCHRONOUS_IO", _SC_ASYNCHRONOUS_IO},
Fred Drakec9680921999-12-13 16:37:25 +000011117#endif
11118#ifdef _SC_ATEXIT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011119 {"SC_ATEXIT_MAX", _SC_ATEXIT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011120#endif
Fred Draked86ed291999-12-15 15:34:33 +000011121#ifdef _SC_AUDIT
Victor Stinner8c62be82010-05-06 00:08:46 +000011122 {"SC_AUDIT", _SC_AUDIT},
Fred Draked86ed291999-12-15 15:34:33 +000011123#endif
Fred Drakec9680921999-12-13 16:37:25 +000011124#ifdef _SC_AVPHYS_PAGES
Victor Stinner8c62be82010-05-06 00:08:46 +000011125 {"SC_AVPHYS_PAGES", _SC_AVPHYS_PAGES},
Fred Drakec9680921999-12-13 16:37:25 +000011126#endif
11127#ifdef _SC_BC_BASE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011128 {"SC_BC_BASE_MAX", _SC_BC_BASE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011129#endif
11130#ifdef _SC_BC_DIM_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011131 {"SC_BC_DIM_MAX", _SC_BC_DIM_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011132#endif
11133#ifdef _SC_BC_SCALE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011134 {"SC_BC_SCALE_MAX", _SC_BC_SCALE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011135#endif
11136#ifdef _SC_BC_STRING_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011137 {"SC_BC_STRING_MAX", _SC_BC_STRING_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011138#endif
Fred Draked86ed291999-12-15 15:34:33 +000011139#ifdef _SC_CAP
Victor Stinner8c62be82010-05-06 00:08:46 +000011140 {"SC_CAP", _SC_CAP},
Fred Draked86ed291999-12-15 15:34:33 +000011141#endif
Fred Drakec9680921999-12-13 16:37:25 +000011142#ifdef _SC_CHARCLASS_NAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011143 {"SC_CHARCLASS_NAME_MAX", _SC_CHARCLASS_NAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011144#endif
11145#ifdef _SC_CHAR_BIT
Victor Stinner8c62be82010-05-06 00:08:46 +000011146 {"SC_CHAR_BIT", _SC_CHAR_BIT},
Fred Drakec9680921999-12-13 16:37:25 +000011147#endif
11148#ifdef _SC_CHAR_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011149 {"SC_CHAR_MAX", _SC_CHAR_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011150#endif
11151#ifdef _SC_CHAR_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000011152 {"SC_CHAR_MIN", _SC_CHAR_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000011153#endif
11154#ifdef _SC_CHILD_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011155 {"SC_CHILD_MAX", _SC_CHILD_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011156#endif
11157#ifdef _SC_CLK_TCK
Victor Stinner8c62be82010-05-06 00:08:46 +000011158 {"SC_CLK_TCK", _SC_CLK_TCK},
Fred Drakec9680921999-12-13 16:37:25 +000011159#endif
11160#ifdef _SC_COHER_BLKSZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011161 {"SC_COHER_BLKSZ", _SC_COHER_BLKSZ},
Fred Drakec9680921999-12-13 16:37:25 +000011162#endif
11163#ifdef _SC_COLL_WEIGHTS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011164 {"SC_COLL_WEIGHTS_MAX", _SC_COLL_WEIGHTS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011165#endif
11166#ifdef _SC_DCACHE_ASSOC
Victor Stinner8c62be82010-05-06 00:08:46 +000011167 {"SC_DCACHE_ASSOC", _SC_DCACHE_ASSOC},
Fred Drakec9680921999-12-13 16:37:25 +000011168#endif
11169#ifdef _SC_DCACHE_BLKSZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011170 {"SC_DCACHE_BLKSZ", _SC_DCACHE_BLKSZ},
Fred Drakec9680921999-12-13 16:37:25 +000011171#endif
11172#ifdef _SC_DCACHE_LINESZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011173 {"SC_DCACHE_LINESZ", _SC_DCACHE_LINESZ},
Fred Drakec9680921999-12-13 16:37:25 +000011174#endif
11175#ifdef _SC_DCACHE_SZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011176 {"SC_DCACHE_SZ", _SC_DCACHE_SZ},
Fred Drakec9680921999-12-13 16:37:25 +000011177#endif
11178#ifdef _SC_DCACHE_TBLKSZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011179 {"SC_DCACHE_TBLKSZ", _SC_DCACHE_TBLKSZ},
Fred Drakec9680921999-12-13 16:37:25 +000011180#endif
11181#ifdef _SC_DELAYTIMER_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011182 {"SC_DELAYTIMER_MAX", _SC_DELAYTIMER_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011183#endif
11184#ifdef _SC_EQUIV_CLASS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011185 {"SC_EQUIV_CLASS_MAX", _SC_EQUIV_CLASS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011186#endif
11187#ifdef _SC_EXPR_NEST_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011188 {"SC_EXPR_NEST_MAX", _SC_EXPR_NEST_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011189#endif
11190#ifdef _SC_FSYNC
Victor Stinner8c62be82010-05-06 00:08:46 +000011191 {"SC_FSYNC", _SC_FSYNC},
Fred Drakec9680921999-12-13 16:37:25 +000011192#endif
11193#ifdef _SC_GETGR_R_SIZE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011194 {"SC_GETGR_R_SIZE_MAX", _SC_GETGR_R_SIZE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011195#endif
11196#ifdef _SC_GETPW_R_SIZE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011197 {"SC_GETPW_R_SIZE_MAX", _SC_GETPW_R_SIZE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011198#endif
11199#ifdef _SC_ICACHE_ASSOC
Victor Stinner8c62be82010-05-06 00:08:46 +000011200 {"SC_ICACHE_ASSOC", _SC_ICACHE_ASSOC},
Fred Drakec9680921999-12-13 16:37:25 +000011201#endif
11202#ifdef _SC_ICACHE_BLKSZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011203 {"SC_ICACHE_BLKSZ", _SC_ICACHE_BLKSZ},
Fred Drakec9680921999-12-13 16:37:25 +000011204#endif
11205#ifdef _SC_ICACHE_LINESZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011206 {"SC_ICACHE_LINESZ", _SC_ICACHE_LINESZ},
Fred Drakec9680921999-12-13 16:37:25 +000011207#endif
11208#ifdef _SC_ICACHE_SZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011209 {"SC_ICACHE_SZ", _SC_ICACHE_SZ},
Fred Drakec9680921999-12-13 16:37:25 +000011210#endif
Fred Draked86ed291999-12-15 15:34:33 +000011211#ifdef _SC_INF
Victor Stinner8c62be82010-05-06 00:08:46 +000011212 {"SC_INF", _SC_INF},
Fred Draked86ed291999-12-15 15:34:33 +000011213#endif
Fred Drakec9680921999-12-13 16:37:25 +000011214#ifdef _SC_INT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011215 {"SC_INT_MAX", _SC_INT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011216#endif
11217#ifdef _SC_INT_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000011218 {"SC_INT_MIN", _SC_INT_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000011219#endif
11220#ifdef _SC_IOV_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011221 {"SC_IOV_MAX", _SC_IOV_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011222#endif
Fred Draked86ed291999-12-15 15:34:33 +000011223#ifdef _SC_IP_SECOPTS
Victor Stinner8c62be82010-05-06 00:08:46 +000011224 {"SC_IP_SECOPTS", _SC_IP_SECOPTS},
Fred Draked86ed291999-12-15 15:34:33 +000011225#endif
Fred Drakec9680921999-12-13 16:37:25 +000011226#ifdef _SC_JOB_CONTROL
Victor Stinner8c62be82010-05-06 00:08:46 +000011227 {"SC_JOB_CONTROL", _SC_JOB_CONTROL},
Fred Drakec9680921999-12-13 16:37:25 +000011228#endif
Fred Draked86ed291999-12-15 15:34:33 +000011229#ifdef _SC_KERN_POINTERS
Victor Stinner8c62be82010-05-06 00:08:46 +000011230 {"SC_KERN_POINTERS", _SC_KERN_POINTERS},
Fred Draked86ed291999-12-15 15:34:33 +000011231#endif
11232#ifdef _SC_KERN_SIM
Victor Stinner8c62be82010-05-06 00:08:46 +000011233 {"SC_KERN_SIM", _SC_KERN_SIM},
Fred Draked86ed291999-12-15 15:34:33 +000011234#endif
Fred Drakec9680921999-12-13 16:37:25 +000011235#ifdef _SC_LINE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011236 {"SC_LINE_MAX", _SC_LINE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011237#endif
11238#ifdef _SC_LOGIN_NAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011239 {"SC_LOGIN_NAME_MAX", _SC_LOGIN_NAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011240#endif
11241#ifdef _SC_LOGNAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011242 {"SC_LOGNAME_MAX", _SC_LOGNAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011243#endif
11244#ifdef _SC_LONG_BIT
Victor Stinner8c62be82010-05-06 00:08:46 +000011245 {"SC_LONG_BIT", _SC_LONG_BIT},
Fred Drakec9680921999-12-13 16:37:25 +000011246#endif
Fred Draked86ed291999-12-15 15:34:33 +000011247#ifdef _SC_MAC
Victor Stinner8c62be82010-05-06 00:08:46 +000011248 {"SC_MAC", _SC_MAC},
Fred Draked86ed291999-12-15 15:34:33 +000011249#endif
Fred Drakec9680921999-12-13 16:37:25 +000011250#ifdef _SC_MAPPED_FILES
Victor Stinner8c62be82010-05-06 00:08:46 +000011251 {"SC_MAPPED_FILES", _SC_MAPPED_FILES},
Fred Drakec9680921999-12-13 16:37:25 +000011252#endif
11253#ifdef _SC_MAXPID
Victor Stinner8c62be82010-05-06 00:08:46 +000011254 {"SC_MAXPID", _SC_MAXPID},
Fred Drakec9680921999-12-13 16:37:25 +000011255#endif
11256#ifdef _SC_MB_LEN_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011257 {"SC_MB_LEN_MAX", _SC_MB_LEN_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011258#endif
11259#ifdef _SC_MEMLOCK
Victor Stinner8c62be82010-05-06 00:08:46 +000011260 {"SC_MEMLOCK", _SC_MEMLOCK},
Fred Drakec9680921999-12-13 16:37:25 +000011261#endif
11262#ifdef _SC_MEMLOCK_RANGE
Victor Stinner8c62be82010-05-06 00:08:46 +000011263 {"SC_MEMLOCK_RANGE", _SC_MEMLOCK_RANGE},
Fred Drakec9680921999-12-13 16:37:25 +000011264#endif
11265#ifdef _SC_MEMORY_PROTECTION
Victor Stinner8c62be82010-05-06 00:08:46 +000011266 {"SC_MEMORY_PROTECTION", _SC_MEMORY_PROTECTION},
Fred Drakec9680921999-12-13 16:37:25 +000011267#endif
11268#ifdef _SC_MESSAGE_PASSING
Victor Stinner8c62be82010-05-06 00:08:46 +000011269 {"SC_MESSAGE_PASSING", _SC_MESSAGE_PASSING},
Fred Drakec9680921999-12-13 16:37:25 +000011270#endif
Fred Draked86ed291999-12-15 15:34:33 +000011271#ifdef _SC_MMAP_FIXED_ALIGNMENT
Victor Stinner8c62be82010-05-06 00:08:46 +000011272 {"SC_MMAP_FIXED_ALIGNMENT", _SC_MMAP_FIXED_ALIGNMENT},
Fred Draked86ed291999-12-15 15:34:33 +000011273#endif
Fred Drakec9680921999-12-13 16:37:25 +000011274#ifdef _SC_MQ_OPEN_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011275 {"SC_MQ_OPEN_MAX", _SC_MQ_OPEN_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011276#endif
11277#ifdef _SC_MQ_PRIO_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011278 {"SC_MQ_PRIO_MAX", _SC_MQ_PRIO_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011279#endif
Fred Draked86ed291999-12-15 15:34:33 +000011280#ifdef _SC_NACLS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011281 {"SC_NACLS_MAX", _SC_NACLS_MAX},
Fred Draked86ed291999-12-15 15:34:33 +000011282#endif
Fred Drakec9680921999-12-13 16:37:25 +000011283#ifdef _SC_NGROUPS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011284 {"SC_NGROUPS_MAX", _SC_NGROUPS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011285#endif
11286#ifdef _SC_NL_ARGMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011287 {"SC_NL_ARGMAX", _SC_NL_ARGMAX},
Fred Drakec9680921999-12-13 16:37:25 +000011288#endif
11289#ifdef _SC_NL_LANGMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011290 {"SC_NL_LANGMAX", _SC_NL_LANGMAX},
Fred Drakec9680921999-12-13 16:37:25 +000011291#endif
11292#ifdef _SC_NL_MSGMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011293 {"SC_NL_MSGMAX", _SC_NL_MSGMAX},
Fred Drakec9680921999-12-13 16:37:25 +000011294#endif
11295#ifdef _SC_NL_NMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011296 {"SC_NL_NMAX", _SC_NL_NMAX},
Fred Drakec9680921999-12-13 16:37:25 +000011297#endif
11298#ifdef _SC_NL_SETMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011299 {"SC_NL_SETMAX", _SC_NL_SETMAX},
Fred Drakec9680921999-12-13 16:37:25 +000011300#endif
11301#ifdef _SC_NL_TEXTMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011302 {"SC_NL_TEXTMAX", _SC_NL_TEXTMAX},
Fred Drakec9680921999-12-13 16:37:25 +000011303#endif
11304#ifdef _SC_NPROCESSORS_CONF
Victor Stinner8c62be82010-05-06 00:08:46 +000011305 {"SC_NPROCESSORS_CONF", _SC_NPROCESSORS_CONF},
Fred Drakec9680921999-12-13 16:37:25 +000011306#endif
11307#ifdef _SC_NPROCESSORS_ONLN
Victor Stinner8c62be82010-05-06 00:08:46 +000011308 {"SC_NPROCESSORS_ONLN", _SC_NPROCESSORS_ONLN},
Fred Drakec9680921999-12-13 16:37:25 +000011309#endif
Fred Draked86ed291999-12-15 15:34:33 +000011310#ifdef _SC_NPROC_CONF
Victor Stinner8c62be82010-05-06 00:08:46 +000011311 {"SC_NPROC_CONF", _SC_NPROC_CONF},
Fred Draked86ed291999-12-15 15:34:33 +000011312#endif
11313#ifdef _SC_NPROC_ONLN
Victor Stinner8c62be82010-05-06 00:08:46 +000011314 {"SC_NPROC_ONLN", _SC_NPROC_ONLN},
Fred Draked86ed291999-12-15 15:34:33 +000011315#endif
Fred Drakec9680921999-12-13 16:37:25 +000011316#ifdef _SC_NZERO
Victor Stinner8c62be82010-05-06 00:08:46 +000011317 {"SC_NZERO", _SC_NZERO},
Fred Drakec9680921999-12-13 16:37:25 +000011318#endif
11319#ifdef _SC_OPEN_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011320 {"SC_OPEN_MAX", _SC_OPEN_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011321#endif
11322#ifdef _SC_PAGESIZE
Victor Stinner8c62be82010-05-06 00:08:46 +000011323 {"SC_PAGESIZE", _SC_PAGESIZE},
Fred Drakec9680921999-12-13 16:37:25 +000011324#endif
11325#ifdef _SC_PAGE_SIZE
Victor Stinner8c62be82010-05-06 00:08:46 +000011326 {"SC_PAGE_SIZE", _SC_PAGE_SIZE},
Fred Drakec9680921999-12-13 16:37:25 +000011327#endif
11328#ifdef _SC_PASS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011329 {"SC_PASS_MAX", _SC_PASS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011330#endif
11331#ifdef _SC_PHYS_PAGES
Victor Stinner8c62be82010-05-06 00:08:46 +000011332 {"SC_PHYS_PAGES", _SC_PHYS_PAGES},
Fred Drakec9680921999-12-13 16:37:25 +000011333#endif
11334#ifdef _SC_PII
Victor Stinner8c62be82010-05-06 00:08:46 +000011335 {"SC_PII", _SC_PII},
Fred Drakec9680921999-12-13 16:37:25 +000011336#endif
11337#ifdef _SC_PII_INTERNET
Victor Stinner8c62be82010-05-06 00:08:46 +000011338 {"SC_PII_INTERNET", _SC_PII_INTERNET},
Fred Drakec9680921999-12-13 16:37:25 +000011339#endif
11340#ifdef _SC_PII_INTERNET_DGRAM
Victor Stinner8c62be82010-05-06 00:08:46 +000011341 {"SC_PII_INTERNET_DGRAM", _SC_PII_INTERNET_DGRAM},
Fred Drakec9680921999-12-13 16:37:25 +000011342#endif
11343#ifdef _SC_PII_INTERNET_STREAM
Victor Stinner8c62be82010-05-06 00:08:46 +000011344 {"SC_PII_INTERNET_STREAM", _SC_PII_INTERNET_STREAM},
Fred Drakec9680921999-12-13 16:37:25 +000011345#endif
11346#ifdef _SC_PII_OSI
Victor Stinner8c62be82010-05-06 00:08:46 +000011347 {"SC_PII_OSI", _SC_PII_OSI},
Fred Drakec9680921999-12-13 16:37:25 +000011348#endif
11349#ifdef _SC_PII_OSI_CLTS
Victor Stinner8c62be82010-05-06 00:08:46 +000011350 {"SC_PII_OSI_CLTS", _SC_PII_OSI_CLTS},
Fred Drakec9680921999-12-13 16:37:25 +000011351#endif
11352#ifdef _SC_PII_OSI_COTS
Victor Stinner8c62be82010-05-06 00:08:46 +000011353 {"SC_PII_OSI_COTS", _SC_PII_OSI_COTS},
Fred Drakec9680921999-12-13 16:37:25 +000011354#endif
11355#ifdef _SC_PII_OSI_M
Victor Stinner8c62be82010-05-06 00:08:46 +000011356 {"SC_PII_OSI_M", _SC_PII_OSI_M},
Fred Drakec9680921999-12-13 16:37:25 +000011357#endif
11358#ifdef _SC_PII_SOCKET
Victor Stinner8c62be82010-05-06 00:08:46 +000011359 {"SC_PII_SOCKET", _SC_PII_SOCKET},
Fred Drakec9680921999-12-13 16:37:25 +000011360#endif
11361#ifdef _SC_PII_XTI
Victor Stinner8c62be82010-05-06 00:08:46 +000011362 {"SC_PII_XTI", _SC_PII_XTI},
Fred Drakec9680921999-12-13 16:37:25 +000011363#endif
11364#ifdef _SC_POLL
Victor Stinner8c62be82010-05-06 00:08:46 +000011365 {"SC_POLL", _SC_POLL},
Fred Drakec9680921999-12-13 16:37:25 +000011366#endif
11367#ifdef _SC_PRIORITIZED_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000011368 {"SC_PRIORITIZED_IO", _SC_PRIORITIZED_IO},
Fred Drakec9680921999-12-13 16:37:25 +000011369#endif
11370#ifdef _SC_PRIORITY_SCHEDULING
Victor Stinner8c62be82010-05-06 00:08:46 +000011371 {"SC_PRIORITY_SCHEDULING", _SC_PRIORITY_SCHEDULING},
Fred Drakec9680921999-12-13 16:37:25 +000011372#endif
11373#ifdef _SC_REALTIME_SIGNALS
Victor Stinner8c62be82010-05-06 00:08:46 +000011374 {"SC_REALTIME_SIGNALS", _SC_REALTIME_SIGNALS},
Fred Drakec9680921999-12-13 16:37:25 +000011375#endif
11376#ifdef _SC_RE_DUP_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011377 {"SC_RE_DUP_MAX", _SC_RE_DUP_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011378#endif
11379#ifdef _SC_RTSIG_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011380 {"SC_RTSIG_MAX", _SC_RTSIG_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011381#endif
11382#ifdef _SC_SAVED_IDS
Victor Stinner8c62be82010-05-06 00:08:46 +000011383 {"SC_SAVED_IDS", _SC_SAVED_IDS},
Fred Drakec9680921999-12-13 16:37:25 +000011384#endif
11385#ifdef _SC_SCHAR_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011386 {"SC_SCHAR_MAX", _SC_SCHAR_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011387#endif
11388#ifdef _SC_SCHAR_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000011389 {"SC_SCHAR_MIN", _SC_SCHAR_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000011390#endif
11391#ifdef _SC_SELECT
Victor Stinner8c62be82010-05-06 00:08:46 +000011392 {"SC_SELECT", _SC_SELECT},
Fred Drakec9680921999-12-13 16:37:25 +000011393#endif
11394#ifdef _SC_SEMAPHORES
Victor Stinner8c62be82010-05-06 00:08:46 +000011395 {"SC_SEMAPHORES", _SC_SEMAPHORES},
Fred Drakec9680921999-12-13 16:37:25 +000011396#endif
11397#ifdef _SC_SEM_NSEMS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011398 {"SC_SEM_NSEMS_MAX", _SC_SEM_NSEMS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011399#endif
11400#ifdef _SC_SEM_VALUE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011401 {"SC_SEM_VALUE_MAX", _SC_SEM_VALUE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011402#endif
11403#ifdef _SC_SHARED_MEMORY_OBJECTS
Victor Stinner8c62be82010-05-06 00:08:46 +000011404 {"SC_SHARED_MEMORY_OBJECTS", _SC_SHARED_MEMORY_OBJECTS},
Fred Drakec9680921999-12-13 16:37:25 +000011405#endif
11406#ifdef _SC_SHRT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011407 {"SC_SHRT_MAX", _SC_SHRT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011408#endif
11409#ifdef _SC_SHRT_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000011410 {"SC_SHRT_MIN", _SC_SHRT_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000011411#endif
11412#ifdef _SC_SIGQUEUE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011413 {"SC_SIGQUEUE_MAX", _SC_SIGQUEUE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011414#endif
11415#ifdef _SC_SIGRT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011416 {"SC_SIGRT_MAX", _SC_SIGRT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011417#endif
11418#ifdef _SC_SIGRT_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000011419 {"SC_SIGRT_MIN", _SC_SIGRT_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000011420#endif
Fred Draked86ed291999-12-15 15:34:33 +000011421#ifdef _SC_SOFTPOWER
Victor Stinner8c62be82010-05-06 00:08:46 +000011422 {"SC_SOFTPOWER", _SC_SOFTPOWER},
Fred Draked86ed291999-12-15 15:34:33 +000011423#endif
Fred Drakec9680921999-12-13 16:37:25 +000011424#ifdef _SC_SPLIT_CACHE
Victor Stinner8c62be82010-05-06 00:08:46 +000011425 {"SC_SPLIT_CACHE", _SC_SPLIT_CACHE},
Fred Drakec9680921999-12-13 16:37:25 +000011426#endif
11427#ifdef _SC_SSIZE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011428 {"SC_SSIZE_MAX", _SC_SSIZE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011429#endif
11430#ifdef _SC_STACK_PROT
Victor Stinner8c62be82010-05-06 00:08:46 +000011431 {"SC_STACK_PROT", _SC_STACK_PROT},
Fred Drakec9680921999-12-13 16:37:25 +000011432#endif
11433#ifdef _SC_STREAM_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011434 {"SC_STREAM_MAX", _SC_STREAM_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011435#endif
11436#ifdef _SC_SYNCHRONIZED_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000011437 {"SC_SYNCHRONIZED_IO", _SC_SYNCHRONIZED_IO},
Fred Drakec9680921999-12-13 16:37:25 +000011438#endif
11439#ifdef _SC_THREADS
Victor Stinner8c62be82010-05-06 00:08:46 +000011440 {"SC_THREADS", _SC_THREADS},
Fred Drakec9680921999-12-13 16:37:25 +000011441#endif
11442#ifdef _SC_THREAD_ATTR_STACKADDR
Victor Stinner8c62be82010-05-06 00:08:46 +000011443 {"SC_THREAD_ATTR_STACKADDR", _SC_THREAD_ATTR_STACKADDR},
Fred Drakec9680921999-12-13 16:37:25 +000011444#endif
11445#ifdef _SC_THREAD_ATTR_STACKSIZE
Victor Stinner8c62be82010-05-06 00:08:46 +000011446 {"SC_THREAD_ATTR_STACKSIZE", _SC_THREAD_ATTR_STACKSIZE},
Fred Drakec9680921999-12-13 16:37:25 +000011447#endif
11448#ifdef _SC_THREAD_DESTRUCTOR_ITERATIONS
Victor Stinner8c62be82010-05-06 00:08:46 +000011449 {"SC_THREAD_DESTRUCTOR_ITERATIONS", _SC_THREAD_DESTRUCTOR_ITERATIONS},
Fred Drakec9680921999-12-13 16:37:25 +000011450#endif
11451#ifdef _SC_THREAD_KEYS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011452 {"SC_THREAD_KEYS_MAX", _SC_THREAD_KEYS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011453#endif
11454#ifdef _SC_THREAD_PRIORITY_SCHEDULING
Victor Stinner8c62be82010-05-06 00:08:46 +000011455 {"SC_THREAD_PRIORITY_SCHEDULING", _SC_THREAD_PRIORITY_SCHEDULING},
Fred Drakec9680921999-12-13 16:37:25 +000011456#endif
11457#ifdef _SC_THREAD_PRIO_INHERIT
Victor Stinner8c62be82010-05-06 00:08:46 +000011458 {"SC_THREAD_PRIO_INHERIT", _SC_THREAD_PRIO_INHERIT},
Fred Drakec9680921999-12-13 16:37:25 +000011459#endif
11460#ifdef _SC_THREAD_PRIO_PROTECT
Victor Stinner8c62be82010-05-06 00:08:46 +000011461 {"SC_THREAD_PRIO_PROTECT", _SC_THREAD_PRIO_PROTECT},
Fred Drakec9680921999-12-13 16:37:25 +000011462#endif
11463#ifdef _SC_THREAD_PROCESS_SHARED
Victor Stinner8c62be82010-05-06 00:08:46 +000011464 {"SC_THREAD_PROCESS_SHARED", _SC_THREAD_PROCESS_SHARED},
Fred Drakec9680921999-12-13 16:37:25 +000011465#endif
11466#ifdef _SC_THREAD_SAFE_FUNCTIONS
Victor Stinner8c62be82010-05-06 00:08:46 +000011467 {"SC_THREAD_SAFE_FUNCTIONS", _SC_THREAD_SAFE_FUNCTIONS},
Fred Drakec9680921999-12-13 16:37:25 +000011468#endif
11469#ifdef _SC_THREAD_STACK_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000011470 {"SC_THREAD_STACK_MIN", _SC_THREAD_STACK_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000011471#endif
11472#ifdef _SC_THREAD_THREADS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011473 {"SC_THREAD_THREADS_MAX", _SC_THREAD_THREADS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011474#endif
11475#ifdef _SC_TIMERS
Victor Stinner8c62be82010-05-06 00:08:46 +000011476 {"SC_TIMERS", _SC_TIMERS},
Fred Drakec9680921999-12-13 16:37:25 +000011477#endif
11478#ifdef _SC_TIMER_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011479 {"SC_TIMER_MAX", _SC_TIMER_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011480#endif
11481#ifdef _SC_TTY_NAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011482 {"SC_TTY_NAME_MAX", _SC_TTY_NAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011483#endif
11484#ifdef _SC_TZNAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011485 {"SC_TZNAME_MAX", _SC_TZNAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011486#endif
11487#ifdef _SC_T_IOV_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011488 {"SC_T_IOV_MAX", _SC_T_IOV_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011489#endif
11490#ifdef _SC_UCHAR_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011491 {"SC_UCHAR_MAX", _SC_UCHAR_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011492#endif
11493#ifdef _SC_UINT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011494 {"SC_UINT_MAX", _SC_UINT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011495#endif
11496#ifdef _SC_UIO_MAXIOV
Victor Stinner8c62be82010-05-06 00:08:46 +000011497 {"SC_UIO_MAXIOV", _SC_UIO_MAXIOV},
Fred Drakec9680921999-12-13 16:37:25 +000011498#endif
11499#ifdef _SC_ULONG_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011500 {"SC_ULONG_MAX", _SC_ULONG_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011501#endif
11502#ifdef _SC_USHRT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011503 {"SC_USHRT_MAX", _SC_USHRT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011504#endif
11505#ifdef _SC_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000011506 {"SC_VERSION", _SC_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000011507#endif
11508#ifdef _SC_WORD_BIT
Victor Stinner8c62be82010-05-06 00:08:46 +000011509 {"SC_WORD_BIT", _SC_WORD_BIT},
Fred Drakec9680921999-12-13 16:37:25 +000011510#endif
11511#ifdef _SC_XBS5_ILP32_OFF32
Victor Stinner8c62be82010-05-06 00:08:46 +000011512 {"SC_XBS5_ILP32_OFF32", _SC_XBS5_ILP32_OFF32},
Fred Drakec9680921999-12-13 16:37:25 +000011513#endif
11514#ifdef _SC_XBS5_ILP32_OFFBIG
Victor Stinner8c62be82010-05-06 00:08:46 +000011515 {"SC_XBS5_ILP32_OFFBIG", _SC_XBS5_ILP32_OFFBIG},
Fred Drakec9680921999-12-13 16:37:25 +000011516#endif
11517#ifdef _SC_XBS5_LP64_OFF64
Victor Stinner8c62be82010-05-06 00:08:46 +000011518 {"SC_XBS5_LP64_OFF64", _SC_XBS5_LP64_OFF64},
Fred Drakec9680921999-12-13 16:37:25 +000011519#endif
11520#ifdef _SC_XBS5_LPBIG_OFFBIG
Victor Stinner8c62be82010-05-06 00:08:46 +000011521 {"SC_XBS5_LPBIG_OFFBIG", _SC_XBS5_LPBIG_OFFBIG},
Fred Drakec9680921999-12-13 16:37:25 +000011522#endif
11523#ifdef _SC_XOPEN_CRYPT
Victor Stinner8c62be82010-05-06 00:08:46 +000011524 {"SC_XOPEN_CRYPT", _SC_XOPEN_CRYPT},
Fred Drakec9680921999-12-13 16:37:25 +000011525#endif
11526#ifdef _SC_XOPEN_ENH_I18N
Victor Stinner8c62be82010-05-06 00:08:46 +000011527 {"SC_XOPEN_ENH_I18N", _SC_XOPEN_ENH_I18N},
Fred Drakec9680921999-12-13 16:37:25 +000011528#endif
11529#ifdef _SC_XOPEN_LEGACY
Victor Stinner8c62be82010-05-06 00:08:46 +000011530 {"SC_XOPEN_LEGACY", _SC_XOPEN_LEGACY},
Fred Drakec9680921999-12-13 16:37:25 +000011531#endif
11532#ifdef _SC_XOPEN_REALTIME
Victor Stinner8c62be82010-05-06 00:08:46 +000011533 {"SC_XOPEN_REALTIME", _SC_XOPEN_REALTIME},
Fred Drakec9680921999-12-13 16:37:25 +000011534#endif
11535#ifdef _SC_XOPEN_REALTIME_THREADS
Victor Stinner8c62be82010-05-06 00:08:46 +000011536 {"SC_XOPEN_REALTIME_THREADS", _SC_XOPEN_REALTIME_THREADS},
Fred Drakec9680921999-12-13 16:37:25 +000011537#endif
11538#ifdef _SC_XOPEN_SHM
Victor Stinner8c62be82010-05-06 00:08:46 +000011539 {"SC_XOPEN_SHM", _SC_XOPEN_SHM},
Fred Drakec9680921999-12-13 16:37:25 +000011540#endif
11541#ifdef _SC_XOPEN_UNIX
Victor Stinner8c62be82010-05-06 00:08:46 +000011542 {"SC_XOPEN_UNIX", _SC_XOPEN_UNIX},
Fred Drakec9680921999-12-13 16:37:25 +000011543#endif
11544#ifdef _SC_XOPEN_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000011545 {"SC_XOPEN_VERSION", _SC_XOPEN_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000011546#endif
11547#ifdef _SC_XOPEN_XCU_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000011548 {"SC_XOPEN_XCU_VERSION", _SC_XOPEN_XCU_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000011549#endif
11550#ifdef _SC_XOPEN_XPG2
Victor Stinner8c62be82010-05-06 00:08:46 +000011551 {"SC_XOPEN_XPG2", _SC_XOPEN_XPG2},
Fred Drakec9680921999-12-13 16:37:25 +000011552#endif
11553#ifdef _SC_XOPEN_XPG3
Victor Stinner8c62be82010-05-06 00:08:46 +000011554 {"SC_XOPEN_XPG3", _SC_XOPEN_XPG3},
Fred Drakec9680921999-12-13 16:37:25 +000011555#endif
11556#ifdef _SC_XOPEN_XPG4
Victor Stinner8c62be82010-05-06 00:08:46 +000011557 {"SC_XOPEN_XPG4", _SC_XOPEN_XPG4},
Fred Drakec9680921999-12-13 16:37:25 +000011558#endif
11559};
11560
11561static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000011562conv_sysconf_confname(PyObject *arg, int *valuep)
Fred Drakec9680921999-12-13 16:37:25 +000011563{
11564 return conv_confname(arg, valuep, posix_constants_sysconf,
11565 sizeof(posix_constants_sysconf)
11566 / sizeof(struct constdef));
11567}
11568
Larry Hastings2f936352014-08-05 14:04:04 +100011569
11570/*[clinic input]
11571os.sysconf -> long
11572 name: sysconf_confname
11573 /
11574
11575Return an integer-valued system configuration variable.
11576[clinic start generated code]*/
11577
Larry Hastings2f936352014-08-05 14:04:04 +100011578static long
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011579os_sysconf_impl(PyObject *module, int name)
11580/*[clinic end generated code: output=3662f945fc0cc756 input=279e3430a33f29e4]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011581{
11582 long value;
11583
11584 errno = 0;
11585 value = sysconf(name);
11586 if (value == -1 && errno != 0)
11587 posix_error();
11588 return value;
11589}
11590#endif /* HAVE_SYSCONF */
Fred Drakec9680921999-12-13 16:37:25 +000011591
11592
Fred Drakebec628d1999-12-15 18:31:10 +000011593/* This code is used to ensure that the tables of configuration value names
Serhiy Storchaka56a6d852014-12-01 18:28:43 +020011594 * are in sorted order as required by conv_confname(), and also to build
Fred Drakebec628d1999-12-15 18:31:10 +000011595 * the exported dictionaries that are used to publish information about the
11596 * names available on the host platform.
11597 *
11598 * Sorting the table at runtime ensures that the table is properly ordered
11599 * when used, even for platforms we're not able to test on. It also makes
11600 * it easier to add additional entries to the tables.
Fred Draked86ed291999-12-15 15:34:33 +000011601 */
Fred Drakebec628d1999-12-15 18:31:10 +000011602
11603static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000011604cmp_constdefs(const void *v1, const void *v2)
Fred Drakebec628d1999-12-15 18:31:10 +000011605{
11606 const struct constdef *c1 =
Victor Stinner8c62be82010-05-06 00:08:46 +000011607 (const struct constdef *) v1;
Fred Drakebec628d1999-12-15 18:31:10 +000011608 const struct constdef *c2 =
Victor Stinner8c62be82010-05-06 00:08:46 +000011609 (const struct constdef *) v2;
Fred Drakebec628d1999-12-15 18:31:10 +000011610
11611 return strcmp(c1->name, c2->name);
11612}
11613
11614static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000011615setup_confname_table(struct constdef *table, size_t tablesize,
Serhiy Storchakadeab18d2016-05-07 16:45:18 +030011616 const char *tablename, PyObject *module)
Fred Draked86ed291999-12-15 15:34:33 +000011617{
Fred Drakebec628d1999-12-15 18:31:10 +000011618 PyObject *d = NULL;
Barry Warsaw3155db32000-04-13 15:20:40 +000011619 size_t i;
Fred Drakebec628d1999-12-15 18:31:10 +000011620
11621 qsort(table, tablesize, sizeof(struct constdef), cmp_constdefs);
11622 d = PyDict_New();
Barry Warsaw3155db32000-04-13 15:20:40 +000011623 if (d == NULL)
Victor Stinner8c62be82010-05-06 00:08:46 +000011624 return -1;
Fred Draked86ed291999-12-15 15:34:33 +000011625
Barry Warsaw3155db32000-04-13 15:20:40 +000011626 for (i=0; i < tablesize; ++i) {
Victor Stinner8c62be82010-05-06 00:08:46 +000011627 PyObject *o = PyLong_FromLong(table[i].value);
11628 if (o == NULL || PyDict_SetItemString(d, table[i].name, o) == -1) {
11629 Py_XDECREF(o);
11630 Py_DECREF(d);
11631 return -1;
11632 }
11633 Py_DECREF(o);
Fred Draked86ed291999-12-15 15:34:33 +000011634 }
Fred Drake4d1e64b2002-04-15 19:40:07 +000011635 return PyModule_AddObject(module, tablename, d);
Fred Draked86ed291999-12-15 15:34:33 +000011636}
11637
Fred Drakebec628d1999-12-15 18:31:10 +000011638/* Return -1 on failure, 0 on success. */
11639static int
Fred Drake4d1e64b2002-04-15 19:40:07 +000011640setup_confname_tables(PyObject *module)
Fred Draked86ed291999-12-15 15:34:33 +000011641{
11642#if defined(HAVE_FPATHCONF) || defined(HAVE_PATHCONF)
Fred Drakebec628d1999-12-15 18:31:10 +000011643 if (setup_confname_table(posix_constants_pathconf,
Fred Draked86ed291999-12-15 15:34:33 +000011644 sizeof(posix_constants_pathconf)
11645 / sizeof(struct constdef),
Fred Drake4d1e64b2002-04-15 19:40:07 +000011646 "pathconf_names", module))
Stefan Krah0e803b32010-11-26 16:16:47 +000011647 return -1;
Fred Draked86ed291999-12-15 15:34:33 +000011648#endif
11649#ifdef HAVE_CONFSTR
Fred Drakebec628d1999-12-15 18:31:10 +000011650 if (setup_confname_table(posix_constants_confstr,
Fred Draked86ed291999-12-15 15:34:33 +000011651 sizeof(posix_constants_confstr)
11652 / sizeof(struct constdef),
Fred Drake4d1e64b2002-04-15 19:40:07 +000011653 "confstr_names", module))
Stefan Krah0e803b32010-11-26 16:16:47 +000011654 return -1;
Fred Draked86ed291999-12-15 15:34:33 +000011655#endif
11656#ifdef HAVE_SYSCONF
Fred Drakebec628d1999-12-15 18:31:10 +000011657 if (setup_confname_table(posix_constants_sysconf,
Fred Draked86ed291999-12-15 15:34:33 +000011658 sizeof(posix_constants_sysconf)
11659 / sizeof(struct constdef),
Fred Drake4d1e64b2002-04-15 19:40:07 +000011660 "sysconf_names", module))
Stefan Krah0e803b32010-11-26 16:16:47 +000011661 return -1;
Fred Draked86ed291999-12-15 15:34:33 +000011662#endif
Fred Drakebec628d1999-12-15 18:31:10 +000011663 return 0;
Fred Draked86ed291999-12-15 15:34:33 +000011664}
Fred Draked86ed291999-12-15 15:34:33 +000011665
11666
Larry Hastings2f936352014-08-05 14:04:04 +100011667/*[clinic input]
11668os.abort
11669
11670Abort the interpreter immediately.
11671
11672This function 'dumps core' or otherwise fails in the hardest way possible
11673on the hosting operating system. This function never returns.
11674[clinic start generated code]*/
11675
Larry Hastings2f936352014-08-05 14:04:04 +100011676static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011677os_abort_impl(PyObject *module)
11678/*[clinic end generated code: output=dcf52586dad2467c input=cf2c7d98bc504047]*/
Fred Drake5ab8eaf1999-12-09 21:13:07 +000011679{
Fred Drake5ab8eaf1999-12-09 21:13:07 +000011680 abort();
11681 /*NOTREACHED*/
Victor Stinner9a2329f2016-12-05 17:56:36 +010011682#ifndef __clang__
11683 /* Issue #28152: abort() is declared with __attribute__((__noreturn__)).
11684 GCC emits a warning without "return NULL;" (compiler bug?), but Clang
11685 is smarter and emits a warning on the return. */
Fred Drake5ab8eaf1999-12-09 21:13:07 +000011686 Py_FatalError("abort() called from Python code didn't abort!");
11687 return NULL;
Victor Stinner9a2329f2016-12-05 17:56:36 +010011688#endif
Fred Drake5ab8eaf1999-12-09 21:13:07 +000011689}
Fred Drakebec628d1999-12-15 18:31:10 +000011690
Martin v. Löwis6238d2b2002-06-30 15:26:10 +000011691#ifdef MS_WINDOWS
Steve Dower7d0e0c92015-01-24 08:18:24 -080011692/* Grab ShellExecute dynamically from shell32 */
11693static int has_ShellExecute = -1;
Steve Dower7d0e0c92015-01-24 08:18:24 -080011694static HINSTANCE (CALLBACK *Py_ShellExecuteW)(HWND, LPCWSTR, LPCWSTR, LPCWSTR,
11695 LPCWSTR, INT);
11696static int
11697check_ShellExecute()
11698{
11699 HINSTANCE hShell32;
11700
11701 /* only recheck */
11702 if (-1 == has_ShellExecute) {
11703 Py_BEGIN_ALLOW_THREADS
Victor Stinnera9912152017-10-13 13:46:57 -070011704 /* Security note: this call is not vulnerable to "DLL hijacking".
11705 SHELL32 is part of "KnownDLLs" and so Windows always load
11706 the system SHELL32.DLL, even if there is another SHELL32.DLL
11707 in the DLL search path. */
Steve Dower7d0e0c92015-01-24 08:18:24 -080011708 hShell32 = LoadLibraryW(L"SHELL32");
Steve Dower7d0e0c92015-01-24 08:18:24 -080011709 if (hShell32) {
Steve Dower7d0e0c92015-01-24 08:18:24 -080011710 *(FARPROC*)&Py_ShellExecuteW = GetProcAddress(hShell32,
11711 "ShellExecuteW");
Steve Dowercc16be82016-09-08 10:35:16 -070011712 has_ShellExecute = Py_ShellExecuteW != NULL;
Steve Dower7d0e0c92015-01-24 08:18:24 -080011713 } else {
11714 has_ShellExecute = 0;
11715 }
Tony Roberts4860f012019-02-02 18:16:42 +010011716 Py_END_ALLOW_THREADS
Steve Dower7d0e0c92015-01-24 08:18:24 -080011717 }
11718 return has_ShellExecute;
11719}
11720
11721
Steve Dowercc16be82016-09-08 10:35:16 -070011722/*[clinic input]
11723os.startfile
11724 filepath: path_t
11725 operation: Py_UNICODE = NULL
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +000011726
Steve Dowercc16be82016-09-08 10:35:16 -070011727Start a file with its associated application.
11728
11729When "operation" is not specified or "open", this acts like
11730double-clicking the file in Explorer, or giving the file name as an
11731argument to the DOS "start" command: the file is opened with whatever
11732application (if any) its extension is associated.
11733When another "operation" is given, it specifies what should be done with
11734the file. A typical operation is "print".
11735
11736startfile returns as soon as the associated application is launched.
11737There is no option to wait for the application to close, and no way
11738to retrieve the application's exit status.
11739
11740The filepath is relative to the current directory. If you want to use
11741an absolute path, make sure the first character is not a slash ("/");
11742the underlying Win32 ShellExecute function doesn't work if it is.
11743[clinic start generated code]*/
11744
11745static PyObject *
Serhiy Storchakaafb3e712018-12-14 11:19:51 +020011746os_startfile_impl(PyObject *module, path_t *filepath,
11747 const Py_UNICODE *operation)
Serhiy Storchakad322abb2019-09-14 13:31:50 +030011748/*[clinic end generated code: output=66dc311c94d50797 input=c940888a5390f039]*/
Steve Dowercc16be82016-09-08 10:35:16 -070011749{
11750 HINSTANCE rc;
Steve Dower7d0e0c92015-01-24 08:18:24 -080011751
11752 if(!check_ShellExecute()) {
11753 /* If the OS doesn't have ShellExecute, return a
11754 NotImplementedError. */
11755 return PyErr_Format(PyExc_NotImplementedError,
11756 "startfile not available on this platform");
11757 }
11758
Steve Dowera00b5be2020-02-13 08:30:27 +000011759 if (PySys_Audit("os.startfile", "Ou", filepath->object, operation) < 0) {
Miss Islington (bot)3498ac52020-02-04 16:32:32 -080011760 return NULL;
11761 }
11762
Victor Stinner8c62be82010-05-06 00:08:46 +000011763 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -070011764 rc = Py_ShellExecuteW((HWND)0, operation, filepath->wide,
Steve Dower7d0e0c92015-01-24 08:18:24 -080011765 NULL, NULL, SW_SHOWNORMAL);
Victor Stinner8c62be82010-05-06 00:08:46 +000011766 Py_END_ALLOW_THREADS
11767
Victor Stinner8c62be82010-05-06 00:08:46 +000011768 if (rc <= (HINSTANCE)32) {
Steve Dowercc16be82016-09-08 10:35:16 -070011769 win32_error_object("startfile", filepath->object);
Victor Stinnereb5657a2011-09-30 01:44:27 +020011770 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +000011771 }
Steve Dowercc16be82016-09-08 10:35:16 -070011772 Py_RETURN_NONE;
Tim Petersf58a7aa2000-09-22 10:05:54 +000011773}
Larry Hastings2f936352014-08-05 14:04:04 +100011774#endif /* MS_WINDOWS */
11775
Fred Drake5ab8eaf1999-12-09 21:13:07 +000011776
Martin v. Löwis438b5342002-12-27 10:16:42 +000011777#ifdef HAVE_GETLOADAVG
Larry Hastings2f936352014-08-05 14:04:04 +100011778/*[clinic input]
11779os.getloadavg
11780
11781Return average recent system load information.
11782
11783Return the number of processes in the system run queue averaged over
11784the last 1, 5, and 15 minutes as a tuple of three floats.
11785Raises OSError if the load average was unobtainable.
11786[clinic start generated code]*/
11787
Larry Hastings2f936352014-08-05 14:04:04 +100011788static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011789os_getloadavg_impl(PyObject *module)
11790/*[clinic end generated code: output=9ad3a11bfb4f4bd2 input=3d6d826b76d8a34e]*/
Martin v. Löwis438b5342002-12-27 10:16:42 +000011791{
11792 double loadavg[3];
Martin v. Löwis438b5342002-12-27 10:16:42 +000011793 if (getloadavg(loadavg, 3)!=3) {
Stefan Krah0e803b32010-11-26 16:16:47 +000011794 PyErr_SetString(PyExc_OSError, "Load averages are unobtainable");
11795 return NULL;
Martin v. Löwis438b5342002-12-27 10:16:42 +000011796 } else
Stefan Krah0e803b32010-11-26 16:16:47 +000011797 return Py_BuildValue("ddd", loadavg[0], loadavg[1], loadavg[2]);
Martin v. Löwis438b5342002-12-27 10:16:42 +000011798}
Larry Hastings2f936352014-08-05 14:04:04 +100011799#endif /* HAVE_GETLOADAVG */
Martin v. Löwis438b5342002-12-27 10:16:42 +000011800
Larry Hastings2f936352014-08-05 14:04:04 +100011801
11802/*[clinic input]
11803os.device_encoding
11804 fd: int
11805
11806Return a string describing the encoding of a terminal's file descriptor.
11807
11808The file descriptor must be attached to a terminal.
11809If the device is not a terminal, return None.
11810[clinic start generated code]*/
11811
Larry Hastings2f936352014-08-05 14:04:04 +100011812static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011813os_device_encoding_impl(PyObject *module, int fd)
11814/*[clinic end generated code: output=e0d294bbab7e8c2b input=9e1d4a42b66df312]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011815{
Brett Cannonefb00c02012-02-29 18:31:31 -050011816 return _Py_device_encoding(fd);
Martin v. Löwisd1cd4d42007-08-11 14:02:14 +000011817}
11818
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011819
Larry Hastings2f936352014-08-05 14:04:04 +100011820#ifdef HAVE_SETRESUID
11821/*[clinic input]
11822os.setresuid
11823
11824 ruid: uid_t
11825 euid: uid_t
11826 suid: uid_t
11827 /
11828
11829Set the current process's real, effective, and saved user ids.
11830[clinic start generated code]*/
11831
Larry Hastings2f936352014-08-05 14:04:04 +100011832static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011833os_setresuid_impl(PyObject *module, uid_t ruid, uid_t euid, uid_t suid)
11834/*[clinic end generated code: output=834a641e15373e97 input=9e33cb79a82792f3]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011835{
Victor Stinner8c62be82010-05-06 00:08:46 +000011836 if (setresuid(ruid, euid, suid) < 0)
11837 return posix_error();
11838 Py_RETURN_NONE;
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011839}
Larry Hastings2f936352014-08-05 14:04:04 +100011840#endif /* HAVE_SETRESUID */
11841
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011842
11843#ifdef HAVE_SETRESGID
Larry Hastings2f936352014-08-05 14:04:04 +100011844/*[clinic input]
11845os.setresgid
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011846
Larry Hastings2f936352014-08-05 14:04:04 +100011847 rgid: gid_t
11848 egid: gid_t
11849 sgid: gid_t
11850 /
11851
11852Set the current process's real, effective, and saved group ids.
11853[clinic start generated code]*/
11854
Larry Hastings2f936352014-08-05 14:04:04 +100011855static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011856os_setresgid_impl(PyObject *module, gid_t rgid, gid_t egid, gid_t sgid)
11857/*[clinic end generated code: output=6aa402f3d2e514a9 input=33e9e0785ef426b1]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011858{
Victor Stinner8c62be82010-05-06 00:08:46 +000011859 if (setresgid(rgid, egid, sgid) < 0)
11860 return posix_error();
11861 Py_RETURN_NONE;
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011862}
Larry Hastings2f936352014-08-05 14:04:04 +100011863#endif /* HAVE_SETRESGID */
11864
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011865
11866#ifdef HAVE_GETRESUID
Larry Hastings2f936352014-08-05 14:04:04 +100011867/*[clinic input]
11868os.getresuid
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011869
Larry Hastings2f936352014-08-05 14:04:04 +100011870Return a tuple of the current process's real, effective, and saved user ids.
11871[clinic start generated code]*/
11872
Larry Hastings2f936352014-08-05 14:04:04 +100011873static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011874os_getresuid_impl(PyObject *module)
11875/*[clinic end generated code: output=8e0becff5dece5bf input=41ccfa8e1f6517ad]*/
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011876{
Victor Stinner8c62be82010-05-06 00:08:46 +000011877 uid_t ruid, euid, suid;
Victor Stinner8c62be82010-05-06 00:08:46 +000011878 if (getresuid(&ruid, &euid, &suid) < 0)
11879 return posix_error();
Serhiy Storchaka7cf55992013-02-10 21:56:49 +020011880 return Py_BuildValue("(NNN)", _PyLong_FromUid(ruid),
11881 _PyLong_FromUid(euid),
11882 _PyLong_FromUid(suid));
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011883}
Larry Hastings2f936352014-08-05 14:04:04 +100011884#endif /* HAVE_GETRESUID */
11885
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011886
11887#ifdef HAVE_GETRESGID
Larry Hastings2f936352014-08-05 14:04:04 +100011888/*[clinic input]
11889os.getresgid
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011890
Larry Hastings2f936352014-08-05 14:04:04 +100011891Return a tuple of the current process's real, effective, and saved group ids.
11892[clinic start generated code]*/
11893
Larry Hastings2f936352014-08-05 14:04:04 +100011894static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011895os_getresgid_impl(PyObject *module)
11896/*[clinic end generated code: output=2719c4bfcf27fb9f input=517e68db9ca32df6]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011897{
11898 gid_t rgid, egid, sgid;
Victor Stinner8c62be82010-05-06 00:08:46 +000011899 if (getresgid(&rgid, &egid, &sgid) < 0)
11900 return posix_error();
Serhiy Storchaka7cf55992013-02-10 21:56:49 +020011901 return Py_BuildValue("(NNN)", _PyLong_FromGid(rgid),
11902 _PyLong_FromGid(egid),
11903 _PyLong_FromGid(sgid));
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011904}
Larry Hastings2f936352014-08-05 14:04:04 +100011905#endif /* HAVE_GETRESGID */
11906
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011907
Benjamin Peterson9428d532011-09-14 11:45:52 -040011908#ifdef USE_XATTRS
Larry Hastings2f936352014-08-05 14:04:04 +100011909/*[clinic input]
11910os.getxattr
Benjamin Peterson799bd802011-08-31 22:15:17 -040011911
Larry Hastings2f936352014-08-05 14:04:04 +100011912 path: path_t(allow_fd=True)
11913 attribute: path_t
11914 *
11915 follow_symlinks: bool = True
11916
11917Return the value of extended attribute attribute on path.
11918
BNMetricsb9427072018-11-02 15:20:19 +000011919path may be either a string, a path-like object, or an open file descriptor.
Larry Hastings2f936352014-08-05 14:04:04 +100011920If follow_symlinks is False, and the last element of the path is a symbolic
11921 link, getxattr will examine the symbolic link itself instead of the file
11922 the link points to.
11923
11924[clinic start generated code]*/
11925
Larry Hastings2f936352014-08-05 14:04:04 +100011926static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011927os_getxattr_impl(PyObject *module, path_t *path, path_t *attribute,
Larry Hastings89964c42015-04-14 18:07:59 -040011928 int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +000011929/*[clinic end generated code: output=5f2f44200a43cff2 input=025789491708f7eb]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011930{
11931 Py_ssize_t i;
11932 PyObject *buffer = NULL;
11933
11934 if (fd_and_follow_symlinks_invalid("getxattr", path->fd, follow_symlinks))
11935 return NULL;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011936
Steve Dowera00b5be2020-02-13 08:30:27 +000011937 if (PySys_Audit("os.getxattr", "OO", path->object, attribute->object) < 0) {
11938 return NULL;
11939 }
11940
Larry Hastings9cf065c2012-06-22 16:30:09 -070011941 for (i = 0; ; i++) {
11942 void *ptr;
11943 ssize_t result;
Serhiy Storchaka2d06e842015-12-25 19:53:18 +020011944 static const Py_ssize_t buffer_sizes[] = {128, XATTR_SIZE_MAX, 0};
Larry Hastings9cf065c2012-06-22 16:30:09 -070011945 Py_ssize_t buffer_size = buffer_sizes[i];
11946 if (!buffer_size) {
Larry Hastings2f936352014-08-05 14:04:04 +100011947 path_error(path);
11948 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070011949 }
11950 buffer = PyBytes_FromStringAndSize(NULL, buffer_size);
11951 if (!buffer)
Larry Hastings2f936352014-08-05 14:04:04 +100011952 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070011953 ptr = PyBytes_AS_STRING(buffer);
Benjamin Peterson799bd802011-08-31 22:15:17 -040011954
Larry Hastings9cf065c2012-06-22 16:30:09 -070011955 Py_BEGIN_ALLOW_THREADS;
Larry Hastings2f936352014-08-05 14:04:04 +100011956 if (path->fd >= 0)
11957 result = fgetxattr(path->fd, attribute->narrow, ptr, buffer_size);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011958 else if (follow_symlinks)
Larry Hastings2f936352014-08-05 14:04:04 +100011959 result = getxattr(path->narrow, attribute->narrow, ptr, buffer_size);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011960 else
Larry Hastings2f936352014-08-05 14:04:04 +100011961 result = lgetxattr(path->narrow, attribute->narrow, ptr, buffer_size);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011962 Py_END_ALLOW_THREADS;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011963
Larry Hastings9cf065c2012-06-22 16:30:09 -070011964 if (result < 0) {
11965 Py_DECREF(buffer);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011966 if (errno == ERANGE)
11967 continue;
Larry Hastings2f936352014-08-05 14:04:04 +100011968 path_error(path);
11969 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070011970 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040011971
Larry Hastings9cf065c2012-06-22 16:30:09 -070011972 if (result != buffer_size) {
11973 /* Can only shrink. */
11974 _PyBytes_Resize(&buffer, result);
11975 }
11976 break;
11977 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040011978
Larry Hastings9cf065c2012-06-22 16:30:09 -070011979 return buffer;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011980}
11981
Larry Hastings2f936352014-08-05 14:04:04 +100011982
11983/*[clinic input]
11984os.setxattr
11985
11986 path: path_t(allow_fd=True)
11987 attribute: path_t
11988 value: Py_buffer
11989 flags: int = 0
11990 *
11991 follow_symlinks: bool = True
11992
11993Set extended attribute attribute on path to value.
11994
BNMetricsb9427072018-11-02 15:20:19 +000011995path may be either a string, a path-like object, or an open file descriptor.
Larry Hastings2f936352014-08-05 14:04:04 +100011996If follow_symlinks is False, and the last element of the path is a symbolic
11997 link, setxattr will modify the symbolic link itself instead of the file
11998 the link points to.
11999
12000[clinic start generated code]*/
12001
Benjamin Peterson799bd802011-08-31 22:15:17 -040012002static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012003os_setxattr_impl(PyObject *module, path_t *path, path_t *attribute,
Larry Hastings89964c42015-04-14 18:07:59 -040012004 Py_buffer *value, int flags, int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +000012005/*[clinic end generated code: output=98b83f63fdde26bb input=c17c0103009042f0]*/
Benjamin Peterson799bd802011-08-31 22:15:17 -040012006{
Larry Hastings2f936352014-08-05 14:04:04 +100012007 ssize_t result;
Benjamin Peterson799bd802011-08-31 22:15:17 -040012008
Larry Hastings2f936352014-08-05 14:04:04 +100012009 if (fd_and_follow_symlinks_invalid("setxattr", path->fd, follow_symlinks))
Benjamin Peterson799bd802011-08-31 22:15:17 -040012010 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070012011
Steve Dowera00b5be2020-02-13 08:30:27 +000012012 if (PySys_Audit("os.setxattr", "OOy#i", path->object, attribute->object,
12013 value->buf, value->len, flags) < 0) {
12014 return NULL;
12015 }
12016
Benjamin Peterson799bd802011-08-31 22:15:17 -040012017 Py_BEGIN_ALLOW_THREADS;
Larry Hastings2f936352014-08-05 14:04:04 +100012018 if (path->fd > -1)
12019 result = fsetxattr(path->fd, attribute->narrow,
12020 value->buf, value->len, flags);
Larry Hastings9cf065c2012-06-22 16:30:09 -070012021 else if (follow_symlinks)
Larry Hastings2f936352014-08-05 14:04:04 +100012022 result = setxattr(path->narrow, attribute->narrow,
12023 value->buf, value->len, flags);
Larry Hastings9cf065c2012-06-22 16:30:09 -070012024 else
Larry Hastings2f936352014-08-05 14:04:04 +100012025 result = lsetxattr(path->narrow, attribute->narrow,
12026 value->buf, value->len, flags);
Benjamin Peterson799bd802011-08-31 22:15:17 -040012027 Py_END_ALLOW_THREADS;
Benjamin Peterson799bd802011-08-31 22:15:17 -040012028
Larry Hastings9cf065c2012-06-22 16:30:09 -070012029 if (result) {
Larry Hastings2f936352014-08-05 14:04:04 +100012030 path_error(path);
12031 return NULL;
Benjamin Peterson799bd802011-08-31 22:15:17 -040012032 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040012033
Larry Hastings2f936352014-08-05 14:04:04 +100012034 Py_RETURN_NONE;
12035}
12036
12037
12038/*[clinic input]
12039os.removexattr
12040
12041 path: path_t(allow_fd=True)
12042 attribute: path_t
12043 *
12044 follow_symlinks: bool = True
12045
12046Remove extended attribute attribute on path.
12047
BNMetricsb9427072018-11-02 15:20:19 +000012048path may be either a string, a path-like object, or an open file descriptor.
Larry Hastings2f936352014-08-05 14:04:04 +100012049If follow_symlinks is False, and the last element of the path is a symbolic
12050 link, removexattr will modify the symbolic link itself instead of the file
12051 the link points to.
12052
12053[clinic start generated code]*/
12054
Larry Hastings2f936352014-08-05 14:04:04 +100012055static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012056os_removexattr_impl(PyObject *module, path_t *path, path_t *attribute,
Larry Hastings89964c42015-04-14 18:07:59 -040012057 int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +000012058/*[clinic end generated code: output=521a51817980cda6 input=3d9a7d36fe2f7c4e]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012059{
12060 ssize_t result;
12061
12062 if (fd_and_follow_symlinks_invalid("removexattr", path->fd, follow_symlinks))
12063 return NULL;
12064
Steve Dowera00b5be2020-02-13 08:30:27 +000012065 if (PySys_Audit("os.removexattr", "OO", path->object, attribute->object) < 0) {
12066 return NULL;
12067 }
12068
Larry Hastings2f936352014-08-05 14:04:04 +100012069 Py_BEGIN_ALLOW_THREADS;
12070 if (path->fd > -1)
12071 result = fremovexattr(path->fd, attribute->narrow);
12072 else if (follow_symlinks)
12073 result = removexattr(path->narrow, attribute->narrow);
12074 else
12075 result = lremovexattr(path->narrow, attribute->narrow);
12076 Py_END_ALLOW_THREADS;
12077
12078 if (result) {
12079 return path_error(path);
12080 }
12081
12082 Py_RETURN_NONE;
12083}
12084
12085
12086/*[clinic input]
12087os.listxattr
12088
12089 path: path_t(allow_fd=True, nullable=True) = None
12090 *
12091 follow_symlinks: bool = True
12092
12093Return a list of extended attributes on path.
12094
BNMetricsb9427072018-11-02 15:20:19 +000012095path may be either None, a string, a path-like object, or an open file descriptor.
Larry Hastings2f936352014-08-05 14:04:04 +100012096if path is None, listxattr will examine the current directory.
12097If follow_symlinks is False, and the last element of the path is a symbolic
12098 link, listxattr will examine the symbolic link itself instead of the file
12099 the link points to.
12100[clinic start generated code]*/
12101
Larry Hastings2f936352014-08-05 14:04:04 +100012102static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012103os_listxattr_impl(PyObject *module, path_t *path, int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +000012104/*[clinic end generated code: output=bebdb4e2ad0ce435 input=9826edf9fdb90869]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012105{
Larry Hastings9cf065c2012-06-22 16:30:09 -070012106 Py_ssize_t i;
12107 PyObject *result = NULL;
Larry Hastings2f936352014-08-05 14:04:04 +100012108 const char *name;
Larry Hastings9cf065c2012-06-22 16:30:09 -070012109 char *buffer = NULL;
Benjamin Peterson799bd802011-08-31 22:15:17 -040012110
Larry Hastings2f936352014-08-05 14:04:04 +100012111 if (fd_and_follow_symlinks_invalid("listxattr", path->fd, follow_symlinks))
Larry Hastings9cf065c2012-06-22 16:30:09 -070012112 goto exit;
Benjamin Peterson799bd802011-08-31 22:15:17 -040012113
Steve Dowera00b5be2020-02-13 08:30:27 +000012114 if (PySys_Audit("os.listxattr", "(O)",
12115 path->object ? path->object : Py_None) < 0) {
12116 return NULL;
12117 }
12118
Larry Hastings2f936352014-08-05 14:04:04 +100012119 name = path->narrow ? path->narrow : ".";
12120
Larry Hastings9cf065c2012-06-22 16:30:09 -070012121 for (i = 0; ; i++) {
Serhiy Storchakadeab18d2016-05-07 16:45:18 +030012122 const char *start, *trace, *end;
Larry Hastings9cf065c2012-06-22 16:30:09 -070012123 ssize_t length;
Serhiy Storchaka2d06e842015-12-25 19:53:18 +020012124 static const Py_ssize_t buffer_sizes[] = { 256, XATTR_LIST_MAX, 0 };
Larry Hastings9cf065c2012-06-22 16:30:09 -070012125 Py_ssize_t buffer_size = buffer_sizes[i];
12126 if (!buffer_size) {
Christian Heimes3b9493b2012-09-23 16:11:15 +020012127 /* ERANGE */
Larry Hastings2f936352014-08-05 14:04:04 +100012128 path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -070012129 break;
12130 }
12131 buffer = PyMem_MALLOC(buffer_size);
12132 if (!buffer) {
12133 PyErr_NoMemory();
12134 break;
12135 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040012136
Larry Hastings9cf065c2012-06-22 16:30:09 -070012137 Py_BEGIN_ALLOW_THREADS;
Larry Hastings2f936352014-08-05 14:04:04 +100012138 if (path->fd > -1)
12139 length = flistxattr(path->fd, buffer, buffer_size);
Larry Hastings9cf065c2012-06-22 16:30:09 -070012140 else if (follow_symlinks)
12141 length = listxattr(name, buffer, buffer_size);
12142 else
12143 length = llistxattr(name, buffer, buffer_size);
12144 Py_END_ALLOW_THREADS;
Benjamin Peterson799bd802011-08-31 22:15:17 -040012145
Larry Hastings9cf065c2012-06-22 16:30:09 -070012146 if (length < 0) {
Antoine Pitrou7f987392013-05-13 19:46:29 +020012147 if (errno == ERANGE) {
12148 PyMem_FREE(buffer);
Benjamin Petersondedac522013-05-13 19:55:40 -050012149 buffer = NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070012150 continue;
Antoine Pitrou7f987392013-05-13 19:46:29 +020012151 }
Larry Hastings2f936352014-08-05 14:04:04 +100012152 path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -070012153 break;
12154 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040012155
Larry Hastings9cf065c2012-06-22 16:30:09 -070012156 result = PyList_New(0);
12157 if (!result) {
12158 goto exit;
12159 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040012160
Larry Hastings9cf065c2012-06-22 16:30:09 -070012161 end = buffer + length;
12162 for (trace = start = buffer; trace != end; trace++) {
12163 if (!*trace) {
12164 int error;
12165 PyObject *attribute = PyUnicode_DecodeFSDefaultAndSize(start,
12166 trace - start);
12167 if (!attribute) {
12168 Py_DECREF(result);
12169 result = NULL;
12170 goto exit;
12171 }
12172 error = PyList_Append(result, attribute);
12173 Py_DECREF(attribute);
12174 if (error) {
12175 Py_DECREF(result);
12176 result = NULL;
12177 goto exit;
12178 }
12179 start = trace + 1;
12180 }
12181 }
12182 break;
12183 }
12184exit:
Larry Hastings9cf065c2012-06-22 16:30:09 -070012185 if (buffer)
12186 PyMem_FREE(buffer);
12187 return result;
Benjamin Peterson799bd802011-08-31 22:15:17 -040012188}
Benjamin Peterson9428d532011-09-14 11:45:52 -040012189#endif /* USE_XATTRS */
Benjamin Peterson799bd802011-08-31 22:15:17 -040012190
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012191
Larry Hastings2f936352014-08-05 14:04:04 +100012192/*[clinic input]
12193os.urandom
12194
12195 size: Py_ssize_t
12196 /
12197
12198Return a bytes object containing random bytes suitable for cryptographic use.
12199[clinic start generated code]*/
12200
Larry Hastings2f936352014-08-05 14:04:04 +100012201static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012202os_urandom_impl(PyObject *module, Py_ssize_t size)
12203/*[clinic end generated code: output=42c5cca9d18068e9 input=4067cdb1b6776c29]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012204{
12205 PyObject *bytes;
12206 int result;
12207
Georg Brandl2fb477c2012-02-21 00:33:36 +010012208 if (size < 0)
12209 return PyErr_Format(PyExc_ValueError,
12210 "negative argument not allowed");
Larry Hastings2f936352014-08-05 14:04:04 +100012211 bytes = PyBytes_FromStringAndSize(NULL, size);
12212 if (bytes == NULL)
Georg Brandl2fb477c2012-02-21 00:33:36 +010012213 return NULL;
12214
Victor Stinnere66987e2016-09-06 16:33:52 -070012215 result = _PyOS_URandom(PyBytes_AS_STRING(bytes), PyBytes_GET_SIZE(bytes));
Larry Hastings2f936352014-08-05 14:04:04 +100012216 if (result == -1) {
12217 Py_DECREF(bytes);
Georg Brandl2fb477c2012-02-21 00:33:36 +010012218 return NULL;
12219 }
Larry Hastings2f936352014-08-05 14:04:04 +100012220 return bytes;
Georg Brandl2fb477c2012-02-21 00:33:36 +010012221}
12222
Zackery Spytz43fdbd22019-05-29 13:57:07 -060012223#ifdef HAVE_MEMFD_CREATE
12224/*[clinic input]
12225os.memfd_create
12226
12227 name: FSConverter
12228 flags: unsigned_int(bitwise=True, c_default="MFD_CLOEXEC") = MFD_CLOEXEC
12229
12230[clinic start generated code]*/
12231
12232static PyObject *
12233os_memfd_create_impl(PyObject *module, PyObject *name, unsigned int flags)
12234/*[clinic end generated code: output=6681ede983bdb9a6 input=a42cfc199bcd56e9]*/
12235{
12236 int fd;
12237 const char *bytes = PyBytes_AS_STRING(name);
12238 Py_BEGIN_ALLOW_THREADS
12239 fd = memfd_create(bytes, flags);
12240 Py_END_ALLOW_THREADS
12241 if (fd == -1) {
12242 return PyErr_SetFromErrno(PyExc_OSError);
12243 }
12244 return PyLong_FromLong(fd);
12245}
12246#endif
12247
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012248/* Terminal size querying */
12249
Eddie Elizondo474eedf2018-11-13 04:09:31 -080012250static PyTypeObject* TerminalSizeType;
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012251
12252PyDoc_STRVAR(TerminalSize_docstring,
12253 "A tuple of (columns, lines) for holding terminal window size");
12254
12255static PyStructSequence_Field TerminalSize_fields[] = {
12256 {"columns", "width of the terminal window in characters"},
12257 {"lines", "height of the terminal window in characters"},
12258 {NULL, NULL}
12259};
12260
12261static PyStructSequence_Desc TerminalSize_desc = {
12262 "os.terminal_size",
12263 TerminalSize_docstring,
12264 TerminalSize_fields,
12265 2,
12266};
12267
12268#if defined(TERMSIZE_USE_CONIO) || defined(TERMSIZE_USE_IOCTL)
Larry Hastings2f936352014-08-05 14:04:04 +100012269/* AC 3.5: fd should accept None */
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012270PyDoc_STRVAR(termsize__doc__,
12271 "Return the size of the terminal window as (columns, lines).\n" \
12272 "\n" \
12273 "The optional argument fd (default standard output) specifies\n" \
12274 "which file descriptor should be queried.\n" \
12275 "\n" \
12276 "If the file descriptor is not connected to a terminal, an OSError\n" \
12277 "is thrown.\n" \
12278 "\n" \
12279 "This function will only be defined if an implementation is\n" \
12280 "available for this system.\n" \
12281 "\n" \
oldkaa0735f2018-02-02 16:52:55 +080012282 "shutil.get_terminal_size is the high-level function which should\n" \
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012283 "normally be used, os.get_terminal_size is the low-level implementation.");
12284
12285static PyObject*
12286get_terminal_size(PyObject *self, PyObject *args)
12287{
12288 int columns, lines;
12289 PyObject *termsize;
12290
12291 int fd = fileno(stdout);
12292 /* Under some conditions stdout may not be connected and
12293 * fileno(stdout) may point to an invalid file descriptor. For example
12294 * GUI apps don't have valid standard streams by default.
12295 *
12296 * If this happens, and the optional fd argument is not present,
12297 * the ioctl below will fail returning EBADF. This is what we want.
12298 */
12299
12300 if (!PyArg_ParseTuple(args, "|i", &fd))
12301 return NULL;
12302
12303#ifdef TERMSIZE_USE_IOCTL
12304 {
12305 struct winsize w;
12306 if (ioctl(fd, TIOCGWINSZ, &w))
12307 return PyErr_SetFromErrno(PyExc_OSError);
12308 columns = w.ws_col;
12309 lines = w.ws_row;
12310 }
12311#endif /* TERMSIZE_USE_IOCTL */
12312
12313#ifdef TERMSIZE_USE_CONIO
12314 {
12315 DWORD nhandle;
12316 HANDLE handle;
12317 CONSOLE_SCREEN_BUFFER_INFO csbi;
12318 switch (fd) {
12319 case 0: nhandle = STD_INPUT_HANDLE;
12320 break;
12321 case 1: nhandle = STD_OUTPUT_HANDLE;
12322 break;
12323 case 2: nhandle = STD_ERROR_HANDLE;
12324 break;
12325 default:
12326 return PyErr_Format(PyExc_ValueError, "bad file descriptor");
12327 }
12328 handle = GetStdHandle(nhandle);
12329 if (handle == NULL)
12330 return PyErr_Format(PyExc_OSError, "handle cannot be retrieved");
12331 if (handle == INVALID_HANDLE_VALUE)
12332 return PyErr_SetFromWindowsErr(0);
12333
12334 if (!GetConsoleScreenBufferInfo(handle, &csbi))
12335 return PyErr_SetFromWindowsErr(0);
12336
12337 columns = csbi.srWindow.Right - csbi.srWindow.Left + 1;
12338 lines = csbi.srWindow.Bottom - csbi.srWindow.Top + 1;
12339 }
12340#endif /* TERMSIZE_USE_CONIO */
12341
Eddie Elizondo474eedf2018-11-13 04:09:31 -080012342 termsize = PyStructSequence_New(TerminalSizeType);
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012343 if (termsize == NULL)
12344 return NULL;
12345 PyStructSequence_SET_ITEM(termsize, 0, PyLong_FromLong(columns));
12346 PyStructSequence_SET_ITEM(termsize, 1, PyLong_FromLong(lines));
12347 if (PyErr_Occurred()) {
12348 Py_DECREF(termsize);
12349 return NULL;
12350 }
12351 return termsize;
12352}
12353#endif /* defined(TERMSIZE_USE_CONIO) || defined(TERMSIZE_USE_IOCTL) */
12354
Larry Hastings2f936352014-08-05 14:04:04 +100012355
12356/*[clinic input]
12357os.cpu_count
12358
Charles-François Natali80d62e62015-08-13 20:37:08 +010012359Return the number of CPUs in the system; return None if indeterminable.
12360
12361This number is not equivalent to the number of CPUs the current process can
12362use. The number of usable CPUs can be obtained with
12363``len(os.sched_getaffinity(0))``
Larry Hastings2f936352014-08-05 14:04:04 +100012364[clinic start generated code]*/
12365
Larry Hastings2f936352014-08-05 14:04:04 +100012366static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012367os_cpu_count_impl(PyObject *module)
Serhiy Storchaka2954f832016-07-07 18:20:03 +030012368/*[clinic end generated code: output=5fc29463c3936a9c input=e7c8f4ba6dbbadd3]*/
Charles-Francois Natali44feda32013-05-20 14:40:46 +020012369{
Charles-Francois Natalid59087d2013-05-20 17:31:06 +020012370 int ncpu = 0;
Charles-Francois Natali44feda32013-05-20 14:40:46 +020012371#ifdef MS_WINDOWS
Miss Islington (bot)43ee0e22019-09-11 08:56:13 -070012372 /* Declare prototype here to avoid pulling in all of the Win7 APIs in 3.8 */
12373 DWORD WINAPI GetActiveProcessorCount(WORD group);
12374 ncpu = GetActiveProcessorCount(ALL_PROCESSOR_GROUPS);
Charles-Francois Natali44feda32013-05-20 14:40:46 +020012375#elif defined(__hpux)
12376 ncpu = mpctl(MPC_GETNUMSPUS, NULL, NULL);
12377#elif defined(HAVE_SYSCONF) && defined(_SC_NPROCESSORS_ONLN)
12378 ncpu = sysconf(_SC_NPROCESSORS_ONLN);
Charles-Francois Natali44feda32013-05-20 14:40:46 +020012379#elif defined(__DragonFly__) || \
12380 defined(__OpenBSD__) || \
12381 defined(__FreeBSD__) || \
Charles-Francois Natalid59087d2013-05-20 17:31:06 +020012382 defined(__NetBSD__) || \
12383 defined(__APPLE__)
Charles-Francois Natali7c4f8da2013-05-20 17:40:32 +020012384 int mib[2];
12385 size_t len = sizeof(ncpu);
12386 mib[0] = CTL_HW;
12387 mib[1] = HW_NCPU;
12388 if (sysctl(mib, 2, &ncpu, &len, NULL, 0) != 0)
12389 ncpu = 0;
Charles-Francois Natali44feda32013-05-20 14:40:46 +020012390#endif
12391 if (ncpu >= 1)
12392 return PyLong_FromLong(ncpu);
12393 else
12394 Py_RETURN_NONE;
12395}
12396
Victor Stinnerdaf45552013-08-28 00:53:59 +020012397
Larry Hastings2f936352014-08-05 14:04:04 +100012398/*[clinic input]
12399os.get_inheritable -> bool
12400
12401 fd: int
12402 /
12403
12404Get the close-on-exe flag of the specified file descriptor.
12405[clinic start generated code]*/
12406
Larry Hastings2f936352014-08-05 14:04:04 +100012407static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012408os_get_inheritable_impl(PyObject *module, int fd)
12409/*[clinic end generated code: output=0445e20e149aa5b8 input=89ac008dc9ab6b95]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012410{
Steve Dower8fc89802015-04-12 00:26:27 -040012411 int return_value;
Steve Dower8fc89802015-04-12 00:26:27 -040012412 _Py_BEGIN_SUPPRESS_IPH
12413 return_value = _Py_get_inheritable(fd);
12414 _Py_END_SUPPRESS_IPH
12415 return return_value;
Larry Hastings2f936352014-08-05 14:04:04 +100012416}
12417
12418
12419/*[clinic input]
12420os.set_inheritable
12421 fd: int
12422 inheritable: int
12423 /
12424
12425Set the inheritable flag of the specified file descriptor.
12426[clinic start generated code]*/
12427
Larry Hastings2f936352014-08-05 14:04:04 +100012428static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012429os_set_inheritable_impl(PyObject *module, int fd, int inheritable)
12430/*[clinic end generated code: output=f1b1918a2f3c38c2 input=9ceaead87a1e2402]*/
Victor Stinnerdaf45552013-08-28 00:53:59 +020012431{
Steve Dower8fc89802015-04-12 00:26:27 -040012432 int result;
Victor Stinnerdaf45552013-08-28 00:53:59 +020012433
Steve Dower8fc89802015-04-12 00:26:27 -040012434 _Py_BEGIN_SUPPRESS_IPH
12435 result = _Py_set_inheritable(fd, inheritable, NULL);
12436 _Py_END_SUPPRESS_IPH
12437 if (result < 0)
Victor Stinnerdaf45552013-08-28 00:53:59 +020012438 return NULL;
12439 Py_RETURN_NONE;
12440}
12441
12442
12443#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +100012444/*[clinic input]
12445os.get_handle_inheritable -> bool
Benjamin Petersonca470632016-09-06 13:47:26 -070012446 handle: intptr_t
Larry Hastings2f936352014-08-05 14:04:04 +100012447 /
Victor Stinnerdaf45552013-08-28 00:53:59 +020012448
Larry Hastings2f936352014-08-05 14:04:04 +100012449Get the close-on-exe flag of the specified file descriptor.
12450[clinic start generated code]*/
12451
Larry Hastings2f936352014-08-05 14:04:04 +100012452static int
Benjamin Petersonca470632016-09-06 13:47:26 -070012453os_get_handle_inheritable_impl(PyObject *module, intptr_t handle)
Victor Stinner581139c2016-09-06 15:54:20 -070012454/*[clinic end generated code: output=36be5afca6ea84d8 input=cfe99f9c05c70ad1]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012455{
12456 DWORD flags;
Victor Stinnerdaf45552013-08-28 00:53:59 +020012457
12458 if (!GetHandleInformation((HANDLE)handle, &flags)) {
12459 PyErr_SetFromWindowsErr(0);
Larry Hastings2f936352014-08-05 14:04:04 +100012460 return -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +020012461 }
12462
Larry Hastings2f936352014-08-05 14:04:04 +100012463 return flags & HANDLE_FLAG_INHERIT;
Victor Stinnerdaf45552013-08-28 00:53:59 +020012464}
12465
Victor Stinnerdaf45552013-08-28 00:53:59 +020012466
Larry Hastings2f936352014-08-05 14:04:04 +100012467/*[clinic input]
12468os.set_handle_inheritable
Benjamin Petersonca470632016-09-06 13:47:26 -070012469 handle: intptr_t
Larry Hastings2f936352014-08-05 14:04:04 +100012470 inheritable: bool
12471 /
12472
12473Set the inheritable flag of the specified handle.
12474[clinic start generated code]*/
12475
Larry Hastings2f936352014-08-05 14:04:04 +100012476static PyObject *
Benjamin Petersonca470632016-09-06 13:47:26 -070012477os_set_handle_inheritable_impl(PyObject *module, intptr_t handle,
Larry Hastings89964c42015-04-14 18:07:59 -040012478 int inheritable)
Victor Stinner581139c2016-09-06 15:54:20 -070012479/*[clinic end generated code: output=021d74fe6c96baa3 input=7a7641390d8364fc]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012480{
12481 DWORD flags = inheritable ? HANDLE_FLAG_INHERIT : 0;
Victor Stinnerdaf45552013-08-28 00:53:59 +020012482 if (!SetHandleInformation((HANDLE)handle, HANDLE_FLAG_INHERIT, flags)) {
12483 PyErr_SetFromWindowsErr(0);
12484 return NULL;
12485 }
12486 Py_RETURN_NONE;
12487}
Larry Hastings2f936352014-08-05 14:04:04 +100012488#endif /* MS_WINDOWS */
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012489
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012490#ifndef MS_WINDOWS
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030012491/*[clinic input]
12492os.get_blocking -> bool
12493 fd: int
12494 /
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012495
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030012496Get the blocking mode of the file descriptor.
12497
12498Return False if the O_NONBLOCK flag is set, True if the flag is cleared.
12499[clinic start generated code]*/
12500
12501static int
12502os_get_blocking_impl(PyObject *module, int fd)
12503/*[clinic end generated code: output=336a12ad76a61482 input=f4afb59d51560179]*/
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012504{
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012505 int blocking;
12506
Steve Dower8fc89802015-04-12 00:26:27 -040012507 _Py_BEGIN_SUPPRESS_IPH
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012508 blocking = _Py_get_blocking(fd);
Steve Dower8fc89802015-04-12 00:26:27 -040012509 _Py_END_SUPPRESS_IPH
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030012510 return blocking;
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012511}
12512
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030012513/*[clinic input]
12514os.set_blocking
12515 fd: int
12516 blocking: bool(accept={int})
12517 /
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012518
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030012519Set the blocking mode of the specified file descriptor.
12520
12521Set the O_NONBLOCK flag if blocking is False,
12522clear the O_NONBLOCK flag otherwise.
12523[clinic start generated code]*/
12524
12525static PyObject *
12526os_set_blocking_impl(PyObject *module, int fd, int blocking)
12527/*[clinic end generated code: output=384eb43aa0762a9d input=bf5c8efdc5860ff3]*/
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012528{
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030012529 int result;
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012530
Steve Dower8fc89802015-04-12 00:26:27 -040012531 _Py_BEGIN_SUPPRESS_IPH
12532 result = _Py_set_blocking(fd, blocking);
12533 _Py_END_SUPPRESS_IPH
12534 if (result < 0)
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012535 return NULL;
12536 Py_RETURN_NONE;
12537}
12538#endif /* !MS_WINDOWS */
12539
12540
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012541/*[clinic input]
12542class os.DirEntry "DirEntry *" "&DirEntryType"
12543[clinic start generated code]*/
12544/*[clinic end generated code: output=da39a3ee5e6b4b0d input=3138f09f7c683f1d]*/
Victor Stinner6036e442015-03-08 01:58:04 +010012545
12546typedef struct {
12547 PyObject_HEAD
12548 PyObject *name;
12549 PyObject *path;
12550 PyObject *stat;
12551 PyObject *lstat;
12552#ifdef MS_WINDOWS
12553 struct _Py_stat_struct win32_lstat;
Victor Stinner0f6d7332017-03-09 17:34:28 +010012554 uint64_t win32_file_index;
Victor Stinner6036e442015-03-08 01:58:04 +010012555 int got_file_index;
12556#else /* POSIX */
Victor Stinner35a97c02015-03-08 02:59:09 +010012557#ifdef HAVE_DIRENT_D_TYPE
Victor Stinner6036e442015-03-08 01:58:04 +010012558 unsigned char d_type;
Victor Stinner35a97c02015-03-08 02:59:09 +010012559#endif
Victor Stinner6036e442015-03-08 01:58:04 +010012560 ino_t d_ino;
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012561 int dir_fd;
Victor Stinner6036e442015-03-08 01:58:04 +010012562#endif
12563} DirEntry;
12564
12565static void
12566DirEntry_dealloc(DirEntry *entry)
12567{
12568 Py_XDECREF(entry->name);
12569 Py_XDECREF(entry->path);
12570 Py_XDECREF(entry->stat);
12571 Py_XDECREF(entry->lstat);
12572 Py_TYPE(entry)->tp_free((PyObject *)entry);
12573}
12574
12575/* Forward reference */
12576static int
12577DirEntry_test_mode(DirEntry *self, int follow_symlinks, unsigned short mode_bits);
12578
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012579/*[clinic input]
12580os.DirEntry.is_symlink -> bool
12581
12582Return True if the entry is a symbolic link; cached per entry.
12583[clinic start generated code]*/
12584
Victor Stinner6036e442015-03-08 01:58:04 +010012585static int
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012586os_DirEntry_is_symlink_impl(DirEntry *self)
12587/*[clinic end generated code: output=42244667d7bcfc25 input=1605a1b4b96976c3]*/
Victor Stinner6036e442015-03-08 01:58:04 +010012588{
12589#ifdef MS_WINDOWS
12590 return (self->win32_lstat.st_mode & S_IFMT) == S_IFLNK;
Victor Stinner35a97c02015-03-08 02:59:09 +010012591#elif defined(HAVE_DIRENT_D_TYPE)
12592 /* POSIX */
Victor Stinner6036e442015-03-08 01:58:04 +010012593 if (self->d_type != DT_UNKNOWN)
12594 return self->d_type == DT_LNK;
12595 else
12596 return DirEntry_test_mode(self, 0, S_IFLNK);
Victor Stinner35a97c02015-03-08 02:59:09 +010012597#else
12598 /* POSIX without d_type */
12599 return DirEntry_test_mode(self, 0, S_IFLNK);
Victor Stinner6036e442015-03-08 01:58:04 +010012600#endif
12601}
12602
12603static PyObject *
Victor Stinner6036e442015-03-08 01:58:04 +010012604DirEntry_fetch_stat(DirEntry *self, int follow_symlinks)
12605{
12606 int result;
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012607 STRUCT_STAT st;
12608 PyObject *ub;
Victor Stinner6036e442015-03-08 01:58:04 +010012609
12610#ifdef MS_WINDOWS
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012611 if (!PyUnicode_FSDecoder(self->path, &ub))
12612 return NULL;
12613 const wchar_t *path = PyUnicode_AsUnicode(ub);
Victor Stinner6036e442015-03-08 01:58:04 +010012614#else /* POSIX */
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012615 if (!PyUnicode_FSConverter(self->path, &ub))
12616 return NULL;
12617 const char *path = PyBytes_AS_STRING(ub);
12618 if (self->dir_fd != DEFAULT_DIR_FD) {
12619#ifdef HAVE_FSTATAT
12620 result = fstatat(self->dir_fd, path, &st,
12621 follow_symlinks ? 0 : AT_SYMLINK_NOFOLLOW);
12622#else
12623 PyErr_SetString(PyExc_NotImplementedError, "can't fetch stat");
12624 return NULL;
12625#endif /* HAVE_FSTATAT */
12626 }
12627 else
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012628#endif
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012629 {
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012630 if (follow_symlinks)
12631 result = STAT(path, &st);
12632 else
12633 result = LSTAT(path, &st);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012634 }
12635 Py_DECREF(ub);
Victor Stinner6036e442015-03-08 01:58:04 +010012636
12637 if (result != 0)
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012638 return path_object_error(self->path);
Victor Stinner6036e442015-03-08 01:58:04 +010012639
12640 return _pystat_fromstructstat(&st);
12641}
12642
12643static PyObject *
12644DirEntry_get_lstat(DirEntry *self)
12645{
12646 if (!self->lstat) {
12647#ifdef MS_WINDOWS
12648 self->lstat = _pystat_fromstructstat(&self->win32_lstat);
12649#else /* POSIX */
12650 self->lstat = DirEntry_fetch_stat(self, 0);
12651#endif
12652 }
12653 Py_XINCREF(self->lstat);
12654 return self->lstat;
12655}
12656
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012657/*[clinic input]
12658os.DirEntry.stat
12659 *
12660 follow_symlinks: bool = True
12661
12662Return stat_result object for the entry; cached per entry.
12663[clinic start generated code]*/
12664
Victor Stinner6036e442015-03-08 01:58:04 +010012665static PyObject *
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012666os_DirEntry_stat_impl(DirEntry *self, int follow_symlinks)
12667/*[clinic end generated code: output=008593b3a6d01305 input=280d14c1d6f1d00d]*/
Victor Stinner6036e442015-03-08 01:58:04 +010012668{
12669 if (!follow_symlinks)
12670 return DirEntry_get_lstat(self);
12671
12672 if (!self->stat) {
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012673 int result = os_DirEntry_is_symlink_impl(self);
Victor Stinner6036e442015-03-08 01:58:04 +010012674 if (result == -1)
12675 return NULL;
12676 else if (result)
12677 self->stat = DirEntry_fetch_stat(self, 1);
12678 else
12679 self->stat = DirEntry_get_lstat(self);
12680 }
12681
12682 Py_XINCREF(self->stat);
12683 return self->stat;
12684}
12685
Victor Stinner6036e442015-03-08 01:58:04 +010012686/* Set exception and return -1 on error, 0 for False, 1 for True */
12687static int
12688DirEntry_test_mode(DirEntry *self, int follow_symlinks, unsigned short mode_bits)
12689{
12690 PyObject *stat = NULL;
12691 PyObject *st_mode = NULL;
12692 long mode;
12693 int result;
Victor Stinner35a97c02015-03-08 02:59:09 +010012694#if defined(MS_WINDOWS) || defined(HAVE_DIRENT_D_TYPE)
Victor Stinner6036e442015-03-08 01:58:04 +010012695 int is_symlink;
12696 int need_stat;
Victor Stinner35a97c02015-03-08 02:59:09 +010012697#endif
Victor Stinner6036e442015-03-08 01:58:04 +010012698#ifdef MS_WINDOWS
12699 unsigned long dir_bits;
12700#endif
Victor Stinner35a97c02015-03-08 02:59:09 +010012701 _Py_IDENTIFIER(st_mode);
Victor Stinner6036e442015-03-08 01:58:04 +010012702
12703#ifdef MS_WINDOWS
12704 is_symlink = (self->win32_lstat.st_mode & S_IFMT) == S_IFLNK;
12705 need_stat = follow_symlinks && is_symlink;
Victor Stinner35a97c02015-03-08 02:59:09 +010012706#elif defined(HAVE_DIRENT_D_TYPE)
Victor Stinner6036e442015-03-08 01:58:04 +010012707 is_symlink = self->d_type == DT_LNK;
12708 need_stat = self->d_type == DT_UNKNOWN || (follow_symlinks && is_symlink);
12709#endif
12710
Victor Stinner35a97c02015-03-08 02:59:09 +010012711#if defined(MS_WINDOWS) || defined(HAVE_DIRENT_D_TYPE)
Victor Stinner6036e442015-03-08 01:58:04 +010012712 if (need_stat) {
Victor Stinner35a97c02015-03-08 02:59:09 +010012713#endif
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012714 stat = os_DirEntry_stat_impl(self, follow_symlinks);
Victor Stinner6036e442015-03-08 01:58:04 +010012715 if (!stat) {
12716 if (PyErr_ExceptionMatches(PyExc_FileNotFoundError)) {
12717 /* If file doesn't exist (anymore), then return False
12718 (i.e., say it's not a file/directory) */
12719 PyErr_Clear();
12720 return 0;
12721 }
12722 goto error;
12723 }
12724 st_mode = _PyObject_GetAttrId(stat, &PyId_st_mode);
12725 if (!st_mode)
12726 goto error;
12727
12728 mode = PyLong_AsLong(st_mode);
12729 if (mode == -1 && PyErr_Occurred())
12730 goto error;
12731 Py_CLEAR(st_mode);
12732 Py_CLEAR(stat);
12733 result = (mode & S_IFMT) == mode_bits;
Victor Stinner35a97c02015-03-08 02:59:09 +010012734#if defined(MS_WINDOWS) || defined(HAVE_DIRENT_D_TYPE)
Victor Stinner6036e442015-03-08 01:58:04 +010012735 }
12736 else if (is_symlink) {
12737 assert(mode_bits != S_IFLNK);
12738 result = 0;
12739 }
12740 else {
12741 assert(mode_bits == S_IFDIR || mode_bits == S_IFREG);
12742#ifdef MS_WINDOWS
12743 dir_bits = self->win32_lstat.st_file_attributes & FILE_ATTRIBUTE_DIRECTORY;
12744 if (mode_bits == S_IFDIR)
12745 result = dir_bits != 0;
12746 else
12747 result = dir_bits == 0;
12748#else /* POSIX */
12749 if (mode_bits == S_IFDIR)
12750 result = self->d_type == DT_DIR;
12751 else
12752 result = self->d_type == DT_REG;
12753#endif
12754 }
Victor Stinner35a97c02015-03-08 02:59:09 +010012755#endif
Victor Stinner6036e442015-03-08 01:58:04 +010012756
12757 return result;
12758
12759error:
12760 Py_XDECREF(st_mode);
12761 Py_XDECREF(stat);
12762 return -1;
12763}
12764
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012765/*[clinic input]
12766os.DirEntry.is_dir -> bool
12767 *
12768 follow_symlinks: bool = True
Victor Stinner6036e442015-03-08 01:58:04 +010012769
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012770Return True if the entry is a directory; cached per entry.
12771[clinic start generated code]*/
12772
12773static int
12774os_DirEntry_is_dir_impl(DirEntry *self, int follow_symlinks)
12775/*[clinic end generated code: output=ad2e8d54365da287 input=0135232766f53f58]*/
12776{
12777 return DirEntry_test_mode(self, follow_symlinks, S_IFDIR);
Victor Stinner6036e442015-03-08 01:58:04 +010012778}
12779
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012780/*[clinic input]
12781os.DirEntry.is_file -> bool
12782 *
12783 follow_symlinks: bool = True
12784
12785Return True if the entry is a file; cached per entry.
12786[clinic start generated code]*/
12787
12788static int
12789os_DirEntry_is_file_impl(DirEntry *self, int follow_symlinks)
12790/*[clinic end generated code: output=8462ade481d8a476 input=0dc90be168b041ee]*/
Victor Stinner6036e442015-03-08 01:58:04 +010012791{
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012792 return DirEntry_test_mode(self, follow_symlinks, S_IFREG);
Victor Stinner6036e442015-03-08 01:58:04 +010012793}
12794
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012795/*[clinic input]
12796os.DirEntry.inode
Victor Stinner6036e442015-03-08 01:58:04 +010012797
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012798Return inode of the entry; cached per entry.
12799[clinic start generated code]*/
Victor Stinner6036e442015-03-08 01:58:04 +010012800
12801static PyObject *
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012802os_DirEntry_inode_impl(DirEntry *self)
12803/*[clinic end generated code: output=156bb3a72162440e input=3ee7b872ae8649f0]*/
Victor Stinner6036e442015-03-08 01:58:04 +010012804{
12805#ifdef MS_WINDOWS
12806 if (!self->got_file_index) {
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012807 PyObject *unicode;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +030012808 const wchar_t *path;
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012809 STRUCT_STAT stat;
12810 int result;
Victor Stinner6036e442015-03-08 01:58:04 +010012811
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012812 if (!PyUnicode_FSDecoder(self->path, &unicode))
Victor Stinner6036e442015-03-08 01:58:04 +010012813 return NULL;
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012814 path = PyUnicode_AsUnicode(unicode);
12815 result = LSTAT(path, &stat);
12816 Py_DECREF(unicode);
Victor Stinner6036e442015-03-08 01:58:04 +010012817
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012818 if (result != 0)
12819 return path_object_error(self->path);
Victor Stinner6036e442015-03-08 01:58:04 +010012820
12821 self->win32_file_index = stat.st_ino;
12822 self->got_file_index = 1;
12823 }
Victor Stinner0f6d7332017-03-09 17:34:28 +010012824 Py_BUILD_ASSERT(sizeof(unsigned long long) >= sizeof(self->win32_file_index));
12825 return PyLong_FromUnsignedLongLong(self->win32_file_index);
Victor Stinner6036e442015-03-08 01:58:04 +010012826#else /* POSIX */
xdegaye50e86032017-05-22 11:15:08 +020012827 Py_BUILD_ASSERT(sizeof(unsigned long long) >= sizeof(self->d_ino));
12828 return PyLong_FromUnsignedLongLong(self->d_ino);
Victor Stinner6036e442015-03-08 01:58:04 +010012829#endif
12830}
12831
12832static PyObject *
12833DirEntry_repr(DirEntry *self)
12834{
12835 return PyUnicode_FromFormat("<DirEntry %R>", self->name);
12836}
12837
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012838/*[clinic input]
12839os.DirEntry.__fspath__
12840
12841Returns the path for the entry.
12842[clinic start generated code]*/
12843
Brett Cannon96881cd2016-06-10 14:37:21 -070012844static PyObject *
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012845os_DirEntry___fspath___impl(DirEntry *self)
12846/*[clinic end generated code: output=6dd7f7ef752e6f4f input=3c49d0cf38df4fac]*/
Brett Cannon96881cd2016-06-10 14:37:21 -070012847{
12848 Py_INCREF(self->path);
12849 return self->path;
12850}
12851
Victor Stinner6036e442015-03-08 01:58:04 +010012852static PyMemberDef DirEntry_members[] = {
12853 {"name", T_OBJECT_EX, offsetof(DirEntry, name), READONLY,
12854 "the entry's base filename, relative to scandir() \"path\" argument"},
12855 {"path", T_OBJECT_EX, offsetof(DirEntry, path), READONLY,
12856 "the entry's full path name; equivalent to os.path.join(scandir_path, entry.name)"},
12857 {NULL}
12858};
12859
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012860#include "clinic/posixmodule.c.h"
12861
Victor Stinner6036e442015-03-08 01:58:04 +010012862static PyMethodDef DirEntry_methods[] = {
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012863 OS_DIRENTRY_IS_DIR_METHODDEF
12864 OS_DIRENTRY_IS_FILE_METHODDEF
12865 OS_DIRENTRY_IS_SYMLINK_METHODDEF
12866 OS_DIRENTRY_STAT_METHODDEF
12867 OS_DIRENTRY_INODE_METHODDEF
12868 OS_DIRENTRY___FSPATH___METHODDEF
Victor Stinner6036e442015-03-08 01:58:04 +010012869 {NULL}
12870};
12871
Benjamin Peterson5646de42015-04-12 17:56:34 -040012872static PyTypeObject DirEntryType = {
Victor Stinner6036e442015-03-08 01:58:04 +010012873 PyVarObject_HEAD_INIT(NULL, 0)
12874 MODNAME ".DirEntry", /* tp_name */
12875 sizeof(DirEntry), /* tp_basicsize */
12876 0, /* tp_itemsize */
12877 /* methods */
12878 (destructor)DirEntry_dealloc, /* tp_dealloc */
Jeroen Demeyer530f5062019-05-31 04:13:39 +020012879 0, /* tp_vectorcall_offset */
Victor Stinner6036e442015-03-08 01:58:04 +010012880 0, /* tp_getattr */
12881 0, /* tp_setattr */
Jeroen Demeyer530f5062019-05-31 04:13:39 +020012882 0, /* tp_as_async */
Victor Stinner6036e442015-03-08 01:58:04 +010012883 (reprfunc)DirEntry_repr, /* tp_repr */
12884 0, /* tp_as_number */
12885 0, /* tp_as_sequence */
12886 0, /* tp_as_mapping */
12887 0, /* tp_hash */
12888 0, /* tp_call */
12889 0, /* tp_str */
12890 0, /* tp_getattro */
12891 0, /* tp_setattro */
12892 0, /* tp_as_buffer */
12893 Py_TPFLAGS_DEFAULT, /* tp_flags */
12894 0, /* tp_doc */
12895 0, /* tp_traverse */
12896 0, /* tp_clear */
12897 0, /* tp_richcompare */
12898 0, /* tp_weaklistoffset */
12899 0, /* tp_iter */
12900 0, /* tp_iternext */
12901 DirEntry_methods, /* tp_methods */
12902 DirEntry_members, /* tp_members */
12903};
12904
12905#ifdef MS_WINDOWS
12906
12907static wchar_t *
Serhiy Storchakadeab18d2016-05-07 16:45:18 +030012908join_path_filenameW(const wchar_t *path_wide, const wchar_t *filename)
Victor Stinner6036e442015-03-08 01:58:04 +010012909{
12910 Py_ssize_t path_len;
12911 Py_ssize_t size;
12912 wchar_t *result;
12913 wchar_t ch;
12914
12915 if (!path_wide) { /* Default arg: "." */
12916 path_wide = L".";
12917 path_len = 1;
12918 }
12919 else {
12920 path_len = wcslen(path_wide);
12921 }
12922
12923 /* The +1's are for the path separator and the NUL */
12924 size = path_len + 1 + wcslen(filename) + 1;
12925 result = PyMem_New(wchar_t, size);
12926 if (!result) {
12927 PyErr_NoMemory();
12928 return NULL;
12929 }
12930 wcscpy(result, path_wide);
12931 if (path_len > 0) {
12932 ch = result[path_len - 1];
12933 if (ch != SEP && ch != ALTSEP && ch != L':')
12934 result[path_len++] = SEP;
12935 wcscpy(result + path_len, filename);
12936 }
12937 return result;
12938}
12939
12940static PyObject *
12941DirEntry_from_find_data(path_t *path, WIN32_FIND_DATAW *dataW)
12942{
12943 DirEntry *entry;
12944 BY_HANDLE_FILE_INFORMATION file_info;
12945 ULONG reparse_tag;
12946 wchar_t *joined_path;
12947
12948 entry = PyObject_New(DirEntry, &DirEntryType);
12949 if (!entry)
12950 return NULL;
12951 entry->name = NULL;
12952 entry->path = NULL;
12953 entry->stat = NULL;
12954 entry->lstat = NULL;
12955 entry->got_file_index = 0;
12956
12957 entry->name = PyUnicode_FromWideChar(dataW->cFileName, -1);
12958 if (!entry->name)
12959 goto error;
Steve Dowercc16be82016-09-08 10:35:16 -070012960 if (path->narrow) {
12961 Py_SETREF(entry->name, PyUnicode_EncodeFSDefault(entry->name));
12962 if (!entry->name)
12963 goto error;
12964 }
Victor Stinner6036e442015-03-08 01:58:04 +010012965
12966 joined_path = join_path_filenameW(path->wide, dataW->cFileName);
12967 if (!joined_path)
12968 goto error;
12969
12970 entry->path = PyUnicode_FromWideChar(joined_path, -1);
12971 PyMem_Free(joined_path);
12972 if (!entry->path)
12973 goto error;
Steve Dowercc16be82016-09-08 10:35:16 -070012974 if (path->narrow) {
12975 Py_SETREF(entry->path, PyUnicode_EncodeFSDefault(entry->path));
12976 if (!entry->path)
12977 goto error;
12978 }
Victor Stinner6036e442015-03-08 01:58:04 +010012979
Steve Dowercc16be82016-09-08 10:35:16 -070012980 find_data_to_file_info(dataW, &file_info, &reparse_tag);
Victor Stinner6036e442015-03-08 01:58:04 +010012981 _Py_attribute_data_to_stat(&file_info, reparse_tag, &entry->win32_lstat);
12982
12983 return (PyObject *)entry;
12984
12985error:
12986 Py_DECREF(entry);
12987 return NULL;
12988}
12989
12990#else /* POSIX */
12991
12992static char *
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020012993join_path_filename(const char *path_narrow, const char* filename, Py_ssize_t filename_len)
Victor Stinner6036e442015-03-08 01:58:04 +010012994{
12995 Py_ssize_t path_len;
12996 Py_ssize_t size;
12997 char *result;
12998
12999 if (!path_narrow) { /* Default arg: "." */
13000 path_narrow = ".";
13001 path_len = 1;
13002 }
13003 else {
13004 path_len = strlen(path_narrow);
13005 }
13006
13007 if (filename_len == -1)
13008 filename_len = strlen(filename);
13009
13010 /* The +1's are for the path separator and the NUL */
13011 size = path_len + 1 + filename_len + 1;
13012 result = PyMem_New(char, size);
13013 if (!result) {
13014 PyErr_NoMemory();
13015 return NULL;
13016 }
13017 strcpy(result, path_narrow);
13018 if (path_len > 0 && result[path_len - 1] != '/')
13019 result[path_len++] = '/';
13020 strcpy(result + path_len, filename);
13021 return result;
13022}
13023
13024static PyObject *
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020013025DirEntry_from_posix_info(path_t *path, const char *name, Py_ssize_t name_len,
Victor Stinner35a97c02015-03-08 02:59:09 +010013026 ino_t d_ino
13027#ifdef HAVE_DIRENT_D_TYPE
13028 , unsigned char d_type
13029#endif
13030 )
Victor Stinner6036e442015-03-08 01:58:04 +010013031{
13032 DirEntry *entry;
13033 char *joined_path;
13034
13035 entry = PyObject_New(DirEntry, &DirEntryType);
13036 if (!entry)
13037 return NULL;
13038 entry->name = NULL;
13039 entry->path = NULL;
13040 entry->stat = NULL;
13041 entry->lstat = NULL;
13042
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013043 if (path->fd != -1) {
13044 entry->dir_fd = path->fd;
13045 joined_path = NULL;
13046 }
13047 else {
13048 entry->dir_fd = DEFAULT_DIR_FD;
13049 joined_path = join_path_filename(path->narrow, name, name_len);
13050 if (!joined_path)
13051 goto error;
13052 }
Victor Stinner6036e442015-03-08 01:58:04 +010013053
Serhiy Storchaka1180e5a2017-07-11 06:36:46 +030013054 if (!path->narrow || !PyObject_CheckBuffer(path->object)) {
Victor Stinner6036e442015-03-08 01:58:04 +010013055 entry->name = PyUnicode_DecodeFSDefaultAndSize(name, name_len);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013056 if (joined_path)
13057 entry->path = PyUnicode_DecodeFSDefault(joined_path);
Victor Stinner6036e442015-03-08 01:58:04 +010013058 }
13059 else {
13060 entry->name = PyBytes_FromStringAndSize(name, name_len);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013061 if (joined_path)
13062 entry->path = PyBytes_FromString(joined_path);
Victor Stinner6036e442015-03-08 01:58:04 +010013063 }
13064 PyMem_Free(joined_path);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013065 if (!entry->name)
13066 goto error;
13067
13068 if (path->fd != -1) {
13069 entry->path = entry->name;
13070 Py_INCREF(entry->path);
13071 }
13072 else if (!entry->path)
Victor Stinner6036e442015-03-08 01:58:04 +010013073 goto error;
13074
Victor Stinner35a97c02015-03-08 02:59:09 +010013075#ifdef HAVE_DIRENT_D_TYPE
Victor Stinner6036e442015-03-08 01:58:04 +010013076 entry->d_type = d_type;
Victor Stinner35a97c02015-03-08 02:59:09 +010013077#endif
Victor Stinner6036e442015-03-08 01:58:04 +010013078 entry->d_ino = d_ino;
13079
13080 return (PyObject *)entry;
13081
13082error:
13083 Py_XDECREF(entry);
13084 return NULL;
13085}
13086
13087#endif
13088
13089
13090typedef struct {
13091 PyObject_HEAD
13092 path_t path;
13093#ifdef MS_WINDOWS
13094 HANDLE handle;
13095 WIN32_FIND_DATAW file_data;
13096 int first_time;
13097#else /* POSIX */
13098 DIR *dirp;
13099#endif
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013100#ifdef HAVE_FDOPENDIR
13101 int fd;
13102#endif
Victor Stinner6036e442015-03-08 01:58:04 +010013103} ScandirIterator;
13104
13105#ifdef MS_WINDOWS
13106
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013107static int
13108ScandirIterator_is_closed(ScandirIterator *iterator)
13109{
13110 return iterator->handle == INVALID_HANDLE_VALUE;
13111}
13112
Victor Stinner6036e442015-03-08 01:58:04 +010013113static void
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013114ScandirIterator_closedir(ScandirIterator *iterator)
Victor Stinner6036e442015-03-08 01:58:04 +010013115{
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030013116 HANDLE handle = iterator->handle;
13117
13118 if (handle == INVALID_HANDLE_VALUE)
Victor Stinner6036e442015-03-08 01:58:04 +010013119 return;
13120
Victor Stinner6036e442015-03-08 01:58:04 +010013121 iterator->handle = INVALID_HANDLE_VALUE;
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030013122 Py_BEGIN_ALLOW_THREADS
13123 FindClose(handle);
13124 Py_END_ALLOW_THREADS
Victor Stinner6036e442015-03-08 01:58:04 +010013125}
13126
13127static PyObject *
13128ScandirIterator_iternext(ScandirIterator *iterator)
13129{
13130 WIN32_FIND_DATAW *file_data = &iterator->file_data;
13131 BOOL success;
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013132 PyObject *entry;
Victor Stinner6036e442015-03-08 01:58:04 +010013133
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013134 /* Happens if the iterator is iterated twice, or closed explicitly */
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013135 if (iterator->handle == INVALID_HANDLE_VALUE)
Victor Stinner6036e442015-03-08 01:58:04 +010013136 return NULL;
Victor Stinner6036e442015-03-08 01:58:04 +010013137
13138 while (1) {
13139 if (!iterator->first_time) {
13140 Py_BEGIN_ALLOW_THREADS
13141 success = FindNextFileW(iterator->handle, file_data);
13142 Py_END_ALLOW_THREADS
13143 if (!success) {
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013144 /* Error or no more files */
Victor Stinner6036e442015-03-08 01:58:04 +010013145 if (GetLastError() != ERROR_NO_MORE_FILES)
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013146 path_error(&iterator->path);
Victor Stinner6036e442015-03-08 01:58:04 +010013147 break;
13148 }
13149 }
13150 iterator->first_time = 0;
13151
13152 /* Skip over . and .. */
13153 if (wcscmp(file_data->cFileName, L".") != 0 &&
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013154 wcscmp(file_data->cFileName, L"..") != 0) {
13155 entry = DirEntry_from_find_data(&iterator->path, file_data);
13156 if (!entry)
13157 break;
13158 return entry;
13159 }
Victor Stinner6036e442015-03-08 01:58:04 +010013160
13161 /* Loop till we get a non-dot directory or finish iterating */
13162 }
13163
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013164 /* Error or no more files */
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013165 ScandirIterator_closedir(iterator);
Victor Stinner6036e442015-03-08 01:58:04 +010013166 return NULL;
13167}
13168
13169#else /* POSIX */
13170
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013171static int
13172ScandirIterator_is_closed(ScandirIterator *iterator)
13173{
13174 return !iterator->dirp;
13175}
13176
Victor Stinner6036e442015-03-08 01:58:04 +010013177static void
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013178ScandirIterator_closedir(ScandirIterator *iterator)
Victor Stinner6036e442015-03-08 01:58:04 +010013179{
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030013180 DIR *dirp = iterator->dirp;
13181
13182 if (!dirp)
Victor Stinner6036e442015-03-08 01:58:04 +010013183 return;
13184
Victor Stinner6036e442015-03-08 01:58:04 +010013185 iterator->dirp = NULL;
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030013186 Py_BEGIN_ALLOW_THREADS
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013187#ifdef HAVE_FDOPENDIR
13188 if (iterator->path.fd != -1)
13189 rewinddir(dirp);
13190#endif
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030013191 closedir(dirp);
13192 Py_END_ALLOW_THREADS
Victor Stinner6036e442015-03-08 01:58:04 +010013193 return;
13194}
13195
13196static PyObject *
13197ScandirIterator_iternext(ScandirIterator *iterator)
13198{
13199 struct dirent *direntp;
13200 Py_ssize_t name_len;
13201 int is_dot;
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013202 PyObject *entry;
Victor Stinner6036e442015-03-08 01:58:04 +010013203
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013204 /* Happens if the iterator is iterated twice, or closed explicitly */
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013205 if (!iterator->dirp)
Victor Stinner6036e442015-03-08 01:58:04 +010013206 return NULL;
Victor Stinner6036e442015-03-08 01:58:04 +010013207
13208 while (1) {
13209 errno = 0;
13210 Py_BEGIN_ALLOW_THREADS
13211 direntp = readdir(iterator->dirp);
13212 Py_END_ALLOW_THREADS
13213
13214 if (!direntp) {
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013215 /* Error or no more files */
Victor Stinner6036e442015-03-08 01:58:04 +010013216 if (errno != 0)
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013217 path_error(&iterator->path);
Victor Stinner6036e442015-03-08 01:58:04 +010013218 break;
13219 }
13220
13221 /* Skip over . and .. */
13222 name_len = NAMLEN(direntp);
13223 is_dot = direntp->d_name[0] == '.' &&
13224 (name_len == 1 || (direntp->d_name[1] == '.' && name_len == 2));
13225 if (!is_dot) {
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013226 entry = DirEntry_from_posix_info(&iterator->path, direntp->d_name,
Victor Stinner35a97c02015-03-08 02:59:09 +010013227 name_len, direntp->d_ino
13228#ifdef HAVE_DIRENT_D_TYPE
13229 , direntp->d_type
13230#endif
13231 );
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013232 if (!entry)
13233 break;
13234 return entry;
Victor Stinner6036e442015-03-08 01:58:04 +010013235 }
13236
13237 /* Loop till we get a non-dot directory or finish iterating */
13238 }
13239
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013240 /* Error or no more files */
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013241 ScandirIterator_closedir(iterator);
Victor Stinner6036e442015-03-08 01:58:04 +010013242 return NULL;
13243}
13244
13245#endif
13246
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013247static PyObject *
13248ScandirIterator_close(ScandirIterator *self, PyObject *args)
13249{
13250 ScandirIterator_closedir(self);
13251 Py_RETURN_NONE;
13252}
13253
13254static PyObject *
13255ScandirIterator_enter(PyObject *self, PyObject *args)
13256{
13257 Py_INCREF(self);
13258 return self;
13259}
13260
13261static PyObject *
13262ScandirIterator_exit(ScandirIterator *self, PyObject *args)
13263{
13264 ScandirIterator_closedir(self);
13265 Py_RETURN_NONE;
13266}
13267
Victor Stinner6036e442015-03-08 01:58:04 +010013268static void
Victor Stinner7bfa4092016-03-23 00:43:54 +010013269ScandirIterator_finalize(ScandirIterator *iterator)
13270{
13271 PyObject *error_type, *error_value, *error_traceback;
13272
13273 /* Save the current exception, if any. */
13274 PyErr_Fetch(&error_type, &error_value, &error_traceback);
13275
13276 if (!ScandirIterator_is_closed(iterator)) {
13277 ScandirIterator_closedir(iterator);
13278
13279 if (PyErr_ResourceWarning((PyObject *)iterator, 1,
13280 "unclosed scandir iterator %R", iterator)) {
13281 /* Spurious errors can appear at shutdown */
13282 if (PyErr_ExceptionMatches(PyExc_Warning)) {
13283 PyErr_WriteUnraisable((PyObject *) iterator);
13284 }
13285 }
13286 }
13287
Victor Stinner7bfa4092016-03-23 00:43:54 +010013288 path_cleanup(&iterator->path);
13289
13290 /* Restore the saved exception. */
13291 PyErr_Restore(error_type, error_value, error_traceback);
13292}
13293
13294static void
Victor Stinner6036e442015-03-08 01:58:04 +010013295ScandirIterator_dealloc(ScandirIterator *iterator)
13296{
Victor Stinner7bfa4092016-03-23 00:43:54 +010013297 if (PyObject_CallFinalizerFromDealloc((PyObject *)iterator) < 0)
13298 return;
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013299
Victor Stinner6036e442015-03-08 01:58:04 +010013300 Py_TYPE(iterator)->tp_free((PyObject *)iterator);
13301}
13302
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013303static PyMethodDef ScandirIterator_methods[] = {
13304 {"__enter__", (PyCFunction)ScandirIterator_enter, METH_NOARGS},
13305 {"__exit__", (PyCFunction)ScandirIterator_exit, METH_VARARGS},
13306 {"close", (PyCFunction)ScandirIterator_close, METH_NOARGS},
13307 {NULL}
13308};
13309
Benjamin Peterson5646de42015-04-12 17:56:34 -040013310static PyTypeObject ScandirIteratorType = {
Victor Stinner6036e442015-03-08 01:58:04 +010013311 PyVarObject_HEAD_INIT(NULL, 0)
13312 MODNAME ".ScandirIterator", /* tp_name */
13313 sizeof(ScandirIterator), /* tp_basicsize */
13314 0, /* tp_itemsize */
13315 /* methods */
13316 (destructor)ScandirIterator_dealloc, /* tp_dealloc */
Jeroen Demeyer530f5062019-05-31 04:13:39 +020013317 0, /* tp_vectorcall_offset */
Victor Stinner6036e442015-03-08 01:58:04 +010013318 0, /* tp_getattr */
13319 0, /* tp_setattr */
Jeroen Demeyer530f5062019-05-31 04:13:39 +020013320 0, /* tp_as_async */
Victor Stinner6036e442015-03-08 01:58:04 +010013321 0, /* tp_repr */
13322 0, /* tp_as_number */
13323 0, /* tp_as_sequence */
13324 0, /* tp_as_mapping */
13325 0, /* tp_hash */
13326 0, /* tp_call */
13327 0, /* tp_str */
13328 0, /* tp_getattro */
13329 0, /* tp_setattro */
13330 0, /* tp_as_buffer */
Antoine Pitrouada319b2019-05-29 22:12:38 +020013331 Py_TPFLAGS_DEFAULT, /* tp_flags */
Victor Stinner6036e442015-03-08 01:58:04 +010013332 0, /* tp_doc */
13333 0, /* tp_traverse */
13334 0, /* tp_clear */
13335 0, /* tp_richcompare */
13336 0, /* tp_weaklistoffset */
13337 PyObject_SelfIter, /* tp_iter */
13338 (iternextfunc)ScandirIterator_iternext, /* tp_iternext */
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013339 ScandirIterator_methods, /* tp_methods */
Victor Stinner7bfa4092016-03-23 00:43:54 +010013340 0, /* tp_members */
13341 0, /* tp_getset */
13342 0, /* tp_base */
13343 0, /* tp_dict */
13344 0, /* tp_descr_get */
13345 0, /* tp_descr_set */
13346 0, /* tp_dictoffset */
13347 0, /* tp_init */
13348 0, /* tp_alloc */
13349 0, /* tp_new */
13350 0, /* tp_free */
13351 0, /* tp_is_gc */
13352 0, /* tp_bases */
13353 0, /* tp_mro */
13354 0, /* tp_cache */
13355 0, /* tp_subclasses */
13356 0, /* tp_weaklist */
13357 0, /* tp_del */
13358 0, /* tp_version_tag */
13359 (destructor)ScandirIterator_finalize, /* tp_finalize */
Victor Stinner6036e442015-03-08 01:58:04 +010013360};
13361
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013362/*[clinic input]
13363os.scandir
13364
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013365 path : path_t(nullable=True, allow_fd='PATH_HAVE_FDOPENDIR') = None
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013366
13367Return an iterator of DirEntry objects for given path.
13368
BNMetricsb9427072018-11-02 15:20:19 +000013369path can be specified as either str, bytes, or a path-like object. If path
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013370is bytes, the names of yielded DirEntry objects will also be bytes; in
13371all other circumstances they will be str.
13372
13373If path is None, uses the path='.'.
13374[clinic start generated code]*/
13375
Victor Stinner6036e442015-03-08 01:58:04 +010013376static PyObject *
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013377os_scandir_impl(PyObject *module, path_t *path)
BNMetricsb9427072018-11-02 15:20:19 +000013378/*[clinic end generated code: output=6eb2668b675ca89e input=6bdd312708fc3bb0]*/
Victor Stinner6036e442015-03-08 01:58:04 +010013379{
13380 ScandirIterator *iterator;
Victor Stinner6036e442015-03-08 01:58:04 +010013381#ifdef MS_WINDOWS
13382 wchar_t *path_strW;
13383#else
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013384 const char *path_str;
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013385#ifdef HAVE_FDOPENDIR
13386 int fd = -1;
13387#endif
Victor Stinner6036e442015-03-08 01:58:04 +010013388#endif
13389
Miss Islington (bot)8763d432019-06-24 09:09:47 -070013390 if (PySys_Audit("os.scandir", "O",
13391 path->object ? path->object : Py_None) < 0) {
13392 return NULL;
13393 }
13394
Victor Stinner6036e442015-03-08 01:58:04 +010013395 iterator = PyObject_New(ScandirIterator, &ScandirIteratorType);
13396 if (!iterator)
13397 return NULL;
Victor Stinner6036e442015-03-08 01:58:04 +010013398
13399#ifdef MS_WINDOWS
13400 iterator->handle = INVALID_HANDLE_VALUE;
13401#else
13402 iterator->dirp = NULL;
13403#endif
13404
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013405 memcpy(&iterator->path, path, sizeof(path_t));
Serhiy Storchaka095ef732017-02-09 20:05:51 +020013406 /* Move the ownership to iterator->path */
13407 path->object = NULL;
13408 path->cleanup = NULL;
Victor Stinner6036e442015-03-08 01:58:04 +010013409
13410#ifdef MS_WINDOWS
Victor Stinner6036e442015-03-08 01:58:04 +010013411 iterator->first_time = 1;
13412
13413 path_strW = join_path_filenameW(iterator->path.wide, L"*.*");
13414 if (!path_strW)
13415 goto error;
13416
13417 Py_BEGIN_ALLOW_THREADS
13418 iterator->handle = FindFirstFileW(path_strW, &iterator->file_data);
13419 Py_END_ALLOW_THREADS
13420
13421 PyMem_Free(path_strW);
13422
13423 if (iterator->handle == INVALID_HANDLE_VALUE) {
13424 path_error(&iterator->path);
13425 goto error;
13426 }
13427#else /* POSIX */
Victor Stinner6036e442015-03-08 01:58:04 +010013428 errno = 0;
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013429#ifdef HAVE_FDOPENDIR
13430 if (path->fd != -1) {
13431 /* closedir() closes the FD, so we duplicate it */
13432 fd = _Py_dup(path->fd);
13433 if (fd == -1)
13434 goto error;
13435
13436 Py_BEGIN_ALLOW_THREADS
13437 iterator->dirp = fdopendir(fd);
13438 Py_END_ALLOW_THREADS
13439 }
13440 else
13441#endif
13442 {
13443 if (iterator->path.narrow)
13444 path_str = iterator->path.narrow;
13445 else
13446 path_str = ".";
13447
13448 Py_BEGIN_ALLOW_THREADS
13449 iterator->dirp = opendir(path_str);
13450 Py_END_ALLOW_THREADS
13451 }
Victor Stinner6036e442015-03-08 01:58:04 +010013452
13453 if (!iterator->dirp) {
13454 path_error(&iterator->path);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013455#ifdef HAVE_FDOPENDIR
13456 if (fd != -1) {
13457 Py_BEGIN_ALLOW_THREADS
13458 close(fd);
13459 Py_END_ALLOW_THREADS
13460 }
13461#endif
Victor Stinner6036e442015-03-08 01:58:04 +010013462 goto error;
13463 }
13464#endif
13465
13466 return (PyObject *)iterator;
13467
13468error:
13469 Py_DECREF(iterator);
13470 return NULL;
13471}
13472
Ethan Furman410ef8e2016-06-04 12:06:26 -070013473/*
13474 Return the file system path representation of the object.
13475
13476 If the object is str or bytes, then allow it to pass through with
13477 an incremented refcount. If the object defines __fspath__(), then
13478 return the result of that method. All other types raise a TypeError.
13479*/
13480PyObject *
13481PyOS_FSPath(PyObject *path)
13482{
Brett Cannon3f9183b2016-08-26 14:44:48 -070013483 /* For error message reasons, this function is manually inlined in
13484 path_converter(). */
Ethan Furman410ef8e2016-06-04 12:06:26 -070013485 _Py_IDENTIFIER(__fspath__);
13486 PyObject *func = NULL;
13487 PyObject *path_repr = NULL;
13488
13489 if (PyUnicode_Check(path) || PyBytes_Check(path)) {
13490 Py_INCREF(path);
13491 return path;
13492 }
13493
13494 func = _PyObject_LookupSpecial(path, &PyId___fspath__);
13495 if (NULL == func) {
13496 return PyErr_Format(PyExc_TypeError,
13497 "expected str, bytes or os.PathLike object, "
Brett Cannonc78ca1e2016-06-24 12:03:43 -070013498 "not %.200s",
13499 Py_TYPE(path)->tp_name);
Ethan Furman410ef8e2016-06-04 12:06:26 -070013500 }
13501
Victor Stinnerf17c3de2016-12-06 18:46:19 +010013502 path_repr = _PyObject_CallNoArg(func);
Ethan Furman410ef8e2016-06-04 12:06:26 -070013503 Py_DECREF(func);
Brett Cannon044283a2016-07-15 10:41:49 -070013504 if (NULL == path_repr) {
13505 return NULL;
13506 }
13507
Brett Cannonc78ca1e2016-06-24 12:03:43 -070013508 if (!(PyUnicode_Check(path_repr) || PyBytes_Check(path_repr))) {
13509 PyErr_Format(PyExc_TypeError,
13510 "expected %.200s.__fspath__() to return str or bytes, "
13511 "not %.200s", Py_TYPE(path)->tp_name,
13512 Py_TYPE(path_repr)->tp_name);
13513 Py_DECREF(path_repr);
13514 return NULL;
13515 }
13516
Ethan Furman410ef8e2016-06-04 12:06:26 -070013517 return path_repr;
13518}
13519
13520/*[clinic input]
13521os.fspath
13522
13523 path: object
13524
13525Return the file system path representation of the object.
13526
Brett Cannonb4f43e92016-06-09 14:32:08 -070013527If the object is str or bytes, then allow it to pass through as-is. If the
13528object defines __fspath__(), then return the result of that method. All other
13529types raise a TypeError.
Ethan Furman410ef8e2016-06-04 12:06:26 -070013530[clinic start generated code]*/
13531
13532static PyObject *
Serhiy Storchaka2954f832016-07-07 18:20:03 +030013533os_fspath_impl(PyObject *module, PyObject *path)
13534/*[clinic end generated code: output=c3c3b78ecff2914f input=e357165f7b22490f]*/
Ethan Furman410ef8e2016-06-04 12:06:26 -070013535{
13536 return PyOS_FSPath(path);
13537}
Victor Stinner6036e442015-03-08 01:58:04 +010013538
Victor Stinner9b1f4742016-09-06 16:18:52 -070013539#ifdef HAVE_GETRANDOM_SYSCALL
13540/*[clinic input]
13541os.getrandom
13542
13543 size: Py_ssize_t
13544 flags: int=0
13545
13546Obtain a series of random bytes.
13547[clinic start generated code]*/
13548
13549static PyObject *
13550os_getrandom_impl(PyObject *module, Py_ssize_t size, int flags)
13551/*[clinic end generated code: output=b3a618196a61409c input=59bafac39c594947]*/
13552{
Victor Stinner9b1f4742016-09-06 16:18:52 -070013553 PyObject *bytes;
Victor Stinnerec2319c2016-09-20 23:00:59 +020013554 Py_ssize_t n;
Victor Stinner9b1f4742016-09-06 16:18:52 -070013555
13556 if (size < 0) {
13557 errno = EINVAL;
13558 return posix_error();
13559 }
13560
Victor Stinnerec2319c2016-09-20 23:00:59 +020013561 bytes = PyBytes_FromStringAndSize(NULL, size);
13562 if (bytes == NULL) {
Victor Stinner9b1f4742016-09-06 16:18:52 -070013563 PyErr_NoMemory();
13564 return NULL;
13565 }
13566
13567 while (1) {
Victor Stinnerec2319c2016-09-20 23:00:59 +020013568 n = syscall(SYS_getrandom,
13569 PyBytes_AS_STRING(bytes),
13570 PyBytes_GET_SIZE(bytes),
13571 flags);
Victor Stinner9b1f4742016-09-06 16:18:52 -070013572 if (n < 0 && errno == EINTR) {
13573 if (PyErr_CheckSignals() < 0) {
Victor Stinnerec2319c2016-09-20 23:00:59 +020013574 goto error;
Victor Stinner9b1f4742016-09-06 16:18:52 -070013575 }
Victor Stinnerec2319c2016-09-20 23:00:59 +020013576
13577 /* getrandom() was interrupted by a signal: retry */
Victor Stinner9b1f4742016-09-06 16:18:52 -070013578 continue;
13579 }
13580 break;
13581 }
13582
13583 if (n < 0) {
Victor Stinner9b1f4742016-09-06 16:18:52 -070013584 PyErr_SetFromErrno(PyExc_OSError);
Victor Stinnerec2319c2016-09-20 23:00:59 +020013585 goto error;
Victor Stinner9b1f4742016-09-06 16:18:52 -070013586 }
13587
Victor Stinnerec2319c2016-09-20 23:00:59 +020013588 if (n != size) {
13589 _PyBytes_Resize(&bytes, n);
13590 }
Victor Stinner9b1f4742016-09-06 16:18:52 -070013591
13592 return bytes;
Victor Stinnerec2319c2016-09-20 23:00:59 +020013593
13594error:
13595 Py_DECREF(bytes);
13596 return NULL;
Victor Stinner9b1f4742016-09-06 16:18:52 -070013597}
13598#endif /* HAVE_GETRANDOM_SYSCALL */
13599
Steve Dower2438cdf2019-03-29 16:37:16 -070013600#ifdef MS_WINDOWS
13601/* bpo-36085: Helper functions for managing DLL search directories
13602 * on win32
13603 */
13604
13605typedef DLL_DIRECTORY_COOKIE (WINAPI *PAddDllDirectory)(PCWSTR newDirectory);
13606typedef BOOL (WINAPI *PRemoveDllDirectory)(DLL_DIRECTORY_COOKIE cookie);
13607
13608/*[clinic input]
13609os._add_dll_directory
13610
13611 path: path_t
13612
13613Add a path to the DLL search path.
13614
13615This search path is used when resolving dependencies for imported
13616extension modules (the module itself is resolved through sys.path),
13617and also by ctypes.
13618
13619Returns an opaque value that may be passed to os.remove_dll_directory
13620to remove this directory from the search path.
13621[clinic start generated code]*/
13622
13623static PyObject *
13624os__add_dll_directory_impl(PyObject *module, path_t *path)
13625/*[clinic end generated code: output=80b025daebb5d683 input=1de3e6c13a5808c8]*/
13626{
13627 HMODULE hKernel32;
13628 PAddDllDirectory AddDllDirectory;
13629 DLL_DIRECTORY_COOKIE cookie = 0;
13630 DWORD err = 0;
13631
Steve Dowera00b5be2020-02-13 08:30:27 +000013632 if (PySys_Audit("os.add_dll_directory", "(O)", path->object) < 0) {
13633 return NULL;
13634 }
13635
Steve Dower2438cdf2019-03-29 16:37:16 -070013636 /* For Windows 7, we have to load this. As this will be a fairly
13637 infrequent operation, just do it each time. Kernel32 is always
13638 loaded. */
13639 Py_BEGIN_ALLOW_THREADS
13640 if (!(hKernel32 = GetModuleHandleW(L"kernel32")) ||
13641 !(AddDllDirectory = (PAddDllDirectory)GetProcAddress(
13642 hKernel32, "AddDllDirectory")) ||
13643 !(cookie = (*AddDllDirectory)(path->wide))) {
13644 err = GetLastError();
13645 }
13646 Py_END_ALLOW_THREADS
13647
13648 if (err) {
13649 return win32_error_object_err("add_dll_directory",
13650 path->object, err);
13651 }
13652
13653 return PyCapsule_New(cookie, "DLL directory cookie", NULL);
13654}
13655
13656/*[clinic input]
13657os._remove_dll_directory
13658
13659 cookie: object
13660
13661Removes a path from the DLL search path.
13662
13663The parameter is an opaque value that was returned from
13664os.add_dll_directory. You can only remove directories that you added
13665yourself.
13666[clinic start generated code]*/
13667
13668static PyObject *
13669os__remove_dll_directory_impl(PyObject *module, PyObject *cookie)
13670/*[clinic end generated code: output=594350433ae535bc input=c1d16a7e7d9dc5dc]*/
13671{
13672 HMODULE hKernel32;
13673 PRemoveDllDirectory RemoveDllDirectory;
13674 DLL_DIRECTORY_COOKIE cookieValue;
13675 DWORD err = 0;
13676
13677 if (!PyCapsule_IsValid(cookie, "DLL directory cookie")) {
13678 PyErr_SetString(PyExc_TypeError,
13679 "Provided cookie was not returned from os.add_dll_directory");
13680 return NULL;
13681 }
13682
13683 cookieValue = (DLL_DIRECTORY_COOKIE)PyCapsule_GetPointer(
13684 cookie, "DLL directory cookie");
13685
13686 /* For Windows 7, we have to load this. As this will be a fairly
13687 infrequent operation, just do it each time. Kernel32 is always
13688 loaded. */
13689 Py_BEGIN_ALLOW_THREADS
13690 if (!(hKernel32 = GetModuleHandleW(L"kernel32")) ||
13691 !(RemoveDllDirectory = (PRemoveDllDirectory)GetProcAddress(
13692 hKernel32, "RemoveDllDirectory")) ||
13693 !(*RemoveDllDirectory)(cookieValue)) {
13694 err = GetLastError();
13695 }
13696 Py_END_ALLOW_THREADS
13697
13698 if (err) {
13699 return win32_error_object_err("remove_dll_directory",
13700 NULL, err);
13701 }
13702
13703 if (PyCapsule_SetName(cookie, NULL)) {
13704 return NULL;
13705 }
13706
13707 Py_RETURN_NONE;
13708}
13709
13710#endif
Larry Hastings31826802013-10-19 00:09:25 -070013711
Fred Drake5ab8eaf1999-12-09 21:13:07 +000013712static PyMethodDef posix_methods[] = {
Larry Hastings31826802013-10-19 00:09:25 -070013713
13714 OS_STAT_METHODDEF
13715 OS_ACCESS_METHODDEF
13716 OS_TTYNAME_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100013717 OS_CHDIR_METHODDEF
13718 OS_CHFLAGS_METHODDEF
13719 OS_CHMOD_METHODDEF
13720 OS_FCHMOD_METHODDEF
13721 OS_LCHMOD_METHODDEF
13722 OS_CHOWN_METHODDEF
13723 OS_FCHOWN_METHODDEF
13724 OS_LCHOWN_METHODDEF
13725 OS_LCHFLAGS_METHODDEF
13726 OS_CHROOT_METHODDEF
13727 OS_CTERMID_METHODDEF
13728 OS_GETCWD_METHODDEF
13729 OS_GETCWDB_METHODDEF
13730 OS_LINK_METHODDEF
13731 OS_LISTDIR_METHODDEF
13732 OS_LSTAT_METHODDEF
13733 OS_MKDIR_METHODDEF
13734 OS_NICE_METHODDEF
13735 OS_GETPRIORITY_METHODDEF
13736 OS_SETPRIORITY_METHODDEF
Pablo Galindo6c6ddf92018-01-29 01:56:10 +000013737 OS_POSIX_SPAWN_METHODDEF
Joannah Nanjekye92b83222019-01-16 16:29:26 +030013738 OS_POSIX_SPAWNP_METHODDEF
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030013739 OS_READLINK_METHODDEF
Pablo Galindoaac4d032019-05-31 19:39:47 +010013740 OS_COPY_FILE_RANGE_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100013741 OS_RENAME_METHODDEF
13742 OS_REPLACE_METHODDEF
13743 OS_RMDIR_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100013744 OS_SYMLINK_METHODDEF
13745 OS_SYSTEM_METHODDEF
13746 OS_UMASK_METHODDEF
13747 OS_UNAME_METHODDEF
13748 OS_UNLINK_METHODDEF
13749 OS_REMOVE_METHODDEF
13750 OS_UTIME_METHODDEF
13751 OS_TIMES_METHODDEF
13752 OS__EXIT_METHODDEF
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +020013753 OS__FCOPYFILE_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100013754 OS_EXECV_METHODDEF
13755 OS_EXECVE_METHODDEF
13756 OS_SPAWNV_METHODDEF
13757 OS_SPAWNVE_METHODDEF
13758 OS_FORK1_METHODDEF
13759 OS_FORK_METHODDEF
Antoine Pitrou346cbd32017-05-27 17:50:54 +020013760 OS_REGISTER_AT_FORK_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100013761 OS_SCHED_GET_PRIORITY_MAX_METHODDEF
13762 OS_SCHED_GET_PRIORITY_MIN_METHODDEF
13763 OS_SCHED_GETPARAM_METHODDEF
13764 OS_SCHED_GETSCHEDULER_METHODDEF
13765 OS_SCHED_RR_GET_INTERVAL_METHODDEF
13766 OS_SCHED_SETPARAM_METHODDEF
13767 OS_SCHED_SETSCHEDULER_METHODDEF
13768 OS_SCHED_YIELD_METHODDEF
13769 OS_SCHED_SETAFFINITY_METHODDEF
13770 OS_SCHED_GETAFFINITY_METHODDEF
13771 OS_OPENPTY_METHODDEF
13772 OS_FORKPTY_METHODDEF
13773 OS_GETEGID_METHODDEF
13774 OS_GETEUID_METHODDEF
13775 OS_GETGID_METHODDEF
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +020013776#ifdef HAVE_GETGROUPLIST
13777 {"getgrouplist", posix_getgrouplist, METH_VARARGS, posix_getgrouplist__doc__},
13778#endif
Larry Hastings2f936352014-08-05 14:04:04 +100013779 OS_GETGROUPS_METHODDEF
13780 OS_GETPID_METHODDEF
13781 OS_GETPGRP_METHODDEF
13782 OS_GETPPID_METHODDEF
13783 OS_GETUID_METHODDEF
13784 OS_GETLOGIN_METHODDEF
13785 OS_KILL_METHODDEF
13786 OS_KILLPG_METHODDEF
13787 OS_PLOCK_METHODDEF
Thomas Heller8b7a9572007-08-31 06:44:36 +000013788#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -070013789 OS_STARTFILE_METHODDEF
Thomas Heller8b7a9572007-08-31 06:44:36 +000013790#endif
Larry Hastings2f936352014-08-05 14:04:04 +100013791 OS_SETUID_METHODDEF
13792 OS_SETEUID_METHODDEF
13793 OS_SETREUID_METHODDEF
13794 OS_SETGID_METHODDEF
13795 OS_SETEGID_METHODDEF
13796 OS_SETREGID_METHODDEF
13797 OS_SETGROUPS_METHODDEF
Antoine Pitroub7572f02009-12-02 20:46:48 +000013798#ifdef HAVE_INITGROUPS
Victor Stinner8c62be82010-05-06 00:08:46 +000013799 {"initgroups", posix_initgroups, METH_VARARGS, posix_initgroups__doc__},
Antoine Pitroub7572f02009-12-02 20:46:48 +000013800#endif /* HAVE_INITGROUPS */
Larry Hastings2f936352014-08-05 14:04:04 +100013801 OS_GETPGID_METHODDEF
13802 OS_SETPGRP_METHODDEF
13803 OS_WAIT_METHODDEF
13804 OS_WAIT3_METHODDEF
13805 OS_WAIT4_METHODDEF
13806 OS_WAITID_METHODDEF
13807 OS_WAITPID_METHODDEF
13808 OS_GETSID_METHODDEF
13809 OS_SETSID_METHODDEF
13810 OS_SETPGID_METHODDEF
13811 OS_TCGETPGRP_METHODDEF
13812 OS_TCSETPGRP_METHODDEF
13813 OS_OPEN_METHODDEF
13814 OS_CLOSE_METHODDEF
13815 OS_CLOSERANGE_METHODDEF
13816 OS_DEVICE_ENCODING_METHODDEF
13817 OS_DUP_METHODDEF
13818 OS_DUP2_METHODDEF
13819 OS_LOCKF_METHODDEF
13820 OS_LSEEK_METHODDEF
13821 OS_READ_METHODDEF
13822 OS_READV_METHODDEF
13823 OS_PREAD_METHODDEF
Pablo Galindo4defba32018-01-27 16:16:37 +000013824 OS_PREADV_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100013825 OS_WRITE_METHODDEF
13826 OS_WRITEV_METHODDEF
13827 OS_PWRITE_METHODDEF
Pablo Galindo4defba32018-01-27 16:16:37 +000013828 OS_PWRITEV_METHODDEF
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000013829#ifdef HAVE_SENDFILE
Serhiy Storchaka62be7422018-11-27 13:27:31 +020013830 {"sendfile", (PyCFunction)(void(*)(void))posix_sendfile, METH_VARARGS | METH_KEYWORDS,
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000013831 posix_sendfile__doc__},
13832#endif
Larry Hastings2f936352014-08-05 14:04:04 +100013833 OS_FSTAT_METHODDEF
13834 OS_ISATTY_METHODDEF
13835 OS_PIPE_METHODDEF
13836 OS_PIPE2_METHODDEF
13837 OS_MKFIFO_METHODDEF
13838 OS_MKNOD_METHODDEF
13839 OS_MAJOR_METHODDEF
13840 OS_MINOR_METHODDEF
13841 OS_MAKEDEV_METHODDEF
13842 OS_FTRUNCATE_METHODDEF
13843 OS_TRUNCATE_METHODDEF
13844 OS_POSIX_FALLOCATE_METHODDEF
13845 OS_POSIX_FADVISE_METHODDEF
13846 OS_PUTENV_METHODDEF
13847 OS_UNSETENV_METHODDEF
13848 OS_STRERROR_METHODDEF
13849 OS_FCHDIR_METHODDEF
13850 OS_FSYNC_METHODDEF
13851 OS_SYNC_METHODDEF
13852 OS_FDATASYNC_METHODDEF
13853 OS_WCOREDUMP_METHODDEF
13854 OS_WIFCONTINUED_METHODDEF
13855 OS_WIFSTOPPED_METHODDEF
13856 OS_WIFSIGNALED_METHODDEF
13857 OS_WIFEXITED_METHODDEF
13858 OS_WEXITSTATUS_METHODDEF
13859 OS_WTERMSIG_METHODDEF
13860 OS_WSTOPSIG_METHODDEF
13861 OS_FSTATVFS_METHODDEF
13862 OS_STATVFS_METHODDEF
13863 OS_CONFSTR_METHODDEF
13864 OS_SYSCONF_METHODDEF
13865 OS_FPATHCONF_METHODDEF
13866 OS_PATHCONF_METHODDEF
13867 OS_ABORT_METHODDEF
Serhiy Storchakaf0b50152015-05-13 00:52:39 +030013868 OS__GETFULLPATHNAME_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100013869 OS__GETDISKUSAGE_METHODDEF
13870 OS__GETFINALPATHNAME_METHODDEF
13871 OS__GETVOLUMEPATHNAME_METHODDEF
13872 OS_GETLOADAVG_METHODDEF
13873 OS_URANDOM_METHODDEF
13874 OS_SETRESUID_METHODDEF
13875 OS_SETRESGID_METHODDEF
13876 OS_GETRESUID_METHODDEF
13877 OS_GETRESGID_METHODDEF
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000013878
Larry Hastings2f936352014-08-05 14:04:04 +100013879 OS_GETXATTR_METHODDEF
13880 OS_SETXATTR_METHODDEF
13881 OS_REMOVEXATTR_METHODDEF
13882 OS_LISTXATTR_METHODDEF
13883
Antoine Pitroubcf2b592012-02-08 23:28:36 +010013884#if defined(TERMSIZE_USE_CONIO) || defined(TERMSIZE_USE_IOCTL)
13885 {"get_terminal_size", get_terminal_size, METH_VARARGS, termsize__doc__},
13886#endif
Larry Hastings2f936352014-08-05 14:04:04 +100013887 OS_CPU_COUNT_METHODDEF
13888 OS_GET_INHERITABLE_METHODDEF
13889 OS_SET_INHERITABLE_METHODDEF
13890 OS_GET_HANDLE_INHERITABLE_METHODDEF
13891 OS_SET_HANDLE_INHERITABLE_METHODDEF
Victor Stinner1db9e7b2014-07-29 22:32:47 +020013892#ifndef MS_WINDOWS
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030013893 OS_GET_BLOCKING_METHODDEF
13894 OS_SET_BLOCKING_METHODDEF
Victor Stinner1db9e7b2014-07-29 22:32:47 +020013895#endif
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013896 OS_SCANDIR_METHODDEF
Ethan Furman410ef8e2016-06-04 12:06:26 -070013897 OS_FSPATH_METHODDEF
Victor Stinner9b1f4742016-09-06 16:18:52 -070013898 OS_GETRANDOM_METHODDEF
Zackery Spytz43fdbd22019-05-29 13:57:07 -060013899 OS_MEMFD_CREATE_METHODDEF
Steve Dower2438cdf2019-03-29 16:37:16 -070013900#ifdef MS_WINDOWS
13901 OS__ADD_DLL_DIRECTORY_METHODDEF
13902 OS__REMOVE_DLL_DIRECTORY_METHODDEF
13903#endif
Victor Stinner8c62be82010-05-06 00:08:46 +000013904 {NULL, NULL} /* Sentinel */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000013905};
13906
Barry Warsaw4a342091996-12-19 23:50:02 +000013907static int
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013908all_ins(PyObject *m)
Barry Warsaw4a342091996-12-19 23:50:02 +000013909{
Guido van Rossum94f6f721999-01-06 18:42:14 +000013910#ifdef F_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013911 if (PyModule_AddIntMacro(m, F_OK)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013912#endif
Guido van Rossum94f6f721999-01-06 18:42:14 +000013913#ifdef R_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013914 if (PyModule_AddIntMacro(m, R_OK)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013915#endif
Guido van Rossum94f6f721999-01-06 18:42:14 +000013916#ifdef W_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013917 if (PyModule_AddIntMacro(m, W_OK)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013918#endif
Guido van Rossum94f6f721999-01-06 18:42:14 +000013919#ifdef X_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013920 if (PyModule_AddIntMacro(m, X_OK)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013921#endif
Fred Drakec9680921999-12-13 16:37:25 +000013922#ifdef NGROUPS_MAX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013923 if (PyModule_AddIntMacro(m, NGROUPS_MAX)) return -1;
Fred Drakec9680921999-12-13 16:37:25 +000013924#endif
Fred Drake5ab8eaf1999-12-09 21:13:07 +000013925#ifdef TMP_MAX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013926 if (PyModule_AddIntMacro(m, TMP_MAX)) return -1;
Fred Drake5ab8eaf1999-12-09 21:13:07 +000013927#endif
Fred Drake106c1a02002-04-23 15:58:02 +000013928#ifdef WCONTINUED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013929 if (PyModule_AddIntMacro(m, WCONTINUED)) return -1;
Fred Drake106c1a02002-04-23 15:58:02 +000013930#endif
Barry Warsaw4a342091996-12-19 23:50:02 +000013931#ifdef WNOHANG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013932 if (PyModule_AddIntMacro(m, WNOHANG)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013933#endif
Fred Drake106c1a02002-04-23 15:58:02 +000013934#ifdef WUNTRACED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013935 if (PyModule_AddIntMacro(m, WUNTRACED)) return -1;
Fred Drake106c1a02002-04-23 15:58:02 +000013936#endif
Barry Warsaw4a342091996-12-19 23:50:02 +000013937#ifdef O_RDONLY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013938 if (PyModule_AddIntMacro(m, O_RDONLY)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013939#endif
13940#ifdef O_WRONLY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013941 if (PyModule_AddIntMacro(m, O_WRONLY)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013942#endif
13943#ifdef O_RDWR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013944 if (PyModule_AddIntMacro(m, O_RDWR)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013945#endif
13946#ifdef O_NDELAY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013947 if (PyModule_AddIntMacro(m, O_NDELAY)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013948#endif
13949#ifdef O_NONBLOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013950 if (PyModule_AddIntMacro(m, O_NONBLOCK)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013951#endif
13952#ifdef O_APPEND
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013953 if (PyModule_AddIntMacro(m, O_APPEND)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013954#endif
13955#ifdef O_DSYNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013956 if (PyModule_AddIntMacro(m, O_DSYNC)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013957#endif
13958#ifdef O_RSYNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013959 if (PyModule_AddIntMacro(m, O_RSYNC)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013960#endif
13961#ifdef O_SYNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013962 if (PyModule_AddIntMacro(m, O_SYNC)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013963#endif
13964#ifdef O_NOCTTY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013965 if (PyModule_AddIntMacro(m, O_NOCTTY)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013966#endif
13967#ifdef O_CREAT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013968 if (PyModule_AddIntMacro(m, O_CREAT)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013969#endif
13970#ifdef O_EXCL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013971 if (PyModule_AddIntMacro(m, O_EXCL)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013972#endif
13973#ifdef O_TRUNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013974 if (PyModule_AddIntMacro(m, O_TRUNC)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013975#endif
Guido van Rossum98d9d091997-08-08 21:48:51 +000013976#ifdef O_BINARY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013977 if (PyModule_AddIntMacro(m, O_BINARY)) return -1;
Guido van Rossum98d9d091997-08-08 21:48:51 +000013978#endif
13979#ifdef O_TEXT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013980 if (PyModule_AddIntMacro(m, O_TEXT)) return -1;
Guido van Rossum98d9d091997-08-08 21:48:51 +000013981#endif
Jesus Cea1d642d22012-04-24 20:59:17 +020013982#ifdef O_XATTR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013983 if (PyModule_AddIntMacro(m, O_XATTR)) return -1;
Jesus Cea1d642d22012-04-24 20:59:17 +020013984#endif
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000013985#ifdef O_LARGEFILE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013986 if (PyModule_AddIntMacro(m, O_LARGEFILE)) return -1;
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000013987#endif
doko@ubuntu.comfcff4372016-06-13 16:33:04 +020013988#ifndef __GNU__
Skip Montanaro5ff14922005-05-16 02:42:22 +000013989#ifdef O_SHLOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013990 if (PyModule_AddIntMacro(m, O_SHLOCK)) return -1;
Skip Montanaro5ff14922005-05-16 02:42:22 +000013991#endif
13992#ifdef O_EXLOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013993 if (PyModule_AddIntMacro(m, O_EXLOCK)) return -1;
Skip Montanaro5ff14922005-05-16 02:42:22 +000013994#endif
doko@ubuntu.comfcff4372016-06-13 16:33:04 +020013995#endif
Jesus Ceacf381202012-04-24 20:44:40 +020013996#ifdef O_EXEC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013997 if (PyModule_AddIntMacro(m, O_EXEC)) return -1;
Jesus Ceacf381202012-04-24 20:44:40 +020013998#endif
13999#ifdef O_SEARCH
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014000 if (PyModule_AddIntMacro(m, O_SEARCH)) return -1;
Jesus Ceacf381202012-04-24 20:44:40 +020014001#endif
Benjamin Peterson3b965a22013-03-13 10:27:41 -050014002#ifdef O_PATH
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014003 if (PyModule_AddIntMacro(m, O_PATH)) return -1;
Benjamin Peterson3b965a22013-03-13 10:27:41 -050014004#endif
Jesus Ceacf381202012-04-24 20:44:40 +020014005#ifdef O_TTY_INIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014006 if (PyModule_AddIntMacro(m, O_TTY_INIT)) return -1;
Jesus Ceacf381202012-04-24 20:44:40 +020014007#endif
Christian Heimes177b3f92013-08-16 14:35:09 +020014008#ifdef O_TMPFILE
14009 if (PyModule_AddIntMacro(m, O_TMPFILE)) return -1;
14010#endif
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000014011#ifdef PRIO_PROCESS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014012 if (PyModule_AddIntMacro(m, PRIO_PROCESS)) return -1;
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000014013#endif
14014#ifdef PRIO_PGRP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014015 if (PyModule_AddIntMacro(m, PRIO_PGRP)) return -1;
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000014016#endif
14017#ifdef PRIO_USER
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014018 if (PyModule_AddIntMacro(m, PRIO_USER)) return -1;
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000014019#endif
Charles-François Natali1e045b12011-05-22 20:42:32 +020014020#ifdef O_CLOEXEC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014021 if (PyModule_AddIntMacro(m, O_CLOEXEC)) return -1;
Charles-François Natali1e045b12011-05-22 20:42:32 +020014022#endif
Jesus Cea1d642d22012-04-24 20:59:17 +020014023#ifdef O_ACCMODE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014024 if (PyModule_AddIntMacro(m, O_ACCMODE)) return -1;
Jesus Cea1d642d22012-04-24 20:59:17 +020014025#endif
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000014026
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000014027
Jesus Cea94363612012-06-22 18:32:07 +020014028#ifdef SEEK_HOLE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014029 if (PyModule_AddIntMacro(m, SEEK_HOLE)) return -1;
Jesus Cea94363612012-06-22 18:32:07 +020014030#endif
14031#ifdef SEEK_DATA
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014032 if (PyModule_AddIntMacro(m, SEEK_DATA)) return -1;
Jesus Cea94363612012-06-22 18:32:07 +020014033#endif
14034
Tim Peters5aa91602002-01-30 05:46:57 +000014035/* MS Windows */
14036#ifdef O_NOINHERIT
Victor Stinner8c62be82010-05-06 00:08:46 +000014037 /* Don't inherit in child processes. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014038 if (PyModule_AddIntMacro(m, O_NOINHERIT)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000014039#endif
14040#ifdef _O_SHORT_LIVED
Victor Stinner8c62be82010-05-06 00:08:46 +000014041 /* Optimize for short life (keep in memory). */
14042 /* MS forgot to define this one with a non-underscore form too. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014043 if (PyModule_AddIntConstant(m, "O_SHORT_LIVED", _O_SHORT_LIVED)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000014044#endif
14045#ifdef O_TEMPORARY
Victor Stinner8c62be82010-05-06 00:08:46 +000014046 /* Automatically delete when last handle is closed. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014047 if (PyModule_AddIntMacro(m, O_TEMPORARY)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000014048#endif
14049#ifdef O_RANDOM
Victor Stinner8c62be82010-05-06 00:08:46 +000014050 /* Optimize for random access. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014051 if (PyModule_AddIntMacro(m, O_RANDOM)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000014052#endif
14053#ifdef O_SEQUENTIAL
Victor Stinner8c62be82010-05-06 00:08:46 +000014054 /* Optimize for sequential access. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014055 if (PyModule_AddIntMacro(m, O_SEQUENTIAL)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000014056#endif
14057
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000014058/* GNU extensions. */
Alexandre Vassalottibee32532008-05-16 18:15:12 +000014059#ifdef O_ASYNC
Victor Stinner8c62be82010-05-06 00:08:46 +000014060 /* Send a SIGIO signal whenever input or output
14061 becomes available on file descriptor */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014062 if (PyModule_AddIntMacro(m, O_ASYNC)) return -1;
Alexandre Vassalottibee32532008-05-16 18:15:12 +000014063#endif
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000014064#ifdef O_DIRECT
Victor Stinner8c62be82010-05-06 00:08:46 +000014065 /* Direct disk access. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014066 if (PyModule_AddIntMacro(m, O_DIRECT)) return -1;
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000014067#endif
14068#ifdef O_DIRECTORY
Victor Stinner8c62be82010-05-06 00:08:46 +000014069 /* Must be a directory. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014070 if (PyModule_AddIntMacro(m, O_DIRECTORY)) return -1;
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000014071#endif
14072#ifdef O_NOFOLLOW
Victor Stinner8c62be82010-05-06 00:08:46 +000014073 /* Do not follow links. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014074 if (PyModule_AddIntMacro(m, O_NOFOLLOW)) return -1;
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000014075#endif
Jesus Cea1d642d22012-04-24 20:59:17 +020014076#ifdef O_NOLINKS
14077 /* Fails if link count of the named file is greater than 1 */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014078 if (PyModule_AddIntMacro(m, O_NOLINKS)) return -1;
Jesus Cea1d642d22012-04-24 20:59:17 +020014079#endif
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +000014080#ifdef O_NOATIME
Victor Stinner8c62be82010-05-06 00:08:46 +000014081 /* Do not update the access time. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014082 if (PyModule_AddIntMacro(m, O_NOATIME)) return -1;
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +000014083#endif
Guido van Rossumd48f2521997-12-05 22:19:34 +000014084
Victor Stinner8c62be82010-05-06 00:08:46 +000014085 /* These come from sysexits.h */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014086#ifdef EX_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014087 if (PyModule_AddIntMacro(m, EX_OK)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014088#endif /* EX_OK */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014089#ifdef EX_USAGE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014090 if (PyModule_AddIntMacro(m, EX_USAGE)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014091#endif /* EX_USAGE */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014092#ifdef EX_DATAERR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014093 if (PyModule_AddIntMacro(m, EX_DATAERR)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014094#endif /* EX_DATAERR */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014095#ifdef EX_NOINPUT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014096 if (PyModule_AddIntMacro(m, EX_NOINPUT)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014097#endif /* EX_NOINPUT */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014098#ifdef EX_NOUSER
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014099 if (PyModule_AddIntMacro(m, EX_NOUSER)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014100#endif /* EX_NOUSER */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014101#ifdef EX_NOHOST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014102 if (PyModule_AddIntMacro(m, EX_NOHOST)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014103#endif /* EX_NOHOST */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014104#ifdef EX_UNAVAILABLE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014105 if (PyModule_AddIntMacro(m, EX_UNAVAILABLE)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014106#endif /* EX_UNAVAILABLE */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014107#ifdef EX_SOFTWARE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014108 if (PyModule_AddIntMacro(m, EX_SOFTWARE)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014109#endif /* EX_SOFTWARE */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014110#ifdef EX_OSERR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014111 if (PyModule_AddIntMacro(m, EX_OSERR)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014112#endif /* EX_OSERR */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014113#ifdef EX_OSFILE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014114 if (PyModule_AddIntMacro(m, EX_OSFILE)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014115#endif /* EX_OSFILE */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014116#ifdef EX_CANTCREAT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014117 if (PyModule_AddIntMacro(m, EX_CANTCREAT)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014118#endif /* EX_CANTCREAT */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014119#ifdef EX_IOERR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014120 if (PyModule_AddIntMacro(m, EX_IOERR)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014121#endif /* EX_IOERR */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014122#ifdef EX_TEMPFAIL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014123 if (PyModule_AddIntMacro(m, EX_TEMPFAIL)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014124#endif /* EX_TEMPFAIL */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014125#ifdef EX_PROTOCOL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014126 if (PyModule_AddIntMacro(m, EX_PROTOCOL)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014127#endif /* EX_PROTOCOL */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014128#ifdef EX_NOPERM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014129 if (PyModule_AddIntMacro(m, EX_NOPERM)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014130#endif /* EX_NOPERM */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014131#ifdef EX_CONFIG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014132 if (PyModule_AddIntMacro(m, EX_CONFIG)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014133#endif /* EX_CONFIG */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014134#ifdef EX_NOTFOUND
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014135 if (PyModule_AddIntMacro(m, EX_NOTFOUND)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014136#endif /* EX_NOTFOUND */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014137
Amaury Forgeot d'Arc66d00ad2010-09-10 18:11:45 +000014138 /* statvfs */
Andrew M. Kuchling4ea04a32010-08-18 22:30:34 +000014139#ifdef ST_RDONLY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014140 if (PyModule_AddIntMacro(m, ST_RDONLY)) return -1;
Andrew M. Kuchling4ea04a32010-08-18 22:30:34 +000014141#endif /* ST_RDONLY */
14142#ifdef ST_NOSUID
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014143 if (PyModule_AddIntMacro(m, ST_NOSUID)) return -1;
Andrew M. Kuchling4ea04a32010-08-18 22:30:34 +000014144#endif /* ST_NOSUID */
14145
doko@ubuntu.comca616a22013-12-08 15:23:07 +010014146 /* GNU extensions */
14147#ifdef ST_NODEV
14148 if (PyModule_AddIntMacro(m, ST_NODEV)) return -1;
14149#endif /* ST_NODEV */
14150#ifdef ST_NOEXEC
14151 if (PyModule_AddIntMacro(m, ST_NOEXEC)) return -1;
14152#endif /* ST_NOEXEC */
14153#ifdef ST_SYNCHRONOUS
14154 if (PyModule_AddIntMacro(m, ST_SYNCHRONOUS)) return -1;
14155#endif /* ST_SYNCHRONOUS */
14156#ifdef ST_MANDLOCK
14157 if (PyModule_AddIntMacro(m, ST_MANDLOCK)) return -1;
14158#endif /* ST_MANDLOCK */
14159#ifdef ST_WRITE
14160 if (PyModule_AddIntMacro(m, ST_WRITE)) return -1;
14161#endif /* ST_WRITE */
14162#ifdef ST_APPEND
14163 if (PyModule_AddIntMacro(m, ST_APPEND)) return -1;
14164#endif /* ST_APPEND */
14165#ifdef ST_NOATIME
14166 if (PyModule_AddIntMacro(m, ST_NOATIME)) return -1;
14167#endif /* ST_NOATIME */
14168#ifdef ST_NODIRATIME
14169 if (PyModule_AddIntMacro(m, ST_NODIRATIME)) return -1;
14170#endif /* ST_NODIRATIME */
14171#ifdef ST_RELATIME
14172 if (PyModule_AddIntMacro(m, ST_RELATIME)) return -1;
14173#endif /* ST_RELATIME */
14174
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000014175 /* FreeBSD sendfile() constants */
14176#ifdef SF_NODISKIO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014177 if (PyModule_AddIntMacro(m, SF_NODISKIO)) return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000014178#endif
14179#ifdef SF_MNOWAIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014180 if (PyModule_AddIntMacro(m, SF_MNOWAIT)) return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000014181#endif
14182#ifdef SF_SYNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014183 if (PyModule_AddIntMacro(m, SF_SYNC)) return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000014184#endif
14185
Ross Lagerwall7807c352011-03-17 20:20:30 +020014186 /* constants for posix_fadvise */
14187#ifdef POSIX_FADV_NORMAL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014188 if (PyModule_AddIntMacro(m, POSIX_FADV_NORMAL)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014189#endif
14190#ifdef POSIX_FADV_SEQUENTIAL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014191 if (PyModule_AddIntMacro(m, POSIX_FADV_SEQUENTIAL)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014192#endif
14193#ifdef POSIX_FADV_RANDOM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014194 if (PyModule_AddIntMacro(m, POSIX_FADV_RANDOM)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014195#endif
14196#ifdef POSIX_FADV_NOREUSE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014197 if (PyModule_AddIntMacro(m, POSIX_FADV_NOREUSE)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014198#endif
14199#ifdef POSIX_FADV_WILLNEED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014200 if (PyModule_AddIntMacro(m, POSIX_FADV_WILLNEED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014201#endif
14202#ifdef POSIX_FADV_DONTNEED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014203 if (PyModule_AddIntMacro(m, POSIX_FADV_DONTNEED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014204#endif
14205
14206 /* constants for waitid */
14207#if defined(HAVE_SYS_WAIT_H) && defined(HAVE_WAITID)
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014208 if (PyModule_AddIntMacro(m, P_PID)) return -1;
14209 if (PyModule_AddIntMacro(m, P_PGID)) return -1;
14210 if (PyModule_AddIntMacro(m, P_ALL)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014211#endif
14212#ifdef WEXITED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014213 if (PyModule_AddIntMacro(m, WEXITED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014214#endif
14215#ifdef WNOWAIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014216 if (PyModule_AddIntMacro(m, WNOWAIT)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014217#endif
14218#ifdef WSTOPPED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014219 if (PyModule_AddIntMacro(m, WSTOPPED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014220#endif
14221#ifdef CLD_EXITED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014222 if (PyModule_AddIntMacro(m, CLD_EXITED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014223#endif
14224#ifdef CLD_DUMPED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014225 if (PyModule_AddIntMacro(m, CLD_DUMPED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014226#endif
14227#ifdef CLD_TRAPPED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014228 if (PyModule_AddIntMacro(m, CLD_TRAPPED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014229#endif
14230#ifdef CLD_CONTINUED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014231 if (PyModule_AddIntMacro(m, CLD_CONTINUED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014232#endif
14233
14234 /* constants for lockf */
14235#ifdef F_LOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014236 if (PyModule_AddIntMacro(m, F_LOCK)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014237#endif
14238#ifdef F_TLOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014239 if (PyModule_AddIntMacro(m, F_TLOCK)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014240#endif
14241#ifdef F_ULOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014242 if (PyModule_AddIntMacro(m, F_ULOCK)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014243#endif
14244#ifdef F_TEST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014245 if (PyModule_AddIntMacro(m, F_TEST)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014246#endif
14247
Pablo Galindo4defba32018-01-27 16:16:37 +000014248#ifdef RWF_DSYNC
14249 if (PyModule_AddIntConstant(m, "RWF_DSYNC", RWF_DSYNC)) return -1;
14250#endif
14251#ifdef RWF_HIPRI
14252 if (PyModule_AddIntConstant(m, "RWF_HIPRI", RWF_HIPRI)) return -1;
14253#endif
14254#ifdef RWF_SYNC
14255 if (PyModule_AddIntConstant(m, "RWF_SYNC", RWF_SYNC)) return -1;
14256#endif
14257#ifdef RWF_NOWAIT
14258 if (PyModule_AddIntConstant(m, "RWF_NOWAIT", RWF_NOWAIT)) return -1;
14259#endif
14260
Pablo Galindo6c6ddf92018-01-29 01:56:10 +000014261/* constants for posix_spawn */
14262#ifdef HAVE_POSIX_SPAWN
14263 if (PyModule_AddIntConstant(m, "POSIX_SPAWN_OPEN", POSIX_SPAWN_OPEN)) return -1;
14264 if (PyModule_AddIntConstant(m, "POSIX_SPAWN_CLOSE", POSIX_SPAWN_CLOSE)) return -1;
14265 if (PyModule_AddIntConstant(m, "POSIX_SPAWN_DUP2", POSIX_SPAWN_DUP2)) return -1;
14266#endif
14267
pxinwrf2d7ac72019-05-21 18:46:37 +080014268#if defined(HAVE_SPAWNV) || defined (HAVE_RTPSPAWN)
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014269 if (PyModule_AddIntConstant(m, "P_WAIT", _P_WAIT)) return -1;
14270 if (PyModule_AddIntConstant(m, "P_NOWAIT", _P_NOWAIT)) return -1;
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014271 if (PyModule_AddIntConstant(m, "P_NOWAITO", _P_NOWAITO)) return -1;
pxinwrf2d7ac72019-05-21 18:46:37 +080014272#endif
14273#ifdef HAVE_SPAWNV
14274 if (PyModule_AddIntConstant(m, "P_OVERLAY", _OLD_P_OVERLAY)) return -1;
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014275 if (PyModule_AddIntConstant(m, "P_DETACH", _P_DETACH)) return -1;
Guido van Rossum246bc171999-02-01 23:54:31 +000014276#endif
14277
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014278#ifdef HAVE_SCHED_H
Benjamin Petersondbaa5592016-07-30 23:21:50 -070014279#ifdef SCHED_OTHER
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014280 if (PyModule_AddIntMacro(m, SCHED_OTHER)) return -1;
Benjamin Petersondbaa5592016-07-30 23:21:50 -070014281#endif
14282#ifdef SCHED_FIFO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014283 if (PyModule_AddIntMacro(m, SCHED_FIFO)) return -1;
Benjamin Petersondbaa5592016-07-30 23:21:50 -070014284#endif
14285#ifdef SCHED_RR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014286 if (PyModule_AddIntMacro(m, SCHED_RR)) return -1;
Benjamin Petersondbaa5592016-07-30 23:21:50 -070014287#endif
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014288#ifdef SCHED_SPORADIC
messi Liao0d322182017-06-13 22:30:43 +080014289 if (PyModule_AddIntMacro(m, SCHED_SPORADIC)) return -1;
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014290#endif
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014291#ifdef SCHED_BATCH
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014292 if (PyModule_AddIntMacro(m, SCHED_BATCH)) return -1;
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014293#endif
14294#ifdef SCHED_IDLE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014295 if (PyModule_AddIntMacro(m, SCHED_IDLE)) return -1;
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014296#endif
14297#ifdef SCHED_RESET_ON_FORK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014298 if (PyModule_AddIntMacro(m, SCHED_RESET_ON_FORK)) return -1;
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014299#endif
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020014300#ifdef SCHED_SYS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014301 if (PyModule_AddIntMacro(m, SCHED_SYS)) return -1;
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020014302#endif
14303#ifdef SCHED_IA
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014304 if (PyModule_AddIntMacro(m, SCHED_IA)) return -1;
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020014305#endif
14306#ifdef SCHED_FSS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014307 if (PyModule_AddIntMacro(m, SCHED_FSS)) return -1;
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020014308#endif
14309#ifdef SCHED_FX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014310 if (PyModule_AddIntConstant(m, "SCHED_FX", SCHED_FSS)) return -1;
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020014311#endif
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014312#endif
14313
Benjamin Peterson9428d532011-09-14 11:45:52 -040014314#ifdef USE_XATTRS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014315 if (PyModule_AddIntMacro(m, XATTR_CREATE)) return -1;
14316 if (PyModule_AddIntMacro(m, XATTR_REPLACE)) return -1;
14317 if (PyModule_AddIntMacro(m, XATTR_SIZE_MAX)) return -1;
Benjamin Peterson799bd802011-08-31 22:15:17 -040014318#endif
14319
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014320#if HAVE_DECL_RTLD_LAZY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014321 if (PyModule_AddIntMacro(m, RTLD_LAZY)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014322#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014323#if HAVE_DECL_RTLD_NOW
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014324 if (PyModule_AddIntMacro(m, RTLD_NOW)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014325#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014326#if HAVE_DECL_RTLD_GLOBAL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014327 if (PyModule_AddIntMacro(m, RTLD_GLOBAL)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014328#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014329#if HAVE_DECL_RTLD_LOCAL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014330 if (PyModule_AddIntMacro(m, RTLD_LOCAL)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014331#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014332#if HAVE_DECL_RTLD_NODELETE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014333 if (PyModule_AddIntMacro(m, RTLD_NODELETE)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014334#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014335#if HAVE_DECL_RTLD_NOLOAD
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014336 if (PyModule_AddIntMacro(m, RTLD_NOLOAD)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014337#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014338#if HAVE_DECL_RTLD_DEEPBIND
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014339 if (PyModule_AddIntMacro(m, RTLD_DEEPBIND)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014340#endif
Michael Feltc5ae1692017-12-19 13:58:49 +010014341#if HAVE_DECL_RTLD_MEMBER
14342 if (PyModule_AddIntMacro(m, RTLD_MEMBER)) return -1;
14343#endif
Victor Stinner8b905bd2011-10-25 13:34:04 +020014344
Victor Stinner9b1f4742016-09-06 16:18:52 -070014345#ifdef HAVE_GETRANDOM_SYSCALL
14346 if (PyModule_AddIntMacro(m, GRND_RANDOM)) return -1;
14347 if (PyModule_AddIntMacro(m, GRND_NONBLOCK)) return -1;
14348#endif
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014349#ifdef HAVE_MEMFD_CREATE
14350 if (PyModule_AddIntMacro(m, MFD_CLOEXEC)) return -1;
14351 if (PyModule_AddIntMacro(m, MFD_ALLOW_SEALING)) return -1;
14352#ifdef MFD_HUGETLB
14353 if (PyModule_AddIntMacro(m, MFD_HUGETLB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014354#endif
14355#ifdef MFD_HUGE_SHIFT
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014356 if (PyModule_AddIntMacro(m, MFD_HUGE_SHIFT)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014357#endif
14358#ifdef MFD_HUGE_MASK
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014359 if (PyModule_AddIntMacro(m, MFD_HUGE_MASK)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014360#endif
14361#ifdef MFD_HUGE_64KB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014362 if (PyModule_AddIntMacro(m, MFD_HUGE_64KB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014363#endif
14364#ifdef MFD_HUGE_512KB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014365 if (PyModule_AddIntMacro(m, MFD_HUGE_512KB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014366#endif
14367#ifdef MFD_HUGE_1MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014368 if (PyModule_AddIntMacro(m, MFD_HUGE_1MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014369#endif
14370#ifdef MFD_HUGE_2MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014371 if (PyModule_AddIntMacro(m, MFD_HUGE_2MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014372#endif
14373#ifdef MFD_HUGE_8MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014374 if (PyModule_AddIntMacro(m, MFD_HUGE_8MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014375#endif
14376#ifdef MFD_HUGE_16MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014377 if (PyModule_AddIntMacro(m, MFD_HUGE_16MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014378#endif
14379#ifdef MFD_HUGE_32MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014380 if (PyModule_AddIntMacro(m, MFD_HUGE_32MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014381#endif
14382#ifdef MFD_HUGE_256MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014383 if (PyModule_AddIntMacro(m, MFD_HUGE_256MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014384#endif
14385#ifdef MFD_HUGE_512MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014386 if (PyModule_AddIntMacro(m, MFD_HUGE_512MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014387#endif
14388#ifdef MFD_HUGE_1GB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014389 if (PyModule_AddIntMacro(m, MFD_HUGE_1GB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014390#endif
14391#ifdef MFD_HUGE_2GB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014392 if (PyModule_AddIntMacro(m, MFD_HUGE_2GB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014393#endif
14394#ifdef MFD_HUGE_16GB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014395 if (PyModule_AddIntMacro(m, MFD_HUGE_16GB)) return -1;
14396#endif
14397#endif
Victor Stinner9b1f4742016-09-06 16:18:52 -070014398
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +020014399#if defined(__APPLE__)
14400 if (PyModule_AddIntConstant(m, "_COPYFILE_DATA", COPYFILE_DATA)) return -1;
14401#endif
14402
Steve Dower2438cdf2019-03-29 16:37:16 -070014403#ifdef MS_WINDOWS
14404 if (PyModule_AddIntConstant(m, "_LOAD_LIBRARY_SEARCH_DEFAULT_DIRS", LOAD_LIBRARY_SEARCH_DEFAULT_DIRS)) return -1;
14405 if (PyModule_AddIntConstant(m, "_LOAD_LIBRARY_SEARCH_APPLICATION_DIR", LOAD_LIBRARY_SEARCH_APPLICATION_DIR)) return -1;
14406 if (PyModule_AddIntConstant(m, "_LOAD_LIBRARY_SEARCH_SYSTEM32", LOAD_LIBRARY_SEARCH_SYSTEM32)) return -1;
14407 if (PyModule_AddIntConstant(m, "_LOAD_LIBRARY_SEARCH_USER_DIRS", LOAD_LIBRARY_SEARCH_USER_DIRS)) return -1;
14408 if (PyModule_AddIntConstant(m, "_LOAD_LIBRARY_SEARCH_DLL_LOAD_DIR", LOAD_LIBRARY_SEARCH_DLL_LOAD_DIR)) return -1;
14409#endif
14410
Victor Stinner8c62be82010-05-06 00:08:46 +000014411 return 0;
Barry Warsaw4a342091996-12-19 23:50:02 +000014412}
14413
14414
Martin v. Löwis1a214512008-06-11 05:26:20 +000014415static struct PyModuleDef posixmodule = {
Victor Stinner8c62be82010-05-06 00:08:46 +000014416 PyModuleDef_HEAD_INIT,
14417 MODNAME,
14418 posix__doc__,
14419 -1,
14420 posix_methods,
14421 NULL,
14422 NULL,
14423 NULL,
14424 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +000014425};
14426
14427
Serhiy Storchaka2d06e842015-12-25 19:53:18 +020014428static const char * const have_functions[] = {
Larry Hastings9cf065c2012-06-22 16:30:09 -070014429
14430#ifdef HAVE_FACCESSAT
14431 "HAVE_FACCESSAT",
14432#endif
14433
14434#ifdef HAVE_FCHDIR
14435 "HAVE_FCHDIR",
14436#endif
14437
14438#ifdef HAVE_FCHMOD
14439 "HAVE_FCHMOD",
14440#endif
14441
14442#ifdef HAVE_FCHMODAT
14443 "HAVE_FCHMODAT",
14444#endif
14445
14446#ifdef HAVE_FCHOWN
14447 "HAVE_FCHOWN",
14448#endif
14449
Larry Hastings00964ed2013-08-12 13:49:30 -040014450#ifdef HAVE_FCHOWNAT
14451 "HAVE_FCHOWNAT",
14452#endif
14453
Larry Hastings9cf065c2012-06-22 16:30:09 -070014454#ifdef HAVE_FEXECVE
14455 "HAVE_FEXECVE",
14456#endif
14457
14458#ifdef HAVE_FDOPENDIR
14459 "HAVE_FDOPENDIR",
14460#endif
14461
Georg Brandl306336b2012-06-24 12:55:33 +020014462#ifdef HAVE_FPATHCONF
14463 "HAVE_FPATHCONF",
14464#endif
14465
Larry Hastings9cf065c2012-06-22 16:30:09 -070014466#ifdef HAVE_FSTATAT
14467 "HAVE_FSTATAT",
14468#endif
14469
14470#ifdef HAVE_FSTATVFS
14471 "HAVE_FSTATVFS",
14472#endif
14473
Steve Dowerfe0a41a2015-03-20 19:50:46 -070014474#if defined HAVE_FTRUNCATE || defined MS_WINDOWS
Georg Brandl306336b2012-06-24 12:55:33 +020014475 "HAVE_FTRUNCATE",
14476#endif
14477
Larry Hastings9cf065c2012-06-22 16:30:09 -070014478#ifdef HAVE_FUTIMENS
14479 "HAVE_FUTIMENS",
14480#endif
14481
14482#ifdef HAVE_FUTIMES
14483 "HAVE_FUTIMES",
14484#endif
14485
14486#ifdef HAVE_FUTIMESAT
14487 "HAVE_FUTIMESAT",
14488#endif
14489
14490#ifdef HAVE_LINKAT
14491 "HAVE_LINKAT",
14492#endif
14493
14494#ifdef HAVE_LCHFLAGS
14495 "HAVE_LCHFLAGS",
14496#endif
14497
14498#ifdef HAVE_LCHMOD
14499 "HAVE_LCHMOD",
14500#endif
14501
14502#ifdef HAVE_LCHOWN
14503 "HAVE_LCHOWN",
14504#endif
14505
14506#ifdef HAVE_LSTAT
14507 "HAVE_LSTAT",
14508#endif
14509
14510#ifdef HAVE_LUTIMES
14511 "HAVE_LUTIMES",
14512#endif
14513
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014514#ifdef HAVE_MEMFD_CREATE
14515 "HAVE_MEMFD_CREATE",
14516#endif
14517
Larry Hastings9cf065c2012-06-22 16:30:09 -070014518#ifdef HAVE_MKDIRAT
14519 "HAVE_MKDIRAT",
14520#endif
14521
14522#ifdef HAVE_MKFIFOAT
14523 "HAVE_MKFIFOAT",
14524#endif
14525
14526#ifdef HAVE_MKNODAT
14527 "HAVE_MKNODAT",
14528#endif
14529
14530#ifdef HAVE_OPENAT
14531 "HAVE_OPENAT",
14532#endif
14533
14534#ifdef HAVE_READLINKAT
14535 "HAVE_READLINKAT",
14536#endif
14537
14538#ifdef HAVE_RENAMEAT
14539 "HAVE_RENAMEAT",
14540#endif
14541
14542#ifdef HAVE_SYMLINKAT
14543 "HAVE_SYMLINKAT",
14544#endif
14545
14546#ifdef HAVE_UNLINKAT
14547 "HAVE_UNLINKAT",
14548#endif
14549
14550#ifdef HAVE_UTIMENSAT
14551 "HAVE_UTIMENSAT",
14552#endif
14553
14554#ifdef MS_WINDOWS
14555 "MS_WINDOWS",
14556#endif
14557
14558 NULL
14559};
14560
14561
Mark Hammondfe51c6d2002-08-02 02:27:13 +000014562PyMODINIT_FUNC
Thomas Woutersf3f33dc2000-07-21 06:00:07 +000014563INITFUNC(void)
Guido van Rossumb6775db1994-08-01 11:34:53 +000014564{
Victor Stinner8c62be82010-05-06 00:08:46 +000014565 PyObject *m, *v;
Larry Hastings9cf065c2012-06-22 16:30:09 -070014566 PyObject *list;
Serhiy Storchaka2d06e842015-12-25 19:53:18 +020014567 const char * const *trace;
Tim Peters5aa91602002-01-30 05:46:57 +000014568
Victor Stinner8c62be82010-05-06 00:08:46 +000014569 m = PyModule_Create(&posixmodule);
14570 if (m == NULL)
14571 return NULL;
Tim Peters5aa91602002-01-30 05:46:57 +000014572
Victor Stinner8c62be82010-05-06 00:08:46 +000014573 /* Initialize environ dictionary */
14574 v = convertenviron();
14575 Py_XINCREF(v);
14576 if (v == NULL || PyModule_AddObject(m, "environ", v) != 0)
14577 return NULL;
14578 Py_DECREF(v);
Fred Drakec9680921999-12-13 16:37:25 +000014579
Victor Stinner8c62be82010-05-06 00:08:46 +000014580 if (all_ins(m))
14581 return NULL;
Barry Warsaw4a342091996-12-19 23:50:02 +000014582
Victor Stinner8c62be82010-05-06 00:08:46 +000014583 if (setup_confname_tables(m))
14584 return NULL;
Fred Drakebec628d1999-12-15 18:31:10 +000014585
Victor Stinner8c62be82010-05-06 00:08:46 +000014586 Py_INCREF(PyExc_OSError);
14587 PyModule_AddObject(m, "error", PyExc_OSError);
Fred Drake762e2061999-08-26 17:23:54 +000014588
Guido van Rossumb3d39562000-01-31 18:41:26 +000014589#ifdef HAVE_PUTENV
Victor Stinner8c62be82010-05-06 00:08:46 +000014590 if (posix_putenv_garbage == NULL)
14591 posix_putenv_garbage = PyDict_New();
Guido van Rossumb3d39562000-01-31 18:41:26 +000014592#endif
Guido van Rossum98bf58f2001-10-18 20:34:25 +000014593
Victor Stinner8c62be82010-05-06 00:08:46 +000014594 if (!initialized) {
Ross Lagerwall7807c352011-03-17 20:20:30 +020014595#if defined(HAVE_WAITID) && !defined(__APPLE__)
14596 waitid_result_desc.name = MODNAME ".waitid_result";
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014597 WaitidResultType = PyStructSequence_NewType(&waitid_result_desc);
14598 if (WaitidResultType == NULL) {
Victor Stinner1c8f0592013-07-22 22:24:54 +020014599 return NULL;
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014600 }
Ross Lagerwall7807c352011-03-17 20:20:30 +020014601#endif
14602
Christian Heimes25827622013-10-12 01:27:08 +020014603 stat_result_desc.name = "os.stat_result"; /* see issue #19209 */
Victor Stinner8c62be82010-05-06 00:08:46 +000014604 stat_result_desc.fields[7].name = PyStructSequence_UnnamedField;
14605 stat_result_desc.fields[8].name = PyStructSequence_UnnamedField;
14606 stat_result_desc.fields[9].name = PyStructSequence_UnnamedField;
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014607 StatResultType = PyStructSequence_NewType(&stat_result_desc);
14608 if (StatResultType == NULL) {
Victor Stinner1c8f0592013-07-22 22:24:54 +020014609 return NULL;
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014610 }
14611 structseq_new = StatResultType->tp_new;
14612 StatResultType->tp_new = statresult_new;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000014613
Christian Heimes25827622013-10-12 01:27:08 +020014614 statvfs_result_desc.name = "os.statvfs_result"; /* see issue #19209 */
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014615 StatVFSResultType = PyStructSequence_NewType(&statvfs_result_desc);
14616 if (StatVFSResultType == NULL) {
Victor Stinner1c8f0592013-07-22 22:24:54 +020014617 return NULL;
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014618 }
Martin v. Löwis05bfe1f2008-12-29 18:21:47 +000014619#ifdef NEED_TICKS_PER_SECOND
14620# if defined(HAVE_SYSCONF) && defined(_SC_CLK_TCK)
Victor Stinner8c62be82010-05-06 00:08:46 +000014621 ticks_per_second = sysconf(_SC_CLK_TCK);
Martin v. Löwis05bfe1f2008-12-29 18:21:47 +000014622# elif defined(HZ)
Victor Stinner8c62be82010-05-06 00:08:46 +000014623 ticks_per_second = HZ;
Martin v. Löwis05bfe1f2008-12-29 18:21:47 +000014624# else
Victor Stinner8c62be82010-05-06 00:08:46 +000014625 ticks_per_second = 60; /* magic fallback value; may be bogus */
Martin v. Löwis05bfe1f2008-12-29 18:21:47 +000014626# endif
14627#endif
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014628
William Orr81574b82018-10-01 22:19:56 -070014629#if defined(HAVE_SCHED_SETPARAM) || defined(HAVE_SCHED_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDPARAM)
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014630 sched_param_desc.name = MODNAME ".sched_param";
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014631 SchedParamType = PyStructSequence_NewType(&sched_param_desc);
14632 if (SchedParamType == NULL) {
Victor Stinner1c8f0592013-07-22 22:24:54 +020014633 return NULL;
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014634 }
14635 SchedParamType->tp_new = os_sched_param;
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014636#endif
Antoine Pitroubcf2b592012-02-08 23:28:36 +010014637
14638 /* initialize TerminalSize_info */
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014639 TerminalSizeType = PyStructSequence_NewType(&TerminalSize_desc);
14640 if (TerminalSizeType == NULL) {
Victor Stinner1c8f0592013-07-22 22:24:54 +020014641 return NULL;
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014642 }
Victor Stinner6036e442015-03-08 01:58:04 +010014643
14644 /* initialize scandir types */
14645 if (PyType_Ready(&ScandirIteratorType) < 0)
14646 return NULL;
14647 if (PyType_Ready(&DirEntryType) < 0)
14648 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +000014649 }
Ross Lagerwall7807c352011-03-17 20:20:30 +020014650#if defined(HAVE_WAITID) && !defined(__APPLE__)
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014651 Py_INCREF((PyObject*) WaitidResultType);
14652 PyModule_AddObject(m, "waitid_result", (PyObject*) WaitidResultType);
Ross Lagerwall7807c352011-03-17 20:20:30 +020014653#endif
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014654 Py_INCREF((PyObject*) StatResultType);
14655 PyModule_AddObject(m, "stat_result", (PyObject*) StatResultType);
14656 Py_INCREF((PyObject*) StatVFSResultType);
Victor Stinner8c62be82010-05-06 00:08:46 +000014657 PyModule_AddObject(m, "statvfs_result",
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014658 (PyObject*) StatVFSResultType);
Benjamin Petersone3298dd2011-08-02 18:40:46 -050014659
14660#if defined(HAVE_SCHED_SETPARAM) || defined(HAVE_SCHED_SETSCHEDULER)
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014661 Py_INCREF(SchedParamType);
14662 PyModule_AddObject(m, "sched_param", (PyObject *)SchedParamType);
Benjamin Petersone3298dd2011-08-02 18:40:46 -050014663#endif
Thomas Wouters477c8d52006-05-27 19:21:47 +000014664
Larry Hastings605a62d2012-06-24 04:33:36 -070014665 times_result_desc.name = MODNAME ".times_result";
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014666 TimesResultType = PyStructSequence_NewType(&times_result_desc);
14667 if (TimesResultType == NULL) {
Victor Stinner1c8f0592013-07-22 22:24:54 +020014668 return NULL;
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014669 }
14670 PyModule_AddObject(m, "times_result", (PyObject *)TimesResultType);
Larry Hastings605a62d2012-06-24 04:33:36 -070014671
14672 uname_result_desc.name = MODNAME ".uname_result";
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014673 UnameResultType = PyStructSequence_NewType(&uname_result_desc);
14674 if (UnameResultType == NULL) {
Victor Stinner1c8f0592013-07-22 22:24:54 +020014675 return NULL;
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014676 }
14677 PyModule_AddObject(m, "uname_result", (PyObject *)UnameResultType);
Larry Hastings605a62d2012-06-24 04:33:36 -070014678
Thomas Wouters477c8d52006-05-27 19:21:47 +000014679#ifdef __APPLE__
Victor Stinner8c62be82010-05-06 00:08:46 +000014680 /*
14681 * Step 2 of weak-linking support on Mac OS X.
14682 *
14683 * The code below removes functions that are not available on the
14684 * currently active platform.
14685 *
14686 * This block allow one to use a python binary that was build on
Larry Hastings9cf065c2012-06-22 16:30:09 -070014687 * OSX 10.4 on OSX 10.3, without losing access to new APIs on
Victor Stinner8c62be82010-05-06 00:08:46 +000014688 * OSX 10.4.
14689 */
Thomas Wouters477c8d52006-05-27 19:21:47 +000014690#ifdef HAVE_FSTATVFS
Victor Stinner8c62be82010-05-06 00:08:46 +000014691 if (fstatvfs == NULL) {
14692 if (PyObject_DelAttrString(m, "fstatvfs") == -1) {
14693 return NULL;
14694 }
14695 }
Thomas Wouters477c8d52006-05-27 19:21:47 +000014696#endif /* HAVE_FSTATVFS */
14697
14698#ifdef HAVE_STATVFS
Victor Stinner8c62be82010-05-06 00:08:46 +000014699 if (statvfs == NULL) {
14700 if (PyObject_DelAttrString(m, "statvfs") == -1) {
14701 return NULL;
14702 }
14703 }
Thomas Wouters477c8d52006-05-27 19:21:47 +000014704#endif /* HAVE_STATVFS */
14705
14706# ifdef HAVE_LCHOWN
Victor Stinner8c62be82010-05-06 00:08:46 +000014707 if (lchown == NULL) {
14708 if (PyObject_DelAttrString(m, "lchown") == -1) {
14709 return NULL;
14710 }
14711 }
Thomas Wouters477c8d52006-05-27 19:21:47 +000014712#endif /* HAVE_LCHOWN */
14713
14714
14715#endif /* __APPLE__ */
Antoine Pitroubcf2b592012-02-08 23:28:36 +010014716
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014717 Py_INCREF(TerminalSizeType);
14718 PyModule_AddObject(m, "terminal_size", (PyObject*)TerminalSizeType);
Antoine Pitroubcf2b592012-02-08 23:28:36 +010014719
Larry Hastings6fe20b32012-04-19 15:07:49 -070014720 billion = PyLong_FromLong(1000000000);
14721 if (!billion)
14722 return NULL;
14723
Larry Hastings9cf065c2012-06-22 16:30:09 -070014724 /* suppress "function not used" warnings */
14725 {
14726 int ignored;
14727 fd_specified("", -1);
14728 follow_symlinks_specified("", 1);
14729 dir_fd_and_follow_symlinks_invalid("chmod", DEFAULT_DIR_FD, 1);
14730 dir_fd_converter(Py_None, &ignored);
14731 dir_fd_unavailable(Py_None, &ignored);
14732 }
14733
14734 /*
14735 * provide list of locally available functions
14736 * so os.py can populate support_* lists
14737 */
14738 list = PyList_New(0);
14739 if (!list)
14740 return NULL;
14741 for (trace = have_functions; *trace; trace++) {
14742 PyObject *unicode = PyUnicode_DecodeASCII(*trace, strlen(*trace), NULL);
14743 if (!unicode)
14744 return NULL;
14745 if (PyList_Append(list, unicode))
14746 return NULL;
14747 Py_DECREF(unicode);
14748 }
14749 PyModule_AddObject(m, "_have_functions", list);
Ned Deilyeb3be662016-08-15 14:40:38 -040014750
14751 Py_INCREF((PyObject *) &DirEntryType);
Brett Cannona32c4d02016-06-24 14:14:44 -070014752 PyModule_AddObject(m, "DirEntry", (PyObject *)&DirEntryType);
Larry Hastings9cf065c2012-06-22 16:30:09 -070014753
14754 initialized = 1;
14755
Victor Stinner8c62be82010-05-06 00:08:46 +000014756 return m;
Guido van Rossumb6775db1994-08-01 11:34:53 +000014757}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000014758
14759#ifdef __cplusplus
14760}
14761#endif