1 /* Provide a more complete sys/stat header file.
2 Copyright (C) 2005-2012 Free Software Foundation, Inc.
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2, or (at your option)
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software Foundation,
16 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
18 /* Written by Eric Blake, Paul Eggert, and Jim Meyering. */
20 /* This file is supposed to be used on platforms where <sys/stat.h> is
21 incomplete. It is intended to provide definitions and prototypes
22 needed by an application. Start with what the system provides. */
25 @PRAGMA_SYSTEM_HEADER@
29 #if defined __need_system_sys_stat_h
30 /* Special invocation convention. */
32 #@INCLUDE_NEXT@ @NEXT_SYS_STAT_H@
35 /* Normal invocation convention. */
37 #ifndef _@GUARD_PREFIX@_SYS_STAT_H
40 #include <sys/types.h>
42 /* Get struct timespec. */
45 /* The include_next requires a split double-inclusion guard. */
46 #@INCLUDE_NEXT@ @NEXT_SYS_STAT_H@
48 #ifndef _@GUARD_PREFIX@_SYS_STAT_H
49 #define _@GUARD_PREFIX@_SYS_STAT_H
51 /* The definitions of _GL_FUNCDECL_RPL etc. are copied here. */
53 /* The definition of _GL_ARG_NONNULL is copied here. */
55 /* The definition of _GL_WARN_ON_USE is copied here. */
57 /* Before doing "#define mkdir rpl_mkdir" below, we need to include all
58 headers that may declare mkdir(). Native Windows platforms declare mkdir
59 in <io.h> and/or <direct.h>, not in <unistd.h>. */
60 #if (defined _WIN32 || defined __WIN32__) && ! defined __CYGWIN__
61 # include <io.h> /* mingw32, mingw64 */
62 # include <direct.h> /* mingw64, MSVC 9 */
65 /* Native Windows platforms declare umask() in <io.h>. */
66 #if 0 && ((defined _WIN32 || defined __WIN32__) && ! defined __CYGWIN__)
72 # define S_IFIFO _S_IFIFO
77 # define S_IFMT 0170000
80 #if STAT_MACROS_BROKEN
96 # define S_ISBLK(m) (((m) & S_IFMT) == S_IFBLK)
104 # define S_ISCHR(m) (((m) & S_IFMT) == S_IFCHR)
106 # define S_ISCHR(m) 0
112 # define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
114 # define S_ISDIR(m) 0
118 #ifndef S_ISDOOR /* Solaris 2.5 and up */
119 # define S_ISDOOR(m) 0
124 # define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
126 # define S_ISFIFO(m) 0
132 # define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
134 # define S_ISLNK(m) 0
138 #ifndef S_ISMPB /* V7 */
140 # define S_ISMPB(m) (((m) & S_IFMT) == S_IFMPB)
141 # define S_ISMPC(m) (((m) & S_IFMT) == S_IFMPC)
143 # define S_ISMPB(m) 0
144 # define S_ISMPC(m) 0
148 #ifndef S_ISNAM /* Xenix */
150 # define S_ISNAM(m) (((m) & S_IFMT) == S_IFNAM)
152 # define S_ISNAM(m) 0
156 #ifndef S_ISNWK /* HP/UX */
158 # define S_ISNWK(m) (((m) & S_IFMT) == S_IFNWK)
160 # define S_ISNWK(m) 0
164 #ifndef S_ISPORT /* Solaris 10 and up */
165 # define S_ISPORT(m) 0
170 # define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
172 # define S_ISREG(m) 0
178 # define S_ISSOCK(m) (((m) & S_IFMT) == S_IFSOCK)
180 # define S_ISSOCK(m) 0
186 # define S_TYPEISMQ(p) 0
190 # define S_TYPEISTMO(p) 0
196 # define S_TYPEISSEM(p) (S_ISNAM ((p)->st_mode) && (p)->st_rdev == S_INSEM)
198 # define S_TYPEISSEM(p) 0
204 # define S_TYPEISSHM(p) (S_ISNAM ((p)->st_mode) && (p)->st_rdev == S_INSHD)
206 # define S_TYPEISSHM(p) 0
210 /* high performance ("contiguous data") */
212 # define S_ISCTG(p) 0
215 /* Cray DMF (data migration facility): off line, with data */
217 # define S_ISOFD(p) 0
220 /* Cray DMF (data migration facility): off line, with no data */
222 # define S_ISOFL(p) 0
225 /* 4.4BSD whiteout */
227 # define S_ISWHT(m) 0
230 /* If any of the following are undefined,
231 define them to their de facto standard values. */
233 # define S_ISUID 04000
236 # define S_ISGID 02000
239 /* S_ISVTX is a common extension to POSIX. */
241 # define S_ISVTX 01000
244 #if !S_IRUSR && S_IREAD
245 # define S_IRUSR S_IREAD
248 # define S_IRUSR 00400
251 # define S_IRGRP (S_IRUSR >> 3)
254 # define S_IROTH (S_IRUSR >> 6)
257 #if !S_IWUSR && S_IWRITE
258 # define S_IWUSR S_IWRITE
261 # define S_IWUSR 00200
264 # define S_IWGRP (S_IWUSR >> 3)
267 # define S_IWOTH (S_IWUSR >> 6)
270 #if !S_IXUSR && S_IEXEC
271 # define S_IXUSR S_IEXEC
274 # define S_IXUSR 00100
277 # define S_IXGRP (S_IXUSR >> 3)
280 # define S_IXOTH (S_IXUSR >> 6)
284 # define S_IRWXU (S_IRUSR | S_IWUSR | S_IXUSR)
287 # define S_IRWXG (S_IRGRP | S_IWGRP | S_IXGRP)
290 # define S_IRWXO (S_IROTH | S_IWOTH | S_IXOTH)
293 /* S_IXUGO is a common extension to POSIX. */
295 # define S_IXUGO (S_IXUSR | S_IXGRP | S_IXOTH)
299 # define S_IRWXUGO (S_IRWXU | S_IRWXG | S_IRWXO)
302 /* Macros for futimens and utimensat. */
304 # define UTIME_NOW (-1)
305 # define UTIME_OMIT (-2)
309 #if @GNULIB_FCHMODAT@
310 # if !@HAVE_FCHMODAT@
311 _GL_FUNCDECL_SYS (fchmodat, int,
312 (int fd, char const *file, mode_t mode, int flag)
313 _GL_ARG_NONNULL ((2)));
315 _GL_CXXALIAS_SYS (fchmodat, int,
316 (int fd, char const *file, mode_t mode, int flag));
317 _GL_CXXALIASWARN (fchmodat);
318 #elif defined GNULIB_POSIXCHECK
320 # if HAVE_RAW_DECL_FCHMODAT
321 _GL_WARN_ON_USE (fchmodat, "fchmodat is not portable - "
322 "use gnulib module openat for portability");
329 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
331 # define fstat rpl_fstat
333 _GL_FUNCDECL_RPL (fstat, int, (int fd, struct stat *buf) _GL_ARG_NONNULL ((2)));
334 _GL_CXXALIAS_RPL (fstat, int, (int fd, struct stat *buf));
336 _GL_CXXALIAS_SYS (fstat, int, (int fd, struct stat *buf));
338 _GL_CXXALIASWARN (fstat);
339 #elif defined GNULIB_POSIXCHECK
341 # if HAVE_RAW_DECL_FSTAT
342 _GL_WARN_ON_USE (fstat, "fstat has portability problems - "
343 "use gnulib module fstat for portability");
349 # if @REPLACE_FSTATAT@
350 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
352 # define fstatat rpl_fstatat
354 _GL_FUNCDECL_RPL (fstatat, int,
355 (int fd, char const *name, struct stat *st, int flags)
356 _GL_ARG_NONNULL ((2, 3)));
357 _GL_CXXALIAS_RPL (fstatat, int,
358 (int fd, char const *name, struct stat *st, int flags));
361 _GL_FUNCDECL_SYS (fstatat, int,
362 (int fd, char const *name, struct stat *st, int flags)
363 _GL_ARG_NONNULL ((2, 3)));
365 _GL_CXXALIAS_SYS (fstatat, int,
366 (int fd, char const *name, struct stat *st, int flags));
368 _GL_CXXALIASWARN (fstatat);
369 #elif defined GNULIB_POSIXCHECK
371 # if HAVE_RAW_DECL_FSTATAT
372 _GL_WARN_ON_USE (fstatat, "fstatat is not portable - "
373 "use gnulib module openat for portability");
378 #if @GNULIB_FUTIMENS@
379 /* Use the rpl_ prefix also on Solaris <= 9, because on Solaris 9 our futimens
380 implementation relies on futimesat, which on Solaris 10 makes an invocation
381 to futimens that is meant to invoke the libc's futimens(), not gnulib's
383 # if @REPLACE_FUTIMENS@ || (!@HAVE_FUTIMENS@ && defined __sun)
384 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
386 # define futimens rpl_futimens
388 _GL_FUNCDECL_RPL (futimens, int, (int fd, struct timespec const times[2]));
389 _GL_CXXALIAS_RPL (futimens, int, (int fd, struct timespec const times[2]));
391 # if !@HAVE_FUTIMENS@
392 _GL_FUNCDECL_SYS (futimens, int, (int fd, struct timespec const times[2]));
394 _GL_CXXALIAS_SYS (futimens, int, (int fd, struct timespec const times[2]));
397 _GL_CXXALIASWARN (futimens);
399 #elif defined GNULIB_POSIXCHECK
401 # if HAVE_RAW_DECL_FUTIMENS
402 _GL_WARN_ON_USE (futimens, "futimens is not portable - "
403 "use gnulib module futimens for portability");
409 /* Change the mode of FILENAME to MODE, without dereferencing it if FILENAME
410 denotes a symbolic link. */
412 /* The lchmod replacement follows symbolic links. Callers should take
413 this into account; lchmod should be applied only to arguments that
414 are known to not be symbolic links. On hosts that lack lchmod,
415 this can lead to race conditions between the check and the
416 invocation of lchmod, but we know of no workarounds that are
417 reliable in general. You might try requesting support for lchmod
418 from your operating system supplier. */
419 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
420 # define lchmod chmod
422 /* Need to cast, because on mingw, the second parameter of chmod is
424 _GL_CXXALIAS_RPL_CAST_1 (lchmod, chmod, int,
425 (const char *filename, mode_t mode));
427 # if 0 /* assume already declared */
428 _GL_FUNCDECL_SYS (lchmod, int, (const char *filename, mode_t mode)
429 _GL_ARG_NONNULL ((1)));
431 _GL_CXXALIAS_SYS (lchmod, int, (const char *filename, mode_t mode));
434 _GL_CXXALIASWARN (lchmod);
436 #elif defined GNULIB_POSIXCHECK
438 # if HAVE_RAW_DECL_LCHMOD
439 _GL_WARN_ON_USE (lchmod, "lchmod is unportable - "
440 "use gnulib module lchmod for portability");
447 /* mingw does not support symlinks, therefore it does not have lstat. But
448 without links, stat does just fine. */
449 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
452 _GL_CXXALIAS_RPL_1 (lstat, stat, int, (const char *name, struct stat *buf));
453 # elif @REPLACE_LSTAT@
454 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
456 # define lstat rpl_lstat
458 _GL_FUNCDECL_RPL (lstat, int, (const char *name, struct stat *buf)
459 _GL_ARG_NONNULL ((1, 2)));
460 _GL_CXXALIAS_RPL (lstat, int, (const char *name, struct stat *buf));
462 _GL_CXXALIAS_SYS (lstat, int, (const char *name, struct stat *buf));
465 _GL_CXXALIASWARN (lstat);
467 #elif defined GNULIB_POSIXCHECK
469 # if HAVE_RAW_DECL_LSTAT
470 _GL_WARN_ON_USE (lstat, "lstat is unportable - "
471 "use gnulib module lstat for portability");
477 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
479 # define mkdir rpl_mkdir
481 _GL_FUNCDECL_RPL (mkdir, int, (char const *name, mode_t mode)
482 _GL_ARG_NONNULL ((1)));
483 _GL_CXXALIAS_RPL (mkdir, int, (char const *name, mode_t mode));
485 /* mingw's _mkdir() function has 1 argument, but we pass 2 arguments.
486 Additionally, it declares _mkdir (and depending on compile flags, an
487 alias mkdir), only in the nonstandard includes <direct.h> and <io.h>,
488 which are included above. */
489 # if (defined _WIN32 || defined __WIN32__) && ! defined __CYGWIN__
491 # if !GNULIB_defined_rpl_mkdir
493 rpl_mkdir (char const *name, mode_t mode)
495 return _mkdir (name);
497 # define GNULIB_defined_rpl_mkdir 1
500 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
501 # define mkdir rpl_mkdir
503 _GL_CXXALIAS_RPL (mkdir, int, (char const *name, mode_t mode));
505 _GL_CXXALIAS_SYS (mkdir, int, (char const *name, mode_t mode));
508 _GL_CXXALIASWARN (mkdir);
513 _GL_FUNCDECL_SYS (mkdirat, int, (int fd, char const *file, mode_t mode)
514 _GL_ARG_NONNULL ((2)));
516 _GL_CXXALIAS_SYS (mkdirat, int, (int fd, char const *file, mode_t mode));
517 _GL_CXXALIASWARN (mkdirat);
518 #elif defined GNULIB_POSIXCHECK
520 # if HAVE_RAW_DECL_MKDIRAT
521 _GL_WARN_ON_USE (mkdirat, "mkdirat is not portable - "
522 "use gnulib module openat for portability");
528 # if @REPLACE_MKFIFO@
529 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
531 # define mkfifo rpl_mkfifo
533 _GL_FUNCDECL_RPL (mkfifo, int, (char const *file, mode_t mode)
534 _GL_ARG_NONNULL ((1)));
535 _GL_CXXALIAS_RPL (mkfifo, int, (char const *file, mode_t mode));
538 _GL_FUNCDECL_SYS (mkfifo, int, (char const *file, mode_t mode)
539 _GL_ARG_NONNULL ((1)));
541 _GL_CXXALIAS_SYS (mkfifo, int, (char const *file, mode_t mode));
543 _GL_CXXALIASWARN (mkfifo);
544 #elif defined GNULIB_POSIXCHECK
546 # if HAVE_RAW_DECL_MKFIFO
547 _GL_WARN_ON_USE (mkfifo, "mkfifo is not portable - "
548 "use gnulib module mkfifo for portability");
553 #if @GNULIB_MKFIFOAT@
554 # if !@HAVE_MKFIFOAT@
555 _GL_FUNCDECL_SYS (mkfifoat, int, (int fd, char const *file, mode_t mode)
556 _GL_ARG_NONNULL ((2)));
558 _GL_CXXALIAS_SYS (mkfifoat, int, (int fd, char const *file, mode_t mode));
559 _GL_CXXALIASWARN (mkfifoat);
560 #elif defined GNULIB_POSIXCHECK
562 # if HAVE_RAW_DECL_MKFIFOAT
563 _GL_WARN_ON_USE (mkfifoat, "mkfifoat is not portable - "
564 "use gnulib module mkfifoat for portability");
571 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
573 # define mknod rpl_mknod
575 _GL_FUNCDECL_RPL (mknod, int, (char const *file, mode_t mode, dev_t dev)
576 _GL_ARG_NONNULL ((1)));
577 _GL_CXXALIAS_RPL (mknod, int, (char const *file, mode_t mode, dev_t dev));
580 _GL_FUNCDECL_SYS (mknod, int, (char const *file, mode_t mode, dev_t dev)
581 _GL_ARG_NONNULL ((1)));
583 /* Need to cast, because on OSF/1 5.1, the third parameter is '...'. */
584 _GL_CXXALIAS_SYS_CAST (mknod, int, (char const *file, mode_t mode, dev_t dev));
586 _GL_CXXALIASWARN (mknod);
587 #elif defined GNULIB_POSIXCHECK
589 # if HAVE_RAW_DECL_MKNOD
590 _GL_WARN_ON_USE (mknod, "mknod is not portable - "
591 "use gnulib module mknod for portability");
598 _GL_FUNCDECL_SYS (mknodat, int,
599 (int fd, char const *file, mode_t mode, dev_t dev)
600 _GL_ARG_NONNULL ((2)));
602 _GL_CXXALIAS_SYS (mknodat, int,
603 (int fd, char const *file, mode_t mode, dev_t dev));
604 _GL_CXXALIASWARN (mknodat);
605 #elif defined GNULIB_POSIXCHECK
607 # if HAVE_RAW_DECL_MKNODAT
608 _GL_WARN_ON_USE (mknodat, "mknodat is not portable - "
609 "use gnulib module mkfifoat for portability");
616 /* We can't use the object-like #define stat rpl_stat, because of
617 struct stat. This means that rpl_stat will not be used if the user
618 does (stat)(a,b). Oh well. */
619 # if defined _AIX && defined stat && defined _LARGE_FILES
620 /* With _LARGE_FILES defined, AIX (only) defines stat to stat64,
621 so we have to replace stat64() instead of stat(). */
623 # define stat64(name, st) rpl_stat (name, st)
624 # elif defined __MINGW32__ && defined stat
625 # ifdef _USE_32BIT_TIME_T
626 /* The system headers define stat to _stat32i64. */
628 # define _stat32i64(name, st) rpl_stat (name, st)
630 /* The system headers define stat to _stat64. */
632 # define _stat64(name, st) rpl_stat (name, st)
634 # elif defined _MSC_VER && defined stat
635 # ifdef _USE_32BIT_TIME_T
636 /* The system headers define stat to _stat32. */
638 # define _stat32(name, st) rpl_stat (name, st)
640 /* The system headers define stat to _stat64i32. */
642 # define _stat64i32(name, st) rpl_stat (name, st)
644 # else /* !(_AIX ||__MINGW32__ || _MSC_VER) */
646 # define stat(name, st) rpl_stat (name, st)
647 # endif /* !_LARGE_FILES */
648 _GL_EXTERN_C int stat (const char *name, struct stat *buf)
649 _GL_ARG_NONNULL ((1, 2));
651 #elif defined GNULIB_POSIXCHECK
653 # if HAVE_RAW_DECL_STAT
654 _GL_WARN_ON_USE (stat, "stat is unportable - "
655 "use gnulib module stat for portability");
660 #if @GNULIB_UTIMENSAT@
661 /* Use the rpl_ prefix also on Solaris <= 9, because on Solaris 9 our utimensat
662 implementation relies on futimesat, which on Solaris 10 makes an invocation
663 to utimensat that is meant to invoke the libc's utimensat(), not gnulib's
665 # if @REPLACE_UTIMENSAT@ || (!@HAVE_UTIMENSAT@ && defined __sun)
666 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
668 # define utimensat rpl_utimensat
670 _GL_FUNCDECL_RPL (utimensat, int, (int fd, char const *name,
671 struct timespec const times[2], int flag)
672 _GL_ARG_NONNULL ((2)));
673 _GL_CXXALIAS_RPL (utimensat, int, (int fd, char const *name,
674 struct timespec const times[2], int flag));
676 # if !@HAVE_UTIMENSAT@
677 _GL_FUNCDECL_SYS (utimensat, int, (int fd, char const *name,
678 struct timespec const times[2], int flag)
679 _GL_ARG_NONNULL ((2)));
681 _GL_CXXALIAS_SYS (utimensat, int, (int fd, char const *name,
682 struct timespec const times[2], int flag));
684 # if @HAVE_UTIMENSAT@
685 _GL_CXXALIASWARN (utimensat);
687 #elif defined GNULIB_POSIXCHECK
689 # if HAVE_RAW_DECL_UTIMENSAT
690 _GL_WARN_ON_USE (utimensat, "utimensat is not portable - "
691 "use gnulib module utimensat for portability");
696 #endif /* _@GUARD_PREFIX@_SYS_STAT_H */
697 #endif /* _@GUARD_PREFIX@_SYS_STAT_H */