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