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_value(const char *p, char **ret);
274 int readlink_and_make_absolute(const char *p, char **r);
275 int readlink_and_canonicalize(const char *p, char **r);
277 int reset_all_signal_handlers(void);
278 int reset_signal_mask(void);
280 char *strstrip(char *s);
281 char *delete_chars(char *s, const char *bad);
282 char *truncate_nl(char *s);
284 char *file_in_same_dir(const char *path, const char *filename);
286 int rmdir_parents(const char *path, const char *stop);
288 int get_process_state(pid_t pid);
289 int get_process_comm(pid_t pid, char **name);
290 int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
291 int get_process_exe(pid_t pid, char **name);
292 int get_process_uid(pid_t pid, uid_t *uid);
293 int get_process_gid(pid_t pid, gid_t *gid);
294 int get_process_capeff(pid_t pid, char **capeff);
296 char hexchar(int x) _const_;
297 int unhexchar(char c) _const_;
298 char octchar(int x) _const_;
299 int unoctchar(char c) _const_;
300 char decchar(int x) _const_;
301 int undecchar(char c) _const_;
303 char *cescape(const char *s);
304 char *cunescape(const char *s);
305 char *cunescape_length(const char *s, size_t length);
306 char *cunescape_length_with_prefix(const char *s, size_t length, const char *prefix);
308 char *xescape(const char *s, const char *bad);
310 char *ascii_strlower(char *path);
312 bool dirent_is_file(const struct dirent *de) _pure_;
313 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix) _pure_;
315 bool ignore_file(const char *filename) _pure_;
317 bool chars_intersect(const char *a, const char *b) _pure_;
319 int make_stdio(int fd);
320 int make_null_stdio(void);
321 int make_console_stdio(void);
323 int dev_urandom(void *p, size_t n);
324 void random_bytes(void *p, size_t n);
325 void initialize_srand(void);
327 static inline uint64_t random_u64(void) {
329 random_bytes(&u, sizeof(u));
333 static inline uint32_t random_u32(void) {
335 random_bytes(&u, sizeof(u));
339 /* For basic lookup tables with strictly enumerated entries */
340 #define __DEFINE_STRING_TABLE_LOOKUP(name,type,scope) \
341 scope const char *name##_to_string(type i) { \
342 if (i < 0 || i >= (type) ELEMENTSOF(name##_table)) \
344 return name##_table[i]; \
346 scope type name##_from_string(const char *s) { \
350 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
351 if (name##_table[i] && \
352 streq(name##_table[i], s)) \
356 struct __useless_struct_to_allow_trailing_semicolon__
358 #define DEFINE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,)
359 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,static)
361 /* For string conversions where numbers are also acceptable */
362 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max) \
363 int name##_to_string_alloc(type i, char **str) { \
366 if (i < 0 || i > max) \
368 if (i < (type) ELEMENTSOF(name##_table)) { \
369 s = strdup(name##_table[i]); \
373 r = asprintf(&s, "%u", i); \
380 type name##_from_string(const char *s) { \
384 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
385 if (name##_table[i] && \
386 streq(name##_table[i], s)) \
388 if (safe_atou(s, &u) >= 0 && u <= max) \
392 struct __useless_struct_to_allow_trailing_semicolon__
394 int fd_nonblock(int fd, bool nonblock);
395 int fd_cloexec(int fd, bool cloexec);
397 int close_all_fds(const int except[], unsigned n_except);
399 bool fstype_is_network(const char *fstype);
403 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
404 int ask_char(char *ret, const char *replies, const char *text, ...) _printf_(3, 4);
405 int ask_string(char **ret, const char *text, ...) _printf_(2, 3);
407 int reset_terminal_fd(int fd, bool switch_to_text);
408 int reset_terminal(const char *name);
410 int open_terminal(const char *name, int mode);
411 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
412 int release_terminal(void);
414 int flush_fd(int fd);
416 int ignore_signals(int sig, ...);
417 int default_signals(int sig, ...);
418 int sigaction_many(const struct sigaction *sa, ...);
420 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
422 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
423 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
425 bool is_device_path(const char *path);
427 int dir_is_empty(const char *path);
428 char* dirname_malloc(const char *path);
430 void rename_process(const char name[8]);
432 void sigset_add_many(sigset_t *ss, ...);
433 int sigprocmask_many(int how, ...);
435 bool hostname_is_set(void);
437 char* lookup_uid(uid_t uid);
438 char* gethostname_malloc(void);
439 char* getlogname_malloc(void);
440 char* getusername_malloc(void);
442 int getttyname_malloc(int fd, char **r);
443 int getttyname_harder(int fd, char **r);
445 int get_ctty_devnr(pid_t pid, dev_t *d);
446 int get_ctty(pid_t, dev_t *_devnr, char **r);
448 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
449 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
451 int rm_rf_children(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
452 int rm_rf_children_dangerous(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
453 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
454 int rm_rf_dangerous(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
456 int pipe_eof(int fd);
458 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
460 int status_vprintf(const char *status, bool ellipse, bool ephemeral, const char *format, va_list ap) _printf_(4,0);
461 int status_printf(const char *status, bool ellipse, bool ephemeral, const char *format, ...) _printf_(4,5);
463 int fd_columns(int fd);
464 unsigned columns(void);
465 int fd_lines(int fd);
466 unsigned lines(void);
467 void columns_lines_cache_reset(int _unused_ signum);
471 static inline const char *ansi_highlight(void) {
472 return on_tty() ? ANSI_HIGHLIGHT_ON : "";
475 static inline const char *ansi_highlight_red(void) {
476 return on_tty() ? ANSI_HIGHLIGHT_RED_ON : "";
479 static inline const char *ansi_highlight_green(void) {
480 return on_tty() ? ANSI_HIGHLIGHT_GREEN_ON : "";
483 static inline const char *ansi_highlight_yellow(void) {
484 return on_tty() ? ANSI_HIGHLIGHT_YELLOW_ON : "";
487 static inline const char *ansi_highlight_blue(void) {
488 return on_tty() ? ANSI_HIGHLIGHT_BLUE_ON : "";
491 static inline const char *ansi_highlight_off(void) {
492 return on_tty() ? ANSI_HIGHLIGHT_OFF : "";
495 int files_same(const char *filea, const char *fileb);
497 int running_in_chroot(void);
499 char *ellipsize(const char *s, size_t length, unsigned percent);
501 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
503 int touch_file(const char *path, bool parents, usec_t stamp, uid_t uid, gid_t gid, mode_t mode);
504 int touch(const char *path);
506 char *unquote(const char *s, const char *quotes);
507 char *normalize_env_assignment(const char *s);
509 int wait_for_terminate(pid_t pid, siginfo_t *status);
510 int wait_for_terminate_and_warn(const char *name, pid_t pid);
512 noreturn void freeze(void);
514 bool null_or_empty(struct stat *st) _pure_;
515 int null_or_empty_path(const char *fn);
516 int null_or_empty_fd(int fd);
518 DIR *xopendirat(int dirfd, const char *name, int flags);
520 char *fstab_node_to_udev_node(const char *p);
522 char *resolve_dev_console(char **active);
523 bool tty_is_vc(const char *tty);
524 bool tty_is_vc_resolve(const char *tty);
525 bool tty_is_console(const char *tty) _pure_;
526 int vtnr_from_tty(const char *tty);
527 const char *default_term_for_tty(const char *tty);
529 void execute_directory(const char *directory, DIR *_d, usec_t timeout, char *argv[]);
531 int kill_and_sigcont(pid_t pid, int sig);
533 bool nulstr_contains(const char*nulstr, const char *needle);
535 bool plymouth_running(void);
537 bool hostname_is_valid(const char *s) _pure_;
538 char* hostname_cleanup(char *s, bool lowercase);
540 bool machine_name_is_valid(const char *s) _pure_;
542 char* strshorten(char *s, size_t l);
544 int terminal_vhangup_fd(int fd);
545 int terminal_vhangup(const char *name);
547 int vt_disallocate(const char *name);
549 int symlink_atomic(const char *from, const char *to);
550 int mknod_atomic(const char *path, mode_t mode, dev_t dev);
551 int mkfifo_atomic(const char *path, mode_t mode);
553 int fchmod_umask(int fd, mode_t mode);
555 bool display_is_local(const char *display) _pure_;
556 int socket_from_display(const char *display, char **path);
558 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
559 int get_group_creds(const char **groupname, gid_t *gid);
561 int in_gid(gid_t gid);
562 int in_group(const char *name);
564 char* uid_to_name(uid_t uid);
565 char* gid_to_name(gid_t gid);
567 int glob_exists(const char *path);
568 int glob_extend(char ***strv, const char *path);
570 int dirent_ensure_type(DIR *d, struct dirent *de);
572 int get_files_in_directory(const char *path, char ***list);
574 char *strjoin(const char *x, ...) _sentinel_;
576 bool is_main_thread(void);
578 static inline bool _pure_ in_charset(const char *s, const char* charset) {
581 return s[strspn(s, charset)] == '\0';
584 int block_get_whole_disk(dev_t d, dev_t *ret);
586 #define NULSTR_FOREACH(i, l) \
587 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
589 #define NULSTR_FOREACH_PAIR(i, j, l) \
590 for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
592 int ioprio_class_to_string_alloc(int i, char **s);
593 int ioprio_class_from_string(const char *s);
595 const char *sigchld_code_to_string(int i) _const_;
596 int sigchld_code_from_string(const char *s) _pure_;
598 int log_facility_unshifted_to_string_alloc(int i, char **s);
599 int log_facility_unshifted_from_string(const char *s);
601 int log_level_to_string_alloc(int i, char **s);
602 int log_level_from_string(const char *s);
604 int sched_policy_to_string_alloc(int i, char **s);
605 int sched_policy_from_string(const char *s);
607 const char *rlimit_to_string(int i) _const_;
608 int rlimit_from_string(const char *s) _pure_;
610 int ip_tos_to_string_alloc(int i, char **s);
611 int ip_tos_from_string(const char *s);
613 const char *signal_to_string(int i) _const_;
614 int signal_from_string(const char *s) _pure_;
616 int signal_from_string_try_harder(const char *s);
618 extern int saved_argc;
619 extern char **saved_argv;
621 bool kexec_loaded(void);
623 int prot_from_flags(int flags) _const_;
625 char *format_bytes(char *buf, size_t l, off_t t);
627 int fd_wait_for_event(int fd, int event, usec_t timeout);
629 void* memdup(const void *p, size_t l) _alloc_(2);
631 int is_kernel_thread(pid_t pid);
633 int fd_inc_sndbuf(int fd, size_t n);
634 int fd_inc_rcvbuf(int fd, size_t n);
636 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
638 int setrlimit_closest(int resource, const struct rlimit *rlim);
640 int getenv_for_pid(pid_t pid, const char *field, char **_value);
642 bool is_valid_documentation_url(const char *url) _pure_;
644 bool in_initrd(void);
646 void warn_melody(void);
648 int get_home_dir(char **ret);
649 int get_shell(char **_ret);
651 static inline void freep(void *p) {
655 #define DEFINE_TRIVIAL_CLEANUP_FUNC(type, func) \
656 static inline void func##p(type *p) { \
660 struct __useless_struct_to_allow_trailing_semicolon__
662 static inline void closep(int *fd) {
666 static inline void umaskp(mode_t *u) {
670 static inline void close_pairp(int (*p)[2]) {
674 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, fclose);
675 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, pclose);
676 DEFINE_TRIVIAL_CLEANUP_FUNC(DIR*, closedir);
677 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, endmntent);
679 #define _cleanup_free_ _cleanup_(freep)
680 #define _cleanup_close_ _cleanup_(closep)
681 #define _cleanup_umask_ _cleanup_(umaskp)
682 #define _cleanup_globfree_ _cleanup_(globfree)
683 #define _cleanup_fclose_ _cleanup_(fclosep)
684 #define _cleanup_pclose_ _cleanup_(pclosep)
685 #define _cleanup_closedir_ _cleanup_(closedirp)
686 #define _cleanup_endmntent_ _cleanup_(endmntentp)
687 #define _cleanup_close_pair_ _cleanup_(close_pairp)
689 _malloc_ _alloc_(1, 2) static inline void *malloc_multiply(size_t a, size_t b) {
690 if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
693 return malloc(a * b);
696 _alloc_(2, 3) static inline void *realloc_multiply(void *p, size_t a, size_t b) {
697 if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
700 return realloc(p, a * b);
703 _alloc_(2, 3) static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
704 if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
707 return memdup(p, a * b);
710 bool filename_is_safe(const char *p) _pure_;
711 bool path_is_safe(const char *p) _pure_;
712 bool string_is_safe(const char *p) _pure_;
713 bool string_has_cc(const char *p, const char *ok) _pure_;
716 * Check if a string contains any glob patterns.
718 _pure_ static inline bool string_is_glob(const char *p) {
719 return !!strpbrk(p, GLOB_CHARS);
722 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
723 int (*compar) (const void *, const void *, void *),
726 bool is_locale_utf8(void);
728 typedef enum DrawSpecialChar {
733 DRAW_TRIANGULAR_BULLET,
737 _DRAW_SPECIAL_CHAR_MAX
740 const char *draw_special_char(DrawSpecialChar ch);
742 char *strreplace(const char *text, const char *old_string, const char *new_string);
744 char *strip_tab_ansi(char **p, size_t *l);
746 int on_ac_power(void);
748 int search_and_fopen(const char *path, const char *mode, const char *root, const char **search, FILE **_f);
749 int search_and_fopen_nulstr(const char *path, const char *mode, const char *root, const char *search, FILE **_f);
751 #define FOREACH_LINE(line, f, on_error) \
753 if (!fgets(line, sizeof(line), f)) { \
760 #define FOREACH_DIRENT(de, d, on_error) \
761 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
767 } else if (ignore_file((de)->d_name)) \
771 static inline void *mempset(void *s, int c, size_t n) {
773 return (uint8_t*)s + n;
776 char *hexmem(const void *p, size_t l);
777 void *unhexmem(const char *p, size_t l);
779 char *strextend(char **x, ...) _sentinel_;
780 char *strrep(const char *s, unsigned n);
782 void* greedy_realloc(void **p, size_t *allocated, size_t need, size_t size);
783 void* greedy_realloc0(void **p, size_t *allocated, size_t need, size_t size);
784 #define GREEDY_REALLOC(array, allocated, need) \
785 greedy_realloc((void**) &(array), &(allocated), (need), sizeof((array)[0]))
787 #define GREEDY_REALLOC0(array, allocated, need) \
788 greedy_realloc0((void**) &(array), &(allocated), (need), sizeof((array)[0]))
790 static inline void _reset_errno_(int *saved_errno) {
791 errno = *saved_errno;
794 #define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
796 static inline int negative_errno(void) {
797 /* This helper should be used to shut up gcc if you know 'errno' is
798 * negative. Instead of "return -errno;", use "return negative_errno();"
799 * It will suppress bogus gcc warnings in case it assumes 'errno' might
800 * be 0 and thus the caller's error-handling might not be triggered. */
801 assert_return(errno > 0, -EINVAL);
805 struct _umask_struct_ {
810 static inline void _reset_umask_(struct _umask_struct_ *s) {
814 #define RUN_WITH_UMASK(mask) \
815 for (_cleanup_(_reset_umask_) struct _umask_struct_ _saved_umask_ = { umask(mask), false }; \
816 !_saved_umask_.quit ; \
817 _saved_umask_.quit = true)
819 static inline unsigned u64log2(uint64_t n) {
820 #if __SIZEOF_LONG_LONG__ == 8
821 return (n > 1) ? (unsigned) __builtin_clzll(n) ^ 63U : 0;
827 static inline unsigned u32ctz(uint32_t n) {
828 #if __SIZEOF_INT__ == 4
829 return __builtin_ctz(n);
835 static inline int log2i(int x) {
838 return __SIZEOF_INT__ * 8 - __builtin_clz(x) - 1;
841 static inline unsigned log2u(unsigned x) {
844 return sizeof(unsigned) * 8 - __builtin_clz(x) - 1;
847 static inline unsigned log2u_round_up(unsigned x) {
853 return log2u(x - 1) + 1;
856 static inline bool logind_running(void) {
857 return access("/run/systemd/seats/", F_OK) >= 0;
860 #define DECIMAL_STR_WIDTH(x) \
862 typeof(x) _x_ = (x); \
869 int unlink_noerrno(const char *path);
875 _new_ = alloca(_len_); \
876 (void *) memset(_new_, 0, _len_); \
879 #define alloca_align(size, align) \
882 size_t _mask_ = (align) - 1; \
883 _ptr_ = alloca((size) + _mask_); \
884 (void*)(((uintptr_t)_ptr_ + _mask_) & ~_mask_); \
887 #define alloca0_align(size, align) \
890 size_t _size_ = (size); \
891 _new_ = alloca_align(_size_, (align)); \
892 (void*)memset(_new_, 0, _size_); \
895 #define strappenda(a, ...) \
897 int _len = strlen(a); \
900 const char *_appendees_[] = { __VA_ARGS__ }; \
901 for (_i = 0; _i < ELEMENTSOF(_appendees_); _i++) \
902 _len += strlen(_appendees_[_i]); \
903 _d_ = alloca(_len + 1); \
904 _p_ = stpcpy(_d_, a); \
905 for (_i = 0; _i < ELEMENTSOF(_appendees_); _i++) \
906 _p_ = stpcpy(_p_, _appendees_[_i]); \
910 #define procfs_file_alloca(pid, field) \
912 pid_t _pid_ = (pid); \
915 _r_ = ("/proc/self/" field); \
917 _r_ = alloca(strlen("/proc/") + DECIMAL_STR_MAX(pid_t) + 1 + sizeof(field)); \
918 sprintf((char*) _r_, "/proc/"PID_FMT"/" field, _pid_); \
923 struct _locale_struct_ {
924 locale_t saved_locale;
929 static inline void _reset_locale_(struct _locale_struct_ *s) {
931 if (s->saved_locale != (locale_t) 0)
932 uselocale(s->saved_locale);
933 if (s->new_locale != (locale_t) 0)
934 freelocale(s->new_locale);
937 #define RUN_WITH_LOCALE(mask, loc) \
938 for (_cleanup_(_reset_locale_) struct _locale_struct_ _saved_locale_ = { (locale_t) 0, (locale_t) 0, false }; \
940 if (!_saved_locale_.quit) { \
942 _saved_locale_.new_locale = newlocale((mask), (loc), (locale_t) 0); \
943 if (_saved_locale_.new_locale != (locale_t) 0) \
944 _saved_locale_.saved_locale = uselocale(_saved_locale_.new_locale); \
946 !_saved_locale_.quit; }) ; \
947 _saved_locale_.quit = true)
949 bool id128_is_valid(const char *s) _pure_;
951 int split_pair(const char *s, const char *sep, char **l, char **r);
953 int shall_restore_state(void);
956 * Normal qsort requires base to be nonnull. Here were require
957 * that only if nmemb > 0.
959 static inline void qsort_safe(void *base, size_t nmemb, size_t size,
960 int (*compar)(const void *, const void *)) {
963 qsort(base, nmemb, size, compar);
967 int proc_cmdline(char **ret);
968 int parse_proc_cmdline(int (*parse_word)(const char *key, const char *value));
970 int container_get_leader(const char *machine, pid_t *pid);
972 int namespace_open(pid_t pid, int *pidns_fd, int *mntns_fd, int *netns_fd, int *root_fd);
973 int namespace_enter(int pidns_fd, int mntns_fd, int netns_fd, int root_fd);
975 bool pid_is_alive(pid_t pid);
976 bool pid_is_unwaited(pid_t pid);
978 int getpeercred(int fd, struct ucred *ucred);
979 int getpeersec(int fd, char **ret);
981 int writev_safe(int fd, const struct iovec *w, int j);
983 int mkostemp_safe(char *pattern, int flags);
984 int open_tmpfile(const char *path, int flags);
986 int fd_warn_permissions(const char *path, int fd);
988 unsigned long personality_from_string(const char *p);
989 const char *personality_to_string(unsigned long);
991 uint64_t physical_memory(void);
993 char* mount_test_option(const char *haystack, const char *needle);
995 void hexdump(FILE *f, const void *p, size_t s);
997 union file_handle_union {
998 struct file_handle handle;
999 char padding[sizeof(struct file_handle) + MAX_HANDLE_SZ];
1002 int update_reboot_param_file(const char *param);
1004 int umount_recursive(const char *target, int flags);
1006 int bind_remount_recursive(const char *prefix, bool ro);
1008 int fflush_and_check(FILE *f);
1010 char *tempfn_xxxxxx(const char *p);
1011 char *tempfn_random(const char *p);
1013 bool is_localhost(const char *hostname);
1015 int take_password_lock(const char *root);
1017 int is_symlink(const char *path);
1018 int is_dir(const char *path, bool follow);
1020 int unquote_first_word(const char **p, char **ret, bool relax);
1021 int unquote_many_words(const char **p, ...) _sentinel_;
1023 int free_and_strdup(char **p, const char *s);
1025 int sethostname_idempotent(const char *s);