1 /* Provide a more complete sys/stat header file.
2 Copyright (C) 2005-2011 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 3, 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 */
67 # define S_IFIFO _S_IFIFO
72 # define S_IFMT 0170000
75 #if STAT_MACROS_BROKEN
91 # define S_ISBLK(m) (((m) & S_IFMT) == S_IFBLK)
99 # define S_ISCHR(m) (((m) & S_IFMT) == S_IFCHR)
101 # define S_ISCHR(m) 0
107 # define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
109 # define S_ISDIR(m) 0
113 #ifndef S_ISDOOR /* Solaris 2.5 and up */
114 # define S_ISDOOR(m) 0
119 # define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
121 # define S_ISFIFO(m) 0
127 # define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
129 # define S_ISLNK(m) 0
133 #ifndef S_ISMPB /* V7 */
135 # define S_ISMPB(m) (((m) & S_IFMT) == S_IFMPB)
136 # define S_ISMPC(m) (((m) & S_IFMT) == S_IFMPC)
138 # define S_ISMPB(m) 0
139 # define S_ISMPC(m) 0
143 #ifndef S_ISNAM /* Xenix */
145 # define S_ISNAM(m) (((m) & S_IFMT) == S_IFNAM)
147 # define S_ISNAM(m) 0
151 #ifndef S_ISNWK /* HP/UX */
153 # define S_ISNWK(m) (((m) & S_IFMT) == S_IFNWK)
155 # define S_ISNWK(m) 0
159 #ifndef S_ISPORT /* Solaris 10 and up */
160 # define S_ISPORT(m) 0
165 # define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
167 # define S_ISREG(m) 0
173 # define S_ISSOCK(m) (((m) & S_IFMT) == S_IFSOCK)
175 # define S_ISSOCK(m) 0
181 # define S_TYPEISMQ(p) 0
185 # define S_TYPEISTMO(p) 0
191 # define S_TYPEISSEM(p) (S_ISNAM ((p)->st_mode) && (p)->st_rdev == S_INSEM)
193 # define S_TYPEISSEM(p) 0
199 # define S_TYPEISSHM(p) (S_ISNAM ((p)->st_mode) && (p)->st_rdev == S_INSHD)
201 # define S_TYPEISSHM(p) 0
205 /* high performance ("contiguous data") */
207 # define S_ISCTG(p) 0
210 /* Cray DMF (data migration facility): off line, with data */
212 # define S_ISOFD(p) 0
215 /* Cray DMF (data migration facility): off line, with no data */
217 # define S_ISOFL(p) 0
220 /* 4.4BSD whiteout */
222 # define S_ISWHT(m) 0
225 /* If any of the following are undefined,
226 define them to their de facto standard values. */
228 # define S_ISUID 04000
231 # define S_ISGID 02000
234 /* S_ISVTX is a common extension to POSIX. */
236 # define S_ISVTX 01000
239 #if !S_IRUSR && S_IREAD
240 # define S_IRUSR S_IREAD
243 # define S_IRUSR 00400
246 # define S_IRGRP (S_IRUSR >> 3)
249 # define S_IROTH (S_IRUSR >> 6)
252 #if !S_IWUSR && S_IWRITE
253 # define S_IWUSR S_IWRITE
256 # define S_IWUSR 00200
259 # define S_IWGRP (S_IWUSR >> 3)
262 # define S_IWOTH (S_IWUSR >> 6)
265 #if !S_IXUSR && S_IEXEC
266 # define S_IXUSR S_IEXEC
269 # define S_IXUSR 00100
272 # define S_IXGRP (S_IXUSR >> 3)
275 # define S_IXOTH (S_IXUSR >> 6)
279 # define S_IRWXU (S_IRUSR | S_IWUSR | S_IXUSR)
282 # define S_IRWXG (S_IRGRP | S_IWGRP | S_IXGRP)
285 # define S_IRWXO (S_IROTH | S_IWOTH | S_IXOTH)
288 /* S_IXUGO is a common extension to POSIX. */
290 # define S_IXUGO (S_IXUSR | S_IXGRP | S_IXOTH)
294 # define S_IRWXUGO (S_IRWXU | S_IRWXG | S_IRWXO)
297 /* Macros for futimens and utimensat. */
299 # define UTIME_NOW (-1)
300 # define UTIME_OMIT (-2)
304 #if @GNULIB_FCHMODAT@
305 # if !@HAVE_FCHMODAT@
306 _GL_FUNCDECL_SYS (fchmodat
, int,
307 (int fd
, char const *file
, mode_t mode
, int flag
)
308 _GL_ARG_NONNULL ((2)));
310 _GL_CXXALIAS_SYS (fchmodat
, int,
311 (int fd
, char const *file
, mode_t mode
, int flag
));
312 _GL_CXXALIASWARN (fchmodat
);
313 #elif defined GNULIB_POSIXCHECK
315 # if HAVE_RAW_DECL_FCHMODAT
316 _GL_WARN_ON_USE (fchmodat
, "fchmodat is not portable - "
317 "use gnulib module openat for portability");
324 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
326 # define fstat rpl_fstat
328 _GL_FUNCDECL_RPL (fstat
, int, (int fd
, struct stat
*buf
) _GL_ARG_NONNULL ((2)));
329 _GL_CXXALIAS_RPL (fstat
, int, (int fd
, struct stat
*buf
));
331 _GL_CXXALIAS_SYS (fstat
, int, (int fd
, struct stat
*buf
));
333 _GL_CXXALIASWARN (fstat
);
334 #elif defined GNULIB_POSIXCHECK
336 # if HAVE_RAW_DECL_FSTAT
337 _GL_WARN_ON_USE (fstat
, "fstat has portability problems - "
338 "use gnulib module fstat for portability");
344 # if @REPLACE_FSTATAT@
345 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
347 # define fstatat rpl_fstatat
349 _GL_FUNCDECL_RPL (fstatat
, int,
350 (int fd
, char const *name
, struct stat
*st
, int flags
)
351 _GL_ARG_NONNULL ((2, 3)));
352 _GL_CXXALIAS_RPL (fstatat
, int,
353 (int fd
, char const *name
, struct stat
*st
, int flags
));
356 _GL_FUNCDECL_SYS (fstatat
, int,
357 (int fd
, char const *name
, struct stat
*st
, int flags
)
358 _GL_ARG_NONNULL ((2, 3)));
360 _GL_CXXALIAS_SYS (fstatat
, int,
361 (int fd
, char const *name
, struct stat
*st
, int flags
));
363 _GL_CXXALIASWARN (fstatat
);
364 #elif defined GNULIB_POSIXCHECK
366 # if HAVE_RAW_DECL_FSTATAT
367 _GL_WARN_ON_USE (fstatat
, "fstatat is not portable - "
368 "use gnulib module openat for portability");
373 #if @GNULIB_FUTIMENS@
374 /* Use the rpl_ prefix also on Solaris <= 9, because on Solaris 9 our futimens
375 implementation relies on futimesat, which on Solaris 10 makes an invocation
376 to futimens that is meant to invoke the libc's futimens(), not gnulib's
378 # if @REPLACE_FUTIMENS@ || (!@HAVE_FUTIMENS@ && defined __sun)
379 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
381 # define futimens rpl_futimens
383 _GL_FUNCDECL_RPL (futimens
, int, (int fd
, struct timespec
const times
[2]));
384 _GL_CXXALIAS_RPL (futimens
, int, (int fd
, struct timespec
const times
[2]));
386 # if !@HAVE_FUTIMENS@
387 _GL_FUNCDECL_SYS (futimens
, int, (int fd
, struct timespec
const times
[2]));
389 _GL_CXXALIAS_SYS (futimens
, int, (int fd
, struct timespec
const times
[2]));
392 _GL_CXXALIASWARN (futimens
);
394 #elif defined GNULIB_POSIXCHECK
396 # if HAVE_RAW_DECL_FUTIMENS
397 _GL_WARN_ON_USE (futimens
, "futimens is not portable - "
398 "use gnulib module futimens for portability");
404 /* Change the mode of FILENAME to MODE, without dereferencing it if FILENAME
405 denotes a symbolic link. */
407 /* The lchmod replacement follows symbolic links. Callers should take
408 this into account; lchmod should be applied only to arguments that
409 are known to not be symbolic links. On hosts that lack lchmod,
410 this can lead to race conditions between the check and the
411 invocation of lchmod, but we know of no workarounds that are
412 reliable in general. You might try requesting support for lchmod
413 from your operating system supplier. */
414 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
415 # define lchmod chmod
417 /* Need to cast, because on mingw, the second parameter of chmod is
419 _GL_CXXALIAS_RPL_CAST_1 (lchmod
, chmod
, int,
420 (const char *filename
, mode_t mode
));
422 # if 0 /* assume already declared */
423 _GL_FUNCDECL_SYS (lchmod
, int, (const char *filename
, mode_t mode
)
424 _GL_ARG_NONNULL ((1)));
426 _GL_CXXALIAS_SYS (lchmod
, int, (const char *filename
, mode_t mode
));
429 _GL_CXXALIASWARN (lchmod
);
431 #elif defined GNULIB_POSIXCHECK
433 # if HAVE_RAW_DECL_LCHMOD
434 _GL_WARN_ON_USE (lchmod
, "lchmod is unportable - "
435 "use gnulib module lchmod for portability");
442 /* mingw does not support symlinks, therefore it does not have lstat. But
443 without links, stat does just fine. */
444 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
447 _GL_CXXALIAS_RPL_1 (lstat
, stat
, int, (const char *name
, struct stat
*buf
));
448 # elif @REPLACE_LSTAT@
449 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
451 # define lstat rpl_lstat
453 _GL_FUNCDECL_RPL (lstat
, int, (const char *name
, struct stat
*buf
)
454 _GL_ARG_NONNULL ((1, 2)));
455 _GL_CXXALIAS_RPL (lstat
, int, (const char *name
, struct stat
*buf
));
457 _GL_CXXALIAS_SYS (lstat
, int, (const char *name
, struct stat
*buf
));
460 _GL_CXXALIASWARN (lstat
);
462 #elif defined GNULIB_POSIXCHECK
464 # if HAVE_RAW_DECL_LSTAT
465 _GL_WARN_ON_USE (lstat
, "lstat is unportable - "
466 "use gnulib module lstat for portability");
472 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
474 # define mkdir rpl_mkdir
476 _GL_FUNCDECL_RPL (mkdir
, int, (char const *name
, mode_t mode
)
477 _GL_ARG_NONNULL ((1)));
478 _GL_CXXALIAS_RPL (mkdir
, int, (char const *name
, mode_t mode
));
480 /* mingw's _mkdir() function has 1 argument, but we pass 2 arguments.
481 Additionally, it declares _mkdir (and depending on compile flags, an
482 alias mkdir), only in the nonstandard includes <direct.h> and <io.h>,
483 which are included above. */
484 # if (defined _WIN32 || defined __WIN32__) && ! defined __CYGWIN__
486 # if !GNULIB_defined_rpl_mkdir
488 rpl_mkdir (char const *name
, mode_t mode
)
490 return _mkdir (name
);
492 # define GNULIB_defined_rpl_mkdir 1
495 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
496 # define mkdir rpl_mkdir
498 _GL_CXXALIAS_RPL (mkdir
, int, (char const *name
, mode_t mode
));
500 _GL_CXXALIAS_SYS (mkdir
, int, (char const *name
, mode_t mode
));
503 _GL_CXXALIASWARN (mkdir
);
508 _GL_FUNCDECL_SYS (mkdirat
, int, (int fd
, char const *file
, mode_t mode
)
509 _GL_ARG_NONNULL ((2)));
511 _GL_CXXALIAS_SYS (mkdirat
, int, (int fd
, char const *file
, mode_t mode
));
512 _GL_CXXALIASWARN (mkdirat
);
513 #elif defined GNULIB_POSIXCHECK
515 # if HAVE_RAW_DECL_MKDIRAT
516 _GL_WARN_ON_USE (mkdirat
, "mkdirat is not portable - "
517 "use gnulib module openat for portability");
523 # if @REPLACE_MKFIFO@
524 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
526 # define mkfifo rpl_mkfifo
528 _GL_FUNCDECL_RPL (mkfifo
, int, (char const *file
, mode_t mode
)
529 _GL_ARG_NONNULL ((1)));
530 _GL_CXXALIAS_RPL (mkfifo
, int, (char const *file
, mode_t mode
));
533 _GL_FUNCDECL_SYS (mkfifo
, int, (char const *file
, mode_t mode
)
534 _GL_ARG_NONNULL ((1)));
536 _GL_CXXALIAS_SYS (mkfifo
, int, (char const *file
, mode_t mode
));
538 _GL_CXXALIASWARN (mkfifo
);
539 #elif defined GNULIB_POSIXCHECK
541 # if HAVE_RAW_DECL_MKFIFO
542 _GL_WARN_ON_USE (mkfifo
, "mkfifo is not portable - "
543 "use gnulib module mkfifo for portability");
548 #if @GNULIB_MKFIFOAT@
549 # if !@HAVE_MKFIFOAT@
550 _GL_FUNCDECL_SYS (mkfifoat
, int, (int fd
, char const *file
, mode_t mode
)
551 _GL_ARG_NONNULL ((2)));
553 _GL_CXXALIAS_SYS (mkfifoat
, int, (int fd
, char const *file
, mode_t mode
));
554 _GL_CXXALIASWARN (mkfifoat
);
555 #elif defined GNULIB_POSIXCHECK
557 # if HAVE_RAW_DECL_MKFIFOAT
558 _GL_WARN_ON_USE (mkfifoat
, "mkfifoat is not portable - "
559 "use gnulib module mkfifoat for portability");
566 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
568 # define mknod rpl_mknod
570 _GL_FUNCDECL_RPL (mknod
, int, (char const *file
, mode_t mode
, dev_t dev
)
571 _GL_ARG_NONNULL ((1)));
572 _GL_CXXALIAS_RPL (mknod
, int, (char const *file
, mode_t mode
, dev_t dev
));
575 _GL_FUNCDECL_SYS (mknod
, int, (char const *file
, mode_t mode
, dev_t dev
)
576 _GL_ARG_NONNULL ((1)));
578 /* Need to cast, because on OSF/1 5.1, the third parameter is '...'. */
579 _GL_CXXALIAS_SYS_CAST (mknod
, int, (char const *file
, mode_t mode
, dev_t dev
));
581 _GL_CXXALIASWARN (mknod
);
582 #elif defined GNULIB_POSIXCHECK
584 # if HAVE_RAW_DECL_MKNOD
585 _GL_WARN_ON_USE (mknod
, "mknod is not portable - "
586 "use gnulib module mknod for portability");
593 _GL_FUNCDECL_SYS (mknodat
, int,
594 (int fd
, char const *file
, mode_t mode
, dev_t dev
)
595 _GL_ARG_NONNULL ((2)));
597 _GL_CXXALIAS_SYS (mknodat
, int,
598 (int fd
, char const *file
, mode_t mode
, dev_t dev
));
599 _GL_CXXALIASWARN (mknodat
);
600 #elif defined GNULIB_POSIXCHECK
602 # if HAVE_RAW_DECL_MKNODAT
603 _GL_WARN_ON_USE (mknodat
, "mknodat is not portable - "
604 "use gnulib module mkfifoat for portability");
611 /* We can't use the object-like #define stat rpl_stat, because of
612 struct stat. This means that rpl_stat will not be used if the user
613 does (stat)(a,b). Oh well. */
616 /* With _LARGE_FILES defined, AIX (only) defines stat to stat64,
617 so we have to replace stat64() instead of stat(). */
620 # define stat64(name, st) rpl_stat (name, st)
621 # else /* !_LARGE_FILES */
622 # define stat(name, st) rpl_stat (name, st)
623 # endif /* !_LARGE_FILES */
624 _GL_EXTERN_C
int stat (const char *name
, struct stat
*buf
)
625 _GL_ARG_NONNULL ((1, 2));
627 #elif defined GNULIB_POSIXCHECK
629 # if HAVE_RAW_DECL_STAT
630 _GL_WARN_ON_USE (stat
, "stat is unportable - "
631 "use gnulib module stat for portability");
636 #if @GNULIB_UTIMENSAT@
637 /* Use the rpl_ prefix also on Solaris <= 9, because on Solaris 9 our utimensat
638 implementation relies on futimesat, which on Solaris 10 makes an invocation
639 to utimensat that is meant to invoke the libc's utimensat(), not gnulib's
641 # if @REPLACE_UTIMENSAT@ || (!@HAVE_UTIMENSAT@ && defined __sun)
642 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
644 # define utimensat rpl_utimensat
646 _GL_FUNCDECL_RPL (utimensat
, int, (int fd
, char const *name
,
647 struct timespec
const times
[2], int flag
)
648 _GL_ARG_NONNULL ((2)));
649 _GL_CXXALIAS_RPL (utimensat
, int, (int fd
, char const *name
,
650 struct timespec
const times
[2], int flag
));
652 # if !@HAVE_UTIMENSAT@
653 _GL_FUNCDECL_SYS (utimensat
, int, (int fd
, char const *name
,
654 struct timespec
const times
[2], int flag
)
655 _GL_ARG_NONNULL ((2)));
657 _GL_CXXALIAS_SYS (utimensat
, int, (int fd
, char const *name
,
658 struct timespec
const times
[2], int flag
));
660 # if @HAVE_UTIMENSAT@
661 _GL_CXXALIASWARN (utimensat
);
663 #elif defined GNULIB_POSIXCHECK
665 # if HAVE_RAW_DECL_UTIMENSAT
666 _GL_WARN_ON_USE (utimensat
, "utimensat is not portable - "
667 "use gnulib module utimensat for portability");
672 #endif /* _@GUARD_PREFIX@_SYS_STAT_H */
673 #endif /* _@GUARD_PREFIX@_SYS_STAT_H */