chiark / gitweb /
tests: add missing entry to test-tables
[elogind.git] / src / shared / 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 <fcntl.h>
26 #include <inttypes.h>
27 #include <time.h>
28 #include <sys/time.h>
29 #include <stdarg.h>
30 #include <stdbool.h>
31 #include <stdlib.h>
32 #include <stdio.h>
33 #include <signal.h>
34 #include <sched.h>
35 #include <limits.h>
36 #include <sys/types.h>
37 #include <sys/stat.h>
38 #include <dirent.h>
39 #include <sys/resource.h>
40 #include <stddef.h>
41 #include <unistd.h>
42 #include <locale.h>
43 #include <mntent.h>
44 #include <sys/socket.h>
45
46 #if SIZEOF_PID_T == 4
47 #  define PID_FMT "%" PRIu32
48 #elif SIZEOF_PID_T == 2
49 #  define PID_FMT "%" PRIu16
50 #else
51 #  error Unknown pid_t size
52 #endif
53
54 #if SIZEOF_UID_T == 4
55 #  define UID_FMT "%" PRIu32
56 #elif SIZEOF_UID_T == 2
57 #  define UID_FMT "%" PRIu16
58 #else
59 #  error Unknown uid_t size
60 #endif
61
62 #if SIZEOF_GID_T == 4
63 #  define GID_FMT "%" PRIu32
64 #elif SIZEOF_GID_T == 2
65 #  define GID_FMT "%" PRIu16
66 #else
67 #  error Unknown gid_t size
68 #endif
69
70 #if SIZEOF_TIME_T == 8
71 #  define PRI_TIME PRIu64
72 #elif SIZEOF_TIME_T == 4
73 #  define PRI_TIME PRIu32
74 #else
75 #  error Unknown time_t size
76 #endif
77
78 #if SIZEOF_RLIM_T == 8
79 #  define RLIM_FMT "%" PRIu64
80 #elif SIZEOF_RLIM_T == 4
81 #  define RLIM_FMT "%" PRIu32
82 #else
83 #  error Unknown rlim_t size
84 #endif
85
86 #include "macro.h"
87 #include "missing.h"
88 #include "time-util.h"
89
90 /* What is interpreted as whitespace? */
91 #define WHITESPACE " \t\n\r"
92 #define NEWLINE    "\n\r"
93 #define QUOTES     "\"\'"
94 #define COMMENTS   "#;"
95 #define GLOB_CHARS "*?["
96
97 /* What characters are special in the shell? */
98 /* must be escaped outside and inside double-quotes */
99 #define SHELL_NEED_ESCAPE "\"\\`$"
100 /* can be escaped or double-quoted */
101 #define SHELL_NEED_QUOTES SHELL_NEED_ESCAPE GLOB_CHARS "'()<>|&;"
102
103 #define FORMAT_BYTES_MAX 8
104
105 #define ANSI_HIGHLIGHT_ON "\x1B[1;39m"
106 #define ANSI_RED_ON "\x1B[31m"
107 #define ANSI_HIGHLIGHT_RED_ON "\x1B[1;31m"
108 #define ANSI_GREEN_ON "\x1B[32m"
109 #define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
110 #define ANSI_HIGHLIGHT_YELLOW_ON "\x1B[1;33m"
111 #define ANSI_HIGHLIGHT_BLUE_ON "\x1B[1;34m"
112 #define ANSI_HIGHLIGHT_OFF "\x1B[0m"
113 #define ANSI_ERASE_TO_END_OF_LINE "\x1B[K"
114
115 size_t page_size(void);
116 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
117
118 #define streq(a,b) (strcmp((a),(b)) == 0)
119 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
120 #define strcaseeq(a,b) (strcasecmp((a),(b)) == 0)
121 #define strncaseeq(a, b, n) (strncasecmp((a), (b), (n)) == 0)
122
123 bool streq_ptr(const char *a, const char *b) _pure_;
124
125 #define new(t, n) ((t*) malloc_multiply(sizeof(t), (n)))
126
127 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
128
129 #define newa(t, n) ((t*) alloca(sizeof(t)*(n)))
130
131 #define newdup(t, p, n) ((t*) memdup_multiply(p, sizeof(t), (n)))
132
133 #define malloc0(n) (calloc((n), 1))
134
135 static inline const char* yes_no(bool b) {
136         return b ? "yes" : "no";
137 }
138
139 static inline const char* true_false(bool b) {
140         return b ? "true" : "false";
141 }
142
143 static inline const char* strempty(const char *s) {
144         return s ? s : "";
145 }
146
147 static inline const char* strnull(const char *s) {
148         return s ? s : "(null)";
149 }
150
151 static inline const char *strna(const char *s) {
152         return s ? s : "n/a";
153 }
154
155 static inline bool isempty(const char *p) {
156         return !p || !p[0];
157 }
158
159 static inline const char *startswith(const char *s, const char *prefix) {
160         if (strncmp(s, prefix, strlen(prefix)) == 0)
161                 return s + strlen(prefix);
162         return NULL;
163 }
164
165 static inline const char *startswith_no_case(const char *s, const char *prefix) {
166         if (strncasecmp(s, prefix, strlen(prefix)) == 0)
167                 return s + strlen(prefix);
168         return NULL;
169 }
170
171 char *endswith(const char *s, const char *postfix) _pure_;
172
173 char *first_word(const char *s, const char *word) _pure_;
174
175 int close_nointr(int fd);
176 int safe_close(int fd);
177 void safe_close_pair(int p[]);
178
179 void close_many(const int fds[], unsigned n_fd);
180
181 int parse_size(const char *t, off_t base, off_t *size);
182
183 int parse_boolean(const char *v) _pure_;
184 int parse_pid(const char *s, pid_t* ret_pid);
185 int parse_uid(const char *s, uid_t* ret_uid);
186 #define parse_gid(s, ret_uid) parse_uid(s, ret_uid)
187
188 int safe_atou(const char *s, unsigned *ret_u);
189 int safe_atoi(const char *s, int *ret_i);
190
191 int safe_atollu(const char *s, unsigned long long *ret_u);
192 int safe_atolli(const char *s, long long int *ret_i);
193
194 int safe_atod(const char *s, double *ret_d);
195
196 int safe_atou8(const char *s, uint8_t *ret);
197
198 #if __WORDSIZE == 32
199 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
200         assert_cc(sizeof(unsigned long) == sizeof(unsigned));
201         return safe_atou(s, (unsigned*) ret_u);
202 }
203 static inline int safe_atoli(const char *s, long int *ret_u) {
204         assert_cc(sizeof(long int) == sizeof(int));
205         return safe_atoi(s, (int*) ret_u);
206 }
207 #else
208 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
209         assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
210         return safe_atollu(s, (unsigned long long*) ret_u);
211 }
212 static inline int safe_atoli(const char *s, long int *ret_u) {
213         assert_cc(sizeof(long int) == sizeof(long long int));
214         return safe_atolli(s, (long long int*) ret_u);
215 }
216 #endif
217
218 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
219         assert_cc(sizeof(uint32_t) == sizeof(unsigned));
220         return safe_atou(s, (unsigned*) ret_u);
221 }
222
223 static inline int safe_atoi32(const char *s, int32_t *ret_i) {
224         assert_cc(sizeof(int32_t) == sizeof(int));
225         return safe_atoi(s, (int*) ret_i);
226 }
227
228 static inline int safe_atou64(const char *s, uint64_t *ret_u) {
229         assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
230         return safe_atollu(s, (unsigned long long*) ret_u);
231 }
232
233 static inline int safe_atoi64(const char *s, int64_t *ret_i) {
234         assert_cc(sizeof(int64_t) == sizeof(long long int));
235         return safe_atolli(s, (long long int*) ret_i);
236 }
237
238 const char* split(const char **state, size_t *l, const char *separator, bool quoted);
239
240 #define FOREACH_WORD(word, length, s, state)                            \
241         _FOREACH_WORD(word, length, s, WHITESPACE, false, state)
242
243 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state)       \
244         _FOREACH_WORD(word, length, s, separator, false, state)
245
246 #define FOREACH_WORD_QUOTED(word, length, s, state)                     \
247         _FOREACH_WORD(word, length, s, WHITESPACE, true, state)
248
249 #define FOREACH_WORD_SEPARATOR_QUOTED(word, length, s, separator, state)       \
250         _FOREACH_WORD(word, length, s, separator, true, state)
251
252 #define _FOREACH_WORD(word, length, s, separator, quoted, state)        \
253         for ((state) = (s), (word) = split(&(state), &(length), (separator), (quoted)); (word); (word) = split(&(state), &(length), (separator), (quoted)))
254
255 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
256 int get_starttime_of_pid(pid_t pid, unsigned long long *st);
257
258 char *strappend(const char *s, const char *suffix);
259 char *strnappend(const char *s, const char *suffix, size_t length);
260
261 char *replace_env(const char *format, char **env);
262 char **replace_env_argv(char **argv, char **env);
263
264 int readlinkat_malloc(int fd, const char *p, char **ret);
265 int readlink_malloc(const char *p, char **r);
266 int readlink_and_make_absolute(const char *p, char **r);
267 int readlink_and_canonicalize(const char *p, char **r);
268
269 int reset_all_signal_handlers(void);
270
271 char *strstrip(char *s);
272 char *delete_chars(char *s, const char *bad);
273 char *truncate_nl(char *s);
274
275 char *file_in_same_dir(const char *path, const char *filename);
276
277 int rmdir_parents(const char *path, const char *stop);
278
279 int get_process_state(pid_t pid);
280 int get_process_comm(pid_t pid, char **name);
281 int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
282 int get_process_exe(pid_t pid, char **name);
283 int get_process_uid(pid_t pid, uid_t *uid);
284 int get_process_gid(pid_t pid, gid_t *gid);
285 int get_process_capeff(pid_t pid, char **capeff);
286
287 char hexchar(int x) _const_;
288 int unhexchar(char c) _const_;
289 char octchar(int x) _const_;
290 int unoctchar(char c) _const_;
291 char decchar(int x) _const_;
292 int undecchar(char c) _const_;
293
294 char *cescape(const char *s);
295 char *cunescape(const char *s);
296 char *cunescape_length(const char *s, size_t length);
297 char *cunescape_length_with_prefix(const char *s, size_t length, const char *prefix);
298
299 char *xescape(const char *s, const char *bad);
300
301 char *ascii_strlower(char *path);
302
303 bool dirent_is_file(const struct dirent *de) _pure_;
304 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix) _pure_;
305
306 bool ignore_file(const char *filename) _pure_;
307
308 bool chars_intersect(const char *a, const char *b) _pure_;
309
310 int make_stdio(int fd);
311 int make_null_stdio(void);
312 int make_console_stdio(void);
313
314 int dev_urandom(void *p, size_t n);
315 void random_bytes(void *p, size_t n);
316
317 static inline uint64_t random_u64(void) {
318         uint64_t u;
319         random_bytes(&u, sizeof(u));
320         return u;
321 }
322
323 static inline uint32_t random_u32(void) {
324         uint32_t u;
325         random_bytes(&u, sizeof(u));
326         return u;
327 }
328
329 /* For basic lookup tables with strictly enumerated entries */
330 #define __DEFINE_STRING_TABLE_LOOKUP(name,type,scope)                   \
331         scope const char *name##_to_string(type i) {                    \
332                 if (i < 0 || i >= (type) ELEMENTSOF(name##_table))      \
333                         return NULL;                                    \
334                 return name##_table[i];                                 \
335         }                                                               \
336         scope type name##_from_string(const char *s) {                  \
337                 type i;                                                 \
338                 if (!s)                                                 \
339                         return (type) -1;                               \
340                 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
341                         if (name##_table[i] &&                          \
342                             streq(name##_table[i], s))                  \
343                                 return i;                               \
344                 return (type) -1;                                       \
345         }                                                               \
346         struct __useless_struct_to_allow_trailing_semicolon__
347
348 #define DEFINE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,)
349 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,static)
350
351 /* For string conversions where numbers are also acceptable */
352 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max)         \
353         int name##_to_string_alloc(type i, char **str) {                \
354                 char *s;                                                \
355                 int r;                                                  \
356                 if (i < 0 || i > max)                                   \
357                         return -ERANGE;                                 \
358                 if (i < (type) ELEMENTSOF(name##_table)) {              \
359                         s = strdup(name##_table[i]);                    \
360                         if (!s)                                         \
361                                 return log_oom();                       \
362                 } else {                                                \
363                         r = asprintf(&s, "%u", i);                      \
364                         if (r < 0)                                      \
365                                 return log_oom();                       \
366                 }                                                       \
367                 *str = s;                                               \
368                 return 0;                                               \
369         }                                                               \
370         type name##_from_string(const char *s) {                        \
371                 type i;                                                 \
372                 unsigned u = 0;                                         \
373                 assert(s);                                              \
374                 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
375                         if (name##_table[i] &&                          \
376                             streq(name##_table[i], s))                  \
377                                 return i;                               \
378                 if (safe_atou(s, &u) >= 0 && u <= max)                  \
379                         return (type) u;                                \
380                 return (type) -1;                                       \
381         }                                                               \
382         struct __useless_struct_to_allow_trailing_semicolon__
383
384 int fd_nonblock(int fd, bool nonblock);
385 int fd_cloexec(int fd, bool cloexec);
386
387 int close_all_fds(const int except[], unsigned n_except);
388
389 bool fstype_is_network(const char *fstype);
390
391 int chvt(int vt);
392
393 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
394 int ask_char(char *ret, const char *replies, const char *text, ...) _printf_(3, 4);
395 int ask_string(char **ret, const char *text, ...) _printf_(2, 3);
396
397 int reset_terminal_fd(int fd, bool switch_to_text);
398 int reset_terminal(const char *name);
399
400 int open_terminal(const char *name, int mode);
401 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
402 int release_terminal(void);
403
404 int flush_fd(int fd);
405
406 int ignore_signals(int sig, ...);
407 int default_signals(int sig, ...);
408 int sigaction_many(const struct sigaction *sa, ...);
409
410 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
411
412 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
413 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
414
415 bool is_device_path(const char *path);
416
417 int dir_is_empty(const char *path);
418 char* dirname_malloc(const char *path);
419
420 void rename_process(const char name[8]);
421
422 void sigset_add_many(sigset_t *ss, ...);
423 int sigprocmask_many(int how, ...);
424
425 bool hostname_is_set(void);
426
427 char* gethostname_malloc(void);
428 char* getlogname_malloc(void);
429 char* getusername_malloc(void);
430
431 int getttyname_malloc(int fd, char **r);
432 int getttyname_harder(int fd, char **r);
433
434 int get_ctty_devnr(pid_t pid, dev_t *d);
435 int get_ctty(pid_t, dev_t *_devnr, char **r);
436
437 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
438 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
439
440 int rm_rf_children(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
441 int rm_rf_children_dangerous(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
442 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
443 int rm_rf_dangerous(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
444
445 int pipe_eof(int fd);
446
447 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
448
449 int status_vprintf(const char *status, bool ellipse, bool ephemeral, const char *format, va_list ap) _printf_(4,0);
450 int status_printf(const char *status, bool ellipse, bool ephemeral, const char *format, ...) _printf_(4,5);
451
452 int fd_columns(int fd);
453 unsigned columns(void);
454 int fd_lines(int fd);
455 unsigned lines(void);
456 void columns_lines_cache_reset(int _unused_ signum);
457
458 bool on_tty(void);
459
460 static inline const char *ansi_highlight(void) {
461         return on_tty() ? ANSI_HIGHLIGHT_ON : "";
462 }
463
464 static inline const char *ansi_highlight_red(void) {
465         return on_tty() ? ANSI_HIGHLIGHT_RED_ON : "";
466 }
467
468 static inline const char *ansi_highlight_green(void) {
469         return on_tty() ? ANSI_HIGHLIGHT_GREEN_ON : "";
470 }
471
472 static inline const char *ansi_highlight_yellow(void) {
473         return on_tty() ? ANSI_HIGHLIGHT_YELLOW_ON : "";
474 }
475
476 static inline const char *ansi_highlight_blue(void) {
477         return on_tty() ? ANSI_HIGHLIGHT_BLUE_ON : "";
478 }
479
480 static inline const char *ansi_highlight_off(void) {
481         return on_tty() ? ANSI_HIGHLIGHT_OFF : "";
482 }
483
484 int files_same(const char *filea, const char *fileb);
485
486 int running_in_chroot(void);
487
488 char *ellipsize(const char *s, size_t length, unsigned percent);
489                                    /* bytes                 columns */
490 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
491
492 int touch_file(const char *path, bool parents, usec_t stamp, uid_t uid, gid_t gid, mode_t mode);
493 int touch(const char *path);
494
495 char *unquote(const char *s, const char *quotes);
496 char *normalize_env_assignment(const char *s);
497
498 int wait_for_terminate(pid_t pid, siginfo_t *status);
499 int wait_for_terminate_and_warn(const char *name, pid_t pid);
500
501 noreturn void freeze(void);
502
503 bool null_or_empty(struct stat *st) _pure_;
504 int null_or_empty_path(const char *fn);
505 int null_or_empty_fd(int fd);
506
507 DIR *xopendirat(int dirfd, const char *name, int flags);
508
509 char *fstab_node_to_udev_node(const char *p);
510
511 char *resolve_dev_console(char **active);
512 bool tty_is_vc(const char *tty);
513 bool tty_is_vc_resolve(const char *tty);
514 bool tty_is_console(const char *tty) _pure_;
515 int vtnr_from_tty(const char *tty);
516 const char *default_term_for_tty(const char *tty);
517
518 void execute_directory(const char *directory, DIR *_d, usec_t timeout, char *argv[]);
519
520 int kill_and_sigcont(pid_t pid, int sig);
521
522 bool nulstr_contains(const char*nulstr, const char *needle);
523
524 bool plymouth_running(void);
525
526 bool hostname_is_valid(const char *s) _pure_;
527 char* hostname_cleanup(char *s, bool lowercase);
528
529 bool machine_name_is_valid(const char *s) _pure_;
530
531 char* strshorten(char *s, size_t l);
532
533 int terminal_vhangup_fd(int fd);
534 int terminal_vhangup(const char *name);
535
536 int vt_disallocate(const char *name);
537
538 int symlink_atomic(const char *from, const char *to);
539 int mknod_atomic(const char *path, mode_t mode, dev_t dev);
540 int mkfifo_atomic(const char *path, mode_t mode);
541
542 int fchmod_umask(int fd, mode_t mode);
543
544 bool display_is_local(const char *display) _pure_;
545 int socket_from_display(const char *display, char **path);
546
547 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
548 int get_group_creds(const char **groupname, gid_t *gid);
549
550 int in_gid(gid_t gid);
551 int in_group(const char *name);
552
553 char* uid_to_name(uid_t uid);
554 char* gid_to_name(gid_t gid);
555
556 int glob_exists(const char *path);
557 int glob_extend(char ***strv, const char *path);
558
559 int dirent_ensure_type(DIR *d, struct dirent *de);
560
561 int get_files_in_directory(const char *path, char ***list);
562
563 char *strjoin(const char *x, ...) _sentinel_;
564
565 bool is_main_thread(void);
566
567 static inline bool _pure_ in_charset(const char *s, const char* charset) {
568         assert(s);
569         assert(charset);
570         return s[strspn(s, charset)] == '\0';
571 }
572
573 int block_get_whole_disk(dev_t d, dev_t *ret);
574
575 int file_is_priv_sticky(const char *p);
576
577 int strdup_or_null(const char *a, char **b);
578
579 #define NULSTR_FOREACH(i, l)                                    \
580         for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
581
582 #define NULSTR_FOREACH_PAIR(i, j, l)                             \
583         for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
584
585 int ioprio_class_to_string_alloc(int i, char **s);
586 int ioprio_class_from_string(const char *s);
587
588 const char *sigchld_code_to_string(int i) _const_;
589 int sigchld_code_from_string(const char *s) _pure_;
590
591 int log_facility_unshifted_to_string_alloc(int i, char **s);
592 int log_facility_unshifted_from_string(const char *s);
593
594 int log_level_to_string_alloc(int i, char **s);
595 int log_level_from_string(const char *s);
596
597 int sched_policy_to_string_alloc(int i, char **s);
598 int sched_policy_from_string(const char *s);
599
600 const char *rlimit_to_string(int i) _const_;
601 int rlimit_from_string(const char *s) _pure_;
602
603 int ip_tos_to_string_alloc(int i, char **s);
604 int ip_tos_from_string(const char *s);
605
606 const char *signal_to_string(int i) _const_;
607 int signal_from_string(const char *s) _pure_;
608
609 int signal_from_string_try_harder(const char *s);
610
611 extern int saved_argc;
612 extern char **saved_argv;
613
614 bool kexec_loaded(void);
615
616 int prot_from_flags(int flags) _const_;
617
618 char *format_bytes(char *buf, size_t l, off_t t);
619
620 int fd_wait_for_event(int fd, int event, usec_t timeout);
621
622 void* memdup(const void *p, size_t l) _alloc_(2);
623
624 int is_kernel_thread(pid_t pid);
625
626 int fd_inc_sndbuf(int fd, size_t n);
627 int fd_inc_rcvbuf(int fd, size_t n);
628
629 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
630
631 int setrlimit_closest(int resource, const struct rlimit *rlim);
632
633 int getenv_for_pid(pid_t pid, const char *field, char **_value);
634
635 bool is_valid_documentation_url(const char *url) _pure_;
636
637 bool in_initrd(void);
638
639 void warn_melody(void);
640
641 int get_home_dir(char **ret);
642 int get_shell(char **_ret);
643
644 static inline void freep(void *p) {
645         free(*(void**) p);
646 }
647
648 #define DEFINE_TRIVIAL_CLEANUP_FUNC(type, func)                 \
649         static inline void func##p(type *p) {                   \
650                 if (*p)                                         \
651                         func(*p);                               \
652         }                                                       \
653         struct __useless_struct_to_allow_trailing_semicolon__
654
655 static inline void closep(int *fd) {
656         safe_close(*fd);
657 }
658
659 static inline void umaskp(mode_t *u) {
660         umask(*u);
661 }
662
663 static inline void close_pairp(int (*p)[2]) {
664         safe_close_pair(*p);
665 }
666
667 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, fclose);
668 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, pclose);
669 DEFINE_TRIVIAL_CLEANUP_FUNC(DIR*, closedir);
670 DEFINE_TRIVIAL_CLEANUP_FUNC(FILE*, endmntent);
671
672 #define _cleanup_free_ _cleanup_(freep)
673 #define _cleanup_close_ _cleanup_(closep)
674 #define _cleanup_umask_ _cleanup_(umaskp)
675 #define _cleanup_globfree_ _cleanup_(globfree)
676 #define _cleanup_fclose_ _cleanup_(fclosep)
677 #define _cleanup_pclose_ _cleanup_(pclosep)
678 #define _cleanup_closedir_ _cleanup_(closedirp)
679 #define _cleanup_endmntent_ _cleanup_(endmntentp)
680 #define _cleanup_close_pair_ _cleanup_(close_pairp)
681
682 _malloc_  _alloc_(1, 2) static inline void *malloc_multiply(size_t a, size_t b) {
683         if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
684                 return NULL;
685
686         return malloc(a * b);
687 }
688
689 _alloc_(2, 3) static inline void *realloc_multiply(void *p, size_t a, size_t b) {
690         if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
691                 return NULL;
692
693         return realloc(p, a * b);
694 }
695
696 _alloc_(2, 3) static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
697         if (_unlikely_(b != 0 && a > ((size_t) -1) / b))
698                 return NULL;
699
700         return memdup(p, a * b);
701 }
702
703 bool filename_is_safe(const char *p) _pure_;
704 bool path_is_safe(const char *p) _pure_;
705 bool string_is_safe(const char *p) _pure_;
706 bool string_has_cc(const char *p, const char *ok) _pure_;
707
708 /**
709  * Check if a string contains any glob patterns.
710  */
711 _pure_ static inline bool string_is_glob(const char *p) {
712         return !!strpbrk(p, GLOB_CHARS);
713 }
714
715 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
716                  int (*compar) (const void *, const void *, void *),
717                  void *arg);
718
719 bool is_locale_utf8(void);
720
721 typedef enum DrawSpecialChar {
722         DRAW_TREE_VERTICAL,
723         DRAW_TREE_BRANCH,
724         DRAW_TREE_RIGHT,
725         DRAW_TREE_SPACE,
726         DRAW_TRIANGULAR_BULLET,
727         DRAW_BLACK_CIRCLE,
728         DRAW_ARROW,
729         DRAW_DASH,
730         _DRAW_SPECIAL_CHAR_MAX
731 } DrawSpecialChar;
732
733 const char *draw_special_char(DrawSpecialChar ch);
734
735 char *strreplace(const char *text, const char *old_string, const char *new_string);
736
737 char *strip_tab_ansi(char **p, size_t *l);
738
739 int on_ac_power(void);
740
741 int search_and_fopen(const char *path, const char *mode, const char *root, const char **search, FILE **_f);
742 int search_and_fopen_nulstr(const char *path, const char *mode, const char *root, const char *search, FILE **_f);
743
744 #define FOREACH_LINE(line, f, on_error)                         \
745         for (;;)                                                \
746                 if (!fgets(line, sizeof(line), f)) {            \
747                         if (ferror(f)) {                        \
748                                 on_error;                       \
749                         }                                       \
750                         break;                                  \
751                 } else
752
753 #define FOREACH_DIRENT(de, d, on_error)                                 \
754         for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d))   \
755                 if (!de) {                                              \
756                         if (errno > 0) {                                \
757                                 on_error;                               \
758                         }                                               \
759                         break;                                          \
760                 } else if (ignore_file((de)->d_name))                   \
761                         continue;                                       \
762                 else
763
764 static inline void *mempset(void *s, int c, size_t n) {
765         memset(s, c, n);
766         return (uint8_t*)s + n;
767 }
768
769 char *hexmem(const void *p, size_t l);
770 void *unhexmem(const char *p, size_t l);
771
772 char *strextend(char **x, ...) _sentinel_;
773 char *strrep(const char *s, unsigned n);
774
775 void* greedy_realloc(void **p, size_t *allocated, size_t need, size_t size);
776 void* greedy_realloc0(void **p, size_t *allocated, size_t need, size_t size);
777 #define GREEDY_REALLOC(array, allocated, need)                          \
778         greedy_realloc((void**) &(array), &(allocated), (need), sizeof((array)[0]))
779
780 #define GREEDY_REALLOC0(array, allocated, need)                         \
781         greedy_realloc0((void**) &(array), &(allocated), (need), sizeof((array)[0]))
782
783 static inline void _reset_errno_(int *saved_errno) {
784         errno = *saved_errno;
785 }
786
787 #define PROTECT_ERRNO _cleanup_(_reset_errno_) __attribute__((unused)) int _saved_errno_ = errno
788
789 struct _umask_struct_ {
790         mode_t mask;
791         bool quit;
792 };
793
794 static inline void _reset_umask_(struct _umask_struct_ *s) {
795         umask(s->mask);
796 };
797
798 #define RUN_WITH_UMASK(mask)                                            \
799         for (_cleanup_(_reset_umask_) struct _umask_struct_ _saved_umask_ = { umask(mask), false }; \
800              !_saved_umask_.quit ;                                      \
801              _saved_umask_.quit = true)
802
803 static inline unsigned u64log2(uint64_t n) {
804 #if __SIZEOF_LONG_LONG__ == 8
805         return (n > 1) ? (unsigned) __builtin_clzll(n) ^ 63U : 0;
806 #else
807 #error "Wut?"
808 #endif
809 }
810
811 static inline unsigned u32ctz(uint32_t n) {
812 #if __SIZEOF_INT__ == 4
813         return __builtin_ctz(n);
814 #else
815 #error "Wut?"
816 #endif
817 }
818
819 static inline int log2i(int x) {
820         assert(x > 0);
821
822         return __SIZEOF_INT__ * 8 - __builtin_clz(x) - 1;
823 }
824
825 static inline bool logind_running(void) {
826         return access("/run/systemd/seats/", F_OK) >= 0;
827 }
828
829 #define DECIMAL_STR_WIDTH(x)                            \
830         ({                                              \
831                 typeof(x) _x_ = (x);                    \
832                 unsigned ans = 1;                       \
833                 while (_x_ /= 10)                       \
834                         ans++;                          \
835                 ans;                                    \
836         })
837
838 int unlink_noerrno(const char *path);
839
840 #define alloca0(n)                                      \
841         ({                                              \
842                 char *_new_;                            \
843                 size_t _len_ = n;                       \
844                 _new_ = alloca(_len_);                  \
845                 (void *) memset(_new_, 0, _len_);       \
846         })
847
848 #define strappenda(a, ...)                                       \
849         ({                                                       \
850                 int _len = strlen(a);                            \
851                 unsigned _i;                                     \
852                 char *_d_, *_p_;                                 \
853                 const char *_appendees_[] = { __VA_ARGS__ };     \
854                 for (_i = 0; _i < ELEMENTSOF(_appendees_); _i++) \
855                         _len += strlen(_appendees_[_i]);         \
856                 _d_ = alloca(_len + 1);                          \
857                 _p_ = stpcpy(_d_, a);                            \
858                 for (_i = 0; _i < ELEMENTSOF(_appendees_); _i++) \
859                         _p_ = stpcpy(_p_, _appendees_[_i]);      \
860                 _d_;                                             \
861         })
862
863 #define procfs_file_alloca(pid, field)                                  \
864         ({                                                              \
865                 pid_t _pid_ = (pid);                                    \
866                 const char *_r_;                                        \
867                 if (_pid_ == 0) {                                       \
868                         _r_ = ("/proc/self/" field);                    \
869                 } else {                                                \
870                         _r_ = alloca(strlen("/proc/") + DECIMAL_STR_MAX(pid_t) + 1 + sizeof(field)); \
871                         sprintf((char*) _r_, "/proc/"PID_FMT"/" field, _pid_);                       \
872                 }                                                       \
873                 _r_;                                                    \
874         })
875
876 struct _locale_struct_ {
877         locale_t saved_locale;
878         locale_t new_locale;
879         bool quit;
880 };
881
882 static inline void _reset_locale_(struct _locale_struct_ *s) {
883         PROTECT_ERRNO;
884         if (s->saved_locale != (locale_t) 0)
885                 uselocale(s->saved_locale);
886         if (s->new_locale != (locale_t) 0)
887                 freelocale(s->new_locale);
888 }
889
890 #define RUN_WITH_LOCALE(mask, loc) \
891         for (_cleanup_(_reset_locale_) struct _locale_struct_ _saved_locale_ = { (locale_t) 0, (locale_t) 0, false }; \
892              ({                                                         \
893                      if (!_saved_locale_.quit) {                        \
894                              PROTECT_ERRNO;                             \
895                              _saved_locale_.new_locale = newlocale((mask), (loc), (locale_t) 0); \
896                              if (_saved_locale_.new_locale != (locale_t) 0)     \
897                                      _saved_locale_.saved_locale = uselocale(_saved_locale_.new_locale); \
898                      }                                                  \
899                      !_saved_locale_.quit; }) ;                         \
900              _saved_locale_.quit = true)
901
902 bool id128_is_valid(const char *s) _pure_;
903
904 int split_pair(const char *s, const char *sep, char **l, char **r);
905
906 int shall_restore_state(void);
907
908 /**
909  * Normal qsort requires base to be nonnull. Here were require
910  * that only if nmemb > 0.
911  */
912 static inline void qsort_safe(void *base, size_t nmemb, size_t size,
913                               int (*compar)(const void *, const void *)) {
914         if (nmemb) {
915                 assert(base);
916                 qsort(base, nmemb, size, compar);
917         }
918 }
919
920 int proc_cmdline(char **ret);
921 int parse_proc_cmdline(int (*parse_word)(const char *key, const char *value));
922
923 int container_get_leader(const char *machine, pid_t *pid);
924
925 int namespace_open(pid_t pid, int *pidns_fd, int *mntns_fd, int *netns_fd, int *root_fd);
926 int namespace_enter(int pidns_fd, int mntns_fd, int netns_fd, int root_fd);
927
928 bool pid_is_alive(pid_t pid);
929 bool pid_is_unwaited(pid_t pid);
930
931 int getpeercred(int fd, struct ucred *ucred);
932 int getpeersec(int fd, char **ret);
933
934 int writev_safe(int fd, const struct iovec *w, int j);
935
936 int mkostemp_safe(char *pattern, int flags);
937 int open_tmpfile(const char *path, int flags);
938
939 int fd_warn_permissions(const char *path, int fd);
940
941 unsigned long personality_from_string(const char *p);
942 const char *personality_to_string(unsigned long);
943
944 uint64_t physical_memory(void);
945
946 char* mount_test_option(const char *haystack, const char *needle);
947
948 void hexdump(FILE *f, const void *p, size_t s);
949
950 union file_handle_union {
951         struct file_handle handle;
952         char padding[sizeof(struct file_handle) + MAX_HANDLE_SZ];
953 };
954
955 int update_reboot_param_file(const char *param);
956
957 int umount_recursive(const char *target, int flags);
958
959 int bind_remount_recursive(const char *prefix, bool ro);
960
961 int fflush_and_check(FILE *f);
962
963 char *tempfn_xxxxxx(const char *p);
964 char *tempfn_random(const char *p);
965
966 bool is_localhost(const char *hostname);
967
968 int take_password_lock(const char *root);
969
970 int is_symlink(const char *path);