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