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/>.
35 #include <sys/types.h>
38 #include <sys/resource.h>
43 #include "time-util.h"
45 union dirent_storage {
47 uint8_t storage[offsetof(struct dirent, d_name) +
48 ((NAME_MAX + 1 + sizeof(long)) & ~(sizeof(long) - 1))];
51 /* What is interpreted as whitespace? */
52 #define WHITESPACE " \t\n\r"
53 #define NEWLINE "\n\r"
57 #define FORMAT_BYTES_MAX 8
59 #define ANSI_HIGHLIGHT_ON "\x1B[1;39m"
60 #define ANSI_RED_ON "\x1B[31m"
61 #define ANSI_HIGHLIGHT_RED_ON "\x1B[1;31m"
62 #define ANSI_GREEN_ON "\x1B[32m"
63 #define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
64 #define ANSI_HIGHLIGHT_YELLOW_ON "\x1B[1;33m"
65 #define ANSI_HIGHLIGHT_OFF "\x1B[0m"
66 #define ANSI_ERASE_TO_END_OF_LINE "\x1B[K"
68 size_t page_size(void);
69 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
71 #define streq(a,b) (strcmp((a),(b)) == 0)
72 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
73 #define strcaseeq(a,b) (strcasecmp((a),(b)) == 0)
74 #define strncaseeq(a, b, n) (strncasecmp((a), (b), (n)) == 0)
76 bool streq_ptr(const char *a, const char *b);
78 #define new(t, n) ((t*) malloc_multiply(sizeof(t), (n)))
80 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
82 #define newa(t, n) ((t*) alloca(sizeof(t)*(n)))
84 #define newdup(t, p, n) ((t*) memdup_multiply(p, sizeof(t), (n)))
86 #define malloc0(n) (calloc((n), 1))
88 static inline const char* yes_no(bool b) {
89 return b ? "yes" : "no";
92 static inline const char* strempty(const char *s) {
96 static inline const char* strnull(const char *s) {
97 return s ? s : "(null)";
100 static inline const char *strna(const char *s) {
101 return s ? s : "n/a";
104 static inline bool isempty(const char *p) {
108 char *endswith(const char *s, const char *postfix);
109 char *startswith(const char *s, const char *prefix);
110 char *startswith_no_case(const char *s, const char *prefix);
112 bool first_word(const char *s, const char *word);
114 int close_nointr(int fd);
115 void close_nointr_nofail(int fd);
116 void close_many(const int fds[], unsigned n_fd);
118 int parse_boolean(const char *v);
119 int parse_bytes(const char *t, off_t *bytes);
120 int parse_pid(const char *s, pid_t* ret_pid);
121 int parse_uid(const char *s, uid_t* ret_uid);
122 #define parse_gid(s, ret_uid) parse_uid(s, ret_uid)
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);
130 int safe_atod(const char *s, double *ret_d);
133 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
134 assert_cc(sizeof(unsigned long) == sizeof(unsigned));
135 return safe_atou(s, (unsigned*) ret_u);
137 static inline int safe_atoli(const char *s, long int *ret_u) {
138 assert_cc(sizeof(long int) == sizeof(int));
139 return safe_atoi(s, (int*) ret_u);
142 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
143 assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
144 return safe_atollu(s, (unsigned long long*) ret_u);
146 static inline int safe_atoli(const char *s, long int *ret_u) {
147 assert_cc(sizeof(long int) == sizeof(long long int));
148 return safe_atolli(s, (long long int*) ret_u);
152 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
153 assert_cc(sizeof(uint32_t) == sizeof(unsigned));
154 return safe_atou(s, (unsigned*) ret_u);
157 static inline int safe_atoi32(const char *s, int32_t *ret_i) {
158 assert_cc(sizeof(int32_t) == sizeof(int));
159 return safe_atoi(s, (int*) ret_i);
162 static inline int safe_atou64(const char *s, uint64_t *ret_u) {
163 assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
164 return safe_atollu(s, (unsigned long long*) ret_u);
167 static inline int safe_atoi64(const char *s, int64_t *ret_i) {
168 assert_cc(sizeof(int64_t) == sizeof(long long int));
169 return safe_atolli(s, (long long int*) ret_i);
172 char *split(const char *c, size_t *l, const char *separator, char **state);
173 char *split_quoted(const char *c, size_t *l, char **state);
175 #define FOREACH_WORD(word, length, s, state) \
176 for ((state) = NULL, (word) = split((s), &(length), WHITESPACE, &(state)); (word); (word) = split((s), &(length), WHITESPACE, &(state)))
178 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state) \
179 for ((state) = NULL, (word) = split((s), &(length), (separator), &(state)); (word); (word) = split((s), &(length), (separator), &(state)))
181 #define FOREACH_WORD_QUOTED(word, length, s, state) \
182 for ((state) = NULL, (word) = split_quoted((s), &(length), &(state)); (word); (word) = split_quoted((s), &(length), &(state)))
184 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
185 int get_starttime_of_pid(pid_t pid, unsigned long long *st);
187 char *strappend(const char *s, const char *suffix);
188 char *strnappend(const char *s, const char *suffix, size_t length);
190 char *replace_env(const char *format, char **env);
191 char **replace_env_argv(char **argv, char **env);
193 int readlink_malloc(const char *p, char **r);
194 int readlink_and_make_absolute(const char *p, char **r);
195 int readlink_and_canonicalize(const char *p, char **r);
197 int reset_all_signal_handlers(void);
199 char *strstrip(char *s);
200 char *delete_chars(char *s, const char *bad);
201 char *truncate_nl(char *s);
203 char *file_in_same_dir(const char *path, const char *filename);
205 int rmdir_parents(const char *path, const char *stop);
207 int get_process_comm(pid_t pid, char **name);
208 int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
209 int get_process_exe(pid_t pid, char **name);
210 int get_process_uid(pid_t pid, uid_t *uid);
211 int get_process_gid(pid_t pid, gid_t *gid);
214 int unhexchar(char c);
216 int unoctchar(char c);
218 int undecchar(char c);
220 char *cescape(const char *s);
221 char *cunescape(const char *s);
222 char *cunescape_length(const char *s, size_t length);
223 char *cunescape_length_with_prefix(const char *s, size_t length, const char *prefix);
225 char *xescape(const char *s, const char *bad);
227 char *bus_path_escape(const char *s);
228 char *bus_path_unescape(const char *s);
230 char *ascii_strlower(char *path);
232 bool dirent_is_file(const struct dirent *de);
233 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix);
235 bool ignore_file(const char *filename);
237 bool chars_intersect(const char *a, const char *b);
239 int make_stdio(int fd);
240 int make_null_stdio(void);
241 int make_console_stdio(void);
243 unsigned long long random_ull(void);
245 /* For basic lookup tables with strictly enumerated entries */
246 #define __DEFINE_STRING_TABLE_LOOKUP(name,type,scope) \
247 scope const char *name##_to_string(type i) { \
248 if (i < 0 || i >= (type) ELEMENTSOF(name##_table)) \
250 return name##_table[i]; \
252 scope type name##_from_string(const char *s) { \
255 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
256 if (name##_table[i] && \
257 streq(name##_table[i], s)) \
261 struct __useless_struct_to_allow_trailing_semicolon__
263 #define DEFINE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,)
264 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,static)
266 /* For string conversions where numbers are also acceptable */
267 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max) \
268 int name##_to_string_alloc(type i, char **str) { \
271 if (i < 0 || i > max) \
273 if (i < (type) ELEMENTSOF(name##_table)) { \
274 s = strdup(name##_table[i]); \
278 r = asprintf(&s, "%u", i); \
285 type name##_from_string(const char *s) { \
289 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
290 if (name##_table[i] && \
291 streq(name##_table[i], s)) \
293 if (safe_atou(s, &u) >= 0 && u <= max) \
297 struct __useless_struct_to_allow_trailing_semicolon__
299 int fd_nonblock(int fd, bool nonblock);
300 int fd_cloexec(int fd, bool cloexec);
302 int close_all_fds(const int except[], unsigned n_except);
304 bool fstype_is_network(const char *fstype);
308 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
309 int ask(char *ret, const char *replies, const char *text, ...);
311 int reset_terminal_fd(int fd, bool switch_to_text);
312 int reset_terminal(const char *name);
314 int open_terminal(const char *name, int mode);
315 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
316 int release_terminal(void);
318 int flush_fd(int fd);
320 int ignore_signals(int sig, ...);
321 int default_signals(int sig, ...);
322 int sigaction_many(const struct sigaction *sa, ...);
324 int close_pipe(int p[]);
325 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
327 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
328 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
330 bool is_device_path(const char *path);
332 int dir_is_empty(const char *path);
333 char* dirname_malloc(const char *path);
335 void rename_process(const char name[8]);
337 void sigset_add_many(sigset_t *ss, ...);
339 bool hostname_is_set(void);
341 char* gethostname_malloc(void);
342 char* getlogname_malloc(void);
343 char* getusername_malloc(void);
345 int getttyname_malloc(int fd, char **r);
346 int getttyname_harder(int fd, char **r);
348 int get_ctty_devnr(pid_t pid, dev_t *d);
349 int get_ctty(pid_t, dev_t *_devnr, char **r);
351 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
352 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
354 int rm_rf_children(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
355 int rm_rf_children_dangerous(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
356 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
357 int rm_rf_dangerous(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
359 int pipe_eof(int fd);
361 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
363 int status_vprintf(const char *status, bool ellipse, bool ephemeral, const char *format, va_list ap);
364 int status_printf(const char *status, bool ellipse, bool ephemeral, const char *format, ...);
365 int status_welcome(void);
367 int fd_columns(int fd);
368 unsigned columns(void);
369 int fd_lines(int fd);
370 unsigned lines(void);
371 void columns_lines_cache_reset(int _unused_ signum);
375 int running_in_chroot(void);
377 char *ellipsize(const char *s, size_t length, unsigned percent);
378 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
380 int touch(const char *path);
382 char *unquote(const char *s, const char *quotes);
383 char *normalize_env_assignment(const char *s);
385 int wait_for_terminate(pid_t pid, siginfo_t *status);
386 int wait_for_terminate_and_warn(const char *name, pid_t pid);
388 _noreturn_ void freeze(void);
390 bool null_or_empty(struct stat *st);
391 int null_or_empty_path(const char *fn);
393 DIR *xopendirat(int dirfd, const char *name, int flags);
395 char *fstab_node_to_udev_node(const char *p);
397 char *resolve_dev_console(char **active);
398 bool tty_is_vc(const char *tty);
399 bool tty_is_vc_resolve(const char *tty);
400 bool tty_is_console(const char *tty);
401 int vtnr_from_tty(const char *tty);
402 const char *default_term_for_tty(const char *tty);
404 void execute_directory(const char *directory, DIR *_d, char *argv[]);
406 int kill_and_sigcont(pid_t pid, int sig);
408 bool nulstr_contains(const char*nulstr, const char *needle);
410 bool plymouth_running(void);
412 bool hostname_is_valid(const char *s);
413 char* hostname_cleanup(char *s);
415 char* strshorten(char *s, size_t l);
417 int terminal_vhangup_fd(int fd);
418 int terminal_vhangup(const char *name);
420 int vt_disallocate(const char *name);
422 int copy_file(const char *from, const char *to);
424 int symlink_atomic(const char *from, const char *to);
426 int fchmod_umask(int fd, mode_t mode);
428 bool display_is_local(const char *display);
429 int socket_from_display(const char *display, char **path);
431 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
432 int get_group_creds(const char **groupname, gid_t *gid);
434 int in_gid(gid_t gid);
435 int in_group(const char *name);
437 char* uid_to_name(uid_t uid);
438 char* gid_to_name(gid_t gid);
440 int glob_exists(const char *path);
442 int dirent_ensure_type(DIR *d, struct dirent *de);
444 int in_search_path(const char *path, char **search);
445 int get_files_in_directory(const char *path, char ***list);
447 char *strjoin(const char *x, ...) _sentinel_;
449 bool is_main_thread(void);
451 bool in_charset(const char *s, const char* charset);
453 int block_get_whole_disk(dev_t d, dev_t *ret);
455 int file_is_priv_sticky(const char *p);
457 int strdup_or_null(const char *a, char **b);
459 #define NULSTR_FOREACH(i, l) \
460 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
462 #define NULSTR_FOREACH_PAIR(i, j, l) \
463 for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
465 int ioprio_class_to_string_alloc(int i, char **s);
466 int ioprio_class_from_string(const char *s);
468 const char *sigchld_code_to_string(int i);
469 int sigchld_code_from_string(const char *s);
471 int log_facility_unshifted_to_string_alloc(int i, char **s);
472 int log_facility_unshifted_from_string(const char *s);
474 int log_level_to_string_alloc(int i, char **s);
475 int log_level_from_string(const char *s);
477 int sched_policy_to_string_alloc(int i, char **s);
478 int sched_policy_from_string(const char *s);
480 const char *rlimit_to_string(int i);
481 int rlimit_from_string(const char *s);
483 int ip_tos_to_string_alloc(int i, char **s);
484 int ip_tos_from_string(const char *s);
486 const char *signal_to_string(int i);
487 int signal_from_string(const char *s);
489 int signal_from_string_try_harder(const char *s);
491 extern int saved_argc;
492 extern char **saved_argv;
494 bool kexec_loaded(void);
496 int prot_from_flags(int flags);
498 char *format_bytes(char *buf, size_t l, off_t t);
500 int fd_wait_for_event(int fd, int event, usec_t timeout);
502 void* memdup(const void *p, size_t l) _malloc_;
504 int is_kernel_thread(pid_t pid);
506 int fd_inc_sndbuf(int fd, size_t n);
507 int fd_inc_rcvbuf(int fd, size_t n);
509 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
511 int setrlimit_closest(int resource, const struct rlimit *rlim);
513 int getenv_for_pid(pid_t pid, const char *field, char **_value);
515 int can_sleep(const char *type);
516 int can_sleep_disk(const char *type);
518 bool is_valid_documentation_url(const char *url);
520 bool in_initrd(void);
522 void warn_melody(void);
524 int get_home_dir(char **ret);
526 static inline void freep(void *p) {
530 static inline void fclosep(FILE **f) {
535 static inline void pclosep(FILE **f) {
540 static inline void closep(int *fd) {
542 close_nointr_nofail(*fd);
545 static inline void closedirp(DIR **d) {
550 static inline void umaskp(mode_t *u) {
554 #define _cleanup_free_ _cleanup_(freep)
555 #define _cleanup_fclose_ _cleanup_(fclosep)
556 #define _cleanup_pclose_ _cleanup_(pclosep)
557 #define _cleanup_close_ _cleanup_(closep)
558 #define _cleanup_closedir_ _cleanup_(closedirp)
559 #define _cleanup_umask_ _cleanup_(umaskp)
560 #define _cleanup_globfree_ _cleanup_(globfree)
562 _malloc_ static inline void *malloc_multiply(size_t a, size_t b) {
563 if (_unlikely_(b == 0 || a > ((size_t) -1) / b))
566 return malloc(a * b);
569 _malloc_ static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
570 if (_unlikely_(b == 0 || a > ((size_t) -1) / b))
573 return memdup(p, a * b);
576 bool filename_is_safe(const char *p);
577 bool path_is_safe(const char *p);
578 bool string_is_safe(const char *p);
579 bool string_has_cc(const char *p);
581 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
582 int (*compar) (const void *, const void *, void *),
585 bool is_locale_utf8(void);
587 typedef enum DrawSpecialChar {
592 DRAW_TRIANGULAR_BULLET,
593 _DRAW_SPECIAL_CHAR_MAX
595 const char *draw_special_char(DrawSpecialChar ch);
597 char *strreplace(const char *text, const char *old_string, const char *new_string);
599 char *strip_tab_ansi(char **p, size_t *l);
601 int on_ac_power(void);
603 int search_and_fopen(const char *path, const char *mode, const char **search, FILE **_f);
604 int search_and_fopen_nulstr(const char *path, const char *mode, const char *search, FILE **_f);
605 int create_tmp_dir(char template[], char** dir_name);
607 #define FOREACH_LINE(line, f, on_error) \
609 if (!fgets(line, sizeof(line), f)) { \
616 #define FOREACH_DIRENT(de, d, on_error) \
617 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
623 } else if (ignore_file((de)->d_name)) \
627 static inline void *mempset(void *s, int c, size_t n) {
629 return (uint8_t*)s + n;
632 char *hexmem(const void *p, size_t l);
633 void *unhexmem(const char *p, size_t l);
635 char *strextend(char **x, ...);
636 char *strrep(const char *s, unsigned n);
638 void* greedy_realloc(void **p, size_t *allocated, size_t need);
639 #define GREEDY_REALLOC(array, allocated, need) \
640 greedy_realloc((void**) &(array), &(allocated), sizeof((array)[0]) * (need))
642 static inline void _reset_errno_(int *saved_errno) {
643 errno = *saved_errno;
646 #define PROTECT_ERRNO __attribute__((cleanup(_reset_errno_))) int _saved_errno_ = errno
648 struct umask_struct {
653 static inline void _reset_umask_(struct umask_struct *s) {
657 #define RUN_WITH_UMASK(mask) \
658 for (__attribute__((cleanup(_reset_umask_))) struct umask_struct _saved_umask_ = { umask(mask), false }; \
659 !_saved_umask_.quit ; \
660 _saved_umask_.quit = true)
662 static inline unsigned u64log2(uint64_t n) {
663 return (n > 1) ? __builtin_clzll(n) ^ 63U : 0;
666 static inline bool logind_running(void) {
667 return access("/run/systemd/seats/", F_OK) >= 0;
670 #define DECIMAL_STR_WIDTH(x) \
672 typeof(x) _x_ = (x); \
679 int unlink_noerrno(const char *path);
685 _new_ = alloca(_len_); \
686 (void *) memset(_new_, 0, _len_); \
689 #define strappenda(a, b) \
691 const char *_a_ = (a), *_b_ = (b); \
696 _c_ = alloca(_x_ + _y_ + 1); \
697 strcpy(stpcpy(_c_, _a_), _b_); \
701 #define procfs_file_alloca(pid, field) \
703 pid_t _pid_ = (pid); \
705 _r_ = alloca(sizeof("/proc/") -1 + DECIMAL_STR_MAX(pid_t) + 1 + sizeof(field)); \
706 sprintf(_r_, "/proc/%lu/" field, (unsigned long) _pid_); \