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