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(char *ret, const char *replies, const char *text, ...) _printf_(3, 4);
 386 int ask_string(char **ret, const char *text, ...) _printf_(2, 3);
 387
 388 int reset_terminal_fd(int fd, bool switch_to_text);
 389 int reset_terminal(const char *name);
 390
 391 int open_terminal(const char *name, int mode);
 392 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
 393 int release_terminal(void);
 394
 395 int flush_fd(int fd);
 396
 397 int ignore_signals(int sig, ...);
 398 int default_signals(int sig, ...);
 399 int sigaction_many(const struct sigaction *sa, ...);
 400
 401 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
 402
 403 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
 404 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
 405
 406 bool is_device_path(const char *path);
 407
 408 int dir_is_empty(const char *path);
 409 char* dirname_malloc(const char *path);
 410
 411 void rename_process(const char name[8]);
 412
 413 void sigset_add_many(sigset_t *ss, ...);
 414 int sigprocmask_many(int how, ...);
 415
 416 bool hostname_is_set(void);
 417
 418 char* gethostname_malloc(void);
 419 char* getlogname_malloc(void);
 420 char* getusername_malloc(void);
 421
 422 int getttyname_malloc(int fd, char **r);
 423 int getttyname_harder(int fd, char **r);
 424
 425 int get_ctty_devnr(pid_t pid, dev_t *d);
 426 int get_ctty(pid_t, dev_t *_devnr, char **r);
 427
 428 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
 429 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
 430
 431 int rm_rf_children(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
 432 int rm_rf_children_dangerous(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
 433 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
 434 int rm_rf_dangerous(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
 435
 436 int pipe_eof(int fd);
 437
 438 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
 439
 440 int status_vprintf(const char *status, bool ellipse, bool ephemeral, const char *format, va_list ap) _printf_(4,0);
 441 int status_printf(const char *status, bool ellipse, bool ephemeral, const char *format, ...) _printf_(4,5);
 442
 443 int fd_columns(int fd);
 444 unsigned columns(void);
 445 int fd_lines(int fd);
 446 unsigned lines(void);
 447 void columns_lines_cache_reset(int _unused_ signum);
 448
 449 bool on_tty(void);
 450
 451 static inline const char *ansi_highlight(void) {
 452         return on_tty() ? ANSI_HIGHLIGHT_ON : "";
 453 }
 454
 455 static inline const char *ansi_highlight_red(void) {
 456         return on_tty() ? ANSI_HIGHLIGHT_RED_ON : "";
 457 }
 458
 459 static inline const char *ansi_highlight_green(void) {
 460         return on_tty() ? ANSI_HIGHLIGHT_GREEN_ON : "";
 461 }
 462
 463 static inline const char *ansi_highlight_yellow(void) {
 464         return on_tty() ? ANSI_HIGHLIGHT_YELLOW_ON : "";
 465 }
 466
 467 static inline const char *ansi_highlight_blue(void) {
 468         return on_tty() ? ANSI_HIGHLIGHT_BLUE_ON : "";
 469 }
 470
 471 static inline const char *ansi_highlight_off(void) {
 472         return on_tty() ? ANSI_HIGHLIGHT_OFF : "";
 473 }
 474
 475 int files_same(const char *filea, const char *fileb);
 476
 477 int running_in_chroot(void);
 478
 479 char *ellipsize(const char *s, size_t length, unsigned percent);
 480                                    /* bytes                 columns */
 481 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
 482
 483 int touch_file(const char *path, bool parents, usec_t stamp, uid_t uid, gid_t gid, mode_t mode);
 484 int touch(const char *path);
 485
 486 char *unquote(const char *s, const char *quotes);
 487 char *normalize_env_assignment(const char *s);
 488
 489 int wait_for_terminate(pid_t pid, siginfo_t *status);
 490 int wait_for_terminate_and_warn(const char *name, pid_t pid);
 491
 492 noreturn void freeze(void);
 493
 494 bool null_or_empty(struct stat *st) _pure_;
 495 int null_or_empty_path(const char *fn);
 496
 497 DIR *xopendirat(int dirfd, const char *name, int flags);
 498
 499 char *fstab_node_to_udev_node(const char *p);
 500
 501 char *resolve_dev_console(char **active);
 502 bool tty_is_vc(const char *tty);
 503 bool tty_is_vc_resolve(const char *tty);
 504 bool tty_is_console(const char *tty) _pure_;
 505 int vtnr_from_tty(const char *tty);
 506 const char *default_term_for_tty(const char *tty);
 507
 508 void execute_directory(const char *directory, DIR *_d, usec_t timeout, char *argv[]);
 509
 510 int kill_and_sigcont(pid_t pid, int sig);
 511
 512 bool nulstr_contains(const char*nulstr, const char *needle);
 513
 514 bool plymouth_running(void);
 515
 516 bool hostname_is_valid(const char *s) _pure_;
 517 char* hostname_cleanup(char *s, bool lowercase);
 518
 519 bool machine_name_is_valid(const char *s) _pure_;
 520
 521 char* strshorten(char *s, size_t l);
 522
 523 int terminal_vhangup_fd(int fd);
 524 int terminal_vhangup(const char *name);
 525
 526 int vt_disallocate(const char *name);
 527
 528 int symlink_atomic(const char *from, const char *to);
 529 int mknod_atomic(const char *path, mode_t mode, dev_t dev);
 530 int mkfifo_atomic(const char *path, mode_t mode);
 531
 532 int fchmod_umask(int fd, mode_t mode);
 533
 534 bool display_is_local(const char *display) _pure_;
 535 int socket_from_display(const char *display, char **path);
 536
 537 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
 538 int get_group_creds(const char **groupname, gid_t *gid);
 539
 540 int in_gid(gid_t gid);
 541 int in_group(const char *name);
 542
 543 char* uid_to_name(uid_t uid);
 544 char* gid_to_name(gid_t gid);
 545
 546 int glob_exists(const char *path);
 547 int glob_extend(char ***strv, const char *path);
 548
 549 int dirent_ensure_type(DIR *d, struct dirent *de);
 550
 551 int get_files_in_directory(const char *path, char ***list);
 552
 553 char *strjoin(const char *x, ...) _sentinel_;
 554
 555 bool is_main_thread(void);
 556
 557 static inline bool _pure_ in_charset(const char *s, const char* charset) {
 558         assert(s);
 559         assert(charset);
 560         return s[strspn(s, charset)] == '\0';
 561 }
 562
 563 int block_get_whole_disk(dev_t d, dev_t *ret);
 564
 565 int file_is_priv_sticky(const char *p);
 566
 567 int strdup_or_null(const char *a, char **b);
 568
 569 #define NULSTR_FOREACH(i, l)                                    \
 570         for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
 571
 572 #define NULSTR_FOREACH_PAIR(i, j, l)                             \
 573         for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
 574
 575 int ioprio_class_to_string_alloc(int i, char **s);
 576 int ioprio_class_from_string(const char *s);
 577
 578 const char *sigchld_code_to_string(int i) _const_;
 579 int sigchld_code_from_string(const char *s) _pure_;
 580
 581 int log_facility_unshifted_to_string_alloc(int i, char **s);
 582 int log_facility_unshifted_from_string(const char *s);
 583
 584 int log_level_to_string_alloc(int i, char **s);
 585 int log_level_from_string(const char *s);
 586
 587 int sched_policy_to_string_alloc(int i, char **s);
 588 int sched_policy_from_string(const char *s);
 589
 590 const char *rlimit_to_string(int i) _const_;
 591 int rlimit_from_string(const char *s) _pure_;
 592
 593 int ip_tos_to_string_alloc(int i, char **s);
 594 int ip_tos_from_string(const char *s);
 595
 596 const char *signal_to_string(int i) _const_;
 597 int signal_from_string(const char *s) _pure_;
 598
 599 int signal_from_string_try_harder(const char *s);
 600
 601 extern int saved_argc;
 602 extern char **saved_argv;
 603
 604 bool kexec_loaded(void);
 605
 606 int prot_from_flags(int flags) _const_;
 607
 608 char *format_bytes(char *buf, size_t l, off_t t);
 609
 610 int fd_wait_for_event(int fd, int event, usec_t timeout);
 611
 612 void* memdup(const void *p, size_t l) _alloc_(2);
 613
 614 int is_kernel_thread(pid_t pid);
 615
 616 int fd_inc_sndbuf(int fd, size_t n);
 617 int fd_inc_rcvbuf(int fd, size_t n);
 618
 619 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
 620
 621 int setrlimit_closest(int resource, const struct rlimit *rlim);
 622
 623 int getenv_for_pid(pid_t pid, const char *field, char **_value);
 624
 625 bool is_valid_documentation_url(const char *url) _pure_;
 626
 627 bool in_initrd(void);
 628
 629 void warn_melody(void);
 630
 631 int get_home_dir(char **ret);
 632 int get_shell(char **_ret);
 633
 634 static inline void freep(void *p) {
 635         free(*(void**) p);
 636 }
 637
 638 #define DEFINE_TRIVIAL_CLEANUP_FUNC(type, func)                 \
 639         static inline void func##p(type *p) {                   \
 640                 if (*p)                                         \
 641                         func(*p);                               \
 642         }                                                       \
 643         struct __useless_struct_to_allow_trailing_semicolon__
 644
 645 static inline void closep(int *fd) {
 646         safe_close(*fd);
 647 }
 648
 649 static inline void umaskp(mode_t *u) {
 650         umask(*u);
 651 }
 652
 653 static inline void close_pairp(int (*p)[2]) {
 654         safe_close_pair(*p);
 655 }
 656
 657 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, fclose);
 658 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, pclose);
 659 DEFINE_TRIVIAL_CLEANUP_FUNC(DIR*, closedir);
 660 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, endmntent);
 661
 662 #define _cleanup_free_ _cleanup_(freep)
 663 #define _cleanup_close_ _cleanup_(closep)
 664 #define _cleanup_umask_ _cleanup_(umaskp)
 665 #define _cleanup_globfree_ _cleanup_(globfree)
 666 #define _cleanup_fclose_ _cleanup_(fclosep)
 667 #define _cleanup_pclose_ _cleanup_(pclosep)
 668 #define _cleanup_closedir_ _cleanup_(closedirp)
 669 #define _cleanup_endmntent_ _cleanup_(endmntentp)
 670 #define _cleanup_close_pair_ _cleanup_(close_pairp)
 671
 672 _malloc_  _alloc_(1, 2) static inline void *malloc_multiply(size_t a, size_t b) {
 673         if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
 674                 return NULL;
 675
 676         return malloc(a * b);
 677 }
 678
 679 _alloc_(2, 3) static inline void *realloc_multiply(void *p, size_t a, size_t b) {
 680         if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
 681                 return NULL;
 682
 683         return realloc(p, a * b);
 684 }
 685
 686 _alloc_(2, 3) static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
 687         if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
 688                 return NULL;
 689
 690         return memdup(p, a * b);
 691 }
 692
 693 bool filename_is_safe(const char *p) _pure_;
 694 bool path_is_safe(const char *p) _pure_;
 695 bool string_is_safe(const char *p) _pure_;
 696 bool string_has_cc(const char *p, const char *ok) _pure_;
 697
 698 /**
 699  * Check if a string contains any glob patterns.
 700  */
 701 _pure_ static inline bool string_is_glob(const char *p) {
 702         return !!strpbrk(p, GLOB_CHARS);
 703 }
 704
 705 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
 706                  int (*compar) (const void *, const void *, void *),
 707                  void *arg);
 708
 709 bool is_locale_utf8(void);
 710
 711 typedef enum DrawSpecialChar {
 712         DRAW_TREE_VERTICAL,
 713         DRAW_TREE_BRANCH,
 714         DRAW_TREE_RIGHT,
 715         DRAW_TREE_SPACE,
 716         DRAW_TRIANGULAR_BULLET,
 717         DRAW_BLACK_CIRCLE,
 718         DRAW_ARROW,
 719         DRAW_DASH,
 720         _DRAW_SPECIAL_CHAR_MAX
 721 } DrawSpecialChar;
 722
 723 const char *draw_special_char(DrawSpecialChar ch);
 724
 725 char *strreplace(const char *text, const char *old_string, const char *new_string);
 726
 727 char *strip_tab_ansi(char **p, size_t *l);
 728
 729 int on_ac_power(void);
 730
 731 int search_and_fopen(const char *path, const char *mode, const char *root, const char **search, FILE **_f);
 732 int search_and_fopen_nulstr(const char *path, const char *mode, const char *root, const char *search, FILE **_f);
 733
 734 #define FOREACH_LINE(line, f, on_error)                         \
 735         for (;;)                                                \
 736                 if (!fgets(line, sizeof(line), f)) {            \
 737                         if (ferror(f)) {                        \
 738                                 on_error;                       \
 739                         }                                       \
 740                         break;                                  \
 741                 } else
 742
 743 #define FOREACH_DIRENT(de, d, on_error)                                 \
 744         for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d))   \
 745                 if (!de) {                                              \
 746                         if (errno > 0) {                                \
 747                                 on_error;                               \
 748                         }                                               \
 749                         break;                                          \
 750                 } else if (ignore_file((de)->d_name))                   \
 751                         continue;                                       \
 752                 else
 753
 754 static inline void *mempset(void *s, int c, size_t n) {
 755         memset(s, c, n);
 756         return (uint8_t*)s + n;
 757 }
 758
 759 char *hexmem(const void *p, size_t l);
 760 void *unhexmem(const char *p, size_t l);
 761
 762 char *strextend(char **x, ...) _sentinel_;
 763 char *strrep(const char *s, unsigned n);
 764
 765 void* greedy_realloc(void **p, size_t *allocated, size_t need, size_t size);
 766 void* greedy_realloc0(void **p, size_t *allocated, size_t need, size_t size);
 767 #define GREEDY_REALLOC(array, allocated, need)                          \
 768         greedy_realloc((void**) &(array), &(allocated), (need), sizeof((array)[0]))
 769
 770 #define GREEDY_REALLOC0(array, allocated, need)                         \
 771         greedy_realloc0((void**) &(array), &(allocated), (need), sizeof((array)[0]))
 772
 773 static inline void _reset_errno_(int *saved_errno) {
 774         errno = *saved_errno;
 775 }
 776
 777 #define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
 778
 779 struct _umask_struct_ {
 780         mode_t mask;
 781         bool quit;
 782 };
 783
 784 static inline void _reset_umask_(struct _umask_struct_ *s) {
 785         umask(s->mask);
 786 };
 787
 788 #define RUN_WITH_UMASK(mask)                                            \
 789         for (_cleanup_(_reset_umask_) struct _umask_struct_ _saved_umask_ = { umask(mask), false }; \
 790              !_saved_umask_.quit ;                                      \
 791              _saved_umask_.quit = true)
 792
 793 static inline unsigned u64log2(uint64_t n) {
 794 #if __SIZEOF_LONG_LONG__ == 8
 795         return (n > 1) ? (unsigned) __builtin_clzll(n) ^ 63U : 0;
 796 #else
 797 #error "Wut?"
 798 #endif
 799 }
 800
 801 static inline unsigned u32ctz(uint32_t n) {
 802 #if __SIZEOF_INT__ == 4
 803         return __builtin_ctz(n);
 804 #else
 805 #error "Wut?"
 806 #endif
 807 }
 808
 809 static inline int log2i(int x) {
 810         assert(x > 0);
 811
 812         return __SIZEOF_INT__ * 8 - __builtin_clz(x) - 1;
 813 }
 814
 815 static inline bool logind_running(void) {
 816         return access("/run/systemd/seats/", F_OK) >= 0;
 817 }
 818
 819 #define DECIMAL_STR_WIDTH(x)                            \
 820         ({                                              \
 821                 typeof(x) _x_ = (x);                    \
 822                 unsigned ans = 1;                       \
 823                 while (_x_ /= 10)                       \
 824                         ans++;                          \
 825                 ans;                                    \
 826         })
 827
 828 int unlink_noerrno(const char *path);
 829
 830 #define alloca0(n)                                      \
 831         ({                                              \
 832                 char *_new_;                            \
 833                 size_t _len_ = n;                       \
 834                 _new_ = alloca(_len_);                  \
 835                 (void *) memset(_new_, 0, _len_);       \
 836         })
 837
 838 #define strappenda(a, b)                                \
 839         ({                                              \
 840                 const char *_a_ = (a), *_b_ = (b);      \
 841                 char *_c_;                              \
 842                 size_t _x_, _y_;                        \
 843                 _x_ = strlen(_a_);                      \
 844                 _y_ = strlen(_b_);                      \
 845                 _c_ = alloca(_x_ + _y_ + 1);            \
 846                 strcpy(stpcpy(_c_, _a_), _b_);          \
 847                 _c_;                                    \
 848         })
 849
 850 #define strappenda3(a, b, c)                                    \
 851         ({                                                      \
 852                 const char *_a_ = (a), *_b_ = (b), *_c_ = (c);  \
 853                 char *_d_;                                      \
 854                 size_t _x_, _y_, _z_;                           \
 855                 _x_ = strlen(_a_);                              \
 856                 _y_ = strlen(_b_);                              \
 857                 _z_ = strlen(_c_);                              \
 858                 _d_ = alloca(_x_ + _y_ + _z_ + 1);              \
 859                 strcpy(stpcpy(stpcpy(_d_, _a_), _b_), _c_);     \
 860                 _d_;                                            \
 861         })
 862
 863 #define procfs_file_alloca(pid, field)                                  \
 864         ({                                                              \
 865                 pid_t _pid_ = (pid);                                    \
 866                 const char *_r_;                                        \
 867                 if (_pid_ == 0) {                                       \
 868                         _r_ = ("/proc/self/" field);                    \
 869                 } else {                                                \
 870                         _r_ = alloca(strlen("/proc/") + DECIMAL_STR_MAX(pid_t) + 1 + sizeof(field)); \
 871                         sprintf((char*) _r_, "/proc/"PID_FMT"/" field, _pid_);                       \
 872                 }                                                       \
 873                 _r_;                                                    \
 874         })
 875
 876 struct _locale_struct_ {
 877         locale_t saved_locale;
 878         locale_t new_locale;
 879         bool quit;
 880 };
 881
 882 static inline void _reset_locale_(struct _locale_struct_ *s) {
 883         PROTECT_ERRNO;
 884         if (s->saved_locale != (locale_t) 0)
 885                 uselocale(s->saved_locale);
 886         if (s->new_locale != (locale_t) 0)
 887                 freelocale(s->new_locale);
 888 }
 889
 890 #define RUN_WITH_LOCALE(mask, loc) \
 891         for (_cleanup_(_reset_locale_) struct _locale_struct_ _saved_locale_ = { (locale_t) 0, (locale_t) 0, false }; \
 892              ({                                                         \
 893                      if (!_saved_locale_.quit) {                        \
 894                              PROTECT_ERRNO;                             \
 895                              _saved_locale_.new_locale = newlocale((mask), (loc), (locale_t) 0); \
 896                              if (_saved_locale_.new_locale != (locale_t) 0)     \
 897                                      _saved_locale_.saved_locale = uselocale(_saved_locale_.new_locale); \
 898                      }                                                  \
 899                      !_saved_locale_.quit; }) ;                         \
 900              _saved_locale_.quit = true)
 901
 902 bool id128_is_valid(const char *s) _pure_;
 903
 904 int split_pair(const char *s, const char *sep, char **l, char **r);
 905
 906 int shall_restore_state(void);
 907
 908 /**
 909  * Normal qsort requires base to be nonnull. Here were require
 910  * that only if nmemb > 0.
 911  */
 912 static inline void qsort_safe(void *base, size_t nmemb, size_t size,
 913                               int (*compar)(const void *, const void *)) {
 914         if (nmemb) {
 915                 assert(base);
 916                 qsort(base, nmemb, size, compar);
 917         }
 918 }
 919
 920 int proc_cmdline(char **ret);
 921 int parse_proc_cmdline(int (*parse_word)(const char *key, const char *value));
 922
 923 int container_get_leader(const char *machine, pid_t *pid);
 924
 925 int namespace_open(pid_t pid, int *pidns_fd, int *mntns_fd, int *netns_fd, int *root_fd);
 926 int namespace_enter(int pidns_fd, int mntns_fd, int netns_fd, int root_fd);
 927
 928 bool pid_is_alive(pid_t pid);
 929 bool pid_is_unwaited(pid_t pid);
 930
 931 int getpeercred(int fd, struct ucred *ucred);
 932 int getpeersec(int fd, char **ret);
 933
 934 int writev_safe(int fd, const struct iovec *w, int j);
 935
 936 int mkostemp_safe(char *pattern, int flags);
 937 int open_tmpfile(const char *path, int flags);
 938
 939 int fd_warn_permissions(const char *path, int fd);
 940
 941 unsigned long personality_from_string(const char *p);
 942 const char *personality_to_string(unsigned long);
 943
 944 uint64_t physical_memory(void);
 945
 946 char* mount_test_option(const char *haystack, const char *needle);
 947
 948 void hexdump(FILE *f, const void *p, size_t s);
 949
 950 union file_handle_union {
 951         struct file_handle handle;
 952         char padding[sizeof(struct file_handle) + MAX_HANDLE_SZ];
 953 };
 954
 955 int update_reboot_param_file(const char *param);
 956
 957 int umount_recursive(const char *target, int flags);
 958
 959 int bind_remount_recursive(const char *prefix, bool ro);
 960
 961 int fflush_and_check(FILE *f);
 962
 963 char *tempfn_xxxxxx(const char *p);
 964 char *tempfn_random(const char *p);
 965
 966 bool is_localhost(const char *hostname);