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