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