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