src/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 General Public License as published by
  13   the Free Software Foundation; either version 2 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   General Public License for more details.
  20
  21   You should have received a copy of the GNU 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
  38 #include "macro.h"
  39
  40 typedef uint64_t usec_t;
  41
  42 typedef struct dual_timestamp {
  43         usec_t realtime;
  44         usec_t monotonic;
  45 } dual_timestamp;
  46
  47 #define MSEC_PER_SEC  1000ULL
  48 #define USEC_PER_SEC  1000000ULL
  49 #define USEC_PER_MSEC 1000ULL
  50 #define NSEC_PER_SEC  1000000000ULL
  51 #define NSEC_PER_MSEC 1000000ULL
  52 #define NSEC_PER_USEC 1000ULL
  53
  54 #define USEC_PER_MINUTE (60ULL*USEC_PER_SEC)
  55 #define USEC_PER_HOUR (60ULL*USEC_PER_MINUTE)
  56 #define USEC_PER_DAY (24ULL*USEC_PER_HOUR)
  57 #define USEC_PER_WEEK (7ULL*USEC_PER_DAY)
  58 #define USEC_PER_MONTH (2629800ULL*USEC_PER_SEC)
  59 #define USEC_PER_YEAR (31557600ULL*USEC_PER_SEC)
  60
  61 /* What is interpreted as whitespace? */
  62 #define WHITESPACE " \t\n\r"
  63 #define NEWLINE "\n\r"
  64 #define QUOTES "\"\'"
  65 #define COMMENTS "#;\n"
  66
  67 #define FORMAT_TIMESTAMP_MAX 64
  68 #define FORMAT_TIMESTAMP_PRETTY_MAX 256
  69 #define FORMAT_TIMESPAN_MAX 64
  70
  71 #define ANSI_HIGHLIGHT_ON "\x1B[1;31m"
  72 #define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
  73 #define ANSI_HIGHLIGHT_OFF "\x1B[0m"
  74
  75 usec_t now(clockid_t clock);
  76
  77 dual_timestamp* dual_timestamp_get(dual_timestamp *ts);
  78 dual_timestamp* dual_timestamp_from_realtime(dual_timestamp *ts, usec_t u);
  79
  80 #define dual_timestamp_is_set(ts) ((ts)->realtime > 0)
  81
  82 usec_t timespec_load(const struct timespec *ts);
  83 struct timespec *timespec_store(struct timespec *ts, usec_t u);
  84
  85 usec_t timeval_load(const struct timeval *tv);
  86 struct timeval *timeval_store(struct timeval *tv, usec_t u);
  87
  88 size_t page_size(void);
  89 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
  90
  91 #define streq(a,b) (strcmp((a),(b)) == 0)
  92 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
  93
  94 bool streq_ptr(const char *a, const char *b);
  95
  96 #define new(t, n) ((t*) malloc(sizeof(t)*(n)))
  97
  98 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
  99
 100 #define malloc0(n) (calloc((n), 1))
 101
 102 static inline const char* yes_no(bool b) {
 103         return b ? "yes" : "no";
 104 }
 105
 106 static inline const char* strempty(const char *s) {
 107         return s ? s : "";
 108 }
 109
 110 static inline const char* strnull(const char *s) {
 111         return s ? s : "(null)";
 112 }
 113
 114 static inline const char *strna(const char *s) {
 115         return s ? s : "n/a";
 116 }
 117
 118 static inline bool is_path_absolute(const char *p) {
 119         return *p == '/';
 120 }
 121
 122 static inline bool isempty(const char *p) {
 123         return !p || !p[0];
 124 }
 125
 126 bool endswith(const char *s, const char *postfix);
 127 bool startswith(const char *s, const char *prefix);
 128 bool startswith_no_case(const char *s, const char *prefix);
 129
 130 bool first_word(const char *s, const char *word);
 131
 132 int close_nointr(int fd);
 133 void close_nointr_nofail(int fd);
 134 void close_many(const int fds[], unsigned n_fd);
 135
 136 int parse_boolean(const char *v);
 137 int parse_usec(const char *t, usec_t *usec);
 138 int parse_pid(const char *s, pid_t* ret_pid);
 139 int parse_uid(const char *s, uid_t* ret_uid);
 140 #define parse_gid(s, ret_uid) parse_uid(s, ret_uid)
 141
 142 int safe_atou(const char *s, unsigned *ret_u);
 143 int safe_atoi(const char *s, int *ret_i);
 144
 145 int safe_atollu(const char *s, unsigned long long *ret_u);
 146 int safe_atolli(const char *s, long long int *ret_i);
 147
 148 #if __WORDSIZE == 32
 149 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
 150         assert_cc(sizeof(unsigned long) == sizeof(unsigned));
 151         return safe_atou(s, (unsigned*) ret_u);
 152 }
 153 static inline int safe_atoli(const char *s, long int *ret_u) {
 154         assert_cc(sizeof(long int) == sizeof(int));
 155         return safe_atoi(s, (int*) ret_u);
 156 }
 157 #else
 158 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
 159         assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
 160         return safe_atollu(s, (unsigned long long*) ret_u);
 161 }
 162 static inline int safe_atoli(const char *s, long int *ret_u) {
 163         assert_cc(sizeof(long int) == sizeof(long long int));
 164         return safe_atolli(s, (long long int*) ret_u);
 165 }
 166 #endif
 167
 168 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
 169         assert_cc(sizeof(uint32_t) == sizeof(unsigned));
 170         return safe_atou(s, (unsigned*) ret_u);
 171 }
 172
 173 static inline int safe_atoi32(const char *s, int32_t *ret_i) {
 174         assert_cc(sizeof(int32_t) == sizeof(int));
 175         return safe_atoi(s, (int*) ret_i);
 176 }
 177
 178 static inline int safe_atou64(const char *s, uint64_t *ret_u) {
 179         assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
 180         return safe_atollu(s, (unsigned long long*) ret_u);
 181 }
 182
 183 static inline int safe_atoi64(const char *s, int64_t *ret_i) {
 184         assert_cc(sizeof(int64_t) == sizeof(long long int));
 185         return safe_atolli(s, (long long int*) ret_i);
 186 }
 187
 188 char *split(const char *c, size_t *l, const char *separator, char **state);
 189 char *split_quoted(const char *c, size_t *l, char **state);
 190
 191 #define FOREACH_WORD(word, length, s, state)                            \
 192         for ((state) = NULL, (word) = split((s), &(length), WHITESPACE, &(state)); (word); (word) = split((s), &(length), WHITESPACE, &(state)))
 193
 194 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state)       \
 195         for ((state) = NULL, (word) = split((s), &(length), (separator), &(state)); (word); (word) = split((s), &(length), (separator), &(state)))
 196
 197 #define FOREACH_WORD_QUOTED(word, length, s, state)                     \
 198         for ((state) = NULL, (word) = split_quoted((s), &(length), &(state)); (word); (word) = split_quoted((s), &(length), &(state)))
 199
 200 char **split_path_and_make_absolute(const char *p);
 201
 202 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
 203 int get_starttime_of_pid(pid_t pid, unsigned long long *st);
 204
 205 int write_one_line_file(const char *fn, const char *line);
 206 int write_one_line_file_atomic(const char *fn, const char *line);
 207 int read_one_line_file(const char *fn, char **line);
 208 int read_full_file(const char *fn, char **contents, size_t *size);
 209
 210 int parse_env_file(const char *fname, const char *separator, ...) _sentinel_;
 211 int load_env_file(const char *fname, char ***l);
 212 int write_env_file(const char *fname, char **l);
 213
 214 char *strappend(const char *s, const char *suffix);
 215 char *strnappend(const char *s, const char *suffix, size_t length);
 216
 217 char *replace_env(const char *format, char **env);
 218 char **replace_env_argv(char **argv, char **env);
 219
 220 int readlink_malloc(const char *p, char **r);
 221 int readlink_and_make_absolute(const char *p, char **r);
 222 int readlink_and_canonicalize(const char *p, char **r);
 223
 224 char *file_name_from_path(const char *p);
 225 bool is_path(const char *p);
 226
 227 bool path_is_absolute(const char *p);
 228 char *path_make_absolute(const char *p, const char *prefix);
 229 char *path_make_absolute_cwd(const char *p);
 230
 231 char **strv_path_make_absolute_cwd(char **l);
 232 char **strv_path_canonicalize(char **l);
 233 char **strv_path_remove_empty(char **l);
 234
 235 int reset_all_signal_handlers(void);
 236
 237 char *strstrip(char *s);
 238 char *delete_chars(char *s, const char *bad);
 239 char *truncate_nl(char *s);
 240
 241 char *file_in_same_dir(const char *path, const char *filename);
 242 int safe_mkdir(const char *path, mode_t mode, uid_t uid, gid_t gid);
 243 int mkdir_parents(const char *path, mode_t mode);
 244 int mkdir_p(const char *path, mode_t mode);
 245
 246 int parent_of_path(const char *path, char **parent);
 247
 248 int rmdir_parents(const char *path, const char *stop);
 249
 250 int get_process_name(pid_t pid, char **name);
 251 int get_process_cmdline(pid_t pid, size_t max_length, char **line);
 252
 253 char hexchar(int x);
 254 int unhexchar(char c);
 255 char octchar(int x);
 256 int unoctchar(char c);
 257 char decchar(int x);
 258 int undecchar(char c);
 259
 260 char *cescape(const char *s);
 261 char *cunescape(const char *s);
 262 char *cunescape_length(const char *s, size_t length);
 263
 264 char *xescape(const char *s, const char *bad);
 265
 266 char *bus_path_escape(const char *s);
 267 char *bus_path_unescape(const char *s);
 268
 269 char *path_kill_slashes(char *path);
 270
 271 bool path_startswith(const char *path, const char *prefix);
 272 bool path_equal(const char *a, const char *b);
 273
 274 char *ascii_strlower(char *path);
 275
 276 bool dirent_is_file(struct dirent *de);
 277 bool ignore_file(const char *filename);
 278
 279 bool chars_intersect(const char *a, const char *b);
 280
 281 char *format_timestamp(char *buf, size_t l, usec_t t);
 282 char *format_timestamp_pretty(char *buf, size_t l, usec_t t);
 283 char *format_timespan(char *buf, size_t l, usec_t t);
 284
 285 int make_stdio(int fd);
 286 int make_null_stdio(void);
 287
 288 unsigned long long random_ull(void);
 289
 290 #define DEFINE_STRING_TABLE_LOOKUP(name,type)                           \
 291         const char *name##_to_string(type i) {                          \
 292                 if (i < 0 || i >= (type) ELEMENTSOF(name##_table))      \
 293                         return NULL;                                    \
 294                 return name##_table[i];                                 \
 295         }                                                               \
 296         type name##_from_string(const char *s) {                        \
 297                 type i;                                                 \
 298                 unsigned u = 0;                                         \
 299                 assert(s);                                              \
 300                 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
 301                         if (name##_table[i] &&                          \
 302                             streq(name##_table[i], s))                  \
 303                                 return i;                               \
 304                 if (safe_atou(s, &u) >= 0 &&                            \
 305                     u < ELEMENTSOF(name##_table))                       \
 306                         return (type) u;                                \
 307                 return (type) -1;                                       \
 308         }                                                               \
 309         struct __useless_struct_to_allow_trailing_semicolon__
 310
 311
 312 int fd_nonblock(int fd, bool nonblock);
 313 int fd_cloexec(int fd, bool cloexec);
 314
 315 int close_all_fds(const int except[], unsigned n_except);
 316
 317 bool fstype_is_network(const char *fstype);
 318
 319 int chvt(int vt);
 320
 321 int read_one_char(FILE *f, char *ret, bool *need_nl);
 322 int ask(char *ret, const char *replies, const char *text, ...);
 323
 324 int reset_terminal_fd(int fd);
 325 int reset_terminal(const char *name);
 326
 327 int open_terminal(const char *name, int mode);
 328 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm);
 329 int release_terminal(void);
 330
 331 int flush_fd(int fd);
 332
 333 int ignore_signals(int sig, ...);
 334 int default_signals(int sig, ...);
 335 int sigaction_many(const struct sigaction *sa, ...);
 336
 337 int close_pipe(int p[]);
 338 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
 339
 340 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
 341 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
 342
 343 int path_is_mount_point(const char *path);
 344
 345 bool is_device_path(const char *path);
 346
 347 int dir_is_empty(const char *path);
 348
 349 void rename_process(const char name[8]);
 350
 351 void sigset_add_many(sigset_t *ss, ...);
 352
 353 char* gethostname_malloc(void);
 354 char* getlogname_malloc(void);
 355
 356 int getttyname_malloc(int fd, char **r);
 357 int getttyname_harder(int fd, char **r);
 358
 359 int get_ctty_devnr(pid_t pid, dev_t *d);
 360 int get_ctty(pid_t, dev_t *_devnr, char **r);
 361
 362 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
 363
 364 int rm_rf(const char *path, bool only_dirs, bool delete_root);
 365
 366 int pipe_eof(int fd);
 367
 368 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
 369
 370 void status_vprintf(const char *format, va_list ap);
 371 void status_printf(const char *format, ...);
 372 void status_welcome(void);
 373
 374 int columns(void);
 375
 376 int running_in_chroot(void);
 377
 378 char *ellipsize(const char *s, unsigned length, unsigned percent);
 379
 380 int touch(const char *path);
 381
 382 char *unquote(const char *s, const char *quotes);
 383 char *normalize_env_assignment(const char *s);
 384
 385 int wait_for_terminate(pid_t pid, siginfo_t *status);
 386 int wait_for_terminate_and_warn(const char *name, pid_t pid);
 387
 388 _noreturn_ void freeze(void);
 389
 390 bool null_or_empty(struct stat *st);
 391 int null_or_empty_path(const char *fn);
 392
 393 DIR *xopendirat(int dirfd, const char *name, int flags);
 394
 395 void dual_timestamp_serialize(FILE *f, const char *name, dual_timestamp *t);
 396 void dual_timestamp_deserialize(const char *value, dual_timestamp *t);
 397
 398 char *fstab_node_to_udev_node(const char *p);
 399
 400 void filter_environ(const char *prefix);
 401
 402 bool tty_is_vc(const char *tty);
 403 int vtnr_from_tty(const char *tty);
 404 const char *default_term_for_tty(const char *tty);
 405
 406 int detect_vm(const char **id);
 407 int detect_container(const char **id);
 408 int detect_virtualization(const char **id);
 409
 410 void execute_directory(const char *directory, DIR *_d, char *argv[]);
 411
 412 int kill_and_sigcont(pid_t pid, int sig);
 413
 414 bool nulstr_contains(const char*nulstr, const char *needle);
 415
 416 bool plymouth_running(void);
 417
 418 void parse_syslog_priority(char **p, int *priority);
 419
 420 int have_effective_cap(int value);
 421
 422 bool hostname_is_valid(const char *s);
 423 char* hostname_cleanup(char *s);
 424
 425 char* strshorten(char *s, size_t l);
 426
 427 int terminal_vhangup_fd(int fd);
 428 int terminal_vhangup(const char *name);
 429
 430 int vt_disallocate(const char *name);
 431
 432 int copy_file(const char *from, const char *to);
 433 int symlink_or_copy(const char *from, const char *to);
 434 int symlink_or_copy_atomic(const char *from, const char *to);
 435
 436 int fchmod_umask(int fd, mode_t mode);
 437
 438 int conf_files_list(char ***strv, const char *suffix, const char *dir, ...);
 439
 440 int hwclock_is_localtime(void);
 441 int hwclock_apply_localtime_delta(int *min);
 442 int hwclock_reset_localtime_delta(void);
 443 int hwclock_get_time(struct tm *tm);
 444 int hwclock_set_time(const struct tm *tm);
 445
 446 int audit_session_from_pid(pid_t pid, uint32_t *id);
 447
 448 bool display_is_local(const char *display);
 449 int socket_from_display(const char *display, char **path);
 450
 451 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home);
 452 int get_group_creds(const char **groupname, gid_t *gid);
 453
 454 int glob_exists(const char *path);
 455
 456 int dirent_ensure_type(DIR *d, struct dirent *de);
 457
 458 int in_search_path(const char *path, char **search);
 459 int get_files_in_directory(const char *path, char ***list);
 460
 461 #define NULSTR_FOREACH(i, l)                                    \
 462         for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
 463
 464 #define NULSTR_FOREACH_PAIR(i, j, l)                             \
 465         for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
 466
 467 const char *ioprio_class_to_string(int i);
 468 int ioprio_class_from_string(const char *s);
 469
 470 const char *sigchld_code_to_string(int i);
 471 int sigchld_code_from_string(const char *s);
 472
 473 const char *log_facility_unshifted_to_string(int i);
 474 int log_facility_unshifted_from_string(const char *s);
 475
 476 const char *log_level_to_string(int i);
 477 int log_level_from_string(const char *s);
 478
 479 const char *sched_policy_to_string(int i);
 480 int sched_policy_from_string(const char *s);
 481
 482 const char *rlimit_to_string(int i);
 483 int rlimit_from_string(const char *s);
 484
 485 const char *ip_tos_to_string(int i);
 486 int ip_tos_from_string(const char *s);
 487
 488 const char *signal_to_string(int i);
 489 int signal_from_string(const char *s);
 490
 491 int signal_from_string_try_harder(const char *s);
 492
 493 extern int saved_argc;
 494 extern char **saved_argv;
 495
 496 #endif