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