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_TO_STRING(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]; \
358 #define _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope) \
359 scope type name##_from_string(const char *s) { \
363 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
364 if (name##_table[i] && \
365 streq(name##_table[i], s)) \
370 #define _DEFINE_STRING_TABLE_LOOKUP(name,type,scope) \
371 _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope) \
372 _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope) \
373 struct __useless_struct_to_allow_trailing_semicolon__
375 #define DEFINE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,)
376 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,static)
377 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_TO_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,static)
378 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_FROM_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,static)
380 /* For string conversions where numbers are also acceptable */
381 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max) \
382 int name##_to_string_alloc(type i, char **str) { \
385 if (i < 0 || i > max) \
387 if (i < (type) ELEMENTSOF(name##_table)) { \
388 s = strdup(name##_table[i]); \
392 r = asprintf(&s, "%i", i); \
399 type name##_from_string(const char *s) { \
403 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
404 if (name##_table[i] && \
405 streq(name##_table[i], s)) \
407 if (safe_atou(s, &u) >= 0 && u <= max) \
411 struct __useless_struct_to_allow_trailing_semicolon__
413 int fd_nonblock(int fd, bool nonblock);
414 int fd_cloexec(int fd, bool cloexec);
416 int close_all_fds(const int except[], unsigned n_except);
418 bool fstype_is_network(const char *fstype);
422 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
423 int ask_char(char *ret, const char *replies, const char *text, ...) _printf_(3, 4);
424 int ask_string(char **ret, const char *text, ...) _printf_(2, 3);
426 int reset_terminal_fd(int fd, bool switch_to_text);
427 int reset_terminal(const char *name);
429 int open_terminal(const char *name, int mode);
430 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
431 int release_terminal(void);
433 int flush_fd(int fd);
435 int ignore_signals(int sig, ...);
436 int default_signals(int sig, ...);
437 int sigaction_many(const struct sigaction *sa, ...);
439 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
441 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
442 int loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
444 bool is_device_path(const char *path);
446 int dir_is_empty(const char *path);
447 char* dirname_malloc(const char *path);
449 void rename_process(const char name[8]);
451 void sigset_add_many(sigset_t *ss, ...);
452 int sigprocmask_many(int how, ...);
454 bool hostname_is_set(void);
456 char* lookup_uid(uid_t uid);
457 char* gethostname_malloc(void);
458 char* getlogname_malloc(void);
459 char* getusername_malloc(void);
461 int getttyname_malloc(int fd, char **r);
462 int getttyname_harder(int fd, char **r);
464 int get_ctty_devnr(pid_t pid, dev_t *d);
465 int get_ctty(pid_t, dev_t *_devnr, char **r);
467 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
468 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
470 int is_fd_on_temporary_fs(int fd);
472 int rm_rf_children(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
473 int rm_rf_children_dangerous(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
474 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
475 int rm_rf_dangerous(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
477 int pipe_eof(int fd);
479 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
481 int status_vprintf(const char *status, bool ellipse, bool ephemeral, const char *format, va_list ap) _printf_(4,0);
482 int status_printf(const char *status, bool ellipse, bool ephemeral, const char *format, ...) _printf_(4,5);
484 int fd_columns(int fd);
485 unsigned columns(void);
486 int fd_lines(int fd);
487 unsigned lines(void);
488 void columns_lines_cache_reset(int _unused_ signum);
492 static inline const char *ansi_highlight(void) {
493 return on_tty() ? ANSI_HIGHLIGHT_ON : "";
496 static inline const char *ansi_highlight_red(void) {
497 return on_tty() ? ANSI_HIGHLIGHT_RED_ON : "";
500 static inline const char *ansi_highlight_green(void) {
501 return on_tty() ? ANSI_HIGHLIGHT_GREEN_ON : "";
504 static inline const char *ansi_highlight_yellow(void) {
505 return on_tty() ? ANSI_HIGHLIGHT_YELLOW_ON : "";
508 static inline const char *ansi_highlight_blue(void) {
509 return on_tty() ? ANSI_HIGHLIGHT_BLUE_ON : "";
512 static inline const char *ansi_highlight_off(void) {
513 return on_tty() ? ANSI_HIGHLIGHT_OFF : "";
516 int files_same(const char *filea, const char *fileb);
518 int running_in_chroot(void);
520 char *ellipsize(const char *s, size_t length, unsigned percent);
522 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
524 int touch_file(const char *path, bool parents, usec_t stamp, uid_t uid, gid_t gid, mode_t mode);
525 int touch(const char *path);
527 char *unquote(const char *s, const char *quotes);
528 char *normalize_env_assignment(const char *s);
530 int wait_for_terminate(pid_t pid, siginfo_t *status);
531 int wait_for_terminate_and_warn(const char *name, pid_t pid, bool check_exit_code);
533 noreturn void freeze(void);
535 bool null_or_empty(struct stat *st) _pure_;
536 int null_or_empty_path(const char *fn);
537 int null_or_empty_fd(int fd);
539 DIR *xopendirat(int dirfd, const char *name, int flags);
541 char *fstab_node_to_udev_node(const char *p);
543 char *resolve_dev_console(char **active);
544 bool tty_is_vc(const char *tty);
545 bool tty_is_vc_resolve(const char *tty);
546 bool tty_is_console(const char *tty) _pure_;
547 int vtnr_from_tty(const char *tty);
548 const char *default_term_for_tty(const char *tty);
550 void execute_directories(const char* const* directories, usec_t timeout, char *argv[]);
552 int kill_and_sigcont(pid_t pid, int sig);
554 bool nulstr_contains(const char*nulstr, const char *needle);
556 bool plymouth_running(void);
558 bool hostname_is_valid(const char *s) _pure_;
559 char* hostname_cleanup(char *s, bool lowercase);
561 bool machine_name_is_valid(const char *s) _pure_;
563 char* strshorten(char *s, size_t l);
565 int terminal_vhangup_fd(int fd);
566 int terminal_vhangup(const char *name);
568 int vt_disallocate(const char *name);
570 int symlink_atomic(const char *from, const char *to);
571 int mknod_atomic(const char *path, mode_t mode, dev_t dev);
572 int mkfifo_atomic(const char *path, mode_t mode);
574 int fchmod_umask(int fd, mode_t mode);
576 bool display_is_local(const char *display) _pure_;
577 int socket_from_display(const char *display, char **path);
579 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
580 int get_group_creds(const char **groupname, gid_t *gid);
582 int in_gid(gid_t gid);
583 int in_group(const char *name);
585 char* uid_to_name(uid_t uid);
586 char* gid_to_name(gid_t gid);
588 int glob_exists(const char *path);
589 int glob_extend(char ***strv, const char *path);
591 int dirent_ensure_type(DIR *d, struct dirent *de);
593 int get_files_in_directory(const char *path, char ***list);
595 char *strjoin(const char *x, ...) _sentinel_;
597 bool is_main_thread(void);
599 static inline bool _pure_ in_charset(const char *s, const char* charset) {
602 return s[strspn(s, charset)] == '\0';
605 int block_get_whole_disk(dev_t d, dev_t *ret);
607 #define NULSTR_FOREACH(i, l) \
608 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
610 #define NULSTR_FOREACH_PAIR(i, j, l) \
611 for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
613 int ioprio_class_to_string_alloc(int i, char **s);
614 int ioprio_class_from_string(const char *s);
616 const char *sigchld_code_to_string(int i) _const_;
617 int sigchld_code_from_string(const char *s) _pure_;
619 int log_facility_unshifted_to_string_alloc(int i, char **s);
620 int log_facility_unshifted_from_string(const char *s);
622 int log_level_to_string_alloc(int i, char **s);
623 int log_level_from_string(const char *s);
625 int sched_policy_to_string_alloc(int i, char **s);
626 int sched_policy_from_string(const char *s);
628 const char *rlimit_to_string(int i) _const_;
629 int rlimit_from_string(const char *s) _pure_;
631 int ip_tos_to_string_alloc(int i, char **s);
632 int ip_tos_from_string(const char *s);
634 const char *signal_to_string(int i) _const_;
635 int signal_from_string(const char *s) _pure_;
637 int signal_from_string_try_harder(const char *s);
639 extern int saved_argc;
640 extern char **saved_argv;
642 bool kexec_loaded(void);
644 int prot_from_flags(int flags) _const_;
646 char *format_bytes(char *buf, size_t l, off_t t);
648 int fd_wait_for_event(int fd, int event, usec_t timeout);
650 void* memdup(const void *p, size_t l) _alloc_(2);
652 int is_kernel_thread(pid_t pid);
654 int fd_inc_sndbuf(int fd, size_t n);
655 int fd_inc_rcvbuf(int fd, size_t n);
657 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
659 int setrlimit_closest(int resource, const struct rlimit *rlim);
661 int getenv_for_pid(pid_t pid, const char *field, char **_value);
663 bool http_url_is_valid(const char *url) _pure_;
664 bool documentation_url_is_valid(const char *url) _pure_;
666 bool http_etag_is_valid(const char *etag);
668 bool in_initrd(void);
670 void warn_melody(void);
672 int get_home_dir(char **ret);
673 int get_shell(char **_ret);
675 static inline void freep(void *p) {
679 static inline void closep(int *fd) {
683 static inline void umaskp(mode_t *u) {
687 static inline void close_pairp(int (*p)[2]) {
691 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, fclose);
692 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, pclose);
693 DEFINE_TRIVIAL_CLEANUP_FUNC(DIR*, closedir);
694 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, endmntent);
696 #define _cleanup_free_ _cleanup_(freep)
697 #define _cleanup_close_ _cleanup_(closep)
698 #define _cleanup_umask_ _cleanup_(umaskp)
699 #define _cleanup_globfree_ _cleanup_(globfree)
700 #define _cleanup_fclose_ _cleanup_(fclosep)
701 #define _cleanup_pclose_ _cleanup_(pclosep)
702 #define _cleanup_closedir_ _cleanup_(closedirp)
703 #define _cleanup_endmntent_ _cleanup_(endmntentp)
704 #define _cleanup_close_pair_ _cleanup_(close_pairp)
706 _malloc_ _alloc_(1, 2) static inline void *malloc_multiply(size_t a, size_t b) {
707 if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
710 return malloc(a * b);
713 _alloc_(2, 3) static inline void *realloc_multiply(void *p, size_t a, size_t b) {
714 if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
717 return realloc(p, a * b);
720 _alloc_(2, 3) static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
721 if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
724 return memdup(p, a * b);
727 bool filename_is_valid(const char *p) _pure_;
728 bool path_is_safe(const char *p) _pure_;
729 bool string_is_safe(const char *p) _pure_;
730 bool string_has_cc(const char *p, const char *ok) _pure_;
733 * Check if a string contains any glob patterns.
735 _pure_ static inline bool string_is_glob(const char *p) {
736 return !!strpbrk(p, GLOB_CHARS);
739 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
740 int (*compar) (const void *, const void *, void *),
743 bool is_locale_utf8(void);
745 typedef enum DrawSpecialChar {
750 DRAW_TRIANGULAR_BULLET,
754 _DRAW_SPECIAL_CHAR_MAX
757 const char *draw_special_char(DrawSpecialChar ch);
759 char *strreplace(const char *text, const char *old_string, const char *new_string);
761 char *strip_tab_ansi(char **p, size_t *l);
763 int on_ac_power(void);
765 int search_and_fopen(const char *path, const char *mode, const char *root, const char **search, FILE **_f);
766 int search_and_fopen_nulstr(const char *path, const char *mode, const char *root, const char *search, FILE **_f);
768 #define FOREACH_LINE(line, f, on_error) \
770 if (!fgets(line, sizeof(line), f)) { \
777 #define FOREACH_DIRENT(de, d, on_error) \
778 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
784 } else if (hidden_file((de)->d_name)) \
788 #define FOREACH_DIRENT_ALL(de, d, on_error) \
789 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
797 static inline void *mempset(void *s, int c, size_t n) {
799 return (uint8_t*)s + n;
802 char *hexmem(const void *p, size_t l);
803 void *unhexmem(const char *p, size_t l);
805 char *strextend(char **x, ...) _sentinel_;
806 char *strrep(const char *s, unsigned n);
808 void* greedy_realloc(void **p, size_t *allocated, size_t need, size_t size);
809 void* greedy_realloc0(void **p, size_t *allocated, size_t need, size_t size);
810 #define GREEDY_REALLOC(array, allocated, need) \
811 greedy_realloc((void**) &(array), &(allocated), (need), sizeof((array)[0]))
813 #define GREEDY_REALLOC0(array, allocated, need) \
814 greedy_realloc0((void**) &(array), &(allocated), (need), sizeof((array)[0]))
816 static inline void _reset_errno_(int *saved_errno) {
817 errno = *saved_errno;
820 #define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
822 static inline int negative_errno(void) {
823 /* This helper should be used to shut up gcc if you know 'errno' is
824 * negative. Instead of "return -errno;", use "return negative_errno();"
825 * It will suppress bogus gcc warnings in case it assumes 'errno' might
826 * be 0 and thus the caller's error-handling might not be triggered. */
827 assert_return(errno > 0, -EINVAL);
831 struct _umask_struct_ {
836 static inline void _reset_umask_(struct _umask_struct_ *s) {
840 #define RUN_WITH_UMASK(mask) \
841 for (_cleanup_(_reset_umask_) struct _umask_struct_ _saved_umask_ = { umask(mask), false }; \
842 !_saved_umask_.quit ; \
843 _saved_umask_.quit = true)
845 static inline unsigned u64log2(uint64_t n) {
846 #if __SIZEOF_LONG_LONG__ == 8
847 return (n > 1) ? (unsigned) __builtin_clzll(n) ^ 63U : 0;
853 static inline unsigned u32ctz(uint32_t n) {
854 #if __SIZEOF_INT__ == 4
855 return __builtin_ctz(n);
861 static inline int log2i(int x) {
864 return __SIZEOF_INT__ * 8 - __builtin_clz(x) - 1;
867 static inline unsigned log2u(unsigned x) {
870 return sizeof(unsigned) * 8 - __builtin_clz(x) - 1;
873 static inline unsigned log2u_round_up(unsigned x) {
879 return log2u(x - 1) + 1;
882 static inline bool logind_running(void) {
883 return access("/run/systemd/seats/", F_OK) >= 0;
886 #define DECIMAL_STR_WIDTH(x) \
888 typeof(x) _x_ = (x); \
895 int unlink_noerrno(const char *path);
901 _new_ = alloca(_len_); \
902 (void *) memset(_new_, 0, _len_); \
905 /* It's not clear what alignment glibc/gcc alloca() guarantee, hence provide a guaranteed safe version */
906 #define alloca_align(size, align) \
909 size_t _mask_ = (align) - 1; \
910 _ptr_ = alloca((size) + _mask_); \
911 (void*)(((uintptr_t)_ptr_ + _mask_) & ~_mask_); \
914 #define alloca0_align(size, align) \
917 size_t _size_ = (size); \
918 _new_ = alloca_align(_size_, (align)); \
919 (void*)memset(_new_, 0, _size_); \
922 #define strappenda(a, ...) \
924 int _len = strlen(a); \
927 const char *_appendees_[] = { __VA_ARGS__ }; \
928 for (_i = 0; _i < ELEMENTSOF(_appendees_); _i++) \
929 _len += strlen(_appendees_[_i]); \
930 _d_ = alloca(_len + 1); \
931 _p_ = stpcpy(_d_, a); \
932 for (_i = 0; _i < ELEMENTSOF(_appendees_); _i++) \
933 _p_ = stpcpy(_p_, _appendees_[_i]); \
937 #define procfs_file_alloca(pid, field) \
939 pid_t _pid_ = (pid); \
942 _r_ = ("/proc/self/" field); \
944 _r_ = alloca(strlen("/proc/") + DECIMAL_STR_MAX(pid_t) + 1 + sizeof(field)); \
945 sprintf((char*) _r_, "/proc/"PID_FMT"/" field, _pid_); \
950 bool id128_is_valid(const char *s) _pure_;
952 int split_pair(const char *s, const char *sep, char **l, char **r);
954 int shall_restore_state(void);
957 * Normal qsort requires base to be nonnull. Here were require
958 * that only if nmemb > 0.
960 static inline void qsort_safe(void *base, size_t nmemb, size_t size,
961 int (*compar)(const void *, const void *)) {
964 qsort(base, nmemb, size, compar);
968 int proc_cmdline(char **ret);
969 int parse_proc_cmdline(int (*parse_word)(const char *key, const char *value));
970 int get_proc_cmdline_key(const char *parameter, char **value);
972 int container_get_leader(const char *machine, pid_t *pid);
974 int namespace_open(pid_t pid, int *pidns_fd, int *mntns_fd, int *netns_fd, int *root_fd);
975 int namespace_enter(int pidns_fd, int mntns_fd, int netns_fd, int root_fd);
977 bool pid_is_alive(pid_t pid);
978 bool pid_is_unwaited(pid_t pid);
980 int getpeercred(int fd, struct ucred *ucred);
981 int getpeersec(int fd, char **ret);
983 int writev_safe(int fd, const struct iovec *w, int j);
985 int mkostemp_safe(char *pattern, int flags);
986 int open_tmpfile(const char *path, int flags);
988 int fd_warn_permissions(const char *path, int fd);
990 unsigned long personality_from_string(const char *p);
991 const char *personality_to_string(unsigned long);
993 uint64_t physical_memory(void);
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];
1001 #define FILE_HANDLE_INIT { .handle.handle_bytes = MAX_HANDLE_SZ }
1003 int update_reboot_param_file(const char *param);
1005 int umount_recursive(const char *target, int flags);
1007 int bind_remount_recursive(const char *prefix, bool ro);
1009 int fflush_and_check(FILE *f);
1011 int tempfn_xxxxxx(const char *p, char **ret);
1012 int tempfn_random(const char *p, char **ret);
1013 int tempfn_random_child(const char *p, char **ret);
1015 bool is_localhost(const char *hostname);
1017 int take_password_lock(const char *root);
1019 int is_symlink(const char *path);
1020 int is_dir(const char *path, bool follow);
1022 int unquote_first_word(const char **p, char **ret, bool relax);
1023 int unquote_many_words(const char **p, ...) _sentinel_;
1025 int free_and_strdup(char **p, const char *s);
1027 int sethostname_idempotent(const char *s);
1029 #define INOTIFY_EVENT_MAX (sizeof(struct inotify_event) + NAME_MAX + 1)
1031 #define FOREACH_INOTIFY_EVENT(e, buffer, sz) \
1032 for ((e) = &buffer.ev; \
1033 (uint8_t*) (e) < (uint8_t*) (buffer.raw) + (sz); \
1034 (e) = (struct inotify_event*) ((uint8_t*) (e) + sizeof(struct inotify_event) + (e)->len))
1036 union inotify_event_buffer {
1037 struct inotify_event ev;
1038 uint8_t raw[INOTIFY_EVENT_MAX];
1041 #define laccess(path, mode) faccessat(AT_FDCWD, (path), (mode), AT_SYMLINK_NOFOLLOW)
1043 int ptsname_malloc(int fd, char **ret);
1045 int openpt_in_namespace(pid_t pid, int flags);
1047 ssize_t fgetxattrat_fake(int dirfd, const char *filename, const char *attribute, void *value, size_t size, int flags);
1049 int fd_setcrtime(int fd, usec_t usec);
1050 int fd_getcrtime(int fd, usec_t *usec);
1051 int path_getcrtime(const char *p, usec_t *usec);
1052 int fd_getcrtime_at(int dirfd, const char *name, usec_t *usec, int flags);
1054 int same_fd(int a, int b);
1056 int chattr_fd(int fd, bool b, unsigned mask);
1057 int chattr_path(const char *p, bool b, unsigned mask);
1059 int read_attr_fd(int fd, unsigned *ret);
1060 int read_attr_path(const char *p, unsigned *ret);
1062 typedef struct LockFile {
1068 int make_lock_file(const char *p, int operation, LockFile *ret);
1069 int make_lock_file_for(const char *p, int operation, LockFile *ret);
1070 void release_lock_file(LockFile *f);
1072 #define _cleanup_release_lock_file_ _cleanup_(release_lock_file)
1074 #define LOCK_FILE_INIT { .fd = -1, .path = NULL }
1076 #define RLIMIT_MAKE_CONST(lim) ((struct rlimit) { lim, lim })
1078 ssize_t sparse_write(int fd, const void *p, size_t sz, size_t run_length);
1080 void sigkill_wait(pid_t *pid);
1081 #define _cleanup_sigkill_wait_ _cleanup_(sigkill_wait)
1083 int syslog_parse_priority(const char **p, int *priority, bool with_facility);