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