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);
126 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
127 assert_cc(sizeof(unsigned long) == sizeof(unsigned));
128 return safe_atou(s, (unsigned*) ret_u);
130 static inline int safe_atoli(const char *s, long int *ret_u) {
131 assert_cc(sizeof(long int) == sizeof(int));
132 return safe_atoi(s, (int*) ret_u);
135 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
136 assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
137 return safe_atollu(s, (unsigned long long*) ret_u);
139 static inline int safe_atoli(const char *s, long int *ret_u) {
140 assert_cc(sizeof(long int) == sizeof(long long int));
141 return safe_atolli(s, (long long int*) ret_u);
145 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
146 assert_cc(sizeof(uint32_t) == sizeof(unsigned));
147 return safe_atou(s, (unsigned*) ret_u);
150 static inline int safe_atoi32(const char *s, int32_t *ret_i) {
151 assert_cc(sizeof(int32_t) == sizeof(int));
152 return safe_atoi(s, (int*) ret_i);
155 static inline int safe_atou64(const char *s, uint64_t *ret_u) {
156 assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
157 return safe_atollu(s, (unsigned long long*) ret_u);
160 static inline int safe_atoi64(const char *s, int64_t *ret_i) {
161 assert_cc(sizeof(int64_t) == sizeof(long long int));
162 return safe_atolli(s, (long long int*) ret_i);
165 char *split(const char *c, size_t *l, const char *separator, char **state);
166 char *split_quoted(const char *c, size_t *l, char **state);
168 #define FOREACH_WORD(word, length, s, state) \
169 for ((state) = NULL, (word) = split((s), &(length), WHITESPACE, &(state)); (word); (word) = split((s), &(length), WHITESPACE, &(state)))
171 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state) \
172 for ((state) = NULL, (word) = split((s), &(length), (separator), &(state)); (word); (word) = split((s), &(length), (separator), &(state)))
174 #define FOREACH_WORD_QUOTED(word, length, s, state) \
175 for ((state) = NULL, (word) = split_quoted((s), &(length), &(state)); (word); (word) = split_quoted((s), &(length), &(state)))
177 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
178 int get_starttime_of_pid(pid_t pid, unsigned long long *st);
180 char *strappend(const char *s, const char *suffix);
181 char *strnappend(const char *s, const char *suffix, size_t length);
183 char *replace_env(const char *format, char **env);
184 char **replace_env_argv(char **argv, char **env);
186 int readlink_malloc(const char *p, char **r);
187 int readlink_and_make_absolute(const char *p, char **r);
188 int readlink_and_canonicalize(const char *p, char **r);
190 int reset_all_signal_handlers(void);
192 char *strstrip(char *s);
193 char *delete_chars(char *s, const char *bad);
194 char *truncate_nl(char *s);
196 char *file_in_same_dir(const char *path, const char *filename);
198 int rmdir_parents(const char *path, const char *stop);
200 int get_process_comm(pid_t pid, char **name);
201 int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
202 int get_process_exe(pid_t pid, char **name);
203 int get_process_uid(pid_t pid, uid_t *uid);
204 int get_process_gid(pid_t pid, gid_t *gid);
207 int unhexchar(char c);
209 int unoctchar(char c);
211 int undecchar(char c);
213 char *cescape(const char *s);
214 char *cunescape(const char *s);
215 char *cunescape_length(const char *s, size_t length);
216 char *cunescape_length_with_prefix(const char *s, size_t length, const char *prefix);
218 char *xescape(const char *s, const char *bad);
220 char *bus_path_escape(const char *s);
221 char *bus_path_unescape(const char *s);
223 char *ascii_strlower(char *path);
225 bool dirent_is_file(const struct dirent *de);
226 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix);
228 bool ignore_file(const char *filename);
230 bool chars_intersect(const char *a, const char *b);
232 int make_stdio(int fd);
233 int make_null_stdio(void);
234 int make_console_stdio(void);
236 unsigned long long random_ull(void);
238 /* For basic lookup tables with strictly enumerated entries */
239 #define __DEFINE_STRING_TABLE_LOOKUP(name,type,scope) \
240 scope const char *name##_to_string(type i) { \
241 if (i < 0 || i >= (type) ELEMENTSOF(name##_table)) \
243 return name##_table[i]; \
245 scope type name##_from_string(const char *s) { \
248 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
249 if (name##_table[i] && \
250 streq(name##_table[i], s)) \
254 struct __useless_struct_to_allow_trailing_semicolon__
256 #define DEFINE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,)
257 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,static)
259 /* For string conversions where numbers are also acceptable */
260 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max) \
261 int name##_to_string_alloc(type i, char **str) { \
264 if (i < 0 || i > max) \
266 if (i < (type) ELEMENTSOF(name##_table)) { \
267 s = strdup(name##_table[i]); \
271 r = asprintf(&s, "%u", i); \
278 type name##_from_string(const char *s) { \
282 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
283 if (name##_table[i] && \
284 streq(name##_table[i], s)) \
286 if (safe_atou(s, &u) >= 0 && u <= max) \
290 struct __useless_struct_to_allow_trailing_semicolon__
292 int fd_nonblock(int fd, bool nonblock);
293 int fd_cloexec(int fd, bool cloexec);
295 int close_all_fds(const int except[], unsigned n_except);
297 bool fstype_is_network(const char *fstype);
301 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
302 int ask(char *ret, const char *replies, const char *text, ...);
304 int reset_terminal_fd(int fd, bool switch_to_text);
305 int reset_terminal(const char *name);
307 int open_terminal(const char *name, int mode);
308 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
309 int release_terminal(void);
311 int flush_fd(int fd);
313 int ignore_signals(int sig, ...);
314 int default_signals(int sig, ...);
315 int sigaction_many(const struct sigaction *sa, ...);
317 int close_pipe(int p[]);
318 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
320 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
321 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
323 bool is_device_path(const char *path);
325 int dir_is_empty(const char *path);
327 void rename_process(const char name[8]);
329 void sigset_add_many(sigset_t *ss, ...);
331 bool hostname_is_set(void);
333 char* gethostname_malloc(void);
334 char* getlogname_malloc(void);
335 char* getusername_malloc(void);
337 int getttyname_malloc(int fd, char **r);
338 int getttyname_harder(int fd, char **r);
340 int get_ctty_devnr(pid_t pid, dev_t *d);
341 int get_ctty(pid_t, dev_t *_devnr, char **r);
343 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
344 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
346 int rm_rf_children(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
347 int rm_rf_children_dangerous(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
348 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
349 int rm_rf_dangerous(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
351 int pipe_eof(int fd);
353 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
355 int status_vprintf(const char *status, bool ellipse, const char *format, va_list ap);
356 int status_printf(const char *status, bool ellipse, const char *format, ...);
357 int status_welcome(void);
359 int fd_columns(int fd);
360 unsigned columns(void);
361 int fd_lines(int fd);
362 unsigned lines(void);
363 void columns_lines_cache_reset(int _unused_ signum);
367 int running_in_chroot(void);
369 char *ellipsize(const char *s, size_t length, unsigned percent);
370 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
372 int touch(const char *path);
374 char *unquote(const char *s, const char *quotes);
375 char *normalize_env_assignment(const char *s);
377 int wait_for_terminate(pid_t pid, siginfo_t *status);
378 int wait_for_terminate_and_warn(const char *name, pid_t pid);
380 _noreturn_ void freeze(void);
382 bool null_or_empty(struct stat *st);
383 int null_or_empty_path(const char *fn);
385 DIR *xopendirat(int dirfd, const char *name, int flags);
387 char *fstab_node_to_udev_node(const char *p);
389 bool tty_is_vc(const char *tty);
390 bool tty_is_vc_resolve(const char *tty);
391 bool tty_is_console(const char *tty);
392 int vtnr_from_tty(const char *tty);
393 const char *default_term_for_tty(const char *tty);
395 void execute_directory(const char *directory, DIR *_d, char *argv[]);
397 int kill_and_sigcont(pid_t pid, int sig);
399 bool nulstr_contains(const char*nulstr, const char *needle);
401 bool plymouth_running(void);
403 bool hostname_is_valid(const char *s);
404 char* hostname_cleanup(char *s);
406 char* strshorten(char *s, size_t l);
408 int terminal_vhangup_fd(int fd);
409 int terminal_vhangup(const char *name);
411 int vt_disallocate(const char *name);
413 int copy_file(const char *from, const char *to);
415 int symlink_atomic(const char *from, const char *to);
417 int fchmod_umask(int fd, mode_t mode);
419 bool display_is_local(const char *display);
420 int socket_from_display(const char *display, char **path);
422 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
423 int get_group_creds(const char **groupname, gid_t *gid);
425 int in_group(const char *name);
427 char* uid_to_name(uid_t uid);
429 int glob_exists(const char *path);
431 int dirent_ensure_type(DIR *d, struct dirent *de);
433 int in_search_path(const char *path, char **search);
434 int get_files_in_directory(const char *path, char ***list);
436 char *strjoin(const char *x, ...) _sentinel_;
438 bool is_main_thread(void);
440 bool in_charset(const char *s, const char* charset);
442 int block_get_whole_disk(dev_t d, dev_t *ret);
444 int file_is_priv_sticky(const char *p);
446 int strdup_or_null(const char *a, char **b);
448 #define NULSTR_FOREACH(i, l) \
449 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
451 #define NULSTR_FOREACH_PAIR(i, j, l) \
452 for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
454 int ioprio_class_to_string_alloc(int i, char **s);
455 int ioprio_class_from_string(const char *s);
457 const char *sigchld_code_to_string(int i);
458 int sigchld_code_from_string(const char *s);
460 int log_facility_unshifted_to_string_alloc(int i, char **s);
461 int log_facility_unshifted_from_string(const char *s);
463 int log_level_to_string_alloc(int i, char **s);
464 int log_level_from_string(const char *s);
466 int sched_policy_to_string_alloc(int i, char **s);
467 int sched_policy_from_string(const char *s);
469 const char *rlimit_to_string(int i);
470 int rlimit_from_string(const char *s);
472 int ip_tos_to_string_alloc(int i, char **s);
473 int ip_tos_from_string(const char *s);
475 const char *signal_to_string(int i);
476 int signal_from_string(const char *s);
478 int signal_from_string_try_harder(const char *s);
480 extern int saved_argc;
481 extern char **saved_argv;
483 bool kexec_loaded(void);
485 int prot_from_flags(int flags);
487 char *format_bytes(char *buf, size_t l, off_t t);
489 int fd_wait_for_event(int fd, int event, usec_t timeout);
491 void* memdup(const void *p, size_t l) _malloc_;
493 int is_kernel_thread(pid_t pid);
495 int fd_inc_sndbuf(int fd, size_t n);
496 int fd_inc_rcvbuf(int fd, size_t n);
498 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
500 int setrlimit_closest(int resource, const struct rlimit *rlim);
502 int getenv_for_pid(pid_t pid, const char *field, char **_value);
504 int can_sleep(const char *type);
505 int can_sleep_disk(const char *type);
507 bool is_valid_documentation_url(const char *url);
509 bool in_initrd(void);
511 void warn_melody(void);
513 int get_shell(char **ret);
514 int get_home_dir(char **ret);
517 void fclosep(FILE **f);
518 void pclosep(FILE **f);
519 void closep(int *fd);
520 void closedirp(DIR **d);
521 void umaskp(mode_t *u);
523 _malloc_ static inline void *malloc_multiply(size_t a, size_t b) {
524 if (_unlikely_(b == 0 || a > ((size_t) -1) / b))
527 return malloc(a * b);
530 _malloc_ static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
531 if (_unlikely_(b == 0 || a > ((size_t) -1) / b))
534 return memdup(p, a * b);
537 bool filename_is_safe(const char *p);
538 bool path_is_safe(const char *p);
539 bool string_is_safe(const char *p);
540 bool string_has_cc(const char *p);
542 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
543 int (*compar) (const void *, const void *, void *),
546 bool is_locale_utf8(void);
548 typedef enum DrawSpecialChar {
553 DRAW_TRIANGULAR_BULLET,
554 _DRAW_SPECIAL_CHAR_MAX
556 const char *draw_special_char(DrawSpecialChar ch);
558 char *strreplace(const char *text, const char *old_string, const char *new_string);
560 char *strip_tab_ansi(char **p, size_t *l);
562 int on_ac_power(void);
564 int search_and_fopen(const char *path, const char *mode, const char **search, FILE **_f);
565 int search_and_fopen_nulstr(const char *path, const char *mode, const char *search, FILE **_f);
567 #define FOREACH_LINE(line, f, on_error) \
569 if (!fgets(line, sizeof(line), f)) { \
576 #define FOREACH_DIRENT(de, d, on_error) \
577 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
583 } else if (ignore_file((de)->d_name)) \