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>
41 #include "time-util.h"
43 union dirent_storage {
45 uint8_t storage[offsetof(struct dirent, d_name) +
46 ((NAME_MAX + 1 + sizeof(long)) & ~(sizeof(long) - 1))];
49 /* What is interpreted as whitespace? */
50 #define WHITESPACE " \t\n\r"
51 #define NEWLINE "\n\r"
53 #define COMMENTS "#;\n"
55 #define FORMAT_BYTES_MAX 8
57 #define ANSI_HIGHLIGHT_ON "\x1B[1;39m"
58 #define ANSI_HIGHLIGHT_RED_ON "\x1B[1;31m"
59 #define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
60 #define ANSI_HIGHLIGHT_YELLOW_ON "\x1B[1;33m"
61 #define ANSI_HIGHLIGHT_OFF "\x1B[0m"
63 size_t page_size(void);
64 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
66 #define streq(a,b) (strcmp((a),(b)) == 0)
67 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
68 #define strcaseeq(a,b) (strcasecmp((a),(b)) == 0)
69 #define strncaseeq(a, b, n) (strncasecmp((a), (b), (n)) == 0)
71 bool streq_ptr(const char *a, const char *b);
73 #define new(t, n) ((t*) malloc_multiply(sizeof(t), (n)))
75 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
77 #define newa(t, n) ((t*) alloca(sizeof(t)*(n)))
79 #define newdup(t, p, n) ((t*) memdup_multiply(p, sizeof(t), (n)))
81 #define malloc0(n) (calloc((n), 1))
83 static inline const char* yes_no(bool b) {
84 return b ? "yes" : "no";
87 static inline const char* strempty(const char *s) {
91 static inline const char* strnull(const char *s) {
92 return s ? s : "(null)";
95 static inline const char *strna(const char *s) {
99 static inline bool isempty(const char *p) {
103 char *endswith(const char *s, const char *postfix);
104 char *startswith(const char *s, const char *prefix);
105 char *startswith_no_case(const char *s, const char *prefix);
107 bool first_word(const char *s, const char *word);
109 int close_nointr(int fd);
110 void close_nointr_nofail(int fd);
111 void close_many(const int fds[], unsigned n_fd);
113 int parse_boolean(const char *v);
114 int parse_bytes(const char *t, off_t *bytes);
115 int parse_pid(const char *s, pid_t* ret_pid);
116 int parse_uid(const char *s, uid_t* ret_uid);
117 #define parse_gid(s, ret_uid) parse_uid(s, ret_uid)
119 int safe_atou(const char *s, unsigned *ret_u);
120 int safe_atoi(const char *s, int *ret_i);
122 int safe_atollu(const char *s, unsigned long long *ret_u);
123 int safe_atolli(const char *s, long long int *ret_i);
125 int safe_atod(const char *s, double *ret_d);
128 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
129 assert_cc(sizeof(unsigned long) == sizeof(unsigned));
130 return safe_atou(s, (unsigned*) ret_u);
132 static inline int safe_atoli(const char *s, long int *ret_u) {
133 assert_cc(sizeof(long int) == sizeof(int));
134 return safe_atoi(s, (int*) ret_u);
137 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
138 assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
139 return safe_atollu(s, (unsigned long long*) ret_u);
141 static inline int safe_atoli(const char *s, long int *ret_u) {
142 assert_cc(sizeof(long int) == sizeof(long long int));
143 return safe_atolli(s, (long long int*) ret_u);
147 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
148 assert_cc(sizeof(uint32_t) == sizeof(unsigned));
149 return safe_atou(s, (unsigned*) ret_u);
152 static inline int safe_atoi32(const char *s, int32_t *ret_i) {
153 assert_cc(sizeof(int32_t) == sizeof(int));
154 return safe_atoi(s, (int*) ret_i);
157 static inline int safe_atou64(const char *s, uint64_t *ret_u) {
158 assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
159 return safe_atollu(s, (unsigned long long*) ret_u);
162 static inline int safe_atoi64(const char *s, int64_t *ret_i) {
163 assert_cc(sizeof(int64_t) == sizeof(long long int));
164 return safe_atolli(s, (long long int*) ret_i);
167 char *split(const char *c, size_t *l, const char *separator, char **state);
168 char *split_quoted(const char *c, size_t *l, char **state);
170 #define FOREACH_WORD(word, length, s, state) \
171 for ((state) = NULL, (word) = split((s), &(length), WHITESPACE, &(state)); (word); (word) = split((s), &(length), WHITESPACE, &(state)))
173 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state) \
174 for ((state) = NULL, (word) = split((s), &(length), (separator), &(state)); (word); (word) = split((s), &(length), (separator), &(state)))
176 #define FOREACH_WORD_QUOTED(word, length, s, state) \
177 for ((state) = NULL, (word) = split_quoted((s), &(length), &(state)); (word); (word) = split_quoted((s), &(length), &(state)))
179 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
180 int get_starttime_of_pid(pid_t pid, unsigned long long *st);
182 char *strappend(const char *s, const char *suffix);
183 char *strnappend(const char *s, const char *suffix, size_t length);
185 char *replace_env(const char *format, char **env);
186 char **replace_env_argv(char **argv, char **env);
188 int readlink_malloc(const char *p, char **r);
189 int readlink_and_make_absolute(const char *p, char **r);
190 int readlink_and_canonicalize(const char *p, char **r);
192 int reset_all_signal_handlers(void);
194 char *strstrip(char *s);
195 char *delete_chars(char *s, const char *bad);
196 char *truncate_nl(char *s);
198 char *file_in_same_dir(const char *path, const char *filename);
200 int rmdir_parents(const char *path, const char *stop);
202 int get_process_comm(pid_t pid, char **name);
203 int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
204 int get_process_exe(pid_t pid, char **name);
205 int get_process_uid(pid_t pid, uid_t *uid);
206 int get_process_gid(pid_t pid, gid_t *gid);
209 int unhexchar(char c);
211 int unoctchar(char c);
213 int undecchar(char c);
215 char *cescape(const char *s);
216 char *cunescape(const char *s);
217 char *cunescape_length(const char *s, size_t length);
218 char *cunescape_length_with_prefix(const char *s, size_t length, const char *prefix);
220 char *xescape(const char *s, const char *bad);
222 char *bus_path_escape(const char *s);
223 char *bus_path_unescape(const char *s);
225 char *ascii_strlower(char *path);
227 bool dirent_is_file(const struct dirent *de);
228 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix);
230 bool ignore_file(const char *filename);
232 bool chars_intersect(const char *a, const char *b);
234 int make_stdio(int fd);
235 int make_null_stdio(void);
236 int make_console_stdio(void);
238 unsigned long long random_ull(void);
240 /* For basic lookup tables with strictly enumerated entries */
241 #define __DEFINE_STRING_TABLE_LOOKUP(name,type,scope) \
242 scope const char *name##_to_string(type i) { \
243 if (i < 0 || i >= (type) ELEMENTSOF(name##_table)) \
245 return name##_table[i]; \
247 scope type name##_from_string(const char *s) { \
250 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
251 if (name##_table[i] && \
252 streq(name##_table[i], s)) \
256 struct __useless_struct_to_allow_trailing_semicolon__
258 #define DEFINE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,)
259 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,static)
261 /* For string conversions where numbers are also acceptable */
262 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max) \
263 int name##_to_string_alloc(type i, char **str) { \
266 if (i < 0 || i > max) \
268 if (i < (type) ELEMENTSOF(name##_table)) { \
269 s = strdup(name##_table[i]); \
273 r = asprintf(&s, "%u", i); \
280 type name##_from_string(const char *s) { \
284 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
285 if (name##_table[i] && \
286 streq(name##_table[i], s)) \
288 if (safe_atou(s, &u) >= 0 && u <= max) \
292 struct __useless_struct_to_allow_trailing_semicolon__
294 int fd_nonblock(int fd, bool nonblock);
295 int fd_cloexec(int fd, bool cloexec);
297 int close_all_fds(const int except[], unsigned n_except);
299 bool fstype_is_network(const char *fstype);
303 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
304 int ask(char *ret, const char *replies, const char *text, ...);
306 int reset_terminal_fd(int fd, bool switch_to_text);
307 int reset_terminal(const char *name);
309 int open_terminal(const char *name, int mode);
310 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
311 int release_terminal(void);
313 int flush_fd(int fd);
315 int ignore_signals(int sig, ...);
316 int default_signals(int sig, ...);
317 int sigaction_many(const struct sigaction *sa, ...);
319 int close_pipe(int p[]);
320 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
322 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
323 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
325 bool is_device_path(const char *path);
327 int dir_is_empty(const char *path);
329 void rename_process(const char name[8]);
331 void sigset_add_many(sigset_t *ss, ...);
333 bool hostname_is_set(void);
335 char* gethostname_malloc(void);
336 char* getlogname_malloc(void);
337 char* getusername_malloc(void);
339 int getttyname_malloc(int fd, char **r);
340 int getttyname_harder(int fd, char **r);
342 int get_ctty_devnr(pid_t pid, dev_t *d);
343 int get_ctty(pid_t, dev_t *_devnr, char **r);
345 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
346 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
348 int rm_rf_children(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
349 int rm_rf_children_dangerous(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
350 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
351 int rm_rf_dangerous(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
353 int pipe_eof(int fd);
355 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
357 int status_vprintf(const char *status, bool ellipse, const char *format, va_list ap);
358 int status_printf(const char *status, bool ellipse, const char *format, ...);
359 int status_welcome(void);
361 int fd_columns(int fd);
362 unsigned columns(void);
363 int fd_lines(int fd);
364 unsigned lines(void);
365 void columns_lines_cache_reset(int _unused_ signum);
369 int running_in_chroot(void);
371 char *ellipsize(const char *s, size_t length, unsigned percent);
372 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
374 int touch(const char *path);
376 char *unquote(const char *s, const char *quotes);
377 char *normalize_env_assignment(const char *s);
379 int wait_for_terminate(pid_t pid, siginfo_t *status);
380 int wait_for_terminate_and_warn(const char *name, pid_t pid);
382 _noreturn_ void freeze(void);
384 bool null_or_empty(struct stat *st);
385 int null_or_empty_path(const char *fn);
387 DIR *xopendirat(int dirfd, const char *name, int flags);
389 char *fstab_node_to_udev_node(const char *p);
391 bool tty_is_vc(const char *tty);
392 bool tty_is_vc_resolve(const char *tty);
393 bool tty_is_console(const char *tty);
394 int vtnr_from_tty(const char *tty);
395 const char *default_term_for_tty(const char *tty);
397 void execute_directory(const char *directory, DIR *_d, char *argv[]);
399 int kill_and_sigcont(pid_t pid, int sig);
401 bool nulstr_contains(const char*nulstr, const char *needle);
403 bool plymouth_running(void);
405 bool hostname_is_valid(const char *s);
406 char* hostname_cleanup(char *s);
408 char* strshorten(char *s, size_t l);
410 int terminal_vhangup_fd(int fd);
411 int terminal_vhangup(const char *name);
413 int vt_disallocate(const char *name);
415 int copy_file(const char *from, const char *to);
417 int symlink_atomic(const char *from, const char *to);
419 int fchmod_umask(int fd, mode_t mode);
421 bool display_is_local(const char *display);
422 int socket_from_display(const char *display, char **path);
424 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
425 int get_group_creds(const char **groupname, gid_t *gid);
427 int in_group(const char *name);
429 char* uid_to_name(uid_t uid);
431 int glob_exists(const char *path);
433 int dirent_ensure_type(DIR *d, struct dirent *de);
435 int in_search_path(const char *path, char **search);
436 int get_files_in_directory(const char *path, char ***list);
438 char *strjoin(const char *x, ...) _sentinel_;
440 bool is_main_thread(void);
442 bool in_charset(const char *s, const char* charset);
444 int block_get_whole_disk(dev_t d, dev_t *ret);
446 int file_is_priv_sticky(const char *p);
448 int strdup_or_null(const char *a, char **b);
450 #define NULSTR_FOREACH(i, l) \
451 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
453 #define NULSTR_FOREACH_PAIR(i, j, l) \
454 for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
456 int ioprio_class_to_string_alloc(int i, char **s);
457 int ioprio_class_from_string(const char *s);
459 const char *sigchld_code_to_string(int i);
460 int sigchld_code_from_string(const char *s);
462 int log_facility_unshifted_to_string_alloc(int i, char **s);
463 int log_facility_unshifted_from_string(const char *s);
465 int log_level_to_string_alloc(int i, char **s);
466 int log_level_from_string(const char *s);
468 int sched_policy_to_string_alloc(int i, char **s);
469 int sched_policy_from_string(const char *s);
471 const char *rlimit_to_string(int i);
472 int rlimit_from_string(const char *s);
474 int ip_tos_to_string_alloc(int i, char **s);
475 int ip_tos_from_string(const char *s);
477 const char *signal_to_string(int i);
478 int signal_from_string(const char *s);
480 int signal_from_string_try_harder(const char *s);
482 extern int saved_argc;
483 extern char **saved_argv;
485 bool kexec_loaded(void);
487 int prot_from_flags(int flags);
489 char *format_bytes(char *buf, size_t l, off_t t);
491 int fd_wait_for_event(int fd, int event, usec_t timeout);
493 void* memdup(const void *p, size_t l) _malloc_;
495 int is_kernel_thread(pid_t pid);
497 int fd_inc_sndbuf(int fd, size_t n);
498 int fd_inc_rcvbuf(int fd, size_t n);
500 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
502 int setrlimit_closest(int resource, const struct rlimit *rlim);
504 int getenv_for_pid(pid_t pid, const char *field, char **_value);
506 int can_sleep(const char *type);
507 int can_sleep_disk(const char *type);
509 bool is_valid_documentation_url(const char *url);
511 bool in_initrd(void);
513 void warn_melody(void);
515 int get_shell(char **ret);
516 int get_home_dir(char **ret);
519 void fclosep(FILE **f);
520 void pclosep(FILE **f);
521 void closep(int *fd);
522 void closedirp(DIR **d);
523 void umaskp(mode_t *u);
525 _malloc_ static inline void *malloc_multiply(size_t a, size_t b) {
526 if (_unlikely_(b == 0 || a > ((size_t) -1) / b))
529 return malloc(a * b);
532 _malloc_ static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
533 if (_unlikely_(b == 0 || a > ((size_t) -1) / b))
536 return memdup(p, a * b);
539 bool filename_is_safe(const char *p);
540 bool path_is_safe(const char *p);
541 bool string_is_safe(const char *p);
542 bool string_has_cc(const char *p);
544 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
545 int (*compar) (const void *, const void *, void *),
548 bool is_locale_utf8(void);
550 typedef enum DrawSpecialChar {
555 DRAW_TRIANGULAR_BULLET,
556 _DRAW_SPECIAL_CHAR_MAX
558 const char *draw_special_char(DrawSpecialChar ch);
560 char *strreplace(const char *text, const char *old_string, const char *new_string);
562 char *strip_tab_ansi(char **p, size_t *l);
564 int on_ac_power(void);
566 int search_and_fopen(const char *path, const char *mode, const char **search, FILE **_f);
567 int search_and_fopen_nulstr(const char *path, const char *mode, const char *search, FILE **_f);
569 #define FOREACH_LINE(line, f, on_error) \
571 if (!fgets(line, sizeof(line), f)) { \
578 #define FOREACH_DIRENT(de, d, on_error) \
579 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
585 } else if (ignore_file((de)->d_name)) \