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>
44 #include <sys/statfs.h>
47 # define PID_PRI PRIi32
48 #elif SIZEOF_PID_T == 2
49 # define PID_PRI PRIi16
51 # error Unknown pid_t size
53 #define PID_FMT "%" PID_PRI
56 # define UID_FMT "%" PRIu32
57 #elif SIZEOF_UID_T == 2
58 # define UID_FMT "%" PRIu16
60 # error Unknown uid_t size
64 # define GID_FMT "%" PRIu32
65 #elif SIZEOF_GID_T == 2
66 # define GID_FMT "%" PRIu16
68 # error Unknown gid_t size
71 #if SIZEOF_TIME_T == 8
72 # define PRI_TIME PRIi64
73 #elif SIZEOF_TIME_T == 4
74 # define PRI_TIME PRIu32
76 # error Unknown time_t size
79 #if SIZEOF_RLIM_T == 8
80 # define RLIM_FMT "%" PRIu64
81 #elif SIZEOF_RLIM_T == 4
82 # define RLIM_FMT "%" PRIu32
84 # error Unknown rlim_t size
89 #include "time-util.h"
91 /* What is interpreted as whitespace? */
92 #define WHITESPACE " \t\n\r"
93 #define NEWLINE "\n\r"
96 #define GLOB_CHARS "*?["
98 /* What characters are special in the shell? */
99 /* must be escaped outside and inside double-quotes */
100 #define SHELL_NEED_ESCAPE "\"\\`$"
101 /* can be escaped or double-quoted */
102 #define SHELL_NEED_QUOTES SHELL_NEED_ESCAPE GLOB_CHARS "'()<>|&;"
104 #define FORMAT_BYTES_MAX 8
106 #define ANSI_HIGHLIGHT_ON "\x1B[1;39m"
107 #define ANSI_RED_ON "\x1B[31m"
108 #define ANSI_HIGHLIGHT_RED_ON "\x1B[1;31m"
109 #define ANSI_GREEN_ON "\x1B[32m"
110 #define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
111 #define ANSI_HIGHLIGHT_YELLOW_ON "\x1B[1;33m"
112 #define ANSI_HIGHLIGHT_BLUE_ON "\x1B[1;34m"
113 #define ANSI_HIGHLIGHT_OFF "\x1B[0m"
114 #define ANSI_ERASE_TO_END_OF_LINE "\x1B[K"
116 size_t page_size(void) _pure_;
117 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
119 #define streq(a,b) (strcmp((a),(b)) == 0)
120 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
121 #define strcaseeq(a,b) (strcasecmp((a),(b)) == 0)
122 #define strncaseeq(a, b, n) (strncasecmp((a), (b), (n)) == 0)
124 bool streq_ptr(const char *a, const char *b) _pure_;
126 #define new(t, n) ((t*) malloc_multiply(sizeof(t), (n)))
128 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
130 #define newa(t, n) ((t*) alloca(sizeof(t)*(n)))
132 #define newa0(t, n) ((t*) alloca0(sizeof(t)*(n)))
134 #define newdup(t, p, n) ((t*) memdup_multiply(p, sizeof(t), (n)))
136 #define malloc0(n) (calloc((n), 1))
138 static inline const char* yes_no(bool b) {
139 return b ? "yes" : "no";
142 static inline const char* true_false(bool b) {
143 return b ? "true" : "false";
146 static inline const char* one_zero(bool b) {
147 return b ? "1" : "0";
150 static inline const char* strempty(const char *s) {
154 static inline const char* strnull(const char *s) {
155 return s ? s : "(null)";
158 static inline const char *strna(const char *s) {
159 return s ? s : "n/a";
162 static inline bool isempty(const char *p) {
166 static inline char *startswith(const char *s, const char *prefix) {
170 if (strncmp(s, prefix, l) == 0)
171 return (char*) s + l;
176 static inline char *startswith_no_case(const char *s, const char *prefix) {
180 if (strncasecmp(s, prefix, l) == 0)
181 return (char*) s + l;
186 char *endswith(const char *s, const char *postfix) _pure_;
187 char *endswith_no_case(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);
316 typedef enum UnescapeFlags {
320 int cunescape(const char *s, UnescapeFlags flags, char **ret);
321 int cunescape_length(const char *s, size_t length, UnescapeFlags flags, char **ret);
322 int cunescape_length_with_prefix(const char *s, size_t length, const char *prefix, UnescapeFlags flags, char **ret);
324 char *xescape(const char *s, const char *bad);
326 char *ascii_strlower(char *path);
328 bool dirent_is_file(const struct dirent *de) _pure_;
329 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix) _pure_;
331 bool hidden_file(const char *filename) _pure_;
333 bool chars_intersect(const char *a, const char *b) _pure_;
335 int make_stdio(int fd);
336 int make_null_stdio(void);
337 int make_console_stdio(void);
339 int dev_urandom(void *p, size_t n);
340 void random_bytes(void *p, size_t n);
341 void initialize_srand(void);
343 static inline uint64_t random_u64(void) {
345 random_bytes(&u, sizeof(u));
349 static inline uint32_t random_u32(void) {
351 random_bytes(&u, sizeof(u));
355 /* For basic lookup tables with strictly enumerated entries */
356 #define _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope) \
357 scope const char *name##_to_string(type i) { \
358 if (i < 0 || i >= (type) ELEMENTSOF(name##_table)) \
360 return name##_table[i]; \
363 ssize_t string_table_lookup(const char * const *table, size_t len, const char *key);
365 #define _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope) \
366 scope inline type name##_from_string(const char *s) { \
367 return (type)string_table_lookup(name##_table, ELEMENTSOF(name##_table), 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_read_exact(int fd, void *buf, size_t nbytes, bool do_poll);
443 int loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
445 bool is_device_path(const char *path);
447 int dir_is_empty(const char *path);
448 char* dirname_malloc(const char *path);
450 void rename_process(const char name[8]);
452 void sigset_add_many(sigset_t *ss, ...);
453 int sigprocmask_many(int how, ...);
455 bool hostname_is_set(void);
457 char* lookup_uid(uid_t uid);
458 char* gethostname_malloc(void);
459 char* getlogname_malloc(void);
460 char* getusername_malloc(void);
462 int getttyname_malloc(int fd, char **r);
463 int getttyname_harder(int fd, char **r);
465 int get_ctty_devnr(pid_t pid, dev_t *d);
466 int get_ctty(pid_t, dev_t *_devnr, char **r);
468 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
469 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
471 bool is_temporary_fs(const struct statfs *s) _pure_;
472 int fd_is_temporary_fs(int fd);
474 int pipe_eof(int fd);
476 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
478 int status_vprintf(const char *status, bool ellipse, bool ephemeral, const char *format, va_list ap) _printf_(4,0);
479 int status_printf(const char *status, bool ellipse, bool ephemeral, const char *format, ...) _printf_(4,5);
481 #define xsprintf(buf, fmt, ...) assert_se((size_t) snprintf(buf, ELEMENTSOF(buf), fmt, __VA_ARGS__) < ELEMENTSOF(buf))
483 int fd_columns(int fd);
484 unsigned columns(void);
485 int fd_lines(int fd);
486 unsigned lines(void);
487 void columns_lines_cache_reset(int _unused_ signum);
491 static inline const char *ansi_highlight(void) {
492 return on_tty() ? ANSI_HIGHLIGHT_ON : "";
495 static inline const char *ansi_highlight_red(void) {
496 return on_tty() ? ANSI_HIGHLIGHT_RED_ON : "";
499 static inline const char *ansi_highlight_green(void) {
500 return on_tty() ? ANSI_HIGHLIGHT_GREEN_ON : "";
503 static inline const char *ansi_highlight_yellow(void) {
504 return on_tty() ? ANSI_HIGHLIGHT_YELLOW_ON : "";
507 static inline const char *ansi_highlight_blue(void) {
508 return on_tty() ? ANSI_HIGHLIGHT_BLUE_ON : "";
511 static inline const char *ansi_highlight_off(void) {
512 return on_tty() ? ANSI_HIGHLIGHT_OFF : "";
515 int files_same(const char *filea, const char *fileb);
517 int running_in_chroot(void);
519 char *ellipsize(const char *s, size_t length, unsigned percent);
521 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
523 int touch_file(const char *path, bool parents, usec_t stamp, uid_t uid, gid_t gid, mode_t mode);
524 int touch(const char *path);
526 char *unquote(const char *s, const char *quotes);
527 char *normalize_env_assignment(const char *s);
529 int wait_for_terminate(pid_t pid, siginfo_t *status);
530 int wait_for_terminate_and_warn(const char *name, pid_t pid, bool check_exit_code);
532 noreturn void freeze(void);
534 bool null_or_empty(struct stat *st) _pure_;
535 int null_or_empty_path(const char *fn);
536 int null_or_empty_fd(int fd);
538 DIR *xopendirat(int dirfd, const char *name, int flags);
540 char *fstab_node_to_udev_node(const char *p);
542 char *resolve_dev_console(char **active);
543 bool tty_is_vc(const char *tty);
544 bool tty_is_vc_resolve(const char *tty);
545 bool tty_is_console(const char *tty) _pure_;
546 int vtnr_from_tty(const char *tty);
547 const char *default_term_for_tty(const char *tty);
549 void execute_directories(const char* const* directories, usec_t timeout, char *argv[]);
551 int kill_and_sigcont(pid_t pid, int sig);
553 bool nulstr_contains(const char*nulstr, const char *needle);
555 bool plymouth_running(void);
557 bool hostname_is_valid(const char *s) _pure_;
558 char* hostname_cleanup(char *s, bool lowercase);
560 bool machine_name_is_valid(const char *s) _pure_;
562 char* strshorten(char *s, size_t l);
564 int terminal_vhangup_fd(int fd);
565 int terminal_vhangup(const char *name);
567 int vt_disallocate(const char *name);
569 int symlink_atomic(const char *from, const char *to);
570 int mknod_atomic(const char *path, mode_t mode, dev_t dev);
571 int mkfifo_atomic(const char *path, mode_t mode);
573 int fchmod_umask(int fd, mode_t mode);
575 bool display_is_local(const char *display) _pure_;
576 int socket_from_display(const char *display, char **path);
578 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
579 int get_group_creds(const char **groupname, gid_t *gid);
581 int in_gid(gid_t gid);
582 int in_group(const char *name);
584 char* uid_to_name(uid_t uid);
585 char* gid_to_name(gid_t gid);
587 int glob_exists(const char *path);
588 int glob_extend(char ***strv, const char *path);
590 int dirent_ensure_type(DIR *d, struct dirent *de);
592 int get_files_in_directory(const char *path, char ***list);
594 char *strjoin(const char *x, ...) _sentinel_;
596 bool is_main_thread(void);
598 static inline bool _pure_ in_charset(const char *s, const char* charset) {
601 return s[strspn(s, charset)] == '\0';
604 int block_get_whole_disk(dev_t d, dev_t *ret);
606 #define NULSTR_FOREACH(i, l) \
607 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
609 #define NULSTR_FOREACH_PAIR(i, j, l) \
610 for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
612 int ioprio_class_to_string_alloc(int i, char **s);
613 int ioprio_class_from_string(const char *s);
615 const char *sigchld_code_to_string(int i) _const_;
616 int sigchld_code_from_string(const char *s) _pure_;
618 int log_facility_unshifted_to_string_alloc(int i, char **s);
619 int log_facility_unshifted_from_string(const char *s);
621 int log_level_to_string_alloc(int i, char **s);
622 int log_level_from_string(const char *s);
624 int sched_policy_to_string_alloc(int i, char **s);
625 int sched_policy_from_string(const char *s);
627 const char *rlimit_to_string(int i) _const_;
628 int rlimit_from_string(const char *s) _pure_;
630 int ip_tos_to_string_alloc(int i, char **s);
631 int ip_tos_from_string(const char *s);
633 const char *signal_to_string(int i) _const_;
634 int signal_from_string(const char *s) _pure_;
636 int signal_from_string_try_harder(const char *s);
638 extern int saved_argc;
639 extern char **saved_argv;
641 bool kexec_loaded(void);
643 int prot_from_flags(int flags) _const_;
645 char *format_bytes(char *buf, size_t l, off_t t);
647 int fd_wait_for_event(int fd, int event, usec_t timeout);
649 void* memdup(const void *p, size_t l) _alloc_(2);
651 int is_kernel_thread(pid_t pid);
653 int fd_inc_sndbuf(int fd, size_t n);
654 int fd_inc_rcvbuf(int fd, size_t n);
656 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
658 int setrlimit_closest(int resource, const struct rlimit *rlim);
660 int getenv_for_pid(pid_t pid, const char *field, char **_value);
662 bool http_url_is_valid(const char *url) _pure_;
663 bool documentation_url_is_valid(const char *url) _pure_;
665 bool http_etag_is_valid(const char *etag);
667 bool in_initrd(void);
669 void warn_melody(void);
671 int get_home_dir(char **ret);
672 int get_shell(char **_ret);
674 static inline void freep(void *p) {
678 static inline void closep(int *fd) {
682 static inline void umaskp(mode_t *u) {
686 static inline void close_pairp(int (*p)[2]) {
690 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, fclose);
691 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, pclose);
692 DEFINE_TRIVIAL_CLEANUP_FUNC(DIR*, closedir);
693 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, endmntent);
695 #define _cleanup_free_ _cleanup_(freep)
696 #define _cleanup_close_ _cleanup_(closep)
697 #define _cleanup_umask_ _cleanup_(umaskp)
698 #define _cleanup_globfree_ _cleanup_(globfree)
699 #define _cleanup_fclose_ _cleanup_(fclosep)
700 #define _cleanup_pclose_ _cleanup_(pclosep)
701 #define _cleanup_closedir_ _cleanup_(closedirp)
702 #define _cleanup_endmntent_ _cleanup_(endmntentp)
703 #define _cleanup_close_pair_ _cleanup_(close_pairp)
705 _malloc_ _alloc_(1, 2) static inline void *malloc_multiply(size_t a, size_t b) {
706 if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
709 return malloc(a * b);
712 _alloc_(2, 3) static inline void *realloc_multiply(void *p, size_t a, size_t b) {
713 if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
716 return realloc(p, a * b);
719 _alloc_(2, 3) static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
720 if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
723 return memdup(p, a * b);
726 bool filename_is_valid(const char *p) _pure_;
727 bool path_is_safe(const char *p) _pure_;
728 bool string_is_safe(const char *p) _pure_;
729 bool string_has_cc(const char *p, const char *ok) _pure_;
732 * Check if a string contains any glob patterns.
734 _pure_ static inline bool string_is_glob(const char *p) {
735 return !!strpbrk(p, GLOB_CHARS);
738 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
739 int (*compar) (const void *, const void *, void *),
742 #define _(String) gettext (String)
743 void init_gettext(void);
744 bool is_locale_utf8(void);
746 typedef enum DrawSpecialChar {
751 DRAW_TRIANGULAR_BULLET,
755 _DRAW_SPECIAL_CHAR_MAX
758 const char *draw_special_char(DrawSpecialChar ch);
760 char *strreplace(const char *text, const char *old_string, const char *new_string);
762 char *strip_tab_ansi(char **p, size_t *l);
764 int on_ac_power(void);
766 int search_and_fopen(const char *path, const char *mode, const char *root, const char **search, FILE **_f);
767 int search_and_fopen_nulstr(const char *path, const char *mode, const char *root, const char *search, FILE **_f);
769 #define FOREACH_LINE(line, f, on_error) \
771 if (!fgets(line, sizeof(line), f)) { \
778 #define FOREACH_DIRENT(de, d, on_error) \
779 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
785 } else if (hidden_file((de)->d_name)) \
789 #define FOREACH_DIRENT_ALL(de, d, on_error) \
790 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
798 static inline void *mempset(void *s, int c, size_t n) {
800 return (uint8_t*)s + n;
803 char *hexmem(const void *p, size_t l);
804 void *unhexmem(const char *p, size_t l);
806 char *strextend(char **x, ...) _sentinel_;
807 char *strrep(const char *s, unsigned n);
809 void* greedy_realloc(void **p, size_t *allocated, size_t need, size_t size);
810 void* greedy_realloc0(void **p, size_t *allocated, size_t need, size_t size);
811 #define GREEDY_REALLOC(array, allocated, need) \
812 greedy_realloc((void**) &(array), &(allocated), (need), sizeof((array)[0]))
814 #define GREEDY_REALLOC0(array, allocated, need) \
815 greedy_realloc0((void**) &(array), &(allocated), (need), sizeof((array)[0]))
817 static inline void _reset_errno_(int *saved_errno) {
818 errno = *saved_errno;
821 #define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
823 static inline int negative_errno(void) {
824 /* This helper should be used to shut up gcc if you know 'errno' is
825 * negative. Instead of "return -errno;", use "return negative_errno();"
826 * It will suppress bogus gcc warnings in case it assumes 'errno' might
827 * be 0 and thus the caller's error-handling might not be triggered. */
828 assert_return(errno > 0, -EINVAL);
832 struct _umask_struct_ {
837 static inline void _reset_umask_(struct _umask_struct_ *s) {
841 #define RUN_WITH_UMASK(mask) \
842 for (_cleanup_(_reset_umask_) struct _umask_struct_ _saved_umask_ = { umask(mask), false }; \
843 !_saved_umask_.quit ; \
844 _saved_umask_.quit = true)
846 static inline unsigned u64log2(uint64_t n) {
847 #if __SIZEOF_LONG_LONG__ == 8
848 return (n > 1) ? (unsigned) __builtin_clzll(n) ^ 63U : 0;
854 static inline unsigned u32ctz(uint32_t n) {
855 #if __SIZEOF_INT__ == 4
856 return __builtin_ctz(n);
862 static inline unsigned log2i(int x) {
865 return __SIZEOF_INT__ * 8 - __builtin_clz(x) - 1;
868 static inline unsigned log2u(unsigned x) {
871 return sizeof(unsigned) * 8 - __builtin_clz(x) - 1;
874 static inline unsigned log2u_round_up(unsigned x) {
880 return log2u(x - 1) + 1;
883 static inline bool logind_running(void) {
884 return access("/run/systemd/seats/", F_OK) >= 0;
887 #define DECIMAL_STR_WIDTH(x) \
889 typeof(x) _x_ = (x); \
896 int unlink_noerrno(const char *path);
902 _new_ = alloca(_len_); \
903 (void *) memset(_new_, 0, _len_); \
906 /* It's not clear what alignment glibc/gcc alloca() guarantee, hence provide a guaranteed safe version */
907 #define alloca_align(size, align) \
910 size_t _mask_ = (align) - 1; \
911 _ptr_ = alloca((size) + _mask_); \
912 (void*)(((uintptr_t)_ptr_ + _mask_) & ~_mask_); \
915 #define alloca0_align(size, align) \
918 size_t _size_ = (size); \
919 _new_ = alloca_align(_size_, (align)); \
920 (void*)memset(_new_, 0, _size_); \
923 #define strjoina(a, ...) \
925 const char *_appendees_[] = { a, __VA_ARGS__ }; \
929 for (_i_ = 0; _i_ < ELEMENTSOF(_appendees_) && _appendees_[_i_]; _i_++) \
930 _len_ += strlen(_appendees_[_i_]); \
931 _p_ = _d_ = alloca(_len_ + 1); \
932 for (_i_ = 0; _i_ < ELEMENTSOF(_appendees_) && _appendees_[_i_]; _i_++) \
933 _p_ = stpcpy(_p_, _appendees_[_i_]); \
938 #define procfs_file_alloca(pid, field) \
940 pid_t _pid_ = (pid); \
943 _r_ = ("/proc/self/" field); \
945 _r_ = alloca(strlen("/proc/") + DECIMAL_STR_MAX(pid_t) + 1 + sizeof(field)); \
946 sprintf((char*) _r_, "/proc/"PID_FMT"/" field, _pid_); \
951 bool id128_is_valid(const char *s) _pure_;
953 int split_pair(const char *s, const char *sep, char **l, char **r);
955 int shall_restore_state(void);
958 * Normal qsort requires base to be nonnull. Here were require
959 * that only if nmemb > 0.
961 static inline void qsort_safe(void *base, size_t nmemb, size_t size,
962 int (*compar)(const void *, const void *)) {
965 qsort(base, nmemb, size, compar);
969 int proc_cmdline(char **ret);
970 int parse_proc_cmdline(int (*parse_word)(const char *key, const char *value));
971 int get_proc_cmdline_key(const char *parameter, char **value);
973 int container_get_leader(const char *machine, pid_t *pid);
975 int namespace_open(pid_t pid, int *pidns_fd, int *mntns_fd, int *netns_fd, int *root_fd);
976 int namespace_enter(int pidns_fd, int mntns_fd, int netns_fd, int root_fd);
978 bool pid_is_alive(pid_t pid);
979 bool pid_is_unwaited(pid_t pid);
981 int getpeercred(int fd, struct ucred *ucred);
982 int getpeersec(int fd, char **ret);
984 int writev_safe(int fd, const struct iovec *w, int j);
986 int mkostemp_safe(char *pattern, int flags);
987 int open_tmpfile(const char *path, int flags);
989 int fd_warn_permissions(const char *path, int fd);
991 unsigned long personality_from_string(const char *p);
992 const char *personality_to_string(unsigned long);
994 uint64_t physical_memory(void);
996 void hexdump(FILE *f, const void *p, size_t s);
998 union file_handle_union {
999 struct file_handle handle;
1000 char padding[sizeof(struct file_handle) + MAX_HANDLE_SZ];
1002 #define FILE_HANDLE_INIT { .handle.handle_bytes = MAX_HANDLE_SZ }
1004 int update_reboot_param_file(const char *param);
1006 int umount_recursive(const char *target, int flags);
1008 int bind_remount_recursive(const char *prefix, bool ro);
1010 int fflush_and_check(FILE *f);
1012 int tempfn_xxxxxx(const char *p, char **ret);
1013 int tempfn_random(const char *p, char **ret);
1014 int tempfn_random_child(const char *p, char **ret);
1016 bool is_localhost(const char *hostname);
1018 int take_password_lock(const char *root);
1020 int is_symlink(const char *path);
1021 int is_dir(const char *path, bool follow);
1023 typedef enum UnquoteFlags {
1025 UNQUOTE_CUNESCAPE = 2,
1028 int unquote_first_word(const char **p, char **ret, UnquoteFlags flags);
1029 int unquote_many_words(const char **p, UnquoteFlags flags, ...) _sentinel_;
1031 int free_and_strdup(char **p, const char *s);
1033 int sethostname_idempotent(const char *s);
1035 #define INOTIFY_EVENT_MAX (sizeof(struct inotify_event) + NAME_MAX + 1)
1037 #define FOREACH_INOTIFY_EVENT(e, buffer, sz) \
1038 for ((e) = &buffer.ev; \
1039 (uint8_t*) (e) < (uint8_t*) (buffer.raw) + (sz); \
1040 (e) = (struct inotify_event*) ((uint8_t*) (e) + sizeof(struct inotify_event) + (e)->len))
1042 union inotify_event_buffer {
1043 struct inotify_event ev;
1044 uint8_t raw[INOTIFY_EVENT_MAX];
1047 #define laccess(path, mode) faccessat(AT_FDCWD, (path), (mode), AT_SYMLINK_NOFOLLOW)
1049 int ptsname_malloc(int fd, char **ret);
1051 int openpt_in_namespace(pid_t pid, int flags);
1053 ssize_t fgetxattrat_fake(int dirfd, const char *filename, const char *attribute, void *value, size_t size, int flags);
1055 int fd_setcrtime(int fd, usec_t usec);
1056 int fd_getcrtime(int fd, usec_t *usec);
1057 int path_getcrtime(const char *p, usec_t *usec);
1058 int fd_getcrtime_at(int dirfd, const char *name, usec_t *usec, int flags);
1060 int chattr_fd(int fd, bool b, unsigned mask);
1061 int chattr_path(const char *p, bool b, unsigned mask);
1062 int change_attr_fd(int fd, unsigned value, unsigned mask);
1064 int read_attr_fd(int fd, unsigned *ret);
1065 int read_attr_path(const char *p, unsigned *ret);
1067 typedef struct LockFile {
1073 int make_lock_file(const char *p, int operation, LockFile *ret);
1074 int make_lock_file_for(const char *p, int operation, LockFile *ret);
1075 void release_lock_file(LockFile *f);
1077 #define _cleanup_release_lock_file_ _cleanup_(release_lock_file)
1079 #define LOCK_FILE_INIT { .fd = -1, .path = NULL }
1081 #define RLIMIT_MAKE_CONST(lim) ((struct rlimit) { lim, lim })
1083 ssize_t sparse_write(int fd, const void *p, size_t sz, size_t run_length);
1085 void sigkill_wait(pid_t *pid);
1086 #define _cleanup_sigkill_wait_ _cleanup_(sigkill_wait)
1088 int syslog_parse_priority(const char **p, int *priority, bool with_facility);
1090 void cmsg_close_all(struct msghdr *mh);
1092 int rename_noreplace(int olddirfd, const char *oldpath, int newdirfd, const char *newpath);