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 <stdbool.h>
  29 #include <stdlib.h>
  30 #include <stdio.h>
  31 #include <signal.h>
  32 #include <sched.h>
  33 #include <limits.h>
  34
  35 #include "macro.h"
  36
  37 typedef uint64_t usec_t;
  38
  39 typedef struct dual_timestamp {
  40         usec_t realtime;
  41         usec_t monotonic;
  42 } dual_timestamp;
  43
  44 #define MSEC_PER_SEC  1000ULL
  45 #define USEC_PER_SEC  1000000ULL
  46 #define USEC_PER_MSEC 1000ULL
  47 #define NSEC_PER_SEC  1000000000ULL
  48 #define NSEC_PER_MSEC 1000000ULL
  49 #define NSEC_PER_USEC 1000ULL
  50
  51 #define USEC_PER_MINUTE (60ULL*USEC_PER_SEC)
  52 #define USEC_PER_HOUR (60ULL*USEC_PER_MINUTE)
  53 #define USEC_PER_DAY (24ULL*USEC_PER_HOUR)
  54 #define USEC_PER_WEEK (7ULL*USEC_PER_DAY)
  55 #define USEC_PER_MONTH (2629800ULL*USEC_PER_SEC)
  56 #define USEC_PER_YEAR (31557600ULL*USEC_PER_SEC)
  57
  58 /* What is interpreted as whitespace? */
  59 #define WHITESPACE " \t\n\r"
  60 #define NEWLINE "\n\r"
  61 #define QUOTES "\"\'"
  62 #define COMMENTS "#;\n"
  63
  64 #define FORMAT_TIMESTAMP_MAX 64
  65 #define FORMAT_TIMESTAMP_PRETTY_MAX 256
  66 #define FORMAT_TIMESPAN_MAX 64
  67
  68 #define ANSI_HIGHLIGHT_ON "\x1B[1;31m"
  69 #define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
  70 #define ANSI_HIGHLIGHT_OFF "\x1B[0m"
  71
  72 usec_t now(clockid_t clock);
  73
  74 dual_timestamp* dual_timestamp_get(dual_timestamp *ts);
  75
  76 usec_t timespec_load(const struct timespec *ts);
  77 struct timespec *timespec_store(struct timespec *ts, usec_t u);
  78
  79 usec_t timeval_load(const struct timeval *tv);
  80 struct timeval *timeval_store(struct timeval *tv, usec_t u);
  81
  82 #define streq(a,b) (strcmp((a),(b)) == 0)
  83
  84 bool streq_ptr(const char *a, const char *b);
  85
  86 #define new(t, n) ((t*) malloc(sizeof(t)*(n)))
  87
  88 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
  89
  90 #define malloc0(n) (calloc((n), 1))
  91
  92 static inline const char* yes_no(bool b) {
  93         return b ? "yes" : "no";
  94 }
  95
  96 static inline const char* strempty(const char *s) {
  97         return s ? s : "";
  98 }
  99
 100 static inline const char* strnull(const char *s) {
 101         return s ? s : "(null)";
 102 }
 103
 104 static inline const char *strna(const char *s) {
 105         return s ? s : "n/a";
 106 }
 107
 108 static inline bool is_path_absolute(const char *p) {
 109         return *p == '/';
 110 }
 111
 112 bool endswith(const char *s, const char *postfix);
 113 bool startswith(const char *s, const char *prefix);
 114 bool startswith_no_case(const char *s, const char *prefix);
 115
 116 bool first_word(const char *s, const char *word);
 117
 118 int close_nointr(int fd);
 119 void close_nointr_nofail(int fd);
 120 void close_many(const int fds[], unsigned n_fd);
 121
 122 int parse_boolean(const char *v);
 123 int parse_usec(const char *t, usec_t *usec);
 124 int parse_pid(const char *s, pid_t* ret_pid);
 125
 126 int safe_atou(const char *s, unsigned *ret_u);
 127 int safe_atoi(const char *s, int *ret_i);
 128
 129 int safe_atollu(const char *s, unsigned long long *ret_u);
 130 int safe_atolli(const char *s, long long int *ret_i);
 131
 132 #if __WORDSIZE == 32
 133 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
 134         assert_cc(sizeof(unsigned long) == sizeof(unsigned));
 135         return safe_atou(s, (unsigned*) ret_u);
 136 }
 137 static inline int safe_atoli(const char *s, long int *ret_u) {
 138         assert_cc(sizeof(long int) == sizeof(int));
 139         return safe_atoi(s, (int*) ret_u);
 140 }
 141 #else
 142 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
 143         assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
 144         return safe_atollu(s, (unsigned long long*) ret_u);
 145 }
 146 static inline int safe_atoli(const char *s, long int *ret_u) {
 147         assert_cc(sizeof(long int) == sizeof(long long int));
 148         return safe_atolli(s, (long long int*) ret_u);
 149 }
 150 #endif
 151
 152 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
 153         assert_cc(sizeof(uint32_t) == sizeof(unsigned));
 154         return safe_atou(s, (unsigned*) ret_u);
 155 }
 156
 157 static inline int safe_atoi32(const char *s, int32_t *ret_i) {
 158         assert_cc(sizeof(int32_t) == sizeof(int));
 159         return safe_atoi(s, (int*) ret_i);
 160 }
 161
 162 static inline int safe_atou64(const char *s, uint64_t *ret_u) {
 163         assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
 164         return safe_atollu(s, (unsigned long long*) ret_u);
 165 }
 166
 167 static inline int safe_atoi64(const char *s, int64_t *ret_i) {
 168         assert_cc(sizeof(int64_t) == sizeof(long long int));
 169         return safe_atolli(s, (long long int*) ret_i);
 170 }
 171
 172 char *split(const char *c, size_t *l, const char *separator, char **state);
 173 char *split_quoted(const char *c, size_t *l, char **state);
 174
 175 #define FOREACH_WORD(word, length, s, state)                            \
 176         for ((state) = NULL, (word) = split((s), &(length), WHITESPACE, &(state)); (word); (word) = split((s), &(length), WHITESPACE, &(state)))
 177
 178 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state)       \
 179         for ((state) = NULL, (word) = split((s), &(length), (separator), &(state)); (word); (word) = split((s), &(length), (separator), &(state)))
 180
 181 #define FOREACH_WORD_QUOTED(word, length, s, state)                     \
 182         for ((state) = NULL, (word) = split_quoted((s), &(length), &(state)); (word); (word) = split_quoted((s), &(length), &(state)))
 183
 184 char **split_path_and_make_absolute(const char *p);
 185
 186 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
 187
 188 int write_one_line_file(const char *fn, const char *line);
 189 int read_one_line_file(const char *fn, char **line);
 190 int read_full_file(const char *fn, char **contents);
 191
 192 int parse_env_file(const char *fname, const char *seperator, ...) _sentinel_;
 193
 194 char *strappend(const char *s, const char *suffix);
 195 char *strnappend(const char *s, const char *suffix, size_t length);
 196
 197 char *replace_env(const char *format, char **env);
 198 char **replace_env_argv(char **argv, char **env);
 199
 200 int readlink_malloc(const char *p, char **r);
 201 int readlink_and_make_absolute(const char *p, char **r);
 202
 203 char *file_name_from_path(const char *p);
 204 bool is_path(const char *p);
 205
 206 bool path_is_absolute(const char *p);
 207 char *path_make_absolute(const char *p, const char *prefix);
 208 char *path_make_absolute_cwd(const char *p);
 209
 210 char **strv_path_make_absolute_cwd(char **l);
 211 char **strv_path_canonicalize(char **l);
 212
 213 int reset_all_signal_handlers(void);
 214
 215 char *strstrip(char *s);
 216 char *delete_chars(char *s, const char *bad);
 217 char *truncate_nl(char *s);
 218
 219 char *file_in_same_dir(const char *path, const char *filename);
 220 int safe_mkdir(const char *path, mode_t mode, uid_t uid, gid_t gid);
 221 int mkdir_parents(const char *path, mode_t mode);
 222 int mkdir_p(const char *path, mode_t mode);
 223
 224 int parent_of_path(const char *path, char **parent);
 225
 226 int rmdir_parents(const char *path, const char *stop);
 227
 228 int get_process_name(pid_t pid, char **name);
 229 int get_process_cmdline(pid_t pid, size_t max_length, char **line);
 230
 231 char hexchar(int x);
 232 int unhexchar(char c);
 233 char octchar(int x);
 234 int unoctchar(char c);
 235 char decchar(int x);
 236 int undecchar(char c);
 237
 238 char *cescape(const char *s);
 239 char *cunescape(const char *s);
 240 char *cunescape_length(const char *s, size_t length);
 241
 242 char *xescape(const char *s, const char *bad);
 243
 244 char *bus_path_escape(const char *s);
 245 char *bus_path_unescape(const char *s);
 246
 247 char *path_kill_slashes(char *path);
 248
 249 bool path_startswith(const char *path, const char *prefix);
 250 bool path_equal(const char *a, const char *b);
 251
 252 char *ascii_strlower(char *path);
 253
 254 bool ignore_file(const char *filename);
 255
 256 bool chars_intersect(const char *a, const char *b);
 257
 258 char *format_timestamp(char *buf, size_t l, usec_t t);
 259 char *format_timestamp_pretty(char *buf, size_t l, usec_t t);
 260 char *format_timespan(char *buf, size_t l, usec_t t);
 261
 262 int make_stdio(int fd);
 263
 264 bool is_clean_exit(int code, int status);
 265 bool is_clean_exit_lsb(int code, int status);
 266
 267 unsigned long long random_ull(void);
 268
 269 #define DEFINE_STRING_TABLE_LOOKUP(name,type)                           \
 270         const char *name##_to_string(type i) {                          \
 271                 if (i < 0 || i >= (type) ELEMENTSOF(name##_table))      \
 272                         return NULL;                                    \
 273                 return name##_table[i];                                 \
 274         }                                                               \
 275         type name##_from_string(const char *s) {                        \
 276                 type i;                                                 \
 277                 unsigned u = 0;                                         \
 278                 assert(s);                                              \
 279                 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
 280                         if (name##_table[i] &&                          \
 281                             streq(name##_table[i], s))                  \
 282                                 return i;                               \
 283                 if (safe_atou(s, &u) >= 0 &&                            \
 284                     u < ELEMENTSOF(name##_table))                       \
 285                         return (type) u;                                \
 286                 return (type) -1;                                       \
 287         }                                                               \
 288         struct __useless_struct_to_allow_trailing_semicolon__
 289
 290
 291 int fd_nonblock(int fd, bool nonblock);
 292 int fd_cloexec(int fd, bool cloexec);
 293
 294 int close_all_fds(const int except[], unsigned n_except);
 295
 296 bool fstype_is_network(const char *fstype);
 297
 298 int chvt(int vt);
 299
 300 int read_one_char(FILE *f, char *ret, bool *need_nl);
 301 int ask(char *ret, const char *replies, const char *text, ...);
 302
 303 int reset_terminal(int fd);
 304 int open_terminal(const char *name, int mode);
 305 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm);
 306 int release_terminal(void);
 307
 308 int flush_fd(int fd);
 309
 310 int ignore_signals(int sig, ...);
 311 int default_signals(int sig, ...);
 312 int sigaction_many(const struct sigaction *sa, ...);
 313
 314 int close_pipe(int p[]);
 315
 316 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
 317 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
 318
 319 int path_is_mount_point(const char *path);
 320
 321 bool is_device_path(const char *path);
 322
 323 int dir_is_empty(const char *path);
 324
 325 void rename_process(const char name[8]);
 326
 327 void sigset_add_many(sigset_t *ss, ...);
 328
 329 char* gethostname_malloc(void);
 330 char* getlogname_malloc(void);
 331 int getttyname_malloc(char **r);
 332
 333 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
 334
 335 int rm_rf(const char *path, bool only_dirs, bool delete_root);
 336
 337 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
 338
 339 void status_vprintf(const char *format, va_list ap);
 340 void status_printf(const char *format, ...);
 341 void status_welcome(void);
 342
 343 int columns(void);
 344
 345 int running_in_chroot(void);
 346
 347 char *ellipsize(const char *s, unsigned length, unsigned percent);
 348
 349 int touch(const char *path);
 350
 351 char *unquote(const char *s, const char *quotes);
 352
 353 int wait_for_terminate(pid_t pid, siginfo_t *status);
 354 int wait_for_terminate_and_warn(const char *name, pid_t pid);
 355
 356 #define NULSTR_FOREACH(i, l) \
 357         for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
 358
 359 const char *ioprio_class_to_string(int i);
 360 int ioprio_class_from_string(const char *s);
 361
 362 const char *sigchld_code_to_string(int i);
 363 int sigchld_code_from_string(const char *s);
 364
 365 const char *log_facility_to_string(int i);
 366 int log_facility_from_string(const char *s);
 367
 368 const char *log_level_to_string(int i);
 369 int log_level_from_string(const char *s);
 370
 371 const char *sched_policy_to_string(int i);
 372 int sched_policy_from_string(const char *s);
 373
 374 const char *rlimit_to_string(int i);
 375 int rlimit_from_string(const char *s);
 376
 377 const char *ip_tos_to_string(int i);
 378 int ip_tos_from_string(const char *s);
 379
 380 const char *signal_to_string(int i);
 381 int signal_from_string(const char *s);
 382
 383 #endif