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
  43 usec_t now(clockid_t clock);
  44
  45 usec_t timespec_load(const struct timespec *ts);
  46 struct timespec *timespec_store(struct timespec *ts, usec_t u);
  47
  48 usec_t timeval_load(const struct timeval *tv);
  49 struct timeval *timeval_store(struct timeval *tv, usec_t u);
  50
  51 #define streq(a,b) (strcmp((a),(b)) == 0)
  52
  53 #define new(t, n) ((t*) malloc(sizeof(t)*(n)))
  54
  55 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
  56
  57 #define malloc0(n) (calloc((n), 1))
  58
  59 static inline const char* yes_no(bool b) {
  60         return b ? "yes" : "no";
  61 }
  62
  63 static inline const char* strempty(const char *s) {
  64         return s ? s : "";
  65 }
  66
  67 static inline const char* strnull(const char *s) {
  68         return s ? s : "(null)";
  69 }
  70
  71 static inline const char *strna(const char *s) {
  72         return s ? s : "n/a";
  73 }
  74
  75 static inline bool is_path_absolute(const char *p) {
  76         return *p == '/';
  77 }
  78
  79 bool endswith(const char *s, const char *postfix);
  80 bool startswith(const char *s, const char *prefix);
  81
  82 bool first_word(const char *s, const char *word);
  83
  84 int close_nointr(int fd);
  85 void close_nointr_nofail(int fd);
  86
  87 int parse_boolean(const char *v);
  88
  89 int safe_atou(const char *s, unsigned *ret_u);
  90 int safe_atoi(const char *s, int *ret_i);
  91
  92 int safe_atolu(const char *s, unsigned long *ret_u);
  93 int safe_atoli(const char *s, long int *ret_i);
  94
  95 int safe_atollu(const char *s, unsigned long long *ret_u);
  96 int safe_atolli(const char *s, long long int *ret_i);
  97
  98 char *split_spaces(const char *c, size_t *l, char **state);
  99 char *split_quoted(const char *c, size_t *l, char **state);
 100
 101 #define FOREACH_WORD(word, length, s, state)                            \
 102         for ((state) = NULL, (word) = split_spaces((s), &(l), &(state)); (word); (word) = split_spaces((s), &(l), &(state)))
 103
 104 #define FOREACH_WORD_QUOTED(word, length, s, state)                     \
 105         for ((state) = NULL, (word) = split_quoted((s), &(l), &(state)); (word); (word) = split_quoted((s), &(l), &(state)))
 106
 107 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
 108
 109 int write_one_line_file(const char *fn, const char *line);
 110 int read_one_line_file(const char *fn, char **line);
 111
 112 char *strappend(const char *s, const char *suffix);
 113
 114 int readlink_malloc(const char *p, char **r);
 115
 116 char *file_name_from_path(const char *p);
 117 bool is_path(const char *p);
 118
 119 bool path_is_absolute(const char *p);
 120 char *path_make_absolute(const char *p, const char *prefix);
 121
 122 int reset_all_signal_handlers(void);
 123
 124 char *strstrip(char *s);
 125 char *file_in_same_dir(const char *path, const char *filename);
 126
 127 char hexchar(int x);
 128 int unhexchar(char c);
 129 char octchar(int x);
 130 int unoctchar(char c);
 131
 132 char *cescape(const char *s);
 133 char *cunescape(const char *s);
 134
 135 char *path_kill_slashes(char *path);
 136
 137 bool path_startswith(const char *path, const char *prefix);
 138
 139 char *ascii_strlower(char *path);
 140
 141 char *xescape(const char *s, const char *bad);
 142
 143 char *bus_path_escape(const char *s);
 144 char *bus_path_unescape(const char *s);
 145
 146 #define DEFINE_STRING_TABLE_LOOKUP(name,type)                           \
 147         const char *name##_to_string(type i) {                          \
 148                 if (i < 0 || i >= (type) ELEMENTSOF(name##_table))      \
 149                         return NULL;                                    \
 150                 return name##_table[i];                                 \
 151         }                                                               \
 152         type name##_from_string(const char *s) {                        \
 153                 type i;                                                 \
 154                 assert(s);                                              \
 155                 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
 156                         if (streq(name##_table[i], s))                  \
 157                                 return i;                               \
 158                 return (type) -1;                                       \
 159         }                                                               \
 160         struct __useless_struct_to_allow_trailing_semicolon__
 161
 162
 163 const char *ioprio_class_to_string(int i);
 164 int ioprio_class_from_string(const char *s);
 165
 166 const char *sigchld_code_to_string(int i);
 167 int sigchld_code_from_string(const char *s);
 168
 169 const char *log_facility_to_string(int i);
 170 int log_facility_from_string(const char *s);
 171
 172 const char *log_level_to_string(int i);
 173 int log_level_from_string(const char *s);
 174
 175 const char *sched_policy_to_string(int i);
 176 int sched_policy_from_string(const char *s);
 177
 178 const char *rlimit_to_string(int i);
 179 int rlimit_from_string(const char *s);
 180
 181 #endif