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 bool is_efiboot(void);
  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
  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 int write_one_line_file(const char *fn, const char *line);
 181 int write_one_line_file_atomic(const char *fn, const char *line);
 182 int read_one_line_file(const char *fn, char **line);
 183 int read_full_file(const char *fn, char **contents, size_t *size);
 184
 185 int parse_env_file(const char *fname, const char *separator, ...) _sentinel_;
 186 int load_env_file(const char *fname, char ***l);
 187 int write_env_file(const char *fname, char **l);
 188
 189 char *strappend(const char *s, const char *suffix);
 190 char *strnappend(const char *s, const char *suffix, size_t length);
 191
 192 char *replace_env(const char *format, char **env);
 193 char **replace_env_argv(char **argv, char **env);
 194
 195 int readlink_malloc(const char *p, char **r);
 196 int readlink_and_make_absolute(const char *p, char **r);
 197 int readlink_and_canonicalize(const char *p, char **r);
 198
 199 int reset_all_signal_handlers(void);
 200
 201 char *strstrip(char *s);
 202 char *delete_chars(char *s, const char *bad);
 203 char *truncate_nl(char *s);
 204
 205 char *file_in_same_dir(const char *path, const char *filename);
 206
 207 int rmdir_parents(const char *path, const char *stop);
 208
 209 int get_process_comm(pid_t pid, char **name);
 210 int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
 211 int get_process_exe(pid_t pid, char **name);
 212 int get_process_uid(pid_t pid, uid_t *uid);
 213 int get_process_gid(pid_t pid, gid_t *gid);
 214
 215 char hexchar(int x);
 216 int unhexchar(char c);
 217 char octchar(int x);
 218 int unoctchar(char c);
 219 char decchar(int x);
 220 int undecchar(char c);
 221
 222 char *cescape(const char *s);
 223 char *cunescape(const char *s);
 224 char *cunescape_length(const char *s, size_t length);
 225 char *cunescape_length_with_prefix(const char *s, size_t length, const char *prefix);
 226
 227 char *xescape(const char *s, const char *bad);
 228
 229 char *bus_path_escape(const char *s);
 230 char *bus_path_unescape(const char *s);
 231
 232 char *ascii_strlower(char *path);
 233
 234 bool dirent_is_file(const struct dirent *de);
 235 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix);
 236
 237 bool ignore_file(const char *filename);
 238
 239 bool chars_intersect(const char *a, const char *b);
 240
 241 int make_stdio(int fd);
 242 int make_null_stdio(void);
 243 int make_console_stdio(void);
 244
 245 unsigned long long random_ull(void);
 246
 247 /* For basic lookup tables with strictly enumerated entries */
 248 #define __DEFINE_STRING_TABLE_LOOKUP(name,type,scope)                   \
 249         scope const char *name##_to_string(type i) {                    \
 250                 if (i < 0 || i >= (type) ELEMENTSOF(name##_table))      \
 251                         return NULL;                                    \
 252                 return name##_table[i];                                 \
 253         }                                                               \
 254         scope type name##_from_string(const char *s) {                  \
 255                 type i;                                                 \
 256                 assert(s);                                              \
 257                 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
 258                         if (name##_table[i] &&                          \
 259                             streq(name##_table[i], s))                  \
 260                                 return i;                               \
 261                 return (type) -1;                                       \
 262         }                                                               \
 263         struct __useless_struct_to_allow_trailing_semicolon__
 264
 265 #define DEFINE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,)
 266 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,static)
 267
 268 /* For string conversions where numbers are also acceptable */
 269 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max)         \
 270         int name##_to_string_alloc(type i, char **str) {                \
 271                 char *s;                                                \
 272                 int r;                                                  \
 273                 if (i < 0 || i > max)                                   \
 274                         return -ERANGE;                                 \
 275                 if (i < (type) ELEMENTSOF(name##_table)) {              \
 276                         s = strdup(name##_table[i]);                    \
 277                         if (!s)                                         \
 278                                 return log_oom();                       \
 279                 } else {                                                \
 280                         r = asprintf(&s, "%u", i);                      \
 281                         if (r < 0)                                      \
 282                                 return log_oom();                       \
 283                 }                                                       \
 284                 *str = s;                                               \
 285                 return 0;                                               \
 286         }                                                               \
 287         type name##_from_string(const char *s) {                        \
 288                 type i;                                                 \
 289                 unsigned u = 0;                                         \
 290                 assert(s);                                              \
 291                 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
 292                         if (name##_table[i] &&                          \
 293                             streq(name##_table[i], s))                  \
 294                                 return i;                               \
 295                 if (safe_atou(s, &u) >= 0 && u <= max)                  \
 296                         return (type) u;                                \
 297                 return (type) -1;                                       \
 298         }                                                               \
 299         struct __useless_struct_to_allow_trailing_semicolon__
 300
 301 int fd_nonblock(int fd, bool nonblock);
 302 int fd_cloexec(int fd, bool cloexec);
 303
 304 int close_all_fds(const int except[], unsigned n_except);
 305
 306 bool fstype_is_network(const char *fstype);
 307
 308 int chvt(int vt);
 309
 310 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
 311 int ask(char *ret, const char *replies, const char *text, ...);
 312
 313 int reset_terminal_fd(int fd, bool switch_to_text);
 314 int reset_terminal(const char *name);
 315
 316 int open_terminal(const char *name, int mode);
 317 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
 318 int release_terminal(void);
 319
 320 int flush_fd(int fd);
 321
 322 int ignore_signals(int sig, ...);
 323 int default_signals(int sig, ...);
 324 int sigaction_many(const struct sigaction *sa, ...);
 325
 326 int close_pipe(int p[]);
 327 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
 328
 329 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
 330 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
 331
 332 bool is_device_path(const char *path);
 333
 334 int dir_is_empty(const char *path);
 335
 336 void rename_process(const char name[8]);
 337
 338 void sigset_add_many(sigset_t *ss, ...);
 339
 340 bool hostname_is_set(void);
 341
 342 char* gethostname_malloc(void);
 343 char* getlogname_malloc(void);
 344 char* getusername_malloc(void);
 345
 346 int getttyname_malloc(int fd, char **r);
 347 int getttyname_harder(int fd, char **r);
 348
 349 int get_ctty_devnr(pid_t pid, dev_t *d);
 350 int get_ctty(pid_t, dev_t *_devnr, char **r);
 351
 352 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
 353 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
 354
 355 int rm_rf_children(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
 356 int rm_rf_children_dangerous(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
 357 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
 358 int rm_rf_dangerous(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
 359
 360 int pipe_eof(int fd);
 361
 362 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
 363
 364 int status_vprintf(const char *status, bool ellipse, const char *format, va_list ap);
 365 int status_printf(const char *status, bool ellipse, const char *format, ...);
 366 int status_welcome(void);
 367
 368 int fd_columns(int fd);
 369 unsigned columns(void);
 370 int fd_lines(int fd);
 371 unsigned lines(void);
 372 void columns_lines_cache_reset(int _unused_ signum);
 373
 374 bool on_tty(void);
 375
 376 int running_in_chroot(void);
 377
 378 char *ellipsize(const char *s, size_t length, unsigned percent);
 379 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
 380
 381 int touch(const char *path);
 382
 383 char *unquote(const char *s, const char *quotes);
 384 char *normalize_env_assignment(const char *s);
 385
 386 int wait_for_terminate(pid_t pid, siginfo_t *status);
 387 int wait_for_terminate_and_warn(const char *name, pid_t pid);
 388
 389 _noreturn_ void freeze(void);
 390
 391 bool null_or_empty(struct stat *st);
 392 int null_or_empty_path(const char *fn);
 393
 394 DIR *xopendirat(int dirfd, const char *name, int flags);
 395
 396 char *fstab_node_to_udev_node(const char *p);
 397
 398 bool tty_is_vc(const char *tty);
 399 bool tty_is_vc_resolve(const char *tty);
 400 bool tty_is_console(const char *tty);
 401 int vtnr_from_tty(const char *tty);
 402 const char *default_term_for_tty(const char *tty);
 403
 404 void execute_directory(const char *directory, DIR *_d, char *argv[]);
 405
 406 int kill_and_sigcont(pid_t pid, int sig);
 407
 408 bool nulstr_contains(const char*nulstr, const char *needle);
 409
 410 bool plymouth_running(void);
 411
 412 bool hostname_is_valid(const char *s);
 413 char* hostname_cleanup(char *s);
 414
 415 char* strshorten(char *s, size_t l);
 416
 417 int terminal_vhangup_fd(int fd);
 418 int terminal_vhangup(const char *name);
 419
 420 int vt_disallocate(const char *name);
 421
 422 int copy_file(const char *from, const char *to);
 423
 424 int symlink_atomic(const char *from, const char *to);
 425
 426 int fchmod_umask(int fd, mode_t mode);
 427
 428 bool display_is_local(const char *display);
 429 int socket_from_display(const char *display, char **path);
 430
 431 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
 432 int get_group_creds(const char **groupname, gid_t *gid);
 433
 434 int in_group(const char *name);
 435
 436 char* uid_to_name(uid_t uid);
 437
 438 int glob_exists(const char *path);
 439
 440 int dirent_ensure_type(DIR *d, struct dirent *de);
 441
 442 int in_search_path(const char *path, char **search);
 443 int get_files_in_directory(const char *path, char ***list);
 444
 445 char *strjoin(const char *x, ...) _sentinel_;
 446
 447 bool is_main_thread(void);
 448
 449 bool in_charset(const char *s, const char* charset);
 450
 451 int block_get_whole_disk(dev_t d, dev_t *ret);
 452
 453 int file_is_priv_sticky(const char *p);
 454
 455 int strdup_or_null(const char *a, char **b);
 456
 457 #define NULSTR_FOREACH(i, l)                                    \
 458         for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
 459
 460 #define NULSTR_FOREACH_PAIR(i, j, l)                             \
 461         for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
 462
 463 int ioprio_class_to_string_alloc(int i, char **s);
 464 int ioprio_class_from_string(const char *s);
 465
 466 const char *sigchld_code_to_string(int i);
 467 int sigchld_code_from_string(const char *s);
 468
 469 int log_facility_unshifted_to_string_alloc(int i, char **s);
 470 int log_facility_unshifted_from_string(const char *s);
 471
 472 int log_level_to_string_alloc(int i, char **s);
 473 int log_level_from_string(const char *s);
 474
 475 int sched_policy_to_string_alloc(int i, char **s);
 476 int sched_policy_from_string(const char *s);
 477
 478 const char *rlimit_to_string(int i);
 479 int rlimit_from_string(const char *s);
 480
 481 int ip_tos_to_string_alloc(int i, char **s);
 482 int ip_tos_from_string(const char *s);
 483
 484 const char *signal_to_string(int i);
 485 int signal_from_string(const char *s);
 486
 487 int signal_from_string_try_harder(const char *s);
 488
 489 extern int saved_argc;
 490 extern char **saved_argv;
 491
 492 bool kexec_loaded(void);
 493
 494 int prot_from_flags(int flags);
 495
 496 char *format_bytes(char *buf, size_t l, off_t t);
 497
 498 int fd_wait_for_event(int fd, int event, usec_t timeout);
 499
 500 void* memdup(const void *p, size_t l) _malloc_;
 501
 502 int is_kernel_thread(pid_t pid);
 503
 504 int fd_inc_sndbuf(int fd, size_t n);
 505 int fd_inc_rcvbuf(int fd, size_t n);
 506
 507 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
 508
 509 int setrlimit_closest(int resource, const struct rlimit *rlim);
 510
 511 int getenv_for_pid(pid_t pid, const char *field, char **_value);
 512
 513 int can_sleep(const char *type);
 514 int can_sleep_disk(const char *type);
 515
 516 bool is_valid_documentation_url(const char *url);
 517
 518 bool in_initrd(void);
 519
 520 void warn_melody(void);
 521
 522 int get_shell(char **ret);
 523 int get_home_dir(char **ret);
 524
 525 void freep(void *p);
 526 void fclosep(FILE **f);
 527 void closep(int *fd);
 528 void closedirp(DIR **d);
 529 void umaskp(mode_t *u);
 530
 531 _malloc_  static inline void *malloc_multiply(size_t a, size_t b) {
 532         if (_unlikely_(b == 0 || a > ((size_t) -1) / b))
 533                 return NULL;
 534
 535         return malloc(a * b);
 536 }
 537
 538 _malloc_ static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
 539         if (_unlikely_(b == 0 || a > ((size_t) -1) / b))
 540                 return NULL;
 541
 542         return memdup(p, a * b);
 543 }
 544
 545 bool filename_is_safe(const char *p);
 546 bool string_is_safe(const char *p);
 547
 548 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
 549                  int (*compar) (const void *, const void *, void *),
 550                  void *arg);
 551
 552 bool is_locale_utf8(void);
 553
 554 typedef enum DrawSpecialChar {
 555         DRAW_TREE_VERT,
 556         DRAW_TREE_BRANCH,
 557         DRAW_TREE_RIGHT,
 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);