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)
69 bool streq_ptr(const char *a, const char *b);
71 #define new(t, n) ((t*) malloc_multiply(sizeof(t), (n)))
73 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
75 #define newa(t, n) ((t*) alloca(sizeof(t)*(n)))
77 #define newdup(t, p, n) ((t*) memdup_multiply(p, sizeof(t), (n)))
79 #define malloc0(n) (calloc((n), 1))
81 static inline const char* yes_no(bool b) {
82 return b ? "yes" : "no";
85 static inline const char* strempty(const char *s) {
89 static inline const char* strnull(const char *s) {
90 return s ? s : "(null)";
93 static inline const char *strna(const char *s) {
97 static inline bool isempty(const char *p) {
101 char *endswith(const char *s, const char *postfix);
102 char *startswith(const char *s, const char *prefix);
103 char *startswith_no_case(const char *s, const char *prefix);
105 bool first_word(const char *s, const char *word);
107 int close_nointr(int fd);
108 void close_nointr_nofail(int fd);
109 void close_many(const int fds[], unsigned n_fd);
111 int parse_boolean(const char *v);
112 int parse_bytes(const char *t, off_t *bytes);
113 int parse_pid(const char *s, pid_t* ret_pid);
114 int parse_uid(const char *s, uid_t* ret_uid);
115 #define parse_gid(s, ret_uid) parse_uid(s, ret_uid)
117 int safe_atou(const char *s, unsigned *ret_u);
118 int safe_atoi(const char *s, int *ret_i);
120 int safe_atollu(const char *s, unsigned long long *ret_u);
121 int safe_atolli(const char *s, long long int *ret_i);
124 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
125 assert_cc(sizeof(unsigned long) == sizeof(unsigned));
126 return safe_atou(s, (unsigned*) ret_u);
128 static inline int safe_atoli(const char *s, long int *ret_u) {
129 assert_cc(sizeof(long int) == sizeof(int));
130 return safe_atoi(s, (int*) ret_u);
133 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
134 assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
135 return safe_atollu(s, (unsigned long long*) ret_u);
137 static inline int safe_atoli(const char *s, long int *ret_u) {
138 assert_cc(sizeof(long int) == sizeof(long long int));
139 return safe_atolli(s, (long long int*) ret_u);
143 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
144 assert_cc(sizeof(uint32_t) == sizeof(unsigned));
145 return safe_atou(s, (unsigned*) ret_u);
148 static inline int safe_atoi32(const char *s, int32_t *ret_i) {
149 assert_cc(sizeof(int32_t) == sizeof(int));
150 return safe_atoi(s, (int*) ret_i);
153 static inline int safe_atou64(const char *s, uint64_t *ret_u) {
154 assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
155 return safe_atollu(s, (unsigned long long*) ret_u);
158 static inline int safe_atoi64(const char *s, int64_t *ret_i) {
159 assert_cc(sizeof(int64_t) == sizeof(long long int));
160 return safe_atolli(s, (long long int*) ret_i);
163 char *split(const char *c, size_t *l, const char *separator, char **state);
164 char *split_quoted(const char *c, size_t *l, char **state);
166 #define FOREACH_WORD(word, length, s, state) \
167 for ((state) = NULL, (word) = split((s), &(length), WHITESPACE, &(state)); (word); (word) = split((s), &(length), WHITESPACE, &(state)))
169 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state) \
170 for ((state) = NULL, (word) = split((s), &(length), (separator), &(state)); (word); (word) = split((s), &(length), (separator), &(state)))
172 #define FOREACH_WORD_QUOTED(word, length, s, state) \
173 for ((state) = NULL, (word) = split_quoted((s), &(length), &(state)); (word); (word) = split_quoted((s), &(length), &(state)))
175 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
176 int get_starttime_of_pid(pid_t pid, unsigned long long *st);
178 int write_one_line_file(const char *fn, const char *line);
179 int write_one_line_file_atomic(const char *fn, const char *line);
180 int read_one_line_file(const char *fn, char **line);
181 int read_full_file(const char *fn, char **contents, size_t *size);
183 int parse_env_file(const char *fname, const char *separator, ...) _sentinel_;
184 int load_env_file(const char *fname, char ***l);
185 int write_env_file(const char *fname, char **l);
187 char *strappend(const char *s, const char *suffix);
188 char *strnappend(const char *s, const char *suffix, size_t length);
190 char *replace_env(const char *format, char **env);
191 char **replace_env_argv(char **argv, char **env);
193 int readlink_malloc(const char *p, char **r);
194 int readlink_and_make_absolute(const char *p, char **r);
195 int readlink_and_canonicalize(const char *p, char **r);
197 int reset_all_signal_handlers(void);
199 char *strstrip(char *s);
200 char *delete_chars(char *s, const char *bad);
201 char *truncate_nl(char *s);
203 char *file_in_same_dir(const char *path, const char *filename);
205 int rmdir_parents(const char *path, const char *stop);
207 int get_process_comm(pid_t pid, char **name);
208 int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
209 int get_process_exe(pid_t pid, char **name);
210 int get_process_uid(pid_t pid, uid_t *uid);
211 int get_process_gid(pid_t pid, gid_t *gid);
214 int unhexchar(char c);
216 int unoctchar(char c);
218 int undecchar(char c);
220 char *cescape(const char *s);
221 char *cunescape(const char *s);
222 char *cunescape_length(const char *s, size_t length);
223 char *cunescape_length_with_prefix(const char *s, size_t length, const char *prefix);
225 char *xescape(const char *s, const char *bad);
227 char *bus_path_escape(const char *s);
228 char *bus_path_unescape(const char *s);
230 char *ascii_strlower(char *path);
232 bool dirent_is_file(const struct dirent *de);
233 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix);
235 bool ignore_file(const char *filename);
237 bool chars_intersect(const char *a, const char *b);
239 int make_stdio(int fd);
240 int make_null_stdio(void);
241 int make_console_stdio(void);
243 unsigned long long random_ull(void);
245 /* For basic lookup tables with strictly enumerated entries */
246 #define __DEFINE_STRING_TABLE_LOOKUP(name,type,scope) \
247 scope const char *name##_to_string(type i) { \
248 if (i < 0 || i >= (type) ELEMENTSOF(name##_table)) \
250 return name##_table[i]; \
252 scope type name##_from_string(const char *s) { \
255 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
256 if (name##_table[i] && \
257 streq(name##_table[i], s)) \
261 struct __useless_struct_to_allow_trailing_semicolon__
263 #define DEFINE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,)
264 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,static)
266 /* For string conversions where numbers are also acceptable */
267 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max) \
268 int name##_to_string_alloc(type i, char **str) { \
271 if (i < 0 || i > max) \
273 if (i < (type) ELEMENTSOF(name##_table)) { \
274 s = strdup(name##_table[i]); \
278 r = asprintf(&s, "%u", i); \
285 type name##_from_string(const char *s) { \
289 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
290 if (name##_table[i] && \
291 streq(name##_table[i], s)) \
293 if (safe_atou(s, &u) >= 0 && u <= max) \
297 struct __useless_struct_to_allow_trailing_semicolon__
299 int fd_nonblock(int fd, bool nonblock);
300 int fd_cloexec(int fd, bool cloexec);
302 int close_all_fds(const int except[], unsigned n_except);
304 bool fstype_is_network(const char *fstype);
308 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
309 int ask(char *ret, const char *replies, const char *text, ...);
311 int reset_terminal_fd(int fd, bool switch_to_text);
312 int reset_terminal(const char *name);
314 int open_terminal(const char *name, int mode);
315 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
316 int release_terminal(void);
318 int flush_fd(int fd);
320 int ignore_signals(int sig, ...);
321 int default_signals(int sig, ...);
322 int sigaction_many(const struct sigaction *sa, ...);
324 int close_pipe(int p[]);
325 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
327 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
328 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
330 bool is_device_path(const char *path);
332 int dir_is_empty(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, const char *format, va_list ap);
363 int status_printf(const char *status, bool ellipse, 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 bool tty_is_vc(const char *tty);
397 bool tty_is_vc_resolve(const char *tty);
398 bool tty_is_console(const char *tty);
399 int vtnr_from_tty(const char *tty);
400 const char *default_term_for_tty(const char *tty);
402 void execute_directory(const char *directory, DIR *_d, char *argv[]);
404 int kill_and_sigcont(pid_t pid, int sig);
406 bool nulstr_contains(const char*nulstr, const char *needle);
408 bool plymouth_running(void);
410 bool hostname_is_valid(const char *s);
411 char* hostname_cleanup(char *s);
413 char* strshorten(char *s, size_t l);
415 int terminal_vhangup_fd(int fd);
416 int terminal_vhangup(const char *name);
418 int vt_disallocate(const char *name);
420 int copy_file(const char *from, const char *to);
422 int symlink_atomic(const char *from, const char *to);
424 int fchmod_umask(int fd, mode_t mode);
426 bool display_is_local(const char *display);
427 int socket_from_display(const char *display, char **path);
429 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
430 int get_group_creds(const char **groupname, gid_t *gid);
432 int in_group(const char *name);
434 char* uid_to_name(uid_t uid);
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 path_is_safe(const char *p);
545 bool string_is_safe(const char *p);
547 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
548 int (*compar) (const void *, const void *, void *),
551 bool is_locale_utf8(void);
553 typedef enum DrawSpecialChar {
558 DRAW_TRIANGULAR_BULLET,
559 _DRAW_SPECIAL_CHAR_MAX
561 const char *draw_special_char(DrawSpecialChar ch);
563 char *strreplace(const char *text, const char *old_string, const char *new_string);
565 char *strip_tab_ansi(char **p, size_t *l);
567 int on_ac_power(void);