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/>.
36 #include <sys/types.h>
39 #include <sys/resource.h>
44 #include <sys/socket.h>
45 #include <sys/inotify.h>
48 # define PID_FMT "%" PRIu32
49 #elif SIZEOF_PID_T == 2
50 # define PID_FMT "%" PRIu16
52 # error Unknown pid_t size
56 # define UID_FMT "%" PRIu32
57 #elif SIZEOF_UID_T == 2
58 # define UID_FMT "%" PRIu16
60 # error Unknown uid_t size
64 # define GID_FMT "%" PRIu32
65 #elif SIZEOF_GID_T == 2
66 # define GID_FMT "%" PRIu16
68 # error Unknown gid_t size
71 #if SIZEOF_TIME_T == 8
72 # define PRI_TIME PRIu64
73 #elif SIZEOF_TIME_T == 4
74 # define PRI_TIME PRIu32
76 # error Unknown time_t size
79 #if SIZEOF_RLIM_T == 8
80 # define RLIM_FMT "%" PRIu64
81 #elif SIZEOF_RLIM_T == 4
82 # define RLIM_FMT "%" PRIu32
84 # error Unknown rlim_t size
89 #include "time-util.h"
91 /* What is interpreted as whitespace? */
92 #define WHITESPACE " \t\n\r"
93 #define NEWLINE "\n\r"
96 #define GLOB_CHARS "*?["
98 /* What characters are special in the shell? */
99 /* must be escaped outside and inside double-quotes */
100 #define SHELL_NEED_ESCAPE "\"\\`$"
101 /* can be escaped or double-quoted */
102 #define SHELL_NEED_QUOTES SHELL_NEED_ESCAPE GLOB_CHARS "'()<>|&;"
104 #define FORMAT_BYTES_MAX 8
106 #define ANSI_HIGHLIGHT_ON "\x1B[1;39m"
107 #define ANSI_RED_ON "\x1B[31m"
108 #define ANSI_HIGHLIGHT_RED_ON "\x1B[1;31m"
109 #define ANSI_GREEN_ON "\x1B[32m"
110 #define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
111 #define ANSI_HIGHLIGHT_YELLOW_ON "\x1B[1;33m"
112 #define ANSI_HIGHLIGHT_BLUE_ON "\x1B[1;34m"
113 #define ANSI_HIGHLIGHT_OFF "\x1B[0m"
114 #define ANSI_ERASE_TO_END_OF_LINE "\x1B[K"
116 size_t page_size(void) _pure_;
117 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
119 #define streq(a,b) (strcmp((a),(b)) == 0)
120 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
121 #define strcaseeq(a,b) (strcasecmp((a),(b)) == 0)
122 #define strncaseeq(a, b, n) (strncasecmp((a), (b), (n)) == 0)
124 bool streq_ptr(const char *a, const char *b) _pure_;
126 #define new(t, n) ((t*) malloc_multiply(sizeof(t), (n)))
128 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
130 #define newa(t, n) ((t*) alloca(sizeof(t)*(n)))
132 #define newa0(t, n) ((t*) alloca0(sizeof(t)*(n)))
134 #define newdup(t, p, n) ((t*) memdup_multiply(p, sizeof(t), (n)))
136 #define malloc0(n) (calloc((n), 1))
138 static inline const char* yes_no(bool b) {
139 return b ? "yes" : "no";
142 static inline const char* true_false(bool b) {
143 return b ? "true" : "false";
146 static inline const char* strempty(const char *s) {
150 static inline const char* strnull(const char *s) {
151 return s ? s : "(null)";
154 static inline const char *strna(const char *s) {
155 return s ? s : "n/a";
158 static inline bool isempty(const char *p) {
162 static inline char *startswith(const char *s, const char *prefix) {
166 if (strncmp(s, prefix, l) == 0)
167 return (char*) s + l;
172 static inline char *startswith_no_case(const char *s, const char *prefix) {
176 if (strncasecmp(s, prefix, l) == 0)
177 return (char*) s + l;
182 char *endswith(const char *s, const char *postfix) _pure_;
184 char *first_word(const char *s, const char *word) _pure_;
186 int close_nointr(int fd);
187 int safe_close(int fd);
188 void safe_close_pair(int p[]);
190 void close_many(const int fds[], unsigned n_fd);
192 int parse_size(const char *t, off_t base, off_t *size);
194 int parse_boolean(const char *v) _pure_;
195 int parse_pid(const char *s, pid_t* ret_pid);
196 int parse_uid(const char *s, uid_t* ret_uid);
197 #define parse_gid(s, ret_uid) parse_uid(s, ret_uid)
199 int safe_atou(const char *s, unsigned *ret_u);
200 int safe_atoi(const char *s, int *ret_i);
202 int safe_atollu(const char *s, unsigned long long *ret_u);
203 int safe_atolli(const char *s, long long int *ret_i);
205 int safe_atod(const char *s, double *ret_d);
207 int safe_atou8(const char *s, uint8_t *ret);
209 #if LONG_MAX == INT_MAX
210 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
211 assert_cc(sizeof(unsigned long) == sizeof(unsigned));
212 return safe_atou(s, (unsigned*) ret_u);
214 static inline int safe_atoli(const char *s, long int *ret_u) {
215 assert_cc(sizeof(long int) == sizeof(int));
216 return safe_atoi(s, (int*) ret_u);
219 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
220 assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
221 return safe_atollu(s, (unsigned long long*) ret_u);
223 static inline int safe_atoli(const char *s, long int *ret_u) {
224 assert_cc(sizeof(long int) == sizeof(long long int));
225 return safe_atolli(s, (long long int*) ret_u);
229 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
230 assert_cc(sizeof(uint32_t) == sizeof(unsigned));
231 return safe_atou(s, (unsigned*) ret_u);
234 static inline int safe_atoi32(const char *s, int32_t *ret_i) {
235 assert_cc(sizeof(int32_t) == sizeof(int));
236 return safe_atoi(s, (int*) ret_i);
239 static inline int safe_atou64(const char *s, uint64_t *ret_u) {
240 assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
241 return safe_atollu(s, (unsigned long long*) ret_u);
244 static inline int safe_atoi64(const char *s, int64_t *ret_i) {
245 assert_cc(sizeof(int64_t) == sizeof(long long int));
246 return safe_atolli(s, (long long int*) ret_i);
249 int safe_atou16(const char *s, uint16_t *ret);
250 int safe_atoi16(const char *s, int16_t *ret);
252 const char* split(const char **state, size_t *l, const char *separator, bool quoted);
254 #define FOREACH_WORD(word, length, s, state) \
255 _FOREACH_WORD(word, length, s, WHITESPACE, false, state)
257 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state) \
258 _FOREACH_WORD(word, length, s, separator, false, state)
260 #define FOREACH_WORD_QUOTED(word, length, s, state) \
261 _FOREACH_WORD(word, length, s, WHITESPACE, true, state)
263 #define _FOREACH_WORD(word, length, s, separator, quoted, state) \
264 for ((state) = (s), (word) = split(&(state), &(length), (separator), (quoted)); (word); (word) = split(&(state), &(length), (separator), (quoted)))
266 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
268 char *strappend(const char *s, const char *suffix);
269 char *strnappend(const char *s, const char *suffix, size_t length);
271 char *replace_env(const char *format, char **env);
272 char **replace_env_argv(char **argv, char **env);
274 int readlinkat_malloc(int fd, const char *p, char **ret);
275 int readlink_malloc(const char *p, char **r);
276 int readlink_value(const char *p, char **ret);
277 int readlink_and_make_absolute(const char *p, char **r);
278 int readlink_and_canonicalize(const char *p, char **r);
280 int reset_all_signal_handlers(void);
281 int reset_signal_mask(void);
283 char *strstrip(char *s);
284 char *delete_chars(char *s, const char *bad);
285 char *truncate_nl(char *s);
287 char *file_in_same_dir(const char *path, const char *filename);
289 int rmdir_parents(const char *path, const char *stop);
291 int get_process_state(pid_t pid);
292 int get_process_comm(pid_t pid, char **name);
293 int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
294 int get_process_exe(pid_t pid, char **name);
295 int get_process_uid(pid_t pid, uid_t *uid);
296 int get_process_gid(pid_t pid, gid_t *gid);
297 int get_process_capeff(pid_t pid, char **capeff);
298 int get_process_cwd(pid_t pid, char **cwd);
299 int get_process_root(pid_t pid, char **root);
300 int get_process_environ(pid_t pid, char **environ);
302 char hexchar(int x) _const_;
303 int unhexchar(char c) _const_;
304 char octchar(int x) _const_;
305 int unoctchar(char c) _const_;
306 char decchar(int x) _const_;
307 int undecchar(char c) _const_;
309 char *cescape(const char *s);
310 char *cunescape(const char *s);
311 char *cunescape_length(const char *s, size_t length);
312 char *cunescape_length_with_prefix(const char *s, size_t length, const char *prefix);
314 char *xescape(const char *s, const char *bad);
316 char *ascii_strlower(char *path);
318 bool dirent_is_file(const struct dirent *de) _pure_;
319 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix) _pure_;
321 bool hidden_file(const char *filename) _pure_;
323 bool chars_intersect(const char *a, const char *b) _pure_;
325 int make_stdio(int fd);
326 int make_null_stdio(void);
327 int make_console_stdio(void);
329 int dev_urandom(void *p, size_t n);
330 void random_bytes(void *p, size_t n);
331 void initialize_srand(void);
333 static inline uint64_t random_u64(void) {
335 random_bytes(&u, sizeof(u));
339 static inline uint32_t random_u32(void) {
341 random_bytes(&u, sizeof(u));
345 /* For basic lookup tables with strictly enumerated entries */
346 #define __DEFINE_STRING_TABLE_LOOKUP(name,type,scope) \
347 scope const char *name##_to_string(type i) { \
348 if (i < 0 || i >= (type) ELEMENTSOF(name##_table)) \
350 return name##_table[i]; \
352 scope type name##_from_string(const char *s) { \
356 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
357 if (name##_table[i] && \
358 streq(name##_table[i], s)) \
362 struct __useless_struct_to_allow_trailing_semicolon__
364 #define DEFINE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,)
365 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,static)
367 /* For string conversions where numbers are also acceptable */
368 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max) \
369 int name##_to_string_alloc(type i, char **str) { \
372 if (i < 0 || i > max) \
374 if (i < (type) ELEMENTSOF(name##_table)) { \
375 s = strdup(name##_table[i]); \
379 r = asprintf(&s, "%u", i); \
386 type name##_from_string(const char *s) { \
390 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
391 if (name##_table[i] && \
392 streq(name##_table[i], s)) \
394 if (safe_atou(s, &u) >= 0 && u <= max) \
398 struct __useless_struct_to_allow_trailing_semicolon__
400 int fd_nonblock(int fd, bool nonblock);
401 int fd_cloexec(int fd, bool cloexec);
403 int close_all_fds(const int except[], unsigned n_except);
405 bool fstype_is_network(const char *fstype);
409 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
410 int ask_char(char *ret, const char *replies, const char *text, ...) _printf_(3, 4);
411 int ask_string(char **ret, const char *text, ...) _printf_(2, 3);
413 int reset_terminal_fd(int fd, bool switch_to_text);
414 int reset_terminal(const char *name);
416 int open_terminal(const char *name, int mode);
417 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
418 int release_terminal(void);
420 int flush_fd(int fd);
422 int ignore_signals(int sig, ...);
423 int default_signals(int sig, ...);
424 int sigaction_many(const struct sigaction *sa, ...);
426 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
428 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
429 int loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
431 bool is_device_path(const char *path);
433 int dir_is_empty(const char *path);
434 char* dirname_malloc(const char *path);
436 void rename_process(const char name[8]);
438 void sigset_add_many(sigset_t *ss, ...);
439 int sigprocmask_many(int how, ...);
441 bool hostname_is_set(void);
443 char* lookup_uid(uid_t uid);
444 char* gethostname_malloc(void);
445 char* getlogname_malloc(void);
446 char* getusername_malloc(void);
448 int getttyname_malloc(int fd, char **r);
449 int getttyname_harder(int fd, char **r);
451 int get_ctty_devnr(pid_t pid, dev_t *d);
452 int get_ctty(pid_t, dev_t *_devnr, char **r);
454 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
455 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
457 int is_fd_on_temporary_fs(int fd);
459 int rm_rf_children(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
460 int rm_rf_children_dangerous(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
461 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
462 int rm_rf_dangerous(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
464 int pipe_eof(int fd);
466 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
468 int status_vprintf(const char *status, bool ellipse, bool ephemeral, const char *format, va_list ap) _printf_(4,0);
469 int status_printf(const char *status, bool ellipse, bool ephemeral, const char *format, ...) _printf_(4,5);
471 int fd_columns(int fd);
472 unsigned columns(void);
473 int fd_lines(int fd);
474 unsigned lines(void);
475 void columns_lines_cache_reset(int _unused_ signum);
479 static inline const char *ansi_highlight(void) {
480 return on_tty() ? ANSI_HIGHLIGHT_ON : "";
483 static inline const char *ansi_highlight_red(void) {
484 return on_tty() ? ANSI_HIGHLIGHT_RED_ON : "";
487 static inline const char *ansi_highlight_green(void) {
488 return on_tty() ? ANSI_HIGHLIGHT_GREEN_ON : "";
491 static inline const char *ansi_highlight_yellow(void) {
492 return on_tty() ? ANSI_HIGHLIGHT_YELLOW_ON : "";
495 static inline const char *ansi_highlight_blue(void) {
496 return on_tty() ? ANSI_HIGHLIGHT_BLUE_ON : "";
499 static inline const char *ansi_highlight_off(void) {
500 return on_tty() ? ANSI_HIGHLIGHT_OFF : "";
503 int files_same(const char *filea, const char *fileb);
505 int running_in_chroot(void);
507 char *ellipsize(const char *s, size_t length, unsigned percent);
509 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
511 int touch_file(const char *path, bool parents, usec_t stamp, uid_t uid, gid_t gid, mode_t mode);
512 int touch(const char *path);
514 char *unquote(const char *s, const char *quotes);
515 char *normalize_env_assignment(const char *s);
517 int wait_for_terminate(pid_t pid, siginfo_t *status);
518 int wait_for_terminate_and_warn(const char *name, pid_t pid, bool check_exit_code);
520 noreturn void freeze(void);
522 bool null_or_empty(struct stat *st) _pure_;
523 int null_or_empty_path(const char *fn);
524 int null_or_empty_fd(int fd);
526 DIR *xopendirat(int dirfd, const char *name, int flags);
528 char *fstab_node_to_udev_node(const char *p);
530 char *resolve_dev_console(char **active);
531 bool tty_is_vc(const char *tty);
532 bool tty_is_vc_resolve(const char *tty);
533 bool tty_is_console(const char *tty) _pure_;
534 int vtnr_from_tty(const char *tty);
535 const char *default_term_for_tty(const char *tty);
537 void execute_directory(const char *directory, DIR *_d, usec_t timeout, char *argv[]);
539 int kill_and_sigcont(pid_t pid, int sig);
541 bool nulstr_contains(const char*nulstr, const char *needle);
543 bool plymouth_running(void);
545 bool hostname_is_valid(const char *s) _pure_;
546 char* hostname_cleanup(char *s, bool lowercase);
548 bool machine_name_is_valid(const char *s) _pure_;
549 bool image_name_is_valid(const char *s) _pure_;
551 char* strshorten(char *s, size_t l);
553 int terminal_vhangup_fd(int fd);
554 int terminal_vhangup(const char *name);
556 int vt_disallocate(const char *name);
558 int symlink_atomic(const char *from, const char *to);
559 int mknod_atomic(const char *path, mode_t mode, dev_t dev);
560 int mkfifo_atomic(const char *path, mode_t mode);
562 int fchmod_umask(int fd, mode_t mode);
564 bool display_is_local(const char *display) _pure_;
565 int socket_from_display(const char *display, char **path);
567 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
568 int get_group_creds(const char **groupname, gid_t *gid);
570 int in_gid(gid_t gid);
571 int in_group(const char *name);
573 char* uid_to_name(uid_t uid);
574 char* gid_to_name(gid_t gid);
576 int glob_exists(const char *path);
577 int glob_extend(char ***strv, const char *path);
579 int dirent_ensure_type(DIR *d, struct dirent *de);
581 int get_files_in_directory(const char *path, char ***list);
583 char *strjoin(const char *x, ...) _sentinel_;
585 bool is_main_thread(void);
587 static inline bool _pure_ in_charset(const char *s, const char* charset) {
590 return s[strspn(s, charset)] == '\0';
593 int block_get_whole_disk(dev_t d, dev_t *ret);
595 #define NULSTR_FOREACH(i, l) \
596 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
598 #define NULSTR_FOREACH_PAIR(i, j, l) \
599 for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
601 int ioprio_class_to_string_alloc(int i, char **s);
602 int ioprio_class_from_string(const char *s);
604 const char *sigchld_code_to_string(int i) _const_;
605 int sigchld_code_from_string(const char *s) _pure_;
607 int log_facility_unshifted_to_string_alloc(int i, char **s);
608 int log_facility_unshifted_from_string(const char *s);
610 int log_level_to_string_alloc(int i, char **s);
611 int log_level_from_string(const char *s);
613 int sched_policy_to_string_alloc(int i, char **s);
614 int sched_policy_from_string(const char *s);
616 const char *rlimit_to_string(int i) _const_;
617 int rlimit_from_string(const char *s) _pure_;
619 int ip_tos_to_string_alloc(int i, char **s);
620 int ip_tos_from_string(const char *s);
622 const char *signal_to_string(int i) _const_;
623 int signal_from_string(const char *s) _pure_;
625 int signal_from_string_try_harder(const char *s);
627 extern int saved_argc;
628 extern char **saved_argv;
630 bool kexec_loaded(void);
632 int prot_from_flags(int flags) _const_;
634 char *format_bytes(char *buf, size_t l, off_t t);
636 int fd_wait_for_event(int fd, int event, usec_t timeout);
638 void* memdup(const void *p, size_t l) _alloc_(2);
640 int is_kernel_thread(pid_t pid);
642 int fd_inc_sndbuf(int fd, size_t n);
643 int fd_inc_rcvbuf(int fd, size_t n);
645 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
647 int setrlimit_closest(int resource, const struct rlimit *rlim);
649 int getenv_for_pid(pid_t pid, const char *field, char **_value);
651 bool is_valid_documentation_url(const char *url) _pure_;
653 bool in_initrd(void);
655 void warn_melody(void);
657 int get_home_dir(char **ret);
658 int get_shell(char **_ret);
660 static inline void freep(void *p) {
664 #define DEFINE_TRIVIAL_CLEANUP_FUNC(type, func) \
665 static inline void func##p(type *p) { \
669 struct __useless_struct_to_allow_trailing_semicolon__
671 static inline void closep(int *fd) {
675 static inline void umaskp(mode_t *u) {
679 static inline void close_pairp(int (*p)[2]) {
683 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, fclose);
684 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, pclose);
685 DEFINE_TRIVIAL_CLEANUP_FUNC(DIR*, closedir);
686 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, endmntent);
688 #define _cleanup_free_ _cleanup_(freep)
689 #define _cleanup_close_ _cleanup_(closep)
690 #define _cleanup_umask_ _cleanup_(umaskp)
691 #define _cleanup_globfree_ _cleanup_(globfree)
692 #define _cleanup_fclose_ _cleanup_(fclosep)
693 #define _cleanup_pclose_ _cleanup_(pclosep)
694 #define _cleanup_closedir_ _cleanup_(closedirp)
695 #define _cleanup_endmntent_ _cleanup_(endmntentp)
696 #define _cleanup_close_pair_ _cleanup_(close_pairp)
698 _malloc_ _alloc_(1, 2) static inline void *malloc_multiply(size_t a, size_t b) {
699 if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
702 return malloc(a * b);
705 _alloc_(2, 3) static inline void *realloc_multiply(void *p, size_t a, size_t b) {
706 if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
709 return realloc(p, a * b);
712 _alloc_(2, 3) static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
713 if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
716 return memdup(p, a * b);
719 bool filename_is_valid(const char *p) _pure_;
720 bool path_is_safe(const char *p) _pure_;
721 bool string_is_safe(const char *p) _pure_;
722 bool string_has_cc(const char *p, const char *ok) _pure_;
725 * Check if a string contains any glob patterns.
727 _pure_ static inline bool string_is_glob(const char *p) {
728 return !!strpbrk(p, GLOB_CHARS);
731 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
732 int (*compar) (const void *, const void *, void *),
735 bool is_locale_utf8(void);
737 typedef enum DrawSpecialChar {
742 DRAW_TRIANGULAR_BULLET,
746 _DRAW_SPECIAL_CHAR_MAX
749 const char *draw_special_char(DrawSpecialChar ch);
751 char *strreplace(const char *text, const char *old_string, const char *new_string);
753 char *strip_tab_ansi(char **p, size_t *l);
755 int on_ac_power(void);
757 int search_and_fopen(const char *path, const char *mode, const char *root, const char **search, FILE **_f);
758 int search_and_fopen_nulstr(const char *path, const char *mode, const char *root, const char *search, FILE **_f);
760 #define FOREACH_LINE(line, f, on_error) \
762 if (!fgets(line, sizeof(line), f)) { \
769 #define FOREACH_DIRENT(de, d, on_error) \
770 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
776 } else if (hidden_file((de)->d_name)) \
780 #define FOREACH_DIRENT_ALL(de, d, on_error) \
781 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
789 static inline void *mempset(void *s, int c, size_t n) {
791 return (uint8_t*)s + n;
794 char *hexmem(const void *p, size_t l);
795 void *unhexmem(const char *p, size_t l);
797 char *strextend(char **x, ...) _sentinel_;
798 char *strrep(const char *s, unsigned n);
800 void* greedy_realloc(void **p, size_t *allocated, size_t need, size_t size);
801 void* greedy_realloc0(void **p, size_t *allocated, size_t need, size_t size);
802 #define GREEDY_REALLOC(array, allocated, need) \
803 greedy_realloc((void**) &(array), &(allocated), (need), sizeof((array)[0]))
805 #define GREEDY_REALLOC0(array, allocated, need) \
806 greedy_realloc0((void**) &(array), &(allocated), (need), sizeof((array)[0]))
808 static inline void _reset_errno_(int *saved_errno) {
809 errno = *saved_errno;
812 #define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
814 static inline int negative_errno(void) {
815 /* This helper should be used to shut up gcc if you know 'errno' is
816 * negative. Instead of "return -errno;", use "return negative_errno();"
817 * It will suppress bogus gcc warnings in case it assumes 'errno' might
818 * be 0 and thus the caller's error-handling might not be triggered. */
819 assert_return(errno > 0, -EINVAL);
823 struct _umask_struct_ {
828 static inline void _reset_umask_(struct _umask_struct_ *s) {
832 #define RUN_WITH_UMASK(mask) \
833 for (_cleanup_(_reset_umask_) struct _umask_struct_ _saved_umask_ = { umask(mask), false }; \
834 !_saved_umask_.quit ; \
835 _saved_umask_.quit = true)
837 static inline unsigned u64log2(uint64_t n) {
838 #if __SIZEOF_LONG_LONG__ == 8
839 return (n > 1) ? (unsigned) __builtin_clzll(n) ^ 63U : 0;
845 static inline unsigned u32ctz(uint32_t n) {
846 #if __SIZEOF_INT__ == 4
847 return __builtin_ctz(n);
853 static inline int log2i(int x) {
856 return __SIZEOF_INT__ * 8 - __builtin_clz(x) - 1;
859 static inline unsigned log2u(unsigned x) {
862 return sizeof(unsigned) * 8 - __builtin_clz(x) - 1;
865 static inline unsigned log2u_round_up(unsigned x) {
871 return log2u(x - 1) + 1;
874 static inline bool logind_running(void) {
875 return access("/run/systemd/seats/", F_OK) >= 0;
878 #define DECIMAL_STR_WIDTH(x) \
880 typeof(x) _x_ = (x); \
887 int unlink_noerrno(const char *path);
893 _new_ = alloca(_len_); \
894 (void *) memset(_new_, 0, _len_); \
897 /* It's not clear what alignment glibc/gcc alloca() guarantee, hence provide a guaranteed safe version */
898 #define alloca_align(size, align) \
901 size_t _mask_ = (align) - 1; \
902 _ptr_ = alloca((size) + _mask_); \
903 (void*)(((uintptr_t)_ptr_ + _mask_) & ~_mask_); \
906 #define alloca0_align(size, align) \
909 size_t _size_ = (size); \
910 _new_ = alloca_align(_size_, (align)); \
911 (void*)memset(_new_, 0, _size_); \
914 #define strappenda(a, ...) \
916 int _len = strlen(a); \
919 const char *_appendees_[] = { __VA_ARGS__ }; \
920 for (_i = 0; _i < ELEMENTSOF(_appendees_); _i++) \
921 _len += strlen(_appendees_[_i]); \
922 _d_ = alloca(_len + 1); \
923 _p_ = stpcpy(_d_, a); \
924 for (_i = 0; _i < ELEMENTSOF(_appendees_); _i++) \
925 _p_ = stpcpy(_p_, _appendees_[_i]); \
929 #define procfs_file_alloca(pid, field) \
931 pid_t _pid_ = (pid); \
934 _r_ = ("/proc/self/" field); \
936 _r_ = alloca(strlen("/proc/") + DECIMAL_STR_MAX(pid_t) + 1 + sizeof(field)); \
937 sprintf((char*) _r_, "/proc/"PID_FMT"/" field, _pid_); \
942 struct _locale_struct_ {
943 locale_t saved_locale;
948 static inline void _reset_locale_(struct _locale_struct_ *s) {
950 if (s->saved_locale != (locale_t) 0)
951 uselocale(s->saved_locale);
952 if (s->new_locale != (locale_t) 0)
953 freelocale(s->new_locale);
956 #define RUN_WITH_LOCALE(mask, loc) \
957 for (_cleanup_(_reset_locale_) struct _locale_struct_ _saved_locale_ = { (locale_t) 0, (locale_t) 0, false }; \
959 if (!_saved_locale_.quit) { \
961 _saved_locale_.new_locale = newlocale((mask), (loc), (locale_t) 0); \
962 if (_saved_locale_.new_locale != (locale_t) 0) \
963 _saved_locale_.saved_locale = uselocale(_saved_locale_.new_locale); \
965 !_saved_locale_.quit; }) ; \
966 _saved_locale_.quit = true)
968 bool id128_is_valid(const char *s) _pure_;
970 int split_pair(const char *s, const char *sep, char **l, char **r);
972 int shall_restore_state(void);
975 * Normal qsort requires base to be nonnull. Here were require
976 * that only if nmemb > 0.
978 static inline void qsort_safe(void *base, size_t nmemb, size_t size,
979 int (*compar)(const void *, const void *)) {
982 qsort(base, nmemb, size, compar);
986 int proc_cmdline(char **ret);
987 int parse_proc_cmdline(int (*parse_word)(const char *key, const char *value));
988 int get_proc_cmdline_key(const char *parameter, char **value);
990 int container_get_leader(const char *machine, pid_t *pid);
992 int namespace_open(pid_t pid, int *pidns_fd, int *mntns_fd, int *netns_fd, int *root_fd);
993 int namespace_enter(int pidns_fd, int mntns_fd, int netns_fd, int root_fd);
995 bool pid_is_alive(pid_t pid);
996 bool pid_is_unwaited(pid_t pid);
998 int getpeercred(int fd, struct ucred *ucred);
999 int getpeersec(int fd, char **ret);
1001 int writev_safe(int fd, const struct iovec *w, int j);
1003 int mkostemp_safe(char *pattern, int flags);
1004 int open_tmpfile(const char *path, int flags);
1006 int fd_warn_permissions(const char *path, int fd);
1008 unsigned long personality_from_string(const char *p);
1009 const char *personality_to_string(unsigned long);
1011 uint64_t physical_memory(void);
1013 char* mount_test_option(const char *haystack, const char *needle);
1015 void hexdump(FILE *f, const void *p, size_t s);
1017 union file_handle_union {
1018 struct file_handle handle;
1019 char padding[sizeof(struct file_handle) + MAX_HANDLE_SZ];
1022 int update_reboot_param_file(const char *param);
1024 int umount_recursive(const char *target, int flags);
1026 int bind_remount_recursive(const char *prefix, bool ro);
1028 int fflush_and_check(FILE *f);
1030 int tempfn_xxxxxx(const char *p, char **ret);
1031 int tempfn_random(const char *p, char **ret);
1032 int tempfn_random_child(const char *p, char **ret);
1034 bool is_localhost(const char *hostname);
1036 int take_password_lock(const char *root);
1038 int is_symlink(const char *path);
1039 int is_dir(const char *path, bool follow);
1041 int unquote_first_word(const char **p, char **ret, bool relax);
1042 int unquote_many_words(const char **p, ...) _sentinel_;
1044 int free_and_strdup(char **p, const char *s);
1046 int sethostname_idempotent(const char *s);
1048 #define INOTIFY_EVENT_MAX (sizeof(struct inotify_event) + NAME_MAX + 1)
1050 #define FOREACH_INOTIFY_EVENT(e, buffer, sz) \
1051 for ((e) = &buffer.ev; \
1052 (uint8_t*) (e) < (uint8_t*) (buffer.raw) + (sz); \
1053 (e) = (struct inotify_event*) ((uint8_t*) (e) + sizeof(struct inotify_event) + (e)->len))
1055 union inotify_event_buffer {
1056 struct inotify_event ev;
1057 uint8_t raw[INOTIFY_EVENT_MAX];
1060 #define laccess(path, mode) faccessat(AT_FDCWD, (path), (mode), AT_SYMLINK_NOFOLLOW)
1062 int ptsname_malloc(int fd, char **ret);
1064 int openpt_in_namespace(pid_t pid, int flags);
1066 ssize_t fgetxattrat_fake(int dirfd, const char *filename, const char *attribute, void *value, size_t size, int flags);
1068 int fd_setcrtime(int fd, usec_t usec);
1069 int fd_getcrtime(int fd, usec_t *usec);
1070 int path_getcrtime(const char *p, usec_t *usec);
1071 int fd_getcrtime_at(int dirfd, const char *name, usec_t *usec, int flags);
1073 int same_fd(int a, int b);