blob: be7ebb67d21eef5ac754627b5e5d10dae839b489 [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
6909#ifdef __APPLE__
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02006910 groups = PyMem_New(int, ngroups);
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006911#else
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02006912 groups = PyMem_New(gid_t, ngroups);
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006913#endif
6914 if (groups == NULL)
6915 return PyErr_NoMemory();
6916
Miss Islington (bot)21bee0b2020-03-23 12:18:41 -07006917#ifdef __APPLE__
6918 while (getgrouplist(user, basegid, groups, &ngroups)) {
6919 /* On macOS, getgrouplist() returns a non-zero value without setting
6920 errno if the group list is too small. Double the list size and call
6921 it again in this case. */
6922 PyMem_Free(groups);
6923
6924 if (ngroups > INT_MAX / 2) {
6925 return PyErr_NoMemory();
6926 }
6927 ngroups *= 2;
6928
6929 groups = PyMem_New(int, ngroups);
6930 if (groups == NULL) {
6931 return PyErr_NoMemory();
6932 }
6933 }
6934#else
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006935 if (getgrouplist(user, basegid, groups, &ngroups) == -1) {
6936 PyMem_Del(groups);
6937 return posix_error();
6938 }
Miss Islington (bot)21bee0b2020-03-23 12:18:41 -07006939#endif
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006940
Gregory P. Smith1d300ce2018-12-30 21:13:02 -08006941#ifdef _Py_MEMORY_SANITIZER
6942 /* Clang memory sanitizer libc intercepts don't know getgrouplist. */
6943 __msan_unpoison(&ngroups, sizeof(ngroups));
6944 __msan_unpoison(groups, ngroups*sizeof(*groups));
6945#endif
6946
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006947 list = PyList_New(ngroups);
6948 if (list == NULL) {
6949 PyMem_Del(groups);
6950 return NULL;
6951 }
6952
6953 for (i = 0; i < ngroups; i++) {
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006954#ifdef __APPLE__
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006955 PyObject *o = PyLong_FromUnsignedLong((unsigned long)groups[i]);
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006956#else
6957 PyObject *o = _PyLong_FromGid(groups[i]);
6958#endif
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006959 if (o == NULL) {
6960 Py_DECREF(list);
6961 PyMem_Del(groups);
6962 return NULL;
6963 }
6964 PyList_SET_ITEM(list, i, o);
6965 }
6966
6967 PyMem_Del(groups);
6968
6969 return list;
6970}
Larry Hastings2f936352014-08-05 14:04:04 +10006971#endif /* HAVE_GETGROUPLIST */
6972
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006973
Fred Drakec9680921999-12-13 16:37:25 +00006974#ifdef HAVE_GETGROUPS
Larry Hastings2f936352014-08-05 14:04:04 +10006975/*[clinic input]
6976os.getgroups
6977
6978Return list of supplemental group IDs for the process.
6979[clinic start generated code]*/
6980
Larry Hastings2f936352014-08-05 14:04:04 +10006981static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006982os_getgroups_impl(PyObject *module)
6983/*[clinic end generated code: output=42b0c17758561b56 input=d3f109412e6a155c]*/
Fred Drakec9680921999-12-13 16:37:25 +00006984{
6985 PyObject *result = NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00006986 gid_t grouplist[MAX_GROUPS];
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00006987
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00006988 /* On MacOSX getgroups(2) can return more than MAX_GROUPS results
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00006989 * This is a helper variable to store the intermediate result when
6990 * that happens.
6991 *
6992 * To keep the code readable the OSX behaviour is unconditional,
6993 * according to the POSIX spec this should be safe on all unix-y
6994 * systems.
6995 */
6996 gid_t* alt_grouplist = grouplist;
Victor Stinner8c62be82010-05-06 00:08:46 +00006997 int n;
Fred Drakec9680921999-12-13 16:37:25 +00006998
Ned Deilyb5dd6d22013-08-01 21:21:15 -07006999#ifdef __APPLE__
7000 /* Issue #17557: As of OS X 10.8, getgroups(2) no longer raises EINVAL if
7001 * there are more groups than can fit in grouplist. Therefore, on OS X
7002 * always first call getgroups with length 0 to get the actual number
7003 * of groups.
7004 */
7005 n = getgroups(0, NULL);
7006 if (n < 0) {
7007 return posix_error();
7008 } else if (n <= MAX_GROUPS) {
7009 /* groups will fit in existing array */
7010 alt_grouplist = grouplist;
7011 } else {
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02007012 alt_grouplist = PyMem_New(gid_t, n);
Ned Deilyb5dd6d22013-08-01 21:21:15 -07007013 if (alt_grouplist == NULL) {
Zackery Spytz4c49da02018-12-07 03:11:30 -07007014 return PyErr_NoMemory();
Ned Deilyb5dd6d22013-08-01 21:21:15 -07007015 }
7016 }
7017
7018 n = getgroups(n, alt_grouplist);
7019 if (n == -1) {
7020 if (alt_grouplist != grouplist) {
7021 PyMem_Free(alt_grouplist);
7022 }
7023 return posix_error();
7024 }
7025#else
Victor Stinner8c62be82010-05-06 00:08:46 +00007026 n = getgroups(MAX_GROUPS, grouplist);
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00007027 if (n < 0) {
7028 if (errno == EINVAL) {
7029 n = getgroups(0, NULL);
7030 if (n == -1) {
7031 return posix_error();
7032 }
7033 if (n == 0) {
7034 /* Avoid malloc(0) */
7035 alt_grouplist = grouplist;
7036 } else {
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02007037 alt_grouplist = PyMem_New(gid_t, n);
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00007038 if (alt_grouplist == NULL) {
Zackery Spytz4c49da02018-12-07 03:11:30 -07007039 return PyErr_NoMemory();
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00007040 }
7041 n = getgroups(n, alt_grouplist);
7042 if (n == -1) {
7043 PyMem_Free(alt_grouplist);
7044 return posix_error();
7045 }
7046 }
7047 } else {
7048 return posix_error();
7049 }
7050 }
Ned Deilyb5dd6d22013-08-01 21:21:15 -07007051#endif
7052
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00007053 result = PyList_New(n);
7054 if (result != NULL) {
Victor Stinner8c62be82010-05-06 00:08:46 +00007055 int i;
7056 for (i = 0; i < n; ++i) {
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02007057 PyObject *o = _PyLong_FromGid(alt_grouplist[i]);
Victor Stinner8c62be82010-05-06 00:08:46 +00007058 if (o == NULL) {
Stefan Krah0e803b32010-11-26 16:16:47 +00007059 Py_DECREF(result);
7060 result = NULL;
7061 break;
Fred Drakec9680921999-12-13 16:37:25 +00007062 }
Victor Stinner8c62be82010-05-06 00:08:46 +00007063 PyList_SET_ITEM(result, i, o);
Fred Drakec9680921999-12-13 16:37:25 +00007064 }
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00007065 }
7066
7067 if (alt_grouplist != grouplist) {
7068 PyMem_Free(alt_grouplist);
Victor Stinner8c62be82010-05-06 00:08:46 +00007069 }
Neal Norwitze241ce82003-02-17 18:17:05 +00007070
Fred Drakec9680921999-12-13 16:37:25 +00007071 return result;
7072}
Larry Hastings2f936352014-08-05 14:04:04 +10007073#endif /* HAVE_GETGROUPS */
Fred Drakec9680921999-12-13 16:37:25 +00007074
Antoine Pitroub7572f02009-12-02 20:46:48 +00007075#ifdef HAVE_INITGROUPS
7076PyDoc_STRVAR(posix_initgroups__doc__,
7077"initgroups(username, gid) -> None\n\n\
7078Call the system initgroups() to initialize the group access list with all of\n\
7079the groups of which the specified username is a member, plus the specified\n\
7080group id.");
7081
Larry Hastings2f936352014-08-05 14:04:04 +10007082/* AC 3.5: funny apple logic */
Antoine Pitroub7572f02009-12-02 20:46:48 +00007083static PyObject *
7084posix_initgroups(PyObject *self, PyObject *args)
7085{
Victor Stinner61ec5dc2010-08-15 09:22:44 +00007086 PyObject *oname;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03007087 const char *username;
Victor Stinner61ec5dc2010-08-15 09:22:44 +00007088 int res;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02007089#ifdef __APPLE__
7090 int gid;
7091#else
7092 gid_t gid;
7093#endif
Antoine Pitroub7572f02009-12-02 20:46:48 +00007094
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02007095#ifdef __APPLE__
7096 if (!PyArg_ParseTuple(args, "O&i:initgroups",
7097 PyUnicode_FSConverter, &oname,
7098 &gid))
7099#else
7100 if (!PyArg_ParseTuple(args, "O&O&:initgroups",
7101 PyUnicode_FSConverter, &oname,
7102 _Py_Gid_Converter, &gid))
7103#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00007104 return NULL;
Victor Stinner61ec5dc2010-08-15 09:22:44 +00007105 username = PyBytes_AS_STRING(oname);
Antoine Pitroub7572f02009-12-02 20:46:48 +00007106
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02007107 res = initgroups(username, gid);
Victor Stinner61ec5dc2010-08-15 09:22:44 +00007108 Py_DECREF(oname);
7109 if (res == -1)
Victor Stinner8c62be82010-05-06 00:08:46 +00007110 return PyErr_SetFromErrno(PyExc_OSError);
Antoine Pitroub7572f02009-12-02 20:46:48 +00007111
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02007112 Py_RETURN_NONE;
Antoine Pitroub7572f02009-12-02 20:46:48 +00007113}
Larry Hastings2f936352014-08-05 14:04:04 +10007114#endif /* HAVE_INITGROUPS */
7115
Antoine Pitroub7572f02009-12-02 20:46:48 +00007116
Martin v. Löwis606edc12002-06-13 21:09:11 +00007117#ifdef HAVE_GETPGID
Larry Hastings2f936352014-08-05 14:04:04 +10007118/*[clinic input]
7119os.getpgid
7120
7121 pid: pid_t
7122
7123Call the system call getpgid(), and return the result.
7124[clinic start generated code]*/
7125
Larry Hastings2f936352014-08-05 14:04:04 +10007126static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007127os_getpgid_impl(PyObject *module, pid_t pid)
7128/*[clinic end generated code: output=1db95a97be205d18 input=39d710ae3baaf1c7]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007129{
7130 pid_t pgid = getpgid(pid);
Victor Stinner8c62be82010-05-06 00:08:46 +00007131 if (pgid < 0)
7132 return posix_error();
7133 return PyLong_FromPid(pgid);
Martin v. Löwis606edc12002-06-13 21:09:11 +00007134}
7135#endif /* HAVE_GETPGID */
7136
7137
Guido van Rossumb6775db1994-08-01 11:34:53 +00007138#ifdef HAVE_GETPGRP
Larry Hastings2f936352014-08-05 14:04:04 +10007139/*[clinic input]
7140os.getpgrp
7141
7142Return the current process group id.
7143[clinic start generated code]*/
7144
Larry Hastings2f936352014-08-05 14:04:04 +10007145static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007146os_getpgrp_impl(PyObject *module)
7147/*[clinic end generated code: output=c4fc381e51103cf3 input=6846fb2bb9a3705e]*/
Guido van Rossum04814471991-06-04 20:23:49 +00007148{
Guido van Rossumb6775db1994-08-01 11:34:53 +00007149#ifdef GETPGRP_HAVE_ARG
Victor Stinner8c62be82010-05-06 00:08:46 +00007150 return PyLong_FromPid(getpgrp(0));
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00007151#else /* GETPGRP_HAVE_ARG */
Victor Stinner8c62be82010-05-06 00:08:46 +00007152 return PyLong_FromPid(getpgrp());
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00007153#endif /* GETPGRP_HAVE_ARG */
Guido van Rossum04814471991-06-04 20:23:49 +00007154}
Guido van Rossumb6775db1994-08-01 11:34:53 +00007155#endif /* HAVE_GETPGRP */
Guido van Rossum04814471991-06-04 20:23:49 +00007156
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007157
Guido van Rossumb6775db1994-08-01 11:34:53 +00007158#ifdef HAVE_SETPGRP
Larry Hastings2f936352014-08-05 14:04:04 +10007159/*[clinic input]
7160os.setpgrp
7161
7162Make the current process the leader of its process group.
7163[clinic start generated code]*/
7164
Larry Hastings2f936352014-08-05 14:04:04 +10007165static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007166os_setpgrp_impl(PyObject *module)
7167/*[clinic end generated code: output=2554735b0a60f0a0 input=1f0619fcb5731e7e]*/
Guido van Rossumc2670a01992-09-13 20:07:29 +00007168{
Guido van Rossum64933891994-10-20 21:56:42 +00007169#ifdef SETPGRP_HAVE_ARG
Victor Stinner8c62be82010-05-06 00:08:46 +00007170 if (setpgrp(0, 0) < 0)
Guido van Rossum64933891994-10-20 21:56:42 +00007171#else /* SETPGRP_HAVE_ARG */
Victor Stinner8c62be82010-05-06 00:08:46 +00007172 if (setpgrp() < 0)
Guido van Rossum64933891994-10-20 21:56:42 +00007173#endif /* SETPGRP_HAVE_ARG */
Victor Stinner8c62be82010-05-06 00:08:46 +00007174 return posix_error();
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02007175 Py_RETURN_NONE;
Guido van Rossumc2670a01992-09-13 20:07:29 +00007176}
Guido van Rossumb6775db1994-08-01 11:34:53 +00007177#endif /* HAVE_SETPGRP */
7178
Guido van Rossumad0ee831995-03-01 10:34:45 +00007179#ifdef HAVE_GETPPID
Amaury Forgeot d'Arc4b6fdf32010-09-07 21:31:17 +00007180
7181#ifdef MS_WINDOWS
7182#include <tlhelp32.h>
7183
7184static PyObject*
7185win32_getppid()
7186{
7187 HANDLE snapshot;
7188 pid_t mypid;
7189 PyObject* result = NULL;
7190 BOOL have_record;
7191 PROCESSENTRY32 pe;
7192
7193 mypid = getpid(); /* This function never fails */
7194
7195 snapshot = CreateToolhelp32Snapshot(TH32CS_SNAPPROCESS, 0);
7196 if (snapshot == INVALID_HANDLE_VALUE)
7197 return PyErr_SetFromWindowsErr(GetLastError());
7198
7199 pe.dwSize = sizeof(pe);
7200 have_record = Process32First(snapshot, &pe);
7201 while (have_record) {
7202 if (mypid == (pid_t)pe.th32ProcessID) {
7203 /* We could cache the ulong value in a static variable. */
7204 result = PyLong_FromPid((pid_t)pe.th32ParentProcessID);
7205 break;
7206 }
7207
7208 have_record = Process32Next(snapshot, &pe);
7209 }
7210
7211 /* If our loop exits and our pid was not found (result will be NULL)
7212 * then GetLastError will return ERROR_NO_MORE_FILES. This is an
7213 * error anyway, so let's raise it. */
7214 if (!result)
7215 result = PyErr_SetFromWindowsErr(GetLastError());
7216
7217 CloseHandle(snapshot);
7218
7219 return result;
7220}
7221#endif /*MS_WINDOWS*/
7222
Larry Hastings2f936352014-08-05 14:04:04 +10007223
7224/*[clinic input]
7225os.getppid
7226
7227Return the parent's process id.
7228
7229If the parent process has already exited, Windows machines will still
7230return its id; others systems will return the id of the 'init' process (1).
7231[clinic start generated code]*/
7232
Larry Hastings2f936352014-08-05 14:04:04 +10007233static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007234os_getppid_impl(PyObject *module)
7235/*[clinic end generated code: output=43b2a946a8c603b4 input=e637cb87539c030e]*/
Guido van Rossum85e3b011991-06-03 12:42:10 +00007236{
Amaury Forgeot d'Arc4b6fdf32010-09-07 21:31:17 +00007237#ifdef MS_WINDOWS
7238 return win32_getppid();
7239#else
Victor Stinner8c62be82010-05-06 00:08:46 +00007240 return PyLong_FromPid(getppid());
Guido van Rossumad0ee831995-03-01 10:34:45 +00007241#endif
Amaury Forgeot d'Arc4b6fdf32010-09-07 21:31:17 +00007242}
7243#endif /* HAVE_GETPPID */
Guido van Rossum85e3b011991-06-03 12:42:10 +00007244
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007245
Fred Drake12c6e2d1999-12-14 21:25:03 +00007246#ifdef HAVE_GETLOGIN
Larry Hastings2f936352014-08-05 14:04:04 +10007247/*[clinic input]
7248os.getlogin
7249
7250Return the actual login name.
7251[clinic start generated code]*/
7252
Larry Hastings2f936352014-08-05 14:04:04 +10007253static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007254os_getlogin_impl(PyObject *module)
7255/*[clinic end generated code: output=a32e66a7e5715dac input=2a21ab1e917163df]*/
Fred Drake12c6e2d1999-12-14 21:25:03 +00007256{
Victor Stinner8c62be82010-05-06 00:08:46 +00007257 PyObject *result = NULL;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00007258#ifdef MS_WINDOWS
Brian Curtine8e4b3b2010-09-23 20:04:14 +00007259 wchar_t user_name[UNLEN + 1];
Victor Stinner63941882011-09-29 00:42:28 +02007260 DWORD num_chars = Py_ARRAY_LENGTH(user_name);
Brian Curtine8e4b3b2010-09-23 20:04:14 +00007261
7262 if (GetUserNameW(user_name, &num_chars)) {
7263 /* num_chars is the number of unicode chars plus null terminator */
7264 result = PyUnicode_FromWideChar(user_name, num_chars - 1);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00007265 }
7266 else
Brian Curtine8e4b3b2010-09-23 20:04:14 +00007267 result = PyErr_SetFromWindowsErr(GetLastError());
7268#else
Victor Stinner8c62be82010-05-06 00:08:46 +00007269 char *name;
7270 int old_errno = errno;
Fred Drake12c6e2d1999-12-14 21:25:03 +00007271
Victor Stinner8c62be82010-05-06 00:08:46 +00007272 errno = 0;
7273 name = getlogin();
7274 if (name == NULL) {
7275 if (errno)
Victor Stinnere039ffe2010-08-15 09:33:08 +00007276 posix_error();
Fred Drake12c6e2d1999-12-14 21:25:03 +00007277 else
Victor Stinnere039ffe2010-08-15 09:33:08 +00007278 PyErr_SetString(PyExc_OSError, "unable to determine login name");
Victor Stinner8c62be82010-05-06 00:08:46 +00007279 }
7280 else
Victor Stinnere039ffe2010-08-15 09:33:08 +00007281 result = PyUnicode_DecodeFSDefault(name);
Victor Stinner8c62be82010-05-06 00:08:46 +00007282 errno = old_errno;
Brian Curtine8e4b3b2010-09-23 20:04:14 +00007283#endif
Fred Drake12c6e2d1999-12-14 21:25:03 +00007284 return result;
7285}
Brian Curtine8e4b3b2010-09-23 20:04:14 +00007286#endif /* HAVE_GETLOGIN */
Fred Drake12c6e2d1999-12-14 21:25:03 +00007287
Larry Hastings2f936352014-08-05 14:04:04 +10007288
Guido van Rossumad0ee831995-03-01 10:34:45 +00007289#ifdef HAVE_GETUID
Larry Hastings2f936352014-08-05 14:04:04 +10007290/*[clinic input]
7291os.getuid
7292
7293Return the current process's user id.
7294[clinic start generated code]*/
7295
Larry Hastings2f936352014-08-05 14:04:04 +10007296static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007297os_getuid_impl(PyObject *module)
7298/*[clinic end generated code: output=415c0b401ebed11a input=b53c8b35f110a516]*/
Guido van Rossum46003ff1992-05-15 11:05:24 +00007299{
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02007300 return _PyLong_FromUid(getuid());
Guido van Rossum46003ff1992-05-15 11:05:24 +00007301}
Larry Hastings2f936352014-08-05 14:04:04 +10007302#endif /* HAVE_GETUID */
Guido van Rossum46003ff1992-05-15 11:05:24 +00007303
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007304
Brian Curtineb24d742010-04-12 17:16:38 +00007305#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10007306#define HAVE_KILL
7307#endif /* MS_WINDOWS */
7308
7309#ifdef HAVE_KILL
7310/*[clinic input]
7311os.kill
7312
7313 pid: pid_t
7314 signal: Py_ssize_t
7315 /
7316
7317Kill a process with a signal.
7318[clinic start generated code]*/
7319
Larry Hastings2f936352014-08-05 14:04:04 +10007320static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007321os_kill_impl(PyObject *module, pid_t pid, Py_ssize_t signal)
7322/*[clinic end generated code: output=8e346a6701c88568 input=61a36b86ca275ab9]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007323{
Steve Dowera00b5be2020-02-13 08:30:27 +00007324 if (PySys_Audit("os.kill", "in", pid, signal) < 0) {
7325 return NULL;
7326 }
7327#ifndef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10007328 if (kill(pid, (int)signal) == -1)
7329 return posix_error();
7330 Py_RETURN_NONE;
Larry Hastings2f936352014-08-05 14:04:04 +10007331#else /* !MS_WINDOWS */
Amaury Forgeot d'Arc0a589c92010-05-15 20:35:12 +00007332 PyObject *result;
Larry Hastings2f936352014-08-05 14:04:04 +10007333 DWORD sig = (DWORD)signal;
7334 DWORD err;
Victor Stinner8c62be82010-05-06 00:08:46 +00007335 HANDLE handle;
Brian Curtineb24d742010-04-12 17:16:38 +00007336
Victor Stinner8c62be82010-05-06 00:08:46 +00007337 /* Console processes which share a common console can be sent CTRL+C or
7338 CTRL+BREAK events, provided they handle said events. */
7339 if (sig == CTRL_C_EVENT || sig == CTRL_BREAK_EVENT) {
Richard Oudkerkac0ad882013-06-05 23:29:30 +01007340 if (GenerateConsoleCtrlEvent(sig, (DWORD)pid) == 0) {
Victor Stinner8c62be82010-05-06 00:08:46 +00007341 err = GetLastError();
7342 PyErr_SetFromWindowsErr(err);
7343 }
7344 else
7345 Py_RETURN_NONE;
7346 }
Brian Curtineb24d742010-04-12 17:16:38 +00007347
Victor Stinner8c62be82010-05-06 00:08:46 +00007348 /* If the signal is outside of what GenerateConsoleCtrlEvent can use,
7349 attempt to open and terminate the process. */
Richard Oudkerkac0ad882013-06-05 23:29:30 +01007350 handle = OpenProcess(PROCESS_ALL_ACCESS, FALSE, (DWORD)pid);
Victor Stinner8c62be82010-05-06 00:08:46 +00007351 if (handle == NULL) {
7352 err = GetLastError();
7353 return PyErr_SetFromWindowsErr(err);
7354 }
Brian Curtineb24d742010-04-12 17:16:38 +00007355
Victor Stinner8c62be82010-05-06 00:08:46 +00007356 if (TerminateProcess(handle, sig) == 0) {
7357 err = GetLastError();
7358 result = PyErr_SetFromWindowsErr(err);
7359 } else {
7360 Py_INCREF(Py_None);
7361 result = Py_None;
7362 }
Brian Curtineb24d742010-04-12 17:16:38 +00007363
Victor Stinner8c62be82010-05-06 00:08:46 +00007364 CloseHandle(handle);
7365 return result;
Larry Hastings2f936352014-08-05 14:04:04 +10007366#endif /* !MS_WINDOWS */
Steve Dowera00b5be2020-02-13 08:30:27 +00007367}
Larry Hastings2f936352014-08-05 14:04:04 +10007368#endif /* HAVE_KILL */
7369
7370
7371#ifdef HAVE_KILLPG
7372/*[clinic input]
7373os.killpg
7374
7375 pgid: pid_t
7376 signal: int
7377 /
7378
7379Kill a process group with a signal.
7380[clinic start generated code]*/
7381
Larry Hastings2f936352014-08-05 14:04:04 +10007382static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007383os_killpg_impl(PyObject *module, pid_t pgid, int signal)
7384/*[clinic end generated code: output=6dbcd2f1fdf5fdba input=38b5449eb8faec19]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007385{
Steve Dowera00b5be2020-02-13 08:30:27 +00007386 if (PySys_Audit("os.killpg", "ii", pgid, signal) < 0) {
7387 return NULL;
7388 }
Larry Hastings2f936352014-08-05 14:04:04 +10007389 /* XXX some man pages make the `pgid` parameter an int, others
7390 a pid_t. Since getpgrp() returns a pid_t, we assume killpg should
7391 take the same type. Moreover, pid_t is always at least as wide as
7392 int (else compilation of this module fails), which is safe. */
7393 if (killpg(pgid, signal) == -1)
7394 return posix_error();
7395 Py_RETURN_NONE;
7396}
7397#endif /* HAVE_KILLPG */
7398
Brian Curtineb24d742010-04-12 17:16:38 +00007399
Guido van Rossumc0125471996-06-28 18:55:32 +00007400#ifdef HAVE_PLOCK
Guido van Rossumc0125471996-06-28 18:55:32 +00007401#ifdef HAVE_SYS_LOCK_H
7402#include <sys/lock.h>
7403#endif
7404
Larry Hastings2f936352014-08-05 14:04:04 +10007405/*[clinic input]
7406os.plock
7407 op: int
7408 /
7409
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00007410Lock program segments into memory.");
Larry Hastings2f936352014-08-05 14:04:04 +10007411[clinic start generated code]*/
7412
Larry Hastings2f936352014-08-05 14:04:04 +10007413static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007414os_plock_impl(PyObject *module, int op)
7415/*[clinic end generated code: output=81424167033b168e input=e6e5e348e1525f60]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007416{
Victor Stinner8c62be82010-05-06 00:08:46 +00007417 if (plock(op) == -1)
7418 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007419 Py_RETURN_NONE;
Guido van Rossumc0125471996-06-28 18:55:32 +00007420}
Larry Hastings2f936352014-08-05 14:04:04 +10007421#endif /* HAVE_PLOCK */
7422
Guido van Rossumc0125471996-06-28 18:55:32 +00007423
Guido van Rossumb6775db1994-08-01 11:34:53 +00007424#ifdef HAVE_SETUID
Larry Hastings2f936352014-08-05 14:04:04 +10007425/*[clinic input]
7426os.setuid
7427
7428 uid: uid_t
7429 /
7430
7431Set the current process's user id.
7432[clinic start generated code]*/
7433
Larry Hastings2f936352014-08-05 14:04:04 +10007434static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007435os_setuid_impl(PyObject *module, uid_t uid)
7436/*[clinic end generated code: output=a0a41fd0d1ec555f input=c921a3285aa22256]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007437{
Victor Stinner8c62be82010-05-06 00:08:46 +00007438 if (setuid(uid) < 0)
7439 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007440 Py_RETURN_NONE;
Guido van Rossuma3d78fb1993-11-10 09:23:53 +00007441}
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00007442#endif /* HAVE_SETUID */
Guido van Rossuma3d78fb1993-11-10 09:23:53 +00007443
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007444
Andrew M. Kuchling8d2f2b2d2000-07-13 01:26:58 +00007445#ifdef HAVE_SETEUID
Larry Hastings2f936352014-08-05 14:04:04 +10007446/*[clinic input]
7447os.seteuid
7448
7449 euid: uid_t
7450 /
7451
7452Set the current process's effective user id.
7453[clinic start generated code]*/
7454
Larry Hastings2f936352014-08-05 14:04:04 +10007455static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007456os_seteuid_impl(PyObject *module, uid_t euid)
7457/*[clinic end generated code: output=102e3ad98361519a input=ba93d927e4781aa9]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007458{
7459 if (seteuid(euid) < 0)
Victor Stinner8c62be82010-05-06 00:08:46 +00007460 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007461 Py_RETURN_NONE;
Andrew M. Kuchling8d2f2b2d2000-07-13 01:26:58 +00007462}
7463#endif /* HAVE_SETEUID */
7464
Larry Hastings2f936352014-08-05 14:04:04 +10007465
Andrew M. Kuchling8d2f2b2d2000-07-13 01:26:58 +00007466#ifdef HAVE_SETEGID
Larry Hastings2f936352014-08-05 14:04:04 +10007467/*[clinic input]
7468os.setegid
7469
7470 egid: gid_t
7471 /
7472
7473Set the current process's effective group id.
7474[clinic start generated code]*/
7475
Larry Hastings2f936352014-08-05 14:04:04 +10007476static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007477os_setegid_impl(PyObject *module, gid_t egid)
7478/*[clinic end generated code: output=4e4b825a6a10258d input=4080526d0ccd6ce3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007479{
7480 if (setegid(egid) < 0)
Victor Stinner8c62be82010-05-06 00:08:46 +00007481 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007482 Py_RETURN_NONE;
Andrew M. Kuchling8d2f2b2d2000-07-13 01:26:58 +00007483}
7484#endif /* HAVE_SETEGID */
7485
Larry Hastings2f936352014-08-05 14:04:04 +10007486
Andrew M. Kuchling8d2f2b2d2000-07-13 01:26:58 +00007487#ifdef HAVE_SETREUID
Larry Hastings2f936352014-08-05 14:04:04 +10007488/*[clinic input]
7489os.setreuid
7490
7491 ruid: uid_t
7492 euid: uid_t
7493 /
7494
7495Set the current process's real and effective user ids.
7496[clinic start generated code]*/
7497
Larry Hastings2f936352014-08-05 14:04:04 +10007498static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007499os_setreuid_impl(PyObject *module, uid_t ruid, uid_t euid)
7500/*[clinic end generated code: output=62d991210006530a input=0ca8978de663880c]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007501{
Victor Stinner8c62be82010-05-06 00:08:46 +00007502 if (setreuid(ruid, euid) < 0) {
7503 return posix_error();
7504 } else {
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02007505 Py_RETURN_NONE;
Victor Stinner8c62be82010-05-06 00:08:46 +00007506 }
Andrew M. Kuchling8d2f2b2d2000-07-13 01:26:58 +00007507}
7508#endif /* HAVE_SETREUID */
7509
Larry Hastings2f936352014-08-05 14:04:04 +10007510
Andrew M. Kuchling8d2f2b2d2000-07-13 01:26:58 +00007511#ifdef HAVE_SETREGID
Larry Hastings2f936352014-08-05 14:04:04 +10007512/*[clinic input]
7513os.setregid
7514
7515 rgid: gid_t
7516 egid: gid_t
7517 /
7518
7519Set the current process's real and effective group ids.
7520[clinic start generated code]*/
7521
Larry Hastings2f936352014-08-05 14:04:04 +10007522static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007523os_setregid_impl(PyObject *module, gid_t rgid, gid_t egid)
7524/*[clinic end generated code: output=aa803835cf5342f3 input=c59499f72846db78]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007525{
7526 if (setregid(rgid, egid) < 0)
Victor Stinner8c62be82010-05-06 00:08:46 +00007527 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007528 Py_RETURN_NONE;
Andrew M. Kuchling8d2f2b2d2000-07-13 01:26:58 +00007529}
7530#endif /* HAVE_SETREGID */
7531
Larry Hastings2f936352014-08-05 14:04:04 +10007532
Guido van Rossumb6775db1994-08-01 11:34:53 +00007533#ifdef HAVE_SETGID
Larry Hastings2f936352014-08-05 14:04:04 +10007534/*[clinic input]
7535os.setgid
7536 gid: gid_t
7537 /
7538
7539Set the current process's group id.
7540[clinic start generated code]*/
7541
Larry Hastings2f936352014-08-05 14:04:04 +10007542static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007543os_setgid_impl(PyObject *module, gid_t gid)
7544/*[clinic end generated code: output=bdccd7403f6ad8c3 input=27d30c4059045dc6]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007545{
Victor Stinner8c62be82010-05-06 00:08:46 +00007546 if (setgid(gid) < 0)
7547 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007548 Py_RETURN_NONE;
Guido van Rossuma3d78fb1993-11-10 09:23:53 +00007549}
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00007550#endif /* HAVE_SETGID */
Guido van Rossuma3d78fb1993-11-10 09:23:53 +00007551
Larry Hastings2f936352014-08-05 14:04:04 +10007552
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00007553#ifdef HAVE_SETGROUPS
Larry Hastings2f936352014-08-05 14:04:04 +10007554/*[clinic input]
7555os.setgroups
7556
7557 groups: object
7558 /
7559
7560Set the groups of the current process to list.
7561[clinic start generated code]*/
7562
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00007563static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007564os_setgroups(PyObject *module, PyObject *groups)
7565/*[clinic end generated code: output=3fcb32aad58c5ecd input=fa742ca3daf85a7e]*/
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00007566{
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03007567 Py_ssize_t i, len;
Victor Stinner8c62be82010-05-06 00:08:46 +00007568 gid_t grouplist[MAX_GROUPS];
Tim Peters5aa91602002-01-30 05:46:57 +00007569
Victor Stinner8c62be82010-05-06 00:08:46 +00007570 if (!PySequence_Check(groups)) {
7571 PyErr_SetString(PyExc_TypeError, "setgroups argument must be a sequence");
7572 return NULL;
7573 }
7574 len = PySequence_Size(groups);
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03007575 if (len < 0) {
7576 return NULL;
7577 }
Victor Stinner8c62be82010-05-06 00:08:46 +00007578 if (len > MAX_GROUPS) {
7579 PyErr_SetString(PyExc_ValueError, "too many groups");
7580 return NULL;
7581 }
7582 for(i = 0; i < len; i++) {
7583 PyObject *elem;
7584 elem = PySequence_GetItem(groups, i);
7585 if (!elem)
7586 return NULL;
7587 if (!PyLong_Check(elem)) {
7588 PyErr_SetString(PyExc_TypeError,
7589 "groups must be integers");
7590 Py_DECREF(elem);
7591 return NULL;
7592 } else {
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02007593 if (!_Py_Gid_Converter(elem, &grouplist[i])) {
Victor Stinner8c62be82010-05-06 00:08:46 +00007594 Py_DECREF(elem);
7595 return NULL;
7596 }
7597 }
7598 Py_DECREF(elem);
7599 }
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00007600
Victor Stinner8c62be82010-05-06 00:08:46 +00007601 if (setgroups(len, grouplist) < 0)
7602 return posix_error();
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02007603 Py_RETURN_NONE;
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00007604}
7605#endif /* HAVE_SETGROUPS */
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007606
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007607#if defined(HAVE_WAIT3) || defined(HAVE_WAIT4)
7608static PyObject *
Victor Stinner4195b5c2012-02-08 23:03:19 +01007609wait_helper(pid_t pid, int status, struct rusage *ru)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007610{
Victor Stinner8c62be82010-05-06 00:08:46 +00007611 PyObject *result;
7612 static PyObject *struct_rusage;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02007613 _Py_IDENTIFIER(struct_rusage);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007614
Victor Stinner8c62be82010-05-06 00:08:46 +00007615 if (pid == -1)
7616 return posix_error();
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007617
Victor Stinner8c62be82010-05-06 00:08:46 +00007618 if (struct_rusage == NULL) {
7619 PyObject *m = PyImport_ImportModuleNoBlock("resource");
7620 if (m == NULL)
7621 return NULL;
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02007622 struct_rusage = _PyObject_GetAttrId(m, &PyId_struct_rusage);
Victor Stinner8c62be82010-05-06 00:08:46 +00007623 Py_DECREF(m);
7624 if (struct_rusage == NULL)
7625 return NULL;
7626 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007627
Victor Stinner8c62be82010-05-06 00:08:46 +00007628 /* XXX(nnorwitz): Copied (w/mods) from resource.c, there should be only one. */
7629 result = PyStructSequence_New((PyTypeObject*) struct_rusage);
7630 if (!result)
7631 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007632
7633#ifndef doubletime
7634#define doubletime(TV) ((double)(TV).tv_sec + (TV).tv_usec * 0.000001)
7635#endif
7636
Victor Stinner8c62be82010-05-06 00:08:46 +00007637 PyStructSequence_SET_ITEM(result, 0,
Victor Stinner4195b5c2012-02-08 23:03:19 +01007638 PyFloat_FromDouble(doubletime(ru->ru_utime)));
Victor Stinner8c62be82010-05-06 00:08:46 +00007639 PyStructSequence_SET_ITEM(result, 1,
Victor Stinner4195b5c2012-02-08 23:03:19 +01007640 PyFloat_FromDouble(doubletime(ru->ru_stime)));
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007641#define SET_INT(result, index, value)\
Victor Stinner8c62be82010-05-06 00:08:46 +00007642 PyStructSequence_SET_ITEM(result, index, PyLong_FromLong(value))
7643 SET_INT(result, 2, ru->ru_maxrss);
7644 SET_INT(result, 3, ru->ru_ixrss);
7645 SET_INT(result, 4, ru->ru_idrss);
7646 SET_INT(result, 5, ru->ru_isrss);
7647 SET_INT(result, 6, ru->ru_minflt);
7648 SET_INT(result, 7, ru->ru_majflt);
7649 SET_INT(result, 8, ru->ru_nswap);
7650 SET_INT(result, 9, ru->ru_inblock);
7651 SET_INT(result, 10, ru->ru_oublock);
7652 SET_INT(result, 11, ru->ru_msgsnd);
7653 SET_INT(result, 12, ru->ru_msgrcv);
7654 SET_INT(result, 13, ru->ru_nsignals);
7655 SET_INT(result, 14, ru->ru_nvcsw);
7656 SET_INT(result, 15, ru->ru_nivcsw);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007657#undef SET_INT
7658
Victor Stinner8c62be82010-05-06 00:08:46 +00007659 if (PyErr_Occurred()) {
7660 Py_DECREF(result);
7661 return NULL;
7662 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007663
Victor Stinner8c62be82010-05-06 00:08:46 +00007664 return Py_BuildValue("NiN", PyLong_FromPid(pid), status, result);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007665}
7666#endif /* HAVE_WAIT3 || HAVE_WAIT4 */
7667
Larry Hastings2f936352014-08-05 14:04:04 +10007668
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007669#ifdef HAVE_WAIT3
Larry Hastings2f936352014-08-05 14:04:04 +10007670/*[clinic input]
7671os.wait3
7672
7673 options: int
7674Wait for completion of a child process.
7675
7676Returns a tuple of information about the child process:
7677 (pid, status, rusage)
7678[clinic start generated code]*/
7679
Larry Hastings2f936352014-08-05 14:04:04 +10007680static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007681os_wait3_impl(PyObject *module, int options)
7682/*[clinic end generated code: output=92c3224e6f28217a input=8ac4c56956b61710]*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007683{
Victor Stinner8c62be82010-05-06 00:08:46 +00007684 pid_t pid;
Victor Stinner8c62be82010-05-06 00:08:46 +00007685 struct rusage ru;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007686 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00007687 WAIT_TYPE status;
7688 WAIT_STATUS_INT(status) = 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007689
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007690 do {
7691 Py_BEGIN_ALLOW_THREADS
7692 pid = wait3(&status, options, &ru);
7693 Py_END_ALLOW_THREADS
7694 } while (pid < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
7695 if (pid < 0)
7696 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007697
Victor Stinner4195b5c2012-02-08 23:03:19 +01007698 return wait_helper(pid, WAIT_STATUS_INT(status), &ru);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007699}
7700#endif /* HAVE_WAIT3 */
7701
Larry Hastings2f936352014-08-05 14:04:04 +10007702
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007703#ifdef HAVE_WAIT4
Larry Hastings2f936352014-08-05 14:04:04 +10007704/*[clinic input]
7705
7706os.wait4
7707
7708 pid: pid_t
7709 options: int
7710
7711Wait for completion of a specific child process.
7712
7713Returns a tuple of information about the child process:
7714 (pid, status, rusage)
7715[clinic start generated code]*/
7716
Larry Hastings2f936352014-08-05 14:04:04 +10007717static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007718os_wait4_impl(PyObject *module, pid_t pid, int options)
7719/*[clinic end generated code: output=66195aa507b35f70 input=d11deed0750600ba]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007720{
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007721 pid_t res;
Victor Stinner8c62be82010-05-06 00:08:46 +00007722 struct rusage ru;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007723 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00007724 WAIT_TYPE status;
7725 WAIT_STATUS_INT(status) = 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007726
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007727 do {
7728 Py_BEGIN_ALLOW_THREADS
7729 res = wait4(pid, &status, options, &ru);
7730 Py_END_ALLOW_THREADS
7731 } while (res < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
7732 if (res < 0)
7733 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007734
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007735 return wait_helper(res, WAIT_STATUS_INT(status), &ru);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007736}
7737#endif /* HAVE_WAIT4 */
7738
Larry Hastings2f936352014-08-05 14:04:04 +10007739
Ross Lagerwall7807c352011-03-17 20:20:30 +02007740#if defined(HAVE_WAITID) && !defined(__APPLE__)
Larry Hastings2f936352014-08-05 14:04:04 +10007741/*[clinic input]
7742os.waitid
7743
7744 idtype: idtype_t
7745 Must be one of be P_PID, P_PGID or P_ALL.
7746 id: id_t
7747 The id to wait on.
7748 options: int
7749 Constructed from the ORing of one or more of WEXITED, WSTOPPED
7750 or WCONTINUED and additionally may be ORed with WNOHANG or WNOWAIT.
7751 /
7752
7753Returns the result of waiting for a process or processes.
7754
7755Returns either waitid_result or None if WNOHANG is specified and there are
7756no children in a waitable state.
7757[clinic start generated code]*/
7758
Larry Hastings2f936352014-08-05 14:04:04 +10007759static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007760os_waitid_impl(PyObject *module, idtype_t idtype, id_t id, int options)
7761/*[clinic end generated code: output=5d2e1c0bde61f4d8 input=d8e7f76e052b7920]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007762{
7763 PyObject *result;
7764 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007765 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02007766 siginfo_t si;
7767 si.si_pid = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10007768
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007769 do {
7770 Py_BEGIN_ALLOW_THREADS
7771 res = waitid(idtype, id, &si, options);
7772 Py_END_ALLOW_THREADS
7773 } while (res < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
7774 if (res < 0)
7775 return (!async_err) ? posix_error() : NULL;
Ross Lagerwall7807c352011-03-17 20:20:30 +02007776
7777 if (si.si_pid == 0)
7778 Py_RETURN_NONE;
7779
Eddie Elizondo474eedf2018-11-13 04:09:31 -08007780 result = PyStructSequence_New(WaitidResultType);
Ross Lagerwall7807c352011-03-17 20:20:30 +02007781 if (!result)
7782 return NULL;
7783
7784 PyStructSequence_SET_ITEM(result, 0, PyLong_FromPid(si.si_pid));
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02007785 PyStructSequence_SET_ITEM(result, 1, _PyLong_FromUid(si.si_uid));
Ross Lagerwall7807c352011-03-17 20:20:30 +02007786 PyStructSequence_SET_ITEM(result, 2, PyLong_FromLong((long)(si.si_signo)));
7787 PyStructSequence_SET_ITEM(result, 3, PyLong_FromLong((long)(si.si_status)));
7788 PyStructSequence_SET_ITEM(result, 4, PyLong_FromLong((long)(si.si_code)));
7789 if (PyErr_Occurred()) {
7790 Py_DECREF(result);
7791 return NULL;
7792 }
7793
7794 return result;
7795}
Larry Hastings2f936352014-08-05 14:04:04 +10007796#endif /* defined(HAVE_WAITID) && !defined(__APPLE__) */
Ross Lagerwall7807c352011-03-17 20:20:30 +02007797
Larry Hastings2f936352014-08-05 14:04:04 +10007798
7799#if defined(HAVE_WAITPID)
7800/*[clinic input]
7801os.waitpid
7802 pid: pid_t
7803 options: int
7804 /
7805
7806Wait for completion of a given child process.
7807
7808Returns a tuple of information regarding the child process:
7809 (pid, status)
7810
7811The options argument is ignored on Windows.
7812[clinic start generated code]*/
7813
Larry Hastings2f936352014-08-05 14:04:04 +10007814static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007815os_waitpid_impl(PyObject *module, pid_t pid, int options)
7816/*[clinic end generated code: output=5c37c06887a20270 input=0bf1666b8758fda3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007817{
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007818 pid_t res;
7819 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00007820 WAIT_TYPE status;
7821 WAIT_STATUS_INT(status) = 0;
Guido van Rossum54ecc3d1999-01-27 17:53:11 +00007822
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007823 do {
7824 Py_BEGIN_ALLOW_THREADS
7825 res = waitpid(pid, &status, options);
7826 Py_END_ALLOW_THREADS
7827 } while (res < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
7828 if (res < 0)
7829 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007830
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007831 return Py_BuildValue("Ni", PyLong_FromPid(res), WAIT_STATUS_INT(status));
Guido van Rossum21803b81992-08-09 12:55:27 +00007832}
Tim Petersab034fa2002-02-01 11:27:43 +00007833#elif defined(HAVE_CWAIT)
Tim Petersab034fa2002-02-01 11:27:43 +00007834/* MS C has a variant of waitpid() that's usable for most purposes. */
Larry Hastings2f936352014-08-05 14:04:04 +10007835/*[clinic input]
7836os.waitpid
Benjamin Petersonca470632016-09-06 13:47:26 -07007837 pid: intptr_t
Larry Hastings2f936352014-08-05 14:04:04 +10007838 options: int
7839 /
7840
7841Wait for completion of a given process.
7842
7843Returns a tuple of information regarding the process:
7844 (pid, status << 8)
7845
7846The options argument is ignored on Windows.
7847[clinic start generated code]*/
7848
Larry Hastings2f936352014-08-05 14:04:04 +10007849static PyObject *
Benjamin Petersonca470632016-09-06 13:47:26 -07007850os_waitpid_impl(PyObject *module, intptr_t pid, int options)
Victor Stinner581139c2016-09-06 15:54:20 -07007851/*[clinic end generated code: output=be836b221271d538 input=40f2440c515410f8]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007852{
7853 int status;
Benjamin Petersonca470632016-09-06 13:47:26 -07007854 intptr_t res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007855 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10007856
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007857 do {
7858 Py_BEGIN_ALLOW_THREADS
Steve Dower11f43262016-11-19 18:33:39 -08007859 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007860 res = _cwait(&status, pid, options);
Steve Dower11f43262016-11-19 18:33:39 -08007861 _Py_END_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007862 Py_END_ALLOW_THREADS
7863 } while (res < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Victor Stinnerd3ffd322015-09-15 10:11:03 +02007864 if (res < 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007865 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007866
Victor Stinner8c62be82010-05-06 00:08:46 +00007867 /* shift the status left a byte so this is more like the POSIX waitpid */
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007868 return Py_BuildValue(_Py_PARSE_INTPTR "i", res, status << 8);
Tim Petersab034fa2002-02-01 11:27:43 +00007869}
Larry Hastings2f936352014-08-05 14:04:04 +10007870#endif
7871
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007872
Guido van Rossumad0ee831995-03-01 10:34:45 +00007873#ifdef HAVE_WAIT
Larry Hastings2f936352014-08-05 14:04:04 +10007874/*[clinic input]
7875os.wait
7876
7877Wait for completion of a child process.
7878
7879Returns a tuple of information about the child process:
7880 (pid, status)
7881[clinic start generated code]*/
7882
Larry Hastings2f936352014-08-05 14:04:04 +10007883static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007884os_wait_impl(PyObject *module)
7885/*[clinic end generated code: output=6bc419ac32fb364b input=03b0182d4a4700ce]*/
Guido van Rossum21803b81992-08-09 12:55:27 +00007886{
Victor Stinner8c62be82010-05-06 00:08:46 +00007887 pid_t pid;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007888 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00007889 WAIT_TYPE status;
7890 WAIT_STATUS_INT(status) = 0;
Neal Norwitze241ce82003-02-17 18:17:05 +00007891
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007892 do {
7893 Py_BEGIN_ALLOW_THREADS
7894 pid = wait(&status);
7895 Py_END_ALLOW_THREADS
7896 } while (pid < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
7897 if (pid < 0)
7898 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007899
Victor Stinner8c62be82010-05-06 00:08:46 +00007900 return Py_BuildValue("Ni", PyLong_FromPid(pid), WAIT_STATUS_INT(status));
Guido van Rossum85e3b011991-06-03 12:42:10 +00007901}
Larry Hastings2f936352014-08-05 14:04:04 +10007902#endif /* HAVE_WAIT */
Guido van Rossum85e3b011991-06-03 12:42:10 +00007903
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007904
Larry Hastings9cf065c2012-06-22 16:30:09 -07007905#if defined(HAVE_READLINK) || defined(MS_WINDOWS)
Serhiy Storchaka12a69db2018-09-17 15:38:27 +03007906/*[clinic input]
7907os.readlink
7908
7909 path: path_t
7910 *
7911 dir_fd: dir_fd(requires='readlinkat') = None
7912
7913Return a string representing the path to which the symbolic link points.
7914
7915If dir_fd is not None, it should be a file descriptor open to a directory,
7916and path should be relative; path will then be relative to that directory.
7917
7918dir_fd may not be implemented on your platform. If it is unavailable,
7919using it will raise a NotImplementedError.
7920[clinic start generated code]*/
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007921
Barry Warsaw53699e91996-12-10 23:23:01 +00007922static PyObject *
Serhiy Storchaka12a69db2018-09-17 15:38:27 +03007923os_readlink_impl(PyObject *module, path_t *path, int dir_fd)
7924/*[clinic end generated code: output=d21b732a2e814030 input=113c87e0db1ecaf2]*/
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00007925{
Berker Peksage0b5b202018-08-15 13:03:41 +03007926#if defined(HAVE_READLINK)
Christian Heimes3cb091e2016-09-23 20:24:28 +02007927 char buffer[MAXPATHLEN+1];
Larry Hastings9cf065c2012-06-22 16:30:09 -07007928 ssize_t length;
Serhiy Storchaka12a69db2018-09-17 15:38:27 +03007929
7930 Py_BEGIN_ALLOW_THREADS
7931#ifdef HAVE_READLINKAT
7932 if (dir_fd != DEFAULT_DIR_FD)
7933 length = readlinkat(dir_fd, path->narrow, buffer, MAXPATHLEN);
7934 else
7935#endif
7936 length = readlink(path->narrow, buffer, MAXPATHLEN);
7937 Py_END_ALLOW_THREADS
7938
7939 if (length < 0) {
7940 return path_error(path);
7941 }
7942 buffer[length] = '\0';
7943
7944 if (PyUnicode_Check(path->object))
7945 return PyUnicode_DecodeFSDefaultAndSize(buffer, length);
7946 else
7947 return PyBytes_FromStringAndSize(buffer, length);
Berker Peksage0b5b202018-08-15 13:03:41 +03007948#elif defined(MS_WINDOWS)
7949 DWORD n_bytes_returned;
Steve Dower9eb3d542019-08-21 15:52:42 -07007950 DWORD io_result = 0;
Berker Peksage0b5b202018-08-15 13:03:41 +03007951 HANDLE reparse_point_handle;
Berker Peksage0b5b202018-08-15 13:03:41 +03007952 char target_buffer[_Py_MAXIMUM_REPARSE_DATA_BUFFER_SIZE];
7953 _Py_REPARSE_DATA_BUFFER *rdb = (_Py_REPARSE_DATA_BUFFER *)target_buffer;
Miss Islington (bot)54dac6c2019-09-03 13:13:41 -07007954 PyObject *result = NULL;
Thomas Wouters89f507f2006-12-13 04:49:30 +00007955
Larry Hastings2f936352014-08-05 14:04:04 +10007956 /* First get a handle to the reparse point */
7957 Py_BEGIN_ALLOW_THREADS
7958 reparse_point_handle = CreateFileW(
Serhiy Storchaka12a69db2018-09-17 15:38:27 +03007959 path->wide,
Larry Hastings2f936352014-08-05 14:04:04 +10007960 0,
7961 0,
7962 0,
7963 OPEN_EXISTING,
7964 FILE_FLAG_OPEN_REPARSE_POINT|FILE_FLAG_BACKUP_SEMANTICS,
7965 0);
Steve Dower9eb3d542019-08-21 15:52:42 -07007966 if (reparse_point_handle != INVALID_HANDLE_VALUE) {
7967 /* New call DeviceIoControl to read the reparse point */
7968 io_result = DeviceIoControl(
7969 reparse_point_handle,
7970 FSCTL_GET_REPARSE_POINT,
7971 0, 0, /* in buffer */
7972 target_buffer, sizeof(target_buffer),
7973 &n_bytes_returned,
7974 0 /* we're not using OVERLAPPED_IO */
7975 );
7976 CloseHandle(reparse_point_handle);
Berker Peksage0b5b202018-08-15 13:03:41 +03007977 }
Larry Hastings2f936352014-08-05 14:04:04 +10007978 Py_END_ALLOW_THREADS
7979
Berker Peksage0b5b202018-08-15 13:03:41 +03007980 if (io_result == 0) {
Serhiy Storchaka12a69db2018-09-17 15:38:27 +03007981 return path_error(path);
Berker Peksage0b5b202018-08-15 13:03:41 +03007982 }
Larry Hastings2f936352014-08-05 14:04:04 +10007983
Steve Dower9eb3d542019-08-21 15:52:42 -07007984 wchar_t *name = NULL;
7985 Py_ssize_t nameLen = 0;
7986 if (rdb->ReparseTag == IO_REPARSE_TAG_SYMLINK)
Larry Hastings2f936352014-08-05 14:04:04 +10007987 {
Steve Dower9eb3d542019-08-21 15:52:42 -07007988 name = (wchar_t *)((char*)rdb->SymbolicLinkReparseBuffer.PathBuffer +
7989 rdb->SymbolicLinkReparseBuffer.SubstituteNameOffset);
7990 nameLen = rdb->SymbolicLinkReparseBuffer.SubstituteNameLength / sizeof(wchar_t);
Larry Hastings2f936352014-08-05 14:04:04 +10007991 }
Steve Dower9eb3d542019-08-21 15:52:42 -07007992 else if (rdb->ReparseTag == IO_REPARSE_TAG_MOUNT_POINT)
7993 {
7994 name = (wchar_t *)((char*)rdb->MountPointReparseBuffer.PathBuffer +
7995 rdb->MountPointReparseBuffer.SubstituteNameOffset);
7996 nameLen = rdb->MountPointReparseBuffer.SubstituteNameLength / sizeof(wchar_t);
7997 }
7998 else
7999 {
8000 PyErr_SetString(PyExc_ValueError, "not a symbolic link");
8001 }
8002 if (name) {
8003 if (nameLen > 4 && wcsncmp(name, L"\\??\\", 4) == 0) {
8004 /* Our buffer is mutable, so this is okay */
8005 name[1] = L'\\';
8006 }
8007 result = PyUnicode_FromWideChar(name, nameLen);
Miss Islington (bot)54dac6c2019-09-03 13:13:41 -07008008 if (result && path->narrow) {
Steve Dower9eb3d542019-08-21 15:52:42 -07008009 Py_SETREF(result, PyUnicode_EncodeFSDefault(result));
8010 }
Berker Peksage0b5b202018-08-15 13:03:41 +03008011 }
Serhiy Storchaka12a69db2018-09-17 15:38:27 +03008012 return result;
Berker Peksage0b5b202018-08-15 13:03:41 +03008013#endif
Larry Hastings2f936352014-08-05 14:04:04 +10008014}
Berker Peksage0b5b202018-08-15 13:03:41 +03008015#endif /* defined(HAVE_READLINK) || defined(MS_WINDOWS) */
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008016
Larry Hastings9cf065c2012-06-22 16:30:09 -07008017#ifdef HAVE_SYMLINK
Larry Hastings9cf065c2012-06-22 16:30:09 -07008018
8019#if defined(MS_WINDOWS)
8020
Steve Dower6921e732018-03-05 14:26:08 -08008021/* Remove the last portion of the path - return 0 on success */
8022static int
Victor Stinner31b3b922013-06-05 01:49:17 +02008023_dirnameW(WCHAR *path)
8024{
Jason R. Coombs3a092862013-05-27 23:21:28 -04008025 WCHAR *ptr;
Steve Dower6921e732018-03-05 14:26:08 -08008026 size_t length = wcsnlen_s(path, MAX_PATH);
8027 if (length == MAX_PATH) {
8028 return -1;
8029 }
Jason R. Coombs3a092862013-05-27 23:21:28 -04008030
8031 /* walk the path from the end until a backslash is encountered */
Steve Dower6921e732018-03-05 14:26:08 -08008032 for(ptr = path + length; ptr != path; ptr--) {
8033 if (*ptr == L'\\' || *ptr == L'/') {
Jason R. Coombs3a092862013-05-27 23:21:28 -04008034 break;
Steve Dower6921e732018-03-05 14:26:08 -08008035 }
Jason R. Coombs3a092862013-05-27 23:21:28 -04008036 }
8037 *ptr = 0;
Steve Dower6921e732018-03-05 14:26:08 -08008038 return 0;
Jason R. Coombs3a092862013-05-27 23:21:28 -04008039}
8040
Victor Stinner31b3b922013-06-05 01:49:17 +02008041/* Is this path absolute? */
8042static int
8043_is_absW(const WCHAR *path)
8044{
Steve Dower6921e732018-03-05 14:26:08 -08008045 return path[0] == L'\\' || path[0] == L'/' ||
8046 (path[0] && path[1] == L':');
Jason R. Coombs3a092862013-05-27 23:21:28 -04008047}
8048
Steve Dower6921e732018-03-05 14:26:08 -08008049/* join root and rest with a backslash - return 0 on success */
8050static int
Victor Stinner31b3b922013-06-05 01:49:17 +02008051_joinW(WCHAR *dest_path, const WCHAR *root, const WCHAR *rest)
8052{
Victor Stinner31b3b922013-06-05 01:49:17 +02008053 if (_is_absW(rest)) {
Steve Dower6921e732018-03-05 14:26:08 -08008054 return wcscpy_s(dest_path, MAX_PATH, rest);
Jason R. Coombs3a092862013-05-27 23:21:28 -04008055 }
8056
Steve Dower6921e732018-03-05 14:26:08 -08008057 if (wcscpy_s(dest_path, MAX_PATH, root)) {
8058 return -1;
Jason R. Coombs3a092862013-05-27 23:21:28 -04008059 }
Steve Dower6921e732018-03-05 14:26:08 -08008060
8061 if (dest_path[0] && wcscat_s(dest_path, MAX_PATH, L"\\")) {
8062 return -1;
8063 }
8064
8065 return wcscat_s(dest_path, MAX_PATH, rest);
Jason R. Coombs3a092862013-05-27 23:21:28 -04008066}
8067
Victor Stinner31b3b922013-06-05 01:49:17 +02008068/* Return True if the path at src relative to dest is a directory */
8069static int
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03008070_check_dirW(LPCWSTR src, LPCWSTR dest)
Jason R. Coombs3a092862013-05-27 23:21:28 -04008071{
Jason R. Coombs3a092862013-05-27 23:21:28 -04008072 WIN32_FILE_ATTRIBUTE_DATA src_info;
8073 WCHAR dest_parent[MAX_PATH];
8074 WCHAR src_resolved[MAX_PATH] = L"";
8075
8076 /* dest_parent = os.path.dirname(dest) */
Steve Dower6921e732018-03-05 14:26:08 -08008077 if (wcscpy_s(dest_parent, MAX_PATH, dest) ||
8078 _dirnameW(dest_parent)) {
8079 return 0;
8080 }
Jason R. Coombs3a092862013-05-27 23:21:28 -04008081 /* src_resolved = os.path.join(dest_parent, src) */
Steve Dower6921e732018-03-05 14:26:08 -08008082 if (_joinW(src_resolved, dest_parent, src)) {
8083 return 0;
8084 }
Jason R. Coombs3a092862013-05-27 23:21:28 -04008085 return (
8086 GetFileAttributesExW(src_resolved, GetFileExInfoStandard, &src_info)
8087 && src_info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY
8088 );
8089}
Larry Hastings9cf065c2012-06-22 16:30:09 -07008090#endif
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008091
Larry Hastings2f936352014-08-05 14:04:04 +10008092
8093/*[clinic input]
8094os.symlink
8095 src: path_t
8096 dst: path_t
8097 target_is_directory: bool = False
8098 *
8099 dir_fd: dir_fd(requires='symlinkat')=None
8100
8101# "symlink(src, dst, target_is_directory=False, *, dir_fd=None)\n\n\
8102
8103Create a symbolic link pointing to src named dst.
8104
8105target_is_directory is required on Windows if the target is to be
8106 interpreted as a directory. (On Windows, symlink requires
8107 Windows 6.0 or greater, and raises a NotImplementedError otherwise.)
8108 target_is_directory is ignored on non-Windows platforms.
8109
8110If dir_fd is not None, it should be a file descriptor open to a directory,
8111 and path should be relative; path will then be relative to that directory.
8112dir_fd may not be implemented on your platform.
8113 If it is unavailable, using it will raise a NotImplementedError.
8114
8115[clinic start generated code]*/
8116
Larry Hastings2f936352014-08-05 14:04:04 +10008117static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008118os_symlink_impl(PyObject *module, path_t *src, path_t *dst,
Larry Hastings89964c42015-04-14 18:07:59 -04008119 int target_is_directory, int dir_fd)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008120/*[clinic end generated code: output=08ca9f3f3cf960f6 input=e820ec4472547bc3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008121{
Larry Hastings9cf065c2012-06-22 16:30:09 -07008122#ifdef MS_WINDOWS
8123 DWORD result;
Vidar Tonaas Fauske0e107662019-04-09 20:19:46 +02008124 DWORD flags = 0;
8125
8126 /* Assumed true, set to false if detected to not be available. */
8127 static int windows_has_symlink_unprivileged_flag = TRUE;
Larry Hastings9cf065c2012-06-22 16:30:09 -07008128#else
8129 int result;
8130#endif
8131
Steve Dowera00b5be2020-02-13 08:30:27 +00008132 if (PySys_Audit("os.symlink", "OOi", src->object, dst->object,
8133 dir_fd == DEFAULT_DIR_FD ? -1 : dir_fd) < 0) {
8134 return NULL;
8135 }
8136
Larry Hastings9cf065c2012-06-22 16:30:09 -07008137#ifdef MS_WINDOWS
Larry Hastings9cf065c2012-06-22 16:30:09 -07008138
Vidar Tonaas Fauske0e107662019-04-09 20:19:46 +02008139 if (windows_has_symlink_unprivileged_flag) {
8140 /* Allow non-admin symlinks if system allows it. */
8141 flags |= SYMBOLIC_LINK_FLAG_ALLOW_UNPRIVILEGED_CREATE;
8142 }
Jason R. Coombs3a092862013-05-27 23:21:28 -04008143
Larry Hastings9cf065c2012-06-22 16:30:09 -07008144 Py_BEGIN_ALLOW_THREADS
Steve Dower6921e732018-03-05 14:26:08 -08008145 _Py_BEGIN_SUPPRESS_IPH
Vidar Tonaas Fauske0e107662019-04-09 20:19:46 +02008146 /* if src is a directory, ensure flags==1 (target_is_directory bit) */
8147 if (target_is_directory || _check_dirW(src->wide, dst->wide)) {
8148 flags |= SYMBOLIC_LINK_FLAG_DIRECTORY;
8149 }
8150
8151 result = CreateSymbolicLinkW(dst->wide, src->wide, flags);
Steve Dower6921e732018-03-05 14:26:08 -08008152 _Py_END_SUPPRESS_IPH
Larry Hastings9cf065c2012-06-22 16:30:09 -07008153 Py_END_ALLOW_THREADS
8154
Vidar Tonaas Fauske0e107662019-04-09 20:19:46 +02008155 if (windows_has_symlink_unprivileged_flag && !result &&
8156 ERROR_INVALID_PARAMETER == GetLastError()) {
8157
8158 Py_BEGIN_ALLOW_THREADS
8159 _Py_BEGIN_SUPPRESS_IPH
8160 /* This error might be caused by
8161 SYMBOLIC_LINK_FLAG_ALLOW_UNPRIVILEGED_CREATE not being supported.
8162 Try again, and update windows_has_symlink_unprivileged_flag if we
8163 are successful this time.
8164
8165 NOTE: There is a risk of a race condition here if there are other
8166 conditions than the flag causing ERROR_INVALID_PARAMETER, and
8167 another process (or thread) changes that condition in between our
8168 calls to CreateSymbolicLink.
8169 */
8170 flags &= ~(SYMBOLIC_LINK_FLAG_ALLOW_UNPRIVILEGED_CREATE);
8171 result = CreateSymbolicLinkW(dst->wide, src->wide, flags);
8172 _Py_END_SUPPRESS_IPH
8173 Py_END_ALLOW_THREADS
8174
8175 if (result || ERROR_INVALID_PARAMETER != GetLastError()) {
8176 windows_has_symlink_unprivileged_flag = FALSE;
8177 }
8178 }
8179
Larry Hastings2f936352014-08-05 14:04:04 +10008180 if (!result)
8181 return path_error2(src, dst);
Larry Hastings9cf065c2012-06-22 16:30:09 -07008182
8183#else
8184
Steve Dower6921e732018-03-05 14:26:08 -08008185 if ((src->narrow && dst->wide) || (src->wide && dst->narrow)) {
8186 PyErr_SetString(PyExc_ValueError,
8187 "symlink: src and dst must be the same type");
8188 return NULL;
8189 }
8190
Larry Hastings9cf065c2012-06-22 16:30:09 -07008191 Py_BEGIN_ALLOW_THREADS
8192#if HAVE_SYMLINKAT
8193 if (dir_fd != DEFAULT_DIR_FD)
Larry Hastings2f936352014-08-05 14:04:04 +10008194 result = symlinkat(src->narrow, dir_fd, dst->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07008195 else
8196#endif
Larry Hastings2f936352014-08-05 14:04:04 +10008197 result = symlink(src->narrow, dst->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07008198 Py_END_ALLOW_THREADS
8199
Larry Hastings2f936352014-08-05 14:04:04 +10008200 if (result)
8201 return path_error2(src, dst);
Larry Hastings9cf065c2012-06-22 16:30:09 -07008202#endif
8203
Larry Hastings2f936352014-08-05 14:04:04 +10008204 Py_RETURN_NONE;
Guido van Rossumbfaf3d61997-12-29 20:02:27 +00008205}
8206#endif /* HAVE_SYMLINK */
8207
Larry Hastings9cf065c2012-06-22 16:30:09 -07008208
Brian Curtind40e6f72010-07-08 21:39:08 +00008209
Guido van Rossumbfaf3d61997-12-29 20:02:27 +00008210
Larry Hastings605a62d2012-06-24 04:33:36 -07008211static PyStructSequence_Field times_result_fields[] = {
8212 {"user", "user time"},
8213 {"system", "system time"},
8214 {"children_user", "user time of children"},
8215 {"children_system", "system time of children"},
8216 {"elapsed", "elapsed time since an arbitrary point in the past"},
8217 {NULL}
8218};
8219
8220PyDoc_STRVAR(times_result__doc__,
8221"times_result: Result from os.times().\n\n\
8222This object may be accessed either as a tuple of\n\
8223 (user, system, children_user, children_system, elapsed),\n\
8224or via the attributes user, system, children_user, children_system,\n\
8225and elapsed.\n\
8226\n\
8227See os.times for more information.");
8228
8229static PyStructSequence_Desc times_result_desc = {
8230 "times_result", /* name */
8231 times_result__doc__, /* doc */
8232 times_result_fields,
8233 5
8234};
8235
Eddie Elizondo474eedf2018-11-13 04:09:31 -08008236static PyTypeObject* TimesResultType;
Larry Hastings605a62d2012-06-24 04:33:36 -07008237
Antoine Pitrouf3923e92012-07-24 21:23:53 +02008238#ifdef MS_WINDOWS
8239#define HAVE_TIMES /* mandatory, for the method table */
8240#endif
Larry Hastings605a62d2012-06-24 04:33:36 -07008241
Antoine Pitrouf3923e92012-07-24 21:23:53 +02008242#ifdef HAVE_TIMES
Larry Hastings605a62d2012-06-24 04:33:36 -07008243
8244static PyObject *
8245build_times_result(double user, double system,
8246 double children_user, double children_system,
8247 double elapsed)
8248{
Eddie Elizondo474eedf2018-11-13 04:09:31 -08008249 PyObject *value = PyStructSequence_New(TimesResultType);
Larry Hastings605a62d2012-06-24 04:33:36 -07008250 if (value == NULL)
8251 return NULL;
8252
8253#define SET(i, field) \
8254 { \
8255 PyObject *o = PyFloat_FromDouble(field); \
8256 if (!o) { \
8257 Py_DECREF(value); \
8258 return NULL; \
8259 } \
8260 PyStructSequence_SET_ITEM(value, i, o); \
8261 } \
8262
8263 SET(0, user);
8264 SET(1, system);
8265 SET(2, children_user);
8266 SET(3, children_system);
8267 SET(4, elapsed);
8268
8269#undef SET
8270
8271 return value;
8272}
8273
Larry Hastings605a62d2012-06-24 04:33:36 -07008274
Larry Hastings2f936352014-08-05 14:04:04 +10008275#ifndef MS_WINDOWS
8276#define NEED_TICKS_PER_SECOND
8277static long ticks_per_second = -1;
8278#endif /* MS_WINDOWS */
8279
8280/*[clinic input]
8281os.times
8282
8283Return a collection containing process timing information.
8284
8285The object returned behaves like a named tuple with these fields:
8286 (utime, stime, cutime, cstime, elapsed_time)
8287All fields are floating point numbers.
8288[clinic start generated code]*/
8289
Larry Hastings2f936352014-08-05 14:04:04 +10008290static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008291os_times_impl(PyObject *module)
8292/*[clinic end generated code: output=35f640503557d32a input=2bf9df3d6ab2e48b]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008293#ifdef MS_WINDOWS
Guido van Rossum14ed0b21994-09-29 09:50:09 +00008294{
Victor Stinner8c62be82010-05-06 00:08:46 +00008295 FILETIME create, exit, kernel, user;
8296 HANDLE hProc;
8297 hProc = GetCurrentProcess();
8298 GetProcessTimes(hProc, &create, &exit, &kernel, &user);
8299 /* The fields of a FILETIME structure are the hi and lo part
8300 of a 64-bit value expressed in 100 nanosecond units.
8301 1e7 is one second in such units; 1e-7 the inverse.
8302 429.4967296 is 2**32 / 1e7 or 2**32 * 1e-7.
8303 */
Larry Hastings605a62d2012-06-24 04:33:36 -07008304 return build_times_result(
Victor Stinner8c62be82010-05-06 00:08:46 +00008305 (double)(user.dwHighDateTime*429.4967296 +
8306 user.dwLowDateTime*1e-7),
8307 (double)(kernel.dwHighDateTime*429.4967296 +
8308 kernel.dwLowDateTime*1e-7),
8309 (double)0,
8310 (double)0,
8311 (double)0);
Guido van Rossum14ed0b21994-09-29 09:50:09 +00008312}
Larry Hastings2f936352014-08-05 14:04:04 +10008313#else /* MS_WINDOWS */
Antoine Pitrouf3923e92012-07-24 21:23:53 +02008314{
Larry Hastings2f936352014-08-05 14:04:04 +10008315
8316
Antoine Pitrouf3923e92012-07-24 21:23:53 +02008317 struct tms t;
8318 clock_t c;
8319 errno = 0;
8320 c = times(&t);
8321 if (c == (clock_t) -1)
8322 return posix_error();
8323 return build_times_result(
8324 (double)t.tms_utime / ticks_per_second,
8325 (double)t.tms_stime / ticks_per_second,
8326 (double)t.tms_cutime / ticks_per_second,
8327 (double)t.tms_cstime / ticks_per_second,
8328 (double)c / ticks_per_second);
8329}
Larry Hastings2f936352014-08-05 14:04:04 +10008330#endif /* MS_WINDOWS */
Antoine Pitrouf3923e92012-07-24 21:23:53 +02008331#endif /* HAVE_TIMES */
8332
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008333
Martin v. Löwis49ee14d2003-11-10 06:35:36 +00008334#ifdef HAVE_GETSID
Larry Hastings2f936352014-08-05 14:04:04 +10008335/*[clinic input]
8336os.getsid
8337
8338 pid: pid_t
8339 /
8340
8341Call the system call getsid(pid) and return the result.
8342[clinic start generated code]*/
8343
Larry Hastings2f936352014-08-05 14:04:04 +10008344static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008345os_getsid_impl(PyObject *module, pid_t pid)
8346/*[clinic end generated code: output=112deae56b306460 input=eeb2b923a30ce04e]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008347{
Victor Stinner8c62be82010-05-06 00:08:46 +00008348 int sid;
Victor Stinner8c62be82010-05-06 00:08:46 +00008349 sid = getsid(pid);
8350 if (sid < 0)
8351 return posix_error();
8352 return PyLong_FromLong((long)sid);
Martin v. Löwis49ee14d2003-11-10 06:35:36 +00008353}
8354#endif /* HAVE_GETSID */
8355
8356
Guido van Rossumb6775db1994-08-01 11:34:53 +00008357#ifdef HAVE_SETSID
Larry Hastings2f936352014-08-05 14:04:04 +10008358/*[clinic input]
8359os.setsid
8360
8361Call the system call setsid().
8362[clinic start generated code]*/
8363
Larry Hastings2f936352014-08-05 14:04:04 +10008364static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008365os_setsid_impl(PyObject *module)
8366/*[clinic end generated code: output=e2ddedd517086d77 input=5fff45858e2f0776]*/
Guido van Rossumc2670a01992-09-13 20:07:29 +00008367{
Victor Stinner8c62be82010-05-06 00:08:46 +00008368 if (setsid() < 0)
8369 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10008370 Py_RETURN_NONE;
Guido van Rossumc2670a01992-09-13 20:07:29 +00008371}
Guido van Rossumb6775db1994-08-01 11:34:53 +00008372#endif /* HAVE_SETSID */
Guido van Rossumc2670a01992-09-13 20:07:29 +00008373
Larry Hastings2f936352014-08-05 14:04:04 +10008374
Guido van Rossumb6775db1994-08-01 11:34:53 +00008375#ifdef HAVE_SETPGID
Larry Hastings2f936352014-08-05 14:04:04 +10008376/*[clinic input]
8377os.setpgid
8378
8379 pid: pid_t
8380 pgrp: pid_t
8381 /
8382
8383Call the system call setpgid(pid, pgrp).
8384[clinic start generated code]*/
8385
Larry Hastings2f936352014-08-05 14:04:04 +10008386static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008387os_setpgid_impl(PyObject *module, pid_t pid, pid_t pgrp)
8388/*[clinic end generated code: output=6461160319a43d6a input=fceb395eca572e1a]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008389{
Victor Stinner8c62be82010-05-06 00:08:46 +00008390 if (setpgid(pid, pgrp) < 0)
8391 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10008392 Py_RETURN_NONE;
Guido van Rossumc2670a01992-09-13 20:07:29 +00008393}
Guido van Rossumb6775db1994-08-01 11:34:53 +00008394#endif /* HAVE_SETPGID */
Guido van Rossumc2670a01992-09-13 20:07:29 +00008395
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008396
Guido van Rossumb6775db1994-08-01 11:34:53 +00008397#ifdef HAVE_TCGETPGRP
Larry Hastings2f936352014-08-05 14:04:04 +10008398/*[clinic input]
8399os.tcgetpgrp
8400
8401 fd: int
8402 /
8403
8404Return the process group associated with the terminal specified by fd.
8405[clinic start generated code]*/
8406
Larry Hastings2f936352014-08-05 14:04:04 +10008407static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008408os_tcgetpgrp_impl(PyObject *module, int fd)
8409/*[clinic end generated code: output=f865e88be86c272b input=7f6c18eac10ada86]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008410{
8411 pid_t pgid = tcgetpgrp(fd);
Victor Stinner8c62be82010-05-06 00:08:46 +00008412 if (pgid < 0)
8413 return posix_error();
8414 return PyLong_FromPid(pgid);
Guido van Rossum7066dd71992-09-17 17:54:56 +00008415}
Guido van Rossumb6775db1994-08-01 11:34:53 +00008416#endif /* HAVE_TCGETPGRP */
Guido van Rossum7066dd71992-09-17 17:54:56 +00008417
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008418
Guido van Rossumb6775db1994-08-01 11:34:53 +00008419#ifdef HAVE_TCSETPGRP
Larry Hastings2f936352014-08-05 14:04:04 +10008420/*[clinic input]
8421os.tcsetpgrp
8422
8423 fd: int
8424 pgid: pid_t
8425 /
8426
8427Set the process group associated with the terminal specified by fd.
8428[clinic start generated code]*/
8429
Larry Hastings2f936352014-08-05 14:04:04 +10008430static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008431os_tcsetpgrp_impl(PyObject *module, int fd, pid_t pgid)
8432/*[clinic end generated code: output=f1821a381b9daa39 input=5bdc997c6a619020]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008433{
Victor Stinner8c62be82010-05-06 00:08:46 +00008434 if (tcsetpgrp(fd, pgid) < 0)
8435 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10008436 Py_RETURN_NONE;
Guido van Rossum7066dd71992-09-17 17:54:56 +00008437}
Guido van Rossumb6775db1994-08-01 11:34:53 +00008438#endif /* HAVE_TCSETPGRP */
Guido van Rossum22db57e1992-04-05 14:25:30 +00008439
Guido van Rossum687dd131993-05-17 08:34:16 +00008440/* Functions acting on file descriptors */
8441
Victor Stinnerdaf45552013-08-28 00:53:59 +02008442#ifdef O_CLOEXEC
8443extern int _Py_open_cloexec_works;
8444#endif
8445
Larry Hastings2f936352014-08-05 14:04:04 +10008446
8447/*[clinic input]
8448os.open -> int
8449 path: path_t
8450 flags: int
8451 mode: int = 0o777
8452 *
8453 dir_fd: dir_fd(requires='openat') = None
8454
8455# "open(path, flags, mode=0o777, *, dir_fd=None)\n\n\
8456
8457Open a file for low level IO. Returns a file descriptor (integer).
8458
8459If dir_fd is not None, it should be a file descriptor open to a directory,
8460 and path should be relative; path will then be relative to that directory.
8461dir_fd may not be implemented on your platform.
8462 If it is unavailable, using it will raise a NotImplementedError.
8463[clinic start generated code]*/
8464
Larry Hastings2f936352014-08-05 14:04:04 +10008465static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008466os_open_impl(PyObject *module, path_t *path, int flags, int mode, int dir_fd)
8467/*[clinic end generated code: output=abc7227888c8bc73 input=ad8623b29acd2934]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008468{
8469 int fd;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008470 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10008471
Victor Stinnerdaf45552013-08-28 00:53:59 +02008472#ifdef O_CLOEXEC
8473 int *atomic_flag_works = &_Py_open_cloexec_works;
8474#elif !defined(MS_WINDOWS)
8475 int *atomic_flag_works = NULL;
8476#endif
Mark Hammondc2e85bd2002-10-03 05:10:39 +00008477
Victor Stinnerdaf45552013-08-28 00:53:59 +02008478#ifdef MS_WINDOWS
8479 flags |= O_NOINHERIT;
8480#elif defined(O_CLOEXEC)
8481 flags |= O_CLOEXEC;
8482#endif
8483
Steve Dowerb82e17e2019-05-23 08:45:22 -07008484 if (PySys_Audit("open", "OOi", path->object, Py_None, flags) < 0) {
8485 return -1;
8486 }
8487
Steve Dower8fc89802015-04-12 00:26:27 -04008488 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008489 do {
8490 Py_BEGIN_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07008491#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07008492 fd = _wopen(path->wide, flags, mode);
Steve Dower6230aaf2016-09-09 09:03:15 -07008493#else
Larry Hastings9cf065c2012-06-22 16:30:09 -07008494#ifdef HAVE_OPENAT
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008495 if (dir_fd != DEFAULT_DIR_FD)
8496 fd = openat(dir_fd, path->narrow, flags, mode);
8497 else
Steve Dower6230aaf2016-09-09 09:03:15 -07008498#endif /* HAVE_OPENAT */
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008499 fd = open(path->narrow, flags, mode);
Steve Dower6230aaf2016-09-09 09:03:15 -07008500#endif /* !MS_WINDOWS */
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008501 Py_END_ALLOW_THREADS
8502 } while (fd < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Steve Dower8fc89802015-04-12 00:26:27 -04008503 _Py_END_SUPPRESS_IPH
Guido van Rossum687dd131993-05-17 08:34:16 +00008504
Victor Stinnerd3ffd322015-09-15 10:11:03 +02008505 if (fd < 0) {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008506 if (!async_err)
8507 PyErr_SetFromErrnoWithFilenameObject(PyExc_OSError, path->object);
Larry Hastings2f936352014-08-05 14:04:04 +10008508 return -1;
Larry Hastings9cf065c2012-06-22 16:30:09 -07008509 }
8510
Victor Stinnerdaf45552013-08-28 00:53:59 +02008511#ifndef MS_WINDOWS
8512 if (_Py_set_inheritable(fd, 0, atomic_flag_works) < 0) {
8513 close(fd);
Larry Hastings2f936352014-08-05 14:04:04 +10008514 return -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008515 }
8516#endif
8517
Larry Hastings2f936352014-08-05 14:04:04 +10008518 return fd;
8519}
8520
8521
8522/*[clinic input]
8523os.close
8524
8525 fd: int
8526
8527Close a file descriptor.
8528[clinic start generated code]*/
8529
Barry Warsaw53699e91996-12-10 23:23:01 +00008530static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008531os_close_impl(PyObject *module, int fd)
8532/*[clinic end generated code: output=2fe4e93602822c14 input=2bc42451ca5c3223]*/
Guido van Rossum687dd131993-05-17 08:34:16 +00008533{
Larry Hastings2f936352014-08-05 14:04:04 +10008534 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008535 /* We do not want to retry upon EINTR: see http://lwn.net/Articles/576478/
8536 * and http://linux.derkeiler.com/Mailing-Lists/Kernel/2005-09/3000.html
8537 * for more details.
8538 */
Victor Stinner8c62be82010-05-06 00:08:46 +00008539 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04008540 _Py_BEGIN_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00008541 res = close(fd);
Steve Dower8fc89802015-04-12 00:26:27 -04008542 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00008543 Py_END_ALLOW_THREADS
8544 if (res < 0)
8545 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10008546 Py_RETURN_NONE;
Guido van Rossum687dd131993-05-17 08:34:16 +00008547}
8548
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008549
Miss Islington (bot)84eb42e2019-09-12 04:19:21 -07008550#ifdef HAVE_FDWALK
8551static int
8552_fdwalk_close_func(void *lohi, int fd)
8553{
8554 int lo = ((int *)lohi)[0];
8555 int hi = ((int *)lohi)[1];
8556
8557 if (fd >= hi)
8558 return 1;
8559 else if (fd >= lo)
8560 close(fd);
8561 return 0;
8562}
8563#endif /* HAVE_FDWALK */
8564
Larry Hastings2f936352014-08-05 14:04:04 +10008565/*[clinic input]
8566os.closerange
8567
8568 fd_low: int
8569 fd_high: int
8570 /
8571
8572Closes all file descriptors in [fd_low, fd_high), ignoring errors.
8573[clinic start generated code]*/
8574
Larry Hastings2f936352014-08-05 14:04:04 +10008575static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008576os_closerange_impl(PyObject *module, int fd_low, int fd_high)
8577/*[clinic end generated code: output=0ce5c20fcda681c2 input=5855a3d053ebd4ec]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008578{
Miss Islington (bot)84eb42e2019-09-12 04:19:21 -07008579#ifdef HAVE_FDWALK
8580 int lohi[2];
8581#else
Larry Hastings2f936352014-08-05 14:04:04 +10008582 int i;
Miss Islington (bot)84eb42e2019-09-12 04:19:21 -07008583#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00008584 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04008585 _Py_BEGIN_SUPPRESS_IPH
Miss Islington (bot)84eb42e2019-09-12 04:19:21 -07008586#ifdef HAVE_FDWALK
8587 lohi[0] = Py_MAX(fd_low, 0);
8588 lohi[1] = fd_high;
8589 fdwalk(_fdwalk_close_func, lohi);
8590#else
Benjamin Peterson207116b2016-09-08 11:28:06 -07008591 for (i = Py_MAX(fd_low, 0); i < fd_high; i++)
Steve Dower940f33a2016-09-08 11:21:54 -07008592 close(i);
Miss Islington (bot)84eb42e2019-09-12 04:19:21 -07008593#endif
Steve Dower8fc89802015-04-12 00:26:27 -04008594 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00008595 Py_END_ALLOW_THREADS
8596 Py_RETURN_NONE;
Christian Heimesfdab48e2008-01-20 09:06:41 +00008597}
8598
8599
Larry Hastings2f936352014-08-05 14:04:04 +10008600/*[clinic input]
8601os.dup -> int
8602
8603 fd: int
8604 /
8605
8606Return a duplicate of a file descriptor.
8607[clinic start generated code]*/
8608
Larry Hastings2f936352014-08-05 14:04:04 +10008609static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008610os_dup_impl(PyObject *module, int fd)
8611/*[clinic end generated code: output=486f4860636b2a9f input=6f10f7ea97f7852a]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008612{
8613 return _Py_dup(fd);
Guido van Rossum687dd131993-05-17 08:34:16 +00008614}
8615
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008616
Larry Hastings2f936352014-08-05 14:04:04 +10008617/*[clinic input]
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008618os.dup2 -> int
Larry Hastings2f936352014-08-05 14:04:04 +10008619 fd: int
8620 fd2: int
8621 inheritable: bool=True
8622
8623Duplicate file descriptor.
8624[clinic start generated code]*/
8625
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008626static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008627os_dup2_impl(PyObject *module, int fd, int fd2, int inheritable)
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008628/*[clinic end generated code: output=bc059d34a73404d1 input=c3cddda8922b038d]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008629{
Stéphane Wirtel3d86e482018-01-30 07:04:36 +01008630 int res = 0;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008631#if defined(HAVE_DUP3) && \
8632 !(defined(HAVE_FCNTL_H) && defined(F_DUP2FD_CLOEXEC))
8633 /* dup3() is available on Linux 2.6.27+ and glibc 2.9 */
Alexey Izbyshevb3caf382018-02-20 10:25:46 +03008634 static int dup3_works = -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008635#endif
8636
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008637 if (fd < 0 || fd2 < 0) {
8638 posix_error();
8639 return -1;
8640 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02008641
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008642 /* dup2() can fail with EINTR if the target FD is already open, because it
8643 * then has to be closed. See os_close_impl() for why we don't handle EINTR
8644 * upon close(), and therefore below.
8645 */
Victor Stinnerdaf45552013-08-28 00:53:59 +02008646#ifdef MS_WINDOWS
8647 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04008648 _Py_BEGIN_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00008649 res = dup2(fd, fd2);
Steve Dower8fc89802015-04-12 00:26:27 -04008650 _Py_END_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02008651 Py_END_ALLOW_THREADS
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008652 if (res < 0) {
8653 posix_error();
8654 return -1;
8655 }
8656 res = fd2; // msvcrt dup2 returns 0 on success.
Victor Stinnerdaf45552013-08-28 00:53:59 +02008657
8658 /* Character files like console cannot be make non-inheritable */
8659 if (!inheritable && _Py_set_inheritable(fd2, 0, NULL) < 0) {
8660 close(fd2);
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008661 return -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008662 }
8663
8664#elif defined(HAVE_FCNTL_H) && defined(F_DUP2FD_CLOEXEC)
8665 Py_BEGIN_ALLOW_THREADS
8666 if (!inheritable)
8667 res = fcntl(fd, F_DUP2FD_CLOEXEC, fd2);
8668 else
8669 res = dup2(fd, fd2);
8670 Py_END_ALLOW_THREADS
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008671 if (res < 0) {
8672 posix_error();
8673 return -1;
8674 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02008675
8676#else
8677
8678#ifdef HAVE_DUP3
8679 if (!inheritable && dup3_works != 0) {
8680 Py_BEGIN_ALLOW_THREADS
8681 res = dup3(fd, fd2, O_CLOEXEC);
8682 Py_END_ALLOW_THREADS
8683 if (res < 0) {
8684 if (dup3_works == -1)
8685 dup3_works = (errno != ENOSYS);
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008686 if (dup3_works) {
8687 posix_error();
8688 return -1;
8689 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02008690 }
8691 }
8692
8693 if (inheritable || dup3_works == 0)
8694 {
8695#endif
8696 Py_BEGIN_ALLOW_THREADS
8697 res = dup2(fd, fd2);
8698 Py_END_ALLOW_THREADS
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008699 if (res < 0) {
8700 posix_error();
8701 return -1;
8702 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02008703
8704 if (!inheritable && _Py_set_inheritable(fd2, 0, NULL) < 0) {
8705 close(fd2);
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008706 return -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008707 }
8708#ifdef HAVE_DUP3
8709 }
8710#endif
8711
8712#endif
8713
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008714 return res;
Guido van Rossum687dd131993-05-17 08:34:16 +00008715}
8716
Larry Hastings2f936352014-08-05 14:04:04 +10008717
Ross Lagerwall7807c352011-03-17 20:20:30 +02008718#ifdef HAVE_LOCKF
Larry Hastings2f936352014-08-05 14:04:04 +10008719/*[clinic input]
8720os.lockf
8721
8722 fd: int
8723 An open file descriptor.
8724 command: int
8725 One of F_LOCK, F_TLOCK, F_ULOCK or F_TEST.
8726 length: Py_off_t
8727 The number of bytes to lock, starting at the current position.
8728 /
8729
8730Apply, test or remove a POSIX lock on an open file descriptor.
8731
8732[clinic start generated code]*/
8733
Larry Hastings2f936352014-08-05 14:04:04 +10008734static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008735os_lockf_impl(PyObject *module, int fd, int command, Py_off_t length)
8736/*[clinic end generated code: output=af7051f3e7c29651 input=65da41d2106e9b79]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008737{
8738 int res;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008739
Steve Dowera00b5be2020-02-13 08:30:27 +00008740 if (PySys_Audit("os.lockf", "iiL", fd, command, length) < 0) {
8741 return NULL;
8742 }
8743
Ross Lagerwall7807c352011-03-17 20:20:30 +02008744 Py_BEGIN_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10008745 res = lockf(fd, command, length);
Ross Lagerwall7807c352011-03-17 20:20:30 +02008746 Py_END_ALLOW_THREADS
8747
8748 if (res < 0)
8749 return posix_error();
8750
8751 Py_RETURN_NONE;
8752}
Larry Hastings2f936352014-08-05 14:04:04 +10008753#endif /* HAVE_LOCKF */
Ross Lagerwall7807c352011-03-17 20:20:30 +02008754
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008755
Larry Hastings2f936352014-08-05 14:04:04 +10008756/*[clinic input]
8757os.lseek -> Py_off_t
8758
8759 fd: int
8760 position: Py_off_t
8761 how: int
8762 /
8763
8764Set the position of a file descriptor. Return the new position.
8765
8766Return the new cursor position in number of bytes
8767relative to the beginning of the file.
8768[clinic start generated code]*/
8769
Larry Hastings2f936352014-08-05 14:04:04 +10008770static Py_off_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008771os_lseek_impl(PyObject *module, int fd, Py_off_t position, int how)
8772/*[clinic end generated code: output=971e1efb6b30bd2f input=902654ad3f96a6d3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008773{
8774 Py_off_t result;
8775
Guido van Rossum687dd131993-05-17 08:34:16 +00008776#ifdef SEEK_SET
Victor Stinner8c62be82010-05-06 00:08:46 +00008777 /* Turn 0, 1, 2 into SEEK_{SET,CUR,END} */
8778 switch (how) {
Larry Hastings2f936352014-08-05 14:04:04 +10008779 case 0: how = SEEK_SET; break;
8780 case 1: how = SEEK_CUR; break;
8781 case 2: how = SEEK_END; break;
Victor Stinner8c62be82010-05-06 00:08:46 +00008782 }
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00008783#endif /* SEEK_END */
Guido van Rossum94f6f721999-01-06 18:42:14 +00008784
Victor Stinner8c62be82010-05-06 00:08:46 +00008785 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04008786 _Py_BEGIN_SUPPRESS_IPH
Victor Stinner14b9b112013-06-25 00:37:25 +02008787#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10008788 result = _lseeki64(fd, position, how);
Fred Drake699f3522000-06-29 21:12:41 +00008789#else
Larry Hastings2f936352014-08-05 14:04:04 +10008790 result = lseek(fd, position, how);
Fred Drake699f3522000-06-29 21:12:41 +00008791#endif
Steve Dower8fc89802015-04-12 00:26:27 -04008792 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00008793 Py_END_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10008794 if (result < 0)
8795 posix_error();
Guido van Rossum94f6f721999-01-06 18:42:14 +00008796
Larry Hastings2f936352014-08-05 14:04:04 +10008797 return result;
Guido van Rossum687dd131993-05-17 08:34:16 +00008798}
8799
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008800
Larry Hastings2f936352014-08-05 14:04:04 +10008801/*[clinic input]
8802os.read
8803 fd: int
8804 length: Py_ssize_t
8805 /
8806
8807Read from a file descriptor. Returns a bytes object.
8808[clinic start generated code]*/
8809
Larry Hastings2f936352014-08-05 14:04:04 +10008810static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008811os_read_impl(PyObject *module, int fd, Py_ssize_t length)
8812/*[clinic end generated code: output=dafbe9a5cddb987b input=1df2eaa27c0bf1d3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008813{
Victor Stinner8c62be82010-05-06 00:08:46 +00008814 Py_ssize_t n;
8815 PyObject *buffer;
Larry Hastings2f936352014-08-05 14:04:04 +10008816
8817 if (length < 0) {
Victor Stinner8c62be82010-05-06 00:08:46 +00008818 errno = EINVAL;
8819 return posix_error();
8820 }
Larry Hastings2f936352014-08-05 14:04:04 +10008821
Victor Stinner9a0d7a72018-11-22 15:03:40 +01008822 length = Py_MIN(length, _PY_READ_MAX);
Larry Hastings2f936352014-08-05 14:04:04 +10008823
8824 buffer = PyBytes_FromStringAndSize((char *)NULL, length);
Victor Stinner8c62be82010-05-06 00:08:46 +00008825 if (buffer == NULL)
8826 return NULL;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008827
Victor Stinner66aab0c2015-03-19 22:53:20 +01008828 n = _Py_read(fd, PyBytes_AS_STRING(buffer), length);
8829 if (n == -1) {
Victor Stinner8c62be82010-05-06 00:08:46 +00008830 Py_DECREF(buffer);
Victor Stinner66aab0c2015-03-19 22:53:20 +01008831 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00008832 }
Larry Hastings2f936352014-08-05 14:04:04 +10008833
8834 if (n != length)
Victor Stinner8c62be82010-05-06 00:08:46 +00008835 _PyBytes_Resize(&buffer, n);
Larry Hastings2f936352014-08-05 14:04:04 +10008836
Victor Stinner8c62be82010-05-06 00:08:46 +00008837 return buffer;
Guido van Rossum687dd131993-05-17 08:34:16 +00008838}
8839
Ross Lagerwall7807c352011-03-17 20:20:30 +02008840#if (defined(HAVE_SENDFILE) && (defined(__FreeBSD__) || defined(__DragonFly__) \
Serhiy Storchaka9d572732018-07-31 10:24:54 +03008841 || defined(__APPLE__))) \
8842 || defined(HAVE_READV) || defined(HAVE_PREADV) || defined (HAVE_PREADV2) \
8843 || defined(HAVE_WRITEV) || defined(HAVE_PWRITEV) || defined (HAVE_PWRITEV2)
8844static int
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008845iov_setup(struct iovec **iov, Py_buffer **buf, PyObject *seq, Py_ssize_t cnt, int type)
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008846{
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008847 Py_ssize_t i, j;
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00008848
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008849 *iov = PyMem_New(struct iovec, cnt);
8850 if (*iov == NULL) {
8851 PyErr_NoMemory();
Victor Stinner57ddf782014-01-08 15:21:28 +01008852 return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008853 }
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00008854
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008855 *buf = PyMem_New(Py_buffer, cnt);
8856 if (*buf == NULL) {
8857 PyMem_Del(*iov);
8858 PyErr_NoMemory();
Victor Stinner57ddf782014-01-08 15:21:28 +01008859 return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008860 }
8861
8862 for (i = 0; i < cnt; i++) {
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02008863 PyObject *item = PySequence_GetItem(seq, i);
8864 if (item == NULL)
8865 goto fail;
8866 if (PyObject_GetBuffer(item, &(*buf)[i], type) == -1) {
8867 Py_DECREF(item);
8868 goto fail;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008869 }
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02008870 Py_DECREF(item);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008871 (*iov)[i].iov_base = (*buf)[i].buf;
Serhiy Storchaka9d572732018-07-31 10:24:54 +03008872 (*iov)[i].iov_len = (*buf)[i].len;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008873 }
Serhiy Storchaka9d572732018-07-31 10:24:54 +03008874 return 0;
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02008875
8876fail:
8877 PyMem_Del(*iov);
8878 for (j = 0; j < i; j++) {
8879 PyBuffer_Release(&(*buf)[j]);
8880 }
8881 PyMem_Del(*buf);
Victor Stinner57ddf782014-01-08 15:21:28 +01008882 return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008883}
8884
8885static void
8886iov_cleanup(struct iovec *iov, Py_buffer *buf, int cnt)
8887{
8888 int i;
8889 PyMem_Del(iov);
8890 for (i = 0; i < cnt; i++) {
8891 PyBuffer_Release(&buf[i]);
8892 }
8893 PyMem_Del(buf);
8894}
8895#endif
8896
Larry Hastings2f936352014-08-05 14:04:04 +10008897
Ross Lagerwall7807c352011-03-17 20:20:30 +02008898#ifdef HAVE_READV
Larry Hastings2f936352014-08-05 14:04:04 +10008899/*[clinic input]
8900os.readv -> Py_ssize_t
8901
8902 fd: int
8903 buffers: object
8904 /
8905
8906Read from a file descriptor fd into an iterable of buffers.
8907
8908The buffers should be mutable buffers accepting bytes.
8909readv will transfer data into each buffer until it is full
8910and then move on to the next buffer in the sequence to hold
8911the rest of the data.
8912
8913readv returns the total number of bytes read,
8914which may be less than the total capacity of all the buffers.
8915[clinic start generated code]*/
8916
Larry Hastings2f936352014-08-05 14:04:04 +10008917static Py_ssize_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008918os_readv_impl(PyObject *module, int fd, PyObject *buffers)
8919/*[clinic end generated code: output=792da062d3fcebdb input=e679eb5dbfa0357d]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008920{
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008921 Py_ssize_t cnt, n;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008922 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008923 struct iovec *iov;
8924 Py_buffer *buf;
8925
Larry Hastings2f936352014-08-05 14:04:04 +10008926 if (!PySequence_Check(buffers)) {
Ross Lagerwall7807c352011-03-17 20:20:30 +02008927 PyErr_SetString(PyExc_TypeError,
8928 "readv() arg 2 must be a sequence");
Larry Hastings2f936352014-08-05 14:04:04 +10008929 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008930 }
Ross Lagerwall7807c352011-03-17 20:20:30 +02008931
Larry Hastings2f936352014-08-05 14:04:04 +10008932 cnt = PySequence_Size(buffers);
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008933 if (cnt < 0)
8934 return -1;
Larry Hastings2f936352014-08-05 14:04:04 +10008935
8936 if (iov_setup(&iov, &buf, buffers, cnt, PyBUF_WRITABLE) < 0)
8937 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008938
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008939 do {
8940 Py_BEGIN_ALLOW_THREADS
8941 n = readv(fd, iov, cnt);
8942 Py_END_ALLOW_THREADS
8943 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Ross Lagerwall7807c352011-03-17 20:20:30 +02008944
8945 iov_cleanup(iov, buf, cnt);
Larry Hastings2f936352014-08-05 14:04:04 +10008946 if (n < 0) {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008947 if (!async_err)
8948 posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10008949 return -1;
8950 }
Victor Stinner57ddf782014-01-08 15:21:28 +01008951
Larry Hastings2f936352014-08-05 14:04:04 +10008952 return n;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008953}
Larry Hastings2f936352014-08-05 14:04:04 +10008954#endif /* HAVE_READV */
8955
Ross Lagerwall7807c352011-03-17 20:20:30 +02008956
8957#ifdef HAVE_PREAD
Larry Hastings2f936352014-08-05 14:04:04 +10008958/*[clinic input]
8959# TODO length should be size_t! but Python doesn't support parsing size_t yet.
8960os.pread
8961
8962 fd: int
8963 length: int
8964 offset: Py_off_t
8965 /
8966
8967Read a number of bytes from a file descriptor starting at a particular offset.
8968
8969Read length bytes from file descriptor fd, starting at offset bytes from
8970the beginning of the file. The file offset remains unchanged.
8971[clinic start generated code]*/
8972
Larry Hastings2f936352014-08-05 14:04:04 +10008973static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008974os_pread_impl(PyObject *module, int fd, int length, Py_off_t offset)
8975/*[clinic end generated code: output=435b29ee32b54a78 input=084948dcbaa35d4c]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008976{
Ross Lagerwall7807c352011-03-17 20:20:30 +02008977 Py_ssize_t n;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008978 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008979 PyObject *buffer;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008980
Larry Hastings2f936352014-08-05 14:04:04 +10008981 if (length < 0) {
Ross Lagerwall7807c352011-03-17 20:20:30 +02008982 errno = EINVAL;
8983 return posix_error();
8984 }
Larry Hastings2f936352014-08-05 14:04:04 +10008985 buffer = PyBytes_FromStringAndSize((char *)NULL, length);
Ross Lagerwall7807c352011-03-17 20:20:30 +02008986 if (buffer == NULL)
8987 return NULL;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008988
8989 do {
8990 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04008991 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008992 n = pread(fd, PyBytes_AS_STRING(buffer), length, offset);
Steve Dower8fc89802015-04-12 00:26:27 -04008993 _Py_END_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008994 Py_END_ALLOW_THREADS
8995 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
8996
Ross Lagerwall7807c352011-03-17 20:20:30 +02008997 if (n < 0) {
8998 Py_DECREF(buffer);
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008999 return (!async_err) ? posix_error() : NULL;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009000 }
Larry Hastings2f936352014-08-05 14:04:04 +10009001 if (n != length)
Ross Lagerwall7807c352011-03-17 20:20:30 +02009002 _PyBytes_Resize(&buffer, n);
9003 return buffer;
9004}
Larry Hastings2f936352014-08-05 14:04:04 +10009005#endif /* HAVE_PREAD */
Ross Lagerwall7807c352011-03-17 20:20:30 +02009006
Pablo Galindo4defba32018-01-27 16:16:37 +00009007#if defined(HAVE_PREADV) || defined (HAVE_PREADV2)
9008/*[clinic input]
9009os.preadv -> Py_ssize_t
9010
9011 fd: int
9012 buffers: object
9013 offset: Py_off_t
9014 flags: int = 0
9015 /
9016
9017Reads from a file descriptor into a number of mutable bytes-like objects.
9018
9019Combines the functionality of readv() and pread(). As readv(), it will
9020transfer data into each buffer until it is full and then move on to the next
9021buffer in the sequence to hold the rest of the data. Its fourth argument,
9022specifies the file offset at which the input operation is to be performed. It
9023will return the total number of bytes read (which can be less than the total
9024capacity of all the objects).
9025
9026The flags argument contains a bitwise OR of zero or more of the following flags:
9027
9028- RWF_HIPRI
9029- RWF_NOWAIT
9030
9031Using non-zero flags requires Linux 4.6 or newer.
9032[clinic start generated code]*/
9033
9034static Py_ssize_t
9035os_preadv_impl(PyObject *module, int fd, PyObject *buffers, Py_off_t offset,
9036 int flags)
9037/*[clinic end generated code: output=26fc9c6e58e7ada5 input=4173919dc1f7ed99]*/
9038{
9039 Py_ssize_t cnt, n;
9040 int async_err = 0;
9041 struct iovec *iov;
9042 Py_buffer *buf;
9043
9044 if (!PySequence_Check(buffers)) {
9045 PyErr_SetString(PyExc_TypeError,
9046 "preadv2() arg 2 must be a sequence");
9047 return -1;
9048 }
9049
9050 cnt = PySequence_Size(buffers);
9051 if (cnt < 0) {
9052 return -1;
9053 }
9054
9055#ifndef HAVE_PREADV2
9056 if(flags != 0) {
9057 argument_unavailable_error("preadv2", "flags");
9058 return -1;
9059 }
9060#endif
9061
9062 if (iov_setup(&iov, &buf, buffers, cnt, PyBUF_WRITABLE) < 0) {
9063 return -1;
9064 }
9065#ifdef HAVE_PREADV2
9066 do {
9067 Py_BEGIN_ALLOW_THREADS
9068 _Py_BEGIN_SUPPRESS_IPH
9069 n = preadv2(fd, iov, cnt, offset, flags);
9070 _Py_END_SUPPRESS_IPH
9071 Py_END_ALLOW_THREADS
9072 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
9073#else
9074 do {
9075 Py_BEGIN_ALLOW_THREADS
9076 _Py_BEGIN_SUPPRESS_IPH
9077 n = preadv(fd, iov, cnt, offset);
9078 _Py_END_SUPPRESS_IPH
9079 Py_END_ALLOW_THREADS
9080 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
9081#endif
9082
9083 iov_cleanup(iov, buf, cnt);
9084 if (n < 0) {
9085 if (!async_err) {
9086 posix_error();
9087 }
9088 return -1;
9089 }
9090
9091 return n;
9092}
9093#endif /* HAVE_PREADV */
9094
Larry Hastings2f936352014-08-05 14:04:04 +10009095
9096/*[clinic input]
9097os.write -> Py_ssize_t
9098
9099 fd: int
9100 data: Py_buffer
9101 /
9102
9103Write a bytes object to a file descriptor.
9104[clinic start generated code]*/
9105
Larry Hastings2f936352014-08-05 14:04:04 +10009106static Py_ssize_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009107os_write_impl(PyObject *module, int fd, Py_buffer *data)
9108/*[clinic end generated code: output=e4ef5bc904b58ef9 input=3207e28963234f3c]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009109{
Victor Stinner66aab0c2015-03-19 22:53:20 +01009110 return _Py_write(fd, data->buf, data->len);
Ross Lagerwall7807c352011-03-17 20:20:30 +02009111}
9112
9113#ifdef HAVE_SENDFILE
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009114PyDoc_STRVAR(posix_sendfile__doc__,
Martin Panterbf19d162015-09-09 01:01:13 +00009115"sendfile(out, in, offset, count) -> byteswritten\n\
Martin Panter94994132015-09-09 05:29:24 +00009116sendfile(out, in, offset, count[, headers][, trailers], flags=0)\n\
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009117 -> byteswritten\n\
Martin Panterbf19d162015-09-09 01:01:13 +00009118Copy count bytes from file descriptor in to file descriptor out.");
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009119
Larry Hastings2f936352014-08-05 14:04:04 +10009120/* AC 3.5: don't bother converting, has optional group*/
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009121static PyObject *
9122posix_sendfile(PyObject *self, PyObject *args, PyObject *kwdict)
9123{
9124 int in, out;
9125 Py_ssize_t ret;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009126 int async_err = 0;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009127 off_t offset;
9128
9129#if defined(__FreeBSD__) || defined(__DragonFly__) || defined(__APPLE__)
9130#ifndef __APPLE__
9131 Py_ssize_t len;
9132#endif
9133 PyObject *headers = NULL, *trailers = NULL;
9134 Py_buffer *hbuf, *tbuf;
9135 off_t sbytes;
9136 struct sf_hdtr sf;
9137 int flags = 0;
Martin Panterbf19d162015-09-09 01:01:13 +00009138 /* Beware that "in" clashes with Python's own "in" operator keyword */
Benjamin Petersond8a43b42011-02-26 21:35:16 +00009139 static char *keywords[] = {"out", "in",
9140 "offset", "count",
9141 "headers", "trailers", "flags", NULL};
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009142
Victor Stinner6ce0dbf2013-07-07 16:32:36 +02009143 sf.headers = NULL;
9144 sf.trailers = NULL;
9145
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009146#ifdef __APPLE__
9147 if (!PyArg_ParseTupleAndKeywords(args, kwdict, "iiO&O&|OOi:sendfile",
Larry Hastings2f936352014-08-05 14:04:04 +10009148 keywords, &out, &in, Py_off_t_converter, &offset, Py_off_t_converter, &sbytes,
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009149#else
9150 if (!PyArg_ParseTupleAndKeywords(args, kwdict, "iiO&n|OOi:sendfile",
Larry Hastings2f936352014-08-05 14:04:04 +10009151 keywords, &out, &in, Py_off_t_converter, &offset, &len,
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009152#endif
9153 &headers, &trailers, &flags))
9154 return NULL;
9155 if (headers != NULL) {
9156 if (!PySequence_Check(headers)) {
9157 PyErr_SetString(PyExc_TypeError,
Martin Panter94994132015-09-09 05:29:24 +00009158 "sendfile() headers must be a sequence");
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009159 return NULL;
9160 } else {
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009161 Py_ssize_t i = PySequence_Size(headers);
9162 if (i < 0)
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009163 return NULL;
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009164 if (i > INT_MAX) {
9165 PyErr_SetString(PyExc_OverflowError,
9166 "sendfile() header is too large");
9167 return NULL;
9168 }
9169 if (i > 0) {
9170 sf.hdr_cnt = (int)i;
Serhiy Storchaka9d572732018-07-31 10:24:54 +03009171 if (iov_setup(&(sf.headers), &hbuf,
9172 headers, sf.hdr_cnt, PyBUF_SIMPLE) < 0)
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009173 return NULL;
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00009174#ifdef __APPLE__
Serhiy Storchaka9d572732018-07-31 10:24:54 +03009175 for (i = 0; i < sf.hdr_cnt; i++) {
9176 Py_ssize_t blen = sf.headers[i].iov_len;
9177# define OFF_T_MAX 0x7fffffffffffffff
9178 if (sbytes >= OFF_T_MAX - blen) {
9179 PyErr_SetString(PyExc_OverflowError,
9180 "sendfile() header is too large");
9181 return NULL;
9182 }
9183 sbytes += blen;
9184 }
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00009185#endif
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009186 }
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009187 }
9188 }
9189 if (trailers != NULL) {
9190 if (!PySequence_Check(trailers)) {
9191 PyErr_SetString(PyExc_TypeError,
Martin Panter94994132015-09-09 05:29:24 +00009192 "sendfile() trailers must be a sequence");
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009193 return NULL;
9194 } else {
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009195 Py_ssize_t i = PySequence_Size(trailers);
9196 if (i < 0)
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009197 return NULL;
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009198 if (i > INT_MAX) {
9199 PyErr_SetString(PyExc_OverflowError,
9200 "sendfile() trailer is too large");
9201 return NULL;
9202 }
9203 if (i > 0) {
9204 sf.trl_cnt = (int)i;
Serhiy Storchaka9d572732018-07-31 10:24:54 +03009205 if (iov_setup(&(sf.trailers), &tbuf,
9206 trailers, sf.trl_cnt, PyBUF_SIMPLE) < 0)
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009207 return NULL;
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009208 }
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009209 }
9210 }
9211
Steve Dower8fc89802015-04-12 00:26:27 -04009212 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009213 do {
9214 Py_BEGIN_ALLOW_THREADS
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009215#ifdef __APPLE__
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009216 ret = sendfile(in, out, offset, &sbytes, &sf, flags);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009217#else
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009218 ret = sendfile(in, out, offset, len, &sf, &sbytes, flags);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009219#endif
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009220 Py_END_ALLOW_THREADS
9221 } while (ret < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Steve Dower8fc89802015-04-12 00:26:27 -04009222 _Py_END_SUPPRESS_IPH
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009223
9224 if (sf.headers != NULL)
9225 iov_cleanup(sf.headers, hbuf, sf.hdr_cnt);
9226 if (sf.trailers != NULL)
9227 iov_cleanup(sf.trailers, tbuf, sf.trl_cnt);
9228
9229 if (ret < 0) {
9230 if ((errno == EAGAIN) || (errno == EBUSY)) {
9231 if (sbytes != 0) {
9232 // some data has been sent
9233 goto done;
9234 }
9235 else {
9236 // no data has been sent; upper application is supposed
9237 // to retry on EAGAIN or EBUSY
9238 return posix_error();
9239 }
9240 }
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009241 return (!async_err) ? posix_error() : NULL;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009242 }
9243 goto done;
9244
9245done:
9246 #if !defined(HAVE_LARGEFILE_SUPPORT)
9247 return Py_BuildValue("l", sbytes);
9248 #else
9249 return Py_BuildValue("L", sbytes);
9250 #endif
9251
9252#else
9253 Py_ssize_t count;
9254 PyObject *offobj;
9255 static char *keywords[] = {"out", "in",
9256 "offset", "count", NULL};
9257 if (!PyArg_ParseTupleAndKeywords(args, kwdict, "iiOn:sendfile",
9258 keywords, &out, &in, &offobj, &count))
9259 return NULL;
Benjamin Peterson840ef8f2016-09-07 14:45:10 -07009260#ifdef __linux__
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009261 if (offobj == Py_None) {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009262 do {
9263 Py_BEGIN_ALLOW_THREADS
9264 ret = sendfile(out, in, NULL, count);
9265 Py_END_ALLOW_THREADS
9266 } while (ret < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009267 if (ret < 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009268 return (!async_err) ? posix_error() : NULL;
Giampaolo Rodola'ff1a7352011-04-19 09:47:16 +02009269 return Py_BuildValue("n", ret);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009270 }
9271#endif
Larry Hastings2f936352014-08-05 14:04:04 +10009272 if (!Py_off_t_converter(offobj, &offset))
Antoine Pitroudcc20b82011-02-26 13:38:35 +00009273 return NULL;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009274
9275 do {
9276 Py_BEGIN_ALLOW_THREADS
9277 ret = sendfile(out, in, &offset, count);
9278 Py_END_ALLOW_THREADS
9279 } while (ret < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009280 if (ret < 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009281 return (!async_err) ? posix_error() : NULL;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009282 return Py_BuildValue("n", ret);
9283#endif
9284}
Larry Hastings2f936352014-08-05 14:04:04 +10009285#endif /* HAVE_SENDFILE */
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00009286
Larry Hastings2f936352014-08-05 14:04:04 +10009287
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +02009288#if defined(__APPLE__)
9289/*[clinic input]
9290os._fcopyfile
9291
9292 infd: int
9293 outfd: int
9294 flags: int
9295 /
9296
Giampaolo Rodolac7f02a92018-06-19 08:27:29 -07009297Efficiently copy content or metadata of 2 regular file descriptors (macOS).
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +02009298[clinic start generated code]*/
9299
9300static PyObject *
9301os__fcopyfile_impl(PyObject *module, int infd, int outfd, int flags)
Giampaolo Rodolac7f02a92018-06-19 08:27:29 -07009302/*[clinic end generated code: output=8e8885c721ec38e3 input=69e0770e600cb44f]*/
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +02009303{
9304 int ret;
9305
9306 Py_BEGIN_ALLOW_THREADS
9307 ret = fcopyfile(infd, outfd, NULL, flags);
9308 Py_END_ALLOW_THREADS
9309 if (ret < 0)
9310 return posix_error();
9311 Py_RETURN_NONE;
9312}
9313#endif
9314
9315
Larry Hastings2f936352014-08-05 14:04:04 +10009316/*[clinic input]
9317os.fstat
9318
9319 fd : int
9320
9321Perform a stat system call on the given file descriptor.
9322
9323Like stat(), but for an open file descriptor.
9324Equivalent to os.stat(fd).
9325[clinic start generated code]*/
9326
Larry Hastings2f936352014-08-05 14:04:04 +10009327static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009328os_fstat_impl(PyObject *module, int fd)
9329/*[clinic end generated code: output=efc038cb5f654492 input=27e0e0ebbe5600c9]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009330{
Victor Stinner8c62be82010-05-06 00:08:46 +00009331 STRUCT_STAT st;
9332 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009333 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10009334
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009335 do {
9336 Py_BEGIN_ALLOW_THREADS
9337 res = FSTAT(fd, &st);
9338 Py_END_ALLOW_THREADS
9339 } while (res != 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Victor Stinner8c62be82010-05-06 00:08:46 +00009340 if (res != 0) {
Martin v. Löwis14694662006-02-03 12:54:16 +00009341#ifdef MS_WINDOWS
Victor Stinnerb024e842012-10-31 22:24:06 +01009342 return PyErr_SetFromWindowsErr(0);
Martin v. Löwis14694662006-02-03 12:54:16 +00009343#else
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009344 return (!async_err) ? posix_error() : NULL;
Martin v. Löwis14694662006-02-03 12:54:16 +00009345#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00009346 }
Tim Peters5aa91602002-01-30 05:46:57 +00009347
Victor Stinner4195b5c2012-02-08 23:03:19 +01009348 return _pystat_fromstructstat(&st);
Guido van Rossum687dd131993-05-17 08:34:16 +00009349}
9350
Larry Hastings2f936352014-08-05 14:04:04 +10009351
9352/*[clinic input]
9353os.isatty -> bool
9354 fd: int
9355 /
9356
9357Return True if the fd is connected to a terminal.
9358
9359Return True if the file descriptor is an open file descriptor
9360connected to the slave end of a terminal.
9361[clinic start generated code]*/
9362
Larry Hastings2f936352014-08-05 14:04:04 +10009363static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009364os_isatty_impl(PyObject *module, int fd)
9365/*[clinic end generated code: output=6a48c8b4e644ca00 input=08ce94aa1eaf7b5e]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009366{
Steve Dower8fc89802015-04-12 00:26:27 -04009367 int return_value;
Steve Dower8fc89802015-04-12 00:26:27 -04009368 _Py_BEGIN_SUPPRESS_IPH
9369 return_value = isatty(fd);
9370 _Py_END_SUPPRESS_IPH
9371 return return_value;
Larry Hastings2f936352014-08-05 14:04:04 +10009372}
9373
9374
Guido van Rossuma4916fa1996-05-23 22:58:55 +00009375#ifdef HAVE_PIPE
Larry Hastings2f936352014-08-05 14:04:04 +10009376/*[clinic input]
9377os.pipe
9378
9379Create a pipe.
9380
9381Returns a tuple of two file descriptors:
9382 (read_fd, write_fd)
9383[clinic start generated code]*/
9384
Larry Hastings2f936352014-08-05 14:04:04 +10009385static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009386os_pipe_impl(PyObject *module)
9387/*[clinic end generated code: output=ff9b76255793b440 input=02535e8c8fa6c4d4]*/
Guido van Rossum687dd131993-05-17 08:34:16 +00009388{
Victor Stinner8c62be82010-05-06 00:08:46 +00009389 int fds[2];
Victor Stinnerdaf45552013-08-28 00:53:59 +02009390#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00009391 HANDLE read, write;
Victor Stinnerdaf45552013-08-28 00:53:59 +02009392 SECURITY_ATTRIBUTES attr;
Victor Stinner8c62be82010-05-06 00:08:46 +00009393 BOOL ok;
Victor Stinnerdaf45552013-08-28 00:53:59 +02009394#else
9395 int res;
9396#endif
9397
9398#ifdef MS_WINDOWS
9399 attr.nLength = sizeof(attr);
9400 attr.lpSecurityDescriptor = NULL;
9401 attr.bInheritHandle = FALSE;
9402
9403 Py_BEGIN_ALLOW_THREADS
Steve Dowerc3630612016-11-19 18:41:16 -08009404 _Py_BEGIN_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02009405 ok = CreatePipe(&read, &write, &attr, 0);
9406 if (ok) {
Benjamin Petersonca470632016-09-06 13:47:26 -07009407 fds[0] = _open_osfhandle((intptr_t)read, _O_RDONLY);
9408 fds[1] = _open_osfhandle((intptr_t)write, _O_WRONLY);
Victor Stinnerdaf45552013-08-28 00:53:59 +02009409 if (fds[0] == -1 || fds[1] == -1) {
9410 CloseHandle(read);
9411 CloseHandle(write);
9412 ok = 0;
9413 }
9414 }
Steve Dowerc3630612016-11-19 18:41:16 -08009415 _Py_END_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02009416 Py_END_ALLOW_THREADS
9417
Victor Stinner8c62be82010-05-06 00:08:46 +00009418 if (!ok)
Victor Stinnerb024e842012-10-31 22:24:06 +01009419 return PyErr_SetFromWindowsErr(0);
Victor Stinnerdaf45552013-08-28 00:53:59 +02009420#else
9421
9422#ifdef HAVE_PIPE2
9423 Py_BEGIN_ALLOW_THREADS
9424 res = pipe2(fds, O_CLOEXEC);
9425 Py_END_ALLOW_THREADS
9426
9427 if (res != 0 && errno == ENOSYS)
9428 {
9429#endif
9430 Py_BEGIN_ALLOW_THREADS
9431 res = pipe(fds);
9432 Py_END_ALLOW_THREADS
9433
9434 if (res == 0) {
9435 if (_Py_set_inheritable(fds[0], 0, NULL) < 0) {
9436 close(fds[0]);
9437 close(fds[1]);
9438 return NULL;
9439 }
9440 if (_Py_set_inheritable(fds[1], 0, NULL) < 0) {
9441 close(fds[0]);
9442 close(fds[1]);
9443 return NULL;
9444 }
9445 }
9446#ifdef HAVE_PIPE2
9447 }
9448#endif
9449
9450 if (res != 0)
9451 return PyErr_SetFromErrno(PyExc_OSError);
9452#endif /* !MS_WINDOWS */
9453 return Py_BuildValue("(ii)", fds[0], fds[1]);
Guido van Rossum687dd131993-05-17 08:34:16 +00009454}
Guido van Rossuma4916fa1996-05-23 22:58:55 +00009455#endif /* HAVE_PIPE */
9456
Larry Hastings2f936352014-08-05 14:04:04 +10009457
Charles-François Natalidaafdd52011-05-29 20:07:40 +02009458#ifdef HAVE_PIPE2
Larry Hastings2f936352014-08-05 14:04:04 +10009459/*[clinic input]
9460os.pipe2
9461
9462 flags: int
9463 /
9464
9465Create a pipe with flags set atomically.
9466
9467Returns a tuple of two file descriptors:
9468 (read_fd, write_fd)
9469
9470flags can be constructed by ORing together one or more of these values:
9471O_NONBLOCK, O_CLOEXEC.
9472[clinic start generated code]*/
9473
Larry Hastings2f936352014-08-05 14:04:04 +10009474static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009475os_pipe2_impl(PyObject *module, int flags)
9476/*[clinic end generated code: output=25751fb43a45540f input=f261b6e7e63c6817]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009477{
Charles-François Natalidaafdd52011-05-29 20:07:40 +02009478 int fds[2];
9479 int res;
9480
Charles-François Natalidaafdd52011-05-29 20:07:40 +02009481 res = pipe2(fds, flags);
9482 if (res != 0)
9483 return posix_error();
9484 return Py_BuildValue("(ii)", fds[0], fds[1]);
9485}
9486#endif /* HAVE_PIPE2 */
9487
Larry Hastings2f936352014-08-05 14:04:04 +10009488
Ross Lagerwall7807c352011-03-17 20:20:30 +02009489#ifdef HAVE_WRITEV
Larry Hastings2f936352014-08-05 14:04:04 +10009490/*[clinic input]
9491os.writev -> Py_ssize_t
9492 fd: int
9493 buffers: object
9494 /
9495
9496Iterate over buffers, and write the contents of each to a file descriptor.
9497
9498Returns the total number of bytes written.
9499buffers must be a sequence of bytes-like objects.
9500[clinic start generated code]*/
9501
Larry Hastings2f936352014-08-05 14:04:04 +10009502static Py_ssize_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009503os_writev_impl(PyObject *module, int fd, PyObject *buffers)
9504/*[clinic end generated code: output=56565cfac3aac15b input=5b8d17fe4189d2fe]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009505{
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009506 Py_ssize_t cnt;
Larry Hastings2f936352014-08-05 14:04:04 +10009507 Py_ssize_t result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009508 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009509 struct iovec *iov;
9510 Py_buffer *buf;
Larry Hastings2f936352014-08-05 14:04:04 +10009511
9512 if (!PySequence_Check(buffers)) {
Ross Lagerwall7807c352011-03-17 20:20:30 +02009513 PyErr_SetString(PyExc_TypeError,
9514 "writev() arg 2 must be a sequence");
Larry Hastings2f936352014-08-05 14:04:04 +10009515 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009516 }
Larry Hastings2f936352014-08-05 14:04:04 +10009517 cnt = PySequence_Size(buffers);
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009518 if (cnt < 0)
9519 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009520
Larry Hastings2f936352014-08-05 14:04:04 +10009521 if (iov_setup(&iov, &buf, buffers, cnt, PyBUF_SIMPLE) < 0) {
9522 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009523 }
9524
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009525 do {
9526 Py_BEGIN_ALLOW_THREADS
9527 result = writev(fd, iov, cnt);
9528 Py_END_ALLOW_THREADS
9529 } while (result < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Ross Lagerwall7807c352011-03-17 20:20:30 +02009530
9531 iov_cleanup(iov, buf, cnt);
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009532 if (result < 0 && !async_err)
Larry Hastings2f936352014-08-05 14:04:04 +10009533 posix_error();
Victor Stinner57ddf782014-01-08 15:21:28 +01009534
Georg Brandl306336b2012-06-24 12:55:33 +02009535 return result;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009536}
Larry Hastings2f936352014-08-05 14:04:04 +10009537#endif /* HAVE_WRITEV */
9538
9539
9540#ifdef HAVE_PWRITE
9541/*[clinic input]
9542os.pwrite -> Py_ssize_t
9543
9544 fd: int
9545 buffer: Py_buffer
9546 offset: Py_off_t
9547 /
9548
9549Write bytes to a file descriptor starting at a particular offset.
9550
9551Write buffer to fd, starting at offset bytes from the beginning of
9552the file. Returns the number of bytes writte. Does not change the
9553current file offset.
9554[clinic start generated code]*/
9555
Larry Hastings2f936352014-08-05 14:04:04 +10009556static Py_ssize_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009557os_pwrite_impl(PyObject *module, int fd, Py_buffer *buffer, Py_off_t offset)
9558/*[clinic end generated code: output=c74da630758ee925 input=19903f1b3dd26377]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009559{
9560 Py_ssize_t size;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009561 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10009562
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009563 do {
9564 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04009565 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009566 size = pwrite(fd, buffer->buf, (size_t)buffer->len, offset);
Steve Dower8fc89802015-04-12 00:26:27 -04009567 _Py_END_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009568 Py_END_ALLOW_THREADS
9569 } while (size < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Larry Hastings2f936352014-08-05 14:04:04 +10009570
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009571 if (size < 0 && !async_err)
Larry Hastings2f936352014-08-05 14:04:04 +10009572 posix_error();
9573 return size;
9574}
9575#endif /* HAVE_PWRITE */
9576
Pablo Galindo4defba32018-01-27 16:16:37 +00009577#if defined(HAVE_PWRITEV) || defined (HAVE_PWRITEV2)
9578/*[clinic input]
9579os.pwritev -> Py_ssize_t
9580
9581 fd: int
9582 buffers: object
9583 offset: Py_off_t
9584 flags: int = 0
9585 /
9586
9587Writes the contents of bytes-like objects to a file descriptor at a given offset.
9588
9589Combines the functionality of writev() and pwrite(). All buffers must be a sequence
9590of bytes-like objects. Buffers are processed in array order. Entire contents of first
9591buffer is written before proceeding to second, and so on. The operating system may
9592set a limit (sysconf() value SC_IOV_MAX) on the number of buffers that can be used.
9593This function writes the contents of each object to the file descriptor and returns
9594the total number of bytes written.
9595
9596The flags argument contains a bitwise OR of zero or more of the following flags:
9597
9598- RWF_DSYNC
9599- RWF_SYNC
9600
9601Using non-zero flags requires Linux 4.7 or newer.
9602[clinic start generated code]*/
9603
9604static Py_ssize_t
9605os_pwritev_impl(PyObject *module, int fd, PyObject *buffers, Py_off_t offset,
9606 int flags)
9607/*[clinic end generated code: output=e3dd3e9d11a6a5c7 input=803dc5ddbf0cfd3b]*/
9608{
9609 Py_ssize_t cnt;
9610 Py_ssize_t result;
9611 int async_err = 0;
9612 struct iovec *iov;
9613 Py_buffer *buf;
9614
9615 if (!PySequence_Check(buffers)) {
9616 PyErr_SetString(PyExc_TypeError,
9617 "pwritev() arg 2 must be a sequence");
9618 return -1;
9619 }
9620
9621 cnt = PySequence_Size(buffers);
9622 if (cnt < 0) {
9623 return -1;
9624 }
9625
9626#ifndef HAVE_PWRITEV2
9627 if(flags != 0) {
9628 argument_unavailable_error("pwritev2", "flags");
9629 return -1;
9630 }
9631#endif
9632
9633 if (iov_setup(&iov, &buf, buffers, cnt, PyBUF_SIMPLE) < 0) {
9634 return -1;
9635 }
9636#ifdef HAVE_PWRITEV2
9637 do {
9638 Py_BEGIN_ALLOW_THREADS
9639 _Py_BEGIN_SUPPRESS_IPH
9640 result = pwritev2(fd, iov, cnt, offset, flags);
9641 _Py_END_SUPPRESS_IPH
9642 Py_END_ALLOW_THREADS
9643 } while (result < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
9644#else
9645 do {
9646 Py_BEGIN_ALLOW_THREADS
9647 _Py_BEGIN_SUPPRESS_IPH
9648 result = pwritev(fd, iov, cnt, offset);
9649 _Py_END_SUPPRESS_IPH
9650 Py_END_ALLOW_THREADS
9651 } while (result < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
9652#endif
9653
9654 iov_cleanup(iov, buf, cnt);
9655 if (result < 0) {
9656 if (!async_err) {
9657 posix_error();
9658 }
9659 return -1;
9660 }
9661
9662 return result;
9663}
9664#endif /* HAVE_PWRITEV */
9665
Pablo Galindoaac4d032019-05-31 19:39:47 +01009666#ifdef HAVE_COPY_FILE_RANGE
9667/*[clinic input]
9668
9669os.copy_file_range
9670 src: int
9671 Source file descriptor.
9672 dst: int
9673 Destination file descriptor.
9674 count: Py_ssize_t
9675 Number of bytes to copy.
9676 offset_src: object = None
9677 Starting offset in src.
9678 offset_dst: object = None
9679 Starting offset in dst.
9680
9681Copy count bytes from one file descriptor to another.
9682
9683If offset_src is None, then src is read from the current position;
9684respectively for offset_dst.
9685[clinic start generated code]*/
9686
9687static PyObject *
9688os_copy_file_range_impl(PyObject *module, int src, int dst, Py_ssize_t count,
9689 PyObject *offset_src, PyObject *offset_dst)
9690/*[clinic end generated code: output=1a91713a1d99fc7a input=42fdce72681b25a9]*/
9691{
9692 off_t offset_src_val, offset_dst_val;
9693 off_t *p_offset_src = NULL;
9694 off_t *p_offset_dst = NULL;
9695 Py_ssize_t ret;
9696 int async_err = 0;
9697 /* The flags argument is provided to allow
9698 * for future extensions and currently must be to 0. */
9699 int flags = 0;
Pablo Galindo4defba32018-01-27 16:16:37 +00009700
9701
Pablo Galindoaac4d032019-05-31 19:39:47 +01009702 if (count < 0) {
9703 PyErr_SetString(PyExc_ValueError, "negative value for 'count' not allowed");
9704 return NULL;
9705 }
9706
9707 if (offset_src != Py_None) {
9708 if (!Py_off_t_converter(offset_src, &offset_src_val)) {
9709 return NULL;
9710 }
9711 p_offset_src = &offset_src_val;
9712 }
9713
9714 if (offset_dst != Py_None) {
9715 if (!Py_off_t_converter(offset_dst, &offset_dst_val)) {
9716 return NULL;
9717 }
9718 p_offset_dst = &offset_dst_val;
9719 }
9720
9721 do {
9722 Py_BEGIN_ALLOW_THREADS
9723 ret = copy_file_range(src, p_offset_src, dst, p_offset_dst, count, flags);
9724 Py_END_ALLOW_THREADS
9725 } while (ret < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
9726
9727 if (ret < 0) {
9728 return (!async_err) ? posix_error() : NULL;
9729 }
9730
9731 return PyLong_FromSsize_t(ret);
9732}
9733#endif /* HAVE_COPY_FILE_RANGE*/
Larry Hastings2f936352014-08-05 14:04:04 +10009734
9735#ifdef HAVE_MKFIFO
9736/*[clinic input]
9737os.mkfifo
9738
9739 path: path_t
9740 mode: int=0o666
9741 *
9742 dir_fd: dir_fd(requires='mkfifoat')=None
9743
9744Create a "fifo" (a POSIX named pipe).
9745
9746If dir_fd is not None, it should be a file descriptor open to a directory,
9747 and path should be relative; path will then be relative to that directory.
9748dir_fd may not be implemented on your platform.
9749 If it is unavailable, using it will raise a NotImplementedError.
9750[clinic start generated code]*/
9751
Larry Hastings2f936352014-08-05 14:04:04 +10009752static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009753os_mkfifo_impl(PyObject *module, path_t *path, int mode, int dir_fd)
9754/*[clinic end generated code: output=ce41cfad0e68c940 input=73032e98a36e0e19]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009755{
9756 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009757 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10009758
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009759 do {
9760 Py_BEGIN_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10009761#ifdef HAVE_MKFIFOAT
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009762 if (dir_fd != DEFAULT_DIR_FD)
9763 result = mkfifoat(dir_fd, path->narrow, mode);
9764 else
Ross Lagerwall7807c352011-03-17 20:20:30 +02009765#endif
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009766 result = mkfifo(path->narrow, mode);
9767 Py_END_ALLOW_THREADS
9768 } while (result != 0 && errno == EINTR &&
9769 !(async_err = PyErr_CheckSignals()));
9770 if (result != 0)
9771 return (!async_err) ? posix_error() : NULL;
Larry Hastings2f936352014-08-05 14:04:04 +10009772
9773 Py_RETURN_NONE;
9774}
9775#endif /* HAVE_MKFIFO */
9776
9777
9778#if defined(HAVE_MKNOD) && defined(HAVE_MAKEDEV)
9779/*[clinic input]
9780os.mknod
9781
9782 path: path_t
9783 mode: int=0o600
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +02009784 device: dev_t=0
Larry Hastings2f936352014-08-05 14:04:04 +10009785 *
9786 dir_fd: dir_fd(requires='mknodat')=None
9787
9788Create a node in the file system.
9789
9790Create a node in the file system (file, device special file or named pipe)
9791at path. mode specifies both the permissions to use and the
9792type of node to be created, being combined (bitwise OR) with one of
9793S_IFREG, S_IFCHR, S_IFBLK, and S_IFIFO. If S_IFCHR or S_IFBLK is set on mode,
9794device defines the newly created device special file (probably using
9795os.makedev()). Otherwise device is ignored.
9796
9797If dir_fd is not None, it should be a file descriptor open to a directory,
9798 and path should be relative; path will then be relative to that directory.
9799dir_fd may not be implemented on your platform.
9800 If it is unavailable, using it will raise a NotImplementedError.
9801[clinic start generated code]*/
9802
Larry Hastings2f936352014-08-05 14:04:04 +10009803static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009804os_mknod_impl(PyObject *module, path_t *path, int mode, dev_t device,
Larry Hastings89964c42015-04-14 18:07:59 -04009805 int dir_fd)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009806/*[clinic end generated code: output=92e55d3ca8917461 input=ee44531551a4d83b]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009807{
9808 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009809 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10009810
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009811 do {
9812 Py_BEGIN_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10009813#ifdef HAVE_MKNODAT
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009814 if (dir_fd != DEFAULT_DIR_FD)
9815 result = mknodat(dir_fd, path->narrow, mode, device);
9816 else
Larry Hastings2f936352014-08-05 14:04:04 +10009817#endif
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009818 result = mknod(path->narrow, mode, device);
9819 Py_END_ALLOW_THREADS
9820 } while (result != 0 && errno == EINTR &&
9821 !(async_err = PyErr_CheckSignals()));
9822 if (result != 0)
9823 return (!async_err) ? posix_error() : NULL;
Larry Hastings2f936352014-08-05 14:04:04 +10009824
9825 Py_RETURN_NONE;
9826}
9827#endif /* defined(HAVE_MKNOD) && defined(HAVE_MAKEDEV) */
9828
9829
9830#ifdef HAVE_DEVICE_MACROS
9831/*[clinic input]
9832os.major -> unsigned_int
9833
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +02009834 device: dev_t
Larry Hastings2f936352014-08-05 14:04:04 +10009835 /
9836
9837Extracts a device major number from a raw device number.
9838[clinic start generated code]*/
9839
Larry Hastings2f936352014-08-05 14:04:04 +10009840static unsigned int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009841os_major_impl(PyObject *module, dev_t device)
9842/*[clinic end generated code: output=5b3b2589bafb498e input=1e16a4d30c4d4462]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009843{
9844 return major(device);
9845}
9846
9847
9848/*[clinic input]
9849os.minor -> unsigned_int
9850
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +02009851 device: dev_t
Larry Hastings2f936352014-08-05 14:04:04 +10009852 /
9853
9854Extracts a device minor number from a raw device number.
9855[clinic start generated code]*/
9856
Larry Hastings2f936352014-08-05 14:04:04 +10009857static unsigned int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009858os_minor_impl(PyObject *module, dev_t device)
9859/*[clinic end generated code: output=5e1a25e630b0157d input=0842c6d23f24c65e]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009860{
9861 return minor(device);
9862}
9863
9864
9865/*[clinic input]
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +02009866os.makedev -> dev_t
Larry Hastings2f936352014-08-05 14:04:04 +10009867
9868 major: int
9869 minor: int
9870 /
9871
9872Composes a raw device number from the major and minor device numbers.
9873[clinic start generated code]*/
9874
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +02009875static dev_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009876os_makedev_impl(PyObject *module, int major, int minor)
9877/*[clinic end generated code: output=881aaa4aba6f6a52 input=4b9fd8fc73cbe48f]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009878{
9879 return makedev(major, minor);
9880}
9881#endif /* HAVE_DEVICE_MACROS */
9882
9883
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009884#if defined HAVE_FTRUNCATE || defined MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10009885/*[clinic input]
9886os.ftruncate
9887
9888 fd: int
9889 length: Py_off_t
9890 /
9891
9892Truncate a file, specified by file descriptor, to a specific length.
9893[clinic start generated code]*/
9894
Larry Hastings2f936352014-08-05 14:04:04 +10009895static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009896os_ftruncate_impl(PyObject *module, int fd, Py_off_t length)
9897/*[clinic end generated code: output=fba15523721be7e4 input=63b43641e52818f2]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009898{
9899 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009900 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10009901
Steve Dowerb82e17e2019-05-23 08:45:22 -07009902 if (PySys_Audit("os.truncate", "in", fd, length) < 0) {
9903 return NULL;
9904 }
9905
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009906 do {
9907 Py_BEGIN_ALLOW_THREADS
Steve Dowera1c7e722015-04-12 00:26:43 -04009908 _Py_BEGIN_SUPPRESS_IPH
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009909#ifdef MS_WINDOWS
9910 result = _chsize_s(fd, length);
9911#else
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009912 result = ftruncate(fd, length);
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009913#endif
Steve Dowera1c7e722015-04-12 00:26:43 -04009914 _Py_END_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009915 Py_END_ALLOW_THREADS
9916 } while (result != 0 && errno == EINTR &&
9917 !(async_err = PyErr_CheckSignals()));
9918 if (result != 0)
9919 return (!async_err) ? posix_error() : NULL;
Larry Hastings2f936352014-08-05 14:04:04 +10009920 Py_RETURN_NONE;
9921}
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009922#endif /* HAVE_FTRUNCATE || MS_WINDOWS */
Larry Hastings2f936352014-08-05 14:04:04 +10009923
9924
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009925#if defined HAVE_TRUNCATE || defined MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10009926/*[clinic input]
9927os.truncate
9928 path: path_t(allow_fd='PATH_HAVE_FTRUNCATE')
9929 length: Py_off_t
9930
9931Truncate a file, specified by path, to a specific length.
9932
9933On some platforms, path may also be specified as an open file descriptor.
9934 If this functionality is unavailable, using it raises an exception.
9935[clinic start generated code]*/
9936
Larry Hastings2f936352014-08-05 14:04:04 +10009937static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009938os_truncate_impl(PyObject *module, path_t *path, Py_off_t length)
9939/*[clinic end generated code: output=43009c8df5c0a12b input=77229cf0b50a9b77]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009940{
9941 int result;
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009942#ifdef MS_WINDOWS
9943 int fd;
9944#endif
9945
9946 if (path->fd != -1)
9947 return os_ftruncate_impl(module, path->fd, length);
Larry Hastings2f936352014-08-05 14:04:04 +10009948
Steve Dowerb82e17e2019-05-23 08:45:22 -07009949 if (PySys_Audit("os.truncate", "On", path->object, length) < 0) {
9950 return NULL;
9951 }
9952
Larry Hastings2f936352014-08-05 14:04:04 +10009953 Py_BEGIN_ALLOW_THREADS
Steve Dowera1c7e722015-04-12 00:26:43 -04009954 _Py_BEGIN_SUPPRESS_IPH
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009955#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07009956 fd = _wopen(path->wide, _O_WRONLY | _O_BINARY | _O_NOINHERIT);
Victor Stinnercc0bbbc2015-04-25 00:21:52 +02009957 if (fd < 0)
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009958 result = -1;
9959 else {
9960 result = _chsize_s(fd, length);
9961 close(fd);
9962 if (result < 0)
9963 errno = result;
9964 }
9965#else
9966 result = truncate(path->narrow, length);
Larry Hastings2f936352014-08-05 14:04:04 +10009967#endif
Steve Dowera1c7e722015-04-12 00:26:43 -04009968 _Py_END_SUPPRESS_IPH
Larry Hastings2f936352014-08-05 14:04:04 +10009969 Py_END_ALLOW_THREADS
9970 if (result < 0)
Alexey Izbyshev83460312018-10-20 03:28:22 +03009971 return posix_path_error(path);
Larry Hastings2f936352014-08-05 14:04:04 +10009972
9973 Py_RETURN_NONE;
9974}
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009975#endif /* HAVE_TRUNCATE || MS_WINDOWS */
Larry Hastings2f936352014-08-05 14:04:04 +10009976
Ross Lagerwall7807c352011-03-17 20:20:30 +02009977
Victor Stinnerd6b17692014-09-30 12:20:05 +02009978/* Issue #22396: On 32-bit AIX platform, the prototypes of os.posix_fadvise()
9979 and os.posix_fallocate() in system headers are wrong if _LARGE_FILES is
9980 defined, which is the case in Python on AIX. AIX bug report:
9981 http://www-01.ibm.com/support/docview.wss?uid=isg1IV56170 */
9982#if defined(_AIX) && defined(_LARGE_FILES) && !defined(__64BIT__)
9983# define POSIX_FADVISE_AIX_BUG
9984#endif
9985
Victor Stinnerec39e262014-09-30 12:35:58 +02009986
Victor Stinnerd6b17692014-09-30 12:20:05 +02009987#if defined(HAVE_POSIX_FALLOCATE) && !defined(POSIX_FADVISE_AIX_BUG)
Larry Hastings2f936352014-08-05 14:04:04 +10009988/*[clinic input]
9989os.posix_fallocate
9990
9991 fd: int
9992 offset: Py_off_t
9993 length: Py_off_t
9994 /
9995
9996Ensure a file has allocated at least a particular number of bytes on disk.
9997
9998Ensure that the file specified by fd encompasses a range of bytes
9999starting at offset bytes from the beginning and continuing for length bytes.
10000[clinic start generated code]*/
10001
Larry Hastings2f936352014-08-05 14:04:04 +100010002static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010003os_posix_fallocate_impl(PyObject *module, int fd, Py_off_t offset,
Larry Hastings89964c42015-04-14 18:07:59 -040010004 Py_off_t length)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010005/*[clinic end generated code: output=73f107139564aa9d input=d7a2ef0ab2ca52fb]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010006{
10007 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010008 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +020010009
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010010 do {
10011 Py_BEGIN_ALLOW_THREADS
10012 result = posix_fallocate(fd, offset, length);
10013 Py_END_ALLOW_THREADS
Коренберг Маркd4b93e22017-08-14 18:55:16 +050010014 } while (result == EINTR && !(async_err = PyErr_CheckSignals()));
10015
10016 if (result == 0)
10017 Py_RETURN_NONE;
10018
10019 if (async_err)
10020 return NULL;
10021
10022 errno = result;
10023 return posix_error();
Ross Lagerwall7807c352011-03-17 20:20:30 +020010024}
Victor Stinnerec39e262014-09-30 12:35:58 +020010025#endif /* HAVE_POSIX_FALLOCATE) && !POSIX_FADVISE_AIX_BUG */
Larry Hastings2f936352014-08-05 14:04:04 +100010026
Ross Lagerwall7807c352011-03-17 20:20:30 +020010027
Victor Stinnerd6b17692014-09-30 12:20:05 +020010028#if defined(HAVE_POSIX_FADVISE) && !defined(POSIX_FADVISE_AIX_BUG)
Larry Hastings2f936352014-08-05 14:04:04 +100010029/*[clinic input]
10030os.posix_fadvise
10031
10032 fd: int
10033 offset: Py_off_t
10034 length: Py_off_t
10035 advice: int
10036 /
10037
10038Announce an intention to access data in a specific pattern.
10039
10040Announce an intention to access data in a specific pattern, thus allowing
10041the kernel to make optimizations.
10042The advice applies to the region of the file specified by fd starting at
10043offset and continuing for length bytes.
10044advice is one of POSIX_FADV_NORMAL, POSIX_FADV_SEQUENTIAL,
10045POSIX_FADV_RANDOM, POSIX_FADV_NOREUSE, POSIX_FADV_WILLNEED, or
10046POSIX_FADV_DONTNEED.
10047[clinic start generated code]*/
10048
Larry Hastings2f936352014-08-05 14:04:04 +100010049static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010050os_posix_fadvise_impl(PyObject *module, int fd, Py_off_t offset,
Larry Hastings89964c42015-04-14 18:07:59 -040010051 Py_off_t length, int advice)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010052/*[clinic end generated code: output=412ef4aa70c98642 input=0fbe554edc2f04b5]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010053{
10054 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010055 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +020010056
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010057 do {
10058 Py_BEGIN_ALLOW_THREADS
10059 result = posix_fadvise(fd, offset, length, advice);
10060 Py_END_ALLOW_THREADS
Коренберг Маркd4b93e22017-08-14 18:55:16 +050010061 } while (result == EINTR && !(async_err = PyErr_CheckSignals()));
10062
10063 if (result == 0)
10064 Py_RETURN_NONE;
10065
10066 if (async_err)
10067 return NULL;
10068
10069 errno = result;
10070 return posix_error();
Ross Lagerwall7807c352011-03-17 20:20:30 +020010071}
Victor Stinnerec39e262014-09-30 12:35:58 +020010072#endif /* HAVE_POSIX_FADVISE && !POSIX_FADVISE_AIX_BUG */
Ross Lagerwall7807c352011-03-17 20:20:30 +020010073
Guido van Rossumf1af3fe1996-07-23 19:18:10 +000010074#ifdef HAVE_PUTENV
Guido van Rossumec4f4ac1997-06-02 22:20:51 +000010075
Fred Drake762e2061999-08-26 17:23:54 +000010076/* Save putenv() parameters as values here, so we can collect them when they
10077 * get re-set with another call for the same key. */
10078static PyObject *posix_putenv_garbage;
10079
Larry Hastings2f936352014-08-05 14:04:04 +100010080static void
10081posix_putenv_garbage_setitem(PyObject *name, PyObject *value)
Guido van Rossumf1af3fe1996-07-23 19:18:10 +000010082{
Larry Hastings2f936352014-08-05 14:04:04 +100010083 /* Install the first arg and newstr in posix_putenv_garbage;
10084 * this will cause previous value to be collected. This has to
10085 * happen after the real putenv() call because the old value
10086 * was still accessible until then. */
10087 if (PyDict_SetItem(posix_putenv_garbage, name, value))
10088 /* really not much we can do; just leak */
10089 PyErr_Clear();
10090 else
10091 Py_DECREF(value);
10092}
10093
10094
Thomas Hellerf78f12a2007-11-08 19:33:05 +000010095#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +100010096/*[clinic input]
10097os.putenv
10098
10099 name: unicode
10100 value: unicode
10101 /
10102
10103Change or add an environment variable.
10104[clinic start generated code]*/
10105
Larry Hastings2f936352014-08-05 14:04:04 +100010106static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010107os_putenv_impl(PyObject *module, PyObject *name, PyObject *value)
10108/*[clinic end generated code: output=d29a567d6b2327d2 input=ba586581c2e6105f]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010109{
Serhiy Storchakadeab18d2016-05-07 16:45:18 +030010110 const wchar_t *env;
Serhiy Storchakaf7eae0a2017-06-28 08:30:06 +030010111 Py_ssize_t size;
Larry Hastings2f936352014-08-05 14:04:04 +100010112
Serhiy Storchaka77703942017-06-25 07:33:01 +030010113 /* Search from index 1 because on Windows starting '=' is allowed for
10114 defining hidden environment variables. */
10115 if (PyUnicode_GET_LENGTH(name) == 0 ||
10116 PyUnicode_FindChar(name, '=', 1, PyUnicode_GET_LENGTH(name), 1) != -1)
10117 {
10118 PyErr_SetString(PyExc_ValueError, "illegal environment variable name");
10119 return NULL;
10120 }
Larry Hastings2f936352014-08-05 14:04:04 +100010121 PyObject *unicode = PyUnicode_FromFormat("%U=%U", name, value);
10122 if (unicode == NULL) {
Larry Hastings2f936352014-08-05 14:04:04 +100010123 return NULL;
Victor Stinner84ae1182010-05-06 22:05:07 +000010124 }
Serhiy Storchakaf7eae0a2017-06-28 08:30:06 +030010125
10126 env = PyUnicode_AsUnicodeAndSize(unicode, &size);
10127 if (env == NULL)
10128 goto error;
10129 if (size > _MAX_ENV) {
Victor Stinner65170952011-11-22 22:16:17 +010010130 PyErr_Format(PyExc_ValueError,
10131 "the environment variable is longer than %u characters",
10132 _MAX_ENV);
10133 goto error;
10134 }
Serhiy Storchakaf7eae0a2017-06-28 08:30:06 +030010135 if (wcslen(env) != (size_t)size) {
10136 PyErr_SetString(PyExc_ValueError, "embedded null character");
Victor Stinnereb5657a2011-09-30 01:44:27 +020010137 goto error;
Serhiy Storchakaf7eae0a2017-06-28 08:30:06 +030010138 }
10139
Larry Hastings2f936352014-08-05 14:04:04 +100010140 if (_wputenv(env)) {
Victor Stinner8c62be82010-05-06 00:08:46 +000010141 posix_error();
Victor Stinner84ae1182010-05-06 22:05:07 +000010142 goto error;
Victor Stinner8c62be82010-05-06 00:08:46 +000010143 }
Guido van Rossumf1af3fe1996-07-23 19:18:10 +000010144
Larry Hastings2f936352014-08-05 14:04:04 +100010145 posix_putenv_garbage_setitem(name, unicode);
Victor Stinner84ae1182010-05-06 22:05:07 +000010146 Py_RETURN_NONE;
10147
10148error:
Larry Hastings2f936352014-08-05 14:04:04 +100010149 Py_DECREF(unicode);
Victor Stinner84ae1182010-05-06 22:05:07 +000010150 return NULL;
Guido van Rossumf1af3fe1996-07-23 19:18:10 +000010151}
Larry Hastings2f936352014-08-05 14:04:04 +100010152#else /* MS_WINDOWS */
10153/*[clinic input]
10154os.putenv
Guido van Rossumb6a47161997-09-15 22:54:34 +000010155
Larry Hastings2f936352014-08-05 14:04:04 +100010156 name: FSConverter
10157 value: FSConverter
10158 /
10159
10160Change or add an environment variable.
10161[clinic start generated code]*/
10162
Larry Hastings2f936352014-08-05 14:04:04 +100010163static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010164os_putenv_impl(PyObject *module, PyObject *name, PyObject *value)
10165/*[clinic end generated code: output=d29a567d6b2327d2 input=a97bc6152f688d31]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010166{
10167 PyObject *bytes = NULL;
10168 char *env;
Serhiy Storchaka77703942017-06-25 07:33:01 +030010169 const char *name_string = PyBytes_AS_STRING(name);
10170 const char *value_string = PyBytes_AS_STRING(value);
Larry Hastings2f936352014-08-05 14:04:04 +100010171
Serhiy Storchaka77703942017-06-25 07:33:01 +030010172 if (strchr(name_string, '=') != NULL) {
10173 PyErr_SetString(PyExc_ValueError, "illegal environment variable name");
10174 return NULL;
10175 }
Steve Dowera00b5be2020-02-13 08:30:27 +000010176 if (PySys_Audit("os.putenv", "OO", name, value) < 0) {
10177 return NULL;
10178 }
Larry Hastings2f936352014-08-05 14:04:04 +100010179 bytes = PyBytes_FromFormat("%s=%s", name_string, value_string);
10180 if (bytes == NULL) {
Larry Hastings2f936352014-08-05 14:04:04 +100010181 return NULL;
10182 }
10183
10184 env = PyBytes_AS_STRING(bytes);
10185 if (putenv(env)) {
10186 Py_DECREF(bytes);
10187 return posix_error();
10188 }
10189
10190 posix_putenv_garbage_setitem(name, bytes);
10191 Py_RETURN_NONE;
10192}
10193#endif /* MS_WINDOWS */
10194#endif /* HAVE_PUTENV */
10195
10196
10197#ifdef HAVE_UNSETENV
10198/*[clinic input]
10199os.unsetenv
10200 name: FSConverter
10201 /
10202
10203Delete an environment variable.
10204[clinic start generated code]*/
10205
Larry Hastings2f936352014-08-05 14:04:04 +100010206static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010207os_unsetenv_impl(PyObject *module, PyObject *name)
10208/*[clinic end generated code: output=54c4137ab1834f02 input=2bb5288a599c7107]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010209{
Victor Stinner984890f2011-11-24 13:53:38 +010010210#ifndef HAVE_BROKEN_UNSETENV
Victor Stinner60b385e2011-11-22 22:01:28 +010010211 int err;
Victor Stinner984890f2011-11-24 13:53:38 +010010212#endif
Victor Stinner84ae1182010-05-06 22:05:07 +000010213
Steve Dowera00b5be2020-02-13 08:30:27 +000010214 if (PySys_Audit("os.unsetenv", "(O)", name) < 0) {
10215 return NULL;
10216 }
10217
Victor Stinner984890f2011-11-24 13:53:38 +010010218#ifdef HAVE_BROKEN_UNSETENV
10219 unsetenv(PyBytes_AS_STRING(name));
10220#else
Victor Stinner65170952011-11-22 22:16:17 +010010221 err = unsetenv(PyBytes_AS_STRING(name));
Larry Hastings2f936352014-08-05 14:04:04 +100010222 if (err)
Victor Stinner60b385e2011-11-22 22:01:28 +010010223 return posix_error();
Victor Stinner984890f2011-11-24 13:53:38 +010010224#endif
Guido van Rossumc524d952001-10-19 01:31:59 +000010225
Victor Stinner8c62be82010-05-06 00:08:46 +000010226 /* Remove the key from posix_putenv_garbage;
10227 * this will cause it to be collected. This has to
10228 * happen after the real unsetenv() call because the
10229 * old value was still accessible until then.
10230 */
Victor Stinner65170952011-11-22 22:16:17 +010010231 if (PyDict_DelItem(posix_putenv_garbage, name)) {
Victor Stinner8c62be82010-05-06 00:08:46 +000010232 /* really not much we can do; just leak */
Serhiy Storchakaa24107b2019-02-25 17:59:46 +020010233 if (!PyErr_ExceptionMatches(PyExc_KeyError)) {
10234 return NULL;
10235 }
Victor Stinner8c62be82010-05-06 00:08:46 +000010236 PyErr_Clear();
10237 }
Victor Stinner84ae1182010-05-06 22:05:07 +000010238 Py_RETURN_NONE;
Guido van Rossumc524d952001-10-19 01:31:59 +000010239}
Larry Hastings2f936352014-08-05 14:04:04 +100010240#endif /* HAVE_UNSETENV */
Guido van Rossumc524d952001-10-19 01:31:59 +000010241
Larry Hastings2f936352014-08-05 14:04:04 +100010242
10243/*[clinic input]
10244os.strerror
10245
10246 code: int
10247 /
10248
10249Translate an error code to a message string.
10250[clinic start generated code]*/
10251
Larry Hastings2f936352014-08-05 14:04:04 +100010252static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010253os_strerror_impl(PyObject *module, int code)
10254/*[clinic end generated code: output=baebf09fa02a78f2 input=75a8673d97915a91]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010255{
10256 char *message = strerror(code);
Victor Stinner8c62be82010-05-06 00:08:46 +000010257 if (message == NULL) {
10258 PyErr_SetString(PyExc_ValueError,
10259 "strerror() argument out of range");
10260 return NULL;
10261 }
Victor Stinner1b579672011-12-17 05:47:23 +010010262 return PyUnicode_DecodeLocale(message, "surrogateescape");
Guido van Rossumb6a47161997-09-15 22:54:34 +000010263}
Guido van Rossumb6a47161997-09-15 22:54:34 +000010264
Guido van Rossumf1af3fe1996-07-23 19:18:10 +000010265
Guido van Rossumc9641791998-08-04 15:26:23 +000010266#ifdef HAVE_SYS_WAIT_H
Fred Drake106c1a02002-04-23 15:58:02 +000010267#ifdef WCOREDUMP
Larry Hastings2f936352014-08-05 14:04:04 +100010268/*[clinic input]
10269os.WCOREDUMP -> bool
10270
10271 status: int
10272 /
10273
10274Return True if the process returning status was dumped to a core file.
10275[clinic start generated code]*/
10276
Larry Hastings2f936352014-08-05 14:04:04 +100010277static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010278os_WCOREDUMP_impl(PyObject *module, int status)
10279/*[clinic end generated code: output=1a584b147b16bd18 input=8b05e7ab38528d04]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010280{
10281 WAIT_TYPE wait_status;
10282 WAIT_STATUS_INT(wait_status) = status;
10283 return WCOREDUMP(wait_status);
Fred Drake106c1a02002-04-23 15:58:02 +000010284}
10285#endif /* WCOREDUMP */
10286
Larry Hastings2f936352014-08-05 14:04:04 +100010287
Fred Drake106c1a02002-04-23 15:58:02 +000010288#ifdef WIFCONTINUED
Larry Hastings2f936352014-08-05 14:04:04 +100010289/*[clinic input]
10290os.WIFCONTINUED -> bool
10291
10292 status: int
10293
10294Return True if a particular process was continued from a job control stop.
10295
10296Return True if the process returning status was continued from a
10297job control stop.
10298[clinic start generated code]*/
10299
Larry Hastings2f936352014-08-05 14:04:04 +100010300static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010301os_WIFCONTINUED_impl(PyObject *module, int status)
10302/*[clinic end generated code: output=1e35295d844364bd input=e777e7d38eb25bd9]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010303{
10304 WAIT_TYPE wait_status;
10305 WAIT_STATUS_INT(wait_status) = status;
10306 return WIFCONTINUED(wait_status);
Fred Drake106c1a02002-04-23 15:58:02 +000010307}
10308#endif /* WIFCONTINUED */
10309
Larry Hastings2f936352014-08-05 14:04:04 +100010310
Guido van Rossumc9641791998-08-04 15:26:23 +000010311#ifdef WIFSTOPPED
Larry Hastings2f936352014-08-05 14:04:04 +100010312/*[clinic input]
10313os.WIFSTOPPED -> bool
10314
10315 status: int
10316
10317Return True if the process returning status was stopped.
10318[clinic start generated code]*/
10319
Larry Hastings2f936352014-08-05 14:04:04 +100010320static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010321os_WIFSTOPPED_impl(PyObject *module, int status)
10322/*[clinic end generated code: output=fdb57122a5c9b4cb input=043cb7f1289ef904]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010323{
10324 WAIT_TYPE wait_status;
10325 WAIT_STATUS_INT(wait_status) = status;
10326 return WIFSTOPPED(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +000010327}
10328#endif /* WIFSTOPPED */
10329
Larry Hastings2f936352014-08-05 14:04:04 +100010330
Guido van Rossumc9641791998-08-04 15:26:23 +000010331#ifdef WIFSIGNALED
Larry Hastings2f936352014-08-05 14:04:04 +100010332/*[clinic input]
10333os.WIFSIGNALED -> bool
10334
10335 status: int
10336
10337Return True if the process returning status was terminated by a signal.
10338[clinic start generated code]*/
10339
Larry Hastings2f936352014-08-05 14:04:04 +100010340static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010341os_WIFSIGNALED_impl(PyObject *module, int status)
10342/*[clinic end generated code: output=d1dde4dcc819a5f5 input=d55ba7cc9ce5dc43]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010343{
10344 WAIT_TYPE wait_status;
10345 WAIT_STATUS_INT(wait_status) = status;
10346 return WIFSIGNALED(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +000010347}
10348#endif /* WIFSIGNALED */
10349
Larry Hastings2f936352014-08-05 14:04:04 +100010350
Guido van Rossumc9641791998-08-04 15:26:23 +000010351#ifdef WIFEXITED
Larry Hastings2f936352014-08-05 14:04:04 +100010352/*[clinic input]
10353os.WIFEXITED -> bool
10354
10355 status: int
10356
10357Return True if the process returning status exited via the exit() system call.
10358[clinic start generated code]*/
10359
Larry Hastings2f936352014-08-05 14:04:04 +100010360static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010361os_WIFEXITED_impl(PyObject *module, int status)
10362/*[clinic end generated code: output=01c09d6ebfeea397 input=d63775a6791586c0]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010363{
10364 WAIT_TYPE wait_status;
10365 WAIT_STATUS_INT(wait_status) = status;
10366 return WIFEXITED(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +000010367}
10368#endif /* WIFEXITED */
10369
Larry Hastings2f936352014-08-05 14:04:04 +100010370
Guido van Rossum54ecc3d1999-01-27 17:53:11 +000010371#ifdef WEXITSTATUS
Larry Hastings2f936352014-08-05 14:04:04 +100010372/*[clinic input]
10373os.WEXITSTATUS -> int
10374
10375 status: int
10376
10377Return the process return code from status.
10378[clinic start generated code]*/
10379
Larry Hastings2f936352014-08-05 14:04:04 +100010380static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010381os_WEXITSTATUS_impl(PyObject *module, int status)
10382/*[clinic end generated code: output=6e3efbba11f6488d input=e1fb4944e377585b]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010383{
10384 WAIT_TYPE wait_status;
10385 WAIT_STATUS_INT(wait_status) = status;
10386 return WEXITSTATUS(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +000010387}
10388#endif /* WEXITSTATUS */
10389
Larry Hastings2f936352014-08-05 14:04:04 +100010390
Guido van Rossumc9641791998-08-04 15:26:23 +000010391#ifdef WTERMSIG
Larry Hastings2f936352014-08-05 14:04:04 +100010392/*[clinic input]
10393os.WTERMSIG -> int
10394
10395 status: int
10396
10397Return the signal that terminated the process that provided the status value.
10398[clinic start generated code]*/
10399
Larry Hastings2f936352014-08-05 14:04:04 +100010400static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010401os_WTERMSIG_impl(PyObject *module, int status)
10402/*[clinic end generated code: output=172f7dfc8dcfc3ad input=727fd7f84ec3f243]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010403{
10404 WAIT_TYPE wait_status;
10405 WAIT_STATUS_INT(wait_status) = status;
10406 return WTERMSIG(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +000010407}
10408#endif /* WTERMSIG */
10409
Larry Hastings2f936352014-08-05 14:04:04 +100010410
Guido van Rossumc9641791998-08-04 15:26:23 +000010411#ifdef WSTOPSIG
Larry Hastings2f936352014-08-05 14:04:04 +100010412/*[clinic input]
10413os.WSTOPSIG -> int
10414
10415 status: int
10416
10417Return the signal that stopped the process that provided the status value.
10418[clinic start generated code]*/
10419
Larry Hastings2f936352014-08-05 14:04:04 +100010420static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010421os_WSTOPSIG_impl(PyObject *module, int status)
10422/*[clinic end generated code: output=0ab7586396f5d82b input=46ebf1d1b293c5c1]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010423{
10424 WAIT_TYPE wait_status;
10425 WAIT_STATUS_INT(wait_status) = status;
10426 return WSTOPSIG(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +000010427}
10428#endif /* WSTOPSIG */
Guido van Rossumc9641791998-08-04 15:26:23 +000010429#endif /* HAVE_SYS_WAIT_H */
10430
10431
Thomas Wouters477c8d52006-05-27 19:21:47 +000010432#if defined(HAVE_FSTATVFS) && defined(HAVE_SYS_STATVFS_H)
Guido van Rossumd5753e11999-10-19 13:29:23 +000010433#ifdef _SCO_DS
10434/* SCO OpenServer 5.0 and later requires _SVID3 before it reveals the
10435 needed definitions in sys/statvfs.h */
10436#define _SVID3
10437#endif
Guido van Rossum94f6f721999-01-06 18:42:14 +000010438#include <sys/statvfs.h>
10439
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010440static PyObject*
10441_pystatvfs_fromstructstatvfs(struct statvfs st) {
Eddie Elizondo474eedf2018-11-13 04:09:31 -080010442 PyObject *v = PyStructSequence_New(StatVFSResultType);
Victor Stinner8c62be82010-05-06 00:08:46 +000010443 if (v == NULL)
10444 return NULL;
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010445
10446#if !defined(HAVE_LARGEFILE_SUPPORT)
Victor Stinner8c62be82010-05-06 00:08:46 +000010447 PyStructSequence_SET_ITEM(v, 0, PyLong_FromLong((long) st.f_bsize));
10448 PyStructSequence_SET_ITEM(v, 1, PyLong_FromLong((long) st.f_frsize));
10449 PyStructSequence_SET_ITEM(v, 2, PyLong_FromLong((long) st.f_blocks));
10450 PyStructSequence_SET_ITEM(v, 3, PyLong_FromLong((long) st.f_bfree));
10451 PyStructSequence_SET_ITEM(v, 4, PyLong_FromLong((long) st.f_bavail));
10452 PyStructSequence_SET_ITEM(v, 5, PyLong_FromLong((long) st.f_files));
10453 PyStructSequence_SET_ITEM(v, 6, PyLong_FromLong((long) st.f_ffree));
10454 PyStructSequence_SET_ITEM(v, 7, PyLong_FromLong((long) st.f_favail));
10455 PyStructSequence_SET_ITEM(v, 8, PyLong_FromLong((long) st.f_flag));
10456 PyStructSequence_SET_ITEM(v, 9, PyLong_FromLong((long) st.f_namemax));
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010457#else
Victor Stinner8c62be82010-05-06 00:08:46 +000010458 PyStructSequence_SET_ITEM(v, 0, PyLong_FromLong((long) st.f_bsize));
10459 PyStructSequence_SET_ITEM(v, 1, PyLong_FromLong((long) st.f_frsize));
10460 PyStructSequence_SET_ITEM(v, 2,
Benjamin Petersonaf580df2016-09-06 10:46:49 -070010461 PyLong_FromLongLong((long long) st.f_blocks));
Victor Stinner8c62be82010-05-06 00:08:46 +000010462 PyStructSequence_SET_ITEM(v, 3,
Benjamin Petersonaf580df2016-09-06 10:46:49 -070010463 PyLong_FromLongLong((long long) st.f_bfree));
Victor Stinner8c62be82010-05-06 00:08:46 +000010464 PyStructSequence_SET_ITEM(v, 4,
Benjamin Petersonaf580df2016-09-06 10:46:49 -070010465 PyLong_FromLongLong((long long) st.f_bavail));
Victor Stinner8c62be82010-05-06 00:08:46 +000010466 PyStructSequence_SET_ITEM(v, 5,
Benjamin Petersonaf580df2016-09-06 10:46:49 -070010467 PyLong_FromLongLong((long long) st.f_files));
Victor Stinner8c62be82010-05-06 00:08:46 +000010468 PyStructSequence_SET_ITEM(v, 6,
Benjamin Petersonaf580df2016-09-06 10:46:49 -070010469 PyLong_FromLongLong((long long) st.f_ffree));
Victor Stinner8c62be82010-05-06 00:08:46 +000010470 PyStructSequence_SET_ITEM(v, 7,
Benjamin Petersonaf580df2016-09-06 10:46:49 -070010471 PyLong_FromLongLong((long long) st.f_favail));
Victor Stinner8c62be82010-05-06 00:08:46 +000010472 PyStructSequence_SET_ITEM(v, 8, PyLong_FromLong((long) st.f_flag));
10473 PyStructSequence_SET_ITEM(v, 9, PyLong_FromLong((long) st.f_namemax));
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010474#endif
Michael Felt502d5512018-01-05 13:01:58 +010010475/* The _ALL_SOURCE feature test macro defines f_fsid as a structure
10476 * (issue #32390). */
10477#if defined(_AIX) && defined(_ALL_SOURCE)
10478 PyStructSequence_SET_ITEM(v, 10, PyLong_FromUnsignedLong(st.f_fsid.val[0]));
10479#else
Giuseppe Scrivano96a5e502017-12-14 23:46:46 +010010480 PyStructSequence_SET_ITEM(v, 10, PyLong_FromUnsignedLong(st.f_fsid));
Michael Felt502d5512018-01-05 13:01:58 +010010481#endif
Victor Stinnerf0a7bac2013-10-30 18:55:24 +010010482 if (PyErr_Occurred()) {
10483 Py_DECREF(v);
10484 return NULL;
10485 }
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010486
Victor Stinner8c62be82010-05-06 00:08:46 +000010487 return v;
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010488}
10489
Larry Hastings2f936352014-08-05 14:04:04 +100010490
10491/*[clinic input]
10492os.fstatvfs
10493 fd: int
10494 /
10495
10496Perform an fstatvfs system call on the given fd.
10497
10498Equivalent to statvfs(fd).
10499[clinic start generated code]*/
10500
Larry Hastings2f936352014-08-05 14:04:04 +100010501static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010502os_fstatvfs_impl(PyObject *module, int fd)
10503/*[clinic end generated code: output=53547cf0cc55e6c5 input=d8122243ac50975e]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010504{
10505 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010506 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +000010507 struct statvfs st;
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010508
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010509 do {
10510 Py_BEGIN_ALLOW_THREADS
10511 result = fstatvfs(fd, &st);
10512 Py_END_ALLOW_THREADS
10513 } while (result != 0 && errno == EINTR &&
10514 !(async_err = PyErr_CheckSignals()));
Larry Hastings2f936352014-08-05 14:04:04 +100010515 if (result != 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010516 return (!async_err) ? posix_error() : NULL;
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010517
Victor Stinner8c62be82010-05-06 00:08:46 +000010518 return _pystatvfs_fromstructstatvfs(st);
Guido van Rossum94f6f721999-01-06 18:42:14 +000010519}
Larry Hastings2f936352014-08-05 14:04:04 +100010520#endif /* defined(HAVE_FSTATVFS) && defined(HAVE_SYS_STATVFS_H) */
Guido van Rossum94f6f721999-01-06 18:42:14 +000010521
10522
Thomas Wouters477c8d52006-05-27 19:21:47 +000010523#if defined(HAVE_STATVFS) && defined(HAVE_SYS_STATVFS_H)
Guido van Rossum94f6f721999-01-06 18:42:14 +000010524#include <sys/statvfs.h>
Larry Hastings2f936352014-08-05 14:04:04 +100010525/*[clinic input]
10526os.statvfs
Guido van Rossum94f6f721999-01-06 18:42:14 +000010527
Larry Hastings2f936352014-08-05 14:04:04 +100010528 path: path_t(allow_fd='PATH_HAVE_FSTATVFS')
10529
10530Perform a statvfs system call on the given path.
10531
10532path may always be specified as a string.
10533On some platforms, path may also be specified as an open file descriptor.
10534 If this functionality is unavailable, using it raises an exception.
10535[clinic start generated code]*/
10536
Larry Hastings2f936352014-08-05 14:04:04 +100010537static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010538os_statvfs_impl(PyObject *module, path_t *path)
10539/*[clinic end generated code: output=87106dd1beb8556e input=3f5c35791c669bd9]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010540{
10541 int result;
10542 struct statvfs st;
Larry Hastings9cf065c2012-06-22 16:30:09 -070010543
10544 Py_BEGIN_ALLOW_THREADS
10545#ifdef HAVE_FSTATVFS
Larry Hastings2f936352014-08-05 14:04:04 +100010546 if (path->fd != -1) {
Larry Hastings9cf065c2012-06-22 16:30:09 -070010547#ifdef __APPLE__
10548 /* handle weak-linking on Mac OS X 10.3 */
10549 if (fstatvfs == NULL) {
Larry Hastings2f936352014-08-05 14:04:04 +100010550 fd_specified("statvfs", path->fd);
10551 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070010552 }
10553#endif
Larry Hastings2f936352014-08-05 14:04:04 +100010554 result = fstatvfs(path->fd, &st);
Larry Hastings9cf065c2012-06-22 16:30:09 -070010555 }
10556 else
10557#endif
Larry Hastings2f936352014-08-05 14:04:04 +100010558 result = statvfs(path->narrow, &st);
Larry Hastings9cf065c2012-06-22 16:30:09 -070010559 Py_END_ALLOW_THREADS
10560
10561 if (result) {
Larry Hastings2f936352014-08-05 14:04:04 +100010562 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -070010563 }
10564
Larry Hastings2f936352014-08-05 14:04:04 +100010565 return _pystatvfs_fromstructstatvfs(st);
Guido van Rossum94f6f721999-01-06 18:42:14 +000010566}
Larry Hastings2f936352014-08-05 14:04:04 +100010567#endif /* defined(HAVE_STATVFS) && defined(HAVE_SYS_STATVFS_H) */
10568
Guido van Rossum94f6f721999-01-06 18:42:14 +000010569
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010570#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +100010571/*[clinic input]
10572os._getdiskusage
10573
Steve Dower23ad6d02018-02-22 10:39:10 -080010574 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +100010575
10576Return disk usage statistics about the given path as a (total, free) tuple.
10577[clinic start generated code]*/
10578
Larry Hastings2f936352014-08-05 14:04:04 +100010579static PyObject *
Steve Dower23ad6d02018-02-22 10:39:10 -080010580os__getdiskusage_impl(PyObject *module, path_t *path)
10581/*[clinic end generated code: output=3bd3991f5e5c5dfb input=6af8d1b7781cc042]*/
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010582{
10583 BOOL retval;
10584 ULARGE_INTEGER _, total, free;
Joe Pamerc8c02492018-09-25 10:57:36 -040010585 DWORD err = 0;
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010586
10587 Py_BEGIN_ALLOW_THREADS
Steve Dower23ad6d02018-02-22 10:39:10 -080010588 retval = GetDiskFreeSpaceExW(path->wide, &_, &total, &free);
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010589 Py_END_ALLOW_THREADS
Joe Pamerc8c02492018-09-25 10:57:36 -040010590 if (retval == 0) {
10591 if (GetLastError() == ERROR_DIRECTORY) {
10592 wchar_t *dir_path = NULL;
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010593
Joe Pamerc8c02492018-09-25 10:57:36 -040010594 dir_path = PyMem_New(wchar_t, path->length + 1);
10595 if (dir_path == NULL) {
10596 return PyErr_NoMemory();
10597 }
10598
10599 wcscpy_s(dir_path, path->length + 1, path->wide);
10600
10601 if (_dirnameW(dir_path) != -1) {
10602 Py_BEGIN_ALLOW_THREADS
10603 retval = GetDiskFreeSpaceExW(dir_path, &_, &total, &free);
10604 Py_END_ALLOW_THREADS
10605 }
10606 /* Record the last error in case it's modified by PyMem_Free. */
10607 err = GetLastError();
10608 PyMem_Free(dir_path);
10609 if (retval) {
10610 goto success;
10611 }
10612 }
10613 return PyErr_SetFromWindowsErr(err);
10614 }
10615
10616success:
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010617 return Py_BuildValue("(LL)", total.QuadPart, free.QuadPart);
10618}
Larry Hastings2f936352014-08-05 14:04:04 +100010619#endif /* MS_WINDOWS */
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010620
10621
Fred Drakec9680921999-12-13 16:37:25 +000010622/* This is used for fpathconf(), pathconf(), confstr() and sysconf().
10623 * It maps strings representing configuration variable names to
10624 * integer values, allowing those functions to be called with the
Thomas Wouters7e474022000-07-16 12:04:32 +000010625 * magic names instead of polluting the module's namespace with tons of
Fred Drake12c6e2d1999-12-14 21:25:03 +000010626 * rarely-used constants. There are three separate tables that use
10627 * these definitions.
Fred Drakebec628d1999-12-15 18:31:10 +000010628 *
10629 * This code is always included, even if none of the interfaces that
10630 * need it are included. The #if hackery needed to avoid it would be
10631 * sufficiently pervasive that it's not worth the loss of readability.
Fred Drakec9680921999-12-13 16:37:25 +000010632 */
10633struct constdef {
Serhiy Storchaka2d06e842015-12-25 19:53:18 +020010634 const char *name;
Serhiy Storchaka56f6e762015-09-06 21:25:30 +030010635 int value;
Fred Drakec9680921999-12-13 16:37:25 +000010636};
10637
Fred Drake12c6e2d1999-12-14 21:25:03 +000010638static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000010639conv_confname(PyObject *arg, int *valuep, struct constdef *table,
Guido van Rossum7d5baac2007-08-27 23:24:46 +000010640 size_t tablesize)
Fred Drake12c6e2d1999-12-14 21:25:03 +000010641{
Christian Heimes217cfd12007-12-02 14:31:20 +000010642 if (PyLong_Check(arg)) {
Serhiy Storchaka56f6e762015-09-06 21:25:30 +030010643 int value = _PyLong_AsInt(arg);
10644 if (value == -1 && PyErr_Occurred())
10645 return 0;
10646 *valuep = value;
Stefan Krah0e803b32010-11-26 16:16:47 +000010647 return 1;
Fred Drake12c6e2d1999-12-14 21:25:03 +000010648 }
Guido van Rossumbce56a62007-05-10 18:04:33 +000010649 else {
Stefan Krah0e803b32010-11-26 16:16:47 +000010650 /* look up the value in the table using a binary search */
10651 size_t lo = 0;
10652 size_t mid;
10653 size_t hi = tablesize;
10654 int cmp;
10655 const char *confname;
10656 if (!PyUnicode_Check(arg)) {
10657 PyErr_SetString(PyExc_TypeError,
10658 "configuration names must be strings or integers");
10659 return 0;
Victor Stinner8c62be82010-05-06 00:08:46 +000010660 }
Serhiy Storchaka06515832016-11-20 09:13:07 +020010661 confname = PyUnicode_AsUTF8(arg);
Stefan Krah0e803b32010-11-26 16:16:47 +000010662 if (confname == NULL)
10663 return 0;
10664 while (lo < hi) {
10665 mid = (lo + hi) / 2;
10666 cmp = strcmp(confname, table[mid].name);
10667 if (cmp < 0)
10668 hi = mid;
10669 else if (cmp > 0)
10670 lo = mid + 1;
10671 else {
10672 *valuep = table[mid].value;
10673 return 1;
10674 }
10675 }
10676 PyErr_SetString(PyExc_ValueError, "unrecognized configuration name");
10677 return 0;
Victor Stinner8c62be82010-05-06 00:08:46 +000010678 }
Fred Drake12c6e2d1999-12-14 21:25:03 +000010679}
10680
10681
10682#if defined(HAVE_FPATHCONF) || defined(HAVE_PATHCONF)
10683static struct constdef posix_constants_pathconf[] = {
Fred Draked86ed291999-12-15 15:34:33 +000010684#ifdef _PC_ABI_AIO_XFER_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010685 {"PC_ABI_AIO_XFER_MAX", _PC_ABI_AIO_XFER_MAX},
Fred Draked86ed291999-12-15 15:34:33 +000010686#endif
10687#ifdef _PC_ABI_ASYNC_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000010688 {"PC_ABI_ASYNC_IO", _PC_ABI_ASYNC_IO},
Fred Draked86ed291999-12-15 15:34:33 +000010689#endif
Fred Drakec9680921999-12-13 16:37:25 +000010690#ifdef _PC_ASYNC_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000010691 {"PC_ASYNC_IO", _PC_ASYNC_IO},
Fred Drakec9680921999-12-13 16:37:25 +000010692#endif
10693#ifdef _PC_CHOWN_RESTRICTED
Victor Stinner8c62be82010-05-06 00:08:46 +000010694 {"PC_CHOWN_RESTRICTED", _PC_CHOWN_RESTRICTED},
Fred Drakec9680921999-12-13 16:37:25 +000010695#endif
10696#ifdef _PC_FILESIZEBITS
Victor Stinner8c62be82010-05-06 00:08:46 +000010697 {"PC_FILESIZEBITS", _PC_FILESIZEBITS},
Fred Drakec9680921999-12-13 16:37:25 +000010698#endif
10699#ifdef _PC_LAST
Victor Stinner8c62be82010-05-06 00:08:46 +000010700 {"PC_LAST", _PC_LAST},
Fred Drakec9680921999-12-13 16:37:25 +000010701#endif
10702#ifdef _PC_LINK_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010703 {"PC_LINK_MAX", _PC_LINK_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010704#endif
10705#ifdef _PC_MAX_CANON
Victor Stinner8c62be82010-05-06 00:08:46 +000010706 {"PC_MAX_CANON", _PC_MAX_CANON},
Fred Drakec9680921999-12-13 16:37:25 +000010707#endif
10708#ifdef _PC_MAX_INPUT
Victor Stinner8c62be82010-05-06 00:08:46 +000010709 {"PC_MAX_INPUT", _PC_MAX_INPUT},
Fred Drakec9680921999-12-13 16:37:25 +000010710#endif
10711#ifdef _PC_NAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010712 {"PC_NAME_MAX", _PC_NAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010713#endif
10714#ifdef _PC_NO_TRUNC
Victor Stinner8c62be82010-05-06 00:08:46 +000010715 {"PC_NO_TRUNC", _PC_NO_TRUNC},
Fred Drakec9680921999-12-13 16:37:25 +000010716#endif
10717#ifdef _PC_PATH_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010718 {"PC_PATH_MAX", _PC_PATH_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010719#endif
10720#ifdef _PC_PIPE_BUF
Victor Stinner8c62be82010-05-06 00:08:46 +000010721 {"PC_PIPE_BUF", _PC_PIPE_BUF},
Fred Drakec9680921999-12-13 16:37:25 +000010722#endif
10723#ifdef _PC_PRIO_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000010724 {"PC_PRIO_IO", _PC_PRIO_IO},
Fred Drakec9680921999-12-13 16:37:25 +000010725#endif
10726#ifdef _PC_SOCK_MAXBUF
Victor Stinner8c62be82010-05-06 00:08:46 +000010727 {"PC_SOCK_MAXBUF", _PC_SOCK_MAXBUF},
Fred Drakec9680921999-12-13 16:37:25 +000010728#endif
10729#ifdef _PC_SYNC_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000010730 {"PC_SYNC_IO", _PC_SYNC_IO},
Fred Drakec9680921999-12-13 16:37:25 +000010731#endif
10732#ifdef _PC_VDISABLE
Victor Stinner8c62be82010-05-06 00:08:46 +000010733 {"PC_VDISABLE", _PC_VDISABLE},
Fred Drakec9680921999-12-13 16:37:25 +000010734#endif
Jesus Cea7e9065c2010-10-25 13:02:04 +000010735#ifdef _PC_ACL_ENABLED
10736 {"PC_ACL_ENABLED", _PC_ACL_ENABLED},
10737#endif
10738#ifdef _PC_MIN_HOLE_SIZE
10739 {"PC_MIN_HOLE_SIZE", _PC_MIN_HOLE_SIZE},
10740#endif
10741#ifdef _PC_ALLOC_SIZE_MIN
10742 {"PC_ALLOC_SIZE_MIN", _PC_ALLOC_SIZE_MIN},
10743#endif
10744#ifdef _PC_REC_INCR_XFER_SIZE
10745 {"PC_REC_INCR_XFER_SIZE", _PC_REC_INCR_XFER_SIZE},
10746#endif
10747#ifdef _PC_REC_MAX_XFER_SIZE
10748 {"PC_REC_MAX_XFER_SIZE", _PC_REC_MAX_XFER_SIZE},
10749#endif
10750#ifdef _PC_REC_MIN_XFER_SIZE
10751 {"PC_REC_MIN_XFER_SIZE", _PC_REC_MIN_XFER_SIZE},
10752#endif
10753#ifdef _PC_REC_XFER_ALIGN
10754 {"PC_REC_XFER_ALIGN", _PC_REC_XFER_ALIGN},
10755#endif
10756#ifdef _PC_SYMLINK_MAX
10757 {"PC_SYMLINK_MAX", _PC_SYMLINK_MAX},
10758#endif
10759#ifdef _PC_XATTR_ENABLED
10760 {"PC_XATTR_ENABLED", _PC_XATTR_ENABLED},
10761#endif
10762#ifdef _PC_XATTR_EXISTS
10763 {"PC_XATTR_EXISTS", _PC_XATTR_EXISTS},
10764#endif
10765#ifdef _PC_TIMESTAMP_RESOLUTION
10766 {"PC_TIMESTAMP_RESOLUTION", _PC_TIMESTAMP_RESOLUTION},
10767#endif
Fred Drakec9680921999-12-13 16:37:25 +000010768};
10769
Fred Drakec9680921999-12-13 16:37:25 +000010770static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000010771conv_path_confname(PyObject *arg, int *valuep)
Fred Drakec9680921999-12-13 16:37:25 +000010772{
10773 return conv_confname(arg, valuep, posix_constants_pathconf,
10774 sizeof(posix_constants_pathconf)
10775 / sizeof(struct constdef));
10776}
10777#endif
10778
Larry Hastings2f936352014-08-05 14:04:04 +100010779
Fred Drakec9680921999-12-13 16:37:25 +000010780#ifdef HAVE_FPATHCONF
Larry Hastings2f936352014-08-05 14:04:04 +100010781/*[clinic input]
10782os.fpathconf -> long
10783
10784 fd: int
10785 name: path_confname
10786 /
10787
10788Return the configuration limit name for the file descriptor fd.
10789
10790If there is no limit, return -1.
10791[clinic start generated code]*/
10792
Larry Hastings2f936352014-08-05 14:04:04 +100010793static long
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010794os_fpathconf_impl(PyObject *module, int fd, int name)
10795/*[clinic end generated code: output=d5b7042425fc3e21 input=5942a024d3777810]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010796{
10797 long limit;
10798
10799 errno = 0;
10800 limit = fpathconf(fd, name);
10801 if (limit == -1 && errno != 0)
10802 posix_error();
10803
10804 return limit;
10805}
10806#endif /* HAVE_FPATHCONF */
Fred Drakec9680921999-12-13 16:37:25 +000010807
10808
10809#ifdef HAVE_PATHCONF
Larry Hastings2f936352014-08-05 14:04:04 +100010810/*[clinic input]
10811os.pathconf -> long
10812 path: path_t(allow_fd='PATH_HAVE_FPATHCONF')
10813 name: path_confname
10814
10815Return the configuration limit name for the file or directory path.
10816
10817If there is no limit, return -1.
10818On some platforms, path may also be specified as an open file descriptor.
10819 If this functionality is unavailable, using it raises an exception.
10820[clinic start generated code]*/
10821
Larry Hastings2f936352014-08-05 14:04:04 +100010822static long
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010823os_pathconf_impl(PyObject *module, path_t *path, int name)
10824/*[clinic end generated code: output=5bedee35b293a089 input=bc3e2a985af27e5e]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010825{
Victor Stinner8c62be82010-05-06 00:08:46 +000010826 long limit;
Fred Drakec9680921999-12-13 16:37:25 +000010827
Victor Stinner8c62be82010-05-06 00:08:46 +000010828 errno = 0;
Georg Brandl306336b2012-06-24 12:55:33 +020010829#ifdef HAVE_FPATHCONF
Larry Hastings2f936352014-08-05 14:04:04 +100010830 if (path->fd != -1)
10831 limit = fpathconf(path->fd, name);
Georg Brandl306336b2012-06-24 12:55:33 +020010832 else
10833#endif
Larry Hastings2f936352014-08-05 14:04:04 +100010834 limit = pathconf(path->narrow, name);
Victor Stinner8c62be82010-05-06 00:08:46 +000010835 if (limit == -1 && errno != 0) {
10836 if (errno == EINVAL)
Stefan Krah99439262010-11-26 12:58:05 +000010837 /* could be a path or name problem */
10838 posix_error();
Fred Drakec9680921999-12-13 16:37:25 +000010839 else
Larry Hastings2f936352014-08-05 14:04:04 +100010840 path_error(path);
Victor Stinner8c62be82010-05-06 00:08:46 +000010841 }
Larry Hastings2f936352014-08-05 14:04:04 +100010842
10843 return limit;
Fred Drakec9680921999-12-13 16:37:25 +000010844}
Larry Hastings2f936352014-08-05 14:04:04 +100010845#endif /* HAVE_PATHCONF */
Fred Drakec9680921999-12-13 16:37:25 +000010846
10847#ifdef HAVE_CONFSTR
10848static struct constdef posix_constants_confstr[] = {
Fred Draked86ed291999-12-15 15:34:33 +000010849#ifdef _CS_ARCHITECTURE
Victor Stinner8c62be82010-05-06 00:08:46 +000010850 {"CS_ARCHITECTURE", _CS_ARCHITECTURE},
Fred Draked86ed291999-12-15 15:34:33 +000010851#endif
Mark Dickinson876d7c82010-04-16 12:47:52 +000010852#ifdef _CS_GNU_LIBC_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000010853 {"CS_GNU_LIBC_VERSION", _CS_GNU_LIBC_VERSION},
Mark Dickinson876d7c82010-04-16 12:47:52 +000010854#endif
10855#ifdef _CS_GNU_LIBPTHREAD_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000010856 {"CS_GNU_LIBPTHREAD_VERSION", _CS_GNU_LIBPTHREAD_VERSION},
Mark Dickinson876d7c82010-04-16 12:47:52 +000010857#endif
Fred Draked86ed291999-12-15 15:34:33 +000010858#ifdef _CS_HOSTNAME
Victor Stinner8c62be82010-05-06 00:08:46 +000010859 {"CS_HOSTNAME", _CS_HOSTNAME},
Fred Draked86ed291999-12-15 15:34:33 +000010860#endif
10861#ifdef _CS_HW_PROVIDER
Victor Stinner8c62be82010-05-06 00:08:46 +000010862 {"CS_HW_PROVIDER", _CS_HW_PROVIDER},
Fred Draked86ed291999-12-15 15:34:33 +000010863#endif
10864#ifdef _CS_HW_SERIAL
Victor Stinner8c62be82010-05-06 00:08:46 +000010865 {"CS_HW_SERIAL", _CS_HW_SERIAL},
Fred Draked86ed291999-12-15 15:34:33 +000010866#endif
10867#ifdef _CS_INITTAB_NAME
Victor Stinner8c62be82010-05-06 00:08:46 +000010868 {"CS_INITTAB_NAME", _CS_INITTAB_NAME},
Fred Draked86ed291999-12-15 15:34:33 +000010869#endif
Fred Drakec9680921999-12-13 16:37:25 +000010870#ifdef _CS_LFS64_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010871 {"CS_LFS64_CFLAGS", _CS_LFS64_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010872#endif
10873#ifdef _CS_LFS64_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010874 {"CS_LFS64_LDFLAGS", _CS_LFS64_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010875#endif
10876#ifdef _CS_LFS64_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000010877 {"CS_LFS64_LIBS", _CS_LFS64_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000010878#endif
10879#ifdef _CS_LFS64_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010880 {"CS_LFS64_LINTFLAGS", _CS_LFS64_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010881#endif
10882#ifdef _CS_LFS_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010883 {"CS_LFS_CFLAGS", _CS_LFS_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010884#endif
10885#ifdef _CS_LFS_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010886 {"CS_LFS_LDFLAGS", _CS_LFS_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010887#endif
10888#ifdef _CS_LFS_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000010889 {"CS_LFS_LIBS", _CS_LFS_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000010890#endif
10891#ifdef _CS_LFS_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010892 {"CS_LFS_LINTFLAGS", _CS_LFS_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010893#endif
Fred Draked86ed291999-12-15 15:34:33 +000010894#ifdef _CS_MACHINE
Victor Stinner8c62be82010-05-06 00:08:46 +000010895 {"CS_MACHINE", _CS_MACHINE},
Fred Draked86ed291999-12-15 15:34:33 +000010896#endif
Fred Drakec9680921999-12-13 16:37:25 +000010897#ifdef _CS_PATH
Victor Stinner8c62be82010-05-06 00:08:46 +000010898 {"CS_PATH", _CS_PATH},
Fred Drakec9680921999-12-13 16:37:25 +000010899#endif
Fred Draked86ed291999-12-15 15:34:33 +000010900#ifdef _CS_RELEASE
Victor Stinner8c62be82010-05-06 00:08:46 +000010901 {"CS_RELEASE", _CS_RELEASE},
Fred Draked86ed291999-12-15 15:34:33 +000010902#endif
10903#ifdef _CS_SRPC_DOMAIN
Victor Stinner8c62be82010-05-06 00:08:46 +000010904 {"CS_SRPC_DOMAIN", _CS_SRPC_DOMAIN},
Fred Draked86ed291999-12-15 15:34:33 +000010905#endif
10906#ifdef _CS_SYSNAME
Victor Stinner8c62be82010-05-06 00:08:46 +000010907 {"CS_SYSNAME", _CS_SYSNAME},
Fred Draked86ed291999-12-15 15:34:33 +000010908#endif
10909#ifdef _CS_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000010910 {"CS_VERSION", _CS_VERSION},
Fred Draked86ed291999-12-15 15:34:33 +000010911#endif
Fred Drakec9680921999-12-13 16:37:25 +000010912#ifdef _CS_XBS5_ILP32_OFF32_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010913 {"CS_XBS5_ILP32_OFF32_CFLAGS", _CS_XBS5_ILP32_OFF32_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010914#endif
10915#ifdef _CS_XBS5_ILP32_OFF32_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010916 {"CS_XBS5_ILP32_OFF32_LDFLAGS", _CS_XBS5_ILP32_OFF32_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010917#endif
10918#ifdef _CS_XBS5_ILP32_OFF32_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000010919 {"CS_XBS5_ILP32_OFF32_LIBS", _CS_XBS5_ILP32_OFF32_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000010920#endif
10921#ifdef _CS_XBS5_ILP32_OFF32_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010922 {"CS_XBS5_ILP32_OFF32_LINTFLAGS", _CS_XBS5_ILP32_OFF32_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010923#endif
10924#ifdef _CS_XBS5_ILP32_OFFBIG_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010925 {"CS_XBS5_ILP32_OFFBIG_CFLAGS", _CS_XBS5_ILP32_OFFBIG_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010926#endif
10927#ifdef _CS_XBS5_ILP32_OFFBIG_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010928 {"CS_XBS5_ILP32_OFFBIG_LDFLAGS", _CS_XBS5_ILP32_OFFBIG_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010929#endif
10930#ifdef _CS_XBS5_ILP32_OFFBIG_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000010931 {"CS_XBS5_ILP32_OFFBIG_LIBS", _CS_XBS5_ILP32_OFFBIG_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000010932#endif
10933#ifdef _CS_XBS5_ILP32_OFFBIG_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010934 {"CS_XBS5_ILP32_OFFBIG_LINTFLAGS", _CS_XBS5_ILP32_OFFBIG_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010935#endif
10936#ifdef _CS_XBS5_LP64_OFF64_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010937 {"CS_XBS5_LP64_OFF64_CFLAGS", _CS_XBS5_LP64_OFF64_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010938#endif
10939#ifdef _CS_XBS5_LP64_OFF64_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010940 {"CS_XBS5_LP64_OFF64_LDFLAGS", _CS_XBS5_LP64_OFF64_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010941#endif
10942#ifdef _CS_XBS5_LP64_OFF64_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000010943 {"CS_XBS5_LP64_OFF64_LIBS", _CS_XBS5_LP64_OFF64_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000010944#endif
10945#ifdef _CS_XBS5_LP64_OFF64_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010946 {"CS_XBS5_LP64_OFF64_LINTFLAGS", _CS_XBS5_LP64_OFF64_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010947#endif
10948#ifdef _CS_XBS5_LPBIG_OFFBIG_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010949 {"CS_XBS5_LPBIG_OFFBIG_CFLAGS", _CS_XBS5_LPBIG_OFFBIG_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010950#endif
10951#ifdef _CS_XBS5_LPBIG_OFFBIG_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010952 {"CS_XBS5_LPBIG_OFFBIG_LDFLAGS", _CS_XBS5_LPBIG_OFFBIG_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010953#endif
10954#ifdef _CS_XBS5_LPBIG_OFFBIG_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000010955 {"CS_XBS5_LPBIG_OFFBIG_LIBS", _CS_XBS5_LPBIG_OFFBIG_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000010956#endif
10957#ifdef _CS_XBS5_LPBIG_OFFBIG_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010958 {"CS_XBS5_LPBIG_OFFBIG_LINTFLAGS", _CS_XBS5_LPBIG_OFFBIG_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010959#endif
Fred Draked86ed291999-12-15 15:34:33 +000010960#ifdef _MIPS_CS_AVAIL_PROCESSORS
Victor Stinner8c62be82010-05-06 00:08:46 +000010961 {"MIPS_CS_AVAIL_PROCESSORS", _MIPS_CS_AVAIL_PROCESSORS},
Fred Draked86ed291999-12-15 15:34:33 +000010962#endif
10963#ifdef _MIPS_CS_BASE
Victor Stinner8c62be82010-05-06 00:08:46 +000010964 {"MIPS_CS_BASE", _MIPS_CS_BASE},
Fred Draked86ed291999-12-15 15:34:33 +000010965#endif
10966#ifdef _MIPS_CS_HOSTID
Victor Stinner8c62be82010-05-06 00:08:46 +000010967 {"MIPS_CS_HOSTID", _MIPS_CS_HOSTID},
Fred Draked86ed291999-12-15 15:34:33 +000010968#endif
10969#ifdef _MIPS_CS_HW_NAME
Victor Stinner8c62be82010-05-06 00:08:46 +000010970 {"MIPS_CS_HW_NAME", _MIPS_CS_HW_NAME},
Fred Draked86ed291999-12-15 15:34:33 +000010971#endif
10972#ifdef _MIPS_CS_NUM_PROCESSORS
Victor Stinner8c62be82010-05-06 00:08:46 +000010973 {"MIPS_CS_NUM_PROCESSORS", _MIPS_CS_NUM_PROCESSORS},
Fred Draked86ed291999-12-15 15:34:33 +000010974#endif
10975#ifdef _MIPS_CS_OSREL_MAJ
Victor Stinner8c62be82010-05-06 00:08:46 +000010976 {"MIPS_CS_OSREL_MAJ", _MIPS_CS_OSREL_MAJ},
Fred Draked86ed291999-12-15 15:34:33 +000010977#endif
10978#ifdef _MIPS_CS_OSREL_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000010979 {"MIPS_CS_OSREL_MIN", _MIPS_CS_OSREL_MIN},
Fred Draked86ed291999-12-15 15:34:33 +000010980#endif
10981#ifdef _MIPS_CS_OSREL_PATCH
Victor Stinner8c62be82010-05-06 00:08:46 +000010982 {"MIPS_CS_OSREL_PATCH", _MIPS_CS_OSREL_PATCH},
Fred Draked86ed291999-12-15 15:34:33 +000010983#endif
10984#ifdef _MIPS_CS_OS_NAME
Victor Stinner8c62be82010-05-06 00:08:46 +000010985 {"MIPS_CS_OS_NAME", _MIPS_CS_OS_NAME},
Fred Draked86ed291999-12-15 15:34:33 +000010986#endif
10987#ifdef _MIPS_CS_OS_PROVIDER
Victor Stinner8c62be82010-05-06 00:08:46 +000010988 {"MIPS_CS_OS_PROVIDER", _MIPS_CS_OS_PROVIDER},
Fred Draked86ed291999-12-15 15:34:33 +000010989#endif
10990#ifdef _MIPS_CS_PROCESSORS
Victor Stinner8c62be82010-05-06 00:08:46 +000010991 {"MIPS_CS_PROCESSORS", _MIPS_CS_PROCESSORS},
Fred Draked86ed291999-12-15 15:34:33 +000010992#endif
10993#ifdef _MIPS_CS_SERIAL
Victor Stinner8c62be82010-05-06 00:08:46 +000010994 {"MIPS_CS_SERIAL", _MIPS_CS_SERIAL},
Fred Draked86ed291999-12-15 15:34:33 +000010995#endif
10996#ifdef _MIPS_CS_VENDOR
Victor Stinner8c62be82010-05-06 00:08:46 +000010997 {"MIPS_CS_VENDOR", _MIPS_CS_VENDOR},
Fred Draked86ed291999-12-15 15:34:33 +000010998#endif
Fred Drakec9680921999-12-13 16:37:25 +000010999};
11000
11001static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000011002conv_confstr_confname(PyObject *arg, int *valuep)
Fred Drakec9680921999-12-13 16:37:25 +000011003{
11004 return conv_confname(arg, valuep, posix_constants_confstr,
11005 sizeof(posix_constants_confstr)
11006 / sizeof(struct constdef));
11007}
11008
Larry Hastings2f936352014-08-05 14:04:04 +100011009
11010/*[clinic input]
11011os.confstr
11012
11013 name: confstr_confname
11014 /
11015
11016Return a string-valued system configuration variable.
11017[clinic start generated code]*/
11018
Larry Hastings2f936352014-08-05 14:04:04 +100011019static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011020os_confstr_impl(PyObject *module, int name)
11021/*[clinic end generated code: output=bfb0b1b1e49b9383 input=18fb4d0567242e65]*/
Fred Drakec9680921999-12-13 16:37:25 +000011022{
11023 PyObject *result = NULL;
Victor Stinnercb043522010-09-10 23:49:04 +000011024 char buffer[255];
Victor Stinnerdd3a6a52013-06-25 23:13:47 +020011025 size_t len;
Fred Drakec9680921999-12-13 16:37:25 +000011026
Victor Stinnercb043522010-09-10 23:49:04 +000011027 errno = 0;
11028 len = confstr(name, buffer, sizeof(buffer));
11029 if (len == 0) {
11030 if (errno) {
11031 posix_error();
11032 return NULL;
Fred Drakec9680921999-12-13 16:37:25 +000011033 }
11034 else {
Victor Stinnercb043522010-09-10 23:49:04 +000011035 Py_RETURN_NONE;
Fred Drakec9680921999-12-13 16:37:25 +000011036 }
11037 }
Victor Stinnercb043522010-09-10 23:49:04 +000011038
Victor Stinnerdd3a6a52013-06-25 23:13:47 +020011039 if (len >= sizeof(buffer)) {
Victor Stinnercbc18f32014-12-05 22:51:51 +010011040 size_t len2;
Victor Stinnercb043522010-09-10 23:49:04 +000011041 char *buf = PyMem_Malloc(len);
11042 if (buf == NULL)
11043 return PyErr_NoMemory();
Victor Stinnercbc18f32014-12-05 22:51:51 +010011044 len2 = confstr(name, buf, len);
11045 assert(len == len2);
Christian Heimes8714cfd2015-04-21 10:57:41 +020011046 result = PyUnicode_DecodeFSDefaultAndSize(buf, len2-1);
Victor Stinnercb043522010-09-10 23:49:04 +000011047 PyMem_Free(buf);
11048 }
11049 else
11050 result = PyUnicode_DecodeFSDefaultAndSize(buffer, len-1);
Fred Drakec9680921999-12-13 16:37:25 +000011051 return result;
11052}
Larry Hastings2f936352014-08-05 14:04:04 +100011053#endif /* HAVE_CONFSTR */
Fred Drakec9680921999-12-13 16:37:25 +000011054
11055
11056#ifdef HAVE_SYSCONF
11057static struct constdef posix_constants_sysconf[] = {
11058#ifdef _SC_2_CHAR_TERM
Victor Stinner8c62be82010-05-06 00:08:46 +000011059 {"SC_2_CHAR_TERM", _SC_2_CHAR_TERM},
Fred Drakec9680921999-12-13 16:37:25 +000011060#endif
11061#ifdef _SC_2_C_BIND
Victor Stinner8c62be82010-05-06 00:08:46 +000011062 {"SC_2_C_BIND", _SC_2_C_BIND},
Fred Drakec9680921999-12-13 16:37:25 +000011063#endif
11064#ifdef _SC_2_C_DEV
Victor Stinner8c62be82010-05-06 00:08:46 +000011065 {"SC_2_C_DEV", _SC_2_C_DEV},
Fred Drakec9680921999-12-13 16:37:25 +000011066#endif
11067#ifdef _SC_2_C_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000011068 {"SC_2_C_VERSION", _SC_2_C_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000011069#endif
11070#ifdef _SC_2_FORT_DEV
Victor Stinner8c62be82010-05-06 00:08:46 +000011071 {"SC_2_FORT_DEV", _SC_2_FORT_DEV},
Fred Drakec9680921999-12-13 16:37:25 +000011072#endif
11073#ifdef _SC_2_FORT_RUN
Victor Stinner8c62be82010-05-06 00:08:46 +000011074 {"SC_2_FORT_RUN", _SC_2_FORT_RUN},
Fred Drakec9680921999-12-13 16:37:25 +000011075#endif
11076#ifdef _SC_2_LOCALEDEF
Victor Stinner8c62be82010-05-06 00:08:46 +000011077 {"SC_2_LOCALEDEF", _SC_2_LOCALEDEF},
Fred Drakec9680921999-12-13 16:37:25 +000011078#endif
11079#ifdef _SC_2_SW_DEV
Victor Stinner8c62be82010-05-06 00:08:46 +000011080 {"SC_2_SW_DEV", _SC_2_SW_DEV},
Fred Drakec9680921999-12-13 16:37:25 +000011081#endif
11082#ifdef _SC_2_UPE
Victor Stinner8c62be82010-05-06 00:08:46 +000011083 {"SC_2_UPE", _SC_2_UPE},
Fred Drakec9680921999-12-13 16:37:25 +000011084#endif
11085#ifdef _SC_2_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000011086 {"SC_2_VERSION", _SC_2_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000011087#endif
Fred Draked86ed291999-12-15 15:34:33 +000011088#ifdef _SC_ABI_ASYNCHRONOUS_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000011089 {"SC_ABI_ASYNCHRONOUS_IO", _SC_ABI_ASYNCHRONOUS_IO},
Fred Draked86ed291999-12-15 15:34:33 +000011090#endif
11091#ifdef _SC_ACL
Victor Stinner8c62be82010-05-06 00:08:46 +000011092 {"SC_ACL", _SC_ACL},
Fred Draked86ed291999-12-15 15:34:33 +000011093#endif
Fred Drakec9680921999-12-13 16:37:25 +000011094#ifdef _SC_AIO_LISTIO_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011095 {"SC_AIO_LISTIO_MAX", _SC_AIO_LISTIO_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011096#endif
Fred Drakec9680921999-12-13 16:37:25 +000011097#ifdef _SC_AIO_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011098 {"SC_AIO_MAX", _SC_AIO_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011099#endif
11100#ifdef _SC_AIO_PRIO_DELTA_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011101 {"SC_AIO_PRIO_DELTA_MAX", _SC_AIO_PRIO_DELTA_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011102#endif
11103#ifdef _SC_ARG_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011104 {"SC_ARG_MAX", _SC_ARG_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011105#endif
11106#ifdef _SC_ASYNCHRONOUS_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000011107 {"SC_ASYNCHRONOUS_IO", _SC_ASYNCHRONOUS_IO},
Fred Drakec9680921999-12-13 16:37:25 +000011108#endif
11109#ifdef _SC_ATEXIT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011110 {"SC_ATEXIT_MAX", _SC_ATEXIT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011111#endif
Fred Draked86ed291999-12-15 15:34:33 +000011112#ifdef _SC_AUDIT
Victor Stinner8c62be82010-05-06 00:08:46 +000011113 {"SC_AUDIT", _SC_AUDIT},
Fred Draked86ed291999-12-15 15:34:33 +000011114#endif
Fred Drakec9680921999-12-13 16:37:25 +000011115#ifdef _SC_AVPHYS_PAGES
Victor Stinner8c62be82010-05-06 00:08:46 +000011116 {"SC_AVPHYS_PAGES", _SC_AVPHYS_PAGES},
Fred Drakec9680921999-12-13 16:37:25 +000011117#endif
11118#ifdef _SC_BC_BASE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011119 {"SC_BC_BASE_MAX", _SC_BC_BASE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011120#endif
11121#ifdef _SC_BC_DIM_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011122 {"SC_BC_DIM_MAX", _SC_BC_DIM_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011123#endif
11124#ifdef _SC_BC_SCALE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011125 {"SC_BC_SCALE_MAX", _SC_BC_SCALE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011126#endif
11127#ifdef _SC_BC_STRING_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011128 {"SC_BC_STRING_MAX", _SC_BC_STRING_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011129#endif
Fred Draked86ed291999-12-15 15:34:33 +000011130#ifdef _SC_CAP
Victor Stinner8c62be82010-05-06 00:08:46 +000011131 {"SC_CAP", _SC_CAP},
Fred Draked86ed291999-12-15 15:34:33 +000011132#endif
Fred Drakec9680921999-12-13 16:37:25 +000011133#ifdef _SC_CHARCLASS_NAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011134 {"SC_CHARCLASS_NAME_MAX", _SC_CHARCLASS_NAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011135#endif
11136#ifdef _SC_CHAR_BIT
Victor Stinner8c62be82010-05-06 00:08:46 +000011137 {"SC_CHAR_BIT", _SC_CHAR_BIT},
Fred Drakec9680921999-12-13 16:37:25 +000011138#endif
11139#ifdef _SC_CHAR_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011140 {"SC_CHAR_MAX", _SC_CHAR_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011141#endif
11142#ifdef _SC_CHAR_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000011143 {"SC_CHAR_MIN", _SC_CHAR_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000011144#endif
11145#ifdef _SC_CHILD_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011146 {"SC_CHILD_MAX", _SC_CHILD_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011147#endif
11148#ifdef _SC_CLK_TCK
Victor Stinner8c62be82010-05-06 00:08:46 +000011149 {"SC_CLK_TCK", _SC_CLK_TCK},
Fred Drakec9680921999-12-13 16:37:25 +000011150#endif
11151#ifdef _SC_COHER_BLKSZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011152 {"SC_COHER_BLKSZ", _SC_COHER_BLKSZ},
Fred Drakec9680921999-12-13 16:37:25 +000011153#endif
11154#ifdef _SC_COLL_WEIGHTS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011155 {"SC_COLL_WEIGHTS_MAX", _SC_COLL_WEIGHTS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011156#endif
11157#ifdef _SC_DCACHE_ASSOC
Victor Stinner8c62be82010-05-06 00:08:46 +000011158 {"SC_DCACHE_ASSOC", _SC_DCACHE_ASSOC},
Fred Drakec9680921999-12-13 16:37:25 +000011159#endif
11160#ifdef _SC_DCACHE_BLKSZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011161 {"SC_DCACHE_BLKSZ", _SC_DCACHE_BLKSZ},
Fred Drakec9680921999-12-13 16:37:25 +000011162#endif
11163#ifdef _SC_DCACHE_LINESZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011164 {"SC_DCACHE_LINESZ", _SC_DCACHE_LINESZ},
Fred Drakec9680921999-12-13 16:37:25 +000011165#endif
11166#ifdef _SC_DCACHE_SZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011167 {"SC_DCACHE_SZ", _SC_DCACHE_SZ},
Fred Drakec9680921999-12-13 16:37:25 +000011168#endif
11169#ifdef _SC_DCACHE_TBLKSZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011170 {"SC_DCACHE_TBLKSZ", _SC_DCACHE_TBLKSZ},
Fred Drakec9680921999-12-13 16:37:25 +000011171#endif
11172#ifdef _SC_DELAYTIMER_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011173 {"SC_DELAYTIMER_MAX", _SC_DELAYTIMER_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011174#endif
11175#ifdef _SC_EQUIV_CLASS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011176 {"SC_EQUIV_CLASS_MAX", _SC_EQUIV_CLASS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011177#endif
11178#ifdef _SC_EXPR_NEST_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011179 {"SC_EXPR_NEST_MAX", _SC_EXPR_NEST_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011180#endif
11181#ifdef _SC_FSYNC
Victor Stinner8c62be82010-05-06 00:08:46 +000011182 {"SC_FSYNC", _SC_FSYNC},
Fred Drakec9680921999-12-13 16:37:25 +000011183#endif
11184#ifdef _SC_GETGR_R_SIZE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011185 {"SC_GETGR_R_SIZE_MAX", _SC_GETGR_R_SIZE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011186#endif
11187#ifdef _SC_GETPW_R_SIZE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011188 {"SC_GETPW_R_SIZE_MAX", _SC_GETPW_R_SIZE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011189#endif
11190#ifdef _SC_ICACHE_ASSOC
Victor Stinner8c62be82010-05-06 00:08:46 +000011191 {"SC_ICACHE_ASSOC", _SC_ICACHE_ASSOC},
Fred Drakec9680921999-12-13 16:37:25 +000011192#endif
11193#ifdef _SC_ICACHE_BLKSZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011194 {"SC_ICACHE_BLKSZ", _SC_ICACHE_BLKSZ},
Fred Drakec9680921999-12-13 16:37:25 +000011195#endif
11196#ifdef _SC_ICACHE_LINESZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011197 {"SC_ICACHE_LINESZ", _SC_ICACHE_LINESZ},
Fred Drakec9680921999-12-13 16:37:25 +000011198#endif
11199#ifdef _SC_ICACHE_SZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011200 {"SC_ICACHE_SZ", _SC_ICACHE_SZ},
Fred Drakec9680921999-12-13 16:37:25 +000011201#endif
Fred Draked86ed291999-12-15 15:34:33 +000011202#ifdef _SC_INF
Victor Stinner8c62be82010-05-06 00:08:46 +000011203 {"SC_INF", _SC_INF},
Fred Draked86ed291999-12-15 15:34:33 +000011204#endif
Fred Drakec9680921999-12-13 16:37:25 +000011205#ifdef _SC_INT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011206 {"SC_INT_MAX", _SC_INT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011207#endif
11208#ifdef _SC_INT_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000011209 {"SC_INT_MIN", _SC_INT_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000011210#endif
11211#ifdef _SC_IOV_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011212 {"SC_IOV_MAX", _SC_IOV_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011213#endif
Fred Draked86ed291999-12-15 15:34:33 +000011214#ifdef _SC_IP_SECOPTS
Victor Stinner8c62be82010-05-06 00:08:46 +000011215 {"SC_IP_SECOPTS", _SC_IP_SECOPTS},
Fred Draked86ed291999-12-15 15:34:33 +000011216#endif
Fred Drakec9680921999-12-13 16:37:25 +000011217#ifdef _SC_JOB_CONTROL
Victor Stinner8c62be82010-05-06 00:08:46 +000011218 {"SC_JOB_CONTROL", _SC_JOB_CONTROL},
Fred Drakec9680921999-12-13 16:37:25 +000011219#endif
Fred Draked86ed291999-12-15 15:34:33 +000011220#ifdef _SC_KERN_POINTERS
Victor Stinner8c62be82010-05-06 00:08:46 +000011221 {"SC_KERN_POINTERS", _SC_KERN_POINTERS},
Fred Draked86ed291999-12-15 15:34:33 +000011222#endif
11223#ifdef _SC_KERN_SIM
Victor Stinner8c62be82010-05-06 00:08:46 +000011224 {"SC_KERN_SIM", _SC_KERN_SIM},
Fred Draked86ed291999-12-15 15:34:33 +000011225#endif
Fred Drakec9680921999-12-13 16:37:25 +000011226#ifdef _SC_LINE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011227 {"SC_LINE_MAX", _SC_LINE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011228#endif
11229#ifdef _SC_LOGIN_NAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011230 {"SC_LOGIN_NAME_MAX", _SC_LOGIN_NAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011231#endif
11232#ifdef _SC_LOGNAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011233 {"SC_LOGNAME_MAX", _SC_LOGNAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011234#endif
11235#ifdef _SC_LONG_BIT
Victor Stinner8c62be82010-05-06 00:08:46 +000011236 {"SC_LONG_BIT", _SC_LONG_BIT},
Fred Drakec9680921999-12-13 16:37:25 +000011237#endif
Fred Draked86ed291999-12-15 15:34:33 +000011238#ifdef _SC_MAC
Victor Stinner8c62be82010-05-06 00:08:46 +000011239 {"SC_MAC", _SC_MAC},
Fred Draked86ed291999-12-15 15:34:33 +000011240#endif
Fred Drakec9680921999-12-13 16:37:25 +000011241#ifdef _SC_MAPPED_FILES
Victor Stinner8c62be82010-05-06 00:08:46 +000011242 {"SC_MAPPED_FILES", _SC_MAPPED_FILES},
Fred Drakec9680921999-12-13 16:37:25 +000011243#endif
11244#ifdef _SC_MAXPID
Victor Stinner8c62be82010-05-06 00:08:46 +000011245 {"SC_MAXPID", _SC_MAXPID},
Fred Drakec9680921999-12-13 16:37:25 +000011246#endif
11247#ifdef _SC_MB_LEN_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011248 {"SC_MB_LEN_MAX", _SC_MB_LEN_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011249#endif
11250#ifdef _SC_MEMLOCK
Victor Stinner8c62be82010-05-06 00:08:46 +000011251 {"SC_MEMLOCK", _SC_MEMLOCK},
Fred Drakec9680921999-12-13 16:37:25 +000011252#endif
11253#ifdef _SC_MEMLOCK_RANGE
Victor Stinner8c62be82010-05-06 00:08:46 +000011254 {"SC_MEMLOCK_RANGE", _SC_MEMLOCK_RANGE},
Fred Drakec9680921999-12-13 16:37:25 +000011255#endif
11256#ifdef _SC_MEMORY_PROTECTION
Victor Stinner8c62be82010-05-06 00:08:46 +000011257 {"SC_MEMORY_PROTECTION", _SC_MEMORY_PROTECTION},
Fred Drakec9680921999-12-13 16:37:25 +000011258#endif
11259#ifdef _SC_MESSAGE_PASSING
Victor Stinner8c62be82010-05-06 00:08:46 +000011260 {"SC_MESSAGE_PASSING", _SC_MESSAGE_PASSING},
Fred Drakec9680921999-12-13 16:37:25 +000011261#endif
Fred Draked86ed291999-12-15 15:34:33 +000011262#ifdef _SC_MMAP_FIXED_ALIGNMENT
Victor Stinner8c62be82010-05-06 00:08:46 +000011263 {"SC_MMAP_FIXED_ALIGNMENT", _SC_MMAP_FIXED_ALIGNMENT},
Fred Draked86ed291999-12-15 15:34:33 +000011264#endif
Fred Drakec9680921999-12-13 16:37:25 +000011265#ifdef _SC_MQ_OPEN_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011266 {"SC_MQ_OPEN_MAX", _SC_MQ_OPEN_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011267#endif
11268#ifdef _SC_MQ_PRIO_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011269 {"SC_MQ_PRIO_MAX", _SC_MQ_PRIO_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011270#endif
Fred Draked86ed291999-12-15 15:34:33 +000011271#ifdef _SC_NACLS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011272 {"SC_NACLS_MAX", _SC_NACLS_MAX},
Fred Draked86ed291999-12-15 15:34:33 +000011273#endif
Fred Drakec9680921999-12-13 16:37:25 +000011274#ifdef _SC_NGROUPS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011275 {"SC_NGROUPS_MAX", _SC_NGROUPS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011276#endif
11277#ifdef _SC_NL_ARGMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011278 {"SC_NL_ARGMAX", _SC_NL_ARGMAX},
Fred Drakec9680921999-12-13 16:37:25 +000011279#endif
11280#ifdef _SC_NL_LANGMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011281 {"SC_NL_LANGMAX", _SC_NL_LANGMAX},
Fred Drakec9680921999-12-13 16:37:25 +000011282#endif
11283#ifdef _SC_NL_MSGMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011284 {"SC_NL_MSGMAX", _SC_NL_MSGMAX},
Fred Drakec9680921999-12-13 16:37:25 +000011285#endif
11286#ifdef _SC_NL_NMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011287 {"SC_NL_NMAX", _SC_NL_NMAX},
Fred Drakec9680921999-12-13 16:37:25 +000011288#endif
11289#ifdef _SC_NL_SETMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011290 {"SC_NL_SETMAX", _SC_NL_SETMAX},
Fred Drakec9680921999-12-13 16:37:25 +000011291#endif
11292#ifdef _SC_NL_TEXTMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011293 {"SC_NL_TEXTMAX", _SC_NL_TEXTMAX},
Fred Drakec9680921999-12-13 16:37:25 +000011294#endif
11295#ifdef _SC_NPROCESSORS_CONF
Victor Stinner8c62be82010-05-06 00:08:46 +000011296 {"SC_NPROCESSORS_CONF", _SC_NPROCESSORS_CONF},
Fred Drakec9680921999-12-13 16:37:25 +000011297#endif
11298#ifdef _SC_NPROCESSORS_ONLN
Victor Stinner8c62be82010-05-06 00:08:46 +000011299 {"SC_NPROCESSORS_ONLN", _SC_NPROCESSORS_ONLN},
Fred Drakec9680921999-12-13 16:37:25 +000011300#endif
Fred Draked86ed291999-12-15 15:34:33 +000011301#ifdef _SC_NPROC_CONF
Victor Stinner8c62be82010-05-06 00:08:46 +000011302 {"SC_NPROC_CONF", _SC_NPROC_CONF},
Fred Draked86ed291999-12-15 15:34:33 +000011303#endif
11304#ifdef _SC_NPROC_ONLN
Victor Stinner8c62be82010-05-06 00:08:46 +000011305 {"SC_NPROC_ONLN", _SC_NPROC_ONLN},
Fred Draked86ed291999-12-15 15:34:33 +000011306#endif
Fred Drakec9680921999-12-13 16:37:25 +000011307#ifdef _SC_NZERO
Victor Stinner8c62be82010-05-06 00:08:46 +000011308 {"SC_NZERO", _SC_NZERO},
Fred Drakec9680921999-12-13 16:37:25 +000011309#endif
11310#ifdef _SC_OPEN_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011311 {"SC_OPEN_MAX", _SC_OPEN_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011312#endif
11313#ifdef _SC_PAGESIZE
Victor Stinner8c62be82010-05-06 00:08:46 +000011314 {"SC_PAGESIZE", _SC_PAGESIZE},
Fred Drakec9680921999-12-13 16:37:25 +000011315#endif
11316#ifdef _SC_PAGE_SIZE
Victor Stinner8c62be82010-05-06 00:08:46 +000011317 {"SC_PAGE_SIZE", _SC_PAGE_SIZE},
Fred Drakec9680921999-12-13 16:37:25 +000011318#endif
11319#ifdef _SC_PASS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011320 {"SC_PASS_MAX", _SC_PASS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011321#endif
11322#ifdef _SC_PHYS_PAGES
Victor Stinner8c62be82010-05-06 00:08:46 +000011323 {"SC_PHYS_PAGES", _SC_PHYS_PAGES},
Fred Drakec9680921999-12-13 16:37:25 +000011324#endif
11325#ifdef _SC_PII
Victor Stinner8c62be82010-05-06 00:08:46 +000011326 {"SC_PII", _SC_PII},
Fred Drakec9680921999-12-13 16:37:25 +000011327#endif
11328#ifdef _SC_PII_INTERNET
Victor Stinner8c62be82010-05-06 00:08:46 +000011329 {"SC_PII_INTERNET", _SC_PII_INTERNET},
Fred Drakec9680921999-12-13 16:37:25 +000011330#endif
11331#ifdef _SC_PII_INTERNET_DGRAM
Victor Stinner8c62be82010-05-06 00:08:46 +000011332 {"SC_PII_INTERNET_DGRAM", _SC_PII_INTERNET_DGRAM},
Fred Drakec9680921999-12-13 16:37:25 +000011333#endif
11334#ifdef _SC_PII_INTERNET_STREAM
Victor Stinner8c62be82010-05-06 00:08:46 +000011335 {"SC_PII_INTERNET_STREAM", _SC_PII_INTERNET_STREAM},
Fred Drakec9680921999-12-13 16:37:25 +000011336#endif
11337#ifdef _SC_PII_OSI
Victor Stinner8c62be82010-05-06 00:08:46 +000011338 {"SC_PII_OSI", _SC_PII_OSI},
Fred Drakec9680921999-12-13 16:37:25 +000011339#endif
11340#ifdef _SC_PII_OSI_CLTS
Victor Stinner8c62be82010-05-06 00:08:46 +000011341 {"SC_PII_OSI_CLTS", _SC_PII_OSI_CLTS},
Fred Drakec9680921999-12-13 16:37:25 +000011342#endif
11343#ifdef _SC_PII_OSI_COTS
Victor Stinner8c62be82010-05-06 00:08:46 +000011344 {"SC_PII_OSI_COTS", _SC_PII_OSI_COTS},
Fred Drakec9680921999-12-13 16:37:25 +000011345#endif
11346#ifdef _SC_PII_OSI_M
Victor Stinner8c62be82010-05-06 00:08:46 +000011347 {"SC_PII_OSI_M", _SC_PII_OSI_M},
Fred Drakec9680921999-12-13 16:37:25 +000011348#endif
11349#ifdef _SC_PII_SOCKET
Victor Stinner8c62be82010-05-06 00:08:46 +000011350 {"SC_PII_SOCKET", _SC_PII_SOCKET},
Fred Drakec9680921999-12-13 16:37:25 +000011351#endif
11352#ifdef _SC_PII_XTI
Victor Stinner8c62be82010-05-06 00:08:46 +000011353 {"SC_PII_XTI", _SC_PII_XTI},
Fred Drakec9680921999-12-13 16:37:25 +000011354#endif
11355#ifdef _SC_POLL
Victor Stinner8c62be82010-05-06 00:08:46 +000011356 {"SC_POLL", _SC_POLL},
Fred Drakec9680921999-12-13 16:37:25 +000011357#endif
11358#ifdef _SC_PRIORITIZED_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000011359 {"SC_PRIORITIZED_IO", _SC_PRIORITIZED_IO},
Fred Drakec9680921999-12-13 16:37:25 +000011360#endif
11361#ifdef _SC_PRIORITY_SCHEDULING
Victor Stinner8c62be82010-05-06 00:08:46 +000011362 {"SC_PRIORITY_SCHEDULING", _SC_PRIORITY_SCHEDULING},
Fred Drakec9680921999-12-13 16:37:25 +000011363#endif
11364#ifdef _SC_REALTIME_SIGNALS
Victor Stinner8c62be82010-05-06 00:08:46 +000011365 {"SC_REALTIME_SIGNALS", _SC_REALTIME_SIGNALS},
Fred Drakec9680921999-12-13 16:37:25 +000011366#endif
11367#ifdef _SC_RE_DUP_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011368 {"SC_RE_DUP_MAX", _SC_RE_DUP_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011369#endif
11370#ifdef _SC_RTSIG_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011371 {"SC_RTSIG_MAX", _SC_RTSIG_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011372#endif
11373#ifdef _SC_SAVED_IDS
Victor Stinner8c62be82010-05-06 00:08:46 +000011374 {"SC_SAVED_IDS", _SC_SAVED_IDS},
Fred Drakec9680921999-12-13 16:37:25 +000011375#endif
11376#ifdef _SC_SCHAR_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011377 {"SC_SCHAR_MAX", _SC_SCHAR_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011378#endif
11379#ifdef _SC_SCHAR_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000011380 {"SC_SCHAR_MIN", _SC_SCHAR_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000011381#endif
11382#ifdef _SC_SELECT
Victor Stinner8c62be82010-05-06 00:08:46 +000011383 {"SC_SELECT", _SC_SELECT},
Fred Drakec9680921999-12-13 16:37:25 +000011384#endif
11385#ifdef _SC_SEMAPHORES
Victor Stinner8c62be82010-05-06 00:08:46 +000011386 {"SC_SEMAPHORES", _SC_SEMAPHORES},
Fred Drakec9680921999-12-13 16:37:25 +000011387#endif
11388#ifdef _SC_SEM_NSEMS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011389 {"SC_SEM_NSEMS_MAX", _SC_SEM_NSEMS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011390#endif
11391#ifdef _SC_SEM_VALUE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011392 {"SC_SEM_VALUE_MAX", _SC_SEM_VALUE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011393#endif
11394#ifdef _SC_SHARED_MEMORY_OBJECTS
Victor Stinner8c62be82010-05-06 00:08:46 +000011395 {"SC_SHARED_MEMORY_OBJECTS", _SC_SHARED_MEMORY_OBJECTS},
Fred Drakec9680921999-12-13 16:37:25 +000011396#endif
11397#ifdef _SC_SHRT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011398 {"SC_SHRT_MAX", _SC_SHRT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011399#endif
11400#ifdef _SC_SHRT_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000011401 {"SC_SHRT_MIN", _SC_SHRT_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000011402#endif
11403#ifdef _SC_SIGQUEUE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011404 {"SC_SIGQUEUE_MAX", _SC_SIGQUEUE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011405#endif
11406#ifdef _SC_SIGRT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011407 {"SC_SIGRT_MAX", _SC_SIGRT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011408#endif
11409#ifdef _SC_SIGRT_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000011410 {"SC_SIGRT_MIN", _SC_SIGRT_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000011411#endif
Fred Draked86ed291999-12-15 15:34:33 +000011412#ifdef _SC_SOFTPOWER
Victor Stinner8c62be82010-05-06 00:08:46 +000011413 {"SC_SOFTPOWER", _SC_SOFTPOWER},
Fred Draked86ed291999-12-15 15:34:33 +000011414#endif
Fred Drakec9680921999-12-13 16:37:25 +000011415#ifdef _SC_SPLIT_CACHE
Victor Stinner8c62be82010-05-06 00:08:46 +000011416 {"SC_SPLIT_CACHE", _SC_SPLIT_CACHE},
Fred Drakec9680921999-12-13 16:37:25 +000011417#endif
11418#ifdef _SC_SSIZE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011419 {"SC_SSIZE_MAX", _SC_SSIZE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011420#endif
11421#ifdef _SC_STACK_PROT
Victor Stinner8c62be82010-05-06 00:08:46 +000011422 {"SC_STACK_PROT", _SC_STACK_PROT},
Fred Drakec9680921999-12-13 16:37:25 +000011423#endif
11424#ifdef _SC_STREAM_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011425 {"SC_STREAM_MAX", _SC_STREAM_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011426#endif
11427#ifdef _SC_SYNCHRONIZED_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000011428 {"SC_SYNCHRONIZED_IO", _SC_SYNCHRONIZED_IO},
Fred Drakec9680921999-12-13 16:37:25 +000011429#endif
11430#ifdef _SC_THREADS
Victor Stinner8c62be82010-05-06 00:08:46 +000011431 {"SC_THREADS", _SC_THREADS},
Fred Drakec9680921999-12-13 16:37:25 +000011432#endif
11433#ifdef _SC_THREAD_ATTR_STACKADDR
Victor Stinner8c62be82010-05-06 00:08:46 +000011434 {"SC_THREAD_ATTR_STACKADDR", _SC_THREAD_ATTR_STACKADDR},
Fred Drakec9680921999-12-13 16:37:25 +000011435#endif
11436#ifdef _SC_THREAD_ATTR_STACKSIZE
Victor Stinner8c62be82010-05-06 00:08:46 +000011437 {"SC_THREAD_ATTR_STACKSIZE", _SC_THREAD_ATTR_STACKSIZE},
Fred Drakec9680921999-12-13 16:37:25 +000011438#endif
11439#ifdef _SC_THREAD_DESTRUCTOR_ITERATIONS
Victor Stinner8c62be82010-05-06 00:08:46 +000011440 {"SC_THREAD_DESTRUCTOR_ITERATIONS", _SC_THREAD_DESTRUCTOR_ITERATIONS},
Fred Drakec9680921999-12-13 16:37:25 +000011441#endif
11442#ifdef _SC_THREAD_KEYS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011443 {"SC_THREAD_KEYS_MAX", _SC_THREAD_KEYS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011444#endif
11445#ifdef _SC_THREAD_PRIORITY_SCHEDULING
Victor Stinner8c62be82010-05-06 00:08:46 +000011446 {"SC_THREAD_PRIORITY_SCHEDULING", _SC_THREAD_PRIORITY_SCHEDULING},
Fred Drakec9680921999-12-13 16:37:25 +000011447#endif
11448#ifdef _SC_THREAD_PRIO_INHERIT
Victor Stinner8c62be82010-05-06 00:08:46 +000011449 {"SC_THREAD_PRIO_INHERIT", _SC_THREAD_PRIO_INHERIT},
Fred Drakec9680921999-12-13 16:37:25 +000011450#endif
11451#ifdef _SC_THREAD_PRIO_PROTECT
Victor Stinner8c62be82010-05-06 00:08:46 +000011452 {"SC_THREAD_PRIO_PROTECT", _SC_THREAD_PRIO_PROTECT},
Fred Drakec9680921999-12-13 16:37:25 +000011453#endif
11454#ifdef _SC_THREAD_PROCESS_SHARED
Victor Stinner8c62be82010-05-06 00:08:46 +000011455 {"SC_THREAD_PROCESS_SHARED", _SC_THREAD_PROCESS_SHARED},
Fred Drakec9680921999-12-13 16:37:25 +000011456#endif
11457#ifdef _SC_THREAD_SAFE_FUNCTIONS
Victor Stinner8c62be82010-05-06 00:08:46 +000011458 {"SC_THREAD_SAFE_FUNCTIONS", _SC_THREAD_SAFE_FUNCTIONS},
Fred Drakec9680921999-12-13 16:37:25 +000011459#endif
11460#ifdef _SC_THREAD_STACK_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000011461 {"SC_THREAD_STACK_MIN", _SC_THREAD_STACK_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000011462#endif
11463#ifdef _SC_THREAD_THREADS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011464 {"SC_THREAD_THREADS_MAX", _SC_THREAD_THREADS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011465#endif
11466#ifdef _SC_TIMERS
Victor Stinner8c62be82010-05-06 00:08:46 +000011467 {"SC_TIMERS", _SC_TIMERS},
Fred Drakec9680921999-12-13 16:37:25 +000011468#endif
11469#ifdef _SC_TIMER_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011470 {"SC_TIMER_MAX", _SC_TIMER_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011471#endif
11472#ifdef _SC_TTY_NAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011473 {"SC_TTY_NAME_MAX", _SC_TTY_NAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011474#endif
11475#ifdef _SC_TZNAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011476 {"SC_TZNAME_MAX", _SC_TZNAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011477#endif
11478#ifdef _SC_T_IOV_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011479 {"SC_T_IOV_MAX", _SC_T_IOV_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011480#endif
11481#ifdef _SC_UCHAR_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011482 {"SC_UCHAR_MAX", _SC_UCHAR_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011483#endif
11484#ifdef _SC_UINT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011485 {"SC_UINT_MAX", _SC_UINT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011486#endif
11487#ifdef _SC_UIO_MAXIOV
Victor Stinner8c62be82010-05-06 00:08:46 +000011488 {"SC_UIO_MAXIOV", _SC_UIO_MAXIOV},
Fred Drakec9680921999-12-13 16:37:25 +000011489#endif
11490#ifdef _SC_ULONG_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011491 {"SC_ULONG_MAX", _SC_ULONG_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011492#endif
11493#ifdef _SC_USHRT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011494 {"SC_USHRT_MAX", _SC_USHRT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011495#endif
11496#ifdef _SC_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000011497 {"SC_VERSION", _SC_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000011498#endif
11499#ifdef _SC_WORD_BIT
Victor Stinner8c62be82010-05-06 00:08:46 +000011500 {"SC_WORD_BIT", _SC_WORD_BIT},
Fred Drakec9680921999-12-13 16:37:25 +000011501#endif
11502#ifdef _SC_XBS5_ILP32_OFF32
Victor Stinner8c62be82010-05-06 00:08:46 +000011503 {"SC_XBS5_ILP32_OFF32", _SC_XBS5_ILP32_OFF32},
Fred Drakec9680921999-12-13 16:37:25 +000011504#endif
11505#ifdef _SC_XBS5_ILP32_OFFBIG
Victor Stinner8c62be82010-05-06 00:08:46 +000011506 {"SC_XBS5_ILP32_OFFBIG", _SC_XBS5_ILP32_OFFBIG},
Fred Drakec9680921999-12-13 16:37:25 +000011507#endif
11508#ifdef _SC_XBS5_LP64_OFF64
Victor Stinner8c62be82010-05-06 00:08:46 +000011509 {"SC_XBS5_LP64_OFF64", _SC_XBS5_LP64_OFF64},
Fred Drakec9680921999-12-13 16:37:25 +000011510#endif
11511#ifdef _SC_XBS5_LPBIG_OFFBIG
Victor Stinner8c62be82010-05-06 00:08:46 +000011512 {"SC_XBS5_LPBIG_OFFBIG", _SC_XBS5_LPBIG_OFFBIG},
Fred Drakec9680921999-12-13 16:37:25 +000011513#endif
11514#ifdef _SC_XOPEN_CRYPT
Victor Stinner8c62be82010-05-06 00:08:46 +000011515 {"SC_XOPEN_CRYPT", _SC_XOPEN_CRYPT},
Fred Drakec9680921999-12-13 16:37:25 +000011516#endif
11517#ifdef _SC_XOPEN_ENH_I18N
Victor Stinner8c62be82010-05-06 00:08:46 +000011518 {"SC_XOPEN_ENH_I18N", _SC_XOPEN_ENH_I18N},
Fred Drakec9680921999-12-13 16:37:25 +000011519#endif
11520#ifdef _SC_XOPEN_LEGACY
Victor Stinner8c62be82010-05-06 00:08:46 +000011521 {"SC_XOPEN_LEGACY", _SC_XOPEN_LEGACY},
Fred Drakec9680921999-12-13 16:37:25 +000011522#endif
11523#ifdef _SC_XOPEN_REALTIME
Victor Stinner8c62be82010-05-06 00:08:46 +000011524 {"SC_XOPEN_REALTIME", _SC_XOPEN_REALTIME},
Fred Drakec9680921999-12-13 16:37:25 +000011525#endif
11526#ifdef _SC_XOPEN_REALTIME_THREADS
Victor Stinner8c62be82010-05-06 00:08:46 +000011527 {"SC_XOPEN_REALTIME_THREADS", _SC_XOPEN_REALTIME_THREADS},
Fred Drakec9680921999-12-13 16:37:25 +000011528#endif
11529#ifdef _SC_XOPEN_SHM
Victor Stinner8c62be82010-05-06 00:08:46 +000011530 {"SC_XOPEN_SHM", _SC_XOPEN_SHM},
Fred Drakec9680921999-12-13 16:37:25 +000011531#endif
11532#ifdef _SC_XOPEN_UNIX
Victor Stinner8c62be82010-05-06 00:08:46 +000011533 {"SC_XOPEN_UNIX", _SC_XOPEN_UNIX},
Fred Drakec9680921999-12-13 16:37:25 +000011534#endif
11535#ifdef _SC_XOPEN_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000011536 {"SC_XOPEN_VERSION", _SC_XOPEN_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000011537#endif
11538#ifdef _SC_XOPEN_XCU_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000011539 {"SC_XOPEN_XCU_VERSION", _SC_XOPEN_XCU_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000011540#endif
11541#ifdef _SC_XOPEN_XPG2
Victor Stinner8c62be82010-05-06 00:08:46 +000011542 {"SC_XOPEN_XPG2", _SC_XOPEN_XPG2},
Fred Drakec9680921999-12-13 16:37:25 +000011543#endif
11544#ifdef _SC_XOPEN_XPG3
Victor Stinner8c62be82010-05-06 00:08:46 +000011545 {"SC_XOPEN_XPG3", _SC_XOPEN_XPG3},
Fred Drakec9680921999-12-13 16:37:25 +000011546#endif
11547#ifdef _SC_XOPEN_XPG4
Victor Stinner8c62be82010-05-06 00:08:46 +000011548 {"SC_XOPEN_XPG4", _SC_XOPEN_XPG4},
Fred Drakec9680921999-12-13 16:37:25 +000011549#endif
11550};
11551
11552static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000011553conv_sysconf_confname(PyObject *arg, int *valuep)
Fred Drakec9680921999-12-13 16:37:25 +000011554{
11555 return conv_confname(arg, valuep, posix_constants_sysconf,
11556 sizeof(posix_constants_sysconf)
11557 / sizeof(struct constdef));
11558}
11559
Larry Hastings2f936352014-08-05 14:04:04 +100011560
11561/*[clinic input]
11562os.sysconf -> long
11563 name: sysconf_confname
11564 /
11565
11566Return an integer-valued system configuration variable.
11567[clinic start generated code]*/
11568
Larry Hastings2f936352014-08-05 14:04:04 +100011569static long
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011570os_sysconf_impl(PyObject *module, int name)
11571/*[clinic end generated code: output=3662f945fc0cc756 input=279e3430a33f29e4]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011572{
11573 long value;
11574
11575 errno = 0;
11576 value = sysconf(name);
11577 if (value == -1 && errno != 0)
11578 posix_error();
11579 return value;
11580}
11581#endif /* HAVE_SYSCONF */
Fred Drakec9680921999-12-13 16:37:25 +000011582
11583
Fred Drakebec628d1999-12-15 18:31:10 +000011584/* This code is used to ensure that the tables of configuration value names
Serhiy Storchaka56a6d852014-12-01 18:28:43 +020011585 * are in sorted order as required by conv_confname(), and also to build
Fred Drakebec628d1999-12-15 18:31:10 +000011586 * the exported dictionaries that are used to publish information about the
11587 * names available on the host platform.
11588 *
11589 * Sorting the table at runtime ensures that the table is properly ordered
11590 * when used, even for platforms we're not able to test on. It also makes
11591 * it easier to add additional entries to the tables.
Fred Draked86ed291999-12-15 15:34:33 +000011592 */
Fred Drakebec628d1999-12-15 18:31:10 +000011593
11594static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000011595cmp_constdefs(const void *v1, const void *v2)
Fred Drakebec628d1999-12-15 18:31:10 +000011596{
11597 const struct constdef *c1 =
Victor Stinner8c62be82010-05-06 00:08:46 +000011598 (const struct constdef *) v1;
Fred Drakebec628d1999-12-15 18:31:10 +000011599 const struct constdef *c2 =
Victor Stinner8c62be82010-05-06 00:08:46 +000011600 (const struct constdef *) v2;
Fred Drakebec628d1999-12-15 18:31:10 +000011601
11602 return strcmp(c1->name, c2->name);
11603}
11604
11605static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000011606setup_confname_table(struct constdef *table, size_t tablesize,
Serhiy Storchakadeab18d2016-05-07 16:45:18 +030011607 const char *tablename, PyObject *module)
Fred Draked86ed291999-12-15 15:34:33 +000011608{
Fred Drakebec628d1999-12-15 18:31:10 +000011609 PyObject *d = NULL;
Barry Warsaw3155db32000-04-13 15:20:40 +000011610 size_t i;
Fred Drakebec628d1999-12-15 18:31:10 +000011611
11612 qsort(table, tablesize, sizeof(struct constdef), cmp_constdefs);
11613 d = PyDict_New();
Barry Warsaw3155db32000-04-13 15:20:40 +000011614 if (d == NULL)
Victor Stinner8c62be82010-05-06 00:08:46 +000011615 return -1;
Fred Draked86ed291999-12-15 15:34:33 +000011616
Barry Warsaw3155db32000-04-13 15:20:40 +000011617 for (i=0; i < tablesize; ++i) {
Victor Stinner8c62be82010-05-06 00:08:46 +000011618 PyObject *o = PyLong_FromLong(table[i].value);
11619 if (o == NULL || PyDict_SetItemString(d, table[i].name, o) == -1) {
11620 Py_XDECREF(o);
11621 Py_DECREF(d);
11622 return -1;
11623 }
11624 Py_DECREF(o);
Fred Draked86ed291999-12-15 15:34:33 +000011625 }
Fred Drake4d1e64b2002-04-15 19:40:07 +000011626 return PyModule_AddObject(module, tablename, d);
Fred Draked86ed291999-12-15 15:34:33 +000011627}
11628
Fred Drakebec628d1999-12-15 18:31:10 +000011629/* Return -1 on failure, 0 on success. */
11630static int
Fred Drake4d1e64b2002-04-15 19:40:07 +000011631setup_confname_tables(PyObject *module)
Fred Draked86ed291999-12-15 15:34:33 +000011632{
11633#if defined(HAVE_FPATHCONF) || defined(HAVE_PATHCONF)
Fred Drakebec628d1999-12-15 18:31:10 +000011634 if (setup_confname_table(posix_constants_pathconf,
Fred Draked86ed291999-12-15 15:34:33 +000011635 sizeof(posix_constants_pathconf)
11636 / sizeof(struct constdef),
Fred Drake4d1e64b2002-04-15 19:40:07 +000011637 "pathconf_names", module))
Stefan Krah0e803b32010-11-26 16:16:47 +000011638 return -1;
Fred Draked86ed291999-12-15 15:34:33 +000011639#endif
11640#ifdef HAVE_CONFSTR
Fred Drakebec628d1999-12-15 18:31:10 +000011641 if (setup_confname_table(posix_constants_confstr,
Fred Draked86ed291999-12-15 15:34:33 +000011642 sizeof(posix_constants_confstr)
11643 / sizeof(struct constdef),
Fred Drake4d1e64b2002-04-15 19:40:07 +000011644 "confstr_names", module))
Stefan Krah0e803b32010-11-26 16:16:47 +000011645 return -1;
Fred Draked86ed291999-12-15 15:34:33 +000011646#endif
11647#ifdef HAVE_SYSCONF
Fred Drakebec628d1999-12-15 18:31:10 +000011648 if (setup_confname_table(posix_constants_sysconf,
Fred Draked86ed291999-12-15 15:34:33 +000011649 sizeof(posix_constants_sysconf)
11650 / sizeof(struct constdef),
Fred Drake4d1e64b2002-04-15 19:40:07 +000011651 "sysconf_names", module))
Stefan Krah0e803b32010-11-26 16:16:47 +000011652 return -1;
Fred Draked86ed291999-12-15 15:34:33 +000011653#endif
Fred Drakebec628d1999-12-15 18:31:10 +000011654 return 0;
Fred Draked86ed291999-12-15 15:34:33 +000011655}
Fred Draked86ed291999-12-15 15:34:33 +000011656
11657
Larry Hastings2f936352014-08-05 14:04:04 +100011658/*[clinic input]
11659os.abort
11660
11661Abort the interpreter immediately.
11662
11663This function 'dumps core' or otherwise fails in the hardest way possible
11664on the hosting operating system. This function never returns.
11665[clinic start generated code]*/
11666
Larry Hastings2f936352014-08-05 14:04:04 +100011667static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011668os_abort_impl(PyObject *module)
11669/*[clinic end generated code: output=dcf52586dad2467c input=cf2c7d98bc504047]*/
Fred Drake5ab8eaf1999-12-09 21:13:07 +000011670{
Fred Drake5ab8eaf1999-12-09 21:13:07 +000011671 abort();
11672 /*NOTREACHED*/
Victor Stinner9a2329f2016-12-05 17:56:36 +010011673#ifndef __clang__
11674 /* Issue #28152: abort() is declared with __attribute__((__noreturn__)).
11675 GCC emits a warning without "return NULL;" (compiler bug?), but Clang
11676 is smarter and emits a warning on the return. */
Fred Drake5ab8eaf1999-12-09 21:13:07 +000011677 Py_FatalError("abort() called from Python code didn't abort!");
11678 return NULL;
Victor Stinner9a2329f2016-12-05 17:56:36 +010011679#endif
Fred Drake5ab8eaf1999-12-09 21:13:07 +000011680}
Fred Drakebec628d1999-12-15 18:31:10 +000011681
Martin v. Löwis6238d2b2002-06-30 15:26:10 +000011682#ifdef MS_WINDOWS
Steve Dower7d0e0c92015-01-24 08:18:24 -080011683/* Grab ShellExecute dynamically from shell32 */
11684static int has_ShellExecute = -1;
Steve Dower7d0e0c92015-01-24 08:18:24 -080011685static HINSTANCE (CALLBACK *Py_ShellExecuteW)(HWND, LPCWSTR, LPCWSTR, LPCWSTR,
11686 LPCWSTR, INT);
11687static int
11688check_ShellExecute()
11689{
11690 HINSTANCE hShell32;
11691
11692 /* only recheck */
11693 if (-1 == has_ShellExecute) {
11694 Py_BEGIN_ALLOW_THREADS
Victor Stinnera9912152017-10-13 13:46:57 -070011695 /* Security note: this call is not vulnerable to "DLL hijacking".
11696 SHELL32 is part of "KnownDLLs" and so Windows always load
11697 the system SHELL32.DLL, even if there is another SHELL32.DLL
11698 in the DLL search path. */
Steve Dower7d0e0c92015-01-24 08:18:24 -080011699 hShell32 = LoadLibraryW(L"SHELL32");
Steve Dower7d0e0c92015-01-24 08:18:24 -080011700 if (hShell32) {
Steve Dower7d0e0c92015-01-24 08:18:24 -080011701 *(FARPROC*)&Py_ShellExecuteW = GetProcAddress(hShell32,
11702 "ShellExecuteW");
Steve Dowercc16be82016-09-08 10:35:16 -070011703 has_ShellExecute = Py_ShellExecuteW != NULL;
Steve Dower7d0e0c92015-01-24 08:18:24 -080011704 } else {
11705 has_ShellExecute = 0;
11706 }
Tony Roberts4860f012019-02-02 18:16:42 +010011707 Py_END_ALLOW_THREADS
Steve Dower7d0e0c92015-01-24 08:18:24 -080011708 }
11709 return has_ShellExecute;
11710}
11711
11712
Steve Dowercc16be82016-09-08 10:35:16 -070011713/*[clinic input]
11714os.startfile
11715 filepath: path_t
11716 operation: Py_UNICODE = NULL
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +000011717
Steve Dowercc16be82016-09-08 10:35:16 -070011718Start a file with its associated application.
11719
11720When "operation" is not specified or "open", this acts like
11721double-clicking the file in Explorer, or giving the file name as an
11722argument to the DOS "start" command: the file is opened with whatever
11723application (if any) its extension is associated.
11724When another "operation" is given, it specifies what should be done with
11725the file. A typical operation is "print".
11726
11727startfile returns as soon as the associated application is launched.
11728There is no option to wait for the application to close, and no way
11729to retrieve the application's exit status.
11730
11731The filepath is relative to the current directory. If you want to use
11732an absolute path, make sure the first character is not a slash ("/");
11733the underlying Win32 ShellExecute function doesn't work if it is.
11734[clinic start generated code]*/
11735
11736static PyObject *
Serhiy Storchakaafb3e712018-12-14 11:19:51 +020011737os_startfile_impl(PyObject *module, path_t *filepath,
11738 const Py_UNICODE *operation)
Serhiy Storchakad322abb2019-09-14 13:31:50 +030011739/*[clinic end generated code: output=66dc311c94d50797 input=c940888a5390f039]*/
Steve Dowercc16be82016-09-08 10:35:16 -070011740{
11741 HINSTANCE rc;
Steve Dower7d0e0c92015-01-24 08:18:24 -080011742
11743 if(!check_ShellExecute()) {
11744 /* If the OS doesn't have ShellExecute, return a
11745 NotImplementedError. */
11746 return PyErr_Format(PyExc_NotImplementedError,
11747 "startfile not available on this platform");
11748 }
11749
Steve Dowera00b5be2020-02-13 08:30:27 +000011750 if (PySys_Audit("os.startfile", "Ou", filepath->object, operation) < 0) {
Miss Islington (bot)3498ac52020-02-04 16:32:32 -080011751 return NULL;
11752 }
11753
Victor Stinner8c62be82010-05-06 00:08:46 +000011754 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -070011755 rc = Py_ShellExecuteW((HWND)0, operation, filepath->wide,
Steve Dower7d0e0c92015-01-24 08:18:24 -080011756 NULL, NULL, SW_SHOWNORMAL);
Victor Stinner8c62be82010-05-06 00:08:46 +000011757 Py_END_ALLOW_THREADS
11758
Victor Stinner8c62be82010-05-06 00:08:46 +000011759 if (rc <= (HINSTANCE)32) {
Steve Dowercc16be82016-09-08 10:35:16 -070011760 win32_error_object("startfile", filepath->object);
Victor Stinnereb5657a2011-09-30 01:44:27 +020011761 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +000011762 }
Steve Dowercc16be82016-09-08 10:35:16 -070011763 Py_RETURN_NONE;
Tim Petersf58a7aa2000-09-22 10:05:54 +000011764}
Larry Hastings2f936352014-08-05 14:04:04 +100011765#endif /* MS_WINDOWS */
11766
Fred Drake5ab8eaf1999-12-09 21:13:07 +000011767
Martin v. Löwis438b5342002-12-27 10:16:42 +000011768#ifdef HAVE_GETLOADAVG
Larry Hastings2f936352014-08-05 14:04:04 +100011769/*[clinic input]
11770os.getloadavg
11771
11772Return average recent system load information.
11773
11774Return the number of processes in the system run queue averaged over
11775the last 1, 5, and 15 minutes as a tuple of three floats.
11776Raises OSError if the load average was unobtainable.
11777[clinic start generated code]*/
11778
Larry Hastings2f936352014-08-05 14:04:04 +100011779static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011780os_getloadavg_impl(PyObject *module)
11781/*[clinic end generated code: output=9ad3a11bfb4f4bd2 input=3d6d826b76d8a34e]*/
Martin v. Löwis438b5342002-12-27 10:16:42 +000011782{
11783 double loadavg[3];
Martin v. Löwis438b5342002-12-27 10:16:42 +000011784 if (getloadavg(loadavg, 3)!=3) {
Stefan Krah0e803b32010-11-26 16:16:47 +000011785 PyErr_SetString(PyExc_OSError, "Load averages are unobtainable");
11786 return NULL;
Martin v. Löwis438b5342002-12-27 10:16:42 +000011787 } else
Stefan Krah0e803b32010-11-26 16:16:47 +000011788 return Py_BuildValue("ddd", loadavg[0], loadavg[1], loadavg[2]);
Martin v. Löwis438b5342002-12-27 10:16:42 +000011789}
Larry Hastings2f936352014-08-05 14:04:04 +100011790#endif /* HAVE_GETLOADAVG */
Martin v. Löwis438b5342002-12-27 10:16:42 +000011791
Larry Hastings2f936352014-08-05 14:04:04 +100011792
11793/*[clinic input]
11794os.device_encoding
11795 fd: int
11796
11797Return a string describing the encoding of a terminal's file descriptor.
11798
11799The file descriptor must be attached to a terminal.
11800If the device is not a terminal, return None.
11801[clinic start generated code]*/
11802
Larry Hastings2f936352014-08-05 14:04:04 +100011803static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011804os_device_encoding_impl(PyObject *module, int fd)
11805/*[clinic end generated code: output=e0d294bbab7e8c2b input=9e1d4a42b66df312]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011806{
Brett Cannonefb00c02012-02-29 18:31:31 -050011807 return _Py_device_encoding(fd);
Martin v. Löwisd1cd4d42007-08-11 14:02:14 +000011808}
11809
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011810
Larry Hastings2f936352014-08-05 14:04:04 +100011811#ifdef HAVE_SETRESUID
11812/*[clinic input]
11813os.setresuid
11814
11815 ruid: uid_t
11816 euid: uid_t
11817 suid: uid_t
11818 /
11819
11820Set the current process's real, effective, and saved user ids.
11821[clinic start generated code]*/
11822
Larry Hastings2f936352014-08-05 14:04:04 +100011823static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011824os_setresuid_impl(PyObject *module, uid_t ruid, uid_t euid, uid_t suid)
11825/*[clinic end generated code: output=834a641e15373e97 input=9e33cb79a82792f3]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011826{
Victor Stinner8c62be82010-05-06 00:08:46 +000011827 if (setresuid(ruid, euid, suid) < 0)
11828 return posix_error();
11829 Py_RETURN_NONE;
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011830}
Larry Hastings2f936352014-08-05 14:04:04 +100011831#endif /* HAVE_SETRESUID */
11832
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011833
11834#ifdef HAVE_SETRESGID
Larry Hastings2f936352014-08-05 14:04:04 +100011835/*[clinic input]
11836os.setresgid
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011837
Larry Hastings2f936352014-08-05 14:04:04 +100011838 rgid: gid_t
11839 egid: gid_t
11840 sgid: gid_t
11841 /
11842
11843Set the current process's real, effective, and saved group ids.
11844[clinic start generated code]*/
11845
Larry Hastings2f936352014-08-05 14:04:04 +100011846static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011847os_setresgid_impl(PyObject *module, gid_t rgid, gid_t egid, gid_t sgid)
11848/*[clinic end generated code: output=6aa402f3d2e514a9 input=33e9e0785ef426b1]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011849{
Victor Stinner8c62be82010-05-06 00:08:46 +000011850 if (setresgid(rgid, egid, sgid) < 0)
11851 return posix_error();
11852 Py_RETURN_NONE;
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011853}
Larry Hastings2f936352014-08-05 14:04:04 +100011854#endif /* HAVE_SETRESGID */
11855
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011856
11857#ifdef HAVE_GETRESUID
Larry Hastings2f936352014-08-05 14:04:04 +100011858/*[clinic input]
11859os.getresuid
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011860
Larry Hastings2f936352014-08-05 14:04:04 +100011861Return a tuple of the current process's real, effective, and saved user ids.
11862[clinic start generated code]*/
11863
Larry Hastings2f936352014-08-05 14:04:04 +100011864static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011865os_getresuid_impl(PyObject *module)
11866/*[clinic end generated code: output=8e0becff5dece5bf input=41ccfa8e1f6517ad]*/
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011867{
Victor Stinner8c62be82010-05-06 00:08:46 +000011868 uid_t ruid, euid, suid;
Victor Stinner8c62be82010-05-06 00:08:46 +000011869 if (getresuid(&ruid, &euid, &suid) < 0)
11870 return posix_error();
Serhiy Storchaka7cf55992013-02-10 21:56:49 +020011871 return Py_BuildValue("(NNN)", _PyLong_FromUid(ruid),
11872 _PyLong_FromUid(euid),
11873 _PyLong_FromUid(suid));
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011874}
Larry Hastings2f936352014-08-05 14:04:04 +100011875#endif /* HAVE_GETRESUID */
11876
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011877
11878#ifdef HAVE_GETRESGID
Larry Hastings2f936352014-08-05 14:04:04 +100011879/*[clinic input]
11880os.getresgid
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011881
Larry Hastings2f936352014-08-05 14:04:04 +100011882Return a tuple of the current process's real, effective, and saved group ids.
11883[clinic start generated code]*/
11884
Larry Hastings2f936352014-08-05 14:04:04 +100011885static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011886os_getresgid_impl(PyObject *module)
11887/*[clinic end generated code: output=2719c4bfcf27fb9f input=517e68db9ca32df6]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011888{
11889 gid_t rgid, egid, sgid;
Victor Stinner8c62be82010-05-06 00:08:46 +000011890 if (getresgid(&rgid, &egid, &sgid) < 0)
11891 return posix_error();
Serhiy Storchaka7cf55992013-02-10 21:56:49 +020011892 return Py_BuildValue("(NNN)", _PyLong_FromGid(rgid),
11893 _PyLong_FromGid(egid),
11894 _PyLong_FromGid(sgid));
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011895}
Larry Hastings2f936352014-08-05 14:04:04 +100011896#endif /* HAVE_GETRESGID */
11897
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011898
Benjamin Peterson9428d532011-09-14 11:45:52 -040011899#ifdef USE_XATTRS
Larry Hastings2f936352014-08-05 14:04:04 +100011900/*[clinic input]
11901os.getxattr
Benjamin Peterson799bd802011-08-31 22:15:17 -040011902
Larry Hastings2f936352014-08-05 14:04:04 +100011903 path: path_t(allow_fd=True)
11904 attribute: path_t
11905 *
11906 follow_symlinks: bool = True
11907
11908Return the value of extended attribute attribute on path.
11909
BNMetricsb9427072018-11-02 15:20:19 +000011910path may be either a string, a path-like object, or an open file descriptor.
Larry Hastings2f936352014-08-05 14:04:04 +100011911If follow_symlinks is False, and the last element of the path is a symbolic
11912 link, getxattr will examine the symbolic link itself instead of the file
11913 the link points to.
11914
11915[clinic start generated code]*/
11916
Larry Hastings2f936352014-08-05 14:04:04 +100011917static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011918os_getxattr_impl(PyObject *module, path_t *path, path_t *attribute,
Larry Hastings89964c42015-04-14 18:07:59 -040011919 int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +000011920/*[clinic end generated code: output=5f2f44200a43cff2 input=025789491708f7eb]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011921{
11922 Py_ssize_t i;
11923 PyObject *buffer = NULL;
11924
11925 if (fd_and_follow_symlinks_invalid("getxattr", path->fd, follow_symlinks))
11926 return NULL;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011927
Steve Dowera00b5be2020-02-13 08:30:27 +000011928 if (PySys_Audit("os.getxattr", "OO", path->object, attribute->object) < 0) {
11929 return NULL;
11930 }
11931
Larry Hastings9cf065c2012-06-22 16:30:09 -070011932 for (i = 0; ; i++) {
11933 void *ptr;
11934 ssize_t result;
Serhiy Storchaka2d06e842015-12-25 19:53:18 +020011935 static const Py_ssize_t buffer_sizes[] = {128, XATTR_SIZE_MAX, 0};
Larry Hastings9cf065c2012-06-22 16:30:09 -070011936 Py_ssize_t buffer_size = buffer_sizes[i];
11937 if (!buffer_size) {
Larry Hastings2f936352014-08-05 14:04:04 +100011938 path_error(path);
11939 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070011940 }
11941 buffer = PyBytes_FromStringAndSize(NULL, buffer_size);
11942 if (!buffer)
Larry Hastings2f936352014-08-05 14:04:04 +100011943 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070011944 ptr = PyBytes_AS_STRING(buffer);
Benjamin Peterson799bd802011-08-31 22:15:17 -040011945
Larry Hastings9cf065c2012-06-22 16:30:09 -070011946 Py_BEGIN_ALLOW_THREADS;
Larry Hastings2f936352014-08-05 14:04:04 +100011947 if (path->fd >= 0)
11948 result = fgetxattr(path->fd, attribute->narrow, ptr, buffer_size);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011949 else if (follow_symlinks)
Larry Hastings2f936352014-08-05 14:04:04 +100011950 result = getxattr(path->narrow, attribute->narrow, ptr, buffer_size);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011951 else
Larry Hastings2f936352014-08-05 14:04:04 +100011952 result = lgetxattr(path->narrow, attribute->narrow, ptr, buffer_size);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011953 Py_END_ALLOW_THREADS;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011954
Larry Hastings9cf065c2012-06-22 16:30:09 -070011955 if (result < 0) {
11956 Py_DECREF(buffer);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011957 if (errno == ERANGE)
11958 continue;
Larry Hastings2f936352014-08-05 14:04:04 +100011959 path_error(path);
11960 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070011961 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040011962
Larry Hastings9cf065c2012-06-22 16:30:09 -070011963 if (result != buffer_size) {
11964 /* Can only shrink. */
11965 _PyBytes_Resize(&buffer, result);
11966 }
11967 break;
11968 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040011969
Larry Hastings9cf065c2012-06-22 16:30:09 -070011970 return buffer;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011971}
11972
Larry Hastings2f936352014-08-05 14:04:04 +100011973
11974/*[clinic input]
11975os.setxattr
11976
11977 path: path_t(allow_fd=True)
11978 attribute: path_t
11979 value: Py_buffer
11980 flags: int = 0
11981 *
11982 follow_symlinks: bool = True
11983
11984Set extended attribute attribute on path to value.
11985
BNMetricsb9427072018-11-02 15:20:19 +000011986path may be either a string, a path-like object, or an open file descriptor.
Larry Hastings2f936352014-08-05 14:04:04 +100011987If follow_symlinks is False, and the last element of the path is a symbolic
11988 link, setxattr will modify the symbolic link itself instead of the file
11989 the link points to.
11990
11991[clinic start generated code]*/
11992
Benjamin Peterson799bd802011-08-31 22:15:17 -040011993static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011994os_setxattr_impl(PyObject *module, path_t *path, path_t *attribute,
Larry Hastings89964c42015-04-14 18:07:59 -040011995 Py_buffer *value, int flags, int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +000011996/*[clinic end generated code: output=98b83f63fdde26bb input=c17c0103009042f0]*/
Benjamin Peterson799bd802011-08-31 22:15:17 -040011997{
Larry Hastings2f936352014-08-05 14:04:04 +100011998 ssize_t result;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011999
Larry Hastings2f936352014-08-05 14:04:04 +100012000 if (fd_and_follow_symlinks_invalid("setxattr", path->fd, follow_symlinks))
Benjamin Peterson799bd802011-08-31 22:15:17 -040012001 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070012002
Steve Dowera00b5be2020-02-13 08:30:27 +000012003 if (PySys_Audit("os.setxattr", "OOy#i", path->object, attribute->object,
12004 value->buf, value->len, flags) < 0) {
12005 return NULL;
12006 }
12007
Benjamin Peterson799bd802011-08-31 22:15:17 -040012008 Py_BEGIN_ALLOW_THREADS;
Larry Hastings2f936352014-08-05 14:04:04 +100012009 if (path->fd > -1)
12010 result = fsetxattr(path->fd, attribute->narrow,
12011 value->buf, value->len, flags);
Larry Hastings9cf065c2012-06-22 16:30:09 -070012012 else if (follow_symlinks)
Larry Hastings2f936352014-08-05 14:04:04 +100012013 result = setxattr(path->narrow, attribute->narrow,
12014 value->buf, value->len, flags);
Larry Hastings9cf065c2012-06-22 16:30:09 -070012015 else
Larry Hastings2f936352014-08-05 14:04:04 +100012016 result = lsetxattr(path->narrow, attribute->narrow,
12017 value->buf, value->len, flags);
Benjamin Peterson799bd802011-08-31 22:15:17 -040012018 Py_END_ALLOW_THREADS;
Benjamin Peterson799bd802011-08-31 22:15:17 -040012019
Larry Hastings9cf065c2012-06-22 16:30:09 -070012020 if (result) {
Larry Hastings2f936352014-08-05 14:04:04 +100012021 path_error(path);
12022 return NULL;
Benjamin Peterson799bd802011-08-31 22:15:17 -040012023 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040012024
Larry Hastings2f936352014-08-05 14:04:04 +100012025 Py_RETURN_NONE;
12026}
12027
12028
12029/*[clinic input]
12030os.removexattr
12031
12032 path: path_t(allow_fd=True)
12033 attribute: path_t
12034 *
12035 follow_symlinks: bool = True
12036
12037Remove extended attribute attribute on path.
12038
BNMetricsb9427072018-11-02 15:20:19 +000012039path may be either a string, a path-like object, or an open file descriptor.
Larry Hastings2f936352014-08-05 14:04:04 +100012040If follow_symlinks is False, and the last element of the path is a symbolic
12041 link, removexattr will modify the symbolic link itself instead of the file
12042 the link points to.
12043
12044[clinic start generated code]*/
12045
Larry Hastings2f936352014-08-05 14:04:04 +100012046static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012047os_removexattr_impl(PyObject *module, path_t *path, path_t *attribute,
Larry Hastings89964c42015-04-14 18:07:59 -040012048 int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +000012049/*[clinic end generated code: output=521a51817980cda6 input=3d9a7d36fe2f7c4e]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012050{
12051 ssize_t result;
12052
12053 if (fd_and_follow_symlinks_invalid("removexattr", path->fd, follow_symlinks))
12054 return NULL;
12055
Steve Dowera00b5be2020-02-13 08:30:27 +000012056 if (PySys_Audit("os.removexattr", "OO", path->object, attribute->object) < 0) {
12057 return NULL;
12058 }
12059
Larry Hastings2f936352014-08-05 14:04:04 +100012060 Py_BEGIN_ALLOW_THREADS;
12061 if (path->fd > -1)
12062 result = fremovexattr(path->fd, attribute->narrow);
12063 else if (follow_symlinks)
12064 result = removexattr(path->narrow, attribute->narrow);
12065 else
12066 result = lremovexattr(path->narrow, attribute->narrow);
12067 Py_END_ALLOW_THREADS;
12068
12069 if (result) {
12070 return path_error(path);
12071 }
12072
12073 Py_RETURN_NONE;
12074}
12075
12076
12077/*[clinic input]
12078os.listxattr
12079
12080 path: path_t(allow_fd=True, nullable=True) = None
12081 *
12082 follow_symlinks: bool = True
12083
12084Return a list of extended attributes on path.
12085
BNMetricsb9427072018-11-02 15:20:19 +000012086path may be either None, a string, a path-like object, or an open file descriptor.
Larry Hastings2f936352014-08-05 14:04:04 +100012087if path is None, listxattr will examine the current directory.
12088If follow_symlinks is False, and the last element of the path is a symbolic
12089 link, listxattr will examine the symbolic link itself instead of the file
12090 the link points to.
12091[clinic start generated code]*/
12092
Larry Hastings2f936352014-08-05 14:04:04 +100012093static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012094os_listxattr_impl(PyObject *module, path_t *path, int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +000012095/*[clinic end generated code: output=bebdb4e2ad0ce435 input=9826edf9fdb90869]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012096{
Larry Hastings9cf065c2012-06-22 16:30:09 -070012097 Py_ssize_t i;
12098 PyObject *result = NULL;
Larry Hastings2f936352014-08-05 14:04:04 +100012099 const char *name;
Larry Hastings9cf065c2012-06-22 16:30:09 -070012100 char *buffer = NULL;
Benjamin Peterson799bd802011-08-31 22:15:17 -040012101
Larry Hastings2f936352014-08-05 14:04:04 +100012102 if (fd_and_follow_symlinks_invalid("listxattr", path->fd, follow_symlinks))
Larry Hastings9cf065c2012-06-22 16:30:09 -070012103 goto exit;
Benjamin Peterson799bd802011-08-31 22:15:17 -040012104
Steve Dowera00b5be2020-02-13 08:30:27 +000012105 if (PySys_Audit("os.listxattr", "(O)",
12106 path->object ? path->object : Py_None) < 0) {
12107 return NULL;
12108 }
12109
Larry Hastings2f936352014-08-05 14:04:04 +100012110 name = path->narrow ? path->narrow : ".";
12111
Larry Hastings9cf065c2012-06-22 16:30:09 -070012112 for (i = 0; ; i++) {
Serhiy Storchakadeab18d2016-05-07 16:45:18 +030012113 const char *start, *trace, *end;
Larry Hastings9cf065c2012-06-22 16:30:09 -070012114 ssize_t length;
Serhiy Storchaka2d06e842015-12-25 19:53:18 +020012115 static const Py_ssize_t buffer_sizes[] = { 256, XATTR_LIST_MAX, 0 };
Larry Hastings9cf065c2012-06-22 16:30:09 -070012116 Py_ssize_t buffer_size = buffer_sizes[i];
12117 if (!buffer_size) {
Christian Heimes3b9493b2012-09-23 16:11:15 +020012118 /* ERANGE */
Larry Hastings2f936352014-08-05 14:04:04 +100012119 path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -070012120 break;
12121 }
12122 buffer = PyMem_MALLOC(buffer_size);
12123 if (!buffer) {
12124 PyErr_NoMemory();
12125 break;
12126 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040012127
Larry Hastings9cf065c2012-06-22 16:30:09 -070012128 Py_BEGIN_ALLOW_THREADS;
Larry Hastings2f936352014-08-05 14:04:04 +100012129 if (path->fd > -1)
12130 length = flistxattr(path->fd, buffer, buffer_size);
Larry Hastings9cf065c2012-06-22 16:30:09 -070012131 else if (follow_symlinks)
12132 length = listxattr(name, buffer, buffer_size);
12133 else
12134 length = llistxattr(name, buffer, buffer_size);
12135 Py_END_ALLOW_THREADS;
Benjamin Peterson799bd802011-08-31 22:15:17 -040012136
Larry Hastings9cf065c2012-06-22 16:30:09 -070012137 if (length < 0) {
Antoine Pitrou7f987392013-05-13 19:46:29 +020012138 if (errno == ERANGE) {
12139 PyMem_FREE(buffer);
Benjamin Petersondedac522013-05-13 19:55:40 -050012140 buffer = NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070012141 continue;
Antoine Pitrou7f987392013-05-13 19:46:29 +020012142 }
Larry Hastings2f936352014-08-05 14:04:04 +100012143 path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -070012144 break;
12145 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040012146
Larry Hastings9cf065c2012-06-22 16:30:09 -070012147 result = PyList_New(0);
12148 if (!result) {
12149 goto exit;
12150 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040012151
Larry Hastings9cf065c2012-06-22 16:30:09 -070012152 end = buffer + length;
12153 for (trace = start = buffer; trace != end; trace++) {
12154 if (!*trace) {
12155 int error;
12156 PyObject *attribute = PyUnicode_DecodeFSDefaultAndSize(start,
12157 trace - start);
12158 if (!attribute) {
12159 Py_DECREF(result);
12160 result = NULL;
12161 goto exit;
12162 }
12163 error = PyList_Append(result, attribute);
12164 Py_DECREF(attribute);
12165 if (error) {
12166 Py_DECREF(result);
12167 result = NULL;
12168 goto exit;
12169 }
12170 start = trace + 1;
12171 }
12172 }
12173 break;
12174 }
12175exit:
Larry Hastings9cf065c2012-06-22 16:30:09 -070012176 if (buffer)
12177 PyMem_FREE(buffer);
12178 return result;
Benjamin Peterson799bd802011-08-31 22:15:17 -040012179}
Benjamin Peterson9428d532011-09-14 11:45:52 -040012180#endif /* USE_XATTRS */
Benjamin Peterson799bd802011-08-31 22:15:17 -040012181
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012182
Larry Hastings2f936352014-08-05 14:04:04 +100012183/*[clinic input]
12184os.urandom
12185
12186 size: Py_ssize_t
12187 /
12188
12189Return a bytes object containing random bytes suitable for cryptographic use.
12190[clinic start generated code]*/
12191
Larry Hastings2f936352014-08-05 14:04:04 +100012192static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012193os_urandom_impl(PyObject *module, Py_ssize_t size)
12194/*[clinic end generated code: output=42c5cca9d18068e9 input=4067cdb1b6776c29]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012195{
12196 PyObject *bytes;
12197 int result;
12198
Georg Brandl2fb477c2012-02-21 00:33:36 +010012199 if (size < 0)
12200 return PyErr_Format(PyExc_ValueError,
12201 "negative argument not allowed");
Larry Hastings2f936352014-08-05 14:04:04 +100012202 bytes = PyBytes_FromStringAndSize(NULL, size);
12203 if (bytes == NULL)
Georg Brandl2fb477c2012-02-21 00:33:36 +010012204 return NULL;
12205
Victor Stinnere66987e2016-09-06 16:33:52 -070012206 result = _PyOS_URandom(PyBytes_AS_STRING(bytes), PyBytes_GET_SIZE(bytes));
Larry Hastings2f936352014-08-05 14:04:04 +100012207 if (result == -1) {
12208 Py_DECREF(bytes);
Georg Brandl2fb477c2012-02-21 00:33:36 +010012209 return NULL;
12210 }
Larry Hastings2f936352014-08-05 14:04:04 +100012211 return bytes;
Georg Brandl2fb477c2012-02-21 00:33:36 +010012212}
12213
Zackery Spytz43fdbd22019-05-29 13:57:07 -060012214#ifdef HAVE_MEMFD_CREATE
12215/*[clinic input]
12216os.memfd_create
12217
12218 name: FSConverter
12219 flags: unsigned_int(bitwise=True, c_default="MFD_CLOEXEC") = MFD_CLOEXEC
12220
12221[clinic start generated code]*/
12222
12223static PyObject *
12224os_memfd_create_impl(PyObject *module, PyObject *name, unsigned int flags)
12225/*[clinic end generated code: output=6681ede983bdb9a6 input=a42cfc199bcd56e9]*/
12226{
12227 int fd;
12228 const char *bytes = PyBytes_AS_STRING(name);
12229 Py_BEGIN_ALLOW_THREADS
12230 fd = memfd_create(bytes, flags);
12231 Py_END_ALLOW_THREADS
12232 if (fd == -1) {
12233 return PyErr_SetFromErrno(PyExc_OSError);
12234 }
12235 return PyLong_FromLong(fd);
12236}
12237#endif
12238
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012239/* Terminal size querying */
12240
Eddie Elizondo474eedf2018-11-13 04:09:31 -080012241static PyTypeObject* TerminalSizeType;
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012242
12243PyDoc_STRVAR(TerminalSize_docstring,
12244 "A tuple of (columns, lines) for holding terminal window size");
12245
12246static PyStructSequence_Field TerminalSize_fields[] = {
12247 {"columns", "width of the terminal window in characters"},
12248 {"lines", "height of the terminal window in characters"},
12249 {NULL, NULL}
12250};
12251
12252static PyStructSequence_Desc TerminalSize_desc = {
12253 "os.terminal_size",
12254 TerminalSize_docstring,
12255 TerminalSize_fields,
12256 2,
12257};
12258
12259#if defined(TERMSIZE_USE_CONIO) || defined(TERMSIZE_USE_IOCTL)
Larry Hastings2f936352014-08-05 14:04:04 +100012260/* AC 3.5: fd should accept None */
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012261PyDoc_STRVAR(termsize__doc__,
12262 "Return the size of the terminal window as (columns, lines).\n" \
12263 "\n" \
12264 "The optional argument fd (default standard output) specifies\n" \
12265 "which file descriptor should be queried.\n" \
12266 "\n" \
12267 "If the file descriptor is not connected to a terminal, an OSError\n" \
12268 "is thrown.\n" \
12269 "\n" \
12270 "This function will only be defined if an implementation is\n" \
12271 "available for this system.\n" \
12272 "\n" \
oldkaa0735f2018-02-02 16:52:55 +080012273 "shutil.get_terminal_size is the high-level function which should\n" \
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012274 "normally be used, os.get_terminal_size is the low-level implementation.");
12275
12276static PyObject*
12277get_terminal_size(PyObject *self, PyObject *args)
12278{
12279 int columns, lines;
12280 PyObject *termsize;
12281
12282 int fd = fileno(stdout);
12283 /* Under some conditions stdout may not be connected and
12284 * fileno(stdout) may point to an invalid file descriptor. For example
12285 * GUI apps don't have valid standard streams by default.
12286 *
12287 * If this happens, and the optional fd argument is not present,
12288 * the ioctl below will fail returning EBADF. This is what we want.
12289 */
12290
12291 if (!PyArg_ParseTuple(args, "|i", &fd))
12292 return NULL;
12293
12294#ifdef TERMSIZE_USE_IOCTL
12295 {
12296 struct winsize w;
12297 if (ioctl(fd, TIOCGWINSZ, &w))
12298 return PyErr_SetFromErrno(PyExc_OSError);
12299 columns = w.ws_col;
12300 lines = w.ws_row;
12301 }
12302#endif /* TERMSIZE_USE_IOCTL */
12303
12304#ifdef TERMSIZE_USE_CONIO
12305 {
12306 DWORD nhandle;
12307 HANDLE handle;
12308 CONSOLE_SCREEN_BUFFER_INFO csbi;
12309 switch (fd) {
12310 case 0: nhandle = STD_INPUT_HANDLE;
12311 break;
12312 case 1: nhandle = STD_OUTPUT_HANDLE;
12313 break;
12314 case 2: nhandle = STD_ERROR_HANDLE;
12315 break;
12316 default:
12317 return PyErr_Format(PyExc_ValueError, "bad file descriptor");
12318 }
12319 handle = GetStdHandle(nhandle);
12320 if (handle == NULL)
12321 return PyErr_Format(PyExc_OSError, "handle cannot be retrieved");
12322 if (handle == INVALID_HANDLE_VALUE)
12323 return PyErr_SetFromWindowsErr(0);
12324
12325 if (!GetConsoleScreenBufferInfo(handle, &csbi))
12326 return PyErr_SetFromWindowsErr(0);
12327
12328 columns = csbi.srWindow.Right - csbi.srWindow.Left + 1;
12329 lines = csbi.srWindow.Bottom - csbi.srWindow.Top + 1;
12330 }
12331#endif /* TERMSIZE_USE_CONIO */
12332
Eddie Elizondo474eedf2018-11-13 04:09:31 -080012333 termsize = PyStructSequence_New(TerminalSizeType);
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012334 if (termsize == NULL)
12335 return NULL;
12336 PyStructSequence_SET_ITEM(termsize, 0, PyLong_FromLong(columns));
12337 PyStructSequence_SET_ITEM(termsize, 1, PyLong_FromLong(lines));
12338 if (PyErr_Occurred()) {
12339 Py_DECREF(termsize);
12340 return NULL;
12341 }
12342 return termsize;
12343}
12344#endif /* defined(TERMSIZE_USE_CONIO) || defined(TERMSIZE_USE_IOCTL) */
12345
Larry Hastings2f936352014-08-05 14:04:04 +100012346
12347/*[clinic input]
12348os.cpu_count
12349
Charles-François Natali80d62e62015-08-13 20:37:08 +010012350Return the number of CPUs in the system; return None if indeterminable.
12351
12352This number is not equivalent to the number of CPUs the current process can
12353use. The number of usable CPUs can be obtained with
12354``len(os.sched_getaffinity(0))``
Larry Hastings2f936352014-08-05 14:04:04 +100012355[clinic start generated code]*/
12356
Larry Hastings2f936352014-08-05 14:04:04 +100012357static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012358os_cpu_count_impl(PyObject *module)
Serhiy Storchaka2954f832016-07-07 18:20:03 +030012359/*[clinic end generated code: output=5fc29463c3936a9c input=e7c8f4ba6dbbadd3]*/
Charles-Francois Natali44feda32013-05-20 14:40:46 +020012360{
Charles-Francois Natalid59087d2013-05-20 17:31:06 +020012361 int ncpu = 0;
Charles-Francois Natali44feda32013-05-20 14:40:46 +020012362#ifdef MS_WINDOWS
Miss Islington (bot)43ee0e22019-09-11 08:56:13 -070012363 /* Declare prototype here to avoid pulling in all of the Win7 APIs in 3.8 */
12364 DWORD WINAPI GetActiveProcessorCount(WORD group);
12365 ncpu = GetActiveProcessorCount(ALL_PROCESSOR_GROUPS);
Charles-Francois Natali44feda32013-05-20 14:40:46 +020012366#elif defined(__hpux)
12367 ncpu = mpctl(MPC_GETNUMSPUS, NULL, NULL);
12368#elif defined(HAVE_SYSCONF) && defined(_SC_NPROCESSORS_ONLN)
12369 ncpu = sysconf(_SC_NPROCESSORS_ONLN);
Charles-Francois Natali44feda32013-05-20 14:40:46 +020012370#elif defined(__DragonFly__) || \
12371 defined(__OpenBSD__) || \
12372 defined(__FreeBSD__) || \
Charles-Francois Natalid59087d2013-05-20 17:31:06 +020012373 defined(__NetBSD__) || \
12374 defined(__APPLE__)
Charles-Francois Natali7c4f8da2013-05-20 17:40:32 +020012375 int mib[2];
12376 size_t len = sizeof(ncpu);
12377 mib[0] = CTL_HW;
12378 mib[1] = HW_NCPU;
12379 if (sysctl(mib, 2, &ncpu, &len, NULL, 0) != 0)
12380 ncpu = 0;
Charles-Francois Natali44feda32013-05-20 14:40:46 +020012381#endif
12382 if (ncpu >= 1)
12383 return PyLong_FromLong(ncpu);
12384 else
12385 Py_RETURN_NONE;
12386}
12387
Victor Stinnerdaf45552013-08-28 00:53:59 +020012388
Larry Hastings2f936352014-08-05 14:04:04 +100012389/*[clinic input]
12390os.get_inheritable -> bool
12391
12392 fd: int
12393 /
12394
12395Get the close-on-exe flag of the specified file descriptor.
12396[clinic start generated code]*/
12397
Larry Hastings2f936352014-08-05 14:04:04 +100012398static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012399os_get_inheritable_impl(PyObject *module, int fd)
12400/*[clinic end generated code: output=0445e20e149aa5b8 input=89ac008dc9ab6b95]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012401{
Steve Dower8fc89802015-04-12 00:26:27 -040012402 int return_value;
Steve Dower8fc89802015-04-12 00:26:27 -040012403 _Py_BEGIN_SUPPRESS_IPH
12404 return_value = _Py_get_inheritable(fd);
12405 _Py_END_SUPPRESS_IPH
12406 return return_value;
Larry Hastings2f936352014-08-05 14:04:04 +100012407}
12408
12409
12410/*[clinic input]
12411os.set_inheritable
12412 fd: int
12413 inheritable: int
12414 /
12415
12416Set the inheritable flag of the specified file descriptor.
12417[clinic start generated code]*/
12418
Larry Hastings2f936352014-08-05 14:04:04 +100012419static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012420os_set_inheritable_impl(PyObject *module, int fd, int inheritable)
12421/*[clinic end generated code: output=f1b1918a2f3c38c2 input=9ceaead87a1e2402]*/
Victor Stinnerdaf45552013-08-28 00:53:59 +020012422{
Steve Dower8fc89802015-04-12 00:26:27 -040012423 int result;
Victor Stinnerdaf45552013-08-28 00:53:59 +020012424
Steve Dower8fc89802015-04-12 00:26:27 -040012425 _Py_BEGIN_SUPPRESS_IPH
12426 result = _Py_set_inheritable(fd, inheritable, NULL);
12427 _Py_END_SUPPRESS_IPH
12428 if (result < 0)
Victor Stinnerdaf45552013-08-28 00:53:59 +020012429 return NULL;
12430 Py_RETURN_NONE;
12431}
12432
12433
12434#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +100012435/*[clinic input]
12436os.get_handle_inheritable -> bool
Benjamin Petersonca470632016-09-06 13:47:26 -070012437 handle: intptr_t
Larry Hastings2f936352014-08-05 14:04:04 +100012438 /
Victor Stinnerdaf45552013-08-28 00:53:59 +020012439
Larry Hastings2f936352014-08-05 14:04:04 +100012440Get the close-on-exe flag of the specified file descriptor.
12441[clinic start generated code]*/
12442
Larry Hastings2f936352014-08-05 14:04:04 +100012443static int
Benjamin Petersonca470632016-09-06 13:47:26 -070012444os_get_handle_inheritable_impl(PyObject *module, intptr_t handle)
Victor Stinner581139c2016-09-06 15:54:20 -070012445/*[clinic end generated code: output=36be5afca6ea84d8 input=cfe99f9c05c70ad1]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012446{
12447 DWORD flags;
Victor Stinnerdaf45552013-08-28 00:53:59 +020012448
12449 if (!GetHandleInformation((HANDLE)handle, &flags)) {
12450 PyErr_SetFromWindowsErr(0);
Larry Hastings2f936352014-08-05 14:04:04 +100012451 return -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +020012452 }
12453
Larry Hastings2f936352014-08-05 14:04:04 +100012454 return flags & HANDLE_FLAG_INHERIT;
Victor Stinnerdaf45552013-08-28 00:53:59 +020012455}
12456
Victor Stinnerdaf45552013-08-28 00:53:59 +020012457
Larry Hastings2f936352014-08-05 14:04:04 +100012458/*[clinic input]
12459os.set_handle_inheritable
Benjamin Petersonca470632016-09-06 13:47:26 -070012460 handle: intptr_t
Larry Hastings2f936352014-08-05 14:04:04 +100012461 inheritable: bool
12462 /
12463
12464Set the inheritable flag of the specified handle.
12465[clinic start generated code]*/
12466
Larry Hastings2f936352014-08-05 14:04:04 +100012467static PyObject *
Benjamin Petersonca470632016-09-06 13:47:26 -070012468os_set_handle_inheritable_impl(PyObject *module, intptr_t handle,
Larry Hastings89964c42015-04-14 18:07:59 -040012469 int inheritable)
Victor Stinner581139c2016-09-06 15:54:20 -070012470/*[clinic end generated code: output=021d74fe6c96baa3 input=7a7641390d8364fc]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012471{
12472 DWORD flags = inheritable ? HANDLE_FLAG_INHERIT : 0;
Victor Stinnerdaf45552013-08-28 00:53:59 +020012473 if (!SetHandleInformation((HANDLE)handle, HANDLE_FLAG_INHERIT, flags)) {
12474 PyErr_SetFromWindowsErr(0);
12475 return NULL;
12476 }
12477 Py_RETURN_NONE;
12478}
Larry Hastings2f936352014-08-05 14:04:04 +100012479#endif /* MS_WINDOWS */
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012480
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012481#ifndef MS_WINDOWS
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030012482/*[clinic input]
12483os.get_blocking -> bool
12484 fd: int
12485 /
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012486
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030012487Get the blocking mode of the file descriptor.
12488
12489Return False if the O_NONBLOCK flag is set, True if the flag is cleared.
12490[clinic start generated code]*/
12491
12492static int
12493os_get_blocking_impl(PyObject *module, int fd)
12494/*[clinic end generated code: output=336a12ad76a61482 input=f4afb59d51560179]*/
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012495{
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012496 int blocking;
12497
Steve Dower8fc89802015-04-12 00:26:27 -040012498 _Py_BEGIN_SUPPRESS_IPH
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012499 blocking = _Py_get_blocking(fd);
Steve Dower8fc89802015-04-12 00:26:27 -040012500 _Py_END_SUPPRESS_IPH
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030012501 return blocking;
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012502}
12503
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030012504/*[clinic input]
12505os.set_blocking
12506 fd: int
12507 blocking: bool(accept={int})
12508 /
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012509
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030012510Set the blocking mode of the specified file descriptor.
12511
12512Set the O_NONBLOCK flag if blocking is False,
12513clear the O_NONBLOCK flag otherwise.
12514[clinic start generated code]*/
12515
12516static PyObject *
12517os_set_blocking_impl(PyObject *module, int fd, int blocking)
12518/*[clinic end generated code: output=384eb43aa0762a9d input=bf5c8efdc5860ff3]*/
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012519{
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030012520 int result;
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012521
Steve Dower8fc89802015-04-12 00:26:27 -040012522 _Py_BEGIN_SUPPRESS_IPH
12523 result = _Py_set_blocking(fd, blocking);
12524 _Py_END_SUPPRESS_IPH
12525 if (result < 0)
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012526 return NULL;
12527 Py_RETURN_NONE;
12528}
12529#endif /* !MS_WINDOWS */
12530
12531
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012532/*[clinic input]
12533class os.DirEntry "DirEntry *" "&DirEntryType"
12534[clinic start generated code]*/
12535/*[clinic end generated code: output=da39a3ee5e6b4b0d input=3138f09f7c683f1d]*/
Victor Stinner6036e442015-03-08 01:58:04 +010012536
12537typedef struct {
12538 PyObject_HEAD
12539 PyObject *name;
12540 PyObject *path;
12541 PyObject *stat;
12542 PyObject *lstat;
12543#ifdef MS_WINDOWS
12544 struct _Py_stat_struct win32_lstat;
Victor Stinner0f6d7332017-03-09 17:34:28 +010012545 uint64_t win32_file_index;
Victor Stinner6036e442015-03-08 01:58:04 +010012546 int got_file_index;
12547#else /* POSIX */
Victor Stinner35a97c02015-03-08 02:59:09 +010012548#ifdef HAVE_DIRENT_D_TYPE
Victor Stinner6036e442015-03-08 01:58:04 +010012549 unsigned char d_type;
Victor Stinner35a97c02015-03-08 02:59:09 +010012550#endif
Victor Stinner6036e442015-03-08 01:58:04 +010012551 ino_t d_ino;
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012552 int dir_fd;
Victor Stinner6036e442015-03-08 01:58:04 +010012553#endif
12554} DirEntry;
12555
12556static void
12557DirEntry_dealloc(DirEntry *entry)
12558{
12559 Py_XDECREF(entry->name);
12560 Py_XDECREF(entry->path);
12561 Py_XDECREF(entry->stat);
12562 Py_XDECREF(entry->lstat);
12563 Py_TYPE(entry)->tp_free((PyObject *)entry);
12564}
12565
12566/* Forward reference */
12567static int
12568DirEntry_test_mode(DirEntry *self, int follow_symlinks, unsigned short mode_bits);
12569
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012570/*[clinic input]
12571os.DirEntry.is_symlink -> bool
12572
12573Return True if the entry is a symbolic link; cached per entry.
12574[clinic start generated code]*/
12575
Victor Stinner6036e442015-03-08 01:58:04 +010012576static int
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012577os_DirEntry_is_symlink_impl(DirEntry *self)
12578/*[clinic end generated code: output=42244667d7bcfc25 input=1605a1b4b96976c3]*/
Victor Stinner6036e442015-03-08 01:58:04 +010012579{
12580#ifdef MS_WINDOWS
12581 return (self->win32_lstat.st_mode & S_IFMT) == S_IFLNK;
Victor Stinner35a97c02015-03-08 02:59:09 +010012582#elif defined(HAVE_DIRENT_D_TYPE)
12583 /* POSIX */
Victor Stinner6036e442015-03-08 01:58:04 +010012584 if (self->d_type != DT_UNKNOWN)
12585 return self->d_type == DT_LNK;
12586 else
12587 return DirEntry_test_mode(self, 0, S_IFLNK);
Victor Stinner35a97c02015-03-08 02:59:09 +010012588#else
12589 /* POSIX without d_type */
12590 return DirEntry_test_mode(self, 0, S_IFLNK);
Victor Stinner6036e442015-03-08 01:58:04 +010012591#endif
12592}
12593
12594static PyObject *
Victor Stinner6036e442015-03-08 01:58:04 +010012595DirEntry_fetch_stat(DirEntry *self, int follow_symlinks)
12596{
12597 int result;
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012598 STRUCT_STAT st;
12599 PyObject *ub;
Victor Stinner6036e442015-03-08 01:58:04 +010012600
12601#ifdef MS_WINDOWS
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012602 if (!PyUnicode_FSDecoder(self->path, &ub))
12603 return NULL;
12604 const wchar_t *path = PyUnicode_AsUnicode(ub);
Victor Stinner6036e442015-03-08 01:58:04 +010012605#else /* POSIX */
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012606 if (!PyUnicode_FSConverter(self->path, &ub))
12607 return NULL;
12608 const char *path = PyBytes_AS_STRING(ub);
12609 if (self->dir_fd != DEFAULT_DIR_FD) {
12610#ifdef HAVE_FSTATAT
12611 result = fstatat(self->dir_fd, path, &st,
12612 follow_symlinks ? 0 : AT_SYMLINK_NOFOLLOW);
12613#else
12614 PyErr_SetString(PyExc_NotImplementedError, "can't fetch stat");
12615 return NULL;
12616#endif /* HAVE_FSTATAT */
12617 }
12618 else
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012619#endif
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012620 {
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012621 if (follow_symlinks)
12622 result = STAT(path, &st);
12623 else
12624 result = LSTAT(path, &st);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012625 }
12626 Py_DECREF(ub);
Victor Stinner6036e442015-03-08 01:58:04 +010012627
12628 if (result != 0)
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012629 return path_object_error(self->path);
Victor Stinner6036e442015-03-08 01:58:04 +010012630
12631 return _pystat_fromstructstat(&st);
12632}
12633
12634static PyObject *
12635DirEntry_get_lstat(DirEntry *self)
12636{
12637 if (!self->lstat) {
12638#ifdef MS_WINDOWS
12639 self->lstat = _pystat_fromstructstat(&self->win32_lstat);
12640#else /* POSIX */
12641 self->lstat = DirEntry_fetch_stat(self, 0);
12642#endif
12643 }
12644 Py_XINCREF(self->lstat);
12645 return self->lstat;
12646}
12647
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012648/*[clinic input]
12649os.DirEntry.stat
12650 *
12651 follow_symlinks: bool = True
12652
12653Return stat_result object for the entry; cached per entry.
12654[clinic start generated code]*/
12655
Victor Stinner6036e442015-03-08 01:58:04 +010012656static PyObject *
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012657os_DirEntry_stat_impl(DirEntry *self, int follow_symlinks)
12658/*[clinic end generated code: output=008593b3a6d01305 input=280d14c1d6f1d00d]*/
Victor Stinner6036e442015-03-08 01:58:04 +010012659{
12660 if (!follow_symlinks)
12661 return DirEntry_get_lstat(self);
12662
12663 if (!self->stat) {
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012664 int result = os_DirEntry_is_symlink_impl(self);
Victor Stinner6036e442015-03-08 01:58:04 +010012665 if (result == -1)
12666 return NULL;
12667 else if (result)
12668 self->stat = DirEntry_fetch_stat(self, 1);
12669 else
12670 self->stat = DirEntry_get_lstat(self);
12671 }
12672
12673 Py_XINCREF(self->stat);
12674 return self->stat;
12675}
12676
Victor Stinner6036e442015-03-08 01:58:04 +010012677/* Set exception and return -1 on error, 0 for False, 1 for True */
12678static int
12679DirEntry_test_mode(DirEntry *self, int follow_symlinks, unsigned short mode_bits)
12680{
12681 PyObject *stat = NULL;
12682 PyObject *st_mode = NULL;
12683 long mode;
12684 int result;
Victor Stinner35a97c02015-03-08 02:59:09 +010012685#if defined(MS_WINDOWS) || defined(HAVE_DIRENT_D_TYPE)
Victor Stinner6036e442015-03-08 01:58:04 +010012686 int is_symlink;
12687 int need_stat;
Victor Stinner35a97c02015-03-08 02:59:09 +010012688#endif
Victor Stinner6036e442015-03-08 01:58:04 +010012689#ifdef MS_WINDOWS
12690 unsigned long dir_bits;
12691#endif
Victor Stinner35a97c02015-03-08 02:59:09 +010012692 _Py_IDENTIFIER(st_mode);
Victor Stinner6036e442015-03-08 01:58:04 +010012693
12694#ifdef MS_WINDOWS
12695 is_symlink = (self->win32_lstat.st_mode & S_IFMT) == S_IFLNK;
12696 need_stat = follow_symlinks && is_symlink;
Victor Stinner35a97c02015-03-08 02:59:09 +010012697#elif defined(HAVE_DIRENT_D_TYPE)
Victor Stinner6036e442015-03-08 01:58:04 +010012698 is_symlink = self->d_type == DT_LNK;
12699 need_stat = self->d_type == DT_UNKNOWN || (follow_symlinks && is_symlink);
12700#endif
12701
Victor Stinner35a97c02015-03-08 02:59:09 +010012702#if defined(MS_WINDOWS) || defined(HAVE_DIRENT_D_TYPE)
Victor Stinner6036e442015-03-08 01:58:04 +010012703 if (need_stat) {
Victor Stinner35a97c02015-03-08 02:59:09 +010012704#endif
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012705 stat = os_DirEntry_stat_impl(self, follow_symlinks);
Victor Stinner6036e442015-03-08 01:58:04 +010012706 if (!stat) {
12707 if (PyErr_ExceptionMatches(PyExc_FileNotFoundError)) {
12708 /* If file doesn't exist (anymore), then return False
12709 (i.e., say it's not a file/directory) */
12710 PyErr_Clear();
12711 return 0;
12712 }
12713 goto error;
12714 }
12715 st_mode = _PyObject_GetAttrId(stat, &PyId_st_mode);
12716 if (!st_mode)
12717 goto error;
12718
12719 mode = PyLong_AsLong(st_mode);
12720 if (mode == -1 && PyErr_Occurred())
12721 goto error;
12722 Py_CLEAR(st_mode);
12723 Py_CLEAR(stat);
12724 result = (mode & S_IFMT) == mode_bits;
Victor Stinner35a97c02015-03-08 02:59:09 +010012725#if defined(MS_WINDOWS) || defined(HAVE_DIRENT_D_TYPE)
Victor Stinner6036e442015-03-08 01:58:04 +010012726 }
12727 else if (is_symlink) {
12728 assert(mode_bits != S_IFLNK);
12729 result = 0;
12730 }
12731 else {
12732 assert(mode_bits == S_IFDIR || mode_bits == S_IFREG);
12733#ifdef MS_WINDOWS
12734 dir_bits = self->win32_lstat.st_file_attributes & FILE_ATTRIBUTE_DIRECTORY;
12735 if (mode_bits == S_IFDIR)
12736 result = dir_bits != 0;
12737 else
12738 result = dir_bits == 0;
12739#else /* POSIX */
12740 if (mode_bits == S_IFDIR)
12741 result = self->d_type == DT_DIR;
12742 else
12743 result = self->d_type == DT_REG;
12744#endif
12745 }
Victor Stinner35a97c02015-03-08 02:59:09 +010012746#endif
Victor Stinner6036e442015-03-08 01:58:04 +010012747
12748 return result;
12749
12750error:
12751 Py_XDECREF(st_mode);
12752 Py_XDECREF(stat);
12753 return -1;
12754}
12755
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012756/*[clinic input]
12757os.DirEntry.is_dir -> bool
12758 *
12759 follow_symlinks: bool = True
Victor Stinner6036e442015-03-08 01:58:04 +010012760
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012761Return True if the entry is a directory; cached per entry.
12762[clinic start generated code]*/
12763
12764static int
12765os_DirEntry_is_dir_impl(DirEntry *self, int follow_symlinks)
12766/*[clinic end generated code: output=ad2e8d54365da287 input=0135232766f53f58]*/
12767{
12768 return DirEntry_test_mode(self, follow_symlinks, S_IFDIR);
Victor Stinner6036e442015-03-08 01:58:04 +010012769}
12770
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012771/*[clinic input]
12772os.DirEntry.is_file -> bool
12773 *
12774 follow_symlinks: bool = True
12775
12776Return True if the entry is a file; cached per entry.
12777[clinic start generated code]*/
12778
12779static int
12780os_DirEntry_is_file_impl(DirEntry *self, int follow_symlinks)
12781/*[clinic end generated code: output=8462ade481d8a476 input=0dc90be168b041ee]*/
Victor Stinner6036e442015-03-08 01:58:04 +010012782{
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012783 return DirEntry_test_mode(self, follow_symlinks, S_IFREG);
Victor Stinner6036e442015-03-08 01:58:04 +010012784}
12785
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012786/*[clinic input]
12787os.DirEntry.inode
Victor Stinner6036e442015-03-08 01:58:04 +010012788
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012789Return inode of the entry; cached per entry.
12790[clinic start generated code]*/
Victor Stinner6036e442015-03-08 01:58:04 +010012791
12792static PyObject *
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012793os_DirEntry_inode_impl(DirEntry *self)
12794/*[clinic end generated code: output=156bb3a72162440e input=3ee7b872ae8649f0]*/
Victor Stinner6036e442015-03-08 01:58:04 +010012795{
12796#ifdef MS_WINDOWS
12797 if (!self->got_file_index) {
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012798 PyObject *unicode;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +030012799 const wchar_t *path;
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012800 STRUCT_STAT stat;
12801 int result;
Victor Stinner6036e442015-03-08 01:58:04 +010012802
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012803 if (!PyUnicode_FSDecoder(self->path, &unicode))
Victor Stinner6036e442015-03-08 01:58:04 +010012804 return NULL;
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012805 path = PyUnicode_AsUnicode(unicode);
12806 result = LSTAT(path, &stat);
12807 Py_DECREF(unicode);
Victor Stinner6036e442015-03-08 01:58:04 +010012808
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012809 if (result != 0)
12810 return path_object_error(self->path);
Victor Stinner6036e442015-03-08 01:58:04 +010012811
12812 self->win32_file_index = stat.st_ino;
12813 self->got_file_index = 1;
12814 }
Victor Stinner0f6d7332017-03-09 17:34:28 +010012815 Py_BUILD_ASSERT(sizeof(unsigned long long) >= sizeof(self->win32_file_index));
12816 return PyLong_FromUnsignedLongLong(self->win32_file_index);
Victor Stinner6036e442015-03-08 01:58:04 +010012817#else /* POSIX */
xdegaye50e86032017-05-22 11:15:08 +020012818 Py_BUILD_ASSERT(sizeof(unsigned long long) >= sizeof(self->d_ino));
12819 return PyLong_FromUnsignedLongLong(self->d_ino);
Victor Stinner6036e442015-03-08 01:58:04 +010012820#endif
12821}
12822
12823static PyObject *
12824DirEntry_repr(DirEntry *self)
12825{
12826 return PyUnicode_FromFormat("<DirEntry %R>", self->name);
12827}
12828
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012829/*[clinic input]
12830os.DirEntry.__fspath__
12831
12832Returns the path for the entry.
12833[clinic start generated code]*/
12834
Brett Cannon96881cd2016-06-10 14:37:21 -070012835static PyObject *
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012836os_DirEntry___fspath___impl(DirEntry *self)
12837/*[clinic end generated code: output=6dd7f7ef752e6f4f input=3c49d0cf38df4fac]*/
Brett Cannon96881cd2016-06-10 14:37:21 -070012838{
12839 Py_INCREF(self->path);
12840 return self->path;
12841}
12842
Victor Stinner6036e442015-03-08 01:58:04 +010012843static PyMemberDef DirEntry_members[] = {
12844 {"name", T_OBJECT_EX, offsetof(DirEntry, name), READONLY,
12845 "the entry's base filename, relative to scandir() \"path\" argument"},
12846 {"path", T_OBJECT_EX, offsetof(DirEntry, path), READONLY,
12847 "the entry's full path name; equivalent to os.path.join(scandir_path, entry.name)"},
12848 {NULL}
12849};
12850
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012851#include "clinic/posixmodule.c.h"
12852
Victor Stinner6036e442015-03-08 01:58:04 +010012853static PyMethodDef DirEntry_methods[] = {
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012854 OS_DIRENTRY_IS_DIR_METHODDEF
12855 OS_DIRENTRY_IS_FILE_METHODDEF
12856 OS_DIRENTRY_IS_SYMLINK_METHODDEF
12857 OS_DIRENTRY_STAT_METHODDEF
12858 OS_DIRENTRY_INODE_METHODDEF
12859 OS_DIRENTRY___FSPATH___METHODDEF
Victor Stinner6036e442015-03-08 01:58:04 +010012860 {NULL}
12861};
12862
Benjamin Peterson5646de42015-04-12 17:56:34 -040012863static PyTypeObject DirEntryType = {
Victor Stinner6036e442015-03-08 01:58:04 +010012864 PyVarObject_HEAD_INIT(NULL, 0)
12865 MODNAME ".DirEntry", /* tp_name */
12866 sizeof(DirEntry), /* tp_basicsize */
12867 0, /* tp_itemsize */
12868 /* methods */
12869 (destructor)DirEntry_dealloc, /* tp_dealloc */
Jeroen Demeyer530f5062019-05-31 04:13:39 +020012870 0, /* tp_vectorcall_offset */
Victor Stinner6036e442015-03-08 01:58:04 +010012871 0, /* tp_getattr */
12872 0, /* tp_setattr */
Jeroen Demeyer530f5062019-05-31 04:13:39 +020012873 0, /* tp_as_async */
Victor Stinner6036e442015-03-08 01:58:04 +010012874 (reprfunc)DirEntry_repr, /* tp_repr */
12875 0, /* tp_as_number */
12876 0, /* tp_as_sequence */
12877 0, /* tp_as_mapping */
12878 0, /* tp_hash */
12879 0, /* tp_call */
12880 0, /* tp_str */
12881 0, /* tp_getattro */
12882 0, /* tp_setattro */
12883 0, /* tp_as_buffer */
12884 Py_TPFLAGS_DEFAULT, /* tp_flags */
12885 0, /* tp_doc */
12886 0, /* tp_traverse */
12887 0, /* tp_clear */
12888 0, /* tp_richcompare */
12889 0, /* tp_weaklistoffset */
12890 0, /* tp_iter */
12891 0, /* tp_iternext */
12892 DirEntry_methods, /* tp_methods */
12893 DirEntry_members, /* tp_members */
12894};
12895
12896#ifdef MS_WINDOWS
12897
12898static wchar_t *
Serhiy Storchakadeab18d2016-05-07 16:45:18 +030012899join_path_filenameW(const wchar_t *path_wide, const wchar_t *filename)
Victor Stinner6036e442015-03-08 01:58:04 +010012900{
12901 Py_ssize_t path_len;
12902 Py_ssize_t size;
12903 wchar_t *result;
12904 wchar_t ch;
12905
12906 if (!path_wide) { /* Default arg: "." */
12907 path_wide = L".";
12908 path_len = 1;
12909 }
12910 else {
12911 path_len = wcslen(path_wide);
12912 }
12913
12914 /* The +1's are for the path separator and the NUL */
12915 size = path_len + 1 + wcslen(filename) + 1;
12916 result = PyMem_New(wchar_t, size);
12917 if (!result) {
12918 PyErr_NoMemory();
12919 return NULL;
12920 }
12921 wcscpy(result, path_wide);
12922 if (path_len > 0) {
12923 ch = result[path_len - 1];
12924 if (ch != SEP && ch != ALTSEP && ch != L':')
12925 result[path_len++] = SEP;
12926 wcscpy(result + path_len, filename);
12927 }
12928 return result;
12929}
12930
12931static PyObject *
12932DirEntry_from_find_data(path_t *path, WIN32_FIND_DATAW *dataW)
12933{
12934 DirEntry *entry;
12935 BY_HANDLE_FILE_INFORMATION file_info;
12936 ULONG reparse_tag;
12937 wchar_t *joined_path;
12938
12939 entry = PyObject_New(DirEntry, &DirEntryType);
12940 if (!entry)
12941 return NULL;
12942 entry->name = NULL;
12943 entry->path = NULL;
12944 entry->stat = NULL;
12945 entry->lstat = NULL;
12946 entry->got_file_index = 0;
12947
12948 entry->name = PyUnicode_FromWideChar(dataW->cFileName, -1);
12949 if (!entry->name)
12950 goto error;
Steve Dowercc16be82016-09-08 10:35:16 -070012951 if (path->narrow) {
12952 Py_SETREF(entry->name, PyUnicode_EncodeFSDefault(entry->name));
12953 if (!entry->name)
12954 goto error;
12955 }
Victor Stinner6036e442015-03-08 01:58:04 +010012956
12957 joined_path = join_path_filenameW(path->wide, dataW->cFileName);
12958 if (!joined_path)
12959 goto error;
12960
12961 entry->path = PyUnicode_FromWideChar(joined_path, -1);
12962 PyMem_Free(joined_path);
12963 if (!entry->path)
12964 goto error;
Steve Dowercc16be82016-09-08 10:35:16 -070012965 if (path->narrow) {
12966 Py_SETREF(entry->path, PyUnicode_EncodeFSDefault(entry->path));
12967 if (!entry->path)
12968 goto error;
12969 }
Victor Stinner6036e442015-03-08 01:58:04 +010012970
Steve Dowercc16be82016-09-08 10:35:16 -070012971 find_data_to_file_info(dataW, &file_info, &reparse_tag);
Victor Stinner6036e442015-03-08 01:58:04 +010012972 _Py_attribute_data_to_stat(&file_info, reparse_tag, &entry->win32_lstat);
12973
12974 return (PyObject *)entry;
12975
12976error:
12977 Py_DECREF(entry);
12978 return NULL;
12979}
12980
12981#else /* POSIX */
12982
12983static char *
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020012984join_path_filename(const char *path_narrow, const char* filename, Py_ssize_t filename_len)
Victor Stinner6036e442015-03-08 01:58:04 +010012985{
12986 Py_ssize_t path_len;
12987 Py_ssize_t size;
12988 char *result;
12989
12990 if (!path_narrow) { /* Default arg: "." */
12991 path_narrow = ".";
12992 path_len = 1;
12993 }
12994 else {
12995 path_len = strlen(path_narrow);
12996 }
12997
12998 if (filename_len == -1)
12999 filename_len = strlen(filename);
13000
13001 /* The +1's are for the path separator and the NUL */
13002 size = path_len + 1 + filename_len + 1;
13003 result = PyMem_New(char, size);
13004 if (!result) {
13005 PyErr_NoMemory();
13006 return NULL;
13007 }
13008 strcpy(result, path_narrow);
13009 if (path_len > 0 && result[path_len - 1] != '/')
13010 result[path_len++] = '/';
13011 strcpy(result + path_len, filename);
13012 return result;
13013}
13014
13015static PyObject *
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020013016DirEntry_from_posix_info(path_t *path, const char *name, Py_ssize_t name_len,
Victor Stinner35a97c02015-03-08 02:59:09 +010013017 ino_t d_ino
13018#ifdef HAVE_DIRENT_D_TYPE
13019 , unsigned char d_type
13020#endif
13021 )
Victor Stinner6036e442015-03-08 01:58:04 +010013022{
13023 DirEntry *entry;
13024 char *joined_path;
13025
13026 entry = PyObject_New(DirEntry, &DirEntryType);
13027 if (!entry)
13028 return NULL;
13029 entry->name = NULL;
13030 entry->path = NULL;
13031 entry->stat = NULL;
13032 entry->lstat = NULL;
13033
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013034 if (path->fd != -1) {
13035 entry->dir_fd = path->fd;
13036 joined_path = NULL;
13037 }
13038 else {
13039 entry->dir_fd = DEFAULT_DIR_FD;
13040 joined_path = join_path_filename(path->narrow, name, name_len);
13041 if (!joined_path)
13042 goto error;
13043 }
Victor Stinner6036e442015-03-08 01:58:04 +010013044
Serhiy Storchaka1180e5a2017-07-11 06:36:46 +030013045 if (!path->narrow || !PyObject_CheckBuffer(path->object)) {
Victor Stinner6036e442015-03-08 01:58:04 +010013046 entry->name = PyUnicode_DecodeFSDefaultAndSize(name, name_len);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013047 if (joined_path)
13048 entry->path = PyUnicode_DecodeFSDefault(joined_path);
Victor Stinner6036e442015-03-08 01:58:04 +010013049 }
13050 else {
13051 entry->name = PyBytes_FromStringAndSize(name, name_len);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013052 if (joined_path)
13053 entry->path = PyBytes_FromString(joined_path);
Victor Stinner6036e442015-03-08 01:58:04 +010013054 }
13055 PyMem_Free(joined_path);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013056 if (!entry->name)
13057 goto error;
13058
13059 if (path->fd != -1) {
13060 entry->path = entry->name;
13061 Py_INCREF(entry->path);
13062 }
13063 else if (!entry->path)
Victor Stinner6036e442015-03-08 01:58:04 +010013064 goto error;
13065
Victor Stinner35a97c02015-03-08 02:59:09 +010013066#ifdef HAVE_DIRENT_D_TYPE
Victor Stinner6036e442015-03-08 01:58:04 +010013067 entry->d_type = d_type;
Victor Stinner35a97c02015-03-08 02:59:09 +010013068#endif
Victor Stinner6036e442015-03-08 01:58:04 +010013069 entry->d_ino = d_ino;
13070
13071 return (PyObject *)entry;
13072
13073error:
13074 Py_XDECREF(entry);
13075 return NULL;
13076}
13077
13078#endif
13079
13080
13081typedef struct {
13082 PyObject_HEAD
13083 path_t path;
13084#ifdef MS_WINDOWS
13085 HANDLE handle;
13086 WIN32_FIND_DATAW file_data;
13087 int first_time;
13088#else /* POSIX */
13089 DIR *dirp;
13090#endif
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013091#ifdef HAVE_FDOPENDIR
13092 int fd;
13093#endif
Victor Stinner6036e442015-03-08 01:58:04 +010013094} ScandirIterator;
13095
13096#ifdef MS_WINDOWS
13097
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013098static int
13099ScandirIterator_is_closed(ScandirIterator *iterator)
13100{
13101 return iterator->handle == INVALID_HANDLE_VALUE;
13102}
13103
Victor Stinner6036e442015-03-08 01:58:04 +010013104static void
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013105ScandirIterator_closedir(ScandirIterator *iterator)
Victor Stinner6036e442015-03-08 01:58:04 +010013106{
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030013107 HANDLE handle = iterator->handle;
13108
13109 if (handle == INVALID_HANDLE_VALUE)
Victor Stinner6036e442015-03-08 01:58:04 +010013110 return;
13111
Victor Stinner6036e442015-03-08 01:58:04 +010013112 iterator->handle = INVALID_HANDLE_VALUE;
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030013113 Py_BEGIN_ALLOW_THREADS
13114 FindClose(handle);
13115 Py_END_ALLOW_THREADS
Victor Stinner6036e442015-03-08 01:58:04 +010013116}
13117
13118static PyObject *
13119ScandirIterator_iternext(ScandirIterator *iterator)
13120{
13121 WIN32_FIND_DATAW *file_data = &iterator->file_data;
13122 BOOL success;
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013123 PyObject *entry;
Victor Stinner6036e442015-03-08 01:58:04 +010013124
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013125 /* Happens if the iterator is iterated twice, or closed explicitly */
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013126 if (iterator->handle == INVALID_HANDLE_VALUE)
Victor Stinner6036e442015-03-08 01:58:04 +010013127 return NULL;
Victor Stinner6036e442015-03-08 01:58:04 +010013128
13129 while (1) {
13130 if (!iterator->first_time) {
13131 Py_BEGIN_ALLOW_THREADS
13132 success = FindNextFileW(iterator->handle, file_data);
13133 Py_END_ALLOW_THREADS
13134 if (!success) {
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013135 /* Error or no more files */
Victor Stinner6036e442015-03-08 01:58:04 +010013136 if (GetLastError() != ERROR_NO_MORE_FILES)
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013137 path_error(&iterator->path);
Victor Stinner6036e442015-03-08 01:58:04 +010013138 break;
13139 }
13140 }
13141 iterator->first_time = 0;
13142
13143 /* Skip over . and .. */
13144 if (wcscmp(file_data->cFileName, L".") != 0 &&
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013145 wcscmp(file_data->cFileName, L"..") != 0) {
13146 entry = DirEntry_from_find_data(&iterator->path, file_data);
13147 if (!entry)
13148 break;
13149 return entry;
13150 }
Victor Stinner6036e442015-03-08 01:58:04 +010013151
13152 /* Loop till we get a non-dot directory or finish iterating */
13153 }
13154
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013155 /* Error or no more files */
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013156 ScandirIterator_closedir(iterator);
Victor Stinner6036e442015-03-08 01:58:04 +010013157 return NULL;
13158}
13159
13160#else /* POSIX */
13161
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013162static int
13163ScandirIterator_is_closed(ScandirIterator *iterator)
13164{
13165 return !iterator->dirp;
13166}
13167
Victor Stinner6036e442015-03-08 01:58:04 +010013168static void
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013169ScandirIterator_closedir(ScandirIterator *iterator)
Victor Stinner6036e442015-03-08 01:58:04 +010013170{
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030013171 DIR *dirp = iterator->dirp;
13172
13173 if (!dirp)
Victor Stinner6036e442015-03-08 01:58:04 +010013174 return;
13175
Victor Stinner6036e442015-03-08 01:58:04 +010013176 iterator->dirp = NULL;
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030013177 Py_BEGIN_ALLOW_THREADS
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013178#ifdef HAVE_FDOPENDIR
13179 if (iterator->path.fd != -1)
13180 rewinddir(dirp);
13181#endif
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030013182 closedir(dirp);
13183 Py_END_ALLOW_THREADS
Victor Stinner6036e442015-03-08 01:58:04 +010013184 return;
13185}
13186
13187static PyObject *
13188ScandirIterator_iternext(ScandirIterator *iterator)
13189{
13190 struct dirent *direntp;
13191 Py_ssize_t name_len;
13192 int is_dot;
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013193 PyObject *entry;
Victor Stinner6036e442015-03-08 01:58:04 +010013194
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013195 /* Happens if the iterator is iterated twice, or closed explicitly */
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013196 if (!iterator->dirp)
Victor Stinner6036e442015-03-08 01:58:04 +010013197 return NULL;
Victor Stinner6036e442015-03-08 01:58:04 +010013198
13199 while (1) {
13200 errno = 0;
13201 Py_BEGIN_ALLOW_THREADS
13202 direntp = readdir(iterator->dirp);
13203 Py_END_ALLOW_THREADS
13204
13205 if (!direntp) {
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013206 /* Error or no more files */
Victor Stinner6036e442015-03-08 01:58:04 +010013207 if (errno != 0)
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013208 path_error(&iterator->path);
Victor Stinner6036e442015-03-08 01:58:04 +010013209 break;
13210 }
13211
13212 /* Skip over . and .. */
13213 name_len = NAMLEN(direntp);
13214 is_dot = direntp->d_name[0] == '.' &&
13215 (name_len == 1 || (direntp->d_name[1] == '.' && name_len == 2));
13216 if (!is_dot) {
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013217 entry = DirEntry_from_posix_info(&iterator->path, direntp->d_name,
Victor Stinner35a97c02015-03-08 02:59:09 +010013218 name_len, direntp->d_ino
13219#ifdef HAVE_DIRENT_D_TYPE
13220 , direntp->d_type
13221#endif
13222 );
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013223 if (!entry)
13224 break;
13225 return entry;
Victor Stinner6036e442015-03-08 01:58:04 +010013226 }
13227
13228 /* Loop till we get a non-dot directory or finish iterating */
13229 }
13230
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013231 /* Error or no more files */
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013232 ScandirIterator_closedir(iterator);
Victor Stinner6036e442015-03-08 01:58:04 +010013233 return NULL;
13234}
13235
13236#endif
13237
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013238static PyObject *
13239ScandirIterator_close(ScandirIterator *self, PyObject *args)
13240{
13241 ScandirIterator_closedir(self);
13242 Py_RETURN_NONE;
13243}
13244
13245static PyObject *
13246ScandirIterator_enter(PyObject *self, PyObject *args)
13247{
13248 Py_INCREF(self);
13249 return self;
13250}
13251
13252static PyObject *
13253ScandirIterator_exit(ScandirIterator *self, PyObject *args)
13254{
13255 ScandirIterator_closedir(self);
13256 Py_RETURN_NONE;
13257}
13258
Victor Stinner6036e442015-03-08 01:58:04 +010013259static void
Victor Stinner7bfa4092016-03-23 00:43:54 +010013260ScandirIterator_finalize(ScandirIterator *iterator)
13261{
13262 PyObject *error_type, *error_value, *error_traceback;
13263
13264 /* Save the current exception, if any. */
13265 PyErr_Fetch(&error_type, &error_value, &error_traceback);
13266
13267 if (!ScandirIterator_is_closed(iterator)) {
13268 ScandirIterator_closedir(iterator);
13269
13270 if (PyErr_ResourceWarning((PyObject *)iterator, 1,
13271 "unclosed scandir iterator %R", iterator)) {
13272 /* Spurious errors can appear at shutdown */
13273 if (PyErr_ExceptionMatches(PyExc_Warning)) {
13274 PyErr_WriteUnraisable((PyObject *) iterator);
13275 }
13276 }
13277 }
13278
Victor Stinner7bfa4092016-03-23 00:43:54 +010013279 path_cleanup(&iterator->path);
13280
13281 /* Restore the saved exception. */
13282 PyErr_Restore(error_type, error_value, error_traceback);
13283}
13284
13285static void
Victor Stinner6036e442015-03-08 01:58:04 +010013286ScandirIterator_dealloc(ScandirIterator *iterator)
13287{
Victor Stinner7bfa4092016-03-23 00:43:54 +010013288 if (PyObject_CallFinalizerFromDealloc((PyObject *)iterator) < 0)
13289 return;
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013290
Victor Stinner6036e442015-03-08 01:58:04 +010013291 Py_TYPE(iterator)->tp_free((PyObject *)iterator);
13292}
13293
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013294static PyMethodDef ScandirIterator_methods[] = {
13295 {"__enter__", (PyCFunction)ScandirIterator_enter, METH_NOARGS},
13296 {"__exit__", (PyCFunction)ScandirIterator_exit, METH_VARARGS},
13297 {"close", (PyCFunction)ScandirIterator_close, METH_NOARGS},
13298 {NULL}
13299};
13300
Benjamin Peterson5646de42015-04-12 17:56:34 -040013301static PyTypeObject ScandirIteratorType = {
Victor Stinner6036e442015-03-08 01:58:04 +010013302 PyVarObject_HEAD_INIT(NULL, 0)
13303 MODNAME ".ScandirIterator", /* tp_name */
13304 sizeof(ScandirIterator), /* tp_basicsize */
13305 0, /* tp_itemsize */
13306 /* methods */
13307 (destructor)ScandirIterator_dealloc, /* tp_dealloc */
Jeroen Demeyer530f5062019-05-31 04:13:39 +020013308 0, /* tp_vectorcall_offset */
Victor Stinner6036e442015-03-08 01:58:04 +010013309 0, /* tp_getattr */
13310 0, /* tp_setattr */
Jeroen Demeyer530f5062019-05-31 04:13:39 +020013311 0, /* tp_as_async */
Victor Stinner6036e442015-03-08 01:58:04 +010013312 0, /* tp_repr */
13313 0, /* tp_as_number */
13314 0, /* tp_as_sequence */
13315 0, /* tp_as_mapping */
13316 0, /* tp_hash */
13317 0, /* tp_call */
13318 0, /* tp_str */
13319 0, /* tp_getattro */
13320 0, /* tp_setattro */
13321 0, /* tp_as_buffer */
Antoine Pitrouada319b2019-05-29 22:12:38 +020013322 Py_TPFLAGS_DEFAULT, /* tp_flags */
Victor Stinner6036e442015-03-08 01:58:04 +010013323 0, /* tp_doc */
13324 0, /* tp_traverse */
13325 0, /* tp_clear */
13326 0, /* tp_richcompare */
13327 0, /* tp_weaklistoffset */
13328 PyObject_SelfIter, /* tp_iter */
13329 (iternextfunc)ScandirIterator_iternext, /* tp_iternext */
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013330 ScandirIterator_methods, /* tp_methods */
Victor Stinner7bfa4092016-03-23 00:43:54 +010013331 0, /* tp_members */
13332 0, /* tp_getset */
13333 0, /* tp_base */
13334 0, /* tp_dict */
13335 0, /* tp_descr_get */
13336 0, /* tp_descr_set */
13337 0, /* tp_dictoffset */
13338 0, /* tp_init */
13339 0, /* tp_alloc */
13340 0, /* tp_new */
13341 0, /* tp_free */
13342 0, /* tp_is_gc */
13343 0, /* tp_bases */
13344 0, /* tp_mro */
13345 0, /* tp_cache */
13346 0, /* tp_subclasses */
13347 0, /* tp_weaklist */
13348 0, /* tp_del */
13349 0, /* tp_version_tag */
13350 (destructor)ScandirIterator_finalize, /* tp_finalize */
Victor Stinner6036e442015-03-08 01:58:04 +010013351};
13352
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013353/*[clinic input]
13354os.scandir
13355
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013356 path : path_t(nullable=True, allow_fd='PATH_HAVE_FDOPENDIR') = None
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013357
13358Return an iterator of DirEntry objects for given path.
13359
BNMetricsb9427072018-11-02 15:20:19 +000013360path can be specified as either str, bytes, or a path-like object. If path
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013361is bytes, the names of yielded DirEntry objects will also be bytes; in
13362all other circumstances they will be str.
13363
13364If path is None, uses the path='.'.
13365[clinic start generated code]*/
13366
Victor Stinner6036e442015-03-08 01:58:04 +010013367static PyObject *
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013368os_scandir_impl(PyObject *module, path_t *path)
BNMetricsb9427072018-11-02 15:20:19 +000013369/*[clinic end generated code: output=6eb2668b675ca89e input=6bdd312708fc3bb0]*/
Victor Stinner6036e442015-03-08 01:58:04 +010013370{
13371 ScandirIterator *iterator;
Victor Stinner6036e442015-03-08 01:58:04 +010013372#ifdef MS_WINDOWS
13373 wchar_t *path_strW;
13374#else
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013375 const char *path_str;
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013376#ifdef HAVE_FDOPENDIR
13377 int fd = -1;
13378#endif
Victor Stinner6036e442015-03-08 01:58:04 +010013379#endif
13380
Miss Islington (bot)8763d432019-06-24 09:09:47 -070013381 if (PySys_Audit("os.scandir", "O",
13382 path->object ? path->object : Py_None) < 0) {
13383 return NULL;
13384 }
13385
Victor Stinner6036e442015-03-08 01:58:04 +010013386 iterator = PyObject_New(ScandirIterator, &ScandirIteratorType);
13387 if (!iterator)
13388 return NULL;
Victor Stinner6036e442015-03-08 01:58:04 +010013389
13390#ifdef MS_WINDOWS
13391 iterator->handle = INVALID_HANDLE_VALUE;
13392#else
13393 iterator->dirp = NULL;
13394#endif
13395
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013396 memcpy(&iterator->path, path, sizeof(path_t));
Serhiy Storchaka095ef732017-02-09 20:05:51 +020013397 /* Move the ownership to iterator->path */
13398 path->object = NULL;
13399 path->cleanup = NULL;
Victor Stinner6036e442015-03-08 01:58:04 +010013400
13401#ifdef MS_WINDOWS
Victor Stinner6036e442015-03-08 01:58:04 +010013402 iterator->first_time = 1;
13403
13404 path_strW = join_path_filenameW(iterator->path.wide, L"*.*");
13405 if (!path_strW)
13406 goto error;
13407
13408 Py_BEGIN_ALLOW_THREADS
13409 iterator->handle = FindFirstFileW(path_strW, &iterator->file_data);
13410 Py_END_ALLOW_THREADS
13411
13412 PyMem_Free(path_strW);
13413
13414 if (iterator->handle == INVALID_HANDLE_VALUE) {
13415 path_error(&iterator->path);
13416 goto error;
13417 }
13418#else /* POSIX */
Victor Stinner6036e442015-03-08 01:58:04 +010013419 errno = 0;
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013420#ifdef HAVE_FDOPENDIR
13421 if (path->fd != -1) {
13422 /* closedir() closes the FD, so we duplicate it */
13423 fd = _Py_dup(path->fd);
13424 if (fd == -1)
13425 goto error;
13426
13427 Py_BEGIN_ALLOW_THREADS
13428 iterator->dirp = fdopendir(fd);
13429 Py_END_ALLOW_THREADS
13430 }
13431 else
13432#endif
13433 {
13434 if (iterator->path.narrow)
13435 path_str = iterator->path.narrow;
13436 else
13437 path_str = ".";
13438
13439 Py_BEGIN_ALLOW_THREADS
13440 iterator->dirp = opendir(path_str);
13441 Py_END_ALLOW_THREADS
13442 }
Victor Stinner6036e442015-03-08 01:58:04 +010013443
13444 if (!iterator->dirp) {
13445 path_error(&iterator->path);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013446#ifdef HAVE_FDOPENDIR
13447 if (fd != -1) {
13448 Py_BEGIN_ALLOW_THREADS
13449 close(fd);
13450 Py_END_ALLOW_THREADS
13451 }
13452#endif
Victor Stinner6036e442015-03-08 01:58:04 +010013453 goto error;
13454 }
13455#endif
13456
13457 return (PyObject *)iterator;
13458
13459error:
13460 Py_DECREF(iterator);
13461 return NULL;
13462}
13463
Ethan Furman410ef8e2016-06-04 12:06:26 -070013464/*
13465 Return the file system path representation of the object.
13466
13467 If the object is str or bytes, then allow it to pass through with
13468 an incremented refcount. If the object defines __fspath__(), then
13469 return the result of that method. All other types raise a TypeError.
13470*/
13471PyObject *
13472PyOS_FSPath(PyObject *path)
13473{
Brett Cannon3f9183b2016-08-26 14:44:48 -070013474 /* For error message reasons, this function is manually inlined in
13475 path_converter(). */
Ethan Furman410ef8e2016-06-04 12:06:26 -070013476 _Py_IDENTIFIER(__fspath__);
13477 PyObject *func = NULL;
13478 PyObject *path_repr = NULL;
13479
13480 if (PyUnicode_Check(path) || PyBytes_Check(path)) {
13481 Py_INCREF(path);
13482 return path;
13483 }
13484
13485 func = _PyObject_LookupSpecial(path, &PyId___fspath__);
13486 if (NULL == func) {
13487 return PyErr_Format(PyExc_TypeError,
13488 "expected str, bytes or os.PathLike object, "
Brett Cannonc78ca1e2016-06-24 12:03:43 -070013489 "not %.200s",
13490 Py_TYPE(path)->tp_name);
Ethan Furman410ef8e2016-06-04 12:06:26 -070013491 }
13492
Victor Stinnerf17c3de2016-12-06 18:46:19 +010013493 path_repr = _PyObject_CallNoArg(func);
Ethan Furman410ef8e2016-06-04 12:06:26 -070013494 Py_DECREF(func);
Brett Cannon044283a2016-07-15 10:41:49 -070013495 if (NULL == path_repr) {
13496 return NULL;
13497 }
13498
Brett Cannonc78ca1e2016-06-24 12:03:43 -070013499 if (!(PyUnicode_Check(path_repr) || PyBytes_Check(path_repr))) {
13500 PyErr_Format(PyExc_TypeError,
13501 "expected %.200s.__fspath__() to return str or bytes, "
13502 "not %.200s", Py_TYPE(path)->tp_name,
13503 Py_TYPE(path_repr)->tp_name);
13504 Py_DECREF(path_repr);
13505 return NULL;
13506 }
13507
Ethan Furman410ef8e2016-06-04 12:06:26 -070013508 return path_repr;
13509}
13510
13511/*[clinic input]
13512os.fspath
13513
13514 path: object
13515
13516Return the file system path representation of the object.
13517
Brett Cannonb4f43e92016-06-09 14:32:08 -070013518If the object is str or bytes, then allow it to pass through as-is. If the
13519object defines __fspath__(), then return the result of that method. All other
13520types raise a TypeError.
Ethan Furman410ef8e2016-06-04 12:06:26 -070013521[clinic start generated code]*/
13522
13523static PyObject *
Serhiy Storchaka2954f832016-07-07 18:20:03 +030013524os_fspath_impl(PyObject *module, PyObject *path)
13525/*[clinic end generated code: output=c3c3b78ecff2914f input=e357165f7b22490f]*/
Ethan Furman410ef8e2016-06-04 12:06:26 -070013526{
13527 return PyOS_FSPath(path);
13528}
Victor Stinner6036e442015-03-08 01:58:04 +010013529
Victor Stinner9b1f4742016-09-06 16:18:52 -070013530#ifdef HAVE_GETRANDOM_SYSCALL
13531/*[clinic input]
13532os.getrandom
13533
13534 size: Py_ssize_t
13535 flags: int=0
13536
13537Obtain a series of random bytes.
13538[clinic start generated code]*/
13539
13540static PyObject *
13541os_getrandom_impl(PyObject *module, Py_ssize_t size, int flags)
13542/*[clinic end generated code: output=b3a618196a61409c input=59bafac39c594947]*/
13543{
Victor Stinner9b1f4742016-09-06 16:18:52 -070013544 PyObject *bytes;
Victor Stinnerec2319c2016-09-20 23:00:59 +020013545 Py_ssize_t n;
Victor Stinner9b1f4742016-09-06 16:18:52 -070013546
13547 if (size < 0) {
13548 errno = EINVAL;
13549 return posix_error();
13550 }
13551
Victor Stinnerec2319c2016-09-20 23:00:59 +020013552 bytes = PyBytes_FromStringAndSize(NULL, size);
13553 if (bytes == NULL) {
Victor Stinner9b1f4742016-09-06 16:18:52 -070013554 PyErr_NoMemory();
13555 return NULL;
13556 }
13557
13558 while (1) {
Victor Stinnerec2319c2016-09-20 23:00:59 +020013559 n = syscall(SYS_getrandom,
13560 PyBytes_AS_STRING(bytes),
13561 PyBytes_GET_SIZE(bytes),
13562 flags);
Victor Stinner9b1f4742016-09-06 16:18:52 -070013563 if (n < 0 && errno == EINTR) {
13564 if (PyErr_CheckSignals() < 0) {
Victor Stinnerec2319c2016-09-20 23:00:59 +020013565 goto error;
Victor Stinner9b1f4742016-09-06 16:18:52 -070013566 }
Victor Stinnerec2319c2016-09-20 23:00:59 +020013567
13568 /* getrandom() was interrupted by a signal: retry */
Victor Stinner9b1f4742016-09-06 16:18:52 -070013569 continue;
13570 }
13571 break;
13572 }
13573
13574 if (n < 0) {
Victor Stinner9b1f4742016-09-06 16:18:52 -070013575 PyErr_SetFromErrno(PyExc_OSError);
Victor Stinnerec2319c2016-09-20 23:00:59 +020013576 goto error;
Victor Stinner9b1f4742016-09-06 16:18:52 -070013577 }
13578
Victor Stinnerec2319c2016-09-20 23:00:59 +020013579 if (n != size) {
13580 _PyBytes_Resize(&bytes, n);
13581 }
Victor Stinner9b1f4742016-09-06 16:18:52 -070013582
13583 return bytes;
Victor Stinnerec2319c2016-09-20 23:00:59 +020013584
13585error:
13586 Py_DECREF(bytes);
13587 return NULL;
Victor Stinner9b1f4742016-09-06 16:18:52 -070013588}
13589#endif /* HAVE_GETRANDOM_SYSCALL */
13590
Steve Dower2438cdf2019-03-29 16:37:16 -070013591#ifdef MS_WINDOWS
13592/* bpo-36085: Helper functions for managing DLL search directories
13593 * on win32
13594 */
13595
13596typedef DLL_DIRECTORY_COOKIE (WINAPI *PAddDllDirectory)(PCWSTR newDirectory);
13597typedef BOOL (WINAPI *PRemoveDllDirectory)(DLL_DIRECTORY_COOKIE cookie);
13598
13599/*[clinic input]
13600os._add_dll_directory
13601
13602 path: path_t
13603
13604Add a path to the DLL search path.
13605
13606This search path is used when resolving dependencies for imported
13607extension modules (the module itself is resolved through sys.path),
13608and also by ctypes.
13609
13610Returns an opaque value that may be passed to os.remove_dll_directory
13611to remove this directory from the search path.
13612[clinic start generated code]*/
13613
13614static PyObject *
13615os__add_dll_directory_impl(PyObject *module, path_t *path)
13616/*[clinic end generated code: output=80b025daebb5d683 input=1de3e6c13a5808c8]*/
13617{
13618 HMODULE hKernel32;
13619 PAddDllDirectory AddDllDirectory;
13620 DLL_DIRECTORY_COOKIE cookie = 0;
13621 DWORD err = 0;
13622
Steve Dowera00b5be2020-02-13 08:30:27 +000013623 if (PySys_Audit("os.add_dll_directory", "(O)", path->object) < 0) {
13624 return NULL;
13625 }
13626
Steve Dower2438cdf2019-03-29 16:37:16 -070013627 /* For Windows 7, we have to load this. As this will be a fairly
13628 infrequent operation, just do it each time. Kernel32 is always
13629 loaded. */
13630 Py_BEGIN_ALLOW_THREADS
13631 if (!(hKernel32 = GetModuleHandleW(L"kernel32")) ||
13632 !(AddDllDirectory = (PAddDllDirectory)GetProcAddress(
13633 hKernel32, "AddDllDirectory")) ||
13634 !(cookie = (*AddDllDirectory)(path->wide))) {
13635 err = GetLastError();
13636 }
13637 Py_END_ALLOW_THREADS
13638
13639 if (err) {
13640 return win32_error_object_err("add_dll_directory",
13641 path->object, err);
13642 }
13643
13644 return PyCapsule_New(cookie, "DLL directory cookie", NULL);
13645}
13646
13647/*[clinic input]
13648os._remove_dll_directory
13649
13650 cookie: object
13651
13652Removes a path from the DLL search path.
13653
13654The parameter is an opaque value that was returned from
13655os.add_dll_directory. You can only remove directories that you added
13656yourself.
13657[clinic start generated code]*/
13658
13659static PyObject *
13660os__remove_dll_directory_impl(PyObject *module, PyObject *cookie)
13661/*[clinic end generated code: output=594350433ae535bc input=c1d16a7e7d9dc5dc]*/
13662{
13663 HMODULE hKernel32;
13664 PRemoveDllDirectory RemoveDllDirectory;
13665 DLL_DIRECTORY_COOKIE cookieValue;
13666 DWORD err = 0;
13667
13668 if (!PyCapsule_IsValid(cookie, "DLL directory cookie")) {
13669 PyErr_SetString(PyExc_TypeError,
13670 "Provided cookie was not returned from os.add_dll_directory");
13671 return NULL;
13672 }
13673
13674 cookieValue = (DLL_DIRECTORY_COOKIE)PyCapsule_GetPointer(
13675 cookie, "DLL directory cookie");
13676
13677 /* For Windows 7, we have to load this. As this will be a fairly
13678 infrequent operation, just do it each time. Kernel32 is always
13679 loaded. */
13680 Py_BEGIN_ALLOW_THREADS
13681 if (!(hKernel32 = GetModuleHandleW(L"kernel32")) ||
13682 !(RemoveDllDirectory = (PRemoveDllDirectory)GetProcAddress(
13683 hKernel32, "RemoveDllDirectory")) ||
13684 !(*RemoveDllDirectory)(cookieValue)) {
13685 err = GetLastError();
13686 }
13687 Py_END_ALLOW_THREADS
13688
13689 if (err) {
13690 return win32_error_object_err("remove_dll_directory",
13691 NULL, err);
13692 }
13693
13694 if (PyCapsule_SetName(cookie, NULL)) {
13695 return NULL;
13696 }
13697
13698 Py_RETURN_NONE;
13699}
13700
13701#endif
Larry Hastings31826802013-10-19 00:09:25 -070013702
Fred Drake5ab8eaf1999-12-09 21:13:07 +000013703static PyMethodDef posix_methods[] = {
Larry Hastings31826802013-10-19 00:09:25 -070013704
13705 OS_STAT_METHODDEF
13706 OS_ACCESS_METHODDEF
13707 OS_TTYNAME_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100013708 OS_CHDIR_METHODDEF
13709 OS_CHFLAGS_METHODDEF
13710 OS_CHMOD_METHODDEF
13711 OS_FCHMOD_METHODDEF
13712 OS_LCHMOD_METHODDEF
13713 OS_CHOWN_METHODDEF
13714 OS_FCHOWN_METHODDEF
13715 OS_LCHOWN_METHODDEF
13716 OS_LCHFLAGS_METHODDEF
13717 OS_CHROOT_METHODDEF
13718 OS_CTERMID_METHODDEF
13719 OS_GETCWD_METHODDEF
13720 OS_GETCWDB_METHODDEF
13721 OS_LINK_METHODDEF
13722 OS_LISTDIR_METHODDEF
13723 OS_LSTAT_METHODDEF
13724 OS_MKDIR_METHODDEF
13725 OS_NICE_METHODDEF
13726 OS_GETPRIORITY_METHODDEF
13727 OS_SETPRIORITY_METHODDEF
Pablo Galindo6c6ddf92018-01-29 01:56:10 +000013728 OS_POSIX_SPAWN_METHODDEF
Joannah Nanjekye92b83222019-01-16 16:29:26 +030013729 OS_POSIX_SPAWNP_METHODDEF
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030013730 OS_READLINK_METHODDEF
Pablo Galindoaac4d032019-05-31 19:39:47 +010013731 OS_COPY_FILE_RANGE_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100013732 OS_RENAME_METHODDEF
13733 OS_REPLACE_METHODDEF
13734 OS_RMDIR_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100013735 OS_SYMLINK_METHODDEF
13736 OS_SYSTEM_METHODDEF
13737 OS_UMASK_METHODDEF
13738 OS_UNAME_METHODDEF
13739 OS_UNLINK_METHODDEF
13740 OS_REMOVE_METHODDEF
13741 OS_UTIME_METHODDEF
13742 OS_TIMES_METHODDEF
13743 OS__EXIT_METHODDEF
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +020013744 OS__FCOPYFILE_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100013745 OS_EXECV_METHODDEF
13746 OS_EXECVE_METHODDEF
13747 OS_SPAWNV_METHODDEF
13748 OS_SPAWNVE_METHODDEF
13749 OS_FORK1_METHODDEF
13750 OS_FORK_METHODDEF
Antoine Pitrou346cbd32017-05-27 17:50:54 +020013751 OS_REGISTER_AT_FORK_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100013752 OS_SCHED_GET_PRIORITY_MAX_METHODDEF
13753 OS_SCHED_GET_PRIORITY_MIN_METHODDEF
13754 OS_SCHED_GETPARAM_METHODDEF
13755 OS_SCHED_GETSCHEDULER_METHODDEF
13756 OS_SCHED_RR_GET_INTERVAL_METHODDEF
13757 OS_SCHED_SETPARAM_METHODDEF
13758 OS_SCHED_SETSCHEDULER_METHODDEF
13759 OS_SCHED_YIELD_METHODDEF
13760 OS_SCHED_SETAFFINITY_METHODDEF
13761 OS_SCHED_GETAFFINITY_METHODDEF
13762 OS_OPENPTY_METHODDEF
13763 OS_FORKPTY_METHODDEF
13764 OS_GETEGID_METHODDEF
13765 OS_GETEUID_METHODDEF
13766 OS_GETGID_METHODDEF
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +020013767#ifdef HAVE_GETGROUPLIST
13768 {"getgrouplist", posix_getgrouplist, METH_VARARGS, posix_getgrouplist__doc__},
13769#endif
Larry Hastings2f936352014-08-05 14:04:04 +100013770 OS_GETGROUPS_METHODDEF
13771 OS_GETPID_METHODDEF
13772 OS_GETPGRP_METHODDEF
13773 OS_GETPPID_METHODDEF
13774 OS_GETUID_METHODDEF
13775 OS_GETLOGIN_METHODDEF
13776 OS_KILL_METHODDEF
13777 OS_KILLPG_METHODDEF
13778 OS_PLOCK_METHODDEF
Thomas Heller8b7a9572007-08-31 06:44:36 +000013779#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -070013780 OS_STARTFILE_METHODDEF
Thomas Heller8b7a9572007-08-31 06:44:36 +000013781#endif
Larry Hastings2f936352014-08-05 14:04:04 +100013782 OS_SETUID_METHODDEF
13783 OS_SETEUID_METHODDEF
13784 OS_SETREUID_METHODDEF
13785 OS_SETGID_METHODDEF
13786 OS_SETEGID_METHODDEF
13787 OS_SETREGID_METHODDEF
13788 OS_SETGROUPS_METHODDEF
Antoine Pitroub7572f02009-12-02 20:46:48 +000013789#ifdef HAVE_INITGROUPS
Victor Stinner8c62be82010-05-06 00:08:46 +000013790 {"initgroups", posix_initgroups, METH_VARARGS, posix_initgroups__doc__},
Antoine Pitroub7572f02009-12-02 20:46:48 +000013791#endif /* HAVE_INITGROUPS */
Larry Hastings2f936352014-08-05 14:04:04 +100013792 OS_GETPGID_METHODDEF
13793 OS_SETPGRP_METHODDEF
13794 OS_WAIT_METHODDEF
13795 OS_WAIT3_METHODDEF
13796 OS_WAIT4_METHODDEF
13797 OS_WAITID_METHODDEF
13798 OS_WAITPID_METHODDEF
13799 OS_GETSID_METHODDEF
13800 OS_SETSID_METHODDEF
13801 OS_SETPGID_METHODDEF
13802 OS_TCGETPGRP_METHODDEF
13803 OS_TCSETPGRP_METHODDEF
13804 OS_OPEN_METHODDEF
13805 OS_CLOSE_METHODDEF
13806 OS_CLOSERANGE_METHODDEF
13807 OS_DEVICE_ENCODING_METHODDEF
13808 OS_DUP_METHODDEF
13809 OS_DUP2_METHODDEF
13810 OS_LOCKF_METHODDEF
13811 OS_LSEEK_METHODDEF
13812 OS_READ_METHODDEF
13813 OS_READV_METHODDEF
13814 OS_PREAD_METHODDEF
Pablo Galindo4defba32018-01-27 16:16:37 +000013815 OS_PREADV_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100013816 OS_WRITE_METHODDEF
13817 OS_WRITEV_METHODDEF
13818 OS_PWRITE_METHODDEF
Pablo Galindo4defba32018-01-27 16:16:37 +000013819 OS_PWRITEV_METHODDEF
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000013820#ifdef HAVE_SENDFILE
Serhiy Storchaka62be7422018-11-27 13:27:31 +020013821 {"sendfile", (PyCFunction)(void(*)(void))posix_sendfile, METH_VARARGS | METH_KEYWORDS,
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000013822 posix_sendfile__doc__},
13823#endif
Larry Hastings2f936352014-08-05 14:04:04 +100013824 OS_FSTAT_METHODDEF
13825 OS_ISATTY_METHODDEF
13826 OS_PIPE_METHODDEF
13827 OS_PIPE2_METHODDEF
13828 OS_MKFIFO_METHODDEF
13829 OS_MKNOD_METHODDEF
13830 OS_MAJOR_METHODDEF
13831 OS_MINOR_METHODDEF
13832 OS_MAKEDEV_METHODDEF
13833 OS_FTRUNCATE_METHODDEF
13834 OS_TRUNCATE_METHODDEF
13835 OS_POSIX_FALLOCATE_METHODDEF
13836 OS_POSIX_FADVISE_METHODDEF
13837 OS_PUTENV_METHODDEF
13838 OS_UNSETENV_METHODDEF
13839 OS_STRERROR_METHODDEF
13840 OS_FCHDIR_METHODDEF
13841 OS_FSYNC_METHODDEF
13842 OS_SYNC_METHODDEF
13843 OS_FDATASYNC_METHODDEF
13844 OS_WCOREDUMP_METHODDEF
13845 OS_WIFCONTINUED_METHODDEF
13846 OS_WIFSTOPPED_METHODDEF
13847 OS_WIFSIGNALED_METHODDEF
13848 OS_WIFEXITED_METHODDEF
13849 OS_WEXITSTATUS_METHODDEF
13850 OS_WTERMSIG_METHODDEF
13851 OS_WSTOPSIG_METHODDEF
13852 OS_FSTATVFS_METHODDEF
13853 OS_STATVFS_METHODDEF
13854 OS_CONFSTR_METHODDEF
13855 OS_SYSCONF_METHODDEF
13856 OS_FPATHCONF_METHODDEF
13857 OS_PATHCONF_METHODDEF
13858 OS_ABORT_METHODDEF
Serhiy Storchakaf0b50152015-05-13 00:52:39 +030013859 OS__GETFULLPATHNAME_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100013860 OS__GETDISKUSAGE_METHODDEF
13861 OS__GETFINALPATHNAME_METHODDEF
13862 OS__GETVOLUMEPATHNAME_METHODDEF
13863 OS_GETLOADAVG_METHODDEF
13864 OS_URANDOM_METHODDEF
13865 OS_SETRESUID_METHODDEF
13866 OS_SETRESGID_METHODDEF
13867 OS_GETRESUID_METHODDEF
13868 OS_GETRESGID_METHODDEF
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000013869
Larry Hastings2f936352014-08-05 14:04:04 +100013870 OS_GETXATTR_METHODDEF
13871 OS_SETXATTR_METHODDEF
13872 OS_REMOVEXATTR_METHODDEF
13873 OS_LISTXATTR_METHODDEF
13874
Antoine Pitroubcf2b592012-02-08 23:28:36 +010013875#if defined(TERMSIZE_USE_CONIO) || defined(TERMSIZE_USE_IOCTL)
13876 {"get_terminal_size", get_terminal_size, METH_VARARGS, termsize__doc__},
13877#endif
Larry Hastings2f936352014-08-05 14:04:04 +100013878 OS_CPU_COUNT_METHODDEF
13879 OS_GET_INHERITABLE_METHODDEF
13880 OS_SET_INHERITABLE_METHODDEF
13881 OS_GET_HANDLE_INHERITABLE_METHODDEF
13882 OS_SET_HANDLE_INHERITABLE_METHODDEF
Victor Stinner1db9e7b2014-07-29 22:32:47 +020013883#ifndef MS_WINDOWS
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030013884 OS_GET_BLOCKING_METHODDEF
13885 OS_SET_BLOCKING_METHODDEF
Victor Stinner1db9e7b2014-07-29 22:32:47 +020013886#endif
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013887 OS_SCANDIR_METHODDEF
Ethan Furman410ef8e2016-06-04 12:06:26 -070013888 OS_FSPATH_METHODDEF
Victor Stinner9b1f4742016-09-06 16:18:52 -070013889 OS_GETRANDOM_METHODDEF
Zackery Spytz43fdbd22019-05-29 13:57:07 -060013890 OS_MEMFD_CREATE_METHODDEF
Steve Dower2438cdf2019-03-29 16:37:16 -070013891#ifdef MS_WINDOWS
13892 OS__ADD_DLL_DIRECTORY_METHODDEF
13893 OS__REMOVE_DLL_DIRECTORY_METHODDEF
13894#endif
Victor Stinner8c62be82010-05-06 00:08:46 +000013895 {NULL, NULL} /* Sentinel */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000013896};
13897
Barry Warsaw4a342091996-12-19 23:50:02 +000013898static int
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013899all_ins(PyObject *m)
Barry Warsaw4a342091996-12-19 23:50:02 +000013900{
Guido van Rossum94f6f721999-01-06 18:42:14 +000013901#ifdef F_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013902 if (PyModule_AddIntMacro(m, F_OK)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013903#endif
Guido van Rossum94f6f721999-01-06 18:42:14 +000013904#ifdef R_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013905 if (PyModule_AddIntMacro(m, R_OK)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013906#endif
Guido van Rossum94f6f721999-01-06 18:42:14 +000013907#ifdef W_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013908 if (PyModule_AddIntMacro(m, W_OK)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013909#endif
Guido van Rossum94f6f721999-01-06 18:42:14 +000013910#ifdef X_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013911 if (PyModule_AddIntMacro(m, X_OK)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013912#endif
Fred Drakec9680921999-12-13 16:37:25 +000013913#ifdef NGROUPS_MAX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013914 if (PyModule_AddIntMacro(m, NGROUPS_MAX)) return -1;
Fred Drakec9680921999-12-13 16:37:25 +000013915#endif
Fred Drake5ab8eaf1999-12-09 21:13:07 +000013916#ifdef TMP_MAX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013917 if (PyModule_AddIntMacro(m, TMP_MAX)) return -1;
Fred Drake5ab8eaf1999-12-09 21:13:07 +000013918#endif
Fred Drake106c1a02002-04-23 15:58:02 +000013919#ifdef WCONTINUED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013920 if (PyModule_AddIntMacro(m, WCONTINUED)) return -1;
Fred Drake106c1a02002-04-23 15:58:02 +000013921#endif
Barry Warsaw4a342091996-12-19 23:50:02 +000013922#ifdef WNOHANG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013923 if (PyModule_AddIntMacro(m, WNOHANG)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013924#endif
Fred Drake106c1a02002-04-23 15:58:02 +000013925#ifdef WUNTRACED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013926 if (PyModule_AddIntMacro(m, WUNTRACED)) return -1;
Fred Drake106c1a02002-04-23 15:58:02 +000013927#endif
Barry Warsaw4a342091996-12-19 23:50:02 +000013928#ifdef O_RDONLY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013929 if (PyModule_AddIntMacro(m, O_RDONLY)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013930#endif
13931#ifdef O_WRONLY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013932 if (PyModule_AddIntMacro(m, O_WRONLY)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013933#endif
13934#ifdef O_RDWR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013935 if (PyModule_AddIntMacro(m, O_RDWR)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013936#endif
13937#ifdef O_NDELAY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013938 if (PyModule_AddIntMacro(m, O_NDELAY)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013939#endif
13940#ifdef O_NONBLOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013941 if (PyModule_AddIntMacro(m, O_NONBLOCK)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013942#endif
13943#ifdef O_APPEND
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013944 if (PyModule_AddIntMacro(m, O_APPEND)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013945#endif
13946#ifdef O_DSYNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013947 if (PyModule_AddIntMacro(m, O_DSYNC)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013948#endif
13949#ifdef O_RSYNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013950 if (PyModule_AddIntMacro(m, O_RSYNC)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013951#endif
13952#ifdef O_SYNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013953 if (PyModule_AddIntMacro(m, O_SYNC)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013954#endif
13955#ifdef O_NOCTTY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013956 if (PyModule_AddIntMacro(m, O_NOCTTY)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013957#endif
13958#ifdef O_CREAT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013959 if (PyModule_AddIntMacro(m, O_CREAT)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013960#endif
13961#ifdef O_EXCL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013962 if (PyModule_AddIntMacro(m, O_EXCL)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013963#endif
13964#ifdef O_TRUNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013965 if (PyModule_AddIntMacro(m, O_TRUNC)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013966#endif
Guido van Rossum98d9d091997-08-08 21:48:51 +000013967#ifdef O_BINARY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013968 if (PyModule_AddIntMacro(m, O_BINARY)) return -1;
Guido van Rossum98d9d091997-08-08 21:48:51 +000013969#endif
13970#ifdef O_TEXT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013971 if (PyModule_AddIntMacro(m, O_TEXT)) return -1;
Guido van Rossum98d9d091997-08-08 21:48:51 +000013972#endif
Jesus Cea1d642d22012-04-24 20:59:17 +020013973#ifdef O_XATTR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013974 if (PyModule_AddIntMacro(m, O_XATTR)) return -1;
Jesus Cea1d642d22012-04-24 20:59:17 +020013975#endif
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000013976#ifdef O_LARGEFILE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013977 if (PyModule_AddIntMacro(m, O_LARGEFILE)) return -1;
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000013978#endif
doko@ubuntu.comfcff4372016-06-13 16:33:04 +020013979#ifndef __GNU__
Skip Montanaro5ff14922005-05-16 02:42:22 +000013980#ifdef O_SHLOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013981 if (PyModule_AddIntMacro(m, O_SHLOCK)) return -1;
Skip Montanaro5ff14922005-05-16 02:42:22 +000013982#endif
13983#ifdef O_EXLOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013984 if (PyModule_AddIntMacro(m, O_EXLOCK)) return -1;
Skip Montanaro5ff14922005-05-16 02:42:22 +000013985#endif
doko@ubuntu.comfcff4372016-06-13 16:33:04 +020013986#endif
Jesus Ceacf381202012-04-24 20:44:40 +020013987#ifdef O_EXEC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013988 if (PyModule_AddIntMacro(m, O_EXEC)) return -1;
Jesus Ceacf381202012-04-24 20:44:40 +020013989#endif
13990#ifdef O_SEARCH
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013991 if (PyModule_AddIntMacro(m, O_SEARCH)) return -1;
Jesus Ceacf381202012-04-24 20:44:40 +020013992#endif
Benjamin Peterson3b965a22013-03-13 10:27:41 -050013993#ifdef O_PATH
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013994 if (PyModule_AddIntMacro(m, O_PATH)) return -1;
Benjamin Peterson3b965a22013-03-13 10:27:41 -050013995#endif
Jesus Ceacf381202012-04-24 20:44:40 +020013996#ifdef O_TTY_INIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013997 if (PyModule_AddIntMacro(m, O_TTY_INIT)) return -1;
Jesus Ceacf381202012-04-24 20:44:40 +020013998#endif
Christian Heimes177b3f92013-08-16 14:35:09 +020013999#ifdef O_TMPFILE
14000 if (PyModule_AddIntMacro(m, O_TMPFILE)) return -1;
14001#endif
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000014002#ifdef PRIO_PROCESS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014003 if (PyModule_AddIntMacro(m, PRIO_PROCESS)) return -1;
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000014004#endif
14005#ifdef PRIO_PGRP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014006 if (PyModule_AddIntMacro(m, PRIO_PGRP)) return -1;
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000014007#endif
14008#ifdef PRIO_USER
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014009 if (PyModule_AddIntMacro(m, PRIO_USER)) return -1;
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000014010#endif
Charles-François Natali1e045b12011-05-22 20:42:32 +020014011#ifdef O_CLOEXEC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014012 if (PyModule_AddIntMacro(m, O_CLOEXEC)) return -1;
Charles-François Natali1e045b12011-05-22 20:42:32 +020014013#endif
Jesus Cea1d642d22012-04-24 20:59:17 +020014014#ifdef O_ACCMODE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014015 if (PyModule_AddIntMacro(m, O_ACCMODE)) return -1;
Jesus Cea1d642d22012-04-24 20:59:17 +020014016#endif
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000014017
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000014018
Jesus Cea94363612012-06-22 18:32:07 +020014019#ifdef SEEK_HOLE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014020 if (PyModule_AddIntMacro(m, SEEK_HOLE)) return -1;
Jesus Cea94363612012-06-22 18:32:07 +020014021#endif
14022#ifdef SEEK_DATA
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014023 if (PyModule_AddIntMacro(m, SEEK_DATA)) return -1;
Jesus Cea94363612012-06-22 18:32:07 +020014024#endif
14025
Tim Peters5aa91602002-01-30 05:46:57 +000014026/* MS Windows */
14027#ifdef O_NOINHERIT
Victor Stinner8c62be82010-05-06 00:08:46 +000014028 /* Don't inherit in child processes. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014029 if (PyModule_AddIntMacro(m, O_NOINHERIT)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000014030#endif
14031#ifdef _O_SHORT_LIVED
Victor Stinner8c62be82010-05-06 00:08:46 +000014032 /* Optimize for short life (keep in memory). */
14033 /* MS forgot to define this one with a non-underscore form too. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014034 if (PyModule_AddIntConstant(m, "O_SHORT_LIVED", _O_SHORT_LIVED)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000014035#endif
14036#ifdef O_TEMPORARY
Victor Stinner8c62be82010-05-06 00:08:46 +000014037 /* Automatically delete when last handle is closed. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014038 if (PyModule_AddIntMacro(m, O_TEMPORARY)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000014039#endif
14040#ifdef O_RANDOM
Victor Stinner8c62be82010-05-06 00:08:46 +000014041 /* Optimize for random access. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014042 if (PyModule_AddIntMacro(m, O_RANDOM)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000014043#endif
14044#ifdef O_SEQUENTIAL
Victor Stinner8c62be82010-05-06 00:08:46 +000014045 /* Optimize for sequential access. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014046 if (PyModule_AddIntMacro(m, O_SEQUENTIAL)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000014047#endif
14048
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000014049/* GNU extensions. */
Alexandre Vassalottibee32532008-05-16 18:15:12 +000014050#ifdef O_ASYNC
Victor Stinner8c62be82010-05-06 00:08:46 +000014051 /* Send a SIGIO signal whenever input or output
14052 becomes available on file descriptor */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014053 if (PyModule_AddIntMacro(m, O_ASYNC)) return -1;
Alexandre Vassalottibee32532008-05-16 18:15:12 +000014054#endif
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000014055#ifdef O_DIRECT
Victor Stinner8c62be82010-05-06 00:08:46 +000014056 /* Direct disk access. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014057 if (PyModule_AddIntMacro(m, O_DIRECT)) return -1;
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000014058#endif
14059#ifdef O_DIRECTORY
Victor Stinner8c62be82010-05-06 00:08:46 +000014060 /* Must be a directory. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014061 if (PyModule_AddIntMacro(m, O_DIRECTORY)) return -1;
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000014062#endif
14063#ifdef O_NOFOLLOW
Victor Stinner8c62be82010-05-06 00:08:46 +000014064 /* Do not follow links. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014065 if (PyModule_AddIntMacro(m, O_NOFOLLOW)) return -1;
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000014066#endif
Jesus Cea1d642d22012-04-24 20:59:17 +020014067#ifdef O_NOLINKS
14068 /* Fails if link count of the named file is greater than 1 */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014069 if (PyModule_AddIntMacro(m, O_NOLINKS)) return -1;
Jesus Cea1d642d22012-04-24 20:59:17 +020014070#endif
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +000014071#ifdef O_NOATIME
Victor Stinner8c62be82010-05-06 00:08:46 +000014072 /* Do not update the access time. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014073 if (PyModule_AddIntMacro(m, O_NOATIME)) return -1;
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +000014074#endif
Guido van Rossumd48f2521997-12-05 22:19:34 +000014075
Victor Stinner8c62be82010-05-06 00:08:46 +000014076 /* These come from sysexits.h */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014077#ifdef EX_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014078 if (PyModule_AddIntMacro(m, EX_OK)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014079#endif /* EX_OK */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014080#ifdef EX_USAGE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014081 if (PyModule_AddIntMacro(m, EX_USAGE)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014082#endif /* EX_USAGE */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014083#ifdef EX_DATAERR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014084 if (PyModule_AddIntMacro(m, EX_DATAERR)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014085#endif /* EX_DATAERR */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014086#ifdef EX_NOINPUT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014087 if (PyModule_AddIntMacro(m, EX_NOINPUT)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014088#endif /* EX_NOINPUT */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014089#ifdef EX_NOUSER
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014090 if (PyModule_AddIntMacro(m, EX_NOUSER)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014091#endif /* EX_NOUSER */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014092#ifdef EX_NOHOST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014093 if (PyModule_AddIntMacro(m, EX_NOHOST)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014094#endif /* EX_NOHOST */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014095#ifdef EX_UNAVAILABLE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014096 if (PyModule_AddIntMacro(m, EX_UNAVAILABLE)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014097#endif /* EX_UNAVAILABLE */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014098#ifdef EX_SOFTWARE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014099 if (PyModule_AddIntMacro(m, EX_SOFTWARE)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014100#endif /* EX_SOFTWARE */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014101#ifdef EX_OSERR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014102 if (PyModule_AddIntMacro(m, EX_OSERR)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014103#endif /* EX_OSERR */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014104#ifdef EX_OSFILE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014105 if (PyModule_AddIntMacro(m, EX_OSFILE)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014106#endif /* EX_OSFILE */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014107#ifdef EX_CANTCREAT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014108 if (PyModule_AddIntMacro(m, EX_CANTCREAT)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014109#endif /* EX_CANTCREAT */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014110#ifdef EX_IOERR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014111 if (PyModule_AddIntMacro(m, EX_IOERR)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014112#endif /* EX_IOERR */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014113#ifdef EX_TEMPFAIL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014114 if (PyModule_AddIntMacro(m, EX_TEMPFAIL)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014115#endif /* EX_TEMPFAIL */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014116#ifdef EX_PROTOCOL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014117 if (PyModule_AddIntMacro(m, EX_PROTOCOL)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014118#endif /* EX_PROTOCOL */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014119#ifdef EX_NOPERM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014120 if (PyModule_AddIntMacro(m, EX_NOPERM)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014121#endif /* EX_NOPERM */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014122#ifdef EX_CONFIG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014123 if (PyModule_AddIntMacro(m, EX_CONFIG)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014124#endif /* EX_CONFIG */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014125#ifdef EX_NOTFOUND
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014126 if (PyModule_AddIntMacro(m, EX_NOTFOUND)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000014127#endif /* EX_NOTFOUND */
Barry Warsaw5676bd12003-01-07 20:57:09 +000014128
Amaury Forgeot d'Arc66d00ad2010-09-10 18:11:45 +000014129 /* statvfs */
Andrew M. Kuchling4ea04a32010-08-18 22:30:34 +000014130#ifdef ST_RDONLY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014131 if (PyModule_AddIntMacro(m, ST_RDONLY)) return -1;
Andrew M. Kuchling4ea04a32010-08-18 22:30:34 +000014132#endif /* ST_RDONLY */
14133#ifdef ST_NOSUID
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014134 if (PyModule_AddIntMacro(m, ST_NOSUID)) return -1;
Andrew M. Kuchling4ea04a32010-08-18 22:30:34 +000014135#endif /* ST_NOSUID */
14136
doko@ubuntu.comca616a22013-12-08 15:23:07 +010014137 /* GNU extensions */
14138#ifdef ST_NODEV
14139 if (PyModule_AddIntMacro(m, ST_NODEV)) return -1;
14140#endif /* ST_NODEV */
14141#ifdef ST_NOEXEC
14142 if (PyModule_AddIntMacro(m, ST_NOEXEC)) return -1;
14143#endif /* ST_NOEXEC */
14144#ifdef ST_SYNCHRONOUS
14145 if (PyModule_AddIntMacro(m, ST_SYNCHRONOUS)) return -1;
14146#endif /* ST_SYNCHRONOUS */
14147#ifdef ST_MANDLOCK
14148 if (PyModule_AddIntMacro(m, ST_MANDLOCK)) return -1;
14149#endif /* ST_MANDLOCK */
14150#ifdef ST_WRITE
14151 if (PyModule_AddIntMacro(m, ST_WRITE)) return -1;
14152#endif /* ST_WRITE */
14153#ifdef ST_APPEND
14154 if (PyModule_AddIntMacro(m, ST_APPEND)) return -1;
14155#endif /* ST_APPEND */
14156#ifdef ST_NOATIME
14157 if (PyModule_AddIntMacro(m, ST_NOATIME)) return -1;
14158#endif /* ST_NOATIME */
14159#ifdef ST_NODIRATIME
14160 if (PyModule_AddIntMacro(m, ST_NODIRATIME)) return -1;
14161#endif /* ST_NODIRATIME */
14162#ifdef ST_RELATIME
14163 if (PyModule_AddIntMacro(m, ST_RELATIME)) return -1;
14164#endif /* ST_RELATIME */
14165
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000014166 /* FreeBSD sendfile() constants */
14167#ifdef SF_NODISKIO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014168 if (PyModule_AddIntMacro(m, SF_NODISKIO)) return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000014169#endif
14170#ifdef SF_MNOWAIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014171 if (PyModule_AddIntMacro(m, SF_MNOWAIT)) return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000014172#endif
14173#ifdef SF_SYNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014174 if (PyModule_AddIntMacro(m, SF_SYNC)) return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000014175#endif
14176
Ross Lagerwall7807c352011-03-17 20:20:30 +020014177 /* constants for posix_fadvise */
14178#ifdef POSIX_FADV_NORMAL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014179 if (PyModule_AddIntMacro(m, POSIX_FADV_NORMAL)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014180#endif
14181#ifdef POSIX_FADV_SEQUENTIAL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014182 if (PyModule_AddIntMacro(m, POSIX_FADV_SEQUENTIAL)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014183#endif
14184#ifdef POSIX_FADV_RANDOM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014185 if (PyModule_AddIntMacro(m, POSIX_FADV_RANDOM)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014186#endif
14187#ifdef POSIX_FADV_NOREUSE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014188 if (PyModule_AddIntMacro(m, POSIX_FADV_NOREUSE)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014189#endif
14190#ifdef POSIX_FADV_WILLNEED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014191 if (PyModule_AddIntMacro(m, POSIX_FADV_WILLNEED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014192#endif
14193#ifdef POSIX_FADV_DONTNEED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014194 if (PyModule_AddIntMacro(m, POSIX_FADV_DONTNEED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014195#endif
14196
14197 /* constants for waitid */
14198#if defined(HAVE_SYS_WAIT_H) && defined(HAVE_WAITID)
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014199 if (PyModule_AddIntMacro(m, P_PID)) return -1;
14200 if (PyModule_AddIntMacro(m, P_PGID)) return -1;
14201 if (PyModule_AddIntMacro(m, P_ALL)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014202#endif
14203#ifdef WEXITED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014204 if (PyModule_AddIntMacro(m, WEXITED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014205#endif
14206#ifdef WNOWAIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014207 if (PyModule_AddIntMacro(m, WNOWAIT)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014208#endif
14209#ifdef WSTOPPED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014210 if (PyModule_AddIntMacro(m, WSTOPPED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014211#endif
14212#ifdef CLD_EXITED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014213 if (PyModule_AddIntMacro(m, CLD_EXITED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014214#endif
14215#ifdef CLD_DUMPED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014216 if (PyModule_AddIntMacro(m, CLD_DUMPED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014217#endif
14218#ifdef CLD_TRAPPED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014219 if (PyModule_AddIntMacro(m, CLD_TRAPPED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014220#endif
14221#ifdef CLD_CONTINUED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014222 if (PyModule_AddIntMacro(m, CLD_CONTINUED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014223#endif
14224
14225 /* constants for lockf */
14226#ifdef F_LOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014227 if (PyModule_AddIntMacro(m, F_LOCK)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014228#endif
14229#ifdef F_TLOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014230 if (PyModule_AddIntMacro(m, F_TLOCK)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014231#endif
14232#ifdef F_ULOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014233 if (PyModule_AddIntMacro(m, F_ULOCK)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014234#endif
14235#ifdef F_TEST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014236 if (PyModule_AddIntMacro(m, F_TEST)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014237#endif
14238
Pablo Galindo4defba32018-01-27 16:16:37 +000014239#ifdef RWF_DSYNC
14240 if (PyModule_AddIntConstant(m, "RWF_DSYNC", RWF_DSYNC)) return -1;
14241#endif
14242#ifdef RWF_HIPRI
14243 if (PyModule_AddIntConstant(m, "RWF_HIPRI", RWF_HIPRI)) return -1;
14244#endif
14245#ifdef RWF_SYNC
14246 if (PyModule_AddIntConstant(m, "RWF_SYNC", RWF_SYNC)) return -1;
14247#endif
14248#ifdef RWF_NOWAIT
14249 if (PyModule_AddIntConstant(m, "RWF_NOWAIT", RWF_NOWAIT)) return -1;
14250#endif
14251
Pablo Galindo6c6ddf92018-01-29 01:56:10 +000014252/* constants for posix_spawn */
14253#ifdef HAVE_POSIX_SPAWN
14254 if (PyModule_AddIntConstant(m, "POSIX_SPAWN_OPEN", POSIX_SPAWN_OPEN)) return -1;
14255 if (PyModule_AddIntConstant(m, "POSIX_SPAWN_CLOSE", POSIX_SPAWN_CLOSE)) return -1;
14256 if (PyModule_AddIntConstant(m, "POSIX_SPAWN_DUP2", POSIX_SPAWN_DUP2)) return -1;
14257#endif
14258
pxinwrf2d7ac72019-05-21 18:46:37 +080014259#if defined(HAVE_SPAWNV) || defined (HAVE_RTPSPAWN)
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014260 if (PyModule_AddIntConstant(m, "P_WAIT", _P_WAIT)) return -1;
14261 if (PyModule_AddIntConstant(m, "P_NOWAIT", _P_NOWAIT)) return -1;
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014262 if (PyModule_AddIntConstant(m, "P_NOWAITO", _P_NOWAITO)) return -1;
pxinwrf2d7ac72019-05-21 18:46:37 +080014263#endif
14264#ifdef HAVE_SPAWNV
14265 if (PyModule_AddIntConstant(m, "P_OVERLAY", _OLD_P_OVERLAY)) return -1;
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014266 if (PyModule_AddIntConstant(m, "P_DETACH", _P_DETACH)) return -1;
Guido van Rossum246bc171999-02-01 23:54:31 +000014267#endif
14268
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014269#ifdef HAVE_SCHED_H
Benjamin Petersondbaa5592016-07-30 23:21:50 -070014270#ifdef SCHED_OTHER
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014271 if (PyModule_AddIntMacro(m, SCHED_OTHER)) return -1;
Benjamin Petersondbaa5592016-07-30 23:21:50 -070014272#endif
14273#ifdef SCHED_FIFO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014274 if (PyModule_AddIntMacro(m, SCHED_FIFO)) return -1;
Benjamin Petersondbaa5592016-07-30 23:21:50 -070014275#endif
14276#ifdef SCHED_RR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014277 if (PyModule_AddIntMacro(m, SCHED_RR)) return -1;
Benjamin Petersondbaa5592016-07-30 23:21:50 -070014278#endif
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014279#ifdef SCHED_SPORADIC
messi Liao0d322182017-06-13 22:30:43 +080014280 if (PyModule_AddIntMacro(m, SCHED_SPORADIC)) return -1;
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014281#endif
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014282#ifdef SCHED_BATCH
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014283 if (PyModule_AddIntMacro(m, SCHED_BATCH)) return -1;
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014284#endif
14285#ifdef SCHED_IDLE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014286 if (PyModule_AddIntMacro(m, SCHED_IDLE)) return -1;
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014287#endif
14288#ifdef SCHED_RESET_ON_FORK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014289 if (PyModule_AddIntMacro(m, SCHED_RESET_ON_FORK)) return -1;
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014290#endif
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020014291#ifdef SCHED_SYS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014292 if (PyModule_AddIntMacro(m, SCHED_SYS)) return -1;
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020014293#endif
14294#ifdef SCHED_IA
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014295 if (PyModule_AddIntMacro(m, SCHED_IA)) return -1;
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020014296#endif
14297#ifdef SCHED_FSS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014298 if (PyModule_AddIntMacro(m, SCHED_FSS)) return -1;
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020014299#endif
14300#ifdef SCHED_FX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014301 if (PyModule_AddIntConstant(m, "SCHED_FX", SCHED_FSS)) return -1;
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020014302#endif
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014303#endif
14304
Benjamin Peterson9428d532011-09-14 11:45:52 -040014305#ifdef USE_XATTRS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014306 if (PyModule_AddIntMacro(m, XATTR_CREATE)) return -1;
14307 if (PyModule_AddIntMacro(m, XATTR_REPLACE)) return -1;
14308 if (PyModule_AddIntMacro(m, XATTR_SIZE_MAX)) return -1;
Benjamin Peterson799bd802011-08-31 22:15:17 -040014309#endif
14310
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014311#if HAVE_DECL_RTLD_LAZY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014312 if (PyModule_AddIntMacro(m, RTLD_LAZY)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014313#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014314#if HAVE_DECL_RTLD_NOW
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014315 if (PyModule_AddIntMacro(m, RTLD_NOW)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014316#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014317#if HAVE_DECL_RTLD_GLOBAL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014318 if (PyModule_AddIntMacro(m, RTLD_GLOBAL)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014319#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014320#if HAVE_DECL_RTLD_LOCAL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014321 if (PyModule_AddIntMacro(m, RTLD_LOCAL)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014322#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014323#if HAVE_DECL_RTLD_NODELETE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014324 if (PyModule_AddIntMacro(m, RTLD_NODELETE)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014325#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014326#if HAVE_DECL_RTLD_NOLOAD
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014327 if (PyModule_AddIntMacro(m, RTLD_NOLOAD)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014328#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014329#if HAVE_DECL_RTLD_DEEPBIND
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014330 if (PyModule_AddIntMacro(m, RTLD_DEEPBIND)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014331#endif
Michael Feltc5ae1692017-12-19 13:58:49 +010014332#if HAVE_DECL_RTLD_MEMBER
14333 if (PyModule_AddIntMacro(m, RTLD_MEMBER)) return -1;
14334#endif
Victor Stinner8b905bd2011-10-25 13:34:04 +020014335
Victor Stinner9b1f4742016-09-06 16:18:52 -070014336#ifdef HAVE_GETRANDOM_SYSCALL
14337 if (PyModule_AddIntMacro(m, GRND_RANDOM)) return -1;
14338 if (PyModule_AddIntMacro(m, GRND_NONBLOCK)) return -1;
14339#endif
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014340#ifdef HAVE_MEMFD_CREATE
14341 if (PyModule_AddIntMacro(m, MFD_CLOEXEC)) return -1;
14342 if (PyModule_AddIntMacro(m, MFD_ALLOW_SEALING)) return -1;
14343#ifdef MFD_HUGETLB
14344 if (PyModule_AddIntMacro(m, MFD_HUGETLB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014345#endif
14346#ifdef MFD_HUGE_SHIFT
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014347 if (PyModule_AddIntMacro(m, MFD_HUGE_SHIFT)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014348#endif
14349#ifdef MFD_HUGE_MASK
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014350 if (PyModule_AddIntMacro(m, MFD_HUGE_MASK)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014351#endif
14352#ifdef MFD_HUGE_64KB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014353 if (PyModule_AddIntMacro(m, MFD_HUGE_64KB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014354#endif
14355#ifdef MFD_HUGE_512KB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014356 if (PyModule_AddIntMacro(m, MFD_HUGE_512KB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014357#endif
14358#ifdef MFD_HUGE_1MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014359 if (PyModule_AddIntMacro(m, MFD_HUGE_1MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014360#endif
14361#ifdef MFD_HUGE_2MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014362 if (PyModule_AddIntMacro(m, MFD_HUGE_2MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014363#endif
14364#ifdef MFD_HUGE_8MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014365 if (PyModule_AddIntMacro(m, MFD_HUGE_8MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014366#endif
14367#ifdef MFD_HUGE_16MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014368 if (PyModule_AddIntMacro(m, MFD_HUGE_16MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014369#endif
14370#ifdef MFD_HUGE_32MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014371 if (PyModule_AddIntMacro(m, MFD_HUGE_32MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014372#endif
14373#ifdef MFD_HUGE_256MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014374 if (PyModule_AddIntMacro(m, MFD_HUGE_256MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014375#endif
14376#ifdef MFD_HUGE_512MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014377 if (PyModule_AddIntMacro(m, MFD_HUGE_512MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014378#endif
14379#ifdef MFD_HUGE_1GB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014380 if (PyModule_AddIntMacro(m, MFD_HUGE_1GB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014381#endif
14382#ifdef MFD_HUGE_2GB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014383 if (PyModule_AddIntMacro(m, MFD_HUGE_2GB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014384#endif
14385#ifdef MFD_HUGE_16GB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014386 if (PyModule_AddIntMacro(m, MFD_HUGE_16GB)) return -1;
14387#endif
14388#endif
Victor Stinner9b1f4742016-09-06 16:18:52 -070014389
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +020014390#if defined(__APPLE__)
14391 if (PyModule_AddIntConstant(m, "_COPYFILE_DATA", COPYFILE_DATA)) return -1;
14392#endif
14393
Steve Dower2438cdf2019-03-29 16:37:16 -070014394#ifdef MS_WINDOWS
14395 if (PyModule_AddIntConstant(m, "_LOAD_LIBRARY_SEARCH_DEFAULT_DIRS", LOAD_LIBRARY_SEARCH_DEFAULT_DIRS)) return -1;
14396 if (PyModule_AddIntConstant(m, "_LOAD_LIBRARY_SEARCH_APPLICATION_DIR", LOAD_LIBRARY_SEARCH_APPLICATION_DIR)) return -1;
14397 if (PyModule_AddIntConstant(m, "_LOAD_LIBRARY_SEARCH_SYSTEM32", LOAD_LIBRARY_SEARCH_SYSTEM32)) return -1;
14398 if (PyModule_AddIntConstant(m, "_LOAD_LIBRARY_SEARCH_USER_DIRS", LOAD_LIBRARY_SEARCH_USER_DIRS)) return -1;
14399 if (PyModule_AddIntConstant(m, "_LOAD_LIBRARY_SEARCH_DLL_LOAD_DIR", LOAD_LIBRARY_SEARCH_DLL_LOAD_DIR)) return -1;
14400#endif
14401
Victor Stinner8c62be82010-05-06 00:08:46 +000014402 return 0;
Barry Warsaw4a342091996-12-19 23:50:02 +000014403}
14404
14405
Martin v. Löwis1a214512008-06-11 05:26:20 +000014406static struct PyModuleDef posixmodule = {
Victor Stinner8c62be82010-05-06 00:08:46 +000014407 PyModuleDef_HEAD_INIT,
14408 MODNAME,
14409 posix__doc__,
14410 -1,
14411 posix_methods,
14412 NULL,
14413 NULL,
14414 NULL,
14415 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +000014416};
14417
14418
Serhiy Storchaka2d06e842015-12-25 19:53:18 +020014419static const char * const have_functions[] = {
Larry Hastings9cf065c2012-06-22 16:30:09 -070014420
14421#ifdef HAVE_FACCESSAT
14422 "HAVE_FACCESSAT",
14423#endif
14424
14425#ifdef HAVE_FCHDIR
14426 "HAVE_FCHDIR",
14427#endif
14428
14429#ifdef HAVE_FCHMOD
14430 "HAVE_FCHMOD",
14431#endif
14432
14433#ifdef HAVE_FCHMODAT
14434 "HAVE_FCHMODAT",
14435#endif
14436
14437#ifdef HAVE_FCHOWN
14438 "HAVE_FCHOWN",
14439#endif
14440
Larry Hastings00964ed2013-08-12 13:49:30 -040014441#ifdef HAVE_FCHOWNAT
14442 "HAVE_FCHOWNAT",
14443#endif
14444
Larry Hastings9cf065c2012-06-22 16:30:09 -070014445#ifdef HAVE_FEXECVE
14446 "HAVE_FEXECVE",
14447#endif
14448
14449#ifdef HAVE_FDOPENDIR
14450 "HAVE_FDOPENDIR",
14451#endif
14452
Georg Brandl306336b2012-06-24 12:55:33 +020014453#ifdef HAVE_FPATHCONF
14454 "HAVE_FPATHCONF",
14455#endif
14456
Larry Hastings9cf065c2012-06-22 16:30:09 -070014457#ifdef HAVE_FSTATAT
14458 "HAVE_FSTATAT",
14459#endif
14460
14461#ifdef HAVE_FSTATVFS
14462 "HAVE_FSTATVFS",
14463#endif
14464
Steve Dowerfe0a41a2015-03-20 19:50:46 -070014465#if defined HAVE_FTRUNCATE || defined MS_WINDOWS
Georg Brandl306336b2012-06-24 12:55:33 +020014466 "HAVE_FTRUNCATE",
14467#endif
14468
Larry Hastings9cf065c2012-06-22 16:30:09 -070014469#ifdef HAVE_FUTIMENS
14470 "HAVE_FUTIMENS",
14471#endif
14472
14473#ifdef HAVE_FUTIMES
14474 "HAVE_FUTIMES",
14475#endif
14476
14477#ifdef HAVE_FUTIMESAT
14478 "HAVE_FUTIMESAT",
14479#endif
14480
14481#ifdef HAVE_LINKAT
14482 "HAVE_LINKAT",
14483#endif
14484
14485#ifdef HAVE_LCHFLAGS
14486 "HAVE_LCHFLAGS",
14487#endif
14488
14489#ifdef HAVE_LCHMOD
14490 "HAVE_LCHMOD",
14491#endif
14492
14493#ifdef HAVE_LCHOWN
14494 "HAVE_LCHOWN",
14495#endif
14496
14497#ifdef HAVE_LSTAT
14498 "HAVE_LSTAT",
14499#endif
14500
14501#ifdef HAVE_LUTIMES
14502 "HAVE_LUTIMES",
14503#endif
14504
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014505#ifdef HAVE_MEMFD_CREATE
14506 "HAVE_MEMFD_CREATE",
14507#endif
14508
Larry Hastings9cf065c2012-06-22 16:30:09 -070014509#ifdef HAVE_MKDIRAT
14510 "HAVE_MKDIRAT",
14511#endif
14512
14513#ifdef HAVE_MKFIFOAT
14514 "HAVE_MKFIFOAT",
14515#endif
14516
14517#ifdef HAVE_MKNODAT
14518 "HAVE_MKNODAT",
14519#endif
14520
14521#ifdef HAVE_OPENAT
14522 "HAVE_OPENAT",
14523#endif
14524
14525#ifdef HAVE_READLINKAT
14526 "HAVE_READLINKAT",
14527#endif
14528
14529#ifdef HAVE_RENAMEAT
14530 "HAVE_RENAMEAT",
14531#endif
14532
14533#ifdef HAVE_SYMLINKAT
14534 "HAVE_SYMLINKAT",
14535#endif
14536
14537#ifdef HAVE_UNLINKAT
14538 "HAVE_UNLINKAT",
14539#endif
14540
14541#ifdef HAVE_UTIMENSAT
14542 "HAVE_UTIMENSAT",
14543#endif
14544
14545#ifdef MS_WINDOWS
14546 "MS_WINDOWS",
14547#endif
14548
14549 NULL
14550};
14551
14552
Mark Hammondfe51c6d2002-08-02 02:27:13 +000014553PyMODINIT_FUNC
Thomas Woutersf3f33dc2000-07-21 06:00:07 +000014554INITFUNC(void)
Guido van Rossumb6775db1994-08-01 11:34:53 +000014555{
Victor Stinner8c62be82010-05-06 00:08:46 +000014556 PyObject *m, *v;
Larry Hastings9cf065c2012-06-22 16:30:09 -070014557 PyObject *list;
Serhiy Storchaka2d06e842015-12-25 19:53:18 +020014558 const char * const *trace;
Tim Peters5aa91602002-01-30 05:46:57 +000014559
Victor Stinner8c62be82010-05-06 00:08:46 +000014560 m = PyModule_Create(&posixmodule);
14561 if (m == NULL)
14562 return NULL;
Tim Peters5aa91602002-01-30 05:46:57 +000014563
Victor Stinner8c62be82010-05-06 00:08:46 +000014564 /* Initialize environ dictionary */
14565 v = convertenviron();
14566 Py_XINCREF(v);
14567 if (v == NULL || PyModule_AddObject(m, "environ", v) != 0)
14568 return NULL;
14569 Py_DECREF(v);
Fred Drakec9680921999-12-13 16:37:25 +000014570
Victor Stinner8c62be82010-05-06 00:08:46 +000014571 if (all_ins(m))
14572 return NULL;
Barry Warsaw4a342091996-12-19 23:50:02 +000014573
Victor Stinner8c62be82010-05-06 00:08:46 +000014574 if (setup_confname_tables(m))
14575 return NULL;
Fred Drakebec628d1999-12-15 18:31:10 +000014576
Victor Stinner8c62be82010-05-06 00:08:46 +000014577 Py_INCREF(PyExc_OSError);
14578 PyModule_AddObject(m, "error", PyExc_OSError);
Fred Drake762e2061999-08-26 17:23:54 +000014579
Guido van Rossumb3d39562000-01-31 18:41:26 +000014580#ifdef HAVE_PUTENV
Victor Stinner8c62be82010-05-06 00:08:46 +000014581 if (posix_putenv_garbage == NULL)
14582 posix_putenv_garbage = PyDict_New();
Guido van Rossumb3d39562000-01-31 18:41:26 +000014583#endif
Guido van Rossum98bf58f2001-10-18 20:34:25 +000014584
Victor Stinner8c62be82010-05-06 00:08:46 +000014585 if (!initialized) {
Ross Lagerwall7807c352011-03-17 20:20:30 +020014586#if defined(HAVE_WAITID) && !defined(__APPLE__)
14587 waitid_result_desc.name = MODNAME ".waitid_result";
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014588 WaitidResultType = PyStructSequence_NewType(&waitid_result_desc);
14589 if (WaitidResultType == NULL) {
Victor Stinner1c8f0592013-07-22 22:24:54 +020014590 return NULL;
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014591 }
Ross Lagerwall7807c352011-03-17 20:20:30 +020014592#endif
14593
Christian Heimes25827622013-10-12 01:27:08 +020014594 stat_result_desc.name = "os.stat_result"; /* see issue #19209 */
Victor Stinner8c62be82010-05-06 00:08:46 +000014595 stat_result_desc.fields[7].name = PyStructSequence_UnnamedField;
14596 stat_result_desc.fields[8].name = PyStructSequence_UnnamedField;
14597 stat_result_desc.fields[9].name = PyStructSequence_UnnamedField;
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014598 StatResultType = PyStructSequence_NewType(&stat_result_desc);
14599 if (StatResultType == NULL) {
Victor Stinner1c8f0592013-07-22 22:24:54 +020014600 return NULL;
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014601 }
14602 structseq_new = StatResultType->tp_new;
14603 StatResultType->tp_new = statresult_new;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000014604
Christian Heimes25827622013-10-12 01:27:08 +020014605 statvfs_result_desc.name = "os.statvfs_result"; /* see issue #19209 */
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014606 StatVFSResultType = PyStructSequence_NewType(&statvfs_result_desc);
14607 if (StatVFSResultType == NULL) {
Victor Stinner1c8f0592013-07-22 22:24:54 +020014608 return NULL;
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014609 }
Martin v. Löwis05bfe1f2008-12-29 18:21:47 +000014610#ifdef NEED_TICKS_PER_SECOND
14611# if defined(HAVE_SYSCONF) && defined(_SC_CLK_TCK)
Victor Stinner8c62be82010-05-06 00:08:46 +000014612 ticks_per_second = sysconf(_SC_CLK_TCK);
Martin v. Löwis05bfe1f2008-12-29 18:21:47 +000014613# elif defined(HZ)
Victor Stinner8c62be82010-05-06 00:08:46 +000014614 ticks_per_second = HZ;
Martin v. Löwis05bfe1f2008-12-29 18:21:47 +000014615# else
Victor Stinner8c62be82010-05-06 00:08:46 +000014616 ticks_per_second = 60; /* magic fallback value; may be bogus */
Martin v. Löwis05bfe1f2008-12-29 18:21:47 +000014617# endif
14618#endif
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014619
William Orr81574b82018-10-01 22:19:56 -070014620#if defined(HAVE_SCHED_SETPARAM) || defined(HAVE_SCHED_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDPARAM)
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014621 sched_param_desc.name = MODNAME ".sched_param";
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014622 SchedParamType = PyStructSequence_NewType(&sched_param_desc);
14623 if (SchedParamType == NULL) {
Victor Stinner1c8f0592013-07-22 22:24:54 +020014624 return NULL;
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014625 }
14626 SchedParamType->tp_new = os_sched_param;
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014627#endif
Antoine Pitroubcf2b592012-02-08 23:28:36 +010014628
14629 /* initialize TerminalSize_info */
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014630 TerminalSizeType = PyStructSequence_NewType(&TerminalSize_desc);
14631 if (TerminalSizeType == NULL) {
Victor Stinner1c8f0592013-07-22 22:24:54 +020014632 return NULL;
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014633 }
Victor Stinner6036e442015-03-08 01:58:04 +010014634
14635 /* initialize scandir types */
14636 if (PyType_Ready(&ScandirIteratorType) < 0)
14637 return NULL;
14638 if (PyType_Ready(&DirEntryType) < 0)
14639 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +000014640 }
Ross Lagerwall7807c352011-03-17 20:20:30 +020014641#if defined(HAVE_WAITID) && !defined(__APPLE__)
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014642 Py_INCREF((PyObject*) WaitidResultType);
14643 PyModule_AddObject(m, "waitid_result", (PyObject*) WaitidResultType);
Ross Lagerwall7807c352011-03-17 20:20:30 +020014644#endif
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014645 Py_INCREF((PyObject*) StatResultType);
14646 PyModule_AddObject(m, "stat_result", (PyObject*) StatResultType);
14647 Py_INCREF((PyObject*) StatVFSResultType);
Victor Stinner8c62be82010-05-06 00:08:46 +000014648 PyModule_AddObject(m, "statvfs_result",
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014649 (PyObject*) StatVFSResultType);
Benjamin Petersone3298dd2011-08-02 18:40:46 -050014650
14651#if defined(HAVE_SCHED_SETPARAM) || defined(HAVE_SCHED_SETSCHEDULER)
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014652 Py_INCREF(SchedParamType);
14653 PyModule_AddObject(m, "sched_param", (PyObject *)SchedParamType);
Benjamin Petersone3298dd2011-08-02 18:40:46 -050014654#endif
Thomas Wouters477c8d52006-05-27 19:21:47 +000014655
Larry Hastings605a62d2012-06-24 04:33:36 -070014656 times_result_desc.name = MODNAME ".times_result";
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014657 TimesResultType = PyStructSequence_NewType(&times_result_desc);
14658 if (TimesResultType == NULL) {
Victor Stinner1c8f0592013-07-22 22:24:54 +020014659 return NULL;
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014660 }
14661 PyModule_AddObject(m, "times_result", (PyObject *)TimesResultType);
Larry Hastings605a62d2012-06-24 04:33:36 -070014662
14663 uname_result_desc.name = MODNAME ".uname_result";
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014664 UnameResultType = PyStructSequence_NewType(&uname_result_desc);
14665 if (UnameResultType == NULL) {
Victor Stinner1c8f0592013-07-22 22:24:54 +020014666 return NULL;
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014667 }
14668 PyModule_AddObject(m, "uname_result", (PyObject *)UnameResultType);
Larry Hastings605a62d2012-06-24 04:33:36 -070014669
Thomas Wouters477c8d52006-05-27 19:21:47 +000014670#ifdef __APPLE__
Victor Stinner8c62be82010-05-06 00:08:46 +000014671 /*
14672 * Step 2 of weak-linking support on Mac OS X.
14673 *
14674 * The code below removes functions that are not available on the
14675 * currently active platform.
14676 *
14677 * This block allow one to use a python binary that was build on
Larry Hastings9cf065c2012-06-22 16:30:09 -070014678 * OSX 10.4 on OSX 10.3, without losing access to new APIs on
Victor Stinner8c62be82010-05-06 00:08:46 +000014679 * OSX 10.4.
14680 */
Thomas Wouters477c8d52006-05-27 19:21:47 +000014681#ifdef HAVE_FSTATVFS
Victor Stinner8c62be82010-05-06 00:08:46 +000014682 if (fstatvfs == NULL) {
14683 if (PyObject_DelAttrString(m, "fstatvfs") == -1) {
14684 return NULL;
14685 }
14686 }
Thomas Wouters477c8d52006-05-27 19:21:47 +000014687#endif /* HAVE_FSTATVFS */
14688
14689#ifdef HAVE_STATVFS
Victor Stinner8c62be82010-05-06 00:08:46 +000014690 if (statvfs == NULL) {
14691 if (PyObject_DelAttrString(m, "statvfs") == -1) {
14692 return NULL;
14693 }
14694 }
Thomas Wouters477c8d52006-05-27 19:21:47 +000014695#endif /* HAVE_STATVFS */
14696
14697# ifdef HAVE_LCHOWN
Victor Stinner8c62be82010-05-06 00:08:46 +000014698 if (lchown == NULL) {
14699 if (PyObject_DelAttrString(m, "lchown") == -1) {
14700 return NULL;
14701 }
14702 }
Thomas Wouters477c8d52006-05-27 19:21:47 +000014703#endif /* HAVE_LCHOWN */
14704
14705
14706#endif /* __APPLE__ */
Antoine Pitroubcf2b592012-02-08 23:28:36 +010014707
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014708 Py_INCREF(TerminalSizeType);
14709 PyModule_AddObject(m, "terminal_size", (PyObject*)TerminalSizeType);
Antoine Pitroubcf2b592012-02-08 23:28:36 +010014710
Larry Hastings6fe20b32012-04-19 15:07:49 -070014711 billion = PyLong_FromLong(1000000000);
14712 if (!billion)
14713 return NULL;
14714
Larry Hastings9cf065c2012-06-22 16:30:09 -070014715 /* suppress "function not used" warnings */
14716 {
14717 int ignored;
14718 fd_specified("", -1);
14719 follow_symlinks_specified("", 1);
14720 dir_fd_and_follow_symlinks_invalid("chmod", DEFAULT_DIR_FD, 1);
14721 dir_fd_converter(Py_None, &ignored);
14722 dir_fd_unavailable(Py_None, &ignored);
14723 }
14724
14725 /*
14726 * provide list of locally available functions
14727 * so os.py can populate support_* lists
14728 */
14729 list = PyList_New(0);
14730 if (!list)
14731 return NULL;
14732 for (trace = have_functions; *trace; trace++) {
14733 PyObject *unicode = PyUnicode_DecodeASCII(*trace, strlen(*trace), NULL);
14734 if (!unicode)
14735 return NULL;
14736 if (PyList_Append(list, unicode))
14737 return NULL;
14738 Py_DECREF(unicode);
14739 }
14740 PyModule_AddObject(m, "_have_functions", list);
Ned Deilyeb3be662016-08-15 14:40:38 -040014741
14742 Py_INCREF((PyObject *) &DirEntryType);
Brett Cannona32c4d02016-06-24 14:14:44 -070014743 PyModule_AddObject(m, "DirEntry", (PyObject *)&DirEntryType);
Larry Hastings9cf065c2012-06-22 16:30:09 -070014744
14745 initialized = 1;
14746
Victor Stinner8c62be82010-05-06 00:08:46 +000014747 return m;
Guido van Rossumb6775db1994-08-01 11:34:53 +000014748}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000014749
14750#ifdef __cplusplus
14751}
14752#endif