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 #include "time-util.h"
44 union dirent_storage {
46 uint8_t storage[offsetof(struct dirent, d_name) +
47 ((NAME_MAX + 1 + sizeof(long)) & ~(sizeof(long) - 1))];
50 /* What is interpreted as whitespace? */
51 #define WHITESPACE " \t\n\r"
52 #define NEWLINE "\n\r"
56 #define FORMAT_BYTES_MAX 8
58 #define ANSI_HIGHLIGHT_ON "\x1B[1;39m"
59 #define ANSI_RED_ON "\x1B[31m"
60 #define ANSI_HIGHLIGHT_RED_ON "\x1B[1;31m"
61 #define ANSI_GREEN_ON "\x1B[32m"
62 #define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
63 #define ANSI_HIGHLIGHT_YELLOW_ON "\x1B[1;33m"
64 #define ANSI_HIGHLIGHT_OFF "\x1B[0m"
65 #define ANSI_ERASE_TO_END_OF_LINE "\x1B[K"
67 size_t page_size(void);
68 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
70 #define streq(a,b) (strcmp((a),(b)) == 0)
71 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
72 #define strcaseeq(a,b) (strcasecmp((a),(b)) == 0)
73 #define strncaseeq(a, b, n) (strncasecmp((a), (b), (n)) == 0)
75 bool streq_ptr(const char *a, const char *b);
77 #define new(t, n) ((t*) malloc_multiply(sizeof(t), (n)))
79 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
81 #define newa(t, n) ((t*) alloca(sizeof(t)*(n)))
83 #define newdup(t, p, n) ((t*) memdup_multiply(p, sizeof(t), (n)))
85 #define malloc0(n) (calloc((n), 1))
87 static inline const char* yes_no(bool b) {
88 return b ? "yes" : "no";
91 static inline const char* strempty(const char *s) {
95 static inline const char* strnull(const char *s) {
96 return s ? s : "(null)";
99 static inline const char *strna(const char *s) {
100 return s ? s : "n/a";
103 static inline bool isempty(const char *p) {
107 char *endswith(const char *s, const char *postfix);
108 char *startswith(const char *s, const char *prefix);
109 char *startswith_no_case(const char *s, const char *prefix);
111 bool first_word(const char *s, const char *word);
113 int close_nointr(int fd);
114 void close_nointr_nofail(int fd);
115 void close_many(const int fds[], unsigned n_fd);
117 int parse_boolean(const char *v);
118 int parse_bytes(const char *t, off_t *bytes);
119 int parse_pid(const char *s, pid_t* ret_pid);
120 int parse_uid(const char *s, uid_t* ret_uid);
121 #define parse_gid(s, ret_uid) parse_uid(s, ret_uid)
123 int safe_atou(const char *s, unsigned *ret_u);
124 int safe_atoi(const char *s, int *ret_i);
126 int safe_atollu(const char *s, unsigned long long *ret_u);
127 int safe_atolli(const char *s, long long int *ret_i);
129 int safe_atod(const char *s, double *ret_d);
132 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
133 assert_cc(sizeof(unsigned long) == sizeof(unsigned));
134 return safe_atou(s, (unsigned*) ret_u);
136 static inline int safe_atoli(const char *s, long int *ret_u) {
137 assert_cc(sizeof(long int) == sizeof(int));
138 return safe_atoi(s, (int*) ret_u);
141 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
142 assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
143 return safe_atollu(s, (unsigned long long*) ret_u);
145 static inline int safe_atoli(const char *s, long int *ret_u) {
146 assert_cc(sizeof(long int) == sizeof(long long int));
147 return safe_atolli(s, (long long int*) ret_u);
151 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
152 assert_cc(sizeof(uint32_t) == sizeof(unsigned));
153 return safe_atou(s, (unsigned*) ret_u);
156 static inline int safe_atoi32(const char *s, int32_t *ret_i) {
157 assert_cc(sizeof(int32_t) == sizeof(int));
158 return safe_atoi(s, (int*) ret_i);
161 static inline int safe_atou64(const char *s, uint64_t *ret_u) {
162 assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
163 return safe_atollu(s, (unsigned long long*) ret_u);
166 static inline int safe_atoi64(const char *s, int64_t *ret_i) {
167 assert_cc(sizeof(int64_t) == sizeof(long long int));
168 return safe_atolli(s, (long long int*) ret_i);
171 char *split(const char *c, size_t *l, const char *separator, char **state);
172 char *split_quoted(const char *c, size_t *l, char **state);
174 #define FOREACH_WORD(word, length, s, state) \
175 for ((state) = NULL, (word) = split((s), &(length), WHITESPACE, &(state)); (word); (word) = split((s), &(length), WHITESPACE, &(state)))
177 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state) \
178 for ((state) = NULL, (word) = split((s), &(length), (separator), &(state)); (word); (word) = split((s), &(length), (separator), &(state)))
180 #define FOREACH_WORD_QUOTED(word, length, s, state) \
181 for ((state) = NULL, (word) = split_quoted((s), &(length), &(state)); (word); (word) = split_quoted((s), &(length), &(state)))
183 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
184 int get_starttime_of_pid(pid_t pid, unsigned long long *st);
186 char *strappend(const char *s, const char *suffix);
187 char *strnappend(const char *s, const char *suffix, size_t length);
189 char *replace_env(const char *format, char **env);
190 char **replace_env_argv(char **argv, char **env);
192 int readlink_malloc(const char *p, char **r);
193 int readlink_and_make_absolute(const char *p, char **r);
194 int readlink_and_canonicalize(const char *p, char **r);
196 int reset_all_signal_handlers(void);
198 char *strstrip(char *s);
199 char *delete_chars(char *s, const char *bad);
200 char *truncate_nl(char *s);
202 char *file_in_same_dir(const char *path, const char *filename);
204 int rmdir_parents(const char *path, const char *stop);
206 int get_process_comm(pid_t pid, char **name);
207 int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
208 int get_process_exe(pid_t pid, char **name);
209 int get_process_uid(pid_t pid, uid_t *uid);
210 int get_process_gid(pid_t pid, gid_t *gid);
213 int unhexchar(char c);
215 int unoctchar(char c);
217 int undecchar(char c);
219 char *cescape(const char *s);
220 char *cunescape(const char *s);
221 char *cunescape_length(const char *s, size_t length);
222 char *cunescape_length_with_prefix(const char *s, size_t length, const char *prefix);
224 char *xescape(const char *s, const char *bad);
226 char *bus_path_escape(const char *s);
227 char *bus_path_unescape(const char *s);
229 char *ascii_strlower(char *path);
231 bool dirent_is_file(const struct dirent *de);
232 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix);
234 bool ignore_file(const char *filename);
236 bool chars_intersect(const char *a, const char *b);
238 int make_stdio(int fd);
239 int make_null_stdio(void);
240 int make_console_stdio(void);
242 unsigned long long random_ull(void);
244 /* For basic lookup tables with strictly enumerated entries */
245 #define __DEFINE_STRING_TABLE_LOOKUP(name,type,scope) \
246 scope const char *name##_to_string(type i) { \
247 if (i < 0 || i >= (type) ELEMENTSOF(name##_table)) \
249 return name##_table[i]; \
251 scope type name##_from_string(const char *s) { \
254 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
255 if (name##_table[i] && \
256 streq(name##_table[i], s)) \
260 struct __useless_struct_to_allow_trailing_semicolon__
262 #define DEFINE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,)
263 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,static)
265 /* For string conversions where numbers are also acceptable */
266 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max) \
267 int name##_to_string_alloc(type i, char **str) { \
270 if (i < 0 || i > max) \
272 if (i < (type) ELEMENTSOF(name##_table)) { \
273 s = strdup(name##_table[i]); \
277 r = asprintf(&s, "%u", i); \
284 type name##_from_string(const char *s) { \
288 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
289 if (name##_table[i] && \
290 streq(name##_table[i], s)) \
292 if (safe_atou(s, &u) >= 0 && u <= max) \
296 struct __useless_struct_to_allow_trailing_semicolon__
298 int fd_nonblock(int fd, bool nonblock);
299 int fd_cloexec(int fd, bool cloexec);
301 int close_all_fds(const int except[], unsigned n_except);
303 bool fstype_is_network(const char *fstype);
307 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
308 int ask(char *ret, const char *replies, const char *text, ...);
310 int reset_terminal_fd(int fd, bool switch_to_text);
311 int reset_terminal(const char *name);
313 int open_terminal(const char *name, int mode);
314 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
315 int release_terminal(void);
317 int flush_fd(int fd);
319 int ignore_signals(int sig, ...);
320 int default_signals(int sig, ...);
321 int sigaction_many(const struct sigaction *sa, ...);
323 int close_pipe(int p[]);
324 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
326 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
327 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
329 bool is_device_path(const char *path);
331 int dir_is_empty(const char *path);
332 char* dirname_malloc(const char *path);
334 void rename_process(const char name[8]);
336 void sigset_add_many(sigset_t *ss, ...);
338 bool hostname_is_set(void);
340 char* gethostname_malloc(void);
341 char* getlogname_malloc(void);
342 char* getusername_malloc(void);
344 int getttyname_malloc(int fd, char **r);
345 int getttyname_harder(int fd, char **r);
347 int get_ctty_devnr(pid_t pid, dev_t *d);
348 int get_ctty(pid_t, dev_t *_devnr, char **r);
350 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
351 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
353 int rm_rf_children(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
354 int rm_rf_children_dangerous(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
355 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
356 int rm_rf_dangerous(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
358 int pipe_eof(int fd);
360 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
362 int status_vprintf(const char *status, bool ellipse, bool ephemeral, const char *format, va_list ap);
363 int status_printf(const char *status, bool ellipse, bool ephemeral, const char *format, ...);
364 int status_welcome(void);
366 int fd_columns(int fd);
367 unsigned columns(void);
368 int fd_lines(int fd);
369 unsigned lines(void);
370 void columns_lines_cache_reset(int _unused_ signum);
374 int running_in_chroot(void);
376 char *ellipsize(const char *s, size_t length, unsigned percent);
377 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
379 int touch(const char *path);
381 char *unquote(const char *s, const char *quotes);
382 char *normalize_env_assignment(const char *s);
384 int wait_for_terminate(pid_t pid, siginfo_t *status);
385 int wait_for_terminate_and_warn(const char *name, pid_t pid);
387 _noreturn_ void freeze(void);
389 bool null_or_empty(struct stat *st);
390 int null_or_empty_path(const char *fn);
392 DIR *xopendirat(int dirfd, const char *name, int flags);
394 char *fstab_node_to_udev_node(const char *p);
396 char *resolve_dev_console(char **active);
397 bool tty_is_vc(const char *tty);
398 bool tty_is_vc_resolve(const char *tty);
399 bool tty_is_console(const char *tty);
400 int vtnr_from_tty(const char *tty);
401 const char *default_term_for_tty(const char *tty);
403 void execute_directory(const char *directory, DIR *_d, char *argv[]);
405 int kill_and_sigcont(pid_t pid, int sig);
407 bool nulstr_contains(const char*nulstr, const char *needle);
409 bool plymouth_running(void);
411 bool hostname_is_valid(const char *s);
412 char* hostname_cleanup(char *s);
414 char* strshorten(char *s, size_t l);
416 int terminal_vhangup_fd(int fd);
417 int terminal_vhangup(const char *name);
419 int vt_disallocate(const char *name);
421 int copy_file(const char *from, const char *to);
423 int symlink_atomic(const char *from, const char *to);
425 int fchmod_umask(int fd, mode_t mode);
427 bool display_is_local(const char *display);
428 int socket_from_display(const char *display, char **path);
430 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
431 int get_group_creds(const char **groupname, gid_t *gid);
433 int in_gid(gid_t gid);
434 int in_group(const char *name);
436 char* uid_to_name(uid_t uid);
437 char* gid_to_name(gid_t gid);
439 int glob_exists(const char *path);
441 int dirent_ensure_type(DIR *d, struct dirent *de);
443 int in_search_path(const char *path, char **search);
444 int get_files_in_directory(const char *path, char ***list);
446 char *strjoin(const char *x, ...) _sentinel_;
448 bool is_main_thread(void);
450 bool in_charset(const char *s, const char* charset);
452 int block_get_whole_disk(dev_t d, dev_t *ret);
454 int file_is_priv_sticky(const char *p);
456 int strdup_or_null(const char *a, char **b);
458 #define NULSTR_FOREACH(i, l) \
459 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
461 #define NULSTR_FOREACH_PAIR(i, j, l) \
462 for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
464 int ioprio_class_to_string_alloc(int i, char **s);
465 int ioprio_class_from_string(const char *s);
467 const char *sigchld_code_to_string(int i);
468 int sigchld_code_from_string(const char *s);
470 int log_facility_unshifted_to_string_alloc(int i, char **s);
471 int log_facility_unshifted_from_string(const char *s);
473 int log_level_to_string_alloc(int i, char **s);
474 int log_level_from_string(const char *s);
476 int sched_policy_to_string_alloc(int i, char **s);
477 int sched_policy_from_string(const char *s);
479 const char *rlimit_to_string(int i);
480 int rlimit_from_string(const char *s);
482 int ip_tos_to_string_alloc(int i, char **s);
483 int ip_tos_from_string(const char *s);
485 const char *signal_to_string(int i);
486 int signal_from_string(const char *s);
488 int signal_from_string_try_harder(const char *s);
490 extern int saved_argc;
491 extern char **saved_argv;
493 bool kexec_loaded(void);
495 int prot_from_flags(int flags);
497 char *format_bytes(char *buf, size_t l, off_t t);
499 int fd_wait_for_event(int fd, int event, usec_t timeout);
501 void* memdup(const void *p, size_t l) _malloc_;
503 int is_kernel_thread(pid_t pid);
505 int fd_inc_sndbuf(int fd, size_t n);
506 int fd_inc_rcvbuf(int fd, size_t n);
508 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
510 int setrlimit_closest(int resource, const struct rlimit *rlim);
512 int getenv_for_pid(pid_t pid, const char *field, char **_value);
514 int can_sleep(const char *type);
515 int can_sleep_disk(const char *type);
517 bool is_valid_documentation_url(const char *url);
519 bool in_initrd(void);
521 void warn_melody(void);
523 int get_home_dir(char **ret);
525 static inline void freep(void *p) {
529 static inline void fclosep(FILE **f) {
534 static inline void pclosep(FILE **f) {
539 static inline void closep(int *fd) {
541 close_nointr_nofail(*fd);
544 static inline void closedirp(DIR **d) {
549 static inline void umaskp(mode_t *u) {
553 #define _cleanup_free_ _cleanup_(freep)
554 #define _cleanup_fclose_ _cleanup_(fclosep)
555 #define _cleanup_pclose_ _cleanup_(pclosep)
556 #define _cleanup_close_ _cleanup_(closep)
557 #define _cleanup_closedir_ _cleanup_(closedirp)
558 #define _cleanup_umask_ _cleanup_(umaskp)
559 #define _cleanup_globfree_ _cleanup_(globfree)
561 _malloc_ static inline void *malloc_multiply(size_t a, size_t b) {
562 if (_unlikely_(b == 0 || a > ((size_t) -1) / b))
565 return malloc(a * b);
568 _malloc_ static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
569 if (_unlikely_(b == 0 || a > ((size_t) -1) / b))
572 return memdup(p, a * b);
575 bool filename_is_safe(const char *p);
576 bool path_is_safe(const char *p);
577 bool string_is_safe(const char *p);
578 bool string_has_cc(const char *p);
580 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
581 int (*compar) (const void *, const void *, void *),
584 bool is_locale_utf8(void);
586 typedef enum DrawSpecialChar {
591 DRAW_TRIANGULAR_BULLET,
592 _DRAW_SPECIAL_CHAR_MAX
594 const char *draw_special_char(DrawSpecialChar ch);
596 char *strreplace(const char *text, const char *old_string, const char *new_string);
598 char *strip_tab_ansi(char **p, size_t *l);
600 int on_ac_power(void);
602 int search_and_fopen(const char *path, const char *mode, const char **search, FILE **_f);
603 int search_and_fopen_nulstr(const char *path, const char *mode, const char *search, FILE **_f);
604 int create_tmp_dir(char template[], char** dir_name);
606 #define FOREACH_LINE(line, f, on_error) \
608 if (!fgets(line, sizeof(line), f)) { \
615 #define FOREACH_DIRENT(de, d, on_error) \
616 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
622 } else if (ignore_file((de)->d_name)) \
626 static inline void *mempset(void *s, int c, size_t n) {
628 return (uint8_t*)s + n;
631 char *hexmem(const void *p, size_t l);
632 void *unhexmem(const char *p, size_t l);
634 char *strextend(char **x, ...);
635 char *strrep(const char *s, unsigned n);
637 void* greedy_realloc(void **p, size_t *allocated, size_t need);
638 #define GREEDY_REALLOC(array, allocated, need) \
639 greedy_realloc((void**) &(array), &(allocated), sizeof((array)[0]) * (need))
641 static inline void _reset_errno_(int *saved_errno) {
642 errno = *saved_errno;
645 #define PROTECT_ERRNO __attribute__((cleanup(_reset_errno_))) int _saved_errno_ = errno
647 struct umask_struct {
652 static inline void _reset_umask_(struct umask_struct *s) {
656 #define RUN_WITH_UMASK(mask) \
657 for (__attribute__((cleanup(_reset_umask_))) struct umask_struct _saved_umask_ = { umask(mask), false }; \
658 !_saved_umask_.quit ; \
659 _saved_umask_.quit = true)
661 static inline unsigned u64log2(uint64_t n) {
662 return (n > 1) ? __builtin_clzll(n) ^ 63U : 0;
665 static inline bool logind_running(void) {
666 return access("/run/systemd/seats/", F_OK) >= 0;
669 #define DECIMAL_STR_WIDTH(x) \
671 typeof(x) _x_ = (x); \
678 int unlink_noerrno(const char *path);
684 _new_ = alloca(_len_); \
685 (void *) memset(_new_, 0, _len_); \