1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
7 This file is part of systemd.
9 Copyright 2010 Lennart Poettering
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.
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.
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/>.
37 typedef uint64_t usec_t;
39 typedef struct dual_timestamp {
44 #define MSEC_PER_SEC 1000ULL
45 #define USEC_PER_SEC 1000000ULL
46 #define USEC_PER_MSEC 1000ULL
47 #define NSEC_PER_SEC 1000000000ULL
48 #define NSEC_PER_MSEC 1000000ULL
49 #define NSEC_PER_USEC 1000ULL
51 #define USEC_PER_MINUTE (60ULL*USEC_PER_SEC)
52 #define USEC_PER_HOUR (60ULL*USEC_PER_MINUTE)
53 #define USEC_PER_DAY (24ULL*USEC_PER_HOUR)
54 #define USEC_PER_WEEK (7ULL*USEC_PER_DAY)
55 #define USEC_PER_MONTH (2629800ULL*USEC_PER_SEC)
56 #define USEC_PER_YEAR (31557600ULL*USEC_PER_SEC)
58 /* What is interpreted as whitespace? */
59 #define WHITESPACE " \t\n\r"
60 #define NEWLINE "\n\r"
62 #define FORMAT_TIMESTAMP_MAX 64
63 #define FORMAT_TIMESTAMP_PRETTY_MAX 256
64 #define FORMAT_TIMESPAN_MAX 64
66 #define ANSI_HIGHLIGHT_ON "\x1B[1;31m"
67 #define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
68 #define ANSI_HIGHLIGHT_OFF "\x1B[0m"
70 usec_t now(clockid_t clock);
72 dual_timestamp* dual_timestamp_get(dual_timestamp *ts);
74 usec_t timespec_load(const struct timespec *ts);
75 struct timespec *timespec_store(struct timespec *ts, usec_t u);
77 usec_t timeval_load(const struct timeval *tv);
78 struct timeval *timeval_store(struct timeval *tv, usec_t u);
80 #define streq(a,b) (strcmp((a),(b)) == 0)
82 bool streq_ptr(const char *a, const char *b);
84 #define new(t, n) ((t*) malloc(sizeof(t)*(n)))
86 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
88 #define malloc0(n) (calloc((n), 1))
90 static inline const char* yes_no(bool b) {
91 return b ? "yes" : "no";
94 static inline const char* strempty(const char *s) {
98 static inline const char* strnull(const char *s) {
99 return s ? s : "(null)";
102 static inline const char *strna(const char *s) {
103 return s ? s : "n/a";
106 static inline bool is_path_absolute(const char *p) {
110 bool endswith(const char *s, const char *postfix);
111 bool startswith(const char *s, const char *prefix);
112 bool startswith_no_case(const char *s, const char *prefix);
114 bool first_word(const char *s, const char *word);
116 int close_nointr(int fd);
117 void close_nointr_nofail(int fd);
118 void close_many(const int fds[], unsigned n_fd);
120 int parse_boolean(const char *v);
121 int parse_usec(const char *t, usec_t *usec);
122 int parse_pid(const char *s, pid_t* ret_pid);
124 int safe_atou(const char *s, unsigned *ret_u);
125 int safe_atoi(const char *s, int *ret_i);
127 int safe_atollu(const char *s, unsigned long long *ret_u);
128 int safe_atolli(const char *s, long long int *ret_i);
131 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
132 assert_cc(sizeof(unsigned long) == sizeof(unsigned));
133 return safe_atou(s, (unsigned*) ret_u);
135 static inline int safe_atoli(const char *s, long int *ret_u) {
136 assert_cc(sizeof(long int) == sizeof(int));
137 return safe_atoi(s, (int*) ret_u);
140 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
141 assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
142 return safe_atollu(s, (unsigned long long*) ret_u);
144 static inline int safe_atoli(const char *s, long int *ret_u) {
145 assert_cc(sizeof(long int) == sizeof(long long int));
146 return safe_atolli(s, (long long int*) ret_u);
150 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
151 assert_cc(sizeof(uint32_t) == sizeof(unsigned));
152 return safe_atou(s, (unsigned*) ret_u);
155 static inline int safe_atoi32(const char *s, int32_t *ret_i) {
156 assert_cc(sizeof(int32_t) == sizeof(int));
157 return safe_atoi(s, (int*) ret_i);
160 static inline int safe_atou64(const char *s, uint64_t *ret_u) {
161 assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
162 return safe_atollu(s, (unsigned long long*) ret_u);
165 static inline int safe_atoi64(const char *s, int64_t *ret_i) {
166 assert_cc(sizeof(int64_t) == sizeof(long long int));
167 return safe_atolli(s, (long long int*) ret_i);
170 char *split(const char *c, size_t *l, const char *separator, char **state);
171 char *split_quoted(const char *c, size_t *l, char **state);
173 #define FOREACH_WORD(word, length, s, state) \
174 for ((state) = NULL, (word) = split((s), &(length), WHITESPACE, &(state)); (word); (word) = split((s), &(length), WHITESPACE, &(state)))
176 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state) \
177 for ((state) = NULL, (word) = split((s), &(length), (separator), &(state)); (word); (word) = split((s), &(length), (separator), &(state)))
179 #define FOREACH_WORD_QUOTED(word, length, s, state) \
180 for ((state) = NULL, (word) = split_quoted((s), &(length), &(state)); (word); (word) = split_quoted((s), &(length), &(state)))
182 char **split_path_and_make_absolute(const char *p);
184 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
186 int write_one_line_file(const char *fn, const char *line);
187 int read_one_line_file(const char *fn, char **line);
189 char *strappend(const char *s, const char *suffix);
190 char *strnappend(const char *s, const char *suffix, size_t length);
192 char *replace_env(const char *format, char **env);
193 char **replace_env_argv(char **argv, char **env);
195 int readlink_malloc(const char *p, char **r);
196 int readlink_and_make_absolute(const char *p, char **r);
198 char *file_name_from_path(const char *p);
199 bool is_path(const char *p);
201 bool path_is_absolute(const char *p);
202 char *path_make_absolute(const char *p, const char *prefix);
203 char *path_make_absolute_cwd(const char *p);
205 char **strv_path_make_absolute_cwd(char **l);
206 char **strv_path_canonicalize(char **l);
208 int reset_all_signal_handlers(void);
210 char *strstrip(char *s);
211 char *delete_chars(char *s, const char *bad);
212 char *truncate_nl(char *s);
214 char *file_in_same_dir(const char *path, const char *filename);
215 int safe_mkdir(const char *path, mode_t mode, uid_t uid, gid_t gid);
216 int mkdir_parents(const char *path, mode_t mode);
217 int mkdir_p(const char *path, mode_t mode);
219 int parent_of_path(const char *path, char **parent);
221 int rmdir_parents(const char *path, const char *stop);
223 int get_process_name(pid_t pid, char **name);
224 int get_process_cmdline(pid_t pid, size_t max_length, char **line);
227 int unhexchar(char c);
229 int unoctchar(char c);
231 int undecchar(char c);
233 char *cescape(const char *s);
234 char *cunescape(const char *s);
235 char *cunescape_length(const char *s, size_t length);
237 char *xescape(const char *s, const char *bad);
239 char *bus_path_escape(const char *s);
240 char *bus_path_unescape(const char *s);
242 char *path_kill_slashes(char *path);
244 bool path_startswith(const char *path, const char *prefix);
245 bool path_equal(const char *a, const char *b);
247 char *ascii_strlower(char *path);
249 bool ignore_file(const char *filename);
251 bool chars_intersect(const char *a, const char *b);
253 char *format_timestamp(char *buf, size_t l, usec_t t);
254 char *format_timestamp_pretty(char *buf, size_t l, usec_t t);
255 char *format_timespan(char *buf, size_t l, usec_t t);
257 int make_stdio(int fd);
259 bool is_clean_exit(int code, int status);
260 bool is_clean_exit_lsb(int code, int status);
262 unsigned long long random_ull(void);
264 #define DEFINE_STRING_TABLE_LOOKUP(name,type) \
265 const char *name##_to_string(type i) { \
266 if (i < 0 || i >= (type) ELEMENTSOF(name##_table)) \
268 return name##_table[i]; \
270 type name##_from_string(const char *s) { \
274 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
275 if (name##_table[i] && \
276 streq(name##_table[i], s)) \
278 if (safe_atou(s, &u) >= 0 && \
279 u < ELEMENTSOF(name##_table)) \
283 struct __useless_struct_to_allow_trailing_semicolon__
286 int fd_nonblock(int fd, bool nonblock);
287 int fd_cloexec(int fd, bool cloexec);
289 int close_all_fds(const int except[], unsigned n_except);
291 bool fstype_is_network(const char *fstype);
295 int read_one_char(FILE *f, char *ret, bool *need_nl);
296 int ask(char *ret, const char *replies, const char *text, ...);
298 int reset_terminal(int fd);
299 int open_terminal(const char *name, int mode);
300 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm);
301 int release_terminal(void);
303 int flush_fd(int fd);
305 int ignore_signals(int sig, ...);
306 int default_signals(int sig, ...);
307 int sigaction_many(const struct sigaction *sa, ...);
309 int close_pipe(int p[]);
311 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
312 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
314 int path_is_mount_point(const char *path);
316 bool is_device_path(const char *path);
318 int dir_is_empty(const char *path);
320 void rename_process(const char name[8]);
322 void sigset_add_many(sigset_t *ss, ...);
324 char* gethostname_malloc(void);
325 char* getlogname_malloc(void);
326 int getttyname_malloc(char **r);
328 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
330 int rm_rf(const char *path, bool only_dirs, bool delete_root);
332 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
334 void status_vprintf(const char *format, va_list ap);
335 void status_printf(const char *format, ...);
336 void status_welcome(void);
340 int running_in_chroot(void);
342 char *ellipsize(const char *s, unsigned length, unsigned percent);
344 int touch(const char *path);
346 char *unquote(const char *s, const char quote);
348 #define NULSTR_FOREACH(i, l) \
349 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
351 const char *ioprio_class_to_string(int i);
352 int ioprio_class_from_string(const char *s);
354 const char *sigchld_code_to_string(int i);
355 int sigchld_code_from_string(const char *s);
357 const char *log_facility_to_string(int i);
358 int log_facility_from_string(const char *s);
360 const char *log_level_to_string(int i);
361 int log_level_from_string(const char *s);
363 const char *sched_policy_to_string(int i);
364 int sched_policy_from_string(const char *s);
366 const char *rlimit_to_string(int i);
367 int rlimit_from_string(const char *s);
369 const char *ip_tos_to_string(int i);
370 int ip_tos_from_string(const char *s);
372 const char *signal_to_string(int i);
373 int signal_from_string(const char *s);