install/util.h

   1 #ifndef fooutilhfoo
   2 #define fooutilhfoo
   3
   4 /***
   5   This file is part of systemd.
   6
   7   Copyright 2010 Lennart Poettering
   8
   9   systemd is free software; you can redistribute it and/or modify it
  10   under the terms of the GNU Lesser General Public License as published by
  11   the Free Software Foundation; either version 2.1 of the License, or
  12   (at your option) any later version.
  13
  14   systemd is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   Lesser General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public License
  20   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  21 ***/
  22
  23 #define _GNU_SOURCE
  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 <string.h>
  33 #include <signal.h>
  34 #include <sched.h>
  35 #include <limits.h>
  36 #include <sys/stat.h>
  37 #include <dirent.h>
  38 #include <sys/resource.h>
  39
  40 #include "macro.h"
  41
  42 typedef uint64_t usec_t;
  43 typedef uint64_t nsec_t;
  44
  45 typedef struct dual_timestamp {
  46         usec_t realtime;
  47         usec_t monotonic;
  48 } dual_timestamp;
  49
  50 #define MSEC_PER_SEC  1000ULL
  51 #define USEC_PER_SEC  1000000ULL
  52 #define USEC_PER_MSEC 1000ULL
  53 #define NSEC_PER_SEC  1000000000ULL
  54 #define NSEC_PER_MSEC 1000000ULL
  55 #define NSEC_PER_USEC 1000ULL
  56
  57 #define USEC_PER_MINUTE (60ULL*USEC_PER_SEC)
  58 #define NSEC_PER_MINUTE (60ULL*NSEC_PER_SEC)
  59 #define USEC_PER_HOUR (60ULL*USEC_PER_MINUTE)
  60 #define NSEC_PER_HOUR (60ULL*NSEC_PER_MINUTE)
  61 #define USEC_PER_DAY (24ULL*USEC_PER_HOUR)
  62 #define NSEC_PER_DAY (24ULL*NSEC_PER_HOUR)
  63 #define USEC_PER_WEEK (7ULL*USEC_PER_DAY)
  64 #define NSEC_PER_WEEK (7ULL*NSEC_PER_DAY)
  65 #define USEC_PER_MONTH (2629800ULL*USEC_PER_SEC)
  66 #define NSEC_PER_MONTH (2629800ULL*NSEC_PER_SEC)
  67 #define USEC_PER_YEAR (31557600ULL*USEC_PER_SEC)
  68 #define NSEC_PER_YEAR (31557600ULL*NSEC_PER_SEC)
  69
  70 /* What is interpreted as whitespace? */
  71 #define WHITESPACE " \t\n\r"
  72 #define NEWLINE "\n\r"
  73 #define QUOTES "\"\'"
  74 #define COMMENTS "#;\n"
  75
  76 #define FORMAT_TIMESTAMP_MAX 64
  77 #define FORMAT_TIMESTAMP_PRETTY_MAX 256
  78 #define FORMAT_TIMESPAN_MAX 64
  79 #define FORMAT_BYTES_MAX 8
  80
  81 #define ANSI_HIGHLIGHT_ON "\x1B[1;39m"
  82 #define ANSI_HIGHLIGHT_RED_ON "\x1B[1;31m"
  83 #define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
  84 #define ANSI_HIGHLIGHT_YELLOW_ON "\x1B[1;33m"
  85 #define ANSI_HIGHLIGHT_OFF "\x1B[0m"
  86
  87 usec_t now(clockid_t clock);
  88
  89 dual_timestamp* dual_timestamp_get(dual_timestamp *ts);
  90 dual_timestamp* dual_timestamp_from_realtime(dual_timestamp *ts, usec_t u);
  91
  92 #define dual_timestamp_is_set(ts) ((ts)->realtime > 0)
  93
  94 usec_t timespec_load(const struct timespec *ts);
  95 struct timespec *timespec_store(struct timespec *ts, usec_t u);
  96
  97 usec_t timeval_load(const struct timeval *tv);
  98 struct timeval *timeval_store(struct timeval *tv, usec_t u);
  99
 100 size_t page_size(void);
 101 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
 102
 103 #define streq(a,b) (strcmp((a),(b)) == 0)
 104 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
 105
 106 bool streq_ptr(const char *a, const char *b);
 107
 108 #define new(t, n) ((t*) malloc(sizeof(t)*(n)))
 109
 110 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
 111
 112 #define newa(t, n) ((t*) alloca(sizeof(t)*(n)))
 113
 114 #define newdup(t, p, n) ((t*) memdup(p, sizeof(t)*(n)))
 115
 116 #define malloc0(n) (calloc((n), 1))
 117
 118 static inline const char* yes_no(bool b) {
 119         return b ? "yes" : "no";
 120 }
 121
 122 static inline const char* strempty(const char *s) {
 123         return s ? s : "";
 124 }
 125
 126 static inline const char* strnull(const char *s) {
 127         return s ? s : "(null)";
 128 }
 129
 130 static inline const char *strna(const char *s) {
 131         return s ? s : "n/a";
 132 }
 133
 134 static inline bool isempty(const char *p) {
 135         return !p || !p[0];
 136 }
 137
 138
 139 static inline const char *startswith(const char *s, const char *prefix) {
 140         if (strncmp(s, prefix, strlen(prefix)) == 0)
 141                 return s + strlen(prefix);
 142         return NULL;
 143 }
 144
 145 bool endswith(const char *s, const char *postfix);
 146
 147
 148 bool startswith_no_case(const char *s, const char *prefix);
 149
 150 bool first_word(const char *s, const char *word);
 151
 152 int close_nointr(int fd);
 153 void close_nointr_nofail(int fd);
 154 void close_many(const int fds[], unsigned n_fd);
 155
 156 int parse_boolean(const char *v);
 157 int parse_usec(const char *t, usec_t *usec);
 158 int parse_nsec(const char *t, nsec_t *nsec);
 159 int parse_bytes(const char *t, off_t *bytes);
 160 int parse_pid(const char *s, pid_t* ret_pid);
 161 int parse_uid(const char *s, uid_t* ret_uid);
 162 #define parse_gid(s, ret_uid) parse_uid(s, ret_uid)
 163
 164 int safe_atou(const char *s, unsigned *ret_u);
 165 int safe_atoi(const char *s, int *ret_i);
 166
 167 int safe_atollu(const char *s, unsigned long long *ret_u);
 168 int safe_atolli(const char *s, long long int *ret_i);
 169
 170 #if LONG_MAX == INT_MAX
 171 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
 172         assert_cc(sizeof(unsigned long) == sizeof(unsigned));
 173         return safe_atou(s, (unsigned*) ret_u);
 174 }
 175 static inline int safe_atoli(const char *s, long int *ret_u) {
 176         assert_cc(sizeof(long int) == sizeof(int));
 177         return safe_atoi(s, (int*) ret_u);
 178 }
 179 #else
 180 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
 181         assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
 182         return safe_atollu(s, (unsigned long long*) ret_u);
 183 }
 184 static inline int safe_atoli(const char *s, long int *ret_u) {
 185         assert_cc(sizeof(long int) == sizeof(long long int));
 186         return safe_atolli(s, (long long int*) ret_u);
 187 }
 188 #endif
 189
 190 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
 191         assert_cc(sizeof(uint32_t) == sizeof(unsigned));
 192         return safe_atou(s, (unsigned*) ret_u);
 193 }
 194
 195 static inline int safe_atoi32(const char *s, int32_t *ret_i) {
 196         assert_cc(sizeof(int32_t) == sizeof(int));
 197         return safe_atoi(s, (int*) ret_i);
 198 }
 199
 200 static inline int safe_atou64(const char *s, uint64_t *ret_u) {
 201         assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
 202         return safe_atollu(s, (unsigned long long*) ret_u);
 203 }
 204
 205 static inline int safe_atoi64(const char *s, int64_t *ret_i) {
 206         assert_cc(sizeof(int64_t) == sizeof(long long int));
 207         return safe_atolli(s, (long long int*) ret_i);
 208 }
 209
 210 char *split(const char *c, size_t *l, const char *separator, char **state);
 211 char *split_quoted(const char *c, size_t *l, char **state);
 212
 213 #define FOREACH_WORD(word, length, s, state)                            \
 214         for ((state) = NULL, (word) = split((s), &(length), WHITESPACE, &(state)); (word); (word) = split((s), &(length), WHITESPACE, &(state)))
 215
 216 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state)       \
 217         for ((state) = NULL, (word) = split((s), &(length), (separator), &(state)); (word); (word) = split((s), &(length), (separator), &(state)))
 218
 219 #define FOREACH_WORD_QUOTED(word, length, s, state)                     \
 220         for ((state) = NULL, (word) = split_quoted((s), &(length), &(state)); (word); (word) = split_quoted((s), &(length), &(state)))
 221
 222 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
 223 int get_starttime_of_pid(pid_t pid, unsigned long long *st);
 224
 225 int write_one_line_file(const char *fn, const char *line);
 226 int write_one_line_file_atomic(const char *fn, const char *line);
 227 int read_one_line_file(const char *fn, char **line);
 228 int read_full_file(const char *fn, char **contents, size_t *size);
 229
 230 int parse_env_file(const char *fname, const char *separator, ...) _sentinel_;
 231 int load_env_file(const char *fname, char ***l);
 232 int write_env_file(const char *fname, char **l);
 233
 234 char *strappend(const char *s, const char *suffix);
 235 char *strnappend(const char *s, const char *suffix, size_t length);
 236
 237 char *replace_env(const char *format, char **env);
 238 char **replace_env_argv(char **argv, char **env);
 239
 240 int readlink_malloc(const char *p, char **r);
 241 int readlink_and_make_absolute(const char *p, char **r);
 242 int readlink_and_canonicalize(const char *p, char **r);
 243
 244 int reset_all_signal_handlers(void);
 245
 246 char *strstrip(char *s);
 247 char *delete_chars(char *s, const char *bad);
 248 char *truncate_nl(char *s);
 249
 250 char *file_in_same_dir(const char *path, const char *filename);
 251
 252 int rmdir_parents(const char *path, const char *stop);
 253
 254 int get_process_comm(pid_t pid, char **name);
 255 int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
 256 int get_process_exe(pid_t pid, char **name);
 257 int get_process_uid(pid_t pid, uid_t *uid);
 258
 259 char hexchar(int x);
 260 int unhexchar(char c);
 261 char octchar(int x);
 262 int unoctchar(char c);
 263 char decchar(int x);
 264 int undecchar(char c);
 265
 266 char *cescape(const char *s);
 267 char *cunescape(const char *s);
 268 char *cunescape_length(const char *s, size_t length);
 269
 270 char *xescape(const char *s, const char *bad);
 271
 272 char *bus_path_escape(const char *s);
 273 char *bus_path_unescape(const char *s);
 274
 275 char *ascii_strlower(char *path);
 276
 277 bool dirent_is_file(const struct dirent *de);
 278 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix);
 279
 280 bool ignore_file(const char *filename);
 281
 282 bool chars_intersect(const char *a, const char *b);
 283
 284 char *format_timestamp(char *buf, size_t l, usec_t t);
 285 char *format_timestamp_pretty(char *buf, size_t l, usec_t t);
 286 char *format_timespan(char *buf, size_t l, usec_t t);
 287
 288 int make_stdio(int fd);
 289 int make_null_stdio(void);
 290
 291 unsigned long long random_ull(void);
 292
 293 #define __DEFINE_STRING_TABLE_LOOKUP(name,type,scope)                   \
 294         scope const char *name##_to_string(type i) {                    \
 295                 if (i < 0 || i >= (type) ELEMENTSOF(name##_table))      \
 296                         return NULL;                                    \
 297                 return name##_table[i];                                 \
 298         }                                                               \
 299         scope type name##_from_string(const char *s) {                  \
 300                 type i;                                                 \
 301                 unsigned u = 0;                                         \
 302                 assert(s);                                              \
 303                 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
 304                         if (name##_table[i] &&                          \
 305                             streq(name##_table[i], s))                  \
 306                                 return i;                               \
 307                 if (safe_atou(s, &u) >= 0 &&                            \
 308                     u < ELEMENTSOF(name##_table))                       \
 309                         return (type) u;                                \
 310                 return (type) -1;                                       \
 311         }                                                               \
 312         struct __useless_struct_to_allow_trailing_semicolon__
 313
 314 #define DEFINE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,)
 315 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,static)
 316
 317 int fd_nonblock(int fd, bool nonblock);
 318 int fd_cloexec(int fd, bool cloexec);
 319
 320 int close_all_fds(const int except[], unsigned n_except);
 321
 322 bool fstype_is_network(const char *fstype);
 323
 324 int chvt(int vt);
 325
 326 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
 327 int ask(char *ret, const char *replies, const char *text, ...);
 328
 329 int reset_terminal_fd(int fd, bool switch_to_text);
 330 int reset_terminal(const char *name);
 331
 332 int open_terminal(const char *name, int mode);
 333 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm);
 334 int release_terminal(void);
 335
 336 int flush_fd(int fd);
 337
 338 int ignore_signals(int sig, ...);
 339 int default_signals(int sig, ...);
 340 int sigaction_many(const struct sigaction *sa, ...);
 341
 342 int close_pipe(int p[]);
 343 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
 344
 345 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
 346 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
 347
 348 bool is_device_path(const char *path);
 349
 350 int dir_is_empty(const char *path);
 351
 352 void rename_process(const char name[8]);
 353
 354 void sigset_add_many(sigset_t *ss, ...);
 355
 356 char* gethostname_malloc(void);
 357 bool hostname_is_set(void);
 358 char* getlogname_malloc(void);
 359
 360 int getttyname_malloc(int fd, char **r);
 361 int getttyname_harder(int fd, char **r);
 362
 363 int get_ctty_devnr(pid_t pid, dev_t *d);
 364 int get_ctty(pid_t, dev_t *_devnr, char **r);
 365
 366 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
 367 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
 368
 369 int rm_rf_children(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
 370 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
 371
 372 int pipe_eof(int fd);
 373
 374 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
 375
 376 void status_vprintf(const char *status, bool ellipse, const char *format, va_list ap);
 377 void status_printf(const char *status, bool ellipse, const char *format, ...);
 378 void status_welcome(void);
 379
 380 int fd_columns(int fd);
 381 unsigned columns(void);
 382
 383 int fd_lines(int fd);
 384 unsigned lines(void);
 385
 386 int running_in_chroot(void);
 387
 388 char *ellipsize(const char *s, size_t length, unsigned percent);
 389 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
 390
 391 int touch(const char *path);
 392
 393 char *unquote(const char *s, const char *quotes);
 394 char *normalize_env_assignment(const char *s);
 395
 396 int wait_for_terminate(pid_t pid, siginfo_t *status);
 397 int wait_for_terminate_and_warn(const char *name, pid_t pid);
 398
 399 _noreturn_ void freeze(void);
 400
 401 bool null_or_empty(struct stat *st);
 402 int null_or_empty_path(const char *fn);
 403
 404 DIR *xopendirat(int dirfd, const char *name, int flags);
 405
 406 void dual_timestamp_serialize(FILE *f, const char *name, dual_timestamp *t);
 407 void dual_timestamp_deserialize(const char *value, dual_timestamp *t);
 408
 409 char *fstab_node_to_udev_node(const char *p);
 410
 411 bool tty_is_vc(const char *tty);
 412 bool tty_is_vc_resolve(const char *tty);
 413 bool tty_is_console(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 bool display_is_local(const char *display);
 446 int socket_from_display(const char *display, char **path);
 447
 448 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home);
 449 int get_group_creds(const char **groupname, gid_t *gid);
 450
 451 int in_group(const char *name);
 452
 453 int glob_exists(const char *path);
 454
 455 int dirent_ensure_type(DIR *d, struct dirent *de);
 456
 457 int in_search_path(const char *path, char **search);
 458 int get_files_in_directory(const char *path, char ***list);
 459
 460 char *join(const char *x, ...) _sentinel_;
 461
 462 bool is_main_thread(void);
 463
 464 bool in_charset(const char *s, const char* charset);
 465
 466 int block_get_whole_disk(dev_t d, dev_t *ret);
 467
 468 int file_is_priv_sticky(const char *p);
 469
 470 int strdup_or_null(const char *a, char **b);
 471
 472 #define NULSTR_FOREACH(i, l)                                    \
 473         for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
 474
 475 #define NULSTR_FOREACH_PAIR(i, j, l)                             \
 476         for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
 477
 478 const char *ioprio_class_to_string(int i);
 479 int ioprio_class_from_string(const char *s);
 480
 481 const char *sigchld_code_to_string(int i);
 482 int sigchld_code_from_string(const char *s);
 483
 484 const char *log_facility_unshifted_to_string(int i);
 485 int log_facility_unshifted_from_string(const char *s);
 486
 487 const char *log_level_to_string(int i);
 488 int log_level_from_string(const char *s);
 489
 490 const char *sched_policy_to_string(int i);
 491 int sched_policy_from_string(const char *s);
 492
 493 const char *rlimit_to_string(int i);
 494 int rlimit_from_string(const char *s);
 495
 496 const char *ip_tos_to_string(int i);
 497 int ip_tos_from_string(const char *s);
 498
 499 const char *signal_to_string(int i);
 500 int signal_from_string(const char *s);
 501
 502 int signal_from_string_try_harder(const char *s);
 503
 504 extern int saved_argc;
 505 extern char **saved_argv;
 506
 507 bool kexec_loaded(void);
 508
 509 int prot_from_flags(int flags);
 510
 511 char *format_bytes(char *buf, size_t l, off_t t);
 512
 513 int fd_wait_for_event(int fd, int event, usec_t timeout);
 514
 515 void* memdup(const void *p, size_t l);
 516
 517 int is_kernel_thread(pid_t pid);
 518
 519 static inline void freep(void *p) {
 520         free(*(void**) p);
 521 }
 522
 523 static inline void fclosep(FILE **f) {
 524         if (*f)
 525                 fclose(*f);
 526 }
 527
 528 static inline void pclosep(FILE **f) {
 529         if (*f)
 530                 pclose(*f);
 531 }
 532
 533 static inline void closep(int *fd) {
 534         if (*fd >= 0)
 535                 close_nointr_nofail(*fd);
 536 }
 537
 538 static inline void closedirp(DIR **d) {
 539         if (*d)
 540                 closedir(*d);
 541 }
 542
 543 static inline void umaskp(mode_t *u) {
 544         umask(*u);
 545 }
 546
 547 #define _cleanup_free_ _cleanup_(freep)
 548 #define _cleanup_fclose_ _cleanup_(fclosep)
 549 #define _cleanup_pclose_ _cleanup_(pclosep)
 550 #define _cleanup_close_ _cleanup_(closep)
 551 #define _cleanup_closedir_ _cleanup_(closedirp)
 552 #define _cleanup_umask_ _cleanup_(umaskp)
 553 #define _cleanup_globfree_ _cleanup_(globfree)
 554
 555 int fd_inc_sndbuf(int fd, size_t n);
 556 int fd_inc_rcvbuf(int fd, size_t n);
 557
 558 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
 559
 560 int setrlimit_closest(int resource, const struct rlimit *rlim);
 561
 562 int getenv_for_pid(pid_t pid, const char *field, char **_value);
 563
 564 int can_sleep(const char *type);
 565
 566 bool is_valid_documentation_url(const char *url);
 567
 568 bool in_initrd(void);
 569
 570 void warn_melody(void);
 571
 572 char *strjoin(const char *x, ...) _sentinel_;
 573
 574 #define DEFINE_TRIVIAL_CLEANUP_FUNC(type, func)                 \
 575         static inline void func##p(type *p) {                   \
 576                 if (*p)                                         \
 577                         func(*p);                               \
 578         }                                                       \
 579         struct __useless_struct_to_allow_trailing_semicolon__
 580
 581 char *split_quoted(const char *c, size_t *l, char **state);
 582 char *cunescape_length(const char *s, size_t length);
 583 int unhexchar(char c) _const_;
 584 int unoctchar(char c) _const_;
 585
 586 #endif