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