blob: 130e8c1b36f7deca6e31683b5cd33eec8147d9c0 [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
Miss Islington (bot)01dd52f2018-02-22 11:02:12 -08003723 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +10003724 /
3725
3726A helper function for samepath on windows.
3727[clinic start generated code]*/
3728
Larry Hastings2f936352014-08-05 14:04:04 +10003729static PyObject *
Miss Islington (bot)01dd52f2018-02-22 11:02:12 -08003730os__getfinalpathname_impl(PyObject *module, path_t *path)
3731/*[clinic end generated code: output=621a3c79bc29ebfa input=2b6b6c7cbad5fb84]*/
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;
Miss Islington (bot)01dd52f2018-02-22 11:02:12 -08003738 const char *err = NULL;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00003739
Miss Islington (bot)01dd52f2018-02-22 11:02:12 -08003740 Py_BEGIN_ALLOW_THREADS
Brian Curtind40e6f72010-07-08 21:39:08 +00003741 hFile = CreateFileW(
Miss Islington (bot)01dd52f2018-02-22 11:02:12 -08003742 path->wide,
Brian Curtind40e6f72010-07-08 21:39:08 +00003743 0, /* desired access */
3744 0, /* share mode */
3745 NULL, /* security attributes */
3746 OPEN_EXISTING,
3747 /* FILE_FLAG_BACKUP_SEMANTICS is required to open a directory */
3748 FILE_FLAG_BACKUP_SEMANTICS,
3749 NULL);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00003750
Miss Islington (bot)01dd52f2018-02-22 11:02:12 -08003751 if (hFile == INVALID_HANDLE_VALUE) {
3752 err = "CreateFileW";
3753 goto done1;
3754 }
Brian Curtind40e6f72010-07-08 21:39:08 +00003755
3756 /* We have a good handle to the target, use it to determine the
3757 target path name. */
Steve Dower2ea51c92015-03-20 21:49:12 -07003758 buf_size = GetFinalPathNameByHandleW(hFile, 0, 0, VOLUME_NAME_NT);
Brian Curtind40e6f72010-07-08 21:39:08 +00003759
Miss Islington (bot)01dd52f2018-02-22 11:02:12 -08003760 if (!buf_size) {
3761 err = "GetFinalPathNameByHandle";
3762 goto done1;
3763 }
3764done1:
3765 Py_END_ALLOW_THREADS
3766 if (err)
3767 return win32_error_object(err, path->object);
Brian Curtind40e6f72010-07-08 21:39:08 +00003768
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02003769 target_path = PyMem_New(wchar_t, buf_size+1);
Brian Curtind40e6f72010-07-08 21:39:08 +00003770 if(!target_path)
3771 return PyErr_NoMemory();
3772
Miss Islington (bot)01dd52f2018-02-22 11:02:12 -08003773 Py_BEGIN_ALLOW_THREADS
Steve Dower2ea51c92015-03-20 21:49:12 -07003774 result_length = GetFinalPathNameByHandleW(hFile, target_path,
3775 buf_size, VOLUME_NAME_DOS);
Miss Islington (bot)01dd52f2018-02-22 11:02:12 -08003776 if (!result_length) {
3777 err = "GetFinalPathNameByHandle";
3778 goto done2;
3779 }
Brian Curtind40e6f72010-07-08 21:39:08 +00003780
Miss Islington (bot)01dd52f2018-02-22 11:02:12 -08003781 if (!CloseHandle(hFile)) {
3782 err = "CloseHandle";
3783 goto done2;
3784 }
3785done2:
3786 Py_END_ALLOW_THREADS
3787 if (err) {
3788 PyMem_Free(target_path);
3789 return win32_error_object(err, path->object);
3790 }
Brian Curtind40e6f72010-07-08 21:39:08 +00003791
3792 target_path[result_length] = 0;
Victor Stinner9d3b93b2011-11-22 02:27:30 +01003793 result = PyUnicode_FromWideChar(target_path, result_length);
Victor Stinnerb6404912013-07-07 16:21:41 +02003794 PyMem_Free(target_path);
Miss Islington (bot)01dd52f2018-02-22 11:02:12 -08003795 if (path->narrow)
3796 Py_SETREF(result, PyUnicode_EncodeFSDefault(result));
Brian Curtind40e6f72010-07-08 21:39:08 +00003797 return result;
Miss Islington (bot)01dd52f2018-02-22 11:02:12 -08003798
Larry Hastings2f936352014-08-05 14:04:04 +10003799}
Brian Curtin62857742010-09-06 17:07:27 +00003800
Serhiy Storchakaf0b50152015-05-13 00:52:39 +03003801/*[clinic input]
3802os._isdir
3803
3804 path: path_t
3805 /
3806
Serhiy Storchaka579f0382016-11-08 20:21:22 +02003807Return true if the pathname refers to an existing directory.
Serhiy Storchakaf0b50152015-05-13 00:52:39 +03003808[clinic start generated code]*/
3809
Brian Curtin9c669cc2011-06-08 18:17:18 -05003810static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003811os__isdir_impl(PyObject *module, path_t *path)
Serhiy Storchaka579f0382016-11-08 20:21:22 +02003812/*[clinic end generated code: output=75f56f32720836cb input=5e0800149c0ad95f]*/
Brian Curtin9c669cc2011-06-08 18:17:18 -05003813{
Brian Curtin9c669cc2011-06-08 18:17:18 -05003814 DWORD attributes;
3815
Steve Dowerb22a6772016-07-17 20:49:38 -07003816 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07003817 attributes = GetFileAttributesW(path->wide);
Steve Dowerb22a6772016-07-17 20:49:38 -07003818 Py_END_ALLOW_THREADS
Brian Curtin9c669cc2011-06-08 18:17:18 -05003819
Brian Curtin9c669cc2011-06-08 18:17:18 -05003820 if (attributes == INVALID_FILE_ATTRIBUTES)
3821 Py_RETURN_FALSE;
3822
Brian Curtin9c669cc2011-06-08 18:17:18 -05003823 if (attributes & FILE_ATTRIBUTE_DIRECTORY)
3824 Py_RETURN_TRUE;
3825 else
3826 Py_RETURN_FALSE;
3827}
Tim Golden6b528062013-08-01 12:44:00 +01003828
Tim Golden6b528062013-08-01 12:44:00 +01003829
Larry Hastings2f936352014-08-05 14:04:04 +10003830/*[clinic input]
3831os._getvolumepathname
3832
Miss Islington (bot)01dd52f2018-02-22 11:02:12 -08003833 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +10003834
3835A helper function for ismount on Win32.
3836[clinic start generated code]*/
3837
Larry Hastings2f936352014-08-05 14:04:04 +10003838static PyObject *
Miss Islington (bot)01dd52f2018-02-22 11:02:12 -08003839os__getvolumepathname_impl(PyObject *module, path_t *path)
3840/*[clinic end generated code: output=804c63fd13a1330b input=722b40565fa21552]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003841{
3842 PyObject *result;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03003843 wchar_t *mountpath=NULL;
Victor Stinner6edddfa2013-11-24 19:22:57 +01003844 size_t buflen;
Tim Golden6b528062013-08-01 12:44:00 +01003845 BOOL ret;
3846
Tim Golden6b528062013-08-01 12:44:00 +01003847 /* Volume path should be shorter than entire path */
Miss Islington (bot)01dd52f2018-02-22 11:02:12 -08003848 buflen = Py_MAX(path->length, MAX_PATH);
Victor Stinner6edddfa2013-11-24 19:22:57 +01003849
Victor Stinner850a18e2017-10-24 16:53:32 -07003850 if (buflen > PY_DWORD_MAX) {
Victor Stinner6edddfa2013-11-24 19:22:57 +01003851 PyErr_SetString(PyExc_OverflowError, "path too long");
3852 return NULL;
3853 }
3854
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02003855 mountpath = PyMem_New(wchar_t, buflen);
Tim Golden6b528062013-08-01 12:44:00 +01003856 if (mountpath == NULL)
3857 return PyErr_NoMemory();
3858
3859 Py_BEGIN_ALLOW_THREADS
Miss Islington (bot)01dd52f2018-02-22 11:02:12 -08003860 ret = GetVolumePathNameW(path->wide, mountpath,
Victor Stinner6edddfa2013-11-24 19:22:57 +01003861 Py_SAFE_DOWNCAST(buflen, size_t, DWORD));
Tim Golden6b528062013-08-01 12:44:00 +01003862 Py_END_ALLOW_THREADS
3863
3864 if (!ret) {
Miss Islington (bot)01dd52f2018-02-22 11:02:12 -08003865 result = win32_error_object("_getvolumepathname", path->object);
Tim Golden6b528062013-08-01 12:44:00 +01003866 goto exit;
3867 }
3868 result = PyUnicode_FromWideChar(mountpath, wcslen(mountpath));
Miss Islington (bot)01dd52f2018-02-22 11:02:12 -08003869 if (path->narrow)
3870 Py_SETREF(result, PyUnicode_EncodeFSDefault(result));
Tim Golden6b528062013-08-01 12:44:00 +01003871
3872exit:
3873 PyMem_Free(mountpath);
3874 return result;
3875}
Tim Golden6b528062013-08-01 12:44:00 +01003876
Martin v. Löwis6238d2b2002-06-30 15:26:10 +00003877#endif /* MS_WINDOWS */
Mark Hammondef8b6542001-05-13 08:04:26 +00003878
Larry Hastings2f936352014-08-05 14:04:04 +10003879
3880/*[clinic input]
3881os.mkdir
3882
3883 path : path_t
3884
3885 mode: int = 0o777
3886
3887 *
3888
3889 dir_fd : dir_fd(requires='mkdirat') = None
3890
3891# "mkdir(path, mode=0o777, *, dir_fd=None)\n\n\
3892
3893Create a directory.
3894
3895If dir_fd is not None, it should be a file descriptor open to a directory,
3896 and path should be relative; path will then be relative to that directory.
3897dir_fd may not be implemented on your platform.
3898 If it is unavailable, using it will raise a NotImplementedError.
3899
3900The mode argument is ignored on Windows.
3901[clinic start generated code]*/
3902
Larry Hastings2f936352014-08-05 14:04:04 +10003903static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003904os_mkdir_impl(PyObject *module, path_t *path, int mode, int dir_fd)
3905/*[clinic end generated code: output=a70446903abe821f input=e965f68377e9b1ce]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003906{
3907 int result;
Mark Hammondc2e85bd2002-10-03 05:10:39 +00003908
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00003909#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00003910 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07003911 result = CreateDirectoryW(path->wide, NULL);
Victor Stinner8c62be82010-05-06 00:08:46 +00003912 Py_END_ALLOW_THREADS
Mark Hammondc2e85bd2002-10-03 05:10:39 +00003913
Larry Hastings2f936352014-08-05 14:04:04 +10003914 if (!result)
3915 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003916#else
Victor Stinner8c62be82010-05-06 00:08:46 +00003917 Py_BEGIN_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07003918#if HAVE_MKDIRAT
3919 if (dir_fd != DEFAULT_DIR_FD)
Larry Hastings2f936352014-08-05 14:04:04 +10003920 result = mkdirat(dir_fd, path->narrow, mode);
Larry Hastings9cf065c2012-06-22 16:30:09 -07003921 else
3922#endif
Erik Bray03eb11f2017-10-27 14:27:06 +02003923#if defined(__WATCOMC__) && !defined(__QNX__)
Larry Hastings2f936352014-08-05 14:04:04 +10003924 result = mkdir(path->narrow);
Guido van Rossuma4916fa1996-05-23 22:58:55 +00003925#else
Larry Hastings2f936352014-08-05 14:04:04 +10003926 result = mkdir(path->narrow, mode);
Guido van Rossuma4916fa1996-05-23 22:58:55 +00003927#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00003928 Py_END_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10003929 if (result < 0)
3930 return path_error(path);
Steve Dowercc16be82016-09-08 10:35:16 -07003931#endif /* MS_WINDOWS */
Larry Hastings2f936352014-08-05 14:04:04 +10003932 Py_RETURN_NONE;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00003933}
3934
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00003935
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003936/* sys/resource.h is needed for at least: wait3(), wait4(), broken nice. */
3937#if defined(HAVE_SYS_RESOURCE_H)
Thomas Wouterse38b2f12001-07-11 22:35:31 +00003938#include <sys/resource.h>
3939#endif
Thomas Wouterse38b2f12001-07-11 22:35:31 +00003940
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003941
3942#ifdef HAVE_NICE
Larry Hastings2f936352014-08-05 14:04:04 +10003943/*[clinic input]
3944os.nice
3945
3946 increment: int
3947 /
3948
3949Add increment to the priority of process and return the new priority.
3950[clinic start generated code]*/
3951
Larry Hastings2f936352014-08-05 14:04:04 +10003952static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003953os_nice_impl(PyObject *module, int increment)
3954/*[clinic end generated code: output=9dad8a9da8109943 input=864be2d402a21da2]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003955{
3956 int value;
Thomas Woutersc2c12dc2001-07-11 14:45:34 +00003957
Victor Stinner8c62be82010-05-06 00:08:46 +00003958 /* There are two flavours of 'nice': one that returns the new
3959 priority (as required by almost all standards out there) and the
Benjamin Peterson288d1da2017-09-28 22:44:27 -07003960 Linux/FreeBSD one, which returns '0' on success and advices
Victor Stinner8c62be82010-05-06 00:08:46 +00003961 the use of getpriority() to get the new priority.
Tim Peters5aa91602002-01-30 05:46:57 +00003962
Victor Stinner8c62be82010-05-06 00:08:46 +00003963 If we are of the nice family that returns the new priority, we
3964 need to clear errno before the call, and check if errno is filled
3965 before calling posix_error() on a returnvalue of -1, because the
3966 -1 may be the actual new priority! */
Thomas Woutersc2c12dc2001-07-11 14:45:34 +00003967
Victor Stinner8c62be82010-05-06 00:08:46 +00003968 errno = 0;
3969 value = nice(increment);
Thomas Wouterse38b2f12001-07-11 22:35:31 +00003970#if defined(HAVE_BROKEN_NICE) && defined(HAVE_GETPRIORITY)
Victor Stinner8c62be82010-05-06 00:08:46 +00003971 if (value == 0)
3972 value = getpriority(PRIO_PROCESS, 0);
Thomas Woutersc2c12dc2001-07-11 14:45:34 +00003973#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00003974 if (value == -1 && errno != 0)
3975 /* either nice() or getpriority() returned an error */
3976 return posix_error();
3977 return PyLong_FromLong((long) value);
Guido van Rossum775f4da1993-01-09 17:18:52 +00003978}
Guido van Rossumb6775db1994-08-01 11:34:53 +00003979#endif /* HAVE_NICE */
Guido van Rossum1ff6cb41991-04-08 20:59:13 +00003980
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00003981
3982#ifdef HAVE_GETPRIORITY
Larry Hastings2f936352014-08-05 14:04:04 +10003983/*[clinic input]
3984os.getpriority
3985
3986 which: int
3987 who: int
3988
3989Return program scheduling priority.
3990[clinic start generated code]*/
3991
Larry Hastings2f936352014-08-05 14:04:04 +10003992static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03003993os_getpriority_impl(PyObject *module, int which, int who)
3994/*[clinic end generated code: output=c41b7b63c7420228 input=9be615d40e2544ef]*/
Larry Hastings2f936352014-08-05 14:04:04 +10003995{
3996 int retval;
3997
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00003998 errno = 0;
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00003999 retval = getpriority(which, who);
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00004000 if (errno != 0)
4001 return posix_error();
4002 return PyLong_FromLong((long)retval);
4003}
4004#endif /* HAVE_GETPRIORITY */
4005
4006
4007#ifdef HAVE_SETPRIORITY
Larry Hastings2f936352014-08-05 14:04:04 +10004008/*[clinic input]
4009os.setpriority
4010
4011 which: int
4012 who: int
4013 priority: int
4014
4015Set program scheduling priority.
4016[clinic start generated code]*/
4017
Larry Hastings2f936352014-08-05 14:04:04 +10004018static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004019os_setpriority_impl(PyObject *module, int which, int who, int priority)
4020/*[clinic end generated code: output=3d910d95a7771eb2 input=710ccbf65b9dc513]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004021{
4022 int retval;
4023
4024 retval = setpriority(which, who, priority);
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +00004025 if (retval == -1)
4026 return posix_error();
4027 Py_RETURN_NONE;
4028}
4029#endif /* HAVE_SETPRIORITY */
4030
4031
Barry Warsaw53699e91996-12-10 23:23:01 +00004032static PyObject *
Larry Hastings2f936352014-08-05 14:04:04 +10004033internal_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 +00004034{
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03004035 const char *function_name = is_replace ? "replace" : "rename";
Larry Hastings9cf065c2012-06-22 16:30:09 -07004036 int dir_fd_specified;
Larry Hastings9cf065c2012-06-22 16:30:09 -07004037
Mark Hammondc2e85bd2002-10-03 05:10:39 +00004038#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00004039 BOOL result;
Antoine Pitrouf3b2d882012-01-30 22:08:52 +01004040 int flags = is_replace ? MOVEFILE_REPLACE_EXISTING : 0;
Mark Hammondc2e85bd2002-10-03 05:10:39 +00004041#else
Larry Hastings9cf065c2012-06-22 16:30:09 -07004042 int result;
Mark Hammondc2e85bd2002-10-03 05:10:39 +00004043#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07004044
Larry Hastings9cf065c2012-06-22 16:30:09 -07004045 dir_fd_specified = (src_dir_fd != DEFAULT_DIR_FD) ||
4046 (dst_dir_fd != DEFAULT_DIR_FD);
4047#ifndef HAVE_RENAMEAT
4048 if (dir_fd_specified) {
4049 argument_unavailable_error(function_name, "src_dir_fd and dst_dir_fd");
Larry Hastings2f936352014-08-05 14:04:04 +10004050 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07004051 }
4052#endif
4053
Larry Hastings9cf065c2012-06-22 16:30:09 -07004054#ifdef MS_WINDOWS
4055 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07004056 result = MoveFileExW(src->wide, dst->wide, flags);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004057 Py_END_ALLOW_THREADS
4058
Larry Hastings2f936352014-08-05 14:04:04 +10004059 if (!result)
4060 return path_error2(src, dst);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004061
4062#else
Steve Dowercc16be82016-09-08 10:35:16 -07004063 if ((src->narrow && dst->wide) || (src->wide && dst->narrow)) {
4064 PyErr_Format(PyExc_ValueError,
4065 "%s: src and dst must be the same type", function_name);
4066 return NULL;
4067 }
4068
Larry Hastings9cf065c2012-06-22 16:30:09 -07004069 Py_BEGIN_ALLOW_THREADS
4070#ifdef HAVE_RENAMEAT
4071 if (dir_fd_specified)
Larry Hastings2f936352014-08-05 14:04:04 +10004072 result = renameat(src_dir_fd, src->narrow, dst_dir_fd, dst->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004073 else
4074#endif
Steve Dowercc16be82016-09-08 10:35:16 -07004075 result = rename(src->narrow, dst->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004076 Py_END_ALLOW_THREADS
4077
Larry Hastings2f936352014-08-05 14:04:04 +10004078 if (result)
4079 return path_error2(src, dst);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004080#endif
Larry Hastings2f936352014-08-05 14:04:04 +10004081 Py_RETURN_NONE;
4082}
Larry Hastings9cf065c2012-06-22 16:30:09 -07004083
Larry Hastings2f936352014-08-05 14:04:04 +10004084
4085/*[clinic input]
4086os.rename
4087
4088 src : path_t
4089 dst : path_t
4090 *
4091 src_dir_fd : dir_fd = None
4092 dst_dir_fd : dir_fd = None
4093
4094Rename a file or directory.
4095
4096If either src_dir_fd or dst_dir_fd is not None, it should be a file
4097 descriptor open to a directory, and the respective path string (src or dst)
4098 should be relative; the path will then be relative to that directory.
4099src_dir_fd and dst_dir_fd, may not be implemented on your platform.
4100 If they are unavailable, using them will raise a NotImplementedError.
4101[clinic start generated code]*/
4102
Antoine Pitrouf3b2d882012-01-30 22:08:52 +01004103static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004104os_rename_impl(PyObject *module, path_t *src, path_t *dst, int src_dir_fd,
Larry Hastings89964c42015-04-14 18:07:59 -04004105 int dst_dir_fd)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004106/*[clinic end generated code: output=59e803072cf41230 input=faa61c847912c850]*/
Antoine Pitrouf3b2d882012-01-30 22:08:52 +01004107{
Larry Hastings2f936352014-08-05 14:04:04 +10004108 return internal_rename(src, dst, src_dir_fd, dst_dir_fd, 0);
Antoine Pitrouf3b2d882012-01-30 22:08:52 +01004109}
4110
Larry Hastings2f936352014-08-05 14:04:04 +10004111
4112/*[clinic input]
4113os.replace = os.rename
4114
4115Rename a file or directory, overwriting the destination.
4116
4117If either src_dir_fd or dst_dir_fd is not None, it should be a file
4118 descriptor open to a directory, and the respective path string (src or dst)
4119 should be relative; the path will then be relative to that directory.
4120src_dir_fd and dst_dir_fd, may not be implemented on your platform.
4121 If they are unavailable, using them will raise a NotImplementedError."
4122[clinic start generated code]*/
4123
Larry Hastings2f936352014-08-05 14:04:04 +10004124static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004125os_replace_impl(PyObject *module, path_t *src, path_t *dst, int src_dir_fd,
4126 int dst_dir_fd)
4127/*[clinic end generated code: output=1968c02e7857422b input=25515dfb107c8421]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004128{
4129 return internal_rename(src, dst, src_dir_fd, dst_dir_fd, 1);
4130}
4131
4132
4133/*[clinic input]
4134os.rmdir
4135
4136 path: path_t
4137 *
4138 dir_fd: dir_fd(requires='unlinkat') = None
4139
4140Remove a directory.
4141
4142If dir_fd is not None, it should be a file descriptor open to a directory,
4143 and path should be relative; path will then be relative to that directory.
4144dir_fd may not be implemented on your platform.
4145 If it is unavailable, using it will raise a NotImplementedError.
4146[clinic start generated code]*/
4147
Larry Hastings2f936352014-08-05 14:04:04 +10004148static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004149os_rmdir_impl(PyObject *module, path_t *path, int dir_fd)
4150/*[clinic end generated code: output=080eb54f506e8301 input=38c8b375ca34a7e2]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004151{
4152 int result;
Larry Hastingsb698d8e2012-06-23 16:55:07 -07004153
4154 Py_BEGIN_ALLOW_THREADS
4155#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07004156 /* Windows, success=1, UNIX, success=0 */
4157 result = !RemoveDirectoryW(path->wide);
Larry Hastingsb698d8e2012-06-23 16:55:07 -07004158#else
4159#ifdef HAVE_UNLINKAT
4160 if (dir_fd != DEFAULT_DIR_FD)
Larry Hastings2f936352014-08-05 14:04:04 +10004161 result = unlinkat(dir_fd, path->narrow, AT_REMOVEDIR);
Larry Hastingsb698d8e2012-06-23 16:55:07 -07004162 else
4163#endif
Larry Hastings2f936352014-08-05 14:04:04 +10004164 result = rmdir(path->narrow);
Larry Hastingsb698d8e2012-06-23 16:55:07 -07004165#endif
4166 Py_END_ALLOW_THREADS
4167
Larry Hastings2f936352014-08-05 14:04:04 +10004168 if (result)
4169 return path_error(path);
Larry Hastingsb698d8e2012-06-23 16:55:07 -07004170
Larry Hastings2f936352014-08-05 14:04:04 +10004171 Py_RETURN_NONE;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004172}
4173
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004174
Guido van Rossuma4916fa1996-05-23 22:58:55 +00004175#ifdef HAVE_SYSTEM
Larry Hastings2f936352014-08-05 14:04:04 +10004176#ifdef MS_WINDOWS
4177/*[clinic input]
4178os.system -> long
4179
4180 command: Py_UNICODE
4181
4182Execute the command in a subshell.
4183[clinic start generated code]*/
4184
Larry Hastings2f936352014-08-05 14:04:04 +10004185static long
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004186os_system_impl(PyObject *module, Py_UNICODE *command)
4187/*[clinic end generated code: output=96c4dffee36dfb48 input=303f5ce97df606b0]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004188{
4189 long result;
Victor Stinner8c62be82010-05-06 00:08:46 +00004190 Py_BEGIN_ALLOW_THREADS
Steve Dowerc3630612016-11-19 18:41:16 -08004191 _Py_BEGIN_SUPPRESS_IPH
Larry Hastings2f936352014-08-05 14:04:04 +10004192 result = _wsystem(command);
Steve Dowerc3630612016-11-19 18:41:16 -08004193 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00004194 Py_END_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10004195 return result;
4196}
4197#else /* MS_WINDOWS */
4198/*[clinic input]
4199os.system -> long
4200
4201 command: FSConverter
4202
4203Execute the command in a subshell.
4204[clinic start generated code]*/
4205
Larry Hastings2f936352014-08-05 14:04:04 +10004206static long
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004207os_system_impl(PyObject *module, PyObject *command)
4208/*[clinic end generated code: output=290fc437dd4f33a0 input=86a58554ba6094af]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004209{
4210 long result;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03004211 const char *bytes = PyBytes_AsString(command);
Larry Hastings2f936352014-08-05 14:04:04 +10004212 Py_BEGIN_ALLOW_THREADS
4213 result = system(bytes);
4214 Py_END_ALLOW_THREADS
4215 return result;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004216}
Guido van Rossuma4916fa1996-05-23 22:58:55 +00004217#endif
Larry Hastings2f936352014-08-05 14:04:04 +10004218#endif /* HAVE_SYSTEM */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004219
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004220
Larry Hastings2f936352014-08-05 14:04:04 +10004221/*[clinic input]
4222os.umask
4223
4224 mask: int
4225 /
4226
4227Set the current numeric umask and return the previous umask.
4228[clinic start generated code]*/
4229
Larry Hastings2f936352014-08-05 14:04:04 +10004230static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004231os_umask_impl(PyObject *module, int mask)
4232/*[clinic end generated code: output=a2e33ce3bc1a6e33 input=ab6bfd9b24d8a7e8]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004233{
4234 int i = (int)umask(mask);
Victor Stinner8c62be82010-05-06 00:08:46 +00004235 if (i < 0)
4236 return posix_error();
4237 return PyLong_FromLong((long)i);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004238}
4239
Brian Curtind40e6f72010-07-08 21:39:08 +00004240#ifdef MS_WINDOWS
4241
4242/* override the default DeleteFileW behavior so that directory
4243symlinks can be removed with this function, the same as with
4244Unix symlinks */
4245BOOL WINAPI Py_DeleteFileW(LPCWSTR lpFileName)
4246{
4247 WIN32_FILE_ATTRIBUTE_DATA info;
4248 WIN32_FIND_DATAW find_data;
4249 HANDLE find_data_handle;
4250 int is_directory = 0;
4251 int is_link = 0;
4252
4253 if (GetFileAttributesExW(lpFileName, GetFileExInfoStandard, &info)) {
4254 is_directory = info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00004255
Brian Curtind40e6f72010-07-08 21:39:08 +00004256 /* Get WIN32_FIND_DATA structure for the path to determine if
4257 it is a symlink */
4258 if(is_directory &&
4259 info.dwFileAttributes & FILE_ATTRIBUTE_REPARSE_POINT) {
4260 find_data_handle = FindFirstFileW(lpFileName, &find_data);
4261
4262 if(find_data_handle != INVALID_HANDLE_VALUE) {
Tim Golden0321cf22014-05-05 19:46:17 +01004263 /* IO_REPARSE_TAG_SYMLINK if it is a symlink and
4264 IO_REPARSE_TAG_MOUNT_POINT if it is a junction point. */
4265 is_link = find_data.dwReserved0 == IO_REPARSE_TAG_SYMLINK ||
4266 find_data.dwReserved0 == IO_REPARSE_TAG_MOUNT_POINT;
Brian Curtind40e6f72010-07-08 21:39:08 +00004267 FindClose(find_data_handle);
4268 }
4269 }
4270 }
4271
4272 if (is_directory && is_link)
4273 return RemoveDirectoryW(lpFileName);
4274
4275 return DeleteFileW(lpFileName);
4276}
4277#endif /* MS_WINDOWS */
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004278
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004279
Larry Hastings2f936352014-08-05 14:04:04 +10004280/*[clinic input]
4281os.unlink
4282
4283 path: path_t
4284 *
4285 dir_fd: dir_fd(requires='unlinkat')=None
4286
4287Remove a file (same as remove()).
4288
4289If dir_fd is not None, it should be a file descriptor open to a directory,
4290 and path should be relative; path will then be relative to that directory.
4291dir_fd may not be implemented on your platform.
4292 If it is unavailable, using it will raise a NotImplementedError.
4293
4294[clinic start generated code]*/
4295
Larry Hastings2f936352014-08-05 14:04:04 +10004296static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004297os_unlink_impl(PyObject *module, path_t *path, int dir_fd)
4298/*[clinic end generated code: output=621797807b9963b1 input=d7bcde2b1b2a2552]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004299{
4300 int result;
Larry Hastings9cf065c2012-06-22 16:30:09 -07004301
4302 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04004303 _Py_BEGIN_SUPPRESS_IPH
Larry Hastings9cf065c2012-06-22 16:30:09 -07004304#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07004305 /* Windows, success=1, UNIX, success=0 */
4306 result = !Py_DeleteFileW(path->wide);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004307#else
Larry Hastings9cf065c2012-06-22 16:30:09 -07004308#ifdef HAVE_UNLINKAT
4309 if (dir_fd != DEFAULT_DIR_FD)
Larry Hastings2f936352014-08-05 14:04:04 +10004310 result = unlinkat(dir_fd, path->narrow, 0);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004311 else
4312#endif /* HAVE_UNLINKAT */
Larry Hastings2f936352014-08-05 14:04:04 +10004313 result = unlink(path->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004314#endif
Steve Dower8fc89802015-04-12 00:26:27 -04004315 _Py_END_SUPPRESS_IPH
Larry Hastings9cf065c2012-06-22 16:30:09 -07004316 Py_END_ALLOW_THREADS
4317
Larry Hastings2f936352014-08-05 14:04:04 +10004318 if (result)
4319 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004320
Larry Hastings2f936352014-08-05 14:04:04 +10004321 Py_RETURN_NONE;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004322}
4323
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004324
Larry Hastings2f936352014-08-05 14:04:04 +10004325/*[clinic input]
4326os.remove = os.unlink
4327
4328Remove a file (same as unlink()).
4329
4330If dir_fd is not None, it should be a file descriptor open to a directory,
4331 and path should be relative; path will then be relative to that directory.
4332dir_fd may not be implemented on your platform.
4333 If it is unavailable, using it will raise a NotImplementedError.
4334[clinic start generated code]*/
4335
Larry Hastings2f936352014-08-05 14:04:04 +10004336static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004337os_remove_impl(PyObject *module, path_t *path, int dir_fd)
4338/*[clinic end generated code: output=a8535b28f0068883 input=e05c5ab55cd30983]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004339{
4340 return os_unlink_impl(module, path, dir_fd);
4341}
4342
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004343
Larry Hastings605a62d2012-06-24 04:33:36 -07004344static PyStructSequence_Field uname_result_fields[] = {
4345 {"sysname", "operating system name"},
4346 {"nodename", "name of machine on network (implementation-defined)"},
4347 {"release", "operating system release"},
4348 {"version", "operating system version"},
4349 {"machine", "hardware identifier"},
4350 {NULL}
4351};
4352
4353PyDoc_STRVAR(uname_result__doc__,
4354"uname_result: Result from os.uname().\n\n\
4355This object may be accessed either as a tuple of\n\
4356 (sysname, nodename, release, version, machine),\n\
4357or via the attributes sysname, nodename, release, version, and machine.\n\
4358\n\
4359See os.uname for more information.");
4360
4361static PyStructSequence_Desc uname_result_desc = {
4362 "uname_result", /* name */
4363 uname_result__doc__, /* doc */
4364 uname_result_fields,
4365 5
4366};
4367
4368static PyTypeObject UnameResultType;
4369
4370
4371#ifdef HAVE_UNAME
Larry Hastings2f936352014-08-05 14:04:04 +10004372/*[clinic input]
4373os.uname
4374
4375Return an object identifying the current operating system.
4376
4377The object behaves like a named tuple with the following fields:
4378 (sysname, nodename, release, version, machine)
4379
4380[clinic start generated code]*/
4381
Larry Hastings2f936352014-08-05 14:04:04 +10004382static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004383os_uname_impl(PyObject *module)
4384/*[clinic end generated code: output=e6a49cf1a1508a19 input=e68bd246db3043ed]*/
Guido van Rossumc39de5f1992-02-05 11:15:54 +00004385{
Victor Stinner8c62be82010-05-06 00:08:46 +00004386 struct utsname u;
4387 int res;
Larry Hastings605a62d2012-06-24 04:33:36 -07004388 PyObject *value;
Neal Norwitze241ce82003-02-17 18:17:05 +00004389
Victor Stinner8c62be82010-05-06 00:08:46 +00004390 Py_BEGIN_ALLOW_THREADS
4391 res = uname(&u);
4392 Py_END_ALLOW_THREADS
4393 if (res < 0)
4394 return posix_error();
Larry Hastings605a62d2012-06-24 04:33:36 -07004395
4396 value = PyStructSequence_New(&UnameResultType);
4397 if (value == NULL)
4398 return NULL;
4399
4400#define SET(i, field) \
4401 { \
Victor Stinnera534fc42013-06-03 22:07:27 +02004402 PyObject *o = PyUnicode_DecodeFSDefault(field); \
Larry Hastings605a62d2012-06-24 04:33:36 -07004403 if (!o) { \
4404 Py_DECREF(value); \
4405 return NULL; \
4406 } \
4407 PyStructSequence_SET_ITEM(value, i, o); \
4408 } \
4409
4410 SET(0, u.sysname);
4411 SET(1, u.nodename);
4412 SET(2, u.release);
4413 SET(3, u.version);
4414 SET(4, u.machine);
4415
4416#undef SET
4417
4418 return value;
Guido van Rossumc39de5f1992-02-05 11:15:54 +00004419}
Guido van Rossumb6775db1994-08-01 11:34:53 +00004420#endif /* HAVE_UNAME */
Guido van Rossum1ff6cb41991-04-08 20:59:13 +00004421
Larry Hastings9e3e70b2011-09-08 19:29:07 -07004422
Larry Hastings9cf065c2012-06-22 16:30:09 -07004423
4424typedef struct {
4425 int now;
4426 time_t atime_s;
4427 long atime_ns;
4428 time_t mtime_s;
4429 long mtime_ns;
4430} utime_t;
4431
4432/*
Victor Stinner484df002014-10-09 13:52:31 +02004433 * these macros assume that "ut" is a pointer to a utime_t
Larry Hastings9cf065c2012-06-22 16:30:09 -07004434 * they also intentionally leak the declaration of a pointer named "time"
4435 */
4436#define UTIME_TO_TIMESPEC \
4437 struct timespec ts[2]; \
4438 struct timespec *time; \
Victor Stinner484df002014-10-09 13:52:31 +02004439 if (ut->now) \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004440 time = NULL; \
4441 else { \
Victor Stinner484df002014-10-09 13:52:31 +02004442 ts[0].tv_sec = ut->atime_s; \
4443 ts[0].tv_nsec = ut->atime_ns; \
4444 ts[1].tv_sec = ut->mtime_s; \
4445 ts[1].tv_nsec = ut->mtime_ns; \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004446 time = ts; \
4447 } \
4448
4449#define UTIME_TO_TIMEVAL \
4450 struct timeval tv[2]; \
4451 struct timeval *time; \
Victor Stinner484df002014-10-09 13:52:31 +02004452 if (ut->now) \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004453 time = NULL; \
4454 else { \
Victor Stinner484df002014-10-09 13:52:31 +02004455 tv[0].tv_sec = ut->atime_s; \
4456 tv[0].tv_usec = ut->atime_ns / 1000; \
4457 tv[1].tv_sec = ut->mtime_s; \
4458 tv[1].tv_usec = ut->mtime_ns / 1000; \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004459 time = tv; \
4460 } \
4461
4462#define UTIME_TO_UTIMBUF \
Georg Brandle1a7d9d2014-10-12 08:45:15 +02004463 struct utimbuf u; \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004464 struct utimbuf *time; \
Victor Stinner484df002014-10-09 13:52:31 +02004465 if (ut->now) \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004466 time = NULL; \
4467 else { \
Georg Brandle1a7d9d2014-10-12 08:45:15 +02004468 u.actime = ut->atime_s; \
4469 u.modtime = ut->mtime_s; \
4470 time = &u; \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004471 }
4472
4473#define UTIME_TO_TIME_T \
4474 time_t timet[2]; \
Georg Brandle1a7d9d2014-10-12 08:45:15 +02004475 time_t *time; \
Victor Stinner484df002014-10-09 13:52:31 +02004476 if (ut->now) \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004477 time = NULL; \
4478 else { \
Victor Stinner484df002014-10-09 13:52:31 +02004479 timet[0] = ut->atime_s; \
4480 timet[1] = ut->mtime_s; \
Georg Brandle1a7d9d2014-10-12 08:45:15 +02004481 time = timet; \
Larry Hastings9cf065c2012-06-22 16:30:09 -07004482 } \
4483
4484
Victor Stinner528a9ab2015-09-03 21:30:26 +02004485#if defined(HAVE_FUTIMESAT) || defined(HAVE_UTIMENSAT)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004486
4487static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02004488utime_dir_fd(utime_t *ut, int dir_fd, const char *path, int follow_symlinks)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004489{
4490#ifdef HAVE_UTIMENSAT
4491 int flags = follow_symlinks ? 0 : AT_SYMLINK_NOFOLLOW;
4492 UTIME_TO_TIMESPEC;
4493 return utimensat(dir_fd, path, time, flags);
4494#elif defined(HAVE_FUTIMESAT)
4495 UTIME_TO_TIMEVAL;
4496 /*
4497 * follow_symlinks will never be false here;
4498 * we only allow !follow_symlinks and dir_fd together
4499 * if we have utimensat()
4500 */
4501 assert(follow_symlinks);
4502 return futimesat(dir_fd, path, time);
4503#endif
4504}
4505
Larry Hastings2f936352014-08-05 14:04:04 +10004506 #define FUTIMENSAT_DIR_FD_CONVERTER dir_fd_converter
4507#else
4508 #define FUTIMENSAT_DIR_FD_CONVERTER dir_fd_unavailable
Larry Hastings9cf065c2012-06-22 16:30:09 -07004509#endif
4510
Victor Stinner528a9ab2015-09-03 21:30:26 +02004511#if defined(HAVE_FUTIMES) || defined(HAVE_FUTIMENS)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004512
4513static int
Victor Stinner484df002014-10-09 13:52:31 +02004514utime_fd(utime_t *ut, int fd)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004515{
4516#ifdef HAVE_FUTIMENS
4517 UTIME_TO_TIMESPEC;
4518 return futimens(fd, time);
4519#else
4520 UTIME_TO_TIMEVAL;
4521 return futimes(fd, time);
4522#endif
4523}
4524
Larry Hastings2f936352014-08-05 14:04:04 +10004525 #define PATH_UTIME_HAVE_FD 1
4526#else
4527 #define PATH_UTIME_HAVE_FD 0
Larry Hastings9cf065c2012-06-22 16:30:09 -07004528#endif
4529
Victor Stinner5ebae872015-09-22 01:29:33 +02004530#if defined(HAVE_UTIMENSAT) || defined(HAVE_LUTIMES)
4531# define UTIME_HAVE_NOFOLLOW_SYMLINKS
4532#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07004533
Victor Stinner4552ced2015-09-21 22:37:15 +02004534#ifdef UTIME_HAVE_NOFOLLOW_SYMLINKS
Larry Hastings9cf065c2012-06-22 16:30:09 -07004535
4536static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02004537utime_nofollow_symlinks(utime_t *ut, const char *path)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004538{
4539#ifdef HAVE_UTIMENSAT
4540 UTIME_TO_TIMESPEC;
4541 return utimensat(DEFAULT_DIR_FD, path, time, AT_SYMLINK_NOFOLLOW);
4542#else
4543 UTIME_TO_TIMEVAL;
4544 return lutimes(path, time);
4545#endif
4546}
4547
4548#endif
4549
4550#ifndef MS_WINDOWS
4551
4552static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02004553utime_default(utime_t *ut, const char *path)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004554{
4555#ifdef HAVE_UTIMENSAT
4556 UTIME_TO_TIMESPEC;
4557 return utimensat(DEFAULT_DIR_FD, path, time, 0);
4558#elif defined(HAVE_UTIMES)
4559 UTIME_TO_TIMEVAL;
4560 return utimes(path, time);
4561#elif defined(HAVE_UTIME_H)
4562 UTIME_TO_UTIMBUF;
4563 return utime(path, time);
4564#else
4565 UTIME_TO_TIME_T;
4566 return utime(path, time);
4567#endif
4568}
4569
4570#endif
4571
Larry Hastings76ad59b2012-05-03 00:30:07 -07004572static int
4573split_py_long_to_s_and_ns(PyObject *py_long, time_t *s, long *ns)
4574{
4575 int result = 0;
Benjamin Petersonfbd85a02012-05-04 11:06:09 -04004576 PyObject *divmod;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004577 divmod = PyNumber_Divmod(py_long, billion);
4578 if (!divmod)
4579 goto exit;
4580 *s = _PyLong_AsTime_t(PyTuple_GET_ITEM(divmod, 0));
4581 if ((*s == -1) && PyErr_Occurred())
4582 goto exit;
4583 *ns = PyLong_AsLong(PyTuple_GET_ITEM(divmod, 1));
Benjamin Peterson35a8f0d2012-05-04 01:10:59 -04004584 if ((*ns == -1) && PyErr_Occurred())
Larry Hastings76ad59b2012-05-03 00:30:07 -07004585 goto exit;
4586
4587 result = 1;
4588exit:
4589 Py_XDECREF(divmod);
4590 return result;
4591}
4592
Larry Hastings2f936352014-08-05 14:04:04 +10004593
4594/*[clinic input]
4595os.utime
4596
4597 path: path_t(allow_fd='PATH_UTIME_HAVE_FD')
4598 times: object = NULL
4599 *
4600 ns: object = NULL
4601 dir_fd: dir_fd(requires='futimensat') = None
4602 follow_symlinks: bool=True
4603
Martin Panter0ff89092015-09-09 01:56:53 +00004604# "utime(path, times=None, *[, ns], dir_fd=None, follow_symlinks=True)\n\
Larry Hastings2f936352014-08-05 14:04:04 +10004605
4606Set the access and modified time of path.
4607
4608path may always be specified as a string.
4609On some platforms, path may also be specified as an open file descriptor.
4610 If this functionality is unavailable, using it raises an exception.
4611
4612If times is not None, it must be a tuple (atime, mtime);
4613 atime and mtime should be expressed as float seconds since the epoch.
Martin Panter0ff89092015-09-09 01:56:53 +00004614If ns is specified, it must be a tuple (atime_ns, mtime_ns);
Larry Hastings2f936352014-08-05 14:04:04 +10004615 atime_ns and mtime_ns should be expressed as integer nanoseconds
4616 since the epoch.
Martin Panter0ff89092015-09-09 01:56:53 +00004617If times is None and ns is unspecified, utime uses the current time.
Larry Hastings2f936352014-08-05 14:04:04 +10004618Specifying tuples for both times and ns is an error.
4619
4620If dir_fd is not None, it should be a file descriptor open to a directory,
4621 and path should be relative; path will then be relative to that directory.
4622If follow_symlinks is False, and the last element of the path is a symbolic
4623 link, utime will modify the symbolic link itself instead of the file the
4624 link points to.
4625It is an error to use dir_fd or follow_symlinks when specifying path
4626 as an open file descriptor.
4627dir_fd and follow_symlinks may not be available on your platform.
4628 If they are unavailable, using them will raise a NotImplementedError.
4629
4630[clinic start generated code]*/
4631
Larry Hastings2f936352014-08-05 14:04:04 +10004632static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004633os_utime_impl(PyObject *module, path_t *path, PyObject *times, PyObject *ns,
4634 int dir_fd, int follow_symlinks)
4635/*[clinic end generated code: output=cfcac69d027b82cf input=081cdc54ca685385]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004636{
Larry Hastings9cf065c2012-06-22 16:30:09 -07004637#ifdef MS_WINDOWS
4638 HANDLE hFile;
4639 FILETIME atime, mtime;
4640#else
4641 int result;
4642#endif
Larry Hastings76ad59b2012-05-03 00:30:07 -07004643
Larry Hastings9cf065c2012-06-22 16:30:09 -07004644 PyObject *return_value = NULL;
Larry Hastings2f936352014-08-05 14:04:04 +10004645 utime_t utime;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004646
Christian Heimesb3c87242013-08-01 00:08:16 +02004647 memset(&utime, 0, sizeof(utime_t));
Larry Hastings76ad59b2012-05-03 00:30:07 -07004648
Larry Hastings9cf065c2012-06-22 16:30:09 -07004649 if (times && (times != Py_None) && ns) {
4650 PyErr_SetString(PyExc_ValueError,
4651 "utime: you may specify either 'times'"
4652 " or 'ns' but not both");
4653 goto exit;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004654 }
4655
4656 if (times && (times != Py_None)) {
Antoine Pitroucf8a1e52013-04-17 22:06:44 +02004657 time_t a_sec, m_sec;
4658 long a_nsec, m_nsec;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004659 if (!PyTuple_CheckExact(times) || (PyTuple_Size(times) != 2)) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07004660 PyErr_SetString(PyExc_TypeError,
4661 "utime: 'times' must be either"
4662 " a tuple of two ints or None");
4663 goto exit;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004664 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07004665 utime.now = 0;
Benjamin Petersonb399ab22012-05-04 01:31:13 -04004666 if (_PyTime_ObjectToTimespec(PyTuple_GET_ITEM(times, 0),
Victor Stinnerdca028b2015-03-30 01:02:57 +02004667 &a_sec, &a_nsec, _PyTime_ROUND_FLOOR) == -1 ||
Benjamin Petersonb399ab22012-05-04 01:31:13 -04004668 _PyTime_ObjectToTimespec(PyTuple_GET_ITEM(times, 1),
Victor Stinnerdca028b2015-03-30 01:02:57 +02004669 &m_sec, &m_nsec, _PyTime_ROUND_FLOOR) == -1) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07004670 goto exit;
Larry Hastingsb3336402012-05-04 02:31:57 -07004671 }
Antoine Pitroucf8a1e52013-04-17 22:06:44 +02004672 utime.atime_s = a_sec;
4673 utime.atime_ns = a_nsec;
4674 utime.mtime_s = m_sec;
4675 utime.mtime_ns = m_nsec;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004676 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07004677 else if (ns) {
Larry Hastings76ad59b2012-05-03 00:30:07 -07004678 if (!PyTuple_CheckExact(ns) || (PyTuple_Size(ns) != 2)) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07004679 PyErr_SetString(PyExc_TypeError,
4680 "utime: 'ns' must be a tuple of two ints");
4681 goto exit;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004682 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07004683 utime.now = 0;
Benjamin Petersonb399ab22012-05-04 01:31:13 -04004684 if (!split_py_long_to_s_and_ns(PyTuple_GET_ITEM(ns, 0),
Larry Hastings9cf065c2012-06-22 16:30:09 -07004685 &utime.atime_s, &utime.atime_ns) ||
Benjamin Petersonb399ab22012-05-04 01:31:13 -04004686 !split_py_long_to_s_and_ns(PyTuple_GET_ITEM(ns, 1),
Larry Hastings9cf065c2012-06-22 16:30:09 -07004687 &utime.mtime_s, &utime.mtime_ns)) {
4688 goto exit;
Larry Hastingsb3336402012-05-04 02:31:57 -07004689 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07004690 }
4691 else {
4692 /* times and ns are both None/unspecified. use "now". */
4693 utime.now = 1;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004694 }
4695
Victor Stinner4552ced2015-09-21 22:37:15 +02004696#if !defined(UTIME_HAVE_NOFOLLOW_SYMLINKS)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004697 if (follow_symlinks_specified("utime", follow_symlinks))
4698 goto exit;
4699#endif
Benjamin Petersonb399ab22012-05-04 01:31:13 -04004700
Larry Hastings2f936352014-08-05 14:04:04 +10004701 if (path_and_dir_fd_invalid("utime", path, dir_fd) ||
4702 dir_fd_and_fd_invalid("utime", dir_fd, path->fd) ||
4703 fd_and_follow_symlinks_invalid("utime", path->fd, follow_symlinks))
Larry Hastings9cf065c2012-06-22 16:30:09 -07004704 goto exit;
Larry Hastings76ad59b2012-05-03 00:30:07 -07004705
Larry Hastings9cf065c2012-06-22 16:30:09 -07004706#if !defined(HAVE_UTIMENSAT)
4707 if ((dir_fd != DEFAULT_DIR_FD) && (!follow_symlinks)) {
Georg Brandl969288e2012-06-26 09:25:44 +02004708 PyErr_SetString(PyExc_ValueError,
Larry Hastings9cf065c2012-06-22 16:30:09 -07004709 "utime: cannot use dir_fd and follow_symlinks "
4710 "together on this platform");
4711 goto exit;
4712 }
4713#endif
Larry Hastings76ad59b2012-05-03 00:30:07 -07004714
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00004715#ifdef MS_WINDOWS
Larry Hastings9cf065c2012-06-22 16:30:09 -07004716 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07004717 hFile = CreateFileW(path->wide, FILE_WRITE_ATTRIBUTES, 0,
4718 NULL, OPEN_EXISTING,
4719 FILE_FLAG_BACKUP_SEMANTICS, NULL);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004720 Py_END_ALLOW_THREADS
4721 if (hFile == INVALID_HANDLE_VALUE) {
Larry Hastings2f936352014-08-05 14:04:04 +10004722 path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004723 goto exit;
Larry Hastingsb3336402012-05-04 02:31:57 -07004724 }
4725
Larry Hastings9cf065c2012-06-22 16:30:09 -07004726 if (utime.now) {
Antoine Pitrou91a7af32013-11-23 15:23:26 +01004727 GetSystemTimeAsFileTime(&mtime);
4728 atime = mtime;
Victor Stinner8c62be82010-05-06 00:08:46 +00004729 }
Victor Stinner8c62be82010-05-06 00:08:46 +00004730 else {
Steve Dowerbf1f3762015-02-21 15:26:02 -08004731 _Py_time_t_to_FILE_TIME(utime.atime_s, utime.atime_ns, &atime);
4732 _Py_time_t_to_FILE_TIME(utime.mtime_s, utime.mtime_ns, &mtime);
Victor Stinner8c62be82010-05-06 00:08:46 +00004733 }
4734 if (!SetFileTime(hFile, NULL, &atime, &mtime)) {
4735 /* Avoid putting the file name into the error here,
4736 as that may confuse the user into believing that
4737 something is wrong with the file, when it also
4738 could be the time stamp that gives a problem. */
Victor Stinnerb024e842012-10-31 22:24:06 +01004739 PyErr_SetFromWindowsErr(0);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004740 goto exit;
Victor Stinner8c62be82010-05-06 00:08:46 +00004741 }
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00004742#else /* MS_WINDOWS */
Larry Hastings9cf065c2012-06-22 16:30:09 -07004743 Py_BEGIN_ALLOW_THREADS
Guido van Rossum1ff6cb41991-04-08 20:59:13 +00004744
Victor Stinner4552ced2015-09-21 22:37:15 +02004745#ifdef UTIME_HAVE_NOFOLLOW_SYMLINKS
Larry Hastings9cf065c2012-06-22 16:30:09 -07004746 if ((!follow_symlinks) && (dir_fd == DEFAULT_DIR_FD))
Larry Hastings2f936352014-08-05 14:04:04 +10004747 result = utime_nofollow_symlinks(&utime, path->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004748 else
Larry Hastings9e3e70b2011-09-08 19:29:07 -07004749#endif
Larry Hastings9cf065c2012-06-22 16:30:09 -07004750
Victor Stinner528a9ab2015-09-03 21:30:26 +02004751#if defined(HAVE_FUTIMESAT) || defined(HAVE_UTIMENSAT)
Larry Hastings9cf065c2012-06-22 16:30:09 -07004752 if ((dir_fd != DEFAULT_DIR_FD) || (!follow_symlinks))
Larry Hastings2f936352014-08-05 14:04:04 +10004753 result = utime_dir_fd(&utime, dir_fd, path->narrow, follow_symlinks);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004754 else
4755#endif
4756
Victor Stinner528a9ab2015-09-03 21:30:26 +02004757#if defined(HAVE_FUTIMES) || defined(HAVE_FUTIMENS)
Larry Hastings2f936352014-08-05 14:04:04 +10004758 if (path->fd != -1)
4759 result = utime_fd(&utime, path->fd);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004760 else
4761#endif
4762
Larry Hastings2f936352014-08-05 14:04:04 +10004763 result = utime_default(&utime, path->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07004764
4765 Py_END_ALLOW_THREADS
4766
4767 if (result < 0) {
4768 /* see previous comment about not putting filename in error here */
4769 return_value = posix_error();
4770 goto exit;
Victor Stinner8c62be82010-05-06 00:08:46 +00004771 }
Larry Hastings76ad59b2012-05-03 00:30:07 -07004772
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +00004773#endif /* MS_WINDOWS */
Larry Hastings9cf065c2012-06-22 16:30:09 -07004774
4775 Py_INCREF(Py_None);
4776 return_value = Py_None;
4777
4778exit:
Larry Hastings9cf065c2012-06-22 16:30:09 -07004779#ifdef MS_WINDOWS
4780 if (hFile != INVALID_HANDLE_VALUE)
4781 CloseHandle(hFile);
4782#endif
4783 return return_value;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00004784}
4785
Guido van Rossum3b066191991-06-04 19:40:25 +00004786/* Process operations */
Guido van Rossum85e3b011991-06-03 12:42:10 +00004787
Larry Hastings2f936352014-08-05 14:04:04 +10004788
4789/*[clinic input]
4790os._exit
4791
4792 status: int
4793
4794Exit to the system with specified status, without normal exit processing.
4795[clinic start generated code]*/
4796
Larry Hastings2f936352014-08-05 14:04:04 +10004797static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03004798os__exit_impl(PyObject *module, int status)
4799/*[clinic end generated code: output=116e52d9c2260d54 input=5e6d57556b0c4a62]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004800{
4801 _exit(status);
Victor Stinner8c62be82010-05-06 00:08:46 +00004802 return NULL; /* Make gcc -Wall happy */
Guido van Rossum85e3b011991-06-03 12:42:10 +00004803}
4804
Steve Dowercc16be82016-09-08 10:35:16 -07004805#if defined(HAVE_WEXECV) || defined(HAVE_WSPAWNV)
4806#define EXECV_CHAR wchar_t
4807#else
4808#define EXECV_CHAR char
4809#endif
4810
Martin v. Löwis114619e2002-10-07 06:44:21 +00004811#if defined(HAVE_EXECV) || defined(HAVE_SPAWNV)
4812static void
Steve Dowercc16be82016-09-08 10:35:16 -07004813free_string_array(EXECV_CHAR **array, Py_ssize_t count)
Martin v. Löwis114619e2002-10-07 06:44:21 +00004814{
Victor Stinner8c62be82010-05-06 00:08:46 +00004815 Py_ssize_t i;
4816 for (i = 0; i < count; i++)
4817 PyMem_Free(array[i]);
4818 PyMem_DEL(array);
Martin v. Löwis114619e2002-10-07 06:44:21 +00004819}
Martin v. Löwis011e8422009-05-05 04:43:17 +00004820
Berker Peksag81816462016-09-15 20:19:47 +03004821static int
4822fsconvert_strdup(PyObject *o, EXECV_CHAR **out)
Martin v. Löwis011e8422009-05-05 04:43:17 +00004823{
Victor Stinner8c62be82010-05-06 00:08:46 +00004824 Py_ssize_t size;
Berker Peksag81816462016-09-15 20:19:47 +03004825 PyObject *ub;
4826 int result = 0;
Steve Dowercc16be82016-09-08 10:35:16 -07004827#if defined(HAVE_WEXECV) || defined(HAVE_WSPAWNV)
Berker Peksag81816462016-09-15 20:19:47 +03004828 if (!PyUnicode_FSDecoder(o, &ub))
Steve Dowercc16be82016-09-08 10:35:16 -07004829 return 0;
Berker Peksag81816462016-09-15 20:19:47 +03004830 *out = PyUnicode_AsWideCharString(ub, &size);
4831 if (*out)
4832 result = 1;
Steve Dowercc16be82016-09-08 10:35:16 -07004833#else
Berker Peksag81816462016-09-15 20:19:47 +03004834 if (!PyUnicode_FSConverter(o, &ub))
Victor Stinner8c62be82010-05-06 00:08:46 +00004835 return 0;
Berker Peksag81816462016-09-15 20:19:47 +03004836 size = PyBytes_GET_SIZE(ub);
4837 *out = PyMem_Malloc(size + 1);
4838 if (*out) {
4839 memcpy(*out, PyBytes_AS_STRING(ub), size + 1);
4840 result = 1;
4841 } else
Victor Stinner50abf222013-11-07 23:56:10 +01004842 PyErr_NoMemory();
Steve Dowercc16be82016-09-08 10:35:16 -07004843#endif
Berker Peksag81816462016-09-15 20:19:47 +03004844 Py_DECREF(ub);
4845 return result;
Martin v. Löwis011e8422009-05-05 04:43:17 +00004846}
Martin v. Löwis114619e2002-10-07 06:44:21 +00004847#endif
4848
Ross Lagerwall7807c352011-03-17 20:20:30 +02004849#if defined(HAVE_EXECV) || defined (HAVE_FEXECVE)
Steve Dowercc16be82016-09-08 10:35:16 -07004850static EXECV_CHAR**
Victor Stinner13bb71c2010-04-23 21:41:56 +00004851parse_envlist(PyObject* env, Py_ssize_t *envc_ptr)
4852{
Victor Stinner8c62be82010-05-06 00:08:46 +00004853 Py_ssize_t i, pos, envc;
4854 PyObject *keys=NULL, *vals=NULL;
Berker Peksag81816462016-09-15 20:19:47 +03004855 PyObject *key, *val, *key2, *val2, *keyval;
Steve Dowercc16be82016-09-08 10:35:16 -07004856 EXECV_CHAR **envlist;
Victor Stinner13bb71c2010-04-23 21:41:56 +00004857
Victor Stinner8c62be82010-05-06 00:08:46 +00004858 i = PyMapping_Size(env);
4859 if (i < 0)
4860 return NULL;
Steve Dowercc16be82016-09-08 10:35:16 -07004861 envlist = PyMem_NEW(EXECV_CHAR *, i + 1);
Victor Stinner8c62be82010-05-06 00:08:46 +00004862 if (envlist == NULL) {
4863 PyErr_NoMemory();
4864 return NULL;
4865 }
4866 envc = 0;
4867 keys = PyMapping_Keys(env);
Victor Stinnerb0314272013-11-14 21:37:05 +01004868 if (!keys)
4869 goto error;
Victor Stinner8c62be82010-05-06 00:08:46 +00004870 vals = PyMapping_Values(env);
Victor Stinnerb0314272013-11-14 21:37:05 +01004871 if (!vals)
Victor Stinner8c62be82010-05-06 00:08:46 +00004872 goto error;
4873 if (!PyList_Check(keys) || !PyList_Check(vals)) {
4874 PyErr_Format(PyExc_TypeError,
4875 "env.keys() or env.values() is not a list");
4876 goto error;
4877 }
Victor Stinner13bb71c2010-04-23 21:41:56 +00004878
Victor Stinner8c62be82010-05-06 00:08:46 +00004879 for (pos = 0; pos < i; pos++) {
4880 key = PyList_GetItem(keys, pos);
4881 val = PyList_GetItem(vals, pos);
4882 if (!key || !val)
4883 goto error;
Victor Stinner13bb71c2010-04-23 21:41:56 +00004884
Berker Peksag81816462016-09-15 20:19:47 +03004885#if defined(HAVE_WEXECV) || defined(HAVE_WSPAWNV)
4886 if (!PyUnicode_FSDecoder(key, &key2))
4887 goto error;
4888 if (!PyUnicode_FSDecoder(val, &val2)) {
4889 Py_DECREF(key2);
4890 goto error;
4891 }
Serhiy Storchaka77703942017-06-25 07:33:01 +03004892 /* Search from index 1 because on Windows starting '=' is allowed for
4893 defining hidden environment variables. */
4894 if (PyUnicode_GET_LENGTH(key2) == 0 ||
4895 PyUnicode_FindChar(key2, '=', 1, PyUnicode_GET_LENGTH(key2), 1) != -1)
4896 {
4897 PyErr_SetString(PyExc_ValueError, "illegal environment variable name");
Eric N. Vander Weelea7874c72017-06-26 21:35:20 -04004898 Py_DECREF(key2);
4899 Py_DECREF(val2);
Serhiy Storchaka77703942017-06-25 07:33:01 +03004900 goto error;
4901 }
Berker Peksag81816462016-09-15 20:19:47 +03004902 keyval = PyUnicode_FromFormat("%U=%U", key2, val2);
4903#else
4904 if (!PyUnicode_FSConverter(key, &key2))
4905 goto error;
4906 if (!PyUnicode_FSConverter(val, &val2)) {
4907 Py_DECREF(key2);
4908 goto error;
4909 }
Serhiy Storchaka77703942017-06-25 07:33:01 +03004910 if (PyBytes_GET_SIZE(key2) == 0 ||
4911 strchr(PyBytes_AS_STRING(key2) + 1, '=') != NULL)
4912 {
4913 PyErr_SetString(PyExc_ValueError, "illegal environment variable name");
Eric N. Vander Weelea7874c72017-06-26 21:35:20 -04004914 Py_DECREF(key2);
4915 Py_DECREF(val2);
Serhiy Storchaka77703942017-06-25 07:33:01 +03004916 goto error;
4917 }
Berker Peksag81816462016-09-15 20:19:47 +03004918 keyval = PyBytes_FromFormat("%s=%s", PyBytes_AS_STRING(key2),
4919 PyBytes_AS_STRING(val2));
4920#endif
4921 Py_DECREF(key2);
4922 Py_DECREF(val2);
Steve Dowercc16be82016-09-08 10:35:16 -07004923 if (!keyval)
Victor Stinner8c62be82010-05-06 00:08:46 +00004924 goto error;
Steve Dowercc16be82016-09-08 10:35:16 -07004925
4926 if (!fsconvert_strdup(keyval, &envlist[envc++])) {
4927 Py_DECREF(keyval);
Victor Stinner8c62be82010-05-06 00:08:46 +00004928 goto error;
4929 }
Berker Peksag81816462016-09-15 20:19:47 +03004930
Steve Dowercc16be82016-09-08 10:35:16 -07004931 Py_DECREF(keyval);
Victor Stinner8c62be82010-05-06 00:08:46 +00004932 }
4933 Py_DECREF(vals);
4934 Py_DECREF(keys);
Victor Stinner13bb71c2010-04-23 21:41:56 +00004935
Victor Stinner8c62be82010-05-06 00:08:46 +00004936 envlist[envc] = 0;
4937 *envc_ptr = envc;
4938 return envlist;
Victor Stinner13bb71c2010-04-23 21:41:56 +00004939
4940error:
Victor Stinner8c62be82010-05-06 00:08:46 +00004941 Py_XDECREF(keys);
4942 Py_XDECREF(vals);
Steve Dowercc16be82016-09-08 10:35:16 -07004943 free_string_array(envlist, envc);
Victor Stinner8c62be82010-05-06 00:08:46 +00004944 return NULL;
Victor Stinner13bb71c2010-04-23 21:41:56 +00004945}
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00004946
Steve Dowercc16be82016-09-08 10:35:16 -07004947static EXECV_CHAR**
Ross Lagerwall7807c352011-03-17 20:20:30 +02004948parse_arglist(PyObject* argv, Py_ssize_t *argc)
4949{
4950 int i;
Steve Dowercc16be82016-09-08 10:35:16 -07004951 EXECV_CHAR **argvlist = PyMem_NEW(EXECV_CHAR *, *argc+1);
Ross Lagerwall7807c352011-03-17 20:20:30 +02004952 if (argvlist == NULL) {
4953 PyErr_NoMemory();
4954 return NULL;
4955 }
4956 for (i = 0; i < *argc; i++) {
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02004957 PyObject* item = PySequence_ITEM(argv, i);
4958 if (item == NULL)
4959 goto fail;
4960 if (!fsconvert_strdup(item, &argvlist[i])) {
4961 Py_DECREF(item);
Ross Lagerwall7807c352011-03-17 20:20:30 +02004962 goto fail;
4963 }
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02004964 Py_DECREF(item);
Ross Lagerwall7807c352011-03-17 20:20:30 +02004965 }
4966 argvlist[*argc] = NULL;
4967 return argvlist;
4968fail:
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02004969 *argc = i;
Ross Lagerwall7807c352011-03-17 20:20:30 +02004970 free_string_array(argvlist, *argc);
4971 return NULL;
4972}
Steve Dowercc16be82016-09-08 10:35:16 -07004973
Ross Lagerwall7807c352011-03-17 20:20:30 +02004974#endif
4975
Larry Hastings2f936352014-08-05 14:04:04 +10004976
Ross Lagerwall7807c352011-03-17 20:20:30 +02004977#ifdef HAVE_EXECV
Larry Hastings2f936352014-08-05 14:04:04 +10004978/*[clinic input]
4979os.execv
4980
Steve Dowercc16be82016-09-08 10:35:16 -07004981 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +10004982 Path of executable file.
4983 argv: object
4984 Tuple or list of strings.
4985 /
4986
4987Execute an executable path with arguments, replacing current process.
4988[clinic start generated code]*/
4989
Larry Hastings2f936352014-08-05 14:04:04 +10004990static PyObject *
Steve Dowercc16be82016-09-08 10:35:16 -07004991os_execv_impl(PyObject *module, path_t *path, PyObject *argv)
4992/*[clinic end generated code: output=3b52fec34cd0dafd input=9bac31efae07dac7]*/
Larry Hastings2f936352014-08-05 14:04:04 +10004993{
Steve Dowercc16be82016-09-08 10:35:16 -07004994 EXECV_CHAR **argvlist;
Ross Lagerwall7807c352011-03-17 20:20:30 +02004995 Py_ssize_t argc;
4996
4997 /* execv has two arguments: (path, argv), where
4998 argv is a list or tuple of strings. */
4999
Ross Lagerwall7807c352011-03-17 20:20:30 +02005000 if (!PyList_Check(argv) && !PyTuple_Check(argv)) {
5001 PyErr_SetString(PyExc_TypeError,
5002 "execv() arg 2 must be a tuple or list");
Ross Lagerwall7807c352011-03-17 20:20:30 +02005003 return NULL;
5004 }
5005 argc = PySequence_Size(argv);
5006 if (argc < 1) {
5007 PyErr_SetString(PyExc_ValueError, "execv() arg 2 must not be empty");
Ross Lagerwall7807c352011-03-17 20:20:30 +02005008 return NULL;
5009 }
5010
5011 argvlist = parse_arglist(argv, &argc);
5012 if (argvlist == NULL) {
Ross Lagerwall7807c352011-03-17 20:20:30 +02005013 return NULL;
5014 }
Steve Dowerbce26262016-11-19 19:17:26 -08005015 if (!argvlist[0][0]) {
5016 PyErr_SetString(PyExc_ValueError,
5017 "execv() arg 2 first element cannot be empty");
5018 free_string_array(argvlist, argc);
5019 return NULL;
5020 }
Ross Lagerwall7807c352011-03-17 20:20:30 +02005021
Steve Dowerbce26262016-11-19 19:17:26 -08005022 _Py_BEGIN_SUPPRESS_IPH
Steve Dowercc16be82016-09-08 10:35:16 -07005023#ifdef HAVE_WEXECV
5024 _wexecv(path->wide, argvlist);
5025#else
5026 execv(path->narrow, argvlist);
5027#endif
Steve Dowerbce26262016-11-19 19:17:26 -08005028 _Py_END_SUPPRESS_IPH
Ross Lagerwall7807c352011-03-17 20:20:30 +02005029
5030 /* If we get here it's definitely an error */
5031
5032 free_string_array(argvlist, argc);
Ross Lagerwall7807c352011-03-17 20:20:30 +02005033 return posix_error();
5034}
5035
Larry Hastings2f936352014-08-05 14:04:04 +10005036
5037/*[clinic input]
5038os.execve
5039
5040 path: path_t(allow_fd='PATH_HAVE_FEXECVE')
5041 Path of executable file.
5042 argv: object
5043 Tuple or list of strings.
5044 env: object
5045 Dictionary of strings mapping to strings.
5046
5047Execute an executable path with arguments, replacing current process.
5048[clinic start generated code]*/
5049
Larry Hastings2f936352014-08-05 14:04:04 +10005050static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005051os_execve_impl(PyObject *module, path_t *path, PyObject *argv, PyObject *env)
5052/*[clinic end generated code: output=ff9fa8e4da8bde58 input=626804fa092606d9]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005053{
Steve Dowercc16be82016-09-08 10:35:16 -07005054 EXECV_CHAR **argvlist = NULL;
5055 EXECV_CHAR **envlist;
Ross Lagerwall7807c352011-03-17 20:20:30 +02005056 Py_ssize_t argc, envc;
Guido van Rossumc6dcc9f1993-11-05 10:15:19 +00005057
Victor Stinner8c62be82010-05-06 00:08:46 +00005058 /* execve has three arguments: (path, argv, env), where
5059 argv is a list or tuple of strings and env is a dictionary
5060 like posix.environ. */
Guido van Rossumc6dcc9f1993-11-05 10:15:19 +00005061
Ross Lagerwall7807c352011-03-17 20:20:30 +02005062 if (!PyList_Check(argv) && !PyTuple_Check(argv)) {
Victor Stinner8c62be82010-05-06 00:08:46 +00005063 PyErr_SetString(PyExc_TypeError,
Larry Hastings9cf065c2012-06-22 16:30:09 -07005064 "execve: argv must be a tuple or list");
5065 goto fail;
Victor Stinner8c62be82010-05-06 00:08:46 +00005066 }
Ross Lagerwall7807c352011-03-17 20:20:30 +02005067 argc = PySequence_Size(argv);
Steve Dowerbce26262016-11-19 19:17:26 -08005068 if (argc < 1) {
5069 PyErr_SetString(PyExc_ValueError, "execve: argv must not be empty");
5070 return NULL;
5071 }
5072
Victor Stinner8c62be82010-05-06 00:08:46 +00005073 if (!PyMapping_Check(env)) {
5074 PyErr_SetString(PyExc_TypeError,
Larry Hastings9cf065c2012-06-22 16:30:09 -07005075 "execve: environment must be a mapping object");
5076 goto fail;
Victor Stinner8c62be82010-05-06 00:08:46 +00005077 }
Guido van Rossumc6dcc9f1993-11-05 10:15:19 +00005078
Ross Lagerwall7807c352011-03-17 20:20:30 +02005079 argvlist = parse_arglist(argv, &argc);
Victor Stinner8c62be82010-05-06 00:08:46 +00005080 if (argvlist == NULL) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07005081 goto fail;
Victor Stinner8c62be82010-05-06 00:08:46 +00005082 }
Steve Dowerbce26262016-11-19 19:17:26 -08005083 if (!argvlist[0][0]) {
5084 PyErr_SetString(PyExc_ValueError,
5085 "execve: argv first element cannot be empty");
5086 goto fail;
5087 }
Guido van Rossumc6dcc9f1993-11-05 10:15:19 +00005088
Victor Stinner8c62be82010-05-06 00:08:46 +00005089 envlist = parse_envlist(env, &envc);
5090 if (envlist == NULL)
Ross Lagerwall7807c352011-03-17 20:20:30 +02005091 goto fail;
5092
Steve Dowerbce26262016-11-19 19:17:26 -08005093 _Py_BEGIN_SUPPRESS_IPH
Larry Hastings9cf065c2012-06-22 16:30:09 -07005094#ifdef HAVE_FEXECVE
Larry Hastings2f936352014-08-05 14:04:04 +10005095 if (path->fd > -1)
5096 fexecve(path->fd, argvlist, envlist);
Larry Hastings9cf065c2012-06-22 16:30:09 -07005097 else
5098#endif
Steve Dowercc16be82016-09-08 10:35:16 -07005099#ifdef HAVE_WEXECV
5100 _wexecve(path->wide, argvlist, envlist);
5101#else
Larry Hastings2f936352014-08-05 14:04:04 +10005102 execve(path->narrow, argvlist, envlist);
Steve Dowercc16be82016-09-08 10:35:16 -07005103#endif
Steve Dowerbce26262016-11-19 19:17:26 -08005104 _Py_END_SUPPRESS_IPH
Ross Lagerwall7807c352011-03-17 20:20:30 +02005105
5106 /* If we get here it's definitely an error */
5107
Larry Hastings2f936352014-08-05 14:04:04 +10005108 path_error(path);
Ross Lagerwall7807c352011-03-17 20:20:30 +02005109
Steve Dowercc16be82016-09-08 10:35:16 -07005110 free_string_array(envlist, envc);
Ross Lagerwall7807c352011-03-17 20:20:30 +02005111 fail:
Larry Hastings9cf065c2012-06-22 16:30:09 -07005112 if (argvlist)
5113 free_string_array(argvlist, argc);
Ross Lagerwall7807c352011-03-17 20:20:30 +02005114 return NULL;
5115}
Steve Dowercc16be82016-09-08 10:35:16 -07005116
Larry Hastings9cf065c2012-06-22 16:30:09 -07005117#endif /* HAVE_EXECV */
5118
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005119#ifdef HAVE_POSIX_SPAWN
5120
5121enum posix_spawn_file_actions_identifier {
5122 POSIX_SPAWN_OPEN,
5123 POSIX_SPAWN_CLOSE,
5124 POSIX_SPAWN_DUP2
5125};
5126
5127/*[clinic input]
5128
5129os.posix_spawn
5130 path: path_t
5131 Path of executable file.
5132 argv: object
5133 Tuple or list of strings.
5134 env: object
5135 Dictionary of strings mapping to strings.
5136 file_actions: object = None
5137 FileActions object.
5138 /
5139
5140Execute the program specified by path in a new process.
5141[clinic start generated code]*/
5142
5143static PyObject *
5144os_posix_spawn_impl(PyObject *module, path_t *path, PyObject *argv,
5145 PyObject *env, PyObject *file_actions)
5146/*[clinic end generated code: output=d023521f541c709c input=0ec9f1cfdc890be5]*/
5147{
5148 EXECV_CHAR **argvlist = NULL;
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005149 EXECV_CHAR **envlist = NULL;
5150 posix_spawn_file_actions_t _file_actions;
5151 posix_spawn_file_actions_t *file_actionsp = NULL;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005152 Py_ssize_t argc, envc;
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005153 PyObject* result = NULL;
5154 PyObject* seq = NULL;
5155
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005156
5157 /* posix_spawn has three arguments: (path, argv, env), where
5158 argv is a list or tuple of strings and env is a dictionary
5159 like posix.environ. */
5160
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005161 if (!PySequence_Check(argv)) {
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005162 PyErr_SetString(PyExc_TypeError,
5163 "posix_spawn: argv must be a tuple or list");
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005164 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005165 }
5166 argc = PySequence_Size(argv);
5167 if (argc < 1) {
5168 PyErr_SetString(PyExc_ValueError, "posix_spawn: argv must not be empty");
5169 return NULL;
5170 }
5171
5172 if (!PyMapping_Check(env)) {
5173 PyErr_SetString(PyExc_TypeError,
5174 "posix_spawn: environment must be a mapping object");
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005175 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005176 }
5177
5178 argvlist = parse_arglist(argv, &argc);
5179 if (argvlist == NULL) {
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005180 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005181 }
5182 if (!argvlist[0][0]) {
5183 PyErr_SetString(PyExc_ValueError,
5184 "posix_spawn: argv first element cannot be empty");
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005185 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005186 }
5187
5188 envlist = parse_envlist(env, &envc);
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005189 if (envlist == NULL) {
5190 goto exit;
5191 }
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005192
5193 pid_t pid;
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005194 if (file_actions != NULL && file_actions != Py_None) {
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005195 if(posix_spawn_file_actions_init(&_file_actions) != 0){
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005196 PyErr_SetString(PyExc_OSError,
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005197 "Error initializing file actions");
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005198 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005199 }
5200
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005201 file_actionsp = &_file_actions;
5202
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005203 seq = PySequence_Fast(file_actions, "file_actions must be a sequence");
5204 if(seq == NULL) {
5205 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005206 }
5207 PyObject* file_actions_obj;
5208 PyObject* mode_obj;
5209
5210 for (int i = 0; i < PySequence_Fast_GET_SIZE(seq); ++i) {
5211 file_actions_obj = PySequence_Fast_GET_ITEM(seq, i);
5212
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005213 if(!PySequence_Check(file_actions_obj) | !PySequence_Size(file_actions_obj)) {
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005214 PyErr_SetString(PyExc_TypeError,"Each file_action element must be a non empty sequence");
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005215 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005216 }
5217
5218
5219 mode_obj = PySequence_Fast_GET_ITEM(file_actions_obj, 0);
5220 int mode = PyLong_AsLong(mode_obj);
5221
5222 /* Populate the file_actions object */
5223
5224 switch(mode) {
5225
5226 case POSIX_SPAWN_OPEN:
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005227 if(PySequence_Size(file_actions_obj) != 5) {
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005228 PyErr_SetString(PyExc_TypeError,"A open file_action object must have 5 elements");
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005229 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005230 }
5231
5232 long open_fd = PyLong_AsLong(PySequence_GetItem(file_actions_obj, 1));
5233 if(PyErr_Occurred()) {
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005234 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005235 }
5236 const char* open_path = PyUnicode_AsUTF8(PySequence_GetItem(file_actions_obj, 2));
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005237 if(open_path == NULL) {
5238 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005239 }
5240 long open_oflag = PyLong_AsLong(PySequence_GetItem(file_actions_obj, 3));
5241 if(PyErr_Occurred()) {
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005242 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005243 }
5244 long open_mode = PyLong_AsLong(PySequence_GetItem(file_actions_obj, 4));
5245 if(PyErr_Occurred()) {
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005246 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005247 }
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005248 if(posix_spawn_file_actions_addopen(file_actionsp, open_fd, open_path, open_oflag, open_mode)) {
5249 PyErr_SetString(PyExc_OSError,"Failed to add open file action");
5250 goto exit;
5251 }
5252
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005253 break;
5254
5255 case POSIX_SPAWN_CLOSE:
5256 if(PySequence_Size(file_actions_obj) != 2){
5257 PyErr_SetString(PyExc_TypeError,"A close file_action object must have 2 elements");
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005258 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005259 }
5260
5261 long close_fd = PyLong_AsLong(PySequence_GetItem(file_actions_obj, 1));
5262 if(PyErr_Occurred()) {
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005263 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005264 }
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005265 if(posix_spawn_file_actions_addclose(file_actionsp, close_fd)) {
5266 PyErr_SetString(PyExc_OSError,"Failed to add close file action");
5267 goto exit;
5268 }
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005269 break;
5270
5271 case POSIX_SPAWN_DUP2:
5272 if(PySequence_Size(file_actions_obj) != 3){
5273 PyErr_SetString(PyExc_TypeError,"A dup2 file_action object must have 3 elements");
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005274 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005275 }
5276
5277 long fd1 = PyLong_AsLong(PySequence_GetItem(file_actions_obj, 1));
5278 if(PyErr_Occurred()) {
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005279 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005280 }
5281 long fd2 = PyLong_AsLong(PySequence_GetItem(file_actions_obj, 2));
5282 if(PyErr_Occurred()) {
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005283 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005284 }
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005285 if(posix_spawn_file_actions_adddup2(file_actionsp, fd1, fd2)) {
5286 PyErr_SetString(PyExc_OSError,"Failed to add dup2 file action");
5287 goto exit;
5288 }
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005289 break;
5290
5291 default:
5292 PyErr_SetString(PyExc_TypeError,"Unknown file_actions identifier");
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005293 goto exit;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005294 }
5295 }
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005296 }
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005297
5298 _Py_BEGIN_SUPPRESS_IPH
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005299 int err_code = posix_spawn(&pid, path->narrow, file_actionsp, NULL, argvlist, envlist);
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005300 _Py_END_SUPPRESS_IPH
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005301 if(err_code) {
5302 PyErr_SetString(PyExc_OSError,"posix_spawn call failed");
5303 goto exit;
5304 }
5305 result = PyLong_FromPid(pid);
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005306
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005307exit:
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005308
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005309 Py_XDECREF(seq);
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005310
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005311 if(file_actionsp) {
5312 posix_spawn_file_actions_destroy(file_actionsp);
5313 }
5314
5315 if (envlist) {
5316 free_string_array(envlist, envc);
5317 }
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005318
5319 if (argvlist) {
5320 free_string_array(argvlist, argc);
5321 }
Pablo Galindo0cd6bca2018-01-29 20:34:42 +00005322
5323 return result;
Pablo Galindo6c6ddf92018-01-29 01:56:10 +00005324
5325
5326}
5327#endif /* HAVE_POSIX_SPAWN */
5328
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00005329
Steve Dowercc16be82016-09-08 10:35:16 -07005330#if defined(HAVE_SPAWNV) || defined(HAVE_WSPAWNV)
Larry Hastings2f936352014-08-05 14:04:04 +10005331/*[clinic input]
5332os.spawnv
5333
5334 mode: int
5335 Mode of process creation.
Steve Dowercc16be82016-09-08 10:35:16 -07005336 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +10005337 Path of executable file.
5338 argv: object
5339 Tuple or list of strings.
5340 /
5341
5342Execute the program specified by path in a new process.
5343[clinic start generated code]*/
5344
Larry Hastings2f936352014-08-05 14:04:04 +10005345static PyObject *
Steve Dowercc16be82016-09-08 10:35:16 -07005346os_spawnv_impl(PyObject *module, int mode, path_t *path, PyObject *argv)
5347/*[clinic end generated code: output=71cd037a9d96b816 input=43224242303291be]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005348{
Steve Dowercc16be82016-09-08 10:35:16 -07005349 EXECV_CHAR **argvlist;
Larry Hastings2f936352014-08-05 14:04:04 +10005350 int i;
Victor Stinner8c62be82010-05-06 00:08:46 +00005351 Py_ssize_t argc;
Benjamin Petersonca470632016-09-06 13:47:26 -07005352 intptr_t spawnval;
Victor Stinner8c62be82010-05-06 00:08:46 +00005353 PyObject *(*getitem)(PyObject *, Py_ssize_t);
Guido van Rossuma1065681999-01-25 23:20:23 +00005354
Victor Stinner8c62be82010-05-06 00:08:46 +00005355 /* spawnv has three arguments: (mode, path, argv), where
5356 argv is a list or tuple of strings. */
Guido van Rossuma1065681999-01-25 23:20:23 +00005357
Victor Stinner8c62be82010-05-06 00:08:46 +00005358 if (PyList_Check(argv)) {
5359 argc = PyList_Size(argv);
5360 getitem = PyList_GetItem;
5361 }
5362 else if (PyTuple_Check(argv)) {
5363 argc = PyTuple_Size(argv);
5364 getitem = PyTuple_GetItem;
5365 }
5366 else {
5367 PyErr_SetString(PyExc_TypeError,
5368 "spawnv() arg 2 must be a tuple or list");
Victor Stinner8c62be82010-05-06 00:08:46 +00005369 return NULL;
5370 }
Steve Dower859fd7b2016-11-19 18:53:19 -08005371 if (argc == 0) {
5372 PyErr_SetString(PyExc_ValueError,
5373 "spawnv() arg 2 cannot be empty");
5374 return NULL;
5375 }
Guido van Rossuma1065681999-01-25 23:20:23 +00005376
Steve Dowercc16be82016-09-08 10:35:16 -07005377 argvlist = PyMem_NEW(EXECV_CHAR *, argc+1);
Victor Stinner8c62be82010-05-06 00:08:46 +00005378 if (argvlist == NULL) {
Victor Stinner8c62be82010-05-06 00:08:46 +00005379 return PyErr_NoMemory();
5380 }
5381 for (i = 0; i < argc; i++) {
5382 if (!fsconvert_strdup((*getitem)(argv, i),
5383 &argvlist[i])) {
5384 free_string_array(argvlist, i);
5385 PyErr_SetString(
5386 PyExc_TypeError,
5387 "spawnv() arg 2 must contain only strings");
Victor Stinner8c62be82010-05-06 00:08:46 +00005388 return NULL;
5389 }
Steve Dower93ff8722016-11-19 19:03:54 -08005390 if (i == 0 && !argvlist[0][0]) {
Victor Stinner8acb4cf2017-06-15 15:30:40 +02005391 free_string_array(argvlist, i + 1);
Steve Dower93ff8722016-11-19 19:03:54 -08005392 PyErr_SetString(
5393 PyExc_ValueError,
5394 "spawnv() arg 2 first element cannot be empty");
5395 return NULL;
5396 }
Victor Stinner8c62be82010-05-06 00:08:46 +00005397 }
5398 argvlist[argc] = NULL;
Guido van Rossuma1065681999-01-25 23:20:23 +00005399
Victor Stinner8c62be82010-05-06 00:08:46 +00005400 if (mode == _OLD_P_OVERLAY)
5401 mode = _P_OVERLAY;
Tim Peters5aa91602002-01-30 05:46:57 +00005402
Victor Stinner8c62be82010-05-06 00:08:46 +00005403 Py_BEGIN_ALLOW_THREADS
Steve Dower654a7bd2016-09-11 20:19:32 -07005404 _Py_BEGIN_SUPPRESS_IPH
Steve Dowercc16be82016-09-08 10:35:16 -07005405#ifdef HAVE_WSPAWNV
5406 spawnval = _wspawnv(mode, path->wide, argvlist);
5407#else
5408 spawnval = _spawnv(mode, path->narrow, argvlist);
5409#endif
Steve Dower654a7bd2016-09-11 20:19:32 -07005410 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00005411 Py_END_ALLOW_THREADS
Tim Peters5aa91602002-01-30 05:46:57 +00005412
Victor Stinner8c62be82010-05-06 00:08:46 +00005413 free_string_array(argvlist, argc);
Guido van Rossuma1065681999-01-25 23:20:23 +00005414
Victor Stinner8c62be82010-05-06 00:08:46 +00005415 if (spawnval == -1)
5416 return posix_error();
5417 else
Richard Oudkerkac0ad882013-06-05 23:29:30 +01005418 return Py_BuildValue(_Py_PARSE_INTPTR, spawnval);
Guido van Rossuma1065681999-01-25 23:20:23 +00005419}
5420
Larry Hastings2f936352014-08-05 14:04:04 +10005421/*[clinic input]
5422os.spawnve
5423
5424 mode: int
5425 Mode of process creation.
Steve Dowercc16be82016-09-08 10:35:16 -07005426 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +10005427 Path of executable file.
5428 argv: object
5429 Tuple or list of strings.
5430 env: object
5431 Dictionary of strings mapping to strings.
5432 /
5433
5434Execute the program specified by path in a new process.
5435[clinic start generated code]*/
5436
Larry Hastings2f936352014-08-05 14:04:04 +10005437static PyObject *
Steve Dowercc16be82016-09-08 10:35:16 -07005438os_spawnve_impl(PyObject *module, int mode, path_t *path, PyObject *argv,
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005439 PyObject *env)
Steve Dowercc16be82016-09-08 10:35:16 -07005440/*[clinic end generated code: output=30fe85be56fe37ad input=3e40803ee7c4c586]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005441{
Steve Dowercc16be82016-09-08 10:35:16 -07005442 EXECV_CHAR **argvlist;
5443 EXECV_CHAR **envlist;
Victor Stinner8c62be82010-05-06 00:08:46 +00005444 PyObject *res = NULL;
Antoine Pitrou22e41552010-08-15 18:07:50 +00005445 Py_ssize_t argc, i, envc;
Benjamin Petersonca470632016-09-06 13:47:26 -07005446 intptr_t spawnval;
Victor Stinner8c62be82010-05-06 00:08:46 +00005447 PyObject *(*getitem)(PyObject *, Py_ssize_t);
Victor Stinnerc8d6ab22017-06-23 15:04:46 +02005448 Py_ssize_t lastarg = 0;
Guido van Rossuma1065681999-01-25 23:20:23 +00005449
Victor Stinner8c62be82010-05-06 00:08:46 +00005450 /* spawnve has four arguments: (mode, path, argv, env), where
5451 argv is a list or tuple of strings and env is a dictionary
5452 like posix.environ. */
Guido van Rossuma1065681999-01-25 23:20:23 +00005453
Victor Stinner8c62be82010-05-06 00:08:46 +00005454 if (PyList_Check(argv)) {
5455 argc = PyList_Size(argv);
5456 getitem = PyList_GetItem;
5457 }
5458 else if (PyTuple_Check(argv)) {
5459 argc = PyTuple_Size(argv);
5460 getitem = PyTuple_GetItem;
5461 }
5462 else {
5463 PyErr_SetString(PyExc_TypeError,
5464 "spawnve() arg 2 must be a tuple or list");
5465 goto fail_0;
5466 }
Steve Dower859fd7b2016-11-19 18:53:19 -08005467 if (argc == 0) {
5468 PyErr_SetString(PyExc_ValueError,
5469 "spawnve() arg 2 cannot be empty");
5470 goto fail_0;
5471 }
Victor Stinner8c62be82010-05-06 00:08:46 +00005472 if (!PyMapping_Check(env)) {
5473 PyErr_SetString(PyExc_TypeError,
5474 "spawnve() arg 3 must be a mapping object");
5475 goto fail_0;
5476 }
Guido van Rossuma1065681999-01-25 23:20:23 +00005477
Steve Dowercc16be82016-09-08 10:35:16 -07005478 argvlist = PyMem_NEW(EXECV_CHAR *, argc+1);
Victor Stinner8c62be82010-05-06 00:08:46 +00005479 if (argvlist == NULL) {
5480 PyErr_NoMemory();
5481 goto fail_0;
5482 }
5483 for (i = 0; i < argc; i++) {
5484 if (!fsconvert_strdup((*getitem)(argv, i),
5485 &argvlist[i]))
5486 {
5487 lastarg = i;
5488 goto fail_1;
5489 }
Steve Dowerbce26262016-11-19 19:17:26 -08005490 if (i == 0 && !argvlist[0][0]) {
Victor Stinnerc8d6ab22017-06-23 15:04:46 +02005491 lastarg = i + 1;
Steve Dowerbce26262016-11-19 19:17:26 -08005492 PyErr_SetString(
5493 PyExc_ValueError,
5494 "spawnv() arg 2 first element cannot be empty");
5495 goto fail_1;
5496 }
Victor Stinner8c62be82010-05-06 00:08:46 +00005497 }
5498 lastarg = argc;
5499 argvlist[argc] = NULL;
Guido van Rossuma1065681999-01-25 23:20:23 +00005500
Victor Stinner8c62be82010-05-06 00:08:46 +00005501 envlist = parse_envlist(env, &envc);
5502 if (envlist == NULL)
5503 goto fail_1;
Guido van Rossuma1065681999-01-25 23:20:23 +00005504
Victor Stinner8c62be82010-05-06 00:08:46 +00005505 if (mode == _OLD_P_OVERLAY)
5506 mode = _P_OVERLAY;
Tim Peters25059d32001-12-07 20:35:43 +00005507
Victor Stinner8c62be82010-05-06 00:08:46 +00005508 Py_BEGIN_ALLOW_THREADS
Steve Dower654a7bd2016-09-11 20:19:32 -07005509 _Py_BEGIN_SUPPRESS_IPH
Steve Dowercc16be82016-09-08 10:35:16 -07005510#ifdef HAVE_WSPAWNV
5511 spawnval = _wspawnve(mode, path->wide, argvlist, envlist);
5512#else
5513 spawnval = _spawnve(mode, path->narrow, argvlist, envlist);
5514#endif
Steve Dower654a7bd2016-09-11 20:19:32 -07005515 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00005516 Py_END_ALLOW_THREADS
Tim Peters25059d32001-12-07 20:35:43 +00005517
Victor Stinner8c62be82010-05-06 00:08:46 +00005518 if (spawnval == -1)
5519 (void) posix_error();
5520 else
Richard Oudkerkac0ad882013-06-05 23:29:30 +01005521 res = Py_BuildValue(_Py_PARSE_INTPTR, spawnval);
Guido van Rossuma1065681999-01-25 23:20:23 +00005522
Victor Stinner8c62be82010-05-06 00:08:46 +00005523 while (--envc >= 0)
5524 PyMem_DEL(envlist[envc]);
5525 PyMem_DEL(envlist);
Guido van Rossum0847c5c2002-12-13 18:36:22 +00005526 fail_1:
Victor Stinnerc8d6ab22017-06-23 15:04:46 +02005527 free_string_array(argvlist, lastarg);
Martin v. Löwis114619e2002-10-07 06:44:21 +00005528 fail_0:
Victor Stinner8c62be82010-05-06 00:08:46 +00005529 return res;
Guido van Rossuma1065681999-01-25 23:20:23 +00005530}
Andrew MacIntyre69e18c92004-04-04 07:11:43 +00005531
Guido van Rossuma1065681999-01-25 23:20:23 +00005532#endif /* HAVE_SPAWNV */
5533
5534
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005535#ifdef HAVE_FORK
Gregory P. Smith163468a2017-05-29 10:03:41 -07005536
5537/* Helper function to validate arguments.
5538 Returns 0 on success. non-zero on failure with a TypeError raised.
5539 If obj is non-NULL it must be callable. */
5540static int
5541check_null_or_callable(PyObject *obj, const char* obj_name)
5542{
5543 if (obj && !PyCallable_Check(obj)) {
5544 PyErr_Format(PyExc_TypeError, "'%s' must be callable, not %s",
5545 obj_name, Py_TYPE(obj)->tp_name);
5546 return -1;
5547 }
5548 return 0;
5549}
5550
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005551/*[clinic input]
5552os.register_at_fork
5553
Gregory P. Smith163468a2017-05-29 10:03:41 -07005554 *
5555 before: object=NULL
5556 A callable to be called in the parent before the fork() syscall.
5557 after_in_child: object=NULL
5558 A callable to be called in the child after fork().
5559 after_in_parent: object=NULL
5560 A callable to be called in the parent after fork().
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005561
Gregory P. Smith163468a2017-05-29 10:03:41 -07005562Register callables to be called when forking a new process.
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005563
Gregory P. Smith163468a2017-05-29 10:03:41 -07005564'before' callbacks are called in reverse order.
5565'after_in_child' and 'after_in_parent' callbacks are called in order.
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005566
5567[clinic start generated code]*/
5568
5569static PyObject *
Gregory P. Smith163468a2017-05-29 10:03:41 -07005570os_register_at_fork_impl(PyObject *module, PyObject *before,
5571 PyObject *after_in_child, PyObject *after_in_parent)
5572/*[clinic end generated code: output=5398ac75e8e97625 input=cd1187aa85d2312e]*/
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005573{
5574 PyInterpreterState *interp;
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005575
Gregory P. Smith163468a2017-05-29 10:03:41 -07005576 if (!before && !after_in_child && !after_in_parent) {
5577 PyErr_SetString(PyExc_TypeError, "At least one argument is required.");
5578 return NULL;
5579 }
5580 if (check_null_or_callable(before, "before") ||
5581 check_null_or_callable(after_in_child, "after_in_child") ||
5582 check_null_or_callable(after_in_parent, "after_in_parent")) {
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005583 return NULL;
5584 }
5585 interp = PyThreadState_Get()->interp;
5586
Gregory P. Smith163468a2017-05-29 10:03:41 -07005587 if (register_at_forker(&interp->before_forkers, before)) {
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005588 return NULL;
5589 }
Gregory P. Smith163468a2017-05-29 10:03:41 -07005590 if (register_at_forker(&interp->after_forkers_child, after_in_child)) {
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005591 return NULL;
Gregory P. Smith163468a2017-05-29 10:03:41 -07005592 }
5593 if (register_at_forker(&interp->after_forkers_parent, after_in_parent)) {
5594 return NULL;
5595 }
5596 Py_RETURN_NONE;
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005597}
5598#endif /* HAVE_FORK */
5599
5600
Guido van Rossum2242f2f2001-04-11 20:58:20 +00005601#ifdef HAVE_FORK1
Larry Hastings2f936352014-08-05 14:04:04 +10005602/*[clinic input]
5603os.fork1
5604
5605Fork a child process with a single multiplexed (i.e., not bound) thread.
5606
5607Return 0 to child process and PID of child to parent process.
5608[clinic start generated code]*/
5609
Larry Hastings2f936352014-08-05 14:04:04 +10005610static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005611os_fork1_impl(PyObject *module)
5612/*[clinic end generated code: output=0de8e67ce2a310bc input=12db02167893926e]*/
Guido van Rossum2242f2f2001-04-11 20:58:20 +00005613{
Victor Stinner8c62be82010-05-06 00:08:46 +00005614 pid_t pid;
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005615
5616 PyOS_BeforeFork();
Victor Stinner8c62be82010-05-06 00:08:46 +00005617 pid = fork1();
5618 if (pid == 0) {
5619 /* child: this clobbers and resets the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005620 PyOS_AfterFork_Child();
Victor Stinner8c62be82010-05-06 00:08:46 +00005621 } else {
5622 /* parent: release the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005623 PyOS_AfterFork_Parent();
Victor Stinner8c62be82010-05-06 00:08:46 +00005624 }
5625 if (pid == -1)
5626 return posix_error();
Victor Stinner8c62be82010-05-06 00:08:46 +00005627 return PyLong_FromPid(pid);
Guido van Rossum2242f2f2001-04-11 20:58:20 +00005628}
Larry Hastings2f936352014-08-05 14:04:04 +10005629#endif /* HAVE_FORK1 */
Guido van Rossum2242f2f2001-04-11 20:58:20 +00005630
5631
Guido van Rossumad0ee831995-03-01 10:34:45 +00005632#ifdef HAVE_FORK
Larry Hastings2f936352014-08-05 14:04:04 +10005633/*[clinic input]
5634os.fork
5635
5636Fork a child process.
5637
5638Return 0 to child process and PID of child to parent process.
5639[clinic start generated code]*/
5640
Larry Hastings2f936352014-08-05 14:04:04 +10005641static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005642os_fork_impl(PyObject *module)
5643/*[clinic end generated code: output=3626c81f98985d49 input=13c956413110eeaa]*/
Guido van Rossum85e3b011991-06-03 12:42:10 +00005644{
Victor Stinner8c62be82010-05-06 00:08:46 +00005645 pid_t pid;
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005646
5647 PyOS_BeforeFork();
Victor Stinner8c62be82010-05-06 00:08:46 +00005648 pid = fork();
5649 if (pid == 0) {
5650 /* child: this clobbers and resets the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005651 PyOS_AfterFork_Child();
Victor Stinner8c62be82010-05-06 00:08:46 +00005652 } else {
5653 /* parent: release the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02005654 PyOS_AfterFork_Parent();
Victor Stinner8c62be82010-05-06 00:08:46 +00005655 }
5656 if (pid == -1)
5657 return posix_error();
Victor Stinner8c62be82010-05-06 00:08:46 +00005658 return PyLong_FromPid(pid);
Guido van Rossum85e3b011991-06-03 12:42:10 +00005659}
Larry Hastings2f936352014-08-05 14:04:04 +10005660#endif /* HAVE_FORK */
5661
Guido van Rossum85e3b011991-06-03 12:42:10 +00005662
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005663#ifdef HAVE_SCHED_H
Charles-François Nataliea0d5fc2011-09-06 19:03:35 +02005664#ifdef HAVE_SCHED_GET_PRIORITY_MAX
Larry Hastings2f936352014-08-05 14:04:04 +10005665/*[clinic input]
5666os.sched_get_priority_max
Charles-François Nataliea0d5fc2011-09-06 19:03:35 +02005667
Larry Hastings2f936352014-08-05 14:04:04 +10005668 policy: int
5669
5670Get the maximum scheduling priority for policy.
5671[clinic start generated code]*/
5672
Larry Hastings2f936352014-08-05 14:04:04 +10005673static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005674os_sched_get_priority_max_impl(PyObject *module, int policy)
5675/*[clinic end generated code: output=9e465c6e43130521 input=2097b7998eca6874]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005676{
5677 int max;
5678
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005679 max = sched_get_priority_max(policy);
5680 if (max < 0)
5681 return posix_error();
5682 return PyLong_FromLong(max);
5683}
5684
Larry Hastings2f936352014-08-05 14:04:04 +10005685
5686/*[clinic input]
5687os.sched_get_priority_min
5688
5689 policy: int
5690
5691Get the minimum scheduling priority for policy.
5692[clinic start generated code]*/
5693
Larry Hastings2f936352014-08-05 14:04:04 +10005694static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005695os_sched_get_priority_min_impl(PyObject *module, int policy)
5696/*[clinic end generated code: output=7595c1138cc47a6d input=21bc8fa0d70983bf]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005697{
5698 int min = sched_get_priority_min(policy);
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005699 if (min < 0)
5700 return posix_error();
5701 return PyLong_FromLong(min);
5702}
Charles-François Nataliea0d5fc2011-09-06 19:03:35 +02005703#endif /* HAVE_SCHED_GET_PRIORITY_MAX */
5704
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05005705
Larry Hastings2f936352014-08-05 14:04:04 +10005706#ifdef HAVE_SCHED_SETSCHEDULER
5707/*[clinic input]
5708os.sched_getscheduler
5709 pid: pid_t
5710 /
5711
5712Get the scheduling policy for the process identifiedy by pid.
5713
5714Passing 0 for pid returns the scheduling policy for the calling process.
5715[clinic start generated code]*/
5716
Larry Hastings2f936352014-08-05 14:04:04 +10005717static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005718os_sched_getscheduler_impl(PyObject *module, pid_t pid)
5719/*[clinic end generated code: output=dce4c0bd3f1b34c8 input=5f14cfd1f189e1a0]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005720{
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005721 int policy;
5722
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005723 policy = sched_getscheduler(pid);
5724 if (policy < 0)
5725 return posix_error();
5726 return PyLong_FromLong(policy);
5727}
Larry Hastings2f936352014-08-05 14:04:04 +10005728#endif /* HAVE_SCHED_SETSCHEDULER */
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005729
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05005730
5731#if defined(HAVE_SCHED_SETSCHEDULER) || defined(HAVE_SCHED_SETPARAM)
Larry Hastings2f936352014-08-05 14:04:04 +10005732/*[clinic input]
5733class os.sched_param "PyObject *" "&SchedParamType"
5734
5735@classmethod
5736os.sched_param.__new__
5737
5738 sched_priority: object
5739 A scheduling parameter.
5740
5741Current has only one field: sched_priority");
5742[clinic start generated code]*/
5743
Larry Hastings2f936352014-08-05 14:04:04 +10005744static PyObject *
5745os_sched_param_impl(PyTypeObject *type, PyObject *sched_priority)
Serhiy Storchaka1009bf12015-04-03 23:53:51 +03005746/*[clinic end generated code: output=48f4067d60f48c13 input=73a4c22f7071fc62]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005747{
5748 PyObject *res;
5749
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005750 res = PyStructSequence_New(type);
5751 if (!res)
5752 return NULL;
Larry Hastings2f936352014-08-05 14:04:04 +10005753 Py_INCREF(sched_priority);
5754 PyStructSequence_SET_ITEM(res, 0, sched_priority);
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005755 return res;
5756}
5757
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005758
Serhiy Storchaka1009bf12015-04-03 23:53:51 +03005759PyDoc_VAR(os_sched_param__doc__);
5760
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005761static PyStructSequence_Field sched_param_fields[] = {
5762 {"sched_priority", "the scheduling priority"},
5763 {0}
5764};
5765
5766static PyStructSequence_Desc sched_param_desc = {
5767 "sched_param", /* name */
Larry Hastings2f936352014-08-05 14:04:04 +10005768 os_sched_param__doc__, /* doc */
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005769 sched_param_fields,
5770 1
5771};
5772
5773static int
5774convert_sched_param(PyObject *param, struct sched_param *res)
5775{
5776 long priority;
5777
5778 if (Py_TYPE(param) != &SchedParamType) {
5779 PyErr_SetString(PyExc_TypeError, "must have a sched_param object");
5780 return 0;
5781 }
5782 priority = PyLong_AsLong(PyStructSequence_GET_ITEM(param, 0));
5783 if (priority == -1 && PyErr_Occurred())
5784 return 0;
5785 if (priority > INT_MAX || priority < INT_MIN) {
5786 PyErr_SetString(PyExc_OverflowError, "sched_priority out of range");
5787 return 0;
5788 }
5789 res->sched_priority = Py_SAFE_DOWNCAST(priority, long, int);
5790 return 1;
5791}
Larry Hastings2f936352014-08-05 14:04:04 +10005792#endif /* defined(HAVE_SCHED_SETSCHEDULER) || defined(HAVE_SCHED_SETPARAM) */
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005793
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05005794
5795#ifdef HAVE_SCHED_SETSCHEDULER
Larry Hastings2f936352014-08-05 14:04:04 +10005796/*[clinic input]
5797os.sched_setscheduler
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05005798
Larry Hastings2f936352014-08-05 14:04:04 +10005799 pid: pid_t
5800 policy: int
5801 param: sched_param
5802 /
5803
5804Set the scheduling policy for the process identified by pid.
5805
5806If pid is 0, the calling process is changed.
5807param is an instance of sched_param.
5808[clinic start generated code]*/
5809
Larry Hastings2f936352014-08-05 14:04:04 +10005810static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005811os_sched_setscheduler_impl(PyObject *module, pid_t pid, int policy,
Larry Hastings89964c42015-04-14 18:07:59 -04005812 struct sched_param *param)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005813/*[clinic end generated code: output=b0ac0a70d3b1d705 input=c581f9469a5327dd]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005814{
Jesus Cea9c822272011-09-10 01:40:52 +02005815 /*
Jesus Cea54b01492011-09-10 01:53:19 +02005816 ** sched_setscheduler() returns 0 in Linux, but the previous
5817 ** scheduling policy under Solaris/Illumos, and others.
5818 ** On error, -1 is returned in all Operating Systems.
Jesus Cea9c822272011-09-10 01:40:52 +02005819 */
Larry Hastings2f936352014-08-05 14:04:04 +10005820 if (sched_setscheduler(pid, policy, param) == -1)
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005821 return posix_error();
5822 Py_RETURN_NONE;
5823}
Larry Hastings2f936352014-08-05 14:04:04 +10005824#endif /* HAVE_SCHED_SETSCHEDULER*/
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005825
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05005826
5827#ifdef HAVE_SCHED_SETPARAM
Larry Hastings2f936352014-08-05 14:04:04 +10005828/*[clinic input]
5829os.sched_getparam
5830 pid: pid_t
5831 /
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05005832
Larry Hastings2f936352014-08-05 14:04:04 +10005833Returns scheduling parameters for the process identified by pid.
5834
5835If pid is 0, returns parameters for the calling process.
5836Return value is an instance of sched_param.
5837[clinic start generated code]*/
5838
Larry Hastings2f936352014-08-05 14:04:04 +10005839static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005840os_sched_getparam_impl(PyObject *module, pid_t pid)
5841/*[clinic end generated code: output=b194e8708dcf2db8 input=18a1ef9c2efae296]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005842{
5843 struct sched_param param;
5844 PyObject *result;
5845 PyObject *priority;
5846
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005847 if (sched_getparam(pid, &param))
5848 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10005849 result = PyStructSequence_New(&SchedParamType);
5850 if (!result)
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005851 return NULL;
5852 priority = PyLong_FromLong(param.sched_priority);
5853 if (!priority) {
Larry Hastings2f936352014-08-05 14:04:04 +10005854 Py_DECREF(result);
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005855 return NULL;
5856 }
Larry Hastings2f936352014-08-05 14:04:04 +10005857 PyStructSequence_SET_ITEM(result, 0, priority);
5858 return result;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005859}
5860
Larry Hastings2f936352014-08-05 14:04:04 +10005861
5862/*[clinic input]
5863os.sched_setparam
5864 pid: pid_t
5865 param: sched_param
5866 /
5867
5868Set scheduling parameters for the process identified by pid.
5869
5870If pid is 0, sets parameters for the calling process.
5871param should be an instance of sched_param.
5872[clinic start generated code]*/
5873
Larry Hastings2f936352014-08-05 14:04:04 +10005874static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005875os_sched_setparam_impl(PyObject *module, pid_t pid,
Larry Hastings89964c42015-04-14 18:07:59 -04005876 struct sched_param *param)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005877/*[clinic end generated code: output=8af013f78a32b591 input=6b8d6dfcecdc21bd]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005878{
5879 if (sched_setparam(pid, param))
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005880 return posix_error();
5881 Py_RETURN_NONE;
5882}
Larry Hastings2f936352014-08-05 14:04:04 +10005883#endif /* HAVE_SCHED_SETPARAM */
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005884
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05005885
5886#ifdef HAVE_SCHED_RR_GET_INTERVAL
Larry Hastings2f936352014-08-05 14:04:04 +10005887/*[clinic input]
5888os.sched_rr_get_interval -> double
5889 pid: pid_t
5890 /
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05005891
Larry Hastings2f936352014-08-05 14:04:04 +10005892Return the round-robin quantum for the process identified by pid, in seconds.
5893
5894Value returned is a float.
5895[clinic start generated code]*/
5896
Larry Hastings2f936352014-08-05 14:04:04 +10005897static double
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005898os_sched_rr_get_interval_impl(PyObject *module, pid_t pid)
5899/*[clinic end generated code: output=7e2d935833ab47dc input=2a973da15cca6fae]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005900{
5901 struct timespec interval;
5902 if (sched_rr_get_interval(pid, &interval)) {
5903 posix_error();
5904 return -1.0;
5905 }
5906 return (double)interval.tv_sec + 1e-9*interval.tv_nsec;
5907}
5908#endif /* HAVE_SCHED_RR_GET_INTERVAL */
Benjamin Petersonc5fce4d2011-08-02 18:07:32 -05005909
Larry Hastings2f936352014-08-05 14:04:04 +10005910
5911/*[clinic input]
5912os.sched_yield
5913
5914Voluntarily relinquish the CPU.
5915[clinic start generated code]*/
5916
Larry Hastings2f936352014-08-05 14:04:04 +10005917static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005918os_sched_yield_impl(PyObject *module)
5919/*[clinic end generated code: output=902323500f222cac input=e54d6f98189391d4]*/
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005920{
5921 if (sched_yield())
5922 return posix_error();
5923 Py_RETURN_NONE;
5924}
5925
Benjamin Peterson2740af82011-08-02 17:41:34 -05005926#ifdef HAVE_SCHED_SETAFFINITY
Antoine Pitrou84869872012-08-04 16:16:35 +02005927/* The minimum number of CPUs allocated in a cpu_set_t */
5928static const int NCPUS_START = sizeof(unsigned long) * CHAR_BIT;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005929
Larry Hastings2f936352014-08-05 14:04:04 +10005930/*[clinic input]
5931os.sched_setaffinity
5932 pid: pid_t
5933 mask : object
5934 /
5935
5936Set the CPU affinity of the process identified by pid to mask.
5937
5938mask should be an iterable of integers identifying CPUs.
5939[clinic start generated code]*/
5940
Larry Hastings2f936352014-08-05 14:04:04 +10005941static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005942os_sched_setaffinity_impl(PyObject *module, pid_t pid, PyObject *mask)
5943/*[clinic end generated code: output=882d7dd9a229335b input=a0791a597c7085ba]*/
Larry Hastings2f936352014-08-05 14:04:04 +10005944{
Antoine Pitrou84869872012-08-04 16:16:35 +02005945 int ncpus;
5946 size_t setsize;
Larry Hastings2f936352014-08-05 14:04:04 +10005947 cpu_set_t *cpu_set = NULL;
5948 PyObject *iterator = NULL, *item;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05005949
Larry Hastings2f936352014-08-05 14:04:04 +10005950 iterator = PyObject_GetIter(mask);
Antoine Pitrou84869872012-08-04 16:16:35 +02005951 if (iterator == NULL)
5952 return NULL;
5953
5954 ncpus = NCPUS_START;
5955 setsize = CPU_ALLOC_SIZE(ncpus);
Larry Hastings2f936352014-08-05 14:04:04 +10005956 cpu_set = CPU_ALLOC(ncpus);
5957 if (cpu_set == NULL) {
Antoine Pitrou84869872012-08-04 16:16:35 +02005958 PyErr_NoMemory();
5959 goto error;
5960 }
Larry Hastings2f936352014-08-05 14:04:04 +10005961 CPU_ZERO_S(setsize, cpu_set);
Antoine Pitrou84869872012-08-04 16:16:35 +02005962
5963 while ((item = PyIter_Next(iterator))) {
5964 long cpu;
5965 if (!PyLong_Check(item)) {
5966 PyErr_Format(PyExc_TypeError,
5967 "expected an iterator of ints, "
5968 "but iterator yielded %R",
5969 Py_TYPE(item));
5970 Py_DECREF(item);
5971 goto error;
5972 }
5973 cpu = PyLong_AsLong(item);
5974 Py_DECREF(item);
5975 if (cpu < 0) {
5976 if (!PyErr_Occurred())
5977 PyErr_SetString(PyExc_ValueError, "negative CPU number");
5978 goto error;
5979 }
5980 if (cpu > INT_MAX - 1) {
5981 PyErr_SetString(PyExc_OverflowError, "CPU number too large");
5982 goto error;
5983 }
5984 if (cpu >= ncpus) {
5985 /* Grow CPU mask to fit the CPU number */
5986 int newncpus = ncpus;
5987 cpu_set_t *newmask;
5988 size_t newsetsize;
5989 while (newncpus <= cpu) {
5990 if (newncpus > INT_MAX / 2)
5991 newncpus = cpu + 1;
5992 else
5993 newncpus = newncpus * 2;
5994 }
5995 newmask = CPU_ALLOC(newncpus);
5996 if (newmask == NULL) {
5997 PyErr_NoMemory();
5998 goto error;
5999 }
6000 newsetsize = CPU_ALLOC_SIZE(newncpus);
6001 CPU_ZERO_S(newsetsize, newmask);
Larry Hastings2f936352014-08-05 14:04:04 +10006002 memcpy(newmask, cpu_set, setsize);
6003 CPU_FREE(cpu_set);
Antoine Pitrou84869872012-08-04 16:16:35 +02006004 setsize = newsetsize;
Larry Hastings2f936352014-08-05 14:04:04 +10006005 cpu_set = newmask;
Antoine Pitrou84869872012-08-04 16:16:35 +02006006 ncpus = newncpus;
6007 }
Larry Hastings2f936352014-08-05 14:04:04 +10006008 CPU_SET_S(cpu, setsize, cpu_set);
Antoine Pitrou84869872012-08-04 16:16:35 +02006009 }
6010 Py_CLEAR(iterator);
6011
Larry Hastings2f936352014-08-05 14:04:04 +10006012 if (sched_setaffinity(pid, setsize, cpu_set)) {
Antoine Pitrou84869872012-08-04 16:16:35 +02006013 posix_error();
6014 goto error;
6015 }
Larry Hastings2f936352014-08-05 14:04:04 +10006016 CPU_FREE(cpu_set);
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006017 Py_RETURN_NONE;
Antoine Pitrou84869872012-08-04 16:16:35 +02006018
6019error:
Larry Hastings2f936352014-08-05 14:04:04 +10006020 if (cpu_set)
6021 CPU_FREE(cpu_set);
Antoine Pitrou84869872012-08-04 16:16:35 +02006022 Py_XDECREF(iterator);
6023 return NULL;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006024}
6025
Larry Hastings2f936352014-08-05 14:04:04 +10006026
6027/*[clinic input]
6028os.sched_getaffinity
6029 pid: pid_t
6030 /
6031
Charles-François Natalidc87e4b2015-07-13 21:01:39 +01006032Return the affinity of the process identified by pid (or the current process if zero).
Larry Hastings2f936352014-08-05 14:04:04 +10006033
6034The affinity is returned as a set of CPU identifiers.
6035[clinic start generated code]*/
6036
Larry Hastings2f936352014-08-05 14:04:04 +10006037static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006038os_sched_getaffinity_impl(PyObject *module, pid_t pid)
Serhiy Storchaka2954f832016-07-07 18:20:03 +03006039/*[clinic end generated code: output=f726f2c193c17a4f input=983ce7cb4a565980]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006040{
Antoine Pitrou84869872012-08-04 16:16:35 +02006041 int cpu, ncpus, count;
6042 size_t setsize;
6043 cpu_set_t *mask = NULL;
6044 PyObject *res = NULL;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006045
Antoine Pitrou84869872012-08-04 16:16:35 +02006046 ncpus = NCPUS_START;
6047 while (1) {
6048 setsize = CPU_ALLOC_SIZE(ncpus);
6049 mask = CPU_ALLOC(ncpus);
6050 if (mask == NULL)
6051 return PyErr_NoMemory();
6052 if (sched_getaffinity(pid, setsize, mask) == 0)
6053 break;
6054 CPU_FREE(mask);
6055 if (errno != EINVAL)
6056 return posix_error();
6057 if (ncpus > INT_MAX / 2) {
6058 PyErr_SetString(PyExc_OverflowError, "could not allocate "
6059 "a large enough CPU set");
6060 return NULL;
6061 }
6062 ncpus = ncpus * 2;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006063 }
Antoine Pitrou84869872012-08-04 16:16:35 +02006064
6065 res = PySet_New(NULL);
6066 if (res == NULL)
6067 goto error;
6068 for (cpu = 0, count = CPU_COUNT_S(setsize, mask); count; cpu++) {
6069 if (CPU_ISSET_S(cpu, setsize, mask)) {
6070 PyObject *cpu_num = PyLong_FromLong(cpu);
6071 --count;
6072 if (cpu_num == NULL)
6073 goto error;
6074 if (PySet_Add(res, cpu_num)) {
6075 Py_DECREF(cpu_num);
6076 goto error;
6077 }
6078 Py_DECREF(cpu_num);
6079 }
6080 }
6081 CPU_FREE(mask);
6082 return res;
6083
6084error:
6085 if (mask)
6086 CPU_FREE(mask);
6087 Py_XDECREF(res);
6088 return NULL;
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006089}
6090
Benjamin Peterson2740af82011-08-02 17:41:34 -05006091#endif /* HAVE_SCHED_SETAFFINITY */
6092
Benjamin Peterson94b580d2011-08-02 17:30:04 -05006093#endif /* HAVE_SCHED_H */
6094
Larry Hastings2f936352014-08-05 14:04:04 +10006095
Neal Norwitzb59798b2003-03-21 01:43:31 +00006096/* AIX uses /dev/ptc but is otherwise the same as /dev/ptmx */
Neal Norwitz2deaddb2003-03-21 03:08:31 +00006097/* IRIX has both /dev/ptc and /dev/ptmx, use ptmx */
6098#if defined(HAVE_DEV_PTC) && !defined(HAVE_DEV_PTMX)
Neal Norwitzb59798b2003-03-21 01:43:31 +00006099#define DEV_PTY_FILE "/dev/ptc"
6100#define HAVE_DEV_PTMX
6101#else
6102#define DEV_PTY_FILE "/dev/ptmx"
6103#endif
6104
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006105#if defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) || defined(HAVE_DEV_PTMX)
Fred Drake8cef4cf2000-06-28 16:40:38 +00006106#ifdef HAVE_PTY_H
6107#include <pty.h>
6108#else
6109#ifdef HAVE_LIBUTIL_H
6110#include <libutil.h>
Ronald Oussoren755740f2010-02-07 19:56:39 +00006111#else
6112#ifdef HAVE_UTIL_H
6113#include <util.h>
6114#endif /* HAVE_UTIL_H */
Fred Drake8cef4cf2000-06-28 16:40:38 +00006115#endif /* HAVE_LIBUTIL_H */
6116#endif /* HAVE_PTY_H */
Martin v. Löwis14e73b12003-01-01 09:51:12 +00006117#ifdef HAVE_STROPTS_H
6118#include <stropts.h>
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006119#endif
Miss Islington (bot)f0616ce2018-02-14 13:06:46 -08006120#endif /* defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) || defined(HAVE_DEV_PTMX) */
Fred Drake8cef4cf2000-06-28 16:40:38 +00006121
Larry Hastings2f936352014-08-05 14:04:04 +10006122
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006123#if defined(HAVE_OPENPTY) || defined(HAVE__GETPTY) || defined(HAVE_DEV_PTMX)
Larry Hastings2f936352014-08-05 14:04:04 +10006124/*[clinic input]
6125os.openpty
6126
6127Open a pseudo-terminal.
6128
6129Return a tuple of (master_fd, slave_fd) containing open file descriptors
6130for both the master and slave ends.
6131[clinic start generated code]*/
6132
Larry Hastings2f936352014-08-05 14:04:04 +10006133static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006134os_openpty_impl(PyObject *module)
6135/*[clinic end generated code: output=98841ce5ec9cef3c input=f3d99fd99e762907]*/
Fred Drake8cef4cf2000-06-28 16:40:38 +00006136{
Victor Stinnerdaf45552013-08-28 00:53:59 +02006137 int master_fd = -1, slave_fd = -1;
Thomas Wouters70c21a12000-07-14 14:28:33 +00006138#ifndef HAVE_OPENPTY
Victor Stinner8c62be82010-05-06 00:08:46 +00006139 char * slave_name;
Thomas Wouters70c21a12000-07-14 14:28:33 +00006140#endif
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006141#if defined(HAVE_DEV_PTMX) && !defined(HAVE_OPENPTY) && !defined(HAVE__GETPTY)
Victor Stinner8c62be82010-05-06 00:08:46 +00006142 PyOS_sighandler_t sig_saved;
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006143#ifdef sun
Victor Stinner8c62be82010-05-06 00:08:46 +00006144 extern char *ptsname(int fildes);
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006145#endif
6146#endif
Thomas Wouters70c21a12000-07-14 14:28:33 +00006147
Thomas Wouters70c21a12000-07-14 14:28:33 +00006148#ifdef HAVE_OPENPTY
Victor Stinner8c62be82010-05-06 00:08:46 +00006149 if (openpty(&master_fd, &slave_fd, NULL, NULL, NULL) != 0)
Victor Stinnerdaf45552013-08-28 00:53:59 +02006150 goto posix_error;
6151
6152 if (_Py_set_inheritable(master_fd, 0, NULL) < 0)
6153 goto error;
6154 if (_Py_set_inheritable(slave_fd, 0, NULL) < 0)
6155 goto error;
6156
Neal Norwitzb59798b2003-03-21 01:43:31 +00006157#elif defined(HAVE__GETPTY)
Victor Stinner8c62be82010-05-06 00:08:46 +00006158 slave_name = _getpty(&master_fd, O_RDWR, 0666, 0);
6159 if (slave_name == NULL)
Victor Stinnerdaf45552013-08-28 00:53:59 +02006160 goto posix_error;
6161 if (_Py_set_inheritable(master_fd, 0, NULL) < 0)
6162 goto error;
Thomas Wouters70c21a12000-07-14 14:28:33 +00006163
Victor Stinnerdaf45552013-08-28 00:53:59 +02006164 slave_fd = _Py_open(slave_name, O_RDWR);
Victor Stinner8c62be82010-05-06 00:08:46 +00006165 if (slave_fd < 0)
Victor Stinnera555cfc2015-03-18 00:22:14 +01006166 goto error;
Victor Stinnerdaf45552013-08-28 00:53:59 +02006167
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006168#else
Victor Stinner000de532013-11-25 23:19:58 +01006169 master_fd = open(DEV_PTY_FILE, O_RDWR | O_NOCTTY); /* open master */
Victor Stinner8c62be82010-05-06 00:08:46 +00006170 if (master_fd < 0)
Victor Stinnerdaf45552013-08-28 00:53:59 +02006171 goto posix_error;
6172
Victor Stinner8c62be82010-05-06 00:08:46 +00006173 sig_saved = PyOS_setsig(SIGCHLD, SIG_DFL);
Victor Stinnerdaf45552013-08-28 00:53:59 +02006174
Victor Stinner8c62be82010-05-06 00:08:46 +00006175 /* change permission of slave */
6176 if (grantpt(master_fd) < 0) {
6177 PyOS_setsig(SIGCHLD, sig_saved);
Victor Stinnerdaf45552013-08-28 00:53:59 +02006178 goto posix_error;
Victor Stinner8c62be82010-05-06 00:08:46 +00006179 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02006180
Victor Stinner8c62be82010-05-06 00:08:46 +00006181 /* unlock slave */
6182 if (unlockpt(master_fd) < 0) {
6183 PyOS_setsig(SIGCHLD, sig_saved);
Victor Stinnerdaf45552013-08-28 00:53:59 +02006184 goto posix_error;
Victor Stinner8c62be82010-05-06 00:08:46 +00006185 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02006186
Victor Stinner8c62be82010-05-06 00:08:46 +00006187 PyOS_setsig(SIGCHLD, sig_saved);
Victor Stinnerdaf45552013-08-28 00:53:59 +02006188
Victor Stinner8c62be82010-05-06 00:08:46 +00006189 slave_name = ptsname(master_fd); /* get name of slave */
6190 if (slave_name == NULL)
Victor Stinnerdaf45552013-08-28 00:53:59 +02006191 goto posix_error;
6192
6193 slave_fd = _Py_open(slave_name, O_RDWR | O_NOCTTY); /* open slave */
Victor Stinnera555cfc2015-03-18 00:22:14 +01006194 if (slave_fd == -1)
6195 goto error;
Victor Stinner000de532013-11-25 23:19:58 +01006196
6197 if (_Py_set_inheritable(master_fd, 0, NULL) < 0)
6198 goto posix_error;
6199
Stefan Krahfb7c8ae2016-04-26 17:04:18 +02006200#if !defined(__CYGWIN__) && !defined(__ANDROID__) && !defined(HAVE_DEV_PTC)
Victor Stinner8c62be82010-05-06 00:08:46 +00006201 ioctl(slave_fd, I_PUSH, "ptem"); /* push ptem */
6202 ioctl(slave_fd, I_PUSH, "ldterm"); /* push ldterm */
Neal Norwitz6700e472002-12-31 16:16:07 +00006203#ifndef __hpux
Victor Stinner8c62be82010-05-06 00:08:46 +00006204 ioctl(slave_fd, I_PUSH, "ttcompat"); /* push ttcompat */
Neal Norwitz6700e472002-12-31 16:16:07 +00006205#endif /* __hpux */
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006206#endif /* HAVE_CYGWIN */
Thomas Wouters1e0c2f42000-07-24 16:06:23 +00006207#endif /* HAVE_OPENPTY */
Thomas Wouters70c21a12000-07-14 14:28:33 +00006208
Victor Stinner8c62be82010-05-06 00:08:46 +00006209 return Py_BuildValue("(ii)", master_fd, slave_fd);
Thomas Wouters70c21a12000-07-14 14:28:33 +00006210
Victor Stinnerdaf45552013-08-28 00:53:59 +02006211posix_error:
6212 posix_error();
6213error:
6214 if (master_fd != -1)
6215 close(master_fd);
6216 if (slave_fd != -1)
6217 close(slave_fd);
6218 return NULL;
Fred Drake8cef4cf2000-06-28 16:40:38 +00006219}
Martin v. Löwis24a880b2002-12-31 12:55:15 +00006220#endif /* defined(HAVE_OPENPTY) || defined(HAVE__GETPTY) || defined(HAVE_DEV_PTMX) */
Fred Drake8cef4cf2000-06-28 16:40:38 +00006221
Larry Hastings2f936352014-08-05 14:04:04 +10006222
Fred Drake8cef4cf2000-06-28 16:40:38 +00006223#ifdef HAVE_FORKPTY
Larry Hastings2f936352014-08-05 14:04:04 +10006224/*[clinic input]
6225os.forkpty
6226
6227Fork a new process with a new pseudo-terminal as controlling tty.
6228
6229Returns a tuple of (pid, master_fd).
6230Like fork(), return pid of 0 to the child process,
6231and pid of child to the parent process.
6232To both, return fd of newly opened pseudo-terminal.
6233[clinic start generated code]*/
6234
Larry Hastings2f936352014-08-05 14:04:04 +10006235static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006236os_forkpty_impl(PyObject *module)
6237/*[clinic end generated code: output=60d0a5c7512e4087 input=f1f7f4bae3966010]*/
Fred Drake8cef4cf2000-06-28 16:40:38 +00006238{
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006239 int master_fd = -1;
Victor Stinner8c62be82010-05-06 00:08:46 +00006240 pid_t pid;
Tim Peters5aa91602002-01-30 05:46:57 +00006241
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006242 PyOS_BeforeFork();
Victor Stinner8c62be82010-05-06 00:08:46 +00006243 pid = forkpty(&master_fd, NULL, NULL, NULL);
6244 if (pid == 0) {
6245 /* child: this clobbers and resets the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006246 PyOS_AfterFork_Child();
Victor Stinner8c62be82010-05-06 00:08:46 +00006247 } else {
6248 /* parent: release the import lock. */
Antoine Pitrou346cbd32017-05-27 17:50:54 +02006249 PyOS_AfterFork_Parent();
Victor Stinner8c62be82010-05-06 00:08:46 +00006250 }
6251 if (pid == -1)
6252 return posix_error();
Victor Stinner8c62be82010-05-06 00:08:46 +00006253 return Py_BuildValue("(Ni)", PyLong_FromPid(pid), master_fd);
Fred Drake8cef4cf2000-06-28 16:40:38 +00006254}
Larry Hastings2f936352014-08-05 14:04:04 +10006255#endif /* HAVE_FORKPTY */
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006256
Ross Lagerwall7807c352011-03-17 20:20:30 +02006257
Guido van Rossumad0ee831995-03-01 10:34:45 +00006258#ifdef HAVE_GETEGID
Larry Hastings2f936352014-08-05 14:04:04 +10006259/*[clinic input]
6260os.getegid
6261
6262Return the current process's effective group id.
6263[clinic start generated code]*/
6264
Larry Hastings2f936352014-08-05 14:04:04 +10006265static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006266os_getegid_impl(PyObject *module)
6267/*[clinic end generated code: output=67d9be7ac68898a2 input=1596f79ad1107d5d]*/
Guido van Rossum46003ff1992-05-15 11:05:24 +00006268{
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006269 return _PyLong_FromGid(getegid());
Guido van Rossum46003ff1992-05-15 11:05:24 +00006270}
Larry Hastings2f936352014-08-05 14:04:04 +10006271#endif /* HAVE_GETEGID */
Guido van Rossum46003ff1992-05-15 11:05:24 +00006272
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006273
Guido van Rossumad0ee831995-03-01 10:34:45 +00006274#ifdef HAVE_GETEUID
Larry Hastings2f936352014-08-05 14:04:04 +10006275/*[clinic input]
6276os.geteuid
6277
6278Return the current process's effective user id.
6279[clinic start generated code]*/
6280
Larry Hastings2f936352014-08-05 14:04:04 +10006281static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006282os_geteuid_impl(PyObject *module)
6283/*[clinic end generated code: output=ea1b60f0d6abb66e input=4644c662d3bd9f19]*/
Guido van Rossum46003ff1992-05-15 11:05:24 +00006284{
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006285 return _PyLong_FromUid(geteuid());
Guido van Rossum46003ff1992-05-15 11:05:24 +00006286}
Larry Hastings2f936352014-08-05 14:04:04 +10006287#endif /* HAVE_GETEUID */
Guido van Rossum46003ff1992-05-15 11:05:24 +00006288
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006289
Guido van Rossumad0ee831995-03-01 10:34:45 +00006290#ifdef HAVE_GETGID
Larry Hastings2f936352014-08-05 14:04:04 +10006291/*[clinic input]
6292os.getgid
6293
6294Return the current process's group id.
6295[clinic start generated code]*/
6296
Larry Hastings2f936352014-08-05 14:04:04 +10006297static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006298os_getgid_impl(PyObject *module)
6299/*[clinic end generated code: output=4f28ebc9d3e5dfcf input=58796344cd87c0f6]*/
Guido van Rossum46003ff1992-05-15 11:05:24 +00006300{
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006301 return _PyLong_FromGid(getgid());
Guido van Rossum46003ff1992-05-15 11:05:24 +00006302}
Larry Hastings2f936352014-08-05 14:04:04 +10006303#endif /* HAVE_GETGID */
Guido van Rossum46003ff1992-05-15 11:05:24 +00006304
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006305
Berker Peksag39404992016-09-15 20:45:16 +03006306#ifdef HAVE_GETPID
Larry Hastings2f936352014-08-05 14:04:04 +10006307/*[clinic input]
6308os.getpid
6309
6310Return the current process id.
6311[clinic start generated code]*/
6312
Larry Hastings2f936352014-08-05 14:04:04 +10006313static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006314os_getpid_impl(PyObject *module)
6315/*[clinic end generated code: output=9ea6fdac01ed2b3c input=5a9a00f0ab68aa00]*/
Guido van Rossum85e3b011991-06-03 12:42:10 +00006316{
Victor Stinner8c62be82010-05-06 00:08:46 +00006317 return PyLong_FromPid(getpid());
Guido van Rossum85e3b011991-06-03 12:42:10 +00006318}
Berker Peksag39404992016-09-15 20:45:16 +03006319#endif /* HAVE_GETPID */
Guido van Rossum85e3b011991-06-03 12:42:10 +00006320
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006321#ifdef HAVE_GETGROUPLIST
Larry Hastings2f936352014-08-05 14:04:04 +10006322
6323/* AC 3.5: funny apple logic below */
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006324PyDoc_STRVAR(posix_getgrouplist__doc__,
6325"getgrouplist(user, group) -> list of groups to which a user belongs\n\n\
6326Returns a list of groups to which a user belongs.\n\n\
6327 user: username to lookup\n\
6328 group: base group id of the user");
6329
6330static PyObject *
6331posix_getgrouplist(PyObject *self, PyObject *args)
6332{
6333#ifdef NGROUPS_MAX
6334#define MAX_GROUPS NGROUPS_MAX
6335#else
6336 /* defined to be 16 on Solaris7, so this should be a small number */
6337#define MAX_GROUPS 64
6338#endif
6339
6340 const char *user;
6341 int i, ngroups;
6342 PyObject *list;
6343#ifdef __APPLE__
6344 int *groups, basegid;
6345#else
6346 gid_t *groups, basegid;
6347#endif
6348 ngroups = MAX_GROUPS;
6349
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006350#ifdef __APPLE__
6351 if (!PyArg_ParseTuple(args, "si:getgrouplist", &user, &basegid))
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006352 return NULL;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006353#else
6354 if (!PyArg_ParseTuple(args, "sO&:getgrouplist", &user,
6355 _Py_Gid_Converter, &basegid))
6356 return NULL;
6357#endif
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006358
6359#ifdef __APPLE__
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02006360 groups = PyMem_New(int, ngroups);
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006361#else
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02006362 groups = PyMem_New(gid_t, ngroups);
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006363#endif
6364 if (groups == NULL)
6365 return PyErr_NoMemory();
6366
6367 if (getgrouplist(user, basegid, groups, &ngroups) == -1) {
6368 PyMem_Del(groups);
6369 return posix_error();
6370 }
6371
6372 list = PyList_New(ngroups);
6373 if (list == NULL) {
6374 PyMem_Del(groups);
6375 return NULL;
6376 }
6377
6378 for (i = 0; i < ngroups; i++) {
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006379#ifdef __APPLE__
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006380 PyObject *o = PyLong_FromUnsignedLong((unsigned long)groups[i]);
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006381#else
6382 PyObject *o = _PyLong_FromGid(groups[i]);
6383#endif
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +02006384 if (o == NULL) {
6385 Py_DECREF(list);
6386 PyMem_Del(groups);
6387 return NULL;
6388 }
6389 PyList_SET_ITEM(list, i, o);
6390 }
6391
6392 PyMem_Del(groups);
6393
6394 return list;
6395}
Larry Hastings2f936352014-08-05 14:04:04 +10006396#endif /* HAVE_GETGROUPLIST */
6397
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006398
Fred Drakec9680921999-12-13 16:37:25 +00006399#ifdef HAVE_GETGROUPS
Larry Hastings2f936352014-08-05 14:04:04 +10006400/*[clinic input]
6401os.getgroups
6402
6403Return list of supplemental group IDs for the process.
6404[clinic start generated code]*/
6405
Larry Hastings2f936352014-08-05 14:04:04 +10006406static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006407os_getgroups_impl(PyObject *module)
6408/*[clinic end generated code: output=42b0c17758561b56 input=d3f109412e6a155c]*/
Fred Drakec9680921999-12-13 16:37:25 +00006409{
6410 PyObject *result = NULL;
6411
Fred Drakec9680921999-12-13 16:37:25 +00006412#ifdef NGROUPS_MAX
6413#define MAX_GROUPS NGROUPS_MAX
6414#else
Victor Stinner8c62be82010-05-06 00:08:46 +00006415 /* defined to be 16 on Solaris7, so this should be a small number */
Fred Drakec9680921999-12-13 16:37:25 +00006416#define MAX_GROUPS 64
6417#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00006418 gid_t grouplist[MAX_GROUPS];
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00006419
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00006420 /* On MacOSX getgroups(2) can return more than MAX_GROUPS results
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00006421 * This is a helper variable to store the intermediate result when
6422 * that happens.
6423 *
6424 * To keep the code readable the OSX behaviour is unconditional,
6425 * according to the POSIX spec this should be safe on all unix-y
6426 * systems.
6427 */
6428 gid_t* alt_grouplist = grouplist;
Victor Stinner8c62be82010-05-06 00:08:46 +00006429 int n;
Fred Drakec9680921999-12-13 16:37:25 +00006430
Ned Deilyb5dd6d22013-08-01 21:21:15 -07006431#ifdef __APPLE__
6432 /* Issue #17557: As of OS X 10.8, getgroups(2) no longer raises EINVAL if
6433 * there are more groups than can fit in grouplist. Therefore, on OS X
6434 * always first call getgroups with length 0 to get the actual number
6435 * of groups.
6436 */
6437 n = getgroups(0, NULL);
6438 if (n < 0) {
6439 return posix_error();
6440 } else if (n <= MAX_GROUPS) {
6441 /* groups will fit in existing array */
6442 alt_grouplist = grouplist;
6443 } else {
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02006444 alt_grouplist = PyMem_New(gid_t, n);
Ned Deilyb5dd6d22013-08-01 21:21:15 -07006445 if (alt_grouplist == NULL) {
6446 errno = EINVAL;
6447 return posix_error();
6448 }
6449 }
6450
6451 n = getgroups(n, alt_grouplist);
6452 if (n == -1) {
6453 if (alt_grouplist != grouplist) {
6454 PyMem_Free(alt_grouplist);
6455 }
6456 return posix_error();
6457 }
6458#else
Victor Stinner8c62be82010-05-06 00:08:46 +00006459 n = getgroups(MAX_GROUPS, grouplist);
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00006460 if (n < 0) {
6461 if (errno == EINVAL) {
6462 n = getgroups(0, NULL);
6463 if (n == -1) {
6464 return posix_error();
6465 }
6466 if (n == 0) {
6467 /* Avoid malloc(0) */
6468 alt_grouplist = grouplist;
6469 } else {
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02006470 alt_grouplist = PyMem_New(gid_t, n);
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00006471 if (alt_grouplist == NULL) {
6472 errno = EINVAL;
6473 return posix_error();
6474 }
6475 n = getgroups(n, alt_grouplist);
6476 if (n == -1) {
6477 PyMem_Free(alt_grouplist);
6478 return posix_error();
6479 }
6480 }
6481 } else {
6482 return posix_error();
6483 }
6484 }
Ned Deilyb5dd6d22013-08-01 21:21:15 -07006485#endif
6486
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00006487 result = PyList_New(n);
6488 if (result != NULL) {
Victor Stinner8c62be82010-05-06 00:08:46 +00006489 int i;
6490 for (i = 0; i < n; ++i) {
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006491 PyObject *o = _PyLong_FromGid(alt_grouplist[i]);
Victor Stinner8c62be82010-05-06 00:08:46 +00006492 if (o == NULL) {
Stefan Krah0e803b32010-11-26 16:16:47 +00006493 Py_DECREF(result);
6494 result = NULL;
6495 break;
Fred Drakec9680921999-12-13 16:37:25 +00006496 }
Victor Stinner8c62be82010-05-06 00:08:46 +00006497 PyList_SET_ITEM(result, i, o);
Fred Drakec9680921999-12-13 16:37:25 +00006498 }
Ronald Oussorenb6ee4f52010-07-23 13:53:51 +00006499 }
6500
6501 if (alt_grouplist != grouplist) {
6502 PyMem_Free(alt_grouplist);
Victor Stinner8c62be82010-05-06 00:08:46 +00006503 }
Neal Norwitze241ce82003-02-17 18:17:05 +00006504
Fred Drakec9680921999-12-13 16:37:25 +00006505 return result;
6506}
Larry Hastings2f936352014-08-05 14:04:04 +10006507#endif /* HAVE_GETGROUPS */
Fred Drakec9680921999-12-13 16:37:25 +00006508
Antoine Pitroub7572f02009-12-02 20:46:48 +00006509#ifdef HAVE_INITGROUPS
6510PyDoc_STRVAR(posix_initgroups__doc__,
6511"initgroups(username, gid) -> None\n\n\
6512Call the system initgroups() to initialize the group access list with all of\n\
6513the groups of which the specified username is a member, plus the specified\n\
6514group id.");
6515
Larry Hastings2f936352014-08-05 14:04:04 +10006516/* AC 3.5: funny apple logic */
Antoine Pitroub7572f02009-12-02 20:46:48 +00006517static PyObject *
6518posix_initgroups(PyObject *self, PyObject *args)
6519{
Victor Stinner61ec5dc2010-08-15 09:22:44 +00006520 PyObject *oname;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03006521 const char *username;
Victor Stinner61ec5dc2010-08-15 09:22:44 +00006522 int res;
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006523#ifdef __APPLE__
6524 int gid;
6525#else
6526 gid_t gid;
6527#endif
Antoine Pitroub7572f02009-12-02 20:46:48 +00006528
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006529#ifdef __APPLE__
6530 if (!PyArg_ParseTuple(args, "O&i:initgroups",
6531 PyUnicode_FSConverter, &oname,
6532 &gid))
6533#else
6534 if (!PyArg_ParseTuple(args, "O&O&:initgroups",
6535 PyUnicode_FSConverter, &oname,
6536 _Py_Gid_Converter, &gid))
6537#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00006538 return NULL;
Victor Stinner61ec5dc2010-08-15 09:22:44 +00006539 username = PyBytes_AS_STRING(oname);
Antoine Pitroub7572f02009-12-02 20:46:48 +00006540
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006541 res = initgroups(username, gid);
Victor Stinner61ec5dc2010-08-15 09:22:44 +00006542 Py_DECREF(oname);
6543 if (res == -1)
Victor Stinner8c62be82010-05-06 00:08:46 +00006544 return PyErr_SetFromErrno(PyExc_OSError);
Antoine Pitroub7572f02009-12-02 20:46:48 +00006545
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02006546 Py_RETURN_NONE;
Antoine Pitroub7572f02009-12-02 20:46:48 +00006547}
Larry Hastings2f936352014-08-05 14:04:04 +10006548#endif /* HAVE_INITGROUPS */
6549
Antoine Pitroub7572f02009-12-02 20:46:48 +00006550
Martin v. Löwis606edc12002-06-13 21:09:11 +00006551#ifdef HAVE_GETPGID
Larry Hastings2f936352014-08-05 14:04:04 +10006552/*[clinic input]
6553os.getpgid
6554
6555 pid: pid_t
6556
6557Call the system call getpgid(), and return the result.
6558[clinic start generated code]*/
6559
Larry Hastings2f936352014-08-05 14:04:04 +10006560static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006561os_getpgid_impl(PyObject *module, pid_t pid)
6562/*[clinic end generated code: output=1db95a97be205d18 input=39d710ae3baaf1c7]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006563{
6564 pid_t pgid = getpgid(pid);
Victor Stinner8c62be82010-05-06 00:08:46 +00006565 if (pgid < 0)
6566 return posix_error();
6567 return PyLong_FromPid(pgid);
Martin v. Löwis606edc12002-06-13 21:09:11 +00006568}
6569#endif /* HAVE_GETPGID */
6570
6571
Guido van Rossumb6775db1994-08-01 11:34:53 +00006572#ifdef HAVE_GETPGRP
Larry Hastings2f936352014-08-05 14:04:04 +10006573/*[clinic input]
6574os.getpgrp
6575
6576Return the current process group id.
6577[clinic start generated code]*/
6578
Larry Hastings2f936352014-08-05 14:04:04 +10006579static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006580os_getpgrp_impl(PyObject *module)
6581/*[clinic end generated code: output=c4fc381e51103cf3 input=6846fb2bb9a3705e]*/
Guido van Rossum04814471991-06-04 20:23:49 +00006582{
Guido van Rossumb6775db1994-08-01 11:34:53 +00006583#ifdef GETPGRP_HAVE_ARG
Victor Stinner8c62be82010-05-06 00:08:46 +00006584 return PyLong_FromPid(getpgrp(0));
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00006585#else /* GETPGRP_HAVE_ARG */
Victor Stinner8c62be82010-05-06 00:08:46 +00006586 return PyLong_FromPid(getpgrp());
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00006587#endif /* GETPGRP_HAVE_ARG */
Guido van Rossum04814471991-06-04 20:23:49 +00006588}
Guido van Rossumb6775db1994-08-01 11:34:53 +00006589#endif /* HAVE_GETPGRP */
Guido van Rossum04814471991-06-04 20:23:49 +00006590
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006591
Guido van Rossumb6775db1994-08-01 11:34:53 +00006592#ifdef HAVE_SETPGRP
Larry Hastings2f936352014-08-05 14:04:04 +10006593/*[clinic input]
6594os.setpgrp
6595
6596Make the current process the leader of its process group.
6597[clinic start generated code]*/
6598
Larry Hastings2f936352014-08-05 14:04:04 +10006599static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006600os_setpgrp_impl(PyObject *module)
6601/*[clinic end generated code: output=2554735b0a60f0a0 input=1f0619fcb5731e7e]*/
Guido van Rossumc2670a01992-09-13 20:07:29 +00006602{
Guido van Rossum64933891994-10-20 21:56:42 +00006603#ifdef SETPGRP_HAVE_ARG
Victor Stinner8c62be82010-05-06 00:08:46 +00006604 if (setpgrp(0, 0) < 0)
Guido van Rossum64933891994-10-20 21:56:42 +00006605#else /* SETPGRP_HAVE_ARG */
Victor Stinner8c62be82010-05-06 00:08:46 +00006606 if (setpgrp() < 0)
Guido van Rossum64933891994-10-20 21:56:42 +00006607#endif /* SETPGRP_HAVE_ARG */
Victor Stinner8c62be82010-05-06 00:08:46 +00006608 return posix_error();
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02006609 Py_RETURN_NONE;
Guido van Rossumc2670a01992-09-13 20:07:29 +00006610}
Guido van Rossumb6775db1994-08-01 11:34:53 +00006611#endif /* HAVE_SETPGRP */
6612
Guido van Rossumad0ee831995-03-01 10:34:45 +00006613#ifdef HAVE_GETPPID
Amaury Forgeot d'Arc4b6fdf32010-09-07 21:31:17 +00006614
6615#ifdef MS_WINDOWS
6616#include <tlhelp32.h>
6617
6618static PyObject*
6619win32_getppid()
6620{
6621 HANDLE snapshot;
6622 pid_t mypid;
6623 PyObject* result = NULL;
6624 BOOL have_record;
6625 PROCESSENTRY32 pe;
6626
6627 mypid = getpid(); /* This function never fails */
6628
6629 snapshot = CreateToolhelp32Snapshot(TH32CS_SNAPPROCESS, 0);
6630 if (snapshot == INVALID_HANDLE_VALUE)
6631 return PyErr_SetFromWindowsErr(GetLastError());
6632
6633 pe.dwSize = sizeof(pe);
6634 have_record = Process32First(snapshot, &pe);
6635 while (have_record) {
6636 if (mypid == (pid_t)pe.th32ProcessID) {
6637 /* We could cache the ulong value in a static variable. */
6638 result = PyLong_FromPid((pid_t)pe.th32ParentProcessID);
6639 break;
6640 }
6641
6642 have_record = Process32Next(snapshot, &pe);
6643 }
6644
6645 /* If our loop exits and our pid was not found (result will be NULL)
6646 * then GetLastError will return ERROR_NO_MORE_FILES. This is an
6647 * error anyway, so let's raise it. */
6648 if (!result)
6649 result = PyErr_SetFromWindowsErr(GetLastError());
6650
6651 CloseHandle(snapshot);
6652
6653 return result;
6654}
6655#endif /*MS_WINDOWS*/
6656
Larry Hastings2f936352014-08-05 14:04:04 +10006657
6658/*[clinic input]
6659os.getppid
6660
6661Return the parent's process id.
6662
6663If the parent process has already exited, Windows machines will still
6664return its id; others systems will return the id of the 'init' process (1).
6665[clinic start generated code]*/
6666
Larry Hastings2f936352014-08-05 14:04:04 +10006667static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006668os_getppid_impl(PyObject *module)
6669/*[clinic end generated code: output=43b2a946a8c603b4 input=e637cb87539c030e]*/
Guido van Rossum85e3b011991-06-03 12:42:10 +00006670{
Amaury Forgeot d'Arc4b6fdf32010-09-07 21:31:17 +00006671#ifdef MS_WINDOWS
6672 return win32_getppid();
6673#else
Victor Stinner8c62be82010-05-06 00:08:46 +00006674 return PyLong_FromPid(getppid());
Guido van Rossumad0ee831995-03-01 10:34:45 +00006675#endif
Amaury Forgeot d'Arc4b6fdf32010-09-07 21:31:17 +00006676}
6677#endif /* HAVE_GETPPID */
Guido van Rossum85e3b011991-06-03 12:42:10 +00006678
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006679
Fred Drake12c6e2d1999-12-14 21:25:03 +00006680#ifdef HAVE_GETLOGIN
Larry Hastings2f936352014-08-05 14:04:04 +10006681/*[clinic input]
6682os.getlogin
6683
6684Return the actual login name.
6685[clinic start generated code]*/
6686
Larry Hastings2f936352014-08-05 14:04:04 +10006687static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006688os_getlogin_impl(PyObject *module)
6689/*[clinic end generated code: output=a32e66a7e5715dac input=2a21ab1e917163df]*/
Fred Drake12c6e2d1999-12-14 21:25:03 +00006690{
Victor Stinner8c62be82010-05-06 00:08:46 +00006691 PyObject *result = NULL;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00006692#ifdef MS_WINDOWS
Brian Curtine8e4b3b2010-09-23 20:04:14 +00006693 wchar_t user_name[UNLEN + 1];
Victor Stinner63941882011-09-29 00:42:28 +02006694 DWORD num_chars = Py_ARRAY_LENGTH(user_name);
Brian Curtine8e4b3b2010-09-23 20:04:14 +00006695
6696 if (GetUserNameW(user_name, &num_chars)) {
6697 /* num_chars is the number of unicode chars plus null terminator */
6698 result = PyUnicode_FromWideChar(user_name, num_chars - 1);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00006699 }
6700 else
Brian Curtine8e4b3b2010-09-23 20:04:14 +00006701 result = PyErr_SetFromWindowsErr(GetLastError());
6702#else
Victor Stinner8c62be82010-05-06 00:08:46 +00006703 char *name;
6704 int old_errno = errno;
Fred Drake12c6e2d1999-12-14 21:25:03 +00006705
Victor Stinner8c62be82010-05-06 00:08:46 +00006706 errno = 0;
6707 name = getlogin();
6708 if (name == NULL) {
6709 if (errno)
Victor Stinnere039ffe2010-08-15 09:33:08 +00006710 posix_error();
Fred Drake12c6e2d1999-12-14 21:25:03 +00006711 else
Victor Stinnere039ffe2010-08-15 09:33:08 +00006712 PyErr_SetString(PyExc_OSError, "unable to determine login name");
Victor Stinner8c62be82010-05-06 00:08:46 +00006713 }
6714 else
Victor Stinnere039ffe2010-08-15 09:33:08 +00006715 result = PyUnicode_DecodeFSDefault(name);
Victor Stinner8c62be82010-05-06 00:08:46 +00006716 errno = old_errno;
Brian Curtine8e4b3b2010-09-23 20:04:14 +00006717#endif
Fred Drake12c6e2d1999-12-14 21:25:03 +00006718 return result;
6719}
Brian Curtine8e4b3b2010-09-23 20:04:14 +00006720#endif /* HAVE_GETLOGIN */
Fred Drake12c6e2d1999-12-14 21:25:03 +00006721
Larry Hastings2f936352014-08-05 14:04:04 +10006722
Guido van Rossumad0ee831995-03-01 10:34:45 +00006723#ifdef HAVE_GETUID
Larry Hastings2f936352014-08-05 14:04:04 +10006724/*[clinic input]
6725os.getuid
6726
6727Return the current process's user id.
6728[clinic start generated code]*/
6729
Larry Hastings2f936352014-08-05 14:04:04 +10006730static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006731os_getuid_impl(PyObject *module)
6732/*[clinic end generated code: output=415c0b401ebed11a input=b53c8b35f110a516]*/
Guido van Rossum46003ff1992-05-15 11:05:24 +00006733{
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02006734 return _PyLong_FromUid(getuid());
Guido van Rossum46003ff1992-05-15 11:05:24 +00006735}
Larry Hastings2f936352014-08-05 14:04:04 +10006736#endif /* HAVE_GETUID */
Guido van Rossum46003ff1992-05-15 11:05:24 +00006737
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006738
Brian Curtineb24d742010-04-12 17:16:38 +00006739#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10006740#define HAVE_KILL
6741#endif /* MS_WINDOWS */
6742
6743#ifdef HAVE_KILL
6744/*[clinic input]
6745os.kill
6746
6747 pid: pid_t
6748 signal: Py_ssize_t
6749 /
6750
6751Kill a process with a signal.
6752[clinic start generated code]*/
6753
Larry Hastings2f936352014-08-05 14:04:04 +10006754static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006755os_kill_impl(PyObject *module, pid_t pid, Py_ssize_t signal)
6756/*[clinic end generated code: output=8e346a6701c88568 input=61a36b86ca275ab9]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006757#ifndef MS_WINDOWS
6758{
6759 if (kill(pid, (int)signal) == -1)
6760 return posix_error();
6761 Py_RETURN_NONE;
6762}
6763#else /* !MS_WINDOWS */
Brian Curtineb24d742010-04-12 17:16:38 +00006764{
Amaury Forgeot d'Arc0a589c92010-05-15 20:35:12 +00006765 PyObject *result;
Larry Hastings2f936352014-08-05 14:04:04 +10006766 DWORD sig = (DWORD)signal;
6767 DWORD err;
Victor Stinner8c62be82010-05-06 00:08:46 +00006768 HANDLE handle;
Brian Curtineb24d742010-04-12 17:16:38 +00006769
Victor Stinner8c62be82010-05-06 00:08:46 +00006770 /* Console processes which share a common console can be sent CTRL+C or
6771 CTRL+BREAK events, provided they handle said events. */
6772 if (sig == CTRL_C_EVENT || sig == CTRL_BREAK_EVENT) {
Richard Oudkerkac0ad882013-06-05 23:29:30 +01006773 if (GenerateConsoleCtrlEvent(sig, (DWORD)pid) == 0) {
Victor Stinner8c62be82010-05-06 00:08:46 +00006774 err = GetLastError();
6775 PyErr_SetFromWindowsErr(err);
6776 }
6777 else
6778 Py_RETURN_NONE;
6779 }
Brian Curtineb24d742010-04-12 17:16:38 +00006780
Victor Stinner8c62be82010-05-06 00:08:46 +00006781 /* If the signal is outside of what GenerateConsoleCtrlEvent can use,
6782 attempt to open and terminate the process. */
Richard Oudkerkac0ad882013-06-05 23:29:30 +01006783 handle = OpenProcess(PROCESS_ALL_ACCESS, FALSE, (DWORD)pid);
Victor Stinner8c62be82010-05-06 00:08:46 +00006784 if (handle == NULL) {
6785 err = GetLastError();
6786 return PyErr_SetFromWindowsErr(err);
6787 }
Brian Curtineb24d742010-04-12 17:16:38 +00006788
Victor Stinner8c62be82010-05-06 00:08:46 +00006789 if (TerminateProcess(handle, sig) == 0) {
6790 err = GetLastError();
6791 result = PyErr_SetFromWindowsErr(err);
6792 } else {
6793 Py_INCREF(Py_None);
6794 result = Py_None;
6795 }
Brian Curtineb24d742010-04-12 17:16:38 +00006796
Victor Stinner8c62be82010-05-06 00:08:46 +00006797 CloseHandle(handle);
6798 return result;
Brian Curtineb24d742010-04-12 17:16:38 +00006799}
Larry Hastings2f936352014-08-05 14:04:04 +10006800#endif /* !MS_WINDOWS */
6801#endif /* HAVE_KILL */
6802
6803
6804#ifdef HAVE_KILLPG
6805/*[clinic input]
6806os.killpg
6807
6808 pgid: pid_t
6809 signal: int
6810 /
6811
6812Kill a process group with a signal.
6813[clinic start generated code]*/
6814
Larry Hastings2f936352014-08-05 14:04:04 +10006815static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006816os_killpg_impl(PyObject *module, pid_t pgid, int signal)
6817/*[clinic end generated code: output=6dbcd2f1fdf5fdba input=38b5449eb8faec19]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006818{
6819 /* XXX some man pages make the `pgid` parameter an int, others
6820 a pid_t. Since getpgrp() returns a pid_t, we assume killpg should
6821 take the same type. Moreover, pid_t is always at least as wide as
6822 int (else compilation of this module fails), which is safe. */
6823 if (killpg(pgid, signal) == -1)
6824 return posix_error();
6825 Py_RETURN_NONE;
6826}
6827#endif /* HAVE_KILLPG */
6828
Brian Curtineb24d742010-04-12 17:16:38 +00006829
Guido van Rossumc0125471996-06-28 18:55:32 +00006830#ifdef HAVE_PLOCK
Guido van Rossumc0125471996-06-28 18:55:32 +00006831#ifdef HAVE_SYS_LOCK_H
6832#include <sys/lock.h>
6833#endif
6834
Larry Hastings2f936352014-08-05 14:04:04 +10006835/*[clinic input]
6836os.plock
6837 op: int
6838 /
6839
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00006840Lock program segments into memory.");
Larry Hastings2f936352014-08-05 14:04:04 +10006841[clinic start generated code]*/
6842
Larry Hastings2f936352014-08-05 14:04:04 +10006843static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006844os_plock_impl(PyObject *module, int op)
6845/*[clinic end generated code: output=81424167033b168e input=e6e5e348e1525f60]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006846{
Victor Stinner8c62be82010-05-06 00:08:46 +00006847 if (plock(op) == -1)
6848 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10006849 Py_RETURN_NONE;
Guido van Rossumc0125471996-06-28 18:55:32 +00006850}
Larry Hastings2f936352014-08-05 14:04:04 +10006851#endif /* HAVE_PLOCK */
6852
Guido van Rossumc0125471996-06-28 18:55:32 +00006853
Guido van Rossumb6775db1994-08-01 11:34:53 +00006854#ifdef HAVE_SETUID
Larry Hastings2f936352014-08-05 14:04:04 +10006855/*[clinic input]
6856os.setuid
6857
6858 uid: uid_t
6859 /
6860
6861Set the current process's user id.
6862[clinic start generated code]*/
6863
Larry Hastings2f936352014-08-05 14:04:04 +10006864static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006865os_setuid_impl(PyObject *module, uid_t uid)
6866/*[clinic end generated code: output=a0a41fd0d1ec555f input=c921a3285aa22256]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006867{
Victor Stinner8c62be82010-05-06 00:08:46 +00006868 if (setuid(uid) < 0)
6869 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10006870 Py_RETURN_NONE;
Guido van Rossuma3d78fb1993-11-10 09:23:53 +00006871}
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00006872#endif /* HAVE_SETUID */
Guido van Rossuma3d78fb1993-11-10 09:23:53 +00006873
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00006874
Andrew M. Kuchling8d2f2b2d2000-07-13 01:26:58 +00006875#ifdef HAVE_SETEUID
Larry Hastings2f936352014-08-05 14:04:04 +10006876/*[clinic input]
6877os.seteuid
6878
6879 euid: uid_t
6880 /
6881
6882Set the current process's effective user id.
6883[clinic start generated code]*/
6884
Larry Hastings2f936352014-08-05 14:04:04 +10006885static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006886os_seteuid_impl(PyObject *module, uid_t euid)
6887/*[clinic end generated code: output=102e3ad98361519a input=ba93d927e4781aa9]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006888{
6889 if (seteuid(euid) < 0)
Victor Stinner8c62be82010-05-06 00:08:46 +00006890 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10006891 Py_RETURN_NONE;
Andrew M. Kuchling8d2f2b2d2000-07-13 01:26:58 +00006892}
6893#endif /* HAVE_SETEUID */
6894
Larry Hastings2f936352014-08-05 14:04:04 +10006895
Andrew M. Kuchling8d2f2b2d2000-07-13 01:26:58 +00006896#ifdef HAVE_SETEGID
Larry Hastings2f936352014-08-05 14:04:04 +10006897/*[clinic input]
6898os.setegid
6899
6900 egid: gid_t
6901 /
6902
6903Set the current process's effective group id.
6904[clinic start generated code]*/
6905
Larry Hastings2f936352014-08-05 14:04:04 +10006906static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006907os_setegid_impl(PyObject *module, gid_t egid)
6908/*[clinic end generated code: output=4e4b825a6a10258d input=4080526d0ccd6ce3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006909{
6910 if (setegid(egid) < 0)
Victor Stinner8c62be82010-05-06 00:08:46 +00006911 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10006912 Py_RETURN_NONE;
Andrew M. Kuchling8d2f2b2d2000-07-13 01:26:58 +00006913}
6914#endif /* HAVE_SETEGID */
6915
Larry Hastings2f936352014-08-05 14:04:04 +10006916
Andrew M. Kuchling8d2f2b2d2000-07-13 01:26:58 +00006917#ifdef HAVE_SETREUID
Larry Hastings2f936352014-08-05 14:04:04 +10006918/*[clinic input]
6919os.setreuid
6920
6921 ruid: uid_t
6922 euid: uid_t
6923 /
6924
6925Set the current process's real and effective user ids.
6926[clinic start generated code]*/
6927
Larry Hastings2f936352014-08-05 14:04:04 +10006928static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006929os_setreuid_impl(PyObject *module, uid_t ruid, uid_t euid)
6930/*[clinic end generated code: output=62d991210006530a input=0ca8978de663880c]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006931{
Victor Stinner8c62be82010-05-06 00:08:46 +00006932 if (setreuid(ruid, euid) < 0) {
6933 return posix_error();
6934 } else {
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02006935 Py_RETURN_NONE;
Victor Stinner8c62be82010-05-06 00:08:46 +00006936 }
Andrew M. Kuchling8d2f2b2d2000-07-13 01:26:58 +00006937}
6938#endif /* HAVE_SETREUID */
6939
Larry Hastings2f936352014-08-05 14:04:04 +10006940
Andrew M. Kuchling8d2f2b2d2000-07-13 01:26:58 +00006941#ifdef HAVE_SETREGID
Larry Hastings2f936352014-08-05 14:04:04 +10006942/*[clinic input]
6943os.setregid
6944
6945 rgid: gid_t
6946 egid: gid_t
6947 /
6948
6949Set the current process's real and effective group ids.
6950[clinic start generated code]*/
6951
Larry Hastings2f936352014-08-05 14:04:04 +10006952static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006953os_setregid_impl(PyObject *module, gid_t rgid, gid_t egid)
6954/*[clinic end generated code: output=aa803835cf5342f3 input=c59499f72846db78]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006955{
6956 if (setregid(rgid, egid) < 0)
Victor Stinner8c62be82010-05-06 00:08:46 +00006957 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10006958 Py_RETURN_NONE;
Andrew M. Kuchling8d2f2b2d2000-07-13 01:26:58 +00006959}
6960#endif /* HAVE_SETREGID */
6961
Larry Hastings2f936352014-08-05 14:04:04 +10006962
Guido van Rossumb6775db1994-08-01 11:34:53 +00006963#ifdef HAVE_SETGID
Larry Hastings2f936352014-08-05 14:04:04 +10006964/*[clinic input]
6965os.setgid
6966 gid: gid_t
6967 /
6968
6969Set the current process's group id.
6970[clinic start generated code]*/
6971
Larry Hastings2f936352014-08-05 14:04:04 +10006972static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006973os_setgid_impl(PyObject *module, gid_t gid)
6974/*[clinic end generated code: output=bdccd7403f6ad8c3 input=27d30c4059045dc6]*/
Larry Hastings2f936352014-08-05 14:04:04 +10006975{
Victor Stinner8c62be82010-05-06 00:08:46 +00006976 if (setgid(gid) < 0)
6977 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10006978 Py_RETURN_NONE;
Guido van Rossuma3d78fb1993-11-10 09:23:53 +00006979}
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00006980#endif /* HAVE_SETGID */
Guido van Rossuma3d78fb1993-11-10 09:23:53 +00006981
Larry Hastings2f936352014-08-05 14:04:04 +10006982
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00006983#ifdef HAVE_SETGROUPS
Larry Hastings2f936352014-08-05 14:04:04 +10006984/*[clinic input]
6985os.setgroups
6986
6987 groups: object
6988 /
6989
6990Set the groups of the current process to list.
6991[clinic start generated code]*/
6992
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00006993static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03006994os_setgroups(PyObject *module, PyObject *groups)
6995/*[clinic end generated code: output=3fcb32aad58c5ecd input=fa742ca3daf85a7e]*/
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00006996{
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03006997 Py_ssize_t i, len;
Victor Stinner8c62be82010-05-06 00:08:46 +00006998 gid_t grouplist[MAX_GROUPS];
Tim Peters5aa91602002-01-30 05:46:57 +00006999
Victor Stinner8c62be82010-05-06 00:08:46 +00007000 if (!PySequence_Check(groups)) {
7001 PyErr_SetString(PyExc_TypeError, "setgroups argument must be a sequence");
7002 return NULL;
7003 }
7004 len = PySequence_Size(groups);
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03007005 if (len < 0) {
7006 return NULL;
7007 }
Victor Stinner8c62be82010-05-06 00:08:46 +00007008 if (len > MAX_GROUPS) {
7009 PyErr_SetString(PyExc_ValueError, "too many groups");
7010 return NULL;
7011 }
7012 for(i = 0; i < len; i++) {
7013 PyObject *elem;
7014 elem = PySequence_GetItem(groups, i);
7015 if (!elem)
7016 return NULL;
7017 if (!PyLong_Check(elem)) {
7018 PyErr_SetString(PyExc_TypeError,
7019 "groups must be integers");
7020 Py_DECREF(elem);
7021 return NULL;
7022 } else {
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02007023 if (!_Py_Gid_Converter(elem, &grouplist[i])) {
Victor Stinner8c62be82010-05-06 00:08:46 +00007024 Py_DECREF(elem);
7025 return NULL;
7026 }
7027 }
7028 Py_DECREF(elem);
7029 }
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00007030
Victor Stinner8c62be82010-05-06 00:08:46 +00007031 if (setgroups(len, grouplist) < 0)
7032 return posix_error();
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02007033 Py_RETURN_NONE;
Martin v. Löwis61c5edf2001-10-18 04:06:00 +00007034}
7035#endif /* HAVE_SETGROUPS */
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007036
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007037#if defined(HAVE_WAIT3) || defined(HAVE_WAIT4)
7038static PyObject *
Victor Stinner4195b5c2012-02-08 23:03:19 +01007039wait_helper(pid_t pid, int status, struct rusage *ru)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007040{
Victor Stinner8c62be82010-05-06 00:08:46 +00007041 PyObject *result;
7042 static PyObject *struct_rusage;
Martin v. Löwisbd928fe2011-10-14 10:20:37 +02007043 _Py_IDENTIFIER(struct_rusage);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007044
Victor Stinner8c62be82010-05-06 00:08:46 +00007045 if (pid == -1)
7046 return posix_error();
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007047
Victor Stinner8c62be82010-05-06 00:08:46 +00007048 if (struct_rusage == NULL) {
7049 PyObject *m = PyImport_ImportModuleNoBlock("resource");
7050 if (m == NULL)
7051 return NULL;
Martin v. Löwis1ee1b6f2011-10-10 18:11:30 +02007052 struct_rusage = _PyObject_GetAttrId(m, &PyId_struct_rusage);
Victor Stinner8c62be82010-05-06 00:08:46 +00007053 Py_DECREF(m);
7054 if (struct_rusage == NULL)
7055 return NULL;
7056 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007057
Victor Stinner8c62be82010-05-06 00:08:46 +00007058 /* XXX(nnorwitz): Copied (w/mods) from resource.c, there should be only one. */
7059 result = PyStructSequence_New((PyTypeObject*) struct_rusage);
7060 if (!result)
7061 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007062
7063#ifndef doubletime
7064#define doubletime(TV) ((double)(TV).tv_sec + (TV).tv_usec * 0.000001)
7065#endif
7066
Victor Stinner8c62be82010-05-06 00:08:46 +00007067 PyStructSequence_SET_ITEM(result, 0,
Victor Stinner4195b5c2012-02-08 23:03:19 +01007068 PyFloat_FromDouble(doubletime(ru->ru_utime)));
Victor Stinner8c62be82010-05-06 00:08:46 +00007069 PyStructSequence_SET_ITEM(result, 1,
Victor Stinner4195b5c2012-02-08 23:03:19 +01007070 PyFloat_FromDouble(doubletime(ru->ru_stime)));
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007071#define SET_INT(result, index, value)\
Victor Stinner8c62be82010-05-06 00:08:46 +00007072 PyStructSequence_SET_ITEM(result, index, PyLong_FromLong(value))
7073 SET_INT(result, 2, ru->ru_maxrss);
7074 SET_INT(result, 3, ru->ru_ixrss);
7075 SET_INT(result, 4, ru->ru_idrss);
7076 SET_INT(result, 5, ru->ru_isrss);
7077 SET_INT(result, 6, ru->ru_minflt);
7078 SET_INT(result, 7, ru->ru_majflt);
7079 SET_INT(result, 8, ru->ru_nswap);
7080 SET_INT(result, 9, ru->ru_inblock);
7081 SET_INT(result, 10, ru->ru_oublock);
7082 SET_INT(result, 11, ru->ru_msgsnd);
7083 SET_INT(result, 12, ru->ru_msgrcv);
7084 SET_INT(result, 13, ru->ru_nsignals);
7085 SET_INT(result, 14, ru->ru_nvcsw);
7086 SET_INT(result, 15, ru->ru_nivcsw);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007087#undef SET_INT
7088
Victor Stinner8c62be82010-05-06 00:08:46 +00007089 if (PyErr_Occurred()) {
7090 Py_DECREF(result);
7091 return NULL;
7092 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007093
Victor Stinner8c62be82010-05-06 00:08:46 +00007094 return Py_BuildValue("NiN", PyLong_FromPid(pid), status, result);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007095}
7096#endif /* HAVE_WAIT3 || HAVE_WAIT4 */
7097
Larry Hastings2f936352014-08-05 14:04:04 +10007098
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007099#ifdef HAVE_WAIT3
Larry Hastings2f936352014-08-05 14:04:04 +10007100/*[clinic input]
7101os.wait3
7102
7103 options: int
7104Wait for completion of a child process.
7105
7106Returns a tuple of information about the child process:
7107 (pid, status, rusage)
7108[clinic start generated code]*/
7109
Larry Hastings2f936352014-08-05 14:04:04 +10007110static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007111os_wait3_impl(PyObject *module, int options)
7112/*[clinic end generated code: output=92c3224e6f28217a input=8ac4c56956b61710]*/
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007113{
Victor Stinner8c62be82010-05-06 00:08:46 +00007114 pid_t pid;
Victor Stinner8c62be82010-05-06 00:08:46 +00007115 struct rusage ru;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007116 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00007117 WAIT_TYPE status;
7118 WAIT_STATUS_INT(status) = 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007119
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007120 do {
7121 Py_BEGIN_ALLOW_THREADS
7122 pid = wait3(&status, options, &ru);
7123 Py_END_ALLOW_THREADS
7124 } while (pid < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
7125 if (pid < 0)
7126 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007127
Victor Stinner4195b5c2012-02-08 23:03:19 +01007128 return wait_helper(pid, WAIT_STATUS_INT(status), &ru);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007129}
7130#endif /* HAVE_WAIT3 */
7131
Larry Hastings2f936352014-08-05 14:04:04 +10007132
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007133#ifdef HAVE_WAIT4
Larry Hastings2f936352014-08-05 14:04:04 +10007134/*[clinic input]
7135
7136os.wait4
7137
7138 pid: pid_t
7139 options: int
7140
7141Wait for completion of a specific child process.
7142
7143Returns a tuple of information about the child process:
7144 (pid, status, rusage)
7145[clinic start generated code]*/
7146
Larry Hastings2f936352014-08-05 14:04:04 +10007147static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007148os_wait4_impl(PyObject *module, pid_t pid, int options)
7149/*[clinic end generated code: output=66195aa507b35f70 input=d11deed0750600ba]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007150{
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007151 pid_t res;
Victor Stinner8c62be82010-05-06 00:08:46 +00007152 struct rusage ru;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007153 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00007154 WAIT_TYPE status;
7155 WAIT_STATUS_INT(status) = 0;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007156
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007157 do {
7158 Py_BEGIN_ALLOW_THREADS
7159 res = wait4(pid, &status, options, &ru);
7160 Py_END_ALLOW_THREADS
7161 } while (res < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
7162 if (res < 0)
7163 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007164
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007165 return wait_helper(res, WAIT_STATUS_INT(status), &ru);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007166}
7167#endif /* HAVE_WAIT4 */
7168
Larry Hastings2f936352014-08-05 14:04:04 +10007169
Ross Lagerwall7807c352011-03-17 20:20:30 +02007170#if defined(HAVE_WAITID) && !defined(__APPLE__)
Larry Hastings2f936352014-08-05 14:04:04 +10007171/*[clinic input]
7172os.waitid
7173
7174 idtype: idtype_t
7175 Must be one of be P_PID, P_PGID or P_ALL.
7176 id: id_t
7177 The id to wait on.
7178 options: int
7179 Constructed from the ORing of one or more of WEXITED, WSTOPPED
7180 or WCONTINUED and additionally may be ORed with WNOHANG or WNOWAIT.
7181 /
7182
7183Returns the result of waiting for a process or processes.
7184
7185Returns either waitid_result or None if WNOHANG is specified and there are
7186no children in a waitable state.
7187[clinic start generated code]*/
7188
Larry Hastings2f936352014-08-05 14:04:04 +10007189static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007190os_waitid_impl(PyObject *module, idtype_t idtype, id_t id, int options)
7191/*[clinic end generated code: output=5d2e1c0bde61f4d8 input=d8e7f76e052b7920]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007192{
7193 PyObject *result;
7194 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007195 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02007196 siginfo_t si;
7197 si.si_pid = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10007198
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007199 do {
7200 Py_BEGIN_ALLOW_THREADS
7201 res = waitid(idtype, id, &si, options);
7202 Py_END_ALLOW_THREADS
7203 } while (res < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
7204 if (res < 0)
7205 return (!async_err) ? posix_error() : NULL;
Ross Lagerwall7807c352011-03-17 20:20:30 +02007206
7207 if (si.si_pid == 0)
7208 Py_RETURN_NONE;
7209
7210 result = PyStructSequence_New(&WaitidResultType);
7211 if (!result)
7212 return NULL;
7213
7214 PyStructSequence_SET_ITEM(result, 0, PyLong_FromPid(si.si_pid));
Serhiy Storchaka7cf55992013-02-10 21:56:49 +02007215 PyStructSequence_SET_ITEM(result, 1, _PyLong_FromUid(si.si_uid));
Ross Lagerwall7807c352011-03-17 20:20:30 +02007216 PyStructSequence_SET_ITEM(result, 2, PyLong_FromLong((long)(si.si_signo)));
7217 PyStructSequence_SET_ITEM(result, 3, PyLong_FromLong((long)(si.si_status)));
7218 PyStructSequence_SET_ITEM(result, 4, PyLong_FromLong((long)(si.si_code)));
7219 if (PyErr_Occurred()) {
7220 Py_DECREF(result);
7221 return NULL;
7222 }
7223
7224 return result;
7225}
Larry Hastings2f936352014-08-05 14:04:04 +10007226#endif /* defined(HAVE_WAITID) && !defined(__APPLE__) */
Ross Lagerwall7807c352011-03-17 20:20:30 +02007227
Larry Hastings2f936352014-08-05 14:04:04 +10007228
7229#if defined(HAVE_WAITPID)
7230/*[clinic input]
7231os.waitpid
7232 pid: pid_t
7233 options: int
7234 /
7235
7236Wait for completion of a given child process.
7237
7238Returns a tuple of information regarding the child process:
7239 (pid, status)
7240
7241The options argument is ignored on Windows.
7242[clinic start generated code]*/
7243
Larry Hastings2f936352014-08-05 14:04:04 +10007244static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007245os_waitpid_impl(PyObject *module, pid_t pid, int options)
7246/*[clinic end generated code: output=5c37c06887a20270 input=0bf1666b8758fda3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007247{
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007248 pid_t res;
7249 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00007250 WAIT_TYPE status;
7251 WAIT_STATUS_INT(status) = 0;
Guido van Rossum54ecc3d1999-01-27 17:53:11 +00007252
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007253 do {
7254 Py_BEGIN_ALLOW_THREADS
7255 res = waitpid(pid, &status, options);
7256 Py_END_ALLOW_THREADS
7257 } while (res < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
7258 if (res < 0)
7259 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007260
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007261 return Py_BuildValue("Ni", PyLong_FromPid(res), WAIT_STATUS_INT(status));
Guido van Rossum21803b81992-08-09 12:55:27 +00007262}
Tim Petersab034fa2002-02-01 11:27:43 +00007263#elif defined(HAVE_CWAIT)
Tim Petersab034fa2002-02-01 11:27:43 +00007264/* MS C has a variant of waitpid() that's usable for most purposes. */
Larry Hastings2f936352014-08-05 14:04:04 +10007265/*[clinic input]
7266os.waitpid
Benjamin Petersonca470632016-09-06 13:47:26 -07007267 pid: intptr_t
Larry Hastings2f936352014-08-05 14:04:04 +10007268 options: int
7269 /
7270
7271Wait for completion of a given process.
7272
7273Returns a tuple of information regarding the process:
7274 (pid, status << 8)
7275
7276The options argument is ignored on Windows.
7277[clinic start generated code]*/
7278
Larry Hastings2f936352014-08-05 14:04:04 +10007279static PyObject *
Benjamin Petersonca470632016-09-06 13:47:26 -07007280os_waitpid_impl(PyObject *module, intptr_t pid, int options)
Victor Stinner581139c2016-09-06 15:54:20 -07007281/*[clinic end generated code: output=be836b221271d538 input=40f2440c515410f8]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007282{
7283 int status;
Benjamin Petersonca470632016-09-06 13:47:26 -07007284 intptr_t res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007285 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10007286
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007287 do {
7288 Py_BEGIN_ALLOW_THREADS
Steve Dower11f43262016-11-19 18:33:39 -08007289 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007290 res = _cwait(&status, pid, options);
Steve Dower11f43262016-11-19 18:33:39 -08007291 _Py_END_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007292 Py_END_ALLOW_THREADS
7293 } while (res < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Victor Stinnerd3ffd322015-09-15 10:11:03 +02007294 if (res < 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007295 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007296
Victor Stinner8c62be82010-05-06 00:08:46 +00007297 /* shift the status left a byte so this is more like the POSIX waitpid */
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007298 return Py_BuildValue(_Py_PARSE_INTPTR "i", res, status << 8);
Tim Petersab034fa2002-02-01 11:27:43 +00007299}
Larry Hastings2f936352014-08-05 14:04:04 +10007300#endif
7301
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007302
Guido van Rossumad0ee831995-03-01 10:34:45 +00007303#ifdef HAVE_WAIT
Larry Hastings2f936352014-08-05 14:04:04 +10007304/*[clinic input]
7305os.wait
7306
7307Wait for completion of a child process.
7308
7309Returns a tuple of information about the child process:
7310 (pid, status)
7311[clinic start generated code]*/
7312
Larry Hastings2f936352014-08-05 14:04:04 +10007313static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007314os_wait_impl(PyObject *module)
7315/*[clinic end generated code: output=6bc419ac32fb364b input=03b0182d4a4700ce]*/
Guido van Rossum21803b81992-08-09 12:55:27 +00007316{
Victor Stinner8c62be82010-05-06 00:08:46 +00007317 pid_t pid;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007318 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00007319 WAIT_TYPE status;
7320 WAIT_STATUS_INT(status) = 0;
Neal Norwitze241ce82003-02-17 18:17:05 +00007321
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007322 do {
7323 Py_BEGIN_ALLOW_THREADS
7324 pid = wait(&status);
7325 Py_END_ALLOW_THREADS
7326 } while (pid < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
7327 if (pid < 0)
7328 return (!async_err) ? posix_error() : NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00007329
Victor Stinner8c62be82010-05-06 00:08:46 +00007330 return Py_BuildValue("Ni", PyLong_FromPid(pid), WAIT_STATUS_INT(status));
Guido van Rossum85e3b011991-06-03 12:42:10 +00007331}
Larry Hastings2f936352014-08-05 14:04:04 +10007332#endif /* HAVE_WAIT */
Guido van Rossum85e3b011991-06-03 12:42:10 +00007333
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007334
Larry Hastings9cf065c2012-06-22 16:30:09 -07007335#if defined(HAVE_READLINK) || defined(MS_WINDOWS)
7336PyDoc_STRVAR(readlink__doc__,
7337"readlink(path, *, dir_fd=None) -> path\n\n\
7338Return a string representing the path to which the symbolic link points.\n\
7339\n\
7340If dir_fd is not None, it should be a file descriptor open to a directory,\n\
7341 and path should be relative; path will then be relative to that directory.\n\
7342dir_fd may not be implemented on your platform.\n\
7343 If it is unavailable, using it will raise a NotImplementedError.");
Mark Hammondc2e85bd2002-10-03 05:10:39 +00007344#endif
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007345
Guido van Rossumb6775db1994-08-01 11:34:53 +00007346#ifdef HAVE_READLINK
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007347
Larry Hastings2f936352014-08-05 14:04:04 +10007348/* AC 3.5: merge win32 and not together */
Barry Warsaw53699e91996-12-10 23:23:01 +00007349static PyObject *
Larry Hastings9cf065c2012-06-22 16:30:09 -07007350posix_readlink(PyObject *self, PyObject *args, PyObject *kwargs)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00007351{
Larry Hastings9cf065c2012-06-22 16:30:09 -07007352 path_t path;
7353 int dir_fd = DEFAULT_DIR_FD;
Christian Heimes3cb091e2016-09-23 20:24:28 +02007354 char buffer[MAXPATHLEN+1];
Larry Hastings9cf065c2012-06-22 16:30:09 -07007355 ssize_t length;
7356 PyObject *return_value = NULL;
7357 static char *keywords[] = {"path", "dir_fd", NULL};
Thomas Wouters89f507f2006-12-13 04:49:30 +00007358
Larry Hastings9cf065c2012-06-22 16:30:09 -07007359 memset(&path, 0, sizeof(path));
Victor Stinner292c8352012-10-30 02:17:38 +01007360 path.function_name = "readlink";
Larry Hastings9cf065c2012-06-22 16:30:09 -07007361 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O&|$O&:readlink", keywords,
7362 path_converter, &path,
Larry Hastings2f936352014-08-05 14:04:04 +10007363 READLINKAT_DIR_FD_CONVERTER, &dir_fd))
Victor Stinner8c62be82010-05-06 00:08:46 +00007364 return NULL;
Thomas Wouters89f507f2006-12-13 04:49:30 +00007365
Victor Stinner8c62be82010-05-06 00:08:46 +00007366 Py_BEGIN_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07007367#ifdef HAVE_READLINKAT
7368 if (dir_fd != DEFAULT_DIR_FD)
Christian Heimes3cb091e2016-09-23 20:24:28 +02007369 length = readlinkat(dir_fd, path.narrow, buffer, MAXPATHLEN);
Victor Stinnera45598a2010-05-14 16:35:39 +00007370 else
Larry Hastings9cf065c2012-06-22 16:30:09 -07007371#endif
Christian Heimes3cb091e2016-09-23 20:24:28 +02007372 length = readlink(path.narrow, buffer, MAXPATHLEN);
Larry Hastings9cf065c2012-06-22 16:30:09 -07007373 Py_END_ALLOW_THREADS
7374
7375 if (length < 0) {
Victor Stinner292c8352012-10-30 02:17:38 +01007376 return_value = path_error(&path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07007377 goto exit;
7378 }
Christian Heimes3cb091e2016-09-23 20:24:28 +02007379 buffer[length] = '\0';
Larry Hastings9cf065c2012-06-22 16:30:09 -07007380
7381 if (PyUnicode_Check(path.object))
7382 return_value = PyUnicode_DecodeFSDefaultAndSize(buffer, length);
7383 else
7384 return_value = PyBytes_FromStringAndSize(buffer, length);
7385exit:
7386 path_cleanup(&path);
7387 return return_value;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00007388}
Larry Hastings9cf065c2012-06-22 16:30:09 -07007389
Guido van Rossumb6775db1994-08-01 11:34:53 +00007390#endif /* HAVE_READLINK */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00007391
Larry Hastings2f936352014-08-05 14:04:04 +10007392#if !defined(HAVE_READLINK) && defined(MS_WINDOWS)
7393
7394static PyObject *
7395win_readlink(PyObject *self, PyObject *args, PyObject *kwargs)
7396{
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03007397 const wchar_t *path;
Larry Hastings2f936352014-08-05 14:04:04 +10007398 DWORD n_bytes_returned;
7399 DWORD io_result;
7400 PyObject *po, *result;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03007401 int dir_fd;
Larry Hastings2f936352014-08-05 14:04:04 +10007402 HANDLE reparse_point_handle;
7403
Martin Panter70214ad2016-08-04 02:38:59 +00007404 char target_buffer[_Py_MAXIMUM_REPARSE_DATA_BUFFER_SIZE];
7405 _Py_REPARSE_DATA_BUFFER *rdb = (_Py_REPARSE_DATA_BUFFER *)target_buffer;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03007406 const wchar_t *print_name;
Larry Hastings2f936352014-08-05 14:04:04 +10007407
7408 static char *keywords[] = {"path", "dir_fd", NULL};
7409
7410 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "U|$O&:readlink", keywords,
7411 &po,
7412 dir_fd_unavailable, &dir_fd
7413 ))
7414 return NULL;
7415
Serhiy Storchakaf7eae0a2017-06-28 08:30:06 +03007416 path = _PyUnicode_AsUnicode(po);
Larry Hastings2f936352014-08-05 14:04:04 +10007417 if (path == NULL)
7418 return NULL;
7419
7420 /* First get a handle to the reparse point */
7421 Py_BEGIN_ALLOW_THREADS
7422 reparse_point_handle = CreateFileW(
7423 path,
7424 0,
7425 0,
7426 0,
7427 OPEN_EXISTING,
7428 FILE_FLAG_OPEN_REPARSE_POINT|FILE_FLAG_BACKUP_SEMANTICS,
7429 0);
7430 Py_END_ALLOW_THREADS
7431
7432 if (reparse_point_handle==INVALID_HANDLE_VALUE)
7433 return win32_error_object("readlink", po);
7434
7435 Py_BEGIN_ALLOW_THREADS
7436 /* New call DeviceIoControl to read the reparse point */
7437 io_result = DeviceIoControl(
7438 reparse_point_handle,
7439 FSCTL_GET_REPARSE_POINT,
7440 0, 0, /* in buffer */
7441 target_buffer, sizeof(target_buffer),
7442 &n_bytes_returned,
7443 0 /* we're not using OVERLAPPED_IO */
7444 );
7445 CloseHandle(reparse_point_handle);
7446 Py_END_ALLOW_THREADS
7447
7448 if (io_result==0)
7449 return win32_error_object("readlink", po);
7450
7451 if (rdb->ReparseTag != IO_REPARSE_TAG_SYMLINK)
7452 {
7453 PyErr_SetString(PyExc_ValueError,
7454 "not a symbolic link");
7455 return NULL;
7456 }
Miss Islington (bot)74ebbae2018-02-12 13:39:42 -08007457 print_name = (wchar_t *)((char*)rdb->SymbolicLinkReparseBuffer.PathBuffer +
7458 rdb->SymbolicLinkReparseBuffer.PrintNameOffset);
Larry Hastings2f936352014-08-05 14:04:04 +10007459
7460 result = PyUnicode_FromWideChar(print_name,
Miss Islington (bot)74ebbae2018-02-12 13:39:42 -08007461 rdb->SymbolicLinkReparseBuffer.PrintNameLength / sizeof(wchar_t));
Larry Hastings2f936352014-08-05 14:04:04 +10007462 return result;
7463}
7464
7465#endif /* !defined(HAVE_READLINK) && defined(MS_WINDOWS) */
7466
7467
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007468
Larry Hastings9cf065c2012-06-22 16:30:09 -07007469#ifdef HAVE_SYMLINK
Larry Hastings9cf065c2012-06-22 16:30:09 -07007470
7471#if defined(MS_WINDOWS)
7472
7473/* Grab CreateSymbolicLinkW dynamically from kernel32 */
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03007474static DWORD (CALLBACK *Py_CreateSymbolicLinkW)(LPCWSTR, LPCWSTR, DWORD) = NULL;
Victor Stinner31b3b922013-06-05 01:49:17 +02007475
Larry Hastings9cf065c2012-06-22 16:30:09 -07007476static int
Victor Stinner31b3b922013-06-05 01:49:17 +02007477check_CreateSymbolicLink(void)
Larry Hastings9cf065c2012-06-22 16:30:09 -07007478{
7479 HINSTANCE hKernel32;
7480 /* only recheck */
Steve Dowercc16be82016-09-08 10:35:16 -07007481 if (Py_CreateSymbolicLinkW)
Larry Hastings9cf065c2012-06-22 16:30:09 -07007482 return 1;
7483 hKernel32 = GetModuleHandleW(L"KERNEL32");
7484 *(FARPROC*)&Py_CreateSymbolicLinkW = GetProcAddress(hKernel32,
7485 "CreateSymbolicLinkW");
Steve Dowercc16be82016-09-08 10:35:16 -07007486 return Py_CreateSymbolicLinkW != NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07007487}
7488
Victor Stinner31b3b922013-06-05 01:49:17 +02007489/* Remove the last portion of the path */
7490static void
7491_dirnameW(WCHAR *path)
7492{
Jason R. Coombs3a092862013-05-27 23:21:28 -04007493 WCHAR *ptr;
7494
7495 /* walk the path from the end until a backslash is encountered */
Victor Stinner31b3b922013-06-05 01:49:17 +02007496 for(ptr = path + wcslen(path); ptr != path; ptr--) {
Victor Stinner072318b2013-06-05 02:07:46 +02007497 if (*ptr == L'\\' || *ptr == L'/')
Jason R. Coombs3a092862013-05-27 23:21:28 -04007498 break;
Jason R. Coombs3a092862013-05-27 23:21:28 -04007499 }
7500 *ptr = 0;
7501}
7502
Victor Stinner31b3b922013-06-05 01:49:17 +02007503/* Is this path absolute? */
7504static int
7505_is_absW(const WCHAR *path)
7506{
Jason R. Coombs3a092862013-05-27 23:21:28 -04007507 return path[0] == L'\\' || path[0] == L'/' || path[1] == L':';
7508
7509}
7510
Victor Stinner31b3b922013-06-05 01:49:17 +02007511/* join root and rest with a backslash */
7512static void
7513_joinW(WCHAR *dest_path, const WCHAR *root, const WCHAR *rest)
7514{
Victor Stinnere7e7eba2013-06-05 00:35:54 +02007515 size_t root_len;
Jason R. Coombs3a092862013-05-27 23:21:28 -04007516
Victor Stinner31b3b922013-06-05 01:49:17 +02007517 if (_is_absW(rest)) {
Jason R. Coombs3a092862013-05-27 23:21:28 -04007518 wcscpy(dest_path, rest);
7519 return;
7520 }
7521
7522 root_len = wcslen(root);
7523
7524 wcscpy(dest_path, root);
7525 if(root_len) {
Victor Stinner31b3b922013-06-05 01:49:17 +02007526 dest_path[root_len] = L'\\';
7527 root_len++;
Jason R. Coombs3a092862013-05-27 23:21:28 -04007528 }
7529 wcscpy(dest_path+root_len, rest);
7530}
7531
Victor Stinner31b3b922013-06-05 01:49:17 +02007532/* Return True if the path at src relative to dest is a directory */
7533static int
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03007534_check_dirW(LPCWSTR src, LPCWSTR dest)
Jason R. Coombs3a092862013-05-27 23:21:28 -04007535{
Jason R. Coombs3a092862013-05-27 23:21:28 -04007536 WIN32_FILE_ATTRIBUTE_DATA src_info;
7537 WCHAR dest_parent[MAX_PATH];
7538 WCHAR src_resolved[MAX_PATH] = L"";
7539
7540 /* dest_parent = os.path.dirname(dest) */
7541 wcscpy(dest_parent, dest);
7542 _dirnameW(dest_parent);
7543 /* src_resolved = os.path.join(dest_parent, src) */
7544 _joinW(src_resolved, dest_parent, src);
7545 return (
7546 GetFileAttributesExW(src_resolved, GetFileExInfoStandard, &src_info)
7547 && src_info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY
7548 );
7549}
Larry Hastings9cf065c2012-06-22 16:30:09 -07007550#endif
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007551
Larry Hastings2f936352014-08-05 14:04:04 +10007552
7553/*[clinic input]
7554os.symlink
7555 src: path_t
7556 dst: path_t
7557 target_is_directory: bool = False
7558 *
7559 dir_fd: dir_fd(requires='symlinkat')=None
7560
7561# "symlink(src, dst, target_is_directory=False, *, dir_fd=None)\n\n\
7562
7563Create a symbolic link pointing to src named dst.
7564
7565target_is_directory is required on Windows if the target is to be
7566 interpreted as a directory. (On Windows, symlink requires
7567 Windows 6.0 or greater, and raises a NotImplementedError otherwise.)
7568 target_is_directory is ignored on non-Windows platforms.
7569
7570If dir_fd is not None, it should be a file descriptor open to a directory,
7571 and path should be relative; path will then be relative to that directory.
7572dir_fd may not be implemented on your platform.
7573 If it is unavailable, using it will raise a NotImplementedError.
7574
7575[clinic start generated code]*/
7576
Larry Hastings2f936352014-08-05 14:04:04 +10007577static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007578os_symlink_impl(PyObject *module, path_t *src, path_t *dst,
Larry Hastings89964c42015-04-14 18:07:59 -04007579 int target_is_directory, int dir_fd)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007580/*[clinic end generated code: output=08ca9f3f3cf960f6 input=e820ec4472547bc3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007581{
Larry Hastings9cf065c2012-06-22 16:30:09 -07007582#ifdef MS_WINDOWS
7583 DWORD result;
7584#else
7585 int result;
7586#endif
7587
Larry Hastings9cf065c2012-06-22 16:30:09 -07007588#ifdef MS_WINDOWS
7589 if (!check_CreateSymbolicLink()) {
7590 PyErr_SetString(PyExc_NotImplementedError,
7591 "CreateSymbolicLink functions not found");
Larry Hastings2f936352014-08-05 14:04:04 +10007592 return NULL;
Petri Lehtinen5445a8c2012-10-23 16:12:14 +03007593 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07007594 if (!win32_can_symlink) {
7595 PyErr_SetString(PyExc_OSError, "symbolic link privilege not held");
Larry Hastings2f936352014-08-05 14:04:04 +10007596 return NULL;
Petri Lehtinen5445a8c2012-10-23 16:12:14 +03007597 }
Larry Hastings9cf065c2012-06-22 16:30:09 -07007598#endif
7599
Larry Hastings2f936352014-08-05 14:04:04 +10007600 if ((src->narrow && dst->wide) || (src->wide && dst->narrow)) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07007601 PyErr_SetString(PyExc_ValueError,
7602 "symlink: src and dst must be the same type");
Larry Hastings2f936352014-08-05 14:04:04 +10007603 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07007604 }
7605
7606#ifdef MS_WINDOWS
Jason R. Coombs3a092862013-05-27 23:21:28 -04007607
Larry Hastings9cf065c2012-06-22 16:30:09 -07007608 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -07007609 /* if src is a directory, ensure target_is_directory==1 */
7610 target_is_directory |= _check_dirW(src->wide, dst->wide);
7611 result = Py_CreateSymbolicLinkW(dst->wide, src->wide,
7612 target_is_directory);
Larry Hastings9cf065c2012-06-22 16:30:09 -07007613 Py_END_ALLOW_THREADS
7614
Larry Hastings2f936352014-08-05 14:04:04 +10007615 if (!result)
7616 return path_error2(src, dst);
Larry Hastings9cf065c2012-06-22 16:30:09 -07007617
7618#else
7619
7620 Py_BEGIN_ALLOW_THREADS
7621#if HAVE_SYMLINKAT
7622 if (dir_fd != DEFAULT_DIR_FD)
Larry Hastings2f936352014-08-05 14:04:04 +10007623 result = symlinkat(src->narrow, dir_fd, dst->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07007624 else
7625#endif
Larry Hastings2f936352014-08-05 14:04:04 +10007626 result = symlink(src->narrow, dst->narrow);
Larry Hastings9cf065c2012-06-22 16:30:09 -07007627 Py_END_ALLOW_THREADS
7628
Larry Hastings2f936352014-08-05 14:04:04 +10007629 if (result)
7630 return path_error2(src, dst);
Larry Hastings9cf065c2012-06-22 16:30:09 -07007631#endif
7632
Larry Hastings2f936352014-08-05 14:04:04 +10007633 Py_RETURN_NONE;
Guido van Rossumbfaf3d61997-12-29 20:02:27 +00007634}
7635#endif /* HAVE_SYMLINK */
7636
Larry Hastings9cf065c2012-06-22 16:30:09 -07007637
Brian Curtind40e6f72010-07-08 21:39:08 +00007638
Guido van Rossumbfaf3d61997-12-29 20:02:27 +00007639
Larry Hastings605a62d2012-06-24 04:33:36 -07007640static PyStructSequence_Field times_result_fields[] = {
7641 {"user", "user time"},
7642 {"system", "system time"},
7643 {"children_user", "user time of children"},
7644 {"children_system", "system time of children"},
7645 {"elapsed", "elapsed time since an arbitrary point in the past"},
7646 {NULL}
7647};
7648
7649PyDoc_STRVAR(times_result__doc__,
7650"times_result: Result from os.times().\n\n\
7651This object may be accessed either as a tuple of\n\
7652 (user, system, children_user, children_system, elapsed),\n\
7653or via the attributes user, system, children_user, children_system,\n\
7654and elapsed.\n\
7655\n\
7656See os.times for more information.");
7657
7658static PyStructSequence_Desc times_result_desc = {
7659 "times_result", /* name */
7660 times_result__doc__, /* doc */
7661 times_result_fields,
7662 5
7663};
7664
7665static PyTypeObject TimesResultType;
7666
Antoine Pitrouf3923e92012-07-24 21:23:53 +02007667#ifdef MS_WINDOWS
7668#define HAVE_TIMES /* mandatory, for the method table */
7669#endif
Larry Hastings605a62d2012-06-24 04:33:36 -07007670
Antoine Pitrouf3923e92012-07-24 21:23:53 +02007671#ifdef HAVE_TIMES
Larry Hastings605a62d2012-06-24 04:33:36 -07007672
7673static PyObject *
7674build_times_result(double user, double system,
7675 double children_user, double children_system,
7676 double elapsed)
7677{
7678 PyObject *value = PyStructSequence_New(&TimesResultType);
7679 if (value == NULL)
7680 return NULL;
7681
7682#define SET(i, field) \
7683 { \
7684 PyObject *o = PyFloat_FromDouble(field); \
7685 if (!o) { \
7686 Py_DECREF(value); \
7687 return NULL; \
7688 } \
7689 PyStructSequence_SET_ITEM(value, i, o); \
7690 } \
7691
7692 SET(0, user);
7693 SET(1, system);
7694 SET(2, children_user);
7695 SET(3, children_system);
7696 SET(4, elapsed);
7697
7698#undef SET
7699
7700 return value;
7701}
7702
Larry Hastings605a62d2012-06-24 04:33:36 -07007703
Larry Hastings2f936352014-08-05 14:04:04 +10007704#ifndef MS_WINDOWS
7705#define NEED_TICKS_PER_SECOND
7706static long ticks_per_second = -1;
7707#endif /* MS_WINDOWS */
7708
7709/*[clinic input]
7710os.times
7711
7712Return a collection containing process timing information.
7713
7714The object returned behaves like a named tuple with these fields:
7715 (utime, stime, cutime, cstime, elapsed_time)
7716All fields are floating point numbers.
7717[clinic start generated code]*/
7718
Larry Hastings2f936352014-08-05 14:04:04 +10007719static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007720os_times_impl(PyObject *module)
7721/*[clinic end generated code: output=35f640503557d32a input=2bf9df3d6ab2e48b]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007722#ifdef MS_WINDOWS
Guido van Rossum14ed0b21994-09-29 09:50:09 +00007723{
Victor Stinner8c62be82010-05-06 00:08:46 +00007724 FILETIME create, exit, kernel, user;
7725 HANDLE hProc;
7726 hProc = GetCurrentProcess();
7727 GetProcessTimes(hProc, &create, &exit, &kernel, &user);
7728 /* The fields of a FILETIME structure are the hi and lo part
7729 of a 64-bit value expressed in 100 nanosecond units.
7730 1e7 is one second in such units; 1e-7 the inverse.
7731 429.4967296 is 2**32 / 1e7 or 2**32 * 1e-7.
7732 */
Larry Hastings605a62d2012-06-24 04:33:36 -07007733 return build_times_result(
Victor Stinner8c62be82010-05-06 00:08:46 +00007734 (double)(user.dwHighDateTime*429.4967296 +
7735 user.dwLowDateTime*1e-7),
7736 (double)(kernel.dwHighDateTime*429.4967296 +
7737 kernel.dwLowDateTime*1e-7),
7738 (double)0,
7739 (double)0,
7740 (double)0);
Guido van Rossum14ed0b21994-09-29 09:50:09 +00007741}
Larry Hastings2f936352014-08-05 14:04:04 +10007742#else /* MS_WINDOWS */
Antoine Pitrouf3923e92012-07-24 21:23:53 +02007743{
Larry Hastings2f936352014-08-05 14:04:04 +10007744
7745
Antoine Pitrouf3923e92012-07-24 21:23:53 +02007746 struct tms t;
7747 clock_t c;
7748 errno = 0;
7749 c = times(&t);
7750 if (c == (clock_t) -1)
7751 return posix_error();
7752 return build_times_result(
7753 (double)t.tms_utime / ticks_per_second,
7754 (double)t.tms_stime / ticks_per_second,
7755 (double)t.tms_cutime / ticks_per_second,
7756 (double)t.tms_cstime / ticks_per_second,
7757 (double)c / ticks_per_second);
7758}
Larry Hastings2f936352014-08-05 14:04:04 +10007759#endif /* MS_WINDOWS */
Antoine Pitrouf3923e92012-07-24 21:23:53 +02007760#endif /* HAVE_TIMES */
7761
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007762
Martin v. Löwis49ee14d2003-11-10 06:35:36 +00007763#ifdef HAVE_GETSID
Larry Hastings2f936352014-08-05 14:04:04 +10007764/*[clinic input]
7765os.getsid
7766
7767 pid: pid_t
7768 /
7769
7770Call the system call getsid(pid) and return the result.
7771[clinic start generated code]*/
7772
Larry Hastings2f936352014-08-05 14:04:04 +10007773static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007774os_getsid_impl(PyObject *module, pid_t pid)
7775/*[clinic end generated code: output=112deae56b306460 input=eeb2b923a30ce04e]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007776{
Victor Stinner8c62be82010-05-06 00:08:46 +00007777 int sid;
Victor Stinner8c62be82010-05-06 00:08:46 +00007778 sid = getsid(pid);
7779 if (sid < 0)
7780 return posix_error();
7781 return PyLong_FromLong((long)sid);
Martin v. Löwis49ee14d2003-11-10 06:35:36 +00007782}
7783#endif /* HAVE_GETSID */
7784
7785
Guido van Rossumb6775db1994-08-01 11:34:53 +00007786#ifdef HAVE_SETSID
Larry Hastings2f936352014-08-05 14:04:04 +10007787/*[clinic input]
7788os.setsid
7789
7790Call the system call setsid().
7791[clinic start generated code]*/
7792
Larry Hastings2f936352014-08-05 14:04:04 +10007793static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007794os_setsid_impl(PyObject *module)
7795/*[clinic end generated code: output=e2ddedd517086d77 input=5fff45858e2f0776]*/
Guido van Rossumc2670a01992-09-13 20:07:29 +00007796{
Victor Stinner8c62be82010-05-06 00:08:46 +00007797 if (setsid() < 0)
7798 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007799 Py_RETURN_NONE;
Guido van Rossumc2670a01992-09-13 20:07:29 +00007800}
Guido van Rossumb6775db1994-08-01 11:34:53 +00007801#endif /* HAVE_SETSID */
Guido van Rossumc2670a01992-09-13 20:07:29 +00007802
Larry Hastings2f936352014-08-05 14:04:04 +10007803
Guido van Rossumb6775db1994-08-01 11:34:53 +00007804#ifdef HAVE_SETPGID
Larry Hastings2f936352014-08-05 14:04:04 +10007805/*[clinic input]
7806os.setpgid
7807
7808 pid: pid_t
7809 pgrp: pid_t
7810 /
7811
7812Call the system call setpgid(pid, pgrp).
7813[clinic start generated code]*/
7814
Larry Hastings2f936352014-08-05 14:04:04 +10007815static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007816os_setpgid_impl(PyObject *module, pid_t pid, pid_t pgrp)
7817/*[clinic end generated code: output=6461160319a43d6a input=fceb395eca572e1a]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007818{
Victor Stinner8c62be82010-05-06 00:08:46 +00007819 if (setpgid(pid, pgrp) < 0)
7820 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007821 Py_RETURN_NONE;
Guido van Rossumc2670a01992-09-13 20:07:29 +00007822}
Guido van Rossumb6775db1994-08-01 11:34:53 +00007823#endif /* HAVE_SETPGID */
Guido van Rossumc2670a01992-09-13 20:07:29 +00007824
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007825
Guido van Rossumb6775db1994-08-01 11:34:53 +00007826#ifdef HAVE_TCGETPGRP
Larry Hastings2f936352014-08-05 14:04:04 +10007827/*[clinic input]
7828os.tcgetpgrp
7829
7830 fd: int
7831 /
7832
7833Return the process group associated with the terminal specified by fd.
7834[clinic start generated code]*/
7835
Larry Hastings2f936352014-08-05 14:04:04 +10007836static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007837os_tcgetpgrp_impl(PyObject *module, int fd)
7838/*[clinic end generated code: output=f865e88be86c272b input=7f6c18eac10ada86]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007839{
7840 pid_t pgid = tcgetpgrp(fd);
Victor Stinner8c62be82010-05-06 00:08:46 +00007841 if (pgid < 0)
7842 return posix_error();
7843 return PyLong_FromPid(pgid);
Guido van Rossum7066dd71992-09-17 17:54:56 +00007844}
Guido van Rossumb6775db1994-08-01 11:34:53 +00007845#endif /* HAVE_TCGETPGRP */
Guido van Rossum7066dd71992-09-17 17:54:56 +00007846
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007847
Guido van Rossumb6775db1994-08-01 11:34:53 +00007848#ifdef HAVE_TCSETPGRP
Larry Hastings2f936352014-08-05 14:04:04 +10007849/*[clinic input]
7850os.tcsetpgrp
7851
7852 fd: int
7853 pgid: pid_t
7854 /
7855
7856Set the process group associated with the terminal specified by fd.
7857[clinic start generated code]*/
7858
Larry Hastings2f936352014-08-05 14:04:04 +10007859static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007860os_tcsetpgrp_impl(PyObject *module, int fd, pid_t pgid)
7861/*[clinic end generated code: output=f1821a381b9daa39 input=5bdc997c6a619020]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007862{
Victor Stinner8c62be82010-05-06 00:08:46 +00007863 if (tcsetpgrp(fd, pgid) < 0)
7864 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007865 Py_RETURN_NONE;
Guido van Rossum7066dd71992-09-17 17:54:56 +00007866}
Guido van Rossumb6775db1994-08-01 11:34:53 +00007867#endif /* HAVE_TCSETPGRP */
Guido van Rossum22db57e1992-04-05 14:25:30 +00007868
Guido van Rossum687dd131993-05-17 08:34:16 +00007869/* Functions acting on file descriptors */
7870
Victor Stinnerdaf45552013-08-28 00:53:59 +02007871#ifdef O_CLOEXEC
7872extern int _Py_open_cloexec_works;
7873#endif
7874
Larry Hastings2f936352014-08-05 14:04:04 +10007875
7876/*[clinic input]
7877os.open -> int
7878 path: path_t
7879 flags: int
7880 mode: int = 0o777
7881 *
7882 dir_fd: dir_fd(requires='openat') = None
7883
7884# "open(path, flags, mode=0o777, *, dir_fd=None)\n\n\
7885
7886Open a file for low level IO. Returns a file descriptor (integer).
7887
7888If dir_fd is not None, it should be a file descriptor open to a directory,
7889 and path should be relative; path will then be relative to that directory.
7890dir_fd may not be implemented on your platform.
7891 If it is unavailable, using it will raise a NotImplementedError.
7892[clinic start generated code]*/
7893
Larry Hastings2f936352014-08-05 14:04:04 +10007894static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007895os_open_impl(PyObject *module, path_t *path, int flags, int mode, int dir_fd)
7896/*[clinic end generated code: output=abc7227888c8bc73 input=ad8623b29acd2934]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007897{
7898 int fd;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007899 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10007900
Victor Stinnerdaf45552013-08-28 00:53:59 +02007901#ifdef O_CLOEXEC
7902 int *atomic_flag_works = &_Py_open_cloexec_works;
7903#elif !defined(MS_WINDOWS)
7904 int *atomic_flag_works = NULL;
7905#endif
Mark Hammondc2e85bd2002-10-03 05:10:39 +00007906
Victor Stinnerdaf45552013-08-28 00:53:59 +02007907#ifdef MS_WINDOWS
7908 flags |= O_NOINHERIT;
7909#elif defined(O_CLOEXEC)
7910 flags |= O_CLOEXEC;
7911#endif
7912
Steve Dower8fc89802015-04-12 00:26:27 -04007913 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007914 do {
7915 Py_BEGIN_ALLOW_THREADS
Larry Hastings9cf065c2012-06-22 16:30:09 -07007916#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07007917 fd = _wopen(path->wide, flags, mode);
Steve Dower6230aaf2016-09-09 09:03:15 -07007918#else
Larry Hastings9cf065c2012-06-22 16:30:09 -07007919#ifdef HAVE_OPENAT
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007920 if (dir_fd != DEFAULT_DIR_FD)
7921 fd = openat(dir_fd, path->narrow, flags, mode);
7922 else
Steve Dower6230aaf2016-09-09 09:03:15 -07007923#endif /* HAVE_OPENAT */
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007924 fd = open(path->narrow, flags, mode);
Steve Dower6230aaf2016-09-09 09:03:15 -07007925#endif /* !MS_WINDOWS */
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007926 Py_END_ALLOW_THREADS
7927 } while (fd < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Steve Dower8fc89802015-04-12 00:26:27 -04007928 _Py_END_SUPPRESS_IPH
Guido van Rossum687dd131993-05-17 08:34:16 +00007929
Victor Stinnerd3ffd322015-09-15 10:11:03 +02007930 if (fd < 0) {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007931 if (!async_err)
7932 PyErr_SetFromErrnoWithFilenameObject(PyExc_OSError, path->object);
Larry Hastings2f936352014-08-05 14:04:04 +10007933 return -1;
Larry Hastings9cf065c2012-06-22 16:30:09 -07007934 }
7935
Victor Stinnerdaf45552013-08-28 00:53:59 +02007936#ifndef MS_WINDOWS
7937 if (_Py_set_inheritable(fd, 0, atomic_flag_works) < 0) {
7938 close(fd);
Larry Hastings2f936352014-08-05 14:04:04 +10007939 return -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +02007940 }
7941#endif
7942
Larry Hastings2f936352014-08-05 14:04:04 +10007943 return fd;
7944}
7945
7946
7947/*[clinic input]
7948os.close
7949
7950 fd: int
7951
7952Close a file descriptor.
7953[clinic start generated code]*/
7954
Barry Warsaw53699e91996-12-10 23:23:01 +00007955static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007956os_close_impl(PyObject *module, int fd)
7957/*[clinic end generated code: output=2fe4e93602822c14 input=2bc42451ca5c3223]*/
Guido van Rossum687dd131993-05-17 08:34:16 +00007958{
Larry Hastings2f936352014-08-05 14:04:04 +10007959 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00007960 /* We do not want to retry upon EINTR: see http://lwn.net/Articles/576478/
7961 * and http://linux.derkeiler.com/Mailing-Lists/Kernel/2005-09/3000.html
7962 * for more details.
7963 */
Victor Stinner8c62be82010-05-06 00:08:46 +00007964 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04007965 _Py_BEGIN_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00007966 res = close(fd);
Steve Dower8fc89802015-04-12 00:26:27 -04007967 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00007968 Py_END_ALLOW_THREADS
7969 if (res < 0)
7970 return posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10007971 Py_RETURN_NONE;
Guido van Rossum687dd131993-05-17 08:34:16 +00007972}
7973
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00007974
Larry Hastings2f936352014-08-05 14:04:04 +10007975/*[clinic input]
7976os.closerange
7977
7978 fd_low: int
7979 fd_high: int
7980 /
7981
7982Closes all file descriptors in [fd_low, fd_high), ignoring errors.
7983[clinic start generated code]*/
7984
Larry Hastings2f936352014-08-05 14:04:04 +10007985static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03007986os_closerange_impl(PyObject *module, int fd_low, int fd_high)
7987/*[clinic end generated code: output=0ce5c20fcda681c2 input=5855a3d053ebd4ec]*/
Larry Hastings2f936352014-08-05 14:04:04 +10007988{
7989 int i;
Victor Stinner8c62be82010-05-06 00:08:46 +00007990 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04007991 _Py_BEGIN_SUPPRESS_IPH
Benjamin Peterson207116b2016-09-08 11:28:06 -07007992 for (i = Py_MAX(fd_low, 0); i < fd_high; i++)
Steve Dower940f33a2016-09-08 11:21:54 -07007993 close(i);
Steve Dower8fc89802015-04-12 00:26:27 -04007994 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00007995 Py_END_ALLOW_THREADS
7996 Py_RETURN_NONE;
Christian Heimesfdab48e2008-01-20 09:06:41 +00007997}
7998
7999
Larry Hastings2f936352014-08-05 14:04:04 +10008000/*[clinic input]
8001os.dup -> int
8002
8003 fd: int
8004 /
8005
8006Return a duplicate of a file descriptor.
8007[clinic start generated code]*/
8008
Larry Hastings2f936352014-08-05 14:04:04 +10008009static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008010os_dup_impl(PyObject *module, int fd)
8011/*[clinic end generated code: output=486f4860636b2a9f input=6f10f7ea97f7852a]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008012{
8013 return _Py_dup(fd);
Guido van Rossum687dd131993-05-17 08:34:16 +00008014}
8015
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008016
Larry Hastings2f936352014-08-05 14:04:04 +10008017/*[clinic input]
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008018os.dup2 -> int
Larry Hastings2f936352014-08-05 14:04:04 +10008019 fd: int
8020 fd2: int
8021 inheritable: bool=True
8022
8023Duplicate file descriptor.
8024[clinic start generated code]*/
8025
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008026static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008027os_dup2_impl(PyObject *module, int fd, int fd2, int inheritable)
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008028/*[clinic end generated code: output=bc059d34a73404d1 input=c3cddda8922b038d]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008029{
Stéphane Wirtel3d86e482018-01-30 07:04:36 +01008030 int res = 0;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008031#if defined(HAVE_DUP3) && \
8032 !(defined(HAVE_FCNTL_H) && defined(F_DUP2FD_CLOEXEC))
8033 /* dup3() is available on Linux 2.6.27+ and glibc 2.9 */
Miss Islington (bot)bab4fe32018-02-19 23:46:47 -08008034 static int dup3_works = -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008035#endif
8036
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008037 if (fd < 0 || fd2 < 0) {
8038 posix_error();
8039 return -1;
8040 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02008041
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008042 /* dup2() can fail with EINTR if the target FD is already open, because it
8043 * then has to be closed. See os_close_impl() for why we don't handle EINTR
8044 * upon close(), and therefore below.
8045 */
Victor Stinnerdaf45552013-08-28 00:53:59 +02008046#ifdef MS_WINDOWS
8047 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04008048 _Py_BEGIN_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00008049 res = dup2(fd, fd2);
Steve Dower8fc89802015-04-12 00:26:27 -04008050 _Py_END_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02008051 Py_END_ALLOW_THREADS
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008052 if (res < 0) {
8053 posix_error();
8054 return -1;
8055 }
8056 res = fd2; // msvcrt dup2 returns 0 on success.
Victor Stinnerdaf45552013-08-28 00:53:59 +02008057
8058 /* Character files like console cannot be make non-inheritable */
8059 if (!inheritable && _Py_set_inheritable(fd2, 0, NULL) < 0) {
8060 close(fd2);
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008061 return -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008062 }
8063
8064#elif defined(HAVE_FCNTL_H) && defined(F_DUP2FD_CLOEXEC)
8065 Py_BEGIN_ALLOW_THREADS
8066 if (!inheritable)
8067 res = fcntl(fd, F_DUP2FD_CLOEXEC, fd2);
8068 else
8069 res = dup2(fd, fd2);
8070 Py_END_ALLOW_THREADS
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008071 if (res < 0) {
8072 posix_error();
8073 return -1;
8074 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02008075
8076#else
8077
8078#ifdef HAVE_DUP3
8079 if (!inheritable && dup3_works != 0) {
8080 Py_BEGIN_ALLOW_THREADS
8081 res = dup3(fd, fd2, O_CLOEXEC);
8082 Py_END_ALLOW_THREADS
8083 if (res < 0) {
8084 if (dup3_works == -1)
8085 dup3_works = (errno != ENOSYS);
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008086 if (dup3_works) {
8087 posix_error();
8088 return -1;
8089 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02008090 }
8091 }
8092
8093 if (inheritable || dup3_works == 0)
8094 {
8095#endif
8096 Py_BEGIN_ALLOW_THREADS
8097 res = dup2(fd, fd2);
8098 Py_END_ALLOW_THREADS
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008099 if (res < 0) {
8100 posix_error();
8101 return -1;
8102 }
Victor Stinnerdaf45552013-08-28 00:53:59 +02008103
8104 if (!inheritable && _Py_set_inheritable(fd2, 0, NULL) < 0) {
8105 close(fd2);
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008106 return -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008107 }
8108#ifdef HAVE_DUP3
8109 }
8110#endif
8111
8112#endif
8113
Benjamin Petersonbbdb17d2017-12-29 13:13:06 -08008114 return res;
Guido van Rossum687dd131993-05-17 08:34:16 +00008115}
8116
Larry Hastings2f936352014-08-05 14:04:04 +10008117
Ross Lagerwall7807c352011-03-17 20:20:30 +02008118#ifdef HAVE_LOCKF
Larry Hastings2f936352014-08-05 14:04:04 +10008119/*[clinic input]
8120os.lockf
8121
8122 fd: int
8123 An open file descriptor.
8124 command: int
8125 One of F_LOCK, F_TLOCK, F_ULOCK or F_TEST.
8126 length: Py_off_t
8127 The number of bytes to lock, starting at the current position.
8128 /
8129
8130Apply, test or remove a POSIX lock on an open file descriptor.
8131
8132[clinic start generated code]*/
8133
Larry Hastings2f936352014-08-05 14:04:04 +10008134static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008135os_lockf_impl(PyObject *module, int fd, int command, Py_off_t length)
8136/*[clinic end generated code: output=af7051f3e7c29651 input=65da41d2106e9b79]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008137{
8138 int res;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008139
8140 Py_BEGIN_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10008141 res = lockf(fd, command, length);
Ross Lagerwall7807c352011-03-17 20:20:30 +02008142 Py_END_ALLOW_THREADS
8143
8144 if (res < 0)
8145 return posix_error();
8146
8147 Py_RETURN_NONE;
8148}
Larry Hastings2f936352014-08-05 14:04:04 +10008149#endif /* HAVE_LOCKF */
Ross Lagerwall7807c352011-03-17 20:20:30 +02008150
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008151
Larry Hastings2f936352014-08-05 14:04:04 +10008152/*[clinic input]
8153os.lseek -> Py_off_t
8154
8155 fd: int
8156 position: Py_off_t
8157 how: int
8158 /
8159
8160Set the position of a file descriptor. Return the new position.
8161
8162Return the new cursor position in number of bytes
8163relative to the beginning of the file.
8164[clinic start generated code]*/
8165
Larry Hastings2f936352014-08-05 14:04:04 +10008166static Py_off_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008167os_lseek_impl(PyObject *module, int fd, Py_off_t position, int how)
8168/*[clinic end generated code: output=971e1efb6b30bd2f input=902654ad3f96a6d3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008169{
8170 Py_off_t result;
8171
Guido van Rossum687dd131993-05-17 08:34:16 +00008172#ifdef SEEK_SET
Victor Stinner8c62be82010-05-06 00:08:46 +00008173 /* Turn 0, 1, 2 into SEEK_{SET,CUR,END} */
8174 switch (how) {
Larry Hastings2f936352014-08-05 14:04:04 +10008175 case 0: how = SEEK_SET; break;
8176 case 1: how = SEEK_CUR; break;
8177 case 2: how = SEEK_END; break;
Victor Stinner8c62be82010-05-06 00:08:46 +00008178 }
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +00008179#endif /* SEEK_END */
Guido van Rossum94f6f721999-01-06 18:42:14 +00008180
Victor Stinner8c62be82010-05-06 00:08:46 +00008181 if (PyErr_Occurred())
Larry Hastings2f936352014-08-05 14:04:04 +10008182 return -1;
Guido van Rossum94f6f721999-01-06 18:42:14 +00008183
Victor Stinner8c62be82010-05-06 00:08:46 +00008184 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04008185 _Py_BEGIN_SUPPRESS_IPH
Victor Stinner14b9b112013-06-25 00:37:25 +02008186#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10008187 result = _lseeki64(fd, position, how);
Fred Drake699f3522000-06-29 21:12:41 +00008188#else
Larry Hastings2f936352014-08-05 14:04:04 +10008189 result = lseek(fd, position, how);
Fred Drake699f3522000-06-29 21:12:41 +00008190#endif
Steve Dower8fc89802015-04-12 00:26:27 -04008191 _Py_END_SUPPRESS_IPH
Victor Stinner8c62be82010-05-06 00:08:46 +00008192 Py_END_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10008193 if (result < 0)
8194 posix_error();
Guido van Rossum94f6f721999-01-06 18:42:14 +00008195
Larry Hastings2f936352014-08-05 14:04:04 +10008196 return result;
Guido van Rossum687dd131993-05-17 08:34:16 +00008197}
8198
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008199
Larry Hastings2f936352014-08-05 14:04:04 +10008200/*[clinic input]
8201os.read
8202 fd: int
8203 length: Py_ssize_t
8204 /
8205
8206Read from a file descriptor. Returns a bytes object.
8207[clinic start generated code]*/
8208
Larry Hastings2f936352014-08-05 14:04:04 +10008209static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008210os_read_impl(PyObject *module, int fd, Py_ssize_t length)
8211/*[clinic end generated code: output=dafbe9a5cddb987b input=1df2eaa27c0bf1d3]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008212{
Victor Stinner8c62be82010-05-06 00:08:46 +00008213 Py_ssize_t n;
8214 PyObject *buffer;
Larry Hastings2f936352014-08-05 14:04:04 +10008215
8216 if (length < 0) {
Victor Stinner8c62be82010-05-06 00:08:46 +00008217 errno = EINVAL;
8218 return posix_error();
8219 }
Larry Hastings2f936352014-08-05 14:04:04 +10008220
8221#ifdef MS_WINDOWS
Victor Stinner66aab0c2015-03-19 22:53:20 +01008222 /* On Windows, the count parameter of read() is an int */
Larry Hastings2f936352014-08-05 14:04:04 +10008223 if (length > INT_MAX)
8224 length = INT_MAX;
Larry Hastings2f936352014-08-05 14:04:04 +10008225#endif
8226
8227 buffer = PyBytes_FromStringAndSize((char *)NULL, length);
Victor Stinner8c62be82010-05-06 00:08:46 +00008228 if (buffer == NULL)
8229 return NULL;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008230
Victor Stinner66aab0c2015-03-19 22:53:20 +01008231 n = _Py_read(fd, PyBytes_AS_STRING(buffer), length);
8232 if (n == -1) {
Victor Stinner8c62be82010-05-06 00:08:46 +00008233 Py_DECREF(buffer);
Victor Stinner66aab0c2015-03-19 22:53:20 +01008234 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +00008235 }
Larry Hastings2f936352014-08-05 14:04:04 +10008236
8237 if (n != length)
Victor Stinner8c62be82010-05-06 00:08:46 +00008238 _PyBytes_Resize(&buffer, n);
Larry Hastings2f936352014-08-05 14:04:04 +10008239
Victor Stinner8c62be82010-05-06 00:08:46 +00008240 return buffer;
Guido van Rossum687dd131993-05-17 08:34:16 +00008241}
8242
Ross Lagerwall7807c352011-03-17 20:20:30 +02008243#if (defined(HAVE_SENDFILE) && (defined(__FreeBSD__) || defined(__DragonFly__) \
8244 || defined(__APPLE__))) || defined(HAVE_READV) || defined(HAVE_WRITEV)
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00008245static Py_ssize_t
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008246iov_setup(struct iovec **iov, Py_buffer **buf, PyObject *seq, Py_ssize_t cnt, int type)
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008247{
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008248 Py_ssize_t i, j;
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00008249 Py_ssize_t blen, total = 0;
8250
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008251 *iov = PyMem_New(struct iovec, cnt);
8252 if (*iov == NULL) {
8253 PyErr_NoMemory();
Victor Stinner57ddf782014-01-08 15:21:28 +01008254 return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008255 }
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00008256
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008257 *buf = PyMem_New(Py_buffer, cnt);
8258 if (*buf == NULL) {
8259 PyMem_Del(*iov);
8260 PyErr_NoMemory();
Victor Stinner57ddf782014-01-08 15:21:28 +01008261 return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008262 }
8263
8264 for (i = 0; i < cnt; i++) {
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02008265 PyObject *item = PySequence_GetItem(seq, i);
8266 if (item == NULL)
8267 goto fail;
8268 if (PyObject_GetBuffer(item, &(*buf)[i], type) == -1) {
8269 Py_DECREF(item);
8270 goto fail;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008271 }
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02008272 Py_DECREF(item);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008273 (*iov)[i].iov_base = (*buf)[i].buf;
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00008274 blen = (*buf)[i].len;
8275 (*iov)[i].iov_len = blen;
8276 total += blen;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008277 }
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00008278 return total;
Ross Lagerwall9ad63e02011-03-19 09:11:14 +02008279
8280fail:
8281 PyMem_Del(*iov);
8282 for (j = 0; j < i; j++) {
8283 PyBuffer_Release(&(*buf)[j]);
8284 }
8285 PyMem_Del(*buf);
Victor Stinner57ddf782014-01-08 15:21:28 +01008286 return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008287}
8288
8289static void
8290iov_cleanup(struct iovec *iov, Py_buffer *buf, int cnt)
8291{
8292 int i;
8293 PyMem_Del(iov);
8294 for (i = 0; i < cnt; i++) {
8295 PyBuffer_Release(&buf[i]);
8296 }
8297 PyMem_Del(buf);
8298}
8299#endif
8300
Larry Hastings2f936352014-08-05 14:04:04 +10008301
Ross Lagerwall7807c352011-03-17 20:20:30 +02008302#ifdef HAVE_READV
Larry Hastings2f936352014-08-05 14:04:04 +10008303/*[clinic input]
8304os.readv -> Py_ssize_t
8305
8306 fd: int
8307 buffers: object
8308 /
8309
8310Read from a file descriptor fd into an iterable of buffers.
8311
8312The buffers should be mutable buffers accepting bytes.
8313readv will transfer data into each buffer until it is full
8314and then move on to the next buffer in the sequence to hold
8315the rest of the data.
8316
8317readv returns the total number of bytes read,
8318which may be less than the total capacity of all the buffers.
8319[clinic start generated code]*/
8320
Larry Hastings2f936352014-08-05 14:04:04 +10008321static Py_ssize_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008322os_readv_impl(PyObject *module, int fd, PyObject *buffers)
8323/*[clinic end generated code: output=792da062d3fcebdb input=e679eb5dbfa0357d]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008324{
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008325 Py_ssize_t cnt, n;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008326 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008327 struct iovec *iov;
8328 Py_buffer *buf;
8329
Larry Hastings2f936352014-08-05 14:04:04 +10008330 if (!PySequence_Check(buffers)) {
Ross Lagerwall7807c352011-03-17 20:20:30 +02008331 PyErr_SetString(PyExc_TypeError,
8332 "readv() arg 2 must be a sequence");
Larry Hastings2f936352014-08-05 14:04:04 +10008333 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008334 }
Ross Lagerwall7807c352011-03-17 20:20:30 +02008335
Larry Hastings2f936352014-08-05 14:04:04 +10008336 cnt = PySequence_Size(buffers);
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008337 if (cnt < 0)
8338 return -1;
Larry Hastings2f936352014-08-05 14:04:04 +10008339
8340 if (iov_setup(&iov, &buf, buffers, cnt, PyBUF_WRITABLE) < 0)
8341 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008342
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008343 do {
8344 Py_BEGIN_ALLOW_THREADS
8345 n = readv(fd, iov, cnt);
8346 Py_END_ALLOW_THREADS
8347 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Ross Lagerwall7807c352011-03-17 20:20:30 +02008348
8349 iov_cleanup(iov, buf, cnt);
Larry Hastings2f936352014-08-05 14:04:04 +10008350 if (n < 0) {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008351 if (!async_err)
8352 posix_error();
Larry Hastings2f936352014-08-05 14:04:04 +10008353 return -1;
8354 }
Victor Stinner57ddf782014-01-08 15:21:28 +01008355
Larry Hastings2f936352014-08-05 14:04:04 +10008356 return n;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008357}
Larry Hastings2f936352014-08-05 14:04:04 +10008358#endif /* HAVE_READV */
8359
Ross Lagerwall7807c352011-03-17 20:20:30 +02008360
8361#ifdef HAVE_PREAD
Larry Hastings2f936352014-08-05 14:04:04 +10008362/*[clinic input]
8363# TODO length should be size_t! but Python doesn't support parsing size_t yet.
8364os.pread
8365
8366 fd: int
8367 length: int
8368 offset: Py_off_t
8369 /
8370
8371Read a number of bytes from a file descriptor starting at a particular offset.
8372
8373Read length bytes from file descriptor fd, starting at offset bytes from
8374the beginning of the file. The file offset remains unchanged.
8375[clinic start generated code]*/
8376
Larry Hastings2f936352014-08-05 14:04:04 +10008377static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008378os_pread_impl(PyObject *module, int fd, int length, Py_off_t offset)
8379/*[clinic end generated code: output=435b29ee32b54a78 input=084948dcbaa35d4c]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008380{
Ross Lagerwall7807c352011-03-17 20:20:30 +02008381 Py_ssize_t n;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008382 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008383 PyObject *buffer;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008384
Larry Hastings2f936352014-08-05 14:04:04 +10008385 if (length < 0) {
Ross Lagerwall7807c352011-03-17 20:20:30 +02008386 errno = EINVAL;
8387 return posix_error();
8388 }
Larry Hastings2f936352014-08-05 14:04:04 +10008389 buffer = PyBytes_FromStringAndSize((char *)NULL, length);
Ross Lagerwall7807c352011-03-17 20:20:30 +02008390 if (buffer == NULL)
8391 return NULL;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008392
8393 do {
8394 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04008395 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008396 n = pread(fd, PyBytes_AS_STRING(buffer), length, offset);
Steve Dower8fc89802015-04-12 00:26:27 -04008397 _Py_END_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008398 Py_END_ALLOW_THREADS
8399 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
8400
Ross Lagerwall7807c352011-03-17 20:20:30 +02008401 if (n < 0) {
8402 Py_DECREF(buffer);
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008403 return (!async_err) ? posix_error() : NULL;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008404 }
Larry Hastings2f936352014-08-05 14:04:04 +10008405 if (n != length)
Ross Lagerwall7807c352011-03-17 20:20:30 +02008406 _PyBytes_Resize(&buffer, n);
8407 return buffer;
8408}
Larry Hastings2f936352014-08-05 14:04:04 +10008409#endif /* HAVE_PREAD */
Ross Lagerwall7807c352011-03-17 20:20:30 +02008410
Pablo Galindo4defba32018-01-27 16:16:37 +00008411#if defined(HAVE_PREADV) || defined (HAVE_PREADV2)
8412/*[clinic input]
8413os.preadv -> Py_ssize_t
8414
8415 fd: int
8416 buffers: object
8417 offset: Py_off_t
8418 flags: int = 0
8419 /
8420
8421Reads from a file descriptor into a number of mutable bytes-like objects.
8422
8423Combines the functionality of readv() and pread(). As readv(), it will
8424transfer data into each buffer until it is full and then move on to the next
8425buffer in the sequence to hold the rest of the data. Its fourth argument,
8426specifies the file offset at which the input operation is to be performed. It
8427will return the total number of bytes read (which can be less than the total
8428capacity of all the objects).
8429
8430The flags argument contains a bitwise OR of zero or more of the following flags:
8431
8432- RWF_HIPRI
8433- RWF_NOWAIT
8434
8435Using non-zero flags requires Linux 4.6 or newer.
8436[clinic start generated code]*/
8437
8438static Py_ssize_t
8439os_preadv_impl(PyObject *module, int fd, PyObject *buffers, Py_off_t offset,
8440 int flags)
8441/*[clinic end generated code: output=26fc9c6e58e7ada5 input=4173919dc1f7ed99]*/
8442{
8443 Py_ssize_t cnt, n;
8444 int async_err = 0;
8445 struct iovec *iov;
8446 Py_buffer *buf;
8447
8448 if (!PySequence_Check(buffers)) {
8449 PyErr_SetString(PyExc_TypeError,
8450 "preadv2() arg 2 must be a sequence");
8451 return -1;
8452 }
8453
8454 cnt = PySequence_Size(buffers);
8455 if (cnt < 0) {
8456 return -1;
8457 }
8458
8459#ifndef HAVE_PREADV2
8460 if(flags != 0) {
8461 argument_unavailable_error("preadv2", "flags");
8462 return -1;
8463 }
8464#endif
8465
8466 if (iov_setup(&iov, &buf, buffers, cnt, PyBUF_WRITABLE) < 0) {
8467 return -1;
8468 }
8469#ifdef HAVE_PREADV2
8470 do {
8471 Py_BEGIN_ALLOW_THREADS
8472 _Py_BEGIN_SUPPRESS_IPH
8473 n = preadv2(fd, iov, cnt, offset, flags);
8474 _Py_END_SUPPRESS_IPH
8475 Py_END_ALLOW_THREADS
8476 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
8477#else
8478 do {
8479 Py_BEGIN_ALLOW_THREADS
8480 _Py_BEGIN_SUPPRESS_IPH
8481 n = preadv(fd, iov, cnt, offset);
8482 _Py_END_SUPPRESS_IPH
8483 Py_END_ALLOW_THREADS
8484 } while (n < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
8485#endif
8486
8487 iov_cleanup(iov, buf, cnt);
8488 if (n < 0) {
8489 if (!async_err) {
8490 posix_error();
8491 }
8492 return -1;
8493 }
8494
8495 return n;
8496}
8497#endif /* HAVE_PREADV */
8498
Larry Hastings2f936352014-08-05 14:04:04 +10008499
8500/*[clinic input]
8501os.write -> Py_ssize_t
8502
8503 fd: int
8504 data: Py_buffer
8505 /
8506
8507Write a bytes object to a file descriptor.
8508[clinic start generated code]*/
8509
Larry Hastings2f936352014-08-05 14:04:04 +10008510static Py_ssize_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008511os_write_impl(PyObject *module, int fd, Py_buffer *data)
8512/*[clinic end generated code: output=e4ef5bc904b58ef9 input=3207e28963234f3c]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008513{
Victor Stinner66aab0c2015-03-19 22:53:20 +01008514 return _Py_write(fd, data->buf, data->len);
Ross Lagerwall7807c352011-03-17 20:20:30 +02008515}
8516
8517#ifdef HAVE_SENDFILE
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008518PyDoc_STRVAR(posix_sendfile__doc__,
Martin Panterbf19d162015-09-09 01:01:13 +00008519"sendfile(out, in, offset, count) -> byteswritten\n\
Martin Panter94994132015-09-09 05:29:24 +00008520sendfile(out, in, offset, count[, headers][, trailers], flags=0)\n\
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008521 -> byteswritten\n\
Martin Panterbf19d162015-09-09 01:01:13 +00008522Copy count bytes from file descriptor in to file descriptor out.");
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008523
Larry Hastings2f936352014-08-05 14:04:04 +10008524/* AC 3.5: don't bother converting, has optional group*/
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008525static PyObject *
8526posix_sendfile(PyObject *self, PyObject *args, PyObject *kwdict)
8527{
8528 int in, out;
8529 Py_ssize_t ret;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008530 int async_err = 0;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008531 off_t offset;
8532
8533#if defined(__FreeBSD__) || defined(__DragonFly__) || defined(__APPLE__)
8534#ifndef __APPLE__
8535 Py_ssize_t len;
8536#endif
8537 PyObject *headers = NULL, *trailers = NULL;
8538 Py_buffer *hbuf, *tbuf;
8539 off_t sbytes;
8540 struct sf_hdtr sf;
8541 int flags = 0;
Martin Panterbf19d162015-09-09 01:01:13 +00008542 /* Beware that "in" clashes with Python's own "in" operator keyword */
Benjamin Petersond8a43b42011-02-26 21:35:16 +00008543 static char *keywords[] = {"out", "in",
8544 "offset", "count",
8545 "headers", "trailers", "flags", NULL};
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008546
Victor Stinner6ce0dbf2013-07-07 16:32:36 +02008547 sf.headers = NULL;
8548 sf.trailers = NULL;
8549
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008550#ifdef __APPLE__
8551 if (!PyArg_ParseTupleAndKeywords(args, kwdict, "iiO&O&|OOi:sendfile",
Larry Hastings2f936352014-08-05 14:04:04 +10008552 keywords, &out, &in, Py_off_t_converter, &offset, Py_off_t_converter, &sbytes,
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008553#else
8554 if (!PyArg_ParseTupleAndKeywords(args, kwdict, "iiO&n|OOi:sendfile",
Larry Hastings2f936352014-08-05 14:04:04 +10008555 keywords, &out, &in, Py_off_t_converter, &offset, &len,
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008556#endif
8557 &headers, &trailers, &flags))
8558 return NULL;
8559 if (headers != NULL) {
8560 if (!PySequence_Check(headers)) {
8561 PyErr_SetString(PyExc_TypeError,
Martin Panter94994132015-09-09 05:29:24 +00008562 "sendfile() headers must be a sequence");
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008563 return NULL;
8564 } else {
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008565 Py_ssize_t i = PySequence_Size(headers);
8566 if (i < 0)
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008567 return NULL;
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008568 if (i > INT_MAX) {
8569 PyErr_SetString(PyExc_OverflowError,
8570 "sendfile() header is too large");
8571 return NULL;
8572 }
8573 if (i > 0) {
8574 sf.hdr_cnt = (int)i;
8575 i = iov_setup(&(sf.headers), &hbuf,
8576 headers, sf.hdr_cnt, PyBUF_SIMPLE);
8577 if (i < 0)
8578 return NULL;
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00008579#ifdef __APPLE__
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008580 sbytes += i;
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00008581#endif
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008582 }
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008583 }
8584 }
8585 if (trailers != NULL) {
8586 if (!PySequence_Check(trailers)) {
8587 PyErr_SetString(PyExc_TypeError,
Martin Panter94994132015-09-09 05:29:24 +00008588 "sendfile() trailers must be a sequence");
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008589 return NULL;
8590 } else {
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008591 Py_ssize_t i = PySequence_Size(trailers);
8592 if (i < 0)
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008593 return NULL;
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008594 if (i > INT_MAX) {
8595 PyErr_SetString(PyExc_OverflowError,
8596 "sendfile() trailer is too large");
8597 return NULL;
8598 }
8599 if (i > 0) {
8600 sf.trl_cnt = (int)i;
8601 i = iov_setup(&(sf.trailers), &tbuf,
8602 trailers, sf.trl_cnt, PyBUF_SIMPLE);
8603 if (i < 0)
8604 return NULL;
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00008605#ifdef __APPLE__
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008606 sbytes += i;
Giampaolo Rodolàacdad9a2011-03-03 16:10:51 +00008607#endif
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008608 }
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008609 }
8610 }
8611
Steve Dower8fc89802015-04-12 00:26:27 -04008612 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008613 do {
8614 Py_BEGIN_ALLOW_THREADS
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008615#ifdef __APPLE__
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008616 ret = sendfile(in, out, offset, &sbytes, &sf, flags);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008617#else
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008618 ret = sendfile(in, out, offset, len, &sf, &sbytes, flags);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008619#endif
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008620 Py_END_ALLOW_THREADS
8621 } while (ret < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Steve Dower8fc89802015-04-12 00:26:27 -04008622 _Py_END_SUPPRESS_IPH
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008623
8624 if (sf.headers != NULL)
8625 iov_cleanup(sf.headers, hbuf, sf.hdr_cnt);
8626 if (sf.trailers != NULL)
8627 iov_cleanup(sf.trailers, tbuf, sf.trl_cnt);
8628
8629 if (ret < 0) {
8630 if ((errno == EAGAIN) || (errno == EBUSY)) {
8631 if (sbytes != 0) {
8632 // some data has been sent
8633 goto done;
8634 }
8635 else {
8636 // no data has been sent; upper application is supposed
8637 // to retry on EAGAIN or EBUSY
8638 return posix_error();
8639 }
8640 }
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008641 return (!async_err) ? posix_error() : NULL;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008642 }
8643 goto done;
8644
8645done:
8646 #if !defined(HAVE_LARGEFILE_SUPPORT)
8647 return Py_BuildValue("l", sbytes);
8648 #else
8649 return Py_BuildValue("L", sbytes);
8650 #endif
8651
8652#else
8653 Py_ssize_t count;
8654 PyObject *offobj;
8655 static char *keywords[] = {"out", "in",
8656 "offset", "count", NULL};
8657 if (!PyArg_ParseTupleAndKeywords(args, kwdict, "iiOn:sendfile",
8658 keywords, &out, &in, &offobj, &count))
8659 return NULL;
Benjamin Peterson840ef8f2016-09-07 14:45:10 -07008660#ifdef __linux__
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008661 if (offobj == Py_None) {
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008662 do {
8663 Py_BEGIN_ALLOW_THREADS
8664 ret = sendfile(out, in, NULL, count);
8665 Py_END_ALLOW_THREADS
8666 } while (ret < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008667 if (ret < 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008668 return (!async_err) ? posix_error() : NULL;
Giampaolo Rodola'ff1a7352011-04-19 09:47:16 +02008669 return Py_BuildValue("n", ret);
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008670 }
8671#endif
Larry Hastings2f936352014-08-05 14:04:04 +10008672 if (!Py_off_t_converter(offobj, &offset))
Antoine Pitroudcc20b82011-02-26 13:38:35 +00008673 return NULL;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008674
8675 do {
8676 Py_BEGIN_ALLOW_THREADS
8677 ret = sendfile(out, in, &offset, count);
8678 Py_END_ALLOW_THREADS
8679 } while (ret < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008680 if (ret < 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008681 return (!async_err) ? posix_error() : NULL;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +00008682 return Py_BuildValue("n", ret);
8683#endif
8684}
Larry Hastings2f936352014-08-05 14:04:04 +10008685#endif /* HAVE_SENDFILE */
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00008686
Larry Hastings2f936352014-08-05 14:04:04 +10008687
8688/*[clinic input]
8689os.fstat
8690
8691 fd : int
8692
8693Perform a stat system call on the given file descriptor.
8694
8695Like stat(), but for an open file descriptor.
8696Equivalent to os.stat(fd).
8697[clinic start generated code]*/
8698
Larry Hastings2f936352014-08-05 14:04:04 +10008699static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008700os_fstat_impl(PyObject *module, int fd)
8701/*[clinic end generated code: output=efc038cb5f654492 input=27e0e0ebbe5600c9]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008702{
Victor Stinner8c62be82010-05-06 00:08:46 +00008703 STRUCT_STAT st;
8704 int res;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008705 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10008706
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008707 do {
8708 Py_BEGIN_ALLOW_THREADS
8709 res = FSTAT(fd, &st);
8710 Py_END_ALLOW_THREADS
8711 } while (res != 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Victor Stinner8c62be82010-05-06 00:08:46 +00008712 if (res != 0) {
Martin v. Löwis14694662006-02-03 12:54:16 +00008713#ifdef MS_WINDOWS
Victor Stinnerb024e842012-10-31 22:24:06 +01008714 return PyErr_SetFromWindowsErr(0);
Martin v. Löwis14694662006-02-03 12:54:16 +00008715#else
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008716 return (!async_err) ? posix_error() : NULL;
Martin v. Löwis14694662006-02-03 12:54:16 +00008717#endif
Victor Stinner8c62be82010-05-06 00:08:46 +00008718 }
Tim Peters5aa91602002-01-30 05:46:57 +00008719
Victor Stinner4195b5c2012-02-08 23:03:19 +01008720 return _pystat_fromstructstat(&st);
Guido van Rossum687dd131993-05-17 08:34:16 +00008721}
8722
Larry Hastings2f936352014-08-05 14:04:04 +10008723
8724/*[clinic input]
8725os.isatty -> bool
8726 fd: int
8727 /
8728
8729Return True if the fd is connected to a terminal.
8730
8731Return True if the file descriptor is an open file descriptor
8732connected to the slave end of a terminal.
8733[clinic start generated code]*/
8734
Larry Hastings2f936352014-08-05 14:04:04 +10008735static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008736os_isatty_impl(PyObject *module, int fd)
8737/*[clinic end generated code: output=6a48c8b4e644ca00 input=08ce94aa1eaf7b5e]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008738{
Steve Dower8fc89802015-04-12 00:26:27 -04008739 int return_value;
Steve Dower8fc89802015-04-12 00:26:27 -04008740 _Py_BEGIN_SUPPRESS_IPH
8741 return_value = isatty(fd);
8742 _Py_END_SUPPRESS_IPH
8743 return return_value;
Larry Hastings2f936352014-08-05 14:04:04 +10008744}
8745
8746
Guido van Rossuma4916fa1996-05-23 22:58:55 +00008747#ifdef HAVE_PIPE
Larry Hastings2f936352014-08-05 14:04:04 +10008748/*[clinic input]
8749os.pipe
8750
8751Create a pipe.
8752
8753Returns a tuple of two file descriptors:
8754 (read_fd, write_fd)
8755[clinic start generated code]*/
8756
Larry Hastings2f936352014-08-05 14:04:04 +10008757static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008758os_pipe_impl(PyObject *module)
8759/*[clinic end generated code: output=ff9b76255793b440 input=02535e8c8fa6c4d4]*/
Guido van Rossum687dd131993-05-17 08:34:16 +00008760{
Victor Stinner8c62be82010-05-06 00:08:46 +00008761 int fds[2];
Victor Stinnerdaf45552013-08-28 00:53:59 +02008762#ifdef MS_WINDOWS
Victor Stinner8c62be82010-05-06 00:08:46 +00008763 HANDLE read, write;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008764 SECURITY_ATTRIBUTES attr;
Victor Stinner8c62be82010-05-06 00:08:46 +00008765 BOOL ok;
Victor Stinnerdaf45552013-08-28 00:53:59 +02008766#else
8767 int res;
8768#endif
8769
8770#ifdef MS_WINDOWS
8771 attr.nLength = sizeof(attr);
8772 attr.lpSecurityDescriptor = NULL;
8773 attr.bInheritHandle = FALSE;
8774
8775 Py_BEGIN_ALLOW_THREADS
Steve Dowerc3630612016-11-19 18:41:16 -08008776 _Py_BEGIN_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02008777 ok = CreatePipe(&read, &write, &attr, 0);
8778 if (ok) {
Benjamin Petersonca470632016-09-06 13:47:26 -07008779 fds[0] = _open_osfhandle((intptr_t)read, _O_RDONLY);
8780 fds[1] = _open_osfhandle((intptr_t)write, _O_WRONLY);
Victor Stinnerdaf45552013-08-28 00:53:59 +02008781 if (fds[0] == -1 || fds[1] == -1) {
8782 CloseHandle(read);
8783 CloseHandle(write);
8784 ok = 0;
8785 }
8786 }
Steve Dowerc3630612016-11-19 18:41:16 -08008787 _Py_END_SUPPRESS_IPH
Victor Stinnerdaf45552013-08-28 00:53:59 +02008788 Py_END_ALLOW_THREADS
8789
Victor Stinner8c62be82010-05-06 00:08:46 +00008790 if (!ok)
Victor Stinnerb024e842012-10-31 22:24:06 +01008791 return PyErr_SetFromWindowsErr(0);
Victor Stinnerdaf45552013-08-28 00:53:59 +02008792#else
8793
8794#ifdef HAVE_PIPE2
8795 Py_BEGIN_ALLOW_THREADS
8796 res = pipe2(fds, O_CLOEXEC);
8797 Py_END_ALLOW_THREADS
8798
8799 if (res != 0 && errno == ENOSYS)
8800 {
8801#endif
8802 Py_BEGIN_ALLOW_THREADS
8803 res = pipe(fds);
8804 Py_END_ALLOW_THREADS
8805
8806 if (res == 0) {
8807 if (_Py_set_inheritable(fds[0], 0, NULL) < 0) {
8808 close(fds[0]);
8809 close(fds[1]);
8810 return NULL;
8811 }
8812 if (_Py_set_inheritable(fds[1], 0, NULL) < 0) {
8813 close(fds[0]);
8814 close(fds[1]);
8815 return NULL;
8816 }
8817 }
8818#ifdef HAVE_PIPE2
8819 }
8820#endif
8821
8822 if (res != 0)
8823 return PyErr_SetFromErrno(PyExc_OSError);
8824#endif /* !MS_WINDOWS */
8825 return Py_BuildValue("(ii)", fds[0], fds[1]);
Guido van Rossum687dd131993-05-17 08:34:16 +00008826}
Guido van Rossuma4916fa1996-05-23 22:58:55 +00008827#endif /* HAVE_PIPE */
8828
Larry Hastings2f936352014-08-05 14:04:04 +10008829
Charles-François Natalidaafdd52011-05-29 20:07:40 +02008830#ifdef HAVE_PIPE2
Larry Hastings2f936352014-08-05 14:04:04 +10008831/*[clinic input]
8832os.pipe2
8833
8834 flags: int
8835 /
8836
8837Create a pipe with flags set atomically.
8838
8839Returns a tuple of two file descriptors:
8840 (read_fd, write_fd)
8841
8842flags can be constructed by ORing together one or more of these values:
8843O_NONBLOCK, O_CLOEXEC.
8844[clinic start generated code]*/
8845
Larry Hastings2f936352014-08-05 14:04:04 +10008846static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008847os_pipe2_impl(PyObject *module, int flags)
8848/*[clinic end generated code: output=25751fb43a45540f input=f261b6e7e63c6817]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008849{
Charles-François Natalidaafdd52011-05-29 20:07:40 +02008850 int fds[2];
8851 int res;
8852
Charles-François Natalidaafdd52011-05-29 20:07:40 +02008853 res = pipe2(fds, flags);
8854 if (res != 0)
8855 return posix_error();
8856 return Py_BuildValue("(ii)", fds[0], fds[1]);
8857}
8858#endif /* HAVE_PIPE2 */
8859
Larry Hastings2f936352014-08-05 14:04:04 +10008860
Ross Lagerwall7807c352011-03-17 20:20:30 +02008861#ifdef HAVE_WRITEV
Larry Hastings2f936352014-08-05 14:04:04 +10008862/*[clinic input]
8863os.writev -> Py_ssize_t
8864 fd: int
8865 buffers: object
8866 /
8867
8868Iterate over buffers, and write the contents of each to a file descriptor.
8869
8870Returns the total number of bytes written.
8871buffers must be a sequence of bytes-like objects.
8872[clinic start generated code]*/
8873
Larry Hastings2f936352014-08-05 14:04:04 +10008874static Py_ssize_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008875os_writev_impl(PyObject *module, int fd, PyObject *buffers)
8876/*[clinic end generated code: output=56565cfac3aac15b input=5b8d17fe4189d2fe]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008877{
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008878 Py_ssize_t cnt;
Larry Hastings2f936352014-08-05 14:04:04 +10008879 Py_ssize_t result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008880 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008881 struct iovec *iov;
8882 Py_buffer *buf;
Larry Hastings2f936352014-08-05 14:04:04 +10008883
8884 if (!PySequence_Check(buffers)) {
Ross Lagerwall7807c352011-03-17 20:20:30 +02008885 PyErr_SetString(PyExc_TypeError,
8886 "writev() arg 2 must be a sequence");
Larry Hastings2f936352014-08-05 14:04:04 +10008887 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008888 }
Larry Hastings2f936352014-08-05 14:04:04 +10008889 cnt = PySequence_Size(buffers);
Serhiy Storchakabf623ae2017-04-19 20:03:52 +03008890 if (cnt < 0)
8891 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008892
Larry Hastings2f936352014-08-05 14:04:04 +10008893 if (iov_setup(&iov, &buf, buffers, cnt, PyBUF_SIMPLE) < 0) {
8894 return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008895 }
8896
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008897 do {
8898 Py_BEGIN_ALLOW_THREADS
8899 result = writev(fd, iov, cnt);
8900 Py_END_ALLOW_THREADS
8901 } while (result < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Ross Lagerwall7807c352011-03-17 20:20:30 +02008902
8903 iov_cleanup(iov, buf, cnt);
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008904 if (result < 0 && !async_err)
Larry Hastings2f936352014-08-05 14:04:04 +10008905 posix_error();
Victor Stinner57ddf782014-01-08 15:21:28 +01008906
Georg Brandl306336b2012-06-24 12:55:33 +02008907 return result;
Ross Lagerwall7807c352011-03-17 20:20:30 +02008908}
Larry Hastings2f936352014-08-05 14:04:04 +10008909#endif /* HAVE_WRITEV */
8910
8911
8912#ifdef HAVE_PWRITE
8913/*[clinic input]
8914os.pwrite -> Py_ssize_t
8915
8916 fd: int
8917 buffer: Py_buffer
8918 offset: Py_off_t
8919 /
8920
8921Write bytes to a file descriptor starting at a particular offset.
8922
8923Write buffer to fd, starting at offset bytes from the beginning of
8924the file. Returns the number of bytes writte. Does not change the
8925current file offset.
8926[clinic start generated code]*/
8927
Larry Hastings2f936352014-08-05 14:04:04 +10008928static Py_ssize_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03008929os_pwrite_impl(PyObject *module, int fd, Py_buffer *buffer, Py_off_t offset)
8930/*[clinic end generated code: output=c74da630758ee925 input=19903f1b3dd26377]*/
Larry Hastings2f936352014-08-05 14:04:04 +10008931{
8932 Py_ssize_t size;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008933 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10008934
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008935 do {
8936 Py_BEGIN_ALLOW_THREADS
Steve Dower8fc89802015-04-12 00:26:27 -04008937 _Py_BEGIN_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008938 size = pwrite(fd, buffer->buf, (size_t)buffer->len, offset);
Steve Dower8fc89802015-04-12 00:26:27 -04008939 _Py_END_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008940 Py_END_ALLOW_THREADS
8941 } while (size < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
Larry Hastings2f936352014-08-05 14:04:04 +10008942
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00008943 if (size < 0 && !async_err)
Larry Hastings2f936352014-08-05 14:04:04 +10008944 posix_error();
8945 return size;
8946}
8947#endif /* HAVE_PWRITE */
8948
Pablo Galindo4defba32018-01-27 16:16:37 +00008949#if defined(HAVE_PWRITEV) || defined (HAVE_PWRITEV2)
8950/*[clinic input]
8951os.pwritev -> Py_ssize_t
8952
8953 fd: int
8954 buffers: object
8955 offset: Py_off_t
8956 flags: int = 0
8957 /
8958
8959Writes the contents of bytes-like objects to a file descriptor at a given offset.
8960
8961Combines the functionality of writev() and pwrite(). All buffers must be a sequence
8962of bytes-like objects. Buffers are processed in array order. Entire contents of first
8963buffer is written before proceeding to second, and so on. The operating system may
8964set a limit (sysconf() value SC_IOV_MAX) on the number of buffers that can be used.
8965This function writes the contents of each object to the file descriptor and returns
8966the total number of bytes written.
8967
8968The flags argument contains a bitwise OR of zero or more of the following flags:
8969
8970- RWF_DSYNC
8971- RWF_SYNC
8972
8973Using non-zero flags requires Linux 4.7 or newer.
8974[clinic start generated code]*/
8975
8976static Py_ssize_t
8977os_pwritev_impl(PyObject *module, int fd, PyObject *buffers, Py_off_t offset,
8978 int flags)
8979/*[clinic end generated code: output=e3dd3e9d11a6a5c7 input=803dc5ddbf0cfd3b]*/
8980{
8981 Py_ssize_t cnt;
8982 Py_ssize_t result;
8983 int async_err = 0;
8984 struct iovec *iov;
8985 Py_buffer *buf;
8986
8987 if (!PySequence_Check(buffers)) {
8988 PyErr_SetString(PyExc_TypeError,
8989 "pwritev() arg 2 must be a sequence");
8990 return -1;
8991 }
8992
8993 cnt = PySequence_Size(buffers);
8994 if (cnt < 0) {
8995 return -1;
8996 }
8997
8998#ifndef HAVE_PWRITEV2
8999 if(flags != 0) {
9000 argument_unavailable_error("pwritev2", "flags");
9001 return -1;
9002 }
9003#endif
9004
9005 if (iov_setup(&iov, &buf, buffers, cnt, PyBUF_SIMPLE) < 0) {
9006 return -1;
9007 }
9008#ifdef HAVE_PWRITEV2
9009 do {
9010 Py_BEGIN_ALLOW_THREADS
9011 _Py_BEGIN_SUPPRESS_IPH
9012 result = pwritev2(fd, iov, cnt, offset, flags);
9013 _Py_END_SUPPRESS_IPH
9014 Py_END_ALLOW_THREADS
9015 } while (result < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
9016#else
9017 do {
9018 Py_BEGIN_ALLOW_THREADS
9019 _Py_BEGIN_SUPPRESS_IPH
9020 result = pwritev(fd, iov, cnt, offset);
9021 _Py_END_SUPPRESS_IPH
9022 Py_END_ALLOW_THREADS
9023 } while (result < 0 && errno == EINTR && !(async_err = PyErr_CheckSignals()));
9024#endif
9025
9026 iov_cleanup(iov, buf, cnt);
9027 if (result < 0) {
9028 if (!async_err) {
9029 posix_error();
9030 }
9031 return -1;
9032 }
9033
9034 return result;
9035}
9036#endif /* HAVE_PWRITEV */
9037
9038
9039
Larry Hastings2f936352014-08-05 14:04:04 +10009040
9041#ifdef HAVE_MKFIFO
9042/*[clinic input]
9043os.mkfifo
9044
9045 path: path_t
9046 mode: int=0o666
9047 *
9048 dir_fd: dir_fd(requires='mkfifoat')=None
9049
9050Create a "fifo" (a POSIX named pipe).
9051
9052If dir_fd is not None, it should be a file descriptor open to a directory,
9053 and path should be relative; path will then be relative to that directory.
9054dir_fd may not be implemented on your platform.
9055 If it is unavailable, using it will raise a NotImplementedError.
9056[clinic start generated code]*/
9057
Larry Hastings2f936352014-08-05 14:04:04 +10009058static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009059os_mkfifo_impl(PyObject *module, path_t *path, int mode, int dir_fd)
9060/*[clinic end generated code: output=ce41cfad0e68c940 input=73032e98a36e0e19]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009061{
9062 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009063 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10009064
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009065 do {
9066 Py_BEGIN_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10009067#ifdef HAVE_MKFIFOAT
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009068 if (dir_fd != DEFAULT_DIR_FD)
9069 result = mkfifoat(dir_fd, path->narrow, mode);
9070 else
Ross Lagerwall7807c352011-03-17 20:20:30 +02009071#endif
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009072 result = mkfifo(path->narrow, mode);
9073 Py_END_ALLOW_THREADS
9074 } while (result != 0 && errno == EINTR &&
9075 !(async_err = PyErr_CheckSignals()));
9076 if (result != 0)
9077 return (!async_err) ? posix_error() : NULL;
Larry Hastings2f936352014-08-05 14:04:04 +10009078
9079 Py_RETURN_NONE;
9080}
9081#endif /* HAVE_MKFIFO */
9082
9083
9084#if defined(HAVE_MKNOD) && defined(HAVE_MAKEDEV)
9085/*[clinic input]
9086os.mknod
9087
9088 path: path_t
9089 mode: int=0o600
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +02009090 device: dev_t=0
Larry Hastings2f936352014-08-05 14:04:04 +10009091 *
9092 dir_fd: dir_fd(requires='mknodat')=None
9093
9094Create a node in the file system.
9095
9096Create a node in the file system (file, device special file or named pipe)
9097at path. mode specifies both the permissions to use and the
9098type of node to be created, being combined (bitwise OR) with one of
9099S_IFREG, S_IFCHR, S_IFBLK, and S_IFIFO. If S_IFCHR or S_IFBLK is set on mode,
9100device defines the newly created device special file (probably using
9101os.makedev()). Otherwise device is ignored.
9102
9103If dir_fd is not None, it should be a file descriptor open to a directory,
9104 and path should be relative; path will then be relative to that directory.
9105dir_fd may not be implemented on your platform.
9106 If it is unavailable, using it will raise a NotImplementedError.
9107[clinic start generated code]*/
9108
Larry Hastings2f936352014-08-05 14:04:04 +10009109static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009110os_mknod_impl(PyObject *module, path_t *path, int mode, dev_t device,
Larry Hastings89964c42015-04-14 18:07:59 -04009111 int dir_fd)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009112/*[clinic end generated code: output=92e55d3ca8917461 input=ee44531551a4d83b]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009113{
9114 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009115 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10009116
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009117 do {
9118 Py_BEGIN_ALLOW_THREADS
Larry Hastings2f936352014-08-05 14:04:04 +10009119#ifdef HAVE_MKNODAT
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009120 if (dir_fd != DEFAULT_DIR_FD)
9121 result = mknodat(dir_fd, path->narrow, mode, device);
9122 else
Larry Hastings2f936352014-08-05 14:04:04 +10009123#endif
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009124 result = mknod(path->narrow, mode, device);
9125 Py_END_ALLOW_THREADS
9126 } while (result != 0 && errno == EINTR &&
9127 !(async_err = PyErr_CheckSignals()));
9128 if (result != 0)
9129 return (!async_err) ? posix_error() : NULL;
Larry Hastings2f936352014-08-05 14:04:04 +10009130
9131 Py_RETURN_NONE;
9132}
9133#endif /* defined(HAVE_MKNOD) && defined(HAVE_MAKEDEV) */
9134
9135
9136#ifdef HAVE_DEVICE_MACROS
9137/*[clinic input]
9138os.major -> unsigned_int
9139
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +02009140 device: dev_t
Larry Hastings2f936352014-08-05 14:04:04 +10009141 /
9142
9143Extracts a device major number from a raw device number.
9144[clinic start generated code]*/
9145
Larry Hastings2f936352014-08-05 14:04:04 +10009146static unsigned int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009147os_major_impl(PyObject *module, dev_t device)
9148/*[clinic end generated code: output=5b3b2589bafb498e input=1e16a4d30c4d4462]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009149{
9150 return major(device);
9151}
9152
9153
9154/*[clinic input]
9155os.minor -> unsigned_int
9156
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +02009157 device: dev_t
Larry Hastings2f936352014-08-05 14:04:04 +10009158 /
9159
9160Extracts a device minor number from a raw device number.
9161[clinic start generated code]*/
9162
Larry Hastings2f936352014-08-05 14:04:04 +10009163static unsigned int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009164os_minor_impl(PyObject *module, dev_t device)
9165/*[clinic end generated code: output=5e1a25e630b0157d input=0842c6d23f24c65e]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009166{
9167 return minor(device);
9168}
9169
9170
9171/*[clinic input]
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +02009172os.makedev -> dev_t
Larry Hastings2f936352014-08-05 14:04:04 +10009173
9174 major: int
9175 minor: int
9176 /
9177
9178Composes a raw device number from the major and minor device numbers.
9179[clinic start generated code]*/
9180
Serhiy Storchakaacdb7c12015-01-18 11:17:39 +02009181static dev_t
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009182os_makedev_impl(PyObject *module, int major, int minor)
9183/*[clinic end generated code: output=881aaa4aba6f6a52 input=4b9fd8fc73cbe48f]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009184{
9185 return makedev(major, minor);
9186}
9187#endif /* HAVE_DEVICE_MACROS */
9188
9189
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009190#if defined HAVE_FTRUNCATE || defined MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10009191/*[clinic input]
9192os.ftruncate
9193
9194 fd: int
9195 length: Py_off_t
9196 /
9197
9198Truncate a file, specified by file descriptor, to a specific length.
9199[clinic start generated code]*/
9200
Larry Hastings2f936352014-08-05 14:04:04 +10009201static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009202os_ftruncate_impl(PyObject *module, int fd, Py_off_t length)
9203/*[clinic end generated code: output=fba15523721be7e4 input=63b43641e52818f2]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009204{
9205 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009206 int async_err = 0;
Larry Hastings2f936352014-08-05 14:04:04 +10009207
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009208 do {
9209 Py_BEGIN_ALLOW_THREADS
Steve Dowera1c7e722015-04-12 00:26:43 -04009210 _Py_BEGIN_SUPPRESS_IPH
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009211#ifdef MS_WINDOWS
9212 result = _chsize_s(fd, length);
9213#else
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009214 result = ftruncate(fd, length);
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009215#endif
Steve Dowera1c7e722015-04-12 00:26:43 -04009216 _Py_END_SUPPRESS_IPH
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009217 Py_END_ALLOW_THREADS
9218 } while (result != 0 && errno == EINTR &&
9219 !(async_err = PyErr_CheckSignals()));
9220 if (result != 0)
9221 return (!async_err) ? posix_error() : NULL;
Larry Hastings2f936352014-08-05 14:04:04 +10009222 Py_RETURN_NONE;
9223}
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009224#endif /* HAVE_FTRUNCATE || MS_WINDOWS */
Larry Hastings2f936352014-08-05 14:04:04 +10009225
9226
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009227#if defined HAVE_TRUNCATE || defined MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10009228/*[clinic input]
9229os.truncate
9230 path: path_t(allow_fd='PATH_HAVE_FTRUNCATE')
9231 length: Py_off_t
9232
9233Truncate a file, specified by path, to a specific length.
9234
9235On some platforms, path may also be specified as an open file descriptor.
9236 If this functionality is unavailable, using it raises an exception.
9237[clinic start generated code]*/
9238
Larry Hastings2f936352014-08-05 14:04:04 +10009239static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009240os_truncate_impl(PyObject *module, path_t *path, Py_off_t length)
9241/*[clinic end generated code: output=43009c8df5c0a12b input=77229cf0b50a9b77]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009242{
9243 int result;
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009244#ifdef MS_WINDOWS
9245 int fd;
9246#endif
9247
9248 if (path->fd != -1)
9249 return os_ftruncate_impl(module, path->fd, length);
Larry Hastings2f936352014-08-05 14:04:04 +10009250
9251 Py_BEGIN_ALLOW_THREADS
Steve Dowera1c7e722015-04-12 00:26:43 -04009252 _Py_BEGIN_SUPPRESS_IPH
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009253#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -07009254 fd = _wopen(path->wide, _O_WRONLY | _O_BINARY | _O_NOINHERIT);
Victor Stinnercc0bbbc2015-04-25 00:21:52 +02009255 if (fd < 0)
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009256 result = -1;
9257 else {
9258 result = _chsize_s(fd, length);
9259 close(fd);
9260 if (result < 0)
9261 errno = result;
9262 }
9263#else
9264 result = truncate(path->narrow, length);
Larry Hastings2f936352014-08-05 14:04:04 +10009265#endif
Steve Dowera1c7e722015-04-12 00:26:43 -04009266 _Py_END_SUPPRESS_IPH
Larry Hastings2f936352014-08-05 14:04:04 +10009267 Py_END_ALLOW_THREADS
9268 if (result < 0)
9269 return path_error(path);
9270
9271 Py_RETURN_NONE;
9272}
Steve Dowerfe0a41a2015-03-20 19:50:46 -07009273#endif /* HAVE_TRUNCATE || MS_WINDOWS */
Larry Hastings2f936352014-08-05 14:04:04 +10009274
Ross Lagerwall7807c352011-03-17 20:20:30 +02009275
Victor Stinnerd6b17692014-09-30 12:20:05 +02009276/* Issue #22396: On 32-bit AIX platform, the prototypes of os.posix_fadvise()
9277 and os.posix_fallocate() in system headers are wrong if _LARGE_FILES is
9278 defined, which is the case in Python on AIX. AIX bug report:
9279 http://www-01.ibm.com/support/docview.wss?uid=isg1IV56170 */
9280#if defined(_AIX) && defined(_LARGE_FILES) && !defined(__64BIT__)
9281# define POSIX_FADVISE_AIX_BUG
9282#endif
9283
Victor Stinnerec39e262014-09-30 12:35:58 +02009284
Victor Stinnerd6b17692014-09-30 12:20:05 +02009285#if defined(HAVE_POSIX_FALLOCATE) && !defined(POSIX_FADVISE_AIX_BUG)
Larry Hastings2f936352014-08-05 14:04:04 +10009286/*[clinic input]
9287os.posix_fallocate
9288
9289 fd: int
9290 offset: Py_off_t
9291 length: Py_off_t
9292 /
9293
9294Ensure a file has allocated at least a particular number of bytes on disk.
9295
9296Ensure that the file specified by fd encompasses a range of bytes
9297starting at offset bytes from the beginning and continuing for length bytes.
9298[clinic start generated code]*/
9299
Larry Hastings2f936352014-08-05 14:04:04 +10009300static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009301os_posix_fallocate_impl(PyObject *module, int fd, Py_off_t offset,
Larry Hastings89964c42015-04-14 18:07:59 -04009302 Py_off_t length)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009303/*[clinic end generated code: output=73f107139564aa9d input=d7a2ef0ab2ca52fb]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009304{
9305 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009306 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009307
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009308 do {
9309 Py_BEGIN_ALLOW_THREADS
9310 result = posix_fallocate(fd, offset, length);
9311 Py_END_ALLOW_THREADS
Коренберг Маркd4b93e22017-08-14 18:55:16 +05009312 } while (result == EINTR && !(async_err = PyErr_CheckSignals()));
9313
9314 if (result == 0)
9315 Py_RETURN_NONE;
9316
9317 if (async_err)
9318 return NULL;
9319
9320 errno = result;
9321 return posix_error();
Ross Lagerwall7807c352011-03-17 20:20:30 +02009322}
Victor Stinnerec39e262014-09-30 12:35:58 +02009323#endif /* HAVE_POSIX_FALLOCATE) && !POSIX_FADVISE_AIX_BUG */
Larry Hastings2f936352014-08-05 14:04:04 +10009324
Ross Lagerwall7807c352011-03-17 20:20:30 +02009325
Victor Stinnerd6b17692014-09-30 12:20:05 +02009326#if defined(HAVE_POSIX_FADVISE) && !defined(POSIX_FADVISE_AIX_BUG)
Larry Hastings2f936352014-08-05 14:04:04 +10009327/*[clinic input]
9328os.posix_fadvise
9329
9330 fd: int
9331 offset: Py_off_t
9332 length: Py_off_t
9333 advice: int
9334 /
9335
9336Announce an intention to access data in a specific pattern.
9337
9338Announce an intention to access data in a specific pattern, thus allowing
9339the kernel to make optimizations.
9340The advice applies to the region of the file specified by fd starting at
9341offset and continuing for length bytes.
9342advice is one of POSIX_FADV_NORMAL, POSIX_FADV_SEQUENTIAL,
9343POSIX_FADV_RANDOM, POSIX_FADV_NOREUSE, POSIX_FADV_WILLNEED, or
9344POSIX_FADV_DONTNEED.
9345[clinic start generated code]*/
9346
Larry Hastings2f936352014-08-05 14:04:04 +10009347static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009348os_posix_fadvise_impl(PyObject *module, int fd, Py_off_t offset,
Larry Hastings89964c42015-04-14 18:07:59 -04009349 Py_off_t length, int advice)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009350/*[clinic end generated code: output=412ef4aa70c98642 input=0fbe554edc2f04b5]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009351{
9352 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009353 int async_err = 0;
Ross Lagerwall7807c352011-03-17 20:20:30 +02009354
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009355 do {
9356 Py_BEGIN_ALLOW_THREADS
9357 result = posix_fadvise(fd, offset, length, advice);
9358 Py_END_ALLOW_THREADS
Коренберг Маркd4b93e22017-08-14 18:55:16 +05009359 } while (result == EINTR && !(async_err = PyErr_CheckSignals()));
9360
9361 if (result == 0)
9362 Py_RETURN_NONE;
9363
9364 if (async_err)
9365 return NULL;
9366
9367 errno = result;
9368 return posix_error();
Ross Lagerwall7807c352011-03-17 20:20:30 +02009369}
Victor Stinnerec39e262014-09-30 12:35:58 +02009370#endif /* HAVE_POSIX_FADVISE && !POSIX_FADVISE_AIX_BUG */
Ross Lagerwall7807c352011-03-17 20:20:30 +02009371
Guido van Rossumf1af3fe1996-07-23 19:18:10 +00009372#ifdef HAVE_PUTENV
Guido van Rossumec4f4ac1997-06-02 22:20:51 +00009373
Fred Drake762e2061999-08-26 17:23:54 +00009374/* Save putenv() parameters as values here, so we can collect them when they
9375 * get re-set with another call for the same key. */
9376static PyObject *posix_putenv_garbage;
9377
Larry Hastings2f936352014-08-05 14:04:04 +10009378static void
9379posix_putenv_garbage_setitem(PyObject *name, PyObject *value)
Guido van Rossumf1af3fe1996-07-23 19:18:10 +00009380{
Larry Hastings2f936352014-08-05 14:04:04 +10009381 /* Install the first arg and newstr in posix_putenv_garbage;
9382 * this will cause previous value to be collected. This has to
9383 * happen after the real putenv() call because the old value
9384 * was still accessible until then. */
9385 if (PyDict_SetItem(posix_putenv_garbage, name, value))
9386 /* really not much we can do; just leak */
9387 PyErr_Clear();
9388 else
9389 Py_DECREF(value);
9390}
9391
9392
Thomas Hellerf78f12a2007-11-08 19:33:05 +00009393#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10009394/*[clinic input]
9395os.putenv
9396
9397 name: unicode
9398 value: unicode
9399 /
9400
9401Change or add an environment variable.
9402[clinic start generated code]*/
9403
Larry Hastings2f936352014-08-05 14:04:04 +10009404static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009405os_putenv_impl(PyObject *module, PyObject *name, PyObject *value)
9406/*[clinic end generated code: output=d29a567d6b2327d2 input=ba586581c2e6105f]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009407{
Serhiy Storchakadeab18d2016-05-07 16:45:18 +03009408 const wchar_t *env;
Serhiy Storchakaf7eae0a2017-06-28 08:30:06 +03009409 Py_ssize_t size;
Larry Hastings2f936352014-08-05 14:04:04 +10009410
Serhiy Storchaka77703942017-06-25 07:33:01 +03009411 /* Search from index 1 because on Windows starting '=' is allowed for
9412 defining hidden environment variables. */
9413 if (PyUnicode_GET_LENGTH(name) == 0 ||
9414 PyUnicode_FindChar(name, '=', 1, PyUnicode_GET_LENGTH(name), 1) != -1)
9415 {
9416 PyErr_SetString(PyExc_ValueError, "illegal environment variable name");
9417 return NULL;
9418 }
Larry Hastings2f936352014-08-05 14:04:04 +10009419 PyObject *unicode = PyUnicode_FromFormat("%U=%U", name, value);
9420 if (unicode == NULL) {
Larry Hastings2f936352014-08-05 14:04:04 +10009421 return NULL;
Victor Stinner84ae1182010-05-06 22:05:07 +00009422 }
Serhiy Storchakaf7eae0a2017-06-28 08:30:06 +03009423
9424 env = PyUnicode_AsUnicodeAndSize(unicode, &size);
9425 if (env == NULL)
9426 goto error;
9427 if (size > _MAX_ENV) {
Victor Stinner65170952011-11-22 22:16:17 +01009428 PyErr_Format(PyExc_ValueError,
9429 "the environment variable is longer than %u characters",
9430 _MAX_ENV);
9431 goto error;
9432 }
Serhiy Storchakaf7eae0a2017-06-28 08:30:06 +03009433 if (wcslen(env) != (size_t)size) {
9434 PyErr_SetString(PyExc_ValueError, "embedded null character");
Victor Stinnereb5657a2011-09-30 01:44:27 +02009435 goto error;
Serhiy Storchakaf7eae0a2017-06-28 08:30:06 +03009436 }
9437
Larry Hastings2f936352014-08-05 14:04:04 +10009438 if (_wputenv(env)) {
Victor Stinner8c62be82010-05-06 00:08:46 +00009439 posix_error();
Victor Stinner84ae1182010-05-06 22:05:07 +00009440 goto error;
Victor Stinner8c62be82010-05-06 00:08:46 +00009441 }
Guido van Rossumf1af3fe1996-07-23 19:18:10 +00009442
Larry Hastings2f936352014-08-05 14:04:04 +10009443 posix_putenv_garbage_setitem(name, unicode);
Victor Stinner84ae1182010-05-06 22:05:07 +00009444 Py_RETURN_NONE;
9445
9446error:
Larry Hastings2f936352014-08-05 14:04:04 +10009447 Py_DECREF(unicode);
Victor Stinner84ae1182010-05-06 22:05:07 +00009448 return NULL;
Guido van Rossumf1af3fe1996-07-23 19:18:10 +00009449}
Larry Hastings2f936352014-08-05 14:04:04 +10009450#else /* MS_WINDOWS */
9451/*[clinic input]
9452os.putenv
Guido van Rossumb6a47161997-09-15 22:54:34 +00009453
Larry Hastings2f936352014-08-05 14:04:04 +10009454 name: FSConverter
9455 value: FSConverter
9456 /
9457
9458Change or add an environment variable.
9459[clinic start generated code]*/
9460
Larry Hastings2f936352014-08-05 14:04:04 +10009461static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009462os_putenv_impl(PyObject *module, PyObject *name, PyObject *value)
9463/*[clinic end generated code: output=d29a567d6b2327d2 input=a97bc6152f688d31]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009464{
9465 PyObject *bytes = NULL;
9466 char *env;
Serhiy Storchaka77703942017-06-25 07:33:01 +03009467 const char *name_string = PyBytes_AS_STRING(name);
9468 const char *value_string = PyBytes_AS_STRING(value);
Larry Hastings2f936352014-08-05 14:04:04 +10009469
Serhiy Storchaka77703942017-06-25 07:33:01 +03009470 if (strchr(name_string, '=') != NULL) {
9471 PyErr_SetString(PyExc_ValueError, "illegal environment variable name");
9472 return NULL;
9473 }
Larry Hastings2f936352014-08-05 14:04:04 +10009474 bytes = PyBytes_FromFormat("%s=%s", name_string, value_string);
9475 if (bytes == NULL) {
Larry Hastings2f936352014-08-05 14:04:04 +10009476 return NULL;
9477 }
9478
9479 env = PyBytes_AS_STRING(bytes);
9480 if (putenv(env)) {
9481 Py_DECREF(bytes);
9482 return posix_error();
9483 }
9484
9485 posix_putenv_garbage_setitem(name, bytes);
9486 Py_RETURN_NONE;
9487}
9488#endif /* MS_WINDOWS */
9489#endif /* HAVE_PUTENV */
9490
9491
9492#ifdef HAVE_UNSETENV
9493/*[clinic input]
9494os.unsetenv
9495 name: FSConverter
9496 /
9497
9498Delete an environment variable.
9499[clinic start generated code]*/
9500
Larry Hastings2f936352014-08-05 14:04:04 +10009501static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009502os_unsetenv_impl(PyObject *module, PyObject *name)
9503/*[clinic end generated code: output=54c4137ab1834f02 input=2bb5288a599c7107]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009504{
Victor Stinner984890f2011-11-24 13:53:38 +01009505#ifndef HAVE_BROKEN_UNSETENV
Victor Stinner60b385e2011-11-22 22:01:28 +01009506 int err;
Victor Stinner984890f2011-11-24 13:53:38 +01009507#endif
Victor Stinner84ae1182010-05-06 22:05:07 +00009508
Victor Stinner984890f2011-11-24 13:53:38 +01009509#ifdef HAVE_BROKEN_UNSETENV
9510 unsetenv(PyBytes_AS_STRING(name));
9511#else
Victor Stinner65170952011-11-22 22:16:17 +01009512 err = unsetenv(PyBytes_AS_STRING(name));
Larry Hastings2f936352014-08-05 14:04:04 +10009513 if (err)
Victor Stinner60b385e2011-11-22 22:01:28 +01009514 return posix_error();
Victor Stinner984890f2011-11-24 13:53:38 +01009515#endif
Guido van Rossumc524d952001-10-19 01:31:59 +00009516
Victor Stinner8c62be82010-05-06 00:08:46 +00009517 /* Remove the key from posix_putenv_garbage;
9518 * this will cause it to be collected. This has to
9519 * happen after the real unsetenv() call because the
9520 * old value was still accessible until then.
9521 */
Victor Stinner65170952011-11-22 22:16:17 +01009522 if (PyDict_DelItem(posix_putenv_garbage, name)) {
Victor Stinner8c62be82010-05-06 00:08:46 +00009523 /* really not much we can do; just leak */
9524 PyErr_Clear();
9525 }
Victor Stinner84ae1182010-05-06 22:05:07 +00009526 Py_RETURN_NONE;
Guido van Rossumc524d952001-10-19 01:31:59 +00009527}
Larry Hastings2f936352014-08-05 14:04:04 +10009528#endif /* HAVE_UNSETENV */
Guido van Rossumc524d952001-10-19 01:31:59 +00009529
Larry Hastings2f936352014-08-05 14:04:04 +10009530
9531/*[clinic input]
9532os.strerror
9533
9534 code: int
9535 /
9536
9537Translate an error code to a message string.
9538[clinic start generated code]*/
9539
Larry Hastings2f936352014-08-05 14:04:04 +10009540static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009541os_strerror_impl(PyObject *module, int code)
9542/*[clinic end generated code: output=baebf09fa02a78f2 input=75a8673d97915a91]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009543{
9544 char *message = strerror(code);
Victor Stinner8c62be82010-05-06 00:08:46 +00009545 if (message == NULL) {
9546 PyErr_SetString(PyExc_ValueError,
9547 "strerror() argument out of range");
9548 return NULL;
9549 }
Victor Stinner1b579672011-12-17 05:47:23 +01009550 return PyUnicode_DecodeLocale(message, "surrogateescape");
Guido van Rossumb6a47161997-09-15 22:54:34 +00009551}
Guido van Rossumb6a47161997-09-15 22:54:34 +00009552
Guido van Rossumf1af3fe1996-07-23 19:18:10 +00009553
Guido van Rossumc9641791998-08-04 15:26:23 +00009554#ifdef HAVE_SYS_WAIT_H
Fred Drake106c1a02002-04-23 15:58:02 +00009555#ifdef WCOREDUMP
Larry Hastings2f936352014-08-05 14:04:04 +10009556/*[clinic input]
9557os.WCOREDUMP -> bool
9558
9559 status: int
9560 /
9561
9562Return True if the process returning status was dumped to a core file.
9563[clinic start generated code]*/
9564
Larry Hastings2f936352014-08-05 14:04:04 +10009565static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009566os_WCOREDUMP_impl(PyObject *module, int status)
9567/*[clinic end generated code: output=1a584b147b16bd18 input=8b05e7ab38528d04]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009568{
9569 WAIT_TYPE wait_status;
9570 WAIT_STATUS_INT(wait_status) = status;
9571 return WCOREDUMP(wait_status);
Fred Drake106c1a02002-04-23 15:58:02 +00009572}
9573#endif /* WCOREDUMP */
9574
Larry Hastings2f936352014-08-05 14:04:04 +10009575
Fred Drake106c1a02002-04-23 15:58:02 +00009576#ifdef WIFCONTINUED
Larry Hastings2f936352014-08-05 14:04:04 +10009577/*[clinic input]
9578os.WIFCONTINUED -> bool
9579
9580 status: int
9581
9582Return True if a particular process was continued from a job control stop.
9583
9584Return True if the process returning status was continued from a
9585job control stop.
9586[clinic start generated code]*/
9587
Larry Hastings2f936352014-08-05 14:04:04 +10009588static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009589os_WIFCONTINUED_impl(PyObject *module, int status)
9590/*[clinic end generated code: output=1e35295d844364bd input=e777e7d38eb25bd9]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009591{
9592 WAIT_TYPE wait_status;
9593 WAIT_STATUS_INT(wait_status) = status;
9594 return WIFCONTINUED(wait_status);
Fred Drake106c1a02002-04-23 15:58:02 +00009595}
9596#endif /* WIFCONTINUED */
9597
Larry Hastings2f936352014-08-05 14:04:04 +10009598
Guido van Rossumc9641791998-08-04 15:26:23 +00009599#ifdef WIFSTOPPED
Larry Hastings2f936352014-08-05 14:04:04 +10009600/*[clinic input]
9601os.WIFSTOPPED -> bool
9602
9603 status: int
9604
9605Return True if the process returning status was stopped.
9606[clinic start generated code]*/
9607
Larry Hastings2f936352014-08-05 14:04:04 +10009608static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009609os_WIFSTOPPED_impl(PyObject *module, int status)
9610/*[clinic end generated code: output=fdb57122a5c9b4cb input=043cb7f1289ef904]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009611{
9612 WAIT_TYPE wait_status;
9613 WAIT_STATUS_INT(wait_status) = status;
9614 return WIFSTOPPED(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +00009615}
9616#endif /* WIFSTOPPED */
9617
Larry Hastings2f936352014-08-05 14:04:04 +10009618
Guido van Rossumc9641791998-08-04 15:26:23 +00009619#ifdef WIFSIGNALED
Larry Hastings2f936352014-08-05 14:04:04 +10009620/*[clinic input]
9621os.WIFSIGNALED -> bool
9622
9623 status: int
9624
9625Return True if the process returning status was terminated by a signal.
9626[clinic start generated code]*/
9627
Larry Hastings2f936352014-08-05 14:04:04 +10009628static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009629os_WIFSIGNALED_impl(PyObject *module, int status)
9630/*[clinic end generated code: output=d1dde4dcc819a5f5 input=d55ba7cc9ce5dc43]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009631{
9632 WAIT_TYPE wait_status;
9633 WAIT_STATUS_INT(wait_status) = status;
9634 return WIFSIGNALED(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +00009635}
9636#endif /* WIFSIGNALED */
9637
Larry Hastings2f936352014-08-05 14:04:04 +10009638
Guido van Rossumc9641791998-08-04 15:26:23 +00009639#ifdef WIFEXITED
Larry Hastings2f936352014-08-05 14:04:04 +10009640/*[clinic input]
9641os.WIFEXITED -> bool
9642
9643 status: int
9644
9645Return True if the process returning status exited via the exit() system call.
9646[clinic start generated code]*/
9647
Larry Hastings2f936352014-08-05 14:04:04 +10009648static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009649os_WIFEXITED_impl(PyObject *module, int status)
9650/*[clinic end generated code: output=01c09d6ebfeea397 input=d63775a6791586c0]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009651{
9652 WAIT_TYPE wait_status;
9653 WAIT_STATUS_INT(wait_status) = status;
9654 return WIFEXITED(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +00009655}
9656#endif /* WIFEXITED */
9657
Larry Hastings2f936352014-08-05 14:04:04 +10009658
Guido van Rossum54ecc3d1999-01-27 17:53:11 +00009659#ifdef WEXITSTATUS
Larry Hastings2f936352014-08-05 14:04:04 +10009660/*[clinic input]
9661os.WEXITSTATUS -> int
9662
9663 status: int
9664
9665Return the process return code from status.
9666[clinic start generated code]*/
9667
Larry Hastings2f936352014-08-05 14:04:04 +10009668static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009669os_WEXITSTATUS_impl(PyObject *module, int status)
9670/*[clinic end generated code: output=6e3efbba11f6488d input=e1fb4944e377585b]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009671{
9672 WAIT_TYPE wait_status;
9673 WAIT_STATUS_INT(wait_status) = status;
9674 return WEXITSTATUS(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +00009675}
9676#endif /* WEXITSTATUS */
9677
Larry Hastings2f936352014-08-05 14:04:04 +10009678
Guido van Rossumc9641791998-08-04 15:26:23 +00009679#ifdef WTERMSIG
Larry Hastings2f936352014-08-05 14:04:04 +10009680/*[clinic input]
9681os.WTERMSIG -> int
9682
9683 status: int
9684
9685Return the signal that terminated the process that provided the status value.
9686[clinic start generated code]*/
9687
Larry Hastings2f936352014-08-05 14:04:04 +10009688static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009689os_WTERMSIG_impl(PyObject *module, int status)
9690/*[clinic end generated code: output=172f7dfc8dcfc3ad input=727fd7f84ec3f243]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009691{
9692 WAIT_TYPE wait_status;
9693 WAIT_STATUS_INT(wait_status) = status;
9694 return WTERMSIG(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +00009695}
9696#endif /* WTERMSIG */
9697
Larry Hastings2f936352014-08-05 14:04:04 +10009698
Guido van Rossumc9641791998-08-04 15:26:23 +00009699#ifdef WSTOPSIG
Larry Hastings2f936352014-08-05 14:04:04 +10009700/*[clinic input]
9701os.WSTOPSIG -> int
9702
9703 status: int
9704
9705Return the signal that stopped the process that provided the status value.
9706[clinic start generated code]*/
9707
Larry Hastings2f936352014-08-05 14:04:04 +10009708static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009709os_WSTOPSIG_impl(PyObject *module, int status)
9710/*[clinic end generated code: output=0ab7586396f5d82b input=46ebf1d1b293c5c1]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009711{
9712 WAIT_TYPE wait_status;
9713 WAIT_STATUS_INT(wait_status) = status;
9714 return WSTOPSIG(wait_status);
Guido van Rossumc9641791998-08-04 15:26:23 +00009715}
9716#endif /* WSTOPSIG */
Guido van Rossumc9641791998-08-04 15:26:23 +00009717#endif /* HAVE_SYS_WAIT_H */
9718
9719
Thomas Wouters477c8d52006-05-27 19:21:47 +00009720#if defined(HAVE_FSTATVFS) && defined(HAVE_SYS_STATVFS_H)
Guido van Rossumd5753e11999-10-19 13:29:23 +00009721#ifdef _SCO_DS
9722/* SCO OpenServer 5.0 and later requires _SVID3 before it reveals the
9723 needed definitions in sys/statvfs.h */
9724#define _SVID3
9725#endif
Guido van Rossum94f6f721999-01-06 18:42:14 +00009726#include <sys/statvfs.h>
9727
Guido van Rossum98bf58f2001-10-18 20:34:25 +00009728static PyObject*
9729_pystatvfs_fromstructstatvfs(struct statvfs st) {
Victor Stinner8c62be82010-05-06 00:08:46 +00009730 PyObject *v = PyStructSequence_New(&StatVFSResultType);
9731 if (v == NULL)
9732 return NULL;
Guido van Rossum98bf58f2001-10-18 20:34:25 +00009733
9734#if !defined(HAVE_LARGEFILE_SUPPORT)
Victor Stinner8c62be82010-05-06 00:08:46 +00009735 PyStructSequence_SET_ITEM(v, 0, PyLong_FromLong((long) st.f_bsize));
9736 PyStructSequence_SET_ITEM(v, 1, PyLong_FromLong((long) st.f_frsize));
9737 PyStructSequence_SET_ITEM(v, 2, PyLong_FromLong((long) st.f_blocks));
9738 PyStructSequence_SET_ITEM(v, 3, PyLong_FromLong((long) st.f_bfree));
9739 PyStructSequence_SET_ITEM(v, 4, PyLong_FromLong((long) st.f_bavail));
9740 PyStructSequence_SET_ITEM(v, 5, PyLong_FromLong((long) st.f_files));
9741 PyStructSequence_SET_ITEM(v, 6, PyLong_FromLong((long) st.f_ffree));
9742 PyStructSequence_SET_ITEM(v, 7, PyLong_FromLong((long) st.f_favail));
9743 PyStructSequence_SET_ITEM(v, 8, PyLong_FromLong((long) st.f_flag));
9744 PyStructSequence_SET_ITEM(v, 9, PyLong_FromLong((long) st.f_namemax));
Guido van Rossum98bf58f2001-10-18 20:34:25 +00009745#else
Victor Stinner8c62be82010-05-06 00:08:46 +00009746 PyStructSequence_SET_ITEM(v, 0, PyLong_FromLong((long) st.f_bsize));
9747 PyStructSequence_SET_ITEM(v, 1, PyLong_FromLong((long) st.f_frsize));
9748 PyStructSequence_SET_ITEM(v, 2,
Benjamin Petersonaf580df2016-09-06 10:46:49 -07009749 PyLong_FromLongLong((long long) st.f_blocks));
Victor Stinner8c62be82010-05-06 00:08:46 +00009750 PyStructSequence_SET_ITEM(v, 3,
Benjamin Petersonaf580df2016-09-06 10:46:49 -07009751 PyLong_FromLongLong((long long) st.f_bfree));
Victor Stinner8c62be82010-05-06 00:08:46 +00009752 PyStructSequence_SET_ITEM(v, 4,
Benjamin Petersonaf580df2016-09-06 10:46:49 -07009753 PyLong_FromLongLong((long long) st.f_bavail));
Victor Stinner8c62be82010-05-06 00:08:46 +00009754 PyStructSequence_SET_ITEM(v, 5,
Benjamin Petersonaf580df2016-09-06 10:46:49 -07009755 PyLong_FromLongLong((long long) st.f_files));
Victor Stinner8c62be82010-05-06 00:08:46 +00009756 PyStructSequence_SET_ITEM(v, 6,
Benjamin Petersonaf580df2016-09-06 10:46:49 -07009757 PyLong_FromLongLong((long long) st.f_ffree));
Victor Stinner8c62be82010-05-06 00:08:46 +00009758 PyStructSequence_SET_ITEM(v, 7,
Benjamin Petersonaf580df2016-09-06 10:46:49 -07009759 PyLong_FromLongLong((long long) st.f_favail));
Victor Stinner8c62be82010-05-06 00:08:46 +00009760 PyStructSequence_SET_ITEM(v, 8, PyLong_FromLong((long) st.f_flag));
9761 PyStructSequence_SET_ITEM(v, 9, PyLong_FromLong((long) st.f_namemax));
Guido van Rossum98bf58f2001-10-18 20:34:25 +00009762#endif
Michael Felt502d5512018-01-05 13:01:58 +01009763/* The _ALL_SOURCE feature test macro defines f_fsid as a structure
9764 * (issue #32390). */
9765#if defined(_AIX) && defined(_ALL_SOURCE)
9766 PyStructSequence_SET_ITEM(v, 10, PyLong_FromUnsignedLong(st.f_fsid.val[0]));
9767#else
Giuseppe Scrivano96a5e502017-12-14 23:46:46 +01009768 PyStructSequence_SET_ITEM(v, 10, PyLong_FromUnsignedLong(st.f_fsid));
Michael Felt502d5512018-01-05 13:01:58 +01009769#endif
Victor Stinnerf0a7bac2013-10-30 18:55:24 +01009770 if (PyErr_Occurred()) {
9771 Py_DECREF(v);
9772 return NULL;
9773 }
Guido van Rossum98bf58f2001-10-18 20:34:25 +00009774
Victor Stinner8c62be82010-05-06 00:08:46 +00009775 return v;
Guido van Rossum98bf58f2001-10-18 20:34:25 +00009776}
9777
Larry Hastings2f936352014-08-05 14:04:04 +10009778
9779/*[clinic input]
9780os.fstatvfs
9781 fd: int
9782 /
9783
9784Perform an fstatvfs system call on the given fd.
9785
9786Equivalent to statvfs(fd).
9787[clinic start generated code]*/
9788
Larry Hastings2f936352014-08-05 14:04:04 +10009789static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009790os_fstatvfs_impl(PyObject *module, int fd)
9791/*[clinic end generated code: output=53547cf0cc55e6c5 input=d8122243ac50975e]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009792{
9793 int result;
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009794 int async_err = 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00009795 struct statvfs st;
Guido van Rossum98bf58f2001-10-18 20:34:25 +00009796
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009797 do {
9798 Py_BEGIN_ALLOW_THREADS
9799 result = fstatvfs(fd, &st);
9800 Py_END_ALLOW_THREADS
9801 } while (result != 0 && errno == EINTR &&
9802 !(async_err = PyErr_CheckSignals()));
Larry Hastings2f936352014-08-05 14:04:04 +10009803 if (result != 0)
Charles-François Natali6e6c59b2015-02-07 13:27:50 +00009804 return (!async_err) ? posix_error() : NULL;
Guido van Rossum98bf58f2001-10-18 20:34:25 +00009805
Victor Stinner8c62be82010-05-06 00:08:46 +00009806 return _pystatvfs_fromstructstatvfs(st);
Guido van Rossum94f6f721999-01-06 18:42:14 +00009807}
Larry Hastings2f936352014-08-05 14:04:04 +10009808#endif /* defined(HAVE_FSTATVFS) && defined(HAVE_SYS_STATVFS_H) */
Guido van Rossum94f6f721999-01-06 18:42:14 +00009809
9810
Thomas Wouters477c8d52006-05-27 19:21:47 +00009811#if defined(HAVE_STATVFS) && defined(HAVE_SYS_STATVFS_H)
Guido van Rossum94f6f721999-01-06 18:42:14 +00009812#include <sys/statvfs.h>
Larry Hastings2f936352014-08-05 14:04:04 +10009813/*[clinic input]
9814os.statvfs
Guido van Rossum94f6f721999-01-06 18:42:14 +00009815
Larry Hastings2f936352014-08-05 14:04:04 +10009816 path: path_t(allow_fd='PATH_HAVE_FSTATVFS')
9817
9818Perform a statvfs system call on the given path.
9819
9820path may always be specified as a string.
9821On some platforms, path may also be specified as an open file descriptor.
9822 If this functionality is unavailable, using it raises an exception.
9823[clinic start generated code]*/
9824
Larry Hastings2f936352014-08-05 14:04:04 +10009825static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03009826os_statvfs_impl(PyObject *module, path_t *path)
9827/*[clinic end generated code: output=87106dd1beb8556e input=3f5c35791c669bd9]*/
Larry Hastings2f936352014-08-05 14:04:04 +10009828{
9829 int result;
9830 struct statvfs st;
Larry Hastings9cf065c2012-06-22 16:30:09 -07009831
9832 Py_BEGIN_ALLOW_THREADS
9833#ifdef HAVE_FSTATVFS
Larry Hastings2f936352014-08-05 14:04:04 +10009834 if (path->fd != -1) {
Larry Hastings9cf065c2012-06-22 16:30:09 -07009835#ifdef __APPLE__
9836 /* handle weak-linking on Mac OS X 10.3 */
9837 if (fstatvfs == NULL) {
Larry Hastings2f936352014-08-05 14:04:04 +10009838 fd_specified("statvfs", path->fd);
9839 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -07009840 }
9841#endif
Larry Hastings2f936352014-08-05 14:04:04 +10009842 result = fstatvfs(path->fd, &st);
Larry Hastings9cf065c2012-06-22 16:30:09 -07009843 }
9844 else
9845#endif
Larry Hastings2f936352014-08-05 14:04:04 +10009846 result = statvfs(path->narrow, &st);
Larry Hastings9cf065c2012-06-22 16:30:09 -07009847 Py_END_ALLOW_THREADS
9848
9849 if (result) {
Larry Hastings2f936352014-08-05 14:04:04 +10009850 return path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -07009851 }
9852
Larry Hastings2f936352014-08-05 14:04:04 +10009853 return _pystatvfs_fromstructstatvfs(st);
Guido van Rossum94f6f721999-01-06 18:42:14 +00009854}
Larry Hastings2f936352014-08-05 14:04:04 +10009855#endif /* defined(HAVE_STATVFS) && defined(HAVE_SYS_STATVFS_H) */
9856
Guido van Rossum94f6f721999-01-06 18:42:14 +00009857
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +02009858#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +10009859/*[clinic input]
9860os._getdiskusage
9861
Miss Islington (bot)01dd52f2018-02-22 11:02:12 -08009862 path: path_t
Larry Hastings2f936352014-08-05 14:04:04 +10009863
9864Return disk usage statistics about the given path as a (total, free) tuple.
9865[clinic start generated code]*/
9866
Larry Hastings2f936352014-08-05 14:04:04 +10009867static PyObject *
Miss Islington (bot)01dd52f2018-02-22 11:02:12 -08009868os__getdiskusage_impl(PyObject *module, path_t *path)
9869/*[clinic end generated code: output=3bd3991f5e5c5dfb input=6af8d1b7781cc042]*/
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +02009870{
9871 BOOL retval;
9872 ULARGE_INTEGER _, total, free;
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +02009873
9874 Py_BEGIN_ALLOW_THREADS
Miss Islington (bot)01dd52f2018-02-22 11:02:12 -08009875 retval = GetDiskFreeSpaceExW(path->wide, &_, &total, &free);
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +02009876 Py_END_ALLOW_THREADS
9877 if (retval == 0)
9878 return PyErr_SetFromWindowsErr(0);
9879
9880 return Py_BuildValue("(LL)", total.QuadPart, free.QuadPart);
9881}
Larry Hastings2f936352014-08-05 14:04:04 +10009882#endif /* MS_WINDOWS */
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +02009883
9884
Fred Drakec9680921999-12-13 16:37:25 +00009885/* This is used for fpathconf(), pathconf(), confstr() and sysconf().
9886 * It maps strings representing configuration variable names to
9887 * integer values, allowing those functions to be called with the
Thomas Wouters7e474022000-07-16 12:04:32 +00009888 * magic names instead of polluting the module's namespace with tons of
Fred Drake12c6e2d1999-12-14 21:25:03 +00009889 * rarely-used constants. There are three separate tables that use
9890 * these definitions.
Fred Drakebec628d1999-12-15 18:31:10 +00009891 *
9892 * This code is always included, even if none of the interfaces that
9893 * need it are included. The #if hackery needed to avoid it would be
9894 * sufficiently pervasive that it's not worth the loss of readability.
Fred Drakec9680921999-12-13 16:37:25 +00009895 */
9896struct constdef {
Serhiy Storchaka2d06e842015-12-25 19:53:18 +02009897 const char *name;
Serhiy Storchaka56f6e762015-09-06 21:25:30 +03009898 int value;
Fred Drakec9680921999-12-13 16:37:25 +00009899};
9900
Fred Drake12c6e2d1999-12-14 21:25:03 +00009901static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +00009902conv_confname(PyObject *arg, int *valuep, struct constdef *table,
Guido van Rossum7d5baac2007-08-27 23:24:46 +00009903 size_t tablesize)
Fred Drake12c6e2d1999-12-14 21:25:03 +00009904{
Christian Heimes217cfd12007-12-02 14:31:20 +00009905 if (PyLong_Check(arg)) {
Serhiy Storchaka56f6e762015-09-06 21:25:30 +03009906 int value = _PyLong_AsInt(arg);
9907 if (value == -1 && PyErr_Occurred())
9908 return 0;
9909 *valuep = value;
Stefan Krah0e803b32010-11-26 16:16:47 +00009910 return 1;
Fred Drake12c6e2d1999-12-14 21:25:03 +00009911 }
Guido van Rossumbce56a62007-05-10 18:04:33 +00009912 else {
Stefan Krah0e803b32010-11-26 16:16:47 +00009913 /* look up the value in the table using a binary search */
9914 size_t lo = 0;
9915 size_t mid;
9916 size_t hi = tablesize;
9917 int cmp;
9918 const char *confname;
9919 if (!PyUnicode_Check(arg)) {
9920 PyErr_SetString(PyExc_TypeError,
9921 "configuration names must be strings or integers");
9922 return 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00009923 }
Serhiy Storchaka06515832016-11-20 09:13:07 +02009924 confname = PyUnicode_AsUTF8(arg);
Stefan Krah0e803b32010-11-26 16:16:47 +00009925 if (confname == NULL)
9926 return 0;
9927 while (lo < hi) {
9928 mid = (lo + hi) / 2;
9929 cmp = strcmp(confname, table[mid].name);
9930 if (cmp < 0)
9931 hi = mid;
9932 else if (cmp > 0)
9933 lo = mid + 1;
9934 else {
9935 *valuep = table[mid].value;
9936 return 1;
9937 }
9938 }
9939 PyErr_SetString(PyExc_ValueError, "unrecognized configuration name");
9940 return 0;
Victor Stinner8c62be82010-05-06 00:08:46 +00009941 }
Fred Drake12c6e2d1999-12-14 21:25:03 +00009942}
9943
9944
9945#if defined(HAVE_FPATHCONF) || defined(HAVE_PATHCONF)
9946static struct constdef posix_constants_pathconf[] = {
Fred Draked86ed291999-12-15 15:34:33 +00009947#ifdef _PC_ABI_AIO_XFER_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +00009948 {"PC_ABI_AIO_XFER_MAX", _PC_ABI_AIO_XFER_MAX},
Fred Draked86ed291999-12-15 15:34:33 +00009949#endif
9950#ifdef _PC_ABI_ASYNC_IO
Victor Stinner8c62be82010-05-06 00:08:46 +00009951 {"PC_ABI_ASYNC_IO", _PC_ABI_ASYNC_IO},
Fred Draked86ed291999-12-15 15:34:33 +00009952#endif
Fred Drakec9680921999-12-13 16:37:25 +00009953#ifdef _PC_ASYNC_IO
Victor Stinner8c62be82010-05-06 00:08:46 +00009954 {"PC_ASYNC_IO", _PC_ASYNC_IO},
Fred Drakec9680921999-12-13 16:37:25 +00009955#endif
9956#ifdef _PC_CHOWN_RESTRICTED
Victor Stinner8c62be82010-05-06 00:08:46 +00009957 {"PC_CHOWN_RESTRICTED", _PC_CHOWN_RESTRICTED},
Fred Drakec9680921999-12-13 16:37:25 +00009958#endif
9959#ifdef _PC_FILESIZEBITS
Victor Stinner8c62be82010-05-06 00:08:46 +00009960 {"PC_FILESIZEBITS", _PC_FILESIZEBITS},
Fred Drakec9680921999-12-13 16:37:25 +00009961#endif
9962#ifdef _PC_LAST
Victor Stinner8c62be82010-05-06 00:08:46 +00009963 {"PC_LAST", _PC_LAST},
Fred Drakec9680921999-12-13 16:37:25 +00009964#endif
9965#ifdef _PC_LINK_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +00009966 {"PC_LINK_MAX", _PC_LINK_MAX},
Fred Drakec9680921999-12-13 16:37:25 +00009967#endif
9968#ifdef _PC_MAX_CANON
Victor Stinner8c62be82010-05-06 00:08:46 +00009969 {"PC_MAX_CANON", _PC_MAX_CANON},
Fred Drakec9680921999-12-13 16:37:25 +00009970#endif
9971#ifdef _PC_MAX_INPUT
Victor Stinner8c62be82010-05-06 00:08:46 +00009972 {"PC_MAX_INPUT", _PC_MAX_INPUT},
Fred Drakec9680921999-12-13 16:37:25 +00009973#endif
9974#ifdef _PC_NAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +00009975 {"PC_NAME_MAX", _PC_NAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +00009976#endif
9977#ifdef _PC_NO_TRUNC
Victor Stinner8c62be82010-05-06 00:08:46 +00009978 {"PC_NO_TRUNC", _PC_NO_TRUNC},
Fred Drakec9680921999-12-13 16:37:25 +00009979#endif
9980#ifdef _PC_PATH_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +00009981 {"PC_PATH_MAX", _PC_PATH_MAX},
Fred Drakec9680921999-12-13 16:37:25 +00009982#endif
9983#ifdef _PC_PIPE_BUF
Victor Stinner8c62be82010-05-06 00:08:46 +00009984 {"PC_PIPE_BUF", _PC_PIPE_BUF},
Fred Drakec9680921999-12-13 16:37:25 +00009985#endif
9986#ifdef _PC_PRIO_IO
Victor Stinner8c62be82010-05-06 00:08:46 +00009987 {"PC_PRIO_IO", _PC_PRIO_IO},
Fred Drakec9680921999-12-13 16:37:25 +00009988#endif
9989#ifdef _PC_SOCK_MAXBUF
Victor Stinner8c62be82010-05-06 00:08:46 +00009990 {"PC_SOCK_MAXBUF", _PC_SOCK_MAXBUF},
Fred Drakec9680921999-12-13 16:37:25 +00009991#endif
9992#ifdef _PC_SYNC_IO
Victor Stinner8c62be82010-05-06 00:08:46 +00009993 {"PC_SYNC_IO", _PC_SYNC_IO},
Fred Drakec9680921999-12-13 16:37:25 +00009994#endif
9995#ifdef _PC_VDISABLE
Victor Stinner8c62be82010-05-06 00:08:46 +00009996 {"PC_VDISABLE", _PC_VDISABLE},
Fred Drakec9680921999-12-13 16:37:25 +00009997#endif
Jesus Cea7e9065c2010-10-25 13:02:04 +00009998#ifdef _PC_ACL_ENABLED
9999 {"PC_ACL_ENABLED", _PC_ACL_ENABLED},
10000#endif
10001#ifdef _PC_MIN_HOLE_SIZE
10002 {"PC_MIN_HOLE_SIZE", _PC_MIN_HOLE_SIZE},
10003#endif
10004#ifdef _PC_ALLOC_SIZE_MIN
10005 {"PC_ALLOC_SIZE_MIN", _PC_ALLOC_SIZE_MIN},
10006#endif
10007#ifdef _PC_REC_INCR_XFER_SIZE
10008 {"PC_REC_INCR_XFER_SIZE", _PC_REC_INCR_XFER_SIZE},
10009#endif
10010#ifdef _PC_REC_MAX_XFER_SIZE
10011 {"PC_REC_MAX_XFER_SIZE", _PC_REC_MAX_XFER_SIZE},
10012#endif
10013#ifdef _PC_REC_MIN_XFER_SIZE
10014 {"PC_REC_MIN_XFER_SIZE", _PC_REC_MIN_XFER_SIZE},
10015#endif
10016#ifdef _PC_REC_XFER_ALIGN
10017 {"PC_REC_XFER_ALIGN", _PC_REC_XFER_ALIGN},
10018#endif
10019#ifdef _PC_SYMLINK_MAX
10020 {"PC_SYMLINK_MAX", _PC_SYMLINK_MAX},
10021#endif
10022#ifdef _PC_XATTR_ENABLED
10023 {"PC_XATTR_ENABLED", _PC_XATTR_ENABLED},
10024#endif
10025#ifdef _PC_XATTR_EXISTS
10026 {"PC_XATTR_EXISTS", _PC_XATTR_EXISTS},
10027#endif
10028#ifdef _PC_TIMESTAMP_RESOLUTION
10029 {"PC_TIMESTAMP_RESOLUTION", _PC_TIMESTAMP_RESOLUTION},
10030#endif
Fred Drakec9680921999-12-13 16:37:25 +000010031};
10032
Fred Drakec9680921999-12-13 16:37:25 +000010033static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000010034conv_path_confname(PyObject *arg, int *valuep)
Fred Drakec9680921999-12-13 16:37:25 +000010035{
10036 return conv_confname(arg, valuep, posix_constants_pathconf,
10037 sizeof(posix_constants_pathconf)
10038 / sizeof(struct constdef));
10039}
10040#endif
10041
Larry Hastings2f936352014-08-05 14:04:04 +100010042
Fred Drakec9680921999-12-13 16:37:25 +000010043#ifdef HAVE_FPATHCONF
Larry Hastings2f936352014-08-05 14:04:04 +100010044/*[clinic input]
10045os.fpathconf -> long
10046
10047 fd: int
10048 name: path_confname
10049 /
10050
10051Return the configuration limit name for the file descriptor fd.
10052
10053If there is no limit, return -1.
10054[clinic start generated code]*/
10055
Larry Hastings2f936352014-08-05 14:04:04 +100010056static long
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010057os_fpathconf_impl(PyObject *module, int fd, int name)
10058/*[clinic end generated code: output=d5b7042425fc3e21 input=5942a024d3777810]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010059{
10060 long limit;
10061
10062 errno = 0;
10063 limit = fpathconf(fd, name);
10064 if (limit == -1 && errno != 0)
10065 posix_error();
10066
10067 return limit;
10068}
10069#endif /* HAVE_FPATHCONF */
Fred Drakec9680921999-12-13 16:37:25 +000010070
10071
10072#ifdef HAVE_PATHCONF
Larry Hastings2f936352014-08-05 14:04:04 +100010073/*[clinic input]
10074os.pathconf -> long
10075 path: path_t(allow_fd='PATH_HAVE_FPATHCONF')
10076 name: path_confname
10077
10078Return the configuration limit name for the file or directory path.
10079
10080If there is no limit, return -1.
10081On some platforms, path may also be specified as an open file descriptor.
10082 If this functionality is unavailable, using it raises an exception.
10083[clinic start generated code]*/
10084
Larry Hastings2f936352014-08-05 14:04:04 +100010085static long
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010086os_pathconf_impl(PyObject *module, path_t *path, int name)
10087/*[clinic end generated code: output=5bedee35b293a089 input=bc3e2a985af27e5e]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010088{
Victor Stinner8c62be82010-05-06 00:08:46 +000010089 long limit;
Fred Drakec9680921999-12-13 16:37:25 +000010090
Victor Stinner8c62be82010-05-06 00:08:46 +000010091 errno = 0;
Georg Brandl306336b2012-06-24 12:55:33 +020010092#ifdef HAVE_FPATHCONF
Larry Hastings2f936352014-08-05 14:04:04 +100010093 if (path->fd != -1)
10094 limit = fpathconf(path->fd, name);
Georg Brandl306336b2012-06-24 12:55:33 +020010095 else
10096#endif
Larry Hastings2f936352014-08-05 14:04:04 +100010097 limit = pathconf(path->narrow, name);
Victor Stinner8c62be82010-05-06 00:08:46 +000010098 if (limit == -1 && errno != 0) {
10099 if (errno == EINVAL)
Stefan Krah99439262010-11-26 12:58:05 +000010100 /* could be a path or name problem */
10101 posix_error();
Fred Drakec9680921999-12-13 16:37:25 +000010102 else
Larry Hastings2f936352014-08-05 14:04:04 +100010103 path_error(path);
Victor Stinner8c62be82010-05-06 00:08:46 +000010104 }
Larry Hastings2f936352014-08-05 14:04:04 +100010105
10106 return limit;
Fred Drakec9680921999-12-13 16:37:25 +000010107}
Larry Hastings2f936352014-08-05 14:04:04 +100010108#endif /* HAVE_PATHCONF */
Fred Drakec9680921999-12-13 16:37:25 +000010109
10110#ifdef HAVE_CONFSTR
10111static struct constdef posix_constants_confstr[] = {
Fred Draked86ed291999-12-15 15:34:33 +000010112#ifdef _CS_ARCHITECTURE
Victor Stinner8c62be82010-05-06 00:08:46 +000010113 {"CS_ARCHITECTURE", _CS_ARCHITECTURE},
Fred Draked86ed291999-12-15 15:34:33 +000010114#endif
Mark Dickinson876d7c82010-04-16 12:47:52 +000010115#ifdef _CS_GNU_LIBC_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000010116 {"CS_GNU_LIBC_VERSION", _CS_GNU_LIBC_VERSION},
Mark Dickinson876d7c82010-04-16 12:47:52 +000010117#endif
10118#ifdef _CS_GNU_LIBPTHREAD_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000010119 {"CS_GNU_LIBPTHREAD_VERSION", _CS_GNU_LIBPTHREAD_VERSION},
Mark Dickinson876d7c82010-04-16 12:47:52 +000010120#endif
Fred Draked86ed291999-12-15 15:34:33 +000010121#ifdef _CS_HOSTNAME
Victor Stinner8c62be82010-05-06 00:08:46 +000010122 {"CS_HOSTNAME", _CS_HOSTNAME},
Fred Draked86ed291999-12-15 15:34:33 +000010123#endif
10124#ifdef _CS_HW_PROVIDER
Victor Stinner8c62be82010-05-06 00:08:46 +000010125 {"CS_HW_PROVIDER", _CS_HW_PROVIDER},
Fred Draked86ed291999-12-15 15:34:33 +000010126#endif
10127#ifdef _CS_HW_SERIAL
Victor Stinner8c62be82010-05-06 00:08:46 +000010128 {"CS_HW_SERIAL", _CS_HW_SERIAL},
Fred Draked86ed291999-12-15 15:34:33 +000010129#endif
10130#ifdef _CS_INITTAB_NAME
Victor Stinner8c62be82010-05-06 00:08:46 +000010131 {"CS_INITTAB_NAME", _CS_INITTAB_NAME},
Fred Draked86ed291999-12-15 15:34:33 +000010132#endif
Fred Drakec9680921999-12-13 16:37:25 +000010133#ifdef _CS_LFS64_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010134 {"CS_LFS64_CFLAGS", _CS_LFS64_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010135#endif
10136#ifdef _CS_LFS64_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010137 {"CS_LFS64_LDFLAGS", _CS_LFS64_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010138#endif
10139#ifdef _CS_LFS64_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000010140 {"CS_LFS64_LIBS", _CS_LFS64_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000010141#endif
10142#ifdef _CS_LFS64_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010143 {"CS_LFS64_LINTFLAGS", _CS_LFS64_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010144#endif
10145#ifdef _CS_LFS_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010146 {"CS_LFS_CFLAGS", _CS_LFS_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010147#endif
10148#ifdef _CS_LFS_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010149 {"CS_LFS_LDFLAGS", _CS_LFS_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010150#endif
10151#ifdef _CS_LFS_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000010152 {"CS_LFS_LIBS", _CS_LFS_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000010153#endif
10154#ifdef _CS_LFS_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010155 {"CS_LFS_LINTFLAGS", _CS_LFS_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010156#endif
Fred Draked86ed291999-12-15 15:34:33 +000010157#ifdef _CS_MACHINE
Victor Stinner8c62be82010-05-06 00:08:46 +000010158 {"CS_MACHINE", _CS_MACHINE},
Fred Draked86ed291999-12-15 15:34:33 +000010159#endif
Fred Drakec9680921999-12-13 16:37:25 +000010160#ifdef _CS_PATH
Victor Stinner8c62be82010-05-06 00:08:46 +000010161 {"CS_PATH", _CS_PATH},
Fred Drakec9680921999-12-13 16:37:25 +000010162#endif
Fred Draked86ed291999-12-15 15:34:33 +000010163#ifdef _CS_RELEASE
Victor Stinner8c62be82010-05-06 00:08:46 +000010164 {"CS_RELEASE", _CS_RELEASE},
Fred Draked86ed291999-12-15 15:34:33 +000010165#endif
10166#ifdef _CS_SRPC_DOMAIN
Victor Stinner8c62be82010-05-06 00:08:46 +000010167 {"CS_SRPC_DOMAIN", _CS_SRPC_DOMAIN},
Fred Draked86ed291999-12-15 15:34:33 +000010168#endif
10169#ifdef _CS_SYSNAME
Victor Stinner8c62be82010-05-06 00:08:46 +000010170 {"CS_SYSNAME", _CS_SYSNAME},
Fred Draked86ed291999-12-15 15:34:33 +000010171#endif
10172#ifdef _CS_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000010173 {"CS_VERSION", _CS_VERSION},
Fred Draked86ed291999-12-15 15:34:33 +000010174#endif
Fred Drakec9680921999-12-13 16:37:25 +000010175#ifdef _CS_XBS5_ILP32_OFF32_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010176 {"CS_XBS5_ILP32_OFF32_CFLAGS", _CS_XBS5_ILP32_OFF32_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010177#endif
10178#ifdef _CS_XBS5_ILP32_OFF32_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010179 {"CS_XBS5_ILP32_OFF32_LDFLAGS", _CS_XBS5_ILP32_OFF32_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010180#endif
10181#ifdef _CS_XBS5_ILP32_OFF32_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000010182 {"CS_XBS5_ILP32_OFF32_LIBS", _CS_XBS5_ILP32_OFF32_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000010183#endif
10184#ifdef _CS_XBS5_ILP32_OFF32_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010185 {"CS_XBS5_ILP32_OFF32_LINTFLAGS", _CS_XBS5_ILP32_OFF32_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010186#endif
10187#ifdef _CS_XBS5_ILP32_OFFBIG_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010188 {"CS_XBS5_ILP32_OFFBIG_CFLAGS", _CS_XBS5_ILP32_OFFBIG_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010189#endif
10190#ifdef _CS_XBS5_ILP32_OFFBIG_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010191 {"CS_XBS5_ILP32_OFFBIG_LDFLAGS", _CS_XBS5_ILP32_OFFBIG_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010192#endif
10193#ifdef _CS_XBS5_ILP32_OFFBIG_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000010194 {"CS_XBS5_ILP32_OFFBIG_LIBS", _CS_XBS5_ILP32_OFFBIG_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000010195#endif
10196#ifdef _CS_XBS5_ILP32_OFFBIG_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010197 {"CS_XBS5_ILP32_OFFBIG_LINTFLAGS", _CS_XBS5_ILP32_OFFBIG_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010198#endif
10199#ifdef _CS_XBS5_LP64_OFF64_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010200 {"CS_XBS5_LP64_OFF64_CFLAGS", _CS_XBS5_LP64_OFF64_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010201#endif
10202#ifdef _CS_XBS5_LP64_OFF64_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010203 {"CS_XBS5_LP64_OFF64_LDFLAGS", _CS_XBS5_LP64_OFF64_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010204#endif
10205#ifdef _CS_XBS5_LP64_OFF64_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000010206 {"CS_XBS5_LP64_OFF64_LIBS", _CS_XBS5_LP64_OFF64_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000010207#endif
10208#ifdef _CS_XBS5_LP64_OFF64_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010209 {"CS_XBS5_LP64_OFF64_LINTFLAGS", _CS_XBS5_LP64_OFF64_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010210#endif
10211#ifdef _CS_XBS5_LPBIG_OFFBIG_CFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010212 {"CS_XBS5_LPBIG_OFFBIG_CFLAGS", _CS_XBS5_LPBIG_OFFBIG_CFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010213#endif
10214#ifdef _CS_XBS5_LPBIG_OFFBIG_LDFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010215 {"CS_XBS5_LPBIG_OFFBIG_LDFLAGS", _CS_XBS5_LPBIG_OFFBIG_LDFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010216#endif
10217#ifdef _CS_XBS5_LPBIG_OFFBIG_LIBS
Victor Stinner8c62be82010-05-06 00:08:46 +000010218 {"CS_XBS5_LPBIG_OFFBIG_LIBS", _CS_XBS5_LPBIG_OFFBIG_LIBS},
Fred Drakec9680921999-12-13 16:37:25 +000010219#endif
10220#ifdef _CS_XBS5_LPBIG_OFFBIG_LINTFLAGS
Victor Stinner8c62be82010-05-06 00:08:46 +000010221 {"CS_XBS5_LPBIG_OFFBIG_LINTFLAGS", _CS_XBS5_LPBIG_OFFBIG_LINTFLAGS},
Fred Drakec9680921999-12-13 16:37:25 +000010222#endif
Fred Draked86ed291999-12-15 15:34:33 +000010223#ifdef _MIPS_CS_AVAIL_PROCESSORS
Victor Stinner8c62be82010-05-06 00:08:46 +000010224 {"MIPS_CS_AVAIL_PROCESSORS", _MIPS_CS_AVAIL_PROCESSORS},
Fred Draked86ed291999-12-15 15:34:33 +000010225#endif
10226#ifdef _MIPS_CS_BASE
Victor Stinner8c62be82010-05-06 00:08:46 +000010227 {"MIPS_CS_BASE", _MIPS_CS_BASE},
Fred Draked86ed291999-12-15 15:34:33 +000010228#endif
10229#ifdef _MIPS_CS_HOSTID
Victor Stinner8c62be82010-05-06 00:08:46 +000010230 {"MIPS_CS_HOSTID", _MIPS_CS_HOSTID},
Fred Draked86ed291999-12-15 15:34:33 +000010231#endif
10232#ifdef _MIPS_CS_HW_NAME
Victor Stinner8c62be82010-05-06 00:08:46 +000010233 {"MIPS_CS_HW_NAME", _MIPS_CS_HW_NAME},
Fred Draked86ed291999-12-15 15:34:33 +000010234#endif
10235#ifdef _MIPS_CS_NUM_PROCESSORS
Victor Stinner8c62be82010-05-06 00:08:46 +000010236 {"MIPS_CS_NUM_PROCESSORS", _MIPS_CS_NUM_PROCESSORS},
Fred Draked86ed291999-12-15 15:34:33 +000010237#endif
10238#ifdef _MIPS_CS_OSREL_MAJ
Victor Stinner8c62be82010-05-06 00:08:46 +000010239 {"MIPS_CS_OSREL_MAJ", _MIPS_CS_OSREL_MAJ},
Fred Draked86ed291999-12-15 15:34:33 +000010240#endif
10241#ifdef _MIPS_CS_OSREL_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000010242 {"MIPS_CS_OSREL_MIN", _MIPS_CS_OSREL_MIN},
Fred Draked86ed291999-12-15 15:34:33 +000010243#endif
10244#ifdef _MIPS_CS_OSREL_PATCH
Victor Stinner8c62be82010-05-06 00:08:46 +000010245 {"MIPS_CS_OSREL_PATCH", _MIPS_CS_OSREL_PATCH},
Fred Draked86ed291999-12-15 15:34:33 +000010246#endif
10247#ifdef _MIPS_CS_OS_NAME
Victor Stinner8c62be82010-05-06 00:08:46 +000010248 {"MIPS_CS_OS_NAME", _MIPS_CS_OS_NAME},
Fred Draked86ed291999-12-15 15:34:33 +000010249#endif
10250#ifdef _MIPS_CS_OS_PROVIDER
Victor Stinner8c62be82010-05-06 00:08:46 +000010251 {"MIPS_CS_OS_PROVIDER", _MIPS_CS_OS_PROVIDER},
Fred Draked86ed291999-12-15 15:34:33 +000010252#endif
10253#ifdef _MIPS_CS_PROCESSORS
Victor Stinner8c62be82010-05-06 00:08:46 +000010254 {"MIPS_CS_PROCESSORS", _MIPS_CS_PROCESSORS},
Fred Draked86ed291999-12-15 15:34:33 +000010255#endif
10256#ifdef _MIPS_CS_SERIAL
Victor Stinner8c62be82010-05-06 00:08:46 +000010257 {"MIPS_CS_SERIAL", _MIPS_CS_SERIAL},
Fred Draked86ed291999-12-15 15:34:33 +000010258#endif
10259#ifdef _MIPS_CS_VENDOR
Victor Stinner8c62be82010-05-06 00:08:46 +000010260 {"MIPS_CS_VENDOR", _MIPS_CS_VENDOR},
Fred Draked86ed291999-12-15 15:34:33 +000010261#endif
Fred Drakec9680921999-12-13 16:37:25 +000010262};
10263
10264static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000010265conv_confstr_confname(PyObject *arg, int *valuep)
Fred Drakec9680921999-12-13 16:37:25 +000010266{
10267 return conv_confname(arg, valuep, posix_constants_confstr,
10268 sizeof(posix_constants_confstr)
10269 / sizeof(struct constdef));
10270}
10271
Larry Hastings2f936352014-08-05 14:04:04 +100010272
10273/*[clinic input]
10274os.confstr
10275
10276 name: confstr_confname
10277 /
10278
10279Return a string-valued system configuration variable.
10280[clinic start generated code]*/
10281
Larry Hastings2f936352014-08-05 14:04:04 +100010282static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010283os_confstr_impl(PyObject *module, int name)
10284/*[clinic end generated code: output=bfb0b1b1e49b9383 input=18fb4d0567242e65]*/
Fred Drakec9680921999-12-13 16:37:25 +000010285{
10286 PyObject *result = NULL;
Victor Stinnercb043522010-09-10 23:49:04 +000010287 char buffer[255];
Victor Stinnerdd3a6a52013-06-25 23:13:47 +020010288 size_t len;
Fred Drakec9680921999-12-13 16:37:25 +000010289
Victor Stinnercb043522010-09-10 23:49:04 +000010290 errno = 0;
10291 len = confstr(name, buffer, sizeof(buffer));
10292 if (len == 0) {
10293 if (errno) {
10294 posix_error();
10295 return NULL;
Fred Drakec9680921999-12-13 16:37:25 +000010296 }
10297 else {
Victor Stinnercb043522010-09-10 23:49:04 +000010298 Py_RETURN_NONE;
Fred Drakec9680921999-12-13 16:37:25 +000010299 }
10300 }
Victor Stinnercb043522010-09-10 23:49:04 +000010301
Victor Stinnerdd3a6a52013-06-25 23:13:47 +020010302 if (len >= sizeof(buffer)) {
Victor Stinnercbc18f32014-12-05 22:51:51 +010010303 size_t len2;
Victor Stinnercb043522010-09-10 23:49:04 +000010304 char *buf = PyMem_Malloc(len);
10305 if (buf == NULL)
10306 return PyErr_NoMemory();
Victor Stinnercbc18f32014-12-05 22:51:51 +010010307 len2 = confstr(name, buf, len);
10308 assert(len == len2);
Christian Heimes8714cfd2015-04-21 10:57:41 +020010309 result = PyUnicode_DecodeFSDefaultAndSize(buf, len2-1);
Victor Stinnercb043522010-09-10 23:49:04 +000010310 PyMem_Free(buf);
10311 }
10312 else
10313 result = PyUnicode_DecodeFSDefaultAndSize(buffer, len-1);
Fred Drakec9680921999-12-13 16:37:25 +000010314 return result;
10315}
Larry Hastings2f936352014-08-05 14:04:04 +100010316#endif /* HAVE_CONFSTR */
Fred Drakec9680921999-12-13 16:37:25 +000010317
10318
10319#ifdef HAVE_SYSCONF
10320static struct constdef posix_constants_sysconf[] = {
10321#ifdef _SC_2_CHAR_TERM
Victor Stinner8c62be82010-05-06 00:08:46 +000010322 {"SC_2_CHAR_TERM", _SC_2_CHAR_TERM},
Fred Drakec9680921999-12-13 16:37:25 +000010323#endif
10324#ifdef _SC_2_C_BIND
Victor Stinner8c62be82010-05-06 00:08:46 +000010325 {"SC_2_C_BIND", _SC_2_C_BIND},
Fred Drakec9680921999-12-13 16:37:25 +000010326#endif
10327#ifdef _SC_2_C_DEV
Victor Stinner8c62be82010-05-06 00:08:46 +000010328 {"SC_2_C_DEV", _SC_2_C_DEV},
Fred Drakec9680921999-12-13 16:37:25 +000010329#endif
10330#ifdef _SC_2_C_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000010331 {"SC_2_C_VERSION", _SC_2_C_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000010332#endif
10333#ifdef _SC_2_FORT_DEV
Victor Stinner8c62be82010-05-06 00:08:46 +000010334 {"SC_2_FORT_DEV", _SC_2_FORT_DEV},
Fred Drakec9680921999-12-13 16:37:25 +000010335#endif
10336#ifdef _SC_2_FORT_RUN
Victor Stinner8c62be82010-05-06 00:08:46 +000010337 {"SC_2_FORT_RUN", _SC_2_FORT_RUN},
Fred Drakec9680921999-12-13 16:37:25 +000010338#endif
10339#ifdef _SC_2_LOCALEDEF
Victor Stinner8c62be82010-05-06 00:08:46 +000010340 {"SC_2_LOCALEDEF", _SC_2_LOCALEDEF},
Fred Drakec9680921999-12-13 16:37:25 +000010341#endif
10342#ifdef _SC_2_SW_DEV
Victor Stinner8c62be82010-05-06 00:08:46 +000010343 {"SC_2_SW_DEV", _SC_2_SW_DEV},
Fred Drakec9680921999-12-13 16:37:25 +000010344#endif
10345#ifdef _SC_2_UPE
Victor Stinner8c62be82010-05-06 00:08:46 +000010346 {"SC_2_UPE", _SC_2_UPE},
Fred Drakec9680921999-12-13 16:37:25 +000010347#endif
10348#ifdef _SC_2_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000010349 {"SC_2_VERSION", _SC_2_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000010350#endif
Fred Draked86ed291999-12-15 15:34:33 +000010351#ifdef _SC_ABI_ASYNCHRONOUS_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000010352 {"SC_ABI_ASYNCHRONOUS_IO", _SC_ABI_ASYNCHRONOUS_IO},
Fred Draked86ed291999-12-15 15:34:33 +000010353#endif
10354#ifdef _SC_ACL
Victor Stinner8c62be82010-05-06 00:08:46 +000010355 {"SC_ACL", _SC_ACL},
Fred Draked86ed291999-12-15 15:34:33 +000010356#endif
Fred Drakec9680921999-12-13 16:37:25 +000010357#ifdef _SC_AIO_LISTIO_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010358 {"SC_AIO_LISTIO_MAX", _SC_AIO_LISTIO_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010359#endif
Fred Drakec9680921999-12-13 16:37:25 +000010360#ifdef _SC_AIO_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010361 {"SC_AIO_MAX", _SC_AIO_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010362#endif
10363#ifdef _SC_AIO_PRIO_DELTA_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010364 {"SC_AIO_PRIO_DELTA_MAX", _SC_AIO_PRIO_DELTA_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010365#endif
10366#ifdef _SC_ARG_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010367 {"SC_ARG_MAX", _SC_ARG_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010368#endif
10369#ifdef _SC_ASYNCHRONOUS_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000010370 {"SC_ASYNCHRONOUS_IO", _SC_ASYNCHRONOUS_IO},
Fred Drakec9680921999-12-13 16:37:25 +000010371#endif
10372#ifdef _SC_ATEXIT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010373 {"SC_ATEXIT_MAX", _SC_ATEXIT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010374#endif
Fred Draked86ed291999-12-15 15:34:33 +000010375#ifdef _SC_AUDIT
Victor Stinner8c62be82010-05-06 00:08:46 +000010376 {"SC_AUDIT", _SC_AUDIT},
Fred Draked86ed291999-12-15 15:34:33 +000010377#endif
Fred Drakec9680921999-12-13 16:37:25 +000010378#ifdef _SC_AVPHYS_PAGES
Victor Stinner8c62be82010-05-06 00:08:46 +000010379 {"SC_AVPHYS_PAGES", _SC_AVPHYS_PAGES},
Fred Drakec9680921999-12-13 16:37:25 +000010380#endif
10381#ifdef _SC_BC_BASE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010382 {"SC_BC_BASE_MAX", _SC_BC_BASE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010383#endif
10384#ifdef _SC_BC_DIM_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010385 {"SC_BC_DIM_MAX", _SC_BC_DIM_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010386#endif
10387#ifdef _SC_BC_SCALE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010388 {"SC_BC_SCALE_MAX", _SC_BC_SCALE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010389#endif
10390#ifdef _SC_BC_STRING_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010391 {"SC_BC_STRING_MAX", _SC_BC_STRING_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010392#endif
Fred Draked86ed291999-12-15 15:34:33 +000010393#ifdef _SC_CAP
Victor Stinner8c62be82010-05-06 00:08:46 +000010394 {"SC_CAP", _SC_CAP},
Fred Draked86ed291999-12-15 15:34:33 +000010395#endif
Fred Drakec9680921999-12-13 16:37:25 +000010396#ifdef _SC_CHARCLASS_NAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010397 {"SC_CHARCLASS_NAME_MAX", _SC_CHARCLASS_NAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010398#endif
10399#ifdef _SC_CHAR_BIT
Victor Stinner8c62be82010-05-06 00:08:46 +000010400 {"SC_CHAR_BIT", _SC_CHAR_BIT},
Fred Drakec9680921999-12-13 16:37:25 +000010401#endif
10402#ifdef _SC_CHAR_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010403 {"SC_CHAR_MAX", _SC_CHAR_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010404#endif
10405#ifdef _SC_CHAR_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000010406 {"SC_CHAR_MIN", _SC_CHAR_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000010407#endif
10408#ifdef _SC_CHILD_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010409 {"SC_CHILD_MAX", _SC_CHILD_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010410#endif
10411#ifdef _SC_CLK_TCK
Victor Stinner8c62be82010-05-06 00:08:46 +000010412 {"SC_CLK_TCK", _SC_CLK_TCK},
Fred Drakec9680921999-12-13 16:37:25 +000010413#endif
10414#ifdef _SC_COHER_BLKSZ
Victor Stinner8c62be82010-05-06 00:08:46 +000010415 {"SC_COHER_BLKSZ", _SC_COHER_BLKSZ},
Fred Drakec9680921999-12-13 16:37:25 +000010416#endif
10417#ifdef _SC_COLL_WEIGHTS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010418 {"SC_COLL_WEIGHTS_MAX", _SC_COLL_WEIGHTS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010419#endif
10420#ifdef _SC_DCACHE_ASSOC
Victor Stinner8c62be82010-05-06 00:08:46 +000010421 {"SC_DCACHE_ASSOC", _SC_DCACHE_ASSOC},
Fred Drakec9680921999-12-13 16:37:25 +000010422#endif
10423#ifdef _SC_DCACHE_BLKSZ
Victor Stinner8c62be82010-05-06 00:08:46 +000010424 {"SC_DCACHE_BLKSZ", _SC_DCACHE_BLKSZ},
Fred Drakec9680921999-12-13 16:37:25 +000010425#endif
10426#ifdef _SC_DCACHE_LINESZ
Victor Stinner8c62be82010-05-06 00:08:46 +000010427 {"SC_DCACHE_LINESZ", _SC_DCACHE_LINESZ},
Fred Drakec9680921999-12-13 16:37:25 +000010428#endif
10429#ifdef _SC_DCACHE_SZ
Victor Stinner8c62be82010-05-06 00:08:46 +000010430 {"SC_DCACHE_SZ", _SC_DCACHE_SZ},
Fred Drakec9680921999-12-13 16:37:25 +000010431#endif
10432#ifdef _SC_DCACHE_TBLKSZ
Victor Stinner8c62be82010-05-06 00:08:46 +000010433 {"SC_DCACHE_TBLKSZ", _SC_DCACHE_TBLKSZ},
Fred Drakec9680921999-12-13 16:37:25 +000010434#endif
10435#ifdef _SC_DELAYTIMER_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010436 {"SC_DELAYTIMER_MAX", _SC_DELAYTIMER_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010437#endif
10438#ifdef _SC_EQUIV_CLASS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010439 {"SC_EQUIV_CLASS_MAX", _SC_EQUIV_CLASS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010440#endif
10441#ifdef _SC_EXPR_NEST_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010442 {"SC_EXPR_NEST_MAX", _SC_EXPR_NEST_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010443#endif
10444#ifdef _SC_FSYNC
Victor Stinner8c62be82010-05-06 00:08:46 +000010445 {"SC_FSYNC", _SC_FSYNC},
Fred Drakec9680921999-12-13 16:37:25 +000010446#endif
10447#ifdef _SC_GETGR_R_SIZE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010448 {"SC_GETGR_R_SIZE_MAX", _SC_GETGR_R_SIZE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010449#endif
10450#ifdef _SC_GETPW_R_SIZE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010451 {"SC_GETPW_R_SIZE_MAX", _SC_GETPW_R_SIZE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010452#endif
10453#ifdef _SC_ICACHE_ASSOC
Victor Stinner8c62be82010-05-06 00:08:46 +000010454 {"SC_ICACHE_ASSOC", _SC_ICACHE_ASSOC},
Fred Drakec9680921999-12-13 16:37:25 +000010455#endif
10456#ifdef _SC_ICACHE_BLKSZ
Victor Stinner8c62be82010-05-06 00:08:46 +000010457 {"SC_ICACHE_BLKSZ", _SC_ICACHE_BLKSZ},
Fred Drakec9680921999-12-13 16:37:25 +000010458#endif
10459#ifdef _SC_ICACHE_LINESZ
Victor Stinner8c62be82010-05-06 00:08:46 +000010460 {"SC_ICACHE_LINESZ", _SC_ICACHE_LINESZ},
Fred Drakec9680921999-12-13 16:37:25 +000010461#endif
10462#ifdef _SC_ICACHE_SZ
Victor Stinner8c62be82010-05-06 00:08:46 +000010463 {"SC_ICACHE_SZ", _SC_ICACHE_SZ},
Fred Drakec9680921999-12-13 16:37:25 +000010464#endif
Fred Draked86ed291999-12-15 15:34:33 +000010465#ifdef _SC_INF
Victor Stinner8c62be82010-05-06 00:08:46 +000010466 {"SC_INF", _SC_INF},
Fred Draked86ed291999-12-15 15:34:33 +000010467#endif
Fred Drakec9680921999-12-13 16:37:25 +000010468#ifdef _SC_INT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010469 {"SC_INT_MAX", _SC_INT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010470#endif
10471#ifdef _SC_INT_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000010472 {"SC_INT_MIN", _SC_INT_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000010473#endif
10474#ifdef _SC_IOV_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010475 {"SC_IOV_MAX", _SC_IOV_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010476#endif
Fred Draked86ed291999-12-15 15:34:33 +000010477#ifdef _SC_IP_SECOPTS
Victor Stinner8c62be82010-05-06 00:08:46 +000010478 {"SC_IP_SECOPTS", _SC_IP_SECOPTS},
Fred Draked86ed291999-12-15 15:34:33 +000010479#endif
Fred Drakec9680921999-12-13 16:37:25 +000010480#ifdef _SC_JOB_CONTROL
Victor Stinner8c62be82010-05-06 00:08:46 +000010481 {"SC_JOB_CONTROL", _SC_JOB_CONTROL},
Fred Drakec9680921999-12-13 16:37:25 +000010482#endif
Fred Draked86ed291999-12-15 15:34:33 +000010483#ifdef _SC_KERN_POINTERS
Victor Stinner8c62be82010-05-06 00:08:46 +000010484 {"SC_KERN_POINTERS", _SC_KERN_POINTERS},
Fred Draked86ed291999-12-15 15:34:33 +000010485#endif
10486#ifdef _SC_KERN_SIM
Victor Stinner8c62be82010-05-06 00:08:46 +000010487 {"SC_KERN_SIM", _SC_KERN_SIM},
Fred Draked86ed291999-12-15 15:34:33 +000010488#endif
Fred Drakec9680921999-12-13 16:37:25 +000010489#ifdef _SC_LINE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010490 {"SC_LINE_MAX", _SC_LINE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010491#endif
10492#ifdef _SC_LOGIN_NAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010493 {"SC_LOGIN_NAME_MAX", _SC_LOGIN_NAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010494#endif
10495#ifdef _SC_LOGNAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010496 {"SC_LOGNAME_MAX", _SC_LOGNAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010497#endif
10498#ifdef _SC_LONG_BIT
Victor Stinner8c62be82010-05-06 00:08:46 +000010499 {"SC_LONG_BIT", _SC_LONG_BIT},
Fred Drakec9680921999-12-13 16:37:25 +000010500#endif
Fred Draked86ed291999-12-15 15:34:33 +000010501#ifdef _SC_MAC
Victor Stinner8c62be82010-05-06 00:08:46 +000010502 {"SC_MAC", _SC_MAC},
Fred Draked86ed291999-12-15 15:34:33 +000010503#endif
Fred Drakec9680921999-12-13 16:37:25 +000010504#ifdef _SC_MAPPED_FILES
Victor Stinner8c62be82010-05-06 00:08:46 +000010505 {"SC_MAPPED_FILES", _SC_MAPPED_FILES},
Fred Drakec9680921999-12-13 16:37:25 +000010506#endif
10507#ifdef _SC_MAXPID
Victor Stinner8c62be82010-05-06 00:08:46 +000010508 {"SC_MAXPID", _SC_MAXPID},
Fred Drakec9680921999-12-13 16:37:25 +000010509#endif
10510#ifdef _SC_MB_LEN_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010511 {"SC_MB_LEN_MAX", _SC_MB_LEN_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010512#endif
10513#ifdef _SC_MEMLOCK
Victor Stinner8c62be82010-05-06 00:08:46 +000010514 {"SC_MEMLOCK", _SC_MEMLOCK},
Fred Drakec9680921999-12-13 16:37:25 +000010515#endif
10516#ifdef _SC_MEMLOCK_RANGE
Victor Stinner8c62be82010-05-06 00:08:46 +000010517 {"SC_MEMLOCK_RANGE", _SC_MEMLOCK_RANGE},
Fred Drakec9680921999-12-13 16:37:25 +000010518#endif
10519#ifdef _SC_MEMORY_PROTECTION
Victor Stinner8c62be82010-05-06 00:08:46 +000010520 {"SC_MEMORY_PROTECTION", _SC_MEMORY_PROTECTION},
Fred Drakec9680921999-12-13 16:37:25 +000010521#endif
10522#ifdef _SC_MESSAGE_PASSING
Victor Stinner8c62be82010-05-06 00:08:46 +000010523 {"SC_MESSAGE_PASSING", _SC_MESSAGE_PASSING},
Fred Drakec9680921999-12-13 16:37:25 +000010524#endif
Fred Draked86ed291999-12-15 15:34:33 +000010525#ifdef _SC_MMAP_FIXED_ALIGNMENT
Victor Stinner8c62be82010-05-06 00:08:46 +000010526 {"SC_MMAP_FIXED_ALIGNMENT", _SC_MMAP_FIXED_ALIGNMENT},
Fred Draked86ed291999-12-15 15:34:33 +000010527#endif
Fred Drakec9680921999-12-13 16:37:25 +000010528#ifdef _SC_MQ_OPEN_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010529 {"SC_MQ_OPEN_MAX", _SC_MQ_OPEN_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010530#endif
10531#ifdef _SC_MQ_PRIO_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010532 {"SC_MQ_PRIO_MAX", _SC_MQ_PRIO_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010533#endif
Fred Draked86ed291999-12-15 15:34:33 +000010534#ifdef _SC_NACLS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010535 {"SC_NACLS_MAX", _SC_NACLS_MAX},
Fred Draked86ed291999-12-15 15:34:33 +000010536#endif
Fred Drakec9680921999-12-13 16:37:25 +000010537#ifdef _SC_NGROUPS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010538 {"SC_NGROUPS_MAX", _SC_NGROUPS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010539#endif
10540#ifdef _SC_NL_ARGMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010541 {"SC_NL_ARGMAX", _SC_NL_ARGMAX},
Fred Drakec9680921999-12-13 16:37:25 +000010542#endif
10543#ifdef _SC_NL_LANGMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010544 {"SC_NL_LANGMAX", _SC_NL_LANGMAX},
Fred Drakec9680921999-12-13 16:37:25 +000010545#endif
10546#ifdef _SC_NL_MSGMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010547 {"SC_NL_MSGMAX", _SC_NL_MSGMAX},
Fred Drakec9680921999-12-13 16:37:25 +000010548#endif
10549#ifdef _SC_NL_NMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010550 {"SC_NL_NMAX", _SC_NL_NMAX},
Fred Drakec9680921999-12-13 16:37:25 +000010551#endif
10552#ifdef _SC_NL_SETMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010553 {"SC_NL_SETMAX", _SC_NL_SETMAX},
Fred Drakec9680921999-12-13 16:37:25 +000010554#endif
10555#ifdef _SC_NL_TEXTMAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010556 {"SC_NL_TEXTMAX", _SC_NL_TEXTMAX},
Fred Drakec9680921999-12-13 16:37:25 +000010557#endif
10558#ifdef _SC_NPROCESSORS_CONF
Victor Stinner8c62be82010-05-06 00:08:46 +000010559 {"SC_NPROCESSORS_CONF", _SC_NPROCESSORS_CONF},
Fred Drakec9680921999-12-13 16:37:25 +000010560#endif
10561#ifdef _SC_NPROCESSORS_ONLN
Victor Stinner8c62be82010-05-06 00:08:46 +000010562 {"SC_NPROCESSORS_ONLN", _SC_NPROCESSORS_ONLN},
Fred Drakec9680921999-12-13 16:37:25 +000010563#endif
Fred Draked86ed291999-12-15 15:34:33 +000010564#ifdef _SC_NPROC_CONF
Victor Stinner8c62be82010-05-06 00:08:46 +000010565 {"SC_NPROC_CONF", _SC_NPROC_CONF},
Fred Draked86ed291999-12-15 15:34:33 +000010566#endif
10567#ifdef _SC_NPROC_ONLN
Victor Stinner8c62be82010-05-06 00:08:46 +000010568 {"SC_NPROC_ONLN", _SC_NPROC_ONLN},
Fred Draked86ed291999-12-15 15:34:33 +000010569#endif
Fred Drakec9680921999-12-13 16:37:25 +000010570#ifdef _SC_NZERO
Victor Stinner8c62be82010-05-06 00:08:46 +000010571 {"SC_NZERO", _SC_NZERO},
Fred Drakec9680921999-12-13 16:37:25 +000010572#endif
10573#ifdef _SC_OPEN_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010574 {"SC_OPEN_MAX", _SC_OPEN_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010575#endif
10576#ifdef _SC_PAGESIZE
Victor Stinner8c62be82010-05-06 00:08:46 +000010577 {"SC_PAGESIZE", _SC_PAGESIZE},
Fred Drakec9680921999-12-13 16:37:25 +000010578#endif
10579#ifdef _SC_PAGE_SIZE
Victor Stinner8c62be82010-05-06 00:08:46 +000010580 {"SC_PAGE_SIZE", _SC_PAGE_SIZE},
Fred Drakec9680921999-12-13 16:37:25 +000010581#endif
10582#ifdef _SC_PASS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010583 {"SC_PASS_MAX", _SC_PASS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010584#endif
10585#ifdef _SC_PHYS_PAGES
Victor Stinner8c62be82010-05-06 00:08:46 +000010586 {"SC_PHYS_PAGES", _SC_PHYS_PAGES},
Fred Drakec9680921999-12-13 16:37:25 +000010587#endif
10588#ifdef _SC_PII
Victor Stinner8c62be82010-05-06 00:08:46 +000010589 {"SC_PII", _SC_PII},
Fred Drakec9680921999-12-13 16:37:25 +000010590#endif
10591#ifdef _SC_PII_INTERNET
Victor Stinner8c62be82010-05-06 00:08:46 +000010592 {"SC_PII_INTERNET", _SC_PII_INTERNET},
Fred Drakec9680921999-12-13 16:37:25 +000010593#endif
10594#ifdef _SC_PII_INTERNET_DGRAM
Victor Stinner8c62be82010-05-06 00:08:46 +000010595 {"SC_PII_INTERNET_DGRAM", _SC_PII_INTERNET_DGRAM},
Fred Drakec9680921999-12-13 16:37:25 +000010596#endif
10597#ifdef _SC_PII_INTERNET_STREAM
Victor Stinner8c62be82010-05-06 00:08:46 +000010598 {"SC_PII_INTERNET_STREAM", _SC_PII_INTERNET_STREAM},
Fred Drakec9680921999-12-13 16:37:25 +000010599#endif
10600#ifdef _SC_PII_OSI
Victor Stinner8c62be82010-05-06 00:08:46 +000010601 {"SC_PII_OSI", _SC_PII_OSI},
Fred Drakec9680921999-12-13 16:37:25 +000010602#endif
10603#ifdef _SC_PII_OSI_CLTS
Victor Stinner8c62be82010-05-06 00:08:46 +000010604 {"SC_PII_OSI_CLTS", _SC_PII_OSI_CLTS},
Fred Drakec9680921999-12-13 16:37:25 +000010605#endif
10606#ifdef _SC_PII_OSI_COTS
Victor Stinner8c62be82010-05-06 00:08:46 +000010607 {"SC_PII_OSI_COTS", _SC_PII_OSI_COTS},
Fred Drakec9680921999-12-13 16:37:25 +000010608#endif
10609#ifdef _SC_PII_OSI_M
Victor Stinner8c62be82010-05-06 00:08:46 +000010610 {"SC_PII_OSI_M", _SC_PII_OSI_M},
Fred Drakec9680921999-12-13 16:37:25 +000010611#endif
10612#ifdef _SC_PII_SOCKET
Victor Stinner8c62be82010-05-06 00:08:46 +000010613 {"SC_PII_SOCKET", _SC_PII_SOCKET},
Fred Drakec9680921999-12-13 16:37:25 +000010614#endif
10615#ifdef _SC_PII_XTI
Victor Stinner8c62be82010-05-06 00:08:46 +000010616 {"SC_PII_XTI", _SC_PII_XTI},
Fred Drakec9680921999-12-13 16:37:25 +000010617#endif
10618#ifdef _SC_POLL
Victor Stinner8c62be82010-05-06 00:08:46 +000010619 {"SC_POLL", _SC_POLL},
Fred Drakec9680921999-12-13 16:37:25 +000010620#endif
10621#ifdef _SC_PRIORITIZED_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000010622 {"SC_PRIORITIZED_IO", _SC_PRIORITIZED_IO},
Fred Drakec9680921999-12-13 16:37:25 +000010623#endif
10624#ifdef _SC_PRIORITY_SCHEDULING
Victor Stinner8c62be82010-05-06 00:08:46 +000010625 {"SC_PRIORITY_SCHEDULING", _SC_PRIORITY_SCHEDULING},
Fred Drakec9680921999-12-13 16:37:25 +000010626#endif
10627#ifdef _SC_REALTIME_SIGNALS
Victor Stinner8c62be82010-05-06 00:08:46 +000010628 {"SC_REALTIME_SIGNALS", _SC_REALTIME_SIGNALS},
Fred Drakec9680921999-12-13 16:37:25 +000010629#endif
10630#ifdef _SC_RE_DUP_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010631 {"SC_RE_DUP_MAX", _SC_RE_DUP_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010632#endif
10633#ifdef _SC_RTSIG_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010634 {"SC_RTSIG_MAX", _SC_RTSIG_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010635#endif
10636#ifdef _SC_SAVED_IDS
Victor Stinner8c62be82010-05-06 00:08:46 +000010637 {"SC_SAVED_IDS", _SC_SAVED_IDS},
Fred Drakec9680921999-12-13 16:37:25 +000010638#endif
10639#ifdef _SC_SCHAR_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010640 {"SC_SCHAR_MAX", _SC_SCHAR_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010641#endif
10642#ifdef _SC_SCHAR_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000010643 {"SC_SCHAR_MIN", _SC_SCHAR_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000010644#endif
10645#ifdef _SC_SELECT
Victor Stinner8c62be82010-05-06 00:08:46 +000010646 {"SC_SELECT", _SC_SELECT},
Fred Drakec9680921999-12-13 16:37:25 +000010647#endif
10648#ifdef _SC_SEMAPHORES
Victor Stinner8c62be82010-05-06 00:08:46 +000010649 {"SC_SEMAPHORES", _SC_SEMAPHORES},
Fred Drakec9680921999-12-13 16:37:25 +000010650#endif
10651#ifdef _SC_SEM_NSEMS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010652 {"SC_SEM_NSEMS_MAX", _SC_SEM_NSEMS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010653#endif
10654#ifdef _SC_SEM_VALUE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010655 {"SC_SEM_VALUE_MAX", _SC_SEM_VALUE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010656#endif
10657#ifdef _SC_SHARED_MEMORY_OBJECTS
Victor Stinner8c62be82010-05-06 00:08:46 +000010658 {"SC_SHARED_MEMORY_OBJECTS", _SC_SHARED_MEMORY_OBJECTS},
Fred Drakec9680921999-12-13 16:37:25 +000010659#endif
10660#ifdef _SC_SHRT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010661 {"SC_SHRT_MAX", _SC_SHRT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010662#endif
10663#ifdef _SC_SHRT_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000010664 {"SC_SHRT_MIN", _SC_SHRT_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000010665#endif
10666#ifdef _SC_SIGQUEUE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010667 {"SC_SIGQUEUE_MAX", _SC_SIGQUEUE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010668#endif
10669#ifdef _SC_SIGRT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010670 {"SC_SIGRT_MAX", _SC_SIGRT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010671#endif
10672#ifdef _SC_SIGRT_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000010673 {"SC_SIGRT_MIN", _SC_SIGRT_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000010674#endif
Fred Draked86ed291999-12-15 15:34:33 +000010675#ifdef _SC_SOFTPOWER
Victor Stinner8c62be82010-05-06 00:08:46 +000010676 {"SC_SOFTPOWER", _SC_SOFTPOWER},
Fred Draked86ed291999-12-15 15:34:33 +000010677#endif
Fred Drakec9680921999-12-13 16:37:25 +000010678#ifdef _SC_SPLIT_CACHE
Victor Stinner8c62be82010-05-06 00:08:46 +000010679 {"SC_SPLIT_CACHE", _SC_SPLIT_CACHE},
Fred Drakec9680921999-12-13 16:37:25 +000010680#endif
10681#ifdef _SC_SSIZE_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010682 {"SC_SSIZE_MAX", _SC_SSIZE_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010683#endif
10684#ifdef _SC_STACK_PROT
Victor Stinner8c62be82010-05-06 00:08:46 +000010685 {"SC_STACK_PROT", _SC_STACK_PROT},
Fred Drakec9680921999-12-13 16:37:25 +000010686#endif
10687#ifdef _SC_STREAM_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010688 {"SC_STREAM_MAX", _SC_STREAM_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010689#endif
10690#ifdef _SC_SYNCHRONIZED_IO
Victor Stinner8c62be82010-05-06 00:08:46 +000010691 {"SC_SYNCHRONIZED_IO", _SC_SYNCHRONIZED_IO},
Fred Drakec9680921999-12-13 16:37:25 +000010692#endif
10693#ifdef _SC_THREADS
Victor Stinner8c62be82010-05-06 00:08:46 +000010694 {"SC_THREADS", _SC_THREADS},
Fred Drakec9680921999-12-13 16:37:25 +000010695#endif
10696#ifdef _SC_THREAD_ATTR_STACKADDR
Victor Stinner8c62be82010-05-06 00:08:46 +000010697 {"SC_THREAD_ATTR_STACKADDR", _SC_THREAD_ATTR_STACKADDR},
Fred Drakec9680921999-12-13 16:37:25 +000010698#endif
10699#ifdef _SC_THREAD_ATTR_STACKSIZE
Victor Stinner8c62be82010-05-06 00:08:46 +000010700 {"SC_THREAD_ATTR_STACKSIZE", _SC_THREAD_ATTR_STACKSIZE},
Fred Drakec9680921999-12-13 16:37:25 +000010701#endif
10702#ifdef _SC_THREAD_DESTRUCTOR_ITERATIONS
Victor Stinner8c62be82010-05-06 00:08:46 +000010703 {"SC_THREAD_DESTRUCTOR_ITERATIONS", _SC_THREAD_DESTRUCTOR_ITERATIONS},
Fred Drakec9680921999-12-13 16:37:25 +000010704#endif
10705#ifdef _SC_THREAD_KEYS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010706 {"SC_THREAD_KEYS_MAX", _SC_THREAD_KEYS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010707#endif
10708#ifdef _SC_THREAD_PRIORITY_SCHEDULING
Victor Stinner8c62be82010-05-06 00:08:46 +000010709 {"SC_THREAD_PRIORITY_SCHEDULING", _SC_THREAD_PRIORITY_SCHEDULING},
Fred Drakec9680921999-12-13 16:37:25 +000010710#endif
10711#ifdef _SC_THREAD_PRIO_INHERIT
Victor Stinner8c62be82010-05-06 00:08:46 +000010712 {"SC_THREAD_PRIO_INHERIT", _SC_THREAD_PRIO_INHERIT},
Fred Drakec9680921999-12-13 16:37:25 +000010713#endif
10714#ifdef _SC_THREAD_PRIO_PROTECT
Victor Stinner8c62be82010-05-06 00:08:46 +000010715 {"SC_THREAD_PRIO_PROTECT", _SC_THREAD_PRIO_PROTECT},
Fred Drakec9680921999-12-13 16:37:25 +000010716#endif
10717#ifdef _SC_THREAD_PROCESS_SHARED
Victor Stinner8c62be82010-05-06 00:08:46 +000010718 {"SC_THREAD_PROCESS_SHARED", _SC_THREAD_PROCESS_SHARED},
Fred Drakec9680921999-12-13 16:37:25 +000010719#endif
10720#ifdef _SC_THREAD_SAFE_FUNCTIONS
Victor Stinner8c62be82010-05-06 00:08:46 +000010721 {"SC_THREAD_SAFE_FUNCTIONS", _SC_THREAD_SAFE_FUNCTIONS},
Fred Drakec9680921999-12-13 16:37:25 +000010722#endif
10723#ifdef _SC_THREAD_STACK_MIN
Victor Stinner8c62be82010-05-06 00:08:46 +000010724 {"SC_THREAD_STACK_MIN", _SC_THREAD_STACK_MIN},
Fred Drakec9680921999-12-13 16:37:25 +000010725#endif
10726#ifdef _SC_THREAD_THREADS_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010727 {"SC_THREAD_THREADS_MAX", _SC_THREAD_THREADS_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010728#endif
10729#ifdef _SC_TIMERS
Victor Stinner8c62be82010-05-06 00:08:46 +000010730 {"SC_TIMERS", _SC_TIMERS},
Fred Drakec9680921999-12-13 16:37:25 +000010731#endif
10732#ifdef _SC_TIMER_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010733 {"SC_TIMER_MAX", _SC_TIMER_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010734#endif
10735#ifdef _SC_TTY_NAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010736 {"SC_TTY_NAME_MAX", _SC_TTY_NAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010737#endif
10738#ifdef _SC_TZNAME_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010739 {"SC_TZNAME_MAX", _SC_TZNAME_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010740#endif
10741#ifdef _SC_T_IOV_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010742 {"SC_T_IOV_MAX", _SC_T_IOV_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010743#endif
10744#ifdef _SC_UCHAR_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010745 {"SC_UCHAR_MAX", _SC_UCHAR_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010746#endif
10747#ifdef _SC_UINT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010748 {"SC_UINT_MAX", _SC_UINT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010749#endif
10750#ifdef _SC_UIO_MAXIOV
Victor Stinner8c62be82010-05-06 00:08:46 +000010751 {"SC_UIO_MAXIOV", _SC_UIO_MAXIOV},
Fred Drakec9680921999-12-13 16:37:25 +000010752#endif
10753#ifdef _SC_ULONG_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010754 {"SC_ULONG_MAX", _SC_ULONG_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010755#endif
10756#ifdef _SC_USHRT_MAX
Victor Stinner8c62be82010-05-06 00:08:46 +000010757 {"SC_USHRT_MAX", _SC_USHRT_MAX},
Fred Drakec9680921999-12-13 16:37:25 +000010758#endif
10759#ifdef _SC_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000010760 {"SC_VERSION", _SC_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000010761#endif
10762#ifdef _SC_WORD_BIT
Victor Stinner8c62be82010-05-06 00:08:46 +000010763 {"SC_WORD_BIT", _SC_WORD_BIT},
Fred Drakec9680921999-12-13 16:37:25 +000010764#endif
10765#ifdef _SC_XBS5_ILP32_OFF32
Victor Stinner8c62be82010-05-06 00:08:46 +000010766 {"SC_XBS5_ILP32_OFF32", _SC_XBS5_ILP32_OFF32},
Fred Drakec9680921999-12-13 16:37:25 +000010767#endif
10768#ifdef _SC_XBS5_ILP32_OFFBIG
Victor Stinner8c62be82010-05-06 00:08:46 +000010769 {"SC_XBS5_ILP32_OFFBIG", _SC_XBS5_ILP32_OFFBIG},
Fred Drakec9680921999-12-13 16:37:25 +000010770#endif
10771#ifdef _SC_XBS5_LP64_OFF64
Victor Stinner8c62be82010-05-06 00:08:46 +000010772 {"SC_XBS5_LP64_OFF64", _SC_XBS5_LP64_OFF64},
Fred Drakec9680921999-12-13 16:37:25 +000010773#endif
10774#ifdef _SC_XBS5_LPBIG_OFFBIG
Victor Stinner8c62be82010-05-06 00:08:46 +000010775 {"SC_XBS5_LPBIG_OFFBIG", _SC_XBS5_LPBIG_OFFBIG},
Fred Drakec9680921999-12-13 16:37:25 +000010776#endif
10777#ifdef _SC_XOPEN_CRYPT
Victor Stinner8c62be82010-05-06 00:08:46 +000010778 {"SC_XOPEN_CRYPT", _SC_XOPEN_CRYPT},
Fred Drakec9680921999-12-13 16:37:25 +000010779#endif
10780#ifdef _SC_XOPEN_ENH_I18N
Victor Stinner8c62be82010-05-06 00:08:46 +000010781 {"SC_XOPEN_ENH_I18N", _SC_XOPEN_ENH_I18N},
Fred Drakec9680921999-12-13 16:37:25 +000010782#endif
10783#ifdef _SC_XOPEN_LEGACY
Victor Stinner8c62be82010-05-06 00:08:46 +000010784 {"SC_XOPEN_LEGACY", _SC_XOPEN_LEGACY},
Fred Drakec9680921999-12-13 16:37:25 +000010785#endif
10786#ifdef _SC_XOPEN_REALTIME
Victor Stinner8c62be82010-05-06 00:08:46 +000010787 {"SC_XOPEN_REALTIME", _SC_XOPEN_REALTIME},
Fred Drakec9680921999-12-13 16:37:25 +000010788#endif
10789#ifdef _SC_XOPEN_REALTIME_THREADS
Victor Stinner8c62be82010-05-06 00:08:46 +000010790 {"SC_XOPEN_REALTIME_THREADS", _SC_XOPEN_REALTIME_THREADS},
Fred Drakec9680921999-12-13 16:37:25 +000010791#endif
10792#ifdef _SC_XOPEN_SHM
Victor Stinner8c62be82010-05-06 00:08:46 +000010793 {"SC_XOPEN_SHM", _SC_XOPEN_SHM},
Fred Drakec9680921999-12-13 16:37:25 +000010794#endif
10795#ifdef _SC_XOPEN_UNIX
Victor Stinner8c62be82010-05-06 00:08:46 +000010796 {"SC_XOPEN_UNIX", _SC_XOPEN_UNIX},
Fred Drakec9680921999-12-13 16:37:25 +000010797#endif
10798#ifdef _SC_XOPEN_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000010799 {"SC_XOPEN_VERSION", _SC_XOPEN_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000010800#endif
10801#ifdef _SC_XOPEN_XCU_VERSION
Victor Stinner8c62be82010-05-06 00:08:46 +000010802 {"SC_XOPEN_XCU_VERSION", _SC_XOPEN_XCU_VERSION},
Fred Drakec9680921999-12-13 16:37:25 +000010803#endif
10804#ifdef _SC_XOPEN_XPG2
Victor Stinner8c62be82010-05-06 00:08:46 +000010805 {"SC_XOPEN_XPG2", _SC_XOPEN_XPG2},
Fred Drakec9680921999-12-13 16:37:25 +000010806#endif
10807#ifdef _SC_XOPEN_XPG3
Victor Stinner8c62be82010-05-06 00:08:46 +000010808 {"SC_XOPEN_XPG3", _SC_XOPEN_XPG3},
Fred Drakec9680921999-12-13 16:37:25 +000010809#endif
10810#ifdef _SC_XOPEN_XPG4
Victor Stinner8c62be82010-05-06 00:08:46 +000010811 {"SC_XOPEN_XPG4", _SC_XOPEN_XPG4},
Fred Drakec9680921999-12-13 16:37:25 +000010812#endif
10813};
10814
10815static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000010816conv_sysconf_confname(PyObject *arg, int *valuep)
Fred Drakec9680921999-12-13 16:37:25 +000010817{
10818 return conv_confname(arg, valuep, posix_constants_sysconf,
10819 sizeof(posix_constants_sysconf)
10820 / sizeof(struct constdef));
10821}
10822
Larry Hastings2f936352014-08-05 14:04:04 +100010823
10824/*[clinic input]
10825os.sysconf -> long
10826 name: sysconf_confname
10827 /
10828
10829Return an integer-valued system configuration variable.
10830[clinic start generated code]*/
10831
Larry Hastings2f936352014-08-05 14:04:04 +100010832static long
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010833os_sysconf_impl(PyObject *module, int name)
10834/*[clinic end generated code: output=3662f945fc0cc756 input=279e3430a33f29e4]*/
Larry Hastings2f936352014-08-05 14:04:04 +100010835{
10836 long value;
10837
10838 errno = 0;
10839 value = sysconf(name);
10840 if (value == -1 && errno != 0)
10841 posix_error();
10842 return value;
10843}
10844#endif /* HAVE_SYSCONF */
Fred Drakec9680921999-12-13 16:37:25 +000010845
10846
Fred Drakebec628d1999-12-15 18:31:10 +000010847/* This code is used to ensure that the tables of configuration value names
Serhiy Storchaka56a6d852014-12-01 18:28:43 +020010848 * are in sorted order as required by conv_confname(), and also to build
Fred Drakebec628d1999-12-15 18:31:10 +000010849 * the exported dictionaries that are used to publish information about the
10850 * names available on the host platform.
10851 *
10852 * Sorting the table at runtime ensures that the table is properly ordered
10853 * when used, even for platforms we're not able to test on. It also makes
10854 * it easier to add additional entries to the tables.
Fred Draked86ed291999-12-15 15:34:33 +000010855 */
Fred Drakebec628d1999-12-15 18:31:10 +000010856
10857static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000010858cmp_constdefs(const void *v1, const void *v2)
Fred Drakebec628d1999-12-15 18:31:10 +000010859{
10860 const struct constdef *c1 =
Victor Stinner8c62be82010-05-06 00:08:46 +000010861 (const struct constdef *) v1;
Fred Drakebec628d1999-12-15 18:31:10 +000010862 const struct constdef *c2 =
Victor Stinner8c62be82010-05-06 00:08:46 +000010863 (const struct constdef *) v2;
Fred Drakebec628d1999-12-15 18:31:10 +000010864
10865 return strcmp(c1->name, c2->name);
10866}
10867
10868static int
Fredrik Lundhff7df9d2000-07-08 22:48:53 +000010869setup_confname_table(struct constdef *table, size_t tablesize,
Serhiy Storchakadeab18d2016-05-07 16:45:18 +030010870 const char *tablename, PyObject *module)
Fred Draked86ed291999-12-15 15:34:33 +000010871{
Fred Drakebec628d1999-12-15 18:31:10 +000010872 PyObject *d = NULL;
Barry Warsaw3155db32000-04-13 15:20:40 +000010873 size_t i;
Fred Drakebec628d1999-12-15 18:31:10 +000010874
10875 qsort(table, tablesize, sizeof(struct constdef), cmp_constdefs);
10876 d = PyDict_New();
Barry Warsaw3155db32000-04-13 15:20:40 +000010877 if (d == NULL)
Victor Stinner8c62be82010-05-06 00:08:46 +000010878 return -1;
Fred Draked86ed291999-12-15 15:34:33 +000010879
Barry Warsaw3155db32000-04-13 15:20:40 +000010880 for (i=0; i < tablesize; ++i) {
Victor Stinner8c62be82010-05-06 00:08:46 +000010881 PyObject *o = PyLong_FromLong(table[i].value);
10882 if (o == NULL || PyDict_SetItemString(d, table[i].name, o) == -1) {
10883 Py_XDECREF(o);
10884 Py_DECREF(d);
10885 return -1;
10886 }
10887 Py_DECREF(o);
Fred Draked86ed291999-12-15 15:34:33 +000010888 }
Fred Drake4d1e64b2002-04-15 19:40:07 +000010889 return PyModule_AddObject(module, tablename, d);
Fred Draked86ed291999-12-15 15:34:33 +000010890}
10891
Fred Drakebec628d1999-12-15 18:31:10 +000010892/* Return -1 on failure, 0 on success. */
10893static int
Fred Drake4d1e64b2002-04-15 19:40:07 +000010894setup_confname_tables(PyObject *module)
Fred Draked86ed291999-12-15 15:34:33 +000010895{
10896#if defined(HAVE_FPATHCONF) || defined(HAVE_PATHCONF)
Fred Drakebec628d1999-12-15 18:31:10 +000010897 if (setup_confname_table(posix_constants_pathconf,
Fred Draked86ed291999-12-15 15:34:33 +000010898 sizeof(posix_constants_pathconf)
10899 / sizeof(struct constdef),
Fred Drake4d1e64b2002-04-15 19:40:07 +000010900 "pathconf_names", module))
Stefan Krah0e803b32010-11-26 16:16:47 +000010901 return -1;
Fred Draked86ed291999-12-15 15:34:33 +000010902#endif
10903#ifdef HAVE_CONFSTR
Fred Drakebec628d1999-12-15 18:31:10 +000010904 if (setup_confname_table(posix_constants_confstr,
Fred Draked86ed291999-12-15 15:34:33 +000010905 sizeof(posix_constants_confstr)
10906 / sizeof(struct constdef),
Fred Drake4d1e64b2002-04-15 19:40:07 +000010907 "confstr_names", module))
Stefan Krah0e803b32010-11-26 16:16:47 +000010908 return -1;
Fred Draked86ed291999-12-15 15:34:33 +000010909#endif
10910#ifdef HAVE_SYSCONF
Fred Drakebec628d1999-12-15 18:31:10 +000010911 if (setup_confname_table(posix_constants_sysconf,
Fred Draked86ed291999-12-15 15:34:33 +000010912 sizeof(posix_constants_sysconf)
10913 / sizeof(struct constdef),
Fred Drake4d1e64b2002-04-15 19:40:07 +000010914 "sysconf_names", module))
Stefan Krah0e803b32010-11-26 16:16:47 +000010915 return -1;
Fred Draked86ed291999-12-15 15:34:33 +000010916#endif
Fred Drakebec628d1999-12-15 18:31:10 +000010917 return 0;
Fred Draked86ed291999-12-15 15:34:33 +000010918}
Fred Draked86ed291999-12-15 15:34:33 +000010919
10920
Larry Hastings2f936352014-08-05 14:04:04 +100010921/*[clinic input]
10922os.abort
10923
10924Abort the interpreter immediately.
10925
10926This function 'dumps core' or otherwise fails in the hardest way possible
10927on the hosting operating system. This function never returns.
10928[clinic start generated code]*/
10929
Larry Hastings2f936352014-08-05 14:04:04 +100010930static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030010931os_abort_impl(PyObject *module)
10932/*[clinic end generated code: output=dcf52586dad2467c input=cf2c7d98bc504047]*/
Fred Drake5ab8eaf1999-12-09 21:13:07 +000010933{
Fred Drake5ab8eaf1999-12-09 21:13:07 +000010934 abort();
10935 /*NOTREACHED*/
Victor Stinner9a2329f2016-12-05 17:56:36 +010010936#ifndef __clang__
10937 /* Issue #28152: abort() is declared with __attribute__((__noreturn__)).
10938 GCC emits a warning without "return NULL;" (compiler bug?), but Clang
10939 is smarter and emits a warning on the return. */
Fred Drake5ab8eaf1999-12-09 21:13:07 +000010940 Py_FatalError("abort() called from Python code didn't abort!");
10941 return NULL;
Victor Stinner9a2329f2016-12-05 17:56:36 +010010942#endif
Fred Drake5ab8eaf1999-12-09 21:13:07 +000010943}
Fred Drakebec628d1999-12-15 18:31:10 +000010944
Martin v. Löwis6238d2b2002-06-30 15:26:10 +000010945#ifdef MS_WINDOWS
Steve Dower7d0e0c92015-01-24 08:18:24 -080010946/* Grab ShellExecute dynamically from shell32 */
10947static int has_ShellExecute = -1;
Steve Dower7d0e0c92015-01-24 08:18:24 -080010948static HINSTANCE (CALLBACK *Py_ShellExecuteW)(HWND, LPCWSTR, LPCWSTR, LPCWSTR,
10949 LPCWSTR, INT);
10950static int
10951check_ShellExecute()
10952{
10953 HINSTANCE hShell32;
10954
10955 /* only recheck */
10956 if (-1 == has_ShellExecute) {
10957 Py_BEGIN_ALLOW_THREADS
Victor Stinnera9912152017-10-13 13:46:57 -070010958 /* Security note: this call is not vulnerable to "DLL hijacking".
10959 SHELL32 is part of "KnownDLLs" and so Windows always load
10960 the system SHELL32.DLL, even if there is another SHELL32.DLL
10961 in the DLL search path. */
Steve Dower7d0e0c92015-01-24 08:18:24 -080010962 hShell32 = LoadLibraryW(L"SHELL32");
10963 Py_END_ALLOW_THREADS
10964 if (hShell32) {
Steve Dower7d0e0c92015-01-24 08:18:24 -080010965 *(FARPROC*)&Py_ShellExecuteW = GetProcAddress(hShell32,
10966 "ShellExecuteW");
Steve Dowercc16be82016-09-08 10:35:16 -070010967 has_ShellExecute = Py_ShellExecuteW != NULL;
Steve Dower7d0e0c92015-01-24 08:18:24 -080010968 } else {
10969 has_ShellExecute = 0;
10970 }
10971 }
10972 return has_ShellExecute;
10973}
10974
10975
Steve Dowercc16be82016-09-08 10:35:16 -070010976/*[clinic input]
10977os.startfile
10978 filepath: path_t
10979 operation: Py_UNICODE = NULL
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +000010980
Steve Dowercc16be82016-09-08 10:35:16 -070010981startfile(filepath [, operation])
10982
10983Start a file with its associated application.
10984
10985When "operation" is not specified or "open", this acts like
10986double-clicking the file in Explorer, or giving the file name as an
10987argument to the DOS "start" command: the file is opened with whatever
10988application (if any) its extension is associated.
10989When another "operation" is given, it specifies what should be done with
10990the file. A typical operation is "print".
10991
10992startfile returns as soon as the associated application is launched.
10993There is no option to wait for the application to close, and no way
10994to retrieve the application's exit status.
10995
10996The filepath is relative to the current directory. If you want to use
10997an absolute path, make sure the first character is not a slash ("/");
10998the underlying Win32 ShellExecute function doesn't work if it is.
10999[clinic start generated code]*/
11000
11001static PyObject *
11002os_startfile_impl(PyObject *module, path_t *filepath, Py_UNICODE *operation)
11003/*[clinic end generated code: output=912ceba79acfa1c9 input=63950bf2986380d0]*/
11004{
11005 HINSTANCE rc;
Steve Dower7d0e0c92015-01-24 08:18:24 -080011006
11007 if(!check_ShellExecute()) {
11008 /* If the OS doesn't have ShellExecute, return a
11009 NotImplementedError. */
11010 return PyErr_Format(PyExc_NotImplementedError,
11011 "startfile not available on this platform");
11012 }
11013
Victor Stinner8c62be82010-05-06 00:08:46 +000011014 Py_BEGIN_ALLOW_THREADS
Steve Dowercc16be82016-09-08 10:35:16 -070011015 rc = Py_ShellExecuteW((HWND)0, operation, filepath->wide,
Steve Dower7d0e0c92015-01-24 08:18:24 -080011016 NULL, NULL, SW_SHOWNORMAL);
Victor Stinner8c62be82010-05-06 00:08:46 +000011017 Py_END_ALLOW_THREADS
11018
Victor Stinner8c62be82010-05-06 00:08:46 +000011019 if (rc <= (HINSTANCE)32) {
Steve Dowercc16be82016-09-08 10:35:16 -070011020 win32_error_object("startfile", filepath->object);
Victor Stinnereb5657a2011-09-30 01:44:27 +020011021 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +000011022 }
Steve Dowercc16be82016-09-08 10:35:16 -070011023 Py_RETURN_NONE;
Tim Petersf58a7aa2000-09-22 10:05:54 +000011024}
Larry Hastings2f936352014-08-05 14:04:04 +100011025#endif /* MS_WINDOWS */
11026
Fred Drake5ab8eaf1999-12-09 21:13:07 +000011027
Martin v. Löwis438b5342002-12-27 10:16:42 +000011028#ifdef HAVE_GETLOADAVG
Larry Hastings2f936352014-08-05 14:04:04 +100011029/*[clinic input]
11030os.getloadavg
11031
11032Return average recent system load information.
11033
11034Return the number of processes in the system run queue averaged over
11035the last 1, 5, and 15 minutes as a tuple of three floats.
11036Raises OSError if the load average was unobtainable.
11037[clinic start generated code]*/
11038
Larry Hastings2f936352014-08-05 14:04:04 +100011039static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011040os_getloadavg_impl(PyObject *module)
11041/*[clinic end generated code: output=9ad3a11bfb4f4bd2 input=3d6d826b76d8a34e]*/
Martin v. Löwis438b5342002-12-27 10:16:42 +000011042{
11043 double loadavg[3];
Martin v. Löwis438b5342002-12-27 10:16:42 +000011044 if (getloadavg(loadavg, 3)!=3) {
Stefan Krah0e803b32010-11-26 16:16:47 +000011045 PyErr_SetString(PyExc_OSError, "Load averages are unobtainable");
11046 return NULL;
Martin v. Löwis438b5342002-12-27 10:16:42 +000011047 } else
Stefan Krah0e803b32010-11-26 16:16:47 +000011048 return Py_BuildValue("ddd", loadavg[0], loadavg[1], loadavg[2]);
Martin v. Löwis438b5342002-12-27 10:16:42 +000011049}
Larry Hastings2f936352014-08-05 14:04:04 +100011050#endif /* HAVE_GETLOADAVG */
Martin v. Löwis438b5342002-12-27 10:16:42 +000011051
Larry Hastings2f936352014-08-05 14:04:04 +100011052
11053/*[clinic input]
11054os.device_encoding
11055 fd: int
11056
11057Return a string describing the encoding of a terminal's file descriptor.
11058
11059The file descriptor must be attached to a terminal.
11060If the device is not a terminal, return None.
11061[clinic start generated code]*/
11062
Larry Hastings2f936352014-08-05 14:04:04 +100011063static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011064os_device_encoding_impl(PyObject *module, int fd)
11065/*[clinic end generated code: output=e0d294bbab7e8c2b input=9e1d4a42b66df312]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011066{
Brett Cannonefb00c02012-02-29 18:31:31 -050011067 return _Py_device_encoding(fd);
Martin v. Löwisd1cd4d42007-08-11 14:02:14 +000011068}
11069
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011070
Larry Hastings2f936352014-08-05 14:04:04 +100011071#ifdef HAVE_SETRESUID
11072/*[clinic input]
11073os.setresuid
11074
11075 ruid: uid_t
11076 euid: uid_t
11077 suid: uid_t
11078 /
11079
11080Set the current process's real, effective, and saved user ids.
11081[clinic start generated code]*/
11082
Larry Hastings2f936352014-08-05 14:04:04 +100011083static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011084os_setresuid_impl(PyObject *module, uid_t ruid, uid_t euid, uid_t suid)
11085/*[clinic end generated code: output=834a641e15373e97 input=9e33cb79a82792f3]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011086{
Victor Stinner8c62be82010-05-06 00:08:46 +000011087 if (setresuid(ruid, euid, suid) < 0)
11088 return posix_error();
11089 Py_RETURN_NONE;
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011090}
Larry Hastings2f936352014-08-05 14:04:04 +100011091#endif /* HAVE_SETRESUID */
11092
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011093
11094#ifdef HAVE_SETRESGID
Larry Hastings2f936352014-08-05 14:04:04 +100011095/*[clinic input]
11096os.setresgid
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011097
Larry Hastings2f936352014-08-05 14:04:04 +100011098 rgid: gid_t
11099 egid: gid_t
11100 sgid: gid_t
11101 /
11102
11103Set the current process's real, effective, and saved group ids.
11104[clinic start generated code]*/
11105
Larry Hastings2f936352014-08-05 14:04:04 +100011106static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011107os_setresgid_impl(PyObject *module, gid_t rgid, gid_t egid, gid_t sgid)
11108/*[clinic end generated code: output=6aa402f3d2e514a9 input=33e9e0785ef426b1]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011109{
Victor Stinner8c62be82010-05-06 00:08:46 +000011110 if (setresgid(rgid, egid, sgid) < 0)
11111 return posix_error();
11112 Py_RETURN_NONE;
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011113}
Larry Hastings2f936352014-08-05 14:04:04 +100011114#endif /* HAVE_SETRESGID */
11115
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011116
11117#ifdef HAVE_GETRESUID
Larry Hastings2f936352014-08-05 14:04:04 +100011118/*[clinic input]
11119os.getresuid
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011120
Larry Hastings2f936352014-08-05 14:04:04 +100011121Return a tuple of the current process's real, effective, and saved user ids.
11122[clinic start generated code]*/
11123
Larry Hastings2f936352014-08-05 14:04:04 +100011124static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011125os_getresuid_impl(PyObject *module)
11126/*[clinic end generated code: output=8e0becff5dece5bf input=41ccfa8e1f6517ad]*/
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011127{
Victor Stinner8c62be82010-05-06 00:08:46 +000011128 uid_t ruid, euid, suid;
Victor Stinner8c62be82010-05-06 00:08:46 +000011129 if (getresuid(&ruid, &euid, &suid) < 0)
11130 return posix_error();
Serhiy Storchaka7cf55992013-02-10 21:56:49 +020011131 return Py_BuildValue("(NNN)", _PyLong_FromUid(ruid),
11132 _PyLong_FromUid(euid),
11133 _PyLong_FromUid(suid));
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011134}
Larry Hastings2f936352014-08-05 14:04:04 +100011135#endif /* HAVE_GETRESUID */
11136
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011137
11138#ifdef HAVE_GETRESGID
Larry Hastings2f936352014-08-05 14:04:04 +100011139/*[clinic input]
11140os.getresgid
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011141
Larry Hastings2f936352014-08-05 14:04:04 +100011142Return a tuple of the current process's real, effective, and saved group ids.
11143[clinic start generated code]*/
11144
Larry Hastings2f936352014-08-05 14:04:04 +100011145static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011146os_getresgid_impl(PyObject *module)
11147/*[clinic end generated code: output=2719c4bfcf27fb9f input=517e68db9ca32df6]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011148{
11149 gid_t rgid, egid, sgid;
Victor Stinner8c62be82010-05-06 00:08:46 +000011150 if (getresgid(&rgid, &egid, &sgid) < 0)
11151 return posix_error();
Serhiy Storchaka7cf55992013-02-10 21:56:49 +020011152 return Py_BuildValue("(NNN)", _PyLong_FromGid(rgid),
11153 _PyLong_FromGid(egid),
11154 _PyLong_FromGid(sgid));
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011155}
Larry Hastings2f936352014-08-05 14:04:04 +100011156#endif /* HAVE_GETRESGID */
11157
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000011158
Benjamin Peterson9428d532011-09-14 11:45:52 -040011159#ifdef USE_XATTRS
Larry Hastings2f936352014-08-05 14:04:04 +100011160/*[clinic input]
11161os.getxattr
Benjamin Peterson799bd802011-08-31 22:15:17 -040011162
Larry Hastings2f936352014-08-05 14:04:04 +100011163 path: path_t(allow_fd=True)
11164 attribute: path_t
11165 *
11166 follow_symlinks: bool = True
11167
11168Return the value of extended attribute attribute on path.
11169
11170path may be either a string or an open file descriptor.
11171If follow_symlinks is False, and the last element of the path is a symbolic
11172 link, getxattr will examine the symbolic link itself instead of the file
11173 the link points to.
11174
11175[clinic start generated code]*/
11176
Larry Hastings2f936352014-08-05 14:04:04 +100011177static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011178os_getxattr_impl(PyObject *module, path_t *path, path_t *attribute,
Larry Hastings89964c42015-04-14 18:07:59 -040011179 int follow_symlinks)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011180/*[clinic end generated code: output=5f2f44200a43cff2 input=8c8ea3bab78d89c2]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011181{
11182 Py_ssize_t i;
11183 PyObject *buffer = NULL;
11184
11185 if (fd_and_follow_symlinks_invalid("getxattr", path->fd, follow_symlinks))
11186 return NULL;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011187
Larry Hastings9cf065c2012-06-22 16:30:09 -070011188 for (i = 0; ; i++) {
11189 void *ptr;
11190 ssize_t result;
Serhiy Storchaka2d06e842015-12-25 19:53:18 +020011191 static const Py_ssize_t buffer_sizes[] = {128, XATTR_SIZE_MAX, 0};
Larry Hastings9cf065c2012-06-22 16:30:09 -070011192 Py_ssize_t buffer_size = buffer_sizes[i];
11193 if (!buffer_size) {
Larry Hastings2f936352014-08-05 14:04:04 +100011194 path_error(path);
11195 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070011196 }
11197 buffer = PyBytes_FromStringAndSize(NULL, buffer_size);
11198 if (!buffer)
Larry Hastings2f936352014-08-05 14:04:04 +100011199 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070011200 ptr = PyBytes_AS_STRING(buffer);
Benjamin Peterson799bd802011-08-31 22:15:17 -040011201
Larry Hastings9cf065c2012-06-22 16:30:09 -070011202 Py_BEGIN_ALLOW_THREADS;
Larry Hastings2f936352014-08-05 14:04:04 +100011203 if (path->fd >= 0)
11204 result = fgetxattr(path->fd, attribute->narrow, ptr, buffer_size);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011205 else if (follow_symlinks)
Larry Hastings2f936352014-08-05 14:04:04 +100011206 result = getxattr(path->narrow, attribute->narrow, ptr, buffer_size);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011207 else
Larry Hastings2f936352014-08-05 14:04:04 +100011208 result = lgetxattr(path->narrow, attribute->narrow, ptr, buffer_size);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011209 Py_END_ALLOW_THREADS;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011210
Larry Hastings9cf065c2012-06-22 16:30:09 -070011211 if (result < 0) {
11212 Py_DECREF(buffer);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011213 if (errno == ERANGE)
11214 continue;
Larry Hastings2f936352014-08-05 14:04:04 +100011215 path_error(path);
11216 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070011217 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040011218
Larry Hastings9cf065c2012-06-22 16:30:09 -070011219 if (result != buffer_size) {
11220 /* Can only shrink. */
11221 _PyBytes_Resize(&buffer, result);
11222 }
11223 break;
11224 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040011225
Larry Hastings9cf065c2012-06-22 16:30:09 -070011226 return buffer;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011227}
11228
Larry Hastings2f936352014-08-05 14:04:04 +100011229
11230/*[clinic input]
11231os.setxattr
11232
11233 path: path_t(allow_fd=True)
11234 attribute: path_t
11235 value: Py_buffer
11236 flags: int = 0
11237 *
11238 follow_symlinks: bool = True
11239
11240Set extended attribute attribute on path to value.
11241
11242path may be either a string or an open file descriptor.
11243If follow_symlinks is False, and the last element of the path is a symbolic
11244 link, setxattr will modify the symbolic link itself instead of the file
11245 the link points to.
11246
11247[clinic start generated code]*/
11248
Benjamin Peterson799bd802011-08-31 22:15:17 -040011249static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011250os_setxattr_impl(PyObject *module, path_t *path, path_t *attribute,
Larry Hastings89964c42015-04-14 18:07:59 -040011251 Py_buffer *value, int flags, int follow_symlinks)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011252/*[clinic end generated code: output=98b83f63fdde26bb input=f0d26833992015c2]*/
Benjamin Peterson799bd802011-08-31 22:15:17 -040011253{
Larry Hastings2f936352014-08-05 14:04:04 +100011254 ssize_t result;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011255
Larry Hastings2f936352014-08-05 14:04:04 +100011256 if (fd_and_follow_symlinks_invalid("setxattr", path->fd, follow_symlinks))
Benjamin Peterson799bd802011-08-31 22:15:17 -040011257 return NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070011258
Benjamin Peterson799bd802011-08-31 22:15:17 -040011259 Py_BEGIN_ALLOW_THREADS;
Larry Hastings2f936352014-08-05 14:04:04 +100011260 if (path->fd > -1)
11261 result = fsetxattr(path->fd, attribute->narrow,
11262 value->buf, value->len, flags);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011263 else if (follow_symlinks)
Larry Hastings2f936352014-08-05 14:04:04 +100011264 result = setxattr(path->narrow, attribute->narrow,
11265 value->buf, value->len, flags);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011266 else
Larry Hastings2f936352014-08-05 14:04:04 +100011267 result = lsetxattr(path->narrow, attribute->narrow,
11268 value->buf, value->len, flags);
Benjamin Peterson799bd802011-08-31 22:15:17 -040011269 Py_END_ALLOW_THREADS;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011270
Larry Hastings9cf065c2012-06-22 16:30:09 -070011271 if (result) {
Larry Hastings2f936352014-08-05 14:04:04 +100011272 path_error(path);
11273 return NULL;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011274 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040011275
Larry Hastings2f936352014-08-05 14:04:04 +100011276 Py_RETURN_NONE;
11277}
11278
11279
11280/*[clinic input]
11281os.removexattr
11282
11283 path: path_t(allow_fd=True)
11284 attribute: path_t
11285 *
11286 follow_symlinks: bool = True
11287
11288Remove extended attribute attribute on path.
11289
11290path may be either a string or an open file descriptor.
11291If follow_symlinks is False, and the last element of the path is a symbolic
11292 link, removexattr will modify the symbolic link itself instead of the file
11293 the link points to.
11294
11295[clinic start generated code]*/
11296
Larry Hastings2f936352014-08-05 14:04:04 +100011297static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011298os_removexattr_impl(PyObject *module, path_t *path, path_t *attribute,
Larry Hastings89964c42015-04-14 18:07:59 -040011299 int follow_symlinks)
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011300/*[clinic end generated code: output=521a51817980cda6 input=cdb54834161e3329]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011301{
11302 ssize_t result;
11303
11304 if (fd_and_follow_symlinks_invalid("removexattr", path->fd, follow_symlinks))
11305 return NULL;
11306
11307 Py_BEGIN_ALLOW_THREADS;
11308 if (path->fd > -1)
11309 result = fremovexattr(path->fd, attribute->narrow);
11310 else if (follow_symlinks)
11311 result = removexattr(path->narrow, attribute->narrow);
11312 else
11313 result = lremovexattr(path->narrow, attribute->narrow);
11314 Py_END_ALLOW_THREADS;
11315
11316 if (result) {
11317 return path_error(path);
11318 }
11319
11320 Py_RETURN_NONE;
11321}
11322
11323
11324/*[clinic input]
11325os.listxattr
11326
11327 path: path_t(allow_fd=True, nullable=True) = None
11328 *
11329 follow_symlinks: bool = True
11330
11331Return a list of extended attributes on path.
11332
11333path may be either None, a string, or an open file descriptor.
11334if path is None, listxattr will examine the current directory.
11335If follow_symlinks is False, and the last element of the path is a symbolic
11336 link, listxattr will examine the symbolic link itself instead of the file
11337 the link points to.
11338[clinic start generated code]*/
11339
Larry Hastings2f936352014-08-05 14:04:04 +100011340static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011341os_listxattr_impl(PyObject *module, path_t *path, int follow_symlinks)
11342/*[clinic end generated code: output=bebdb4e2ad0ce435 input=08cca53ac0b07c13]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011343{
Larry Hastings9cf065c2012-06-22 16:30:09 -070011344 Py_ssize_t i;
11345 PyObject *result = NULL;
Larry Hastings2f936352014-08-05 14:04:04 +100011346 const char *name;
Larry Hastings9cf065c2012-06-22 16:30:09 -070011347 char *buffer = NULL;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011348
Larry Hastings2f936352014-08-05 14:04:04 +100011349 if (fd_and_follow_symlinks_invalid("listxattr", path->fd, follow_symlinks))
Larry Hastings9cf065c2012-06-22 16:30:09 -070011350 goto exit;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011351
Larry Hastings2f936352014-08-05 14:04:04 +100011352 name = path->narrow ? path->narrow : ".";
11353
Larry Hastings9cf065c2012-06-22 16:30:09 -070011354 for (i = 0; ; i++) {
Serhiy Storchakadeab18d2016-05-07 16:45:18 +030011355 const char *start, *trace, *end;
Larry Hastings9cf065c2012-06-22 16:30:09 -070011356 ssize_t length;
Serhiy Storchaka2d06e842015-12-25 19:53:18 +020011357 static const Py_ssize_t buffer_sizes[] = { 256, XATTR_LIST_MAX, 0 };
Larry Hastings9cf065c2012-06-22 16:30:09 -070011358 Py_ssize_t buffer_size = buffer_sizes[i];
11359 if (!buffer_size) {
Christian Heimes3b9493b2012-09-23 16:11:15 +020011360 /* ERANGE */
Larry Hastings2f936352014-08-05 14:04:04 +100011361 path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011362 break;
11363 }
11364 buffer = PyMem_MALLOC(buffer_size);
11365 if (!buffer) {
11366 PyErr_NoMemory();
11367 break;
11368 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040011369
Larry Hastings9cf065c2012-06-22 16:30:09 -070011370 Py_BEGIN_ALLOW_THREADS;
Larry Hastings2f936352014-08-05 14:04:04 +100011371 if (path->fd > -1)
11372 length = flistxattr(path->fd, buffer, buffer_size);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011373 else if (follow_symlinks)
11374 length = listxattr(name, buffer, buffer_size);
11375 else
11376 length = llistxattr(name, buffer, buffer_size);
11377 Py_END_ALLOW_THREADS;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011378
Larry Hastings9cf065c2012-06-22 16:30:09 -070011379 if (length < 0) {
Antoine Pitrou7f987392013-05-13 19:46:29 +020011380 if (errno == ERANGE) {
11381 PyMem_FREE(buffer);
Benjamin Petersondedac522013-05-13 19:55:40 -050011382 buffer = NULL;
Larry Hastings9cf065c2012-06-22 16:30:09 -070011383 continue;
Antoine Pitrou7f987392013-05-13 19:46:29 +020011384 }
Larry Hastings2f936352014-08-05 14:04:04 +100011385 path_error(path);
Larry Hastings9cf065c2012-06-22 16:30:09 -070011386 break;
11387 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040011388
Larry Hastings9cf065c2012-06-22 16:30:09 -070011389 result = PyList_New(0);
11390 if (!result) {
11391 goto exit;
11392 }
Benjamin Peterson799bd802011-08-31 22:15:17 -040011393
Larry Hastings9cf065c2012-06-22 16:30:09 -070011394 end = buffer + length;
11395 for (trace = start = buffer; trace != end; trace++) {
11396 if (!*trace) {
11397 int error;
11398 PyObject *attribute = PyUnicode_DecodeFSDefaultAndSize(start,
11399 trace - start);
11400 if (!attribute) {
11401 Py_DECREF(result);
11402 result = NULL;
11403 goto exit;
11404 }
11405 error = PyList_Append(result, attribute);
11406 Py_DECREF(attribute);
11407 if (error) {
11408 Py_DECREF(result);
11409 result = NULL;
11410 goto exit;
11411 }
11412 start = trace + 1;
11413 }
11414 }
11415 break;
11416 }
11417exit:
Larry Hastings9cf065c2012-06-22 16:30:09 -070011418 if (buffer)
11419 PyMem_FREE(buffer);
11420 return result;
Benjamin Peterson799bd802011-08-31 22:15:17 -040011421}
Benjamin Peterson9428d532011-09-14 11:45:52 -040011422#endif /* USE_XATTRS */
Benjamin Peterson799bd802011-08-31 22:15:17 -040011423
Antoine Pitroubcf2b592012-02-08 23:28:36 +010011424
Larry Hastings2f936352014-08-05 14:04:04 +100011425/*[clinic input]
11426os.urandom
11427
11428 size: Py_ssize_t
11429 /
11430
11431Return a bytes object containing random bytes suitable for cryptographic use.
11432[clinic start generated code]*/
11433
Larry Hastings2f936352014-08-05 14:04:04 +100011434static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011435os_urandom_impl(PyObject *module, Py_ssize_t size)
11436/*[clinic end generated code: output=42c5cca9d18068e9 input=4067cdb1b6776c29]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011437{
11438 PyObject *bytes;
11439 int result;
11440
Georg Brandl2fb477c2012-02-21 00:33:36 +010011441 if (size < 0)
11442 return PyErr_Format(PyExc_ValueError,
11443 "negative argument not allowed");
Larry Hastings2f936352014-08-05 14:04:04 +100011444 bytes = PyBytes_FromStringAndSize(NULL, size);
11445 if (bytes == NULL)
Georg Brandl2fb477c2012-02-21 00:33:36 +010011446 return NULL;
11447
Victor Stinnere66987e2016-09-06 16:33:52 -070011448 result = _PyOS_URandom(PyBytes_AS_STRING(bytes), PyBytes_GET_SIZE(bytes));
Larry Hastings2f936352014-08-05 14:04:04 +100011449 if (result == -1) {
11450 Py_DECREF(bytes);
Georg Brandl2fb477c2012-02-21 00:33:36 +010011451 return NULL;
11452 }
Larry Hastings2f936352014-08-05 14:04:04 +100011453 return bytes;
Georg Brandl2fb477c2012-02-21 00:33:36 +010011454}
11455
Antoine Pitroubcf2b592012-02-08 23:28:36 +010011456/* Terminal size querying */
11457
11458static PyTypeObject TerminalSizeType;
11459
11460PyDoc_STRVAR(TerminalSize_docstring,
11461 "A tuple of (columns, lines) for holding terminal window size");
11462
11463static PyStructSequence_Field TerminalSize_fields[] = {
11464 {"columns", "width of the terminal window in characters"},
11465 {"lines", "height of the terminal window in characters"},
11466 {NULL, NULL}
11467};
11468
11469static PyStructSequence_Desc TerminalSize_desc = {
11470 "os.terminal_size",
11471 TerminalSize_docstring,
11472 TerminalSize_fields,
11473 2,
11474};
11475
11476#if defined(TERMSIZE_USE_CONIO) || defined(TERMSIZE_USE_IOCTL)
Larry Hastings2f936352014-08-05 14:04:04 +100011477/* AC 3.5: fd should accept None */
Antoine Pitroubcf2b592012-02-08 23:28:36 +010011478PyDoc_STRVAR(termsize__doc__,
11479 "Return the size of the terminal window as (columns, lines).\n" \
11480 "\n" \
11481 "The optional argument fd (default standard output) specifies\n" \
11482 "which file descriptor should be queried.\n" \
11483 "\n" \
11484 "If the file descriptor is not connected to a terminal, an OSError\n" \
11485 "is thrown.\n" \
11486 "\n" \
11487 "This function will only be defined if an implementation is\n" \
11488 "available for this system.\n" \
11489 "\n" \
11490 "shutil.get_terminal_size is the high-level function which should \n" \
11491 "normally be used, os.get_terminal_size is the low-level implementation.");
11492
11493static PyObject*
11494get_terminal_size(PyObject *self, PyObject *args)
11495{
11496 int columns, lines;
11497 PyObject *termsize;
11498
11499 int fd = fileno(stdout);
11500 /* Under some conditions stdout may not be connected and
11501 * fileno(stdout) may point to an invalid file descriptor. For example
11502 * GUI apps don't have valid standard streams by default.
11503 *
11504 * If this happens, and the optional fd argument is not present,
11505 * the ioctl below will fail returning EBADF. This is what we want.
11506 */
11507
11508 if (!PyArg_ParseTuple(args, "|i", &fd))
11509 return NULL;
11510
11511#ifdef TERMSIZE_USE_IOCTL
11512 {
11513 struct winsize w;
11514 if (ioctl(fd, TIOCGWINSZ, &w))
11515 return PyErr_SetFromErrno(PyExc_OSError);
11516 columns = w.ws_col;
11517 lines = w.ws_row;
11518 }
11519#endif /* TERMSIZE_USE_IOCTL */
11520
11521#ifdef TERMSIZE_USE_CONIO
11522 {
11523 DWORD nhandle;
11524 HANDLE handle;
11525 CONSOLE_SCREEN_BUFFER_INFO csbi;
11526 switch (fd) {
11527 case 0: nhandle = STD_INPUT_HANDLE;
11528 break;
11529 case 1: nhandle = STD_OUTPUT_HANDLE;
11530 break;
11531 case 2: nhandle = STD_ERROR_HANDLE;
11532 break;
11533 default:
11534 return PyErr_Format(PyExc_ValueError, "bad file descriptor");
11535 }
11536 handle = GetStdHandle(nhandle);
11537 if (handle == NULL)
11538 return PyErr_Format(PyExc_OSError, "handle cannot be retrieved");
11539 if (handle == INVALID_HANDLE_VALUE)
11540 return PyErr_SetFromWindowsErr(0);
11541
11542 if (!GetConsoleScreenBufferInfo(handle, &csbi))
11543 return PyErr_SetFromWindowsErr(0);
11544
11545 columns = csbi.srWindow.Right - csbi.srWindow.Left + 1;
11546 lines = csbi.srWindow.Bottom - csbi.srWindow.Top + 1;
11547 }
11548#endif /* TERMSIZE_USE_CONIO */
11549
11550 termsize = PyStructSequence_New(&TerminalSizeType);
11551 if (termsize == NULL)
11552 return NULL;
11553 PyStructSequence_SET_ITEM(termsize, 0, PyLong_FromLong(columns));
11554 PyStructSequence_SET_ITEM(termsize, 1, PyLong_FromLong(lines));
11555 if (PyErr_Occurred()) {
11556 Py_DECREF(termsize);
11557 return NULL;
11558 }
11559 return termsize;
11560}
11561#endif /* defined(TERMSIZE_USE_CONIO) || defined(TERMSIZE_USE_IOCTL) */
11562
Larry Hastings2f936352014-08-05 14:04:04 +100011563
11564/*[clinic input]
11565os.cpu_count
11566
Charles-François Natali80d62e62015-08-13 20:37:08 +010011567Return the number of CPUs in the system; return None if indeterminable.
11568
11569This number is not equivalent to the number of CPUs the current process can
11570use. The number of usable CPUs can be obtained with
11571``len(os.sched_getaffinity(0))``
Larry Hastings2f936352014-08-05 14:04:04 +100011572[clinic start generated code]*/
11573
Larry Hastings2f936352014-08-05 14:04:04 +100011574static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011575os_cpu_count_impl(PyObject *module)
Serhiy Storchaka2954f832016-07-07 18:20:03 +030011576/*[clinic end generated code: output=5fc29463c3936a9c input=e7c8f4ba6dbbadd3]*/
Charles-Francois Natali44feda32013-05-20 14:40:46 +020011577{
Charles-Francois Natalid59087d2013-05-20 17:31:06 +020011578 int ncpu = 0;
Charles-Francois Natali44feda32013-05-20 14:40:46 +020011579#ifdef MS_WINDOWS
Christopher Wilcoxc67bae02017-08-30 05:01:08 -040011580 /* Vista is supported and the GetMaximumProcessorCount API is Win7+
11581 Need to fallback to Vista behavior if this call isn't present */
11582 HINSTANCE hKernel32;
11583 hKernel32 = GetModuleHandleW(L"KERNEL32");
11584
11585 static DWORD(CALLBACK *_GetMaximumProcessorCount)(WORD) = NULL;
11586 *(FARPROC*)&_GetMaximumProcessorCount = GetProcAddress(hKernel32,
11587 "GetMaximumProcessorCount");
11588 if (_GetMaximumProcessorCount != NULL) {
11589 ncpu = _GetMaximumProcessorCount(ALL_PROCESSOR_GROUPS);
11590 }
11591 else {
11592 SYSTEM_INFO sysinfo;
11593 GetSystemInfo(&sysinfo);
11594 ncpu = sysinfo.dwNumberOfProcessors;
11595 }
Charles-Francois Natali44feda32013-05-20 14:40:46 +020011596#elif defined(__hpux)
11597 ncpu = mpctl(MPC_GETNUMSPUS, NULL, NULL);
11598#elif defined(HAVE_SYSCONF) && defined(_SC_NPROCESSORS_ONLN)
11599 ncpu = sysconf(_SC_NPROCESSORS_ONLN);
Charles-Francois Natali44feda32013-05-20 14:40:46 +020011600#elif defined(__DragonFly__) || \
11601 defined(__OpenBSD__) || \
11602 defined(__FreeBSD__) || \
Charles-Francois Natalid59087d2013-05-20 17:31:06 +020011603 defined(__NetBSD__) || \
11604 defined(__APPLE__)
Charles-Francois Natali7c4f8da2013-05-20 17:40:32 +020011605 int mib[2];
11606 size_t len = sizeof(ncpu);
11607 mib[0] = CTL_HW;
11608 mib[1] = HW_NCPU;
11609 if (sysctl(mib, 2, &ncpu, &len, NULL, 0) != 0)
11610 ncpu = 0;
Charles-Francois Natali44feda32013-05-20 14:40:46 +020011611#endif
11612 if (ncpu >= 1)
11613 return PyLong_FromLong(ncpu);
11614 else
11615 Py_RETURN_NONE;
11616}
11617
Victor Stinnerdaf45552013-08-28 00:53:59 +020011618
Larry Hastings2f936352014-08-05 14:04:04 +100011619/*[clinic input]
11620os.get_inheritable -> bool
11621
11622 fd: int
11623 /
11624
11625Get the close-on-exe flag of the specified file descriptor.
11626[clinic start generated code]*/
11627
Larry Hastings2f936352014-08-05 14:04:04 +100011628static int
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011629os_get_inheritable_impl(PyObject *module, int fd)
11630/*[clinic end generated code: output=0445e20e149aa5b8 input=89ac008dc9ab6b95]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011631{
Steve Dower8fc89802015-04-12 00:26:27 -040011632 int return_value;
Steve Dower8fc89802015-04-12 00:26:27 -040011633 _Py_BEGIN_SUPPRESS_IPH
11634 return_value = _Py_get_inheritable(fd);
11635 _Py_END_SUPPRESS_IPH
11636 return return_value;
Larry Hastings2f936352014-08-05 14:04:04 +100011637}
11638
11639
11640/*[clinic input]
11641os.set_inheritable
11642 fd: int
11643 inheritable: int
11644 /
11645
11646Set the inheritable flag of the specified file descriptor.
11647[clinic start generated code]*/
11648
Larry Hastings2f936352014-08-05 14:04:04 +100011649static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +030011650os_set_inheritable_impl(PyObject *module, int fd, int inheritable)
11651/*[clinic end generated code: output=f1b1918a2f3c38c2 input=9ceaead87a1e2402]*/
Victor Stinnerdaf45552013-08-28 00:53:59 +020011652{
Steve Dower8fc89802015-04-12 00:26:27 -040011653 int result;
Victor Stinnerdaf45552013-08-28 00:53:59 +020011654
Steve Dower8fc89802015-04-12 00:26:27 -040011655 _Py_BEGIN_SUPPRESS_IPH
11656 result = _Py_set_inheritable(fd, inheritable, NULL);
11657 _Py_END_SUPPRESS_IPH
11658 if (result < 0)
Victor Stinnerdaf45552013-08-28 00:53:59 +020011659 return NULL;
11660 Py_RETURN_NONE;
11661}
11662
11663
11664#ifdef MS_WINDOWS
Larry Hastings2f936352014-08-05 14:04:04 +100011665/*[clinic input]
11666os.get_handle_inheritable -> bool
Benjamin Petersonca470632016-09-06 13:47:26 -070011667 handle: intptr_t
Larry Hastings2f936352014-08-05 14:04:04 +100011668 /
Victor Stinnerdaf45552013-08-28 00:53:59 +020011669
Larry Hastings2f936352014-08-05 14:04:04 +100011670Get the close-on-exe flag of the specified file descriptor.
11671[clinic start generated code]*/
11672
Larry Hastings2f936352014-08-05 14:04:04 +100011673static int
Benjamin Petersonca470632016-09-06 13:47:26 -070011674os_get_handle_inheritable_impl(PyObject *module, intptr_t handle)
Victor Stinner581139c2016-09-06 15:54:20 -070011675/*[clinic end generated code: output=36be5afca6ea84d8 input=cfe99f9c05c70ad1]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011676{
11677 DWORD flags;
Victor Stinnerdaf45552013-08-28 00:53:59 +020011678
11679 if (!GetHandleInformation((HANDLE)handle, &flags)) {
11680 PyErr_SetFromWindowsErr(0);
Larry Hastings2f936352014-08-05 14:04:04 +100011681 return -1;
Victor Stinnerdaf45552013-08-28 00:53:59 +020011682 }
11683
Larry Hastings2f936352014-08-05 14:04:04 +100011684 return flags & HANDLE_FLAG_INHERIT;
Victor Stinnerdaf45552013-08-28 00:53:59 +020011685}
11686
Victor Stinnerdaf45552013-08-28 00:53:59 +020011687
Larry Hastings2f936352014-08-05 14:04:04 +100011688/*[clinic input]
11689os.set_handle_inheritable
Benjamin Petersonca470632016-09-06 13:47:26 -070011690 handle: intptr_t
Larry Hastings2f936352014-08-05 14:04:04 +100011691 inheritable: bool
11692 /
11693
11694Set the inheritable flag of the specified handle.
11695[clinic start generated code]*/
11696
Larry Hastings2f936352014-08-05 14:04:04 +100011697static PyObject *
Benjamin Petersonca470632016-09-06 13:47:26 -070011698os_set_handle_inheritable_impl(PyObject *module, intptr_t handle,
Larry Hastings89964c42015-04-14 18:07:59 -040011699 int inheritable)
Victor Stinner581139c2016-09-06 15:54:20 -070011700/*[clinic end generated code: output=021d74fe6c96baa3 input=7a7641390d8364fc]*/
Larry Hastings2f936352014-08-05 14:04:04 +100011701{
11702 DWORD flags = inheritable ? HANDLE_FLAG_INHERIT : 0;
Victor Stinnerdaf45552013-08-28 00:53:59 +020011703 if (!SetHandleInformation((HANDLE)handle, HANDLE_FLAG_INHERIT, flags)) {
11704 PyErr_SetFromWindowsErr(0);
11705 return NULL;
11706 }
11707 Py_RETURN_NONE;
11708}
Larry Hastings2f936352014-08-05 14:04:04 +100011709#endif /* MS_WINDOWS */
Antoine Pitroubcf2b592012-02-08 23:28:36 +010011710
Victor Stinner1db9e7b2014-07-29 22:32:47 +020011711#ifndef MS_WINDOWS
11712PyDoc_STRVAR(get_blocking__doc__,
11713 "get_blocking(fd) -> bool\n" \
11714 "\n" \
11715 "Get the blocking mode of the file descriptor:\n" \
11716 "False if the O_NONBLOCK flag is set, True if the flag is cleared.");
11717
11718static PyObject*
11719posix_get_blocking(PyObject *self, PyObject *args)
11720{
11721 int fd;
11722 int blocking;
11723
11724 if (!PyArg_ParseTuple(args, "i:get_blocking", &fd))
11725 return NULL;
11726
Steve Dower8fc89802015-04-12 00:26:27 -040011727 _Py_BEGIN_SUPPRESS_IPH
Victor Stinner1db9e7b2014-07-29 22:32:47 +020011728 blocking = _Py_get_blocking(fd);
Steve Dower8fc89802015-04-12 00:26:27 -040011729 _Py_END_SUPPRESS_IPH
Victor Stinner1db9e7b2014-07-29 22:32:47 +020011730 if (blocking < 0)
11731 return NULL;
11732 return PyBool_FromLong(blocking);
11733}
11734
11735PyDoc_STRVAR(set_blocking__doc__,
11736 "set_blocking(fd, blocking)\n" \
11737 "\n" \
11738 "Set the blocking mode of the specified file descriptor.\n" \
11739 "Set the O_NONBLOCK flag if blocking is False,\n" \
11740 "clear the O_NONBLOCK flag otherwise.");
11741
11742static PyObject*
11743posix_set_blocking(PyObject *self, PyObject *args)
11744{
Steve Dower8fc89802015-04-12 00:26:27 -040011745 int fd, blocking, result;
Victor Stinner1db9e7b2014-07-29 22:32:47 +020011746
11747 if (!PyArg_ParseTuple(args, "ii:set_blocking", &fd, &blocking))
11748 return NULL;
11749
Steve Dower8fc89802015-04-12 00:26:27 -040011750 _Py_BEGIN_SUPPRESS_IPH
11751 result = _Py_set_blocking(fd, blocking);
11752 _Py_END_SUPPRESS_IPH
11753 if (result < 0)
Victor Stinner1db9e7b2014-07-29 22:32:47 +020011754 return NULL;
11755 Py_RETURN_NONE;
11756}
11757#endif /* !MS_WINDOWS */
11758
11759
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020011760/*[clinic input]
11761class os.DirEntry "DirEntry *" "&DirEntryType"
11762[clinic start generated code]*/
11763/*[clinic end generated code: output=da39a3ee5e6b4b0d input=3138f09f7c683f1d]*/
Victor Stinner6036e442015-03-08 01:58:04 +010011764
11765typedef struct {
11766 PyObject_HEAD
11767 PyObject *name;
11768 PyObject *path;
11769 PyObject *stat;
11770 PyObject *lstat;
11771#ifdef MS_WINDOWS
11772 struct _Py_stat_struct win32_lstat;
Victor Stinner0f6d7332017-03-09 17:34:28 +010011773 uint64_t win32_file_index;
Victor Stinner6036e442015-03-08 01:58:04 +010011774 int got_file_index;
11775#else /* POSIX */
Victor Stinner35a97c02015-03-08 02:59:09 +010011776#ifdef HAVE_DIRENT_D_TYPE
Victor Stinner6036e442015-03-08 01:58:04 +010011777 unsigned char d_type;
Victor Stinner35a97c02015-03-08 02:59:09 +010011778#endif
Victor Stinner6036e442015-03-08 01:58:04 +010011779 ino_t d_ino;
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030011780 int dir_fd;
Victor Stinner6036e442015-03-08 01:58:04 +010011781#endif
11782} DirEntry;
11783
11784static void
11785DirEntry_dealloc(DirEntry *entry)
11786{
11787 Py_XDECREF(entry->name);
11788 Py_XDECREF(entry->path);
11789 Py_XDECREF(entry->stat);
11790 Py_XDECREF(entry->lstat);
11791 Py_TYPE(entry)->tp_free((PyObject *)entry);
11792}
11793
11794/* Forward reference */
11795static int
11796DirEntry_test_mode(DirEntry *self, int follow_symlinks, unsigned short mode_bits);
11797
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020011798/*[clinic input]
11799os.DirEntry.is_symlink -> bool
11800
11801Return True if the entry is a symbolic link; cached per entry.
11802[clinic start generated code]*/
11803
Victor Stinner6036e442015-03-08 01:58:04 +010011804static int
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020011805os_DirEntry_is_symlink_impl(DirEntry *self)
11806/*[clinic end generated code: output=42244667d7bcfc25 input=1605a1b4b96976c3]*/
Victor Stinner6036e442015-03-08 01:58:04 +010011807{
11808#ifdef MS_WINDOWS
11809 return (self->win32_lstat.st_mode & S_IFMT) == S_IFLNK;
Victor Stinner35a97c02015-03-08 02:59:09 +010011810#elif defined(HAVE_DIRENT_D_TYPE)
11811 /* POSIX */
Victor Stinner6036e442015-03-08 01:58:04 +010011812 if (self->d_type != DT_UNKNOWN)
11813 return self->d_type == DT_LNK;
11814 else
11815 return DirEntry_test_mode(self, 0, S_IFLNK);
Victor Stinner35a97c02015-03-08 02:59:09 +010011816#else
11817 /* POSIX without d_type */
11818 return DirEntry_test_mode(self, 0, S_IFLNK);
Victor Stinner6036e442015-03-08 01:58:04 +010011819#endif
11820}
11821
11822static PyObject *
Victor Stinner6036e442015-03-08 01:58:04 +010011823DirEntry_fetch_stat(DirEntry *self, int follow_symlinks)
11824{
11825 int result;
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030011826 STRUCT_STAT st;
11827 PyObject *ub;
Victor Stinner6036e442015-03-08 01:58:04 +010011828
11829#ifdef MS_WINDOWS
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030011830 if (!PyUnicode_FSDecoder(self->path, &ub))
11831 return NULL;
11832 const wchar_t *path = PyUnicode_AsUnicode(ub);
Victor Stinner6036e442015-03-08 01:58:04 +010011833#else /* POSIX */
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030011834 if (!PyUnicode_FSConverter(self->path, &ub))
11835 return NULL;
11836 const char *path = PyBytes_AS_STRING(ub);
11837 if (self->dir_fd != DEFAULT_DIR_FD) {
11838#ifdef HAVE_FSTATAT
11839 result = fstatat(self->dir_fd, path, &st,
11840 follow_symlinks ? 0 : AT_SYMLINK_NOFOLLOW);
11841#else
11842 PyErr_SetString(PyExc_NotImplementedError, "can't fetch stat");
11843 return NULL;
11844#endif /* HAVE_FSTATAT */
11845 }
11846 else
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030011847#endif
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030011848 {
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030011849 if (follow_symlinks)
11850 result = STAT(path, &st);
11851 else
11852 result = LSTAT(path, &st);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030011853 }
11854 Py_DECREF(ub);
Victor Stinner6036e442015-03-08 01:58:04 +010011855
11856 if (result != 0)
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030011857 return path_object_error(self->path);
Victor Stinner6036e442015-03-08 01:58:04 +010011858
11859 return _pystat_fromstructstat(&st);
11860}
11861
11862static PyObject *
11863DirEntry_get_lstat(DirEntry *self)
11864{
11865 if (!self->lstat) {
11866#ifdef MS_WINDOWS
11867 self->lstat = _pystat_fromstructstat(&self->win32_lstat);
11868#else /* POSIX */
11869 self->lstat = DirEntry_fetch_stat(self, 0);
11870#endif
11871 }
11872 Py_XINCREF(self->lstat);
11873 return self->lstat;
11874}
11875
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020011876/*[clinic input]
11877os.DirEntry.stat
11878 *
11879 follow_symlinks: bool = True
11880
11881Return stat_result object for the entry; cached per entry.
11882[clinic start generated code]*/
11883
Victor Stinner6036e442015-03-08 01:58:04 +010011884static PyObject *
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020011885os_DirEntry_stat_impl(DirEntry *self, int follow_symlinks)
11886/*[clinic end generated code: output=008593b3a6d01305 input=280d14c1d6f1d00d]*/
Victor Stinner6036e442015-03-08 01:58:04 +010011887{
11888 if (!follow_symlinks)
11889 return DirEntry_get_lstat(self);
11890
11891 if (!self->stat) {
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020011892 int result = os_DirEntry_is_symlink_impl(self);
Victor Stinner6036e442015-03-08 01:58:04 +010011893 if (result == -1)
11894 return NULL;
11895 else if (result)
11896 self->stat = DirEntry_fetch_stat(self, 1);
11897 else
11898 self->stat = DirEntry_get_lstat(self);
11899 }
11900
11901 Py_XINCREF(self->stat);
11902 return self->stat;
11903}
11904
Victor Stinner6036e442015-03-08 01:58:04 +010011905/* Set exception and return -1 on error, 0 for False, 1 for True */
11906static int
11907DirEntry_test_mode(DirEntry *self, int follow_symlinks, unsigned short mode_bits)
11908{
11909 PyObject *stat = NULL;
11910 PyObject *st_mode = NULL;
11911 long mode;
11912 int result;
Victor Stinner35a97c02015-03-08 02:59:09 +010011913#if defined(MS_WINDOWS) || defined(HAVE_DIRENT_D_TYPE)
Victor Stinner6036e442015-03-08 01:58:04 +010011914 int is_symlink;
11915 int need_stat;
Victor Stinner35a97c02015-03-08 02:59:09 +010011916#endif
Victor Stinner6036e442015-03-08 01:58:04 +010011917#ifdef MS_WINDOWS
11918 unsigned long dir_bits;
11919#endif
Victor Stinner35a97c02015-03-08 02:59:09 +010011920 _Py_IDENTIFIER(st_mode);
Victor Stinner6036e442015-03-08 01:58:04 +010011921
11922#ifdef MS_WINDOWS
11923 is_symlink = (self->win32_lstat.st_mode & S_IFMT) == S_IFLNK;
11924 need_stat = follow_symlinks && is_symlink;
Victor Stinner35a97c02015-03-08 02:59:09 +010011925#elif defined(HAVE_DIRENT_D_TYPE)
Victor Stinner6036e442015-03-08 01:58:04 +010011926 is_symlink = self->d_type == DT_LNK;
11927 need_stat = self->d_type == DT_UNKNOWN || (follow_symlinks && is_symlink);
11928#endif
11929
Victor Stinner35a97c02015-03-08 02:59:09 +010011930#if defined(MS_WINDOWS) || defined(HAVE_DIRENT_D_TYPE)
Victor Stinner6036e442015-03-08 01:58:04 +010011931 if (need_stat) {
Victor Stinner35a97c02015-03-08 02:59:09 +010011932#endif
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020011933 stat = os_DirEntry_stat_impl(self, follow_symlinks);
Victor Stinner6036e442015-03-08 01:58:04 +010011934 if (!stat) {
11935 if (PyErr_ExceptionMatches(PyExc_FileNotFoundError)) {
11936 /* If file doesn't exist (anymore), then return False
11937 (i.e., say it's not a file/directory) */
11938 PyErr_Clear();
11939 return 0;
11940 }
11941 goto error;
11942 }
11943 st_mode = _PyObject_GetAttrId(stat, &PyId_st_mode);
11944 if (!st_mode)
11945 goto error;
11946
11947 mode = PyLong_AsLong(st_mode);
11948 if (mode == -1 && PyErr_Occurred())
11949 goto error;
11950 Py_CLEAR(st_mode);
11951 Py_CLEAR(stat);
11952 result = (mode & S_IFMT) == mode_bits;
Victor Stinner35a97c02015-03-08 02:59:09 +010011953#if defined(MS_WINDOWS) || defined(HAVE_DIRENT_D_TYPE)
Victor Stinner6036e442015-03-08 01:58:04 +010011954 }
11955 else if (is_symlink) {
11956 assert(mode_bits != S_IFLNK);
11957 result = 0;
11958 }
11959 else {
11960 assert(mode_bits == S_IFDIR || mode_bits == S_IFREG);
11961#ifdef MS_WINDOWS
11962 dir_bits = self->win32_lstat.st_file_attributes & FILE_ATTRIBUTE_DIRECTORY;
11963 if (mode_bits == S_IFDIR)
11964 result = dir_bits != 0;
11965 else
11966 result = dir_bits == 0;
11967#else /* POSIX */
11968 if (mode_bits == S_IFDIR)
11969 result = self->d_type == DT_DIR;
11970 else
11971 result = self->d_type == DT_REG;
11972#endif
11973 }
Victor Stinner35a97c02015-03-08 02:59:09 +010011974#endif
Victor Stinner6036e442015-03-08 01:58:04 +010011975
11976 return result;
11977
11978error:
11979 Py_XDECREF(st_mode);
11980 Py_XDECREF(stat);
11981 return -1;
11982}
11983
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020011984/*[clinic input]
11985os.DirEntry.is_dir -> bool
11986 *
11987 follow_symlinks: bool = True
Victor Stinner6036e442015-03-08 01:58:04 +010011988
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020011989Return True if the entry is a directory; cached per entry.
11990[clinic start generated code]*/
11991
11992static int
11993os_DirEntry_is_dir_impl(DirEntry *self, int follow_symlinks)
11994/*[clinic end generated code: output=ad2e8d54365da287 input=0135232766f53f58]*/
11995{
11996 return DirEntry_test_mode(self, follow_symlinks, S_IFDIR);
Victor Stinner6036e442015-03-08 01:58:04 +010011997}
11998
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020011999/*[clinic input]
12000os.DirEntry.is_file -> bool
12001 *
12002 follow_symlinks: bool = True
12003
12004Return True if the entry is a file; cached per entry.
12005[clinic start generated code]*/
12006
12007static int
12008os_DirEntry_is_file_impl(DirEntry *self, int follow_symlinks)
12009/*[clinic end generated code: output=8462ade481d8a476 input=0dc90be168b041ee]*/
Victor Stinner6036e442015-03-08 01:58:04 +010012010{
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012011 return DirEntry_test_mode(self, follow_symlinks, S_IFREG);
Victor Stinner6036e442015-03-08 01:58:04 +010012012}
12013
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012014/*[clinic input]
12015os.DirEntry.inode
Victor Stinner6036e442015-03-08 01:58:04 +010012016
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012017Return inode of the entry; cached per entry.
12018[clinic start generated code]*/
Victor Stinner6036e442015-03-08 01:58:04 +010012019
12020static PyObject *
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012021os_DirEntry_inode_impl(DirEntry *self)
12022/*[clinic end generated code: output=156bb3a72162440e input=3ee7b872ae8649f0]*/
Victor Stinner6036e442015-03-08 01:58:04 +010012023{
12024#ifdef MS_WINDOWS
12025 if (!self->got_file_index) {
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012026 PyObject *unicode;
Serhiy Storchakadeab18d2016-05-07 16:45:18 +030012027 const wchar_t *path;
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012028 STRUCT_STAT stat;
12029 int result;
Victor Stinner6036e442015-03-08 01:58:04 +010012030
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012031 if (!PyUnicode_FSDecoder(self->path, &unicode))
Victor Stinner6036e442015-03-08 01:58:04 +010012032 return NULL;
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012033 path = PyUnicode_AsUnicode(unicode);
12034 result = LSTAT(path, &stat);
12035 Py_DECREF(unicode);
Victor Stinner6036e442015-03-08 01:58:04 +010012036
Serhiy Storchaka2674bc72016-10-08 20:16:57 +030012037 if (result != 0)
12038 return path_object_error(self->path);
Victor Stinner6036e442015-03-08 01:58:04 +010012039
12040 self->win32_file_index = stat.st_ino;
12041 self->got_file_index = 1;
12042 }
Victor Stinner0f6d7332017-03-09 17:34:28 +010012043 Py_BUILD_ASSERT(sizeof(unsigned long long) >= sizeof(self->win32_file_index));
12044 return PyLong_FromUnsignedLongLong(self->win32_file_index);
Victor Stinner6036e442015-03-08 01:58:04 +010012045#else /* POSIX */
xdegaye50e86032017-05-22 11:15:08 +020012046 Py_BUILD_ASSERT(sizeof(unsigned long long) >= sizeof(self->d_ino));
12047 return PyLong_FromUnsignedLongLong(self->d_ino);
Victor Stinner6036e442015-03-08 01:58:04 +010012048#endif
12049}
12050
12051static PyObject *
12052DirEntry_repr(DirEntry *self)
12053{
12054 return PyUnicode_FromFormat("<DirEntry %R>", self->name);
12055}
12056
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012057/*[clinic input]
12058os.DirEntry.__fspath__
12059
12060Returns the path for the entry.
12061[clinic start generated code]*/
12062
Brett Cannon96881cd2016-06-10 14:37:21 -070012063static PyObject *
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012064os_DirEntry___fspath___impl(DirEntry *self)
12065/*[clinic end generated code: output=6dd7f7ef752e6f4f input=3c49d0cf38df4fac]*/
Brett Cannon96881cd2016-06-10 14:37:21 -070012066{
12067 Py_INCREF(self->path);
12068 return self->path;
12069}
12070
Victor Stinner6036e442015-03-08 01:58:04 +010012071static PyMemberDef DirEntry_members[] = {
12072 {"name", T_OBJECT_EX, offsetof(DirEntry, name), READONLY,
12073 "the entry's base filename, relative to scandir() \"path\" argument"},
12074 {"path", T_OBJECT_EX, offsetof(DirEntry, path), READONLY,
12075 "the entry's full path name; equivalent to os.path.join(scandir_path, entry.name)"},
12076 {NULL}
12077};
12078
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012079#include "clinic/posixmodule.c.h"
12080
Victor Stinner6036e442015-03-08 01:58:04 +010012081static PyMethodDef DirEntry_methods[] = {
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012082 OS_DIRENTRY_IS_DIR_METHODDEF
12083 OS_DIRENTRY_IS_FILE_METHODDEF
12084 OS_DIRENTRY_IS_SYMLINK_METHODDEF
12085 OS_DIRENTRY_STAT_METHODDEF
12086 OS_DIRENTRY_INODE_METHODDEF
12087 OS_DIRENTRY___FSPATH___METHODDEF
Victor Stinner6036e442015-03-08 01:58:04 +010012088 {NULL}
12089};
12090
Benjamin Peterson5646de42015-04-12 17:56:34 -040012091static PyTypeObject DirEntryType = {
Victor Stinner6036e442015-03-08 01:58:04 +010012092 PyVarObject_HEAD_INIT(NULL, 0)
12093 MODNAME ".DirEntry", /* tp_name */
12094 sizeof(DirEntry), /* tp_basicsize */
12095 0, /* tp_itemsize */
12096 /* methods */
12097 (destructor)DirEntry_dealloc, /* tp_dealloc */
12098 0, /* tp_print */
12099 0, /* tp_getattr */
12100 0, /* tp_setattr */
12101 0, /* tp_compare */
12102 (reprfunc)DirEntry_repr, /* tp_repr */
12103 0, /* tp_as_number */
12104 0, /* tp_as_sequence */
12105 0, /* tp_as_mapping */
12106 0, /* tp_hash */
12107 0, /* tp_call */
12108 0, /* tp_str */
12109 0, /* tp_getattro */
12110 0, /* tp_setattro */
12111 0, /* tp_as_buffer */
12112 Py_TPFLAGS_DEFAULT, /* tp_flags */
12113 0, /* tp_doc */
12114 0, /* tp_traverse */
12115 0, /* tp_clear */
12116 0, /* tp_richcompare */
12117 0, /* tp_weaklistoffset */
12118 0, /* tp_iter */
12119 0, /* tp_iternext */
12120 DirEntry_methods, /* tp_methods */
12121 DirEntry_members, /* tp_members */
12122};
12123
12124#ifdef MS_WINDOWS
12125
12126static wchar_t *
Serhiy Storchakadeab18d2016-05-07 16:45:18 +030012127join_path_filenameW(const wchar_t *path_wide, const wchar_t *filename)
Victor Stinner6036e442015-03-08 01:58:04 +010012128{
12129 Py_ssize_t path_len;
12130 Py_ssize_t size;
12131 wchar_t *result;
12132 wchar_t ch;
12133
12134 if (!path_wide) { /* Default arg: "." */
12135 path_wide = L".";
12136 path_len = 1;
12137 }
12138 else {
12139 path_len = wcslen(path_wide);
12140 }
12141
12142 /* The +1's are for the path separator and the NUL */
12143 size = path_len + 1 + wcslen(filename) + 1;
12144 result = PyMem_New(wchar_t, size);
12145 if (!result) {
12146 PyErr_NoMemory();
12147 return NULL;
12148 }
12149 wcscpy(result, path_wide);
12150 if (path_len > 0) {
12151 ch = result[path_len - 1];
12152 if (ch != SEP && ch != ALTSEP && ch != L':')
12153 result[path_len++] = SEP;
12154 wcscpy(result + path_len, filename);
12155 }
12156 return result;
12157}
12158
12159static PyObject *
12160DirEntry_from_find_data(path_t *path, WIN32_FIND_DATAW *dataW)
12161{
12162 DirEntry *entry;
12163 BY_HANDLE_FILE_INFORMATION file_info;
12164 ULONG reparse_tag;
12165 wchar_t *joined_path;
12166
12167 entry = PyObject_New(DirEntry, &DirEntryType);
12168 if (!entry)
12169 return NULL;
12170 entry->name = NULL;
12171 entry->path = NULL;
12172 entry->stat = NULL;
12173 entry->lstat = NULL;
12174 entry->got_file_index = 0;
12175
12176 entry->name = PyUnicode_FromWideChar(dataW->cFileName, -1);
12177 if (!entry->name)
12178 goto error;
Steve Dowercc16be82016-09-08 10:35:16 -070012179 if (path->narrow) {
12180 Py_SETREF(entry->name, PyUnicode_EncodeFSDefault(entry->name));
12181 if (!entry->name)
12182 goto error;
12183 }
Victor Stinner6036e442015-03-08 01:58:04 +010012184
12185 joined_path = join_path_filenameW(path->wide, dataW->cFileName);
12186 if (!joined_path)
12187 goto error;
12188
12189 entry->path = PyUnicode_FromWideChar(joined_path, -1);
12190 PyMem_Free(joined_path);
12191 if (!entry->path)
12192 goto error;
Steve Dowercc16be82016-09-08 10:35:16 -070012193 if (path->narrow) {
12194 Py_SETREF(entry->path, PyUnicode_EncodeFSDefault(entry->path));
12195 if (!entry->path)
12196 goto error;
12197 }
Victor Stinner6036e442015-03-08 01:58:04 +010012198
Steve Dowercc16be82016-09-08 10:35:16 -070012199 find_data_to_file_info(dataW, &file_info, &reparse_tag);
Victor Stinner6036e442015-03-08 01:58:04 +010012200 _Py_attribute_data_to_stat(&file_info, reparse_tag, &entry->win32_lstat);
12201
12202 return (PyObject *)entry;
12203
12204error:
12205 Py_DECREF(entry);
12206 return NULL;
12207}
12208
12209#else /* POSIX */
12210
12211static char *
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020012212join_path_filename(const char *path_narrow, const char* filename, Py_ssize_t filename_len)
Victor Stinner6036e442015-03-08 01:58:04 +010012213{
12214 Py_ssize_t path_len;
12215 Py_ssize_t size;
12216 char *result;
12217
12218 if (!path_narrow) { /* Default arg: "." */
12219 path_narrow = ".";
12220 path_len = 1;
12221 }
12222 else {
12223 path_len = strlen(path_narrow);
12224 }
12225
12226 if (filename_len == -1)
12227 filename_len = strlen(filename);
12228
12229 /* The +1's are for the path separator and the NUL */
12230 size = path_len + 1 + filename_len + 1;
12231 result = PyMem_New(char, size);
12232 if (!result) {
12233 PyErr_NoMemory();
12234 return NULL;
12235 }
12236 strcpy(result, path_narrow);
12237 if (path_len > 0 && result[path_len - 1] != '/')
12238 result[path_len++] = '/';
12239 strcpy(result + path_len, filename);
12240 return result;
12241}
12242
12243static PyObject *
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020012244DirEntry_from_posix_info(path_t *path, const char *name, Py_ssize_t name_len,
Victor Stinner35a97c02015-03-08 02:59:09 +010012245 ino_t d_ino
12246#ifdef HAVE_DIRENT_D_TYPE
12247 , unsigned char d_type
12248#endif
12249 )
Victor Stinner6036e442015-03-08 01:58:04 +010012250{
12251 DirEntry *entry;
12252 char *joined_path;
12253
12254 entry = PyObject_New(DirEntry, &DirEntryType);
12255 if (!entry)
12256 return NULL;
12257 entry->name = NULL;
12258 entry->path = NULL;
12259 entry->stat = NULL;
12260 entry->lstat = NULL;
12261
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012262 if (path->fd != -1) {
12263 entry->dir_fd = path->fd;
12264 joined_path = NULL;
12265 }
12266 else {
12267 entry->dir_fd = DEFAULT_DIR_FD;
12268 joined_path = join_path_filename(path->narrow, name, name_len);
12269 if (!joined_path)
12270 goto error;
12271 }
Victor Stinner6036e442015-03-08 01:58:04 +010012272
Serhiy Storchaka1180e5a2017-07-11 06:36:46 +030012273 if (!path->narrow || !PyObject_CheckBuffer(path->object)) {
Victor Stinner6036e442015-03-08 01:58:04 +010012274 entry->name = PyUnicode_DecodeFSDefaultAndSize(name, name_len);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012275 if (joined_path)
12276 entry->path = PyUnicode_DecodeFSDefault(joined_path);
Victor Stinner6036e442015-03-08 01:58:04 +010012277 }
12278 else {
12279 entry->name = PyBytes_FromStringAndSize(name, name_len);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012280 if (joined_path)
12281 entry->path = PyBytes_FromString(joined_path);
Victor Stinner6036e442015-03-08 01:58:04 +010012282 }
12283 PyMem_Free(joined_path);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012284 if (!entry->name)
12285 goto error;
12286
12287 if (path->fd != -1) {
12288 entry->path = entry->name;
12289 Py_INCREF(entry->path);
12290 }
12291 else if (!entry->path)
Victor Stinner6036e442015-03-08 01:58:04 +010012292 goto error;
12293
Victor Stinner35a97c02015-03-08 02:59:09 +010012294#ifdef HAVE_DIRENT_D_TYPE
Victor Stinner6036e442015-03-08 01:58:04 +010012295 entry->d_type = d_type;
Victor Stinner35a97c02015-03-08 02:59:09 +010012296#endif
Victor Stinner6036e442015-03-08 01:58:04 +010012297 entry->d_ino = d_ino;
12298
12299 return (PyObject *)entry;
12300
12301error:
12302 Py_XDECREF(entry);
12303 return NULL;
12304}
12305
12306#endif
12307
12308
12309typedef struct {
12310 PyObject_HEAD
12311 path_t path;
12312#ifdef MS_WINDOWS
12313 HANDLE handle;
12314 WIN32_FIND_DATAW file_data;
12315 int first_time;
12316#else /* POSIX */
12317 DIR *dirp;
12318#endif
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012319#ifdef HAVE_FDOPENDIR
12320 int fd;
12321#endif
Victor Stinner6036e442015-03-08 01:58:04 +010012322} ScandirIterator;
12323
12324#ifdef MS_WINDOWS
12325
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020012326static int
12327ScandirIterator_is_closed(ScandirIterator *iterator)
12328{
12329 return iterator->handle == INVALID_HANDLE_VALUE;
12330}
12331
Victor Stinner6036e442015-03-08 01:58:04 +010012332static void
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020012333ScandirIterator_closedir(ScandirIterator *iterator)
Victor Stinner6036e442015-03-08 01:58:04 +010012334{
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030012335 HANDLE handle = iterator->handle;
12336
12337 if (handle == INVALID_HANDLE_VALUE)
Victor Stinner6036e442015-03-08 01:58:04 +010012338 return;
12339
Victor Stinner6036e442015-03-08 01:58:04 +010012340 iterator->handle = INVALID_HANDLE_VALUE;
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030012341 Py_BEGIN_ALLOW_THREADS
12342 FindClose(handle);
12343 Py_END_ALLOW_THREADS
Victor Stinner6036e442015-03-08 01:58:04 +010012344}
12345
12346static PyObject *
12347ScandirIterator_iternext(ScandirIterator *iterator)
12348{
12349 WIN32_FIND_DATAW *file_data = &iterator->file_data;
12350 BOOL success;
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020012351 PyObject *entry;
Victor Stinner6036e442015-03-08 01:58:04 +010012352
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020012353 /* Happens if the iterator is iterated twice, or closed explicitly */
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020012354 if (iterator->handle == INVALID_HANDLE_VALUE)
Victor Stinner6036e442015-03-08 01:58:04 +010012355 return NULL;
Victor Stinner6036e442015-03-08 01:58:04 +010012356
12357 while (1) {
12358 if (!iterator->first_time) {
12359 Py_BEGIN_ALLOW_THREADS
12360 success = FindNextFileW(iterator->handle, file_data);
12361 Py_END_ALLOW_THREADS
12362 if (!success) {
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020012363 /* Error or no more files */
Victor Stinner6036e442015-03-08 01:58:04 +010012364 if (GetLastError() != ERROR_NO_MORE_FILES)
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020012365 path_error(&iterator->path);
Victor Stinner6036e442015-03-08 01:58:04 +010012366 break;
12367 }
12368 }
12369 iterator->first_time = 0;
12370
12371 /* Skip over . and .. */
12372 if (wcscmp(file_data->cFileName, L".") != 0 &&
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020012373 wcscmp(file_data->cFileName, L"..") != 0) {
12374 entry = DirEntry_from_find_data(&iterator->path, file_data);
12375 if (!entry)
12376 break;
12377 return entry;
12378 }
Victor Stinner6036e442015-03-08 01:58:04 +010012379
12380 /* Loop till we get a non-dot directory or finish iterating */
12381 }
12382
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020012383 /* Error or no more files */
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020012384 ScandirIterator_closedir(iterator);
Victor Stinner6036e442015-03-08 01:58:04 +010012385 return NULL;
12386}
12387
12388#else /* POSIX */
12389
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020012390static int
12391ScandirIterator_is_closed(ScandirIterator *iterator)
12392{
12393 return !iterator->dirp;
12394}
12395
Victor Stinner6036e442015-03-08 01:58:04 +010012396static void
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020012397ScandirIterator_closedir(ScandirIterator *iterator)
Victor Stinner6036e442015-03-08 01:58:04 +010012398{
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030012399 DIR *dirp = iterator->dirp;
12400
12401 if (!dirp)
Victor Stinner6036e442015-03-08 01:58:04 +010012402 return;
12403
Victor Stinner6036e442015-03-08 01:58:04 +010012404 iterator->dirp = NULL;
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030012405 Py_BEGIN_ALLOW_THREADS
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012406#ifdef HAVE_FDOPENDIR
12407 if (iterator->path.fd != -1)
12408 rewinddir(dirp);
12409#endif
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +030012410 closedir(dirp);
12411 Py_END_ALLOW_THREADS
Victor Stinner6036e442015-03-08 01:58:04 +010012412 return;
12413}
12414
12415static PyObject *
12416ScandirIterator_iternext(ScandirIterator *iterator)
12417{
12418 struct dirent *direntp;
12419 Py_ssize_t name_len;
12420 int is_dot;
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020012421 PyObject *entry;
Victor Stinner6036e442015-03-08 01:58:04 +010012422
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020012423 /* Happens if the iterator is iterated twice, or closed explicitly */
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020012424 if (!iterator->dirp)
Victor Stinner6036e442015-03-08 01:58:04 +010012425 return NULL;
Victor Stinner6036e442015-03-08 01:58:04 +010012426
12427 while (1) {
12428 errno = 0;
12429 Py_BEGIN_ALLOW_THREADS
12430 direntp = readdir(iterator->dirp);
12431 Py_END_ALLOW_THREADS
12432
12433 if (!direntp) {
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020012434 /* Error or no more files */
Victor Stinner6036e442015-03-08 01:58:04 +010012435 if (errno != 0)
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020012436 path_error(&iterator->path);
Victor Stinner6036e442015-03-08 01:58:04 +010012437 break;
12438 }
12439
12440 /* Skip over . and .. */
12441 name_len = NAMLEN(direntp);
12442 is_dot = direntp->d_name[0] == '.' &&
12443 (name_len == 1 || (direntp->d_name[1] == '.' && name_len == 2));
12444 if (!is_dot) {
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020012445 entry = DirEntry_from_posix_info(&iterator->path, direntp->d_name,
Victor Stinner35a97c02015-03-08 02:59:09 +010012446 name_len, direntp->d_ino
12447#ifdef HAVE_DIRENT_D_TYPE
12448 , direntp->d_type
12449#endif
12450 );
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020012451 if (!entry)
12452 break;
12453 return entry;
Victor Stinner6036e442015-03-08 01:58:04 +010012454 }
12455
12456 /* Loop till we get a non-dot directory or finish iterating */
12457 }
12458
Serhiy Storchaka988b9bc2016-02-08 17:56:36 +020012459 /* Error or no more files */
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020012460 ScandirIterator_closedir(iterator);
Victor Stinner6036e442015-03-08 01:58:04 +010012461 return NULL;
12462}
12463
12464#endif
12465
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020012466static PyObject *
12467ScandirIterator_close(ScandirIterator *self, PyObject *args)
12468{
12469 ScandirIterator_closedir(self);
12470 Py_RETURN_NONE;
12471}
12472
12473static PyObject *
12474ScandirIterator_enter(PyObject *self, PyObject *args)
12475{
12476 Py_INCREF(self);
12477 return self;
12478}
12479
12480static PyObject *
12481ScandirIterator_exit(ScandirIterator *self, PyObject *args)
12482{
12483 ScandirIterator_closedir(self);
12484 Py_RETURN_NONE;
12485}
12486
Victor Stinner6036e442015-03-08 01:58:04 +010012487static void
Victor Stinner7bfa4092016-03-23 00:43:54 +010012488ScandirIterator_finalize(ScandirIterator *iterator)
12489{
12490 PyObject *error_type, *error_value, *error_traceback;
12491
12492 /* Save the current exception, if any. */
12493 PyErr_Fetch(&error_type, &error_value, &error_traceback);
12494
12495 if (!ScandirIterator_is_closed(iterator)) {
12496 ScandirIterator_closedir(iterator);
12497
12498 if (PyErr_ResourceWarning((PyObject *)iterator, 1,
12499 "unclosed scandir iterator %R", iterator)) {
12500 /* Spurious errors can appear at shutdown */
12501 if (PyErr_ExceptionMatches(PyExc_Warning)) {
12502 PyErr_WriteUnraisable((PyObject *) iterator);
12503 }
12504 }
12505 }
12506
Victor Stinner7bfa4092016-03-23 00:43:54 +010012507 path_cleanup(&iterator->path);
12508
12509 /* Restore the saved exception. */
12510 PyErr_Restore(error_type, error_value, error_traceback);
12511}
12512
12513static void
Victor Stinner6036e442015-03-08 01:58:04 +010012514ScandirIterator_dealloc(ScandirIterator *iterator)
12515{
Victor Stinner7bfa4092016-03-23 00:43:54 +010012516 if (PyObject_CallFinalizerFromDealloc((PyObject *)iterator) < 0)
12517 return;
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020012518
Victor Stinner6036e442015-03-08 01:58:04 +010012519 Py_TYPE(iterator)->tp_free((PyObject *)iterator);
12520}
12521
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020012522static PyMethodDef ScandirIterator_methods[] = {
12523 {"__enter__", (PyCFunction)ScandirIterator_enter, METH_NOARGS},
12524 {"__exit__", (PyCFunction)ScandirIterator_exit, METH_VARARGS},
12525 {"close", (PyCFunction)ScandirIterator_close, METH_NOARGS},
12526 {NULL}
12527};
12528
Benjamin Peterson5646de42015-04-12 17:56:34 -040012529static PyTypeObject ScandirIteratorType = {
Victor Stinner6036e442015-03-08 01:58:04 +010012530 PyVarObject_HEAD_INIT(NULL, 0)
12531 MODNAME ".ScandirIterator", /* tp_name */
12532 sizeof(ScandirIterator), /* tp_basicsize */
12533 0, /* tp_itemsize */
12534 /* methods */
12535 (destructor)ScandirIterator_dealloc, /* tp_dealloc */
12536 0, /* tp_print */
12537 0, /* tp_getattr */
12538 0, /* tp_setattr */
12539 0, /* tp_compare */
12540 0, /* tp_repr */
12541 0, /* tp_as_number */
12542 0, /* tp_as_sequence */
12543 0, /* tp_as_mapping */
12544 0, /* tp_hash */
12545 0, /* tp_call */
12546 0, /* tp_str */
12547 0, /* tp_getattro */
12548 0, /* tp_setattro */
12549 0, /* tp_as_buffer */
Victor Stinner7bfa4092016-03-23 00:43:54 +010012550 Py_TPFLAGS_DEFAULT
12551 | Py_TPFLAGS_HAVE_FINALIZE, /* tp_flags */
Victor Stinner6036e442015-03-08 01:58:04 +010012552 0, /* tp_doc */
12553 0, /* tp_traverse */
12554 0, /* tp_clear */
12555 0, /* tp_richcompare */
12556 0, /* tp_weaklistoffset */
12557 PyObject_SelfIter, /* tp_iter */
12558 (iternextfunc)ScandirIterator_iternext, /* tp_iternext */
Serhiy Storchakaffe96ae2016-02-11 13:21:30 +020012559 ScandirIterator_methods, /* tp_methods */
Victor Stinner7bfa4092016-03-23 00:43:54 +010012560 0, /* tp_members */
12561 0, /* tp_getset */
12562 0, /* tp_base */
12563 0, /* tp_dict */
12564 0, /* tp_descr_get */
12565 0, /* tp_descr_set */
12566 0, /* tp_dictoffset */
12567 0, /* tp_init */
12568 0, /* tp_alloc */
12569 0, /* tp_new */
12570 0, /* tp_free */
12571 0, /* tp_is_gc */
12572 0, /* tp_bases */
12573 0, /* tp_mro */
12574 0, /* tp_cache */
12575 0, /* tp_subclasses */
12576 0, /* tp_weaklist */
12577 0, /* tp_del */
12578 0, /* tp_version_tag */
12579 (destructor)ScandirIterator_finalize, /* tp_finalize */
Victor Stinner6036e442015-03-08 01:58:04 +010012580};
12581
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012582/*[clinic input]
12583os.scandir
12584
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012585 path : path_t(nullable=True, allow_fd='PATH_HAVE_FDOPENDIR') = None
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012586
12587Return an iterator of DirEntry objects for given path.
12588
12589path can be specified as either str, bytes or path-like object. If path
12590is bytes, the names of yielded DirEntry objects will also be bytes; in
12591all other circumstances they will be str.
12592
12593If path is None, uses the path='.'.
12594[clinic start generated code]*/
12595
Victor Stinner6036e442015-03-08 01:58:04 +010012596static PyObject *
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012597os_scandir_impl(PyObject *module, path_t *path)
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012598/*[clinic end generated code: output=6eb2668b675ca89e input=b139dc1c57f60846]*/
Victor Stinner6036e442015-03-08 01:58:04 +010012599{
12600 ScandirIterator *iterator;
Victor Stinner6036e442015-03-08 01:58:04 +010012601#ifdef MS_WINDOWS
12602 wchar_t *path_strW;
12603#else
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012604 const char *path_str;
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012605#ifdef HAVE_FDOPENDIR
12606 int fd = -1;
12607#endif
Victor Stinner6036e442015-03-08 01:58:04 +010012608#endif
12609
12610 iterator = PyObject_New(ScandirIterator, &ScandirIteratorType);
12611 if (!iterator)
12612 return NULL;
Victor Stinner6036e442015-03-08 01:58:04 +010012613
12614#ifdef MS_WINDOWS
12615 iterator->handle = INVALID_HANDLE_VALUE;
12616#else
12617 iterator->dirp = NULL;
12618#endif
12619
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020012620 memcpy(&iterator->path, path, sizeof(path_t));
Serhiy Storchaka095ef732017-02-09 20:05:51 +020012621 /* Move the ownership to iterator->path */
12622 path->object = NULL;
12623 path->cleanup = NULL;
Victor Stinner6036e442015-03-08 01:58:04 +010012624
12625#ifdef MS_WINDOWS
Victor Stinner6036e442015-03-08 01:58:04 +010012626 iterator->first_time = 1;
12627
12628 path_strW = join_path_filenameW(iterator->path.wide, L"*.*");
12629 if (!path_strW)
12630 goto error;
12631
12632 Py_BEGIN_ALLOW_THREADS
12633 iterator->handle = FindFirstFileW(path_strW, &iterator->file_data);
12634 Py_END_ALLOW_THREADS
12635
12636 PyMem_Free(path_strW);
12637
12638 if (iterator->handle == INVALID_HANDLE_VALUE) {
12639 path_error(&iterator->path);
12640 goto error;
12641 }
12642#else /* POSIX */
Victor Stinner6036e442015-03-08 01:58:04 +010012643 errno = 0;
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012644#ifdef HAVE_FDOPENDIR
12645 if (path->fd != -1) {
12646 /* closedir() closes the FD, so we duplicate it */
12647 fd = _Py_dup(path->fd);
12648 if (fd == -1)
12649 goto error;
12650
12651 Py_BEGIN_ALLOW_THREADS
12652 iterator->dirp = fdopendir(fd);
12653 Py_END_ALLOW_THREADS
12654 }
12655 else
12656#endif
12657 {
12658 if (iterator->path.narrow)
12659 path_str = iterator->path.narrow;
12660 else
12661 path_str = ".";
12662
12663 Py_BEGIN_ALLOW_THREADS
12664 iterator->dirp = opendir(path_str);
12665 Py_END_ALLOW_THREADS
12666 }
Victor Stinner6036e442015-03-08 01:58:04 +010012667
12668 if (!iterator->dirp) {
12669 path_error(&iterator->path);
Serhiy Storchakaea720fe2017-03-30 09:12:31 +030012670#ifdef HAVE_FDOPENDIR
12671 if (fd != -1) {
12672 Py_BEGIN_ALLOW_THREADS
12673 close(fd);
12674 Py_END_ALLOW_THREADS
12675 }
12676#endif
Victor Stinner6036e442015-03-08 01:58:04 +010012677 goto error;
12678 }
12679#endif
12680
12681 return (PyObject *)iterator;
12682
12683error:
12684 Py_DECREF(iterator);
12685 return NULL;
12686}
12687
Ethan Furman410ef8e2016-06-04 12:06:26 -070012688/*
12689 Return the file system path representation of the object.
12690
12691 If the object is str or bytes, then allow it to pass through with
12692 an incremented refcount. If the object defines __fspath__(), then
12693 return the result of that method. All other types raise a TypeError.
12694*/
12695PyObject *
12696PyOS_FSPath(PyObject *path)
12697{
Brett Cannon3f9183b2016-08-26 14:44:48 -070012698 /* For error message reasons, this function is manually inlined in
12699 path_converter(). */
Ethan Furman410ef8e2016-06-04 12:06:26 -070012700 _Py_IDENTIFIER(__fspath__);
12701 PyObject *func = NULL;
12702 PyObject *path_repr = NULL;
12703
12704 if (PyUnicode_Check(path) || PyBytes_Check(path)) {
12705 Py_INCREF(path);
12706 return path;
12707 }
12708
12709 func = _PyObject_LookupSpecial(path, &PyId___fspath__);
12710 if (NULL == func) {
12711 return PyErr_Format(PyExc_TypeError,
12712 "expected str, bytes or os.PathLike object, "
Brett Cannonc78ca1e2016-06-24 12:03:43 -070012713 "not %.200s",
12714 Py_TYPE(path)->tp_name);
Ethan Furman410ef8e2016-06-04 12:06:26 -070012715 }
12716
Victor Stinnerf17c3de2016-12-06 18:46:19 +010012717 path_repr = _PyObject_CallNoArg(func);
Ethan Furman410ef8e2016-06-04 12:06:26 -070012718 Py_DECREF(func);
Brett Cannon044283a2016-07-15 10:41:49 -070012719 if (NULL == path_repr) {
12720 return NULL;
12721 }
12722
Brett Cannonc78ca1e2016-06-24 12:03:43 -070012723 if (!(PyUnicode_Check(path_repr) || PyBytes_Check(path_repr))) {
12724 PyErr_Format(PyExc_TypeError,
12725 "expected %.200s.__fspath__() to return str or bytes, "
12726 "not %.200s", Py_TYPE(path)->tp_name,
12727 Py_TYPE(path_repr)->tp_name);
12728 Py_DECREF(path_repr);
12729 return NULL;
12730 }
12731
Ethan Furman410ef8e2016-06-04 12:06:26 -070012732 return path_repr;
12733}
12734
12735/*[clinic input]
12736os.fspath
12737
12738 path: object
12739
12740Return the file system path representation of the object.
12741
Brett Cannonb4f43e92016-06-09 14:32:08 -070012742If the object is str or bytes, then allow it to pass through as-is. If the
12743object defines __fspath__(), then return the result of that method. All other
12744types raise a TypeError.
Ethan Furman410ef8e2016-06-04 12:06:26 -070012745[clinic start generated code]*/
12746
12747static PyObject *
Serhiy Storchaka2954f832016-07-07 18:20:03 +030012748os_fspath_impl(PyObject *module, PyObject *path)
12749/*[clinic end generated code: output=c3c3b78ecff2914f input=e357165f7b22490f]*/
Ethan Furman410ef8e2016-06-04 12:06:26 -070012750{
12751 return PyOS_FSPath(path);
12752}
Victor Stinner6036e442015-03-08 01:58:04 +010012753
Victor Stinner9b1f4742016-09-06 16:18:52 -070012754#ifdef HAVE_GETRANDOM_SYSCALL
12755/*[clinic input]
12756os.getrandom
12757
12758 size: Py_ssize_t
12759 flags: int=0
12760
12761Obtain a series of random bytes.
12762[clinic start generated code]*/
12763
12764static PyObject *
12765os_getrandom_impl(PyObject *module, Py_ssize_t size, int flags)
12766/*[clinic end generated code: output=b3a618196a61409c input=59bafac39c594947]*/
12767{
Victor Stinner9b1f4742016-09-06 16:18:52 -070012768 PyObject *bytes;
Victor Stinnerec2319c2016-09-20 23:00:59 +020012769 Py_ssize_t n;
Victor Stinner9b1f4742016-09-06 16:18:52 -070012770
12771 if (size < 0) {
12772 errno = EINVAL;
12773 return posix_error();
12774 }
12775
Victor Stinnerec2319c2016-09-20 23:00:59 +020012776 bytes = PyBytes_FromStringAndSize(NULL, size);
12777 if (bytes == NULL) {
Victor Stinner9b1f4742016-09-06 16:18:52 -070012778 PyErr_NoMemory();
12779 return NULL;
12780 }
12781
12782 while (1) {
Victor Stinnerec2319c2016-09-20 23:00:59 +020012783 n = syscall(SYS_getrandom,
12784 PyBytes_AS_STRING(bytes),
12785 PyBytes_GET_SIZE(bytes),
12786 flags);
Victor Stinner9b1f4742016-09-06 16:18:52 -070012787 if (n < 0 && errno == EINTR) {
12788 if (PyErr_CheckSignals() < 0) {
Victor Stinnerec2319c2016-09-20 23:00:59 +020012789 goto error;
Victor Stinner9b1f4742016-09-06 16:18:52 -070012790 }
Victor Stinnerec2319c2016-09-20 23:00:59 +020012791
12792 /* getrandom() was interrupted by a signal: retry */
Victor Stinner9b1f4742016-09-06 16:18:52 -070012793 continue;
12794 }
12795 break;
12796 }
12797
12798 if (n < 0) {
Victor Stinner9b1f4742016-09-06 16:18:52 -070012799 PyErr_SetFromErrno(PyExc_OSError);
Victor Stinnerec2319c2016-09-20 23:00:59 +020012800 goto error;
Victor Stinner9b1f4742016-09-06 16:18:52 -070012801 }
12802
Victor Stinnerec2319c2016-09-20 23:00:59 +020012803 if (n != size) {
12804 _PyBytes_Resize(&bytes, n);
12805 }
Victor Stinner9b1f4742016-09-06 16:18:52 -070012806
12807 return bytes;
Victor Stinnerec2319c2016-09-20 23:00:59 +020012808
12809error:
12810 Py_DECREF(bytes);
12811 return NULL;
Victor Stinner9b1f4742016-09-06 16:18:52 -070012812}
12813#endif /* HAVE_GETRANDOM_SYSCALL */
12814
Larry Hastings31826802013-10-19 00:09:25 -070012815
Fred Drake5ab8eaf1999-12-09 21:13:07 +000012816static PyMethodDef posix_methods[] = {
Larry Hastings31826802013-10-19 00:09:25 -070012817
12818 OS_STAT_METHODDEF
12819 OS_ACCESS_METHODDEF
12820 OS_TTYNAME_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100012821 OS_CHDIR_METHODDEF
12822 OS_CHFLAGS_METHODDEF
12823 OS_CHMOD_METHODDEF
12824 OS_FCHMOD_METHODDEF
12825 OS_LCHMOD_METHODDEF
12826 OS_CHOWN_METHODDEF
12827 OS_FCHOWN_METHODDEF
12828 OS_LCHOWN_METHODDEF
12829 OS_LCHFLAGS_METHODDEF
12830 OS_CHROOT_METHODDEF
12831 OS_CTERMID_METHODDEF
12832 OS_GETCWD_METHODDEF
12833 OS_GETCWDB_METHODDEF
12834 OS_LINK_METHODDEF
12835 OS_LISTDIR_METHODDEF
12836 OS_LSTAT_METHODDEF
12837 OS_MKDIR_METHODDEF
12838 OS_NICE_METHODDEF
12839 OS_GETPRIORITY_METHODDEF
12840 OS_SETPRIORITY_METHODDEF
Pablo Galindo6c6ddf92018-01-29 01:56:10 +000012841 OS_POSIX_SPAWN_METHODDEF
Guido van Rossumb6775db1994-08-01 11:34:53 +000012842#ifdef HAVE_READLINK
Larry Hastings9cf065c2012-06-22 16:30:09 -070012843 {"readlink", (PyCFunction)posix_readlink,
12844 METH_VARARGS | METH_KEYWORDS,
12845 readlink__doc__},
Guido van Rossum6a3eb5f1994-08-18 15:42:46 +000012846#endif /* HAVE_READLINK */
Brian Curtind40e6f72010-07-08 21:39:08 +000012847#if !defined(HAVE_READLINK) && defined(MS_WINDOWS)
Larry Hastings9cf065c2012-06-22 16:30:09 -070012848 {"readlink", (PyCFunction)win_readlink,
12849 METH_VARARGS | METH_KEYWORDS,
12850 readlink__doc__},
Brian Curtind40e6f72010-07-08 21:39:08 +000012851#endif /* !defined(HAVE_READLINK) && defined(MS_WINDOWS) */
Larry Hastings2f936352014-08-05 14:04:04 +100012852 OS_RENAME_METHODDEF
12853 OS_REPLACE_METHODDEF
12854 OS_RMDIR_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100012855 OS_SYMLINK_METHODDEF
12856 OS_SYSTEM_METHODDEF
12857 OS_UMASK_METHODDEF
12858 OS_UNAME_METHODDEF
12859 OS_UNLINK_METHODDEF
12860 OS_REMOVE_METHODDEF
12861 OS_UTIME_METHODDEF
12862 OS_TIMES_METHODDEF
12863 OS__EXIT_METHODDEF
12864 OS_EXECV_METHODDEF
12865 OS_EXECVE_METHODDEF
12866 OS_SPAWNV_METHODDEF
12867 OS_SPAWNVE_METHODDEF
12868 OS_FORK1_METHODDEF
12869 OS_FORK_METHODDEF
Antoine Pitrou346cbd32017-05-27 17:50:54 +020012870 OS_REGISTER_AT_FORK_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100012871 OS_SCHED_GET_PRIORITY_MAX_METHODDEF
12872 OS_SCHED_GET_PRIORITY_MIN_METHODDEF
12873 OS_SCHED_GETPARAM_METHODDEF
12874 OS_SCHED_GETSCHEDULER_METHODDEF
12875 OS_SCHED_RR_GET_INTERVAL_METHODDEF
12876 OS_SCHED_SETPARAM_METHODDEF
12877 OS_SCHED_SETSCHEDULER_METHODDEF
12878 OS_SCHED_YIELD_METHODDEF
12879 OS_SCHED_SETAFFINITY_METHODDEF
12880 OS_SCHED_GETAFFINITY_METHODDEF
12881 OS_OPENPTY_METHODDEF
12882 OS_FORKPTY_METHODDEF
12883 OS_GETEGID_METHODDEF
12884 OS_GETEUID_METHODDEF
12885 OS_GETGID_METHODDEF
Ross Lagerwallb0ae53d2011-06-10 07:30:30 +020012886#ifdef HAVE_GETGROUPLIST
12887 {"getgrouplist", posix_getgrouplist, METH_VARARGS, posix_getgrouplist__doc__},
12888#endif
Larry Hastings2f936352014-08-05 14:04:04 +100012889 OS_GETGROUPS_METHODDEF
12890 OS_GETPID_METHODDEF
12891 OS_GETPGRP_METHODDEF
12892 OS_GETPPID_METHODDEF
12893 OS_GETUID_METHODDEF
12894 OS_GETLOGIN_METHODDEF
12895 OS_KILL_METHODDEF
12896 OS_KILLPG_METHODDEF
12897 OS_PLOCK_METHODDEF
Thomas Heller8b7a9572007-08-31 06:44:36 +000012898#ifdef MS_WINDOWS
Steve Dowercc16be82016-09-08 10:35:16 -070012899 OS_STARTFILE_METHODDEF
Thomas Heller8b7a9572007-08-31 06:44:36 +000012900#endif
Larry Hastings2f936352014-08-05 14:04:04 +100012901 OS_SETUID_METHODDEF
12902 OS_SETEUID_METHODDEF
12903 OS_SETREUID_METHODDEF
12904 OS_SETGID_METHODDEF
12905 OS_SETEGID_METHODDEF
12906 OS_SETREGID_METHODDEF
12907 OS_SETGROUPS_METHODDEF
Antoine Pitroub7572f02009-12-02 20:46:48 +000012908#ifdef HAVE_INITGROUPS
Victor Stinner8c62be82010-05-06 00:08:46 +000012909 {"initgroups", posix_initgroups, METH_VARARGS, posix_initgroups__doc__},
Antoine Pitroub7572f02009-12-02 20:46:48 +000012910#endif /* HAVE_INITGROUPS */
Larry Hastings2f936352014-08-05 14:04:04 +100012911 OS_GETPGID_METHODDEF
12912 OS_SETPGRP_METHODDEF
12913 OS_WAIT_METHODDEF
12914 OS_WAIT3_METHODDEF
12915 OS_WAIT4_METHODDEF
12916 OS_WAITID_METHODDEF
12917 OS_WAITPID_METHODDEF
12918 OS_GETSID_METHODDEF
12919 OS_SETSID_METHODDEF
12920 OS_SETPGID_METHODDEF
12921 OS_TCGETPGRP_METHODDEF
12922 OS_TCSETPGRP_METHODDEF
12923 OS_OPEN_METHODDEF
12924 OS_CLOSE_METHODDEF
12925 OS_CLOSERANGE_METHODDEF
12926 OS_DEVICE_ENCODING_METHODDEF
12927 OS_DUP_METHODDEF
12928 OS_DUP2_METHODDEF
12929 OS_LOCKF_METHODDEF
12930 OS_LSEEK_METHODDEF
12931 OS_READ_METHODDEF
12932 OS_READV_METHODDEF
12933 OS_PREAD_METHODDEF
Pablo Galindo4defba32018-01-27 16:16:37 +000012934 OS_PREADV_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100012935 OS_WRITE_METHODDEF
12936 OS_WRITEV_METHODDEF
12937 OS_PWRITE_METHODDEF
Pablo Galindo4defba32018-01-27 16:16:37 +000012938 OS_PWRITEV_METHODDEF
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000012939#ifdef HAVE_SENDFILE
12940 {"sendfile", (PyCFunction)posix_sendfile, METH_VARARGS | METH_KEYWORDS,
12941 posix_sendfile__doc__},
12942#endif
Larry Hastings2f936352014-08-05 14:04:04 +100012943 OS_FSTAT_METHODDEF
12944 OS_ISATTY_METHODDEF
12945 OS_PIPE_METHODDEF
12946 OS_PIPE2_METHODDEF
12947 OS_MKFIFO_METHODDEF
12948 OS_MKNOD_METHODDEF
12949 OS_MAJOR_METHODDEF
12950 OS_MINOR_METHODDEF
12951 OS_MAKEDEV_METHODDEF
12952 OS_FTRUNCATE_METHODDEF
12953 OS_TRUNCATE_METHODDEF
12954 OS_POSIX_FALLOCATE_METHODDEF
12955 OS_POSIX_FADVISE_METHODDEF
12956 OS_PUTENV_METHODDEF
12957 OS_UNSETENV_METHODDEF
12958 OS_STRERROR_METHODDEF
12959 OS_FCHDIR_METHODDEF
12960 OS_FSYNC_METHODDEF
12961 OS_SYNC_METHODDEF
12962 OS_FDATASYNC_METHODDEF
12963 OS_WCOREDUMP_METHODDEF
12964 OS_WIFCONTINUED_METHODDEF
12965 OS_WIFSTOPPED_METHODDEF
12966 OS_WIFSIGNALED_METHODDEF
12967 OS_WIFEXITED_METHODDEF
12968 OS_WEXITSTATUS_METHODDEF
12969 OS_WTERMSIG_METHODDEF
12970 OS_WSTOPSIG_METHODDEF
12971 OS_FSTATVFS_METHODDEF
12972 OS_STATVFS_METHODDEF
12973 OS_CONFSTR_METHODDEF
12974 OS_SYSCONF_METHODDEF
12975 OS_FPATHCONF_METHODDEF
12976 OS_PATHCONF_METHODDEF
12977 OS_ABORT_METHODDEF
Serhiy Storchakaf0b50152015-05-13 00:52:39 +030012978 OS__GETFULLPATHNAME_METHODDEF
12979 OS__ISDIR_METHODDEF
Larry Hastings2f936352014-08-05 14:04:04 +100012980 OS__GETDISKUSAGE_METHODDEF
12981 OS__GETFINALPATHNAME_METHODDEF
12982 OS__GETVOLUMEPATHNAME_METHODDEF
12983 OS_GETLOADAVG_METHODDEF
12984 OS_URANDOM_METHODDEF
12985 OS_SETRESUID_METHODDEF
12986 OS_SETRESGID_METHODDEF
12987 OS_GETRESUID_METHODDEF
12988 OS_GETRESGID_METHODDEF
Martin v. Löwis7aed61a2009-11-27 14:09:49 +000012989
Larry Hastings2f936352014-08-05 14:04:04 +100012990 OS_GETXATTR_METHODDEF
12991 OS_SETXATTR_METHODDEF
12992 OS_REMOVEXATTR_METHODDEF
12993 OS_LISTXATTR_METHODDEF
12994
Antoine Pitroubcf2b592012-02-08 23:28:36 +010012995#if defined(TERMSIZE_USE_CONIO) || defined(TERMSIZE_USE_IOCTL)
12996 {"get_terminal_size", get_terminal_size, METH_VARARGS, termsize__doc__},
12997#endif
Larry Hastings2f936352014-08-05 14:04:04 +100012998 OS_CPU_COUNT_METHODDEF
12999 OS_GET_INHERITABLE_METHODDEF
13000 OS_SET_INHERITABLE_METHODDEF
13001 OS_GET_HANDLE_INHERITABLE_METHODDEF
13002 OS_SET_HANDLE_INHERITABLE_METHODDEF
Victor Stinner1db9e7b2014-07-29 22:32:47 +020013003#ifndef MS_WINDOWS
13004 {"get_blocking", posix_get_blocking, METH_VARARGS, get_blocking__doc__},
13005 {"set_blocking", posix_set_blocking, METH_VARARGS, set_blocking__doc__},
13006#endif
Serhiy Storchaka49d02d12016-11-06 13:45:33 +020013007 OS_SCANDIR_METHODDEF
Ethan Furman410ef8e2016-06-04 12:06:26 -070013008 OS_FSPATH_METHODDEF
Victor Stinner9b1f4742016-09-06 16:18:52 -070013009 OS_GETRANDOM_METHODDEF
Victor Stinner8c62be82010-05-06 00:08:46 +000013010 {NULL, NULL} /* Sentinel */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000013011};
13012
13013
Brian Curtin52173d42010-12-02 18:29:18 +000013014#if defined(HAVE_SYMLINK) && defined(MS_WINDOWS)
Brian Curtin3b4499c2010-12-28 14:31:47 +000013015static int
Brian Curtin52173d42010-12-02 18:29:18 +000013016enable_symlink()
13017{
13018 HANDLE tok;
13019 TOKEN_PRIVILEGES tok_priv;
13020 LUID luid;
Brian Curtin52173d42010-12-02 18:29:18 +000013021
13022 if (!OpenProcessToken(GetCurrentProcess(), TOKEN_ALL_ACCESS, &tok))
Brian Curtin3b4499c2010-12-28 14:31:47 +000013023 return 0;
Brian Curtin52173d42010-12-02 18:29:18 +000013024
13025 if (!LookupPrivilegeValue(NULL, SE_CREATE_SYMBOLIC_LINK_NAME, &luid))
Brian Curtin3b4499c2010-12-28 14:31:47 +000013026 return 0;
Brian Curtin52173d42010-12-02 18:29:18 +000013027
13028 tok_priv.PrivilegeCount = 1;
13029 tok_priv.Privileges[0].Luid = luid;
13030 tok_priv.Privileges[0].Attributes = SE_PRIVILEGE_ENABLED;
13031
13032 if (!AdjustTokenPrivileges(tok, FALSE, &tok_priv,
13033 sizeof(TOKEN_PRIVILEGES),
13034 (PTOKEN_PRIVILEGES) NULL, (PDWORD) NULL))
Brian Curtin3b4499c2010-12-28 14:31:47 +000013035 return 0;
Brian Curtin52173d42010-12-02 18:29:18 +000013036
Brian Curtin3b4499c2010-12-28 14:31:47 +000013037 /* ERROR_NOT_ALL_ASSIGNED returned when the privilege can't be assigned. */
13038 return GetLastError() == ERROR_NOT_ALL_ASSIGNED ? 0 : 1;
Brian Curtin52173d42010-12-02 18:29:18 +000013039}
13040#endif /* defined(HAVE_SYMLINK) && defined(MS_WINDOWS) */
13041
Barry Warsaw4a342091996-12-19 23:50:02 +000013042static int
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013043all_ins(PyObject *m)
Barry Warsaw4a342091996-12-19 23:50:02 +000013044{
Guido van Rossum94f6f721999-01-06 18:42:14 +000013045#ifdef F_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013046 if (PyModule_AddIntMacro(m, F_OK)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013047#endif
Guido van Rossum94f6f721999-01-06 18:42:14 +000013048#ifdef R_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013049 if (PyModule_AddIntMacro(m, R_OK)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013050#endif
Guido van Rossum94f6f721999-01-06 18:42:14 +000013051#ifdef W_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013052 if (PyModule_AddIntMacro(m, W_OK)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013053#endif
Guido van Rossum94f6f721999-01-06 18:42:14 +000013054#ifdef X_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013055 if (PyModule_AddIntMacro(m, X_OK)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013056#endif
Fred Drakec9680921999-12-13 16:37:25 +000013057#ifdef NGROUPS_MAX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013058 if (PyModule_AddIntMacro(m, NGROUPS_MAX)) return -1;
Fred Drakec9680921999-12-13 16:37:25 +000013059#endif
Fred Drake5ab8eaf1999-12-09 21:13:07 +000013060#ifdef TMP_MAX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013061 if (PyModule_AddIntMacro(m, TMP_MAX)) return -1;
Fred Drake5ab8eaf1999-12-09 21:13:07 +000013062#endif
Fred Drake106c1a02002-04-23 15:58:02 +000013063#ifdef WCONTINUED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013064 if (PyModule_AddIntMacro(m, WCONTINUED)) return -1;
Fred Drake106c1a02002-04-23 15:58:02 +000013065#endif
Barry Warsaw4a342091996-12-19 23:50:02 +000013066#ifdef WNOHANG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013067 if (PyModule_AddIntMacro(m, WNOHANG)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013068#endif
Fred Drake106c1a02002-04-23 15:58:02 +000013069#ifdef WUNTRACED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013070 if (PyModule_AddIntMacro(m, WUNTRACED)) return -1;
Fred Drake106c1a02002-04-23 15:58:02 +000013071#endif
Barry Warsaw4a342091996-12-19 23:50:02 +000013072#ifdef O_RDONLY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013073 if (PyModule_AddIntMacro(m, O_RDONLY)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013074#endif
13075#ifdef O_WRONLY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013076 if (PyModule_AddIntMacro(m, O_WRONLY)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013077#endif
13078#ifdef O_RDWR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013079 if (PyModule_AddIntMacro(m, O_RDWR)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013080#endif
13081#ifdef O_NDELAY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013082 if (PyModule_AddIntMacro(m, O_NDELAY)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013083#endif
13084#ifdef O_NONBLOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013085 if (PyModule_AddIntMacro(m, O_NONBLOCK)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013086#endif
13087#ifdef O_APPEND
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013088 if (PyModule_AddIntMacro(m, O_APPEND)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013089#endif
13090#ifdef O_DSYNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013091 if (PyModule_AddIntMacro(m, O_DSYNC)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013092#endif
13093#ifdef O_RSYNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013094 if (PyModule_AddIntMacro(m, O_RSYNC)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013095#endif
13096#ifdef O_SYNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013097 if (PyModule_AddIntMacro(m, O_SYNC)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013098#endif
13099#ifdef O_NOCTTY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013100 if (PyModule_AddIntMacro(m, O_NOCTTY)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013101#endif
13102#ifdef O_CREAT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013103 if (PyModule_AddIntMacro(m, O_CREAT)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013104#endif
13105#ifdef O_EXCL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013106 if (PyModule_AddIntMacro(m, O_EXCL)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013107#endif
13108#ifdef O_TRUNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013109 if (PyModule_AddIntMacro(m, O_TRUNC)) return -1;
Barry Warsaw4a342091996-12-19 23:50:02 +000013110#endif
Guido van Rossum98d9d091997-08-08 21:48:51 +000013111#ifdef O_BINARY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013112 if (PyModule_AddIntMacro(m, O_BINARY)) return -1;
Guido van Rossum98d9d091997-08-08 21:48:51 +000013113#endif
13114#ifdef O_TEXT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013115 if (PyModule_AddIntMacro(m, O_TEXT)) return -1;
Guido van Rossum98d9d091997-08-08 21:48:51 +000013116#endif
Jesus Cea1d642d22012-04-24 20:59:17 +020013117#ifdef O_XATTR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013118 if (PyModule_AddIntMacro(m, O_XATTR)) return -1;
Jesus Cea1d642d22012-04-24 20:59:17 +020013119#endif
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000013120#ifdef O_LARGEFILE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013121 if (PyModule_AddIntMacro(m, O_LARGEFILE)) return -1;
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000013122#endif
doko@ubuntu.comfcff4372016-06-13 16:33:04 +020013123#ifndef __GNU__
Skip Montanaro5ff14922005-05-16 02:42:22 +000013124#ifdef O_SHLOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013125 if (PyModule_AddIntMacro(m, O_SHLOCK)) return -1;
Skip Montanaro5ff14922005-05-16 02:42:22 +000013126#endif
13127#ifdef O_EXLOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013128 if (PyModule_AddIntMacro(m, O_EXLOCK)) return -1;
Skip Montanaro5ff14922005-05-16 02:42:22 +000013129#endif
doko@ubuntu.comfcff4372016-06-13 16:33:04 +020013130#endif
Jesus Ceacf381202012-04-24 20:44:40 +020013131#ifdef O_EXEC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013132 if (PyModule_AddIntMacro(m, O_EXEC)) return -1;
Jesus Ceacf381202012-04-24 20:44:40 +020013133#endif
13134#ifdef O_SEARCH
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013135 if (PyModule_AddIntMacro(m, O_SEARCH)) return -1;
Jesus Ceacf381202012-04-24 20:44:40 +020013136#endif
Benjamin Peterson3b965a22013-03-13 10:27:41 -050013137#ifdef O_PATH
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013138 if (PyModule_AddIntMacro(m, O_PATH)) return -1;
Benjamin Peterson3b965a22013-03-13 10:27:41 -050013139#endif
Jesus Ceacf381202012-04-24 20:44:40 +020013140#ifdef O_TTY_INIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013141 if (PyModule_AddIntMacro(m, O_TTY_INIT)) return -1;
Jesus Ceacf381202012-04-24 20:44:40 +020013142#endif
Christian Heimes177b3f92013-08-16 14:35:09 +020013143#ifdef O_TMPFILE
13144 if (PyModule_AddIntMacro(m, O_TMPFILE)) return -1;
13145#endif
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000013146#ifdef PRIO_PROCESS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013147 if (PyModule_AddIntMacro(m, PRIO_PROCESS)) return -1;
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000013148#endif
13149#ifdef PRIO_PGRP
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013150 if (PyModule_AddIntMacro(m, PRIO_PGRP)) return -1;
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000013151#endif
13152#ifdef PRIO_USER
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013153 if (PyModule_AddIntMacro(m, PRIO_USER)) return -1;
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000013154#endif
Charles-François Natali1e045b12011-05-22 20:42:32 +020013155#ifdef O_CLOEXEC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013156 if (PyModule_AddIntMacro(m, O_CLOEXEC)) return -1;
Charles-François Natali1e045b12011-05-22 20:42:32 +020013157#endif
Jesus Cea1d642d22012-04-24 20:59:17 +020013158#ifdef O_ACCMODE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013159 if (PyModule_AddIntMacro(m, O_ACCMODE)) return -1;
Jesus Cea1d642d22012-04-24 20:59:17 +020013160#endif
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +000013161
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000013162
Jesus Cea94363612012-06-22 18:32:07 +020013163#ifdef SEEK_HOLE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013164 if (PyModule_AddIntMacro(m, SEEK_HOLE)) return -1;
Jesus Cea94363612012-06-22 18:32:07 +020013165#endif
13166#ifdef SEEK_DATA
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013167 if (PyModule_AddIntMacro(m, SEEK_DATA)) return -1;
Jesus Cea94363612012-06-22 18:32:07 +020013168#endif
13169
Tim Peters5aa91602002-01-30 05:46:57 +000013170/* MS Windows */
13171#ifdef O_NOINHERIT
Victor Stinner8c62be82010-05-06 00:08:46 +000013172 /* Don't inherit in child processes. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013173 if (PyModule_AddIntMacro(m, O_NOINHERIT)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013174#endif
13175#ifdef _O_SHORT_LIVED
Victor Stinner8c62be82010-05-06 00:08:46 +000013176 /* Optimize for short life (keep in memory). */
13177 /* MS forgot to define this one with a non-underscore form too. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013178 if (PyModule_AddIntConstant(m, "O_SHORT_LIVED", _O_SHORT_LIVED)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013179#endif
13180#ifdef O_TEMPORARY
Victor Stinner8c62be82010-05-06 00:08:46 +000013181 /* Automatically delete when last handle is closed. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013182 if (PyModule_AddIntMacro(m, O_TEMPORARY)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013183#endif
13184#ifdef O_RANDOM
Victor Stinner8c62be82010-05-06 00:08:46 +000013185 /* Optimize for random access. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013186 if (PyModule_AddIntMacro(m, O_RANDOM)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013187#endif
13188#ifdef O_SEQUENTIAL
Victor Stinner8c62be82010-05-06 00:08:46 +000013189 /* Optimize for sequential access. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013190 if (PyModule_AddIntMacro(m, O_SEQUENTIAL)) return -1;
Tim Peters5aa91602002-01-30 05:46:57 +000013191#endif
13192
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000013193/* GNU extensions. */
Alexandre Vassalottibee32532008-05-16 18:15:12 +000013194#ifdef O_ASYNC
Victor Stinner8c62be82010-05-06 00:08:46 +000013195 /* Send a SIGIO signal whenever input or output
13196 becomes available on file descriptor */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013197 if (PyModule_AddIntMacro(m, O_ASYNC)) return -1;
Alexandre Vassalottibee32532008-05-16 18:15:12 +000013198#endif
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000013199#ifdef O_DIRECT
Victor Stinner8c62be82010-05-06 00:08:46 +000013200 /* Direct disk access. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013201 if (PyModule_AddIntMacro(m, O_DIRECT)) return -1;
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000013202#endif
13203#ifdef O_DIRECTORY
Victor Stinner8c62be82010-05-06 00:08:46 +000013204 /* Must be a directory. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013205 if (PyModule_AddIntMacro(m, O_DIRECTORY)) return -1;
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000013206#endif
13207#ifdef O_NOFOLLOW
Victor Stinner8c62be82010-05-06 00:08:46 +000013208 /* Do not follow links. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013209 if (PyModule_AddIntMacro(m, O_NOFOLLOW)) return -1;
Martin v. Löwis4fe3c272001-10-18 22:05:36 +000013210#endif
Jesus Cea1d642d22012-04-24 20:59:17 +020013211#ifdef O_NOLINKS
13212 /* Fails if link count of the named file is greater than 1 */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013213 if (PyModule_AddIntMacro(m, O_NOLINKS)) return -1;
Jesus Cea1d642d22012-04-24 20:59:17 +020013214#endif
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +000013215#ifdef O_NOATIME
Victor Stinner8c62be82010-05-06 00:08:46 +000013216 /* Do not update the access time. */
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013217 if (PyModule_AddIntMacro(m, O_NOATIME)) return -1;
Guido van Rossum0d3fb8a2007-11-26 23:23:18 +000013218#endif
Guido van Rossumd48f2521997-12-05 22:19:34 +000013219
Victor Stinner8c62be82010-05-06 00:08:46 +000013220 /* These come from sysexits.h */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013221#ifdef EX_OK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013222 if (PyModule_AddIntMacro(m, EX_OK)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013223#endif /* EX_OK */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013224#ifdef EX_USAGE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013225 if (PyModule_AddIntMacro(m, EX_USAGE)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013226#endif /* EX_USAGE */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013227#ifdef EX_DATAERR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013228 if (PyModule_AddIntMacro(m, EX_DATAERR)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013229#endif /* EX_DATAERR */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013230#ifdef EX_NOINPUT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013231 if (PyModule_AddIntMacro(m, EX_NOINPUT)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013232#endif /* EX_NOINPUT */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013233#ifdef EX_NOUSER
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013234 if (PyModule_AddIntMacro(m, EX_NOUSER)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013235#endif /* EX_NOUSER */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013236#ifdef EX_NOHOST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013237 if (PyModule_AddIntMacro(m, EX_NOHOST)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013238#endif /* EX_NOHOST */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013239#ifdef EX_UNAVAILABLE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013240 if (PyModule_AddIntMacro(m, EX_UNAVAILABLE)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013241#endif /* EX_UNAVAILABLE */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013242#ifdef EX_SOFTWARE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013243 if (PyModule_AddIntMacro(m, EX_SOFTWARE)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013244#endif /* EX_SOFTWARE */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013245#ifdef EX_OSERR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013246 if (PyModule_AddIntMacro(m, EX_OSERR)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013247#endif /* EX_OSERR */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013248#ifdef EX_OSFILE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013249 if (PyModule_AddIntMacro(m, EX_OSFILE)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013250#endif /* EX_OSFILE */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013251#ifdef EX_CANTCREAT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013252 if (PyModule_AddIntMacro(m, EX_CANTCREAT)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013253#endif /* EX_CANTCREAT */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013254#ifdef EX_IOERR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013255 if (PyModule_AddIntMacro(m, EX_IOERR)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013256#endif /* EX_IOERR */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013257#ifdef EX_TEMPFAIL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013258 if (PyModule_AddIntMacro(m, EX_TEMPFAIL)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013259#endif /* EX_TEMPFAIL */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013260#ifdef EX_PROTOCOL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013261 if (PyModule_AddIntMacro(m, EX_PROTOCOL)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013262#endif /* EX_PROTOCOL */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013263#ifdef EX_NOPERM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013264 if (PyModule_AddIntMacro(m, EX_NOPERM)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013265#endif /* EX_NOPERM */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013266#ifdef EX_CONFIG
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013267 if (PyModule_AddIntMacro(m, EX_CONFIG)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013268#endif /* EX_CONFIG */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013269#ifdef EX_NOTFOUND
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013270 if (PyModule_AddIntMacro(m, EX_NOTFOUND)) return -1;
Neal Norwitz8e914d92003-01-10 15:29:16 +000013271#endif /* EX_NOTFOUND */
Barry Warsaw5676bd12003-01-07 20:57:09 +000013272
Amaury Forgeot d'Arc66d00ad2010-09-10 18:11:45 +000013273 /* statvfs */
Andrew M. Kuchling4ea04a32010-08-18 22:30:34 +000013274#ifdef ST_RDONLY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013275 if (PyModule_AddIntMacro(m, ST_RDONLY)) return -1;
Andrew M. Kuchling4ea04a32010-08-18 22:30:34 +000013276#endif /* ST_RDONLY */
13277#ifdef ST_NOSUID
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013278 if (PyModule_AddIntMacro(m, ST_NOSUID)) return -1;
Andrew M. Kuchling4ea04a32010-08-18 22:30:34 +000013279#endif /* ST_NOSUID */
13280
doko@ubuntu.comca616a22013-12-08 15:23:07 +010013281 /* GNU extensions */
13282#ifdef ST_NODEV
13283 if (PyModule_AddIntMacro(m, ST_NODEV)) return -1;
13284#endif /* ST_NODEV */
13285#ifdef ST_NOEXEC
13286 if (PyModule_AddIntMacro(m, ST_NOEXEC)) return -1;
13287#endif /* ST_NOEXEC */
13288#ifdef ST_SYNCHRONOUS
13289 if (PyModule_AddIntMacro(m, ST_SYNCHRONOUS)) return -1;
13290#endif /* ST_SYNCHRONOUS */
13291#ifdef ST_MANDLOCK
13292 if (PyModule_AddIntMacro(m, ST_MANDLOCK)) return -1;
13293#endif /* ST_MANDLOCK */
13294#ifdef ST_WRITE
13295 if (PyModule_AddIntMacro(m, ST_WRITE)) return -1;
13296#endif /* ST_WRITE */
13297#ifdef ST_APPEND
13298 if (PyModule_AddIntMacro(m, ST_APPEND)) return -1;
13299#endif /* ST_APPEND */
13300#ifdef ST_NOATIME
13301 if (PyModule_AddIntMacro(m, ST_NOATIME)) return -1;
13302#endif /* ST_NOATIME */
13303#ifdef ST_NODIRATIME
13304 if (PyModule_AddIntMacro(m, ST_NODIRATIME)) return -1;
13305#endif /* ST_NODIRATIME */
13306#ifdef ST_RELATIME
13307 if (PyModule_AddIntMacro(m, ST_RELATIME)) return -1;
13308#endif /* ST_RELATIME */
13309
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000013310 /* FreeBSD sendfile() constants */
13311#ifdef SF_NODISKIO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013312 if (PyModule_AddIntMacro(m, SF_NODISKIO)) return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000013313#endif
13314#ifdef SF_MNOWAIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013315 if (PyModule_AddIntMacro(m, SF_MNOWAIT)) return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000013316#endif
13317#ifdef SF_SYNC
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013318 if (PyModule_AddIntMacro(m, SF_SYNC)) return -1;
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +000013319#endif
13320
Ross Lagerwall7807c352011-03-17 20:20:30 +020013321 /* constants for posix_fadvise */
13322#ifdef POSIX_FADV_NORMAL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013323 if (PyModule_AddIntMacro(m, POSIX_FADV_NORMAL)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013324#endif
13325#ifdef POSIX_FADV_SEQUENTIAL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013326 if (PyModule_AddIntMacro(m, POSIX_FADV_SEQUENTIAL)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013327#endif
13328#ifdef POSIX_FADV_RANDOM
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013329 if (PyModule_AddIntMacro(m, POSIX_FADV_RANDOM)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013330#endif
13331#ifdef POSIX_FADV_NOREUSE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013332 if (PyModule_AddIntMacro(m, POSIX_FADV_NOREUSE)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013333#endif
13334#ifdef POSIX_FADV_WILLNEED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013335 if (PyModule_AddIntMacro(m, POSIX_FADV_WILLNEED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013336#endif
13337#ifdef POSIX_FADV_DONTNEED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013338 if (PyModule_AddIntMacro(m, POSIX_FADV_DONTNEED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013339#endif
13340
13341 /* constants for waitid */
13342#if defined(HAVE_SYS_WAIT_H) && defined(HAVE_WAITID)
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013343 if (PyModule_AddIntMacro(m, P_PID)) return -1;
13344 if (PyModule_AddIntMacro(m, P_PGID)) return -1;
13345 if (PyModule_AddIntMacro(m, P_ALL)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013346#endif
13347#ifdef WEXITED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013348 if (PyModule_AddIntMacro(m, WEXITED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013349#endif
13350#ifdef WNOWAIT
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013351 if (PyModule_AddIntMacro(m, WNOWAIT)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013352#endif
13353#ifdef WSTOPPED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013354 if (PyModule_AddIntMacro(m, WSTOPPED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013355#endif
13356#ifdef CLD_EXITED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013357 if (PyModule_AddIntMacro(m, CLD_EXITED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013358#endif
13359#ifdef CLD_DUMPED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013360 if (PyModule_AddIntMacro(m, CLD_DUMPED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013361#endif
13362#ifdef CLD_TRAPPED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013363 if (PyModule_AddIntMacro(m, CLD_TRAPPED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013364#endif
13365#ifdef CLD_CONTINUED
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013366 if (PyModule_AddIntMacro(m, CLD_CONTINUED)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013367#endif
13368
13369 /* constants for lockf */
13370#ifdef F_LOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013371 if (PyModule_AddIntMacro(m, F_LOCK)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013372#endif
13373#ifdef F_TLOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013374 if (PyModule_AddIntMacro(m, F_TLOCK)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013375#endif
13376#ifdef F_ULOCK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013377 if (PyModule_AddIntMacro(m, F_ULOCK)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013378#endif
13379#ifdef F_TEST
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013380 if (PyModule_AddIntMacro(m, F_TEST)) return -1;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013381#endif
13382
Pablo Galindo4defba32018-01-27 16:16:37 +000013383#ifdef RWF_DSYNC
13384 if (PyModule_AddIntConstant(m, "RWF_DSYNC", RWF_DSYNC)) return -1;
13385#endif
13386#ifdef RWF_HIPRI
13387 if (PyModule_AddIntConstant(m, "RWF_HIPRI", RWF_HIPRI)) return -1;
13388#endif
13389#ifdef RWF_SYNC
13390 if (PyModule_AddIntConstant(m, "RWF_SYNC", RWF_SYNC)) return -1;
13391#endif
13392#ifdef RWF_NOWAIT
13393 if (PyModule_AddIntConstant(m, "RWF_NOWAIT", RWF_NOWAIT)) return -1;
13394#endif
13395
Pablo Galindo6c6ddf92018-01-29 01:56:10 +000013396/* constants for posix_spawn */
13397#ifdef HAVE_POSIX_SPAWN
13398 if (PyModule_AddIntConstant(m, "POSIX_SPAWN_OPEN", POSIX_SPAWN_OPEN)) return -1;
13399 if (PyModule_AddIntConstant(m, "POSIX_SPAWN_CLOSE", POSIX_SPAWN_CLOSE)) return -1;
13400 if (PyModule_AddIntConstant(m, "POSIX_SPAWN_DUP2", POSIX_SPAWN_DUP2)) return -1;
13401#endif
13402
Guido van Rossum246bc171999-02-01 23:54:31 +000013403#ifdef HAVE_SPAWNV
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013404 if (PyModule_AddIntConstant(m, "P_WAIT", _P_WAIT)) return -1;
13405 if (PyModule_AddIntConstant(m, "P_NOWAIT", _P_NOWAIT)) return -1;
13406 if (PyModule_AddIntConstant(m, "P_OVERLAY", _OLD_P_OVERLAY)) return -1;
13407 if (PyModule_AddIntConstant(m, "P_NOWAITO", _P_NOWAITO)) return -1;
13408 if (PyModule_AddIntConstant(m, "P_DETACH", _P_DETACH)) return -1;
Guido van Rossum246bc171999-02-01 23:54:31 +000013409#endif
13410
Benjamin Peterson94b580d2011-08-02 17:30:04 -050013411#ifdef HAVE_SCHED_H
Benjamin Petersondbaa5592016-07-30 23:21:50 -070013412#ifdef SCHED_OTHER
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013413 if (PyModule_AddIntMacro(m, SCHED_OTHER)) return -1;
Benjamin Petersondbaa5592016-07-30 23:21:50 -070013414#endif
13415#ifdef SCHED_FIFO
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013416 if (PyModule_AddIntMacro(m, SCHED_FIFO)) return -1;
Benjamin Petersondbaa5592016-07-30 23:21:50 -070013417#endif
13418#ifdef SCHED_RR
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013419 if (PyModule_AddIntMacro(m, SCHED_RR)) return -1;
Benjamin Petersondbaa5592016-07-30 23:21:50 -070013420#endif
Benjamin Peterson94b580d2011-08-02 17:30:04 -050013421#ifdef SCHED_SPORADIC
messi Liao0d322182017-06-13 22:30:43 +080013422 if (PyModule_AddIntMacro(m, SCHED_SPORADIC)) return -1;
Benjamin Peterson94b580d2011-08-02 17:30:04 -050013423#endif
Benjamin Peterson94b580d2011-08-02 17:30:04 -050013424#ifdef SCHED_BATCH
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013425 if (PyModule_AddIntMacro(m, SCHED_BATCH)) return -1;
Benjamin Peterson94b580d2011-08-02 17:30:04 -050013426#endif
13427#ifdef SCHED_IDLE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013428 if (PyModule_AddIntMacro(m, SCHED_IDLE)) return -1;
Benjamin Peterson94b580d2011-08-02 17:30:04 -050013429#endif
13430#ifdef SCHED_RESET_ON_FORK
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013431 if (PyModule_AddIntMacro(m, SCHED_RESET_ON_FORK)) return -1;
Benjamin Peterson94b580d2011-08-02 17:30:04 -050013432#endif
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020013433#ifdef SCHED_SYS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013434 if (PyModule_AddIntMacro(m, SCHED_SYS)) return -1;
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020013435#endif
13436#ifdef SCHED_IA
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013437 if (PyModule_AddIntMacro(m, SCHED_IA)) return -1;
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020013438#endif
13439#ifdef SCHED_FSS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013440 if (PyModule_AddIntMacro(m, SCHED_FSS)) return -1;
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020013441#endif
13442#ifdef SCHED_FX
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013443 if (PyModule_AddIntConstant(m, "SCHED_FX", SCHED_FSS)) return -1;
Jesus Ceaf2cb4e82011-09-09 23:55:42 +020013444#endif
Benjamin Peterson94b580d2011-08-02 17:30:04 -050013445#endif
13446
Benjamin Peterson9428d532011-09-14 11:45:52 -040013447#ifdef USE_XATTRS
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013448 if (PyModule_AddIntMacro(m, XATTR_CREATE)) return -1;
13449 if (PyModule_AddIntMacro(m, XATTR_REPLACE)) return -1;
13450 if (PyModule_AddIntMacro(m, XATTR_SIZE_MAX)) return -1;
Benjamin Peterson799bd802011-08-31 22:15:17 -040013451#endif
13452
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030013453#if HAVE_DECL_RTLD_LAZY
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013454 if (PyModule_AddIntMacro(m, RTLD_LAZY)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020013455#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030013456#if HAVE_DECL_RTLD_NOW
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013457 if (PyModule_AddIntMacro(m, RTLD_NOW)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020013458#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030013459#if HAVE_DECL_RTLD_GLOBAL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013460 if (PyModule_AddIntMacro(m, RTLD_GLOBAL)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020013461#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030013462#if HAVE_DECL_RTLD_LOCAL
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013463 if (PyModule_AddIntMacro(m, RTLD_LOCAL)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020013464#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030013465#if HAVE_DECL_RTLD_NODELETE
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013466 if (PyModule_AddIntMacro(m, RTLD_NODELETE)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020013467#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030013468#if HAVE_DECL_RTLD_NOLOAD
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013469 if (PyModule_AddIntMacro(m, RTLD_NOLOAD)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020013470#endif
Serhiy Storchakac2f7d872016-05-04 09:44:44 +030013471#if HAVE_DECL_RTLD_DEEPBIND
Charles-Francois Natali74ca8862013-05-20 19:13:19 +020013472 if (PyModule_AddIntMacro(m, RTLD_DEEPBIND)) return -1;
Victor Stinner8b905bd2011-10-25 13:34:04 +020013473#endif
Michael Feltc5ae1692017-12-19 13:58:49 +010013474#if HAVE_DECL_RTLD_MEMBER
13475 if (PyModule_AddIntMacro(m, RTLD_MEMBER)) return -1;
13476#endif
Victor Stinner8b905bd2011-10-25 13:34:04 +020013477
Victor Stinner9b1f4742016-09-06 16:18:52 -070013478#ifdef HAVE_GETRANDOM_SYSCALL
13479 if (PyModule_AddIntMacro(m, GRND_RANDOM)) return -1;
13480 if (PyModule_AddIntMacro(m, GRND_NONBLOCK)) return -1;
13481#endif
13482
Victor Stinner8c62be82010-05-06 00:08:46 +000013483 return 0;
Barry Warsaw4a342091996-12-19 23:50:02 +000013484}
13485
13486
Martin v. Löwis1a214512008-06-11 05:26:20 +000013487static struct PyModuleDef posixmodule = {
Victor Stinner8c62be82010-05-06 00:08:46 +000013488 PyModuleDef_HEAD_INIT,
13489 MODNAME,
13490 posix__doc__,
13491 -1,
13492 posix_methods,
13493 NULL,
13494 NULL,
13495 NULL,
13496 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +000013497};
13498
13499
Serhiy Storchaka2d06e842015-12-25 19:53:18 +020013500static const char * const have_functions[] = {
Larry Hastings9cf065c2012-06-22 16:30:09 -070013501
13502#ifdef HAVE_FACCESSAT
13503 "HAVE_FACCESSAT",
13504#endif
13505
13506#ifdef HAVE_FCHDIR
13507 "HAVE_FCHDIR",
13508#endif
13509
13510#ifdef HAVE_FCHMOD
13511 "HAVE_FCHMOD",
13512#endif
13513
13514#ifdef HAVE_FCHMODAT
13515 "HAVE_FCHMODAT",
13516#endif
13517
13518#ifdef HAVE_FCHOWN
13519 "HAVE_FCHOWN",
13520#endif
13521
Larry Hastings00964ed2013-08-12 13:49:30 -040013522#ifdef HAVE_FCHOWNAT
13523 "HAVE_FCHOWNAT",
13524#endif
13525
Larry Hastings9cf065c2012-06-22 16:30:09 -070013526#ifdef HAVE_FEXECVE
13527 "HAVE_FEXECVE",
13528#endif
13529
13530#ifdef HAVE_FDOPENDIR
13531 "HAVE_FDOPENDIR",
13532#endif
13533
Georg Brandl306336b2012-06-24 12:55:33 +020013534#ifdef HAVE_FPATHCONF
13535 "HAVE_FPATHCONF",
13536#endif
13537
Larry Hastings9cf065c2012-06-22 16:30:09 -070013538#ifdef HAVE_FSTATAT
13539 "HAVE_FSTATAT",
13540#endif
13541
13542#ifdef HAVE_FSTATVFS
13543 "HAVE_FSTATVFS",
13544#endif
13545
Steve Dowerfe0a41a2015-03-20 19:50:46 -070013546#if defined HAVE_FTRUNCATE || defined MS_WINDOWS
Georg Brandl306336b2012-06-24 12:55:33 +020013547 "HAVE_FTRUNCATE",
13548#endif
13549
Larry Hastings9cf065c2012-06-22 16:30:09 -070013550#ifdef HAVE_FUTIMENS
13551 "HAVE_FUTIMENS",
13552#endif
13553
13554#ifdef HAVE_FUTIMES
13555 "HAVE_FUTIMES",
13556#endif
13557
13558#ifdef HAVE_FUTIMESAT
13559 "HAVE_FUTIMESAT",
13560#endif
13561
13562#ifdef HAVE_LINKAT
13563 "HAVE_LINKAT",
13564#endif
13565
13566#ifdef HAVE_LCHFLAGS
13567 "HAVE_LCHFLAGS",
13568#endif
13569
13570#ifdef HAVE_LCHMOD
13571 "HAVE_LCHMOD",
13572#endif
13573
13574#ifdef HAVE_LCHOWN
13575 "HAVE_LCHOWN",
13576#endif
13577
13578#ifdef HAVE_LSTAT
13579 "HAVE_LSTAT",
13580#endif
13581
13582#ifdef HAVE_LUTIMES
13583 "HAVE_LUTIMES",
13584#endif
13585
13586#ifdef HAVE_MKDIRAT
13587 "HAVE_MKDIRAT",
13588#endif
13589
13590#ifdef HAVE_MKFIFOAT
13591 "HAVE_MKFIFOAT",
13592#endif
13593
13594#ifdef HAVE_MKNODAT
13595 "HAVE_MKNODAT",
13596#endif
13597
13598#ifdef HAVE_OPENAT
13599 "HAVE_OPENAT",
13600#endif
13601
13602#ifdef HAVE_READLINKAT
13603 "HAVE_READLINKAT",
13604#endif
13605
13606#ifdef HAVE_RENAMEAT
13607 "HAVE_RENAMEAT",
13608#endif
13609
13610#ifdef HAVE_SYMLINKAT
13611 "HAVE_SYMLINKAT",
13612#endif
13613
13614#ifdef HAVE_UNLINKAT
13615 "HAVE_UNLINKAT",
13616#endif
13617
13618#ifdef HAVE_UTIMENSAT
13619 "HAVE_UTIMENSAT",
13620#endif
13621
13622#ifdef MS_WINDOWS
13623 "MS_WINDOWS",
13624#endif
13625
13626 NULL
13627};
13628
13629
Mark Hammondfe51c6d2002-08-02 02:27:13 +000013630PyMODINIT_FUNC
Thomas Woutersf3f33dc2000-07-21 06:00:07 +000013631INITFUNC(void)
Guido van Rossumb6775db1994-08-01 11:34:53 +000013632{
Victor Stinner8c62be82010-05-06 00:08:46 +000013633 PyObject *m, *v;
Larry Hastings9cf065c2012-06-22 16:30:09 -070013634 PyObject *list;
Serhiy Storchaka2d06e842015-12-25 19:53:18 +020013635 const char * const *trace;
Tim Peters5aa91602002-01-30 05:46:57 +000013636
Brian Curtin52173d42010-12-02 18:29:18 +000013637#if defined(HAVE_SYMLINK) && defined(MS_WINDOWS)
Brian Curtin3b4499c2010-12-28 14:31:47 +000013638 win32_can_symlink = enable_symlink();
Brian Curtin52173d42010-12-02 18:29:18 +000013639#endif
13640
Victor Stinner8c62be82010-05-06 00:08:46 +000013641 m = PyModule_Create(&posixmodule);
13642 if (m == NULL)
13643 return NULL;
Tim Peters5aa91602002-01-30 05:46:57 +000013644
Victor Stinner8c62be82010-05-06 00:08:46 +000013645 /* Initialize environ dictionary */
13646 v = convertenviron();
13647 Py_XINCREF(v);
13648 if (v == NULL || PyModule_AddObject(m, "environ", v) != 0)
13649 return NULL;
13650 Py_DECREF(v);
Fred Drakec9680921999-12-13 16:37:25 +000013651
Victor Stinner8c62be82010-05-06 00:08:46 +000013652 if (all_ins(m))
13653 return NULL;
Barry Warsaw4a342091996-12-19 23:50:02 +000013654
Victor Stinner8c62be82010-05-06 00:08:46 +000013655 if (setup_confname_tables(m))
13656 return NULL;
Fred Drakebec628d1999-12-15 18:31:10 +000013657
Victor Stinner8c62be82010-05-06 00:08:46 +000013658 Py_INCREF(PyExc_OSError);
13659 PyModule_AddObject(m, "error", PyExc_OSError);
Fred Drake762e2061999-08-26 17:23:54 +000013660
Guido van Rossumb3d39562000-01-31 18:41:26 +000013661#ifdef HAVE_PUTENV
Victor Stinner8c62be82010-05-06 00:08:46 +000013662 if (posix_putenv_garbage == NULL)
13663 posix_putenv_garbage = PyDict_New();
Guido van Rossumb3d39562000-01-31 18:41:26 +000013664#endif
Guido van Rossum98bf58f2001-10-18 20:34:25 +000013665
Victor Stinner8c62be82010-05-06 00:08:46 +000013666 if (!initialized) {
Ross Lagerwall7807c352011-03-17 20:20:30 +020013667#if defined(HAVE_WAITID) && !defined(__APPLE__)
13668 waitid_result_desc.name = MODNAME ".waitid_result";
Victor Stinner1c8f0592013-07-22 22:24:54 +020013669 if (PyStructSequence_InitType2(&WaitidResultType, &waitid_result_desc) < 0)
13670 return NULL;
Ross Lagerwall7807c352011-03-17 20:20:30 +020013671#endif
13672
Christian Heimes25827622013-10-12 01:27:08 +020013673 stat_result_desc.name = "os.stat_result"; /* see issue #19209 */
Victor Stinner8c62be82010-05-06 00:08:46 +000013674 stat_result_desc.fields[7].name = PyStructSequence_UnnamedField;
13675 stat_result_desc.fields[8].name = PyStructSequence_UnnamedField;
13676 stat_result_desc.fields[9].name = PyStructSequence_UnnamedField;
Victor Stinner1c8f0592013-07-22 22:24:54 +020013677 if (PyStructSequence_InitType2(&StatResultType, &stat_result_desc) < 0)
13678 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +000013679 structseq_new = StatResultType.tp_new;
13680 StatResultType.tp_new = statresult_new;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000013681
Christian Heimes25827622013-10-12 01:27:08 +020013682 statvfs_result_desc.name = "os.statvfs_result"; /* see issue #19209 */
Victor Stinner1c8f0592013-07-22 22:24:54 +020013683 if (PyStructSequence_InitType2(&StatVFSResultType,
13684 &statvfs_result_desc) < 0)
13685 return NULL;
Martin v. Löwis05bfe1f2008-12-29 18:21:47 +000013686#ifdef NEED_TICKS_PER_SECOND
13687# if defined(HAVE_SYSCONF) && defined(_SC_CLK_TCK)
Victor Stinner8c62be82010-05-06 00:08:46 +000013688 ticks_per_second = sysconf(_SC_CLK_TCK);
Martin v. Löwis05bfe1f2008-12-29 18:21:47 +000013689# elif defined(HZ)
Victor Stinner8c62be82010-05-06 00:08:46 +000013690 ticks_per_second = HZ;
Martin v. Löwis05bfe1f2008-12-29 18:21:47 +000013691# else
Victor Stinner8c62be82010-05-06 00:08:46 +000013692 ticks_per_second = 60; /* magic fallback value; may be bogus */
Martin v. Löwis05bfe1f2008-12-29 18:21:47 +000013693# endif
13694#endif
Benjamin Peterson94b580d2011-08-02 17:30:04 -050013695
Benjamin Peterson0163c9a2011-08-02 18:11:38 -050013696#if defined(HAVE_SCHED_SETPARAM) || defined(HAVE_SCHED_SETSCHEDULER)
Benjamin Peterson94b580d2011-08-02 17:30:04 -050013697 sched_param_desc.name = MODNAME ".sched_param";
Victor Stinner1c8f0592013-07-22 22:24:54 +020013698 if (PyStructSequence_InitType2(&SchedParamType, &sched_param_desc) < 0)
13699 return NULL;
Larry Hastings2f936352014-08-05 14:04:04 +100013700 SchedParamType.tp_new = os_sched_param;
Benjamin Peterson94b580d2011-08-02 17:30:04 -050013701#endif
Antoine Pitroubcf2b592012-02-08 23:28:36 +010013702
13703 /* initialize TerminalSize_info */
Victor Stinner1c8f0592013-07-22 22:24:54 +020013704 if (PyStructSequence_InitType2(&TerminalSizeType,
13705 &TerminalSize_desc) < 0)
13706 return NULL;
Victor Stinner6036e442015-03-08 01:58:04 +010013707
13708 /* initialize scandir types */
13709 if (PyType_Ready(&ScandirIteratorType) < 0)
13710 return NULL;
13711 if (PyType_Ready(&DirEntryType) < 0)
13712 return NULL;
Victor Stinner8c62be82010-05-06 00:08:46 +000013713 }
Ross Lagerwall7807c352011-03-17 20:20:30 +020013714#if defined(HAVE_WAITID) && !defined(__APPLE__)
13715 Py_INCREF((PyObject*) &WaitidResultType);
13716 PyModule_AddObject(m, "waitid_result", (PyObject*) &WaitidResultType);
13717#endif
Victor Stinner8c62be82010-05-06 00:08:46 +000013718 Py_INCREF((PyObject*) &StatResultType);
13719 PyModule_AddObject(m, "stat_result", (PyObject*) &StatResultType);
13720 Py_INCREF((PyObject*) &StatVFSResultType);
13721 PyModule_AddObject(m, "statvfs_result",
13722 (PyObject*) &StatVFSResultType);
Benjamin Petersone3298dd2011-08-02 18:40:46 -050013723
13724#if defined(HAVE_SCHED_SETPARAM) || defined(HAVE_SCHED_SETSCHEDULER)
Benjamin Peterson94b580d2011-08-02 17:30:04 -050013725 Py_INCREF(&SchedParamType);
13726 PyModule_AddObject(m, "sched_param", (PyObject *)&SchedParamType);
Benjamin Petersone3298dd2011-08-02 18:40:46 -050013727#endif
Thomas Wouters477c8d52006-05-27 19:21:47 +000013728
Larry Hastings605a62d2012-06-24 04:33:36 -070013729 times_result_desc.name = MODNAME ".times_result";
Victor Stinner1c8f0592013-07-22 22:24:54 +020013730 if (PyStructSequence_InitType2(&TimesResultType, &times_result_desc) < 0)
13731 return NULL;
Larry Hastings605a62d2012-06-24 04:33:36 -070013732 PyModule_AddObject(m, "times_result", (PyObject *)&TimesResultType);
13733
13734 uname_result_desc.name = MODNAME ".uname_result";
Victor Stinner1c8f0592013-07-22 22:24:54 +020013735 if (PyStructSequence_InitType2(&UnameResultType, &uname_result_desc) < 0)
13736 return NULL;
Larry Hastings605a62d2012-06-24 04:33:36 -070013737 PyModule_AddObject(m, "uname_result", (PyObject *)&UnameResultType);
13738
Thomas Wouters477c8d52006-05-27 19:21:47 +000013739#ifdef __APPLE__
Victor Stinner8c62be82010-05-06 00:08:46 +000013740 /*
13741 * Step 2 of weak-linking support on Mac OS X.
13742 *
13743 * The code below removes functions that are not available on the
13744 * currently active platform.
13745 *
13746 * This block allow one to use a python binary that was build on
Larry Hastings9cf065c2012-06-22 16:30:09 -070013747 * OSX 10.4 on OSX 10.3, without losing access to new APIs on
Victor Stinner8c62be82010-05-06 00:08:46 +000013748 * OSX 10.4.
13749 */
Thomas Wouters477c8d52006-05-27 19:21:47 +000013750#ifdef HAVE_FSTATVFS
Victor Stinner8c62be82010-05-06 00:08:46 +000013751 if (fstatvfs == NULL) {
13752 if (PyObject_DelAttrString(m, "fstatvfs") == -1) {
13753 return NULL;
13754 }
13755 }
Thomas Wouters477c8d52006-05-27 19:21:47 +000013756#endif /* HAVE_FSTATVFS */
13757
13758#ifdef HAVE_STATVFS
Victor Stinner8c62be82010-05-06 00:08:46 +000013759 if (statvfs == NULL) {
13760 if (PyObject_DelAttrString(m, "statvfs") == -1) {
13761 return NULL;
13762 }
13763 }
Thomas Wouters477c8d52006-05-27 19:21:47 +000013764#endif /* HAVE_STATVFS */
13765
13766# ifdef HAVE_LCHOWN
Victor Stinner8c62be82010-05-06 00:08:46 +000013767 if (lchown == NULL) {
13768 if (PyObject_DelAttrString(m, "lchown") == -1) {
13769 return NULL;
13770 }
13771 }
Thomas Wouters477c8d52006-05-27 19:21:47 +000013772#endif /* HAVE_LCHOWN */
13773
13774
13775#endif /* __APPLE__ */
Antoine Pitroubcf2b592012-02-08 23:28:36 +010013776
Antoine Pitrou9d20e0e2012-09-12 18:01:36 +020013777 Py_INCREF(&TerminalSizeType);
Antoine Pitroubcf2b592012-02-08 23:28:36 +010013778 PyModule_AddObject(m, "terminal_size", (PyObject*) &TerminalSizeType);
13779
Larry Hastings6fe20b32012-04-19 15:07:49 -070013780 billion = PyLong_FromLong(1000000000);
13781 if (!billion)
13782 return NULL;
13783
Larry Hastings9cf065c2012-06-22 16:30:09 -070013784 /* suppress "function not used" warnings */
13785 {
13786 int ignored;
13787 fd_specified("", -1);
13788 follow_symlinks_specified("", 1);
13789 dir_fd_and_follow_symlinks_invalid("chmod", DEFAULT_DIR_FD, 1);
13790 dir_fd_converter(Py_None, &ignored);
13791 dir_fd_unavailable(Py_None, &ignored);
13792 }
13793
13794 /*
13795 * provide list of locally available functions
13796 * so os.py can populate support_* lists
13797 */
13798 list = PyList_New(0);
13799 if (!list)
13800 return NULL;
13801 for (trace = have_functions; *trace; trace++) {
13802 PyObject *unicode = PyUnicode_DecodeASCII(*trace, strlen(*trace), NULL);
13803 if (!unicode)
13804 return NULL;
13805 if (PyList_Append(list, unicode))
13806 return NULL;
13807 Py_DECREF(unicode);
13808 }
13809 PyModule_AddObject(m, "_have_functions", list);
Ned Deilyeb3be662016-08-15 14:40:38 -040013810
13811 Py_INCREF((PyObject *) &DirEntryType);
Brett Cannona32c4d02016-06-24 14:14:44 -070013812 PyModule_AddObject(m, "DirEntry", (PyObject *)&DirEntryType);
Larry Hastings9cf065c2012-06-22 16:30:09 -070013813
13814 initialized = 1;
13815
Victor Stinner8c62be82010-05-06 00:08:46 +000013816 return m;
Guido van Rossumb6775db1994-08-01 11:34:53 +000013817}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000013818
13819#ifdef __cplusplus
13820}
13821#endif