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
163 #if !defined O_DIRECTORY
164 # define O_DIRECTORY 0
171 #if !defined O_NDELAY
175 #if !defined O_NOATIME
179 #if !defined O_NONBLOCK
180 # define O_NONBLOCK O_NDELAY
183 #if !defined O_NOCTTY
187 #if !defined O_NOFOLLOW
188 # define O_NOFOLLOW 0
199 /* For systems that distinguish between text and binary I/O.
200 O_BINARY is usually declared in fcntl.h */
201 #if !defined O_BINARY && defined _O_BINARY
202 /* For MSC-compatible compilers. */
203 # define O_BINARY _O_BINARY
204 # define O_TEXT _O_TEXT
208 /* BeOS 5 has O_BINARY and O_TEXT, but they have no effect. */
220 # define NLENGTH(direct) (strlen((direct)->d_name))
221 #else /* not HAVE_DIRENT_H */
222 # define dirent direct
223 # define NLENGTH(direct) ((direct)->d_namlen)
225 # include <sys/ndir.h>
226 # endif /* HAVE_SYS_NDIR_H */
228 # include <sys/dir.h>
229 # endif /* HAVE_SYS_DIR_H */
232 # endif /* HAVE_NDIR_H */
233 #endif /* HAVE_DIRENT_H */
236 /* Fake a return value. */
237 # define CLOSEDIR(d) (closedir (d), 0)
239 # define CLOSEDIR(d) closedir (d)
242 /* Get or fake the disk device blocksize.
243 Usually defined by sys/param.h (if at all). */
244 #if !defined DEV_BSIZE && defined BSIZE
245 # define DEV_BSIZE BSIZE
247 #if !defined DEV_BSIZE && defined BBSIZE /* SGI */
248 # define DEV_BSIZE BBSIZE
251 # define DEV_BSIZE 4096
254 /* Extract or fake data from a `struct stat'.
255 ST_BLKSIZE: Preferred I/O blocksize for the file, in bytes.
256 ST_NBLOCKS: Number of blocks in the file, including indirect blocks.
257 ST_NBLOCKSIZE: Size of blocks used when calculating ST_NBLOCKS. */
258 #ifndef HAVE_STRUCT_STAT_ST_BLOCKS
259 # define ST_BLKSIZE(statbuf) DEV_BSIZE
260 # if defined _POSIX_SOURCE || !defined BSIZE /* fileblocks.c uses BSIZE. */
261 # define ST_NBLOCKS(statbuf) \
262 ((statbuf).st_size / ST_NBLOCKSIZE + ((statbuf).st_size % ST_NBLOCKSIZE != 0))
263 # else /* !_POSIX_SOURCE && BSIZE */
264 # define ST_NBLOCKS(statbuf) \
265 (S_ISREG ((statbuf).st_mode) \
266 || S_ISDIR ((statbuf).st_mode) \
267 ? st_blocks ((statbuf).st_size) : 0)
268 # endif /* !_POSIX_SOURCE && BSIZE */
269 #else /* HAVE_STRUCT_STAT_ST_BLOCKS */
270 /* Some systems, like Sequents, return st_blksize of 0 on pipes.
271 Also, when running `rsh hpux11-system cat any-file', cat would
272 determine that the output stream had an st_blksize of 2147421096.
273 So here we arbitrarily limit the `optimal' block size to 4MB.
274 If anyone knows of a system for which the legitimate value for
275 st_blksize can exceed 4MB, please report it as a bug in this code. */
276 # define ST_BLKSIZE(statbuf) ((0 < (statbuf).st_blksize \
277 && (statbuf).st_blksize <= (1 << 22)) /* 4MB */ \
278 ? (statbuf).st_blksize : DEV_BSIZE)
279 # if defined hpux || defined __hpux__ || defined __hpux
280 /* HP-UX counts st_blocks in 1024-byte units.
281 This loses when mixing HP-UX and BSD file systems with NFS. */
282 # define ST_NBLOCKSIZE 1024
284 # if defined _AIX && defined _I386
285 /* AIX PS/2 counts st_blocks in 4K units. */
286 # define ST_NBLOCKSIZE (4 * 1024)
287 # else /* not AIX PS/2 */
289 # define ST_NBLOCKS(statbuf) \
290 (S_ISREG ((statbuf).st_mode) \
291 || S_ISDIR ((statbuf).st_mode) \
292 ? (statbuf).st_blocks * ST_BLKSIZE(statbuf)/ST_NBLOCKSIZE : 0)
294 # endif /* not AIX PS/2 */
296 #endif /* HAVE_STRUCT_STAT_ST_BLOCKS */
299 # define ST_NBLOCKS(statbuf) ((statbuf).st_blocks)
302 #ifndef ST_NBLOCKSIZE
304 # define ST_NBLOCKSIZE S_BLKSIZE
306 # define ST_NBLOCKSIZE 512
310 /* Redirection and wildcarding when done by the utility itself.
311 Generally a noop, but used in particular for native VMS. */
312 #ifndef initialize_main
313 # define initialize_main(ac, av)
316 #include "stat-macros.h"
318 #include "timespec.h"
321 # include <inttypes.h>
327 #if ULONG_MAX_LT_ULLONG_MAX
328 # define LONGEST_MODIFIER "ll"
330 # define LONGEST_MODIFIER "l"
332 #if PRI_MACROS_BROKEN
339 # define PRIdMAX LONGEST_MODIFIER "d"
342 # define PRIoMAX LONGEST_MODIFIER "o"
345 # define PRIuMAX LONGEST_MODIFIER "u"
348 # define PRIxMAX LONGEST_MODIFIER "x"
353 /* Jim Meyering writes:
355 "... Some ctype macros are valid only for character codes that
356 isascii says are ASCII (SGI's IRIX-4.0.5 is one such system --when
357 using /bin/cc or gcc but without giving an ansi option). So, all
358 ctype uses should be through macros like ISPRINT... If
359 STDC_HEADERS is defined, then autoconf has verified that the ctype
360 macros don't need to be guarded with references to isascii. ...
361 Defining isascii to 1 should let any compiler worth its salt
362 eliminate the && through constant folding."
366 "... Furthermore, isupper(c) etc. have an undefined result if c is
367 outside the range -1 <= c <= 255. One is tempted to write isupper(c)
368 with c being of type `char', but this is wrong if c is an 8-bit
369 character >= 128 which gets sign-extended to a negative value.
370 The macro ISUPPER protects against this as well." */
372 #if STDC_HEADERS || (!defined isascii && !HAVE_ISASCII)
373 # define IN_CTYPE_DOMAIN(c) 1
375 # define IN_CTYPE_DOMAIN(c) isascii(c)
379 # define ISBLANK(c) (IN_CTYPE_DOMAIN (c) && isblank (c))
381 # define ISBLANK(c) ((c) == ' ' || (c) == '\t')
384 # define ISGRAPH(c) (IN_CTYPE_DOMAIN (c) && isgraph (c))
386 # define ISGRAPH(c) (IN_CTYPE_DOMAIN (c) && isprint (c) && !isspace (c))
389 /* This is defined in <sys/euc.h> on at least Solaris2.6 systems. */
392 #define ISPRINT(c) (IN_CTYPE_DOMAIN (c) && isprint (c))
393 #define ISALNUM(c) (IN_CTYPE_DOMAIN (c) && isalnum (c))
394 #define ISALPHA(c) (IN_CTYPE_DOMAIN (c) && isalpha (c))
395 #define ISCNTRL(c) (IN_CTYPE_DOMAIN (c) && iscntrl (c))
396 #define ISLOWER(c) (IN_CTYPE_DOMAIN (c) && islower (c))
397 #define ISPUNCT(c) (IN_CTYPE_DOMAIN (c) && ispunct (c))
398 #define ISSPACE(c) (IN_CTYPE_DOMAIN (c) && isspace (c))
399 #define ISUPPER(c) (IN_CTYPE_DOMAIN (c) && isupper (c))
400 #define ISXDIGIT(c) (IN_CTYPE_DOMAIN (c) && isxdigit (c))
401 #define ISDIGIT_LOCALE(c) (IN_CTYPE_DOMAIN (c) && isdigit (c))
404 # define TOLOWER(Ch) tolower (Ch)
405 # define TOUPPER(Ch) toupper (Ch)
407 # define TOLOWER(Ch) (ISUPPER (Ch) ? tolower (Ch) : (Ch))
408 # define TOUPPER(Ch) (ISLOWER (Ch) ? toupper (Ch) : (Ch))
411 /* ISDIGIT differs from ISDIGIT_LOCALE, as follows:
412 - Its arg may be any int or unsigned int; it need not be an unsigned char.
413 - It's guaranteed to evaluate its argument exactly once.
414 - It's typically faster.
415 POSIX says that only '0' through '9' are digits. Prefer ISDIGIT to
416 ISDIGIT_LOCALE unless it's important to use the locale's definition
417 of `digit' even when the host does not conform to POSIX. */
418 #define ISDIGIT(c) ((unsigned int) (c) - '0' <= 9)
420 /* Convert a possibly-signed character to an unsigned character. This is
421 a bit safer than casting to unsigned char, since it catches some type
422 errors that the cast doesn't. */
423 static inline unsigned char to_uchar (char ch) { return ch; }
427 /* Take care of NLS matters. */
432 # define textdomain(Domainname) /* empty */
433 # undef bindtextdomain
434 # define bindtextdomain(Domainname, Dirname) /* empty */
437 #define _(msgid) gettext (msgid)
438 #define N_(msgid) msgid
440 #define STREQ(a, b) (strcmp ((a), (b)) == 0)
446 #if !HAVE_DECL_MALLOC
450 #if !HAVE_DECL_MEMCHR
454 #if !HAVE_DECL_REALLOC
458 #if !HAVE_DECL_STPCPY
464 #if !HAVE_DECL_STRNDUP
468 #if !HAVE_DECL_STRSTR
472 #if !HAVE_DECL_GETENV
480 /* This is needed on some AIX systems. */
481 #if !HAVE_DECL_STRTOUL
482 unsigned long strtoul ();
485 #if !HAVE_DECL_GETLOGIN
489 #if !HAVE_DECL_TTYNAME
493 #if !HAVE_DECL_GETEUID
497 #if !HAVE_DECL_GETPWUID
498 struct passwd *getpwuid ();
501 #if !HAVE_DECL_GETGRGID
502 struct group *getgrgid ();
505 #if !HAVE_DECL_GETUID
512 /* This is simply a shorthand for the common case in which
513 the third argument to x2nrealloc would be `sizeof *(P)'.
514 Ensure that sizeof *(P) is *not* 1. In that case, it'd be
515 better to use X2REALLOC, although not strictly necessary. */
516 #define X2NREALLOC(P, PN) (verify_true (sizeof *(P) != 1), \
517 x2nrealloc (P, PN, sizeof *(P)))
519 /* Using x2realloc (when appropriate) usually makes your code more
520 readable than using x2nrealloc, but it also makes it so your
521 code will malfunction if sizeof *(P) ever becomes 2 or greater.
522 So use this macro instead of using x2realloc directly. */
523 #define X2REALLOC(P, PN) (verify_true (sizeof *(P) == 1), x2realloc (P, PN))
525 #if ! defined HAVE_MEMPCPY && ! defined mempcpy
526 /* Be CAREFUL that there are no side effects in N. */
527 # define mempcpy(D, S, N) ((void *) ((char *) memcpy (D, S, N) + (N)))
530 /* Include automatically-generated macros for unlocked I/O. */
531 #include "unlocked-io.h"
533 #define SAME_INODE(Stat_buf_1, Stat_buf_2) \
534 ((Stat_buf_1).st_ino == (Stat_buf_2).st_ino \
535 && (Stat_buf_1).st_dev == (Stat_buf_2).st_dev)
537 #define DOT_OR_DOTDOT(Basename) \
538 (Basename[0] == '.' && (Basename[1] == '\0' \
539 || (Basename[1] == '.' && Basename[2] == '\0')))
541 /* A wrapper for readdir so that callers don't see entries for `.' or `..'. */
542 static inline struct dirent const *
543 readdir_ignoring_dot_and_dotdot (DIR *dirp)
547 struct dirent const *dp = readdir (dirp);
548 if (dp == NULL || ! DOT_OR_DOTDOT (dp->d_name))
554 # define SETVBUF(Stream, Buffer, Type, Size) \
555 setvbuf (Stream, Type, Buffer, Size)
557 # define SETVBUF(Stream, Buffer, Type, Size) \
558 setvbuf (Stream, Buffer, Type, Size)
561 /* Factor out some of the common --help and --version processing code. */
563 /* These enum values cannot possibly conflict with the option values
564 ordinarily used by commands, including CHAR_MAX + 1, etc. Avoid
565 CHAR_MIN - 1, as it may equal -1, the getopt end-of-options value. */
568 GETOPT_HELP_CHAR = (CHAR_MIN - 2),
569 GETOPT_VERSION_CHAR = (CHAR_MIN - 3)
572 #define GETOPT_HELP_OPTION_DECL \
573 "help", no_argument, NULL, GETOPT_HELP_CHAR
574 #define GETOPT_VERSION_OPTION_DECL \
575 "version", no_argument, NULL, GETOPT_VERSION_CHAR
577 #define case_GETOPT_HELP_CHAR \
578 case GETOPT_HELP_CHAR: \
579 usage (EXIT_SUCCESS); \
582 /* Program_name must be a literal string.
583 Usually it is just PROGRAM_NAME. */
584 #define USAGE_BUILTIN_WARNING \
586 "NOTE: your shell may have its own version of %s, which usually supersedes\n" \
587 "the version described here. Please refer to your shell's documentation\n" \
588 "for details about the options it supports.\n")
590 #define HELP_OPTION_DESCRIPTION \
591 _(" --help display this help and exit\n")
592 #define VERSION_OPTION_DESCRIPTION \
593 _(" --version output version information and exit\n")
595 #include "closeout.h"
596 #include "version-etc.h"
598 #define case_GETOPT_VERSION_CHAR(Program_name, Authors) \
599 case GETOPT_VERSION_CHAR: \
600 version_etc (stdout, Program_name, GNU_PACKAGE, VERSION, Authors, \
602 exit (EXIT_SUCCESS); \
606 # define MAX(a, b) ((a) > (b) ? (a) : (b))
610 # define MIN(a,b) (((a) < (b)) ? (a) : (b))
613 #include "intprops.h"
616 # define CHAR_MIN TYPE_MINIMUM (char)
620 # define CHAR_MAX TYPE_MAXIMUM (char)
624 # define SCHAR_MIN (-1 - SCHAR_MAX)
628 # define SCHAR_MAX (CHAR_MAX == UCHAR_MAX ? CHAR_MAX / 2 : CHAR_MAX)
632 # define UCHAR_MAX TYPE_MAXIMUM (unsigned char)
636 # define SHRT_MIN TYPE_MINIMUM (short int)
640 # define SHRT_MAX TYPE_MAXIMUM (short int)
644 # define INT_MAX TYPE_MAXIMUM (int)
648 # define INT_MIN TYPE_MINIMUM (int)
652 # define INTMAX_MAX TYPE_MAXIMUM (intmax_t)
656 # define INTMAX_MIN TYPE_MINIMUM (intmax_t)
660 # define UINT_MAX TYPE_MAXIMUM (unsigned int)
664 # define LONG_MAX TYPE_MAXIMUM (long int)
668 # define ULONG_MAX TYPE_MAXIMUM (unsigned long int)
672 # define SIZE_MAX TYPE_MAXIMUM (size_t)
676 # define SSIZE_MAX TYPE_MAXIMUM (ssize_t)
680 # define UINTMAX_MAX TYPE_MAXIMUM (uintmax_t)
684 # define OFF_T_MIN TYPE_MINIMUM (off_t)
688 # define OFF_T_MAX TYPE_MAXIMUM (off_t)
692 # define UID_T_MAX TYPE_MAXIMUM (uid_t)
696 # define GID_T_MAX TYPE_MAXIMUM (gid_t)
700 # define PID_T_MAX TYPE_MAXIMUM (pid_t)
703 /* Use this to suppress gcc's `...may be used before initialized' warnings. */
705 # define IF_LINT(Code) Code
707 # define IF_LINT(Code) /* empty */
710 #ifndef __attribute__
711 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 8) || __STRICT_ANSI__
712 # define __attribute__(x) /* empty */
716 #ifndef ATTRIBUTE_NORETURN
717 # define ATTRIBUTE_NORETURN __attribute__ ((__noreturn__))
720 #ifndef ATTRIBUTE_UNUSED
721 # define ATTRIBUTE_UNUSED __attribute__ ((__unused__))
725 # define ASSIGN_STRDUPA(DEST, S) \
726 do { DEST = strdupa (S); } while (0)
728 # define ASSIGN_STRDUPA(DEST, S) \
731 const char *s_ = (S); \
732 size_t len_ = strlen (s_) + 1; \
733 char *tmp_dest_ = alloca (len_); \
734 DEST = memcpy (tmp_dest_, (s_), len_); \
740 # define EOVERFLOW EINVAL
743 #if ! HAVE_FSEEKO && ! defined fseeko
744 # define fseeko(s, o, w) ((o) == (long int) (o) \
746 : (errno = EOVERFLOW, -1))
749 /* Compute the greatest common divisor of U and V using Euclid's
750 algorithm. U and V must be nonzero. */
753 gcd (size_t u, size_t v)
766 /* Compute the least common multiple of U and V. U and V must be
767 nonzero. There is no overflow checking, so callers should not
768 specify outlandish sizes. */
771 lcm (size_t u, size_t v)
773 return u * (v / gcd (u, v));
776 /* Return PTR, aligned upward to the next multiple of ALIGNMENT.
777 ALIGNMENT must be nonzero. The caller must arrange for ((char *)
778 PTR) through ((char *) PTR + ALIGNMENT - 1) to be addressable
782 ptr_align (void const *ptr, size_t alignment)
784 char const *p0 = ptr;
785 char const *p1 = p0 + alignment - 1;
786 return (void *) (p1 - (size_t) p1 % alignment);
789 /* If 10*Accum + Digit_val is larger than the maximum value for Type,
790 then don't update Accum and return false to indicate it would
791 overflow. Otherwise, set Accum to that new value and return true.
792 Verify at compile-time that Type is Accum's type, and that Type is
793 unsigned. Accum must be an object, so that we can take its
794 address. Accum and Digit_val may be evaluated multiple times.
796 The "Added check" below is not strictly required, but it causes GCC
797 to return a nonzero exit status instead of merely a warning
798 diagnostic, and that is more useful. */
800 #define DECIMAL_DIGIT_ACCUMULATE(Accum, Digit_val, Type) \
802 (void) (&(Accum) == (Type *) NULL), /* The type matches. */ \
803 verify_true (! TYPE_SIGNED (Type)), /* The type is unsigned. */ \
804 verify_true (sizeof (Accum) == sizeof (Type)), /* Added check. */ \
805 (((Type) -1 / 10 < (Accum) \
806 || (Type) ((Accum) * 10 + (Digit_val)) < (Accum)) \
807 ? false : (((Accum) = (Accum) * 10 + (Digit_val)), true)) \