1 /* system-dependent definitions for coreutils
2 Copyright (C) 1989, 1991-2006 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. */
20 /* Include sys/types.h before this file. */
22 #if 2 <= __GLIBC__ && 2 <= __GLIBC_MINOR__
23 # if ! defined _SYS_TYPES_H
24 you must include <sys/types.h> before including this file
30 #if !defined HAVE_MKFIFO
31 # define mkfifo(name, mode) mknod (name, (mode) | S_IFIFO, 0)
35 # include <sys/param.h>
41 # define STDIN_FILENO 0
45 # define STDOUT_FILENO 1
49 # define STDERR_FILENO 2
53 /* limits.h must come before pathmax.h because limits.h on some systems
54 undefs PATH_MAX, whereas pathmax.h sets PATH_MAX. */
58 #include "localedir.h"
60 #if TIME_WITH_SYS_TIME
61 # include <sys/time.h>
65 # include <sys/time.h>
71 /* Since major is a function on SVR4, we can't use `ifndef major'. */
73 # include <sys/mkdev.h>
76 #if MAJOR_IN_SYSMACROS
77 # include <sys/sysmacros.h>
80 #ifdef major /* Might be defined in sys/types.h. */
85 # define major(dev) (((dev) >> 8) & 0xff)
86 # define minor(dev) ((dev) & 0xff)
87 # define makedev(maj, min) (((maj) << 8) | (min))
91 #if ! defined makedev && defined mkdev
92 # define makedev(maj, min) mkdev (maj, min)
95 /* Don't use bcopy! Use memmove if source and destination may overlap,
103 /* Some systems don't define the following symbols. */
114 /* The following test is to work around the gross typo in
115 systems like Sony NEWS-OS Release 4.0C, whereby EXIT_FAILURE
116 is defined to 0, not 1. */
119 # define EXIT_FAILURE 1
123 # define EXIT_SUCCESS 0
126 /* Exit statuses for programs like 'env' that exec other programs.
127 EXIT_FAILURE might not be 1, so use EXIT_FAIL in such programs. */
131 EXIT_CANNOT_INVOKE = 126,
135 #include "exitfail.h"
137 /* Set exit_failure to STATUS if that's not the default already. */
139 initialize_exit_failure (int status)
141 if (status != EXIT_FAILURE)
142 exit_failure = status;
147 #if !defined SEEK_SET
159 #if !defined O_DIRECT && defined O_DIRECTIO
160 /* Tru64 spells it `O_DIRECTIO'. */
161 # define O_DIRECT O_DIRECTIO
164 #if !defined O_DIRECT
168 #if !defined O_DIRECTORY
169 # define O_DIRECTORY 0
176 #if !defined O_NDELAY
180 #if !defined O_NOATIME
184 #if !defined O_NONBLOCK
185 # define O_NONBLOCK O_NDELAY
188 #if !defined O_NOCTTY
192 #if !defined O_NOFOLLOW
193 # define O_NOFOLLOW 0
196 #if !defined O_NOLINKS
208 /* For systems that distinguish between text and binary I/O.
209 O_BINARY is usually declared in fcntl.h */
210 #if !defined O_BINARY && defined _O_BINARY
211 /* For MSC-compatible compilers. */
212 # define O_BINARY _O_BINARY
213 # define O_TEXT _O_TEXT
217 /* BeOS 5 has O_BINARY and O_TEXT, but they have no effect. */
229 # define NLENGTH(direct) (strlen((direct)->d_name))
230 #else /* not HAVE_DIRENT_H */
231 # define dirent direct
232 # define NLENGTH(direct) ((direct)->d_namlen)
234 # include <sys/ndir.h>
235 # endif /* HAVE_SYS_NDIR_H */
237 # include <sys/dir.h>
238 # endif /* HAVE_SYS_DIR_H */
241 # endif /* HAVE_NDIR_H */
242 #endif /* HAVE_DIRENT_H */
246 NOT_AN_INODE_NUMBER = 0
249 #ifdef D_INO_IN_DIRENT
250 # define D_INO(dp) ((dp)->d_ino)
252 /* Some systems don't have inodes, so fake them to avoid lots of ifdefs. */
253 # define D_INO(dp) NOT_AN_INODE_NUMBER
256 /* Get or fake the disk device blocksize.
257 Usually defined by sys/param.h (if at all). */
258 #if !defined DEV_BSIZE && defined BSIZE
259 # define DEV_BSIZE BSIZE
261 #if !defined DEV_BSIZE && defined BBSIZE /* SGI */
262 # define DEV_BSIZE BBSIZE
265 # define DEV_BSIZE 4096
268 /* Extract or fake data from a `struct stat'.
269 ST_BLKSIZE: Preferred I/O blocksize for the file, in bytes.
270 ST_NBLOCKS: Number of blocks in the file, including indirect blocks.
271 ST_NBLOCKSIZE: Size of blocks used when calculating ST_NBLOCKS. */
272 #ifndef HAVE_STRUCT_STAT_ST_BLOCKS
273 # define ST_BLKSIZE(statbuf) DEV_BSIZE
274 # if defined _POSIX_SOURCE || !defined BSIZE /* fileblocks.c uses BSIZE. */
275 # define ST_NBLOCKS(statbuf) \
276 ((statbuf).st_size / ST_NBLOCKSIZE + ((statbuf).st_size % ST_NBLOCKSIZE != 0))
277 # else /* !_POSIX_SOURCE && BSIZE */
278 # define ST_NBLOCKS(statbuf) \
279 (S_ISREG ((statbuf).st_mode) \
280 || S_ISDIR ((statbuf).st_mode) \
281 ? st_blocks ((statbuf).st_size) : 0)
282 # endif /* !_POSIX_SOURCE && BSIZE */
283 #else /* HAVE_STRUCT_STAT_ST_BLOCKS */
284 /* Some systems, like Sequents, return st_blksize of 0 on pipes.
285 Also, when running `rsh hpux11-system cat any-file', cat would
286 determine that the output stream had an st_blksize of 2147421096.
287 So here we arbitrarily limit the `optimal' block size to 4MB.
288 If anyone knows of a system for which the legitimate value for
289 st_blksize can exceed 4MB, please report it as a bug in this code. */
290 # define ST_BLKSIZE(statbuf) ((0 < (statbuf).st_blksize \
291 && (statbuf).st_blksize <= (1 << 22)) /* 4MB */ \
292 ? (statbuf).st_blksize : DEV_BSIZE)
293 # if defined hpux || defined __hpux__ || defined __hpux
294 /* HP-UX counts st_blocks in 1024-byte units.
295 This loses when mixing HP-UX and BSD file systems with NFS. */
296 # define ST_NBLOCKSIZE 1024
298 # if defined _AIX && defined _I386
299 /* AIX PS/2 counts st_blocks in 4K units. */
300 # define ST_NBLOCKSIZE (4 * 1024)
301 # else /* not AIX PS/2 */
303 # define ST_NBLOCKS(statbuf) \
304 (S_ISREG ((statbuf).st_mode) \
305 || S_ISDIR ((statbuf).st_mode) \
306 ? (statbuf).st_blocks * ST_BLKSIZE(statbuf)/ST_NBLOCKSIZE : 0)
308 # endif /* not AIX PS/2 */
310 #endif /* HAVE_STRUCT_STAT_ST_BLOCKS */
313 # define ST_NBLOCKS(statbuf) ((statbuf).st_blocks)
316 #ifndef ST_NBLOCKSIZE
318 # define ST_NBLOCKSIZE S_BLKSIZE
320 # define ST_NBLOCKSIZE 512
324 /* Redirection and wildcarding when done by the utility itself.
325 Generally a noop, but used in particular for native VMS. */
326 #ifndef initialize_main
327 # define initialize_main(ac, av)
330 #include "stat-macros.h"
332 #include "timespec.h"
335 # include <inttypes.h>
339 #if ULONG_MAX_LT_ULLONG_MAX
340 # define LONGEST_MODIFIER "ll"
342 # define LONGEST_MODIFIER "l"
344 #if PRI_MACROS_BROKEN
351 # define PRIdMAX LONGEST_MODIFIER "d"
354 # define PRIoMAX LONGEST_MODIFIER "o"
357 # define PRIuMAX LONGEST_MODIFIER "u"
360 # define PRIxMAX LONGEST_MODIFIER "x"
365 /* Jim Meyering writes:
367 "... Some ctype macros are valid only for character codes that
368 isascii says are ASCII (SGI's IRIX-4.0.5 is one such system --when
369 using /bin/cc or gcc but without giving an ansi option). So, all
370 ctype uses should be through macros like ISPRINT... If
371 STDC_HEADERS is defined, then autoconf has verified that the ctype
372 macros don't need to be guarded with references to isascii. ...
373 Defining isascii to 1 should let any compiler worth its salt
374 eliminate the && through constant folding."
378 "... Furthermore, isupper(c) etc. have an undefined result if c is
379 outside the range -1 <= c <= 255. One is tempted to write isupper(c)
380 with c being of type `char', but this is wrong if c is an 8-bit
381 character >= 128 which gets sign-extended to a negative value.
382 The macro ISUPPER protects against this as well." */
384 #if STDC_HEADERS || (!defined isascii && !HAVE_ISASCII)
385 # define IN_CTYPE_DOMAIN(c) 1
387 # define IN_CTYPE_DOMAIN(c) isascii(c)
391 # define ISBLANK(c) (IN_CTYPE_DOMAIN (c) && isblank (c))
393 # define ISBLANK(c) ((c) == ' ' || (c) == '\t')
396 # define ISGRAPH(c) (IN_CTYPE_DOMAIN (c) && isgraph (c))
398 # define ISGRAPH(c) (IN_CTYPE_DOMAIN (c) && isprint (c) && !isspace (c))
401 /* This is defined in <sys/euc.h> on at least Solaris2.6 systems. */
404 #define ISPRINT(c) (IN_CTYPE_DOMAIN (c) && isprint (c))
405 #define ISALNUM(c) (IN_CTYPE_DOMAIN (c) && isalnum (c))
406 #define ISALPHA(c) (IN_CTYPE_DOMAIN (c) && isalpha (c))
407 #define ISCNTRL(c) (IN_CTYPE_DOMAIN (c) && iscntrl (c))
408 #define ISLOWER(c) (IN_CTYPE_DOMAIN (c) && islower (c))
409 #define ISPUNCT(c) (IN_CTYPE_DOMAIN (c) && ispunct (c))
410 #define ISSPACE(c) (IN_CTYPE_DOMAIN (c) && isspace (c))
411 #define ISUPPER(c) (IN_CTYPE_DOMAIN (c) && isupper (c))
412 #define ISXDIGIT(c) (IN_CTYPE_DOMAIN (c) && isxdigit (c))
413 #define ISDIGIT_LOCALE(c) (IN_CTYPE_DOMAIN (c) && isdigit (c))
416 # define TOLOWER(Ch) tolower (Ch)
417 # define TOUPPER(Ch) toupper (Ch)
419 # define TOLOWER(Ch) (ISUPPER (Ch) ? tolower (Ch) : (Ch))
420 # define TOUPPER(Ch) (ISLOWER (Ch) ? toupper (Ch) : (Ch))
423 /* ISDIGIT differs from ISDIGIT_LOCALE, as follows:
424 - Its arg may be any int or unsigned int; it need not be an unsigned char.
425 - It's guaranteed to evaluate its argument exactly once.
426 - It's typically faster.
427 POSIX says that only '0' through '9' are digits. Prefer ISDIGIT to
428 ISDIGIT_LOCALE unless it's important to use the locale's definition
429 of `digit' even when the host does not conform to POSIX. */
430 #define ISDIGIT(c) ((unsigned int) (c) - '0' <= 9)
432 /* Convert a possibly-signed character to an unsigned character. This is
433 a bit safer than casting to unsigned char, since it catches some type
434 errors that the cast doesn't. */
435 static inline unsigned char to_uchar (char ch) { return ch; }
439 /* Take care of NLS matters. */
444 # define textdomain(Domainname) /* empty */
445 # undef bindtextdomain
446 # define bindtextdomain(Domainname, Dirname) /* empty */
449 #define _(msgid) gettext (msgid)
450 #define N_(msgid) msgid
452 #define STREQ(a, b) (strcmp ((a), (b)) == 0)
458 #if !HAVE_DECL_MALLOC
462 #if !HAVE_DECL_MEMCHR
466 #if !HAVE_DECL_REALLOC
470 #if !HAVE_DECL_STPCPY
476 #if !HAVE_DECL_STRNDUP
480 #if !HAVE_DECL_STRSTR
484 #if !HAVE_DECL_GETENV
492 /* This is needed on some AIX systems. */
493 #if !HAVE_DECL_STRTOUL
494 unsigned long strtoul ();
497 #if !HAVE_DECL_GETLOGIN
501 #if !HAVE_DECL_TTYNAME
505 #if !HAVE_DECL_GETEUID
509 #if !HAVE_DECL_GETPWUID
510 struct passwd *getpwuid ();
513 #if !HAVE_DECL_GETGRGID
514 struct group *getgrgid ();
517 #if !HAVE_DECL_GETUID
524 /* This is simply a shorthand for the common case in which
525 the third argument to x2nrealloc would be `sizeof *(P)'.
526 Ensure that sizeof *(P) is *not* 1. In that case, it'd be
527 better to use X2REALLOC, although not strictly necessary. */
528 #define X2NREALLOC(P, PN) ((void) verify_true (sizeof *(P) != 1), \
529 x2nrealloc (P, PN, sizeof *(P)))
531 /* Using x2realloc (when appropriate) usually makes your code more
532 readable than using x2nrealloc, but it also makes it so your
533 code will malfunction if sizeof *(P) ever becomes 2 or greater.
534 So use this macro instead of using x2realloc directly. */
535 #define X2REALLOC(P, PN) ((void) verify_true (sizeof *(P) == 1), \
538 #if ! defined HAVE_MEMPCPY && ! defined mempcpy
539 /* Be CAREFUL that there are no side effects in N. */
540 # define mempcpy(D, S, N) ((void *) ((char *) memcpy (D, S, N) + (N)))
543 /* Include automatically-generated macros for unlocked I/O. */
544 #include "unlocked-io.h"
545 #include "same-inode.h"
547 #define DOT_OR_DOTDOT(Basename) \
548 (Basename[0] == '.' && (Basename[1] == '\0' \
549 || (Basename[1] == '.' && Basename[2] == '\0')))
551 /* A wrapper for readdir so that callers don't see entries for `.' or `..'. */
552 static inline struct dirent const *
553 readdir_ignoring_dot_and_dotdot (DIR *dirp)
557 struct dirent const *dp = readdir (dirp);
558 if (dp == NULL || ! DOT_OR_DOTDOT (dp->d_name))
564 # define SETVBUF(Stream, Buffer, Type, Size) \
565 setvbuf (Stream, Type, Buffer, Size)
567 # define SETVBUF(Stream, Buffer, Type, Size) \
568 setvbuf (Stream, Buffer, Type, Size)
571 /* Factor out some of the common --help and --version processing code. */
573 /* These enum values cannot possibly conflict with the option values
574 ordinarily used by commands, including CHAR_MAX + 1, etc. Avoid
575 CHAR_MIN - 1, as it may equal -1, the getopt end-of-options value. */
578 GETOPT_HELP_CHAR = (CHAR_MIN - 2),
579 GETOPT_VERSION_CHAR = (CHAR_MIN - 3)
582 #define GETOPT_HELP_OPTION_DECL \
583 "help", no_argument, NULL, GETOPT_HELP_CHAR
584 #define GETOPT_VERSION_OPTION_DECL \
585 "version", no_argument, NULL, GETOPT_VERSION_CHAR
587 #define case_GETOPT_HELP_CHAR \
588 case GETOPT_HELP_CHAR: \
589 usage (EXIT_SUCCESS); \
592 /* Program_name must be a literal string.
593 Usually it is just PROGRAM_NAME. */
594 #define USAGE_BUILTIN_WARNING \
596 "NOTE: your shell may have its own version of %s, which usually supersedes\n" \
597 "the version described here. Please refer to your shell's documentation\n" \
598 "for details about the options it supports.\n")
600 #define HELP_OPTION_DESCRIPTION \
601 _(" --help display this help and exit\n")
602 #define VERSION_OPTION_DESCRIPTION \
603 _(" --version output version information and exit\n")
605 #include "closeout.h"
606 #include "version-etc.h"
608 #define case_GETOPT_VERSION_CHAR(Program_name, Authors) \
609 case GETOPT_VERSION_CHAR: \
610 version_etc (stdout, Program_name, GNU_PACKAGE, VERSION, Authors, \
612 exit (EXIT_SUCCESS); \
616 # define MAX(a, b) ((a) > (b) ? (a) : (b))
620 # define MIN(a,b) (((a) < (b)) ? (a) : (b))
623 #include "intprops.h"
626 # define CHAR_MIN TYPE_MINIMUM (char)
630 # define CHAR_MAX TYPE_MAXIMUM (char)
634 # define SCHAR_MIN (-1 - SCHAR_MAX)
638 # define SCHAR_MAX (CHAR_MAX == UCHAR_MAX ? CHAR_MAX / 2 : CHAR_MAX)
642 # define UCHAR_MAX TYPE_MAXIMUM (unsigned char)
646 # define SHRT_MIN TYPE_MINIMUM (short int)
650 # define SHRT_MAX TYPE_MAXIMUM (short int)
654 # define INT_MAX TYPE_MAXIMUM (int)
658 # define INT_MIN TYPE_MINIMUM (int)
662 # define INTMAX_MAX TYPE_MAXIMUM (intmax_t)
666 # define INTMAX_MIN TYPE_MINIMUM (intmax_t)
670 # define UINT_MAX TYPE_MAXIMUM (unsigned int)
674 # define LONG_MAX TYPE_MAXIMUM (long int)
678 # define ULONG_MAX TYPE_MAXIMUM (unsigned long int)
682 # define SIZE_MAX TYPE_MAXIMUM (size_t)
686 # define SSIZE_MAX TYPE_MAXIMUM (ssize_t)
690 # define UINTMAX_MAX TYPE_MAXIMUM (uintmax_t)
694 # define OFF_T_MIN TYPE_MINIMUM (off_t)
698 # define OFF_T_MAX TYPE_MAXIMUM (off_t)
702 # define UID_T_MAX TYPE_MAXIMUM (uid_t)
706 # define GID_T_MAX TYPE_MAXIMUM (gid_t)
710 # define PID_T_MAX TYPE_MAXIMUM (pid_t)
713 /* Use this to suppress gcc's `...may be used before initialized' warnings. */
715 # define IF_LINT(Code) Code
717 # define IF_LINT(Code) /* empty */
720 #ifndef __attribute__
721 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 8) || __STRICT_ANSI__
722 # define __attribute__(x) /* empty */
726 #ifndef ATTRIBUTE_NORETURN
727 # define ATTRIBUTE_NORETURN __attribute__ ((__noreturn__))
730 #ifndef ATTRIBUTE_UNUSED
731 # define ATTRIBUTE_UNUSED __attribute__ ((__unused__))
735 # define ASSIGN_STRDUPA(DEST, S) \
736 do { DEST = strdupa (S); } while (0)
738 # define ASSIGN_STRDUPA(DEST, S) \
741 const char *s_ = (S); \
742 size_t len_ = strlen (s_) + 1; \
743 char *tmp_dest_ = alloca (len_); \
744 DEST = memcpy (tmp_dest_, (s_), len_); \
750 # define EOVERFLOW EINVAL
753 #if ! HAVE_FSEEKO && ! defined fseeko
754 # define fseeko(s, o, w) ((o) == (long int) (o) \
756 : (errno = EOVERFLOW, -1))
760 # define sync() /* empty */
763 /* Compute the greatest common divisor of U and V using Euclid's
764 algorithm. U and V must be nonzero. */
767 gcd (size_t u, size_t v)
780 /* Compute the least common multiple of U and V. U and V must be
781 nonzero. There is no overflow checking, so callers should not
782 specify outlandish sizes. */
785 lcm (size_t u, size_t v)
787 return u * (v / gcd (u, v));
790 /* Return PTR, aligned upward to the next multiple of ALIGNMENT.
791 ALIGNMENT must be nonzero. The caller must arrange for ((char *)
792 PTR) through ((char *) PTR + ALIGNMENT - 1) to be addressable
796 ptr_align (void const *ptr, size_t alignment)
798 char const *p0 = ptr;
799 char const *p1 = p0 + alignment - 1;
800 return (void *) (p1 - (size_t) p1 % alignment);
803 /* If 10*Accum + Digit_val is larger than the maximum value for Type,
804 then don't update Accum and return false to indicate it would
805 overflow. Otherwise, set Accum to that new value and return true.
806 Verify at compile-time that Type is Accum's type, and that Type is
807 unsigned. Accum must be an object, so that we can take its
808 address. Accum and Digit_val may be evaluated multiple times.
810 The "Added check" below is not strictly required, but it causes GCC
811 to return a nonzero exit status instead of merely a warning
812 diagnostic, and that is more useful. */
814 #define DECIMAL_DIGIT_ACCUMULATE(Accum, Digit_val, Type) \
816 (void) (&(Accum) == (Type *) NULL), /* The type matches. */ \
817 (void) verify_true (! TYPE_SIGNED (Type)), /* The type is unsigned. */ \
818 (void) verify_true (sizeof (Accum) == sizeof (Type)), /* Added check. */ \
819 (((Type) -1 / 10 < (Accum) \
820 || (Type) ((Accum) * 10 + (Digit_val)) < (Accum)) \
821 ? false : (((Accum) = (Accum) * 10 + (Digit_val)), true)) \