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/>.
35 #include <sys/types.h>
36 #include <sys/socket.h>
43 #include <sys/inotify.h>
46 # define PID_PRI PRIi32
47 #elif SIZEOF_PID_T == 2
48 # define PID_PRI PRIi16
50 # error Unknown pid_t size
52 #define PID_FMT "%" PID_PRI
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 PRIi64
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) _pure_;
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* one_zero(bool b) {
146 return b ? "1" : "0";
149 static inline const char* strempty(const char *s) {
153 static inline const char* strnull(const char *s) {
154 return s ? s : "(null)";
157 static inline const char *strna(const char *s) {
158 return s ? s : "n/a";
161 static inline bool isempty(const char *p) {
165 static inline char *startswith(const char *s, const char *prefix) {
169 if (strncmp(s, prefix, l) == 0)
170 return (char*) s + l;
175 static inline char *startswith_no_case(const char *s, const char *prefix) {
179 if (strncasecmp(s, prefix, l) == 0)
180 return (char*) s + l;
185 char *endswith(const char *s, const char *postfix) _pure_;
187 char *first_word(const char *s, const char *word) _pure_;
189 int close_nointr(int fd);
190 int safe_close(int fd);
191 void safe_close_pair(int p[]);
193 void close_many(const int fds[], unsigned n_fd);
195 int parse_size(const char *t, off_t base, off_t *size);
197 int parse_boolean(const char *v) _pure_;
198 int parse_pid(const char *s, pid_t* ret_pid);
199 int parse_uid(const char *s, uid_t* ret_uid);
200 #define parse_gid(s, ret_uid) parse_uid(s, ret_uid)
202 int safe_atou(const char *s, unsigned *ret_u);
203 int safe_atoi(const char *s, int *ret_i);
205 int safe_atollu(const char *s, unsigned long long *ret_u);
206 int safe_atolli(const char *s, long long int *ret_i);
208 int safe_atod(const char *s, double *ret_d);
210 int safe_atou8(const char *s, uint8_t *ret);
212 #if LONG_MAX == INT_MAX
213 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
214 assert_cc(sizeof(unsigned long) == sizeof(unsigned));
215 return safe_atou(s, (unsigned*) ret_u);
217 static inline int safe_atoli(const char *s, long int *ret_u) {
218 assert_cc(sizeof(long int) == sizeof(int));
219 return safe_atoi(s, (int*) ret_u);
222 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
223 assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
224 return safe_atollu(s, (unsigned long long*) ret_u);
226 static inline int safe_atoli(const char *s, long int *ret_u) {
227 assert_cc(sizeof(long int) == sizeof(long long int));
228 return safe_atolli(s, (long long int*) ret_u);
232 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
233 assert_cc(sizeof(uint32_t) == sizeof(unsigned));
234 return safe_atou(s, (unsigned*) ret_u);
237 static inline int safe_atoi32(const char *s, int32_t *ret_i) {
238 assert_cc(sizeof(int32_t) == sizeof(int));
239 return safe_atoi(s, (int*) ret_i);
242 static inline int safe_atou64(const char *s, uint64_t *ret_u) {
243 assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
244 return safe_atollu(s, (unsigned long long*) ret_u);
247 static inline int safe_atoi64(const char *s, int64_t *ret_i) {
248 assert_cc(sizeof(int64_t) == sizeof(long long int));
249 return safe_atolli(s, (long long int*) ret_i);
252 int safe_atou16(const char *s, uint16_t *ret);
253 int safe_atoi16(const char *s, int16_t *ret);
255 const char* split(const char **state, size_t *l, const char *separator, bool quoted);
257 #define FOREACH_WORD(word, length, s, state) \
258 _FOREACH_WORD(word, length, s, WHITESPACE, false, state)
260 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state) \
261 _FOREACH_WORD(word, length, s, separator, false, state)
263 #define FOREACH_WORD_QUOTED(word, length, s, state) \
264 _FOREACH_WORD(word, length, s, WHITESPACE, true, state)
266 #define _FOREACH_WORD(word, length, s, separator, quoted, state) \
267 for ((state) = (s), (word) = split(&(state), &(length), (separator), (quoted)); (word); (word) = split(&(state), &(length), (separator), (quoted)))
269 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
271 char *strappend(const char *s, const char *suffix);
272 char *strnappend(const char *s, const char *suffix, size_t length);
274 char *replace_env(const char *format, char **env);
275 char **replace_env_argv(char **argv, char **env);
277 int readlinkat_malloc(int fd, const char *p, char **ret);
278 int readlink_malloc(const char *p, char **r);
279 int readlink_value(const char *p, char **ret);
280 int readlink_and_make_absolute(const char *p, char **r);
281 int readlink_and_canonicalize(const char *p, char **r);
283 int reset_all_signal_handlers(void);
284 int reset_signal_mask(void);
286 char *strstrip(char *s);
287 char *delete_chars(char *s, const char *bad);
288 char *truncate_nl(char *s);
290 char *file_in_same_dir(const char *path, const char *filename);
292 int rmdir_parents(const char *path, const char *stop);
294 int get_process_state(pid_t pid);
295 int get_process_comm(pid_t pid, char **name);
296 int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
297 int get_process_exe(pid_t pid, char **name);
298 int get_process_uid(pid_t pid, uid_t *uid);
299 int get_process_gid(pid_t pid, gid_t *gid);
300 int get_process_capeff(pid_t pid, char **capeff);
301 int get_process_cwd(pid_t pid, char **cwd);
302 int get_process_root(pid_t pid, char **root);
303 int get_process_environ(pid_t pid, char **environ);
305 char hexchar(int x) _const_;
306 int unhexchar(char c) _const_;
307 char octchar(int x) _const_;
308 int unoctchar(char c) _const_;
309 char decchar(int x) _const_;
310 int undecchar(char c) _const_;
312 char *cescape(const char *s);
313 char *cunescape(const char *s);
314 char *cunescape_length(const char *s, size_t length);
315 char *cunescape_length_with_prefix(const char *s, size_t length, const char *prefix);
317 char *xescape(const char *s, const char *bad);
319 char *ascii_strlower(char *path);
321 bool dirent_is_file(const struct dirent *de) _pure_;
322 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix) _pure_;
324 bool hidden_file(const char *filename) _pure_;
326 bool chars_intersect(const char *a, const char *b) _pure_;
328 int make_stdio(int fd);
329 int make_null_stdio(void);
330 int make_console_stdio(void);
332 int dev_urandom(void *p, size_t n);
333 void random_bytes(void *p, size_t n);
334 void initialize_srand(void);
336 static inline uint64_t random_u64(void) {
338 random_bytes(&u, sizeof(u));
342 static inline uint32_t random_u32(void) {
344 random_bytes(&u, sizeof(u));
348 /* For basic lookup tables with strictly enumerated entries */
349 #define _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope) \
350 scope const char *name##_to_string(type i) { \
351 if (i < 0 || i >= (type) ELEMENTSOF(name##_table)) \
353 return name##_table[i]; \
356 ssize_t string_table_lookup(const char * const *table, size_t len, const char *key);
358 #define _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope) \
359 scope inline type name##_from_string(const char *s) { \
360 return (type)string_table_lookup(name##_table, ELEMENTSOF(name##_table), s); \
363 #define _DEFINE_STRING_TABLE_LOOKUP(name,type,scope) \
364 _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope) \
365 _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope) \
366 struct __useless_struct_to_allow_trailing_semicolon__
368 #define DEFINE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,)
369 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,static)
370 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_TO_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,static)
371 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_FROM_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,static)
373 /* For string conversions where numbers are also acceptable */
374 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max) \
375 int name##_to_string_alloc(type i, char **str) { \
378 if (i < 0 || i > max) \
380 if (i < (type) ELEMENTSOF(name##_table)) { \
381 s = strdup(name##_table[i]); \
385 r = asprintf(&s, "%i", i); \
392 type name##_from_string(const char *s) { \
396 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
397 if (name##_table[i] && \
398 streq(name##_table[i], s)) \
400 if (safe_atou(s, &u) >= 0 && u <= max) \
404 struct __useless_struct_to_allow_trailing_semicolon__
406 int fd_nonblock(int fd, bool nonblock);
407 int fd_cloexec(int fd, bool cloexec);
409 int close_all_fds(const int except[], unsigned n_except);
411 bool fstype_is_network(const char *fstype);
415 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
416 int ask_char(char *ret, const char *replies, const char *text, ...) _printf_(3, 4);
417 int ask_string(char **ret, const char *text, ...) _printf_(2, 3);
419 int reset_terminal_fd(int fd, bool switch_to_text);
420 int reset_terminal(const char *name);
422 int open_terminal(const char *name, int mode);
423 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
424 int release_terminal(void);
426 int flush_fd(int fd);
428 int ignore_signals(int sig, ...);
429 int default_signals(int sig, ...);
430 int sigaction_many(const struct sigaction *sa, ...);
432 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
434 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
435 int loop_read_exact(int fd, void *buf, size_t nbytes, bool do_poll);
436 int loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
438 bool is_device_path(const char *path);
440 int dir_is_empty(const char *path);
441 char* dirname_malloc(const char *path);
443 void rename_process(const char name[8]);
445 void sigset_add_many(sigset_t *ss, ...);
446 int sigprocmask_many(int how, ...);
448 bool hostname_is_set(void);
450 char* lookup_uid(uid_t uid);
451 char* gethostname_malloc(void);
452 char* getlogname_malloc(void);
453 char* getusername_malloc(void);
455 int getttyname_malloc(int fd, char **r);
456 int getttyname_harder(int fd, char **r);
458 int get_ctty_devnr(pid_t pid, dev_t *d);
459 int get_ctty(pid_t, dev_t *_devnr, char **r);
461 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
462 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
464 int is_fd_on_temporary_fs(int fd);
466 int rm_rf_children(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
467 int rm_rf_children_dangerous(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
468 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
469 int rm_rf_dangerous(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
471 int pipe_eof(int fd);
473 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
475 int status_vprintf(const char *status, bool ellipse, bool ephemeral, const char *format, va_list ap) _printf_(4,0);
476 int status_printf(const char *status, bool ellipse, bool ephemeral, const char *format, ...) _printf_(4,5);
478 #define xsprintf(buf, fmt, ...) assert_se((size_t) snprintf(buf, ELEMENTSOF(buf), fmt, __VA_ARGS__) < ELEMENTSOF(buf))
480 int fd_columns(int fd);
481 unsigned columns(void);
482 int fd_lines(int fd);
483 unsigned lines(void);
484 void columns_lines_cache_reset(int _unused_ signum);
488 static inline const char *ansi_highlight(void) {
489 return on_tty() ? ANSI_HIGHLIGHT_ON : "";
492 static inline const char *ansi_highlight_red(void) {
493 return on_tty() ? ANSI_HIGHLIGHT_RED_ON : "";
496 static inline const char *ansi_highlight_green(void) {
497 return on_tty() ? ANSI_HIGHLIGHT_GREEN_ON : "";
500 static inline const char *ansi_highlight_yellow(void) {
501 return on_tty() ? ANSI_HIGHLIGHT_YELLOW_ON : "";
504 static inline const char *ansi_highlight_blue(void) {
505 return on_tty() ? ANSI_HIGHLIGHT_BLUE_ON : "";
508 static inline const char *ansi_highlight_off(void) {
509 return on_tty() ? ANSI_HIGHLIGHT_OFF : "";
512 int files_same(const char *filea, const char *fileb);
514 int running_in_chroot(void);
516 char *ellipsize(const char *s, size_t length, unsigned percent);
518 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
520 int touch_file(const char *path, bool parents, usec_t stamp, uid_t uid, gid_t gid, mode_t mode);
521 int touch(const char *path);
523 char *unquote(const char *s, const char *quotes);
524 char *normalize_env_assignment(const char *s);
526 int wait_for_terminate(pid_t pid, siginfo_t *status);
527 int wait_for_terminate_and_warn(const char *name, pid_t pid, bool check_exit_code);
529 noreturn void freeze(void);
531 bool null_or_empty(struct stat *st) _pure_;
532 int null_or_empty_path(const char *fn);
533 int null_or_empty_fd(int fd);
535 DIR *xopendirat(int dirfd, const char *name, int flags);
537 char *fstab_node_to_udev_node(const char *p);
539 char *resolve_dev_console(char **active);
540 bool tty_is_vc(const char *tty);
541 bool tty_is_vc_resolve(const char *tty);
542 bool tty_is_console(const char *tty) _pure_;
543 int vtnr_from_tty(const char *tty);
544 const char *default_term_for_tty(const char *tty);
546 void execute_directories(const char* const* directories, usec_t timeout, char *argv[]);
548 int kill_and_sigcont(pid_t pid, int sig);
550 bool nulstr_contains(const char*nulstr, const char *needle);
552 bool plymouth_running(void);
554 bool hostname_is_valid(const char *s) _pure_;
555 char* hostname_cleanup(char *s, bool lowercase);
557 bool machine_name_is_valid(const char *s) _pure_;
559 char* strshorten(char *s, size_t l);
561 int terminal_vhangup_fd(int fd);
562 int terminal_vhangup(const char *name);
564 int vt_disallocate(const char *name);
566 int symlink_atomic(const char *from, const char *to);
567 int mknod_atomic(const char *path, mode_t mode, dev_t dev);
568 int mkfifo_atomic(const char *path, mode_t mode);
570 int fchmod_umask(int fd, mode_t mode);
572 bool display_is_local(const char *display) _pure_;
573 int socket_from_display(const char *display, char **path);
575 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
576 int get_group_creds(const char **groupname, gid_t *gid);
578 int in_gid(gid_t gid);
579 int in_group(const char *name);
581 char* uid_to_name(uid_t uid);
582 char* gid_to_name(gid_t gid);
584 int glob_exists(const char *path);
585 int glob_extend(char ***strv, const char *path);
587 int dirent_ensure_type(DIR *d, struct dirent *de);
589 int get_files_in_directory(const char *path, char ***list);
591 char *strjoin(const char *x, ...) _sentinel_;
593 bool is_main_thread(void);
595 static inline bool _pure_ in_charset(const char *s, const char* charset) {
598 return s[strspn(s, charset)] == '\0';
601 int block_get_whole_disk(dev_t d, dev_t *ret);
603 #define NULSTR_FOREACH(i, l) \
604 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
606 #define NULSTR_FOREACH_PAIR(i, j, l) \
607 for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
609 int ioprio_class_to_string_alloc(int i, char **s);
610 int ioprio_class_from_string(const char *s);
612 const char *sigchld_code_to_string(int i) _const_;
613 int sigchld_code_from_string(const char *s) _pure_;
615 int log_facility_unshifted_to_string_alloc(int i, char **s);
616 int log_facility_unshifted_from_string(const char *s);
618 int log_level_to_string_alloc(int i, char **s);
619 int log_level_from_string(const char *s);
621 int sched_policy_to_string_alloc(int i, char **s);
622 int sched_policy_from_string(const char *s);
624 const char *rlimit_to_string(int i) _const_;
625 int rlimit_from_string(const char *s) _pure_;
627 int ip_tos_to_string_alloc(int i, char **s);
628 int ip_tos_from_string(const char *s);
630 const char *signal_to_string(int i) _const_;
631 int signal_from_string(const char *s) _pure_;
633 int signal_from_string_try_harder(const char *s);
635 extern int saved_argc;
636 extern char **saved_argv;
638 bool kexec_loaded(void);
640 int prot_from_flags(int flags) _const_;
642 char *format_bytes(char *buf, size_t l, off_t t);
644 int fd_wait_for_event(int fd, int event, usec_t timeout);
646 void* memdup(const void *p, size_t l) _alloc_(2);
648 int is_kernel_thread(pid_t pid);
650 int fd_inc_sndbuf(int fd, size_t n);
651 int fd_inc_rcvbuf(int fd, size_t n);
653 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
655 int setrlimit_closest(int resource, const struct rlimit *rlim);
657 int getenv_for_pid(pid_t pid, const char *field, char **_value);
659 bool http_url_is_valid(const char *url) _pure_;
660 bool documentation_url_is_valid(const char *url) _pure_;
662 bool http_etag_is_valid(const char *etag);
664 bool in_initrd(void);
666 void warn_melody(void);
668 int get_home_dir(char **ret);
669 int get_shell(char **_ret);
671 static inline void freep(void *p) {
675 static inline void closep(int *fd) {
679 static inline void umaskp(mode_t *u) {
683 static inline void close_pairp(int (*p)[2]) {
687 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, fclose);
688 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, pclose);
689 DEFINE_TRIVIAL_CLEANUP_FUNC(DIR*, closedir);
690 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, endmntent);
692 #define _cleanup_free_ _cleanup_(freep)
693 #define _cleanup_close_ _cleanup_(closep)
694 #define _cleanup_umask_ _cleanup_(umaskp)
695 #define _cleanup_globfree_ _cleanup_(globfree)
696 #define _cleanup_fclose_ _cleanup_(fclosep)
697 #define _cleanup_pclose_ _cleanup_(pclosep)
698 #define _cleanup_closedir_ _cleanup_(closedirp)
699 #define _cleanup_endmntent_ _cleanup_(endmntentp)
700 #define _cleanup_close_pair_ _cleanup_(close_pairp)
702 _malloc_ _alloc_(1, 2) static inline void *malloc_multiply(size_t a, size_t b) {
703 if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
706 return malloc(a * b);
709 _alloc_(2, 3) static inline void *realloc_multiply(void *p, size_t a, size_t b) {
710 if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
713 return realloc(p, a * b);
716 _alloc_(2, 3) static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
717 if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
720 return memdup(p, a * b);
723 bool filename_is_valid(const char *p) _pure_;
724 bool path_is_safe(const char *p) _pure_;
725 bool string_is_safe(const char *p) _pure_;
726 bool string_has_cc(const char *p, const char *ok) _pure_;
729 * Check if a string contains any glob patterns.
731 _pure_ static inline bool string_is_glob(const char *p) {
732 return !!strpbrk(p, GLOB_CHARS);
735 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
736 int (*compar) (const void *, const void *, void *),
739 #define _(String) gettext (String)
740 void init_gettext(void);
741 bool is_locale_utf8(void);
743 typedef enum DrawSpecialChar {
748 DRAW_TRIANGULAR_BULLET,
752 _DRAW_SPECIAL_CHAR_MAX
755 const char *draw_special_char(DrawSpecialChar ch);
757 char *strreplace(const char *text, const char *old_string, const char *new_string);
759 char *strip_tab_ansi(char **p, size_t *l);
761 int on_ac_power(void);
763 int search_and_fopen(const char *path, const char *mode, const char *root, const char **search, FILE **_f);
764 int search_and_fopen_nulstr(const char *path, const char *mode, const char *root, const char *search, FILE **_f);
766 #define FOREACH_LINE(line, f, on_error) \
768 if (!fgets(line, sizeof(line), f)) { \
775 #define FOREACH_DIRENT(de, d, on_error) \
776 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
782 } else if (hidden_file((de)->d_name)) \
786 #define FOREACH_DIRENT_ALL(de, d, on_error) \
787 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
795 static inline void *mempset(void *s, int c, size_t n) {
797 return (uint8_t*)s + n;
800 char *hexmem(const void *p, size_t l);
801 void *unhexmem(const char *p, size_t l);
803 char *strextend(char **x, ...) _sentinel_;
804 char *strrep(const char *s, unsigned n);
806 void* greedy_realloc(void **p, size_t *allocated, size_t need, size_t size);
807 void* greedy_realloc0(void **p, size_t *allocated, size_t need, size_t size);
808 #define GREEDY_REALLOC(array, allocated, need) \
809 greedy_realloc((void**) &(array), &(allocated), (need), sizeof((array)[0]))
811 #define GREEDY_REALLOC0(array, allocated, need) \
812 greedy_realloc0((void**) &(array), &(allocated), (need), sizeof((array)[0]))
814 static inline void _reset_errno_(int *saved_errno) {
815 errno = *saved_errno;
818 #define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
820 static inline int negative_errno(void) {
821 /* This helper should be used to shut up gcc if you know 'errno' is
822 * negative. Instead of "return -errno;", use "return negative_errno();"
823 * It will suppress bogus gcc warnings in case it assumes 'errno' might
824 * be 0 and thus the caller's error-handling might not be triggered. */
825 assert_return(errno > 0, -EINVAL);
829 struct _umask_struct_ {
834 static inline void _reset_umask_(struct _umask_struct_ *s) {
838 #define RUN_WITH_UMASK(mask) \
839 for (_cleanup_(_reset_umask_) struct _umask_struct_ _saved_umask_ = { umask(mask), false }; \
840 !_saved_umask_.quit ; \
841 _saved_umask_.quit = true)
843 static inline unsigned u64log2(uint64_t n) {
844 #if __SIZEOF_LONG_LONG__ == 8
845 return (n > 1) ? (unsigned) __builtin_clzll(n) ^ 63U : 0;
851 static inline unsigned u32ctz(uint32_t n) {
852 #if __SIZEOF_INT__ == 4
853 return __builtin_ctz(n);
859 static inline unsigned log2i(int x) {
862 return __SIZEOF_INT__ * 8 - __builtin_clz(x) - 1;
865 static inline unsigned log2u(unsigned x) {
868 return sizeof(unsigned) * 8 - __builtin_clz(x) - 1;
871 static inline unsigned log2u_round_up(unsigned x) {
877 return log2u(x - 1) + 1;
880 static inline bool logind_running(void) {
881 return access("/run/systemd/seats/", F_OK) >= 0;
884 #define DECIMAL_STR_WIDTH(x) \
886 typeof(x) _x_ = (x); \
893 int unlink_noerrno(const char *path);
899 _new_ = alloca(_len_); \
900 (void *) memset(_new_, 0, _len_); \
903 /* It's not clear what alignment glibc/gcc alloca() guarantee, hence provide a guaranteed safe version */
904 #define alloca_align(size, align) \
907 size_t _mask_ = (align) - 1; \
908 _ptr_ = alloca((size) + _mask_); \
909 (void*)(((uintptr_t)_ptr_ + _mask_) & ~_mask_); \
912 #define alloca0_align(size, align) \
915 size_t _size_ = (size); \
916 _new_ = alloca_align(_size_, (align)); \
917 (void*)memset(_new_, 0, _size_); \
920 #define strjoina(a, ...) \
922 const char *_appendees_[] = { a, __VA_ARGS__ }; \
926 for (_i_ = 0; _i_ < ELEMENTSOF(_appendees_) && _appendees_[_i_]; _i_++) \
927 _len_ += strlen(_appendees_[_i_]); \
928 _p_ = _d_ = alloca(_len_ + 1); \
929 for (_i_ = 0; _i_ < ELEMENTSOF(_appendees_) && _appendees_[_i_]; _i_++) \
930 _p_ = stpcpy(_p_, _appendees_[_i_]); \
935 #define procfs_file_alloca(pid, field) \
937 pid_t _pid_ = (pid); \
940 _r_ = ("/proc/self/" field); \
942 _r_ = alloca(strlen("/proc/") + DECIMAL_STR_MAX(pid_t) + 1 + sizeof(field)); \
943 sprintf((char*) _r_, "/proc/"PID_FMT"/" field, _pid_); \
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));
968 int get_proc_cmdline_key(const char *parameter, 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 void hexdump(FILE *f, const void *p, size_t s);
995 union file_handle_union {
996 struct file_handle handle;
997 char padding[sizeof(struct file_handle) + MAX_HANDLE_SZ];
999 #define FILE_HANDLE_INIT { .handle.handle_bytes = 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 int tempfn_xxxxxx(const char *p, char **ret);
1010 int tempfn_random(const char *p, char **ret);
1011 int tempfn_random_child(const char *p, char **ret);
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 typedef enum UnquoteFlags{
1022 UNQUOTE_CUNESCAPE = 2,
1025 int unquote_first_word(const char **p, char **ret, UnquoteFlags flags);
1026 int unquote_many_words(const char **p, UnquoteFlags flags, ...) _sentinel_;
1028 int free_and_strdup(char **p, const char *s);
1030 int sethostname_idempotent(const char *s);
1032 #define INOTIFY_EVENT_MAX (sizeof(struct inotify_event) + NAME_MAX + 1)
1034 #define FOREACH_INOTIFY_EVENT(e, buffer, sz) \
1035 for ((e) = &buffer.ev; \
1036 (uint8_t*) (e) < (uint8_t*) (buffer.raw) + (sz); \
1037 (e) = (struct inotify_event*) ((uint8_t*) (e) + sizeof(struct inotify_event) + (e)->len))
1039 union inotify_event_buffer {
1040 struct inotify_event ev;
1041 uint8_t raw[INOTIFY_EVENT_MAX];
1044 #define laccess(path, mode) faccessat(AT_FDCWD, (path), (mode), AT_SYMLINK_NOFOLLOW)
1046 int ptsname_malloc(int fd, char **ret);
1048 int openpt_in_namespace(pid_t pid, int flags);
1050 ssize_t fgetxattrat_fake(int dirfd, const char *filename, const char *attribute, void *value, size_t size, int flags);
1052 int fd_setcrtime(int fd, usec_t usec);
1053 int fd_getcrtime(int fd, usec_t *usec);
1054 int path_getcrtime(const char *p, usec_t *usec);
1055 int fd_getcrtime_at(int dirfd, const char *name, usec_t *usec, int flags);
1057 int chattr_fd(int fd, bool b, unsigned mask);
1058 int chattr_path(const char *p, bool b, unsigned mask);
1059 int change_attr_fd(int fd, unsigned value, unsigned mask);
1061 int read_attr_fd(int fd, unsigned *ret);
1062 int read_attr_path(const char *p, unsigned *ret);
1064 typedef struct LockFile {
1070 int make_lock_file(const char *p, int operation, LockFile *ret);
1071 int make_lock_file_for(const char *p, int operation, LockFile *ret);
1072 void release_lock_file(LockFile *f);
1074 #define _cleanup_release_lock_file_ _cleanup_(release_lock_file)
1076 #define LOCK_FILE_INIT { .fd = -1, .path = NULL }
1078 #define RLIMIT_MAKE_CONST(lim) ((struct rlimit) { lim, lim })
1080 ssize_t sparse_write(int fd, const void *p, size_t sz, size_t run_length);
1082 void sigkill_wait(pid_t *pid);
1083 #define _cleanup_sigkill_wait_ _cleanup_(sigkill_wait)
1085 int syslog_parse_priority(const char **p, int *priority, bool with_facility);
1087 void cmsg_close_all(struct msghdr *mh);
1089 int rename_noreplace(int olddirfd, const char *oldpath, int newdirfd, const char *newpath);