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