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 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 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
 205 int get_starttime_of_pid(pid_t pid, unsigned long long *st);
 206
 207 int write_one_line_file(const char *fn, const char *line);
 208 int write_one_line_file_atomic(const char *fn, const char *line);
 209 int read_one_line_file(const char *fn, char **line);
 210 int read_full_file(const char *fn, char **contents, size_t *size);
 211
 212 int parse_env_file(const char *fname, const char *separator, ...) _sentinel_;
 213 int load_env_file(const char *fname, char ***l);
 214 int write_env_file(const char *fname, char **l);
 215
 216 char *strappend(const char *s, const char *suffix);
 217 char *strnappend(const char *s, const char *suffix, size_t length);
 218
 219 char *replace_env(const char *format, char **env);
 220 char **replace_env_argv(char **argv, char **env);
 221
 222 int readlink_malloc(const char *p, char **r);
 223 int readlink_and_make_absolute(const char *p, char **r);
 224 int readlink_and_canonicalize(const char *p, char **r);
 225
 226 int reset_all_signal_handlers(void);
 227
 228 char *strstrip(char *s);
 229 char *delete_chars(char *s, const char *bad);
 230 char *truncate_nl(char *s);
 231
 232 char *file_in_same_dir(const char *path, const char *filename);
 233
 234 int rmdir_parents(const char *path, const char *stop);
 235
 236 int get_process_comm(pid_t pid, char **name);
 237 int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
 238 int get_process_exe(pid_t pid, char **name);
 239 int get_process_uid(pid_t pid, uid_t *uid);
 240
 241 char hexchar(int x);
 242 int unhexchar(char c);
 243 char octchar(int x);
 244 int unoctchar(char c);
 245 char decchar(int x);
 246 int undecchar(char c);
 247
 248 char *cescape(const char *s);
 249 char *cunescape(const char *s);
 250 char *cunescape_length(const char *s, size_t length);
 251
 252 char *xescape(const char *s, const char *bad);
 253
 254 char *bus_path_escape(const char *s);
 255 char *bus_path_unescape(const char *s);
 256
 257 char *ascii_strlower(char *path);
 258
 259 bool dirent_is_file(const struct dirent *de);
 260 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix);
 261
 262 bool ignore_file(const char *filename);
 263
 264 bool chars_intersect(const char *a, const char *b);
 265
 266 char *format_timestamp(char *buf, size_t l, usec_t t);
 267 char *format_timestamp_pretty(char *buf, size_t l, usec_t t);
 268 char *format_timespan(char *buf, size_t l, usec_t t);
 269
 270 int make_stdio(int fd);
 271 int make_null_stdio(void);
 272
 273 unsigned long long random_ull(void);
 274
 275 #define __DEFINE_STRING_TABLE_LOOKUP(name,type,scope)                   \
 276         scope const char *name##_to_string(type i) {                    \
 277                 if (i < 0 || i >= (type) ELEMENTSOF(name##_table))      \
 278                         return NULL;                                    \
 279                 return name##_table[i];                                 \
 280         }                                                               \
 281         scope type name##_from_string(const char *s) {                  \
 282                 type i;                                                 \
 283                 unsigned u = 0;                                         \
 284                 assert(s);                                              \
 285                 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
 286                         if (name##_table[i] &&                          \
 287                             streq(name##_table[i], s))                  \
 288                                 return i;                               \
 289                 if (safe_atou(s, &u) >= 0 &&                            \
 290                     u < ELEMENTSOF(name##_table))                       \
 291                         return (type) u;                                \
 292                 return (type) -1;                                       \
 293         }                                                               \
 294         struct __useless_struct_to_allow_trailing_semicolon__
 295
 296 #define DEFINE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,)
 297 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,static)
 298
 299 int fd_nonblock(int fd, bool nonblock);
 300 int fd_cloexec(int fd, bool cloexec);
 301
 302 int close_all_fds(const int except[], unsigned n_except);
 303
 304 bool fstype_is_network(const char *fstype);
 305
 306 int chvt(int vt);
 307
 308 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
 309 int ask(char *ret, const char *replies, const char *text, ...);
 310
 311 int reset_terminal_fd(int fd, bool switch_to_text);
 312 int reset_terminal(const char *name);
 313
 314 int open_terminal(const char *name, int mode);
 315 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm);
 316 int release_terminal(void);
 317
 318 int flush_fd(int fd);
 319
 320 int ignore_signals(int sig, ...);
 321 int default_signals(int sig, ...);
 322 int sigaction_many(const struct sigaction *sa, ...);
 323
 324 int close_pipe(int p[]);
 325 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
 326
 327 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
 328 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
 329
 330 bool is_device_path(const char *path);
 331
 332 int dir_is_empty(const char *path);
 333
 334 void rename_process(const char name[8]);
 335
 336 void sigset_add_many(sigset_t *ss, ...);
 337
 338 char* gethostname_malloc(void);
 339 char* getlogname_malloc(void);
 340
 341 int getttyname_malloc(int fd, char **r);
 342 int getttyname_harder(int fd, char **r);
 343
 344 int get_ctty_devnr(pid_t pid, dev_t *d);
 345 int get_ctty(pid_t, dev_t *_devnr, char **r);
 346
 347 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
 348 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
 349
 350 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
 351
 352 int pipe_eof(int fd);
 353
 354 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
 355
 356 void status_vprintf(const char *status, bool ellipse, const char *format, va_list ap);
 357 void status_printf(const char *status, bool ellipse, const char *format, ...);
 358 void status_welcome(void);
 359
 360 int fd_columns(int fd);
 361 unsigned columns(void);
 362
 363 int fd_lines(int fd);
 364 unsigned lines(void);
 365
 366 int running_in_chroot(void);
 367
 368 char *ellipsize(const char *s, size_t length, unsigned percent);
 369 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
 370
 371 int touch(const char *path);
 372
 373 char *unquote(const char *s, const char *quotes);
 374 char *normalize_env_assignment(const char *s);
 375
 376 int wait_for_terminate(pid_t pid, siginfo_t *status);
 377 int wait_for_terminate_and_warn(const char *name, pid_t pid);
 378
 379 _noreturn_ void freeze(void);
 380
 381 bool null_or_empty(struct stat *st);
 382 int null_or_empty_path(const char *fn);
 383
 384 DIR *xopendirat(int dirfd, const char *name, int flags);
 385
 386 void dual_timestamp_serialize(FILE *f, const char *name, dual_timestamp *t);
 387 void dual_timestamp_deserialize(const char *value, dual_timestamp *t);
 388
 389 char *fstab_node_to_udev_node(const char *p);
 390
 391 bool tty_is_vc(const char *tty);
 392 bool tty_is_vc_resolve(const char *tty);
 393 bool tty_is_console(const char *tty);
 394 int vtnr_from_tty(const char *tty);
 395 const char *default_term_for_tty(const char *tty);
 396
 397 void execute_directory(const char *directory, DIR *_d, char *argv[]);
 398
 399 int kill_and_sigcont(pid_t pid, int sig);
 400
 401 bool nulstr_contains(const char*nulstr, const char *needle);
 402
 403 bool plymouth_running(void);
 404
 405 void parse_syslog_priority(char **p, int *priority);
 406 void skip_syslog_pid(char **buf);
 407 void skip_syslog_date(char **buf);
 408
 409 bool hostname_is_valid(const char *s);
 410 char* hostname_cleanup(char *s);
 411
 412 char* strshorten(char *s, size_t l);
 413
 414 int terminal_vhangup_fd(int fd);
 415 int terminal_vhangup(const char *name);
 416
 417 int vt_disallocate(const char *name);
 418
 419 int copy_file(const char *from, const char *to);
 420 int symlink_or_copy(const char *from, const char *to);
 421 int symlink_or_copy_atomic(const char *from, const char *to);
 422
 423 int fchmod_umask(int fd, mode_t mode);
 424
 425 bool display_is_local(const char *display);
 426 int socket_from_display(const char *display, char **path);
 427
 428 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home);
 429 int get_group_creds(const char **groupname, gid_t *gid);
 430
 431 int in_group(const char *name);
 432
 433 int glob_exists(const char *path);
 434
 435 int dirent_ensure_type(DIR *d, struct dirent *de);
 436
 437 int in_search_path(const char *path, char **search);
 438 int get_files_in_directory(const char *path, char ***list);
 439
 440 char *join(const char *x, ...) _sentinel_;
 441
 442 bool is_main_thread(void);
 443
 444 bool in_charset(const char *s, const char* charset);
 445
 446 int block_get_whole_disk(dev_t d, dev_t *ret);
 447
 448 int file_is_priv_sticky(const char *p);
 449
 450 int strdup_or_null(const char *a, char **b);
 451
 452 #define NULSTR_FOREACH(i, l)                                    \
 453         for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
 454
 455 #define NULSTR_FOREACH_PAIR(i, j, l)                             \
 456         for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
 457
 458 const char *ioprio_class_to_string(int i);
 459 int ioprio_class_from_string(const char *s);
 460
 461 const char *sigchld_code_to_string(int i);
 462 int sigchld_code_from_string(const char *s);
 463
 464 const char *log_facility_unshifted_to_string(int i);
 465 int log_facility_unshifted_from_string(const char *s);
 466
 467 const char *log_level_to_string(int i);
 468 int log_level_from_string(const char *s);
 469
 470 const char *sched_policy_to_string(int i);
 471 int sched_policy_from_string(const char *s);
 472
 473 const char *rlimit_to_string(int i);
 474 int rlimit_from_string(const char *s);
 475
 476 const char *ip_tos_to_string(int i);
 477 int ip_tos_from_string(const char *s);
 478
 479 const char *signal_to_string(int i);
 480 int signal_from_string(const char *s);
 481
 482 int signal_from_string_try_harder(const char *s);
 483
 484 extern int saved_argc;
 485 extern char **saved_argv;
 486
 487 bool kexec_loaded(void);
 488
 489 int prot_from_flags(int flags);
 490
 491 char *format_bytes(char *buf, size_t l, off_t t);
 492
 493 int fd_wait_for_event(int fd, int event, usec_t timeout);
 494
 495 void* memdup(const void *p, size_t l);
 496
 497 int is_kernel_thread(pid_t pid);
 498
 499 int fd_inc_sndbuf(int fd, size_t n);
 500 int fd_inc_rcvbuf(int fd, size_t n);
 501
 502 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
 503
 504 int setrlimit_closest(int resource, const struct rlimit *rlim);
 505
 506 int getenv_for_pid(pid_t pid, const char *field, char **_value);
 507
 508 #endif