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_bytes(const char *t, off_t *bytes);
 139 int parse_pid(const char *s, pid_t* ret_pid);
 140 int parse_uid(const char *s, uid_t* ret_uid);
 141 #define parse_gid(s, ret_uid) parse_uid(s, ret_uid)
 142
 143 int safe_atou(const char *s, unsigned *ret_u);
 144 int safe_atoi(const char *s, int *ret_i);
 145
 146 int safe_atollu(const char *s, unsigned long long *ret_u);
 147 int safe_atolli(const char *s, long long int *ret_i);
 148
 149 #if __WORDSIZE == 32
 150 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
 151         assert_cc(sizeof(unsigned long) == sizeof(unsigned));
 152         return safe_atou(s, (unsigned*) ret_u);
 153 }
 154 static inline int safe_atoli(const char *s, long int *ret_u) {
 155         assert_cc(sizeof(long int) == sizeof(int));
 156         return safe_atoi(s, (int*) ret_u);
 157 }
 158 #else
 159 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
 160         assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
 161         return safe_atollu(s, (unsigned long long*) ret_u);
 162 }
 163 static inline int safe_atoli(const char *s, long int *ret_u) {
 164         assert_cc(sizeof(long int) == sizeof(long long int));
 165         return safe_atolli(s, (long long int*) ret_u);
 166 }
 167 #endif
 168
 169 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
 170         assert_cc(sizeof(uint32_t) == sizeof(unsigned));
 171         return safe_atou(s, (unsigned*) ret_u);
 172 }
 173
 174 static inline int safe_atoi32(const char *s, int32_t *ret_i) {
 175         assert_cc(sizeof(int32_t) == sizeof(int));
 176         return safe_atoi(s, (int*) ret_i);
 177 }
 178
 179 static inline int safe_atou64(const char *s, uint64_t *ret_u) {
 180         assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
 181         return safe_atollu(s, (unsigned long long*) ret_u);
 182 }
 183
 184 static inline int safe_atoi64(const char *s, int64_t *ret_i) {
 185         assert_cc(sizeof(int64_t) == sizeof(long long int));
 186         return safe_atolli(s, (long long int*) ret_i);
 187 }
 188
 189 char *split(const char *c, size_t *l, const char *separator, char **state);
 190 char *split_quoted(const char *c, size_t *l, char **state);
 191
 192 #define FOREACH_WORD(word, length, s, state)                            \
 193         for ((state) = NULL, (word) = split((s), &(length), WHITESPACE, &(state)); (word); (word) = split((s), &(length), WHITESPACE, &(state)))
 194
 195 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state)       \
 196         for ((state) = NULL, (word) = split((s), &(length), (separator), &(state)); (word); (word) = split((s), &(length), (separator), &(state)))
 197
 198 #define FOREACH_WORD_QUOTED(word, length, s, state)                     \
 199         for ((state) = NULL, (word) = split_quoted((s), &(length), &(state)); (word); (word) = split_quoted((s), &(length), &(state)))
 200
 201 char **split_path_and_make_absolute(const char *p);
 202
 203 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
 204 int get_starttime_of_pid(pid_t pid, unsigned long long *st);
 205
 206 int write_one_line_file(const char *fn, const char *line);
 207 int write_one_line_file_atomic(const char *fn, const char *line);
 208 int read_one_line_file(const char *fn, char **line);
 209 int read_full_file(const char *fn, char **contents, size_t *size);
 210
 211 int parse_env_file(const char *fname, const char *separator, ...) _sentinel_;
 212 int load_env_file(const char *fname, char ***l);
 213 int write_env_file(const char *fname, char **l);
 214
 215 char *strappend(const char *s, const char *suffix);
 216 char *strnappend(const char *s, const char *suffix, size_t length);
 217
 218 char *replace_env(const char *format, char **env);
 219 char **replace_env_argv(char **argv, char **env);
 220
 221 int readlink_malloc(const char *p, char **r);
 222 int readlink_and_make_absolute(const char *p, char **r);
 223 int readlink_and_canonicalize(const char *p, char **r);
 224
 225 char *file_name_from_path(const char *p);
 226 bool is_path(const char *p);
 227
 228 bool path_is_absolute(const char *p);
 229 char *path_make_absolute(const char *p, const char *prefix);
 230 char *path_make_absolute_cwd(const char *p);
 231
 232 char **strv_path_make_absolute_cwd(char **l);
 233 char **strv_path_canonicalize(char **l);
 234 char **strv_path_remove_empty(char **l);
 235
 236 int reset_all_signal_handlers(void);
 237
 238 char *strstrip(char *s);
 239 char *delete_chars(char *s, const char *bad);
 240 char *truncate_nl(char *s);
 241
 242 char *file_in_same_dir(const char *path, const char *filename);
 243 int safe_mkdir(const char *path, mode_t mode, uid_t uid, gid_t gid);
 244 int mkdir_parents(const char *path, mode_t mode);
 245 int mkdir_p(const char *path, mode_t mode);
 246
 247 int parent_of_path(const char *path, char **parent);
 248
 249 int rmdir_parents(const char *path, const char *stop);
 250
 251 int get_process_comm(pid_t pid, char **name);
 252 int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
 253 int get_process_exe(pid_t pid, char **name);
 254
 255 char hexchar(int x);
 256 int unhexchar(char c);
 257 char octchar(int x);
 258 int unoctchar(char c);
 259 char decchar(int x);
 260 int undecchar(char c);
 261
 262 char *cescape(const char *s);
 263 char *cunescape(const char *s);
 264 char *cunescape_length(const char *s, size_t length);
 265
 266 char *xescape(const char *s, const char *bad);
 267
 268 char *bus_path_escape(const char *s);
 269 char *bus_path_unescape(const char *s);
 270
 271 char *path_kill_slashes(char *path);
 272
 273 bool path_startswith(const char *path, const char *prefix);
 274 bool path_equal(const char *a, const char *b);
 275
 276 char *ascii_strlower(char *path);
 277
 278 bool dirent_is_file(const struct dirent *de);
 279 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix);
 280
 281 bool ignore_file(const char *filename);
 282
 283 bool chars_intersect(const char *a, const char *b);
 284
 285 char *format_timestamp(char *buf, size_t l, usec_t t);
 286 char *format_timestamp_pretty(char *buf, size_t l, usec_t t);
 287 char *format_timespan(char *buf, size_t l, usec_t t);
 288
 289 int make_stdio(int fd);
 290 int make_null_stdio(void);
 291
 292 unsigned long long random_ull(void);
 293
 294 #define __DEFINE_STRING_TABLE_LOOKUP(name,type,scope)                   \
 295         scope const char *name##_to_string(type i) {                    \
 296                 if (i < 0 || i >= (type) ELEMENTSOF(name##_table))      \
 297                         return NULL;                                    \
 298                 return name##_table[i];                                 \
 299         }                                                               \
 300         scope type name##_from_string(const char *s) {                  \
 301                 type i;                                                 \
 302                 unsigned u = 0;                                         \
 303                 assert(s);                                              \
 304                 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
 305                         if (name##_table[i] &&                          \
 306                             streq(name##_table[i], s))                  \
 307                                 return i;                               \
 308                 if (safe_atou(s, &u) >= 0 &&                            \
 309                     u < ELEMENTSOF(name##_table))                       \
 310                         return (type) u;                                \
 311                 return (type) -1;                                       \
 312         }                                                               \
 313         struct __useless_struct_to_allow_trailing_semicolon__
 314
 315 #define DEFINE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,)
 316 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,static)
 317
 318 int fd_nonblock(int fd, bool nonblock);
 319 int fd_cloexec(int fd, bool cloexec);
 320
 321 int close_all_fds(const int except[], unsigned n_except);
 322
 323 bool fstype_is_network(const char *fstype);
 324
 325 int chvt(int vt);
 326
 327 int read_one_char(FILE *f, char *ret, bool *need_nl);
 328 int ask(char *ret, const char *replies, const char *text, ...);
 329
 330 int reset_terminal_fd(int fd);
 331 int reset_terminal(const char *name);
 332
 333 int open_terminal(const char *name, int mode);
 334 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm);
 335 int release_terminal(void);
 336
 337 int flush_fd(int fd);
 338
 339 int ignore_signals(int sig, ...);
 340 int default_signals(int sig, ...);
 341 int sigaction_many(const struct sigaction *sa, ...);
 342
 343 int close_pipe(int p[]);
 344 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
 345
 346 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
 347 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
 348
 349 int path_is_mount_point(const char *path, bool allow_symlink);
 350
 351 bool is_device_path(const char *path);
 352
 353 int dir_is_empty(const char *path);
 354
 355 void rename_process(const char name[8]);
 356
 357 void sigset_add_many(sigset_t *ss, ...);
 358
 359 char* gethostname_malloc(void);
 360 char* getlogname_malloc(void);
 361
 362 int getttyname_malloc(int fd, char **r);
 363 int getttyname_harder(int fd, char **r);
 364
 365 int get_ctty_devnr(pid_t pid, dev_t *d);
 366 int get_ctty(pid_t, dev_t *_devnr, char **r);
 367
 368 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
 369 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
 370
 371 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
 372
 373 int pipe_eof(int fd);
 374
 375 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
 376
 377 void status_vprintf(const char *status, const char *format, va_list ap);
 378 void status_printf(const char *status, const char *format, ...);
 379 void status_welcome(void);
 380
 381 int fd_columns(int fd);
 382 unsigned columns(void);
 383
 384 int running_in_chroot(void);
 385
 386 char *ellipsize(const char *s, size_t length, unsigned percent);
 387 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
 388
 389 int touch(const char *path);
 390
 391 char *unquote(const char *s, const char *quotes);
 392 char *normalize_env_assignment(const char *s);
 393
 394 int wait_for_terminate(pid_t pid, siginfo_t *status);
 395 int wait_for_terminate_and_warn(const char *name, pid_t pid);
 396
 397 _noreturn_ void freeze(void);
 398
 399 bool null_or_empty(struct stat *st);
 400 int null_or_empty_path(const char *fn);
 401
 402 DIR *xopendirat(int dirfd, const char *name, int flags);
 403
 404 void dual_timestamp_serialize(FILE *f, const char *name, dual_timestamp *t);
 405 void dual_timestamp_deserialize(const char *value, dual_timestamp *t);
 406
 407 char *fstab_node_to_udev_node(const char *p);
 408
 409 void filter_environ(const char *prefix);
 410
 411 bool tty_is_vc(const char *tty);
 412 int vtnr_from_tty(const char *tty);
 413 const char *default_term_for_tty(const char *tty);
 414
 415 void execute_directory(const char *directory, DIR *_d, char *argv[]);
 416
 417 int kill_and_sigcont(pid_t pid, int sig);
 418
 419 bool nulstr_contains(const char*nulstr, const char *needle);
 420
 421 bool plymouth_running(void);
 422
 423 void parse_syslog_priority(char **p, int *priority);
 424 void skip_syslog_pid(char **buf);
 425 void skip_syslog_date(char **buf);
 426
 427 int have_effective_cap(int value);
 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 int conf_files_list(char ***strv, const char *suffix, const char *dir, ...);
 446
 447 int hwclock_is_localtime(void);
 448 int hwclock_apply_localtime_delta(int *min);
 449 int hwclock_reset_localtime_delta(void);
 450 int hwclock_get_time(struct tm *tm);
 451 int hwclock_set_time(const struct tm *tm);
 452
 453 int audit_session_from_pid(pid_t pid, uint32_t *id);
 454 int audit_loginuid_from_pid(pid_t pid, uid_t *uid);
 455
 456 bool display_is_local(const char *display);
 457 int socket_from_display(const char *display, char **path);
 458
 459 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home);
 460 int get_group_creds(const char **groupname, gid_t *gid);
 461
 462 int glob_exists(const char *path);
 463
 464 int dirent_ensure_type(DIR *d, struct dirent *de);
 465
 466 int in_search_path(const char *path, char **search);
 467 int get_files_in_directory(const char *path, char ***list);
 468
 469 char *join(const char *x, ...) _sentinel_;
 470
 471 bool is_main_thread(void);
 472
 473 bool in_charset(const char *s, const char* charset);
 474
 475 int block_get_whole_disk(dev_t d, dev_t *ret);
 476
 477 int file_is_sticky(const char *p);
 478
 479 int strdup_or_null(const char *a, char **b);
 480
 481 #define NULSTR_FOREACH(i, l)                                    \
 482         for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
 483
 484 #define NULSTR_FOREACH_PAIR(i, j, l)                             \
 485         for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
 486
 487 const char *ioprio_class_to_string(int i);
 488 int ioprio_class_from_string(const char *s);
 489
 490 const char *sigchld_code_to_string(int i);
 491 int sigchld_code_from_string(const char *s);
 492
 493 const char *log_facility_unshifted_to_string(int i);
 494 int log_facility_unshifted_from_string(const char *s);
 495
 496 const char *log_level_to_string(int i);
 497 int log_level_from_string(const char *s);
 498
 499 const char *sched_policy_to_string(int i);
 500 int sched_policy_from_string(const char *s);
 501
 502 const char *rlimit_to_string(int i);
 503 int rlimit_from_string(const char *s);
 504
 505 const char *ip_tos_to_string(int i);
 506 int ip_tos_from_string(const char *s);
 507
 508 const char *signal_to_string(int i);
 509 int signal_from_string(const char *s);
 510
 511 int signal_from_string_try_harder(const char *s);
 512
 513 extern int saved_argc;
 514 extern char **saved_argv;
 515
 516 bool kexec_loaded(void);
 517
 518 int prot_from_flags(int flags);
 519
 520 unsigned long cap_last_cap(void);
 521
 522 char *format_bytes(char *buf, size_t l, off_t t);
 523
 524 int fd_wait_for_event(int fd, int event);
 525
 526 #endif