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