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