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