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