]>
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>
48 #include "time-util.h"
49 #include "formats-util.h"
51 /* What is interpreted as whitespace? */
52 #define WHITESPACE " \t\n\r"
53 #define NEWLINE "\n\r"
56 #define GLOB_CHARS "*?["
58 /* What characters are special in the shell? */
59 /* must be escaped outside and inside double-quotes */
60 #define SHELL_NEED_ESCAPE "\"\\`$"
61 /* can be escaped or double-quoted */
62 #define SHELL_NEED_QUOTES SHELL_NEED_ESCAPE GLOB_CHARS "'()<>|&;"
64 #define FORMAT_BYTES_MAX 8
66 #define ANSI_HIGHLIGHT_ON "\x1B[1;39m"
67 #define ANSI_RED_ON "\x1B[31m"
68 #define ANSI_HIGHLIGHT_RED_ON "\x1B[1;31m"
69 #define ANSI_GREEN_ON "\x1B[32m"
70 #define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
71 #define ANSI_HIGHLIGHT_YELLOW_ON "\x1B[1;33m"
72 #define ANSI_HIGHLIGHT_BLUE_ON "\x1B[1;34m"
73 #define ANSI_HIGHLIGHT_OFF "\x1B[0m"
74 #define ANSI_ERASE_TO_END_OF_LINE "\x1B[K"
76 size_t page_size(void) _pure_
;
77 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
79 #define streq(a,b) (strcmp((a),(b)) == 0)
80 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
81 #define strcaseeq(a,b) (strcasecmp((a),(b)) == 0)
82 #define strncaseeq(a, b, n) (strncasecmp((a), (b), (n)) == 0)
84 bool streq_ptr(const char *a
, const char *b
) _pure_
;
86 #define new(t, n) ((t*) malloc_multiply(sizeof(t), (n)))
88 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
90 #define newa(t, n) ((t*) alloca(sizeof(t)*(n)))
92 #define newa0(t, n) ((t*) alloca0(sizeof(t)*(n)))
94 #define newdup(t, p, n) ((t*) memdup_multiply(p, sizeof(t), (n)))
96 #define malloc0(n) (calloc((n), 1))
98 static inline const char* yes_no(bool b
) {
99 return b
? "yes" : "no";
102 static inline const char* true_false(bool b
) {
103 return b
? "true" : "false";
106 static inline const char* one_zero(bool b
) {
107 return b
? "1" : "0";
110 static inline const char* strempty(const char *s
) {
114 static inline const char* strnull(const char *s
) {
115 return s
? s
: "(null)";
118 static inline const char *strna(const char *s
) {
119 return s
? s
: "n/a";
122 static inline bool isempty(const char *p
) {
126 static inline char *startswith(const char *s
, const char *prefix
) {
130 if (strncmp(s
, prefix
, l
) == 0)
131 return (char*) s
+ l
;
136 static inline char *startswith_no_case(const char *s
, const char *prefix
) {
140 if (strncasecmp(s
, prefix
, l
) == 0)
141 return (char*) s
+ l
;
146 char *endswith(const char *s
, const char *postfix
) _pure_
;
148 char *first_word(const char *s
, const char *word
) _pure_
;
150 int close_nointr(int fd
);
151 int safe_close(int fd
);
152 void safe_close_pair(int p
[]);
154 void close_many(const int fds
[], unsigned n_fd
);
156 int parse_size(const char *t
, off_t base
, off_t
*size
);
158 int parse_boolean(const char *v
) _pure_
;
159 int parse_pid(const char *s
, pid_t
* ret_pid
);
160 int parse_uid(const char *s
, uid_t
* ret_uid
);
161 #define parse_gid(s, ret_uid) parse_uid(s, ret_uid)
163 int safe_atou(const char *s
, unsigned *ret_u
);
164 int safe_atoi(const char *s
, int *ret_i
);
166 int safe_atollu(const char *s
, unsigned long long *ret_u
);
167 int safe_atolli(const char *s
, long long int *ret_i
);
169 int safe_atod(const char *s
, double *ret_d
);
171 int safe_atou8(const char *s
, uint8_t *ret
);
173 #if LONG_MAX == INT_MAX
174 static inline int safe_atolu(const char *s
, unsigned long *ret_u
) {
175 assert_cc(sizeof(unsigned long) == sizeof(unsigned));
176 return safe_atou(s
, (unsigned*) ret_u
);
178 static inline int safe_atoli(const char *s
, long int *ret_u
) {
179 assert_cc(sizeof(long int) == sizeof(int));
180 return safe_atoi(s
, (int*) ret_u
);
183 static inline int safe_atolu(const char *s
, unsigned long *ret_u
) {
184 assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
185 return safe_atollu(s
, (unsigned long long*) ret_u
);
187 static inline int safe_atoli(const char *s
, long int *ret_u
) {
188 assert_cc(sizeof(long int) == sizeof(long long int));
189 return safe_atolli(s
, (long long int*) ret_u
);
193 static inline int safe_atou32(const char *s
, uint32_t *ret_u
) {
194 assert_cc(sizeof(uint32_t) == sizeof(unsigned));
195 return safe_atou(s
, (unsigned*) ret_u
);
198 static inline int safe_atoi32(const char *s
, int32_t *ret_i
) {
199 assert_cc(sizeof(int32_t) == sizeof(int));
200 return safe_atoi(s
, (int*) ret_i
);
203 static inline int safe_atou64(const char *s
, uint64_t *ret_u
) {
204 assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
205 return safe_atollu(s
, (unsigned long long*) ret_u
);
208 static inline int safe_atoi64(const char *s
, int64_t *ret_i
) {
209 assert_cc(sizeof(int64_t) == sizeof(long long int));
210 return safe_atolli(s
, (long long int*) ret_i
);
213 int safe_atou16(const char *s
, uint16_t *ret
);
214 int safe_atoi16(const char *s
, int16_t *ret
);
216 const char* split(const char **state
, size_t *l
, const char *separator
, bool quoted
);
218 #define FOREACH_WORD(word, length, s, state) \
219 _FOREACH_WORD(word, length, s, WHITESPACE, false, state)
221 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state) \
222 _FOREACH_WORD(word, length, s, separator, false, state)
224 #define FOREACH_WORD_QUOTED(word, length, s, state) \
225 _FOREACH_WORD(word, length, s, WHITESPACE, true, state)
227 #define _FOREACH_WORD(word, length, s, separator, quoted, state) \
228 for ((state) = (s), (word) = split(&(state), &(length), (separator), (quoted)); (word); (word) = split(&(state), &(length), (separator), (quoted)))
230 char *strappend(const char *s
, const char *suffix
);
231 char *strnappend(const char *s
, const char *suffix
, size_t length
);
233 char *replace_env(const char *format
, char **env
);
234 char **replace_env_argv(char **argv
, char **env
);
236 int readlinkat_malloc(int fd
, const char *p
, char **ret
);
237 int readlink_malloc(const char *p
, char **r
);
238 int readlink_value(const char *p
, char **ret
);
239 int readlink_and_make_absolute(const char *p
, char **r
);
240 int readlink_and_canonicalize(const char *p
, char **r
);
242 int reset_all_signal_handlers(void);
243 int reset_signal_mask(void);
245 char *strstrip(char *s
);
246 char *delete_chars(char *s
, const char *bad
);
247 char *truncate_nl(char *s
);
249 char *file_in_same_dir(const char *path
, const char *filename
);
251 int rmdir_parents(const char *path
, const char *stop
);
253 char hexchar(int x
) _const_
;
254 int unhexchar(char c
) _const_
;
255 char octchar(int x
) _const_
;
256 int unoctchar(char c
) _const_
;
257 char decchar(int x
) _const_
;
258 int undecchar(char c
) _const_
;
260 char *cescape(const char *s
);
261 size_t cescape_char(char c
, char *buf
);
263 typedef enum UnescapeFlags
{
267 int cunescape(const char *s
, UnescapeFlags flags
, char **ret
);
268 int cunescape_length(const char *s
, size_t length
, UnescapeFlags flags
, char **ret
);
269 int cunescape_length_with_prefix(const char *s
, size_t length
, const char *prefix
, UnescapeFlags flags
, char **ret
);
271 char *xescape(const char *s
, const char *bad
);
273 char *ascii_strlower(char *path
);
275 bool dirent_is_file(const struct dirent
*de
) _pure_
;
276 bool dirent_is_file_with_suffix(const struct dirent
*de
, const char *suffix
) _pure_
;
278 bool hidden_file(const char *filename
) _pure_
;
280 bool chars_intersect(const char *a
, const char *b
) _pure_
;
282 int make_stdio(int fd
);
283 int make_null_stdio(void);
284 int make_console_stdio(void);
286 int dev_urandom(void *p
, size_t n
);
287 void random_bytes(void *p
, size_t n
);
288 void initialize_srand(void);
290 static inline uint64_t random_u64(void) {
292 random_bytes(&u
, sizeof(u
));
296 static inline uint32_t random_u32(void) {
298 random_bytes(&u
, sizeof(u
));
302 /* For basic lookup tables with strictly enumerated entries */
303 #define _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope) \
304 scope const char *name##_to_string(type i) { \
305 if (i < 0 || i >= (type) ELEMENTSOF(name##_table)) \
307 return name##_table[i]; \
310 ssize_t
string_table_lookup(const char * const *table
, size_t len
, const char *key
);
312 #define _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope) \
313 scope inline type name##_from_string(const char *s) { \
314 return (type)string_table_lookup(name##_table, ELEMENTSOF(name##_table), s); \
317 #define _DEFINE_STRING_TABLE_LOOKUP(name,type,scope) \
318 _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope) \
319 _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope) \
320 struct __useless_struct_to_allow_trailing_semicolon__
322 #define DEFINE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,)
323 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,static)
324 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_TO_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,static)
325 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_FROM_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,static)
327 /* For string conversions where numbers are also acceptable */
328 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max) \
329 int name##_to_string_alloc(type i, char **str) { \
332 if (i < 0 || i > max) \
334 if (i < (type) ELEMENTSOF(name##_table)) { \
335 s = strdup(name##_table[i]); \
339 r = asprintf(&s, "%i", i); \
346 type name##_from_string(const char *s) { \
350 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
351 if (name##_table[i] && \
352 streq(name##_table[i], s)) \
354 if (safe_atou(s, &u) >= 0 && u <= max) \
358 struct __useless_struct_to_allow_trailing_semicolon__
360 int fd_nonblock(int fd
, bool nonblock
);
361 int fd_cloexec(int fd
, bool cloexec
);
363 int close_all_fds(const int except
[], unsigned n_except
);
365 bool fstype_is_network(const char *fstype
);
369 int read_one_char(FILE *f
, char *ret
, usec_t timeout
, bool *need_nl
);
370 int ask_char(char *ret
, const char *replies
, const char *text
, ...) _printf_(3, 4);
371 int ask_string(char **ret
, const char *text
, ...) _printf_(2, 3);
373 int reset_terminal_fd(int fd
, bool switch_to_text
);
374 int reset_terminal(const char *name
);
376 int open_terminal(const char *name
, int mode
);
377 int acquire_terminal(const char *name
, bool fail
, bool force
, bool ignore_tiocstty_eperm
, usec_t timeout
);
378 int release_terminal(void);
380 int flush_fd(int fd
);
382 int ignore_signals(int sig
, ...);
383 int default_signals(int sig
, ...);
384 int sigaction_many(const struct sigaction
*sa
, ...);
386 int fopen_temporary(const char *path
, FILE **_f
, char **_temp_path
);
388 ssize_t
loop_read(int fd
, void *buf
, size_t nbytes
, bool do_poll
);
389 int loop_read_exact(int fd
, void *buf
, size_t nbytes
, bool do_poll
);
390 int loop_write(int fd
, const void *buf
, size_t nbytes
, bool do_poll
);
392 bool is_device_path(const char *path
);
394 int dir_is_empty(const char *path
);
395 char* dirname_malloc(const char *path
);
397 void sigset_add_many(sigset_t
*ss
, ...);
398 int sigprocmask_many(int how
, ...);
400 bool hostname_is_set(void);
402 char* lookup_uid(uid_t uid
);
403 char* gethostname_malloc(void);
404 char* getlogname_malloc(void);
405 char* getusername_malloc(void);
407 int getttyname_malloc(int fd
, char **r
);
408 int getttyname_harder(int fd
, char **r
);
410 int get_ctty_devnr(pid_t pid
, dev_t
*d
);
411 int get_ctty(pid_t
, dev_t
*_devnr
, char **r
);
413 int chmod_and_chown(const char *path
, mode_t mode
, uid_t uid
, gid_t gid
);
414 int fchmod_and_fchown(int fd
, mode_t mode
, uid_t uid
, gid_t gid
);
416 bool is_temporary_fs(const struct statfs
*s
) _pure_
;
417 int fd_is_temporary_fs(int fd
);
419 int pipe_eof(int fd
);
421 cpu_set_t
* cpu_set_malloc(unsigned *ncpus
);
423 int status_vprintf(const char *status
, bool ellipse
, bool ephemeral
, const char *format
, va_list ap
) _printf_(4,0);
424 int status_printf(const char *status
, bool ellipse
, bool ephemeral
, const char *format
, ...) _printf_(4,5);
426 #define xsprintf(buf, fmt, ...) assert_se((size_t) snprintf(buf, ELEMENTSOF(buf), fmt, __VA_ARGS__) < ELEMENTSOF(buf))
428 int fd_columns(int fd
);
429 unsigned columns(void);
430 int fd_lines(int fd
);
431 unsigned lines(void);
432 void columns_lines_cache_reset(int _unused_ signum
);
436 static inline const char *ansi_highlight(void) {
437 return on_tty() ? ANSI_HIGHLIGHT_ON
: "";
440 static inline const char *ansi_highlight_red(void) {
441 return on_tty() ? ANSI_HIGHLIGHT_RED_ON
: "";
444 static inline const char *ansi_highlight_green(void) {
445 return on_tty() ? ANSI_HIGHLIGHT_GREEN_ON
: "";
448 static inline const char *ansi_highlight_yellow(void) {
449 return on_tty() ? ANSI_HIGHLIGHT_YELLOW_ON
: "";
452 static inline const char *ansi_highlight_blue(void) {
453 return on_tty() ? ANSI_HIGHLIGHT_BLUE_ON
: "";
456 static inline const char *ansi_highlight_off(void) {
457 return on_tty() ? ANSI_HIGHLIGHT_OFF
: "";
460 int files_same(const char *filea
, const char *fileb
);
462 int running_in_chroot(void);
464 char *ellipsize(const char *s
, size_t length
, unsigned percent
);
466 char *ellipsize_mem(const char *s
, size_t old_length
, size_t new_length
, unsigned percent
);
468 int touch_file(const char *path
, bool parents
, usec_t stamp
, uid_t uid
, gid_t gid
, mode_t mode
);
469 int touch(const char *path
);
471 noreturn
void freeze(void);
473 bool null_or_empty(struct stat
*st
) _pure_
;
474 int null_or_empty_path(const char *fn
);
475 int null_or_empty_fd(int fd
);
477 DIR *xopendirat(int dirfd
, const char *name
, int flags
);
479 char *fstab_node_to_udev_node(const char *p
);
481 char *resolve_dev_console(char **active
);
482 bool tty_is_vc(const char *tty
);
483 bool tty_is_vc_resolve(const char *tty
);
484 bool tty_is_console(const char *tty
) _pure_
;
485 int vtnr_from_tty(const char *tty
);
486 const char *default_term_for_tty(const char *tty
);
488 void execute_directories(const char* const* directories
, usec_t timeout
, char *argv
[]);
490 bool nulstr_contains(const char*nulstr
, const char *needle
);
492 bool plymouth_running(void);
494 bool hostname_is_valid(const char *s
) _pure_
;
495 char* hostname_cleanup(char *s
, bool lowercase
);
497 bool machine_name_is_valid(const char *s
) _pure_
;
499 char* strshorten(char *s
, size_t l
);
501 int terminal_vhangup_fd(int fd
);
502 int terminal_vhangup(const char *name
);
504 int vt_disallocate(const char *name
);
506 int symlink_atomic(const char *from
, const char *to
);
507 int mknod_atomic(const char *path
, mode_t mode
, dev_t dev
);
508 int mkfifo_atomic(const char *path
, mode_t mode
);
510 int fchmod_umask(int fd
, mode_t mode
);
512 bool display_is_local(const char *display
) _pure_
;
513 int socket_from_display(const char *display
, char **path
);
515 int get_user_creds(const char **username
, uid_t
*uid
, gid_t
*gid
, const char **home
, const char **shell
);
516 int get_group_creds(const char **groupname
, gid_t
*gid
);
518 int in_gid(gid_t gid
);
519 int in_group(const char *name
);
521 char* uid_to_name(uid_t uid
);
522 char* gid_to_name(gid_t gid
);
524 int glob_exists(const char *path
);
525 int glob_extend(char ***strv
, const char *path
);
527 int dirent_ensure_type(DIR *d
, struct dirent
*de
);
529 int get_files_in_directory(const char *path
, char ***list
);
531 char *strjoin(const char *x
, ...) _sentinel_
;
533 bool is_main_thread(void);
535 static inline bool _pure_
in_charset(const char *s
, const char* charset
) {
538 return s
[strspn(s
, charset
)] == '\0';
541 int block_get_whole_disk(dev_t d
, dev_t
*ret
);
543 #define NULSTR_FOREACH(i, l) \
544 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
546 #define NULSTR_FOREACH_PAIR(i, j, l) \
547 for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
549 int ioprio_class_to_string_alloc(int i
, char **s
);
550 int ioprio_class_from_string(const char *s
);
552 const char *sigchld_code_to_string(int i
) _const_
;
553 int sigchld_code_from_string(const char *s
) _pure_
;
555 int log_facility_unshifted_to_string_alloc(int i
, char **s
);
556 int log_facility_unshifted_from_string(const char *s
);
558 int log_level_to_string_alloc(int i
, char **s
);
559 int log_level_from_string(const char *s
);
561 int sched_policy_to_string_alloc(int i
, char **s
);
562 int sched_policy_from_string(const char *s
);
564 const char *rlimit_to_string(int i
) _const_
;
565 int rlimit_from_string(const char *s
) _pure_
;
567 int ip_tos_to_string_alloc(int i
, char **s
);
568 int ip_tos_from_string(const char *s
);
570 const char *signal_to_string(int i
) _const_
;
571 int signal_from_string(const char *s
) _pure_
;
573 int signal_from_string_try_harder(const char *s
);
575 extern int saved_argc
;
576 extern char **saved_argv
;
578 bool kexec_loaded(void);
580 int prot_from_flags(int flags
) _const_
;
582 char *format_bytes(char *buf
, size_t l
, off_t t
);
584 int fd_wait_for_event(int fd
, int event
, usec_t timeout
);
586 void* memdup(const void *p
, size_t l
) _alloc_(2);
588 int fd_inc_sndbuf(int fd
, size_t n
);
589 int fd_inc_rcvbuf(int fd
, size_t n
);
591 int fork_agent(pid_t
*pid
, const int except
[], unsigned n_except
, const char *path
, ...);
593 int setrlimit_closest(int resource
, const struct rlimit
*rlim
);
595 bool http_url_is_valid(const char *url
) _pure_
;
596 bool documentation_url_is_valid(const char *url
) _pure_
;
598 bool http_etag_is_valid(const char *etag
);
600 bool in_initrd(void);
602 void warn_melody(void);
604 int get_home_dir(char **ret
);
605 int get_shell(char **_ret
);
607 static inline void freep(void *p
) {
611 static inline void closep(int *fd
) {
615 static inline void umaskp(mode_t
*u
) {
619 static inline void close_pairp(int (*p
)[2]) {
623 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, fclose
);
624 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, pclose
);
625 DEFINE_TRIVIAL_CLEANUP_FUNC(DIR*, closedir
);
626 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, endmntent
);
628 #define _cleanup_free_ _cleanup_(freep)
629 #define _cleanup_close_ _cleanup_(closep)
630 #define _cleanup_umask_ _cleanup_(umaskp)
631 #define _cleanup_globfree_ _cleanup_(globfree)
632 #define _cleanup_fclose_ _cleanup_(fclosep)
633 #define _cleanup_pclose_ _cleanup_(pclosep)
634 #define _cleanup_closedir_ _cleanup_(closedirp)
635 #define _cleanup_endmntent_ _cleanup_(endmntentp)
636 #define _cleanup_close_pair_ _cleanup_(close_pairp)
638 _malloc_
_alloc_(1, 2) static inline void *malloc_multiply(size_t a
, size_t b
) {
639 if (_unlikely_(b
!= 0 && a
> ((size_t) -1) / b
))
642 return malloc(a
* b
);
645 _alloc_(2, 3) static inline void *realloc_multiply(void *p
, size_t a
, size_t b
) {
646 if (_unlikely_(b
!= 0 && a
> ((size_t) -1) / b
))
649 return realloc(p
, a
* b
);
652 _alloc_(2, 3) static inline void *memdup_multiply(const void *p
, size_t a
, size_t b
) {
653 if (_unlikely_(b
!= 0 && a
> ((size_t) -1) / b
))
656 return memdup(p
, a
* b
);
659 bool filename_is_valid(const char *p
) _pure_
;
660 bool path_is_safe(const char *p
) _pure_
;
661 bool string_is_safe(const char *p
) _pure_
;
662 bool string_has_cc(const char *p
, const char *ok
) _pure_
;
665 * Check if a string contains any glob patterns.
667 _pure_
static inline bool string_is_glob(const char *p
) {
668 return !!strpbrk(p
, GLOB_CHARS
);
671 void *xbsearch_r(const void *key
, const void *base
, size_t nmemb
, size_t size
,
672 int (*compar
) (const void *, const void *, void *),
675 #define _(String) gettext (String)
676 void init_gettext(void);
677 bool is_locale_utf8(void);
679 typedef enum DrawSpecialChar
{
684 DRAW_TRIANGULAR_BULLET
,
688 _DRAW_SPECIAL_CHAR_MAX
691 const char *draw_special_char(DrawSpecialChar ch
);
693 char *strreplace(const char *text
, const char *old_string
, const char *new_string
);
695 char *strip_tab_ansi(char **p
, size_t *l
);
697 int on_ac_power(void);
699 int search_and_fopen(const char *path
, const char *mode
, const char *root
, const char **search
, FILE **_f
);
700 int search_and_fopen_nulstr(const char *path
, const char *mode
, const char *root
, const char *search
, FILE **_f
);
702 #define FOREACH_LINE(line, f, on_error) \
704 if (!fgets(line, sizeof(line), f)) { \
711 #define FOREACH_DIRENT(de, d, on_error) \
712 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
718 } else if (hidden_file((de)->d_name)) \
722 #define FOREACH_DIRENT_ALL(de, d, on_error) \
723 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
731 static inline void *mempset(void *s
, int c
, size_t n
) {
733 return (uint8_t*)s
+ n
;
736 char *hexmem(const void *p
, size_t l
);
737 void *unhexmem(const char *p
, size_t l
);
739 char *strextend(char **x
, ...) _sentinel_
;
740 char *strrep(const char *s
, unsigned n
);
742 void* greedy_realloc(void **p
, size_t *allocated
, size_t need
, size_t size
);
743 void* greedy_realloc0(void **p
, size_t *allocated
, size_t need
, size_t size
);
744 #define GREEDY_REALLOC(array, allocated, need) \
745 greedy_realloc((void**) &(array), &(allocated), (need), sizeof((array)[0]))
747 #define GREEDY_REALLOC0(array, allocated, need) \
748 greedy_realloc0((void**) &(array), &(allocated), (need), sizeof((array)[0]))
750 static inline void _reset_errno_(int *saved_errno
) {
751 errno
= *saved_errno
;
754 #define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
756 static inline int negative_errno(void) {
757 /* This helper should be used to shut up gcc if you know 'errno' is
758 * negative. Instead of "return -errno;", use "return negative_errno();"
759 * It will suppress bogus gcc warnings in case it assumes 'errno' might
760 * be 0 and thus the caller's error-handling might not be triggered. */
761 assert_return(errno
> 0, -EINVAL
);
765 struct _umask_struct_
{
770 static inline void _reset_umask_(struct _umask_struct_
*s
) {
774 #define RUN_WITH_UMASK(mask) \
775 for (_cleanup_(_reset_umask_) struct _umask_struct_ _saved_umask_ = { umask(mask), false }; \
776 !_saved_umask_.quit ; \
777 _saved_umask_.quit = true)
779 static inline unsigned u64log2(uint64_t n
) {
780 #if __SIZEOF_LONG_LONG__ == 8
781 return (n
> 1) ? (unsigned) __builtin_clzll(n
) ^ 63U : 0;
787 static inline unsigned u32ctz(uint32_t n
) {
788 #if __SIZEOF_INT__ == 4
789 return __builtin_ctz(n
);
795 static inline unsigned log2i(int x
) {
798 return __SIZEOF_INT__
* 8 - __builtin_clz(x
) - 1;
801 static inline unsigned log2u(unsigned x
) {
804 return sizeof(unsigned) * 8 - __builtin_clz(x
) - 1;
807 static inline unsigned log2u_round_up(unsigned x
) {
813 return log2u(x
- 1) + 1;
816 static inline bool logind_running(void) {
817 return access("/run/systemd/seats/", F_OK
) >= 0;
820 #define DECIMAL_STR_WIDTH(x) \
822 typeof(x) _x_ = (x); \
829 int unlink_noerrno(const char *path
);
835 _new_ = alloca(_len_); \
836 (void *) memset(_new_, 0, _len_); \
839 /* It's not clear what alignment glibc/gcc alloca() guarantee, hence provide a guaranteed safe version */
840 #define alloca_align(size, align) \
843 size_t _mask_ = (align) - 1; \
844 _ptr_ = alloca((size) + _mask_); \
845 (void*)(((uintptr_t)_ptr_ + _mask_) & ~_mask_); \
848 #define alloca0_align(size, align) \
851 size_t _size_ = (size); \
852 _new_ = alloca_align(_size_, (align)); \
853 (void*)memset(_new_, 0, _size_); \
856 #define strjoina(a, ...) \
858 const char *_appendees_[] = { a, __VA_ARGS__ }; \
862 for (_i_ = 0; _i_ < ELEMENTSOF(_appendees_) && _appendees_[_i_]; _i_++) \
863 _len_ += strlen(_appendees_[_i_]); \
864 _p_ = _d_ = alloca(_len_ + 1); \
865 for (_i_ = 0; _i_ < ELEMENTSOF(_appendees_) && _appendees_[_i_]; _i_++) \
866 _p_ = stpcpy(_p_, _appendees_[_i_]); \
871 bool id128_is_valid(const char *s
) _pure_
;
873 int split_pair(const char *s
, const char *sep
, char **l
, char **r
);
875 int shall_restore_state(void);
878 * Normal qsort requires base to be nonnull. Here were require
879 * that only if nmemb > 0.
881 static inline void qsort_safe(void *base
, size_t nmemb
, size_t size
,
882 int (*compar
)(const void *, const void *)) {
885 qsort(base
, nmemb
, size
, compar
);
889 int proc_cmdline(char **ret
);
890 int parse_proc_cmdline(int (*parse_word
)(const char *key
, const char *value
));
891 int get_proc_cmdline_key(const char *parameter
, char **value
);
893 int container_get_leader(const char *machine
, pid_t
*pid
);
895 int namespace_open(pid_t pid
, int *pidns_fd
, int *mntns_fd
, int *netns_fd
, int *root_fd
);
896 int namespace_enter(int pidns_fd
, int mntns_fd
, int netns_fd
, int root_fd
);
898 int getpeercred(int fd
, struct ucred
*ucred
);
899 int getpeersec(int fd
, char **ret
);
901 int writev_safe(int fd
, const struct iovec
*w
, int j
);
903 int mkostemp_safe(char *pattern
, int flags
);
904 int open_tmpfile(const char *path
, int flags
);
906 int fd_warn_permissions(const char *path
, int fd
);
908 unsigned long personality_from_string(const char *p
);
909 const char *personality_to_string(unsigned long);
911 uint64_t physical_memory(void);
913 void hexdump(FILE *f
, const void *p
, size_t s
);
915 union file_handle_union
{
916 struct file_handle handle
;
917 char padding
[sizeof(struct file_handle
) + MAX_HANDLE_SZ
];
919 #define FILE_HANDLE_INIT { .handle.handle_bytes = MAX_HANDLE_SZ }
921 int update_reboot_param_file(const char *param
);
923 int umount_recursive(const char *target
, int flags
);
925 int bind_remount_recursive(const char *prefix
, bool ro
);
927 int fflush_and_check(FILE *f
);
929 int tempfn_xxxxxx(const char *p
, char **ret
);
930 int tempfn_random(const char *p
, char **ret
);
931 int tempfn_random_child(const char *p
, char **ret
);
933 bool is_localhost(const char *hostname
);
935 int take_password_lock(const char *root
);
937 int is_symlink(const char *path
);
938 int is_dir(const char *path
, bool follow
);
940 typedef enum UnquoteFlags
{
942 UNQUOTE_CUNESCAPE
= 2,
945 int unquote_first_word(const char **p
, char **ret
, UnquoteFlags flags
);
946 int unquote_many_words(const char **p
, UnquoteFlags flags
, ...) _sentinel_
;
948 int free_and_strdup(char **p
, const char *s
);
950 int sethostname_idempotent(const char *s
);
952 #define INOTIFY_EVENT_MAX (sizeof(struct inotify_event) + NAME_MAX + 1)
954 #define FOREACH_INOTIFY_EVENT(e, buffer, sz) \
955 for ((e) = &buffer.ev; \
956 (uint8_t*) (e) < (uint8_t*) (buffer.raw) + (sz); \
957 (e) = (struct inotify_event*) ((uint8_t*) (e) + sizeof(struct inotify_event) + (e)->len))
959 union inotify_event_buffer
{
960 struct inotify_event ev
;
961 uint8_t raw
[INOTIFY_EVENT_MAX
];
964 #define laccess(path, mode) faccessat(AT_FDCWD, (path), (mode), AT_SYMLINK_NOFOLLOW)
966 int ptsname_malloc(int fd
, char **ret
);
968 int openpt_in_namespace(pid_t pid
, int flags
);
970 ssize_t
fgetxattrat_fake(int dirfd
, const char *filename
, const char *attribute
, void *value
, size_t size
, int flags
);
972 int fd_setcrtime(int fd
, usec_t usec
);
973 int fd_getcrtime(int fd
, usec_t
*usec
);
974 int path_getcrtime(const char *p
, usec_t
*usec
);
975 int fd_getcrtime_at(int dirfd
, const char *name
, usec_t
*usec
, int flags
);
977 int same_fd(int a
, int b
);
979 int chattr_fd(int fd
, unsigned value
, unsigned mask
);
980 int chattr_path(const char *p
, unsigned value
, unsigned mask
);
982 int read_attr_fd(int fd
, unsigned *ret
);
983 int read_attr_path(const char *p
, unsigned *ret
);
985 typedef struct LockFile
{
991 int make_lock_file(const char *p
, int operation
, LockFile
*ret
);
992 int make_lock_file_for(const char *p
, int operation
, LockFile
*ret
);
993 void release_lock_file(LockFile
*f
);
995 #define _cleanup_release_lock_file_ _cleanup_(release_lock_file)
997 #define LOCK_FILE_INIT { .fd = -1, .path = NULL }
999 #define RLIMIT_MAKE_CONST(lim) ((struct rlimit) { lim, lim })
1001 ssize_t
sparse_write(int fd
, const void *p
, size_t sz
, size_t run_length
);
1003 void sigkill_wait(pid_t
*pid
);
1004 #define _cleanup_sigkill_wait_ _cleanup_(sigkill_wait)
1006 int syslog_parse_priority(const char **p
, int *priority
, bool with_facility
);
1008 void cmsg_close_all(struct msghdr
*mh
);
1010 int rename_noreplace(int olddirfd
, const char *oldpath
, int newdirfd
, const char *newpath
);
1012 char *shell_maybe_quote(const char *s
);
1014 int parse_mode(const char *s
, mode_t
*ret
);