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