]>
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/>.
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_
;
188 char *first_word(const char *s
, const char *word
) _pure_
;
190 int close_nointr(int fd
);
191 int safe_close(int fd
);
192 void safe_close_pair(int p
[]);
194 void close_many(const int fds
[], unsigned n_fd
);
196 int parse_size(const char *t
, off_t base
, off_t
*size
);
198 int parse_boolean(const char *v
) _pure_
;
199 int parse_pid(const char *s
, pid_t
* ret_pid
);
200 int parse_uid(const char *s
, uid_t
* ret_uid
);
201 #define parse_gid(s, ret_uid) parse_uid(s, ret_uid)
203 int safe_atou(const char *s
, unsigned *ret_u
);
204 int safe_atoi(const char *s
, int *ret_i
);
206 int safe_atollu(const char *s
, unsigned long long *ret_u
);
207 int safe_atolli(const char *s
, long long int *ret_i
);
209 int safe_atod(const char *s
, double *ret_d
);
211 int safe_atou8(const char *s
, uint8_t *ret
);
213 #if LONG_MAX == INT_MAX
214 static inline int safe_atolu(const char *s
, unsigned long *ret_u
) {
215 assert_cc(sizeof(unsigned long) == sizeof(unsigned));
216 return safe_atou(s
, (unsigned*) ret_u
);
218 static inline int safe_atoli(const char *s
, long int *ret_u
) {
219 assert_cc(sizeof(long int) == sizeof(int));
220 return safe_atoi(s
, (int*) ret_u
);
223 static inline int safe_atolu(const char *s
, unsigned long *ret_u
) {
224 assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
225 return safe_atollu(s
, (unsigned long long*) ret_u
);
227 static inline int safe_atoli(const char *s
, long int *ret_u
) {
228 assert_cc(sizeof(long int) == sizeof(long long int));
229 return safe_atolli(s
, (long long int*) ret_u
);
233 static inline int safe_atou32(const char *s
, uint32_t *ret_u
) {
234 assert_cc(sizeof(uint32_t) == sizeof(unsigned));
235 return safe_atou(s
, (unsigned*) ret_u
);
238 static inline int safe_atoi32(const char *s
, int32_t *ret_i
) {
239 assert_cc(sizeof(int32_t) == sizeof(int));
240 return safe_atoi(s
, (int*) ret_i
);
243 static inline int safe_atou64(const char *s
, uint64_t *ret_u
) {
244 assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
245 return safe_atollu(s
, (unsigned long long*) ret_u
);
248 static inline int safe_atoi64(const char *s
, int64_t *ret_i
) {
249 assert_cc(sizeof(int64_t) == sizeof(long long int));
250 return safe_atolli(s
, (long long int*) ret_i
);
253 int safe_atou16(const char *s
, uint16_t *ret
);
254 int safe_atoi16(const char *s
, int16_t *ret
);
256 const char* split(const char **state
, size_t *l
, const char *separator
, bool quoted
);
258 #define FOREACH_WORD(word, length, s, state) \
259 _FOREACH_WORD(word, length, s, WHITESPACE, false, state)
261 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state) \
262 _FOREACH_WORD(word, length, s, separator, false, state)
264 #define FOREACH_WORD_QUOTED(word, length, s, state) \
265 _FOREACH_WORD(word, length, s, WHITESPACE, true, state)
267 #define _FOREACH_WORD(word, length, s, separator, quoted, state) \
268 for ((state) = (s), (word) = split(&(state), &(length), (separator), (quoted)); (word); (word) = split(&(state), &(length), (separator), (quoted)))
270 pid_t
get_parent_of_pid(pid_t pid
, pid_t
*ppid
);
272 char *strappend(const char *s
, const char *suffix
);
273 char *strnappend(const char *s
, const char *suffix
, size_t length
);
275 char *replace_env(const char *format
, char **env
);
276 char **replace_env_argv(char **argv
, char **env
);
278 int readlinkat_malloc(int fd
, const char *p
, char **ret
);
279 int readlink_malloc(const char *p
, char **r
);
280 int readlink_value(const char *p
, char **ret
);
281 int readlink_and_make_absolute(const char *p
, char **r
);
282 int readlink_and_canonicalize(const char *p
, char **r
);
284 int reset_all_signal_handlers(void);
285 int reset_signal_mask(void);
287 char *strstrip(char *s
);
288 char *delete_chars(char *s
, const char *bad
);
289 char *truncate_nl(char *s
);
291 char *file_in_same_dir(const char *path
, const char *filename
);
293 int rmdir_parents(const char *path
, const char *stop
);
295 int get_process_state(pid_t pid
);
296 int get_process_comm(pid_t pid
, char **name
);
297 int get_process_cmdline(pid_t pid
, size_t max_length
, bool comm_fallback
, char **line
);
298 int get_process_exe(pid_t pid
, char **name
);
299 int get_process_uid(pid_t pid
, uid_t
*uid
);
300 int get_process_gid(pid_t pid
, gid_t
*gid
);
301 int get_process_capeff(pid_t pid
, char **capeff
);
302 int get_process_cwd(pid_t pid
, char **cwd
);
303 int get_process_root(pid_t pid
, char **root
);
304 int get_process_environ(pid_t pid
, char **environ
);
306 char hexchar(int x
) _const_
;
307 int unhexchar(char c
) _const_
;
308 char octchar(int x
) _const_
;
309 int unoctchar(char c
) _const_
;
310 char decchar(int x
) _const_
;
311 int undecchar(char c
) _const_
;
313 char *cescape(const char *s
);
314 char *cunescape(const char *s
);
315 char *cunescape_length(const char *s
, size_t length
);
316 char *cunescape_length_with_prefix(const char *s
, size_t length
, const char *prefix
);
318 char *xescape(const char *s
, const char *bad
);
320 char *ascii_strlower(char *path
);
322 bool dirent_is_file(const struct dirent
*de
) _pure_
;
323 bool dirent_is_file_with_suffix(const struct dirent
*de
, const char *suffix
) _pure_
;
325 bool hidden_file(const char *filename
) _pure_
;
327 bool chars_intersect(const char *a
, const char *b
) _pure_
;
329 int make_stdio(int fd
);
330 int make_null_stdio(void);
331 int make_console_stdio(void);
333 int dev_urandom(void *p
, size_t n
);
334 void random_bytes(void *p
, size_t n
);
335 void initialize_srand(void);
337 static inline uint64_t random_u64(void) {
339 random_bytes(&u
, sizeof(u
));
343 static inline uint32_t random_u32(void) {
345 random_bytes(&u
, sizeof(u
));
349 /* For basic lookup tables with strictly enumerated entries */
350 #define _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope) \
351 scope const char *name##_to_string(type i) { \
352 if (i < 0 || i >= (type) ELEMENTSOF(name##_table)) \
354 return name##_table[i]; \
357 ssize_t
string_table_lookup(const char * const *table
, size_t len
, const char *key
);
359 #define _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope) \
360 scope inline type name##_from_string(const char *s) { \
361 return (type)string_table_lookup(name##_table, ELEMENTSOF(name##_table), s); \
364 #define _DEFINE_STRING_TABLE_LOOKUP(name,type,scope) \
365 _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope) \
366 _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope) \
367 struct __useless_struct_to_allow_trailing_semicolon__
369 #define DEFINE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,)
370 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,static)
371 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_TO_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,static)
372 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_FROM_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,static)
374 /* For string conversions where numbers are also acceptable */
375 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max) \
376 int name##_to_string_alloc(type i, char **str) { \
379 if (i < 0 || i > max) \
381 if (i < (type) ELEMENTSOF(name##_table)) { \
382 s = strdup(name##_table[i]); \
386 r = asprintf(&s, "%i", i); \
393 type name##_from_string(const char *s) { \
397 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
398 if (name##_table[i] && \
399 streq(name##_table[i], s)) \
401 if (safe_atou(s, &u) >= 0 && u <= max) \
405 struct __useless_struct_to_allow_trailing_semicolon__
407 int fd_nonblock(int fd
, bool nonblock
);
408 int fd_cloexec(int fd
, bool cloexec
);
410 int close_all_fds(const int except
[], unsigned n_except
);
412 bool fstype_is_network(const char *fstype
);
416 int read_one_char(FILE *f
, char *ret
, usec_t timeout
, bool *need_nl
);
417 int ask_char(char *ret
, const char *replies
, const char *text
, ...) _printf_(3, 4);
418 int ask_string(char **ret
, const char *text
, ...) _printf_(2, 3);
420 int reset_terminal_fd(int fd
, bool switch_to_text
);
421 int reset_terminal(const char *name
);
423 int open_terminal(const char *name
, int mode
);
424 int acquire_terminal(const char *name
, bool fail
, bool force
, bool ignore_tiocstty_eperm
, usec_t timeout
);
425 int release_terminal(void);
427 int flush_fd(int fd
);
429 int ignore_signals(int sig
, ...);
430 int default_signals(int sig
, ...);
431 int sigaction_many(const struct sigaction
*sa
, ...);
433 int fopen_temporary(const char *path
, FILE **_f
, char **_temp_path
);
435 ssize_t
loop_read(int fd
, void *buf
, size_t nbytes
, bool do_poll
);
436 int loop_read_exact(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 bool is_temporary_fs(const struct statfs
*s
) _pure_
;
466 int fd_is_temporary_fs(int fd
);
468 int pipe_eof(int fd
);
470 cpu_set_t
* cpu_set_malloc(unsigned *ncpus
);
472 int status_vprintf(const char *status
, bool ellipse
, bool ephemeral
, const char *format
, va_list ap
) _printf_(4,0);
473 int status_printf(const char *status
, bool ellipse
, bool ephemeral
, const char *format
, ...) _printf_(4,5);
475 #define xsprintf(buf, fmt, ...) assert_se((size_t) snprintf(buf, ELEMENTSOF(buf), fmt, __VA_ARGS__) < ELEMENTSOF(buf))
477 int fd_columns(int fd
);
478 unsigned columns(void);
479 int fd_lines(int fd
);
480 unsigned lines(void);
481 void columns_lines_cache_reset(int _unused_ signum
);
485 static inline const char *ansi_highlight(void) {
486 return on_tty() ? ANSI_HIGHLIGHT_ON
: "";
489 static inline const char *ansi_highlight_red(void) {
490 return on_tty() ? ANSI_HIGHLIGHT_RED_ON
: "";
493 static inline const char *ansi_highlight_green(void) {
494 return on_tty() ? ANSI_HIGHLIGHT_GREEN_ON
: "";
497 static inline const char *ansi_highlight_yellow(void) {
498 return on_tty() ? ANSI_HIGHLIGHT_YELLOW_ON
: "";
501 static inline const char *ansi_highlight_blue(void) {
502 return on_tty() ? ANSI_HIGHLIGHT_BLUE_ON
: "";
505 static inline const char *ansi_highlight_off(void) {
506 return on_tty() ? ANSI_HIGHLIGHT_OFF
: "";
509 int files_same(const char *filea
, const char *fileb
);
511 int running_in_chroot(void);
513 char *ellipsize(const char *s
, size_t length
, unsigned percent
);
515 char *ellipsize_mem(const char *s
, size_t old_length
, size_t new_length
, unsigned percent
);
517 int touch_file(const char *path
, bool parents
, usec_t stamp
, uid_t uid
, gid_t gid
, mode_t mode
);
518 int touch(const char *path
);
520 char *unquote(const char *s
, const char *quotes
);
521 char *normalize_env_assignment(const char *s
);
523 int wait_for_terminate(pid_t pid
, siginfo_t
*status
);
524 int wait_for_terminate_and_warn(const char *name
, pid_t pid
, bool check_exit_code
);
526 noreturn
void freeze(void);
528 bool null_or_empty(struct stat
*st
) _pure_
;
529 int null_or_empty_path(const char *fn
);
530 int null_or_empty_fd(int fd
);
532 DIR *xopendirat(int dirfd
, const char *name
, int flags
);
534 char *fstab_node_to_udev_node(const char *p
);
536 char *resolve_dev_console(char **active
);
537 bool tty_is_vc(const char *tty
);
538 bool tty_is_vc_resolve(const char *tty
);
539 bool tty_is_console(const char *tty
) _pure_
;
540 int vtnr_from_tty(const char *tty
);
541 const char *default_term_for_tty(const char *tty
);
543 void execute_directories(const char* const* directories
, usec_t timeout
, char *argv
[]);
545 int kill_and_sigcont(pid_t pid
, int sig
);
547 bool nulstr_contains(const char*nulstr
, const char *needle
);
549 bool plymouth_running(void);
551 bool hostname_is_valid(const char *s
) _pure_
;
552 char* hostname_cleanup(char *s
, bool lowercase
);
554 bool machine_name_is_valid(const char *s
) _pure_
;
556 char* strshorten(char *s
, size_t l
);
558 int terminal_vhangup_fd(int fd
);
559 int terminal_vhangup(const char *name
);
561 int vt_disallocate(const char *name
);
563 int symlink_atomic(const char *from
, const char *to
);
564 int mknod_atomic(const char *path
, mode_t mode
, dev_t dev
);
565 int mkfifo_atomic(const char *path
, mode_t mode
);
567 int fchmod_umask(int fd
, mode_t mode
);
569 bool display_is_local(const char *display
) _pure_
;
570 int socket_from_display(const char *display
, char **path
);
572 int get_user_creds(const char **username
, uid_t
*uid
, gid_t
*gid
, const char **home
, const char **shell
);
573 int get_group_creds(const char **groupname
, gid_t
*gid
);
575 int in_gid(gid_t gid
);
576 int in_group(const char *name
);
578 char* uid_to_name(uid_t uid
);
579 char* gid_to_name(gid_t gid
);
581 int glob_exists(const char *path
);
582 int glob_extend(char ***strv
, const char *path
);
584 int dirent_ensure_type(DIR *d
, struct dirent
*de
);
586 int get_files_in_directory(const char *path
, char ***list
);
588 char *strjoin(const char *x
, ...) _sentinel_
;
590 bool is_main_thread(void);
592 static inline bool _pure_
in_charset(const char *s
, const char* charset
) {
595 return s
[strspn(s
, charset
)] == '\0';
598 int block_get_whole_disk(dev_t d
, dev_t
*ret
);
600 #define NULSTR_FOREACH(i, l) \
601 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
603 #define NULSTR_FOREACH_PAIR(i, j, l) \
604 for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
606 int ioprio_class_to_string_alloc(int i
, char **s
);
607 int ioprio_class_from_string(const char *s
);
609 const char *sigchld_code_to_string(int i
) _const_
;
610 int sigchld_code_from_string(const char *s
) _pure_
;
612 int log_facility_unshifted_to_string_alloc(int i
, char **s
);
613 int log_facility_unshifted_from_string(const char *s
);
615 int log_level_to_string_alloc(int i
, char **s
);
616 int log_level_from_string(const char *s
);
618 int sched_policy_to_string_alloc(int i
, char **s
);
619 int sched_policy_from_string(const char *s
);
621 const char *rlimit_to_string(int i
) _const_
;
622 int rlimit_from_string(const char *s
) _pure_
;
624 int ip_tos_to_string_alloc(int i
, char **s
);
625 int ip_tos_from_string(const char *s
);
627 const char *signal_to_string(int i
) _const_
;
628 int signal_from_string(const char *s
) _pure_
;
630 int signal_from_string_try_harder(const char *s
);
632 extern int saved_argc
;
633 extern char **saved_argv
;
635 bool kexec_loaded(void);
637 int prot_from_flags(int flags
) _const_
;
639 char *format_bytes(char *buf
, size_t l
, off_t t
);
641 int fd_wait_for_event(int fd
, int event
, usec_t timeout
);
643 void* memdup(const void *p
, size_t l
) _alloc_(2);
645 int is_kernel_thread(pid_t pid
);
647 int fd_inc_sndbuf(int fd
, size_t n
);
648 int fd_inc_rcvbuf(int fd
, size_t n
);
650 int fork_agent(pid_t
*pid
, const int except
[], unsigned n_except
, const char *path
, ...);
652 int setrlimit_closest(int resource
, const struct rlimit
*rlim
);
654 int getenv_for_pid(pid_t pid
, const char *field
, char **_value
);
656 bool http_url_is_valid(const char *url
) _pure_
;
657 bool documentation_url_is_valid(const char *url
) _pure_
;
659 bool http_etag_is_valid(const char *etag
);
661 bool in_initrd(void);
663 void warn_melody(void);
665 int get_home_dir(char **ret
);
666 int get_shell(char **_ret
);
668 static inline void freep(void *p
) {
672 static inline void closep(int *fd
) {
676 static inline void umaskp(mode_t
*u
) {
680 static inline void close_pairp(int (*p
)[2]) {
684 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, fclose
);
685 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, pclose
);
686 DEFINE_TRIVIAL_CLEANUP_FUNC(DIR*, closedir
);
687 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, endmntent
);
689 #define _cleanup_free_ _cleanup_(freep)
690 #define _cleanup_close_ _cleanup_(closep)
691 #define _cleanup_umask_ _cleanup_(umaskp)
692 #define _cleanup_globfree_ _cleanup_(globfree)
693 #define _cleanup_fclose_ _cleanup_(fclosep)
694 #define _cleanup_pclose_ _cleanup_(pclosep)
695 #define _cleanup_closedir_ _cleanup_(closedirp)
696 #define _cleanup_endmntent_ _cleanup_(endmntentp)
697 #define _cleanup_close_pair_ _cleanup_(close_pairp)
699 _malloc_
_alloc_(1, 2) static inline void *malloc_multiply(size_t a
, size_t b
) {
700 if (_unlikely_(b
!= 0 && a
> ((size_t) -1) / b
))
703 return malloc(a
* b
);
706 _alloc_(2, 3) static inline void *realloc_multiply(void *p
, size_t a
, size_t b
) {
707 if (_unlikely_(b
!= 0 && a
> ((size_t) -1) / b
))
710 return realloc(p
, a
* b
);
713 _alloc_(2, 3) static inline void *memdup_multiply(const void *p
, size_t a
, size_t b
) {
714 if (_unlikely_(b
!= 0 && a
> ((size_t) -1) / b
))
717 return memdup(p
, a
* b
);
720 bool filename_is_valid(const char *p
) _pure_
;
721 bool path_is_safe(const char *p
) _pure_
;
722 bool string_is_safe(const char *p
) _pure_
;
723 bool string_has_cc(const char *p
, const char *ok
) _pure_
;
726 * Check if a string contains any glob patterns.
728 _pure_
static inline bool string_is_glob(const char *p
) {
729 return !!strpbrk(p
, GLOB_CHARS
);
732 void *xbsearch_r(const void *key
, const void *base
, size_t nmemb
, size_t size
,
733 int (*compar
) (const void *, const void *, void *),
736 #define _(String) gettext (String)
737 void init_gettext(void);
738 bool is_locale_utf8(void);
740 typedef enum DrawSpecialChar
{
745 DRAW_TRIANGULAR_BULLET
,
749 _DRAW_SPECIAL_CHAR_MAX
752 const char *draw_special_char(DrawSpecialChar ch
);
754 char *strreplace(const char *text
, const char *old_string
, const char *new_string
);
756 char *strip_tab_ansi(char **p
, size_t *l
);
758 int on_ac_power(void);
760 int search_and_fopen(const char *path
, const char *mode
, const char *root
, const char **search
, FILE **_f
);
761 int search_and_fopen_nulstr(const char *path
, const char *mode
, const char *root
, const char *search
, FILE **_f
);
763 #define FOREACH_LINE(line, f, on_error) \
765 if (!fgets(line, sizeof(line), f)) { \
772 #define FOREACH_DIRENT(de, d, on_error) \
773 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
779 } else if (hidden_file((de)->d_name)) \
783 #define FOREACH_DIRENT_ALL(de, d, on_error) \
784 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
792 static inline void *mempset(void *s
, int c
, size_t n
) {
794 return (uint8_t*)s
+ n
;
797 char *hexmem(const void *p
, size_t l
);
798 void *unhexmem(const char *p
, size_t l
);
800 char *strextend(char **x
, ...) _sentinel_
;
801 char *strrep(const char *s
, unsigned n
);
803 void* greedy_realloc(void **p
, size_t *allocated
, size_t need
, size_t size
);
804 void* greedy_realloc0(void **p
, size_t *allocated
, size_t need
, size_t size
);
805 #define GREEDY_REALLOC(array, allocated, need) \
806 greedy_realloc((void**) &(array), &(allocated), (need), sizeof((array)[0]))
808 #define GREEDY_REALLOC0(array, allocated, need) \
809 greedy_realloc0((void**) &(array), &(allocated), (need), sizeof((array)[0]))
811 static inline void _reset_errno_(int *saved_errno
) {
812 errno
= *saved_errno
;
815 #define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
817 static inline int negative_errno(void) {
818 /* This helper should be used to shut up gcc if you know 'errno' is
819 * negative. Instead of "return -errno;", use "return negative_errno();"
820 * It will suppress bogus gcc warnings in case it assumes 'errno' might
821 * be 0 and thus the caller's error-handling might not be triggered. */
822 assert_return(errno
> 0, -EINVAL
);
826 struct _umask_struct_
{
831 static inline void _reset_umask_(struct _umask_struct_
*s
) {
835 #define RUN_WITH_UMASK(mask) \
836 for (_cleanup_(_reset_umask_) struct _umask_struct_ _saved_umask_ = { umask(mask), false }; \
837 !_saved_umask_.quit ; \
838 _saved_umask_.quit = true)
840 static inline unsigned u64log2(uint64_t n
) {
841 #if __SIZEOF_LONG_LONG__ == 8
842 return (n
> 1) ? (unsigned) __builtin_clzll(n
) ^ 63U : 0;
848 static inline unsigned u32ctz(uint32_t n
) {
849 #if __SIZEOF_INT__ == 4
850 return __builtin_ctz(n
);
856 static inline unsigned log2i(int x
) {
859 return __SIZEOF_INT__
* 8 - __builtin_clz(x
) - 1;
862 static inline unsigned log2u(unsigned x
) {
865 return sizeof(unsigned) * 8 - __builtin_clz(x
) - 1;
868 static inline unsigned log2u_round_up(unsigned x
) {
874 return log2u(x
- 1) + 1;
877 static inline bool logind_running(void) {
878 return access("/run/systemd/seats/", F_OK
) >= 0;
881 #define DECIMAL_STR_WIDTH(x) \
883 typeof(x) _x_ = (x); \
890 int unlink_noerrno(const char *path
);
896 _new_ = alloca(_len_); \
897 (void *) memset(_new_, 0, _len_); \
900 /* It's not clear what alignment glibc/gcc alloca() guarantee, hence provide a guaranteed safe version */
901 #define alloca_align(size, align) \
904 size_t _mask_ = (align) - 1; \
905 _ptr_ = alloca((size) + _mask_); \
906 (void*)(((uintptr_t)_ptr_ + _mask_) & ~_mask_); \
909 #define alloca0_align(size, align) \
912 size_t _size_ = (size); \
913 _new_ = alloca_align(_size_, (align)); \
914 (void*)memset(_new_, 0, _size_); \
917 #define strjoina(a, ...) \
919 const char *_appendees_[] = { a, __VA_ARGS__ }; \
923 for (_i_ = 0; _i_ < ELEMENTSOF(_appendees_) && _appendees_[_i_]; _i_++) \
924 _len_ += strlen(_appendees_[_i_]); \
925 _p_ = _d_ = alloca(_len_ + 1); \
926 for (_i_ = 0; _i_ < ELEMENTSOF(_appendees_) && _appendees_[_i_]; _i_++) \
927 _p_ = stpcpy(_p_, _appendees_[_i_]); \
932 #define procfs_file_alloca(pid, field) \
934 pid_t _pid_ = (pid); \
937 _r_ = ("/proc/self/" field); \
939 _r_ = alloca(strlen("/proc/") + DECIMAL_STR_MAX(pid_t) + 1 + sizeof(field)); \
940 sprintf((char*) _r_, "/proc/"PID_FMT"/" field, _pid_); \
945 bool id128_is_valid(const char *s
) _pure_
;
947 int split_pair(const char *s
, const char *sep
, char **l
, char **r
);
949 int shall_restore_state(void);
952 * Normal qsort requires base to be nonnull. Here were require
953 * that only if nmemb > 0.
955 static inline void qsort_safe(void *base
, size_t nmemb
, size_t size
,
956 int (*compar
)(const void *, const void *)) {
959 qsort(base
, nmemb
, size
, compar
);
963 int proc_cmdline(char **ret
);
964 int parse_proc_cmdline(int (*parse_word
)(const char *key
, const char *value
));
965 int get_proc_cmdline_key(const char *parameter
, char **value
);
967 int container_get_leader(const char *machine
, pid_t
*pid
);
969 int namespace_open(pid_t pid
, int *pidns_fd
, int *mntns_fd
, int *netns_fd
, int *root_fd
);
970 int namespace_enter(int pidns_fd
, int mntns_fd
, int netns_fd
, int root_fd
);
972 bool pid_is_alive(pid_t pid
);
973 bool pid_is_unwaited(pid_t pid
);
975 int getpeercred(int fd
, struct ucred
*ucred
);
976 int getpeersec(int fd
, char **ret
);
978 int writev_safe(int fd
, const struct iovec
*w
, int j
);
980 int mkostemp_safe(char *pattern
, int flags
);
981 int open_tmpfile(const char *path
, int flags
);
983 int fd_warn_permissions(const char *path
, int fd
);
985 unsigned long personality_from_string(const char *p
);
986 const char *personality_to_string(unsigned long);
988 uint64_t physical_memory(void);
990 void hexdump(FILE *f
, const void *p
, size_t s
);
992 union file_handle_union
{
993 struct file_handle handle
;
994 char padding
[sizeof(struct file_handle
) + MAX_HANDLE_SZ
];
996 #define FILE_HANDLE_INIT { .handle.handle_bytes = MAX_HANDLE_SZ }
998 int update_reboot_param_file(const char *param
);
1000 int umount_recursive(const char *target
, int flags
);
1002 int bind_remount_recursive(const char *prefix
, bool ro
);
1004 int fflush_and_check(FILE *f
);
1006 int tempfn_xxxxxx(const char *p
, char **ret
);
1007 int tempfn_random(const char *p
, char **ret
);
1008 int tempfn_random_child(const char *p
, char **ret
);
1010 bool is_localhost(const char *hostname
);
1012 int take_password_lock(const char *root
);
1014 int is_symlink(const char *path
);
1015 int is_dir(const char *path
, bool follow
);
1017 typedef enum UnquoteFlags
{
1019 UNQUOTE_CUNESCAPE
= 2,
1022 int unquote_first_word(const char **p
, char **ret
, UnquoteFlags flags
);
1023 int unquote_many_words(const char **p
, UnquoteFlags flags
, ...) _sentinel_
;
1025 int free_and_strdup(char **p
, const char *s
);
1027 int sethostname_idempotent(const char *s
);
1029 #define INOTIFY_EVENT_MAX (sizeof(struct inotify_event) + NAME_MAX + 1)
1031 #define FOREACH_INOTIFY_EVENT(e, buffer, sz) \
1032 for ((e) = &buffer.ev; \
1033 (uint8_t*) (e) < (uint8_t*) (buffer.raw) + (sz); \
1034 (e) = (struct inotify_event*) ((uint8_t*) (e) + sizeof(struct inotify_event) + (e)->len))
1036 union inotify_event_buffer
{
1037 struct inotify_event ev
;
1038 uint8_t raw
[INOTIFY_EVENT_MAX
];
1041 #define laccess(path, mode) faccessat(AT_FDCWD, (path), (mode), AT_SYMLINK_NOFOLLOW)
1043 int ptsname_malloc(int fd
, char **ret
);
1045 int openpt_in_namespace(pid_t pid
, int flags
);
1047 ssize_t
fgetxattrat_fake(int dirfd
, const char *filename
, const char *attribute
, void *value
, size_t size
, int flags
);
1049 int fd_setcrtime(int fd
, usec_t usec
);
1050 int fd_getcrtime(int fd
, usec_t
*usec
);
1051 int path_getcrtime(const char *p
, usec_t
*usec
);
1052 int fd_getcrtime_at(int dirfd
, const char *name
, usec_t
*usec
, int flags
);
1054 int same_fd(int a
, int b
);
1056 int chattr_fd(int fd
, bool b
, unsigned mask
);
1057 int chattr_path(const char *p
, bool b
, unsigned mask
);
1058 int change_attr_fd(int fd
, unsigned value
, unsigned mask
);
1060 int read_attr_fd(int fd
, unsigned *ret
);
1061 int read_attr_path(const char *p
, unsigned *ret
);
1063 typedef struct LockFile
{
1069 int make_lock_file(const char *p
, int operation
, LockFile
*ret
);
1070 int make_lock_file_for(const char *p
, int operation
, LockFile
*ret
);
1071 void release_lock_file(LockFile
*f
);
1073 #define _cleanup_release_lock_file_ _cleanup_(release_lock_file)
1075 #define LOCK_FILE_INIT { .fd = -1, .path = NULL }
1077 #define RLIMIT_MAKE_CONST(lim) ((struct rlimit) { lim, lim })
1079 ssize_t
sparse_write(int fd
, const void *p
, size_t sz
, size_t run_length
);
1081 void sigkill_wait(pid_t
*pid
);
1082 #define _cleanup_sigkill_wait_ _cleanup_(sigkill_wait)
1084 int syslog_parse_priority(const char **p
, int *priority
, bool with_facility
);
1086 void cmsg_close_all(struct msghdr
*mh
);
1088 int rename_noreplace(int olddirfd
, const char *oldpath
, int newdirfd
, const char *newpath
);