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 COMMENTS "#;\n"
64 #define FORMAT_TIMESTAMP_MAX 64
65 #define FORMAT_TIMESTAMP_PRETTY_MAX 256
66 #define FORMAT_TIMESPAN_MAX 64
68 #define ANSI_HIGHLIGHT_ON "\x1B[1;31m"
69 #define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
70 #define ANSI_HIGHLIGHT_OFF "\x1B[0m"
72 usec_t now(clockid_t clock);
74 dual_timestamp* dual_timestamp_get(dual_timestamp *ts);
76 #define dual_timestamp_is_set(ts) ((ts)->realtime > 0)
78 usec_t timespec_load(const struct timespec *ts);
79 struct timespec *timespec_store(struct timespec *ts, usec_t u);
81 usec_t timeval_load(const struct timeval *tv);
82 struct timeval *timeval_store(struct timeval *tv, usec_t u);
84 #define streq(a,b) (strcmp((a),(b)) == 0)
86 bool streq_ptr(const char *a, const char *b);
88 #define new(t, n) ((t*) malloc(sizeof(t)*(n)))
90 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
92 #define malloc0(n) (calloc((n), 1))
94 static inline const char* yes_no(bool b) {
95 return b ? "yes" : "no";
98 static inline const char* strempty(const char *s) {
102 static inline const char* strnull(const char *s) {
103 return s ? s : "(null)";
106 static inline const char *strna(const char *s) {
107 return s ? s : "n/a";
110 static inline bool is_path_absolute(const char *p) {
114 bool endswith(const char *s, const char *postfix);
115 bool startswith(const char *s, const char *prefix);
116 bool startswith_no_case(const char *s, const char *prefix);
118 bool first_word(const char *s, const char *word);
120 int close_nointr(int fd);
121 void close_nointr_nofail(int fd);
122 void close_many(const int fds[], unsigned n_fd);
124 int parse_boolean(const char *v);
125 int parse_usec(const char *t, usec_t *usec);
126 int parse_pid(const char *s, pid_t* ret_pid);
128 int safe_atou(const char *s, unsigned *ret_u);
129 int safe_atoi(const char *s, int *ret_i);
131 int safe_atollu(const char *s, unsigned long long *ret_u);
132 int safe_atolli(const char *s, long long int *ret_i);
135 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
136 assert_cc(sizeof(unsigned long) == sizeof(unsigned));
137 return safe_atou(s, (unsigned*) ret_u);
139 static inline int safe_atoli(const char *s, long int *ret_u) {
140 assert_cc(sizeof(long int) == sizeof(int));
141 return safe_atoi(s, (int*) ret_u);
144 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
145 assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
146 return safe_atollu(s, (unsigned long long*) ret_u);
148 static inline int safe_atoli(const char *s, long int *ret_u) {
149 assert_cc(sizeof(long int) == sizeof(long long int));
150 return safe_atolli(s, (long long int*) ret_u);
154 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
155 assert_cc(sizeof(uint32_t) == sizeof(unsigned));
156 return safe_atou(s, (unsigned*) ret_u);
159 static inline int safe_atoi32(const char *s, int32_t *ret_i) {
160 assert_cc(sizeof(int32_t) == sizeof(int));
161 return safe_atoi(s, (int*) ret_i);
164 static inline int safe_atou64(const char *s, uint64_t *ret_u) {
165 assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
166 return safe_atollu(s, (unsigned long long*) ret_u);
169 static inline int safe_atoi64(const char *s, int64_t *ret_i) {
170 assert_cc(sizeof(int64_t) == sizeof(long long int));
171 return safe_atolli(s, (long long int*) ret_i);
174 char *split(const char *c, size_t *l, const char *separator, char **state);
175 char *split_quoted(const char *c, size_t *l, char **state);
177 #define FOREACH_WORD(word, length, s, state) \
178 for ((state) = NULL, (word) = split((s), &(length), WHITESPACE, &(state)); (word); (word) = split((s), &(length), WHITESPACE, &(state)))
180 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state) \
181 for ((state) = NULL, (word) = split((s), &(length), (separator), &(state)); (word); (word) = split((s), &(length), (separator), &(state)))
183 #define FOREACH_WORD_QUOTED(word, length, s, state) \
184 for ((state) = NULL, (word) = split_quoted((s), &(length), &(state)); (word); (word) = split_quoted((s), &(length), &(state)))
186 char **split_path_and_make_absolute(const char *p);
188 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
190 int write_one_line_file(const char *fn, const char *line);
191 int read_one_line_file(const char *fn, char **line);
192 int read_full_file(const char *fn, char **contents);
194 int parse_env_file(const char *fname, const char *seperator, ...) _sentinel_;
196 char *strappend(const char *s, const char *suffix);
197 char *strnappend(const char *s, const char *suffix, size_t length);
199 char *replace_env(const char *format, char **env);
200 char **replace_env_argv(char **argv, char **env);
202 int readlink_malloc(const char *p, char **r);
203 int readlink_and_make_absolute(const char *p, char **r);
205 char *file_name_from_path(const char *p);
206 bool is_path(const char *p);
208 bool path_is_absolute(const char *p);
209 char *path_make_absolute(const char *p, const char *prefix);
210 char *path_make_absolute_cwd(const char *p);
212 char **strv_path_make_absolute_cwd(char **l);
213 char **strv_path_canonicalize(char **l);
215 int reset_all_signal_handlers(void);
217 char *strstrip(char *s);
218 char *delete_chars(char *s, const char *bad);
219 char *truncate_nl(char *s);
221 char *file_in_same_dir(const char *path, const char *filename);
222 int safe_mkdir(const char *path, mode_t mode, uid_t uid, gid_t gid);
223 int mkdir_parents(const char *path, mode_t mode);
224 int mkdir_p(const char *path, mode_t mode);
226 int parent_of_path(const char *path, char **parent);
228 int rmdir_parents(const char *path, const char *stop);
230 int get_process_name(pid_t pid, char **name);
231 int get_process_cmdline(pid_t pid, size_t max_length, char **line);
234 int unhexchar(char c);
236 int unoctchar(char c);
238 int undecchar(char c);
240 char *cescape(const char *s);
241 char *cunescape(const char *s);
242 char *cunescape_length(const char *s, size_t length);
244 char *xescape(const char *s, const char *bad);
246 char *bus_path_escape(const char *s);
247 char *bus_path_unescape(const char *s);
249 char *path_kill_slashes(char *path);
251 bool path_startswith(const char *path, const char *prefix);
252 bool path_equal(const char *a, const char *b);
254 char *ascii_strlower(char *path);
256 bool ignore_file(const char *filename);
258 bool chars_intersect(const char *a, const char *b);
260 char *format_timestamp(char *buf, size_t l, usec_t t);
261 char *format_timestamp_pretty(char *buf, size_t l, usec_t t);
262 char *format_timespan(char *buf, size_t l, usec_t t);
264 int make_stdio(int fd);
266 bool is_clean_exit(int code, int status);
267 bool is_clean_exit_lsb(int code, int status);
269 unsigned long long random_ull(void);
271 #define DEFINE_STRING_TABLE_LOOKUP(name,type) \
272 const char *name##_to_string(type i) { \
273 if (i < 0 || i >= (type) ELEMENTSOF(name##_table)) \
275 return name##_table[i]; \
277 type name##_from_string(const char *s) { \
281 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
282 if (name##_table[i] && \
283 streq(name##_table[i], s)) \
285 if (safe_atou(s, &u) >= 0 && \
286 u < ELEMENTSOF(name##_table)) \
290 struct __useless_struct_to_allow_trailing_semicolon__
293 int fd_nonblock(int fd, bool nonblock);
294 int fd_cloexec(int fd, bool cloexec);
296 int close_all_fds(const int except[], unsigned n_except);
298 bool fstype_is_network(const char *fstype);
302 int read_one_char(FILE *f, char *ret, bool *need_nl);
303 int ask(char *ret, const char *replies, const char *text, ...);
305 int reset_terminal(int fd);
306 int open_terminal(const char *name, int mode);
307 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm);
308 int release_terminal(void);
310 int flush_fd(int fd);
312 int ignore_signals(int sig, ...);
313 int default_signals(int sig, ...);
314 int sigaction_many(const struct sigaction *sa, ...);
316 int close_pipe(int p[]);
318 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
319 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
321 int path_is_mount_point(const char *path);
323 bool is_device_path(const char *path);
325 int dir_is_empty(const char *path);
327 void rename_process(const char name[8]);
329 void sigset_add_many(sigset_t *ss, ...);
331 char* gethostname_malloc(void);
332 char* getlogname_malloc(void);
333 int getttyname_malloc(char **r);
335 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
337 int rm_rf(const char *path, bool only_dirs, bool delete_root);
339 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
341 void status_vprintf(const char *format, va_list ap);
342 void status_printf(const char *format, ...);
343 void status_welcome(void);
347 int running_in_chroot(void);
349 char *ellipsize(const char *s, unsigned length, unsigned percent);
351 int touch(const char *path);
353 char *unquote(const char *s, const char *quotes);
355 int wait_for_terminate(pid_t pid, siginfo_t *status);
356 int wait_for_terminate_and_warn(const char *name, pid_t pid);
358 #define NULSTR_FOREACH(i, l) \
359 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
361 const char *ioprio_class_to_string(int i);
362 int ioprio_class_from_string(const char *s);
364 const char *sigchld_code_to_string(int i);
365 int sigchld_code_from_string(const char *s);
367 const char *log_facility_to_string(int i);
368 int log_facility_from_string(const char *s);
370 const char *log_level_to_string(int i);
371 int log_level_from_string(const char *s);
373 const char *sched_policy_to_string(int i);
374 int sched_policy_from_string(const char *s);
376 const char *rlimit_to_string(int i);
377 int rlimit_from_string(const char *s);
379 const char *ip_tos_to_string(int i);
380 int ip_tos_from_string(const char *s);
382 const char *signal_to_string(int i);
383 int signal_from_string(const char *s);