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. */
228 #ifndef _D_EXACT_NAMLEN
229 # define _D_EXACT_NAMLEN(dp) strlen ((dp)->d_name)
234 NOT_AN_INODE_NUMBER = 0
237 #ifdef D_INO_IN_DIRENT
238 # define D_INO(dp) (dp)->d_ino
240 /* Some systems don't have inodes, so fake them to avoid lots of ifdefs. */
241 # define D_INO(dp) NOT_AN_INODE_NUMBER
244 /* Get or fake the disk device blocksize.
245 Usually defined by sys/param.h (if at all). */
246 #if !defined DEV_BSIZE && defined BSIZE
247 # define DEV_BSIZE BSIZE
249 #if !defined DEV_BSIZE && defined BBSIZE /* SGI */
250 # define DEV_BSIZE BBSIZE
253 # define DEV_BSIZE 4096
256 /* Extract or fake data from a `struct stat'.
257 ST_BLKSIZE: Preferred I/O blocksize for the file, in bytes.
258 ST_NBLOCKS: Number of blocks in the file, including indirect blocks.
259 ST_NBLOCKSIZE: Size of blocks used when calculating ST_NBLOCKS. */
260 #ifndef HAVE_STRUCT_STAT_ST_BLOCKS
261 # define ST_BLKSIZE(statbuf) DEV_BSIZE
262 # if defined _POSIX_SOURCE || !defined BSIZE /* fileblocks.c uses BSIZE. */
263 # define ST_NBLOCKS(statbuf) \
264 ((statbuf).st_size / ST_NBLOCKSIZE + ((statbuf).st_size % ST_NBLOCKSIZE != 0))
265 # else /* !_POSIX_SOURCE && BSIZE */
266 # define ST_NBLOCKS(statbuf) \
267 (S_ISREG ((statbuf).st_mode) \
268 || S_ISDIR ((statbuf).st_mode) \
269 ? st_blocks ((statbuf).st_size) : 0)
270 # endif /* !_POSIX_SOURCE && BSIZE */
271 #else /* HAVE_STRUCT_STAT_ST_BLOCKS */
272 /* Some systems, like Sequents, return st_blksize of 0 on pipes.
273 Also, when running `rsh hpux11-system cat any-file', cat would
274 determine that the output stream had an st_blksize of 2147421096.
275 So here we arbitrarily limit the `optimal' block size to 4MB.
276 If anyone knows of a system for which the legitimate value for
277 st_blksize can exceed 4MB, please report it as a bug in this code. */
278 # define ST_BLKSIZE(statbuf) ((0 < (statbuf).st_blksize \
279 && (statbuf).st_blksize <= (1 << 22)) /* 4MB */ \
280 ? (statbuf).st_blksize : DEV_BSIZE)
281 # if defined hpux || defined __hpux__ || defined __hpux
282 /* HP-UX counts st_blocks in 1024-byte units.
283 This loses when mixing HP-UX and BSD file systems with NFS. */
284 # define ST_NBLOCKSIZE 1024
286 # if defined _AIX && defined _I386
287 /* AIX PS/2 counts st_blocks in 4K units. */
288 # define ST_NBLOCKSIZE (4 * 1024)
289 # else /* not AIX PS/2 */
291 # define ST_NBLOCKS(statbuf) \
292 (S_ISREG ((statbuf).st_mode) \
293 || S_ISDIR ((statbuf).st_mode) \
294 ? (statbuf).st_blocks * ST_BLKSIZE(statbuf)/ST_NBLOCKSIZE : 0)
296 # endif /* not AIX PS/2 */
298 #endif /* HAVE_STRUCT_STAT_ST_BLOCKS */
301 # define ST_NBLOCKS(statbuf) ((statbuf).st_blocks)
304 #ifndef ST_NBLOCKSIZE
306 # define ST_NBLOCKSIZE S_BLKSIZE
308 # define ST_NBLOCKSIZE 512
312 /* Redirection and wildcarding when done by the utility itself.
313 Generally a noop, but used in particular for native VMS. */
314 #ifndef initialize_main
315 # define initialize_main(ac, av)
318 #include "stat-macros.h"
320 #include "timespec.h"
323 # 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 #if ! (defined isblank || HAVE_DECL_ISBLANK)
354 # define isblank(c) ((c) == ' ' || (c) == '\t')
357 /* ISDIGIT differs from isdigit, as follows:
358 - Its arg may be any int or unsigned int; it need not be an unsigned char
360 - It's typically faster.
361 POSIX says that only '0' through '9' are digits. Prefer ISDIGIT to
362 isdigit unless it's important to use the locale's definition
363 of `digit' even when the host does not conform to POSIX. */
364 #define ISDIGIT(c) ((unsigned int) (c) - '0' <= 9)
366 /* Convert a possibly-signed character to an unsigned character. This is
367 a bit safer than casting to unsigned char, since it catches some type
368 errors that the cast doesn't. */
369 static inline unsigned char to_uchar (char ch) { return ch; }
373 /* Take care of NLS matters. */
378 # define textdomain(Domainname) /* empty */
379 # undef bindtextdomain
380 # define bindtextdomain(Domainname, Dirname) /* empty */
383 #define _(msgid) gettext (msgid)
384 #define N_(msgid) msgid
386 #define STREQ(a, b) (strcmp ((a), (b)) == 0)
392 #if !HAVE_DECL_MALLOC
396 #if !HAVE_DECL_MEMCHR
400 #if !HAVE_DECL_REALLOC
404 #if !HAVE_DECL_STPCPY
410 #if !HAVE_DECL_STRNDUP
414 #if !HAVE_DECL_STRSTR
418 #if !HAVE_DECL_GETENV
426 /* This is needed on some AIX systems. */
427 #if !HAVE_DECL_STRTOUL
428 unsigned long strtoul ();
431 #if !HAVE_DECL_GETLOGIN
435 #if !HAVE_DECL_TTYNAME
439 #if !HAVE_DECL_GETEUID
443 #if !HAVE_DECL_GETPWUID
444 struct passwd *getpwuid ();
447 #if !HAVE_DECL_GETGRGID
448 struct group *getgrgid ();
451 #if !HAVE_DECL_GETUID
458 /* This is simply a shorthand for the common case in which
459 the third argument to x2nrealloc would be `sizeof *(P)'.
460 Ensure that sizeof *(P) is *not* 1. In that case, it'd be
461 better to use X2REALLOC, although not strictly necessary. */
462 #define X2NREALLOC(P, PN) ((void) verify_true (sizeof *(P) != 1), \
463 x2nrealloc (P, PN, sizeof *(P)))
465 /* Using x2realloc (when appropriate) usually makes your code more
466 readable than using x2nrealloc, but it also makes it so your
467 code will malfunction if sizeof *(P) ever becomes 2 or greater.
468 So use this macro instead of using x2realloc directly. */
469 #define X2REALLOC(P, PN) ((void) verify_true (sizeof *(P) == 1), \
472 #if ! defined HAVE_MEMPCPY && ! defined mempcpy
473 /* Be CAREFUL that there are no side effects in N. */
474 # define mempcpy(D, S, N) ((void *) ((char *) memcpy (D, S, N) + (N)))
477 /* Include automatically-generated macros for unlocked I/O. */
478 #include "unlocked-io.h"
479 #include "same-inode.h"
481 #define DOT_OR_DOTDOT(Basename) \
482 (Basename[0] == '.' && (Basename[1] == '\0' \
483 || (Basename[1] == '.' && Basename[2] == '\0')))
485 /* A wrapper for readdir so that callers don't see entries for `.' or `..'. */
486 static inline struct dirent const *
487 readdir_ignoring_dot_and_dotdot (DIR *dirp)
491 struct dirent const *dp = readdir (dirp);
492 if (dp == NULL || ! DOT_OR_DOTDOT (dp->d_name))
498 # define SETVBUF(Stream, Buffer, Type, Size) \
499 setvbuf (Stream, Type, Buffer, Size)
501 # define SETVBUF(Stream, Buffer, Type, Size) \
502 setvbuf (Stream, Buffer, Type, Size)
505 /* Factor out some of the common --help and --version processing code. */
507 /* These enum values cannot possibly conflict with the option values
508 ordinarily used by commands, including CHAR_MAX + 1, etc. Avoid
509 CHAR_MIN - 1, as it may equal -1, the getopt end-of-options value. */
512 GETOPT_HELP_CHAR = (CHAR_MIN - 2),
513 GETOPT_VERSION_CHAR = (CHAR_MIN - 3)
516 #define GETOPT_HELP_OPTION_DECL \
517 "help", no_argument, NULL, GETOPT_HELP_CHAR
518 #define GETOPT_VERSION_OPTION_DECL \
519 "version", no_argument, NULL, GETOPT_VERSION_CHAR
521 #define case_GETOPT_HELP_CHAR \
522 case GETOPT_HELP_CHAR: \
523 usage (EXIT_SUCCESS); \
526 /* Program_name must be a literal string.
527 Usually it is just PROGRAM_NAME. */
528 #define USAGE_BUILTIN_WARNING \
530 "NOTE: your shell may have its own version of %s, which usually supersedes\n" \
531 "the version described here. Please refer to your shell's documentation\n" \
532 "for details about the options it supports.\n")
534 #define HELP_OPTION_DESCRIPTION \
535 _(" --help display this help and exit\n")
536 #define VERSION_OPTION_DESCRIPTION \
537 _(" --version output version information and exit\n")
539 #include "closeout.h"
540 #include "version-etc.h"
542 #define case_GETOPT_VERSION_CHAR(Program_name, Authors) \
543 case GETOPT_VERSION_CHAR: \
544 version_etc (stdout, Program_name, GNU_PACKAGE, VERSION, Authors, \
546 exit (EXIT_SUCCESS); \
550 # define MAX(a, b) ((a) > (b) ? (a) : (b))
554 # define MIN(a,b) (((a) < (b)) ? (a) : (b))
557 #include "intprops.h"
560 # define CHAR_MIN TYPE_MINIMUM (char)
564 # define CHAR_MAX TYPE_MAXIMUM (char)
568 # define SCHAR_MIN (-1 - SCHAR_MAX)
572 # define SCHAR_MAX (CHAR_MAX == UCHAR_MAX ? CHAR_MAX / 2 : CHAR_MAX)
576 # define UCHAR_MAX TYPE_MAXIMUM (unsigned char)
580 # define SHRT_MIN TYPE_MINIMUM (short int)
584 # define SHRT_MAX TYPE_MAXIMUM (short int)
588 # define INT_MAX TYPE_MAXIMUM (int)
592 # define INT_MIN TYPE_MINIMUM (int)
596 # define INTMAX_MAX TYPE_MAXIMUM (intmax_t)
600 # define INTMAX_MIN TYPE_MINIMUM (intmax_t)
604 # define UINT_MAX TYPE_MAXIMUM (unsigned int)
608 # define LONG_MAX TYPE_MAXIMUM (long int)
612 # define ULONG_MAX TYPE_MAXIMUM (unsigned long int)
616 # define SIZE_MAX TYPE_MAXIMUM (size_t)
620 # define SSIZE_MAX TYPE_MAXIMUM (ssize_t)
624 # define UINTMAX_MAX TYPE_MAXIMUM (uintmax_t)
628 # define OFF_T_MIN TYPE_MINIMUM (off_t)
632 # define OFF_T_MAX TYPE_MAXIMUM (off_t)
636 # define UID_T_MAX TYPE_MAXIMUM (uid_t)
640 # define GID_T_MAX TYPE_MAXIMUM (gid_t)
644 # define PID_T_MAX TYPE_MAXIMUM (pid_t)
647 /* Use this to suppress gcc's `...may be used before initialized' warnings. */
649 # define IF_LINT(Code) Code
651 # define IF_LINT(Code) /* empty */
654 #ifndef __attribute__
655 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 8) || __STRICT_ANSI__
656 # define __attribute__(x) /* empty */
660 #ifndef ATTRIBUTE_NORETURN
661 # define ATTRIBUTE_NORETURN __attribute__ ((__noreturn__))
664 #ifndef ATTRIBUTE_UNUSED
665 # define ATTRIBUTE_UNUSED __attribute__ ((__unused__))
669 # define ASSIGN_STRDUPA(DEST, S) \
670 do { DEST = strdupa (S); } while (0)
672 # define ASSIGN_STRDUPA(DEST, S) \
675 const char *s_ = (S); \
676 size_t len_ = strlen (s_) + 1; \
677 char *tmp_dest_ = alloca (len_); \
678 DEST = memcpy (tmp_dest_, (s_), len_); \
684 # define EOVERFLOW EINVAL
687 #if ! HAVE_FSEEKO && ! defined fseeko
688 # define fseeko(s, o, w) ((o) == (long int) (o) \
690 : (errno = EOVERFLOW, -1))
694 # define sync() /* empty */
697 /* Compute the greatest common divisor of U and V using Euclid's
698 algorithm. U and V must be nonzero. */
701 gcd (size_t u, size_t v)
714 /* Compute the least common multiple of U and V. U and V must be
715 nonzero. There is no overflow checking, so callers should not
716 specify outlandish sizes. */
719 lcm (size_t u, size_t v)
721 return u * (v / gcd (u, v));
724 /* Return PTR, aligned upward to the next multiple of ALIGNMENT.
725 ALIGNMENT must be nonzero. The caller must arrange for ((char *)
726 PTR) through ((char *) PTR + ALIGNMENT - 1) to be addressable
730 ptr_align (void const *ptr, size_t alignment)
732 char const *p0 = ptr;
733 char const *p1 = p0 + alignment - 1;
734 return (void *) (p1 - (size_t) p1 % alignment);
737 /* If 10*Accum + Digit_val is larger than the maximum value for Type,
738 then don't update Accum and return false to indicate it would
739 overflow. Otherwise, set Accum to that new value and return true.
740 Verify at compile-time that Type is Accum's type, and that Type is
741 unsigned. Accum must be an object, so that we can take its
742 address. Accum and Digit_val may be evaluated multiple times.
744 The "Added check" below is not strictly required, but it causes GCC
745 to return a nonzero exit status instead of merely a warning
746 diagnostic, and that is more useful. */
748 #define DECIMAL_DIGIT_ACCUMULATE(Accum, Digit_val, Type) \
750 (void) (&(Accum) == (Type *) NULL), /* The type matches. */ \
751 (void) verify_true (! TYPE_SIGNED (Type)), /* The type is unsigned. */ \
752 (void) verify_true (sizeof (Accum) == sizeof (Type)), /* Added check. */ \
753 (((Type) -1 / 10 < (Accum) \
754 || (Type) ((Accum) * 10 + (Digit_val)) < (Accum)) \
755 ? false : (((Accum) = (Accum) * 10 + (Digit_val)), true)) \