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