blob: 4a1c9f398a07b76d1661c8add8f1ad0178f4f12b [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"
Antoine Pitrou346cbd32017-05-27 17:50:54 +020028#include "pythread.h"
Victor Stinner6036e442015-03-08 01:58:04 +010029#include "structmember.h"
Serhiy Storchaka7cf55992013-02-10 21:56:49 +020030#ifndef MS_WINDOWS
31#include "posixmodule.h"
Tim Golden0321cf22014-05-05 19:46:17 +010032#else
33#include "winreparse.h"
Serhiy Storchaka7cf55992013-02-10 21:56:49 +020034#endif
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000035
Stefan Krahfb7c8ae2016-04-26 17:04:18 +020036/* On android API level 21, 'AT_EACCESS' is not declared although
37 * HAVE_FACCESSAT is defined. */
38#ifdef __ANDROID__
39#undef HAVE_FACCESSAT
40#endif
41
Gregory P. Smith ext:(%20%5BGoogle%20Inc.%5D)fa76eee2016-05-28 21:03:48 +000042#include <stdio.h> /* needed for ctermid() */
43
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000044#ifdef __cplusplus
45extern "C" {
46#endif
47
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000048PyDoc_STRVAR(posix__doc__,
Guido van Rossumec4f4ac1997-06-02 22:20:51 +000049"This module provides access to operating system functionality that is\n\
50standardized by the C Standard and the POSIX standard (a thinly\n\
51disguised Unix interface). Refer to the library manual and\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000052corresponding Unix manual entries for more information on calls.");
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000053
Martin v. Löwis0073f2e2002-11-21 23:52:35 +000054
Ross Lagerwall4d076da2011-03-18 06:56:53 +020055#ifdef HAVE_SYS_UIO_H
56#include <sys/uio.h>
57#endif
58
Christian Heimes75b96182017-09-05 15:53:09 +020059#ifdef HAVE_SYS_SYSMACROS_H
60/* GNU C Library: major(), minor(), makedev() */
61#include <sys/sysmacros.h>
62#endif
63
Thomas Wouters0e3f5912006-08-11 14:57:12 +000064#ifdef HAVE_SYS_TYPES_H
Guido van Rossumb6775db1994-08-01 11:34:53 +000065#include <sys/types.h>
Thomas Wouters0e3f5912006-08-11 14:57:12 +000066#endif /* HAVE_SYS_TYPES_H */
67
68#ifdef HAVE_SYS_STAT_H
Guido van Rossumb6775db1994-08-01 11:34:53 +000069#include <sys/stat.h>
Thomas Wouters0e3f5912006-08-11 14:57:12 +000070#endif /* HAVE_SYS_STAT_H */
Guido van Rossuma6535fd2001-10-18 19:44:10 +000071
Guido van Rossum36bc6801995-06-14 22:54:23 +000072#ifdef HAVE_SYS_WAIT_H
Victor Stinner8c62be82010-05-06 00:08:46 +000073#include <sys/wait.h> /* For WNOHANG */
Guido van Rossum36bc6801995-06-14 22:54:23 +000074#endif
Guido van Rossumb6775db1994-08-01 11:34:53 +000075
Thomas Wouters0e3f5912006-08-11 14:57:12 +000076#ifdef HAVE_SIGNAL_H
Guido van Rossuma376cc51996-12-05 23:43:35 +000077#include <signal.h>
Thomas Wouters0e3f5912006-08-11 14:57:12 +000078#endif
Guido van Rossuma376cc51996-12-05 23:43:35 +000079
Guido van Rossumb6775db1994-08-01 11:34:53 +000080#ifdef HAVE_FCNTL_H
81#include <fcntl.h>
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +000082#endif /* HAVE_FCNTL_H */
Guido van Rossumb6775db1994-08-01 11:34:53 +000083
Guido van Rossuma6535fd2001-10-18 19:44:10 +000084#ifdef HAVE_GRP_H
85#include <grp.h>
86#endif
87
Barry Warsaw5676bd12003-01-07 20:57:09 +000088#ifdef HAVE_SYSEXITS_H
89#include <sysexits.h>
90#endif /* HAVE_SYSEXITS_H */
91
Anthony Baxter8a560de2004-10-13 15:30:56 +000092#ifdef HAVE_SYS_LOADAVG_H
93#include <sys/loadavg.h>
94#endif
95
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000096#ifdef HAVE_SYS_SENDFILE_H
97#include <sys/sendfile.h>
98#endif
99
Benjamin Peterson94b580d2011-08-02 17:30:04 -0500100#ifdef HAVE_SCHED_H
101#include <sched.h>
102#endif
103
Benjamin Peterson2dbda072012-03-16 10:12:55 -0500104#if !defined(CPU_ALLOC) && defined(HAVE_SCHED_SETAFFINITY)
Benjamin Peterson7b51b8d2012-03-14 22:28:25 -0500105#undef HAVE_SCHED_SETAFFINITY
106#endif
107
doko@ubuntu.com4a173bc2014-04-17 19:47:16 +0200108#if defined(HAVE_SYS_XATTR_H) && defined(__GLIBC__) && !defined(__FreeBSD_kernel__) && !defined(__GNU__)
Benjamin Peterson9428d532011-09-14 11:45:52 -0400109#define USE_XATTRS
110#endif
111
112#ifdef USE_XATTRS
Benjamin Petersonb77fe172011-09-13 17:20:47 -0400113#include <sys/xattr.h>
Benjamin Peterson799bd802011-08-31 22:15:17 -0400114#endif
115
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +0000116#if defined(__FreeBSD__) || defined(__DragonFly__) || defined(__APPLE__)
117#ifdef HAVE_SYS_SOCKET_H
118#include <sys/socket.h>
119#endif
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +0000120#endif
121
Victor Stinner8b905bd2011-10-25 13:34:04 +0200122#ifdef HAVE_DLFCN_H
123#include <dlfcn.h>
124#endif
125
Charles-Francois Natali44feda32013-05-20 14:40:46 +0200126#ifdef __hpux
127#include <sys/mpctl.h>
128#endif
129
130#if defined(__DragonFly__) || \
131 defined(__OpenBSD__) || \
132 defined(__FreeBSD__) || \
133 defined(__NetBSD__) || \
134 defined(__APPLE__)
135#include <sys/sysctl.h>
136#endif
137
Victor Stinner9b1f4742016-09-06 16:18:52 -0700138#ifdef HAVE_LINUX_RANDOM_H
139# include <linux/random.h>
140#endif
141#ifdef HAVE_GETRANDOM_SYSCALL
142# include <sys/syscall.h>
143#endif
144
Antoine Pitroubcf2b592012-02-08 23:28:36 +0100145#if defined(MS_WINDOWS)
146# define TERMSIZE_USE_CONIO
147#elif defined(HAVE_SYS_IOCTL_H)
148# include <sys/ioctl.h>
149# if defined(HAVE_TERMIOS_H)
150# include <termios.h>
151# endif
152# if defined(TIOCGWINSZ)
153# define TERMSIZE_USE_IOCTL
154# endif
155#endif /* MS_WINDOWS */
156
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000157/* Various compilers have only certain posix functions */
Martin v. Löwis4f1cd8b2001-07-26 13:41:06 +0000158/* XXX Gosh I wish these were all moved into pyconfig.h */
Victor Stinner8c62be82010-05-06 00:08:46 +0000159#if defined(__WATCOMC__) && !defined(__QNX__) /* Watcom compiler */
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000160#define HAVE_OPENDIR 1
Victor Stinner8c62be82010-05-06 00:08:46 +0000161#define HAVE_SYSTEM 1
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000162#include <process.h>
163#else
Victor Stinner8c62be82010-05-06 00:08:46 +0000164#ifdef _MSC_VER /* Microsoft compiler */
Amaury Forgeot d'Arc4b6fdf32010-09-07 21:31:17 +0000165#define HAVE_GETPPID 1
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +0000166#define HAVE_GETLOGIN 1
Victor Stinner8c62be82010-05-06 00:08:46 +0000167#define HAVE_SPAWNV 1
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000168#define HAVE_EXECV 1
Steve Dowercc16be82016-09-08 10:35:16 -0700169#define HAVE_WSPAWNV 1
170#define HAVE_WEXECV 1
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000171#define HAVE_PIPE 1
Victor Stinner8c62be82010-05-06 00:08:46 +0000172#define HAVE_SYSTEM 1
173#define HAVE_CWAIT 1
174#define HAVE_FSYNC 1
Tim Peters11b23062003-04-23 02:39:17 +0000175#define fsync _commit
Andrew MacIntyre6c73af22002-03-03 03:07:07 +0000176#else
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000177/* Unix functions that the configure script doesn't check for */
178#define HAVE_EXECV 1
179#define HAVE_FORK 1
Victor Stinner8c62be82010-05-06 00:08:46 +0000180#if defined(__USLC__) && defined(__SCO_VERSION__) /* SCO UDK Compiler */
Guido van Rossum2242f2f2001-04-11 20:58:20 +0000181#define HAVE_FORK1 1
182#endif
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000183#define HAVE_GETEGID 1
184#define HAVE_GETEUID 1
185#define HAVE_GETGID 1
186#define HAVE_GETPPID 1
187#define HAVE_GETUID 1
188#define HAVE_KILL 1
189#define HAVE_OPENDIR 1
190#define HAVE_PIPE 1
Victor Stinner8c62be82010-05-06 00:08:46 +0000191#define HAVE_SYSTEM 1
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000192#define HAVE_WAIT 1
Victor Stinner8c62be82010-05-06 00:08:46 +0000193#define HAVE_TTYNAME 1
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000194#endif /* _MSC_VER */
Guido van Rossumc5a0f531997-12-02 20:36:02 +0000195#endif /* ! __WATCOMC__ || __QNX__ */
Guido van Rossumad0ee831995-03-01 10:34:45 +0000196
Victor Stinnera2f7c002012-02-08 03:36:25 +0100197
Larry Hastings61272b72014-01-07 12:41:53 -0800198/*[clinic input]
Larry Hastings2f936352014-08-05 14:04:04 +1000199# one of the few times we lie about this name!
Larry Hastings44e2eaa2013-11-23 15:37:55 -0800200module os
Larry Hastings61272b72014-01-07 12:41:53 -0800201[clinic start generated code]*/
Larry Hastings2f936352014-08-05 14:04:04 +1000202/*[clinic end generated code: output=da39a3ee5e6b4b0d input=94a0f0f978acae17]*/
Victor Stinnera2f7c002012-02-08 03:36:25 +0100203
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000204#ifndef _MSC_VER
Guido van Rossum36bc6801995-06-14 22:54:23 +0000205
Martin v. Löwis8eb92a02002-09-19 08:03:21 +0000206#if defined(__sgi)&&_COMPILER_VERSION>=700
207/* declare ctermid_r if compiling with MIPSPro 7.x in ANSI C mode
208 (default) */
209extern char *ctermid_r(char *);
210#endif
211
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000212#ifndef HAVE_UNISTD_H
Guido van Rossumc5a0f531997-12-02 20:36:02 +0000213#if ( defined(__WATCOMC__) || defined(_MSC_VER) ) && !defined(__QNX__)
Fredrik Lundhff7df9d2000-07-08 22:48:53 +0000214extern int mkdir(const char *);
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000215#else
Fredrik Lundhff7df9d2000-07-08 22:48:53 +0000216extern int mkdir(const char *, mode_t);
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000217#endif
Guido van Rossum8e9ebfd1997-11-22 21:53:48 +0000218#if defined(__IBMC__) || defined(__IBMCPP__)
Fredrik Lundhff7df9d2000-07-08 22:48:53 +0000219extern int chdir(char *);
220extern int rmdir(char *);
Guido van Rossum8e9ebfd1997-11-22 21:53:48 +0000221#else
Fredrik Lundhff7df9d2000-07-08 22:48:53 +0000222extern int chdir(const char *);
223extern int rmdir(const char *);
Guido van Rossum8e9ebfd1997-11-22 21:53:48 +0000224#endif
Fredrik Lundhff7df9d2000-07-08 22:48:53 +0000225extern int chmod(const char *, mode_t);
Christian Heimes4e30a842007-11-30 22:12:06 +0000226/*#ifdef HAVE_FCHMOD
227extern int fchmod(int, mode_t);
228#endif*/
229/*#ifdef HAVE_LCHMOD
230extern int lchmod(const char *, mode_t);
231#endif*/
Fredrik Lundhff7df9d2000-07-08 22:48:53 +0000232extern int chown(const char *, uid_t, gid_t);
233extern char *getcwd(char *, int);
234extern char *strerror(int);
235extern int link(const char *, const char *);
236extern int rename(const char *, const char *);
237extern int stat(const char *, struct stat *);
238extern int unlink(const char *);
Guido van Rossumb6775db1994-08-01 11:34:53 +0000239#ifdef HAVE_SYMLINK
Fredrik Lundhff7df9d2000-07-08 22:48:53 +0000240extern int symlink(const char *, const char *);
Guido van Rossuma38a5031995-02-17 15:11:36 +0000241#endif /* HAVE_SYMLINK */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000242#ifdef HAVE_LSTAT
Fredrik Lundhff7df9d2000-07-08 22:48:53 +0000243extern int lstat(const char *, struct stat *);
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +0000244#endif /* HAVE_LSTAT */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000245#endif /* !HAVE_UNISTD_H */
Guido van Rossum36bc6801995-06-14 22:54:23 +0000246
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000247#endif /* !_MSC_VER */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000248
Pablo Galindo6c6ddf92018-01-29 01:56:10 +0000249#ifdef HAVE_POSIX_SPAWN
250#include <spawn.h>
251#endif
252
Guido van Rossumb6775db1994-08-01 11:34:53 +0000253#ifdef HAVE_UTIME_H
254#include <utime.h>
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +0000255#endif /* HAVE_UTIME_H */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000256
Guido van Rossum14ed0b21994-09-29 09:50:09 +0000257#ifdef HAVE_SYS_UTIME_H
258#include <sys/utime.h>
259#define HAVE_UTIME_H /* pretend we do for the rest of this file */
260#endif /* HAVE_SYS_UTIME_H */
261
Guido van Rossumb6775db1994-08-01 11:34:53 +0000262#ifdef HAVE_SYS_TIMES_H
263#include <sys/times.h>
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +0000264#endif /* HAVE_SYS_TIMES_H */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000265
266#ifdef HAVE_SYS_PARAM_H
267#include <sys/param.h>
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +0000268#endif /* HAVE_SYS_PARAM_H */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000269
270#ifdef HAVE_SYS_UTSNAME_H
271#include <sys/utsname.h>
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +0000272#endif /* HAVE_SYS_UTSNAME_H */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000273
Guido van Rossum3bbc62e1995-01-02 19:30:30 +0000274#ifdef HAVE_DIRENT_H
Guido van Rossumb6775db1994-08-01 11:34:53 +0000275#include <dirent.h>
Guido van Rossum3bbc62e1995-01-02 19:30:30 +0000276#define NAMLEN(dirent) strlen((dirent)->d_name)
277#else
Guido van Rossumc5a0f531997-12-02 20:36:02 +0000278#if defined(__WATCOMC__) && !defined(__QNX__)
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000279#include <direct.h>
280#define NAMLEN(dirent) strlen((dirent)->d_name)
281#else
Guido van Rossumb6775db1994-08-01 11:34:53 +0000282#define dirent direct
Guido van Rossum3bbc62e1995-01-02 19:30:30 +0000283#define NAMLEN(dirent) (dirent)->d_namlen
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000284#endif
Guido van Rossum3bbc62e1995-01-02 19:30:30 +0000285#ifdef HAVE_SYS_NDIR_H
Guido van Rossumb6775db1994-08-01 11:34:53 +0000286#include <sys/ndir.h>
Guido van Rossum3bbc62e1995-01-02 19:30:30 +0000287#endif
288#ifdef HAVE_SYS_DIR_H
Guido van Rossumb6775db1994-08-01 11:34:53 +0000289#include <sys/dir.h>
Guido van Rossum3bbc62e1995-01-02 19:30:30 +0000290#endif
291#ifdef HAVE_NDIR_H
Guido van Rossumb6775db1994-08-01 11:34:53 +0000292#include <ndir.h>
Guido van Rossum3bbc62e1995-01-02 19:30:30 +0000293#endif
294#endif
Guido van Rossumb6775db1994-08-01 11:34:53 +0000295
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000296#ifdef _MSC_VER
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000297#ifdef HAVE_DIRECT_H
Guido van Rossumb6775db1994-08-01 11:34:53 +0000298#include <direct.h>
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000299#endif
300#ifdef HAVE_IO_H
Guido van Rossumb6775db1994-08-01 11:34:53 +0000301#include <io.h>
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000302#endif
303#ifdef HAVE_PROCESS_H
Guido van Rossumb6775db1994-08-01 11:34:53 +0000304#include <process.h>
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000305#endif
Raymond Hettinger0291c9f2010-08-01 21:10:35 +0000306#ifndef VOLUME_NAME_DOS
Amaury Forgeot d'Arc844807e2010-08-16 22:16:51 +0000307#define VOLUME_NAME_DOS 0x0
Raymond Hettinger0291c9f2010-08-01 21:10:35 +0000308#endif
309#ifndef VOLUME_NAME_NT
Amaury Forgeot d'Arc844807e2010-08-16 22:16:51 +0000310#define VOLUME_NAME_NT 0x2
Raymond Hettinger0291c9f2010-08-01 21:10:35 +0000311#endif
312#ifndef IO_REPARSE_TAG_SYMLINK
Amaury Forgeot d'Arc844807e2010-08-16 22:16:51 +0000313#define IO_REPARSE_TAG_SYMLINK (0xA000000CL)
Raymond Hettinger0291c9f2010-08-01 21:10:35 +0000314#endif
Tim Golden0321cf22014-05-05 19:46:17 +0100315#ifndef IO_REPARSE_TAG_MOUNT_POINT
316#define IO_REPARSE_TAG_MOUNT_POINT (0xA0000003L)
317#endif
Tim Petersbc2e10e2002-03-03 23:17:02 +0000318#include "osdefs.h"
Kristján Valur Jónssonf64e6512009-04-13 10:16:14 +0000319#include <malloc.h>
Guido van Rossumb6775db1994-08-01 11:34:53 +0000320#include <windows.h>
Victor Stinner8c62be82010-05-06 00:08:46 +0000321#include <shellapi.h> /* for ShellExecute() */
Brian Curtine8e4b3b2010-09-23 20:04:14 +0000322#include <lmcons.h> /* for UNLEN */
Brian Curtin52173d42010-12-02 18:29:18 +0000323#ifdef SE_CREATE_SYMBOLIC_LINK_NAME /* Available starting with Vista */
324#define HAVE_SYMLINK
Brian Curtin3b4499c2010-12-28 14:31:47 +0000325static int win32_can_symlink = 0;
Brian Curtin52173d42010-12-02 18:29:18 +0000326#endif
Guido van Rossuma4916fa1996-05-23 22:58:55 +0000327#endif /* _MSC_VER */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000328
Tim Petersbc2e10e2002-03-03 23:17:02 +0000329#ifndef MAXPATHLEN
Thomas Wouters477c8d52006-05-27 19:21:47 +0000330#if defined(PATH_MAX) && PATH_MAX > 1024
331#define MAXPATHLEN PATH_MAX
332#else
Tim Petersbc2e10e2002-03-03 23:17:02 +0000333#define MAXPATHLEN 1024
Thomas Wouters477c8d52006-05-27 19:21:47 +0000334#endif
Tim Petersbc2e10e2002-03-03 23:17:02 +0000335#endif /* MAXPATHLEN */
336
Guido van Rossum54ecc3d1999-01-27 17:53:11 +0000337#ifdef UNION_WAIT
338/* Emulate some macros on systems that have a union instead of macros */
339
340#ifndef WIFEXITED
341#define WIFEXITED(u_wait) (!(u_wait).w_termsig && !(u_wait).w_coredump)
342#endif
343
344#ifndef WEXITSTATUS
345#define WEXITSTATUS(u_wait) (WIFEXITED(u_wait)?((u_wait).w_retcode):-1)
346#endif
347
348#ifndef WTERMSIG
349#define WTERMSIG(u_wait) ((u_wait).w_termsig)
350#endif
351
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000352#define WAIT_TYPE union wait
353#define WAIT_STATUS_INT(s) (s.w_status)
354
355#else /* !UNION_WAIT */
356#define WAIT_TYPE int
357#define WAIT_STATUS_INT(s) (s)
Guido van Rossum54ecc3d1999-01-27 17:53:11 +0000358#endif /* UNION_WAIT */
359
Greg Wardb48bc172000-03-01 21:51:56 +0000360/* Don't use the "_r" form if we don't need it (also, won't have a
361 prototype for it, at least on Solaris -- maybe others as well?). */
Antoine Pitroua6a4dc82017-09-07 18:56:24 +0200362#if defined(HAVE_CTERMID_R)
Greg Wardb48bc172000-03-01 21:51:56 +0000363#define USE_CTERMID_R
364#endif
365
Fred Drake699f3522000-06-29 21:12:41 +0000366/* choose the appropriate stat and fstat functions and return structs */
Guido van Rossum64529cd2000-06-30 22:45:12 +0000367#undef STAT
Antoine Pitroue47e0932011-01-19 15:21:35 +0000368#undef FSTAT
369#undef STRUCT_STAT
Victor Stinner14b9b112013-06-25 00:37:25 +0200370#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +0000371# define STAT win32_stat
Larry Hastings9cf065c2012-06-22 16:30:09 -0700372# define LSTAT win32_lstat
Victor Stinnere134a7f2015-03-30 10:09:31 +0200373# define FSTAT _Py_fstat_noraise
Steve Dowerf2f373f2015-02-21 08:44:05 -0800374# define STRUCT_STAT struct _Py_stat_struct
Fred Drake699f3522000-06-29 21:12:41 +0000375#else
Victor Stinner8c62be82010-05-06 00:08:46 +0000376# define STAT stat
Larry Hastings9cf065c2012-06-22 16:30:09 -0700377# define LSTAT lstat
Victor Stinner8c62be82010-05-06 00:08:46 +0000378# define FSTAT fstat
379# define STRUCT_STAT struct stat
Fred Drake699f3522000-06-29 21:12:41 +0000380#endif
381
Tim Peters11b23062003-04-23 02:39:17 +0000382#if defined(MAJOR_IN_MKDEV)
Martin v. Löwisdbe3f762002-10-10 14:27:30 +0000383#include <sys/mkdev.h>
384#else
385#if defined(MAJOR_IN_SYSMACROS)
386#include <sys/sysmacros.h>
387#endif
Neal Norwitz3d949422002-04-20 13:46:43 +0000388#if defined(HAVE_MKNOD) && defined(HAVE_SYS_MKDEV_H)
389#include <sys/mkdev.h>
390#endif
Martin v. Löwisdbe3f762002-10-10 14:27:30 +0000391#endif
Fred Drake699f3522000-06-29 21:12:41 +0000392
Serhiy Storchaka06a13f82015-02-22 21:34:54 +0200393#ifdef MS_WINDOWS
Victor Stinner6036e442015-03-08 01:58:04 +0100394#define INITFUNC PyInit_nt
395#define MODNAME "nt"
396#else
397#define INITFUNC PyInit_posix
398#define MODNAME "posix"
399#endif
400
jcea6c51d512018-01-28 14:00:08 +0100401#if defined(__sun)
402/* Something to implement in autoconf, not present in autoconf 2.69 */
403#define HAVE_STRUCT_STAT_ST_FSTYPE 1
404#endif
Antoine Pitrou346cbd32017-05-27 17:50:54 +0200405
406#ifdef HAVE_FORK
407static void
408run_at_forkers(PyObject *lst, int reverse)
409{
410 Py_ssize_t i;
411 PyObject *cpy;
412
413 if (lst != NULL) {
414 assert(PyList_CheckExact(lst));
415
416 /* Use a list copy in case register_at_fork() is called from
417 * one of the callbacks.
418 */
419 cpy = PyList_GetSlice(lst, 0, PyList_GET_SIZE(lst));
420 if (cpy == NULL)
421 PyErr_WriteUnraisable(lst);
422 else {
423 if (reverse)
424 PyList_Reverse(cpy);
425 for (i = 0; i < PyList_GET_SIZE(cpy); i++) {
426 PyObject *func, *res;
427 func = PyList_GET_ITEM(cpy, i);
428 res = PyObject_CallObject(func, NULL);
429 if (res == NULL)
430 PyErr_WriteUnraisable(func);
431 else
432 Py_DECREF(res);
433 }
434 Py_DECREF(cpy);
435 }
436 }
437}
438
439void
440PyOS_BeforeFork(void)
441{
442 run_at_forkers(PyThreadState_Get()->interp->before_forkers, 1);
443
444 _PyImport_AcquireLock();
445}
446
447void
448PyOS_AfterFork_Parent(void)
449{
450 if (_PyImport_ReleaseLock() <= 0)
451 Py_FatalError("failed releasing import lock after fork");
452
453 run_at_forkers(PyThreadState_Get()->interp->after_forkers_parent, 0);
454}
455
456void
457PyOS_AfterFork_Child(void)
458{
Antoine Pitrou346cbd32017-05-27 17:50:54 +0200459 _PyGILState_Reinit();
460 PyEval_ReInitThreads();
461 _PyImport_ReInitLock();
Antoine Pitrou346cbd32017-05-27 17:50:54 +0200462 _PySignal_AfterFork();
463
464 run_at_forkers(PyThreadState_Get()->interp->after_forkers_child, 0);
465}
466
467static int
468register_at_forker(PyObject **lst, PyObject *func)
469{
Gregory P. Smith163468a2017-05-29 10:03:41 -0700470 if (func == NULL) /* nothing to register? do nothing. */
471 return 0;
Antoine Pitrou346cbd32017-05-27 17:50:54 +0200472 if (*lst == NULL) {
473 *lst = PyList_New(0);
474 if (*lst == NULL)
475 return -1;
476 }
477 return PyList_Append(*lst, func);
478}
479#endif
480
481/* Legacy wrapper */
482void
483PyOS_AfterFork(void)
484{
485#ifdef HAVE_FORK
486 PyOS_AfterFork_Child();
487#endif
488}
489
490
Victor Stinner6036e442015-03-08 01:58:04 +0100491#ifdef MS_WINDOWS
Serhiy Storchaka06a13f82015-02-22 21:34:54 +0200492/* defined in fileutils.c */
493PyAPI_FUNC(void) _Py_time_t_to_FILE_TIME(time_t, int, FILETIME *);
494PyAPI_FUNC(void) _Py_attribute_data_to_stat(BY_HANDLE_FILE_INFORMATION *,
495 ULONG, struct _Py_stat_struct *);
496#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -0700497
498#ifdef MS_WINDOWS
499static int
500win32_warn_bytes_api()
501{
502 return PyErr_WarnEx(PyExc_DeprecationWarning,
503 "The Windows bytes API has been deprecated, "
504 "use Unicode filenames instead",
505 1);
506}
507#endif
508
509
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200510#ifndef MS_WINDOWS
511PyObject *
512_PyLong_FromUid(uid_t uid)
513{
514 if (uid == (uid_t)-1)
515 return PyLong_FromLong(-1);
516 return PyLong_FromUnsignedLong(uid);
517}
518
519PyObject *
520_PyLong_FromGid(gid_t gid)
521{
522 if (gid == (gid_t)-1)
523 return PyLong_FromLong(-1);
524 return PyLong_FromUnsignedLong(gid);
525}
526
527int
528_Py_Uid_Converter(PyObject *obj, void *p)
529{
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700530 uid_t uid;
531 PyObject *index;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200532 int overflow;
Serhiy Storchakab4621892013-02-10 23:28:02 +0200533 long result;
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700534 unsigned long uresult;
535
536 index = PyNumber_Index(obj);
537 if (index == NULL) {
538 PyErr_Format(PyExc_TypeError,
539 "uid should be integer, not %.200s",
540 Py_TYPE(obj)->tp_name);
Serhiy Storchakab4621892013-02-10 23:28:02 +0200541 return 0;
542 }
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700543
544 /*
545 * Handling uid_t is complicated for two reasons:
546 * * Although uid_t is (always?) unsigned, it still
547 * accepts -1.
548 * * We don't know its size in advance--it may be
549 * bigger than an int, or it may be smaller than
550 * a long.
551 *
552 * So a bit of defensive programming is in order.
553 * Start with interpreting the value passed
554 * in as a signed long and see if it works.
555 */
556
557 result = PyLong_AsLongAndOverflow(index, &overflow);
558
559 if (!overflow) {
560 uid = (uid_t)result;
561
562 if (result == -1) {
563 if (PyErr_Occurred())
564 goto fail;
565 /* It's a legitimate -1, we're done. */
566 goto success;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200567 }
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700568
569 /* Any other negative number is disallowed. */
570 if (result < 0)
571 goto underflow;
572
573 /* Ensure the value wasn't truncated. */
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200574 if (sizeof(uid_t) < sizeof(long) &&
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700575 (long)uid != result)
576 goto underflow;
577 goto success;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200578 }
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700579
580 if (overflow < 0)
581 goto underflow;
582
583 /*
584 * Okay, the value overflowed a signed long. If it
585 * fits in an *unsigned* long, it may still be okay,
586 * as uid_t may be unsigned long on this platform.
587 */
588 uresult = PyLong_AsUnsignedLong(index);
589 if (PyErr_Occurred()) {
590 if (PyErr_ExceptionMatches(PyExc_OverflowError))
591 goto overflow;
592 goto fail;
593 }
594
595 uid = (uid_t)uresult;
596
597 /*
598 * If uid == (uid_t)-1, the user actually passed in ULONG_MAX,
599 * but this value would get interpreted as (uid_t)-1 by chown
600 * and its siblings. That's not what the user meant! So we
601 * throw an overflow exception instead. (We already
Tim Golden23005082013-10-25 11:22:37 +0100602 * handled a real -1 with PyLong_AsLongAndOverflow() above.)
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700603 */
604 if (uid == (uid_t)-1)
605 goto overflow;
606
607 /* Ensure the value wasn't truncated. */
608 if (sizeof(uid_t) < sizeof(long) &&
609 (unsigned long)uid != uresult)
610 goto overflow;
611 /* fallthrough */
612
613success:
614 Py_DECREF(index);
615 *(uid_t *)p = uid;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200616 return 1;
617
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700618underflow:
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200619 PyErr_SetString(PyExc_OverflowError,
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700620 "uid is less than minimum");
621 goto fail;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200622
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700623overflow:
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200624 PyErr_SetString(PyExc_OverflowError,
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700625 "uid is greater than maximum");
626 /* fallthrough */
627
628fail:
629 Py_DECREF(index);
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200630 return 0;
631}
632
633int
634_Py_Gid_Converter(PyObject *obj, void *p)
635{
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700636 gid_t gid;
637 PyObject *index;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200638 int overflow;
Serhiy Storchakab4621892013-02-10 23:28:02 +0200639 long result;
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700640 unsigned long uresult;
641
642 index = PyNumber_Index(obj);
643 if (index == NULL) {
644 PyErr_Format(PyExc_TypeError,
645 "gid should be integer, not %.200s",
646 Py_TYPE(obj)->tp_name);
Serhiy Storchakab4621892013-02-10 23:28:02 +0200647 return 0;
648 }
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700649
650 /*
651 * Handling gid_t is complicated for two reasons:
652 * * Although gid_t is (always?) unsigned, it still
653 * accepts -1.
654 * * We don't know its size in advance--it may be
655 * bigger than an int, or it may be smaller than
656 * a long.
657 *
658 * So a bit of defensive programming is in order.
659 * Start with interpreting the value passed
660 * in as a signed long and see if it works.
661 */
662
663 result = PyLong_AsLongAndOverflow(index, &overflow);
664
665 if (!overflow) {
666 gid = (gid_t)result;
667
668 if (result == -1) {
669 if (PyErr_Occurred())
670 goto fail;
671 /* It's a legitimate -1, we're done. */
672 goto success;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200673 }
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700674
675 /* Any other negative number is disallowed. */
676 if (result < 0) {
677 goto underflow;
678 }
679
680 /* Ensure the value wasn't truncated. */
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200681 if (sizeof(gid_t) < sizeof(long) &&
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700682 (long)gid != result)
683 goto underflow;
684 goto success;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200685 }
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700686
687 if (overflow < 0)
688 goto underflow;
689
690 /*
691 * Okay, the value overflowed a signed long. If it
692 * fits in an *unsigned* long, it may still be okay,
693 * as gid_t may be unsigned long on this platform.
694 */
695 uresult = PyLong_AsUnsignedLong(index);
696 if (PyErr_Occurred()) {
697 if (PyErr_ExceptionMatches(PyExc_OverflowError))
698 goto overflow;
699 goto fail;
700 }
701
702 gid = (gid_t)uresult;
703
704 /*
705 * If gid == (gid_t)-1, the user actually passed in ULONG_MAX,
706 * but this value would get interpreted as (gid_t)-1 by chown
707 * and its siblings. That's not what the user meant! So we
708 * throw an overflow exception instead. (We already
Tim Golden23005082013-10-25 11:22:37 +0100709 * handled a real -1 with PyLong_AsLongAndOverflow() above.)
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700710 */
711 if (gid == (gid_t)-1)
712 goto overflow;
713
714 /* Ensure the value wasn't truncated. */
715 if (sizeof(gid_t) < sizeof(long) &&
716 (unsigned long)gid != uresult)
717 goto overflow;
718 /* fallthrough */
719
720success:
721 Py_DECREF(index);
722 *(gid_t *)p = gid;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200723 return 1;
724
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700725underflow:
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200726 PyErr_SetString(PyExc_OverflowError,
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700727 "gid is less than minimum");
728 goto fail;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200729
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700730overflow:
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200731 PyErr_SetString(PyExc_OverflowError,
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700732 "gid is greater than maximum");
733 /* fallthrough */
734
735fail:
736 Py_DECREF(index);
Serhiy Storchaka7cf55992013-02-10 21:56:49 +0200737 return 0;
738}
739#endif /* MS_WINDOWS */
740
741
Benjamin Petersoned4aa832016-09-05 17:44:18 -0700742#define _PyLong_FromDev PyLong_FromLongLong
Gregory P. Smith702dada2015-01-28 16:07:52 -0800743
744
Serhiy Storchakab2653b32015-01-18 11:12:11 +0200745#if defined(HAVE_MKNOD) && defined(HAVE_MAKEDEV)
746static int
747_Py_Dev_Converter(PyObject *obj, void *p)
748{
Serhiy Storchakab2653b32015-01-18 11:12:11 +0200749 *((dev_t *)p) = PyLong_AsUnsignedLongLong(obj);
Serhiy Storchakab2653b32015-01-18 11:12:11 +0200750 if (PyErr_Occurred())
751 return 0;
752 return 1;
753}
Gregory P. Smith702dada2015-01-28 16:07:52 -0800754#endif /* HAVE_MKNOD && HAVE_MAKEDEV */
Serhiy Storchakab2653b32015-01-18 11:12:11 +0200755
756
Larry Hastings9cf065c2012-06-22 16:30:09 -0700757#ifdef AT_FDCWD
Trent Nelson9a461052012-09-18 21:50:06 -0400758/*
759 * Why the (int) cast? Solaris 10 defines AT_FDCWD as 0xffd19553 (-3041965);
760 * without the int cast, the value gets interpreted as uint (4291925331),
761 * which doesn't play nicely with all the initializer lines in this file that
762 * look like this:
763 * int dir_fd = DEFAULT_DIR_FD;
764 */
765#define DEFAULT_DIR_FD (int)AT_FDCWD
Larry Hastings9cf065c2012-06-22 16:30:09 -0700766#else
767#define DEFAULT_DIR_FD (-100)
768#endif
769
770static int
Serhiy Storchaka819399b2016-04-06 22:17:52 +0300771_fd_converter(PyObject *o, int *p)
Serhiy Storchakaa2ad5c32013-01-07 23:13:46 +0200772{
773 int overflow;
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700774 long long_value;
775
776 PyObject *index = PyNumber_Index(o);
777 if (index == NULL) {
Larry Hastings9cf065c2012-06-22 16:30:09 -0700778 return 0;
779 }
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700780
Serhiy Storchaka819399b2016-04-06 22:17:52 +0300781 assert(PyLong_Check(index));
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700782 long_value = PyLong_AsLongAndOverflow(index, &overflow);
783 Py_DECREF(index);
Serhiy Storchaka819399b2016-04-06 22:17:52 +0300784 assert(!PyErr_Occurred());
Serhiy Storchakaa2ad5c32013-01-07 23:13:46 +0200785 if (overflow > 0 || long_value > INT_MAX) {
Larry Hastings9cf065c2012-06-22 16:30:09 -0700786 PyErr_SetString(PyExc_OverflowError,
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700787 "fd is greater than maximum");
Larry Hastings9cf065c2012-06-22 16:30:09 -0700788 return 0;
789 }
Serhiy Storchakaa2ad5c32013-01-07 23:13:46 +0200790 if (overflow < 0 || long_value < INT_MIN) {
Larry Hastings9cf065c2012-06-22 16:30:09 -0700791 PyErr_SetString(PyExc_OverflowError,
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700792 "fd is less than minimum");
Larry Hastings9cf065c2012-06-22 16:30:09 -0700793 return 0;
794 }
Larry Hastingsa27b83a2013-08-08 00:19:50 -0700795
Larry Hastings9cf065c2012-06-22 16:30:09 -0700796 *p = (int)long_value;
797 return 1;
798}
799
800static int
Serhiy Storchakaa2ad5c32013-01-07 23:13:46 +0200801dir_fd_converter(PyObject *o, void *p)
802{
803 if (o == Py_None) {
804 *(int *)p = DEFAULT_DIR_FD;
805 return 1;
806 }
Serhiy Storchaka819399b2016-04-06 22:17:52 +0300807 else if (PyIndex_Check(o)) {
808 return _fd_converter(o, (int *)p);
809 }
810 else {
811 PyErr_Format(PyExc_TypeError,
812 "argument should be integer or None, not %.200s",
813 Py_TYPE(o)->tp_name);
814 return 0;
815 }
Larry Hastings9cf065c2012-06-22 16:30:09 -0700816}
817
818
Larry Hastings9cf065c2012-06-22 16:30:09 -0700819/*
820 * A PyArg_ParseTuple "converter" function
821 * that handles filesystem paths in the manner
822 * preferred by the os module.
823 *
824 * path_converter accepts (Unicode) strings and their
825 * subclasses, and bytes and their subclasses. What
826 * it does with the argument depends on the platform:
827 *
828 * * On Windows, if we get a (Unicode) string we
829 * extract the wchar_t * and return it; if we get
Steve Dowercc16be82016-09-08 10:35:16 -0700830 * bytes we decode to wchar_t * and return that.
Larry Hastings9cf065c2012-06-22 16:30:09 -0700831 *
832 * * On all other platforms, strings are encoded
833 * to bytes using PyUnicode_FSConverter, then we
834 * extract the char * from the bytes object and
835 * return that.
836 *
837 * path_converter also optionally accepts signed
838 * integers (representing open file descriptors) instead
839 * of path strings.
840 *
841 * Input fields:
842 * path.nullable
843 * If nonzero, the path is permitted to be None.
844 * path.allow_fd
845 * If nonzero, the path is permitted to be a file handle
846 * (a signed int) instead of a string.
847 * path.function_name
848 * If non-NULL, path_converter will use that as the name
849 * of the function in error messages.
Larry Hastings31826802013-10-19 00:09:25 -0700850 * (If path.function_name is NULL it omits the function name.)
Larry Hastings9cf065c2012-06-22 16:30:09 -0700851 * path.argument_name
852 * If non-NULL, path_converter will use that as the name
853 * of the parameter in error messages.
854 * (If path.argument_name is NULL it uses "path".)
855 *
856 * Output fields:
857 * path.wide
858 * Points to the path if it was expressed as Unicode
859 * and was not encoded. (Only used on Windows.)
860 * path.narrow
861 * Points to the path if it was expressed as bytes,
Steve Dowercc16be82016-09-08 10:35:16 -0700862 * or it was Unicode and was encoded to bytes. (On Windows,
Martin Panterb1321fb2016-10-10 00:38:21 +0000863 * is a non-zero integer if the path was expressed as bytes.
Steve Dowercc16be82016-09-08 10:35:16 -0700864 * The type is deliberately incompatible to prevent misuse.)
Larry Hastings9cf065c2012-06-22 16:30:09 -0700865 * path.fd
866 * Contains a file descriptor if path.accept_fd was true
867 * and the caller provided a signed integer instead of any
868 * sort of string.
869 *
870 * WARNING: if your "path" parameter is optional, and is
871 * unspecified, path_converter will never get called.
872 * So if you set allow_fd, you *MUST* initialize path.fd = -1
873 * yourself!
874 * path.length
875 * The length of the path in characters, if specified as
876 * a string.
877 * path.object
Xiang Zhang04316c42017-01-08 23:26:57 +0800878 * The original object passed in (if get a PathLike object,
879 * the result of PyOS_FSPath() is treated as the original object).
880 * Own a reference to the object.
Larry Hastings9cf065c2012-06-22 16:30:09 -0700881 * path.cleanup
882 * For internal use only. May point to a temporary object.
883 * (Pay no attention to the man behind the curtain.)
884 *
885 * At most one of path.wide or path.narrow will be non-NULL.
886 * If path was None and path.nullable was set,
887 * or if path was an integer and path.allow_fd was set,
888 * both path.wide and path.narrow will be NULL
889 * and path.length will be 0.
Georg Brandlf7875592012-06-24 13:58:31 +0200890 *
Larry Hastings9cf065c2012-06-22 16:30:09 -0700891 * path_converter takes care to not write to the path_t
892 * unless it's successful. However it must reset the
893 * "cleanup" field each time it's called.
894 *
895 * Use as follows:
896 * path_t path;
897 * memset(&path, 0, sizeof(path));
898 * PyArg_ParseTuple(args, "O&", path_converter, &path);
899 * // ... use values from path ...
900 * path_cleanup(&path);
901 *
902 * (Note that if PyArg_Parse fails you don't need to call
903 * path_cleanup(). However it is safe to do so.)
904 */
905typedef struct {
Victor Stinner292c8352012-10-30 02:17:38 +0100906 const char *function_name;
907 const char *argument_name;
Larry Hastings9cf065c2012-06-22 16:30:09 -0700908 int nullable;
909 int allow_fd;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +0300910 const wchar_t *wide;
Steve Dowercc16be82016-09-08 10:35:16 -0700911#ifdef MS_WINDOWS
912 BOOL narrow;
913#else
Serhiy Storchakadeab18d2016-05-07 16:45:18 +0300914 const char *narrow;
Steve Dowercc16be82016-09-08 10:35:16 -0700915#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -0700916 int fd;
917 Py_ssize_t length;
918 PyObject *object;
919 PyObject *cleanup;
920} path_t;
921
Steve Dowercc16be82016-09-08 10:35:16 -0700922#ifdef MS_WINDOWS
923#define PATH_T_INITIALIZE(function_name, argument_name, nullable, allow_fd) \
924 {function_name, argument_name, nullable, allow_fd, NULL, FALSE, -1, 0, NULL, NULL}
925#else
Larry Hastings2f936352014-08-05 14:04:04 +1000926#define PATH_T_INITIALIZE(function_name, argument_name, nullable, allow_fd) \
927 {function_name, argument_name, nullable, allow_fd, NULL, NULL, -1, 0, NULL, NULL}
Steve Dowercc16be82016-09-08 10:35:16 -0700928#endif
Larry Hastings31826802013-10-19 00:09:25 -0700929
Larry Hastings9cf065c2012-06-22 16:30:09 -0700930static void
Xiang Zhang04316c42017-01-08 23:26:57 +0800931path_cleanup(path_t *path)
932{
933 Py_CLEAR(path->object);
934 Py_CLEAR(path->cleanup);
Larry Hastings9cf065c2012-06-22 16:30:09 -0700935}
936
937static int
Serhiy Storchaka819399b2016-04-06 22:17:52 +0300938path_converter(PyObject *o, void *p)
939{
Larry Hastings9cf065c2012-06-22 16:30:09 -0700940 path_t *path = (path_t *)p;
Xiang Zhang04316c42017-01-08 23:26:57 +0800941 PyObject *bytes = NULL;
942 Py_ssize_t length = 0;
Brett Cannon3f9183b2016-08-26 14:44:48 -0700943 int is_index, is_buffer, is_bytes, is_unicode;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +0300944 const char *narrow;
Steve Dowercc16be82016-09-08 10:35:16 -0700945#ifdef MS_WINDOWS
Xiang Zhang04316c42017-01-08 23:26:57 +0800946 PyObject *wo = NULL;
Steve Dowercc16be82016-09-08 10:35:16 -0700947 const wchar_t *wide;
948#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -0700949
950#define FORMAT_EXCEPTION(exc, fmt) \
951 PyErr_Format(exc, "%s%s" fmt, \
952 path->function_name ? path->function_name : "", \
953 path->function_name ? ": " : "", \
954 path->argument_name ? path->argument_name : "path")
955
956 /* Py_CLEANUP_SUPPORTED support */
957 if (o == NULL) {
958 path_cleanup(path);
959 return 1;
960 }
961
Brett Cannon3f9183b2016-08-26 14:44:48 -0700962 /* Ensure it's always safe to call path_cleanup(). */
Xiang Zhang04316c42017-01-08 23:26:57 +0800963 path->object = path->cleanup = NULL;
964 /* path->object owns a reference to the original object */
965 Py_INCREF(o);
Larry Hastings9cf065c2012-06-22 16:30:09 -0700966
Serhiy Storchaka819399b2016-04-06 22:17:52 +0300967 if ((o == Py_None) && path->nullable) {
Larry Hastings9cf065c2012-06-22 16:30:09 -0700968 path->wide = NULL;
Steve Dowercc16be82016-09-08 10:35:16 -0700969#ifdef MS_WINDOWS
970 path->narrow = FALSE;
971#else
Larry Hastings9cf065c2012-06-22 16:30:09 -0700972 path->narrow = NULL;
Steve Dowercc16be82016-09-08 10:35:16 -0700973#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -0700974 path->fd = -1;
Xiang Zhang04316c42017-01-08 23:26:57 +0800975 goto success_exit;
Larry Hastings9cf065c2012-06-22 16:30:09 -0700976 }
977
Brett Cannon3f9183b2016-08-26 14:44:48 -0700978 /* Only call this here so that we don't treat the return value of
979 os.fspath() as an fd or buffer. */
980 is_index = path->allow_fd && PyIndex_Check(o);
981 is_buffer = PyObject_CheckBuffer(o);
982 is_bytes = PyBytes_Check(o);
983 is_unicode = PyUnicode_Check(o);
984
985 if (!is_index && !is_buffer && !is_unicode && !is_bytes) {
986 /* Inline PyOS_FSPath() for better error messages. */
987 _Py_IDENTIFIER(__fspath__);
988 PyObject *func = NULL;
989
990 func = _PyObject_LookupSpecial(o, &PyId___fspath__);
991 if (NULL == func) {
Xiang Zhang04316c42017-01-08 23:26:57 +0800992 goto error_format;
Brett Cannon3f9183b2016-08-26 14:44:48 -0700993 }
Xiang Zhang04316c42017-01-08 23:26:57 +0800994 /* still owns a reference to the original object */
995 Py_DECREF(o);
996 o = _PyObject_CallNoArg(func);
Brett Cannon3f9183b2016-08-26 14:44:48 -0700997 Py_DECREF(func);
998 if (NULL == o) {
999 goto error_exit;
1000 }
1001 else if (PyUnicode_Check(o)) {
1002 is_unicode = 1;
1003 }
1004 else if (PyBytes_Check(o)) {
1005 is_bytes = 1;
1006 }
1007 else {
Xiang Zhang04316c42017-01-08 23:26:57 +08001008 goto error_format;
Brett Cannon3f9183b2016-08-26 14:44:48 -07001009 }
1010 }
1011
1012 if (is_unicode) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07001013#ifdef MS_WINDOWS
Victor Stinner26c03bd2016-09-19 11:55:44 +02001014 wide = PyUnicode_AsUnicodeAndSize(o, &length);
Victor Stinner59799a82013-11-13 14:17:30 +01001015 if (!wide) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001016 goto error_exit;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001017 }
Victor Stinner59799a82013-11-13 14:17:30 +01001018 if (length > 32767) {
1019 FORMAT_EXCEPTION(PyExc_ValueError, "%s too long for Windows");
Xiang Zhang04316c42017-01-08 23:26:57 +08001020 goto error_exit;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001021 }
Serhiy Storchaka2b0d2002015-04-20 09:53:58 +03001022 if (wcslen(wide) != length) {
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001023 FORMAT_EXCEPTION(PyExc_ValueError, "embedded null character in %s");
Xiang Zhang04316c42017-01-08 23:26:57 +08001024 goto error_exit;
Serhiy Storchaka2b0d2002015-04-20 09:53:58 +03001025 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07001026
1027 path->wide = wide;
Xiang Zhang04316c42017-01-08 23:26:57 +08001028 path->narrow = FALSE;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001029 path->fd = -1;
Xiang Zhang04316c42017-01-08 23:26:57 +08001030 goto success_exit;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001031#else
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001032 if (!PyUnicode_FSConverter(o, &bytes)) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001033 goto error_exit;
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001034 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07001035#endif
1036 }
Brett Cannon3f9183b2016-08-26 14:44:48 -07001037 else if (is_bytes) {
Serhiy Storchakad73c3182016-08-06 23:22:08 +03001038 bytes = o;
1039 Py_INCREF(bytes);
1040 }
Brett Cannon3f9183b2016-08-26 14:44:48 -07001041 else if (is_buffer) {
Serhiy Storchaka1180e5a2017-07-11 06:36:46 +03001042 /* XXX Replace PyObject_CheckBuffer with PyBytes_Check in other code
Ville Skyttä49b27342017-08-03 09:00:59 +03001043 after removing support of non-bytes buffer objects. */
Serhiy Storchakad73c3182016-08-06 23:22:08 +03001044 if (PyErr_WarnFormat(PyExc_DeprecationWarning, 1,
1045 "%s%s%s should be %s, not %.200s",
1046 path->function_name ? path->function_name : "",
1047 path->function_name ? ": " : "",
1048 path->argument_name ? path->argument_name : "path",
Brett Cannon3f9183b2016-08-26 14:44:48 -07001049 path->allow_fd && path->nullable ? "string, bytes, os.PathLike, "
1050 "integer or None" :
1051 path->allow_fd ? "string, bytes, os.PathLike or integer" :
1052 path->nullable ? "string, bytes, os.PathLike or None" :
1053 "string, bytes or os.PathLike",
Serhiy Storchakad73c3182016-08-06 23:22:08 +03001054 Py_TYPE(o)->tp_name)) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001055 goto error_exit;
Serhiy Storchakad73c3182016-08-06 23:22:08 +03001056 }
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001057 bytes = PyBytes_FromObject(o);
Larry Hastings9cf065c2012-06-22 16:30:09 -07001058 if (!bytes) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001059 goto error_exit;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001060 }
1061 }
Steve Dowercc16be82016-09-08 10:35:16 -07001062 else if (is_index) {
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001063 if (!_fd_converter(o, &path->fd)) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001064 goto error_exit;
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001065 }
1066 path->wide = NULL;
Steve Dowercc16be82016-09-08 10:35:16 -07001067#ifdef MS_WINDOWS
1068 path->narrow = FALSE;
1069#else
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001070 path->narrow = NULL;
Steve Dowercc16be82016-09-08 10:35:16 -07001071#endif
Xiang Zhang04316c42017-01-08 23:26:57 +08001072 goto success_exit;
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001073 }
1074 else {
Xiang Zhang04316c42017-01-08 23:26:57 +08001075 error_format:
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001076 PyErr_Format(PyExc_TypeError, "%s%s%s should be %s, not %.200s",
1077 path->function_name ? path->function_name : "",
1078 path->function_name ? ": " : "",
1079 path->argument_name ? path->argument_name : "path",
Brett Cannon3f9183b2016-08-26 14:44:48 -07001080 path->allow_fd && path->nullable ? "string, bytes, os.PathLike, "
1081 "integer or None" :
1082 path->allow_fd ? "string, bytes, os.PathLike or integer" :
1083 path->nullable ? "string, bytes, os.PathLike or None" :
1084 "string, bytes or os.PathLike",
Serhiy Storchaka819399b2016-04-06 22:17:52 +03001085 Py_TYPE(o)->tp_name);
Xiang Zhang04316c42017-01-08 23:26:57 +08001086 goto error_exit;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001087 }
1088
Larry Hastings9cf065c2012-06-22 16:30:09 -07001089 length = PyBytes_GET_SIZE(bytes);
Larry Hastings9cf065c2012-06-22 16:30:09 -07001090 narrow = PyBytes_AS_STRING(bytes);
Victor Stinner706768c2014-08-16 01:03:39 +02001091 if ((size_t)length != strlen(narrow)) {
Serhiy Storchakad8a14472014-09-06 20:07:17 +03001092 FORMAT_EXCEPTION(PyExc_ValueError, "embedded null character in %s");
Xiang Zhang04316c42017-01-08 23:26:57 +08001093 goto error_exit;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001094 }
1095
Steve Dowercc16be82016-09-08 10:35:16 -07001096#ifdef MS_WINDOWS
1097 wo = PyUnicode_DecodeFSDefaultAndSize(
1098 narrow,
1099 length
1100 );
1101 if (!wo) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001102 goto error_exit;
Steve Dowercc16be82016-09-08 10:35:16 -07001103 }
1104
Xiang Zhang04316c42017-01-08 23:26:57 +08001105 wide = PyUnicode_AsUnicodeAndSize(wo, &length);
Steve Dowercc16be82016-09-08 10:35:16 -07001106 if (!wide) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001107 goto error_exit;
Steve Dowercc16be82016-09-08 10:35:16 -07001108 }
1109 if (length > 32767) {
1110 FORMAT_EXCEPTION(PyExc_ValueError, "%s too long for Windows");
Xiang Zhang04316c42017-01-08 23:26:57 +08001111 goto error_exit;
Steve Dowercc16be82016-09-08 10:35:16 -07001112 }
1113 if (wcslen(wide) != length) {
1114 FORMAT_EXCEPTION(PyExc_ValueError, "embedded null character in %s");
Xiang Zhang04316c42017-01-08 23:26:57 +08001115 goto error_exit;
Steve Dowercc16be82016-09-08 10:35:16 -07001116 }
1117 path->wide = wide;
1118 path->narrow = TRUE;
Xiang Zhang04316c42017-01-08 23:26:57 +08001119 path->cleanup = wo;
1120 Py_DECREF(bytes);
Steve Dowercc16be82016-09-08 10:35:16 -07001121#else
Larry Hastings9cf065c2012-06-22 16:30:09 -07001122 path->wide = NULL;
1123 path->narrow = narrow;
Serhiy Storchakad73c3182016-08-06 23:22:08 +03001124 if (bytes == o) {
Xiang Zhang04316c42017-01-08 23:26:57 +08001125 /* Still a reference owned by path->object, don't have to
1126 worry about path->narrow is used after free. */
Serhiy Storchakad73c3182016-08-06 23:22:08 +03001127 Py_DECREF(bytes);
Serhiy Storchakad73c3182016-08-06 23:22:08 +03001128 }
1129 else {
1130 path->cleanup = bytes;
Serhiy Storchakad73c3182016-08-06 23:22:08 +03001131 }
Xiang Zhang04316c42017-01-08 23:26:57 +08001132#endif
1133 path->fd = -1;
1134
1135 success_exit:
1136 path->length = length;
1137 path->object = o;
1138 return Py_CLEANUP_SUPPORTED;
1139
1140 error_exit:
1141 Py_XDECREF(o);
1142 Py_XDECREF(bytes);
1143#ifdef MS_WINDOWS
1144 Py_XDECREF(wo);
1145#endif
1146 return 0;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001147}
1148
1149static void
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001150argument_unavailable_error(const char *function_name, const char *argument_name)
1151{
Larry Hastings9cf065c2012-06-22 16:30:09 -07001152 PyErr_Format(PyExc_NotImplementedError,
1153 "%s%s%s unavailable on this platform",
1154 (function_name != NULL) ? function_name : "",
1155 (function_name != NULL) ? ": ": "",
1156 argument_name);
1157}
1158
1159static int
Serhiy Storchakaa2ad5c32013-01-07 23:13:46 +02001160dir_fd_unavailable(PyObject *o, void *p)
1161{
1162 int dir_fd;
1163 if (!dir_fd_converter(o, &dir_fd))
Larry Hastings9cf065c2012-06-22 16:30:09 -07001164 return 0;
Serhiy Storchakaa2ad5c32013-01-07 23:13:46 +02001165 if (dir_fd != DEFAULT_DIR_FD) {
1166 argument_unavailable_error(NULL, "dir_fd");
1167 return 0;
1168 }
1169 *(int *)p = dir_fd;
1170 return 1;
Larry Hastings9cf065c2012-06-22 16:30:09 -07001171}
1172
1173static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001174fd_specified(const char *function_name, int fd)
1175{
Larry Hastings9cf065c2012-06-22 16:30:09 -07001176 if (fd == -1)
1177 return 0;
1178
1179 argument_unavailable_error(function_name, "fd");
1180 return 1;
1181}
1182
1183static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001184follow_symlinks_specified(const char *function_name, int follow_symlinks)
1185{
Larry Hastings9cf065c2012-06-22 16:30:09 -07001186 if (follow_symlinks)
1187 return 0;
1188
1189 argument_unavailable_error(function_name, "follow_symlinks");
1190 return 1;
1191}
1192
1193static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001194path_and_dir_fd_invalid(const char *function_name, path_t *path, int dir_fd)
1195{
Steve Dowercc16be82016-09-08 10:35:16 -07001196 if (!path->wide && (dir_fd != DEFAULT_DIR_FD)
1197#ifndef MS_WINDOWS
1198 && !path->narrow
1199#endif
1200 ) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07001201 PyErr_Format(PyExc_ValueError,
1202 "%s: can't specify dir_fd without matching path",
1203 function_name);
1204 return 1;
1205 }
1206 return 0;
1207}
1208
1209static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001210dir_fd_and_fd_invalid(const char *function_name, int dir_fd, int fd)
1211{
Larry Hastings9cf065c2012-06-22 16:30:09 -07001212 if ((dir_fd != DEFAULT_DIR_FD) && (fd != -1)) {
1213 PyErr_Format(PyExc_ValueError,
1214 "%s: can't specify both dir_fd and fd",
1215 function_name);
1216 return 1;
1217 }
1218 return 0;
1219}
1220
1221static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001222fd_and_follow_symlinks_invalid(const char *function_name, int fd,
1223 int follow_symlinks)
1224{
Larry Hastings9cf065c2012-06-22 16:30:09 -07001225 if ((fd > 0) && (!follow_symlinks)) {
1226 PyErr_Format(PyExc_ValueError,
1227 "%s: cannot use fd and follow_symlinks together",
1228 function_name);
1229 return 1;
1230 }
1231 return 0;
1232}
1233
1234static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001235dir_fd_and_follow_symlinks_invalid(const char *function_name, int dir_fd,
1236 int follow_symlinks)
1237{
Larry Hastings9cf065c2012-06-22 16:30:09 -07001238 if ((dir_fd != DEFAULT_DIR_FD) && (!follow_symlinks)) {
1239 PyErr_Format(PyExc_ValueError,
1240 "%s: cannot use dir_fd and follow_symlinks together",
1241 function_name);
1242 return 1;
1243 }
1244 return 0;
1245}
1246
Larry Hastings2f936352014-08-05 14:04:04 +10001247#ifdef MS_WINDOWS
Benjamin Petersonaf580df2016-09-06 10:46:49 -07001248 typedef long long Py_off_t;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00001249#else
Larry Hastings2f936352014-08-05 14:04:04 +10001250 typedef off_t Py_off_t;
1251#endif
1252
1253static int
1254Py_off_t_converter(PyObject *arg, void *addr)
1255{
1256#ifdef HAVE_LARGEFILE_SUPPORT
1257 *((Py_off_t *)addr) = PyLong_AsLongLong(arg);
1258#else
1259 *((Py_off_t *)addr) = PyLong_AsLong(arg);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00001260#endif
1261 if (PyErr_Occurred())
1262 return 0;
1263 return 1;
1264}
Larry Hastings2f936352014-08-05 14:04:04 +10001265
1266static PyObject *
1267PyLong_FromPy_off_t(Py_off_t offset)
1268{
1269#ifdef HAVE_LARGEFILE_SUPPORT
1270 return PyLong_FromLongLong(offset);
1271#else
1272 return PyLong_FromLong(offset);
Ross Lagerwallb1e5d592011-09-19 08:30:43 +02001273#endif
Larry Hastings2f936352014-08-05 14:04:04 +10001274}
1275
Brian Curtinfc1be6d2010-11-24 13:23:18 +00001276#ifdef MS_WINDOWS
Brian Curtinf5e76d02010-11-24 13:14:05 +00001277
1278static int
Brian Curtind25aef52011-06-13 15:16:04 -05001279win32_get_reparse_tag(HANDLE reparse_point_handle, ULONG *reparse_tag)
Brian Curtinf5e76d02010-11-24 13:14:05 +00001280{
Martin Panter70214ad2016-08-04 02:38:59 +00001281 char target_buffer[_Py_MAXIMUM_REPARSE_DATA_BUFFER_SIZE];
1282 _Py_REPARSE_DATA_BUFFER *rdb = (_Py_REPARSE_DATA_BUFFER *)target_buffer;
Brian Curtinf5e76d02010-11-24 13:14:05 +00001283 DWORD n_bytes_returned;
Brian Curtinf5e76d02010-11-24 13:14:05 +00001284
1285 if (0 == DeviceIoControl(
1286 reparse_point_handle,
1287 FSCTL_GET_REPARSE_POINT,
1288 NULL, 0, /* in buffer */
1289 target_buffer, sizeof(target_buffer),
1290 &n_bytes_returned,
1291 NULL)) /* we're not using OVERLAPPED_IO */
Brian Curtind25aef52011-06-13 15:16:04 -05001292 return FALSE;
Brian Curtinf5e76d02010-11-24 13:14:05 +00001293
1294 if (reparse_tag)
1295 *reparse_tag = rdb->ReparseTag;
1296
Brian Curtind25aef52011-06-13 15:16:04 -05001297 return TRUE;
Brian Curtinf5e76d02010-11-24 13:14:05 +00001298}
Victor Stinner1ab6c2d2011-11-15 22:27:41 +01001299
Brian Curtinfc1be6d2010-11-24 13:23:18 +00001300#endif /* MS_WINDOWS */
Brian Curtinf5e76d02010-11-24 13:14:05 +00001301
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001302/* Return a dictionary corresponding to the POSIX environment table */
Ronald Oussoren697e56d2013-01-25 17:57:13 +01001303#if defined(WITH_NEXT_FRAMEWORK) || (defined(__APPLE__) && defined(Py_ENABLE_SHARED))
Jack Jansenea0c3822002-08-01 21:57:49 +00001304/* On Darwin/MacOSX a shared library or framework has no access to
Ronald Oussoren697e56d2013-01-25 17:57:13 +01001305** environ directly, we must obtain it with _NSGetEnviron(). See also
1306** man environ(7).
Jack Jansenea0c3822002-08-01 21:57:49 +00001307*/
1308#include <crt_externs.h>
1309static char **environ;
1310#elif !defined(_MSC_VER) && ( !defined(__WATCOMC__) || defined(__QNX__) )
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001311extern char **environ;
Guido van Rossuma4916fa1996-05-23 22:58:55 +00001312#endif /* !_MSC_VER */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001313
Barry Warsaw53699e91996-12-10 23:23:01 +00001314static PyObject *
Thomas Woutersf3f33dc2000-07-21 06:00:07 +00001315convertenviron(void)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001316{
Victor Stinner8c62be82010-05-06 00:08:46 +00001317 PyObject *d;
Thomas Hellerf78f12a2007-11-08 19:33:05 +00001318#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00001319 wchar_t **e;
Thomas Hellerf78f12a2007-11-08 19:33:05 +00001320#else
Victor Stinner8c62be82010-05-06 00:08:46 +00001321 char **e;
Thomas Hellerf78f12a2007-11-08 19:33:05 +00001322#endif
Guido van Rossumd48f2521997-12-05 22:19:34 +00001323
Victor Stinner8c62be82010-05-06 00:08:46 +00001324 d = PyDict_New();
1325 if (d == NULL)
1326 return NULL;
Ronald Oussoren697e56d2013-01-25 17:57:13 +01001327#if defined(WITH_NEXT_FRAMEWORK) || (defined(__APPLE__) && defined(Py_ENABLE_SHARED))
Victor Stinner8c62be82010-05-06 00:08:46 +00001328 if (environ == NULL)
1329 environ = *_NSGetEnviron();
1330#endif
1331#ifdef MS_WINDOWS
1332 /* _wenviron must be initialized in this way if the program is started
1333 through main() instead of wmain(). */
1334 _wgetenv(L"");
1335 if (_wenviron == NULL)
1336 return d;
1337 /* This part ignores errors */
1338 for (e = _wenviron; *e != NULL; e++) {
1339 PyObject *k;
1340 PyObject *v;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03001341 const wchar_t *p = wcschr(*e, L'=');
Victor Stinner8c62be82010-05-06 00:08:46 +00001342 if (p == NULL)
1343 continue;
1344 k = PyUnicode_FromWideChar(*e, (Py_ssize_t)(p-*e));
1345 if (k == NULL) {
1346 PyErr_Clear();
1347 continue;
Guido van Rossumd48f2521997-12-05 22:19:34 +00001348 }
Victor Stinner8c62be82010-05-06 00:08:46 +00001349 v = PyUnicode_FromWideChar(p+1, wcslen(p+1));
1350 if (v == NULL) {
1351 PyErr_Clear();
1352 Py_DECREF(k);
1353 continue;
Guido van Rossumd48f2521997-12-05 22:19:34 +00001354 }
Victor Stinner8c62be82010-05-06 00:08:46 +00001355 if (PyDict_GetItem(d, k) == NULL) {
1356 if (PyDict_SetItem(d, k, v) != 0)
1357 PyErr_Clear();
1358 }
1359 Py_DECREF(k);
1360 Py_DECREF(v);
1361 }
1362#else
1363 if (environ == NULL)
1364 return d;
1365 /* This part ignores errors */
1366 for (e = environ; *e != NULL; e++) {
1367 PyObject *k;
1368 PyObject *v;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03001369 const char *p = strchr(*e, '=');
Victor Stinner8c62be82010-05-06 00:08:46 +00001370 if (p == NULL)
1371 continue;
Victor Stinner84ae1182010-05-06 22:05:07 +00001372 k = PyBytes_FromStringAndSize(*e, (int)(p-*e));
Victor Stinner8c62be82010-05-06 00:08:46 +00001373 if (k == NULL) {
1374 PyErr_Clear();
1375 continue;
1376 }
Victor Stinner84ae1182010-05-06 22:05:07 +00001377 v = PyBytes_FromStringAndSize(p+1, strlen(p+1));
Victor Stinner8c62be82010-05-06 00:08:46 +00001378 if (v == NULL) {
1379 PyErr_Clear();
1380 Py_DECREF(k);
1381 continue;
1382 }
1383 if (PyDict_GetItem(d, k) == NULL) {
1384 if (PyDict_SetItem(d, k, v) != 0)
1385 PyErr_Clear();
1386 }
1387 Py_DECREF(k);
1388 Py_DECREF(v);
Guido van Rossumd48f2521997-12-05 22:19:34 +00001389 }
1390#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00001391 return d;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001392}
1393
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001394/* Set a POSIX-specific error from errno, and return NULL */
1395
Barry Warsawd58d7641998-07-23 16:14:40 +00001396static PyObject *
Thomas Woutersf3f33dc2000-07-21 06:00:07 +00001397posix_error(void)
Guido van Rossumad0ee831995-03-01 10:34:45 +00001398{
Victor Stinner8c62be82010-05-06 00:08:46 +00001399 return PyErr_SetFromErrno(PyExc_OSError);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001400}
Mark Hammondef8b6542001-05-13 08:04:26 +00001401
Martin v. Löwis6238d2b2002-06-30 15:26:10 +00001402#ifdef MS_WINDOWS
Fredrik Lundhffb9c772000-07-09 14:49:51 +00001403static PyObject *
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001404win32_error(const char* function, const char* filename)
Fredrik Lundhffb9c772000-07-09 14:49:51 +00001405{
Victor Stinner8c62be82010-05-06 00:08:46 +00001406 /* XXX We should pass the function name along in the future.
1407 (winreg.c also wants to pass the function name.)
1408 This would however require an additional param to the
1409 Windows error object, which is non-trivial.
1410 */
1411 errno = GetLastError();
1412 if (filename)
1413 return PyErr_SetFromWindowsErrWithFilename(errno, filename);
1414 else
1415 return PyErr_SetFromWindowsErr(errno);
Fredrik Lundhffb9c772000-07-09 14:49:51 +00001416}
Mark Hammondc2e85bd2002-10-03 05:10:39 +00001417
Mark Hammondc2e85bd2002-10-03 05:10:39 +00001418static PyObject *
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001419win32_error_object(const char* function, PyObject* filename)
Victor Stinnereb5657a2011-09-30 01:44:27 +02001420{
1421 /* XXX - see win32_error for comments on 'function' */
1422 errno = GetLastError();
1423 if (filename)
1424 return PyErr_SetExcFromWindowsErrWithFilenameObject(
Andrew Svetlov2606a6f2012-12-19 14:33:35 +02001425 PyExc_OSError,
Victor Stinnereb5657a2011-09-30 01:44:27 +02001426 errno,
1427 filename);
1428 else
1429 return PyErr_SetFromWindowsErr(errno);
1430}
1431
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00001432#endif /* MS_WINDOWS */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001433
Larry Hastings9cf065c2012-06-22 16:30:09 -07001434static PyObject *
Serhiy Storchaka2674bc72016-10-08 20:16:57 +03001435path_object_error(PyObject *path)
Larry Hastings9cf065c2012-06-22 16:30:09 -07001436{
1437#ifdef MS_WINDOWS
Serhiy Storchaka2674bc72016-10-08 20:16:57 +03001438 return PyErr_SetExcFromWindowsErrWithFilenameObject(
1439 PyExc_OSError, 0, path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07001440#else
Serhiy Storchaka2674bc72016-10-08 20:16:57 +03001441 return PyErr_SetFromErrnoWithFilenameObject(PyExc_OSError, path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07001442#endif
1443}
1444
Serhiy Storchaka2674bc72016-10-08 20:16:57 +03001445static PyObject *
1446path_object_error2(PyObject *path, PyObject *path2)
1447{
1448#ifdef MS_WINDOWS
1449 return PyErr_SetExcFromWindowsErrWithFilenameObjects(
1450 PyExc_OSError, 0, path, path2);
1451#else
1452 return PyErr_SetFromErrnoWithFilenameObjects(PyExc_OSError, path, path2);
1453#endif
1454}
1455
1456static PyObject *
1457path_error(path_t *path)
1458{
1459 return path_object_error(path->object);
1460}
Larry Hastings31826802013-10-19 00:09:25 -07001461
Larry Hastingsb0827312014-02-09 22:05:19 -08001462static PyObject *
1463path_error2(path_t *path, path_t *path2)
1464{
Serhiy Storchaka2674bc72016-10-08 20:16:57 +03001465 return path_object_error2(path->object, path2->object);
Larry Hastingsb0827312014-02-09 22:05:19 -08001466}
1467
1468
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001469/* POSIX generic methods */
1470
Larry Hastings2f936352014-08-05 14:04:04 +10001471static int
1472fildes_converter(PyObject *o, void *p)
Fred Drake4d1e64b2002-04-15 19:40:07 +00001473{
Victor Stinner8c62be82010-05-06 00:08:46 +00001474 int fd;
Larry Hastings2f936352014-08-05 14:04:04 +10001475 int *pointer = (int *)p;
1476 fd = PyObject_AsFileDescriptor(o);
Victor Stinner8c62be82010-05-06 00:08:46 +00001477 if (fd < 0)
Larry Hastings2f936352014-08-05 14:04:04 +10001478 return 0;
Larry Hastings2f936352014-08-05 14:04:04 +10001479 *pointer = fd;
1480 return 1;
1481}
1482
1483static PyObject *
1484posix_fildes_fd(int fd, int (*func)(int))
1485{
1486 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00001487 int async_err = 0;
1488
1489 do {
1490 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04001491 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00001492 res = (*func)(fd);
Steve Dower8fc89802015-04-12 00:26:27 -04001493 _Py_END_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00001494 Py_END_ALLOW_THREADS
1495 } while (res != 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
1496 if (res != 0)
1497 return (!async_err) ? posix_error() : NULL;
1498 Py_RETURN_NONE;
Fred Drake4d1e64b2002-04-15 19:40:07 +00001499}
Guido van Rossum21142a01999-01-08 21:05:37 +00001500
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001501
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00001502#ifdef MS_WINDOWS
Thomas Wouters477c8d52006-05-27 19:21:47 +00001503/* This is a reimplementation of the C library's chdir function,
1504 but one that produces Win32 errors instead of DOS error codes.
1505 chdir is essentially a wrapper around SetCurrentDirectory; however,
1506 it also needs to set "magic" environment variables indicating
1507 the per-drive current directory, which are of the form =<drive>: */
Benjamin Peterson206e3072008-10-19 14:07:49 +00001508static BOOL __stdcall
Thomas Wouters477c8d52006-05-27 19:21:47 +00001509win32_wchdir(LPCWSTR path)
1510{
Victor Stinnered537822015-12-13 21:40:26 +01001511 wchar_t path_buf[MAX_PATH], *new_path = path_buf;
Victor Stinner8c62be82010-05-06 00:08:46 +00001512 int result;
1513 wchar_t env[4] = L"=x:";
Thomas Wouters477c8d52006-05-27 19:21:47 +00001514
Victor Stinner8c62be82010-05-06 00:08:46 +00001515 if(!SetCurrentDirectoryW(path))
1516 return FALSE;
Victor Stinnered537822015-12-13 21:40:26 +01001517 result = GetCurrentDirectoryW(Py_ARRAY_LENGTH(path_buf), new_path);
Victor Stinner8c62be82010-05-06 00:08:46 +00001518 if (!result)
1519 return FALSE;
Victor Stinnere847d712015-12-14 00:21:50 +01001520 if (result > Py_ARRAY_LENGTH(path_buf)) {
Victor Stinnerb6404912013-07-07 16:21:41 +02001521 new_path = PyMem_RawMalloc(result * sizeof(wchar_t));
Victor Stinner8c62be82010-05-06 00:08:46 +00001522 if (!new_path) {
1523 SetLastError(ERROR_OUTOFMEMORY);
1524 return FALSE;
1525 }
1526 result = GetCurrentDirectoryW(result, new_path);
1527 if (!result) {
Victor Stinnerb6404912013-07-07 16:21:41 +02001528 PyMem_RawFree(new_path);
Victor Stinner8c62be82010-05-06 00:08:46 +00001529 return FALSE;
1530 }
1531 }
1532 if (wcsncmp(new_path, L"\\\\", 2) == 0 ||
1533 wcsncmp(new_path, L"//", 2) == 0)
1534 /* UNC path, nothing to do. */
1535 return TRUE;
1536 env[1] = new_path[0];
1537 result = SetEnvironmentVariableW(env, new_path);
Victor Stinnered537822015-12-13 21:40:26 +01001538 if (new_path != path_buf)
Victor Stinnerb6404912013-07-07 16:21:41 +02001539 PyMem_RawFree(new_path);
Victor Stinner8c62be82010-05-06 00:08:46 +00001540 return result;
Thomas Wouters477c8d52006-05-27 19:21:47 +00001541}
1542#endif
1543
Martin v. Löwis14694662006-02-03 12:54:16 +00001544#ifdef MS_WINDOWS
1545/* The CRT of Windows has a number of flaws wrt. its stat() implementation:
1546 - time stamps are restricted to second resolution
1547 - file modification times suffer from forth-and-back conversions between
1548 UTC and local time
1549 Therefore, we implement our own stat, based on the Win32 API directly.
1550*/
Victor Stinner8c62be82010-05-06 00:08:46 +00001551#define HAVE_STAT_NSEC 1
Zachary Ware63f277b2014-06-19 09:46:37 -05001552#define HAVE_STRUCT_STAT_ST_FILE_ATTRIBUTES 1
Martin v. Löwis14694662006-02-03 12:54:16 +00001553
Victor Stinner6036e442015-03-08 01:58:04 +01001554static void
Steve Dowercc16be82016-09-08 10:35:16 -07001555find_data_to_file_info(WIN32_FIND_DATAW *pFileData,
1556 BY_HANDLE_FILE_INFORMATION *info,
1557 ULONG *reparse_tag)
Victor Stinner6036e442015-03-08 01:58:04 +01001558{
1559 memset(info, 0, sizeof(*info));
1560 info->dwFileAttributes = pFileData->dwFileAttributes;
1561 info->ftCreationTime = pFileData->ftCreationTime;
1562 info->ftLastAccessTime = pFileData->ftLastAccessTime;
1563 info->ftLastWriteTime = pFileData->ftLastWriteTime;
1564 info->nFileSizeHigh = pFileData->nFileSizeHigh;
1565 info->nFileSizeLow = pFileData->nFileSizeLow;
1566/* info->nNumberOfLinks = 1; */
1567 if (pFileData->dwFileAttributes & FILE_ATTRIBUTE_REPARSE_POINT)
1568 *reparse_tag = pFileData->dwReserved0;
1569 else
1570 *reparse_tag = 0;
1571}
1572
Guido van Rossumd8faa362007-04-27 19:54:29 +00001573static BOOL
Steve Dowercc16be82016-09-08 10:35:16 -07001574attributes_from_dir(LPCWSTR pszFile, BY_HANDLE_FILE_INFORMATION *info, ULONG *reparse_tag)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001575{
Victor Stinner8c62be82010-05-06 00:08:46 +00001576 HANDLE hFindFile;
1577 WIN32_FIND_DATAW FileData;
1578 hFindFile = FindFirstFileW(pszFile, &FileData);
1579 if (hFindFile == INVALID_HANDLE_VALUE)
1580 return FALSE;
1581 FindClose(hFindFile);
Steve Dowercc16be82016-09-08 10:35:16 -07001582 find_data_to_file_info(&FileData, info, reparse_tag);
Victor Stinner8c62be82010-05-06 00:08:46 +00001583 return TRUE;
Guido van Rossumd8faa362007-04-27 19:54:29 +00001584}
1585
Brian Curtind25aef52011-06-13 15:16:04 -05001586static BOOL
1587get_target_path(HANDLE hdl, wchar_t **target_path)
1588{
1589 int buf_size, result_length;
1590 wchar_t *buf;
1591
1592 /* We have a good handle to the target, use it to determine
1593 the target path name (then we'll call lstat on it). */
Steve Dower2ea51c92015-03-20 21:49:12 -07001594 buf_size = GetFinalPathNameByHandleW(hdl, 0, 0,
1595 VOLUME_NAME_DOS);
Brian Curtind25aef52011-06-13 15:16:04 -05001596 if(!buf_size)
1597 return FALSE;
1598
Victor Stinnerc36674a2016-03-16 14:30:16 +01001599 buf = (wchar_t *)PyMem_RawMalloc((buf_size + 1) * sizeof(wchar_t));
Brian Curtinc8be8402011-06-14 09:52:50 -05001600 if (!buf) {
1601 SetLastError(ERROR_OUTOFMEMORY);
1602 return FALSE;
1603 }
1604
Steve Dower2ea51c92015-03-20 21:49:12 -07001605 result_length = GetFinalPathNameByHandleW(hdl,
Brian Curtind25aef52011-06-13 15:16:04 -05001606 buf, buf_size, VOLUME_NAME_DOS);
1607
1608 if(!result_length) {
Victor Stinnerc36674a2016-03-16 14:30:16 +01001609 PyMem_RawFree(buf);
Brian Curtind25aef52011-06-13 15:16:04 -05001610 return FALSE;
1611 }
1612
1613 if(!CloseHandle(hdl)) {
Victor Stinnerc36674a2016-03-16 14:30:16 +01001614 PyMem_RawFree(buf);
Brian Curtind25aef52011-06-13 15:16:04 -05001615 return FALSE;
1616 }
1617
1618 buf[result_length] = 0;
1619
1620 *target_path = buf;
1621 return TRUE;
1622}
1623
1624static int
Steve Dowercc16be82016-09-08 10:35:16 -07001625win32_xstat_impl(const wchar_t *path, struct _Py_stat_struct *result,
Brian Curtind25aef52011-06-13 15:16:04 -05001626 BOOL traverse)
1627{
Victor Stinner26de69d2011-06-17 15:15:38 +02001628 int code;
Brian Curtind25aef52011-06-13 15:16:04 -05001629 HANDLE hFile, hFile2;
Brian Curtinf5e76d02010-11-24 13:14:05 +00001630 BY_HANDLE_FILE_INFORMATION info;
Hirokazu Yamamoto427d3142010-12-04 10:16:05 +00001631 ULONG reparse_tag = 0;
Victor Stinner26de69d2011-06-17 15:15:38 +02001632 wchar_t *target_path;
Steve Dowercc16be82016-09-08 10:35:16 -07001633 const wchar_t *dot;
Brian Curtinf5e76d02010-11-24 13:14:05 +00001634
Steve Dowercc16be82016-09-08 10:35:16 -07001635 hFile = CreateFileW(
Brian Curtinf5e76d02010-11-24 13:14:05 +00001636 path,
Brian Curtind25aef52011-06-13 15:16:04 -05001637 FILE_READ_ATTRIBUTES, /* desired access */
Brian Curtinf5e76d02010-11-24 13:14:05 +00001638 0, /* share mode */
1639 NULL, /* security attributes */
1640 OPEN_EXISTING,
1641 /* FILE_FLAG_BACKUP_SEMANTICS is required to open a directory */
Brian Curtind25aef52011-06-13 15:16:04 -05001642 /* FILE_FLAG_OPEN_REPARSE_POINT does not follow the symlink.
1643 Because of this, calls like GetFinalPathNameByHandle will return
R David Murrayfc069992013-12-13 20:52:19 -05001644 the symlink path again and not the actual final path. */
Brian Curtind25aef52011-06-13 15:16:04 -05001645 FILE_ATTRIBUTE_NORMAL|FILE_FLAG_BACKUP_SEMANTICS|
1646 FILE_FLAG_OPEN_REPARSE_POINT,
Brian Curtinf5e76d02010-11-24 13:14:05 +00001647 NULL);
1648
Hirokazu Yamamoto427d3142010-12-04 10:16:05 +00001649 if (hFile == INVALID_HANDLE_VALUE) {
Brian Curtinf5e76d02010-11-24 13:14:05 +00001650 /* Either the target doesn't exist, or we don't have access to
1651 get a handle to it. If the former, we need to return an error.
1652 If the latter, we can use attributes_from_dir. */
Berker Peksag0b4dc482016-09-17 15:49:59 +03001653 DWORD lastError = GetLastError();
1654 if (lastError != ERROR_ACCESS_DENIED &&
1655 lastError != ERROR_SHARING_VIOLATION)
Hirokazu Yamamoto427d3142010-12-04 10:16:05 +00001656 return -1;
1657 /* Could not get attributes on open file. Fall back to
1658 reading the directory. */
1659 if (!attributes_from_dir(path, &info, &reparse_tag))
1660 /* Very strange. This should not fail now */
1661 return -1;
1662 if (info.dwFileAttributes & FILE_ATTRIBUTE_REPARSE_POINT) {
1663 if (traverse) {
1664 /* Should traverse, but could not open reparse point handle */
Berker Peksag0b4dc482016-09-17 15:49:59 +03001665 SetLastError(lastError);
Hirokazu Yamamoto427d3142010-12-04 10:16:05 +00001666 return -1;
Brian Curtinf5e76d02010-11-24 13:14:05 +00001667 }
Brian Curtinf5e76d02010-11-24 13:14:05 +00001668 }
Hirokazu Yamamoto427d3142010-12-04 10:16:05 +00001669 } else {
1670 if (!GetFileInformationByHandle(hFile, &info)) {
1671 CloseHandle(hFile);
Brian Curtind25aef52011-06-13 15:16:04 -05001672 return -1;
Hirokazu Yamamoto427d3142010-12-04 10:16:05 +00001673 }
1674 if (info.dwFileAttributes & FILE_ATTRIBUTE_REPARSE_POINT) {
Brian Curtind25aef52011-06-13 15:16:04 -05001675 if (!win32_get_reparse_tag(hFile, &reparse_tag))
1676 return -1;
1677
1678 /* Close the outer open file handle now that we're about to
1679 reopen it with different flags. */
1680 if (!CloseHandle(hFile))
1681 return -1;
1682
Hirokazu Yamamoto427d3142010-12-04 10:16:05 +00001683 if (traverse) {
Brian Curtind25aef52011-06-13 15:16:04 -05001684 /* In order to call GetFinalPathNameByHandle we need to open
1685 the file without the reparse handling flag set. */
Brian Curtind25aef52011-06-13 15:16:04 -05001686 hFile2 = CreateFileW(
1687 path, FILE_READ_ATTRIBUTES, FILE_SHARE_READ,
1688 NULL, OPEN_EXISTING,
1689 FILE_ATTRIBUTE_NORMAL|FILE_FLAG_BACKUP_SEMANTICS,
1690 NULL);
1691 if (hFile2 == INVALID_HANDLE_VALUE)
1692 return -1;
1693
1694 if (!get_target_path(hFile2, &target_path))
1695 return -1;
1696
Steve Dowercc16be82016-09-08 10:35:16 -07001697 code = win32_xstat_impl(target_path, result, FALSE);
Victor Stinnerc36674a2016-03-16 14:30:16 +01001698 PyMem_RawFree(target_path);
Hirokazu Yamamoto427d3142010-12-04 10:16:05 +00001699 return code;
1700 }
Hirokazu Yamamoto7ed117a2010-12-07 10:24:37 +00001701 } else
1702 CloseHandle(hFile);
Brian Curtinf5e76d02010-11-24 13:14:05 +00001703 }
Steve Dowera2af1a52015-02-21 10:04:10 -08001704 _Py_attribute_data_to_stat(&info, reparse_tag, result);
Brian Curtinf5e76d02010-11-24 13:14:05 +00001705
1706 /* Set S_IEXEC if it is an .exe, .bat, ... */
1707 dot = wcsrchr(path, '.');
1708 if (dot) {
1709 if (_wcsicmp(dot, L".bat") == 0 || _wcsicmp(dot, L".cmd") == 0 ||
1710 _wcsicmp(dot, L".exe") == 0 || _wcsicmp(dot, L".com") == 0)
1711 result->st_mode |= 0111;
1712 }
1713 return 0;
Brian Curtinf5e76d02010-11-24 13:14:05 +00001714}
1715
1716static int
Steve Dowercc16be82016-09-08 10:35:16 -07001717win32_xstat(const wchar_t *path, struct _Py_stat_struct *result, BOOL traverse)
Brian Curtinf5e76d02010-11-24 13:14:05 +00001718{
Hirokazu Yamamoto427d3142010-12-04 10:16:05 +00001719 /* Protocol violation: we explicitly clear errno, instead of
1720 setting it to a POSIX error. Callers should use GetLastError. */
Brian Curtind25aef52011-06-13 15:16:04 -05001721 int code = win32_xstat_impl(path, result, traverse);
Hirokazu Yamamoto427d3142010-12-04 10:16:05 +00001722 errno = 0;
1723 return code;
1724}
Brian Curtind25aef52011-06-13 15:16:04 -05001725/* About the following functions: win32_lstat_w, win32_stat, win32_stat_w
Brian Curtind40e6f72010-07-08 21:39:08 +00001726
1727 In Posix, stat automatically traverses symlinks and returns the stat
1728 structure for the target. In Windows, the equivalent GetFileAttributes by
1729 default does not traverse symlinks and instead returns attributes for
1730 the symlink.
1731
1732 Therefore, win32_lstat will get the attributes traditionally, and
1733 win32_stat will first explicitly resolve the symlink target and then will
Steve Dowercc16be82016-09-08 10:35:16 -07001734 call win32_lstat on that result. */
Brian Curtind40e6f72010-07-08 21:39:08 +00001735
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00001736static int
Steve Dowercc16be82016-09-08 10:35:16 -07001737win32_lstat(const wchar_t* path, struct _Py_stat_struct *result)
Martin v. Löwis14694662006-02-03 12:54:16 +00001738{
Hirokazu Yamamoto427d3142010-12-04 10:16:05 +00001739 return win32_xstat(path, result, FALSE);
Martin v. Löwis14694662006-02-03 12:54:16 +00001740}
1741
Victor Stinner8c62be82010-05-06 00:08:46 +00001742static int
Steve Dowercc16be82016-09-08 10:35:16 -07001743win32_stat(const wchar_t* path, struct _Py_stat_struct *result)
Brian Curtind40e6f72010-07-08 21:39:08 +00001744{
Hirokazu Yamamoto427d3142010-12-04 10:16:05 +00001745 return win32_xstat(path, result, TRUE);
Brian Curtind40e6f72010-07-08 21:39:08 +00001746}
1747
Martin v. Löwis14694662006-02-03 12:54:16 +00001748#endif /* MS_WINDOWS */
1749
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001750PyDoc_STRVAR(stat_result__doc__,
Larry Hastings9cf065c2012-06-22 16:30:09 -07001751"stat_result: Result from stat, fstat, or lstat.\n\n\
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001752This object may be accessed either as a tuple of\n\
Fred Drakef7ce04d2002-06-20 18:31:21 +00001753 (mode, ino, dev, nlink, uid, gid, size, atime, mtime, ctime)\n\
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001754or via the attributes st_mode, st_ino, st_dev, st_nlink, st_uid, and so on.\n\
1755\n\
Hye-Shik Chang5f937a72005-06-02 13:09:30 +00001756Posix/windows: If your platform supports st_blksize, st_blocks, st_rdev,\n\
1757or st_flags, they are available as attributes only.\n\
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001758\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001759See os.stat for more information.");
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001760
1761static PyStructSequence_Field stat_result_fields[] = {
Victor Stinner8c62be82010-05-06 00:08:46 +00001762 {"st_mode", "protection bits"},
1763 {"st_ino", "inode"},
1764 {"st_dev", "device"},
1765 {"st_nlink", "number of hard links"},
1766 {"st_uid", "user ID of owner"},
1767 {"st_gid", "group ID of owner"},
1768 {"st_size", "total size, in bytes"},
1769 /* The NULL is replaced with PyStructSequence_UnnamedField later. */
1770 {NULL, "integer time of last access"},
1771 {NULL, "integer time of last modification"},
1772 {NULL, "integer time of last change"},
1773 {"st_atime", "time of last access"},
1774 {"st_mtime", "time of last modification"},
1775 {"st_ctime", "time of last change"},
Larry Hastings6fe20b32012-04-19 15:07:49 -07001776 {"st_atime_ns", "time of last access in nanoseconds"},
1777 {"st_mtime_ns", "time of last modification in nanoseconds"},
1778 {"st_ctime_ns", "time of last change in nanoseconds"},
Martin v. Löwis60a5d722002-10-16 20:28:25 +00001779#ifdef HAVE_STRUCT_STAT_ST_BLKSIZE
Victor Stinner8c62be82010-05-06 00:08:46 +00001780 {"st_blksize", "blocksize for filesystem I/O"},
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001781#endif
Martin v. Löwis60a5d722002-10-16 20:28:25 +00001782#ifdef HAVE_STRUCT_STAT_ST_BLOCKS
Victor Stinner8c62be82010-05-06 00:08:46 +00001783 {"st_blocks", "number of blocks allocated"},
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001784#endif
Martin v. Löwis60a5d722002-10-16 20:28:25 +00001785#ifdef HAVE_STRUCT_STAT_ST_RDEV
Victor Stinner8c62be82010-05-06 00:08:46 +00001786 {"st_rdev", "device type (if inode device)"},
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001787#endif
Hye-Shik Chang5f937a72005-06-02 13:09:30 +00001788#ifdef HAVE_STRUCT_STAT_ST_FLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +00001789 {"st_flags", "user defined flags for file"},
Hye-Shik Chang5f937a72005-06-02 13:09:30 +00001790#endif
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00001791#ifdef HAVE_STRUCT_STAT_ST_GEN
Victor Stinner8c62be82010-05-06 00:08:46 +00001792 {"st_gen", "generation number"},
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00001793#endif
1794#ifdef HAVE_STRUCT_STAT_ST_BIRTHTIME
Victor Stinner8c62be82010-05-06 00:08:46 +00001795 {"st_birthtime", "time of creation"},
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00001796#endif
Zachary Ware63f277b2014-06-19 09:46:37 -05001797#ifdef HAVE_STRUCT_STAT_ST_FILE_ATTRIBUTES
1798 {"st_file_attributes", "Windows file attribute bits"},
1799#endif
jcea6c51d512018-01-28 14:00:08 +01001800#ifdef HAVE_STRUCT_STAT_ST_FSTYPE
1801 {"st_fstype", "Type of filesystem"},
1802#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00001803 {0}
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001804};
1805
Martin v. Löwis60a5d722002-10-16 20:28:25 +00001806#ifdef HAVE_STRUCT_STAT_ST_BLKSIZE
Larry Hastings6fe20b32012-04-19 15:07:49 -07001807#define ST_BLKSIZE_IDX 16
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001808#else
Larry Hastings6fe20b32012-04-19 15:07:49 -07001809#define ST_BLKSIZE_IDX 15
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001810#endif
1811
Martin v. Löwis60a5d722002-10-16 20:28:25 +00001812#ifdef HAVE_STRUCT_STAT_ST_BLOCKS
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001813#define ST_BLOCKS_IDX (ST_BLKSIZE_IDX+1)
1814#else
1815#define ST_BLOCKS_IDX ST_BLKSIZE_IDX
1816#endif
1817
Martin v. Löwis60a5d722002-10-16 20:28:25 +00001818#ifdef HAVE_STRUCT_STAT_ST_RDEV
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001819#define ST_RDEV_IDX (ST_BLOCKS_IDX+1)
1820#else
1821#define ST_RDEV_IDX ST_BLOCKS_IDX
1822#endif
1823
Hye-Shik Chang5f937a72005-06-02 13:09:30 +00001824#ifdef HAVE_STRUCT_STAT_ST_FLAGS
1825#define ST_FLAGS_IDX (ST_RDEV_IDX+1)
1826#else
1827#define ST_FLAGS_IDX ST_RDEV_IDX
1828#endif
1829
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00001830#ifdef HAVE_STRUCT_STAT_ST_GEN
Martin v. Löwisf09582e2005-08-14 21:42:34 +00001831#define ST_GEN_IDX (ST_FLAGS_IDX+1)
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00001832#else
Martin v. Löwisf09582e2005-08-14 21:42:34 +00001833#define ST_GEN_IDX ST_FLAGS_IDX
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00001834#endif
1835
1836#ifdef HAVE_STRUCT_STAT_ST_BIRTHTIME
1837#define ST_BIRTHTIME_IDX (ST_GEN_IDX+1)
1838#else
1839#define ST_BIRTHTIME_IDX ST_GEN_IDX
1840#endif
1841
Zachary Ware63f277b2014-06-19 09:46:37 -05001842#ifdef HAVE_STRUCT_STAT_ST_FILE_ATTRIBUTES
1843#define ST_FILE_ATTRIBUTES_IDX (ST_BIRTHTIME_IDX+1)
1844#else
1845#define ST_FILE_ATTRIBUTES_IDX ST_BIRTHTIME_IDX
1846#endif
1847
jcea6c51d512018-01-28 14:00:08 +01001848#ifdef HAVE_STRUCT_STAT_ST_FSTYPE
1849#define ST_FSTYPE_IDX (ST_FILE_ATTRIBUTES_IDX+1)
1850#else
1851#define ST_FSTYPE_IDX ST_FILE_ATTRIBUTES_IDX
1852#endif
1853
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001854static PyStructSequence_Desc stat_result_desc = {
Victor Stinner8c62be82010-05-06 00:08:46 +00001855 "stat_result", /* name */
1856 stat_result__doc__, /* doc */
1857 stat_result_fields,
1858 10
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001859};
1860
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001861PyDoc_STRVAR(statvfs_result__doc__,
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001862"statvfs_result: Result from statvfs or fstatvfs.\n\n\
1863This object may be accessed either as a tuple of\n\
Fred Drakef7ce04d2002-06-20 18:31:21 +00001864 (bsize, frsize, blocks, bfree, bavail, files, ffree, favail, flag, namemax),\n\
Guido van Rossuma4dc73e2001-10-18 20:53:15 +00001865or via the attributes f_bsize, f_frsize, f_blocks, f_bfree, and so on.\n\
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001866\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001867See os.statvfs for more information.");
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001868
1869static PyStructSequence_Field statvfs_result_fields[] = {
Victor Stinner8c62be82010-05-06 00:08:46 +00001870 {"f_bsize", },
1871 {"f_frsize", },
1872 {"f_blocks", },
1873 {"f_bfree", },
1874 {"f_bavail", },
1875 {"f_files", },
1876 {"f_ffree", },
1877 {"f_favail", },
1878 {"f_flag", },
1879 {"f_namemax",},
Giuseppe Scrivano96a5e502017-12-14 23:46:46 +01001880 {"f_fsid", },
Victor Stinner8c62be82010-05-06 00:08:46 +00001881 {0}
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001882};
1883
1884static PyStructSequence_Desc statvfs_result_desc = {
Victor Stinner8c62be82010-05-06 00:08:46 +00001885 "statvfs_result", /* name */
1886 statvfs_result__doc__, /* doc */
1887 statvfs_result_fields,
1888 10
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001889};
1890
Ross Lagerwall7807c352011-03-17 20:20:30 +02001891#if defined(HAVE_WAITID) && !defined(__APPLE__)
1892PyDoc_STRVAR(waitid_result__doc__,
1893"waitid_result: Result from waitid.\n\n\
1894This object may be accessed either as a tuple of\n\
1895 (si_pid, si_uid, si_signo, si_status, si_code),\n\
1896or via the attributes si_pid, si_uid, and so on.\n\
1897\n\
1898See os.waitid for more information.");
1899
1900static PyStructSequence_Field waitid_result_fields[] = {
1901 {"si_pid", },
1902 {"si_uid", },
1903 {"si_signo", },
1904 {"si_status", },
1905 {"si_code", },
1906 {0}
1907};
1908
1909static PyStructSequence_Desc waitid_result_desc = {
1910 "waitid_result", /* name */
1911 waitid_result__doc__, /* doc */
1912 waitid_result_fields,
1913 5
1914};
1915static PyTypeObject WaitidResultType;
1916#endif
1917
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001918static int initialized;
Guido van Rossum98bf58f2001-10-18 20:34:25 +00001919static PyTypeObject StatResultType;
1920static PyTypeObject StatVFSResultType;
Benjamin Petersonbad9c2f2011-08-02 18:42:14 -05001921#if defined(HAVE_SCHED_SETPARAM) || defined(HAVE_SCHED_SETSCHEDULER)
Benjamin Peterson94b580d2011-08-02 17:30:04 -05001922static PyTypeObject SchedParamType;
Benjamin Petersonbad9c2f2011-08-02 18:42:14 -05001923#endif
Martin v. Löwisf607bda2002-10-16 18:27:39 +00001924static newfunc structseq_new;
1925
1926static PyObject *
1927statresult_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
1928{
Victor Stinner8c62be82010-05-06 00:08:46 +00001929 PyStructSequence *result;
1930 int i;
Martin v. Löwisf607bda2002-10-16 18:27:39 +00001931
Victor Stinner8c62be82010-05-06 00:08:46 +00001932 result = (PyStructSequence*)structseq_new(type, args, kwds);
1933 if (!result)
1934 return NULL;
1935 /* If we have been initialized from a tuple,
1936 st_?time might be set to None. Initialize it
1937 from the int slots. */
1938 for (i = 7; i <= 9; i++) {
1939 if (result->ob_item[i+3] == Py_None) {
1940 Py_DECREF(Py_None);
1941 Py_INCREF(result->ob_item[i]);
1942 result->ob_item[i+3] = result->ob_item[i];
1943 }
1944 }
1945 return (PyObject*)result;
Martin v. Löwisf607bda2002-10-16 18:27:39 +00001946}
1947
1948
Larry Hastings6fe20b32012-04-19 15:07:49 -07001949static PyObject *billion = NULL;
1950
Martin v. Löwis94717ed2002-09-09 14:24:16 +00001951static void
Victor Stinner4195b5c2012-02-08 23:03:19 +01001952fill_time(PyObject *v, int index, time_t sec, unsigned long nsec)
Martin v. Löwis94717ed2002-09-09 14:24:16 +00001953{
Larry Hastings6fe20b32012-04-19 15:07:49 -07001954 PyObject *s = _PyLong_FromTime_t(sec);
1955 PyObject *ns_fractional = PyLong_FromUnsignedLong(nsec);
1956 PyObject *s_in_ns = NULL;
1957 PyObject *ns_total = NULL;
1958 PyObject *float_s = NULL;
1959
1960 if (!(s && ns_fractional))
1961 goto exit;
1962
1963 s_in_ns = PyNumber_Multiply(s, billion);
1964 if (!s_in_ns)
1965 goto exit;
1966
1967 ns_total = PyNumber_Add(s_in_ns, ns_fractional);
1968 if (!ns_total)
1969 goto exit;
1970
Victor Stinner01b5aab2017-10-24 02:02:00 -07001971 float_s = PyFloat_FromDouble(sec + 1e-9*nsec);
1972 if (!float_s) {
1973 goto exit;
Larry Hastings6fe20b32012-04-19 15:07:49 -07001974 }
1975
1976 PyStructSequence_SET_ITEM(v, index, s);
1977 PyStructSequence_SET_ITEM(v, index+3, float_s);
1978 PyStructSequence_SET_ITEM(v, index+6, ns_total);
1979 s = NULL;
1980 float_s = NULL;
1981 ns_total = NULL;
1982exit:
1983 Py_XDECREF(s);
1984 Py_XDECREF(ns_fractional);
1985 Py_XDECREF(s_in_ns);
1986 Py_XDECREF(ns_total);
1987 Py_XDECREF(float_s);
Martin v. Löwis94717ed2002-09-09 14:24:16 +00001988}
1989
Tim Peters5aa91602002-01-30 05:46:57 +00001990/* pack a system stat C structure into the Python stat tuple
Fred Drake699f3522000-06-29 21:12:41 +00001991 (used by posix_stat() and posix_fstat()) */
1992static PyObject*
Victor Stinner4195b5c2012-02-08 23:03:19 +01001993_pystat_fromstructstat(STRUCT_STAT *st)
Fred Drake699f3522000-06-29 21:12:41 +00001994{
Victor Stinner8c62be82010-05-06 00:08:46 +00001995 unsigned long ansec, mnsec, cnsec;
1996 PyObject *v = PyStructSequence_New(&StatResultType);
1997 if (v == NULL)
1998 return NULL;
Fred Drake699f3522000-06-29 21:12:41 +00001999
Victor Stinner8c62be82010-05-06 00:08:46 +00002000 PyStructSequence_SET_ITEM(v, 0, PyLong_FromLong((long)st->st_mode));
Victor Stinner0f6d7332017-03-09 17:34:28 +01002001 Py_BUILD_ASSERT(sizeof(unsigned long long) >= sizeof(st->st_ino));
xdegaye50e86032017-05-22 11:15:08 +02002002 PyStructSequence_SET_ITEM(v, 1, PyLong_FromUnsignedLongLong(st->st_ino));
Serhiy Storchaka404fa922013-01-02 18:22:23 +02002003#ifdef MS_WINDOWS
2004 PyStructSequence_SET_ITEM(v, 2, PyLong_FromUnsignedLong(st->st_dev));
Fred Drake699f3522000-06-29 21:12:41 +00002005#else
Serhiy Storchakab2653b32015-01-18 11:12:11 +02002006 PyStructSequence_SET_ITEM(v, 2, _PyLong_FromDev(st->st_dev));
Fred Drake699f3522000-06-29 21:12:41 +00002007#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00002008 PyStructSequence_SET_ITEM(v, 3, PyLong_FromLong((long)st->st_nlink));
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02002009#if defined(MS_WINDOWS)
2010 PyStructSequence_SET_ITEM(v, 4, PyLong_FromLong(0));
2011 PyStructSequence_SET_ITEM(v, 5, PyLong_FromLong(0));
2012#else
2013 PyStructSequence_SET_ITEM(v, 4, _PyLong_FromUid(st->st_uid));
2014 PyStructSequence_SET_ITEM(v, 5, _PyLong_FromGid(st->st_gid));
2015#endif
xdegaye50e86032017-05-22 11:15:08 +02002016 Py_BUILD_ASSERT(sizeof(long long) >= sizeof(st->st_size));
2017 PyStructSequence_SET_ITEM(v, 6, PyLong_FromLongLong(st->st_size));
Martin v. Löwis94717ed2002-09-09 14:24:16 +00002018
Martin v. Löwis14694662006-02-03 12:54:16 +00002019#if defined(HAVE_STAT_TV_NSEC)
Victor Stinner8c62be82010-05-06 00:08:46 +00002020 ansec = st->st_atim.tv_nsec;
2021 mnsec = st->st_mtim.tv_nsec;
2022 cnsec = st->st_ctim.tv_nsec;
Martin v. Löwis14694662006-02-03 12:54:16 +00002023#elif defined(HAVE_STAT_TV_NSEC2)
Victor Stinner8c62be82010-05-06 00:08:46 +00002024 ansec = st->st_atimespec.tv_nsec;
2025 mnsec = st->st_mtimespec.tv_nsec;
2026 cnsec = st->st_ctimespec.tv_nsec;
Martin v. Löwis14694662006-02-03 12:54:16 +00002027#elif defined(HAVE_STAT_NSEC)
Victor Stinner8c62be82010-05-06 00:08:46 +00002028 ansec = st->st_atime_nsec;
2029 mnsec = st->st_mtime_nsec;
2030 cnsec = st->st_ctime_nsec;
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002031#else
Victor Stinner8c62be82010-05-06 00:08:46 +00002032 ansec = mnsec = cnsec = 0;
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002033#endif
Victor Stinner4195b5c2012-02-08 23:03:19 +01002034 fill_time(v, 7, st->st_atime, ansec);
2035 fill_time(v, 8, st->st_mtime, mnsec);
2036 fill_time(v, 9, st->st_ctime, cnsec);
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002037
Martin v. Löwis60a5d722002-10-16 20:28:25 +00002038#ifdef HAVE_STRUCT_STAT_ST_BLKSIZE
Victor Stinner8c62be82010-05-06 00:08:46 +00002039 PyStructSequence_SET_ITEM(v, ST_BLKSIZE_IDX,
2040 PyLong_FromLong((long)st->st_blksize));
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002041#endif
Martin v. Löwis60a5d722002-10-16 20:28:25 +00002042#ifdef HAVE_STRUCT_STAT_ST_BLOCKS
Victor Stinner8c62be82010-05-06 00:08:46 +00002043 PyStructSequence_SET_ITEM(v, ST_BLOCKS_IDX,
2044 PyLong_FromLong((long)st->st_blocks));
Guido van Rossum98bf58f2001-10-18 20:34:25 +00002045#endif
Martin v. Löwis60a5d722002-10-16 20:28:25 +00002046#ifdef HAVE_STRUCT_STAT_ST_RDEV
Victor Stinner8c62be82010-05-06 00:08:46 +00002047 PyStructSequence_SET_ITEM(v, ST_RDEV_IDX,
2048 PyLong_FromLong((long)st->st_rdev));
Fred Drake699f3522000-06-29 21:12:41 +00002049#endif
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002050#ifdef HAVE_STRUCT_STAT_ST_GEN
Victor Stinner8c62be82010-05-06 00:08:46 +00002051 PyStructSequence_SET_ITEM(v, ST_GEN_IDX,
2052 PyLong_FromLong((long)st->st_gen));
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002053#endif
2054#ifdef HAVE_STRUCT_STAT_ST_BIRTHTIME
Victor Stinner8c62be82010-05-06 00:08:46 +00002055 {
Victor Stinner4195b5c2012-02-08 23:03:19 +01002056 PyObject *val;
2057 unsigned long bsec,bnsec;
2058 bsec = (long)st->st_birthtime;
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002059#ifdef HAVE_STAT_TV_NSEC2
Victor Stinner4195b5c2012-02-08 23:03:19 +01002060 bnsec = st->st_birthtimespec.tv_nsec;
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002061#else
Victor Stinner4195b5c2012-02-08 23:03:19 +01002062 bnsec = 0;
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002063#endif
Victor Stinner01b5aab2017-10-24 02:02:00 -07002064 val = PyFloat_FromDouble(bsec + 1e-9*bnsec);
Victor Stinner4195b5c2012-02-08 23:03:19 +01002065 PyStructSequence_SET_ITEM(v, ST_BIRTHTIME_IDX,
2066 val);
Victor Stinner8c62be82010-05-06 00:08:46 +00002067 }
Martin v. Löwisebd9d5b2005-08-09 15:00:59 +00002068#endif
Hye-Shik Chang5f937a72005-06-02 13:09:30 +00002069#ifdef HAVE_STRUCT_STAT_ST_FLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +00002070 PyStructSequence_SET_ITEM(v, ST_FLAGS_IDX,
2071 PyLong_FromLong((long)st->st_flags));
Hye-Shik Chang5f937a72005-06-02 13:09:30 +00002072#endif
Zachary Ware63f277b2014-06-19 09:46:37 -05002073#ifdef HAVE_STRUCT_STAT_ST_FILE_ATTRIBUTES
2074 PyStructSequence_SET_ITEM(v, ST_FILE_ATTRIBUTES_IDX,
2075 PyLong_FromUnsignedLong(st->st_file_attributes));
2076#endif
jcea6c51d512018-01-28 14:00:08 +01002077#ifdef HAVE_STRUCT_STAT_ST_FSTYPE
2078 PyStructSequence_SET_ITEM(v, ST_FSTYPE_IDX,
2079 PyUnicode_FromString(st->st_fstype));
2080#endif
Fred Drake699f3522000-06-29 21:12:41 +00002081
Victor Stinner8c62be82010-05-06 00:08:46 +00002082 if (PyErr_Occurred()) {
2083 Py_DECREF(v);
2084 return NULL;
2085 }
Fred Drake699f3522000-06-29 21:12:41 +00002086
Victor Stinner8c62be82010-05-06 00:08:46 +00002087 return v;
Fred Drake699f3522000-06-29 21:12:41 +00002088}
2089
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002090/* POSIX methods */
2091
Guido van Rossum94f6f721999-01-06 18:42:14 +00002092
2093static PyObject *
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02002094posix_do_stat(const char *function_name, path_t *path,
Larry Hastings9cf065c2012-06-22 16:30:09 -07002095 int dir_fd, int follow_symlinks)
Guido van Rossum94f6f721999-01-06 18:42:14 +00002096{
Larry Hastings9cf065c2012-06-22 16:30:09 -07002097 STRUCT_STAT st;
2098 int result;
2099
2100#if !defined(MS_WINDOWS) && !defined(HAVE_FSTATAT) && !defined(HAVE_LSTAT)
2101 if (follow_symlinks_specified(function_name, follow_symlinks))
2102 return NULL;
2103#endif
2104
2105 if (path_and_dir_fd_invalid("stat", path, dir_fd) ||
2106 dir_fd_and_fd_invalid("stat", dir_fd, path->fd) ||
2107 fd_and_follow_symlinks_invalid("stat", path->fd, follow_symlinks))
2108 return NULL;
2109
2110 Py_BEGIN_ALLOW_THREADS
2111 if (path->fd != -1)
2112 result = FSTAT(path->fd, &st);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002113#ifdef MS_WINDOWS
Steve Dower513d7472016-09-08 10:41:50 -07002114 else if (follow_symlinks)
Steve Dowercc16be82016-09-08 10:35:16 -07002115 result = win32_stat(path->wide, &st);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002116 else
Steve Dowercc16be82016-09-08 10:35:16 -07002117 result = win32_lstat(path->wide, &st);
2118#else
2119 else
2120#if defined(HAVE_LSTAT)
Larry Hastings9cf065c2012-06-22 16:30:09 -07002121 if ((!follow_symlinks) && (dir_fd == DEFAULT_DIR_FD))
2122 result = LSTAT(path->narrow, &st);
2123 else
Steve Dowercc16be82016-09-08 10:35:16 -07002124#endif /* HAVE_LSTAT */
Larry Hastings9cf065c2012-06-22 16:30:09 -07002125#ifdef HAVE_FSTATAT
2126 if ((dir_fd != DEFAULT_DIR_FD) || !follow_symlinks)
2127 result = fstatat(dir_fd, path->narrow, &st,
2128 follow_symlinks ? 0 : AT_SYMLINK_NOFOLLOW);
2129 else
Steve Dowercc16be82016-09-08 10:35:16 -07002130#endif /* HAVE_FSTATAT */
Larry Hastings9cf065c2012-06-22 16:30:09 -07002131 result = STAT(path->narrow, &st);
Steve Dowercc16be82016-09-08 10:35:16 -07002132#endif /* MS_WINDOWS */
Larry Hastings9cf065c2012-06-22 16:30:09 -07002133 Py_END_ALLOW_THREADS
2134
Victor Stinner292c8352012-10-30 02:17:38 +01002135 if (result != 0) {
2136 return path_error(path);
2137 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07002138
2139 return _pystat_fromstructstat(&st);
2140}
2141
Larry Hastings2f936352014-08-05 14:04:04 +10002142/*[python input]
2143
2144for s in """
2145
2146FACCESSAT
2147FCHMODAT
2148FCHOWNAT
2149FSTATAT
2150LINKAT
2151MKDIRAT
2152MKFIFOAT
2153MKNODAT
2154OPENAT
2155READLINKAT
2156SYMLINKAT
2157UNLINKAT
2158
2159""".strip().split():
2160 s = s.strip()
2161 print("""
2162#ifdef HAVE_{s}
2163 #define {s}_DIR_FD_CONVERTER dir_fd_converter
Larry Hastings31826802013-10-19 00:09:25 -07002164#else
Larry Hastings2f936352014-08-05 14:04:04 +10002165 #define {s}_DIR_FD_CONVERTER dir_fd_unavailable
Larry Hastings31826802013-10-19 00:09:25 -07002166#endif
Larry Hastings2f936352014-08-05 14:04:04 +10002167""".rstrip().format(s=s))
2168
2169for s in """
2170
2171FCHDIR
2172FCHMOD
2173FCHOWN
2174FDOPENDIR
2175FEXECVE
2176FPATHCONF
2177FSTATVFS
2178FTRUNCATE
2179
2180""".strip().split():
2181 s = s.strip()
2182 print("""
2183#ifdef HAVE_{s}
2184 #define PATH_HAVE_{s} 1
2185#else
2186 #define PATH_HAVE_{s} 0
2187#endif
2188
2189""".rstrip().format(s=s))
2190[python start generated code]*/
2191
2192#ifdef HAVE_FACCESSAT
2193 #define FACCESSAT_DIR_FD_CONVERTER dir_fd_converter
2194#else
2195 #define FACCESSAT_DIR_FD_CONVERTER dir_fd_unavailable
2196#endif
2197
2198#ifdef HAVE_FCHMODAT
2199 #define FCHMODAT_DIR_FD_CONVERTER dir_fd_converter
2200#else
2201 #define FCHMODAT_DIR_FD_CONVERTER dir_fd_unavailable
2202#endif
2203
2204#ifdef HAVE_FCHOWNAT
2205 #define FCHOWNAT_DIR_FD_CONVERTER dir_fd_converter
2206#else
2207 #define FCHOWNAT_DIR_FD_CONVERTER dir_fd_unavailable
2208#endif
2209
2210#ifdef HAVE_FSTATAT
2211 #define FSTATAT_DIR_FD_CONVERTER dir_fd_converter
2212#else
2213 #define FSTATAT_DIR_FD_CONVERTER dir_fd_unavailable
2214#endif
2215
2216#ifdef HAVE_LINKAT
2217 #define LINKAT_DIR_FD_CONVERTER dir_fd_converter
2218#else
2219 #define LINKAT_DIR_FD_CONVERTER dir_fd_unavailable
2220#endif
2221
2222#ifdef HAVE_MKDIRAT
2223 #define MKDIRAT_DIR_FD_CONVERTER dir_fd_converter
2224#else
2225 #define MKDIRAT_DIR_FD_CONVERTER dir_fd_unavailable
2226#endif
2227
2228#ifdef HAVE_MKFIFOAT
2229 #define MKFIFOAT_DIR_FD_CONVERTER dir_fd_converter
2230#else
2231 #define MKFIFOAT_DIR_FD_CONVERTER dir_fd_unavailable
2232#endif
2233
2234#ifdef HAVE_MKNODAT
2235 #define MKNODAT_DIR_FD_CONVERTER dir_fd_converter
2236#else
2237 #define MKNODAT_DIR_FD_CONVERTER dir_fd_unavailable
2238#endif
2239
2240#ifdef HAVE_OPENAT
2241 #define OPENAT_DIR_FD_CONVERTER dir_fd_converter
2242#else
2243 #define OPENAT_DIR_FD_CONVERTER dir_fd_unavailable
2244#endif
2245
2246#ifdef HAVE_READLINKAT
2247 #define READLINKAT_DIR_FD_CONVERTER dir_fd_converter
2248#else
2249 #define READLINKAT_DIR_FD_CONVERTER dir_fd_unavailable
2250#endif
2251
2252#ifdef HAVE_SYMLINKAT
2253 #define SYMLINKAT_DIR_FD_CONVERTER dir_fd_converter
2254#else
2255 #define SYMLINKAT_DIR_FD_CONVERTER dir_fd_unavailable
2256#endif
2257
2258#ifdef HAVE_UNLINKAT
2259 #define UNLINKAT_DIR_FD_CONVERTER dir_fd_converter
2260#else
2261 #define UNLINKAT_DIR_FD_CONVERTER dir_fd_unavailable
2262#endif
2263
2264#ifdef HAVE_FCHDIR
2265 #define PATH_HAVE_FCHDIR 1
2266#else
2267 #define PATH_HAVE_FCHDIR 0
2268#endif
2269
2270#ifdef HAVE_FCHMOD
2271 #define PATH_HAVE_FCHMOD 1
2272#else
2273 #define PATH_HAVE_FCHMOD 0
2274#endif
2275
2276#ifdef HAVE_FCHOWN
2277 #define PATH_HAVE_FCHOWN 1
2278#else
2279 #define PATH_HAVE_FCHOWN 0
2280#endif
2281
2282#ifdef HAVE_FDOPENDIR
2283 #define PATH_HAVE_FDOPENDIR 1
2284#else
2285 #define PATH_HAVE_FDOPENDIR 0
2286#endif
2287
2288#ifdef HAVE_FEXECVE
2289 #define PATH_HAVE_FEXECVE 1
2290#else
2291 #define PATH_HAVE_FEXECVE 0
2292#endif
2293
2294#ifdef HAVE_FPATHCONF
2295 #define PATH_HAVE_FPATHCONF 1
2296#else
2297 #define PATH_HAVE_FPATHCONF 0
2298#endif
2299
2300#ifdef HAVE_FSTATVFS
2301 #define PATH_HAVE_FSTATVFS 1
2302#else
2303 #define PATH_HAVE_FSTATVFS 0
2304#endif
2305
2306#ifdef HAVE_FTRUNCATE
2307 #define PATH_HAVE_FTRUNCATE 1
2308#else
2309 #define PATH_HAVE_FTRUNCATE 0
2310#endif
2311/*[python end generated code: output=4bd4f6f7d41267f1 input=80b4c890b6774ea5]*/
Larry Hastings31826802013-10-19 00:09:25 -07002312
Steve Dowerfe0a41a2015-03-20 19:50:46 -07002313#ifdef MS_WINDOWS
2314 #undef PATH_HAVE_FTRUNCATE
2315 #define PATH_HAVE_FTRUNCATE 1
2316#endif
Larry Hastings31826802013-10-19 00:09:25 -07002317
Larry Hastings61272b72014-01-07 12:41:53 -08002318/*[python input]
Larry Hastings31826802013-10-19 00:09:25 -07002319
2320class path_t_converter(CConverter):
2321
2322 type = "path_t"
2323 impl_by_reference = True
2324 parse_by_reference = True
2325
2326 converter = 'path_converter'
2327
2328 def converter_init(self, *, allow_fd=False, nullable=False):
Larry Hastings31826802013-10-19 00:09:25 -07002329 # right now path_t doesn't support default values.
2330 # to support a default value, you'll need to override initialize().
Larry Hastings2f936352014-08-05 14:04:04 +10002331 if self.default not in (unspecified, None):
Larry Hastings7726ac92014-01-31 22:03:12 -08002332 fail("Can't specify a default to the path_t converter!")
Larry Hastings31826802013-10-19 00:09:25 -07002333
Larry Hastings2f936352014-08-05 14:04:04 +10002334 if self.c_default not in (None, 'Py_None'):
2335 raise RuntimeError("Can't specify a c_default to the path_t converter!")
Larry Hastings31826802013-10-19 00:09:25 -07002336
2337 self.nullable = nullable
2338 self.allow_fd = allow_fd
2339
Larry Hastings7726ac92014-01-31 22:03:12 -08002340 def pre_render(self):
2341 def strify(value):
Larry Hastings2f936352014-08-05 14:04:04 +10002342 if isinstance(value, str):
2343 return value
Larry Hastings7726ac92014-01-31 22:03:12 -08002344 return str(int(bool(value)))
2345
2346 # add self.py_name here when merging with posixmodule conversion
Larry Hastings2f936352014-08-05 14:04:04 +10002347 self.c_default = 'PATH_T_INITIALIZE("{}", "{}", {}, {})'.format(
Larry Hastings31826802013-10-19 00:09:25 -07002348 self.function.name,
Larry Hastings2f936352014-08-05 14:04:04 +10002349 self.name,
Larry Hastings7726ac92014-01-31 22:03:12 -08002350 strify(self.nullable),
2351 strify(self.allow_fd),
Larry Hastings31826802013-10-19 00:09:25 -07002352 )
2353
2354 def cleanup(self):
2355 return "path_cleanup(&" + self.name + ");\n"
2356
2357
2358class dir_fd_converter(CConverter):
2359 type = 'int'
Larry Hastings31826802013-10-19 00:09:25 -07002360
Larry Hastings2f936352014-08-05 14:04:04 +10002361 def converter_init(self, requires=None):
Larry Hastings31826802013-10-19 00:09:25 -07002362 if self.default in (unspecified, None):
2363 self.c_default = 'DEFAULT_DIR_FD'
Larry Hastings2f936352014-08-05 14:04:04 +10002364 if isinstance(requires, str):
2365 self.converter = requires.upper() + '_DIR_FD_CONVERTER'
2366 else:
2367 self.converter = 'dir_fd_converter'
Larry Hastings31826802013-10-19 00:09:25 -07002368
Larry Hastings2f936352014-08-05 14:04:04 +10002369class fildes_converter(CConverter):
2370 type = 'int'
2371 converter = 'fildes_converter'
2372
2373class uid_t_converter(CConverter):
2374 type = "uid_t"
2375 converter = '_Py_Uid_Converter'
2376
2377class gid_t_converter(CConverter):
2378 type = "gid_t"
2379 converter = '_Py_Gid_Converter'
2380
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +02002381class dev_t_converter(CConverter):
2382 type = 'dev_t'
2383 converter = '_Py_Dev_Converter'
2384
2385class dev_t_return_converter(unsigned_long_return_converter):
2386 type = 'dev_t'
2387 conversion_fn = '_PyLong_FromDev'
2388 unsigned_cast = '(dev_t)'
2389
Larry Hastings2f936352014-08-05 14:04:04 +10002390class FSConverter_converter(CConverter):
2391 type = 'PyObject *'
2392 converter = 'PyUnicode_FSConverter'
2393 def converter_init(self):
2394 if self.default is not unspecified:
2395 fail("FSConverter_converter does not support default values")
2396 self.c_default = 'NULL'
2397
2398 def cleanup(self):
2399 return "Py_XDECREF(" + self.name + ");\n"
2400
2401class pid_t_converter(CConverter):
2402 type = 'pid_t'
2403 format_unit = '" _Py_PARSE_PID "'
2404
2405class idtype_t_converter(int_converter):
2406 type = 'idtype_t'
2407
2408class id_t_converter(CConverter):
2409 type = 'id_t'
2410 format_unit = '" _Py_PARSE_PID "'
2411
Benjamin Petersonca470632016-09-06 13:47:26 -07002412class intptr_t_converter(CConverter):
2413 type = 'intptr_t'
Larry Hastings2f936352014-08-05 14:04:04 +10002414 format_unit = '" _Py_PARSE_INTPTR "'
2415
2416class Py_off_t_converter(CConverter):
2417 type = 'Py_off_t'
2418 converter = 'Py_off_t_converter'
2419
2420class Py_off_t_return_converter(long_return_converter):
2421 type = 'Py_off_t'
2422 conversion_fn = 'PyLong_FromPy_off_t'
2423
2424class path_confname_converter(CConverter):
2425 type="int"
2426 converter="conv_path_confname"
2427
2428class confstr_confname_converter(path_confname_converter):
2429 converter='conv_confstr_confname'
2430
2431class sysconf_confname_converter(path_confname_converter):
2432 converter="conv_sysconf_confname"
2433
2434class sched_param_converter(CConverter):
2435 type = 'struct sched_param'
2436 converter = 'convert_sched_param'
2437 impl_by_reference = True;
Larry Hastings31826802013-10-19 00:09:25 -07002438
Larry Hastings61272b72014-01-07 12:41:53 -08002439[python start generated code]*/
Victor Stinner581139c2016-09-06 15:54:20 -07002440/*[python end generated code: output=da39a3ee5e6b4b0d input=418fce0e01144461]*/
Larry Hastings31826802013-10-19 00:09:25 -07002441
Larry Hastings61272b72014-01-07 12:41:53 -08002442/*[clinic input]
Larry Hastings31826802013-10-19 00:09:25 -07002443
Larry Hastings2a727912014-01-16 11:32:01 -08002444os.stat
Larry Hastings31826802013-10-19 00:09:25 -07002445
2446 path : path_t(allow_fd=True)
Xiang Zhang4459e002017-01-22 13:04:17 +08002447 Path to be examined; can be string, bytes, path-like object or
2448 open-file-descriptor int.
Larry Hastings31826802013-10-19 00:09:25 -07002449
2450 *
2451
Larry Hastings2f936352014-08-05 14:04:04 +10002452 dir_fd : dir_fd(requires='fstatat') = None
Larry Hastings31826802013-10-19 00:09:25 -07002453 If not None, it should be a file descriptor open to a directory,
2454 and path should be a relative string; path will then be relative to
2455 that directory.
2456
2457 follow_symlinks: bool = True
2458 If False, and the last element of the path is a symbolic link,
2459 stat will examine the symbolic link itself instead of the file
2460 the link points to.
2461
2462Perform a stat system call on the given path.
2463
2464dir_fd and follow_symlinks may not be implemented
2465 on your platform. If they are unavailable, using them will raise a
2466 NotImplementedError.
2467
2468It's an error to use dir_fd or follow_symlinks when specifying path as
2469 an open file descriptor.
2470
Larry Hastings61272b72014-01-07 12:41:53 -08002471[clinic start generated code]*/
Larry Hastings31826802013-10-19 00:09:25 -07002472
Larry Hastings31826802013-10-19 00:09:25 -07002473static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002474os_stat_impl(PyObject *module, path_t *path, int dir_fd, int follow_symlinks)
Xiang Zhang4459e002017-01-22 13:04:17 +08002475/*[clinic end generated code: output=7d4976e6f18a59c5 input=270bd64e7bb3c8f7]*/
Larry Hastings31826802013-10-19 00:09:25 -07002476{
2477 return posix_do_stat("stat", path, dir_fd, follow_symlinks);
2478}
2479
Larry Hastings2f936352014-08-05 14:04:04 +10002480
2481/*[clinic input]
2482os.lstat
2483
2484 path : path_t
2485
2486 *
2487
2488 dir_fd : dir_fd(requires='fstatat') = None
2489
2490Perform a stat system call on the given path, without following symbolic links.
2491
2492Like stat(), but do not follow symbolic links.
2493Equivalent to stat(path, follow_symlinks=False).
2494[clinic start generated code]*/
2495
Larry Hastings2f936352014-08-05 14:04:04 +10002496static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002497os_lstat_impl(PyObject *module, path_t *path, int dir_fd)
2498/*[clinic end generated code: output=ef82a5d35ce8ab37 input=0b7474765927b925]*/
Larry Hastings2f936352014-08-05 14:04:04 +10002499{
2500 int follow_symlinks = 0;
2501 return posix_do_stat("lstat", path, dir_fd, follow_symlinks);
2502}
Larry Hastings31826802013-10-19 00:09:25 -07002503
Larry Hastings2f936352014-08-05 14:04:04 +10002504
Larry Hastings61272b72014-01-07 12:41:53 -08002505/*[clinic input]
Larry Hastings2f936352014-08-05 14:04:04 +10002506os.access -> bool
Larry Hastings31826802013-10-19 00:09:25 -07002507
Benjamin Peterson768f3b42016-09-05 15:29:33 -07002508 path: path_t
2509 Path to be tested; can be string or bytes
Larry Hastings31826802013-10-19 00:09:25 -07002510
2511 mode: int
2512 Operating-system mode bitfield. Can be F_OK to test existence,
2513 or the inclusive-OR of R_OK, W_OK, and X_OK.
2514
2515 *
2516
Larry Hastings2f936352014-08-05 14:04:04 +10002517 dir_fd : dir_fd(requires='faccessat') = None
Larry Hastings31826802013-10-19 00:09:25 -07002518 If not None, it should be a file descriptor open to a directory,
2519 and path should be relative; path will then be relative to that
2520 directory.
2521
2522 effective_ids: bool = False
2523 If True, access will use the effective uid/gid instead of
2524 the real uid/gid.
2525
2526 follow_symlinks: bool = True
2527 If False, and the last element of the path is a symbolic link,
2528 access will examine the symbolic link itself instead of the file
2529 the link points to.
2530
2531Use the real uid/gid to test for access to a path.
2532
2533{parameters}
2534dir_fd, effective_ids, and follow_symlinks may not be implemented
2535 on your platform. If they are unavailable, using them will raise a
2536 NotImplementedError.
2537
2538Note that most operations will use the effective uid/gid, therefore this
2539 routine can be used in a suid/sgid environment to test if the invoking user
2540 has the specified access to the path.
2541
Larry Hastings61272b72014-01-07 12:41:53 -08002542[clinic start generated code]*/
Larry Hastings31826802013-10-19 00:09:25 -07002543
Larry Hastings2f936352014-08-05 14:04:04 +10002544static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002545os_access_impl(PyObject *module, path_t *path, int mode, int dir_fd,
Larry Hastings89964c42015-04-14 18:07:59 -04002546 int effective_ids, int follow_symlinks)
Benjamin Peterson768f3b42016-09-05 15:29:33 -07002547/*[clinic end generated code: output=cf84158bc90b1a77 input=8e8c3a6ba791fee3]*/
Larry Hastings31826802013-10-19 00:09:25 -07002548{
Larry Hastings2f936352014-08-05 14:04:04 +10002549 int return_value;
Victor Stinner8c62be82010-05-06 00:08:46 +00002550
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00002551#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00002552 DWORD attr;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002553#else
Larry Hastings9cf065c2012-06-22 16:30:09 -07002554 int result;
Thomas Wouters477c8d52006-05-27 19:21:47 +00002555#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07002556
Larry Hastings9cf065c2012-06-22 16:30:09 -07002557#ifndef HAVE_FACCESSAT
2558 if (follow_symlinks_specified("access", follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10002559 return -1;
Larry Hastings9cf065c2012-06-22 16:30:09 -07002560
2561 if (effective_ids) {
2562 argument_unavailable_error("access", "effective_ids");
Larry Hastings2f936352014-08-05 14:04:04 +10002563 return -1;
Larry Hastings9cf065c2012-06-22 16:30:09 -07002564 }
2565#endif
2566
2567#ifdef MS_WINDOWS
2568 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07002569 attr = GetFileAttributesW(path->wide);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002570 Py_END_ALLOW_THREADS
2571
2572 /*
Georg Brandlf7875592012-06-24 13:58:31 +02002573 * Access is possible if
Larry Hastings9cf065c2012-06-22 16:30:09 -07002574 * * we didn't get a -1, and
2575 * * write access wasn't requested,
2576 * * or the file isn't read-only,
2577 * * or it's a directory.
2578 * (Directories cannot be read-only on Windows.)
2579 */
Larry Hastings2f936352014-08-05 14:04:04 +10002580 return_value = (attr != INVALID_FILE_ATTRIBUTES) &&
Georg Brandl5bb7aa92012-06-23 12:48:40 +02002581 (!(mode & 2) ||
Larry Hastings9cf065c2012-06-22 16:30:09 -07002582 !(attr & FILE_ATTRIBUTE_READONLY) ||
Larry Hastings2f936352014-08-05 14:04:04 +10002583 (attr & FILE_ATTRIBUTE_DIRECTORY));
Larry Hastings9cf065c2012-06-22 16:30:09 -07002584#else
2585
2586 Py_BEGIN_ALLOW_THREADS
2587#ifdef HAVE_FACCESSAT
2588 if ((dir_fd != DEFAULT_DIR_FD) ||
2589 effective_ids ||
2590 !follow_symlinks) {
2591 int flags = 0;
2592 if (!follow_symlinks)
2593 flags |= AT_SYMLINK_NOFOLLOW;
2594 if (effective_ids)
2595 flags |= AT_EACCESS;
Larry Hastings31826802013-10-19 00:09:25 -07002596 result = faccessat(dir_fd, path->narrow, mode, flags);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002597 }
2598 else
2599#endif
Larry Hastings31826802013-10-19 00:09:25 -07002600 result = access(path->narrow, mode);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002601 Py_END_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10002602 return_value = !result;
Larry Hastings9cf065c2012-06-22 16:30:09 -07002603#endif
2604
Larry Hastings9cf065c2012-06-22 16:30:09 -07002605 return return_value;
Guido van Rossum94f6f721999-01-06 18:42:14 +00002606}
2607
Guido van Rossumd371ff11999-01-25 16:12:23 +00002608#ifndef F_OK
2609#define F_OK 0
2610#endif
2611#ifndef R_OK
2612#define R_OK 4
2613#endif
2614#ifndef W_OK
2615#define W_OK 2
2616#endif
2617#ifndef X_OK
2618#define X_OK 1
2619#endif
2620
Larry Hastings31826802013-10-19 00:09:25 -07002621
Guido van Rossumd371ff11999-01-25 16:12:23 +00002622#ifdef HAVE_TTYNAME
Larry Hastings61272b72014-01-07 12:41:53 -08002623/*[clinic input]
Larry Hastings31826802013-10-19 00:09:25 -07002624os.ttyname -> DecodeFSDefault
2625
2626 fd: int
2627 Integer file descriptor handle.
2628
2629 /
2630
2631Return the name of the terminal device connected to 'fd'.
Larry Hastings61272b72014-01-07 12:41:53 -08002632[clinic start generated code]*/
Larry Hastings31826802013-10-19 00:09:25 -07002633
Larry Hastings31826802013-10-19 00:09:25 -07002634static char *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002635os_ttyname_impl(PyObject *module, int fd)
2636/*[clinic end generated code: output=ed16ad216d813591 input=5f72ca83e76b3b45]*/
Larry Hastings31826802013-10-19 00:09:25 -07002637{
2638 char *ret;
Guido van Rossum94f6f721999-01-06 18:42:14 +00002639
Larry Hastings31826802013-10-19 00:09:25 -07002640 ret = ttyname(fd);
Victor Stinner8c62be82010-05-06 00:08:46 +00002641 if (ret == NULL)
Larry Hastings31826802013-10-19 00:09:25 -07002642 posix_error();
2643 return ret;
Guido van Rossum94f6f721999-01-06 18:42:14 +00002644}
Guido van Rossumd371ff11999-01-25 16:12:23 +00002645#endif
Guido van Rossum94f6f721999-01-06 18:42:14 +00002646
Fred Drake5ab8eaf1999-12-09 21:13:07 +00002647#ifdef HAVE_CTERMID
Larry Hastings2f936352014-08-05 14:04:04 +10002648/*[clinic input]
2649os.ctermid
2650
2651Return the name of the controlling terminal for this process.
2652[clinic start generated code]*/
2653
Larry Hastings2f936352014-08-05 14:04:04 +10002654static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002655os_ctermid_impl(PyObject *module)
2656/*[clinic end generated code: output=02f017e6c9e620db input=3b87fdd52556382d]*/
Fred Drake5ab8eaf1999-12-09 21:13:07 +00002657{
Victor Stinner8c62be82010-05-06 00:08:46 +00002658 char *ret;
2659 char buffer[L_ctermid];
Fred Drake5ab8eaf1999-12-09 21:13:07 +00002660
Greg Wardb48bc172000-03-01 21:51:56 +00002661#ifdef USE_CTERMID_R
Victor Stinner8c62be82010-05-06 00:08:46 +00002662 ret = ctermid_r(buffer);
Fred Drake5ab8eaf1999-12-09 21:13:07 +00002663#else
Victor Stinner8c62be82010-05-06 00:08:46 +00002664 ret = ctermid(buffer);
Fred Drake5ab8eaf1999-12-09 21:13:07 +00002665#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00002666 if (ret == NULL)
2667 return posix_error();
Victor Stinner5fe6de82010-08-15 09:12:51 +00002668 return PyUnicode_DecodeFSDefault(buffer);
Fred Drake5ab8eaf1999-12-09 21:13:07 +00002669}
Larry Hastings2f936352014-08-05 14:04:04 +10002670#endif /* HAVE_CTERMID */
Fred Drake5ab8eaf1999-12-09 21:13:07 +00002671
Larry Hastings2f936352014-08-05 14:04:04 +10002672
2673/*[clinic input]
2674os.chdir
2675
2676 path: path_t(allow_fd='PATH_HAVE_FCHDIR')
2677
2678Change the current working directory to the specified path.
2679
2680path may always be specified as a string.
2681On some platforms, path may also be specified as an open file descriptor.
2682 If this functionality is unavailable, using it raises an exception.
2683[clinic start generated code]*/
2684
Larry Hastings2f936352014-08-05 14:04:04 +10002685static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002686os_chdir_impl(PyObject *module, path_t *path)
2687/*[clinic end generated code: output=3be6400eee26eaae input=1a4a15b4d12cb15d]*/
Larry Hastings2f936352014-08-05 14:04:04 +10002688{
2689 int result;
Larry Hastings9cf065c2012-06-22 16:30:09 -07002690
2691 Py_BEGIN_ALLOW_THREADS
2692#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07002693 /* on unix, success = 0, on windows, success = !0 */
2694 result = !win32_wchdir(path->wide);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002695#else
2696#ifdef HAVE_FCHDIR
Larry Hastings2f936352014-08-05 14:04:04 +10002697 if (path->fd != -1)
2698 result = fchdir(path->fd);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002699 else
2700#endif
Larry Hastings2f936352014-08-05 14:04:04 +10002701 result = chdir(path->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002702#endif
2703 Py_END_ALLOW_THREADS
2704
2705 if (result) {
Larry Hastings2f936352014-08-05 14:04:04 +10002706 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002707 }
2708
Larry Hastings2f936352014-08-05 14:04:04 +10002709 Py_RETURN_NONE;
2710}
2711
2712
2713#ifdef HAVE_FCHDIR
2714/*[clinic input]
2715os.fchdir
2716
2717 fd: fildes
2718
2719Change to the directory of the given file descriptor.
2720
2721fd must be opened on a directory, not a file.
2722Equivalent to os.chdir(fd).
2723
2724[clinic start generated code]*/
2725
Fred Drake4d1e64b2002-04-15 19:40:07 +00002726static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002727os_fchdir_impl(PyObject *module, int fd)
2728/*[clinic end generated code: output=42e064ec4dc00ab0 input=18e816479a2fa985]*/
Fred Drake4d1e64b2002-04-15 19:40:07 +00002729{
Larry Hastings2f936352014-08-05 14:04:04 +10002730 return posix_fildes_fd(fd, fchdir);
Fred Drake4d1e64b2002-04-15 19:40:07 +00002731}
2732#endif /* HAVE_FCHDIR */
2733
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00002734
Larry Hastings2f936352014-08-05 14:04:04 +10002735/*[clinic input]
2736os.chmod
2737
2738 path: path_t(allow_fd='PATH_HAVE_FCHMOD')
2739 Path to be modified. May always be specified as a str or bytes.
2740 On some platforms, path may also be specified as an open file descriptor.
2741 If this functionality is unavailable, using it raises an exception.
2742
2743 mode: int
2744 Operating-system mode bitfield.
2745
2746 *
2747
2748 dir_fd : dir_fd(requires='fchmodat') = None
2749 If not None, it should be a file descriptor open to a directory,
2750 and path should be relative; path will then be relative to that
2751 directory.
2752
2753 follow_symlinks: bool = True
2754 If False, and the last element of the path is a symbolic link,
2755 chmod will modify the symbolic link itself instead of the file
2756 the link points to.
2757
2758Change the access permissions of a file.
2759
2760It is an error to use dir_fd or follow_symlinks when specifying path as
2761 an open file descriptor.
2762dir_fd and follow_symlinks may not be implemented on your platform.
2763 If they are unavailable, using them will raise a NotImplementedError.
2764
2765[clinic start generated code]*/
2766
Larry Hastings2f936352014-08-05 14:04:04 +10002767static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002768os_chmod_impl(PyObject *module, path_t *path, int mode, int dir_fd,
Larry Hastings89964c42015-04-14 18:07:59 -04002769 int follow_symlinks)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002770/*[clinic end generated code: output=5cf6a94915cc7bff input=7f1618e5e15cc196]*/
Larry Hastings2f936352014-08-05 14:04:04 +10002771{
Larry Hastings9cf065c2012-06-22 16:30:09 -07002772 int result;
Larry Hastings9cf065c2012-06-22 16:30:09 -07002773
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00002774#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00002775 DWORD attr;
Larry Hastings9cf065c2012-06-22 16:30:09 -07002776#endif
Hirokazu Yamamoto892a37a2009-06-28 11:07:03 +00002777
Larry Hastings9cf065c2012-06-22 16:30:09 -07002778#ifdef HAVE_FCHMODAT
2779 int fchmodat_nofollow_unsupported = 0;
2780#endif
2781
Larry Hastings9cf065c2012-06-22 16:30:09 -07002782#if !(defined(HAVE_FCHMODAT) || defined(HAVE_LCHMOD))
2783 if (follow_symlinks_specified("chmod", follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10002784 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07002785#endif
2786
2787#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00002788 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07002789 attr = GetFileAttributesW(path->wide);
Tim Golden23005082013-10-25 11:22:37 +01002790 if (attr == INVALID_FILE_ATTRIBUTES)
Larry Hastings9cf065c2012-06-22 16:30:09 -07002791 result = 0;
2792 else {
2793 if (mode & _S_IWRITE)
Victor Stinner8c62be82010-05-06 00:08:46 +00002794 attr &= ~FILE_ATTRIBUTE_READONLY;
2795 else
2796 attr |= FILE_ATTRIBUTE_READONLY;
Steve Dowercc16be82016-09-08 10:35:16 -07002797 result = SetFileAttributesW(path->wide, attr);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002798 }
2799 Py_END_ALLOW_THREADS
2800
2801 if (!result) {
Larry Hastings2f936352014-08-05 14:04:04 +10002802 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002803 }
2804#else /* MS_WINDOWS */
2805 Py_BEGIN_ALLOW_THREADS
2806#ifdef HAVE_FCHMOD
Larry Hastings2f936352014-08-05 14:04:04 +10002807 if (path->fd != -1)
2808 result = fchmod(path->fd, mode);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002809 else
2810#endif
2811#ifdef HAVE_LCHMOD
2812 if ((!follow_symlinks) && (dir_fd == DEFAULT_DIR_FD))
Larry Hastings2f936352014-08-05 14:04:04 +10002813 result = lchmod(path->narrow, mode);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002814 else
2815#endif
2816#ifdef HAVE_FCHMODAT
2817 if ((dir_fd != DEFAULT_DIR_FD) || !follow_symlinks) {
2818 /*
2819 * fchmodat() doesn't currently support AT_SYMLINK_NOFOLLOW!
2820 * The documentation specifically shows how to use it,
Larry Hastingsdbbc0c82012-06-22 19:50:21 -07002821 * and then says it isn't implemented yet.
2822 * (true on linux with glibc 2.15, and openindiana 3.x)
Larry Hastings9cf065c2012-06-22 16:30:09 -07002823 *
2824 * Once it is supported, os.chmod will automatically
2825 * support dir_fd and follow_symlinks=False. (Hopefully.)
2826 * Until then, we need to be careful what exception we raise.
2827 */
Larry Hastings2f936352014-08-05 14:04:04 +10002828 result = fchmodat(dir_fd, path->narrow, mode,
Larry Hastings9cf065c2012-06-22 16:30:09 -07002829 follow_symlinks ? 0 : AT_SYMLINK_NOFOLLOW);
2830 /*
2831 * But wait! We can't throw the exception without allowing threads,
2832 * and we can't do that in this nested scope. (Macro trickery, sigh.)
2833 */
2834 fchmodat_nofollow_unsupported =
Larry Hastingsdbbc0c82012-06-22 19:50:21 -07002835 result &&
2836 ((errno == ENOTSUP) || (errno == EOPNOTSUPP)) &&
2837 !follow_symlinks;
Victor Stinner8c62be82010-05-06 00:08:46 +00002838 }
2839 else
Thomas Wouters477c8d52006-05-27 19:21:47 +00002840#endif
Larry Hastings2f936352014-08-05 14:04:04 +10002841 result = chmod(path->narrow, mode);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002842 Py_END_ALLOW_THREADS
2843
2844 if (result) {
2845#ifdef HAVE_FCHMODAT
2846 if (fchmodat_nofollow_unsupported) {
2847 if (dir_fd != DEFAULT_DIR_FD)
2848 dir_fd_and_follow_symlinks_invalid("chmod",
2849 dir_fd, follow_symlinks);
2850 else
2851 follow_symlinks_specified("chmod", follow_symlinks);
Anthony Sottile233ef242017-12-14 08:57:55 -08002852 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07002853 }
2854 else
2855#endif
Larry Hastings2f936352014-08-05 14:04:04 +10002856 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002857 }
2858#endif
2859
Larry Hastings2f936352014-08-05 14:04:04 +10002860 Py_RETURN_NONE;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002861}
2862
Larry Hastings9cf065c2012-06-22 16:30:09 -07002863
Christian Heimes4e30a842007-11-30 22:12:06 +00002864#ifdef HAVE_FCHMOD
Larry Hastings2f936352014-08-05 14:04:04 +10002865/*[clinic input]
2866os.fchmod
2867
2868 fd: int
2869 mode: int
2870
2871Change the access permissions of the file given by file descriptor fd.
2872
2873Equivalent to os.chmod(fd, mode).
2874[clinic start generated code]*/
2875
Larry Hastings2f936352014-08-05 14:04:04 +10002876static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002877os_fchmod_impl(PyObject *module, int fd, int mode)
2878/*[clinic end generated code: output=afd9bc05b4e426b3 input=8ab11975ca01ee5b]*/
Larry Hastings2f936352014-08-05 14:04:04 +10002879{
2880 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00002881 int async_err = 0;
2882
2883 do {
2884 Py_BEGIN_ALLOW_THREADS
2885 res = fchmod(fd, mode);
2886 Py_END_ALLOW_THREADS
2887 } while (res != 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
2888 if (res != 0)
2889 return (!async_err) ? posix_error() : NULL;
2890
Victor Stinner8c62be82010-05-06 00:08:46 +00002891 Py_RETURN_NONE;
Christian Heimes4e30a842007-11-30 22:12:06 +00002892}
2893#endif /* HAVE_FCHMOD */
2894
Larry Hastings2f936352014-08-05 14:04:04 +10002895
Christian Heimes4e30a842007-11-30 22:12:06 +00002896#ifdef HAVE_LCHMOD
Larry Hastings2f936352014-08-05 14:04:04 +10002897/*[clinic input]
2898os.lchmod
2899
2900 path: path_t
2901 mode: int
2902
2903Change the access permissions of a file, without following symbolic links.
2904
2905If path is a symlink, this affects the link itself rather than the target.
2906Equivalent to chmod(path, mode, follow_symlinks=False)."
2907[clinic start generated code]*/
2908
Larry Hastings2f936352014-08-05 14:04:04 +10002909static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002910os_lchmod_impl(PyObject *module, path_t *path, int mode)
2911/*[clinic end generated code: output=082344022b51a1d5 input=90c5663c7465d24f]*/
Larry Hastings2f936352014-08-05 14:04:04 +10002912{
Victor Stinner8c62be82010-05-06 00:08:46 +00002913 int res;
Victor Stinner8c62be82010-05-06 00:08:46 +00002914 Py_BEGIN_ALLOW_THREADS
Larry Hastingsb1dc1122014-08-05 16:06:16 +10002915 res = lchmod(path->narrow, mode);
Victor Stinner8c62be82010-05-06 00:08:46 +00002916 Py_END_ALLOW_THREADS
Victor Stinner292c8352012-10-30 02:17:38 +01002917 if (res < 0) {
Larry Hastings2f936352014-08-05 14:04:04 +10002918 path_error(path);
Victor Stinner292c8352012-10-30 02:17:38 +01002919 return NULL;
2920 }
Victor Stinner8c62be82010-05-06 00:08:46 +00002921 Py_RETURN_NONE;
Christian Heimes4e30a842007-11-30 22:12:06 +00002922}
2923#endif /* HAVE_LCHMOD */
2924
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00002925
Thomas Wouterscf297e42007-02-23 15:07:44 +00002926#ifdef HAVE_CHFLAGS
Larry Hastings2f936352014-08-05 14:04:04 +10002927/*[clinic input]
2928os.chflags
2929
2930 path: path_t
2931 flags: unsigned_long(bitwise=True)
2932 follow_symlinks: bool=True
2933
2934Set file flags.
2935
2936If follow_symlinks is False, and the last element of the path is a symbolic
2937 link, chflags will change flags on the symbolic link itself instead of the
2938 file the link points to.
2939follow_symlinks may not be implemented on your platform. If it is
2940unavailable, using it will raise a NotImplementedError.
2941
2942[clinic start generated code]*/
2943
Larry Hastings2f936352014-08-05 14:04:04 +10002944static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002945os_chflags_impl(PyObject *module, path_t *path, unsigned long flags,
Larry Hastings89964c42015-04-14 18:07:59 -04002946 int follow_symlinks)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002947/*[clinic end generated code: output=85571c6737661ce9 input=0327e29feb876236]*/
Larry Hastings2f936352014-08-05 14:04:04 +10002948{
2949 int result;
Larry Hastings9cf065c2012-06-22 16:30:09 -07002950
2951#ifndef HAVE_LCHFLAGS
2952 if (follow_symlinks_specified("chflags", follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10002953 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07002954#endif
2955
Victor Stinner8c62be82010-05-06 00:08:46 +00002956 Py_BEGIN_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07002957#ifdef HAVE_LCHFLAGS
2958 if (!follow_symlinks)
Larry Hastings2f936352014-08-05 14:04:04 +10002959 result = lchflags(path->narrow, flags);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002960 else
2961#endif
Larry Hastings2f936352014-08-05 14:04:04 +10002962 result = chflags(path->narrow, flags);
Victor Stinner8c62be82010-05-06 00:08:46 +00002963 Py_END_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07002964
Larry Hastings2f936352014-08-05 14:04:04 +10002965 if (result)
2966 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07002967
Larry Hastings2f936352014-08-05 14:04:04 +10002968 Py_RETURN_NONE;
Thomas Wouterscf297e42007-02-23 15:07:44 +00002969}
2970#endif /* HAVE_CHFLAGS */
2971
Larry Hastings2f936352014-08-05 14:04:04 +10002972
Thomas Wouterscf297e42007-02-23 15:07:44 +00002973#ifdef HAVE_LCHFLAGS
Larry Hastings2f936352014-08-05 14:04:04 +10002974/*[clinic input]
2975os.lchflags
2976
2977 path: path_t
2978 flags: unsigned_long(bitwise=True)
2979
2980Set file flags.
2981
2982This function will not follow symbolic links.
2983Equivalent to chflags(path, flags, follow_symlinks=False).
2984[clinic start generated code]*/
2985
Larry Hastings2f936352014-08-05 14:04:04 +10002986static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03002987os_lchflags_impl(PyObject *module, path_t *path, unsigned long flags)
2988/*[clinic end generated code: output=30ae958695c07316 input=f9f82ea8b585ca9d]*/
Larry Hastings2f936352014-08-05 14:04:04 +10002989{
Victor Stinner8c62be82010-05-06 00:08:46 +00002990 int res;
Victor Stinner8c62be82010-05-06 00:08:46 +00002991 Py_BEGIN_ALLOW_THREADS
Larry Hastingsb1dc1122014-08-05 16:06:16 +10002992 res = lchflags(path->narrow, flags);
Victor Stinner8c62be82010-05-06 00:08:46 +00002993 Py_END_ALLOW_THREADS
Victor Stinner292c8352012-10-30 02:17:38 +01002994 if (res < 0) {
Larry Hastings2f936352014-08-05 14:04:04 +10002995 return path_error(path);
Victor Stinner292c8352012-10-30 02:17:38 +01002996 }
Victor Stinner292c8352012-10-30 02:17:38 +01002997 Py_RETURN_NONE;
Thomas Wouterscf297e42007-02-23 15:07:44 +00002998}
2999#endif /* HAVE_LCHFLAGS */
3000
Larry Hastings2f936352014-08-05 14:04:04 +10003001
Martin v. Löwis244edc82001-10-04 22:44:26 +00003002#ifdef HAVE_CHROOT
Larry Hastings2f936352014-08-05 14:04:04 +10003003/*[clinic input]
3004os.chroot
3005 path: path_t
3006
3007Change root directory to path.
3008
3009[clinic start generated code]*/
3010
Larry Hastings2f936352014-08-05 14:04:04 +10003011static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003012os_chroot_impl(PyObject *module, path_t *path)
3013/*[clinic end generated code: output=de80befc763a4475 input=14822965652c3dc3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003014{
3015 int res;
3016 Py_BEGIN_ALLOW_THREADS
3017 res = chroot(path->narrow);
3018 Py_END_ALLOW_THREADS
3019 if (res < 0)
3020 return path_error(path);
3021 Py_RETURN_NONE;
3022}
3023#endif /* HAVE_CHROOT */
3024
Martin v. Löwis244edc82001-10-04 22:44:26 +00003025
Guido van Rossum21142a01999-01-08 21:05:37 +00003026#ifdef HAVE_FSYNC
Larry Hastings2f936352014-08-05 14:04:04 +10003027/*[clinic input]
3028os.fsync
3029
3030 fd: fildes
3031
3032Force write of fd to disk.
3033[clinic start generated code]*/
3034
Larry Hastings2f936352014-08-05 14:04:04 +10003035static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003036os_fsync_impl(PyObject *module, int fd)
3037/*[clinic end generated code: output=4a10d773f52b3584 input=21c3645c056967f2]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003038{
3039 return posix_fildes_fd(fd, fsync);
Guido van Rossum21142a01999-01-08 21:05:37 +00003040}
3041#endif /* HAVE_FSYNC */
3042
Larry Hastings2f936352014-08-05 14:04:04 +10003043
Ross Lagerwall7807c352011-03-17 20:20:30 +02003044#ifdef HAVE_SYNC
Larry Hastings2f936352014-08-05 14:04:04 +10003045/*[clinic input]
3046os.sync
3047
3048Force write of everything to disk.
3049[clinic start generated code]*/
3050
Larry Hastings2f936352014-08-05 14:04:04 +10003051static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003052os_sync_impl(PyObject *module)
3053/*[clinic end generated code: output=2796b1f0818cd71c input=84749fe5e9b404ff]*/
Ross Lagerwall7807c352011-03-17 20:20:30 +02003054{
3055 Py_BEGIN_ALLOW_THREADS
3056 sync();
3057 Py_END_ALLOW_THREADS
3058 Py_RETURN_NONE;
3059}
Larry Hastings2f936352014-08-05 14:04:04 +10003060#endif /* HAVE_SYNC */
3061
Ross Lagerwall7807c352011-03-17 20:20:30 +02003062
Guido van Rossum21142a01999-01-08 21:05:37 +00003063#ifdef HAVE_FDATASYNC
Guido van Rossum7f58e2e2000-09-22 17:26:14 +00003064#ifdef __hpux
Guido van Rossumecc23b02000-09-22 16:01:05 +00003065extern int fdatasync(int); /* On HP-UX, in libc but not in unistd.h */
3066#endif
3067
Larry Hastings2f936352014-08-05 14:04:04 +10003068/*[clinic input]
3069os.fdatasync
3070
3071 fd: fildes
3072
3073Force write of fd to disk without forcing update of metadata.
3074[clinic start generated code]*/
3075
Larry Hastings2f936352014-08-05 14:04:04 +10003076static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003077os_fdatasync_impl(PyObject *module, int fd)
3078/*[clinic end generated code: output=b4b9698b5d7e26dd input=bc74791ee54dd291]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003079{
3080 return posix_fildes_fd(fd, fdatasync);
Guido van Rossum21142a01999-01-08 21:05:37 +00003081}
3082#endif /* HAVE_FDATASYNC */
3083
3084
Fredrik Lundh10723342000-07-10 16:38:09 +00003085#ifdef HAVE_CHOWN
Larry Hastings2f936352014-08-05 14:04:04 +10003086/*[clinic input]
3087os.chown
3088
3089 path : path_t(allow_fd='PATH_HAVE_FCHOWN')
3090 Path to be examined; can be string, bytes, or open-file-descriptor int.
3091
3092 uid: uid_t
3093
3094 gid: gid_t
3095
3096 *
3097
3098 dir_fd : dir_fd(requires='fchownat') = None
3099 If not None, it should be a file descriptor open to a directory,
3100 and path should be relative; path will then be relative to that
3101 directory.
3102
3103 follow_symlinks: bool = True
3104 If False, and the last element of the path is a symbolic link,
3105 stat will examine the symbolic link itself instead of the file
3106 the link points to.
3107
3108Change the owner and group id of path to the numeric uid and gid.\
3109
3110path may always be specified as a string.
3111On some platforms, path may also be specified as an open file descriptor.
3112 If this functionality is unavailable, using it raises an exception.
3113If dir_fd is not None, it should be a file descriptor open to a directory,
3114 and path should be relative; path will then be relative to that directory.
3115If follow_symlinks is False, and the last element of the path is a symbolic
3116 link, chown will modify the symbolic link itself instead of the file the
3117 link points to.
3118It is an error to use dir_fd or follow_symlinks when specifying path as
3119 an open file descriptor.
3120dir_fd and follow_symlinks may not be implemented on your platform.
3121 If they are unavailable, using them will raise a NotImplementedError.
3122
3123[clinic start generated code]*/
3124
Larry Hastings2f936352014-08-05 14:04:04 +10003125static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003126os_chown_impl(PyObject *module, path_t *path, uid_t uid, gid_t gid,
Larry Hastings89964c42015-04-14 18:07:59 -04003127 int dir_fd, int follow_symlinks)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003128/*[clinic end generated code: output=4beadab0db5f70cd input=a61cc35574814d5d]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003129{
3130 int result;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003131
3132#if !(defined(HAVE_LCHOWN) || defined(HAVE_FCHOWNAT))
3133 if (follow_symlinks_specified("chown", follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10003134 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003135#endif
Larry Hastings2f936352014-08-05 14:04:04 +10003136 if (dir_fd_and_fd_invalid("chown", dir_fd, path->fd) ||
3137 fd_and_follow_symlinks_invalid("chown", path->fd, follow_symlinks))
3138 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003139
3140#ifdef __APPLE__
3141 /*
3142 * This is for Mac OS X 10.3, which doesn't have lchown.
3143 * (But we still have an lchown symbol because of weak-linking.)
3144 * It doesn't have fchownat either. So there's no possibility
3145 * of a graceful failover.
Georg Brandlf7875592012-06-24 13:58:31 +02003146 */
Larry Hastings9cf065c2012-06-22 16:30:09 -07003147 if ((!follow_symlinks) && (lchown == NULL)) {
3148 follow_symlinks_specified("chown", follow_symlinks);
Larry Hastings2f936352014-08-05 14:04:04 +10003149 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003150 }
3151#endif
3152
Victor Stinner8c62be82010-05-06 00:08:46 +00003153 Py_BEGIN_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07003154#ifdef HAVE_FCHOWN
Larry Hastings2f936352014-08-05 14:04:04 +10003155 if (path->fd != -1)
3156 result = fchown(path->fd, uid, gid);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003157 else
3158#endif
3159#ifdef HAVE_LCHOWN
3160 if ((!follow_symlinks) && (dir_fd == DEFAULT_DIR_FD))
Larry Hastings2f936352014-08-05 14:04:04 +10003161 result = lchown(path->narrow, uid, gid);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003162 else
3163#endif
3164#ifdef HAVE_FCHOWNAT
3165 if ((dir_fd != DEFAULT_DIR_FD) || (!follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10003166 result = fchownat(dir_fd, path->narrow, uid, gid,
Larry Hastings9cf065c2012-06-22 16:30:09 -07003167 follow_symlinks ? 0 : AT_SYMLINK_NOFOLLOW);
3168 else
3169#endif
Larry Hastings2f936352014-08-05 14:04:04 +10003170 result = chown(path->narrow, uid, gid);
Victor Stinner8c62be82010-05-06 00:08:46 +00003171 Py_END_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07003172
Larry Hastings2f936352014-08-05 14:04:04 +10003173 if (result)
3174 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003175
Larry Hastings2f936352014-08-05 14:04:04 +10003176 Py_RETURN_NONE;
Guido van Rossumb6775db1994-08-01 11:34:53 +00003177}
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00003178#endif /* HAVE_CHOWN */
Guido van Rossumb6775db1994-08-01 11:34:53 +00003179
Larry Hastings2f936352014-08-05 14:04:04 +10003180
Christian Heimes4e30a842007-11-30 22:12:06 +00003181#ifdef HAVE_FCHOWN
Larry Hastings2f936352014-08-05 14:04:04 +10003182/*[clinic input]
3183os.fchown
3184
3185 fd: int
3186 uid: uid_t
3187 gid: gid_t
3188
3189Change the owner and group id of the file specified by file descriptor.
3190
3191Equivalent to os.chown(fd, uid, gid).
3192
3193[clinic start generated code]*/
3194
Larry Hastings2f936352014-08-05 14:04:04 +10003195static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003196os_fchown_impl(PyObject *module, int fd, uid_t uid, gid_t gid)
3197/*[clinic end generated code: output=97d21cbd5a4350a6 input=3af544ba1b13a0d7]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003198{
Victor Stinner8c62be82010-05-06 00:08:46 +00003199 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00003200 int async_err = 0;
3201
3202 do {
3203 Py_BEGIN_ALLOW_THREADS
3204 res = fchown(fd, uid, gid);
3205 Py_END_ALLOW_THREADS
3206 } while (res != 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
3207 if (res != 0)
3208 return (!async_err) ? posix_error() : NULL;
3209
Victor Stinner8c62be82010-05-06 00:08:46 +00003210 Py_RETURN_NONE;
Christian Heimes4e30a842007-11-30 22:12:06 +00003211}
3212#endif /* HAVE_FCHOWN */
3213
Larry Hastings2f936352014-08-05 14:04:04 +10003214
Martin v. Löwis0cec0ff2002-07-28 16:33:45 +00003215#ifdef HAVE_LCHOWN
Larry Hastings2f936352014-08-05 14:04:04 +10003216/*[clinic input]
3217os.lchown
3218
3219 path : path_t
3220 uid: uid_t
3221 gid: gid_t
3222
3223Change the owner and group id of path to the numeric uid and gid.
3224
3225This function will not follow symbolic links.
3226Equivalent to os.chown(path, uid, gid, follow_symlinks=False).
3227[clinic start generated code]*/
3228
Larry Hastings2f936352014-08-05 14:04:04 +10003229static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003230os_lchown_impl(PyObject *module, path_t *path, uid_t uid, gid_t gid)
3231/*[clinic end generated code: output=25eaf6af412fdf2f input=b1c6014d563a7161]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003232{
Victor Stinner8c62be82010-05-06 00:08:46 +00003233 int res;
Victor Stinner8c62be82010-05-06 00:08:46 +00003234 Py_BEGIN_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10003235 res = lchown(path->narrow, uid, gid);
Victor Stinner8c62be82010-05-06 00:08:46 +00003236 Py_END_ALLOW_THREADS
Victor Stinner292c8352012-10-30 02:17:38 +01003237 if (res < 0) {
Larry Hastings2f936352014-08-05 14:04:04 +10003238 return path_error(path);
Victor Stinner292c8352012-10-30 02:17:38 +01003239 }
Larry Hastings2f936352014-08-05 14:04:04 +10003240 Py_RETURN_NONE;
Martin v. Löwis0cec0ff2002-07-28 16:33:45 +00003241}
3242#endif /* HAVE_LCHOWN */
3243
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00003244
Barry Warsaw53699e91996-12-10 23:23:01 +00003245static PyObject *
Guido van Rossumf0af3e32008-10-02 18:55:37 +00003246posix_getcwd(int use_bytes)
Mark Hammondc2e85bd2002-10-03 05:10:39 +00003247{
Victor Stinner4403d7d2015-04-25 00:16:10 +02003248 char *buf, *tmpbuf;
3249 char *cwd;
3250 const size_t chunk = 1024;
3251 size_t buflen = 0;
3252 PyObject *obj;
Mark Hammondc2e85bd2002-10-03 05:10:39 +00003253
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00003254#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00003255 if (!use_bytes) {
Victor Stinner4403d7d2015-04-25 00:16:10 +02003256 wchar_t wbuf[MAXPATHLEN];
Victor Stinner8c62be82010-05-06 00:08:46 +00003257 wchar_t *wbuf2 = wbuf;
3258 PyObject *resobj;
3259 DWORD len;
3260 Py_BEGIN_ALLOW_THREADS
Victor Stinner75875072013-11-24 19:23:25 +01003261 len = GetCurrentDirectoryW(Py_ARRAY_LENGTH(wbuf), wbuf);
Victor Stinner8c62be82010-05-06 00:08:46 +00003262 /* If the buffer is large enough, len does not include the
3263 terminating \0. If the buffer is too small, len includes
3264 the space needed for the terminator. */
Victor Stinner75875072013-11-24 19:23:25 +01003265 if (len >= Py_ARRAY_LENGTH(wbuf)) {
Victor Stinnerb6404912013-07-07 16:21:41 +02003266 wbuf2 = PyMem_RawMalloc(len * sizeof(wchar_t));
Victor Stinner8c62be82010-05-06 00:08:46 +00003267 if (wbuf2)
3268 len = GetCurrentDirectoryW(len, wbuf2);
3269 }
3270 Py_END_ALLOW_THREADS
3271 if (!wbuf2) {
3272 PyErr_NoMemory();
3273 return NULL;
3274 }
3275 if (!len) {
Victor Stinnerb024e842012-10-31 22:24:06 +01003276 if (wbuf2 != wbuf)
Victor Stinnerb6404912013-07-07 16:21:41 +02003277 PyMem_RawFree(wbuf2);
Victor Stinnerb024e842012-10-31 22:24:06 +01003278 return PyErr_SetFromWindowsErr(0);
Victor Stinner8c62be82010-05-06 00:08:46 +00003279 }
3280 resobj = PyUnicode_FromWideChar(wbuf2, len);
Victor Stinnerb024e842012-10-31 22:24:06 +01003281 if (wbuf2 != wbuf)
Victor Stinnerb6404912013-07-07 16:21:41 +02003282 PyMem_RawFree(wbuf2);
Victor Stinner8c62be82010-05-06 00:08:46 +00003283 return resobj;
3284 }
Victor Stinnerf7c5ae22011-11-16 23:43:07 +01003285
3286 if (win32_warn_bytes_api())
3287 return NULL;
Mark Hammondc2e85bd2002-10-03 05:10:39 +00003288#endif
3289
Victor Stinner4403d7d2015-04-25 00:16:10 +02003290 buf = cwd = NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00003291 Py_BEGIN_ALLOW_THREADS
Victor Stinner4403d7d2015-04-25 00:16:10 +02003292 do {
3293 buflen += chunk;
Victor Stinnerc44f7072016-03-14 18:07:53 +01003294#ifdef MS_WINDOWS
3295 if (buflen > INT_MAX) {
3296 PyErr_NoMemory();
3297 break;
3298 }
3299#endif
Victor Stinner4403d7d2015-04-25 00:16:10 +02003300 tmpbuf = PyMem_RawRealloc(buf, buflen);
3301 if (tmpbuf == NULL)
3302 break;
3303
3304 buf = tmpbuf;
Victor Stinnerc44f7072016-03-14 18:07:53 +01003305#ifdef MS_WINDOWS
3306 cwd = getcwd(buf, (int)buflen);
3307#else
Victor Stinner4403d7d2015-04-25 00:16:10 +02003308 cwd = getcwd(buf, buflen);
Victor Stinnerc44f7072016-03-14 18:07:53 +01003309#endif
Victor Stinner4403d7d2015-04-25 00:16:10 +02003310 } while (cwd == NULL && errno == ERANGE);
Victor Stinner8c62be82010-05-06 00:08:46 +00003311 Py_END_ALLOW_THREADS
Victor Stinner4403d7d2015-04-25 00:16:10 +02003312
3313 if (cwd == NULL) {
3314 PyMem_RawFree(buf);
Victor Stinner8c62be82010-05-06 00:08:46 +00003315 return posix_error();
Victor Stinner4403d7d2015-04-25 00:16:10 +02003316 }
3317
Victor Stinner8c62be82010-05-06 00:08:46 +00003318 if (use_bytes)
Victor Stinner4403d7d2015-04-25 00:16:10 +02003319 obj = PyBytes_FromStringAndSize(buf, strlen(buf));
3320 else
3321 obj = PyUnicode_DecodeFSDefault(buf);
3322 PyMem_RawFree(buf);
3323
3324 return obj;
Mark Hammondc2e85bd2002-10-03 05:10:39 +00003325}
Guido van Rossumf0af3e32008-10-02 18:55:37 +00003326
Larry Hastings2f936352014-08-05 14:04:04 +10003327
3328/*[clinic input]
3329os.getcwd
3330
3331Return a unicode string representing the current working directory.
3332[clinic start generated code]*/
3333
Larry Hastings2f936352014-08-05 14:04:04 +10003334static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003335os_getcwd_impl(PyObject *module)
3336/*[clinic end generated code: output=21badfae2ea99ddc input=f069211bb70e3d39]*/
Guido van Rossumf0af3e32008-10-02 18:55:37 +00003337{
3338 return posix_getcwd(0);
3339}
3340
Larry Hastings2f936352014-08-05 14:04:04 +10003341
3342/*[clinic input]
3343os.getcwdb
3344
3345Return a bytes string representing the current working directory.
3346[clinic start generated code]*/
3347
Larry Hastings2f936352014-08-05 14:04:04 +10003348static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003349os_getcwdb_impl(PyObject *module)
3350/*[clinic end generated code: output=3dd47909480e4824 input=f6f6a378dad3d9cb]*/
Guido van Rossumf0af3e32008-10-02 18:55:37 +00003351{
3352 return posix_getcwd(1);
3353}
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003354
Larry Hastings2f936352014-08-05 14:04:04 +10003355
Larry Hastings9cf065c2012-06-22 16:30:09 -07003356#if ((!defined(HAVE_LINK)) && defined(MS_WINDOWS))
3357#define HAVE_LINK 1
3358#endif
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00003359
Guido van Rossumb6775db1994-08-01 11:34:53 +00003360#ifdef HAVE_LINK
Larry Hastings2f936352014-08-05 14:04:04 +10003361/*[clinic input]
3362
3363os.link
3364
3365 src : path_t
3366 dst : path_t
3367 *
3368 src_dir_fd : dir_fd = None
3369 dst_dir_fd : dir_fd = None
3370 follow_symlinks: bool = True
3371
3372Create a hard link to a file.
3373
3374If either src_dir_fd or dst_dir_fd is not None, it should be a file
3375 descriptor open to a directory, and the respective path string (src or dst)
3376 should be relative; the path will then be relative to that directory.
3377If follow_symlinks is False, and the last element of src is a symbolic
3378 link, link will create a link to the symbolic link itself instead of the
3379 file the link points to.
3380src_dir_fd, dst_dir_fd, and follow_symlinks may not be implemented on your
3381 platform. If they are unavailable, using them will raise a
3382 NotImplementedError.
3383[clinic start generated code]*/
3384
Larry Hastings2f936352014-08-05 14:04:04 +10003385static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003386os_link_impl(PyObject *module, path_t *src, path_t *dst, int src_dir_fd,
Larry Hastings89964c42015-04-14 18:07:59 -04003387 int dst_dir_fd, int follow_symlinks)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003388/*[clinic end generated code: output=7f00f6007fd5269a input=b0095ebbcbaa7e04]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003389{
Larry Hastings9cf065c2012-06-22 16:30:09 -07003390#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07003391 BOOL result = FALSE;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003392#else
3393 int result;
3394#endif
3395
Larry Hastings9cf065c2012-06-22 16:30:09 -07003396#ifndef HAVE_LINKAT
3397 if ((src_dir_fd != DEFAULT_DIR_FD) || (dst_dir_fd != DEFAULT_DIR_FD)) {
3398 argument_unavailable_error("link", "src_dir_fd and dst_dir_fd");
Larry Hastings2f936352014-08-05 14:04:04 +10003399 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003400 }
3401#endif
3402
Steve Dowercc16be82016-09-08 10:35:16 -07003403#ifndef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10003404 if ((src->narrow && dst->wide) || (src->wide && dst->narrow)) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07003405 PyErr_SetString(PyExc_NotImplementedError,
3406 "link: src and dst must be the same type");
Larry Hastings2f936352014-08-05 14:04:04 +10003407 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003408 }
Steve Dowercc16be82016-09-08 10:35:16 -07003409#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003410
Brian Curtin1b9df392010-11-24 20:24:31 +00003411#ifdef MS_WINDOWS
Larry Hastings9cf065c2012-06-22 16:30:09 -07003412 Py_BEGIN_ALLOW_THREADS
Steve Dowerc3630612016-11-19 18:41:16 -08003413 result = CreateHardLinkW(dst->wide, src->wide, NULL);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003414 Py_END_ALLOW_THREADS
Brian Curtin1b9df392010-11-24 20:24:31 +00003415
Larry Hastings2f936352014-08-05 14:04:04 +10003416 if (!result)
3417 return path_error2(src, dst);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003418#else
3419 Py_BEGIN_ALLOW_THREADS
Larry Hastings67cbf7b2012-06-22 17:06:48 -07003420#ifdef HAVE_LINKAT
Larry Hastings9cf065c2012-06-22 16:30:09 -07003421 if ((src_dir_fd != DEFAULT_DIR_FD) ||
3422 (dst_dir_fd != DEFAULT_DIR_FD) ||
3423 (!follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10003424 result = linkat(src_dir_fd, src->narrow,
3425 dst_dir_fd, dst->narrow,
Larry Hastings9cf065c2012-06-22 16:30:09 -07003426 follow_symlinks ? AT_SYMLINK_FOLLOW : 0);
3427 else
Steve Dowercc16be82016-09-08 10:35:16 -07003428#endif /* HAVE_LINKAT */
Larry Hastings2f936352014-08-05 14:04:04 +10003429 result = link(src->narrow, dst->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003430 Py_END_ALLOW_THREADS
Brian Curtinfc889c42010-11-28 23:59:46 +00003431
Larry Hastings2f936352014-08-05 14:04:04 +10003432 if (result)
3433 return path_error2(src, dst);
Steve Dowercc16be82016-09-08 10:35:16 -07003434#endif /* MS_WINDOWS */
Larry Hastings9cf065c2012-06-22 16:30:09 -07003435
Larry Hastings2f936352014-08-05 14:04:04 +10003436 Py_RETURN_NONE;
Brian Curtin1b9df392010-11-24 20:24:31 +00003437}
Larry Hastings9cf065c2012-06-22 16:30:09 -07003438#endif
3439
Brian Curtin1b9df392010-11-24 20:24:31 +00003440
Gregory P. Smith16ea14a2013-03-20 18:51:33 -07003441#if defined(MS_WINDOWS) && !defined(HAVE_OPENDIR)
Barry Warsaw53699e91996-12-10 23:23:01 +00003442static PyObject *
Gregory P. Smith40a21602013-03-20 20:52:50 -07003443_listdir_windows_no_opendir(path_t *path, PyObject *list)
Guido van Rossumb6775db1994-08-01 11:34:53 +00003444{
Larry Hastings9cf065c2012-06-22 16:30:09 -07003445 PyObject *v;
3446 HANDLE hFindFile = INVALID_HANDLE_VALUE;
3447 BOOL result;
Steve Dowercc16be82016-09-08 10:35:16 -07003448 wchar_t namebuf[MAX_PATH+4]; /* Overallocate for "\*.*" */
Larry Hastings9cf065c2012-06-22 16:30:09 -07003449 /* only claim to have space for MAX_PATH */
Victor Stinner75875072013-11-24 19:23:25 +01003450 Py_ssize_t len = Py_ARRAY_LENGTH(namebuf)-4;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003451 wchar_t *wnamebuf = NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003452
Steve Dowercc16be82016-09-08 10:35:16 -07003453 WIN32_FIND_DATAW wFileData;
3454 const wchar_t *po_wchars;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00003455
Steve Dowercc16be82016-09-08 10:35:16 -07003456 if (!path->wide) { /* Default arg: "." */
3457 po_wchars = L".";
3458 len = 1;
3459 } else {
3460 po_wchars = path->wide;
3461 len = wcslen(path->wide);
3462 }
3463 /* The +5 is so we can append "\\*.*\0" */
3464 wnamebuf = PyMem_New(wchar_t, len + 5);
3465 if (!wnamebuf) {
3466 PyErr_NoMemory();
Larry Hastings9cf065c2012-06-22 16:30:09 -07003467 goto exit;
Victor Stinner8c62be82010-05-06 00:08:46 +00003468 }
Steve Dowercc16be82016-09-08 10:35:16 -07003469 wcscpy(wnamebuf, po_wchars);
Victor Stinner8c62be82010-05-06 00:08:46 +00003470 if (len > 0) {
Steve Dowercc16be82016-09-08 10:35:16 -07003471 wchar_t wch = wnamebuf[len-1];
3472 if (wch != SEP && wch != ALTSEP && wch != L':')
3473 wnamebuf[len++] = SEP;
3474 wcscpy(wnamebuf + len, L"*.*");
Victor Stinner8c62be82010-05-06 00:08:46 +00003475 }
Steve Dowercc16be82016-09-08 10:35:16 -07003476 if ((list = PyList_New(0)) == NULL) {
3477 goto exit;
3478 }
Antoine Pitroub73caab2010-08-09 23:39:31 +00003479 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07003480 hFindFile = FindFirstFileW(wnamebuf, &wFileData);
Antoine Pitroub73caab2010-08-09 23:39:31 +00003481 Py_END_ALLOW_THREADS
Victor Stinner8c62be82010-05-06 00:08:46 +00003482 if (hFindFile == INVALID_HANDLE_VALUE) {
3483 int error = GetLastError();
3484 if (error == ERROR_FILE_NOT_FOUND)
Larry Hastings9cf065c2012-06-22 16:30:09 -07003485 goto exit;
3486 Py_DECREF(list);
Gregory P. Smith40a21602013-03-20 20:52:50 -07003487 list = path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003488 goto exit;
Victor Stinner8c62be82010-05-06 00:08:46 +00003489 }
3490 do {
3491 /* Skip over . and .. */
Steve Dowercc16be82016-09-08 10:35:16 -07003492 if (wcscmp(wFileData.cFileName, L".") != 0 &&
3493 wcscmp(wFileData.cFileName, L"..") != 0) {
3494 v = PyUnicode_FromWideChar(wFileData.cFileName,
3495 wcslen(wFileData.cFileName));
3496 if (path->narrow && v) {
3497 Py_SETREF(v, PyUnicode_EncodeFSDefault(v));
3498 }
Victor Stinner8c62be82010-05-06 00:08:46 +00003499 if (v == NULL) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07003500 Py_DECREF(list);
3501 list = NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00003502 break;
3503 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07003504 if (PyList_Append(list, v) != 0) {
Victor Stinner8c62be82010-05-06 00:08:46 +00003505 Py_DECREF(v);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003506 Py_DECREF(list);
3507 list = NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00003508 break;
3509 }
3510 Py_DECREF(v);
3511 }
3512 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07003513 result = FindNextFileW(hFindFile, &wFileData);
Victor Stinner8c62be82010-05-06 00:08:46 +00003514 Py_END_ALLOW_THREADS
3515 /* FindNextFile sets error to ERROR_NO_MORE_FILES if
3516 it got to the end of the directory. */
3517 if (!result && GetLastError() != ERROR_NO_MORE_FILES) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07003518 Py_DECREF(list);
Gregory P. Smith40a21602013-03-20 20:52:50 -07003519 list = path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003520 goto exit;
Victor Stinner8c62be82010-05-06 00:08:46 +00003521 }
3522 } while (result == TRUE);
Guido van Rossumb6775db1994-08-01 11:34:53 +00003523
Larry Hastings9cf065c2012-06-22 16:30:09 -07003524exit:
3525 if (hFindFile != INVALID_HANDLE_VALUE) {
3526 if (FindClose(hFindFile) == FALSE) {
3527 if (list != NULL) {
3528 Py_DECREF(list);
Gregory P. Smith40a21602013-03-20 20:52:50 -07003529 list = path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003530 }
3531 }
Victor Stinner8c62be82010-05-06 00:08:46 +00003532 }
Victor Stinnerb6404912013-07-07 16:21:41 +02003533 PyMem_Free(wnamebuf);
Guido van Rossumb6775db1994-08-01 11:34:53 +00003534
Larry Hastings9cf065c2012-06-22 16:30:09 -07003535 return list;
Gregory P. Smith16ea14a2013-03-20 18:51:33 -07003536} /* end of _listdir_windows_no_opendir */
3537
3538#else /* thus POSIX, ie: not (MS_WINDOWS and not HAVE_OPENDIR) */
3539
3540static PyObject *
Gregory P. Smith40a21602013-03-20 20:52:50 -07003541_posix_listdir(path_t *path, PyObject *list)
Gregory P. Smith16ea14a2013-03-20 18:51:33 -07003542{
Gregory P. Smith16ea14a2013-03-20 18:51:33 -07003543 PyObject *v;
3544 DIR *dirp = NULL;
3545 struct dirent *ep;
3546 int return_str; /* if false, return bytes */
Larry Hastings4dbc95e2013-08-01 18:18:56 -07003547#ifdef HAVE_FDOPENDIR
3548 int fd = -1;
3549#endif
Gregory P. Smith16ea14a2013-03-20 18:51:33 -07003550
Victor Stinner8c62be82010-05-06 00:08:46 +00003551 errno = 0;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003552#ifdef HAVE_FDOPENDIR
Gregory P. Smith40a21602013-03-20 20:52:50 -07003553 if (path->fd != -1) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07003554 /* closedir() closes the FD, so we duplicate it */
Victor Stinnerdaf45552013-08-28 00:53:59 +02003555 fd = _Py_dup(path->fd);
Victor Stinnerf3266652013-12-19 13:24:49 +01003556 if (fd == -1)
3557 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07003558
Larry Hastingsfdaea062012-06-25 04:42:23 -07003559 return_str = 1;
3560
Larry Hastings9cf065c2012-06-22 16:30:09 -07003561 Py_BEGIN_ALLOW_THREADS
3562 dirp = fdopendir(fd);
3563 Py_END_ALLOW_THREADS
3564 }
3565 else
3566#endif
3567 {
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03003568 const char *name;
Gregory P. Smith40a21602013-03-20 20:52:50 -07003569 if (path->narrow) {
3570 name = path->narrow;
Serhiy Storchaka1180e5a2017-07-11 06:36:46 +03003571 /* only return bytes if they specified a bytes-like object */
3572 return_str = !PyObject_CheckBuffer(path->object);
Larry Hastingsfdaea062012-06-25 04:42:23 -07003573 }
3574 else {
3575 name = ".";
3576 return_str = 1;
3577 }
3578
Larry Hastings9cf065c2012-06-22 16:30:09 -07003579 Py_BEGIN_ALLOW_THREADS
3580 dirp = opendir(name);
3581 Py_END_ALLOW_THREADS
3582 }
3583
3584 if (dirp == NULL) {
Gregory P. Smith40a21602013-03-20 20:52:50 -07003585 list = path_error(path);
Larry Hastings4dbc95e2013-08-01 18:18:56 -07003586#ifdef HAVE_FDOPENDIR
3587 if (fd != -1) {
3588 Py_BEGIN_ALLOW_THREADS
3589 close(fd);
3590 Py_END_ALLOW_THREADS
3591 }
3592#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07003593 goto exit;
3594 }
3595 if ((list = PyList_New(0)) == NULL) {
3596 goto exit;
Victor Stinner8c62be82010-05-06 00:08:46 +00003597 }
3598 for (;;) {
3599 errno = 0;
3600 Py_BEGIN_ALLOW_THREADS
3601 ep = readdir(dirp);
3602 Py_END_ALLOW_THREADS
3603 if (ep == NULL) {
3604 if (errno == 0) {
3605 break;
3606 } else {
Larry Hastings9cf065c2012-06-22 16:30:09 -07003607 Py_DECREF(list);
Gregory P. Smith40a21602013-03-20 20:52:50 -07003608 list = path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003609 goto exit;
Victor Stinner8c62be82010-05-06 00:08:46 +00003610 }
3611 }
3612 if (ep->d_name[0] == '.' &&
3613 (NAMLEN(ep) == 1 ||
3614 (ep->d_name[1] == '.' && NAMLEN(ep) == 2)))
3615 continue;
Larry Hastingsfdaea062012-06-25 04:42:23 -07003616 if (return_str)
Victor Stinnera45598a2010-05-14 16:35:39 +00003617 v = PyUnicode_DecodeFSDefaultAndSize(ep->d_name, NAMLEN(ep));
3618 else
3619 v = PyBytes_FromStringAndSize(ep->d_name, NAMLEN(ep));
Victor Stinner8c62be82010-05-06 00:08:46 +00003620 if (v == NULL) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07003621 Py_CLEAR(list);
Victor Stinner8c62be82010-05-06 00:08:46 +00003622 break;
3623 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07003624 if (PyList_Append(list, v) != 0) {
Victor Stinner8c62be82010-05-06 00:08:46 +00003625 Py_DECREF(v);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003626 Py_CLEAR(list);
Victor Stinner8c62be82010-05-06 00:08:46 +00003627 break;
3628 }
3629 Py_DECREF(v);
3630 }
Guido van Rossum0ee42cd1991-04-08 21:01:03 +00003631
Larry Hastings9cf065c2012-06-22 16:30:09 -07003632exit:
3633 if (dirp != NULL) {
3634 Py_BEGIN_ALLOW_THREADS
Larry Hastings4dbc95e2013-08-01 18:18:56 -07003635#ifdef HAVE_FDOPENDIR
Larry Hastings9cf065c2012-06-22 16:30:09 -07003636 if (fd > -1)
3637 rewinddir(dirp);
Larry Hastings4dbc95e2013-08-01 18:18:56 -07003638#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07003639 closedir(dirp);
3640 Py_END_ALLOW_THREADS
3641 }
3642
Larry Hastings9cf065c2012-06-22 16:30:09 -07003643 return list;
Gregory P. Smith16ea14a2013-03-20 18:51:33 -07003644} /* end of _posix_listdir */
3645#endif /* which OS */
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00003646
Larry Hastings2f936352014-08-05 14:04:04 +10003647
3648/*[clinic input]
3649os.listdir
3650
3651 path : path_t(nullable=True, allow_fd='PATH_HAVE_FDOPENDIR') = None
3652
3653Return a list containing the names of the files in the directory.
3654
3655path can be specified as either str or bytes. If path is bytes,
3656 the filenames returned will also be bytes; in all other circumstances
3657 the filenames returned will be str.
3658If path is None, uses the path='.'.
3659On some platforms, path may also be specified as an open file descriptor;\
3660 the file descriptor must refer to a directory.
3661 If this functionality is unavailable, using it raises NotImplementedError.
3662
3663The list is in arbitrary order. It does not include the special
3664entries '.' and '..' even if they are present in the directory.
3665
3666
3667[clinic start generated code]*/
3668
Larry Hastings2f936352014-08-05 14:04:04 +10003669static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003670os_listdir_impl(PyObject *module, path_t *path)
3671/*[clinic end generated code: output=293045673fcd1a75 input=09e300416e3cd729]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003672{
3673#if defined(MS_WINDOWS) && !defined(HAVE_OPENDIR)
3674 return _listdir_windows_no_opendir(path, NULL);
3675#else
3676 return _posix_listdir(path, NULL);
3677#endif
3678}
3679
Martin v. Löwis6238d2b2002-06-30 15:26:10 +00003680#ifdef MS_WINDOWS
Mark Hammondef8b6542001-05-13 08:04:26 +00003681/* A helper function for abspath on win32 */
Serhiy Storchakaf0b50152015-05-13 00:52:39 +03003682/*[clinic input]
3683os._getfullpathname
Victor Stinnereb5657a2011-09-30 01:44:27 +02003684
Serhiy Storchakaf0b50152015-05-13 00:52:39 +03003685 path: path_t
3686 /
3687
3688[clinic start generated code]*/
3689
3690static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003691os__getfullpathname_impl(PyObject *module, path_t *path)
3692/*[clinic end generated code: output=bb8679d56845bc9b input=332ed537c29d0a3e]*/
Serhiy Storchakaf0b50152015-05-13 00:52:39 +03003693{
Steve Dowercc16be82016-09-08 10:35:16 -07003694 wchar_t woutbuf[MAX_PATH], *woutbufp = woutbuf;
3695 wchar_t *wtemp;
3696 DWORD result;
3697 PyObject *v;
Victor Stinnereb5657a2011-09-30 01:44:27 +02003698
Steve Dowercc16be82016-09-08 10:35:16 -07003699 result = GetFullPathNameW(path->wide,
3700 Py_ARRAY_LENGTH(woutbuf),
3701 woutbuf, &wtemp);
3702 if (result > Py_ARRAY_LENGTH(woutbuf)) {
3703 woutbufp = PyMem_New(wchar_t, result);
3704 if (!woutbufp)
3705 return PyErr_NoMemory();
3706 result = GetFullPathNameW(path->wide, result, woutbufp, &wtemp);
Victor Stinner8c62be82010-05-06 00:08:46 +00003707 }
Steve Dowercc16be82016-09-08 10:35:16 -07003708 if (result) {
3709 v = PyUnicode_FromWideChar(woutbufp, wcslen(woutbufp));
3710 if (path->narrow)
3711 Py_SETREF(v, PyUnicode_EncodeFSDefault(v));
3712 } else
3713 v = win32_error_object("GetFullPathNameW", path->object);
3714 if (woutbufp != woutbuf)
3715 PyMem_Free(woutbufp);
3716 return v;
Larry Hastings2f936352014-08-05 14:04:04 +10003717}
Brian Curtind40e6f72010-07-08 21:39:08 +00003718
Brian Curtind25aef52011-06-13 15:16:04 -05003719
Larry Hastings2f936352014-08-05 14:04:04 +10003720/*[clinic input]
3721os._getfinalpathname
Brian Curtinf5e76d02010-11-24 13:14:05 +00003722
Larry Hastings2f936352014-08-05 14:04:04 +10003723 path: unicode
3724 /
3725
3726A helper function for samepath on windows.
3727[clinic start generated code]*/
3728
Larry Hastings2f936352014-08-05 14:04:04 +10003729static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003730os__getfinalpathname_impl(PyObject *module, PyObject *path)
3731/*[clinic end generated code: output=9bd78d0e52782e75 input=71d5e89334891bf4]*/
Brian Curtind40e6f72010-07-08 21:39:08 +00003732{
3733 HANDLE hFile;
3734 int buf_size;
3735 wchar_t *target_path;
3736 int result_length;
Larry Hastings2f936352014-08-05 14:04:04 +10003737 PyObject *result;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03003738 const wchar_t *path_wchar;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00003739
Serhiy Storchakaf7eae0a2017-06-28 08:30:06 +03003740 path_wchar = _PyUnicode_AsUnicode(path);
Larry Hastings2f936352014-08-05 14:04:04 +10003741 if (path_wchar == NULL)
Victor Stinnereb5657a2011-09-30 01:44:27 +02003742 return NULL;
Brian Curtind40e6f72010-07-08 21:39:08 +00003743
Brian Curtind40e6f72010-07-08 21:39:08 +00003744 hFile = CreateFileW(
Larry Hastings2f936352014-08-05 14:04:04 +10003745 path_wchar,
Brian Curtind40e6f72010-07-08 21:39:08 +00003746 0, /* desired access */
3747 0, /* share mode */
3748 NULL, /* security attributes */
3749 OPEN_EXISTING,
3750 /* FILE_FLAG_BACKUP_SEMANTICS is required to open a directory */
3751 FILE_FLAG_BACKUP_SEMANTICS,
3752 NULL);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00003753
Victor Stinnereb5657a2011-09-30 01:44:27 +02003754 if(hFile == INVALID_HANDLE_VALUE)
Larry Hastings2f936352014-08-05 14:04:04 +10003755 return win32_error_object("CreateFileW", path);
Brian Curtind40e6f72010-07-08 21:39:08 +00003756
3757 /* We have a good handle to the target, use it to determine the
3758 target path name. */
Steve Dower2ea51c92015-03-20 21:49:12 -07003759 buf_size = GetFinalPathNameByHandleW(hFile, 0, 0, VOLUME_NAME_NT);
Brian Curtind40e6f72010-07-08 21:39:08 +00003760
3761 if(!buf_size)
Larry Hastings2f936352014-08-05 14:04:04 +10003762 return win32_error_object("GetFinalPathNameByHandle", path);
Brian Curtind40e6f72010-07-08 21:39:08 +00003763
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02003764 target_path = PyMem_New(wchar_t, buf_size+1);
Brian Curtind40e6f72010-07-08 21:39:08 +00003765 if(!target_path)
3766 return PyErr_NoMemory();
3767
Steve Dower2ea51c92015-03-20 21:49:12 -07003768 result_length = GetFinalPathNameByHandleW(hFile, target_path,
3769 buf_size, VOLUME_NAME_DOS);
Brian Curtind40e6f72010-07-08 21:39:08 +00003770 if(!result_length)
Larry Hastings2f936352014-08-05 14:04:04 +10003771 return win32_error_object("GetFinalPathNamyByHandle", path);
Brian Curtind40e6f72010-07-08 21:39:08 +00003772
3773 if(!CloseHandle(hFile))
Larry Hastings2f936352014-08-05 14:04:04 +10003774 return win32_error_object("CloseHandle", path);
Brian Curtind40e6f72010-07-08 21:39:08 +00003775
3776 target_path[result_length] = 0;
Victor Stinner9d3b93b2011-11-22 02:27:30 +01003777 result = PyUnicode_FromWideChar(target_path, result_length);
Victor Stinnerb6404912013-07-07 16:21:41 +02003778 PyMem_Free(target_path);
Brian Curtind40e6f72010-07-08 21:39:08 +00003779 return result;
Larry Hastings2f936352014-08-05 14:04:04 +10003780}
Brian Curtin62857742010-09-06 17:07:27 +00003781
Serhiy Storchakaf0b50152015-05-13 00:52:39 +03003782/*[clinic input]
3783os._isdir
3784
3785 path: path_t
3786 /
3787
Serhiy Storchaka579f0382016-11-08 20:21:22 +02003788Return true if the pathname refers to an existing directory.
Serhiy Storchakaf0b50152015-05-13 00:52:39 +03003789[clinic start generated code]*/
3790
Brian Curtin9c669cc2011-06-08 18:17:18 -05003791static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003792os__isdir_impl(PyObject *module, path_t *path)
Serhiy Storchaka579f0382016-11-08 20:21:22 +02003793/*[clinic end generated code: output=75f56f32720836cb input=5e0800149c0ad95f]*/
Brian Curtin9c669cc2011-06-08 18:17:18 -05003794{
Brian Curtin9c669cc2011-06-08 18:17:18 -05003795 DWORD attributes;
3796
Steve Dowerb22a6772016-07-17 20:49:38 -07003797 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07003798 attributes = GetFileAttributesW(path->wide);
Steve Dowerb22a6772016-07-17 20:49:38 -07003799 Py_END_ALLOW_THREADS
Brian Curtin9c669cc2011-06-08 18:17:18 -05003800
Brian Curtin9c669cc2011-06-08 18:17:18 -05003801 if (attributes == INVALID_FILE_ATTRIBUTES)
3802 Py_RETURN_FALSE;
3803
Brian Curtin9c669cc2011-06-08 18:17:18 -05003804 if (attributes & FILE_ATTRIBUTE_DIRECTORY)
3805 Py_RETURN_TRUE;
3806 else
3807 Py_RETURN_FALSE;
3808}
Tim Golden6b528062013-08-01 12:44:00 +01003809
Tim Golden6b528062013-08-01 12:44:00 +01003810
Larry Hastings2f936352014-08-05 14:04:04 +10003811/*[clinic input]
3812os._getvolumepathname
3813
3814 path: unicode
3815
3816A helper function for ismount on Win32.
3817[clinic start generated code]*/
3818
Larry Hastings2f936352014-08-05 14:04:04 +10003819static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003820os__getvolumepathname_impl(PyObject *module, PyObject *path)
3821/*[clinic end generated code: output=cbdcbd1059ceef4c input=7eacadc40acbda6b]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003822{
3823 PyObject *result;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03003824 const wchar_t *path_wchar;
3825 wchar_t *mountpath=NULL;
Victor Stinner6edddfa2013-11-24 19:22:57 +01003826 size_t buflen;
Tim Golden6b528062013-08-01 12:44:00 +01003827 BOOL ret;
3828
Larry Hastings2f936352014-08-05 14:04:04 +10003829 path_wchar = PyUnicode_AsUnicodeAndSize(path, &buflen);
3830 if (path_wchar == NULL)
Tim Golden6b528062013-08-01 12:44:00 +01003831 return NULL;
Victor Stinner6edddfa2013-11-24 19:22:57 +01003832 buflen += 1;
Tim Golden6b528062013-08-01 12:44:00 +01003833
3834 /* Volume path should be shorter than entire path */
Victor Stinner6edddfa2013-11-24 19:22:57 +01003835 buflen = Py_MAX(buflen, MAX_PATH);
3836
Victor Stinner850a18e2017-10-24 16:53:32 -07003837 if (buflen > PY_DWORD_MAX) {
Victor Stinner6edddfa2013-11-24 19:22:57 +01003838 PyErr_SetString(PyExc_OverflowError, "path too long");
3839 return NULL;
3840 }
3841
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02003842 mountpath = PyMem_New(wchar_t, buflen);
Tim Golden6b528062013-08-01 12:44:00 +01003843 if (mountpath == NULL)
3844 return PyErr_NoMemory();
3845
3846 Py_BEGIN_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10003847 ret = GetVolumePathNameW(path_wchar, mountpath,
Victor Stinner6edddfa2013-11-24 19:22:57 +01003848 Py_SAFE_DOWNCAST(buflen, size_t, DWORD));
Tim Golden6b528062013-08-01 12:44:00 +01003849 Py_END_ALLOW_THREADS
3850
3851 if (!ret) {
Larry Hastings2f936352014-08-05 14:04:04 +10003852 result = win32_error_object("_getvolumepathname", path);
Tim Golden6b528062013-08-01 12:44:00 +01003853 goto exit;
3854 }
3855 result = PyUnicode_FromWideChar(mountpath, wcslen(mountpath));
3856
3857exit:
3858 PyMem_Free(mountpath);
3859 return result;
3860}
Tim Golden6b528062013-08-01 12:44:00 +01003861
Martin v. Löwis6238d2b2002-06-30 15:26:10 +00003862#endif /* MS_WINDOWS */
Mark Hammondef8b6542001-05-13 08:04:26 +00003863
Larry Hastings2f936352014-08-05 14:04:04 +10003864
3865/*[clinic input]
3866os.mkdir
3867
3868 path : path_t
3869
3870 mode: int = 0o777
3871
3872 *
3873
3874 dir_fd : dir_fd(requires='mkdirat') = None
3875
3876# "mkdir(path, mode=0o777, *, dir_fd=None)\n\n\
3877
3878Create a directory.
3879
3880If dir_fd is not None, it should be a file descriptor open to a directory,
3881 and path should be relative; path will then be relative to that directory.
3882dir_fd may not be implemented on your platform.
3883 If it is unavailable, using it will raise a NotImplementedError.
3884
3885The mode argument is ignored on Windows.
3886[clinic start generated code]*/
3887
Larry Hastings2f936352014-08-05 14:04:04 +10003888static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003889os_mkdir_impl(PyObject *module, path_t *path, int mode, int dir_fd)
3890/*[clinic end generated code: output=a70446903abe821f input=e965f68377e9b1ce]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003891{
3892 int result;
Mark Hammondc2e85bd2002-10-03 05:10:39 +00003893
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00003894#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00003895 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07003896 result = CreateDirectoryW(path->wide, NULL);
Victor Stinner8c62be82010-05-06 00:08:46 +00003897 Py_END_ALLOW_THREADS
Mark Hammondc2e85bd2002-10-03 05:10:39 +00003898
Larry Hastings2f936352014-08-05 14:04:04 +10003899 if (!result)
3900 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003901#else
Victor Stinner8c62be82010-05-06 00:08:46 +00003902 Py_BEGIN_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07003903#if HAVE_MKDIRAT
3904 if (dir_fd != DEFAULT_DIR_FD)
Larry Hastings2f936352014-08-05 14:04:04 +10003905 result = mkdirat(dir_fd, path->narrow, mode);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003906 else
3907#endif
Erik Bray03eb11f2017-10-27 14:27:06 +02003908#if defined(__WATCOMC__) && !defined(__QNX__)
Larry Hastings2f936352014-08-05 14:04:04 +10003909 result = mkdir(path->narrow);
Guido van Rossuma4916fa1996-05-23 22:58:55 +00003910#else
Larry Hastings2f936352014-08-05 14:04:04 +10003911 result = mkdir(path->narrow, mode);
Guido van Rossuma4916fa1996-05-23 22:58:55 +00003912#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00003913 Py_END_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10003914 if (result < 0)
3915 return path_error(path);
Steve Dowercc16be82016-09-08 10:35:16 -07003916#endif /* MS_WINDOWS */
Larry Hastings2f936352014-08-05 14:04:04 +10003917 Py_RETURN_NONE;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003918}
3919
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00003920
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003921/* sys/resource.h is needed for at least: wait3(), wait4(), broken nice. */
3922#if defined(HAVE_SYS_RESOURCE_H)
Thomas Wouterse38b2f12001-07-11 22:35:31 +00003923#include <sys/resource.h>
3924#endif
Thomas Wouterse38b2f12001-07-11 22:35:31 +00003925
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003926
3927#ifdef HAVE_NICE
Larry Hastings2f936352014-08-05 14:04:04 +10003928/*[clinic input]
3929os.nice
3930
3931 increment: int
3932 /
3933
3934Add increment to the priority of process and return the new priority.
3935[clinic start generated code]*/
3936
Larry Hastings2f936352014-08-05 14:04:04 +10003937static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003938os_nice_impl(PyObject *module, int increment)
3939/*[clinic end generated code: output=9dad8a9da8109943 input=864be2d402a21da2]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003940{
3941 int value;
Thomas Woutersc2c12dc2001-07-11 14:45:34 +00003942
Victor Stinner8c62be82010-05-06 00:08:46 +00003943 /* There are two flavours of 'nice': one that returns the new
3944 priority (as required by almost all standards out there) and the
Benjamin Peterson288d1da2017-09-28 22:44:27 -07003945 Linux/FreeBSD one, which returns '0' on success and advices
Victor Stinner8c62be82010-05-06 00:08:46 +00003946 the use of getpriority() to get the new priority.
Tim Peters5aa91602002-01-30 05:46:57 +00003947
Victor Stinner8c62be82010-05-06 00:08:46 +00003948 If we are of the nice family that returns the new priority, we
3949 need to clear errno before the call, and check if errno is filled
3950 before calling posix_error() on a returnvalue of -1, because the
3951 -1 may be the actual new priority! */
Thomas Woutersc2c12dc2001-07-11 14:45:34 +00003952
Victor Stinner8c62be82010-05-06 00:08:46 +00003953 errno = 0;
3954 value = nice(increment);
Thomas Wouterse38b2f12001-07-11 22:35:31 +00003955#if defined(HAVE_BROKEN_NICE) && defined(HAVE_GETPRIORITY)
Victor Stinner8c62be82010-05-06 00:08:46 +00003956 if (value == 0)
3957 value = getpriority(PRIO_PROCESS, 0);
Thomas Woutersc2c12dc2001-07-11 14:45:34 +00003958#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00003959 if (value == -1 && errno != 0)
3960 /* either nice() or getpriority() returned an error */
3961 return posix_error();
3962 return PyLong_FromLong((long) value);
Guido van Rossum775f4da1993-01-09 17:18:52 +00003963}
Guido van Rossumb6775db1994-08-01 11:34:53 +00003964#endif /* HAVE_NICE */
Guido van Rossum1ff6cb41991-04-08 20:59:13 +00003965
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00003966
3967#ifdef HAVE_GETPRIORITY
Larry Hastings2f936352014-08-05 14:04:04 +10003968/*[clinic input]
3969os.getpriority
3970
3971 which: int
3972 who: int
3973
3974Return program scheduling priority.
3975[clinic start generated code]*/
3976
Larry Hastings2f936352014-08-05 14:04:04 +10003977static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003978os_getpriority_impl(PyObject *module, int which, int who)
3979/*[clinic end generated code: output=c41b7b63c7420228 input=9be615d40e2544ef]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003980{
3981 int retval;
3982
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00003983 errno = 0;
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00003984 retval = getpriority(which, who);
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00003985 if (errno != 0)
3986 return posix_error();
3987 return PyLong_FromLong((long)retval);
3988}
3989#endif /* HAVE_GETPRIORITY */
3990
3991
3992#ifdef HAVE_SETPRIORITY
Larry Hastings2f936352014-08-05 14:04:04 +10003993/*[clinic input]
3994os.setpriority
3995
3996 which: int
3997 who: int
3998 priority: int
3999
4000Set program scheduling priority.
4001[clinic start generated code]*/
4002
Larry Hastings2f936352014-08-05 14:04:04 +10004003static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004004os_setpriority_impl(PyObject *module, int which, int who, int priority)
4005/*[clinic end generated code: output=3d910d95a7771eb2 input=710ccbf65b9dc513]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004006{
4007 int retval;
4008
4009 retval = setpriority(which, who, priority);
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00004010 if (retval == -1)
4011 return posix_error();
4012 Py_RETURN_NONE;
4013}
4014#endif /* HAVE_SETPRIORITY */
4015
4016
Barry Warsaw53699e91996-12-10 23:23:01 +00004017static PyObject *
Larry Hastings2f936352014-08-05 14:04:04 +10004018internal_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 +00004019{
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03004020 const char *function_name = is_replace ? "replace" : "rename";
Larry Hastings9cf065c2012-06-22 16:30:09 -07004021 int dir_fd_specified;
Larry Hastings9cf065c2012-06-22 16:30:09 -07004022
Mark Hammondc2e85bd2002-10-03 05:10:39 +00004023#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00004024 BOOL result;
Antoine Pitrouf3b2d882012-01-30 22:08:52 +01004025 int flags = is_replace ? MOVEFILE_REPLACE_EXISTING : 0;
Mark Hammondc2e85bd2002-10-03 05:10:39 +00004026#else
Larry Hastings9cf065c2012-06-22 16:30:09 -07004027 int result;
Mark Hammondc2e85bd2002-10-03 05:10:39 +00004028#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07004029
Larry Hastings9cf065c2012-06-22 16:30:09 -07004030 dir_fd_specified = (src_dir_fd != DEFAULT_DIR_FD) ||
4031 (dst_dir_fd != DEFAULT_DIR_FD);
4032#ifndef HAVE_RENAMEAT
4033 if (dir_fd_specified) {
4034 argument_unavailable_error(function_name, "src_dir_fd and dst_dir_fd");
Larry Hastings2f936352014-08-05 14:04:04 +10004035 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07004036 }
4037#endif
4038
Larry Hastings9cf065c2012-06-22 16:30:09 -07004039#ifdef MS_WINDOWS
4040 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07004041 result = MoveFileExW(src->wide, dst->wide, flags);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004042 Py_END_ALLOW_THREADS
4043
Larry Hastings2f936352014-08-05 14:04:04 +10004044 if (!result)
4045 return path_error2(src, dst);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004046
4047#else
Steve Dowercc16be82016-09-08 10:35:16 -07004048 if ((src->narrow && dst->wide) || (src->wide && dst->narrow)) {
4049 PyErr_Format(PyExc_ValueError,
4050 "%s: src and dst must be the same type", function_name);
4051 return NULL;
4052 }
4053
Larry Hastings9cf065c2012-06-22 16:30:09 -07004054 Py_BEGIN_ALLOW_THREADS
4055#ifdef HAVE_RENAMEAT
4056 if (dir_fd_specified)
Larry Hastings2f936352014-08-05 14:04:04 +10004057 result = renameat(src_dir_fd, src->narrow, dst_dir_fd, dst->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004058 else
4059#endif
Steve Dowercc16be82016-09-08 10:35:16 -07004060 result = rename(src->narrow, dst->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004061 Py_END_ALLOW_THREADS
4062
Larry Hastings2f936352014-08-05 14:04:04 +10004063 if (result)
4064 return path_error2(src, dst);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004065#endif
Larry Hastings2f936352014-08-05 14:04:04 +10004066 Py_RETURN_NONE;
4067}
Larry Hastings9cf065c2012-06-22 16:30:09 -07004068
Larry Hastings2f936352014-08-05 14:04:04 +10004069
4070/*[clinic input]
4071os.rename
4072
4073 src : path_t
4074 dst : path_t
4075 *
4076 src_dir_fd : dir_fd = None
4077 dst_dir_fd : dir_fd = None
4078
4079Rename a file or directory.
4080
4081If either src_dir_fd or dst_dir_fd is not None, it should be a file
4082 descriptor open to a directory, and the respective path string (src or dst)
4083 should be relative; the path will then be relative to that directory.
4084src_dir_fd and dst_dir_fd, may not be implemented on your platform.
4085 If they are unavailable, using them will raise a NotImplementedError.
4086[clinic start generated code]*/
4087
Antoine Pitrouf3b2d882012-01-30 22:08:52 +01004088static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004089os_rename_impl(PyObject *module, path_t *src, path_t *dst, int src_dir_fd,
Larry Hastings89964c42015-04-14 18:07:59 -04004090 int dst_dir_fd)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004091/*[clinic end generated code: output=59e803072cf41230 input=faa61c847912c850]*/
Antoine Pitrouf3b2d882012-01-30 22:08:52 +01004092{
Larry Hastings2f936352014-08-05 14:04:04 +10004093 return internal_rename(src, dst, src_dir_fd, dst_dir_fd, 0);
Antoine Pitrouf3b2d882012-01-30 22:08:52 +01004094}
4095
Larry Hastings2f936352014-08-05 14:04:04 +10004096
4097/*[clinic input]
4098os.replace = os.rename
4099
4100Rename a file or directory, overwriting the destination.
4101
4102If either src_dir_fd or dst_dir_fd is not None, it should be a file
4103 descriptor open to a directory, and the respective path string (src or dst)
4104 should be relative; the path will then be relative to that directory.
4105src_dir_fd and dst_dir_fd, may not be implemented on your platform.
4106 If they are unavailable, using them will raise a NotImplementedError."
4107[clinic start generated code]*/
4108
Larry Hastings2f936352014-08-05 14:04:04 +10004109static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004110os_replace_impl(PyObject *module, path_t *src, path_t *dst, int src_dir_fd,
4111 int dst_dir_fd)
4112/*[clinic end generated code: output=1968c02e7857422b input=25515dfb107c8421]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004113{
4114 return internal_rename(src, dst, src_dir_fd, dst_dir_fd, 1);
4115}
4116
4117
4118/*[clinic input]
4119os.rmdir
4120
4121 path: path_t
4122 *
4123 dir_fd: dir_fd(requires='unlinkat') = None
4124
4125Remove a directory.
4126
4127If dir_fd is not None, it should be a file descriptor open to a directory,
4128 and path should be relative; path will then be relative to that directory.
4129dir_fd may not be implemented on your platform.
4130 If it is unavailable, using it will raise a NotImplementedError.
4131[clinic start generated code]*/
4132
Larry Hastings2f936352014-08-05 14:04:04 +10004133static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004134os_rmdir_impl(PyObject *module, path_t *path, int dir_fd)
4135/*[clinic end generated code: output=080eb54f506e8301 input=38c8b375ca34a7e2]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004136{
4137 int result;
Larry Hastingsb698d8e2012-06-23 16:55:07 -07004138
4139 Py_BEGIN_ALLOW_THREADS
4140#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07004141 /* Windows, success=1, UNIX, success=0 */
4142 result = !RemoveDirectoryW(path->wide);
Larry Hastingsb698d8e2012-06-23 16:55:07 -07004143#else
4144#ifdef HAVE_UNLINKAT
4145 if (dir_fd != DEFAULT_DIR_FD)
Larry Hastings2f936352014-08-05 14:04:04 +10004146 result = unlinkat(dir_fd, path->narrow, AT_REMOVEDIR);
Larry Hastingsb698d8e2012-06-23 16:55:07 -07004147 else
4148#endif
Larry Hastings2f936352014-08-05 14:04:04 +10004149 result = rmdir(path->narrow);
Larry Hastingsb698d8e2012-06-23 16:55:07 -07004150#endif
4151 Py_END_ALLOW_THREADS
4152
Larry Hastings2f936352014-08-05 14:04:04 +10004153 if (result)
4154 return path_error(path);
Larry Hastingsb698d8e2012-06-23 16:55:07 -07004155
Larry Hastings2f936352014-08-05 14:04:04 +10004156 Py_RETURN_NONE;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004157}
4158
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004159
Guido van Rossuma4916fa1996-05-23 22:58:55 +00004160#ifdef HAVE_SYSTEM
Larry Hastings2f936352014-08-05 14:04:04 +10004161#ifdef MS_WINDOWS
4162/*[clinic input]
4163os.system -> long
4164
4165 command: Py_UNICODE
4166
4167Execute the command in a subshell.
4168[clinic start generated code]*/
4169
Larry Hastings2f936352014-08-05 14:04:04 +10004170static long
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004171os_system_impl(PyObject *module, Py_UNICODE *command)
4172/*[clinic end generated code: output=96c4dffee36dfb48 input=303f5ce97df606b0]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004173{
4174 long result;
Victor Stinner8c62be82010-05-06 00:08:46 +00004175 Py_BEGIN_ALLOW_THREADS
Steve Dowerc3630612016-11-19 18:41:16 -08004176 _Py_BEGIN_SUPPRESS_IPH
Larry Hastings2f936352014-08-05 14:04:04 +10004177 result = _wsystem(command);
Steve Dowerc3630612016-11-19 18:41:16 -08004178 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00004179 Py_END_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10004180 return result;
4181}
4182#else /* MS_WINDOWS */
4183/*[clinic input]
4184os.system -> long
4185
4186 command: FSConverter
4187
4188Execute the command in a subshell.
4189[clinic start generated code]*/
4190
Larry Hastings2f936352014-08-05 14:04:04 +10004191static long
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004192os_system_impl(PyObject *module, PyObject *command)
4193/*[clinic end generated code: output=290fc437dd4f33a0 input=86a58554ba6094af]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004194{
4195 long result;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03004196 const char *bytes = PyBytes_AsString(command);
Larry Hastings2f936352014-08-05 14:04:04 +10004197 Py_BEGIN_ALLOW_THREADS
4198 result = system(bytes);
4199 Py_END_ALLOW_THREADS
4200 return result;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004201}
Guido van Rossuma4916fa1996-05-23 22:58:55 +00004202#endif
Larry Hastings2f936352014-08-05 14:04:04 +10004203#endif /* HAVE_SYSTEM */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004204
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004205
Larry Hastings2f936352014-08-05 14:04:04 +10004206/*[clinic input]
4207os.umask
4208
4209 mask: int
4210 /
4211
4212Set the current numeric umask and return the previous umask.
4213[clinic start generated code]*/
4214
Larry Hastings2f936352014-08-05 14:04:04 +10004215static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004216os_umask_impl(PyObject *module, int mask)
4217/*[clinic end generated code: output=a2e33ce3bc1a6e33 input=ab6bfd9b24d8a7e8]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004218{
4219 int i = (int)umask(mask);
Victor Stinner8c62be82010-05-06 00:08:46 +00004220 if (i < 0)
4221 return posix_error();
4222 return PyLong_FromLong((long)i);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004223}
4224
Brian Curtind40e6f72010-07-08 21:39:08 +00004225#ifdef MS_WINDOWS
4226
4227/* override the default DeleteFileW behavior so that directory
4228symlinks can be removed with this function, the same as with
4229Unix symlinks */
4230BOOL WINAPI Py_DeleteFileW(LPCWSTR lpFileName)
4231{
4232 WIN32_FILE_ATTRIBUTE_DATA info;
4233 WIN32_FIND_DATAW find_data;
4234 HANDLE find_data_handle;
4235 int is_directory = 0;
4236 int is_link = 0;
4237
4238 if (GetFileAttributesExW(lpFileName, GetFileExInfoStandard, &info)) {
4239 is_directory = info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00004240
Brian Curtind40e6f72010-07-08 21:39:08 +00004241 /* Get WIN32_FIND_DATA structure for the path to determine if
4242 it is a symlink */
4243 if(is_directory &&
4244 info.dwFileAttributes & FILE_ATTRIBUTE_REPARSE_POINT) {
4245 find_data_handle = FindFirstFileW(lpFileName, &find_data);
4246
4247 if(find_data_handle != INVALID_HANDLE_VALUE) {
Tim Golden0321cf22014-05-05 19:46:17 +01004248 /* IO_REPARSE_TAG_SYMLINK if it is a symlink and
4249 IO_REPARSE_TAG_MOUNT_POINT if it is a junction point. */
4250 is_link = find_data.dwReserved0 == IO_REPARSE_TAG_SYMLINK ||
4251 find_data.dwReserved0 == IO_REPARSE_TAG_MOUNT_POINT;
Brian Curtind40e6f72010-07-08 21:39:08 +00004252 FindClose(find_data_handle);
4253 }
4254 }
4255 }
4256
4257 if (is_directory && is_link)
4258 return RemoveDirectoryW(lpFileName);
4259
4260 return DeleteFileW(lpFileName);
4261}
4262#endif /* MS_WINDOWS */
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004263
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004264
Larry Hastings2f936352014-08-05 14:04:04 +10004265/*[clinic input]
4266os.unlink
4267
4268 path: path_t
4269 *
4270 dir_fd: dir_fd(requires='unlinkat')=None
4271
4272Remove a file (same as remove()).
4273
4274If dir_fd is not None, it should be a file descriptor open to a directory,
4275 and path should be relative; path will then be relative to that directory.
4276dir_fd may not be implemented on your platform.
4277 If it is unavailable, using it will raise a NotImplementedError.
4278
4279[clinic start generated code]*/
4280
Larry Hastings2f936352014-08-05 14:04:04 +10004281static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004282os_unlink_impl(PyObject *module, path_t *path, int dir_fd)
4283/*[clinic end generated code: output=621797807b9963b1 input=d7bcde2b1b2a2552]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004284{
4285 int result;
Larry Hastings9cf065c2012-06-22 16:30:09 -07004286
4287 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04004288 _Py_BEGIN_SUPPRESS_IPH
Larry Hastings9cf065c2012-06-22 16:30:09 -07004289#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07004290 /* Windows, success=1, UNIX, success=0 */
4291 result = !Py_DeleteFileW(path->wide);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004292#else
Larry Hastings9cf065c2012-06-22 16:30:09 -07004293#ifdef HAVE_UNLINKAT
4294 if (dir_fd != DEFAULT_DIR_FD)
Larry Hastings2f936352014-08-05 14:04:04 +10004295 result = unlinkat(dir_fd, path->narrow, 0);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004296 else
4297#endif /* HAVE_UNLINKAT */
Larry Hastings2f936352014-08-05 14:04:04 +10004298 result = unlink(path->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004299#endif
Steve Dower8fc89802015-04-12 00:26:27 -04004300 _Py_END_SUPPRESS_IPH
Larry Hastings9cf065c2012-06-22 16:30:09 -07004301 Py_END_ALLOW_THREADS
4302
Larry Hastings2f936352014-08-05 14:04:04 +10004303 if (result)
4304 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004305
Larry Hastings2f936352014-08-05 14:04:04 +10004306 Py_RETURN_NONE;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004307}
4308
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004309
Larry Hastings2f936352014-08-05 14:04:04 +10004310/*[clinic input]
4311os.remove = os.unlink
4312
4313Remove a file (same as unlink()).
4314
4315If dir_fd is not None, it should be a file descriptor open to a directory,
4316 and path should be relative; path will then be relative to that directory.
4317dir_fd may not be implemented on your platform.
4318 If it is unavailable, using it will raise a NotImplementedError.
4319[clinic start generated code]*/
4320
Larry Hastings2f936352014-08-05 14:04:04 +10004321static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004322os_remove_impl(PyObject *module, path_t *path, int dir_fd)
4323/*[clinic end generated code: output=a8535b28f0068883 input=e05c5ab55cd30983]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004324{
4325 return os_unlink_impl(module, path, dir_fd);
4326}
4327
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004328
Larry Hastings605a62d2012-06-24 04:33:36 -07004329static PyStructSequence_Field uname_result_fields[] = {
4330 {"sysname", "operating system name"},
4331 {"nodename", "name of machine on network (implementation-defined)"},
4332 {"release", "operating system release"},
4333 {"version", "operating system version"},
4334 {"machine", "hardware identifier"},
4335 {NULL}
4336};
4337
4338PyDoc_STRVAR(uname_result__doc__,
4339"uname_result: Result from os.uname().\n\n\
4340This object may be accessed either as a tuple of\n\
4341 (sysname, nodename, release, version, machine),\n\
4342or via the attributes sysname, nodename, release, version, and machine.\n\
4343\n\
4344See os.uname for more information.");
4345
4346static PyStructSequence_Desc uname_result_desc = {
4347 "uname_result", /* name */
4348 uname_result__doc__, /* doc */
4349 uname_result_fields,
4350 5
4351};
4352
4353static PyTypeObject UnameResultType;
4354
4355
4356#ifdef HAVE_UNAME
Larry Hastings2f936352014-08-05 14:04:04 +10004357/*[clinic input]
4358os.uname
4359
4360Return an object identifying the current operating system.
4361
4362The object behaves like a named tuple with the following fields:
4363 (sysname, nodename, release, version, machine)
4364
4365[clinic start generated code]*/
4366
Larry Hastings2f936352014-08-05 14:04:04 +10004367static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004368os_uname_impl(PyObject *module)
4369/*[clinic end generated code: output=e6a49cf1a1508a19 input=e68bd246db3043ed]*/
Guido van Rossumc39de5f1992-02-05 11:15:54 +00004370{
Victor Stinner8c62be82010-05-06 00:08:46 +00004371 struct utsname u;
4372 int res;
Larry Hastings605a62d2012-06-24 04:33:36 -07004373 PyObject *value;
Neal Norwitze241ce82003-02-17 18:17:05 +00004374
Victor Stinner8c62be82010-05-06 00:08:46 +00004375 Py_BEGIN_ALLOW_THREADS
4376 res = uname(&u);
4377 Py_END_ALLOW_THREADS
4378 if (res < 0)
4379 return posix_error();
Larry Hastings605a62d2012-06-24 04:33:36 -07004380
4381 value = PyStructSequence_New(&UnameResultType);
4382 if (value == NULL)
4383 return NULL;
4384
4385#define SET(i, field) \
4386 { \
Victor Stinnera534fc42013-06-03 22:07:27 +02004387 PyObject *o = PyUnicode_DecodeFSDefault(field); \
Larry Hastings605a62d2012-06-24 04:33:36 -07004388 if (!o) { \
4389 Py_DECREF(value); \
4390 return NULL; \
4391 } \
4392 PyStructSequence_SET_ITEM(value, i, o); \
4393 } \
4394
4395 SET(0, u.sysname);
4396 SET(1, u.nodename);
4397 SET(2, u.release);
4398 SET(3, u.version);
4399 SET(4, u.machine);
4400
4401#undef SET
4402
4403 return value;
Guido van Rossumc39de5f1992-02-05 11:15:54 +00004404}
Guido van Rossumb6775db1994-08-01 11:34:53 +00004405#endif /* HAVE_UNAME */
Guido van Rossum1ff6cb41991-04-08 20:59:13 +00004406
Larry Hastings9e3e70b2011-09-08 19:29:07 -07004407
Larry Hastings9cf065c2012-06-22 16:30:09 -07004408
4409typedef struct {
4410 int now;
4411 time_t atime_s;
4412 long atime_ns;
4413 time_t mtime_s;
4414 long mtime_ns;
4415} utime_t;
4416
4417/*
Victor Stinner484df002014-10-09 13:52:31 +02004418 * these macros assume that "ut" is a pointer to a utime_t
Larry Hastings9cf065c2012-06-22 16:30:09 -07004419 * they also intentionally leak the declaration of a pointer named "time"
4420 */
4421#define UTIME_TO_TIMESPEC \
4422 struct timespec ts[2]; \
4423 struct timespec *time; \
Victor Stinner484df002014-10-09 13:52:31 +02004424 if (ut->now) \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004425 time = NULL; \
4426 else { \
Victor Stinner484df002014-10-09 13:52:31 +02004427 ts[0].tv_sec = ut->atime_s; \
4428 ts[0].tv_nsec = ut->atime_ns; \
4429 ts[1].tv_sec = ut->mtime_s; \
4430 ts[1].tv_nsec = ut->mtime_ns; \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004431 time = ts; \
4432 } \
4433
4434#define UTIME_TO_TIMEVAL \
4435 struct timeval tv[2]; \
4436 struct timeval *time; \
Victor Stinner484df002014-10-09 13:52:31 +02004437 if (ut->now) \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004438 time = NULL; \
4439 else { \
Victor Stinner484df002014-10-09 13:52:31 +02004440 tv[0].tv_sec = ut->atime_s; \
4441 tv[0].tv_usec = ut->atime_ns / 1000; \
4442 tv[1].tv_sec = ut->mtime_s; \
4443 tv[1].tv_usec = ut->mtime_ns / 1000; \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004444 time = tv; \
4445 } \
4446
4447#define UTIME_TO_UTIMBUF \
Georg Brandle1a7d9d2014-10-12 08:45:15 +02004448 struct utimbuf u; \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004449 struct utimbuf *time; \
Victor Stinner484df002014-10-09 13:52:31 +02004450 if (ut->now) \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004451 time = NULL; \
4452 else { \
Georg Brandle1a7d9d2014-10-12 08:45:15 +02004453 u.actime = ut->atime_s; \
4454 u.modtime = ut->mtime_s; \
4455 time = &u; \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004456 }
4457
4458#define UTIME_TO_TIME_T \
4459 time_t timet[2]; \
Georg Brandle1a7d9d2014-10-12 08:45:15 +02004460 time_t *time; \
Victor Stinner484df002014-10-09 13:52:31 +02004461 if (ut->now) \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004462 time = NULL; \
4463 else { \
Victor Stinner484df002014-10-09 13:52:31 +02004464 timet[0] = ut->atime_s; \
4465 timet[1] = ut->mtime_s; \
Georg Brandle1a7d9d2014-10-12 08:45:15 +02004466 time = timet; \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004467 } \
4468
4469
Victor Stinner528a9ab2015-09-03 21:30:26 +02004470#if defined(HAVE_FUTIMESAT) || defined(HAVE_UTIMENSAT)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004471
4472static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02004473utime_dir_fd(utime_t *ut, int dir_fd, const char *path, int follow_symlinks)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004474{
4475#ifdef HAVE_UTIMENSAT
4476 int flags = follow_symlinks ? 0 : AT_SYMLINK_NOFOLLOW;
4477 UTIME_TO_TIMESPEC;
4478 return utimensat(dir_fd, path, time, flags);
4479#elif defined(HAVE_FUTIMESAT)
4480 UTIME_TO_TIMEVAL;
4481 /*
4482 * follow_symlinks will never be false here;
4483 * we only allow !follow_symlinks and dir_fd together
4484 * if we have utimensat()
4485 */
4486 assert(follow_symlinks);
4487 return futimesat(dir_fd, path, time);
4488#endif
4489}
4490
Larry Hastings2f936352014-08-05 14:04:04 +10004491 #define FUTIMENSAT_DIR_FD_CONVERTER dir_fd_converter
4492#else
4493 #define FUTIMENSAT_DIR_FD_CONVERTER dir_fd_unavailable
Larry Hastings9cf065c2012-06-22 16:30:09 -07004494#endif
4495
Victor Stinner528a9ab2015-09-03 21:30:26 +02004496#if defined(HAVE_FUTIMES) || defined(HAVE_FUTIMENS)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004497
4498static int
Victor Stinner484df002014-10-09 13:52:31 +02004499utime_fd(utime_t *ut, int fd)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004500{
4501#ifdef HAVE_FUTIMENS
4502 UTIME_TO_TIMESPEC;
4503 return futimens(fd, time);
4504#else
4505 UTIME_TO_TIMEVAL;
4506 return futimes(fd, time);
4507#endif
4508}
4509
Larry Hastings2f936352014-08-05 14:04:04 +10004510 #define PATH_UTIME_HAVE_FD 1
4511#else
4512 #define PATH_UTIME_HAVE_FD 0
Larry Hastings9cf065c2012-06-22 16:30:09 -07004513#endif
4514
Victor Stinner5ebae872015-09-22 01:29:33 +02004515#if defined(HAVE_UTIMENSAT) || defined(HAVE_LUTIMES)
4516# define UTIME_HAVE_NOFOLLOW_SYMLINKS
4517#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07004518
Victor Stinner4552ced2015-09-21 22:37:15 +02004519#ifdef UTIME_HAVE_NOFOLLOW_SYMLINKS
Larry Hastings9cf065c2012-06-22 16:30:09 -07004520
4521static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02004522utime_nofollow_symlinks(utime_t *ut, const char *path)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004523{
4524#ifdef HAVE_UTIMENSAT
4525 UTIME_TO_TIMESPEC;
4526 return utimensat(DEFAULT_DIR_FD, path, time, AT_SYMLINK_NOFOLLOW);
4527#else
4528 UTIME_TO_TIMEVAL;
4529 return lutimes(path, time);
4530#endif
4531}
4532
4533#endif
4534
4535#ifndef MS_WINDOWS
4536
4537static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02004538utime_default(utime_t *ut, const char *path)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004539{
4540#ifdef HAVE_UTIMENSAT
4541 UTIME_TO_TIMESPEC;
4542 return utimensat(DEFAULT_DIR_FD, path, time, 0);
4543#elif defined(HAVE_UTIMES)
4544 UTIME_TO_TIMEVAL;
4545 return utimes(path, time);
4546#elif defined(HAVE_UTIME_H)
4547 UTIME_TO_UTIMBUF;
4548 return utime(path, time);
4549#else
4550 UTIME_TO_TIME_T;
4551 return utime(path, time);
4552#endif
4553}
4554
4555#endif
4556
Larry Hastings76ad59b2012-05-03 00:30:07 -07004557static int
4558split_py_long_to_s_and_ns(PyObject *py_long, time_t *s, long *ns)
4559{
4560 int result = 0;
Benjamin Petersonfbd85a02012-05-04 11:06:09 -04004561 PyObject *divmod;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004562 divmod = PyNumber_Divmod(py_long, billion);
4563 if (!divmod)
4564 goto exit;
4565 *s = _PyLong_AsTime_t(PyTuple_GET_ITEM(divmod, 0));
4566 if ((*s == -1) && PyErr_Occurred())
4567 goto exit;
4568 *ns = PyLong_AsLong(PyTuple_GET_ITEM(divmod, 1));
Benjamin Peterson35a8f0d2012-05-04 01:10:59 -04004569 if ((*ns == -1) && PyErr_Occurred())
Larry Hastings76ad59b2012-05-03 00:30:07 -07004570 goto exit;
4571
4572 result = 1;
4573exit:
4574 Py_XDECREF(divmod);
4575 return result;
4576}
4577
Larry Hastings2f936352014-08-05 14:04:04 +10004578
4579/*[clinic input]
4580os.utime
4581
4582 path: path_t(allow_fd='PATH_UTIME_HAVE_FD')
4583 times: object = NULL
4584 *
4585 ns: object = NULL
4586 dir_fd: dir_fd(requires='futimensat') = None
4587 follow_symlinks: bool=True
4588
Martin Panter0ff89092015-09-09 01:56:53 +00004589# "utime(path, times=None, *[, ns], dir_fd=None, follow_symlinks=True)\n\
Larry Hastings2f936352014-08-05 14:04:04 +10004590
4591Set the access and modified time of path.
4592
4593path may always be specified as a string.
4594On some platforms, path may also be specified as an open file descriptor.
4595 If this functionality is unavailable, using it raises an exception.
4596
4597If times is not None, it must be a tuple (atime, mtime);
4598 atime and mtime should be expressed as float seconds since the epoch.
Martin Panter0ff89092015-09-09 01:56:53 +00004599If ns is specified, it must be a tuple (atime_ns, mtime_ns);
Larry Hastings2f936352014-08-05 14:04:04 +10004600 atime_ns and mtime_ns should be expressed as integer nanoseconds
4601 since the epoch.
Martin Panter0ff89092015-09-09 01:56:53 +00004602If times is None and ns is unspecified, utime uses the current time.
Larry Hastings2f936352014-08-05 14:04:04 +10004603Specifying tuples for both times and ns is an error.
4604
4605If dir_fd is not None, it should be a file descriptor open to a directory,
4606 and path should be relative; path will then be relative to that directory.
4607If follow_symlinks is False, and the last element of the path is a symbolic
4608 link, utime will modify the symbolic link itself instead of the file the
4609 link points to.
4610It is an error to use dir_fd or follow_symlinks when specifying path
4611 as an open file descriptor.
4612dir_fd and follow_symlinks may not be available on your platform.
4613 If they are unavailable, using them will raise a NotImplementedError.
4614
4615[clinic start generated code]*/
4616
Larry Hastings2f936352014-08-05 14:04:04 +10004617static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004618os_utime_impl(PyObject *module, path_t *path, PyObject *times, PyObject *ns,
4619 int dir_fd, int follow_symlinks)
4620/*[clinic end generated code: output=cfcac69d027b82cf input=081cdc54ca685385]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004621{
Larry Hastings9cf065c2012-06-22 16:30:09 -07004622#ifdef MS_WINDOWS
4623 HANDLE hFile;
4624 FILETIME atime, mtime;
4625#else
4626 int result;
4627#endif
Larry Hastings76ad59b2012-05-03 00:30:07 -07004628
Larry Hastings9cf065c2012-06-22 16:30:09 -07004629 PyObject *return_value = NULL;
Larry Hastings2f936352014-08-05 14:04:04 +10004630 utime_t utime;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004631
Christian Heimesb3c87242013-08-01 00:08:16 +02004632 memset(&utime, 0, sizeof(utime_t));
Larry Hastings76ad59b2012-05-03 00:30:07 -07004633
Larry Hastings9cf065c2012-06-22 16:30:09 -07004634 if (times && (times != Py_None) && ns) {
4635 PyErr_SetString(PyExc_ValueError,
4636 "utime: you may specify either 'times'"
4637 " or 'ns' but not both");
4638 goto exit;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004639 }
4640
4641 if (times && (times != Py_None)) {
Antoine Pitroucf8a1e52013-04-17 22:06:44 +02004642 time_t a_sec, m_sec;
4643 long a_nsec, m_nsec;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004644 if (!PyTuple_CheckExact(times) || (PyTuple_Size(times) != 2)) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07004645 PyErr_SetString(PyExc_TypeError,
4646 "utime: 'times' must be either"
4647 " a tuple of two ints or None");
4648 goto exit;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004649 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07004650 utime.now = 0;
Benjamin Petersonb399ab22012-05-04 01:31:13 -04004651 if (_PyTime_ObjectToTimespec(PyTuple_GET_ITEM(times, 0),
Victor Stinnerdca028b2015-03-30 01:02:57 +02004652 &a_sec, &a_nsec, _PyTime_ROUND_FLOOR) == -1 ||
Benjamin Petersonb399ab22012-05-04 01:31:13 -04004653 _PyTime_ObjectToTimespec(PyTuple_GET_ITEM(times, 1),
Victor Stinnerdca028b2015-03-30 01:02:57 +02004654 &m_sec, &m_nsec, _PyTime_ROUND_FLOOR) == -1) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07004655 goto exit;
Larry Hastingsb3336402012-05-04 02:31:57 -07004656 }
Antoine Pitroucf8a1e52013-04-17 22:06:44 +02004657 utime.atime_s = a_sec;
4658 utime.atime_ns = a_nsec;
4659 utime.mtime_s = m_sec;
4660 utime.mtime_ns = m_nsec;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004661 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07004662 else if (ns) {
Larry Hastings76ad59b2012-05-03 00:30:07 -07004663 if (!PyTuple_CheckExact(ns) || (PyTuple_Size(ns) != 2)) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07004664 PyErr_SetString(PyExc_TypeError,
4665 "utime: 'ns' must be a tuple of two ints");
4666 goto exit;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004667 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07004668 utime.now = 0;
Benjamin Petersonb399ab22012-05-04 01:31:13 -04004669 if (!split_py_long_to_s_and_ns(PyTuple_GET_ITEM(ns, 0),
Larry Hastings9cf065c2012-06-22 16:30:09 -07004670 &utime.atime_s, &utime.atime_ns) ||
Benjamin Petersonb399ab22012-05-04 01:31:13 -04004671 !split_py_long_to_s_and_ns(PyTuple_GET_ITEM(ns, 1),
Larry Hastings9cf065c2012-06-22 16:30:09 -07004672 &utime.mtime_s, &utime.mtime_ns)) {
4673 goto exit;
Larry Hastingsb3336402012-05-04 02:31:57 -07004674 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07004675 }
4676 else {
4677 /* times and ns are both None/unspecified. use "now". */
4678 utime.now = 1;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004679 }
4680
Victor Stinner4552ced2015-09-21 22:37:15 +02004681#if !defined(UTIME_HAVE_NOFOLLOW_SYMLINKS)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004682 if (follow_symlinks_specified("utime", follow_symlinks))
4683 goto exit;
4684#endif
Benjamin Petersonb399ab22012-05-04 01:31:13 -04004685
Larry Hastings2f936352014-08-05 14:04:04 +10004686 if (path_and_dir_fd_invalid("utime", path, dir_fd) ||
4687 dir_fd_and_fd_invalid("utime", dir_fd, path->fd) ||
4688 fd_and_follow_symlinks_invalid("utime", path->fd, follow_symlinks))
Larry Hastings9cf065c2012-06-22 16:30:09 -07004689 goto exit;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004690
Larry Hastings9cf065c2012-06-22 16:30:09 -07004691#if !defined(HAVE_UTIMENSAT)
4692 if ((dir_fd != DEFAULT_DIR_FD) && (!follow_symlinks)) {
Georg Brandl969288e2012-06-26 09:25:44 +02004693 PyErr_SetString(PyExc_ValueError,
Larry Hastings9cf065c2012-06-22 16:30:09 -07004694 "utime: cannot use dir_fd and follow_symlinks "
4695 "together on this platform");
4696 goto exit;
4697 }
4698#endif
Larry Hastings76ad59b2012-05-03 00:30:07 -07004699
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00004700#ifdef MS_WINDOWS
Larry Hastings9cf065c2012-06-22 16:30:09 -07004701 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07004702 hFile = CreateFileW(path->wide, FILE_WRITE_ATTRIBUTES, 0,
4703 NULL, OPEN_EXISTING,
4704 FILE_FLAG_BACKUP_SEMANTICS, NULL);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004705 Py_END_ALLOW_THREADS
4706 if (hFile == INVALID_HANDLE_VALUE) {
Larry Hastings2f936352014-08-05 14:04:04 +10004707 path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004708 goto exit;
Larry Hastingsb3336402012-05-04 02:31:57 -07004709 }
4710
Larry Hastings9cf065c2012-06-22 16:30:09 -07004711 if (utime.now) {
Antoine Pitrou91a7af32013-11-23 15:23:26 +01004712 GetSystemTimeAsFileTime(&mtime);
4713 atime = mtime;
Victor Stinner8c62be82010-05-06 00:08:46 +00004714 }
Victor Stinner8c62be82010-05-06 00:08:46 +00004715 else {
Steve Dowerbf1f3762015-02-21 15:26:02 -08004716 _Py_time_t_to_FILE_TIME(utime.atime_s, utime.atime_ns, &atime);
4717 _Py_time_t_to_FILE_TIME(utime.mtime_s, utime.mtime_ns, &mtime);
Victor Stinner8c62be82010-05-06 00:08:46 +00004718 }
4719 if (!SetFileTime(hFile, NULL, &atime, &mtime)) {
4720 /* Avoid putting the file name into the error here,
4721 as that may confuse the user into believing that
4722 something is wrong with the file, when it also
4723 could be the time stamp that gives a problem. */
Victor Stinnerb024e842012-10-31 22:24:06 +01004724 PyErr_SetFromWindowsErr(0);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004725 goto exit;
Victor Stinner8c62be82010-05-06 00:08:46 +00004726 }
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00004727#else /* MS_WINDOWS */
Larry Hastings9cf065c2012-06-22 16:30:09 -07004728 Py_BEGIN_ALLOW_THREADS
Guido van Rossum1ff6cb41991-04-08 20:59:13 +00004729
Victor Stinner4552ced2015-09-21 22:37:15 +02004730#ifdef UTIME_HAVE_NOFOLLOW_SYMLINKS
Larry Hastings9cf065c2012-06-22 16:30:09 -07004731 if ((!follow_symlinks) && (dir_fd == DEFAULT_DIR_FD))
Larry Hastings2f936352014-08-05 14:04:04 +10004732 result = utime_nofollow_symlinks(&utime, path->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004733 else
Larry Hastings9e3e70b2011-09-08 19:29:07 -07004734#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07004735
Victor Stinner528a9ab2015-09-03 21:30:26 +02004736#if defined(HAVE_FUTIMESAT) || defined(HAVE_UTIMENSAT)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004737 if ((dir_fd != DEFAULT_DIR_FD) || (!follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10004738 result = utime_dir_fd(&utime, dir_fd, path->narrow, follow_symlinks);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004739 else
4740#endif
4741
Victor Stinner528a9ab2015-09-03 21:30:26 +02004742#if defined(HAVE_FUTIMES) || defined(HAVE_FUTIMENS)
Larry Hastings2f936352014-08-05 14:04:04 +10004743 if (path->fd != -1)
4744 result = utime_fd(&utime, path->fd);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004745 else
4746#endif
4747
Larry Hastings2f936352014-08-05 14:04:04 +10004748 result = utime_default(&utime, path->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004749
4750 Py_END_ALLOW_THREADS
4751
4752 if (result < 0) {
4753 /* see previous comment about not putting filename in error here */
4754 return_value = posix_error();
4755 goto exit;
Victor Stinner8c62be82010-05-06 00:08:46 +00004756 }
Larry Hastings76ad59b2012-05-03 00:30:07 -07004757
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00004758#endif /* MS_WINDOWS */
Larry Hastings9cf065c2012-06-22 16:30:09 -07004759
4760 Py_INCREF(Py_None);
4761 return_value = Py_None;
4762
4763exit:
Larry Hastings9cf065c2012-06-22 16:30:09 -07004764#ifdef MS_WINDOWS
4765 if (hFile != INVALID_HANDLE_VALUE)
4766 CloseHandle(hFile);
4767#endif
4768 return return_value;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004769}
4770
Guido van Rossum3b066191991-06-04 19:40:25 +00004771/* Process operations */
Guido van Rossum85e3b011991-06-03 12:42:10 +00004772
Larry Hastings2f936352014-08-05 14:04:04 +10004773
4774/*[clinic input]
4775os._exit
4776
4777 status: int
4778
4779Exit to the system with specified status, without normal exit processing.
4780[clinic start generated code]*/
4781
Larry Hastings2f936352014-08-05 14:04:04 +10004782static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004783os__exit_impl(PyObject *module, int status)
4784/*[clinic end generated code: output=116e52d9c2260d54 input=5e6d57556b0c4a62]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004785{
4786 _exit(status);
Victor Stinner8c62be82010-05-06 00:08:46 +00004787 return NULL; /* Make gcc -Wall happy */
Guido van Rossum85e3b011991-06-03 12:42:10 +00004788}
4789
Steve Dowercc16be82016-09-08 10:35:16 -07004790#if defined(HAVE_WEXECV) || defined(HAVE_WSPAWNV)
4791#define EXECV_CHAR wchar_t
4792#else
4793#define EXECV_CHAR char
4794#endif
4795
Martin v. Löwis114619e2002-10-07 06:44:21 +00004796#if defined(HAVE_EXECV) || defined(HAVE_SPAWNV)
4797static void
Steve Dowercc16be82016-09-08 10:35:16 -07004798free_string_array(EXECV_CHAR **array, Py_ssize_t count)
Martin v. Löwis114619e2002-10-07 06:44:21 +00004799{
Victor Stinner8c62be82010-05-06 00:08:46 +00004800 Py_ssize_t i;
4801 for (i = 0; i < count; i++)
4802 PyMem_Free(array[i]);
4803 PyMem_DEL(array);
Martin v. Löwis114619e2002-10-07 06:44:21 +00004804}
Martin v. Löwis011e8422009-05-05 04:43:17 +00004805
Berker Peksag81816462016-09-15 20:19:47 +03004806static int
4807fsconvert_strdup(PyObject *o, EXECV_CHAR **out)
Martin v. Löwis011e8422009-05-05 04:43:17 +00004808{
Victor Stinner8c62be82010-05-06 00:08:46 +00004809 Py_ssize_t size;
Berker Peksag81816462016-09-15 20:19:47 +03004810 PyObject *ub;
4811 int result = 0;
Steve Dowercc16be82016-09-08 10:35:16 -07004812#if defined(HAVE_WEXECV) || defined(HAVE_WSPAWNV)
Berker Peksag81816462016-09-15 20:19:47 +03004813 if (!PyUnicode_FSDecoder(o, &ub))
Steve Dowercc16be82016-09-08 10:35:16 -07004814 return 0;
Berker Peksag81816462016-09-15 20:19:47 +03004815 *out = PyUnicode_AsWideCharString(ub, &size);
4816 if (*out)
4817 result = 1;
Steve Dowercc16be82016-09-08 10:35:16 -07004818#else
Berker Peksag81816462016-09-15 20:19:47 +03004819 if (!PyUnicode_FSConverter(o, &ub))
Victor Stinner8c62be82010-05-06 00:08:46 +00004820 return 0;
Berker Peksag81816462016-09-15 20:19:47 +03004821 size = PyBytes_GET_SIZE(ub);
4822 *out = PyMem_Malloc(size + 1);
4823 if (*out) {
4824 memcpy(*out, PyBytes_AS_STRING(ub), size + 1);
4825 result = 1;
4826 } else
Victor Stinner50abf222013-11-07 23:56:10 +01004827 PyErr_NoMemory();
Steve Dowercc16be82016-09-08 10:35:16 -07004828#endif
Berker Peksag81816462016-09-15 20:19:47 +03004829 Py_DECREF(ub);
4830 return result;
Martin v. Löwis011e8422009-05-05 04:43:17 +00004831}
Martin v. Löwis114619e2002-10-07 06:44:21 +00004832#endif
4833
Ross Lagerwall7807c352011-03-17 20:20:30 +02004834#if defined(HAVE_EXECV) || defined (HAVE_FEXECVE)
Steve Dowercc16be82016-09-08 10:35:16 -07004835static EXECV_CHAR**
Victor Stinner13bb71c2010-04-23 21:41:56 +00004836parse_envlist(PyObject* env, Py_ssize_t *envc_ptr)
4837{
Victor Stinner8c62be82010-05-06 00:08:46 +00004838 Py_ssize_t i, pos, envc;
4839 PyObject *keys=NULL, *vals=NULL;
Berker Peksag81816462016-09-15 20:19:47 +03004840 PyObject *key, *val, *key2, *val2, *keyval;
Steve Dowercc16be82016-09-08 10:35:16 -07004841 EXECV_CHAR **envlist;
Victor Stinner13bb71c2010-04-23 21:41:56 +00004842
Victor Stinner8c62be82010-05-06 00:08:46 +00004843 i = PyMapping_Size(env);
4844 if (i < 0)
4845 return NULL;
Steve Dowercc16be82016-09-08 10:35:16 -07004846 envlist = PyMem_NEW(EXECV_CHAR *, i + 1);
Victor Stinner8c62be82010-05-06 00:08:46 +00004847 if (envlist == NULL) {
4848 PyErr_NoMemory();
4849 return NULL;
4850 }
4851 envc = 0;
4852 keys = PyMapping_Keys(env);
Victor Stinnerb0314272013-11-14 21:37:05 +01004853 if (!keys)
4854 goto error;
Victor Stinner8c62be82010-05-06 00:08:46 +00004855 vals = PyMapping_Values(env);
Victor Stinnerb0314272013-11-14 21:37:05 +01004856 if (!vals)
Victor Stinner8c62be82010-05-06 00:08:46 +00004857 goto error;
4858 if (!PyList_Check(keys) || !PyList_Check(vals)) {
4859 PyErr_Format(PyExc_TypeError,
4860 "env.keys() or env.values() is not a list");
4861 goto error;
4862 }
Victor Stinner13bb71c2010-04-23 21:41:56 +00004863
Victor Stinner8c62be82010-05-06 00:08:46 +00004864 for (pos = 0; pos < i; pos++) {
4865 key = PyList_GetItem(keys, pos);
4866 val = PyList_GetItem(vals, pos);
4867 if (!key || !val)
4868 goto error;
Victor Stinner13bb71c2010-04-23 21:41:56 +00004869
Berker Peksag81816462016-09-15 20:19:47 +03004870#if defined(HAVE_WEXECV) || defined(HAVE_WSPAWNV)
4871 if (!PyUnicode_FSDecoder(key, &key2))
4872 goto error;
4873 if (!PyUnicode_FSDecoder(val, &val2)) {
4874 Py_DECREF(key2);
4875 goto error;
4876 }
Serhiy Storchaka77703942017-06-25 07:33:01 +03004877 /* Search from index 1 because on Windows starting '=' is allowed for
4878 defining hidden environment variables. */
4879 if (PyUnicode_GET_LENGTH(key2) == 0 ||
4880 PyUnicode_FindChar(key2, '=', 1, PyUnicode_GET_LENGTH(key2), 1) != -1)
4881 {
4882 PyErr_SetString(PyExc_ValueError, "illegal environment variable name");
Eric N. Vander Weelea7874c72017-06-26 21:35:20 -04004883 Py_DECREF(key2);
4884 Py_DECREF(val2);
Serhiy Storchaka77703942017-06-25 07:33:01 +03004885 goto error;
4886 }
Berker Peksag81816462016-09-15 20:19:47 +03004887 keyval = PyUnicode_FromFormat("%U=%U", key2, val2);
4888#else
4889 if (!PyUnicode_FSConverter(key, &key2))
4890 goto error;
4891 if (!PyUnicode_FSConverter(val, &val2)) {
4892 Py_DECREF(key2);
4893 goto error;
4894 }
Serhiy Storchaka77703942017-06-25 07:33:01 +03004895 if (PyBytes_GET_SIZE(key2) == 0 ||
4896 strchr(PyBytes_AS_STRING(key2) + 1, '=') != NULL)
4897 {
4898 PyErr_SetString(PyExc_ValueError, "illegal environment variable name");
Eric N. Vander Weelea7874c72017-06-26 21:35:20 -04004899 Py_DECREF(key2);
4900 Py_DECREF(val2);
Serhiy Storchaka77703942017-06-25 07:33:01 +03004901 goto error;
4902 }
Berker Peksag81816462016-09-15 20:19:47 +03004903 keyval = PyBytes_FromFormat("%s=%s", PyBytes_AS_STRING(key2),
4904 PyBytes_AS_STRING(val2));
4905#endif
4906 Py_DECREF(key2);
4907 Py_DECREF(val2);
Steve Dowercc16be82016-09-08 10:35:16 -07004908 if (!keyval)
Victor Stinner8c62be82010-05-06 00:08:46 +00004909 goto error;
Steve Dowercc16be82016-09-08 10:35:16 -07004910
4911 if (!fsconvert_strdup(keyval, &envlist[envc++])) {
4912 Py_DECREF(keyval);
Victor Stinner8c62be82010-05-06 00:08:46 +00004913 goto error;
4914 }
Berker Peksag81816462016-09-15 20:19:47 +03004915
Steve Dowercc16be82016-09-08 10:35:16 -07004916 Py_DECREF(keyval);
Victor Stinner8c62be82010-05-06 00:08:46 +00004917 }
4918 Py_DECREF(vals);
4919 Py_DECREF(keys);
Victor Stinner13bb71c2010-04-23 21:41:56 +00004920
Victor Stinner8c62be82010-05-06 00:08:46 +00004921 envlist[envc] = 0;
4922 *envc_ptr = envc;
4923 return envlist;
Victor Stinner13bb71c2010-04-23 21:41:56 +00004924
4925error:
Victor Stinner8c62be82010-05-06 00:08:46 +00004926 Py_XDECREF(keys);
4927 Py_XDECREF(vals);
Steve Dowercc16be82016-09-08 10:35:16 -07004928 free_string_array(envlist, envc);
Victor Stinner8c62be82010-05-06 00:08:46 +00004929 return NULL;
Victor Stinner13bb71c2010-04-23 21:41:56 +00004930}
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004931
Steve Dowercc16be82016-09-08 10:35:16 -07004932static EXECV_CHAR**
Ross Lagerwall7807c352011-03-17 20:20:30 +02004933parse_arglist(PyObject* argv, Py_ssize_t *argc)
4934{
4935 int i;
Steve Dowercc16be82016-09-08 10:35:16 -07004936 EXECV_CHAR **argvlist = PyMem_NEW(EXECV_CHAR *, *argc+1);
Ross Lagerwall7807c352011-03-17 20:20:30 +02004937 if (argvlist == NULL) {
4938 PyErr_NoMemory();
4939 return NULL;
4940 }
4941 for (i = 0; i < *argc; i++) {
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02004942 PyObject* item = PySequence_ITEM(argv, i);
4943 if (item == NULL)
4944 goto fail;
4945 if (!fsconvert_strdup(item, &argvlist[i])) {
4946 Py_DECREF(item);
Ross Lagerwall7807c352011-03-17 20:20:30 +02004947 goto fail;
4948 }
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02004949 Py_DECREF(item);
Ross Lagerwall7807c352011-03-17 20:20:30 +02004950 }
4951 argvlist[*argc] = NULL;
4952 return argvlist;
4953fail:
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02004954 *argc = i;
Ross Lagerwall7807c352011-03-17 20:20:30 +02004955 free_string_array(argvlist, *argc);
4956 return NULL;
4957}
Steve Dowercc16be82016-09-08 10:35:16 -07004958
Ross Lagerwall7807c352011-03-17 20:20:30 +02004959#endif
4960
Larry Hastings2f936352014-08-05 14:04:04 +10004961
Ross Lagerwall7807c352011-03-17 20:20:30 +02004962#ifdef HAVE_EXECV
Larry Hastings2f936352014-08-05 14:04:04 +10004963/*[clinic input]
4964os.execv
4965
Steve Dowercc16be82016-09-08 10:35:16 -07004966 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +10004967 Path of executable file.
4968 argv: object
4969 Tuple or list of strings.
4970 /
4971
4972Execute an executable path with arguments, replacing current process.
4973[clinic start generated code]*/
4974
Larry Hastings2f936352014-08-05 14:04:04 +10004975static PyObject *
Steve Dowercc16be82016-09-08 10:35:16 -07004976os_execv_impl(PyObject *module, path_t *path, PyObject *argv)
4977/*[clinic end generated code: output=3b52fec34cd0dafd input=9bac31efae07dac7]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004978{
Steve Dowercc16be82016-09-08 10:35:16 -07004979 EXECV_CHAR **argvlist;
Ross Lagerwall7807c352011-03-17 20:20:30 +02004980 Py_ssize_t argc;
4981
4982 /* execv has two arguments: (path, argv), where
4983 argv is a list or tuple of strings. */
4984
Ross Lagerwall7807c352011-03-17 20:20:30 +02004985 if (!PyList_Check(argv) && !PyTuple_Check(argv)) {
4986 PyErr_SetString(PyExc_TypeError,
4987 "execv() arg 2 must be a tuple or list");
Ross Lagerwall7807c352011-03-17 20:20:30 +02004988 return NULL;
4989 }
4990 argc = PySequence_Size(argv);
4991 if (argc < 1) {
4992 PyErr_SetString(PyExc_ValueError, "execv() arg 2 must not be empty");
Ross Lagerwall7807c352011-03-17 20:20:30 +02004993 return NULL;
4994 }
4995
4996 argvlist = parse_arglist(argv, &argc);
4997 if (argvlist == NULL) {
Ross Lagerwall7807c352011-03-17 20:20:30 +02004998 return NULL;
4999 }
Steve Dowerbce26262016-11-19 19:17:26 -08005000 if (!argvlist[0][0]) {
5001 PyErr_SetString(PyExc_ValueError,
5002 "execv() arg 2 first element cannot be empty");
5003 free_string_array(argvlist, argc);
5004 return NULL;
5005 }
Ross Lagerwall7807c352011-03-17 20:20:30 +02005006
Steve Dowerbce26262016-11-19 19:17:26 -08005007 _Py_BEGIN_SUPPRESS_IPH
Steve Dowercc16be82016-09-08 10:35:16 -07005008#ifdef HAVE_WEXECV
5009 _wexecv(path->wide, argvlist);
5010#else
5011 execv(path->narrow, argvlist);
5012#endif
Steve Dowerbce26262016-11-19 19:17:26 -08005013 _Py_END_SUPPRESS_IPH
Ross Lagerwall7807c352011-03-17 20:20:30 +02005014
5015 /* If we get here it's definitely an error */
5016
5017 free_string_array(argvlist, argc);
Ross Lagerwall7807c352011-03-17 20:20:30 +02005018 return posix_error();
5019}
5020
Larry Hastings2f936352014-08-05 14:04:04 +10005021
5022/*[clinic input]
5023os.execve
5024
5025 path: path_t(allow_fd='PATH_HAVE_FEXECVE')
5026 Path of executable file.
5027 argv: object
5028 Tuple or list of strings.
5029 env: object
5030 Dictionary of strings mapping to strings.
5031
5032Execute an executable path with arguments, replacing current process.
5033[clinic start generated code]*/
5034
Larry Hastings2f936352014-08-05 14:04:04 +10005035static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005036os_execve_impl(PyObject *module, path_t *path, PyObject *argv, PyObject *env)
5037/*[clinic end generated code: output=ff9fa8e4da8bde58 input=626804fa092606d9]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005038{
Steve Dowercc16be82016-09-08 10:35:16 -07005039 EXECV_CHAR **argvlist = NULL;
5040 EXECV_CHAR **envlist;
Ross Lagerwall7807c352011-03-17 20:20:30 +02005041 Py_ssize_t argc, envc;
Guido van Rossumc6dcc9f1993-11-05 10:15:19 +00005042
Victor Stinner8c62be82010-05-06 00:08:46 +00005043 /* execve has three arguments: (path, argv, env), where
5044 argv is a list or tuple of strings and env is a dictionary
5045 like posix.environ. */
Guido van Rossumc6dcc9f1993-11-05 10:15:19 +00005046
Ross Lagerwall7807c352011-03-17 20:20:30 +02005047 if (!PyList_Check(argv) && !PyTuple_Check(argv)) {
Victor Stinner8c62be82010-05-06 00:08:46 +00005048 PyErr_SetString(PyExc_TypeError,
Larry Hastings9cf065c2012-06-22 16:30:09 -07005049 "execve: argv must be a tuple or list");
5050 goto fail;
Victor Stinner8c62be82010-05-06 00:08:46 +00005051 }
Ross Lagerwall7807c352011-03-17 20:20:30 +02005052 argc = PySequence_Size(argv);
Steve Dowerbce26262016-11-19 19:17:26 -08005053 if (argc < 1) {
5054 PyErr_SetString(PyExc_ValueError, "execve: argv must not be empty");
5055 return NULL;
5056 }
5057
Victor Stinner8c62be82010-05-06 00:08:46 +00005058 if (!PyMapping_Check(env)) {
5059 PyErr_SetString(PyExc_TypeError,
Larry Hastings9cf065c2012-06-22 16:30:09 -07005060 "execve: environment must be a mapping object");
5061 goto fail;
Victor Stinner8c62be82010-05-06 00:08:46 +00005062 }
Guido van Rossumc6dcc9f1993-11-05 10:15:19 +00005063
Ross Lagerwall7807c352011-03-17 20:20:30 +02005064 argvlist = parse_arglist(argv, &argc);
Victor Stinner8c62be82010-05-06 00:08:46 +00005065 if (argvlist == NULL) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07005066 goto fail;
Victor Stinner8c62be82010-05-06 00:08:46 +00005067 }
Steve Dowerbce26262016-11-19 19:17:26 -08005068 if (!argvlist[0][0]) {
5069 PyErr_SetString(PyExc_ValueError,
5070 "execve: argv first element cannot be empty");
5071 goto fail;
5072 }
Guido van Rossumc6dcc9f1993-11-05 10:15:19 +00005073
Victor Stinner8c62be82010-05-06 00:08:46 +00005074 envlist = parse_envlist(env, &envc);
5075 if (envlist == NULL)
Ross Lagerwall7807c352011-03-17 20:20:30 +02005076 goto fail;
5077
Steve Dowerbce26262016-11-19 19:17:26 -08005078 _Py_BEGIN_SUPPRESS_IPH
Larry Hastings9cf065c2012-06-22 16:30:09 -07005079#ifdef HAVE_FEXECVE
Larry Hastings2f936352014-08-05 14:04:04 +10005080 if (path->fd > -1)
5081 fexecve(path->fd, argvlist, envlist);
Larry Hastings9cf065c2012-06-22 16:30:09 -07005082 else
5083#endif
Steve Dowercc16be82016-09-08 10:35:16 -07005084#ifdef HAVE_WEXECV
5085 _wexecve(path->wide, argvlist, envlist);
5086#else
Larry Hastings2f936352014-08-05 14:04:04 +10005087 execve(path->narrow, argvlist, envlist);
Steve Dowercc16be82016-09-08 10:35:16 -07005088#endif
Steve Dowerbce26262016-11-19 19:17:26 -08005089 _Py_END_SUPPRESS_IPH
Ross Lagerwall7807c352011-03-17 20:20:30 +02005090
5091 /* If we get here it's definitely an error */
5092
Larry Hastings2f936352014-08-05 14:04:04 +10005093 path_error(path);
Ross Lagerwall7807c352011-03-17 20:20:30 +02005094
Steve Dowercc16be82016-09-08 10:35:16 -07005095 free_string_array(envlist, envc);
Ross Lagerwall7807c352011-03-17 20:20:30 +02005096 fail:
Larry Hastings9cf065c2012-06-22 16:30:09 -07005097 if (argvlist)
5098 free_string_array(argvlist, argc);
Ross Lagerwall7807c352011-03-17 20:20:30 +02005099 return NULL;
5100}
Steve Dowercc16be82016-09-08 10:35:16 -07005101
Larry Hastings9cf065c2012-06-22 16:30:09 -07005102#endif /* HAVE_EXECV */
5103
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005104#ifdef HAVE_POSIX_SPAWN
5105
5106enum posix_spawn_file_actions_identifier {
5107 POSIX_SPAWN_OPEN,
5108 POSIX_SPAWN_CLOSE,
5109 POSIX_SPAWN_DUP2
5110};
5111
5112/*[clinic input]
5113
5114os.posix_spawn
5115 path: path_t
5116 Path of executable file.
5117 argv: object
5118 Tuple or list of strings.
5119 env: object
5120 Dictionary of strings mapping to strings.
5121 file_actions: object = None
5122 FileActions object.
5123 /
5124
5125Execute the program specified by path in a new process.
5126[clinic start generated code]*/
5127
5128static PyObject *
5129os_posix_spawn_impl(PyObject *module, path_t *path, PyObject *argv,
5130 PyObject *env, PyObject *file_actions)
5131/*[clinic end generated code: output=d023521f541c709c input=0ec9f1cfdc890be5]*/
5132{
5133 EXECV_CHAR **argvlist = NULL;
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005134 EXECV_CHAR **envlist = NULL;
5135 posix_spawn_file_actions_t _file_actions;
5136 posix_spawn_file_actions_t *file_actionsp = NULL;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005137 Py_ssize_t argc, envc;
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005138 PyObject* result = NULL;
5139 PyObject* seq = NULL;
5140
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005141
5142 /* posix_spawn has three arguments: (path, argv, env), where
5143 argv is a list or tuple of strings and env is a dictionary
5144 like posix.environ. */
5145
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005146 if (!PySequence_Check(argv)) {
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005147 PyErr_SetString(PyExc_TypeError,
5148 "posix_spawn: argv must be a tuple or list");
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005149 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005150 }
5151 argc = PySequence_Size(argv);
5152 if (argc < 1) {
5153 PyErr_SetString(PyExc_ValueError, "posix_spawn: argv must not be empty");
5154 return NULL;
5155 }
5156
5157 if (!PyMapping_Check(env)) {
5158 PyErr_SetString(PyExc_TypeError,
5159 "posix_spawn: environment must be a mapping object");
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005160 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005161 }
5162
5163 argvlist = parse_arglist(argv, &argc);
5164 if (argvlist == NULL) {
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005165 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005166 }
5167 if (!argvlist[0][0]) {
5168 PyErr_SetString(PyExc_ValueError,
5169 "posix_spawn: argv first element cannot be empty");
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005170 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005171 }
5172
5173 envlist = parse_envlist(env, &envc);
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005174 if (envlist == NULL) {
5175 goto exit;
5176 }
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005177
5178 pid_t pid;
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005179 if (file_actions != NULL && file_actions != Py_None) {
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005180 if(posix_spawn_file_actions_init(&_file_actions) != 0){
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005181 PyErr_SetString(PyExc_OSError,
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005182 "Error initializing file actions");
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005183 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005184 }
5185
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005186 file_actionsp = &_file_actions;
5187
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005188 seq = PySequence_Fast(file_actions, "file_actions must be a sequence");
5189 if(seq == NULL) {
5190 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005191 }
5192 PyObject* file_actions_obj;
5193 PyObject* mode_obj;
5194
5195 for (int i = 0; i < PySequence_Fast_GET_SIZE(seq); ++i) {
5196 file_actions_obj = PySequence_Fast_GET_ITEM(seq, i);
5197
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005198 if(!PySequence_Check(file_actions_obj) | !PySequence_Size(file_actions_obj)) {
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005199 PyErr_SetString(PyExc_TypeError,"Each file_action element must be a non empty sequence");
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005200 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005201 }
5202
5203
5204 mode_obj = PySequence_Fast_GET_ITEM(file_actions_obj, 0);
5205 int mode = PyLong_AsLong(mode_obj);
5206
5207 /* Populate the file_actions object */
5208
5209 switch(mode) {
5210
5211 case POSIX_SPAWN_OPEN:
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005212 if(PySequence_Size(file_actions_obj) != 5) {
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005213 PyErr_SetString(PyExc_TypeError,"A open file_action object must have 5 elements");
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005214 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005215 }
5216
5217 long open_fd = PyLong_AsLong(PySequence_GetItem(file_actions_obj, 1));
5218 if(PyErr_Occurred()) {
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005219 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005220 }
5221 const char* open_path = PyUnicode_AsUTF8(PySequence_GetItem(file_actions_obj, 2));
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005222 if(open_path == NULL) {
5223 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005224 }
5225 long open_oflag = PyLong_AsLong(PySequence_GetItem(file_actions_obj, 3));
5226 if(PyErr_Occurred()) {
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005227 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005228 }
5229 long open_mode = PyLong_AsLong(PySequence_GetItem(file_actions_obj, 4));
5230 if(PyErr_Occurred()) {
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005231 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005232 }
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005233 if(posix_spawn_file_actions_addopen(file_actionsp, open_fd, open_path, open_oflag, open_mode)) {
5234 PyErr_SetString(PyExc_OSError,"Failed to add open file action");
5235 goto exit;
5236 }
5237
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005238 break;
5239
5240 case POSIX_SPAWN_CLOSE:
5241 if(PySequence_Size(file_actions_obj) != 2){
5242 PyErr_SetString(PyExc_TypeError,"A close file_action object must have 2 elements");
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005243 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005244 }
5245
5246 long close_fd = PyLong_AsLong(PySequence_GetItem(file_actions_obj, 1));
5247 if(PyErr_Occurred()) {
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005248 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005249 }
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005250 if(posix_spawn_file_actions_addclose(file_actionsp, close_fd)) {
5251 PyErr_SetString(PyExc_OSError,"Failed to add close file action");
5252 goto exit;
5253 }
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005254 break;
5255
5256 case POSIX_SPAWN_DUP2:
5257 if(PySequence_Size(file_actions_obj) != 3){
5258 PyErr_SetString(PyExc_TypeError,"A dup2 file_action object must have 3 elements");
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005259 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005260 }
5261
5262 long fd1 = PyLong_AsLong(PySequence_GetItem(file_actions_obj, 1));
5263 if(PyErr_Occurred()) {
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005264 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005265 }
5266 long fd2 = PyLong_AsLong(PySequence_GetItem(file_actions_obj, 2));
5267 if(PyErr_Occurred()) {
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005268 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005269 }
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005270 if(posix_spawn_file_actions_adddup2(file_actionsp, fd1, fd2)) {
5271 PyErr_SetString(PyExc_OSError,"Failed to add dup2 file action");
5272 goto exit;
5273 }
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005274 break;
5275
5276 default:
5277 PyErr_SetString(PyExc_TypeError,"Unknown file_actions identifier");
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005278 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005279 }
5280 }
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005281 }
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005282
5283 _Py_BEGIN_SUPPRESS_IPH
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005284 int err_code = posix_spawn(&pid, path->narrow, file_actionsp, NULL, argvlist, envlist);
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005285 _Py_END_SUPPRESS_IPH
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005286 if(err_code) {
5287 PyErr_SetString(PyExc_OSError,"posix_spawn call failed");
5288 goto exit;
5289 }
5290 result = PyLong_FromPid(pid);
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005291
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005292exit:
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005293
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005294 Py_XDECREF(seq);
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005295
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005296 if(file_actionsp) {
5297 posix_spawn_file_actions_destroy(file_actionsp);
5298 }
5299
5300 if (envlist) {
5301 free_string_array(envlist, envc);
5302 }
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005303
5304 if (argvlist) {
5305 free_string_array(argvlist, argc);
5306 }
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005307
5308 return result;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005309
5310
5311}
5312#endif /* HAVE_POSIX_SPAWN */
5313
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00005314
Steve Dowercc16be82016-09-08 10:35:16 -07005315#if defined(HAVE_SPAWNV) || defined(HAVE_WSPAWNV)
Larry Hastings2f936352014-08-05 14:04:04 +10005316/*[clinic input]
5317os.spawnv
5318
5319 mode: int
5320 Mode of process creation.
Steve Dowercc16be82016-09-08 10:35:16 -07005321 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +10005322 Path of executable file.
5323 argv: object
5324 Tuple or list of strings.
5325 /
5326
5327Execute the program specified by path in a new process.
5328[clinic start generated code]*/
5329
Larry Hastings2f936352014-08-05 14:04:04 +10005330static PyObject *
Steve Dowercc16be82016-09-08 10:35:16 -07005331os_spawnv_impl(PyObject *module, int mode, path_t *path, PyObject *argv)
5332/*[clinic end generated code: output=71cd037a9d96b816 input=43224242303291be]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005333{
Steve Dowercc16be82016-09-08 10:35:16 -07005334 EXECV_CHAR **argvlist;
Larry Hastings2f936352014-08-05 14:04:04 +10005335 int i;
Victor Stinner8c62be82010-05-06 00:08:46 +00005336 Py_ssize_t argc;
Benjamin Petersonca470632016-09-06 13:47:26 -07005337 intptr_t spawnval;
Victor Stinner8c62be82010-05-06 00:08:46 +00005338 PyObject *(*getitem)(PyObject *, Py_ssize_t);
Guido van Rossuma1065681999-01-25 23:20:23 +00005339
Victor Stinner8c62be82010-05-06 00:08:46 +00005340 /* spawnv has three arguments: (mode, path, argv), where
5341 argv is a list or tuple of strings. */
Guido van Rossuma1065681999-01-25 23:20:23 +00005342
Victor Stinner8c62be82010-05-06 00:08:46 +00005343 if (PyList_Check(argv)) {
5344 argc = PyList_Size(argv);
5345 getitem = PyList_GetItem;
5346 }
5347 else if (PyTuple_Check(argv)) {
5348 argc = PyTuple_Size(argv);
5349 getitem = PyTuple_GetItem;
5350 }
5351 else {
5352 PyErr_SetString(PyExc_TypeError,
5353 "spawnv() arg 2 must be a tuple or list");
Victor Stinner8c62be82010-05-06 00:08:46 +00005354 return NULL;
5355 }
Steve Dower859fd7b2016-11-19 18:53:19 -08005356 if (argc == 0) {
5357 PyErr_SetString(PyExc_ValueError,
5358 "spawnv() arg 2 cannot be empty");
5359 return NULL;
5360 }
Guido van Rossuma1065681999-01-25 23:20:23 +00005361
Steve Dowercc16be82016-09-08 10:35:16 -07005362 argvlist = PyMem_NEW(EXECV_CHAR *, argc+1);
Victor Stinner8c62be82010-05-06 00:08:46 +00005363 if (argvlist == NULL) {
Victor Stinner8c62be82010-05-06 00:08:46 +00005364 return PyErr_NoMemory();
5365 }
5366 for (i = 0; i < argc; i++) {
5367 if (!fsconvert_strdup((*getitem)(argv, i),
5368 &argvlist[i])) {
5369 free_string_array(argvlist, i);
5370 PyErr_SetString(
5371 PyExc_TypeError,
5372 "spawnv() arg 2 must contain only strings");
Victor Stinner8c62be82010-05-06 00:08:46 +00005373 return NULL;
5374 }
Steve Dower93ff8722016-11-19 19:03:54 -08005375 if (i == 0 && !argvlist[0][0]) {
Victor Stinner8acb4cf2017-06-15 15:30:40 +02005376 free_string_array(argvlist, i + 1);
Steve Dower93ff8722016-11-19 19:03:54 -08005377 PyErr_SetString(
5378 PyExc_ValueError,
5379 "spawnv() arg 2 first element cannot be empty");
5380 return NULL;
5381 }
Victor Stinner8c62be82010-05-06 00:08:46 +00005382 }
5383 argvlist[argc] = NULL;
Guido van Rossuma1065681999-01-25 23:20:23 +00005384
Victor Stinner8c62be82010-05-06 00:08:46 +00005385 if (mode == _OLD_P_OVERLAY)
5386 mode = _P_OVERLAY;
Tim Peters5aa91602002-01-30 05:46:57 +00005387
Victor Stinner8c62be82010-05-06 00:08:46 +00005388 Py_BEGIN_ALLOW_THREADS
Steve Dower654a7bd2016-09-11 20:19:32 -07005389 _Py_BEGIN_SUPPRESS_IPH
Steve Dowercc16be82016-09-08 10:35:16 -07005390#ifdef HAVE_WSPAWNV
5391 spawnval = _wspawnv(mode, path->wide, argvlist);
5392#else
5393 spawnval = _spawnv(mode, path->narrow, argvlist);
5394#endif
Steve Dower654a7bd2016-09-11 20:19:32 -07005395 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00005396 Py_END_ALLOW_THREADS
Tim Peters5aa91602002-01-30 05:46:57 +00005397
Victor Stinner8c62be82010-05-06 00:08:46 +00005398 free_string_array(argvlist, argc);
Guido van Rossuma1065681999-01-25 23:20:23 +00005399
Victor Stinner8c62be82010-05-06 00:08:46 +00005400 if (spawnval == -1)
5401 return posix_error();
5402 else
Richard Oudkerkac0ad882013-06-05 23:29:30 +01005403 return Py_BuildValue(_Py_PARSE_INTPTR, spawnval);
Guido van Rossuma1065681999-01-25 23:20:23 +00005404}
5405
Larry Hastings2f936352014-08-05 14:04:04 +10005406/*[clinic input]
5407os.spawnve
5408
5409 mode: int
5410 Mode of process creation.
Steve Dowercc16be82016-09-08 10:35:16 -07005411 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +10005412 Path of executable file.
5413 argv: object
5414 Tuple or list of strings.
5415 env: object
5416 Dictionary of strings mapping to strings.
5417 /
5418
5419Execute the program specified by path in a new process.
5420[clinic start generated code]*/
5421
Larry Hastings2f936352014-08-05 14:04:04 +10005422static PyObject *
Steve Dowercc16be82016-09-08 10:35:16 -07005423os_spawnve_impl(PyObject *module, int mode, path_t *path, PyObject *argv,
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005424 PyObject *env)
Steve Dowercc16be82016-09-08 10:35:16 -07005425/*[clinic end generated code: output=30fe85be56fe37ad input=3e40803ee7c4c586]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005426{
Steve Dowercc16be82016-09-08 10:35:16 -07005427 EXECV_CHAR **argvlist;
5428 EXECV_CHAR **envlist;
Victor Stinner8c62be82010-05-06 00:08:46 +00005429 PyObject *res = NULL;
Antoine Pitrou22e41552010-08-15 18:07:50 +00005430 Py_ssize_t argc, i, envc;
Benjamin Petersonca470632016-09-06 13:47:26 -07005431 intptr_t spawnval;
Victor Stinner8c62be82010-05-06 00:08:46 +00005432 PyObject *(*getitem)(PyObject *, Py_ssize_t);
Victor Stinnerc8d6ab22017-06-23 15:04:46 +02005433 Py_ssize_t lastarg = 0;
Guido van Rossuma1065681999-01-25 23:20:23 +00005434
Victor Stinner8c62be82010-05-06 00:08:46 +00005435 /* spawnve has four arguments: (mode, path, argv, env), where
5436 argv is a list or tuple of strings and env is a dictionary
5437 like posix.environ. */
Guido van Rossuma1065681999-01-25 23:20:23 +00005438
Victor Stinner8c62be82010-05-06 00:08:46 +00005439 if (PyList_Check(argv)) {
5440 argc = PyList_Size(argv);
5441 getitem = PyList_GetItem;
5442 }
5443 else if (PyTuple_Check(argv)) {
5444 argc = PyTuple_Size(argv);
5445 getitem = PyTuple_GetItem;
5446 }
5447 else {
5448 PyErr_SetString(PyExc_TypeError,
5449 "spawnve() arg 2 must be a tuple or list");
5450 goto fail_0;
5451 }
Steve Dower859fd7b2016-11-19 18:53:19 -08005452 if (argc == 0) {
5453 PyErr_SetString(PyExc_ValueError,
5454 "spawnve() arg 2 cannot be empty");
5455 goto fail_0;
5456 }
Victor Stinner8c62be82010-05-06 00:08:46 +00005457 if (!PyMapping_Check(env)) {
5458 PyErr_SetString(PyExc_TypeError,
5459 "spawnve() arg 3 must be a mapping object");
5460 goto fail_0;
5461 }
Guido van Rossuma1065681999-01-25 23:20:23 +00005462
Steve Dowercc16be82016-09-08 10:35:16 -07005463 argvlist = PyMem_NEW(EXECV_CHAR *, argc+1);
Victor Stinner8c62be82010-05-06 00:08:46 +00005464 if (argvlist == NULL) {
5465 PyErr_NoMemory();
5466 goto fail_0;
5467 }
5468 for (i = 0; i < argc; i++) {
5469 if (!fsconvert_strdup((*getitem)(argv, i),
5470 &argvlist[i]))
5471 {
5472 lastarg = i;
5473 goto fail_1;
5474 }
Steve Dowerbce26262016-11-19 19:17:26 -08005475 if (i == 0 && !argvlist[0][0]) {
Victor Stinnerc8d6ab22017-06-23 15:04:46 +02005476 lastarg = i + 1;
Steve Dowerbce26262016-11-19 19:17:26 -08005477 PyErr_SetString(
5478 PyExc_ValueError,
5479 "spawnv() arg 2 first element cannot be empty");
5480 goto fail_1;
5481 }
Victor Stinner8c62be82010-05-06 00:08:46 +00005482 }
5483 lastarg = argc;
5484 argvlist[argc] = NULL;
Guido van Rossuma1065681999-01-25 23:20:23 +00005485
Victor Stinner8c62be82010-05-06 00:08:46 +00005486 envlist = parse_envlist(env, &envc);
5487 if (envlist == NULL)
5488 goto fail_1;
Guido van Rossuma1065681999-01-25 23:20:23 +00005489
Victor Stinner8c62be82010-05-06 00:08:46 +00005490 if (mode == _OLD_P_OVERLAY)
5491 mode = _P_OVERLAY;
Tim Peters25059d32001-12-07 20:35:43 +00005492
Victor Stinner8c62be82010-05-06 00:08:46 +00005493 Py_BEGIN_ALLOW_THREADS
Steve Dower654a7bd2016-09-11 20:19:32 -07005494 _Py_BEGIN_SUPPRESS_IPH
Steve Dowercc16be82016-09-08 10:35:16 -07005495#ifdef HAVE_WSPAWNV
5496 spawnval = _wspawnve(mode, path->wide, argvlist, envlist);
5497#else
5498 spawnval = _spawnve(mode, path->narrow, argvlist, envlist);
5499#endif
Steve Dower654a7bd2016-09-11 20:19:32 -07005500 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00005501 Py_END_ALLOW_THREADS
Tim Peters25059d32001-12-07 20:35:43 +00005502
Victor Stinner8c62be82010-05-06 00:08:46 +00005503 if (spawnval == -1)
5504 (void) posix_error();
5505 else
Richard Oudkerkac0ad882013-06-05 23:29:30 +01005506 res = Py_BuildValue(_Py_PARSE_INTPTR, spawnval);
Guido van Rossuma1065681999-01-25 23:20:23 +00005507
Victor Stinner8c62be82010-05-06 00:08:46 +00005508 while (--envc >= 0)
5509 PyMem_DEL(envlist[envc]);
5510 PyMem_DEL(envlist);
Guido van Rossum0847c5c2002-12-13 18:36:22 +00005511 fail_1:
Victor Stinnerc8d6ab22017-06-23 15:04:46 +02005512 free_string_array(argvlist, lastarg);
Martin v. Löwis114619e2002-10-07 06:44:21 +00005513 fail_0:
Victor Stinner8c62be82010-05-06 00:08:46 +00005514 return res;
Guido van Rossuma1065681999-01-25 23:20:23 +00005515}
Andrew MacIntyre69e18c92004-04-04 07:11:43 +00005516
Guido van Rossuma1065681999-01-25 23:20:23 +00005517#endif /* HAVE_SPAWNV */
5518
5519
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005520#ifdef HAVE_FORK
Gregory P. Smith163468a2017-05-29 10:03:41 -07005521
5522/* Helper function to validate arguments.
5523 Returns 0 on success. non-zero on failure with a TypeError raised.
5524 If obj is non-NULL it must be callable. */
5525static int
5526check_null_or_callable(PyObject *obj, const char* obj_name)
5527{
5528 if (obj && !PyCallable_Check(obj)) {
5529 PyErr_Format(PyExc_TypeError, "'%s' must be callable, not %s",
5530 obj_name, Py_TYPE(obj)->tp_name);
5531 return -1;
5532 }
5533 return 0;
5534}
5535
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005536/*[clinic input]
5537os.register_at_fork
5538
Gregory P. Smith163468a2017-05-29 10:03:41 -07005539 *
5540 before: object=NULL
5541 A callable to be called in the parent before the fork() syscall.
5542 after_in_child: object=NULL
5543 A callable to be called in the child after fork().
5544 after_in_parent: object=NULL
5545 A callable to be called in the parent after fork().
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005546
Gregory P. Smith163468a2017-05-29 10:03:41 -07005547Register callables to be called when forking a new process.
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005548
Gregory P. Smith163468a2017-05-29 10:03:41 -07005549'before' callbacks are called in reverse order.
5550'after_in_child' and 'after_in_parent' callbacks are called in order.
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005551
5552[clinic start generated code]*/
5553
5554static PyObject *
Gregory P. Smith163468a2017-05-29 10:03:41 -07005555os_register_at_fork_impl(PyObject *module, PyObject *before,
5556 PyObject *after_in_child, PyObject *after_in_parent)
5557/*[clinic end generated code: output=5398ac75e8e97625 input=cd1187aa85d2312e]*/
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005558{
5559 PyInterpreterState *interp;
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005560
Gregory P. Smith163468a2017-05-29 10:03:41 -07005561 if (!before && !after_in_child && !after_in_parent) {
5562 PyErr_SetString(PyExc_TypeError, "At least one argument is required.");
5563 return NULL;
5564 }
5565 if (check_null_or_callable(before, "before") ||
5566 check_null_or_callable(after_in_child, "after_in_child") ||
5567 check_null_or_callable(after_in_parent, "after_in_parent")) {
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005568 return NULL;
5569 }
5570 interp = PyThreadState_Get()->interp;
5571
Gregory P. Smith163468a2017-05-29 10:03:41 -07005572 if (register_at_forker(&interp->before_forkers, before)) {
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005573 return NULL;
5574 }
Gregory P. Smith163468a2017-05-29 10:03:41 -07005575 if (register_at_forker(&interp->after_forkers_child, after_in_child)) {
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005576 return NULL;
Gregory P. Smith163468a2017-05-29 10:03:41 -07005577 }
5578 if (register_at_forker(&interp->after_forkers_parent, after_in_parent)) {
5579 return NULL;
5580 }
5581 Py_RETURN_NONE;
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005582}
5583#endif /* HAVE_FORK */
5584
5585
Guido van Rossum2242f2f2001-04-11 20:58:20 +00005586#ifdef HAVE_FORK1
Larry Hastings2f936352014-08-05 14:04:04 +10005587/*[clinic input]
5588os.fork1
5589
5590Fork a child process with a single multiplexed (i.e., not bound) thread.
5591
5592Return 0 to child process and PID of child to parent process.
5593[clinic start generated code]*/
5594
Larry Hastings2f936352014-08-05 14:04:04 +10005595static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005596os_fork1_impl(PyObject *module)
5597/*[clinic end generated code: output=0de8e67ce2a310bc input=12db02167893926e]*/
Guido van Rossum2242f2f2001-04-11 20:58:20 +00005598{
Victor Stinner8c62be82010-05-06 00:08:46 +00005599 pid_t pid;
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005600
5601 PyOS_BeforeFork();
Victor Stinner8c62be82010-05-06 00:08:46 +00005602 pid = fork1();
5603 if (pid == 0) {
5604 /* child: this clobbers and resets the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005605 PyOS_AfterFork_Child();
Victor Stinner8c62be82010-05-06 00:08:46 +00005606 } else {
5607 /* parent: release the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005608 PyOS_AfterFork_Parent();
Victor Stinner8c62be82010-05-06 00:08:46 +00005609 }
5610 if (pid == -1)
5611 return posix_error();
Victor Stinner8c62be82010-05-06 00:08:46 +00005612 return PyLong_FromPid(pid);
Guido van Rossum2242f2f2001-04-11 20:58:20 +00005613}
Larry Hastings2f936352014-08-05 14:04:04 +10005614#endif /* HAVE_FORK1 */
Guido van Rossum2242f2f2001-04-11 20:58:20 +00005615
5616
Guido van Rossumad0ee831995-03-01 10:34:45 +00005617#ifdef HAVE_FORK
Larry Hastings2f936352014-08-05 14:04:04 +10005618/*[clinic input]
5619os.fork
5620
5621Fork a child process.
5622
5623Return 0 to child process and PID of child to parent process.
5624[clinic start generated code]*/
5625
Larry Hastings2f936352014-08-05 14:04:04 +10005626static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005627os_fork_impl(PyObject *module)
5628/*[clinic end generated code: output=3626c81f98985d49 input=13c956413110eeaa]*/
Guido van Rossum85e3b011991-06-03 12:42:10 +00005629{
Victor Stinner8c62be82010-05-06 00:08:46 +00005630 pid_t pid;
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005631
5632 PyOS_BeforeFork();
Victor Stinner8c62be82010-05-06 00:08:46 +00005633 pid = fork();
5634 if (pid == 0) {
5635 /* child: this clobbers and resets the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005636 PyOS_AfterFork_Child();
Victor Stinner8c62be82010-05-06 00:08:46 +00005637 } else {
5638 /* parent: release the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005639 PyOS_AfterFork_Parent();
Victor Stinner8c62be82010-05-06 00:08:46 +00005640 }
5641 if (pid == -1)
5642 return posix_error();
Victor Stinner8c62be82010-05-06 00:08:46 +00005643 return PyLong_FromPid(pid);
Guido van Rossum85e3b011991-06-03 12:42:10 +00005644}
Larry Hastings2f936352014-08-05 14:04:04 +10005645#endif /* HAVE_FORK */
5646
Guido van Rossum85e3b011991-06-03 12:42:10 +00005647
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005648#ifdef HAVE_SCHED_H
Charles-François Nataliea0d5fc2011-09-06 19:03:35 +02005649#ifdef HAVE_SCHED_GET_PRIORITY_MAX
Larry Hastings2f936352014-08-05 14:04:04 +10005650/*[clinic input]
5651os.sched_get_priority_max
Charles-François Nataliea0d5fc2011-09-06 19:03:35 +02005652
Larry Hastings2f936352014-08-05 14:04:04 +10005653 policy: int
5654
5655Get the maximum scheduling priority for policy.
5656[clinic start generated code]*/
5657
Larry Hastings2f936352014-08-05 14:04:04 +10005658static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005659os_sched_get_priority_max_impl(PyObject *module, int policy)
5660/*[clinic end generated code: output=9e465c6e43130521 input=2097b7998eca6874]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005661{
5662 int max;
5663
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005664 max = sched_get_priority_max(policy);
5665 if (max < 0)
5666 return posix_error();
5667 return PyLong_FromLong(max);
5668}
5669
Larry Hastings2f936352014-08-05 14:04:04 +10005670
5671/*[clinic input]
5672os.sched_get_priority_min
5673
5674 policy: int
5675
5676Get the minimum scheduling priority for policy.
5677[clinic start generated code]*/
5678
Larry Hastings2f936352014-08-05 14:04:04 +10005679static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005680os_sched_get_priority_min_impl(PyObject *module, int policy)
5681/*[clinic end generated code: output=7595c1138cc47a6d input=21bc8fa0d70983bf]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005682{
5683 int min = sched_get_priority_min(policy);
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005684 if (min < 0)
5685 return posix_error();
5686 return PyLong_FromLong(min);
5687}
Charles-François Nataliea0d5fc2011-09-06 19:03:35 +02005688#endif /* HAVE_SCHED_GET_PRIORITY_MAX */
5689
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05005690
Larry Hastings2f936352014-08-05 14:04:04 +10005691#ifdef HAVE_SCHED_SETSCHEDULER
5692/*[clinic input]
5693os.sched_getscheduler
5694 pid: pid_t
5695 /
5696
5697Get the scheduling policy for the process identifiedy by pid.
5698
5699Passing 0 for pid returns the scheduling policy for the calling process.
5700[clinic start generated code]*/
5701
Larry Hastings2f936352014-08-05 14:04:04 +10005702static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005703os_sched_getscheduler_impl(PyObject *module, pid_t pid)
5704/*[clinic end generated code: output=dce4c0bd3f1b34c8 input=5f14cfd1f189e1a0]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005705{
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005706 int policy;
5707
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005708 policy = sched_getscheduler(pid);
5709 if (policy < 0)
5710 return posix_error();
5711 return PyLong_FromLong(policy);
5712}
Larry Hastings2f936352014-08-05 14:04:04 +10005713#endif /* HAVE_SCHED_SETSCHEDULER */
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005714
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05005715
5716#if defined(HAVE_SCHED_SETSCHEDULER) || defined(HAVE_SCHED_SETPARAM)
Larry Hastings2f936352014-08-05 14:04:04 +10005717/*[clinic input]
5718class os.sched_param "PyObject *" "&SchedParamType"
5719
5720@classmethod
5721os.sched_param.__new__
5722
5723 sched_priority: object
5724 A scheduling parameter.
5725
5726Current has only one field: sched_priority");
5727[clinic start generated code]*/
5728
Larry Hastings2f936352014-08-05 14:04:04 +10005729static PyObject *
5730os_sched_param_impl(PyTypeObject *type, PyObject *sched_priority)
Serhiy Storchaka1009bf12015-04-03 23:53:51 +03005731/*[clinic end generated code: output=48f4067d60f48c13 input=73a4c22f7071fc62]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005732{
5733 PyObject *res;
5734
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005735 res = PyStructSequence_New(type);
5736 if (!res)
5737 return NULL;
Larry Hastings2f936352014-08-05 14:04:04 +10005738 Py_INCREF(sched_priority);
5739 PyStructSequence_SET_ITEM(res, 0, sched_priority);
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005740 return res;
5741}
5742
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005743
Serhiy Storchaka1009bf12015-04-03 23:53:51 +03005744PyDoc_VAR(os_sched_param__doc__);
5745
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005746static PyStructSequence_Field sched_param_fields[] = {
5747 {"sched_priority", "the scheduling priority"},
5748 {0}
5749};
5750
5751static PyStructSequence_Desc sched_param_desc = {
5752 "sched_param", /* name */
Larry Hastings2f936352014-08-05 14:04:04 +10005753 os_sched_param__doc__, /* doc */
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005754 sched_param_fields,
5755 1
5756};
5757
5758static int
5759convert_sched_param(PyObject *param, struct sched_param *res)
5760{
5761 long priority;
5762
5763 if (Py_TYPE(param) != &SchedParamType) {
5764 PyErr_SetString(PyExc_TypeError, "must have a sched_param object");
5765 return 0;
5766 }
5767 priority = PyLong_AsLong(PyStructSequence_GET_ITEM(param, 0));
5768 if (priority == -1 && PyErr_Occurred())
5769 return 0;
5770 if (priority > INT_MAX || priority < INT_MIN) {
5771 PyErr_SetString(PyExc_OverflowError, "sched_priority out of range");
5772 return 0;
5773 }
5774 res->sched_priority = Py_SAFE_DOWNCAST(priority, long, int);
5775 return 1;
5776}
Larry Hastings2f936352014-08-05 14:04:04 +10005777#endif /* defined(HAVE_SCHED_SETSCHEDULER) || defined(HAVE_SCHED_SETPARAM) */
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005778
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05005779
5780#ifdef HAVE_SCHED_SETSCHEDULER
Larry Hastings2f936352014-08-05 14:04:04 +10005781/*[clinic input]
5782os.sched_setscheduler
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05005783
Larry Hastings2f936352014-08-05 14:04:04 +10005784 pid: pid_t
5785 policy: int
5786 param: sched_param
5787 /
5788
5789Set the scheduling policy for the process identified by pid.
5790
5791If pid is 0, the calling process is changed.
5792param is an instance of sched_param.
5793[clinic start generated code]*/
5794
Larry Hastings2f936352014-08-05 14:04:04 +10005795static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005796os_sched_setscheduler_impl(PyObject *module, pid_t pid, int policy,
Larry Hastings89964c42015-04-14 18:07:59 -04005797 struct sched_param *param)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005798/*[clinic end generated code: output=b0ac0a70d3b1d705 input=c581f9469a5327dd]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005799{
Jesus Cea9c822272011-09-10 01:40:52 +02005800 /*
Jesus Cea54b01492011-09-10 01:53:19 +02005801 ** sched_setscheduler() returns 0 in Linux, but the previous
5802 ** scheduling policy under Solaris/Illumos, and others.
5803 ** On error, -1 is returned in all Operating Systems.
Jesus Cea9c822272011-09-10 01:40:52 +02005804 */
Larry Hastings2f936352014-08-05 14:04:04 +10005805 if (sched_setscheduler(pid, policy, param) == -1)
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005806 return posix_error();
5807 Py_RETURN_NONE;
5808}
Larry Hastings2f936352014-08-05 14:04:04 +10005809#endif /* HAVE_SCHED_SETSCHEDULER*/
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005810
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05005811
5812#ifdef HAVE_SCHED_SETPARAM
Larry Hastings2f936352014-08-05 14:04:04 +10005813/*[clinic input]
5814os.sched_getparam
5815 pid: pid_t
5816 /
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05005817
Larry Hastings2f936352014-08-05 14:04:04 +10005818Returns scheduling parameters for the process identified by pid.
5819
5820If pid is 0, returns parameters for the calling process.
5821Return value is an instance of sched_param.
5822[clinic start generated code]*/
5823
Larry Hastings2f936352014-08-05 14:04:04 +10005824static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005825os_sched_getparam_impl(PyObject *module, pid_t pid)
5826/*[clinic end generated code: output=b194e8708dcf2db8 input=18a1ef9c2efae296]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005827{
5828 struct sched_param param;
5829 PyObject *result;
5830 PyObject *priority;
5831
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005832 if (sched_getparam(pid, &param))
5833 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10005834 result = PyStructSequence_New(&SchedParamType);
5835 if (!result)
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005836 return NULL;
5837 priority = PyLong_FromLong(param.sched_priority);
5838 if (!priority) {
Larry Hastings2f936352014-08-05 14:04:04 +10005839 Py_DECREF(result);
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005840 return NULL;
5841 }
Larry Hastings2f936352014-08-05 14:04:04 +10005842 PyStructSequence_SET_ITEM(result, 0, priority);
5843 return result;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005844}
5845
Larry Hastings2f936352014-08-05 14:04:04 +10005846
5847/*[clinic input]
5848os.sched_setparam
5849 pid: pid_t
5850 param: sched_param
5851 /
5852
5853Set scheduling parameters for the process identified by pid.
5854
5855If pid is 0, sets parameters for the calling process.
5856param should be an instance of sched_param.
5857[clinic start generated code]*/
5858
Larry Hastings2f936352014-08-05 14:04:04 +10005859static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005860os_sched_setparam_impl(PyObject *module, pid_t pid,
Larry Hastings89964c42015-04-14 18:07:59 -04005861 struct sched_param *param)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005862/*[clinic end generated code: output=8af013f78a32b591 input=6b8d6dfcecdc21bd]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005863{
5864 if (sched_setparam(pid, param))
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005865 return posix_error();
5866 Py_RETURN_NONE;
5867}
Larry Hastings2f936352014-08-05 14:04:04 +10005868#endif /* HAVE_SCHED_SETPARAM */
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005869
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05005870
5871#ifdef HAVE_SCHED_RR_GET_INTERVAL
Larry Hastings2f936352014-08-05 14:04:04 +10005872/*[clinic input]
5873os.sched_rr_get_interval -> double
5874 pid: pid_t
5875 /
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05005876
Larry Hastings2f936352014-08-05 14:04:04 +10005877Return the round-robin quantum for the process identified by pid, in seconds.
5878
5879Value returned is a float.
5880[clinic start generated code]*/
5881
Larry Hastings2f936352014-08-05 14:04:04 +10005882static double
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005883os_sched_rr_get_interval_impl(PyObject *module, pid_t pid)
5884/*[clinic end generated code: output=7e2d935833ab47dc input=2a973da15cca6fae]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005885{
5886 struct timespec interval;
5887 if (sched_rr_get_interval(pid, &interval)) {
5888 posix_error();
5889 return -1.0;
5890 }
5891 return (double)interval.tv_sec + 1e-9*interval.tv_nsec;
5892}
5893#endif /* HAVE_SCHED_RR_GET_INTERVAL */
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05005894
Larry Hastings2f936352014-08-05 14:04:04 +10005895
5896/*[clinic input]
5897os.sched_yield
5898
5899Voluntarily relinquish the CPU.
5900[clinic start generated code]*/
5901
Larry Hastings2f936352014-08-05 14:04:04 +10005902static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005903os_sched_yield_impl(PyObject *module)
5904/*[clinic end generated code: output=902323500f222cac input=e54d6f98189391d4]*/
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005905{
5906 if (sched_yield())
5907 return posix_error();
5908 Py_RETURN_NONE;
5909}
5910
Benjamin Peterson2740af82011-08-02 17:41:34 -05005911#ifdef HAVE_SCHED_SETAFFINITY
Antoine Pitrou84869872012-08-04 16:16:35 +02005912/* The minimum number of CPUs allocated in a cpu_set_t */
5913static const int NCPUS_START = sizeof(unsigned long) * CHAR_BIT;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005914
Larry Hastings2f936352014-08-05 14:04:04 +10005915/*[clinic input]
5916os.sched_setaffinity
5917 pid: pid_t
5918 mask : object
5919 /
5920
5921Set the CPU affinity of the process identified by pid to mask.
5922
5923mask should be an iterable of integers identifying CPUs.
5924[clinic start generated code]*/
5925
Larry Hastings2f936352014-08-05 14:04:04 +10005926static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005927os_sched_setaffinity_impl(PyObject *module, pid_t pid, PyObject *mask)
5928/*[clinic end generated code: output=882d7dd9a229335b input=a0791a597c7085ba]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005929{
Antoine Pitrou84869872012-08-04 16:16:35 +02005930 int ncpus;
5931 size_t setsize;
Larry Hastings2f936352014-08-05 14:04:04 +10005932 cpu_set_t *cpu_set = NULL;
5933 PyObject *iterator = NULL, *item;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005934
Larry Hastings2f936352014-08-05 14:04:04 +10005935 iterator = PyObject_GetIter(mask);
Antoine Pitrou84869872012-08-04 16:16:35 +02005936 if (iterator == NULL)
5937 return NULL;
5938
5939 ncpus = NCPUS_START;
5940 setsize = CPU_ALLOC_SIZE(ncpus);
Larry Hastings2f936352014-08-05 14:04:04 +10005941 cpu_set = CPU_ALLOC(ncpus);
5942 if (cpu_set == NULL) {
Antoine Pitrou84869872012-08-04 16:16:35 +02005943 PyErr_NoMemory();
5944 goto error;
5945 }
Larry Hastings2f936352014-08-05 14:04:04 +10005946 CPU_ZERO_S(setsize, cpu_set);
Antoine Pitrou84869872012-08-04 16:16:35 +02005947
5948 while ((item = PyIter_Next(iterator))) {
5949 long cpu;
5950 if (!PyLong_Check(item)) {
5951 PyErr_Format(PyExc_TypeError,
5952 "expected an iterator of ints, "
5953 "but iterator yielded %R",
5954 Py_TYPE(item));
5955 Py_DECREF(item);
5956 goto error;
5957 }
5958 cpu = PyLong_AsLong(item);
5959 Py_DECREF(item);
5960 if (cpu < 0) {
5961 if (!PyErr_Occurred())
5962 PyErr_SetString(PyExc_ValueError, "negative CPU number");
5963 goto error;
5964 }
5965 if (cpu > INT_MAX - 1) {
5966 PyErr_SetString(PyExc_OverflowError, "CPU number too large");
5967 goto error;
5968 }
5969 if (cpu >= ncpus) {
5970 /* Grow CPU mask to fit the CPU number */
5971 int newncpus = ncpus;
5972 cpu_set_t *newmask;
5973 size_t newsetsize;
5974 while (newncpus <= cpu) {
5975 if (newncpus > INT_MAX / 2)
5976 newncpus = cpu + 1;
5977 else
5978 newncpus = newncpus * 2;
5979 }
5980 newmask = CPU_ALLOC(newncpus);
5981 if (newmask == NULL) {
5982 PyErr_NoMemory();
5983 goto error;
5984 }
5985 newsetsize = CPU_ALLOC_SIZE(newncpus);
5986 CPU_ZERO_S(newsetsize, newmask);
Larry Hastings2f936352014-08-05 14:04:04 +10005987 memcpy(newmask, cpu_set, setsize);
5988 CPU_FREE(cpu_set);
Antoine Pitrou84869872012-08-04 16:16:35 +02005989 setsize = newsetsize;
Larry Hastings2f936352014-08-05 14:04:04 +10005990 cpu_set = newmask;
Antoine Pitrou84869872012-08-04 16:16:35 +02005991 ncpus = newncpus;
5992 }
Larry Hastings2f936352014-08-05 14:04:04 +10005993 CPU_SET_S(cpu, setsize, cpu_set);
Antoine Pitrou84869872012-08-04 16:16:35 +02005994 }
5995 Py_CLEAR(iterator);
5996
Larry Hastings2f936352014-08-05 14:04:04 +10005997 if (sched_setaffinity(pid, setsize, cpu_set)) {
Antoine Pitrou84869872012-08-04 16:16:35 +02005998 posix_error();
5999 goto error;
6000 }
Larry Hastings2f936352014-08-05 14:04:04 +10006001 CPU_FREE(cpu_set);
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006002 Py_RETURN_NONE;
Antoine Pitrou84869872012-08-04 16:16:35 +02006003
6004error:
Larry Hastings2f936352014-08-05 14:04:04 +10006005 if (cpu_set)
6006 CPU_FREE(cpu_set);
Antoine Pitrou84869872012-08-04 16:16:35 +02006007 Py_XDECREF(iterator);
6008 return NULL;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006009}
6010
Larry Hastings2f936352014-08-05 14:04:04 +10006011
6012/*[clinic input]
6013os.sched_getaffinity
6014 pid: pid_t
6015 /
6016
Charles-François Natalidc87e4b2015-07-13 21:01:39 +01006017Return the affinity of the process identified by pid (or the current process if zero).
Larry Hastings2f936352014-08-05 14:04:04 +10006018
6019The affinity is returned as a set of CPU identifiers.
6020[clinic start generated code]*/
6021
Larry Hastings2f936352014-08-05 14:04:04 +10006022static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006023os_sched_getaffinity_impl(PyObject *module, pid_t pid)
Serhiy Storchaka2954f832016-07-07 18:20:03 +03006024/*[clinic end generated code: output=f726f2c193c17a4f input=983ce7cb4a565980]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006025{
Antoine Pitrou84869872012-08-04 16:16:35 +02006026 int cpu, ncpus, count;
6027 size_t setsize;
6028 cpu_set_t *mask = NULL;
6029 PyObject *res = NULL;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006030
Antoine Pitrou84869872012-08-04 16:16:35 +02006031 ncpus = NCPUS_START;
6032 while (1) {
6033 setsize = CPU_ALLOC_SIZE(ncpus);
6034 mask = CPU_ALLOC(ncpus);
6035 if (mask == NULL)
6036 return PyErr_NoMemory();
6037 if (sched_getaffinity(pid, setsize, mask) == 0)
6038 break;
6039 CPU_FREE(mask);
6040 if (errno != EINVAL)
6041 return posix_error();
6042 if (ncpus > INT_MAX / 2) {
6043 PyErr_SetString(PyExc_OverflowError, "could not allocate "
6044 "a large enough CPU set");
6045 return NULL;
6046 }
6047 ncpus = ncpus * 2;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006048 }
Antoine Pitrou84869872012-08-04 16:16:35 +02006049
6050 res = PySet_New(NULL);
6051 if (res == NULL)
6052 goto error;
6053 for (cpu = 0, count = CPU_COUNT_S(setsize, mask); count; cpu++) {
6054 if (CPU_ISSET_S(cpu, setsize, mask)) {
6055 PyObject *cpu_num = PyLong_FromLong(cpu);
6056 --count;
6057 if (cpu_num == NULL)
6058 goto error;
6059 if (PySet_Add(res, cpu_num)) {
6060 Py_DECREF(cpu_num);
6061 goto error;
6062 }
6063 Py_DECREF(cpu_num);
6064 }
6065 }
6066 CPU_FREE(mask);
6067 return res;
6068
6069error:
6070 if (mask)
6071 CPU_FREE(mask);
6072 Py_XDECREF(res);
6073 return NULL;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006074}
6075
Benjamin Peterson2740af82011-08-02 17:41:34 -05006076#endif /* HAVE_SCHED_SETAFFINITY */
6077
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006078#endif /* HAVE_SCHED_H */
6079
Larry Hastings2f936352014-08-05 14:04:04 +10006080
Neal Norwitzb59798b2003-03-21 01:43:31 +00006081/* AIX uses /dev/ptc but is otherwise the same as /dev/ptmx */
Neal Norwitz2deaddb2003-03-21 03:08:31 +00006082/* IRIX has both /dev/ptc and /dev/ptmx, use ptmx */
6083#if defined(HAVE_DEV_PTC) && !defined(HAVE_DEV_PTMX)
Neal Norwitzb59798b2003-03-21 01:43:31 +00006084#define DEV_PTY_FILE "/dev/ptc"
6085#define HAVE_DEV_PTMX
6086#else
6087#define DEV_PTY_FILE "/dev/ptmx"
6088#endif
6089
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006090#if defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) || defined(HAVE_DEV_PTMX)
Fred Drake8cef4cf2000-06-28 16:40:38 +00006091#ifdef HAVE_PTY_H
6092#include <pty.h>
6093#else
6094#ifdef HAVE_LIBUTIL_H
6095#include <libutil.h>
Ronald Oussoren755740f2010-02-07 19:56:39 +00006096#else
6097#ifdef HAVE_UTIL_H
6098#include <util.h>
6099#endif /* HAVE_UTIL_H */
Fred Drake8cef4cf2000-06-28 16:40:38 +00006100#endif /* HAVE_LIBUTIL_H */
6101#endif /* HAVE_PTY_H */
Martin v. Löwis14e73b12003-01-01 09:51:12 +00006102#ifdef HAVE_STROPTS_H
6103#include <stropts.h>
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006104#endif
6105#endif /* defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) || defined(HAVE_DEV_PTMX */
Fred Drake8cef4cf2000-06-28 16:40:38 +00006106
Larry Hastings2f936352014-08-05 14:04:04 +10006107
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006108#if defined(HAVE_OPENPTY) || defined(HAVE__GETPTY) || defined(HAVE_DEV_PTMX)
Larry Hastings2f936352014-08-05 14:04:04 +10006109/*[clinic input]
6110os.openpty
6111
6112Open a pseudo-terminal.
6113
6114Return a tuple of (master_fd, slave_fd) containing open file descriptors
6115for both the master and slave ends.
6116[clinic start generated code]*/
6117
Larry Hastings2f936352014-08-05 14:04:04 +10006118static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006119os_openpty_impl(PyObject *module)
6120/*[clinic end generated code: output=98841ce5ec9cef3c input=f3d99fd99e762907]*/
Fred Drake8cef4cf2000-06-28 16:40:38 +00006121{
Victor Stinnerdaf45552013-08-28 00:53:59 +02006122 int master_fd = -1, slave_fd = -1;
Thomas Wouters70c21a12000-07-14 14:28:33 +00006123#ifndef HAVE_OPENPTY
Victor Stinner8c62be82010-05-06 00:08:46 +00006124 char * slave_name;
Thomas Wouters70c21a12000-07-14 14:28:33 +00006125#endif
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006126#if defined(HAVE_DEV_PTMX) && !defined(HAVE_OPENPTY) && !defined(HAVE__GETPTY)
Victor Stinner8c62be82010-05-06 00:08:46 +00006127 PyOS_sighandler_t sig_saved;
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006128#ifdef sun
Victor Stinner8c62be82010-05-06 00:08:46 +00006129 extern char *ptsname(int fildes);
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006130#endif
6131#endif
Thomas Wouters70c21a12000-07-14 14:28:33 +00006132
Thomas Wouters70c21a12000-07-14 14:28:33 +00006133#ifdef HAVE_OPENPTY
Victor Stinner8c62be82010-05-06 00:08:46 +00006134 if (openpty(&master_fd, &slave_fd, NULL, NULL, NULL) != 0)
Victor Stinnerdaf45552013-08-28 00:53:59 +02006135 goto posix_error;
6136
6137 if (_Py_set_inheritable(master_fd, 0, NULL) < 0)
6138 goto error;
6139 if (_Py_set_inheritable(slave_fd, 0, NULL) < 0)
6140 goto error;
6141
Neal Norwitzb59798b2003-03-21 01:43:31 +00006142#elif defined(HAVE__GETPTY)
Victor Stinner8c62be82010-05-06 00:08:46 +00006143 slave_name = _getpty(&master_fd, O_RDWR, 0666, 0);
6144 if (slave_name == NULL)
Victor Stinnerdaf45552013-08-28 00:53:59 +02006145 goto posix_error;
6146 if (_Py_set_inheritable(master_fd, 0, NULL) < 0)
6147 goto error;
Thomas Wouters70c21a12000-07-14 14:28:33 +00006148
Victor Stinnerdaf45552013-08-28 00:53:59 +02006149 slave_fd = _Py_open(slave_name, O_RDWR);
Victor Stinner8c62be82010-05-06 00:08:46 +00006150 if (slave_fd < 0)
Victor Stinnera555cfc2015-03-18 00:22:14 +01006151 goto error;
Victor Stinnerdaf45552013-08-28 00:53:59 +02006152
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006153#else
Victor Stinner000de532013-11-25 23:19:58 +01006154 master_fd = open(DEV_PTY_FILE, O_RDWR | O_NOCTTY); /* open master */
Victor Stinner8c62be82010-05-06 00:08:46 +00006155 if (master_fd < 0)
Victor Stinnerdaf45552013-08-28 00:53:59 +02006156 goto posix_error;
6157
Victor Stinner8c62be82010-05-06 00:08:46 +00006158 sig_saved = PyOS_setsig(SIGCHLD, SIG_DFL);
Victor Stinnerdaf45552013-08-28 00:53:59 +02006159
Victor Stinner8c62be82010-05-06 00:08:46 +00006160 /* change permission of slave */
6161 if (grantpt(master_fd) < 0) {
6162 PyOS_setsig(SIGCHLD, sig_saved);
Victor Stinnerdaf45552013-08-28 00:53:59 +02006163 goto posix_error;
Victor Stinner8c62be82010-05-06 00:08:46 +00006164 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02006165
Victor Stinner8c62be82010-05-06 00:08:46 +00006166 /* unlock slave */
6167 if (unlockpt(master_fd) < 0) {
6168 PyOS_setsig(SIGCHLD, sig_saved);
Victor Stinnerdaf45552013-08-28 00:53:59 +02006169 goto posix_error;
Victor Stinner8c62be82010-05-06 00:08:46 +00006170 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02006171
Victor Stinner8c62be82010-05-06 00:08:46 +00006172 PyOS_setsig(SIGCHLD, sig_saved);
Victor Stinnerdaf45552013-08-28 00:53:59 +02006173
Victor Stinner8c62be82010-05-06 00:08:46 +00006174 slave_name = ptsname(master_fd); /* get name of slave */
6175 if (slave_name == NULL)
Victor Stinnerdaf45552013-08-28 00:53:59 +02006176 goto posix_error;
6177
6178 slave_fd = _Py_open(slave_name, O_RDWR | O_NOCTTY); /* open slave */
Victor Stinnera555cfc2015-03-18 00:22:14 +01006179 if (slave_fd == -1)
6180 goto error;
Victor Stinner000de532013-11-25 23:19:58 +01006181
6182 if (_Py_set_inheritable(master_fd, 0, NULL) < 0)
6183 goto posix_error;
6184
Stefan Krahfb7c8ae2016-04-26 17:04:18 +02006185#if !defined(__CYGWIN__) && !defined(__ANDROID__) && !defined(HAVE_DEV_PTC)
Victor Stinner8c62be82010-05-06 00:08:46 +00006186 ioctl(slave_fd, I_PUSH, "ptem"); /* push ptem */
6187 ioctl(slave_fd, I_PUSH, "ldterm"); /* push ldterm */
Neal Norwitz6700e472002-12-31 16:16:07 +00006188#ifndef __hpux
Victor Stinner8c62be82010-05-06 00:08:46 +00006189 ioctl(slave_fd, I_PUSH, "ttcompat"); /* push ttcompat */
Neal Norwitz6700e472002-12-31 16:16:07 +00006190#endif /* __hpux */
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006191#endif /* HAVE_CYGWIN */
Thomas Wouters1e0c2f42000-07-24 16:06:23 +00006192#endif /* HAVE_OPENPTY */
Thomas Wouters70c21a12000-07-14 14:28:33 +00006193
Victor Stinner8c62be82010-05-06 00:08:46 +00006194 return Py_BuildValue("(ii)", master_fd, slave_fd);
Thomas Wouters70c21a12000-07-14 14:28:33 +00006195
Victor Stinnerdaf45552013-08-28 00:53:59 +02006196posix_error:
6197 posix_error();
6198error:
6199 if (master_fd != -1)
6200 close(master_fd);
6201 if (slave_fd != -1)
6202 close(slave_fd);
6203 return NULL;
Fred Drake8cef4cf2000-06-28 16:40:38 +00006204}
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006205#endif /* defined(HAVE_OPENPTY) || defined(HAVE__GETPTY) || defined(HAVE_DEV_PTMX) */
Fred Drake8cef4cf2000-06-28 16:40:38 +00006206
Larry Hastings2f936352014-08-05 14:04:04 +10006207
Fred Drake8cef4cf2000-06-28 16:40:38 +00006208#ifdef HAVE_FORKPTY
Larry Hastings2f936352014-08-05 14:04:04 +10006209/*[clinic input]
6210os.forkpty
6211
6212Fork a new process with a new pseudo-terminal as controlling tty.
6213
6214Returns a tuple of (pid, master_fd).
6215Like fork(), return pid of 0 to the child process,
6216and pid of child to the parent process.
6217To both, return fd of newly opened pseudo-terminal.
6218[clinic start generated code]*/
6219
Larry Hastings2f936352014-08-05 14:04:04 +10006220static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006221os_forkpty_impl(PyObject *module)
6222/*[clinic end generated code: output=60d0a5c7512e4087 input=f1f7f4bae3966010]*/
Fred Drake8cef4cf2000-06-28 16:40:38 +00006223{
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006224 int master_fd = -1;
Victor Stinner8c62be82010-05-06 00:08:46 +00006225 pid_t pid;
Tim Peters5aa91602002-01-30 05:46:57 +00006226
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006227 PyOS_BeforeFork();
Victor Stinner8c62be82010-05-06 00:08:46 +00006228 pid = forkpty(&master_fd, NULL, NULL, NULL);
6229 if (pid == 0) {
6230 /* child: this clobbers and resets the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006231 PyOS_AfterFork_Child();
Victor Stinner8c62be82010-05-06 00:08:46 +00006232 } else {
6233 /* parent: release the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006234 PyOS_AfterFork_Parent();
Victor Stinner8c62be82010-05-06 00:08:46 +00006235 }
6236 if (pid == -1)
6237 return posix_error();
Victor Stinner8c62be82010-05-06 00:08:46 +00006238 return Py_BuildValue("(Ni)", PyLong_FromPid(pid), master_fd);
Fred Drake8cef4cf2000-06-28 16:40:38 +00006239}
Larry Hastings2f936352014-08-05 14:04:04 +10006240#endif /* HAVE_FORKPTY */
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006241
Ross Lagerwall7807c352011-03-17 20:20:30 +02006242
Guido van Rossumad0ee831995-03-01 10:34:45 +00006243#ifdef HAVE_GETEGID
Larry Hastings2f936352014-08-05 14:04:04 +10006244/*[clinic input]
6245os.getegid
6246
6247Return the current process's effective group id.
6248[clinic start generated code]*/
6249
Larry Hastings2f936352014-08-05 14:04:04 +10006250static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006251os_getegid_impl(PyObject *module)
6252/*[clinic end generated code: output=67d9be7ac68898a2 input=1596f79ad1107d5d]*/
Guido van Rossum46003ff1992-05-15 11:05:24 +00006253{
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006254 return _PyLong_FromGid(getegid());
Guido van Rossum46003ff1992-05-15 11:05:24 +00006255}
Larry Hastings2f936352014-08-05 14:04:04 +10006256#endif /* HAVE_GETEGID */
Guido van Rossum46003ff1992-05-15 11:05:24 +00006257
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006258
Guido van Rossumad0ee831995-03-01 10:34:45 +00006259#ifdef HAVE_GETEUID
Larry Hastings2f936352014-08-05 14:04:04 +10006260/*[clinic input]
6261os.geteuid
6262
6263Return the current process's effective user id.
6264[clinic start generated code]*/
6265
Larry Hastings2f936352014-08-05 14:04:04 +10006266static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006267os_geteuid_impl(PyObject *module)
6268/*[clinic end generated code: output=ea1b60f0d6abb66e input=4644c662d3bd9f19]*/
Guido van Rossum46003ff1992-05-15 11:05:24 +00006269{
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006270 return _PyLong_FromUid(geteuid());
Guido van Rossum46003ff1992-05-15 11:05:24 +00006271}
Larry Hastings2f936352014-08-05 14:04:04 +10006272#endif /* HAVE_GETEUID */
Guido van Rossum46003ff1992-05-15 11:05:24 +00006273
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006274
Guido van Rossumad0ee831995-03-01 10:34:45 +00006275#ifdef HAVE_GETGID
Larry Hastings2f936352014-08-05 14:04:04 +10006276/*[clinic input]
6277os.getgid
6278
6279Return the current process's group id.
6280[clinic start generated code]*/
6281
Larry Hastings2f936352014-08-05 14:04:04 +10006282static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006283os_getgid_impl(PyObject *module)
6284/*[clinic end generated code: output=4f28ebc9d3e5dfcf input=58796344cd87c0f6]*/
Guido van Rossum46003ff1992-05-15 11:05:24 +00006285{
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006286 return _PyLong_FromGid(getgid());
Guido van Rossum46003ff1992-05-15 11:05:24 +00006287}
Larry Hastings2f936352014-08-05 14:04:04 +10006288#endif /* HAVE_GETGID */
Guido van Rossum46003ff1992-05-15 11:05:24 +00006289
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006290
Berker Peksag39404992016-09-15 20:45:16 +03006291#ifdef HAVE_GETPID
Larry Hastings2f936352014-08-05 14:04:04 +10006292/*[clinic input]
6293os.getpid
6294
6295Return the current process id.
6296[clinic start generated code]*/
6297
Larry Hastings2f936352014-08-05 14:04:04 +10006298static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006299os_getpid_impl(PyObject *module)
6300/*[clinic end generated code: output=9ea6fdac01ed2b3c input=5a9a00f0ab68aa00]*/
Guido van Rossum85e3b011991-06-03 12:42:10 +00006301{
Victor Stinner8c62be82010-05-06 00:08:46 +00006302 return PyLong_FromPid(getpid());
Guido van Rossum85e3b011991-06-03 12:42:10 +00006303}
Berker Peksag39404992016-09-15 20:45:16 +03006304#endif /* HAVE_GETPID */
Guido van Rossum85e3b011991-06-03 12:42:10 +00006305
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006306#ifdef HAVE_GETGROUPLIST
Larry Hastings2f936352014-08-05 14:04:04 +10006307
6308/* AC 3.5: funny apple logic below */
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006309PyDoc_STRVAR(posix_getgrouplist__doc__,
6310"getgrouplist(user, group) -> list of groups to which a user belongs\n\n\
6311Returns a list of groups to which a user belongs.\n\n\
6312 user: username to lookup\n\
6313 group: base group id of the user");
6314
6315static PyObject *
6316posix_getgrouplist(PyObject *self, PyObject *args)
6317{
6318#ifdef NGROUPS_MAX
6319#define MAX_GROUPS NGROUPS_MAX
6320#else
6321 /* defined to be 16 on Solaris7, so this should be a small number */
6322#define MAX_GROUPS 64
6323#endif
6324
6325 const char *user;
6326 int i, ngroups;
6327 PyObject *list;
6328#ifdef __APPLE__
6329 int *groups, basegid;
6330#else
6331 gid_t *groups, basegid;
6332#endif
6333 ngroups = MAX_GROUPS;
6334
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006335#ifdef __APPLE__
6336 if (!PyArg_ParseTuple(args, "si:getgrouplist", &user, &basegid))
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006337 return NULL;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006338#else
6339 if (!PyArg_ParseTuple(args, "sO&:getgrouplist", &user,
6340 _Py_Gid_Converter, &basegid))
6341 return NULL;
6342#endif
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006343
6344#ifdef __APPLE__
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02006345 groups = PyMem_New(int, ngroups);
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006346#else
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02006347 groups = PyMem_New(gid_t, ngroups);
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006348#endif
6349 if (groups == NULL)
6350 return PyErr_NoMemory();
6351
6352 if (getgrouplist(user, basegid, groups, &ngroups) == -1) {
6353 PyMem_Del(groups);
6354 return posix_error();
6355 }
6356
6357 list = PyList_New(ngroups);
6358 if (list == NULL) {
6359 PyMem_Del(groups);
6360 return NULL;
6361 }
6362
6363 for (i = 0; i < ngroups; i++) {
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006364#ifdef __APPLE__
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006365 PyObject *o = PyLong_FromUnsignedLong((unsigned long)groups[i]);
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006366#else
6367 PyObject *o = _PyLong_FromGid(groups[i]);
6368#endif
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006369 if (o == NULL) {
6370 Py_DECREF(list);
6371 PyMem_Del(groups);
6372 return NULL;
6373 }
6374 PyList_SET_ITEM(list, i, o);
6375 }
6376
6377 PyMem_Del(groups);
6378
6379 return list;
6380}
Larry Hastings2f936352014-08-05 14:04:04 +10006381#endif /* HAVE_GETGROUPLIST */
6382
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006383
Fred Drakec9680921999-12-13 16:37:25 +00006384#ifdef HAVE_GETGROUPS
Larry Hastings2f936352014-08-05 14:04:04 +10006385/*[clinic input]
6386os.getgroups
6387
6388Return list of supplemental group IDs for the process.
6389[clinic start generated code]*/
6390
Larry Hastings2f936352014-08-05 14:04:04 +10006391static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006392os_getgroups_impl(PyObject *module)
6393/*[clinic end generated code: output=42b0c17758561b56 input=d3f109412e6a155c]*/
Fred Drakec9680921999-12-13 16:37:25 +00006394{
6395 PyObject *result = NULL;
6396
Fred Drakec9680921999-12-13 16:37:25 +00006397#ifdef NGROUPS_MAX
6398#define MAX_GROUPS NGROUPS_MAX
6399#else
Victor Stinner8c62be82010-05-06 00:08:46 +00006400 /* defined to be 16 on Solaris7, so this should be a small number */
Fred Drakec9680921999-12-13 16:37:25 +00006401#define MAX_GROUPS 64
6402#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00006403 gid_t grouplist[MAX_GROUPS];
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00006404
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00006405 /* On MacOSX getgroups(2) can return more than MAX_GROUPS results
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00006406 * This is a helper variable to store the intermediate result when
6407 * that happens.
6408 *
6409 * To keep the code readable the OSX behaviour is unconditional,
6410 * according to the POSIX spec this should be safe on all unix-y
6411 * systems.
6412 */
6413 gid_t* alt_grouplist = grouplist;
Victor Stinner8c62be82010-05-06 00:08:46 +00006414 int n;
Fred Drakec9680921999-12-13 16:37:25 +00006415
Ned Deilyb5dd6d22013-08-01 21:21:15 -07006416#ifdef __APPLE__
6417 /* Issue #17557: As of OS X 10.8, getgroups(2) no longer raises EINVAL if
6418 * there are more groups than can fit in grouplist. Therefore, on OS X
6419 * always first call getgroups with length 0 to get the actual number
6420 * of groups.
6421 */
6422 n = getgroups(0, NULL);
6423 if (n < 0) {
6424 return posix_error();
6425 } else if (n <= MAX_GROUPS) {
6426 /* groups will fit in existing array */
6427 alt_grouplist = grouplist;
6428 } else {
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02006429 alt_grouplist = PyMem_New(gid_t, n);
Ned Deilyb5dd6d22013-08-01 21:21:15 -07006430 if (alt_grouplist == NULL) {
6431 errno = EINVAL;
6432 return posix_error();
6433 }
6434 }
6435
6436 n = getgroups(n, alt_grouplist);
6437 if (n == -1) {
6438 if (alt_grouplist != grouplist) {
6439 PyMem_Free(alt_grouplist);
6440 }
6441 return posix_error();
6442 }
6443#else
Victor Stinner8c62be82010-05-06 00:08:46 +00006444 n = getgroups(MAX_GROUPS, grouplist);
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00006445 if (n < 0) {
6446 if (errno == EINVAL) {
6447 n = getgroups(0, NULL);
6448 if (n == -1) {
6449 return posix_error();
6450 }
6451 if (n == 0) {
6452 /* Avoid malloc(0) */
6453 alt_grouplist = grouplist;
6454 } else {
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02006455 alt_grouplist = PyMem_New(gid_t, n);
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00006456 if (alt_grouplist == NULL) {
6457 errno = EINVAL;
6458 return posix_error();
6459 }
6460 n = getgroups(n, alt_grouplist);
6461 if (n == -1) {
6462 PyMem_Free(alt_grouplist);
6463 return posix_error();
6464 }
6465 }
6466 } else {
6467 return posix_error();
6468 }
6469 }
Ned Deilyb5dd6d22013-08-01 21:21:15 -07006470#endif
6471
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00006472 result = PyList_New(n);
6473 if (result != NULL) {
Victor Stinner8c62be82010-05-06 00:08:46 +00006474 int i;
6475 for (i = 0; i < n; ++i) {
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006476 PyObject *o = _PyLong_FromGid(alt_grouplist[i]);
Victor Stinner8c62be82010-05-06 00:08:46 +00006477 if (o == NULL) {
Stefan Krah0e803b32010-11-26 16:16:47 +00006478 Py_DECREF(result);
6479 result = NULL;
6480 break;
Fred Drakec9680921999-12-13 16:37:25 +00006481 }
Victor Stinner8c62be82010-05-06 00:08:46 +00006482 PyList_SET_ITEM(result, i, o);
Fred Drakec9680921999-12-13 16:37:25 +00006483 }
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00006484 }
6485
6486 if (alt_grouplist != grouplist) {
6487 PyMem_Free(alt_grouplist);
Victor Stinner8c62be82010-05-06 00:08:46 +00006488 }
Neal Norwitze241ce82003-02-17 18:17:05 +00006489
Fred Drakec9680921999-12-13 16:37:25 +00006490 return result;
6491}
Larry Hastings2f936352014-08-05 14:04:04 +10006492#endif /* HAVE_GETGROUPS */
Fred Drakec9680921999-12-13 16:37:25 +00006493
Antoine Pitroub7572f02009-12-02 20:46:48 +00006494#ifdef HAVE_INITGROUPS
6495PyDoc_STRVAR(posix_initgroups__doc__,
6496"initgroups(username, gid) -> None\n\n\
6497Call the system initgroups() to initialize the group access list with all of\n\
6498the groups of which the specified username is a member, plus the specified\n\
6499group id.");
6500
Larry Hastings2f936352014-08-05 14:04:04 +10006501/* AC 3.5: funny apple logic */
Antoine Pitroub7572f02009-12-02 20:46:48 +00006502static PyObject *
6503posix_initgroups(PyObject *self, PyObject *args)
6504{
Victor Stinner61ec5dc2010-08-15 09:22:44 +00006505 PyObject *oname;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03006506 const char *username;
Victor Stinner61ec5dc2010-08-15 09:22:44 +00006507 int res;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006508#ifdef __APPLE__
6509 int gid;
6510#else
6511 gid_t gid;
6512#endif
Antoine Pitroub7572f02009-12-02 20:46:48 +00006513
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006514#ifdef __APPLE__
6515 if (!PyArg_ParseTuple(args, "O&i:initgroups",
6516 PyUnicode_FSConverter, &oname,
6517 &gid))
6518#else
6519 if (!PyArg_ParseTuple(args, "O&O&:initgroups",
6520 PyUnicode_FSConverter, &oname,
6521 _Py_Gid_Converter, &gid))
6522#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00006523 return NULL;
Victor Stinner61ec5dc2010-08-15 09:22:44 +00006524 username = PyBytes_AS_STRING(oname);
Antoine Pitroub7572f02009-12-02 20:46:48 +00006525
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006526 res = initgroups(username, gid);
Victor Stinner61ec5dc2010-08-15 09:22:44 +00006527 Py_DECREF(oname);
6528 if (res == -1)
Victor Stinner8c62be82010-05-06 00:08:46 +00006529 return PyErr_SetFromErrno(PyExc_OSError);
Antoine Pitroub7572f02009-12-02 20:46:48 +00006530
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02006531 Py_RETURN_NONE;
Antoine Pitroub7572f02009-12-02 20:46:48 +00006532}
Larry Hastings2f936352014-08-05 14:04:04 +10006533#endif /* HAVE_INITGROUPS */
6534
Antoine Pitroub7572f02009-12-02 20:46:48 +00006535
Martin v. Löwis606edc12002-06-13 21:09:11 +00006536#ifdef HAVE_GETPGID
Larry Hastings2f936352014-08-05 14:04:04 +10006537/*[clinic input]
6538os.getpgid
6539
6540 pid: pid_t
6541
6542Call the system call getpgid(), and return the result.
6543[clinic start generated code]*/
6544
Larry Hastings2f936352014-08-05 14:04:04 +10006545static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006546os_getpgid_impl(PyObject *module, pid_t pid)
6547/*[clinic end generated code: output=1db95a97be205d18 input=39d710ae3baaf1c7]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006548{
6549 pid_t pgid = getpgid(pid);
Victor Stinner8c62be82010-05-06 00:08:46 +00006550 if (pgid < 0)
6551 return posix_error();
6552 return PyLong_FromPid(pgid);
Martin v. Löwis606edc12002-06-13 21:09:11 +00006553}
6554#endif /* HAVE_GETPGID */
6555
6556
Guido van Rossumb6775db1994-08-01 11:34:53 +00006557#ifdef HAVE_GETPGRP
Larry Hastings2f936352014-08-05 14:04:04 +10006558/*[clinic input]
6559os.getpgrp
6560
6561Return the current process group id.
6562[clinic start generated code]*/
6563
Larry Hastings2f936352014-08-05 14:04:04 +10006564static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006565os_getpgrp_impl(PyObject *module)
6566/*[clinic end generated code: output=c4fc381e51103cf3 input=6846fb2bb9a3705e]*/
Guido van Rossum04814471991-06-04 20:23:49 +00006567{
Guido van Rossumb6775db1994-08-01 11:34:53 +00006568#ifdef GETPGRP_HAVE_ARG
Victor Stinner8c62be82010-05-06 00:08:46 +00006569 return PyLong_FromPid(getpgrp(0));
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00006570#else /* GETPGRP_HAVE_ARG */
Victor Stinner8c62be82010-05-06 00:08:46 +00006571 return PyLong_FromPid(getpgrp());
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00006572#endif /* GETPGRP_HAVE_ARG */
Guido van Rossum04814471991-06-04 20:23:49 +00006573}
Guido van Rossumb6775db1994-08-01 11:34:53 +00006574#endif /* HAVE_GETPGRP */
Guido van Rossum04814471991-06-04 20:23:49 +00006575
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006576
Guido van Rossumb6775db1994-08-01 11:34:53 +00006577#ifdef HAVE_SETPGRP
Larry Hastings2f936352014-08-05 14:04:04 +10006578/*[clinic input]
6579os.setpgrp
6580
6581Make the current process the leader of its process group.
6582[clinic start generated code]*/
6583
Larry Hastings2f936352014-08-05 14:04:04 +10006584static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006585os_setpgrp_impl(PyObject *module)
6586/*[clinic end generated code: output=2554735b0a60f0a0 input=1f0619fcb5731e7e]*/
Guido van Rossumc2670a01992-09-13 20:07:29 +00006587{
Guido van Rossum64933891994-10-20 21:56:42 +00006588#ifdef SETPGRP_HAVE_ARG
Victor Stinner8c62be82010-05-06 00:08:46 +00006589 if (setpgrp(0, 0) < 0)
Guido van Rossum64933891994-10-20 21:56:42 +00006590#else /* SETPGRP_HAVE_ARG */
Victor Stinner8c62be82010-05-06 00:08:46 +00006591 if (setpgrp() < 0)
Guido van Rossum64933891994-10-20 21:56:42 +00006592#endif /* SETPGRP_HAVE_ARG */
Victor Stinner8c62be82010-05-06 00:08:46 +00006593 return posix_error();
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02006594 Py_RETURN_NONE;
Guido van Rossumc2670a01992-09-13 20:07:29 +00006595}
Guido van Rossumb6775db1994-08-01 11:34:53 +00006596#endif /* HAVE_SETPGRP */
6597
Guido van Rossumad0ee831995-03-01 10:34:45 +00006598#ifdef HAVE_GETPPID
Amaury Forgeot d'Arc4b6fdf32010-09-07 21:31:17 +00006599
6600#ifdef MS_WINDOWS
6601#include <tlhelp32.h>
6602
6603static PyObject*
6604win32_getppid()
6605{
6606 HANDLE snapshot;
6607 pid_t mypid;
6608 PyObject* result = NULL;
6609 BOOL have_record;
6610 PROCESSENTRY32 pe;
6611
6612 mypid = getpid(); /* This function never fails */
6613
6614 snapshot = CreateToolhelp32Snapshot(TH32CS_SNAPPROCESS, 0);
6615 if (snapshot == INVALID_HANDLE_VALUE)
6616 return PyErr_SetFromWindowsErr(GetLastError());
6617
6618 pe.dwSize = sizeof(pe);
6619 have_record = Process32First(snapshot, &pe);
6620 while (have_record) {
6621 if (mypid == (pid_t)pe.th32ProcessID) {
6622 /* We could cache the ulong value in a static variable. */
6623 result = PyLong_FromPid((pid_t)pe.th32ParentProcessID);
6624 break;
6625 }
6626
6627 have_record = Process32Next(snapshot, &pe);
6628 }
6629
6630 /* If our loop exits and our pid was not found (result will be NULL)
6631 * then GetLastError will return ERROR_NO_MORE_FILES. This is an
6632 * error anyway, so let's raise it. */
6633 if (!result)
6634 result = PyErr_SetFromWindowsErr(GetLastError());
6635
6636 CloseHandle(snapshot);
6637
6638 return result;
6639}
6640#endif /*MS_WINDOWS*/
6641
Larry Hastings2f936352014-08-05 14:04:04 +10006642
6643/*[clinic input]
6644os.getppid
6645
6646Return the parent's process id.
6647
6648If the parent process has already exited, Windows machines will still
6649return its id; others systems will return the id of the 'init' process (1).
6650[clinic start generated code]*/
6651
Larry Hastings2f936352014-08-05 14:04:04 +10006652static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006653os_getppid_impl(PyObject *module)
6654/*[clinic end generated code: output=43b2a946a8c603b4 input=e637cb87539c030e]*/
Guido van Rossum85e3b011991-06-03 12:42:10 +00006655{
Amaury Forgeot d'Arc4b6fdf32010-09-07 21:31:17 +00006656#ifdef MS_WINDOWS
6657 return win32_getppid();
6658#else
Victor Stinner8c62be82010-05-06 00:08:46 +00006659 return PyLong_FromPid(getppid());
Guido van Rossumad0ee831995-03-01 10:34:45 +00006660#endif
Amaury Forgeot d'Arc4b6fdf32010-09-07 21:31:17 +00006661}
6662#endif /* HAVE_GETPPID */
Guido van Rossum85e3b011991-06-03 12:42:10 +00006663
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006664
Fred Drake12c6e2d1999-12-14 21:25:03 +00006665#ifdef HAVE_GETLOGIN
Larry Hastings2f936352014-08-05 14:04:04 +10006666/*[clinic input]
6667os.getlogin
6668
6669Return the actual login name.
6670[clinic start generated code]*/
6671
Larry Hastings2f936352014-08-05 14:04:04 +10006672static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006673os_getlogin_impl(PyObject *module)
6674/*[clinic end generated code: output=a32e66a7e5715dac input=2a21ab1e917163df]*/
Fred Drake12c6e2d1999-12-14 21:25:03 +00006675{
Victor Stinner8c62be82010-05-06 00:08:46 +00006676 PyObject *result = NULL;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00006677#ifdef MS_WINDOWS
Brian Curtine8e4b3b2010-09-23 20:04:14 +00006678 wchar_t user_name[UNLEN + 1];
Victor Stinner63941882011-09-29 00:42:28 +02006679 DWORD num_chars = Py_ARRAY_LENGTH(user_name);
Brian Curtine8e4b3b2010-09-23 20:04:14 +00006680
6681 if (GetUserNameW(user_name, &num_chars)) {
6682 /* num_chars is the number of unicode chars plus null terminator */
6683 result = PyUnicode_FromWideChar(user_name, num_chars - 1);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00006684 }
6685 else
Brian Curtine8e4b3b2010-09-23 20:04:14 +00006686 result = PyErr_SetFromWindowsErr(GetLastError());
6687#else
Victor Stinner8c62be82010-05-06 00:08:46 +00006688 char *name;
6689 int old_errno = errno;
Fred Drake12c6e2d1999-12-14 21:25:03 +00006690
Victor Stinner8c62be82010-05-06 00:08:46 +00006691 errno = 0;
6692 name = getlogin();
6693 if (name == NULL) {
6694 if (errno)
Victor Stinnere039ffe2010-08-15 09:33:08 +00006695 posix_error();
Fred Drake12c6e2d1999-12-14 21:25:03 +00006696 else
Victor Stinnere039ffe2010-08-15 09:33:08 +00006697 PyErr_SetString(PyExc_OSError, "unable to determine login name");
Victor Stinner8c62be82010-05-06 00:08:46 +00006698 }
6699 else
Victor Stinnere039ffe2010-08-15 09:33:08 +00006700 result = PyUnicode_DecodeFSDefault(name);
Victor Stinner8c62be82010-05-06 00:08:46 +00006701 errno = old_errno;
Brian Curtine8e4b3b2010-09-23 20:04:14 +00006702#endif
Fred Drake12c6e2d1999-12-14 21:25:03 +00006703 return result;
6704}
Brian Curtine8e4b3b2010-09-23 20:04:14 +00006705#endif /* HAVE_GETLOGIN */
Fred Drake12c6e2d1999-12-14 21:25:03 +00006706
Larry Hastings2f936352014-08-05 14:04:04 +10006707
Guido van Rossumad0ee831995-03-01 10:34:45 +00006708#ifdef HAVE_GETUID
Larry Hastings2f936352014-08-05 14:04:04 +10006709/*[clinic input]
6710os.getuid
6711
6712Return the current process's user id.
6713[clinic start generated code]*/
6714
Larry Hastings2f936352014-08-05 14:04:04 +10006715static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006716os_getuid_impl(PyObject *module)
6717/*[clinic end generated code: output=415c0b401ebed11a input=b53c8b35f110a516]*/
Guido van Rossum46003ff1992-05-15 11:05:24 +00006718{
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006719 return _PyLong_FromUid(getuid());
Guido van Rossum46003ff1992-05-15 11:05:24 +00006720}
Larry Hastings2f936352014-08-05 14:04:04 +10006721#endif /* HAVE_GETUID */
Guido van Rossum46003ff1992-05-15 11:05:24 +00006722
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006723
Brian Curtineb24d742010-04-12 17:16:38 +00006724#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10006725#define HAVE_KILL
6726#endif /* MS_WINDOWS */
6727
6728#ifdef HAVE_KILL
6729/*[clinic input]
6730os.kill
6731
6732 pid: pid_t
6733 signal: Py_ssize_t
6734 /
6735
6736Kill a process with a signal.
6737[clinic start generated code]*/
6738
Larry Hastings2f936352014-08-05 14:04:04 +10006739static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006740os_kill_impl(PyObject *module, pid_t pid, Py_ssize_t signal)
6741/*[clinic end generated code: output=8e346a6701c88568 input=61a36b86ca275ab9]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006742#ifndef MS_WINDOWS
6743{
6744 if (kill(pid, (int)signal) == -1)
6745 return posix_error();
6746 Py_RETURN_NONE;
6747}
6748#else /* !MS_WINDOWS */
Brian Curtineb24d742010-04-12 17:16:38 +00006749{
Amaury Forgeot d'Arc0a589c92010-05-15 20:35:12 +00006750 PyObject *result;
Larry Hastings2f936352014-08-05 14:04:04 +10006751 DWORD sig = (DWORD)signal;
6752 DWORD err;
Victor Stinner8c62be82010-05-06 00:08:46 +00006753 HANDLE handle;
Brian Curtineb24d742010-04-12 17:16:38 +00006754
Victor Stinner8c62be82010-05-06 00:08:46 +00006755 /* Console processes which share a common console can be sent CTRL+C or
6756 CTRL+BREAK events, provided they handle said events. */
6757 if (sig == CTRL_C_EVENT || sig == CTRL_BREAK_EVENT) {
Richard Oudkerkac0ad882013-06-05 23:29:30 +01006758 if (GenerateConsoleCtrlEvent(sig, (DWORD)pid) == 0) {
Victor Stinner8c62be82010-05-06 00:08:46 +00006759 err = GetLastError();
6760 PyErr_SetFromWindowsErr(err);
6761 }
6762 else
6763 Py_RETURN_NONE;
6764 }
Brian Curtineb24d742010-04-12 17:16:38 +00006765
Victor Stinner8c62be82010-05-06 00:08:46 +00006766 /* If the signal is outside of what GenerateConsoleCtrlEvent can use,
6767 attempt to open and terminate the process. */
Richard Oudkerkac0ad882013-06-05 23:29:30 +01006768 handle = OpenProcess(PROCESS_ALL_ACCESS, FALSE, (DWORD)pid);
Victor Stinner8c62be82010-05-06 00:08:46 +00006769 if (handle == NULL) {
6770 err = GetLastError();
6771 return PyErr_SetFromWindowsErr(err);
6772 }
Brian Curtineb24d742010-04-12 17:16:38 +00006773
Victor Stinner8c62be82010-05-06 00:08:46 +00006774 if (TerminateProcess(handle, sig) == 0) {
6775 err = GetLastError();
6776 result = PyErr_SetFromWindowsErr(err);
6777 } else {
6778 Py_INCREF(Py_None);
6779 result = Py_None;
6780 }
Brian Curtineb24d742010-04-12 17:16:38 +00006781
Victor Stinner8c62be82010-05-06 00:08:46 +00006782 CloseHandle(handle);
6783 return result;
Brian Curtineb24d742010-04-12 17:16:38 +00006784}
Larry Hastings2f936352014-08-05 14:04:04 +10006785#endif /* !MS_WINDOWS */
6786#endif /* HAVE_KILL */
6787
6788
6789#ifdef HAVE_KILLPG
6790/*[clinic input]
6791os.killpg
6792
6793 pgid: pid_t
6794 signal: int
6795 /
6796
6797Kill a process group with a signal.
6798[clinic start generated code]*/
6799
Larry Hastings2f936352014-08-05 14:04:04 +10006800static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006801os_killpg_impl(PyObject *module, pid_t pgid, int signal)
6802/*[clinic end generated code: output=6dbcd2f1fdf5fdba input=38b5449eb8faec19]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006803{
6804 /* XXX some man pages make the `pgid` parameter an int, others
6805 a pid_t. Since getpgrp() returns a pid_t, we assume killpg should
6806 take the same type. Moreover, pid_t is always at least as wide as
6807 int (else compilation of this module fails), which is safe. */
6808 if (killpg(pgid, signal) == -1)
6809 return posix_error();
6810 Py_RETURN_NONE;
6811}
6812#endif /* HAVE_KILLPG */
6813
Brian Curtineb24d742010-04-12 17:16:38 +00006814
Guido van Rossumc0125471996-06-28 18:55:32 +00006815#ifdef HAVE_PLOCK
Guido van Rossumc0125471996-06-28 18:55:32 +00006816#ifdef HAVE_SYS_LOCK_H
6817#include <sys/lock.h>
6818#endif
6819
Larry Hastings2f936352014-08-05 14:04:04 +10006820/*[clinic input]
6821os.plock
6822 op: int
6823 /
6824
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00006825Lock program segments into memory.");
Larry Hastings2f936352014-08-05 14:04:04 +10006826[clinic start generated code]*/
6827
Larry Hastings2f936352014-08-05 14:04:04 +10006828static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006829os_plock_impl(PyObject *module, int op)
6830/*[clinic end generated code: output=81424167033b168e input=e6e5e348e1525f60]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006831{
Victor Stinner8c62be82010-05-06 00:08:46 +00006832 if (plock(op) == -1)
6833 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10006834 Py_RETURN_NONE;
Guido van Rossumc0125471996-06-28 18:55:32 +00006835}
Larry Hastings2f936352014-08-05 14:04:04 +10006836#endif /* HAVE_PLOCK */
6837
Guido van Rossumc0125471996-06-28 18:55:32 +00006838
Guido van Rossumb6775db1994-08-01 11:34:53 +00006839#ifdef HAVE_SETUID
Larry Hastings2f936352014-08-05 14:04:04 +10006840/*[clinic input]
6841os.setuid
6842
6843 uid: uid_t
6844 /
6845
6846Set the current process's user id.
6847[clinic start generated code]*/
6848
Larry Hastings2f936352014-08-05 14:04:04 +10006849static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006850os_setuid_impl(PyObject *module, uid_t uid)
6851/*[clinic end generated code: output=a0a41fd0d1ec555f input=c921a3285aa22256]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006852{
Victor Stinner8c62be82010-05-06 00:08:46 +00006853 if (setuid(uid) < 0)
6854 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10006855 Py_RETURN_NONE;
Guido van Rossuma3d78fb1993-11-10 09:23:53 +00006856}
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00006857#endif /* HAVE_SETUID */
Guido van Rossuma3d78fb1993-11-10 09:23:53 +00006858
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006859
Andrew M. Kuchling8d2f2b22000-07-13 01:26:58 +00006860#ifdef HAVE_SETEUID
Larry Hastings2f936352014-08-05 14:04:04 +10006861/*[clinic input]
6862os.seteuid
6863
6864 euid: uid_t
6865 /
6866
6867Set the current process's effective user id.
6868[clinic start generated code]*/
6869
Larry Hastings2f936352014-08-05 14:04:04 +10006870static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006871os_seteuid_impl(PyObject *module, uid_t euid)
6872/*[clinic end generated code: output=102e3ad98361519a input=ba93d927e4781aa9]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006873{
6874 if (seteuid(euid) < 0)
Victor Stinner8c62be82010-05-06 00:08:46 +00006875 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10006876 Py_RETURN_NONE;
Andrew M. Kuchling8d2f2b22000-07-13 01:26:58 +00006877}
6878#endif /* HAVE_SETEUID */
6879
Larry Hastings2f936352014-08-05 14:04:04 +10006880
Andrew M. Kuchling8d2f2b22000-07-13 01:26:58 +00006881#ifdef HAVE_SETEGID
Larry Hastings2f936352014-08-05 14:04:04 +10006882/*[clinic input]
6883os.setegid
6884
6885 egid: gid_t
6886 /
6887
6888Set the current process's effective group id.
6889[clinic start generated code]*/
6890
Larry Hastings2f936352014-08-05 14:04:04 +10006891static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006892os_setegid_impl(PyObject *module, gid_t egid)
6893/*[clinic end generated code: output=4e4b825a6a10258d input=4080526d0ccd6ce3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006894{
6895 if (setegid(egid) < 0)
Victor Stinner8c62be82010-05-06 00:08:46 +00006896 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10006897 Py_RETURN_NONE;
Andrew M. Kuchling8d2f2b22000-07-13 01:26:58 +00006898}
6899#endif /* HAVE_SETEGID */
6900
Larry Hastings2f936352014-08-05 14:04:04 +10006901
Andrew M. Kuchling8d2f2b22000-07-13 01:26:58 +00006902#ifdef HAVE_SETREUID
Larry Hastings2f936352014-08-05 14:04:04 +10006903/*[clinic input]
6904os.setreuid
6905
6906 ruid: uid_t
6907 euid: uid_t
6908 /
6909
6910Set the current process's real and effective user ids.
6911[clinic start generated code]*/
6912
Larry Hastings2f936352014-08-05 14:04:04 +10006913static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006914os_setreuid_impl(PyObject *module, uid_t ruid, uid_t euid)
6915/*[clinic end generated code: output=62d991210006530a input=0ca8978de663880c]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006916{
Victor Stinner8c62be82010-05-06 00:08:46 +00006917 if (setreuid(ruid, euid) < 0) {
6918 return posix_error();
6919 } else {
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02006920 Py_RETURN_NONE;
Victor Stinner8c62be82010-05-06 00:08:46 +00006921 }
Andrew M. Kuchling8d2f2b22000-07-13 01:26:58 +00006922}
6923#endif /* HAVE_SETREUID */
6924
Larry Hastings2f936352014-08-05 14:04:04 +10006925
Andrew M. Kuchling8d2f2b22000-07-13 01:26:58 +00006926#ifdef HAVE_SETREGID
Larry Hastings2f936352014-08-05 14:04:04 +10006927/*[clinic input]
6928os.setregid
6929
6930 rgid: gid_t
6931 egid: gid_t
6932 /
6933
6934Set the current process's real and effective group ids.
6935[clinic start generated code]*/
6936
Larry Hastings2f936352014-08-05 14:04:04 +10006937static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006938os_setregid_impl(PyObject *module, gid_t rgid, gid_t egid)
6939/*[clinic end generated code: output=aa803835cf5342f3 input=c59499f72846db78]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006940{
6941 if (setregid(rgid, egid) < 0)
Victor Stinner8c62be82010-05-06 00:08:46 +00006942 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10006943 Py_RETURN_NONE;
Andrew M. Kuchling8d2f2b22000-07-13 01:26:58 +00006944}
6945#endif /* HAVE_SETREGID */
6946
Larry Hastings2f936352014-08-05 14:04:04 +10006947
Guido van Rossumb6775db1994-08-01 11:34:53 +00006948#ifdef HAVE_SETGID
Larry Hastings2f936352014-08-05 14:04:04 +10006949/*[clinic input]
6950os.setgid
6951 gid: gid_t
6952 /
6953
6954Set the current process's group id.
6955[clinic start generated code]*/
6956
Larry Hastings2f936352014-08-05 14:04:04 +10006957static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006958os_setgid_impl(PyObject *module, gid_t gid)
6959/*[clinic end generated code: output=bdccd7403f6ad8c3 input=27d30c4059045dc6]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006960{
Victor Stinner8c62be82010-05-06 00:08:46 +00006961 if (setgid(gid) < 0)
6962 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10006963 Py_RETURN_NONE;
Guido van Rossuma3d78fb1993-11-10 09:23:53 +00006964}
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00006965#endif /* HAVE_SETGID */
Guido van Rossuma3d78fb1993-11-10 09:23:53 +00006966
Larry Hastings2f936352014-08-05 14:04:04 +10006967
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00006968#ifdef HAVE_SETGROUPS
Larry Hastings2f936352014-08-05 14:04:04 +10006969/*[clinic input]
6970os.setgroups
6971
6972 groups: object
6973 /
6974
6975Set the groups of the current process to list.
6976[clinic start generated code]*/
6977
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00006978static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006979os_setgroups(PyObject *module, PyObject *groups)
6980/*[clinic end generated code: output=3fcb32aad58c5ecd input=fa742ca3daf85a7e]*/
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00006981{
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03006982 Py_ssize_t i, len;
Victor Stinner8c62be82010-05-06 00:08:46 +00006983 gid_t grouplist[MAX_GROUPS];
Tim Peters5aa91602002-01-30 05:46:57 +00006984
Victor Stinner8c62be82010-05-06 00:08:46 +00006985 if (!PySequence_Check(groups)) {
6986 PyErr_SetString(PyExc_TypeError, "setgroups argument must be a sequence");
6987 return NULL;
6988 }
6989 len = PySequence_Size(groups);
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03006990 if (len < 0) {
6991 return NULL;
6992 }
Victor Stinner8c62be82010-05-06 00:08:46 +00006993 if (len > MAX_GROUPS) {
6994 PyErr_SetString(PyExc_ValueError, "too many groups");
6995 return NULL;
6996 }
6997 for(i = 0; i < len; i++) {
6998 PyObject *elem;
6999 elem = PySequence_GetItem(groups, i);
7000 if (!elem)
7001 return NULL;
7002 if (!PyLong_Check(elem)) {
7003 PyErr_SetString(PyExc_TypeError,
7004 "groups must be integers");
7005 Py_DECREF(elem);
7006 return NULL;
7007 } else {
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02007008 if (!_Py_Gid_Converter(elem, &grouplist[i])) {
Victor Stinner8c62be82010-05-06 00:08:46 +00007009 Py_DECREF(elem);
7010 return NULL;
7011 }
7012 }
7013 Py_DECREF(elem);
7014 }
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00007015
Victor Stinner8c62be82010-05-06 00:08:46 +00007016 if (setgroups(len, grouplist) < 0)
7017 return posix_error();
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02007018 Py_RETURN_NONE;
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00007019}
7020#endif /* HAVE_SETGROUPS */
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007021
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007022#if defined(HAVE_WAIT3) || defined(HAVE_WAIT4)
7023static PyObject *
Victor Stinner4195b5c2012-02-08 23:03:19 +01007024wait_helper(pid_t pid, int status, struct rusage *ru)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007025{
Victor Stinner8c62be82010-05-06 00:08:46 +00007026 PyObject *result;
7027 static PyObject *struct_rusage;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02007028 _Py_IDENTIFIER(struct_rusage);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007029
Victor Stinner8c62be82010-05-06 00:08:46 +00007030 if (pid == -1)
7031 return posix_error();
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007032
Victor Stinner8c62be82010-05-06 00:08:46 +00007033 if (struct_rusage == NULL) {
7034 PyObject *m = PyImport_ImportModuleNoBlock("resource");
7035 if (m == NULL)
7036 return NULL;
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02007037 struct_rusage = _PyObject_GetAttrId(m, &PyId_struct_rusage);
Victor Stinner8c62be82010-05-06 00:08:46 +00007038 Py_DECREF(m);
7039 if (struct_rusage == NULL)
7040 return NULL;
7041 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007042
Victor Stinner8c62be82010-05-06 00:08:46 +00007043 /* XXX(nnorwitz): Copied (w/mods) from resource.c, there should be only one. */
7044 result = PyStructSequence_New((PyTypeObject*) struct_rusage);
7045 if (!result)
7046 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007047
7048#ifndef doubletime
7049#define doubletime(TV) ((double)(TV).tv_sec + (TV).tv_usec * 0.000001)
7050#endif
7051
Victor Stinner8c62be82010-05-06 00:08:46 +00007052 PyStructSequence_SET_ITEM(result, 0,
Victor Stinner4195b5c2012-02-08 23:03:19 +01007053 PyFloat_FromDouble(doubletime(ru->ru_utime)));
Victor Stinner8c62be82010-05-06 00:08:46 +00007054 PyStructSequence_SET_ITEM(result, 1,
Victor Stinner4195b5c2012-02-08 23:03:19 +01007055 PyFloat_FromDouble(doubletime(ru->ru_stime)));
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007056#define SET_INT(result, index, value)\
Victor Stinner8c62be82010-05-06 00:08:46 +00007057 PyStructSequence_SET_ITEM(result, index, PyLong_FromLong(value))
7058 SET_INT(result, 2, ru->ru_maxrss);
7059 SET_INT(result, 3, ru->ru_ixrss);
7060 SET_INT(result, 4, ru->ru_idrss);
7061 SET_INT(result, 5, ru->ru_isrss);
7062 SET_INT(result, 6, ru->ru_minflt);
7063 SET_INT(result, 7, ru->ru_majflt);
7064 SET_INT(result, 8, ru->ru_nswap);
7065 SET_INT(result, 9, ru->ru_inblock);
7066 SET_INT(result, 10, ru->ru_oublock);
7067 SET_INT(result, 11, ru->ru_msgsnd);
7068 SET_INT(result, 12, ru->ru_msgrcv);
7069 SET_INT(result, 13, ru->ru_nsignals);
7070 SET_INT(result, 14, ru->ru_nvcsw);
7071 SET_INT(result, 15, ru->ru_nivcsw);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007072#undef SET_INT
7073
Victor Stinner8c62be82010-05-06 00:08:46 +00007074 if (PyErr_Occurred()) {
7075 Py_DECREF(result);
7076 return NULL;
7077 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007078
Victor Stinner8c62be82010-05-06 00:08:46 +00007079 return Py_BuildValue("NiN", PyLong_FromPid(pid), status, result);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007080}
7081#endif /* HAVE_WAIT3 || HAVE_WAIT4 */
7082
Larry Hastings2f936352014-08-05 14:04:04 +10007083
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007084#ifdef HAVE_WAIT3
Larry Hastings2f936352014-08-05 14:04:04 +10007085/*[clinic input]
7086os.wait3
7087
7088 options: int
7089Wait for completion of a child process.
7090
7091Returns a tuple of information about the child process:
7092 (pid, status, rusage)
7093[clinic start generated code]*/
7094
Larry Hastings2f936352014-08-05 14:04:04 +10007095static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007096os_wait3_impl(PyObject *module, int options)
7097/*[clinic end generated code: output=92c3224e6f28217a input=8ac4c56956b61710]*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007098{
Victor Stinner8c62be82010-05-06 00:08:46 +00007099 pid_t pid;
Victor Stinner8c62be82010-05-06 00:08:46 +00007100 struct rusage ru;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007101 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00007102 WAIT_TYPE status;
7103 WAIT_STATUS_INT(status) = 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007104
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007105 do {
7106 Py_BEGIN_ALLOW_THREADS
7107 pid = wait3(&status, options, &ru);
7108 Py_END_ALLOW_THREADS
7109 } while (pid < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
7110 if (pid < 0)
7111 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007112
Victor Stinner4195b5c2012-02-08 23:03:19 +01007113 return wait_helper(pid, WAIT_STATUS_INT(status), &ru);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007114}
7115#endif /* HAVE_WAIT3 */
7116
Larry Hastings2f936352014-08-05 14:04:04 +10007117
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007118#ifdef HAVE_WAIT4
Larry Hastings2f936352014-08-05 14:04:04 +10007119/*[clinic input]
7120
7121os.wait4
7122
7123 pid: pid_t
7124 options: int
7125
7126Wait for completion of a specific child process.
7127
7128Returns a tuple of information about the child process:
7129 (pid, status, rusage)
7130[clinic start generated code]*/
7131
Larry Hastings2f936352014-08-05 14:04:04 +10007132static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007133os_wait4_impl(PyObject *module, pid_t pid, int options)
7134/*[clinic end generated code: output=66195aa507b35f70 input=d11deed0750600ba]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007135{
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007136 pid_t res;
Victor Stinner8c62be82010-05-06 00:08:46 +00007137 struct rusage ru;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007138 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00007139 WAIT_TYPE status;
7140 WAIT_STATUS_INT(status) = 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007141
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007142 do {
7143 Py_BEGIN_ALLOW_THREADS
7144 res = wait4(pid, &status, options, &ru);
7145 Py_END_ALLOW_THREADS
7146 } while (res < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
7147 if (res < 0)
7148 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007149
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007150 return wait_helper(res, WAIT_STATUS_INT(status), &ru);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007151}
7152#endif /* HAVE_WAIT4 */
7153
Larry Hastings2f936352014-08-05 14:04:04 +10007154
Ross Lagerwall7807c352011-03-17 20:20:30 +02007155#if defined(HAVE_WAITID) && !defined(__APPLE__)
Larry Hastings2f936352014-08-05 14:04:04 +10007156/*[clinic input]
7157os.waitid
7158
7159 idtype: idtype_t
7160 Must be one of be P_PID, P_PGID or P_ALL.
7161 id: id_t
7162 The id to wait on.
7163 options: int
7164 Constructed from the ORing of one or more of WEXITED, WSTOPPED
7165 or WCONTINUED and additionally may be ORed with WNOHANG or WNOWAIT.
7166 /
7167
7168Returns the result of waiting for a process or processes.
7169
7170Returns either waitid_result or None if WNOHANG is specified and there are
7171no children in a waitable state.
7172[clinic start generated code]*/
7173
Larry Hastings2f936352014-08-05 14:04:04 +10007174static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007175os_waitid_impl(PyObject *module, idtype_t idtype, id_t id, int options)
7176/*[clinic end generated code: output=5d2e1c0bde61f4d8 input=d8e7f76e052b7920]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007177{
7178 PyObject *result;
7179 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007180 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02007181 siginfo_t si;
7182 si.si_pid = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10007183
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007184 do {
7185 Py_BEGIN_ALLOW_THREADS
7186 res = waitid(idtype, id, &si, options);
7187 Py_END_ALLOW_THREADS
7188 } while (res < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
7189 if (res < 0)
7190 return (!async_err) ? posix_error() : NULL;
Ross Lagerwall7807c352011-03-17 20:20:30 +02007191
7192 if (si.si_pid == 0)
7193 Py_RETURN_NONE;
7194
7195 result = PyStructSequence_New(&WaitidResultType);
7196 if (!result)
7197 return NULL;
7198
7199 PyStructSequence_SET_ITEM(result, 0, PyLong_FromPid(si.si_pid));
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02007200 PyStructSequence_SET_ITEM(result, 1, _PyLong_FromUid(si.si_uid));
Ross Lagerwall7807c352011-03-17 20:20:30 +02007201 PyStructSequence_SET_ITEM(result, 2, PyLong_FromLong((long)(si.si_signo)));
7202 PyStructSequence_SET_ITEM(result, 3, PyLong_FromLong((long)(si.si_status)));
7203 PyStructSequence_SET_ITEM(result, 4, PyLong_FromLong((long)(si.si_code)));
7204 if (PyErr_Occurred()) {
7205 Py_DECREF(result);
7206 return NULL;
7207 }
7208
7209 return result;
7210}
Larry Hastings2f936352014-08-05 14:04:04 +10007211#endif /* defined(HAVE_WAITID) && !defined(__APPLE__) */
Ross Lagerwall7807c352011-03-17 20:20:30 +02007212
Larry Hastings2f936352014-08-05 14:04:04 +10007213
7214#if defined(HAVE_WAITPID)
7215/*[clinic input]
7216os.waitpid
7217 pid: pid_t
7218 options: int
7219 /
7220
7221Wait for completion of a given child process.
7222
7223Returns a tuple of information regarding the child process:
7224 (pid, status)
7225
7226The options argument is ignored on Windows.
7227[clinic start generated code]*/
7228
Larry Hastings2f936352014-08-05 14:04:04 +10007229static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007230os_waitpid_impl(PyObject *module, pid_t pid, int options)
7231/*[clinic end generated code: output=5c37c06887a20270 input=0bf1666b8758fda3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007232{
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007233 pid_t res;
7234 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00007235 WAIT_TYPE status;
7236 WAIT_STATUS_INT(status) = 0;
Guido van Rossum54ecc3d1999-01-27 17:53:11 +00007237
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007238 do {
7239 Py_BEGIN_ALLOW_THREADS
7240 res = waitpid(pid, &status, options);
7241 Py_END_ALLOW_THREADS
7242 } while (res < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
7243 if (res < 0)
7244 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007245
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007246 return Py_BuildValue("Ni", PyLong_FromPid(res), WAIT_STATUS_INT(status));
Guido van Rossum21803b81992-08-09 12:55:27 +00007247}
Tim Petersab034fa2002-02-01 11:27:43 +00007248#elif defined(HAVE_CWAIT)
Tim Petersab034fa2002-02-01 11:27:43 +00007249/* MS C has a variant of waitpid() that's usable for most purposes. */
Larry Hastings2f936352014-08-05 14:04:04 +10007250/*[clinic input]
7251os.waitpid
Benjamin Petersonca470632016-09-06 13:47:26 -07007252 pid: intptr_t
Larry Hastings2f936352014-08-05 14:04:04 +10007253 options: int
7254 /
7255
7256Wait for completion of a given process.
7257
7258Returns a tuple of information regarding the process:
7259 (pid, status << 8)
7260
7261The options argument is ignored on Windows.
7262[clinic start generated code]*/
7263
Larry Hastings2f936352014-08-05 14:04:04 +10007264static PyObject *
Benjamin Petersonca470632016-09-06 13:47:26 -07007265os_waitpid_impl(PyObject *module, intptr_t pid, int options)
Victor Stinner581139c2016-09-06 15:54:20 -07007266/*[clinic end generated code: output=be836b221271d538 input=40f2440c515410f8]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007267{
7268 int status;
Benjamin Petersonca470632016-09-06 13:47:26 -07007269 intptr_t res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007270 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10007271
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007272 do {
7273 Py_BEGIN_ALLOW_THREADS
Steve Dower11f43262016-11-19 18:33:39 -08007274 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007275 res = _cwait(&status, pid, options);
Steve Dower11f43262016-11-19 18:33:39 -08007276 _Py_END_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007277 Py_END_ALLOW_THREADS
7278 } while (res < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Victor Stinnerd3ffd322015-09-15 10:11:03 +02007279 if (res < 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007280 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007281
Victor Stinner8c62be82010-05-06 00:08:46 +00007282 /* shift the status left a byte so this is more like the POSIX waitpid */
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007283 return Py_BuildValue(_Py_PARSE_INTPTR "i", res, status << 8);
Tim Petersab034fa2002-02-01 11:27:43 +00007284}
Larry Hastings2f936352014-08-05 14:04:04 +10007285#endif
7286
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007287
Guido van Rossumad0ee831995-03-01 10:34:45 +00007288#ifdef HAVE_WAIT
Larry Hastings2f936352014-08-05 14:04:04 +10007289/*[clinic input]
7290os.wait
7291
7292Wait for completion of a child process.
7293
7294Returns a tuple of information about the child process:
7295 (pid, status)
7296[clinic start generated code]*/
7297
Larry Hastings2f936352014-08-05 14:04:04 +10007298static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007299os_wait_impl(PyObject *module)
7300/*[clinic end generated code: output=6bc419ac32fb364b input=03b0182d4a4700ce]*/
Guido van Rossum21803b81992-08-09 12:55:27 +00007301{
Victor Stinner8c62be82010-05-06 00:08:46 +00007302 pid_t pid;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007303 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00007304 WAIT_TYPE status;
7305 WAIT_STATUS_INT(status) = 0;
Neal Norwitze241ce82003-02-17 18:17:05 +00007306
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007307 do {
7308 Py_BEGIN_ALLOW_THREADS
7309 pid = wait(&status);
7310 Py_END_ALLOW_THREADS
7311 } while (pid < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
7312 if (pid < 0)
7313 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007314
Victor Stinner8c62be82010-05-06 00:08:46 +00007315 return Py_BuildValue("Ni", PyLong_FromPid(pid), WAIT_STATUS_INT(status));
Guido van Rossum85e3b011991-06-03 12:42:10 +00007316}
Larry Hastings2f936352014-08-05 14:04:04 +10007317#endif /* HAVE_WAIT */
Guido van Rossum85e3b011991-06-03 12:42:10 +00007318
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007319
Larry Hastings9cf065c2012-06-22 16:30:09 -07007320#if defined(HAVE_READLINK) || defined(MS_WINDOWS)
7321PyDoc_STRVAR(readlink__doc__,
7322"readlink(path, *, dir_fd=None) -> path\n\n\
7323Return a string representing the path to which the symbolic link points.\n\
7324\n\
7325If dir_fd is not None, it should be a file descriptor open to a directory,\n\
7326 and path should be relative; path will then be relative to that directory.\n\
7327dir_fd may not be implemented on your platform.\n\
7328 If it is unavailable, using it will raise a NotImplementedError.");
Mark Hammondc2e85bd2002-10-03 05:10:39 +00007329#endif
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007330
Guido van Rossumb6775db1994-08-01 11:34:53 +00007331#ifdef HAVE_READLINK
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007332
Larry Hastings2f936352014-08-05 14:04:04 +10007333/* AC 3.5: merge win32 and not together */
Barry Warsaw53699e91996-12-10 23:23:01 +00007334static PyObject *
Larry Hastings9cf065c2012-06-22 16:30:09 -07007335posix_readlink(PyObject *self, PyObject *args, PyObject *kwargs)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00007336{
Larry Hastings9cf065c2012-06-22 16:30:09 -07007337 path_t path;
7338 int dir_fd = DEFAULT_DIR_FD;
Christian Heimes3cb091e2016-09-23 20:24:28 +02007339 char buffer[MAXPATHLEN+1];
Larry Hastings9cf065c2012-06-22 16:30:09 -07007340 ssize_t length;
7341 PyObject *return_value = NULL;
7342 static char *keywords[] = {"path", "dir_fd", NULL};
Thomas Wouters89f507f2006-12-13 04:49:30 +00007343
Larry Hastings9cf065c2012-06-22 16:30:09 -07007344 memset(&path, 0, sizeof(path));
Victor Stinner292c8352012-10-30 02:17:38 +01007345 path.function_name = "readlink";
Larry Hastings9cf065c2012-06-22 16:30:09 -07007346 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O&|$O&:readlink", keywords,
7347 path_converter, &path,
Larry Hastings2f936352014-08-05 14:04:04 +10007348 READLINKAT_DIR_FD_CONVERTER, &dir_fd))
Victor Stinner8c62be82010-05-06 00:08:46 +00007349 return NULL;
Thomas Wouters89f507f2006-12-13 04:49:30 +00007350
Victor Stinner8c62be82010-05-06 00:08:46 +00007351 Py_BEGIN_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07007352#ifdef HAVE_READLINKAT
7353 if (dir_fd != DEFAULT_DIR_FD)
Christian Heimes3cb091e2016-09-23 20:24:28 +02007354 length = readlinkat(dir_fd, path.narrow, buffer, MAXPATHLEN);
Victor Stinnera45598a2010-05-14 16:35:39 +00007355 else
Larry Hastings9cf065c2012-06-22 16:30:09 -07007356#endif
Christian Heimes3cb091e2016-09-23 20:24:28 +02007357 length = readlink(path.narrow, buffer, MAXPATHLEN);
Larry Hastings9cf065c2012-06-22 16:30:09 -07007358 Py_END_ALLOW_THREADS
7359
7360 if (length < 0) {
Victor Stinner292c8352012-10-30 02:17:38 +01007361 return_value = path_error(&path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07007362 goto exit;
7363 }
Christian Heimes3cb091e2016-09-23 20:24:28 +02007364 buffer[length] = '\0';
Larry Hastings9cf065c2012-06-22 16:30:09 -07007365
7366 if (PyUnicode_Check(path.object))
7367 return_value = PyUnicode_DecodeFSDefaultAndSize(buffer, length);
7368 else
7369 return_value = PyBytes_FromStringAndSize(buffer, length);
7370exit:
7371 path_cleanup(&path);
7372 return return_value;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00007373}
Larry Hastings9cf065c2012-06-22 16:30:09 -07007374
Guido van Rossumb6775db1994-08-01 11:34:53 +00007375#endif /* HAVE_READLINK */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00007376
Larry Hastings2f936352014-08-05 14:04:04 +10007377#if !defined(HAVE_READLINK) && defined(MS_WINDOWS)
7378
7379static PyObject *
7380win_readlink(PyObject *self, PyObject *args, PyObject *kwargs)
7381{
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03007382 const wchar_t *path;
Larry Hastings2f936352014-08-05 14:04:04 +10007383 DWORD n_bytes_returned;
7384 DWORD io_result;
7385 PyObject *po, *result;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03007386 int dir_fd;
Larry Hastings2f936352014-08-05 14:04:04 +10007387 HANDLE reparse_point_handle;
7388
Martin Panter70214ad2016-08-04 02:38:59 +00007389 char target_buffer[_Py_MAXIMUM_REPARSE_DATA_BUFFER_SIZE];
7390 _Py_REPARSE_DATA_BUFFER *rdb = (_Py_REPARSE_DATA_BUFFER *)target_buffer;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03007391 const wchar_t *print_name;
Larry Hastings2f936352014-08-05 14:04:04 +10007392
7393 static char *keywords[] = {"path", "dir_fd", NULL};
7394
7395 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "U|$O&:readlink", keywords,
7396 &po,
7397 dir_fd_unavailable, &dir_fd
7398 ))
7399 return NULL;
7400
Serhiy Storchakaf7eae0a2017-06-28 08:30:06 +03007401 path = _PyUnicode_AsUnicode(po);
Larry Hastings2f936352014-08-05 14:04:04 +10007402 if (path == NULL)
7403 return NULL;
7404
7405 /* First get a handle to the reparse point */
7406 Py_BEGIN_ALLOW_THREADS
7407 reparse_point_handle = CreateFileW(
7408 path,
7409 0,
7410 0,
7411 0,
7412 OPEN_EXISTING,
7413 FILE_FLAG_OPEN_REPARSE_POINT|FILE_FLAG_BACKUP_SEMANTICS,
7414 0);
7415 Py_END_ALLOW_THREADS
7416
7417 if (reparse_point_handle==INVALID_HANDLE_VALUE)
7418 return win32_error_object("readlink", po);
7419
7420 Py_BEGIN_ALLOW_THREADS
7421 /* New call DeviceIoControl to read the reparse point */
7422 io_result = DeviceIoControl(
7423 reparse_point_handle,
7424 FSCTL_GET_REPARSE_POINT,
7425 0, 0, /* in buffer */
7426 target_buffer, sizeof(target_buffer),
7427 &n_bytes_returned,
7428 0 /* we're not using OVERLAPPED_IO */
7429 );
7430 CloseHandle(reparse_point_handle);
7431 Py_END_ALLOW_THREADS
7432
7433 if (io_result==0)
7434 return win32_error_object("readlink", po);
7435
7436 if (rdb->ReparseTag != IO_REPARSE_TAG_SYMLINK)
7437 {
7438 PyErr_SetString(PyExc_ValueError,
7439 "not a symbolic link");
7440 return NULL;
7441 }
7442 print_name = rdb->SymbolicLinkReparseBuffer.PathBuffer +
7443 rdb->SymbolicLinkReparseBuffer.PrintNameOffset;
7444
7445 result = PyUnicode_FromWideChar(print_name,
7446 rdb->SymbolicLinkReparseBuffer.PrintNameLength/2);
7447 return result;
7448}
7449
7450#endif /* !defined(HAVE_READLINK) && defined(MS_WINDOWS) */
7451
7452
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007453
Larry Hastings9cf065c2012-06-22 16:30:09 -07007454#ifdef HAVE_SYMLINK
Larry Hastings9cf065c2012-06-22 16:30:09 -07007455
7456#if defined(MS_WINDOWS)
7457
7458/* Grab CreateSymbolicLinkW dynamically from kernel32 */
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03007459static DWORD (CALLBACK *Py_CreateSymbolicLinkW)(LPCWSTR, LPCWSTR, DWORD) = NULL;
Victor Stinner31b3b922013-06-05 01:49:17 +02007460
Larry Hastings9cf065c2012-06-22 16:30:09 -07007461static int
Victor Stinner31b3b922013-06-05 01:49:17 +02007462check_CreateSymbolicLink(void)
Larry Hastings9cf065c2012-06-22 16:30:09 -07007463{
7464 HINSTANCE hKernel32;
7465 /* only recheck */
Steve Dowercc16be82016-09-08 10:35:16 -07007466 if (Py_CreateSymbolicLinkW)
Larry Hastings9cf065c2012-06-22 16:30:09 -07007467 return 1;
7468 hKernel32 = GetModuleHandleW(L"KERNEL32");
7469 *(FARPROC*)&Py_CreateSymbolicLinkW = GetProcAddress(hKernel32,
7470 "CreateSymbolicLinkW");
Steve Dowercc16be82016-09-08 10:35:16 -07007471 return Py_CreateSymbolicLinkW != NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07007472}
7473
Victor Stinner31b3b922013-06-05 01:49:17 +02007474/* Remove the last portion of the path */
7475static void
7476_dirnameW(WCHAR *path)
7477{
Jason R. Coombs3a092862013-05-27 23:21:28 -04007478 WCHAR *ptr;
7479
7480 /* walk the path from the end until a backslash is encountered */
Victor Stinner31b3b922013-06-05 01:49:17 +02007481 for(ptr = path + wcslen(path); ptr != path; ptr--) {
Victor Stinner072318b2013-06-05 02:07:46 +02007482 if (*ptr == L'\\' || *ptr == L'/')
Jason R. Coombs3a092862013-05-27 23:21:28 -04007483 break;
Jason R. Coombs3a092862013-05-27 23:21:28 -04007484 }
7485 *ptr = 0;
7486}
7487
Victor Stinner31b3b922013-06-05 01:49:17 +02007488/* Is this path absolute? */
7489static int
7490_is_absW(const WCHAR *path)
7491{
Jason R. Coombs3a092862013-05-27 23:21:28 -04007492 return path[0] == L'\\' || path[0] == L'/' || path[1] == L':';
7493
7494}
7495
Victor Stinner31b3b922013-06-05 01:49:17 +02007496/* join root and rest with a backslash */
7497static void
7498_joinW(WCHAR *dest_path, const WCHAR *root, const WCHAR *rest)
7499{
Victor Stinnere7e7eba2013-06-05 00:35:54 +02007500 size_t root_len;
Jason R. Coombs3a092862013-05-27 23:21:28 -04007501
Victor Stinner31b3b922013-06-05 01:49:17 +02007502 if (_is_absW(rest)) {
Jason R. Coombs3a092862013-05-27 23:21:28 -04007503 wcscpy(dest_path, rest);
7504 return;
7505 }
7506
7507 root_len = wcslen(root);
7508
7509 wcscpy(dest_path, root);
7510 if(root_len) {
Victor Stinner31b3b922013-06-05 01:49:17 +02007511 dest_path[root_len] = L'\\';
7512 root_len++;
Jason R. Coombs3a092862013-05-27 23:21:28 -04007513 }
7514 wcscpy(dest_path+root_len, rest);
7515}
7516
Victor Stinner31b3b922013-06-05 01:49:17 +02007517/* Return True if the path at src relative to dest is a directory */
7518static int
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03007519_check_dirW(LPCWSTR src, LPCWSTR dest)
Jason R. Coombs3a092862013-05-27 23:21:28 -04007520{
Jason R. Coombs3a092862013-05-27 23:21:28 -04007521 WIN32_FILE_ATTRIBUTE_DATA src_info;
7522 WCHAR dest_parent[MAX_PATH];
7523 WCHAR src_resolved[MAX_PATH] = L"";
7524
7525 /* dest_parent = os.path.dirname(dest) */
7526 wcscpy(dest_parent, dest);
7527 _dirnameW(dest_parent);
7528 /* src_resolved = os.path.join(dest_parent, src) */
7529 _joinW(src_resolved, dest_parent, src);
7530 return (
7531 GetFileAttributesExW(src_resolved, GetFileExInfoStandard, &src_info)
7532 && src_info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY
7533 );
7534}
Larry Hastings9cf065c2012-06-22 16:30:09 -07007535#endif
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007536
Larry Hastings2f936352014-08-05 14:04:04 +10007537
7538/*[clinic input]
7539os.symlink
7540 src: path_t
7541 dst: path_t
7542 target_is_directory: bool = False
7543 *
7544 dir_fd: dir_fd(requires='symlinkat')=None
7545
7546# "symlink(src, dst, target_is_directory=False, *, dir_fd=None)\n\n\
7547
7548Create a symbolic link pointing to src named dst.
7549
7550target_is_directory is required on Windows if the target is to be
7551 interpreted as a directory. (On Windows, symlink requires
7552 Windows 6.0 or greater, and raises a NotImplementedError otherwise.)
7553 target_is_directory is ignored on non-Windows platforms.
7554
7555If dir_fd is not None, it should be a file descriptor open to a directory,
7556 and path should be relative; path will then be relative to that directory.
7557dir_fd may not be implemented on your platform.
7558 If it is unavailable, using it will raise a NotImplementedError.
7559
7560[clinic start generated code]*/
7561
Larry Hastings2f936352014-08-05 14:04:04 +10007562static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007563os_symlink_impl(PyObject *module, path_t *src, path_t *dst,
Larry Hastings89964c42015-04-14 18:07:59 -04007564 int target_is_directory, int dir_fd)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007565/*[clinic end generated code: output=08ca9f3f3cf960f6 input=e820ec4472547bc3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007566{
Larry Hastings9cf065c2012-06-22 16:30:09 -07007567#ifdef MS_WINDOWS
7568 DWORD result;
7569#else
7570 int result;
7571#endif
7572
Larry Hastings9cf065c2012-06-22 16:30:09 -07007573#ifdef MS_WINDOWS
7574 if (!check_CreateSymbolicLink()) {
7575 PyErr_SetString(PyExc_NotImplementedError,
7576 "CreateSymbolicLink functions not found");
Larry Hastings2f936352014-08-05 14:04:04 +10007577 return NULL;
Petri Lehtinen5445a8c2012-10-23 16:12:14 +03007578 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07007579 if (!win32_can_symlink) {
7580 PyErr_SetString(PyExc_OSError, "symbolic link privilege not held");
Larry Hastings2f936352014-08-05 14:04:04 +10007581 return NULL;
Petri Lehtinen5445a8c2012-10-23 16:12:14 +03007582 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07007583#endif
7584
Larry Hastings2f936352014-08-05 14:04:04 +10007585 if ((src->narrow && dst->wide) || (src->wide && dst->narrow)) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07007586 PyErr_SetString(PyExc_ValueError,
7587 "symlink: src and dst must be the same type");
Larry Hastings2f936352014-08-05 14:04:04 +10007588 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07007589 }
7590
7591#ifdef MS_WINDOWS
Jason R. Coombs3a092862013-05-27 23:21:28 -04007592
Larry Hastings9cf065c2012-06-22 16:30:09 -07007593 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07007594 /* if src is a directory, ensure target_is_directory==1 */
7595 target_is_directory |= _check_dirW(src->wide, dst->wide);
7596 result = Py_CreateSymbolicLinkW(dst->wide, src->wide,
7597 target_is_directory);
Larry Hastings9cf065c2012-06-22 16:30:09 -07007598 Py_END_ALLOW_THREADS
7599
Larry Hastings2f936352014-08-05 14:04:04 +10007600 if (!result)
7601 return path_error2(src, dst);
Larry Hastings9cf065c2012-06-22 16:30:09 -07007602
7603#else
7604
7605 Py_BEGIN_ALLOW_THREADS
7606#if HAVE_SYMLINKAT
7607 if (dir_fd != DEFAULT_DIR_FD)
Larry Hastings2f936352014-08-05 14:04:04 +10007608 result = symlinkat(src->narrow, dir_fd, dst->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07007609 else
7610#endif
Larry Hastings2f936352014-08-05 14:04:04 +10007611 result = symlink(src->narrow, dst->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07007612 Py_END_ALLOW_THREADS
7613
Larry Hastings2f936352014-08-05 14:04:04 +10007614 if (result)
7615 return path_error2(src, dst);
Larry Hastings9cf065c2012-06-22 16:30:09 -07007616#endif
7617
Larry Hastings2f936352014-08-05 14:04:04 +10007618 Py_RETURN_NONE;
Guido van Rossumbfaf3d61997-12-29 20:02:27 +00007619}
7620#endif /* HAVE_SYMLINK */
7621
Larry Hastings9cf065c2012-06-22 16:30:09 -07007622
Brian Curtind40e6f72010-07-08 21:39:08 +00007623
Guido van Rossumbfaf3d61997-12-29 20:02:27 +00007624
Larry Hastings605a62d2012-06-24 04:33:36 -07007625static PyStructSequence_Field times_result_fields[] = {
7626 {"user", "user time"},
7627 {"system", "system time"},
7628 {"children_user", "user time of children"},
7629 {"children_system", "system time of children"},
7630 {"elapsed", "elapsed time since an arbitrary point in the past"},
7631 {NULL}
7632};
7633
7634PyDoc_STRVAR(times_result__doc__,
7635"times_result: Result from os.times().\n\n\
7636This object may be accessed either as a tuple of\n\
7637 (user, system, children_user, children_system, elapsed),\n\
7638or via the attributes user, system, children_user, children_system,\n\
7639and elapsed.\n\
7640\n\
7641See os.times for more information.");
7642
7643static PyStructSequence_Desc times_result_desc = {
7644 "times_result", /* name */
7645 times_result__doc__, /* doc */
7646 times_result_fields,
7647 5
7648};
7649
7650static PyTypeObject TimesResultType;
7651
Antoine Pitrouf3923e92012-07-24 21:23:53 +02007652#ifdef MS_WINDOWS
7653#define HAVE_TIMES /* mandatory, for the method table */
7654#endif
Larry Hastings605a62d2012-06-24 04:33:36 -07007655
Antoine Pitrouf3923e92012-07-24 21:23:53 +02007656#ifdef HAVE_TIMES
Larry Hastings605a62d2012-06-24 04:33:36 -07007657
7658static PyObject *
7659build_times_result(double user, double system,
7660 double children_user, double children_system,
7661 double elapsed)
7662{
7663 PyObject *value = PyStructSequence_New(&TimesResultType);
7664 if (value == NULL)
7665 return NULL;
7666
7667#define SET(i, field) \
7668 { \
7669 PyObject *o = PyFloat_FromDouble(field); \
7670 if (!o) { \
7671 Py_DECREF(value); \
7672 return NULL; \
7673 } \
7674 PyStructSequence_SET_ITEM(value, i, o); \
7675 } \
7676
7677 SET(0, user);
7678 SET(1, system);
7679 SET(2, children_user);
7680 SET(3, children_system);
7681 SET(4, elapsed);
7682
7683#undef SET
7684
7685 return value;
7686}
7687
Larry Hastings605a62d2012-06-24 04:33:36 -07007688
Larry Hastings2f936352014-08-05 14:04:04 +10007689#ifndef MS_WINDOWS
7690#define NEED_TICKS_PER_SECOND
7691static long ticks_per_second = -1;
7692#endif /* MS_WINDOWS */
7693
7694/*[clinic input]
7695os.times
7696
7697Return a collection containing process timing information.
7698
7699The object returned behaves like a named tuple with these fields:
7700 (utime, stime, cutime, cstime, elapsed_time)
7701All fields are floating point numbers.
7702[clinic start generated code]*/
7703
Larry Hastings2f936352014-08-05 14:04:04 +10007704static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007705os_times_impl(PyObject *module)
7706/*[clinic end generated code: output=35f640503557d32a input=2bf9df3d6ab2e48b]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007707#ifdef MS_WINDOWS
Guido van Rossum14ed0b21994-09-29 09:50:09 +00007708{
Victor Stinner8c62be82010-05-06 00:08:46 +00007709 FILETIME create, exit, kernel, user;
7710 HANDLE hProc;
7711 hProc = GetCurrentProcess();
7712 GetProcessTimes(hProc, &create, &exit, &kernel, &user);
7713 /* The fields of a FILETIME structure are the hi and lo part
7714 of a 64-bit value expressed in 100 nanosecond units.
7715 1e7 is one second in such units; 1e-7 the inverse.
7716 429.4967296 is 2**32 / 1e7 or 2**32 * 1e-7.
7717 */
Larry Hastings605a62d2012-06-24 04:33:36 -07007718 return build_times_result(
Victor Stinner8c62be82010-05-06 00:08:46 +00007719 (double)(user.dwHighDateTime*429.4967296 +
7720 user.dwLowDateTime*1e-7),
7721 (double)(kernel.dwHighDateTime*429.4967296 +
7722 kernel.dwLowDateTime*1e-7),
7723 (double)0,
7724 (double)0,
7725 (double)0);
Guido van Rossum14ed0b21994-09-29 09:50:09 +00007726}
Larry Hastings2f936352014-08-05 14:04:04 +10007727#else /* MS_WINDOWS */
Antoine Pitrouf3923e92012-07-24 21:23:53 +02007728{
Larry Hastings2f936352014-08-05 14:04:04 +10007729
7730
Antoine Pitrouf3923e92012-07-24 21:23:53 +02007731 struct tms t;
7732 clock_t c;
7733 errno = 0;
7734 c = times(&t);
7735 if (c == (clock_t) -1)
7736 return posix_error();
7737 return build_times_result(
7738 (double)t.tms_utime / ticks_per_second,
7739 (double)t.tms_stime / ticks_per_second,
7740 (double)t.tms_cutime / ticks_per_second,
7741 (double)t.tms_cstime / ticks_per_second,
7742 (double)c / ticks_per_second);
7743}
Larry Hastings2f936352014-08-05 14:04:04 +10007744#endif /* MS_WINDOWS */
Antoine Pitrouf3923e92012-07-24 21:23:53 +02007745#endif /* HAVE_TIMES */
7746
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007747
Martin v. Löwis49ee14d2003-11-10 06:35:36 +00007748#ifdef HAVE_GETSID
Larry Hastings2f936352014-08-05 14:04:04 +10007749/*[clinic input]
7750os.getsid
7751
7752 pid: pid_t
7753 /
7754
7755Call the system call getsid(pid) and return the result.
7756[clinic start generated code]*/
7757
Larry Hastings2f936352014-08-05 14:04:04 +10007758static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007759os_getsid_impl(PyObject *module, pid_t pid)
7760/*[clinic end generated code: output=112deae56b306460 input=eeb2b923a30ce04e]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007761{
Victor Stinner8c62be82010-05-06 00:08:46 +00007762 int sid;
Victor Stinner8c62be82010-05-06 00:08:46 +00007763 sid = getsid(pid);
7764 if (sid < 0)
7765 return posix_error();
7766 return PyLong_FromLong((long)sid);
Martin v. Löwis49ee14d2003-11-10 06:35:36 +00007767}
7768#endif /* HAVE_GETSID */
7769
7770
Guido van Rossumb6775db1994-08-01 11:34:53 +00007771#ifdef HAVE_SETSID
Larry Hastings2f936352014-08-05 14:04:04 +10007772/*[clinic input]
7773os.setsid
7774
7775Call the system call setsid().
7776[clinic start generated code]*/
7777
Larry Hastings2f936352014-08-05 14:04:04 +10007778static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007779os_setsid_impl(PyObject *module)
7780/*[clinic end generated code: output=e2ddedd517086d77 input=5fff45858e2f0776]*/
Guido van Rossumc2670a01992-09-13 20:07:29 +00007781{
Victor Stinner8c62be82010-05-06 00:08:46 +00007782 if (setsid() < 0)
7783 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007784 Py_RETURN_NONE;
Guido van Rossumc2670a01992-09-13 20:07:29 +00007785}
Guido van Rossumb6775db1994-08-01 11:34:53 +00007786#endif /* HAVE_SETSID */
Guido van Rossumc2670a01992-09-13 20:07:29 +00007787
Larry Hastings2f936352014-08-05 14:04:04 +10007788
Guido van Rossumb6775db1994-08-01 11:34:53 +00007789#ifdef HAVE_SETPGID
Larry Hastings2f936352014-08-05 14:04:04 +10007790/*[clinic input]
7791os.setpgid
7792
7793 pid: pid_t
7794 pgrp: pid_t
7795 /
7796
7797Call the system call setpgid(pid, pgrp).
7798[clinic start generated code]*/
7799
Larry Hastings2f936352014-08-05 14:04:04 +10007800static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007801os_setpgid_impl(PyObject *module, pid_t pid, pid_t pgrp)
7802/*[clinic end generated code: output=6461160319a43d6a input=fceb395eca572e1a]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007803{
Victor Stinner8c62be82010-05-06 00:08:46 +00007804 if (setpgid(pid, pgrp) < 0)
7805 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007806 Py_RETURN_NONE;
Guido van Rossumc2670a01992-09-13 20:07:29 +00007807}
Guido van Rossumb6775db1994-08-01 11:34:53 +00007808#endif /* HAVE_SETPGID */
Guido van Rossumc2670a01992-09-13 20:07:29 +00007809
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007810
Guido van Rossumb6775db1994-08-01 11:34:53 +00007811#ifdef HAVE_TCGETPGRP
Larry Hastings2f936352014-08-05 14:04:04 +10007812/*[clinic input]
7813os.tcgetpgrp
7814
7815 fd: int
7816 /
7817
7818Return the process group associated with the terminal specified by fd.
7819[clinic start generated code]*/
7820
Larry Hastings2f936352014-08-05 14:04:04 +10007821static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007822os_tcgetpgrp_impl(PyObject *module, int fd)
7823/*[clinic end generated code: output=f865e88be86c272b input=7f6c18eac10ada86]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007824{
7825 pid_t pgid = tcgetpgrp(fd);
Victor Stinner8c62be82010-05-06 00:08:46 +00007826 if (pgid < 0)
7827 return posix_error();
7828 return PyLong_FromPid(pgid);
Guido van Rossum7066dd71992-09-17 17:54:56 +00007829}
Guido van Rossumb6775db1994-08-01 11:34:53 +00007830#endif /* HAVE_TCGETPGRP */
Guido van Rossum7066dd71992-09-17 17:54:56 +00007831
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007832
Guido van Rossumb6775db1994-08-01 11:34:53 +00007833#ifdef HAVE_TCSETPGRP
Larry Hastings2f936352014-08-05 14:04:04 +10007834/*[clinic input]
7835os.tcsetpgrp
7836
7837 fd: int
7838 pgid: pid_t
7839 /
7840
7841Set the process group associated with the terminal specified by fd.
7842[clinic start generated code]*/
7843
Larry Hastings2f936352014-08-05 14:04:04 +10007844static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007845os_tcsetpgrp_impl(PyObject *module, int fd, pid_t pgid)
7846/*[clinic end generated code: output=f1821a381b9daa39 input=5bdc997c6a619020]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007847{
Victor Stinner8c62be82010-05-06 00:08:46 +00007848 if (tcsetpgrp(fd, pgid) < 0)
7849 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007850 Py_RETURN_NONE;
Guido van Rossum7066dd71992-09-17 17:54:56 +00007851}
Guido van Rossumb6775db1994-08-01 11:34:53 +00007852#endif /* HAVE_TCSETPGRP */
Guido van Rossum22db57e1992-04-05 14:25:30 +00007853
Guido van Rossum687dd131993-05-17 08:34:16 +00007854/* Functions acting on file descriptors */
7855
Victor Stinnerdaf45552013-08-28 00:53:59 +02007856#ifdef O_CLOEXEC
7857extern int _Py_open_cloexec_works;
7858#endif
7859
Larry Hastings2f936352014-08-05 14:04:04 +10007860
7861/*[clinic input]
7862os.open -> int
7863 path: path_t
7864 flags: int
7865 mode: int = 0o777
7866 *
7867 dir_fd: dir_fd(requires='openat') = None
7868
7869# "open(path, flags, mode=0o777, *, dir_fd=None)\n\n\
7870
7871Open a file for low level IO. Returns a file descriptor (integer).
7872
7873If dir_fd is not None, it should be a file descriptor open to a directory,
7874 and path should be relative; path will then be relative to that directory.
7875dir_fd may not be implemented on your platform.
7876 If it is unavailable, using it will raise a NotImplementedError.
7877[clinic start generated code]*/
7878
Larry Hastings2f936352014-08-05 14:04:04 +10007879static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007880os_open_impl(PyObject *module, path_t *path, int flags, int mode, int dir_fd)
7881/*[clinic end generated code: output=abc7227888c8bc73 input=ad8623b29acd2934]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007882{
7883 int fd;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007884 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10007885
Victor Stinnerdaf45552013-08-28 00:53:59 +02007886#ifdef O_CLOEXEC
7887 int *atomic_flag_works = &_Py_open_cloexec_works;
7888#elif !defined(MS_WINDOWS)
7889 int *atomic_flag_works = NULL;
7890#endif
Mark Hammondc2e85bd2002-10-03 05:10:39 +00007891
Victor Stinnerdaf45552013-08-28 00:53:59 +02007892#ifdef MS_WINDOWS
7893 flags |= O_NOINHERIT;
7894#elif defined(O_CLOEXEC)
7895 flags |= O_CLOEXEC;
7896#endif
7897
Steve Dower8fc89802015-04-12 00:26:27 -04007898 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007899 do {
7900 Py_BEGIN_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07007901#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07007902 fd = _wopen(path->wide, flags, mode);
Steve Dower6230aaf2016-09-09 09:03:15 -07007903#else
Larry Hastings9cf065c2012-06-22 16:30:09 -07007904#ifdef HAVE_OPENAT
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007905 if (dir_fd != DEFAULT_DIR_FD)
7906 fd = openat(dir_fd, path->narrow, flags, mode);
7907 else
Steve Dower6230aaf2016-09-09 09:03:15 -07007908#endif /* HAVE_OPENAT */
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007909 fd = open(path->narrow, flags, mode);
Steve Dower6230aaf2016-09-09 09:03:15 -07007910#endif /* !MS_WINDOWS */
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007911 Py_END_ALLOW_THREADS
7912 } while (fd < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Steve Dower8fc89802015-04-12 00:26:27 -04007913 _Py_END_SUPPRESS_IPH
Guido van Rossum687dd131993-05-17 08:34:16 +00007914
Victor Stinnerd3ffd322015-09-15 10:11:03 +02007915 if (fd < 0) {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007916 if (!async_err)
7917 PyErr_SetFromErrnoWithFilenameObject(PyExc_OSError, path->object);
Larry Hastings2f936352014-08-05 14:04:04 +10007918 return -1;
Larry Hastings9cf065c2012-06-22 16:30:09 -07007919 }
7920
Victor Stinnerdaf45552013-08-28 00:53:59 +02007921#ifndef MS_WINDOWS
7922 if (_Py_set_inheritable(fd, 0, atomic_flag_works) < 0) {
7923 close(fd);
Larry Hastings2f936352014-08-05 14:04:04 +10007924 return -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +02007925 }
7926#endif
7927
Larry Hastings2f936352014-08-05 14:04:04 +10007928 return fd;
7929}
7930
7931
7932/*[clinic input]
7933os.close
7934
7935 fd: int
7936
7937Close a file descriptor.
7938[clinic start generated code]*/
7939
Barry Warsaw53699e91996-12-10 23:23:01 +00007940static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007941os_close_impl(PyObject *module, int fd)
7942/*[clinic end generated code: output=2fe4e93602822c14 input=2bc42451ca5c3223]*/
Guido van Rossum687dd131993-05-17 08:34:16 +00007943{
Larry Hastings2f936352014-08-05 14:04:04 +10007944 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007945 /* We do not want to retry upon EINTR: see http://lwn.net/Articles/576478/
7946 * and http://linux.derkeiler.com/Mailing-Lists/Kernel/2005-09/3000.html
7947 * for more details.
7948 */
Victor Stinner8c62be82010-05-06 00:08:46 +00007949 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04007950 _Py_BEGIN_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00007951 res = close(fd);
Steve Dower8fc89802015-04-12 00:26:27 -04007952 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00007953 Py_END_ALLOW_THREADS
7954 if (res < 0)
7955 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007956 Py_RETURN_NONE;
Guido van Rossum687dd131993-05-17 08:34:16 +00007957}
7958
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007959
Larry Hastings2f936352014-08-05 14:04:04 +10007960/*[clinic input]
7961os.closerange
7962
7963 fd_low: int
7964 fd_high: int
7965 /
7966
7967Closes all file descriptors in [fd_low, fd_high), ignoring errors.
7968[clinic start generated code]*/
7969
Larry Hastings2f936352014-08-05 14:04:04 +10007970static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007971os_closerange_impl(PyObject *module, int fd_low, int fd_high)
7972/*[clinic end generated code: output=0ce5c20fcda681c2 input=5855a3d053ebd4ec]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007973{
7974 int i;
Victor Stinner8c62be82010-05-06 00:08:46 +00007975 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04007976 _Py_BEGIN_SUPPRESS_IPH
Benjamin Peterson207116b2016-09-08 11:28:06 -07007977 for (i = Py_MAX(fd_low, 0); i < fd_high; i++)
Steve Dower940f33a2016-09-08 11:21:54 -07007978 close(i);
Steve Dower8fc89802015-04-12 00:26:27 -04007979 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00007980 Py_END_ALLOW_THREADS
7981 Py_RETURN_NONE;
Christian Heimesfdab48e2008-01-20 09:06:41 +00007982}
7983
7984
Larry Hastings2f936352014-08-05 14:04:04 +10007985/*[clinic input]
7986os.dup -> int
7987
7988 fd: int
7989 /
7990
7991Return a duplicate of a file descriptor.
7992[clinic start generated code]*/
7993
Larry Hastings2f936352014-08-05 14:04:04 +10007994static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007995os_dup_impl(PyObject *module, int fd)
7996/*[clinic end generated code: output=486f4860636b2a9f input=6f10f7ea97f7852a]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007997{
7998 return _Py_dup(fd);
Guido van Rossum687dd131993-05-17 08:34:16 +00007999}
8000
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008001
Larry Hastings2f936352014-08-05 14:04:04 +10008002/*[clinic input]
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008003os.dup2 -> int
Larry Hastings2f936352014-08-05 14:04:04 +10008004 fd: int
8005 fd2: int
8006 inheritable: bool=True
8007
8008Duplicate file descriptor.
8009[clinic start generated code]*/
8010
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008011static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008012os_dup2_impl(PyObject *module, int fd, int fd2, int inheritable)
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008013/*[clinic end generated code: output=bc059d34a73404d1 input=c3cddda8922b038d]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008014{
Stéphane Wirtel3d86e482018-01-30 07:04:36 +01008015 int res = 0;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008016#if defined(HAVE_DUP3) && \
8017 !(defined(HAVE_FCNTL_H) && defined(F_DUP2FD_CLOEXEC))
8018 /* dup3() is available on Linux 2.6.27+ and glibc 2.9 */
8019 int dup3_works = -1;
8020#endif
8021
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008022 if (fd < 0 || fd2 < 0) {
8023 posix_error();
8024 return -1;
8025 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02008026
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008027 /* dup2() can fail with EINTR if the target FD is already open, because it
8028 * then has to be closed. See os_close_impl() for why we don't handle EINTR
8029 * upon close(), and therefore below.
8030 */
Victor Stinnerdaf45552013-08-28 00:53:59 +02008031#ifdef MS_WINDOWS
8032 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04008033 _Py_BEGIN_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00008034 res = dup2(fd, fd2);
Steve Dower8fc89802015-04-12 00:26:27 -04008035 _Py_END_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02008036 Py_END_ALLOW_THREADS
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008037 if (res < 0) {
8038 posix_error();
8039 return -1;
8040 }
8041 res = fd2; // msvcrt dup2 returns 0 on success.
Victor Stinnerdaf45552013-08-28 00:53:59 +02008042
8043 /* Character files like console cannot be make non-inheritable */
8044 if (!inheritable && _Py_set_inheritable(fd2, 0, NULL) < 0) {
8045 close(fd2);
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008046 return -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008047 }
8048
8049#elif defined(HAVE_FCNTL_H) && defined(F_DUP2FD_CLOEXEC)
8050 Py_BEGIN_ALLOW_THREADS
8051 if (!inheritable)
8052 res = fcntl(fd, F_DUP2FD_CLOEXEC, fd2);
8053 else
8054 res = dup2(fd, fd2);
8055 Py_END_ALLOW_THREADS
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008056 if (res < 0) {
8057 posix_error();
8058 return -1;
8059 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02008060
8061#else
8062
8063#ifdef HAVE_DUP3
8064 if (!inheritable && dup3_works != 0) {
8065 Py_BEGIN_ALLOW_THREADS
8066 res = dup3(fd, fd2, O_CLOEXEC);
8067 Py_END_ALLOW_THREADS
8068 if (res < 0) {
8069 if (dup3_works == -1)
8070 dup3_works = (errno != ENOSYS);
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008071 if (dup3_works) {
8072 posix_error();
8073 return -1;
8074 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02008075 }
8076 }
8077
8078 if (inheritable || dup3_works == 0)
8079 {
8080#endif
8081 Py_BEGIN_ALLOW_THREADS
8082 res = dup2(fd, fd2);
8083 Py_END_ALLOW_THREADS
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008084 if (res < 0) {
8085 posix_error();
8086 return -1;
8087 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02008088
8089 if (!inheritable && _Py_set_inheritable(fd2, 0, NULL) < 0) {
8090 close(fd2);
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008091 return -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008092 }
8093#ifdef HAVE_DUP3
8094 }
8095#endif
8096
8097#endif
8098
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008099 return res;
Guido van Rossum687dd131993-05-17 08:34:16 +00008100}
8101
Larry Hastings2f936352014-08-05 14:04:04 +10008102
Ross Lagerwall7807c352011-03-17 20:20:30 +02008103#ifdef HAVE_LOCKF
Larry Hastings2f936352014-08-05 14:04:04 +10008104/*[clinic input]
8105os.lockf
8106
8107 fd: int
8108 An open file descriptor.
8109 command: int
8110 One of F_LOCK, F_TLOCK, F_ULOCK or F_TEST.
8111 length: Py_off_t
8112 The number of bytes to lock, starting at the current position.
8113 /
8114
8115Apply, test or remove a POSIX lock on an open file descriptor.
8116
8117[clinic start generated code]*/
8118
Larry Hastings2f936352014-08-05 14:04:04 +10008119static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008120os_lockf_impl(PyObject *module, int fd, int command, Py_off_t length)
8121/*[clinic end generated code: output=af7051f3e7c29651 input=65da41d2106e9b79]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008122{
8123 int res;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008124
8125 Py_BEGIN_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10008126 res = lockf(fd, command, length);
Ross Lagerwall7807c352011-03-17 20:20:30 +02008127 Py_END_ALLOW_THREADS
8128
8129 if (res < 0)
8130 return posix_error();
8131
8132 Py_RETURN_NONE;
8133}
Larry Hastings2f936352014-08-05 14:04:04 +10008134#endif /* HAVE_LOCKF */
Ross Lagerwall7807c352011-03-17 20:20:30 +02008135
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008136
Larry Hastings2f936352014-08-05 14:04:04 +10008137/*[clinic input]
8138os.lseek -> Py_off_t
8139
8140 fd: int
8141 position: Py_off_t
8142 how: int
8143 /
8144
8145Set the position of a file descriptor. Return the new position.
8146
8147Return the new cursor position in number of bytes
8148relative to the beginning of the file.
8149[clinic start generated code]*/
8150
Larry Hastings2f936352014-08-05 14:04:04 +10008151static Py_off_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008152os_lseek_impl(PyObject *module, int fd, Py_off_t position, int how)
8153/*[clinic end generated code: output=971e1efb6b30bd2f input=902654ad3f96a6d3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008154{
8155 Py_off_t result;
8156
Guido van Rossum687dd131993-05-17 08:34:16 +00008157#ifdef SEEK_SET
Victor Stinner8c62be82010-05-06 00:08:46 +00008158 /* Turn 0, 1, 2 into SEEK_{SET,CUR,END} */
8159 switch (how) {
Larry Hastings2f936352014-08-05 14:04:04 +10008160 case 0: how = SEEK_SET; break;
8161 case 1: how = SEEK_CUR; break;
8162 case 2: how = SEEK_END; break;
Victor Stinner8c62be82010-05-06 00:08:46 +00008163 }
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00008164#endif /* SEEK_END */
Guido van Rossum94f6f721999-01-06 18:42:14 +00008165
Victor Stinner8c62be82010-05-06 00:08:46 +00008166 if (PyErr_Occurred())
Larry Hastings2f936352014-08-05 14:04:04 +10008167 return -1;
Guido van Rossum94f6f721999-01-06 18:42:14 +00008168
Victor Stinner8c62be82010-05-06 00:08:46 +00008169 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04008170 _Py_BEGIN_SUPPRESS_IPH
Victor Stinner14b9b112013-06-25 00:37:25 +02008171#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10008172 result = _lseeki64(fd, position, how);
Fred Drake699f3522000-06-29 21:12:41 +00008173#else
Larry Hastings2f936352014-08-05 14:04:04 +10008174 result = lseek(fd, position, how);
Fred Drake699f3522000-06-29 21:12:41 +00008175#endif
Steve Dower8fc89802015-04-12 00:26:27 -04008176 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00008177 Py_END_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10008178 if (result < 0)
8179 posix_error();
Guido van Rossum94f6f721999-01-06 18:42:14 +00008180
Larry Hastings2f936352014-08-05 14:04:04 +10008181 return result;
Guido van Rossum687dd131993-05-17 08:34:16 +00008182}
8183
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008184
Larry Hastings2f936352014-08-05 14:04:04 +10008185/*[clinic input]
8186os.read
8187 fd: int
8188 length: Py_ssize_t
8189 /
8190
8191Read from a file descriptor. Returns a bytes object.
8192[clinic start generated code]*/
8193
Larry Hastings2f936352014-08-05 14:04:04 +10008194static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008195os_read_impl(PyObject *module, int fd, Py_ssize_t length)
8196/*[clinic end generated code: output=dafbe9a5cddb987b input=1df2eaa27c0bf1d3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008197{
Victor Stinner8c62be82010-05-06 00:08:46 +00008198 Py_ssize_t n;
8199 PyObject *buffer;
Larry Hastings2f936352014-08-05 14:04:04 +10008200
8201 if (length < 0) {
Victor Stinner8c62be82010-05-06 00:08:46 +00008202 errno = EINVAL;
8203 return posix_error();
8204 }
Larry Hastings2f936352014-08-05 14:04:04 +10008205
8206#ifdef MS_WINDOWS
Victor Stinner66aab0c2015-03-19 22:53:20 +01008207 /* On Windows, the count parameter of read() is an int */
Larry Hastings2f936352014-08-05 14:04:04 +10008208 if (length > INT_MAX)
8209 length = INT_MAX;
Larry Hastings2f936352014-08-05 14:04:04 +10008210#endif
8211
8212 buffer = PyBytes_FromStringAndSize((char *)NULL, length);
Victor Stinner8c62be82010-05-06 00:08:46 +00008213 if (buffer == NULL)
8214 return NULL;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008215
Victor Stinner66aab0c2015-03-19 22:53:20 +01008216 n = _Py_read(fd, PyBytes_AS_STRING(buffer), length);
8217 if (n == -1) {
Victor Stinner8c62be82010-05-06 00:08:46 +00008218 Py_DECREF(buffer);
Victor Stinner66aab0c2015-03-19 22:53:20 +01008219 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00008220 }
Larry Hastings2f936352014-08-05 14:04:04 +10008221
8222 if (n != length)
Victor Stinner8c62be82010-05-06 00:08:46 +00008223 _PyBytes_Resize(&buffer, n);
Larry Hastings2f936352014-08-05 14:04:04 +10008224
Victor Stinner8c62be82010-05-06 00:08:46 +00008225 return buffer;
Guido van Rossum687dd131993-05-17 08:34:16 +00008226}
8227
Ross Lagerwall7807c352011-03-17 20:20:30 +02008228#if (defined(HAVE_SENDFILE) && (defined(__FreeBSD__) || defined(__DragonFly__) \
8229 || defined(__APPLE__))) || defined(HAVE_READV) || defined(HAVE_WRITEV)
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00008230static Py_ssize_t
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008231iov_setup(struct iovec **iov, Py_buffer **buf, PyObject *seq, Py_ssize_t cnt, int type)
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008232{
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008233 Py_ssize_t i, j;
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00008234 Py_ssize_t blen, total = 0;
8235
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008236 *iov = PyMem_New(struct iovec, cnt);
8237 if (*iov == NULL) {
8238 PyErr_NoMemory();
Victor Stinner57ddf782014-01-08 15:21:28 +01008239 return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008240 }
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00008241
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008242 *buf = PyMem_New(Py_buffer, cnt);
8243 if (*buf == NULL) {
8244 PyMem_Del(*iov);
8245 PyErr_NoMemory();
Victor Stinner57ddf782014-01-08 15:21:28 +01008246 return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008247 }
8248
8249 for (i = 0; i < cnt; i++) {
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02008250 PyObject *item = PySequence_GetItem(seq, i);
8251 if (item == NULL)
8252 goto fail;
8253 if (PyObject_GetBuffer(item, &(*buf)[i], type) == -1) {
8254 Py_DECREF(item);
8255 goto fail;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008256 }
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02008257 Py_DECREF(item);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008258 (*iov)[i].iov_base = (*buf)[i].buf;
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00008259 blen = (*buf)[i].len;
8260 (*iov)[i].iov_len = blen;
8261 total += blen;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008262 }
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00008263 return total;
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02008264
8265fail:
8266 PyMem_Del(*iov);
8267 for (j = 0; j < i; j++) {
8268 PyBuffer_Release(&(*buf)[j]);
8269 }
8270 PyMem_Del(*buf);
Victor Stinner57ddf782014-01-08 15:21:28 +01008271 return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008272}
8273
8274static void
8275iov_cleanup(struct iovec *iov, Py_buffer *buf, int cnt)
8276{
8277 int i;
8278 PyMem_Del(iov);
8279 for (i = 0; i < cnt; i++) {
8280 PyBuffer_Release(&buf[i]);
8281 }
8282 PyMem_Del(buf);
8283}
8284#endif
8285
Larry Hastings2f936352014-08-05 14:04:04 +10008286
Ross Lagerwall7807c352011-03-17 20:20:30 +02008287#ifdef HAVE_READV
Larry Hastings2f936352014-08-05 14:04:04 +10008288/*[clinic input]
8289os.readv -> Py_ssize_t
8290
8291 fd: int
8292 buffers: object
8293 /
8294
8295Read from a file descriptor fd into an iterable of buffers.
8296
8297The buffers should be mutable buffers accepting bytes.
8298readv will transfer data into each buffer until it is full
8299and then move on to the next buffer in the sequence to hold
8300the rest of the data.
8301
8302readv returns the total number of bytes read,
8303which may be less than the total capacity of all the buffers.
8304[clinic start generated code]*/
8305
Larry Hastings2f936352014-08-05 14:04:04 +10008306static Py_ssize_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008307os_readv_impl(PyObject *module, int fd, PyObject *buffers)
8308/*[clinic end generated code: output=792da062d3fcebdb input=e679eb5dbfa0357d]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008309{
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008310 Py_ssize_t cnt, n;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008311 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008312 struct iovec *iov;
8313 Py_buffer *buf;
8314
Larry Hastings2f936352014-08-05 14:04:04 +10008315 if (!PySequence_Check(buffers)) {
Ross Lagerwall7807c352011-03-17 20:20:30 +02008316 PyErr_SetString(PyExc_TypeError,
8317 "readv() arg 2 must be a sequence");
Larry Hastings2f936352014-08-05 14:04:04 +10008318 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008319 }
Ross Lagerwall7807c352011-03-17 20:20:30 +02008320
Larry Hastings2f936352014-08-05 14:04:04 +10008321 cnt = PySequence_Size(buffers);
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008322 if (cnt < 0)
8323 return -1;
Larry Hastings2f936352014-08-05 14:04:04 +10008324
8325 if (iov_setup(&iov, &buf, buffers, cnt, PyBUF_WRITABLE) < 0)
8326 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008327
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008328 do {
8329 Py_BEGIN_ALLOW_THREADS
8330 n = readv(fd, iov, cnt);
8331 Py_END_ALLOW_THREADS
8332 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Ross Lagerwall7807c352011-03-17 20:20:30 +02008333
8334 iov_cleanup(iov, buf, cnt);
Larry Hastings2f936352014-08-05 14:04:04 +10008335 if (n < 0) {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008336 if (!async_err)
8337 posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10008338 return -1;
8339 }
Victor Stinner57ddf782014-01-08 15:21:28 +01008340
Larry Hastings2f936352014-08-05 14:04:04 +10008341 return n;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008342}
Larry Hastings2f936352014-08-05 14:04:04 +10008343#endif /* HAVE_READV */
8344
Ross Lagerwall7807c352011-03-17 20:20:30 +02008345
8346#ifdef HAVE_PREAD
Larry Hastings2f936352014-08-05 14:04:04 +10008347/*[clinic input]
8348# TODO length should be size_t! but Python doesn't support parsing size_t yet.
8349os.pread
8350
8351 fd: int
8352 length: int
8353 offset: Py_off_t
8354 /
8355
8356Read a number of bytes from a file descriptor starting at a particular offset.
8357
8358Read length bytes from file descriptor fd, starting at offset bytes from
8359the beginning of the file. The file offset remains unchanged.
8360[clinic start generated code]*/
8361
Larry Hastings2f936352014-08-05 14:04:04 +10008362static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008363os_pread_impl(PyObject *module, int fd, int length, Py_off_t offset)
8364/*[clinic end generated code: output=435b29ee32b54a78 input=084948dcbaa35d4c]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008365{
Ross Lagerwall7807c352011-03-17 20:20:30 +02008366 Py_ssize_t n;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008367 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008368 PyObject *buffer;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008369
Larry Hastings2f936352014-08-05 14:04:04 +10008370 if (length < 0) {
Ross Lagerwall7807c352011-03-17 20:20:30 +02008371 errno = EINVAL;
8372 return posix_error();
8373 }
Larry Hastings2f936352014-08-05 14:04:04 +10008374 buffer = PyBytes_FromStringAndSize((char *)NULL, length);
Ross Lagerwall7807c352011-03-17 20:20:30 +02008375 if (buffer == NULL)
8376 return NULL;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008377
8378 do {
8379 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04008380 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008381 n = pread(fd, PyBytes_AS_STRING(buffer), length, offset);
Steve Dower8fc89802015-04-12 00:26:27 -04008382 _Py_END_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008383 Py_END_ALLOW_THREADS
8384 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
8385
Ross Lagerwall7807c352011-03-17 20:20:30 +02008386 if (n < 0) {
8387 Py_DECREF(buffer);
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008388 return (!async_err) ? posix_error() : NULL;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008389 }
Larry Hastings2f936352014-08-05 14:04:04 +10008390 if (n != length)
Ross Lagerwall7807c352011-03-17 20:20:30 +02008391 _PyBytes_Resize(&buffer, n);
8392 return buffer;
8393}
Larry Hastings2f936352014-08-05 14:04:04 +10008394#endif /* HAVE_PREAD */
Ross Lagerwall7807c352011-03-17 20:20:30 +02008395
Pablo Galindo4defba32018-01-27 16:16:37 +00008396#if defined(HAVE_PREADV) || defined (HAVE_PREADV2)
8397/*[clinic input]
8398os.preadv -> Py_ssize_t
8399
8400 fd: int
8401 buffers: object
8402 offset: Py_off_t
8403 flags: int = 0
8404 /
8405
8406Reads from a file descriptor into a number of mutable bytes-like objects.
8407
8408Combines the functionality of readv() and pread(). As readv(), it will
8409transfer data into each buffer until it is full and then move on to the next
8410buffer in the sequence to hold the rest of the data. Its fourth argument,
8411specifies the file offset at which the input operation is to be performed. It
8412will return the total number of bytes read (which can be less than the total
8413capacity of all the objects).
8414
8415The flags argument contains a bitwise OR of zero or more of the following flags:
8416
8417- RWF_HIPRI
8418- RWF_NOWAIT
8419
8420Using non-zero flags requires Linux 4.6 or newer.
8421[clinic start generated code]*/
8422
8423static Py_ssize_t
8424os_preadv_impl(PyObject *module, int fd, PyObject *buffers, Py_off_t offset,
8425 int flags)
8426/*[clinic end generated code: output=26fc9c6e58e7ada5 input=4173919dc1f7ed99]*/
8427{
8428 Py_ssize_t cnt, n;
8429 int async_err = 0;
8430 struct iovec *iov;
8431 Py_buffer *buf;
8432
8433 if (!PySequence_Check(buffers)) {
8434 PyErr_SetString(PyExc_TypeError,
8435 "preadv2() arg 2 must be a sequence");
8436 return -1;
8437 }
8438
8439 cnt = PySequence_Size(buffers);
8440 if (cnt < 0) {
8441 return -1;
8442 }
8443
8444#ifndef HAVE_PREADV2
8445 if(flags != 0) {
8446 argument_unavailable_error("preadv2", "flags");
8447 return -1;
8448 }
8449#endif
8450
8451 if (iov_setup(&iov, &buf, buffers, cnt, PyBUF_WRITABLE) < 0) {
8452 return -1;
8453 }
8454#ifdef HAVE_PREADV2
8455 do {
8456 Py_BEGIN_ALLOW_THREADS
8457 _Py_BEGIN_SUPPRESS_IPH
8458 n = preadv2(fd, iov, cnt, offset, flags);
8459 _Py_END_SUPPRESS_IPH
8460 Py_END_ALLOW_THREADS
8461 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
8462#else
8463 do {
8464 Py_BEGIN_ALLOW_THREADS
8465 _Py_BEGIN_SUPPRESS_IPH
8466 n = preadv(fd, iov, cnt, offset);
8467 _Py_END_SUPPRESS_IPH
8468 Py_END_ALLOW_THREADS
8469 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
8470#endif
8471
8472 iov_cleanup(iov, buf, cnt);
8473 if (n < 0) {
8474 if (!async_err) {
8475 posix_error();
8476 }
8477 return -1;
8478 }
8479
8480 return n;
8481}
8482#endif /* HAVE_PREADV */
8483
Larry Hastings2f936352014-08-05 14:04:04 +10008484
8485/*[clinic input]
8486os.write -> Py_ssize_t
8487
8488 fd: int
8489 data: Py_buffer
8490 /
8491
8492Write a bytes object to a file descriptor.
8493[clinic start generated code]*/
8494
Larry Hastings2f936352014-08-05 14:04:04 +10008495static Py_ssize_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008496os_write_impl(PyObject *module, int fd, Py_buffer *data)
8497/*[clinic end generated code: output=e4ef5bc904b58ef9 input=3207e28963234f3c]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008498{
Victor Stinner66aab0c2015-03-19 22:53:20 +01008499 return _Py_write(fd, data->buf, data->len);
Ross Lagerwall7807c352011-03-17 20:20:30 +02008500}
8501
8502#ifdef HAVE_SENDFILE
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008503PyDoc_STRVAR(posix_sendfile__doc__,
Martin Panterbf19d162015-09-09 01:01:13 +00008504"sendfile(out, in, offset, count) -> byteswritten\n\
Martin Panter94994132015-09-09 05:29:24 +00008505sendfile(out, in, offset, count[, headers][, trailers], flags=0)\n\
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008506 -> byteswritten\n\
Martin Panterbf19d162015-09-09 01:01:13 +00008507Copy count bytes from file descriptor in to file descriptor out.");
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008508
Larry Hastings2f936352014-08-05 14:04:04 +10008509/* AC 3.5: don't bother converting, has optional group*/
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008510static PyObject *
8511posix_sendfile(PyObject *self, PyObject *args, PyObject *kwdict)
8512{
8513 int in, out;
8514 Py_ssize_t ret;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008515 int async_err = 0;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008516 off_t offset;
8517
8518#if defined(__FreeBSD__) || defined(__DragonFly__) || defined(__APPLE__)
8519#ifndef __APPLE__
8520 Py_ssize_t len;
8521#endif
8522 PyObject *headers = NULL, *trailers = NULL;
8523 Py_buffer *hbuf, *tbuf;
8524 off_t sbytes;
8525 struct sf_hdtr sf;
8526 int flags = 0;
Martin Panterbf19d162015-09-09 01:01:13 +00008527 /* Beware that "in" clashes with Python's own "in" operator keyword */
Benjamin Petersond8a43b42011-02-26 21:35:16 +00008528 static char *keywords[] = {"out", "in",
8529 "offset", "count",
8530 "headers", "trailers", "flags", NULL};
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008531
Victor Stinner6ce0dbf2013-07-07 16:32:36 +02008532 sf.headers = NULL;
8533 sf.trailers = NULL;
8534
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008535#ifdef __APPLE__
8536 if (!PyArg_ParseTupleAndKeywords(args, kwdict, "iiO&O&|OOi:sendfile",
Larry Hastings2f936352014-08-05 14:04:04 +10008537 keywords, &out, &in, Py_off_t_converter, &offset, Py_off_t_converter, &sbytes,
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008538#else
8539 if (!PyArg_ParseTupleAndKeywords(args, kwdict, "iiO&n|OOi:sendfile",
Larry Hastings2f936352014-08-05 14:04:04 +10008540 keywords, &out, &in, Py_off_t_converter, &offset, &len,
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008541#endif
8542 &headers, &trailers, &flags))
8543 return NULL;
8544 if (headers != NULL) {
8545 if (!PySequence_Check(headers)) {
8546 PyErr_SetString(PyExc_TypeError,
Martin Panter94994132015-09-09 05:29:24 +00008547 "sendfile() headers must be a sequence");
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008548 return NULL;
8549 } else {
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008550 Py_ssize_t i = PySequence_Size(headers);
8551 if (i < 0)
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008552 return NULL;
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008553 if (i > INT_MAX) {
8554 PyErr_SetString(PyExc_OverflowError,
8555 "sendfile() header is too large");
8556 return NULL;
8557 }
8558 if (i > 0) {
8559 sf.hdr_cnt = (int)i;
8560 i = iov_setup(&(sf.headers), &hbuf,
8561 headers, sf.hdr_cnt, PyBUF_SIMPLE);
8562 if (i < 0)
8563 return NULL;
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00008564#ifdef __APPLE__
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008565 sbytes += i;
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00008566#endif
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008567 }
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008568 }
8569 }
8570 if (trailers != NULL) {
8571 if (!PySequence_Check(trailers)) {
8572 PyErr_SetString(PyExc_TypeError,
Martin Panter94994132015-09-09 05:29:24 +00008573 "sendfile() trailers must be a sequence");
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008574 return NULL;
8575 } else {
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008576 Py_ssize_t i = PySequence_Size(trailers);
8577 if (i < 0)
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008578 return NULL;
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008579 if (i > INT_MAX) {
8580 PyErr_SetString(PyExc_OverflowError,
8581 "sendfile() trailer is too large");
8582 return NULL;
8583 }
8584 if (i > 0) {
8585 sf.trl_cnt = (int)i;
8586 i = iov_setup(&(sf.trailers), &tbuf,
8587 trailers, sf.trl_cnt, PyBUF_SIMPLE);
8588 if (i < 0)
8589 return NULL;
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00008590#ifdef __APPLE__
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008591 sbytes += i;
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00008592#endif
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008593 }
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008594 }
8595 }
8596
Steve Dower8fc89802015-04-12 00:26:27 -04008597 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008598 do {
8599 Py_BEGIN_ALLOW_THREADS
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008600#ifdef __APPLE__
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008601 ret = sendfile(in, out, offset, &sbytes, &sf, flags);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008602#else
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008603 ret = sendfile(in, out, offset, len, &sf, &sbytes, flags);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008604#endif
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008605 Py_END_ALLOW_THREADS
8606 } while (ret < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Steve Dower8fc89802015-04-12 00:26:27 -04008607 _Py_END_SUPPRESS_IPH
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008608
8609 if (sf.headers != NULL)
8610 iov_cleanup(sf.headers, hbuf, sf.hdr_cnt);
8611 if (sf.trailers != NULL)
8612 iov_cleanup(sf.trailers, tbuf, sf.trl_cnt);
8613
8614 if (ret < 0) {
8615 if ((errno == EAGAIN) || (errno == EBUSY)) {
8616 if (sbytes != 0) {
8617 // some data has been sent
8618 goto done;
8619 }
8620 else {
8621 // no data has been sent; upper application is supposed
8622 // to retry on EAGAIN or EBUSY
8623 return posix_error();
8624 }
8625 }
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008626 return (!async_err) ? posix_error() : NULL;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008627 }
8628 goto done;
8629
8630done:
8631 #if !defined(HAVE_LARGEFILE_SUPPORT)
8632 return Py_BuildValue("l", sbytes);
8633 #else
8634 return Py_BuildValue("L", sbytes);
8635 #endif
8636
8637#else
8638 Py_ssize_t count;
8639 PyObject *offobj;
8640 static char *keywords[] = {"out", "in",
8641 "offset", "count", NULL};
8642 if (!PyArg_ParseTupleAndKeywords(args, kwdict, "iiOn:sendfile",
8643 keywords, &out, &in, &offobj, &count))
8644 return NULL;
Benjamin Peterson840ef8f2016-09-07 14:45:10 -07008645#ifdef __linux__
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008646 if (offobj == Py_None) {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008647 do {
8648 Py_BEGIN_ALLOW_THREADS
8649 ret = sendfile(out, in, NULL, count);
8650 Py_END_ALLOW_THREADS
8651 } while (ret < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008652 if (ret < 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008653 return (!async_err) ? posix_error() : NULL;
Giampaolo Rodola'ff1a7352011-04-19 09:47:16 +02008654 return Py_BuildValue("n", ret);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008655 }
8656#endif
Larry Hastings2f936352014-08-05 14:04:04 +10008657 if (!Py_off_t_converter(offobj, &offset))
Antoine Pitroudcc20b82011-02-26 13:38:35 +00008658 return NULL;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008659
8660 do {
8661 Py_BEGIN_ALLOW_THREADS
8662 ret = sendfile(out, in, &offset, count);
8663 Py_END_ALLOW_THREADS
8664 } while (ret < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008665 if (ret < 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008666 return (!async_err) ? posix_error() : NULL;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008667 return Py_BuildValue("n", ret);
8668#endif
8669}
Larry Hastings2f936352014-08-05 14:04:04 +10008670#endif /* HAVE_SENDFILE */
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008671
Larry Hastings2f936352014-08-05 14:04:04 +10008672
8673/*[clinic input]
8674os.fstat
8675
8676 fd : int
8677
8678Perform a stat system call on the given file descriptor.
8679
8680Like stat(), but for an open file descriptor.
8681Equivalent to os.stat(fd).
8682[clinic start generated code]*/
8683
Larry Hastings2f936352014-08-05 14:04:04 +10008684static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008685os_fstat_impl(PyObject *module, int fd)
8686/*[clinic end generated code: output=efc038cb5f654492 input=27e0e0ebbe5600c9]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008687{
Victor Stinner8c62be82010-05-06 00:08:46 +00008688 STRUCT_STAT st;
8689 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008690 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10008691
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008692 do {
8693 Py_BEGIN_ALLOW_THREADS
8694 res = FSTAT(fd, &st);
8695 Py_END_ALLOW_THREADS
8696 } while (res != 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Victor Stinner8c62be82010-05-06 00:08:46 +00008697 if (res != 0) {
Martin v. Löwis14694662006-02-03 12:54:16 +00008698#ifdef MS_WINDOWS
Victor Stinnerb024e842012-10-31 22:24:06 +01008699 return PyErr_SetFromWindowsErr(0);
Martin v. Löwis14694662006-02-03 12:54:16 +00008700#else
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008701 return (!async_err) ? posix_error() : NULL;
Martin v. Löwis14694662006-02-03 12:54:16 +00008702#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00008703 }
Tim Peters5aa91602002-01-30 05:46:57 +00008704
Victor Stinner4195b5c2012-02-08 23:03:19 +01008705 return _pystat_fromstructstat(&st);
Guido van Rossum687dd131993-05-17 08:34:16 +00008706}
8707
Larry Hastings2f936352014-08-05 14:04:04 +10008708
8709/*[clinic input]
8710os.isatty -> bool
8711 fd: int
8712 /
8713
8714Return True if the fd is connected to a terminal.
8715
8716Return True if the file descriptor is an open file descriptor
8717connected to the slave end of a terminal.
8718[clinic start generated code]*/
8719
Larry Hastings2f936352014-08-05 14:04:04 +10008720static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008721os_isatty_impl(PyObject *module, int fd)
8722/*[clinic end generated code: output=6a48c8b4e644ca00 input=08ce94aa1eaf7b5e]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008723{
Steve Dower8fc89802015-04-12 00:26:27 -04008724 int return_value;
Steve Dower8fc89802015-04-12 00:26:27 -04008725 _Py_BEGIN_SUPPRESS_IPH
8726 return_value = isatty(fd);
8727 _Py_END_SUPPRESS_IPH
8728 return return_value;
Larry Hastings2f936352014-08-05 14:04:04 +10008729}
8730
8731
Guido van Rossuma4916fa1996-05-23 22:58:55 +00008732#ifdef HAVE_PIPE
Larry Hastings2f936352014-08-05 14:04:04 +10008733/*[clinic input]
8734os.pipe
8735
8736Create a pipe.
8737
8738Returns a tuple of two file descriptors:
8739 (read_fd, write_fd)
8740[clinic start generated code]*/
8741
Larry Hastings2f936352014-08-05 14:04:04 +10008742static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008743os_pipe_impl(PyObject *module)
8744/*[clinic end generated code: output=ff9b76255793b440 input=02535e8c8fa6c4d4]*/
Guido van Rossum687dd131993-05-17 08:34:16 +00008745{
Victor Stinner8c62be82010-05-06 00:08:46 +00008746 int fds[2];
Victor Stinnerdaf45552013-08-28 00:53:59 +02008747#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00008748 HANDLE read, write;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008749 SECURITY_ATTRIBUTES attr;
Victor Stinner8c62be82010-05-06 00:08:46 +00008750 BOOL ok;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008751#else
8752 int res;
8753#endif
8754
8755#ifdef MS_WINDOWS
8756 attr.nLength = sizeof(attr);
8757 attr.lpSecurityDescriptor = NULL;
8758 attr.bInheritHandle = FALSE;
8759
8760 Py_BEGIN_ALLOW_THREADS
Steve Dowerc3630612016-11-19 18:41:16 -08008761 _Py_BEGIN_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02008762 ok = CreatePipe(&read, &write, &attr, 0);
8763 if (ok) {
Benjamin Petersonca470632016-09-06 13:47:26 -07008764 fds[0] = _open_osfhandle((intptr_t)read, _O_RDONLY);
8765 fds[1] = _open_osfhandle((intptr_t)write, _O_WRONLY);
Victor Stinnerdaf45552013-08-28 00:53:59 +02008766 if (fds[0] == -1 || fds[1] == -1) {
8767 CloseHandle(read);
8768 CloseHandle(write);
8769 ok = 0;
8770 }
8771 }
Steve Dowerc3630612016-11-19 18:41:16 -08008772 _Py_END_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02008773 Py_END_ALLOW_THREADS
8774
Victor Stinner8c62be82010-05-06 00:08:46 +00008775 if (!ok)
Victor Stinnerb024e842012-10-31 22:24:06 +01008776 return PyErr_SetFromWindowsErr(0);
Victor Stinnerdaf45552013-08-28 00:53:59 +02008777#else
8778
8779#ifdef HAVE_PIPE2
8780 Py_BEGIN_ALLOW_THREADS
8781 res = pipe2(fds, O_CLOEXEC);
8782 Py_END_ALLOW_THREADS
8783
8784 if (res != 0 && errno == ENOSYS)
8785 {
8786#endif
8787 Py_BEGIN_ALLOW_THREADS
8788 res = pipe(fds);
8789 Py_END_ALLOW_THREADS
8790
8791 if (res == 0) {
8792 if (_Py_set_inheritable(fds[0], 0, NULL) < 0) {
8793 close(fds[0]);
8794 close(fds[1]);
8795 return NULL;
8796 }
8797 if (_Py_set_inheritable(fds[1], 0, NULL) < 0) {
8798 close(fds[0]);
8799 close(fds[1]);
8800 return NULL;
8801 }
8802 }
8803#ifdef HAVE_PIPE2
8804 }
8805#endif
8806
8807 if (res != 0)
8808 return PyErr_SetFromErrno(PyExc_OSError);
8809#endif /* !MS_WINDOWS */
8810 return Py_BuildValue("(ii)", fds[0], fds[1]);
Guido van Rossum687dd131993-05-17 08:34:16 +00008811}
Guido van Rossuma4916fa1996-05-23 22:58:55 +00008812#endif /* HAVE_PIPE */
8813
Larry Hastings2f936352014-08-05 14:04:04 +10008814
Charles-François Natalidaafdd52011-05-29 20:07:40 +02008815#ifdef HAVE_PIPE2
Larry Hastings2f936352014-08-05 14:04:04 +10008816/*[clinic input]
8817os.pipe2
8818
8819 flags: int
8820 /
8821
8822Create a pipe with flags set atomically.
8823
8824Returns a tuple of two file descriptors:
8825 (read_fd, write_fd)
8826
8827flags can be constructed by ORing together one or more of these values:
8828O_NONBLOCK, O_CLOEXEC.
8829[clinic start generated code]*/
8830
Larry Hastings2f936352014-08-05 14:04:04 +10008831static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008832os_pipe2_impl(PyObject *module, int flags)
8833/*[clinic end generated code: output=25751fb43a45540f input=f261b6e7e63c6817]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008834{
Charles-François Natalidaafdd52011-05-29 20:07:40 +02008835 int fds[2];
8836 int res;
8837
Charles-François Natalidaafdd52011-05-29 20:07:40 +02008838 res = pipe2(fds, flags);
8839 if (res != 0)
8840 return posix_error();
8841 return Py_BuildValue("(ii)", fds[0], fds[1]);
8842}
8843#endif /* HAVE_PIPE2 */
8844
Larry Hastings2f936352014-08-05 14:04:04 +10008845
Ross Lagerwall7807c352011-03-17 20:20:30 +02008846#ifdef HAVE_WRITEV
Larry Hastings2f936352014-08-05 14:04:04 +10008847/*[clinic input]
8848os.writev -> Py_ssize_t
8849 fd: int
8850 buffers: object
8851 /
8852
8853Iterate over buffers, and write the contents of each to a file descriptor.
8854
8855Returns the total number of bytes written.
8856buffers must be a sequence of bytes-like objects.
8857[clinic start generated code]*/
8858
Larry Hastings2f936352014-08-05 14:04:04 +10008859static Py_ssize_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008860os_writev_impl(PyObject *module, int fd, PyObject *buffers)
8861/*[clinic end generated code: output=56565cfac3aac15b input=5b8d17fe4189d2fe]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008862{
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008863 Py_ssize_t cnt;
Larry Hastings2f936352014-08-05 14:04:04 +10008864 Py_ssize_t result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008865 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008866 struct iovec *iov;
8867 Py_buffer *buf;
Larry Hastings2f936352014-08-05 14:04:04 +10008868
8869 if (!PySequence_Check(buffers)) {
Ross Lagerwall7807c352011-03-17 20:20:30 +02008870 PyErr_SetString(PyExc_TypeError,
8871 "writev() arg 2 must be a sequence");
Larry Hastings2f936352014-08-05 14:04:04 +10008872 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008873 }
Larry Hastings2f936352014-08-05 14:04:04 +10008874 cnt = PySequence_Size(buffers);
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008875 if (cnt < 0)
8876 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008877
Larry Hastings2f936352014-08-05 14:04:04 +10008878 if (iov_setup(&iov, &buf, buffers, cnt, PyBUF_SIMPLE) < 0) {
8879 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008880 }
8881
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008882 do {
8883 Py_BEGIN_ALLOW_THREADS
8884 result = writev(fd, iov, cnt);
8885 Py_END_ALLOW_THREADS
8886 } while (result < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Ross Lagerwall7807c352011-03-17 20:20:30 +02008887
8888 iov_cleanup(iov, buf, cnt);
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008889 if (result < 0 && !async_err)
Larry Hastings2f936352014-08-05 14:04:04 +10008890 posix_error();
Victor Stinner57ddf782014-01-08 15:21:28 +01008891
Georg Brandl306336b2012-06-24 12:55:33 +02008892 return result;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008893}
Larry Hastings2f936352014-08-05 14:04:04 +10008894#endif /* HAVE_WRITEV */
8895
8896
8897#ifdef HAVE_PWRITE
8898/*[clinic input]
8899os.pwrite -> Py_ssize_t
8900
8901 fd: int
8902 buffer: Py_buffer
8903 offset: Py_off_t
8904 /
8905
8906Write bytes to a file descriptor starting at a particular offset.
8907
8908Write buffer to fd, starting at offset bytes from the beginning of
8909the file. Returns the number of bytes writte. Does not change the
8910current file offset.
8911[clinic start generated code]*/
8912
Larry Hastings2f936352014-08-05 14:04:04 +10008913static Py_ssize_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008914os_pwrite_impl(PyObject *module, int fd, Py_buffer *buffer, Py_off_t offset)
8915/*[clinic end generated code: output=c74da630758ee925 input=19903f1b3dd26377]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008916{
8917 Py_ssize_t size;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008918 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10008919
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008920 do {
8921 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04008922 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008923 size = pwrite(fd, buffer->buf, (size_t)buffer->len, offset);
Steve Dower8fc89802015-04-12 00:26:27 -04008924 _Py_END_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008925 Py_END_ALLOW_THREADS
8926 } while (size < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Larry Hastings2f936352014-08-05 14:04:04 +10008927
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008928 if (size < 0 && !async_err)
Larry Hastings2f936352014-08-05 14:04:04 +10008929 posix_error();
8930 return size;
8931}
8932#endif /* HAVE_PWRITE */
8933
Pablo Galindo4defba32018-01-27 16:16:37 +00008934#if defined(HAVE_PWRITEV) || defined (HAVE_PWRITEV2)
8935/*[clinic input]
8936os.pwritev -> Py_ssize_t
8937
8938 fd: int
8939 buffers: object
8940 offset: Py_off_t
8941 flags: int = 0
8942 /
8943
8944Writes the contents of bytes-like objects to a file descriptor at a given offset.
8945
8946Combines the functionality of writev() and pwrite(). All buffers must be a sequence
8947of bytes-like objects. Buffers are processed in array order. Entire contents of first
8948buffer is written before proceeding to second, and so on. The operating system may
8949set a limit (sysconf() value SC_IOV_MAX) on the number of buffers that can be used.
8950This function writes the contents of each object to the file descriptor and returns
8951the total number of bytes written.
8952
8953The flags argument contains a bitwise OR of zero or more of the following flags:
8954
8955- RWF_DSYNC
8956- RWF_SYNC
8957
8958Using non-zero flags requires Linux 4.7 or newer.
8959[clinic start generated code]*/
8960
8961static Py_ssize_t
8962os_pwritev_impl(PyObject *module, int fd, PyObject *buffers, Py_off_t offset,
8963 int flags)
8964/*[clinic end generated code: output=e3dd3e9d11a6a5c7 input=803dc5ddbf0cfd3b]*/
8965{
8966 Py_ssize_t cnt;
8967 Py_ssize_t result;
8968 int async_err = 0;
8969 struct iovec *iov;
8970 Py_buffer *buf;
8971
8972 if (!PySequence_Check(buffers)) {
8973 PyErr_SetString(PyExc_TypeError,
8974 "pwritev() arg 2 must be a sequence");
8975 return -1;
8976 }
8977
8978 cnt = PySequence_Size(buffers);
8979 if (cnt < 0) {
8980 return -1;
8981 }
8982
8983#ifndef HAVE_PWRITEV2
8984 if(flags != 0) {
8985 argument_unavailable_error("pwritev2", "flags");
8986 return -1;
8987 }
8988#endif
8989
8990 if (iov_setup(&iov, &buf, buffers, cnt, PyBUF_SIMPLE) < 0) {
8991 return -1;
8992 }
8993#ifdef HAVE_PWRITEV2
8994 do {
8995 Py_BEGIN_ALLOW_THREADS
8996 _Py_BEGIN_SUPPRESS_IPH
8997 result = pwritev2(fd, iov, cnt, offset, flags);
8998 _Py_END_SUPPRESS_IPH
8999 Py_END_ALLOW_THREADS
9000 } while (result < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
9001#else
9002 do {
9003 Py_BEGIN_ALLOW_THREADS
9004 _Py_BEGIN_SUPPRESS_IPH
9005 result = pwritev(fd, iov, cnt, offset);
9006 _Py_END_SUPPRESS_IPH
9007 Py_END_ALLOW_THREADS
9008 } while (result < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
9009#endif
9010
9011 iov_cleanup(iov, buf, cnt);
9012 if (result < 0) {
9013 if (!async_err) {
9014 posix_error();
9015 }
9016 return -1;
9017 }
9018
9019 return result;
9020}
9021#endif /* HAVE_PWRITEV */
9022
9023
9024
Larry Hastings2f936352014-08-05 14:04:04 +10009025
9026#ifdef HAVE_MKFIFO
9027/*[clinic input]
9028os.mkfifo
9029
9030 path: path_t
9031 mode: int=0o666
9032 *
9033 dir_fd: dir_fd(requires='mkfifoat')=None
9034
9035Create a "fifo" (a POSIX named pipe).
9036
9037If dir_fd is not None, it should be a file descriptor open to a directory,
9038 and path should be relative; path will then be relative to that directory.
9039dir_fd may not be implemented on your platform.
9040 If it is unavailable, using it will raise a NotImplementedError.
9041[clinic start generated code]*/
9042
Larry Hastings2f936352014-08-05 14:04:04 +10009043static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009044os_mkfifo_impl(PyObject *module, path_t *path, int mode, int dir_fd)
9045/*[clinic end generated code: output=ce41cfad0e68c940 input=73032e98a36e0e19]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009046{
9047 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009048 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10009049
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009050 do {
9051 Py_BEGIN_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10009052#ifdef HAVE_MKFIFOAT
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009053 if (dir_fd != DEFAULT_DIR_FD)
9054 result = mkfifoat(dir_fd, path->narrow, mode);
9055 else
Ross Lagerwall7807c352011-03-17 20:20:30 +02009056#endif
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009057 result = mkfifo(path->narrow, mode);
9058 Py_END_ALLOW_THREADS
9059 } while (result != 0 && errno == EINTR &&
9060 !(async_err = PyErr_CheckSignals()));
9061 if (result != 0)
9062 return (!async_err) ? posix_error() : NULL;
Larry Hastings2f936352014-08-05 14:04:04 +10009063
9064 Py_RETURN_NONE;
9065}
9066#endif /* HAVE_MKFIFO */
9067
9068
9069#if defined(HAVE_MKNOD) && defined(HAVE_MAKEDEV)
9070/*[clinic input]
9071os.mknod
9072
9073 path: path_t
9074 mode: int=0o600
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +02009075 device: dev_t=0
Larry Hastings2f936352014-08-05 14:04:04 +10009076 *
9077 dir_fd: dir_fd(requires='mknodat')=None
9078
9079Create a node in the file system.
9080
9081Create a node in the file system (file, device special file or named pipe)
9082at path. mode specifies both the permissions to use and the
9083type of node to be created, being combined (bitwise OR) with one of
9084S_IFREG, S_IFCHR, S_IFBLK, and S_IFIFO. If S_IFCHR or S_IFBLK is set on mode,
9085device defines the newly created device special file (probably using
9086os.makedev()). Otherwise device is ignored.
9087
9088If dir_fd is not None, it should be a file descriptor open to a directory,
9089 and path should be relative; path will then be relative to that directory.
9090dir_fd may not be implemented on your platform.
9091 If it is unavailable, using it will raise a NotImplementedError.
9092[clinic start generated code]*/
9093
Larry Hastings2f936352014-08-05 14:04:04 +10009094static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009095os_mknod_impl(PyObject *module, path_t *path, int mode, dev_t device,
Larry Hastings89964c42015-04-14 18:07:59 -04009096 int dir_fd)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009097/*[clinic end generated code: output=92e55d3ca8917461 input=ee44531551a4d83b]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009098{
9099 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009100 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10009101
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009102 do {
9103 Py_BEGIN_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10009104#ifdef HAVE_MKNODAT
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009105 if (dir_fd != DEFAULT_DIR_FD)
9106 result = mknodat(dir_fd, path->narrow, mode, device);
9107 else
Larry Hastings2f936352014-08-05 14:04:04 +10009108#endif
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009109 result = mknod(path->narrow, mode, device);
9110 Py_END_ALLOW_THREADS
9111 } while (result != 0 && errno == EINTR &&
9112 !(async_err = PyErr_CheckSignals()));
9113 if (result != 0)
9114 return (!async_err) ? posix_error() : NULL;
Larry Hastings2f936352014-08-05 14:04:04 +10009115
9116 Py_RETURN_NONE;
9117}
9118#endif /* defined(HAVE_MKNOD) && defined(HAVE_MAKEDEV) */
9119
9120
9121#ifdef HAVE_DEVICE_MACROS
9122/*[clinic input]
9123os.major -> unsigned_int
9124
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +02009125 device: dev_t
Larry Hastings2f936352014-08-05 14:04:04 +10009126 /
9127
9128Extracts a device major number from a raw device number.
9129[clinic start generated code]*/
9130
Larry Hastings2f936352014-08-05 14:04:04 +10009131static unsigned int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009132os_major_impl(PyObject *module, dev_t device)
9133/*[clinic end generated code: output=5b3b2589bafb498e input=1e16a4d30c4d4462]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009134{
9135 return major(device);
9136}
9137
9138
9139/*[clinic input]
9140os.minor -> unsigned_int
9141
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +02009142 device: dev_t
Larry Hastings2f936352014-08-05 14:04:04 +10009143 /
9144
9145Extracts a device minor number from a raw device number.
9146[clinic start generated code]*/
9147
Larry Hastings2f936352014-08-05 14:04:04 +10009148static unsigned int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009149os_minor_impl(PyObject *module, dev_t device)
9150/*[clinic end generated code: output=5e1a25e630b0157d input=0842c6d23f24c65e]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009151{
9152 return minor(device);
9153}
9154
9155
9156/*[clinic input]
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +02009157os.makedev -> dev_t
Larry Hastings2f936352014-08-05 14:04:04 +10009158
9159 major: int
9160 minor: int
9161 /
9162
9163Composes a raw device number from the major and minor device numbers.
9164[clinic start generated code]*/
9165
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +02009166static dev_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009167os_makedev_impl(PyObject *module, int major, int minor)
9168/*[clinic end generated code: output=881aaa4aba6f6a52 input=4b9fd8fc73cbe48f]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009169{
9170 return makedev(major, minor);
9171}
9172#endif /* HAVE_DEVICE_MACROS */
9173
9174
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009175#if defined HAVE_FTRUNCATE || defined MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10009176/*[clinic input]
9177os.ftruncate
9178
9179 fd: int
9180 length: Py_off_t
9181 /
9182
9183Truncate a file, specified by file descriptor, to a specific length.
9184[clinic start generated code]*/
9185
Larry Hastings2f936352014-08-05 14:04:04 +10009186static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009187os_ftruncate_impl(PyObject *module, int fd, Py_off_t length)
9188/*[clinic end generated code: output=fba15523721be7e4 input=63b43641e52818f2]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009189{
9190 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009191 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10009192
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009193 do {
9194 Py_BEGIN_ALLOW_THREADS
Steve Dowera1c7e722015-04-12 00:26:43 -04009195 _Py_BEGIN_SUPPRESS_IPH
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009196#ifdef MS_WINDOWS
9197 result = _chsize_s(fd, length);
9198#else
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009199 result = ftruncate(fd, length);
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009200#endif
Steve Dowera1c7e722015-04-12 00:26:43 -04009201 _Py_END_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009202 Py_END_ALLOW_THREADS
9203 } while (result != 0 && errno == EINTR &&
9204 !(async_err = PyErr_CheckSignals()));
9205 if (result != 0)
9206 return (!async_err) ? posix_error() : NULL;
Larry Hastings2f936352014-08-05 14:04:04 +10009207 Py_RETURN_NONE;
9208}
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009209#endif /* HAVE_FTRUNCATE || MS_WINDOWS */
Larry Hastings2f936352014-08-05 14:04:04 +10009210
9211
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009212#if defined HAVE_TRUNCATE || defined MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10009213/*[clinic input]
9214os.truncate
9215 path: path_t(allow_fd='PATH_HAVE_FTRUNCATE')
9216 length: Py_off_t
9217
9218Truncate a file, specified by path, to a specific length.
9219
9220On some platforms, path may also be specified as an open file descriptor.
9221 If this functionality is unavailable, using it raises an exception.
9222[clinic start generated code]*/
9223
Larry Hastings2f936352014-08-05 14:04:04 +10009224static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009225os_truncate_impl(PyObject *module, path_t *path, Py_off_t length)
9226/*[clinic end generated code: output=43009c8df5c0a12b input=77229cf0b50a9b77]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009227{
9228 int result;
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009229#ifdef MS_WINDOWS
9230 int fd;
9231#endif
9232
9233 if (path->fd != -1)
9234 return os_ftruncate_impl(module, path->fd, length);
Larry Hastings2f936352014-08-05 14:04:04 +10009235
9236 Py_BEGIN_ALLOW_THREADS
Steve Dowera1c7e722015-04-12 00:26:43 -04009237 _Py_BEGIN_SUPPRESS_IPH
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009238#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07009239 fd = _wopen(path->wide, _O_WRONLY | _O_BINARY | _O_NOINHERIT);
Victor Stinnercc0bbbc2015-04-25 00:21:52 +02009240 if (fd < 0)
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009241 result = -1;
9242 else {
9243 result = _chsize_s(fd, length);
9244 close(fd);
9245 if (result < 0)
9246 errno = result;
9247 }
9248#else
9249 result = truncate(path->narrow, length);
Larry Hastings2f936352014-08-05 14:04:04 +10009250#endif
Steve Dowera1c7e722015-04-12 00:26:43 -04009251 _Py_END_SUPPRESS_IPH
Larry Hastings2f936352014-08-05 14:04:04 +10009252 Py_END_ALLOW_THREADS
9253 if (result < 0)
9254 return path_error(path);
9255
9256 Py_RETURN_NONE;
9257}
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009258#endif /* HAVE_TRUNCATE || MS_WINDOWS */
Larry Hastings2f936352014-08-05 14:04:04 +10009259
Ross Lagerwall7807c352011-03-17 20:20:30 +02009260
Victor Stinnerd6b17692014-09-30 12:20:05 +02009261/* Issue #22396: On 32-bit AIX platform, the prototypes of os.posix_fadvise()
9262 and os.posix_fallocate() in system headers are wrong if _LARGE_FILES is
9263 defined, which is the case in Python on AIX. AIX bug report:
9264 http://www-01.ibm.com/support/docview.wss?uid=isg1IV56170 */
9265#if defined(_AIX) && defined(_LARGE_FILES) && !defined(__64BIT__)
9266# define POSIX_FADVISE_AIX_BUG
9267#endif
9268
Victor Stinnerec39e262014-09-30 12:35:58 +02009269
Victor Stinnerd6b17692014-09-30 12:20:05 +02009270#if defined(HAVE_POSIX_FALLOCATE) && !defined(POSIX_FADVISE_AIX_BUG)
Larry Hastings2f936352014-08-05 14:04:04 +10009271/*[clinic input]
9272os.posix_fallocate
9273
9274 fd: int
9275 offset: Py_off_t
9276 length: Py_off_t
9277 /
9278
9279Ensure a file has allocated at least a particular number of bytes on disk.
9280
9281Ensure that the file specified by fd encompasses a range of bytes
9282starting at offset bytes from the beginning and continuing for length bytes.
9283[clinic start generated code]*/
9284
Larry Hastings2f936352014-08-05 14:04:04 +10009285static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009286os_posix_fallocate_impl(PyObject *module, int fd, Py_off_t offset,
Larry Hastings89964c42015-04-14 18:07:59 -04009287 Py_off_t length)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009288/*[clinic end generated code: output=73f107139564aa9d input=d7a2ef0ab2ca52fb]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009289{
9290 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009291 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009292
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009293 do {
9294 Py_BEGIN_ALLOW_THREADS
9295 result = posix_fallocate(fd, offset, length);
9296 Py_END_ALLOW_THREADS
Коренберг Маркd4b93e22017-08-14 18:55:16 +05009297 } while (result == EINTR && !(async_err = PyErr_CheckSignals()));
9298
9299 if (result == 0)
9300 Py_RETURN_NONE;
9301
9302 if (async_err)
9303 return NULL;
9304
9305 errno = result;
9306 return posix_error();
Ross Lagerwall7807c352011-03-17 20:20:30 +02009307}
Victor Stinnerec39e262014-09-30 12:35:58 +02009308#endif /* HAVE_POSIX_FALLOCATE) && !POSIX_FADVISE_AIX_BUG */
Larry Hastings2f936352014-08-05 14:04:04 +10009309
Ross Lagerwall7807c352011-03-17 20:20:30 +02009310
Victor Stinnerd6b17692014-09-30 12:20:05 +02009311#if defined(HAVE_POSIX_FADVISE) && !defined(POSIX_FADVISE_AIX_BUG)
Larry Hastings2f936352014-08-05 14:04:04 +10009312/*[clinic input]
9313os.posix_fadvise
9314
9315 fd: int
9316 offset: Py_off_t
9317 length: Py_off_t
9318 advice: int
9319 /
9320
9321Announce an intention to access data in a specific pattern.
9322
9323Announce an intention to access data in a specific pattern, thus allowing
9324the kernel to make optimizations.
9325The advice applies to the region of the file specified by fd starting at
9326offset and continuing for length bytes.
9327advice is one of POSIX_FADV_NORMAL, POSIX_FADV_SEQUENTIAL,
9328POSIX_FADV_RANDOM, POSIX_FADV_NOREUSE, POSIX_FADV_WILLNEED, or
9329POSIX_FADV_DONTNEED.
9330[clinic start generated code]*/
9331
Larry Hastings2f936352014-08-05 14:04:04 +10009332static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009333os_posix_fadvise_impl(PyObject *module, int fd, Py_off_t offset,
Larry Hastings89964c42015-04-14 18:07:59 -04009334 Py_off_t length, int advice)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009335/*[clinic end generated code: output=412ef4aa70c98642 input=0fbe554edc2f04b5]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009336{
9337 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009338 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009339
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009340 do {
9341 Py_BEGIN_ALLOW_THREADS
9342 result = posix_fadvise(fd, offset, length, advice);
9343 Py_END_ALLOW_THREADS
Коренберг Маркd4b93e22017-08-14 18:55:16 +05009344 } while (result == EINTR && !(async_err = PyErr_CheckSignals()));
9345
9346 if (result == 0)
9347 Py_RETURN_NONE;
9348
9349 if (async_err)
9350 return NULL;
9351
9352 errno = result;
9353 return posix_error();
Ross Lagerwall7807c352011-03-17 20:20:30 +02009354}
Victor Stinnerec39e262014-09-30 12:35:58 +02009355#endif /* HAVE_POSIX_FADVISE && !POSIX_FADVISE_AIX_BUG */
Ross Lagerwall7807c352011-03-17 20:20:30 +02009356
Guido van Rossumf1af3fe1996-07-23 19:18:10 +00009357#ifdef HAVE_PUTENV
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00009358
Fred Drake762e2061999-08-26 17:23:54 +00009359/* Save putenv() parameters as values here, so we can collect them when they
9360 * get re-set with another call for the same key. */
9361static PyObject *posix_putenv_garbage;
9362
Larry Hastings2f936352014-08-05 14:04:04 +10009363static void
9364posix_putenv_garbage_setitem(PyObject *name, PyObject *value)
Guido van Rossumf1af3fe1996-07-23 19:18:10 +00009365{
Larry Hastings2f936352014-08-05 14:04:04 +10009366 /* Install the first arg and newstr in posix_putenv_garbage;
9367 * this will cause previous value to be collected. This has to
9368 * happen after the real putenv() call because the old value
9369 * was still accessible until then. */
9370 if (PyDict_SetItem(posix_putenv_garbage, name, value))
9371 /* really not much we can do; just leak */
9372 PyErr_Clear();
9373 else
9374 Py_DECREF(value);
9375}
9376
9377
Thomas Hellerf78f12a2007-11-08 19:33:05 +00009378#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10009379/*[clinic input]
9380os.putenv
9381
9382 name: unicode
9383 value: unicode
9384 /
9385
9386Change or add an environment variable.
9387[clinic start generated code]*/
9388
Larry Hastings2f936352014-08-05 14:04:04 +10009389static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009390os_putenv_impl(PyObject *module, PyObject *name, PyObject *value)
9391/*[clinic end generated code: output=d29a567d6b2327d2 input=ba586581c2e6105f]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009392{
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03009393 const wchar_t *env;
Serhiy Storchakaf7eae0a2017-06-28 08:30:06 +03009394 Py_ssize_t size;
Larry Hastings2f936352014-08-05 14:04:04 +10009395
Serhiy Storchaka77703942017-06-25 07:33:01 +03009396 /* Search from index 1 because on Windows starting '=' is allowed for
9397 defining hidden environment variables. */
9398 if (PyUnicode_GET_LENGTH(name) == 0 ||
9399 PyUnicode_FindChar(name, '=', 1, PyUnicode_GET_LENGTH(name), 1) != -1)
9400 {
9401 PyErr_SetString(PyExc_ValueError, "illegal environment variable name");
9402 return NULL;
9403 }
Larry Hastings2f936352014-08-05 14:04:04 +10009404 PyObject *unicode = PyUnicode_FromFormat("%U=%U", name, value);
9405 if (unicode == NULL) {
Larry Hastings2f936352014-08-05 14:04:04 +10009406 return NULL;
Victor Stinner84ae1182010-05-06 22:05:07 +00009407 }
Serhiy Storchakaf7eae0a2017-06-28 08:30:06 +03009408
9409 env = PyUnicode_AsUnicodeAndSize(unicode, &size);
9410 if (env == NULL)
9411 goto error;
9412 if (size > _MAX_ENV) {
Victor Stinner65170952011-11-22 22:16:17 +01009413 PyErr_Format(PyExc_ValueError,
9414 "the environment variable is longer than %u characters",
9415 _MAX_ENV);
9416 goto error;
9417 }
Serhiy Storchakaf7eae0a2017-06-28 08:30:06 +03009418 if (wcslen(env) != (size_t)size) {
9419 PyErr_SetString(PyExc_ValueError, "embedded null character");
Victor Stinnereb5657a2011-09-30 01:44:27 +02009420 goto error;
Serhiy Storchakaf7eae0a2017-06-28 08:30:06 +03009421 }
9422
Larry Hastings2f936352014-08-05 14:04:04 +10009423 if (_wputenv(env)) {
Victor Stinner8c62be82010-05-06 00:08:46 +00009424 posix_error();
Victor Stinner84ae1182010-05-06 22:05:07 +00009425 goto error;
Victor Stinner8c62be82010-05-06 00:08:46 +00009426 }
Guido van Rossumf1af3fe1996-07-23 19:18:10 +00009427
Larry Hastings2f936352014-08-05 14:04:04 +10009428 posix_putenv_garbage_setitem(name, unicode);
Victor Stinner84ae1182010-05-06 22:05:07 +00009429 Py_RETURN_NONE;
9430
9431error:
Larry Hastings2f936352014-08-05 14:04:04 +10009432 Py_DECREF(unicode);
Victor Stinner84ae1182010-05-06 22:05:07 +00009433 return NULL;
Guido van Rossumf1af3fe1996-07-23 19:18:10 +00009434}
Larry Hastings2f936352014-08-05 14:04:04 +10009435#else /* MS_WINDOWS */
9436/*[clinic input]
9437os.putenv
Guido van Rossumb6a47161997-09-15 22:54:34 +00009438
Larry Hastings2f936352014-08-05 14:04:04 +10009439 name: FSConverter
9440 value: FSConverter
9441 /
9442
9443Change or add an environment variable.
9444[clinic start generated code]*/
9445
Larry Hastings2f936352014-08-05 14:04:04 +10009446static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009447os_putenv_impl(PyObject *module, PyObject *name, PyObject *value)
9448/*[clinic end generated code: output=d29a567d6b2327d2 input=a97bc6152f688d31]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009449{
9450 PyObject *bytes = NULL;
9451 char *env;
Serhiy Storchaka77703942017-06-25 07:33:01 +03009452 const char *name_string = PyBytes_AS_STRING(name);
9453 const char *value_string = PyBytes_AS_STRING(value);
Larry Hastings2f936352014-08-05 14:04:04 +10009454
Serhiy Storchaka77703942017-06-25 07:33:01 +03009455 if (strchr(name_string, '=') != NULL) {
9456 PyErr_SetString(PyExc_ValueError, "illegal environment variable name");
9457 return NULL;
9458 }
Larry Hastings2f936352014-08-05 14:04:04 +10009459 bytes = PyBytes_FromFormat("%s=%s", name_string, value_string);
9460 if (bytes == NULL) {
Larry Hastings2f936352014-08-05 14:04:04 +10009461 return NULL;
9462 }
9463
9464 env = PyBytes_AS_STRING(bytes);
9465 if (putenv(env)) {
9466 Py_DECREF(bytes);
9467 return posix_error();
9468 }
9469
9470 posix_putenv_garbage_setitem(name, bytes);
9471 Py_RETURN_NONE;
9472}
9473#endif /* MS_WINDOWS */
9474#endif /* HAVE_PUTENV */
9475
9476
9477#ifdef HAVE_UNSETENV
9478/*[clinic input]
9479os.unsetenv
9480 name: FSConverter
9481 /
9482
9483Delete an environment variable.
9484[clinic start generated code]*/
9485
Larry Hastings2f936352014-08-05 14:04:04 +10009486static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009487os_unsetenv_impl(PyObject *module, PyObject *name)
9488/*[clinic end generated code: output=54c4137ab1834f02 input=2bb5288a599c7107]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009489{
Victor Stinner984890f2011-11-24 13:53:38 +01009490#ifndef HAVE_BROKEN_UNSETENV
Victor Stinner60b385e2011-11-22 22:01:28 +01009491 int err;
Victor Stinner984890f2011-11-24 13:53:38 +01009492#endif
Victor Stinner84ae1182010-05-06 22:05:07 +00009493
Victor Stinner984890f2011-11-24 13:53:38 +01009494#ifdef HAVE_BROKEN_UNSETENV
9495 unsetenv(PyBytes_AS_STRING(name));
9496#else
Victor Stinner65170952011-11-22 22:16:17 +01009497 err = unsetenv(PyBytes_AS_STRING(name));
Larry Hastings2f936352014-08-05 14:04:04 +10009498 if (err)
Victor Stinner60b385e2011-11-22 22:01:28 +01009499 return posix_error();
Victor Stinner984890f2011-11-24 13:53:38 +01009500#endif
Guido van Rossumc524d952001-10-19 01:31:59 +00009501
Victor Stinner8c62be82010-05-06 00:08:46 +00009502 /* Remove the key from posix_putenv_garbage;
9503 * this will cause it to be collected. This has to
9504 * happen after the real unsetenv() call because the
9505 * old value was still accessible until then.
9506 */
Victor Stinner65170952011-11-22 22:16:17 +01009507 if (PyDict_DelItem(posix_putenv_garbage, name)) {
Victor Stinner8c62be82010-05-06 00:08:46 +00009508 /* really not much we can do; just leak */
9509 PyErr_Clear();
9510 }
Victor Stinner84ae1182010-05-06 22:05:07 +00009511 Py_RETURN_NONE;
Guido van Rossumc524d952001-10-19 01:31:59 +00009512}
Larry Hastings2f936352014-08-05 14:04:04 +10009513#endif /* HAVE_UNSETENV */
Guido van Rossumc524d952001-10-19 01:31:59 +00009514
Larry Hastings2f936352014-08-05 14:04:04 +10009515
9516/*[clinic input]
9517os.strerror
9518
9519 code: int
9520 /
9521
9522Translate an error code to a message string.
9523[clinic start generated code]*/
9524
Larry Hastings2f936352014-08-05 14:04:04 +10009525static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009526os_strerror_impl(PyObject *module, int code)
9527/*[clinic end generated code: output=baebf09fa02a78f2 input=75a8673d97915a91]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009528{
9529 char *message = strerror(code);
Victor Stinner8c62be82010-05-06 00:08:46 +00009530 if (message == NULL) {
9531 PyErr_SetString(PyExc_ValueError,
9532 "strerror() argument out of range");
9533 return NULL;
9534 }
Victor Stinner1b579672011-12-17 05:47:23 +01009535 return PyUnicode_DecodeLocale(message, "surrogateescape");
Guido van Rossumb6a47161997-09-15 22:54:34 +00009536}
Guido van Rossumb6a47161997-09-15 22:54:34 +00009537
Guido van Rossumf1af3fe1996-07-23 19:18:10 +00009538
Guido van Rossumc9641791998-08-04 15:26:23 +00009539#ifdef HAVE_SYS_WAIT_H
Fred Drake106c1a02002-04-23 15:58:02 +00009540#ifdef WCOREDUMP
Larry Hastings2f936352014-08-05 14:04:04 +10009541/*[clinic input]
9542os.WCOREDUMP -> bool
9543
9544 status: int
9545 /
9546
9547Return True if the process returning status was dumped to a core file.
9548[clinic start generated code]*/
9549
Larry Hastings2f936352014-08-05 14:04:04 +10009550static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009551os_WCOREDUMP_impl(PyObject *module, int status)
9552/*[clinic end generated code: output=1a584b147b16bd18 input=8b05e7ab38528d04]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009553{
9554 WAIT_TYPE wait_status;
9555 WAIT_STATUS_INT(wait_status) = status;
9556 return WCOREDUMP(wait_status);
Fred Drake106c1a02002-04-23 15:58:02 +00009557}
9558#endif /* WCOREDUMP */
9559
Larry Hastings2f936352014-08-05 14:04:04 +10009560
Fred Drake106c1a02002-04-23 15:58:02 +00009561#ifdef WIFCONTINUED
Larry Hastings2f936352014-08-05 14:04:04 +10009562/*[clinic input]
9563os.WIFCONTINUED -> bool
9564
9565 status: int
9566
9567Return True if a particular process was continued from a job control stop.
9568
9569Return True if the process returning status was continued from a
9570job control stop.
9571[clinic start generated code]*/
9572
Larry Hastings2f936352014-08-05 14:04:04 +10009573static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009574os_WIFCONTINUED_impl(PyObject *module, int status)
9575/*[clinic end generated code: output=1e35295d844364bd input=e777e7d38eb25bd9]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009576{
9577 WAIT_TYPE wait_status;
9578 WAIT_STATUS_INT(wait_status) = status;
9579 return WIFCONTINUED(wait_status);
Fred Drake106c1a02002-04-23 15:58:02 +00009580}
9581#endif /* WIFCONTINUED */
9582
Larry Hastings2f936352014-08-05 14:04:04 +10009583
Guido van Rossumc9641791998-08-04 15:26:23 +00009584#ifdef WIFSTOPPED
Larry Hastings2f936352014-08-05 14:04:04 +10009585/*[clinic input]
9586os.WIFSTOPPED -> bool
9587
9588 status: int
9589
9590Return True if the process returning status was stopped.
9591[clinic start generated code]*/
9592
Larry Hastings2f936352014-08-05 14:04:04 +10009593static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009594os_WIFSTOPPED_impl(PyObject *module, int status)
9595/*[clinic end generated code: output=fdb57122a5c9b4cb input=043cb7f1289ef904]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009596{
9597 WAIT_TYPE wait_status;
9598 WAIT_STATUS_INT(wait_status) = status;
9599 return WIFSTOPPED(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +00009600}
9601#endif /* WIFSTOPPED */
9602
Larry Hastings2f936352014-08-05 14:04:04 +10009603
Guido van Rossumc9641791998-08-04 15:26:23 +00009604#ifdef WIFSIGNALED
Larry Hastings2f936352014-08-05 14:04:04 +10009605/*[clinic input]
9606os.WIFSIGNALED -> bool
9607
9608 status: int
9609
9610Return True if the process returning status was terminated by a signal.
9611[clinic start generated code]*/
9612
Larry Hastings2f936352014-08-05 14:04:04 +10009613static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009614os_WIFSIGNALED_impl(PyObject *module, int status)
9615/*[clinic end generated code: output=d1dde4dcc819a5f5 input=d55ba7cc9ce5dc43]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009616{
9617 WAIT_TYPE wait_status;
9618 WAIT_STATUS_INT(wait_status) = status;
9619 return WIFSIGNALED(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +00009620}
9621#endif /* WIFSIGNALED */
9622
Larry Hastings2f936352014-08-05 14:04:04 +10009623
Guido van Rossumc9641791998-08-04 15:26:23 +00009624#ifdef WIFEXITED
Larry Hastings2f936352014-08-05 14:04:04 +10009625/*[clinic input]
9626os.WIFEXITED -> bool
9627
9628 status: int
9629
9630Return True if the process returning status exited via the exit() system call.
9631[clinic start generated code]*/
9632
Larry Hastings2f936352014-08-05 14:04:04 +10009633static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009634os_WIFEXITED_impl(PyObject *module, int status)
9635/*[clinic end generated code: output=01c09d6ebfeea397 input=d63775a6791586c0]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009636{
9637 WAIT_TYPE wait_status;
9638 WAIT_STATUS_INT(wait_status) = status;
9639 return WIFEXITED(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +00009640}
9641#endif /* WIFEXITED */
9642
Larry Hastings2f936352014-08-05 14:04:04 +10009643
Guido van Rossum54ecc3d1999-01-27 17:53:11 +00009644#ifdef WEXITSTATUS
Larry Hastings2f936352014-08-05 14:04:04 +10009645/*[clinic input]
9646os.WEXITSTATUS -> int
9647
9648 status: int
9649
9650Return the process return code from status.
9651[clinic start generated code]*/
9652
Larry Hastings2f936352014-08-05 14:04:04 +10009653static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009654os_WEXITSTATUS_impl(PyObject *module, int status)
9655/*[clinic end generated code: output=6e3efbba11f6488d input=e1fb4944e377585b]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009656{
9657 WAIT_TYPE wait_status;
9658 WAIT_STATUS_INT(wait_status) = status;
9659 return WEXITSTATUS(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +00009660}
9661#endif /* WEXITSTATUS */
9662
Larry Hastings2f936352014-08-05 14:04:04 +10009663
Guido van Rossumc9641791998-08-04 15:26:23 +00009664#ifdef WTERMSIG
Larry Hastings2f936352014-08-05 14:04:04 +10009665/*[clinic input]
9666os.WTERMSIG -> int
9667
9668 status: int
9669
9670Return the signal that terminated the process that provided the status value.
9671[clinic start generated code]*/
9672
Larry Hastings2f936352014-08-05 14:04:04 +10009673static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009674os_WTERMSIG_impl(PyObject *module, int status)
9675/*[clinic end generated code: output=172f7dfc8dcfc3ad input=727fd7f84ec3f243]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009676{
9677 WAIT_TYPE wait_status;
9678 WAIT_STATUS_INT(wait_status) = status;
9679 return WTERMSIG(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +00009680}
9681#endif /* WTERMSIG */
9682
Larry Hastings2f936352014-08-05 14:04:04 +10009683
Guido van Rossumc9641791998-08-04 15:26:23 +00009684#ifdef WSTOPSIG
Larry Hastings2f936352014-08-05 14:04:04 +10009685/*[clinic input]
9686os.WSTOPSIG -> int
9687
9688 status: int
9689
9690Return the signal that stopped the process that provided the status value.
9691[clinic start generated code]*/
9692
Larry Hastings2f936352014-08-05 14:04:04 +10009693static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009694os_WSTOPSIG_impl(PyObject *module, int status)
9695/*[clinic end generated code: output=0ab7586396f5d82b input=46ebf1d1b293c5c1]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009696{
9697 WAIT_TYPE wait_status;
9698 WAIT_STATUS_INT(wait_status) = status;
9699 return WSTOPSIG(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +00009700}
9701#endif /* WSTOPSIG */
Guido van Rossumc9641791998-08-04 15:26:23 +00009702#endif /* HAVE_SYS_WAIT_H */
9703
9704
Thomas Wouters477c8d52006-05-27 19:21:47 +00009705#if defined(HAVE_FSTATVFS) && defined(HAVE_SYS_STATVFS_H)
Guido van Rossumd5753e11999-10-19 13:29:23 +00009706#ifdef _SCO_DS
9707/* SCO OpenServer 5.0 and later requires _SVID3 before it reveals the
9708 needed definitions in sys/statvfs.h */
9709#define _SVID3
9710#endif
Guido van Rossum94f6f721999-01-06 18:42:14 +00009711#include <sys/statvfs.h>
9712
Guido van Rossum98bf58f2001-10-18 20:34:25 +00009713static PyObject*
9714_pystatvfs_fromstructstatvfs(struct statvfs st) {
Victor Stinner8c62be82010-05-06 00:08:46 +00009715 PyObject *v = PyStructSequence_New(&StatVFSResultType);
9716 if (v == NULL)
9717 return NULL;
Guido van Rossum98bf58f2001-10-18 20:34:25 +00009718
9719#if !defined(HAVE_LARGEFILE_SUPPORT)
Victor Stinner8c62be82010-05-06 00:08:46 +00009720 PyStructSequence_SET_ITEM(v, 0, PyLong_FromLong((long) st.f_bsize));
9721 PyStructSequence_SET_ITEM(v, 1, PyLong_FromLong((long) st.f_frsize));
9722 PyStructSequence_SET_ITEM(v, 2, PyLong_FromLong((long) st.f_blocks));
9723 PyStructSequence_SET_ITEM(v, 3, PyLong_FromLong((long) st.f_bfree));
9724 PyStructSequence_SET_ITEM(v, 4, PyLong_FromLong((long) st.f_bavail));
9725 PyStructSequence_SET_ITEM(v, 5, PyLong_FromLong((long) st.f_files));
9726 PyStructSequence_SET_ITEM(v, 6, PyLong_FromLong((long) st.f_ffree));
9727 PyStructSequence_SET_ITEM(v, 7, PyLong_FromLong((long) st.f_favail));
9728 PyStructSequence_SET_ITEM(v, 8, PyLong_FromLong((long) st.f_flag));
9729 PyStructSequence_SET_ITEM(v, 9, PyLong_FromLong((long) st.f_namemax));
Guido van Rossum98bf58f2001-10-18 20:34:25 +00009730#else
Victor Stinner8c62be82010-05-06 00:08:46 +00009731 PyStructSequence_SET_ITEM(v, 0, PyLong_FromLong((long) st.f_bsize));
9732 PyStructSequence_SET_ITEM(v, 1, PyLong_FromLong((long) st.f_frsize));
9733 PyStructSequence_SET_ITEM(v, 2,
Benjamin Petersonaf580df2016-09-06 10:46:49 -07009734 PyLong_FromLongLong((long long) st.f_blocks));
Victor Stinner8c62be82010-05-06 00:08:46 +00009735 PyStructSequence_SET_ITEM(v, 3,
Benjamin Petersonaf580df2016-09-06 10:46:49 -07009736 PyLong_FromLongLong((long long) st.f_bfree));
Victor Stinner8c62be82010-05-06 00:08:46 +00009737 PyStructSequence_SET_ITEM(v, 4,
Benjamin Petersonaf580df2016-09-06 10:46:49 -07009738 PyLong_FromLongLong((long long) st.f_bavail));
Victor Stinner8c62be82010-05-06 00:08:46 +00009739 PyStructSequence_SET_ITEM(v, 5,
Benjamin Petersonaf580df2016-09-06 10:46:49 -07009740 PyLong_FromLongLong((long long) st.f_files));
Victor Stinner8c62be82010-05-06 00:08:46 +00009741 PyStructSequence_SET_ITEM(v, 6,
Benjamin Petersonaf580df2016-09-06 10:46:49 -07009742 PyLong_FromLongLong((long long) st.f_ffree));
Victor Stinner8c62be82010-05-06 00:08:46 +00009743 PyStructSequence_SET_ITEM(v, 7,
Benjamin Petersonaf580df2016-09-06 10:46:49 -07009744 PyLong_FromLongLong((long long) st.f_favail));
Victor Stinner8c62be82010-05-06 00:08:46 +00009745 PyStructSequence_SET_ITEM(v, 8, PyLong_FromLong((long) st.f_flag));
9746 PyStructSequence_SET_ITEM(v, 9, PyLong_FromLong((long) st.f_namemax));
Guido van Rossum98bf58f2001-10-18 20:34:25 +00009747#endif
Michael Felt502d5512018-01-05 13:01:58 +01009748/* The _ALL_SOURCE feature test macro defines f_fsid as a structure
9749 * (issue #32390). */
9750#if defined(_AIX) && defined(_ALL_SOURCE)
9751 PyStructSequence_SET_ITEM(v, 10, PyLong_FromUnsignedLong(st.f_fsid.val[0]));
9752#else
Giuseppe Scrivano96a5e502017-12-14 23:46:46 +01009753 PyStructSequence_SET_ITEM(v, 10, PyLong_FromUnsignedLong(st.f_fsid));
Michael Felt502d5512018-01-05 13:01:58 +01009754#endif
Victor Stinnerf0a7bac2013-10-30 18:55:24 +01009755 if (PyErr_Occurred()) {
9756 Py_DECREF(v);
9757 return NULL;
9758 }
Guido van Rossum98bf58f2001-10-18 20:34:25 +00009759
Victor Stinner8c62be82010-05-06 00:08:46 +00009760 return v;
Guido van Rossum98bf58f2001-10-18 20:34:25 +00009761}
9762
Larry Hastings2f936352014-08-05 14:04:04 +10009763
9764/*[clinic input]
9765os.fstatvfs
9766 fd: int
9767 /
9768
9769Perform an fstatvfs system call on the given fd.
9770
9771Equivalent to statvfs(fd).
9772[clinic start generated code]*/
9773
Larry Hastings2f936352014-08-05 14:04:04 +10009774static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009775os_fstatvfs_impl(PyObject *module, int fd)
9776/*[clinic end generated code: output=53547cf0cc55e6c5 input=d8122243ac50975e]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009777{
9778 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009779 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00009780 struct statvfs st;
Guido van Rossum98bf58f2001-10-18 20:34:25 +00009781
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009782 do {
9783 Py_BEGIN_ALLOW_THREADS
9784 result = fstatvfs(fd, &st);
9785 Py_END_ALLOW_THREADS
9786 } while (result != 0 && errno == EINTR &&
9787 !(async_err = PyErr_CheckSignals()));
Larry Hastings2f936352014-08-05 14:04:04 +10009788 if (result != 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009789 return (!async_err) ? posix_error() : NULL;
Guido van Rossum98bf58f2001-10-18 20:34:25 +00009790
Victor Stinner8c62be82010-05-06 00:08:46 +00009791 return _pystatvfs_fromstructstatvfs(st);
Guido van Rossum94f6f721999-01-06 18:42:14 +00009792}
Larry Hastings2f936352014-08-05 14:04:04 +10009793#endif /* defined(HAVE_FSTATVFS) && defined(HAVE_SYS_STATVFS_H) */
Guido van Rossum94f6f721999-01-06 18:42:14 +00009794
9795
Thomas Wouters477c8d52006-05-27 19:21:47 +00009796#if defined(HAVE_STATVFS) && defined(HAVE_SYS_STATVFS_H)
Guido van Rossum94f6f721999-01-06 18:42:14 +00009797#include <sys/statvfs.h>
Larry Hastings2f936352014-08-05 14:04:04 +10009798/*[clinic input]
9799os.statvfs
Guido van Rossum94f6f721999-01-06 18:42:14 +00009800
Larry Hastings2f936352014-08-05 14:04:04 +10009801 path: path_t(allow_fd='PATH_HAVE_FSTATVFS')
9802
9803Perform a statvfs system call on the given path.
9804
9805path may always be specified as a string.
9806On some platforms, path may also be specified as an open file descriptor.
9807 If this functionality is unavailable, using it raises an exception.
9808[clinic start generated code]*/
9809
Larry Hastings2f936352014-08-05 14:04:04 +10009810static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009811os_statvfs_impl(PyObject *module, path_t *path)
9812/*[clinic end generated code: output=87106dd1beb8556e input=3f5c35791c669bd9]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009813{
9814 int result;
9815 struct statvfs st;
Larry Hastings9cf065c2012-06-22 16:30:09 -07009816
9817 Py_BEGIN_ALLOW_THREADS
9818#ifdef HAVE_FSTATVFS
Larry Hastings2f936352014-08-05 14:04:04 +10009819 if (path->fd != -1) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07009820#ifdef __APPLE__
9821 /* handle weak-linking on Mac OS X 10.3 */
9822 if (fstatvfs == NULL) {
Larry Hastings2f936352014-08-05 14:04:04 +10009823 fd_specified("statvfs", path->fd);
9824 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07009825 }
9826#endif
Larry Hastings2f936352014-08-05 14:04:04 +10009827 result = fstatvfs(path->fd, &st);
Larry Hastings9cf065c2012-06-22 16:30:09 -07009828 }
9829 else
9830#endif
Larry Hastings2f936352014-08-05 14:04:04 +10009831 result = statvfs(path->narrow, &st);
Larry Hastings9cf065c2012-06-22 16:30:09 -07009832 Py_END_ALLOW_THREADS
9833
9834 if (result) {
Larry Hastings2f936352014-08-05 14:04:04 +10009835 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07009836 }
9837
Larry Hastings2f936352014-08-05 14:04:04 +10009838 return _pystatvfs_fromstructstatvfs(st);
Guido van Rossum94f6f721999-01-06 18:42:14 +00009839}
Larry Hastings2f936352014-08-05 14:04:04 +10009840#endif /* defined(HAVE_STATVFS) && defined(HAVE_SYS_STATVFS_H) */
9841
Guido van Rossum94f6f721999-01-06 18:42:14 +00009842
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +02009843#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10009844/*[clinic input]
9845os._getdiskusage
9846
9847 path: Py_UNICODE
9848
9849Return disk usage statistics about the given path as a (total, free) tuple.
9850[clinic start generated code]*/
9851
Larry Hastings2f936352014-08-05 14:04:04 +10009852static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009853os__getdiskusage_impl(PyObject *module, Py_UNICODE *path)
9854/*[clinic end generated code: output=76d6adcd86b1db0b input=6458133aed893c78]*/
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +02009855{
9856 BOOL retval;
9857 ULARGE_INTEGER _, total, free;
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +02009858
9859 Py_BEGIN_ALLOW_THREADS
Victor Stinner6139c1b2011-11-09 22:14:14 +01009860 retval = GetDiskFreeSpaceExW(path, &_, &total, &free);
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +02009861 Py_END_ALLOW_THREADS
9862 if (retval == 0)
9863 return PyErr_SetFromWindowsErr(0);
9864
9865 return Py_BuildValue("(LL)", total.QuadPart, free.QuadPart);
9866}
Larry Hastings2f936352014-08-05 14:04:04 +10009867#endif /* MS_WINDOWS */
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +02009868
9869
Fred Drakec9680921999-12-13 16:37:25 +00009870/* This is used for fpathconf(), pathconf(), confstr() and sysconf().
9871 * It maps strings representing configuration variable names to
9872 * integer values, allowing those functions to be called with the
Thomas Wouters7e474022000-07-16 12:04:32 +00009873 * magic names instead of polluting the module's namespace with tons of
Fred Drake12c6e2d1999-12-14 21:25:03 +00009874 * rarely-used constants. There are three separate tables that use
9875 * these definitions.
Fred Drakebec628d1999-12-15 18:31:10 +00009876 *
9877 * This code is always included, even if none of the interfaces that
9878 * need it are included. The #if hackery needed to avoid it would be
9879 * sufficiently pervasive that it's not worth the loss of readability.
Fred Drakec9680921999-12-13 16:37:25 +00009880 */
9881struct constdef {
Serhiy Storchaka2d06e842015-12-25 19:53:18 +02009882 const char *name;
Serhiy Storchaka56f6e762015-09-06 21:25:30 +03009883 int value;
Fred Drakec9680921999-12-13 16:37:25 +00009884};
9885
Fred Drake12c6e2d1999-12-14 21:25:03 +00009886static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +00009887conv_confname(PyObject *arg, int *valuep, struct constdef *table,
Guido van Rossum7d5baac2007-08-27 23:24:46 +00009888 size_t tablesize)
Fred Drake12c6e2d1999-12-14 21:25:03 +00009889{
Christian Heimes217cfd12007-12-02 14:31:20 +00009890 if (PyLong_Check(arg)) {
Serhiy Storchaka56f6e762015-09-06 21:25:30 +03009891 int value = _PyLong_AsInt(arg);
9892 if (value == -1 && PyErr_Occurred())
9893 return 0;
9894 *valuep = value;
Stefan Krah0e803b32010-11-26 16:16:47 +00009895 return 1;
Fred Drake12c6e2d1999-12-14 21:25:03 +00009896 }
Guido van Rossumbce56a62007-05-10 18:04:33 +00009897 else {
Stefan Krah0e803b32010-11-26 16:16:47 +00009898 /* look up the value in the table using a binary search */
9899 size_t lo = 0;
9900 size_t mid;
9901 size_t hi = tablesize;
9902 int cmp;
9903 const char *confname;
9904 if (!PyUnicode_Check(arg)) {
9905 PyErr_SetString(PyExc_TypeError,
9906 "configuration names must be strings or integers");
9907 return 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00009908 }
Serhiy Storchaka06515832016-11-20 09:13:07 +02009909 confname = PyUnicode_AsUTF8(arg);
Stefan Krah0e803b32010-11-26 16:16:47 +00009910 if (confname == NULL)
9911 return 0;
9912 while (lo < hi) {
9913 mid = (lo + hi) / 2;
9914 cmp = strcmp(confname, table[mid].name);
9915 if (cmp < 0)
9916 hi = mid;
9917 else if (cmp > 0)
9918 lo = mid + 1;
9919 else {
9920 *valuep = table[mid].value;
9921 return 1;
9922 }
9923 }
9924 PyErr_SetString(PyExc_ValueError, "unrecognized configuration name");
9925 return 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00009926 }
Fred Drake12c6e2d1999-12-14 21:25:03 +00009927}
9928
9929
9930#if defined(HAVE_FPATHCONF) || defined(HAVE_PATHCONF)
9931static struct constdef posix_constants_pathconf[] = {
Fred Draked86ed291999-12-15 15:34:33 +00009932#ifdef _PC_ABI_AIO_XFER_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +00009933 {"PC_ABI_AIO_XFER_MAX", _PC_ABI_AIO_XFER_MAX},
Fred Draked86ed291999-12-15 15:34:33 +00009934#endif
9935#ifdef _PC_ABI_ASYNC_IO
Victor Stinner8c62be82010-05-06 00:08:46 +00009936 {"PC_ABI_ASYNC_IO", _PC_ABI_ASYNC_IO},
Fred Draked86ed291999-12-15 15:34:33 +00009937#endif
Fred Drakec9680921999-12-13 16:37:25 +00009938#ifdef _PC_ASYNC_IO
Victor Stinner8c62be82010-05-06 00:08:46 +00009939 {"PC_ASYNC_IO", _PC_ASYNC_IO},
Fred Drakec9680921999-12-13 16:37:25 +00009940#endif
9941#ifdef _PC_CHOWN_RESTRICTED
Victor Stinner8c62be82010-05-06 00:08:46 +00009942 {"PC_CHOWN_RESTRICTED", _PC_CHOWN_RESTRICTED},
Fred Drakec9680921999-12-13 16:37:25 +00009943#endif
9944#ifdef _PC_FILESIZEBITS
Victor Stinner8c62be82010-05-06 00:08:46 +00009945 {"PC_FILESIZEBITS", _PC_FILESIZEBITS},
Fred Drakec9680921999-12-13 16:37:25 +00009946#endif
9947#ifdef _PC_LAST
Victor Stinner8c62be82010-05-06 00:08:46 +00009948 {"PC_LAST", _PC_LAST},
Fred Drakec9680921999-12-13 16:37:25 +00009949#endif
9950#ifdef _PC_LINK_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +00009951 {"PC_LINK_MAX", _PC_LINK_MAX},
Fred Drakec9680921999-12-13 16:37:25 +00009952#endif
9953#ifdef _PC_MAX_CANON
Victor Stinner8c62be82010-05-06 00:08:46 +00009954 {"PC_MAX_CANON", _PC_MAX_CANON},
Fred Drakec9680921999-12-13 16:37:25 +00009955#endif
9956#ifdef _PC_MAX_INPUT
Victor Stinner8c62be82010-05-06 00:08:46 +00009957 {"PC_MAX_INPUT", _PC_MAX_INPUT},
Fred Drakec9680921999-12-13 16:37:25 +00009958#endif
9959#ifdef _PC_NAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +00009960 {"PC_NAME_MAX", _PC_NAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +00009961#endif
9962#ifdef _PC_NO_TRUNC
Victor Stinner8c62be82010-05-06 00:08:46 +00009963 {"PC_NO_TRUNC", _PC_NO_TRUNC},
Fred Drakec9680921999-12-13 16:37:25 +00009964#endif
9965#ifdef _PC_PATH_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +00009966 {"PC_PATH_MAX", _PC_PATH_MAX},
Fred Drakec9680921999-12-13 16:37:25 +00009967#endif
9968#ifdef _PC_PIPE_BUF
Victor Stinner8c62be82010-05-06 00:08:46 +00009969 {"PC_PIPE_BUF", _PC_PIPE_BUF},
Fred Drakec9680921999-12-13 16:37:25 +00009970#endif
9971#ifdef _PC_PRIO_IO
Victor Stinner8c62be82010-05-06 00:08:46 +00009972 {"PC_PRIO_IO", _PC_PRIO_IO},
Fred Drakec9680921999-12-13 16:37:25 +00009973#endif
9974#ifdef _PC_SOCK_MAXBUF
Victor Stinner8c62be82010-05-06 00:08:46 +00009975 {"PC_SOCK_MAXBUF", _PC_SOCK_MAXBUF},
Fred Drakec9680921999-12-13 16:37:25 +00009976#endif
9977#ifdef _PC_SYNC_IO
Victor Stinner8c62be82010-05-06 00:08:46 +00009978 {"PC_SYNC_IO", _PC_SYNC_IO},
Fred Drakec9680921999-12-13 16:37:25 +00009979#endif
9980#ifdef _PC_VDISABLE
Victor Stinner8c62be82010-05-06 00:08:46 +00009981 {"PC_VDISABLE", _PC_VDISABLE},
Fred Drakec9680921999-12-13 16:37:25 +00009982#endif
Jesus Cea7e9065c2010-10-25 13:02:04 +00009983#ifdef _PC_ACL_ENABLED
9984 {"PC_ACL_ENABLED", _PC_ACL_ENABLED},
9985#endif
9986#ifdef _PC_MIN_HOLE_SIZE
9987 {"PC_MIN_HOLE_SIZE", _PC_MIN_HOLE_SIZE},
9988#endif
9989#ifdef _PC_ALLOC_SIZE_MIN
9990 {"PC_ALLOC_SIZE_MIN", _PC_ALLOC_SIZE_MIN},
9991#endif
9992#ifdef _PC_REC_INCR_XFER_SIZE
9993 {"PC_REC_INCR_XFER_SIZE", _PC_REC_INCR_XFER_SIZE},
9994#endif
9995#ifdef _PC_REC_MAX_XFER_SIZE
9996 {"PC_REC_MAX_XFER_SIZE", _PC_REC_MAX_XFER_SIZE},
9997#endif
9998#ifdef _PC_REC_MIN_XFER_SIZE
9999 {"PC_REC_MIN_XFER_SIZE", _PC_REC_MIN_XFER_SIZE},
10000#endif
10001#ifdef _PC_REC_XFER_ALIGN
10002 {"PC_REC_XFER_ALIGN", _PC_REC_XFER_ALIGN},
10003#endif
10004#ifdef _PC_SYMLINK_MAX
10005 {"PC_SYMLINK_MAX", _PC_SYMLINK_MAX},
10006#endif
10007#ifdef _PC_XATTR_ENABLED
10008 {"PC_XATTR_ENABLED", _PC_XATTR_ENABLED},
10009#endif
10010#ifdef _PC_XATTR_EXISTS
10011 {"PC_XATTR_EXISTS", _PC_XATTR_EXISTS},
10012#endif
10013#ifdef _PC_TIMESTAMP_RESOLUTION
10014 {"PC_TIMESTAMP_RESOLUTION", _PC_TIMESTAMP_RESOLUTION},
10015#endif
Fred Drakec9680921999-12-13 16:37:25 +000010016};
10017
Fred Drakec9680921999-12-13 16:37:25 +000010018static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000010019conv_path_confname(PyObject *arg, int *valuep)
Fred Drakec9680921999-12-13 16:37:25 +000010020{
10021 return conv_confname(arg, valuep, posix_constants_pathconf,
10022 sizeof(posix_constants_pathconf)
10023 / sizeof(struct constdef));
10024}
10025#endif
10026
Larry Hastings2f936352014-08-05 14:04:04 +100010027
Fred Drakec9680921999-12-13 16:37:25 +000010028#ifdef HAVE_FPATHCONF
Larry Hastings2f936352014-08-05 14:04:04 +100010029/*[clinic input]
10030os.fpathconf -> long
10031
10032 fd: int
10033 name: path_confname
10034 /
10035
10036Return the configuration limit name for the file descriptor fd.
10037
10038If there is no limit, return -1.
10039[clinic start generated code]*/
10040
Larry Hastings2f936352014-08-05 14:04:04 +100010041static long
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010042os_fpathconf_impl(PyObject *module, int fd, int name)
10043/*[clinic end generated code: output=d5b7042425fc3e21 input=5942a024d3777810]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010044{
10045 long limit;
10046
10047 errno = 0;
10048 limit = fpathconf(fd, name);
10049 if (limit == -1 && errno != 0)
10050 posix_error();
10051
10052 return limit;
10053}
10054#endif /* HAVE_FPATHCONF */
Fred Drakec9680921999-12-13 16:37:25 +000010055
10056
10057#ifdef HAVE_PATHCONF
Larry Hastings2f936352014-08-05 14:04:04 +100010058/*[clinic input]
10059os.pathconf -> long
10060 path: path_t(allow_fd='PATH_HAVE_FPATHCONF')
10061 name: path_confname
10062
10063Return the configuration limit name for the file or directory path.
10064
10065If there is no limit, return -1.
10066On some platforms, path may also be specified as an open file descriptor.
10067 If this functionality is unavailable, using it raises an exception.
10068[clinic start generated code]*/
10069
Larry Hastings2f936352014-08-05 14:04:04 +100010070static long
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010071os_pathconf_impl(PyObject *module, path_t *path, int name)
10072/*[clinic end generated code: output=5bedee35b293a089 input=bc3e2a985af27e5e]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010073{
Victor Stinner8c62be82010-05-06 00:08:46 +000010074 long limit;
Fred Drakec9680921999-12-13 16:37:25 +000010075
Victor Stinner8c62be82010-05-06 00:08:46 +000010076 errno = 0;
Georg Brandl306336b2012-06-24 12:55:33 +020010077#ifdef HAVE_FPATHCONF
Larry Hastings2f936352014-08-05 14:04:04 +100010078 if (path->fd != -1)
10079 limit = fpathconf(path->fd, name);
Georg Brandl306336b2012-06-24 12:55:33 +020010080 else
10081#endif
Larry Hastings2f936352014-08-05 14:04:04 +100010082 limit = pathconf(path->narrow, name);
Victor Stinner8c62be82010-05-06 00:08:46 +000010083 if (limit == -1 && errno != 0) {
10084 if (errno == EINVAL)
Stefan Krah99439262010-11-26 12:58:05 +000010085 /* could be a path or name problem */
10086 posix_error();
Fred Drakec9680921999-12-13 16:37:25 +000010087 else
Larry Hastings2f936352014-08-05 14:04:04 +100010088 path_error(path);
Victor Stinner8c62be82010-05-06 00:08:46 +000010089 }
Larry Hastings2f936352014-08-05 14:04:04 +100010090
10091 return limit;
Fred Drakec9680921999-12-13 16:37:25 +000010092}
Larry Hastings2f936352014-08-05 14:04:04 +100010093#endif /* HAVE_PATHCONF */
Fred Drakec9680921999-12-13 16:37:25 +000010094
10095#ifdef HAVE_CONFSTR
10096static struct constdef posix_constants_confstr[] = {
Fred Draked86ed291999-12-15 15:34:33 +000010097#ifdef _CS_ARCHITECTURE
Victor Stinner8c62be82010-05-06 00:08:46 +000010098 {"CS_ARCHITECTURE", _CS_ARCHITECTURE},
Fred Draked86ed291999-12-15 15:34:33 +000010099#endif
Mark Dickinson876d7c82010-04-16 12:47:52 +000010100#ifdef _CS_GNU_LIBC_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000010101 {"CS_GNU_LIBC_VERSION", _CS_GNU_LIBC_VERSION},
Mark Dickinson876d7c82010-04-16 12:47:52 +000010102#endif
10103#ifdef _CS_GNU_LIBPTHREAD_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000010104 {"CS_GNU_LIBPTHREAD_VERSION", _CS_GNU_LIBPTHREAD_VERSION},
Mark Dickinson876d7c82010-04-16 12:47:52 +000010105#endif
Fred Draked86ed291999-12-15 15:34:33 +000010106#ifdef _CS_HOSTNAME
Victor Stinner8c62be82010-05-06 00:08:46 +000010107 {"CS_HOSTNAME", _CS_HOSTNAME},
Fred Draked86ed291999-12-15 15:34:33 +000010108#endif
10109#ifdef _CS_HW_PROVIDER
Victor Stinner8c62be82010-05-06 00:08:46 +000010110 {"CS_HW_PROVIDER", _CS_HW_PROVIDER},
Fred Draked86ed291999-12-15 15:34:33 +000010111#endif
10112#ifdef _CS_HW_SERIAL
Victor Stinner8c62be82010-05-06 00:08:46 +000010113 {"CS_HW_SERIAL", _CS_HW_SERIAL},
Fred Draked86ed291999-12-15 15:34:33 +000010114#endif
10115#ifdef _CS_INITTAB_NAME
Victor Stinner8c62be82010-05-06 00:08:46 +000010116 {"CS_INITTAB_NAME", _CS_INITTAB_NAME},
Fred Draked86ed291999-12-15 15:34:33 +000010117#endif
Fred Drakec9680921999-12-13 16:37:25 +000010118#ifdef _CS_LFS64_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010119 {"CS_LFS64_CFLAGS", _CS_LFS64_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010120#endif
10121#ifdef _CS_LFS64_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010122 {"CS_LFS64_LDFLAGS", _CS_LFS64_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010123#endif
10124#ifdef _CS_LFS64_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000010125 {"CS_LFS64_LIBS", _CS_LFS64_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000010126#endif
10127#ifdef _CS_LFS64_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010128 {"CS_LFS64_LINTFLAGS", _CS_LFS64_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010129#endif
10130#ifdef _CS_LFS_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010131 {"CS_LFS_CFLAGS", _CS_LFS_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010132#endif
10133#ifdef _CS_LFS_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010134 {"CS_LFS_LDFLAGS", _CS_LFS_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010135#endif
10136#ifdef _CS_LFS_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000010137 {"CS_LFS_LIBS", _CS_LFS_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000010138#endif
10139#ifdef _CS_LFS_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010140 {"CS_LFS_LINTFLAGS", _CS_LFS_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010141#endif
Fred Draked86ed291999-12-15 15:34:33 +000010142#ifdef _CS_MACHINE
Victor Stinner8c62be82010-05-06 00:08:46 +000010143 {"CS_MACHINE", _CS_MACHINE},
Fred Draked86ed291999-12-15 15:34:33 +000010144#endif
Fred Drakec9680921999-12-13 16:37:25 +000010145#ifdef _CS_PATH
Victor Stinner8c62be82010-05-06 00:08:46 +000010146 {"CS_PATH", _CS_PATH},
Fred Drakec9680921999-12-13 16:37:25 +000010147#endif
Fred Draked86ed291999-12-15 15:34:33 +000010148#ifdef _CS_RELEASE
Victor Stinner8c62be82010-05-06 00:08:46 +000010149 {"CS_RELEASE", _CS_RELEASE},
Fred Draked86ed291999-12-15 15:34:33 +000010150#endif
10151#ifdef _CS_SRPC_DOMAIN
Victor Stinner8c62be82010-05-06 00:08:46 +000010152 {"CS_SRPC_DOMAIN", _CS_SRPC_DOMAIN},
Fred Draked86ed291999-12-15 15:34:33 +000010153#endif
10154#ifdef _CS_SYSNAME
Victor Stinner8c62be82010-05-06 00:08:46 +000010155 {"CS_SYSNAME", _CS_SYSNAME},
Fred Draked86ed291999-12-15 15:34:33 +000010156#endif
10157#ifdef _CS_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000010158 {"CS_VERSION", _CS_VERSION},
Fred Draked86ed291999-12-15 15:34:33 +000010159#endif
Fred Drakec9680921999-12-13 16:37:25 +000010160#ifdef _CS_XBS5_ILP32_OFF32_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010161 {"CS_XBS5_ILP32_OFF32_CFLAGS", _CS_XBS5_ILP32_OFF32_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010162#endif
10163#ifdef _CS_XBS5_ILP32_OFF32_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010164 {"CS_XBS5_ILP32_OFF32_LDFLAGS", _CS_XBS5_ILP32_OFF32_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010165#endif
10166#ifdef _CS_XBS5_ILP32_OFF32_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000010167 {"CS_XBS5_ILP32_OFF32_LIBS", _CS_XBS5_ILP32_OFF32_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000010168#endif
10169#ifdef _CS_XBS5_ILP32_OFF32_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010170 {"CS_XBS5_ILP32_OFF32_LINTFLAGS", _CS_XBS5_ILP32_OFF32_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010171#endif
10172#ifdef _CS_XBS5_ILP32_OFFBIG_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010173 {"CS_XBS5_ILP32_OFFBIG_CFLAGS", _CS_XBS5_ILP32_OFFBIG_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010174#endif
10175#ifdef _CS_XBS5_ILP32_OFFBIG_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010176 {"CS_XBS5_ILP32_OFFBIG_LDFLAGS", _CS_XBS5_ILP32_OFFBIG_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010177#endif
10178#ifdef _CS_XBS5_ILP32_OFFBIG_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000010179 {"CS_XBS5_ILP32_OFFBIG_LIBS", _CS_XBS5_ILP32_OFFBIG_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000010180#endif
10181#ifdef _CS_XBS5_ILP32_OFFBIG_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010182 {"CS_XBS5_ILP32_OFFBIG_LINTFLAGS", _CS_XBS5_ILP32_OFFBIG_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010183#endif
10184#ifdef _CS_XBS5_LP64_OFF64_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010185 {"CS_XBS5_LP64_OFF64_CFLAGS", _CS_XBS5_LP64_OFF64_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010186#endif
10187#ifdef _CS_XBS5_LP64_OFF64_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010188 {"CS_XBS5_LP64_OFF64_LDFLAGS", _CS_XBS5_LP64_OFF64_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010189#endif
10190#ifdef _CS_XBS5_LP64_OFF64_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000010191 {"CS_XBS5_LP64_OFF64_LIBS", _CS_XBS5_LP64_OFF64_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000010192#endif
10193#ifdef _CS_XBS5_LP64_OFF64_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010194 {"CS_XBS5_LP64_OFF64_LINTFLAGS", _CS_XBS5_LP64_OFF64_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010195#endif
10196#ifdef _CS_XBS5_LPBIG_OFFBIG_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010197 {"CS_XBS5_LPBIG_OFFBIG_CFLAGS", _CS_XBS5_LPBIG_OFFBIG_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010198#endif
10199#ifdef _CS_XBS5_LPBIG_OFFBIG_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010200 {"CS_XBS5_LPBIG_OFFBIG_LDFLAGS", _CS_XBS5_LPBIG_OFFBIG_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010201#endif
10202#ifdef _CS_XBS5_LPBIG_OFFBIG_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000010203 {"CS_XBS5_LPBIG_OFFBIG_LIBS", _CS_XBS5_LPBIG_OFFBIG_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000010204#endif
10205#ifdef _CS_XBS5_LPBIG_OFFBIG_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010206 {"CS_XBS5_LPBIG_OFFBIG_LINTFLAGS", _CS_XBS5_LPBIG_OFFBIG_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010207#endif
Fred Draked86ed291999-12-15 15:34:33 +000010208#ifdef _MIPS_CS_AVAIL_PROCESSORS
Victor Stinner8c62be82010-05-06 00:08:46 +000010209 {"MIPS_CS_AVAIL_PROCESSORS", _MIPS_CS_AVAIL_PROCESSORS},
Fred Draked86ed291999-12-15 15:34:33 +000010210#endif
10211#ifdef _MIPS_CS_BASE
Victor Stinner8c62be82010-05-06 00:08:46 +000010212 {"MIPS_CS_BASE", _MIPS_CS_BASE},
Fred Draked86ed291999-12-15 15:34:33 +000010213#endif
10214#ifdef _MIPS_CS_HOSTID
Victor Stinner8c62be82010-05-06 00:08:46 +000010215 {"MIPS_CS_HOSTID", _MIPS_CS_HOSTID},
Fred Draked86ed291999-12-15 15:34:33 +000010216#endif
10217#ifdef _MIPS_CS_HW_NAME
Victor Stinner8c62be82010-05-06 00:08:46 +000010218 {"MIPS_CS_HW_NAME", _MIPS_CS_HW_NAME},
Fred Draked86ed291999-12-15 15:34:33 +000010219#endif
10220#ifdef _MIPS_CS_NUM_PROCESSORS
Victor Stinner8c62be82010-05-06 00:08:46 +000010221 {"MIPS_CS_NUM_PROCESSORS", _MIPS_CS_NUM_PROCESSORS},
Fred Draked86ed291999-12-15 15:34:33 +000010222#endif
10223#ifdef _MIPS_CS_OSREL_MAJ
Victor Stinner8c62be82010-05-06 00:08:46 +000010224 {"MIPS_CS_OSREL_MAJ", _MIPS_CS_OSREL_MAJ},
Fred Draked86ed291999-12-15 15:34:33 +000010225#endif
10226#ifdef _MIPS_CS_OSREL_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000010227 {"MIPS_CS_OSREL_MIN", _MIPS_CS_OSREL_MIN},
Fred Draked86ed291999-12-15 15:34:33 +000010228#endif
10229#ifdef _MIPS_CS_OSREL_PATCH
Victor Stinner8c62be82010-05-06 00:08:46 +000010230 {"MIPS_CS_OSREL_PATCH", _MIPS_CS_OSREL_PATCH},
Fred Draked86ed291999-12-15 15:34:33 +000010231#endif
10232#ifdef _MIPS_CS_OS_NAME
Victor Stinner8c62be82010-05-06 00:08:46 +000010233 {"MIPS_CS_OS_NAME", _MIPS_CS_OS_NAME},
Fred Draked86ed291999-12-15 15:34:33 +000010234#endif
10235#ifdef _MIPS_CS_OS_PROVIDER
Victor Stinner8c62be82010-05-06 00:08:46 +000010236 {"MIPS_CS_OS_PROVIDER", _MIPS_CS_OS_PROVIDER},
Fred Draked86ed291999-12-15 15:34:33 +000010237#endif
10238#ifdef _MIPS_CS_PROCESSORS
Victor Stinner8c62be82010-05-06 00:08:46 +000010239 {"MIPS_CS_PROCESSORS", _MIPS_CS_PROCESSORS},
Fred Draked86ed291999-12-15 15:34:33 +000010240#endif
10241#ifdef _MIPS_CS_SERIAL
Victor Stinner8c62be82010-05-06 00:08:46 +000010242 {"MIPS_CS_SERIAL", _MIPS_CS_SERIAL},
Fred Draked86ed291999-12-15 15:34:33 +000010243#endif
10244#ifdef _MIPS_CS_VENDOR
Victor Stinner8c62be82010-05-06 00:08:46 +000010245 {"MIPS_CS_VENDOR", _MIPS_CS_VENDOR},
Fred Draked86ed291999-12-15 15:34:33 +000010246#endif
Fred Drakec9680921999-12-13 16:37:25 +000010247};
10248
10249static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000010250conv_confstr_confname(PyObject *arg, int *valuep)
Fred Drakec9680921999-12-13 16:37:25 +000010251{
10252 return conv_confname(arg, valuep, posix_constants_confstr,
10253 sizeof(posix_constants_confstr)
10254 / sizeof(struct constdef));
10255}
10256
Larry Hastings2f936352014-08-05 14:04:04 +100010257
10258/*[clinic input]
10259os.confstr
10260
10261 name: confstr_confname
10262 /
10263
10264Return a string-valued system configuration variable.
10265[clinic start generated code]*/
10266
Larry Hastings2f936352014-08-05 14:04:04 +100010267static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010268os_confstr_impl(PyObject *module, int name)
10269/*[clinic end generated code: output=bfb0b1b1e49b9383 input=18fb4d0567242e65]*/
Fred Drakec9680921999-12-13 16:37:25 +000010270{
10271 PyObject *result = NULL;
Victor Stinnercb043522010-09-10 23:49:04 +000010272 char buffer[255];
Victor Stinnerdd3a6a52013-06-25 23:13:47 +020010273 size_t len;
Fred Drakec9680921999-12-13 16:37:25 +000010274
Victor Stinnercb043522010-09-10 23:49:04 +000010275 errno = 0;
10276 len = confstr(name, buffer, sizeof(buffer));
10277 if (len == 0) {
10278 if (errno) {
10279 posix_error();
10280 return NULL;
Fred Drakec9680921999-12-13 16:37:25 +000010281 }
10282 else {
Victor Stinnercb043522010-09-10 23:49:04 +000010283 Py_RETURN_NONE;
Fred Drakec9680921999-12-13 16:37:25 +000010284 }
10285 }
Victor Stinnercb043522010-09-10 23:49:04 +000010286
Victor Stinnerdd3a6a52013-06-25 23:13:47 +020010287 if (len >= sizeof(buffer)) {
Victor Stinnercbc18f32014-12-05 22:51:51 +010010288 size_t len2;
Victor Stinnercb043522010-09-10 23:49:04 +000010289 char *buf = PyMem_Malloc(len);
10290 if (buf == NULL)
10291 return PyErr_NoMemory();
Victor Stinnercbc18f32014-12-05 22:51:51 +010010292 len2 = confstr(name, buf, len);
10293 assert(len == len2);
Christian Heimes8714cfd2015-04-21 10:57:41 +020010294 result = PyUnicode_DecodeFSDefaultAndSize(buf, len2-1);
Victor Stinnercb043522010-09-10 23:49:04 +000010295 PyMem_Free(buf);
10296 }
10297 else
10298 result = PyUnicode_DecodeFSDefaultAndSize(buffer, len-1);
Fred Drakec9680921999-12-13 16:37:25 +000010299 return result;
10300}
Larry Hastings2f936352014-08-05 14:04:04 +100010301#endif /* HAVE_CONFSTR */
Fred Drakec9680921999-12-13 16:37:25 +000010302
10303
10304#ifdef HAVE_SYSCONF
10305static struct constdef posix_constants_sysconf[] = {
10306#ifdef _SC_2_CHAR_TERM
Victor Stinner8c62be82010-05-06 00:08:46 +000010307 {"SC_2_CHAR_TERM", _SC_2_CHAR_TERM},
Fred Drakec9680921999-12-13 16:37:25 +000010308#endif
10309#ifdef _SC_2_C_BIND
Victor Stinner8c62be82010-05-06 00:08:46 +000010310 {"SC_2_C_BIND", _SC_2_C_BIND},
Fred Drakec9680921999-12-13 16:37:25 +000010311#endif
10312#ifdef _SC_2_C_DEV
Victor Stinner8c62be82010-05-06 00:08:46 +000010313 {"SC_2_C_DEV", _SC_2_C_DEV},
Fred Drakec9680921999-12-13 16:37:25 +000010314#endif
10315#ifdef _SC_2_C_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000010316 {"SC_2_C_VERSION", _SC_2_C_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000010317#endif
10318#ifdef _SC_2_FORT_DEV
Victor Stinner8c62be82010-05-06 00:08:46 +000010319 {"SC_2_FORT_DEV", _SC_2_FORT_DEV},
Fred Drakec9680921999-12-13 16:37:25 +000010320#endif
10321#ifdef _SC_2_FORT_RUN
Victor Stinner8c62be82010-05-06 00:08:46 +000010322 {"SC_2_FORT_RUN", _SC_2_FORT_RUN},
Fred Drakec9680921999-12-13 16:37:25 +000010323#endif
10324#ifdef _SC_2_LOCALEDEF
Victor Stinner8c62be82010-05-06 00:08:46 +000010325 {"SC_2_LOCALEDEF", _SC_2_LOCALEDEF},
Fred Drakec9680921999-12-13 16:37:25 +000010326#endif
10327#ifdef _SC_2_SW_DEV
Victor Stinner8c62be82010-05-06 00:08:46 +000010328 {"SC_2_SW_DEV", _SC_2_SW_DEV},
Fred Drakec9680921999-12-13 16:37:25 +000010329#endif
10330#ifdef _SC_2_UPE
Victor Stinner8c62be82010-05-06 00:08:46 +000010331 {"SC_2_UPE", _SC_2_UPE},
Fred Drakec9680921999-12-13 16:37:25 +000010332#endif
10333#ifdef _SC_2_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000010334 {"SC_2_VERSION", _SC_2_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000010335#endif
Fred Draked86ed291999-12-15 15:34:33 +000010336#ifdef _SC_ABI_ASYNCHRONOUS_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000010337 {"SC_ABI_ASYNCHRONOUS_IO", _SC_ABI_ASYNCHRONOUS_IO},
Fred Draked86ed291999-12-15 15:34:33 +000010338#endif
10339#ifdef _SC_ACL
Victor Stinner8c62be82010-05-06 00:08:46 +000010340 {"SC_ACL", _SC_ACL},
Fred Draked86ed291999-12-15 15:34:33 +000010341#endif
Fred Drakec9680921999-12-13 16:37:25 +000010342#ifdef _SC_AIO_LISTIO_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010343 {"SC_AIO_LISTIO_MAX", _SC_AIO_LISTIO_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010344#endif
Fred Drakec9680921999-12-13 16:37:25 +000010345#ifdef _SC_AIO_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010346 {"SC_AIO_MAX", _SC_AIO_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010347#endif
10348#ifdef _SC_AIO_PRIO_DELTA_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010349 {"SC_AIO_PRIO_DELTA_MAX", _SC_AIO_PRIO_DELTA_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010350#endif
10351#ifdef _SC_ARG_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010352 {"SC_ARG_MAX", _SC_ARG_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010353#endif
10354#ifdef _SC_ASYNCHRONOUS_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000010355 {"SC_ASYNCHRONOUS_IO", _SC_ASYNCHRONOUS_IO},
Fred Drakec9680921999-12-13 16:37:25 +000010356#endif
10357#ifdef _SC_ATEXIT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010358 {"SC_ATEXIT_MAX", _SC_ATEXIT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010359#endif
Fred Draked86ed291999-12-15 15:34:33 +000010360#ifdef _SC_AUDIT
Victor Stinner8c62be82010-05-06 00:08:46 +000010361 {"SC_AUDIT", _SC_AUDIT},
Fred Draked86ed291999-12-15 15:34:33 +000010362#endif
Fred Drakec9680921999-12-13 16:37:25 +000010363#ifdef _SC_AVPHYS_PAGES
Victor Stinner8c62be82010-05-06 00:08:46 +000010364 {"SC_AVPHYS_PAGES", _SC_AVPHYS_PAGES},
Fred Drakec9680921999-12-13 16:37:25 +000010365#endif
10366#ifdef _SC_BC_BASE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010367 {"SC_BC_BASE_MAX", _SC_BC_BASE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010368#endif
10369#ifdef _SC_BC_DIM_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010370 {"SC_BC_DIM_MAX", _SC_BC_DIM_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010371#endif
10372#ifdef _SC_BC_SCALE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010373 {"SC_BC_SCALE_MAX", _SC_BC_SCALE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010374#endif
10375#ifdef _SC_BC_STRING_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010376 {"SC_BC_STRING_MAX", _SC_BC_STRING_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010377#endif
Fred Draked86ed291999-12-15 15:34:33 +000010378#ifdef _SC_CAP
Victor Stinner8c62be82010-05-06 00:08:46 +000010379 {"SC_CAP", _SC_CAP},
Fred Draked86ed291999-12-15 15:34:33 +000010380#endif
Fred Drakec9680921999-12-13 16:37:25 +000010381#ifdef _SC_CHARCLASS_NAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010382 {"SC_CHARCLASS_NAME_MAX", _SC_CHARCLASS_NAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010383#endif
10384#ifdef _SC_CHAR_BIT
Victor Stinner8c62be82010-05-06 00:08:46 +000010385 {"SC_CHAR_BIT", _SC_CHAR_BIT},
Fred Drakec9680921999-12-13 16:37:25 +000010386#endif
10387#ifdef _SC_CHAR_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010388 {"SC_CHAR_MAX", _SC_CHAR_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010389#endif
10390#ifdef _SC_CHAR_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000010391 {"SC_CHAR_MIN", _SC_CHAR_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000010392#endif
10393#ifdef _SC_CHILD_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010394 {"SC_CHILD_MAX", _SC_CHILD_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010395#endif
10396#ifdef _SC_CLK_TCK
Victor Stinner8c62be82010-05-06 00:08:46 +000010397 {"SC_CLK_TCK", _SC_CLK_TCK},
Fred Drakec9680921999-12-13 16:37:25 +000010398#endif
10399#ifdef _SC_COHER_BLKSZ
Victor Stinner8c62be82010-05-06 00:08:46 +000010400 {"SC_COHER_BLKSZ", _SC_COHER_BLKSZ},
Fred Drakec9680921999-12-13 16:37:25 +000010401#endif
10402#ifdef _SC_COLL_WEIGHTS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010403 {"SC_COLL_WEIGHTS_MAX", _SC_COLL_WEIGHTS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010404#endif
10405#ifdef _SC_DCACHE_ASSOC
Victor Stinner8c62be82010-05-06 00:08:46 +000010406 {"SC_DCACHE_ASSOC", _SC_DCACHE_ASSOC},
Fred Drakec9680921999-12-13 16:37:25 +000010407#endif
10408#ifdef _SC_DCACHE_BLKSZ
Victor Stinner8c62be82010-05-06 00:08:46 +000010409 {"SC_DCACHE_BLKSZ", _SC_DCACHE_BLKSZ},
Fred Drakec9680921999-12-13 16:37:25 +000010410#endif
10411#ifdef _SC_DCACHE_LINESZ
Victor Stinner8c62be82010-05-06 00:08:46 +000010412 {"SC_DCACHE_LINESZ", _SC_DCACHE_LINESZ},
Fred Drakec9680921999-12-13 16:37:25 +000010413#endif
10414#ifdef _SC_DCACHE_SZ
Victor Stinner8c62be82010-05-06 00:08:46 +000010415 {"SC_DCACHE_SZ", _SC_DCACHE_SZ},
Fred Drakec9680921999-12-13 16:37:25 +000010416#endif
10417#ifdef _SC_DCACHE_TBLKSZ
Victor Stinner8c62be82010-05-06 00:08:46 +000010418 {"SC_DCACHE_TBLKSZ", _SC_DCACHE_TBLKSZ},
Fred Drakec9680921999-12-13 16:37:25 +000010419#endif
10420#ifdef _SC_DELAYTIMER_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010421 {"SC_DELAYTIMER_MAX", _SC_DELAYTIMER_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010422#endif
10423#ifdef _SC_EQUIV_CLASS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010424 {"SC_EQUIV_CLASS_MAX", _SC_EQUIV_CLASS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010425#endif
10426#ifdef _SC_EXPR_NEST_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010427 {"SC_EXPR_NEST_MAX", _SC_EXPR_NEST_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010428#endif
10429#ifdef _SC_FSYNC
Victor Stinner8c62be82010-05-06 00:08:46 +000010430 {"SC_FSYNC", _SC_FSYNC},
Fred Drakec9680921999-12-13 16:37:25 +000010431#endif
10432#ifdef _SC_GETGR_R_SIZE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010433 {"SC_GETGR_R_SIZE_MAX", _SC_GETGR_R_SIZE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010434#endif
10435#ifdef _SC_GETPW_R_SIZE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010436 {"SC_GETPW_R_SIZE_MAX", _SC_GETPW_R_SIZE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010437#endif
10438#ifdef _SC_ICACHE_ASSOC
Victor Stinner8c62be82010-05-06 00:08:46 +000010439 {"SC_ICACHE_ASSOC", _SC_ICACHE_ASSOC},
Fred Drakec9680921999-12-13 16:37:25 +000010440#endif
10441#ifdef _SC_ICACHE_BLKSZ
Victor Stinner8c62be82010-05-06 00:08:46 +000010442 {"SC_ICACHE_BLKSZ", _SC_ICACHE_BLKSZ},
Fred Drakec9680921999-12-13 16:37:25 +000010443#endif
10444#ifdef _SC_ICACHE_LINESZ
Victor Stinner8c62be82010-05-06 00:08:46 +000010445 {"SC_ICACHE_LINESZ", _SC_ICACHE_LINESZ},
Fred Drakec9680921999-12-13 16:37:25 +000010446#endif
10447#ifdef _SC_ICACHE_SZ
Victor Stinner8c62be82010-05-06 00:08:46 +000010448 {"SC_ICACHE_SZ", _SC_ICACHE_SZ},
Fred Drakec9680921999-12-13 16:37:25 +000010449#endif
Fred Draked86ed291999-12-15 15:34:33 +000010450#ifdef _SC_INF
Victor Stinner8c62be82010-05-06 00:08:46 +000010451 {"SC_INF", _SC_INF},
Fred Draked86ed291999-12-15 15:34:33 +000010452#endif
Fred Drakec9680921999-12-13 16:37:25 +000010453#ifdef _SC_INT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010454 {"SC_INT_MAX", _SC_INT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010455#endif
10456#ifdef _SC_INT_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000010457 {"SC_INT_MIN", _SC_INT_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000010458#endif
10459#ifdef _SC_IOV_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010460 {"SC_IOV_MAX", _SC_IOV_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010461#endif
Fred Draked86ed291999-12-15 15:34:33 +000010462#ifdef _SC_IP_SECOPTS
Victor Stinner8c62be82010-05-06 00:08:46 +000010463 {"SC_IP_SECOPTS", _SC_IP_SECOPTS},
Fred Draked86ed291999-12-15 15:34:33 +000010464#endif
Fred Drakec9680921999-12-13 16:37:25 +000010465#ifdef _SC_JOB_CONTROL
Victor Stinner8c62be82010-05-06 00:08:46 +000010466 {"SC_JOB_CONTROL", _SC_JOB_CONTROL},
Fred Drakec9680921999-12-13 16:37:25 +000010467#endif
Fred Draked86ed291999-12-15 15:34:33 +000010468#ifdef _SC_KERN_POINTERS
Victor Stinner8c62be82010-05-06 00:08:46 +000010469 {"SC_KERN_POINTERS", _SC_KERN_POINTERS},
Fred Draked86ed291999-12-15 15:34:33 +000010470#endif
10471#ifdef _SC_KERN_SIM
Victor Stinner8c62be82010-05-06 00:08:46 +000010472 {"SC_KERN_SIM", _SC_KERN_SIM},
Fred Draked86ed291999-12-15 15:34:33 +000010473#endif
Fred Drakec9680921999-12-13 16:37:25 +000010474#ifdef _SC_LINE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010475 {"SC_LINE_MAX", _SC_LINE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010476#endif
10477#ifdef _SC_LOGIN_NAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010478 {"SC_LOGIN_NAME_MAX", _SC_LOGIN_NAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010479#endif
10480#ifdef _SC_LOGNAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010481 {"SC_LOGNAME_MAX", _SC_LOGNAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010482#endif
10483#ifdef _SC_LONG_BIT
Victor Stinner8c62be82010-05-06 00:08:46 +000010484 {"SC_LONG_BIT", _SC_LONG_BIT},
Fred Drakec9680921999-12-13 16:37:25 +000010485#endif
Fred Draked86ed291999-12-15 15:34:33 +000010486#ifdef _SC_MAC
Victor Stinner8c62be82010-05-06 00:08:46 +000010487 {"SC_MAC", _SC_MAC},
Fred Draked86ed291999-12-15 15:34:33 +000010488#endif
Fred Drakec9680921999-12-13 16:37:25 +000010489#ifdef _SC_MAPPED_FILES
Victor Stinner8c62be82010-05-06 00:08:46 +000010490 {"SC_MAPPED_FILES", _SC_MAPPED_FILES},
Fred Drakec9680921999-12-13 16:37:25 +000010491#endif
10492#ifdef _SC_MAXPID
Victor Stinner8c62be82010-05-06 00:08:46 +000010493 {"SC_MAXPID", _SC_MAXPID},
Fred Drakec9680921999-12-13 16:37:25 +000010494#endif
10495#ifdef _SC_MB_LEN_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010496 {"SC_MB_LEN_MAX", _SC_MB_LEN_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010497#endif
10498#ifdef _SC_MEMLOCK
Victor Stinner8c62be82010-05-06 00:08:46 +000010499 {"SC_MEMLOCK", _SC_MEMLOCK},
Fred Drakec9680921999-12-13 16:37:25 +000010500#endif
10501#ifdef _SC_MEMLOCK_RANGE
Victor Stinner8c62be82010-05-06 00:08:46 +000010502 {"SC_MEMLOCK_RANGE", _SC_MEMLOCK_RANGE},
Fred Drakec9680921999-12-13 16:37:25 +000010503#endif
10504#ifdef _SC_MEMORY_PROTECTION
Victor Stinner8c62be82010-05-06 00:08:46 +000010505 {"SC_MEMORY_PROTECTION", _SC_MEMORY_PROTECTION},
Fred Drakec9680921999-12-13 16:37:25 +000010506#endif
10507#ifdef _SC_MESSAGE_PASSING
Victor Stinner8c62be82010-05-06 00:08:46 +000010508 {"SC_MESSAGE_PASSING", _SC_MESSAGE_PASSING},
Fred Drakec9680921999-12-13 16:37:25 +000010509#endif
Fred Draked86ed291999-12-15 15:34:33 +000010510#ifdef _SC_MMAP_FIXED_ALIGNMENT
Victor Stinner8c62be82010-05-06 00:08:46 +000010511 {"SC_MMAP_FIXED_ALIGNMENT", _SC_MMAP_FIXED_ALIGNMENT},
Fred Draked86ed291999-12-15 15:34:33 +000010512#endif
Fred Drakec9680921999-12-13 16:37:25 +000010513#ifdef _SC_MQ_OPEN_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010514 {"SC_MQ_OPEN_MAX", _SC_MQ_OPEN_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010515#endif
10516#ifdef _SC_MQ_PRIO_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010517 {"SC_MQ_PRIO_MAX", _SC_MQ_PRIO_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010518#endif
Fred Draked86ed291999-12-15 15:34:33 +000010519#ifdef _SC_NACLS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010520 {"SC_NACLS_MAX", _SC_NACLS_MAX},
Fred Draked86ed291999-12-15 15:34:33 +000010521#endif
Fred Drakec9680921999-12-13 16:37:25 +000010522#ifdef _SC_NGROUPS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010523 {"SC_NGROUPS_MAX", _SC_NGROUPS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010524#endif
10525#ifdef _SC_NL_ARGMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010526 {"SC_NL_ARGMAX", _SC_NL_ARGMAX},
Fred Drakec9680921999-12-13 16:37:25 +000010527#endif
10528#ifdef _SC_NL_LANGMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010529 {"SC_NL_LANGMAX", _SC_NL_LANGMAX},
Fred Drakec9680921999-12-13 16:37:25 +000010530#endif
10531#ifdef _SC_NL_MSGMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010532 {"SC_NL_MSGMAX", _SC_NL_MSGMAX},
Fred Drakec9680921999-12-13 16:37:25 +000010533#endif
10534#ifdef _SC_NL_NMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010535 {"SC_NL_NMAX", _SC_NL_NMAX},
Fred Drakec9680921999-12-13 16:37:25 +000010536#endif
10537#ifdef _SC_NL_SETMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010538 {"SC_NL_SETMAX", _SC_NL_SETMAX},
Fred Drakec9680921999-12-13 16:37:25 +000010539#endif
10540#ifdef _SC_NL_TEXTMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010541 {"SC_NL_TEXTMAX", _SC_NL_TEXTMAX},
Fred Drakec9680921999-12-13 16:37:25 +000010542#endif
10543#ifdef _SC_NPROCESSORS_CONF
Victor Stinner8c62be82010-05-06 00:08:46 +000010544 {"SC_NPROCESSORS_CONF", _SC_NPROCESSORS_CONF},
Fred Drakec9680921999-12-13 16:37:25 +000010545#endif
10546#ifdef _SC_NPROCESSORS_ONLN
Victor Stinner8c62be82010-05-06 00:08:46 +000010547 {"SC_NPROCESSORS_ONLN", _SC_NPROCESSORS_ONLN},
Fred Drakec9680921999-12-13 16:37:25 +000010548#endif
Fred Draked86ed291999-12-15 15:34:33 +000010549#ifdef _SC_NPROC_CONF
Victor Stinner8c62be82010-05-06 00:08:46 +000010550 {"SC_NPROC_CONF", _SC_NPROC_CONF},
Fred Draked86ed291999-12-15 15:34:33 +000010551#endif
10552#ifdef _SC_NPROC_ONLN
Victor Stinner8c62be82010-05-06 00:08:46 +000010553 {"SC_NPROC_ONLN", _SC_NPROC_ONLN},
Fred Draked86ed291999-12-15 15:34:33 +000010554#endif
Fred Drakec9680921999-12-13 16:37:25 +000010555#ifdef _SC_NZERO
Victor Stinner8c62be82010-05-06 00:08:46 +000010556 {"SC_NZERO", _SC_NZERO},
Fred Drakec9680921999-12-13 16:37:25 +000010557#endif
10558#ifdef _SC_OPEN_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010559 {"SC_OPEN_MAX", _SC_OPEN_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010560#endif
10561#ifdef _SC_PAGESIZE
Victor Stinner8c62be82010-05-06 00:08:46 +000010562 {"SC_PAGESIZE", _SC_PAGESIZE},
Fred Drakec9680921999-12-13 16:37:25 +000010563#endif
10564#ifdef _SC_PAGE_SIZE
Victor Stinner8c62be82010-05-06 00:08:46 +000010565 {"SC_PAGE_SIZE", _SC_PAGE_SIZE},
Fred Drakec9680921999-12-13 16:37:25 +000010566#endif
10567#ifdef _SC_PASS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010568 {"SC_PASS_MAX", _SC_PASS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010569#endif
10570#ifdef _SC_PHYS_PAGES
Victor Stinner8c62be82010-05-06 00:08:46 +000010571 {"SC_PHYS_PAGES", _SC_PHYS_PAGES},
Fred Drakec9680921999-12-13 16:37:25 +000010572#endif
10573#ifdef _SC_PII
Victor Stinner8c62be82010-05-06 00:08:46 +000010574 {"SC_PII", _SC_PII},
Fred Drakec9680921999-12-13 16:37:25 +000010575#endif
10576#ifdef _SC_PII_INTERNET
Victor Stinner8c62be82010-05-06 00:08:46 +000010577 {"SC_PII_INTERNET", _SC_PII_INTERNET},
Fred Drakec9680921999-12-13 16:37:25 +000010578#endif
10579#ifdef _SC_PII_INTERNET_DGRAM
Victor Stinner8c62be82010-05-06 00:08:46 +000010580 {"SC_PII_INTERNET_DGRAM", _SC_PII_INTERNET_DGRAM},
Fred Drakec9680921999-12-13 16:37:25 +000010581#endif
10582#ifdef _SC_PII_INTERNET_STREAM
Victor Stinner8c62be82010-05-06 00:08:46 +000010583 {"SC_PII_INTERNET_STREAM", _SC_PII_INTERNET_STREAM},
Fred Drakec9680921999-12-13 16:37:25 +000010584#endif
10585#ifdef _SC_PII_OSI
Victor Stinner8c62be82010-05-06 00:08:46 +000010586 {"SC_PII_OSI", _SC_PII_OSI},
Fred Drakec9680921999-12-13 16:37:25 +000010587#endif
10588#ifdef _SC_PII_OSI_CLTS
Victor Stinner8c62be82010-05-06 00:08:46 +000010589 {"SC_PII_OSI_CLTS", _SC_PII_OSI_CLTS},
Fred Drakec9680921999-12-13 16:37:25 +000010590#endif
10591#ifdef _SC_PII_OSI_COTS
Victor Stinner8c62be82010-05-06 00:08:46 +000010592 {"SC_PII_OSI_COTS", _SC_PII_OSI_COTS},
Fred Drakec9680921999-12-13 16:37:25 +000010593#endif
10594#ifdef _SC_PII_OSI_M
Victor Stinner8c62be82010-05-06 00:08:46 +000010595 {"SC_PII_OSI_M", _SC_PII_OSI_M},
Fred Drakec9680921999-12-13 16:37:25 +000010596#endif
10597#ifdef _SC_PII_SOCKET
Victor Stinner8c62be82010-05-06 00:08:46 +000010598 {"SC_PII_SOCKET", _SC_PII_SOCKET},
Fred Drakec9680921999-12-13 16:37:25 +000010599#endif
10600#ifdef _SC_PII_XTI
Victor Stinner8c62be82010-05-06 00:08:46 +000010601 {"SC_PII_XTI", _SC_PII_XTI},
Fred Drakec9680921999-12-13 16:37:25 +000010602#endif
10603#ifdef _SC_POLL
Victor Stinner8c62be82010-05-06 00:08:46 +000010604 {"SC_POLL", _SC_POLL},
Fred Drakec9680921999-12-13 16:37:25 +000010605#endif
10606#ifdef _SC_PRIORITIZED_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000010607 {"SC_PRIORITIZED_IO", _SC_PRIORITIZED_IO},
Fred Drakec9680921999-12-13 16:37:25 +000010608#endif
10609#ifdef _SC_PRIORITY_SCHEDULING
Victor Stinner8c62be82010-05-06 00:08:46 +000010610 {"SC_PRIORITY_SCHEDULING", _SC_PRIORITY_SCHEDULING},
Fred Drakec9680921999-12-13 16:37:25 +000010611#endif
10612#ifdef _SC_REALTIME_SIGNALS
Victor Stinner8c62be82010-05-06 00:08:46 +000010613 {"SC_REALTIME_SIGNALS", _SC_REALTIME_SIGNALS},
Fred Drakec9680921999-12-13 16:37:25 +000010614#endif
10615#ifdef _SC_RE_DUP_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010616 {"SC_RE_DUP_MAX", _SC_RE_DUP_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010617#endif
10618#ifdef _SC_RTSIG_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010619 {"SC_RTSIG_MAX", _SC_RTSIG_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010620#endif
10621#ifdef _SC_SAVED_IDS
Victor Stinner8c62be82010-05-06 00:08:46 +000010622 {"SC_SAVED_IDS", _SC_SAVED_IDS},
Fred Drakec9680921999-12-13 16:37:25 +000010623#endif
10624#ifdef _SC_SCHAR_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010625 {"SC_SCHAR_MAX", _SC_SCHAR_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010626#endif
10627#ifdef _SC_SCHAR_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000010628 {"SC_SCHAR_MIN", _SC_SCHAR_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000010629#endif
10630#ifdef _SC_SELECT
Victor Stinner8c62be82010-05-06 00:08:46 +000010631 {"SC_SELECT", _SC_SELECT},
Fred Drakec9680921999-12-13 16:37:25 +000010632#endif
10633#ifdef _SC_SEMAPHORES
Victor Stinner8c62be82010-05-06 00:08:46 +000010634 {"SC_SEMAPHORES", _SC_SEMAPHORES},
Fred Drakec9680921999-12-13 16:37:25 +000010635#endif
10636#ifdef _SC_SEM_NSEMS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010637 {"SC_SEM_NSEMS_MAX", _SC_SEM_NSEMS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010638#endif
10639#ifdef _SC_SEM_VALUE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010640 {"SC_SEM_VALUE_MAX", _SC_SEM_VALUE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010641#endif
10642#ifdef _SC_SHARED_MEMORY_OBJECTS
Victor Stinner8c62be82010-05-06 00:08:46 +000010643 {"SC_SHARED_MEMORY_OBJECTS", _SC_SHARED_MEMORY_OBJECTS},
Fred Drakec9680921999-12-13 16:37:25 +000010644#endif
10645#ifdef _SC_SHRT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010646 {"SC_SHRT_MAX", _SC_SHRT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010647#endif
10648#ifdef _SC_SHRT_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000010649 {"SC_SHRT_MIN", _SC_SHRT_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000010650#endif
10651#ifdef _SC_SIGQUEUE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010652 {"SC_SIGQUEUE_MAX", _SC_SIGQUEUE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010653#endif
10654#ifdef _SC_SIGRT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010655 {"SC_SIGRT_MAX", _SC_SIGRT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010656#endif
10657#ifdef _SC_SIGRT_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000010658 {"SC_SIGRT_MIN", _SC_SIGRT_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000010659#endif
Fred Draked86ed291999-12-15 15:34:33 +000010660#ifdef _SC_SOFTPOWER
Victor Stinner8c62be82010-05-06 00:08:46 +000010661 {"SC_SOFTPOWER", _SC_SOFTPOWER},
Fred Draked86ed291999-12-15 15:34:33 +000010662#endif
Fred Drakec9680921999-12-13 16:37:25 +000010663#ifdef _SC_SPLIT_CACHE
Victor Stinner8c62be82010-05-06 00:08:46 +000010664 {"SC_SPLIT_CACHE", _SC_SPLIT_CACHE},
Fred Drakec9680921999-12-13 16:37:25 +000010665#endif
10666#ifdef _SC_SSIZE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010667 {"SC_SSIZE_MAX", _SC_SSIZE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010668#endif
10669#ifdef _SC_STACK_PROT
Victor Stinner8c62be82010-05-06 00:08:46 +000010670 {"SC_STACK_PROT", _SC_STACK_PROT},
Fred Drakec9680921999-12-13 16:37:25 +000010671#endif
10672#ifdef _SC_STREAM_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010673 {"SC_STREAM_MAX", _SC_STREAM_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010674#endif
10675#ifdef _SC_SYNCHRONIZED_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000010676 {"SC_SYNCHRONIZED_IO", _SC_SYNCHRONIZED_IO},
Fred Drakec9680921999-12-13 16:37:25 +000010677#endif
10678#ifdef _SC_THREADS
Victor Stinner8c62be82010-05-06 00:08:46 +000010679 {"SC_THREADS", _SC_THREADS},
Fred Drakec9680921999-12-13 16:37:25 +000010680#endif
10681#ifdef _SC_THREAD_ATTR_STACKADDR
Victor Stinner8c62be82010-05-06 00:08:46 +000010682 {"SC_THREAD_ATTR_STACKADDR", _SC_THREAD_ATTR_STACKADDR},
Fred Drakec9680921999-12-13 16:37:25 +000010683#endif
10684#ifdef _SC_THREAD_ATTR_STACKSIZE
Victor Stinner8c62be82010-05-06 00:08:46 +000010685 {"SC_THREAD_ATTR_STACKSIZE", _SC_THREAD_ATTR_STACKSIZE},
Fred Drakec9680921999-12-13 16:37:25 +000010686#endif
10687#ifdef _SC_THREAD_DESTRUCTOR_ITERATIONS
Victor Stinner8c62be82010-05-06 00:08:46 +000010688 {"SC_THREAD_DESTRUCTOR_ITERATIONS", _SC_THREAD_DESTRUCTOR_ITERATIONS},
Fred Drakec9680921999-12-13 16:37:25 +000010689#endif
10690#ifdef _SC_THREAD_KEYS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010691 {"SC_THREAD_KEYS_MAX", _SC_THREAD_KEYS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010692#endif
10693#ifdef _SC_THREAD_PRIORITY_SCHEDULING
Victor Stinner8c62be82010-05-06 00:08:46 +000010694 {"SC_THREAD_PRIORITY_SCHEDULING", _SC_THREAD_PRIORITY_SCHEDULING},
Fred Drakec9680921999-12-13 16:37:25 +000010695#endif
10696#ifdef _SC_THREAD_PRIO_INHERIT
Victor Stinner8c62be82010-05-06 00:08:46 +000010697 {"SC_THREAD_PRIO_INHERIT", _SC_THREAD_PRIO_INHERIT},
Fred Drakec9680921999-12-13 16:37:25 +000010698#endif
10699#ifdef _SC_THREAD_PRIO_PROTECT
Victor Stinner8c62be82010-05-06 00:08:46 +000010700 {"SC_THREAD_PRIO_PROTECT", _SC_THREAD_PRIO_PROTECT},
Fred Drakec9680921999-12-13 16:37:25 +000010701#endif
10702#ifdef _SC_THREAD_PROCESS_SHARED
Victor Stinner8c62be82010-05-06 00:08:46 +000010703 {"SC_THREAD_PROCESS_SHARED", _SC_THREAD_PROCESS_SHARED},
Fred Drakec9680921999-12-13 16:37:25 +000010704#endif
10705#ifdef _SC_THREAD_SAFE_FUNCTIONS
Victor Stinner8c62be82010-05-06 00:08:46 +000010706 {"SC_THREAD_SAFE_FUNCTIONS", _SC_THREAD_SAFE_FUNCTIONS},
Fred Drakec9680921999-12-13 16:37:25 +000010707#endif
10708#ifdef _SC_THREAD_STACK_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000010709 {"SC_THREAD_STACK_MIN", _SC_THREAD_STACK_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000010710#endif
10711#ifdef _SC_THREAD_THREADS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010712 {"SC_THREAD_THREADS_MAX", _SC_THREAD_THREADS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010713#endif
10714#ifdef _SC_TIMERS
Victor Stinner8c62be82010-05-06 00:08:46 +000010715 {"SC_TIMERS", _SC_TIMERS},
Fred Drakec9680921999-12-13 16:37:25 +000010716#endif
10717#ifdef _SC_TIMER_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010718 {"SC_TIMER_MAX", _SC_TIMER_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010719#endif
10720#ifdef _SC_TTY_NAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010721 {"SC_TTY_NAME_MAX", _SC_TTY_NAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010722#endif
10723#ifdef _SC_TZNAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010724 {"SC_TZNAME_MAX", _SC_TZNAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010725#endif
10726#ifdef _SC_T_IOV_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010727 {"SC_T_IOV_MAX", _SC_T_IOV_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010728#endif
10729#ifdef _SC_UCHAR_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010730 {"SC_UCHAR_MAX", _SC_UCHAR_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010731#endif
10732#ifdef _SC_UINT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010733 {"SC_UINT_MAX", _SC_UINT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010734#endif
10735#ifdef _SC_UIO_MAXIOV
Victor Stinner8c62be82010-05-06 00:08:46 +000010736 {"SC_UIO_MAXIOV", _SC_UIO_MAXIOV},
Fred Drakec9680921999-12-13 16:37:25 +000010737#endif
10738#ifdef _SC_ULONG_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010739 {"SC_ULONG_MAX", _SC_ULONG_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010740#endif
10741#ifdef _SC_USHRT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010742 {"SC_USHRT_MAX", _SC_USHRT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010743#endif
10744#ifdef _SC_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000010745 {"SC_VERSION", _SC_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000010746#endif
10747#ifdef _SC_WORD_BIT
Victor Stinner8c62be82010-05-06 00:08:46 +000010748 {"SC_WORD_BIT", _SC_WORD_BIT},
Fred Drakec9680921999-12-13 16:37:25 +000010749#endif
10750#ifdef _SC_XBS5_ILP32_OFF32
Victor Stinner8c62be82010-05-06 00:08:46 +000010751 {"SC_XBS5_ILP32_OFF32", _SC_XBS5_ILP32_OFF32},
Fred Drakec9680921999-12-13 16:37:25 +000010752#endif
10753#ifdef _SC_XBS5_ILP32_OFFBIG
Victor Stinner8c62be82010-05-06 00:08:46 +000010754 {"SC_XBS5_ILP32_OFFBIG", _SC_XBS5_ILP32_OFFBIG},
Fred Drakec9680921999-12-13 16:37:25 +000010755#endif
10756#ifdef _SC_XBS5_LP64_OFF64
Victor Stinner8c62be82010-05-06 00:08:46 +000010757 {"SC_XBS5_LP64_OFF64", _SC_XBS5_LP64_OFF64},
Fred Drakec9680921999-12-13 16:37:25 +000010758#endif
10759#ifdef _SC_XBS5_LPBIG_OFFBIG
Victor Stinner8c62be82010-05-06 00:08:46 +000010760 {"SC_XBS5_LPBIG_OFFBIG", _SC_XBS5_LPBIG_OFFBIG},
Fred Drakec9680921999-12-13 16:37:25 +000010761#endif
10762#ifdef _SC_XOPEN_CRYPT
Victor Stinner8c62be82010-05-06 00:08:46 +000010763 {"SC_XOPEN_CRYPT", _SC_XOPEN_CRYPT},
Fred Drakec9680921999-12-13 16:37:25 +000010764#endif
10765#ifdef _SC_XOPEN_ENH_I18N
Victor Stinner8c62be82010-05-06 00:08:46 +000010766 {"SC_XOPEN_ENH_I18N", _SC_XOPEN_ENH_I18N},
Fred Drakec9680921999-12-13 16:37:25 +000010767#endif
10768#ifdef _SC_XOPEN_LEGACY
Victor Stinner8c62be82010-05-06 00:08:46 +000010769 {"SC_XOPEN_LEGACY", _SC_XOPEN_LEGACY},
Fred Drakec9680921999-12-13 16:37:25 +000010770#endif
10771#ifdef _SC_XOPEN_REALTIME
Victor Stinner8c62be82010-05-06 00:08:46 +000010772 {"SC_XOPEN_REALTIME", _SC_XOPEN_REALTIME},
Fred Drakec9680921999-12-13 16:37:25 +000010773#endif
10774#ifdef _SC_XOPEN_REALTIME_THREADS
Victor Stinner8c62be82010-05-06 00:08:46 +000010775 {"SC_XOPEN_REALTIME_THREADS", _SC_XOPEN_REALTIME_THREADS},
Fred Drakec9680921999-12-13 16:37:25 +000010776#endif
10777#ifdef _SC_XOPEN_SHM
Victor Stinner8c62be82010-05-06 00:08:46 +000010778 {"SC_XOPEN_SHM", _SC_XOPEN_SHM},
Fred Drakec9680921999-12-13 16:37:25 +000010779#endif
10780#ifdef _SC_XOPEN_UNIX
Victor Stinner8c62be82010-05-06 00:08:46 +000010781 {"SC_XOPEN_UNIX", _SC_XOPEN_UNIX},
Fred Drakec9680921999-12-13 16:37:25 +000010782#endif
10783#ifdef _SC_XOPEN_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000010784 {"SC_XOPEN_VERSION", _SC_XOPEN_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000010785#endif
10786#ifdef _SC_XOPEN_XCU_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000010787 {"SC_XOPEN_XCU_VERSION", _SC_XOPEN_XCU_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000010788#endif
10789#ifdef _SC_XOPEN_XPG2
Victor Stinner8c62be82010-05-06 00:08:46 +000010790 {"SC_XOPEN_XPG2", _SC_XOPEN_XPG2},
Fred Drakec9680921999-12-13 16:37:25 +000010791#endif
10792#ifdef _SC_XOPEN_XPG3
Victor Stinner8c62be82010-05-06 00:08:46 +000010793 {"SC_XOPEN_XPG3", _SC_XOPEN_XPG3},
Fred Drakec9680921999-12-13 16:37:25 +000010794#endif
10795#ifdef _SC_XOPEN_XPG4
Victor Stinner8c62be82010-05-06 00:08:46 +000010796 {"SC_XOPEN_XPG4", _SC_XOPEN_XPG4},
Fred Drakec9680921999-12-13 16:37:25 +000010797#endif
10798};
10799
10800static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000010801conv_sysconf_confname(PyObject *arg, int *valuep)
Fred Drakec9680921999-12-13 16:37:25 +000010802{
10803 return conv_confname(arg, valuep, posix_constants_sysconf,
10804 sizeof(posix_constants_sysconf)
10805 / sizeof(struct constdef));
10806}
10807
Larry Hastings2f936352014-08-05 14:04:04 +100010808
10809/*[clinic input]
10810os.sysconf -> long
10811 name: sysconf_confname
10812 /
10813
10814Return an integer-valued system configuration variable.
10815[clinic start generated code]*/
10816
Larry Hastings2f936352014-08-05 14:04:04 +100010817static long
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010818os_sysconf_impl(PyObject *module, int name)
10819/*[clinic end generated code: output=3662f945fc0cc756 input=279e3430a33f29e4]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010820{
10821 long value;
10822
10823 errno = 0;
10824 value = sysconf(name);
10825 if (value == -1 && errno != 0)
10826 posix_error();
10827 return value;
10828}
10829#endif /* HAVE_SYSCONF */
Fred Drakec9680921999-12-13 16:37:25 +000010830
10831
Fred Drakebec628d1999-12-15 18:31:10 +000010832/* This code is used to ensure that the tables of configuration value names
Serhiy Storchaka56a6d852014-12-01 18:28:43 +020010833 * are in sorted order as required by conv_confname(), and also to build
Fred Drakebec628d1999-12-15 18:31:10 +000010834 * the exported dictionaries that are used to publish information about the
10835 * names available on the host platform.
10836 *
10837 * Sorting the table at runtime ensures that the table is properly ordered
10838 * when used, even for platforms we're not able to test on. It also makes
10839 * it easier to add additional entries to the tables.
Fred Draked86ed291999-12-15 15:34:33 +000010840 */
Fred Drakebec628d1999-12-15 18:31:10 +000010841
10842static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000010843cmp_constdefs(const void *v1, const void *v2)
Fred Drakebec628d1999-12-15 18:31:10 +000010844{
10845 const struct constdef *c1 =
Victor Stinner8c62be82010-05-06 00:08:46 +000010846 (const struct constdef *) v1;
Fred Drakebec628d1999-12-15 18:31:10 +000010847 const struct constdef *c2 =
Victor Stinner8c62be82010-05-06 00:08:46 +000010848 (const struct constdef *) v2;
Fred Drakebec628d1999-12-15 18:31:10 +000010849
10850 return strcmp(c1->name, c2->name);
10851}
10852
10853static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000010854setup_confname_table(struct constdef *table, size_t tablesize,
Serhiy Storchakadeab18d2016-05-07 16:45:18 +030010855 const char *tablename, PyObject *module)
Fred Draked86ed291999-12-15 15:34:33 +000010856{
Fred Drakebec628d1999-12-15 18:31:10 +000010857 PyObject *d = NULL;
Barry Warsaw3155db32000-04-13 15:20:40 +000010858 size_t i;
Fred Drakebec628d1999-12-15 18:31:10 +000010859
10860 qsort(table, tablesize, sizeof(struct constdef), cmp_constdefs);
10861 d = PyDict_New();
Barry Warsaw3155db32000-04-13 15:20:40 +000010862 if (d == NULL)
Victor Stinner8c62be82010-05-06 00:08:46 +000010863 return -1;
Fred Draked86ed291999-12-15 15:34:33 +000010864
Barry Warsaw3155db32000-04-13 15:20:40 +000010865 for (i=0; i < tablesize; ++i) {
Victor Stinner8c62be82010-05-06 00:08:46 +000010866 PyObject *o = PyLong_FromLong(table[i].value);
10867 if (o == NULL || PyDict_SetItemString(d, table[i].name, o) == -1) {
10868 Py_XDECREF(o);
10869 Py_DECREF(d);
10870 return -1;
10871 }
10872 Py_DECREF(o);
Fred Draked86ed291999-12-15 15:34:33 +000010873 }
Fred Drake4d1e64b2002-04-15 19:40:07 +000010874 return PyModule_AddObject(module, tablename, d);
Fred Draked86ed291999-12-15 15:34:33 +000010875}
10876
Fred Drakebec628d1999-12-15 18:31:10 +000010877/* Return -1 on failure, 0 on success. */
10878static int
Fred Drake4d1e64b2002-04-15 19:40:07 +000010879setup_confname_tables(PyObject *module)
Fred Draked86ed291999-12-15 15:34:33 +000010880{
10881#if defined(HAVE_FPATHCONF) || defined(HAVE_PATHCONF)
Fred Drakebec628d1999-12-15 18:31:10 +000010882 if (setup_confname_table(posix_constants_pathconf,
Fred Draked86ed291999-12-15 15:34:33 +000010883 sizeof(posix_constants_pathconf)
10884 / sizeof(struct constdef),
Fred Drake4d1e64b2002-04-15 19:40:07 +000010885 "pathconf_names", module))
Stefan Krah0e803b32010-11-26 16:16:47 +000010886 return -1;
Fred Draked86ed291999-12-15 15:34:33 +000010887#endif
10888#ifdef HAVE_CONFSTR
Fred Drakebec628d1999-12-15 18:31:10 +000010889 if (setup_confname_table(posix_constants_confstr,
Fred Draked86ed291999-12-15 15:34:33 +000010890 sizeof(posix_constants_confstr)
10891 / sizeof(struct constdef),
Fred Drake4d1e64b2002-04-15 19:40:07 +000010892 "confstr_names", module))
Stefan Krah0e803b32010-11-26 16:16:47 +000010893 return -1;
Fred Draked86ed291999-12-15 15:34:33 +000010894#endif
10895#ifdef HAVE_SYSCONF
Fred Drakebec628d1999-12-15 18:31:10 +000010896 if (setup_confname_table(posix_constants_sysconf,
Fred Draked86ed291999-12-15 15:34:33 +000010897 sizeof(posix_constants_sysconf)
10898 / sizeof(struct constdef),
Fred Drake4d1e64b2002-04-15 19:40:07 +000010899 "sysconf_names", module))
Stefan Krah0e803b32010-11-26 16:16:47 +000010900 return -1;
Fred Draked86ed291999-12-15 15:34:33 +000010901#endif
Fred Drakebec628d1999-12-15 18:31:10 +000010902 return 0;
Fred Draked86ed291999-12-15 15:34:33 +000010903}
Fred Draked86ed291999-12-15 15:34:33 +000010904
10905
Larry Hastings2f936352014-08-05 14:04:04 +100010906/*[clinic input]
10907os.abort
10908
10909Abort the interpreter immediately.
10910
10911This function 'dumps core' or otherwise fails in the hardest way possible
10912on the hosting operating system. This function never returns.
10913[clinic start generated code]*/
10914
Larry Hastings2f936352014-08-05 14:04:04 +100010915static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010916os_abort_impl(PyObject *module)
10917/*[clinic end generated code: output=dcf52586dad2467c input=cf2c7d98bc504047]*/
Fred Drake5ab8eaf1999-12-09 21:13:07 +000010918{
Fred Drake5ab8eaf1999-12-09 21:13:07 +000010919 abort();
10920 /*NOTREACHED*/
Victor Stinner9a2329f2016-12-05 17:56:36 +010010921#ifndef __clang__
10922 /* Issue #28152: abort() is declared with __attribute__((__noreturn__)).
10923 GCC emits a warning without "return NULL;" (compiler bug?), but Clang
10924 is smarter and emits a warning on the return. */
Fred Drake5ab8eaf1999-12-09 21:13:07 +000010925 Py_FatalError("abort() called from Python code didn't abort!");
10926 return NULL;
Victor Stinner9a2329f2016-12-05 17:56:36 +010010927#endif
Fred Drake5ab8eaf1999-12-09 21:13:07 +000010928}
Fred Drakebec628d1999-12-15 18:31:10 +000010929
Martin v. Löwis6238d2b2002-06-30 15:26:10 +000010930#ifdef MS_WINDOWS
Steve Dower7d0e0c92015-01-24 08:18:24 -080010931/* Grab ShellExecute dynamically from shell32 */
10932static int has_ShellExecute = -1;
Steve Dower7d0e0c92015-01-24 08:18:24 -080010933static HINSTANCE (CALLBACK *Py_ShellExecuteW)(HWND, LPCWSTR, LPCWSTR, LPCWSTR,
10934 LPCWSTR, INT);
10935static int
10936check_ShellExecute()
10937{
10938 HINSTANCE hShell32;
10939
10940 /* only recheck */
10941 if (-1 == has_ShellExecute) {
10942 Py_BEGIN_ALLOW_THREADS
Victor Stinnera9912152017-10-13 13:46:57 -070010943 /* Security note: this call is not vulnerable to "DLL hijacking".
10944 SHELL32 is part of "KnownDLLs" and so Windows always load
10945 the system SHELL32.DLL, even if there is another SHELL32.DLL
10946 in the DLL search path. */
Steve Dower7d0e0c92015-01-24 08:18:24 -080010947 hShell32 = LoadLibraryW(L"SHELL32");
10948 Py_END_ALLOW_THREADS
10949 if (hShell32) {
Steve Dower7d0e0c92015-01-24 08:18:24 -080010950 *(FARPROC*)&Py_ShellExecuteW = GetProcAddress(hShell32,
10951 "ShellExecuteW");
Steve Dowercc16be82016-09-08 10:35:16 -070010952 has_ShellExecute = Py_ShellExecuteW != NULL;
Steve Dower7d0e0c92015-01-24 08:18:24 -080010953 } else {
10954 has_ShellExecute = 0;
10955 }
10956 }
10957 return has_ShellExecute;
10958}
10959
10960
Steve Dowercc16be82016-09-08 10:35:16 -070010961/*[clinic input]
10962os.startfile
10963 filepath: path_t
10964 operation: Py_UNICODE = NULL
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +000010965
Steve Dowercc16be82016-09-08 10:35:16 -070010966startfile(filepath [, operation])
10967
10968Start a file with its associated application.
10969
10970When "operation" is not specified or "open", this acts like
10971double-clicking the file in Explorer, or giving the file name as an
10972argument to the DOS "start" command: the file is opened with whatever
10973application (if any) its extension is associated.
10974When another "operation" is given, it specifies what should be done with
10975the file. A typical operation is "print".
10976
10977startfile returns as soon as the associated application is launched.
10978There is no option to wait for the application to close, and no way
10979to retrieve the application's exit status.
10980
10981The filepath is relative to the current directory. If you want to use
10982an absolute path, make sure the first character is not a slash ("/");
10983the underlying Win32 ShellExecute function doesn't work if it is.
10984[clinic start generated code]*/
10985
10986static PyObject *
10987os_startfile_impl(PyObject *module, path_t *filepath, Py_UNICODE *operation)
10988/*[clinic end generated code: output=912ceba79acfa1c9 input=63950bf2986380d0]*/
10989{
10990 HINSTANCE rc;
Steve Dower7d0e0c92015-01-24 08:18:24 -080010991
10992 if(!check_ShellExecute()) {
10993 /* If the OS doesn't have ShellExecute, return a
10994 NotImplementedError. */
10995 return PyErr_Format(PyExc_NotImplementedError,
10996 "startfile not available on this platform");
10997 }
10998
Victor Stinner8c62be82010-05-06 00:08:46 +000010999 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -070011000 rc = Py_ShellExecuteW((HWND)0, operation, filepath->wide,
Steve Dower7d0e0c92015-01-24 08:18:24 -080011001 NULL, NULL, SW_SHOWNORMAL);
Victor Stinner8c62be82010-05-06 00:08:46 +000011002 Py_END_ALLOW_THREADS
11003
Victor Stinner8c62be82010-05-06 00:08:46 +000011004 if (rc <= (HINSTANCE)32) {
Steve Dowercc16be82016-09-08 10:35:16 -070011005 win32_error_object("startfile", filepath->object);
Victor Stinnereb5657a2011-09-30 01:44:27 +020011006 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +000011007 }
Steve Dowercc16be82016-09-08 10:35:16 -070011008 Py_RETURN_NONE;
Tim Petersf58a7aa2000-09-22 10:05:54 +000011009}
Larry Hastings2f936352014-08-05 14:04:04 +100011010#endif /* MS_WINDOWS */
11011
Fred Drake5ab8eaf1999-12-09 21:13:07 +000011012
Martin v. Löwis438b5342002-12-27 10:16:42 +000011013#ifdef HAVE_GETLOADAVG
Larry Hastings2f936352014-08-05 14:04:04 +100011014/*[clinic input]
11015os.getloadavg
11016
11017Return average recent system load information.
11018
11019Return the number of processes in the system run queue averaged over
11020the last 1, 5, and 15 minutes as a tuple of three floats.
11021Raises OSError if the load average was unobtainable.
11022[clinic start generated code]*/
11023
Larry Hastings2f936352014-08-05 14:04:04 +100011024static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011025os_getloadavg_impl(PyObject *module)
11026/*[clinic end generated code: output=9ad3a11bfb4f4bd2 input=3d6d826b76d8a34e]*/
Martin v. Löwis438b5342002-12-27 10:16:42 +000011027{
11028 double loadavg[3];
Martin v. Löwis438b5342002-12-27 10:16:42 +000011029 if (getloadavg(loadavg, 3)!=3) {
Stefan Krah0e803b32010-11-26 16:16:47 +000011030 PyErr_SetString(PyExc_OSError, "Load averages are unobtainable");
11031 return NULL;
Martin v. Löwis438b5342002-12-27 10:16:42 +000011032 } else
Stefan Krah0e803b32010-11-26 16:16:47 +000011033 return Py_BuildValue("ddd", loadavg[0], loadavg[1], loadavg[2]);
Martin v. Löwis438b5342002-12-27 10:16:42 +000011034}
Larry Hastings2f936352014-08-05 14:04:04 +100011035#endif /* HAVE_GETLOADAVG */
Martin v. Löwis438b5342002-12-27 10:16:42 +000011036
Larry Hastings2f936352014-08-05 14:04:04 +100011037
11038/*[clinic input]
11039os.device_encoding
11040 fd: int
11041
11042Return a string describing the encoding of a terminal's file descriptor.
11043
11044The file descriptor must be attached to a terminal.
11045If the device is not a terminal, return None.
11046[clinic start generated code]*/
11047
Larry Hastings2f936352014-08-05 14:04:04 +100011048static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011049os_device_encoding_impl(PyObject *module, int fd)
11050/*[clinic end generated code: output=e0d294bbab7e8c2b input=9e1d4a42b66df312]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011051{
Brett Cannonefb00c02012-02-29 18:31:31 -050011052 return _Py_device_encoding(fd);
Martin v. Löwisd1cd4d42007-08-11 14:02:14 +000011053}
11054
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011055
Larry Hastings2f936352014-08-05 14:04:04 +100011056#ifdef HAVE_SETRESUID
11057/*[clinic input]
11058os.setresuid
11059
11060 ruid: uid_t
11061 euid: uid_t
11062 suid: uid_t
11063 /
11064
11065Set the current process's real, effective, and saved user ids.
11066[clinic start generated code]*/
11067
Larry Hastings2f936352014-08-05 14:04:04 +100011068static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011069os_setresuid_impl(PyObject *module, uid_t ruid, uid_t euid, uid_t suid)
11070/*[clinic end generated code: output=834a641e15373e97 input=9e33cb79a82792f3]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011071{
Victor Stinner8c62be82010-05-06 00:08:46 +000011072 if (setresuid(ruid, euid, suid) < 0)
11073 return posix_error();
11074 Py_RETURN_NONE;
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011075}
Larry Hastings2f936352014-08-05 14:04:04 +100011076#endif /* HAVE_SETRESUID */
11077
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011078
11079#ifdef HAVE_SETRESGID
Larry Hastings2f936352014-08-05 14:04:04 +100011080/*[clinic input]
11081os.setresgid
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011082
Larry Hastings2f936352014-08-05 14:04:04 +100011083 rgid: gid_t
11084 egid: gid_t
11085 sgid: gid_t
11086 /
11087
11088Set the current process's real, effective, and saved group ids.
11089[clinic start generated code]*/
11090
Larry Hastings2f936352014-08-05 14:04:04 +100011091static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011092os_setresgid_impl(PyObject *module, gid_t rgid, gid_t egid, gid_t sgid)
11093/*[clinic end generated code: output=6aa402f3d2e514a9 input=33e9e0785ef426b1]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011094{
Victor Stinner8c62be82010-05-06 00:08:46 +000011095 if (setresgid(rgid, egid, sgid) < 0)
11096 return posix_error();
11097 Py_RETURN_NONE;
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011098}
Larry Hastings2f936352014-08-05 14:04:04 +100011099#endif /* HAVE_SETRESGID */
11100
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011101
11102#ifdef HAVE_GETRESUID
Larry Hastings2f936352014-08-05 14:04:04 +100011103/*[clinic input]
11104os.getresuid
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011105
Larry Hastings2f936352014-08-05 14:04:04 +100011106Return a tuple of the current process's real, effective, and saved user ids.
11107[clinic start generated code]*/
11108
Larry Hastings2f936352014-08-05 14:04:04 +100011109static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011110os_getresuid_impl(PyObject *module)
11111/*[clinic end generated code: output=8e0becff5dece5bf input=41ccfa8e1f6517ad]*/
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011112{
Victor Stinner8c62be82010-05-06 00:08:46 +000011113 uid_t ruid, euid, suid;
Victor Stinner8c62be82010-05-06 00:08:46 +000011114 if (getresuid(&ruid, &euid, &suid) < 0)
11115 return posix_error();
Serhiy Storchaka7cf55992013-02-10 21:56:49 +020011116 return Py_BuildValue("(NNN)", _PyLong_FromUid(ruid),
11117 _PyLong_FromUid(euid),
11118 _PyLong_FromUid(suid));
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011119}
Larry Hastings2f936352014-08-05 14:04:04 +100011120#endif /* HAVE_GETRESUID */
11121
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011122
11123#ifdef HAVE_GETRESGID
Larry Hastings2f936352014-08-05 14:04:04 +100011124/*[clinic input]
11125os.getresgid
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011126
Larry Hastings2f936352014-08-05 14:04:04 +100011127Return a tuple of the current process's real, effective, and saved group ids.
11128[clinic start generated code]*/
11129
Larry Hastings2f936352014-08-05 14:04:04 +100011130static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011131os_getresgid_impl(PyObject *module)
11132/*[clinic end generated code: output=2719c4bfcf27fb9f input=517e68db9ca32df6]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011133{
11134 gid_t rgid, egid, sgid;
Victor Stinner8c62be82010-05-06 00:08:46 +000011135 if (getresgid(&rgid, &egid, &sgid) < 0)
11136 return posix_error();
Serhiy Storchaka7cf55992013-02-10 21:56:49 +020011137 return Py_BuildValue("(NNN)", _PyLong_FromGid(rgid),
11138 _PyLong_FromGid(egid),
11139 _PyLong_FromGid(sgid));
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011140}
Larry Hastings2f936352014-08-05 14:04:04 +100011141#endif /* HAVE_GETRESGID */
11142
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011143
Benjamin Peterson9428d532011-09-14 11:45:52 -040011144#ifdef USE_XATTRS
Larry Hastings2f936352014-08-05 14:04:04 +100011145/*[clinic input]
11146os.getxattr
Benjamin Peterson799bd802011-08-31 22:15:17 -040011147
Larry Hastings2f936352014-08-05 14:04:04 +100011148 path: path_t(allow_fd=True)
11149 attribute: path_t
11150 *
11151 follow_symlinks: bool = True
11152
11153Return the value of extended attribute attribute on path.
11154
11155path may be either a string or an open file descriptor.
11156If follow_symlinks is False, and the last element of the path is a symbolic
11157 link, getxattr will examine the symbolic link itself instead of the file
11158 the link points to.
11159
11160[clinic start generated code]*/
11161
Larry Hastings2f936352014-08-05 14:04:04 +100011162static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011163os_getxattr_impl(PyObject *module, path_t *path, path_t *attribute,
Larry Hastings89964c42015-04-14 18:07:59 -040011164 int follow_symlinks)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011165/*[clinic end generated code: output=5f2f44200a43cff2 input=8c8ea3bab78d89c2]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011166{
11167 Py_ssize_t i;
11168 PyObject *buffer = NULL;
11169
11170 if (fd_and_follow_symlinks_invalid("getxattr", path->fd, follow_symlinks))
11171 return NULL;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011172
Larry Hastings9cf065c2012-06-22 16:30:09 -070011173 for (i = 0; ; i++) {
11174 void *ptr;
11175 ssize_t result;
Serhiy Storchaka2d06e842015-12-25 19:53:18 +020011176 static const Py_ssize_t buffer_sizes[] = {128, XATTR_SIZE_MAX, 0};
Larry Hastings9cf065c2012-06-22 16:30:09 -070011177 Py_ssize_t buffer_size = buffer_sizes[i];
11178 if (!buffer_size) {
Larry Hastings2f936352014-08-05 14:04:04 +100011179 path_error(path);
11180 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070011181 }
11182 buffer = PyBytes_FromStringAndSize(NULL, buffer_size);
11183 if (!buffer)
Larry Hastings2f936352014-08-05 14:04:04 +100011184 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070011185 ptr = PyBytes_AS_STRING(buffer);
Benjamin Peterson799bd802011-08-31 22:15:17 -040011186
Larry Hastings9cf065c2012-06-22 16:30:09 -070011187 Py_BEGIN_ALLOW_THREADS;
Larry Hastings2f936352014-08-05 14:04:04 +100011188 if (path->fd >= 0)
11189 result = fgetxattr(path->fd, attribute->narrow, ptr, buffer_size);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011190 else if (follow_symlinks)
Larry Hastings2f936352014-08-05 14:04:04 +100011191 result = getxattr(path->narrow, attribute->narrow, ptr, buffer_size);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011192 else
Larry Hastings2f936352014-08-05 14:04:04 +100011193 result = lgetxattr(path->narrow, attribute->narrow, ptr, buffer_size);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011194 Py_END_ALLOW_THREADS;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011195
Larry Hastings9cf065c2012-06-22 16:30:09 -070011196 if (result < 0) {
11197 Py_DECREF(buffer);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011198 if (errno == ERANGE)
11199 continue;
Larry Hastings2f936352014-08-05 14:04:04 +100011200 path_error(path);
11201 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070011202 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040011203
Larry Hastings9cf065c2012-06-22 16:30:09 -070011204 if (result != buffer_size) {
11205 /* Can only shrink. */
11206 _PyBytes_Resize(&buffer, result);
11207 }
11208 break;
11209 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040011210
Larry Hastings9cf065c2012-06-22 16:30:09 -070011211 return buffer;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011212}
11213
Larry Hastings2f936352014-08-05 14:04:04 +100011214
11215/*[clinic input]
11216os.setxattr
11217
11218 path: path_t(allow_fd=True)
11219 attribute: path_t
11220 value: Py_buffer
11221 flags: int = 0
11222 *
11223 follow_symlinks: bool = True
11224
11225Set extended attribute attribute on path to value.
11226
11227path may be either a string or an open file descriptor.
11228If follow_symlinks is False, and the last element of the path is a symbolic
11229 link, setxattr will modify the symbolic link itself instead of the file
11230 the link points to.
11231
11232[clinic start generated code]*/
11233
Benjamin Peterson799bd802011-08-31 22:15:17 -040011234static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011235os_setxattr_impl(PyObject *module, path_t *path, path_t *attribute,
Larry Hastings89964c42015-04-14 18:07:59 -040011236 Py_buffer *value, int flags, int follow_symlinks)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011237/*[clinic end generated code: output=98b83f63fdde26bb input=f0d26833992015c2]*/
Benjamin Peterson799bd802011-08-31 22:15:17 -040011238{
Larry Hastings2f936352014-08-05 14:04:04 +100011239 ssize_t result;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011240
Larry Hastings2f936352014-08-05 14:04:04 +100011241 if (fd_and_follow_symlinks_invalid("setxattr", path->fd, follow_symlinks))
Benjamin Peterson799bd802011-08-31 22:15:17 -040011242 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070011243
Benjamin Peterson799bd802011-08-31 22:15:17 -040011244 Py_BEGIN_ALLOW_THREADS;
Larry Hastings2f936352014-08-05 14:04:04 +100011245 if (path->fd > -1)
11246 result = fsetxattr(path->fd, attribute->narrow,
11247 value->buf, value->len, flags);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011248 else if (follow_symlinks)
Larry Hastings2f936352014-08-05 14:04:04 +100011249 result = setxattr(path->narrow, attribute->narrow,
11250 value->buf, value->len, flags);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011251 else
Larry Hastings2f936352014-08-05 14:04:04 +100011252 result = lsetxattr(path->narrow, attribute->narrow,
11253 value->buf, value->len, flags);
Benjamin Peterson799bd802011-08-31 22:15:17 -040011254 Py_END_ALLOW_THREADS;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011255
Larry Hastings9cf065c2012-06-22 16:30:09 -070011256 if (result) {
Larry Hastings2f936352014-08-05 14:04:04 +100011257 path_error(path);
11258 return NULL;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011259 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040011260
Larry Hastings2f936352014-08-05 14:04:04 +100011261 Py_RETURN_NONE;
11262}
11263
11264
11265/*[clinic input]
11266os.removexattr
11267
11268 path: path_t(allow_fd=True)
11269 attribute: path_t
11270 *
11271 follow_symlinks: bool = True
11272
11273Remove extended attribute attribute on path.
11274
11275path may be either a string or an open file descriptor.
11276If follow_symlinks is False, and the last element of the path is a symbolic
11277 link, removexattr will modify the symbolic link itself instead of the file
11278 the link points to.
11279
11280[clinic start generated code]*/
11281
Larry Hastings2f936352014-08-05 14:04:04 +100011282static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011283os_removexattr_impl(PyObject *module, path_t *path, path_t *attribute,
Larry Hastings89964c42015-04-14 18:07:59 -040011284 int follow_symlinks)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011285/*[clinic end generated code: output=521a51817980cda6 input=cdb54834161e3329]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011286{
11287 ssize_t result;
11288
11289 if (fd_and_follow_symlinks_invalid("removexattr", path->fd, follow_symlinks))
11290 return NULL;
11291
11292 Py_BEGIN_ALLOW_THREADS;
11293 if (path->fd > -1)
11294 result = fremovexattr(path->fd, attribute->narrow);
11295 else if (follow_symlinks)
11296 result = removexattr(path->narrow, attribute->narrow);
11297 else
11298 result = lremovexattr(path->narrow, attribute->narrow);
11299 Py_END_ALLOW_THREADS;
11300
11301 if (result) {
11302 return path_error(path);
11303 }
11304
11305 Py_RETURN_NONE;
11306}
11307
11308
11309/*[clinic input]
11310os.listxattr
11311
11312 path: path_t(allow_fd=True, nullable=True) = None
11313 *
11314 follow_symlinks: bool = True
11315
11316Return a list of extended attributes on path.
11317
11318path may be either None, a string, or an open file descriptor.
11319if path is None, listxattr will examine the current directory.
11320If follow_symlinks is False, and the last element of the path is a symbolic
11321 link, listxattr will examine the symbolic link itself instead of the file
11322 the link points to.
11323[clinic start generated code]*/
11324
Larry Hastings2f936352014-08-05 14:04:04 +100011325static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011326os_listxattr_impl(PyObject *module, path_t *path, int follow_symlinks)
11327/*[clinic end generated code: output=bebdb4e2ad0ce435 input=08cca53ac0b07c13]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011328{
Larry Hastings9cf065c2012-06-22 16:30:09 -070011329 Py_ssize_t i;
11330 PyObject *result = NULL;
Larry Hastings2f936352014-08-05 14:04:04 +100011331 const char *name;
Larry Hastings9cf065c2012-06-22 16:30:09 -070011332 char *buffer = NULL;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011333
Larry Hastings2f936352014-08-05 14:04:04 +100011334 if (fd_and_follow_symlinks_invalid("listxattr", path->fd, follow_symlinks))
Larry Hastings9cf065c2012-06-22 16:30:09 -070011335 goto exit;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011336
Larry Hastings2f936352014-08-05 14:04:04 +100011337 name = path->narrow ? path->narrow : ".";
11338
Larry Hastings9cf065c2012-06-22 16:30:09 -070011339 for (i = 0; ; i++) {
Serhiy Storchakadeab18d2016-05-07 16:45:18 +030011340 const char *start, *trace, *end;
Larry Hastings9cf065c2012-06-22 16:30:09 -070011341 ssize_t length;
Serhiy Storchaka2d06e842015-12-25 19:53:18 +020011342 static const Py_ssize_t buffer_sizes[] = { 256, XATTR_LIST_MAX, 0 };
Larry Hastings9cf065c2012-06-22 16:30:09 -070011343 Py_ssize_t buffer_size = buffer_sizes[i];
11344 if (!buffer_size) {
Christian Heimes3b9493b2012-09-23 16:11:15 +020011345 /* ERANGE */
Larry Hastings2f936352014-08-05 14:04:04 +100011346 path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011347 break;
11348 }
11349 buffer = PyMem_MALLOC(buffer_size);
11350 if (!buffer) {
11351 PyErr_NoMemory();
11352 break;
11353 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040011354
Larry Hastings9cf065c2012-06-22 16:30:09 -070011355 Py_BEGIN_ALLOW_THREADS;
Larry Hastings2f936352014-08-05 14:04:04 +100011356 if (path->fd > -1)
11357 length = flistxattr(path->fd, buffer, buffer_size);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011358 else if (follow_symlinks)
11359 length = listxattr(name, buffer, buffer_size);
11360 else
11361 length = llistxattr(name, buffer, buffer_size);
11362 Py_END_ALLOW_THREADS;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011363
Larry Hastings9cf065c2012-06-22 16:30:09 -070011364 if (length < 0) {
Antoine Pitrou7f987392013-05-13 19:46:29 +020011365 if (errno == ERANGE) {
11366 PyMem_FREE(buffer);
Benjamin Petersondedac522013-05-13 19:55:40 -050011367 buffer = NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070011368 continue;
Antoine Pitrou7f987392013-05-13 19:46:29 +020011369 }
Larry Hastings2f936352014-08-05 14:04:04 +100011370 path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011371 break;
11372 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040011373
Larry Hastings9cf065c2012-06-22 16:30:09 -070011374 result = PyList_New(0);
11375 if (!result) {
11376 goto exit;
11377 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040011378
Larry Hastings9cf065c2012-06-22 16:30:09 -070011379 end = buffer + length;
11380 for (trace = start = buffer; trace != end; trace++) {
11381 if (!*trace) {
11382 int error;
11383 PyObject *attribute = PyUnicode_DecodeFSDefaultAndSize(start,
11384 trace - start);
11385 if (!attribute) {
11386 Py_DECREF(result);
11387 result = NULL;
11388 goto exit;
11389 }
11390 error = PyList_Append(result, attribute);
11391 Py_DECREF(attribute);
11392 if (error) {
11393 Py_DECREF(result);
11394 result = NULL;
11395 goto exit;
11396 }
11397 start = trace + 1;
11398 }
11399 }
11400 break;
11401 }
11402exit:
Larry Hastings9cf065c2012-06-22 16:30:09 -070011403 if (buffer)
11404 PyMem_FREE(buffer);
11405 return result;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011406}
Benjamin Peterson9428d532011-09-14 11:45:52 -040011407#endif /* USE_XATTRS */
Benjamin Peterson799bd802011-08-31 22:15:17 -040011408
Antoine Pitroubcf2b592012-02-08 23:28:36 +010011409
Larry Hastings2f936352014-08-05 14:04:04 +100011410/*[clinic input]
11411os.urandom
11412
11413 size: Py_ssize_t
11414 /
11415
11416Return a bytes object containing random bytes suitable for cryptographic use.
11417[clinic start generated code]*/
11418
Larry Hastings2f936352014-08-05 14:04:04 +100011419static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011420os_urandom_impl(PyObject *module, Py_ssize_t size)
11421/*[clinic end generated code: output=42c5cca9d18068e9 input=4067cdb1b6776c29]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011422{
11423 PyObject *bytes;
11424 int result;
11425
Georg Brandl2fb477c2012-02-21 00:33:36 +010011426 if (size < 0)
11427 return PyErr_Format(PyExc_ValueError,
11428 "negative argument not allowed");
Larry Hastings2f936352014-08-05 14:04:04 +100011429 bytes = PyBytes_FromStringAndSize(NULL, size);
11430 if (bytes == NULL)
Georg Brandl2fb477c2012-02-21 00:33:36 +010011431 return NULL;
11432
Victor Stinnere66987e2016-09-06 16:33:52 -070011433 result = _PyOS_URandom(PyBytes_AS_STRING(bytes), PyBytes_GET_SIZE(bytes));
Larry Hastings2f936352014-08-05 14:04:04 +100011434 if (result == -1) {
11435 Py_DECREF(bytes);
Georg Brandl2fb477c2012-02-21 00:33:36 +010011436 return NULL;
11437 }
Larry Hastings2f936352014-08-05 14:04:04 +100011438 return bytes;
Georg Brandl2fb477c2012-02-21 00:33:36 +010011439}
11440
Antoine Pitroubcf2b592012-02-08 23:28:36 +010011441/* Terminal size querying */
11442
11443static PyTypeObject TerminalSizeType;
11444
11445PyDoc_STRVAR(TerminalSize_docstring,
11446 "A tuple of (columns, lines) for holding terminal window size");
11447
11448static PyStructSequence_Field TerminalSize_fields[] = {
11449 {"columns", "width of the terminal window in characters"},
11450 {"lines", "height of the terminal window in characters"},
11451 {NULL, NULL}
11452};
11453
11454static PyStructSequence_Desc TerminalSize_desc = {
11455 "os.terminal_size",
11456 TerminalSize_docstring,
11457 TerminalSize_fields,
11458 2,
11459};
11460
11461#if defined(TERMSIZE_USE_CONIO) || defined(TERMSIZE_USE_IOCTL)
Larry Hastings2f936352014-08-05 14:04:04 +100011462/* AC 3.5: fd should accept None */
Antoine Pitroubcf2b592012-02-08 23:28:36 +010011463PyDoc_STRVAR(termsize__doc__,
11464 "Return the size of the terminal window as (columns, lines).\n" \
11465 "\n" \
11466 "The optional argument fd (default standard output) specifies\n" \
11467 "which file descriptor should be queried.\n" \
11468 "\n" \
11469 "If the file descriptor is not connected to a terminal, an OSError\n" \
11470 "is thrown.\n" \
11471 "\n" \
11472 "This function will only be defined if an implementation is\n" \
11473 "available for this system.\n" \
11474 "\n" \
11475 "shutil.get_terminal_size is the high-level function which should \n" \
11476 "normally be used, os.get_terminal_size is the low-level implementation.");
11477
11478static PyObject*
11479get_terminal_size(PyObject *self, PyObject *args)
11480{
11481 int columns, lines;
11482 PyObject *termsize;
11483
11484 int fd = fileno(stdout);
11485 /* Under some conditions stdout may not be connected and
11486 * fileno(stdout) may point to an invalid file descriptor. For example
11487 * GUI apps don't have valid standard streams by default.
11488 *
11489 * If this happens, and the optional fd argument is not present,
11490 * the ioctl below will fail returning EBADF. This is what we want.
11491 */
11492
11493 if (!PyArg_ParseTuple(args, "|i", &fd))
11494 return NULL;
11495
11496#ifdef TERMSIZE_USE_IOCTL
11497 {
11498 struct winsize w;
11499 if (ioctl(fd, TIOCGWINSZ, &w))
11500 return PyErr_SetFromErrno(PyExc_OSError);
11501 columns = w.ws_col;
11502 lines = w.ws_row;
11503 }
11504#endif /* TERMSIZE_USE_IOCTL */
11505
11506#ifdef TERMSIZE_USE_CONIO
11507 {
11508 DWORD nhandle;
11509 HANDLE handle;
11510 CONSOLE_SCREEN_BUFFER_INFO csbi;
11511 switch (fd) {
11512 case 0: nhandle = STD_INPUT_HANDLE;
11513 break;
11514 case 1: nhandle = STD_OUTPUT_HANDLE;
11515 break;
11516 case 2: nhandle = STD_ERROR_HANDLE;
11517 break;
11518 default:
11519 return PyErr_Format(PyExc_ValueError, "bad file descriptor");
11520 }
11521 handle = GetStdHandle(nhandle);
11522 if (handle == NULL)
11523 return PyErr_Format(PyExc_OSError, "handle cannot be retrieved");
11524 if (handle == INVALID_HANDLE_VALUE)
11525 return PyErr_SetFromWindowsErr(0);
11526
11527 if (!GetConsoleScreenBufferInfo(handle, &csbi))
11528 return PyErr_SetFromWindowsErr(0);
11529
11530 columns = csbi.srWindow.Right - csbi.srWindow.Left + 1;
11531 lines = csbi.srWindow.Bottom - csbi.srWindow.Top + 1;
11532 }
11533#endif /* TERMSIZE_USE_CONIO */
11534
11535 termsize = PyStructSequence_New(&TerminalSizeType);
11536 if (termsize == NULL)
11537 return NULL;
11538 PyStructSequence_SET_ITEM(termsize, 0, PyLong_FromLong(columns));
11539 PyStructSequence_SET_ITEM(termsize, 1, PyLong_FromLong(lines));
11540 if (PyErr_Occurred()) {
11541 Py_DECREF(termsize);
11542 return NULL;
11543 }
11544 return termsize;
11545}
11546#endif /* defined(TERMSIZE_USE_CONIO) || defined(TERMSIZE_USE_IOCTL) */
11547
Larry Hastings2f936352014-08-05 14:04:04 +100011548
11549/*[clinic input]
11550os.cpu_count
11551
Charles-François Natali80d62e62015-08-13 20:37:08 +010011552Return the number of CPUs in the system; return None if indeterminable.
11553
11554This number is not equivalent to the number of CPUs the current process can
11555use. The number of usable CPUs can be obtained with
11556``len(os.sched_getaffinity(0))``
Larry Hastings2f936352014-08-05 14:04:04 +100011557[clinic start generated code]*/
11558
Larry Hastings2f936352014-08-05 14:04:04 +100011559static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011560os_cpu_count_impl(PyObject *module)
Serhiy Storchaka2954f832016-07-07 18:20:03 +030011561/*[clinic end generated code: output=5fc29463c3936a9c input=e7c8f4ba6dbbadd3]*/
Charles-Francois Natali44feda32013-05-20 14:40:46 +020011562{
Charles-Francois Natalid59087d2013-05-20 17:31:06 +020011563 int ncpu = 0;
Charles-Francois Natali44feda32013-05-20 14:40:46 +020011564#ifdef MS_WINDOWS
Christopher Wilcoxc67bae02017-08-30 05:01:08 -040011565 /* Vista is supported and the GetMaximumProcessorCount API is Win7+
11566 Need to fallback to Vista behavior if this call isn't present */
11567 HINSTANCE hKernel32;
11568 hKernel32 = GetModuleHandleW(L"KERNEL32");
11569
11570 static DWORD(CALLBACK *_GetMaximumProcessorCount)(WORD) = NULL;
11571 *(FARPROC*)&_GetMaximumProcessorCount = GetProcAddress(hKernel32,
11572 "GetMaximumProcessorCount");
11573 if (_GetMaximumProcessorCount != NULL) {
11574 ncpu = _GetMaximumProcessorCount(ALL_PROCESSOR_GROUPS);
11575 }
11576 else {
11577 SYSTEM_INFO sysinfo;
11578 GetSystemInfo(&sysinfo);
11579 ncpu = sysinfo.dwNumberOfProcessors;
11580 }
Charles-Francois Natali44feda32013-05-20 14:40:46 +020011581#elif defined(__hpux)
11582 ncpu = mpctl(MPC_GETNUMSPUS, NULL, NULL);
11583#elif defined(HAVE_SYSCONF) && defined(_SC_NPROCESSORS_ONLN)
11584 ncpu = sysconf(_SC_NPROCESSORS_ONLN);
Charles-Francois Natali44feda32013-05-20 14:40:46 +020011585#elif defined(__DragonFly__) || \
11586 defined(__OpenBSD__) || \
11587 defined(__FreeBSD__) || \
Charles-Francois Natalid59087d2013-05-20 17:31:06 +020011588 defined(__NetBSD__) || \
11589 defined(__APPLE__)
Charles-Francois Natali7c4f8da2013-05-20 17:40:32 +020011590 int mib[2];
11591 size_t len = sizeof(ncpu);
11592 mib[0] = CTL_HW;
11593 mib[1] = HW_NCPU;
11594 if (sysctl(mib, 2, &ncpu, &len, NULL, 0) != 0)
11595 ncpu = 0;
Charles-Francois Natali44feda32013-05-20 14:40:46 +020011596#endif
11597 if (ncpu >= 1)
11598 return PyLong_FromLong(ncpu);
11599 else
11600 Py_RETURN_NONE;
11601}
11602
Victor Stinnerdaf45552013-08-28 00:53:59 +020011603
Larry Hastings2f936352014-08-05 14:04:04 +100011604/*[clinic input]
11605os.get_inheritable -> bool
11606
11607 fd: int
11608 /
11609
11610Get the close-on-exe flag of the specified file descriptor.
11611[clinic start generated code]*/
11612
Larry Hastings2f936352014-08-05 14:04:04 +100011613static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011614os_get_inheritable_impl(PyObject *module, int fd)
11615/*[clinic end generated code: output=0445e20e149aa5b8 input=89ac008dc9ab6b95]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011616{
Steve Dower8fc89802015-04-12 00:26:27 -040011617 int return_value;
Steve Dower8fc89802015-04-12 00:26:27 -040011618 _Py_BEGIN_SUPPRESS_IPH
11619 return_value = _Py_get_inheritable(fd);
11620 _Py_END_SUPPRESS_IPH
11621 return return_value;
Larry Hastings2f936352014-08-05 14:04:04 +100011622}
11623
11624
11625/*[clinic input]
11626os.set_inheritable
11627 fd: int
11628 inheritable: int
11629 /
11630
11631Set the inheritable flag of the specified file descriptor.
11632[clinic start generated code]*/
11633
Larry Hastings2f936352014-08-05 14:04:04 +100011634static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011635os_set_inheritable_impl(PyObject *module, int fd, int inheritable)
11636/*[clinic end generated code: output=f1b1918a2f3c38c2 input=9ceaead87a1e2402]*/
Victor Stinnerdaf45552013-08-28 00:53:59 +020011637{
Steve Dower8fc89802015-04-12 00:26:27 -040011638 int result;
Victor Stinnerdaf45552013-08-28 00:53:59 +020011639
Steve Dower8fc89802015-04-12 00:26:27 -040011640 _Py_BEGIN_SUPPRESS_IPH
11641 result = _Py_set_inheritable(fd, inheritable, NULL);
11642 _Py_END_SUPPRESS_IPH
11643 if (result < 0)
Victor Stinnerdaf45552013-08-28 00:53:59 +020011644 return NULL;
11645 Py_RETURN_NONE;
11646}
11647
11648
11649#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +100011650/*[clinic input]
11651os.get_handle_inheritable -> bool
Benjamin Petersonca470632016-09-06 13:47:26 -070011652 handle: intptr_t
Larry Hastings2f936352014-08-05 14:04:04 +100011653 /
Victor Stinnerdaf45552013-08-28 00:53:59 +020011654
Larry Hastings2f936352014-08-05 14:04:04 +100011655Get the close-on-exe flag of the specified file descriptor.
11656[clinic start generated code]*/
11657
Larry Hastings2f936352014-08-05 14:04:04 +100011658static int
Benjamin Petersonca470632016-09-06 13:47:26 -070011659os_get_handle_inheritable_impl(PyObject *module, intptr_t handle)
Victor Stinner581139c2016-09-06 15:54:20 -070011660/*[clinic end generated code: output=36be5afca6ea84d8 input=cfe99f9c05c70ad1]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011661{
11662 DWORD flags;
Victor Stinnerdaf45552013-08-28 00:53:59 +020011663
11664 if (!GetHandleInformation((HANDLE)handle, &flags)) {
11665 PyErr_SetFromWindowsErr(0);
Larry Hastings2f936352014-08-05 14:04:04 +100011666 return -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +020011667 }
11668
Larry Hastings2f936352014-08-05 14:04:04 +100011669 return flags & HANDLE_FLAG_INHERIT;
Victor Stinnerdaf45552013-08-28 00:53:59 +020011670}
11671
Victor Stinnerdaf45552013-08-28 00:53:59 +020011672
Larry Hastings2f936352014-08-05 14:04:04 +100011673/*[clinic input]
11674os.set_handle_inheritable
Benjamin Petersonca470632016-09-06 13:47:26 -070011675 handle: intptr_t
Larry Hastings2f936352014-08-05 14:04:04 +100011676 inheritable: bool
11677 /
11678
11679Set the inheritable flag of the specified handle.
11680[clinic start generated code]*/
11681
Larry Hastings2f936352014-08-05 14:04:04 +100011682static PyObject *
Benjamin Petersonca470632016-09-06 13:47:26 -070011683os_set_handle_inheritable_impl(PyObject *module, intptr_t handle,
Larry Hastings89964c42015-04-14 18:07:59 -040011684 int inheritable)
Victor Stinner581139c2016-09-06 15:54:20 -070011685/*[clinic end generated code: output=021d74fe6c96baa3 input=7a7641390d8364fc]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011686{
11687 DWORD flags = inheritable ? HANDLE_FLAG_INHERIT : 0;
Victor Stinnerdaf45552013-08-28 00:53:59 +020011688 if (!SetHandleInformation((HANDLE)handle, HANDLE_FLAG_INHERIT, flags)) {
11689 PyErr_SetFromWindowsErr(0);
11690 return NULL;
11691 }
11692 Py_RETURN_NONE;
11693}
Larry Hastings2f936352014-08-05 14:04:04 +100011694#endif /* MS_WINDOWS */
Antoine Pitroubcf2b592012-02-08 23:28:36 +010011695
Victor Stinner1db9e7b2014-07-29 22:32:47 +020011696#ifndef MS_WINDOWS
11697PyDoc_STRVAR(get_blocking__doc__,
11698 "get_blocking(fd) -> bool\n" \
11699 "\n" \
11700 "Get the blocking mode of the file descriptor:\n" \
11701 "False if the O_NONBLOCK flag is set, True if the flag is cleared.");
11702
11703static PyObject*
11704posix_get_blocking(PyObject *self, PyObject *args)
11705{
11706 int fd;
11707 int blocking;
11708
11709 if (!PyArg_ParseTuple(args, "i:get_blocking", &fd))
11710 return NULL;
11711
Steve Dower8fc89802015-04-12 00:26:27 -040011712 _Py_BEGIN_SUPPRESS_IPH
Victor Stinner1db9e7b2014-07-29 22:32:47 +020011713 blocking = _Py_get_blocking(fd);
Steve Dower8fc89802015-04-12 00:26:27 -040011714 _Py_END_SUPPRESS_IPH
Victor Stinner1db9e7b2014-07-29 22:32:47 +020011715 if (blocking < 0)
11716 return NULL;
11717 return PyBool_FromLong(blocking);
11718}
11719
11720PyDoc_STRVAR(set_blocking__doc__,
11721 "set_blocking(fd, blocking)\n" \
11722 "\n" \
11723 "Set the blocking mode of the specified file descriptor.\n" \
11724 "Set the O_NONBLOCK flag if blocking is False,\n" \
11725 "clear the O_NONBLOCK flag otherwise.");
11726
11727static PyObject*
11728posix_set_blocking(PyObject *self, PyObject *args)
11729{
Steve Dower8fc89802015-04-12 00:26:27 -040011730 int fd, blocking, result;
Victor Stinner1db9e7b2014-07-29 22:32:47 +020011731
11732 if (!PyArg_ParseTuple(args, "ii:set_blocking", &fd, &blocking))
11733 return NULL;
11734
Steve Dower8fc89802015-04-12 00:26:27 -040011735 _Py_BEGIN_SUPPRESS_IPH
11736 result = _Py_set_blocking(fd, blocking);
11737 _Py_END_SUPPRESS_IPH
11738 if (result < 0)
Victor Stinner1db9e7b2014-07-29 22:32:47 +020011739 return NULL;
11740 Py_RETURN_NONE;
11741}
11742#endif /* !MS_WINDOWS */
11743
11744
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020011745/*[clinic input]
11746class os.DirEntry "DirEntry *" "&DirEntryType"
11747[clinic start generated code]*/
11748/*[clinic end generated code: output=da39a3ee5e6b4b0d input=3138f09f7c683f1d]*/
Victor Stinner6036e442015-03-08 01:58:04 +010011749
11750typedef struct {
11751 PyObject_HEAD
11752 PyObject *name;
11753 PyObject *path;
11754 PyObject *stat;
11755 PyObject *lstat;
11756#ifdef MS_WINDOWS
11757 struct _Py_stat_struct win32_lstat;
Victor Stinner0f6d7332017-03-09 17:34:28 +010011758 uint64_t win32_file_index;
Victor Stinner6036e442015-03-08 01:58:04 +010011759 int got_file_index;
11760#else /* POSIX */
Victor Stinner35a97c02015-03-08 02:59:09 +010011761#ifdef HAVE_DIRENT_D_TYPE
Victor Stinner6036e442015-03-08 01:58:04 +010011762 unsigned char d_type;
Victor Stinner35a97c02015-03-08 02:59:09 +010011763#endif
Victor Stinner6036e442015-03-08 01:58:04 +010011764 ino_t d_ino;
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030011765 int dir_fd;
Victor Stinner6036e442015-03-08 01:58:04 +010011766#endif
11767} DirEntry;
11768
11769static void
11770DirEntry_dealloc(DirEntry *entry)
11771{
11772 Py_XDECREF(entry->name);
11773 Py_XDECREF(entry->path);
11774 Py_XDECREF(entry->stat);
11775 Py_XDECREF(entry->lstat);
11776 Py_TYPE(entry)->tp_free((PyObject *)entry);
11777}
11778
11779/* Forward reference */
11780static int
11781DirEntry_test_mode(DirEntry *self, int follow_symlinks, unsigned short mode_bits);
11782
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020011783/*[clinic input]
11784os.DirEntry.is_symlink -> bool
11785
11786Return True if the entry is a symbolic link; cached per entry.
11787[clinic start generated code]*/
11788
Victor Stinner6036e442015-03-08 01:58:04 +010011789static int
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020011790os_DirEntry_is_symlink_impl(DirEntry *self)
11791/*[clinic end generated code: output=42244667d7bcfc25 input=1605a1b4b96976c3]*/
Victor Stinner6036e442015-03-08 01:58:04 +010011792{
11793#ifdef MS_WINDOWS
11794 return (self->win32_lstat.st_mode & S_IFMT) == S_IFLNK;
Victor Stinner35a97c02015-03-08 02:59:09 +010011795#elif defined(HAVE_DIRENT_D_TYPE)
11796 /* POSIX */
Victor Stinner6036e442015-03-08 01:58:04 +010011797 if (self->d_type != DT_UNKNOWN)
11798 return self->d_type == DT_LNK;
11799 else
11800 return DirEntry_test_mode(self, 0, S_IFLNK);
Victor Stinner35a97c02015-03-08 02:59:09 +010011801#else
11802 /* POSIX without d_type */
11803 return DirEntry_test_mode(self, 0, S_IFLNK);
Victor Stinner6036e442015-03-08 01:58:04 +010011804#endif
11805}
11806
11807static PyObject *
Victor Stinner6036e442015-03-08 01:58:04 +010011808DirEntry_fetch_stat(DirEntry *self, int follow_symlinks)
11809{
11810 int result;
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030011811 STRUCT_STAT st;
11812 PyObject *ub;
Victor Stinner6036e442015-03-08 01:58:04 +010011813
11814#ifdef MS_WINDOWS
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030011815 if (!PyUnicode_FSDecoder(self->path, &ub))
11816 return NULL;
11817 const wchar_t *path = PyUnicode_AsUnicode(ub);
Victor Stinner6036e442015-03-08 01:58:04 +010011818#else /* POSIX */
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030011819 if (!PyUnicode_FSConverter(self->path, &ub))
11820 return NULL;
11821 const char *path = PyBytes_AS_STRING(ub);
11822 if (self->dir_fd != DEFAULT_DIR_FD) {
11823#ifdef HAVE_FSTATAT
11824 result = fstatat(self->dir_fd, path, &st,
11825 follow_symlinks ? 0 : AT_SYMLINK_NOFOLLOW);
11826#else
11827 PyErr_SetString(PyExc_NotImplementedError, "can't fetch stat");
11828 return NULL;
11829#endif /* HAVE_FSTATAT */
11830 }
11831 else
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030011832#endif
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030011833 {
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030011834 if (follow_symlinks)
11835 result = STAT(path, &st);
11836 else
11837 result = LSTAT(path, &st);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030011838 }
11839 Py_DECREF(ub);
Victor Stinner6036e442015-03-08 01:58:04 +010011840
11841 if (result != 0)
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030011842 return path_object_error(self->path);
Victor Stinner6036e442015-03-08 01:58:04 +010011843
11844 return _pystat_fromstructstat(&st);
11845}
11846
11847static PyObject *
11848DirEntry_get_lstat(DirEntry *self)
11849{
11850 if (!self->lstat) {
11851#ifdef MS_WINDOWS
11852 self->lstat = _pystat_fromstructstat(&self->win32_lstat);
11853#else /* POSIX */
11854 self->lstat = DirEntry_fetch_stat(self, 0);
11855#endif
11856 }
11857 Py_XINCREF(self->lstat);
11858 return self->lstat;
11859}
11860
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020011861/*[clinic input]
11862os.DirEntry.stat
11863 *
11864 follow_symlinks: bool = True
11865
11866Return stat_result object for the entry; cached per entry.
11867[clinic start generated code]*/
11868
Victor Stinner6036e442015-03-08 01:58:04 +010011869static PyObject *
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020011870os_DirEntry_stat_impl(DirEntry *self, int follow_symlinks)
11871/*[clinic end generated code: output=008593b3a6d01305 input=280d14c1d6f1d00d]*/
Victor Stinner6036e442015-03-08 01:58:04 +010011872{
11873 if (!follow_symlinks)
11874 return DirEntry_get_lstat(self);
11875
11876 if (!self->stat) {
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020011877 int result = os_DirEntry_is_symlink_impl(self);
Victor Stinner6036e442015-03-08 01:58:04 +010011878 if (result == -1)
11879 return NULL;
11880 else if (result)
11881 self->stat = DirEntry_fetch_stat(self, 1);
11882 else
11883 self->stat = DirEntry_get_lstat(self);
11884 }
11885
11886 Py_XINCREF(self->stat);
11887 return self->stat;
11888}
11889
Victor Stinner6036e442015-03-08 01:58:04 +010011890/* Set exception and return -1 on error, 0 for False, 1 for True */
11891static int
11892DirEntry_test_mode(DirEntry *self, int follow_symlinks, unsigned short mode_bits)
11893{
11894 PyObject *stat = NULL;
11895 PyObject *st_mode = NULL;
11896 long mode;
11897 int result;
Victor Stinner35a97c02015-03-08 02:59:09 +010011898#if defined(MS_WINDOWS) || defined(HAVE_DIRENT_D_TYPE)
Victor Stinner6036e442015-03-08 01:58:04 +010011899 int is_symlink;
11900 int need_stat;
Victor Stinner35a97c02015-03-08 02:59:09 +010011901#endif
Victor Stinner6036e442015-03-08 01:58:04 +010011902#ifdef MS_WINDOWS
11903 unsigned long dir_bits;
11904#endif
Victor Stinner35a97c02015-03-08 02:59:09 +010011905 _Py_IDENTIFIER(st_mode);
Victor Stinner6036e442015-03-08 01:58:04 +010011906
11907#ifdef MS_WINDOWS
11908 is_symlink = (self->win32_lstat.st_mode & S_IFMT) == S_IFLNK;
11909 need_stat = follow_symlinks && is_symlink;
Victor Stinner35a97c02015-03-08 02:59:09 +010011910#elif defined(HAVE_DIRENT_D_TYPE)
Victor Stinner6036e442015-03-08 01:58:04 +010011911 is_symlink = self->d_type == DT_LNK;
11912 need_stat = self->d_type == DT_UNKNOWN || (follow_symlinks && is_symlink);
11913#endif
11914
Victor Stinner35a97c02015-03-08 02:59:09 +010011915#if defined(MS_WINDOWS) || defined(HAVE_DIRENT_D_TYPE)
Victor Stinner6036e442015-03-08 01:58:04 +010011916 if (need_stat) {
Victor Stinner35a97c02015-03-08 02:59:09 +010011917#endif
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020011918 stat = os_DirEntry_stat_impl(self, follow_symlinks);
Victor Stinner6036e442015-03-08 01:58:04 +010011919 if (!stat) {
11920 if (PyErr_ExceptionMatches(PyExc_FileNotFoundError)) {
11921 /* If file doesn't exist (anymore), then return False
11922 (i.e., say it's not a file/directory) */
11923 PyErr_Clear();
11924 return 0;
11925 }
11926 goto error;
11927 }
11928 st_mode = _PyObject_GetAttrId(stat, &PyId_st_mode);
11929 if (!st_mode)
11930 goto error;
11931
11932 mode = PyLong_AsLong(st_mode);
11933 if (mode == -1 && PyErr_Occurred())
11934 goto error;
11935 Py_CLEAR(st_mode);
11936 Py_CLEAR(stat);
11937 result = (mode & S_IFMT) == mode_bits;
Victor Stinner35a97c02015-03-08 02:59:09 +010011938#if defined(MS_WINDOWS) || defined(HAVE_DIRENT_D_TYPE)
Victor Stinner6036e442015-03-08 01:58:04 +010011939 }
11940 else if (is_symlink) {
11941 assert(mode_bits != S_IFLNK);
11942 result = 0;
11943 }
11944 else {
11945 assert(mode_bits == S_IFDIR || mode_bits == S_IFREG);
11946#ifdef MS_WINDOWS
11947 dir_bits = self->win32_lstat.st_file_attributes & FILE_ATTRIBUTE_DIRECTORY;
11948 if (mode_bits == S_IFDIR)
11949 result = dir_bits != 0;
11950 else
11951 result = dir_bits == 0;
11952#else /* POSIX */
11953 if (mode_bits == S_IFDIR)
11954 result = self->d_type == DT_DIR;
11955 else
11956 result = self->d_type == DT_REG;
11957#endif
11958 }
Victor Stinner35a97c02015-03-08 02:59:09 +010011959#endif
Victor Stinner6036e442015-03-08 01:58:04 +010011960
11961 return result;
11962
11963error:
11964 Py_XDECREF(st_mode);
11965 Py_XDECREF(stat);
11966 return -1;
11967}
11968
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020011969/*[clinic input]
11970os.DirEntry.is_dir -> bool
11971 *
11972 follow_symlinks: bool = True
Victor Stinner6036e442015-03-08 01:58:04 +010011973
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020011974Return True if the entry is a directory; cached per entry.
11975[clinic start generated code]*/
11976
11977static int
11978os_DirEntry_is_dir_impl(DirEntry *self, int follow_symlinks)
11979/*[clinic end generated code: output=ad2e8d54365da287 input=0135232766f53f58]*/
11980{
11981 return DirEntry_test_mode(self, follow_symlinks, S_IFDIR);
Victor Stinner6036e442015-03-08 01:58:04 +010011982}
11983
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020011984/*[clinic input]
11985os.DirEntry.is_file -> bool
11986 *
11987 follow_symlinks: bool = True
11988
11989Return True if the entry is a file; cached per entry.
11990[clinic start generated code]*/
11991
11992static int
11993os_DirEntry_is_file_impl(DirEntry *self, int follow_symlinks)
11994/*[clinic end generated code: output=8462ade481d8a476 input=0dc90be168b041ee]*/
Victor Stinner6036e442015-03-08 01:58:04 +010011995{
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020011996 return DirEntry_test_mode(self, follow_symlinks, S_IFREG);
Victor Stinner6036e442015-03-08 01:58:04 +010011997}
11998
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020011999/*[clinic input]
12000os.DirEntry.inode
Victor Stinner6036e442015-03-08 01:58:04 +010012001
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012002Return inode of the entry; cached per entry.
12003[clinic start generated code]*/
Victor Stinner6036e442015-03-08 01:58:04 +010012004
12005static PyObject *
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012006os_DirEntry_inode_impl(DirEntry *self)
12007/*[clinic end generated code: output=156bb3a72162440e input=3ee7b872ae8649f0]*/
Victor Stinner6036e442015-03-08 01:58:04 +010012008{
12009#ifdef MS_WINDOWS
12010 if (!self->got_file_index) {
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012011 PyObject *unicode;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +030012012 const wchar_t *path;
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012013 STRUCT_STAT stat;
12014 int result;
Victor Stinner6036e442015-03-08 01:58:04 +010012015
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012016 if (!PyUnicode_FSDecoder(self->path, &unicode))
Victor Stinner6036e442015-03-08 01:58:04 +010012017 return NULL;
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012018 path = PyUnicode_AsUnicode(unicode);
12019 result = LSTAT(path, &stat);
12020 Py_DECREF(unicode);
Victor Stinner6036e442015-03-08 01:58:04 +010012021
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012022 if (result != 0)
12023 return path_object_error(self->path);
Victor Stinner6036e442015-03-08 01:58:04 +010012024
12025 self->win32_file_index = stat.st_ino;
12026 self->got_file_index = 1;
12027 }
Victor Stinner0f6d7332017-03-09 17:34:28 +010012028 Py_BUILD_ASSERT(sizeof(unsigned long long) >= sizeof(self->win32_file_index));
12029 return PyLong_FromUnsignedLongLong(self->win32_file_index);
Victor Stinner6036e442015-03-08 01:58:04 +010012030#else /* POSIX */
xdegaye50e86032017-05-22 11:15:08 +020012031 Py_BUILD_ASSERT(sizeof(unsigned long long) >= sizeof(self->d_ino));
12032 return PyLong_FromUnsignedLongLong(self->d_ino);
Victor Stinner6036e442015-03-08 01:58:04 +010012033#endif
12034}
12035
12036static PyObject *
12037DirEntry_repr(DirEntry *self)
12038{
12039 return PyUnicode_FromFormat("<DirEntry %R>", self->name);
12040}
12041
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012042/*[clinic input]
12043os.DirEntry.__fspath__
12044
12045Returns the path for the entry.
12046[clinic start generated code]*/
12047
Brett Cannon96881cd2016-06-10 14:37:21 -070012048static PyObject *
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012049os_DirEntry___fspath___impl(DirEntry *self)
12050/*[clinic end generated code: output=6dd7f7ef752e6f4f input=3c49d0cf38df4fac]*/
Brett Cannon96881cd2016-06-10 14:37:21 -070012051{
12052 Py_INCREF(self->path);
12053 return self->path;
12054}
12055
Victor Stinner6036e442015-03-08 01:58:04 +010012056static PyMemberDef DirEntry_members[] = {
12057 {"name", T_OBJECT_EX, offsetof(DirEntry, name), READONLY,
12058 "the entry's base filename, relative to scandir() \"path\" argument"},
12059 {"path", T_OBJECT_EX, offsetof(DirEntry, path), READONLY,
12060 "the entry's full path name; equivalent to os.path.join(scandir_path, entry.name)"},
12061 {NULL}
12062};
12063
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012064#include "clinic/posixmodule.c.h"
12065
Victor Stinner6036e442015-03-08 01:58:04 +010012066static PyMethodDef DirEntry_methods[] = {
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012067 OS_DIRENTRY_IS_DIR_METHODDEF
12068 OS_DIRENTRY_IS_FILE_METHODDEF
12069 OS_DIRENTRY_IS_SYMLINK_METHODDEF
12070 OS_DIRENTRY_STAT_METHODDEF
12071 OS_DIRENTRY_INODE_METHODDEF
12072 OS_DIRENTRY___FSPATH___METHODDEF
Victor Stinner6036e442015-03-08 01:58:04 +010012073 {NULL}
12074};
12075
Benjamin Peterson5646de42015-04-12 17:56:34 -040012076static PyTypeObject DirEntryType = {
Victor Stinner6036e442015-03-08 01:58:04 +010012077 PyVarObject_HEAD_INIT(NULL, 0)
12078 MODNAME ".DirEntry", /* tp_name */
12079 sizeof(DirEntry), /* tp_basicsize */
12080 0, /* tp_itemsize */
12081 /* methods */
12082 (destructor)DirEntry_dealloc, /* tp_dealloc */
12083 0, /* tp_print */
12084 0, /* tp_getattr */
12085 0, /* tp_setattr */
12086 0, /* tp_compare */
12087 (reprfunc)DirEntry_repr, /* tp_repr */
12088 0, /* tp_as_number */
12089 0, /* tp_as_sequence */
12090 0, /* tp_as_mapping */
12091 0, /* tp_hash */
12092 0, /* tp_call */
12093 0, /* tp_str */
12094 0, /* tp_getattro */
12095 0, /* tp_setattro */
12096 0, /* tp_as_buffer */
12097 Py_TPFLAGS_DEFAULT, /* tp_flags */
12098 0, /* tp_doc */
12099 0, /* tp_traverse */
12100 0, /* tp_clear */
12101 0, /* tp_richcompare */
12102 0, /* tp_weaklistoffset */
12103 0, /* tp_iter */
12104 0, /* tp_iternext */
12105 DirEntry_methods, /* tp_methods */
12106 DirEntry_members, /* tp_members */
12107};
12108
12109#ifdef MS_WINDOWS
12110
12111static wchar_t *
Serhiy Storchakadeab18d2016-05-07 16:45:18 +030012112join_path_filenameW(const wchar_t *path_wide, const wchar_t *filename)
Victor Stinner6036e442015-03-08 01:58:04 +010012113{
12114 Py_ssize_t path_len;
12115 Py_ssize_t size;
12116 wchar_t *result;
12117 wchar_t ch;
12118
12119 if (!path_wide) { /* Default arg: "." */
12120 path_wide = L".";
12121 path_len = 1;
12122 }
12123 else {
12124 path_len = wcslen(path_wide);
12125 }
12126
12127 /* The +1's are for the path separator and the NUL */
12128 size = path_len + 1 + wcslen(filename) + 1;
12129 result = PyMem_New(wchar_t, size);
12130 if (!result) {
12131 PyErr_NoMemory();
12132 return NULL;
12133 }
12134 wcscpy(result, path_wide);
12135 if (path_len > 0) {
12136 ch = result[path_len - 1];
12137 if (ch != SEP && ch != ALTSEP && ch != L':')
12138 result[path_len++] = SEP;
12139 wcscpy(result + path_len, filename);
12140 }
12141 return result;
12142}
12143
12144static PyObject *
12145DirEntry_from_find_data(path_t *path, WIN32_FIND_DATAW *dataW)
12146{
12147 DirEntry *entry;
12148 BY_HANDLE_FILE_INFORMATION file_info;
12149 ULONG reparse_tag;
12150 wchar_t *joined_path;
12151
12152 entry = PyObject_New(DirEntry, &DirEntryType);
12153 if (!entry)
12154 return NULL;
12155 entry->name = NULL;
12156 entry->path = NULL;
12157 entry->stat = NULL;
12158 entry->lstat = NULL;
12159 entry->got_file_index = 0;
12160
12161 entry->name = PyUnicode_FromWideChar(dataW->cFileName, -1);
12162 if (!entry->name)
12163 goto error;
Steve Dowercc16be82016-09-08 10:35:16 -070012164 if (path->narrow) {
12165 Py_SETREF(entry->name, PyUnicode_EncodeFSDefault(entry->name));
12166 if (!entry->name)
12167 goto error;
12168 }
Victor Stinner6036e442015-03-08 01:58:04 +010012169
12170 joined_path = join_path_filenameW(path->wide, dataW->cFileName);
12171 if (!joined_path)
12172 goto error;
12173
12174 entry->path = PyUnicode_FromWideChar(joined_path, -1);
12175 PyMem_Free(joined_path);
12176 if (!entry->path)
12177 goto error;
Steve Dowercc16be82016-09-08 10:35:16 -070012178 if (path->narrow) {
12179 Py_SETREF(entry->path, PyUnicode_EncodeFSDefault(entry->path));
12180 if (!entry->path)
12181 goto error;
12182 }
Victor Stinner6036e442015-03-08 01:58:04 +010012183
Steve Dowercc16be82016-09-08 10:35:16 -070012184 find_data_to_file_info(dataW, &file_info, &reparse_tag);
Victor Stinner6036e442015-03-08 01:58:04 +010012185 _Py_attribute_data_to_stat(&file_info, reparse_tag, &entry->win32_lstat);
12186
12187 return (PyObject *)entry;
12188
12189error:
12190 Py_DECREF(entry);
12191 return NULL;
12192}
12193
12194#else /* POSIX */
12195
12196static char *
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020012197join_path_filename(const char *path_narrow, const char* filename, Py_ssize_t filename_len)
Victor Stinner6036e442015-03-08 01:58:04 +010012198{
12199 Py_ssize_t path_len;
12200 Py_ssize_t size;
12201 char *result;
12202
12203 if (!path_narrow) { /* Default arg: "." */
12204 path_narrow = ".";
12205 path_len = 1;
12206 }
12207 else {
12208 path_len = strlen(path_narrow);
12209 }
12210
12211 if (filename_len == -1)
12212 filename_len = strlen(filename);
12213
12214 /* The +1's are for the path separator and the NUL */
12215 size = path_len + 1 + filename_len + 1;
12216 result = PyMem_New(char, size);
12217 if (!result) {
12218 PyErr_NoMemory();
12219 return NULL;
12220 }
12221 strcpy(result, path_narrow);
12222 if (path_len > 0 && result[path_len - 1] != '/')
12223 result[path_len++] = '/';
12224 strcpy(result + path_len, filename);
12225 return result;
12226}
12227
12228static PyObject *
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020012229DirEntry_from_posix_info(path_t *path, const char *name, Py_ssize_t name_len,
Victor Stinner35a97c02015-03-08 02:59:09 +010012230 ino_t d_ino
12231#ifdef HAVE_DIRENT_D_TYPE
12232 , unsigned char d_type
12233#endif
12234 )
Victor Stinner6036e442015-03-08 01:58:04 +010012235{
12236 DirEntry *entry;
12237 char *joined_path;
12238
12239 entry = PyObject_New(DirEntry, &DirEntryType);
12240 if (!entry)
12241 return NULL;
12242 entry->name = NULL;
12243 entry->path = NULL;
12244 entry->stat = NULL;
12245 entry->lstat = NULL;
12246
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012247 if (path->fd != -1) {
12248 entry->dir_fd = path->fd;
12249 joined_path = NULL;
12250 }
12251 else {
12252 entry->dir_fd = DEFAULT_DIR_FD;
12253 joined_path = join_path_filename(path->narrow, name, name_len);
12254 if (!joined_path)
12255 goto error;
12256 }
Victor Stinner6036e442015-03-08 01:58:04 +010012257
Serhiy Storchaka1180e5a2017-07-11 06:36:46 +030012258 if (!path->narrow || !PyObject_CheckBuffer(path->object)) {
Victor Stinner6036e442015-03-08 01:58:04 +010012259 entry->name = PyUnicode_DecodeFSDefaultAndSize(name, name_len);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012260 if (joined_path)
12261 entry->path = PyUnicode_DecodeFSDefault(joined_path);
Victor Stinner6036e442015-03-08 01:58:04 +010012262 }
12263 else {
12264 entry->name = PyBytes_FromStringAndSize(name, name_len);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012265 if (joined_path)
12266 entry->path = PyBytes_FromString(joined_path);
Victor Stinner6036e442015-03-08 01:58:04 +010012267 }
12268 PyMem_Free(joined_path);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012269 if (!entry->name)
12270 goto error;
12271
12272 if (path->fd != -1) {
12273 entry->path = entry->name;
12274 Py_INCREF(entry->path);
12275 }
12276 else if (!entry->path)
Victor Stinner6036e442015-03-08 01:58:04 +010012277 goto error;
12278
Victor Stinner35a97c02015-03-08 02:59:09 +010012279#ifdef HAVE_DIRENT_D_TYPE
Victor Stinner6036e442015-03-08 01:58:04 +010012280 entry->d_type = d_type;
Victor Stinner35a97c02015-03-08 02:59:09 +010012281#endif
Victor Stinner6036e442015-03-08 01:58:04 +010012282 entry->d_ino = d_ino;
12283
12284 return (PyObject *)entry;
12285
12286error:
12287 Py_XDECREF(entry);
12288 return NULL;
12289}
12290
12291#endif
12292
12293
12294typedef struct {
12295 PyObject_HEAD
12296 path_t path;
12297#ifdef MS_WINDOWS
12298 HANDLE handle;
12299 WIN32_FIND_DATAW file_data;
12300 int first_time;
12301#else /* POSIX */
12302 DIR *dirp;
12303#endif
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012304#ifdef HAVE_FDOPENDIR
12305 int fd;
12306#endif
Victor Stinner6036e442015-03-08 01:58:04 +010012307} ScandirIterator;
12308
12309#ifdef MS_WINDOWS
12310
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020012311static int
12312ScandirIterator_is_closed(ScandirIterator *iterator)
12313{
12314 return iterator->handle == INVALID_HANDLE_VALUE;
12315}
12316
Victor Stinner6036e442015-03-08 01:58:04 +010012317static void
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020012318ScandirIterator_closedir(ScandirIterator *iterator)
Victor Stinner6036e442015-03-08 01:58:04 +010012319{
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030012320 HANDLE handle = iterator->handle;
12321
12322 if (handle == INVALID_HANDLE_VALUE)
Victor Stinner6036e442015-03-08 01:58:04 +010012323 return;
12324
Victor Stinner6036e442015-03-08 01:58:04 +010012325 iterator->handle = INVALID_HANDLE_VALUE;
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030012326 Py_BEGIN_ALLOW_THREADS
12327 FindClose(handle);
12328 Py_END_ALLOW_THREADS
Victor Stinner6036e442015-03-08 01:58:04 +010012329}
12330
12331static PyObject *
12332ScandirIterator_iternext(ScandirIterator *iterator)
12333{
12334 WIN32_FIND_DATAW *file_data = &iterator->file_data;
12335 BOOL success;
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020012336 PyObject *entry;
Victor Stinner6036e442015-03-08 01:58:04 +010012337
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020012338 /* Happens if the iterator is iterated twice, or closed explicitly */
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020012339 if (iterator->handle == INVALID_HANDLE_VALUE)
Victor Stinner6036e442015-03-08 01:58:04 +010012340 return NULL;
Victor Stinner6036e442015-03-08 01:58:04 +010012341
12342 while (1) {
12343 if (!iterator->first_time) {
12344 Py_BEGIN_ALLOW_THREADS
12345 success = FindNextFileW(iterator->handle, file_data);
12346 Py_END_ALLOW_THREADS
12347 if (!success) {
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020012348 /* Error or no more files */
Victor Stinner6036e442015-03-08 01:58:04 +010012349 if (GetLastError() != ERROR_NO_MORE_FILES)
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020012350 path_error(&iterator->path);
Victor Stinner6036e442015-03-08 01:58:04 +010012351 break;
12352 }
12353 }
12354 iterator->first_time = 0;
12355
12356 /* Skip over . and .. */
12357 if (wcscmp(file_data->cFileName, L".") != 0 &&
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020012358 wcscmp(file_data->cFileName, L"..") != 0) {
12359 entry = DirEntry_from_find_data(&iterator->path, file_data);
12360 if (!entry)
12361 break;
12362 return entry;
12363 }
Victor Stinner6036e442015-03-08 01:58:04 +010012364
12365 /* Loop till we get a non-dot directory or finish iterating */
12366 }
12367
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020012368 /* Error or no more files */
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020012369 ScandirIterator_closedir(iterator);
Victor Stinner6036e442015-03-08 01:58:04 +010012370 return NULL;
12371}
12372
12373#else /* POSIX */
12374
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020012375static int
12376ScandirIterator_is_closed(ScandirIterator *iterator)
12377{
12378 return !iterator->dirp;
12379}
12380
Victor Stinner6036e442015-03-08 01:58:04 +010012381static void
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020012382ScandirIterator_closedir(ScandirIterator *iterator)
Victor Stinner6036e442015-03-08 01:58:04 +010012383{
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030012384 DIR *dirp = iterator->dirp;
12385
12386 if (!dirp)
Victor Stinner6036e442015-03-08 01:58:04 +010012387 return;
12388
Victor Stinner6036e442015-03-08 01:58:04 +010012389 iterator->dirp = NULL;
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030012390 Py_BEGIN_ALLOW_THREADS
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012391#ifdef HAVE_FDOPENDIR
12392 if (iterator->path.fd != -1)
12393 rewinddir(dirp);
12394#endif
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030012395 closedir(dirp);
12396 Py_END_ALLOW_THREADS
Victor Stinner6036e442015-03-08 01:58:04 +010012397 return;
12398}
12399
12400static PyObject *
12401ScandirIterator_iternext(ScandirIterator *iterator)
12402{
12403 struct dirent *direntp;
12404 Py_ssize_t name_len;
12405 int is_dot;
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020012406 PyObject *entry;
Victor Stinner6036e442015-03-08 01:58:04 +010012407
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020012408 /* Happens if the iterator is iterated twice, or closed explicitly */
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020012409 if (!iterator->dirp)
Victor Stinner6036e442015-03-08 01:58:04 +010012410 return NULL;
Victor Stinner6036e442015-03-08 01:58:04 +010012411
12412 while (1) {
12413 errno = 0;
12414 Py_BEGIN_ALLOW_THREADS
12415 direntp = readdir(iterator->dirp);
12416 Py_END_ALLOW_THREADS
12417
12418 if (!direntp) {
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020012419 /* Error or no more files */
Victor Stinner6036e442015-03-08 01:58:04 +010012420 if (errno != 0)
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020012421 path_error(&iterator->path);
Victor Stinner6036e442015-03-08 01:58:04 +010012422 break;
12423 }
12424
12425 /* Skip over . and .. */
12426 name_len = NAMLEN(direntp);
12427 is_dot = direntp->d_name[0] == '.' &&
12428 (name_len == 1 || (direntp->d_name[1] == '.' && name_len == 2));
12429 if (!is_dot) {
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020012430 entry = DirEntry_from_posix_info(&iterator->path, direntp->d_name,
Victor Stinner35a97c02015-03-08 02:59:09 +010012431 name_len, direntp->d_ino
12432#ifdef HAVE_DIRENT_D_TYPE
12433 , direntp->d_type
12434#endif
12435 );
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020012436 if (!entry)
12437 break;
12438 return entry;
Victor Stinner6036e442015-03-08 01:58:04 +010012439 }
12440
12441 /* Loop till we get a non-dot directory or finish iterating */
12442 }
12443
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020012444 /* Error or no more files */
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020012445 ScandirIterator_closedir(iterator);
Victor Stinner6036e442015-03-08 01:58:04 +010012446 return NULL;
12447}
12448
12449#endif
12450
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020012451static PyObject *
12452ScandirIterator_close(ScandirIterator *self, PyObject *args)
12453{
12454 ScandirIterator_closedir(self);
12455 Py_RETURN_NONE;
12456}
12457
12458static PyObject *
12459ScandirIterator_enter(PyObject *self, PyObject *args)
12460{
12461 Py_INCREF(self);
12462 return self;
12463}
12464
12465static PyObject *
12466ScandirIterator_exit(ScandirIterator *self, PyObject *args)
12467{
12468 ScandirIterator_closedir(self);
12469 Py_RETURN_NONE;
12470}
12471
Victor Stinner6036e442015-03-08 01:58:04 +010012472static void
Victor Stinner7bfa4092016-03-23 00:43:54 +010012473ScandirIterator_finalize(ScandirIterator *iterator)
12474{
12475 PyObject *error_type, *error_value, *error_traceback;
12476
12477 /* Save the current exception, if any. */
12478 PyErr_Fetch(&error_type, &error_value, &error_traceback);
12479
12480 if (!ScandirIterator_is_closed(iterator)) {
12481 ScandirIterator_closedir(iterator);
12482
12483 if (PyErr_ResourceWarning((PyObject *)iterator, 1,
12484 "unclosed scandir iterator %R", iterator)) {
12485 /* Spurious errors can appear at shutdown */
12486 if (PyErr_ExceptionMatches(PyExc_Warning)) {
12487 PyErr_WriteUnraisable((PyObject *) iterator);
12488 }
12489 }
12490 }
12491
Victor Stinner7bfa4092016-03-23 00:43:54 +010012492 path_cleanup(&iterator->path);
12493
12494 /* Restore the saved exception. */
12495 PyErr_Restore(error_type, error_value, error_traceback);
12496}
12497
12498static void
Victor Stinner6036e442015-03-08 01:58:04 +010012499ScandirIterator_dealloc(ScandirIterator *iterator)
12500{
Victor Stinner7bfa4092016-03-23 00:43:54 +010012501 if (PyObject_CallFinalizerFromDealloc((PyObject *)iterator) < 0)
12502 return;
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020012503
Victor Stinner6036e442015-03-08 01:58:04 +010012504 Py_TYPE(iterator)->tp_free((PyObject *)iterator);
12505}
12506
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020012507static PyMethodDef ScandirIterator_methods[] = {
12508 {"__enter__", (PyCFunction)ScandirIterator_enter, METH_NOARGS},
12509 {"__exit__", (PyCFunction)ScandirIterator_exit, METH_VARARGS},
12510 {"close", (PyCFunction)ScandirIterator_close, METH_NOARGS},
12511 {NULL}
12512};
12513
Benjamin Peterson5646de42015-04-12 17:56:34 -040012514static PyTypeObject ScandirIteratorType = {
Victor Stinner6036e442015-03-08 01:58:04 +010012515 PyVarObject_HEAD_INIT(NULL, 0)
12516 MODNAME ".ScandirIterator", /* tp_name */
12517 sizeof(ScandirIterator), /* tp_basicsize */
12518 0, /* tp_itemsize */
12519 /* methods */
12520 (destructor)ScandirIterator_dealloc, /* tp_dealloc */
12521 0, /* tp_print */
12522 0, /* tp_getattr */
12523 0, /* tp_setattr */
12524 0, /* tp_compare */
12525 0, /* tp_repr */
12526 0, /* tp_as_number */
12527 0, /* tp_as_sequence */
12528 0, /* tp_as_mapping */
12529 0, /* tp_hash */
12530 0, /* tp_call */
12531 0, /* tp_str */
12532 0, /* tp_getattro */
12533 0, /* tp_setattro */
12534 0, /* tp_as_buffer */
Victor Stinner7bfa4092016-03-23 00:43:54 +010012535 Py_TPFLAGS_DEFAULT
12536 | Py_TPFLAGS_HAVE_FINALIZE, /* tp_flags */
Victor Stinner6036e442015-03-08 01:58:04 +010012537 0, /* tp_doc */
12538 0, /* tp_traverse */
12539 0, /* tp_clear */
12540 0, /* tp_richcompare */
12541 0, /* tp_weaklistoffset */
12542 PyObject_SelfIter, /* tp_iter */
12543 (iternextfunc)ScandirIterator_iternext, /* tp_iternext */
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020012544 ScandirIterator_methods, /* tp_methods */
Victor Stinner7bfa4092016-03-23 00:43:54 +010012545 0, /* tp_members */
12546 0, /* tp_getset */
12547 0, /* tp_base */
12548 0, /* tp_dict */
12549 0, /* tp_descr_get */
12550 0, /* tp_descr_set */
12551 0, /* tp_dictoffset */
12552 0, /* tp_init */
12553 0, /* tp_alloc */
12554 0, /* tp_new */
12555 0, /* tp_free */
12556 0, /* tp_is_gc */
12557 0, /* tp_bases */
12558 0, /* tp_mro */
12559 0, /* tp_cache */
12560 0, /* tp_subclasses */
12561 0, /* tp_weaklist */
12562 0, /* tp_del */
12563 0, /* tp_version_tag */
12564 (destructor)ScandirIterator_finalize, /* tp_finalize */
Victor Stinner6036e442015-03-08 01:58:04 +010012565};
12566
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012567/*[clinic input]
12568os.scandir
12569
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012570 path : path_t(nullable=True, allow_fd='PATH_HAVE_FDOPENDIR') = None
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012571
12572Return an iterator of DirEntry objects for given path.
12573
12574path can be specified as either str, bytes or path-like object. If path
12575is bytes, the names of yielded DirEntry objects will also be bytes; in
12576all other circumstances they will be str.
12577
12578If path is None, uses the path='.'.
12579[clinic start generated code]*/
12580
Victor Stinner6036e442015-03-08 01:58:04 +010012581static PyObject *
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012582os_scandir_impl(PyObject *module, path_t *path)
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012583/*[clinic end generated code: output=6eb2668b675ca89e input=b139dc1c57f60846]*/
Victor Stinner6036e442015-03-08 01:58:04 +010012584{
12585 ScandirIterator *iterator;
Victor Stinner6036e442015-03-08 01:58:04 +010012586#ifdef MS_WINDOWS
12587 wchar_t *path_strW;
12588#else
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012589 const char *path_str;
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012590#ifdef HAVE_FDOPENDIR
12591 int fd = -1;
12592#endif
Victor Stinner6036e442015-03-08 01:58:04 +010012593#endif
12594
12595 iterator = PyObject_New(ScandirIterator, &ScandirIteratorType);
12596 if (!iterator)
12597 return NULL;
Victor Stinner6036e442015-03-08 01:58:04 +010012598
12599#ifdef MS_WINDOWS
12600 iterator->handle = INVALID_HANDLE_VALUE;
12601#else
12602 iterator->dirp = NULL;
12603#endif
12604
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012605 memcpy(&iterator->path, path, sizeof(path_t));
Serhiy Storchaka095ef732017-02-09 20:05:51 +020012606 /* Move the ownership to iterator->path */
12607 path->object = NULL;
12608 path->cleanup = NULL;
Victor Stinner6036e442015-03-08 01:58:04 +010012609
12610#ifdef MS_WINDOWS
Victor Stinner6036e442015-03-08 01:58:04 +010012611 iterator->first_time = 1;
12612
12613 path_strW = join_path_filenameW(iterator->path.wide, L"*.*");
12614 if (!path_strW)
12615 goto error;
12616
12617 Py_BEGIN_ALLOW_THREADS
12618 iterator->handle = FindFirstFileW(path_strW, &iterator->file_data);
12619 Py_END_ALLOW_THREADS
12620
12621 PyMem_Free(path_strW);
12622
12623 if (iterator->handle == INVALID_HANDLE_VALUE) {
12624 path_error(&iterator->path);
12625 goto error;
12626 }
12627#else /* POSIX */
Victor Stinner6036e442015-03-08 01:58:04 +010012628 errno = 0;
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012629#ifdef HAVE_FDOPENDIR
12630 if (path->fd != -1) {
12631 /* closedir() closes the FD, so we duplicate it */
12632 fd = _Py_dup(path->fd);
12633 if (fd == -1)
12634 goto error;
12635
12636 Py_BEGIN_ALLOW_THREADS
12637 iterator->dirp = fdopendir(fd);
12638 Py_END_ALLOW_THREADS
12639 }
12640 else
12641#endif
12642 {
12643 if (iterator->path.narrow)
12644 path_str = iterator->path.narrow;
12645 else
12646 path_str = ".";
12647
12648 Py_BEGIN_ALLOW_THREADS
12649 iterator->dirp = opendir(path_str);
12650 Py_END_ALLOW_THREADS
12651 }
Victor Stinner6036e442015-03-08 01:58:04 +010012652
12653 if (!iterator->dirp) {
12654 path_error(&iterator->path);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012655#ifdef HAVE_FDOPENDIR
12656 if (fd != -1) {
12657 Py_BEGIN_ALLOW_THREADS
12658 close(fd);
12659 Py_END_ALLOW_THREADS
12660 }
12661#endif
Victor Stinner6036e442015-03-08 01:58:04 +010012662 goto error;
12663 }
12664#endif
12665
12666 return (PyObject *)iterator;
12667
12668error:
12669 Py_DECREF(iterator);
12670 return NULL;
12671}
12672
Ethan Furman410ef8e2016-06-04 12:06:26 -070012673/*
12674 Return the file system path representation of the object.
12675
12676 If the object is str or bytes, then allow it to pass through with
12677 an incremented refcount. If the object defines __fspath__(), then
12678 return the result of that method. All other types raise a TypeError.
12679*/
12680PyObject *
12681PyOS_FSPath(PyObject *path)
12682{
Brett Cannon3f9183b2016-08-26 14:44:48 -070012683 /* For error message reasons, this function is manually inlined in
12684 path_converter(). */
Ethan Furman410ef8e2016-06-04 12:06:26 -070012685 _Py_IDENTIFIER(__fspath__);
12686 PyObject *func = NULL;
12687 PyObject *path_repr = NULL;
12688
12689 if (PyUnicode_Check(path) || PyBytes_Check(path)) {
12690 Py_INCREF(path);
12691 return path;
12692 }
12693
12694 func = _PyObject_LookupSpecial(path, &PyId___fspath__);
12695 if (NULL == func) {
12696 return PyErr_Format(PyExc_TypeError,
12697 "expected str, bytes or os.PathLike object, "
Brett Cannonc78ca1e2016-06-24 12:03:43 -070012698 "not %.200s",
12699 Py_TYPE(path)->tp_name);
Ethan Furman410ef8e2016-06-04 12:06:26 -070012700 }
12701
Victor Stinnerf17c3de2016-12-06 18:46:19 +010012702 path_repr = _PyObject_CallNoArg(func);
Ethan Furman410ef8e2016-06-04 12:06:26 -070012703 Py_DECREF(func);
Brett Cannon044283a2016-07-15 10:41:49 -070012704 if (NULL == path_repr) {
12705 return NULL;
12706 }
12707
Brett Cannonc78ca1e2016-06-24 12:03:43 -070012708 if (!(PyUnicode_Check(path_repr) || PyBytes_Check(path_repr))) {
12709 PyErr_Format(PyExc_TypeError,
12710 "expected %.200s.__fspath__() to return str or bytes, "
12711 "not %.200s", Py_TYPE(path)->tp_name,
12712 Py_TYPE(path_repr)->tp_name);
12713 Py_DECREF(path_repr);
12714 return NULL;
12715 }
12716
Ethan Furman410ef8e2016-06-04 12:06:26 -070012717 return path_repr;
12718}
12719
12720/*[clinic input]
12721os.fspath
12722
12723 path: object
12724
12725Return the file system path representation of the object.
12726
Brett Cannonb4f43e92016-06-09 14:32:08 -070012727If the object is str or bytes, then allow it to pass through as-is. If the
12728object defines __fspath__(), then return the result of that method. All other
12729types raise a TypeError.
Ethan Furman410ef8e2016-06-04 12:06:26 -070012730[clinic start generated code]*/
12731
12732static PyObject *
Serhiy Storchaka2954f832016-07-07 18:20:03 +030012733os_fspath_impl(PyObject *module, PyObject *path)
12734/*[clinic end generated code: output=c3c3b78ecff2914f input=e357165f7b22490f]*/
Ethan Furman410ef8e2016-06-04 12:06:26 -070012735{
12736 return PyOS_FSPath(path);
12737}
Victor Stinner6036e442015-03-08 01:58:04 +010012738
Victor Stinner9b1f4742016-09-06 16:18:52 -070012739#ifdef HAVE_GETRANDOM_SYSCALL
12740/*[clinic input]
12741os.getrandom
12742
12743 size: Py_ssize_t
12744 flags: int=0
12745
12746Obtain a series of random bytes.
12747[clinic start generated code]*/
12748
12749static PyObject *
12750os_getrandom_impl(PyObject *module, Py_ssize_t size, int flags)
12751/*[clinic end generated code: output=b3a618196a61409c input=59bafac39c594947]*/
12752{
Victor Stinner9b1f4742016-09-06 16:18:52 -070012753 PyObject *bytes;
Victor Stinnerec2319c2016-09-20 23:00:59 +020012754 Py_ssize_t n;
Victor Stinner9b1f4742016-09-06 16:18:52 -070012755
12756 if (size < 0) {
12757 errno = EINVAL;
12758 return posix_error();
12759 }
12760
Victor Stinnerec2319c2016-09-20 23:00:59 +020012761 bytes = PyBytes_FromStringAndSize(NULL, size);
12762 if (bytes == NULL) {
Victor Stinner9b1f4742016-09-06 16:18:52 -070012763 PyErr_NoMemory();
12764 return NULL;
12765 }
12766
12767 while (1) {
Victor Stinnerec2319c2016-09-20 23:00:59 +020012768 n = syscall(SYS_getrandom,
12769 PyBytes_AS_STRING(bytes),
12770 PyBytes_GET_SIZE(bytes),
12771 flags);
Victor Stinner9b1f4742016-09-06 16:18:52 -070012772 if (n < 0 && errno == EINTR) {
12773 if (PyErr_CheckSignals() < 0) {
Victor Stinnerec2319c2016-09-20 23:00:59 +020012774 goto error;
Victor Stinner9b1f4742016-09-06 16:18:52 -070012775 }
Victor Stinnerec2319c2016-09-20 23:00:59 +020012776
12777 /* getrandom() was interrupted by a signal: retry */
Victor Stinner9b1f4742016-09-06 16:18:52 -070012778 continue;
12779 }
12780 break;
12781 }
12782
12783 if (n < 0) {
Victor Stinner9b1f4742016-09-06 16:18:52 -070012784 PyErr_SetFromErrno(PyExc_OSError);
Victor Stinnerec2319c2016-09-20 23:00:59 +020012785 goto error;
Victor Stinner9b1f4742016-09-06 16:18:52 -070012786 }
12787
Victor Stinnerec2319c2016-09-20 23:00:59 +020012788 if (n != size) {
12789 _PyBytes_Resize(&bytes, n);
12790 }
Victor Stinner9b1f4742016-09-06 16:18:52 -070012791
12792 return bytes;
Victor Stinnerec2319c2016-09-20 23:00:59 +020012793
12794error:
12795 Py_DECREF(bytes);
12796 return NULL;
Victor Stinner9b1f4742016-09-06 16:18:52 -070012797}
12798#endif /* HAVE_GETRANDOM_SYSCALL */
12799
Larry Hastings31826802013-10-19 00:09:25 -070012800
Fred Drake5ab8eaf1999-12-09 21:13:07 +000012801static PyMethodDef posix_methods[] = {
Larry Hastings31826802013-10-19 00:09:25 -070012802
12803 OS_STAT_METHODDEF
12804 OS_ACCESS_METHODDEF
12805 OS_TTYNAME_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100012806 OS_CHDIR_METHODDEF
12807 OS_CHFLAGS_METHODDEF
12808 OS_CHMOD_METHODDEF
12809 OS_FCHMOD_METHODDEF
12810 OS_LCHMOD_METHODDEF
12811 OS_CHOWN_METHODDEF
12812 OS_FCHOWN_METHODDEF
12813 OS_LCHOWN_METHODDEF
12814 OS_LCHFLAGS_METHODDEF
12815 OS_CHROOT_METHODDEF
12816 OS_CTERMID_METHODDEF
12817 OS_GETCWD_METHODDEF
12818 OS_GETCWDB_METHODDEF
12819 OS_LINK_METHODDEF
12820 OS_LISTDIR_METHODDEF
12821 OS_LSTAT_METHODDEF
12822 OS_MKDIR_METHODDEF
12823 OS_NICE_METHODDEF
12824 OS_GETPRIORITY_METHODDEF
12825 OS_SETPRIORITY_METHODDEF
Pablo Galindo6c6ddf92018-01-29 01:56:10 +000012826 OS_POSIX_SPAWN_METHODDEF
Guido van Rossumb6775db1994-08-01 11:34:53 +000012827#ifdef HAVE_READLINK
Larry Hastings9cf065c2012-06-22 16:30:09 -070012828 {"readlink", (PyCFunction)posix_readlink,
12829 METH_VARARGS | METH_KEYWORDS,
12830 readlink__doc__},
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +000012831#endif /* HAVE_READLINK */
Brian Curtind40e6f72010-07-08 21:39:08 +000012832#if !defined(HAVE_READLINK) && defined(MS_WINDOWS)
Larry Hastings9cf065c2012-06-22 16:30:09 -070012833 {"readlink", (PyCFunction)win_readlink,
12834 METH_VARARGS | METH_KEYWORDS,
12835 readlink__doc__},
Brian Curtind40e6f72010-07-08 21:39:08 +000012836#endif /* !defined(HAVE_READLINK) && defined(MS_WINDOWS) */
Larry Hastings2f936352014-08-05 14:04:04 +100012837 OS_RENAME_METHODDEF
12838 OS_REPLACE_METHODDEF
12839 OS_RMDIR_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100012840 OS_SYMLINK_METHODDEF
12841 OS_SYSTEM_METHODDEF
12842 OS_UMASK_METHODDEF
12843 OS_UNAME_METHODDEF
12844 OS_UNLINK_METHODDEF
12845 OS_REMOVE_METHODDEF
12846 OS_UTIME_METHODDEF
12847 OS_TIMES_METHODDEF
12848 OS__EXIT_METHODDEF
12849 OS_EXECV_METHODDEF
12850 OS_EXECVE_METHODDEF
12851 OS_SPAWNV_METHODDEF
12852 OS_SPAWNVE_METHODDEF
12853 OS_FORK1_METHODDEF
12854 OS_FORK_METHODDEF
Antoine Pitrou346cbd32017-05-27 17:50:54 +020012855 OS_REGISTER_AT_FORK_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100012856 OS_SCHED_GET_PRIORITY_MAX_METHODDEF
12857 OS_SCHED_GET_PRIORITY_MIN_METHODDEF
12858 OS_SCHED_GETPARAM_METHODDEF
12859 OS_SCHED_GETSCHEDULER_METHODDEF
12860 OS_SCHED_RR_GET_INTERVAL_METHODDEF
12861 OS_SCHED_SETPARAM_METHODDEF
12862 OS_SCHED_SETSCHEDULER_METHODDEF
12863 OS_SCHED_YIELD_METHODDEF
12864 OS_SCHED_SETAFFINITY_METHODDEF
12865 OS_SCHED_GETAFFINITY_METHODDEF
12866 OS_OPENPTY_METHODDEF
12867 OS_FORKPTY_METHODDEF
12868 OS_GETEGID_METHODDEF
12869 OS_GETEUID_METHODDEF
12870 OS_GETGID_METHODDEF
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +020012871#ifdef HAVE_GETGROUPLIST
12872 {"getgrouplist", posix_getgrouplist, METH_VARARGS, posix_getgrouplist__doc__},
12873#endif
Larry Hastings2f936352014-08-05 14:04:04 +100012874 OS_GETGROUPS_METHODDEF
12875 OS_GETPID_METHODDEF
12876 OS_GETPGRP_METHODDEF
12877 OS_GETPPID_METHODDEF
12878 OS_GETUID_METHODDEF
12879 OS_GETLOGIN_METHODDEF
12880 OS_KILL_METHODDEF
12881 OS_KILLPG_METHODDEF
12882 OS_PLOCK_METHODDEF
Thomas Heller8b7a9572007-08-31 06:44:36 +000012883#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -070012884 OS_STARTFILE_METHODDEF
Thomas Heller8b7a9572007-08-31 06:44:36 +000012885#endif
Larry Hastings2f936352014-08-05 14:04:04 +100012886 OS_SETUID_METHODDEF
12887 OS_SETEUID_METHODDEF
12888 OS_SETREUID_METHODDEF
12889 OS_SETGID_METHODDEF
12890 OS_SETEGID_METHODDEF
12891 OS_SETREGID_METHODDEF
12892 OS_SETGROUPS_METHODDEF
Antoine Pitroub7572f02009-12-02 20:46:48 +000012893#ifdef HAVE_INITGROUPS
Victor Stinner8c62be82010-05-06 00:08:46 +000012894 {"initgroups", posix_initgroups, METH_VARARGS, posix_initgroups__doc__},
Antoine Pitroub7572f02009-12-02 20:46:48 +000012895#endif /* HAVE_INITGROUPS */
Larry Hastings2f936352014-08-05 14:04:04 +100012896 OS_GETPGID_METHODDEF
12897 OS_SETPGRP_METHODDEF
12898 OS_WAIT_METHODDEF
12899 OS_WAIT3_METHODDEF
12900 OS_WAIT4_METHODDEF
12901 OS_WAITID_METHODDEF
12902 OS_WAITPID_METHODDEF
12903 OS_GETSID_METHODDEF
12904 OS_SETSID_METHODDEF
12905 OS_SETPGID_METHODDEF
12906 OS_TCGETPGRP_METHODDEF
12907 OS_TCSETPGRP_METHODDEF
12908 OS_OPEN_METHODDEF
12909 OS_CLOSE_METHODDEF
12910 OS_CLOSERANGE_METHODDEF
12911 OS_DEVICE_ENCODING_METHODDEF
12912 OS_DUP_METHODDEF
12913 OS_DUP2_METHODDEF
12914 OS_LOCKF_METHODDEF
12915 OS_LSEEK_METHODDEF
12916 OS_READ_METHODDEF
12917 OS_READV_METHODDEF
12918 OS_PREAD_METHODDEF
Pablo Galindo4defba32018-01-27 16:16:37 +000012919 OS_PREADV_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100012920 OS_WRITE_METHODDEF
12921 OS_WRITEV_METHODDEF
12922 OS_PWRITE_METHODDEF
Pablo Galindo4defba32018-01-27 16:16:37 +000012923 OS_PWRITEV_METHODDEF
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000012924#ifdef HAVE_SENDFILE
12925 {"sendfile", (PyCFunction)posix_sendfile, METH_VARARGS | METH_KEYWORDS,
12926 posix_sendfile__doc__},
12927#endif
Larry Hastings2f936352014-08-05 14:04:04 +100012928 OS_FSTAT_METHODDEF
12929 OS_ISATTY_METHODDEF
12930 OS_PIPE_METHODDEF
12931 OS_PIPE2_METHODDEF
12932 OS_MKFIFO_METHODDEF
12933 OS_MKNOD_METHODDEF
12934 OS_MAJOR_METHODDEF
12935 OS_MINOR_METHODDEF
12936 OS_MAKEDEV_METHODDEF
12937 OS_FTRUNCATE_METHODDEF
12938 OS_TRUNCATE_METHODDEF
12939 OS_POSIX_FALLOCATE_METHODDEF
12940 OS_POSIX_FADVISE_METHODDEF
12941 OS_PUTENV_METHODDEF
12942 OS_UNSETENV_METHODDEF
12943 OS_STRERROR_METHODDEF
12944 OS_FCHDIR_METHODDEF
12945 OS_FSYNC_METHODDEF
12946 OS_SYNC_METHODDEF
12947 OS_FDATASYNC_METHODDEF
12948 OS_WCOREDUMP_METHODDEF
12949 OS_WIFCONTINUED_METHODDEF
12950 OS_WIFSTOPPED_METHODDEF
12951 OS_WIFSIGNALED_METHODDEF
12952 OS_WIFEXITED_METHODDEF
12953 OS_WEXITSTATUS_METHODDEF
12954 OS_WTERMSIG_METHODDEF
12955 OS_WSTOPSIG_METHODDEF
12956 OS_FSTATVFS_METHODDEF
12957 OS_STATVFS_METHODDEF
12958 OS_CONFSTR_METHODDEF
12959 OS_SYSCONF_METHODDEF
12960 OS_FPATHCONF_METHODDEF
12961 OS_PATHCONF_METHODDEF
12962 OS_ABORT_METHODDEF
Serhiy Storchakaf0b50152015-05-13 00:52:39 +030012963 OS__GETFULLPATHNAME_METHODDEF
12964 OS__ISDIR_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100012965 OS__GETDISKUSAGE_METHODDEF
12966 OS__GETFINALPATHNAME_METHODDEF
12967 OS__GETVOLUMEPATHNAME_METHODDEF
12968 OS_GETLOADAVG_METHODDEF
12969 OS_URANDOM_METHODDEF
12970 OS_SETRESUID_METHODDEF
12971 OS_SETRESGID_METHODDEF
12972 OS_GETRESUID_METHODDEF
12973 OS_GETRESGID_METHODDEF
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000012974
Larry Hastings2f936352014-08-05 14:04:04 +100012975 OS_GETXATTR_METHODDEF
12976 OS_SETXATTR_METHODDEF
12977 OS_REMOVEXATTR_METHODDEF
12978 OS_LISTXATTR_METHODDEF
12979
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012980#if defined(TERMSIZE_USE_CONIO) || defined(TERMSIZE_USE_IOCTL)
12981 {"get_terminal_size", get_terminal_size, METH_VARARGS, termsize__doc__},
12982#endif
Larry Hastings2f936352014-08-05 14:04:04 +100012983 OS_CPU_COUNT_METHODDEF
12984 OS_GET_INHERITABLE_METHODDEF
12985 OS_SET_INHERITABLE_METHODDEF
12986 OS_GET_HANDLE_INHERITABLE_METHODDEF
12987 OS_SET_HANDLE_INHERITABLE_METHODDEF
Victor Stinner1db9e7b2014-07-29 22:32:47 +020012988#ifndef MS_WINDOWS
12989 {"get_blocking", posix_get_blocking, METH_VARARGS, get_blocking__doc__},
12990 {"set_blocking", posix_set_blocking, METH_VARARGS, set_blocking__doc__},
12991#endif
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012992 OS_SCANDIR_METHODDEF
Ethan Furman410ef8e2016-06-04 12:06:26 -070012993 OS_FSPATH_METHODDEF
Victor Stinner9b1f4742016-09-06 16:18:52 -070012994 OS_GETRANDOM_METHODDEF
Victor Stinner8c62be82010-05-06 00:08:46 +000012995 {NULL, NULL} /* Sentinel */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000012996};
12997
12998
Brian Curtin52173d42010-12-02 18:29:18 +000012999#if defined(HAVE_SYMLINK) && defined(MS_WINDOWS)
Brian Curtin3b4499c2010-12-28 14:31:47 +000013000static int
Brian Curtin52173d42010-12-02 18:29:18 +000013001enable_symlink()
13002{
13003 HANDLE tok;
13004 TOKEN_PRIVILEGES tok_priv;
13005 LUID luid;
Brian Curtin52173d42010-12-02 18:29:18 +000013006
13007 if (!OpenProcessToken(GetCurrentProcess(), TOKEN_ALL_ACCESS, &tok))
Brian Curtin3b4499c2010-12-28 14:31:47 +000013008 return 0;
Brian Curtin52173d42010-12-02 18:29:18 +000013009
13010 if (!LookupPrivilegeValue(NULL, SE_CREATE_SYMBOLIC_LINK_NAME, &luid))
Brian Curtin3b4499c2010-12-28 14:31:47 +000013011 return 0;
Brian Curtin52173d42010-12-02 18:29:18 +000013012
13013 tok_priv.PrivilegeCount = 1;
13014 tok_priv.Privileges[0].Luid = luid;
13015 tok_priv.Privileges[0].Attributes = SE_PRIVILEGE_ENABLED;
13016
13017 if (!AdjustTokenPrivileges(tok, FALSE, &tok_priv,
13018 sizeof(TOKEN_PRIVILEGES),
13019 (PTOKEN_PRIVILEGES) NULL, (PDWORD) NULL))
Brian Curtin3b4499c2010-12-28 14:31:47 +000013020 return 0;
Brian Curtin52173d42010-12-02 18:29:18 +000013021
Brian Curtin3b4499c2010-12-28 14:31:47 +000013022 /* ERROR_NOT_ALL_ASSIGNED returned when the privilege can't be assigned. */
13023 return GetLastError() == ERROR_NOT_ALL_ASSIGNED ? 0 : 1;
Brian Curtin52173d42010-12-02 18:29:18 +000013024}
13025#endif /* defined(HAVE_SYMLINK) && defined(MS_WINDOWS) */
13026
Barry Warsaw4a342091996-12-19 23:50:02 +000013027static int
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013028all_ins(PyObject *m)
Barry Warsaw4a342091996-12-19 23:50:02 +000013029{
Guido van Rossum94f6f721999-01-06 18:42:14 +000013030#ifdef F_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013031 if (PyModule_AddIntMacro(m, F_OK)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013032#endif
Guido van Rossum94f6f721999-01-06 18:42:14 +000013033#ifdef R_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013034 if (PyModule_AddIntMacro(m, R_OK)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013035#endif
Guido van Rossum94f6f721999-01-06 18:42:14 +000013036#ifdef W_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013037 if (PyModule_AddIntMacro(m, W_OK)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013038#endif
Guido van Rossum94f6f721999-01-06 18:42:14 +000013039#ifdef X_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013040 if (PyModule_AddIntMacro(m, X_OK)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013041#endif
Fred Drakec9680921999-12-13 16:37:25 +000013042#ifdef NGROUPS_MAX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013043 if (PyModule_AddIntMacro(m, NGROUPS_MAX)) return -1;
Fred Drakec9680921999-12-13 16:37:25 +000013044#endif
Fred Drake5ab8eaf1999-12-09 21:13:07 +000013045#ifdef TMP_MAX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013046 if (PyModule_AddIntMacro(m, TMP_MAX)) return -1;
Fred Drake5ab8eaf1999-12-09 21:13:07 +000013047#endif
Fred Drake106c1a02002-04-23 15:58:02 +000013048#ifdef WCONTINUED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013049 if (PyModule_AddIntMacro(m, WCONTINUED)) return -1;
Fred Drake106c1a02002-04-23 15:58:02 +000013050#endif
Barry Warsaw4a342091996-12-19 23:50:02 +000013051#ifdef WNOHANG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013052 if (PyModule_AddIntMacro(m, WNOHANG)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013053#endif
Fred Drake106c1a02002-04-23 15:58:02 +000013054#ifdef WUNTRACED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013055 if (PyModule_AddIntMacro(m, WUNTRACED)) return -1;
Fred Drake106c1a02002-04-23 15:58:02 +000013056#endif
Barry Warsaw4a342091996-12-19 23:50:02 +000013057#ifdef O_RDONLY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013058 if (PyModule_AddIntMacro(m, O_RDONLY)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013059#endif
13060#ifdef O_WRONLY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013061 if (PyModule_AddIntMacro(m, O_WRONLY)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013062#endif
13063#ifdef O_RDWR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013064 if (PyModule_AddIntMacro(m, O_RDWR)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013065#endif
13066#ifdef O_NDELAY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013067 if (PyModule_AddIntMacro(m, O_NDELAY)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013068#endif
13069#ifdef O_NONBLOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013070 if (PyModule_AddIntMacro(m, O_NONBLOCK)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013071#endif
13072#ifdef O_APPEND
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013073 if (PyModule_AddIntMacro(m, O_APPEND)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013074#endif
13075#ifdef O_DSYNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013076 if (PyModule_AddIntMacro(m, O_DSYNC)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013077#endif
13078#ifdef O_RSYNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013079 if (PyModule_AddIntMacro(m, O_RSYNC)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013080#endif
13081#ifdef O_SYNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013082 if (PyModule_AddIntMacro(m, O_SYNC)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013083#endif
13084#ifdef O_NOCTTY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013085 if (PyModule_AddIntMacro(m, O_NOCTTY)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013086#endif
13087#ifdef O_CREAT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013088 if (PyModule_AddIntMacro(m, O_CREAT)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013089#endif
13090#ifdef O_EXCL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013091 if (PyModule_AddIntMacro(m, O_EXCL)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013092#endif
13093#ifdef O_TRUNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013094 if (PyModule_AddIntMacro(m, O_TRUNC)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013095#endif
Guido van Rossum98d9d091997-08-08 21:48:51 +000013096#ifdef O_BINARY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013097 if (PyModule_AddIntMacro(m, O_BINARY)) return -1;
Guido van Rossum98d9d091997-08-08 21:48:51 +000013098#endif
13099#ifdef O_TEXT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013100 if (PyModule_AddIntMacro(m, O_TEXT)) return -1;
Guido van Rossum98d9d091997-08-08 21:48:51 +000013101#endif
Jesus Cea1d642d22012-04-24 20:59:17 +020013102#ifdef O_XATTR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013103 if (PyModule_AddIntMacro(m, O_XATTR)) return -1;
Jesus Cea1d642d22012-04-24 20:59:17 +020013104#endif
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000013105#ifdef O_LARGEFILE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013106 if (PyModule_AddIntMacro(m, O_LARGEFILE)) return -1;
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000013107#endif
doko@ubuntu.comfcff4372016-06-13 16:33:04 +020013108#ifndef __GNU__
Skip Montanaro5ff14922005-05-16 02:42:22 +000013109#ifdef O_SHLOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013110 if (PyModule_AddIntMacro(m, O_SHLOCK)) return -1;
Skip Montanaro5ff14922005-05-16 02:42:22 +000013111#endif
13112#ifdef O_EXLOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013113 if (PyModule_AddIntMacro(m, O_EXLOCK)) return -1;
Skip Montanaro5ff14922005-05-16 02:42:22 +000013114#endif
doko@ubuntu.comfcff4372016-06-13 16:33:04 +020013115#endif
Jesus Ceacf381202012-04-24 20:44:40 +020013116#ifdef O_EXEC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013117 if (PyModule_AddIntMacro(m, O_EXEC)) return -1;
Jesus Ceacf381202012-04-24 20:44:40 +020013118#endif
13119#ifdef O_SEARCH
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013120 if (PyModule_AddIntMacro(m, O_SEARCH)) return -1;
Jesus Ceacf381202012-04-24 20:44:40 +020013121#endif
Benjamin Peterson3b965a22013-03-13 10:27:41 -050013122#ifdef O_PATH
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013123 if (PyModule_AddIntMacro(m, O_PATH)) return -1;
Benjamin Peterson3b965a22013-03-13 10:27:41 -050013124#endif
Jesus Ceacf381202012-04-24 20:44:40 +020013125#ifdef O_TTY_INIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013126 if (PyModule_AddIntMacro(m, O_TTY_INIT)) return -1;
Jesus Ceacf381202012-04-24 20:44:40 +020013127#endif
Christian Heimes177b3f92013-08-16 14:35:09 +020013128#ifdef O_TMPFILE
13129 if (PyModule_AddIntMacro(m, O_TMPFILE)) return -1;
13130#endif
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000013131#ifdef PRIO_PROCESS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013132 if (PyModule_AddIntMacro(m, PRIO_PROCESS)) return -1;
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000013133#endif
13134#ifdef PRIO_PGRP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013135 if (PyModule_AddIntMacro(m, PRIO_PGRP)) return -1;
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000013136#endif
13137#ifdef PRIO_USER
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013138 if (PyModule_AddIntMacro(m, PRIO_USER)) return -1;
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000013139#endif
Charles-François Natali1e045b12011-05-22 20:42:32 +020013140#ifdef O_CLOEXEC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013141 if (PyModule_AddIntMacro(m, O_CLOEXEC)) return -1;
Charles-François Natali1e045b12011-05-22 20:42:32 +020013142#endif
Jesus Cea1d642d22012-04-24 20:59:17 +020013143#ifdef O_ACCMODE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013144 if (PyModule_AddIntMacro(m, O_ACCMODE)) return -1;
Jesus Cea1d642d22012-04-24 20:59:17 +020013145#endif
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000013146
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000013147
Jesus Cea94363612012-06-22 18:32:07 +020013148#ifdef SEEK_HOLE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013149 if (PyModule_AddIntMacro(m, SEEK_HOLE)) return -1;
Jesus Cea94363612012-06-22 18:32:07 +020013150#endif
13151#ifdef SEEK_DATA
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013152 if (PyModule_AddIntMacro(m, SEEK_DATA)) return -1;
Jesus Cea94363612012-06-22 18:32:07 +020013153#endif
13154
Tim Peters5aa91602002-01-30 05:46:57 +000013155/* MS Windows */
13156#ifdef O_NOINHERIT
Victor Stinner8c62be82010-05-06 00:08:46 +000013157 /* Don't inherit in child processes. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013158 if (PyModule_AddIntMacro(m, O_NOINHERIT)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013159#endif
13160#ifdef _O_SHORT_LIVED
Victor Stinner8c62be82010-05-06 00:08:46 +000013161 /* Optimize for short life (keep in memory). */
13162 /* MS forgot to define this one with a non-underscore form too. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013163 if (PyModule_AddIntConstant(m, "O_SHORT_LIVED", _O_SHORT_LIVED)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013164#endif
13165#ifdef O_TEMPORARY
Victor Stinner8c62be82010-05-06 00:08:46 +000013166 /* Automatically delete when last handle is closed. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013167 if (PyModule_AddIntMacro(m, O_TEMPORARY)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013168#endif
13169#ifdef O_RANDOM
Victor Stinner8c62be82010-05-06 00:08:46 +000013170 /* Optimize for random access. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013171 if (PyModule_AddIntMacro(m, O_RANDOM)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013172#endif
13173#ifdef O_SEQUENTIAL
Victor Stinner8c62be82010-05-06 00:08:46 +000013174 /* Optimize for sequential access. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013175 if (PyModule_AddIntMacro(m, O_SEQUENTIAL)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013176#endif
13177
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000013178/* GNU extensions. */
Alexandre Vassalottibee32532008-05-16 18:15:12 +000013179#ifdef O_ASYNC
Victor Stinner8c62be82010-05-06 00:08:46 +000013180 /* Send a SIGIO signal whenever input or output
13181 becomes available on file descriptor */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013182 if (PyModule_AddIntMacro(m, O_ASYNC)) return -1;
Alexandre Vassalottibee32532008-05-16 18:15:12 +000013183#endif
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000013184#ifdef O_DIRECT
Victor Stinner8c62be82010-05-06 00:08:46 +000013185 /* Direct disk access. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013186 if (PyModule_AddIntMacro(m, O_DIRECT)) return -1;
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000013187#endif
13188#ifdef O_DIRECTORY
Victor Stinner8c62be82010-05-06 00:08:46 +000013189 /* Must be a directory. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013190 if (PyModule_AddIntMacro(m, O_DIRECTORY)) return -1;
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000013191#endif
13192#ifdef O_NOFOLLOW
Victor Stinner8c62be82010-05-06 00:08:46 +000013193 /* Do not follow links. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013194 if (PyModule_AddIntMacro(m, O_NOFOLLOW)) return -1;
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000013195#endif
Jesus Cea1d642d22012-04-24 20:59:17 +020013196#ifdef O_NOLINKS
13197 /* Fails if link count of the named file is greater than 1 */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013198 if (PyModule_AddIntMacro(m, O_NOLINKS)) return -1;
Jesus Cea1d642d22012-04-24 20:59:17 +020013199#endif
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +000013200#ifdef O_NOATIME
Victor Stinner8c62be82010-05-06 00:08:46 +000013201 /* Do not update the access time. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013202 if (PyModule_AddIntMacro(m, O_NOATIME)) return -1;
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +000013203#endif
Guido van Rossumd48f2521997-12-05 22:19:34 +000013204
Victor Stinner8c62be82010-05-06 00:08:46 +000013205 /* These come from sysexits.h */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013206#ifdef EX_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013207 if (PyModule_AddIntMacro(m, EX_OK)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013208#endif /* EX_OK */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013209#ifdef EX_USAGE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013210 if (PyModule_AddIntMacro(m, EX_USAGE)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013211#endif /* EX_USAGE */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013212#ifdef EX_DATAERR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013213 if (PyModule_AddIntMacro(m, EX_DATAERR)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013214#endif /* EX_DATAERR */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013215#ifdef EX_NOINPUT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013216 if (PyModule_AddIntMacro(m, EX_NOINPUT)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013217#endif /* EX_NOINPUT */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013218#ifdef EX_NOUSER
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013219 if (PyModule_AddIntMacro(m, EX_NOUSER)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013220#endif /* EX_NOUSER */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013221#ifdef EX_NOHOST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013222 if (PyModule_AddIntMacro(m, EX_NOHOST)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013223#endif /* EX_NOHOST */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013224#ifdef EX_UNAVAILABLE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013225 if (PyModule_AddIntMacro(m, EX_UNAVAILABLE)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013226#endif /* EX_UNAVAILABLE */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013227#ifdef EX_SOFTWARE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013228 if (PyModule_AddIntMacro(m, EX_SOFTWARE)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013229#endif /* EX_SOFTWARE */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013230#ifdef EX_OSERR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013231 if (PyModule_AddIntMacro(m, EX_OSERR)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013232#endif /* EX_OSERR */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013233#ifdef EX_OSFILE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013234 if (PyModule_AddIntMacro(m, EX_OSFILE)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013235#endif /* EX_OSFILE */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013236#ifdef EX_CANTCREAT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013237 if (PyModule_AddIntMacro(m, EX_CANTCREAT)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013238#endif /* EX_CANTCREAT */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013239#ifdef EX_IOERR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013240 if (PyModule_AddIntMacro(m, EX_IOERR)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013241#endif /* EX_IOERR */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013242#ifdef EX_TEMPFAIL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013243 if (PyModule_AddIntMacro(m, EX_TEMPFAIL)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013244#endif /* EX_TEMPFAIL */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013245#ifdef EX_PROTOCOL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013246 if (PyModule_AddIntMacro(m, EX_PROTOCOL)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013247#endif /* EX_PROTOCOL */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013248#ifdef EX_NOPERM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013249 if (PyModule_AddIntMacro(m, EX_NOPERM)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013250#endif /* EX_NOPERM */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013251#ifdef EX_CONFIG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013252 if (PyModule_AddIntMacro(m, EX_CONFIG)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013253#endif /* EX_CONFIG */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013254#ifdef EX_NOTFOUND
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013255 if (PyModule_AddIntMacro(m, EX_NOTFOUND)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013256#endif /* EX_NOTFOUND */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013257
Amaury Forgeot d'Arc66d00ad2010-09-10 18:11:45 +000013258 /* statvfs */
Andrew M. Kuchling4ea04a32010-08-18 22:30:34 +000013259#ifdef ST_RDONLY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013260 if (PyModule_AddIntMacro(m, ST_RDONLY)) return -1;
Andrew M. Kuchling4ea04a32010-08-18 22:30:34 +000013261#endif /* ST_RDONLY */
13262#ifdef ST_NOSUID
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013263 if (PyModule_AddIntMacro(m, ST_NOSUID)) return -1;
Andrew M. Kuchling4ea04a32010-08-18 22:30:34 +000013264#endif /* ST_NOSUID */
13265
doko@ubuntu.comca616a22013-12-08 15:23:07 +010013266 /* GNU extensions */
13267#ifdef ST_NODEV
13268 if (PyModule_AddIntMacro(m, ST_NODEV)) return -1;
13269#endif /* ST_NODEV */
13270#ifdef ST_NOEXEC
13271 if (PyModule_AddIntMacro(m, ST_NOEXEC)) return -1;
13272#endif /* ST_NOEXEC */
13273#ifdef ST_SYNCHRONOUS
13274 if (PyModule_AddIntMacro(m, ST_SYNCHRONOUS)) return -1;
13275#endif /* ST_SYNCHRONOUS */
13276#ifdef ST_MANDLOCK
13277 if (PyModule_AddIntMacro(m, ST_MANDLOCK)) return -1;
13278#endif /* ST_MANDLOCK */
13279#ifdef ST_WRITE
13280 if (PyModule_AddIntMacro(m, ST_WRITE)) return -1;
13281#endif /* ST_WRITE */
13282#ifdef ST_APPEND
13283 if (PyModule_AddIntMacro(m, ST_APPEND)) return -1;
13284#endif /* ST_APPEND */
13285#ifdef ST_NOATIME
13286 if (PyModule_AddIntMacro(m, ST_NOATIME)) return -1;
13287#endif /* ST_NOATIME */
13288#ifdef ST_NODIRATIME
13289 if (PyModule_AddIntMacro(m, ST_NODIRATIME)) return -1;
13290#endif /* ST_NODIRATIME */
13291#ifdef ST_RELATIME
13292 if (PyModule_AddIntMacro(m, ST_RELATIME)) return -1;
13293#endif /* ST_RELATIME */
13294
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000013295 /* FreeBSD sendfile() constants */
13296#ifdef SF_NODISKIO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013297 if (PyModule_AddIntMacro(m, SF_NODISKIO)) return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000013298#endif
13299#ifdef SF_MNOWAIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013300 if (PyModule_AddIntMacro(m, SF_MNOWAIT)) return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000013301#endif
13302#ifdef SF_SYNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013303 if (PyModule_AddIntMacro(m, SF_SYNC)) return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000013304#endif
13305
Ross Lagerwall7807c352011-03-17 20:20:30 +020013306 /* constants for posix_fadvise */
13307#ifdef POSIX_FADV_NORMAL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013308 if (PyModule_AddIntMacro(m, POSIX_FADV_NORMAL)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013309#endif
13310#ifdef POSIX_FADV_SEQUENTIAL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013311 if (PyModule_AddIntMacro(m, POSIX_FADV_SEQUENTIAL)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013312#endif
13313#ifdef POSIX_FADV_RANDOM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013314 if (PyModule_AddIntMacro(m, POSIX_FADV_RANDOM)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013315#endif
13316#ifdef POSIX_FADV_NOREUSE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013317 if (PyModule_AddIntMacro(m, POSIX_FADV_NOREUSE)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013318#endif
13319#ifdef POSIX_FADV_WILLNEED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013320 if (PyModule_AddIntMacro(m, POSIX_FADV_WILLNEED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013321#endif
13322#ifdef POSIX_FADV_DONTNEED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013323 if (PyModule_AddIntMacro(m, POSIX_FADV_DONTNEED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013324#endif
13325
13326 /* constants for waitid */
13327#if defined(HAVE_SYS_WAIT_H) && defined(HAVE_WAITID)
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013328 if (PyModule_AddIntMacro(m, P_PID)) return -1;
13329 if (PyModule_AddIntMacro(m, P_PGID)) return -1;
13330 if (PyModule_AddIntMacro(m, P_ALL)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013331#endif
13332#ifdef WEXITED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013333 if (PyModule_AddIntMacro(m, WEXITED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013334#endif
13335#ifdef WNOWAIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013336 if (PyModule_AddIntMacro(m, WNOWAIT)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013337#endif
13338#ifdef WSTOPPED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013339 if (PyModule_AddIntMacro(m, WSTOPPED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013340#endif
13341#ifdef CLD_EXITED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013342 if (PyModule_AddIntMacro(m, CLD_EXITED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013343#endif
13344#ifdef CLD_DUMPED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013345 if (PyModule_AddIntMacro(m, CLD_DUMPED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013346#endif
13347#ifdef CLD_TRAPPED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013348 if (PyModule_AddIntMacro(m, CLD_TRAPPED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013349#endif
13350#ifdef CLD_CONTINUED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013351 if (PyModule_AddIntMacro(m, CLD_CONTINUED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013352#endif
13353
13354 /* constants for lockf */
13355#ifdef F_LOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013356 if (PyModule_AddIntMacro(m, F_LOCK)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013357#endif
13358#ifdef F_TLOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013359 if (PyModule_AddIntMacro(m, F_TLOCK)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013360#endif
13361#ifdef F_ULOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013362 if (PyModule_AddIntMacro(m, F_ULOCK)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013363#endif
13364#ifdef F_TEST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013365 if (PyModule_AddIntMacro(m, F_TEST)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013366#endif
13367
Pablo Galindo4defba32018-01-27 16:16:37 +000013368#ifdef RWF_DSYNC
13369 if (PyModule_AddIntConstant(m, "RWF_DSYNC", RWF_DSYNC)) return -1;
13370#endif
13371#ifdef RWF_HIPRI
13372 if (PyModule_AddIntConstant(m, "RWF_HIPRI", RWF_HIPRI)) return -1;
13373#endif
13374#ifdef RWF_SYNC
13375 if (PyModule_AddIntConstant(m, "RWF_SYNC", RWF_SYNC)) return -1;
13376#endif
13377#ifdef RWF_NOWAIT
13378 if (PyModule_AddIntConstant(m, "RWF_NOWAIT", RWF_NOWAIT)) return -1;
13379#endif
13380
Pablo Galindo6c6ddf92018-01-29 01:56:10 +000013381/* constants for posix_spawn */
13382#ifdef HAVE_POSIX_SPAWN
13383 if (PyModule_AddIntConstant(m, "POSIX_SPAWN_OPEN", POSIX_SPAWN_OPEN)) return -1;
13384 if (PyModule_AddIntConstant(m, "POSIX_SPAWN_CLOSE", POSIX_SPAWN_CLOSE)) return -1;
13385 if (PyModule_AddIntConstant(m, "POSIX_SPAWN_DUP2", POSIX_SPAWN_DUP2)) return -1;
13386#endif
13387
Guido van Rossum246bc171999-02-01 23:54:31 +000013388#ifdef HAVE_SPAWNV
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013389 if (PyModule_AddIntConstant(m, "P_WAIT", _P_WAIT)) return -1;
13390 if (PyModule_AddIntConstant(m, "P_NOWAIT", _P_NOWAIT)) return -1;
13391 if (PyModule_AddIntConstant(m, "P_OVERLAY", _OLD_P_OVERLAY)) return -1;
13392 if (PyModule_AddIntConstant(m, "P_NOWAITO", _P_NOWAITO)) return -1;
13393 if (PyModule_AddIntConstant(m, "P_DETACH", _P_DETACH)) return -1;
Guido van Rossum246bc171999-02-01 23:54:31 +000013394#endif
13395
Benjamin Peterson94b580d2011-08-02 17:30:04 -050013396#ifdef HAVE_SCHED_H
Benjamin Petersondbaa5592016-07-30 23:21:50 -070013397#ifdef SCHED_OTHER
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013398 if (PyModule_AddIntMacro(m, SCHED_OTHER)) return -1;
Benjamin Petersondbaa5592016-07-30 23:21:50 -070013399#endif
13400#ifdef SCHED_FIFO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013401 if (PyModule_AddIntMacro(m, SCHED_FIFO)) return -1;
Benjamin Petersondbaa5592016-07-30 23:21:50 -070013402#endif
13403#ifdef SCHED_RR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013404 if (PyModule_AddIntMacro(m, SCHED_RR)) return -1;
Benjamin Petersondbaa5592016-07-30 23:21:50 -070013405#endif
Benjamin Peterson94b580d2011-08-02 17:30:04 -050013406#ifdef SCHED_SPORADIC
messi Liao0d322182017-06-13 22:30:43 +080013407 if (PyModule_AddIntMacro(m, SCHED_SPORADIC)) return -1;
Benjamin Peterson94b580d2011-08-02 17:30:04 -050013408#endif
Benjamin Peterson94b580d2011-08-02 17:30:04 -050013409#ifdef SCHED_BATCH
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013410 if (PyModule_AddIntMacro(m, SCHED_BATCH)) return -1;
Benjamin Peterson94b580d2011-08-02 17:30:04 -050013411#endif
13412#ifdef SCHED_IDLE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013413 if (PyModule_AddIntMacro(m, SCHED_IDLE)) return -1;
Benjamin Peterson94b580d2011-08-02 17:30:04 -050013414#endif
13415#ifdef SCHED_RESET_ON_FORK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013416 if (PyModule_AddIntMacro(m, SCHED_RESET_ON_FORK)) return -1;
Benjamin Peterson94b580d2011-08-02 17:30:04 -050013417#endif
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020013418#ifdef SCHED_SYS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013419 if (PyModule_AddIntMacro(m, SCHED_SYS)) return -1;
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020013420#endif
13421#ifdef SCHED_IA
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013422 if (PyModule_AddIntMacro(m, SCHED_IA)) return -1;
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020013423#endif
13424#ifdef SCHED_FSS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013425 if (PyModule_AddIntMacro(m, SCHED_FSS)) return -1;
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020013426#endif
13427#ifdef SCHED_FX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013428 if (PyModule_AddIntConstant(m, "SCHED_FX", SCHED_FSS)) return -1;
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020013429#endif
Benjamin Peterson94b580d2011-08-02 17:30:04 -050013430#endif
13431
Benjamin Peterson9428d532011-09-14 11:45:52 -040013432#ifdef USE_XATTRS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013433 if (PyModule_AddIntMacro(m, XATTR_CREATE)) return -1;
13434 if (PyModule_AddIntMacro(m, XATTR_REPLACE)) return -1;
13435 if (PyModule_AddIntMacro(m, XATTR_SIZE_MAX)) return -1;
Benjamin Peterson799bd802011-08-31 22:15:17 -040013436#endif
13437
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030013438#if HAVE_DECL_RTLD_LAZY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013439 if (PyModule_AddIntMacro(m, RTLD_LAZY)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020013440#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030013441#if HAVE_DECL_RTLD_NOW
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013442 if (PyModule_AddIntMacro(m, RTLD_NOW)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020013443#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030013444#if HAVE_DECL_RTLD_GLOBAL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013445 if (PyModule_AddIntMacro(m, RTLD_GLOBAL)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020013446#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030013447#if HAVE_DECL_RTLD_LOCAL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013448 if (PyModule_AddIntMacro(m, RTLD_LOCAL)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020013449#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030013450#if HAVE_DECL_RTLD_NODELETE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013451 if (PyModule_AddIntMacro(m, RTLD_NODELETE)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020013452#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030013453#if HAVE_DECL_RTLD_NOLOAD
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013454 if (PyModule_AddIntMacro(m, RTLD_NOLOAD)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020013455#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030013456#if HAVE_DECL_RTLD_DEEPBIND
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013457 if (PyModule_AddIntMacro(m, RTLD_DEEPBIND)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020013458#endif
Michael Feltc5ae1692017-12-19 13:58:49 +010013459#if HAVE_DECL_RTLD_MEMBER
13460 if (PyModule_AddIntMacro(m, RTLD_MEMBER)) return -1;
13461#endif
Victor Stinner8b905bd2011-10-25 13:34:04 +020013462
Victor Stinner9b1f4742016-09-06 16:18:52 -070013463#ifdef HAVE_GETRANDOM_SYSCALL
13464 if (PyModule_AddIntMacro(m, GRND_RANDOM)) return -1;
13465 if (PyModule_AddIntMacro(m, GRND_NONBLOCK)) return -1;
13466#endif
13467
Victor Stinner8c62be82010-05-06 00:08:46 +000013468 return 0;
Barry Warsaw4a342091996-12-19 23:50:02 +000013469}
13470
13471
Martin v. Löwis1a214512008-06-11 05:26:20 +000013472static struct PyModuleDef posixmodule = {
Victor Stinner8c62be82010-05-06 00:08:46 +000013473 PyModuleDef_HEAD_INIT,
13474 MODNAME,
13475 posix__doc__,
13476 -1,
13477 posix_methods,
13478 NULL,
13479 NULL,
13480 NULL,
13481 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +000013482};
13483
13484
Serhiy Storchaka2d06e842015-12-25 19:53:18 +020013485static const char * const have_functions[] = {
Larry Hastings9cf065c2012-06-22 16:30:09 -070013486
13487#ifdef HAVE_FACCESSAT
13488 "HAVE_FACCESSAT",
13489#endif
13490
13491#ifdef HAVE_FCHDIR
13492 "HAVE_FCHDIR",
13493#endif
13494
13495#ifdef HAVE_FCHMOD
13496 "HAVE_FCHMOD",
13497#endif
13498
13499#ifdef HAVE_FCHMODAT
13500 "HAVE_FCHMODAT",
13501#endif
13502
13503#ifdef HAVE_FCHOWN
13504 "HAVE_FCHOWN",
13505#endif
13506
Larry Hastings00964ed2013-08-12 13:49:30 -040013507#ifdef HAVE_FCHOWNAT
13508 "HAVE_FCHOWNAT",
13509#endif
13510
Larry Hastings9cf065c2012-06-22 16:30:09 -070013511#ifdef HAVE_FEXECVE
13512 "HAVE_FEXECVE",
13513#endif
13514
13515#ifdef HAVE_FDOPENDIR
13516 "HAVE_FDOPENDIR",
13517#endif
13518
Georg Brandl306336b2012-06-24 12:55:33 +020013519#ifdef HAVE_FPATHCONF
13520 "HAVE_FPATHCONF",
13521#endif
13522
Larry Hastings9cf065c2012-06-22 16:30:09 -070013523#ifdef HAVE_FSTATAT
13524 "HAVE_FSTATAT",
13525#endif
13526
13527#ifdef HAVE_FSTATVFS
13528 "HAVE_FSTATVFS",
13529#endif
13530
Steve Dowerfe0a41a2015-03-20 19:50:46 -070013531#if defined HAVE_FTRUNCATE || defined MS_WINDOWS
Georg Brandl306336b2012-06-24 12:55:33 +020013532 "HAVE_FTRUNCATE",
13533#endif
13534
Larry Hastings9cf065c2012-06-22 16:30:09 -070013535#ifdef HAVE_FUTIMENS
13536 "HAVE_FUTIMENS",
13537#endif
13538
13539#ifdef HAVE_FUTIMES
13540 "HAVE_FUTIMES",
13541#endif
13542
13543#ifdef HAVE_FUTIMESAT
13544 "HAVE_FUTIMESAT",
13545#endif
13546
13547#ifdef HAVE_LINKAT
13548 "HAVE_LINKAT",
13549#endif
13550
13551#ifdef HAVE_LCHFLAGS
13552 "HAVE_LCHFLAGS",
13553#endif
13554
13555#ifdef HAVE_LCHMOD
13556 "HAVE_LCHMOD",
13557#endif
13558
13559#ifdef HAVE_LCHOWN
13560 "HAVE_LCHOWN",
13561#endif
13562
13563#ifdef HAVE_LSTAT
13564 "HAVE_LSTAT",
13565#endif
13566
13567#ifdef HAVE_LUTIMES
13568 "HAVE_LUTIMES",
13569#endif
13570
13571#ifdef HAVE_MKDIRAT
13572 "HAVE_MKDIRAT",
13573#endif
13574
13575#ifdef HAVE_MKFIFOAT
13576 "HAVE_MKFIFOAT",
13577#endif
13578
13579#ifdef HAVE_MKNODAT
13580 "HAVE_MKNODAT",
13581#endif
13582
13583#ifdef HAVE_OPENAT
13584 "HAVE_OPENAT",
13585#endif
13586
13587#ifdef HAVE_READLINKAT
13588 "HAVE_READLINKAT",
13589#endif
13590
13591#ifdef HAVE_RENAMEAT
13592 "HAVE_RENAMEAT",
13593#endif
13594
13595#ifdef HAVE_SYMLINKAT
13596 "HAVE_SYMLINKAT",
13597#endif
13598
13599#ifdef HAVE_UNLINKAT
13600 "HAVE_UNLINKAT",
13601#endif
13602
13603#ifdef HAVE_UTIMENSAT
13604 "HAVE_UTIMENSAT",
13605#endif
13606
13607#ifdef MS_WINDOWS
13608 "MS_WINDOWS",
13609#endif
13610
13611 NULL
13612};
13613
13614
Mark Hammondfe51c6d2002-08-02 02:27:13 +000013615PyMODINIT_FUNC
Thomas Woutersf3f33dc2000-07-21 06:00:07 +000013616INITFUNC(void)
Guido van Rossumb6775db1994-08-01 11:34:53 +000013617{
Victor Stinner8c62be82010-05-06 00:08:46 +000013618 PyObject *m, *v;
Larry Hastings9cf065c2012-06-22 16:30:09 -070013619 PyObject *list;
Serhiy Storchaka2d06e842015-12-25 19:53:18 +020013620 const char * const *trace;
Tim Peters5aa91602002-01-30 05:46:57 +000013621
Brian Curtin52173d42010-12-02 18:29:18 +000013622#if defined(HAVE_SYMLINK) && defined(MS_WINDOWS)
Brian Curtin3b4499c2010-12-28 14:31:47 +000013623 win32_can_symlink = enable_symlink();
Brian Curtin52173d42010-12-02 18:29:18 +000013624#endif
13625
Victor Stinner8c62be82010-05-06 00:08:46 +000013626 m = PyModule_Create(&posixmodule);
13627 if (m == NULL)
13628 return NULL;
Tim Peters5aa91602002-01-30 05:46:57 +000013629
Victor Stinner8c62be82010-05-06 00:08:46 +000013630 /* Initialize environ dictionary */
13631 v = convertenviron();
13632 Py_XINCREF(v);
13633 if (v == NULL || PyModule_AddObject(m, "environ", v) != 0)
13634 return NULL;
13635 Py_DECREF(v);
Fred Drakec9680921999-12-13 16:37:25 +000013636
Victor Stinner8c62be82010-05-06 00:08:46 +000013637 if (all_ins(m))
13638 return NULL;
Barry Warsaw4a342091996-12-19 23:50:02 +000013639
Victor Stinner8c62be82010-05-06 00:08:46 +000013640 if (setup_confname_tables(m))
13641 return NULL;
Fred Drakebec628d1999-12-15 18:31:10 +000013642
Victor Stinner8c62be82010-05-06 00:08:46 +000013643 Py_INCREF(PyExc_OSError);
13644 PyModule_AddObject(m, "error", PyExc_OSError);
Fred Drake762e2061999-08-26 17:23:54 +000013645
Guido van Rossumb3d39562000-01-31 18:41:26 +000013646#ifdef HAVE_PUTENV
Victor Stinner8c62be82010-05-06 00:08:46 +000013647 if (posix_putenv_garbage == NULL)
13648 posix_putenv_garbage = PyDict_New();
Guido van Rossumb3d39562000-01-31 18:41:26 +000013649#endif
Guido van Rossum98bf58f2001-10-18 20:34:25 +000013650
Victor Stinner8c62be82010-05-06 00:08:46 +000013651 if (!initialized) {
Ross Lagerwall7807c352011-03-17 20:20:30 +020013652#if defined(HAVE_WAITID) && !defined(__APPLE__)
13653 waitid_result_desc.name = MODNAME ".waitid_result";
Victor Stinner1c8f0592013-07-22 22:24:54 +020013654 if (PyStructSequence_InitType2(&WaitidResultType, &waitid_result_desc) < 0)
13655 return NULL;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013656#endif
13657
Christian Heimes25827622013-10-12 01:27:08 +020013658 stat_result_desc.name = "os.stat_result"; /* see issue #19209 */
Victor Stinner8c62be82010-05-06 00:08:46 +000013659 stat_result_desc.fields[7].name = PyStructSequence_UnnamedField;
13660 stat_result_desc.fields[8].name = PyStructSequence_UnnamedField;
13661 stat_result_desc.fields[9].name = PyStructSequence_UnnamedField;
Victor Stinner1c8f0592013-07-22 22:24:54 +020013662 if (PyStructSequence_InitType2(&StatResultType, &stat_result_desc) < 0)
13663 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +000013664 structseq_new = StatResultType.tp_new;
13665 StatResultType.tp_new = statresult_new;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000013666
Christian Heimes25827622013-10-12 01:27:08 +020013667 statvfs_result_desc.name = "os.statvfs_result"; /* see issue #19209 */
Victor Stinner1c8f0592013-07-22 22:24:54 +020013668 if (PyStructSequence_InitType2(&StatVFSResultType,
13669 &statvfs_result_desc) < 0)
13670 return NULL;
Martin v. Löwis05bfe1f2008-12-29 18:21:47 +000013671#ifdef NEED_TICKS_PER_SECOND
13672# if defined(HAVE_SYSCONF) && defined(_SC_CLK_TCK)
Victor Stinner8c62be82010-05-06 00:08:46 +000013673 ticks_per_second = sysconf(_SC_CLK_TCK);
Martin v. Löwis05bfe1f2008-12-29 18:21:47 +000013674# elif defined(HZ)
Victor Stinner8c62be82010-05-06 00:08:46 +000013675 ticks_per_second = HZ;
Martin v. Löwis05bfe1f2008-12-29 18:21:47 +000013676# else
Victor Stinner8c62be82010-05-06 00:08:46 +000013677 ticks_per_second = 60; /* magic fallback value; may be bogus */
Martin v. Löwis05bfe1f2008-12-29 18:21:47 +000013678# endif
13679#endif
Benjamin Peterson94b580d2011-08-02 17:30:04 -050013680
Benjamin Peterson0163c9a2011-08-02 18:11:38 -050013681#if defined(HAVE_SCHED_SETPARAM) || defined(HAVE_SCHED_SETSCHEDULER)
Benjamin Peterson94b580d2011-08-02 17:30:04 -050013682 sched_param_desc.name = MODNAME ".sched_param";
Victor Stinner1c8f0592013-07-22 22:24:54 +020013683 if (PyStructSequence_InitType2(&SchedParamType, &sched_param_desc) < 0)
13684 return NULL;
Larry Hastings2f936352014-08-05 14:04:04 +100013685 SchedParamType.tp_new = os_sched_param;
Benjamin Peterson94b580d2011-08-02 17:30:04 -050013686#endif
Antoine Pitroubcf2b592012-02-08 23:28:36 +010013687
13688 /* initialize TerminalSize_info */
Victor Stinner1c8f0592013-07-22 22:24:54 +020013689 if (PyStructSequence_InitType2(&TerminalSizeType,
13690 &TerminalSize_desc) < 0)
13691 return NULL;
Victor Stinner6036e442015-03-08 01:58:04 +010013692
13693 /* initialize scandir types */
13694 if (PyType_Ready(&ScandirIteratorType) < 0)
13695 return NULL;
13696 if (PyType_Ready(&DirEntryType) < 0)
13697 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +000013698 }
Ross Lagerwall7807c352011-03-17 20:20:30 +020013699#if defined(HAVE_WAITID) && !defined(__APPLE__)
13700 Py_INCREF((PyObject*) &WaitidResultType);
13701 PyModule_AddObject(m, "waitid_result", (PyObject*) &WaitidResultType);
13702#endif
Victor Stinner8c62be82010-05-06 00:08:46 +000013703 Py_INCREF((PyObject*) &StatResultType);
13704 PyModule_AddObject(m, "stat_result", (PyObject*) &StatResultType);
13705 Py_INCREF((PyObject*) &StatVFSResultType);
13706 PyModule_AddObject(m, "statvfs_result",
13707 (PyObject*) &StatVFSResultType);
Benjamin Petersone3298dd2011-08-02 18:40:46 -050013708
13709#if defined(HAVE_SCHED_SETPARAM) || defined(HAVE_SCHED_SETSCHEDULER)
Benjamin Peterson94b580d2011-08-02 17:30:04 -050013710 Py_INCREF(&SchedParamType);
13711 PyModule_AddObject(m, "sched_param", (PyObject *)&SchedParamType);
Benjamin Petersone3298dd2011-08-02 18:40:46 -050013712#endif
Thomas Wouters477c8d52006-05-27 19:21:47 +000013713
Larry Hastings605a62d2012-06-24 04:33:36 -070013714 times_result_desc.name = MODNAME ".times_result";
Victor Stinner1c8f0592013-07-22 22:24:54 +020013715 if (PyStructSequence_InitType2(&TimesResultType, &times_result_desc) < 0)
13716 return NULL;
Larry Hastings605a62d2012-06-24 04:33:36 -070013717 PyModule_AddObject(m, "times_result", (PyObject *)&TimesResultType);
13718
13719 uname_result_desc.name = MODNAME ".uname_result";
Victor Stinner1c8f0592013-07-22 22:24:54 +020013720 if (PyStructSequence_InitType2(&UnameResultType, &uname_result_desc) < 0)
13721 return NULL;
Larry Hastings605a62d2012-06-24 04:33:36 -070013722 PyModule_AddObject(m, "uname_result", (PyObject *)&UnameResultType);
13723
Thomas Wouters477c8d52006-05-27 19:21:47 +000013724#ifdef __APPLE__
Victor Stinner8c62be82010-05-06 00:08:46 +000013725 /*
13726 * Step 2 of weak-linking support on Mac OS X.
13727 *
13728 * The code below removes functions that are not available on the
13729 * currently active platform.
13730 *
13731 * This block allow one to use a python binary that was build on
Larry Hastings9cf065c2012-06-22 16:30:09 -070013732 * OSX 10.4 on OSX 10.3, without losing access to new APIs on
Victor Stinner8c62be82010-05-06 00:08:46 +000013733 * OSX 10.4.
13734 */
Thomas Wouters477c8d52006-05-27 19:21:47 +000013735#ifdef HAVE_FSTATVFS
Victor Stinner8c62be82010-05-06 00:08:46 +000013736 if (fstatvfs == NULL) {
13737 if (PyObject_DelAttrString(m, "fstatvfs") == -1) {
13738 return NULL;
13739 }
13740 }
Thomas Wouters477c8d52006-05-27 19:21:47 +000013741#endif /* HAVE_FSTATVFS */
13742
13743#ifdef HAVE_STATVFS
Victor Stinner8c62be82010-05-06 00:08:46 +000013744 if (statvfs == NULL) {
13745 if (PyObject_DelAttrString(m, "statvfs") == -1) {
13746 return NULL;
13747 }
13748 }
Thomas Wouters477c8d52006-05-27 19:21:47 +000013749#endif /* HAVE_STATVFS */
13750
13751# ifdef HAVE_LCHOWN
Victor Stinner8c62be82010-05-06 00:08:46 +000013752 if (lchown == NULL) {
13753 if (PyObject_DelAttrString(m, "lchown") == -1) {
13754 return NULL;
13755 }
13756 }
Thomas Wouters477c8d52006-05-27 19:21:47 +000013757#endif /* HAVE_LCHOWN */
13758
13759
13760#endif /* __APPLE__ */
Antoine Pitroubcf2b592012-02-08 23:28:36 +010013761
Antoine Pitrou9d20e0e2012-09-12 18:01:36 +020013762 Py_INCREF(&TerminalSizeType);
Antoine Pitroubcf2b592012-02-08 23:28:36 +010013763 PyModule_AddObject(m, "terminal_size", (PyObject*) &TerminalSizeType);
13764
Larry Hastings6fe20b32012-04-19 15:07:49 -070013765 billion = PyLong_FromLong(1000000000);
13766 if (!billion)
13767 return NULL;
13768
Larry Hastings9cf065c2012-06-22 16:30:09 -070013769 /* suppress "function not used" warnings */
13770 {
13771 int ignored;
13772 fd_specified("", -1);
13773 follow_symlinks_specified("", 1);
13774 dir_fd_and_follow_symlinks_invalid("chmod", DEFAULT_DIR_FD, 1);
13775 dir_fd_converter(Py_None, &ignored);
13776 dir_fd_unavailable(Py_None, &ignored);
13777 }
13778
13779 /*
13780 * provide list of locally available functions
13781 * so os.py can populate support_* lists
13782 */
13783 list = PyList_New(0);
13784 if (!list)
13785 return NULL;
13786 for (trace = have_functions; *trace; trace++) {
13787 PyObject *unicode = PyUnicode_DecodeASCII(*trace, strlen(*trace), NULL);
13788 if (!unicode)
13789 return NULL;
13790 if (PyList_Append(list, unicode))
13791 return NULL;
13792 Py_DECREF(unicode);
13793 }
13794 PyModule_AddObject(m, "_have_functions", list);
Ned Deilyeb3be662016-08-15 14:40:38 -040013795
13796 Py_INCREF((PyObject *) &DirEntryType);
Brett Cannona32c4d02016-06-24 14:14:44 -070013797 PyModule_AddObject(m, "DirEntry", (PyObject *)&DirEntryType);
Larry Hastings9cf065c2012-06-22 16:30:09 -070013798
13799 initialized = 1;
13800
Victor Stinner8c62be82010-05-06 00:08:46 +000013801 return m;
Guido van Rossumb6775db1994-08-01 11:34:53 +000013802}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000013803
13804#ifdef __cplusplus
13805}
13806#endif