1 /* system-dependent definitions for coreutils
2 Copyright (C) 1989-2019 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 <https://www.gnu.org/licenses/>. */
17 /* Include this file _after_ system headers if possible. */
23 /* Commonly used file permission combination. */
24 #define MODE_RW_UGO (S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH)
26 #if !defined HAVE_MKFIFO
27 # define mkfifo(name, mode) mknod (name, (mode) | S_IFIFO, 0)
31 # include <sys/param.h>
40 # define PATH_MAX 8192
43 #include "configmake.h"
48 /* Since major is a function on SVR4, we can't use 'ifndef major'. */
50 # include <sys/mkdev.h>
53 #if MAJOR_IN_SYSMACROS
54 # include <sys/sysmacros.h>
57 #ifdef major /* Might be defined in sys/types.h. */
62 # define major(dev) (((dev) >> 8) & 0xff)
63 # define minor(dev) ((dev) & 0xff)
64 # define makedev(maj, min) (((maj) << 8) | (min))
68 #if ! defined makedev && defined mkdev
69 # define makedev(maj, min) mkdev (maj, min)
75 /* Some systems don't define this; POSIX mentions it but says it is
76 obsolete. gnulib defines it, but only on native Windows systems,
77 and there only because MSVC 10 does. */
86 /* Exit statuses for programs like 'env' that exec other programs. */
89 EXIT_TIMEDOUT
= 124, /* Time expired before child completed. */
90 EXIT_CANCELED
= 125, /* Internal error prior to exec attempt. */
91 EXIT_CANNOT_INVOKE
= 126, /* Program located, but not usable. */
92 EXIT_ENOENT
= 127 /* Could not find program to exec. */
97 /* Set exit_failure to STATUS if that's not the default already. */
99 initialize_exit_failure (int status
)
101 if (status
!= EXIT_FAILURE
)
102 exit_failure
= status
;
108 #ifndef _D_EXACT_NAMLEN
109 # define _D_EXACT_NAMLEN(dp) strlen ((dp)->d_name)
114 NOT_AN_INODE_NUMBER
= 0
117 #ifdef D_INO_IN_DIRENT
118 # define D_INO(dp) (dp)->d_ino
120 /* Some systems don't have inodes, so fake them to avoid lots of ifdefs. */
121 # define D_INO(dp) NOT_AN_INODE_NUMBER
124 /* include here for SIZE_MAX. */
125 #include <inttypes.h>
127 /* Redirection and wildcarding when done by the utility itself.
128 Generally a noop, but used in particular for OS/2. */
129 #ifndef initialize_main
131 # define initialize_main(ac, av)
133 # define initialize_main(ac, av) \
134 do { _wildcard (ac, av); _response (ac, av); } while (0)
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
; }
158 /* '\n' is considered a field separator with --zero-terminated. */
160 field_sep (unsigned char ch
)
162 return isblank (ch
) || ch
== '\n';
167 /* Take care of NLS matters. */
172 # define textdomain(Domainname) /* empty */
173 # undef bindtextdomain
174 # define bindtextdomain(Domainname, Dirname) /* empty */
177 #define _(msgid) gettext (msgid)
178 #define N_(msgid) msgid
180 /* Return a value that pluralizes the same way that N does, in all
181 languages we know of. */
182 static inline unsigned long int
183 select_plural (uintmax_t n
)
185 /* Reduce by a power of ten, but keep it away from zero. The
186 gettext manual says 1000000 should be safe. */
187 enum { PLURAL_REDUCER
= 1000000 };
188 return (n
<= ULONG_MAX
? n
: n
% PLURAL_REDUCER
+ PLURAL_REDUCER
);
191 #define STREQ(a, b) (strcmp (a, b) == 0)
192 #define STREQ_LEN(a, b, n) (strncmp (a, b, n) == 0)
193 #define STRPREFIX(a, b) (strncmp (a, b, strlen (b)) == 0)
195 /* Just like strncmp, but the second argument must be a literal string
196 and you don't specify the length; that comes from the literal. */
197 #define STRNCMP_LIT(s, lit) strncmp (s, "" lit "", sizeof (lit) - 1)
199 #if !HAVE_DECL_GETLOGIN
200 char *getlogin (void);
203 #if !HAVE_DECL_TTYNAME
207 #if !HAVE_DECL_GETEUID
208 uid_t
geteuid (void);
211 #if !HAVE_DECL_GETPWUID
212 struct passwd
*getpwuid (uid_t
);
215 #if !HAVE_DECL_GETGRGID
216 struct group
*getgrgid (gid_t
);
219 /* Interix has replacements for getgr{gid,nam,ent}, that don't
220 query the domain controller for group members when not required.
221 This speeds up the calls tremendously (<1 ms vs. >3 s). */
222 /* To protect any system that could provide _nomembers functions
223 other than interix, check for HAVE_SETGROUPS, as interix is
224 one of the very few (the only?) platform that lacks it */
226 # if HAVE_GETGRGID_NOMEMBERS
227 # define getgrgid(gid) getgrgid_nomembers(gid)
229 # if HAVE_GETGRNAM_NOMEMBERS
230 # define getgrnam(nam) getgrnam_nomembers(nam)
232 # if HAVE_GETGRENT_NOMEMBERS
233 # define getgrent() getgrent_nomembers()
237 #if !HAVE_DECL_GETUID
244 /* This is simply a shorthand for the common case in which
245 the third argument to x2nrealloc would be 'sizeof *(P)'.
246 Ensure that sizeof *(P) is *not* 1. In that case, it'd be
247 better to use X2REALLOC, although not strictly necessary. */
248 #define X2NREALLOC(P, PN) verify_expr (sizeof *(P) != 1, \
249 x2nrealloc (P, PN, sizeof *(P)))
251 /* Using x2realloc (when appropriate) usually makes your code more
252 readable than using x2nrealloc, but it also makes it so your
253 code will malfunction if sizeof *(P) ever becomes 2 or greater.
254 So use this macro instead of using x2realloc directly. */
255 #define X2REALLOC(P, PN) verify_expr (sizeof *(P) == 1, \
258 #include "unlocked-io.h"
259 #include "same-inode.h"
265 dot_or_dotdot (char const *file_name
)
267 if (file_name
[0] == '.')
269 char sep
= file_name
[(file_name
[1] == '.') + 1];
270 return (! sep
|| ISSLASH (sep
));
276 /* A wrapper for readdir so that callers don't see entries for '.' or '..'. */
277 static inline struct dirent
const *
278 readdir_ignoring_dot_and_dotdot (DIR *dirp
)
282 struct dirent
const *dp
= readdir (dirp
);
283 if (dp
== NULL
|| ! dot_or_dotdot (dp
->d_name
))
288 /* Return true if DIR is determined to be an empty directory. */
290 is_empty_dir (int fd_cwd
, char const *dir
)
293 struct dirent
const *dp
;
295 int fd
= openat (fd_cwd
, dir
,
296 (O_RDONLY
| O_DIRECTORY
297 | O_NOCTTY
| O_NOFOLLOW
| O_NONBLOCK
));
302 dirp
= fdopendir (fd
);
310 dp
= readdir_ignoring_dot_and_dotdot (dirp
);
315 return saved_errno
== 0 ? true : false;
318 /* Factor out some of the common --help and --version processing code. */
320 /* These enum values cannot possibly conflict with the option values
321 ordinarily used by commands, including CHAR_MAX + 1, etc. Avoid
322 CHAR_MIN - 1, as it may equal -1, the getopt end-of-options value. */
325 GETOPT_HELP_CHAR
= (CHAR_MIN
- 2),
326 GETOPT_VERSION_CHAR
= (CHAR_MIN
- 3)
329 #define GETOPT_HELP_OPTION_DECL \
330 "help", no_argument, NULL, GETOPT_HELP_CHAR
331 #define GETOPT_VERSION_OPTION_DECL \
332 "version", no_argument, NULL, GETOPT_VERSION_CHAR
333 #define GETOPT_SELINUX_CONTEXT_OPTION_DECL \
334 "context", optional_argument, NULL, 'Z'
336 #define case_GETOPT_HELP_CHAR \
337 case GETOPT_HELP_CHAR: \
338 usage (EXIT_SUCCESS); \
341 /* Program_name must be a literal string.
342 Usually it is just PROGRAM_NAME. */
343 #define USAGE_BUILTIN_WARNING \
345 "NOTE: your shell may have its own version of %s, which usually supersedes\n" \
346 "the version described here. Please refer to your shell's documentation\n" \
347 "for details about the options it supports.\n")
349 #define HELP_OPTION_DESCRIPTION \
350 _(" --help display this help and exit\n")
351 #define VERSION_OPTION_DESCRIPTION \
352 _(" --version output version information and exit\n")
355 #include "closeout.h"
357 #define emit_bug_reporting_address unused__emit_bug_reporting_address
358 #include "version-etc.h"
359 #undef emit_bug_reporting_address
361 #include "propername.h"
362 /* Define away proper_name (leaving proper_name_utf8, which affects far
363 fewer programs), since it's not worth the cost of adding ~17KB to
364 the x86_64 text size of every single program. This avoids a 40%
365 (almost ~2MB) increase in the on-disk space utilization for the set
366 of the 100 binaries. */
367 #define proper_name(x) (x)
369 #include "progname.h"
371 #define case_GETOPT_VERSION_CHAR(Program_name, Authors) \
372 case GETOPT_VERSION_CHAR: \
373 version_etc (stdout, Program_name, PACKAGE_NAME, Version, Authors, \
375 exit (EXIT_SUCCESS); \
379 # define MAX(a, b) ((a) > (b) ? (a) : (b))
383 # define MIN(a,b) (((a) < (b)) ? (a) : (b))
386 #include "intprops.h"
389 # define SSIZE_MAX TYPE_MAXIMUM (ssize_t)
393 # define OFF_T_MIN TYPE_MINIMUM (off_t)
397 # define OFF_T_MAX TYPE_MAXIMUM (off_t)
401 # define UID_T_MAX TYPE_MAXIMUM (uid_t)
405 # define GID_T_MAX TYPE_MAXIMUM (gid_t)
409 # define PID_T_MAX TYPE_MAXIMUM (pid_t)
412 /* Use this to suppress gcc's '...may be used before initialized' warnings. */
414 # define IF_LINT(Code) Code
416 # define IF_LINT(Code) /* empty */
419 #ifndef __attribute__
420 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 8)
421 # define __attribute__(x) /* empty */
425 #ifndef ATTRIBUTE_NORETURN
426 # define ATTRIBUTE_NORETURN __attribute__ ((__noreturn__))
429 /* The warn_unused_result attribute appeared first in gcc-3.4.0 */
430 #undef ATTRIBUTE_WARN_UNUSED_RESULT
431 #if __GNUC__ < 3 || (__GNUC__ == 3 && __GNUC_MINOR__ < 4)
432 # define ATTRIBUTE_WARN_UNUSED_RESULT /* empty */
434 # define ATTRIBUTE_WARN_UNUSED_RESULT __attribute__ ((__warn_unused_result__))
438 # define LIKELY(cond) __builtin_expect ((cond), 1)
439 # define UNLIKELY(cond) __builtin_expect ((cond), 0)
441 # define LIKELY(cond) (cond)
442 # define UNLIKELY(cond) (cond)
447 # define ASSIGN_STRDUPA(DEST, S) \
448 do { DEST = strdupa (S); } while (0)
450 # define ASSIGN_STRDUPA(DEST, S) \
453 const char *s_ = (S); \
454 size_t len_ = strlen (s_) + 1; \
455 char *tmp_dest_ = alloca (len_); \
456 DEST = memcpy (tmp_dest_, s_, len_); \
462 # define sync() /* empty */
465 /* Compute the greatest common divisor of U and V using Euclid's
466 algorithm. U and V must be nonzero. */
468 static inline size_t _GL_ATTRIBUTE_CONST
469 gcd (size_t u
, size_t v
)
482 /* Compute the least common multiple of U and V. U and V must be
483 nonzero. There is no overflow checking, so callers should not
484 specify outlandish sizes. */
486 static inline size_t _GL_ATTRIBUTE_CONST
487 lcm (size_t u
, size_t v
)
489 return u
* (v
/ gcd (u
, v
));
492 /* Return PTR, aligned upward to the next multiple of ALIGNMENT.
493 ALIGNMENT must be nonzero. The caller must arrange for ((char *)
494 PTR) through ((char *) PTR + ALIGNMENT - 1) to be addressable
498 ptr_align (void const *ptr
, size_t alignment
)
500 char const *p0
= ptr
;
501 char const *p1
= p0
+ alignment
- 1;
502 return (void *) (p1
- (size_t) p1
% alignment
);
505 /* Return whether the buffer consists entirely of NULs.
506 Based on memeqzero in CCAN by Rusty Russell under CC0 (Public domain). */
508 static inline bool _GL_ATTRIBUTE_PURE
509 is_nul (void const *buf
, size_t length
)
511 const unsigned char *p
= buf
;
512 /* Using possibly unaligned access for the first 16 bytes
513 saves about 30-40 cycles, though it is strictly undefined behavior
514 and so would need __attribute__ ((__no_sanitize_undefined__))
515 to avoid -fsanitize=undefined warnings.
516 Considering coreutils is mainly concerned with relatively
517 large buffers, we'll just use the defined behavior. */
518 #if 0 && (_STRING_ARCH_unaligned || _STRING_INLINE_unaligned)
527 /* Check len bytes not aligned on a word. */
528 while (UNLIKELY (length
& (sizeof word
- 1)))
538 /* Check up to 16 bytes a word at a time. */
541 memcpy (&word
, p
, sizeof word
);
545 length
-= sizeof word
;
548 if (UNLIKELY (length
& 15) == 0)
552 /* Now we know first 16 bytes are NUL, memcmp with self. */
553 return memcmp (buf
, p
, length
) == 0;
556 /* If 10*Accum + Digit_val is larger than the maximum value for Type,
557 then don't update Accum and return false to indicate it would
558 overflow. Otherwise, set Accum to that new value and return true.
559 Verify at compile-time that Type is Accum's type, and that Type is
560 unsigned. Accum must be an object, so that we can take its
561 address. Accum and Digit_val may be evaluated multiple times.
563 The "Added check" below is not strictly required, but it causes GCC
564 to return a nonzero exit status instead of merely a warning
565 diagnostic, and that is more useful. */
567 #define DECIMAL_DIGIT_ACCUMULATE(Accum, Digit_val, Type) \
569 (void) (&(Accum) == (Type *) NULL), /* The type matches. */ \
570 verify_expr (! TYPE_SIGNED (Type), /* The type is unsigned. */ \
571 (((Type) -1 / 10 < (Accum) \
572 || (Type) ((Accum) * 10 + (Digit_val)) < (Accum)) \
574 : (((Accum) = (Accum) * 10 + (Digit_val)), true))) \
578 emit_stdin_note (void)
581 With no FILE, or when FILE is -, read standard input.\n\
585 emit_mandatory_arg_note (void)
588 Mandatory arguments to long options are mandatory for short options too.\n\
593 emit_size_note (void)
596 The SIZE argument is an integer and optional unit (example: 10K is 10*1024).\n\
597 Units are K,M,G,T,P,E,Z,Y (powers of 1024) or KB,MB,... (powers of 1000).\n\
598 Binary prefixes can be used, too: KiB=K, MiB=M, and so on.\n\
603 emit_blocksize_note (char const *program
)
606 Display values are in units of the first available SIZE from --block-size,\n\
607 and the %s_BLOCK_SIZE, BLOCK_SIZE and BLOCKSIZE environment variables.\n\
608 Otherwise, units default to 1024 bytes (or 512 if POSIXLY_CORRECT is set).\n\
613 emit_backup_suffix_note (void)
617 The backup suffix is '~', unless set with --suffix or SIMPLE_BACKUP_SUFFIX.\n\
618 The version control method may be selected via the --backup option or through\n\
619 the VERSION_CONTROL environment variable. Here are the values:\n\
623 none, off never make backups (even if --backup is given)\n\
624 numbered, t make numbered backups\n\
625 existing, nil numbered if numbered backups exist, simple otherwise\n\
626 simple, never always make simple backups\n\
631 emit_ancillary_info (char const *program
)
633 struct infomap
{ char const *program
; char const *node
; } const infomap
[] = {
634 { "[", "test invocation" },
635 { "coreutils", "Multi-call invocation" },
636 { "sha224sum", "sha2 utilities" },
637 { "sha256sum", "sha2 utilities" },
638 { "sha384sum", "sha2 utilities" },
639 { "sha512sum", "sha2 utilities" },
643 char const *node
= program
;
644 struct infomap
const *map_prog
= infomap
;
646 while (map_prog
->program
&& ! STREQ (program
, map_prog
->program
))
650 node
= map_prog
->node
;
652 printf (_("\n%s online help: <%s>\n"), PACKAGE_NAME
, PACKAGE_URL
);
654 /* Don't output this redundant message for English locales.
655 Note we still output for 'C' so that it gets included in the man page. */
656 const char *lc_messages
= setlocale (LC_MESSAGES
, NULL
);
657 if (lc_messages
&& STRNCMP_LIT (lc_messages
, "en_"))
659 /* TRANSLATORS: Replace LANG_CODE in this URL with your language code
660 <https://translationproject.org/team/LANG_CODE.html> to form one of
661 the URLs at https://translationproject.org/team/. Otherwise, replace
662 the entire URL with your translation team's email address. */
663 fputs (_("Report any translation bugs to "
664 "<https://translationproject.org/team/>\n"), stdout
);
666 printf (_("Full documentation <%s%s>\n"),
667 PACKAGE_URL
, program
);
668 printf (_("or available locally via: info '(coreutils) %s%s'\n"),
669 node
, node
== program
? " invocation" : "");
672 /* Use a macro rather than an inline function, as this references
673 the global program_name, which causes dynamic linking issues
674 in libstdbuf.so on some systems where unused functions
675 are not removed by the linker. */
676 #define emit_try_help() \
679 fprintf (stderr, _("Try '%s --help' for more information.\n"), \
684 #include "inttostr.h"
687 timetostr (time_t t
, char *buf
)
689 return (TYPE_SIGNED (time_t)
691 : umaxtostr (t
, buf
));
695 bad_cast (char const *s
)
700 /* Return a boolean indicating whether SB->st_size is defined. */
702 usable_st_size (struct stat
const *sb
)
704 return (S_ISREG (sb
->st_mode
) || S_ISLNK (sb
->st_mode
)
705 || S_TYPEISSHM (sb
) || S_TYPEISTMO (sb
));
708 void usage (int status
) ATTRIBUTE_NORETURN
;
710 /* Like error(0, 0, ...), but without an implicit newline.
711 Also a noop unless the global DEV_DEBUG is set. */
712 #define devmsg(...) \
716 fprintf (stderr, __VA_ARGS__); \
720 #define emit_cycle_warning(file_name) \
724 WARNING: Circular directory structure.\n\
725 This almost certainly means that you have a corrupted file system.\n\
726 NOTIFY YOUR SYSTEM MANAGER.\n\
727 The following directory is part of the cycle:\n %s\n"), \
728 quotef (file_name)); \
732 /* Like stpncpy, but do ensure that the result is NUL-terminated,
733 and do not NUL-pad out to LEN. I.e., when strnlen (src, len) == len,
734 this function writes a NUL byte into dest[len]. Thus, the length
735 of the destination buffer must be at least LEN + 1.
736 The DEST and SRC buffers must not overlap. */
738 stzncpy (char *restrict dest
, char const *restrict src
, size_t len
)
740 char const *src_end
= src
+ len
;
741 while (src
< src_end
&& *src
)
747 #ifndef ARRAY_CARDINALITY
748 # define ARRAY_CARDINALITY(Array) (sizeof (Array) / sizeof *(Array))
751 /* Avoid const warnings by casting to more portable type.
752 This is to cater for the incorrect const function declarations
753 in selinux.h before libselinux-2.3 (May 2014).
754 When version >= 2.3 is ubiquitous remove this function. */
755 static inline char * se_const (char const * sctx
) { return (char *) sctx
; }
757 /* Return true if ERR is ENOTSUP or EOPNOTSUPP, otherwise false.
758 This wrapper function avoids the redundant 'or'd comparison on
759 systems like Linux for which they have the same value. It also
760 avoids the gcc warning to that effect. */
764 return err
== EOPNOTSUPP
|| (ENOTSUP
!= EOPNOTSUPP
&& err
== ENOTSUP
);
768 /* How coreutils quotes filenames, to minimize use of outer quotes,
769 but also provide better support for copy and paste when used. */
770 #include "quotearg.h"
772 /* Use these to shell quote only when necessary,
773 when the quoted item is already delimited with colons. */
774 #define quotef(arg) \
775 quotearg_n_style_colon (0, shell_escape_quoting_style, arg)
776 #define quotef_n(n, arg) \
777 quotearg_n_style_colon (n, shell_escape_quoting_style, arg)
779 /* Use these when there are spaces around the file name,
780 in the error message. */
781 #define quoteaf(arg) \
782 quotearg_style (shell_escape_always_quoting_style, arg)
783 #define quoteaf_n(n, arg) \
784 quotearg_n_style (n, shell_escape_always_quoting_style, arg)
788 # define FALLTHROUGH ((void) 0)
790 # define FALLTHROUGH __attribute__ ((__fallthrough__))