src/util.h

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