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 bool is_efiboot(void);
65 size_t page_size(void);
66 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
68 #define streq(a,b) (strcmp((a),(b)) == 0)
69 #define strneq(a, b, n) (strncmp((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 int write_one_line_file(const char *fn, const char *line);
181 int write_one_line_file_atomic(const char *fn, const char *line);
182 int read_one_line_file(const char *fn, char **line);
183 int read_full_file(const char *fn, char **contents, size_t *size);
185 int parse_env_file(const char *fname, const char *separator, ...) _sentinel_;
186 int load_env_file(const char *fname, char ***l);
187 int write_env_file(const char *fname, char **l);
189 char *strappend(const char *s, const char *suffix);
190 char *strnappend(const char *s, const char *suffix, size_t length);
192 char *replace_env(const char *format, char **env);
193 char **replace_env_argv(char **argv, char **env);
195 int readlink_malloc(const char *p, char **r);
196 int readlink_and_make_absolute(const char *p, char **r);
197 int readlink_and_canonicalize(const char *p, char **r);
199 int reset_all_signal_handlers(void);
201 char *strstrip(char *s);
202 char *delete_chars(char *s, const char *bad);
203 char *truncate_nl(char *s);
205 char *file_in_same_dir(const char *path, const char *filename);
207 int rmdir_parents(const char *path, const char *stop);
209 int get_process_comm(pid_t pid, char **name);
210 int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
211 int get_process_exe(pid_t pid, char **name);
212 int get_process_uid(pid_t pid, uid_t *uid);
213 int get_process_gid(pid_t pid, gid_t *gid);
216 int unhexchar(char c);
218 int unoctchar(char c);
220 int undecchar(char c);
222 char *cescape(const char *s);
223 char *cunescape(const char *s);
224 char *cunescape_length(const char *s, size_t length);
225 char *cunescape_length_with_prefix(const char *s, size_t length, const char *prefix);
227 char *xescape(const char *s, const char *bad);
229 char *bus_path_escape(const char *s);
230 char *bus_path_unescape(const char *s);
232 char *ascii_strlower(char *path);
234 bool dirent_is_file(const struct dirent *de);
235 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix);
237 bool ignore_file(const char *filename);
239 bool chars_intersect(const char *a, const char *b);
241 int make_stdio(int fd);
242 int make_null_stdio(void);
243 int make_console_stdio(void);
245 unsigned long long random_ull(void);
247 /* For basic lookup tables with strictly enumerated entries */
248 #define __DEFINE_STRING_TABLE_LOOKUP(name,type,scope) \
249 scope const char *name##_to_string(type i) { \
250 if (i < 0 || i >= (type) ELEMENTSOF(name##_table)) \
252 return name##_table[i]; \
254 scope type name##_from_string(const char *s) { \
257 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
258 if (name##_table[i] && \
259 streq(name##_table[i], s)) \
263 struct __useless_struct_to_allow_trailing_semicolon__
265 #define DEFINE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,)
266 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,static)
268 /* For string conversions where numbers are also acceptable */
269 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max) \
270 int name##_to_string_alloc(type i, char **str) { \
273 if (i < 0 || i > max) \
275 if (i < (type) ELEMENTSOF(name##_table)) { \
276 s = strdup(name##_table[i]); \
280 r = asprintf(&s, "%u", i); \
287 type name##_from_string(const char *s) { \
291 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
292 if (name##_table[i] && \
293 streq(name##_table[i], s)) \
295 if (safe_atou(s, &u) >= 0 && u <= max) \
299 struct __useless_struct_to_allow_trailing_semicolon__
301 int fd_nonblock(int fd, bool nonblock);
302 int fd_cloexec(int fd, bool cloexec);
304 int close_all_fds(const int except[], unsigned n_except);
306 bool fstype_is_network(const char *fstype);
310 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
311 int ask(char *ret, const char *replies, const char *text, ...);
313 int reset_terminal_fd(int fd, bool switch_to_text);
314 int reset_terminal(const char *name);
316 int open_terminal(const char *name, int mode);
317 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
318 int release_terminal(void);
320 int flush_fd(int fd);
322 int ignore_signals(int sig, ...);
323 int default_signals(int sig, ...);
324 int sigaction_many(const struct sigaction *sa, ...);
326 int close_pipe(int p[]);
327 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
329 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
330 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
332 bool is_device_path(const char *path);
334 int dir_is_empty(const char *path);
336 void rename_process(const char name[8]);
338 void sigset_add_many(sigset_t *ss, ...);
340 bool hostname_is_set(void);
342 char* gethostname_malloc(void);
343 char* getlogname_malloc(void);
344 char* getusername_malloc(void);
346 int getttyname_malloc(int fd, char **r);
347 int getttyname_harder(int fd, char **r);
349 int get_ctty_devnr(pid_t pid, dev_t *d);
350 int get_ctty(pid_t, dev_t *_devnr, char **r);
352 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
353 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
355 int rm_rf_children(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
356 int rm_rf_children_dangerous(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
357 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
358 int rm_rf_dangerous(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
360 int pipe_eof(int fd);
362 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
364 int status_vprintf(const char *status, bool ellipse, const char *format, va_list ap);
365 int status_printf(const char *status, bool ellipse, const char *format, ...);
366 int status_welcome(void);
368 int fd_columns(int fd);
369 unsigned columns(void);
370 int fd_lines(int fd);
371 unsigned lines(void);
372 void columns_lines_cache_reset(int _unused_ signum);
376 int running_in_chroot(void);
378 char *ellipsize(const char *s, size_t length, unsigned percent);
379 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
381 int touch(const char *path);
383 char *unquote(const char *s, const char *quotes);
384 char *normalize_env_assignment(const char *s);
386 int wait_for_terminate(pid_t pid, siginfo_t *status);
387 int wait_for_terminate_and_warn(const char *name, pid_t pid);
389 _noreturn_ void freeze(void);
391 bool null_or_empty(struct stat *st);
392 int null_or_empty_path(const char *fn);
394 DIR *xopendirat(int dirfd, const char *name, int flags);
396 char *fstab_node_to_udev_node(const char *p);
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_group(const char *name);
436 int glob_exists(const char *path);
438 int dirent_ensure_type(DIR *d, struct dirent *de);
440 int in_search_path(const char *path, char **search);
441 int get_files_in_directory(const char *path, char ***list);
443 char *strjoin(const char *x, ...) _sentinel_;
445 bool is_main_thread(void);
447 bool in_charset(const char *s, const char* charset);
449 int block_get_whole_disk(dev_t d, dev_t *ret);
451 int file_is_priv_sticky(const char *p);
453 int strdup_or_null(const char *a, char **b);
455 #define NULSTR_FOREACH(i, l) \
456 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
458 #define NULSTR_FOREACH_PAIR(i, j, l) \
459 for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
461 int ioprio_class_to_string_alloc(int i, char **s);
462 int ioprio_class_from_string(const char *s);
464 const char *sigchld_code_to_string(int i);
465 int sigchld_code_from_string(const char *s);
467 int log_facility_unshifted_to_string_alloc(int i, char **s);
468 int log_facility_unshifted_from_string(const char *s);
470 int log_level_to_string_alloc(int i, char **s);
471 int log_level_from_string(const char *s);
473 int sched_policy_to_string_alloc(int i, char **s);
474 int sched_policy_from_string(const char *s);
476 const char *rlimit_to_string(int i);
477 int rlimit_from_string(const char *s);
479 int ip_tos_to_string_alloc(int i, char **s);
480 int ip_tos_from_string(const char *s);
482 const char *signal_to_string(int i);
483 int signal_from_string(const char *s);
485 int signal_from_string_try_harder(const char *s);
487 extern int saved_argc;
488 extern char **saved_argv;
490 bool kexec_loaded(void);
492 int prot_from_flags(int flags);
494 char *format_bytes(char *buf, size_t l, off_t t);
496 int fd_wait_for_event(int fd, int event, usec_t timeout);
498 void* memdup(const void *p, size_t l) _malloc_;
500 int is_kernel_thread(pid_t pid);
502 int fd_inc_sndbuf(int fd, size_t n);
503 int fd_inc_rcvbuf(int fd, size_t n);
505 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
507 int setrlimit_closest(int resource, const struct rlimit *rlim);
509 int getenv_for_pid(pid_t pid, const char *field, char **_value);
511 int can_sleep(const char *type);
512 int can_sleep_disk(const char *type);
514 bool is_valid_documentation_url(const char *url);
516 bool in_initrd(void);
518 void warn_melody(void);
520 int get_shell(char **ret);
521 int get_home_dir(char **ret);
524 void fclosep(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 string_is_safe(const char *p);
546 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
547 int (*compar) (const void *, const void *, void *),
550 bool is_locale_utf8(void);
552 typedef enum DrawSpecialChar {
556 DRAW_TRIANGULAR_BULLET,
557 _DRAW_SPECIAL_CHAR_MAX
559 const char *draw_special_char(DrawSpecialChar ch);
561 char *strreplace(const char *text, const char *old_string, const char *new_string);
563 char *strip_tab_ansi(char **p, size_t *l);
565 int on_ac_power(void);