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
 299 char hexchar(int x) _const_;
 300 int unhexchar(char c) _const_;
 301 char octchar(int x) _const_;
 302 int unoctchar(char c) _const_;
 303 char decchar(int x) _const_;
 304 int undecchar(char c) _const_;
 305
 306 char *cescape(const char *s);
 307 char *cunescape(const char *s);
 308 char *cunescape_length(const char *s, size_t length);
 309 char *cunescape_length_with_prefix(const char *s, size_t length, const char *prefix);
 310
 311 char *xescape(const char *s, const char *bad);
 312
 313 char *ascii_strlower(char *path);
 314
 315 bool dirent_is_file(const struct dirent *de) _pure_;
 316 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix) _pure_;
 317
 318 bool ignore_file(const char *filename) _pure_;
 319
 320 bool chars_intersect(const char *a, const char *b) _pure_;
 321
 322 int make_stdio(int fd);
 323 int make_null_stdio(void);
 324 int make_console_stdio(void);
 325
 326 int dev_urandom(void *p, size_t n);
 327 void random_bytes(void *p, size_t n);
 328 void initialize_srand(void);
 329
 330 static inline uint64_t random_u64(void) {
 331         uint64_t u;
 332         random_bytes(&u, sizeof(u));
 333         return u;
 334 }
 335
 336 static inline uint32_t random_u32(void) {
 337         uint32_t u;
 338         random_bytes(&u, sizeof(u));
 339         return u;
 340 }
 341
 342 /* For basic lookup tables with strictly enumerated entries */
 343 #define __DEFINE_STRING_TABLE_LOOKUP(name,type,scope)                   \
 344         scope const char *name##_to_string(type i) {                    \
 345                 if (i < 0 || i >= (type) ELEMENTSOF(name##_table))      \
 346                         return NULL;                                    \
 347                 return name##_table[i];                                 \
 348         }                                                               \
 349         scope type name##_from_string(const char *s) {                  \
 350                 type i;                                                 \
 351                 if (!s)                                                 \
 352                         return (type) -1;                               \
 353                 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
 354                         if (name##_table[i] &&                          \
 355                             streq(name##_table[i], s))                  \
 356                                 return i;                               \
 357                 return (type) -1;                                       \
 358         }                                                               \
 359         struct __useless_struct_to_allow_trailing_semicolon__
 360
 361 #define DEFINE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,)
 362 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,static)
 363
 364 /* For string conversions where numbers are also acceptable */
 365 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max)         \
 366         int name##_to_string_alloc(type i, char **str) {                \
 367                 char *s;                                                \
 368                 int r;                                                  \
 369                 if (i < 0 || i > max)                                   \
 370                         return -ERANGE;                                 \
 371                 if (i < (type) ELEMENTSOF(name##_table)) {              \
 372                         s = strdup(name##_table[i]);                    \
 373                         if (!s)                                         \
 374                                 return log_oom();                       \
 375                 } else {                                                \
 376                         r = asprintf(&s, "%u", i);                      \
 377                         if (r < 0)                                      \
 378                                 return log_oom();                       \
 379                 }                                                       \
 380                 *str = s;                                               \
 381                 return 0;                                               \
 382         }                                                               \
 383         type name##_from_string(const char *s) {                        \
 384                 type i;                                                 \
 385                 unsigned u = 0;                                         \
 386                 assert(s);                                              \
 387                 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
 388                         if (name##_table[i] &&                          \
 389                             streq(name##_table[i], s))                  \
 390                                 return i;                               \
 391                 if (safe_atou(s, &u) >= 0 && u <= max)                  \
 392                         return (type) u;                                \
 393                 return (type) -1;                                       \
 394         }                                                               \
 395         struct __useless_struct_to_allow_trailing_semicolon__
 396
 397 int fd_nonblock(int fd, bool nonblock);
 398 int fd_cloexec(int fd, bool cloexec);
 399
 400 int close_all_fds(const int except[], unsigned n_except);
 401
 402 bool fstype_is_network(const char *fstype);
 403
 404 int chvt(int vt);
 405
 406 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
 407 int ask_char(char *ret, const char *replies, const char *text, ...) _printf_(3, 4);
 408 int ask_string(char **ret, const char *text, ...) _printf_(2, 3);
 409
 410 int reset_terminal_fd(int fd, bool switch_to_text);
 411 int reset_terminal(const char *name);
 412
 413 int open_terminal(const char *name, int mode);
 414 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
 415 int release_terminal(void);
 416
 417 int flush_fd(int fd);
 418
 419 int ignore_signals(int sig, ...);
 420 int default_signals(int sig, ...);
 421 int sigaction_many(const struct sigaction *sa, ...);
 422
 423 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
 424
 425 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
 426 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
 427
 428 bool is_device_path(const char *path);
 429
 430 int dir_is_empty(const char *path);
 431 char* dirname_malloc(const char *path);
 432
 433 void rename_process(const char name[8]);
 434
 435 void sigset_add_many(sigset_t *ss, ...);
 436 int sigprocmask_many(int how, ...);
 437
 438 bool hostname_is_set(void);
 439
 440 char* lookup_uid(uid_t uid);
 441 char* gethostname_malloc(void);
 442 char* getlogname_malloc(void);
 443 char* getusername_malloc(void);
 444
 445 int getttyname_malloc(int fd, char **r);
 446 int getttyname_harder(int fd, char **r);
 447
 448 int get_ctty_devnr(pid_t pid, dev_t *d);
 449 int get_ctty(pid_t, dev_t *_devnr, char **r);
 450
 451 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
 452 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
 453
 454 int rm_rf_children(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
 455 int rm_rf_children_dangerous(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
 456 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
 457 int rm_rf_dangerous(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
 458
 459 int pipe_eof(int fd);
 460
 461 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
 462
 463 int status_vprintf(const char *status, bool ellipse, bool ephemeral, const char *format, va_list ap) _printf_(4,0);
 464 int status_printf(const char *status, bool ellipse, bool ephemeral, const char *format, ...) _printf_(4,5);
 465
 466 int fd_columns(int fd);
 467 unsigned columns(void);
 468 int fd_lines(int fd);
 469 unsigned lines(void);
 470 void columns_lines_cache_reset(int _unused_ signum);
 471
 472 bool on_tty(void);
 473
 474 static inline const char *ansi_highlight(void) {
 475         return on_tty() ? ANSI_HIGHLIGHT_ON : "";
 476 }
 477
 478 static inline const char *ansi_highlight_red(void) {
 479         return on_tty() ? ANSI_HIGHLIGHT_RED_ON : "";
 480 }
 481
 482 static inline const char *ansi_highlight_green(void) {
 483         return on_tty() ? ANSI_HIGHLIGHT_GREEN_ON : "";
 484 }
 485
 486 static inline const char *ansi_highlight_yellow(void) {
 487         return on_tty() ? ANSI_HIGHLIGHT_YELLOW_ON : "";
 488 }
 489
 490 static inline const char *ansi_highlight_blue(void) {
 491         return on_tty() ? ANSI_HIGHLIGHT_BLUE_ON : "";
 492 }
 493
 494 static inline const char *ansi_highlight_off(void) {
 495         return on_tty() ? ANSI_HIGHLIGHT_OFF : "";
 496 }
 497
 498 int files_same(const char *filea, const char *fileb);
 499
 500 int running_in_chroot(void);
 501
 502 char *ellipsize(const char *s, size_t length, unsigned percent);
 503                                    /* bytes                 columns */
 504 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
 505
 506 int touch_file(const char *path, bool parents, usec_t stamp, uid_t uid, gid_t gid, mode_t mode);
 507 int touch(const char *path);
 508
 509 char *unquote(const char *s, const char *quotes);
 510 char *normalize_env_assignment(const char *s);
 511
 512 int wait_for_terminate(pid_t pid, siginfo_t *status);
 513 int wait_for_terminate_and_warn(const char *name, pid_t pid);
 514
 515 noreturn void freeze(void);
 516
 517 bool null_or_empty(struct stat *st) _pure_;
 518 int null_or_empty_path(const char *fn);
 519 int null_or_empty_fd(int fd);
 520
 521 DIR *xopendirat(int dirfd, const char *name, int flags);
 522
 523 char *fstab_node_to_udev_node(const char *p);
 524
 525 char *resolve_dev_console(char **active);
 526 bool tty_is_vc(const char *tty);
 527 bool tty_is_vc_resolve(const char *tty);
 528 bool tty_is_console(const char *tty) _pure_;
 529 int vtnr_from_tty(const char *tty);
 530 const char *default_term_for_tty(const char *tty);
 531
 532 void execute_directory(const char *directory, DIR *_d, usec_t timeout, char *argv[]);
 533
 534 int kill_and_sigcont(pid_t pid, int sig);
 535
 536 bool nulstr_contains(const char*nulstr, const char *needle);
 537
 538 bool plymouth_running(void);
 539
 540 bool hostname_is_valid(const char *s) _pure_;
 541 char* hostname_cleanup(char *s, bool lowercase);
 542
 543 bool machine_name_is_valid(const char *s) _pure_;
 544
 545 char* strshorten(char *s, size_t l);
 546
 547 int terminal_vhangup_fd(int fd);
 548 int terminal_vhangup(const char *name);
 549
 550 int vt_disallocate(const char *name);
 551
 552 int symlink_atomic(const char *from, const char *to);
 553 int mknod_atomic(const char *path, mode_t mode, dev_t dev);
 554 int mkfifo_atomic(const char *path, mode_t mode);
 555
 556 int fchmod_umask(int fd, mode_t mode);
 557
 558 bool display_is_local(const char *display) _pure_;
 559 int socket_from_display(const char *display, char **path);
 560
 561 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
 562 int get_group_creds(const char **groupname, gid_t *gid);
 563
 564 int in_gid(gid_t gid);
 565 int in_group(const char *name);
 566
 567 char* uid_to_name(uid_t uid);
 568 char* gid_to_name(gid_t gid);
 569
 570 int glob_exists(const char *path);
 571 int glob_extend(char ***strv, const char *path);
 572
 573 int dirent_ensure_type(DIR *d, struct dirent *de);
 574
 575 int get_files_in_directory(const char *path, char ***list);
 576
 577 char *strjoin(const char *x, ...) _sentinel_;
 578
 579 bool is_main_thread(void);
 580
 581 static inline bool _pure_ in_charset(const char *s, const char* charset) {
 582         assert(s);
 583         assert(charset);
 584         return s[strspn(s, charset)] == '\0';
 585 }
 586
 587 int block_get_whole_disk(dev_t d, dev_t *ret);
 588
 589 #define NULSTR_FOREACH(i, l)                                    \
 590         for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
 591
 592 #define NULSTR_FOREACH_PAIR(i, j, l)                             \
 593         for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
 594
 595 int ioprio_class_to_string_alloc(int i, char **s);
 596 int ioprio_class_from_string(const char *s);
 597
 598 const char *sigchld_code_to_string(int i) _const_;
 599 int sigchld_code_from_string(const char *s) _pure_;
 600
 601 int log_facility_unshifted_to_string_alloc(int i, char **s);
 602 int log_facility_unshifted_from_string(const char *s);
 603
 604 int log_level_to_string_alloc(int i, char **s);
 605 int log_level_from_string(const char *s);
 606
 607 int sched_policy_to_string_alloc(int i, char **s);
 608 int sched_policy_from_string(const char *s);
 609
 610 const char *rlimit_to_string(int i) _const_;
 611 int rlimit_from_string(const char *s) _pure_;
 612
 613 int ip_tos_to_string_alloc(int i, char **s);
 614 int ip_tos_from_string(const char *s);
 615
 616 const char *signal_to_string(int i) _const_;
 617 int signal_from_string(const char *s) _pure_;
 618
 619 int signal_from_string_try_harder(const char *s);
 620
 621 extern int saved_argc;
 622 extern char **saved_argv;
 623
 624 bool kexec_loaded(void);
 625
 626 int prot_from_flags(int flags) _const_;
 627
 628 char *format_bytes(char *buf, size_t l, off_t t);
 629
 630 int fd_wait_for_event(int fd, int event, usec_t timeout);
 631
 632 void* memdup(const void *p, size_t l) _alloc_(2);
 633
 634 int is_kernel_thread(pid_t pid);
 635
 636 int fd_inc_sndbuf(int fd, size_t n);
 637 int fd_inc_rcvbuf(int fd, size_t n);
 638
 639 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
 640
 641 int setrlimit_closest(int resource, const struct rlimit *rlim);
 642
 643 int getenv_for_pid(pid_t pid, const char *field, char **_value);
 644
 645 bool is_valid_documentation_url(const char *url) _pure_;
 646
 647 bool in_initrd(void);
 648
 649 void warn_melody(void);
 650
 651 int get_home_dir(char **ret);
 652 int get_shell(char **_ret);
 653
 654 static inline void freep(void *p) {
 655         free(*(void**) p);
 656 }
 657
 658 #define DEFINE_TRIVIAL_CLEANUP_FUNC(type, func)                 \
 659         static inline void func##p(type *p) {                   \
 660                 if (*p)                                         \
 661                         func(*p);                               \
 662         }                                                       \
 663         struct __useless_struct_to_allow_trailing_semicolon__
 664
 665 static inline void closep(int *fd) {
 666         safe_close(*fd);
 667 }
 668
 669 static inline void umaskp(mode_t *u) {
 670         umask(*u);
 671 }
 672
 673 static inline void close_pairp(int (*p)[2]) {
 674         safe_close_pair(*p);
 675 }
 676
 677 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, fclose);
 678 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, pclose);
 679 DEFINE_TRIVIAL_CLEANUP_FUNC(DIR*, closedir);
 680 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, endmntent);
 681
 682 #define _cleanup_free_ _cleanup_(freep)
 683 #define _cleanup_close_ _cleanup_(closep)
 684 #define _cleanup_umask_ _cleanup_(umaskp)
 685 #define _cleanup_globfree_ _cleanup_(globfree)
 686 #define _cleanup_fclose_ _cleanup_(fclosep)
 687 #define _cleanup_pclose_ _cleanup_(pclosep)
 688 #define _cleanup_closedir_ _cleanup_(closedirp)
 689 #define _cleanup_endmntent_ _cleanup_(endmntentp)
 690 #define _cleanup_close_pair_ _cleanup_(close_pairp)
 691
 692 _malloc_  _alloc_(1, 2) static inline void *malloc_multiply(size_t a, size_t b) {
 693         if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
 694                 return NULL;
 695
 696         return malloc(a * b);
 697 }
 698
 699 _alloc_(2, 3) static inline void *realloc_multiply(void *p, size_t a, size_t b) {
 700         if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
 701                 return NULL;
 702
 703         return realloc(p, a * b);
 704 }
 705
 706 _alloc_(2, 3) static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
 707         if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
 708                 return NULL;
 709
 710         return memdup(p, a * b);
 711 }
 712
 713 bool filename_is_safe(const char *p) _pure_;
 714 bool path_is_safe(const char *p) _pure_;
 715 bool string_is_safe(const char *p) _pure_;
 716 bool string_has_cc(const char *p, const char *ok) _pure_;
 717
 718 /**
 719  * Check if a string contains any glob patterns.
 720  */
 721 _pure_ static inline bool string_is_glob(const char *p) {
 722         return !!strpbrk(p, GLOB_CHARS);
 723 }
 724
 725 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
 726                  int (*compar) (const void *, const void *, void *),
 727                  void *arg);
 728
 729 bool is_locale_utf8(void);
 730
 731 typedef enum DrawSpecialChar {
 732         DRAW_TREE_VERTICAL,
 733         DRAW_TREE_BRANCH,
 734         DRAW_TREE_RIGHT,
 735         DRAW_TREE_SPACE,
 736         DRAW_TRIANGULAR_BULLET,
 737         DRAW_BLACK_CIRCLE,
 738         DRAW_ARROW,
 739         DRAW_DASH,
 740         _DRAW_SPECIAL_CHAR_MAX
 741 } DrawSpecialChar;
 742
 743 const char *draw_special_char(DrawSpecialChar ch);
 744
 745 char *strreplace(const char *text, const char *old_string, const char *new_string);
 746
 747 char *strip_tab_ansi(char **p, size_t *l);
 748
 749 int on_ac_power(void);
 750
 751 int search_and_fopen(const char *path, const char *mode, const char *root, const char **search, FILE **_f);
 752 int search_and_fopen_nulstr(const char *path, const char *mode, const char *root, const char *search, FILE **_f);
 753
 754 #define FOREACH_LINE(line, f, on_error)                         \
 755         for (;;)                                                \
 756                 if (!fgets(line, sizeof(line), f)) {            \
 757                         if (ferror(f)) {                        \
 758                                 on_error;                       \
 759                         }                                       \
 760                         break;                                  \
 761                 } else
 762
 763 #define FOREACH_DIRENT(de, d, on_error)                                 \
 764         for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d))   \
 765                 if (!de) {                                              \
 766                         if (errno > 0) {                                \
 767                                 on_error;                               \
 768                         }                                               \
 769                         break;                                          \
 770                 } else if (ignore_file((de)->d_name))                   \
 771                         continue;                                       \
 772                 else
 773
 774 static inline void *mempset(void *s, int c, size_t n) {
 775         memset(s, c, n);
 776         return (uint8_t*)s + n;
 777 }
 778
 779 char *hexmem(const void *p, size_t l);
 780 void *unhexmem(const char *p, size_t l);
 781
 782 char *strextend(char **x, ...) _sentinel_;
 783 char *strrep(const char *s, unsigned n);
 784
 785 void* greedy_realloc(void **p, size_t *allocated, size_t need, size_t size);
 786 void* greedy_realloc0(void **p, size_t *allocated, size_t need, size_t size);
 787 #define GREEDY_REALLOC(array, allocated, need)                          \
 788         greedy_realloc((void**) &(array), &(allocated), (need), sizeof((array)[0]))
 789
 790 #define GREEDY_REALLOC0(array, allocated, need)                         \
 791         greedy_realloc0((void**) &(array), &(allocated), (need), sizeof((array)[0]))
 792
 793 static inline void _reset_errno_(int *saved_errno) {
 794         errno = *saved_errno;
 795 }
 796
 797 #define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
 798
 799 static inline int negative_errno(void) {
 800         /* This helper should be used to shut up gcc if you know 'errno' is
 801          * negative. Instead of "return -errno;", use "return negative_errno();"
 802          * It will suppress bogus gcc warnings in case it assumes 'errno' might
 803          * be 0 and thus the caller's error-handling might not be triggered. */
 804         assert_return(errno > 0, -EINVAL);
 805         return -errno;
 806 }
 807
 808 struct _umask_struct_ {
 809         mode_t mask;
 810         bool quit;
 811 };
 812
 813 static inline void _reset_umask_(struct _umask_struct_ *s) {
 814         umask(s->mask);
 815 };
 816
 817 #define RUN_WITH_UMASK(mask)                                            \
 818         for (_cleanup_(_reset_umask_) struct _umask_struct_ _saved_umask_ = { umask(mask), false }; \
 819              !_saved_umask_.quit ;                                      \
 820              _saved_umask_.quit = true)
 821
 822 static inline unsigned u64log2(uint64_t n) {
 823 #if __SIZEOF_LONG_LONG__ == 8
 824         return (n > 1) ? (unsigned) __builtin_clzll(n) ^ 63U : 0;
 825 #else
 826 #error "Wut?"
 827 #endif
 828 }
 829
 830 static inline unsigned u32ctz(uint32_t n) {
 831 #if __SIZEOF_INT__ == 4
 832         return __builtin_ctz(n);
 833 #else
 834 #error "Wut?"
 835 #endif
 836 }
 837
 838 static inline int log2i(int x) {
 839         assert(x > 0);
 840
 841         return __SIZEOF_INT__ * 8 - __builtin_clz(x) - 1;
 842 }
 843
 844 static inline unsigned log2u(unsigned x) {
 845         assert(x > 0);
 846
 847         return sizeof(unsigned) * 8 - __builtin_clz(x) - 1;
 848 }
 849
 850 static inline unsigned log2u_round_up(unsigned x) {
 851         assert(x > 0);
 852
 853         if (x == 1)
 854                 return 0;
 855
 856         return log2u(x - 1) + 1;
 857 }
 858
 859 static inline bool logind_running(void) {
 860         return access("/run/systemd/seats/", F_OK) >= 0;
 861 }
 862
 863 #define DECIMAL_STR_WIDTH(x)                            \
 864         ({                                              \
 865                 typeof(x) _x_ = (x);                    \
 866                 unsigned ans = 1;                       \
 867                 while (_x_ /= 10)                       \
 868                         ans++;                          \
 869                 ans;                                    \
 870         })
 871
 872 int unlink_noerrno(const char *path);
 873
 874 #define alloca0(n)                                      \
 875         ({                                              \
 876                 char *_new_;                            \
 877                 size_t _len_ = n;                       \
 878                 _new_ = alloca(_len_);                  \
 879                 (void *) memset(_new_, 0, _len_);       \
 880         })
 881
 882 #define alloca_align(size, align)                                       \
 883         ({                                                              \
 884                 void *_ptr_;                                            \
 885                 size_t _mask_ = (align) - 1;                            \
 886                 _ptr_ = alloca((size) + _mask_);                        \
 887                 (void*)(((uintptr_t)_ptr_ + _mask_) & ~_mask_);         \
 888         })
 889
 890 #define alloca0_align(size, align)                                      \
 891         ({                                                              \
 892                 void *_new_;                                            \
 893                 size_t _size_ = (size);                                 \
 894                 _new_ = alloca_align(_size_, (align));                  \
 895                 (void*)memset(_new_, 0, _size_);                        \
 896         })
 897
 898 #define strappenda(a, ...)                                       \
 899         ({                                                       \
 900                 int _len = strlen(a);                            \
 901                 unsigned _i;                                     \
 902                 char *_d_, *_p_;                                 \
 903                 const char *_appendees_[] = { __VA_ARGS__ };     \
 904                 for (_i = 0; _i < ELEMENTSOF(_appendees_); _i++) \
 905                         _len += strlen(_appendees_[_i]);         \
 906                 _d_ = alloca(_len + 1);                          \
 907                 _p_ = stpcpy(_d_, a);                            \
 908                 for (_i = 0; _i < ELEMENTSOF(_appendees_); _i++) \
 909                         _p_ = stpcpy(_p_, _appendees_[_i]);      \
 910                 _d_;                                             \
 911         })
 912
 913 #define procfs_file_alloca(pid, field)                                  \
 914         ({                                                              \
 915                 pid_t _pid_ = (pid);                                    \
 916                 const char *_r_;                                        \
 917                 if (_pid_ == 0) {                                       \
 918                         _r_ = ("/proc/self/" field);                    \
 919                 } else {                                                \
 920                         _r_ = alloca(strlen("/proc/") + DECIMAL_STR_MAX(pid_t) + 1 + sizeof(field)); \
 921                         sprintf((char*) _r_, "/proc/"PID_FMT"/" field, _pid_);                       \
 922                 }                                                       \
 923                 _r_;                                                    \
 924         })
 925
 926 struct _locale_struct_ {
 927         locale_t saved_locale;
 928         locale_t new_locale;
 929         bool quit;
 930 };
 931
 932 static inline void _reset_locale_(struct _locale_struct_ *s) {
 933         PROTECT_ERRNO;
 934         if (s->saved_locale != (locale_t) 0)
 935                 uselocale(s->saved_locale);
 936         if (s->new_locale != (locale_t) 0)
 937                 freelocale(s->new_locale);
 938 }
 939
 940 #define RUN_WITH_LOCALE(mask, loc) \
 941         for (_cleanup_(_reset_locale_) struct _locale_struct_ _saved_locale_ = { (locale_t) 0, (locale_t) 0, false }; \
 942              ({                                                         \
 943                      if (!_saved_locale_.quit) {                        \
 944                              PROTECT_ERRNO;                             \
 945                              _saved_locale_.new_locale = newlocale((mask), (loc), (locale_t) 0); \
 946                              if (_saved_locale_.new_locale != (locale_t) 0)     \
 947                                      _saved_locale_.saved_locale = uselocale(_saved_locale_.new_locale); \
 948                      }                                                  \
 949                      !_saved_locale_.quit; }) ;                         \
 950              _saved_locale_.quit = true)
 951
 952 bool id128_is_valid(const char *s) _pure_;
 953
 954 int split_pair(const char *s, const char *sep, char **l, char **r);
 955
 956 int shall_restore_state(void);
 957
 958 /**
 959  * Normal qsort requires base to be nonnull. Here were require
 960  * that only if nmemb > 0.
 961  */
 962 static inline void qsort_safe(void *base, size_t nmemb, size_t size,
 963                               int (*compar)(const void *, const void *)) {
 964         if (nmemb) {
 965                 assert(base);
 966                 qsort(base, nmemb, size, compar);
 967         }
 968 }
 969
 970 int proc_cmdline(char **ret);
 971 int parse_proc_cmdline(int (*parse_word)(const char *key, const char *value));
 972
 973 int container_get_leader(const char *machine, pid_t *pid);
 974
 975 int namespace_open(pid_t pid, int *pidns_fd, int *mntns_fd, int *netns_fd, int *root_fd);
 976 int namespace_enter(int pidns_fd, int mntns_fd, int netns_fd, int root_fd);
 977
 978 bool pid_is_alive(pid_t pid);
 979 bool pid_is_unwaited(pid_t pid);
 980
 981 int getpeercred(int fd, struct ucred *ucred);
 982 int getpeersec(int fd, char **ret);
 983
 984 int writev_safe(int fd, const struct iovec *w, int j);
 985
 986 int mkostemp_safe(char *pattern, int flags);
 987 int open_tmpfile(const char *path, int flags);
 988
 989 int fd_warn_permissions(const char *path, int fd);
 990
 991 unsigned long personality_from_string(const char *p);
 992 const char *personality_to_string(unsigned long);
 993
 994 uint64_t physical_memory(void);
 995
 996 char* mount_test_option(const char *haystack, const char *needle);
 997
 998 void hexdump(FILE *f, const void *p, size_t s);
 999
1000 union file_handle_union {
1001         struct file_handle handle;
1002         char padding[sizeof(struct file_handle) + MAX_HANDLE_SZ];
1003 };
1004
1005 int update_reboot_param_file(const char *param);
1006
1007 int umount_recursive(const char *target, int flags);
1008
1009 int bind_remount_recursive(const char *prefix, bool ro);
1010
1011 int fflush_and_check(FILE *f);
1012
1013 char *tempfn_xxxxxx(const char *p);
1014 char *tempfn_random(const char *p);
1015
1016 bool is_localhost(const char *hostname);
1017
1018 int take_password_lock(const char *root);
1019
1020 int is_symlink(const char *path);
1021 int is_dir(const char *path, bool follow);
1022
1023 int unquote_first_word(const char **p, char **ret, bool relax);
1024 int unquote_many_words(const char **p, ...) _sentinel_;
1025
1026 int free_and_strdup(char **p, const char *s);
1027
1028 int sethostname_idempotent(const char *s);