]>
git.proxmox.com Git - 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>
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 ssize_t
string_table_lookup(const char * const *table
, size_t len
, const char *key
);
360 #define _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope) \
361 scope inline type name##_from_string(const char *s) { \
362 return (type)string_table_lookup(name##_table, ELEMENTSOF(name##_table), s); \
365 #define _DEFINE_STRING_TABLE_LOOKUP(name,type,scope) \
366 _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope) \
367 _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope) \
368 struct __useless_struct_to_allow_trailing_semicolon__
370 #define DEFINE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,)
371 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,static)
372 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_TO_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,static)
373 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_FROM_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,static)
375 /* For string conversions where numbers are also acceptable */
376 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max) \
377 int name##_to_string_alloc(type i, char **str) { \
380 if (i < 0 || i > max) \
382 if (i < (type) ELEMENTSOF(name##_table)) { \
383 s = strdup(name##_table[i]); \
387 r = asprintf(&s, "%i", i); \
394 type name##_from_string(const char *s) { \
398 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
399 if (name##_table[i] && \
400 streq(name##_table[i], s)) \
402 if (safe_atou(s, &u) >= 0 && u <= max) \
406 struct __useless_struct_to_allow_trailing_semicolon__
408 int fd_nonblock(int fd
, bool nonblock
);
409 int fd_cloexec(int fd
, bool cloexec
);
411 int close_all_fds(const int except
[], unsigned n_except
);
413 bool fstype_is_network(const char *fstype
);
417 int read_one_char(FILE *f
, char *ret
, usec_t timeout
, bool *need_nl
);
418 int ask_char(char *ret
, const char *replies
, const char *text
, ...) _printf_(3, 4);
419 int ask_string(char **ret
, const char *text
, ...) _printf_(2, 3);
421 int reset_terminal_fd(int fd
, bool switch_to_text
);
422 int reset_terminal(const char *name
);
424 int open_terminal(const char *name
, int mode
);
425 int acquire_terminal(const char *name
, bool fail
, bool force
, bool ignore_tiocstty_eperm
, usec_t timeout
);
426 int release_terminal(void);
428 int flush_fd(int fd
);
430 int ignore_signals(int sig
, ...);
431 int default_signals(int sig
, ...);
432 int sigaction_many(const struct sigaction
*sa
, ...);
434 int fopen_temporary(const char *path
, FILE **_f
, char **_temp_path
);
436 ssize_t
loop_read(int fd
, void *buf
, size_t nbytes
, bool do_poll
);
437 int loop_write(int fd
, const void *buf
, size_t nbytes
, bool do_poll
);
439 bool is_device_path(const char *path
);
441 int dir_is_empty(const char *path
);
442 char* dirname_malloc(const char *path
);
444 void rename_process(const char name
[8]);
446 void sigset_add_many(sigset_t
*ss
, ...);
447 int sigprocmask_many(int how
, ...);
449 bool hostname_is_set(void);
451 char* lookup_uid(uid_t uid
);
452 char* gethostname_malloc(void);
453 char* getlogname_malloc(void);
454 char* getusername_malloc(void);
456 int getttyname_malloc(int fd
, char **r
);
457 int getttyname_harder(int fd
, char **r
);
459 int get_ctty_devnr(pid_t pid
, dev_t
*d
);
460 int get_ctty(pid_t
, dev_t
*_devnr
, char **r
);
462 int chmod_and_chown(const char *path
, mode_t mode
, uid_t uid
, gid_t gid
);
463 int fchmod_and_fchown(int fd
, mode_t mode
, uid_t uid
, gid_t gid
);
465 int is_fd_on_temporary_fs(int fd
);
467 int rm_rf_children(int fd
, bool only_dirs
, bool honour_sticky
, struct stat
*root_dev
);
468 int rm_rf_children_dangerous(int fd
, bool only_dirs
, bool honour_sticky
, struct stat
*root_dev
);
469 int rm_rf(const char *path
, bool only_dirs
, bool delete_root
, bool honour_sticky
);
470 int rm_rf_dangerous(const char *path
, bool only_dirs
, bool delete_root
, bool honour_sticky
);
472 int pipe_eof(int fd
);
474 cpu_set_t
* cpu_set_malloc(unsigned *ncpus
);
476 int status_vprintf(const char *status
, bool ellipse
, bool ephemeral
, const char *format
, va_list ap
) _printf_(4,0);
477 int status_printf(const char *status
, bool ellipse
, bool ephemeral
, const char *format
, ...) _printf_(4,5);
479 #define xsprintf(buf, fmt, ...) assert_se((size_t) snprintf(buf, ELEMENTSOF(buf), fmt, __VA_ARGS__) < ELEMENTSOF(buf))
481 int fd_columns(int fd
);
482 unsigned columns(void);
483 int fd_lines(int fd
);
484 unsigned lines(void);
485 void columns_lines_cache_reset(int _unused_ signum
);
489 static inline const char *ansi_highlight(void) {
490 return on_tty() ? ANSI_HIGHLIGHT_ON
: "";
493 static inline const char *ansi_highlight_red(void) {
494 return on_tty() ? ANSI_HIGHLIGHT_RED_ON
: "";
497 static inline const char *ansi_highlight_green(void) {
498 return on_tty() ? ANSI_HIGHLIGHT_GREEN_ON
: "";
501 static inline const char *ansi_highlight_yellow(void) {
502 return on_tty() ? ANSI_HIGHLIGHT_YELLOW_ON
: "";
505 static inline const char *ansi_highlight_blue(void) {
506 return on_tty() ? ANSI_HIGHLIGHT_BLUE_ON
: "";
509 static inline const char *ansi_highlight_off(void) {
510 return on_tty() ? ANSI_HIGHLIGHT_OFF
: "";
513 int files_same(const char *filea
, const char *fileb
);
515 int running_in_chroot(void);
517 char *ellipsize(const char *s
, size_t length
, unsigned percent
);
519 char *ellipsize_mem(const char *s
, size_t old_length
, size_t new_length
, unsigned percent
);
521 int touch_file(const char *path
, bool parents
, usec_t stamp
, uid_t uid
, gid_t gid
, mode_t mode
);
522 int touch(const char *path
);
524 char *unquote(const char *s
, const char *quotes
);
525 char *normalize_env_assignment(const char *s
);
527 int wait_for_terminate(pid_t pid
, siginfo_t
*status
);
528 int wait_for_terminate_and_warn(const char *name
, pid_t pid
, bool check_exit_code
);
530 noreturn
void freeze(void);
532 bool null_or_empty(struct stat
*st
) _pure_
;
533 int null_or_empty_path(const char *fn
);
534 int null_or_empty_fd(int fd
);
536 DIR *xopendirat(int dirfd
, const char *name
, int flags
);
538 char *fstab_node_to_udev_node(const char *p
);
540 char *resolve_dev_console(char **active
);
541 bool tty_is_vc(const char *tty
);
542 bool tty_is_vc_resolve(const char *tty
);
543 bool tty_is_console(const char *tty
) _pure_
;
544 int vtnr_from_tty(const char *tty
);
545 const char *default_term_for_tty(const char *tty
);
547 void execute_directories(const char* const* directories
, usec_t timeout
, char *argv
[]);
549 int kill_and_sigcont(pid_t pid
, int sig
);
551 bool nulstr_contains(const char*nulstr
, const char *needle
);
553 bool plymouth_running(void);
555 bool hostname_is_valid(const char *s
) _pure_
;
556 char* hostname_cleanup(char *s
, bool lowercase
);
558 bool machine_name_is_valid(const char *s
) _pure_
;
560 char* strshorten(char *s
, size_t l
);
562 int terminal_vhangup_fd(int fd
);
563 int terminal_vhangup(const char *name
);
565 int vt_disallocate(const char *name
);
567 int symlink_atomic(const char *from
, const char *to
);
568 int mknod_atomic(const char *path
, mode_t mode
, dev_t dev
);
569 int mkfifo_atomic(const char *path
, mode_t mode
);
571 int fchmod_umask(int fd
, mode_t mode
);
573 bool display_is_local(const char *display
) _pure_
;
574 int socket_from_display(const char *display
, char **path
);
576 int get_user_creds(const char **username
, uid_t
*uid
, gid_t
*gid
, const char **home
, const char **shell
);
577 int get_group_creds(const char **groupname
, gid_t
*gid
);
579 int in_gid(gid_t gid
);
580 int in_group(const char *name
);
582 char* uid_to_name(uid_t uid
);
583 char* gid_to_name(gid_t gid
);
585 int glob_exists(const char *path
);
586 int glob_extend(char ***strv
, const char *path
);
588 int dirent_ensure_type(DIR *d
, struct dirent
*de
);
590 int get_files_in_directory(const char *path
, char ***list
);
592 char *strjoin(const char *x
, ...) _sentinel_
;
594 bool is_main_thread(void);
596 static inline bool _pure_
in_charset(const char *s
, const char* charset
) {
599 return s
[strspn(s
, charset
)] == '\0';
602 int block_get_whole_disk(dev_t d
, dev_t
*ret
);
604 #define NULSTR_FOREACH(i, l) \
605 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
607 #define NULSTR_FOREACH_PAIR(i, j, l) \
608 for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
610 int ioprio_class_to_string_alloc(int i
, char **s
);
611 int ioprio_class_from_string(const char *s
);
613 const char *sigchld_code_to_string(int i
) _const_
;
614 int sigchld_code_from_string(const char *s
) _pure_
;
616 int log_facility_unshifted_to_string_alloc(int i
, char **s
);
617 int log_facility_unshifted_from_string(const char *s
);
619 int log_level_to_string_alloc(int i
, char **s
);
620 int log_level_from_string(const char *s
);
622 int sched_policy_to_string_alloc(int i
, char **s
);
623 int sched_policy_from_string(const char *s
);
625 const char *rlimit_to_string(int i
) _const_
;
626 int rlimit_from_string(const char *s
) _pure_
;
628 int ip_tos_to_string_alloc(int i
, char **s
);
629 int ip_tos_from_string(const char *s
);
631 const char *signal_to_string(int i
) _const_
;
632 int signal_from_string(const char *s
) _pure_
;
634 int signal_from_string_try_harder(const char *s
);
636 extern int saved_argc
;
637 extern char **saved_argv
;
639 bool kexec_loaded(void);
641 int prot_from_flags(int flags
) _const_
;
643 char *format_bytes(char *buf
, size_t l
, off_t t
);
645 int fd_wait_for_event(int fd
, int event
, usec_t timeout
);
647 void* memdup(const void *p
, size_t l
) _alloc_(2);
649 int is_kernel_thread(pid_t pid
);
651 int fd_inc_sndbuf(int fd
, size_t n
);
652 int fd_inc_rcvbuf(int fd
, size_t n
);
654 int fork_agent(pid_t
*pid
, const int except
[], unsigned n_except
, const char *path
, ...);
656 int setrlimit_closest(int resource
, const struct rlimit
*rlim
);
658 int getenv_for_pid(pid_t pid
, const char *field
, char **_value
);
660 bool http_url_is_valid(const char *url
) _pure_
;
661 bool documentation_url_is_valid(const char *url
) _pure_
;
663 bool http_etag_is_valid(const char *etag
);
665 bool in_initrd(void);
667 void warn_melody(void);
669 int get_home_dir(char **ret
);
670 int get_shell(char **_ret
);
672 static inline void freep(void *p
) {
676 static inline void closep(int *fd
) {
680 static inline void umaskp(mode_t
*u
) {
684 static inline void close_pairp(int (*p
)[2]) {
688 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, fclose
);
689 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, pclose
);
690 DEFINE_TRIVIAL_CLEANUP_FUNC(DIR*, closedir
);
691 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, endmntent
);
693 #define _cleanup_free_ _cleanup_(freep)
694 #define _cleanup_close_ _cleanup_(closep)
695 #define _cleanup_umask_ _cleanup_(umaskp)
696 #define _cleanup_globfree_ _cleanup_(globfree)
697 #define _cleanup_fclose_ _cleanup_(fclosep)
698 #define _cleanup_pclose_ _cleanup_(pclosep)
699 #define _cleanup_closedir_ _cleanup_(closedirp)
700 #define _cleanup_endmntent_ _cleanup_(endmntentp)
701 #define _cleanup_close_pair_ _cleanup_(close_pairp)
703 _malloc_
_alloc_(1, 2) static inline void *malloc_multiply(size_t a
, size_t b
) {
704 if (_unlikely_(b
!= 0 && a
> ((size_t) -1) / b
))
707 return malloc(a
* b
);
710 _alloc_(2, 3) static inline void *realloc_multiply(void *p
, size_t a
, size_t b
) {
711 if (_unlikely_(b
!= 0 && a
> ((size_t) -1) / b
))
714 return realloc(p
, a
* b
);
717 _alloc_(2, 3) static inline void *memdup_multiply(const void *p
, size_t a
, size_t b
) {
718 if (_unlikely_(b
!= 0 && a
> ((size_t) -1) / b
))
721 return memdup(p
, a
* b
);
724 bool filename_is_valid(const char *p
) _pure_
;
725 bool path_is_safe(const char *p
) _pure_
;
726 bool string_is_safe(const char *p
) _pure_
;
727 bool string_has_cc(const char *p
, const char *ok
) _pure_
;
730 * Check if a string contains any glob patterns.
732 _pure_
static inline bool string_is_glob(const char *p
) {
733 return !!strpbrk(p
, GLOB_CHARS
);
736 void *xbsearch_r(const void *key
, const void *base
, size_t nmemb
, size_t size
,
737 int (*compar
) (const void *, const void *, void *),
740 bool is_locale_utf8(void);
742 typedef enum DrawSpecialChar
{
747 DRAW_TRIANGULAR_BULLET
,
751 _DRAW_SPECIAL_CHAR_MAX
754 const char *draw_special_char(DrawSpecialChar ch
);
756 char *strreplace(const char *text
, const char *old_string
, const char *new_string
);
758 char *strip_tab_ansi(char **p
, size_t *l
);
760 int on_ac_power(void);
762 int search_and_fopen(const char *path
, const char *mode
, const char *root
, const char **search
, FILE **_f
);
763 int search_and_fopen_nulstr(const char *path
, const char *mode
, const char *root
, const char *search
, FILE **_f
);
765 #define FOREACH_LINE(line, f, on_error) \
767 if (!fgets(line, sizeof(line), f)) { \
774 #define FOREACH_DIRENT(de, d, on_error) \
775 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
781 } else if (hidden_file((de)->d_name)) \
785 #define FOREACH_DIRENT_ALL(de, d, on_error) \
786 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
794 static inline void *mempset(void *s
, int c
, size_t n
) {
796 return (uint8_t*)s
+ n
;
799 char *hexmem(const void *p
, size_t l
);
800 void *unhexmem(const char *p
, size_t l
);
802 char *strextend(char **x
, ...) _sentinel_
;
803 char *strrep(const char *s
, unsigned n
);
805 void* greedy_realloc(void **p
, size_t *allocated
, size_t need
, size_t size
);
806 void* greedy_realloc0(void **p
, size_t *allocated
, size_t need
, size_t size
);
807 #define GREEDY_REALLOC(array, allocated, need) \
808 greedy_realloc((void**) &(array), &(allocated), (need), sizeof((array)[0]))
810 #define GREEDY_REALLOC0(array, allocated, need) \
811 greedy_realloc0((void**) &(array), &(allocated), (need), sizeof((array)[0]))
813 static inline void _reset_errno_(int *saved_errno
) {
814 errno
= *saved_errno
;
817 #define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
819 static inline int negative_errno(void) {
820 /* This helper should be used to shut up gcc if you know 'errno' is
821 * negative. Instead of "return -errno;", use "return negative_errno();"
822 * It will suppress bogus gcc warnings in case it assumes 'errno' might
823 * be 0 and thus the caller's error-handling might not be triggered. */
824 assert_return(errno
> 0, -EINVAL
);
828 struct _umask_struct_
{
833 static inline void _reset_umask_(struct _umask_struct_
*s
) {
837 #define RUN_WITH_UMASK(mask) \
838 for (_cleanup_(_reset_umask_) struct _umask_struct_ _saved_umask_ = { umask(mask), false }; \
839 !_saved_umask_.quit ; \
840 _saved_umask_.quit = true)
842 static inline unsigned u64log2(uint64_t n
) {
843 #if __SIZEOF_LONG_LONG__ == 8
844 return (n
> 1) ? (unsigned) __builtin_clzll(n
) ^ 63U : 0;
850 static inline unsigned u32ctz(uint32_t n
) {
851 #if __SIZEOF_INT__ == 4
852 return __builtin_ctz(n
);
858 static inline unsigned log2i(int x
) {
861 return __SIZEOF_INT__
* 8 - __builtin_clz(x
) - 1;
864 static inline unsigned log2u(unsigned x
) {
867 return sizeof(unsigned) * 8 - __builtin_clz(x
) - 1;
870 static inline unsigned log2u_round_up(unsigned x
) {
876 return log2u(x
- 1) + 1;
879 static inline bool logind_running(void) {
880 return access("/run/systemd/seats/", F_OK
) >= 0;
883 #define DECIMAL_STR_WIDTH(x) \
885 typeof(x) _x_ = (x); \
892 int unlink_noerrno(const char *path
);
898 _new_ = alloca(_len_); \
899 (void *) memset(_new_, 0, _len_); \
902 /* It's not clear what alignment glibc/gcc alloca() guarantee, hence provide a guaranteed safe version */
903 #define alloca_align(size, align) \
906 size_t _mask_ = (align) - 1; \
907 _ptr_ = alloca((size) + _mask_); \
908 (void*)(((uintptr_t)_ptr_ + _mask_) & ~_mask_); \
911 #define alloca0_align(size, align) \
914 size_t _size_ = (size); \
915 _new_ = alloca_align(_size_, (align)); \
916 (void*)memset(_new_, 0, _size_); \
919 #define strjoina(a, ...) \
921 const char *_appendees_[] = { a, __VA_ARGS__ }; \
925 for (_i_ = 0; _i_ < ELEMENTSOF(_appendees_) && _appendees_[_i_]; _i_++) \
926 _len_ += strlen(_appendees_[_i_]); \
927 _p_ = _d_ = alloca(_len_ + 1); \
928 for (_i_ = 0; _i_ < ELEMENTSOF(_appendees_) && _appendees_[_i_]; _i_++) \
929 _p_ = stpcpy(_p_, _appendees_[_i_]); \
934 #define procfs_file_alloca(pid, field) \
936 pid_t _pid_ = (pid); \
939 _r_ = ("/proc/self/" field); \
941 _r_ = alloca(strlen("/proc/") + DECIMAL_STR_MAX(pid_t) + 1 + sizeof(field)); \
942 sprintf((char*) _r_, "/proc/"PID_FMT"/" field, _pid_); \
947 bool id128_is_valid(const char *s
) _pure_
;
949 int split_pair(const char *s
, const char *sep
, char **l
, char **r
);
951 int shall_restore_state(void);
954 * Normal qsort requires base to be nonnull. Here were require
955 * that only if nmemb > 0.
957 static inline void qsort_safe(void *base
, size_t nmemb
, size_t size
,
958 int (*compar
)(const void *, const void *)) {
961 qsort(base
, nmemb
, size
, compar
);
965 int proc_cmdline(char **ret
);
966 int parse_proc_cmdline(int (*parse_word
)(const char *key
, const char *value
));
967 int get_proc_cmdline_key(const char *parameter
, char **value
);
969 int container_get_leader(const char *machine
, pid_t
*pid
);
971 int namespace_open(pid_t pid
, int *pidns_fd
, int *mntns_fd
, int *netns_fd
, int *root_fd
);
972 int namespace_enter(int pidns_fd
, int mntns_fd
, int netns_fd
, int root_fd
);
974 bool pid_is_alive(pid_t pid
);
975 bool pid_is_unwaited(pid_t pid
);
977 int getpeercred(int fd
, struct ucred
*ucred
);
978 int getpeersec(int fd
, char **ret
);
980 int writev_safe(int fd
, const struct iovec
*w
, int j
);
982 int mkostemp_safe(char *pattern
, int flags
);
983 int open_tmpfile(const char *path
, int flags
);
985 int fd_warn_permissions(const char *path
, int fd
);
987 unsigned long personality_from_string(const char *p
);
988 const char *personality_to_string(unsigned long);
990 uint64_t physical_memory(void);
992 void hexdump(FILE *f
, const void *p
, size_t s
);
994 union file_handle_union
{
995 struct file_handle handle
;
996 char padding
[sizeof(struct file_handle
) + MAX_HANDLE_SZ
];
998 #define FILE_HANDLE_INIT { .handle.handle_bytes = MAX_HANDLE_SZ }
1000 int update_reboot_param_file(const char *param
);
1002 int umount_recursive(const char *target
, int flags
);
1004 int bind_remount_recursive(const char *prefix
, bool ro
);
1006 int fflush_and_check(FILE *f
);
1008 int tempfn_xxxxxx(const char *p
, char **ret
);
1009 int tempfn_random(const char *p
, char **ret
);
1010 int tempfn_random_child(const char *p
, char **ret
);
1012 bool is_localhost(const char *hostname
);
1014 int take_password_lock(const char *root
);
1016 int is_symlink(const char *path
);
1017 int is_dir(const char *path
, bool follow
);
1019 int unquote_first_word(const char **p
, char **ret
, bool relax
);
1020 int unquote_many_words(const char **p
, ...) _sentinel_
;
1022 int free_and_strdup(char **p
, const char *s
);
1024 int sethostname_idempotent(const char *s
);
1026 #define INOTIFY_EVENT_MAX (sizeof(struct inotify_event) + NAME_MAX + 1)
1028 #define FOREACH_INOTIFY_EVENT(e, buffer, sz) \
1029 for ((e) = &buffer.ev; \
1030 (uint8_t*) (e) < (uint8_t*) (buffer.raw) + (sz); \
1031 (e) = (struct inotify_event*) ((uint8_t*) (e) + sizeof(struct inotify_event) + (e)->len))
1033 union inotify_event_buffer
{
1034 struct inotify_event ev
;
1035 uint8_t raw
[INOTIFY_EVENT_MAX
];
1038 #define laccess(path, mode) faccessat(AT_FDCWD, (path), (mode), AT_SYMLINK_NOFOLLOW)
1040 int ptsname_malloc(int fd
, char **ret
);
1042 int openpt_in_namespace(pid_t pid
, int flags
);
1044 ssize_t
fgetxattrat_fake(int dirfd
, const char *filename
, const char *attribute
, void *value
, size_t size
, int flags
);
1046 int fd_setcrtime(int fd
, usec_t usec
);
1047 int fd_getcrtime(int fd
, usec_t
*usec
);
1048 int path_getcrtime(const char *p
, usec_t
*usec
);
1049 int fd_getcrtime_at(int dirfd
, const char *name
, usec_t
*usec
, int flags
);
1051 int same_fd(int a
, int b
);
1053 int chattr_fd(int fd
, bool b
, unsigned mask
);
1054 int chattr_path(const char *p
, bool b
, unsigned mask
);
1056 int read_attr_fd(int fd
, unsigned *ret
);
1057 int read_attr_path(const char *p
, unsigned *ret
);
1059 typedef struct LockFile
{
1065 int make_lock_file(const char *p
, int operation
, LockFile
*ret
);
1066 int make_lock_file_for(const char *p
, int operation
, LockFile
*ret
);
1067 void release_lock_file(LockFile
*f
);
1069 #define _cleanup_release_lock_file_ _cleanup_(release_lock_file)
1071 #define LOCK_FILE_INIT { .fd = -1, .path = NULL }
1073 #define RLIMIT_MAKE_CONST(lim) ((struct rlimit) { lim, lim })
1075 ssize_t
sparse_write(int fd
, const void *p
, size_t sz
, size_t run_length
);
1077 void sigkill_wait(pid_t
*pid
);
1078 #define _cleanup_sigkill_wait_ _cleanup_(sigkill_wait)
1080 int syslog_parse_priority(const char **p
, int *priority
, bool with_facility
);