]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/basic/util.h
util-lib: split string parsing related calls from util.[ch] into parse-util.[ch]
[thirdparty/systemd.git] / src / basic / util.h
1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
2
3 #pragma once
4
5 /***
6 This file is part of systemd.
7
8 Copyright 2010 Lennart Poettering
9
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.
14
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.
19
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/>.
22 ***/
23
24 #include <alloca.h>
25 #include <dirent.h>
26 #include <fcntl.h>
27 #include <inttypes.h>
28 #include <limits.h>
29 #include <locale.h>
30 #include <mntent.h>
31 #include <stdarg.h>
32 #include <stdbool.h>
33 #include <stddef.h>
34 #include <stdio.h>
35 #include <stdlib.h>
36 #include <sys/inotify.h>
37 #include <sys/socket.h>
38 #include <sys/stat.h>
39 #include <sys/statfs.h>
40 #include <sys/types.h>
41 #include <time.h>
42 #include <unistd.h>
43
44 #include "formats-util.h"
45 #include "macro.h"
46 #include "missing.h"
47 #include "time-util.h"
48
49 /* What is interpreted as whitespace? */
50 #define WHITESPACE " \t\n\r"
51 #define NEWLINE "\n\r"
52 #define QUOTES "\"\'"
53 #define COMMENTS "#;"
54 #define GLOB_CHARS "*?["
55
56 size_t page_size(void) _pure_;
57 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
58
59 #define new(t, n) ((t*) malloc_multiply(sizeof(t), (n)))
60
61 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
62
63 #define newa(t, n) ((t*) alloca(sizeof(t)*(n)))
64
65 #define newa0(t, n) ((t*) alloca0(sizeof(t)*(n)))
66
67 #define newdup(t, p, n) ((t*) memdup_multiply(p, sizeof(t), (n)))
68
69 #define malloc0(n) (calloc(1, (n)))
70
71 static inline void *mfree(void *memory) {
72 free(memory);
73 return NULL;
74 }
75
76 static inline const char* yes_no(bool b) {
77 return b ? "yes" : "no";
78 }
79
80 static inline const char* true_false(bool b) {
81 return b ? "true" : "false";
82 }
83
84 static inline const char* one_zero(bool b) {
85 return b ? "1" : "0";
86 }
87
88 int readlinkat_malloc(int fd, const char *p, char **ret);
89 int readlink_malloc(const char *p, char **r);
90 int readlink_value(const char *p, char **ret);
91 int readlink_and_make_absolute(const char *p, char **r);
92 int readlink_and_canonicalize(const char *p, char **r);
93
94 char *file_in_same_dir(const char *path, const char *filename);
95
96 int rmdir_parents(const char *path, const char *stop);
97
98 char hexchar(int x) _const_;
99 int unhexchar(char c) _const_;
100 char octchar(int x) _const_;
101 int unoctchar(char c) _const_;
102 char decchar(int x) _const_;
103 int undecchar(char c) _const_;
104 char base32hexchar(int x) _const_;
105 int unbase32hexchar(char c) _const_;
106 char base64char(int x) _const_;
107 int unbase64char(char c) _const_;
108
109 bool dirent_is_file(const struct dirent *de) _pure_;
110 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix) _pure_;
111
112 bool hidden_file(const char *filename) _pure_;
113
114 /* For basic lookup tables with strictly enumerated entries */
115 #define _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope) \
116 scope const char *name##_to_string(type i) { \
117 if (i < 0 || i >= (type) ELEMENTSOF(name##_table)) \
118 return NULL; \
119 return name##_table[i]; \
120 }
121
122 ssize_t string_table_lookup(const char * const *table, size_t len, const char *key);
123
124 #define _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope) \
125 scope type name##_from_string(const char *s) { \
126 return (type) string_table_lookup(name##_table, ELEMENTSOF(name##_table), s); \
127 }
128
129 #define _DEFINE_STRING_TABLE_LOOKUP(name,type,scope) \
130 _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope) \
131 _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope) \
132 struct __useless_struct_to_allow_trailing_semicolon__
133
134 #define DEFINE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,)
135 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,static)
136 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_TO_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,static)
137 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_FROM_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,static)
138
139 /* For string conversions where numbers are also acceptable */
140 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max) \
141 int name##_to_string_alloc(type i, char **str) { \
142 char *s; \
143 if (i < 0 || i > max) \
144 return -ERANGE; \
145 if (i < (type) ELEMENTSOF(name##_table)) { \
146 s = strdup(name##_table[i]); \
147 if (!s) \
148 return -ENOMEM; \
149 } else { \
150 if (asprintf(&s, "%i", i) < 0) \
151 return -ENOMEM; \
152 } \
153 *str = s; \
154 return 0; \
155 } \
156 type name##_from_string(const char *s) { \
157 type i; \
158 unsigned u = 0; \
159 if (!s) \
160 return (type) -1; \
161 for (i = 0; i < (type) ELEMENTSOF(name##_table); i++) \
162 if (streq_ptr(name##_table[i], s)) \
163 return i; \
164 if (safe_atou(s, &u) >= 0 && u <= max) \
165 return (type) u; \
166 return (type) -1; \
167 } \
168 struct __useless_struct_to_allow_trailing_semicolon__
169
170 bool fstype_is_network(const char *fstype);
171
172 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
173
174 bool is_device_path(const char *path);
175
176 int dir_is_empty(const char *path);
177 char* dirname_malloc(const char *path);
178
179 static inline int dir_is_populated(const char *path) {
180 int r;
181 r = dir_is_empty(path);
182 if (r < 0)
183 return r;
184 return !r;
185 }
186
187 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
188 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
189
190 typedef long statfs_f_type_t;
191
192 bool is_fs_type(const struct statfs *s, statfs_f_type_t magic_value) _pure_;
193 int fd_check_fstype(int fd, statfs_f_type_t magic_value);
194 int path_check_fstype(const char *path, statfs_f_type_t magic_value);
195
196 bool is_temporary_fs(const struct statfs *s) _pure_;
197 int fd_is_temporary_fs(int fd);
198
199 #define xsprintf(buf, fmt, ...) \
200 assert_message_se((size_t) snprintf(buf, ELEMENTSOF(buf), fmt, __VA_ARGS__) < ELEMENTSOF(buf), \
201 "xsprintf: " #buf "[] must be big enough")
202
203 int files_same(const char *filea, const char *fileb);
204
205 int running_in_chroot(void);
206
207 int touch_file(const char *path, bool parents, usec_t stamp, uid_t uid, gid_t gid, mode_t mode);
208 int touch(const char *path);
209
210 noreturn void freeze(void);
211
212 bool null_or_empty(struct stat *st) _pure_;
213 int null_or_empty_path(const char *fn);
214 int null_or_empty_fd(int fd);
215
216 DIR *xopendirat(int dirfd, const char *name, int flags);
217
218 char *fstab_node_to_udev_node(const char *p);
219
220 void execute_directories(const char* const* directories, usec_t timeout, char *argv[]);
221
222 bool plymouth_running(void);
223
224 int symlink_idempotent(const char *from, const char *to);
225
226 int symlink_atomic(const char *from, const char *to);
227 int mknod_atomic(const char *path, mode_t mode, dev_t dev);
228 int mkfifo_atomic(const char *path, mode_t mode);
229
230 int fchmod_umask(int fd, mode_t mode);
231
232 bool display_is_local(const char *display) _pure_;
233 int socket_from_display(const char *display, char **path);
234
235 int glob_exists(const char *path);
236 int glob_extend(char ***strv, const char *path);
237
238 int dirent_ensure_type(DIR *d, struct dirent *de);
239
240 int get_files_in_directory(const char *path, char ***list);
241
242 bool is_main_thread(void);
243
244 int block_get_whole_disk(dev_t d, dev_t *ret);
245
246 #define NULSTR_FOREACH(i, l) \
247 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
248
249 #define NULSTR_FOREACH_PAIR(i, j, l) \
250 for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
251
252 int ioprio_class_to_string_alloc(int i, char **s);
253 int ioprio_class_from_string(const char *s);
254
255 const char *sigchld_code_to_string(int i) _const_;
256 int sigchld_code_from_string(const char *s) _pure_;
257
258 int log_facility_unshifted_to_string_alloc(int i, char **s);
259 int log_facility_unshifted_from_string(const char *s);
260 bool log_facility_unshifted_is_valid(int faciliy);
261
262 int log_level_to_string_alloc(int i, char **s);
263 int log_level_from_string(const char *s);
264 bool log_level_is_valid(int level);
265
266 int sched_policy_to_string_alloc(int i, char **s);
267 int sched_policy_from_string(const char *s);
268
269 const char *rlimit_to_string(int i) _const_;
270 int rlimit_from_string(const char *s) _pure_;
271
272 extern int saved_argc;
273 extern char **saved_argv;
274
275 bool kexec_loaded(void);
276
277 int prot_from_flags(int flags) _const_;
278
279 void* memdup(const void *p, size_t l) _alloc_(2);
280
281 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
282
283 int setrlimit_closest(int resource, const struct rlimit *rlim);
284
285 bool http_url_is_valid(const char *url) _pure_;
286 bool documentation_url_is_valid(const char *url) _pure_;
287
288 bool http_etag_is_valid(const char *etag);
289
290 bool in_initrd(void);
291
292 static inline void freep(void *p) {
293 free(*(void**) p);
294 }
295
296 static inline void umaskp(mode_t *u) {
297 umask(*u);
298 }
299
300 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, endmntent);
301
302 #define _cleanup_free_ _cleanup_(freep)
303 #define _cleanup_umask_ _cleanup_(umaskp)
304 #define _cleanup_globfree_ _cleanup_(globfree)
305 #define _cleanup_endmntent_ _cleanup_(endmntentp)
306
307 _malloc_ _alloc_(1, 2) static inline void *malloc_multiply(size_t a, size_t b) {
308 if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
309 return NULL;
310
311 return malloc(a * b);
312 }
313
314 _alloc_(2, 3) static inline void *realloc_multiply(void *p, size_t a, size_t b) {
315 if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
316 return NULL;
317
318 return realloc(p, a * b);
319 }
320
321 _alloc_(2, 3) static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
322 if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
323 return NULL;
324
325 return memdup(p, a * b);
326 }
327
328 bool filename_is_valid(const char *p) _pure_;
329 bool path_is_safe(const char *p) _pure_;
330 bool string_is_safe(const char *p) _pure_;
331
332 /**
333 * Check if a string contains any glob patterns.
334 */
335 _pure_ static inline bool string_is_glob(const char *p) {
336 return !!strpbrk(p, GLOB_CHARS);
337 }
338
339 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
340 int (*compar) (const void *, const void *, void *),
341 void *arg);
342
343 #define _(String) gettext (String)
344 #define N_(String) String
345 void init_gettext(void);
346 bool is_locale_utf8(void);
347
348 typedef enum DrawSpecialChar {
349 DRAW_TREE_VERTICAL,
350 DRAW_TREE_BRANCH,
351 DRAW_TREE_RIGHT,
352 DRAW_TREE_SPACE,
353 DRAW_TRIANGULAR_BULLET,
354 DRAW_BLACK_CIRCLE,
355 DRAW_ARROW,
356 DRAW_DASH,
357 _DRAW_SPECIAL_CHAR_MAX
358 } DrawSpecialChar;
359
360 const char *draw_special_char(DrawSpecialChar ch);
361
362 int on_ac_power(void);
363
364 int search_and_fopen(const char *path, const char *mode, const char *root, const char **search, FILE **_f);
365 int search_and_fopen_nulstr(const char *path, const char *mode, const char *root, const char *search, FILE **_f);
366
367 #define FOREACH_LINE(line, f, on_error) \
368 for (;;) \
369 if (!fgets(line, sizeof(line), f)) { \
370 if (ferror(f)) { \
371 on_error; \
372 } \
373 break; \
374 } else
375
376 #define FOREACH_DIRENT(de, d, on_error) \
377 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
378 if (!de) { \
379 if (errno > 0) { \
380 on_error; \
381 } \
382 break; \
383 } else if (hidden_file((de)->d_name)) \
384 continue; \
385 else
386
387 #define FOREACH_DIRENT_ALL(de, d, on_error) \
388 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
389 if (!de) { \
390 if (errno > 0) { \
391 on_error; \
392 } \
393 break; \
394 } else
395
396 static inline void *mempset(void *s, int c, size_t n) {
397 memset(s, c, n);
398 return (uint8_t*)s + n;
399 }
400
401 char *hexmem(const void *p, size_t l);
402 int unhexmem(const char *p, size_t l, void **mem, size_t *len);
403
404 char *base32hexmem(const void *p, size_t l, bool padding);
405 int unbase32hexmem(const char *p, size_t l, bool padding, void **mem, size_t *len);
406
407 char *base64mem(const void *p, size_t l);
408 int unbase64mem(const char *p, size_t l, void **mem, size_t *len);
409
410 void* greedy_realloc(void **p, size_t *allocated, size_t need, size_t size);
411 void* greedy_realloc0(void **p, size_t *allocated, size_t need, size_t size);
412 #define GREEDY_REALLOC(array, allocated, need) \
413 greedy_realloc((void**) &(array), &(allocated), (need), sizeof((array)[0]))
414
415 #define GREEDY_REALLOC0(array, allocated, need) \
416 greedy_realloc0((void**) &(array), &(allocated), (need), sizeof((array)[0]))
417
418 static inline void _reset_errno_(int *saved_errno) {
419 errno = *saved_errno;
420 }
421
422 #define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
423
424 static inline int negative_errno(void) {
425 /* This helper should be used to shut up gcc if you know 'errno' is
426 * negative. Instead of "return -errno;", use "return negative_errno();"
427 * It will suppress bogus gcc warnings in case it assumes 'errno' might
428 * be 0 and thus the caller's error-handling might not be triggered. */
429 assert_return(errno > 0, -EINVAL);
430 return -errno;
431 }
432
433 struct _umask_struct_ {
434 mode_t mask;
435 bool quit;
436 };
437
438 static inline void _reset_umask_(struct _umask_struct_ *s) {
439 umask(s->mask);
440 };
441
442 #define RUN_WITH_UMASK(mask) \
443 for (_cleanup_(_reset_umask_) struct _umask_struct_ _saved_umask_ = { umask(mask), false }; \
444 !_saved_umask_.quit ; \
445 _saved_umask_.quit = true)
446
447 static inline unsigned u64log2(uint64_t n) {
448 #if __SIZEOF_LONG_LONG__ == 8
449 return (n > 1) ? (unsigned) __builtin_clzll(n) ^ 63U : 0;
450 #else
451 #error "Wut?"
452 #endif
453 }
454
455 static inline unsigned u32ctz(uint32_t n) {
456 #if __SIZEOF_INT__ == 4
457 return __builtin_ctz(n);
458 #else
459 #error "Wut?"
460 #endif
461 }
462
463 static inline unsigned log2i(int x) {
464 assert(x > 0);
465
466 return __SIZEOF_INT__ * 8 - __builtin_clz(x) - 1;
467 }
468
469 static inline unsigned log2u(unsigned x) {
470 assert(x > 0);
471
472 return sizeof(unsigned) * 8 - __builtin_clz(x) - 1;
473 }
474
475 static inline unsigned log2u_round_up(unsigned x) {
476 assert(x > 0);
477
478 if (x == 1)
479 return 0;
480
481 return log2u(x - 1) + 1;
482 }
483
484 #define DECIMAL_STR_WIDTH(x) \
485 ({ \
486 typeof(x) _x_ = (x); \
487 unsigned ans = 1; \
488 while (_x_ /= 10) \
489 ans++; \
490 ans; \
491 })
492
493 int unlink_noerrno(const char *path);
494
495 #define alloca0(n) \
496 ({ \
497 char *_new_; \
498 size_t _len_ = n; \
499 _new_ = alloca(_len_); \
500 (void *) memset(_new_, 0, _len_); \
501 })
502
503 /* It's not clear what alignment glibc/gcc alloca() guarantee, hence provide a guaranteed safe version */
504 #define alloca_align(size, align) \
505 ({ \
506 void *_ptr_; \
507 size_t _mask_ = (align) - 1; \
508 _ptr_ = alloca((size) + _mask_); \
509 (void*)(((uintptr_t)_ptr_ + _mask_) & ~_mask_); \
510 })
511
512 #define alloca0_align(size, align) \
513 ({ \
514 void *_new_; \
515 size_t _size_ = (size); \
516 _new_ = alloca_align(_size_, (align)); \
517 (void*)memset(_new_, 0, _size_); \
518 })
519
520 bool id128_is_valid(const char *s) _pure_;
521
522 int shall_restore_state(void);
523
524 /**
525 * Normal qsort requires base to be nonnull. Here were require
526 * that only if nmemb > 0.
527 */
528 static inline void qsort_safe(void *base, size_t nmemb, size_t size, comparison_fn_t compar) {
529 if (nmemb <= 1)
530 return;
531
532 assert(base);
533 qsort(base, nmemb, size, compar);
534 }
535
536 int proc_cmdline(char **ret);
537 int parse_proc_cmdline(int (*parse_word)(const char *key, const char *value));
538 int get_proc_cmdline_key(const char *parameter, char **value);
539
540 int container_get_leader(const char *machine, pid_t *pid);
541
542 int namespace_open(pid_t pid, int *pidns_fd, int *mntns_fd, int *netns_fd, int *userns_fd, int *root_fd);
543 int namespace_enter(int pidns_fd, int mntns_fd, int netns_fd, int userns_fd, int root_fd);
544
545 int mkostemp_safe(char *pattern, int flags);
546 int open_tmpfile(const char *path, int flags);
547
548 int fd_warn_permissions(const char *path, int fd);
549
550 #ifndef PERSONALITY_INVALID
551 /* personality(7) documents that 0xffffffffUL is used for querying the
552 * current personality, hence let's use that here as error
553 * indicator. */
554 #define PERSONALITY_INVALID 0xffffffffLU
555 #endif
556
557 unsigned long personality_from_string(const char *p);
558 const char *personality_to_string(unsigned long);
559
560 uint64_t physical_memory(void);
561
562 void hexdump(FILE *f, const void *p, size_t s);
563
564 union file_handle_union {
565 struct file_handle handle;
566 char padding[sizeof(struct file_handle) + MAX_HANDLE_SZ];
567 };
568 #define FILE_HANDLE_INIT { .handle.handle_bytes = MAX_HANDLE_SZ }
569
570 int update_reboot_param_file(const char *param);
571
572 int umount_recursive(const char *target, int flags);
573
574 int bind_remount_recursive(const char *prefix, bool ro);
575
576 int fflush_and_check(FILE *f);
577
578 int tempfn_xxxxxx(const char *p, const char *extra, char **ret);
579 int tempfn_random(const char *p, const char *extra, char **ret);
580 int tempfn_random_child(const char *p, const char *extra, char **ret);
581
582 int take_password_lock(const char *root);
583
584 int is_symlink(const char *path);
585 int is_dir(const char *path, bool follow);
586 int is_device_node(const char *path);
587
588 #define INOTIFY_EVENT_MAX (sizeof(struct inotify_event) + NAME_MAX + 1)
589
590 #define FOREACH_INOTIFY_EVENT(e, buffer, sz) \
591 for ((e) = &buffer.ev; \
592 (uint8_t*) (e) < (uint8_t*) (buffer.raw) + (sz); \
593 (e) = (struct inotify_event*) ((uint8_t*) (e) + sizeof(struct inotify_event) + (e)->len))
594
595 union inotify_event_buffer {
596 struct inotify_event ev;
597 uint8_t raw[INOTIFY_EVENT_MAX];
598 };
599
600 #define laccess(path, mode) faccessat(AT_FDCWD, (path), (mode), AT_SYMLINK_NOFOLLOW)
601
602 ssize_t fgetxattrat_fake(int dirfd, const char *filename, const char *attribute, void *value, size_t size, int flags);
603
604 int fd_setcrtime(int fd, usec_t usec);
605 int fd_getcrtime(int fd, usec_t *usec);
606 int path_getcrtime(const char *p, usec_t *usec);
607 int fd_getcrtime_at(int dirfd, const char *name, usec_t *usec, int flags);
608
609 int chattr_fd(int fd, unsigned value, unsigned mask);
610 int chattr_path(const char *p, unsigned value, unsigned mask);
611
612 int read_attr_fd(int fd, unsigned *ret);
613 int read_attr_path(const char *p, unsigned *ret);
614
615 #define RLIMIT_MAKE_CONST(lim) ((struct rlimit) { lim, lim })
616
617 int syslog_parse_priority(const char **p, int *priority, bool with_facility);
618
619 int rename_noreplace(int olddirfd, const char *oldpath, int newdirfd, const char *newpath);
620
621 int mount_move_root(const char *path);
622
623 int getxattr_malloc(const char *path, const char *name, char **value, bool allow_symlink);
624 int fgetxattr_malloc(int fd, const char *name, char **value);
625
626 int version(void);
627
628 bool fdname_is_valid(const char *s);
629
630 bool oom_score_adjust_is_valid(int oa);