1 /* system-dependent definitions for coreutils
2 Copyright (C) 1989, 1991-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 of the License, or
7 (at your option) any later version.
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, see <http://www.gnu.org/licenses/>. */
17 /* Include this file _after_ system headers if possible. */
21 /* Include <sys/types.h> before this file.
22 Note this doesn't warn if we're included
23 before all system headers. */
25 #if 2 < __GLIBC__ || ( 2 == ___GLIBC__ && 2 <= __GLIBC_MINOR__ )
26 # if ! defined _SYS_TYPES_H
27 you must include
<sys
/types
.h
> before including
this file
33 #if !defined HAVE_MKFIFO
34 # define mkfifo(name, mode) mknod (name, (mode) | S_IFIFO, 0)
38 # include <sys/param.h>
45 # define PATH_MAX 8192
48 #include "configmake.h"
53 /* Since major is a function on SVR4, we can't use `ifndef major'. */
55 # include <sys/mkdev.h>
58 #if MAJOR_IN_SYSMACROS
59 # include <sys/sysmacros.h>
62 #ifdef major /* Might be defined in sys/types.h. */
67 # define major(dev) (((dev) >> 8) & 0xff)
68 # define minor(dev) ((dev) & 0xff)
69 # define makedev(maj, min) (((maj) << 8) | (min))
73 #if ! defined makedev && defined mkdev
74 # define makedev(maj, min) mkdev (maj, min)
80 /* Some systems don't define this; POSIX mentions it but says it is
81 obsolete. gnulib defines it, but only on native Windows systems,
82 and there only because MSVC 10 does. */
91 /* Exit statuses for programs like 'env' that exec other programs. */
94 EXIT_TIMEDOUT
= 124, /* Time expired before child completed. */
95 EXIT_CANCELED
= 125, /* Internal error prior to exec attempt. */
96 EXIT_CANNOT_INVOKE
= 126, /* Program located, but not usable. */
97 EXIT_ENOENT
= 127 /* Could not find program to exec. */
100 #include "exitfail.h"
102 /* Set exit_failure to STATUS if that's not the default already. */
104 initialize_exit_failure (int status
)
106 if (status
!= EXIT_FAILURE
)
107 exit_failure
= status
;
113 #ifndef _D_EXACT_NAMLEN
114 # define _D_EXACT_NAMLEN(dp) strlen ((dp)->d_name)
119 NOT_AN_INODE_NUMBER
= 0
122 #ifdef D_INO_IN_DIRENT
123 # define D_INO(dp) (dp)->d_ino
125 /* Some systems don't have inodes, so fake them to avoid lots of ifdefs. */
126 # define D_INO(dp) NOT_AN_INODE_NUMBER
129 /* include here for SIZE_MAX. */
130 #include <inttypes.h>
132 /* Redirection and wildcarding when done by the utility itself.
133 Generally a noop, but used in particular for native VMS. */
134 #ifndef initialize_main
135 # define initialize_main(ac, av)
138 #include "stat-macros.h"
140 #include "timespec.h"
144 /* ISDIGIT differs from isdigit, as follows:
145 - Its arg may be any int or unsigned int; it need not be an unsigned char
147 - It's typically faster.
148 POSIX says that only '0' through '9' are digits. Prefer ISDIGIT to
149 isdigit unless it's important to use the locale's definition
150 of `digit' even when the host does not conform to POSIX. */
151 #define ISDIGIT(c) ((unsigned int) (c) - '0' <= 9)
153 /* Convert a possibly-signed character to an unsigned character. This is
154 a bit safer than casting to unsigned char, since it catches some type
155 errors that the cast doesn't. */
156 static inline unsigned char to_uchar (char ch
) { return ch
; }
160 /* Take care of NLS matters. */
165 # define textdomain(Domainname) /* empty */
166 # undef bindtextdomain
167 # define bindtextdomain(Domainname, Dirname) /* empty */
170 #define _(msgid) gettext (msgid)
171 #define N_(msgid) msgid
173 /* Return a value that pluralizes the same way that N does, in all
174 languages we know of. */
175 static inline unsigned long int
176 select_plural (uintmax_t n
)
178 /* Reduce by a power of ten, but keep it away from zero. The
179 gettext manual says 1000000 should be safe. */
180 enum { PLURAL_REDUCER
= 1000000 };
181 return (n
<= ULONG_MAX
? n
: n
% PLURAL_REDUCER
+ PLURAL_REDUCER
);
184 #define STREQ(a, b) (strcmp (a, b) == 0)
185 #define STREQ_LEN(a, b, n) (strncmp (a, b, n) == 0)
186 #define STRPREFIX(a, b) (strncmp(a, b, strlen (b)) == 0)
188 /* Just like strncmp, but the second argument must be a literal string
189 and you don't specify the length. */
190 #define STRNCMP_LIT(s, literal) \
191 strncmp (s, "" literal "", sizeof (literal) - 1)
193 #if !HAVE_DECL_GETLOGIN
197 #if !HAVE_DECL_TTYNAME
201 #if !HAVE_DECL_GETEUID
205 #if !HAVE_DECL_GETPWUID
206 struct passwd
*getpwuid ();
209 #if !HAVE_DECL_GETGRGID
210 struct group
*getgrgid ();
213 /* Interix has replacements for getgr{gid,nam,ent}, that don't
214 query the domain controller for group members when not required.
215 This speeds up the calls tremendously (<1 ms vs. >3 s). */
216 /* To protect any system that could provide _nomembers functions
217 other than interix, check for HAVE_SETGROUPS, as interix is
218 one of the very few (the only?) platform that lacks it */
220 # if HAVE_GETGRGID_NOMEMBERS
221 # define getgrgid(gid) getgrgid_nomembers(gid)
223 # if HAVE_GETGRNAM_NOMEMBERS
224 # define getgrnam(nam) getgrnam_nomembers(nam)
226 # if HAVE_GETGRENT_NOMEMBERS
227 # define getgrent() getgrent_nomembers()
231 #if !HAVE_DECL_GETUID
238 /* This is simply a shorthand for the common case in which
239 the third argument to x2nrealloc would be `sizeof *(P)'.
240 Ensure that sizeof *(P) is *not* 1. In that case, it'd be
241 better to use X2REALLOC, although not strictly necessary. */
242 #define X2NREALLOC(P, PN) ((void) verify_true (sizeof *(P) != 1), \
243 x2nrealloc (P, PN, sizeof *(P)))
245 /* Using x2realloc (when appropriate) usually makes your code more
246 readable than using x2nrealloc, but it also makes it so your
247 code will malfunction if sizeof *(P) ever becomes 2 or greater.
248 So use this macro instead of using x2realloc directly. */
249 #define X2REALLOC(P, PN) ((void) verify_true (sizeof *(P) == 1), \
252 #include "unlocked-io.h"
253 #include "same-inode.h"
259 dot_or_dotdot (char const *file_name
)
261 if (file_name
[0] == '.')
263 char sep
= file_name
[(file_name
[1] == '.') + 1];
264 return (! sep
|| ISSLASH (sep
));
270 /* A wrapper for readdir so that callers don't see entries for `.' or `..'. */
271 static inline struct dirent
const *
272 readdir_ignoring_dot_and_dotdot (DIR *dirp
)
276 struct dirent
const *dp
= readdir (dirp
);
277 if (dp
== NULL
|| ! dot_or_dotdot (dp
->d_name
))
282 /* Return true if DIR is determined to be an empty directory. */
284 is_empty_dir (int fd_cwd
, char const *dir
)
287 struct dirent
const *dp
;
289 int fd
= openat (fd_cwd
, dir
,
290 (O_RDONLY
| O_DIRECTORY
291 | O_NOCTTY
| O_NOFOLLOW
| O_NONBLOCK
));
296 dirp
= fdopendir (fd
);
304 dp
= readdir_ignoring_dot_and_dotdot (dirp
);
309 return saved_errno
== 0 ? true : false;
312 /* Factor out some of the common --help and --version processing code. */
314 /* These enum values cannot possibly conflict with the option values
315 ordinarily used by commands, including CHAR_MAX + 1, etc. Avoid
316 CHAR_MIN - 1, as it may equal -1, the getopt end-of-options value. */
319 GETOPT_HELP_CHAR
= (CHAR_MIN
- 2),
320 GETOPT_VERSION_CHAR
= (CHAR_MIN
- 3)
323 #define GETOPT_HELP_OPTION_DECL \
324 "help", no_argument, NULL, GETOPT_HELP_CHAR
325 #define GETOPT_VERSION_OPTION_DECL \
326 "version", no_argument, NULL, GETOPT_VERSION_CHAR
327 #define GETOPT_SELINUX_CONTEXT_OPTION_DECL \
328 "context", required_argument, NULL, 'Z'
330 #define case_GETOPT_HELP_CHAR \
331 case GETOPT_HELP_CHAR: \
332 usage (EXIT_SUCCESS); \
335 /* Program_name must be a literal string.
336 Usually it is just PROGRAM_NAME. */
337 #define USAGE_BUILTIN_WARNING \
339 "NOTE: your shell may have its own version of %s, which usually supersedes\n" \
340 "the version described here. Please refer to your shell's documentation\n" \
341 "for details about the options it supports.\n")
343 #define HELP_OPTION_DESCRIPTION \
344 _(" --help display this help and exit\n")
345 #define VERSION_OPTION_DESCRIPTION \
346 _(" --version output version information and exit\n")
349 #include "closeout.h"
351 #define emit_bug_reporting_address unused__emit_bug_reporting_address
352 #include "version-etc.h"
353 #undef emit_bug_reporting_address
355 #include "propername.h"
356 /* Define away proper_name (leaving proper_name_utf8, which affects far
357 fewer programs), since it's not worth the cost of adding ~17KB to
358 the x86_64 text size of every single program. This avoids a 40%
359 (almost ~2MB) increase in the on-disk space utilization for the set
360 of the 100 binaries. */
361 #define proper_name(x) (x)
363 #include "progname.h"
365 #define case_GETOPT_VERSION_CHAR(Program_name, Authors) \
366 case GETOPT_VERSION_CHAR: \
367 version_etc (stdout, Program_name, PACKAGE_NAME, Version, Authors, \
369 exit (EXIT_SUCCESS); \
373 # define MAX(a, b) ((a) > (b) ? (a) : (b))
377 # define MIN(a,b) (((a) < (b)) ? (a) : (b))
380 #include "intprops.h"
383 # define SSIZE_MAX TYPE_MAXIMUM (ssize_t)
387 # define OFF_T_MIN TYPE_MINIMUM (off_t)
391 # define OFF_T_MAX TYPE_MAXIMUM (off_t)
395 # define UID_T_MAX TYPE_MAXIMUM (uid_t)
399 # define GID_T_MAX TYPE_MAXIMUM (gid_t)
403 # define PID_T_MAX TYPE_MAXIMUM (pid_t)
406 /* Use this to suppress gcc's `...may be used before initialized' warnings. */
408 # define IF_LINT(Code) Code
410 # define IF_LINT(Code) /* empty */
413 #ifndef __attribute__
414 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 8)
415 # define __attribute__(x) /* empty */
419 #ifndef ATTRIBUTE_NORETURN
420 # define ATTRIBUTE_NORETURN __attribute__ ((__noreturn__))
423 #ifndef ATTRIBUTE_UNUSED
424 # define ATTRIBUTE_UNUSED __attribute__ ((__unused__))
427 /* The warn_unused_result attribute appeared first in gcc-3.4.0 */
428 #undef ATTRIBUTE_WARN_UNUSED_RESULT
429 #if __GNUC__ < 3 || (__GNUC__ == 3 && __GNUC_MINOR__ < 4)
430 # define ATTRIBUTE_WARN_UNUSED_RESULT /* empty */
432 # define ATTRIBUTE_WARN_UNUSED_RESULT __attribute__ ((__warn_unused_result__))
436 # define ASSIGN_STRDUPA(DEST, S) \
437 do { DEST = strdupa (S); } while (0)
439 # define ASSIGN_STRDUPA(DEST, S) \
442 const char *s_ = (S); \
443 size_t len_ = strlen (s_) + 1; \
444 char *tmp_dest_ = alloca (len_); \
445 DEST = memcpy (tmp_dest_, s_, len_); \
451 # define sync() /* empty */
454 /* Compute the greatest common divisor of U and V using Euclid's
455 algorithm. U and V must be nonzero. */
457 static inline size_t _GL_ATTRIBUTE_CONST
458 gcd (size_t u
, size_t v
)
471 /* Compute the least common multiple of U and V. U and V must be
472 nonzero. There is no overflow checking, so callers should not
473 specify outlandish sizes. */
475 static inline size_t _GL_ATTRIBUTE_CONST
476 lcm (size_t u
, size_t v
)
478 return u
* (v
/ gcd (u
, v
));
481 /* Return PTR, aligned upward to the next multiple of ALIGNMENT.
482 ALIGNMENT must be nonzero. The caller must arrange for ((char *)
483 PTR) through ((char *) PTR + ALIGNMENT - 1) to be addressable
487 ptr_align (void const *ptr
, size_t alignment
)
489 char const *p0
= ptr
;
490 char const *p1
= p0
+ alignment
- 1;
491 return (void *) (p1
- (size_t) p1
% alignment
);
494 /* If 10*Accum + Digit_val is larger than the maximum value for Type,
495 then don't update Accum and return false to indicate it would
496 overflow. Otherwise, set Accum to that new value and return true.
497 Verify at compile-time that Type is Accum's type, and that Type is
498 unsigned. Accum must be an object, so that we can take its
499 address. Accum and Digit_val may be evaluated multiple times.
501 The "Added check" below is not strictly required, but it causes GCC
502 to return a nonzero exit status instead of merely a warning
503 diagnostic, and that is more useful. */
505 #define DECIMAL_DIGIT_ACCUMULATE(Accum, Digit_val, Type) \
507 (void) (&(Accum) == (Type *) NULL), /* The type matches. */ \
508 (void) verify_true (! TYPE_SIGNED (Type)), /* The type is unsigned. */ \
509 (void) verify_true (sizeof (Accum) == sizeof (Type)), /* Added check. */ \
510 (((Type) -1 / 10 < (Accum) \
511 || (Type) ((Accum) * 10 + (Digit_val)) < (Accum)) \
512 ? false : (((Accum) = (Accum) * 10 + (Digit_val)), true)) \
516 emit_size_note (void)
519 SIZE may be (or may be an integer optionally followed by) one of following:\n\
520 KB 1000, K 1024, MB 1000*1000, M 1024*1024, and so on for G, T, P, E, Z, Y.\n\
525 emit_blocksize_note (char const *program
)
528 Display values are in units of the first available SIZE from --block-size,\n\
529 and the %s_BLOCK_SIZE, BLOCK_SIZE and BLOCKSIZE environment variables.\n\
530 Otherwise, units default to 1024 bytes (or 512 if POSIXLY_CORRECT is set).\n\
535 emit_ancillary_info (void)
537 printf (_("\nReport %s bugs to %s\n"), last_component (program_name
),
539 printf (_("%s home page: <%s>\n"), PACKAGE_NAME
, PACKAGE_URL
);
540 fputs (_("General help using GNU software: <http://www.gnu.org/gethelp/>\n"),
542 /* Don't output this redundant message for English locales.
543 Note we still output for 'C' so that it gets included in the man page. */
544 const char *lc_messages
= setlocale (LC_MESSAGES
, NULL
);
545 if (lc_messages
&& STRNCMP_LIT (lc_messages
, "en_"))
547 /* TRANSLATORS: Replace LANG_CODE in this URL with your language code
548 <http://translationproject.org/team/LANG_CODE.html> to form one of
549 the URLs at http://translationproject.org/team/. Otherwise, replace
550 the entire URL with your translation team's email address. */
551 printf (_("Report %s translation bugs to "
552 "<http://translationproject.org/team/>\n"),
553 last_component (program_name
));
555 printf (_("For complete documentation, run: "
556 "info coreutils '%s invocation'\n"), last_component (program_name
));
559 #include "inttostr.h"
562 timetostr (time_t t
, char *buf
)
564 return (TYPE_SIGNED (time_t)
566 : umaxtostr (t
, buf
));
570 bad_cast (char const *s
)
575 void usage (int status
) ATTRIBUTE_NORETURN
;
577 #define emit_cycle_warning(file_name) \
581 WARNING: Circular directory structure.\n\
582 This almost certainly means that you have a corrupted file system.\n\
583 NOTIFY YOUR SYSTEM MANAGER.\n\
584 The following directory is part of the cycle:\n %s\n"), \
585 quote (file_name)); \
589 #ifndef ARRAY_CARDINALITY
590 # define ARRAY_CARDINALITY(Array) (sizeof (Array) / sizeof *(Array))