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 <stdarg.h>
  29 #include <stdbool.h>
  30 #include <stdlib.h>
  31 #include <stdio.h>
  32 #include <signal.h>
  33 #include <sched.h>
  34 #include <limits.h>
  35 #include <sys/types.h>
  36 #include <sys/socket.h>
  37 #include <sys/stat.h>
  38 #include <dirent.h>
  39 #include <stddef.h>
  40 #include <unistd.h>
  41 #include <locale.h>
  42 #include <mntent.h>
  43 #include <sys/inotify.h>
  44 #include <sys/statfs.h>
  45
  46 #if SIZEOF_PID_T == 4
  47 #  define PID_PRI PRIi32
  48 #elif SIZEOF_PID_T == 2
  49 #  define PID_PRI PRIi16
  50 #else
  51 #  error Unknown pid_t size
  52 #endif
  53 #define PID_FMT "%" PID_PRI
  54
  55 #if SIZEOF_UID_T == 4
  56 #  define UID_FMT "%" PRIu32
  57 #elif SIZEOF_UID_T == 2
  58 #  define UID_FMT "%" PRIu16
  59 #else
  60 #  error Unknown uid_t size
  61 #endif
  62
  63 #if SIZEOF_GID_T == 4
  64 #  define GID_FMT "%" PRIu32
  65 #elif SIZEOF_GID_T == 2
  66 #  define GID_FMT "%" PRIu16
  67 #else
  68 #  error Unknown gid_t size
  69 #endif
  70
  71 #if SIZEOF_TIME_T == 8
  72 #  define PRI_TIME PRIi64
  73 #elif SIZEOF_TIME_T == 4
  74 #  define PRI_TIME PRIu32
  75 #else
  76 #  error Unknown time_t size
  77 #endif
  78
  79 #if SIZEOF_RLIM_T == 8
  80 #  define RLIM_FMT "%" PRIu64
  81 #elif SIZEOF_RLIM_T == 4
  82 #  define RLIM_FMT "%" PRIu32
  83 #else
  84 #  error Unknown rlim_t size
  85 #endif
  86
  87 #include "macro.h"
  88 #include "missing.h"
  89 #include "time-util.h"
  90
  91 /* What is interpreted as whitespace? */
  92 #define WHITESPACE " \t\n\r"
  93 #define NEWLINE    "\n\r"
  94 #define QUOTES     "\"\'"
  95 #define COMMENTS   "#;"
  96 #define GLOB_CHARS "*?["
  97
  98 /* What characters are special in the shell? */
  99 /* must be escaped outside and inside double-quotes */
 100 #define SHELL_NEED_ESCAPE "\"\\`$"
 101 /* can be escaped or double-quoted */
 102 #define SHELL_NEED_QUOTES SHELL_NEED_ESCAPE GLOB_CHARS "'()<>|&;"
 103
 104 #define FORMAT_BYTES_MAX 8
 105
 106 #define ANSI_HIGHLIGHT_ON "\x1B[1;39m"
 107 #define ANSI_RED_ON "\x1B[31m"
 108 #define ANSI_HIGHLIGHT_RED_ON "\x1B[1;31m"
 109 #define ANSI_GREEN_ON "\x1B[32m"
 110 #define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
 111 #define ANSI_HIGHLIGHT_YELLOW_ON "\x1B[1;33m"
 112 #define ANSI_HIGHLIGHT_BLUE_ON "\x1B[1;34m"
 113 #define ANSI_HIGHLIGHT_OFF "\x1B[0m"
 114 #define ANSI_ERASE_TO_END_OF_LINE "\x1B[K"
 115
 116 size_t page_size(void) _pure_;
 117 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
 118
 119 #define streq(a,b) (strcmp((a),(b)) == 0)
 120 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
 121 #define strcaseeq(a,b) (strcasecmp((a),(b)) == 0)
 122 #define strncaseeq(a, b, n) (strncasecmp((a), (b), (n)) == 0)
 123
 124 bool streq_ptr(const char *a, const char *b) _pure_;
 125
 126 #define new(t, n) ((t*) malloc_multiply(sizeof(t), (n)))
 127
 128 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
 129
 130 #define newa(t, n) ((t*) alloca(sizeof(t)*(n)))
 131
 132 #define newa0(t, n) ((t*) alloca0(sizeof(t)*(n)))
 133
 134 #define newdup(t, p, n) ((t*) memdup_multiply(p, sizeof(t), (n)))
 135
 136 #define malloc0(n) (calloc((n), 1))
 137
 138 static inline const char* yes_no(bool b) {
 139         return b ? "yes" : "no";
 140 }
 141
 142 static inline const char* true_false(bool b) {
 143         return b ? "true" : "false";
 144 }
 145
 146 static inline const char* one_zero(bool b) {
 147         return b ? "1" : "0";
 148 }
 149
 150 static inline const char* strempty(const char *s) {
 151         return s ? s : "";
 152 }
 153
 154 static inline const char* strnull(const char *s) {
 155         return s ? s : "(null)";
 156 }
 157
 158 static inline const char *strna(const char *s) {
 159         return s ? s : "n/a";
 160 }
 161
 162 static inline bool isempty(const char *p) {
 163         return !p || !p[0];
 164 }
 165
 166 static inline char *startswith(const char *s, const char *prefix) {
 167         size_t l;
 168
 169         l = strlen(prefix);
 170         if (strncmp(s, prefix, l) == 0)
 171                 return (char*) s + l;
 172
 173         return NULL;
 174 }
 175
 176 static inline char *startswith_no_case(const char *s, const char *prefix) {
 177         size_t l;
 178
 179         l = strlen(prefix);
 180         if (strncasecmp(s, prefix, l) == 0)
 181                 return (char*) s + l;
 182
 183         return NULL;
 184 }
 185
 186 char *endswith(const char *s, const char *postfix) _pure_;
 187 char *endswith_no_case(const char *s, const char *postfix) _pure_;
 188
 189 char *first_word(const char *s, const char *word) _pure_;
 190
 191 int close_nointr(int fd);
 192 int safe_close(int fd);
 193 void safe_close_pair(int p[]);
 194
 195 void close_many(const int fds[], unsigned n_fd);
 196
 197 int parse_size(const char *t, off_t base, off_t *size);
 198
 199 int parse_boolean(const char *v) _pure_;
 200 int parse_pid(const char *s, pid_t* ret_pid);
 201 int parse_uid(const char *s, uid_t* ret_uid);
 202 #define parse_gid(s, ret_uid) parse_uid(s, ret_uid)
 203
 204 int safe_atou(const char *s, unsigned *ret_u);
 205 int safe_atoi(const char *s, int *ret_i);
 206
 207 int safe_atollu(const char *s, unsigned long long *ret_u);
 208 int safe_atolli(const char *s, long long int *ret_i);
 209
 210 int safe_atod(const char *s, double *ret_d);
 211
 212 int safe_atou8(const char *s, uint8_t *ret);
 213
 214 #if LONG_MAX == INT_MAX
 215 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
 216         assert_cc(sizeof(unsigned long) == sizeof(unsigned));
 217         return safe_atou(s, (unsigned*) ret_u);
 218 }
 219 static inline int safe_atoli(const char *s, long int *ret_u) {
 220         assert_cc(sizeof(long int) == sizeof(int));
 221         return safe_atoi(s, (int*) ret_u);
 222 }
 223 #else
 224 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
 225         assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
 226         return safe_atollu(s, (unsigned long long*) ret_u);
 227 }
 228 static inline int safe_atoli(const char *s, long int *ret_u) {
 229         assert_cc(sizeof(long int) == sizeof(long long int));
 230         return safe_atolli(s, (long long int*) ret_u);
 231 }
 232 #endif
 233
 234 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
 235         assert_cc(sizeof(uint32_t) == sizeof(unsigned));
 236         return safe_atou(s, (unsigned*) ret_u);
 237 }
 238
 239 static inline int safe_atoi32(const char *s, int32_t *ret_i) {
 240         assert_cc(sizeof(int32_t) == sizeof(int));
 241         return safe_atoi(s, (int*) ret_i);
 242 }
 243
 244 static inline int safe_atou64(const char *s, uint64_t *ret_u) {
 245         assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
 246         return safe_atollu(s, (unsigned long long*) ret_u);
 247 }
 248
 249 static inline int safe_atoi64(const char *s, int64_t *ret_i) {
 250         assert_cc(sizeof(int64_t) == sizeof(long long int));
 251         return safe_atolli(s, (long long int*) ret_i);
 252 }
 253
 254 int safe_atou16(const char *s, uint16_t *ret);
 255 int safe_atoi16(const char *s, int16_t *ret);
 256
 257 const char* split(const char **state, size_t *l, const char *separator, bool quoted);
 258
 259 #define FOREACH_WORD(word, length, s, state)                            \
 260         _FOREACH_WORD(word, length, s, WHITESPACE, false, state)
 261
 262 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state)       \
 263         _FOREACH_WORD(word, length, s, separator, false, state)
 264
 265 #define FOREACH_WORD_QUOTED(word, length, s, state)                     \
 266         _FOREACH_WORD(word, length, s, WHITESPACE, true, state)
 267
 268 #define _FOREACH_WORD(word, length, s, separator, quoted, state)        \
 269         for ((state) = (s), (word) = split(&(state), &(length), (separator), (quoted)); (word); (word) = split(&(state), &(length), (separator), (quoted)))
 270
 271 char *strappend(const char *s, const char *suffix);
 272 char *strnappend(const char *s, const char *suffix, size_t length);
 273
 274 char *replace_env(const char *format, char **env);
 275 char **replace_env_argv(char **argv, char **env);
 276
 277 int readlinkat_malloc(int fd, const char *p, char **ret);
 278 int readlink_malloc(const char *p, char **r);
 279 int readlink_value(const char *p, char **ret);
 280 int readlink_and_make_absolute(const char *p, char **r);
 281 int readlink_and_canonicalize(const char *p, char **r);
 282
 283 int reset_all_signal_handlers(void);
 284 int reset_signal_mask(void);
 285
 286 char *strstrip(char *s);
 287 char *delete_chars(char *s, const char *bad);
 288 char *truncate_nl(char *s);
 289
 290 char *file_in_same_dir(const char *path, const char *filename);
 291
 292 int rmdir_parents(const char *path, const char *stop);
 293
 294 char hexchar(int x) _const_;
 295 int unhexchar(char c) _const_;
 296 char octchar(int x) _const_;
 297 int unoctchar(char c) _const_;
 298 char decchar(int x) _const_;
 299 int undecchar(char c) _const_;
 300
 301 char *cescape(const char *s);
 302 size_t cescape_char(char c, char *buf);
 303
 304 typedef enum UnescapeFlags {
 305         UNESCAPE_RELAX = 1,
 306 } UnescapeFlags;
 307
 308 int cunescape(const char *s, UnescapeFlags flags, char **ret);
 309 int cunescape_length(const char *s, size_t length, UnescapeFlags flags, char **ret);
 310 int cunescape_length_with_prefix(const char *s, size_t length, const char *prefix, UnescapeFlags flags, char **ret);
 311
 312 char *xescape(const char *s, const char *bad);
 313
 314 char *ascii_strlower(char *path);
 315
 316 bool dirent_is_file(const struct dirent *de) _pure_;
 317 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix) _pure_;
 318
 319 bool hidden_file(const char *filename) _pure_;
 320
 321 bool chars_intersect(const char *a, const char *b) _pure_;
 322
 323 int make_stdio(int fd);
 324 int make_null_stdio(void);
 325 int make_console_stdio(void);
 326
 327 int dev_urandom(void *p, size_t n);
 328 void random_bytes(void *p, size_t n);
 329 void initialize_srand(void);
 330
 331 static inline uint64_t random_u64(void) {
 332         uint64_t u;
 333         random_bytes(&u, sizeof(u));
 334         return u;
 335 }
 336
 337 static inline uint32_t random_u32(void) {
 338         uint32_t u;
 339         random_bytes(&u, sizeof(u));
 340         return u;
 341 }
 342
 343 /* For basic lookup tables with strictly enumerated entries */
 344 #define _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope)          \
 345         scope const char *name##_to_string(type i) {                    \
 346                 if (i < 0 || i >= (type) ELEMENTSOF(name##_table))      \
 347                         return NULL;                                    \
 348                 return name##_table[i];                                 \
 349         }
 350
 351 ssize_t string_table_lookup(const char * const *table, size_t len, const char *key);
 352
 353 #define _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope)                                \
 354         scope inline type name##_from_string(const char *s) {                                   \
 355                 return (type)string_table_lookup(name##_table, ELEMENTSOF(name##_table), s);    \
 356         }
 357
 358 #define _DEFINE_STRING_TABLE_LOOKUP(name,type,scope)                    \
 359         _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope)          \
 360         _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope)        \
 361         struct __useless_struct_to_allow_trailing_semicolon__
 362
 363 #define DEFINE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,)
 364 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,static)
 365 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_TO_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,static)
 366 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_FROM_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,static)
 367
 368 /* For string conversions where numbers are also acceptable */
 369 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max)         \
 370         int name##_to_string_alloc(type i, char **str) {                \
 371                 char *s;                                                \
 372                 int r;                                                  \
 373                 if (i < 0 || i > max)                                   \
 374                         return -ERANGE;                                 \
 375                 if (i < (type) ELEMENTSOF(name##_table)) {              \
 376                         s = strdup(name##_table[i]);                    \
 377                         if (!s)                                         \
 378                                 return log_oom();                       \
 379                 } else {                                                \
 380                         r = asprintf(&s, "%i", i);                      \
 381                         if (r < 0)                                      \
 382                                 return log_oom();                       \
 383                 }                                                       \
 384                 *str = s;                                               \
 385                 return 0;                                               \
 386         }                                                               \
 387         type name##_from_string(const char *s) {                        \
 388                 type i;                                                 \
 389                 unsigned u = 0;                                         \
 390                 assert(s);                                              \
 391                 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
 392                         if (name##_table[i] &&                          \
 393                             streq(name##_table[i], s))                  \
 394                                 return i;                               \
 395                 if (safe_atou(s, &u) >= 0 && u <= max)                  \
 396                         return (type) u;                                \
 397                 return (type) -1;                                       \
 398         }                                                               \
 399         struct __useless_struct_to_allow_trailing_semicolon__
 400
 401 int fd_nonblock(int fd, bool nonblock);
 402 int fd_cloexec(int fd, bool cloexec);
 403
 404 int close_all_fds(const int except[], unsigned n_except);
 405
 406 bool fstype_is_network(const char *fstype);
 407
 408 int chvt(int vt);
 409
 410 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
 411 int ask_char(char *ret, const char *replies, const char *text, ...) _printf_(3, 4);
 412 int ask_string(char **ret, const char *text, ...) _printf_(2, 3);
 413
 414 int reset_terminal_fd(int fd, bool switch_to_text);
 415 int reset_terminal(const char *name);
 416
 417 int open_terminal(const char *name, int mode);
 418 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
 419 int release_terminal(void);
 420
 421 int flush_fd(int fd);
 422
 423 int ignore_signals(int sig, ...);
 424 int default_signals(int sig, ...);
 425 int sigaction_many(const struct sigaction *sa, ...);
 426
 427 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
 428
 429 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
 430 int loop_read_exact(int fd, void *buf, size_t nbytes, bool do_poll);
 431 int loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
 432
 433 bool is_device_path(const char *path);
 434
 435 int dir_is_empty(const char *path);
 436 char* dirname_malloc(const char *path);
 437
 438 void sigset_add_many(sigset_t *ss, ...);
 439 int sigprocmask_many(int how, ...);
 440
 441 bool hostname_is_set(void);
 442
 443 char* lookup_uid(uid_t uid);
 444 char* gethostname_malloc(void);
 445 char* getlogname_malloc(void);
 446 char* getusername_malloc(void);
 447
 448 int getttyname_malloc(int fd, char **r);
 449 int getttyname_harder(int fd, char **r);
 450
 451 int get_ctty_devnr(pid_t pid, dev_t *d);
 452 int get_ctty(pid_t, dev_t *_devnr, char **r);
 453
 454 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
 455 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
 456
 457 bool is_temporary_fs(const struct statfs *s) _pure_;
 458 int fd_is_temporary_fs(int fd);
 459
 460 int pipe_eof(int fd);
 461
 462 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
 463
 464 int status_vprintf(const char *status, bool ellipse, bool ephemeral, const char *format, va_list ap) _printf_(4,0);
 465 int status_printf(const char *status, bool ellipse, bool ephemeral, const char *format, ...) _printf_(4,5);
 466
 467 #define xsprintf(buf, fmt, ...) assert_se((size_t) snprintf(buf, ELEMENTSOF(buf), fmt, __VA_ARGS__) < ELEMENTSOF(buf))
 468
 469 int fd_columns(int fd);
 470 unsigned columns(void);
 471 int fd_lines(int fd);
 472 unsigned lines(void);
 473 void columns_lines_cache_reset(int _unused_ signum);
 474
 475 bool on_tty(void);
 476
 477 static inline const char *ansi_highlight(void) {
 478         return on_tty() ? ANSI_HIGHLIGHT_ON : "";
 479 }
 480
 481 static inline const char *ansi_highlight_red(void) {
 482         return on_tty() ? ANSI_HIGHLIGHT_RED_ON : "";
 483 }
 484
 485 static inline const char *ansi_highlight_green(void) {
 486         return on_tty() ? ANSI_HIGHLIGHT_GREEN_ON : "";
 487 }
 488
 489 static inline const char *ansi_highlight_yellow(void) {
 490         return on_tty() ? ANSI_HIGHLIGHT_YELLOW_ON : "";
 491 }
 492
 493 static inline const char *ansi_highlight_blue(void) {
 494         return on_tty() ? ANSI_HIGHLIGHT_BLUE_ON : "";
 495 }
 496
 497 static inline const char *ansi_highlight_off(void) {
 498         return on_tty() ? ANSI_HIGHLIGHT_OFF : "";
 499 }
 500
 501 int files_same(const char *filea, const char *fileb);
 502
 503 int running_in_chroot(void);
 504
 505 char *ellipsize(const char *s, size_t length, unsigned percent);
 506                                    /* bytes                 columns */
 507 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
 508
 509 int touch_file(const char *path, bool parents, usec_t stamp, uid_t uid, gid_t gid, mode_t mode);
 510 int touch(const char *path);
 511
 512 noreturn void freeze(void);
 513
 514 bool null_or_empty(struct stat *st) _pure_;
 515 int null_or_empty_path(const char *fn);
 516 int null_or_empty_fd(int fd);
 517
 518 DIR *xopendirat(int dirfd, const char *name, int flags);
 519
 520 char *fstab_node_to_udev_node(const char *p);
 521
 522 char *resolve_dev_console(char **active);
 523 bool tty_is_vc(const char *tty);
 524 bool tty_is_vc_resolve(const char *tty);
 525 bool tty_is_console(const char *tty) _pure_;
 526 int vtnr_from_tty(const char *tty);
 527 const char *default_term_for_tty(const char *tty);
 528
 529 void execute_directories(const char* const* directories, usec_t timeout, char *argv[]);
 530
 531 bool nulstr_contains(const char*nulstr, const char *needle);
 532
 533 bool plymouth_running(void);
 534
 535 bool hostname_is_valid(const char *s) _pure_;
 536 char* hostname_cleanup(char *s, bool lowercase);
 537
 538 bool machine_name_is_valid(const char *s) _pure_;
 539
 540 char* strshorten(char *s, size_t l);
 541
 542 int terminal_vhangup_fd(int fd);
 543 int terminal_vhangup(const char *name);
 544
 545 int vt_disallocate(const char *name);
 546
 547 int symlink_atomic(const char *from, const char *to);
 548 int mknod_atomic(const char *path, mode_t mode, dev_t dev);
 549 int mkfifo_atomic(const char *path, mode_t mode);
 550
 551 int fchmod_umask(int fd, mode_t mode);
 552
 553 bool display_is_local(const char *display) _pure_;
 554 int socket_from_display(const char *display, char **path);
 555
 556 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
 557 int get_group_creds(const char **groupname, gid_t *gid);
 558
 559 int in_gid(gid_t gid);
 560 int in_group(const char *name);
 561
 562 char* uid_to_name(uid_t uid);
 563 char* gid_to_name(gid_t gid);
 564
 565 int glob_exists(const char *path);
 566 int glob_extend(char ***strv, const char *path);
 567
 568 int dirent_ensure_type(DIR *d, struct dirent *de);
 569
 570 int get_files_in_directory(const char *path, char ***list);
 571
 572 char *strjoin(const char *x, ...) _sentinel_;
 573
 574 bool is_main_thread(void);
 575
 576 static inline bool _pure_ in_charset(const char *s, const char* charset) {
 577         assert(s);
 578         assert(charset);
 579         return s[strspn(s, charset)] == '\0';
 580 }
 581
 582 int block_get_whole_disk(dev_t d, dev_t *ret);
 583
 584 #define NULSTR_FOREACH(i, l)                                    \
 585         for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
 586
 587 #define NULSTR_FOREACH_PAIR(i, j, l)                             \
 588         for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
 589
 590 int ioprio_class_to_string_alloc(int i, char **s);
 591 int ioprio_class_from_string(const char *s);
 592
 593 const char *sigchld_code_to_string(int i) _const_;
 594 int sigchld_code_from_string(const char *s) _pure_;
 595
 596 int log_facility_unshifted_to_string_alloc(int i, char **s);
 597 int log_facility_unshifted_from_string(const char *s);
 598
 599 int log_level_to_string_alloc(int i, char **s);
 600 int log_level_from_string(const char *s);
 601
 602 int sched_policy_to_string_alloc(int i, char **s);
 603 int sched_policy_from_string(const char *s);
 604
 605 const char *rlimit_to_string(int i) _const_;
 606 int rlimit_from_string(const char *s) _pure_;
 607
 608 int ip_tos_to_string_alloc(int i, char **s);
 609 int ip_tos_from_string(const char *s);
 610
 611 const char *signal_to_string(int i) _const_;
 612 int signal_from_string(const char *s) _pure_;
 613
 614 int signal_from_string_try_harder(const char *s);
 615
 616 extern int saved_argc;
 617 extern char **saved_argv;
 618
 619 bool kexec_loaded(void);
 620
 621 int prot_from_flags(int flags) _const_;
 622
 623 char *format_bytes(char *buf, size_t l, off_t t);
 624
 625 int fd_wait_for_event(int fd, int event, usec_t timeout);
 626
 627 void* memdup(const void *p, size_t l) _alloc_(2);
 628
 629 int fd_inc_sndbuf(int fd, size_t n);
 630 int fd_inc_rcvbuf(int fd, size_t n);
 631
 632 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
 633
 634 int setrlimit_closest(int resource, const struct rlimit *rlim);
 635
 636 bool http_url_is_valid(const char *url) _pure_;
 637 bool documentation_url_is_valid(const char *url) _pure_;
 638
 639 bool http_etag_is_valid(const char *etag);
 640
 641 bool in_initrd(void);
 642
 643 void warn_melody(void);
 644
 645 int get_home_dir(char **ret);
 646 int get_shell(char **_ret);
 647
 648 static inline void freep(void *p) {
 649         free(*(void**) p);
 650 }
 651
 652 static inline void closep(int *fd) {
 653         safe_close(*fd);
 654 }
 655
 656 static inline void umaskp(mode_t *u) {
 657         umask(*u);
 658 }
 659
 660 static inline void close_pairp(int (*p)[2]) {
 661         safe_close_pair(*p);
 662 }
 663
 664 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, fclose);
 665 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, pclose);
 666 DEFINE_TRIVIAL_CLEANUP_FUNC(DIR*, closedir);
 667 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, endmntent);
 668
 669 #define _cleanup_free_ _cleanup_(freep)
 670 #define _cleanup_close_ _cleanup_(closep)
 671 #define _cleanup_umask_ _cleanup_(umaskp)
 672 #define _cleanup_globfree_ _cleanup_(globfree)
 673 #define _cleanup_fclose_ _cleanup_(fclosep)
 674 #define _cleanup_pclose_ _cleanup_(pclosep)
 675 #define _cleanup_closedir_ _cleanup_(closedirp)
 676 #define _cleanup_endmntent_ _cleanup_(endmntentp)
 677 #define _cleanup_close_pair_ _cleanup_(close_pairp)
 678
 679 _malloc_  _alloc_(1, 2) static inline void *malloc_multiply(size_t a, size_t b) {
 680         if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
 681                 return NULL;
 682
 683         return malloc(a * b);
 684 }
 685
 686 _alloc_(2, 3) static inline void *realloc_multiply(void *p, size_t a, size_t b) {
 687         if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
 688                 return NULL;
 689
 690         return realloc(p, a * b);
 691 }
 692
 693 _alloc_(2, 3) static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
 694         if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
 695                 return NULL;
 696
 697         return memdup(p, a * b);
 698 }
 699
 700 bool filename_is_valid(const char *p) _pure_;
 701 bool path_is_safe(const char *p) _pure_;
 702 bool string_is_safe(const char *p) _pure_;
 703 bool string_has_cc(const char *p, const char *ok) _pure_;
 704
 705 /**
 706  * Check if a string contains any glob patterns.
 707  */
 708 _pure_ static inline bool string_is_glob(const char *p) {
 709         return !!strpbrk(p, GLOB_CHARS);
 710 }
 711
 712 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
 713                  int (*compar) (const void *, const void *, void *),
 714                  void *arg);
 715
 716 #define _(String) gettext (String)
 717 void init_gettext(void);
 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 (hidden_file((de)->d_name))                   \
 760                         continue;                                       \
 761                 else
 762
 763 #define FOREACH_DIRENT_ALL(de, d, on_error)                             \
 764         for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d))   \
 765                 if (!de) {                                              \
 766                         if (errno > 0) {                                \
 767                                 on_error;                               \
 768                         }                                               \
 769                         break;                                          \
 770                 } else
 771
 772 static inline void *mempset(void *s, int c, size_t n) {
 773         memset(s, c, n);
 774         return (uint8_t*)s + n;
 775 }
 776
 777 char *hexmem(const void *p, size_t l);
 778 void *unhexmem(const char *p, size_t l);
 779
 780 char *strextend(char **x, ...) _sentinel_;
 781 char *strrep(const char *s, unsigned n);
 782
 783 void* greedy_realloc(void **p, size_t *allocated, size_t need, size_t size);
 784 void* greedy_realloc0(void **p, size_t *allocated, size_t need, size_t size);
 785 #define GREEDY_REALLOC(array, allocated, need)                          \
 786         greedy_realloc((void**) &(array), &(allocated), (need), sizeof((array)[0]))
 787
 788 #define GREEDY_REALLOC0(array, allocated, need)                         \
 789         greedy_realloc0((void**) &(array), &(allocated), (need), sizeof((array)[0]))
 790
 791 static inline void _reset_errno_(int *saved_errno) {
 792         errno = *saved_errno;
 793 }
 794
 795 #define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
 796
 797 static inline int negative_errno(void) {
 798         /* This helper should be used to shut up gcc if you know 'errno' is
 799          * negative. Instead of "return -errno;", use "return negative_errno();"
 800          * It will suppress bogus gcc warnings in case it assumes 'errno' might
 801          * be 0 and thus the caller's error-handling might not be triggered. */
 802         assert_return(errno > 0, -EINVAL);
 803         return -errno;
 804 }
 805
 806 struct _umask_struct_ {
 807         mode_t mask;
 808         bool quit;
 809 };
 810
 811 static inline void _reset_umask_(struct _umask_struct_ *s) {
 812         umask(s->mask);
 813 };
 814
 815 #define RUN_WITH_UMASK(mask)                                            \
 816         for (_cleanup_(_reset_umask_) struct _umask_struct_ _saved_umask_ = { umask(mask), false }; \
 817              !_saved_umask_.quit ;                                      \
 818              _saved_umask_.quit = true)
 819
 820 static inline unsigned u64log2(uint64_t n) {
 821 #if __SIZEOF_LONG_LONG__ == 8
 822         return (n > 1) ? (unsigned) __builtin_clzll(n) ^ 63U : 0;
 823 #else
 824 #error "Wut?"
 825 #endif
 826 }
 827
 828 static inline unsigned u32ctz(uint32_t n) {
 829 #if __SIZEOF_INT__ == 4
 830         return __builtin_ctz(n);
 831 #else
 832 #error "Wut?"
 833 #endif
 834 }
 835
 836 static inline unsigned log2i(int x) {
 837         assert(x > 0);
 838
 839         return __SIZEOF_INT__ * 8 - __builtin_clz(x) - 1;
 840 }
 841
 842 static inline unsigned log2u(unsigned x) {
 843         assert(x > 0);
 844
 845         return sizeof(unsigned) * 8 - __builtin_clz(x) - 1;
 846 }
 847
 848 static inline unsigned log2u_round_up(unsigned x) {
 849         assert(x > 0);
 850
 851         if (x == 1)
 852                 return 0;
 853
 854         return log2u(x - 1) + 1;
 855 }
 856
 857 static inline bool logind_running(void) {
 858         return access("/run/systemd/seats/", F_OK) >= 0;
 859 }
 860
 861 #define DECIMAL_STR_WIDTH(x)                            \
 862         ({                                              \
 863                 typeof(x) _x_ = (x);                    \
 864                 unsigned ans = 1;                       \
 865                 while (_x_ /= 10)                       \
 866                         ans++;                          \
 867                 ans;                                    \
 868         })
 869
 870 int unlink_noerrno(const char *path);
 871
 872 #define alloca0(n)                                      \
 873         ({                                              \
 874                 char *_new_;                            \
 875                 size_t _len_ = n;                       \
 876                 _new_ = alloca(_len_);                  \
 877                 (void *) memset(_new_, 0, _len_);       \
 878         })
 879
 880 /* It's not clear what alignment glibc/gcc alloca() guarantee, hence provide a guaranteed safe version */
 881 #define alloca_align(size, align)                                       \
 882         ({                                                              \
 883                 void *_ptr_;                                            \
 884                 size_t _mask_ = (align) - 1;                            \
 885                 _ptr_ = alloca((size) + _mask_);                        \
 886                 (void*)(((uintptr_t)_ptr_ + _mask_) & ~_mask_);         \
 887         })
 888
 889 #define alloca0_align(size, align)                                      \
 890         ({                                                              \
 891                 void *_new_;                                            \
 892                 size_t _size_ = (size);                                 \
 893                 _new_ = alloca_align(_size_, (align));                  \
 894                 (void*)memset(_new_, 0, _size_);                        \
 895         })
 896
 897 #define strjoina(a, ...)                                                \
 898         ({                                                              \
 899                 const char *_appendees_[] = { a, __VA_ARGS__ };         \
 900                 char *_d_, *_p_;                                        \
 901                 int _len_ = 0;                                          \
 902                 unsigned _i_;                                           \
 903                 for (_i_ = 0; _i_ < ELEMENTSOF(_appendees_) && _appendees_[_i_]; _i_++) \
 904                         _len_ += strlen(_appendees_[_i_]);              \
 905                 _p_ = _d_ = alloca(_len_ + 1);                          \
 906                 for (_i_ = 0; _i_ < ELEMENTSOF(_appendees_) && _appendees_[_i_]; _i_++) \
 907                         _p_ = stpcpy(_p_, _appendees_[_i_]);            \
 908                 *_p_ = 0;                                               \
 909                 _d_;                                                    \
 910         })
 911
 912 bool id128_is_valid(const char *s) _pure_;
 913
 914 int split_pair(const char *s, const char *sep, char **l, char **r);
 915
 916 int shall_restore_state(void);
 917
 918 /**
 919  * Normal qsort requires base to be nonnull. Here were require
 920  * that only if nmemb > 0.
 921  */
 922 static inline void qsort_safe(void *base, size_t nmemb, size_t size,
 923                               int (*compar)(const void *, const void *)) {
 924         if (nmemb) {
 925                 assert(base);
 926                 qsort(base, nmemb, size, compar);
 927         }
 928 }
 929
 930 int proc_cmdline(char **ret);
 931 int parse_proc_cmdline(int (*parse_word)(const char *key, const char *value));
 932 int get_proc_cmdline_key(const char *parameter, char **value);
 933
 934 int container_get_leader(const char *machine, pid_t *pid);
 935
 936 int namespace_open(pid_t pid, int *pidns_fd, int *mntns_fd, int *netns_fd, int *root_fd);
 937 int namespace_enter(int pidns_fd, int mntns_fd, int netns_fd, int root_fd);
 938
 939 int getpeercred(int fd, struct ucred *ucred);
 940 int getpeersec(int fd, char **ret);
 941
 942 int writev_safe(int fd, const struct iovec *w, int j);
 943
 944 int mkostemp_safe(char *pattern, int flags);
 945 int open_tmpfile(const char *path, int flags);
 946
 947 int fd_warn_permissions(const char *path, int fd);
 948
 949 unsigned long personality_from_string(const char *p);
 950 const char *personality_to_string(unsigned long);
 951
 952 uint64_t physical_memory(void);
 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 #define FILE_HANDLE_INIT { .handle.handle_bytes = MAX_HANDLE_SZ }
 961
 962 int update_reboot_param_file(const char *param);
 963
 964 int umount_recursive(const char *target, int flags);
 965
 966 int bind_remount_recursive(const char *prefix, bool ro);
 967
 968 int fflush_and_check(FILE *f);
 969
 970 int tempfn_xxxxxx(const char *p, char **ret);
 971 int tempfn_random(const char *p, char **ret);
 972 int tempfn_random_child(const char *p, char **ret);
 973
 974 bool is_localhost(const char *hostname);
 975
 976 int take_password_lock(const char *root);
 977
 978 int is_symlink(const char *path);
 979 int is_dir(const char *path, bool follow);
 980
 981 typedef enum UnquoteFlags {
 982         UNQUOTE_RELAX     = 1,
 983         UNQUOTE_CUNESCAPE = 2,
 984 } UnquoteFlags;
 985
 986 int unquote_first_word(const char **p, char **ret, UnquoteFlags flags);
 987 int unquote_many_words(const char **p, UnquoteFlags flags, ...) _sentinel_;
 988
 989 int free_and_strdup(char **p, const char *s);
 990
 991 int sethostname_idempotent(const char *s);
 992
 993 #define INOTIFY_EVENT_MAX (sizeof(struct inotify_event) + NAME_MAX + 1)
 994
 995 #define FOREACH_INOTIFY_EVENT(e, buffer, sz) \
 996         for ((e) = &buffer.ev;                                \
 997              (uint8_t*) (e) < (uint8_t*) (buffer.raw) + (sz); \
 998              (e) = (struct inotify_event*) ((uint8_t*) (e) + sizeof(struct inotify_event) + (e)->len))
 999
1000 union inotify_event_buffer {
1001         struct inotify_event ev;
1002         uint8_t raw[INOTIFY_EVENT_MAX];
1003 };
1004
1005 #define laccess(path, mode) faccessat(AT_FDCWD, (path), (mode), AT_SYMLINK_NOFOLLOW)
1006
1007 int ptsname_malloc(int fd, char **ret);
1008
1009 int openpt_in_namespace(pid_t pid, int flags);
1010
1011 ssize_t fgetxattrat_fake(int dirfd, const char *filename, const char *attribute, void *value, size_t size, int flags);
1012
1013 int fd_setcrtime(int fd, usec_t usec);
1014 int fd_getcrtime(int fd, usec_t *usec);
1015 int path_getcrtime(const char *p, usec_t *usec);
1016 int fd_getcrtime_at(int dirfd, const char *name, usec_t *usec, int flags);
1017
1018 int chattr_fd(int fd, unsigned value, unsigned mask);
1019 int chattr_path(const char *p, unsigned value, unsigned mask);
1020
1021 int read_attr_fd(int fd, unsigned *ret);
1022 int read_attr_path(const char *p, unsigned *ret);
1023
1024 typedef struct LockFile {
1025         char *path;
1026         int fd;
1027         int operation;
1028 } LockFile;
1029
1030 int make_lock_file(const char *p, int operation, LockFile *ret);
1031 int make_lock_file_for(const char *p, int operation, LockFile *ret);
1032 void release_lock_file(LockFile *f);
1033
1034 #define _cleanup_release_lock_file_ _cleanup_(release_lock_file)
1035
1036 #define LOCK_FILE_INIT { .fd = -1, .path = NULL }
1037
1038 #define RLIMIT_MAKE_CONST(lim) ((struct rlimit) { lim, lim })
1039
1040 ssize_t sparse_write(int fd, const void *p, size_t sz, size_t run_length);
1041
1042 void sigkill_wait(pid_t *pid);
1043 #define _cleanup_sigkill_wait_ _cleanup_(sigkill_wait)
1044
1045 int syslog_parse_priority(const char **p, int *priority, bool with_facility);
1046
1047 void cmsg_close_all(struct msghdr *mh);
1048
1049 int rename_noreplace(int olddirfd, const char *oldpath, int newdirfd, const char *newpath);
1050
1051 char *shell_maybe_quote(const char *s);
1052
1053 int parse_mode(const char *s, mode_t *ret);