1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
6 This file is part of systemd.
8 Copyright 2010 Lennart Poettering
10 systemd is free software; you can redistribute it and/or modify it
11 under the terms of the GNU Lesser General Public License as published by
12 the Free Software Foundation; either version 2.1 of the License, or
13 (at your option) any later version.
15 systemd is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
20 You should have received a copy of the GNU Lesser General Public License
21 along with systemd; If not, see <http://www.gnu.org/licenses/>.
35 #include <sys/types.h>
36 #include <sys/socket.h>
43 #include <sys/inotify.h>
44 #include <sys/statfs.h>
47 # define PID_PRI PRIi32
48 #elif SIZEOF_PID_T == 2
49 # define PID_PRI PRIi16
51 # error Unknown pid_t size
53 #define PID_FMT "%" PID_PRI
56 # define UID_FMT "%" PRIu32
57 #elif SIZEOF_UID_T == 2
58 # define UID_FMT "%" PRIu16
60 # error Unknown uid_t size
64 # define GID_FMT "%" PRIu32
65 #elif SIZEOF_GID_T == 2
66 # define GID_FMT "%" PRIu16
68 # error Unknown gid_t size
71 #if SIZEOF_TIME_T == 8
72 # define PRI_TIME PRIi64
73 #elif SIZEOF_TIME_T == 4
74 # define PRI_TIME PRIu32
76 # error Unknown time_t size
79 #if SIZEOF_RLIM_T == 8
80 # define RLIM_FMT "%" PRIu64
81 #elif SIZEOF_RLIM_T == 4
82 # define RLIM_FMT "%" PRIu32
84 # error Unknown rlim_t size
89 #include "time-util.h"
91 /* What is interpreted as whitespace? */
92 #define WHITESPACE " \t\n\r"
93 #define NEWLINE "\n\r"
96 #define GLOB_CHARS "*?["
98 /* What characters are special in the shell? */
99 /* must be escaped outside and inside double-quotes */
100 #define SHELL_NEED_ESCAPE "\"\\`$"
101 /* can be escaped or double-quoted */
102 #define SHELL_NEED_QUOTES SHELL_NEED_ESCAPE GLOB_CHARS "'()<>|&;"
104 #define FORMAT_BYTES_MAX 8
106 #define ANSI_HIGHLIGHT_ON "\x1B[1;39m"
107 #define ANSI_RED_ON "\x1B[31m"
108 #define ANSI_HIGHLIGHT_RED_ON "\x1B[1;31m"
109 #define ANSI_GREEN_ON "\x1B[32m"
110 #define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
111 #define ANSI_HIGHLIGHT_YELLOW_ON "\x1B[1;33m"
112 #define ANSI_HIGHLIGHT_BLUE_ON "\x1B[1;34m"
113 #define ANSI_HIGHLIGHT_OFF "\x1B[0m"
114 #define ANSI_ERASE_TO_END_OF_LINE "\x1B[K"
116 size_t page_size(void) _pure_;
117 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
119 #define streq(a,b) (strcmp((a),(b)) == 0)
120 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
121 #define strcaseeq(a,b) (strcasecmp((a),(b)) == 0)
122 #define strncaseeq(a, b, n) (strncasecmp((a), (b), (n)) == 0)
124 bool streq_ptr(const char *a, const char *b) _pure_;
126 #define new(t, n) ((t*) malloc_multiply(sizeof(t), (n)))
128 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
130 #define newa(t, n) ((t*) alloca(sizeof(t)*(n)))
132 #define newa0(t, n) ((t*) alloca0(sizeof(t)*(n)))
134 #define newdup(t, p, n) ((t*) memdup_multiply(p, sizeof(t), (n)))
136 #define malloc0(n) (calloc((n), 1))
138 static inline const char* yes_no(bool b) {
139 return b ? "yes" : "no";
142 static inline const char* true_false(bool b) {
143 return b ? "true" : "false";
146 static inline const char* one_zero(bool b) {
147 return b ? "1" : "0";
150 static inline const char* strempty(const char *s) {
154 static inline const char* strnull(const char *s) {
155 return s ? s : "(null)";
158 static inline const char *strna(const char *s) {
159 return s ? s : "n/a";
162 static inline bool isempty(const char *p) {
166 static inline char *startswith(const char *s, const char *prefix) {
170 if (strncmp(s, prefix, l) == 0)
171 return (char*) s + l;
176 static inline char *startswith_no_case(const char *s, const char *prefix) {
180 if (strncasecmp(s, prefix, l) == 0)
181 return (char*) s + l;
186 char *endswith(const char *s, const char *postfix) _pure_;
187 char *endswith_no_case(const char *s, const char *postfix) _pure_;
189 char *first_word(const char *s, const char *word) _pure_;
191 int close_nointr(int fd);
192 int safe_close(int fd);
193 void safe_close_pair(int p[]);
195 void close_many(const int fds[], unsigned n_fd);
197 int parse_size(const char *t, off_t base, off_t *size);
199 int parse_boolean(const char *v) _pure_;
200 int parse_pid(const char *s, pid_t* ret_pid);
201 int parse_uid(const char *s, uid_t* ret_uid);
202 #define parse_gid(s, ret_uid) parse_uid(s, ret_uid)
204 int safe_atou(const char *s, unsigned *ret_u);
205 int safe_atoi(const char *s, int *ret_i);
207 int safe_atollu(const char *s, unsigned long long *ret_u);
208 int safe_atolli(const char *s, long long int *ret_i);
210 int safe_atod(const char *s, double *ret_d);
212 int safe_atou8(const char *s, uint8_t *ret);
214 #if LONG_MAX == INT_MAX
215 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
216 assert_cc(sizeof(unsigned long) == sizeof(unsigned));
217 return safe_atou(s, (unsigned*) ret_u);
219 static inline int safe_atoli(const char *s, long int *ret_u) {
220 assert_cc(sizeof(long int) == sizeof(int));
221 return safe_atoi(s, (int*) ret_u);
224 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
225 assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
226 return safe_atollu(s, (unsigned long long*) ret_u);
228 static inline int safe_atoli(const char *s, long int *ret_u) {
229 assert_cc(sizeof(long int) == sizeof(long long int));
230 return safe_atolli(s, (long long int*) ret_u);
234 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
235 assert_cc(sizeof(uint32_t) == sizeof(unsigned));
236 return safe_atou(s, (unsigned*) ret_u);
239 static inline int safe_atoi32(const char *s, int32_t *ret_i) {
240 assert_cc(sizeof(int32_t) == sizeof(int));
241 return safe_atoi(s, (int*) ret_i);
244 static inline int safe_atou64(const char *s, uint64_t *ret_u) {
245 assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
246 return safe_atollu(s, (unsigned long long*) ret_u);
249 static inline int safe_atoi64(const char *s, int64_t *ret_i) {
250 assert_cc(sizeof(int64_t) == sizeof(long long int));
251 return safe_atolli(s, (long long int*) ret_i);
254 int safe_atou16(const char *s, uint16_t *ret);
255 int safe_atoi16(const char *s, int16_t *ret);
257 const char* split(const char **state, size_t *l, const char *separator, bool quoted);
259 #define FOREACH_WORD(word, length, s, state) \
260 _FOREACH_WORD(word, length, s, WHITESPACE, false, state)
262 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state) \
263 _FOREACH_WORD(word, length, s, separator, false, state)
265 #define FOREACH_WORD_QUOTED(word, length, s, state) \
266 _FOREACH_WORD(word, length, s, WHITESPACE, true, state)
268 #define _FOREACH_WORD(word, length, s, separator, quoted, state) \
269 for ((state) = (s), (word) = split(&(state), &(length), (separator), (quoted)); (word); (word) = split(&(state), &(length), (separator), (quoted)))
271 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
273 char *strappend(const char *s, const char *suffix);
274 char *strnappend(const char *s, const char *suffix, size_t length);
276 char *replace_env(const char *format, char **env);
277 char **replace_env_argv(char **argv, char **env);
279 int readlinkat_malloc(int fd, const char *p, char **ret);
280 int readlink_malloc(const char *p, char **r);
281 int readlink_value(const char *p, char **ret);
282 int readlink_and_make_absolute(const char *p, char **r);
283 int readlink_and_canonicalize(const char *p, char **r);
285 int reset_all_signal_handlers(void);
286 int reset_signal_mask(void);
288 char *strstrip(char *s);
289 char *delete_chars(char *s, const char *bad);
290 char *truncate_nl(char *s);
292 char *file_in_same_dir(const char *path, const char *filename);
294 int rmdir_parents(const char *path, const char *stop);
296 int get_process_state(pid_t pid);
297 int get_process_comm(pid_t pid, char **name);
298 int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
299 int get_process_exe(pid_t pid, char **name);
300 int get_process_uid(pid_t pid, uid_t *uid);
301 int get_process_gid(pid_t pid, gid_t *gid);
302 int get_process_capeff(pid_t pid, char **capeff);
303 int get_process_cwd(pid_t pid, char **cwd);
304 int get_process_root(pid_t pid, char **root);
305 int get_process_environ(pid_t pid, char **environ);
307 char hexchar(int x) _const_;
308 int unhexchar(char c) _const_;
309 char octchar(int x) _const_;
310 int unoctchar(char c) _const_;
311 char decchar(int x) _const_;
312 int undecchar(char c) _const_;
314 char *cescape(const char *s);
315 char *cunescape(const char *s);
316 char *cunescape_length(const char *s, size_t length);
317 char *cunescape_length_with_prefix(const char *s, size_t length, const char *prefix);
319 char *xescape(const char *s, const char *bad);
321 char *ascii_strlower(char *path);
323 bool dirent_is_file(const struct dirent *de) _pure_;
324 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix) _pure_;
326 bool hidden_file(const char *filename) _pure_;
328 bool chars_intersect(const char *a, const char *b) _pure_;
330 int make_stdio(int fd);
331 int make_null_stdio(void);
332 int make_console_stdio(void);
334 int dev_urandom(void *p, size_t n);
335 void random_bytes(void *p, size_t n);
336 void initialize_srand(void);
338 static inline uint64_t random_u64(void) {
340 random_bytes(&u, sizeof(u));
344 static inline uint32_t random_u32(void) {
346 random_bytes(&u, sizeof(u));
350 /* For basic lookup tables with strictly enumerated entries */
351 #define _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope) \
352 scope const char *name##_to_string(type i) { \
353 if (i < 0 || i >= (type) ELEMENTSOF(name##_table)) \
355 return name##_table[i]; \
358 ssize_t string_table_lookup(const char * const *table, size_t len, const char *key);
360 #define _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope) \
361 scope inline type name##_from_string(const char *s) { \
362 return (type)string_table_lookup(name##_table, ELEMENTSOF(name##_table), s); \
365 #define _DEFINE_STRING_TABLE_LOOKUP(name,type,scope) \
366 _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,scope) \
367 _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,scope) \
368 struct __useless_struct_to_allow_trailing_semicolon__
370 #define DEFINE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,)
371 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) _DEFINE_STRING_TABLE_LOOKUP(name,type,static)
372 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_TO_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_TO_STRING(name,type,static)
373 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP_FROM_STRING(name,type) _DEFINE_STRING_TABLE_LOOKUP_FROM_STRING(name,type,static)
375 /* For string conversions where numbers are also acceptable */
376 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max) \
377 int name##_to_string_alloc(type i, char **str) { \
380 if (i < 0 || i > max) \
382 if (i < (type) ELEMENTSOF(name##_table)) { \
383 s = strdup(name##_table[i]); \
387 r = asprintf(&s, "%i", i); \
394 type name##_from_string(const char *s) { \
398 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
399 if (name##_table[i] && \
400 streq(name##_table[i], s)) \
402 if (safe_atou(s, &u) >= 0 && u <= max) \
406 struct __useless_struct_to_allow_trailing_semicolon__
408 int fd_nonblock(int fd, bool nonblock);
409 int fd_cloexec(int fd, bool cloexec);
411 int close_all_fds(const int except[], unsigned n_except);
413 bool fstype_is_network(const char *fstype);
417 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
418 int ask_char(char *ret, const char *replies, const char *text, ...) _printf_(3, 4);
419 int ask_string(char **ret, const char *text, ...) _printf_(2, 3);
421 int reset_terminal_fd(int fd, bool switch_to_text);
422 int reset_terminal(const char *name);
424 int open_terminal(const char *name, int mode);
425 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
426 int release_terminal(void);
428 int flush_fd(int fd);
430 int ignore_signals(int sig, ...);
431 int default_signals(int sig, ...);
432 int sigaction_many(const struct sigaction *sa, ...);
434 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
436 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
437 int loop_read_exact(int fd, void *buf, size_t nbytes, bool do_poll);
438 int loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
440 bool is_device_path(const char *path);
442 int dir_is_empty(const char *path);
443 char* dirname_malloc(const char *path);
445 void rename_process(const char name[8]);
447 void sigset_add_many(sigset_t *ss, ...);
448 int sigprocmask_many(int how, ...);
450 bool hostname_is_set(void);
452 char* lookup_uid(uid_t uid);
453 char* gethostname_malloc(void);
454 char* getlogname_malloc(void);
455 char* getusername_malloc(void);
457 int getttyname_malloc(int fd, char **r);
458 int getttyname_harder(int fd, char **r);
460 int get_ctty_devnr(pid_t pid, dev_t *d);
461 int get_ctty(pid_t, dev_t *_devnr, char **r);
463 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
464 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
466 bool is_temporary_fs(const struct statfs *s) _pure_;
467 int fd_is_temporary_fs(int fd);
469 int pipe_eof(int fd);
471 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
473 int status_vprintf(const char *status, bool ellipse, bool ephemeral, const char *format, va_list ap) _printf_(4,0);
474 int status_printf(const char *status, bool ellipse, bool ephemeral, const char *format, ...) _printf_(4,5);
476 #define xsprintf(buf, fmt, ...) assert_se((size_t) snprintf(buf, ELEMENTSOF(buf), fmt, __VA_ARGS__) < ELEMENTSOF(buf))
478 int fd_columns(int fd);
479 unsigned columns(void);
480 int fd_lines(int fd);
481 unsigned lines(void);
482 void columns_lines_cache_reset(int _unused_ signum);
486 static inline const char *ansi_highlight(void) {
487 return on_tty() ? ANSI_HIGHLIGHT_ON : "";
490 static inline const char *ansi_highlight_red(void) {
491 return on_tty() ? ANSI_HIGHLIGHT_RED_ON : "";
494 static inline const char *ansi_highlight_green(void) {
495 return on_tty() ? ANSI_HIGHLIGHT_GREEN_ON : "";
498 static inline const char *ansi_highlight_yellow(void) {
499 return on_tty() ? ANSI_HIGHLIGHT_YELLOW_ON : "";
502 static inline const char *ansi_highlight_blue(void) {
503 return on_tty() ? ANSI_HIGHLIGHT_BLUE_ON : "";
506 static inline const char *ansi_highlight_off(void) {
507 return on_tty() ? ANSI_HIGHLIGHT_OFF : "";
510 int files_same(const char *filea, const char *fileb);
512 int running_in_chroot(void);
514 char *ellipsize(const char *s, size_t length, unsigned percent);
516 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
518 int touch_file(const char *path, bool parents, usec_t stamp, uid_t uid, gid_t gid, mode_t mode);
519 int touch(const char *path);
521 char *unquote(const char *s, const char *quotes);
522 char *normalize_env_assignment(const char *s);
524 int wait_for_terminate(pid_t pid, siginfo_t *status);
525 int wait_for_terminate_and_warn(const char *name, pid_t pid, bool check_exit_code);
527 noreturn void freeze(void);
529 bool null_or_empty(struct stat *st) _pure_;
530 int null_or_empty_path(const char *fn);
531 int null_or_empty_fd(int fd);
533 DIR *xopendirat(int dirfd, const char *name, int flags);
535 char *fstab_node_to_udev_node(const char *p);
537 char *resolve_dev_console(char **active);
538 bool tty_is_vc(const char *tty);
539 bool tty_is_vc_resolve(const char *tty);
540 bool tty_is_console(const char *tty) _pure_;
541 int vtnr_from_tty(const char *tty);
542 const char *default_term_for_tty(const char *tty);
544 void execute_directories(const char* const* directories, usec_t timeout, char *argv[]);
546 int kill_and_sigcont(pid_t pid, int sig);
548 bool nulstr_contains(const char*nulstr, const char *needle);
550 bool plymouth_running(void);
552 bool hostname_is_valid(const char *s) _pure_;
553 char* hostname_cleanup(char *s, bool lowercase);
555 bool machine_name_is_valid(const char *s) _pure_;
557 char* strshorten(char *s, size_t l);
559 int terminal_vhangup_fd(int fd);
560 int terminal_vhangup(const char *name);
562 int vt_disallocate(const char *name);
564 int symlink_atomic(const char *from, const char *to);
565 int mknod_atomic(const char *path, mode_t mode, dev_t dev);
566 int mkfifo_atomic(const char *path, mode_t mode);
568 int fchmod_umask(int fd, mode_t mode);
570 bool display_is_local(const char *display) _pure_;
571 int socket_from_display(const char *display, char **path);
573 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
574 int get_group_creds(const char **groupname, gid_t *gid);
576 int in_gid(gid_t gid);
577 int in_group(const char *name);
579 char* uid_to_name(uid_t uid);
580 char* gid_to_name(gid_t gid);
582 int glob_exists(const char *path);
583 int glob_extend(char ***strv, const char *path);
585 int dirent_ensure_type(DIR *d, struct dirent *de);
587 int get_files_in_directory(const char *path, char ***list);
589 char *strjoin(const char *x, ...) _sentinel_;
591 bool is_main_thread(void);
593 static inline bool _pure_ in_charset(const char *s, const char* charset) {
596 return s[strspn(s, charset)] == '\0';
599 int block_get_whole_disk(dev_t d, dev_t *ret);
601 #define NULSTR_FOREACH(i, l) \
602 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
604 #define NULSTR_FOREACH_PAIR(i, j, l) \
605 for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
607 int ioprio_class_to_string_alloc(int i, char **s);
608 int ioprio_class_from_string(const char *s);
610 const char *sigchld_code_to_string(int i) _const_;
611 int sigchld_code_from_string(const char *s) _pure_;
613 int log_facility_unshifted_to_string_alloc(int i, char **s);
614 int log_facility_unshifted_from_string(const char *s);
616 int log_level_to_string_alloc(int i, char **s);
617 int log_level_from_string(const char *s);
619 int sched_policy_to_string_alloc(int i, char **s);
620 int sched_policy_from_string(const char *s);
622 const char *rlimit_to_string(int i) _const_;
623 int rlimit_from_string(const char *s) _pure_;
625 int ip_tos_to_string_alloc(int i, char **s);
626 int ip_tos_from_string(const char *s);
628 const char *signal_to_string(int i) _const_;
629 int signal_from_string(const char *s) _pure_;
631 int signal_from_string_try_harder(const char *s);
633 extern int saved_argc;
634 extern char **saved_argv;
636 bool kexec_loaded(void);
638 int prot_from_flags(int flags) _const_;
640 char *format_bytes(char *buf, size_t l, off_t t);
642 int fd_wait_for_event(int fd, int event, usec_t timeout);
644 void* memdup(const void *p, size_t l) _alloc_(2);
646 int is_kernel_thread(pid_t pid);
648 int fd_inc_sndbuf(int fd, size_t n);
649 int fd_inc_rcvbuf(int fd, size_t n);
651 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
653 int setrlimit_closest(int resource, const struct rlimit *rlim);
655 int getenv_for_pid(pid_t pid, const char *field, char **_value);
657 bool http_url_is_valid(const char *url) _pure_;
658 bool documentation_url_is_valid(const char *url) _pure_;
660 bool http_etag_is_valid(const char *etag);
662 bool in_initrd(void);
664 void warn_melody(void);
666 int get_home_dir(char **ret);
667 int get_shell(char **_ret);
669 static inline void freep(void *p) {
673 static inline void closep(int *fd) {
677 static inline void umaskp(mode_t *u) {
681 static inline void close_pairp(int (*p)[2]) {
685 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, fclose);
686 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, pclose);
687 DEFINE_TRIVIAL_CLEANUP_FUNC(DIR*, closedir);
688 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, endmntent);
690 #define _cleanup_free_ _cleanup_(freep)
691 #define _cleanup_close_ _cleanup_(closep)
692 #define _cleanup_umask_ _cleanup_(umaskp)
693 #define _cleanup_globfree_ _cleanup_(globfree)
694 #define _cleanup_fclose_ _cleanup_(fclosep)
695 #define _cleanup_pclose_ _cleanup_(pclosep)
696 #define _cleanup_closedir_ _cleanup_(closedirp)
697 #define _cleanup_endmntent_ _cleanup_(endmntentp)
698 #define _cleanup_close_pair_ _cleanup_(close_pairp)
700 _malloc_ _alloc_(1, 2) static inline void *malloc_multiply(size_t a, size_t b) {
701 if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
704 return malloc(a * b);
707 _alloc_(2, 3) static inline void *realloc_multiply(void *p, size_t a, size_t b) {
708 if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
711 return realloc(p, a * b);
714 _alloc_(2, 3) static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
715 if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
718 return memdup(p, a * b);
721 bool filename_is_valid(const char *p) _pure_;
722 bool path_is_safe(const char *p) _pure_;
723 bool string_is_safe(const char *p) _pure_;
724 bool string_has_cc(const char *p, const char *ok) _pure_;
727 * Check if a string contains any glob patterns.
729 _pure_ static inline bool string_is_glob(const char *p) {
730 return !!strpbrk(p, GLOB_CHARS);
733 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
734 int (*compar) (const void *, const void *, void *),
737 #define _(String) gettext (String)
738 void init_gettext(void);
739 bool is_locale_utf8(void);
741 typedef enum DrawSpecialChar {
746 DRAW_TRIANGULAR_BULLET,
750 _DRAW_SPECIAL_CHAR_MAX
753 const char *draw_special_char(DrawSpecialChar ch);
755 char *strreplace(const char *text, const char *old_string, const char *new_string);
757 char *strip_tab_ansi(char **p, size_t *l);
759 int on_ac_power(void);
761 int search_and_fopen(const char *path, const char *mode, const char *root, const char **search, FILE **_f);
762 int search_and_fopen_nulstr(const char *path, const char *mode, const char *root, const char *search, FILE **_f);
764 #define FOREACH_LINE(line, f, on_error) \
766 if (!fgets(line, sizeof(line), f)) { \
773 #define FOREACH_DIRENT(de, d, on_error) \
774 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
780 } else if (hidden_file((de)->d_name)) \
784 #define FOREACH_DIRENT_ALL(de, d, on_error) \
785 for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d)) \
793 static inline void *mempset(void *s, int c, size_t n) {
795 return (uint8_t*)s + n;
798 char *hexmem(const void *p, size_t l);
799 void *unhexmem(const char *p, size_t l);
801 char *strextend(char **x, ...) _sentinel_;
802 char *strrep(const char *s, unsigned n);
804 void* greedy_realloc(void **p, size_t *allocated, size_t need, size_t size);
805 void* greedy_realloc0(void **p, size_t *allocated, size_t need, size_t size);
806 #define GREEDY_REALLOC(array, allocated, need) \
807 greedy_realloc((void**) &(array), &(allocated), (need), sizeof((array)[0]))
809 #define GREEDY_REALLOC0(array, allocated, need) \
810 greedy_realloc0((void**) &(array), &(allocated), (need), sizeof((array)[0]))
812 static inline void _reset_errno_(int *saved_errno) {
813 errno = *saved_errno;
816 #define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
818 static inline int negative_errno(void) {
819 /* This helper should be used to shut up gcc if you know 'errno' is
820 * negative. Instead of "return -errno;", use "return negative_errno();"
821 * It will suppress bogus gcc warnings in case it assumes 'errno' might
822 * be 0 and thus the caller's error-handling might not be triggered. */
823 assert_return(errno > 0, -EINVAL);
827 struct _umask_struct_ {
832 static inline void _reset_umask_(struct _umask_struct_ *s) {
836 #define RUN_WITH_UMASK(mask) \
837 for (_cleanup_(_reset_umask_) struct _umask_struct_ _saved_umask_ = { umask(mask), false }; \
838 !_saved_umask_.quit ; \
839 _saved_umask_.quit = true)
841 static inline unsigned u64log2(uint64_t n) {
842 #if __SIZEOF_LONG_LONG__ == 8
843 return (n > 1) ? (unsigned) __builtin_clzll(n) ^ 63U : 0;
849 static inline unsigned u32ctz(uint32_t n) {
850 #if __SIZEOF_INT__ == 4
851 return __builtin_ctz(n);
857 static inline unsigned log2i(int x) {
860 return __SIZEOF_INT__ * 8 - __builtin_clz(x) - 1;
863 static inline unsigned log2u(unsigned x) {
866 return sizeof(unsigned) * 8 - __builtin_clz(x) - 1;
869 static inline unsigned log2u_round_up(unsigned x) {
875 return log2u(x - 1) + 1;
878 static inline bool logind_running(void) {
879 return access("/run/systemd/seats/", F_OK) >= 0;
882 #define DECIMAL_STR_WIDTH(x) \
884 typeof(x) _x_ = (x); \
891 int unlink_noerrno(const char *path);
897 _new_ = alloca(_len_); \
898 (void *) memset(_new_, 0, _len_); \
901 /* It's not clear what alignment glibc/gcc alloca() guarantee, hence provide a guaranteed safe version */
902 #define alloca_align(size, align) \
905 size_t _mask_ = (align) - 1; \
906 _ptr_ = alloca((size) + _mask_); \
907 (void*)(((uintptr_t)_ptr_ + _mask_) & ~_mask_); \
910 #define alloca0_align(size, align) \
913 size_t _size_ = (size); \
914 _new_ = alloca_align(_size_, (align)); \
915 (void*)memset(_new_, 0, _size_); \
918 #define strjoina(a, ...) \
920 const char *_appendees_[] = { a, __VA_ARGS__ }; \
924 for (_i_ = 0; _i_ < ELEMENTSOF(_appendees_) && _appendees_[_i_]; _i_++) \
925 _len_ += strlen(_appendees_[_i_]); \
926 _p_ = _d_ = alloca(_len_ + 1); \
927 for (_i_ = 0; _i_ < ELEMENTSOF(_appendees_) && _appendees_[_i_]; _i_++) \
928 _p_ = stpcpy(_p_, _appendees_[_i_]); \
933 #define procfs_file_alloca(pid, field) \
935 pid_t _pid_ = (pid); \
938 _r_ = ("/proc/self/" field); \
940 _r_ = alloca(strlen("/proc/") + DECIMAL_STR_MAX(pid_t) + 1 + sizeof(field)); \
941 sprintf((char*) _r_, "/proc/"PID_FMT"/" field, _pid_); \
946 bool id128_is_valid(const char *s) _pure_;
948 int split_pair(const char *s, const char *sep, char **l, char **r);
950 int shall_restore_state(void);
953 * Normal qsort requires base to be nonnull. Here were require
954 * that only if nmemb > 0.
956 static inline void qsort_safe(void *base, size_t nmemb, size_t size,
957 int (*compar)(const void *, const void *)) {
960 qsort(base, nmemb, size, compar);
964 int proc_cmdline(char **ret);
965 int parse_proc_cmdline(int (*parse_word)(const char *key, const char *value));
966 int get_proc_cmdline_key(const char *parameter, char **value);
968 int container_get_leader(const char *machine, pid_t *pid);
970 int namespace_open(pid_t pid, int *pidns_fd, int *mntns_fd, int *netns_fd, int *root_fd);
971 int namespace_enter(int pidns_fd, int mntns_fd, int netns_fd, int root_fd);
973 bool pid_is_alive(pid_t pid);
974 bool pid_is_unwaited(pid_t pid);
976 int getpeercred(int fd, struct ucred *ucred);
977 int getpeersec(int fd, char **ret);
979 int writev_safe(int fd, const struct iovec *w, int j);
981 int mkostemp_safe(char *pattern, int flags);
982 int open_tmpfile(const char *path, int flags);
984 int fd_warn_permissions(const char *path, int fd);
986 unsigned long personality_from_string(const char *p);
987 const char *personality_to_string(unsigned long);
989 uint64_t physical_memory(void);
991 void hexdump(FILE *f, const void *p, size_t s);
993 union file_handle_union {
994 struct file_handle handle;
995 char padding[sizeof(struct file_handle) + MAX_HANDLE_SZ];
997 #define FILE_HANDLE_INIT { .handle.handle_bytes = MAX_HANDLE_SZ }
999 int update_reboot_param_file(const char *param);
1001 int umount_recursive(const char *target, int flags);
1003 int bind_remount_recursive(const char *prefix, bool ro);
1005 int fflush_and_check(FILE *f);
1007 int tempfn_xxxxxx(const char *p, char **ret);
1008 int tempfn_random(const char *p, char **ret);
1009 int tempfn_random_child(const char *p, char **ret);
1011 bool is_localhost(const char *hostname);
1013 int take_password_lock(const char *root);
1015 int is_symlink(const char *path);
1016 int is_dir(const char *path, bool follow);
1018 typedef enum UnquoteFlags{
1020 UNQUOTE_CUNESCAPE = 2,
1023 int unquote_first_word(const char **p, char **ret, UnquoteFlags flags);
1024 int unquote_many_words(const char **p, UnquoteFlags flags, ...) _sentinel_;
1026 int free_and_strdup(char **p, const char *s);
1028 int sethostname_idempotent(const char *s);
1030 #define INOTIFY_EVENT_MAX (sizeof(struct inotify_event) + NAME_MAX + 1)
1032 #define FOREACH_INOTIFY_EVENT(e, buffer, sz) \
1033 for ((e) = &buffer.ev; \
1034 (uint8_t*) (e) < (uint8_t*) (buffer.raw) + (sz); \
1035 (e) = (struct inotify_event*) ((uint8_t*) (e) + sizeof(struct inotify_event) + (e)->len))
1037 union inotify_event_buffer {
1038 struct inotify_event ev;
1039 uint8_t raw[INOTIFY_EVENT_MAX];
1042 #define laccess(path, mode) faccessat(AT_FDCWD, (path), (mode), AT_SYMLINK_NOFOLLOW)
1044 int ptsname_malloc(int fd, char **ret);
1046 int openpt_in_namespace(pid_t pid, int flags);
1048 ssize_t fgetxattrat_fake(int dirfd, const char *filename, const char *attribute, void *value, size_t size, int flags);
1050 int fd_setcrtime(int fd, usec_t usec);
1051 int fd_getcrtime(int fd, usec_t *usec);
1052 int path_getcrtime(const char *p, usec_t *usec);
1053 int fd_getcrtime_at(int dirfd, const char *name, usec_t *usec, int flags);
1055 int chattr_fd(int fd, bool b, unsigned mask);
1056 int chattr_path(const char *p, bool b, unsigned mask);
1057 int change_attr_fd(int fd, unsigned value, unsigned mask);
1059 int read_attr_fd(int fd, unsigned *ret);
1060 int read_attr_path(const char *p, unsigned *ret);
1062 typedef struct LockFile {
1068 int make_lock_file(const char *p, int operation, LockFile *ret);
1069 int make_lock_file_for(const char *p, int operation, LockFile *ret);
1070 void release_lock_file(LockFile *f);
1072 #define _cleanup_release_lock_file_ _cleanup_(release_lock_file)
1074 #define LOCK_FILE_INIT { .fd = -1, .path = NULL }
1076 #define RLIMIT_MAKE_CONST(lim) ((struct rlimit) { lim, lim })
1078 ssize_t sparse_write(int fd, const void *p, size_t sz, size_t run_length);
1080 void sigkill_wait(pid_t *pid);
1081 #define _cleanup_sigkill_wait_ _cleanup_(sigkill_wait)
1083 int syslog_parse_priority(const char **p, int *priority, bool with_facility);
1085 void cmsg_close_all(struct msghdr *mh);
1087 int rename_noreplace(int olddirfd, const char *oldpath, int newdirfd, const char *newpath);