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_RED_ON "\x1B[31m"
59 #define ANSI_HIGHLIGHT_RED_ON "\x1B[1;31m"
60 #define ANSI_GREEN_ON "\x1B[32m"
61 #define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
62 #define ANSI_HIGHLIGHT_YELLOW_ON "\x1B[1;33m"
63 #define ANSI_HIGHLIGHT_OFF "\x1B[0m"
64 #define ANSI_ERASE_TO_END_OF_LINE "\x1B[K"
66 size_t page_size(void);
67 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
69 #define streq(a,b) (strcmp((a),(b)) == 0)
70 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
71 #define strcaseeq(a,b) (strcasecmp((a),(b)) == 0)
72 #define strncaseeq(a, b, n) (strncasecmp((a), (b), (n)) == 0)
74 bool streq_ptr(const char *a, const char *b);
76 #define new(t, n) ((t*) malloc_multiply(sizeof(t), (n)))
78 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
80 #define newa(t, n) ((t*) alloca(sizeof(t)*(n)))
82 #define newdup(t, p, n) ((t*) memdup_multiply(p, sizeof(t), (n)))
84 #define malloc0(n) (calloc((n), 1))
86 static inline const char* yes_no(bool b) {
87 return b ? "yes" : "no";
90 static inline const char* strempty(const char *s) {
94 static inline const char* strnull(const char *s) {
95 return s ? s : "(null)";
98 static inline const char *strna(const char *s) {
102 static inline bool isempty(const char *p) {
106 char *endswith(const char *s, const char *postfix);
107 char *startswith(const char *s, const char *prefix);
108 char *startswith_no_case(const char *s, const char *prefix);
110 bool first_word(const char *s, const char *word);
112 int close_nointr(int fd);
113 void close_nointr_nofail(int fd);
114 void close_many(const int fds[], unsigned n_fd);
116 int parse_boolean(const char *v);
117 int parse_bytes(const char *t, off_t *bytes);
118 int parse_pid(const char *s, pid_t* ret_pid);
119 int parse_uid(const char *s, uid_t* ret_uid);
120 #define parse_gid(s, ret_uid) parse_uid(s, ret_uid)
122 int safe_atou(const char *s, unsigned *ret_u);
123 int safe_atoi(const char *s, int *ret_i);
125 int safe_atollu(const char *s, unsigned long long *ret_u);
126 int safe_atolli(const char *s, long long int *ret_i);
128 int safe_atod(const char *s, double *ret_d);
131 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
132 assert_cc(sizeof(unsigned long) == sizeof(unsigned));
133 return safe_atou(s, (unsigned*) ret_u);
135 static inline int safe_atoli(const char *s, long int *ret_u) {
136 assert_cc(sizeof(long int) == sizeof(int));
137 return safe_atoi(s, (int*) ret_u);
140 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
141 assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
142 return safe_atollu(s, (unsigned long long*) ret_u);
144 static inline int safe_atoli(const char *s, long int *ret_u) {
145 assert_cc(sizeof(long int) == sizeof(long long int));
146 return safe_atolli(s, (long long int*) ret_u);
150 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
151 assert_cc(sizeof(uint32_t) == sizeof(unsigned));
152 return safe_atou(s, (unsigned*) ret_u);
155 static inline int safe_atoi32(const char *s, int32_t *ret_i) {
156 assert_cc(sizeof(int32_t) == sizeof(int));
157 return safe_atoi(s, (int*) ret_i);
160 static inline int safe_atou64(const char *s, uint64_t *ret_u) {
161 assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
162 return safe_atollu(s, (unsigned long long*) ret_u);
165 static inline int safe_atoi64(const char *s, int64_t *ret_i) {
166 assert_cc(sizeof(int64_t) == sizeof(long long int));
167 return safe_atolli(s, (long long int*) ret_i);
170 char *split(const char *c, size_t *l, const char *separator, char **state);
171 char *split_quoted(const char *c, size_t *l, char **state);
173 #define FOREACH_WORD(word, length, s, state) \
174 for ((state) = NULL, (word) = split((s), &(length), WHITESPACE, &(state)); (word); (word) = split((s), &(length), WHITESPACE, &(state)))
176 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state) \
177 for ((state) = NULL, (word) = split((s), &(length), (separator), &(state)); (word); (word) = split((s), &(length), (separator), &(state)))
179 #define FOREACH_WORD_QUOTED(word, length, s, state) \
180 for ((state) = NULL, (word) = split_quoted((s), &(length), &(state)); (word); (word) = split_quoted((s), &(length), &(state)))
182 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
183 int get_starttime_of_pid(pid_t pid, unsigned long long *st);
185 char *strappend(const char *s, const char *suffix);
186 char *strnappend(const char *s, const char *suffix, size_t length);
188 char *replace_env(const char *format, char **env);
189 char **replace_env_argv(char **argv, char **env);
191 int readlink_malloc(const char *p, char **r);
192 int readlink_and_make_absolute(const char *p, char **r);
193 int readlink_and_canonicalize(const char *p, char **r);
195 int reset_all_signal_handlers(void);
197 char *strstrip(char *s);
198 char *delete_chars(char *s, const char *bad);
199 char *truncate_nl(char *s);
201 char *file_in_same_dir(const char *path, const char *filename);
203 int rmdir_parents(const char *path, const char *stop);
205 int get_process_comm(pid_t pid, char **name);
206 int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
207 int get_process_exe(pid_t pid, char **name);
208 int get_process_uid(pid_t pid, uid_t *uid);
209 int get_process_gid(pid_t pid, gid_t *gid);
212 int unhexchar(char c);
214 int unoctchar(char c);
216 int undecchar(char c);
218 char *cescape(const char *s);
219 char *cunescape(const char *s);
220 char *cunescape_length(const char *s, size_t length);
221 char *cunescape_length_with_prefix(const char *s, size_t length, const char *prefix);
223 char *xescape(const char *s, const char *bad);
225 char *bus_path_escape(const char *s);
226 char *bus_path_unescape(const char *s);
228 char *ascii_strlower(char *path);
230 bool dirent_is_file(const struct dirent *de);
231 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix);
233 bool ignore_file(const char *filename);
235 bool chars_intersect(const char *a, const char *b);
237 int make_stdio(int fd);
238 int make_null_stdio(void);
239 int make_console_stdio(void);
241 unsigned long long random_ull(void);
243 /* For basic lookup tables with strictly enumerated entries */
244 #define __DEFINE_STRING_TABLE_LOOKUP(name,type,scope) \
245 scope const char *name##_to_string(type i) { \
246 if (i < 0 || i >= (type) ELEMENTSOF(name##_table)) \
248 return name##_table[i]; \
250 scope type name##_from_string(const char *s) { \
253 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
254 if (name##_table[i] && \
255 streq(name##_table[i], s)) \
259 struct __useless_struct_to_allow_trailing_semicolon__
261 #define DEFINE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,)
262 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,static)
264 /* For string conversions where numbers are also acceptable */
265 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max) \
266 int name##_to_string_alloc(type i, char **str) { \
269 if (i < 0 || i > max) \
271 if (i < (type) ELEMENTSOF(name##_table)) { \
272 s = strdup(name##_table[i]); \
276 r = asprintf(&s, "%u", i); \
283 type name##_from_string(const char *s) { \
287 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
288 if (name##_table[i] && \
289 streq(name##_table[i], s)) \
291 if (safe_atou(s, &u) >= 0 && u <= max) \
295 struct __useless_struct_to_allow_trailing_semicolon__
297 int fd_nonblock(int fd, bool nonblock);
298 int fd_cloexec(int fd, bool cloexec);
300 int close_all_fds(const int except[], unsigned n_except);
302 bool fstype_is_network(const char *fstype);
306 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
307 int ask(char *ret, const char *replies, const char *text, ...);
309 int reset_terminal_fd(int fd, bool switch_to_text);
310 int reset_terminal(const char *name);
312 int open_terminal(const char *name, int mode);
313 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
314 int release_terminal(void);
316 int flush_fd(int fd);
318 int ignore_signals(int sig, ...);
319 int default_signals(int sig, ...);
320 int sigaction_many(const struct sigaction *sa, ...);
322 int close_pipe(int p[]);
323 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
325 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
326 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
328 bool is_device_path(const char *path);
330 int dir_is_empty(const char *path);
332 void rename_process(const char name[8]);
334 void sigset_add_many(sigset_t *ss, ...);
336 bool hostname_is_set(void);
338 char* gethostname_malloc(void);
339 char* getlogname_malloc(void);
340 char* getusername_malloc(void);
342 int getttyname_malloc(int fd, char **r);
343 int getttyname_harder(int fd, char **r);
345 int get_ctty_devnr(pid_t pid, dev_t *d);
346 int get_ctty(pid_t, dev_t *_devnr, char **r);
348 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
349 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
351 int rm_rf_children(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
352 int rm_rf_children_dangerous(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
353 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
354 int rm_rf_dangerous(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
356 int pipe_eof(int fd);
358 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
360 int status_vprintf(const char *status, bool ellipse, bool ephemeral, const char *format, va_list ap);
361 int status_printf(const char *status, bool ellipse, bool ephemeral, const char *format, ...);
362 int status_welcome(void);
364 int fd_columns(int fd);
365 unsigned columns(void);
366 int fd_lines(int fd);
367 unsigned lines(void);
368 void columns_lines_cache_reset(int _unused_ signum);
372 int running_in_chroot(void);
374 char *ellipsize(const char *s, size_t length, unsigned percent);
375 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
377 int touch(const char *path);
379 char *unquote(const char *s, const char *quotes);
380 char *normalize_env_assignment(const char *s);
382 int wait_for_terminate(pid_t pid, siginfo_t *status);
383 int wait_for_terminate_and_warn(const char *name, pid_t pid);
385 _noreturn_ void freeze(void);
387 bool null_or_empty(struct stat *st);
388 int null_or_empty_path(const char *fn);
390 DIR *xopendirat(int dirfd, const char *name, int flags);
392 char *fstab_node_to_udev_node(const char *p);
394 char *resolve_dev_console(char **active);
395 bool tty_is_vc(const char *tty);
396 bool tty_is_vc_resolve(const char *tty);
397 bool tty_is_console(const char *tty);
398 int vtnr_from_tty(const char *tty);
399 const char *default_term_for_tty(const char *tty);
401 void execute_directory(const char *directory, DIR *_d, char *argv[]);
403 int kill_and_sigcont(pid_t pid, int sig);
405 bool nulstr_contains(const char*nulstr, const char *needle);
407 bool plymouth_running(void);
409 bool hostname_is_valid(const char *s);
410 char* hostname_cleanup(char *s);
412 char* strshorten(char *s, size_t l);
414 int terminal_vhangup_fd(int fd);
415 int terminal_vhangup(const char *name);
417 int vt_disallocate(const char *name);
419 int copy_file(const char *from, const char *to);
421 int symlink_atomic(const char *from, const char *to);
423 int fchmod_umask(int fd, mode_t mode);
425 bool display_is_local(const char *display);
426 int socket_from_display(const char *display, char **path);
428 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
429 int get_group_creds(const char **groupname, gid_t *gid);
431 int in_group(const char *name);
433 char* uid_to_name(uid_t uid);
435 int glob_exists(const char *path);
437 int dirent_ensure_type(DIR *d, struct dirent *de);
439 int in_search_path(const char *path, char **search);
440 int get_files_in_directory(const char *path, char ***list);
442 char *strjoin(const char *x, ...) _sentinel_;
444 bool is_main_thread(void);
446 bool in_charset(const char *s, const char* charset);
448 int block_get_whole_disk(dev_t d, dev_t *ret);
450 int file_is_priv_sticky(const char *p);
452 int strdup_or_null(const char *a, char **b);
454 #define NULSTR_FOREACH(i, l) \
455 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
457 #define NULSTR_FOREACH_PAIR(i, j, l) \
458 for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
460 int ioprio_class_to_string_alloc(int i, char **s);
461 int ioprio_class_from_string(const char *s);
463 const char *sigchld_code_to_string(int i);
464 int sigchld_code_from_string(const char *s);
466 int log_facility_unshifted_to_string_alloc(int i, char **s);
467 int log_facility_unshifted_from_string(const char *s);
469 int log_level_to_string_alloc(int i, char **s);
470 int log_level_from_string(const char *s);
472 int sched_policy_to_string_alloc(int i, char **s);
473 int sched_policy_from_string(const char *s);
475 const char *rlimit_to_string(int i);
476 int rlimit_from_string(const char *s);
478 int ip_tos_to_string_alloc(int i, char **s);
479 int ip_tos_from_string(const char *s);
481 const char *signal_to_string(int i);
482 int signal_from_string(const char *s);
484 int signal_from_string_try_harder(const char *s);
486 extern int saved_argc;
487 extern char **saved_argv;
489 bool kexec_loaded(void);
491 int prot_from_flags(int flags);
493 char *format_bytes(char *buf, size_t l, off_t t);
495 int fd_wait_for_event(int fd, int event, usec_t timeout);
497 void* memdup(const void *p, size_t l) _malloc_;
499 int is_kernel_thread(pid_t pid);
501 int fd_inc_sndbuf(int fd, size_t n);
502 int fd_inc_rcvbuf(int fd, size_t n);
504 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
506 int setrlimit_closest(int resource, const struct rlimit *rlim);
508 int getenv_for_pid(pid_t pid, const char *field, char **_value);
510 int can_sleep(const char *type);
511 int can_sleep_disk(const char *type);
513 bool is_valid_documentation_url(const char *url);
515 bool in_initrd(void);
517 void warn_melody(void);
519 int get_shell(char **ret);
520 int get_home_dir(char **ret);
523 void fclosep(FILE **f);
524 void pclosep(FILE **f);
525 void closep(int *fd);
526 void closedirp(DIR **d);
527 void umaskp(mode_t *u);
529 _malloc_ static inline void *malloc_multiply(size_t a, size_t b) {
530 if (_unlikely_(b == 0 || a > ((size_t) -1) / b))
533 return malloc(a * b);
536 _malloc_ static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
537 if (_unlikely_(b == 0 || a > ((size_t) -1) / b))
540 return memdup(p, a * b);
543 bool filename_is_safe(const char *p);
544 bool path_is_safe(const char *p);
545 bool string_is_safe(const char *p);
546 bool string_has_cc(const char *p);
548 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
549 int (*compar) (const void *, const void *, void *),
552 bool is_locale_utf8(void);
554 typedef enum DrawSpecialChar {
559 DRAW_TRIANGULAR_BULLET,
560 _DRAW_SPECIAL_CHAR_MAX
562 const char *draw_special_char(DrawSpecialChar ch);
564 char *strreplace(const char *text, const char *old_string, const char *new_string);
566 char *strip_tab_ansi(char **p, size_t *l);
568 int on_ac_power(void);
570 int search_and_fopen(const char *path, const char *mode, const char **search, FILE **_f);
571 int search_and_fopen_nulstr(const char *path, const char *mode, const char *search, FILE **_f);
573 #define FOREACH_LINE(line, f, on_error) \
575 if (!fgets(line, sizeof(line), f)) { \
582 #define FOREACH_DIRENT(de, d, on_error) \
583 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
589 } else if (ignore_file((de)->d_name)) \