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