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