1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
6 This file is part of systemd.
8 Copyright 2010 Lennart Poettering
10 systemd is free software; you can redistribute it and/or modify it
11 under the terms of the GNU Lesser General Public License as published by
12 the Free Software Foundation; either version 2.1 of the License, or
13 (at your option) any later version.
15 systemd is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
20 You should have received a copy of the GNU Lesser General Public License
21 along with systemd; If not, see <http://www.gnu.org/licenses/>.
34 #include <sys/types.h>
37 #include <sys/resource.h>
42 typedef uint64_t usec_t;
43 typedef uint64_t nsec_t;
45 typedef struct dual_timestamp {
50 union dirent_storage {
52 uint8_t storage[offsetof(struct dirent, d_name) +
53 ((NAME_MAX + 1 + sizeof(long)) & ~(sizeof(long) - 1))];
56 #define MSEC_PER_SEC 1000ULL
57 #define USEC_PER_SEC 1000000ULL
58 #define USEC_PER_MSEC 1000ULL
59 #define NSEC_PER_SEC 1000000000ULL
60 #define NSEC_PER_MSEC 1000000ULL
61 #define NSEC_PER_USEC 1000ULL
63 #define USEC_PER_MINUTE (60ULL*USEC_PER_SEC)
64 #define NSEC_PER_MINUTE (60ULL*NSEC_PER_SEC)
65 #define USEC_PER_HOUR (60ULL*USEC_PER_MINUTE)
66 #define NSEC_PER_HOUR (60ULL*NSEC_PER_MINUTE)
67 #define USEC_PER_DAY (24ULL*USEC_PER_HOUR)
68 #define NSEC_PER_DAY (24ULL*NSEC_PER_HOUR)
69 #define USEC_PER_WEEK (7ULL*USEC_PER_DAY)
70 #define NSEC_PER_WEEK (7ULL*NSEC_PER_DAY)
71 #define USEC_PER_MONTH (2629800ULL*USEC_PER_SEC)
72 #define NSEC_PER_MONTH (2629800ULL*NSEC_PER_SEC)
73 #define USEC_PER_YEAR (31557600ULL*USEC_PER_SEC)
74 #define NSEC_PER_YEAR (31557600ULL*NSEC_PER_SEC)
76 /* What is interpreted as whitespace? */
77 #define WHITESPACE " \t\n\r"
78 #define NEWLINE "\n\r"
80 #define COMMENTS "#;\n"
82 #define FORMAT_TIMESTAMP_MAX (5+11+9+4+1)
83 #define FORMAT_TIMESTAMP_PRETTY_MAX 256
84 #define FORMAT_TIMESPAN_MAX 64
85 #define FORMAT_BYTES_MAX 8
87 #define ANSI_HIGHLIGHT_ON "\x1B[1;39m"
88 #define ANSI_HIGHLIGHT_RED_ON "\x1B[1;31m"
89 #define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
90 #define ANSI_HIGHLIGHT_YELLOW_ON "\x1B[1;33m"
91 #define ANSI_HIGHLIGHT_OFF "\x1B[0m"
93 usec_t now(clockid_t clock);
95 dual_timestamp* dual_timestamp_get(dual_timestamp *ts);
96 dual_timestamp* dual_timestamp_from_realtime(dual_timestamp *ts, usec_t u);
98 #define dual_timestamp_is_set(ts) ((ts)->realtime > 0)
100 usec_t timespec_load(const struct timespec *ts);
101 struct timespec *timespec_store(struct timespec *ts, usec_t u);
103 usec_t timeval_load(const struct timeval *tv);
104 struct timeval *timeval_store(struct timeval *tv, usec_t u);
106 size_t page_size(void);
107 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
109 #define streq(a,b) (strcmp((a),(b)) == 0)
110 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
112 bool streq_ptr(const char *a, const char *b);
114 #define new(t, n) ((t*) malloc_multiply(sizeof(t), (n)))
116 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
118 #define newa(t, n) ((t*) alloca(sizeof(t)*(n)))
120 #define newdup(t, p, n) ((t*) memdup_multiply(p, sizeof(t), (n)))
122 #define malloc0(n) (calloc((n), 1))
124 static inline const char* yes_no(bool b) {
125 return b ? "yes" : "no";
128 static inline const char* strempty(const char *s) {
132 static inline const char* strnull(const char *s) {
133 return s ? s : "(null)";
136 static inline const char *strna(const char *s) {
137 return s ? s : "n/a";
140 static inline bool isempty(const char *p) {
144 char *endswith(const char *s, const char *postfix);
145 char *startswith(const char *s, const char *prefix);
146 char *startswith_no_case(const char *s, const char *prefix);
148 bool first_word(const char *s, const char *word);
150 int close_nointr(int fd);
151 void close_nointr_nofail(int fd);
152 void close_many(const int fds[], unsigned n_fd);
154 int parse_boolean(const char *v);
155 int parse_usec(const char *t, usec_t *usec);
156 int parse_nsec(const char *t, nsec_t *nsec);
157 int parse_bytes(const char *t, off_t *bytes);
158 int parse_pid(const char *s, pid_t* ret_pid);
159 int parse_uid(const char *s, uid_t* ret_uid);
160 #define parse_gid(s, ret_uid) parse_uid(s, ret_uid)
162 int safe_atou(const char *s, unsigned *ret_u);
163 int safe_atoi(const char *s, int *ret_i);
165 int safe_atollu(const char *s, unsigned long long *ret_u);
166 int safe_atolli(const char *s, long long int *ret_i);
169 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
170 assert_cc(sizeof(unsigned long) == sizeof(unsigned));
171 return safe_atou(s, (unsigned*) ret_u);
173 static inline int safe_atoli(const char *s, long int *ret_u) {
174 assert_cc(sizeof(long int) == sizeof(int));
175 return safe_atoi(s, (int*) ret_u);
178 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
179 assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
180 return safe_atollu(s, (unsigned long long*) ret_u);
182 static inline int safe_atoli(const char *s, long int *ret_u) {
183 assert_cc(sizeof(long int) == sizeof(long long int));
184 return safe_atolli(s, (long long int*) ret_u);
188 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
189 assert_cc(sizeof(uint32_t) == sizeof(unsigned));
190 return safe_atou(s, (unsigned*) ret_u);
193 static inline int safe_atoi32(const char *s, int32_t *ret_i) {
194 assert_cc(sizeof(int32_t) == sizeof(int));
195 return safe_atoi(s, (int*) ret_i);
198 static inline int safe_atou64(const char *s, uint64_t *ret_u) {
199 assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
200 return safe_atollu(s, (unsigned long long*) ret_u);
203 static inline int safe_atoi64(const char *s, int64_t *ret_i) {
204 assert_cc(sizeof(int64_t) == sizeof(long long int));
205 return safe_atolli(s, (long long int*) ret_i);
208 char *split(const char *c, size_t *l, const char *separator, char **state);
209 char *split_quoted(const char *c, size_t *l, char **state);
211 #define FOREACH_WORD(word, length, s, state) \
212 for ((state) = NULL, (word) = split((s), &(length), WHITESPACE, &(state)); (word); (word) = split((s), &(length), WHITESPACE, &(state)))
214 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state) \
215 for ((state) = NULL, (word) = split((s), &(length), (separator), &(state)); (word); (word) = split((s), &(length), (separator), &(state)))
217 #define FOREACH_WORD_QUOTED(word, length, s, state) \
218 for ((state) = NULL, (word) = split_quoted((s), &(length), &(state)); (word); (word) = split_quoted((s), &(length), &(state)))
220 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
221 int get_starttime_of_pid(pid_t pid, unsigned long long *st);
223 int write_one_line_file(const char *fn, const char *line);
224 int write_one_line_file_atomic(const char *fn, const char *line);
225 int read_one_line_file(const char *fn, char **line);
226 int read_full_file(const char *fn, char **contents, size_t *size);
228 int parse_env_file(const char *fname, const char *separator, ...) _sentinel_;
229 int load_env_file(const char *fname, char ***l);
230 int write_env_file(const char *fname, char **l);
232 char *strappend(const char *s, const char *suffix);
233 char *strnappend(const char *s, const char *suffix, size_t length);
235 char *replace_env(const char *format, char **env);
236 char **replace_env_argv(char **argv, char **env);
238 int readlink_malloc(const char *p, char **r);
239 int readlink_and_make_absolute(const char *p, char **r);
240 int readlink_and_canonicalize(const char *p, char **r);
242 int reset_all_signal_handlers(void);
244 char *strstrip(char *s);
245 char *delete_chars(char *s, const char *bad);
246 char *truncate_nl(char *s);
248 char *file_in_same_dir(const char *path, const char *filename);
250 int rmdir_parents(const char *path, const char *stop);
252 int get_process_comm(pid_t pid, char **name);
253 int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
254 int get_process_exe(pid_t pid, char **name);
255 int get_process_uid(pid_t pid, uid_t *uid);
256 int get_process_gid(pid_t pid, gid_t *gid);
259 int unhexchar(char c);
261 int unoctchar(char c);
263 int undecchar(char c);
265 char *cescape(const char *s);
266 char *cunescape(const char *s);
267 char *cunescape_length(const char *s, size_t length);
268 char *cunescape_length_with_prefix(const char *s, size_t length, const char *prefix);
270 char *xescape(const char *s, const char *bad);
272 char *bus_path_escape(const char *s);
273 char *bus_path_unescape(const char *s);
275 char *ascii_strlower(char *path);
277 bool dirent_is_file(const struct dirent *de);
278 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix);
280 bool ignore_file(const char *filename);
282 bool chars_intersect(const char *a, const char *b);
284 char *format_timestamp(char *buf, size_t l, usec_t t);
285 char *format_timestamp_pretty(char *buf, size_t l, usec_t t);
286 char *format_timespan(char *buf, size_t l, usec_t t);
288 int make_stdio(int fd);
289 int make_null_stdio(void);
290 int make_console_stdio(void);
292 unsigned long long random_ull(void);
294 /* For basic lookup tables with strictly enumerated entries */
295 #define __DEFINE_STRING_TABLE_LOOKUP(name,type,scope) \
296 scope const char *name##_to_string(type i) { \
297 if (i < 0 || i >= (type) ELEMENTSOF(name##_table)) \
299 return name##_table[i]; \
301 scope type name##_from_string(const char *s) { \
304 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
305 if (name##_table[i] && \
306 streq(name##_table[i], s)) \
310 struct __useless_struct_to_allow_trailing_semicolon__
312 #define DEFINE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,)
313 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,static)
315 /* For string conversions where numbers are also acceptable */
316 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max) \
317 int name##_to_string_alloc(type i, char **str) { \
320 if (i < 0 || i > max) \
322 if (i < (type) ELEMENTSOF(name##_table)) { \
323 s = strdup(name##_table[i]); \
327 r = asprintf(&s, "%u", i); \
334 type name##_from_string(const char *s) { \
338 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
339 if (name##_table[i] && \
340 streq(name##_table[i], s)) \
342 if (safe_atou(s, &u) >= 0 && u <= max) \
346 struct __useless_struct_to_allow_trailing_semicolon__
348 int fd_nonblock(int fd, bool nonblock);
349 int fd_cloexec(int fd, bool cloexec);
351 int close_all_fds(const int except[], unsigned n_except);
353 bool fstype_is_network(const char *fstype);
357 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
358 int ask(char *ret, const char *replies, const char *text, ...);
360 int reset_terminal_fd(int fd, bool switch_to_text);
361 int reset_terminal(const char *name);
363 int open_terminal(const char *name, int mode);
364 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
365 int release_terminal(void);
367 int flush_fd(int fd);
369 int ignore_signals(int sig, ...);
370 int default_signals(int sig, ...);
371 int sigaction_many(const struct sigaction *sa, ...);
373 int close_pipe(int p[]);
374 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
376 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
377 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
379 bool is_device_path(const char *path);
381 int dir_is_empty(const char *path);
383 void rename_process(const char name[8]);
385 void sigset_add_many(sigset_t *ss, ...);
387 bool hostname_is_set(void);
389 char* gethostname_malloc(void);
390 char* getlogname_malloc(void);
391 char* getusername_malloc(void);
393 int getttyname_malloc(int fd, char **r);
394 int getttyname_harder(int fd, char **r);
396 int get_ctty_devnr(pid_t pid, dev_t *d);
397 int get_ctty(pid_t, dev_t *_devnr, char **r);
399 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
400 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
402 int rm_rf_children(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
403 int rm_rf_children_dangerous(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
404 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
405 int rm_rf_dangerous(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
407 int pipe_eof(int fd);
409 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
411 int status_vprintf(const char *status, bool ellipse, const char *format, va_list ap);
412 int status_printf(const char *status, bool ellipse, const char *format, ...);
413 int status_welcome(void);
415 int fd_columns(int fd);
416 unsigned columns(void);
417 int fd_lines(int fd);
418 unsigned lines(void);
419 void columns_lines_cache_reset(int _unused_ signum);
423 int running_in_chroot(void);
425 char *ellipsize(const char *s, size_t length, unsigned percent);
426 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
428 int touch(const char *path);
430 char *unquote(const char *s, const char *quotes);
431 char *normalize_env_assignment(const char *s);
433 int wait_for_terminate(pid_t pid, siginfo_t *status);
434 int wait_for_terminate_and_warn(const char *name, pid_t pid);
436 _noreturn_ void freeze(void);
438 bool null_or_empty(struct stat *st);
439 int null_or_empty_path(const char *fn);
441 DIR *xopendirat(int dirfd, const char *name, int flags);
443 void dual_timestamp_serialize(FILE *f, const char *name, dual_timestamp *t);
444 void dual_timestamp_deserialize(const char *value, dual_timestamp *t);
446 char *fstab_node_to_udev_node(const char *p);
448 bool tty_is_vc(const char *tty);
449 bool tty_is_vc_resolve(const char *tty);
450 bool tty_is_console(const char *tty);
451 int vtnr_from_tty(const char *tty);
452 const char *default_term_for_tty(const char *tty);
454 void execute_directory(const char *directory, DIR *_d, char *argv[]);
456 int kill_and_sigcont(pid_t pid, int sig);
458 bool nulstr_contains(const char*nulstr, const char *needle);
460 bool plymouth_running(void);
462 bool hostname_is_valid(const char *s);
463 char* hostname_cleanup(char *s);
465 char* strshorten(char *s, size_t l);
467 int terminal_vhangup_fd(int fd);
468 int terminal_vhangup(const char *name);
470 int vt_disallocate(const char *name);
472 int copy_file(const char *from, const char *to);
474 int symlink_atomic(const char *from, const char *to);
476 int fchmod_umask(int fd, mode_t mode);
478 bool display_is_local(const char *display);
479 int socket_from_display(const char *display, char **path);
481 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
482 int get_group_creds(const char **groupname, gid_t *gid);
484 int in_group(const char *name);
486 int glob_exists(const char *path);
488 int dirent_ensure_type(DIR *d, struct dirent *de);
490 int in_search_path(const char *path, char **search);
491 int get_files_in_directory(const char *path, char ***list);
493 char *strjoin(const char *x, ...) _sentinel_;
495 bool is_main_thread(void);
497 bool in_charset(const char *s, const char* charset);
499 int block_get_whole_disk(dev_t d, dev_t *ret);
501 int file_is_priv_sticky(const char *p);
503 int strdup_or_null(const char *a, char **b);
505 #define NULSTR_FOREACH(i, l) \
506 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
508 #define NULSTR_FOREACH_PAIR(i, j, l) \
509 for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
511 int ioprio_class_to_string_alloc(int i, char **s);
512 int ioprio_class_from_string(const char *s);
514 const char *sigchld_code_to_string(int i);
515 int sigchld_code_from_string(const char *s);
517 int log_facility_unshifted_to_string_alloc(int i, char **s);
518 int log_facility_unshifted_from_string(const char *s);
520 int log_level_to_string_alloc(int i, char **s);
521 int log_level_from_string(const char *s);
523 int sched_policy_to_string_alloc(int i, char **s);
524 int sched_policy_from_string(const char *s);
526 const char *rlimit_to_string(int i);
527 int rlimit_from_string(const char *s);
529 int ip_tos_to_string_alloc(int i, char **s);
530 int ip_tos_from_string(const char *s);
532 const char *signal_to_string(int i);
533 int signal_from_string(const char *s);
535 int signal_from_string_try_harder(const char *s);
537 extern int saved_argc;
538 extern char **saved_argv;
540 bool kexec_loaded(void);
542 int prot_from_flags(int flags);
544 char *format_bytes(char *buf, size_t l, off_t t);
546 int fd_wait_for_event(int fd, int event, usec_t timeout);
548 void* memdup(const void *p, size_t l) _malloc_;
550 int is_kernel_thread(pid_t pid);
552 int fd_inc_sndbuf(int fd, size_t n);
553 int fd_inc_rcvbuf(int fd, size_t n);
555 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
557 int setrlimit_closest(int resource, const struct rlimit *rlim);
559 int getenv_for_pid(pid_t pid, const char *field, char **_value);
561 int can_sleep(const char *type);
562 int can_sleep_disk(const char *type);
564 bool is_valid_documentation_url(const char *url);
566 bool in_initrd(void);
568 void warn_melody(void);
570 int get_shell(char **ret);
571 int get_home_dir(char **ret);
574 void fclosep(FILE **f);
575 void closep(int *fd);
576 void closedirp(DIR **d);
577 void umaskp(mode_t *u);
579 _malloc_ static inline void *malloc_multiply(size_t a, size_t b) {
580 if (_unlikely_(b == 0 || a > ((size_t) -1) / b))
583 return malloc(a * b);
586 _malloc_ static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
587 if (_unlikely_(b == 0 || a > ((size_t) -1) / b))
590 return memdup(p, a * b);
593 bool filename_is_safe(const char *p);
594 bool string_is_safe(const char *p);
596 int parse_timestamp(const char *t, usec_t *usec);
598 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
599 int (*compar) (const void *, const void *, void *),
602 bool is_locale_utf8(void);
604 typedef enum DrawSpecialChar {
606 DRAW_BOX_VERT_AND_RIGHT,
607 DRAW_BOX_UP_AND_RIGHT,
608 DRAW_TRIANGULAR_BULLET,
609 _DRAW_SPECIAL_CHAR_MAX
611 const char *draw_special_char(DrawSpecialChar ch);