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/>.
39 typedef uint64_t usec_t;
41 typedef struct dual_timestamp {
46 #define MSEC_PER_SEC 1000ULL
47 #define USEC_PER_SEC 1000000ULL
48 #define USEC_PER_MSEC 1000ULL
49 #define NSEC_PER_SEC 1000000000ULL
50 #define NSEC_PER_MSEC 1000000ULL
51 #define NSEC_PER_USEC 1000ULL
53 #define USEC_PER_MINUTE (60ULL*USEC_PER_SEC)
54 #define USEC_PER_HOUR (60ULL*USEC_PER_MINUTE)
55 #define USEC_PER_DAY (24ULL*USEC_PER_HOUR)
56 #define USEC_PER_WEEK (7ULL*USEC_PER_DAY)
57 #define USEC_PER_MONTH (2629800ULL*USEC_PER_SEC)
58 #define USEC_PER_YEAR (31557600ULL*USEC_PER_SEC)
60 /* What is interpreted as whitespace? */
61 #define WHITESPACE " \t\n\r"
62 #define NEWLINE "\n\r"
64 #define COMMENTS "#;\n"
66 #define FORMAT_TIMESTAMP_MAX 64
67 #define FORMAT_TIMESTAMP_PRETTY_MAX 256
68 #define FORMAT_TIMESPAN_MAX 64
70 #define ANSI_HIGHLIGHT_ON "\x1B[1;31m"
71 #define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
72 #define ANSI_HIGHLIGHT_OFF "\x1B[0m"
74 usec_t now(clockid_t clock);
76 dual_timestamp* dual_timestamp_get(dual_timestamp *ts);
78 #define dual_timestamp_is_set(ts) ((ts)->realtime > 0)
80 usec_t timespec_load(const struct timespec *ts);
81 struct timespec *timespec_store(struct timespec *ts, usec_t u);
83 usec_t timeval_load(const struct timeval *tv);
84 struct timeval *timeval_store(struct timeval *tv, usec_t u);
86 size_t page_size(void);
87 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
89 #define streq(a,b) (strcmp((a),(b)) == 0)
90 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
92 bool streq_ptr(const char *a, const char *b);
94 #define new(t, n) ((t*) malloc(sizeof(t)*(n)))
96 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
98 #define malloc0(n) (calloc((n), 1))
100 static inline const char* yes_no(bool b) {
101 return b ? "yes" : "no";
104 static inline const char* strempty(const char *s) {
108 static inline const char* strnull(const char *s) {
109 return s ? s : "(null)";
112 static inline const char *strna(const char *s) {
113 return s ? s : "n/a";
116 static inline bool is_path_absolute(const char *p) {
120 static inline bool isempty(const char *p) {
124 bool endswith(const char *s, const char *postfix);
125 bool startswith(const char *s, const char *prefix);
126 bool startswith_no_case(const char *s, const char *prefix);
128 bool first_word(const char *s, const char *word);
130 int close_nointr(int fd);
131 void close_nointr_nofail(int fd);
132 void close_many(const int fds[], unsigned n_fd);
134 int parse_boolean(const char *v);
135 int parse_usec(const char *t, usec_t *usec);
136 int parse_pid(const char *s, pid_t* ret_pid);
138 int safe_atou(const char *s, unsigned *ret_u);
139 int safe_atoi(const char *s, int *ret_i);
141 int safe_atollu(const char *s, unsigned long long *ret_u);
142 int safe_atolli(const char *s, long long int *ret_i);
145 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
146 assert_cc(sizeof(unsigned long) == sizeof(unsigned));
147 return safe_atou(s, (unsigned*) ret_u);
149 static inline int safe_atoli(const char *s, long int *ret_u) {
150 assert_cc(sizeof(long int) == sizeof(int));
151 return safe_atoi(s, (int*) ret_u);
154 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
155 assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
156 return safe_atollu(s, (unsigned long long*) ret_u);
158 static inline int safe_atoli(const char *s, long int *ret_u) {
159 assert_cc(sizeof(long int) == sizeof(long long int));
160 return safe_atolli(s, (long long int*) ret_u);
164 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
165 assert_cc(sizeof(uint32_t) == sizeof(unsigned));
166 return safe_atou(s, (unsigned*) ret_u);
169 static inline int safe_atoi32(const char *s, int32_t *ret_i) {
170 assert_cc(sizeof(int32_t) == sizeof(int));
171 return safe_atoi(s, (int*) ret_i);
174 static inline int safe_atou64(const char *s, uint64_t *ret_u) {
175 assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
176 return safe_atollu(s, (unsigned long long*) ret_u);
179 static inline int safe_atoi64(const char *s, int64_t *ret_i) {
180 assert_cc(sizeof(int64_t) == sizeof(long long int));
181 return safe_atolli(s, (long long int*) ret_i);
184 char *split(const char *c, size_t *l, const char *separator, char **state);
185 char *split_quoted(const char *c, size_t *l, char **state);
187 #define FOREACH_WORD(word, length, s, state) \
188 for ((state) = NULL, (word) = split((s), &(length), WHITESPACE, &(state)); (word); (word) = split((s), &(length), WHITESPACE, &(state)))
190 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state) \
191 for ((state) = NULL, (word) = split((s), &(length), (separator), &(state)); (word); (word) = split((s), &(length), (separator), &(state)))
193 #define FOREACH_WORD_QUOTED(word, length, s, state) \
194 for ((state) = NULL, (word) = split_quoted((s), &(length), &(state)); (word); (word) = split_quoted((s), &(length), &(state)))
196 char **split_path_and_make_absolute(const char *p);
198 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
199 int get_starttime_of_pid(pid_t pid, unsigned long long *st);
201 int write_one_line_file(const char *fn, const char *line);
202 int read_one_line_file(const char *fn, char **line);
203 int read_full_file(const char *fn, char **contents);
205 int parse_env_file(const char *fname, const char *separator, ...) _sentinel_;
206 int load_env_file(const char *fname, char ***l);
207 int write_env_file(const char *fname, char **l);
209 char *strappend(const char *s, const char *suffix);
210 char *strnappend(const char *s, const char *suffix, size_t length);
212 char *replace_env(const char *format, char **env);
213 char **replace_env_argv(char **argv, char **env);
215 int readlink_malloc(const char *p, char **r);
216 int readlink_and_make_absolute(const char *p, char **r);
218 char *file_name_from_path(const char *p);
219 bool is_path(const char *p);
221 bool path_is_absolute(const char *p);
222 char *path_make_absolute(const char *p, const char *prefix);
223 char *path_make_absolute_cwd(const char *p);
225 char **strv_path_make_absolute_cwd(char **l);
226 char **strv_path_canonicalize(char **l);
228 int reset_all_signal_handlers(void);
230 char *strstrip(char *s);
231 char *delete_chars(char *s, const char *bad);
232 char *truncate_nl(char *s);
234 char *file_in_same_dir(const char *path, const char *filename);
235 int safe_mkdir(const char *path, mode_t mode, uid_t uid, gid_t gid);
236 int mkdir_parents(const char *path, mode_t mode);
237 int mkdir_p(const char *path, mode_t mode);
239 int parent_of_path(const char *path, char **parent);
241 int rmdir_parents(const char *path, const char *stop);
243 int get_process_name(pid_t pid, char **name);
244 int get_process_cmdline(pid_t pid, size_t max_length, char **line);
247 int unhexchar(char c);
249 int unoctchar(char c);
251 int undecchar(char c);
253 char *cescape(const char *s);
254 char *cunescape(const char *s);
255 char *cunescape_length(const char *s, size_t length);
257 char *xescape(const char *s, const char *bad);
259 char *bus_path_escape(const char *s);
260 char *bus_path_unescape(const char *s);
262 char *path_kill_slashes(char *path);
264 bool path_startswith(const char *path, const char *prefix);
265 bool path_equal(const char *a, const char *b);
267 char *ascii_strlower(char *path);
269 bool ignore_file(const char *filename);
271 bool chars_intersect(const char *a, const char *b);
273 char *format_timestamp(char *buf, size_t l, usec_t t);
274 char *format_timestamp_pretty(char *buf, size_t l, usec_t t);
275 char *format_timespan(char *buf, size_t l, usec_t t);
277 int make_stdio(int fd);
278 int make_null_stdio(void);
280 unsigned long long random_ull(void);
282 #define DEFINE_STRING_TABLE_LOOKUP(name,type) \
283 const char *name##_to_string(type i) { \
284 if (i < 0 || i >= (type) ELEMENTSOF(name##_table)) \
286 return name##_table[i]; \
288 type name##_from_string(const char *s) { \
292 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
293 if (name##_table[i] && \
294 streq(name##_table[i], s)) \
296 if (safe_atou(s, &u) >= 0 && \
297 u < ELEMENTSOF(name##_table)) \
301 struct __useless_struct_to_allow_trailing_semicolon__
304 int fd_nonblock(int fd, bool nonblock);
305 int fd_cloexec(int fd, bool cloexec);
307 int close_all_fds(const int except[], unsigned n_except);
309 bool fstype_is_network(const char *fstype);
313 int read_one_char(FILE *f, char *ret, bool *need_nl);
314 int ask(char *ret, const char *replies, const char *text, ...);
316 int reset_terminal(int fd);
317 int open_terminal(const char *name, int mode);
318 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm);
319 int release_terminal(void);
321 int flush_fd(int fd);
323 int ignore_signals(int sig, ...);
324 int default_signals(int sig, ...);
325 int sigaction_many(const struct sigaction *sa, ...);
327 int close_pipe(int p[]);
329 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
330 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
332 int path_is_mount_point(const char *path);
334 bool is_device_path(const char *path);
336 int dir_is_empty(const char *path);
338 void rename_process(const char name[8]);
340 void sigset_add_many(sigset_t *ss, ...);
342 char* gethostname_malloc(void);
343 char* getlogname_malloc(void);
345 int getttyname_malloc(int fd, char **r);
346 int getttyname_harder(int fd, char **r);
348 int get_ctty_devnr(dev_t *d);
349 int get_ctty(char **r, dev_t *_devnr);
351 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
353 int rm_rf(const char *path, bool only_dirs, bool delete_root);
355 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
357 void status_vprintf(const char *format, va_list ap);
358 void status_printf(const char *format, ...);
359 void status_welcome(void);
363 int running_in_chroot(void);
365 char *ellipsize(const char *s, unsigned length, unsigned percent);
367 int touch(const char *path);
369 char *unquote(const char *s, const char *quotes);
370 char *normalize_env_assignment(const char *s);
372 int wait_for_terminate(pid_t pid, siginfo_t *status);
373 int wait_for_terminate_and_warn(const char *name, pid_t pid);
375 _noreturn_ void freeze(void);
377 bool null_or_empty(struct stat *st);
379 DIR *xopendirat(int dirfd, const char *name, int flags);
381 void dual_timestamp_serialize(FILE *f, const char *name, dual_timestamp *t);
382 void dual_timestamp_deserialize(const char *value, dual_timestamp *t);
384 char *fstab_node_to_udev_node(const char *p);
386 void filter_environ(const char *prefix);
388 bool tty_is_vc(const char *tty);
389 const char *default_term_for_tty(const char *tty);
391 int detect_vm(const char **id);
392 int detect_container(const char **id);
393 int detect_virtualization(const char **id);
395 void execute_directory(const char *directory, DIR *_d, char *argv[]);
397 int kill_and_sigcont(pid_t pid, int sig);
399 bool nulstr_contains(const char*nulstr, const char *needle);
401 bool plymouth_running(void);
403 void parse_syslog_priority(char **p, int *priority);
405 int have_effective_cap(int value);
407 bool hostname_is_valid(const char *s);
408 char* hostname_cleanup(char *s);
410 char* strshorten(char *s, size_t l);
412 #define NULSTR_FOREACH(i, l) \
413 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
415 #define NULSTR_FOREACH_PAIR(i, j, l) \
416 for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
418 const char *ioprio_class_to_string(int i);
419 int ioprio_class_from_string(const char *s);
421 const char *sigchld_code_to_string(int i);
422 int sigchld_code_from_string(const char *s);
424 const char *log_facility_unshifted_to_string(int i);
425 int log_facility_unshifted_from_string(const char *s);
427 const char *log_level_to_string(int i);
428 int log_level_from_string(const char *s);
430 const char *sched_policy_to_string(int i);
431 int sched_policy_from_string(const char *s);
433 const char *rlimit_to_string(int i);
434 int rlimit_from_string(const char *s);
436 const char *ip_tos_to_string(int i);
437 int ip_tos_from_string(const char *s);
439 const char *signal_to_string(int i);
440 int signal_from_string(const char *s);
442 int signal_from_string_try_harder(const char *s);