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