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 #define FORMAT_BYTES_MAX 8
58 size_t page_size(void) _pure_
;
59 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
61 #define new(t, n) ((t*) malloc_multiply(sizeof(t), (n)))
63 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
65 #define newa(t, n) ((t*) alloca(sizeof(t)*(n)))
67 #define newa0(t, n) ((t*) alloca0(sizeof(t)*(n)))
69 #define newdup(t, p, n) ((t*) memdup_multiply(p, sizeof(t), (n)))
71 #define malloc0(n) (calloc(1, (n)))
73 static inline void *mfree(void *memory
) {
78 static inline const char* yes_no(bool b
) {
79 return b
? "yes" : "no";
82 static inline const char* true_false(bool b
) {
83 return b
? "true" : "false";
86 static inline const char* one_zero(bool b
) {
90 int parse_size(const char *t
, uint64_t base
, uint64_t *size
);
92 int parse_boolean(const char *v
) _pure_
;
93 int parse_pid(const char *s
, pid_t
* ret_pid
);
96 int safe_atou(const char *s
, unsigned *ret_u
);
97 int safe_atoi(const char *s
, int *ret_i
);
99 int safe_atollu(const char *s
, unsigned long long *ret_u
);
100 int safe_atolli(const char *s
, long long int *ret_i
);
102 int safe_atod(const char *s
, double *ret_d
);
104 int safe_atou8(const char *s
, uint8_t *ret
);
106 #if LONG_MAX == INT_MAX
107 static inline int safe_atolu(const char *s
, unsigned long *ret_u
) {
108 assert_cc(sizeof(unsigned long) == sizeof(unsigned));
109 return safe_atou(s
, (unsigned*) ret_u
);
111 static inline int safe_atoli(const char *s
, long int *ret_u
) {
112 assert_cc(sizeof(long int) == sizeof(int));
113 return safe_atoi(s
, (int*) ret_u
);
116 static inline int safe_atolu(const char *s
, unsigned long *ret_u
) {
117 assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
118 return safe_atollu(s
, (unsigned long long*) ret_u
);
120 static inline int safe_atoli(const char *s
, long int *ret_u
) {
121 assert_cc(sizeof(long int) == sizeof(long long int));
122 return safe_atolli(s
, (long long int*) ret_u
);
126 static inline int safe_atou32(const char *s
, uint32_t *ret_u
) {
127 assert_cc(sizeof(uint32_t) == sizeof(unsigned));
128 return safe_atou(s
, (unsigned*) ret_u
);
131 static inline int safe_atoi32(const char *s
, int32_t *ret_i
) {
132 assert_cc(sizeof(int32_t) == sizeof(int));
133 return safe_atoi(s
, (int*) ret_i
);
136 static inline int safe_atou64(const char *s
, uint64_t *ret_u
) {
137 assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
138 return safe_atollu(s
, (unsigned long long*) ret_u
);
141 static inline int safe_atoi64(const char *s
, int64_t *ret_i
) {
142 assert_cc(sizeof(int64_t) == sizeof(long long int));
143 return safe_atolli(s
, (long long int*) ret_i
);
146 int safe_atou16(const char *s
, uint16_t *ret
);
147 int safe_atoi16(const char *s
, int16_t *ret
);
149 int readlinkat_malloc(int fd
, const char *p
, char **ret
);
150 int readlink_malloc(const char *p
, char **r
);
151 int readlink_value(const char *p
, char **ret
);
152 int readlink_and_make_absolute(const char *p
, char **r
);
153 int readlink_and_canonicalize(const char *p
, char **r
);
155 char *file_in_same_dir(const char *path
, const char *filename
);
157 int rmdir_parents(const char *path
, const char *stop
);
159 char hexchar(int x
) _const_
;
160 int unhexchar(char c
) _const_
;
161 char octchar(int x
) _const_
;
162 int unoctchar(char c
) _const_
;
163 char decchar(int x
) _const_
;
164 int undecchar(char c
) _const_
;
165 char base32hexchar(int x
) _const_
;
166 int unbase32hexchar(char c
) _const_
;
167 char base64char(int x
) _const_
;
168 int unbase64char(char c
) _const_
;
170 bool dirent_is_file(const struct dirent
*de
) _pure_
;
171 bool dirent_is_file_with_suffix(const struct dirent
*de
, const char *suffix
) _pure_
;
173 bool hidden_file(const char *filename
) _pure_
;
175 /* For basic lookup tables with strictly enumerated entries */
176 #define _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope) \
177 scope const char *name##_to_string(type i) { \
178 if (i < 0 || i >= (type) ELEMENTSOF(name##_table)) \
180 return name##_table[i]; \
183 ssize_t
string_table_lookup(const char * const *table
, size_t len
, const char *key
);
185 #define _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope) \
186 scope type name##_from_string(const char *s) { \
187 return (type) string_table_lookup(name##_table, ELEMENTSOF(name##_table), s); \
190 #define _DEFINE_STRING_TABLE_LOOKUP(name,type,scope) \
191 _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope) \
192 _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope) \
193 struct __useless_struct_to_allow_trailing_semicolon__
195 #define DEFINE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,)
196 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,static)
197 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_TO_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,static)
198 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_FROM_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,static)
200 /* For string conversions where numbers are also acceptable */
201 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max) \
202 int name##_to_string_alloc(type i, char **str) { \
204 if (i < 0 || i > max) \
206 if (i < (type) ELEMENTSOF(name##_table)) { \
207 s = strdup(name##_table[i]); \
211 if (asprintf(&s, "%i", i) < 0) \
217 type name##_from_string(const char *s) { \
222 for (i = 0; i < (type) ELEMENTSOF(name##_table); i++) \
223 if (streq_ptr(name##_table[i], s)) \
225 if (safe_atou(s, &u) >= 0 && u <= max) \
229 struct __useless_struct_to_allow_trailing_semicolon__
231 bool fstype_is_network(const char *fstype
);
233 int fopen_temporary(const char *path
, FILE **_f
, char **_temp_path
);
235 bool is_device_path(const char *path
);
237 int dir_is_empty(const char *path
);
238 char* dirname_malloc(const char *path
);
240 static inline int dir_is_populated(const char *path
) {
242 r
= dir_is_empty(path
);
248 int chmod_and_chown(const char *path
, mode_t mode
, uid_t uid
, gid_t gid
);
249 int fchmod_and_fchown(int fd
, mode_t mode
, uid_t uid
, gid_t gid
);
251 typedef long statfs_f_type_t
;
253 bool is_fs_type(const struct statfs
*s
, statfs_f_type_t magic_value
) _pure_
;
254 int fd_check_fstype(int fd
, statfs_f_type_t magic_value
);
255 int path_check_fstype(const char *path
, statfs_f_type_t magic_value
);
257 bool is_temporary_fs(const struct statfs
*s
) _pure_
;
258 int fd_is_temporary_fs(int fd
);
260 #define xsprintf(buf, fmt, ...) \
261 assert_message_se((size_t) snprintf(buf, ELEMENTSOF(buf), fmt, __VA_ARGS__) < ELEMENTSOF(buf), \
262 "xsprintf: " #buf "[] must be big enough")
264 int files_same(const char *filea
, const char *fileb
);
266 int running_in_chroot(void);
268 int touch_file(const char *path
, bool parents
, usec_t stamp
, uid_t uid
, gid_t gid
, mode_t mode
);
269 int touch(const char *path
);
271 noreturn
void freeze(void);
273 bool null_or_empty(struct stat
*st
) _pure_
;
274 int null_or_empty_path(const char *fn
);
275 int null_or_empty_fd(int fd
);
277 DIR *xopendirat(int dirfd
, const char *name
, int flags
);
279 char *fstab_node_to_udev_node(const char *p
);
281 void execute_directories(const char* const* directories
, usec_t timeout
, char *argv
[]);
283 bool plymouth_running(void);
285 int symlink_idempotent(const char *from
, const char *to
);
287 int symlink_atomic(const char *from
, const char *to
);
288 int mknod_atomic(const char *path
, mode_t mode
, dev_t dev
);
289 int mkfifo_atomic(const char *path
, mode_t mode
);
291 int fchmod_umask(int fd
, mode_t mode
);
293 bool display_is_local(const char *display
) _pure_
;
294 int socket_from_display(const char *display
, char **path
);
296 int glob_exists(const char *path
);
297 int glob_extend(char ***strv
, const char *path
);
299 int dirent_ensure_type(DIR *d
, struct dirent
*de
);
301 int get_files_in_directory(const char *path
, char ***list
);
303 bool is_main_thread(void);
305 int block_get_whole_disk(dev_t d
, dev_t
*ret
);
307 #define NULSTR_FOREACH(i, l) \
308 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
310 #define NULSTR_FOREACH_PAIR(i, j, l) \
311 for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
313 int ioprio_class_to_string_alloc(int i
, char **s
);
314 int ioprio_class_from_string(const char *s
);
316 const char *sigchld_code_to_string(int i
) _const_
;
317 int sigchld_code_from_string(const char *s
) _pure_
;
319 int log_facility_unshifted_to_string_alloc(int i
, char **s
);
320 int log_facility_unshifted_from_string(const char *s
);
321 bool log_facility_unshifted_is_valid(int faciliy
);
323 int log_level_to_string_alloc(int i
, char **s
);
324 int log_level_from_string(const char *s
);
325 bool log_level_is_valid(int level
);
327 int sched_policy_to_string_alloc(int i
, char **s
);
328 int sched_policy_from_string(const char *s
);
330 const char *rlimit_to_string(int i
) _const_
;
331 int rlimit_from_string(const char *s
) _pure_
;
333 int ip_tos_to_string_alloc(int i
, char **s
);
334 int ip_tos_from_string(const char *s
);
336 extern int saved_argc
;
337 extern char **saved_argv
;
339 bool kexec_loaded(void);
341 int prot_from_flags(int flags
) _const_
;
343 char *format_bytes(char *buf
, size_t l
, uint64_t t
);
345 void* memdup(const void *p
, size_t l
) _alloc_(2);
347 int fd_inc_sndbuf(int fd
, size_t n
);
348 int fd_inc_rcvbuf(int fd
, size_t n
);
350 int fork_agent(pid_t
*pid
, const int except
[], unsigned n_except
, const char *path
, ...);
352 int setrlimit_closest(int resource
, const struct rlimit
*rlim
);
354 bool http_url_is_valid(const char *url
) _pure_
;
355 bool documentation_url_is_valid(const char *url
) _pure_
;
357 bool http_etag_is_valid(const char *etag
);
359 bool in_initrd(void);
361 static inline void freep(void *p
) {
365 static inline void umaskp(mode_t
*u
) {
369 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, endmntent
);
371 #define _cleanup_free_ _cleanup_(freep)
372 #define _cleanup_umask_ _cleanup_(umaskp)
373 #define _cleanup_globfree_ _cleanup_(globfree)
374 #define _cleanup_endmntent_ _cleanup_(endmntentp)
376 _malloc_
_alloc_(1, 2) static inline void *malloc_multiply(size_t a
, size_t b
) {
377 if (_unlikely_(b
!= 0 && a
> ((size_t) -1) / b
))
380 return malloc(a
* b
);
383 _alloc_(2, 3) static inline void *realloc_multiply(void *p
, size_t a
, size_t b
) {
384 if (_unlikely_(b
!= 0 && a
> ((size_t) -1) / b
))
387 return realloc(p
, a
* b
);
390 _alloc_(2, 3) static inline void *memdup_multiply(const void *p
, size_t a
, size_t b
) {
391 if (_unlikely_(b
!= 0 && a
> ((size_t) -1) / b
))
394 return memdup(p
, a
* b
);
397 bool filename_is_valid(const char *p
) _pure_
;
398 bool path_is_safe(const char *p
) _pure_
;
399 bool string_is_safe(const char *p
) _pure_
;
402 * Check if a string contains any glob patterns.
404 _pure_
static inline bool string_is_glob(const char *p
) {
405 return !!strpbrk(p
, GLOB_CHARS
);
408 void *xbsearch_r(const void *key
, const void *base
, size_t nmemb
, size_t size
,
409 int (*compar
) (const void *, const void *, void *),
412 #define _(String) gettext (String)
413 #define N_(String) String
414 void init_gettext(void);
415 bool is_locale_utf8(void);
417 typedef enum DrawSpecialChar
{
422 DRAW_TRIANGULAR_BULLET
,
426 _DRAW_SPECIAL_CHAR_MAX
429 const char *draw_special_char(DrawSpecialChar ch
);
431 int on_ac_power(void);
433 int search_and_fopen(const char *path
, const char *mode
, const char *root
, const char **search
, FILE **_f
);
434 int search_and_fopen_nulstr(const char *path
, const char *mode
, const char *root
, const char *search
, FILE **_f
);
436 #define FOREACH_LINE(line, f, on_error) \
438 if (!fgets(line, sizeof(line), f)) { \
445 #define FOREACH_DIRENT(de, d, on_error) \
446 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
452 } else if (hidden_file((de)->d_name)) \
456 #define FOREACH_DIRENT_ALL(de, d, on_error) \
457 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
465 static inline void *mempset(void *s
, int c
, size_t n
) {
467 return (uint8_t*)s
+ n
;
470 char *hexmem(const void *p
, size_t l
);
471 int unhexmem(const char *p
, size_t l
, void **mem
, size_t *len
);
473 char *base32hexmem(const void *p
, size_t l
, bool padding
);
474 int unbase32hexmem(const char *p
, size_t l
, bool padding
, void **mem
, size_t *len
);
476 char *base64mem(const void *p
, size_t l
);
477 int unbase64mem(const char *p
, size_t l
, void **mem
, size_t *len
);
479 void* greedy_realloc(void **p
, size_t *allocated
, size_t need
, size_t size
);
480 void* greedy_realloc0(void **p
, size_t *allocated
, size_t need
, size_t size
);
481 #define GREEDY_REALLOC(array, allocated, need) \
482 greedy_realloc((void**) &(array), &(allocated), (need), sizeof((array)[0]))
484 #define GREEDY_REALLOC0(array, allocated, need) \
485 greedy_realloc0((void**) &(array), &(allocated), (need), sizeof((array)[0]))
487 static inline void _reset_errno_(int *saved_errno
) {
488 errno
= *saved_errno
;
491 #define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
493 static inline int negative_errno(void) {
494 /* This helper should be used to shut up gcc if you know 'errno' is
495 * negative. Instead of "return -errno;", use "return negative_errno();"
496 * It will suppress bogus gcc warnings in case it assumes 'errno' might
497 * be 0 and thus the caller's error-handling might not be triggered. */
498 assert_return(errno
> 0, -EINVAL
);
502 struct _umask_struct_
{
507 static inline void _reset_umask_(struct _umask_struct_
*s
) {
511 #define RUN_WITH_UMASK(mask) \
512 for (_cleanup_(_reset_umask_) struct _umask_struct_ _saved_umask_ = { umask(mask), false }; \
513 !_saved_umask_.quit ; \
514 _saved_umask_.quit = true)
516 static inline unsigned u64log2(uint64_t n
) {
517 #if __SIZEOF_LONG_LONG__ == 8
518 return (n
> 1) ? (unsigned) __builtin_clzll(n
) ^ 63U : 0;
524 static inline unsigned u32ctz(uint32_t n
) {
525 #if __SIZEOF_INT__ == 4
526 return __builtin_ctz(n
);
532 static inline unsigned log2i(int x
) {
535 return __SIZEOF_INT__
* 8 - __builtin_clz(x
) - 1;
538 static inline unsigned log2u(unsigned x
) {
541 return sizeof(unsigned) * 8 - __builtin_clz(x
) - 1;
544 static inline unsigned log2u_round_up(unsigned x
) {
550 return log2u(x
- 1) + 1;
553 #define DECIMAL_STR_WIDTH(x) \
555 typeof(x) _x_ = (x); \
562 int unlink_noerrno(const char *path
);
568 _new_ = alloca(_len_); \
569 (void *) memset(_new_, 0, _len_); \
572 /* It's not clear what alignment glibc/gcc alloca() guarantee, hence provide a guaranteed safe version */
573 #define alloca_align(size, align) \
576 size_t _mask_ = (align) - 1; \
577 _ptr_ = alloca((size) + _mask_); \
578 (void*)(((uintptr_t)_ptr_ + _mask_) & ~_mask_); \
581 #define alloca0_align(size, align) \
584 size_t _size_ = (size); \
585 _new_ = alloca_align(_size_, (align)); \
586 (void*)memset(_new_, 0, _size_); \
589 bool id128_is_valid(const char *s
) _pure_
;
591 int shall_restore_state(void);
594 * Normal qsort requires base to be nonnull. Here were require
595 * that only if nmemb > 0.
597 static inline void qsort_safe(void *base
, size_t nmemb
, size_t size
, comparison_fn_t compar
) {
602 qsort(base
, nmemb
, size
, compar
);
605 int proc_cmdline(char **ret
);
606 int parse_proc_cmdline(int (*parse_word
)(const char *key
, const char *value
));
607 int get_proc_cmdline_key(const char *parameter
, char **value
);
609 int container_get_leader(const char *machine
, pid_t
*pid
);
611 int namespace_open(pid_t pid
, int *pidns_fd
, int *mntns_fd
, int *netns_fd
, int *userns_fd
, int *root_fd
);
612 int namespace_enter(int pidns_fd
, int mntns_fd
, int netns_fd
, int userns_fd
, int root_fd
);
614 int getpeercred(int fd
, struct ucred
*ucred
);
615 int getpeersec(int fd
, char **ret
);
617 int mkostemp_safe(char *pattern
, int flags
);
618 int open_tmpfile(const char *path
, int flags
);
620 int fd_warn_permissions(const char *path
, int fd
);
622 #ifndef PERSONALITY_INVALID
623 /* personality(7) documents that 0xffffffffUL is used for querying the
624 * current personality, hence let's use that here as error
626 #define PERSONALITY_INVALID 0xffffffffLU
629 unsigned long personality_from_string(const char *p
);
630 const char *personality_to_string(unsigned long);
632 uint64_t physical_memory(void);
634 void hexdump(FILE *f
, const void *p
, size_t s
);
636 union file_handle_union
{
637 struct file_handle handle
;
638 char padding
[sizeof(struct file_handle
) + MAX_HANDLE_SZ
];
640 #define FILE_HANDLE_INIT { .handle.handle_bytes = MAX_HANDLE_SZ }
642 int update_reboot_param_file(const char *param
);
644 int umount_recursive(const char *target
, int flags
);
646 int bind_remount_recursive(const char *prefix
, bool ro
);
648 int fflush_and_check(FILE *f
);
650 int tempfn_xxxxxx(const char *p
, const char *extra
, char **ret
);
651 int tempfn_random(const char *p
, const char *extra
, char **ret
);
652 int tempfn_random_child(const char *p
, const char *extra
, char **ret
);
654 int take_password_lock(const char *root
);
656 int is_symlink(const char *path
);
657 int is_dir(const char *path
, bool follow
);
658 int is_device_node(const char *path
);
660 #define INOTIFY_EVENT_MAX (sizeof(struct inotify_event) + NAME_MAX + 1)
662 #define FOREACH_INOTIFY_EVENT(e, buffer, sz) \
663 for ((e) = &buffer.ev; \
664 (uint8_t*) (e) < (uint8_t*) (buffer.raw) + (sz); \
665 (e) = (struct inotify_event*) ((uint8_t*) (e) + sizeof(struct inotify_event) + (e)->len))
667 union inotify_event_buffer
{
668 struct inotify_event ev
;
669 uint8_t raw
[INOTIFY_EVENT_MAX
];
672 #define laccess(path, mode) faccessat(AT_FDCWD, (path), (mode), AT_SYMLINK_NOFOLLOW)
674 ssize_t
fgetxattrat_fake(int dirfd
, const char *filename
, const char *attribute
, void *value
, size_t size
, int flags
);
676 int fd_setcrtime(int fd
, usec_t usec
);
677 int fd_getcrtime(int fd
, usec_t
*usec
);
678 int path_getcrtime(const char *p
, usec_t
*usec
);
679 int fd_getcrtime_at(int dirfd
, const char *name
, usec_t
*usec
, int flags
);
681 int chattr_fd(int fd
, unsigned value
, unsigned mask
);
682 int chattr_path(const char *p
, unsigned value
, unsigned mask
);
684 int read_attr_fd(int fd
, unsigned *ret
);
685 int read_attr_path(const char *p
, unsigned *ret
);
687 #define RLIMIT_MAKE_CONST(lim) ((struct rlimit) { lim, lim })
689 void sigkill_wait(pid_t
*pid
);
690 #define _cleanup_sigkill_wait_ _cleanup_(sigkill_wait)
692 int syslog_parse_priority(const char **p
, int *priority
, bool with_facility
);
694 int rename_noreplace(int olddirfd
, const char *oldpath
, int newdirfd
, const char *newpath
);
696 int parse_mode(const char *s
, mode_t
*ret
);
698 int mount_move_root(const char *path
);
700 int getxattr_malloc(const char *path
, const char *name
, char **value
, bool allow_symlink
);
701 int fgetxattr_malloc(int fd
, const char *name
, char **value
);
703 int send_one_fd(int transport_fd
, int fd
, int flags
);
704 int receive_one_fd(int transport_fd
, int flags
);
706 void nop_signal_handler(int sig
);
710 bool fdname_is_valid(const char *s
);
712 bool oom_score_adjust_is_valid(int oa
);