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