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_PRI PRIi32
49 #elif SIZEOF_PID_T == 2
50 # define PID_PRI PRIi16
52 # error Unknown pid_t size
54 #define PID_FMT "%" PID_PRI
57 # define UID_FMT "%" PRIu32
58 #elif SIZEOF_UID_T == 2
59 # define UID_FMT "%" PRIu16
61 # error Unknown uid_t size
65 # define GID_FMT "%" PRIu32
66 #elif SIZEOF_GID_T == 2
67 # define GID_FMT "%" PRIu16
69 # error Unknown gid_t size
72 #if SIZEOF_TIME_T == 8
73 # define PRI_TIME PRIi64
74 #elif SIZEOF_TIME_T == 4
75 # define PRI_TIME PRIu32
77 # error Unknown time_t size
80 #if SIZEOF_RLIM_T == 8
81 # define RLIM_FMT "%" PRIu64
82 #elif SIZEOF_RLIM_T == 4
83 # define RLIM_FMT "%" PRIu32
85 # error Unknown rlim_t size
90 #include "time-util.h"
92 /* What is interpreted as whitespace? */
93 #define WHITESPACE " \t\n\r"
94 #define NEWLINE "\n\r"
97 #define GLOB_CHARS "*?["
99 /* What characters are special in the shell? */
100 /* must be escaped outside and inside double-quotes */
101 #define SHELL_NEED_ESCAPE "\"\\`$"
102 /* can be escaped or double-quoted */
103 #define SHELL_NEED_QUOTES SHELL_NEED_ESCAPE GLOB_CHARS "'()<>|&;"
105 #define FORMAT_BYTES_MAX 8
107 #define ANSI_HIGHLIGHT_ON "\x1B[1;39m"
108 #define ANSI_RED_ON "\x1B[31m"
109 #define ANSI_HIGHLIGHT_RED_ON "\x1B[1;31m"
110 #define ANSI_GREEN_ON "\x1B[32m"
111 #define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
112 #define ANSI_HIGHLIGHT_YELLOW_ON "\x1B[1;33m"
113 #define ANSI_HIGHLIGHT_BLUE_ON "\x1B[1;34m"
114 #define ANSI_HIGHLIGHT_OFF "\x1B[0m"
115 #define ANSI_ERASE_TO_END_OF_LINE "\x1B[K"
117 size_t page_size(void) _pure_;
118 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
120 #define streq(a,b) (strcmp((a),(b)) == 0)
121 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
122 #define strcaseeq(a,b) (strcasecmp((a),(b)) == 0)
123 #define strncaseeq(a, b, n) (strncasecmp((a), (b), (n)) == 0)
125 bool streq_ptr(const char *a, const char *b) _pure_;
127 #define new(t, n) ((t*) malloc_multiply(sizeof(t), (n)))
129 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
131 #define newa(t, n) ((t*) alloca(sizeof(t)*(n)))
133 #define newa0(t, n) ((t*) alloca0(sizeof(t)*(n)))
135 #define newdup(t, p, n) ((t*) memdup_multiply(p, sizeof(t), (n)))
137 #define malloc0(n) (calloc((n), 1))
139 static inline const char* yes_no(bool b) {
140 return b ? "yes" : "no";
143 static inline const char* true_false(bool b) {
144 return b ? "true" : "false";
147 static inline const char* one_zero(bool b) {
148 return b ? "1" : "0";
151 static inline const char* strempty(const char *s) {
155 static inline const char* strnull(const char *s) {
156 return s ? s : "(null)";
159 static inline const char *strna(const char *s) {
160 return s ? s : "n/a";
163 static inline bool isempty(const char *p) {
167 static inline char *startswith(const char *s, const char *prefix) {
171 if (strncmp(s, prefix, l) == 0)
172 return (char*) s + l;
177 static inline char *startswith_no_case(const char *s, const char *prefix) {
181 if (strncasecmp(s, prefix, l) == 0)
182 return (char*) s + l;
187 char *endswith(const char *s, const char *postfix) _pure_;
189 char *first_word(const char *s, const char *word) _pure_;
191 int close_nointr(int fd);
192 int safe_close(int fd);
193 void safe_close_pair(int p[]);
195 void close_many(const int fds[], unsigned n_fd);
197 int parse_size(const char *t, off_t base, off_t *size);
199 int parse_boolean(const char *v) _pure_;
200 int parse_pid(const char *s, pid_t* ret_pid);
201 int parse_uid(const char *s, uid_t* ret_uid);
202 #define parse_gid(s, ret_uid) parse_uid(s, ret_uid)
204 int safe_atou(const char *s, unsigned *ret_u);
205 int safe_atoi(const char *s, int *ret_i);
207 int safe_atollu(const char *s, unsigned long long *ret_u);
208 int safe_atolli(const char *s, long long int *ret_i);
210 int safe_atod(const char *s, double *ret_d);
212 int safe_atou8(const char *s, uint8_t *ret);
214 #if LONG_MAX == INT_MAX
215 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
216 assert_cc(sizeof(unsigned long) == sizeof(unsigned));
217 return safe_atou(s, (unsigned*) ret_u);
219 static inline int safe_atoli(const char *s, long int *ret_u) {
220 assert_cc(sizeof(long int) == sizeof(int));
221 return safe_atoi(s, (int*) ret_u);
224 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
225 assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
226 return safe_atollu(s, (unsigned long long*) ret_u);
228 static inline int safe_atoli(const char *s, long int *ret_u) {
229 assert_cc(sizeof(long int) == sizeof(long long int));
230 return safe_atolli(s, (long long int*) ret_u);
234 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
235 assert_cc(sizeof(uint32_t) == sizeof(unsigned));
236 return safe_atou(s, (unsigned*) ret_u);
239 static inline int safe_atoi32(const char *s, int32_t *ret_i) {
240 assert_cc(sizeof(int32_t) == sizeof(int));
241 return safe_atoi(s, (int*) ret_i);
244 static inline int safe_atou64(const char *s, uint64_t *ret_u) {
245 assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
246 return safe_atollu(s, (unsigned long long*) ret_u);
249 static inline int safe_atoi64(const char *s, int64_t *ret_i) {
250 assert_cc(sizeof(int64_t) == sizeof(long long int));
251 return safe_atolli(s, (long long int*) ret_i);
254 int safe_atou16(const char *s, uint16_t *ret);
255 int safe_atoi16(const char *s, int16_t *ret);
257 const char* split(const char **state, size_t *l, const char *separator, bool quoted);
259 #define FOREACH_WORD(word, length, s, state) \
260 _FOREACH_WORD(word, length, s, WHITESPACE, false, state)
262 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state) \
263 _FOREACH_WORD(word, length, s, separator, false, state)
265 #define FOREACH_WORD_QUOTED(word, length, s, state) \
266 _FOREACH_WORD(word, length, s, WHITESPACE, true, state)
268 #define _FOREACH_WORD(word, length, s, separator, quoted, state) \
269 for ((state) = (s), (word) = split(&(state), &(length), (separator), (quoted)); (word); (word) = split(&(state), &(length), (separator), (quoted)))
271 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
273 char *strappend(const char *s, const char *suffix);
274 char *strnappend(const char *s, const char *suffix, size_t length);
276 char *replace_env(const char *format, char **env);
277 char **replace_env_argv(char **argv, char **env);
279 int readlinkat_malloc(int fd, const char *p, char **ret);
280 int readlink_malloc(const char *p, char **r);
281 int readlink_value(const char *p, char **ret);
282 int readlink_and_make_absolute(const char *p, char **r);
283 int readlink_and_canonicalize(const char *p, char **r);
285 int reset_all_signal_handlers(void);
286 int reset_signal_mask(void);
288 char *strstrip(char *s);
289 char *delete_chars(char *s, const char *bad);
290 char *truncate_nl(char *s);
292 char *file_in_same_dir(const char *path, const char *filename);
294 int rmdir_parents(const char *path, const char *stop);
296 int get_process_state(pid_t pid);
297 int get_process_comm(pid_t pid, char **name);
298 int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
299 int get_process_exe(pid_t pid, char **name);
300 int get_process_uid(pid_t pid, uid_t *uid);
301 int get_process_gid(pid_t pid, gid_t *gid);
302 int get_process_capeff(pid_t pid, char **capeff);
303 int get_process_cwd(pid_t pid, char **cwd);
304 int get_process_root(pid_t pid, char **root);
305 int get_process_environ(pid_t pid, char **environ);
307 char hexchar(int x) _const_;
308 int unhexchar(char c) _const_;
309 char octchar(int x) _const_;
310 int unoctchar(char c) _const_;
311 char decchar(int x) _const_;
312 int undecchar(char c) _const_;
314 char *cescape(const char *s);
315 char *cunescape(const char *s);
316 char *cunescape_length(const char *s, size_t length);
317 char *cunescape_length_with_prefix(const char *s, size_t length, const char *prefix);
319 char *xescape(const char *s, const char *bad);
321 char *ascii_strlower(char *path);
323 bool dirent_is_file(const struct dirent *de) _pure_;
324 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix) _pure_;
326 bool hidden_file(const char *filename) _pure_;
328 bool chars_intersect(const char *a, const char *b) _pure_;
330 int make_stdio(int fd);
331 int make_null_stdio(void);
332 int make_console_stdio(void);
334 int dev_urandom(void *p, size_t n);
335 void random_bytes(void *p, size_t n);
336 void initialize_srand(void);
338 static inline uint64_t random_u64(void) {
340 random_bytes(&u, sizeof(u));
344 static inline uint32_t random_u32(void) {
346 random_bytes(&u, sizeof(u));
350 /* For basic lookup tables with strictly enumerated entries */
351 #define __DEFINE_STRING_TABLE_LOOKUP(name,type,scope) \
352 scope const char *name##_to_string(type i) { \
353 if (i < 0 || i >= (type) ELEMENTSOF(name##_table)) \
355 return name##_table[i]; \
357 scope type name##_from_string(const char *s) { \
361 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
362 if (name##_table[i] && \
363 streq(name##_table[i], s)) \
367 struct __useless_struct_to_allow_trailing_semicolon__
369 #define DEFINE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,)
370 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,static)
372 /* For string conversions where numbers are also acceptable */
373 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max) \
374 int name##_to_string_alloc(type i, char **str) { \
377 if (i < 0 || i > max) \
379 if (i < (type) ELEMENTSOF(name##_table)) { \
380 s = strdup(name##_table[i]); \
384 r = asprintf(&s, "%i", i); \
391 type name##_from_string(const char *s) { \
395 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
396 if (name##_table[i] && \
397 streq(name##_table[i], s)) \
399 if (safe_atou(s, &u) >= 0 && u <= max) \
403 struct __useless_struct_to_allow_trailing_semicolon__
405 int fd_nonblock(int fd, bool nonblock);
406 int fd_cloexec(int fd, bool cloexec);
408 int close_all_fds(const int except[], unsigned n_except);
410 bool fstype_is_network(const char *fstype);
414 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
415 int ask_char(char *ret, const char *replies, const char *text, ...) _printf_(3, 4);
416 int ask_string(char **ret, const char *text, ...) _printf_(2, 3);
418 int reset_terminal_fd(int fd, bool switch_to_text);
419 int reset_terminal(const char *name);
421 int open_terminal(const char *name, int mode);
422 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
423 int release_terminal(void);
425 int flush_fd(int fd);
427 int ignore_signals(int sig, ...);
428 int default_signals(int sig, ...);
429 int sigaction_many(const struct sigaction *sa, ...);
431 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
433 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
434 int loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
436 bool is_device_path(const char *path);
438 int dir_is_empty(const char *path);
439 char* dirname_malloc(const char *path);
441 void rename_process(const char name[8]);
443 void sigset_add_many(sigset_t *ss, ...);
444 int sigprocmask_many(int how, ...);
446 bool hostname_is_set(void);
448 char* lookup_uid(uid_t uid);
449 char* gethostname_malloc(void);
450 char* getlogname_malloc(void);
451 char* getusername_malloc(void);
453 int getttyname_malloc(int fd, char **r);
454 int getttyname_harder(int fd, char **r);
456 int get_ctty_devnr(pid_t pid, dev_t *d);
457 int get_ctty(pid_t, dev_t *_devnr, char **r);
459 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
460 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
462 int is_fd_on_temporary_fs(int fd);
464 int rm_rf_children(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
465 int rm_rf_children_dangerous(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
466 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
467 int rm_rf_dangerous(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
469 int pipe_eof(int fd);
471 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
473 int status_vprintf(const char *status, bool ellipse, bool ephemeral, const char *format, va_list ap) _printf_(4,0);
474 int status_printf(const char *status, bool ellipse, bool ephemeral, const char *format, ...) _printf_(4,5);
476 int fd_columns(int fd);
477 unsigned columns(void);
478 int fd_lines(int fd);
479 unsigned lines(void);
480 void columns_lines_cache_reset(int _unused_ signum);
484 static inline const char *ansi_highlight(void) {
485 return on_tty() ? ANSI_HIGHLIGHT_ON : "";
488 static inline const char *ansi_highlight_red(void) {
489 return on_tty() ? ANSI_HIGHLIGHT_RED_ON : "";
492 static inline const char *ansi_highlight_green(void) {
493 return on_tty() ? ANSI_HIGHLIGHT_GREEN_ON : "";
496 static inline const char *ansi_highlight_yellow(void) {
497 return on_tty() ? ANSI_HIGHLIGHT_YELLOW_ON : "";
500 static inline const char *ansi_highlight_blue(void) {
501 return on_tty() ? ANSI_HIGHLIGHT_BLUE_ON : "";
504 static inline const char *ansi_highlight_off(void) {
505 return on_tty() ? ANSI_HIGHLIGHT_OFF : "";
508 int files_same(const char *filea, const char *fileb);
510 int running_in_chroot(void);
512 char *ellipsize(const char *s, size_t length, unsigned percent);
514 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
516 int touch_file(const char *path, bool parents, usec_t stamp, uid_t uid, gid_t gid, mode_t mode);
517 int touch(const char *path);
519 char *unquote(const char *s, const char *quotes);
520 char *normalize_env_assignment(const char *s);
522 int wait_for_terminate(pid_t pid, siginfo_t *status);
523 int wait_for_terminate_and_warn(const char *name, pid_t pid, bool check_exit_code);
525 noreturn void freeze(void);
527 bool null_or_empty(struct stat *st) _pure_;
528 int null_or_empty_path(const char *fn);
529 int null_or_empty_fd(int fd);
531 DIR *xopendirat(int dirfd, const char *name, int flags);
533 char *fstab_node_to_udev_node(const char *p);
535 char *resolve_dev_console(char **active);
536 bool tty_is_vc(const char *tty);
537 bool tty_is_vc_resolve(const char *tty);
538 bool tty_is_console(const char *tty) _pure_;
539 int vtnr_from_tty(const char *tty);
540 const char *default_term_for_tty(const char *tty);
542 void execute_directories(const char* const* directories, usec_t timeout, char *argv[]);
544 int kill_and_sigcont(pid_t pid, int sig);
546 bool nulstr_contains(const char*nulstr, const char *needle);
548 bool plymouth_running(void);
550 bool hostname_is_valid(const char *s) _pure_;
551 char* hostname_cleanup(char *s, bool lowercase);
553 bool machine_name_is_valid(const char *s) _pure_;
555 char* strshorten(char *s, size_t l);
557 int terminal_vhangup_fd(int fd);
558 int terminal_vhangup(const char *name);
560 int vt_disallocate(const char *name);
562 int symlink_atomic(const char *from, const char *to);
563 int mknod_atomic(const char *path, mode_t mode, dev_t dev);
564 int mkfifo_atomic(const char *path, mode_t mode);
566 int fchmod_umask(int fd, mode_t mode);
568 bool display_is_local(const char *display) _pure_;
569 int socket_from_display(const char *display, char **path);
571 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
572 int get_group_creds(const char **groupname, gid_t *gid);
574 int in_gid(gid_t gid);
575 int in_group(const char *name);
577 char* uid_to_name(uid_t uid);
578 char* gid_to_name(gid_t gid);
580 int glob_exists(const char *path);
581 int glob_extend(char ***strv, const char *path);
583 int dirent_ensure_type(DIR *d, struct dirent *de);
585 int get_files_in_directory(const char *path, char ***list);
587 char *strjoin(const char *x, ...) _sentinel_;
589 bool is_main_thread(void);
591 static inline bool _pure_ in_charset(const char *s, const char* charset) {
594 return s[strspn(s, charset)] == '\0';
597 int block_get_whole_disk(dev_t d, dev_t *ret);
599 #define NULSTR_FOREACH(i, l) \
600 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
602 #define NULSTR_FOREACH_PAIR(i, j, l) \
603 for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
605 int ioprio_class_to_string_alloc(int i, char **s);
606 int ioprio_class_from_string(const char *s);
608 const char *sigchld_code_to_string(int i) _const_;
609 int sigchld_code_from_string(const char *s) _pure_;
611 int log_facility_unshifted_to_string_alloc(int i, char **s);
612 int log_facility_unshifted_from_string(const char *s);
614 int log_level_to_string_alloc(int i, char **s);
615 int log_level_from_string(const char *s);
617 int sched_policy_to_string_alloc(int i, char **s);
618 int sched_policy_from_string(const char *s);
620 const char *rlimit_to_string(int i) _const_;
621 int rlimit_from_string(const char *s) _pure_;
623 int ip_tos_to_string_alloc(int i, char **s);
624 int ip_tos_from_string(const char *s);
626 const char *signal_to_string(int i) _const_;
627 int signal_from_string(const char *s) _pure_;
629 int signal_from_string_try_harder(const char *s);
631 extern int saved_argc;
632 extern char **saved_argv;
634 bool kexec_loaded(void);
636 int prot_from_flags(int flags) _const_;
638 char *format_bytes(char *buf, size_t l, off_t t);
640 int fd_wait_for_event(int fd, int event, usec_t timeout);
642 void* memdup(const void *p, size_t l) _alloc_(2);
644 int is_kernel_thread(pid_t pid);
646 int fd_inc_sndbuf(int fd, size_t n);
647 int fd_inc_rcvbuf(int fd, size_t n);
649 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
651 int setrlimit_closest(int resource, const struct rlimit *rlim);
653 int getenv_for_pid(pid_t pid, const char *field, char **_value);
655 bool http_url_is_valid(const char *url) _pure_;
656 bool documentation_url_is_valid(const char *url) _pure_;
658 bool http_etag_is_valid(const char *etag);
660 bool in_initrd(void);
662 void warn_melody(void);
664 int get_home_dir(char **ret);
665 int get_shell(char **_ret);
667 static inline void freep(void *p) {
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 bool id128_is_valid(const char *s) _pure_;
944 int split_pair(const char *s, const char *sep, char **l, char **r);
946 int shall_restore_state(void);
949 * Normal qsort requires base to be nonnull. Here were require
950 * that only if nmemb > 0.
952 static inline void qsort_safe(void *base, size_t nmemb, size_t size,
953 int (*compar)(const void *, const void *)) {
956 qsort(base, nmemb, size, compar);
960 int proc_cmdline(char **ret);
961 int parse_proc_cmdline(int (*parse_word)(const char *key, const char *value));
962 int get_proc_cmdline_key(const char *parameter, char **value);
964 int container_get_leader(const char *machine, pid_t *pid);
966 int namespace_open(pid_t pid, int *pidns_fd, int *mntns_fd, int *netns_fd, int *root_fd);
967 int namespace_enter(int pidns_fd, int mntns_fd, int netns_fd, int root_fd);
969 bool pid_is_alive(pid_t pid);
970 bool pid_is_unwaited(pid_t pid);
972 int getpeercred(int fd, struct ucred *ucred);
973 int getpeersec(int fd, char **ret);
975 int writev_safe(int fd, const struct iovec *w, int j);
977 int mkostemp_safe(char *pattern, int flags);
978 int open_tmpfile(const char *path, int flags);
980 int fd_warn_permissions(const char *path, int fd);
982 unsigned long personality_from_string(const char *p);
983 const char *personality_to_string(unsigned long);
985 uint64_t physical_memory(void);
987 void hexdump(FILE *f, const void *p, size_t s);
989 union file_handle_union {
990 struct file_handle handle;
991 char padding[sizeof(struct file_handle) + MAX_HANDLE_SZ];
993 #define FILE_HANDLE_INIT { .handle.handle_bytes = MAX_HANDLE_SZ }
995 int update_reboot_param_file(const char *param);
997 int umount_recursive(const char *target, int flags);
999 int bind_remount_recursive(const char *prefix, bool ro);
1001 int fflush_and_check(FILE *f);
1003 int tempfn_xxxxxx(const char *p, char **ret);
1004 int tempfn_random(const char *p, char **ret);
1005 int tempfn_random_child(const char *p, char **ret);
1007 bool is_localhost(const char *hostname);
1009 int take_password_lock(const char *root);
1011 int is_symlink(const char *path);
1012 int is_dir(const char *path, bool follow);
1014 int unquote_first_word(const char **p, char **ret, bool relax);
1015 int unquote_many_words(const char **p, ...) _sentinel_;
1017 int free_and_strdup(char **p, const char *s);
1019 int sethostname_idempotent(const char *s);
1021 #define INOTIFY_EVENT_MAX (sizeof(struct inotify_event) + NAME_MAX + 1)
1023 #define FOREACH_INOTIFY_EVENT(e, buffer, sz) \
1024 for ((e) = &buffer.ev; \
1025 (uint8_t*) (e) < (uint8_t*) (buffer.raw) + (sz); \
1026 (e) = (struct inotify_event*) ((uint8_t*) (e) + sizeof(struct inotify_event) + (e)->len))
1028 union inotify_event_buffer {
1029 struct inotify_event ev;
1030 uint8_t raw[INOTIFY_EVENT_MAX];
1033 #define laccess(path, mode) faccessat(AT_FDCWD, (path), (mode), AT_SYMLINK_NOFOLLOW)
1035 int ptsname_malloc(int fd, char **ret);
1037 int openpt_in_namespace(pid_t pid, int flags);
1039 ssize_t fgetxattrat_fake(int dirfd, const char *filename, const char *attribute, void *value, size_t size, int flags);
1041 int fd_setcrtime(int fd, usec_t usec);
1042 int fd_getcrtime(int fd, usec_t *usec);
1043 int path_getcrtime(const char *p, usec_t *usec);
1044 int fd_getcrtime_at(int dirfd, const char *name, usec_t *usec, int flags);
1046 int same_fd(int a, int b);
1048 int chattr_fd(int fd, bool b, unsigned mask);
1049 int chattr_path(const char *p, bool b, unsigned mask);
1051 int read_attr_fd(int fd, unsigned *ret);
1052 int read_attr_path(const char *p, unsigned *ret);
1054 typedef struct LockFile {
1060 int make_lock_file(const char *p, int operation, LockFile *ret);
1061 int make_lock_file_for(const char *p, int operation, LockFile *ret);
1062 void release_lock_file(LockFile *f);
1064 #define _cleanup_release_lock_file_ _cleanup_(release_lock_file)
1066 #define LOCK_FILE_INIT { .fd = -1, .path = NULL }
1068 #define RLIMIT_MAKE_CONST(lim) ((struct rlimit) { lim, lim })
1070 ssize_t sparse_write(int fd, const void *p, size_t sz, size_t run_length);
1072 void sigkill_wait(pid_t *pid);
1073 #define _cleanup_sigkill_wait_ _cleanup_(sigkill_wait)
1075 int syslog_parse_priority(const char **p, int *priority, bool with_facility);