src/shared/util.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #pragma once
   4
   5 /***
   6   This file is part of systemd.
   7
   8   Copyright 2010 Lennart Poettering
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  13   (at your option) any later version.
  14
  15   systemd is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 ***/
  23
  24 #include <alloca.h>
  25 #include <fcntl.h>
  26 #include <inttypes.h>
  27 #include <time.h>
  28 #include <stdarg.h>
  29 #include <stdbool.h>
  30 #include <stdlib.h>
  31 #include <stdio.h>
  32 #include <signal.h>
  33 #include <sched.h>
  34 #include <limits.h>
  35 #include <sys/types.h>
  36 #include <sys/socket.h>
  37 #include <sys/stat.h>
  38 #include <dirent.h>
  39 #include <stddef.h>
  40 #include <unistd.h>
  41 #include <locale.h>
  42 #include <mntent.h>
  43 #include <sys/inotify.h>
  44 #include <sys/statfs.h>
  45
  46 #if SIZEOF_PID_T == 4
  47 #  define PID_PRI PRIi32
  48 #elif SIZEOF_PID_T == 2
  49 #  define PID_PRI PRIi16
  50 #else
  51 #  error Unknown pid_t size
  52 #endif
  53 #define PID_FMT "%" PID_PRI
  54
  55 #if SIZEOF_UID_T == 4
  56 #  define UID_FMT "%" PRIu32
  57 #elif SIZEOF_UID_T == 2
  58 #  define UID_FMT "%" PRIu16
  59 #else
  60 #  error Unknown uid_t size
  61 #endif
  62
  63 #if SIZEOF_GID_T == 4
  64 #  define GID_FMT "%" PRIu32
  65 #elif SIZEOF_GID_T == 2
  66 #  define GID_FMT "%" PRIu16
  67 #else
  68 #  error Unknown gid_t size
  69 #endif
  70
  71 #if SIZEOF_TIME_T == 8
  72 #  define PRI_TIME PRIi64
  73 #elif SIZEOF_TIME_T == 4
  74 #  define PRI_TIME PRIu32
  75 #else
  76 #  error Unknown time_t size
  77 #endif
  78
  79 #if SIZEOF_RLIM_T == 8
  80 #  define RLIM_FMT "%" PRIu64
  81 #elif SIZEOF_RLIM_T == 4
  82 #  define RLIM_FMT "%" PRIu32
  83 #else
  84 #  error Unknown rlim_t size
  85 #endif
  86
  87 #include "macro.h"
  88 #include "missing.h"
  89 #include "time-util.h"
  90
  91 /* What is interpreted as whitespace? */
  92 #define WHITESPACE " \t\n\r"
  93 #define NEWLINE    "\n\r"
  94 #define QUOTES     "\"\'"
  95 #define COMMENTS   "#;"
  96 #define GLOB_CHARS "*?["
  97
  98 /* What characters are special in the shell? */
  99 /* must be escaped outside and inside double-quotes */
 100 #define SHELL_NEED_ESCAPE "\"\\`$"
 101 /* can be escaped or double-quoted */
 102 #define SHELL_NEED_QUOTES SHELL_NEED_ESCAPE GLOB_CHARS "'()<>|&;"
 103
 104 #define FORMAT_BYTES_MAX 8
 105
 106 #define ANSI_HIGHLIGHT_ON "\x1B[1;39m"
 107 #define ANSI_RED_ON "\x1B[31m"
 108 #define ANSI_HIGHLIGHT_RED_ON "\x1B[1;31m"
 109 #define ANSI_GREEN_ON "\x1B[32m"
 110 #define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
 111 #define ANSI_HIGHLIGHT_YELLOW_ON "\x1B[1;33m"
 112 #define ANSI_HIGHLIGHT_BLUE_ON "\x1B[1;34m"
 113 #define ANSI_HIGHLIGHT_OFF "\x1B[0m"
 114 #define ANSI_ERASE_TO_END_OF_LINE "\x1B[K"
 115
 116 size_t page_size(void) _pure_;
 117 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
 118
 119 #define streq(a,b) (strcmp((a),(b)) == 0)
 120 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
 121 #define strcaseeq(a,b) (strcasecmp((a),(b)) == 0)
 122 #define strncaseeq(a, b, n) (strncasecmp((a), (b), (n)) == 0)
 123
 124 bool streq_ptr(const char *a, const char *b) _pure_;
 125
 126 #define new(t, n) ((t*) malloc_multiply(sizeof(t), (n)))
 127
 128 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
 129
 130 #define newa(t, n) ((t*) alloca(sizeof(t)*(n)))
 131
 132 #define newa0(t, n) ((t*) alloca0(sizeof(t)*(n)))
 133
 134 #define newdup(t, p, n) ((t*) memdup_multiply(p, sizeof(t), (n)))
 135
 136 #define malloc0(n) (calloc((n), 1))
 137
 138 static inline const char* yes_no(bool b) {
 139         return b ? "yes" : "no";
 140 }
 141
 142 static inline const char* true_false(bool b) {
 143         return b ? "true" : "false";
 144 }
 145
 146 static inline const char* one_zero(bool b) {
 147         return b ? "1" : "0";
 148 }
 149
 150 static inline const char* strempty(const char *s) {
 151         return s ? s : "";
 152 }
 153
 154 static inline const char* strnull(const char *s) {
 155         return s ? s : "(null)";
 156 }
 157
 158 static inline const char *strna(const char *s) {
 159         return s ? s : "n/a";
 160 }
 161
 162 static inline bool isempty(const char *p) {
 163         return !p || !p[0];
 164 }
 165
 166 static inline char *startswith(const char *s, const char *prefix) {
 167         size_t l;
 168
 169         l = strlen(prefix);
 170         if (strncmp(s, prefix, l) == 0)
 171                 return (char*) s + l;
 172
 173         return NULL;
 174 }
 175
 176 static inline char *startswith_no_case(const char *s, const char *prefix) {
 177         size_t l;
 178
 179         l = strlen(prefix);
 180         if (strncasecmp(s, prefix, l) == 0)
 181                 return (char*) s + l;
 182
 183         return NULL;
 184 }
 185
 186 char *endswith(const char *s, const char *postfix) _pure_;
 187 char *endswith_no_case(const char *s, const char *postfix) _pure_;
 188
 189 char *first_word(const char *s, const char *word) _pure_;
 190
 191 int close_nointr(int fd);
 192 int safe_close(int fd);
 193 void safe_close_pair(int p[]);
 194
 195 void close_many(const int fds[], unsigned n_fd);
 196
 197 int parse_size(const char *t, off_t base, off_t *size);
 198
 199 int parse_boolean(const char *v) _pure_;
 200 int parse_pid(const char *s, pid_t* ret_pid);
 201 int parse_uid(const char *s, uid_t* ret_uid);
 202 #define parse_gid(s, ret_uid) parse_uid(s, ret_uid)
 203
 204 int safe_atou(const char *s, unsigned *ret_u);
 205 int safe_atoi(const char *s, int *ret_i);
 206
 207 int safe_atollu(const char *s, unsigned long long *ret_u);
 208 int safe_atolli(const char *s, long long int *ret_i);
 209
 210 int safe_atod(const char *s, double *ret_d);
 211
 212 int safe_atou8(const char *s, uint8_t *ret);
 213
 214 #if LONG_MAX == INT_MAX
 215 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
 216         assert_cc(sizeof(unsigned long) == sizeof(unsigned));
 217         return safe_atou(s, (unsigned*) ret_u);
 218 }
 219 static inline int safe_atoli(const char *s, long int *ret_u) {
 220         assert_cc(sizeof(long int) == sizeof(int));
 221         return safe_atoi(s, (int*) ret_u);
 222 }
 223 #else
 224 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
 225         assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
 226         return safe_atollu(s, (unsigned long long*) ret_u);
 227 }
 228 static inline int safe_atoli(const char *s, long int *ret_u) {
 229         assert_cc(sizeof(long int) == sizeof(long long int));
 230         return safe_atolli(s, (long long int*) ret_u);
 231 }
 232 #endif
 233
 234 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
 235         assert_cc(sizeof(uint32_t) == sizeof(unsigned));
 236         return safe_atou(s, (unsigned*) ret_u);
 237 }
 238
 239 static inline int safe_atoi32(const char *s, int32_t *ret_i) {
 240         assert_cc(sizeof(int32_t) == sizeof(int));
 241         return safe_atoi(s, (int*) ret_i);
 242 }
 243
 244 static inline int safe_atou64(const char *s, uint64_t *ret_u) {
 245         assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
 246         return safe_atollu(s, (unsigned long long*) ret_u);
 247 }
 248
 249 static inline int safe_atoi64(const char *s, int64_t *ret_i) {
 250         assert_cc(sizeof(int64_t) == sizeof(long long int));
 251         return safe_atolli(s, (long long int*) ret_i);
 252 }
 253
 254 int safe_atou16(const char *s, uint16_t *ret);
 255 int safe_atoi16(const char *s, int16_t *ret);
 256
 257 const char* split(const char **state, size_t *l, const char *separator, bool quoted);
 258
 259 #define FOREACH_WORD(word, length, s, state)                            \
 260         _FOREACH_WORD(word, length, s, WHITESPACE, false, state)
 261
 262 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state)       \
 263         _FOREACH_WORD(word, length, s, separator, false, state)
 264
 265 #define FOREACH_WORD_QUOTED(word, length, s, state)                     \
 266         _FOREACH_WORD(word, length, s, WHITESPACE, true, state)
 267
 268 #define _FOREACH_WORD(word, length, s, separator, quoted, state)        \
 269         for ((state) = (s), (word) = split(&(state), &(length), (separator), (quoted)); (word); (word) = split(&(state), &(length), (separator), (quoted)))
 270
 271 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
 272
 273 char *strappend(const char *s, const char *suffix);
 274 char *strnappend(const char *s, const char *suffix, size_t length);
 275
 276 char *replace_env(const char *format, char **env);
 277 char **replace_env_argv(char **argv, char **env);
 278
 279 int readlinkat_malloc(int fd, const char *p, char **ret);
 280 int readlink_malloc(const char *p, char **r);
 281 int readlink_value(const char *p, char **ret);
 282 int readlink_and_make_absolute(const char *p, char **r);
 283 int readlink_and_canonicalize(const char *p, char **r);
 284
 285 int reset_all_signal_handlers(void);
 286 int reset_signal_mask(void);
 287
 288 char *strstrip(char *s);
 289 char *delete_chars(char *s, const char *bad);
 290 char *truncate_nl(char *s);
 291
 292 char *file_in_same_dir(const char *path, const char *filename);
 293
 294 int rmdir_parents(const char *path, const char *stop);
 295
 296 int get_process_state(pid_t pid);
 297 int get_process_comm(pid_t pid, char **name);
 298 int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
 299 int get_process_exe(pid_t pid, char **name);
 300 int get_process_uid(pid_t pid, uid_t *uid);
 301 int get_process_gid(pid_t pid, gid_t *gid);
 302 int get_process_capeff(pid_t pid, char **capeff);
 303 int get_process_cwd(pid_t pid, char **cwd);
 304 int get_process_root(pid_t pid, char **root);
 305 int get_process_environ(pid_t pid, char **environ);
 306
 307 char hexchar(int x) _const_;
 308 int unhexchar(char c) _const_;
 309 char octchar(int x) _const_;
 310 int unoctchar(char c) _const_;
 311 char decchar(int x) _const_;
 312 int undecchar(char c) _const_;
 313
 314 char *cescape(const char *s);
 315
 316 typedef enum UnescapeFlags {
 317         UNESCAPE_RELAX = 1,
 318 } UnescapeFlags;
 319
 320 int cunescape(const char *s, UnescapeFlags flags, char **ret);
 321 int cunescape_length(const char *s, size_t length, UnescapeFlags flags, char **ret);
 322 int cunescape_length_with_prefix(const char *s, size_t length, const char *prefix, UnescapeFlags flags, char **ret);
 323
 324 char *xescape(const char *s, const char *bad);
 325
 326 char *ascii_strlower(char *path);
 327
 328 bool dirent_is_file(const struct dirent *de) _pure_;
 329 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix) _pure_;
 330
 331 bool hidden_file(const char *filename) _pure_;
 332
 333 bool chars_intersect(const char *a, const char *b) _pure_;
 334
 335 int make_stdio(int fd);
 336 int make_null_stdio(void);
 337 int make_console_stdio(void);
 338
 339 int dev_urandom(void *p, size_t n);
 340 void random_bytes(void *p, size_t n);
 341 void initialize_srand(void);
 342
 343 static inline uint64_t random_u64(void) {
 344         uint64_t u;
 345         random_bytes(&u, sizeof(u));
 346         return u;
 347 }
 348
 349 static inline uint32_t random_u32(void) {
 350         uint32_t u;
 351         random_bytes(&u, sizeof(u));
 352         return u;
 353 }
 354
 355 /* For basic lookup tables with strictly enumerated entries */
 356 #define _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope)          \
 357         scope const char *name##_to_string(type i) {                    \
 358                 if (i < 0 || i >= (type) ELEMENTSOF(name##_table))      \
 359                         return NULL;                                    \
 360                 return name##_table[i];                                 \
 361         }
 362
 363 ssize_t string_table_lookup(const char * const *table, size_t len, const char *key);
 364
 365 #define _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope)                                \
 366         scope inline type name##_from_string(const char *s) {                                   \
 367                 return (type)string_table_lookup(name##_table, ELEMENTSOF(name##_table), s);    \
 368         }
 369
 370 #define _DEFINE_STRING_TABLE_LOOKUP(name,type,scope)                    \
 371         _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope)          \
 372         _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope)        \
 373         struct __useless_struct_to_allow_trailing_semicolon__
 374
 375 #define DEFINE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,)
 376 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,static)
 377 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_TO_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,static)
 378 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_FROM_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,static)
 379
 380 /* For string conversions where numbers are also acceptable */
 381 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max)         \
 382         int name##_to_string_alloc(type i, char **str) {                \
 383                 char *s;                                                \
 384                 int r;                                                  \
 385                 if (i < 0 || i > max)                                   \
 386                         return -ERANGE;                                 \
 387                 if (i < (type) ELEMENTSOF(name##_table)) {              \
 388                         s = strdup(name##_table[i]);                    \
 389                         if (!s)                                         \
 390                                 return log_oom();                       \
 391                 } else {                                                \
 392                         r = asprintf(&s, "%i", i);                      \
 393                         if (r < 0)                                      \
 394                                 return log_oom();                       \
 395                 }                                                       \
 396                 *str = s;                                               \
 397                 return 0;                                               \
 398         }                                                               \
 399         type name##_from_string(const char *s) {                        \
 400                 type i;                                                 \
 401                 unsigned u = 0;                                         \
 402                 assert(s);                                              \
 403                 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
 404                         if (name##_table[i] &&                          \
 405                             streq(name##_table[i], s))                  \
 406                                 return i;                               \
 407                 if (safe_atou(s, &u) >= 0 && u <= max)                  \
 408                         return (type) u;                                \
 409                 return (type) -1;                                       \
 410         }                                                               \
 411         struct __useless_struct_to_allow_trailing_semicolon__
 412
 413 int fd_nonblock(int fd, bool nonblock);
 414 int fd_cloexec(int fd, bool cloexec);
 415
 416 int close_all_fds(const int except[], unsigned n_except);
 417
 418 bool fstype_is_network(const char *fstype);
 419
 420 int chvt(int vt);
 421
 422 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
 423 int ask_char(char *ret, const char *replies, const char *text, ...) _printf_(3, 4);
 424 int ask_string(char **ret, const char *text, ...) _printf_(2, 3);
 425
 426 int reset_terminal_fd(int fd, bool switch_to_text);
 427 int reset_terminal(const char *name);
 428
 429 int open_terminal(const char *name, int mode);
 430 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
 431 int release_terminal(void);
 432
 433 int flush_fd(int fd);
 434
 435 int ignore_signals(int sig, ...);
 436 int default_signals(int sig, ...);
 437 int sigaction_many(const struct sigaction *sa, ...);
 438
 439 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
 440
 441 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
 442 int loop_read_exact(int fd, void *buf, size_t nbytes, bool do_poll);
 443 int loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
 444
 445 bool is_device_path(const char *path);
 446
 447 int dir_is_empty(const char *path);
 448 char* dirname_malloc(const char *path);
 449
 450 void rename_process(const char name[8]);
 451
 452 void sigset_add_many(sigset_t *ss, ...);
 453 int sigprocmask_many(int how, ...);
 454
 455 bool hostname_is_set(void);
 456
 457 char* lookup_uid(uid_t uid);
 458 char* gethostname_malloc(void);
 459 char* getlogname_malloc(void);
 460 char* getusername_malloc(void);
 461
 462 int getttyname_malloc(int fd, char **r);
 463 int getttyname_harder(int fd, char **r);
 464
 465 int get_ctty_devnr(pid_t pid, dev_t *d);
 466 int get_ctty(pid_t, dev_t *_devnr, char **r);
 467
 468 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
 469 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
 470
 471 bool is_temporary_fs(const struct statfs *s) _pure_;
 472 int fd_is_temporary_fs(int fd);
 473
 474 int pipe_eof(int fd);
 475
 476 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
 477
 478 int status_vprintf(const char *status, bool ellipse, bool ephemeral, const char *format, va_list ap) _printf_(4,0);
 479 int status_printf(const char *status, bool ellipse, bool ephemeral, const char *format, ...) _printf_(4,5);
 480
 481 #define xsprintf(buf, fmt, ...) assert_se((size_t) snprintf(buf, ELEMENTSOF(buf), fmt, __VA_ARGS__) < ELEMENTSOF(buf))
 482
 483 int fd_columns(int fd);
 484 unsigned columns(void);
 485 int fd_lines(int fd);
 486 unsigned lines(void);
 487 void columns_lines_cache_reset(int _unused_ signum);
 488
 489 bool on_tty(void);
 490
 491 static inline const char *ansi_highlight(void) {
 492         return on_tty() ? ANSI_HIGHLIGHT_ON : "";
 493 }
 494
 495 static inline const char *ansi_highlight_red(void) {
 496         return on_tty() ? ANSI_HIGHLIGHT_RED_ON : "";
 497 }
 498
 499 static inline const char *ansi_highlight_green(void) {
 500         return on_tty() ? ANSI_HIGHLIGHT_GREEN_ON : "";
 501 }
 502
 503 static inline const char *ansi_highlight_yellow(void) {
 504         return on_tty() ? ANSI_HIGHLIGHT_YELLOW_ON : "";
 505 }
 506
 507 static inline const char *ansi_highlight_blue(void) {
 508         return on_tty() ? ANSI_HIGHLIGHT_BLUE_ON : "";
 509 }
 510
 511 static inline const char *ansi_highlight_off(void) {
 512         return on_tty() ? ANSI_HIGHLIGHT_OFF : "";
 513 }
 514
 515 int files_same(const char *filea, const char *fileb);
 516
 517 int running_in_chroot(void);
 518
 519 char *ellipsize(const char *s, size_t length, unsigned percent);
 520                                    /* bytes                 columns */
 521 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
 522
 523 int touch_file(const char *path, bool parents, usec_t stamp, uid_t uid, gid_t gid, mode_t mode);
 524 int touch(const char *path);
 525
 526 char *normalize_env_assignment(const char *s);
 527
 528 int wait_for_terminate(pid_t pid, siginfo_t *status);
 529 int wait_for_terminate_and_warn(const char *name, pid_t pid, bool check_exit_code);
 530
 531 noreturn void freeze(void);
 532
 533 bool null_or_empty(struct stat *st) _pure_;
 534 int null_or_empty_path(const char *fn);
 535 int null_or_empty_fd(int fd);
 536
 537 DIR *xopendirat(int dirfd, const char *name, int flags);
 538
 539 char *fstab_node_to_udev_node(const char *p);
 540
 541 char *resolve_dev_console(char **active);
 542 bool tty_is_vc(const char *tty);
 543 bool tty_is_vc_resolve(const char *tty);
 544 bool tty_is_console(const char *tty) _pure_;
 545 int vtnr_from_tty(const char *tty);
 546 const char *default_term_for_tty(const char *tty);
 547
 548 void execute_directories(const char* const* directories, usec_t timeout, char *argv[]);
 549
 550 int kill_and_sigcont(pid_t pid, int sig);
 551
 552 bool nulstr_contains(const char*nulstr, const char *needle);
 553
 554 bool plymouth_running(void);
 555
 556 bool hostname_is_valid(const char *s) _pure_;
 557 char* hostname_cleanup(char *s, bool lowercase);
 558
 559 bool machine_name_is_valid(const char *s) _pure_;
 560
 561 char* strshorten(char *s, size_t l);
 562
 563 int terminal_vhangup_fd(int fd);
 564 int terminal_vhangup(const char *name);
 565
 566 int vt_disallocate(const char *name);
 567
 568 int symlink_atomic(const char *from, const char *to);
 569 int mknod_atomic(const char *path, mode_t mode, dev_t dev);
 570 int mkfifo_atomic(const char *path, mode_t mode);
 571
 572 int fchmod_umask(int fd, mode_t mode);
 573
 574 bool display_is_local(const char *display) _pure_;
 575 int socket_from_display(const char *display, char **path);
 576
 577 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
 578 int get_group_creds(const char **groupname, gid_t *gid);
 579
 580 int in_gid(gid_t gid);
 581 int in_group(const char *name);
 582
 583 char* uid_to_name(uid_t uid);
 584 char* gid_to_name(gid_t gid);
 585
 586 int glob_exists(const char *path);
 587 int glob_extend(char ***strv, const char *path);
 588
 589 int dirent_ensure_type(DIR *d, struct dirent *de);
 590
 591 int get_files_in_directory(const char *path, char ***list);
 592
 593 char *strjoin(const char *x, ...) _sentinel_;
 594
 595 bool is_main_thread(void);
 596
 597 static inline bool _pure_ in_charset(const char *s, const char* charset) {
 598         assert(s);
 599         assert(charset);
 600         return s[strspn(s, charset)] == '\0';
 601 }
 602
 603 int block_get_whole_disk(dev_t d, dev_t *ret);
 604
 605 #define NULSTR_FOREACH(i, l)                                    \
 606         for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
 607
 608 #define NULSTR_FOREACH_PAIR(i, j, l)                             \
 609         for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
 610
 611 int ioprio_class_to_string_alloc(int i, char **s);
 612 int ioprio_class_from_string(const char *s);
 613
 614 const char *sigchld_code_to_string(int i) _const_;
 615 int sigchld_code_from_string(const char *s) _pure_;
 616
 617 int log_facility_unshifted_to_string_alloc(int i, char **s);
 618 int log_facility_unshifted_from_string(const char *s);
 619
 620 int log_level_to_string_alloc(int i, char **s);
 621 int log_level_from_string(const char *s);
 622
 623 int sched_policy_to_string_alloc(int i, char **s);
 624 int sched_policy_from_string(const char *s);
 625
 626 const char *rlimit_to_string(int i) _const_;
 627 int rlimit_from_string(const char *s) _pure_;
 628
 629 int ip_tos_to_string_alloc(int i, char **s);
 630 int ip_tos_from_string(const char *s);
 631
 632 const char *signal_to_string(int i) _const_;
 633 int signal_from_string(const char *s) _pure_;
 634
 635 int signal_from_string_try_harder(const char *s);
 636
 637 extern int saved_argc;
 638 extern char **saved_argv;
 639
 640 bool kexec_loaded(void);
 641
 642 int prot_from_flags(int flags) _const_;
 643
 644 char *format_bytes(char *buf, size_t l, off_t t);
 645
 646 int fd_wait_for_event(int fd, int event, usec_t timeout);
 647
 648 void* memdup(const void *p, size_t l) _alloc_(2);
 649
 650 int is_kernel_thread(pid_t pid);
 651
 652 int fd_inc_sndbuf(int fd, size_t n);
 653 int fd_inc_rcvbuf(int fd, size_t n);
 654
 655 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
 656
 657 int setrlimit_closest(int resource, const struct rlimit *rlim);
 658
 659 int getenv_for_pid(pid_t pid, const char *field, char **_value);
 660
 661 bool http_url_is_valid(const char *url) _pure_;
 662 bool documentation_url_is_valid(const char *url) _pure_;
 663
 664 bool http_etag_is_valid(const char *etag);
 665
 666 bool in_initrd(void);
 667
 668 void warn_melody(void);
 669
 670 int get_home_dir(char **ret);
 671 int get_shell(char **_ret);
 672
 673 static inline void freep(void *p) {
 674         free(*(void**) p);
 675 }
 676
 677 static inline void closep(int *fd) {
 678         safe_close(*fd);
 679 }
 680
 681 static inline void umaskp(mode_t *u) {
 682         umask(*u);
 683 }
 684
 685 static inline void close_pairp(int (*p)[2]) {
 686         safe_close_pair(*p);
 687 }
 688
 689 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, fclose);
 690 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, pclose);
 691 DEFINE_TRIVIAL_CLEANUP_FUNC(DIR*, closedir);
 692 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, endmntent);
 693
 694 #define _cleanup_free_ _cleanup_(freep)
 695 #define _cleanup_close_ _cleanup_(closep)
 696 #define _cleanup_umask_ _cleanup_(umaskp)
 697 #define _cleanup_globfree_ _cleanup_(globfree)
 698 #define _cleanup_fclose_ _cleanup_(fclosep)
 699 #define _cleanup_pclose_ _cleanup_(pclosep)
 700 #define _cleanup_closedir_ _cleanup_(closedirp)
 701 #define _cleanup_endmntent_ _cleanup_(endmntentp)
 702 #define _cleanup_close_pair_ _cleanup_(close_pairp)
 703
 704 _malloc_  _alloc_(1, 2) static inline void *malloc_multiply(size_t a, size_t b) {
 705         if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
 706                 return NULL;
 707
 708         return malloc(a * b);
 709 }
 710
 711 _alloc_(2, 3) static inline void *realloc_multiply(void *p, size_t a, size_t b) {
 712         if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
 713                 return NULL;
 714
 715         return realloc(p, a * b);
 716 }
 717
 718 _alloc_(2, 3) static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
 719         if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
 720                 return NULL;
 721
 722         return memdup(p, a * b);
 723 }
 724
 725 bool filename_is_valid(const char *p) _pure_;
 726 bool path_is_safe(const char *p) _pure_;
 727 bool string_is_safe(const char *p) _pure_;
 728 bool string_has_cc(const char *p, const char *ok) _pure_;
 729
 730 /**
 731  * Check if a string contains any glob patterns.
 732  */
 733 _pure_ static inline bool string_is_glob(const char *p) {
 734         return !!strpbrk(p, GLOB_CHARS);
 735 }
 736
 737 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
 738                  int (*compar) (const void *, const void *, void *),
 739                  void *arg);
 740
 741 #define _(String) gettext (String)
 742 void init_gettext(void);
 743 bool is_locale_utf8(void);
 744
 745 typedef enum DrawSpecialChar {
 746         DRAW_TREE_VERTICAL,
 747         DRAW_TREE_BRANCH,
 748         DRAW_TREE_RIGHT,
 749         DRAW_TREE_SPACE,
 750         DRAW_TRIANGULAR_BULLET,
 751         DRAW_BLACK_CIRCLE,
 752         DRAW_ARROW,
 753         DRAW_DASH,
 754         _DRAW_SPECIAL_CHAR_MAX
 755 } DrawSpecialChar;
 756
 757 const char *draw_special_char(DrawSpecialChar ch);
 758
 759 char *strreplace(const char *text, const char *old_string, const char *new_string);
 760
 761 char *strip_tab_ansi(char **p, size_t *l);
 762
 763 int on_ac_power(void);
 764
 765 int search_and_fopen(const char *path, const char *mode, const char *root, const char **search, FILE **_f);
 766 int search_and_fopen_nulstr(const char *path, const char *mode, const char *root, const char *search, FILE **_f);
 767
 768 #define FOREACH_LINE(line, f, on_error)                         \
 769         for (;;)                                                \
 770                 if (!fgets(line, sizeof(line), f)) {            \
 771                         if (ferror(f)) {                        \
 772                                 on_error;                       \
 773                         }                                       \
 774                         break;                                  \
 775                 } else
 776
 777 #define FOREACH_DIRENT(de, d, on_error)                                 \
 778         for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d))   \
 779                 if (!de) {                                              \
 780                         if (errno > 0) {                                \
 781                                 on_error;                               \
 782                         }                                               \
 783                         break;                                          \
 784                 } else if (hidden_file((de)->d_name))                   \
 785                         continue;                                       \
 786                 else
 787
 788 #define FOREACH_DIRENT_ALL(de, d, on_error)                             \
 789         for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d))   \
 790                 if (!de) {                                              \
 791                         if (errno > 0) {                                \
 792                                 on_error;                               \
 793                         }                                               \
 794                         break;                                          \
 795                 } else
 796
 797 static inline void *mempset(void *s, int c, size_t n) {
 798         memset(s, c, n);
 799         return (uint8_t*)s + n;
 800 }
 801
 802 char *hexmem(const void *p, size_t l);
 803 void *unhexmem(const char *p, size_t l);
 804
 805 char *strextend(char **x, ...) _sentinel_;
 806 char *strrep(const char *s, unsigned n);
 807
 808 void* greedy_realloc(void **p, size_t *allocated, size_t need, size_t size);
 809 void* greedy_realloc0(void **p, size_t *allocated, size_t need, size_t size);
 810 #define GREEDY_REALLOC(array, allocated, need)                          \
 811         greedy_realloc((void**) &(array), &(allocated), (need), sizeof((array)[0]))
 812
 813 #define GREEDY_REALLOC0(array, allocated, need)                         \
 814         greedy_realloc0((void**) &(array), &(allocated), (need), sizeof((array)[0]))
 815
 816 static inline void _reset_errno_(int *saved_errno) {
 817         errno = *saved_errno;
 818 }
 819
 820 #define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
 821
 822 static inline int negative_errno(void) {
 823         /* This helper should be used to shut up gcc if you know 'errno' is
 824          * negative. Instead of "return -errno;", use "return negative_errno();"
 825          * It will suppress bogus gcc warnings in case it assumes 'errno' might
 826          * be 0 and thus the caller's error-handling might not be triggered. */
 827         assert_return(errno > 0, -EINVAL);
 828         return -errno;
 829 }
 830
 831 struct _umask_struct_ {
 832         mode_t mask;
 833         bool quit;
 834 };
 835
 836 static inline void _reset_umask_(struct _umask_struct_ *s) {
 837         umask(s->mask);
 838 };
 839
 840 #define RUN_WITH_UMASK(mask)                                            \
 841         for (_cleanup_(_reset_umask_) struct _umask_struct_ _saved_umask_ = { umask(mask), false }; \
 842              !_saved_umask_.quit ;                                      \
 843              _saved_umask_.quit = true)
 844
 845 static inline unsigned u64log2(uint64_t n) {
 846 #if __SIZEOF_LONG_LONG__ == 8
 847         return (n > 1) ? (unsigned) __builtin_clzll(n) ^ 63U : 0;
 848 #else
 849 #error "Wut?"
 850 #endif
 851 }
 852
 853 static inline unsigned u32ctz(uint32_t n) {
 854 #if __SIZEOF_INT__ == 4
 855         return __builtin_ctz(n);
 856 #else
 857 #error "Wut?"
 858 #endif
 859 }
 860
 861 static inline unsigned log2i(int x) {
 862         assert(x > 0);
 863
 864         return __SIZEOF_INT__ * 8 - __builtin_clz(x) - 1;
 865 }
 866
 867 static inline unsigned log2u(unsigned x) {
 868         assert(x > 0);
 869
 870         return sizeof(unsigned) * 8 - __builtin_clz(x) - 1;
 871 }
 872
 873 static inline unsigned log2u_round_up(unsigned x) {
 874         assert(x > 0);
 875
 876         if (x == 1)
 877                 return 0;
 878
 879         return log2u(x - 1) + 1;
 880 }
 881
 882 static inline bool logind_running(void) {
 883         return access("/run/systemd/seats/", F_OK) >= 0;
 884 }
 885
 886 #define DECIMAL_STR_WIDTH(x)                            \
 887         ({                                              \
 888                 typeof(x) _x_ = (x);                    \
 889                 unsigned ans = 1;                       \
 890                 while (_x_ /= 10)                       \
 891                         ans++;                          \
 892                 ans;                                    \
 893         })
 894
 895 int unlink_noerrno(const char *path);
 896
 897 #define alloca0(n)                                      \
 898         ({                                              \
 899                 char *_new_;                            \
 900                 size_t _len_ = n;                       \
 901                 _new_ = alloca(_len_);                  \
 902                 (void *) memset(_new_, 0, _len_);       \
 903         })
 904
 905 /* It's not clear what alignment glibc/gcc alloca() guarantee, hence provide a guaranteed safe version */
 906 #define alloca_align(size, align)                                       \
 907         ({                                                              \
 908                 void *_ptr_;                                            \
 909                 size_t _mask_ = (align) - 1;                            \
 910                 _ptr_ = alloca((size) + _mask_);                        \
 911                 (void*)(((uintptr_t)_ptr_ + _mask_) & ~_mask_);         \
 912         })
 913
 914 #define alloca0_align(size, align)                                      \
 915         ({                                                              \
 916                 void *_new_;                                            \
 917                 size_t _size_ = (size);                                 \
 918                 _new_ = alloca_align(_size_, (align));                  \
 919                 (void*)memset(_new_, 0, _size_);                        \
 920         })
 921
 922 #define strjoina(a, ...)                                                \
 923         ({                                                              \
 924                 const char *_appendees_[] = { a, __VA_ARGS__ };         \
 925                 char *_d_, *_p_;                                        \
 926                 int _len_ = 0;                                          \
 927                 unsigned _i_;                                           \
 928                 for (_i_ = 0; _i_ < ELEMENTSOF(_appendees_) && _appendees_[_i_]; _i_++) \
 929                         _len_ += strlen(_appendees_[_i_]);              \
 930                 _p_ = _d_ = alloca(_len_ + 1);                          \
 931                 for (_i_ = 0; _i_ < ELEMENTSOF(_appendees_) && _appendees_[_i_]; _i_++) \
 932                         _p_ = stpcpy(_p_, _appendees_[_i_]);            \
 933                 *_p_ = 0;                                               \
 934                 _d_;                                                    \
 935         })
 936
 937 #define procfs_file_alloca(pid, field)                                  \
 938         ({                                                              \
 939                 pid_t _pid_ = (pid);                                    \
 940                 const char *_r_;                                        \
 941                 if (_pid_ == 0) {                                       \
 942                         _r_ = ("/proc/self/" field);                    \
 943                 } else {                                                \
 944                         _r_ = alloca(strlen("/proc/") + DECIMAL_STR_MAX(pid_t) + 1 + sizeof(field)); \
 945                         sprintf((char*) _r_, "/proc/"PID_FMT"/" field, _pid_);                       \
 946                 }                                                       \
 947                 _r_;                                                    \
 948         })
 949
 950 bool id128_is_valid(const char *s) _pure_;
 951
 952 int split_pair(const char *s, const char *sep, char **l, char **r);
 953
 954 int shall_restore_state(void);
 955
 956 /**
 957  * Normal qsort requires base to be nonnull. Here were require
 958  * that only if nmemb > 0.
 959  */
 960 static inline void qsort_safe(void *base, size_t nmemb, size_t size,
 961                               int (*compar)(const void *, const void *)) {
 962         if (nmemb) {
 963                 assert(base);
 964                 qsort(base, nmemb, size, compar);
 965         }
 966 }
 967
 968 int proc_cmdline(char **ret);
 969 int parse_proc_cmdline(int (*parse_word)(const char *key, const char *value));
 970 int get_proc_cmdline_key(const char *parameter, char **value);
 971
 972 int container_get_leader(const char *machine, pid_t *pid);
 973
 974 int namespace_open(pid_t pid, int *pidns_fd, int *mntns_fd, int *netns_fd, int *root_fd);
 975 int namespace_enter(int pidns_fd, int mntns_fd, int netns_fd, int root_fd);
 976
 977 bool pid_is_alive(pid_t pid);
 978 bool pid_is_unwaited(pid_t pid);
 979
 980 int getpeercred(int fd, struct ucred *ucred);
 981 int getpeersec(int fd, char **ret);
 982
 983 int writev_safe(int fd, const struct iovec *w, int j);
 984
 985 int mkostemp_safe(char *pattern, int flags);
 986 int open_tmpfile(const char *path, int flags);
 987
 988 int fd_warn_permissions(const char *path, int fd);
 989
 990 unsigned long personality_from_string(const char *p);
 991 const char *personality_to_string(unsigned long);
 992
 993 uint64_t physical_memory(void);
 994
 995 void hexdump(FILE *f, const void *p, size_t s);
 996
 997 union file_handle_union {
 998         struct file_handle handle;
 999         char padding[sizeof(struct file_handle) + MAX_HANDLE_SZ];
1000 };
1001 #define FILE_HANDLE_INIT { .handle.handle_bytes = MAX_HANDLE_SZ }
1002
1003 int update_reboot_param_file(const char *param);
1004
1005 int umount_recursive(const char *target, int flags);
1006
1007 int bind_remount_recursive(const char *prefix, bool ro);
1008
1009 int fflush_and_check(FILE *f);
1010
1011 int tempfn_xxxxxx(const char *p, char **ret);
1012 int tempfn_random(const char *p, char **ret);
1013 int tempfn_random_child(const char *p, char **ret);
1014
1015 bool is_localhost(const char *hostname);
1016
1017 int take_password_lock(const char *root);
1018
1019 int is_symlink(const char *path);
1020 int is_dir(const char *path, bool follow);
1021
1022 typedef enum UnquoteFlags {
1023         UNQUOTE_RELAX     = 1,
1024         UNQUOTE_CUNESCAPE = 2,
1025 } UnquoteFlags;
1026
1027 int unquote_first_word(const char **p, char **ret, UnquoteFlags flags);
1028 int unquote_many_words(const char **p, UnquoteFlags flags, ...) _sentinel_;
1029
1030 int free_and_strdup(char **p, const char *s);
1031
1032 int sethostname_idempotent(const char *s);
1033
1034 #define INOTIFY_EVENT_MAX (sizeof(struct inotify_event) + NAME_MAX + 1)
1035
1036 #define FOREACH_INOTIFY_EVENT(e, buffer, sz) \
1037         for ((e) = &buffer.ev;                                \
1038              (uint8_t*) (e) < (uint8_t*) (buffer.raw) + (sz); \
1039              (e) = (struct inotify_event*) ((uint8_t*) (e) + sizeof(struct inotify_event) + (e)->len))
1040
1041 union inotify_event_buffer {
1042         struct inotify_event ev;
1043         uint8_t raw[INOTIFY_EVENT_MAX];
1044 };
1045
1046 #define laccess(path, mode) faccessat(AT_FDCWD, (path), (mode), AT_SYMLINK_NOFOLLOW)
1047
1048 int ptsname_malloc(int fd, char **ret);
1049
1050 int openpt_in_namespace(pid_t pid, int flags);
1051
1052 ssize_t fgetxattrat_fake(int dirfd, const char *filename, const char *attribute, void *value, size_t size, int flags);
1053
1054 int fd_setcrtime(int fd, usec_t usec);
1055 int fd_getcrtime(int fd, usec_t *usec);
1056 int path_getcrtime(const char *p, usec_t *usec);
1057 int fd_getcrtime_at(int dirfd, const char *name, usec_t *usec, int flags);
1058
1059 int chattr_fd(int fd, unsigned value, unsigned mask);
1060 int chattr_path(const char *p, unsigned value, unsigned mask);
1061
1062 int read_attr_fd(int fd, unsigned *ret);
1063 int read_attr_path(const char *p, unsigned *ret);
1064
1065 typedef struct LockFile {
1066         char *path;
1067         int fd;
1068         int operation;
1069 } LockFile;
1070
1071 int make_lock_file(const char *p, int operation, LockFile *ret);
1072 int make_lock_file_for(const char *p, int operation, LockFile *ret);
1073 void release_lock_file(LockFile *f);
1074
1075 #define _cleanup_release_lock_file_ _cleanup_(release_lock_file)
1076
1077 #define LOCK_FILE_INIT { .fd = -1, .path = NULL }
1078
1079 #define RLIMIT_MAKE_CONST(lim) ((struct rlimit) { lim, lim })
1080
1081 ssize_t sparse_write(int fd, const void *p, size_t sz, size_t run_length);
1082
1083 void sigkill_wait(pid_t *pid);
1084 #define _cleanup_sigkill_wait_ _cleanup_(sigkill_wait)
1085
1086 int syslog_parse_priority(const char **p, int *priority, bool with_facility);
1087
1088 void cmsg_close_all(struct msghdr *mh);
1089
1090 int rename_noreplace(int olddirfd, const char *oldpath, int newdirfd, const char *newpath);
1091
1092 char *shell_maybe_quote(const char *s);