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
  33 typedef uint64_t usec_t;
  34
  35 typedef struct timestamp {
  36         usec_t realtime;
  37         usec_t monotonic;
  38 } timestamp;
  39
  40 #define MSEC_PER_SEC  1000ULL
  41 #define USEC_PER_SEC  1000000ULL
  42 #define USEC_PER_MSEC 1000ULL
  43 #define NSEC_PER_SEC  1000000000ULL
  44 #define NSEC_PER_MSEC 1000000ULL
  45 #define NSEC_PER_USEC 1000ULL
  46
  47 #define USEC_PER_MINUTE (60ULL*USEC_PER_SEC)
  48 #define USEC_PER_HOUR (60ULL*USEC_PER_MINUTE)
  49 #define USEC_PER_DAY (24ULL*USEC_PER_HOUR)
  50 #define USEC_PER_WEEK (7ULL*USEC_PER_DAY)
  51
  52 /* What is interpreted as whitespace? */
  53 #define WHITESPACE " \t\n\r"
  54 #define NEWLINE "\n\r"
  55
  56 #define FORMAT_TIMESTAMP_MAX 64
  57 #define FORMAT_TIMESPAN_MAX 64
  58
  59 usec_t now(clockid_t clock);
  60
  61 timestamp* timestamp_get(timestamp *ts);
  62
  63 usec_t timespec_load(const struct timespec *ts);
  64 struct timespec *timespec_store(struct timespec *ts, usec_t u);
  65
  66 usec_t timeval_load(const struct timeval *tv);
  67 struct timeval *timeval_store(struct timeval *tv, usec_t u);
  68
  69 #define streq(a,b) (strcmp((a),(b)) == 0)
  70
  71 bool streq_ptr(const char *a, const char *b);
  72
  73 #define new(t, n) ((t*) malloc(sizeof(t)*(n)))
  74
  75 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
  76
  77 #define malloc0(n) (calloc((n), 1))
  78
  79 static inline const char* yes_no(bool b) {
  80         return b ? "yes" : "no";
  81 }
  82
  83 static inline const char* strempty(const char *s) {
  84         return s ? s : "";
  85 }
  86
  87 static inline const char* strnull(const char *s) {
  88         return s ? s : "(null)";
  89 }
  90
  91 static inline const char *strna(const char *s) {
  92         return s ? s : "n/a";
  93 }
  94
  95 static inline bool is_path_absolute(const char *p) {
  96         return *p == '/';
  97 }
  98
  99 bool endswith(const char *s, const char *postfix);
 100 bool startswith(const char *s, const char *prefix);
 101 bool startswith_no_case(const char *s, const char *prefix);
 102
 103 bool first_word(const char *s, const char *word);
 104
 105 int close_nointr(int fd);
 106 void close_nointr_nofail(int fd);
 107 void close_many(const int fds[], unsigned n_fd);
 108
 109 int parse_boolean(const char *v);
 110 int parse_usec(const char *t, usec_t *usec);
 111 int parse_pid(const char *s, pid_t* ret_pid);
 112
 113 int safe_atou(const char *s, unsigned *ret_u);
 114 int safe_atoi(const char *s, int *ret_i);
 115
 116 int safe_atolu(const char *s, unsigned long *ret_u);
 117 int safe_atoli(const char *s, long int *ret_i);
 118
 119 int safe_atollu(const char *s, unsigned long long *ret_u);
 120 int safe_atolli(const char *s, long long int *ret_i);
 121
 122 char *split(const char *c, size_t *l, const char *separator, char **state);
 123 char *split_quoted(const char *c, size_t *l, char **state);
 124
 125 #define FOREACH_WORD(word, length, s, state)                            \
 126         for ((state) = NULL, (word) = split((s), &(length), WHITESPACE, &(state)); (word); (word) = split((s), &(length), WHITESPACE, &(state)))
 127
 128 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state)       \
 129         for ((state) = NULL, (word) = split((s), &(length), (separator), &(state)); (word); (word) = split((s), &(length), (separator), &(state)))
 130
 131 #define FOREACH_WORD_QUOTED(word, length, s, state)                     \
 132         for ((state) = NULL, (word) = split_quoted((s), &(length), &(state)); (word); (word) = split_quoted((s), &(length), &(state)))
 133
 134 char **split_path_and_make_absolute(const char *p);
 135
 136 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
 137
 138 int write_one_line_file(const char *fn, const char *line);
 139 int read_one_line_file(const char *fn, char **line);
 140
 141 char *strappend(const char *s, const char *suffix);
 142
 143 int readlink_malloc(const char *p, char **r);
 144 int readlink_and_make_absolute(const char *p, char **r);
 145
 146 char *file_name_from_path(const char *p);
 147 bool is_path(const char *p);
 148
 149 bool path_is_absolute(const char *p);
 150 char *path_make_absolute(const char *p, const char *prefix);
 151 char *path_make_absolute_cwd(const char *p);
 152
 153 char **strv_path_make_absolute_cwd(char **l);
 154 char **strv_path_canonicalize(char **l);
 155
 156 int reset_all_signal_handlers(void);
 157
 158 char *strstrip(char *s);
 159 char *delete_chars(char *s, const char *bad);
 160 char *truncate_nl(char *s);
 161
 162 char *file_in_same_dir(const char *path, const char *filename);
 163 int safe_mkdir(const char *path, mode_t mode, uid_t uid, gid_t gid);
 164 int mkdir_parents(const char *path, mode_t mode);
 165 int mkdir_p(const char *path, mode_t mode);
 166
 167 int rmdir_parents(const char *path, const char *stop);
 168
 169 int get_process_name(pid_t pid, char **name);
 170
 171 char hexchar(int x);
 172 int unhexchar(char c);
 173 char octchar(int x);
 174 int unoctchar(char c);
 175 char decchar(int x);
 176 int undecchar(char c);
 177
 178 char *cescape(const char *s);
 179 char *cunescape(const char *s);
 180
 181 char *path_kill_slashes(char *path);
 182
 183 bool path_startswith(const char *path, const char *prefix);
 184 bool path_equal(const char *a, const char *b);
 185
 186 char *ascii_strlower(char *path);
 187
 188 char *xescape(const char *s, const char *bad);
 189
 190 char *bus_path_escape(const char *s);
 191 char *bus_path_unescape(const char *s);
 192
 193 bool ignore_file(const char *filename);
 194
 195 bool chars_intersect(const char *a, const char *b);
 196
 197 char *format_timestamp(char *buf, size_t l, usec_t t);
 198 char *format_timespan(char *buf, size_t l, usec_t t);
 199
 200 int make_stdio(int fd);
 201
 202 bool is_clean_exit(int code, int status);
 203
 204 unsigned long long random_ull(void);
 205
 206 #define DEFINE_STRING_TABLE_LOOKUP(name,type)                           \
 207         const char *name##_to_string(type i) {                          \
 208                 if (i < 0 || i >= (type) ELEMENTSOF(name##_table))      \
 209                         return NULL;                                    \
 210                 return name##_table[i];                                 \
 211         }                                                               \
 212         type name##_from_string(const char *s) {                        \
 213                 type i;                                                 \
 214                 unsigned u = 0;                                         \
 215                 assert(s);                                              \
 216                 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
 217                         if (streq(name##_table[i], s))                  \
 218                                 return i;                               \
 219                 if (safe_atou(s, &u) >= 0 &&                            \
 220                     u < ELEMENTSOF(name##_table))                       \
 221                         return (type) u;                                \
 222                 return (type) -1;                                       \
 223         }                                                               \
 224         struct __useless_struct_to_allow_trailing_semicolon__
 225
 226
 227 int fd_nonblock(int fd, bool nonblock);
 228 int fd_cloexec(int fd, bool cloexec);
 229
 230 int close_all_fds(const int except[], unsigned n_except);
 231
 232 bool fstype_is_network(const char *fstype);
 233
 234 int chvt(int vt);
 235
 236 int read_one_char(FILE *f, char *ret, bool *need_nl);
 237 int ask(char *ret, const char *replies, const char *text, ...);
 238
 239 int reset_terminal(int fd);
 240 int open_terminal(const char *name, int mode);
 241 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm);
 242 int release_terminal(void);
 243
 244 int flush_fd(int fd);
 245
 246 int ignore_signals(int sig, ...);
 247 int default_signals(int sig, ...);
 248 int sigaction_many(const struct sigaction *sa, ...);
 249
 250 int close_pipe(int p[]);
 251
 252 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
 253 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
 254
 255 int path_is_mount_point(const char *path);
 256
 257 bool is_device_path(const char *path);
 258
 259 int dir_is_empty(const char *path);
 260
 261 void rename_process(const char name[8]);
 262
 263 void sigset_add_many(sigset_t *ss, ...);
 264
 265 char* gethostname_malloc(void);
 266 char* getlogname_malloc(void);
 267 int getttyname_malloc(char **r);
 268 int getmachineid_malloc(char **r);
 269
 270 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
 271
 272 int rm_rf(const char *path, bool only_dirs, bool delete_root);
 273
 274 const char *ioprio_class_to_string(int i);
 275 int ioprio_class_from_string(const char *s);
 276
 277 const char *sigchld_code_to_string(int i);
 278 int sigchld_code_from_string(const char *s);
 279
 280 const char *log_facility_to_string(int i);
 281 int log_facility_from_string(const char *s);
 282
 283 const char *log_level_to_string(int i);
 284 int log_level_from_string(const char *s);
 285
 286 const char *sched_policy_to_string(int i);
 287 int sched_policy_from_string(const char *s);
 288
 289 const char *rlimit_to_string(int i);
 290 int rlimit_from_string(const char *s);
 291
 292 #endif