src/shared/util.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #ifndef fooutilhfoo
   4 #define fooutilhfoo
   5
   6 /***
   7   This file is part of systemd.
   8
   9   Copyright 2010 Lennart Poettering
  10
  11   systemd is free software; you can redistribute it and/or modify it
  12   under the terms of the GNU Lesser General Public License as published by
  13   the Free Software Foundation; either version 2.1 of the License, or
  14   (at your option) any later version.
  15
  16   systemd is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19   Lesser General Public License for more details.
  20
  21   You should have received a copy of the GNU Lesser General Public License
  22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  23 ***/
  24
  25 #include <inttypes.h>
  26 #include <time.h>
  27 #include <sys/time.h>
  28 #include <stdarg.h>
  29 #include <stdbool.h>
  30 #include <stdlib.h>
  31 #include <stdio.h>
  32 #include <signal.h>
  33 #include <sched.h>
  34 #include <limits.h>
  35 #include <sys/stat.h>
  36 #include <dirent.h>
  37
  38 #include "macro.h"
  39
  40 typedef uint64_t usec_t;
  41
  42 typedef struct dual_timestamp {
  43         usec_t realtime;
  44         usec_t monotonic;
  45 } dual_timestamp;
  46
  47 #define MSEC_PER_SEC  1000ULL
  48 #define USEC_PER_SEC  1000000ULL
  49 #define USEC_PER_MSEC 1000ULL
  50 #define NSEC_PER_SEC  1000000000ULL
  51 #define NSEC_PER_MSEC 1000000ULL
  52 #define NSEC_PER_USEC 1000ULL
  53
  54 #define USEC_PER_MINUTE (60ULL*USEC_PER_SEC)
  55 #define USEC_PER_HOUR (60ULL*USEC_PER_MINUTE)
  56 #define USEC_PER_DAY (24ULL*USEC_PER_HOUR)
  57 #define USEC_PER_WEEK (7ULL*USEC_PER_DAY)
  58 #define USEC_PER_MONTH (2629800ULL*USEC_PER_SEC)
  59 #define USEC_PER_YEAR (31557600ULL*USEC_PER_SEC)
  60
  61 /* What is interpreted as whitespace? */
  62 #define WHITESPACE " \t\n\r"
  63 #define NEWLINE "\n\r"
  64 #define QUOTES "\"\'"
  65 #define COMMENTS "#;\n"
  66
  67 #define FORMAT_TIMESTAMP_MAX 64
  68 #define FORMAT_TIMESTAMP_PRETTY_MAX 256
  69 #define FORMAT_TIMESPAN_MAX 64
  70 #define FORMAT_BYTES_MAX 8
  71
  72 #define ANSI_HIGHLIGHT_ON "\x1B[1;39m"
  73 #define ANSI_HIGHLIGHT_RED_ON "\x1B[1;31m"
  74 #define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
  75 #define ANSI_HIGHLIGHT_OFF "\x1B[0m"
  76
  77 usec_t now(clockid_t clock);
  78
  79 dual_timestamp* dual_timestamp_get(dual_timestamp *ts);
  80 dual_timestamp* dual_timestamp_from_realtime(dual_timestamp *ts, usec_t u);
  81
  82 #define dual_timestamp_is_set(ts) ((ts)->realtime > 0)
  83
  84 usec_t timespec_load(const struct timespec *ts);
  85 struct timespec *timespec_store(struct timespec *ts, usec_t u);
  86
  87 usec_t timeval_load(const struct timeval *tv);
  88 struct timeval *timeval_store(struct timeval *tv, usec_t u);
  89
  90 size_t page_size(void);
  91 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
  92
  93 #define streq(a,b) (strcmp((a),(b)) == 0)
  94 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
  95
  96 bool streq_ptr(const char *a, const char *b);
  97
  98 #define new(t, n) ((t*) malloc(sizeof(t)*(n)))
  99
 100 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
 101
 102 #define malloc0(n) (calloc((n), 1))
 103
 104 static inline const char* yes_no(bool b) {
 105         return b ? "yes" : "no";
 106 }
 107
 108 static inline const char* strempty(const char *s) {
 109         return s ? s : "";
 110 }
 111
 112 static inline const char* strnull(const char *s) {
 113         return s ? s : "(null)";
 114 }
 115
 116 static inline const char *strna(const char *s) {
 117         return s ? s : "n/a";
 118 }
 119
 120 static inline bool is_path_absolute(const char *p) {
 121         return *p == '/';
 122 }
 123
 124 static inline bool isempty(const char *p) {
 125         return !p || !p[0];
 126 }
 127
 128 bool endswith(const char *s, const char *postfix);
 129 bool startswith(const char *s, const char *prefix);
 130 bool startswith_no_case(const char *s, const char *prefix);
 131
 132 bool first_word(const char *s, const char *word);
 133
 134 int close_nointr(int fd);
 135 void close_nointr_nofail(int fd);
 136 void close_many(const int fds[], unsigned n_fd);
 137
 138 int parse_boolean(const char *v);
 139 int parse_usec(const char *t, usec_t *usec);
 140 int parse_bytes(const char *t, off_t *bytes);
 141 int parse_pid(const char *s, pid_t* ret_pid);
 142 int parse_uid(const char *s, uid_t* ret_uid);
 143 #define parse_gid(s, ret_uid) parse_uid(s, ret_uid)
 144
 145 int safe_atou(const char *s, unsigned *ret_u);
 146 int safe_atoi(const char *s, int *ret_i);
 147
 148 int safe_atollu(const char *s, unsigned long long *ret_u);
 149 int safe_atolli(const char *s, long long int *ret_i);
 150
 151 #if __WORDSIZE == 32
 152 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
 153         assert_cc(sizeof(unsigned long) == sizeof(unsigned));
 154         return safe_atou(s, (unsigned*) ret_u);
 155 }
 156 static inline int safe_atoli(const char *s, long int *ret_u) {
 157         assert_cc(sizeof(long int) == sizeof(int));
 158         return safe_atoi(s, (int*) ret_u);
 159 }
 160 #else
 161 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
 162         assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
 163         return safe_atollu(s, (unsigned long long*) ret_u);
 164 }
 165 static inline int safe_atoli(const char *s, long int *ret_u) {
 166         assert_cc(sizeof(long int) == sizeof(long long int));
 167         return safe_atolli(s, (long long int*) ret_u);
 168 }
 169 #endif
 170
 171 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
 172         assert_cc(sizeof(uint32_t) == sizeof(unsigned));
 173         return safe_atou(s, (unsigned*) ret_u);
 174 }
 175
 176 static inline int safe_atoi32(const char *s, int32_t *ret_i) {
 177         assert_cc(sizeof(int32_t) == sizeof(int));
 178         return safe_atoi(s, (int*) ret_i);
 179 }
 180
 181 static inline int safe_atou64(const char *s, uint64_t *ret_u) {
 182         assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
 183         return safe_atollu(s, (unsigned long long*) ret_u);
 184 }
 185
 186 static inline int safe_atoi64(const char *s, int64_t *ret_i) {
 187         assert_cc(sizeof(int64_t) == sizeof(long long int));
 188         return safe_atolli(s, (long long int*) ret_i);
 189 }
 190
 191 char *split(const char *c, size_t *l, const char *separator, char **state);
 192 char *split_quoted(const char *c, size_t *l, char **state);
 193
 194 #define FOREACH_WORD(word, length, s, state)                            \
 195         for ((state) = NULL, (word) = split((s), &(length), WHITESPACE, &(state)); (word); (word) = split((s), &(length), WHITESPACE, &(state)))
 196
 197 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state)       \
 198         for ((state) = NULL, (word) = split((s), &(length), (separator), &(state)); (word); (word) = split((s), &(length), (separator), &(state)))
 199
 200 #define FOREACH_WORD_QUOTED(word, length, s, state)                     \
 201         for ((state) = NULL, (word) = split_quoted((s), &(length), &(state)); (word); (word) = split_quoted((s), &(length), &(state)))
 202
 203 char **split_path_and_make_absolute(const char *p);
 204
 205 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
 206 int get_starttime_of_pid(pid_t pid, unsigned long long *st);
 207
 208 int write_one_line_file(const char *fn, const char *line);
 209 int write_one_line_file_atomic(const char *fn, const char *line);
 210 int read_one_line_file(const char *fn, char **line);
 211 int read_full_file(const char *fn, char **contents, size_t *size);
 212
 213 int parse_env_file(const char *fname, const char *separator, ...) _sentinel_;
 214 int load_env_file(const char *fname, char ***l);
 215 int write_env_file(const char *fname, char **l);
 216
 217 char *strappend(const char *s, const char *suffix);
 218 char *strnappend(const char *s, const char *suffix, size_t length);
 219
 220 char *replace_env(const char *format, char **env);
 221 char **replace_env_argv(char **argv, char **env);
 222
 223 int readlink_malloc(const char *p, char **r);
 224 int readlink_and_make_absolute(const char *p, char **r);
 225 int readlink_and_canonicalize(const char *p, char **r);
 226
 227 char *file_name_from_path(const char *p);
 228 bool is_path(const char *p);
 229
 230 bool path_is_absolute(const char *p);
 231 char *path_make_absolute(const char *p, const char *prefix);
 232 char *path_make_absolute_cwd(const char *p);
 233
 234 char **strv_path_make_absolute_cwd(char **l);
 235 char **strv_path_canonicalize(char **l);
 236 char **strv_path_remove_empty(char **l);
 237
 238 int reset_all_signal_handlers(void);
 239
 240 char *strstrip(char *s);
 241 char *delete_chars(char *s, const char *bad);
 242 char *truncate_nl(char *s);
 243
 244 char *file_in_same_dir(const char *path, const char *filename);
 245
 246 int parent_of_path(const char *path, char **parent);
 247
 248 int rmdir_parents(const char *path, const char *stop);
 249
 250 int get_process_comm(pid_t pid, char **name);
 251 int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
 252 int get_process_exe(pid_t pid, char **name);
 253 int get_process_uid(pid_t pid, uid_t *uid);
 254
 255 char hexchar(int x);
 256 int unhexchar(char c);
 257 char octchar(int x);
 258 int unoctchar(char c);
 259 char decchar(int x);
 260 int undecchar(char c);
 261
 262 char *cescape(const char *s);
 263 char *cunescape(const char *s);
 264 char *cunescape_length(const char *s, size_t length);
 265
 266 char *xescape(const char *s, const char *bad);
 267
 268 char *bus_path_escape(const char *s);
 269 char *bus_path_unescape(const char *s);
 270
 271 char *path_kill_slashes(char *path);
 272
 273 bool path_startswith(const char *path, const char *prefix);
 274 bool path_equal(const char *a, const char *b);
 275
 276 char *ascii_strlower(char *path);
 277
 278 bool dirent_is_file(const struct dirent *de);
 279 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix);
 280
 281 bool ignore_file(const char *filename);
 282
 283 bool chars_intersect(const char *a, const char *b);
 284
 285 char *format_timestamp(char *buf, size_t l, usec_t t);
 286 char *format_timestamp_pretty(char *buf, size_t l, usec_t t);
 287 char *format_timespan(char *buf, size_t l, usec_t t);
 288
 289 int make_stdio(int fd);
 290 int make_null_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);
 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 int path_is_mount_point(const char *path, bool allow_symlink);
 350
 351 bool is_device_path(const char *path);
 352
 353 int dir_is_empty(const char *path);
 354
 355 void rename_process(const char name[8]);
 356
 357 void sigset_add_many(sigset_t *ss, ...);
 358
 359 char* gethostname_malloc(void);
 360 char* getlogname_malloc(void);
 361
 362 int getttyname_malloc(int fd, char **r);
 363 int getttyname_harder(int fd, char **r);
 364
 365 int get_ctty_devnr(pid_t pid, dev_t *d);
 366 int get_ctty(pid_t, dev_t *_devnr, char **r);
 367
 368 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
 369 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
 370
 371 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
 372
 373 int pipe_eof(int fd);
 374
 375 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
 376
 377 void status_vprintf(const char *status, bool ellipse, const char *format, va_list ap);
 378 void status_printf(const char *status, bool ellipse, const char *format, ...);
 379 void status_welcome(void);
 380
 381 int fd_columns(int fd);
 382 unsigned columns(void);
 383
 384 int fd_lines(int fd);
 385 unsigned lines(void);
 386
 387 int running_in_chroot(void);
 388
 389 char *ellipsize(const char *s, size_t length, unsigned percent);
 390 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
 391
 392 int touch(const char *path);
 393
 394 char *unquote(const char *s, const char *quotes);
 395 char *normalize_env_assignment(const char *s);
 396
 397 int wait_for_terminate(pid_t pid, siginfo_t *status);
 398 int wait_for_terminate_and_warn(const char *name, pid_t pid);
 399
 400 _noreturn_ void freeze(void);
 401
 402 bool null_or_empty(struct stat *st);
 403 int null_or_empty_path(const char *fn);
 404
 405 DIR *xopendirat(int dirfd, const char *name, int flags);
 406
 407 void dual_timestamp_serialize(FILE *f, const char *name, dual_timestamp *t);
 408 void dual_timestamp_deserialize(const char *value, dual_timestamp *t);
 409
 410 char *fstab_node_to_udev_node(const char *p);
 411
 412 bool tty_is_vc(const char *tty);
 413 bool tty_is_vc_resolve(const char *tty);
 414 int vtnr_from_tty(const char *tty);
 415 const char *default_term_for_tty(const char *tty);
 416
 417 void execute_directory(const char *directory, DIR *_d, char *argv[]);
 418
 419 int kill_and_sigcont(pid_t pid, int sig);
 420
 421 bool nulstr_contains(const char*nulstr, const char *needle);
 422
 423 bool plymouth_running(void);
 424
 425 void parse_syslog_priority(char **p, int *priority);
 426 void skip_syslog_pid(char **buf);
 427 void skip_syslog_date(char **buf);
 428
 429 bool hostname_is_valid(const char *s);
 430 char* hostname_cleanup(char *s);
 431
 432 char* strshorten(char *s, size_t l);
 433
 434 int terminal_vhangup_fd(int fd);
 435 int terminal_vhangup(const char *name);
 436
 437 int vt_disallocate(const char *name);
 438
 439 int copy_file(const char *from, const char *to);
 440 int symlink_or_copy(const char *from, const char *to);
 441 int symlink_or_copy_atomic(const char *from, const char *to);
 442
 443 int fchmod_umask(int fd, mode_t mode);
 444
 445 int conf_files_list(char ***strv, const char *suffix, const char *dir, ...);
 446
 447 int hwclock_is_localtime(void);
 448 int hwclock_apply_localtime_delta(int *min);
 449 int hwclock_reset_localtime_delta(void);
 450 int hwclock_get_time(struct tm *tm);
 451 int hwclock_set_time(const struct tm *tm);
 452
 453 bool display_is_local(const char *display);
 454 int socket_from_display(const char *display, char **path);
 455
 456 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home);
 457 int get_group_creds(const char **groupname, gid_t *gid);
 458
 459 int in_group(const char *name);
 460
 461 int glob_exists(const char *path);
 462
 463 int dirent_ensure_type(DIR *d, struct dirent *de);
 464
 465 int in_search_path(const char *path, char **search);
 466 int get_files_in_directory(const char *path, char ***list);
 467
 468 char *join(const char *x, ...) _sentinel_;
 469
 470 bool is_main_thread(void);
 471
 472 bool in_charset(const char *s, const char* charset);
 473
 474 int block_get_whole_disk(dev_t d, dev_t *ret);
 475
 476 int file_is_priv_sticky(const char *p);
 477
 478 int strdup_or_null(const char *a, char **b);
 479
 480 #define NULSTR_FOREACH(i, l)                                    \
 481         for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
 482
 483 #define NULSTR_FOREACH_PAIR(i, j, l)                             \
 484         for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
 485
 486 const char *ioprio_class_to_string(int i);
 487 int ioprio_class_from_string(const char *s);
 488
 489 const char *sigchld_code_to_string(int i);
 490 int sigchld_code_from_string(const char *s);
 491
 492 const char *log_facility_unshifted_to_string(int i);
 493 int log_facility_unshifted_from_string(const char *s);
 494
 495 const char *log_level_to_string(int i);
 496 int log_level_from_string(const char *s);
 497
 498 const char *sched_policy_to_string(int i);
 499 int sched_policy_from_string(const char *s);
 500
 501 const char *rlimit_to_string(int i);
 502 int rlimit_from_string(const char *s);
 503
 504 const char *ip_tos_to_string(int i);
 505 int ip_tos_from_string(const char *s);
 506
 507 const char *signal_to_string(int i);
 508 int signal_from_string(const char *s);
 509
 510 int signal_from_string_try_harder(const char *s);
 511
 512 extern int saved_argc;
 513 extern char **saved_argv;
 514
 515 bool kexec_loaded(void);
 516
 517 int prot_from_flags(int flags);
 518
 519 char *format_bytes(char *buf, size_t l, off_t t);
 520
 521 int fd_wait_for_event(int fd, int event, usec_t timeout);
 522
 523 void* memdup(const void *p, size_t l);
 524
 525 int rtc_open(int flags);
 526
 527 int is_kernel_thread(pid_t pid);
 528
 529 int fd_inc_sndbuf(int fd, size_t n);
 530 int fd_inc_rcvbuf(int fd, size_t n);
 531
 532 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
 533
 534 #endif