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>
47 # define PID_FMT "%" PRIu32
48 #elif SIZEOF_PID_T == 2
49 # define PID_FMT "%" PRIu16
51 # error Unknown pid_t size
55 # define UID_FMT "%" PRIu32
56 #elif SIZEOF_UID_T == 2
57 # define UID_FMT "%" PRIu16
59 # error Unknown uid_t size
63 # define GID_FMT "%" PRIu32
64 #elif SIZEOF_GID_T == 2
65 # define GID_FMT "%" PRIu16
67 # error Unknown gid_t size
70 #if SIZEOF_TIME_T == 8
71 # define PRI_TIME PRIu64
72 #elif SIZEOF_TIME_T == 4
73 # define PRI_TIME PRIu32
75 # error Unknown time_t size
78 #if SIZEOF_RLIM_T == 8
79 # define RLIM_FMT "%" PRIu64
80 #elif SIZEOF_RLIM_T == 4
81 # define RLIM_FMT "%" PRIu32
83 # error Unknown rlim_t size
88 #include "time-util.h"
90 /* What is interpreted as whitespace? */
91 #define WHITESPACE " \t\n\r"
92 #define NEWLINE "\n\r"
95 #define GLOB_CHARS "*?["
97 /* What characters are special in the shell? */
98 /* must be escaped outside and inside double-quotes */
99 #define SHELL_NEED_ESCAPE "\"\\`$"
100 /* can be escaped or double-quoted */
101 #define SHELL_NEED_QUOTES SHELL_NEED_ESCAPE GLOB_CHARS "'()<>|&;"
103 #define FORMAT_BYTES_MAX 8
105 #define ANSI_HIGHLIGHT_ON "\x1B[1;39m"
106 #define ANSI_RED_ON "\x1B[31m"
107 #define ANSI_HIGHLIGHT_RED_ON "\x1B[1;31m"
108 #define ANSI_GREEN_ON "\x1B[32m"
109 #define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
110 #define ANSI_HIGHLIGHT_YELLOW_ON "\x1B[1;33m"
111 #define ANSI_HIGHLIGHT_BLUE_ON "\x1B[1;34m"
112 #define ANSI_HIGHLIGHT_OFF "\x1B[0m"
113 #define ANSI_ERASE_TO_END_OF_LINE "\x1B[K"
115 size_t page_size(void);
116 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
118 #define streq(a,b) (strcmp((a),(b)) == 0)
119 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
120 #define strcaseeq(a,b) (strcasecmp((a),(b)) == 0)
121 #define strncaseeq(a, b, n) (strncasecmp((a), (b), (n)) == 0)
123 bool streq_ptr(const char *a, const char *b) _pure_;
125 #define new(t, n) ((t*) malloc_multiply(sizeof(t), (n)))
127 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
129 #define newa(t, n) ((t*) alloca(sizeof(t)*(n)))
131 #define newa0(t, n) ((t*) alloca0(sizeof(t)*(n)))
133 #define newdup(t, p, n) ((t*) memdup_multiply(p, sizeof(t), (n)))
135 #define malloc0(n) (calloc((n), 1))
137 static inline const char* yes_no(bool b) {
138 return b ? "yes" : "no";
141 static inline const char* true_false(bool b) {
142 return b ? "true" : "false";
145 static inline const char* strempty(const char *s) {
149 static inline const char* strnull(const char *s) {
150 return s ? s : "(null)";
153 static inline const char *strna(const char *s) {
154 return s ? s : "n/a";
157 static inline bool isempty(const char *p) {
161 static inline char *startswith(const char *s, const char *prefix) {
165 if (strncmp(s, prefix, l) == 0)
166 return (char*) s + l;
171 static inline char *startswith_no_case(const char *s, const char *prefix) {
175 if (strncasecmp(s, prefix, l) == 0)
176 return (char*) s + l;
181 char *endswith(const char *s, const char *postfix) _pure_;
183 char *first_word(const char *s, const char *word) _pure_;
185 int close_nointr(int fd);
186 int safe_close(int fd);
187 void safe_close_pair(int p[]);
189 void close_many(const int fds[], unsigned n_fd);
191 int parse_size(const char *t, off_t base, off_t *size);
193 int parse_boolean(const char *v) _pure_;
194 int parse_pid(const char *s, pid_t* ret_pid);
195 int parse_uid(const char *s, uid_t* ret_uid);
196 #define parse_gid(s, ret_uid) parse_uid(s, ret_uid)
198 int safe_atou(const char *s, unsigned *ret_u);
199 int safe_atoi(const char *s, int *ret_i);
201 int safe_atollu(const char *s, unsigned long long *ret_u);
202 int safe_atolli(const char *s, long long int *ret_i);
204 int safe_atod(const char *s, double *ret_d);
206 int safe_atou8(const char *s, uint8_t *ret);
208 #if LONG_MAX == INT_MAX
209 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
210 assert_cc(sizeof(unsigned long) == sizeof(unsigned));
211 return safe_atou(s, (unsigned*) ret_u);
213 static inline int safe_atoli(const char *s, long int *ret_u) {
214 assert_cc(sizeof(long int) == sizeof(int));
215 return safe_atoi(s, (int*) ret_u);
218 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
219 assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
220 return safe_atollu(s, (unsigned long long*) ret_u);
222 static inline int safe_atoli(const char *s, long int *ret_u) {
223 assert_cc(sizeof(long int) == sizeof(long long int));
224 return safe_atolli(s, (long long int*) ret_u);
228 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
229 assert_cc(sizeof(uint32_t) == sizeof(unsigned));
230 return safe_atou(s, (unsigned*) ret_u);
233 static inline int safe_atoi32(const char *s, int32_t *ret_i) {
234 assert_cc(sizeof(int32_t) == sizeof(int));
235 return safe_atoi(s, (int*) ret_i);
238 static inline int safe_atou64(const char *s, uint64_t *ret_u) {
239 assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
240 return safe_atollu(s, (unsigned long long*) ret_u);
243 static inline int safe_atoi64(const char *s, int64_t *ret_i) {
244 assert_cc(sizeof(int64_t) == sizeof(long long int));
245 return safe_atolli(s, (long long int*) ret_i);
248 const char* split(const char **state, size_t *l, const char *separator, bool quoted);
250 #define FOREACH_WORD(word, length, s, state) \
251 _FOREACH_WORD(word, length, s, WHITESPACE, false, state)
253 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state) \
254 _FOREACH_WORD(word, length, s, separator, false, state)
256 #define FOREACH_WORD_QUOTED(word, length, s, state) \
257 _FOREACH_WORD(word, length, s, WHITESPACE, true, state)
259 #define _FOREACH_WORD(word, length, s, separator, quoted, state) \
260 for ((state) = (s), (word) = split(&(state), &(length), (separator), (quoted)); (word); (word) = split(&(state), &(length), (separator), (quoted)))
262 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
263 int get_starttime_of_pid(pid_t pid, unsigned long long *st);
265 char *strappend(const char *s, const char *suffix);
266 char *strnappend(const char *s, const char *suffix, size_t length);
268 char *replace_env(const char *format, char **env);
269 char **replace_env_argv(char **argv, char **env);
271 int readlinkat_malloc(int fd, const char *p, char **ret);
272 int readlink_malloc(const char *p, char **r);
273 int readlink_and_make_absolute(const char *p, char **r);
274 int readlink_and_canonicalize(const char *p, char **r);
276 int reset_all_signal_handlers(void);
277 int reset_signal_mask(void);
279 char *strstrip(char *s);
280 char *delete_chars(char *s, const char *bad);
281 char *truncate_nl(char *s);
283 char *file_in_same_dir(const char *path, const char *filename);
285 int rmdir_parents(const char *path, const char *stop);
287 int get_process_state(pid_t pid);
288 int get_process_comm(pid_t pid, char **name);
289 int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
290 int get_process_exe(pid_t pid, char **name);
291 int get_process_uid(pid_t pid, uid_t *uid);
292 int get_process_gid(pid_t pid, gid_t *gid);
293 int get_process_capeff(pid_t pid, char **capeff);
295 char hexchar(int x) _const_;
296 int unhexchar(char c) _const_;
297 char octchar(int x) _const_;
298 int unoctchar(char c) _const_;
299 char decchar(int x) _const_;
300 int undecchar(char c) _const_;
302 char *cescape(const char *s);
303 char *cunescape(const char *s);
304 char *cunescape_length(const char *s, size_t length);
305 char *cunescape_length_with_prefix(const char *s, size_t length, const char *prefix);
307 char *xescape(const char *s, const char *bad);
309 char *ascii_strlower(char *path);
311 bool dirent_is_file(const struct dirent *de) _pure_;
312 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix) _pure_;
314 bool ignore_file(const char *filename) _pure_;
316 bool chars_intersect(const char *a, const char *b) _pure_;
318 int make_stdio(int fd);
319 int make_null_stdio(void);
320 int make_console_stdio(void);
322 int dev_urandom(void *p, size_t n);
323 void random_bytes(void *p, size_t n);
324 void initialize_srand(void);
326 static inline uint64_t random_u64(void) {
328 random_bytes(&u, sizeof(u));
332 static inline uint32_t random_u32(void) {
334 random_bytes(&u, sizeof(u));
338 /* For basic lookup tables with strictly enumerated entries */
339 #define __DEFINE_STRING_TABLE_LOOKUP(name,type,scope) \
340 scope const char *name##_to_string(type i) { \
341 if (i < 0 || i >= (type) ELEMENTSOF(name##_table)) \
343 return name##_table[i]; \
345 scope type name##_from_string(const char *s) { \
349 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
350 if (name##_table[i] && \
351 streq(name##_table[i], s)) \
355 struct __useless_struct_to_allow_trailing_semicolon__
357 #define DEFINE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,)
358 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,static)
360 /* For string conversions where numbers are also acceptable */
361 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max) \
362 int name##_to_string_alloc(type i, char **str) { \
365 if (i < 0 || i > max) \
367 if (i < (type) ELEMENTSOF(name##_table)) { \
368 s = strdup(name##_table[i]); \
372 r = asprintf(&s, "%u", i); \
379 type name##_from_string(const char *s) { \
383 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
384 if (name##_table[i] && \
385 streq(name##_table[i], s)) \
387 if (safe_atou(s, &u) >= 0 && u <= max) \
391 struct __useless_struct_to_allow_trailing_semicolon__
393 int fd_nonblock(int fd, bool nonblock);
394 int fd_cloexec(int fd, bool cloexec);
396 int close_all_fds(const int except[], unsigned n_except);
398 bool fstype_is_network(const char *fstype);
402 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
403 int ask_char(char *ret, const char *replies, const char *text, ...) _printf_(3, 4);
404 int ask_string(char **ret, const char *text, ...) _printf_(2, 3);
406 int reset_terminal_fd(int fd, bool switch_to_text);
407 int reset_terminal(const char *name);
409 int open_terminal(const char *name, int mode);
410 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
411 int release_terminal(void);
413 int flush_fd(int fd);
415 int ignore_signals(int sig, ...);
416 int default_signals(int sig, ...);
417 int sigaction_many(const struct sigaction *sa, ...);
419 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
421 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
422 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
424 bool is_device_path(const char *path);
426 int dir_is_empty(const char *path);
427 char* dirname_malloc(const char *path);
429 void rename_process(const char name[8]);
431 void sigset_add_many(sigset_t *ss, ...);
432 int sigprocmask_many(int how, ...);
434 bool hostname_is_set(void);
436 char* lookup_uid(uid_t uid);
437 char* gethostname_malloc(void);
438 char* getlogname_malloc(void);
439 char* getusername_malloc(void);
441 int getttyname_malloc(int fd, char **r);
442 int getttyname_harder(int fd, char **r);
444 int get_ctty_devnr(pid_t pid, dev_t *d);
445 int get_ctty(pid_t, dev_t *_devnr, char **r);
447 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
448 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
450 int rm_rf_children(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
451 int rm_rf_children_dangerous(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
452 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
453 int rm_rf_dangerous(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
455 int pipe_eof(int fd);
457 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
459 int status_vprintf(const char *status, bool ellipse, bool ephemeral, const char *format, va_list ap) _printf_(4,0);
460 int status_printf(const char *status, bool ellipse, bool ephemeral, const char *format, ...) _printf_(4,5);
462 int fd_columns(int fd);
463 unsigned columns(void);
464 int fd_lines(int fd);
465 unsigned lines(void);
466 void columns_lines_cache_reset(int _unused_ signum);
470 static inline const char *ansi_highlight(void) {
471 return on_tty() ? ANSI_HIGHLIGHT_ON : "";
474 static inline const char *ansi_highlight_red(void) {
475 return on_tty() ? ANSI_HIGHLIGHT_RED_ON : "";
478 static inline const char *ansi_highlight_green(void) {
479 return on_tty() ? ANSI_HIGHLIGHT_GREEN_ON : "";
482 static inline const char *ansi_highlight_yellow(void) {
483 return on_tty() ? ANSI_HIGHLIGHT_YELLOW_ON : "";
486 static inline const char *ansi_highlight_blue(void) {
487 return on_tty() ? ANSI_HIGHLIGHT_BLUE_ON : "";
490 static inline const char *ansi_highlight_off(void) {
491 return on_tty() ? ANSI_HIGHLIGHT_OFF : "";
494 int files_same(const char *filea, const char *fileb);
496 int running_in_chroot(void);
498 char *ellipsize(const char *s, size_t length, unsigned percent);
500 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
502 int touch_file(const char *path, bool parents, usec_t stamp, uid_t uid, gid_t gid, mode_t mode);
503 int touch(const char *path);
505 char *unquote(const char *s, const char *quotes);
506 char *normalize_env_assignment(const char *s);
508 int wait_for_terminate(pid_t pid, siginfo_t *status);
509 int wait_for_terminate_and_warn(const char *name, pid_t pid);
511 noreturn void freeze(void);
513 bool null_or_empty(struct stat *st) _pure_;
514 int null_or_empty_path(const char *fn);
515 int null_or_empty_fd(int fd);
517 DIR *xopendirat(int dirfd, const char *name, int flags);
519 char *fstab_node_to_udev_node(const char *p);
521 char *resolve_dev_console(char **active);
522 bool tty_is_vc(const char *tty);
523 bool tty_is_vc_resolve(const char *tty);
524 bool tty_is_console(const char *tty) _pure_;
525 int vtnr_from_tty(const char *tty);
526 const char *default_term_for_tty(const char *tty);
528 void execute_directory(const char *directory, DIR *_d, usec_t timeout, char *argv[]);
530 int kill_and_sigcont(pid_t pid, int sig);
532 bool nulstr_contains(const char*nulstr, const char *needle);
534 bool plymouth_running(void);
536 bool hostname_is_valid(const char *s) _pure_;
537 char* hostname_cleanup(char *s, bool lowercase);
539 bool machine_name_is_valid(const char *s) _pure_;
541 char* strshorten(char *s, size_t l);
543 int terminal_vhangup_fd(int fd);
544 int terminal_vhangup(const char *name);
546 int vt_disallocate(const char *name);
548 int symlink_atomic(const char *from, const char *to);
549 int mknod_atomic(const char *path, mode_t mode, dev_t dev);
550 int mkfifo_atomic(const char *path, mode_t mode);
552 int fchmod_umask(int fd, mode_t mode);
554 bool display_is_local(const char *display) _pure_;
555 int socket_from_display(const char *display, char **path);
557 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
558 int get_group_creds(const char **groupname, gid_t *gid);
560 int in_gid(gid_t gid);
561 int in_group(const char *name);
563 char* uid_to_name(uid_t uid);
564 char* gid_to_name(gid_t gid);
566 int glob_exists(const char *path);
567 int glob_extend(char ***strv, const char *path);
569 int dirent_ensure_type(DIR *d, struct dirent *de);
571 int get_files_in_directory(const char *path, char ***list);
573 char *strjoin(const char *x, ...) _sentinel_;
575 bool is_main_thread(void);
577 static inline bool _pure_ in_charset(const char *s, const char* charset) {
580 return s[strspn(s, charset)] == '\0';
583 int block_get_whole_disk(dev_t d, dev_t *ret);
585 #define NULSTR_FOREACH(i, l) \
586 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
588 #define NULSTR_FOREACH_PAIR(i, j, l) \
589 for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
591 int ioprio_class_to_string_alloc(int i, char **s);
592 int ioprio_class_from_string(const char *s);
594 const char *sigchld_code_to_string(int i) _const_;
595 int sigchld_code_from_string(const char *s) _pure_;
597 int log_facility_unshifted_to_string_alloc(int i, char **s);
598 int log_facility_unshifted_from_string(const char *s);
600 int log_level_to_string_alloc(int i, char **s);
601 int log_level_from_string(const char *s);
603 int sched_policy_to_string_alloc(int i, char **s);
604 int sched_policy_from_string(const char *s);
606 const char *rlimit_to_string(int i) _const_;
607 int rlimit_from_string(const char *s) _pure_;
609 int ip_tos_to_string_alloc(int i, char **s);
610 int ip_tos_from_string(const char *s);
612 const char *signal_to_string(int i) _const_;
613 int signal_from_string(const char *s) _pure_;
615 int signal_from_string_try_harder(const char *s);
617 extern int saved_argc;
618 extern char **saved_argv;
620 bool kexec_loaded(void);
622 int prot_from_flags(int flags) _const_;
624 char *format_bytes(char *buf, size_t l, off_t t);
626 int fd_wait_for_event(int fd, int event, usec_t timeout);
628 void* memdup(const void *p, size_t l) _alloc_(2);
630 int is_kernel_thread(pid_t pid);
632 int fd_inc_sndbuf(int fd, size_t n);
633 int fd_inc_rcvbuf(int fd, size_t n);
635 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
637 int setrlimit_closest(int resource, const struct rlimit *rlim);
639 int getenv_for_pid(pid_t pid, const char *field, char **_value);
641 bool is_valid_documentation_url(const char *url) _pure_;
643 bool in_initrd(void);
645 void warn_melody(void);
647 int get_home_dir(char **ret);
648 int get_shell(char **_ret);
650 static inline void freep(void *p) {
654 #define DEFINE_TRIVIAL_CLEANUP_FUNC(type, func) \
655 static inline void func##p(type *p) { \
659 struct __useless_struct_to_allow_trailing_semicolon__
661 static inline void closep(int *fd) {
665 static inline void umaskp(mode_t *u) {
669 static inline void close_pairp(int (*p)[2]) {
673 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, fclose);
674 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, pclose);
675 DEFINE_TRIVIAL_CLEANUP_FUNC(DIR*, closedir);
676 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, endmntent);
678 #define _cleanup_free_ _cleanup_(freep)
679 #define _cleanup_close_ _cleanup_(closep)
680 #define _cleanup_umask_ _cleanup_(umaskp)
681 #define _cleanup_globfree_ _cleanup_(globfree)
682 #define _cleanup_fclose_ _cleanup_(fclosep)
683 #define _cleanup_pclose_ _cleanup_(pclosep)
684 #define _cleanup_closedir_ _cleanup_(closedirp)
685 #define _cleanup_endmntent_ _cleanup_(endmntentp)
686 #define _cleanup_close_pair_ _cleanup_(close_pairp)
688 _malloc_ _alloc_(1, 2) static inline void *malloc_multiply(size_t a, size_t b) {
689 if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
692 return malloc(a * b);
695 _alloc_(2, 3) static inline void *realloc_multiply(void *p, size_t a, size_t b) {
696 if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
699 return realloc(p, a * b);
702 _alloc_(2, 3) static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
703 if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
706 return memdup(p, a * b);
709 bool filename_is_safe(const char *p) _pure_;
710 bool path_is_safe(const char *p) _pure_;
711 bool string_is_safe(const char *p) _pure_;
712 bool string_has_cc(const char *p, const char *ok) _pure_;
715 * Check if a string contains any glob patterns.
717 _pure_ static inline bool string_is_glob(const char *p) {
718 return !!strpbrk(p, GLOB_CHARS);
721 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
722 int (*compar) (const void *, const void *, void *),
725 bool is_locale_utf8(void);
727 typedef enum DrawSpecialChar {
732 DRAW_TRIANGULAR_BULLET,
736 _DRAW_SPECIAL_CHAR_MAX
739 const char *draw_special_char(DrawSpecialChar ch);
741 char *strreplace(const char *text, const char *old_string, const char *new_string);
743 char *strip_tab_ansi(char **p, size_t *l);
745 int on_ac_power(void);
747 int search_and_fopen(const char *path, const char *mode, const char *root, const char **search, FILE **_f);
748 int search_and_fopen_nulstr(const char *path, const char *mode, const char *root, const char *search, FILE **_f);
750 #define FOREACH_LINE(line, f, on_error) \
752 if (!fgets(line, sizeof(line), f)) { \
759 #define FOREACH_DIRENT(de, d, on_error) \
760 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
766 } else if (ignore_file((de)->d_name)) \
770 static inline void *mempset(void *s, int c, size_t n) {
772 return (uint8_t*)s + n;
775 char *hexmem(const void *p, size_t l);
776 void *unhexmem(const char *p, size_t l);
778 char *strextend(char **x, ...) _sentinel_;
779 char *strrep(const char *s, unsigned n);
781 void* greedy_realloc(void **p, size_t *allocated, size_t need, size_t size);
782 void* greedy_realloc0(void **p, size_t *allocated, size_t need, size_t size);
783 #define GREEDY_REALLOC(array, allocated, need) \
784 greedy_realloc((void**) &(array), &(allocated), (need), sizeof((array)[0]))
786 #define GREEDY_REALLOC0(array, allocated, need) \
787 greedy_realloc0((void**) &(array), &(allocated), (need), sizeof((array)[0]))
789 static inline void _reset_errno_(int *saved_errno) {
790 errno = *saved_errno;
793 #define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
795 static inline int negative_errno(void) {
796 /* This helper should be used to shut up gcc if you know 'errno' is
797 * negative. Instead of "return -errno;", use "return negative_errno();"
798 * It will suppress bogus gcc warnings in case it assumes 'errno' might
799 * be 0 and thus the caller's error-handling might not be triggered. */
800 assert_return(errno > 0, -EINVAL);
804 struct _umask_struct_ {
809 static inline void _reset_umask_(struct _umask_struct_ *s) {
813 #define RUN_WITH_UMASK(mask) \
814 for (_cleanup_(_reset_umask_) struct _umask_struct_ _saved_umask_ = { umask(mask), false }; \
815 !_saved_umask_.quit ; \
816 _saved_umask_.quit = true)
818 static inline unsigned u64log2(uint64_t n) {
819 #if __SIZEOF_LONG_LONG__ == 8
820 return (n > 1) ? (unsigned) __builtin_clzll(n) ^ 63U : 0;
826 static inline unsigned u32ctz(uint32_t n) {
827 #if __SIZEOF_INT__ == 4
828 return __builtin_ctz(n);
834 static inline int log2i(int x) {
837 return __SIZEOF_INT__ * 8 - __builtin_clz(x) - 1;
840 static inline unsigned log2u(unsigned x) {
843 return sizeof(unsigned) * 8 - __builtin_clz(x) - 1;
846 static inline unsigned log2u_round_up(unsigned x) {
852 return log2u(x - 1) + 1;
855 static inline bool logind_running(void) {
856 return access("/run/systemd/seats/", F_OK) >= 0;
859 #define DECIMAL_STR_WIDTH(x) \
861 typeof(x) _x_ = (x); \
868 int unlink_noerrno(const char *path);
874 _new_ = alloca(_len_); \
875 (void *) memset(_new_, 0, _len_); \
878 #define alloca_align(size, align) \
881 size_t _mask_ = (align) - 1; \
882 _ptr_ = alloca((size) + _mask_); \
883 (void*)(((uintptr_t)_ptr_ + _mask_) & ~_mask_); \
886 #define alloca0_align(size, align) \
889 size_t _size_ = (size); \
890 _new_ = alloca_align(_size_, (align)); \
891 (void*)memset(_new_, 0, _size_); \
894 #define strappenda(a, ...) \
896 int _len = strlen(a); \
899 const char *_appendees_[] = { __VA_ARGS__ }; \
900 for (_i = 0; _i < ELEMENTSOF(_appendees_); _i++) \
901 _len += strlen(_appendees_[_i]); \
902 _d_ = alloca(_len + 1); \
903 _p_ = stpcpy(_d_, a); \
904 for (_i = 0; _i < ELEMENTSOF(_appendees_); _i++) \
905 _p_ = stpcpy(_p_, _appendees_[_i]); \
909 #define procfs_file_alloca(pid, field) \
911 pid_t _pid_ = (pid); \
914 _r_ = ("/proc/self/" field); \
916 _r_ = alloca(strlen("/proc/") + DECIMAL_STR_MAX(pid_t) + 1 + sizeof(field)); \
917 sprintf((char*) _r_, "/proc/"PID_FMT"/" field, _pid_); \
922 struct _locale_struct_ {
923 locale_t saved_locale;
928 static inline void _reset_locale_(struct _locale_struct_ *s) {
930 if (s->saved_locale != (locale_t) 0)
931 uselocale(s->saved_locale);
932 if (s->new_locale != (locale_t) 0)
933 freelocale(s->new_locale);
936 #define RUN_WITH_LOCALE(mask, loc) \
937 for (_cleanup_(_reset_locale_) struct _locale_struct_ _saved_locale_ = { (locale_t) 0, (locale_t) 0, false }; \
939 if (!_saved_locale_.quit) { \
941 _saved_locale_.new_locale = newlocale((mask), (loc), (locale_t) 0); \
942 if (_saved_locale_.new_locale != (locale_t) 0) \
943 _saved_locale_.saved_locale = uselocale(_saved_locale_.new_locale); \
945 !_saved_locale_.quit; }) ; \
946 _saved_locale_.quit = true)
948 bool id128_is_valid(const char *s) _pure_;
950 int split_pair(const char *s, const char *sep, char **l, char **r);
952 int shall_restore_state(void);
955 * Normal qsort requires base to be nonnull. Here were require
956 * that only if nmemb > 0.
958 static inline void qsort_safe(void *base, size_t nmemb, size_t size,
959 int (*compar)(const void *, const void *)) {
962 qsort(base, nmemb, size, compar);
966 int proc_cmdline(char **ret);
967 int parse_proc_cmdline(int (*parse_word)(const char *key, const char *value));
969 int container_get_leader(const char *machine, pid_t *pid);
971 int namespace_open(pid_t pid, int *pidns_fd, int *mntns_fd, int *netns_fd, int *root_fd);
972 int namespace_enter(int pidns_fd, int mntns_fd, int netns_fd, int root_fd);
974 bool pid_is_alive(pid_t pid);
975 bool pid_is_unwaited(pid_t pid);
977 int getpeercred(int fd, struct ucred *ucred);
978 int getpeersec(int fd, char **ret);
980 int writev_safe(int fd, const struct iovec *w, int j);
982 int mkostemp_safe(char *pattern, int flags);
983 int open_tmpfile(const char *path, int flags);
985 int fd_warn_permissions(const char *path, int fd);
987 unsigned long personality_from_string(const char *p);
988 const char *personality_to_string(unsigned long);
990 uint64_t physical_memory(void);
992 char* mount_test_option(const char *haystack, const char *needle);
994 void hexdump(FILE *f, const void *p, size_t s);
996 union file_handle_union {
997 struct file_handle handle;
998 char padding[sizeof(struct file_handle) + MAX_HANDLE_SZ];
1001 int update_reboot_param_file(const char *param);
1003 int umount_recursive(const char *target, int flags);
1005 int bind_remount_recursive(const char *prefix, bool ro);
1007 int fflush_and_check(FILE *f);
1009 char *tempfn_xxxxxx(const char *p);
1010 char *tempfn_random(const char *p);
1012 bool is_localhost(const char *hostname);
1014 int take_password_lock(const char *root);
1016 int is_symlink(const char *path);
1017 int is_dir(const char *path, bool follow);
1019 int unquote_first_word(const char **p, char **ret, bool relax);
1020 int unquote_many_words(const char **p, ...) _sentinel_;
1022 int free_and_strdup(char **p, const char *s);
1024 int sethostname_idempotent(const char *s);