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