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