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
 260 char *xescape(const char *s, const char *bad);
 261
 262 char *bus_path_escape(const char *s);
 263 char *bus_path_unescape(const char *s);
 264
 265 char *ascii_strlower(char *path);
 266
 267 bool dirent_is_file(const struct dirent *de);
 268 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix);
 269
 270 bool ignore_file(const char *filename);
 271
 272 bool chars_intersect(const char *a, const char *b);
 273
 274 char *format_timestamp(char *buf, size_t l, usec_t t);
 275 char *format_timestamp_pretty(char *buf, size_t l, usec_t t);
 276 char *format_timespan(char *buf, size_t l, usec_t t);
 277
 278 int make_stdio(int fd);
 279 int make_null_stdio(void);
 280 int make_console_stdio(void);
 281
 282 unsigned long long random_ull(void);
 283
 284 #define __DEFINE_STRING_TABLE_LOOKUP(name,type,scope)                   \
 285         scope const char *name##_to_string(type i) {                    \
 286                 if (i < 0 || i >= (type) ELEMENTSOF(name##_table))      \
 287                         return NULL;                                    \
 288                 return name##_table[i];                                 \
 289         }                                                               \
 290         scope type name##_from_string(const char *s) {                  \
 291                 type i;                                                 \
 292                 unsigned u = 0;                                         \
 293                 assert(s);                                              \
 294                 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
 295                         if (name##_table[i] &&                          \
 296                             streq(name##_table[i], s))                  \
 297                                 return i;                               \
 298                 if (safe_atou(s, &u) >= 0 &&                            \
 299                     u < ELEMENTSOF(name##_table))                       \
 300                         return (type) u;                                \
 301                 return (type) -1;                                       \
 302         }                                                               \
 303         struct __useless_struct_to_allow_trailing_semicolon__
 304
 305 #define DEFINE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,)
 306 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,static)
 307
 308 int fd_nonblock(int fd, bool nonblock);
 309 int fd_cloexec(int fd, bool cloexec);
 310
 311 int close_all_fds(const int except[], unsigned n_except);
 312
 313 bool fstype_is_network(const char *fstype);
 314
 315 int chvt(int vt);
 316
 317 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
 318 int ask(char *ret, const char *replies, const char *text, ...);
 319
 320 int reset_terminal_fd(int fd, bool switch_to_text);
 321 int reset_terminal(const char *name);
 322
 323 int open_terminal(const char *name, int mode);
 324 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
 325 int release_terminal(void);
 326
 327 int flush_fd(int fd);
 328
 329 int ignore_signals(int sig, ...);
 330 int default_signals(int sig, ...);
 331 int sigaction_many(const struct sigaction *sa, ...);
 332
 333 int close_pipe(int p[]);
 334 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
 335
 336 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
 337 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
 338
 339 bool is_device_path(const char *path);
 340
 341 int dir_is_empty(const char *path);
 342
 343 void rename_process(const char name[8]);
 344
 345 void sigset_add_many(sigset_t *ss, ...);
 346
 347 bool hostname_is_set(void);
 348
 349 char* gethostname_malloc(void);
 350 char* getlogname_malloc(void);
 351 char* getusername_malloc(void);
 352
 353 int getttyname_malloc(int fd, char **r);
 354 int getttyname_harder(int fd, char **r);
 355
 356 int get_ctty_devnr(pid_t pid, dev_t *d);
 357 int get_ctty(pid_t, dev_t *_devnr, char **r);
 358
 359 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
 360 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
 361
 362 int rm_rf_children(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
 363 int rm_rf_children_dangerous(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
 364 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
 365 int rm_rf_dangerous(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
 366
 367 int pipe_eof(int fd);
 368
 369 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
 370
 371 void status_vprintf(const char *status, bool ellipse, const char *format, va_list ap);
 372 void status_printf(const char *status, bool ellipse, const char *format, ...);
 373 void status_welcome(void);
 374
 375 int fd_columns(int fd);
 376 unsigned columns(void);
 377
 378 int fd_lines(int fd);
 379 unsigned lines(void);
 380
 381 int running_in_chroot(void);
 382
 383 char *ellipsize(const char *s, size_t length, unsigned percent);
 384 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
 385
 386 int touch(const char *path);
 387
 388 char *unquote(const char *s, const char *quotes);
 389 char *normalize_env_assignment(const char *s);
 390
 391 int wait_for_terminate(pid_t pid, siginfo_t *status);
 392 int wait_for_terminate_and_warn(const char *name, pid_t pid);
 393
 394 _noreturn_ void freeze(void);
 395
 396 bool null_or_empty(struct stat *st);
 397 int null_or_empty_path(const char *fn);
 398
 399 DIR *xopendirat(int dirfd, const char *name, int flags);
 400
 401 void dual_timestamp_serialize(FILE *f, const char *name, dual_timestamp *t);
 402 void dual_timestamp_deserialize(const char *value, dual_timestamp *t);
 403
 404 char *fstab_node_to_udev_node(const char *p);
 405
 406 bool tty_is_vc(const char *tty);
 407 bool tty_is_vc_resolve(const char *tty);
 408 bool tty_is_console(const char *tty);
 409 int vtnr_from_tty(const char *tty);
 410 const char *default_term_for_tty(const char *tty);
 411
 412 void execute_directory(const char *directory, DIR *_d, char *argv[]);
 413
 414 int kill_and_sigcont(pid_t pid, int sig);
 415
 416 bool nulstr_contains(const char*nulstr, const char *needle);
 417
 418 bool plymouth_running(void);
 419
 420 void parse_syslog_priority(char **p, int *priority);
 421 void skip_syslog_pid(char **buf);
 422 void skip_syslog_date(char **buf);
 423
 424 bool hostname_is_valid(const char *s);
 425 char* hostname_cleanup(char *s);
 426
 427 char* strshorten(char *s, size_t l);
 428
 429 int terminal_vhangup_fd(int fd);
 430 int terminal_vhangup(const char *name);
 431
 432 int vt_disallocate(const char *name);
 433
 434 int copy_file(const char *from, const char *to);
 435 int symlink_or_copy(const char *from, const char *to);
 436 int symlink_or_copy_atomic(const char *from, const char *to);
 437
 438 int fchmod_umask(int fd, mode_t mode);
 439
 440 bool display_is_local(const char *display);
 441 int socket_from_display(const char *display, char **path);
 442
 443 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
 444 int get_group_creds(const char **groupname, gid_t *gid);
 445
 446 int in_group(const char *name);
 447
 448 int glob_exists(const char *path);
 449
 450 int dirent_ensure_type(DIR *d, struct dirent *de);
 451
 452 int in_search_path(const char *path, char **search);
 453 int get_files_in_directory(const char *path, char ***list);
 454
 455 char *strjoin(const char *x, ...) _sentinel_;
 456
 457 bool is_main_thread(void);
 458
 459 bool in_charset(const char *s, const char* charset);
 460
 461 int block_get_whole_disk(dev_t d, dev_t *ret);
 462
 463 int file_is_priv_sticky(const char *p);
 464
 465 int strdup_or_null(const char *a, char **b);
 466
 467 #define NULSTR_FOREACH(i, l)                                    \
 468         for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
 469
 470 #define NULSTR_FOREACH_PAIR(i, j, l)                             \
 471         for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
 472
 473 const char *ioprio_class_to_string(int i);
 474 int ioprio_class_from_string(const char *s);
 475
 476 const char *sigchld_code_to_string(int i);
 477 int sigchld_code_from_string(const char *s);
 478
 479 const char *log_facility_unshifted_to_string(int i);
 480 int log_facility_unshifted_from_string(const char *s);
 481
 482 const char *log_level_to_string(int i);
 483 int log_level_from_string(const char *s);
 484
 485 const char *sched_policy_to_string(int i);
 486 int sched_policy_from_string(const char *s);
 487
 488 const char *rlimit_to_string(int i);
 489 int rlimit_from_string(const char *s);
 490
 491 const char *ip_tos_to_string(int i);
 492 int ip_tos_from_string(const char *s);
 493
 494 const char *signal_to_string(int i);
 495 int signal_from_string(const char *s);
 496
 497 int signal_from_string_try_harder(const char *s);
 498
 499 extern int saved_argc;
 500 extern char **saved_argv;
 501
 502 bool kexec_loaded(void);
 503
 504 int prot_from_flags(int flags);
 505
 506 char *format_bytes(char *buf, size_t l, off_t t);
 507
 508 int fd_wait_for_event(int fd, int event, usec_t timeout);
 509
 510 void* memdup(const void *p, size_t l);
 511
 512 int is_kernel_thread(pid_t pid);
 513
 514 int fd_inc_sndbuf(int fd, size_t n);
 515 int fd_inc_rcvbuf(int fd, size_t n);
 516
 517 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
 518
 519 int setrlimit_closest(int resource, const struct rlimit *rlim);
 520
 521 int getenv_for_pid(pid_t pid, const char *field, char **_value);
 522
 523 int can_sleep(const char *type);
 524
 525 bool is_valid_documentation_url(const char *url);
 526
 527 bool in_initrd(void);
 528
 529 void warn_melody(void);
 530
 531 int get_shell(char **ret);
 532 int get_home_dir(char **ret);