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 <inttypes.h>
  25 #include <time.h>
  26 #include <sys/time.h>
  27 #include <stdarg.h>
  28 #include <stdbool.h>
  29 #include <stdlib.h>
  30 #include <stdio.h>
  31 #include <signal.h>
  32 #include <sched.h>
  33 #include <limits.h>
  34 #include <sys/types.h>
  35 #include <sys/stat.h>
  36 #include <dirent.h>
  37 #include <sys/resource.h>
  38 #include <stddef.h>
  39
  40 #include "macro.h"
  41 #include "time-util.h"
  42
  43 union dirent_storage {
  44         struct dirent de;
  45         uint8_t storage[offsetof(struct dirent, d_name) +
  46                         ((NAME_MAX + 1 + sizeof(long)) & ~(sizeof(long) - 1))];
  47 };
  48
  49 /* What is interpreted as whitespace? */
  50 #define WHITESPACE " \t\n\r"
  51 #define NEWLINE "\n\r"
  52 #define QUOTES "\"\'"
  53 #define COMMENTS "#;\n"
  54
  55 #define FORMAT_BYTES_MAX 8
  56
  57 #define ANSI_HIGHLIGHT_ON "\x1B[1;39m"
  58 #define ANSI_RED_ON "\x1B[31m"
  59 #define ANSI_HIGHLIGHT_RED_ON "\x1B[1;31m"
  60 #define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
  61 #define ANSI_HIGHLIGHT_YELLOW_ON "\x1B[1;33m"
  62 #define ANSI_HIGHLIGHT_OFF "\x1B[0m"
  63 #define ANSI_ERASE_TO_END_OF_LINE "\x1B[K"
  64
  65 size_t page_size(void);
  66 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
  67
  68 #define streq(a,b) (strcmp((a),(b)) == 0)
  69 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
  70 #define strcaseeq(a,b) (strcasecmp((a),(b)) == 0)
  71 #define strncaseeq(a, b, n) (strncasecmp((a), (b), (n)) == 0)
  72
  73 bool streq_ptr(const char *a, const char *b);
  74
  75 #define new(t, n) ((t*) malloc_multiply(sizeof(t), (n)))
  76
  77 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
  78
  79 #define newa(t, n) ((t*) alloca(sizeof(t)*(n)))
  80
  81 #define newdup(t, p, n) ((t*) memdup_multiply(p, sizeof(t), (n)))
  82
  83 #define malloc0(n) (calloc((n), 1))
  84
  85 static inline const char* yes_no(bool b) {
  86         return b ? "yes" : "no";
  87 }
  88
  89 static inline const char* strempty(const char *s) {
  90         return s ? s : "";
  91 }
  92
  93 static inline const char* strnull(const char *s) {
  94         return s ? s : "(null)";
  95 }
  96
  97 static inline const char *strna(const char *s) {
  98         return s ? s : "n/a";
  99 }
 100
 101 static inline bool isempty(const char *p) {
 102         return !p || !p[0];
 103 }
 104
 105 char *endswith(const char *s, const char *postfix);
 106 char *startswith(const char *s, const char *prefix);
 107 char *startswith_no_case(const char *s, const char *prefix);
 108
 109 bool first_word(const char *s, const char *word);
 110
 111 int close_nointr(int fd);
 112 void close_nointr_nofail(int fd);
 113 void close_many(const int fds[], unsigned n_fd);
 114
 115 int parse_boolean(const char *v);
 116 int parse_bytes(const char *t, off_t *bytes);
 117 int parse_pid(const char *s, pid_t* ret_pid);
 118 int parse_uid(const char *s, uid_t* ret_uid);
 119 #define parse_gid(s, ret_uid) parse_uid(s, ret_uid)
 120
 121 int safe_atou(const char *s, unsigned *ret_u);
 122 int safe_atoi(const char *s, int *ret_i);
 123
 124 int safe_atollu(const char *s, unsigned long long *ret_u);
 125 int safe_atolli(const char *s, long long int *ret_i);
 126
 127 int safe_atod(const char *s, double *ret_d);
 128
 129 #if __WORDSIZE == 32
 130 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
 131         assert_cc(sizeof(unsigned long) == sizeof(unsigned));
 132         return safe_atou(s, (unsigned*) ret_u);
 133 }
 134 static inline int safe_atoli(const char *s, long int *ret_u) {
 135         assert_cc(sizeof(long int) == sizeof(int));
 136         return safe_atoi(s, (int*) ret_u);
 137 }
 138 #else
 139 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
 140         assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
 141         return safe_atollu(s, (unsigned long long*) ret_u);
 142 }
 143 static inline int safe_atoli(const char *s, long int *ret_u) {
 144         assert_cc(sizeof(long int) == sizeof(long long int));
 145         return safe_atolli(s, (long long int*) ret_u);
 146 }
 147 #endif
 148
 149 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
 150         assert_cc(sizeof(uint32_t) == sizeof(unsigned));
 151         return safe_atou(s, (unsigned*) ret_u);
 152 }
 153
 154 static inline int safe_atoi32(const char *s, int32_t *ret_i) {
 155         assert_cc(sizeof(int32_t) == sizeof(int));
 156         return safe_atoi(s, (int*) ret_i);
 157 }
 158
 159 static inline int safe_atou64(const char *s, uint64_t *ret_u) {
 160         assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
 161         return safe_atollu(s, (unsigned long long*) ret_u);
 162 }
 163
 164 static inline int safe_atoi64(const char *s, int64_t *ret_i) {
 165         assert_cc(sizeof(int64_t) == sizeof(long long int));
 166         return safe_atolli(s, (long long int*) ret_i);
 167 }
 168
 169 char *split(const char *c, size_t *l, const char *separator, char **state);
 170 char *split_quoted(const char *c, size_t *l, char **state);
 171
 172 #define FOREACH_WORD(word, length, s, state)                            \
 173         for ((state) = NULL, (word) = split((s), &(length), WHITESPACE, &(state)); (word); (word) = split((s), &(length), WHITESPACE, &(state)))
 174
 175 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state)       \
 176         for ((state) = NULL, (word) = split((s), &(length), (separator), &(state)); (word); (word) = split((s), &(length), (separator), &(state)))
 177
 178 #define FOREACH_WORD_QUOTED(word, length, s, state)                     \
 179         for ((state) = NULL, (word) = split_quoted((s), &(length), &(state)); (word); (word) = split_quoted((s), &(length), &(state)))
 180
 181 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
 182 int get_starttime_of_pid(pid_t pid, unsigned long long *st);
 183
 184 char *strappend(const char *s, const char *suffix);
 185 char *strnappend(const char *s, const char *suffix, size_t length);
 186
 187 char *replace_env(const char *format, char **env);
 188 char **replace_env_argv(char **argv, char **env);
 189
 190 int readlink_malloc(const char *p, char **r);
 191 int readlink_and_make_absolute(const char *p, char **r);
 192 int readlink_and_canonicalize(const char *p, char **r);
 193
 194 int reset_all_signal_handlers(void);
 195
 196 char *strstrip(char *s);
 197 char *delete_chars(char *s, const char *bad);
 198 char *truncate_nl(char *s);
 199
 200 char *file_in_same_dir(const char *path, const char *filename);
 201
 202 int rmdir_parents(const char *path, const char *stop);
 203
 204 int get_process_comm(pid_t pid, char **name);
 205 int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
 206 int get_process_exe(pid_t pid, char **name);
 207 int get_process_uid(pid_t pid, uid_t *uid);
 208 int get_process_gid(pid_t pid, gid_t *gid);
 209
 210 char hexchar(int x);
 211 int unhexchar(char c);
 212 char octchar(int x);
 213 int unoctchar(char c);
 214 char decchar(int x);
 215 int undecchar(char c);
 216
 217 char *cescape(const char *s);
 218 char *cunescape(const char *s);
 219 char *cunescape_length(const char *s, size_t length);
 220 char *cunescape_length_with_prefix(const char *s, size_t length, const char *prefix);
 221
 222 char *xescape(const char *s, const char *bad);
 223
 224 char *bus_path_escape(const char *s);
 225 char *bus_path_unescape(const char *s);
 226
 227 char *ascii_strlower(char *path);
 228
 229 bool dirent_is_file(const struct dirent *de);
 230 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix);
 231
 232 bool ignore_file(const char *filename);
 233
 234 bool chars_intersect(const char *a, const char *b);
 235
 236 int make_stdio(int fd);
 237 int make_null_stdio(void);
 238 int make_console_stdio(void);
 239
 240 unsigned long long random_ull(void);
 241
 242 /* For basic lookup tables with strictly enumerated entries */
 243 #define __DEFINE_STRING_TABLE_LOOKUP(name,type,scope)                   \
 244         scope const char *name##_to_string(type i) {                    \
 245                 if (i < 0 || i >= (type) ELEMENTSOF(name##_table))      \
 246                         return NULL;                                    \
 247                 return name##_table[i];                                 \
 248         }                                                               \
 249         scope type name##_from_string(const char *s) {                  \
 250                 type i;                                                 \
 251                 assert(s);                                              \
 252                 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
 253                         if (name##_table[i] &&                          \
 254                             streq(name##_table[i], s))                  \
 255                                 return i;                               \
 256                 return (type) -1;                                       \
 257         }                                                               \
 258         struct __useless_struct_to_allow_trailing_semicolon__
 259
 260 #define DEFINE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,)
 261 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,static)
 262
 263 /* For string conversions where numbers are also acceptable */
 264 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max)         \
 265         int name##_to_string_alloc(type i, char **str) {                \
 266                 char *s;                                                \
 267                 int r;                                                  \
 268                 if (i < 0 || i > max)                                   \
 269                         return -ERANGE;                                 \
 270                 if (i < (type) ELEMENTSOF(name##_table)) {              \
 271                         s = strdup(name##_table[i]);                    \
 272                         if (!s)                                         \
 273                                 return log_oom();                       \
 274                 } else {                                                \
 275                         r = asprintf(&s, "%u", i);                      \
 276                         if (r < 0)                                      \
 277                                 return log_oom();                       \
 278                 }                                                       \
 279                 *str = s;                                               \
 280                 return 0;                                               \
 281         }                                                               \
 282         type name##_from_string(const char *s) {                        \
 283                 type i;                                                 \
 284                 unsigned u = 0;                                         \
 285                 assert(s);                                              \
 286                 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
 287                         if (name##_table[i] &&                          \
 288                             streq(name##_table[i], s))                  \
 289                                 return i;                               \
 290                 if (safe_atou(s, &u) >= 0 && u <= max)                  \
 291                         return (type) u;                                \
 292                 return (type) -1;                                       \
 293         }                                                               \
 294         struct __useless_struct_to_allow_trailing_semicolon__
 295
 296 int fd_nonblock(int fd, bool nonblock);
 297 int fd_cloexec(int fd, bool cloexec);
 298
 299 int close_all_fds(const int except[], unsigned n_except);
 300
 301 bool fstype_is_network(const char *fstype);
 302
 303 int chvt(int vt);
 304
 305 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
 306 int ask(char *ret, const char *replies, const char *text, ...);
 307
 308 int reset_terminal_fd(int fd, bool switch_to_text);
 309 int reset_terminal(const char *name);
 310
 311 int open_terminal(const char *name, int mode);
 312 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
 313 int release_terminal(void);
 314
 315 int flush_fd(int fd);
 316
 317 int ignore_signals(int sig, ...);
 318 int default_signals(int sig, ...);
 319 int sigaction_many(const struct sigaction *sa, ...);
 320
 321 int close_pipe(int p[]);
 322 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
 323
 324 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
 325 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
 326
 327 bool is_device_path(const char *path);
 328
 329 int dir_is_empty(const char *path);
 330
 331 void rename_process(const char name[8]);
 332
 333 void sigset_add_many(sigset_t *ss, ...);
 334
 335 bool hostname_is_set(void);
 336
 337 char* gethostname_malloc(void);
 338 char* getlogname_malloc(void);
 339 char* getusername_malloc(void);
 340
 341 int getttyname_malloc(int fd, char **r);
 342 int getttyname_harder(int fd, char **r);
 343
 344 int get_ctty_devnr(pid_t pid, dev_t *d);
 345 int get_ctty(pid_t, dev_t *_devnr, char **r);
 346
 347 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
 348 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
 349
 350 int rm_rf_children(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
 351 int rm_rf_children_dangerous(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
 352 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
 353 int rm_rf_dangerous(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
 354
 355 int pipe_eof(int fd);
 356
 357 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
 358
 359 int status_vprintf(const char *status, bool ellipse, bool ephemeral, const char *format, va_list ap);
 360 int status_printf(const char *status, bool ellipse, bool ephemeral, const char *format, ...);
 361 int status_welcome(void);
 362
 363 int fd_columns(int fd);
 364 unsigned columns(void);
 365 int fd_lines(int fd);
 366 unsigned lines(void);
 367 void columns_lines_cache_reset(int _unused_ signum);
 368
 369 bool on_tty(void);
 370
 371 int running_in_chroot(void);
 372
 373 char *ellipsize(const char *s, size_t length, unsigned percent);
 374 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
 375
 376 int touch(const char *path);
 377
 378 char *unquote(const char *s, const char *quotes);
 379 char *normalize_env_assignment(const char *s);
 380
 381 int wait_for_terminate(pid_t pid, siginfo_t *status);
 382 int wait_for_terminate_and_warn(const char *name, pid_t pid);
 383
 384 _noreturn_ void freeze(void);
 385
 386 bool null_or_empty(struct stat *st);
 387 int null_or_empty_path(const char *fn);
 388
 389 DIR *xopendirat(int dirfd, const char *name, int flags);
 390
 391 char *fstab_node_to_udev_node(const char *p);
 392
 393 char *resolve_dev_console(char **active);
 394 bool tty_is_vc(const char *tty);
 395 bool tty_is_vc_resolve(const char *tty);
 396 bool tty_is_console(const char *tty);
 397 int vtnr_from_tty(const char *tty);
 398 const char *default_term_for_tty(const char *tty);
 399
 400 void execute_directory(const char *directory, DIR *_d, char *argv[]);
 401
 402 int kill_and_sigcont(pid_t pid, int sig);
 403
 404 bool nulstr_contains(const char*nulstr, const char *needle);
 405
 406 bool plymouth_running(void);
 407
 408 bool hostname_is_valid(const char *s);
 409 char* hostname_cleanup(char *s);
 410
 411 char* strshorten(char *s, size_t l);
 412
 413 int terminal_vhangup_fd(int fd);
 414 int terminal_vhangup(const char *name);
 415
 416 int vt_disallocate(const char *name);
 417
 418 int copy_file(const char *from, const char *to);
 419
 420 int symlink_atomic(const char *from, const char *to);
 421
 422 int fchmod_umask(int fd, mode_t mode);
 423
 424 bool display_is_local(const char *display);
 425 int socket_from_display(const char *display, char **path);
 426
 427 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
 428 int get_group_creds(const char **groupname, gid_t *gid);
 429
 430 int in_group(const char *name);
 431
 432 char* uid_to_name(uid_t uid);
 433
 434 int glob_exists(const char *path);
 435
 436 int dirent_ensure_type(DIR *d, struct dirent *de);
 437
 438 int in_search_path(const char *path, char **search);
 439 int get_files_in_directory(const char *path, char ***list);
 440
 441 char *strjoin(const char *x, ...) _sentinel_;
 442
 443 bool is_main_thread(void);
 444
 445 bool in_charset(const char *s, const char* charset);
 446
 447 int block_get_whole_disk(dev_t d, dev_t *ret);
 448
 449 int file_is_priv_sticky(const char *p);
 450
 451 int strdup_or_null(const char *a, char **b);
 452
 453 #define NULSTR_FOREACH(i, l)                                    \
 454         for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
 455
 456 #define NULSTR_FOREACH_PAIR(i, j, l)                             \
 457         for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
 458
 459 int ioprio_class_to_string_alloc(int i, char **s);
 460 int ioprio_class_from_string(const char *s);
 461
 462 const char *sigchld_code_to_string(int i);
 463 int sigchld_code_from_string(const char *s);
 464
 465 int log_facility_unshifted_to_string_alloc(int i, char **s);
 466 int log_facility_unshifted_from_string(const char *s);
 467
 468 int log_level_to_string_alloc(int i, char **s);
 469 int log_level_from_string(const char *s);
 470
 471 int sched_policy_to_string_alloc(int i, char **s);
 472 int sched_policy_from_string(const char *s);
 473
 474 const char *rlimit_to_string(int i);
 475 int rlimit_from_string(const char *s);
 476
 477 int ip_tos_to_string_alloc(int i, char **s);
 478 int ip_tos_from_string(const char *s);
 479
 480 const char *signal_to_string(int i);
 481 int signal_from_string(const char *s);
 482
 483 int signal_from_string_try_harder(const char *s);
 484
 485 extern int saved_argc;
 486 extern char **saved_argv;
 487
 488 bool kexec_loaded(void);
 489
 490 int prot_from_flags(int flags);
 491
 492 char *format_bytes(char *buf, size_t l, off_t t);
 493
 494 int fd_wait_for_event(int fd, int event, usec_t timeout);
 495
 496 void* memdup(const void *p, size_t l) _malloc_;
 497
 498 int is_kernel_thread(pid_t pid);
 499
 500 int fd_inc_sndbuf(int fd, size_t n);
 501 int fd_inc_rcvbuf(int fd, size_t n);
 502
 503 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
 504
 505 int setrlimit_closest(int resource, const struct rlimit *rlim);
 506
 507 int getenv_for_pid(pid_t pid, const char *field, char **_value);
 508
 509 int can_sleep(const char *type);
 510 int can_sleep_disk(const char *type);
 511
 512 bool is_valid_documentation_url(const char *url);
 513
 514 bool in_initrd(void);
 515
 516 void warn_melody(void);
 517
 518 int get_shell(char **ret);
 519 int get_home_dir(char **ret);
 520
 521 void freep(void *p);
 522 void fclosep(FILE **f);
 523 void pclosep(FILE **f);
 524 void closep(int *fd);
 525 void closedirp(DIR **d);
 526 void umaskp(mode_t *u);
 527
 528 _malloc_  static inline void *malloc_multiply(size_t a, size_t b) {
 529         if (_unlikely_(b == 0 || a > ((size_t) -1) / b))
 530                 return NULL;
 531
 532         return malloc(a * b);
 533 }
 534
 535 _malloc_ static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
 536         if (_unlikely_(b == 0 || a > ((size_t) -1) / b))
 537                 return NULL;
 538
 539         return memdup(p, a * b);
 540 }
 541
 542 bool filename_is_safe(const char *p);
 543 bool path_is_safe(const char *p);
 544 bool string_is_safe(const char *p);
 545 bool string_has_cc(const char *p);
 546
 547 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
 548                  int (*compar) (const void *, const void *, void *),
 549                  void *arg);
 550
 551 bool is_locale_utf8(void);
 552
 553 typedef enum DrawSpecialChar {
 554         DRAW_TREE_VERT,
 555         DRAW_TREE_BRANCH,
 556         DRAW_TREE_RIGHT,
 557         DRAW_TREE_SPACE,
 558         DRAW_TRIANGULAR_BULLET,
 559         _DRAW_SPECIAL_CHAR_MAX
 560 } DrawSpecialChar;
 561 const char *draw_special_char(DrawSpecialChar ch);
 562
 563 char *strreplace(const char *text, const char *old_string, const char *new_string);
 564
 565 char *strip_tab_ansi(char **p, size_t *l);
 566
 567 int on_ac_power(void);
 568
 569 int search_and_fopen(const char *path, const char *mode, const char **search, FILE **_f);
 570 int search_and_fopen_nulstr(const char *path, const char *mode, const char *search, FILE **_f);
 571
 572 #define FOREACH_LINE(line, f, on_error)                         \
 573         for (;;)                                                \
 574                 if (!fgets(line, sizeof(line), f)) {            \
 575                         if (ferror(f)) {                        \
 576                                 on_error;                       \
 577                         }                                       \
 578                         break;                                  \
 579                 } else
 580
 581 #define FOREACH_DIRENT(de, d, on_error)                                 \
 582         for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d))   \
 583                 if (!de) {                                              \
 584                         if (errno != 0) {                               \
 585                                 on_error;                               \
 586                         }                                               \
 587                         break;                                          \
 588                 } else if (ignore_file((de)->d_name))                   \
 589                         continue;                                       \
 590                 else