]>
git.ipfire.org Git - thirdparty/systemd.git/blob - src/shared/util.h
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) _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* 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 int safe_atou16(const char *s
, uint16_t *ret
);
249 int safe_atoi16(const char *s
, int16_t *ret
);
251 const char* split(const char **state
, size_t *l
, const char *separator
, bool quoted
);
253 #define FOREACH_WORD(word, length, s, state) \
254 _FOREACH_WORD(word, length, s, WHITESPACE, false, state)
256 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state) \
257 _FOREACH_WORD(word, length, s, separator, false, state)
259 #define FOREACH_WORD_QUOTED(word, length, s, state) \
260 _FOREACH_WORD(word, length, s, WHITESPACE, true, state)
262 #define _FOREACH_WORD(word, length, s, separator, quoted, state) \
263 for ((state) = (s), (word) = split(&(state), &(length), (separator), (quoted)); (word); (word) = split(&(state), &(length), (separator), (quoted)))
265 pid_t
get_parent_of_pid(pid_t pid
, pid_t
*ppid
);
267 char *strappend(const char *s
, const char *suffix
);
268 char *strnappend(const char *s
, const char *suffix
, size_t length
);
270 char *replace_env(const char *format
, char **env
);
271 char **replace_env_argv(char **argv
, char **env
);
273 int readlinkat_malloc(int fd
, const char *p
, char **ret
);
274 int readlink_malloc(const char *p
, char **r
);
275 int readlink_value(const char *p
, char **ret
);
276 int readlink_and_make_absolute(const char *p
, char **r
);
277 int readlink_and_canonicalize(const char *p
, char **r
);
279 int reset_all_signal_handlers(void);
280 int reset_signal_mask(void);
282 char *strstrip(char *s
);
283 char *delete_chars(char *s
, const char *bad
);
284 char *truncate_nl(char *s
);
286 char *file_in_same_dir(const char *path
, const char *filename
);
288 int rmdir_parents(const char *path
, const char *stop
);
290 int get_process_state(pid_t pid
);
291 int get_process_comm(pid_t pid
, char **name
);
292 int get_process_cmdline(pid_t pid
, size_t max_length
, bool comm_fallback
, char **line
);
293 int get_process_exe(pid_t pid
, char **name
);
294 int get_process_uid(pid_t pid
, uid_t
*uid
);
295 int get_process_gid(pid_t pid
, gid_t
*gid
);
296 int get_process_capeff(pid_t pid
, char **capeff
);
297 int get_process_cwd(pid_t pid
, char **cwd
);
298 int get_process_root(pid_t pid
, char **root
);
299 int get_process_environ(pid_t pid
, char **environ
);
301 char hexchar(int x
) _const_
;
302 int unhexchar(char c
) _const_
;
303 char octchar(int x
) _const_
;
304 int unoctchar(char c
) _const_
;
305 char decchar(int x
) _const_
;
306 int undecchar(char c
) _const_
;
308 char *cescape(const char *s
);
309 char *cunescape(const char *s
);
310 char *cunescape_length(const char *s
, size_t length
);
311 char *cunescape_length_with_prefix(const char *s
, size_t length
, const char *prefix
);
313 char *xescape(const char *s
, const char *bad
);
315 char *ascii_strlower(char *path
);
317 bool dirent_is_file(const struct dirent
*de
) _pure_
;
318 bool dirent_is_file_with_suffix(const struct dirent
*de
, const char *suffix
) _pure_
;
320 bool hidden_file(const char *filename
) _pure_
;
322 bool chars_intersect(const char *a
, const char *b
) _pure_
;
324 int make_stdio(int fd
);
325 int make_null_stdio(void);
326 int make_console_stdio(void);
328 int dev_urandom(void *p
, size_t n
);
329 void random_bytes(void *p
, size_t n
);
330 void initialize_srand(void);
332 static inline uint64_t random_u64(void) {
334 random_bytes(&u
, sizeof(u
));
338 static inline uint32_t random_u32(void) {
340 random_bytes(&u
, sizeof(u
));
344 /* For basic lookup tables with strictly enumerated entries */
345 #define __DEFINE_STRING_TABLE_LOOKUP(name,type,scope) \
346 scope const char *name##_to_string(type i) { \
347 if (i < 0 || i >= (type) ELEMENTSOF(name##_table)) \
349 return name##_table[i]; \
351 scope type name##_from_string(const char *s) { \
355 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
356 if (name##_table[i] && \
357 streq(name##_table[i], s)) \
361 struct __useless_struct_to_allow_trailing_semicolon__
363 #define DEFINE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,)
364 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,static)
366 /* For string conversions where numbers are also acceptable */
367 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max) \
368 int name##_to_string_alloc(type i, char **str) { \
371 if (i < 0 || i > max) \
373 if (i < (type) ELEMENTSOF(name##_table)) { \
374 s = strdup(name##_table[i]); \
378 r = asprintf(&s, "%u", i); \
385 type name##_from_string(const char *s) { \
389 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
390 if (name##_table[i] && \
391 streq(name##_table[i], s)) \
393 if (safe_atou(s, &u) >= 0 && u <= max) \
397 struct __useless_struct_to_allow_trailing_semicolon__
399 int fd_nonblock(int fd
, bool nonblock
);
400 int fd_cloexec(int fd
, bool cloexec
);
402 int close_all_fds(const int except
[], unsigned n_except
);
404 bool fstype_is_network(const char *fstype
);
408 int read_one_char(FILE *f
, char *ret
, usec_t timeout
, bool *need_nl
);
409 int ask_char(char *ret
, const char *replies
, const char *text
, ...) _printf_(3, 4);
410 int ask_string(char **ret
, const char *text
, ...) _printf_(2, 3);
412 int reset_terminal_fd(int fd
, bool switch_to_text
);
413 int reset_terminal(const char *name
);
415 int open_terminal(const char *name
, int mode
);
416 int acquire_terminal(const char *name
, bool fail
, bool force
, bool ignore_tiocstty_eperm
, usec_t timeout
);
417 int release_terminal(void);
419 int flush_fd(int fd
);
421 int ignore_signals(int sig
, ...);
422 int default_signals(int sig
, ...);
423 int sigaction_many(const struct sigaction
*sa
, ...);
425 int fopen_temporary(const char *path
, FILE **_f
, char **_temp_path
);
427 ssize_t
loop_read(int fd
, void *buf
, size_t nbytes
, bool do_poll
);
428 int loop_write(int fd
, const void *buf
, size_t nbytes
, bool do_poll
);
430 bool is_device_path(const char *path
);
432 int dir_is_empty(const char *path
);
433 char* dirname_malloc(const char *path
);
435 void rename_process(const char name
[8]);
437 void sigset_add_many(sigset_t
*ss
, ...);
438 int sigprocmask_many(int how
, ...);
440 bool hostname_is_set(void);
442 char* lookup_uid(uid_t uid
);
443 char* gethostname_malloc(void);
444 char* getlogname_malloc(void);
445 char* getusername_malloc(void);
447 int getttyname_malloc(int fd
, char **r
);
448 int getttyname_harder(int fd
, char **r
);
450 int get_ctty_devnr(pid_t pid
, dev_t
*d
);
451 int get_ctty(pid_t
, dev_t
*_devnr
, char **r
);
453 int chmod_and_chown(const char *path
, mode_t mode
, uid_t uid
, gid_t gid
);
454 int fchmod_and_fchown(int fd
, mode_t mode
, uid_t uid
, gid_t gid
);
456 int is_fd_on_temporary_fs(int fd
);
458 int rm_rf_children(int fd
, bool only_dirs
, bool honour_sticky
, struct stat
*root_dev
);
459 int rm_rf_children_dangerous(int fd
, bool only_dirs
, bool honour_sticky
, struct stat
*root_dev
);
460 int rm_rf(const char *path
, bool only_dirs
, bool delete_root
, bool honour_sticky
);
461 int rm_rf_dangerous(const char *path
, bool only_dirs
, bool delete_root
, bool honour_sticky
);
463 int pipe_eof(int fd
);
465 cpu_set_t
* cpu_set_malloc(unsigned *ncpus
);
467 int status_vprintf(const char *status
, bool ellipse
, bool ephemeral
, const char *format
, va_list ap
) _printf_(4,0);
468 int status_printf(const char *status
, bool ellipse
, bool ephemeral
, const char *format
, ...) _printf_(4,5);
470 int fd_columns(int fd
);
471 unsigned columns(void);
472 int fd_lines(int fd
);
473 unsigned lines(void);
474 void columns_lines_cache_reset(int _unused_ signum
);
478 static inline const char *ansi_highlight(void) {
479 return on_tty() ? ANSI_HIGHLIGHT_ON
: "";
482 static inline const char *ansi_highlight_red(void) {
483 return on_tty() ? ANSI_HIGHLIGHT_RED_ON
: "";
486 static inline const char *ansi_highlight_green(void) {
487 return on_tty() ? ANSI_HIGHLIGHT_GREEN_ON
: "";
490 static inline const char *ansi_highlight_yellow(void) {
491 return on_tty() ? ANSI_HIGHLIGHT_YELLOW_ON
: "";
494 static inline const char *ansi_highlight_blue(void) {
495 return on_tty() ? ANSI_HIGHLIGHT_BLUE_ON
: "";
498 static inline const char *ansi_highlight_off(void) {
499 return on_tty() ? ANSI_HIGHLIGHT_OFF
: "";
502 int files_same(const char *filea
, const char *fileb
);
504 int running_in_chroot(void);
506 char *ellipsize(const char *s
, size_t length
, unsigned percent
);
508 char *ellipsize_mem(const char *s
, size_t old_length
, size_t new_length
, unsigned percent
);
510 int touch_file(const char *path
, bool parents
, usec_t stamp
, uid_t uid
, gid_t gid
, mode_t mode
);
511 int touch(const char *path
);
513 char *unquote(const char *s
, const char *quotes
);
514 char *normalize_env_assignment(const char *s
);
516 int wait_for_terminate(pid_t pid
, siginfo_t
*status
);
517 int wait_for_terminate_and_warn(const char *name
, pid_t pid
, bool check_exit_code
);
519 noreturn
void freeze(void);
521 bool null_or_empty(struct stat
*st
) _pure_
;
522 int null_or_empty_path(const char *fn
);
523 int null_or_empty_fd(int fd
);
525 DIR *xopendirat(int dirfd
, const char *name
, int flags
);
527 char *fstab_node_to_udev_node(const char *p
);
529 char *resolve_dev_console(char **active
);
530 bool tty_is_vc(const char *tty
);
531 bool tty_is_vc_resolve(const char *tty
);
532 bool tty_is_console(const char *tty
) _pure_
;
533 int vtnr_from_tty(const char *tty
);
534 const char *default_term_for_tty(const char *tty
);
536 void execute_directory(const char *directory
, DIR *_d
, usec_t timeout
, char *argv
[]);
538 int kill_and_sigcont(pid_t pid
, int sig
);
540 bool nulstr_contains(const char*nulstr
, const char *needle
);
542 bool plymouth_running(void);
544 bool hostname_is_valid(const char *s
) _pure_
;
545 char* hostname_cleanup(char *s
, bool lowercase
);
547 bool machine_name_is_valid(const char *s
) _pure_
;
548 bool image_name_is_valid(const char *s
) _pure_
;
550 char* strshorten(char *s
, size_t l
);
552 int terminal_vhangup_fd(int fd
);
553 int terminal_vhangup(const char *name
);
555 int vt_disallocate(const char *name
);
557 int symlink_atomic(const char *from
, const char *to
);
558 int mknod_atomic(const char *path
, mode_t mode
, dev_t dev
);
559 int mkfifo_atomic(const char *path
, mode_t mode
);
561 int fchmod_umask(int fd
, mode_t mode
);
563 bool display_is_local(const char *display
) _pure_
;
564 int socket_from_display(const char *display
, char **path
);
566 int get_user_creds(const char **username
, uid_t
*uid
, gid_t
*gid
, const char **home
, const char **shell
);
567 int get_group_creds(const char **groupname
, gid_t
*gid
);
569 int in_gid(gid_t gid
);
570 int in_group(const char *name
);
572 char* uid_to_name(uid_t uid
);
573 char* gid_to_name(gid_t gid
);
575 int glob_exists(const char *path
);
576 int glob_extend(char ***strv
, const char *path
);
578 int dirent_ensure_type(DIR *d
, struct dirent
*de
);
580 int get_files_in_directory(const char *path
, char ***list
);
582 char *strjoin(const char *x
, ...) _sentinel_
;
584 bool is_main_thread(void);
586 static inline bool _pure_
in_charset(const char *s
, const char* charset
) {
589 return s
[strspn(s
, charset
)] == '\0';
592 int block_get_whole_disk(dev_t d
, dev_t
*ret
);
594 #define NULSTR_FOREACH(i, l) \
595 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
597 #define NULSTR_FOREACH_PAIR(i, j, l) \
598 for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
600 int ioprio_class_to_string_alloc(int i
, char **s
);
601 int ioprio_class_from_string(const char *s
);
603 const char *sigchld_code_to_string(int i
) _const_
;
604 int sigchld_code_from_string(const char *s
) _pure_
;
606 int log_facility_unshifted_to_string_alloc(int i
, char **s
);
607 int log_facility_unshifted_from_string(const char *s
);
609 int log_level_to_string_alloc(int i
, char **s
);
610 int log_level_from_string(const char *s
);
612 int sched_policy_to_string_alloc(int i
, char **s
);
613 int sched_policy_from_string(const char *s
);
615 const char *rlimit_to_string(int i
) _const_
;
616 int rlimit_from_string(const char *s
) _pure_
;
618 int ip_tos_to_string_alloc(int i
, char **s
);
619 int ip_tos_from_string(const char *s
);
621 const char *signal_to_string(int i
) _const_
;
622 int signal_from_string(const char *s
) _pure_
;
624 int signal_from_string_try_harder(const char *s
);
626 extern int saved_argc
;
627 extern char **saved_argv
;
629 bool kexec_loaded(void);
631 int prot_from_flags(int flags
) _const_
;
633 char *format_bytes(char *buf
, size_t l
, off_t t
);
635 int fd_wait_for_event(int fd
, int event
, usec_t timeout
);
637 void* memdup(const void *p
, size_t l
) _alloc_(2);
639 int is_kernel_thread(pid_t pid
);
641 int fd_inc_sndbuf(int fd
, size_t n
);
642 int fd_inc_rcvbuf(int fd
, size_t n
);
644 int fork_agent(pid_t
*pid
, const int except
[], unsigned n_except
, const char *path
, ...);
646 int setrlimit_closest(int resource
, const struct rlimit
*rlim
);
648 int getenv_for_pid(pid_t pid
, const char *field
, char **_value
);
650 bool is_valid_documentation_url(const char *url
) _pure_
;
652 bool in_initrd(void);
654 void warn_melody(void);
656 int get_home_dir(char **ret
);
657 int get_shell(char **_ret
);
659 static inline void freep(void *p
) {
663 #define DEFINE_TRIVIAL_CLEANUP_FUNC(type, func) \
664 static inline void func##p(type *p) { \
668 struct __useless_struct_to_allow_trailing_semicolon__
670 static inline void closep(int *fd
) {
674 static inline void umaskp(mode_t
*u
) {
678 static inline void close_pairp(int (*p
)[2]) {
682 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, fclose
);
683 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, pclose
);
684 DEFINE_TRIVIAL_CLEANUP_FUNC(DIR*, closedir
);
685 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, endmntent
);
687 #define _cleanup_free_ _cleanup_(freep)
688 #define _cleanup_close_ _cleanup_(closep)
689 #define _cleanup_umask_ _cleanup_(umaskp)
690 #define _cleanup_globfree_ _cleanup_(globfree)
691 #define _cleanup_fclose_ _cleanup_(fclosep)
692 #define _cleanup_pclose_ _cleanup_(pclosep)
693 #define _cleanup_closedir_ _cleanup_(closedirp)
694 #define _cleanup_endmntent_ _cleanup_(endmntentp)
695 #define _cleanup_close_pair_ _cleanup_(close_pairp)
697 _malloc_
_alloc_(1, 2) static inline void *malloc_multiply(size_t a
, size_t b
) {
698 if (_unlikely_(b
!= 0 && a
> ((size_t) -1) / b
))
701 return malloc(a
* b
);
704 _alloc_(2, 3) static inline void *realloc_multiply(void *p
, size_t a
, size_t b
) {
705 if (_unlikely_(b
!= 0 && a
> ((size_t) -1) / b
))
708 return realloc(p
, a
* b
);
711 _alloc_(2, 3) static inline void *memdup_multiply(const void *p
, size_t a
, size_t b
) {
712 if (_unlikely_(b
!= 0 && a
> ((size_t) -1) / b
))
715 return memdup(p
, a
* b
);
718 bool filename_is_valid(const char *p
) _pure_
;
719 bool path_is_safe(const char *p
) _pure_
;
720 bool string_is_safe(const char *p
) _pure_
;
721 bool string_has_cc(const char *p
, const char *ok
) _pure_
;
724 * Check if a string contains any glob patterns.
726 _pure_
static inline bool string_is_glob(const char *p
) {
727 return !!strpbrk(p
, GLOB_CHARS
);
730 void *xbsearch_r(const void *key
, const void *base
, size_t nmemb
, size_t size
,
731 int (*compar
) (const void *, const void *, void *),
734 bool is_locale_utf8(void);
736 typedef enum DrawSpecialChar
{
741 DRAW_TRIANGULAR_BULLET
,
745 _DRAW_SPECIAL_CHAR_MAX
748 const char *draw_special_char(DrawSpecialChar ch
);
750 char *strreplace(const char *text
, const char *old_string
, const char *new_string
);
752 char *strip_tab_ansi(char **p
, size_t *l
);
754 int on_ac_power(void);
756 int search_and_fopen(const char *path
, const char *mode
, const char *root
, const char **search
, FILE **_f
);
757 int search_and_fopen_nulstr(const char *path
, const char *mode
, const char *root
, const char *search
, FILE **_f
);
759 #define FOREACH_LINE(line, f, on_error) \
761 if (!fgets(line, sizeof(line), f)) { \
768 #define FOREACH_DIRENT(de, d, on_error) \
769 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
775 } else if (hidden_file((de)->d_name)) \
779 #define FOREACH_DIRENT_ALL(de, d, on_error) \
780 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
788 static inline void *mempset(void *s
, int c
, size_t n
) {
790 return (uint8_t*)s
+ n
;
793 char *hexmem(const void *p
, size_t l
);
794 void *unhexmem(const char *p
, size_t l
);
796 char *strextend(char **x
, ...) _sentinel_
;
797 char *strrep(const char *s
, unsigned n
);
799 void* greedy_realloc(void **p
, size_t *allocated
, size_t need
, size_t size
);
800 void* greedy_realloc0(void **p
, size_t *allocated
, size_t need
, size_t size
);
801 #define GREEDY_REALLOC(array, allocated, need) \
802 greedy_realloc((void**) &(array), &(allocated), (need), sizeof((array)[0]))
804 #define GREEDY_REALLOC0(array, allocated, need) \
805 greedy_realloc0((void**) &(array), &(allocated), (need), sizeof((array)[0]))
807 static inline void _reset_errno_(int *saved_errno
) {
808 errno
= *saved_errno
;
811 #define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
813 static inline int negative_errno(void) {
814 /* This helper should be used to shut up gcc if you know 'errno' is
815 * negative. Instead of "return -errno;", use "return negative_errno();"
816 * It will suppress bogus gcc warnings in case it assumes 'errno' might
817 * be 0 and thus the caller's error-handling might not be triggered. */
818 assert_return(errno
> 0, -EINVAL
);
822 struct _umask_struct_
{
827 static inline void _reset_umask_(struct _umask_struct_
*s
) {
831 #define RUN_WITH_UMASK(mask) \
832 for (_cleanup_(_reset_umask_) struct _umask_struct_ _saved_umask_ = { umask(mask), false }; \
833 !_saved_umask_.quit ; \
834 _saved_umask_.quit = true)
836 static inline unsigned u64log2(uint64_t n
) {
837 #if __SIZEOF_LONG_LONG__ == 8
838 return (n
> 1) ? (unsigned) __builtin_clzll(n
) ^ 63U : 0;
844 static inline unsigned u32ctz(uint32_t n
) {
845 #if __SIZEOF_INT__ == 4
846 return __builtin_ctz(n
);
852 static inline int log2i(int x
) {
855 return __SIZEOF_INT__
* 8 - __builtin_clz(x
) - 1;
858 static inline unsigned log2u(unsigned x
) {
861 return sizeof(unsigned) * 8 - __builtin_clz(x
) - 1;
864 static inline unsigned log2u_round_up(unsigned x
) {
870 return log2u(x
- 1) + 1;
873 static inline bool logind_running(void) {
874 return access("/run/systemd/seats/", F_OK
) >= 0;
877 #define DECIMAL_STR_WIDTH(x) \
879 typeof(x) _x_ = (x); \
886 int unlink_noerrno(const char *path
);
892 _new_ = alloca(_len_); \
893 (void *) memset(_new_, 0, _len_); \
896 /* It's not clear what alignment glibc/gcc alloca() guarantee, hence provide a guaranteed safe version */
897 #define alloca_align(size, align) \
900 size_t _mask_ = (align) - 1; \
901 _ptr_ = alloca((size) + _mask_); \
902 (void*)(((uintptr_t)_ptr_ + _mask_) & ~_mask_); \
905 #define alloca0_align(size, align) \
908 size_t _size_ = (size); \
909 _new_ = alloca_align(_size_, (align)); \
910 (void*)memset(_new_, 0, _size_); \
913 #define strappenda(a, ...) \
915 int _len = strlen(a); \
918 const char *_appendees_[] = { __VA_ARGS__ }; \
919 for (_i = 0; _i < ELEMENTSOF(_appendees_); _i++) \
920 _len += strlen(_appendees_[_i]); \
921 _d_ = alloca(_len + 1); \
922 _p_ = stpcpy(_d_, a); \
923 for (_i = 0; _i < ELEMENTSOF(_appendees_); _i++) \
924 _p_ = stpcpy(_p_, _appendees_[_i]); \
928 #define procfs_file_alloca(pid, field) \
930 pid_t _pid_ = (pid); \
933 _r_ = ("/proc/self/" field); \
935 _r_ = alloca(strlen("/proc/") + DECIMAL_STR_MAX(pid_t) + 1 + sizeof(field)); \
936 sprintf((char*) _r_, "/proc/"PID_FMT"/" field, _pid_); \
941 struct _locale_struct_
{
942 locale_t saved_locale
;
947 static inline void _reset_locale_(struct _locale_struct_
*s
) {
949 if (s
->saved_locale
!= (locale_t
) 0)
950 uselocale(s
->saved_locale
);
951 if (s
->new_locale
!= (locale_t
) 0)
952 freelocale(s
->new_locale
);
955 #define RUN_WITH_LOCALE(mask, loc) \
956 for (_cleanup_(_reset_locale_) struct _locale_struct_ _saved_locale_ = { (locale_t) 0, (locale_t) 0, false }; \
958 if (!_saved_locale_.quit) { \
960 _saved_locale_.new_locale = newlocale((mask), (loc), (locale_t) 0); \
961 if (_saved_locale_.new_locale != (locale_t) 0) \
962 _saved_locale_.saved_locale = uselocale(_saved_locale_.new_locale); \
964 !_saved_locale_.quit; }) ; \
965 _saved_locale_.quit = true)
967 bool id128_is_valid(const char *s
) _pure_
;
969 int split_pair(const char *s
, const char *sep
, char **l
, char **r
);
971 int shall_restore_state(void);
974 * Normal qsort requires base to be nonnull. Here were require
975 * that only if nmemb > 0.
977 static inline void qsort_safe(void *base
, size_t nmemb
, size_t size
,
978 int (*compar
)(const void *, const void *)) {
981 qsort(base
, nmemb
, size
, compar
);
985 int proc_cmdline(char **ret
);
986 int parse_proc_cmdline(int (*parse_word
)(const char *key
, const char *value
));
987 int get_proc_cmdline_key(const char *parameter
, char **value
);
989 int container_get_leader(const char *machine
, pid_t
*pid
);
991 int namespace_open(pid_t pid
, int *pidns_fd
, int *mntns_fd
, int *netns_fd
, int *root_fd
);
992 int namespace_enter(int pidns_fd
, int mntns_fd
, int netns_fd
, int root_fd
);
994 bool pid_is_alive(pid_t pid
);
995 bool pid_is_unwaited(pid_t pid
);
997 int getpeercred(int fd
, struct ucred
*ucred
);
998 int getpeersec(int fd
, char **ret
);
1000 int writev_safe(int fd
, const struct iovec
*w
, int j
);
1002 int mkostemp_safe(char *pattern
, int flags
);
1003 int open_tmpfile(const char *path
, int flags
);
1005 int fd_warn_permissions(const char *path
, int fd
);
1007 unsigned long personality_from_string(const char *p
);
1008 const char *personality_to_string(unsigned long);
1010 uint64_t physical_memory(void);
1012 char* mount_test_option(const char *haystack
, const char *needle
);
1014 void hexdump(FILE *f
, const void *p
, size_t s
);
1016 union file_handle_union
{
1017 struct file_handle handle
;
1018 char padding
[sizeof(struct file_handle
) + MAX_HANDLE_SZ
];
1021 int update_reboot_param_file(const char *param
);
1023 int umount_recursive(const char *target
, int flags
);
1025 int bind_remount_recursive(const char *prefix
, bool ro
);
1027 int fflush_and_check(FILE *f
);
1029 int tempfn_xxxxxx(const char *p
, char **ret
);
1030 int tempfn_random(const char *p
, char **ret
);
1031 int tempfn_random_child(const char *p
, char **ret
);
1033 bool is_localhost(const char *hostname
);
1035 int take_password_lock(const char *root
);
1037 int is_symlink(const char *path
);
1038 int is_dir(const char *path
, bool follow
);
1040 int unquote_first_word(const char **p
, char **ret
, bool relax
);
1041 int unquote_many_words(const char **p
, ...) _sentinel_
;
1043 int free_and_strdup(char **p
, const char *s
);
1045 int sethostname_idempotent(const char *s
);
1047 #define INOTIFY_EVENT_MAX (sizeof(struct inotify_event) + NAME_MAX + 1)
1049 #define FOREACH_INOTIFY_EVENT(e, buffer, sz) \
1050 for ((e) = (struct inotify_event*) (buffer); \
1051 (uint8_t*) (e) < (uint8_t*) (buffer) + (sz); \
1052 (e) = (struct inotify_event*) ((uint8_t*) (e) + sizeof(struct inotify_event) + (e)->len))
1054 #define laccess(path, mode) faccessat(AT_FDCWD, (path), (mode), AT_SYMLINK_NOFOLLOW)