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/inotify.h>
37 #include <sys/socket.h>
39 #include <sys/statfs.h>
40 #include <sys/types.h>
44 #include "formats-util.h"
47 #include "time-util.h"
49 /* What is interpreted as whitespace? */
50 #define WHITESPACE " \t\n\r"
51 #define NEWLINE "\n\r"
54 #define GLOB_CHARS "*?["
56 /* What characters are special in the shell? */
57 /* must be escaped outside and inside double-quotes */
58 #define SHELL_NEED_ESCAPE "\"\\`$"
59 /* can be escaped or double-quoted */
60 #define SHELL_NEED_QUOTES SHELL_NEED_ESCAPE GLOB_CHARS "'()<>|&;"
62 #define FORMAT_BYTES_MAX 8
64 size_t page_size(void) _pure_
;
65 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
67 #define streq(a,b) (strcmp((a),(b)) == 0)
68 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
69 #define strcaseeq(a,b) (strcasecmp((a),(b)) == 0)
70 #define strncaseeq(a, b, n) (strncasecmp((a), (b), (n)) == 0)
72 bool streq_ptr(const char *a
, const char *b
) _pure_
;
73 int strcmp_ptr(const char *a
, const char *b
) _pure_
;
75 #define new(t, n) ((t*) malloc_multiply(sizeof(t), (n)))
77 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
79 #define newa(t, n) ((t*) alloca(sizeof(t)*(n)))
81 #define newa0(t, n) ((t*) alloca0(sizeof(t)*(n)))
83 #define newdup(t, p, n) ((t*) memdup_multiply(p, sizeof(t), (n)))
85 #define malloc0(n) (calloc(1, (n)))
87 static inline void *mfree(void *memory
) {
92 static inline const char* yes_no(bool b
) {
93 return b
? "yes" : "no";
96 static inline const char* true_false(bool b
) {
97 return b
? "true" : "false";
100 static inline const char* one_zero(bool b
) {
101 return b
? "1" : "0";
104 static inline const char* strempty(const char *s
) {
108 static inline const char* strnull(const char *s
) {
109 return s
? s
: "(null)";
112 static inline const char *strna(const char *s
) {
113 return s
? s
: "n/a";
116 static inline bool isempty(const char *p
) {
120 static inline char *startswith(const char *s
, const char *prefix
) {
124 if (strncmp(s
, prefix
, l
) == 0)
125 return (char*) s
+ l
;
130 static inline char *startswith_no_case(const char *s
, const char *prefix
) {
134 if (strncasecmp(s
, prefix
, l
) == 0)
135 return (char*) s
+ l
;
140 char *endswith(const char *s
, const char *postfix
) _pure_
;
141 char *endswith_no_case(const char *s
, const char *postfix
) _pure_
;
143 char *first_word(const char *s
, const char *word
) _pure_
;
145 int close_nointr(int fd
);
146 int safe_close(int fd
);
147 void safe_close_pair(int p
[]);
149 void close_many(const int fds
[], unsigned n_fd
);
151 int fclose_nointr(FILE *f
);
152 FILE* safe_fclose(FILE *f
);
153 DIR* safe_closedir(DIR *f
);
155 int parse_size(const char *t
, uint64_t base
, uint64_t *size
);
157 int parse_boolean(const char *v
) _pure_
;
158 int parse_pid(const char *s
, pid_t
* ret_pid
);
159 int parse_uid(const char *s
, uid_t
* ret_uid
);
160 #define parse_gid(s, ret_gid) parse_uid(s, ret_gid)
162 bool uid_is_valid(uid_t uid
);
164 static inline bool gid_is_valid(gid_t gid
) {
165 return uid_is_valid((uid_t
) gid
);
168 int safe_atou(const char *s
, unsigned *ret_u
);
169 int safe_atoi(const char *s
, int *ret_i
);
171 int safe_atollu(const char *s
, unsigned long long *ret_u
);
172 int safe_atolli(const char *s
, long long int *ret_i
);
174 int safe_atod(const char *s
, double *ret_d
);
176 int safe_atou8(const char *s
, uint8_t *ret
);
178 #if LONG_MAX == INT_MAX
179 static inline int safe_atolu(const char *s
, unsigned long *ret_u
) {
180 assert_cc(sizeof(unsigned long) == sizeof(unsigned));
181 return safe_atou(s
, (unsigned*) ret_u
);
183 static inline int safe_atoli(const char *s
, long int *ret_u
) {
184 assert_cc(sizeof(long int) == sizeof(int));
185 return safe_atoi(s
, (int*) ret_u
);
188 static inline int safe_atolu(const char *s
, unsigned long *ret_u
) {
189 assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
190 return safe_atollu(s
, (unsigned long long*) ret_u
);
192 static inline int safe_atoli(const char *s
, long int *ret_u
) {
193 assert_cc(sizeof(long int) == sizeof(long long int));
194 return safe_atolli(s
, (long long int*) ret_u
);
198 static inline int safe_atou32(const char *s
, uint32_t *ret_u
) {
199 assert_cc(sizeof(uint32_t) == sizeof(unsigned));
200 return safe_atou(s
, (unsigned*) ret_u
);
203 static inline int safe_atoi32(const char *s
, int32_t *ret_i
) {
204 assert_cc(sizeof(int32_t) == sizeof(int));
205 return safe_atoi(s
, (int*) ret_i
);
208 static inline int safe_atou64(const char *s
, uint64_t *ret_u
) {
209 assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
210 return safe_atollu(s
, (unsigned long long*) ret_u
);
213 static inline int safe_atoi64(const char *s
, int64_t *ret_i
) {
214 assert_cc(sizeof(int64_t) == sizeof(long long int));
215 return safe_atolli(s
, (long long int*) ret_i
);
218 int safe_atou16(const char *s
, uint16_t *ret
);
219 int safe_atoi16(const char *s
, int16_t *ret
);
221 const char* split(const char **state
, size_t *l
, const char *separator
, bool quoted
);
223 #define FOREACH_WORD(word, length, s, state) \
224 _FOREACH_WORD(word, length, s, WHITESPACE, false, state)
226 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state) \
227 _FOREACH_WORD(word, length, s, separator, false, state)
229 #define FOREACH_WORD_QUOTED(word, length, s, state) \
230 _FOREACH_WORD(word, length, s, WHITESPACE, true, state)
232 #define _FOREACH_WORD(word, length, s, separator, quoted, state) \
233 for ((state) = (s), (word) = split(&(state), &(length), (separator), (quoted)); (word); (word) = split(&(state), &(length), (separator), (quoted)))
235 char *strappend(const char *s
, const char *suffix
);
236 char *strnappend(const char *s
, const char *suffix
, size_t length
);
238 int readlinkat_malloc(int fd
, const char *p
, char **ret
);
239 int readlink_malloc(const char *p
, char **r
);
240 int readlink_value(const char *p
, char **ret
);
241 int readlink_and_make_absolute(const char *p
, char **r
);
242 int readlink_and_canonicalize(const char *p
, char **r
);
244 char *strstrip(char *s
);
245 char *delete_chars(char *s
, const char *bad
);
246 char *truncate_nl(char *s
);
248 char *file_in_same_dir(const char *path
, const char *filename
);
250 int rmdir_parents(const char *path
, const char *stop
);
252 char hexchar(int x
) _const_
;
253 int unhexchar(char c
) _const_
;
254 char octchar(int x
) _const_
;
255 int unoctchar(char c
) _const_
;
256 char decchar(int x
) _const_
;
257 int undecchar(char c
) _const_
;
258 char base32hexchar(int x
) _const_
;
259 int unbase32hexchar(char c
) _const_
;
260 char base64char(int x
) _const_
;
261 int unbase64char(char c
) _const_
;
263 char *cescape(const char *s
);
264 size_t cescape_char(char c
, char *buf
);
266 typedef enum UnescapeFlags
{
270 int cunescape(const char *s
, UnescapeFlags flags
, char **ret
);
271 int cunescape_length(const char *s
, size_t length
, UnescapeFlags flags
, char **ret
);
272 int cunescape_length_with_prefix(const char *s
, size_t length
, const char *prefix
, UnescapeFlags flags
, char **ret
);
274 char *xescape(const char *s
, const char *bad
);
276 char *ascii_strlower(char *path
);
278 bool dirent_is_file(const struct dirent
*de
) _pure_
;
279 bool dirent_is_file_with_suffix(const struct dirent
*de
, const char *suffix
) _pure_
;
281 bool hidden_file(const char *filename
) _pure_
;
283 bool chars_intersect(const char *a
, const char *b
) _pure_
;
285 /* For basic lookup tables with strictly enumerated entries */
286 #define _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope) \
287 scope const char *name##_to_string(type i) { \
288 if (i < 0 || i >= (type) ELEMENTSOF(name##_table)) \
290 return name##_table[i]; \
293 ssize_t
string_table_lookup(const char * const *table
, size_t len
, const char *key
);
295 #define _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope) \
296 scope type name##_from_string(const char *s) { \
297 return (type) string_table_lookup(name##_table, ELEMENTSOF(name##_table), s); \
300 #define _DEFINE_STRING_TABLE_LOOKUP(name,type,scope) \
301 _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope) \
302 _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope) \
303 struct __useless_struct_to_allow_trailing_semicolon__
305 #define DEFINE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,)
306 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,static)
307 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_TO_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,static)
308 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_FROM_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,static)
310 /* For string conversions where numbers are also acceptable */
311 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max) \
312 int name##_to_string_alloc(type i, char **str) { \
314 if (i < 0 || i > max) \
316 if (i < (type) ELEMENTSOF(name##_table)) { \
317 s = strdup(name##_table[i]); \
321 if (asprintf(&s, "%i", i) < 0) \
327 type name##_from_string(const char *s) { \
332 for (i = 0; i < (type) ELEMENTSOF(name##_table); i++) \
333 if (streq_ptr(name##_table[i], s)) \
335 if (safe_atou(s, &u) >= 0 && u <= max) \
339 struct __useless_struct_to_allow_trailing_semicolon__
341 int fd_nonblock(int fd
, bool nonblock
);
342 int fd_cloexec(int fd
, bool cloexec
);
344 int close_all_fds(const int except
[], unsigned n_except
);
346 bool fstype_is_network(const char *fstype
);
348 int flush_fd(int fd
);
350 int fopen_temporary(const char *path
, FILE **_f
, char **_temp_path
);
352 ssize_t
loop_read(int fd
, void *buf
, size_t nbytes
, bool do_poll
);
353 int loop_read_exact(int fd
, void *buf
, size_t nbytes
, bool do_poll
);
354 int loop_write(int fd
, const void *buf
, size_t nbytes
, bool do_poll
);
356 bool is_device_path(const char *path
);
358 int dir_is_empty(const char *path
);
359 char* dirname_malloc(const char *path
);
361 char* lookup_uid(uid_t uid
);
362 char* getlogname_malloc(void);
363 char* getusername_malloc(void);
365 int chmod_and_chown(const char *path
, mode_t mode
, uid_t uid
, gid_t gid
);
366 int fchmod_and_fchown(int fd
, mode_t mode
, uid_t uid
, gid_t gid
);
368 bool is_temporary_fs(const struct statfs
*s
) _pure_
;
369 int fd_is_temporary_fs(int fd
);
371 int pipe_eof(int fd
);
373 #define xsprintf(buf, fmt, ...) \
374 assert_message_se((size_t) snprintf(buf, ELEMENTSOF(buf), fmt, __VA_ARGS__) < ELEMENTSOF(buf), \
375 "xsprintf: " #buf "[] must be big enough")
377 int files_same(const char *filea
, const char *fileb
);
379 int running_in_chroot(void);
381 char *ellipsize(const char *s
, size_t length
, unsigned percent
);
383 char *ellipsize_mem(const char *s
, size_t old_length
, size_t new_length
, unsigned percent
);
385 int touch_file(const char *path
, bool parents
, usec_t stamp
, uid_t uid
, gid_t gid
, mode_t mode
);
386 int touch(const char *path
);
388 noreturn
void freeze(void);
390 bool null_or_empty(struct stat
*st
) _pure_
;
391 int null_or_empty_path(const char *fn
);
392 int null_or_empty_fd(int fd
);
394 DIR *xopendirat(int dirfd
, const char *name
, int flags
);
396 char *fstab_node_to_udev_node(const char *p
);
398 void execute_directories(const char* const* directories
, usec_t timeout
, char *argv
[]);
400 bool nulstr_contains(const char*nulstr
, const char *needle
);
402 bool plymouth_running(void);
404 char* strshorten(char *s
, size_t l
);
406 int symlink_idempotent(const char *from
, const char *to
);
408 int symlink_atomic(const char *from
, const char *to
);
409 int mknod_atomic(const char *path
, mode_t mode
, dev_t dev
);
410 int mkfifo_atomic(const char *path
, mode_t mode
);
412 int fchmod_umask(int fd
, mode_t mode
);
414 bool display_is_local(const char *display
) _pure_
;
415 int socket_from_display(const char *display
, char **path
);
417 int get_user_creds(const char **username
, uid_t
*uid
, gid_t
*gid
, const char **home
, const char **shell
);
418 int get_group_creds(const char **groupname
, gid_t
*gid
);
420 int in_gid(gid_t gid
);
421 int in_group(const char *name
);
423 char* uid_to_name(uid_t uid
);
424 char* gid_to_name(gid_t gid
);
426 int glob_exists(const char *path
);
427 int glob_extend(char ***strv
, const char *path
);
429 int dirent_ensure_type(DIR *d
, struct dirent
*de
);
431 int get_files_in_directory(const char *path
, char ***list
);
433 char *strjoin(const char *x
, ...) _sentinel_
;
435 bool is_main_thread(void);
437 static inline bool _pure_
in_charset(const char *s
, const char* charset
) {
440 return s
[strspn(s
, charset
)] == '\0';
443 int block_get_whole_disk(dev_t d
, dev_t
*ret
);
445 #define NULSTR_FOREACH(i, l) \
446 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
448 #define NULSTR_FOREACH_PAIR(i, j, l) \
449 for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
451 int ioprio_class_to_string_alloc(int i
, char **s
);
452 int ioprio_class_from_string(const char *s
);
454 const char *sigchld_code_to_string(int i
) _const_
;
455 int sigchld_code_from_string(const char *s
) _pure_
;
457 int log_facility_unshifted_to_string_alloc(int i
, char **s
);
458 int log_facility_unshifted_from_string(const char *s
);
460 int log_level_to_string_alloc(int i
, char **s
);
461 int log_level_from_string(const char *s
);
463 int sched_policy_to_string_alloc(int i
, char **s
);
464 int sched_policy_from_string(const char *s
);
466 const char *rlimit_to_string(int i
) _const_
;
467 int rlimit_from_string(const char *s
) _pure_
;
469 int ip_tos_to_string_alloc(int i
, char **s
);
470 int ip_tos_from_string(const char *s
);
472 extern int saved_argc
;
473 extern char **saved_argv
;
475 bool kexec_loaded(void);
477 int prot_from_flags(int flags
) _const_
;
479 char *format_bytes(char *buf
, size_t l
, uint64_t t
);
481 int fd_wait_for_event(int fd
, int event
, usec_t timeout
);
483 void* memdup(const void *p
, size_t l
) _alloc_(2);
485 int fd_inc_sndbuf(int fd
, size_t n
);
486 int fd_inc_rcvbuf(int fd
, size_t n
);
488 int fork_agent(pid_t
*pid
, const int except
[], unsigned n_except
, const char *path
, ...);
490 int setrlimit_closest(int resource
, const struct rlimit
*rlim
);
492 bool http_url_is_valid(const char *url
) _pure_
;
493 bool documentation_url_is_valid(const char *url
) _pure_
;
495 bool http_etag_is_valid(const char *etag
);
497 bool in_initrd(void);
499 int get_home_dir(char **ret
);
500 int get_shell(char **_ret
);
502 static inline void freep(void *p
) {
506 static inline void closep(int *fd
) {
510 static inline void umaskp(mode_t
*u
) {
514 static inline void close_pairp(int (*p
)[2]) {
518 static inline void fclosep(FILE **f
) {
522 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, pclose
);
523 DEFINE_TRIVIAL_CLEANUP_FUNC(DIR*, closedir
);
524 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, endmntent
);
526 #define _cleanup_free_ _cleanup_(freep)
527 #define _cleanup_close_ _cleanup_(closep)
528 #define _cleanup_umask_ _cleanup_(umaskp)
529 #define _cleanup_globfree_ _cleanup_(globfree)
530 #define _cleanup_fclose_ _cleanup_(fclosep)
531 #define _cleanup_pclose_ _cleanup_(pclosep)
532 #define _cleanup_closedir_ _cleanup_(closedirp)
533 #define _cleanup_endmntent_ _cleanup_(endmntentp)
534 #define _cleanup_close_pair_ _cleanup_(close_pairp)
536 _malloc_
_alloc_(1, 2) static inline void *malloc_multiply(size_t a
, size_t b
) {
537 if (_unlikely_(b
!= 0 && a
> ((size_t) -1) / b
))
540 return malloc(a
* b
);
543 _alloc_(2, 3) static inline void *realloc_multiply(void *p
, size_t a
, size_t b
) {
544 if (_unlikely_(b
!= 0 && a
> ((size_t) -1) / b
))
547 return realloc(p
, a
* b
);
550 _alloc_(2, 3) static inline void *memdup_multiply(const void *p
, size_t a
, size_t b
) {
551 if (_unlikely_(b
!= 0 && a
> ((size_t) -1) / b
))
554 return memdup(p
, a
* b
);
557 bool filename_is_valid(const char *p
) _pure_
;
558 bool path_is_safe(const char *p
) _pure_
;
559 bool string_is_safe(const char *p
) _pure_
;
560 bool string_has_cc(const char *p
, const char *ok
) _pure_
;
563 * Check if a string contains any glob patterns.
565 _pure_
static inline bool string_is_glob(const char *p
) {
566 return !!strpbrk(p
, GLOB_CHARS
);
569 void *xbsearch_r(const void *key
, const void *base
, size_t nmemb
, size_t size
,
570 int (*compar
) (const void *, const void *, void *),
573 #define _(String) gettext (String)
574 #define N_(String) String
575 void init_gettext(void);
576 bool is_locale_utf8(void);
578 typedef enum DrawSpecialChar
{
583 DRAW_TRIANGULAR_BULLET
,
587 _DRAW_SPECIAL_CHAR_MAX
590 const char *draw_special_char(DrawSpecialChar ch
);
592 char *strreplace(const char *text
, const char *old_string
, const char *new_string
);
594 char *strip_tab_ansi(char **p
, size_t *l
);
596 int on_ac_power(void);
598 int search_and_fopen(const char *path
, const char *mode
, const char *root
, const char **search
, FILE **_f
);
599 int search_and_fopen_nulstr(const char *path
, const char *mode
, const char *root
, const char *search
, FILE **_f
);
601 #define FOREACH_LINE(line, f, on_error) \
603 if (!fgets(line, sizeof(line), f)) { \
610 #define FOREACH_DIRENT(de, d, on_error) \
611 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
617 } else if (hidden_file((de)->d_name)) \
621 #define FOREACH_DIRENT_ALL(de, d, on_error) \
622 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
630 static inline void *mempset(void *s
, int c
, size_t n
) {
632 return (uint8_t*)s
+ n
;
635 char *hexmem(const void *p
, size_t l
);
636 int unhexmem(const char *p
, size_t l
, void **mem
, size_t *len
);
638 char *base32hexmem(const void *p
, size_t l
, bool padding
);
639 int unbase32hexmem(const char *p
, size_t l
, bool padding
, void **mem
, size_t *len
);
641 char *base64mem(const void *p
, size_t l
);
642 int unbase64mem(const char *p
, size_t l
, void **mem
, size_t *len
);
644 char *strextend(char **x
, ...) _sentinel_
;
645 char *strrep(const char *s
, unsigned n
);
647 void* greedy_realloc(void **p
, size_t *allocated
, size_t need
, size_t size
);
648 void* greedy_realloc0(void **p
, size_t *allocated
, size_t need
, size_t size
);
649 #define GREEDY_REALLOC(array, allocated, need) \
650 greedy_realloc((void**) &(array), &(allocated), (need), sizeof((array)[0]))
652 #define GREEDY_REALLOC0(array, allocated, need) \
653 greedy_realloc0((void**) &(array), &(allocated), (need), sizeof((array)[0]))
655 static inline void _reset_errno_(int *saved_errno
) {
656 errno
= *saved_errno
;
659 #define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
661 static inline int negative_errno(void) {
662 /* This helper should be used to shut up gcc if you know 'errno' is
663 * negative. Instead of "return -errno;", use "return negative_errno();"
664 * It will suppress bogus gcc warnings in case it assumes 'errno' might
665 * be 0 and thus the caller's error-handling might not be triggered. */
666 assert_return(errno
> 0, -EINVAL
);
670 struct _umask_struct_
{
675 static inline void _reset_umask_(struct _umask_struct_
*s
) {
679 #define RUN_WITH_UMASK(mask) \
680 for (_cleanup_(_reset_umask_) struct _umask_struct_ _saved_umask_ = { umask(mask), false }; \
681 !_saved_umask_.quit ; \
682 _saved_umask_.quit = true)
684 static inline unsigned u64log2(uint64_t n
) {
685 #if __SIZEOF_LONG_LONG__ == 8
686 return (n
> 1) ? (unsigned) __builtin_clzll(n
) ^ 63U : 0;
692 static inline unsigned u32ctz(uint32_t n
) {
693 #if __SIZEOF_INT__ == 4
694 return __builtin_ctz(n
);
700 static inline unsigned log2i(int x
) {
703 return __SIZEOF_INT__
* 8 - __builtin_clz(x
) - 1;
706 static inline unsigned log2u(unsigned x
) {
709 return sizeof(unsigned) * 8 - __builtin_clz(x
) - 1;
712 static inline unsigned log2u_round_up(unsigned x
) {
718 return log2u(x
- 1) + 1;
721 static inline bool logind_running(void) {
722 return access("/run/systemd/seats/", F_OK
) >= 0;
725 #define DECIMAL_STR_WIDTH(x) \
727 typeof(x) _x_ = (x); \
734 int unlink_noerrno(const char *path
);
740 _new_ = alloca(_len_); \
741 (void *) memset(_new_, 0, _len_); \
744 /* It's not clear what alignment glibc/gcc alloca() guarantee, hence provide a guaranteed safe version */
745 #define alloca_align(size, align) \
748 size_t _mask_ = (align) - 1; \
749 _ptr_ = alloca((size) + _mask_); \
750 (void*)(((uintptr_t)_ptr_ + _mask_) & ~_mask_); \
753 #define alloca0_align(size, align) \
756 size_t _size_ = (size); \
757 _new_ = alloca_align(_size_, (align)); \
758 (void*)memset(_new_, 0, _size_); \
761 #define strjoina(a, ...) \
763 const char *_appendees_[] = { a, __VA_ARGS__ }; \
767 for (_i_ = 0; _i_ < ELEMENTSOF(_appendees_) && _appendees_[_i_]; _i_++) \
768 _len_ += strlen(_appendees_[_i_]); \
769 _p_ = _d_ = alloca(_len_ + 1); \
770 for (_i_ = 0; _i_ < ELEMENTSOF(_appendees_) && _appendees_[_i_]; _i_++) \
771 _p_ = stpcpy(_p_, _appendees_[_i_]); \
776 bool id128_is_valid(const char *s
) _pure_
;
778 int split_pair(const char *s
, const char *sep
, char **l
, char **r
);
780 int shall_restore_state(void);
783 * Normal qsort requires base to be nonnull. Here were require
784 * that only if nmemb > 0.
786 static inline void qsort_safe(void *base
, size_t nmemb
, size_t size
, comparison_fn_t compar
) {
791 qsort(base
, nmemb
, size
, compar
);
794 /* Normal memmem() requires haystack to be nonnull, which is annoying for zero-length buffers */
795 static inline void *memmem_safe(const void *haystack
, size_t haystacklen
, const void *needle
, size_t needlelen
) {
798 return (void*) haystack
;
800 if (haystacklen
< needlelen
)
806 return memmem(haystack
, haystacklen
, needle
, needlelen
);
809 int proc_cmdline(char **ret
);
810 int parse_proc_cmdline(int (*parse_word
)(const char *key
, const char *value
));
811 int get_proc_cmdline_key(const char *parameter
, char **value
);
813 int container_get_leader(const char *machine
, pid_t
*pid
);
815 int namespace_open(pid_t pid
, int *pidns_fd
, int *mntns_fd
, int *netns_fd
, int *userns_fd
, int *root_fd
);
816 int namespace_enter(int pidns_fd
, int mntns_fd
, int netns_fd
, int userns_fd
, int root_fd
);
818 int getpeercred(int fd
, struct ucred
*ucred
);
819 int getpeersec(int fd
, char **ret
);
821 int writev_safe(int fd
, const struct iovec
*w
, int j
);
823 int mkostemp_safe(char *pattern
, int flags
);
824 int open_tmpfile(const char *path
, int flags
);
826 int fd_warn_permissions(const char *path
, int fd
);
828 #ifndef PERSONALITY_INVALID
829 /* personality(7) documents that 0xffffffffUL is used for querying the
830 * current personality, hence let's use that here as error
832 #define PERSONALITY_INVALID 0xffffffffLU
835 unsigned long personality_from_string(const char *p
);
836 const char *personality_to_string(unsigned long);
838 uint64_t physical_memory(void);
840 void hexdump(FILE *f
, const void *p
, size_t s
);
842 union file_handle_union
{
843 struct file_handle handle
;
844 char padding
[sizeof(struct file_handle
) + MAX_HANDLE_SZ
];
846 #define FILE_HANDLE_INIT { .handle.handle_bytes = MAX_HANDLE_SZ }
848 int update_reboot_param_file(const char *param
);
850 int umount_recursive(const char *target
, int flags
);
852 int bind_remount_recursive(const char *prefix
, bool ro
);
854 int fflush_and_check(FILE *f
);
856 int tempfn_xxxxxx(const char *p
, const char *extra
, char **ret
);
857 int tempfn_random(const char *p
, const char *extra
, char **ret
);
858 int tempfn_random_child(const char *p
, const char *extra
, char **ret
);
860 int take_password_lock(const char *root
);
862 int is_symlink(const char *path
);
863 int is_dir(const char *path
, bool follow
);
864 int is_device_node(const char *path
);
866 typedef enum ExtractFlags
{
868 EXTRACT_CUNESCAPE
= 2,
869 EXTRACT_CUNESCAPE_RELAX
= 4,
871 EXTRACT_DONT_COALESCE_SEPARATORS
= 16,
874 int extract_first_word(const char **p
, char **ret
, const char *separators
, ExtractFlags flags
);
875 int extract_first_word_and_warn(const char **p
, char **ret
, const char *separators
, ExtractFlags flags
, const char *unit
, const char *filename
, unsigned line
, const char *rvalue
);
876 int extract_many_words(const char **p
, const char *separators
, ExtractFlags flags
, ...) _sentinel_
;
878 int free_and_strdup(char **p
, const char *s
);
880 #define INOTIFY_EVENT_MAX (sizeof(struct inotify_event) + NAME_MAX + 1)
882 #define FOREACH_INOTIFY_EVENT(e, buffer, sz) \
883 for ((e) = &buffer.ev; \
884 (uint8_t*) (e) < (uint8_t*) (buffer.raw) + (sz); \
885 (e) = (struct inotify_event*) ((uint8_t*) (e) + sizeof(struct inotify_event) + (e)->len))
887 union inotify_event_buffer
{
888 struct inotify_event ev
;
889 uint8_t raw
[INOTIFY_EVENT_MAX
];
892 #define laccess(path, mode) faccessat(AT_FDCWD, (path), (mode), AT_SYMLINK_NOFOLLOW)
894 int ptsname_malloc(int fd
, char **ret
);
896 int openpt_in_namespace(pid_t pid
, int flags
);
898 ssize_t
fgetxattrat_fake(int dirfd
, const char *filename
, const char *attribute
, void *value
, size_t size
, int flags
);
900 int fd_setcrtime(int fd
, usec_t usec
);
901 int fd_getcrtime(int fd
, usec_t
*usec
);
902 int path_getcrtime(const char *p
, usec_t
*usec
);
903 int fd_getcrtime_at(int dirfd
, const char *name
, usec_t
*usec
, int flags
);
905 int same_fd(int a
, int b
);
907 int chattr_fd(int fd
, unsigned value
, unsigned mask
);
908 int chattr_path(const char *p
, unsigned value
, unsigned mask
);
910 int read_attr_fd(int fd
, unsigned *ret
);
911 int read_attr_path(const char *p
, unsigned *ret
);
913 #define RLIMIT_MAKE_CONST(lim) ((struct rlimit) { lim, lim })
915 ssize_t
sparse_write(int fd
, const void *p
, size_t sz
, size_t run_length
);
917 void sigkill_wait(pid_t
*pid
);
918 #define _cleanup_sigkill_wait_ _cleanup_(sigkill_wait)
920 int syslog_parse_priority(const char **p
, int *priority
, bool with_facility
);
922 void cmsg_close_all(struct msghdr
*mh
);
924 int rename_noreplace(int olddirfd
, const char *oldpath
, int newdirfd
, const char *newpath
);
926 char *shell_escape(const char *s
, const char *bad
);
927 char *shell_maybe_quote(const char *s
);
929 int parse_mode(const char *s
, mode_t
*ret
);
931 int mount_move_root(const char *path
);
933 int reset_uid_gid(void);
935 int getxattr_malloc(const char *path
, const char *name
, char **value
, bool allow_symlink
);
936 int fgetxattr_malloc(int fd
, const char *name
, char **value
);
938 int send_one_fd(int transport_fd
, int fd
, int flags
);
939 int receive_one_fd(int transport_fd
, int flags
);
941 void nop_signal_handler(int sig
);