blob: 771c5616152cfddb48756b983aa96765a9a7c5f4 [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>
1375static char **environ;
pxinwrf2d7ac72019-05-21 18:46:37 +08001376#elif !defined(_MSC_VER) && (!defined(__WATCOMC__) || defined(__QNX__) || defined(__VXWORKS__))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001377extern char **environ;
Guido van Rossuma4916fa1996-05-23 22:58:55 +00001378#endif /* !_MSC_VER */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001379
Barry Warsaw53699e91996-12-10 23:23:01 +00001380static PyObject *
Thomas Woutersf3f33dc2000-07-21 06:00:07 +00001381convertenviron(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001382{
Victor Stinner8c62be82010-05-06 00:08:46 +00001383 PyObject *d;
Thomas Hellerf78f12a2007-11-08 19:33:05 +00001384#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00001385 wchar_t **e;
Thomas Hellerf78f12a2007-11-08 19:33:05 +00001386#else
Victor Stinner8c62be82010-05-06 00:08:46 +00001387 char **e;
Thomas Hellerf78f12a2007-11-08 19:33:05 +00001388#endif
Guido van Rossumd48f2521997-12-05 22:19:34 +00001389
Victor Stinner8c62be82010-05-06 00:08:46 +00001390 d = PyDict_New();
1391 if (d == NULL)
1392 return NULL;
Ronald Oussoren697e56d2013-01-25 17:57:13 +01001393#if defined(WITH_NEXT_FRAMEWORK) || (defined(__APPLE__) && defined(Py_ENABLE_SHARED))
Victor Stinner8c62be82010-05-06 00:08:46 +00001394 if (environ == NULL)
1395 environ = *_NSGetEnviron();
1396#endif
1397#ifdef MS_WINDOWS
1398 /* _wenviron must be initialized in this way if the program is started
1399 through main() instead of wmain(). */
1400 _wgetenv(L"");
Serhiy Storchaka6fef0f12018-12-10 12:10:56 +02001401 e = _wenviron;
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
2830 Py_BEGIN_ALLOW_THREADS
2831#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07002832 /* on unix, success = 0, on windows, success = !0 */
2833 result = !win32_wchdir(path->wide);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002834#else
2835#ifdef HAVE_FCHDIR
Larry Hastings2f936352014-08-05 14:04:04 +10002836 if (path->fd != -1)
2837 result = fchdir(path->fd);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002838 else
2839#endif
Larry Hastings2f936352014-08-05 14:04:04 +10002840 result = chdir(path->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002841#endif
2842 Py_END_ALLOW_THREADS
2843
2844 if (result) {
Larry Hastings2f936352014-08-05 14:04:04 +10002845 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002846 }
2847
Larry Hastings2f936352014-08-05 14:04:04 +10002848 Py_RETURN_NONE;
2849}
2850
2851
2852#ifdef HAVE_FCHDIR
2853/*[clinic input]
2854os.fchdir
2855
2856 fd: fildes
2857
2858Change to the directory of the given file descriptor.
2859
2860fd must be opened on a directory, not a file.
2861Equivalent to os.chdir(fd).
2862
2863[clinic start generated code]*/
2864
Fred Drake4d1e64b2002-04-15 19:40:07 +00002865static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002866os_fchdir_impl(PyObject *module, int fd)
2867/*[clinic end generated code: output=42e064ec4dc00ab0 input=18e816479a2fa985]*/
Fred Drake4d1e64b2002-04-15 19:40:07 +00002868{
Larry Hastings2f936352014-08-05 14:04:04 +10002869 return posix_fildes_fd(fd, fchdir);
Fred Drake4d1e64b2002-04-15 19:40:07 +00002870}
2871#endif /* HAVE_FCHDIR */
2872
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00002873
Larry Hastings2f936352014-08-05 14:04:04 +10002874/*[clinic input]
2875os.chmod
2876
2877 path: path_t(allow_fd='PATH_HAVE_FCHMOD')
BNMetricsb9427072018-11-02 15:20:19 +00002878 Path to be modified. May always be specified as a str, bytes, or a path-like object.
Larry Hastings2f936352014-08-05 14:04:04 +10002879 On some platforms, path may also be specified as an open file descriptor.
2880 If this functionality is unavailable, using it raises an exception.
2881
2882 mode: int
2883 Operating-system mode bitfield.
2884
2885 *
2886
2887 dir_fd : dir_fd(requires='fchmodat') = None
2888 If not None, it should be a file descriptor open to a directory,
2889 and path should be relative; path will then be relative to that
2890 directory.
2891
2892 follow_symlinks: bool = True
2893 If False, and the last element of the path is a symbolic link,
2894 chmod will modify the symbolic link itself instead of the file
2895 the link points to.
2896
2897Change the access permissions of a file.
2898
2899It is an error to use dir_fd or follow_symlinks when specifying path as
2900 an open file descriptor.
2901dir_fd and follow_symlinks may not be implemented on your platform.
2902 If they are unavailable, using them will raise a NotImplementedError.
2903
2904[clinic start generated code]*/
2905
Larry Hastings2f936352014-08-05 14:04:04 +10002906static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002907os_chmod_impl(PyObject *module, path_t *path, int mode, int dir_fd,
Larry Hastings89964c42015-04-14 18:07:59 -04002908 int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +00002909/*[clinic end generated code: output=5cf6a94915cc7bff input=989081551c00293b]*/
Larry Hastings2f936352014-08-05 14:04:04 +10002910{
Larry Hastings9cf065c2012-06-22 16:30:09 -07002911 int result;
Larry Hastings9cf065c2012-06-22 16:30:09 -07002912
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00002913#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00002914 DWORD attr;
Larry Hastings9cf065c2012-06-22 16:30:09 -07002915#endif
Hirokazu Yamamoto892a37a2009-06-28 11:07:03 +00002916
Larry Hastings9cf065c2012-06-22 16:30:09 -07002917#ifdef HAVE_FCHMODAT
2918 int fchmodat_nofollow_unsupported = 0;
2919#endif
2920
Larry Hastings9cf065c2012-06-22 16:30:09 -07002921#if !(defined(HAVE_FCHMODAT) || defined(HAVE_LCHMOD))
2922 if (follow_symlinks_specified("chmod", follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10002923 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07002924#endif
2925
2926#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00002927 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07002928 attr = GetFileAttributesW(path->wide);
Tim Golden23005082013-10-25 11:22:37 +01002929 if (attr == INVALID_FILE_ATTRIBUTES)
Larry Hastings9cf065c2012-06-22 16:30:09 -07002930 result = 0;
2931 else {
2932 if (mode & _S_IWRITE)
Victor Stinner8c62be82010-05-06 00:08:46 +00002933 attr &= ~FILE_ATTRIBUTE_READONLY;
2934 else
2935 attr |= FILE_ATTRIBUTE_READONLY;
Steve Dowercc16be82016-09-08 10:35:16 -07002936 result = SetFileAttributesW(path->wide, attr);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002937 }
2938 Py_END_ALLOW_THREADS
2939
2940 if (!result) {
Larry Hastings2f936352014-08-05 14:04:04 +10002941 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002942 }
2943#else /* MS_WINDOWS */
2944 Py_BEGIN_ALLOW_THREADS
2945#ifdef HAVE_FCHMOD
Larry Hastings2f936352014-08-05 14:04:04 +10002946 if (path->fd != -1)
2947 result = fchmod(path->fd, mode);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002948 else
2949#endif
2950#ifdef HAVE_LCHMOD
2951 if ((!follow_symlinks) && (dir_fd == DEFAULT_DIR_FD))
Larry Hastings2f936352014-08-05 14:04:04 +10002952 result = lchmod(path->narrow, mode);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002953 else
2954#endif
2955#ifdef HAVE_FCHMODAT
2956 if ((dir_fd != DEFAULT_DIR_FD) || !follow_symlinks) {
2957 /*
2958 * fchmodat() doesn't currently support AT_SYMLINK_NOFOLLOW!
2959 * The documentation specifically shows how to use it,
Larry Hastingsdbbc0c82012-06-22 19:50:21 -07002960 * and then says it isn't implemented yet.
2961 * (true on linux with glibc 2.15, and openindiana 3.x)
Larry Hastings9cf065c2012-06-22 16:30:09 -07002962 *
2963 * Once it is supported, os.chmod will automatically
2964 * support dir_fd and follow_symlinks=False. (Hopefully.)
2965 * Until then, we need to be careful what exception we raise.
2966 */
Larry Hastings2f936352014-08-05 14:04:04 +10002967 result = fchmodat(dir_fd, path->narrow, mode,
Larry Hastings9cf065c2012-06-22 16:30:09 -07002968 follow_symlinks ? 0 : AT_SYMLINK_NOFOLLOW);
2969 /*
2970 * But wait! We can't throw the exception without allowing threads,
2971 * and we can't do that in this nested scope. (Macro trickery, sigh.)
2972 */
2973 fchmodat_nofollow_unsupported =
Larry Hastingsdbbc0c82012-06-22 19:50:21 -07002974 result &&
2975 ((errno == ENOTSUP) || (errno == EOPNOTSUPP)) &&
2976 !follow_symlinks;
Victor Stinner8c62be82010-05-06 00:08:46 +00002977 }
2978 else
Thomas Wouters477c8d52006-05-27 19:21:47 +00002979#endif
Larry Hastings2f936352014-08-05 14:04:04 +10002980 result = chmod(path->narrow, mode);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002981 Py_END_ALLOW_THREADS
2982
2983 if (result) {
2984#ifdef HAVE_FCHMODAT
2985 if (fchmodat_nofollow_unsupported) {
2986 if (dir_fd != DEFAULT_DIR_FD)
2987 dir_fd_and_follow_symlinks_invalid("chmod",
2988 dir_fd, follow_symlinks);
2989 else
2990 follow_symlinks_specified("chmod", follow_symlinks);
Anthony Sottile233ef242017-12-14 08:57:55 -08002991 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07002992 }
2993 else
2994#endif
Larry Hastings2f936352014-08-05 14:04:04 +10002995 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002996 }
2997#endif
2998
Larry Hastings2f936352014-08-05 14:04:04 +10002999 Py_RETURN_NONE;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003000}
3001
Larry Hastings9cf065c2012-06-22 16:30:09 -07003002
Christian Heimes4e30a842007-11-30 22:12:06 +00003003#ifdef HAVE_FCHMOD
Larry Hastings2f936352014-08-05 14:04:04 +10003004/*[clinic input]
3005os.fchmod
3006
3007 fd: int
3008 mode: int
3009
3010Change the access permissions of the file given by file descriptor fd.
3011
3012Equivalent to os.chmod(fd, mode).
3013[clinic start generated code]*/
3014
Larry Hastings2f936352014-08-05 14:04:04 +10003015static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003016os_fchmod_impl(PyObject *module, int fd, int mode)
3017/*[clinic end generated code: output=afd9bc05b4e426b3 input=8ab11975ca01ee5b]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003018{
3019 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003020 int async_err = 0;
3021
3022 do {
3023 Py_BEGIN_ALLOW_THREADS
3024 res = fchmod(fd, mode);
3025 Py_END_ALLOW_THREADS
3026 } while (res != 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
3027 if (res != 0)
3028 return (!async_err) ? posix_error() : NULL;
3029
Victor Stinner8c62be82010-05-06 00:08:46 +00003030 Py_RETURN_NONE;
Christian Heimes4e30a842007-11-30 22:12:06 +00003031}
3032#endif /* HAVE_FCHMOD */
3033
Larry Hastings2f936352014-08-05 14:04:04 +10003034
Christian Heimes4e30a842007-11-30 22:12:06 +00003035#ifdef HAVE_LCHMOD
Larry Hastings2f936352014-08-05 14:04:04 +10003036/*[clinic input]
3037os.lchmod
3038
3039 path: path_t
3040 mode: int
3041
3042Change the access permissions of a file, without following symbolic links.
3043
3044If path is a symlink, this affects the link itself rather than the target.
3045Equivalent to chmod(path, mode, follow_symlinks=False)."
3046[clinic start generated code]*/
3047
Larry Hastings2f936352014-08-05 14:04:04 +10003048static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003049os_lchmod_impl(PyObject *module, path_t *path, int mode)
3050/*[clinic end generated code: output=082344022b51a1d5 input=90c5663c7465d24f]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003051{
Victor Stinner8c62be82010-05-06 00:08:46 +00003052 int res;
Victor Stinner8c62be82010-05-06 00:08:46 +00003053 Py_BEGIN_ALLOW_THREADS
Larry Hastingsb1dc1122014-08-05 16:06:16 +10003054 res = lchmod(path->narrow, mode);
Victor Stinner8c62be82010-05-06 00:08:46 +00003055 Py_END_ALLOW_THREADS
Victor Stinner292c8352012-10-30 02:17:38 +01003056 if (res < 0) {
Larry Hastings2f936352014-08-05 14:04:04 +10003057 path_error(path);
Victor Stinner292c8352012-10-30 02:17:38 +01003058 return NULL;
3059 }
Victor Stinner8c62be82010-05-06 00:08:46 +00003060 Py_RETURN_NONE;
Christian Heimes4e30a842007-11-30 22:12:06 +00003061}
3062#endif /* HAVE_LCHMOD */
3063
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00003064
Thomas Wouterscf297e42007-02-23 15:07:44 +00003065#ifdef HAVE_CHFLAGS
Larry Hastings2f936352014-08-05 14:04:04 +10003066/*[clinic input]
3067os.chflags
3068
3069 path: path_t
3070 flags: unsigned_long(bitwise=True)
3071 follow_symlinks: bool=True
3072
3073Set file flags.
3074
3075If follow_symlinks is False, and the last element of the path is a symbolic
3076 link, chflags will change flags on the symbolic link itself instead of the
3077 file the link points to.
3078follow_symlinks may not be implemented on your platform. If it is
3079unavailable, using it will raise a NotImplementedError.
3080
3081[clinic start generated code]*/
3082
Larry Hastings2f936352014-08-05 14:04:04 +10003083static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003084os_chflags_impl(PyObject *module, path_t *path, unsigned long flags,
Larry Hastings89964c42015-04-14 18:07:59 -04003085 int follow_symlinks)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003086/*[clinic end generated code: output=85571c6737661ce9 input=0327e29feb876236]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003087{
3088 int result;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003089
3090#ifndef HAVE_LCHFLAGS
3091 if (follow_symlinks_specified("chflags", follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10003092 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003093#endif
3094
Victor Stinner8c62be82010-05-06 00:08:46 +00003095 Py_BEGIN_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07003096#ifdef HAVE_LCHFLAGS
3097 if (!follow_symlinks)
Larry Hastings2f936352014-08-05 14:04:04 +10003098 result = lchflags(path->narrow, flags);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003099 else
3100#endif
Larry Hastings2f936352014-08-05 14:04:04 +10003101 result = chflags(path->narrow, flags);
Victor Stinner8c62be82010-05-06 00:08:46 +00003102 Py_END_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07003103
Larry Hastings2f936352014-08-05 14:04:04 +10003104 if (result)
3105 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003106
Larry Hastings2f936352014-08-05 14:04:04 +10003107 Py_RETURN_NONE;
Thomas Wouterscf297e42007-02-23 15:07:44 +00003108}
3109#endif /* HAVE_CHFLAGS */
3110
Larry Hastings2f936352014-08-05 14:04:04 +10003111
Thomas Wouterscf297e42007-02-23 15:07:44 +00003112#ifdef HAVE_LCHFLAGS
Larry Hastings2f936352014-08-05 14:04:04 +10003113/*[clinic input]
3114os.lchflags
3115
3116 path: path_t
3117 flags: unsigned_long(bitwise=True)
3118
3119Set file flags.
3120
3121This function will not follow symbolic links.
3122Equivalent to chflags(path, flags, follow_symlinks=False).
3123[clinic start generated code]*/
3124
Larry Hastings2f936352014-08-05 14:04:04 +10003125static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003126os_lchflags_impl(PyObject *module, path_t *path, unsigned long flags)
3127/*[clinic end generated code: output=30ae958695c07316 input=f9f82ea8b585ca9d]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003128{
Victor Stinner8c62be82010-05-06 00:08:46 +00003129 int res;
Victor Stinner8c62be82010-05-06 00:08:46 +00003130 Py_BEGIN_ALLOW_THREADS
Larry Hastingsb1dc1122014-08-05 16:06:16 +10003131 res = lchflags(path->narrow, flags);
Victor Stinner8c62be82010-05-06 00:08:46 +00003132 Py_END_ALLOW_THREADS
Victor Stinner292c8352012-10-30 02:17:38 +01003133 if (res < 0) {
Larry Hastings2f936352014-08-05 14:04:04 +10003134 return path_error(path);
Victor Stinner292c8352012-10-30 02:17:38 +01003135 }
Victor Stinner292c8352012-10-30 02:17:38 +01003136 Py_RETURN_NONE;
Thomas Wouterscf297e42007-02-23 15:07:44 +00003137}
3138#endif /* HAVE_LCHFLAGS */
3139
Larry Hastings2f936352014-08-05 14:04:04 +10003140
Martin v. Löwis244edc82001-10-04 22:44:26 +00003141#ifdef HAVE_CHROOT
Larry Hastings2f936352014-08-05 14:04:04 +10003142/*[clinic input]
3143os.chroot
3144 path: path_t
3145
3146Change root directory to path.
3147
3148[clinic start generated code]*/
3149
Larry Hastings2f936352014-08-05 14:04:04 +10003150static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003151os_chroot_impl(PyObject *module, path_t *path)
3152/*[clinic end generated code: output=de80befc763a4475 input=14822965652c3dc3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003153{
3154 int res;
3155 Py_BEGIN_ALLOW_THREADS
3156 res = chroot(path->narrow);
3157 Py_END_ALLOW_THREADS
3158 if (res < 0)
3159 return path_error(path);
3160 Py_RETURN_NONE;
3161}
3162#endif /* HAVE_CHROOT */
3163
Martin v. Löwis244edc82001-10-04 22:44:26 +00003164
Guido van Rossum21142a01999-01-08 21:05:37 +00003165#ifdef HAVE_FSYNC
Larry Hastings2f936352014-08-05 14:04:04 +10003166/*[clinic input]
3167os.fsync
3168
3169 fd: fildes
3170
3171Force write of fd to disk.
3172[clinic start generated code]*/
3173
Larry Hastings2f936352014-08-05 14:04:04 +10003174static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003175os_fsync_impl(PyObject *module, int fd)
3176/*[clinic end generated code: output=4a10d773f52b3584 input=21c3645c056967f2]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003177{
3178 return posix_fildes_fd(fd, fsync);
Guido van Rossum21142a01999-01-08 21:05:37 +00003179}
3180#endif /* HAVE_FSYNC */
3181
Larry Hastings2f936352014-08-05 14:04:04 +10003182
Ross Lagerwall7807c352011-03-17 20:20:30 +02003183#ifdef HAVE_SYNC
Larry Hastings2f936352014-08-05 14:04:04 +10003184/*[clinic input]
3185os.sync
3186
3187Force write of everything to disk.
3188[clinic start generated code]*/
3189
Larry Hastings2f936352014-08-05 14:04:04 +10003190static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003191os_sync_impl(PyObject *module)
3192/*[clinic end generated code: output=2796b1f0818cd71c input=84749fe5e9b404ff]*/
Ross Lagerwall7807c352011-03-17 20:20:30 +02003193{
3194 Py_BEGIN_ALLOW_THREADS
3195 sync();
3196 Py_END_ALLOW_THREADS
3197 Py_RETURN_NONE;
3198}
Larry Hastings2f936352014-08-05 14:04:04 +10003199#endif /* HAVE_SYNC */
3200
Ross Lagerwall7807c352011-03-17 20:20:30 +02003201
Guido van Rossum21142a01999-01-08 21:05:37 +00003202#ifdef HAVE_FDATASYNC
Guido van Rossum7f58e2e2000-09-22 17:26:14 +00003203#ifdef __hpux
Guido van Rossumecc23b02000-09-22 16:01:05 +00003204extern int fdatasync(int); /* On HP-UX, in libc but not in unistd.h */
3205#endif
3206
Larry Hastings2f936352014-08-05 14:04:04 +10003207/*[clinic input]
3208os.fdatasync
3209
3210 fd: fildes
3211
3212Force write of fd to disk without forcing update of metadata.
3213[clinic start generated code]*/
3214
Larry Hastings2f936352014-08-05 14:04:04 +10003215static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003216os_fdatasync_impl(PyObject *module, int fd)
3217/*[clinic end generated code: output=b4b9698b5d7e26dd input=bc74791ee54dd291]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003218{
3219 return posix_fildes_fd(fd, fdatasync);
Guido van Rossum21142a01999-01-08 21:05:37 +00003220}
3221#endif /* HAVE_FDATASYNC */
3222
3223
Fredrik Lundh10723342000-07-10 16:38:09 +00003224#ifdef HAVE_CHOWN
Larry Hastings2f936352014-08-05 14:04:04 +10003225/*[clinic input]
3226os.chown
3227
3228 path : path_t(allow_fd='PATH_HAVE_FCHOWN')
BNMetricsb9427072018-11-02 15:20:19 +00003229 Path to be examined; can be string, bytes, a path-like object, or open-file-descriptor int.
Larry Hastings2f936352014-08-05 14:04:04 +10003230
3231 uid: uid_t
3232
3233 gid: gid_t
3234
3235 *
3236
3237 dir_fd : dir_fd(requires='fchownat') = None
3238 If not None, it should be a file descriptor open to a directory,
3239 and path should be relative; path will then be relative to that
3240 directory.
3241
3242 follow_symlinks: bool = True
3243 If False, and the last element of the path is a symbolic link,
3244 stat will examine the symbolic link itself instead of the file
3245 the link points to.
3246
3247Change the owner and group id of path to the numeric uid and gid.\
3248
3249path may always be specified as a string.
3250On some platforms, path may also be specified as an open file descriptor.
3251 If this functionality is unavailable, using it raises an exception.
3252If dir_fd is not None, it should be a file descriptor open to a directory,
3253 and path should be relative; path will then be relative to that directory.
3254If follow_symlinks is False, and the last element of the path is a symbolic
3255 link, chown will modify the symbolic link itself instead of the file the
3256 link points to.
3257It is an error to use dir_fd or follow_symlinks when specifying path as
3258 an open file descriptor.
3259dir_fd and follow_symlinks may not be implemented on your platform.
3260 If they are unavailable, using them will raise a NotImplementedError.
3261
3262[clinic start generated code]*/
3263
Larry Hastings2f936352014-08-05 14:04:04 +10003264static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003265os_chown_impl(PyObject *module, path_t *path, uid_t uid, gid_t gid,
Larry Hastings89964c42015-04-14 18:07:59 -04003266 int dir_fd, int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +00003267/*[clinic end generated code: output=4beadab0db5f70cd input=b08c5ec67996a97d]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003268{
3269 int result;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003270
3271#if !(defined(HAVE_LCHOWN) || defined(HAVE_FCHOWNAT))
3272 if (follow_symlinks_specified("chown", follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10003273 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003274#endif
Larry Hastings2f936352014-08-05 14:04:04 +10003275 if (dir_fd_and_fd_invalid("chown", dir_fd, path->fd) ||
3276 fd_and_follow_symlinks_invalid("chown", path->fd, follow_symlinks))
3277 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003278
3279#ifdef __APPLE__
3280 /*
3281 * This is for Mac OS X 10.3, which doesn't have lchown.
3282 * (But we still have an lchown symbol because of weak-linking.)
3283 * It doesn't have fchownat either. So there's no possibility
3284 * of a graceful failover.
Georg Brandlf7875592012-06-24 13:58:31 +02003285 */
Larry Hastings9cf065c2012-06-22 16:30:09 -07003286 if ((!follow_symlinks) && (lchown == NULL)) {
3287 follow_symlinks_specified("chown", follow_symlinks);
Larry Hastings2f936352014-08-05 14:04:04 +10003288 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003289 }
3290#endif
3291
Victor Stinner8c62be82010-05-06 00:08:46 +00003292 Py_BEGIN_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07003293#ifdef HAVE_FCHOWN
Larry Hastings2f936352014-08-05 14:04:04 +10003294 if (path->fd != -1)
3295 result = fchown(path->fd, uid, gid);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003296 else
3297#endif
3298#ifdef HAVE_LCHOWN
3299 if ((!follow_symlinks) && (dir_fd == DEFAULT_DIR_FD))
Larry Hastings2f936352014-08-05 14:04:04 +10003300 result = lchown(path->narrow, uid, gid);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003301 else
3302#endif
3303#ifdef HAVE_FCHOWNAT
3304 if ((dir_fd != DEFAULT_DIR_FD) || (!follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10003305 result = fchownat(dir_fd, path->narrow, uid, gid,
Larry Hastings9cf065c2012-06-22 16:30:09 -07003306 follow_symlinks ? 0 : AT_SYMLINK_NOFOLLOW);
3307 else
3308#endif
Larry Hastings2f936352014-08-05 14:04:04 +10003309 result = chown(path->narrow, uid, gid);
Victor Stinner8c62be82010-05-06 00:08:46 +00003310 Py_END_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07003311
Larry Hastings2f936352014-08-05 14:04:04 +10003312 if (result)
3313 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003314
Larry Hastings2f936352014-08-05 14:04:04 +10003315 Py_RETURN_NONE;
Guido van Rossumb6775db1994-08-01 11:34:53 +00003316}
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00003317#endif /* HAVE_CHOWN */
Guido van Rossumb6775db1994-08-01 11:34:53 +00003318
Larry Hastings2f936352014-08-05 14:04:04 +10003319
Christian Heimes4e30a842007-11-30 22:12:06 +00003320#ifdef HAVE_FCHOWN
Larry Hastings2f936352014-08-05 14:04:04 +10003321/*[clinic input]
3322os.fchown
3323
3324 fd: int
3325 uid: uid_t
3326 gid: gid_t
3327
3328Change the owner and group id of the file specified by file descriptor.
3329
3330Equivalent to os.chown(fd, uid, gid).
3331
3332[clinic start generated code]*/
3333
Larry Hastings2f936352014-08-05 14:04:04 +10003334static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003335os_fchown_impl(PyObject *module, int fd, uid_t uid, gid_t gid)
3336/*[clinic end generated code: output=97d21cbd5a4350a6 input=3af544ba1b13a0d7]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003337{
Victor Stinner8c62be82010-05-06 00:08:46 +00003338 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003339 int async_err = 0;
3340
3341 do {
3342 Py_BEGIN_ALLOW_THREADS
3343 res = fchown(fd, uid, gid);
3344 Py_END_ALLOW_THREADS
3345 } while (res != 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
3346 if (res != 0)
3347 return (!async_err) ? posix_error() : NULL;
3348
Victor Stinner8c62be82010-05-06 00:08:46 +00003349 Py_RETURN_NONE;
Christian Heimes4e30a842007-11-30 22:12:06 +00003350}
3351#endif /* HAVE_FCHOWN */
3352
Larry Hastings2f936352014-08-05 14:04:04 +10003353
Martin v. Löwis0cec0ff2002-07-28 16:33:45 +00003354#ifdef HAVE_LCHOWN
Larry Hastings2f936352014-08-05 14:04:04 +10003355/*[clinic input]
3356os.lchown
3357
3358 path : path_t
3359 uid: uid_t
3360 gid: gid_t
3361
3362Change the owner and group id of path to the numeric uid and gid.
3363
3364This function will not follow symbolic links.
3365Equivalent to os.chown(path, uid, gid, follow_symlinks=False).
3366[clinic start generated code]*/
3367
Larry Hastings2f936352014-08-05 14:04:04 +10003368static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003369os_lchown_impl(PyObject *module, path_t *path, uid_t uid, gid_t gid)
3370/*[clinic end generated code: output=25eaf6af412fdf2f input=b1c6014d563a7161]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003371{
Victor Stinner8c62be82010-05-06 00:08:46 +00003372 int res;
Victor Stinner8c62be82010-05-06 00:08:46 +00003373 Py_BEGIN_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10003374 res = lchown(path->narrow, uid, gid);
Victor Stinner8c62be82010-05-06 00:08:46 +00003375 Py_END_ALLOW_THREADS
Victor Stinner292c8352012-10-30 02:17:38 +01003376 if (res < 0) {
Larry Hastings2f936352014-08-05 14:04:04 +10003377 return path_error(path);
Victor Stinner292c8352012-10-30 02:17:38 +01003378 }
Larry Hastings2f936352014-08-05 14:04:04 +10003379 Py_RETURN_NONE;
Martin v. Löwis0cec0ff2002-07-28 16:33:45 +00003380}
3381#endif /* HAVE_LCHOWN */
3382
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00003383
Barry Warsaw53699e91996-12-10 23:23:01 +00003384static PyObject *
Guido van Rossumf0af3e32008-10-02 18:55:37 +00003385posix_getcwd(int use_bytes)
Mark Hammondc2e85bd2002-10-03 05:10:39 +00003386{
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00003387#ifdef MS_WINDOWS
Miss Islington (bot)63429c82019-06-26 09:14:30 -07003388 wchar_t wbuf[MAXPATHLEN];
3389 wchar_t *wbuf2 = wbuf;
3390 DWORD len;
3391
3392 Py_BEGIN_ALLOW_THREADS
3393 len = GetCurrentDirectoryW(Py_ARRAY_LENGTH(wbuf), wbuf);
3394 /* If the buffer is large enough, len does not include the
3395 terminating \0. If the buffer is too small, len includes
3396 the space needed for the terminator. */
3397 if (len >= Py_ARRAY_LENGTH(wbuf)) {
Miss Islington (bot)68c1c392019-06-28 09:23:06 -07003398 if (len <= PY_SSIZE_T_MAX / sizeof(wchar_t)) {
Victor Stinnerb6404912013-07-07 16:21:41 +02003399 wbuf2 = PyMem_RawMalloc(len * sizeof(wchar_t));
Victor Stinner8c62be82010-05-06 00:08:46 +00003400 }
Miss Islington (bot)63429c82019-06-26 09:14:30 -07003401 else {
3402 wbuf2 = NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00003403 }
Miss Islington (bot)63429c82019-06-26 09:14:30 -07003404 if (wbuf2) {
3405 len = GetCurrentDirectoryW(len, wbuf2);
Victor Stinner8c62be82010-05-06 00:08:46 +00003406 }
Miss Islington (bot)63429c82019-06-26 09:14:30 -07003407 }
3408 Py_END_ALLOW_THREADS
3409
3410 if (!wbuf2) {
3411 PyErr_NoMemory();
3412 return NULL;
3413 }
3414 if (!len) {
Victor Stinnerb024e842012-10-31 22:24:06 +01003415 if (wbuf2 != wbuf)
Victor Stinnerb6404912013-07-07 16:21:41 +02003416 PyMem_RawFree(wbuf2);
Miss Islington (bot)63429c82019-06-26 09:14:30 -07003417 return PyErr_SetFromWindowsErr(0);
Victor Stinner8c62be82010-05-06 00:08:46 +00003418 }
Victor Stinnerf7c5ae22011-11-16 23:43:07 +01003419
Miss Islington (bot)63429c82019-06-26 09:14:30 -07003420 PyObject *resobj = PyUnicode_FromWideChar(wbuf2, len);
3421 if (wbuf2 != wbuf) {
3422 PyMem_RawFree(wbuf2);
3423 }
Mark Hammondc2e85bd2002-10-03 05:10:39 +00003424
Miss Islington (bot)63429c82019-06-26 09:14:30 -07003425 if (use_bytes) {
3426 if (resobj == NULL) {
3427 return NULL;
3428 }
3429 Py_SETREF(resobj, PyUnicode_EncodeFSDefault(resobj));
3430 }
3431
3432 return resobj;
3433#else
3434 const size_t chunk = 1024;
3435
3436 char *buf = NULL;
3437 char *cwd = NULL;
3438 size_t buflen = 0;
3439
Victor Stinner8c62be82010-05-06 00:08:46 +00003440 Py_BEGIN_ALLOW_THREADS
Victor Stinner4403d7d2015-04-25 00:16:10 +02003441 do {
Miss Islington (bot)63429c82019-06-26 09:14:30 -07003442 char *newbuf;
3443 if (buflen <= PY_SSIZE_T_MAX - chunk) {
3444 buflen += chunk;
3445 newbuf = PyMem_RawRealloc(buf, buflen);
3446 }
3447 else {
3448 newbuf = NULL;
3449 }
3450 if (newbuf == NULL) {
3451 PyMem_RawFree(buf);
3452 buf = NULL;
Victor Stinnerc44f7072016-03-14 18:07:53 +01003453 break;
3454 }
Miss Islington (bot)63429c82019-06-26 09:14:30 -07003455 buf = newbuf;
Victor Stinner4403d7d2015-04-25 00:16:10 +02003456
Victor Stinner4403d7d2015-04-25 00:16:10 +02003457 cwd = getcwd(buf, buflen);
3458 } while (cwd == NULL && errno == ERANGE);
Victor Stinner8c62be82010-05-06 00:08:46 +00003459 Py_END_ALLOW_THREADS
Victor Stinner4403d7d2015-04-25 00:16:10 +02003460
Miss Islington (bot)63429c82019-06-26 09:14:30 -07003461 if (buf == NULL) {
3462 return PyErr_NoMemory();
3463 }
Victor Stinner4403d7d2015-04-25 00:16:10 +02003464 if (cwd == NULL) {
3465 PyMem_RawFree(buf);
Victor Stinner8c62be82010-05-06 00:08:46 +00003466 return posix_error();
Victor Stinner4403d7d2015-04-25 00:16:10 +02003467 }
3468
Miss Islington (bot)63429c82019-06-26 09:14:30 -07003469 PyObject *obj;
3470 if (use_bytes) {
Victor Stinner4403d7d2015-04-25 00:16:10 +02003471 obj = PyBytes_FromStringAndSize(buf, strlen(buf));
Miss Islington (bot)63429c82019-06-26 09:14:30 -07003472 }
3473 else {
Victor Stinner4403d7d2015-04-25 00:16:10 +02003474 obj = PyUnicode_DecodeFSDefault(buf);
Miss Islington (bot)63429c82019-06-26 09:14:30 -07003475 }
Victor Stinner4403d7d2015-04-25 00:16:10 +02003476 PyMem_RawFree(buf);
3477
3478 return obj;
Miss Islington (bot)63429c82019-06-26 09:14:30 -07003479#endif /* !MS_WINDOWS */
Mark Hammondc2e85bd2002-10-03 05:10:39 +00003480}
Guido van Rossumf0af3e32008-10-02 18:55:37 +00003481
Larry Hastings2f936352014-08-05 14:04:04 +10003482
3483/*[clinic input]
3484os.getcwd
3485
3486Return a unicode string representing the current working directory.
3487[clinic start generated code]*/
3488
Larry Hastings2f936352014-08-05 14:04:04 +10003489static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003490os_getcwd_impl(PyObject *module)
3491/*[clinic end generated code: output=21badfae2ea99ddc input=f069211bb70e3d39]*/
Guido van Rossumf0af3e32008-10-02 18:55:37 +00003492{
3493 return posix_getcwd(0);
3494}
3495
Larry Hastings2f936352014-08-05 14:04:04 +10003496
3497/*[clinic input]
3498os.getcwdb
3499
3500Return a bytes string representing the current working directory.
3501[clinic start generated code]*/
3502
Larry Hastings2f936352014-08-05 14:04:04 +10003503static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003504os_getcwdb_impl(PyObject *module)
3505/*[clinic end generated code: output=3dd47909480e4824 input=f6f6a378dad3d9cb]*/
Guido van Rossumf0af3e32008-10-02 18:55:37 +00003506{
3507 return posix_getcwd(1);
3508}
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003509
Larry Hastings2f936352014-08-05 14:04:04 +10003510
Larry Hastings9cf065c2012-06-22 16:30:09 -07003511#if ((!defined(HAVE_LINK)) && defined(MS_WINDOWS))
3512#define HAVE_LINK 1
3513#endif
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00003514
Guido van Rossumb6775db1994-08-01 11:34:53 +00003515#ifdef HAVE_LINK
Larry Hastings2f936352014-08-05 14:04:04 +10003516/*[clinic input]
3517
3518os.link
3519
3520 src : path_t
3521 dst : path_t
3522 *
3523 src_dir_fd : dir_fd = None
3524 dst_dir_fd : dir_fd = None
3525 follow_symlinks: bool = True
3526
3527Create a hard link to a file.
3528
3529If either src_dir_fd or dst_dir_fd is not None, it should be a file
3530 descriptor open to a directory, and the respective path string (src or dst)
3531 should be relative; the path will then be relative to that directory.
3532If follow_symlinks is False, and the last element of src is a symbolic
3533 link, link will create a link to the symbolic link itself instead of the
3534 file the link points to.
3535src_dir_fd, dst_dir_fd, and follow_symlinks may not be implemented on your
3536 platform. If they are unavailable, using them will raise a
3537 NotImplementedError.
3538[clinic start generated code]*/
3539
Larry Hastings2f936352014-08-05 14:04:04 +10003540static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003541os_link_impl(PyObject *module, path_t *src, path_t *dst, int src_dir_fd,
Larry Hastings89964c42015-04-14 18:07:59 -04003542 int dst_dir_fd, int follow_symlinks)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003543/*[clinic end generated code: output=7f00f6007fd5269a input=b0095ebbcbaa7e04]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003544{
Larry Hastings9cf065c2012-06-22 16:30:09 -07003545#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07003546 BOOL result = FALSE;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003547#else
3548 int result;
3549#endif
3550
Larry Hastings9cf065c2012-06-22 16:30:09 -07003551#ifndef HAVE_LINKAT
3552 if ((src_dir_fd != DEFAULT_DIR_FD) || (dst_dir_fd != DEFAULT_DIR_FD)) {
3553 argument_unavailable_error("link", "src_dir_fd and dst_dir_fd");
Larry Hastings2f936352014-08-05 14:04:04 +10003554 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003555 }
3556#endif
3557
Steve Dowercc16be82016-09-08 10:35:16 -07003558#ifndef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10003559 if ((src->narrow && dst->wide) || (src->wide && dst->narrow)) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07003560 PyErr_SetString(PyExc_NotImplementedError,
3561 "link: src and dst must be the same type");
Larry Hastings2f936352014-08-05 14:04:04 +10003562 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003563 }
Steve Dowercc16be82016-09-08 10:35:16 -07003564#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003565
Brian Curtin1b9df392010-11-24 20:24:31 +00003566#ifdef MS_WINDOWS
Larry Hastings9cf065c2012-06-22 16:30:09 -07003567 Py_BEGIN_ALLOW_THREADS
Steve Dowerc3630612016-11-19 18:41:16 -08003568 result = CreateHardLinkW(dst->wide, src->wide, NULL);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003569 Py_END_ALLOW_THREADS
Brian Curtin1b9df392010-11-24 20:24:31 +00003570
Larry Hastings2f936352014-08-05 14:04:04 +10003571 if (!result)
3572 return path_error2(src, dst);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003573#else
3574 Py_BEGIN_ALLOW_THREADS
Larry Hastings67cbf7b2012-06-22 17:06:48 -07003575#ifdef HAVE_LINKAT
Larry Hastings9cf065c2012-06-22 16:30:09 -07003576 if ((src_dir_fd != DEFAULT_DIR_FD) ||
3577 (dst_dir_fd != DEFAULT_DIR_FD) ||
3578 (!follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10003579 result = linkat(src_dir_fd, src->narrow,
3580 dst_dir_fd, dst->narrow,
Larry Hastings9cf065c2012-06-22 16:30:09 -07003581 follow_symlinks ? AT_SYMLINK_FOLLOW : 0);
3582 else
Steve Dowercc16be82016-09-08 10:35:16 -07003583#endif /* HAVE_LINKAT */
Larry Hastings2f936352014-08-05 14:04:04 +10003584 result = link(src->narrow, dst->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003585 Py_END_ALLOW_THREADS
Brian Curtinfc889c42010-11-28 23:59:46 +00003586
Larry Hastings2f936352014-08-05 14:04:04 +10003587 if (result)
3588 return path_error2(src, dst);
Steve Dowercc16be82016-09-08 10:35:16 -07003589#endif /* MS_WINDOWS */
Larry Hastings9cf065c2012-06-22 16:30:09 -07003590
Larry Hastings2f936352014-08-05 14:04:04 +10003591 Py_RETURN_NONE;
Brian Curtin1b9df392010-11-24 20:24:31 +00003592}
Larry Hastings9cf065c2012-06-22 16:30:09 -07003593#endif
3594
Brian Curtin1b9df392010-11-24 20:24:31 +00003595
Gregory P. Smith16ea14a2013-03-20 18:51:33 -07003596#if defined(MS_WINDOWS) && !defined(HAVE_OPENDIR)
Barry Warsaw53699e91996-12-10 23:23:01 +00003597static PyObject *
Gregory P. Smith40a21602013-03-20 20:52:50 -07003598_listdir_windows_no_opendir(path_t *path, PyObject *list)
Guido van Rossumb6775db1994-08-01 11:34:53 +00003599{
Larry Hastings9cf065c2012-06-22 16:30:09 -07003600 PyObject *v;
3601 HANDLE hFindFile = INVALID_HANDLE_VALUE;
3602 BOOL result;
Steve Dowercc16be82016-09-08 10:35:16 -07003603 wchar_t namebuf[MAX_PATH+4]; /* Overallocate for "\*.*" */
Larry Hastings9cf065c2012-06-22 16:30:09 -07003604 /* only claim to have space for MAX_PATH */
Victor Stinner75875072013-11-24 19:23:25 +01003605 Py_ssize_t len = Py_ARRAY_LENGTH(namebuf)-4;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003606 wchar_t *wnamebuf = NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003607
Steve Dowercc16be82016-09-08 10:35:16 -07003608 WIN32_FIND_DATAW wFileData;
3609 const wchar_t *po_wchars;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00003610
Steve Dowercc16be82016-09-08 10:35:16 -07003611 if (!path->wide) { /* Default arg: "." */
3612 po_wchars = L".";
3613 len = 1;
3614 } else {
3615 po_wchars = path->wide;
3616 len = wcslen(path->wide);
3617 }
3618 /* The +5 is so we can append "\\*.*\0" */
3619 wnamebuf = PyMem_New(wchar_t, len + 5);
3620 if (!wnamebuf) {
3621 PyErr_NoMemory();
Larry Hastings9cf065c2012-06-22 16:30:09 -07003622 goto exit;
Victor Stinner8c62be82010-05-06 00:08:46 +00003623 }
Steve Dowercc16be82016-09-08 10:35:16 -07003624 wcscpy(wnamebuf, po_wchars);
Victor Stinner8c62be82010-05-06 00:08:46 +00003625 if (len > 0) {
Steve Dowercc16be82016-09-08 10:35:16 -07003626 wchar_t wch = wnamebuf[len-1];
3627 if (wch != SEP && wch != ALTSEP && wch != L':')
3628 wnamebuf[len++] = SEP;
3629 wcscpy(wnamebuf + len, L"*.*");
Victor Stinner8c62be82010-05-06 00:08:46 +00003630 }
Steve Dowercc16be82016-09-08 10:35:16 -07003631 if ((list = PyList_New(0)) == NULL) {
3632 goto exit;
3633 }
Antoine Pitroub73caab2010-08-09 23:39:31 +00003634 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07003635 hFindFile = FindFirstFileW(wnamebuf, &wFileData);
Antoine Pitroub73caab2010-08-09 23:39:31 +00003636 Py_END_ALLOW_THREADS
Victor Stinner8c62be82010-05-06 00:08:46 +00003637 if (hFindFile == INVALID_HANDLE_VALUE) {
3638 int error = GetLastError();
3639 if (error == ERROR_FILE_NOT_FOUND)
Larry Hastings9cf065c2012-06-22 16:30:09 -07003640 goto exit;
3641 Py_DECREF(list);
Gregory P. Smith40a21602013-03-20 20:52:50 -07003642 list = path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003643 goto exit;
Victor Stinner8c62be82010-05-06 00:08:46 +00003644 }
3645 do {
3646 /* Skip over . and .. */
Steve Dowercc16be82016-09-08 10:35:16 -07003647 if (wcscmp(wFileData.cFileName, L".") != 0 &&
3648 wcscmp(wFileData.cFileName, L"..") != 0) {
3649 v = PyUnicode_FromWideChar(wFileData.cFileName,
3650 wcslen(wFileData.cFileName));
3651 if (path->narrow && v) {
3652 Py_SETREF(v, PyUnicode_EncodeFSDefault(v));
3653 }
Victor Stinner8c62be82010-05-06 00:08:46 +00003654 if (v == NULL) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07003655 Py_DECREF(list);
3656 list = NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00003657 break;
3658 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07003659 if (PyList_Append(list, v) != 0) {
Victor Stinner8c62be82010-05-06 00:08:46 +00003660 Py_DECREF(v);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003661 Py_DECREF(list);
3662 list = NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00003663 break;
3664 }
3665 Py_DECREF(v);
3666 }
3667 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07003668 result = FindNextFileW(hFindFile, &wFileData);
Victor Stinner8c62be82010-05-06 00:08:46 +00003669 Py_END_ALLOW_THREADS
3670 /* FindNextFile sets error to ERROR_NO_MORE_FILES if
3671 it got to the end of the directory. */
3672 if (!result && GetLastError() != ERROR_NO_MORE_FILES) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07003673 Py_DECREF(list);
Gregory P. Smith40a21602013-03-20 20:52:50 -07003674 list = path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003675 goto exit;
Victor Stinner8c62be82010-05-06 00:08:46 +00003676 }
3677 } while (result == TRUE);
Guido van Rossumb6775db1994-08-01 11:34:53 +00003678
Larry Hastings9cf065c2012-06-22 16:30:09 -07003679exit:
3680 if (hFindFile != INVALID_HANDLE_VALUE) {
3681 if (FindClose(hFindFile) == FALSE) {
3682 if (list != NULL) {
3683 Py_DECREF(list);
Gregory P. Smith40a21602013-03-20 20:52:50 -07003684 list = path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003685 }
3686 }
Victor Stinner8c62be82010-05-06 00:08:46 +00003687 }
Victor Stinnerb6404912013-07-07 16:21:41 +02003688 PyMem_Free(wnamebuf);
Guido van Rossumb6775db1994-08-01 11:34:53 +00003689
Larry Hastings9cf065c2012-06-22 16:30:09 -07003690 return list;
Gregory P. Smith16ea14a2013-03-20 18:51:33 -07003691} /* end of _listdir_windows_no_opendir */
3692
3693#else /* thus POSIX, ie: not (MS_WINDOWS and not HAVE_OPENDIR) */
3694
3695static PyObject *
Gregory P. Smith40a21602013-03-20 20:52:50 -07003696_posix_listdir(path_t *path, PyObject *list)
Gregory P. Smith16ea14a2013-03-20 18:51:33 -07003697{
Gregory P. Smith16ea14a2013-03-20 18:51:33 -07003698 PyObject *v;
3699 DIR *dirp = NULL;
3700 struct dirent *ep;
3701 int return_str; /* if false, return bytes */
Larry Hastings4dbc95e2013-08-01 18:18:56 -07003702#ifdef HAVE_FDOPENDIR
3703 int fd = -1;
3704#endif
Gregory P. Smith16ea14a2013-03-20 18:51:33 -07003705
Victor Stinner8c62be82010-05-06 00:08:46 +00003706 errno = 0;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003707#ifdef HAVE_FDOPENDIR
Gregory P. Smith40a21602013-03-20 20:52:50 -07003708 if (path->fd != -1) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07003709 /* closedir() closes the FD, so we duplicate it */
Victor Stinnerdaf45552013-08-28 00:53:59 +02003710 fd = _Py_dup(path->fd);
Victor Stinnerf3266652013-12-19 13:24:49 +01003711 if (fd == -1)
3712 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003713
Larry Hastingsfdaea062012-06-25 04:42:23 -07003714 return_str = 1;
3715
Larry Hastings9cf065c2012-06-22 16:30:09 -07003716 Py_BEGIN_ALLOW_THREADS
3717 dirp = fdopendir(fd);
3718 Py_END_ALLOW_THREADS
3719 }
3720 else
3721#endif
3722 {
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03003723 const char *name;
Gregory P. Smith40a21602013-03-20 20:52:50 -07003724 if (path->narrow) {
3725 name = path->narrow;
Serhiy Storchaka1180e5a2017-07-11 06:36:46 +03003726 /* only return bytes if they specified a bytes-like object */
3727 return_str = !PyObject_CheckBuffer(path->object);
Larry Hastingsfdaea062012-06-25 04:42:23 -07003728 }
3729 else {
3730 name = ".";
3731 return_str = 1;
3732 }
3733
Larry Hastings9cf065c2012-06-22 16:30:09 -07003734 Py_BEGIN_ALLOW_THREADS
3735 dirp = opendir(name);
3736 Py_END_ALLOW_THREADS
3737 }
3738
3739 if (dirp == NULL) {
Gregory P. Smith40a21602013-03-20 20:52:50 -07003740 list = path_error(path);
Larry Hastings4dbc95e2013-08-01 18:18:56 -07003741#ifdef HAVE_FDOPENDIR
3742 if (fd != -1) {
3743 Py_BEGIN_ALLOW_THREADS
3744 close(fd);
3745 Py_END_ALLOW_THREADS
3746 }
3747#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07003748 goto exit;
3749 }
3750 if ((list = PyList_New(0)) == NULL) {
3751 goto exit;
Victor Stinner8c62be82010-05-06 00:08:46 +00003752 }
3753 for (;;) {
3754 errno = 0;
3755 Py_BEGIN_ALLOW_THREADS
3756 ep = readdir(dirp);
3757 Py_END_ALLOW_THREADS
3758 if (ep == NULL) {
3759 if (errno == 0) {
3760 break;
3761 } else {
Larry Hastings9cf065c2012-06-22 16:30:09 -07003762 Py_DECREF(list);
Gregory P. Smith40a21602013-03-20 20:52:50 -07003763 list = path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003764 goto exit;
Victor Stinner8c62be82010-05-06 00:08:46 +00003765 }
3766 }
3767 if (ep->d_name[0] == '.' &&
3768 (NAMLEN(ep) == 1 ||
3769 (ep->d_name[1] == '.' && NAMLEN(ep) == 2)))
3770 continue;
Larry Hastingsfdaea062012-06-25 04:42:23 -07003771 if (return_str)
Victor Stinnera45598a2010-05-14 16:35:39 +00003772 v = PyUnicode_DecodeFSDefaultAndSize(ep->d_name, NAMLEN(ep));
3773 else
3774 v = PyBytes_FromStringAndSize(ep->d_name, NAMLEN(ep));
Victor Stinner8c62be82010-05-06 00:08:46 +00003775 if (v == NULL) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07003776 Py_CLEAR(list);
Victor Stinner8c62be82010-05-06 00:08:46 +00003777 break;
3778 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07003779 if (PyList_Append(list, v) != 0) {
Victor Stinner8c62be82010-05-06 00:08:46 +00003780 Py_DECREF(v);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003781 Py_CLEAR(list);
Victor Stinner8c62be82010-05-06 00:08:46 +00003782 break;
3783 }
3784 Py_DECREF(v);
3785 }
Guido van Rossum0ee42cd1991-04-08 21:01:03 +00003786
Larry Hastings9cf065c2012-06-22 16:30:09 -07003787exit:
3788 if (dirp != NULL) {
3789 Py_BEGIN_ALLOW_THREADS
Larry Hastings4dbc95e2013-08-01 18:18:56 -07003790#ifdef HAVE_FDOPENDIR
Larry Hastings9cf065c2012-06-22 16:30:09 -07003791 if (fd > -1)
3792 rewinddir(dirp);
Larry Hastings4dbc95e2013-08-01 18:18:56 -07003793#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07003794 closedir(dirp);
3795 Py_END_ALLOW_THREADS
3796 }
3797
Larry Hastings9cf065c2012-06-22 16:30:09 -07003798 return list;
Gregory P. Smith16ea14a2013-03-20 18:51:33 -07003799} /* end of _posix_listdir */
3800#endif /* which OS */
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00003801
Larry Hastings2f936352014-08-05 14:04:04 +10003802
3803/*[clinic input]
3804os.listdir
3805
3806 path : path_t(nullable=True, allow_fd='PATH_HAVE_FDOPENDIR') = None
3807
3808Return a list containing the names of the files in the directory.
3809
BNMetricsb9427072018-11-02 15:20:19 +00003810path can be specified as either str, bytes, or a path-like object. If path is bytes,
Larry Hastings2f936352014-08-05 14:04:04 +10003811 the filenames returned will also be bytes; in all other circumstances
3812 the filenames returned will be str.
3813If path is None, uses the path='.'.
3814On some platforms, path may also be specified as an open file descriptor;\
3815 the file descriptor must refer to a directory.
3816 If this functionality is unavailable, using it raises NotImplementedError.
3817
3818The list is in arbitrary order. It does not include the special
3819entries '.' and '..' even if they are present in the directory.
3820
3821
3822[clinic start generated code]*/
3823
Larry Hastings2f936352014-08-05 14:04:04 +10003824static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003825os_listdir_impl(PyObject *module, path_t *path)
BNMetricsb9427072018-11-02 15:20:19 +00003826/*[clinic end generated code: output=293045673fcd1a75 input=e3f58030f538295d]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003827{
Miss Islington (bot)8763d432019-06-24 09:09:47 -07003828 if (PySys_Audit("os.listdir", "O",
3829 path->object ? path->object : Py_None) < 0) {
3830 return NULL;
3831 }
Larry Hastings2f936352014-08-05 14:04:04 +10003832#if defined(MS_WINDOWS) && !defined(HAVE_OPENDIR)
3833 return _listdir_windows_no_opendir(path, NULL);
3834#else
3835 return _posix_listdir(path, NULL);
3836#endif
3837}
3838
Martin v. Löwis6238d2b2002-06-30 15:26:10 +00003839#ifdef MS_WINDOWS
Mark Hammondef8b6542001-05-13 08:04:26 +00003840/* A helper function for abspath on win32 */
Serhiy Storchakaf0b50152015-05-13 00:52:39 +03003841/*[clinic input]
3842os._getfullpathname
Victor Stinnereb5657a2011-09-30 01:44:27 +02003843
Serhiy Storchakaf0b50152015-05-13 00:52:39 +03003844 path: path_t
3845 /
3846
3847[clinic start generated code]*/
3848
3849static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003850os__getfullpathname_impl(PyObject *module, path_t *path)
3851/*[clinic end generated code: output=bb8679d56845bc9b input=332ed537c29d0a3e]*/
Serhiy Storchakaf0b50152015-05-13 00:52:39 +03003852{
Steve Dowercc16be82016-09-08 10:35:16 -07003853 wchar_t woutbuf[MAX_PATH], *woutbufp = woutbuf;
3854 wchar_t *wtemp;
3855 DWORD result;
3856 PyObject *v;
Victor Stinnereb5657a2011-09-30 01:44:27 +02003857
Steve Dowercc16be82016-09-08 10:35:16 -07003858 result = GetFullPathNameW(path->wide,
3859 Py_ARRAY_LENGTH(woutbuf),
3860 woutbuf, &wtemp);
3861 if (result > Py_ARRAY_LENGTH(woutbuf)) {
3862 woutbufp = PyMem_New(wchar_t, result);
3863 if (!woutbufp)
3864 return PyErr_NoMemory();
3865 result = GetFullPathNameW(path->wide, result, woutbufp, &wtemp);
Victor Stinner8c62be82010-05-06 00:08:46 +00003866 }
Steve Dowercc16be82016-09-08 10:35:16 -07003867 if (result) {
3868 v = PyUnicode_FromWideChar(woutbufp, wcslen(woutbufp));
3869 if (path->narrow)
3870 Py_SETREF(v, PyUnicode_EncodeFSDefault(v));
3871 } else
3872 v = win32_error_object("GetFullPathNameW", path->object);
3873 if (woutbufp != woutbuf)
3874 PyMem_Free(woutbufp);
3875 return v;
Larry Hastings2f936352014-08-05 14:04:04 +10003876}
Brian Curtind40e6f72010-07-08 21:39:08 +00003877
Brian Curtind25aef52011-06-13 15:16:04 -05003878
Larry Hastings2f936352014-08-05 14:04:04 +10003879/*[clinic input]
3880os._getfinalpathname
Brian Curtinf5e76d02010-11-24 13:14:05 +00003881
Steve Dower23ad6d02018-02-22 10:39:10 -08003882 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +10003883 /
3884
3885A helper function for samepath on windows.
3886[clinic start generated code]*/
3887
Larry Hastings2f936352014-08-05 14:04:04 +10003888static PyObject *
Steve Dower23ad6d02018-02-22 10:39:10 -08003889os__getfinalpathname_impl(PyObject *module, path_t *path)
3890/*[clinic end generated code: output=621a3c79bc29ebfa input=2b6b6c7cbad5fb84]*/
Brian Curtind40e6f72010-07-08 21:39:08 +00003891{
3892 HANDLE hFile;
Alexey Izbyshev3b20d342018-03-08 19:03:25 +03003893 wchar_t buf[MAXPATHLEN], *target_path = buf;
3894 int buf_size = Py_ARRAY_LENGTH(buf);
Brian Curtind40e6f72010-07-08 21:39:08 +00003895 int result_length;
Larry Hastings2f936352014-08-05 14:04:04 +10003896 PyObject *result;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00003897
Steve Dower23ad6d02018-02-22 10:39:10 -08003898 Py_BEGIN_ALLOW_THREADS
Brian Curtind40e6f72010-07-08 21:39:08 +00003899 hFile = CreateFileW(
Steve Dower23ad6d02018-02-22 10:39:10 -08003900 path->wide,
Brian Curtind40e6f72010-07-08 21:39:08 +00003901 0, /* desired access */
3902 0, /* share mode */
3903 NULL, /* security attributes */
3904 OPEN_EXISTING,
3905 /* FILE_FLAG_BACKUP_SEMANTICS is required to open a directory */
3906 FILE_FLAG_BACKUP_SEMANTICS,
3907 NULL);
Alexey Izbyshev3b20d342018-03-08 19:03:25 +03003908 Py_END_ALLOW_THREADS
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00003909
Steve Dower23ad6d02018-02-22 10:39:10 -08003910 if (hFile == INVALID_HANDLE_VALUE) {
Alexey Izbyshev3b20d342018-03-08 19:03:25 +03003911 return win32_error_object("CreateFileW", path->object);
Steve Dower23ad6d02018-02-22 10:39:10 -08003912 }
Brian Curtind40e6f72010-07-08 21:39:08 +00003913
3914 /* We have a good handle to the target, use it to determine the
3915 target path name. */
Alexey Izbyshev3b20d342018-03-08 19:03:25 +03003916 while (1) {
3917 Py_BEGIN_ALLOW_THREADS
3918 result_length = GetFinalPathNameByHandleW(hFile, target_path,
3919 buf_size, VOLUME_NAME_DOS);
3920 Py_END_ALLOW_THREADS
Brian Curtind40e6f72010-07-08 21:39:08 +00003921
Alexey Izbyshev3b20d342018-03-08 19:03:25 +03003922 if (!result_length) {
3923 result = win32_error_object("GetFinalPathNameByHandleW",
3924 path->object);
3925 goto cleanup;
3926 }
Brian Curtind40e6f72010-07-08 21:39:08 +00003927
Alexey Izbyshev3b20d342018-03-08 19:03:25 +03003928 if (result_length < buf_size) {
3929 break;
3930 }
Brian Curtind40e6f72010-07-08 21:39:08 +00003931
Alexey Izbyshev3b20d342018-03-08 19:03:25 +03003932 wchar_t *tmp;
3933 tmp = PyMem_Realloc(target_path != buf ? target_path : NULL,
3934 result_length * sizeof(*tmp));
3935 if (!tmp) {
3936 result = PyErr_NoMemory();
3937 goto cleanup;
3938 }
3939
3940 buf_size = result_length;
3941 target_path = tmp;
Steve Dower23ad6d02018-02-22 10:39:10 -08003942 }
Brian Curtind40e6f72010-07-08 21:39:08 +00003943
Victor Stinner9d3b93b2011-11-22 02:27:30 +01003944 result = PyUnicode_FromWideChar(target_path, result_length);
Steve Dower9eb3d542019-08-21 15:52:42 -07003945 if (result && path->narrow) {
Steve Dower23ad6d02018-02-22 10:39:10 -08003946 Py_SETREF(result, PyUnicode_EncodeFSDefault(result));
Steve Dower9eb3d542019-08-21 15:52:42 -07003947 }
Steve Dower23ad6d02018-02-22 10:39:10 -08003948
Alexey Izbyshev3b20d342018-03-08 19:03:25 +03003949cleanup:
3950 if (target_path != buf) {
3951 PyMem_Free(target_path);
3952 }
3953 CloseHandle(hFile);
3954 return result;
Larry Hastings2f936352014-08-05 14:04:04 +10003955}
Brian Curtin62857742010-09-06 17:07:27 +00003956
Tim Golden6b528062013-08-01 12:44:00 +01003957
Larry Hastings2f936352014-08-05 14:04:04 +10003958/*[clinic input]
3959os._getvolumepathname
3960
Steve Dower23ad6d02018-02-22 10:39:10 -08003961 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +10003962
3963A helper function for ismount on Win32.
3964[clinic start generated code]*/
3965
Larry Hastings2f936352014-08-05 14:04:04 +10003966static PyObject *
Steve Dower23ad6d02018-02-22 10:39:10 -08003967os__getvolumepathname_impl(PyObject *module, path_t *path)
3968/*[clinic end generated code: output=804c63fd13a1330b input=722b40565fa21552]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003969{
3970 PyObject *result;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03003971 wchar_t *mountpath=NULL;
Victor Stinner6edddfa2013-11-24 19:22:57 +01003972 size_t buflen;
Tim Golden6b528062013-08-01 12:44:00 +01003973 BOOL ret;
3974
Tim Golden6b528062013-08-01 12:44:00 +01003975 /* Volume path should be shorter than entire path */
Steve Dower23ad6d02018-02-22 10:39:10 -08003976 buflen = Py_MAX(path->length, MAX_PATH);
Victor Stinner6edddfa2013-11-24 19:22:57 +01003977
Victor Stinner850a18e2017-10-24 16:53:32 -07003978 if (buflen > PY_DWORD_MAX) {
Victor Stinner6edddfa2013-11-24 19:22:57 +01003979 PyErr_SetString(PyExc_OverflowError, "path too long");
3980 return NULL;
3981 }
3982
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02003983 mountpath = PyMem_New(wchar_t, buflen);
Tim Golden6b528062013-08-01 12:44:00 +01003984 if (mountpath == NULL)
3985 return PyErr_NoMemory();
3986
3987 Py_BEGIN_ALLOW_THREADS
Steve Dower23ad6d02018-02-22 10:39:10 -08003988 ret = GetVolumePathNameW(path->wide, mountpath,
Victor Stinner6edddfa2013-11-24 19:22:57 +01003989 Py_SAFE_DOWNCAST(buflen, size_t, DWORD));
Tim Golden6b528062013-08-01 12:44:00 +01003990 Py_END_ALLOW_THREADS
3991
3992 if (!ret) {
Steve Dower23ad6d02018-02-22 10:39:10 -08003993 result = win32_error_object("_getvolumepathname", path->object);
Tim Golden6b528062013-08-01 12:44:00 +01003994 goto exit;
3995 }
3996 result = PyUnicode_FromWideChar(mountpath, wcslen(mountpath));
Steve Dower23ad6d02018-02-22 10:39:10 -08003997 if (path->narrow)
3998 Py_SETREF(result, PyUnicode_EncodeFSDefault(result));
Tim Golden6b528062013-08-01 12:44:00 +01003999
4000exit:
4001 PyMem_Free(mountpath);
4002 return result;
4003}
Tim Golden6b528062013-08-01 12:44:00 +01004004
Martin v. Löwis6238d2b2002-06-30 15:26:10 +00004005#endif /* MS_WINDOWS */
Mark Hammondef8b6542001-05-13 08:04:26 +00004006
Larry Hastings2f936352014-08-05 14:04:04 +10004007
4008/*[clinic input]
4009os.mkdir
4010
4011 path : path_t
4012
4013 mode: int = 0o777
4014
4015 *
4016
4017 dir_fd : dir_fd(requires='mkdirat') = None
4018
4019# "mkdir(path, mode=0o777, *, dir_fd=None)\n\n\
4020
4021Create a directory.
4022
4023If dir_fd is not None, it should be a file descriptor open to a directory,
4024 and path should be relative; path will then be relative to that directory.
4025dir_fd may not be implemented on your platform.
4026 If it is unavailable, using it will raise a NotImplementedError.
4027
4028The mode argument is ignored on Windows.
4029[clinic start generated code]*/
4030
Larry Hastings2f936352014-08-05 14:04:04 +10004031static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004032os_mkdir_impl(PyObject *module, path_t *path, int mode, int dir_fd)
4033/*[clinic end generated code: output=a70446903abe821f input=e965f68377e9b1ce]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004034{
4035 int result;
Mark Hammondc2e85bd2002-10-03 05:10:39 +00004036
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00004037#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00004038 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07004039 result = CreateDirectoryW(path->wide, NULL);
Victor Stinner8c62be82010-05-06 00:08:46 +00004040 Py_END_ALLOW_THREADS
Mark Hammondc2e85bd2002-10-03 05:10:39 +00004041
Larry Hastings2f936352014-08-05 14:04:04 +10004042 if (!result)
4043 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004044#else
Victor Stinner8c62be82010-05-06 00:08:46 +00004045 Py_BEGIN_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07004046#if HAVE_MKDIRAT
4047 if (dir_fd != DEFAULT_DIR_FD)
Larry Hastings2f936352014-08-05 14:04:04 +10004048 result = mkdirat(dir_fd, path->narrow, mode);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004049 else
4050#endif
Erik Bray03eb11f2017-10-27 14:27:06 +02004051#if defined(__WATCOMC__) && !defined(__QNX__)
Larry Hastings2f936352014-08-05 14:04:04 +10004052 result = mkdir(path->narrow);
Guido van Rossuma4916fa1996-05-23 22:58:55 +00004053#else
Larry Hastings2f936352014-08-05 14:04:04 +10004054 result = mkdir(path->narrow, mode);
Guido van Rossuma4916fa1996-05-23 22:58:55 +00004055#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00004056 Py_END_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10004057 if (result < 0)
4058 return path_error(path);
Steve Dowercc16be82016-09-08 10:35:16 -07004059#endif /* MS_WINDOWS */
Larry Hastings2f936352014-08-05 14:04:04 +10004060 Py_RETURN_NONE;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004061}
4062
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004063
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004064/* sys/resource.h is needed for at least: wait3(), wait4(), broken nice. */
4065#if defined(HAVE_SYS_RESOURCE_H)
Thomas Wouterse38b2f12001-07-11 22:35:31 +00004066#include <sys/resource.h>
4067#endif
Thomas Wouterse38b2f12001-07-11 22:35:31 +00004068
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00004069
4070#ifdef HAVE_NICE
Larry Hastings2f936352014-08-05 14:04:04 +10004071/*[clinic input]
4072os.nice
4073
4074 increment: int
4075 /
4076
4077Add increment to the priority of process and return the new priority.
4078[clinic start generated code]*/
4079
Larry Hastings2f936352014-08-05 14:04:04 +10004080static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004081os_nice_impl(PyObject *module, int increment)
4082/*[clinic end generated code: output=9dad8a9da8109943 input=864be2d402a21da2]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004083{
4084 int value;
Thomas Woutersc2c12dc2001-07-11 14:45:34 +00004085
Victor Stinner8c62be82010-05-06 00:08:46 +00004086 /* There are two flavours of 'nice': one that returns the new
4087 priority (as required by almost all standards out there) and the
Benjamin Peterson288d1da2017-09-28 22:44:27 -07004088 Linux/FreeBSD one, which returns '0' on success and advices
Victor Stinner8c62be82010-05-06 00:08:46 +00004089 the use of getpriority() to get the new priority.
Tim Peters5aa91602002-01-30 05:46:57 +00004090
Victor Stinner8c62be82010-05-06 00:08:46 +00004091 If we are of the nice family that returns the new priority, we
4092 need to clear errno before the call, and check if errno is filled
4093 before calling posix_error() on a returnvalue of -1, because the
4094 -1 may be the actual new priority! */
Thomas Woutersc2c12dc2001-07-11 14:45:34 +00004095
Victor Stinner8c62be82010-05-06 00:08:46 +00004096 errno = 0;
4097 value = nice(increment);
Thomas Wouterse38b2f12001-07-11 22:35:31 +00004098#if defined(HAVE_BROKEN_NICE) && defined(HAVE_GETPRIORITY)
Victor Stinner8c62be82010-05-06 00:08:46 +00004099 if (value == 0)
4100 value = getpriority(PRIO_PROCESS, 0);
Thomas Woutersc2c12dc2001-07-11 14:45:34 +00004101#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00004102 if (value == -1 && errno != 0)
4103 /* either nice() or getpriority() returned an error */
4104 return posix_error();
4105 return PyLong_FromLong((long) value);
Guido van Rossum775f4da1993-01-09 17:18:52 +00004106}
Guido van Rossumb6775db1994-08-01 11:34:53 +00004107#endif /* HAVE_NICE */
Guido van Rossum1ff6cb41991-04-08 20:59:13 +00004108
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00004109
4110#ifdef HAVE_GETPRIORITY
Larry Hastings2f936352014-08-05 14:04:04 +10004111/*[clinic input]
4112os.getpriority
4113
4114 which: int
4115 who: int
4116
4117Return program scheduling priority.
4118[clinic start generated code]*/
4119
Larry Hastings2f936352014-08-05 14:04:04 +10004120static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004121os_getpriority_impl(PyObject *module, int which, int who)
4122/*[clinic end generated code: output=c41b7b63c7420228 input=9be615d40e2544ef]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004123{
4124 int retval;
4125
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00004126 errno = 0;
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00004127 retval = getpriority(which, who);
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00004128 if (errno != 0)
4129 return posix_error();
4130 return PyLong_FromLong((long)retval);
4131}
4132#endif /* HAVE_GETPRIORITY */
4133
4134
4135#ifdef HAVE_SETPRIORITY
Larry Hastings2f936352014-08-05 14:04:04 +10004136/*[clinic input]
4137os.setpriority
4138
4139 which: int
4140 who: int
4141 priority: int
4142
4143Set program scheduling priority.
4144[clinic start generated code]*/
4145
Larry Hastings2f936352014-08-05 14:04:04 +10004146static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004147os_setpriority_impl(PyObject *module, int which, int who, int priority)
4148/*[clinic end generated code: output=3d910d95a7771eb2 input=710ccbf65b9dc513]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004149{
4150 int retval;
4151
4152 retval = setpriority(which, who, priority);
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00004153 if (retval == -1)
4154 return posix_error();
4155 Py_RETURN_NONE;
4156}
4157#endif /* HAVE_SETPRIORITY */
4158
4159
Barry Warsaw53699e91996-12-10 23:23:01 +00004160static PyObject *
Larry Hastings2f936352014-08-05 14:04:04 +10004161internal_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 +00004162{
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03004163 const char *function_name = is_replace ? "replace" : "rename";
Larry Hastings9cf065c2012-06-22 16:30:09 -07004164 int dir_fd_specified;
Larry Hastings9cf065c2012-06-22 16:30:09 -07004165
Mark Hammondc2e85bd2002-10-03 05:10:39 +00004166#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00004167 BOOL result;
Antoine Pitrouf3b2d882012-01-30 22:08:52 +01004168 int flags = is_replace ? MOVEFILE_REPLACE_EXISTING : 0;
Mark Hammondc2e85bd2002-10-03 05:10:39 +00004169#else
Larry Hastings9cf065c2012-06-22 16:30:09 -07004170 int result;
Mark Hammondc2e85bd2002-10-03 05:10:39 +00004171#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07004172
Larry Hastings9cf065c2012-06-22 16:30:09 -07004173 dir_fd_specified = (src_dir_fd != DEFAULT_DIR_FD) ||
4174 (dst_dir_fd != DEFAULT_DIR_FD);
4175#ifndef HAVE_RENAMEAT
4176 if (dir_fd_specified) {
4177 argument_unavailable_error(function_name, "src_dir_fd and dst_dir_fd");
Larry Hastings2f936352014-08-05 14:04:04 +10004178 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07004179 }
4180#endif
4181
Larry Hastings9cf065c2012-06-22 16:30:09 -07004182#ifdef MS_WINDOWS
4183 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07004184 result = MoveFileExW(src->wide, dst->wide, flags);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004185 Py_END_ALLOW_THREADS
4186
Larry Hastings2f936352014-08-05 14:04:04 +10004187 if (!result)
4188 return path_error2(src, dst);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004189
4190#else
Steve Dowercc16be82016-09-08 10:35:16 -07004191 if ((src->narrow && dst->wide) || (src->wide && dst->narrow)) {
4192 PyErr_Format(PyExc_ValueError,
4193 "%s: src and dst must be the same type", function_name);
4194 return NULL;
4195 }
4196
Larry Hastings9cf065c2012-06-22 16:30:09 -07004197 Py_BEGIN_ALLOW_THREADS
4198#ifdef HAVE_RENAMEAT
4199 if (dir_fd_specified)
Larry Hastings2f936352014-08-05 14:04:04 +10004200 result = renameat(src_dir_fd, src->narrow, dst_dir_fd, dst->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004201 else
4202#endif
Steve Dowercc16be82016-09-08 10:35:16 -07004203 result = rename(src->narrow, dst->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004204 Py_END_ALLOW_THREADS
4205
Larry Hastings2f936352014-08-05 14:04:04 +10004206 if (result)
4207 return path_error2(src, dst);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004208#endif
Larry Hastings2f936352014-08-05 14:04:04 +10004209 Py_RETURN_NONE;
4210}
Larry Hastings9cf065c2012-06-22 16:30:09 -07004211
Larry Hastings2f936352014-08-05 14:04:04 +10004212
4213/*[clinic input]
4214os.rename
4215
4216 src : path_t
4217 dst : path_t
4218 *
4219 src_dir_fd : dir_fd = None
4220 dst_dir_fd : dir_fd = None
4221
4222Rename a file or directory.
4223
4224If either src_dir_fd or dst_dir_fd is not None, it should be a file
4225 descriptor open to a directory, and the respective path string (src or dst)
4226 should be relative; the path will then be relative to that directory.
4227src_dir_fd and dst_dir_fd, may not be implemented on your platform.
4228 If they are unavailable, using them will raise a NotImplementedError.
4229[clinic start generated code]*/
4230
Antoine Pitrouf3b2d882012-01-30 22:08:52 +01004231static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004232os_rename_impl(PyObject *module, path_t *src, path_t *dst, int src_dir_fd,
Larry Hastings89964c42015-04-14 18:07:59 -04004233 int dst_dir_fd)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004234/*[clinic end generated code: output=59e803072cf41230 input=faa61c847912c850]*/
Antoine Pitrouf3b2d882012-01-30 22:08:52 +01004235{
Larry Hastings2f936352014-08-05 14:04:04 +10004236 return internal_rename(src, dst, src_dir_fd, dst_dir_fd, 0);
Antoine Pitrouf3b2d882012-01-30 22:08:52 +01004237}
4238
Larry Hastings2f936352014-08-05 14:04:04 +10004239
4240/*[clinic input]
4241os.replace = os.rename
4242
4243Rename a file or directory, overwriting the destination.
4244
4245If either src_dir_fd or dst_dir_fd is not None, it should be a file
4246 descriptor open to a directory, and the respective path string (src or dst)
4247 should be relative; the path will then be relative to that directory.
4248src_dir_fd and dst_dir_fd, may not be implemented on your platform.
Anthony Sottile73d60022019-02-12 23:15:54 -05004249 If they are unavailable, using them will raise a NotImplementedError.
Larry Hastings2f936352014-08-05 14:04:04 +10004250[clinic start generated code]*/
4251
Larry Hastings2f936352014-08-05 14:04:04 +10004252static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004253os_replace_impl(PyObject *module, path_t *src, path_t *dst, int src_dir_fd,
4254 int dst_dir_fd)
Anthony Sottile73d60022019-02-12 23:15:54 -05004255/*[clinic end generated code: output=1968c02e7857422b input=c003f0def43378ef]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004256{
4257 return internal_rename(src, dst, src_dir_fd, dst_dir_fd, 1);
4258}
4259
4260
4261/*[clinic input]
4262os.rmdir
4263
4264 path: path_t
4265 *
4266 dir_fd: dir_fd(requires='unlinkat') = None
4267
4268Remove a directory.
4269
4270If dir_fd is not None, it should be a file descriptor open to a directory,
4271 and path should be relative; path will then be relative to that directory.
4272dir_fd may not be implemented on your platform.
4273 If it is unavailable, using it will raise a NotImplementedError.
4274[clinic start generated code]*/
4275
Larry Hastings2f936352014-08-05 14:04:04 +10004276static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004277os_rmdir_impl(PyObject *module, path_t *path, int dir_fd)
4278/*[clinic end generated code: output=080eb54f506e8301 input=38c8b375ca34a7e2]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004279{
4280 int result;
Larry Hastingsb698d8e2012-06-23 16:55:07 -07004281
4282 Py_BEGIN_ALLOW_THREADS
4283#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07004284 /* Windows, success=1, UNIX, success=0 */
4285 result = !RemoveDirectoryW(path->wide);
Larry Hastingsb698d8e2012-06-23 16:55:07 -07004286#else
4287#ifdef HAVE_UNLINKAT
4288 if (dir_fd != DEFAULT_DIR_FD)
Larry Hastings2f936352014-08-05 14:04:04 +10004289 result = unlinkat(dir_fd, path->narrow, AT_REMOVEDIR);
Larry Hastingsb698d8e2012-06-23 16:55:07 -07004290 else
4291#endif
Larry Hastings2f936352014-08-05 14:04:04 +10004292 result = rmdir(path->narrow);
Larry Hastingsb698d8e2012-06-23 16:55:07 -07004293#endif
4294 Py_END_ALLOW_THREADS
4295
Larry Hastings2f936352014-08-05 14:04:04 +10004296 if (result)
4297 return path_error(path);
Larry Hastingsb698d8e2012-06-23 16:55:07 -07004298
Larry Hastings2f936352014-08-05 14:04:04 +10004299 Py_RETURN_NONE;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004300}
4301
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004302
Guido van Rossuma4916fa1996-05-23 22:58:55 +00004303#ifdef HAVE_SYSTEM
Larry Hastings2f936352014-08-05 14:04:04 +10004304#ifdef MS_WINDOWS
4305/*[clinic input]
4306os.system -> long
4307
4308 command: Py_UNICODE
4309
4310Execute the command in a subshell.
4311[clinic start generated code]*/
4312
Larry Hastings2f936352014-08-05 14:04:04 +10004313static long
Serhiy Storchakaafb3e712018-12-14 11:19:51 +02004314os_system_impl(PyObject *module, const Py_UNICODE *command)
4315/*[clinic end generated code: output=5b7c3599c068ca42 input=303f5ce97df606b0]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004316{
4317 long result;
Steve Dowerb82e17e2019-05-23 08:45:22 -07004318
4319 if (PySys_Audit("system", "(u)", command) < 0) {
4320 return -1;
4321 }
4322
Victor Stinner8c62be82010-05-06 00:08:46 +00004323 Py_BEGIN_ALLOW_THREADS
Steve Dowerc3630612016-11-19 18:41:16 -08004324 _Py_BEGIN_SUPPRESS_IPH
Larry Hastings2f936352014-08-05 14:04:04 +10004325 result = _wsystem(command);
Steve Dowerc3630612016-11-19 18:41:16 -08004326 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00004327 Py_END_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10004328 return result;
4329}
4330#else /* MS_WINDOWS */
4331/*[clinic input]
4332os.system -> long
4333
4334 command: FSConverter
4335
4336Execute the command in a subshell.
4337[clinic start generated code]*/
4338
Larry Hastings2f936352014-08-05 14:04:04 +10004339static long
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004340os_system_impl(PyObject *module, PyObject *command)
4341/*[clinic end generated code: output=290fc437dd4f33a0 input=86a58554ba6094af]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004342{
4343 long result;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03004344 const char *bytes = PyBytes_AsString(command);
Steve Dowerb82e17e2019-05-23 08:45:22 -07004345
4346 if (PySys_Audit("system", "(O)", command) < 0) {
4347 return -1;
4348 }
4349
Larry Hastings2f936352014-08-05 14:04:04 +10004350 Py_BEGIN_ALLOW_THREADS
4351 result = system(bytes);
4352 Py_END_ALLOW_THREADS
4353 return result;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004354}
Guido van Rossuma4916fa1996-05-23 22:58:55 +00004355#endif
Larry Hastings2f936352014-08-05 14:04:04 +10004356#endif /* HAVE_SYSTEM */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004357
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004358
Larry Hastings2f936352014-08-05 14:04:04 +10004359/*[clinic input]
4360os.umask
4361
4362 mask: int
4363 /
4364
4365Set the current numeric umask and return the previous umask.
4366[clinic start generated code]*/
4367
Larry Hastings2f936352014-08-05 14:04:04 +10004368static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004369os_umask_impl(PyObject *module, int mask)
4370/*[clinic end generated code: output=a2e33ce3bc1a6e33 input=ab6bfd9b24d8a7e8]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004371{
4372 int i = (int)umask(mask);
Victor Stinner8c62be82010-05-06 00:08:46 +00004373 if (i < 0)
4374 return posix_error();
4375 return PyLong_FromLong((long)i);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004376}
4377
Brian Curtind40e6f72010-07-08 21:39:08 +00004378#ifdef MS_WINDOWS
4379
4380/* override the default DeleteFileW behavior so that directory
4381symlinks can be removed with this function, the same as with
4382Unix symlinks */
4383BOOL WINAPI Py_DeleteFileW(LPCWSTR lpFileName)
4384{
4385 WIN32_FILE_ATTRIBUTE_DATA info;
4386 WIN32_FIND_DATAW find_data;
4387 HANDLE find_data_handle;
4388 int is_directory = 0;
4389 int is_link = 0;
4390
4391 if (GetFileAttributesExW(lpFileName, GetFileExInfoStandard, &info)) {
4392 is_directory = info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00004393
Brian Curtind40e6f72010-07-08 21:39:08 +00004394 /* Get WIN32_FIND_DATA structure for the path to determine if
4395 it is a symlink */
4396 if(is_directory &&
4397 info.dwFileAttributes & FILE_ATTRIBUTE_REPARSE_POINT) {
4398 find_data_handle = FindFirstFileW(lpFileName, &find_data);
4399
4400 if(find_data_handle != INVALID_HANDLE_VALUE) {
Tim Golden0321cf22014-05-05 19:46:17 +01004401 /* IO_REPARSE_TAG_SYMLINK if it is a symlink and
4402 IO_REPARSE_TAG_MOUNT_POINT if it is a junction point. */
4403 is_link = find_data.dwReserved0 == IO_REPARSE_TAG_SYMLINK ||
4404 find_data.dwReserved0 == IO_REPARSE_TAG_MOUNT_POINT;
Brian Curtind40e6f72010-07-08 21:39:08 +00004405 FindClose(find_data_handle);
4406 }
4407 }
4408 }
4409
4410 if (is_directory && is_link)
4411 return RemoveDirectoryW(lpFileName);
4412
4413 return DeleteFileW(lpFileName);
4414}
4415#endif /* MS_WINDOWS */
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004416
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004417
Larry Hastings2f936352014-08-05 14:04:04 +10004418/*[clinic input]
4419os.unlink
4420
4421 path: path_t
4422 *
4423 dir_fd: dir_fd(requires='unlinkat')=None
4424
4425Remove a file (same as remove()).
4426
4427If dir_fd is not None, it should be a file descriptor open to a directory,
4428 and path should be relative; path will then be relative to that directory.
4429dir_fd may not be implemented on your platform.
4430 If it is unavailable, using it will raise a NotImplementedError.
4431
4432[clinic start generated code]*/
4433
Larry Hastings2f936352014-08-05 14:04:04 +10004434static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004435os_unlink_impl(PyObject *module, path_t *path, int dir_fd)
4436/*[clinic end generated code: output=621797807b9963b1 input=d7bcde2b1b2a2552]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004437{
4438 int result;
Larry Hastings9cf065c2012-06-22 16:30:09 -07004439
4440 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04004441 _Py_BEGIN_SUPPRESS_IPH
Larry Hastings9cf065c2012-06-22 16:30:09 -07004442#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07004443 /* Windows, success=1, UNIX, success=0 */
4444 result = !Py_DeleteFileW(path->wide);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004445#else
Larry Hastings9cf065c2012-06-22 16:30:09 -07004446#ifdef HAVE_UNLINKAT
4447 if (dir_fd != DEFAULT_DIR_FD)
Larry Hastings2f936352014-08-05 14:04:04 +10004448 result = unlinkat(dir_fd, path->narrow, 0);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004449 else
4450#endif /* HAVE_UNLINKAT */
Larry Hastings2f936352014-08-05 14:04:04 +10004451 result = unlink(path->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004452#endif
Steve Dower8fc89802015-04-12 00:26:27 -04004453 _Py_END_SUPPRESS_IPH
Larry Hastings9cf065c2012-06-22 16:30:09 -07004454 Py_END_ALLOW_THREADS
4455
Larry Hastings2f936352014-08-05 14:04:04 +10004456 if (result)
4457 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004458
Larry Hastings2f936352014-08-05 14:04:04 +10004459 Py_RETURN_NONE;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004460}
4461
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004462
Larry Hastings2f936352014-08-05 14:04:04 +10004463/*[clinic input]
4464os.remove = os.unlink
4465
4466Remove a file (same as unlink()).
4467
4468If dir_fd is not None, it should be a file descriptor open to a directory,
4469 and path should be relative; path will then be relative to that directory.
4470dir_fd may not be implemented on your platform.
4471 If it is unavailable, using it will raise a NotImplementedError.
4472[clinic start generated code]*/
4473
Larry Hastings2f936352014-08-05 14:04:04 +10004474static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004475os_remove_impl(PyObject *module, path_t *path, int dir_fd)
4476/*[clinic end generated code: output=a8535b28f0068883 input=e05c5ab55cd30983]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004477{
4478 return os_unlink_impl(module, path, dir_fd);
4479}
4480
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004481
Larry Hastings605a62d2012-06-24 04:33:36 -07004482static PyStructSequence_Field uname_result_fields[] = {
4483 {"sysname", "operating system name"},
4484 {"nodename", "name of machine on network (implementation-defined)"},
4485 {"release", "operating system release"},
4486 {"version", "operating system version"},
4487 {"machine", "hardware identifier"},
4488 {NULL}
4489};
4490
4491PyDoc_STRVAR(uname_result__doc__,
4492"uname_result: Result from os.uname().\n\n\
4493This object may be accessed either as a tuple of\n\
4494 (sysname, nodename, release, version, machine),\n\
4495or via the attributes sysname, nodename, release, version, and machine.\n\
4496\n\
4497See os.uname for more information.");
4498
4499static PyStructSequence_Desc uname_result_desc = {
4500 "uname_result", /* name */
4501 uname_result__doc__, /* doc */
4502 uname_result_fields,
4503 5
4504};
4505
Eddie Elizondo474eedf2018-11-13 04:09:31 -08004506static PyTypeObject* UnameResultType;
Larry Hastings605a62d2012-06-24 04:33:36 -07004507
4508
4509#ifdef HAVE_UNAME
Larry Hastings2f936352014-08-05 14:04:04 +10004510/*[clinic input]
4511os.uname
4512
4513Return an object identifying the current operating system.
4514
4515The object behaves like a named tuple with the following fields:
4516 (sysname, nodename, release, version, machine)
4517
4518[clinic start generated code]*/
4519
Larry Hastings2f936352014-08-05 14:04:04 +10004520static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004521os_uname_impl(PyObject *module)
4522/*[clinic end generated code: output=e6a49cf1a1508a19 input=e68bd246db3043ed]*/
Guido van Rossumc39de5f1992-02-05 11:15:54 +00004523{
Victor Stinner8c62be82010-05-06 00:08:46 +00004524 struct utsname u;
4525 int res;
Larry Hastings605a62d2012-06-24 04:33:36 -07004526 PyObject *value;
Neal Norwitze241ce82003-02-17 18:17:05 +00004527
Victor Stinner8c62be82010-05-06 00:08:46 +00004528 Py_BEGIN_ALLOW_THREADS
4529 res = uname(&u);
4530 Py_END_ALLOW_THREADS
4531 if (res < 0)
4532 return posix_error();
Larry Hastings605a62d2012-06-24 04:33:36 -07004533
Eddie Elizondo474eedf2018-11-13 04:09:31 -08004534 value = PyStructSequence_New(UnameResultType);
Larry Hastings605a62d2012-06-24 04:33:36 -07004535 if (value == NULL)
4536 return NULL;
4537
4538#define SET(i, field) \
4539 { \
Victor Stinnera534fc42013-06-03 22:07:27 +02004540 PyObject *o = PyUnicode_DecodeFSDefault(field); \
Larry Hastings605a62d2012-06-24 04:33:36 -07004541 if (!o) { \
4542 Py_DECREF(value); \
4543 return NULL; \
4544 } \
4545 PyStructSequence_SET_ITEM(value, i, o); \
4546 } \
4547
4548 SET(0, u.sysname);
4549 SET(1, u.nodename);
4550 SET(2, u.release);
4551 SET(3, u.version);
4552 SET(4, u.machine);
4553
4554#undef SET
4555
4556 return value;
Guido van Rossumc39de5f1992-02-05 11:15:54 +00004557}
Guido van Rossumb6775db1994-08-01 11:34:53 +00004558#endif /* HAVE_UNAME */
Guido van Rossum1ff6cb41991-04-08 20:59:13 +00004559
Larry Hastings9e3e70b2011-09-08 19:29:07 -07004560
Larry Hastings9cf065c2012-06-22 16:30:09 -07004561
4562typedef struct {
4563 int now;
4564 time_t atime_s;
4565 long atime_ns;
4566 time_t mtime_s;
4567 long mtime_ns;
4568} utime_t;
4569
4570/*
Victor Stinner484df002014-10-09 13:52:31 +02004571 * these macros assume that "ut" is a pointer to a utime_t
Larry Hastings9cf065c2012-06-22 16:30:09 -07004572 * they also intentionally leak the declaration of a pointer named "time"
4573 */
4574#define UTIME_TO_TIMESPEC \
4575 struct timespec ts[2]; \
4576 struct timespec *time; \
Victor Stinner484df002014-10-09 13:52:31 +02004577 if (ut->now) \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004578 time = NULL; \
4579 else { \
Victor Stinner484df002014-10-09 13:52:31 +02004580 ts[0].tv_sec = ut->atime_s; \
4581 ts[0].tv_nsec = ut->atime_ns; \
4582 ts[1].tv_sec = ut->mtime_s; \
4583 ts[1].tv_nsec = ut->mtime_ns; \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004584 time = ts; \
4585 } \
4586
4587#define UTIME_TO_TIMEVAL \
4588 struct timeval tv[2]; \
4589 struct timeval *time; \
Victor Stinner484df002014-10-09 13:52:31 +02004590 if (ut->now) \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004591 time = NULL; \
4592 else { \
Victor Stinner484df002014-10-09 13:52:31 +02004593 tv[0].tv_sec = ut->atime_s; \
4594 tv[0].tv_usec = ut->atime_ns / 1000; \
4595 tv[1].tv_sec = ut->mtime_s; \
4596 tv[1].tv_usec = ut->mtime_ns / 1000; \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004597 time = tv; \
4598 } \
4599
4600#define UTIME_TO_UTIMBUF \
Georg Brandle1a7d9d2014-10-12 08:45:15 +02004601 struct utimbuf u; \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004602 struct utimbuf *time; \
Victor Stinner484df002014-10-09 13:52:31 +02004603 if (ut->now) \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004604 time = NULL; \
4605 else { \
Georg Brandle1a7d9d2014-10-12 08:45:15 +02004606 u.actime = ut->atime_s; \
4607 u.modtime = ut->mtime_s; \
4608 time = &u; \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004609 }
4610
4611#define UTIME_TO_TIME_T \
4612 time_t timet[2]; \
Georg Brandle1a7d9d2014-10-12 08:45:15 +02004613 time_t *time; \
Victor Stinner484df002014-10-09 13:52:31 +02004614 if (ut->now) \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004615 time = NULL; \
4616 else { \
Victor Stinner484df002014-10-09 13:52:31 +02004617 timet[0] = ut->atime_s; \
4618 timet[1] = ut->mtime_s; \
Georg Brandle1a7d9d2014-10-12 08:45:15 +02004619 time = timet; \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004620 } \
4621
4622
Victor Stinner528a9ab2015-09-03 21:30:26 +02004623#if defined(HAVE_FUTIMESAT) || defined(HAVE_UTIMENSAT)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004624
4625static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02004626utime_dir_fd(utime_t *ut, int dir_fd, const char *path, int follow_symlinks)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004627{
4628#ifdef HAVE_UTIMENSAT
4629 int flags = follow_symlinks ? 0 : AT_SYMLINK_NOFOLLOW;
4630 UTIME_TO_TIMESPEC;
4631 return utimensat(dir_fd, path, time, flags);
4632#elif defined(HAVE_FUTIMESAT)
4633 UTIME_TO_TIMEVAL;
4634 /*
4635 * follow_symlinks will never be false here;
4636 * we only allow !follow_symlinks and dir_fd together
4637 * if we have utimensat()
4638 */
4639 assert(follow_symlinks);
4640 return futimesat(dir_fd, path, time);
4641#endif
4642}
4643
Larry Hastings2f936352014-08-05 14:04:04 +10004644 #define FUTIMENSAT_DIR_FD_CONVERTER dir_fd_converter
4645#else
4646 #define FUTIMENSAT_DIR_FD_CONVERTER dir_fd_unavailable
Larry Hastings9cf065c2012-06-22 16:30:09 -07004647#endif
4648
Victor Stinner528a9ab2015-09-03 21:30:26 +02004649#if defined(HAVE_FUTIMES) || defined(HAVE_FUTIMENS)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004650
4651static int
Victor Stinner484df002014-10-09 13:52:31 +02004652utime_fd(utime_t *ut, int fd)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004653{
4654#ifdef HAVE_FUTIMENS
4655 UTIME_TO_TIMESPEC;
4656 return futimens(fd, time);
4657#else
4658 UTIME_TO_TIMEVAL;
4659 return futimes(fd, time);
4660#endif
4661}
4662
Larry Hastings2f936352014-08-05 14:04:04 +10004663 #define PATH_UTIME_HAVE_FD 1
4664#else
4665 #define PATH_UTIME_HAVE_FD 0
Larry Hastings9cf065c2012-06-22 16:30:09 -07004666#endif
4667
Victor Stinner5ebae872015-09-22 01:29:33 +02004668#if defined(HAVE_UTIMENSAT) || defined(HAVE_LUTIMES)
4669# define UTIME_HAVE_NOFOLLOW_SYMLINKS
4670#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07004671
Victor Stinner4552ced2015-09-21 22:37:15 +02004672#ifdef UTIME_HAVE_NOFOLLOW_SYMLINKS
Larry Hastings9cf065c2012-06-22 16:30:09 -07004673
4674static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02004675utime_nofollow_symlinks(utime_t *ut, const char *path)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004676{
4677#ifdef HAVE_UTIMENSAT
4678 UTIME_TO_TIMESPEC;
4679 return utimensat(DEFAULT_DIR_FD, path, time, AT_SYMLINK_NOFOLLOW);
4680#else
4681 UTIME_TO_TIMEVAL;
4682 return lutimes(path, time);
4683#endif
4684}
4685
4686#endif
4687
4688#ifndef MS_WINDOWS
4689
4690static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02004691utime_default(utime_t *ut, const char *path)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004692{
4693#ifdef HAVE_UTIMENSAT
4694 UTIME_TO_TIMESPEC;
4695 return utimensat(DEFAULT_DIR_FD, path, time, 0);
4696#elif defined(HAVE_UTIMES)
4697 UTIME_TO_TIMEVAL;
4698 return utimes(path, time);
4699#elif defined(HAVE_UTIME_H)
4700 UTIME_TO_UTIMBUF;
4701 return utime(path, time);
4702#else
4703 UTIME_TO_TIME_T;
4704 return utime(path, time);
4705#endif
4706}
4707
4708#endif
4709
Larry Hastings76ad59b2012-05-03 00:30:07 -07004710static int
4711split_py_long_to_s_and_ns(PyObject *py_long, time_t *s, long *ns)
4712{
4713 int result = 0;
Benjamin Petersonfbd85a02012-05-04 11:06:09 -04004714 PyObject *divmod;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004715 divmod = PyNumber_Divmod(py_long, billion);
4716 if (!divmod)
4717 goto exit;
Oren Milman0bd1a2d2018-09-12 22:14:35 +03004718 if (!PyTuple_Check(divmod) || PyTuple_GET_SIZE(divmod) != 2) {
4719 PyErr_Format(PyExc_TypeError,
4720 "%.200s.__divmod__() must return a 2-tuple, not %.200s",
4721 Py_TYPE(py_long)->tp_name, Py_TYPE(divmod)->tp_name);
4722 goto exit;
4723 }
Larry Hastings76ad59b2012-05-03 00:30:07 -07004724 *s = _PyLong_AsTime_t(PyTuple_GET_ITEM(divmod, 0));
4725 if ((*s == -1) && PyErr_Occurred())
4726 goto exit;
4727 *ns = PyLong_AsLong(PyTuple_GET_ITEM(divmod, 1));
Benjamin Peterson35a8f0d2012-05-04 01:10:59 -04004728 if ((*ns == -1) && PyErr_Occurred())
Larry Hastings76ad59b2012-05-03 00:30:07 -07004729 goto exit;
4730
4731 result = 1;
4732exit:
4733 Py_XDECREF(divmod);
4734 return result;
4735}
4736
Larry Hastings2f936352014-08-05 14:04:04 +10004737
4738/*[clinic input]
4739os.utime
4740
4741 path: path_t(allow_fd='PATH_UTIME_HAVE_FD')
4742 times: object = NULL
4743 *
4744 ns: object = NULL
4745 dir_fd: dir_fd(requires='futimensat') = None
4746 follow_symlinks: bool=True
4747
Martin Panter0ff89092015-09-09 01:56:53 +00004748# "utime(path, times=None, *[, ns], dir_fd=None, follow_symlinks=True)\n\
Larry Hastings2f936352014-08-05 14:04:04 +10004749
4750Set the access and modified time of path.
4751
4752path may always be specified as a string.
4753On some platforms, path may also be specified as an open file descriptor.
4754 If this functionality is unavailable, using it raises an exception.
4755
4756If times is not None, it must be a tuple (atime, mtime);
4757 atime and mtime should be expressed as float seconds since the epoch.
Martin Panter0ff89092015-09-09 01:56:53 +00004758If ns is specified, it must be a tuple (atime_ns, mtime_ns);
Larry Hastings2f936352014-08-05 14:04:04 +10004759 atime_ns and mtime_ns should be expressed as integer nanoseconds
4760 since the epoch.
Martin Panter0ff89092015-09-09 01:56:53 +00004761If times is None and ns is unspecified, utime uses the current time.
Larry Hastings2f936352014-08-05 14:04:04 +10004762Specifying tuples for both times and ns is an error.
4763
4764If dir_fd is not None, it should be a file descriptor open to a directory,
4765 and path should be relative; path will then be relative to that directory.
4766If follow_symlinks is False, and the last element of the path is a symbolic
4767 link, utime will modify the symbolic link itself instead of the file the
4768 link points to.
4769It is an error to use dir_fd or follow_symlinks when specifying path
4770 as an open file descriptor.
4771dir_fd and follow_symlinks may not be available on your platform.
4772 If they are unavailable, using them will raise a NotImplementedError.
4773
4774[clinic start generated code]*/
4775
Larry Hastings2f936352014-08-05 14:04:04 +10004776static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004777os_utime_impl(PyObject *module, path_t *path, PyObject *times, PyObject *ns,
4778 int dir_fd, int follow_symlinks)
4779/*[clinic end generated code: output=cfcac69d027b82cf input=081cdc54ca685385]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004780{
Larry Hastings9cf065c2012-06-22 16:30:09 -07004781#ifdef MS_WINDOWS
4782 HANDLE hFile;
4783 FILETIME atime, mtime;
4784#else
4785 int result;
4786#endif
Larry Hastings76ad59b2012-05-03 00:30:07 -07004787
Larry Hastings2f936352014-08-05 14:04:04 +10004788 utime_t utime;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004789
Christian Heimesb3c87242013-08-01 00:08:16 +02004790 memset(&utime, 0, sizeof(utime_t));
Larry Hastings76ad59b2012-05-03 00:30:07 -07004791
Larry Hastings9cf065c2012-06-22 16:30:09 -07004792 if (times && (times != Py_None) && ns) {
4793 PyErr_SetString(PyExc_ValueError,
4794 "utime: you may specify either 'times'"
4795 " or 'ns' but not both");
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004796 return NULL;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004797 }
4798
4799 if (times && (times != Py_None)) {
Antoine Pitroucf8a1e52013-04-17 22:06:44 +02004800 time_t a_sec, m_sec;
4801 long a_nsec, m_nsec;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004802 if (!PyTuple_CheckExact(times) || (PyTuple_Size(times) != 2)) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07004803 PyErr_SetString(PyExc_TypeError,
4804 "utime: 'times' must be either"
4805 " a tuple of two ints or None");
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004806 return NULL;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004807 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07004808 utime.now = 0;
Benjamin Petersonb399ab22012-05-04 01:31:13 -04004809 if (_PyTime_ObjectToTimespec(PyTuple_GET_ITEM(times, 0),
Victor Stinnerdca028b2015-03-30 01:02:57 +02004810 &a_sec, &a_nsec, _PyTime_ROUND_FLOOR) == -1 ||
Benjamin Petersonb399ab22012-05-04 01:31:13 -04004811 _PyTime_ObjectToTimespec(PyTuple_GET_ITEM(times, 1),
Victor Stinnerdca028b2015-03-30 01:02:57 +02004812 &m_sec, &m_nsec, _PyTime_ROUND_FLOOR) == -1) {
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004813 return NULL;
Larry Hastingsb3336402012-05-04 02:31:57 -07004814 }
Antoine Pitroucf8a1e52013-04-17 22:06:44 +02004815 utime.atime_s = a_sec;
4816 utime.atime_ns = a_nsec;
4817 utime.mtime_s = m_sec;
4818 utime.mtime_ns = m_nsec;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004819 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07004820 else if (ns) {
Larry Hastings76ad59b2012-05-03 00:30:07 -07004821 if (!PyTuple_CheckExact(ns) || (PyTuple_Size(ns) != 2)) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07004822 PyErr_SetString(PyExc_TypeError,
4823 "utime: 'ns' must be a tuple of two ints");
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004824 return NULL;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004825 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07004826 utime.now = 0;
Benjamin Petersonb399ab22012-05-04 01:31:13 -04004827 if (!split_py_long_to_s_and_ns(PyTuple_GET_ITEM(ns, 0),
Larry Hastings9cf065c2012-06-22 16:30:09 -07004828 &utime.atime_s, &utime.atime_ns) ||
Benjamin Petersonb399ab22012-05-04 01:31:13 -04004829 !split_py_long_to_s_and_ns(PyTuple_GET_ITEM(ns, 1),
Larry Hastings9cf065c2012-06-22 16:30:09 -07004830 &utime.mtime_s, &utime.mtime_ns)) {
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004831 return NULL;
Larry Hastingsb3336402012-05-04 02:31:57 -07004832 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07004833 }
4834 else {
4835 /* times and ns are both None/unspecified. use "now". */
4836 utime.now = 1;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004837 }
4838
Victor Stinner4552ced2015-09-21 22:37:15 +02004839#if !defined(UTIME_HAVE_NOFOLLOW_SYMLINKS)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004840 if (follow_symlinks_specified("utime", follow_symlinks))
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004841 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07004842#endif
Benjamin Petersonb399ab22012-05-04 01:31:13 -04004843
Larry Hastings2f936352014-08-05 14:04:04 +10004844 if (path_and_dir_fd_invalid("utime", path, dir_fd) ||
4845 dir_fd_and_fd_invalid("utime", dir_fd, path->fd) ||
4846 fd_and_follow_symlinks_invalid("utime", path->fd, follow_symlinks))
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004847 return NULL;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004848
Larry Hastings9cf065c2012-06-22 16:30:09 -07004849#if !defined(HAVE_UTIMENSAT)
4850 if ((dir_fd != DEFAULT_DIR_FD) && (!follow_symlinks)) {
Georg Brandl969288e2012-06-26 09:25:44 +02004851 PyErr_SetString(PyExc_ValueError,
Larry Hastings9cf065c2012-06-22 16:30:09 -07004852 "utime: cannot use dir_fd and follow_symlinks "
4853 "together on this platform");
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004854 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07004855 }
4856#endif
Larry Hastings76ad59b2012-05-03 00:30:07 -07004857
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00004858#ifdef MS_WINDOWS
Larry Hastings9cf065c2012-06-22 16:30:09 -07004859 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07004860 hFile = CreateFileW(path->wide, FILE_WRITE_ATTRIBUTES, 0,
4861 NULL, OPEN_EXISTING,
4862 FILE_FLAG_BACKUP_SEMANTICS, NULL);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004863 Py_END_ALLOW_THREADS
4864 if (hFile == INVALID_HANDLE_VALUE) {
Larry Hastings2f936352014-08-05 14:04:04 +10004865 path_error(path);
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004866 return NULL;
Larry Hastingsb3336402012-05-04 02:31:57 -07004867 }
4868
Larry Hastings9cf065c2012-06-22 16:30:09 -07004869 if (utime.now) {
Antoine Pitrou91a7af32013-11-23 15:23:26 +01004870 GetSystemTimeAsFileTime(&mtime);
4871 atime = mtime;
Victor Stinner8c62be82010-05-06 00:08:46 +00004872 }
Victor Stinner8c62be82010-05-06 00:08:46 +00004873 else {
Steve Dowerbf1f3762015-02-21 15:26:02 -08004874 _Py_time_t_to_FILE_TIME(utime.atime_s, utime.atime_ns, &atime);
4875 _Py_time_t_to_FILE_TIME(utime.mtime_s, utime.mtime_ns, &mtime);
Victor Stinner8c62be82010-05-06 00:08:46 +00004876 }
4877 if (!SetFileTime(hFile, NULL, &atime, &mtime)) {
4878 /* Avoid putting the file name into the error here,
4879 as that may confuse the user into believing that
4880 something is wrong with the file, when it also
4881 could be the time stamp that gives a problem. */
Victor Stinnerb024e842012-10-31 22:24:06 +01004882 PyErr_SetFromWindowsErr(0);
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004883 CloseHandle(hFile);
4884 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00004885 }
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004886 CloseHandle(hFile);
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00004887#else /* MS_WINDOWS */
Larry Hastings9cf065c2012-06-22 16:30:09 -07004888 Py_BEGIN_ALLOW_THREADS
Guido van Rossum1ff6cb41991-04-08 20:59:13 +00004889
Victor Stinner4552ced2015-09-21 22:37:15 +02004890#ifdef UTIME_HAVE_NOFOLLOW_SYMLINKS
Larry Hastings9cf065c2012-06-22 16:30:09 -07004891 if ((!follow_symlinks) && (dir_fd == DEFAULT_DIR_FD))
Larry Hastings2f936352014-08-05 14:04:04 +10004892 result = utime_nofollow_symlinks(&utime, path->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004893 else
Larry Hastings9e3e70b2011-09-08 19:29:07 -07004894#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07004895
Victor Stinner528a9ab2015-09-03 21:30:26 +02004896#if defined(HAVE_FUTIMESAT) || defined(HAVE_UTIMENSAT)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004897 if ((dir_fd != DEFAULT_DIR_FD) || (!follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10004898 result = utime_dir_fd(&utime, dir_fd, path->narrow, follow_symlinks);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004899 else
4900#endif
4901
Victor Stinner528a9ab2015-09-03 21:30:26 +02004902#if defined(HAVE_FUTIMES) || defined(HAVE_FUTIMENS)
Larry Hastings2f936352014-08-05 14:04:04 +10004903 if (path->fd != -1)
4904 result = utime_fd(&utime, path->fd);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004905 else
4906#endif
4907
Larry Hastings2f936352014-08-05 14:04:04 +10004908 result = utime_default(&utime, path->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004909
4910 Py_END_ALLOW_THREADS
4911
4912 if (result < 0) {
4913 /* see previous comment about not putting filename in error here */
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004914 posix_error();
4915 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00004916 }
Larry Hastings76ad59b2012-05-03 00:30:07 -07004917
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00004918#endif /* MS_WINDOWS */
Larry Hastings9cf065c2012-06-22 16:30:09 -07004919
Serhiy Storchaka32bc11c2018-12-01 14:30:20 +02004920 Py_RETURN_NONE;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004921}
4922
Guido van Rossum3b066191991-06-04 19:40:25 +00004923/* Process operations */
Guido van Rossum85e3b011991-06-03 12:42:10 +00004924
Larry Hastings2f936352014-08-05 14:04:04 +10004925
4926/*[clinic input]
4927os._exit
4928
4929 status: int
4930
4931Exit to the system with specified status, without normal exit processing.
4932[clinic start generated code]*/
4933
Larry Hastings2f936352014-08-05 14:04:04 +10004934static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004935os__exit_impl(PyObject *module, int status)
4936/*[clinic end generated code: output=116e52d9c2260d54 input=5e6d57556b0c4a62]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004937{
4938 _exit(status);
Victor Stinner8c62be82010-05-06 00:08:46 +00004939 return NULL; /* Make gcc -Wall happy */
Guido van Rossum85e3b011991-06-03 12:42:10 +00004940}
4941
Steve Dowercc16be82016-09-08 10:35:16 -07004942#if defined(HAVE_WEXECV) || defined(HAVE_WSPAWNV)
4943#define EXECV_CHAR wchar_t
4944#else
4945#define EXECV_CHAR char
4946#endif
4947
pxinwrf2d7ac72019-05-21 18:46:37 +08004948#if defined(HAVE_EXECV) || defined(HAVE_SPAWNV) || defined(HAVE_RTPSPAWN)
Martin v. Löwis114619e2002-10-07 06:44:21 +00004949static void
Steve Dowercc16be82016-09-08 10:35:16 -07004950free_string_array(EXECV_CHAR **array, Py_ssize_t count)
Martin v. Löwis114619e2002-10-07 06:44:21 +00004951{
Victor Stinner8c62be82010-05-06 00:08:46 +00004952 Py_ssize_t i;
4953 for (i = 0; i < count; i++)
4954 PyMem_Free(array[i]);
4955 PyMem_DEL(array);
Martin v. Löwis114619e2002-10-07 06:44:21 +00004956}
Martin v. Löwis011e8422009-05-05 04:43:17 +00004957
Berker Peksag81816462016-09-15 20:19:47 +03004958static int
4959fsconvert_strdup(PyObject *o, EXECV_CHAR **out)
Martin v. Löwis011e8422009-05-05 04:43:17 +00004960{
Victor Stinner8c62be82010-05-06 00:08:46 +00004961 Py_ssize_t size;
Berker Peksag81816462016-09-15 20:19:47 +03004962 PyObject *ub;
4963 int result = 0;
Steve Dowercc16be82016-09-08 10:35:16 -07004964#if defined(HAVE_WEXECV) || defined(HAVE_WSPAWNV)
Berker Peksag81816462016-09-15 20:19:47 +03004965 if (!PyUnicode_FSDecoder(o, &ub))
Steve Dowercc16be82016-09-08 10:35:16 -07004966 return 0;
Berker Peksag81816462016-09-15 20:19:47 +03004967 *out = PyUnicode_AsWideCharString(ub, &size);
4968 if (*out)
4969 result = 1;
Steve Dowercc16be82016-09-08 10:35:16 -07004970#else
Berker Peksag81816462016-09-15 20:19:47 +03004971 if (!PyUnicode_FSConverter(o, &ub))
Victor Stinner8c62be82010-05-06 00:08:46 +00004972 return 0;
Berker Peksag81816462016-09-15 20:19:47 +03004973 size = PyBytes_GET_SIZE(ub);
4974 *out = PyMem_Malloc(size + 1);
4975 if (*out) {
4976 memcpy(*out, PyBytes_AS_STRING(ub), size + 1);
4977 result = 1;
4978 } else
Victor Stinner50abf222013-11-07 23:56:10 +01004979 PyErr_NoMemory();
Steve Dowercc16be82016-09-08 10:35:16 -07004980#endif
Berker Peksag81816462016-09-15 20:19:47 +03004981 Py_DECREF(ub);
4982 return result;
Martin v. Löwis011e8422009-05-05 04:43:17 +00004983}
Martin v. Löwis114619e2002-10-07 06:44:21 +00004984#endif
4985
pxinwrf2d7ac72019-05-21 18:46:37 +08004986#if defined(HAVE_EXECV) || defined (HAVE_FEXECVE) || defined(HAVE_RTPSPAWN)
Steve Dowercc16be82016-09-08 10:35:16 -07004987static EXECV_CHAR**
Victor Stinner13bb71c2010-04-23 21:41:56 +00004988parse_envlist(PyObject* env, Py_ssize_t *envc_ptr)
4989{
Victor Stinner8c62be82010-05-06 00:08:46 +00004990 Py_ssize_t i, pos, envc;
4991 PyObject *keys=NULL, *vals=NULL;
Berker Peksag81816462016-09-15 20:19:47 +03004992 PyObject *key, *val, *key2, *val2, *keyval;
Steve Dowercc16be82016-09-08 10:35:16 -07004993 EXECV_CHAR **envlist;
Victor Stinner13bb71c2010-04-23 21:41:56 +00004994
Victor Stinner8c62be82010-05-06 00:08:46 +00004995 i = PyMapping_Size(env);
4996 if (i < 0)
4997 return NULL;
Steve Dowercc16be82016-09-08 10:35:16 -07004998 envlist = PyMem_NEW(EXECV_CHAR *, i + 1);
Victor Stinner8c62be82010-05-06 00:08:46 +00004999 if (envlist == NULL) {
5000 PyErr_NoMemory();
5001 return NULL;
5002 }
5003 envc = 0;
5004 keys = PyMapping_Keys(env);
Victor Stinnerb0314272013-11-14 21:37:05 +01005005 if (!keys)
5006 goto error;
Victor Stinner8c62be82010-05-06 00:08:46 +00005007 vals = PyMapping_Values(env);
Victor Stinnerb0314272013-11-14 21:37:05 +01005008 if (!vals)
Victor Stinner8c62be82010-05-06 00:08:46 +00005009 goto error;
5010 if (!PyList_Check(keys) || !PyList_Check(vals)) {
5011 PyErr_Format(PyExc_TypeError,
5012 "env.keys() or env.values() is not a list");
5013 goto error;
5014 }
Victor Stinner13bb71c2010-04-23 21:41:56 +00005015
Victor Stinner8c62be82010-05-06 00:08:46 +00005016 for (pos = 0; pos < i; pos++) {
5017 key = PyList_GetItem(keys, pos);
5018 val = PyList_GetItem(vals, pos);
5019 if (!key || !val)
5020 goto error;
Victor Stinner13bb71c2010-04-23 21:41:56 +00005021
Berker Peksag81816462016-09-15 20:19:47 +03005022#if defined(HAVE_WEXECV) || defined(HAVE_WSPAWNV)
5023 if (!PyUnicode_FSDecoder(key, &key2))
5024 goto error;
5025 if (!PyUnicode_FSDecoder(val, &val2)) {
5026 Py_DECREF(key2);
5027 goto error;
5028 }
Serhiy Storchaka77703942017-06-25 07:33:01 +03005029 /* Search from index 1 because on Windows starting '=' is allowed for
5030 defining hidden environment variables. */
5031 if (PyUnicode_GET_LENGTH(key2) == 0 ||
5032 PyUnicode_FindChar(key2, '=', 1, PyUnicode_GET_LENGTH(key2), 1) != -1)
5033 {
5034 PyErr_SetString(PyExc_ValueError, "illegal environment variable name");
Eric N. Vander Weelea7874c72017-06-26 21:35:20 -04005035 Py_DECREF(key2);
5036 Py_DECREF(val2);
Serhiy Storchaka77703942017-06-25 07:33:01 +03005037 goto error;
5038 }
Berker Peksag81816462016-09-15 20:19:47 +03005039 keyval = PyUnicode_FromFormat("%U=%U", key2, val2);
5040#else
5041 if (!PyUnicode_FSConverter(key, &key2))
5042 goto error;
5043 if (!PyUnicode_FSConverter(val, &val2)) {
5044 Py_DECREF(key2);
5045 goto error;
5046 }
Serhiy Storchaka77703942017-06-25 07:33:01 +03005047 if (PyBytes_GET_SIZE(key2) == 0 ||
5048 strchr(PyBytes_AS_STRING(key2) + 1, '=') != NULL)
5049 {
5050 PyErr_SetString(PyExc_ValueError, "illegal environment variable name");
Eric N. Vander Weelea7874c72017-06-26 21:35:20 -04005051 Py_DECREF(key2);
5052 Py_DECREF(val2);
Serhiy Storchaka77703942017-06-25 07:33:01 +03005053 goto error;
5054 }
Berker Peksag81816462016-09-15 20:19:47 +03005055 keyval = PyBytes_FromFormat("%s=%s", PyBytes_AS_STRING(key2),
5056 PyBytes_AS_STRING(val2));
5057#endif
5058 Py_DECREF(key2);
5059 Py_DECREF(val2);
Steve Dowercc16be82016-09-08 10:35:16 -07005060 if (!keyval)
Victor Stinner8c62be82010-05-06 00:08:46 +00005061 goto error;
Steve Dowercc16be82016-09-08 10:35:16 -07005062
5063 if (!fsconvert_strdup(keyval, &envlist[envc++])) {
5064 Py_DECREF(keyval);
Victor Stinner8c62be82010-05-06 00:08:46 +00005065 goto error;
5066 }
Berker Peksag81816462016-09-15 20:19:47 +03005067
Steve Dowercc16be82016-09-08 10:35:16 -07005068 Py_DECREF(keyval);
Victor Stinner8c62be82010-05-06 00:08:46 +00005069 }
5070 Py_DECREF(vals);
5071 Py_DECREF(keys);
Victor Stinner13bb71c2010-04-23 21:41:56 +00005072
Victor Stinner8c62be82010-05-06 00:08:46 +00005073 envlist[envc] = 0;
5074 *envc_ptr = envc;
5075 return envlist;
Victor Stinner13bb71c2010-04-23 21:41:56 +00005076
5077error:
Victor Stinner8c62be82010-05-06 00:08:46 +00005078 Py_XDECREF(keys);
5079 Py_XDECREF(vals);
Steve Dowercc16be82016-09-08 10:35:16 -07005080 free_string_array(envlist, envc);
Victor Stinner8c62be82010-05-06 00:08:46 +00005081 return NULL;
Victor Stinner13bb71c2010-04-23 21:41:56 +00005082}
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00005083
Steve Dowercc16be82016-09-08 10:35:16 -07005084static EXECV_CHAR**
Ross Lagerwall7807c352011-03-17 20:20:30 +02005085parse_arglist(PyObject* argv, Py_ssize_t *argc)
5086{
5087 int i;
Steve Dowercc16be82016-09-08 10:35:16 -07005088 EXECV_CHAR **argvlist = PyMem_NEW(EXECV_CHAR *, *argc+1);
Ross Lagerwall7807c352011-03-17 20:20:30 +02005089 if (argvlist == NULL) {
5090 PyErr_NoMemory();
5091 return NULL;
5092 }
5093 for (i = 0; i < *argc; i++) {
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02005094 PyObject* item = PySequence_ITEM(argv, i);
5095 if (item == NULL)
5096 goto fail;
5097 if (!fsconvert_strdup(item, &argvlist[i])) {
5098 Py_DECREF(item);
Ross Lagerwall7807c352011-03-17 20:20:30 +02005099 goto fail;
5100 }
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02005101 Py_DECREF(item);
Ross Lagerwall7807c352011-03-17 20:20:30 +02005102 }
5103 argvlist[*argc] = NULL;
5104 return argvlist;
5105fail:
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02005106 *argc = i;
Ross Lagerwall7807c352011-03-17 20:20:30 +02005107 free_string_array(argvlist, *argc);
5108 return NULL;
5109}
Steve Dowercc16be82016-09-08 10:35:16 -07005110
Ross Lagerwall7807c352011-03-17 20:20:30 +02005111#endif
5112
Larry Hastings2f936352014-08-05 14:04:04 +10005113
Ross Lagerwall7807c352011-03-17 20:20:30 +02005114#ifdef HAVE_EXECV
Larry Hastings2f936352014-08-05 14:04:04 +10005115/*[clinic input]
5116os.execv
5117
Steve Dowercc16be82016-09-08 10:35:16 -07005118 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +10005119 Path of executable file.
5120 argv: object
5121 Tuple or list of strings.
5122 /
5123
5124Execute an executable path with arguments, replacing current process.
5125[clinic start generated code]*/
5126
Larry Hastings2f936352014-08-05 14:04:04 +10005127static PyObject *
Steve Dowercc16be82016-09-08 10:35:16 -07005128os_execv_impl(PyObject *module, path_t *path, PyObject *argv)
5129/*[clinic end generated code: output=3b52fec34cd0dafd input=9bac31efae07dac7]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005130{
Steve Dowercc16be82016-09-08 10:35:16 -07005131 EXECV_CHAR **argvlist;
Ross Lagerwall7807c352011-03-17 20:20:30 +02005132 Py_ssize_t argc;
5133
5134 /* execv has two arguments: (path, argv), where
5135 argv is a list or tuple of strings. */
5136
Ross Lagerwall7807c352011-03-17 20:20:30 +02005137 if (!PyList_Check(argv) && !PyTuple_Check(argv)) {
5138 PyErr_SetString(PyExc_TypeError,
5139 "execv() arg 2 must be a tuple or list");
Ross Lagerwall7807c352011-03-17 20:20:30 +02005140 return NULL;
5141 }
5142 argc = PySequence_Size(argv);
5143 if (argc < 1) {
5144 PyErr_SetString(PyExc_ValueError, "execv() arg 2 must not be empty");
Ross Lagerwall7807c352011-03-17 20:20:30 +02005145 return NULL;
5146 }
5147
5148 argvlist = parse_arglist(argv, &argc);
5149 if (argvlist == NULL) {
Ross Lagerwall7807c352011-03-17 20:20:30 +02005150 return NULL;
5151 }
Steve Dowerbce26262016-11-19 19:17:26 -08005152 if (!argvlist[0][0]) {
5153 PyErr_SetString(PyExc_ValueError,
5154 "execv() arg 2 first element cannot be empty");
5155 free_string_array(argvlist, argc);
5156 return NULL;
5157 }
Ross Lagerwall7807c352011-03-17 20:20:30 +02005158
Steve Dowerbce26262016-11-19 19:17:26 -08005159 _Py_BEGIN_SUPPRESS_IPH
Steve Dowercc16be82016-09-08 10:35:16 -07005160#ifdef HAVE_WEXECV
5161 _wexecv(path->wide, argvlist);
5162#else
5163 execv(path->narrow, argvlist);
5164#endif
Steve Dowerbce26262016-11-19 19:17:26 -08005165 _Py_END_SUPPRESS_IPH
Ross Lagerwall7807c352011-03-17 20:20:30 +02005166
5167 /* If we get here it's definitely an error */
5168
5169 free_string_array(argvlist, argc);
Ross Lagerwall7807c352011-03-17 20:20:30 +02005170 return posix_error();
5171}
5172
Larry Hastings2f936352014-08-05 14:04:04 +10005173
5174/*[clinic input]
5175os.execve
5176
5177 path: path_t(allow_fd='PATH_HAVE_FEXECVE')
5178 Path of executable file.
5179 argv: object
5180 Tuple or list of strings.
5181 env: object
5182 Dictionary of strings mapping to strings.
5183
5184Execute an executable path with arguments, replacing current process.
5185[clinic start generated code]*/
5186
Larry Hastings2f936352014-08-05 14:04:04 +10005187static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005188os_execve_impl(PyObject *module, path_t *path, PyObject *argv, PyObject *env)
5189/*[clinic end generated code: output=ff9fa8e4da8bde58 input=626804fa092606d9]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005190{
Steve Dowercc16be82016-09-08 10:35:16 -07005191 EXECV_CHAR **argvlist = NULL;
5192 EXECV_CHAR **envlist;
Ross Lagerwall7807c352011-03-17 20:20:30 +02005193 Py_ssize_t argc, envc;
Guido van Rossumc6dcc9f1993-11-05 10:15:19 +00005194
Victor Stinner8c62be82010-05-06 00:08:46 +00005195 /* execve has three arguments: (path, argv, env), where
5196 argv is a list or tuple of strings and env is a dictionary
5197 like posix.environ. */
Guido van Rossumc6dcc9f1993-11-05 10:15:19 +00005198
Ross Lagerwall7807c352011-03-17 20:20:30 +02005199 if (!PyList_Check(argv) && !PyTuple_Check(argv)) {
Victor Stinner8c62be82010-05-06 00:08:46 +00005200 PyErr_SetString(PyExc_TypeError,
Larry Hastings9cf065c2012-06-22 16:30:09 -07005201 "execve: argv must be a tuple or list");
5202 goto fail;
Victor Stinner8c62be82010-05-06 00:08:46 +00005203 }
Ross Lagerwall7807c352011-03-17 20:20:30 +02005204 argc = PySequence_Size(argv);
Steve Dowerbce26262016-11-19 19:17:26 -08005205 if (argc < 1) {
5206 PyErr_SetString(PyExc_ValueError, "execve: argv must not be empty");
5207 return NULL;
5208 }
5209
Victor Stinner8c62be82010-05-06 00:08:46 +00005210 if (!PyMapping_Check(env)) {
5211 PyErr_SetString(PyExc_TypeError,
Larry Hastings9cf065c2012-06-22 16:30:09 -07005212 "execve: environment must be a mapping object");
5213 goto fail;
Victor Stinner8c62be82010-05-06 00:08:46 +00005214 }
Guido van Rossumc6dcc9f1993-11-05 10:15:19 +00005215
Ross Lagerwall7807c352011-03-17 20:20:30 +02005216 argvlist = parse_arglist(argv, &argc);
Victor Stinner8c62be82010-05-06 00:08:46 +00005217 if (argvlist == NULL) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07005218 goto fail;
Victor Stinner8c62be82010-05-06 00:08:46 +00005219 }
Steve Dowerbce26262016-11-19 19:17:26 -08005220 if (!argvlist[0][0]) {
5221 PyErr_SetString(PyExc_ValueError,
5222 "execve: argv first element cannot be empty");
5223 goto fail;
5224 }
Guido van Rossumc6dcc9f1993-11-05 10:15:19 +00005225
Victor Stinner8c62be82010-05-06 00:08:46 +00005226 envlist = parse_envlist(env, &envc);
5227 if (envlist == NULL)
Ross Lagerwall7807c352011-03-17 20:20:30 +02005228 goto fail;
5229
Steve Dowerbce26262016-11-19 19:17:26 -08005230 _Py_BEGIN_SUPPRESS_IPH
Larry Hastings9cf065c2012-06-22 16:30:09 -07005231#ifdef HAVE_FEXECVE
Larry Hastings2f936352014-08-05 14:04:04 +10005232 if (path->fd > -1)
5233 fexecve(path->fd, argvlist, envlist);
Larry Hastings9cf065c2012-06-22 16:30:09 -07005234 else
5235#endif
Steve Dowercc16be82016-09-08 10:35:16 -07005236#ifdef HAVE_WEXECV
5237 _wexecve(path->wide, argvlist, envlist);
5238#else
Larry Hastings2f936352014-08-05 14:04:04 +10005239 execve(path->narrow, argvlist, envlist);
Steve Dowercc16be82016-09-08 10:35:16 -07005240#endif
Steve Dowerbce26262016-11-19 19:17:26 -08005241 _Py_END_SUPPRESS_IPH
Ross Lagerwall7807c352011-03-17 20:20:30 +02005242
5243 /* If we get here it's definitely an error */
5244
Alexey Izbyshev83460312018-10-20 03:28:22 +03005245 posix_path_error(path);
Ross Lagerwall7807c352011-03-17 20:20:30 +02005246
Steve Dowercc16be82016-09-08 10:35:16 -07005247 free_string_array(envlist, envc);
Ross Lagerwall7807c352011-03-17 20:20:30 +02005248 fail:
Larry Hastings9cf065c2012-06-22 16:30:09 -07005249 if (argvlist)
5250 free_string_array(argvlist, argc);
Ross Lagerwall7807c352011-03-17 20:20:30 +02005251 return NULL;
5252}
Steve Dowercc16be82016-09-08 10:35:16 -07005253
Larry Hastings9cf065c2012-06-22 16:30:09 -07005254#endif /* HAVE_EXECV */
5255
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005256#ifdef HAVE_POSIX_SPAWN
5257
5258enum posix_spawn_file_actions_identifier {
5259 POSIX_SPAWN_OPEN,
5260 POSIX_SPAWN_CLOSE,
5261 POSIX_SPAWN_DUP2
5262};
5263
William Orr81574b82018-10-01 22:19:56 -07005264#if defined(HAVE_SCHED_SETPARAM) || defined(HAVE_SCHED_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDPARAM)
Serhiy Storchakaef347532018-05-01 16:45:04 +03005265static int
Pablo Galindo254a4662018-09-07 16:44:24 +01005266convert_sched_param(PyObject *param, struct sched_param *res);
William Orr81574b82018-10-01 22:19:56 -07005267#endif
Pablo Galindo254a4662018-09-07 16:44:24 +01005268
5269static int
Victor Stinner325e4ba2019-02-01 15:47:24 +01005270parse_posix_spawn_flags(const char *func_name, PyObject *setpgroup,
5271 int resetids, int setsid, PyObject *setsigmask,
Pablo Galindo254a4662018-09-07 16:44:24 +01005272 PyObject *setsigdef, PyObject *scheduler,
5273 posix_spawnattr_t *attrp)
5274{
5275 long all_flags = 0;
5276
5277 errno = posix_spawnattr_init(attrp);
5278 if (errno) {
5279 posix_error();
5280 return -1;
5281 }
5282
5283 if (setpgroup) {
5284 pid_t pgid = PyLong_AsPid(setpgroup);
5285 if (pgid == (pid_t)-1 && PyErr_Occurred()) {
5286 goto fail;
5287 }
5288 errno = posix_spawnattr_setpgroup(attrp, pgid);
5289 if (errno) {
5290 posix_error();
5291 goto fail;
5292 }
5293 all_flags |= POSIX_SPAWN_SETPGROUP;
5294 }
5295
5296 if (resetids) {
5297 all_flags |= POSIX_SPAWN_RESETIDS;
5298 }
5299
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005300 if (setsid) {
5301#ifdef POSIX_SPAWN_SETSID
5302 all_flags |= POSIX_SPAWN_SETSID;
5303#elif defined(POSIX_SPAWN_SETSID_NP)
5304 all_flags |= POSIX_SPAWN_SETSID_NP;
5305#else
5306 argument_unavailable_error(func_name, "setsid");
5307 return -1;
5308#endif
5309 }
5310
Pablo Galindo254a4662018-09-07 16:44:24 +01005311 if (setsigmask) {
5312 sigset_t set;
5313 if (!_Py_Sigset_Converter(setsigmask, &set)) {
5314 goto fail;
5315 }
5316 errno = posix_spawnattr_setsigmask(attrp, &set);
5317 if (errno) {
5318 posix_error();
5319 goto fail;
5320 }
5321 all_flags |= POSIX_SPAWN_SETSIGMASK;
5322 }
5323
5324 if (setsigdef) {
5325 sigset_t set;
5326 if (!_Py_Sigset_Converter(setsigdef, &set)) {
5327 goto fail;
5328 }
5329 errno = posix_spawnattr_setsigdefault(attrp, &set);
5330 if (errno) {
5331 posix_error();
5332 goto fail;
5333 }
5334 all_flags |= POSIX_SPAWN_SETSIGDEF;
5335 }
5336
5337 if (scheduler) {
5338#ifdef POSIX_SPAWN_SETSCHEDULER
5339 PyObject *py_schedpolicy;
5340 struct sched_param schedparam;
5341
5342 if (!PyArg_ParseTuple(scheduler, "OO&"
5343 ";A scheduler tuple must have two elements",
5344 &py_schedpolicy, convert_sched_param, &schedparam)) {
5345 goto fail;
5346 }
5347 if (py_schedpolicy != Py_None) {
5348 int schedpolicy = _PyLong_AsInt(py_schedpolicy);
5349
5350 if (schedpolicy == -1 && PyErr_Occurred()) {
5351 goto fail;
5352 }
5353 errno = posix_spawnattr_setschedpolicy(attrp, schedpolicy);
5354 if (errno) {
5355 posix_error();
5356 goto fail;
5357 }
5358 all_flags |= POSIX_SPAWN_SETSCHEDULER;
5359 }
5360 errno = posix_spawnattr_setschedparam(attrp, &schedparam);
5361 if (errno) {
5362 posix_error();
5363 goto fail;
5364 }
5365 all_flags |= POSIX_SPAWN_SETSCHEDPARAM;
5366#else
5367 PyErr_SetString(PyExc_NotImplementedError,
5368 "The scheduler option is not supported in this system.");
5369 goto fail;
5370#endif
5371 }
5372
5373 errno = posix_spawnattr_setflags(attrp, all_flags);
5374 if (errno) {
5375 posix_error();
5376 goto fail;
5377 }
5378
5379 return 0;
5380
5381fail:
5382 (void)posix_spawnattr_destroy(attrp);
5383 return -1;
5384}
5385
5386static int
Serhiy Storchakaef347532018-05-01 16:45:04 +03005387parse_file_actions(PyObject *file_actions,
Pablo Galindocb970732018-06-19 09:19:50 +01005388 posix_spawn_file_actions_t *file_actionsp,
5389 PyObject *temp_buffer)
Serhiy Storchakaef347532018-05-01 16:45:04 +03005390{
5391 PyObject *seq;
5392 PyObject *file_action = NULL;
5393 PyObject *tag_obj;
5394
5395 seq = PySequence_Fast(file_actions,
5396 "file_actions must be a sequence or None");
5397 if (seq == NULL) {
5398 return -1;
5399 }
5400
5401 errno = posix_spawn_file_actions_init(file_actionsp);
5402 if (errno) {
5403 posix_error();
5404 Py_DECREF(seq);
5405 return -1;
5406 }
5407
Miss Islington (bot)04d46922019-06-26 14:20:09 -07005408 for (Py_ssize_t i = 0; i < PySequence_Fast_GET_SIZE(seq); ++i) {
Serhiy Storchakaef347532018-05-01 16:45:04 +03005409 file_action = PySequence_Fast_GET_ITEM(seq, i);
5410 Py_INCREF(file_action);
5411 if (!PyTuple_Check(file_action) || !PyTuple_GET_SIZE(file_action)) {
5412 PyErr_SetString(PyExc_TypeError,
5413 "Each file_actions element must be a non-empty tuple");
5414 goto fail;
5415 }
5416 long tag = PyLong_AsLong(PyTuple_GET_ITEM(file_action, 0));
5417 if (tag == -1 && PyErr_Occurred()) {
5418 goto fail;
5419 }
5420
5421 /* Populate the file_actions object */
5422 switch (tag) {
5423 case POSIX_SPAWN_OPEN: {
5424 int fd, oflag;
5425 PyObject *path;
5426 unsigned long mode;
5427 if (!PyArg_ParseTuple(file_action, "OiO&ik"
5428 ";A open file_action tuple must have 5 elements",
5429 &tag_obj, &fd, PyUnicode_FSConverter, &path,
5430 &oflag, &mode))
5431 {
5432 goto fail;
5433 }
Pablo Galindocb970732018-06-19 09:19:50 +01005434 if (PyList_Append(temp_buffer, path)) {
5435 Py_DECREF(path);
5436 goto fail;
5437 }
Serhiy Storchakaef347532018-05-01 16:45:04 +03005438 errno = posix_spawn_file_actions_addopen(file_actionsp,
5439 fd, PyBytes_AS_STRING(path), oflag, (mode_t)mode);
Pablo Galindocb970732018-06-19 09:19:50 +01005440 Py_DECREF(path);
Serhiy Storchakaef347532018-05-01 16:45:04 +03005441 if (errno) {
5442 posix_error();
5443 goto fail;
5444 }
5445 break;
5446 }
5447 case POSIX_SPAWN_CLOSE: {
5448 int fd;
5449 if (!PyArg_ParseTuple(file_action, "Oi"
5450 ";A close file_action tuple must have 2 elements",
5451 &tag_obj, &fd))
5452 {
5453 goto fail;
5454 }
5455 errno = posix_spawn_file_actions_addclose(file_actionsp, fd);
5456 if (errno) {
5457 posix_error();
5458 goto fail;
5459 }
5460 break;
5461 }
5462 case POSIX_SPAWN_DUP2: {
5463 int fd1, fd2;
5464 if (!PyArg_ParseTuple(file_action, "Oii"
5465 ";A dup2 file_action tuple must have 3 elements",
5466 &tag_obj, &fd1, &fd2))
5467 {
5468 goto fail;
5469 }
5470 errno = posix_spawn_file_actions_adddup2(file_actionsp,
5471 fd1, fd2);
5472 if (errno) {
5473 posix_error();
5474 goto fail;
5475 }
5476 break;
5477 }
5478 default: {
5479 PyErr_SetString(PyExc_TypeError,
5480 "Unknown file_actions identifier");
5481 goto fail;
5482 }
5483 }
5484 Py_DECREF(file_action);
5485 }
Pablo Galindo254a4662018-09-07 16:44:24 +01005486
Serhiy Storchakaef347532018-05-01 16:45:04 +03005487 Py_DECREF(seq);
5488 return 0;
5489
5490fail:
5491 Py_DECREF(seq);
5492 Py_DECREF(file_action);
5493 (void)posix_spawn_file_actions_destroy(file_actionsp);
5494 return -1;
5495}
5496
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005497
5498static PyObject *
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005499py_posix_spawn(int use_posix_spawnp, PyObject *module, path_t *path, PyObject *argv,
5500 PyObject *env, PyObject *file_actions,
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005501 PyObject *setpgroup, int resetids, int setsid, PyObject *setsigmask,
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005502 PyObject *setsigdef, PyObject *scheduler)
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005503{
Victor Stinner325e4ba2019-02-01 15:47:24 +01005504 const char *func_name = use_posix_spawnp ? "posix_spawnp" : "posix_spawn";
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005505 EXECV_CHAR **argvlist = NULL;
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005506 EXECV_CHAR **envlist = NULL;
Serhiy Storchakaef347532018-05-01 16:45:04 +03005507 posix_spawn_file_actions_t file_actions_buf;
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005508 posix_spawn_file_actions_t *file_actionsp = NULL;
Pablo Galindo254a4662018-09-07 16:44:24 +01005509 posix_spawnattr_t attr;
5510 posix_spawnattr_t *attrp = NULL;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005511 Py_ssize_t argc, envc;
Serhiy Storchakaef347532018-05-01 16:45:04 +03005512 PyObject *result = NULL;
Pablo Galindocb970732018-06-19 09:19:50 +01005513 PyObject *temp_buffer = NULL;
Serhiy Storchakaef347532018-05-01 16:45:04 +03005514 pid_t pid;
5515 int err_code;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005516
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005517 /* posix_spawn and posix_spawnp have three arguments: (path, argv, env), where
Serhiy Storchakaef347532018-05-01 16:45:04 +03005518 argv is a list or tuple of strings and env is a dictionary
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005519 like posix.environ. */
5520
Serhiy Storchakaef347532018-05-01 16:45:04 +03005521 if (!PyList_Check(argv) && !PyTuple_Check(argv)) {
Victor Stinner325e4ba2019-02-01 15:47:24 +01005522 PyErr_Format(PyExc_TypeError,
5523 "%s: argv must be a tuple or list", func_name);
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005524 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005525 }
5526 argc = PySequence_Size(argv);
5527 if (argc < 1) {
Victor Stinner325e4ba2019-02-01 15:47:24 +01005528 PyErr_Format(PyExc_ValueError,
5529 "%s: argv must not be empty", func_name);
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005530 return NULL;
5531 }
5532
5533 if (!PyMapping_Check(env)) {
Victor Stinner325e4ba2019-02-01 15:47:24 +01005534 PyErr_Format(PyExc_TypeError,
5535 "%s: environment must be a mapping object", func_name);
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005536 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005537 }
5538
5539 argvlist = parse_arglist(argv, &argc);
5540 if (argvlist == NULL) {
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005541 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005542 }
5543 if (!argvlist[0][0]) {
Victor Stinner325e4ba2019-02-01 15:47:24 +01005544 PyErr_Format(PyExc_ValueError,
5545 "%s: argv first element cannot be empty", func_name);
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005546 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005547 }
5548
5549 envlist = parse_envlist(env, &envc);
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005550 if (envlist == NULL) {
5551 goto exit;
5552 }
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005553
Anthony Shaw948ed8c2019-05-10 12:00:06 +10005554 if (file_actions != NULL && file_actions != Py_None) {
Pablo Galindocb970732018-06-19 09:19:50 +01005555 /* There is a bug in old versions of glibc that makes some of the
5556 * helper functions for manipulating file actions not copy the provided
5557 * buffers. The problem is that posix_spawn_file_actions_addopen does not
5558 * copy the value of path for some old versions of glibc (<2.20).
5559 * The use of temp_buffer here is a workaround that keeps the
5560 * python objects that own the buffers alive until posix_spawn gets called.
5561 * Check https://bugs.python.org/issue33630 and
5562 * https://sourceware.org/bugzilla/show_bug.cgi?id=17048 for more info.*/
5563 temp_buffer = PyList_New(0);
5564 if (!temp_buffer) {
5565 goto exit;
5566 }
5567 if (parse_file_actions(file_actions, &file_actions_buf, temp_buffer)) {
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005568 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005569 }
Serhiy Storchakaef347532018-05-01 16:45:04 +03005570 file_actionsp = &file_actions_buf;
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005571 }
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005572
Victor Stinner325e4ba2019-02-01 15:47:24 +01005573 if (parse_posix_spawn_flags(func_name, setpgroup, resetids, setsid,
5574 setsigmask, setsigdef, scheduler, &attr)) {
Pablo Galindo254a4662018-09-07 16:44:24 +01005575 goto exit;
5576 }
5577 attrp = &attr;
5578
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005579 _Py_BEGIN_SUPPRESS_IPH
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005580#ifdef HAVE_POSIX_SPAWNP
5581 if (use_posix_spawnp) {
5582 err_code = posix_spawnp(&pid, path->narrow,
5583 file_actionsp, attrp, argvlist, envlist);
5584 }
5585 else
5586#endif /* HAVE_POSIX_SPAWNP */
5587 {
5588 err_code = posix_spawn(&pid, path->narrow,
5589 file_actionsp, attrp, argvlist, envlist);
5590 }
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005591 _Py_END_SUPPRESS_IPH
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005592
Serhiy Storchakaef347532018-05-01 16:45:04 +03005593 if (err_code) {
5594 errno = err_code;
5595 PyErr_SetFromErrnoWithFilenameObject(PyExc_OSError, path->object);
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005596 goto exit;
5597 }
Gregory P. Smith1d300ce2018-12-30 21:13:02 -08005598#ifdef _Py_MEMORY_SANITIZER
5599 __msan_unpoison(&pid, sizeof(pid));
5600#endif
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005601 result = PyLong_FromPid(pid);
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005602
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005603exit:
Serhiy Storchakaef347532018-05-01 16:45:04 +03005604 if (file_actionsp) {
5605 (void)posix_spawn_file_actions_destroy(file_actionsp);
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005606 }
Pablo Galindo254a4662018-09-07 16:44:24 +01005607 if (attrp) {
5608 (void)posix_spawnattr_destroy(attrp);
5609 }
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005610 if (envlist) {
5611 free_string_array(envlist, envc);
5612 }
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005613 if (argvlist) {
5614 free_string_array(argvlist, argc);
5615 }
Pablo Galindocb970732018-06-19 09:19:50 +01005616 Py_XDECREF(temp_buffer);
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005617 return result;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005618}
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005619
5620
5621/*[clinic input]
5622
5623os.posix_spawn
5624 path: path_t
5625 Path of executable file.
5626 argv: object
5627 Tuple or list of strings.
5628 env: object
5629 Dictionary of strings mapping to strings.
5630 /
5631 *
5632 file_actions: object(c_default='NULL') = ()
5633 A sequence of file action tuples.
5634 setpgroup: object = NULL
5635 The pgroup to use with the POSIX_SPAWN_SETPGROUP flag.
5636 resetids: bool(accept={int}) = False
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005637 If the value is `true` the POSIX_SPAWN_RESETIDS will be activated.
5638 setsid: bool(accept={int}) = False
5639 If the value is `true` the POSIX_SPAWN_SETSID or POSIX_SPAWN_SETSID_NP will be activated.
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005640 setsigmask: object(c_default='NULL') = ()
5641 The sigmask to use with the POSIX_SPAWN_SETSIGMASK flag.
5642 setsigdef: object(c_default='NULL') = ()
5643 The sigmask to use with the POSIX_SPAWN_SETSIGDEF flag.
5644 scheduler: object = NULL
5645 A tuple with the scheduler policy (optional) and parameters.
5646
5647Execute the program specified by path in a new process.
5648[clinic start generated code]*/
5649
5650static PyObject *
5651os_posix_spawn_impl(PyObject *module, path_t *path, PyObject *argv,
5652 PyObject *env, PyObject *file_actions,
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005653 PyObject *setpgroup, int resetids, int setsid,
5654 PyObject *setsigmask, PyObject *setsigdef,
5655 PyObject *scheduler)
5656/*[clinic end generated code: output=14a1098c566bc675 input=8c6305619a00ad04]*/
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005657{
5658 return py_posix_spawn(0, module, path, argv, env, file_actions,
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005659 setpgroup, resetids, setsid, setsigmask, setsigdef,
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005660 scheduler);
5661}
5662 #endif /* HAVE_POSIX_SPAWN */
5663
5664
5665
5666#ifdef HAVE_POSIX_SPAWNP
5667/*[clinic input]
5668
5669os.posix_spawnp
5670 path: path_t
5671 Path of executable file.
5672 argv: object
5673 Tuple or list of strings.
5674 env: object
5675 Dictionary of strings mapping to strings.
5676 /
5677 *
5678 file_actions: object(c_default='NULL') = ()
5679 A sequence of file action tuples.
5680 setpgroup: object = NULL
5681 The pgroup to use with the POSIX_SPAWN_SETPGROUP flag.
5682 resetids: bool(accept={int}) = False
5683 If the value is `True` the POSIX_SPAWN_RESETIDS will be activated.
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005684 setsid: bool(accept={int}) = False
5685 If the value is `True` the POSIX_SPAWN_SETSID or POSIX_SPAWN_SETSID_NP will be activated.
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005686 setsigmask: object(c_default='NULL') = ()
5687 The sigmask to use with the POSIX_SPAWN_SETSIGMASK flag.
5688 setsigdef: object(c_default='NULL') = ()
5689 The sigmask to use with the POSIX_SPAWN_SETSIGDEF flag.
5690 scheduler: object = NULL
5691 A tuple with the scheduler policy (optional) and parameters.
5692
5693Execute the program specified by path in a new process.
5694[clinic start generated code]*/
5695
5696static PyObject *
5697os_posix_spawnp_impl(PyObject *module, path_t *path, PyObject *argv,
5698 PyObject *env, PyObject *file_actions,
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005699 PyObject *setpgroup, int resetids, int setsid,
5700 PyObject *setsigmask, PyObject *setsigdef,
5701 PyObject *scheduler)
5702/*[clinic end generated code: output=7b9aaefe3031238d input=c1911043a22028da]*/
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005703{
5704 return py_posix_spawn(1, module, path, argv, env, file_actions,
Joannah Nanjekye80c5dfe2019-02-01 13:05:22 +03005705 setpgroup, resetids, setsid, setsigmask, setsigdef,
Joannah Nanjekye92b83222019-01-16 16:29:26 +03005706 scheduler);
5707}
5708#endif /* HAVE_POSIX_SPAWNP */
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005709
pxinwrf2d7ac72019-05-21 18:46:37 +08005710#ifdef HAVE_RTPSPAWN
5711static intptr_t
5712_rtp_spawn(int mode, const char *rtpFileName, const char *argv[],
5713 const char *envp[])
5714{
5715 RTP_ID rtpid;
5716 int status;
5717 pid_t res;
5718 int async_err = 0;
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00005719
pxinwrf2d7ac72019-05-21 18:46:37 +08005720 /* Set priority=100 and uStackSize=16 MiB (0x1000000) for new processes.
5721 uStackSize=0 cannot be used, the default stack size is too small for
5722 Python. */
5723 if (envp) {
5724 rtpid = rtpSpawn(rtpFileName, argv, envp,
5725 100, 0x1000000, 0, VX_FP_TASK);
5726 }
5727 else {
5728 rtpid = rtpSpawn(rtpFileName, argv, (const char **)environ,
5729 100, 0x1000000, 0, VX_FP_TASK);
5730 }
5731 if ((rtpid != RTP_ID_ERROR) && (mode == _P_WAIT)) {
5732 do {
5733 res = waitpid((pid_t)rtpid, &status, 0);
5734 } while (res < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
5735
5736 if (res < 0)
5737 return RTP_ID_ERROR;
5738 return ((intptr_t)status);
5739 }
5740 return ((intptr_t)rtpid);
5741}
5742#endif
5743
5744#if defined(HAVE_SPAWNV) || defined(HAVE_WSPAWNV) || defined(HAVE_RTPSPAWN)
Larry Hastings2f936352014-08-05 14:04:04 +10005745/*[clinic input]
5746os.spawnv
5747
5748 mode: int
5749 Mode of process creation.
Steve Dowercc16be82016-09-08 10:35:16 -07005750 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +10005751 Path of executable file.
5752 argv: object
5753 Tuple or list of strings.
5754 /
5755
5756Execute the program specified by path in a new process.
5757[clinic start generated code]*/
5758
Larry Hastings2f936352014-08-05 14:04:04 +10005759static PyObject *
Steve Dowercc16be82016-09-08 10:35:16 -07005760os_spawnv_impl(PyObject *module, int mode, path_t *path, PyObject *argv)
5761/*[clinic end generated code: output=71cd037a9d96b816 input=43224242303291be]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005762{
Steve Dowercc16be82016-09-08 10:35:16 -07005763 EXECV_CHAR **argvlist;
Larry Hastings2f936352014-08-05 14:04:04 +10005764 int i;
Victor Stinner8c62be82010-05-06 00:08:46 +00005765 Py_ssize_t argc;
Benjamin Petersonca470632016-09-06 13:47:26 -07005766 intptr_t spawnval;
Victor Stinner8c62be82010-05-06 00:08:46 +00005767 PyObject *(*getitem)(PyObject *, Py_ssize_t);
Guido van Rossuma1065681999-01-25 23:20:23 +00005768
Victor Stinner8c62be82010-05-06 00:08:46 +00005769 /* spawnv has three arguments: (mode, path, argv), where
5770 argv is a list or tuple of strings. */
Guido van Rossuma1065681999-01-25 23:20:23 +00005771
Victor Stinner8c62be82010-05-06 00:08:46 +00005772 if (PyList_Check(argv)) {
5773 argc = PyList_Size(argv);
5774 getitem = PyList_GetItem;
5775 }
5776 else if (PyTuple_Check(argv)) {
5777 argc = PyTuple_Size(argv);
5778 getitem = PyTuple_GetItem;
5779 }
5780 else {
5781 PyErr_SetString(PyExc_TypeError,
5782 "spawnv() arg 2 must be a tuple or list");
Victor Stinner8c62be82010-05-06 00:08:46 +00005783 return NULL;
5784 }
Steve Dower859fd7b2016-11-19 18:53:19 -08005785 if (argc == 0) {
5786 PyErr_SetString(PyExc_ValueError,
5787 "spawnv() arg 2 cannot be empty");
5788 return NULL;
5789 }
Guido van Rossuma1065681999-01-25 23:20:23 +00005790
Steve Dowercc16be82016-09-08 10:35:16 -07005791 argvlist = PyMem_NEW(EXECV_CHAR *, argc+1);
Victor Stinner8c62be82010-05-06 00:08:46 +00005792 if (argvlist == NULL) {
Victor Stinner8c62be82010-05-06 00:08:46 +00005793 return PyErr_NoMemory();
5794 }
5795 for (i = 0; i < argc; i++) {
5796 if (!fsconvert_strdup((*getitem)(argv, i),
5797 &argvlist[i])) {
5798 free_string_array(argvlist, i);
5799 PyErr_SetString(
5800 PyExc_TypeError,
5801 "spawnv() arg 2 must contain only strings");
Victor Stinner8c62be82010-05-06 00:08:46 +00005802 return NULL;
5803 }
Steve Dower93ff8722016-11-19 19:03:54 -08005804 if (i == 0 && !argvlist[0][0]) {
Victor Stinner8acb4cf2017-06-15 15:30:40 +02005805 free_string_array(argvlist, i + 1);
Steve Dower93ff8722016-11-19 19:03:54 -08005806 PyErr_SetString(
5807 PyExc_ValueError,
5808 "spawnv() arg 2 first element cannot be empty");
5809 return NULL;
5810 }
Victor Stinner8c62be82010-05-06 00:08:46 +00005811 }
5812 argvlist[argc] = NULL;
Guido van Rossuma1065681999-01-25 23:20:23 +00005813
pxinwrf2d7ac72019-05-21 18:46:37 +08005814#if !defined(HAVE_RTPSPAWN)
Victor Stinner8c62be82010-05-06 00:08:46 +00005815 if (mode == _OLD_P_OVERLAY)
5816 mode = _P_OVERLAY;
pxinwrf2d7ac72019-05-21 18:46:37 +08005817#endif
Tim Peters5aa91602002-01-30 05:46:57 +00005818
Victor Stinner8c62be82010-05-06 00:08:46 +00005819 Py_BEGIN_ALLOW_THREADS
Steve Dower654a7bd2016-09-11 20:19:32 -07005820 _Py_BEGIN_SUPPRESS_IPH
Steve Dowercc16be82016-09-08 10:35:16 -07005821#ifdef HAVE_WSPAWNV
5822 spawnval = _wspawnv(mode, path->wide, argvlist);
pxinwrf2d7ac72019-05-21 18:46:37 +08005823#elif defined(HAVE_RTPSPAWN)
5824 spawnval = _rtp_spawn(mode, path->narrow, (const char **)argvlist, NULL);
Steve Dowercc16be82016-09-08 10:35:16 -07005825#else
5826 spawnval = _spawnv(mode, path->narrow, argvlist);
5827#endif
Steve Dower654a7bd2016-09-11 20:19:32 -07005828 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00005829 Py_END_ALLOW_THREADS
Tim Peters5aa91602002-01-30 05:46:57 +00005830
Victor Stinner8c62be82010-05-06 00:08:46 +00005831 free_string_array(argvlist, argc);
Guido van Rossuma1065681999-01-25 23:20:23 +00005832
Victor Stinner8c62be82010-05-06 00:08:46 +00005833 if (spawnval == -1)
5834 return posix_error();
5835 else
Richard Oudkerkac0ad882013-06-05 23:29:30 +01005836 return Py_BuildValue(_Py_PARSE_INTPTR, spawnval);
Guido van Rossuma1065681999-01-25 23:20:23 +00005837}
5838
Larry Hastings2f936352014-08-05 14:04:04 +10005839/*[clinic input]
5840os.spawnve
5841
5842 mode: int
5843 Mode of process creation.
Steve Dowercc16be82016-09-08 10:35:16 -07005844 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +10005845 Path of executable file.
5846 argv: object
5847 Tuple or list of strings.
5848 env: object
5849 Dictionary of strings mapping to strings.
5850 /
5851
5852Execute the program specified by path in a new process.
5853[clinic start generated code]*/
5854
Larry Hastings2f936352014-08-05 14:04:04 +10005855static PyObject *
Steve Dowercc16be82016-09-08 10:35:16 -07005856os_spawnve_impl(PyObject *module, int mode, path_t *path, PyObject *argv,
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005857 PyObject *env)
Steve Dowercc16be82016-09-08 10:35:16 -07005858/*[clinic end generated code: output=30fe85be56fe37ad input=3e40803ee7c4c586]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005859{
Steve Dowercc16be82016-09-08 10:35:16 -07005860 EXECV_CHAR **argvlist;
5861 EXECV_CHAR **envlist;
Victor Stinner8c62be82010-05-06 00:08:46 +00005862 PyObject *res = NULL;
Antoine Pitrou22e41552010-08-15 18:07:50 +00005863 Py_ssize_t argc, i, envc;
Benjamin Petersonca470632016-09-06 13:47:26 -07005864 intptr_t spawnval;
Victor Stinner8c62be82010-05-06 00:08:46 +00005865 PyObject *(*getitem)(PyObject *, Py_ssize_t);
Victor Stinnerc8d6ab22017-06-23 15:04:46 +02005866 Py_ssize_t lastarg = 0;
Guido van Rossuma1065681999-01-25 23:20:23 +00005867
Victor Stinner8c62be82010-05-06 00:08:46 +00005868 /* spawnve has four arguments: (mode, path, argv, env), where
5869 argv is a list or tuple of strings and env is a dictionary
5870 like posix.environ. */
Guido van Rossuma1065681999-01-25 23:20:23 +00005871
Victor Stinner8c62be82010-05-06 00:08:46 +00005872 if (PyList_Check(argv)) {
5873 argc = PyList_Size(argv);
5874 getitem = PyList_GetItem;
5875 }
5876 else if (PyTuple_Check(argv)) {
5877 argc = PyTuple_Size(argv);
5878 getitem = PyTuple_GetItem;
5879 }
5880 else {
5881 PyErr_SetString(PyExc_TypeError,
5882 "spawnve() arg 2 must be a tuple or list");
5883 goto fail_0;
5884 }
Steve Dower859fd7b2016-11-19 18:53:19 -08005885 if (argc == 0) {
5886 PyErr_SetString(PyExc_ValueError,
5887 "spawnve() arg 2 cannot be empty");
5888 goto fail_0;
5889 }
Victor Stinner8c62be82010-05-06 00:08:46 +00005890 if (!PyMapping_Check(env)) {
5891 PyErr_SetString(PyExc_TypeError,
5892 "spawnve() arg 3 must be a mapping object");
5893 goto fail_0;
5894 }
Guido van Rossuma1065681999-01-25 23:20:23 +00005895
Steve Dowercc16be82016-09-08 10:35:16 -07005896 argvlist = PyMem_NEW(EXECV_CHAR *, argc+1);
Victor Stinner8c62be82010-05-06 00:08:46 +00005897 if (argvlist == NULL) {
5898 PyErr_NoMemory();
5899 goto fail_0;
5900 }
5901 for (i = 0; i < argc; i++) {
5902 if (!fsconvert_strdup((*getitem)(argv, i),
5903 &argvlist[i]))
5904 {
5905 lastarg = i;
5906 goto fail_1;
5907 }
Steve Dowerbce26262016-11-19 19:17:26 -08005908 if (i == 0 && !argvlist[0][0]) {
Victor Stinnerc8d6ab22017-06-23 15:04:46 +02005909 lastarg = i + 1;
Steve Dowerbce26262016-11-19 19:17:26 -08005910 PyErr_SetString(
5911 PyExc_ValueError,
5912 "spawnv() arg 2 first element cannot be empty");
5913 goto fail_1;
5914 }
Victor Stinner8c62be82010-05-06 00:08:46 +00005915 }
5916 lastarg = argc;
5917 argvlist[argc] = NULL;
Guido van Rossuma1065681999-01-25 23:20:23 +00005918
Victor Stinner8c62be82010-05-06 00:08:46 +00005919 envlist = parse_envlist(env, &envc);
5920 if (envlist == NULL)
5921 goto fail_1;
Guido van Rossuma1065681999-01-25 23:20:23 +00005922
pxinwrf2d7ac72019-05-21 18:46:37 +08005923#if !defined(HAVE_RTPSPAWN)
Victor Stinner8c62be82010-05-06 00:08:46 +00005924 if (mode == _OLD_P_OVERLAY)
5925 mode = _P_OVERLAY;
pxinwrf2d7ac72019-05-21 18:46:37 +08005926#endif
Tim Peters25059d32001-12-07 20:35:43 +00005927
Victor Stinner8c62be82010-05-06 00:08:46 +00005928 Py_BEGIN_ALLOW_THREADS
Steve Dower654a7bd2016-09-11 20:19:32 -07005929 _Py_BEGIN_SUPPRESS_IPH
Steve Dowercc16be82016-09-08 10:35:16 -07005930#ifdef HAVE_WSPAWNV
5931 spawnval = _wspawnve(mode, path->wide, argvlist, envlist);
pxinwrf2d7ac72019-05-21 18:46:37 +08005932#elif defined(HAVE_RTPSPAWN)
5933 spawnval = _rtp_spawn(mode, path->narrow, (const char **)argvlist,
5934 (const char **)envlist);
Steve Dowercc16be82016-09-08 10:35:16 -07005935#else
5936 spawnval = _spawnve(mode, path->narrow, argvlist, envlist);
5937#endif
Steve Dower654a7bd2016-09-11 20:19:32 -07005938 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00005939 Py_END_ALLOW_THREADS
Tim Peters25059d32001-12-07 20:35:43 +00005940
Victor Stinner8c62be82010-05-06 00:08:46 +00005941 if (spawnval == -1)
5942 (void) posix_error();
5943 else
Richard Oudkerkac0ad882013-06-05 23:29:30 +01005944 res = Py_BuildValue(_Py_PARSE_INTPTR, spawnval);
Guido van Rossuma1065681999-01-25 23:20:23 +00005945
Victor Stinner8c62be82010-05-06 00:08:46 +00005946 while (--envc >= 0)
5947 PyMem_DEL(envlist[envc]);
5948 PyMem_DEL(envlist);
Guido van Rossum0847c5c2002-12-13 18:36:22 +00005949 fail_1:
Victor Stinnerc8d6ab22017-06-23 15:04:46 +02005950 free_string_array(argvlist, lastarg);
Martin v. Löwis114619e2002-10-07 06:44:21 +00005951 fail_0:
Victor Stinner8c62be82010-05-06 00:08:46 +00005952 return res;
Guido van Rossuma1065681999-01-25 23:20:23 +00005953}
Andrew MacIntyre69e18c92004-04-04 07:11:43 +00005954
Guido van Rossuma1065681999-01-25 23:20:23 +00005955#endif /* HAVE_SPAWNV */
5956
5957
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005958#ifdef HAVE_FORK
Gregory P. Smith163468a2017-05-29 10:03:41 -07005959
5960/* Helper function to validate arguments.
5961 Returns 0 on success. non-zero on failure with a TypeError raised.
5962 If obj is non-NULL it must be callable. */
5963static int
5964check_null_or_callable(PyObject *obj, const char* obj_name)
5965{
5966 if (obj && !PyCallable_Check(obj)) {
5967 PyErr_Format(PyExc_TypeError, "'%s' must be callable, not %s",
5968 obj_name, Py_TYPE(obj)->tp_name);
5969 return -1;
5970 }
5971 return 0;
5972}
5973
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005974/*[clinic input]
5975os.register_at_fork
5976
Gregory P. Smith163468a2017-05-29 10:03:41 -07005977 *
5978 before: object=NULL
5979 A callable to be called in the parent before the fork() syscall.
5980 after_in_child: object=NULL
5981 A callable to be called in the child after fork().
5982 after_in_parent: object=NULL
5983 A callable to be called in the parent after fork().
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005984
Gregory P. Smith163468a2017-05-29 10:03:41 -07005985Register callables to be called when forking a new process.
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005986
Gregory P. Smith163468a2017-05-29 10:03:41 -07005987'before' callbacks are called in reverse order.
5988'after_in_child' and 'after_in_parent' callbacks are called in order.
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005989
5990[clinic start generated code]*/
5991
5992static PyObject *
Gregory P. Smith163468a2017-05-29 10:03:41 -07005993os_register_at_fork_impl(PyObject *module, PyObject *before,
5994 PyObject *after_in_child, PyObject *after_in_parent)
5995/*[clinic end generated code: output=5398ac75e8e97625 input=cd1187aa85d2312e]*/
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005996{
5997 PyInterpreterState *interp;
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005998
Gregory P. Smith163468a2017-05-29 10:03:41 -07005999 if (!before && !after_in_child && !after_in_parent) {
6000 PyErr_SetString(PyExc_TypeError, "At least one argument is required.");
6001 return NULL;
6002 }
6003 if (check_null_or_callable(before, "before") ||
6004 check_null_or_callable(after_in_child, "after_in_child") ||
6005 check_null_or_callable(after_in_parent, "after_in_parent")) {
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006006 return NULL;
6007 }
Victor Stinnercaba55b2018-08-03 15:33:52 +02006008 interp = _PyInterpreterState_Get();
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006009
Gregory P. Smith163468a2017-05-29 10:03:41 -07006010 if (register_at_forker(&interp->before_forkers, before)) {
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006011 return NULL;
6012 }
Gregory P. Smith163468a2017-05-29 10:03:41 -07006013 if (register_at_forker(&interp->after_forkers_child, after_in_child)) {
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006014 return NULL;
Gregory P. Smith163468a2017-05-29 10:03:41 -07006015 }
6016 if (register_at_forker(&interp->after_forkers_parent, after_in_parent)) {
6017 return NULL;
6018 }
6019 Py_RETURN_NONE;
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006020}
6021#endif /* HAVE_FORK */
6022
6023
Guido van Rossum2242f2f2001-04-11 20:58:20 +00006024#ifdef HAVE_FORK1
Larry Hastings2f936352014-08-05 14:04:04 +10006025/*[clinic input]
6026os.fork1
6027
6028Fork a child process with a single multiplexed (i.e., not bound) thread.
6029
6030Return 0 to child process and PID of child to parent process.
6031[clinic start generated code]*/
6032
Larry Hastings2f936352014-08-05 14:04:04 +10006033static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006034os_fork1_impl(PyObject *module)
6035/*[clinic end generated code: output=0de8e67ce2a310bc input=12db02167893926e]*/
Guido van Rossum2242f2f2001-04-11 20:58:20 +00006036{
Victor Stinner8c62be82010-05-06 00:08:46 +00006037 pid_t pid;
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006038
Eric Snow59032962018-09-14 14:17:20 -07006039 if (_PyInterpreterState_Get() != PyInterpreterState_Main()) {
6040 PyErr_SetString(PyExc_RuntimeError, "fork not supported for subinterpreters");
6041 return NULL;
6042 }
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006043 PyOS_BeforeFork();
Victor Stinner8c62be82010-05-06 00:08:46 +00006044 pid = fork1();
6045 if (pid == 0) {
6046 /* child: this clobbers and resets the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006047 PyOS_AfterFork_Child();
Victor Stinner8c62be82010-05-06 00:08:46 +00006048 } else {
6049 /* parent: release the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006050 PyOS_AfterFork_Parent();
Victor Stinner8c62be82010-05-06 00:08:46 +00006051 }
6052 if (pid == -1)
6053 return posix_error();
Victor Stinner8c62be82010-05-06 00:08:46 +00006054 return PyLong_FromPid(pid);
Guido van Rossum2242f2f2001-04-11 20:58:20 +00006055}
Larry Hastings2f936352014-08-05 14:04:04 +10006056#endif /* HAVE_FORK1 */
Guido van Rossum2242f2f2001-04-11 20:58:20 +00006057
6058
Guido van Rossumad0ee831995-03-01 10:34:45 +00006059#ifdef HAVE_FORK
Larry Hastings2f936352014-08-05 14:04:04 +10006060/*[clinic input]
6061os.fork
6062
6063Fork a child process.
6064
6065Return 0 to child process and PID of child to parent process.
6066[clinic start generated code]*/
6067
Larry Hastings2f936352014-08-05 14:04:04 +10006068static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006069os_fork_impl(PyObject *module)
6070/*[clinic end generated code: output=3626c81f98985d49 input=13c956413110eeaa]*/
Guido van Rossum85e3b011991-06-03 12:42:10 +00006071{
Victor Stinner8c62be82010-05-06 00:08:46 +00006072 pid_t pid;
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006073
Eric Snow59032962018-09-14 14:17:20 -07006074 if (_PyInterpreterState_Get() != PyInterpreterState_Main()) {
6075 PyErr_SetString(PyExc_RuntimeError, "fork not supported for subinterpreters");
6076 return NULL;
6077 }
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006078 PyOS_BeforeFork();
Victor Stinner8c62be82010-05-06 00:08:46 +00006079 pid = fork();
6080 if (pid == 0) {
6081 /* child: this clobbers and resets the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006082 PyOS_AfterFork_Child();
Victor Stinner8c62be82010-05-06 00:08:46 +00006083 } else {
6084 /* parent: release the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006085 PyOS_AfterFork_Parent();
Victor Stinner8c62be82010-05-06 00:08:46 +00006086 }
6087 if (pid == -1)
6088 return posix_error();
Victor Stinner8c62be82010-05-06 00:08:46 +00006089 return PyLong_FromPid(pid);
Guido van Rossum85e3b011991-06-03 12:42:10 +00006090}
Larry Hastings2f936352014-08-05 14:04:04 +10006091#endif /* HAVE_FORK */
6092
Guido van Rossum85e3b011991-06-03 12:42:10 +00006093
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006094#ifdef HAVE_SCHED_H
Charles-François Nataliea0d5fc2011-09-06 19:03:35 +02006095#ifdef HAVE_SCHED_GET_PRIORITY_MAX
Larry Hastings2f936352014-08-05 14:04:04 +10006096/*[clinic input]
6097os.sched_get_priority_max
Charles-François Nataliea0d5fc2011-09-06 19:03:35 +02006098
Larry Hastings2f936352014-08-05 14:04:04 +10006099 policy: int
6100
6101Get the maximum scheduling priority for policy.
6102[clinic start generated code]*/
6103
Larry Hastings2f936352014-08-05 14:04:04 +10006104static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006105os_sched_get_priority_max_impl(PyObject *module, int policy)
6106/*[clinic end generated code: output=9e465c6e43130521 input=2097b7998eca6874]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006107{
6108 int max;
6109
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006110 max = sched_get_priority_max(policy);
6111 if (max < 0)
6112 return posix_error();
6113 return PyLong_FromLong(max);
6114}
6115
Larry Hastings2f936352014-08-05 14:04:04 +10006116
6117/*[clinic input]
6118os.sched_get_priority_min
6119
6120 policy: int
6121
6122Get the minimum scheduling priority for policy.
6123[clinic start generated code]*/
6124
Larry Hastings2f936352014-08-05 14:04:04 +10006125static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006126os_sched_get_priority_min_impl(PyObject *module, int policy)
6127/*[clinic end generated code: output=7595c1138cc47a6d input=21bc8fa0d70983bf]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006128{
6129 int min = sched_get_priority_min(policy);
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006130 if (min < 0)
6131 return posix_error();
6132 return PyLong_FromLong(min);
6133}
Charles-François Nataliea0d5fc2011-09-06 19:03:35 +02006134#endif /* HAVE_SCHED_GET_PRIORITY_MAX */
6135
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006136
Larry Hastings2f936352014-08-05 14:04:04 +10006137#ifdef HAVE_SCHED_SETSCHEDULER
6138/*[clinic input]
6139os.sched_getscheduler
6140 pid: pid_t
6141 /
6142
6143Get the scheduling policy for the process identifiedy by pid.
6144
6145Passing 0 for pid returns the scheduling policy for the calling process.
6146[clinic start generated code]*/
6147
Larry Hastings2f936352014-08-05 14:04:04 +10006148static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006149os_sched_getscheduler_impl(PyObject *module, pid_t pid)
6150/*[clinic end generated code: output=dce4c0bd3f1b34c8 input=5f14cfd1f189e1a0]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006151{
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006152 int policy;
6153
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006154 policy = sched_getscheduler(pid);
6155 if (policy < 0)
6156 return posix_error();
6157 return PyLong_FromLong(policy);
6158}
Larry Hastings2f936352014-08-05 14:04:04 +10006159#endif /* HAVE_SCHED_SETSCHEDULER */
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006160
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006161
William Orr81574b82018-10-01 22:19:56 -07006162#if defined(HAVE_SCHED_SETPARAM) || defined(HAVE_SCHED_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDPARAM)
Larry Hastings2f936352014-08-05 14:04:04 +10006163/*[clinic input]
Eddie Elizondo474eedf2018-11-13 04:09:31 -08006164class os.sched_param "PyObject *" "SchedParamType"
Larry Hastings2f936352014-08-05 14:04:04 +10006165
6166@classmethod
6167os.sched_param.__new__
6168
6169 sched_priority: object
6170 A scheduling parameter.
6171
6172Current has only one field: sched_priority");
6173[clinic start generated code]*/
6174
Larry Hastings2f936352014-08-05 14:04:04 +10006175static PyObject *
6176os_sched_param_impl(PyTypeObject *type, PyObject *sched_priority)
Eddie Elizondo474eedf2018-11-13 04:09:31 -08006177/*[clinic end generated code: output=48f4067d60f48c13 input=ab4de35a9a7811f2]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006178{
6179 PyObject *res;
6180
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006181 res = PyStructSequence_New(type);
6182 if (!res)
6183 return NULL;
Larry Hastings2f936352014-08-05 14:04:04 +10006184 Py_INCREF(sched_priority);
6185 PyStructSequence_SET_ITEM(res, 0, sched_priority);
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006186 return res;
6187}
6188
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006189
Serhiy Storchaka1009bf12015-04-03 23:53:51 +03006190PyDoc_VAR(os_sched_param__doc__);
6191
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006192static PyStructSequence_Field sched_param_fields[] = {
6193 {"sched_priority", "the scheduling priority"},
6194 {0}
6195};
6196
6197static PyStructSequence_Desc sched_param_desc = {
6198 "sched_param", /* name */
Larry Hastings2f936352014-08-05 14:04:04 +10006199 os_sched_param__doc__, /* doc */
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006200 sched_param_fields,
6201 1
6202};
6203
6204static int
6205convert_sched_param(PyObject *param, struct sched_param *res)
6206{
6207 long priority;
6208
Eddie Elizondo474eedf2018-11-13 04:09:31 -08006209 if (Py_TYPE(param) != SchedParamType) {
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006210 PyErr_SetString(PyExc_TypeError, "must have a sched_param object");
6211 return 0;
6212 }
6213 priority = PyLong_AsLong(PyStructSequence_GET_ITEM(param, 0));
6214 if (priority == -1 && PyErr_Occurred())
6215 return 0;
6216 if (priority > INT_MAX || priority < INT_MIN) {
6217 PyErr_SetString(PyExc_OverflowError, "sched_priority out of range");
6218 return 0;
6219 }
6220 res->sched_priority = Py_SAFE_DOWNCAST(priority, long, int);
6221 return 1;
6222}
William Orr81574b82018-10-01 22:19:56 -07006223#endif /* defined(HAVE_SCHED_SETPARAM) || defined(HAVE_SCHED_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDPARAM) */
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006224
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006225
6226#ifdef HAVE_SCHED_SETSCHEDULER
Larry Hastings2f936352014-08-05 14:04:04 +10006227/*[clinic input]
6228os.sched_setscheduler
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006229
Larry Hastings2f936352014-08-05 14:04:04 +10006230 pid: pid_t
6231 policy: int
6232 param: sched_param
6233 /
6234
6235Set the scheduling policy for the process identified by pid.
6236
6237If pid is 0, the calling process is changed.
6238param is an instance of sched_param.
6239[clinic start generated code]*/
6240
Larry Hastings2f936352014-08-05 14:04:04 +10006241static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006242os_sched_setscheduler_impl(PyObject *module, pid_t pid, int policy,
Larry Hastings89964c42015-04-14 18:07:59 -04006243 struct sched_param *param)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006244/*[clinic end generated code: output=b0ac0a70d3b1d705 input=c581f9469a5327dd]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006245{
Jesus Cea9c822272011-09-10 01:40:52 +02006246 /*
Jesus Cea54b01492011-09-10 01:53:19 +02006247 ** sched_setscheduler() returns 0 in Linux, but the previous
6248 ** scheduling policy under Solaris/Illumos, and others.
6249 ** On error, -1 is returned in all Operating Systems.
Jesus Cea9c822272011-09-10 01:40:52 +02006250 */
Larry Hastings2f936352014-08-05 14:04:04 +10006251 if (sched_setscheduler(pid, policy, param) == -1)
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006252 return posix_error();
6253 Py_RETURN_NONE;
6254}
Larry Hastings2f936352014-08-05 14:04:04 +10006255#endif /* HAVE_SCHED_SETSCHEDULER*/
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006256
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006257
6258#ifdef HAVE_SCHED_SETPARAM
Larry Hastings2f936352014-08-05 14:04:04 +10006259/*[clinic input]
6260os.sched_getparam
6261 pid: pid_t
6262 /
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006263
Larry Hastings2f936352014-08-05 14:04:04 +10006264Returns scheduling parameters for the process identified by pid.
6265
6266If pid is 0, returns parameters for the calling process.
6267Return value is an instance of sched_param.
6268[clinic start generated code]*/
6269
Larry Hastings2f936352014-08-05 14:04:04 +10006270static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006271os_sched_getparam_impl(PyObject *module, pid_t pid)
6272/*[clinic end generated code: output=b194e8708dcf2db8 input=18a1ef9c2efae296]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006273{
6274 struct sched_param param;
6275 PyObject *result;
6276 PyObject *priority;
6277
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006278 if (sched_getparam(pid, &param))
6279 return posix_error();
Eddie Elizondo474eedf2018-11-13 04:09:31 -08006280 result = PyStructSequence_New(SchedParamType);
Larry Hastings2f936352014-08-05 14:04:04 +10006281 if (!result)
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006282 return NULL;
6283 priority = PyLong_FromLong(param.sched_priority);
6284 if (!priority) {
Larry Hastings2f936352014-08-05 14:04:04 +10006285 Py_DECREF(result);
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006286 return NULL;
6287 }
Larry Hastings2f936352014-08-05 14:04:04 +10006288 PyStructSequence_SET_ITEM(result, 0, priority);
6289 return result;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006290}
6291
Larry Hastings2f936352014-08-05 14:04:04 +10006292
6293/*[clinic input]
6294os.sched_setparam
6295 pid: pid_t
6296 param: sched_param
6297 /
6298
6299Set scheduling parameters for the process identified by pid.
6300
6301If pid is 0, sets parameters for the calling process.
6302param should be an instance of sched_param.
6303[clinic start generated code]*/
6304
Larry Hastings2f936352014-08-05 14:04:04 +10006305static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006306os_sched_setparam_impl(PyObject *module, pid_t pid,
Larry Hastings89964c42015-04-14 18:07:59 -04006307 struct sched_param *param)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006308/*[clinic end generated code: output=8af013f78a32b591 input=6b8d6dfcecdc21bd]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006309{
6310 if (sched_setparam(pid, param))
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006311 return posix_error();
6312 Py_RETURN_NONE;
6313}
Larry Hastings2f936352014-08-05 14:04:04 +10006314#endif /* HAVE_SCHED_SETPARAM */
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006315
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006316
6317#ifdef HAVE_SCHED_RR_GET_INTERVAL
Larry Hastings2f936352014-08-05 14:04:04 +10006318/*[clinic input]
6319os.sched_rr_get_interval -> double
6320 pid: pid_t
6321 /
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006322
Larry Hastings2f936352014-08-05 14:04:04 +10006323Return the round-robin quantum for the process identified by pid, in seconds.
6324
6325Value returned is a float.
6326[clinic start generated code]*/
6327
Larry Hastings2f936352014-08-05 14:04:04 +10006328static double
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006329os_sched_rr_get_interval_impl(PyObject *module, pid_t pid)
6330/*[clinic end generated code: output=7e2d935833ab47dc input=2a973da15cca6fae]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006331{
6332 struct timespec interval;
6333 if (sched_rr_get_interval(pid, &interval)) {
6334 posix_error();
6335 return -1.0;
6336 }
Gregory P. Smith1d300ce2018-12-30 21:13:02 -08006337#ifdef _Py_MEMORY_SANITIZER
6338 __msan_unpoison(&interval, sizeof(interval));
6339#endif
Larry Hastings2f936352014-08-05 14:04:04 +10006340 return (double)interval.tv_sec + 1e-9*interval.tv_nsec;
6341}
6342#endif /* HAVE_SCHED_RR_GET_INTERVAL */
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05006343
Larry Hastings2f936352014-08-05 14:04:04 +10006344
6345/*[clinic input]
6346os.sched_yield
6347
6348Voluntarily relinquish the CPU.
6349[clinic start generated code]*/
6350
Larry Hastings2f936352014-08-05 14:04:04 +10006351static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006352os_sched_yield_impl(PyObject *module)
6353/*[clinic end generated code: output=902323500f222cac input=e54d6f98189391d4]*/
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006354{
6355 if (sched_yield())
6356 return posix_error();
6357 Py_RETURN_NONE;
6358}
6359
Benjamin Peterson2740af82011-08-02 17:41:34 -05006360#ifdef HAVE_SCHED_SETAFFINITY
Antoine Pitrou84869872012-08-04 16:16:35 +02006361/* The minimum number of CPUs allocated in a cpu_set_t */
6362static const int NCPUS_START = sizeof(unsigned long) * CHAR_BIT;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006363
Larry Hastings2f936352014-08-05 14:04:04 +10006364/*[clinic input]
6365os.sched_setaffinity
6366 pid: pid_t
6367 mask : object
6368 /
6369
6370Set the CPU affinity of the process identified by pid to mask.
6371
6372mask should be an iterable of integers identifying CPUs.
6373[clinic start generated code]*/
6374
Larry Hastings2f936352014-08-05 14:04:04 +10006375static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006376os_sched_setaffinity_impl(PyObject *module, pid_t pid, PyObject *mask)
6377/*[clinic end generated code: output=882d7dd9a229335b input=a0791a597c7085ba]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006378{
Antoine Pitrou84869872012-08-04 16:16:35 +02006379 int ncpus;
6380 size_t setsize;
Larry Hastings2f936352014-08-05 14:04:04 +10006381 cpu_set_t *cpu_set = NULL;
6382 PyObject *iterator = NULL, *item;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006383
Larry Hastings2f936352014-08-05 14:04:04 +10006384 iterator = PyObject_GetIter(mask);
Antoine Pitrou84869872012-08-04 16:16:35 +02006385 if (iterator == NULL)
6386 return NULL;
6387
6388 ncpus = NCPUS_START;
6389 setsize = CPU_ALLOC_SIZE(ncpus);
Larry Hastings2f936352014-08-05 14:04:04 +10006390 cpu_set = CPU_ALLOC(ncpus);
6391 if (cpu_set == NULL) {
Antoine Pitrou84869872012-08-04 16:16:35 +02006392 PyErr_NoMemory();
6393 goto error;
6394 }
Larry Hastings2f936352014-08-05 14:04:04 +10006395 CPU_ZERO_S(setsize, cpu_set);
Antoine Pitrou84869872012-08-04 16:16:35 +02006396
6397 while ((item = PyIter_Next(iterator))) {
6398 long cpu;
6399 if (!PyLong_Check(item)) {
6400 PyErr_Format(PyExc_TypeError,
6401 "expected an iterator of ints, "
6402 "but iterator yielded %R",
6403 Py_TYPE(item));
6404 Py_DECREF(item);
6405 goto error;
6406 }
6407 cpu = PyLong_AsLong(item);
6408 Py_DECREF(item);
6409 if (cpu < 0) {
6410 if (!PyErr_Occurred())
6411 PyErr_SetString(PyExc_ValueError, "negative CPU number");
6412 goto error;
6413 }
6414 if (cpu > INT_MAX - 1) {
6415 PyErr_SetString(PyExc_OverflowError, "CPU number too large");
6416 goto error;
6417 }
6418 if (cpu >= ncpus) {
6419 /* Grow CPU mask to fit the CPU number */
6420 int newncpus = ncpus;
6421 cpu_set_t *newmask;
6422 size_t newsetsize;
6423 while (newncpus <= cpu) {
6424 if (newncpus > INT_MAX / 2)
6425 newncpus = cpu + 1;
6426 else
6427 newncpus = newncpus * 2;
6428 }
6429 newmask = CPU_ALLOC(newncpus);
6430 if (newmask == NULL) {
6431 PyErr_NoMemory();
6432 goto error;
6433 }
6434 newsetsize = CPU_ALLOC_SIZE(newncpus);
6435 CPU_ZERO_S(newsetsize, newmask);
Larry Hastings2f936352014-08-05 14:04:04 +10006436 memcpy(newmask, cpu_set, setsize);
6437 CPU_FREE(cpu_set);
Antoine Pitrou84869872012-08-04 16:16:35 +02006438 setsize = newsetsize;
Larry Hastings2f936352014-08-05 14:04:04 +10006439 cpu_set = newmask;
Antoine Pitrou84869872012-08-04 16:16:35 +02006440 ncpus = newncpus;
6441 }
Larry Hastings2f936352014-08-05 14:04:04 +10006442 CPU_SET_S(cpu, setsize, cpu_set);
Antoine Pitrou84869872012-08-04 16:16:35 +02006443 }
Miss Islington (bot)6fbed532019-06-27 09:45:30 -07006444 if (PyErr_Occurred()) {
6445 goto error;
6446 }
Antoine Pitrou84869872012-08-04 16:16:35 +02006447 Py_CLEAR(iterator);
6448
Larry Hastings2f936352014-08-05 14:04:04 +10006449 if (sched_setaffinity(pid, setsize, cpu_set)) {
Antoine Pitrou84869872012-08-04 16:16:35 +02006450 posix_error();
6451 goto error;
6452 }
Larry Hastings2f936352014-08-05 14:04:04 +10006453 CPU_FREE(cpu_set);
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006454 Py_RETURN_NONE;
Antoine Pitrou84869872012-08-04 16:16:35 +02006455
6456error:
Larry Hastings2f936352014-08-05 14:04:04 +10006457 if (cpu_set)
6458 CPU_FREE(cpu_set);
Antoine Pitrou84869872012-08-04 16:16:35 +02006459 Py_XDECREF(iterator);
6460 return NULL;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006461}
6462
Larry Hastings2f936352014-08-05 14:04:04 +10006463
6464/*[clinic input]
6465os.sched_getaffinity
6466 pid: pid_t
6467 /
6468
Charles-François Natalidc87e4b2015-07-13 21:01:39 +01006469Return the affinity of the process identified by pid (or the current process if zero).
Larry Hastings2f936352014-08-05 14:04:04 +10006470
6471The affinity is returned as a set of CPU identifiers.
6472[clinic start generated code]*/
6473
Larry Hastings2f936352014-08-05 14:04:04 +10006474static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006475os_sched_getaffinity_impl(PyObject *module, pid_t pid)
Serhiy Storchaka2954f832016-07-07 18:20:03 +03006476/*[clinic end generated code: output=f726f2c193c17a4f input=983ce7cb4a565980]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006477{
Antoine Pitrou84869872012-08-04 16:16:35 +02006478 int cpu, ncpus, count;
6479 size_t setsize;
6480 cpu_set_t *mask = NULL;
6481 PyObject *res = NULL;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006482
Antoine Pitrou84869872012-08-04 16:16:35 +02006483 ncpus = NCPUS_START;
6484 while (1) {
6485 setsize = CPU_ALLOC_SIZE(ncpus);
6486 mask = CPU_ALLOC(ncpus);
6487 if (mask == NULL)
6488 return PyErr_NoMemory();
6489 if (sched_getaffinity(pid, setsize, mask) == 0)
6490 break;
6491 CPU_FREE(mask);
6492 if (errno != EINVAL)
6493 return posix_error();
6494 if (ncpus > INT_MAX / 2) {
6495 PyErr_SetString(PyExc_OverflowError, "could not allocate "
6496 "a large enough CPU set");
6497 return NULL;
6498 }
6499 ncpus = ncpus * 2;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006500 }
Antoine Pitrou84869872012-08-04 16:16:35 +02006501
6502 res = PySet_New(NULL);
6503 if (res == NULL)
6504 goto error;
6505 for (cpu = 0, count = CPU_COUNT_S(setsize, mask); count; cpu++) {
6506 if (CPU_ISSET_S(cpu, setsize, mask)) {
6507 PyObject *cpu_num = PyLong_FromLong(cpu);
6508 --count;
6509 if (cpu_num == NULL)
6510 goto error;
6511 if (PySet_Add(res, cpu_num)) {
6512 Py_DECREF(cpu_num);
6513 goto error;
6514 }
6515 Py_DECREF(cpu_num);
6516 }
6517 }
6518 CPU_FREE(mask);
6519 return res;
6520
6521error:
6522 if (mask)
6523 CPU_FREE(mask);
6524 Py_XDECREF(res);
6525 return NULL;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006526}
6527
Benjamin Peterson2740af82011-08-02 17:41:34 -05006528#endif /* HAVE_SCHED_SETAFFINITY */
6529
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006530#endif /* HAVE_SCHED_H */
6531
Larry Hastings2f936352014-08-05 14:04:04 +10006532
Neal Norwitzb59798b2003-03-21 01:43:31 +00006533/* AIX uses /dev/ptc but is otherwise the same as /dev/ptmx */
Neal Norwitz2deaddb2003-03-21 03:08:31 +00006534/* IRIX has both /dev/ptc and /dev/ptmx, use ptmx */
6535#if defined(HAVE_DEV_PTC) && !defined(HAVE_DEV_PTMX)
Neal Norwitzb59798b2003-03-21 01:43:31 +00006536#define DEV_PTY_FILE "/dev/ptc"
6537#define HAVE_DEV_PTMX
6538#else
6539#define DEV_PTY_FILE "/dev/ptmx"
6540#endif
6541
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006542#if defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) || defined(HAVE_DEV_PTMX)
Fred Drake8cef4cf2000-06-28 16:40:38 +00006543#ifdef HAVE_PTY_H
6544#include <pty.h>
6545#else
6546#ifdef HAVE_LIBUTIL_H
6547#include <libutil.h>
Ronald Oussoren755740f2010-02-07 19:56:39 +00006548#else
6549#ifdef HAVE_UTIL_H
6550#include <util.h>
6551#endif /* HAVE_UTIL_H */
Fred Drake8cef4cf2000-06-28 16:40:38 +00006552#endif /* HAVE_LIBUTIL_H */
6553#endif /* HAVE_PTY_H */
Martin v. Löwis14e73b12003-01-01 09:51:12 +00006554#ifdef HAVE_STROPTS_H
6555#include <stropts.h>
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006556#endif
ngie-eign7745ec42018-02-14 11:54:28 -08006557#endif /* defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) || defined(HAVE_DEV_PTMX) */
Fred Drake8cef4cf2000-06-28 16:40:38 +00006558
Larry Hastings2f936352014-08-05 14:04:04 +10006559
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006560#if defined(HAVE_OPENPTY) || defined(HAVE__GETPTY) || defined(HAVE_DEV_PTMX)
Larry Hastings2f936352014-08-05 14:04:04 +10006561/*[clinic input]
6562os.openpty
6563
6564Open a pseudo-terminal.
6565
6566Return a tuple of (master_fd, slave_fd) containing open file descriptors
6567for both the master and slave ends.
6568[clinic start generated code]*/
6569
Larry Hastings2f936352014-08-05 14:04:04 +10006570static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006571os_openpty_impl(PyObject *module)
6572/*[clinic end generated code: output=98841ce5ec9cef3c input=f3d99fd99e762907]*/
Fred Drake8cef4cf2000-06-28 16:40:38 +00006573{
Victor Stinnerdaf45552013-08-28 00:53:59 +02006574 int master_fd = -1, slave_fd = -1;
Thomas Wouters70c21a12000-07-14 14:28:33 +00006575#ifndef HAVE_OPENPTY
Victor Stinner8c62be82010-05-06 00:08:46 +00006576 char * slave_name;
Thomas Wouters70c21a12000-07-14 14:28:33 +00006577#endif
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006578#if defined(HAVE_DEV_PTMX) && !defined(HAVE_OPENPTY) && !defined(HAVE__GETPTY)
Victor Stinner8c62be82010-05-06 00:08:46 +00006579 PyOS_sighandler_t sig_saved;
Jakub Kulík6f9bc722018-12-31 03:16:40 +01006580#if defined(__sun) && defined(__SVR4)
Victor Stinner8c62be82010-05-06 00:08:46 +00006581 extern char *ptsname(int fildes);
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006582#endif
6583#endif
Thomas Wouters70c21a12000-07-14 14:28:33 +00006584
Thomas Wouters70c21a12000-07-14 14:28:33 +00006585#ifdef HAVE_OPENPTY
Victor Stinner8c62be82010-05-06 00:08:46 +00006586 if (openpty(&master_fd, &slave_fd, NULL, NULL, NULL) != 0)
Victor Stinnerdaf45552013-08-28 00:53:59 +02006587 goto posix_error;
6588
6589 if (_Py_set_inheritable(master_fd, 0, NULL) < 0)
6590 goto error;
6591 if (_Py_set_inheritable(slave_fd, 0, NULL) < 0)
6592 goto error;
6593
Neal Norwitzb59798b2003-03-21 01:43:31 +00006594#elif defined(HAVE__GETPTY)
Victor Stinner8c62be82010-05-06 00:08:46 +00006595 slave_name = _getpty(&master_fd, O_RDWR, 0666, 0);
6596 if (slave_name == NULL)
Victor Stinnerdaf45552013-08-28 00:53:59 +02006597 goto posix_error;
6598 if (_Py_set_inheritable(master_fd, 0, NULL) < 0)
6599 goto error;
Thomas Wouters70c21a12000-07-14 14:28:33 +00006600
Victor Stinnerdaf45552013-08-28 00:53:59 +02006601 slave_fd = _Py_open(slave_name, O_RDWR);
Victor Stinner8c62be82010-05-06 00:08:46 +00006602 if (slave_fd < 0)
Victor Stinnera555cfc2015-03-18 00:22:14 +01006603 goto error;
Victor Stinnerdaf45552013-08-28 00:53:59 +02006604
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006605#else
Victor Stinner000de532013-11-25 23:19:58 +01006606 master_fd = open(DEV_PTY_FILE, O_RDWR | O_NOCTTY); /* open master */
Victor Stinner8c62be82010-05-06 00:08:46 +00006607 if (master_fd < 0)
Victor Stinnerdaf45552013-08-28 00:53:59 +02006608 goto posix_error;
6609
Victor Stinner8c62be82010-05-06 00:08:46 +00006610 sig_saved = PyOS_setsig(SIGCHLD, SIG_DFL);
Victor Stinnerdaf45552013-08-28 00:53:59 +02006611
Victor Stinner8c62be82010-05-06 00:08:46 +00006612 /* change permission of slave */
6613 if (grantpt(master_fd) < 0) {
6614 PyOS_setsig(SIGCHLD, sig_saved);
Victor Stinnerdaf45552013-08-28 00:53:59 +02006615 goto posix_error;
Victor Stinner8c62be82010-05-06 00:08:46 +00006616 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02006617
Victor Stinner8c62be82010-05-06 00:08:46 +00006618 /* unlock slave */
6619 if (unlockpt(master_fd) < 0) {
6620 PyOS_setsig(SIGCHLD, sig_saved);
Victor Stinnerdaf45552013-08-28 00:53:59 +02006621 goto posix_error;
Victor Stinner8c62be82010-05-06 00:08:46 +00006622 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02006623
Victor Stinner8c62be82010-05-06 00:08:46 +00006624 PyOS_setsig(SIGCHLD, sig_saved);
Victor Stinnerdaf45552013-08-28 00:53:59 +02006625
Victor Stinner8c62be82010-05-06 00:08:46 +00006626 slave_name = ptsname(master_fd); /* get name of slave */
6627 if (slave_name == NULL)
Victor Stinnerdaf45552013-08-28 00:53:59 +02006628 goto posix_error;
6629
6630 slave_fd = _Py_open(slave_name, O_RDWR | O_NOCTTY); /* open slave */
Victor Stinnera555cfc2015-03-18 00:22:14 +01006631 if (slave_fd == -1)
6632 goto error;
Victor Stinner000de532013-11-25 23:19:58 +01006633
6634 if (_Py_set_inheritable(master_fd, 0, NULL) < 0)
6635 goto posix_error;
6636
Stefan Krahfb7c8ae2016-04-26 17:04:18 +02006637#if !defined(__CYGWIN__) && !defined(__ANDROID__) && !defined(HAVE_DEV_PTC)
Victor Stinner8c62be82010-05-06 00:08:46 +00006638 ioctl(slave_fd, I_PUSH, "ptem"); /* push ptem */
6639 ioctl(slave_fd, I_PUSH, "ldterm"); /* push ldterm */
Neal Norwitz6700e472002-12-31 16:16:07 +00006640#ifndef __hpux
Victor Stinner8c62be82010-05-06 00:08:46 +00006641 ioctl(slave_fd, I_PUSH, "ttcompat"); /* push ttcompat */
Neal Norwitz6700e472002-12-31 16:16:07 +00006642#endif /* __hpux */
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006643#endif /* HAVE_CYGWIN */
Thomas Wouters1e0c2f42000-07-24 16:06:23 +00006644#endif /* HAVE_OPENPTY */
Thomas Wouters70c21a12000-07-14 14:28:33 +00006645
Victor Stinner8c62be82010-05-06 00:08:46 +00006646 return Py_BuildValue("(ii)", master_fd, slave_fd);
Thomas Wouters70c21a12000-07-14 14:28:33 +00006647
Victor Stinnerdaf45552013-08-28 00:53:59 +02006648posix_error:
6649 posix_error();
6650error:
6651 if (master_fd != -1)
6652 close(master_fd);
6653 if (slave_fd != -1)
6654 close(slave_fd);
6655 return NULL;
Fred Drake8cef4cf2000-06-28 16:40:38 +00006656}
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006657#endif /* defined(HAVE_OPENPTY) || defined(HAVE__GETPTY) || defined(HAVE_DEV_PTMX) */
Fred Drake8cef4cf2000-06-28 16:40:38 +00006658
Larry Hastings2f936352014-08-05 14:04:04 +10006659
Fred Drake8cef4cf2000-06-28 16:40:38 +00006660#ifdef HAVE_FORKPTY
Larry Hastings2f936352014-08-05 14:04:04 +10006661/*[clinic input]
6662os.forkpty
6663
6664Fork a new process with a new pseudo-terminal as controlling tty.
6665
6666Returns a tuple of (pid, master_fd).
6667Like fork(), return pid of 0 to the child process,
6668and pid of child to the parent process.
6669To both, return fd of newly opened pseudo-terminal.
6670[clinic start generated code]*/
6671
Larry Hastings2f936352014-08-05 14:04:04 +10006672static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006673os_forkpty_impl(PyObject *module)
6674/*[clinic end generated code: output=60d0a5c7512e4087 input=f1f7f4bae3966010]*/
Fred Drake8cef4cf2000-06-28 16:40:38 +00006675{
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006676 int master_fd = -1;
Victor Stinner8c62be82010-05-06 00:08:46 +00006677 pid_t pid;
Tim Peters5aa91602002-01-30 05:46:57 +00006678
Eric Snow59032962018-09-14 14:17:20 -07006679 if (_PyInterpreterState_Get() != PyInterpreterState_Main()) {
6680 PyErr_SetString(PyExc_RuntimeError, "fork not supported for subinterpreters");
6681 return NULL;
6682 }
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006683 PyOS_BeforeFork();
Victor Stinner8c62be82010-05-06 00:08:46 +00006684 pid = forkpty(&master_fd, NULL, NULL, NULL);
6685 if (pid == 0) {
6686 /* child: this clobbers and resets the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006687 PyOS_AfterFork_Child();
Victor Stinner8c62be82010-05-06 00:08:46 +00006688 } else {
6689 /* parent: release the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006690 PyOS_AfterFork_Parent();
Victor Stinner8c62be82010-05-06 00:08:46 +00006691 }
6692 if (pid == -1)
6693 return posix_error();
Victor Stinner8c62be82010-05-06 00:08:46 +00006694 return Py_BuildValue("(Ni)", PyLong_FromPid(pid), master_fd);
Fred Drake8cef4cf2000-06-28 16:40:38 +00006695}
Larry Hastings2f936352014-08-05 14:04:04 +10006696#endif /* HAVE_FORKPTY */
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006697
Ross Lagerwall7807c352011-03-17 20:20:30 +02006698
Guido van Rossumad0ee831995-03-01 10:34:45 +00006699#ifdef HAVE_GETEGID
Larry Hastings2f936352014-08-05 14:04:04 +10006700/*[clinic input]
6701os.getegid
6702
6703Return the current process's effective group id.
6704[clinic start generated code]*/
6705
Larry Hastings2f936352014-08-05 14:04:04 +10006706static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006707os_getegid_impl(PyObject *module)
6708/*[clinic end generated code: output=67d9be7ac68898a2 input=1596f79ad1107d5d]*/
Guido van Rossum46003ff1992-05-15 11:05:24 +00006709{
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006710 return _PyLong_FromGid(getegid());
Guido van Rossum46003ff1992-05-15 11:05:24 +00006711}
Larry Hastings2f936352014-08-05 14:04:04 +10006712#endif /* HAVE_GETEGID */
Guido van Rossum46003ff1992-05-15 11:05:24 +00006713
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006714
Guido van Rossumad0ee831995-03-01 10:34:45 +00006715#ifdef HAVE_GETEUID
Larry Hastings2f936352014-08-05 14:04:04 +10006716/*[clinic input]
6717os.geteuid
6718
6719Return the current process's effective user id.
6720[clinic start generated code]*/
6721
Larry Hastings2f936352014-08-05 14:04:04 +10006722static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006723os_geteuid_impl(PyObject *module)
6724/*[clinic end generated code: output=ea1b60f0d6abb66e input=4644c662d3bd9f19]*/
Guido van Rossum46003ff1992-05-15 11:05:24 +00006725{
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006726 return _PyLong_FromUid(geteuid());
Guido van Rossum46003ff1992-05-15 11:05:24 +00006727}
Larry Hastings2f936352014-08-05 14:04:04 +10006728#endif /* HAVE_GETEUID */
Guido van Rossum46003ff1992-05-15 11:05:24 +00006729
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006730
Guido van Rossumad0ee831995-03-01 10:34:45 +00006731#ifdef HAVE_GETGID
Larry Hastings2f936352014-08-05 14:04:04 +10006732/*[clinic input]
6733os.getgid
6734
6735Return the current process's group id.
6736[clinic start generated code]*/
6737
Larry Hastings2f936352014-08-05 14:04:04 +10006738static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006739os_getgid_impl(PyObject *module)
6740/*[clinic end generated code: output=4f28ebc9d3e5dfcf input=58796344cd87c0f6]*/
Guido van Rossum46003ff1992-05-15 11:05:24 +00006741{
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006742 return _PyLong_FromGid(getgid());
Guido van Rossum46003ff1992-05-15 11:05:24 +00006743}
Larry Hastings2f936352014-08-05 14:04:04 +10006744#endif /* HAVE_GETGID */
Guido van Rossum46003ff1992-05-15 11:05:24 +00006745
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006746
Berker Peksag39404992016-09-15 20:45:16 +03006747#ifdef HAVE_GETPID
Larry Hastings2f936352014-08-05 14:04:04 +10006748/*[clinic input]
6749os.getpid
6750
6751Return the current process id.
6752[clinic start generated code]*/
6753
Larry Hastings2f936352014-08-05 14:04:04 +10006754static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006755os_getpid_impl(PyObject *module)
6756/*[clinic end generated code: output=9ea6fdac01ed2b3c input=5a9a00f0ab68aa00]*/
Guido van Rossum85e3b011991-06-03 12:42:10 +00006757{
Victor Stinner8c62be82010-05-06 00:08:46 +00006758 return PyLong_FromPid(getpid());
Guido van Rossum85e3b011991-06-03 12:42:10 +00006759}
Berker Peksag39404992016-09-15 20:45:16 +03006760#endif /* HAVE_GETPID */
Guido van Rossum85e3b011991-06-03 12:42:10 +00006761
Miss Islington (bot)c80183e2019-06-13 00:27:23 -07006762#ifdef NGROUPS_MAX
6763#define MAX_GROUPS NGROUPS_MAX
6764#else
6765 /* defined to be 16 on Solaris7, so this should be a small number */
6766#define MAX_GROUPS 64
6767#endif
6768
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006769#ifdef HAVE_GETGROUPLIST
Larry Hastings2f936352014-08-05 14:04:04 +10006770
6771/* AC 3.5: funny apple logic below */
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006772PyDoc_STRVAR(posix_getgrouplist__doc__,
6773"getgrouplist(user, group) -> list of groups to which a user belongs\n\n\
6774Returns a list of groups to which a user belongs.\n\n\
6775 user: username to lookup\n\
6776 group: base group id of the user");
6777
6778static PyObject *
6779posix_getgrouplist(PyObject *self, PyObject *args)
6780{
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006781 const char *user;
6782 int i, ngroups;
6783 PyObject *list;
6784#ifdef __APPLE__
6785 int *groups, basegid;
6786#else
6787 gid_t *groups, basegid;
6788#endif
Miss Islington (bot)c80183e2019-06-13 00:27:23 -07006789
6790 /*
6791 * NGROUPS_MAX is defined by POSIX.1 as the maximum
6792 * number of supplimental groups a users can belong to.
6793 * We have to increment it by one because
6794 * getgrouplist() returns both the supplemental groups
6795 * and the primary group, i.e. all of the groups the
6796 * user belongs to.
6797 */
6798 ngroups = 1 + MAX_GROUPS;
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006799
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006800#ifdef __APPLE__
6801 if (!PyArg_ParseTuple(args, "si:getgrouplist", &user, &basegid))
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006802 return NULL;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006803#else
6804 if (!PyArg_ParseTuple(args, "sO&:getgrouplist", &user,
6805 _Py_Gid_Converter, &basegid))
6806 return NULL;
6807#endif
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006808
6809#ifdef __APPLE__
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02006810 groups = PyMem_New(int, ngroups);
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006811#else
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02006812 groups = PyMem_New(gid_t, ngroups);
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006813#endif
6814 if (groups == NULL)
6815 return PyErr_NoMemory();
6816
6817 if (getgrouplist(user, basegid, groups, &ngroups) == -1) {
6818 PyMem_Del(groups);
6819 return posix_error();
6820 }
6821
Gregory P. Smith1d300ce2018-12-30 21:13:02 -08006822#ifdef _Py_MEMORY_SANITIZER
6823 /* Clang memory sanitizer libc intercepts don't know getgrouplist. */
6824 __msan_unpoison(&ngroups, sizeof(ngroups));
6825 __msan_unpoison(groups, ngroups*sizeof(*groups));
6826#endif
6827
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006828 list = PyList_New(ngroups);
6829 if (list == NULL) {
6830 PyMem_Del(groups);
6831 return NULL;
6832 }
6833
6834 for (i = 0; i < ngroups; i++) {
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006835#ifdef __APPLE__
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006836 PyObject *o = PyLong_FromUnsignedLong((unsigned long)groups[i]);
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006837#else
6838 PyObject *o = _PyLong_FromGid(groups[i]);
6839#endif
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006840 if (o == NULL) {
6841 Py_DECREF(list);
6842 PyMem_Del(groups);
6843 return NULL;
6844 }
6845 PyList_SET_ITEM(list, i, o);
6846 }
6847
6848 PyMem_Del(groups);
6849
6850 return list;
6851}
Larry Hastings2f936352014-08-05 14:04:04 +10006852#endif /* HAVE_GETGROUPLIST */
6853
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006854
Fred Drakec9680921999-12-13 16:37:25 +00006855#ifdef HAVE_GETGROUPS
Larry Hastings2f936352014-08-05 14:04:04 +10006856/*[clinic input]
6857os.getgroups
6858
6859Return list of supplemental group IDs for the process.
6860[clinic start generated code]*/
6861
Larry Hastings2f936352014-08-05 14:04:04 +10006862static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006863os_getgroups_impl(PyObject *module)
6864/*[clinic end generated code: output=42b0c17758561b56 input=d3f109412e6a155c]*/
Fred Drakec9680921999-12-13 16:37:25 +00006865{
6866 PyObject *result = NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00006867 gid_t grouplist[MAX_GROUPS];
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00006868
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00006869 /* On MacOSX getgroups(2) can return more than MAX_GROUPS results
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00006870 * This is a helper variable to store the intermediate result when
6871 * that happens.
6872 *
6873 * To keep the code readable the OSX behaviour is unconditional,
6874 * according to the POSIX spec this should be safe on all unix-y
6875 * systems.
6876 */
6877 gid_t* alt_grouplist = grouplist;
Victor Stinner8c62be82010-05-06 00:08:46 +00006878 int n;
Fred Drakec9680921999-12-13 16:37:25 +00006879
Ned Deilyb5dd6d22013-08-01 21:21:15 -07006880#ifdef __APPLE__
6881 /* Issue #17557: As of OS X 10.8, getgroups(2) no longer raises EINVAL if
6882 * there are more groups than can fit in grouplist. Therefore, on OS X
6883 * always first call getgroups with length 0 to get the actual number
6884 * of groups.
6885 */
6886 n = getgroups(0, NULL);
6887 if (n < 0) {
6888 return posix_error();
6889 } else if (n <= MAX_GROUPS) {
6890 /* groups will fit in existing array */
6891 alt_grouplist = grouplist;
6892 } else {
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02006893 alt_grouplist = PyMem_New(gid_t, n);
Ned Deilyb5dd6d22013-08-01 21:21:15 -07006894 if (alt_grouplist == NULL) {
Zackery Spytz4c49da02018-12-07 03:11:30 -07006895 return PyErr_NoMemory();
Ned Deilyb5dd6d22013-08-01 21:21:15 -07006896 }
6897 }
6898
6899 n = getgroups(n, alt_grouplist);
6900 if (n == -1) {
6901 if (alt_grouplist != grouplist) {
6902 PyMem_Free(alt_grouplist);
6903 }
6904 return posix_error();
6905 }
6906#else
Victor Stinner8c62be82010-05-06 00:08:46 +00006907 n = getgroups(MAX_GROUPS, grouplist);
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00006908 if (n < 0) {
6909 if (errno == EINVAL) {
6910 n = getgroups(0, NULL);
6911 if (n == -1) {
6912 return posix_error();
6913 }
6914 if (n == 0) {
6915 /* Avoid malloc(0) */
6916 alt_grouplist = grouplist;
6917 } else {
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02006918 alt_grouplist = PyMem_New(gid_t, n);
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00006919 if (alt_grouplist == NULL) {
Zackery Spytz4c49da02018-12-07 03:11:30 -07006920 return PyErr_NoMemory();
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00006921 }
6922 n = getgroups(n, alt_grouplist);
6923 if (n == -1) {
6924 PyMem_Free(alt_grouplist);
6925 return posix_error();
6926 }
6927 }
6928 } else {
6929 return posix_error();
6930 }
6931 }
Ned Deilyb5dd6d22013-08-01 21:21:15 -07006932#endif
6933
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00006934 result = PyList_New(n);
6935 if (result != NULL) {
Victor Stinner8c62be82010-05-06 00:08:46 +00006936 int i;
6937 for (i = 0; i < n; ++i) {
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006938 PyObject *o = _PyLong_FromGid(alt_grouplist[i]);
Victor Stinner8c62be82010-05-06 00:08:46 +00006939 if (o == NULL) {
Stefan Krah0e803b32010-11-26 16:16:47 +00006940 Py_DECREF(result);
6941 result = NULL;
6942 break;
Fred Drakec9680921999-12-13 16:37:25 +00006943 }
Victor Stinner8c62be82010-05-06 00:08:46 +00006944 PyList_SET_ITEM(result, i, o);
Fred Drakec9680921999-12-13 16:37:25 +00006945 }
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00006946 }
6947
6948 if (alt_grouplist != grouplist) {
6949 PyMem_Free(alt_grouplist);
Victor Stinner8c62be82010-05-06 00:08:46 +00006950 }
Neal Norwitze241ce82003-02-17 18:17:05 +00006951
Fred Drakec9680921999-12-13 16:37:25 +00006952 return result;
6953}
Larry Hastings2f936352014-08-05 14:04:04 +10006954#endif /* HAVE_GETGROUPS */
Fred Drakec9680921999-12-13 16:37:25 +00006955
Antoine Pitroub7572f02009-12-02 20:46:48 +00006956#ifdef HAVE_INITGROUPS
6957PyDoc_STRVAR(posix_initgroups__doc__,
6958"initgroups(username, gid) -> None\n\n\
6959Call the system initgroups() to initialize the group access list with all of\n\
6960the groups of which the specified username is a member, plus the specified\n\
6961group id.");
6962
Larry Hastings2f936352014-08-05 14:04:04 +10006963/* AC 3.5: funny apple logic */
Antoine Pitroub7572f02009-12-02 20:46:48 +00006964static PyObject *
6965posix_initgroups(PyObject *self, PyObject *args)
6966{
Victor Stinner61ec5dc2010-08-15 09:22:44 +00006967 PyObject *oname;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03006968 const char *username;
Victor Stinner61ec5dc2010-08-15 09:22:44 +00006969 int res;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006970#ifdef __APPLE__
6971 int gid;
6972#else
6973 gid_t gid;
6974#endif
Antoine Pitroub7572f02009-12-02 20:46:48 +00006975
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006976#ifdef __APPLE__
6977 if (!PyArg_ParseTuple(args, "O&i:initgroups",
6978 PyUnicode_FSConverter, &oname,
6979 &gid))
6980#else
6981 if (!PyArg_ParseTuple(args, "O&O&:initgroups",
6982 PyUnicode_FSConverter, &oname,
6983 _Py_Gid_Converter, &gid))
6984#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00006985 return NULL;
Victor Stinner61ec5dc2010-08-15 09:22:44 +00006986 username = PyBytes_AS_STRING(oname);
Antoine Pitroub7572f02009-12-02 20:46:48 +00006987
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006988 res = initgroups(username, gid);
Victor Stinner61ec5dc2010-08-15 09:22:44 +00006989 Py_DECREF(oname);
6990 if (res == -1)
Victor Stinner8c62be82010-05-06 00:08:46 +00006991 return PyErr_SetFromErrno(PyExc_OSError);
Antoine Pitroub7572f02009-12-02 20:46:48 +00006992
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02006993 Py_RETURN_NONE;
Antoine Pitroub7572f02009-12-02 20:46:48 +00006994}
Larry Hastings2f936352014-08-05 14:04:04 +10006995#endif /* HAVE_INITGROUPS */
6996
Antoine Pitroub7572f02009-12-02 20:46:48 +00006997
Martin v. Löwis606edc12002-06-13 21:09:11 +00006998#ifdef HAVE_GETPGID
Larry Hastings2f936352014-08-05 14:04:04 +10006999/*[clinic input]
7000os.getpgid
7001
7002 pid: pid_t
7003
7004Call the system call getpgid(), and return the result.
7005[clinic start generated code]*/
7006
Larry Hastings2f936352014-08-05 14:04:04 +10007007static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007008os_getpgid_impl(PyObject *module, pid_t pid)
7009/*[clinic end generated code: output=1db95a97be205d18 input=39d710ae3baaf1c7]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007010{
7011 pid_t pgid = getpgid(pid);
Victor Stinner8c62be82010-05-06 00:08:46 +00007012 if (pgid < 0)
7013 return posix_error();
7014 return PyLong_FromPid(pgid);
Martin v. Löwis606edc12002-06-13 21:09:11 +00007015}
7016#endif /* HAVE_GETPGID */
7017
7018
Guido van Rossumb6775db1994-08-01 11:34:53 +00007019#ifdef HAVE_GETPGRP
Larry Hastings2f936352014-08-05 14:04:04 +10007020/*[clinic input]
7021os.getpgrp
7022
7023Return the current process group id.
7024[clinic start generated code]*/
7025
Larry Hastings2f936352014-08-05 14:04:04 +10007026static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007027os_getpgrp_impl(PyObject *module)
7028/*[clinic end generated code: output=c4fc381e51103cf3 input=6846fb2bb9a3705e]*/
Guido van Rossum04814471991-06-04 20:23:49 +00007029{
Guido van Rossumb6775db1994-08-01 11:34:53 +00007030#ifdef GETPGRP_HAVE_ARG
Victor Stinner8c62be82010-05-06 00:08:46 +00007031 return PyLong_FromPid(getpgrp(0));
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00007032#else /* GETPGRP_HAVE_ARG */
Victor Stinner8c62be82010-05-06 00:08:46 +00007033 return PyLong_FromPid(getpgrp());
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00007034#endif /* GETPGRP_HAVE_ARG */
Guido van Rossum04814471991-06-04 20:23:49 +00007035}
Guido van Rossumb6775db1994-08-01 11:34:53 +00007036#endif /* HAVE_GETPGRP */
Guido van Rossum04814471991-06-04 20:23:49 +00007037
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007038
Guido van Rossumb6775db1994-08-01 11:34:53 +00007039#ifdef HAVE_SETPGRP
Larry Hastings2f936352014-08-05 14:04:04 +10007040/*[clinic input]
7041os.setpgrp
7042
7043Make the current process the leader of its process group.
7044[clinic start generated code]*/
7045
Larry Hastings2f936352014-08-05 14:04:04 +10007046static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007047os_setpgrp_impl(PyObject *module)
7048/*[clinic end generated code: output=2554735b0a60f0a0 input=1f0619fcb5731e7e]*/
Guido van Rossumc2670a01992-09-13 20:07:29 +00007049{
Guido van Rossum64933891994-10-20 21:56:42 +00007050#ifdef SETPGRP_HAVE_ARG
Victor Stinner8c62be82010-05-06 00:08:46 +00007051 if (setpgrp(0, 0) < 0)
Guido van Rossum64933891994-10-20 21:56:42 +00007052#else /* SETPGRP_HAVE_ARG */
Victor Stinner8c62be82010-05-06 00:08:46 +00007053 if (setpgrp() < 0)
Guido van Rossum64933891994-10-20 21:56:42 +00007054#endif /* SETPGRP_HAVE_ARG */
Victor Stinner8c62be82010-05-06 00:08:46 +00007055 return posix_error();
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02007056 Py_RETURN_NONE;
Guido van Rossumc2670a01992-09-13 20:07:29 +00007057}
Guido van Rossumb6775db1994-08-01 11:34:53 +00007058#endif /* HAVE_SETPGRP */
7059
Guido van Rossumad0ee831995-03-01 10:34:45 +00007060#ifdef HAVE_GETPPID
Amaury Forgeot d'Arc4b6fdf32010-09-07 21:31:17 +00007061
7062#ifdef MS_WINDOWS
7063#include <tlhelp32.h>
7064
7065static PyObject*
7066win32_getppid()
7067{
7068 HANDLE snapshot;
7069 pid_t mypid;
7070 PyObject* result = NULL;
7071 BOOL have_record;
7072 PROCESSENTRY32 pe;
7073
7074 mypid = getpid(); /* This function never fails */
7075
7076 snapshot = CreateToolhelp32Snapshot(TH32CS_SNAPPROCESS, 0);
7077 if (snapshot == INVALID_HANDLE_VALUE)
7078 return PyErr_SetFromWindowsErr(GetLastError());
7079
7080 pe.dwSize = sizeof(pe);
7081 have_record = Process32First(snapshot, &pe);
7082 while (have_record) {
7083 if (mypid == (pid_t)pe.th32ProcessID) {
7084 /* We could cache the ulong value in a static variable. */
7085 result = PyLong_FromPid((pid_t)pe.th32ParentProcessID);
7086 break;
7087 }
7088
7089 have_record = Process32Next(snapshot, &pe);
7090 }
7091
7092 /* If our loop exits and our pid was not found (result will be NULL)
7093 * then GetLastError will return ERROR_NO_MORE_FILES. This is an
7094 * error anyway, so let's raise it. */
7095 if (!result)
7096 result = PyErr_SetFromWindowsErr(GetLastError());
7097
7098 CloseHandle(snapshot);
7099
7100 return result;
7101}
7102#endif /*MS_WINDOWS*/
7103
Larry Hastings2f936352014-08-05 14:04:04 +10007104
7105/*[clinic input]
7106os.getppid
7107
7108Return the parent's process id.
7109
7110If the parent process has already exited, Windows machines will still
7111return its id; others systems will return the id of the 'init' process (1).
7112[clinic start generated code]*/
7113
Larry Hastings2f936352014-08-05 14:04:04 +10007114static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007115os_getppid_impl(PyObject *module)
7116/*[clinic end generated code: output=43b2a946a8c603b4 input=e637cb87539c030e]*/
Guido van Rossum85e3b011991-06-03 12:42:10 +00007117{
Amaury Forgeot d'Arc4b6fdf32010-09-07 21:31:17 +00007118#ifdef MS_WINDOWS
7119 return win32_getppid();
7120#else
Victor Stinner8c62be82010-05-06 00:08:46 +00007121 return PyLong_FromPid(getppid());
Guido van Rossumad0ee831995-03-01 10:34:45 +00007122#endif
Amaury Forgeot d'Arc4b6fdf32010-09-07 21:31:17 +00007123}
7124#endif /* HAVE_GETPPID */
Guido van Rossum85e3b011991-06-03 12:42:10 +00007125
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007126
Fred Drake12c6e2d1999-12-14 21:25:03 +00007127#ifdef HAVE_GETLOGIN
Larry Hastings2f936352014-08-05 14:04:04 +10007128/*[clinic input]
7129os.getlogin
7130
7131Return the actual login name.
7132[clinic start generated code]*/
7133
Larry Hastings2f936352014-08-05 14:04:04 +10007134static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007135os_getlogin_impl(PyObject *module)
7136/*[clinic end generated code: output=a32e66a7e5715dac input=2a21ab1e917163df]*/
Fred Drake12c6e2d1999-12-14 21:25:03 +00007137{
Victor Stinner8c62be82010-05-06 00:08:46 +00007138 PyObject *result = NULL;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00007139#ifdef MS_WINDOWS
Brian Curtine8e4b3b2010-09-23 20:04:14 +00007140 wchar_t user_name[UNLEN + 1];
Victor Stinner63941882011-09-29 00:42:28 +02007141 DWORD num_chars = Py_ARRAY_LENGTH(user_name);
Brian Curtine8e4b3b2010-09-23 20:04:14 +00007142
7143 if (GetUserNameW(user_name, &num_chars)) {
7144 /* num_chars is the number of unicode chars plus null terminator */
7145 result = PyUnicode_FromWideChar(user_name, num_chars - 1);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00007146 }
7147 else
Brian Curtine8e4b3b2010-09-23 20:04:14 +00007148 result = PyErr_SetFromWindowsErr(GetLastError());
7149#else
Victor Stinner8c62be82010-05-06 00:08:46 +00007150 char *name;
7151 int old_errno = errno;
Fred Drake12c6e2d1999-12-14 21:25:03 +00007152
Victor Stinner8c62be82010-05-06 00:08:46 +00007153 errno = 0;
7154 name = getlogin();
7155 if (name == NULL) {
7156 if (errno)
Victor Stinnere039ffe2010-08-15 09:33:08 +00007157 posix_error();
Fred Drake12c6e2d1999-12-14 21:25:03 +00007158 else
Victor Stinnere039ffe2010-08-15 09:33:08 +00007159 PyErr_SetString(PyExc_OSError, "unable to determine login name");
Victor Stinner8c62be82010-05-06 00:08:46 +00007160 }
7161 else
Victor Stinnere039ffe2010-08-15 09:33:08 +00007162 result = PyUnicode_DecodeFSDefault(name);
Victor Stinner8c62be82010-05-06 00:08:46 +00007163 errno = old_errno;
Brian Curtine8e4b3b2010-09-23 20:04:14 +00007164#endif
Fred Drake12c6e2d1999-12-14 21:25:03 +00007165 return result;
7166}
Brian Curtine8e4b3b2010-09-23 20:04:14 +00007167#endif /* HAVE_GETLOGIN */
Fred Drake12c6e2d1999-12-14 21:25:03 +00007168
Larry Hastings2f936352014-08-05 14:04:04 +10007169
Guido van Rossumad0ee831995-03-01 10:34:45 +00007170#ifdef HAVE_GETUID
Larry Hastings2f936352014-08-05 14:04:04 +10007171/*[clinic input]
7172os.getuid
7173
7174Return the current process's user id.
7175[clinic start generated code]*/
7176
Larry Hastings2f936352014-08-05 14:04:04 +10007177static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007178os_getuid_impl(PyObject *module)
7179/*[clinic end generated code: output=415c0b401ebed11a input=b53c8b35f110a516]*/
Guido van Rossum46003ff1992-05-15 11:05:24 +00007180{
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02007181 return _PyLong_FromUid(getuid());
Guido van Rossum46003ff1992-05-15 11:05:24 +00007182}
Larry Hastings2f936352014-08-05 14:04:04 +10007183#endif /* HAVE_GETUID */
Guido van Rossum46003ff1992-05-15 11:05:24 +00007184
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007185
Brian Curtineb24d742010-04-12 17:16:38 +00007186#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10007187#define HAVE_KILL
7188#endif /* MS_WINDOWS */
7189
7190#ifdef HAVE_KILL
7191/*[clinic input]
7192os.kill
7193
7194 pid: pid_t
7195 signal: Py_ssize_t
7196 /
7197
7198Kill a process with a signal.
7199[clinic start generated code]*/
7200
Larry Hastings2f936352014-08-05 14:04:04 +10007201static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007202os_kill_impl(PyObject *module, pid_t pid, Py_ssize_t signal)
7203/*[clinic end generated code: output=8e346a6701c88568 input=61a36b86ca275ab9]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007204#ifndef MS_WINDOWS
7205{
7206 if (kill(pid, (int)signal) == -1)
7207 return posix_error();
7208 Py_RETURN_NONE;
7209}
7210#else /* !MS_WINDOWS */
Brian Curtineb24d742010-04-12 17:16:38 +00007211{
Amaury Forgeot d'Arc0a589c92010-05-15 20:35:12 +00007212 PyObject *result;
Larry Hastings2f936352014-08-05 14:04:04 +10007213 DWORD sig = (DWORD)signal;
7214 DWORD err;
Victor Stinner8c62be82010-05-06 00:08:46 +00007215 HANDLE handle;
Brian Curtineb24d742010-04-12 17:16:38 +00007216
Victor Stinner8c62be82010-05-06 00:08:46 +00007217 /* Console processes which share a common console can be sent CTRL+C or
7218 CTRL+BREAK events, provided they handle said events. */
7219 if (sig == CTRL_C_EVENT || sig == CTRL_BREAK_EVENT) {
Richard Oudkerkac0ad882013-06-05 23:29:30 +01007220 if (GenerateConsoleCtrlEvent(sig, (DWORD)pid) == 0) {
Victor Stinner8c62be82010-05-06 00:08:46 +00007221 err = GetLastError();
7222 PyErr_SetFromWindowsErr(err);
7223 }
7224 else
7225 Py_RETURN_NONE;
7226 }
Brian Curtineb24d742010-04-12 17:16:38 +00007227
Victor Stinner8c62be82010-05-06 00:08:46 +00007228 /* If the signal is outside of what GenerateConsoleCtrlEvent can use,
7229 attempt to open and terminate the process. */
Richard Oudkerkac0ad882013-06-05 23:29:30 +01007230 handle = OpenProcess(PROCESS_ALL_ACCESS, FALSE, (DWORD)pid);
Victor Stinner8c62be82010-05-06 00:08:46 +00007231 if (handle == NULL) {
7232 err = GetLastError();
7233 return PyErr_SetFromWindowsErr(err);
7234 }
Brian Curtineb24d742010-04-12 17:16:38 +00007235
Victor Stinner8c62be82010-05-06 00:08:46 +00007236 if (TerminateProcess(handle, sig) == 0) {
7237 err = GetLastError();
7238 result = PyErr_SetFromWindowsErr(err);
7239 } else {
7240 Py_INCREF(Py_None);
7241 result = Py_None;
7242 }
Brian Curtineb24d742010-04-12 17:16:38 +00007243
Victor Stinner8c62be82010-05-06 00:08:46 +00007244 CloseHandle(handle);
7245 return result;
Brian Curtineb24d742010-04-12 17:16:38 +00007246}
Larry Hastings2f936352014-08-05 14:04:04 +10007247#endif /* !MS_WINDOWS */
7248#endif /* HAVE_KILL */
7249
7250
7251#ifdef HAVE_KILLPG
7252/*[clinic input]
7253os.killpg
7254
7255 pgid: pid_t
7256 signal: int
7257 /
7258
7259Kill a process group with a signal.
7260[clinic start generated code]*/
7261
Larry Hastings2f936352014-08-05 14:04:04 +10007262static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007263os_killpg_impl(PyObject *module, pid_t pgid, int signal)
7264/*[clinic end generated code: output=6dbcd2f1fdf5fdba input=38b5449eb8faec19]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007265{
7266 /* XXX some man pages make the `pgid` parameter an int, others
7267 a pid_t. Since getpgrp() returns a pid_t, we assume killpg should
7268 take the same type. Moreover, pid_t is always at least as wide as
7269 int (else compilation of this module fails), which is safe. */
7270 if (killpg(pgid, signal) == -1)
7271 return posix_error();
7272 Py_RETURN_NONE;
7273}
7274#endif /* HAVE_KILLPG */
7275
Brian Curtineb24d742010-04-12 17:16:38 +00007276
Guido van Rossumc0125471996-06-28 18:55:32 +00007277#ifdef HAVE_PLOCK
Guido van Rossumc0125471996-06-28 18:55:32 +00007278#ifdef HAVE_SYS_LOCK_H
7279#include <sys/lock.h>
7280#endif
7281
Larry Hastings2f936352014-08-05 14:04:04 +10007282/*[clinic input]
7283os.plock
7284 op: int
7285 /
7286
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00007287Lock program segments into memory.");
Larry Hastings2f936352014-08-05 14:04:04 +10007288[clinic start generated code]*/
7289
Larry Hastings2f936352014-08-05 14:04:04 +10007290static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007291os_plock_impl(PyObject *module, int op)
7292/*[clinic end generated code: output=81424167033b168e input=e6e5e348e1525f60]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007293{
Victor Stinner8c62be82010-05-06 00:08:46 +00007294 if (plock(op) == -1)
7295 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007296 Py_RETURN_NONE;
Guido van Rossumc0125471996-06-28 18:55:32 +00007297}
Larry Hastings2f936352014-08-05 14:04:04 +10007298#endif /* HAVE_PLOCK */
7299
Guido van Rossumc0125471996-06-28 18:55:32 +00007300
Guido van Rossumb6775db1994-08-01 11:34:53 +00007301#ifdef HAVE_SETUID
Larry Hastings2f936352014-08-05 14:04:04 +10007302/*[clinic input]
7303os.setuid
7304
7305 uid: uid_t
7306 /
7307
7308Set the current process's user id.
7309[clinic start generated code]*/
7310
Larry Hastings2f936352014-08-05 14:04:04 +10007311static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007312os_setuid_impl(PyObject *module, uid_t uid)
7313/*[clinic end generated code: output=a0a41fd0d1ec555f input=c921a3285aa22256]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007314{
Victor Stinner8c62be82010-05-06 00:08:46 +00007315 if (setuid(uid) < 0)
7316 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007317 Py_RETURN_NONE;
Guido van Rossuma3d78fb1993-11-10 09:23:53 +00007318}
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00007319#endif /* HAVE_SETUID */
Guido van Rossuma3d78fb1993-11-10 09:23:53 +00007320
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007321
Andrew M. Kuchling8d2f2b2d2000-07-13 01:26:58 +00007322#ifdef HAVE_SETEUID
Larry Hastings2f936352014-08-05 14:04:04 +10007323/*[clinic input]
7324os.seteuid
7325
7326 euid: uid_t
7327 /
7328
7329Set the current process's effective user id.
7330[clinic start generated code]*/
7331
Larry Hastings2f936352014-08-05 14:04:04 +10007332static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007333os_seteuid_impl(PyObject *module, uid_t euid)
7334/*[clinic end generated code: output=102e3ad98361519a input=ba93d927e4781aa9]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007335{
7336 if (seteuid(euid) < 0)
Victor Stinner8c62be82010-05-06 00:08:46 +00007337 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007338 Py_RETURN_NONE;
Andrew M. Kuchling8d2f2b2d2000-07-13 01:26:58 +00007339}
7340#endif /* HAVE_SETEUID */
7341
Larry Hastings2f936352014-08-05 14:04:04 +10007342
Andrew M. Kuchling8d2f2b2d2000-07-13 01:26:58 +00007343#ifdef HAVE_SETEGID
Larry Hastings2f936352014-08-05 14:04:04 +10007344/*[clinic input]
7345os.setegid
7346
7347 egid: gid_t
7348 /
7349
7350Set the current process's effective group id.
7351[clinic start generated code]*/
7352
Larry Hastings2f936352014-08-05 14:04:04 +10007353static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007354os_setegid_impl(PyObject *module, gid_t egid)
7355/*[clinic end generated code: output=4e4b825a6a10258d input=4080526d0ccd6ce3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007356{
7357 if (setegid(egid) < 0)
Victor Stinner8c62be82010-05-06 00:08:46 +00007358 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007359 Py_RETURN_NONE;
Andrew M. Kuchling8d2f2b2d2000-07-13 01:26:58 +00007360}
7361#endif /* HAVE_SETEGID */
7362
Larry Hastings2f936352014-08-05 14:04:04 +10007363
Andrew M. Kuchling8d2f2b2d2000-07-13 01:26:58 +00007364#ifdef HAVE_SETREUID
Larry Hastings2f936352014-08-05 14:04:04 +10007365/*[clinic input]
7366os.setreuid
7367
7368 ruid: uid_t
7369 euid: uid_t
7370 /
7371
7372Set the current process's real and effective user ids.
7373[clinic start generated code]*/
7374
Larry Hastings2f936352014-08-05 14:04:04 +10007375static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007376os_setreuid_impl(PyObject *module, uid_t ruid, uid_t euid)
7377/*[clinic end generated code: output=62d991210006530a input=0ca8978de663880c]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007378{
Victor Stinner8c62be82010-05-06 00:08:46 +00007379 if (setreuid(ruid, euid) < 0) {
7380 return posix_error();
7381 } else {
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02007382 Py_RETURN_NONE;
Victor Stinner8c62be82010-05-06 00:08:46 +00007383 }
Andrew M. Kuchling8d2f2b2d2000-07-13 01:26:58 +00007384}
7385#endif /* HAVE_SETREUID */
7386
Larry Hastings2f936352014-08-05 14:04:04 +10007387
Andrew M. Kuchling8d2f2b2d2000-07-13 01:26:58 +00007388#ifdef HAVE_SETREGID
Larry Hastings2f936352014-08-05 14:04:04 +10007389/*[clinic input]
7390os.setregid
7391
7392 rgid: gid_t
7393 egid: gid_t
7394 /
7395
7396Set the current process's real and effective group ids.
7397[clinic start generated code]*/
7398
Larry Hastings2f936352014-08-05 14:04:04 +10007399static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007400os_setregid_impl(PyObject *module, gid_t rgid, gid_t egid)
7401/*[clinic end generated code: output=aa803835cf5342f3 input=c59499f72846db78]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007402{
7403 if (setregid(rgid, egid) < 0)
Victor Stinner8c62be82010-05-06 00:08:46 +00007404 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007405 Py_RETURN_NONE;
Andrew M. Kuchling8d2f2b2d2000-07-13 01:26:58 +00007406}
7407#endif /* HAVE_SETREGID */
7408
Larry Hastings2f936352014-08-05 14:04:04 +10007409
Guido van Rossumb6775db1994-08-01 11:34:53 +00007410#ifdef HAVE_SETGID
Larry Hastings2f936352014-08-05 14:04:04 +10007411/*[clinic input]
7412os.setgid
7413 gid: gid_t
7414 /
7415
7416Set the current process's group id.
7417[clinic start generated code]*/
7418
Larry Hastings2f936352014-08-05 14:04:04 +10007419static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007420os_setgid_impl(PyObject *module, gid_t gid)
7421/*[clinic end generated code: output=bdccd7403f6ad8c3 input=27d30c4059045dc6]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007422{
Victor Stinner8c62be82010-05-06 00:08:46 +00007423 if (setgid(gid) < 0)
7424 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007425 Py_RETURN_NONE;
Guido van Rossuma3d78fb1993-11-10 09:23:53 +00007426}
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00007427#endif /* HAVE_SETGID */
Guido van Rossuma3d78fb1993-11-10 09:23:53 +00007428
Larry Hastings2f936352014-08-05 14:04:04 +10007429
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00007430#ifdef HAVE_SETGROUPS
Larry Hastings2f936352014-08-05 14:04:04 +10007431/*[clinic input]
7432os.setgroups
7433
7434 groups: object
7435 /
7436
7437Set the groups of the current process to list.
7438[clinic start generated code]*/
7439
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00007440static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007441os_setgroups(PyObject *module, PyObject *groups)
7442/*[clinic end generated code: output=3fcb32aad58c5ecd input=fa742ca3daf85a7e]*/
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00007443{
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03007444 Py_ssize_t i, len;
Victor Stinner8c62be82010-05-06 00:08:46 +00007445 gid_t grouplist[MAX_GROUPS];
Tim Peters5aa91602002-01-30 05:46:57 +00007446
Victor Stinner8c62be82010-05-06 00:08:46 +00007447 if (!PySequence_Check(groups)) {
7448 PyErr_SetString(PyExc_TypeError, "setgroups argument must be a sequence");
7449 return NULL;
7450 }
7451 len = PySequence_Size(groups);
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03007452 if (len < 0) {
7453 return NULL;
7454 }
Victor Stinner8c62be82010-05-06 00:08:46 +00007455 if (len > MAX_GROUPS) {
7456 PyErr_SetString(PyExc_ValueError, "too many groups");
7457 return NULL;
7458 }
7459 for(i = 0; i < len; i++) {
7460 PyObject *elem;
7461 elem = PySequence_GetItem(groups, i);
7462 if (!elem)
7463 return NULL;
7464 if (!PyLong_Check(elem)) {
7465 PyErr_SetString(PyExc_TypeError,
7466 "groups must be integers");
7467 Py_DECREF(elem);
7468 return NULL;
7469 } else {
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02007470 if (!_Py_Gid_Converter(elem, &grouplist[i])) {
Victor Stinner8c62be82010-05-06 00:08:46 +00007471 Py_DECREF(elem);
7472 return NULL;
7473 }
7474 }
7475 Py_DECREF(elem);
7476 }
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00007477
Victor Stinner8c62be82010-05-06 00:08:46 +00007478 if (setgroups(len, grouplist) < 0)
7479 return posix_error();
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02007480 Py_RETURN_NONE;
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00007481}
7482#endif /* HAVE_SETGROUPS */
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007483
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007484#if defined(HAVE_WAIT3) || defined(HAVE_WAIT4)
7485static PyObject *
Victor Stinner4195b5c2012-02-08 23:03:19 +01007486wait_helper(pid_t pid, int status, struct rusage *ru)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007487{
Victor Stinner8c62be82010-05-06 00:08:46 +00007488 PyObject *result;
7489 static PyObject *struct_rusage;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02007490 _Py_IDENTIFIER(struct_rusage);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007491
Victor Stinner8c62be82010-05-06 00:08:46 +00007492 if (pid == -1)
7493 return posix_error();
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007494
Victor Stinner8c62be82010-05-06 00:08:46 +00007495 if (struct_rusage == NULL) {
7496 PyObject *m = PyImport_ImportModuleNoBlock("resource");
7497 if (m == NULL)
7498 return NULL;
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02007499 struct_rusage = _PyObject_GetAttrId(m, &PyId_struct_rusage);
Victor Stinner8c62be82010-05-06 00:08:46 +00007500 Py_DECREF(m);
7501 if (struct_rusage == NULL)
7502 return NULL;
7503 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007504
Victor Stinner8c62be82010-05-06 00:08:46 +00007505 /* XXX(nnorwitz): Copied (w/mods) from resource.c, there should be only one. */
7506 result = PyStructSequence_New((PyTypeObject*) struct_rusage);
7507 if (!result)
7508 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007509
7510#ifndef doubletime
7511#define doubletime(TV) ((double)(TV).tv_sec + (TV).tv_usec * 0.000001)
7512#endif
7513
Victor Stinner8c62be82010-05-06 00:08:46 +00007514 PyStructSequence_SET_ITEM(result, 0,
Victor Stinner4195b5c2012-02-08 23:03:19 +01007515 PyFloat_FromDouble(doubletime(ru->ru_utime)));
Victor Stinner8c62be82010-05-06 00:08:46 +00007516 PyStructSequence_SET_ITEM(result, 1,
Victor Stinner4195b5c2012-02-08 23:03:19 +01007517 PyFloat_FromDouble(doubletime(ru->ru_stime)));
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007518#define SET_INT(result, index, value)\
Victor Stinner8c62be82010-05-06 00:08:46 +00007519 PyStructSequence_SET_ITEM(result, index, PyLong_FromLong(value))
7520 SET_INT(result, 2, ru->ru_maxrss);
7521 SET_INT(result, 3, ru->ru_ixrss);
7522 SET_INT(result, 4, ru->ru_idrss);
7523 SET_INT(result, 5, ru->ru_isrss);
7524 SET_INT(result, 6, ru->ru_minflt);
7525 SET_INT(result, 7, ru->ru_majflt);
7526 SET_INT(result, 8, ru->ru_nswap);
7527 SET_INT(result, 9, ru->ru_inblock);
7528 SET_INT(result, 10, ru->ru_oublock);
7529 SET_INT(result, 11, ru->ru_msgsnd);
7530 SET_INT(result, 12, ru->ru_msgrcv);
7531 SET_INT(result, 13, ru->ru_nsignals);
7532 SET_INT(result, 14, ru->ru_nvcsw);
7533 SET_INT(result, 15, ru->ru_nivcsw);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007534#undef SET_INT
7535
Victor Stinner8c62be82010-05-06 00:08:46 +00007536 if (PyErr_Occurred()) {
7537 Py_DECREF(result);
7538 return NULL;
7539 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007540
Victor Stinner8c62be82010-05-06 00:08:46 +00007541 return Py_BuildValue("NiN", PyLong_FromPid(pid), status, result);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007542}
7543#endif /* HAVE_WAIT3 || HAVE_WAIT4 */
7544
Larry Hastings2f936352014-08-05 14:04:04 +10007545
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007546#ifdef HAVE_WAIT3
Larry Hastings2f936352014-08-05 14:04:04 +10007547/*[clinic input]
7548os.wait3
7549
7550 options: int
7551Wait for completion of a child process.
7552
7553Returns a tuple of information about the child process:
7554 (pid, status, rusage)
7555[clinic start generated code]*/
7556
Larry Hastings2f936352014-08-05 14:04:04 +10007557static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007558os_wait3_impl(PyObject *module, int options)
7559/*[clinic end generated code: output=92c3224e6f28217a input=8ac4c56956b61710]*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007560{
Victor Stinner8c62be82010-05-06 00:08:46 +00007561 pid_t pid;
Victor Stinner8c62be82010-05-06 00:08:46 +00007562 struct rusage ru;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007563 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00007564 WAIT_TYPE status;
7565 WAIT_STATUS_INT(status) = 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007566
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007567 do {
7568 Py_BEGIN_ALLOW_THREADS
7569 pid = wait3(&status, options, &ru);
7570 Py_END_ALLOW_THREADS
7571 } while (pid < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
7572 if (pid < 0)
7573 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007574
Victor Stinner4195b5c2012-02-08 23:03:19 +01007575 return wait_helper(pid, WAIT_STATUS_INT(status), &ru);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007576}
7577#endif /* HAVE_WAIT3 */
7578
Larry Hastings2f936352014-08-05 14:04:04 +10007579
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007580#ifdef HAVE_WAIT4
Larry Hastings2f936352014-08-05 14:04:04 +10007581/*[clinic input]
7582
7583os.wait4
7584
7585 pid: pid_t
7586 options: int
7587
7588Wait for completion of a specific child process.
7589
7590Returns a tuple of information about the child process:
7591 (pid, status, rusage)
7592[clinic start generated code]*/
7593
Larry Hastings2f936352014-08-05 14:04:04 +10007594static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007595os_wait4_impl(PyObject *module, pid_t pid, int options)
7596/*[clinic end generated code: output=66195aa507b35f70 input=d11deed0750600ba]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007597{
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007598 pid_t res;
Victor Stinner8c62be82010-05-06 00:08:46 +00007599 struct rusage ru;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007600 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00007601 WAIT_TYPE status;
7602 WAIT_STATUS_INT(status) = 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007603
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007604 do {
7605 Py_BEGIN_ALLOW_THREADS
7606 res = wait4(pid, &status, options, &ru);
7607 Py_END_ALLOW_THREADS
7608 } while (res < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
7609 if (res < 0)
7610 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007611
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007612 return wait_helper(res, WAIT_STATUS_INT(status), &ru);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007613}
7614#endif /* HAVE_WAIT4 */
7615
Larry Hastings2f936352014-08-05 14:04:04 +10007616
Ross Lagerwall7807c352011-03-17 20:20:30 +02007617#if defined(HAVE_WAITID) && !defined(__APPLE__)
Larry Hastings2f936352014-08-05 14:04:04 +10007618/*[clinic input]
7619os.waitid
7620
7621 idtype: idtype_t
7622 Must be one of be P_PID, P_PGID or P_ALL.
7623 id: id_t
7624 The id to wait on.
7625 options: int
7626 Constructed from the ORing of one or more of WEXITED, WSTOPPED
7627 or WCONTINUED and additionally may be ORed with WNOHANG or WNOWAIT.
7628 /
7629
7630Returns the result of waiting for a process or processes.
7631
7632Returns either waitid_result or None if WNOHANG is specified and there are
7633no children in a waitable state.
7634[clinic start generated code]*/
7635
Larry Hastings2f936352014-08-05 14:04:04 +10007636static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007637os_waitid_impl(PyObject *module, idtype_t idtype, id_t id, int options)
7638/*[clinic end generated code: output=5d2e1c0bde61f4d8 input=d8e7f76e052b7920]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007639{
7640 PyObject *result;
7641 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007642 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02007643 siginfo_t si;
7644 si.si_pid = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10007645
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007646 do {
7647 Py_BEGIN_ALLOW_THREADS
7648 res = waitid(idtype, id, &si, options);
7649 Py_END_ALLOW_THREADS
7650 } while (res < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
7651 if (res < 0)
7652 return (!async_err) ? posix_error() : NULL;
Ross Lagerwall7807c352011-03-17 20:20:30 +02007653
7654 if (si.si_pid == 0)
7655 Py_RETURN_NONE;
7656
Eddie Elizondo474eedf2018-11-13 04:09:31 -08007657 result = PyStructSequence_New(WaitidResultType);
Ross Lagerwall7807c352011-03-17 20:20:30 +02007658 if (!result)
7659 return NULL;
7660
7661 PyStructSequence_SET_ITEM(result, 0, PyLong_FromPid(si.si_pid));
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02007662 PyStructSequence_SET_ITEM(result, 1, _PyLong_FromUid(si.si_uid));
Ross Lagerwall7807c352011-03-17 20:20:30 +02007663 PyStructSequence_SET_ITEM(result, 2, PyLong_FromLong((long)(si.si_signo)));
7664 PyStructSequence_SET_ITEM(result, 3, PyLong_FromLong((long)(si.si_status)));
7665 PyStructSequence_SET_ITEM(result, 4, PyLong_FromLong((long)(si.si_code)));
7666 if (PyErr_Occurred()) {
7667 Py_DECREF(result);
7668 return NULL;
7669 }
7670
7671 return result;
7672}
Larry Hastings2f936352014-08-05 14:04:04 +10007673#endif /* defined(HAVE_WAITID) && !defined(__APPLE__) */
Ross Lagerwall7807c352011-03-17 20:20:30 +02007674
Larry Hastings2f936352014-08-05 14:04:04 +10007675
7676#if defined(HAVE_WAITPID)
7677/*[clinic input]
7678os.waitpid
7679 pid: pid_t
7680 options: int
7681 /
7682
7683Wait for completion of a given child process.
7684
7685Returns a tuple of information regarding the child process:
7686 (pid, status)
7687
7688The options argument is ignored on Windows.
7689[clinic start generated code]*/
7690
Larry Hastings2f936352014-08-05 14:04:04 +10007691static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007692os_waitpid_impl(PyObject *module, pid_t pid, int options)
7693/*[clinic end generated code: output=5c37c06887a20270 input=0bf1666b8758fda3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007694{
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007695 pid_t res;
7696 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00007697 WAIT_TYPE status;
7698 WAIT_STATUS_INT(status) = 0;
Guido van Rossum54ecc3d1999-01-27 17:53:11 +00007699
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007700 do {
7701 Py_BEGIN_ALLOW_THREADS
7702 res = waitpid(pid, &status, options);
7703 Py_END_ALLOW_THREADS
7704 } while (res < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
7705 if (res < 0)
7706 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007707
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007708 return Py_BuildValue("Ni", PyLong_FromPid(res), WAIT_STATUS_INT(status));
Guido van Rossum21803b81992-08-09 12:55:27 +00007709}
Tim Petersab034fa2002-02-01 11:27:43 +00007710#elif defined(HAVE_CWAIT)
Tim Petersab034fa2002-02-01 11:27:43 +00007711/* MS C has a variant of waitpid() that's usable for most purposes. */
Larry Hastings2f936352014-08-05 14:04:04 +10007712/*[clinic input]
7713os.waitpid
Benjamin Petersonca470632016-09-06 13:47:26 -07007714 pid: intptr_t
Larry Hastings2f936352014-08-05 14:04:04 +10007715 options: int
7716 /
7717
7718Wait for completion of a given process.
7719
7720Returns a tuple of information regarding the process:
7721 (pid, status << 8)
7722
7723The options argument is ignored on Windows.
7724[clinic start generated code]*/
7725
Larry Hastings2f936352014-08-05 14:04:04 +10007726static PyObject *
Benjamin Petersonca470632016-09-06 13:47:26 -07007727os_waitpid_impl(PyObject *module, intptr_t pid, int options)
Victor Stinner581139c2016-09-06 15:54:20 -07007728/*[clinic end generated code: output=be836b221271d538 input=40f2440c515410f8]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007729{
7730 int status;
Benjamin Petersonca470632016-09-06 13:47:26 -07007731 intptr_t res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007732 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10007733
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007734 do {
7735 Py_BEGIN_ALLOW_THREADS
Steve Dower11f43262016-11-19 18:33:39 -08007736 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007737 res = _cwait(&status, pid, options);
Steve Dower11f43262016-11-19 18:33:39 -08007738 _Py_END_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007739 Py_END_ALLOW_THREADS
7740 } while (res < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Victor Stinnerd3ffd322015-09-15 10:11:03 +02007741 if (res < 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007742 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007743
Victor Stinner8c62be82010-05-06 00:08:46 +00007744 /* shift the status left a byte so this is more like the POSIX waitpid */
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007745 return Py_BuildValue(_Py_PARSE_INTPTR "i", res, status << 8);
Tim Petersab034fa2002-02-01 11:27:43 +00007746}
Larry Hastings2f936352014-08-05 14:04:04 +10007747#endif
7748
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007749
Guido van Rossumad0ee831995-03-01 10:34:45 +00007750#ifdef HAVE_WAIT
Larry Hastings2f936352014-08-05 14:04:04 +10007751/*[clinic input]
7752os.wait
7753
7754Wait for completion of a child process.
7755
7756Returns a tuple of information about the child process:
7757 (pid, status)
7758[clinic start generated code]*/
7759
Larry Hastings2f936352014-08-05 14:04:04 +10007760static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007761os_wait_impl(PyObject *module)
7762/*[clinic end generated code: output=6bc419ac32fb364b input=03b0182d4a4700ce]*/
Guido van Rossum21803b81992-08-09 12:55:27 +00007763{
Victor Stinner8c62be82010-05-06 00:08:46 +00007764 pid_t pid;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007765 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00007766 WAIT_TYPE status;
7767 WAIT_STATUS_INT(status) = 0;
Neal Norwitze241ce82003-02-17 18:17:05 +00007768
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007769 do {
7770 Py_BEGIN_ALLOW_THREADS
7771 pid = wait(&status);
7772 Py_END_ALLOW_THREADS
7773 } while (pid < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
7774 if (pid < 0)
7775 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007776
Victor Stinner8c62be82010-05-06 00:08:46 +00007777 return Py_BuildValue("Ni", PyLong_FromPid(pid), WAIT_STATUS_INT(status));
Guido van Rossum85e3b011991-06-03 12:42:10 +00007778}
Larry Hastings2f936352014-08-05 14:04:04 +10007779#endif /* HAVE_WAIT */
Guido van Rossum85e3b011991-06-03 12:42:10 +00007780
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007781
Larry Hastings9cf065c2012-06-22 16:30:09 -07007782#if defined(HAVE_READLINK) || defined(MS_WINDOWS)
Serhiy Storchaka12a69db2018-09-17 15:38:27 +03007783/*[clinic input]
7784os.readlink
7785
7786 path: path_t
7787 *
7788 dir_fd: dir_fd(requires='readlinkat') = None
7789
7790Return a string representing the path to which the symbolic link points.
7791
7792If dir_fd is not None, it should be a file descriptor open to a directory,
7793and path should be relative; path will then be relative to that directory.
7794
7795dir_fd may not be implemented on your platform. If it is unavailable,
7796using it will raise a NotImplementedError.
7797[clinic start generated code]*/
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007798
Barry Warsaw53699e91996-12-10 23:23:01 +00007799static PyObject *
Serhiy Storchaka12a69db2018-09-17 15:38:27 +03007800os_readlink_impl(PyObject *module, path_t *path, int dir_fd)
7801/*[clinic end generated code: output=d21b732a2e814030 input=113c87e0db1ecaf2]*/
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00007802{
Berker Peksage0b5b202018-08-15 13:03:41 +03007803#if defined(HAVE_READLINK)
Christian Heimes3cb091e2016-09-23 20:24:28 +02007804 char buffer[MAXPATHLEN+1];
Larry Hastings9cf065c2012-06-22 16:30:09 -07007805 ssize_t length;
Serhiy Storchaka12a69db2018-09-17 15:38:27 +03007806
7807 Py_BEGIN_ALLOW_THREADS
7808#ifdef HAVE_READLINKAT
7809 if (dir_fd != DEFAULT_DIR_FD)
7810 length = readlinkat(dir_fd, path->narrow, buffer, MAXPATHLEN);
7811 else
7812#endif
7813 length = readlink(path->narrow, buffer, MAXPATHLEN);
7814 Py_END_ALLOW_THREADS
7815
7816 if (length < 0) {
7817 return path_error(path);
7818 }
7819 buffer[length] = '\0';
7820
7821 if (PyUnicode_Check(path->object))
7822 return PyUnicode_DecodeFSDefaultAndSize(buffer, length);
7823 else
7824 return PyBytes_FromStringAndSize(buffer, length);
Berker Peksage0b5b202018-08-15 13:03:41 +03007825#elif defined(MS_WINDOWS)
7826 DWORD n_bytes_returned;
Steve Dower9eb3d542019-08-21 15:52:42 -07007827 DWORD io_result = 0;
Berker Peksage0b5b202018-08-15 13:03:41 +03007828 HANDLE reparse_point_handle;
Berker Peksage0b5b202018-08-15 13:03:41 +03007829 char target_buffer[_Py_MAXIMUM_REPARSE_DATA_BUFFER_SIZE];
7830 _Py_REPARSE_DATA_BUFFER *rdb = (_Py_REPARSE_DATA_BUFFER *)target_buffer;
Miss Islington (bot)54dac6c2019-09-03 13:13:41 -07007831 PyObject *result = NULL;
Thomas Wouters89f507f2006-12-13 04:49:30 +00007832
Larry Hastings2f936352014-08-05 14:04:04 +10007833 /* First get a handle to the reparse point */
7834 Py_BEGIN_ALLOW_THREADS
7835 reparse_point_handle = CreateFileW(
Serhiy Storchaka12a69db2018-09-17 15:38:27 +03007836 path->wide,
Larry Hastings2f936352014-08-05 14:04:04 +10007837 0,
7838 0,
7839 0,
7840 OPEN_EXISTING,
7841 FILE_FLAG_OPEN_REPARSE_POINT|FILE_FLAG_BACKUP_SEMANTICS,
7842 0);
Steve Dower9eb3d542019-08-21 15:52:42 -07007843 if (reparse_point_handle != INVALID_HANDLE_VALUE) {
7844 /* New call DeviceIoControl to read the reparse point */
7845 io_result = DeviceIoControl(
7846 reparse_point_handle,
7847 FSCTL_GET_REPARSE_POINT,
7848 0, 0, /* in buffer */
7849 target_buffer, sizeof(target_buffer),
7850 &n_bytes_returned,
7851 0 /* we're not using OVERLAPPED_IO */
7852 );
7853 CloseHandle(reparse_point_handle);
Berker Peksage0b5b202018-08-15 13:03:41 +03007854 }
Larry Hastings2f936352014-08-05 14:04:04 +10007855 Py_END_ALLOW_THREADS
7856
Berker Peksage0b5b202018-08-15 13:03:41 +03007857 if (io_result == 0) {
Serhiy Storchaka12a69db2018-09-17 15:38:27 +03007858 return path_error(path);
Berker Peksage0b5b202018-08-15 13:03:41 +03007859 }
Larry Hastings2f936352014-08-05 14:04:04 +10007860
Steve Dower9eb3d542019-08-21 15:52:42 -07007861 wchar_t *name = NULL;
7862 Py_ssize_t nameLen = 0;
7863 if (rdb->ReparseTag == IO_REPARSE_TAG_SYMLINK)
Larry Hastings2f936352014-08-05 14:04:04 +10007864 {
Steve Dower9eb3d542019-08-21 15:52:42 -07007865 name = (wchar_t *)((char*)rdb->SymbolicLinkReparseBuffer.PathBuffer +
7866 rdb->SymbolicLinkReparseBuffer.SubstituteNameOffset);
7867 nameLen = rdb->SymbolicLinkReparseBuffer.SubstituteNameLength / sizeof(wchar_t);
Larry Hastings2f936352014-08-05 14:04:04 +10007868 }
Steve Dower9eb3d542019-08-21 15:52:42 -07007869 else if (rdb->ReparseTag == IO_REPARSE_TAG_MOUNT_POINT)
7870 {
7871 name = (wchar_t *)((char*)rdb->MountPointReparseBuffer.PathBuffer +
7872 rdb->MountPointReparseBuffer.SubstituteNameOffset);
7873 nameLen = rdb->MountPointReparseBuffer.SubstituteNameLength / sizeof(wchar_t);
7874 }
7875 else
7876 {
7877 PyErr_SetString(PyExc_ValueError, "not a symbolic link");
7878 }
7879 if (name) {
7880 if (nameLen > 4 && wcsncmp(name, L"\\??\\", 4) == 0) {
7881 /* Our buffer is mutable, so this is okay */
7882 name[1] = L'\\';
7883 }
7884 result = PyUnicode_FromWideChar(name, nameLen);
Miss Islington (bot)54dac6c2019-09-03 13:13:41 -07007885 if (result && path->narrow) {
Steve Dower9eb3d542019-08-21 15:52:42 -07007886 Py_SETREF(result, PyUnicode_EncodeFSDefault(result));
7887 }
Berker Peksage0b5b202018-08-15 13:03:41 +03007888 }
Serhiy Storchaka12a69db2018-09-17 15:38:27 +03007889 return result;
Berker Peksage0b5b202018-08-15 13:03:41 +03007890#endif
Larry Hastings2f936352014-08-05 14:04:04 +10007891}
Berker Peksage0b5b202018-08-15 13:03:41 +03007892#endif /* defined(HAVE_READLINK) || defined(MS_WINDOWS) */
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007893
Larry Hastings9cf065c2012-06-22 16:30:09 -07007894#ifdef HAVE_SYMLINK
Larry Hastings9cf065c2012-06-22 16:30:09 -07007895
7896#if defined(MS_WINDOWS)
7897
Steve Dower6921e732018-03-05 14:26:08 -08007898/* Remove the last portion of the path - return 0 on success */
7899static int
Victor Stinner31b3b922013-06-05 01:49:17 +02007900_dirnameW(WCHAR *path)
7901{
Jason R. Coombs3a092862013-05-27 23:21:28 -04007902 WCHAR *ptr;
Steve Dower6921e732018-03-05 14:26:08 -08007903 size_t length = wcsnlen_s(path, MAX_PATH);
7904 if (length == MAX_PATH) {
7905 return -1;
7906 }
Jason R. Coombs3a092862013-05-27 23:21:28 -04007907
7908 /* walk the path from the end until a backslash is encountered */
Steve Dower6921e732018-03-05 14:26:08 -08007909 for(ptr = path + length; ptr != path; ptr--) {
7910 if (*ptr == L'\\' || *ptr == L'/') {
Jason R. Coombs3a092862013-05-27 23:21:28 -04007911 break;
Steve Dower6921e732018-03-05 14:26:08 -08007912 }
Jason R. Coombs3a092862013-05-27 23:21:28 -04007913 }
7914 *ptr = 0;
Steve Dower6921e732018-03-05 14:26:08 -08007915 return 0;
Jason R. Coombs3a092862013-05-27 23:21:28 -04007916}
7917
Victor Stinner31b3b922013-06-05 01:49:17 +02007918/* Is this path absolute? */
7919static int
7920_is_absW(const WCHAR *path)
7921{
Steve Dower6921e732018-03-05 14:26:08 -08007922 return path[0] == L'\\' || path[0] == L'/' ||
7923 (path[0] && path[1] == L':');
Jason R. Coombs3a092862013-05-27 23:21:28 -04007924}
7925
Steve Dower6921e732018-03-05 14:26:08 -08007926/* join root and rest with a backslash - return 0 on success */
7927static int
Victor Stinner31b3b922013-06-05 01:49:17 +02007928_joinW(WCHAR *dest_path, const WCHAR *root, const WCHAR *rest)
7929{
Victor Stinner31b3b922013-06-05 01:49:17 +02007930 if (_is_absW(rest)) {
Steve Dower6921e732018-03-05 14:26:08 -08007931 return wcscpy_s(dest_path, MAX_PATH, rest);
Jason R. Coombs3a092862013-05-27 23:21:28 -04007932 }
7933
Steve Dower6921e732018-03-05 14:26:08 -08007934 if (wcscpy_s(dest_path, MAX_PATH, root)) {
7935 return -1;
Jason R. Coombs3a092862013-05-27 23:21:28 -04007936 }
Steve Dower6921e732018-03-05 14:26:08 -08007937
7938 if (dest_path[0] && wcscat_s(dest_path, MAX_PATH, L"\\")) {
7939 return -1;
7940 }
7941
7942 return wcscat_s(dest_path, MAX_PATH, rest);
Jason R. Coombs3a092862013-05-27 23:21:28 -04007943}
7944
Victor Stinner31b3b922013-06-05 01:49:17 +02007945/* Return True if the path at src relative to dest is a directory */
7946static int
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03007947_check_dirW(LPCWSTR src, LPCWSTR dest)
Jason R. Coombs3a092862013-05-27 23:21:28 -04007948{
Jason R. Coombs3a092862013-05-27 23:21:28 -04007949 WIN32_FILE_ATTRIBUTE_DATA src_info;
7950 WCHAR dest_parent[MAX_PATH];
7951 WCHAR src_resolved[MAX_PATH] = L"";
7952
7953 /* dest_parent = os.path.dirname(dest) */
Steve Dower6921e732018-03-05 14:26:08 -08007954 if (wcscpy_s(dest_parent, MAX_PATH, dest) ||
7955 _dirnameW(dest_parent)) {
7956 return 0;
7957 }
Jason R. Coombs3a092862013-05-27 23:21:28 -04007958 /* src_resolved = os.path.join(dest_parent, src) */
Steve Dower6921e732018-03-05 14:26:08 -08007959 if (_joinW(src_resolved, dest_parent, src)) {
7960 return 0;
7961 }
Jason R. Coombs3a092862013-05-27 23:21:28 -04007962 return (
7963 GetFileAttributesExW(src_resolved, GetFileExInfoStandard, &src_info)
7964 && src_info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY
7965 );
7966}
Larry Hastings9cf065c2012-06-22 16:30:09 -07007967#endif
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007968
Larry Hastings2f936352014-08-05 14:04:04 +10007969
7970/*[clinic input]
7971os.symlink
7972 src: path_t
7973 dst: path_t
7974 target_is_directory: bool = False
7975 *
7976 dir_fd: dir_fd(requires='symlinkat')=None
7977
7978# "symlink(src, dst, target_is_directory=False, *, dir_fd=None)\n\n\
7979
7980Create a symbolic link pointing to src named dst.
7981
7982target_is_directory is required on Windows if the target is to be
7983 interpreted as a directory. (On Windows, symlink requires
7984 Windows 6.0 or greater, and raises a NotImplementedError otherwise.)
7985 target_is_directory is ignored on non-Windows platforms.
7986
7987If dir_fd is not None, it should be a file descriptor open to a directory,
7988 and path should be relative; path will then be relative to that directory.
7989dir_fd may not be implemented on your platform.
7990 If it is unavailable, using it will raise a NotImplementedError.
7991
7992[clinic start generated code]*/
7993
Larry Hastings2f936352014-08-05 14:04:04 +10007994static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007995os_symlink_impl(PyObject *module, path_t *src, path_t *dst,
Larry Hastings89964c42015-04-14 18:07:59 -04007996 int target_is_directory, int dir_fd)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007997/*[clinic end generated code: output=08ca9f3f3cf960f6 input=e820ec4472547bc3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007998{
Larry Hastings9cf065c2012-06-22 16:30:09 -07007999#ifdef MS_WINDOWS
8000 DWORD result;
Vidar Tonaas Fauske0e107662019-04-09 20:19:46 +02008001 DWORD flags = 0;
8002
8003 /* Assumed true, set to false if detected to not be available. */
8004 static int windows_has_symlink_unprivileged_flag = TRUE;
Larry Hastings9cf065c2012-06-22 16:30:09 -07008005#else
8006 int result;
8007#endif
8008
Larry Hastings9cf065c2012-06-22 16:30:09 -07008009#ifdef MS_WINDOWS
Larry Hastings9cf065c2012-06-22 16:30:09 -07008010
Vidar Tonaas Fauske0e107662019-04-09 20:19:46 +02008011 if (windows_has_symlink_unprivileged_flag) {
8012 /* Allow non-admin symlinks if system allows it. */
8013 flags |= SYMBOLIC_LINK_FLAG_ALLOW_UNPRIVILEGED_CREATE;
8014 }
Jason R. Coombs3a092862013-05-27 23:21:28 -04008015
Larry Hastings9cf065c2012-06-22 16:30:09 -07008016 Py_BEGIN_ALLOW_THREADS
Steve Dower6921e732018-03-05 14:26:08 -08008017 _Py_BEGIN_SUPPRESS_IPH
Vidar Tonaas Fauske0e107662019-04-09 20:19:46 +02008018 /* if src is a directory, ensure flags==1 (target_is_directory bit) */
8019 if (target_is_directory || _check_dirW(src->wide, dst->wide)) {
8020 flags |= SYMBOLIC_LINK_FLAG_DIRECTORY;
8021 }
8022
8023 result = CreateSymbolicLinkW(dst->wide, src->wide, flags);
Steve Dower6921e732018-03-05 14:26:08 -08008024 _Py_END_SUPPRESS_IPH
Larry Hastings9cf065c2012-06-22 16:30:09 -07008025 Py_END_ALLOW_THREADS
8026
Vidar Tonaas Fauske0e107662019-04-09 20:19:46 +02008027 if (windows_has_symlink_unprivileged_flag && !result &&
8028 ERROR_INVALID_PARAMETER == GetLastError()) {
8029
8030 Py_BEGIN_ALLOW_THREADS
8031 _Py_BEGIN_SUPPRESS_IPH
8032 /* This error might be caused by
8033 SYMBOLIC_LINK_FLAG_ALLOW_UNPRIVILEGED_CREATE not being supported.
8034 Try again, and update windows_has_symlink_unprivileged_flag if we
8035 are successful this time.
8036
8037 NOTE: There is a risk of a race condition here if there are other
8038 conditions than the flag causing ERROR_INVALID_PARAMETER, and
8039 another process (or thread) changes that condition in between our
8040 calls to CreateSymbolicLink.
8041 */
8042 flags &= ~(SYMBOLIC_LINK_FLAG_ALLOW_UNPRIVILEGED_CREATE);
8043 result = CreateSymbolicLinkW(dst->wide, src->wide, flags);
8044 _Py_END_SUPPRESS_IPH
8045 Py_END_ALLOW_THREADS
8046
8047 if (result || ERROR_INVALID_PARAMETER != GetLastError()) {
8048 windows_has_symlink_unprivileged_flag = FALSE;
8049 }
8050 }
8051
Larry Hastings2f936352014-08-05 14:04:04 +10008052 if (!result)
8053 return path_error2(src, dst);
Larry Hastings9cf065c2012-06-22 16:30:09 -07008054
8055#else
8056
Steve Dower6921e732018-03-05 14:26:08 -08008057 if ((src->narrow && dst->wide) || (src->wide && dst->narrow)) {
8058 PyErr_SetString(PyExc_ValueError,
8059 "symlink: src and dst must be the same type");
8060 return NULL;
8061 }
8062
Larry Hastings9cf065c2012-06-22 16:30:09 -07008063 Py_BEGIN_ALLOW_THREADS
8064#if HAVE_SYMLINKAT
8065 if (dir_fd != DEFAULT_DIR_FD)
Larry Hastings2f936352014-08-05 14:04:04 +10008066 result = symlinkat(src->narrow, dir_fd, dst->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07008067 else
8068#endif
Larry Hastings2f936352014-08-05 14:04:04 +10008069 result = symlink(src->narrow, dst->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07008070 Py_END_ALLOW_THREADS
8071
Larry Hastings2f936352014-08-05 14:04:04 +10008072 if (result)
8073 return path_error2(src, dst);
Larry Hastings9cf065c2012-06-22 16:30:09 -07008074#endif
8075
Larry Hastings2f936352014-08-05 14:04:04 +10008076 Py_RETURN_NONE;
Guido van Rossumbfaf3d61997-12-29 20:02:27 +00008077}
8078#endif /* HAVE_SYMLINK */
8079
Larry Hastings9cf065c2012-06-22 16:30:09 -07008080
Brian Curtind40e6f72010-07-08 21:39:08 +00008081
Guido van Rossumbfaf3d61997-12-29 20:02:27 +00008082
Larry Hastings605a62d2012-06-24 04:33:36 -07008083static PyStructSequence_Field times_result_fields[] = {
8084 {"user", "user time"},
8085 {"system", "system time"},
8086 {"children_user", "user time of children"},
8087 {"children_system", "system time of children"},
8088 {"elapsed", "elapsed time since an arbitrary point in the past"},
8089 {NULL}
8090};
8091
8092PyDoc_STRVAR(times_result__doc__,
8093"times_result: Result from os.times().\n\n\
8094This object may be accessed either as a tuple of\n\
8095 (user, system, children_user, children_system, elapsed),\n\
8096or via the attributes user, system, children_user, children_system,\n\
8097and elapsed.\n\
8098\n\
8099See os.times for more information.");
8100
8101static PyStructSequence_Desc times_result_desc = {
8102 "times_result", /* name */
8103 times_result__doc__, /* doc */
8104 times_result_fields,
8105 5
8106};
8107
Eddie Elizondo474eedf2018-11-13 04:09:31 -08008108static PyTypeObject* TimesResultType;
Larry Hastings605a62d2012-06-24 04:33:36 -07008109
Antoine Pitrouf3923e92012-07-24 21:23:53 +02008110#ifdef MS_WINDOWS
8111#define HAVE_TIMES /* mandatory, for the method table */
8112#endif
Larry Hastings605a62d2012-06-24 04:33:36 -07008113
Antoine Pitrouf3923e92012-07-24 21:23:53 +02008114#ifdef HAVE_TIMES
Larry Hastings605a62d2012-06-24 04:33:36 -07008115
8116static PyObject *
8117build_times_result(double user, double system,
8118 double children_user, double children_system,
8119 double elapsed)
8120{
Eddie Elizondo474eedf2018-11-13 04:09:31 -08008121 PyObject *value = PyStructSequence_New(TimesResultType);
Larry Hastings605a62d2012-06-24 04:33:36 -07008122 if (value == NULL)
8123 return NULL;
8124
8125#define SET(i, field) \
8126 { \
8127 PyObject *o = PyFloat_FromDouble(field); \
8128 if (!o) { \
8129 Py_DECREF(value); \
8130 return NULL; \
8131 } \
8132 PyStructSequence_SET_ITEM(value, i, o); \
8133 } \
8134
8135 SET(0, user);
8136 SET(1, system);
8137 SET(2, children_user);
8138 SET(3, children_system);
8139 SET(4, elapsed);
8140
8141#undef SET
8142
8143 return value;
8144}
8145
Larry Hastings605a62d2012-06-24 04:33:36 -07008146
Larry Hastings2f936352014-08-05 14:04:04 +10008147#ifndef MS_WINDOWS
8148#define NEED_TICKS_PER_SECOND
8149static long ticks_per_second = -1;
8150#endif /* MS_WINDOWS */
8151
8152/*[clinic input]
8153os.times
8154
8155Return a collection containing process timing information.
8156
8157The object returned behaves like a named tuple with these fields:
8158 (utime, stime, cutime, cstime, elapsed_time)
8159All fields are floating point numbers.
8160[clinic start generated code]*/
8161
Larry Hastings2f936352014-08-05 14:04:04 +10008162static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008163os_times_impl(PyObject *module)
8164/*[clinic end generated code: output=35f640503557d32a input=2bf9df3d6ab2e48b]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008165#ifdef MS_WINDOWS
Guido van Rossum14ed0b21994-09-29 09:50:09 +00008166{
Victor Stinner8c62be82010-05-06 00:08:46 +00008167 FILETIME create, exit, kernel, user;
8168 HANDLE hProc;
8169 hProc = GetCurrentProcess();
8170 GetProcessTimes(hProc, &create, &exit, &kernel, &user);
8171 /* The fields of a FILETIME structure are the hi and lo part
8172 of a 64-bit value expressed in 100 nanosecond units.
8173 1e7 is one second in such units; 1e-7 the inverse.
8174 429.4967296 is 2**32 / 1e7 or 2**32 * 1e-7.
8175 */
Larry Hastings605a62d2012-06-24 04:33:36 -07008176 return build_times_result(
Victor Stinner8c62be82010-05-06 00:08:46 +00008177 (double)(user.dwHighDateTime*429.4967296 +
8178 user.dwLowDateTime*1e-7),
8179 (double)(kernel.dwHighDateTime*429.4967296 +
8180 kernel.dwLowDateTime*1e-7),
8181 (double)0,
8182 (double)0,
8183 (double)0);
Guido van Rossum14ed0b21994-09-29 09:50:09 +00008184}
Larry Hastings2f936352014-08-05 14:04:04 +10008185#else /* MS_WINDOWS */
Antoine Pitrouf3923e92012-07-24 21:23:53 +02008186{
Larry Hastings2f936352014-08-05 14:04:04 +10008187
8188
Antoine Pitrouf3923e92012-07-24 21:23:53 +02008189 struct tms t;
8190 clock_t c;
8191 errno = 0;
8192 c = times(&t);
8193 if (c == (clock_t) -1)
8194 return posix_error();
8195 return build_times_result(
8196 (double)t.tms_utime / ticks_per_second,
8197 (double)t.tms_stime / ticks_per_second,
8198 (double)t.tms_cutime / ticks_per_second,
8199 (double)t.tms_cstime / ticks_per_second,
8200 (double)c / ticks_per_second);
8201}
Larry Hastings2f936352014-08-05 14:04:04 +10008202#endif /* MS_WINDOWS */
Antoine Pitrouf3923e92012-07-24 21:23:53 +02008203#endif /* HAVE_TIMES */
8204
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008205
Martin v. Löwis49ee14d2003-11-10 06:35:36 +00008206#ifdef HAVE_GETSID
Larry Hastings2f936352014-08-05 14:04:04 +10008207/*[clinic input]
8208os.getsid
8209
8210 pid: pid_t
8211 /
8212
8213Call the system call getsid(pid) and return the result.
8214[clinic start generated code]*/
8215
Larry Hastings2f936352014-08-05 14:04:04 +10008216static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008217os_getsid_impl(PyObject *module, pid_t pid)
8218/*[clinic end generated code: output=112deae56b306460 input=eeb2b923a30ce04e]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008219{
Victor Stinner8c62be82010-05-06 00:08:46 +00008220 int sid;
Victor Stinner8c62be82010-05-06 00:08:46 +00008221 sid = getsid(pid);
8222 if (sid < 0)
8223 return posix_error();
8224 return PyLong_FromLong((long)sid);
Martin v. Löwis49ee14d2003-11-10 06:35:36 +00008225}
8226#endif /* HAVE_GETSID */
8227
8228
Guido van Rossumb6775db1994-08-01 11:34:53 +00008229#ifdef HAVE_SETSID
Larry Hastings2f936352014-08-05 14:04:04 +10008230/*[clinic input]
8231os.setsid
8232
8233Call the system call setsid().
8234[clinic start generated code]*/
8235
Larry Hastings2f936352014-08-05 14:04:04 +10008236static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008237os_setsid_impl(PyObject *module)
8238/*[clinic end generated code: output=e2ddedd517086d77 input=5fff45858e2f0776]*/
Guido van Rossumc2670a01992-09-13 20:07:29 +00008239{
Victor Stinner8c62be82010-05-06 00:08:46 +00008240 if (setsid() < 0)
8241 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10008242 Py_RETURN_NONE;
Guido van Rossumc2670a01992-09-13 20:07:29 +00008243}
Guido van Rossumb6775db1994-08-01 11:34:53 +00008244#endif /* HAVE_SETSID */
Guido van Rossumc2670a01992-09-13 20:07:29 +00008245
Larry Hastings2f936352014-08-05 14:04:04 +10008246
Guido van Rossumb6775db1994-08-01 11:34:53 +00008247#ifdef HAVE_SETPGID
Larry Hastings2f936352014-08-05 14:04:04 +10008248/*[clinic input]
8249os.setpgid
8250
8251 pid: pid_t
8252 pgrp: pid_t
8253 /
8254
8255Call the system call setpgid(pid, pgrp).
8256[clinic start generated code]*/
8257
Larry Hastings2f936352014-08-05 14:04:04 +10008258static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008259os_setpgid_impl(PyObject *module, pid_t pid, pid_t pgrp)
8260/*[clinic end generated code: output=6461160319a43d6a input=fceb395eca572e1a]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008261{
Victor Stinner8c62be82010-05-06 00:08:46 +00008262 if (setpgid(pid, pgrp) < 0)
8263 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10008264 Py_RETURN_NONE;
Guido van Rossumc2670a01992-09-13 20:07:29 +00008265}
Guido van Rossumb6775db1994-08-01 11:34:53 +00008266#endif /* HAVE_SETPGID */
Guido van Rossumc2670a01992-09-13 20:07:29 +00008267
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008268
Guido van Rossumb6775db1994-08-01 11:34:53 +00008269#ifdef HAVE_TCGETPGRP
Larry Hastings2f936352014-08-05 14:04:04 +10008270/*[clinic input]
8271os.tcgetpgrp
8272
8273 fd: int
8274 /
8275
8276Return the process group associated with the terminal specified by fd.
8277[clinic start generated code]*/
8278
Larry Hastings2f936352014-08-05 14:04:04 +10008279static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008280os_tcgetpgrp_impl(PyObject *module, int fd)
8281/*[clinic end generated code: output=f865e88be86c272b input=7f6c18eac10ada86]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008282{
8283 pid_t pgid = tcgetpgrp(fd);
Victor Stinner8c62be82010-05-06 00:08:46 +00008284 if (pgid < 0)
8285 return posix_error();
8286 return PyLong_FromPid(pgid);
Guido van Rossum7066dd71992-09-17 17:54:56 +00008287}
Guido van Rossumb6775db1994-08-01 11:34:53 +00008288#endif /* HAVE_TCGETPGRP */
Guido van Rossum7066dd71992-09-17 17:54:56 +00008289
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008290
Guido van Rossumb6775db1994-08-01 11:34:53 +00008291#ifdef HAVE_TCSETPGRP
Larry Hastings2f936352014-08-05 14:04:04 +10008292/*[clinic input]
8293os.tcsetpgrp
8294
8295 fd: int
8296 pgid: pid_t
8297 /
8298
8299Set the process group associated with the terminal specified by fd.
8300[clinic start generated code]*/
8301
Larry Hastings2f936352014-08-05 14:04:04 +10008302static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008303os_tcsetpgrp_impl(PyObject *module, int fd, pid_t pgid)
8304/*[clinic end generated code: output=f1821a381b9daa39 input=5bdc997c6a619020]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008305{
Victor Stinner8c62be82010-05-06 00:08:46 +00008306 if (tcsetpgrp(fd, pgid) < 0)
8307 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10008308 Py_RETURN_NONE;
Guido van Rossum7066dd71992-09-17 17:54:56 +00008309}
Guido van Rossumb6775db1994-08-01 11:34:53 +00008310#endif /* HAVE_TCSETPGRP */
Guido van Rossum22db57e1992-04-05 14:25:30 +00008311
Guido van Rossum687dd131993-05-17 08:34:16 +00008312/* Functions acting on file descriptors */
8313
Victor Stinnerdaf45552013-08-28 00:53:59 +02008314#ifdef O_CLOEXEC
8315extern int _Py_open_cloexec_works;
8316#endif
8317
Larry Hastings2f936352014-08-05 14:04:04 +10008318
8319/*[clinic input]
8320os.open -> int
8321 path: path_t
8322 flags: int
8323 mode: int = 0o777
8324 *
8325 dir_fd: dir_fd(requires='openat') = None
8326
8327# "open(path, flags, mode=0o777, *, dir_fd=None)\n\n\
8328
8329Open a file for low level IO. Returns a file descriptor (integer).
8330
8331If dir_fd is not None, it should be a file descriptor open to a directory,
8332 and path should be relative; path will then be relative to that directory.
8333dir_fd may not be implemented on your platform.
8334 If it is unavailable, using it will raise a NotImplementedError.
8335[clinic start generated code]*/
8336
Larry Hastings2f936352014-08-05 14:04:04 +10008337static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008338os_open_impl(PyObject *module, path_t *path, int flags, int mode, int dir_fd)
8339/*[clinic end generated code: output=abc7227888c8bc73 input=ad8623b29acd2934]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008340{
8341 int fd;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008342 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10008343
Victor Stinnerdaf45552013-08-28 00:53:59 +02008344#ifdef O_CLOEXEC
8345 int *atomic_flag_works = &_Py_open_cloexec_works;
8346#elif !defined(MS_WINDOWS)
8347 int *atomic_flag_works = NULL;
8348#endif
Mark Hammondc2e85bd2002-10-03 05:10:39 +00008349
Victor Stinnerdaf45552013-08-28 00:53:59 +02008350#ifdef MS_WINDOWS
8351 flags |= O_NOINHERIT;
8352#elif defined(O_CLOEXEC)
8353 flags |= O_CLOEXEC;
8354#endif
8355
Steve Dowerb82e17e2019-05-23 08:45:22 -07008356 if (PySys_Audit("open", "OOi", path->object, Py_None, flags) < 0) {
8357 return -1;
8358 }
8359
Steve Dower8fc89802015-04-12 00:26:27 -04008360 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008361 do {
8362 Py_BEGIN_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07008363#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07008364 fd = _wopen(path->wide, flags, mode);
Steve Dower6230aaf2016-09-09 09:03:15 -07008365#else
Larry Hastings9cf065c2012-06-22 16:30:09 -07008366#ifdef HAVE_OPENAT
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008367 if (dir_fd != DEFAULT_DIR_FD)
8368 fd = openat(dir_fd, path->narrow, flags, mode);
8369 else
Steve Dower6230aaf2016-09-09 09:03:15 -07008370#endif /* HAVE_OPENAT */
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008371 fd = open(path->narrow, flags, mode);
Steve Dower6230aaf2016-09-09 09:03:15 -07008372#endif /* !MS_WINDOWS */
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008373 Py_END_ALLOW_THREADS
8374 } while (fd < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Steve Dower8fc89802015-04-12 00:26:27 -04008375 _Py_END_SUPPRESS_IPH
Guido van Rossum687dd131993-05-17 08:34:16 +00008376
Victor Stinnerd3ffd322015-09-15 10:11:03 +02008377 if (fd < 0) {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008378 if (!async_err)
8379 PyErr_SetFromErrnoWithFilenameObject(PyExc_OSError, path->object);
Larry Hastings2f936352014-08-05 14:04:04 +10008380 return -1;
Larry Hastings9cf065c2012-06-22 16:30:09 -07008381 }
8382
Victor Stinnerdaf45552013-08-28 00:53:59 +02008383#ifndef MS_WINDOWS
8384 if (_Py_set_inheritable(fd, 0, atomic_flag_works) < 0) {
8385 close(fd);
Larry Hastings2f936352014-08-05 14:04:04 +10008386 return -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008387 }
8388#endif
8389
Larry Hastings2f936352014-08-05 14:04:04 +10008390 return fd;
8391}
8392
8393
8394/*[clinic input]
8395os.close
8396
8397 fd: int
8398
8399Close a file descriptor.
8400[clinic start generated code]*/
8401
Barry Warsaw53699e91996-12-10 23:23:01 +00008402static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008403os_close_impl(PyObject *module, int fd)
8404/*[clinic end generated code: output=2fe4e93602822c14 input=2bc42451ca5c3223]*/
Guido van Rossum687dd131993-05-17 08:34:16 +00008405{
Larry Hastings2f936352014-08-05 14:04:04 +10008406 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008407 /* We do not want to retry upon EINTR: see http://lwn.net/Articles/576478/
8408 * and http://linux.derkeiler.com/Mailing-Lists/Kernel/2005-09/3000.html
8409 * for more details.
8410 */
Victor Stinner8c62be82010-05-06 00:08:46 +00008411 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04008412 _Py_BEGIN_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00008413 res = close(fd);
Steve Dower8fc89802015-04-12 00:26:27 -04008414 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00008415 Py_END_ALLOW_THREADS
8416 if (res < 0)
8417 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10008418 Py_RETURN_NONE;
Guido van Rossum687dd131993-05-17 08:34:16 +00008419}
8420
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008421
Larry Hastings2f936352014-08-05 14:04:04 +10008422/*[clinic input]
8423os.closerange
8424
8425 fd_low: int
8426 fd_high: int
8427 /
8428
8429Closes all file descriptors in [fd_low, fd_high), ignoring errors.
8430[clinic start generated code]*/
8431
Larry Hastings2f936352014-08-05 14:04:04 +10008432static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008433os_closerange_impl(PyObject *module, int fd_low, int fd_high)
8434/*[clinic end generated code: output=0ce5c20fcda681c2 input=5855a3d053ebd4ec]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008435{
8436 int i;
Victor Stinner8c62be82010-05-06 00:08:46 +00008437 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04008438 _Py_BEGIN_SUPPRESS_IPH
Benjamin Peterson207116b2016-09-08 11:28:06 -07008439 for (i = Py_MAX(fd_low, 0); i < fd_high; i++)
Steve Dower940f33a2016-09-08 11:21:54 -07008440 close(i);
Steve Dower8fc89802015-04-12 00:26:27 -04008441 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00008442 Py_END_ALLOW_THREADS
8443 Py_RETURN_NONE;
Christian Heimesfdab48e2008-01-20 09:06:41 +00008444}
8445
8446
Larry Hastings2f936352014-08-05 14:04:04 +10008447/*[clinic input]
8448os.dup -> int
8449
8450 fd: int
8451 /
8452
8453Return a duplicate of a file descriptor.
8454[clinic start generated code]*/
8455
Larry Hastings2f936352014-08-05 14:04:04 +10008456static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008457os_dup_impl(PyObject *module, int fd)
8458/*[clinic end generated code: output=486f4860636b2a9f input=6f10f7ea97f7852a]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008459{
8460 return _Py_dup(fd);
Guido van Rossum687dd131993-05-17 08:34:16 +00008461}
8462
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008463
Larry Hastings2f936352014-08-05 14:04:04 +10008464/*[clinic input]
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008465os.dup2 -> int
Larry Hastings2f936352014-08-05 14:04:04 +10008466 fd: int
8467 fd2: int
8468 inheritable: bool=True
8469
8470Duplicate file descriptor.
8471[clinic start generated code]*/
8472
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008473static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008474os_dup2_impl(PyObject *module, int fd, int fd2, int inheritable)
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008475/*[clinic end generated code: output=bc059d34a73404d1 input=c3cddda8922b038d]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008476{
Stéphane Wirtel3d86e482018-01-30 07:04:36 +01008477 int res = 0;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008478#if defined(HAVE_DUP3) && \
8479 !(defined(HAVE_FCNTL_H) && defined(F_DUP2FD_CLOEXEC))
8480 /* dup3() is available on Linux 2.6.27+ and glibc 2.9 */
Alexey Izbyshevb3caf382018-02-20 10:25:46 +03008481 static int dup3_works = -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008482#endif
8483
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008484 if (fd < 0 || fd2 < 0) {
8485 posix_error();
8486 return -1;
8487 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02008488
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008489 /* dup2() can fail with EINTR if the target FD is already open, because it
8490 * then has to be closed. See os_close_impl() for why we don't handle EINTR
8491 * upon close(), and therefore below.
8492 */
Victor Stinnerdaf45552013-08-28 00:53:59 +02008493#ifdef MS_WINDOWS
8494 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04008495 _Py_BEGIN_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00008496 res = dup2(fd, fd2);
Steve Dower8fc89802015-04-12 00:26:27 -04008497 _Py_END_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02008498 Py_END_ALLOW_THREADS
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008499 if (res < 0) {
8500 posix_error();
8501 return -1;
8502 }
8503 res = fd2; // msvcrt dup2 returns 0 on success.
Victor Stinnerdaf45552013-08-28 00:53:59 +02008504
8505 /* Character files like console cannot be make non-inheritable */
8506 if (!inheritable && _Py_set_inheritable(fd2, 0, NULL) < 0) {
8507 close(fd2);
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008508 return -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008509 }
8510
8511#elif defined(HAVE_FCNTL_H) && defined(F_DUP2FD_CLOEXEC)
8512 Py_BEGIN_ALLOW_THREADS
8513 if (!inheritable)
8514 res = fcntl(fd, F_DUP2FD_CLOEXEC, fd2);
8515 else
8516 res = dup2(fd, fd2);
8517 Py_END_ALLOW_THREADS
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008518 if (res < 0) {
8519 posix_error();
8520 return -1;
8521 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02008522
8523#else
8524
8525#ifdef HAVE_DUP3
8526 if (!inheritable && dup3_works != 0) {
8527 Py_BEGIN_ALLOW_THREADS
8528 res = dup3(fd, fd2, O_CLOEXEC);
8529 Py_END_ALLOW_THREADS
8530 if (res < 0) {
8531 if (dup3_works == -1)
8532 dup3_works = (errno != ENOSYS);
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008533 if (dup3_works) {
8534 posix_error();
8535 return -1;
8536 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02008537 }
8538 }
8539
8540 if (inheritable || dup3_works == 0)
8541 {
8542#endif
8543 Py_BEGIN_ALLOW_THREADS
8544 res = dup2(fd, fd2);
8545 Py_END_ALLOW_THREADS
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008546 if (res < 0) {
8547 posix_error();
8548 return -1;
8549 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02008550
8551 if (!inheritable && _Py_set_inheritable(fd2, 0, NULL) < 0) {
8552 close(fd2);
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008553 return -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008554 }
8555#ifdef HAVE_DUP3
8556 }
8557#endif
8558
8559#endif
8560
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008561 return res;
Guido van Rossum687dd131993-05-17 08:34:16 +00008562}
8563
Larry Hastings2f936352014-08-05 14:04:04 +10008564
Ross Lagerwall7807c352011-03-17 20:20:30 +02008565#ifdef HAVE_LOCKF
Larry Hastings2f936352014-08-05 14:04:04 +10008566/*[clinic input]
8567os.lockf
8568
8569 fd: int
8570 An open file descriptor.
8571 command: int
8572 One of F_LOCK, F_TLOCK, F_ULOCK or F_TEST.
8573 length: Py_off_t
8574 The number of bytes to lock, starting at the current position.
8575 /
8576
8577Apply, test or remove a POSIX lock on an open file descriptor.
8578
8579[clinic start generated code]*/
8580
Larry Hastings2f936352014-08-05 14:04:04 +10008581static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008582os_lockf_impl(PyObject *module, int fd, int command, Py_off_t length)
8583/*[clinic end generated code: output=af7051f3e7c29651 input=65da41d2106e9b79]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008584{
8585 int res;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008586
8587 Py_BEGIN_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10008588 res = lockf(fd, command, length);
Ross Lagerwall7807c352011-03-17 20:20:30 +02008589 Py_END_ALLOW_THREADS
8590
8591 if (res < 0)
8592 return posix_error();
8593
8594 Py_RETURN_NONE;
8595}
Larry Hastings2f936352014-08-05 14:04:04 +10008596#endif /* HAVE_LOCKF */
Ross Lagerwall7807c352011-03-17 20:20:30 +02008597
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008598
Larry Hastings2f936352014-08-05 14:04:04 +10008599/*[clinic input]
8600os.lseek -> Py_off_t
8601
8602 fd: int
8603 position: Py_off_t
8604 how: int
8605 /
8606
8607Set the position of a file descriptor. Return the new position.
8608
8609Return the new cursor position in number of bytes
8610relative to the beginning of the file.
8611[clinic start generated code]*/
8612
Larry Hastings2f936352014-08-05 14:04:04 +10008613static Py_off_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008614os_lseek_impl(PyObject *module, int fd, Py_off_t position, int how)
8615/*[clinic end generated code: output=971e1efb6b30bd2f input=902654ad3f96a6d3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008616{
8617 Py_off_t result;
8618
Guido van Rossum687dd131993-05-17 08:34:16 +00008619#ifdef SEEK_SET
Victor Stinner8c62be82010-05-06 00:08:46 +00008620 /* Turn 0, 1, 2 into SEEK_{SET,CUR,END} */
8621 switch (how) {
Larry Hastings2f936352014-08-05 14:04:04 +10008622 case 0: how = SEEK_SET; break;
8623 case 1: how = SEEK_CUR; break;
8624 case 2: how = SEEK_END; break;
Victor Stinner8c62be82010-05-06 00:08:46 +00008625 }
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00008626#endif /* SEEK_END */
Guido van Rossum94f6f721999-01-06 18:42:14 +00008627
Victor Stinner8c62be82010-05-06 00:08:46 +00008628 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04008629 _Py_BEGIN_SUPPRESS_IPH
Victor Stinner14b9b112013-06-25 00:37:25 +02008630#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10008631 result = _lseeki64(fd, position, how);
Fred Drake699f3522000-06-29 21:12:41 +00008632#else
Larry Hastings2f936352014-08-05 14:04:04 +10008633 result = lseek(fd, position, how);
Fred Drake699f3522000-06-29 21:12:41 +00008634#endif
Steve Dower8fc89802015-04-12 00:26:27 -04008635 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00008636 Py_END_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10008637 if (result < 0)
8638 posix_error();
Guido van Rossum94f6f721999-01-06 18:42:14 +00008639
Larry Hastings2f936352014-08-05 14:04:04 +10008640 return result;
Guido van Rossum687dd131993-05-17 08:34:16 +00008641}
8642
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008643
Larry Hastings2f936352014-08-05 14:04:04 +10008644/*[clinic input]
8645os.read
8646 fd: int
8647 length: Py_ssize_t
8648 /
8649
8650Read from a file descriptor. Returns a bytes object.
8651[clinic start generated code]*/
8652
Larry Hastings2f936352014-08-05 14:04:04 +10008653static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008654os_read_impl(PyObject *module, int fd, Py_ssize_t length)
8655/*[clinic end generated code: output=dafbe9a5cddb987b input=1df2eaa27c0bf1d3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008656{
Victor Stinner8c62be82010-05-06 00:08:46 +00008657 Py_ssize_t n;
8658 PyObject *buffer;
Larry Hastings2f936352014-08-05 14:04:04 +10008659
8660 if (length < 0) {
Victor Stinner8c62be82010-05-06 00:08:46 +00008661 errno = EINVAL;
8662 return posix_error();
8663 }
Larry Hastings2f936352014-08-05 14:04:04 +10008664
Victor Stinner9a0d7a72018-11-22 15:03:40 +01008665 length = Py_MIN(length, _PY_READ_MAX);
Larry Hastings2f936352014-08-05 14:04:04 +10008666
8667 buffer = PyBytes_FromStringAndSize((char *)NULL, length);
Victor Stinner8c62be82010-05-06 00:08:46 +00008668 if (buffer == NULL)
8669 return NULL;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008670
Victor Stinner66aab0c2015-03-19 22:53:20 +01008671 n = _Py_read(fd, PyBytes_AS_STRING(buffer), length);
8672 if (n == -1) {
Victor Stinner8c62be82010-05-06 00:08:46 +00008673 Py_DECREF(buffer);
Victor Stinner66aab0c2015-03-19 22:53:20 +01008674 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00008675 }
Larry Hastings2f936352014-08-05 14:04:04 +10008676
8677 if (n != length)
Victor Stinner8c62be82010-05-06 00:08:46 +00008678 _PyBytes_Resize(&buffer, n);
Larry Hastings2f936352014-08-05 14:04:04 +10008679
Victor Stinner8c62be82010-05-06 00:08:46 +00008680 return buffer;
Guido van Rossum687dd131993-05-17 08:34:16 +00008681}
8682
Ross Lagerwall7807c352011-03-17 20:20:30 +02008683#if (defined(HAVE_SENDFILE) && (defined(__FreeBSD__) || defined(__DragonFly__) \
Serhiy Storchaka9d572732018-07-31 10:24:54 +03008684 || defined(__APPLE__))) \
8685 || defined(HAVE_READV) || defined(HAVE_PREADV) || defined (HAVE_PREADV2) \
8686 || defined(HAVE_WRITEV) || defined(HAVE_PWRITEV) || defined (HAVE_PWRITEV2)
8687static int
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008688iov_setup(struct iovec **iov, Py_buffer **buf, PyObject *seq, Py_ssize_t cnt, int type)
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008689{
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008690 Py_ssize_t i, j;
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00008691
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008692 *iov = PyMem_New(struct iovec, cnt);
8693 if (*iov == NULL) {
8694 PyErr_NoMemory();
Victor Stinner57ddf782014-01-08 15:21:28 +01008695 return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008696 }
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00008697
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008698 *buf = PyMem_New(Py_buffer, cnt);
8699 if (*buf == NULL) {
8700 PyMem_Del(*iov);
8701 PyErr_NoMemory();
Victor Stinner57ddf782014-01-08 15:21:28 +01008702 return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008703 }
8704
8705 for (i = 0; i < cnt; i++) {
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02008706 PyObject *item = PySequence_GetItem(seq, i);
8707 if (item == NULL)
8708 goto fail;
8709 if (PyObject_GetBuffer(item, &(*buf)[i], type) == -1) {
8710 Py_DECREF(item);
8711 goto fail;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008712 }
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02008713 Py_DECREF(item);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008714 (*iov)[i].iov_base = (*buf)[i].buf;
Serhiy Storchaka9d572732018-07-31 10:24:54 +03008715 (*iov)[i].iov_len = (*buf)[i].len;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008716 }
Serhiy Storchaka9d572732018-07-31 10:24:54 +03008717 return 0;
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02008718
8719fail:
8720 PyMem_Del(*iov);
8721 for (j = 0; j < i; j++) {
8722 PyBuffer_Release(&(*buf)[j]);
8723 }
8724 PyMem_Del(*buf);
Victor Stinner57ddf782014-01-08 15:21:28 +01008725 return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008726}
8727
8728static void
8729iov_cleanup(struct iovec *iov, Py_buffer *buf, int cnt)
8730{
8731 int i;
8732 PyMem_Del(iov);
8733 for (i = 0; i < cnt; i++) {
8734 PyBuffer_Release(&buf[i]);
8735 }
8736 PyMem_Del(buf);
8737}
8738#endif
8739
Larry Hastings2f936352014-08-05 14:04:04 +10008740
Ross Lagerwall7807c352011-03-17 20:20:30 +02008741#ifdef HAVE_READV
Larry Hastings2f936352014-08-05 14:04:04 +10008742/*[clinic input]
8743os.readv -> Py_ssize_t
8744
8745 fd: int
8746 buffers: object
8747 /
8748
8749Read from a file descriptor fd into an iterable of buffers.
8750
8751The buffers should be mutable buffers accepting bytes.
8752readv will transfer data into each buffer until it is full
8753and then move on to the next buffer in the sequence to hold
8754the rest of the data.
8755
8756readv returns the total number of bytes read,
8757which may be less than the total capacity of all the buffers.
8758[clinic start generated code]*/
8759
Larry Hastings2f936352014-08-05 14:04:04 +10008760static Py_ssize_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008761os_readv_impl(PyObject *module, int fd, PyObject *buffers)
8762/*[clinic end generated code: output=792da062d3fcebdb input=e679eb5dbfa0357d]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008763{
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008764 Py_ssize_t cnt, n;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008765 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008766 struct iovec *iov;
8767 Py_buffer *buf;
8768
Larry Hastings2f936352014-08-05 14:04:04 +10008769 if (!PySequence_Check(buffers)) {
Ross Lagerwall7807c352011-03-17 20:20:30 +02008770 PyErr_SetString(PyExc_TypeError,
8771 "readv() arg 2 must be a sequence");
Larry Hastings2f936352014-08-05 14:04:04 +10008772 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008773 }
Ross Lagerwall7807c352011-03-17 20:20:30 +02008774
Larry Hastings2f936352014-08-05 14:04:04 +10008775 cnt = PySequence_Size(buffers);
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008776 if (cnt < 0)
8777 return -1;
Larry Hastings2f936352014-08-05 14:04:04 +10008778
8779 if (iov_setup(&iov, &buf, buffers, cnt, PyBUF_WRITABLE) < 0)
8780 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008781
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008782 do {
8783 Py_BEGIN_ALLOW_THREADS
8784 n = readv(fd, iov, cnt);
8785 Py_END_ALLOW_THREADS
8786 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Ross Lagerwall7807c352011-03-17 20:20:30 +02008787
8788 iov_cleanup(iov, buf, cnt);
Larry Hastings2f936352014-08-05 14:04:04 +10008789 if (n < 0) {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008790 if (!async_err)
8791 posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10008792 return -1;
8793 }
Victor Stinner57ddf782014-01-08 15:21:28 +01008794
Larry Hastings2f936352014-08-05 14:04:04 +10008795 return n;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008796}
Larry Hastings2f936352014-08-05 14:04:04 +10008797#endif /* HAVE_READV */
8798
Ross Lagerwall7807c352011-03-17 20:20:30 +02008799
8800#ifdef HAVE_PREAD
Larry Hastings2f936352014-08-05 14:04:04 +10008801/*[clinic input]
8802# TODO length should be size_t! but Python doesn't support parsing size_t yet.
8803os.pread
8804
8805 fd: int
8806 length: int
8807 offset: Py_off_t
8808 /
8809
8810Read a number of bytes from a file descriptor starting at a particular offset.
8811
8812Read length bytes from file descriptor fd, starting at offset bytes from
8813the beginning of the file. The file offset remains unchanged.
8814[clinic start generated code]*/
8815
Larry Hastings2f936352014-08-05 14:04:04 +10008816static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008817os_pread_impl(PyObject *module, int fd, int length, Py_off_t offset)
8818/*[clinic end generated code: output=435b29ee32b54a78 input=084948dcbaa35d4c]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008819{
Ross Lagerwall7807c352011-03-17 20:20:30 +02008820 Py_ssize_t n;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008821 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008822 PyObject *buffer;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008823
Larry Hastings2f936352014-08-05 14:04:04 +10008824 if (length < 0) {
Ross Lagerwall7807c352011-03-17 20:20:30 +02008825 errno = EINVAL;
8826 return posix_error();
8827 }
Larry Hastings2f936352014-08-05 14:04:04 +10008828 buffer = PyBytes_FromStringAndSize((char *)NULL, length);
Ross Lagerwall7807c352011-03-17 20:20:30 +02008829 if (buffer == NULL)
8830 return NULL;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008831
8832 do {
8833 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04008834 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008835 n = pread(fd, PyBytes_AS_STRING(buffer), length, offset);
Steve Dower8fc89802015-04-12 00:26:27 -04008836 _Py_END_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008837 Py_END_ALLOW_THREADS
8838 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
8839
Ross Lagerwall7807c352011-03-17 20:20:30 +02008840 if (n < 0) {
8841 Py_DECREF(buffer);
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008842 return (!async_err) ? posix_error() : NULL;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008843 }
Larry Hastings2f936352014-08-05 14:04:04 +10008844 if (n != length)
Ross Lagerwall7807c352011-03-17 20:20:30 +02008845 _PyBytes_Resize(&buffer, n);
8846 return buffer;
8847}
Larry Hastings2f936352014-08-05 14:04:04 +10008848#endif /* HAVE_PREAD */
Ross Lagerwall7807c352011-03-17 20:20:30 +02008849
Pablo Galindo4defba32018-01-27 16:16:37 +00008850#if defined(HAVE_PREADV) || defined (HAVE_PREADV2)
8851/*[clinic input]
8852os.preadv -> Py_ssize_t
8853
8854 fd: int
8855 buffers: object
8856 offset: Py_off_t
8857 flags: int = 0
8858 /
8859
8860Reads from a file descriptor into a number of mutable bytes-like objects.
8861
8862Combines the functionality of readv() and pread(). As readv(), it will
8863transfer data into each buffer until it is full and then move on to the next
8864buffer in the sequence to hold the rest of the data. Its fourth argument,
8865specifies the file offset at which the input operation is to be performed. It
8866will return the total number of bytes read (which can be less than the total
8867capacity of all the objects).
8868
8869The flags argument contains a bitwise OR of zero or more of the following flags:
8870
8871- RWF_HIPRI
8872- RWF_NOWAIT
8873
8874Using non-zero flags requires Linux 4.6 or newer.
8875[clinic start generated code]*/
8876
8877static Py_ssize_t
8878os_preadv_impl(PyObject *module, int fd, PyObject *buffers, Py_off_t offset,
8879 int flags)
8880/*[clinic end generated code: output=26fc9c6e58e7ada5 input=4173919dc1f7ed99]*/
8881{
8882 Py_ssize_t cnt, n;
8883 int async_err = 0;
8884 struct iovec *iov;
8885 Py_buffer *buf;
8886
8887 if (!PySequence_Check(buffers)) {
8888 PyErr_SetString(PyExc_TypeError,
8889 "preadv2() arg 2 must be a sequence");
8890 return -1;
8891 }
8892
8893 cnt = PySequence_Size(buffers);
8894 if (cnt < 0) {
8895 return -1;
8896 }
8897
8898#ifndef HAVE_PREADV2
8899 if(flags != 0) {
8900 argument_unavailable_error("preadv2", "flags");
8901 return -1;
8902 }
8903#endif
8904
8905 if (iov_setup(&iov, &buf, buffers, cnt, PyBUF_WRITABLE) < 0) {
8906 return -1;
8907 }
8908#ifdef HAVE_PREADV2
8909 do {
8910 Py_BEGIN_ALLOW_THREADS
8911 _Py_BEGIN_SUPPRESS_IPH
8912 n = preadv2(fd, iov, cnt, offset, flags);
8913 _Py_END_SUPPRESS_IPH
8914 Py_END_ALLOW_THREADS
8915 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
8916#else
8917 do {
8918 Py_BEGIN_ALLOW_THREADS
8919 _Py_BEGIN_SUPPRESS_IPH
8920 n = preadv(fd, iov, cnt, offset);
8921 _Py_END_SUPPRESS_IPH
8922 Py_END_ALLOW_THREADS
8923 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
8924#endif
8925
8926 iov_cleanup(iov, buf, cnt);
8927 if (n < 0) {
8928 if (!async_err) {
8929 posix_error();
8930 }
8931 return -1;
8932 }
8933
8934 return n;
8935}
8936#endif /* HAVE_PREADV */
8937
Larry Hastings2f936352014-08-05 14:04:04 +10008938
8939/*[clinic input]
8940os.write -> Py_ssize_t
8941
8942 fd: int
8943 data: Py_buffer
8944 /
8945
8946Write a bytes object to a file descriptor.
8947[clinic start generated code]*/
8948
Larry Hastings2f936352014-08-05 14:04:04 +10008949static Py_ssize_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008950os_write_impl(PyObject *module, int fd, Py_buffer *data)
8951/*[clinic end generated code: output=e4ef5bc904b58ef9 input=3207e28963234f3c]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008952{
Victor Stinner66aab0c2015-03-19 22:53:20 +01008953 return _Py_write(fd, data->buf, data->len);
Ross Lagerwall7807c352011-03-17 20:20:30 +02008954}
8955
8956#ifdef HAVE_SENDFILE
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008957PyDoc_STRVAR(posix_sendfile__doc__,
Martin Panterbf19d162015-09-09 01:01:13 +00008958"sendfile(out, in, offset, count) -> byteswritten\n\
Martin Panter94994132015-09-09 05:29:24 +00008959sendfile(out, in, offset, count[, headers][, trailers], flags=0)\n\
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008960 -> byteswritten\n\
Martin Panterbf19d162015-09-09 01:01:13 +00008961Copy count bytes from file descriptor in to file descriptor out.");
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008962
Larry Hastings2f936352014-08-05 14:04:04 +10008963/* AC 3.5: don't bother converting, has optional group*/
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008964static PyObject *
8965posix_sendfile(PyObject *self, PyObject *args, PyObject *kwdict)
8966{
8967 int in, out;
8968 Py_ssize_t ret;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008969 int async_err = 0;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008970 off_t offset;
8971
8972#if defined(__FreeBSD__) || defined(__DragonFly__) || defined(__APPLE__)
8973#ifndef __APPLE__
8974 Py_ssize_t len;
8975#endif
8976 PyObject *headers = NULL, *trailers = NULL;
8977 Py_buffer *hbuf, *tbuf;
8978 off_t sbytes;
8979 struct sf_hdtr sf;
8980 int flags = 0;
Martin Panterbf19d162015-09-09 01:01:13 +00008981 /* Beware that "in" clashes with Python's own "in" operator keyword */
Benjamin Petersond8a43b42011-02-26 21:35:16 +00008982 static char *keywords[] = {"out", "in",
8983 "offset", "count",
8984 "headers", "trailers", "flags", NULL};
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008985
Victor Stinner6ce0dbf2013-07-07 16:32:36 +02008986 sf.headers = NULL;
8987 sf.trailers = NULL;
8988
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008989#ifdef __APPLE__
8990 if (!PyArg_ParseTupleAndKeywords(args, kwdict, "iiO&O&|OOi:sendfile",
Larry Hastings2f936352014-08-05 14:04:04 +10008991 keywords, &out, &in, Py_off_t_converter, &offset, Py_off_t_converter, &sbytes,
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008992#else
8993 if (!PyArg_ParseTupleAndKeywords(args, kwdict, "iiO&n|OOi:sendfile",
Larry Hastings2f936352014-08-05 14:04:04 +10008994 keywords, &out, &in, Py_off_t_converter, &offset, &len,
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008995#endif
8996 &headers, &trailers, &flags))
8997 return NULL;
8998 if (headers != NULL) {
8999 if (!PySequence_Check(headers)) {
9000 PyErr_SetString(PyExc_TypeError,
Martin Panter94994132015-09-09 05:29:24 +00009001 "sendfile() headers must be a sequence");
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009002 return NULL;
9003 } else {
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009004 Py_ssize_t i = PySequence_Size(headers);
9005 if (i < 0)
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009006 return NULL;
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009007 if (i > INT_MAX) {
9008 PyErr_SetString(PyExc_OverflowError,
9009 "sendfile() header is too large");
9010 return NULL;
9011 }
9012 if (i > 0) {
9013 sf.hdr_cnt = (int)i;
Serhiy Storchaka9d572732018-07-31 10:24:54 +03009014 if (iov_setup(&(sf.headers), &hbuf,
9015 headers, sf.hdr_cnt, PyBUF_SIMPLE) < 0)
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009016 return NULL;
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00009017#ifdef __APPLE__
Serhiy Storchaka9d572732018-07-31 10:24:54 +03009018 for (i = 0; i < sf.hdr_cnt; i++) {
9019 Py_ssize_t blen = sf.headers[i].iov_len;
9020# define OFF_T_MAX 0x7fffffffffffffff
9021 if (sbytes >= OFF_T_MAX - blen) {
9022 PyErr_SetString(PyExc_OverflowError,
9023 "sendfile() header is too large");
9024 return NULL;
9025 }
9026 sbytes += blen;
9027 }
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00009028#endif
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009029 }
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009030 }
9031 }
9032 if (trailers != NULL) {
9033 if (!PySequence_Check(trailers)) {
9034 PyErr_SetString(PyExc_TypeError,
Martin Panter94994132015-09-09 05:29:24 +00009035 "sendfile() trailers must be a sequence");
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009036 return NULL;
9037 } else {
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009038 Py_ssize_t i = PySequence_Size(trailers);
9039 if (i < 0)
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009040 return NULL;
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009041 if (i > INT_MAX) {
9042 PyErr_SetString(PyExc_OverflowError,
9043 "sendfile() trailer is too large");
9044 return NULL;
9045 }
9046 if (i > 0) {
9047 sf.trl_cnt = (int)i;
Serhiy Storchaka9d572732018-07-31 10:24:54 +03009048 if (iov_setup(&(sf.trailers), &tbuf,
9049 trailers, sf.trl_cnt, PyBUF_SIMPLE) < 0)
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009050 return NULL;
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009051 }
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009052 }
9053 }
9054
Steve Dower8fc89802015-04-12 00:26:27 -04009055 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009056 do {
9057 Py_BEGIN_ALLOW_THREADS
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009058#ifdef __APPLE__
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009059 ret = sendfile(in, out, offset, &sbytes, &sf, flags);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009060#else
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009061 ret = sendfile(in, out, offset, len, &sf, &sbytes, flags);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009062#endif
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009063 Py_END_ALLOW_THREADS
9064 } while (ret < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Steve Dower8fc89802015-04-12 00:26:27 -04009065 _Py_END_SUPPRESS_IPH
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009066
9067 if (sf.headers != NULL)
9068 iov_cleanup(sf.headers, hbuf, sf.hdr_cnt);
9069 if (sf.trailers != NULL)
9070 iov_cleanup(sf.trailers, tbuf, sf.trl_cnt);
9071
9072 if (ret < 0) {
9073 if ((errno == EAGAIN) || (errno == EBUSY)) {
9074 if (sbytes != 0) {
9075 // some data has been sent
9076 goto done;
9077 }
9078 else {
9079 // no data has been sent; upper application is supposed
9080 // to retry on EAGAIN or EBUSY
9081 return posix_error();
9082 }
9083 }
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009084 return (!async_err) ? posix_error() : NULL;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009085 }
9086 goto done;
9087
9088done:
9089 #if !defined(HAVE_LARGEFILE_SUPPORT)
9090 return Py_BuildValue("l", sbytes);
9091 #else
9092 return Py_BuildValue("L", sbytes);
9093 #endif
9094
9095#else
9096 Py_ssize_t count;
9097 PyObject *offobj;
9098 static char *keywords[] = {"out", "in",
9099 "offset", "count", NULL};
9100 if (!PyArg_ParseTupleAndKeywords(args, kwdict, "iiOn:sendfile",
9101 keywords, &out, &in, &offobj, &count))
9102 return NULL;
Benjamin Peterson840ef8f2016-09-07 14:45:10 -07009103#ifdef __linux__
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009104 if (offobj == Py_None) {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009105 do {
9106 Py_BEGIN_ALLOW_THREADS
9107 ret = sendfile(out, in, NULL, count);
9108 Py_END_ALLOW_THREADS
9109 } while (ret < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009110 if (ret < 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009111 return (!async_err) ? posix_error() : NULL;
Giampaolo Rodola'ff1a7352011-04-19 09:47:16 +02009112 return Py_BuildValue("n", ret);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009113 }
9114#endif
Larry Hastings2f936352014-08-05 14:04:04 +10009115 if (!Py_off_t_converter(offobj, &offset))
Antoine Pitroudcc20b82011-02-26 13:38:35 +00009116 return NULL;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009117
9118 do {
9119 Py_BEGIN_ALLOW_THREADS
9120 ret = sendfile(out, in, &offset, count);
9121 Py_END_ALLOW_THREADS
9122 } while (ret < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009123 if (ret < 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009124 return (!async_err) ? posix_error() : NULL;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00009125 return Py_BuildValue("n", ret);
9126#endif
9127}
Larry Hastings2f936352014-08-05 14:04:04 +10009128#endif /* HAVE_SENDFILE */
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00009129
Larry Hastings2f936352014-08-05 14:04:04 +10009130
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +02009131#if defined(__APPLE__)
9132/*[clinic input]
9133os._fcopyfile
9134
9135 infd: int
9136 outfd: int
9137 flags: int
9138 /
9139
Giampaolo Rodolac7f02a92018-06-19 08:27:29 -07009140Efficiently copy content or metadata of 2 regular file descriptors (macOS).
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +02009141[clinic start generated code]*/
9142
9143static PyObject *
9144os__fcopyfile_impl(PyObject *module, int infd, int outfd, int flags)
Giampaolo Rodolac7f02a92018-06-19 08:27:29 -07009145/*[clinic end generated code: output=8e8885c721ec38e3 input=69e0770e600cb44f]*/
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +02009146{
9147 int ret;
9148
9149 Py_BEGIN_ALLOW_THREADS
9150 ret = fcopyfile(infd, outfd, NULL, flags);
9151 Py_END_ALLOW_THREADS
9152 if (ret < 0)
9153 return posix_error();
9154 Py_RETURN_NONE;
9155}
9156#endif
9157
9158
Larry Hastings2f936352014-08-05 14:04:04 +10009159/*[clinic input]
9160os.fstat
9161
9162 fd : int
9163
9164Perform a stat system call on the given file descriptor.
9165
9166Like stat(), but for an open file descriptor.
9167Equivalent to os.stat(fd).
9168[clinic start generated code]*/
9169
Larry Hastings2f936352014-08-05 14:04:04 +10009170static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009171os_fstat_impl(PyObject *module, int fd)
9172/*[clinic end generated code: output=efc038cb5f654492 input=27e0e0ebbe5600c9]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009173{
Victor Stinner8c62be82010-05-06 00:08:46 +00009174 STRUCT_STAT st;
9175 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009176 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10009177
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009178 do {
9179 Py_BEGIN_ALLOW_THREADS
9180 res = FSTAT(fd, &st);
9181 Py_END_ALLOW_THREADS
9182 } while (res != 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Victor Stinner8c62be82010-05-06 00:08:46 +00009183 if (res != 0) {
Martin v. Löwis14694662006-02-03 12:54:16 +00009184#ifdef MS_WINDOWS
Victor Stinnerb024e842012-10-31 22:24:06 +01009185 return PyErr_SetFromWindowsErr(0);
Martin v. Löwis14694662006-02-03 12:54:16 +00009186#else
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009187 return (!async_err) ? posix_error() : NULL;
Martin v. Löwis14694662006-02-03 12:54:16 +00009188#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00009189 }
Tim Peters5aa91602002-01-30 05:46:57 +00009190
Victor Stinner4195b5c2012-02-08 23:03:19 +01009191 return _pystat_fromstructstat(&st);
Guido van Rossum687dd131993-05-17 08:34:16 +00009192}
9193
Larry Hastings2f936352014-08-05 14:04:04 +10009194
9195/*[clinic input]
9196os.isatty -> bool
9197 fd: int
9198 /
9199
9200Return True if the fd is connected to a terminal.
9201
9202Return True if the file descriptor is an open file descriptor
9203connected to the slave end of a terminal.
9204[clinic start generated code]*/
9205
Larry Hastings2f936352014-08-05 14:04:04 +10009206static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009207os_isatty_impl(PyObject *module, int fd)
9208/*[clinic end generated code: output=6a48c8b4e644ca00 input=08ce94aa1eaf7b5e]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009209{
Steve Dower8fc89802015-04-12 00:26:27 -04009210 int return_value;
Steve Dower8fc89802015-04-12 00:26:27 -04009211 _Py_BEGIN_SUPPRESS_IPH
9212 return_value = isatty(fd);
9213 _Py_END_SUPPRESS_IPH
9214 return return_value;
Larry Hastings2f936352014-08-05 14:04:04 +10009215}
9216
9217
Guido van Rossuma4916fa1996-05-23 22:58:55 +00009218#ifdef HAVE_PIPE
Larry Hastings2f936352014-08-05 14:04:04 +10009219/*[clinic input]
9220os.pipe
9221
9222Create a pipe.
9223
9224Returns a tuple of two file descriptors:
9225 (read_fd, write_fd)
9226[clinic start generated code]*/
9227
Larry Hastings2f936352014-08-05 14:04:04 +10009228static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009229os_pipe_impl(PyObject *module)
9230/*[clinic end generated code: output=ff9b76255793b440 input=02535e8c8fa6c4d4]*/
Guido van Rossum687dd131993-05-17 08:34:16 +00009231{
Victor Stinner8c62be82010-05-06 00:08:46 +00009232 int fds[2];
Victor Stinnerdaf45552013-08-28 00:53:59 +02009233#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00009234 HANDLE read, write;
Victor Stinnerdaf45552013-08-28 00:53:59 +02009235 SECURITY_ATTRIBUTES attr;
Victor Stinner8c62be82010-05-06 00:08:46 +00009236 BOOL ok;
Victor Stinnerdaf45552013-08-28 00:53:59 +02009237#else
9238 int res;
9239#endif
9240
9241#ifdef MS_WINDOWS
9242 attr.nLength = sizeof(attr);
9243 attr.lpSecurityDescriptor = NULL;
9244 attr.bInheritHandle = FALSE;
9245
9246 Py_BEGIN_ALLOW_THREADS
Steve Dowerc3630612016-11-19 18:41:16 -08009247 _Py_BEGIN_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02009248 ok = CreatePipe(&read, &write, &attr, 0);
9249 if (ok) {
Benjamin Petersonca470632016-09-06 13:47:26 -07009250 fds[0] = _open_osfhandle((intptr_t)read, _O_RDONLY);
9251 fds[1] = _open_osfhandle((intptr_t)write, _O_WRONLY);
Victor Stinnerdaf45552013-08-28 00:53:59 +02009252 if (fds[0] == -1 || fds[1] == -1) {
9253 CloseHandle(read);
9254 CloseHandle(write);
9255 ok = 0;
9256 }
9257 }
Steve Dowerc3630612016-11-19 18:41:16 -08009258 _Py_END_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02009259 Py_END_ALLOW_THREADS
9260
Victor Stinner8c62be82010-05-06 00:08:46 +00009261 if (!ok)
Victor Stinnerb024e842012-10-31 22:24:06 +01009262 return PyErr_SetFromWindowsErr(0);
Victor Stinnerdaf45552013-08-28 00:53:59 +02009263#else
9264
9265#ifdef HAVE_PIPE2
9266 Py_BEGIN_ALLOW_THREADS
9267 res = pipe2(fds, O_CLOEXEC);
9268 Py_END_ALLOW_THREADS
9269
9270 if (res != 0 && errno == ENOSYS)
9271 {
9272#endif
9273 Py_BEGIN_ALLOW_THREADS
9274 res = pipe(fds);
9275 Py_END_ALLOW_THREADS
9276
9277 if (res == 0) {
9278 if (_Py_set_inheritable(fds[0], 0, NULL) < 0) {
9279 close(fds[0]);
9280 close(fds[1]);
9281 return NULL;
9282 }
9283 if (_Py_set_inheritable(fds[1], 0, NULL) < 0) {
9284 close(fds[0]);
9285 close(fds[1]);
9286 return NULL;
9287 }
9288 }
9289#ifdef HAVE_PIPE2
9290 }
9291#endif
9292
9293 if (res != 0)
9294 return PyErr_SetFromErrno(PyExc_OSError);
9295#endif /* !MS_WINDOWS */
9296 return Py_BuildValue("(ii)", fds[0], fds[1]);
Guido van Rossum687dd131993-05-17 08:34:16 +00009297}
Guido van Rossuma4916fa1996-05-23 22:58:55 +00009298#endif /* HAVE_PIPE */
9299
Larry Hastings2f936352014-08-05 14:04:04 +10009300
Charles-François Natalidaafdd52011-05-29 20:07:40 +02009301#ifdef HAVE_PIPE2
Larry Hastings2f936352014-08-05 14:04:04 +10009302/*[clinic input]
9303os.pipe2
9304
9305 flags: int
9306 /
9307
9308Create a pipe with flags set atomically.
9309
9310Returns a tuple of two file descriptors:
9311 (read_fd, write_fd)
9312
9313flags can be constructed by ORing together one or more of these values:
9314O_NONBLOCK, O_CLOEXEC.
9315[clinic start generated code]*/
9316
Larry Hastings2f936352014-08-05 14:04:04 +10009317static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009318os_pipe2_impl(PyObject *module, int flags)
9319/*[clinic end generated code: output=25751fb43a45540f input=f261b6e7e63c6817]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009320{
Charles-François Natalidaafdd52011-05-29 20:07:40 +02009321 int fds[2];
9322 int res;
9323
Charles-François Natalidaafdd52011-05-29 20:07:40 +02009324 res = pipe2(fds, flags);
9325 if (res != 0)
9326 return posix_error();
9327 return Py_BuildValue("(ii)", fds[0], fds[1]);
9328}
9329#endif /* HAVE_PIPE2 */
9330
Larry Hastings2f936352014-08-05 14:04:04 +10009331
Ross Lagerwall7807c352011-03-17 20:20:30 +02009332#ifdef HAVE_WRITEV
Larry Hastings2f936352014-08-05 14:04:04 +10009333/*[clinic input]
9334os.writev -> Py_ssize_t
9335 fd: int
9336 buffers: object
9337 /
9338
9339Iterate over buffers, and write the contents of each to a file descriptor.
9340
9341Returns the total number of bytes written.
9342buffers must be a sequence of bytes-like objects.
9343[clinic start generated code]*/
9344
Larry Hastings2f936352014-08-05 14:04:04 +10009345static Py_ssize_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009346os_writev_impl(PyObject *module, int fd, PyObject *buffers)
9347/*[clinic end generated code: output=56565cfac3aac15b input=5b8d17fe4189d2fe]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009348{
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009349 Py_ssize_t cnt;
Larry Hastings2f936352014-08-05 14:04:04 +10009350 Py_ssize_t result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009351 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009352 struct iovec *iov;
9353 Py_buffer *buf;
Larry Hastings2f936352014-08-05 14:04:04 +10009354
9355 if (!PySequence_Check(buffers)) {
Ross Lagerwall7807c352011-03-17 20:20:30 +02009356 PyErr_SetString(PyExc_TypeError,
9357 "writev() arg 2 must be a sequence");
Larry Hastings2f936352014-08-05 14:04:04 +10009358 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009359 }
Larry Hastings2f936352014-08-05 14:04:04 +10009360 cnt = PySequence_Size(buffers);
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03009361 if (cnt < 0)
9362 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009363
Larry Hastings2f936352014-08-05 14:04:04 +10009364 if (iov_setup(&iov, &buf, buffers, cnt, PyBUF_SIMPLE) < 0) {
9365 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009366 }
9367
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009368 do {
9369 Py_BEGIN_ALLOW_THREADS
9370 result = writev(fd, iov, cnt);
9371 Py_END_ALLOW_THREADS
9372 } while (result < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Ross Lagerwall7807c352011-03-17 20:20:30 +02009373
9374 iov_cleanup(iov, buf, cnt);
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009375 if (result < 0 && !async_err)
Larry Hastings2f936352014-08-05 14:04:04 +10009376 posix_error();
Victor Stinner57ddf782014-01-08 15:21:28 +01009377
Georg Brandl306336b2012-06-24 12:55:33 +02009378 return result;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009379}
Larry Hastings2f936352014-08-05 14:04:04 +10009380#endif /* HAVE_WRITEV */
9381
9382
9383#ifdef HAVE_PWRITE
9384/*[clinic input]
9385os.pwrite -> Py_ssize_t
9386
9387 fd: int
9388 buffer: Py_buffer
9389 offset: Py_off_t
9390 /
9391
9392Write bytes to a file descriptor starting at a particular offset.
9393
9394Write buffer to fd, starting at offset bytes from the beginning of
9395the file. Returns the number of bytes writte. Does not change the
9396current file offset.
9397[clinic start generated code]*/
9398
Larry Hastings2f936352014-08-05 14:04:04 +10009399static Py_ssize_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009400os_pwrite_impl(PyObject *module, int fd, Py_buffer *buffer, Py_off_t offset)
9401/*[clinic end generated code: output=c74da630758ee925 input=19903f1b3dd26377]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009402{
9403 Py_ssize_t size;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009404 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10009405
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009406 do {
9407 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04009408 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009409 size = pwrite(fd, buffer->buf, (size_t)buffer->len, offset);
Steve Dower8fc89802015-04-12 00:26:27 -04009410 _Py_END_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009411 Py_END_ALLOW_THREADS
9412 } while (size < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Larry Hastings2f936352014-08-05 14:04:04 +10009413
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009414 if (size < 0 && !async_err)
Larry Hastings2f936352014-08-05 14:04:04 +10009415 posix_error();
9416 return size;
9417}
9418#endif /* HAVE_PWRITE */
9419
Pablo Galindo4defba32018-01-27 16:16:37 +00009420#if defined(HAVE_PWRITEV) || defined (HAVE_PWRITEV2)
9421/*[clinic input]
9422os.pwritev -> Py_ssize_t
9423
9424 fd: int
9425 buffers: object
9426 offset: Py_off_t
9427 flags: int = 0
9428 /
9429
9430Writes the contents of bytes-like objects to a file descriptor at a given offset.
9431
9432Combines the functionality of writev() and pwrite(). All buffers must be a sequence
9433of bytes-like objects. Buffers are processed in array order. Entire contents of first
9434buffer is written before proceeding to second, and so on. The operating system may
9435set a limit (sysconf() value SC_IOV_MAX) on the number of buffers that can be used.
9436This function writes the contents of each object to the file descriptor and returns
9437the total number of bytes written.
9438
9439The flags argument contains a bitwise OR of zero or more of the following flags:
9440
9441- RWF_DSYNC
9442- RWF_SYNC
9443
9444Using non-zero flags requires Linux 4.7 or newer.
9445[clinic start generated code]*/
9446
9447static Py_ssize_t
9448os_pwritev_impl(PyObject *module, int fd, PyObject *buffers, Py_off_t offset,
9449 int flags)
9450/*[clinic end generated code: output=e3dd3e9d11a6a5c7 input=803dc5ddbf0cfd3b]*/
9451{
9452 Py_ssize_t cnt;
9453 Py_ssize_t result;
9454 int async_err = 0;
9455 struct iovec *iov;
9456 Py_buffer *buf;
9457
9458 if (!PySequence_Check(buffers)) {
9459 PyErr_SetString(PyExc_TypeError,
9460 "pwritev() arg 2 must be a sequence");
9461 return -1;
9462 }
9463
9464 cnt = PySequence_Size(buffers);
9465 if (cnt < 0) {
9466 return -1;
9467 }
9468
9469#ifndef HAVE_PWRITEV2
9470 if(flags != 0) {
9471 argument_unavailable_error("pwritev2", "flags");
9472 return -1;
9473 }
9474#endif
9475
9476 if (iov_setup(&iov, &buf, buffers, cnt, PyBUF_SIMPLE) < 0) {
9477 return -1;
9478 }
9479#ifdef HAVE_PWRITEV2
9480 do {
9481 Py_BEGIN_ALLOW_THREADS
9482 _Py_BEGIN_SUPPRESS_IPH
9483 result = pwritev2(fd, iov, cnt, offset, flags);
9484 _Py_END_SUPPRESS_IPH
9485 Py_END_ALLOW_THREADS
9486 } while (result < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
9487#else
9488 do {
9489 Py_BEGIN_ALLOW_THREADS
9490 _Py_BEGIN_SUPPRESS_IPH
9491 result = pwritev(fd, iov, cnt, offset);
9492 _Py_END_SUPPRESS_IPH
9493 Py_END_ALLOW_THREADS
9494 } while (result < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
9495#endif
9496
9497 iov_cleanup(iov, buf, cnt);
9498 if (result < 0) {
9499 if (!async_err) {
9500 posix_error();
9501 }
9502 return -1;
9503 }
9504
9505 return result;
9506}
9507#endif /* HAVE_PWRITEV */
9508
Pablo Galindoaac4d032019-05-31 19:39:47 +01009509#ifdef HAVE_COPY_FILE_RANGE
9510/*[clinic input]
9511
9512os.copy_file_range
9513 src: int
9514 Source file descriptor.
9515 dst: int
9516 Destination file descriptor.
9517 count: Py_ssize_t
9518 Number of bytes to copy.
9519 offset_src: object = None
9520 Starting offset in src.
9521 offset_dst: object = None
9522 Starting offset in dst.
9523
9524Copy count bytes from one file descriptor to another.
9525
9526If offset_src is None, then src is read from the current position;
9527respectively for offset_dst.
9528[clinic start generated code]*/
9529
9530static PyObject *
9531os_copy_file_range_impl(PyObject *module, int src, int dst, Py_ssize_t count,
9532 PyObject *offset_src, PyObject *offset_dst)
9533/*[clinic end generated code: output=1a91713a1d99fc7a input=42fdce72681b25a9]*/
9534{
9535 off_t offset_src_val, offset_dst_val;
9536 off_t *p_offset_src = NULL;
9537 off_t *p_offset_dst = NULL;
9538 Py_ssize_t ret;
9539 int async_err = 0;
9540 /* The flags argument is provided to allow
9541 * for future extensions and currently must be to 0. */
9542 int flags = 0;
Pablo Galindo4defba32018-01-27 16:16:37 +00009543
9544
Pablo Galindoaac4d032019-05-31 19:39:47 +01009545 if (count < 0) {
9546 PyErr_SetString(PyExc_ValueError, "negative value for 'count' not allowed");
9547 return NULL;
9548 }
9549
9550 if (offset_src != Py_None) {
9551 if (!Py_off_t_converter(offset_src, &offset_src_val)) {
9552 return NULL;
9553 }
9554 p_offset_src = &offset_src_val;
9555 }
9556
9557 if (offset_dst != Py_None) {
9558 if (!Py_off_t_converter(offset_dst, &offset_dst_val)) {
9559 return NULL;
9560 }
9561 p_offset_dst = &offset_dst_val;
9562 }
9563
9564 do {
9565 Py_BEGIN_ALLOW_THREADS
9566 ret = copy_file_range(src, p_offset_src, dst, p_offset_dst, count, flags);
9567 Py_END_ALLOW_THREADS
9568 } while (ret < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
9569
9570 if (ret < 0) {
9571 return (!async_err) ? posix_error() : NULL;
9572 }
9573
9574 return PyLong_FromSsize_t(ret);
9575}
9576#endif /* HAVE_COPY_FILE_RANGE*/
Larry Hastings2f936352014-08-05 14:04:04 +10009577
9578#ifdef HAVE_MKFIFO
9579/*[clinic input]
9580os.mkfifo
9581
9582 path: path_t
9583 mode: int=0o666
9584 *
9585 dir_fd: dir_fd(requires='mkfifoat')=None
9586
9587Create a "fifo" (a POSIX named pipe).
9588
9589If dir_fd is not None, it should be a file descriptor open to a directory,
9590 and path should be relative; path will then be relative to that directory.
9591dir_fd may not be implemented on your platform.
9592 If it is unavailable, using it will raise a NotImplementedError.
9593[clinic start generated code]*/
9594
Larry Hastings2f936352014-08-05 14:04:04 +10009595static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009596os_mkfifo_impl(PyObject *module, path_t *path, int mode, int dir_fd)
9597/*[clinic end generated code: output=ce41cfad0e68c940 input=73032e98a36e0e19]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009598{
9599 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009600 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10009601
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009602 do {
9603 Py_BEGIN_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10009604#ifdef HAVE_MKFIFOAT
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009605 if (dir_fd != DEFAULT_DIR_FD)
9606 result = mkfifoat(dir_fd, path->narrow, mode);
9607 else
Ross Lagerwall7807c352011-03-17 20:20:30 +02009608#endif
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009609 result = mkfifo(path->narrow, mode);
9610 Py_END_ALLOW_THREADS
9611 } while (result != 0 && errno == EINTR &&
9612 !(async_err = PyErr_CheckSignals()));
9613 if (result != 0)
9614 return (!async_err) ? posix_error() : NULL;
Larry Hastings2f936352014-08-05 14:04:04 +10009615
9616 Py_RETURN_NONE;
9617}
9618#endif /* HAVE_MKFIFO */
9619
9620
9621#if defined(HAVE_MKNOD) && defined(HAVE_MAKEDEV)
9622/*[clinic input]
9623os.mknod
9624
9625 path: path_t
9626 mode: int=0o600
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +02009627 device: dev_t=0
Larry Hastings2f936352014-08-05 14:04:04 +10009628 *
9629 dir_fd: dir_fd(requires='mknodat')=None
9630
9631Create a node in the file system.
9632
9633Create a node in the file system (file, device special file or named pipe)
9634at path. mode specifies both the permissions to use and the
9635type of node to be created, being combined (bitwise OR) with one of
9636S_IFREG, S_IFCHR, S_IFBLK, and S_IFIFO. If S_IFCHR or S_IFBLK is set on mode,
9637device defines the newly created device special file (probably using
9638os.makedev()). Otherwise device is ignored.
9639
9640If dir_fd is not None, it should be a file descriptor open to a directory,
9641 and path should be relative; path will then be relative to that directory.
9642dir_fd may not be implemented on your platform.
9643 If it is unavailable, using it will raise a NotImplementedError.
9644[clinic start generated code]*/
9645
Larry Hastings2f936352014-08-05 14:04:04 +10009646static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009647os_mknod_impl(PyObject *module, path_t *path, int mode, dev_t device,
Larry Hastings89964c42015-04-14 18:07:59 -04009648 int dir_fd)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009649/*[clinic end generated code: output=92e55d3ca8917461 input=ee44531551a4d83b]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009650{
9651 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009652 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10009653
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009654 do {
9655 Py_BEGIN_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10009656#ifdef HAVE_MKNODAT
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009657 if (dir_fd != DEFAULT_DIR_FD)
9658 result = mknodat(dir_fd, path->narrow, mode, device);
9659 else
Larry Hastings2f936352014-08-05 14:04:04 +10009660#endif
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009661 result = mknod(path->narrow, mode, device);
9662 Py_END_ALLOW_THREADS
9663 } while (result != 0 && errno == EINTR &&
9664 !(async_err = PyErr_CheckSignals()));
9665 if (result != 0)
9666 return (!async_err) ? posix_error() : NULL;
Larry Hastings2f936352014-08-05 14:04:04 +10009667
9668 Py_RETURN_NONE;
9669}
9670#endif /* defined(HAVE_MKNOD) && defined(HAVE_MAKEDEV) */
9671
9672
9673#ifdef HAVE_DEVICE_MACROS
9674/*[clinic input]
9675os.major -> unsigned_int
9676
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +02009677 device: dev_t
Larry Hastings2f936352014-08-05 14:04:04 +10009678 /
9679
9680Extracts a device major number from a raw device number.
9681[clinic start generated code]*/
9682
Larry Hastings2f936352014-08-05 14:04:04 +10009683static unsigned int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009684os_major_impl(PyObject *module, dev_t device)
9685/*[clinic end generated code: output=5b3b2589bafb498e input=1e16a4d30c4d4462]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009686{
9687 return major(device);
9688}
9689
9690
9691/*[clinic input]
9692os.minor -> unsigned_int
9693
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +02009694 device: dev_t
Larry Hastings2f936352014-08-05 14:04:04 +10009695 /
9696
9697Extracts a device minor number from a raw device number.
9698[clinic start generated code]*/
9699
Larry Hastings2f936352014-08-05 14:04:04 +10009700static unsigned int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009701os_minor_impl(PyObject *module, dev_t device)
9702/*[clinic end generated code: output=5e1a25e630b0157d input=0842c6d23f24c65e]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009703{
9704 return minor(device);
9705}
9706
9707
9708/*[clinic input]
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +02009709os.makedev -> dev_t
Larry Hastings2f936352014-08-05 14:04:04 +10009710
9711 major: int
9712 minor: int
9713 /
9714
9715Composes a raw device number from the major and minor device numbers.
9716[clinic start generated code]*/
9717
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +02009718static dev_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009719os_makedev_impl(PyObject *module, int major, int minor)
9720/*[clinic end generated code: output=881aaa4aba6f6a52 input=4b9fd8fc73cbe48f]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009721{
9722 return makedev(major, minor);
9723}
9724#endif /* HAVE_DEVICE_MACROS */
9725
9726
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009727#if defined HAVE_FTRUNCATE || defined MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10009728/*[clinic input]
9729os.ftruncate
9730
9731 fd: int
9732 length: Py_off_t
9733 /
9734
9735Truncate a file, specified by file descriptor, to a specific length.
9736[clinic start generated code]*/
9737
Larry Hastings2f936352014-08-05 14:04:04 +10009738static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009739os_ftruncate_impl(PyObject *module, int fd, Py_off_t length)
9740/*[clinic end generated code: output=fba15523721be7e4 input=63b43641e52818f2]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009741{
9742 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009743 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10009744
Steve Dowerb82e17e2019-05-23 08:45:22 -07009745 if (PySys_Audit("os.truncate", "in", fd, length) < 0) {
9746 return NULL;
9747 }
9748
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009749 do {
9750 Py_BEGIN_ALLOW_THREADS
Steve Dowera1c7e722015-04-12 00:26:43 -04009751 _Py_BEGIN_SUPPRESS_IPH
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009752#ifdef MS_WINDOWS
9753 result = _chsize_s(fd, length);
9754#else
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009755 result = ftruncate(fd, length);
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009756#endif
Steve Dowera1c7e722015-04-12 00:26:43 -04009757 _Py_END_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009758 Py_END_ALLOW_THREADS
9759 } while (result != 0 && errno == EINTR &&
9760 !(async_err = PyErr_CheckSignals()));
9761 if (result != 0)
9762 return (!async_err) ? posix_error() : NULL;
Larry Hastings2f936352014-08-05 14:04:04 +10009763 Py_RETURN_NONE;
9764}
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009765#endif /* HAVE_FTRUNCATE || MS_WINDOWS */
Larry Hastings2f936352014-08-05 14:04:04 +10009766
9767
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009768#if defined HAVE_TRUNCATE || defined MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10009769/*[clinic input]
9770os.truncate
9771 path: path_t(allow_fd='PATH_HAVE_FTRUNCATE')
9772 length: Py_off_t
9773
9774Truncate a file, specified by path, to a specific length.
9775
9776On some platforms, path may also be specified as an open file descriptor.
9777 If this functionality is unavailable, using it raises an exception.
9778[clinic start generated code]*/
9779
Larry Hastings2f936352014-08-05 14:04:04 +10009780static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009781os_truncate_impl(PyObject *module, path_t *path, Py_off_t length)
9782/*[clinic end generated code: output=43009c8df5c0a12b input=77229cf0b50a9b77]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009783{
9784 int result;
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009785#ifdef MS_WINDOWS
9786 int fd;
9787#endif
9788
9789 if (path->fd != -1)
9790 return os_ftruncate_impl(module, path->fd, length);
Larry Hastings2f936352014-08-05 14:04:04 +10009791
Steve Dowerb82e17e2019-05-23 08:45:22 -07009792 if (PySys_Audit("os.truncate", "On", path->object, length) < 0) {
9793 return NULL;
9794 }
9795
Larry Hastings2f936352014-08-05 14:04:04 +10009796 Py_BEGIN_ALLOW_THREADS
Steve Dowera1c7e722015-04-12 00:26:43 -04009797 _Py_BEGIN_SUPPRESS_IPH
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009798#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07009799 fd = _wopen(path->wide, _O_WRONLY | _O_BINARY | _O_NOINHERIT);
Victor Stinnercc0bbbc2015-04-25 00:21:52 +02009800 if (fd < 0)
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009801 result = -1;
9802 else {
9803 result = _chsize_s(fd, length);
9804 close(fd);
9805 if (result < 0)
9806 errno = result;
9807 }
9808#else
9809 result = truncate(path->narrow, length);
Larry Hastings2f936352014-08-05 14:04:04 +10009810#endif
Steve Dowera1c7e722015-04-12 00:26:43 -04009811 _Py_END_SUPPRESS_IPH
Larry Hastings2f936352014-08-05 14:04:04 +10009812 Py_END_ALLOW_THREADS
9813 if (result < 0)
Alexey Izbyshev83460312018-10-20 03:28:22 +03009814 return posix_path_error(path);
Larry Hastings2f936352014-08-05 14:04:04 +10009815
9816 Py_RETURN_NONE;
9817}
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009818#endif /* HAVE_TRUNCATE || MS_WINDOWS */
Larry Hastings2f936352014-08-05 14:04:04 +10009819
Ross Lagerwall7807c352011-03-17 20:20:30 +02009820
Victor Stinnerd6b17692014-09-30 12:20:05 +02009821/* Issue #22396: On 32-bit AIX platform, the prototypes of os.posix_fadvise()
9822 and os.posix_fallocate() in system headers are wrong if _LARGE_FILES is
9823 defined, which is the case in Python on AIX. AIX bug report:
9824 http://www-01.ibm.com/support/docview.wss?uid=isg1IV56170 */
9825#if defined(_AIX) && defined(_LARGE_FILES) && !defined(__64BIT__)
9826# define POSIX_FADVISE_AIX_BUG
9827#endif
9828
Victor Stinnerec39e262014-09-30 12:35:58 +02009829
Victor Stinnerd6b17692014-09-30 12:20:05 +02009830#if defined(HAVE_POSIX_FALLOCATE) && !defined(POSIX_FADVISE_AIX_BUG)
Larry Hastings2f936352014-08-05 14:04:04 +10009831/*[clinic input]
9832os.posix_fallocate
9833
9834 fd: int
9835 offset: Py_off_t
9836 length: Py_off_t
9837 /
9838
9839Ensure a file has allocated at least a particular number of bytes on disk.
9840
9841Ensure that the file specified by fd encompasses a range of bytes
9842starting at offset bytes from the beginning and continuing for length bytes.
9843[clinic start generated code]*/
9844
Larry Hastings2f936352014-08-05 14:04:04 +10009845static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009846os_posix_fallocate_impl(PyObject *module, int fd, Py_off_t offset,
Larry Hastings89964c42015-04-14 18:07:59 -04009847 Py_off_t length)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009848/*[clinic end generated code: output=73f107139564aa9d input=d7a2ef0ab2ca52fb]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009849{
9850 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009851 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009852
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009853 do {
9854 Py_BEGIN_ALLOW_THREADS
9855 result = posix_fallocate(fd, offset, length);
9856 Py_END_ALLOW_THREADS
Коренберг Маркd4b93e22017-08-14 18:55:16 +05009857 } while (result == EINTR && !(async_err = PyErr_CheckSignals()));
9858
9859 if (result == 0)
9860 Py_RETURN_NONE;
9861
9862 if (async_err)
9863 return NULL;
9864
9865 errno = result;
9866 return posix_error();
Ross Lagerwall7807c352011-03-17 20:20:30 +02009867}
Victor Stinnerec39e262014-09-30 12:35:58 +02009868#endif /* HAVE_POSIX_FALLOCATE) && !POSIX_FADVISE_AIX_BUG */
Larry Hastings2f936352014-08-05 14:04:04 +10009869
Ross Lagerwall7807c352011-03-17 20:20:30 +02009870
Victor Stinnerd6b17692014-09-30 12:20:05 +02009871#if defined(HAVE_POSIX_FADVISE) && !defined(POSIX_FADVISE_AIX_BUG)
Larry Hastings2f936352014-08-05 14:04:04 +10009872/*[clinic input]
9873os.posix_fadvise
9874
9875 fd: int
9876 offset: Py_off_t
9877 length: Py_off_t
9878 advice: int
9879 /
9880
9881Announce an intention to access data in a specific pattern.
9882
9883Announce an intention to access data in a specific pattern, thus allowing
9884the kernel to make optimizations.
9885The advice applies to the region of the file specified by fd starting at
9886offset and continuing for length bytes.
9887advice is one of POSIX_FADV_NORMAL, POSIX_FADV_SEQUENTIAL,
9888POSIX_FADV_RANDOM, POSIX_FADV_NOREUSE, POSIX_FADV_WILLNEED, or
9889POSIX_FADV_DONTNEED.
9890[clinic start generated code]*/
9891
Larry Hastings2f936352014-08-05 14:04:04 +10009892static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009893os_posix_fadvise_impl(PyObject *module, int fd, Py_off_t offset,
Larry Hastings89964c42015-04-14 18:07:59 -04009894 Py_off_t length, int advice)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009895/*[clinic end generated code: output=412ef4aa70c98642 input=0fbe554edc2f04b5]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009896{
9897 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009898 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009899
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009900 do {
9901 Py_BEGIN_ALLOW_THREADS
9902 result = posix_fadvise(fd, offset, length, advice);
9903 Py_END_ALLOW_THREADS
Коренберг Маркd4b93e22017-08-14 18:55:16 +05009904 } while (result == EINTR && !(async_err = PyErr_CheckSignals()));
9905
9906 if (result == 0)
9907 Py_RETURN_NONE;
9908
9909 if (async_err)
9910 return NULL;
9911
9912 errno = result;
9913 return posix_error();
Ross Lagerwall7807c352011-03-17 20:20:30 +02009914}
Victor Stinnerec39e262014-09-30 12:35:58 +02009915#endif /* HAVE_POSIX_FADVISE && !POSIX_FADVISE_AIX_BUG */
Ross Lagerwall7807c352011-03-17 20:20:30 +02009916
Guido van Rossumf1af3fe1996-07-23 19:18:10 +00009917#ifdef HAVE_PUTENV
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00009918
Fred Drake762e2061999-08-26 17:23:54 +00009919/* Save putenv() parameters as values here, so we can collect them when they
9920 * get re-set with another call for the same key. */
9921static PyObject *posix_putenv_garbage;
9922
Larry Hastings2f936352014-08-05 14:04:04 +10009923static void
9924posix_putenv_garbage_setitem(PyObject *name, PyObject *value)
Guido van Rossumf1af3fe1996-07-23 19:18:10 +00009925{
Larry Hastings2f936352014-08-05 14:04:04 +10009926 /* Install the first arg and newstr in posix_putenv_garbage;
9927 * this will cause previous value to be collected. This has to
9928 * happen after the real putenv() call because the old value
9929 * was still accessible until then. */
9930 if (PyDict_SetItem(posix_putenv_garbage, name, value))
9931 /* really not much we can do; just leak */
9932 PyErr_Clear();
9933 else
9934 Py_DECREF(value);
9935}
9936
9937
Thomas Hellerf78f12a2007-11-08 19:33:05 +00009938#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10009939/*[clinic input]
9940os.putenv
9941
9942 name: unicode
9943 value: unicode
9944 /
9945
9946Change or add an environment variable.
9947[clinic start generated code]*/
9948
Larry Hastings2f936352014-08-05 14:04:04 +10009949static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009950os_putenv_impl(PyObject *module, PyObject *name, PyObject *value)
9951/*[clinic end generated code: output=d29a567d6b2327d2 input=ba586581c2e6105f]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009952{
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03009953 const wchar_t *env;
Serhiy Storchakaf7eae0a2017-06-28 08:30:06 +03009954 Py_ssize_t size;
Larry Hastings2f936352014-08-05 14:04:04 +10009955
Serhiy Storchaka77703942017-06-25 07:33:01 +03009956 /* Search from index 1 because on Windows starting '=' is allowed for
9957 defining hidden environment variables. */
9958 if (PyUnicode_GET_LENGTH(name) == 0 ||
9959 PyUnicode_FindChar(name, '=', 1, PyUnicode_GET_LENGTH(name), 1) != -1)
9960 {
9961 PyErr_SetString(PyExc_ValueError, "illegal environment variable name");
9962 return NULL;
9963 }
Larry Hastings2f936352014-08-05 14:04:04 +10009964 PyObject *unicode = PyUnicode_FromFormat("%U=%U", name, value);
9965 if (unicode == NULL) {
Larry Hastings2f936352014-08-05 14:04:04 +10009966 return NULL;
Victor Stinner84ae1182010-05-06 22:05:07 +00009967 }
Serhiy Storchakaf7eae0a2017-06-28 08:30:06 +03009968
9969 env = PyUnicode_AsUnicodeAndSize(unicode, &size);
9970 if (env == NULL)
9971 goto error;
9972 if (size > _MAX_ENV) {
Victor Stinner65170952011-11-22 22:16:17 +01009973 PyErr_Format(PyExc_ValueError,
9974 "the environment variable is longer than %u characters",
9975 _MAX_ENV);
9976 goto error;
9977 }
Serhiy Storchakaf7eae0a2017-06-28 08:30:06 +03009978 if (wcslen(env) != (size_t)size) {
9979 PyErr_SetString(PyExc_ValueError, "embedded null character");
Victor Stinnereb5657a2011-09-30 01:44:27 +02009980 goto error;
Serhiy Storchakaf7eae0a2017-06-28 08:30:06 +03009981 }
9982
Larry Hastings2f936352014-08-05 14:04:04 +10009983 if (_wputenv(env)) {
Victor Stinner8c62be82010-05-06 00:08:46 +00009984 posix_error();
Victor Stinner84ae1182010-05-06 22:05:07 +00009985 goto error;
Victor Stinner8c62be82010-05-06 00:08:46 +00009986 }
Guido van Rossumf1af3fe1996-07-23 19:18:10 +00009987
Larry Hastings2f936352014-08-05 14:04:04 +10009988 posix_putenv_garbage_setitem(name, unicode);
Victor Stinner84ae1182010-05-06 22:05:07 +00009989 Py_RETURN_NONE;
9990
9991error:
Larry Hastings2f936352014-08-05 14:04:04 +10009992 Py_DECREF(unicode);
Victor Stinner84ae1182010-05-06 22:05:07 +00009993 return NULL;
Guido van Rossumf1af3fe1996-07-23 19:18:10 +00009994}
Larry Hastings2f936352014-08-05 14:04:04 +10009995#else /* MS_WINDOWS */
9996/*[clinic input]
9997os.putenv
Guido van Rossumb6a47161997-09-15 22:54:34 +00009998
Larry Hastings2f936352014-08-05 14:04:04 +10009999 name: FSConverter
10000 value: FSConverter
10001 /
10002
10003Change or add an environment variable.
10004[clinic start generated code]*/
10005
Larry Hastings2f936352014-08-05 14:04:04 +100010006static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010007os_putenv_impl(PyObject *module, PyObject *name, PyObject *value)
10008/*[clinic end generated code: output=d29a567d6b2327d2 input=a97bc6152f688d31]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010009{
10010 PyObject *bytes = NULL;
10011 char *env;
Serhiy Storchaka77703942017-06-25 07:33:01 +030010012 const char *name_string = PyBytes_AS_STRING(name);
10013 const char *value_string = PyBytes_AS_STRING(value);
Larry Hastings2f936352014-08-05 14:04:04 +100010014
Serhiy Storchaka77703942017-06-25 07:33:01 +030010015 if (strchr(name_string, '=') != NULL) {
10016 PyErr_SetString(PyExc_ValueError, "illegal environment variable name");
10017 return NULL;
10018 }
Larry Hastings2f936352014-08-05 14:04:04 +100010019 bytes = PyBytes_FromFormat("%s=%s", name_string, value_string);
10020 if (bytes == NULL) {
Larry Hastings2f936352014-08-05 14:04:04 +100010021 return NULL;
10022 }
10023
10024 env = PyBytes_AS_STRING(bytes);
10025 if (putenv(env)) {
10026 Py_DECREF(bytes);
10027 return posix_error();
10028 }
10029
10030 posix_putenv_garbage_setitem(name, bytes);
10031 Py_RETURN_NONE;
10032}
10033#endif /* MS_WINDOWS */
10034#endif /* HAVE_PUTENV */
10035
10036
10037#ifdef HAVE_UNSETENV
10038/*[clinic input]
10039os.unsetenv
10040 name: FSConverter
10041 /
10042
10043Delete an environment variable.
10044[clinic start generated code]*/
10045
Larry Hastings2f936352014-08-05 14:04:04 +100010046static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010047os_unsetenv_impl(PyObject *module, PyObject *name)
10048/*[clinic end generated code: output=54c4137ab1834f02 input=2bb5288a599c7107]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010049{
Victor Stinner984890f2011-11-24 13:53:38 +010010050#ifndef HAVE_BROKEN_UNSETENV
Victor Stinner60b385e2011-11-22 22:01:28 +010010051 int err;
Victor Stinner984890f2011-11-24 13:53:38 +010010052#endif
Victor Stinner84ae1182010-05-06 22:05:07 +000010053
Victor Stinner984890f2011-11-24 13:53:38 +010010054#ifdef HAVE_BROKEN_UNSETENV
10055 unsetenv(PyBytes_AS_STRING(name));
10056#else
Victor Stinner65170952011-11-22 22:16:17 +010010057 err = unsetenv(PyBytes_AS_STRING(name));
Larry Hastings2f936352014-08-05 14:04:04 +100010058 if (err)
Victor Stinner60b385e2011-11-22 22:01:28 +010010059 return posix_error();
Victor Stinner984890f2011-11-24 13:53:38 +010010060#endif
Guido van Rossumc524d952001-10-19 01:31:59 +000010061
Victor Stinner8c62be82010-05-06 00:08:46 +000010062 /* Remove the key from posix_putenv_garbage;
10063 * this will cause it to be collected. This has to
10064 * happen after the real unsetenv() call because the
10065 * old value was still accessible until then.
10066 */
Victor Stinner65170952011-11-22 22:16:17 +010010067 if (PyDict_DelItem(posix_putenv_garbage, name)) {
Victor Stinner8c62be82010-05-06 00:08:46 +000010068 /* really not much we can do; just leak */
Serhiy Storchakaa24107b2019-02-25 17:59:46 +020010069 if (!PyErr_ExceptionMatches(PyExc_KeyError)) {
10070 return NULL;
10071 }
Victor Stinner8c62be82010-05-06 00:08:46 +000010072 PyErr_Clear();
10073 }
Victor Stinner84ae1182010-05-06 22:05:07 +000010074 Py_RETURN_NONE;
Guido van Rossumc524d952001-10-19 01:31:59 +000010075}
Larry Hastings2f936352014-08-05 14:04:04 +100010076#endif /* HAVE_UNSETENV */
Guido van Rossumc524d952001-10-19 01:31:59 +000010077
Larry Hastings2f936352014-08-05 14:04:04 +100010078
10079/*[clinic input]
10080os.strerror
10081
10082 code: int
10083 /
10084
10085Translate an error code to a message string.
10086[clinic start generated code]*/
10087
Larry Hastings2f936352014-08-05 14:04:04 +100010088static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010089os_strerror_impl(PyObject *module, int code)
10090/*[clinic end generated code: output=baebf09fa02a78f2 input=75a8673d97915a91]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010091{
10092 char *message = strerror(code);
Victor Stinner8c62be82010-05-06 00:08:46 +000010093 if (message == NULL) {
10094 PyErr_SetString(PyExc_ValueError,
10095 "strerror() argument out of range");
10096 return NULL;
10097 }
Victor Stinner1b579672011-12-17 05:47:23 +010010098 return PyUnicode_DecodeLocale(message, "surrogateescape");
Guido van Rossumb6a47161997-09-15 22:54:34 +000010099}
Guido van Rossumb6a47161997-09-15 22:54:34 +000010100
Guido van Rossumf1af3fe1996-07-23 19:18:10 +000010101
Guido van Rossumc9641791998-08-04 15:26:23 +000010102#ifdef HAVE_SYS_WAIT_H
Fred Drake106c1a02002-04-23 15:58:02 +000010103#ifdef WCOREDUMP
Larry Hastings2f936352014-08-05 14:04:04 +100010104/*[clinic input]
10105os.WCOREDUMP -> bool
10106
10107 status: int
10108 /
10109
10110Return True if the process returning status was dumped to a core file.
10111[clinic start generated code]*/
10112
Larry Hastings2f936352014-08-05 14:04:04 +100010113static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010114os_WCOREDUMP_impl(PyObject *module, int status)
10115/*[clinic end generated code: output=1a584b147b16bd18 input=8b05e7ab38528d04]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010116{
10117 WAIT_TYPE wait_status;
10118 WAIT_STATUS_INT(wait_status) = status;
10119 return WCOREDUMP(wait_status);
Fred Drake106c1a02002-04-23 15:58:02 +000010120}
10121#endif /* WCOREDUMP */
10122
Larry Hastings2f936352014-08-05 14:04:04 +100010123
Fred Drake106c1a02002-04-23 15:58:02 +000010124#ifdef WIFCONTINUED
Larry Hastings2f936352014-08-05 14:04:04 +100010125/*[clinic input]
10126os.WIFCONTINUED -> bool
10127
10128 status: int
10129
10130Return True if a particular process was continued from a job control stop.
10131
10132Return True if the process returning status was continued from a
10133job control stop.
10134[clinic start generated code]*/
10135
Larry Hastings2f936352014-08-05 14:04:04 +100010136static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010137os_WIFCONTINUED_impl(PyObject *module, int status)
10138/*[clinic end generated code: output=1e35295d844364bd input=e777e7d38eb25bd9]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010139{
10140 WAIT_TYPE wait_status;
10141 WAIT_STATUS_INT(wait_status) = status;
10142 return WIFCONTINUED(wait_status);
Fred Drake106c1a02002-04-23 15:58:02 +000010143}
10144#endif /* WIFCONTINUED */
10145
Larry Hastings2f936352014-08-05 14:04:04 +100010146
Guido van Rossumc9641791998-08-04 15:26:23 +000010147#ifdef WIFSTOPPED
Larry Hastings2f936352014-08-05 14:04:04 +100010148/*[clinic input]
10149os.WIFSTOPPED -> bool
10150
10151 status: int
10152
10153Return True if the process returning status was stopped.
10154[clinic start generated code]*/
10155
Larry Hastings2f936352014-08-05 14:04:04 +100010156static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010157os_WIFSTOPPED_impl(PyObject *module, int status)
10158/*[clinic end generated code: output=fdb57122a5c9b4cb input=043cb7f1289ef904]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010159{
10160 WAIT_TYPE wait_status;
10161 WAIT_STATUS_INT(wait_status) = status;
10162 return WIFSTOPPED(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +000010163}
10164#endif /* WIFSTOPPED */
10165
Larry Hastings2f936352014-08-05 14:04:04 +100010166
Guido van Rossumc9641791998-08-04 15:26:23 +000010167#ifdef WIFSIGNALED
Larry Hastings2f936352014-08-05 14:04:04 +100010168/*[clinic input]
10169os.WIFSIGNALED -> bool
10170
10171 status: int
10172
10173Return True if the process returning status was terminated by a signal.
10174[clinic start generated code]*/
10175
Larry Hastings2f936352014-08-05 14:04:04 +100010176static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010177os_WIFSIGNALED_impl(PyObject *module, int status)
10178/*[clinic end generated code: output=d1dde4dcc819a5f5 input=d55ba7cc9ce5dc43]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010179{
10180 WAIT_TYPE wait_status;
10181 WAIT_STATUS_INT(wait_status) = status;
10182 return WIFSIGNALED(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +000010183}
10184#endif /* WIFSIGNALED */
10185
Larry Hastings2f936352014-08-05 14:04:04 +100010186
Guido van Rossumc9641791998-08-04 15:26:23 +000010187#ifdef WIFEXITED
Larry Hastings2f936352014-08-05 14:04:04 +100010188/*[clinic input]
10189os.WIFEXITED -> bool
10190
10191 status: int
10192
10193Return True if the process returning status exited via the exit() system call.
10194[clinic start generated code]*/
10195
Larry Hastings2f936352014-08-05 14:04:04 +100010196static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010197os_WIFEXITED_impl(PyObject *module, int status)
10198/*[clinic end generated code: output=01c09d6ebfeea397 input=d63775a6791586c0]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010199{
10200 WAIT_TYPE wait_status;
10201 WAIT_STATUS_INT(wait_status) = status;
10202 return WIFEXITED(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +000010203}
10204#endif /* WIFEXITED */
10205
Larry Hastings2f936352014-08-05 14:04:04 +100010206
Guido van Rossum54ecc3d1999-01-27 17:53:11 +000010207#ifdef WEXITSTATUS
Larry Hastings2f936352014-08-05 14:04:04 +100010208/*[clinic input]
10209os.WEXITSTATUS -> int
10210
10211 status: int
10212
10213Return the process return code from status.
10214[clinic start generated code]*/
10215
Larry Hastings2f936352014-08-05 14:04:04 +100010216static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010217os_WEXITSTATUS_impl(PyObject *module, int status)
10218/*[clinic end generated code: output=6e3efbba11f6488d input=e1fb4944e377585b]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010219{
10220 WAIT_TYPE wait_status;
10221 WAIT_STATUS_INT(wait_status) = status;
10222 return WEXITSTATUS(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +000010223}
10224#endif /* WEXITSTATUS */
10225
Larry Hastings2f936352014-08-05 14:04:04 +100010226
Guido van Rossumc9641791998-08-04 15:26:23 +000010227#ifdef WTERMSIG
Larry Hastings2f936352014-08-05 14:04:04 +100010228/*[clinic input]
10229os.WTERMSIG -> int
10230
10231 status: int
10232
10233Return the signal that terminated the process that provided the status value.
10234[clinic start generated code]*/
10235
Larry Hastings2f936352014-08-05 14:04:04 +100010236static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010237os_WTERMSIG_impl(PyObject *module, int status)
10238/*[clinic end generated code: output=172f7dfc8dcfc3ad input=727fd7f84ec3f243]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010239{
10240 WAIT_TYPE wait_status;
10241 WAIT_STATUS_INT(wait_status) = status;
10242 return WTERMSIG(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +000010243}
10244#endif /* WTERMSIG */
10245
Larry Hastings2f936352014-08-05 14:04:04 +100010246
Guido van Rossumc9641791998-08-04 15:26:23 +000010247#ifdef WSTOPSIG
Larry Hastings2f936352014-08-05 14:04:04 +100010248/*[clinic input]
10249os.WSTOPSIG -> int
10250
10251 status: int
10252
10253Return the signal that stopped the process that provided the status value.
10254[clinic start generated code]*/
10255
Larry Hastings2f936352014-08-05 14:04:04 +100010256static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010257os_WSTOPSIG_impl(PyObject *module, int status)
10258/*[clinic end generated code: output=0ab7586396f5d82b input=46ebf1d1b293c5c1]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010259{
10260 WAIT_TYPE wait_status;
10261 WAIT_STATUS_INT(wait_status) = status;
10262 return WSTOPSIG(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +000010263}
10264#endif /* WSTOPSIG */
Guido van Rossumc9641791998-08-04 15:26:23 +000010265#endif /* HAVE_SYS_WAIT_H */
10266
10267
Thomas Wouters477c8d52006-05-27 19:21:47 +000010268#if defined(HAVE_FSTATVFS) && defined(HAVE_SYS_STATVFS_H)
Guido van Rossumd5753e11999-10-19 13:29:23 +000010269#ifdef _SCO_DS
10270/* SCO OpenServer 5.0 and later requires _SVID3 before it reveals the
10271 needed definitions in sys/statvfs.h */
10272#define _SVID3
10273#endif
Guido van Rossum94f6f721999-01-06 18:42:14 +000010274#include <sys/statvfs.h>
10275
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010276static PyObject*
10277_pystatvfs_fromstructstatvfs(struct statvfs st) {
Eddie Elizondo474eedf2018-11-13 04:09:31 -080010278 PyObject *v = PyStructSequence_New(StatVFSResultType);
Victor Stinner8c62be82010-05-06 00:08:46 +000010279 if (v == NULL)
10280 return NULL;
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010281
10282#if !defined(HAVE_LARGEFILE_SUPPORT)
Victor Stinner8c62be82010-05-06 00:08:46 +000010283 PyStructSequence_SET_ITEM(v, 0, PyLong_FromLong((long) st.f_bsize));
10284 PyStructSequence_SET_ITEM(v, 1, PyLong_FromLong((long) st.f_frsize));
10285 PyStructSequence_SET_ITEM(v, 2, PyLong_FromLong((long) st.f_blocks));
10286 PyStructSequence_SET_ITEM(v, 3, PyLong_FromLong((long) st.f_bfree));
10287 PyStructSequence_SET_ITEM(v, 4, PyLong_FromLong((long) st.f_bavail));
10288 PyStructSequence_SET_ITEM(v, 5, PyLong_FromLong((long) st.f_files));
10289 PyStructSequence_SET_ITEM(v, 6, PyLong_FromLong((long) st.f_ffree));
10290 PyStructSequence_SET_ITEM(v, 7, PyLong_FromLong((long) st.f_favail));
10291 PyStructSequence_SET_ITEM(v, 8, PyLong_FromLong((long) st.f_flag));
10292 PyStructSequence_SET_ITEM(v, 9, PyLong_FromLong((long) st.f_namemax));
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010293#else
Victor Stinner8c62be82010-05-06 00:08:46 +000010294 PyStructSequence_SET_ITEM(v, 0, PyLong_FromLong((long) st.f_bsize));
10295 PyStructSequence_SET_ITEM(v, 1, PyLong_FromLong((long) st.f_frsize));
10296 PyStructSequence_SET_ITEM(v, 2,
Benjamin Petersonaf580df2016-09-06 10:46:49 -070010297 PyLong_FromLongLong((long long) st.f_blocks));
Victor Stinner8c62be82010-05-06 00:08:46 +000010298 PyStructSequence_SET_ITEM(v, 3,
Benjamin Petersonaf580df2016-09-06 10:46:49 -070010299 PyLong_FromLongLong((long long) st.f_bfree));
Victor Stinner8c62be82010-05-06 00:08:46 +000010300 PyStructSequence_SET_ITEM(v, 4,
Benjamin Petersonaf580df2016-09-06 10:46:49 -070010301 PyLong_FromLongLong((long long) st.f_bavail));
Victor Stinner8c62be82010-05-06 00:08:46 +000010302 PyStructSequence_SET_ITEM(v, 5,
Benjamin Petersonaf580df2016-09-06 10:46:49 -070010303 PyLong_FromLongLong((long long) st.f_files));
Victor Stinner8c62be82010-05-06 00:08:46 +000010304 PyStructSequence_SET_ITEM(v, 6,
Benjamin Petersonaf580df2016-09-06 10:46:49 -070010305 PyLong_FromLongLong((long long) st.f_ffree));
Victor Stinner8c62be82010-05-06 00:08:46 +000010306 PyStructSequence_SET_ITEM(v, 7,
Benjamin Petersonaf580df2016-09-06 10:46:49 -070010307 PyLong_FromLongLong((long long) st.f_favail));
Victor Stinner8c62be82010-05-06 00:08:46 +000010308 PyStructSequence_SET_ITEM(v, 8, PyLong_FromLong((long) st.f_flag));
10309 PyStructSequence_SET_ITEM(v, 9, PyLong_FromLong((long) st.f_namemax));
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010310#endif
Michael Felt502d5512018-01-05 13:01:58 +010010311/* The _ALL_SOURCE feature test macro defines f_fsid as a structure
10312 * (issue #32390). */
10313#if defined(_AIX) && defined(_ALL_SOURCE)
10314 PyStructSequence_SET_ITEM(v, 10, PyLong_FromUnsignedLong(st.f_fsid.val[0]));
10315#else
Giuseppe Scrivano96a5e502017-12-14 23:46:46 +010010316 PyStructSequence_SET_ITEM(v, 10, PyLong_FromUnsignedLong(st.f_fsid));
Michael Felt502d5512018-01-05 13:01:58 +010010317#endif
Victor Stinnerf0a7bac2013-10-30 18:55:24 +010010318 if (PyErr_Occurred()) {
10319 Py_DECREF(v);
10320 return NULL;
10321 }
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010322
Victor Stinner8c62be82010-05-06 00:08:46 +000010323 return v;
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010324}
10325
Larry Hastings2f936352014-08-05 14:04:04 +100010326
10327/*[clinic input]
10328os.fstatvfs
10329 fd: int
10330 /
10331
10332Perform an fstatvfs system call on the given fd.
10333
10334Equivalent to statvfs(fd).
10335[clinic start generated code]*/
10336
Larry Hastings2f936352014-08-05 14:04:04 +100010337static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010338os_fstatvfs_impl(PyObject *module, int fd)
10339/*[clinic end generated code: output=53547cf0cc55e6c5 input=d8122243ac50975e]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010340{
10341 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010342 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +000010343 struct statvfs st;
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010344
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010345 do {
10346 Py_BEGIN_ALLOW_THREADS
10347 result = fstatvfs(fd, &st);
10348 Py_END_ALLOW_THREADS
10349 } while (result != 0 && errno == EINTR &&
10350 !(async_err = PyErr_CheckSignals()));
Larry Hastings2f936352014-08-05 14:04:04 +100010351 if (result != 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +000010352 return (!async_err) ? posix_error() : NULL;
Guido van Rossum98bf58f2001-10-18 20:34:25 +000010353
Victor Stinner8c62be82010-05-06 00:08:46 +000010354 return _pystatvfs_fromstructstatvfs(st);
Guido van Rossum94f6f721999-01-06 18:42:14 +000010355}
Larry Hastings2f936352014-08-05 14:04:04 +100010356#endif /* defined(HAVE_FSTATVFS) && defined(HAVE_SYS_STATVFS_H) */
Guido van Rossum94f6f721999-01-06 18:42:14 +000010357
10358
Thomas Wouters477c8d52006-05-27 19:21:47 +000010359#if defined(HAVE_STATVFS) && defined(HAVE_SYS_STATVFS_H)
Guido van Rossum94f6f721999-01-06 18:42:14 +000010360#include <sys/statvfs.h>
Larry Hastings2f936352014-08-05 14:04:04 +100010361/*[clinic input]
10362os.statvfs
Guido van Rossum94f6f721999-01-06 18:42:14 +000010363
Larry Hastings2f936352014-08-05 14:04:04 +100010364 path: path_t(allow_fd='PATH_HAVE_FSTATVFS')
10365
10366Perform a statvfs system call on the given path.
10367
10368path may always be specified as a string.
10369On some platforms, path may also be specified as an open file descriptor.
10370 If this functionality is unavailable, using it raises an exception.
10371[clinic start generated code]*/
10372
Larry Hastings2f936352014-08-05 14:04:04 +100010373static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010374os_statvfs_impl(PyObject *module, path_t *path)
10375/*[clinic end generated code: output=87106dd1beb8556e input=3f5c35791c669bd9]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010376{
10377 int result;
10378 struct statvfs st;
Larry Hastings9cf065c2012-06-22 16:30:09 -070010379
10380 Py_BEGIN_ALLOW_THREADS
10381#ifdef HAVE_FSTATVFS
Larry Hastings2f936352014-08-05 14:04:04 +100010382 if (path->fd != -1) {
Larry Hastings9cf065c2012-06-22 16:30:09 -070010383#ifdef __APPLE__
10384 /* handle weak-linking on Mac OS X 10.3 */
10385 if (fstatvfs == NULL) {
Larry Hastings2f936352014-08-05 14:04:04 +100010386 fd_specified("statvfs", path->fd);
10387 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070010388 }
10389#endif
Larry Hastings2f936352014-08-05 14:04:04 +100010390 result = fstatvfs(path->fd, &st);
Larry Hastings9cf065c2012-06-22 16:30:09 -070010391 }
10392 else
10393#endif
Larry Hastings2f936352014-08-05 14:04:04 +100010394 result = statvfs(path->narrow, &st);
Larry Hastings9cf065c2012-06-22 16:30:09 -070010395 Py_END_ALLOW_THREADS
10396
10397 if (result) {
Larry Hastings2f936352014-08-05 14:04:04 +100010398 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -070010399 }
10400
Larry Hastings2f936352014-08-05 14:04:04 +100010401 return _pystatvfs_fromstructstatvfs(st);
Guido van Rossum94f6f721999-01-06 18:42:14 +000010402}
Larry Hastings2f936352014-08-05 14:04:04 +100010403#endif /* defined(HAVE_STATVFS) && defined(HAVE_SYS_STATVFS_H) */
10404
Guido van Rossum94f6f721999-01-06 18:42:14 +000010405
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010406#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +100010407/*[clinic input]
10408os._getdiskusage
10409
Steve Dower23ad6d02018-02-22 10:39:10 -080010410 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +100010411
10412Return disk usage statistics about the given path as a (total, free) tuple.
10413[clinic start generated code]*/
10414
Larry Hastings2f936352014-08-05 14:04:04 +100010415static PyObject *
Steve Dower23ad6d02018-02-22 10:39:10 -080010416os__getdiskusage_impl(PyObject *module, path_t *path)
10417/*[clinic end generated code: output=3bd3991f5e5c5dfb input=6af8d1b7781cc042]*/
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010418{
10419 BOOL retval;
10420 ULARGE_INTEGER _, total, free;
Joe Pamerc8c02492018-09-25 10:57:36 -040010421 DWORD err = 0;
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010422
10423 Py_BEGIN_ALLOW_THREADS
Steve Dower23ad6d02018-02-22 10:39:10 -080010424 retval = GetDiskFreeSpaceExW(path->wide, &_, &total, &free);
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010425 Py_END_ALLOW_THREADS
Joe Pamerc8c02492018-09-25 10:57:36 -040010426 if (retval == 0) {
10427 if (GetLastError() == ERROR_DIRECTORY) {
10428 wchar_t *dir_path = NULL;
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010429
Joe Pamerc8c02492018-09-25 10:57:36 -040010430 dir_path = PyMem_New(wchar_t, path->length + 1);
10431 if (dir_path == NULL) {
10432 return PyErr_NoMemory();
10433 }
10434
10435 wcscpy_s(dir_path, path->length + 1, path->wide);
10436
10437 if (_dirnameW(dir_path) != -1) {
10438 Py_BEGIN_ALLOW_THREADS
10439 retval = GetDiskFreeSpaceExW(dir_path, &_, &total, &free);
10440 Py_END_ALLOW_THREADS
10441 }
10442 /* Record the last error in case it's modified by PyMem_Free. */
10443 err = GetLastError();
10444 PyMem_Free(dir_path);
10445 if (retval) {
10446 goto success;
10447 }
10448 }
10449 return PyErr_SetFromWindowsErr(err);
10450 }
10451
10452success:
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010453 return Py_BuildValue("(LL)", total.QuadPart, free.QuadPart);
10454}
Larry Hastings2f936352014-08-05 14:04:04 +100010455#endif /* MS_WINDOWS */
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +020010456
10457
Fred Drakec9680921999-12-13 16:37:25 +000010458/* This is used for fpathconf(), pathconf(), confstr() and sysconf().
10459 * It maps strings representing configuration variable names to
10460 * integer values, allowing those functions to be called with the
Thomas Wouters7e474022000-07-16 12:04:32 +000010461 * magic names instead of polluting the module's namespace with tons of
Fred Drake12c6e2d1999-12-14 21:25:03 +000010462 * rarely-used constants. There are three separate tables that use
10463 * these definitions.
Fred Drakebec628d1999-12-15 18:31:10 +000010464 *
10465 * This code is always included, even if none of the interfaces that
10466 * need it are included. The #if hackery needed to avoid it would be
10467 * sufficiently pervasive that it's not worth the loss of readability.
Fred Drakec9680921999-12-13 16:37:25 +000010468 */
10469struct constdef {
Serhiy Storchaka2d06e842015-12-25 19:53:18 +020010470 const char *name;
Serhiy Storchaka56f6e762015-09-06 21:25:30 +030010471 int value;
Fred Drakec9680921999-12-13 16:37:25 +000010472};
10473
Fred Drake12c6e2d1999-12-14 21:25:03 +000010474static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000010475conv_confname(PyObject *arg, int *valuep, struct constdef *table,
Guido van Rossum7d5baac2007-08-27 23:24:46 +000010476 size_t tablesize)
Fred Drake12c6e2d1999-12-14 21:25:03 +000010477{
Christian Heimes217cfd12007-12-02 14:31:20 +000010478 if (PyLong_Check(arg)) {
Serhiy Storchaka56f6e762015-09-06 21:25:30 +030010479 int value = _PyLong_AsInt(arg);
10480 if (value == -1 && PyErr_Occurred())
10481 return 0;
10482 *valuep = value;
Stefan Krah0e803b32010-11-26 16:16:47 +000010483 return 1;
Fred Drake12c6e2d1999-12-14 21:25:03 +000010484 }
Guido van Rossumbce56a62007-05-10 18:04:33 +000010485 else {
Stefan Krah0e803b32010-11-26 16:16:47 +000010486 /* look up the value in the table using a binary search */
10487 size_t lo = 0;
10488 size_t mid;
10489 size_t hi = tablesize;
10490 int cmp;
10491 const char *confname;
10492 if (!PyUnicode_Check(arg)) {
10493 PyErr_SetString(PyExc_TypeError,
10494 "configuration names must be strings or integers");
10495 return 0;
Victor Stinner8c62be82010-05-06 00:08:46 +000010496 }
Serhiy Storchaka06515832016-11-20 09:13:07 +020010497 confname = PyUnicode_AsUTF8(arg);
Stefan Krah0e803b32010-11-26 16:16:47 +000010498 if (confname == NULL)
10499 return 0;
10500 while (lo < hi) {
10501 mid = (lo + hi) / 2;
10502 cmp = strcmp(confname, table[mid].name);
10503 if (cmp < 0)
10504 hi = mid;
10505 else if (cmp > 0)
10506 lo = mid + 1;
10507 else {
10508 *valuep = table[mid].value;
10509 return 1;
10510 }
10511 }
10512 PyErr_SetString(PyExc_ValueError, "unrecognized configuration name");
10513 return 0;
Victor Stinner8c62be82010-05-06 00:08:46 +000010514 }
Fred Drake12c6e2d1999-12-14 21:25:03 +000010515}
10516
10517
10518#if defined(HAVE_FPATHCONF) || defined(HAVE_PATHCONF)
10519static struct constdef posix_constants_pathconf[] = {
Fred Draked86ed291999-12-15 15:34:33 +000010520#ifdef _PC_ABI_AIO_XFER_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010521 {"PC_ABI_AIO_XFER_MAX", _PC_ABI_AIO_XFER_MAX},
Fred Draked86ed291999-12-15 15:34:33 +000010522#endif
10523#ifdef _PC_ABI_ASYNC_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000010524 {"PC_ABI_ASYNC_IO", _PC_ABI_ASYNC_IO},
Fred Draked86ed291999-12-15 15:34:33 +000010525#endif
Fred Drakec9680921999-12-13 16:37:25 +000010526#ifdef _PC_ASYNC_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000010527 {"PC_ASYNC_IO", _PC_ASYNC_IO},
Fred Drakec9680921999-12-13 16:37:25 +000010528#endif
10529#ifdef _PC_CHOWN_RESTRICTED
Victor Stinner8c62be82010-05-06 00:08:46 +000010530 {"PC_CHOWN_RESTRICTED", _PC_CHOWN_RESTRICTED},
Fred Drakec9680921999-12-13 16:37:25 +000010531#endif
10532#ifdef _PC_FILESIZEBITS
Victor Stinner8c62be82010-05-06 00:08:46 +000010533 {"PC_FILESIZEBITS", _PC_FILESIZEBITS},
Fred Drakec9680921999-12-13 16:37:25 +000010534#endif
10535#ifdef _PC_LAST
Victor Stinner8c62be82010-05-06 00:08:46 +000010536 {"PC_LAST", _PC_LAST},
Fred Drakec9680921999-12-13 16:37:25 +000010537#endif
10538#ifdef _PC_LINK_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010539 {"PC_LINK_MAX", _PC_LINK_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010540#endif
10541#ifdef _PC_MAX_CANON
Victor Stinner8c62be82010-05-06 00:08:46 +000010542 {"PC_MAX_CANON", _PC_MAX_CANON},
Fred Drakec9680921999-12-13 16:37:25 +000010543#endif
10544#ifdef _PC_MAX_INPUT
Victor Stinner8c62be82010-05-06 00:08:46 +000010545 {"PC_MAX_INPUT", _PC_MAX_INPUT},
Fred Drakec9680921999-12-13 16:37:25 +000010546#endif
10547#ifdef _PC_NAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010548 {"PC_NAME_MAX", _PC_NAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010549#endif
10550#ifdef _PC_NO_TRUNC
Victor Stinner8c62be82010-05-06 00:08:46 +000010551 {"PC_NO_TRUNC", _PC_NO_TRUNC},
Fred Drakec9680921999-12-13 16:37:25 +000010552#endif
10553#ifdef _PC_PATH_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010554 {"PC_PATH_MAX", _PC_PATH_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010555#endif
10556#ifdef _PC_PIPE_BUF
Victor Stinner8c62be82010-05-06 00:08:46 +000010557 {"PC_PIPE_BUF", _PC_PIPE_BUF},
Fred Drakec9680921999-12-13 16:37:25 +000010558#endif
10559#ifdef _PC_PRIO_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000010560 {"PC_PRIO_IO", _PC_PRIO_IO},
Fred Drakec9680921999-12-13 16:37:25 +000010561#endif
10562#ifdef _PC_SOCK_MAXBUF
Victor Stinner8c62be82010-05-06 00:08:46 +000010563 {"PC_SOCK_MAXBUF", _PC_SOCK_MAXBUF},
Fred Drakec9680921999-12-13 16:37:25 +000010564#endif
10565#ifdef _PC_SYNC_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000010566 {"PC_SYNC_IO", _PC_SYNC_IO},
Fred Drakec9680921999-12-13 16:37:25 +000010567#endif
10568#ifdef _PC_VDISABLE
Victor Stinner8c62be82010-05-06 00:08:46 +000010569 {"PC_VDISABLE", _PC_VDISABLE},
Fred Drakec9680921999-12-13 16:37:25 +000010570#endif
Jesus Cea7e9065c2010-10-25 13:02:04 +000010571#ifdef _PC_ACL_ENABLED
10572 {"PC_ACL_ENABLED", _PC_ACL_ENABLED},
10573#endif
10574#ifdef _PC_MIN_HOLE_SIZE
10575 {"PC_MIN_HOLE_SIZE", _PC_MIN_HOLE_SIZE},
10576#endif
10577#ifdef _PC_ALLOC_SIZE_MIN
10578 {"PC_ALLOC_SIZE_MIN", _PC_ALLOC_SIZE_MIN},
10579#endif
10580#ifdef _PC_REC_INCR_XFER_SIZE
10581 {"PC_REC_INCR_XFER_SIZE", _PC_REC_INCR_XFER_SIZE},
10582#endif
10583#ifdef _PC_REC_MAX_XFER_SIZE
10584 {"PC_REC_MAX_XFER_SIZE", _PC_REC_MAX_XFER_SIZE},
10585#endif
10586#ifdef _PC_REC_MIN_XFER_SIZE
10587 {"PC_REC_MIN_XFER_SIZE", _PC_REC_MIN_XFER_SIZE},
10588#endif
10589#ifdef _PC_REC_XFER_ALIGN
10590 {"PC_REC_XFER_ALIGN", _PC_REC_XFER_ALIGN},
10591#endif
10592#ifdef _PC_SYMLINK_MAX
10593 {"PC_SYMLINK_MAX", _PC_SYMLINK_MAX},
10594#endif
10595#ifdef _PC_XATTR_ENABLED
10596 {"PC_XATTR_ENABLED", _PC_XATTR_ENABLED},
10597#endif
10598#ifdef _PC_XATTR_EXISTS
10599 {"PC_XATTR_EXISTS", _PC_XATTR_EXISTS},
10600#endif
10601#ifdef _PC_TIMESTAMP_RESOLUTION
10602 {"PC_TIMESTAMP_RESOLUTION", _PC_TIMESTAMP_RESOLUTION},
10603#endif
Fred Drakec9680921999-12-13 16:37:25 +000010604};
10605
Fred Drakec9680921999-12-13 16:37:25 +000010606static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000010607conv_path_confname(PyObject *arg, int *valuep)
Fred Drakec9680921999-12-13 16:37:25 +000010608{
10609 return conv_confname(arg, valuep, posix_constants_pathconf,
10610 sizeof(posix_constants_pathconf)
10611 / sizeof(struct constdef));
10612}
10613#endif
10614
Larry Hastings2f936352014-08-05 14:04:04 +100010615
Fred Drakec9680921999-12-13 16:37:25 +000010616#ifdef HAVE_FPATHCONF
Larry Hastings2f936352014-08-05 14:04:04 +100010617/*[clinic input]
10618os.fpathconf -> long
10619
10620 fd: int
10621 name: path_confname
10622 /
10623
10624Return the configuration limit name for the file descriptor fd.
10625
10626If there is no limit, return -1.
10627[clinic start generated code]*/
10628
Larry Hastings2f936352014-08-05 14:04:04 +100010629static long
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010630os_fpathconf_impl(PyObject *module, int fd, int name)
10631/*[clinic end generated code: output=d5b7042425fc3e21 input=5942a024d3777810]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010632{
10633 long limit;
10634
10635 errno = 0;
10636 limit = fpathconf(fd, name);
10637 if (limit == -1 && errno != 0)
10638 posix_error();
10639
10640 return limit;
10641}
10642#endif /* HAVE_FPATHCONF */
Fred Drakec9680921999-12-13 16:37:25 +000010643
10644
10645#ifdef HAVE_PATHCONF
Larry Hastings2f936352014-08-05 14:04:04 +100010646/*[clinic input]
10647os.pathconf -> long
10648 path: path_t(allow_fd='PATH_HAVE_FPATHCONF')
10649 name: path_confname
10650
10651Return the configuration limit name for the file or directory path.
10652
10653If there is no limit, return -1.
10654On some platforms, path may also be specified as an open file descriptor.
10655 If this functionality is unavailable, using it raises an exception.
10656[clinic start generated code]*/
10657
Larry Hastings2f936352014-08-05 14:04:04 +100010658static long
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010659os_pathconf_impl(PyObject *module, path_t *path, int name)
10660/*[clinic end generated code: output=5bedee35b293a089 input=bc3e2a985af27e5e]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010661{
Victor Stinner8c62be82010-05-06 00:08:46 +000010662 long limit;
Fred Drakec9680921999-12-13 16:37:25 +000010663
Victor Stinner8c62be82010-05-06 00:08:46 +000010664 errno = 0;
Georg Brandl306336b2012-06-24 12:55:33 +020010665#ifdef HAVE_FPATHCONF
Larry Hastings2f936352014-08-05 14:04:04 +100010666 if (path->fd != -1)
10667 limit = fpathconf(path->fd, name);
Georg Brandl306336b2012-06-24 12:55:33 +020010668 else
10669#endif
Larry Hastings2f936352014-08-05 14:04:04 +100010670 limit = pathconf(path->narrow, name);
Victor Stinner8c62be82010-05-06 00:08:46 +000010671 if (limit == -1 && errno != 0) {
10672 if (errno == EINVAL)
Stefan Krah99439262010-11-26 12:58:05 +000010673 /* could be a path or name problem */
10674 posix_error();
Fred Drakec9680921999-12-13 16:37:25 +000010675 else
Larry Hastings2f936352014-08-05 14:04:04 +100010676 path_error(path);
Victor Stinner8c62be82010-05-06 00:08:46 +000010677 }
Larry Hastings2f936352014-08-05 14:04:04 +100010678
10679 return limit;
Fred Drakec9680921999-12-13 16:37:25 +000010680}
Larry Hastings2f936352014-08-05 14:04:04 +100010681#endif /* HAVE_PATHCONF */
Fred Drakec9680921999-12-13 16:37:25 +000010682
10683#ifdef HAVE_CONFSTR
10684static struct constdef posix_constants_confstr[] = {
Fred Draked86ed291999-12-15 15:34:33 +000010685#ifdef _CS_ARCHITECTURE
Victor Stinner8c62be82010-05-06 00:08:46 +000010686 {"CS_ARCHITECTURE", _CS_ARCHITECTURE},
Fred Draked86ed291999-12-15 15:34:33 +000010687#endif
Mark Dickinson876d7c82010-04-16 12:47:52 +000010688#ifdef _CS_GNU_LIBC_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000010689 {"CS_GNU_LIBC_VERSION", _CS_GNU_LIBC_VERSION},
Mark Dickinson876d7c82010-04-16 12:47:52 +000010690#endif
10691#ifdef _CS_GNU_LIBPTHREAD_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000010692 {"CS_GNU_LIBPTHREAD_VERSION", _CS_GNU_LIBPTHREAD_VERSION},
Mark Dickinson876d7c82010-04-16 12:47:52 +000010693#endif
Fred Draked86ed291999-12-15 15:34:33 +000010694#ifdef _CS_HOSTNAME
Victor Stinner8c62be82010-05-06 00:08:46 +000010695 {"CS_HOSTNAME", _CS_HOSTNAME},
Fred Draked86ed291999-12-15 15:34:33 +000010696#endif
10697#ifdef _CS_HW_PROVIDER
Victor Stinner8c62be82010-05-06 00:08:46 +000010698 {"CS_HW_PROVIDER", _CS_HW_PROVIDER},
Fred Draked86ed291999-12-15 15:34:33 +000010699#endif
10700#ifdef _CS_HW_SERIAL
Victor Stinner8c62be82010-05-06 00:08:46 +000010701 {"CS_HW_SERIAL", _CS_HW_SERIAL},
Fred Draked86ed291999-12-15 15:34:33 +000010702#endif
10703#ifdef _CS_INITTAB_NAME
Victor Stinner8c62be82010-05-06 00:08:46 +000010704 {"CS_INITTAB_NAME", _CS_INITTAB_NAME},
Fred Draked86ed291999-12-15 15:34:33 +000010705#endif
Fred Drakec9680921999-12-13 16:37:25 +000010706#ifdef _CS_LFS64_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010707 {"CS_LFS64_CFLAGS", _CS_LFS64_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010708#endif
10709#ifdef _CS_LFS64_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010710 {"CS_LFS64_LDFLAGS", _CS_LFS64_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010711#endif
10712#ifdef _CS_LFS64_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000010713 {"CS_LFS64_LIBS", _CS_LFS64_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000010714#endif
10715#ifdef _CS_LFS64_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010716 {"CS_LFS64_LINTFLAGS", _CS_LFS64_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010717#endif
10718#ifdef _CS_LFS_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010719 {"CS_LFS_CFLAGS", _CS_LFS_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010720#endif
10721#ifdef _CS_LFS_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010722 {"CS_LFS_LDFLAGS", _CS_LFS_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010723#endif
10724#ifdef _CS_LFS_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000010725 {"CS_LFS_LIBS", _CS_LFS_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000010726#endif
10727#ifdef _CS_LFS_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010728 {"CS_LFS_LINTFLAGS", _CS_LFS_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010729#endif
Fred Draked86ed291999-12-15 15:34:33 +000010730#ifdef _CS_MACHINE
Victor Stinner8c62be82010-05-06 00:08:46 +000010731 {"CS_MACHINE", _CS_MACHINE},
Fred Draked86ed291999-12-15 15:34:33 +000010732#endif
Fred Drakec9680921999-12-13 16:37:25 +000010733#ifdef _CS_PATH
Victor Stinner8c62be82010-05-06 00:08:46 +000010734 {"CS_PATH", _CS_PATH},
Fred Drakec9680921999-12-13 16:37:25 +000010735#endif
Fred Draked86ed291999-12-15 15:34:33 +000010736#ifdef _CS_RELEASE
Victor Stinner8c62be82010-05-06 00:08:46 +000010737 {"CS_RELEASE", _CS_RELEASE},
Fred Draked86ed291999-12-15 15:34:33 +000010738#endif
10739#ifdef _CS_SRPC_DOMAIN
Victor Stinner8c62be82010-05-06 00:08:46 +000010740 {"CS_SRPC_DOMAIN", _CS_SRPC_DOMAIN},
Fred Draked86ed291999-12-15 15:34:33 +000010741#endif
10742#ifdef _CS_SYSNAME
Victor Stinner8c62be82010-05-06 00:08:46 +000010743 {"CS_SYSNAME", _CS_SYSNAME},
Fred Draked86ed291999-12-15 15:34:33 +000010744#endif
10745#ifdef _CS_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000010746 {"CS_VERSION", _CS_VERSION},
Fred Draked86ed291999-12-15 15:34:33 +000010747#endif
Fred Drakec9680921999-12-13 16:37:25 +000010748#ifdef _CS_XBS5_ILP32_OFF32_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010749 {"CS_XBS5_ILP32_OFF32_CFLAGS", _CS_XBS5_ILP32_OFF32_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010750#endif
10751#ifdef _CS_XBS5_ILP32_OFF32_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010752 {"CS_XBS5_ILP32_OFF32_LDFLAGS", _CS_XBS5_ILP32_OFF32_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010753#endif
10754#ifdef _CS_XBS5_ILP32_OFF32_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000010755 {"CS_XBS5_ILP32_OFF32_LIBS", _CS_XBS5_ILP32_OFF32_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000010756#endif
10757#ifdef _CS_XBS5_ILP32_OFF32_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010758 {"CS_XBS5_ILP32_OFF32_LINTFLAGS", _CS_XBS5_ILP32_OFF32_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010759#endif
10760#ifdef _CS_XBS5_ILP32_OFFBIG_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010761 {"CS_XBS5_ILP32_OFFBIG_CFLAGS", _CS_XBS5_ILP32_OFFBIG_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010762#endif
10763#ifdef _CS_XBS5_ILP32_OFFBIG_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010764 {"CS_XBS5_ILP32_OFFBIG_LDFLAGS", _CS_XBS5_ILP32_OFFBIG_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010765#endif
10766#ifdef _CS_XBS5_ILP32_OFFBIG_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000010767 {"CS_XBS5_ILP32_OFFBIG_LIBS", _CS_XBS5_ILP32_OFFBIG_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000010768#endif
10769#ifdef _CS_XBS5_ILP32_OFFBIG_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010770 {"CS_XBS5_ILP32_OFFBIG_LINTFLAGS", _CS_XBS5_ILP32_OFFBIG_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010771#endif
10772#ifdef _CS_XBS5_LP64_OFF64_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010773 {"CS_XBS5_LP64_OFF64_CFLAGS", _CS_XBS5_LP64_OFF64_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010774#endif
10775#ifdef _CS_XBS5_LP64_OFF64_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010776 {"CS_XBS5_LP64_OFF64_LDFLAGS", _CS_XBS5_LP64_OFF64_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010777#endif
10778#ifdef _CS_XBS5_LP64_OFF64_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000010779 {"CS_XBS5_LP64_OFF64_LIBS", _CS_XBS5_LP64_OFF64_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000010780#endif
10781#ifdef _CS_XBS5_LP64_OFF64_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010782 {"CS_XBS5_LP64_OFF64_LINTFLAGS", _CS_XBS5_LP64_OFF64_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010783#endif
10784#ifdef _CS_XBS5_LPBIG_OFFBIG_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010785 {"CS_XBS5_LPBIG_OFFBIG_CFLAGS", _CS_XBS5_LPBIG_OFFBIG_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010786#endif
10787#ifdef _CS_XBS5_LPBIG_OFFBIG_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010788 {"CS_XBS5_LPBIG_OFFBIG_LDFLAGS", _CS_XBS5_LPBIG_OFFBIG_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010789#endif
10790#ifdef _CS_XBS5_LPBIG_OFFBIG_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000010791 {"CS_XBS5_LPBIG_OFFBIG_LIBS", _CS_XBS5_LPBIG_OFFBIG_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000010792#endif
10793#ifdef _CS_XBS5_LPBIG_OFFBIG_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010794 {"CS_XBS5_LPBIG_OFFBIG_LINTFLAGS", _CS_XBS5_LPBIG_OFFBIG_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010795#endif
Fred Draked86ed291999-12-15 15:34:33 +000010796#ifdef _MIPS_CS_AVAIL_PROCESSORS
Victor Stinner8c62be82010-05-06 00:08:46 +000010797 {"MIPS_CS_AVAIL_PROCESSORS", _MIPS_CS_AVAIL_PROCESSORS},
Fred Draked86ed291999-12-15 15:34:33 +000010798#endif
10799#ifdef _MIPS_CS_BASE
Victor Stinner8c62be82010-05-06 00:08:46 +000010800 {"MIPS_CS_BASE", _MIPS_CS_BASE},
Fred Draked86ed291999-12-15 15:34:33 +000010801#endif
10802#ifdef _MIPS_CS_HOSTID
Victor Stinner8c62be82010-05-06 00:08:46 +000010803 {"MIPS_CS_HOSTID", _MIPS_CS_HOSTID},
Fred Draked86ed291999-12-15 15:34:33 +000010804#endif
10805#ifdef _MIPS_CS_HW_NAME
Victor Stinner8c62be82010-05-06 00:08:46 +000010806 {"MIPS_CS_HW_NAME", _MIPS_CS_HW_NAME},
Fred Draked86ed291999-12-15 15:34:33 +000010807#endif
10808#ifdef _MIPS_CS_NUM_PROCESSORS
Victor Stinner8c62be82010-05-06 00:08:46 +000010809 {"MIPS_CS_NUM_PROCESSORS", _MIPS_CS_NUM_PROCESSORS},
Fred Draked86ed291999-12-15 15:34:33 +000010810#endif
10811#ifdef _MIPS_CS_OSREL_MAJ
Victor Stinner8c62be82010-05-06 00:08:46 +000010812 {"MIPS_CS_OSREL_MAJ", _MIPS_CS_OSREL_MAJ},
Fred Draked86ed291999-12-15 15:34:33 +000010813#endif
10814#ifdef _MIPS_CS_OSREL_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000010815 {"MIPS_CS_OSREL_MIN", _MIPS_CS_OSREL_MIN},
Fred Draked86ed291999-12-15 15:34:33 +000010816#endif
10817#ifdef _MIPS_CS_OSREL_PATCH
Victor Stinner8c62be82010-05-06 00:08:46 +000010818 {"MIPS_CS_OSREL_PATCH", _MIPS_CS_OSREL_PATCH},
Fred Draked86ed291999-12-15 15:34:33 +000010819#endif
10820#ifdef _MIPS_CS_OS_NAME
Victor Stinner8c62be82010-05-06 00:08:46 +000010821 {"MIPS_CS_OS_NAME", _MIPS_CS_OS_NAME},
Fred Draked86ed291999-12-15 15:34:33 +000010822#endif
10823#ifdef _MIPS_CS_OS_PROVIDER
Victor Stinner8c62be82010-05-06 00:08:46 +000010824 {"MIPS_CS_OS_PROVIDER", _MIPS_CS_OS_PROVIDER},
Fred Draked86ed291999-12-15 15:34:33 +000010825#endif
10826#ifdef _MIPS_CS_PROCESSORS
Victor Stinner8c62be82010-05-06 00:08:46 +000010827 {"MIPS_CS_PROCESSORS", _MIPS_CS_PROCESSORS},
Fred Draked86ed291999-12-15 15:34:33 +000010828#endif
10829#ifdef _MIPS_CS_SERIAL
Victor Stinner8c62be82010-05-06 00:08:46 +000010830 {"MIPS_CS_SERIAL", _MIPS_CS_SERIAL},
Fred Draked86ed291999-12-15 15:34:33 +000010831#endif
10832#ifdef _MIPS_CS_VENDOR
Victor Stinner8c62be82010-05-06 00:08:46 +000010833 {"MIPS_CS_VENDOR", _MIPS_CS_VENDOR},
Fred Draked86ed291999-12-15 15:34:33 +000010834#endif
Fred Drakec9680921999-12-13 16:37:25 +000010835};
10836
10837static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000010838conv_confstr_confname(PyObject *arg, int *valuep)
Fred Drakec9680921999-12-13 16:37:25 +000010839{
10840 return conv_confname(arg, valuep, posix_constants_confstr,
10841 sizeof(posix_constants_confstr)
10842 / sizeof(struct constdef));
10843}
10844
Larry Hastings2f936352014-08-05 14:04:04 +100010845
10846/*[clinic input]
10847os.confstr
10848
10849 name: confstr_confname
10850 /
10851
10852Return a string-valued system configuration variable.
10853[clinic start generated code]*/
10854
Larry Hastings2f936352014-08-05 14:04:04 +100010855static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010856os_confstr_impl(PyObject *module, int name)
10857/*[clinic end generated code: output=bfb0b1b1e49b9383 input=18fb4d0567242e65]*/
Fred Drakec9680921999-12-13 16:37:25 +000010858{
10859 PyObject *result = NULL;
Victor Stinnercb043522010-09-10 23:49:04 +000010860 char buffer[255];
Victor Stinnerdd3a6a52013-06-25 23:13:47 +020010861 size_t len;
Fred Drakec9680921999-12-13 16:37:25 +000010862
Victor Stinnercb043522010-09-10 23:49:04 +000010863 errno = 0;
10864 len = confstr(name, buffer, sizeof(buffer));
10865 if (len == 0) {
10866 if (errno) {
10867 posix_error();
10868 return NULL;
Fred Drakec9680921999-12-13 16:37:25 +000010869 }
10870 else {
Victor Stinnercb043522010-09-10 23:49:04 +000010871 Py_RETURN_NONE;
Fred Drakec9680921999-12-13 16:37:25 +000010872 }
10873 }
Victor Stinnercb043522010-09-10 23:49:04 +000010874
Victor Stinnerdd3a6a52013-06-25 23:13:47 +020010875 if (len >= sizeof(buffer)) {
Victor Stinnercbc18f32014-12-05 22:51:51 +010010876 size_t len2;
Victor Stinnercb043522010-09-10 23:49:04 +000010877 char *buf = PyMem_Malloc(len);
10878 if (buf == NULL)
10879 return PyErr_NoMemory();
Victor Stinnercbc18f32014-12-05 22:51:51 +010010880 len2 = confstr(name, buf, len);
10881 assert(len == len2);
Christian Heimes8714cfd2015-04-21 10:57:41 +020010882 result = PyUnicode_DecodeFSDefaultAndSize(buf, len2-1);
Victor Stinnercb043522010-09-10 23:49:04 +000010883 PyMem_Free(buf);
10884 }
10885 else
10886 result = PyUnicode_DecodeFSDefaultAndSize(buffer, len-1);
Fred Drakec9680921999-12-13 16:37:25 +000010887 return result;
10888}
Larry Hastings2f936352014-08-05 14:04:04 +100010889#endif /* HAVE_CONFSTR */
Fred Drakec9680921999-12-13 16:37:25 +000010890
10891
10892#ifdef HAVE_SYSCONF
10893static struct constdef posix_constants_sysconf[] = {
10894#ifdef _SC_2_CHAR_TERM
Victor Stinner8c62be82010-05-06 00:08:46 +000010895 {"SC_2_CHAR_TERM", _SC_2_CHAR_TERM},
Fred Drakec9680921999-12-13 16:37:25 +000010896#endif
10897#ifdef _SC_2_C_BIND
Victor Stinner8c62be82010-05-06 00:08:46 +000010898 {"SC_2_C_BIND", _SC_2_C_BIND},
Fred Drakec9680921999-12-13 16:37:25 +000010899#endif
10900#ifdef _SC_2_C_DEV
Victor Stinner8c62be82010-05-06 00:08:46 +000010901 {"SC_2_C_DEV", _SC_2_C_DEV},
Fred Drakec9680921999-12-13 16:37:25 +000010902#endif
10903#ifdef _SC_2_C_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000010904 {"SC_2_C_VERSION", _SC_2_C_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000010905#endif
10906#ifdef _SC_2_FORT_DEV
Victor Stinner8c62be82010-05-06 00:08:46 +000010907 {"SC_2_FORT_DEV", _SC_2_FORT_DEV},
Fred Drakec9680921999-12-13 16:37:25 +000010908#endif
10909#ifdef _SC_2_FORT_RUN
Victor Stinner8c62be82010-05-06 00:08:46 +000010910 {"SC_2_FORT_RUN", _SC_2_FORT_RUN},
Fred Drakec9680921999-12-13 16:37:25 +000010911#endif
10912#ifdef _SC_2_LOCALEDEF
Victor Stinner8c62be82010-05-06 00:08:46 +000010913 {"SC_2_LOCALEDEF", _SC_2_LOCALEDEF},
Fred Drakec9680921999-12-13 16:37:25 +000010914#endif
10915#ifdef _SC_2_SW_DEV
Victor Stinner8c62be82010-05-06 00:08:46 +000010916 {"SC_2_SW_DEV", _SC_2_SW_DEV},
Fred Drakec9680921999-12-13 16:37:25 +000010917#endif
10918#ifdef _SC_2_UPE
Victor Stinner8c62be82010-05-06 00:08:46 +000010919 {"SC_2_UPE", _SC_2_UPE},
Fred Drakec9680921999-12-13 16:37:25 +000010920#endif
10921#ifdef _SC_2_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000010922 {"SC_2_VERSION", _SC_2_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000010923#endif
Fred Draked86ed291999-12-15 15:34:33 +000010924#ifdef _SC_ABI_ASYNCHRONOUS_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000010925 {"SC_ABI_ASYNCHRONOUS_IO", _SC_ABI_ASYNCHRONOUS_IO},
Fred Draked86ed291999-12-15 15:34:33 +000010926#endif
10927#ifdef _SC_ACL
Victor Stinner8c62be82010-05-06 00:08:46 +000010928 {"SC_ACL", _SC_ACL},
Fred Draked86ed291999-12-15 15:34:33 +000010929#endif
Fred Drakec9680921999-12-13 16:37:25 +000010930#ifdef _SC_AIO_LISTIO_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010931 {"SC_AIO_LISTIO_MAX", _SC_AIO_LISTIO_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010932#endif
Fred Drakec9680921999-12-13 16:37:25 +000010933#ifdef _SC_AIO_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010934 {"SC_AIO_MAX", _SC_AIO_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010935#endif
10936#ifdef _SC_AIO_PRIO_DELTA_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010937 {"SC_AIO_PRIO_DELTA_MAX", _SC_AIO_PRIO_DELTA_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010938#endif
10939#ifdef _SC_ARG_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010940 {"SC_ARG_MAX", _SC_ARG_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010941#endif
10942#ifdef _SC_ASYNCHRONOUS_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000010943 {"SC_ASYNCHRONOUS_IO", _SC_ASYNCHRONOUS_IO},
Fred Drakec9680921999-12-13 16:37:25 +000010944#endif
10945#ifdef _SC_ATEXIT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010946 {"SC_ATEXIT_MAX", _SC_ATEXIT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010947#endif
Fred Draked86ed291999-12-15 15:34:33 +000010948#ifdef _SC_AUDIT
Victor Stinner8c62be82010-05-06 00:08:46 +000010949 {"SC_AUDIT", _SC_AUDIT},
Fred Draked86ed291999-12-15 15:34:33 +000010950#endif
Fred Drakec9680921999-12-13 16:37:25 +000010951#ifdef _SC_AVPHYS_PAGES
Victor Stinner8c62be82010-05-06 00:08:46 +000010952 {"SC_AVPHYS_PAGES", _SC_AVPHYS_PAGES},
Fred Drakec9680921999-12-13 16:37:25 +000010953#endif
10954#ifdef _SC_BC_BASE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010955 {"SC_BC_BASE_MAX", _SC_BC_BASE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010956#endif
10957#ifdef _SC_BC_DIM_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010958 {"SC_BC_DIM_MAX", _SC_BC_DIM_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010959#endif
10960#ifdef _SC_BC_SCALE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010961 {"SC_BC_SCALE_MAX", _SC_BC_SCALE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010962#endif
10963#ifdef _SC_BC_STRING_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010964 {"SC_BC_STRING_MAX", _SC_BC_STRING_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010965#endif
Fred Draked86ed291999-12-15 15:34:33 +000010966#ifdef _SC_CAP
Victor Stinner8c62be82010-05-06 00:08:46 +000010967 {"SC_CAP", _SC_CAP},
Fred Draked86ed291999-12-15 15:34:33 +000010968#endif
Fred Drakec9680921999-12-13 16:37:25 +000010969#ifdef _SC_CHARCLASS_NAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010970 {"SC_CHARCLASS_NAME_MAX", _SC_CHARCLASS_NAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010971#endif
10972#ifdef _SC_CHAR_BIT
Victor Stinner8c62be82010-05-06 00:08:46 +000010973 {"SC_CHAR_BIT", _SC_CHAR_BIT},
Fred Drakec9680921999-12-13 16:37:25 +000010974#endif
10975#ifdef _SC_CHAR_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010976 {"SC_CHAR_MAX", _SC_CHAR_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010977#endif
10978#ifdef _SC_CHAR_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000010979 {"SC_CHAR_MIN", _SC_CHAR_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000010980#endif
10981#ifdef _SC_CHILD_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010982 {"SC_CHILD_MAX", _SC_CHILD_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010983#endif
10984#ifdef _SC_CLK_TCK
Victor Stinner8c62be82010-05-06 00:08:46 +000010985 {"SC_CLK_TCK", _SC_CLK_TCK},
Fred Drakec9680921999-12-13 16:37:25 +000010986#endif
10987#ifdef _SC_COHER_BLKSZ
Victor Stinner8c62be82010-05-06 00:08:46 +000010988 {"SC_COHER_BLKSZ", _SC_COHER_BLKSZ},
Fred Drakec9680921999-12-13 16:37:25 +000010989#endif
10990#ifdef _SC_COLL_WEIGHTS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010991 {"SC_COLL_WEIGHTS_MAX", _SC_COLL_WEIGHTS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010992#endif
10993#ifdef _SC_DCACHE_ASSOC
Victor Stinner8c62be82010-05-06 00:08:46 +000010994 {"SC_DCACHE_ASSOC", _SC_DCACHE_ASSOC},
Fred Drakec9680921999-12-13 16:37:25 +000010995#endif
10996#ifdef _SC_DCACHE_BLKSZ
Victor Stinner8c62be82010-05-06 00:08:46 +000010997 {"SC_DCACHE_BLKSZ", _SC_DCACHE_BLKSZ},
Fred Drakec9680921999-12-13 16:37:25 +000010998#endif
10999#ifdef _SC_DCACHE_LINESZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011000 {"SC_DCACHE_LINESZ", _SC_DCACHE_LINESZ},
Fred Drakec9680921999-12-13 16:37:25 +000011001#endif
11002#ifdef _SC_DCACHE_SZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011003 {"SC_DCACHE_SZ", _SC_DCACHE_SZ},
Fred Drakec9680921999-12-13 16:37:25 +000011004#endif
11005#ifdef _SC_DCACHE_TBLKSZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011006 {"SC_DCACHE_TBLKSZ", _SC_DCACHE_TBLKSZ},
Fred Drakec9680921999-12-13 16:37:25 +000011007#endif
11008#ifdef _SC_DELAYTIMER_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011009 {"SC_DELAYTIMER_MAX", _SC_DELAYTIMER_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011010#endif
11011#ifdef _SC_EQUIV_CLASS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011012 {"SC_EQUIV_CLASS_MAX", _SC_EQUIV_CLASS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011013#endif
11014#ifdef _SC_EXPR_NEST_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011015 {"SC_EXPR_NEST_MAX", _SC_EXPR_NEST_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011016#endif
11017#ifdef _SC_FSYNC
Victor Stinner8c62be82010-05-06 00:08:46 +000011018 {"SC_FSYNC", _SC_FSYNC},
Fred Drakec9680921999-12-13 16:37:25 +000011019#endif
11020#ifdef _SC_GETGR_R_SIZE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011021 {"SC_GETGR_R_SIZE_MAX", _SC_GETGR_R_SIZE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011022#endif
11023#ifdef _SC_GETPW_R_SIZE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011024 {"SC_GETPW_R_SIZE_MAX", _SC_GETPW_R_SIZE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011025#endif
11026#ifdef _SC_ICACHE_ASSOC
Victor Stinner8c62be82010-05-06 00:08:46 +000011027 {"SC_ICACHE_ASSOC", _SC_ICACHE_ASSOC},
Fred Drakec9680921999-12-13 16:37:25 +000011028#endif
11029#ifdef _SC_ICACHE_BLKSZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011030 {"SC_ICACHE_BLKSZ", _SC_ICACHE_BLKSZ},
Fred Drakec9680921999-12-13 16:37:25 +000011031#endif
11032#ifdef _SC_ICACHE_LINESZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011033 {"SC_ICACHE_LINESZ", _SC_ICACHE_LINESZ},
Fred Drakec9680921999-12-13 16:37:25 +000011034#endif
11035#ifdef _SC_ICACHE_SZ
Victor Stinner8c62be82010-05-06 00:08:46 +000011036 {"SC_ICACHE_SZ", _SC_ICACHE_SZ},
Fred Drakec9680921999-12-13 16:37:25 +000011037#endif
Fred Draked86ed291999-12-15 15:34:33 +000011038#ifdef _SC_INF
Victor Stinner8c62be82010-05-06 00:08:46 +000011039 {"SC_INF", _SC_INF},
Fred Draked86ed291999-12-15 15:34:33 +000011040#endif
Fred Drakec9680921999-12-13 16:37:25 +000011041#ifdef _SC_INT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011042 {"SC_INT_MAX", _SC_INT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011043#endif
11044#ifdef _SC_INT_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000011045 {"SC_INT_MIN", _SC_INT_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000011046#endif
11047#ifdef _SC_IOV_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011048 {"SC_IOV_MAX", _SC_IOV_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011049#endif
Fred Draked86ed291999-12-15 15:34:33 +000011050#ifdef _SC_IP_SECOPTS
Victor Stinner8c62be82010-05-06 00:08:46 +000011051 {"SC_IP_SECOPTS", _SC_IP_SECOPTS},
Fred Draked86ed291999-12-15 15:34:33 +000011052#endif
Fred Drakec9680921999-12-13 16:37:25 +000011053#ifdef _SC_JOB_CONTROL
Victor Stinner8c62be82010-05-06 00:08:46 +000011054 {"SC_JOB_CONTROL", _SC_JOB_CONTROL},
Fred Drakec9680921999-12-13 16:37:25 +000011055#endif
Fred Draked86ed291999-12-15 15:34:33 +000011056#ifdef _SC_KERN_POINTERS
Victor Stinner8c62be82010-05-06 00:08:46 +000011057 {"SC_KERN_POINTERS", _SC_KERN_POINTERS},
Fred Draked86ed291999-12-15 15:34:33 +000011058#endif
11059#ifdef _SC_KERN_SIM
Victor Stinner8c62be82010-05-06 00:08:46 +000011060 {"SC_KERN_SIM", _SC_KERN_SIM},
Fred Draked86ed291999-12-15 15:34:33 +000011061#endif
Fred Drakec9680921999-12-13 16:37:25 +000011062#ifdef _SC_LINE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011063 {"SC_LINE_MAX", _SC_LINE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011064#endif
11065#ifdef _SC_LOGIN_NAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011066 {"SC_LOGIN_NAME_MAX", _SC_LOGIN_NAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011067#endif
11068#ifdef _SC_LOGNAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011069 {"SC_LOGNAME_MAX", _SC_LOGNAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011070#endif
11071#ifdef _SC_LONG_BIT
Victor Stinner8c62be82010-05-06 00:08:46 +000011072 {"SC_LONG_BIT", _SC_LONG_BIT},
Fred Drakec9680921999-12-13 16:37:25 +000011073#endif
Fred Draked86ed291999-12-15 15:34:33 +000011074#ifdef _SC_MAC
Victor Stinner8c62be82010-05-06 00:08:46 +000011075 {"SC_MAC", _SC_MAC},
Fred Draked86ed291999-12-15 15:34:33 +000011076#endif
Fred Drakec9680921999-12-13 16:37:25 +000011077#ifdef _SC_MAPPED_FILES
Victor Stinner8c62be82010-05-06 00:08:46 +000011078 {"SC_MAPPED_FILES", _SC_MAPPED_FILES},
Fred Drakec9680921999-12-13 16:37:25 +000011079#endif
11080#ifdef _SC_MAXPID
Victor Stinner8c62be82010-05-06 00:08:46 +000011081 {"SC_MAXPID", _SC_MAXPID},
Fred Drakec9680921999-12-13 16:37:25 +000011082#endif
11083#ifdef _SC_MB_LEN_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011084 {"SC_MB_LEN_MAX", _SC_MB_LEN_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011085#endif
11086#ifdef _SC_MEMLOCK
Victor Stinner8c62be82010-05-06 00:08:46 +000011087 {"SC_MEMLOCK", _SC_MEMLOCK},
Fred Drakec9680921999-12-13 16:37:25 +000011088#endif
11089#ifdef _SC_MEMLOCK_RANGE
Victor Stinner8c62be82010-05-06 00:08:46 +000011090 {"SC_MEMLOCK_RANGE", _SC_MEMLOCK_RANGE},
Fred Drakec9680921999-12-13 16:37:25 +000011091#endif
11092#ifdef _SC_MEMORY_PROTECTION
Victor Stinner8c62be82010-05-06 00:08:46 +000011093 {"SC_MEMORY_PROTECTION", _SC_MEMORY_PROTECTION},
Fred Drakec9680921999-12-13 16:37:25 +000011094#endif
11095#ifdef _SC_MESSAGE_PASSING
Victor Stinner8c62be82010-05-06 00:08:46 +000011096 {"SC_MESSAGE_PASSING", _SC_MESSAGE_PASSING},
Fred Drakec9680921999-12-13 16:37:25 +000011097#endif
Fred Draked86ed291999-12-15 15:34:33 +000011098#ifdef _SC_MMAP_FIXED_ALIGNMENT
Victor Stinner8c62be82010-05-06 00:08:46 +000011099 {"SC_MMAP_FIXED_ALIGNMENT", _SC_MMAP_FIXED_ALIGNMENT},
Fred Draked86ed291999-12-15 15:34:33 +000011100#endif
Fred Drakec9680921999-12-13 16:37:25 +000011101#ifdef _SC_MQ_OPEN_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011102 {"SC_MQ_OPEN_MAX", _SC_MQ_OPEN_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011103#endif
11104#ifdef _SC_MQ_PRIO_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011105 {"SC_MQ_PRIO_MAX", _SC_MQ_PRIO_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011106#endif
Fred Draked86ed291999-12-15 15:34:33 +000011107#ifdef _SC_NACLS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011108 {"SC_NACLS_MAX", _SC_NACLS_MAX},
Fred Draked86ed291999-12-15 15:34:33 +000011109#endif
Fred Drakec9680921999-12-13 16:37:25 +000011110#ifdef _SC_NGROUPS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011111 {"SC_NGROUPS_MAX", _SC_NGROUPS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011112#endif
11113#ifdef _SC_NL_ARGMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011114 {"SC_NL_ARGMAX", _SC_NL_ARGMAX},
Fred Drakec9680921999-12-13 16:37:25 +000011115#endif
11116#ifdef _SC_NL_LANGMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011117 {"SC_NL_LANGMAX", _SC_NL_LANGMAX},
Fred Drakec9680921999-12-13 16:37:25 +000011118#endif
11119#ifdef _SC_NL_MSGMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011120 {"SC_NL_MSGMAX", _SC_NL_MSGMAX},
Fred Drakec9680921999-12-13 16:37:25 +000011121#endif
11122#ifdef _SC_NL_NMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011123 {"SC_NL_NMAX", _SC_NL_NMAX},
Fred Drakec9680921999-12-13 16:37:25 +000011124#endif
11125#ifdef _SC_NL_SETMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011126 {"SC_NL_SETMAX", _SC_NL_SETMAX},
Fred Drakec9680921999-12-13 16:37:25 +000011127#endif
11128#ifdef _SC_NL_TEXTMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011129 {"SC_NL_TEXTMAX", _SC_NL_TEXTMAX},
Fred Drakec9680921999-12-13 16:37:25 +000011130#endif
11131#ifdef _SC_NPROCESSORS_CONF
Victor Stinner8c62be82010-05-06 00:08:46 +000011132 {"SC_NPROCESSORS_CONF", _SC_NPROCESSORS_CONF},
Fred Drakec9680921999-12-13 16:37:25 +000011133#endif
11134#ifdef _SC_NPROCESSORS_ONLN
Victor Stinner8c62be82010-05-06 00:08:46 +000011135 {"SC_NPROCESSORS_ONLN", _SC_NPROCESSORS_ONLN},
Fred Drakec9680921999-12-13 16:37:25 +000011136#endif
Fred Draked86ed291999-12-15 15:34:33 +000011137#ifdef _SC_NPROC_CONF
Victor Stinner8c62be82010-05-06 00:08:46 +000011138 {"SC_NPROC_CONF", _SC_NPROC_CONF},
Fred Draked86ed291999-12-15 15:34:33 +000011139#endif
11140#ifdef _SC_NPROC_ONLN
Victor Stinner8c62be82010-05-06 00:08:46 +000011141 {"SC_NPROC_ONLN", _SC_NPROC_ONLN},
Fred Draked86ed291999-12-15 15:34:33 +000011142#endif
Fred Drakec9680921999-12-13 16:37:25 +000011143#ifdef _SC_NZERO
Victor Stinner8c62be82010-05-06 00:08:46 +000011144 {"SC_NZERO", _SC_NZERO},
Fred Drakec9680921999-12-13 16:37:25 +000011145#endif
11146#ifdef _SC_OPEN_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011147 {"SC_OPEN_MAX", _SC_OPEN_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011148#endif
11149#ifdef _SC_PAGESIZE
Victor Stinner8c62be82010-05-06 00:08:46 +000011150 {"SC_PAGESIZE", _SC_PAGESIZE},
Fred Drakec9680921999-12-13 16:37:25 +000011151#endif
11152#ifdef _SC_PAGE_SIZE
Victor Stinner8c62be82010-05-06 00:08:46 +000011153 {"SC_PAGE_SIZE", _SC_PAGE_SIZE},
Fred Drakec9680921999-12-13 16:37:25 +000011154#endif
11155#ifdef _SC_PASS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011156 {"SC_PASS_MAX", _SC_PASS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011157#endif
11158#ifdef _SC_PHYS_PAGES
Victor Stinner8c62be82010-05-06 00:08:46 +000011159 {"SC_PHYS_PAGES", _SC_PHYS_PAGES},
Fred Drakec9680921999-12-13 16:37:25 +000011160#endif
11161#ifdef _SC_PII
Victor Stinner8c62be82010-05-06 00:08:46 +000011162 {"SC_PII", _SC_PII},
Fred Drakec9680921999-12-13 16:37:25 +000011163#endif
11164#ifdef _SC_PII_INTERNET
Victor Stinner8c62be82010-05-06 00:08:46 +000011165 {"SC_PII_INTERNET", _SC_PII_INTERNET},
Fred Drakec9680921999-12-13 16:37:25 +000011166#endif
11167#ifdef _SC_PII_INTERNET_DGRAM
Victor Stinner8c62be82010-05-06 00:08:46 +000011168 {"SC_PII_INTERNET_DGRAM", _SC_PII_INTERNET_DGRAM},
Fred Drakec9680921999-12-13 16:37:25 +000011169#endif
11170#ifdef _SC_PII_INTERNET_STREAM
Victor Stinner8c62be82010-05-06 00:08:46 +000011171 {"SC_PII_INTERNET_STREAM", _SC_PII_INTERNET_STREAM},
Fred Drakec9680921999-12-13 16:37:25 +000011172#endif
11173#ifdef _SC_PII_OSI
Victor Stinner8c62be82010-05-06 00:08:46 +000011174 {"SC_PII_OSI", _SC_PII_OSI},
Fred Drakec9680921999-12-13 16:37:25 +000011175#endif
11176#ifdef _SC_PII_OSI_CLTS
Victor Stinner8c62be82010-05-06 00:08:46 +000011177 {"SC_PII_OSI_CLTS", _SC_PII_OSI_CLTS},
Fred Drakec9680921999-12-13 16:37:25 +000011178#endif
11179#ifdef _SC_PII_OSI_COTS
Victor Stinner8c62be82010-05-06 00:08:46 +000011180 {"SC_PII_OSI_COTS", _SC_PII_OSI_COTS},
Fred Drakec9680921999-12-13 16:37:25 +000011181#endif
11182#ifdef _SC_PII_OSI_M
Victor Stinner8c62be82010-05-06 00:08:46 +000011183 {"SC_PII_OSI_M", _SC_PII_OSI_M},
Fred Drakec9680921999-12-13 16:37:25 +000011184#endif
11185#ifdef _SC_PII_SOCKET
Victor Stinner8c62be82010-05-06 00:08:46 +000011186 {"SC_PII_SOCKET", _SC_PII_SOCKET},
Fred Drakec9680921999-12-13 16:37:25 +000011187#endif
11188#ifdef _SC_PII_XTI
Victor Stinner8c62be82010-05-06 00:08:46 +000011189 {"SC_PII_XTI", _SC_PII_XTI},
Fred Drakec9680921999-12-13 16:37:25 +000011190#endif
11191#ifdef _SC_POLL
Victor Stinner8c62be82010-05-06 00:08:46 +000011192 {"SC_POLL", _SC_POLL},
Fred Drakec9680921999-12-13 16:37:25 +000011193#endif
11194#ifdef _SC_PRIORITIZED_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000011195 {"SC_PRIORITIZED_IO", _SC_PRIORITIZED_IO},
Fred Drakec9680921999-12-13 16:37:25 +000011196#endif
11197#ifdef _SC_PRIORITY_SCHEDULING
Victor Stinner8c62be82010-05-06 00:08:46 +000011198 {"SC_PRIORITY_SCHEDULING", _SC_PRIORITY_SCHEDULING},
Fred Drakec9680921999-12-13 16:37:25 +000011199#endif
11200#ifdef _SC_REALTIME_SIGNALS
Victor Stinner8c62be82010-05-06 00:08:46 +000011201 {"SC_REALTIME_SIGNALS", _SC_REALTIME_SIGNALS},
Fred Drakec9680921999-12-13 16:37:25 +000011202#endif
11203#ifdef _SC_RE_DUP_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011204 {"SC_RE_DUP_MAX", _SC_RE_DUP_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011205#endif
11206#ifdef _SC_RTSIG_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011207 {"SC_RTSIG_MAX", _SC_RTSIG_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011208#endif
11209#ifdef _SC_SAVED_IDS
Victor Stinner8c62be82010-05-06 00:08:46 +000011210 {"SC_SAVED_IDS", _SC_SAVED_IDS},
Fred Drakec9680921999-12-13 16:37:25 +000011211#endif
11212#ifdef _SC_SCHAR_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011213 {"SC_SCHAR_MAX", _SC_SCHAR_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011214#endif
11215#ifdef _SC_SCHAR_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000011216 {"SC_SCHAR_MIN", _SC_SCHAR_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000011217#endif
11218#ifdef _SC_SELECT
Victor Stinner8c62be82010-05-06 00:08:46 +000011219 {"SC_SELECT", _SC_SELECT},
Fred Drakec9680921999-12-13 16:37:25 +000011220#endif
11221#ifdef _SC_SEMAPHORES
Victor Stinner8c62be82010-05-06 00:08:46 +000011222 {"SC_SEMAPHORES", _SC_SEMAPHORES},
Fred Drakec9680921999-12-13 16:37:25 +000011223#endif
11224#ifdef _SC_SEM_NSEMS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011225 {"SC_SEM_NSEMS_MAX", _SC_SEM_NSEMS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011226#endif
11227#ifdef _SC_SEM_VALUE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011228 {"SC_SEM_VALUE_MAX", _SC_SEM_VALUE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011229#endif
11230#ifdef _SC_SHARED_MEMORY_OBJECTS
Victor Stinner8c62be82010-05-06 00:08:46 +000011231 {"SC_SHARED_MEMORY_OBJECTS", _SC_SHARED_MEMORY_OBJECTS},
Fred Drakec9680921999-12-13 16:37:25 +000011232#endif
11233#ifdef _SC_SHRT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011234 {"SC_SHRT_MAX", _SC_SHRT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011235#endif
11236#ifdef _SC_SHRT_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000011237 {"SC_SHRT_MIN", _SC_SHRT_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000011238#endif
11239#ifdef _SC_SIGQUEUE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011240 {"SC_SIGQUEUE_MAX", _SC_SIGQUEUE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011241#endif
11242#ifdef _SC_SIGRT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011243 {"SC_SIGRT_MAX", _SC_SIGRT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011244#endif
11245#ifdef _SC_SIGRT_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000011246 {"SC_SIGRT_MIN", _SC_SIGRT_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000011247#endif
Fred Draked86ed291999-12-15 15:34:33 +000011248#ifdef _SC_SOFTPOWER
Victor Stinner8c62be82010-05-06 00:08:46 +000011249 {"SC_SOFTPOWER", _SC_SOFTPOWER},
Fred Draked86ed291999-12-15 15:34:33 +000011250#endif
Fred Drakec9680921999-12-13 16:37:25 +000011251#ifdef _SC_SPLIT_CACHE
Victor Stinner8c62be82010-05-06 00:08:46 +000011252 {"SC_SPLIT_CACHE", _SC_SPLIT_CACHE},
Fred Drakec9680921999-12-13 16:37:25 +000011253#endif
11254#ifdef _SC_SSIZE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011255 {"SC_SSIZE_MAX", _SC_SSIZE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011256#endif
11257#ifdef _SC_STACK_PROT
Victor Stinner8c62be82010-05-06 00:08:46 +000011258 {"SC_STACK_PROT", _SC_STACK_PROT},
Fred Drakec9680921999-12-13 16:37:25 +000011259#endif
11260#ifdef _SC_STREAM_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011261 {"SC_STREAM_MAX", _SC_STREAM_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011262#endif
11263#ifdef _SC_SYNCHRONIZED_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000011264 {"SC_SYNCHRONIZED_IO", _SC_SYNCHRONIZED_IO},
Fred Drakec9680921999-12-13 16:37:25 +000011265#endif
11266#ifdef _SC_THREADS
Victor Stinner8c62be82010-05-06 00:08:46 +000011267 {"SC_THREADS", _SC_THREADS},
Fred Drakec9680921999-12-13 16:37:25 +000011268#endif
11269#ifdef _SC_THREAD_ATTR_STACKADDR
Victor Stinner8c62be82010-05-06 00:08:46 +000011270 {"SC_THREAD_ATTR_STACKADDR", _SC_THREAD_ATTR_STACKADDR},
Fred Drakec9680921999-12-13 16:37:25 +000011271#endif
11272#ifdef _SC_THREAD_ATTR_STACKSIZE
Victor Stinner8c62be82010-05-06 00:08:46 +000011273 {"SC_THREAD_ATTR_STACKSIZE", _SC_THREAD_ATTR_STACKSIZE},
Fred Drakec9680921999-12-13 16:37:25 +000011274#endif
11275#ifdef _SC_THREAD_DESTRUCTOR_ITERATIONS
Victor Stinner8c62be82010-05-06 00:08:46 +000011276 {"SC_THREAD_DESTRUCTOR_ITERATIONS", _SC_THREAD_DESTRUCTOR_ITERATIONS},
Fred Drakec9680921999-12-13 16:37:25 +000011277#endif
11278#ifdef _SC_THREAD_KEYS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011279 {"SC_THREAD_KEYS_MAX", _SC_THREAD_KEYS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011280#endif
11281#ifdef _SC_THREAD_PRIORITY_SCHEDULING
Victor Stinner8c62be82010-05-06 00:08:46 +000011282 {"SC_THREAD_PRIORITY_SCHEDULING", _SC_THREAD_PRIORITY_SCHEDULING},
Fred Drakec9680921999-12-13 16:37:25 +000011283#endif
11284#ifdef _SC_THREAD_PRIO_INHERIT
Victor Stinner8c62be82010-05-06 00:08:46 +000011285 {"SC_THREAD_PRIO_INHERIT", _SC_THREAD_PRIO_INHERIT},
Fred Drakec9680921999-12-13 16:37:25 +000011286#endif
11287#ifdef _SC_THREAD_PRIO_PROTECT
Victor Stinner8c62be82010-05-06 00:08:46 +000011288 {"SC_THREAD_PRIO_PROTECT", _SC_THREAD_PRIO_PROTECT},
Fred Drakec9680921999-12-13 16:37:25 +000011289#endif
11290#ifdef _SC_THREAD_PROCESS_SHARED
Victor Stinner8c62be82010-05-06 00:08:46 +000011291 {"SC_THREAD_PROCESS_SHARED", _SC_THREAD_PROCESS_SHARED},
Fred Drakec9680921999-12-13 16:37:25 +000011292#endif
11293#ifdef _SC_THREAD_SAFE_FUNCTIONS
Victor Stinner8c62be82010-05-06 00:08:46 +000011294 {"SC_THREAD_SAFE_FUNCTIONS", _SC_THREAD_SAFE_FUNCTIONS},
Fred Drakec9680921999-12-13 16:37:25 +000011295#endif
11296#ifdef _SC_THREAD_STACK_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000011297 {"SC_THREAD_STACK_MIN", _SC_THREAD_STACK_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000011298#endif
11299#ifdef _SC_THREAD_THREADS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011300 {"SC_THREAD_THREADS_MAX", _SC_THREAD_THREADS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011301#endif
11302#ifdef _SC_TIMERS
Victor Stinner8c62be82010-05-06 00:08:46 +000011303 {"SC_TIMERS", _SC_TIMERS},
Fred Drakec9680921999-12-13 16:37:25 +000011304#endif
11305#ifdef _SC_TIMER_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011306 {"SC_TIMER_MAX", _SC_TIMER_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011307#endif
11308#ifdef _SC_TTY_NAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011309 {"SC_TTY_NAME_MAX", _SC_TTY_NAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011310#endif
11311#ifdef _SC_TZNAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011312 {"SC_TZNAME_MAX", _SC_TZNAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011313#endif
11314#ifdef _SC_T_IOV_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011315 {"SC_T_IOV_MAX", _SC_T_IOV_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011316#endif
11317#ifdef _SC_UCHAR_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011318 {"SC_UCHAR_MAX", _SC_UCHAR_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011319#endif
11320#ifdef _SC_UINT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011321 {"SC_UINT_MAX", _SC_UINT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011322#endif
11323#ifdef _SC_UIO_MAXIOV
Victor Stinner8c62be82010-05-06 00:08:46 +000011324 {"SC_UIO_MAXIOV", _SC_UIO_MAXIOV},
Fred Drakec9680921999-12-13 16:37:25 +000011325#endif
11326#ifdef _SC_ULONG_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011327 {"SC_ULONG_MAX", _SC_ULONG_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011328#endif
11329#ifdef _SC_USHRT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000011330 {"SC_USHRT_MAX", _SC_USHRT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000011331#endif
11332#ifdef _SC_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000011333 {"SC_VERSION", _SC_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000011334#endif
11335#ifdef _SC_WORD_BIT
Victor Stinner8c62be82010-05-06 00:08:46 +000011336 {"SC_WORD_BIT", _SC_WORD_BIT},
Fred Drakec9680921999-12-13 16:37:25 +000011337#endif
11338#ifdef _SC_XBS5_ILP32_OFF32
Victor Stinner8c62be82010-05-06 00:08:46 +000011339 {"SC_XBS5_ILP32_OFF32", _SC_XBS5_ILP32_OFF32},
Fred Drakec9680921999-12-13 16:37:25 +000011340#endif
11341#ifdef _SC_XBS5_ILP32_OFFBIG
Victor Stinner8c62be82010-05-06 00:08:46 +000011342 {"SC_XBS5_ILP32_OFFBIG", _SC_XBS5_ILP32_OFFBIG},
Fred Drakec9680921999-12-13 16:37:25 +000011343#endif
11344#ifdef _SC_XBS5_LP64_OFF64
Victor Stinner8c62be82010-05-06 00:08:46 +000011345 {"SC_XBS5_LP64_OFF64", _SC_XBS5_LP64_OFF64},
Fred Drakec9680921999-12-13 16:37:25 +000011346#endif
11347#ifdef _SC_XBS5_LPBIG_OFFBIG
Victor Stinner8c62be82010-05-06 00:08:46 +000011348 {"SC_XBS5_LPBIG_OFFBIG", _SC_XBS5_LPBIG_OFFBIG},
Fred Drakec9680921999-12-13 16:37:25 +000011349#endif
11350#ifdef _SC_XOPEN_CRYPT
Victor Stinner8c62be82010-05-06 00:08:46 +000011351 {"SC_XOPEN_CRYPT", _SC_XOPEN_CRYPT},
Fred Drakec9680921999-12-13 16:37:25 +000011352#endif
11353#ifdef _SC_XOPEN_ENH_I18N
Victor Stinner8c62be82010-05-06 00:08:46 +000011354 {"SC_XOPEN_ENH_I18N", _SC_XOPEN_ENH_I18N},
Fred Drakec9680921999-12-13 16:37:25 +000011355#endif
11356#ifdef _SC_XOPEN_LEGACY
Victor Stinner8c62be82010-05-06 00:08:46 +000011357 {"SC_XOPEN_LEGACY", _SC_XOPEN_LEGACY},
Fred Drakec9680921999-12-13 16:37:25 +000011358#endif
11359#ifdef _SC_XOPEN_REALTIME
Victor Stinner8c62be82010-05-06 00:08:46 +000011360 {"SC_XOPEN_REALTIME", _SC_XOPEN_REALTIME},
Fred Drakec9680921999-12-13 16:37:25 +000011361#endif
11362#ifdef _SC_XOPEN_REALTIME_THREADS
Victor Stinner8c62be82010-05-06 00:08:46 +000011363 {"SC_XOPEN_REALTIME_THREADS", _SC_XOPEN_REALTIME_THREADS},
Fred Drakec9680921999-12-13 16:37:25 +000011364#endif
11365#ifdef _SC_XOPEN_SHM
Victor Stinner8c62be82010-05-06 00:08:46 +000011366 {"SC_XOPEN_SHM", _SC_XOPEN_SHM},
Fred Drakec9680921999-12-13 16:37:25 +000011367#endif
11368#ifdef _SC_XOPEN_UNIX
Victor Stinner8c62be82010-05-06 00:08:46 +000011369 {"SC_XOPEN_UNIX", _SC_XOPEN_UNIX},
Fred Drakec9680921999-12-13 16:37:25 +000011370#endif
11371#ifdef _SC_XOPEN_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000011372 {"SC_XOPEN_VERSION", _SC_XOPEN_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000011373#endif
11374#ifdef _SC_XOPEN_XCU_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000011375 {"SC_XOPEN_XCU_VERSION", _SC_XOPEN_XCU_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000011376#endif
11377#ifdef _SC_XOPEN_XPG2
Victor Stinner8c62be82010-05-06 00:08:46 +000011378 {"SC_XOPEN_XPG2", _SC_XOPEN_XPG2},
Fred Drakec9680921999-12-13 16:37:25 +000011379#endif
11380#ifdef _SC_XOPEN_XPG3
Victor Stinner8c62be82010-05-06 00:08:46 +000011381 {"SC_XOPEN_XPG3", _SC_XOPEN_XPG3},
Fred Drakec9680921999-12-13 16:37:25 +000011382#endif
11383#ifdef _SC_XOPEN_XPG4
Victor Stinner8c62be82010-05-06 00:08:46 +000011384 {"SC_XOPEN_XPG4", _SC_XOPEN_XPG4},
Fred Drakec9680921999-12-13 16:37:25 +000011385#endif
11386};
11387
11388static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000011389conv_sysconf_confname(PyObject *arg, int *valuep)
Fred Drakec9680921999-12-13 16:37:25 +000011390{
11391 return conv_confname(arg, valuep, posix_constants_sysconf,
11392 sizeof(posix_constants_sysconf)
11393 / sizeof(struct constdef));
11394}
11395
Larry Hastings2f936352014-08-05 14:04:04 +100011396
11397/*[clinic input]
11398os.sysconf -> long
11399 name: sysconf_confname
11400 /
11401
11402Return an integer-valued system configuration variable.
11403[clinic start generated code]*/
11404
Larry Hastings2f936352014-08-05 14:04:04 +100011405static long
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011406os_sysconf_impl(PyObject *module, int name)
11407/*[clinic end generated code: output=3662f945fc0cc756 input=279e3430a33f29e4]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011408{
11409 long value;
11410
11411 errno = 0;
11412 value = sysconf(name);
11413 if (value == -1 && errno != 0)
11414 posix_error();
11415 return value;
11416}
11417#endif /* HAVE_SYSCONF */
Fred Drakec9680921999-12-13 16:37:25 +000011418
11419
Fred Drakebec628d1999-12-15 18:31:10 +000011420/* This code is used to ensure that the tables of configuration value names
Serhiy Storchaka56a6d852014-12-01 18:28:43 +020011421 * are in sorted order as required by conv_confname(), and also to build
Fred Drakebec628d1999-12-15 18:31:10 +000011422 * the exported dictionaries that are used to publish information about the
11423 * names available on the host platform.
11424 *
11425 * Sorting the table at runtime ensures that the table is properly ordered
11426 * when used, even for platforms we're not able to test on. It also makes
11427 * it easier to add additional entries to the tables.
Fred Draked86ed291999-12-15 15:34:33 +000011428 */
Fred Drakebec628d1999-12-15 18:31:10 +000011429
11430static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000011431cmp_constdefs(const void *v1, const void *v2)
Fred Drakebec628d1999-12-15 18:31:10 +000011432{
11433 const struct constdef *c1 =
Victor Stinner8c62be82010-05-06 00:08:46 +000011434 (const struct constdef *) v1;
Fred Drakebec628d1999-12-15 18:31:10 +000011435 const struct constdef *c2 =
Victor Stinner8c62be82010-05-06 00:08:46 +000011436 (const struct constdef *) v2;
Fred Drakebec628d1999-12-15 18:31:10 +000011437
11438 return strcmp(c1->name, c2->name);
11439}
11440
11441static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000011442setup_confname_table(struct constdef *table, size_t tablesize,
Serhiy Storchakadeab18d2016-05-07 16:45:18 +030011443 const char *tablename, PyObject *module)
Fred Draked86ed291999-12-15 15:34:33 +000011444{
Fred Drakebec628d1999-12-15 18:31:10 +000011445 PyObject *d = NULL;
Barry Warsaw3155db32000-04-13 15:20:40 +000011446 size_t i;
Fred Drakebec628d1999-12-15 18:31:10 +000011447
11448 qsort(table, tablesize, sizeof(struct constdef), cmp_constdefs);
11449 d = PyDict_New();
Barry Warsaw3155db32000-04-13 15:20:40 +000011450 if (d == NULL)
Victor Stinner8c62be82010-05-06 00:08:46 +000011451 return -1;
Fred Draked86ed291999-12-15 15:34:33 +000011452
Barry Warsaw3155db32000-04-13 15:20:40 +000011453 for (i=0; i < tablesize; ++i) {
Victor Stinner8c62be82010-05-06 00:08:46 +000011454 PyObject *o = PyLong_FromLong(table[i].value);
11455 if (o == NULL || PyDict_SetItemString(d, table[i].name, o) == -1) {
11456 Py_XDECREF(o);
11457 Py_DECREF(d);
11458 return -1;
11459 }
11460 Py_DECREF(o);
Fred Draked86ed291999-12-15 15:34:33 +000011461 }
Fred Drake4d1e64b2002-04-15 19:40:07 +000011462 return PyModule_AddObject(module, tablename, d);
Fred Draked86ed291999-12-15 15:34:33 +000011463}
11464
Fred Drakebec628d1999-12-15 18:31:10 +000011465/* Return -1 on failure, 0 on success. */
11466static int
Fred Drake4d1e64b2002-04-15 19:40:07 +000011467setup_confname_tables(PyObject *module)
Fred Draked86ed291999-12-15 15:34:33 +000011468{
11469#if defined(HAVE_FPATHCONF) || defined(HAVE_PATHCONF)
Fred Drakebec628d1999-12-15 18:31:10 +000011470 if (setup_confname_table(posix_constants_pathconf,
Fred Draked86ed291999-12-15 15:34:33 +000011471 sizeof(posix_constants_pathconf)
11472 / sizeof(struct constdef),
Fred Drake4d1e64b2002-04-15 19:40:07 +000011473 "pathconf_names", module))
Stefan Krah0e803b32010-11-26 16:16:47 +000011474 return -1;
Fred Draked86ed291999-12-15 15:34:33 +000011475#endif
11476#ifdef HAVE_CONFSTR
Fred Drakebec628d1999-12-15 18:31:10 +000011477 if (setup_confname_table(posix_constants_confstr,
Fred Draked86ed291999-12-15 15:34:33 +000011478 sizeof(posix_constants_confstr)
11479 / sizeof(struct constdef),
Fred Drake4d1e64b2002-04-15 19:40:07 +000011480 "confstr_names", module))
Stefan Krah0e803b32010-11-26 16:16:47 +000011481 return -1;
Fred Draked86ed291999-12-15 15:34:33 +000011482#endif
11483#ifdef HAVE_SYSCONF
Fred Drakebec628d1999-12-15 18:31:10 +000011484 if (setup_confname_table(posix_constants_sysconf,
Fred Draked86ed291999-12-15 15:34:33 +000011485 sizeof(posix_constants_sysconf)
11486 / sizeof(struct constdef),
Fred Drake4d1e64b2002-04-15 19:40:07 +000011487 "sysconf_names", module))
Stefan Krah0e803b32010-11-26 16:16:47 +000011488 return -1;
Fred Draked86ed291999-12-15 15:34:33 +000011489#endif
Fred Drakebec628d1999-12-15 18:31:10 +000011490 return 0;
Fred Draked86ed291999-12-15 15:34:33 +000011491}
Fred Draked86ed291999-12-15 15:34:33 +000011492
11493
Larry Hastings2f936352014-08-05 14:04:04 +100011494/*[clinic input]
11495os.abort
11496
11497Abort the interpreter immediately.
11498
11499This function 'dumps core' or otherwise fails in the hardest way possible
11500on the hosting operating system. This function never returns.
11501[clinic start generated code]*/
11502
Larry Hastings2f936352014-08-05 14:04:04 +100011503static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011504os_abort_impl(PyObject *module)
11505/*[clinic end generated code: output=dcf52586dad2467c input=cf2c7d98bc504047]*/
Fred Drake5ab8eaf1999-12-09 21:13:07 +000011506{
Fred Drake5ab8eaf1999-12-09 21:13:07 +000011507 abort();
11508 /*NOTREACHED*/
Victor Stinner9a2329f2016-12-05 17:56:36 +010011509#ifndef __clang__
11510 /* Issue #28152: abort() is declared with __attribute__((__noreturn__)).
11511 GCC emits a warning without "return NULL;" (compiler bug?), but Clang
11512 is smarter and emits a warning on the return. */
Fred Drake5ab8eaf1999-12-09 21:13:07 +000011513 Py_FatalError("abort() called from Python code didn't abort!");
11514 return NULL;
Victor Stinner9a2329f2016-12-05 17:56:36 +010011515#endif
Fred Drake5ab8eaf1999-12-09 21:13:07 +000011516}
Fred Drakebec628d1999-12-15 18:31:10 +000011517
Martin v. Löwis6238d2b2002-06-30 15:26:10 +000011518#ifdef MS_WINDOWS
Steve Dower7d0e0c92015-01-24 08:18:24 -080011519/* Grab ShellExecute dynamically from shell32 */
11520static int has_ShellExecute = -1;
Steve Dower7d0e0c92015-01-24 08:18:24 -080011521static HINSTANCE (CALLBACK *Py_ShellExecuteW)(HWND, LPCWSTR, LPCWSTR, LPCWSTR,
11522 LPCWSTR, INT);
11523static int
11524check_ShellExecute()
11525{
11526 HINSTANCE hShell32;
11527
11528 /* only recheck */
11529 if (-1 == has_ShellExecute) {
11530 Py_BEGIN_ALLOW_THREADS
Victor Stinnera9912152017-10-13 13:46:57 -070011531 /* Security note: this call is not vulnerable to "DLL hijacking".
11532 SHELL32 is part of "KnownDLLs" and so Windows always load
11533 the system SHELL32.DLL, even if there is another SHELL32.DLL
11534 in the DLL search path. */
Steve Dower7d0e0c92015-01-24 08:18:24 -080011535 hShell32 = LoadLibraryW(L"SHELL32");
Steve Dower7d0e0c92015-01-24 08:18:24 -080011536 if (hShell32) {
Steve Dower7d0e0c92015-01-24 08:18:24 -080011537 *(FARPROC*)&Py_ShellExecuteW = GetProcAddress(hShell32,
11538 "ShellExecuteW");
Steve Dowercc16be82016-09-08 10:35:16 -070011539 has_ShellExecute = Py_ShellExecuteW != NULL;
Steve Dower7d0e0c92015-01-24 08:18:24 -080011540 } else {
11541 has_ShellExecute = 0;
11542 }
Tony Roberts4860f012019-02-02 18:16:42 +010011543 Py_END_ALLOW_THREADS
Steve Dower7d0e0c92015-01-24 08:18:24 -080011544 }
11545 return has_ShellExecute;
11546}
11547
11548
Steve Dowercc16be82016-09-08 10:35:16 -070011549/*[clinic input]
11550os.startfile
11551 filepath: path_t
11552 operation: Py_UNICODE = NULL
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +000011553
Steve Dowercc16be82016-09-08 10:35:16 -070011554startfile(filepath [, operation])
11555
11556Start a file with its associated application.
11557
11558When "operation" is not specified or "open", this acts like
11559double-clicking the file in Explorer, or giving the file name as an
11560argument to the DOS "start" command: the file is opened with whatever
11561application (if any) its extension is associated.
11562When another "operation" is given, it specifies what should be done with
11563the file. A typical operation is "print".
11564
11565startfile returns as soon as the associated application is launched.
11566There is no option to wait for the application to close, and no way
11567to retrieve the application's exit status.
11568
11569The filepath is relative to the current directory. If you want to use
11570an absolute path, make sure the first character is not a slash ("/");
11571the underlying Win32 ShellExecute function doesn't work if it is.
11572[clinic start generated code]*/
11573
11574static PyObject *
Serhiy Storchakaafb3e712018-12-14 11:19:51 +020011575os_startfile_impl(PyObject *module, path_t *filepath,
11576 const Py_UNICODE *operation)
11577/*[clinic end generated code: output=66dc311c94d50797 input=63950bf2986380d0]*/
Steve Dowercc16be82016-09-08 10:35:16 -070011578{
11579 HINSTANCE rc;
Steve Dower7d0e0c92015-01-24 08:18:24 -080011580
11581 if(!check_ShellExecute()) {
11582 /* If the OS doesn't have ShellExecute, return a
11583 NotImplementedError. */
11584 return PyErr_Format(PyExc_NotImplementedError,
11585 "startfile not available on this platform");
11586 }
11587
Victor Stinner8c62be82010-05-06 00:08:46 +000011588 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -070011589 rc = Py_ShellExecuteW((HWND)0, operation, filepath->wide,
Steve Dower7d0e0c92015-01-24 08:18:24 -080011590 NULL, NULL, SW_SHOWNORMAL);
Victor Stinner8c62be82010-05-06 00:08:46 +000011591 Py_END_ALLOW_THREADS
11592
Victor Stinner8c62be82010-05-06 00:08:46 +000011593 if (rc <= (HINSTANCE)32) {
Steve Dowercc16be82016-09-08 10:35:16 -070011594 win32_error_object("startfile", filepath->object);
Victor Stinnereb5657a2011-09-30 01:44:27 +020011595 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +000011596 }
Steve Dowercc16be82016-09-08 10:35:16 -070011597 Py_RETURN_NONE;
Tim Petersf58a7aa2000-09-22 10:05:54 +000011598}
Larry Hastings2f936352014-08-05 14:04:04 +100011599#endif /* MS_WINDOWS */
11600
Fred Drake5ab8eaf1999-12-09 21:13:07 +000011601
Martin v. Löwis438b5342002-12-27 10:16:42 +000011602#ifdef HAVE_GETLOADAVG
Larry Hastings2f936352014-08-05 14:04:04 +100011603/*[clinic input]
11604os.getloadavg
11605
11606Return average recent system load information.
11607
11608Return the number of processes in the system run queue averaged over
11609the last 1, 5, and 15 minutes as a tuple of three floats.
11610Raises OSError if the load average was unobtainable.
11611[clinic start generated code]*/
11612
Larry Hastings2f936352014-08-05 14:04:04 +100011613static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011614os_getloadavg_impl(PyObject *module)
11615/*[clinic end generated code: output=9ad3a11bfb4f4bd2 input=3d6d826b76d8a34e]*/
Martin v. Löwis438b5342002-12-27 10:16:42 +000011616{
11617 double loadavg[3];
Martin v. Löwis438b5342002-12-27 10:16:42 +000011618 if (getloadavg(loadavg, 3)!=3) {
Stefan Krah0e803b32010-11-26 16:16:47 +000011619 PyErr_SetString(PyExc_OSError, "Load averages are unobtainable");
11620 return NULL;
Martin v. Löwis438b5342002-12-27 10:16:42 +000011621 } else
Stefan Krah0e803b32010-11-26 16:16:47 +000011622 return Py_BuildValue("ddd", loadavg[0], loadavg[1], loadavg[2]);
Martin v. Löwis438b5342002-12-27 10:16:42 +000011623}
Larry Hastings2f936352014-08-05 14:04:04 +100011624#endif /* HAVE_GETLOADAVG */
Martin v. Löwis438b5342002-12-27 10:16:42 +000011625
Larry Hastings2f936352014-08-05 14:04:04 +100011626
11627/*[clinic input]
11628os.device_encoding
11629 fd: int
11630
11631Return a string describing the encoding of a terminal's file descriptor.
11632
11633The file descriptor must be attached to a terminal.
11634If the device is not a terminal, return None.
11635[clinic start generated code]*/
11636
Larry Hastings2f936352014-08-05 14:04:04 +100011637static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011638os_device_encoding_impl(PyObject *module, int fd)
11639/*[clinic end generated code: output=e0d294bbab7e8c2b input=9e1d4a42b66df312]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011640{
Brett Cannonefb00c02012-02-29 18:31:31 -050011641 return _Py_device_encoding(fd);
Martin v. Löwisd1cd4d42007-08-11 14:02:14 +000011642}
11643
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011644
Larry Hastings2f936352014-08-05 14:04:04 +100011645#ifdef HAVE_SETRESUID
11646/*[clinic input]
11647os.setresuid
11648
11649 ruid: uid_t
11650 euid: uid_t
11651 suid: uid_t
11652 /
11653
11654Set the current process's real, effective, and saved user ids.
11655[clinic start generated code]*/
11656
Larry Hastings2f936352014-08-05 14:04:04 +100011657static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011658os_setresuid_impl(PyObject *module, uid_t ruid, uid_t euid, uid_t suid)
11659/*[clinic end generated code: output=834a641e15373e97 input=9e33cb79a82792f3]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011660{
Victor Stinner8c62be82010-05-06 00:08:46 +000011661 if (setresuid(ruid, euid, suid) < 0)
11662 return posix_error();
11663 Py_RETURN_NONE;
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011664}
Larry Hastings2f936352014-08-05 14:04:04 +100011665#endif /* HAVE_SETRESUID */
11666
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011667
11668#ifdef HAVE_SETRESGID
Larry Hastings2f936352014-08-05 14:04:04 +100011669/*[clinic input]
11670os.setresgid
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011671
Larry Hastings2f936352014-08-05 14:04:04 +100011672 rgid: gid_t
11673 egid: gid_t
11674 sgid: gid_t
11675 /
11676
11677Set the current process's real, effective, and saved group ids.
11678[clinic start generated code]*/
11679
Larry Hastings2f936352014-08-05 14:04:04 +100011680static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011681os_setresgid_impl(PyObject *module, gid_t rgid, gid_t egid, gid_t sgid)
11682/*[clinic end generated code: output=6aa402f3d2e514a9 input=33e9e0785ef426b1]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011683{
Victor Stinner8c62be82010-05-06 00:08:46 +000011684 if (setresgid(rgid, egid, sgid) < 0)
11685 return posix_error();
11686 Py_RETURN_NONE;
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011687}
Larry Hastings2f936352014-08-05 14:04:04 +100011688#endif /* HAVE_SETRESGID */
11689
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011690
11691#ifdef HAVE_GETRESUID
Larry Hastings2f936352014-08-05 14:04:04 +100011692/*[clinic input]
11693os.getresuid
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011694
Larry Hastings2f936352014-08-05 14:04:04 +100011695Return a tuple of the current process's real, effective, and saved user ids.
11696[clinic start generated code]*/
11697
Larry Hastings2f936352014-08-05 14:04:04 +100011698static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011699os_getresuid_impl(PyObject *module)
11700/*[clinic end generated code: output=8e0becff5dece5bf input=41ccfa8e1f6517ad]*/
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011701{
Victor Stinner8c62be82010-05-06 00:08:46 +000011702 uid_t ruid, euid, suid;
Victor Stinner8c62be82010-05-06 00:08:46 +000011703 if (getresuid(&ruid, &euid, &suid) < 0)
11704 return posix_error();
Serhiy Storchaka7cf55992013-02-10 21:56:49 +020011705 return Py_BuildValue("(NNN)", _PyLong_FromUid(ruid),
11706 _PyLong_FromUid(euid),
11707 _PyLong_FromUid(suid));
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011708}
Larry Hastings2f936352014-08-05 14:04:04 +100011709#endif /* HAVE_GETRESUID */
11710
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011711
11712#ifdef HAVE_GETRESGID
Larry Hastings2f936352014-08-05 14:04:04 +100011713/*[clinic input]
11714os.getresgid
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011715
Larry Hastings2f936352014-08-05 14:04:04 +100011716Return a tuple of the current process's real, effective, and saved group ids.
11717[clinic start generated code]*/
11718
Larry Hastings2f936352014-08-05 14:04:04 +100011719static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011720os_getresgid_impl(PyObject *module)
11721/*[clinic end generated code: output=2719c4bfcf27fb9f input=517e68db9ca32df6]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011722{
11723 gid_t rgid, egid, sgid;
Victor Stinner8c62be82010-05-06 00:08:46 +000011724 if (getresgid(&rgid, &egid, &sgid) < 0)
11725 return posix_error();
Serhiy Storchaka7cf55992013-02-10 21:56:49 +020011726 return Py_BuildValue("(NNN)", _PyLong_FromGid(rgid),
11727 _PyLong_FromGid(egid),
11728 _PyLong_FromGid(sgid));
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011729}
Larry Hastings2f936352014-08-05 14:04:04 +100011730#endif /* HAVE_GETRESGID */
11731
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011732
Benjamin Peterson9428d532011-09-14 11:45:52 -040011733#ifdef USE_XATTRS
Larry Hastings2f936352014-08-05 14:04:04 +100011734/*[clinic input]
11735os.getxattr
Benjamin Peterson799bd802011-08-31 22:15:17 -040011736
Larry Hastings2f936352014-08-05 14:04:04 +100011737 path: path_t(allow_fd=True)
11738 attribute: path_t
11739 *
11740 follow_symlinks: bool = True
11741
11742Return the value of extended attribute attribute on path.
11743
BNMetricsb9427072018-11-02 15:20:19 +000011744path may be either a string, a path-like object, or an open file descriptor.
Larry Hastings2f936352014-08-05 14:04:04 +100011745If follow_symlinks is False, and the last element of the path is a symbolic
11746 link, getxattr will examine the symbolic link itself instead of the file
11747 the link points to.
11748
11749[clinic start generated code]*/
11750
Larry Hastings2f936352014-08-05 14:04:04 +100011751static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011752os_getxattr_impl(PyObject *module, path_t *path, path_t *attribute,
Larry Hastings89964c42015-04-14 18:07:59 -040011753 int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +000011754/*[clinic end generated code: output=5f2f44200a43cff2 input=025789491708f7eb]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011755{
11756 Py_ssize_t i;
11757 PyObject *buffer = NULL;
11758
11759 if (fd_and_follow_symlinks_invalid("getxattr", path->fd, follow_symlinks))
11760 return NULL;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011761
Larry Hastings9cf065c2012-06-22 16:30:09 -070011762 for (i = 0; ; i++) {
11763 void *ptr;
11764 ssize_t result;
Serhiy Storchaka2d06e842015-12-25 19:53:18 +020011765 static const Py_ssize_t buffer_sizes[] = {128, XATTR_SIZE_MAX, 0};
Larry Hastings9cf065c2012-06-22 16:30:09 -070011766 Py_ssize_t buffer_size = buffer_sizes[i];
11767 if (!buffer_size) {
Larry Hastings2f936352014-08-05 14:04:04 +100011768 path_error(path);
11769 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070011770 }
11771 buffer = PyBytes_FromStringAndSize(NULL, buffer_size);
11772 if (!buffer)
Larry Hastings2f936352014-08-05 14:04:04 +100011773 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070011774 ptr = PyBytes_AS_STRING(buffer);
Benjamin Peterson799bd802011-08-31 22:15:17 -040011775
Larry Hastings9cf065c2012-06-22 16:30:09 -070011776 Py_BEGIN_ALLOW_THREADS;
Larry Hastings2f936352014-08-05 14:04:04 +100011777 if (path->fd >= 0)
11778 result = fgetxattr(path->fd, attribute->narrow, ptr, buffer_size);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011779 else if (follow_symlinks)
Larry Hastings2f936352014-08-05 14:04:04 +100011780 result = getxattr(path->narrow, attribute->narrow, ptr, buffer_size);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011781 else
Larry Hastings2f936352014-08-05 14:04:04 +100011782 result = lgetxattr(path->narrow, attribute->narrow, ptr, buffer_size);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011783 Py_END_ALLOW_THREADS;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011784
Larry Hastings9cf065c2012-06-22 16:30:09 -070011785 if (result < 0) {
11786 Py_DECREF(buffer);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011787 if (errno == ERANGE)
11788 continue;
Larry Hastings2f936352014-08-05 14:04:04 +100011789 path_error(path);
11790 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070011791 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040011792
Larry Hastings9cf065c2012-06-22 16:30:09 -070011793 if (result != buffer_size) {
11794 /* Can only shrink. */
11795 _PyBytes_Resize(&buffer, result);
11796 }
11797 break;
11798 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040011799
Larry Hastings9cf065c2012-06-22 16:30:09 -070011800 return buffer;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011801}
11802
Larry Hastings2f936352014-08-05 14:04:04 +100011803
11804/*[clinic input]
11805os.setxattr
11806
11807 path: path_t(allow_fd=True)
11808 attribute: path_t
11809 value: Py_buffer
11810 flags: int = 0
11811 *
11812 follow_symlinks: bool = True
11813
11814Set extended attribute attribute on path to value.
11815
BNMetricsb9427072018-11-02 15:20:19 +000011816path may be either a string, a path-like object, or an open file descriptor.
Larry Hastings2f936352014-08-05 14:04:04 +100011817If follow_symlinks is False, and the last element of the path is a symbolic
11818 link, setxattr will modify the symbolic link itself instead of the file
11819 the link points to.
11820
11821[clinic start generated code]*/
11822
Benjamin Peterson799bd802011-08-31 22:15:17 -040011823static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011824os_setxattr_impl(PyObject *module, path_t *path, path_t *attribute,
Larry Hastings89964c42015-04-14 18:07:59 -040011825 Py_buffer *value, int flags, int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +000011826/*[clinic end generated code: output=98b83f63fdde26bb input=c17c0103009042f0]*/
Benjamin Peterson799bd802011-08-31 22:15:17 -040011827{
Larry Hastings2f936352014-08-05 14:04:04 +100011828 ssize_t result;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011829
Larry Hastings2f936352014-08-05 14:04:04 +100011830 if (fd_and_follow_symlinks_invalid("setxattr", path->fd, follow_symlinks))
Benjamin Peterson799bd802011-08-31 22:15:17 -040011831 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070011832
Benjamin Peterson799bd802011-08-31 22:15:17 -040011833 Py_BEGIN_ALLOW_THREADS;
Larry Hastings2f936352014-08-05 14:04:04 +100011834 if (path->fd > -1)
11835 result = fsetxattr(path->fd, attribute->narrow,
11836 value->buf, value->len, flags);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011837 else if (follow_symlinks)
Larry Hastings2f936352014-08-05 14:04:04 +100011838 result = setxattr(path->narrow, attribute->narrow,
11839 value->buf, value->len, flags);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011840 else
Larry Hastings2f936352014-08-05 14:04:04 +100011841 result = lsetxattr(path->narrow, attribute->narrow,
11842 value->buf, value->len, flags);
Benjamin Peterson799bd802011-08-31 22:15:17 -040011843 Py_END_ALLOW_THREADS;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011844
Larry Hastings9cf065c2012-06-22 16:30:09 -070011845 if (result) {
Larry Hastings2f936352014-08-05 14:04:04 +100011846 path_error(path);
11847 return NULL;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011848 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040011849
Larry Hastings2f936352014-08-05 14:04:04 +100011850 Py_RETURN_NONE;
11851}
11852
11853
11854/*[clinic input]
11855os.removexattr
11856
11857 path: path_t(allow_fd=True)
11858 attribute: path_t
11859 *
11860 follow_symlinks: bool = True
11861
11862Remove extended attribute attribute on path.
11863
BNMetricsb9427072018-11-02 15:20:19 +000011864path may be either a string, a path-like object, or an open file descriptor.
Larry Hastings2f936352014-08-05 14:04:04 +100011865If follow_symlinks is False, and the last element of the path is a symbolic
11866 link, removexattr will modify the symbolic link itself instead of the file
11867 the link points to.
11868
11869[clinic start generated code]*/
11870
Larry Hastings2f936352014-08-05 14:04:04 +100011871static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011872os_removexattr_impl(PyObject *module, path_t *path, path_t *attribute,
Larry Hastings89964c42015-04-14 18:07:59 -040011873 int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +000011874/*[clinic end generated code: output=521a51817980cda6 input=3d9a7d36fe2f7c4e]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011875{
11876 ssize_t result;
11877
11878 if (fd_and_follow_symlinks_invalid("removexattr", path->fd, follow_symlinks))
11879 return NULL;
11880
11881 Py_BEGIN_ALLOW_THREADS;
11882 if (path->fd > -1)
11883 result = fremovexattr(path->fd, attribute->narrow);
11884 else if (follow_symlinks)
11885 result = removexattr(path->narrow, attribute->narrow);
11886 else
11887 result = lremovexattr(path->narrow, attribute->narrow);
11888 Py_END_ALLOW_THREADS;
11889
11890 if (result) {
11891 return path_error(path);
11892 }
11893
11894 Py_RETURN_NONE;
11895}
11896
11897
11898/*[clinic input]
11899os.listxattr
11900
11901 path: path_t(allow_fd=True, nullable=True) = None
11902 *
11903 follow_symlinks: bool = True
11904
11905Return a list of extended attributes on path.
11906
BNMetricsb9427072018-11-02 15:20:19 +000011907path may be either None, a string, a path-like object, or an open file descriptor.
Larry Hastings2f936352014-08-05 14:04:04 +100011908if path is None, listxattr will examine the current directory.
11909If follow_symlinks is False, and the last element of the path is a symbolic
11910 link, listxattr will examine the symbolic link itself instead of the file
11911 the link points to.
11912[clinic start generated code]*/
11913
Larry Hastings2f936352014-08-05 14:04:04 +100011914static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011915os_listxattr_impl(PyObject *module, path_t *path, int follow_symlinks)
BNMetricsb9427072018-11-02 15:20:19 +000011916/*[clinic end generated code: output=bebdb4e2ad0ce435 input=9826edf9fdb90869]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011917{
Larry Hastings9cf065c2012-06-22 16:30:09 -070011918 Py_ssize_t i;
11919 PyObject *result = NULL;
Larry Hastings2f936352014-08-05 14:04:04 +100011920 const char *name;
Larry Hastings9cf065c2012-06-22 16:30:09 -070011921 char *buffer = NULL;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011922
Larry Hastings2f936352014-08-05 14:04:04 +100011923 if (fd_and_follow_symlinks_invalid("listxattr", path->fd, follow_symlinks))
Larry Hastings9cf065c2012-06-22 16:30:09 -070011924 goto exit;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011925
Larry Hastings2f936352014-08-05 14:04:04 +100011926 name = path->narrow ? path->narrow : ".";
11927
Larry Hastings9cf065c2012-06-22 16:30:09 -070011928 for (i = 0; ; i++) {
Serhiy Storchakadeab18d2016-05-07 16:45:18 +030011929 const char *start, *trace, *end;
Larry Hastings9cf065c2012-06-22 16:30:09 -070011930 ssize_t length;
Serhiy Storchaka2d06e842015-12-25 19:53:18 +020011931 static const Py_ssize_t buffer_sizes[] = { 256, XATTR_LIST_MAX, 0 };
Larry Hastings9cf065c2012-06-22 16:30:09 -070011932 Py_ssize_t buffer_size = buffer_sizes[i];
11933 if (!buffer_size) {
Christian Heimes3b9493b2012-09-23 16:11:15 +020011934 /* ERANGE */
Larry Hastings2f936352014-08-05 14:04:04 +100011935 path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011936 break;
11937 }
11938 buffer = PyMem_MALLOC(buffer_size);
11939 if (!buffer) {
11940 PyErr_NoMemory();
11941 break;
11942 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040011943
Larry Hastings9cf065c2012-06-22 16:30:09 -070011944 Py_BEGIN_ALLOW_THREADS;
Larry Hastings2f936352014-08-05 14:04:04 +100011945 if (path->fd > -1)
11946 length = flistxattr(path->fd, buffer, buffer_size);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011947 else if (follow_symlinks)
11948 length = listxattr(name, buffer, buffer_size);
11949 else
11950 length = llistxattr(name, buffer, buffer_size);
11951 Py_END_ALLOW_THREADS;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011952
Larry Hastings9cf065c2012-06-22 16:30:09 -070011953 if (length < 0) {
Antoine Pitrou7f987392013-05-13 19:46:29 +020011954 if (errno == ERANGE) {
11955 PyMem_FREE(buffer);
Benjamin Petersondedac522013-05-13 19:55:40 -050011956 buffer = NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070011957 continue;
Antoine Pitrou7f987392013-05-13 19:46:29 +020011958 }
Larry Hastings2f936352014-08-05 14:04:04 +100011959 path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011960 break;
11961 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040011962
Larry Hastings9cf065c2012-06-22 16:30:09 -070011963 result = PyList_New(0);
11964 if (!result) {
11965 goto exit;
11966 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040011967
Larry Hastings9cf065c2012-06-22 16:30:09 -070011968 end = buffer + length;
11969 for (trace = start = buffer; trace != end; trace++) {
11970 if (!*trace) {
11971 int error;
11972 PyObject *attribute = PyUnicode_DecodeFSDefaultAndSize(start,
11973 trace - start);
11974 if (!attribute) {
11975 Py_DECREF(result);
11976 result = NULL;
11977 goto exit;
11978 }
11979 error = PyList_Append(result, attribute);
11980 Py_DECREF(attribute);
11981 if (error) {
11982 Py_DECREF(result);
11983 result = NULL;
11984 goto exit;
11985 }
11986 start = trace + 1;
11987 }
11988 }
11989 break;
11990 }
11991exit:
Larry Hastings9cf065c2012-06-22 16:30:09 -070011992 if (buffer)
11993 PyMem_FREE(buffer);
11994 return result;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011995}
Benjamin Peterson9428d532011-09-14 11:45:52 -040011996#endif /* USE_XATTRS */
Benjamin Peterson799bd802011-08-31 22:15:17 -040011997
Antoine Pitroubcf2b592012-02-08 23:28:36 +010011998
Larry Hastings2f936352014-08-05 14:04:04 +100011999/*[clinic input]
12000os.urandom
12001
12002 size: Py_ssize_t
12003 /
12004
12005Return a bytes object containing random bytes suitable for cryptographic use.
12006[clinic start generated code]*/
12007
Larry Hastings2f936352014-08-05 14:04:04 +100012008static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012009os_urandom_impl(PyObject *module, Py_ssize_t size)
12010/*[clinic end generated code: output=42c5cca9d18068e9 input=4067cdb1b6776c29]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012011{
12012 PyObject *bytes;
12013 int result;
12014
Georg Brandl2fb477c2012-02-21 00:33:36 +010012015 if (size < 0)
12016 return PyErr_Format(PyExc_ValueError,
12017 "negative argument not allowed");
Larry Hastings2f936352014-08-05 14:04:04 +100012018 bytes = PyBytes_FromStringAndSize(NULL, size);
12019 if (bytes == NULL)
Georg Brandl2fb477c2012-02-21 00:33:36 +010012020 return NULL;
12021
Victor Stinnere66987e2016-09-06 16:33:52 -070012022 result = _PyOS_URandom(PyBytes_AS_STRING(bytes), PyBytes_GET_SIZE(bytes));
Larry Hastings2f936352014-08-05 14:04:04 +100012023 if (result == -1) {
12024 Py_DECREF(bytes);
Georg Brandl2fb477c2012-02-21 00:33:36 +010012025 return NULL;
12026 }
Larry Hastings2f936352014-08-05 14:04:04 +100012027 return bytes;
Georg Brandl2fb477c2012-02-21 00:33:36 +010012028}
12029
Zackery Spytz43fdbd22019-05-29 13:57:07 -060012030#ifdef HAVE_MEMFD_CREATE
12031/*[clinic input]
12032os.memfd_create
12033
12034 name: FSConverter
12035 flags: unsigned_int(bitwise=True, c_default="MFD_CLOEXEC") = MFD_CLOEXEC
12036
12037[clinic start generated code]*/
12038
12039static PyObject *
12040os_memfd_create_impl(PyObject *module, PyObject *name, unsigned int flags)
12041/*[clinic end generated code: output=6681ede983bdb9a6 input=a42cfc199bcd56e9]*/
12042{
12043 int fd;
12044 const char *bytes = PyBytes_AS_STRING(name);
12045 Py_BEGIN_ALLOW_THREADS
12046 fd = memfd_create(bytes, flags);
12047 Py_END_ALLOW_THREADS
12048 if (fd == -1) {
12049 return PyErr_SetFromErrno(PyExc_OSError);
12050 }
12051 return PyLong_FromLong(fd);
12052}
12053#endif
12054
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012055/* Terminal size querying */
12056
Eddie Elizondo474eedf2018-11-13 04:09:31 -080012057static PyTypeObject* TerminalSizeType;
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012058
12059PyDoc_STRVAR(TerminalSize_docstring,
12060 "A tuple of (columns, lines) for holding terminal window size");
12061
12062static PyStructSequence_Field TerminalSize_fields[] = {
12063 {"columns", "width of the terminal window in characters"},
12064 {"lines", "height of the terminal window in characters"},
12065 {NULL, NULL}
12066};
12067
12068static PyStructSequence_Desc TerminalSize_desc = {
12069 "os.terminal_size",
12070 TerminalSize_docstring,
12071 TerminalSize_fields,
12072 2,
12073};
12074
12075#if defined(TERMSIZE_USE_CONIO) || defined(TERMSIZE_USE_IOCTL)
Larry Hastings2f936352014-08-05 14:04:04 +100012076/* AC 3.5: fd should accept None */
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012077PyDoc_STRVAR(termsize__doc__,
12078 "Return the size of the terminal window as (columns, lines).\n" \
12079 "\n" \
12080 "The optional argument fd (default standard output) specifies\n" \
12081 "which file descriptor should be queried.\n" \
12082 "\n" \
12083 "If the file descriptor is not connected to a terminal, an OSError\n" \
12084 "is thrown.\n" \
12085 "\n" \
12086 "This function will only be defined if an implementation is\n" \
12087 "available for this system.\n" \
12088 "\n" \
oldkaa0735f2018-02-02 16:52:55 +080012089 "shutil.get_terminal_size is the high-level function which should\n" \
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012090 "normally be used, os.get_terminal_size is the low-level implementation.");
12091
12092static PyObject*
12093get_terminal_size(PyObject *self, PyObject *args)
12094{
12095 int columns, lines;
12096 PyObject *termsize;
12097
12098 int fd = fileno(stdout);
12099 /* Under some conditions stdout may not be connected and
12100 * fileno(stdout) may point to an invalid file descriptor. For example
12101 * GUI apps don't have valid standard streams by default.
12102 *
12103 * If this happens, and the optional fd argument is not present,
12104 * the ioctl below will fail returning EBADF. This is what we want.
12105 */
12106
12107 if (!PyArg_ParseTuple(args, "|i", &fd))
12108 return NULL;
12109
12110#ifdef TERMSIZE_USE_IOCTL
12111 {
12112 struct winsize w;
12113 if (ioctl(fd, TIOCGWINSZ, &w))
12114 return PyErr_SetFromErrno(PyExc_OSError);
12115 columns = w.ws_col;
12116 lines = w.ws_row;
12117 }
12118#endif /* TERMSIZE_USE_IOCTL */
12119
12120#ifdef TERMSIZE_USE_CONIO
12121 {
12122 DWORD nhandle;
12123 HANDLE handle;
12124 CONSOLE_SCREEN_BUFFER_INFO csbi;
12125 switch (fd) {
12126 case 0: nhandle = STD_INPUT_HANDLE;
12127 break;
12128 case 1: nhandle = STD_OUTPUT_HANDLE;
12129 break;
12130 case 2: nhandle = STD_ERROR_HANDLE;
12131 break;
12132 default:
12133 return PyErr_Format(PyExc_ValueError, "bad file descriptor");
12134 }
12135 handle = GetStdHandle(nhandle);
12136 if (handle == NULL)
12137 return PyErr_Format(PyExc_OSError, "handle cannot be retrieved");
12138 if (handle == INVALID_HANDLE_VALUE)
12139 return PyErr_SetFromWindowsErr(0);
12140
12141 if (!GetConsoleScreenBufferInfo(handle, &csbi))
12142 return PyErr_SetFromWindowsErr(0);
12143
12144 columns = csbi.srWindow.Right - csbi.srWindow.Left + 1;
12145 lines = csbi.srWindow.Bottom - csbi.srWindow.Top + 1;
12146 }
12147#endif /* TERMSIZE_USE_CONIO */
12148
Eddie Elizondo474eedf2018-11-13 04:09:31 -080012149 termsize = PyStructSequence_New(TerminalSizeType);
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012150 if (termsize == NULL)
12151 return NULL;
12152 PyStructSequence_SET_ITEM(termsize, 0, PyLong_FromLong(columns));
12153 PyStructSequence_SET_ITEM(termsize, 1, PyLong_FromLong(lines));
12154 if (PyErr_Occurred()) {
12155 Py_DECREF(termsize);
12156 return NULL;
12157 }
12158 return termsize;
12159}
12160#endif /* defined(TERMSIZE_USE_CONIO) || defined(TERMSIZE_USE_IOCTL) */
12161
Larry Hastings2f936352014-08-05 14:04:04 +100012162
12163/*[clinic input]
12164os.cpu_count
12165
Charles-François Natali80d62e62015-08-13 20:37:08 +010012166Return the number of CPUs in the system; return None if indeterminable.
12167
12168This number is not equivalent to the number of CPUs the current process can
12169use. The number of usable CPUs can be obtained with
12170``len(os.sched_getaffinity(0))``
Larry Hastings2f936352014-08-05 14:04:04 +100012171[clinic start generated code]*/
12172
Larry Hastings2f936352014-08-05 14:04:04 +100012173static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012174os_cpu_count_impl(PyObject *module)
Serhiy Storchaka2954f832016-07-07 18:20:03 +030012175/*[clinic end generated code: output=5fc29463c3936a9c input=e7c8f4ba6dbbadd3]*/
Charles-Francois Natali44feda32013-05-20 14:40:46 +020012176{
Charles-Francois Natalid59087d2013-05-20 17:31:06 +020012177 int ncpu = 0;
Charles-Francois Natali44feda32013-05-20 14:40:46 +020012178#ifdef MS_WINDOWS
Christopher Wilcoxc67bae02017-08-30 05:01:08 -040012179 /* Vista is supported and the GetMaximumProcessorCount API is Win7+
12180 Need to fallback to Vista behavior if this call isn't present */
12181 HINSTANCE hKernel32;
Christopher Wilcoxc67bae02017-08-30 05:01:08 -040012182 static DWORD(CALLBACK *_GetMaximumProcessorCount)(WORD) = NULL;
Tony Roberts4860f012019-02-02 18:16:42 +010012183 Py_BEGIN_ALLOW_THREADS
12184 hKernel32 = GetModuleHandleW(L"KERNEL32");
Christopher Wilcoxc67bae02017-08-30 05:01:08 -040012185 *(FARPROC*)&_GetMaximumProcessorCount = GetProcAddress(hKernel32,
12186 "GetMaximumProcessorCount");
Tony Roberts4860f012019-02-02 18:16:42 +010012187 Py_END_ALLOW_THREADS
Christopher Wilcoxc67bae02017-08-30 05:01:08 -040012188 if (_GetMaximumProcessorCount != NULL) {
12189 ncpu = _GetMaximumProcessorCount(ALL_PROCESSOR_GROUPS);
12190 }
12191 else {
12192 SYSTEM_INFO sysinfo;
12193 GetSystemInfo(&sysinfo);
12194 ncpu = sysinfo.dwNumberOfProcessors;
12195 }
Charles-Francois Natali44feda32013-05-20 14:40:46 +020012196#elif defined(__hpux)
12197 ncpu = mpctl(MPC_GETNUMSPUS, NULL, NULL);
12198#elif defined(HAVE_SYSCONF) && defined(_SC_NPROCESSORS_ONLN)
12199 ncpu = sysconf(_SC_NPROCESSORS_ONLN);
Charles-Francois Natali44feda32013-05-20 14:40:46 +020012200#elif defined(__DragonFly__) || \
12201 defined(__OpenBSD__) || \
12202 defined(__FreeBSD__) || \
Charles-Francois Natalid59087d2013-05-20 17:31:06 +020012203 defined(__NetBSD__) || \
12204 defined(__APPLE__)
Charles-Francois Natali7c4f8da2013-05-20 17:40:32 +020012205 int mib[2];
12206 size_t len = sizeof(ncpu);
12207 mib[0] = CTL_HW;
12208 mib[1] = HW_NCPU;
12209 if (sysctl(mib, 2, &ncpu, &len, NULL, 0) != 0)
12210 ncpu = 0;
Charles-Francois Natali44feda32013-05-20 14:40:46 +020012211#endif
12212 if (ncpu >= 1)
12213 return PyLong_FromLong(ncpu);
12214 else
12215 Py_RETURN_NONE;
12216}
12217
Victor Stinnerdaf45552013-08-28 00:53:59 +020012218
Larry Hastings2f936352014-08-05 14:04:04 +100012219/*[clinic input]
12220os.get_inheritable -> bool
12221
12222 fd: int
12223 /
12224
12225Get the close-on-exe flag of the specified file descriptor.
12226[clinic start generated code]*/
12227
Larry Hastings2f936352014-08-05 14:04:04 +100012228static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012229os_get_inheritable_impl(PyObject *module, int fd)
12230/*[clinic end generated code: output=0445e20e149aa5b8 input=89ac008dc9ab6b95]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012231{
Steve Dower8fc89802015-04-12 00:26:27 -040012232 int return_value;
Steve Dower8fc89802015-04-12 00:26:27 -040012233 _Py_BEGIN_SUPPRESS_IPH
12234 return_value = _Py_get_inheritable(fd);
12235 _Py_END_SUPPRESS_IPH
12236 return return_value;
Larry Hastings2f936352014-08-05 14:04:04 +100012237}
12238
12239
12240/*[clinic input]
12241os.set_inheritable
12242 fd: int
12243 inheritable: int
12244 /
12245
12246Set the inheritable flag of the specified file descriptor.
12247[clinic start generated code]*/
12248
Larry Hastings2f936352014-08-05 14:04:04 +100012249static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030012250os_set_inheritable_impl(PyObject *module, int fd, int inheritable)
12251/*[clinic end generated code: output=f1b1918a2f3c38c2 input=9ceaead87a1e2402]*/
Victor Stinnerdaf45552013-08-28 00:53:59 +020012252{
Steve Dower8fc89802015-04-12 00:26:27 -040012253 int result;
Victor Stinnerdaf45552013-08-28 00:53:59 +020012254
Steve Dower8fc89802015-04-12 00:26:27 -040012255 _Py_BEGIN_SUPPRESS_IPH
12256 result = _Py_set_inheritable(fd, inheritable, NULL);
12257 _Py_END_SUPPRESS_IPH
12258 if (result < 0)
Victor Stinnerdaf45552013-08-28 00:53:59 +020012259 return NULL;
12260 Py_RETURN_NONE;
12261}
12262
12263
12264#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +100012265/*[clinic input]
12266os.get_handle_inheritable -> bool
Benjamin Petersonca470632016-09-06 13:47:26 -070012267 handle: intptr_t
Larry Hastings2f936352014-08-05 14:04:04 +100012268 /
Victor Stinnerdaf45552013-08-28 00:53:59 +020012269
Larry Hastings2f936352014-08-05 14:04:04 +100012270Get the close-on-exe flag of the specified file descriptor.
12271[clinic start generated code]*/
12272
Larry Hastings2f936352014-08-05 14:04:04 +100012273static int
Benjamin Petersonca470632016-09-06 13:47:26 -070012274os_get_handle_inheritable_impl(PyObject *module, intptr_t handle)
Victor Stinner581139c2016-09-06 15:54:20 -070012275/*[clinic end generated code: output=36be5afca6ea84d8 input=cfe99f9c05c70ad1]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012276{
12277 DWORD flags;
Victor Stinnerdaf45552013-08-28 00:53:59 +020012278
12279 if (!GetHandleInformation((HANDLE)handle, &flags)) {
12280 PyErr_SetFromWindowsErr(0);
Larry Hastings2f936352014-08-05 14:04:04 +100012281 return -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +020012282 }
12283
Larry Hastings2f936352014-08-05 14:04:04 +100012284 return flags & HANDLE_FLAG_INHERIT;
Victor Stinnerdaf45552013-08-28 00:53:59 +020012285}
12286
Victor Stinnerdaf45552013-08-28 00:53:59 +020012287
Larry Hastings2f936352014-08-05 14:04:04 +100012288/*[clinic input]
12289os.set_handle_inheritable
Benjamin Petersonca470632016-09-06 13:47:26 -070012290 handle: intptr_t
Larry Hastings2f936352014-08-05 14:04:04 +100012291 inheritable: bool
12292 /
12293
12294Set the inheritable flag of the specified handle.
12295[clinic start generated code]*/
12296
Larry Hastings2f936352014-08-05 14:04:04 +100012297static PyObject *
Benjamin Petersonca470632016-09-06 13:47:26 -070012298os_set_handle_inheritable_impl(PyObject *module, intptr_t handle,
Larry Hastings89964c42015-04-14 18:07:59 -040012299 int inheritable)
Victor Stinner581139c2016-09-06 15:54:20 -070012300/*[clinic end generated code: output=021d74fe6c96baa3 input=7a7641390d8364fc]*/
Larry Hastings2f936352014-08-05 14:04:04 +100012301{
12302 DWORD flags = inheritable ? HANDLE_FLAG_INHERIT : 0;
Victor Stinnerdaf45552013-08-28 00:53:59 +020012303 if (!SetHandleInformation((HANDLE)handle, HANDLE_FLAG_INHERIT, flags)) {
12304 PyErr_SetFromWindowsErr(0);
12305 return NULL;
12306 }
12307 Py_RETURN_NONE;
12308}
Larry Hastings2f936352014-08-05 14:04:04 +100012309#endif /* MS_WINDOWS */
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012310
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012311#ifndef MS_WINDOWS
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030012312/*[clinic input]
12313os.get_blocking -> bool
12314 fd: int
12315 /
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012316
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030012317Get the blocking mode of the file descriptor.
12318
12319Return False if the O_NONBLOCK flag is set, True if the flag is cleared.
12320[clinic start generated code]*/
12321
12322static int
12323os_get_blocking_impl(PyObject *module, int fd)
12324/*[clinic end generated code: output=336a12ad76a61482 input=f4afb59d51560179]*/
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012325{
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012326 int blocking;
12327
Steve Dower8fc89802015-04-12 00:26:27 -040012328 _Py_BEGIN_SUPPRESS_IPH
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012329 blocking = _Py_get_blocking(fd);
Steve Dower8fc89802015-04-12 00:26:27 -040012330 _Py_END_SUPPRESS_IPH
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030012331 return blocking;
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012332}
12333
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030012334/*[clinic input]
12335os.set_blocking
12336 fd: int
12337 blocking: bool(accept={int})
12338 /
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012339
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030012340Set the blocking mode of the specified file descriptor.
12341
12342Set the O_NONBLOCK flag if blocking is False,
12343clear the O_NONBLOCK flag otherwise.
12344[clinic start generated code]*/
12345
12346static PyObject *
12347os_set_blocking_impl(PyObject *module, int fd, int blocking)
12348/*[clinic end generated code: output=384eb43aa0762a9d input=bf5c8efdc5860ff3]*/
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012349{
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030012350 int result;
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012351
Steve Dower8fc89802015-04-12 00:26:27 -040012352 _Py_BEGIN_SUPPRESS_IPH
12353 result = _Py_set_blocking(fd, blocking);
12354 _Py_END_SUPPRESS_IPH
12355 if (result < 0)
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012356 return NULL;
12357 Py_RETURN_NONE;
12358}
12359#endif /* !MS_WINDOWS */
12360
12361
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012362/*[clinic input]
12363class os.DirEntry "DirEntry *" "&DirEntryType"
12364[clinic start generated code]*/
12365/*[clinic end generated code: output=da39a3ee5e6b4b0d input=3138f09f7c683f1d]*/
Victor Stinner6036e442015-03-08 01:58:04 +010012366
12367typedef struct {
12368 PyObject_HEAD
12369 PyObject *name;
12370 PyObject *path;
12371 PyObject *stat;
12372 PyObject *lstat;
12373#ifdef MS_WINDOWS
12374 struct _Py_stat_struct win32_lstat;
Victor Stinner0f6d7332017-03-09 17:34:28 +010012375 uint64_t win32_file_index;
Victor Stinner6036e442015-03-08 01:58:04 +010012376 int got_file_index;
12377#else /* POSIX */
Victor Stinner35a97c02015-03-08 02:59:09 +010012378#ifdef HAVE_DIRENT_D_TYPE
Victor Stinner6036e442015-03-08 01:58:04 +010012379 unsigned char d_type;
Victor Stinner35a97c02015-03-08 02:59:09 +010012380#endif
Victor Stinner6036e442015-03-08 01:58:04 +010012381 ino_t d_ino;
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012382 int dir_fd;
Victor Stinner6036e442015-03-08 01:58:04 +010012383#endif
12384} DirEntry;
12385
12386static void
12387DirEntry_dealloc(DirEntry *entry)
12388{
12389 Py_XDECREF(entry->name);
12390 Py_XDECREF(entry->path);
12391 Py_XDECREF(entry->stat);
12392 Py_XDECREF(entry->lstat);
12393 Py_TYPE(entry)->tp_free((PyObject *)entry);
12394}
12395
12396/* Forward reference */
12397static int
12398DirEntry_test_mode(DirEntry *self, int follow_symlinks, unsigned short mode_bits);
12399
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012400/*[clinic input]
12401os.DirEntry.is_symlink -> bool
12402
12403Return True if the entry is a symbolic link; cached per entry.
12404[clinic start generated code]*/
12405
Victor Stinner6036e442015-03-08 01:58:04 +010012406static int
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012407os_DirEntry_is_symlink_impl(DirEntry *self)
12408/*[clinic end generated code: output=42244667d7bcfc25 input=1605a1b4b96976c3]*/
Victor Stinner6036e442015-03-08 01:58:04 +010012409{
12410#ifdef MS_WINDOWS
12411 return (self->win32_lstat.st_mode & S_IFMT) == S_IFLNK;
Victor Stinner35a97c02015-03-08 02:59:09 +010012412#elif defined(HAVE_DIRENT_D_TYPE)
12413 /* POSIX */
Victor Stinner6036e442015-03-08 01:58:04 +010012414 if (self->d_type != DT_UNKNOWN)
12415 return self->d_type == DT_LNK;
12416 else
12417 return DirEntry_test_mode(self, 0, S_IFLNK);
Victor Stinner35a97c02015-03-08 02:59:09 +010012418#else
12419 /* POSIX without d_type */
12420 return DirEntry_test_mode(self, 0, S_IFLNK);
Victor Stinner6036e442015-03-08 01:58:04 +010012421#endif
12422}
12423
12424static PyObject *
Victor Stinner6036e442015-03-08 01:58:04 +010012425DirEntry_fetch_stat(DirEntry *self, int follow_symlinks)
12426{
12427 int result;
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012428 STRUCT_STAT st;
12429 PyObject *ub;
Victor Stinner6036e442015-03-08 01:58:04 +010012430
12431#ifdef MS_WINDOWS
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012432 if (!PyUnicode_FSDecoder(self->path, &ub))
12433 return NULL;
12434 const wchar_t *path = PyUnicode_AsUnicode(ub);
Victor Stinner6036e442015-03-08 01:58:04 +010012435#else /* POSIX */
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012436 if (!PyUnicode_FSConverter(self->path, &ub))
12437 return NULL;
12438 const char *path = PyBytes_AS_STRING(ub);
12439 if (self->dir_fd != DEFAULT_DIR_FD) {
12440#ifdef HAVE_FSTATAT
12441 result = fstatat(self->dir_fd, path, &st,
12442 follow_symlinks ? 0 : AT_SYMLINK_NOFOLLOW);
12443#else
12444 PyErr_SetString(PyExc_NotImplementedError, "can't fetch stat");
12445 return NULL;
12446#endif /* HAVE_FSTATAT */
12447 }
12448 else
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012449#endif
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012450 {
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012451 if (follow_symlinks)
12452 result = STAT(path, &st);
12453 else
12454 result = LSTAT(path, &st);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012455 }
12456 Py_DECREF(ub);
Victor Stinner6036e442015-03-08 01:58:04 +010012457
12458 if (result != 0)
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012459 return path_object_error(self->path);
Victor Stinner6036e442015-03-08 01:58:04 +010012460
12461 return _pystat_fromstructstat(&st);
12462}
12463
12464static PyObject *
12465DirEntry_get_lstat(DirEntry *self)
12466{
12467 if (!self->lstat) {
12468#ifdef MS_WINDOWS
12469 self->lstat = _pystat_fromstructstat(&self->win32_lstat);
12470#else /* POSIX */
12471 self->lstat = DirEntry_fetch_stat(self, 0);
12472#endif
12473 }
12474 Py_XINCREF(self->lstat);
12475 return self->lstat;
12476}
12477
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012478/*[clinic input]
12479os.DirEntry.stat
12480 *
12481 follow_symlinks: bool = True
12482
12483Return stat_result object for the entry; cached per entry.
12484[clinic start generated code]*/
12485
Victor Stinner6036e442015-03-08 01:58:04 +010012486static PyObject *
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012487os_DirEntry_stat_impl(DirEntry *self, int follow_symlinks)
12488/*[clinic end generated code: output=008593b3a6d01305 input=280d14c1d6f1d00d]*/
Victor Stinner6036e442015-03-08 01:58:04 +010012489{
12490 if (!follow_symlinks)
12491 return DirEntry_get_lstat(self);
12492
12493 if (!self->stat) {
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012494 int result = os_DirEntry_is_symlink_impl(self);
Victor Stinner6036e442015-03-08 01:58:04 +010012495 if (result == -1)
12496 return NULL;
12497 else if (result)
12498 self->stat = DirEntry_fetch_stat(self, 1);
12499 else
12500 self->stat = DirEntry_get_lstat(self);
12501 }
12502
12503 Py_XINCREF(self->stat);
12504 return self->stat;
12505}
12506
Victor Stinner6036e442015-03-08 01:58:04 +010012507/* Set exception and return -1 on error, 0 for False, 1 for True */
12508static int
12509DirEntry_test_mode(DirEntry *self, int follow_symlinks, unsigned short mode_bits)
12510{
12511 PyObject *stat = NULL;
12512 PyObject *st_mode = NULL;
12513 long mode;
12514 int result;
Victor Stinner35a97c02015-03-08 02:59:09 +010012515#if defined(MS_WINDOWS) || defined(HAVE_DIRENT_D_TYPE)
Victor Stinner6036e442015-03-08 01:58:04 +010012516 int is_symlink;
12517 int need_stat;
Victor Stinner35a97c02015-03-08 02:59:09 +010012518#endif
Victor Stinner6036e442015-03-08 01:58:04 +010012519#ifdef MS_WINDOWS
12520 unsigned long dir_bits;
12521#endif
Victor Stinner35a97c02015-03-08 02:59:09 +010012522 _Py_IDENTIFIER(st_mode);
Victor Stinner6036e442015-03-08 01:58:04 +010012523
12524#ifdef MS_WINDOWS
12525 is_symlink = (self->win32_lstat.st_mode & S_IFMT) == S_IFLNK;
12526 need_stat = follow_symlinks && is_symlink;
Victor Stinner35a97c02015-03-08 02:59:09 +010012527#elif defined(HAVE_DIRENT_D_TYPE)
Victor Stinner6036e442015-03-08 01:58:04 +010012528 is_symlink = self->d_type == DT_LNK;
12529 need_stat = self->d_type == DT_UNKNOWN || (follow_symlinks && is_symlink);
12530#endif
12531
Victor Stinner35a97c02015-03-08 02:59:09 +010012532#if defined(MS_WINDOWS) || defined(HAVE_DIRENT_D_TYPE)
Victor Stinner6036e442015-03-08 01:58:04 +010012533 if (need_stat) {
Victor Stinner35a97c02015-03-08 02:59:09 +010012534#endif
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012535 stat = os_DirEntry_stat_impl(self, follow_symlinks);
Victor Stinner6036e442015-03-08 01:58:04 +010012536 if (!stat) {
12537 if (PyErr_ExceptionMatches(PyExc_FileNotFoundError)) {
12538 /* If file doesn't exist (anymore), then return False
12539 (i.e., say it's not a file/directory) */
12540 PyErr_Clear();
12541 return 0;
12542 }
12543 goto error;
12544 }
12545 st_mode = _PyObject_GetAttrId(stat, &PyId_st_mode);
12546 if (!st_mode)
12547 goto error;
12548
12549 mode = PyLong_AsLong(st_mode);
12550 if (mode == -1 && PyErr_Occurred())
12551 goto error;
12552 Py_CLEAR(st_mode);
12553 Py_CLEAR(stat);
12554 result = (mode & S_IFMT) == mode_bits;
Victor Stinner35a97c02015-03-08 02:59:09 +010012555#if defined(MS_WINDOWS) || defined(HAVE_DIRENT_D_TYPE)
Victor Stinner6036e442015-03-08 01:58:04 +010012556 }
12557 else if (is_symlink) {
12558 assert(mode_bits != S_IFLNK);
12559 result = 0;
12560 }
12561 else {
12562 assert(mode_bits == S_IFDIR || mode_bits == S_IFREG);
12563#ifdef MS_WINDOWS
12564 dir_bits = self->win32_lstat.st_file_attributes & FILE_ATTRIBUTE_DIRECTORY;
12565 if (mode_bits == S_IFDIR)
12566 result = dir_bits != 0;
12567 else
12568 result = dir_bits == 0;
12569#else /* POSIX */
12570 if (mode_bits == S_IFDIR)
12571 result = self->d_type == DT_DIR;
12572 else
12573 result = self->d_type == DT_REG;
12574#endif
12575 }
Victor Stinner35a97c02015-03-08 02:59:09 +010012576#endif
Victor Stinner6036e442015-03-08 01:58:04 +010012577
12578 return result;
12579
12580error:
12581 Py_XDECREF(st_mode);
12582 Py_XDECREF(stat);
12583 return -1;
12584}
12585
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012586/*[clinic input]
12587os.DirEntry.is_dir -> bool
12588 *
12589 follow_symlinks: bool = True
Victor Stinner6036e442015-03-08 01:58:04 +010012590
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012591Return True if the entry is a directory; cached per entry.
12592[clinic start generated code]*/
12593
12594static int
12595os_DirEntry_is_dir_impl(DirEntry *self, int follow_symlinks)
12596/*[clinic end generated code: output=ad2e8d54365da287 input=0135232766f53f58]*/
12597{
12598 return DirEntry_test_mode(self, follow_symlinks, S_IFDIR);
Victor Stinner6036e442015-03-08 01:58:04 +010012599}
12600
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012601/*[clinic input]
12602os.DirEntry.is_file -> bool
12603 *
12604 follow_symlinks: bool = True
12605
12606Return True if the entry is a file; cached per entry.
12607[clinic start generated code]*/
12608
12609static int
12610os_DirEntry_is_file_impl(DirEntry *self, int follow_symlinks)
12611/*[clinic end generated code: output=8462ade481d8a476 input=0dc90be168b041ee]*/
Victor Stinner6036e442015-03-08 01:58:04 +010012612{
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012613 return DirEntry_test_mode(self, follow_symlinks, S_IFREG);
Victor Stinner6036e442015-03-08 01:58:04 +010012614}
12615
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012616/*[clinic input]
12617os.DirEntry.inode
Victor Stinner6036e442015-03-08 01:58:04 +010012618
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012619Return inode of the entry; cached per entry.
12620[clinic start generated code]*/
Victor Stinner6036e442015-03-08 01:58:04 +010012621
12622static PyObject *
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012623os_DirEntry_inode_impl(DirEntry *self)
12624/*[clinic end generated code: output=156bb3a72162440e input=3ee7b872ae8649f0]*/
Victor Stinner6036e442015-03-08 01:58:04 +010012625{
12626#ifdef MS_WINDOWS
12627 if (!self->got_file_index) {
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012628 PyObject *unicode;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +030012629 const wchar_t *path;
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012630 STRUCT_STAT stat;
12631 int result;
Victor Stinner6036e442015-03-08 01:58:04 +010012632
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012633 if (!PyUnicode_FSDecoder(self->path, &unicode))
Victor Stinner6036e442015-03-08 01:58:04 +010012634 return NULL;
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012635 path = PyUnicode_AsUnicode(unicode);
12636 result = LSTAT(path, &stat);
12637 Py_DECREF(unicode);
Victor Stinner6036e442015-03-08 01:58:04 +010012638
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012639 if (result != 0)
12640 return path_object_error(self->path);
Victor Stinner6036e442015-03-08 01:58:04 +010012641
12642 self->win32_file_index = stat.st_ino;
12643 self->got_file_index = 1;
12644 }
Victor Stinner0f6d7332017-03-09 17:34:28 +010012645 Py_BUILD_ASSERT(sizeof(unsigned long long) >= sizeof(self->win32_file_index));
12646 return PyLong_FromUnsignedLongLong(self->win32_file_index);
Victor Stinner6036e442015-03-08 01:58:04 +010012647#else /* POSIX */
xdegaye50e86032017-05-22 11:15:08 +020012648 Py_BUILD_ASSERT(sizeof(unsigned long long) >= sizeof(self->d_ino));
12649 return PyLong_FromUnsignedLongLong(self->d_ino);
Victor Stinner6036e442015-03-08 01:58:04 +010012650#endif
12651}
12652
12653static PyObject *
12654DirEntry_repr(DirEntry *self)
12655{
12656 return PyUnicode_FromFormat("<DirEntry %R>", self->name);
12657}
12658
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012659/*[clinic input]
12660os.DirEntry.__fspath__
12661
12662Returns the path for the entry.
12663[clinic start generated code]*/
12664
Brett Cannon96881cd2016-06-10 14:37:21 -070012665static PyObject *
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012666os_DirEntry___fspath___impl(DirEntry *self)
12667/*[clinic end generated code: output=6dd7f7ef752e6f4f input=3c49d0cf38df4fac]*/
Brett Cannon96881cd2016-06-10 14:37:21 -070012668{
12669 Py_INCREF(self->path);
12670 return self->path;
12671}
12672
Victor Stinner6036e442015-03-08 01:58:04 +010012673static PyMemberDef DirEntry_members[] = {
12674 {"name", T_OBJECT_EX, offsetof(DirEntry, name), READONLY,
12675 "the entry's base filename, relative to scandir() \"path\" argument"},
12676 {"path", T_OBJECT_EX, offsetof(DirEntry, path), READONLY,
12677 "the entry's full path name; equivalent to os.path.join(scandir_path, entry.name)"},
12678 {NULL}
12679};
12680
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012681#include "clinic/posixmodule.c.h"
12682
Victor Stinner6036e442015-03-08 01:58:04 +010012683static PyMethodDef DirEntry_methods[] = {
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012684 OS_DIRENTRY_IS_DIR_METHODDEF
12685 OS_DIRENTRY_IS_FILE_METHODDEF
12686 OS_DIRENTRY_IS_SYMLINK_METHODDEF
12687 OS_DIRENTRY_STAT_METHODDEF
12688 OS_DIRENTRY_INODE_METHODDEF
12689 OS_DIRENTRY___FSPATH___METHODDEF
Victor Stinner6036e442015-03-08 01:58:04 +010012690 {NULL}
12691};
12692
Benjamin Peterson5646de42015-04-12 17:56:34 -040012693static PyTypeObject DirEntryType = {
Victor Stinner6036e442015-03-08 01:58:04 +010012694 PyVarObject_HEAD_INIT(NULL, 0)
12695 MODNAME ".DirEntry", /* tp_name */
12696 sizeof(DirEntry), /* tp_basicsize */
12697 0, /* tp_itemsize */
12698 /* methods */
12699 (destructor)DirEntry_dealloc, /* tp_dealloc */
Jeroen Demeyer530f5062019-05-31 04:13:39 +020012700 0, /* tp_vectorcall_offset */
Victor Stinner6036e442015-03-08 01:58:04 +010012701 0, /* tp_getattr */
12702 0, /* tp_setattr */
Jeroen Demeyer530f5062019-05-31 04:13:39 +020012703 0, /* tp_as_async */
Victor Stinner6036e442015-03-08 01:58:04 +010012704 (reprfunc)DirEntry_repr, /* tp_repr */
12705 0, /* tp_as_number */
12706 0, /* tp_as_sequence */
12707 0, /* tp_as_mapping */
12708 0, /* tp_hash */
12709 0, /* tp_call */
12710 0, /* tp_str */
12711 0, /* tp_getattro */
12712 0, /* tp_setattro */
12713 0, /* tp_as_buffer */
12714 Py_TPFLAGS_DEFAULT, /* tp_flags */
12715 0, /* tp_doc */
12716 0, /* tp_traverse */
12717 0, /* tp_clear */
12718 0, /* tp_richcompare */
12719 0, /* tp_weaklistoffset */
12720 0, /* tp_iter */
12721 0, /* tp_iternext */
12722 DirEntry_methods, /* tp_methods */
12723 DirEntry_members, /* tp_members */
12724};
12725
12726#ifdef MS_WINDOWS
12727
12728static wchar_t *
Serhiy Storchakadeab18d2016-05-07 16:45:18 +030012729join_path_filenameW(const wchar_t *path_wide, const wchar_t *filename)
Victor Stinner6036e442015-03-08 01:58:04 +010012730{
12731 Py_ssize_t path_len;
12732 Py_ssize_t size;
12733 wchar_t *result;
12734 wchar_t ch;
12735
12736 if (!path_wide) { /* Default arg: "." */
12737 path_wide = L".";
12738 path_len = 1;
12739 }
12740 else {
12741 path_len = wcslen(path_wide);
12742 }
12743
12744 /* The +1's are for the path separator and the NUL */
12745 size = path_len + 1 + wcslen(filename) + 1;
12746 result = PyMem_New(wchar_t, size);
12747 if (!result) {
12748 PyErr_NoMemory();
12749 return NULL;
12750 }
12751 wcscpy(result, path_wide);
12752 if (path_len > 0) {
12753 ch = result[path_len - 1];
12754 if (ch != SEP && ch != ALTSEP && ch != L':')
12755 result[path_len++] = SEP;
12756 wcscpy(result + path_len, filename);
12757 }
12758 return result;
12759}
12760
12761static PyObject *
12762DirEntry_from_find_data(path_t *path, WIN32_FIND_DATAW *dataW)
12763{
12764 DirEntry *entry;
12765 BY_HANDLE_FILE_INFORMATION file_info;
12766 ULONG reparse_tag;
12767 wchar_t *joined_path;
12768
12769 entry = PyObject_New(DirEntry, &DirEntryType);
12770 if (!entry)
12771 return NULL;
12772 entry->name = NULL;
12773 entry->path = NULL;
12774 entry->stat = NULL;
12775 entry->lstat = NULL;
12776 entry->got_file_index = 0;
12777
12778 entry->name = PyUnicode_FromWideChar(dataW->cFileName, -1);
12779 if (!entry->name)
12780 goto error;
Steve Dowercc16be82016-09-08 10:35:16 -070012781 if (path->narrow) {
12782 Py_SETREF(entry->name, PyUnicode_EncodeFSDefault(entry->name));
12783 if (!entry->name)
12784 goto error;
12785 }
Victor Stinner6036e442015-03-08 01:58:04 +010012786
12787 joined_path = join_path_filenameW(path->wide, dataW->cFileName);
12788 if (!joined_path)
12789 goto error;
12790
12791 entry->path = PyUnicode_FromWideChar(joined_path, -1);
12792 PyMem_Free(joined_path);
12793 if (!entry->path)
12794 goto error;
Steve Dowercc16be82016-09-08 10:35:16 -070012795 if (path->narrow) {
12796 Py_SETREF(entry->path, PyUnicode_EncodeFSDefault(entry->path));
12797 if (!entry->path)
12798 goto error;
12799 }
Victor Stinner6036e442015-03-08 01:58:04 +010012800
Steve Dowercc16be82016-09-08 10:35:16 -070012801 find_data_to_file_info(dataW, &file_info, &reparse_tag);
Victor Stinner6036e442015-03-08 01:58:04 +010012802 _Py_attribute_data_to_stat(&file_info, reparse_tag, &entry->win32_lstat);
12803
12804 return (PyObject *)entry;
12805
12806error:
12807 Py_DECREF(entry);
12808 return NULL;
12809}
12810
12811#else /* POSIX */
12812
12813static char *
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020012814join_path_filename(const char *path_narrow, const char* filename, Py_ssize_t filename_len)
Victor Stinner6036e442015-03-08 01:58:04 +010012815{
12816 Py_ssize_t path_len;
12817 Py_ssize_t size;
12818 char *result;
12819
12820 if (!path_narrow) { /* Default arg: "." */
12821 path_narrow = ".";
12822 path_len = 1;
12823 }
12824 else {
12825 path_len = strlen(path_narrow);
12826 }
12827
12828 if (filename_len == -1)
12829 filename_len = strlen(filename);
12830
12831 /* The +1's are for the path separator and the NUL */
12832 size = path_len + 1 + filename_len + 1;
12833 result = PyMem_New(char, size);
12834 if (!result) {
12835 PyErr_NoMemory();
12836 return NULL;
12837 }
12838 strcpy(result, path_narrow);
12839 if (path_len > 0 && result[path_len - 1] != '/')
12840 result[path_len++] = '/';
12841 strcpy(result + path_len, filename);
12842 return result;
12843}
12844
12845static PyObject *
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020012846DirEntry_from_posix_info(path_t *path, const char *name, Py_ssize_t name_len,
Victor Stinner35a97c02015-03-08 02:59:09 +010012847 ino_t d_ino
12848#ifdef HAVE_DIRENT_D_TYPE
12849 , unsigned char d_type
12850#endif
12851 )
Victor Stinner6036e442015-03-08 01:58:04 +010012852{
12853 DirEntry *entry;
12854 char *joined_path;
12855
12856 entry = PyObject_New(DirEntry, &DirEntryType);
12857 if (!entry)
12858 return NULL;
12859 entry->name = NULL;
12860 entry->path = NULL;
12861 entry->stat = NULL;
12862 entry->lstat = NULL;
12863
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012864 if (path->fd != -1) {
12865 entry->dir_fd = path->fd;
12866 joined_path = NULL;
12867 }
12868 else {
12869 entry->dir_fd = DEFAULT_DIR_FD;
12870 joined_path = join_path_filename(path->narrow, name, name_len);
12871 if (!joined_path)
12872 goto error;
12873 }
Victor Stinner6036e442015-03-08 01:58:04 +010012874
Serhiy Storchaka1180e5a2017-07-11 06:36:46 +030012875 if (!path->narrow || !PyObject_CheckBuffer(path->object)) {
Victor Stinner6036e442015-03-08 01:58:04 +010012876 entry->name = PyUnicode_DecodeFSDefaultAndSize(name, name_len);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012877 if (joined_path)
12878 entry->path = PyUnicode_DecodeFSDefault(joined_path);
Victor Stinner6036e442015-03-08 01:58:04 +010012879 }
12880 else {
12881 entry->name = PyBytes_FromStringAndSize(name, name_len);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012882 if (joined_path)
12883 entry->path = PyBytes_FromString(joined_path);
Victor Stinner6036e442015-03-08 01:58:04 +010012884 }
12885 PyMem_Free(joined_path);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012886 if (!entry->name)
12887 goto error;
12888
12889 if (path->fd != -1) {
12890 entry->path = entry->name;
12891 Py_INCREF(entry->path);
12892 }
12893 else if (!entry->path)
Victor Stinner6036e442015-03-08 01:58:04 +010012894 goto error;
12895
Victor Stinner35a97c02015-03-08 02:59:09 +010012896#ifdef HAVE_DIRENT_D_TYPE
Victor Stinner6036e442015-03-08 01:58:04 +010012897 entry->d_type = d_type;
Victor Stinner35a97c02015-03-08 02:59:09 +010012898#endif
Victor Stinner6036e442015-03-08 01:58:04 +010012899 entry->d_ino = d_ino;
12900
12901 return (PyObject *)entry;
12902
12903error:
12904 Py_XDECREF(entry);
12905 return NULL;
12906}
12907
12908#endif
12909
12910
12911typedef struct {
12912 PyObject_HEAD
12913 path_t path;
12914#ifdef MS_WINDOWS
12915 HANDLE handle;
12916 WIN32_FIND_DATAW file_data;
12917 int first_time;
12918#else /* POSIX */
12919 DIR *dirp;
12920#endif
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012921#ifdef HAVE_FDOPENDIR
12922 int fd;
12923#endif
Victor Stinner6036e442015-03-08 01:58:04 +010012924} ScandirIterator;
12925
12926#ifdef MS_WINDOWS
12927
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020012928static int
12929ScandirIterator_is_closed(ScandirIterator *iterator)
12930{
12931 return iterator->handle == INVALID_HANDLE_VALUE;
12932}
12933
Victor Stinner6036e442015-03-08 01:58:04 +010012934static void
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020012935ScandirIterator_closedir(ScandirIterator *iterator)
Victor Stinner6036e442015-03-08 01:58:04 +010012936{
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030012937 HANDLE handle = iterator->handle;
12938
12939 if (handle == INVALID_HANDLE_VALUE)
Victor Stinner6036e442015-03-08 01:58:04 +010012940 return;
12941
Victor Stinner6036e442015-03-08 01:58:04 +010012942 iterator->handle = INVALID_HANDLE_VALUE;
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030012943 Py_BEGIN_ALLOW_THREADS
12944 FindClose(handle);
12945 Py_END_ALLOW_THREADS
Victor Stinner6036e442015-03-08 01:58:04 +010012946}
12947
12948static PyObject *
12949ScandirIterator_iternext(ScandirIterator *iterator)
12950{
12951 WIN32_FIND_DATAW *file_data = &iterator->file_data;
12952 BOOL success;
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020012953 PyObject *entry;
Victor Stinner6036e442015-03-08 01:58:04 +010012954
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020012955 /* Happens if the iterator is iterated twice, or closed explicitly */
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020012956 if (iterator->handle == INVALID_HANDLE_VALUE)
Victor Stinner6036e442015-03-08 01:58:04 +010012957 return NULL;
Victor Stinner6036e442015-03-08 01:58:04 +010012958
12959 while (1) {
12960 if (!iterator->first_time) {
12961 Py_BEGIN_ALLOW_THREADS
12962 success = FindNextFileW(iterator->handle, file_data);
12963 Py_END_ALLOW_THREADS
12964 if (!success) {
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020012965 /* Error or no more files */
Victor Stinner6036e442015-03-08 01:58:04 +010012966 if (GetLastError() != ERROR_NO_MORE_FILES)
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020012967 path_error(&iterator->path);
Victor Stinner6036e442015-03-08 01:58:04 +010012968 break;
12969 }
12970 }
12971 iterator->first_time = 0;
12972
12973 /* Skip over . and .. */
12974 if (wcscmp(file_data->cFileName, L".") != 0 &&
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020012975 wcscmp(file_data->cFileName, L"..") != 0) {
12976 entry = DirEntry_from_find_data(&iterator->path, file_data);
12977 if (!entry)
12978 break;
12979 return entry;
12980 }
Victor Stinner6036e442015-03-08 01:58:04 +010012981
12982 /* Loop till we get a non-dot directory or finish iterating */
12983 }
12984
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020012985 /* Error or no more files */
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020012986 ScandirIterator_closedir(iterator);
Victor Stinner6036e442015-03-08 01:58:04 +010012987 return NULL;
12988}
12989
12990#else /* POSIX */
12991
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020012992static int
12993ScandirIterator_is_closed(ScandirIterator *iterator)
12994{
12995 return !iterator->dirp;
12996}
12997
Victor Stinner6036e442015-03-08 01:58:04 +010012998static void
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020012999ScandirIterator_closedir(ScandirIterator *iterator)
Victor Stinner6036e442015-03-08 01:58:04 +010013000{
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030013001 DIR *dirp = iterator->dirp;
13002
13003 if (!dirp)
Victor Stinner6036e442015-03-08 01:58:04 +010013004 return;
13005
Victor Stinner6036e442015-03-08 01:58:04 +010013006 iterator->dirp = NULL;
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030013007 Py_BEGIN_ALLOW_THREADS
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013008#ifdef HAVE_FDOPENDIR
13009 if (iterator->path.fd != -1)
13010 rewinddir(dirp);
13011#endif
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030013012 closedir(dirp);
13013 Py_END_ALLOW_THREADS
Victor Stinner6036e442015-03-08 01:58:04 +010013014 return;
13015}
13016
13017static PyObject *
13018ScandirIterator_iternext(ScandirIterator *iterator)
13019{
13020 struct dirent *direntp;
13021 Py_ssize_t name_len;
13022 int is_dot;
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013023 PyObject *entry;
Victor Stinner6036e442015-03-08 01:58:04 +010013024
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013025 /* Happens if the iterator is iterated twice, or closed explicitly */
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013026 if (!iterator->dirp)
Victor Stinner6036e442015-03-08 01:58:04 +010013027 return NULL;
Victor Stinner6036e442015-03-08 01:58:04 +010013028
13029 while (1) {
13030 errno = 0;
13031 Py_BEGIN_ALLOW_THREADS
13032 direntp = readdir(iterator->dirp);
13033 Py_END_ALLOW_THREADS
13034
13035 if (!direntp) {
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013036 /* Error or no more files */
Victor Stinner6036e442015-03-08 01:58:04 +010013037 if (errno != 0)
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013038 path_error(&iterator->path);
Victor Stinner6036e442015-03-08 01:58:04 +010013039 break;
13040 }
13041
13042 /* Skip over . and .. */
13043 name_len = NAMLEN(direntp);
13044 is_dot = direntp->d_name[0] == '.' &&
13045 (name_len == 1 || (direntp->d_name[1] == '.' && name_len == 2));
13046 if (!is_dot) {
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013047 entry = DirEntry_from_posix_info(&iterator->path, direntp->d_name,
Victor Stinner35a97c02015-03-08 02:59:09 +010013048 name_len, direntp->d_ino
13049#ifdef HAVE_DIRENT_D_TYPE
13050 , direntp->d_type
13051#endif
13052 );
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013053 if (!entry)
13054 break;
13055 return entry;
Victor Stinner6036e442015-03-08 01:58:04 +010013056 }
13057
13058 /* Loop till we get a non-dot directory or finish iterating */
13059 }
13060
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020013061 /* Error or no more files */
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013062 ScandirIterator_closedir(iterator);
Victor Stinner6036e442015-03-08 01:58:04 +010013063 return NULL;
13064}
13065
13066#endif
13067
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013068static PyObject *
13069ScandirIterator_close(ScandirIterator *self, PyObject *args)
13070{
13071 ScandirIterator_closedir(self);
13072 Py_RETURN_NONE;
13073}
13074
13075static PyObject *
13076ScandirIterator_enter(PyObject *self, PyObject *args)
13077{
13078 Py_INCREF(self);
13079 return self;
13080}
13081
13082static PyObject *
13083ScandirIterator_exit(ScandirIterator *self, PyObject *args)
13084{
13085 ScandirIterator_closedir(self);
13086 Py_RETURN_NONE;
13087}
13088
Victor Stinner6036e442015-03-08 01:58:04 +010013089static void
Victor Stinner7bfa4092016-03-23 00:43:54 +010013090ScandirIterator_finalize(ScandirIterator *iterator)
13091{
13092 PyObject *error_type, *error_value, *error_traceback;
13093
13094 /* Save the current exception, if any. */
13095 PyErr_Fetch(&error_type, &error_value, &error_traceback);
13096
13097 if (!ScandirIterator_is_closed(iterator)) {
13098 ScandirIterator_closedir(iterator);
13099
13100 if (PyErr_ResourceWarning((PyObject *)iterator, 1,
13101 "unclosed scandir iterator %R", iterator)) {
13102 /* Spurious errors can appear at shutdown */
13103 if (PyErr_ExceptionMatches(PyExc_Warning)) {
13104 PyErr_WriteUnraisable((PyObject *) iterator);
13105 }
13106 }
13107 }
13108
Victor Stinner7bfa4092016-03-23 00:43:54 +010013109 path_cleanup(&iterator->path);
13110
13111 /* Restore the saved exception. */
13112 PyErr_Restore(error_type, error_value, error_traceback);
13113}
13114
13115static void
Victor Stinner6036e442015-03-08 01:58:04 +010013116ScandirIterator_dealloc(ScandirIterator *iterator)
13117{
Victor Stinner7bfa4092016-03-23 00:43:54 +010013118 if (PyObject_CallFinalizerFromDealloc((PyObject *)iterator) < 0)
13119 return;
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013120
Victor Stinner6036e442015-03-08 01:58:04 +010013121 Py_TYPE(iterator)->tp_free((PyObject *)iterator);
13122}
13123
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013124static PyMethodDef ScandirIterator_methods[] = {
13125 {"__enter__", (PyCFunction)ScandirIterator_enter, METH_NOARGS},
13126 {"__exit__", (PyCFunction)ScandirIterator_exit, METH_VARARGS},
13127 {"close", (PyCFunction)ScandirIterator_close, METH_NOARGS},
13128 {NULL}
13129};
13130
Benjamin Peterson5646de42015-04-12 17:56:34 -040013131static PyTypeObject ScandirIteratorType = {
Victor Stinner6036e442015-03-08 01:58:04 +010013132 PyVarObject_HEAD_INIT(NULL, 0)
13133 MODNAME ".ScandirIterator", /* tp_name */
13134 sizeof(ScandirIterator), /* tp_basicsize */
13135 0, /* tp_itemsize */
13136 /* methods */
13137 (destructor)ScandirIterator_dealloc, /* tp_dealloc */
Jeroen Demeyer530f5062019-05-31 04:13:39 +020013138 0, /* tp_vectorcall_offset */
Victor Stinner6036e442015-03-08 01:58:04 +010013139 0, /* tp_getattr */
13140 0, /* tp_setattr */
Jeroen Demeyer530f5062019-05-31 04:13:39 +020013141 0, /* tp_as_async */
Victor Stinner6036e442015-03-08 01:58:04 +010013142 0, /* tp_repr */
13143 0, /* tp_as_number */
13144 0, /* tp_as_sequence */
13145 0, /* tp_as_mapping */
13146 0, /* tp_hash */
13147 0, /* tp_call */
13148 0, /* tp_str */
13149 0, /* tp_getattro */
13150 0, /* tp_setattro */
13151 0, /* tp_as_buffer */
Antoine Pitrouada319b2019-05-29 22:12:38 +020013152 Py_TPFLAGS_DEFAULT, /* tp_flags */
Victor Stinner6036e442015-03-08 01:58:04 +010013153 0, /* tp_doc */
13154 0, /* tp_traverse */
13155 0, /* tp_clear */
13156 0, /* tp_richcompare */
13157 0, /* tp_weaklistoffset */
13158 PyObject_SelfIter, /* tp_iter */
13159 (iternextfunc)ScandirIterator_iternext, /* tp_iternext */
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020013160 ScandirIterator_methods, /* tp_methods */
Victor Stinner7bfa4092016-03-23 00:43:54 +010013161 0, /* tp_members */
13162 0, /* tp_getset */
13163 0, /* tp_base */
13164 0, /* tp_dict */
13165 0, /* tp_descr_get */
13166 0, /* tp_descr_set */
13167 0, /* tp_dictoffset */
13168 0, /* tp_init */
13169 0, /* tp_alloc */
13170 0, /* tp_new */
13171 0, /* tp_free */
13172 0, /* tp_is_gc */
13173 0, /* tp_bases */
13174 0, /* tp_mro */
13175 0, /* tp_cache */
13176 0, /* tp_subclasses */
13177 0, /* tp_weaklist */
13178 0, /* tp_del */
13179 0, /* tp_version_tag */
13180 (destructor)ScandirIterator_finalize, /* tp_finalize */
Victor Stinner6036e442015-03-08 01:58:04 +010013181};
13182
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013183/*[clinic input]
13184os.scandir
13185
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013186 path : path_t(nullable=True, allow_fd='PATH_HAVE_FDOPENDIR') = None
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013187
13188Return an iterator of DirEntry objects for given path.
13189
BNMetricsb9427072018-11-02 15:20:19 +000013190path can be specified as either str, bytes, or a path-like object. If path
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013191is bytes, the names of yielded DirEntry objects will also be bytes; in
13192all other circumstances they will be str.
13193
13194If path is None, uses the path='.'.
13195[clinic start generated code]*/
13196
Victor Stinner6036e442015-03-08 01:58:04 +010013197static PyObject *
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013198os_scandir_impl(PyObject *module, path_t *path)
BNMetricsb9427072018-11-02 15:20:19 +000013199/*[clinic end generated code: output=6eb2668b675ca89e input=6bdd312708fc3bb0]*/
Victor Stinner6036e442015-03-08 01:58:04 +010013200{
13201 ScandirIterator *iterator;
Victor Stinner6036e442015-03-08 01:58:04 +010013202#ifdef MS_WINDOWS
13203 wchar_t *path_strW;
13204#else
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013205 const char *path_str;
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013206#ifdef HAVE_FDOPENDIR
13207 int fd = -1;
13208#endif
Victor Stinner6036e442015-03-08 01:58:04 +010013209#endif
13210
Miss Islington (bot)8763d432019-06-24 09:09:47 -070013211 if (PySys_Audit("os.scandir", "O",
13212 path->object ? path->object : Py_None) < 0) {
13213 return NULL;
13214 }
13215
Victor Stinner6036e442015-03-08 01:58:04 +010013216 iterator = PyObject_New(ScandirIterator, &ScandirIteratorType);
13217 if (!iterator)
13218 return NULL;
Victor Stinner6036e442015-03-08 01:58:04 +010013219
13220#ifdef MS_WINDOWS
13221 iterator->handle = INVALID_HANDLE_VALUE;
13222#else
13223 iterator->dirp = NULL;
13224#endif
13225
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013226 memcpy(&iterator->path, path, sizeof(path_t));
Serhiy Storchaka095ef732017-02-09 20:05:51 +020013227 /* Move the ownership to iterator->path */
13228 path->object = NULL;
13229 path->cleanup = NULL;
Victor Stinner6036e442015-03-08 01:58:04 +010013230
13231#ifdef MS_WINDOWS
Victor Stinner6036e442015-03-08 01:58:04 +010013232 iterator->first_time = 1;
13233
13234 path_strW = join_path_filenameW(iterator->path.wide, L"*.*");
13235 if (!path_strW)
13236 goto error;
13237
13238 Py_BEGIN_ALLOW_THREADS
13239 iterator->handle = FindFirstFileW(path_strW, &iterator->file_data);
13240 Py_END_ALLOW_THREADS
13241
13242 PyMem_Free(path_strW);
13243
13244 if (iterator->handle == INVALID_HANDLE_VALUE) {
13245 path_error(&iterator->path);
13246 goto error;
13247 }
13248#else /* POSIX */
Victor Stinner6036e442015-03-08 01:58:04 +010013249 errno = 0;
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013250#ifdef HAVE_FDOPENDIR
13251 if (path->fd != -1) {
13252 /* closedir() closes the FD, so we duplicate it */
13253 fd = _Py_dup(path->fd);
13254 if (fd == -1)
13255 goto error;
13256
13257 Py_BEGIN_ALLOW_THREADS
13258 iterator->dirp = fdopendir(fd);
13259 Py_END_ALLOW_THREADS
13260 }
13261 else
13262#endif
13263 {
13264 if (iterator->path.narrow)
13265 path_str = iterator->path.narrow;
13266 else
13267 path_str = ".";
13268
13269 Py_BEGIN_ALLOW_THREADS
13270 iterator->dirp = opendir(path_str);
13271 Py_END_ALLOW_THREADS
13272 }
Victor Stinner6036e442015-03-08 01:58:04 +010013273
13274 if (!iterator->dirp) {
13275 path_error(&iterator->path);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030013276#ifdef HAVE_FDOPENDIR
13277 if (fd != -1) {
13278 Py_BEGIN_ALLOW_THREADS
13279 close(fd);
13280 Py_END_ALLOW_THREADS
13281 }
13282#endif
Victor Stinner6036e442015-03-08 01:58:04 +010013283 goto error;
13284 }
13285#endif
13286
13287 return (PyObject *)iterator;
13288
13289error:
13290 Py_DECREF(iterator);
13291 return NULL;
13292}
13293
Ethan Furman410ef8e2016-06-04 12:06:26 -070013294/*
13295 Return the file system path representation of the object.
13296
13297 If the object is str or bytes, then allow it to pass through with
13298 an incremented refcount. If the object defines __fspath__(), then
13299 return the result of that method. All other types raise a TypeError.
13300*/
13301PyObject *
13302PyOS_FSPath(PyObject *path)
13303{
Brett Cannon3f9183b2016-08-26 14:44:48 -070013304 /* For error message reasons, this function is manually inlined in
13305 path_converter(). */
Ethan Furman410ef8e2016-06-04 12:06:26 -070013306 _Py_IDENTIFIER(__fspath__);
13307 PyObject *func = NULL;
13308 PyObject *path_repr = NULL;
13309
13310 if (PyUnicode_Check(path) || PyBytes_Check(path)) {
13311 Py_INCREF(path);
13312 return path;
13313 }
13314
13315 func = _PyObject_LookupSpecial(path, &PyId___fspath__);
13316 if (NULL == func) {
13317 return PyErr_Format(PyExc_TypeError,
13318 "expected str, bytes or os.PathLike object, "
Brett Cannonc78ca1e2016-06-24 12:03:43 -070013319 "not %.200s",
13320 Py_TYPE(path)->tp_name);
Ethan Furman410ef8e2016-06-04 12:06:26 -070013321 }
13322
Victor Stinnerf17c3de2016-12-06 18:46:19 +010013323 path_repr = _PyObject_CallNoArg(func);
Ethan Furman410ef8e2016-06-04 12:06:26 -070013324 Py_DECREF(func);
Brett Cannon044283a2016-07-15 10:41:49 -070013325 if (NULL == path_repr) {
13326 return NULL;
13327 }
13328
Brett Cannonc78ca1e2016-06-24 12:03:43 -070013329 if (!(PyUnicode_Check(path_repr) || PyBytes_Check(path_repr))) {
13330 PyErr_Format(PyExc_TypeError,
13331 "expected %.200s.__fspath__() to return str or bytes, "
13332 "not %.200s", Py_TYPE(path)->tp_name,
13333 Py_TYPE(path_repr)->tp_name);
13334 Py_DECREF(path_repr);
13335 return NULL;
13336 }
13337
Ethan Furman410ef8e2016-06-04 12:06:26 -070013338 return path_repr;
13339}
13340
13341/*[clinic input]
13342os.fspath
13343
13344 path: object
13345
13346Return the file system path representation of the object.
13347
Brett Cannonb4f43e92016-06-09 14:32:08 -070013348If the object is str or bytes, then allow it to pass through as-is. If the
13349object defines __fspath__(), then return the result of that method. All other
13350types raise a TypeError.
Ethan Furman410ef8e2016-06-04 12:06:26 -070013351[clinic start generated code]*/
13352
13353static PyObject *
Serhiy Storchaka2954f832016-07-07 18:20:03 +030013354os_fspath_impl(PyObject *module, PyObject *path)
13355/*[clinic end generated code: output=c3c3b78ecff2914f input=e357165f7b22490f]*/
Ethan Furman410ef8e2016-06-04 12:06:26 -070013356{
13357 return PyOS_FSPath(path);
13358}
Victor Stinner6036e442015-03-08 01:58:04 +010013359
Victor Stinner9b1f4742016-09-06 16:18:52 -070013360#ifdef HAVE_GETRANDOM_SYSCALL
13361/*[clinic input]
13362os.getrandom
13363
13364 size: Py_ssize_t
13365 flags: int=0
13366
13367Obtain a series of random bytes.
13368[clinic start generated code]*/
13369
13370static PyObject *
13371os_getrandom_impl(PyObject *module, Py_ssize_t size, int flags)
13372/*[clinic end generated code: output=b3a618196a61409c input=59bafac39c594947]*/
13373{
Victor Stinner9b1f4742016-09-06 16:18:52 -070013374 PyObject *bytes;
Victor Stinnerec2319c2016-09-20 23:00:59 +020013375 Py_ssize_t n;
Victor Stinner9b1f4742016-09-06 16:18:52 -070013376
13377 if (size < 0) {
13378 errno = EINVAL;
13379 return posix_error();
13380 }
13381
Victor Stinnerec2319c2016-09-20 23:00:59 +020013382 bytes = PyBytes_FromStringAndSize(NULL, size);
13383 if (bytes == NULL) {
Victor Stinner9b1f4742016-09-06 16:18:52 -070013384 PyErr_NoMemory();
13385 return NULL;
13386 }
13387
13388 while (1) {
Victor Stinnerec2319c2016-09-20 23:00:59 +020013389 n = syscall(SYS_getrandom,
13390 PyBytes_AS_STRING(bytes),
13391 PyBytes_GET_SIZE(bytes),
13392 flags);
Victor Stinner9b1f4742016-09-06 16:18:52 -070013393 if (n < 0 && errno == EINTR) {
13394 if (PyErr_CheckSignals() < 0) {
Victor Stinnerec2319c2016-09-20 23:00:59 +020013395 goto error;
Victor Stinner9b1f4742016-09-06 16:18:52 -070013396 }
Victor Stinnerec2319c2016-09-20 23:00:59 +020013397
13398 /* getrandom() was interrupted by a signal: retry */
Victor Stinner9b1f4742016-09-06 16:18:52 -070013399 continue;
13400 }
13401 break;
13402 }
13403
13404 if (n < 0) {
Victor Stinner9b1f4742016-09-06 16:18:52 -070013405 PyErr_SetFromErrno(PyExc_OSError);
Victor Stinnerec2319c2016-09-20 23:00:59 +020013406 goto error;
Victor Stinner9b1f4742016-09-06 16:18:52 -070013407 }
13408
Victor Stinnerec2319c2016-09-20 23:00:59 +020013409 if (n != size) {
13410 _PyBytes_Resize(&bytes, n);
13411 }
Victor Stinner9b1f4742016-09-06 16:18:52 -070013412
13413 return bytes;
Victor Stinnerec2319c2016-09-20 23:00:59 +020013414
13415error:
13416 Py_DECREF(bytes);
13417 return NULL;
Victor Stinner9b1f4742016-09-06 16:18:52 -070013418}
13419#endif /* HAVE_GETRANDOM_SYSCALL */
13420
Steve Dower2438cdf2019-03-29 16:37:16 -070013421#ifdef MS_WINDOWS
13422/* bpo-36085: Helper functions for managing DLL search directories
13423 * on win32
13424 */
13425
13426typedef DLL_DIRECTORY_COOKIE (WINAPI *PAddDllDirectory)(PCWSTR newDirectory);
13427typedef BOOL (WINAPI *PRemoveDllDirectory)(DLL_DIRECTORY_COOKIE cookie);
13428
13429/*[clinic input]
13430os._add_dll_directory
13431
13432 path: path_t
13433
13434Add a path to the DLL search path.
13435
13436This search path is used when resolving dependencies for imported
13437extension modules (the module itself is resolved through sys.path),
13438and also by ctypes.
13439
13440Returns an opaque value that may be passed to os.remove_dll_directory
13441to remove this directory from the search path.
13442[clinic start generated code]*/
13443
13444static PyObject *
13445os__add_dll_directory_impl(PyObject *module, path_t *path)
13446/*[clinic end generated code: output=80b025daebb5d683 input=1de3e6c13a5808c8]*/
13447{
13448 HMODULE hKernel32;
13449 PAddDllDirectory AddDllDirectory;
13450 DLL_DIRECTORY_COOKIE cookie = 0;
13451 DWORD err = 0;
13452
13453 /* For Windows 7, we have to load this. As this will be a fairly
13454 infrequent operation, just do it each time. Kernel32 is always
13455 loaded. */
13456 Py_BEGIN_ALLOW_THREADS
13457 if (!(hKernel32 = GetModuleHandleW(L"kernel32")) ||
13458 !(AddDllDirectory = (PAddDllDirectory)GetProcAddress(
13459 hKernel32, "AddDllDirectory")) ||
13460 !(cookie = (*AddDllDirectory)(path->wide))) {
13461 err = GetLastError();
13462 }
13463 Py_END_ALLOW_THREADS
13464
13465 if (err) {
13466 return win32_error_object_err("add_dll_directory",
13467 path->object, err);
13468 }
13469
13470 return PyCapsule_New(cookie, "DLL directory cookie", NULL);
13471}
13472
13473/*[clinic input]
13474os._remove_dll_directory
13475
13476 cookie: object
13477
13478Removes a path from the DLL search path.
13479
13480The parameter is an opaque value that was returned from
13481os.add_dll_directory. You can only remove directories that you added
13482yourself.
13483[clinic start generated code]*/
13484
13485static PyObject *
13486os__remove_dll_directory_impl(PyObject *module, PyObject *cookie)
13487/*[clinic end generated code: output=594350433ae535bc input=c1d16a7e7d9dc5dc]*/
13488{
13489 HMODULE hKernel32;
13490 PRemoveDllDirectory RemoveDllDirectory;
13491 DLL_DIRECTORY_COOKIE cookieValue;
13492 DWORD err = 0;
13493
13494 if (!PyCapsule_IsValid(cookie, "DLL directory cookie")) {
13495 PyErr_SetString(PyExc_TypeError,
13496 "Provided cookie was not returned from os.add_dll_directory");
13497 return NULL;
13498 }
13499
13500 cookieValue = (DLL_DIRECTORY_COOKIE)PyCapsule_GetPointer(
13501 cookie, "DLL directory cookie");
13502
13503 /* For Windows 7, we have to load this. As this will be a fairly
13504 infrequent operation, just do it each time. Kernel32 is always
13505 loaded. */
13506 Py_BEGIN_ALLOW_THREADS
13507 if (!(hKernel32 = GetModuleHandleW(L"kernel32")) ||
13508 !(RemoveDllDirectory = (PRemoveDllDirectory)GetProcAddress(
13509 hKernel32, "RemoveDllDirectory")) ||
13510 !(*RemoveDllDirectory)(cookieValue)) {
13511 err = GetLastError();
13512 }
13513 Py_END_ALLOW_THREADS
13514
13515 if (err) {
13516 return win32_error_object_err("remove_dll_directory",
13517 NULL, err);
13518 }
13519
13520 if (PyCapsule_SetName(cookie, NULL)) {
13521 return NULL;
13522 }
13523
13524 Py_RETURN_NONE;
13525}
13526
13527#endif
Larry Hastings31826802013-10-19 00:09:25 -070013528
Fred Drake5ab8eaf1999-12-09 21:13:07 +000013529static PyMethodDef posix_methods[] = {
Larry Hastings31826802013-10-19 00:09:25 -070013530
13531 OS_STAT_METHODDEF
13532 OS_ACCESS_METHODDEF
13533 OS_TTYNAME_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100013534 OS_CHDIR_METHODDEF
13535 OS_CHFLAGS_METHODDEF
13536 OS_CHMOD_METHODDEF
13537 OS_FCHMOD_METHODDEF
13538 OS_LCHMOD_METHODDEF
13539 OS_CHOWN_METHODDEF
13540 OS_FCHOWN_METHODDEF
13541 OS_LCHOWN_METHODDEF
13542 OS_LCHFLAGS_METHODDEF
13543 OS_CHROOT_METHODDEF
13544 OS_CTERMID_METHODDEF
13545 OS_GETCWD_METHODDEF
13546 OS_GETCWDB_METHODDEF
13547 OS_LINK_METHODDEF
13548 OS_LISTDIR_METHODDEF
13549 OS_LSTAT_METHODDEF
13550 OS_MKDIR_METHODDEF
13551 OS_NICE_METHODDEF
13552 OS_GETPRIORITY_METHODDEF
13553 OS_SETPRIORITY_METHODDEF
Pablo Galindo6c6ddf92018-01-29 01:56:10 +000013554 OS_POSIX_SPAWN_METHODDEF
Joannah Nanjekye92b83222019-01-16 16:29:26 +030013555 OS_POSIX_SPAWNP_METHODDEF
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030013556 OS_READLINK_METHODDEF
Pablo Galindoaac4d032019-05-31 19:39:47 +010013557 OS_COPY_FILE_RANGE_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100013558 OS_RENAME_METHODDEF
13559 OS_REPLACE_METHODDEF
13560 OS_RMDIR_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100013561 OS_SYMLINK_METHODDEF
13562 OS_SYSTEM_METHODDEF
13563 OS_UMASK_METHODDEF
13564 OS_UNAME_METHODDEF
13565 OS_UNLINK_METHODDEF
13566 OS_REMOVE_METHODDEF
13567 OS_UTIME_METHODDEF
13568 OS_TIMES_METHODDEF
13569 OS__EXIT_METHODDEF
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +020013570 OS__FCOPYFILE_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100013571 OS_EXECV_METHODDEF
13572 OS_EXECVE_METHODDEF
13573 OS_SPAWNV_METHODDEF
13574 OS_SPAWNVE_METHODDEF
13575 OS_FORK1_METHODDEF
13576 OS_FORK_METHODDEF
Antoine Pitrou346cbd32017-05-27 17:50:54 +020013577 OS_REGISTER_AT_FORK_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100013578 OS_SCHED_GET_PRIORITY_MAX_METHODDEF
13579 OS_SCHED_GET_PRIORITY_MIN_METHODDEF
13580 OS_SCHED_GETPARAM_METHODDEF
13581 OS_SCHED_GETSCHEDULER_METHODDEF
13582 OS_SCHED_RR_GET_INTERVAL_METHODDEF
13583 OS_SCHED_SETPARAM_METHODDEF
13584 OS_SCHED_SETSCHEDULER_METHODDEF
13585 OS_SCHED_YIELD_METHODDEF
13586 OS_SCHED_SETAFFINITY_METHODDEF
13587 OS_SCHED_GETAFFINITY_METHODDEF
13588 OS_OPENPTY_METHODDEF
13589 OS_FORKPTY_METHODDEF
13590 OS_GETEGID_METHODDEF
13591 OS_GETEUID_METHODDEF
13592 OS_GETGID_METHODDEF
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +020013593#ifdef HAVE_GETGROUPLIST
13594 {"getgrouplist", posix_getgrouplist, METH_VARARGS, posix_getgrouplist__doc__},
13595#endif
Larry Hastings2f936352014-08-05 14:04:04 +100013596 OS_GETGROUPS_METHODDEF
13597 OS_GETPID_METHODDEF
13598 OS_GETPGRP_METHODDEF
13599 OS_GETPPID_METHODDEF
13600 OS_GETUID_METHODDEF
13601 OS_GETLOGIN_METHODDEF
13602 OS_KILL_METHODDEF
13603 OS_KILLPG_METHODDEF
13604 OS_PLOCK_METHODDEF
Thomas Heller8b7a9572007-08-31 06:44:36 +000013605#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -070013606 OS_STARTFILE_METHODDEF
Thomas Heller8b7a9572007-08-31 06:44:36 +000013607#endif
Larry Hastings2f936352014-08-05 14:04:04 +100013608 OS_SETUID_METHODDEF
13609 OS_SETEUID_METHODDEF
13610 OS_SETREUID_METHODDEF
13611 OS_SETGID_METHODDEF
13612 OS_SETEGID_METHODDEF
13613 OS_SETREGID_METHODDEF
13614 OS_SETGROUPS_METHODDEF
Antoine Pitroub7572f02009-12-02 20:46:48 +000013615#ifdef HAVE_INITGROUPS
Victor Stinner8c62be82010-05-06 00:08:46 +000013616 {"initgroups", posix_initgroups, METH_VARARGS, posix_initgroups__doc__},
Antoine Pitroub7572f02009-12-02 20:46:48 +000013617#endif /* HAVE_INITGROUPS */
Larry Hastings2f936352014-08-05 14:04:04 +100013618 OS_GETPGID_METHODDEF
13619 OS_SETPGRP_METHODDEF
13620 OS_WAIT_METHODDEF
13621 OS_WAIT3_METHODDEF
13622 OS_WAIT4_METHODDEF
13623 OS_WAITID_METHODDEF
13624 OS_WAITPID_METHODDEF
13625 OS_GETSID_METHODDEF
13626 OS_SETSID_METHODDEF
13627 OS_SETPGID_METHODDEF
13628 OS_TCGETPGRP_METHODDEF
13629 OS_TCSETPGRP_METHODDEF
13630 OS_OPEN_METHODDEF
13631 OS_CLOSE_METHODDEF
13632 OS_CLOSERANGE_METHODDEF
13633 OS_DEVICE_ENCODING_METHODDEF
13634 OS_DUP_METHODDEF
13635 OS_DUP2_METHODDEF
13636 OS_LOCKF_METHODDEF
13637 OS_LSEEK_METHODDEF
13638 OS_READ_METHODDEF
13639 OS_READV_METHODDEF
13640 OS_PREAD_METHODDEF
Pablo Galindo4defba32018-01-27 16:16:37 +000013641 OS_PREADV_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100013642 OS_WRITE_METHODDEF
13643 OS_WRITEV_METHODDEF
13644 OS_PWRITE_METHODDEF
Pablo Galindo4defba32018-01-27 16:16:37 +000013645 OS_PWRITEV_METHODDEF
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000013646#ifdef HAVE_SENDFILE
Serhiy Storchaka62be7422018-11-27 13:27:31 +020013647 {"sendfile", (PyCFunction)(void(*)(void))posix_sendfile, METH_VARARGS | METH_KEYWORDS,
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000013648 posix_sendfile__doc__},
13649#endif
Larry Hastings2f936352014-08-05 14:04:04 +100013650 OS_FSTAT_METHODDEF
13651 OS_ISATTY_METHODDEF
13652 OS_PIPE_METHODDEF
13653 OS_PIPE2_METHODDEF
13654 OS_MKFIFO_METHODDEF
13655 OS_MKNOD_METHODDEF
13656 OS_MAJOR_METHODDEF
13657 OS_MINOR_METHODDEF
13658 OS_MAKEDEV_METHODDEF
13659 OS_FTRUNCATE_METHODDEF
13660 OS_TRUNCATE_METHODDEF
13661 OS_POSIX_FALLOCATE_METHODDEF
13662 OS_POSIX_FADVISE_METHODDEF
13663 OS_PUTENV_METHODDEF
13664 OS_UNSETENV_METHODDEF
13665 OS_STRERROR_METHODDEF
13666 OS_FCHDIR_METHODDEF
13667 OS_FSYNC_METHODDEF
13668 OS_SYNC_METHODDEF
13669 OS_FDATASYNC_METHODDEF
13670 OS_WCOREDUMP_METHODDEF
13671 OS_WIFCONTINUED_METHODDEF
13672 OS_WIFSTOPPED_METHODDEF
13673 OS_WIFSIGNALED_METHODDEF
13674 OS_WIFEXITED_METHODDEF
13675 OS_WEXITSTATUS_METHODDEF
13676 OS_WTERMSIG_METHODDEF
13677 OS_WSTOPSIG_METHODDEF
13678 OS_FSTATVFS_METHODDEF
13679 OS_STATVFS_METHODDEF
13680 OS_CONFSTR_METHODDEF
13681 OS_SYSCONF_METHODDEF
13682 OS_FPATHCONF_METHODDEF
13683 OS_PATHCONF_METHODDEF
13684 OS_ABORT_METHODDEF
Serhiy Storchakaf0b50152015-05-13 00:52:39 +030013685 OS__GETFULLPATHNAME_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100013686 OS__GETDISKUSAGE_METHODDEF
13687 OS__GETFINALPATHNAME_METHODDEF
13688 OS__GETVOLUMEPATHNAME_METHODDEF
13689 OS_GETLOADAVG_METHODDEF
13690 OS_URANDOM_METHODDEF
13691 OS_SETRESUID_METHODDEF
13692 OS_SETRESGID_METHODDEF
13693 OS_GETRESUID_METHODDEF
13694 OS_GETRESGID_METHODDEF
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000013695
Larry Hastings2f936352014-08-05 14:04:04 +100013696 OS_GETXATTR_METHODDEF
13697 OS_SETXATTR_METHODDEF
13698 OS_REMOVEXATTR_METHODDEF
13699 OS_LISTXATTR_METHODDEF
13700
Antoine Pitroubcf2b592012-02-08 23:28:36 +010013701#if defined(TERMSIZE_USE_CONIO) || defined(TERMSIZE_USE_IOCTL)
13702 {"get_terminal_size", get_terminal_size, METH_VARARGS, termsize__doc__},
13703#endif
Larry Hastings2f936352014-08-05 14:04:04 +100013704 OS_CPU_COUNT_METHODDEF
13705 OS_GET_INHERITABLE_METHODDEF
13706 OS_SET_INHERITABLE_METHODDEF
13707 OS_GET_HANDLE_INHERITABLE_METHODDEF
13708 OS_SET_HANDLE_INHERITABLE_METHODDEF
Victor Stinner1db9e7b2014-07-29 22:32:47 +020013709#ifndef MS_WINDOWS
Serhiy Storchaka12a69db2018-09-17 15:38:27 +030013710 OS_GET_BLOCKING_METHODDEF
13711 OS_SET_BLOCKING_METHODDEF
Victor Stinner1db9e7b2014-07-29 22:32:47 +020013712#endif
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013713 OS_SCANDIR_METHODDEF
Ethan Furman410ef8e2016-06-04 12:06:26 -070013714 OS_FSPATH_METHODDEF
Victor Stinner9b1f4742016-09-06 16:18:52 -070013715 OS_GETRANDOM_METHODDEF
Zackery Spytz43fdbd22019-05-29 13:57:07 -060013716 OS_MEMFD_CREATE_METHODDEF
Steve Dower2438cdf2019-03-29 16:37:16 -070013717#ifdef MS_WINDOWS
13718 OS__ADD_DLL_DIRECTORY_METHODDEF
13719 OS__REMOVE_DLL_DIRECTORY_METHODDEF
13720#endif
Victor Stinner8c62be82010-05-06 00:08:46 +000013721 {NULL, NULL} /* Sentinel */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000013722};
13723
Barry Warsaw4a342091996-12-19 23:50:02 +000013724static int
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013725all_ins(PyObject *m)
Barry Warsaw4a342091996-12-19 23:50:02 +000013726{
Guido van Rossum94f6f721999-01-06 18:42:14 +000013727#ifdef F_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013728 if (PyModule_AddIntMacro(m, F_OK)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013729#endif
Guido van Rossum94f6f721999-01-06 18:42:14 +000013730#ifdef R_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013731 if (PyModule_AddIntMacro(m, R_OK)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013732#endif
Guido van Rossum94f6f721999-01-06 18:42:14 +000013733#ifdef W_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013734 if (PyModule_AddIntMacro(m, W_OK)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013735#endif
Guido van Rossum94f6f721999-01-06 18:42:14 +000013736#ifdef X_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013737 if (PyModule_AddIntMacro(m, X_OK)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013738#endif
Fred Drakec9680921999-12-13 16:37:25 +000013739#ifdef NGROUPS_MAX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013740 if (PyModule_AddIntMacro(m, NGROUPS_MAX)) return -1;
Fred Drakec9680921999-12-13 16:37:25 +000013741#endif
Fred Drake5ab8eaf1999-12-09 21:13:07 +000013742#ifdef TMP_MAX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013743 if (PyModule_AddIntMacro(m, TMP_MAX)) return -1;
Fred Drake5ab8eaf1999-12-09 21:13:07 +000013744#endif
Fred Drake106c1a02002-04-23 15:58:02 +000013745#ifdef WCONTINUED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013746 if (PyModule_AddIntMacro(m, WCONTINUED)) return -1;
Fred Drake106c1a02002-04-23 15:58:02 +000013747#endif
Barry Warsaw4a342091996-12-19 23:50:02 +000013748#ifdef WNOHANG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013749 if (PyModule_AddIntMacro(m, WNOHANG)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013750#endif
Fred Drake106c1a02002-04-23 15:58:02 +000013751#ifdef WUNTRACED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013752 if (PyModule_AddIntMacro(m, WUNTRACED)) return -1;
Fred Drake106c1a02002-04-23 15:58:02 +000013753#endif
Barry Warsaw4a342091996-12-19 23:50:02 +000013754#ifdef O_RDONLY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013755 if (PyModule_AddIntMacro(m, O_RDONLY)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013756#endif
13757#ifdef O_WRONLY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013758 if (PyModule_AddIntMacro(m, O_WRONLY)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013759#endif
13760#ifdef O_RDWR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013761 if (PyModule_AddIntMacro(m, O_RDWR)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013762#endif
13763#ifdef O_NDELAY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013764 if (PyModule_AddIntMacro(m, O_NDELAY)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013765#endif
13766#ifdef O_NONBLOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013767 if (PyModule_AddIntMacro(m, O_NONBLOCK)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013768#endif
13769#ifdef O_APPEND
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013770 if (PyModule_AddIntMacro(m, O_APPEND)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013771#endif
13772#ifdef O_DSYNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013773 if (PyModule_AddIntMacro(m, O_DSYNC)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013774#endif
13775#ifdef O_RSYNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013776 if (PyModule_AddIntMacro(m, O_RSYNC)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013777#endif
13778#ifdef O_SYNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013779 if (PyModule_AddIntMacro(m, O_SYNC)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013780#endif
13781#ifdef O_NOCTTY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013782 if (PyModule_AddIntMacro(m, O_NOCTTY)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013783#endif
13784#ifdef O_CREAT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013785 if (PyModule_AddIntMacro(m, O_CREAT)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013786#endif
13787#ifdef O_EXCL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013788 if (PyModule_AddIntMacro(m, O_EXCL)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013789#endif
13790#ifdef O_TRUNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013791 if (PyModule_AddIntMacro(m, O_TRUNC)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013792#endif
Guido van Rossum98d9d091997-08-08 21:48:51 +000013793#ifdef O_BINARY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013794 if (PyModule_AddIntMacro(m, O_BINARY)) return -1;
Guido van Rossum98d9d091997-08-08 21:48:51 +000013795#endif
13796#ifdef O_TEXT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013797 if (PyModule_AddIntMacro(m, O_TEXT)) return -1;
Guido van Rossum98d9d091997-08-08 21:48:51 +000013798#endif
Jesus Cea1d642d22012-04-24 20:59:17 +020013799#ifdef O_XATTR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013800 if (PyModule_AddIntMacro(m, O_XATTR)) return -1;
Jesus Cea1d642d22012-04-24 20:59:17 +020013801#endif
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000013802#ifdef O_LARGEFILE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013803 if (PyModule_AddIntMacro(m, O_LARGEFILE)) return -1;
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000013804#endif
doko@ubuntu.comfcff4372016-06-13 16:33:04 +020013805#ifndef __GNU__
Skip Montanaro5ff14922005-05-16 02:42:22 +000013806#ifdef O_SHLOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013807 if (PyModule_AddIntMacro(m, O_SHLOCK)) return -1;
Skip Montanaro5ff14922005-05-16 02:42:22 +000013808#endif
13809#ifdef O_EXLOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013810 if (PyModule_AddIntMacro(m, O_EXLOCK)) return -1;
Skip Montanaro5ff14922005-05-16 02:42:22 +000013811#endif
doko@ubuntu.comfcff4372016-06-13 16:33:04 +020013812#endif
Jesus Ceacf381202012-04-24 20:44:40 +020013813#ifdef O_EXEC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013814 if (PyModule_AddIntMacro(m, O_EXEC)) return -1;
Jesus Ceacf381202012-04-24 20:44:40 +020013815#endif
13816#ifdef O_SEARCH
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013817 if (PyModule_AddIntMacro(m, O_SEARCH)) return -1;
Jesus Ceacf381202012-04-24 20:44:40 +020013818#endif
Benjamin Peterson3b965a22013-03-13 10:27:41 -050013819#ifdef O_PATH
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013820 if (PyModule_AddIntMacro(m, O_PATH)) return -1;
Benjamin Peterson3b965a22013-03-13 10:27:41 -050013821#endif
Jesus Ceacf381202012-04-24 20:44:40 +020013822#ifdef O_TTY_INIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013823 if (PyModule_AddIntMacro(m, O_TTY_INIT)) return -1;
Jesus Ceacf381202012-04-24 20:44:40 +020013824#endif
Christian Heimes177b3f92013-08-16 14:35:09 +020013825#ifdef O_TMPFILE
13826 if (PyModule_AddIntMacro(m, O_TMPFILE)) return -1;
13827#endif
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000013828#ifdef PRIO_PROCESS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013829 if (PyModule_AddIntMacro(m, PRIO_PROCESS)) return -1;
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000013830#endif
13831#ifdef PRIO_PGRP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013832 if (PyModule_AddIntMacro(m, PRIO_PGRP)) return -1;
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000013833#endif
13834#ifdef PRIO_USER
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013835 if (PyModule_AddIntMacro(m, PRIO_USER)) return -1;
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000013836#endif
Charles-François Natali1e045b12011-05-22 20:42:32 +020013837#ifdef O_CLOEXEC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013838 if (PyModule_AddIntMacro(m, O_CLOEXEC)) return -1;
Charles-François Natali1e045b12011-05-22 20:42:32 +020013839#endif
Jesus Cea1d642d22012-04-24 20:59:17 +020013840#ifdef O_ACCMODE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013841 if (PyModule_AddIntMacro(m, O_ACCMODE)) return -1;
Jesus Cea1d642d22012-04-24 20:59:17 +020013842#endif
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000013843
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000013844
Jesus Cea94363612012-06-22 18:32:07 +020013845#ifdef SEEK_HOLE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013846 if (PyModule_AddIntMacro(m, SEEK_HOLE)) return -1;
Jesus Cea94363612012-06-22 18:32:07 +020013847#endif
13848#ifdef SEEK_DATA
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013849 if (PyModule_AddIntMacro(m, SEEK_DATA)) return -1;
Jesus Cea94363612012-06-22 18:32:07 +020013850#endif
13851
Tim Peters5aa91602002-01-30 05:46:57 +000013852/* MS Windows */
13853#ifdef O_NOINHERIT
Victor Stinner8c62be82010-05-06 00:08:46 +000013854 /* Don't inherit in child processes. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013855 if (PyModule_AddIntMacro(m, O_NOINHERIT)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013856#endif
13857#ifdef _O_SHORT_LIVED
Victor Stinner8c62be82010-05-06 00:08:46 +000013858 /* Optimize for short life (keep in memory). */
13859 /* MS forgot to define this one with a non-underscore form too. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013860 if (PyModule_AddIntConstant(m, "O_SHORT_LIVED", _O_SHORT_LIVED)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013861#endif
13862#ifdef O_TEMPORARY
Victor Stinner8c62be82010-05-06 00:08:46 +000013863 /* Automatically delete when last handle is closed. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013864 if (PyModule_AddIntMacro(m, O_TEMPORARY)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013865#endif
13866#ifdef O_RANDOM
Victor Stinner8c62be82010-05-06 00:08:46 +000013867 /* Optimize for random access. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013868 if (PyModule_AddIntMacro(m, O_RANDOM)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013869#endif
13870#ifdef O_SEQUENTIAL
Victor Stinner8c62be82010-05-06 00:08:46 +000013871 /* Optimize for sequential access. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013872 if (PyModule_AddIntMacro(m, O_SEQUENTIAL)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013873#endif
13874
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000013875/* GNU extensions. */
Alexandre Vassalottibee32532008-05-16 18:15:12 +000013876#ifdef O_ASYNC
Victor Stinner8c62be82010-05-06 00:08:46 +000013877 /* Send a SIGIO signal whenever input or output
13878 becomes available on file descriptor */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013879 if (PyModule_AddIntMacro(m, O_ASYNC)) return -1;
Alexandre Vassalottibee32532008-05-16 18:15:12 +000013880#endif
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000013881#ifdef O_DIRECT
Victor Stinner8c62be82010-05-06 00:08:46 +000013882 /* Direct disk access. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013883 if (PyModule_AddIntMacro(m, O_DIRECT)) return -1;
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000013884#endif
13885#ifdef O_DIRECTORY
Victor Stinner8c62be82010-05-06 00:08:46 +000013886 /* Must be a directory. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013887 if (PyModule_AddIntMacro(m, O_DIRECTORY)) return -1;
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000013888#endif
13889#ifdef O_NOFOLLOW
Victor Stinner8c62be82010-05-06 00:08:46 +000013890 /* Do not follow links. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013891 if (PyModule_AddIntMacro(m, O_NOFOLLOW)) return -1;
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000013892#endif
Jesus Cea1d642d22012-04-24 20:59:17 +020013893#ifdef O_NOLINKS
13894 /* Fails if link count of the named file is greater than 1 */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013895 if (PyModule_AddIntMacro(m, O_NOLINKS)) return -1;
Jesus Cea1d642d22012-04-24 20:59:17 +020013896#endif
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +000013897#ifdef O_NOATIME
Victor Stinner8c62be82010-05-06 00:08:46 +000013898 /* Do not update the access time. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013899 if (PyModule_AddIntMacro(m, O_NOATIME)) return -1;
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +000013900#endif
Guido van Rossumd48f2521997-12-05 22:19:34 +000013901
Victor Stinner8c62be82010-05-06 00:08:46 +000013902 /* These come from sysexits.h */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013903#ifdef EX_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013904 if (PyModule_AddIntMacro(m, EX_OK)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013905#endif /* EX_OK */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013906#ifdef EX_USAGE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013907 if (PyModule_AddIntMacro(m, EX_USAGE)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013908#endif /* EX_USAGE */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013909#ifdef EX_DATAERR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013910 if (PyModule_AddIntMacro(m, EX_DATAERR)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013911#endif /* EX_DATAERR */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013912#ifdef EX_NOINPUT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013913 if (PyModule_AddIntMacro(m, EX_NOINPUT)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013914#endif /* EX_NOINPUT */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013915#ifdef EX_NOUSER
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013916 if (PyModule_AddIntMacro(m, EX_NOUSER)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013917#endif /* EX_NOUSER */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013918#ifdef EX_NOHOST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013919 if (PyModule_AddIntMacro(m, EX_NOHOST)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013920#endif /* EX_NOHOST */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013921#ifdef EX_UNAVAILABLE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013922 if (PyModule_AddIntMacro(m, EX_UNAVAILABLE)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013923#endif /* EX_UNAVAILABLE */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013924#ifdef EX_SOFTWARE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013925 if (PyModule_AddIntMacro(m, EX_SOFTWARE)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013926#endif /* EX_SOFTWARE */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013927#ifdef EX_OSERR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013928 if (PyModule_AddIntMacro(m, EX_OSERR)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013929#endif /* EX_OSERR */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013930#ifdef EX_OSFILE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013931 if (PyModule_AddIntMacro(m, EX_OSFILE)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013932#endif /* EX_OSFILE */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013933#ifdef EX_CANTCREAT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013934 if (PyModule_AddIntMacro(m, EX_CANTCREAT)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013935#endif /* EX_CANTCREAT */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013936#ifdef EX_IOERR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013937 if (PyModule_AddIntMacro(m, EX_IOERR)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013938#endif /* EX_IOERR */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013939#ifdef EX_TEMPFAIL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013940 if (PyModule_AddIntMacro(m, EX_TEMPFAIL)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013941#endif /* EX_TEMPFAIL */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013942#ifdef EX_PROTOCOL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013943 if (PyModule_AddIntMacro(m, EX_PROTOCOL)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013944#endif /* EX_PROTOCOL */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013945#ifdef EX_NOPERM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013946 if (PyModule_AddIntMacro(m, EX_NOPERM)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013947#endif /* EX_NOPERM */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013948#ifdef EX_CONFIG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013949 if (PyModule_AddIntMacro(m, EX_CONFIG)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013950#endif /* EX_CONFIG */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013951#ifdef EX_NOTFOUND
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013952 if (PyModule_AddIntMacro(m, EX_NOTFOUND)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013953#endif /* EX_NOTFOUND */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013954
Amaury Forgeot d'Arc66d00ad2010-09-10 18:11:45 +000013955 /* statvfs */
Andrew M. Kuchling4ea04a32010-08-18 22:30:34 +000013956#ifdef ST_RDONLY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013957 if (PyModule_AddIntMacro(m, ST_RDONLY)) return -1;
Andrew M. Kuchling4ea04a32010-08-18 22:30:34 +000013958#endif /* ST_RDONLY */
13959#ifdef ST_NOSUID
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013960 if (PyModule_AddIntMacro(m, ST_NOSUID)) return -1;
Andrew M. Kuchling4ea04a32010-08-18 22:30:34 +000013961#endif /* ST_NOSUID */
13962
doko@ubuntu.comca616a22013-12-08 15:23:07 +010013963 /* GNU extensions */
13964#ifdef ST_NODEV
13965 if (PyModule_AddIntMacro(m, ST_NODEV)) return -1;
13966#endif /* ST_NODEV */
13967#ifdef ST_NOEXEC
13968 if (PyModule_AddIntMacro(m, ST_NOEXEC)) return -1;
13969#endif /* ST_NOEXEC */
13970#ifdef ST_SYNCHRONOUS
13971 if (PyModule_AddIntMacro(m, ST_SYNCHRONOUS)) return -1;
13972#endif /* ST_SYNCHRONOUS */
13973#ifdef ST_MANDLOCK
13974 if (PyModule_AddIntMacro(m, ST_MANDLOCK)) return -1;
13975#endif /* ST_MANDLOCK */
13976#ifdef ST_WRITE
13977 if (PyModule_AddIntMacro(m, ST_WRITE)) return -1;
13978#endif /* ST_WRITE */
13979#ifdef ST_APPEND
13980 if (PyModule_AddIntMacro(m, ST_APPEND)) return -1;
13981#endif /* ST_APPEND */
13982#ifdef ST_NOATIME
13983 if (PyModule_AddIntMacro(m, ST_NOATIME)) return -1;
13984#endif /* ST_NOATIME */
13985#ifdef ST_NODIRATIME
13986 if (PyModule_AddIntMacro(m, ST_NODIRATIME)) return -1;
13987#endif /* ST_NODIRATIME */
13988#ifdef ST_RELATIME
13989 if (PyModule_AddIntMacro(m, ST_RELATIME)) return -1;
13990#endif /* ST_RELATIME */
13991
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000013992 /* FreeBSD sendfile() constants */
13993#ifdef SF_NODISKIO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013994 if (PyModule_AddIntMacro(m, SF_NODISKIO)) return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000013995#endif
13996#ifdef SF_MNOWAIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013997 if (PyModule_AddIntMacro(m, SF_MNOWAIT)) return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000013998#endif
13999#ifdef SF_SYNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014000 if (PyModule_AddIntMacro(m, SF_SYNC)) return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000014001#endif
14002
Ross Lagerwall7807c352011-03-17 20:20:30 +020014003 /* constants for posix_fadvise */
14004#ifdef POSIX_FADV_NORMAL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014005 if (PyModule_AddIntMacro(m, POSIX_FADV_NORMAL)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014006#endif
14007#ifdef POSIX_FADV_SEQUENTIAL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014008 if (PyModule_AddIntMacro(m, POSIX_FADV_SEQUENTIAL)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014009#endif
14010#ifdef POSIX_FADV_RANDOM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014011 if (PyModule_AddIntMacro(m, POSIX_FADV_RANDOM)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014012#endif
14013#ifdef POSIX_FADV_NOREUSE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014014 if (PyModule_AddIntMacro(m, POSIX_FADV_NOREUSE)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014015#endif
14016#ifdef POSIX_FADV_WILLNEED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014017 if (PyModule_AddIntMacro(m, POSIX_FADV_WILLNEED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014018#endif
14019#ifdef POSIX_FADV_DONTNEED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014020 if (PyModule_AddIntMacro(m, POSIX_FADV_DONTNEED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014021#endif
14022
14023 /* constants for waitid */
14024#if defined(HAVE_SYS_WAIT_H) && defined(HAVE_WAITID)
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014025 if (PyModule_AddIntMacro(m, P_PID)) return -1;
14026 if (PyModule_AddIntMacro(m, P_PGID)) return -1;
14027 if (PyModule_AddIntMacro(m, P_ALL)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014028#endif
14029#ifdef WEXITED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014030 if (PyModule_AddIntMacro(m, WEXITED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014031#endif
14032#ifdef WNOWAIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014033 if (PyModule_AddIntMacro(m, WNOWAIT)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014034#endif
14035#ifdef WSTOPPED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014036 if (PyModule_AddIntMacro(m, WSTOPPED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014037#endif
14038#ifdef CLD_EXITED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014039 if (PyModule_AddIntMacro(m, CLD_EXITED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014040#endif
14041#ifdef CLD_DUMPED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014042 if (PyModule_AddIntMacro(m, CLD_DUMPED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014043#endif
14044#ifdef CLD_TRAPPED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014045 if (PyModule_AddIntMacro(m, CLD_TRAPPED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014046#endif
14047#ifdef CLD_CONTINUED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014048 if (PyModule_AddIntMacro(m, CLD_CONTINUED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014049#endif
14050
14051 /* constants for lockf */
14052#ifdef F_LOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014053 if (PyModule_AddIntMacro(m, F_LOCK)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014054#endif
14055#ifdef F_TLOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014056 if (PyModule_AddIntMacro(m, F_TLOCK)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014057#endif
14058#ifdef F_ULOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014059 if (PyModule_AddIntMacro(m, F_ULOCK)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014060#endif
14061#ifdef F_TEST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014062 if (PyModule_AddIntMacro(m, F_TEST)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020014063#endif
14064
Pablo Galindo4defba32018-01-27 16:16:37 +000014065#ifdef RWF_DSYNC
14066 if (PyModule_AddIntConstant(m, "RWF_DSYNC", RWF_DSYNC)) return -1;
14067#endif
14068#ifdef RWF_HIPRI
14069 if (PyModule_AddIntConstant(m, "RWF_HIPRI", RWF_HIPRI)) return -1;
14070#endif
14071#ifdef RWF_SYNC
14072 if (PyModule_AddIntConstant(m, "RWF_SYNC", RWF_SYNC)) return -1;
14073#endif
14074#ifdef RWF_NOWAIT
14075 if (PyModule_AddIntConstant(m, "RWF_NOWAIT", RWF_NOWAIT)) return -1;
14076#endif
14077
Pablo Galindo6c6ddf92018-01-29 01:56:10 +000014078/* constants for posix_spawn */
14079#ifdef HAVE_POSIX_SPAWN
14080 if (PyModule_AddIntConstant(m, "POSIX_SPAWN_OPEN", POSIX_SPAWN_OPEN)) return -1;
14081 if (PyModule_AddIntConstant(m, "POSIX_SPAWN_CLOSE", POSIX_SPAWN_CLOSE)) return -1;
14082 if (PyModule_AddIntConstant(m, "POSIX_SPAWN_DUP2", POSIX_SPAWN_DUP2)) return -1;
14083#endif
14084
pxinwrf2d7ac72019-05-21 18:46:37 +080014085#if defined(HAVE_SPAWNV) || defined (HAVE_RTPSPAWN)
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014086 if (PyModule_AddIntConstant(m, "P_WAIT", _P_WAIT)) return -1;
14087 if (PyModule_AddIntConstant(m, "P_NOWAIT", _P_NOWAIT)) return -1;
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014088 if (PyModule_AddIntConstant(m, "P_NOWAITO", _P_NOWAITO)) return -1;
pxinwrf2d7ac72019-05-21 18:46:37 +080014089#endif
14090#ifdef HAVE_SPAWNV
14091 if (PyModule_AddIntConstant(m, "P_OVERLAY", _OLD_P_OVERLAY)) return -1;
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014092 if (PyModule_AddIntConstant(m, "P_DETACH", _P_DETACH)) return -1;
Guido van Rossum246bc171999-02-01 23:54:31 +000014093#endif
14094
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014095#ifdef HAVE_SCHED_H
Benjamin Petersondbaa5592016-07-30 23:21:50 -070014096#ifdef SCHED_OTHER
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014097 if (PyModule_AddIntMacro(m, SCHED_OTHER)) return -1;
Benjamin Petersondbaa5592016-07-30 23:21:50 -070014098#endif
14099#ifdef SCHED_FIFO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014100 if (PyModule_AddIntMacro(m, SCHED_FIFO)) return -1;
Benjamin Petersondbaa5592016-07-30 23:21:50 -070014101#endif
14102#ifdef SCHED_RR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014103 if (PyModule_AddIntMacro(m, SCHED_RR)) return -1;
Benjamin Petersondbaa5592016-07-30 23:21:50 -070014104#endif
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014105#ifdef SCHED_SPORADIC
messi Liao0d322182017-06-13 22:30:43 +080014106 if (PyModule_AddIntMacro(m, SCHED_SPORADIC)) return -1;
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014107#endif
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014108#ifdef SCHED_BATCH
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014109 if (PyModule_AddIntMacro(m, SCHED_BATCH)) return -1;
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014110#endif
14111#ifdef SCHED_IDLE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014112 if (PyModule_AddIntMacro(m, SCHED_IDLE)) return -1;
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014113#endif
14114#ifdef SCHED_RESET_ON_FORK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014115 if (PyModule_AddIntMacro(m, SCHED_RESET_ON_FORK)) return -1;
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014116#endif
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020014117#ifdef SCHED_SYS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014118 if (PyModule_AddIntMacro(m, SCHED_SYS)) return -1;
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020014119#endif
14120#ifdef SCHED_IA
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014121 if (PyModule_AddIntMacro(m, SCHED_IA)) return -1;
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020014122#endif
14123#ifdef SCHED_FSS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014124 if (PyModule_AddIntMacro(m, SCHED_FSS)) return -1;
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020014125#endif
14126#ifdef SCHED_FX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014127 if (PyModule_AddIntConstant(m, "SCHED_FX", SCHED_FSS)) return -1;
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020014128#endif
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014129#endif
14130
Benjamin Peterson9428d532011-09-14 11:45:52 -040014131#ifdef USE_XATTRS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014132 if (PyModule_AddIntMacro(m, XATTR_CREATE)) return -1;
14133 if (PyModule_AddIntMacro(m, XATTR_REPLACE)) return -1;
14134 if (PyModule_AddIntMacro(m, XATTR_SIZE_MAX)) return -1;
Benjamin Peterson799bd802011-08-31 22:15:17 -040014135#endif
14136
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014137#if HAVE_DECL_RTLD_LAZY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014138 if (PyModule_AddIntMacro(m, RTLD_LAZY)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014139#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014140#if HAVE_DECL_RTLD_NOW
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014141 if (PyModule_AddIntMacro(m, RTLD_NOW)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014142#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014143#if HAVE_DECL_RTLD_GLOBAL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014144 if (PyModule_AddIntMacro(m, RTLD_GLOBAL)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014145#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014146#if HAVE_DECL_RTLD_LOCAL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014147 if (PyModule_AddIntMacro(m, RTLD_LOCAL)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014148#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014149#if HAVE_DECL_RTLD_NODELETE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014150 if (PyModule_AddIntMacro(m, RTLD_NODELETE)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014151#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014152#if HAVE_DECL_RTLD_NOLOAD
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014153 if (PyModule_AddIntMacro(m, RTLD_NOLOAD)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014154#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030014155#if HAVE_DECL_RTLD_DEEPBIND
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020014156 if (PyModule_AddIntMacro(m, RTLD_DEEPBIND)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020014157#endif
Michael Feltc5ae1692017-12-19 13:58:49 +010014158#if HAVE_DECL_RTLD_MEMBER
14159 if (PyModule_AddIntMacro(m, RTLD_MEMBER)) return -1;
14160#endif
Victor Stinner8b905bd2011-10-25 13:34:04 +020014161
Victor Stinner9b1f4742016-09-06 16:18:52 -070014162#ifdef HAVE_GETRANDOM_SYSCALL
14163 if (PyModule_AddIntMacro(m, GRND_RANDOM)) return -1;
14164 if (PyModule_AddIntMacro(m, GRND_NONBLOCK)) return -1;
14165#endif
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014166#ifdef HAVE_MEMFD_CREATE
14167 if (PyModule_AddIntMacro(m, MFD_CLOEXEC)) return -1;
14168 if (PyModule_AddIntMacro(m, MFD_ALLOW_SEALING)) return -1;
14169#ifdef MFD_HUGETLB
14170 if (PyModule_AddIntMacro(m, MFD_HUGETLB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014171#endif
14172#ifdef MFD_HUGE_SHIFT
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014173 if (PyModule_AddIntMacro(m, MFD_HUGE_SHIFT)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014174#endif
14175#ifdef MFD_HUGE_MASK
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014176 if (PyModule_AddIntMacro(m, MFD_HUGE_MASK)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014177#endif
14178#ifdef MFD_HUGE_64KB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014179 if (PyModule_AddIntMacro(m, MFD_HUGE_64KB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014180#endif
14181#ifdef MFD_HUGE_512KB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014182 if (PyModule_AddIntMacro(m, MFD_HUGE_512KB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014183#endif
14184#ifdef MFD_HUGE_1MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014185 if (PyModule_AddIntMacro(m, MFD_HUGE_1MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014186#endif
14187#ifdef MFD_HUGE_2MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014188 if (PyModule_AddIntMacro(m, MFD_HUGE_2MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014189#endif
14190#ifdef MFD_HUGE_8MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014191 if (PyModule_AddIntMacro(m, MFD_HUGE_8MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014192#endif
14193#ifdef MFD_HUGE_16MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014194 if (PyModule_AddIntMacro(m, MFD_HUGE_16MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014195#endif
14196#ifdef MFD_HUGE_32MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014197 if (PyModule_AddIntMacro(m, MFD_HUGE_32MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014198#endif
14199#ifdef MFD_HUGE_256MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014200 if (PyModule_AddIntMacro(m, MFD_HUGE_256MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014201#endif
14202#ifdef MFD_HUGE_512MB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014203 if (PyModule_AddIntMacro(m, MFD_HUGE_512MB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014204#endif
14205#ifdef MFD_HUGE_1GB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014206 if (PyModule_AddIntMacro(m, MFD_HUGE_1GB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014207#endif
14208#ifdef MFD_HUGE_2GB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014209 if (PyModule_AddIntMacro(m, MFD_HUGE_2GB)) return -1;
Zackery Spytze70bfa952019-05-29 14:43:50 -060014210#endif
14211#ifdef MFD_HUGE_16GB
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014212 if (PyModule_AddIntMacro(m, MFD_HUGE_16GB)) return -1;
14213#endif
14214#endif
Victor Stinner9b1f4742016-09-06 16:18:52 -070014215
Giampaolo Rodola4a172cc2018-06-12 23:04:50 +020014216#if defined(__APPLE__)
14217 if (PyModule_AddIntConstant(m, "_COPYFILE_DATA", COPYFILE_DATA)) return -1;
14218#endif
14219
Steve Dower2438cdf2019-03-29 16:37:16 -070014220#ifdef MS_WINDOWS
14221 if (PyModule_AddIntConstant(m, "_LOAD_LIBRARY_SEARCH_DEFAULT_DIRS", LOAD_LIBRARY_SEARCH_DEFAULT_DIRS)) return -1;
14222 if (PyModule_AddIntConstant(m, "_LOAD_LIBRARY_SEARCH_APPLICATION_DIR", LOAD_LIBRARY_SEARCH_APPLICATION_DIR)) return -1;
14223 if (PyModule_AddIntConstant(m, "_LOAD_LIBRARY_SEARCH_SYSTEM32", LOAD_LIBRARY_SEARCH_SYSTEM32)) return -1;
14224 if (PyModule_AddIntConstant(m, "_LOAD_LIBRARY_SEARCH_USER_DIRS", LOAD_LIBRARY_SEARCH_USER_DIRS)) return -1;
14225 if (PyModule_AddIntConstant(m, "_LOAD_LIBRARY_SEARCH_DLL_LOAD_DIR", LOAD_LIBRARY_SEARCH_DLL_LOAD_DIR)) return -1;
14226#endif
14227
Victor Stinner8c62be82010-05-06 00:08:46 +000014228 return 0;
Barry Warsaw4a342091996-12-19 23:50:02 +000014229}
14230
14231
Martin v. Löwis1a214512008-06-11 05:26:20 +000014232static struct PyModuleDef posixmodule = {
Victor Stinner8c62be82010-05-06 00:08:46 +000014233 PyModuleDef_HEAD_INIT,
14234 MODNAME,
14235 posix__doc__,
14236 -1,
14237 posix_methods,
14238 NULL,
14239 NULL,
14240 NULL,
14241 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +000014242};
14243
14244
Serhiy Storchaka2d06e842015-12-25 19:53:18 +020014245static const char * const have_functions[] = {
Larry Hastings9cf065c2012-06-22 16:30:09 -070014246
14247#ifdef HAVE_FACCESSAT
14248 "HAVE_FACCESSAT",
14249#endif
14250
14251#ifdef HAVE_FCHDIR
14252 "HAVE_FCHDIR",
14253#endif
14254
14255#ifdef HAVE_FCHMOD
14256 "HAVE_FCHMOD",
14257#endif
14258
14259#ifdef HAVE_FCHMODAT
14260 "HAVE_FCHMODAT",
14261#endif
14262
14263#ifdef HAVE_FCHOWN
14264 "HAVE_FCHOWN",
14265#endif
14266
Larry Hastings00964ed2013-08-12 13:49:30 -040014267#ifdef HAVE_FCHOWNAT
14268 "HAVE_FCHOWNAT",
14269#endif
14270
Larry Hastings9cf065c2012-06-22 16:30:09 -070014271#ifdef HAVE_FEXECVE
14272 "HAVE_FEXECVE",
14273#endif
14274
14275#ifdef HAVE_FDOPENDIR
14276 "HAVE_FDOPENDIR",
14277#endif
14278
Georg Brandl306336b2012-06-24 12:55:33 +020014279#ifdef HAVE_FPATHCONF
14280 "HAVE_FPATHCONF",
14281#endif
14282
Larry Hastings9cf065c2012-06-22 16:30:09 -070014283#ifdef HAVE_FSTATAT
14284 "HAVE_FSTATAT",
14285#endif
14286
14287#ifdef HAVE_FSTATVFS
14288 "HAVE_FSTATVFS",
14289#endif
14290
Steve Dowerfe0a41a2015-03-20 19:50:46 -070014291#if defined HAVE_FTRUNCATE || defined MS_WINDOWS
Georg Brandl306336b2012-06-24 12:55:33 +020014292 "HAVE_FTRUNCATE",
14293#endif
14294
Larry Hastings9cf065c2012-06-22 16:30:09 -070014295#ifdef HAVE_FUTIMENS
14296 "HAVE_FUTIMENS",
14297#endif
14298
14299#ifdef HAVE_FUTIMES
14300 "HAVE_FUTIMES",
14301#endif
14302
14303#ifdef HAVE_FUTIMESAT
14304 "HAVE_FUTIMESAT",
14305#endif
14306
14307#ifdef HAVE_LINKAT
14308 "HAVE_LINKAT",
14309#endif
14310
14311#ifdef HAVE_LCHFLAGS
14312 "HAVE_LCHFLAGS",
14313#endif
14314
14315#ifdef HAVE_LCHMOD
14316 "HAVE_LCHMOD",
14317#endif
14318
14319#ifdef HAVE_LCHOWN
14320 "HAVE_LCHOWN",
14321#endif
14322
14323#ifdef HAVE_LSTAT
14324 "HAVE_LSTAT",
14325#endif
14326
14327#ifdef HAVE_LUTIMES
14328 "HAVE_LUTIMES",
14329#endif
14330
Zackery Spytz43fdbd22019-05-29 13:57:07 -060014331#ifdef HAVE_MEMFD_CREATE
14332 "HAVE_MEMFD_CREATE",
14333#endif
14334
Larry Hastings9cf065c2012-06-22 16:30:09 -070014335#ifdef HAVE_MKDIRAT
14336 "HAVE_MKDIRAT",
14337#endif
14338
14339#ifdef HAVE_MKFIFOAT
14340 "HAVE_MKFIFOAT",
14341#endif
14342
14343#ifdef HAVE_MKNODAT
14344 "HAVE_MKNODAT",
14345#endif
14346
14347#ifdef HAVE_OPENAT
14348 "HAVE_OPENAT",
14349#endif
14350
14351#ifdef HAVE_READLINKAT
14352 "HAVE_READLINKAT",
14353#endif
14354
14355#ifdef HAVE_RENAMEAT
14356 "HAVE_RENAMEAT",
14357#endif
14358
14359#ifdef HAVE_SYMLINKAT
14360 "HAVE_SYMLINKAT",
14361#endif
14362
14363#ifdef HAVE_UNLINKAT
14364 "HAVE_UNLINKAT",
14365#endif
14366
14367#ifdef HAVE_UTIMENSAT
14368 "HAVE_UTIMENSAT",
14369#endif
14370
14371#ifdef MS_WINDOWS
14372 "MS_WINDOWS",
14373#endif
14374
14375 NULL
14376};
14377
14378
Mark Hammondfe51c6d2002-08-02 02:27:13 +000014379PyMODINIT_FUNC
Thomas Woutersf3f33dc2000-07-21 06:00:07 +000014380INITFUNC(void)
Guido van Rossumb6775db1994-08-01 11:34:53 +000014381{
Victor Stinner8c62be82010-05-06 00:08:46 +000014382 PyObject *m, *v;
Larry Hastings9cf065c2012-06-22 16:30:09 -070014383 PyObject *list;
Serhiy Storchaka2d06e842015-12-25 19:53:18 +020014384 const char * const *trace;
Tim Peters5aa91602002-01-30 05:46:57 +000014385
Victor Stinner8c62be82010-05-06 00:08:46 +000014386 m = PyModule_Create(&posixmodule);
14387 if (m == NULL)
14388 return NULL;
Tim Peters5aa91602002-01-30 05:46:57 +000014389
Victor Stinner8c62be82010-05-06 00:08:46 +000014390 /* Initialize environ dictionary */
14391 v = convertenviron();
14392 Py_XINCREF(v);
14393 if (v == NULL || PyModule_AddObject(m, "environ", v) != 0)
14394 return NULL;
14395 Py_DECREF(v);
Fred Drakec9680921999-12-13 16:37:25 +000014396
Victor Stinner8c62be82010-05-06 00:08:46 +000014397 if (all_ins(m))
14398 return NULL;
Barry Warsaw4a342091996-12-19 23:50:02 +000014399
Victor Stinner8c62be82010-05-06 00:08:46 +000014400 if (setup_confname_tables(m))
14401 return NULL;
Fred Drakebec628d1999-12-15 18:31:10 +000014402
Victor Stinner8c62be82010-05-06 00:08:46 +000014403 Py_INCREF(PyExc_OSError);
14404 PyModule_AddObject(m, "error", PyExc_OSError);
Fred Drake762e2061999-08-26 17:23:54 +000014405
Guido van Rossumb3d39562000-01-31 18:41:26 +000014406#ifdef HAVE_PUTENV
Victor Stinner8c62be82010-05-06 00:08:46 +000014407 if (posix_putenv_garbage == NULL)
14408 posix_putenv_garbage = PyDict_New();
Guido van Rossumb3d39562000-01-31 18:41:26 +000014409#endif
Guido van Rossum98bf58f2001-10-18 20:34:25 +000014410
Victor Stinner8c62be82010-05-06 00:08:46 +000014411 if (!initialized) {
Ross Lagerwall7807c352011-03-17 20:20:30 +020014412#if defined(HAVE_WAITID) && !defined(__APPLE__)
14413 waitid_result_desc.name = MODNAME ".waitid_result";
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014414 WaitidResultType = PyStructSequence_NewType(&waitid_result_desc);
14415 if (WaitidResultType == NULL) {
Victor Stinner1c8f0592013-07-22 22:24:54 +020014416 return NULL;
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014417 }
Ross Lagerwall7807c352011-03-17 20:20:30 +020014418#endif
14419
Christian Heimes25827622013-10-12 01:27:08 +020014420 stat_result_desc.name = "os.stat_result"; /* see issue #19209 */
Victor Stinner8c62be82010-05-06 00:08:46 +000014421 stat_result_desc.fields[7].name = PyStructSequence_UnnamedField;
14422 stat_result_desc.fields[8].name = PyStructSequence_UnnamedField;
14423 stat_result_desc.fields[9].name = PyStructSequence_UnnamedField;
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014424 StatResultType = PyStructSequence_NewType(&stat_result_desc);
14425 if (StatResultType == NULL) {
Victor Stinner1c8f0592013-07-22 22:24:54 +020014426 return NULL;
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014427 }
14428 structseq_new = StatResultType->tp_new;
14429 StatResultType->tp_new = statresult_new;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000014430
Christian Heimes25827622013-10-12 01:27:08 +020014431 statvfs_result_desc.name = "os.statvfs_result"; /* see issue #19209 */
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014432 StatVFSResultType = PyStructSequence_NewType(&statvfs_result_desc);
14433 if (StatVFSResultType == NULL) {
Victor Stinner1c8f0592013-07-22 22:24:54 +020014434 return NULL;
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014435 }
Martin v. Löwis05bfe1f2008-12-29 18:21:47 +000014436#ifdef NEED_TICKS_PER_SECOND
14437# if defined(HAVE_SYSCONF) && defined(_SC_CLK_TCK)
Victor Stinner8c62be82010-05-06 00:08:46 +000014438 ticks_per_second = sysconf(_SC_CLK_TCK);
Martin v. Löwis05bfe1f2008-12-29 18:21:47 +000014439# elif defined(HZ)
Victor Stinner8c62be82010-05-06 00:08:46 +000014440 ticks_per_second = HZ;
Martin v. Löwis05bfe1f2008-12-29 18:21:47 +000014441# else
Victor Stinner8c62be82010-05-06 00:08:46 +000014442 ticks_per_second = 60; /* magic fallback value; may be bogus */
Martin v. Löwis05bfe1f2008-12-29 18:21:47 +000014443# endif
14444#endif
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014445
William Orr81574b82018-10-01 22:19:56 -070014446#if defined(HAVE_SCHED_SETPARAM) || defined(HAVE_SCHED_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDULER) || defined(POSIX_SPAWN_SETSCHEDPARAM)
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014447 sched_param_desc.name = MODNAME ".sched_param";
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014448 SchedParamType = PyStructSequence_NewType(&sched_param_desc);
14449 if (SchedParamType == NULL) {
Victor Stinner1c8f0592013-07-22 22:24:54 +020014450 return NULL;
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014451 }
14452 SchedParamType->tp_new = os_sched_param;
Benjamin Peterson94b580d2011-08-02 17:30:04 -050014453#endif
Antoine Pitroubcf2b592012-02-08 23:28:36 +010014454
14455 /* initialize TerminalSize_info */
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014456 TerminalSizeType = PyStructSequence_NewType(&TerminalSize_desc);
14457 if (TerminalSizeType == NULL) {
Victor Stinner1c8f0592013-07-22 22:24:54 +020014458 return NULL;
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014459 }
Victor Stinner6036e442015-03-08 01:58:04 +010014460
14461 /* initialize scandir types */
14462 if (PyType_Ready(&ScandirIteratorType) < 0)
14463 return NULL;
14464 if (PyType_Ready(&DirEntryType) < 0)
14465 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +000014466 }
Ross Lagerwall7807c352011-03-17 20:20:30 +020014467#if defined(HAVE_WAITID) && !defined(__APPLE__)
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014468 Py_INCREF((PyObject*) WaitidResultType);
14469 PyModule_AddObject(m, "waitid_result", (PyObject*) WaitidResultType);
Ross Lagerwall7807c352011-03-17 20:20:30 +020014470#endif
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014471 Py_INCREF((PyObject*) StatResultType);
14472 PyModule_AddObject(m, "stat_result", (PyObject*) StatResultType);
14473 Py_INCREF((PyObject*) StatVFSResultType);
Victor Stinner8c62be82010-05-06 00:08:46 +000014474 PyModule_AddObject(m, "statvfs_result",
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014475 (PyObject*) StatVFSResultType);
Benjamin Petersone3298dd2011-08-02 18:40:46 -050014476
14477#if defined(HAVE_SCHED_SETPARAM) || defined(HAVE_SCHED_SETSCHEDULER)
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014478 Py_INCREF(SchedParamType);
14479 PyModule_AddObject(m, "sched_param", (PyObject *)SchedParamType);
Benjamin Petersone3298dd2011-08-02 18:40:46 -050014480#endif
Thomas Wouters477c8d52006-05-27 19:21:47 +000014481
Larry Hastings605a62d2012-06-24 04:33:36 -070014482 times_result_desc.name = MODNAME ".times_result";
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014483 TimesResultType = PyStructSequence_NewType(&times_result_desc);
14484 if (TimesResultType == NULL) {
Victor Stinner1c8f0592013-07-22 22:24:54 +020014485 return NULL;
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014486 }
14487 PyModule_AddObject(m, "times_result", (PyObject *)TimesResultType);
Larry Hastings605a62d2012-06-24 04:33:36 -070014488
14489 uname_result_desc.name = MODNAME ".uname_result";
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014490 UnameResultType = PyStructSequence_NewType(&uname_result_desc);
14491 if (UnameResultType == NULL) {
Victor Stinner1c8f0592013-07-22 22:24:54 +020014492 return NULL;
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014493 }
14494 PyModule_AddObject(m, "uname_result", (PyObject *)UnameResultType);
Larry Hastings605a62d2012-06-24 04:33:36 -070014495
Thomas Wouters477c8d52006-05-27 19:21:47 +000014496#ifdef __APPLE__
Victor Stinner8c62be82010-05-06 00:08:46 +000014497 /*
14498 * Step 2 of weak-linking support on Mac OS X.
14499 *
14500 * The code below removes functions that are not available on the
14501 * currently active platform.
14502 *
14503 * This block allow one to use a python binary that was build on
Larry Hastings9cf065c2012-06-22 16:30:09 -070014504 * OSX 10.4 on OSX 10.3, without losing access to new APIs on
Victor Stinner8c62be82010-05-06 00:08:46 +000014505 * OSX 10.4.
14506 */
Thomas Wouters477c8d52006-05-27 19:21:47 +000014507#ifdef HAVE_FSTATVFS
Victor Stinner8c62be82010-05-06 00:08:46 +000014508 if (fstatvfs == NULL) {
14509 if (PyObject_DelAttrString(m, "fstatvfs") == -1) {
14510 return NULL;
14511 }
14512 }
Thomas Wouters477c8d52006-05-27 19:21:47 +000014513#endif /* HAVE_FSTATVFS */
14514
14515#ifdef HAVE_STATVFS
Victor Stinner8c62be82010-05-06 00:08:46 +000014516 if (statvfs == NULL) {
14517 if (PyObject_DelAttrString(m, "statvfs") == -1) {
14518 return NULL;
14519 }
14520 }
Thomas Wouters477c8d52006-05-27 19:21:47 +000014521#endif /* HAVE_STATVFS */
14522
14523# ifdef HAVE_LCHOWN
Victor Stinner8c62be82010-05-06 00:08:46 +000014524 if (lchown == NULL) {
14525 if (PyObject_DelAttrString(m, "lchown") == -1) {
14526 return NULL;
14527 }
14528 }
Thomas Wouters477c8d52006-05-27 19:21:47 +000014529#endif /* HAVE_LCHOWN */
14530
14531
14532#endif /* __APPLE__ */
Antoine Pitroubcf2b592012-02-08 23:28:36 +010014533
Eddie Elizondo474eedf2018-11-13 04:09:31 -080014534 Py_INCREF(TerminalSizeType);
14535 PyModule_AddObject(m, "terminal_size", (PyObject*)TerminalSizeType);
Antoine Pitroubcf2b592012-02-08 23:28:36 +010014536
Larry Hastings6fe20b32012-04-19 15:07:49 -070014537 billion = PyLong_FromLong(1000000000);
14538 if (!billion)
14539 return NULL;
14540
Larry Hastings9cf065c2012-06-22 16:30:09 -070014541 /* suppress "function not used" warnings */
14542 {
14543 int ignored;
14544 fd_specified("", -1);
14545 follow_symlinks_specified("", 1);
14546 dir_fd_and_follow_symlinks_invalid("chmod", DEFAULT_DIR_FD, 1);
14547 dir_fd_converter(Py_None, &ignored);
14548 dir_fd_unavailable(Py_None, &ignored);
14549 }
14550
14551 /*
14552 * provide list of locally available functions
14553 * so os.py can populate support_* lists
14554 */
14555 list = PyList_New(0);
14556 if (!list)
14557 return NULL;
14558 for (trace = have_functions; *trace; trace++) {
14559 PyObject *unicode = PyUnicode_DecodeASCII(*trace, strlen(*trace), NULL);
14560 if (!unicode)
14561 return NULL;
14562 if (PyList_Append(list, unicode))
14563 return NULL;
14564 Py_DECREF(unicode);
14565 }
14566 PyModule_AddObject(m, "_have_functions", list);
Ned Deilyeb3be662016-08-15 14:40:38 -040014567
14568 Py_INCREF((PyObject *) &DirEntryType);
Brett Cannona32c4d02016-06-24 14:14:44 -070014569 PyModule_AddObject(m, "DirEntry", (PyObject *)&DirEntryType);
Larry Hastings9cf065c2012-06-22 16:30:09 -070014570
14571 initialized = 1;
14572
Victor Stinner8c62be82010-05-06 00:08:46 +000014573 return m;
Guido van Rossumb6775db1994-08-01 11:34:53 +000014574}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000014575
14576#ifdef __cplusplus
14577}
14578#endif