src/shared/util.h

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