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