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