chiark / gitweb /
journalctl: give a nice hint about group membership based on ACLs of /var/log/journal
[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 <inttypes.h>
25 #include <time.h>
26 #include <sys/time.h>
27 #include <stdarg.h>
28 #include <stdbool.h>
29 #include <stdlib.h>
30 #include <stdio.h>
31 #include <signal.h>
32 #include <sched.h>
33 #include <limits.h>
34 #include <sys/types.h>
35 #include <sys/stat.h>
36 #include <dirent.h>
37 #include <sys/resource.h>
38 #include <stddef.h>
39 #include <systemd/sd-journal.h>
40
41 #include "macro.h"
42 #include "time-util.h"
43
44 union dirent_storage {
45         struct dirent de;
46         uint8_t storage[offsetof(struct dirent, d_name) +
47                         ((NAME_MAX + 1 + sizeof(long)) & ~(sizeof(long) - 1))];
48 };
49
50 /* What is interpreted as whitespace? */
51 #define WHITESPACE " \t\n\r"
52 #define NEWLINE "\n\r"
53 #define QUOTES "\"\'"
54 #define COMMENTS "#;\n"
55
56 #define FORMAT_BYTES_MAX 8
57
58 #define ANSI_HIGHLIGHT_ON "\x1B[1;39m"
59 #define ANSI_RED_ON "\x1B[31m"
60 #define ANSI_HIGHLIGHT_RED_ON "\x1B[1;31m"
61 #define ANSI_GREEN_ON "\x1B[32m"
62 #define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
63 #define ANSI_HIGHLIGHT_YELLOW_ON "\x1B[1;33m"
64 #define ANSI_HIGHLIGHT_OFF "\x1B[0m"
65 #define ANSI_ERASE_TO_END_OF_LINE "\x1B[K"
66
67 size_t page_size(void);
68 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
69
70 #define streq(a,b) (strcmp((a),(b)) == 0)
71 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
72 #define strcaseeq(a,b) (strcasecmp((a),(b)) == 0)
73 #define strncaseeq(a, b, n) (strncasecmp((a), (b), (n)) == 0)
74
75 bool streq_ptr(const char *a, const char *b);
76
77 #define new(t, n) ((t*) malloc_multiply(sizeof(t), (n)))
78
79 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
80
81 #define newa(t, n) ((t*) alloca(sizeof(t)*(n)))
82
83 #define newdup(t, p, n) ((t*) memdup_multiply(p, sizeof(t), (n)))
84
85 #define malloc0(n) (calloc((n), 1))
86
87 static inline const char* yes_no(bool b) {
88         return b ? "yes" : "no";
89 }
90
91 static inline const char* strempty(const char *s) {
92         return s ? s : "";
93 }
94
95 static inline const char* strnull(const char *s) {
96         return s ? s : "(null)";
97 }
98
99 static inline const char *strna(const char *s) {
100         return s ? s : "n/a";
101 }
102
103 static inline bool isempty(const char *p) {
104         return !p || !p[0];
105 }
106
107 char *endswith(const char *s, const char *postfix);
108 char *startswith(const char *s, const char *prefix);
109 char *startswith_no_case(const char *s, const char *prefix);
110
111 bool first_word(const char *s, const char *word);
112
113 int close_nointr(int fd);
114 void close_nointr_nofail(int fd);
115 void close_many(const int fds[], unsigned n_fd);
116
117 int parse_boolean(const char *v);
118 int parse_bytes(const char *t, off_t *bytes);
119 int parse_pid(const char *s, pid_t* ret_pid);
120 int parse_uid(const char *s, uid_t* ret_uid);
121 #define parse_gid(s, ret_uid) parse_uid(s, ret_uid)
122
123 int safe_atou(const char *s, unsigned *ret_u);
124 int safe_atoi(const char *s, int *ret_i);
125
126 int safe_atollu(const char *s, unsigned long long *ret_u);
127 int safe_atolli(const char *s, long long int *ret_i);
128
129 int safe_atod(const char *s, double *ret_d);
130
131 #if __WORDSIZE == 32
132 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
133         assert_cc(sizeof(unsigned long) == sizeof(unsigned));
134         return safe_atou(s, (unsigned*) ret_u);
135 }
136 static inline int safe_atoli(const char *s, long int *ret_u) {
137         assert_cc(sizeof(long int) == sizeof(int));
138         return safe_atoi(s, (int*) ret_u);
139 }
140 #else
141 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
142         assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
143         return safe_atollu(s, (unsigned long long*) ret_u);
144 }
145 static inline int safe_atoli(const char *s, long int *ret_u) {
146         assert_cc(sizeof(long int) == sizeof(long long int));
147         return safe_atolli(s, (long long int*) ret_u);
148 }
149 #endif
150
151 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
152         assert_cc(sizeof(uint32_t) == sizeof(unsigned));
153         return safe_atou(s, (unsigned*) ret_u);
154 }
155
156 static inline int safe_atoi32(const char *s, int32_t *ret_i) {
157         assert_cc(sizeof(int32_t) == sizeof(int));
158         return safe_atoi(s, (int*) ret_i);
159 }
160
161 static inline int safe_atou64(const char *s, uint64_t *ret_u) {
162         assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
163         return safe_atollu(s, (unsigned long long*) ret_u);
164 }
165
166 static inline int safe_atoi64(const char *s, int64_t *ret_i) {
167         assert_cc(sizeof(int64_t) == sizeof(long long int));
168         return safe_atolli(s, (long long int*) ret_i);
169 }
170
171 char *split(const char *c, size_t *l, const char *separator, char **state);
172 char *split_quoted(const char *c, size_t *l, char **state);
173
174 #define FOREACH_WORD(word, length, s, state)                            \
175         for ((state) = NULL, (word) = split((s), &(length), WHITESPACE, &(state)); (word); (word) = split((s), &(length), WHITESPACE, &(state)))
176
177 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state)       \
178         for ((state) = NULL, (word) = split((s), &(length), (separator), &(state)); (word); (word) = split((s), &(length), (separator), &(state)))
179
180 #define FOREACH_WORD_QUOTED(word, length, s, state)                     \
181         for ((state) = NULL, (word) = split_quoted((s), &(length), &(state)); (word); (word) = split_quoted((s), &(length), &(state)))
182
183 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
184 int get_starttime_of_pid(pid_t pid, unsigned long long *st);
185
186 char *strappend(const char *s, const char *suffix);
187 char *strnappend(const char *s, const char *suffix, size_t length);
188
189 char *replace_env(const char *format, char **env);
190 char **replace_env_argv(char **argv, char **env);
191
192 int readlink_malloc(const char *p, char **r);
193 int readlink_and_make_absolute(const char *p, char **r);
194 int readlink_and_canonicalize(const char *p, char **r);
195
196 int reset_all_signal_handlers(void);
197
198 char *strstrip(char *s);
199 char *delete_chars(char *s, const char *bad);
200 char *truncate_nl(char *s);
201
202 char *file_in_same_dir(const char *path, const char *filename);
203
204 int rmdir_parents(const char *path, const char *stop);
205
206 int get_process_comm(pid_t pid, char **name);
207 int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
208 int get_process_exe(pid_t pid, char **name);
209 int get_process_uid(pid_t pid, uid_t *uid);
210 int get_process_gid(pid_t pid, gid_t *gid);
211
212 char hexchar(int x);
213 int unhexchar(char c);
214 char octchar(int x);
215 int unoctchar(char c);
216 char decchar(int x);
217 int undecchar(char c);
218
219 char *cescape(const char *s);
220 char *cunescape(const char *s);
221 char *cunescape_length(const char *s, size_t length);
222 char *cunescape_length_with_prefix(const char *s, size_t length, const char *prefix);
223
224 char *xescape(const char *s, const char *bad);
225
226 char *bus_path_escape(const char *s);
227 char *bus_path_unescape(const char *s);
228
229 char *ascii_strlower(char *path);
230
231 bool dirent_is_file(const struct dirent *de);
232 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix);
233
234 bool ignore_file(const char *filename);
235
236 bool chars_intersect(const char *a, const char *b);
237
238 int make_stdio(int fd);
239 int make_null_stdio(void);
240 int make_console_stdio(void);
241
242 unsigned long long random_ull(void);
243
244 /* For basic lookup tables with strictly enumerated entries */
245 #define __DEFINE_STRING_TABLE_LOOKUP(name,type,scope)                   \
246         scope const char *name##_to_string(type i) {                    \
247                 if (i < 0 || i >= (type) ELEMENTSOF(name##_table))      \
248                         return NULL;                                    \
249                 return name##_table[i];                                 \
250         }                                                               \
251         scope type name##_from_string(const char *s) {                  \
252                 type i;                                                 \
253                 assert(s);                                              \
254                 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
255                         if (name##_table[i] &&                          \
256                             streq(name##_table[i], s))                  \
257                                 return i;                               \
258                 return (type) -1;                                       \
259         }                                                               \
260         struct __useless_struct_to_allow_trailing_semicolon__
261
262 #define DEFINE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,)
263 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,static)
264
265 /* For string conversions where numbers are also acceptable */
266 #define DEFINE_STRING_TABLE_LOOKUP_WITH_FALLBACK(name,type,max)         \
267         int name##_to_string_alloc(type i, char **str) {                \
268                 char *s;                                                \
269                 int r;                                                  \
270                 if (i < 0 || i > max)                                   \
271                         return -ERANGE;                                 \
272                 if (i < (type) ELEMENTSOF(name##_table)) {              \
273                         s = strdup(name##_table[i]);                    \
274                         if (!s)                                         \
275                                 return log_oom();                       \
276                 } else {                                                \
277                         r = asprintf(&s, "%u", i);                      \
278                         if (r < 0)                                      \
279                                 return log_oom();                       \
280                 }                                                       \
281                 *str = s;                                               \
282                 return 0;                                               \
283         }                                                               \
284         type name##_from_string(const char *s) {                        \
285                 type i;                                                 \
286                 unsigned u = 0;                                         \
287                 assert(s);                                              \
288                 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
289                         if (name##_table[i] &&                          \
290                             streq(name##_table[i], s))                  \
291                                 return i;                               \
292                 if (safe_atou(s, &u) >= 0 && u <= max)                  \
293                         return (type) u;                                \
294                 return (type) -1;                                       \
295         }                                                               \
296         struct __useless_struct_to_allow_trailing_semicolon__
297
298 int fd_nonblock(int fd, bool nonblock);
299 int fd_cloexec(int fd, bool cloexec);
300
301 int close_all_fds(const int except[], unsigned n_except);
302
303 bool fstype_is_network(const char *fstype);
304
305 int chvt(int vt);
306
307 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
308 int ask(char *ret, const char *replies, const char *text, ...);
309
310 int reset_terminal_fd(int fd, bool switch_to_text);
311 int reset_terminal(const char *name);
312
313 int open_terminal(const char *name, int mode);
314 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
315 int release_terminal(void);
316
317 int flush_fd(int fd);
318
319 int ignore_signals(int sig, ...);
320 int default_signals(int sig, ...);
321 int sigaction_many(const struct sigaction *sa, ...);
322
323 int close_pipe(int p[]);
324 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
325
326 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
327 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
328
329 bool is_device_path(const char *path);
330
331 int dir_is_empty(const char *path);
332
333 void rename_process(const char name[8]);
334
335 void sigset_add_many(sigset_t *ss, ...);
336
337 bool hostname_is_set(void);
338
339 char* gethostname_malloc(void);
340 char* getlogname_malloc(void);
341 char* getusername_malloc(void);
342
343 int getttyname_malloc(int fd, char **r);
344 int getttyname_harder(int fd, char **r);
345
346 int get_ctty_devnr(pid_t pid, dev_t *d);
347 int get_ctty(pid_t, dev_t *_devnr, char **r);
348
349 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
350 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
351
352 int rm_rf_children(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
353 int rm_rf_children_dangerous(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
354 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
355 int rm_rf_dangerous(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
356
357 int pipe_eof(int fd);
358
359 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
360
361 int status_vprintf(const char *status, bool ellipse, bool ephemeral, const char *format, va_list ap);
362 int status_printf(const char *status, bool ellipse, bool ephemeral, const char *format, ...);
363 int status_welcome(void);
364
365 int fd_columns(int fd);
366 unsigned columns(void);
367 int fd_lines(int fd);
368 unsigned lines(void);
369 void columns_lines_cache_reset(int _unused_ signum);
370
371 bool on_tty(void);
372
373 int running_in_chroot(void);
374
375 char *ellipsize(const char *s, size_t length, unsigned percent);
376 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
377
378 int touch(const char *path);
379
380 char *unquote(const char *s, const char *quotes);
381 char *normalize_env_assignment(const char *s);
382
383 int wait_for_terminate(pid_t pid, siginfo_t *status);
384 int wait_for_terminate_and_warn(const char *name, pid_t pid);
385
386 _noreturn_ void freeze(void);
387
388 bool null_or_empty(struct stat *st);
389 int null_or_empty_path(const char *fn);
390
391 DIR *xopendirat(int dirfd, const char *name, int flags);
392
393 char *fstab_node_to_udev_node(const char *p);
394
395 char *resolve_dev_console(char **active);
396 bool tty_is_vc(const char *tty);
397 bool tty_is_vc_resolve(const char *tty);
398 bool tty_is_console(const char *tty);
399 int vtnr_from_tty(const char *tty);
400 const char *default_term_for_tty(const char *tty);
401
402 void execute_directory(const char *directory, DIR *_d, char *argv[]);
403
404 int kill_and_sigcont(pid_t pid, int sig);
405
406 bool nulstr_contains(const char*nulstr, const char *needle);
407
408 bool plymouth_running(void);
409
410 bool hostname_is_valid(const char *s);
411 char* hostname_cleanup(char *s);
412
413 char* strshorten(char *s, size_t l);
414
415 int terminal_vhangup_fd(int fd);
416 int terminal_vhangup(const char *name);
417
418 int vt_disallocate(const char *name);
419
420 int copy_file(const char *from, const char *to);
421
422 int symlink_atomic(const char *from, const char *to);
423
424 int fchmod_umask(int fd, mode_t mode);
425
426 bool display_is_local(const char *display);
427 int socket_from_display(const char *display, char **path);
428
429 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
430 int get_group_creds(const char **groupname, gid_t *gid);
431
432 int in_gid(gid_t gid);
433 int in_group(const char *name);
434
435 char* uid_to_name(uid_t uid);
436 char* gid_to_name(gid_t gid);
437
438 int glob_exists(const char *path);
439
440 int dirent_ensure_type(DIR *d, struct dirent *de);
441
442 int in_search_path(const char *path, char **search);
443 int get_files_in_directory(const char *path, char ***list);
444
445 char *strjoin(const char *x, ...) _sentinel_;
446
447 bool is_main_thread(void);
448
449 bool in_charset(const char *s, const char* charset);
450
451 int block_get_whole_disk(dev_t d, dev_t *ret);
452
453 int file_is_priv_sticky(const char *p);
454
455 int strdup_or_null(const char *a, char **b);
456
457 #define NULSTR_FOREACH(i, l)                                    \
458         for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
459
460 #define NULSTR_FOREACH_PAIR(i, j, l)                             \
461         for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
462
463 int ioprio_class_to_string_alloc(int i, char **s);
464 int ioprio_class_from_string(const char *s);
465
466 const char *sigchld_code_to_string(int i);
467 int sigchld_code_from_string(const char *s);
468
469 int log_facility_unshifted_to_string_alloc(int i, char **s);
470 int log_facility_unshifted_from_string(const char *s);
471
472 int log_level_to_string_alloc(int i, char **s);
473 int log_level_from_string(const char *s);
474
475 int sched_policy_to_string_alloc(int i, char **s);
476 int sched_policy_from_string(const char *s);
477
478 const char *rlimit_to_string(int i);
479 int rlimit_from_string(const char *s);
480
481 int ip_tos_to_string_alloc(int i, char **s);
482 int ip_tos_from_string(const char *s);
483
484 const char *signal_to_string(int i);
485 int signal_from_string(const char *s);
486
487 int signal_from_string_try_harder(const char *s);
488
489 extern int saved_argc;
490 extern char **saved_argv;
491
492 bool kexec_loaded(void);
493
494 int prot_from_flags(int flags);
495
496 char *format_bytes(char *buf, size_t l, off_t t);
497
498 int fd_wait_for_event(int fd, int event, usec_t timeout);
499
500 void* memdup(const void *p, size_t l) _malloc_;
501
502 int is_kernel_thread(pid_t pid);
503
504 int fd_inc_sndbuf(int fd, size_t n);
505 int fd_inc_rcvbuf(int fd, size_t n);
506
507 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
508
509 int setrlimit_closest(int resource, const struct rlimit *rlim);
510
511 int getenv_for_pid(pid_t pid, const char *field, char **_value);
512
513 int can_sleep(const char *type);
514 int can_sleep_disk(const char *type);
515
516 bool is_valid_documentation_url(const char *url);
517
518 bool in_initrd(void);
519
520 void warn_melody(void);
521
522 int get_shell(char **ret);
523 int get_home_dir(char **ret);
524
525 static inline void freep(void *p) {
526         free(*(void**) p);
527 }
528
529 void fclosep(FILE **f);
530 void pclosep(FILE **f);
531 void closep(int *fd);
532 void closedirp(DIR **d);
533 static inline void umaskp(mode_t *u) {
534         umask(*u);
535 }
536
537 static inline void journal_closep(sd_journal **j) {
538         sd_journal_close(*j);
539 }
540
541 _malloc_  static inline void *malloc_multiply(size_t a, size_t b) {
542         if (_unlikely_(b == 0 || a > ((size_t) -1) / b))
543                 return NULL;
544
545         return malloc(a * b);
546 }
547
548 _malloc_ static inline void *memdup_multiply(const void *p, size_t a, size_t b) {
549         if (_unlikely_(b == 0 || a > ((size_t) -1) / b))
550                 return NULL;
551
552         return memdup(p, a * b);
553 }
554
555 bool filename_is_safe(const char *p);
556 bool path_is_safe(const char *p);
557 bool string_is_safe(const char *p);
558 bool string_has_cc(const char *p);
559
560 void *xbsearch_r(const void *key, const void *base, size_t nmemb, size_t size,
561                  int (*compar) (const void *, const void *, void *),
562                  void *arg);
563
564 bool is_locale_utf8(void);
565
566 typedef enum DrawSpecialChar {
567         DRAW_TREE_VERT,
568         DRAW_TREE_BRANCH,
569         DRAW_TREE_RIGHT,
570         DRAW_TREE_SPACE,
571         DRAW_TRIANGULAR_BULLET,
572         _DRAW_SPECIAL_CHAR_MAX
573 } DrawSpecialChar;
574 const char *draw_special_char(DrawSpecialChar ch);
575
576 char *strreplace(const char *text, const char *old_string, const char *new_string);
577
578 char *strip_tab_ansi(char **p, size_t *l);
579
580 int on_ac_power(void);
581
582 int search_and_fopen(const char *path, const char *mode, const char **search, FILE **_f);
583 int search_and_fopen_nulstr(const char *path, const char *mode, const char *search, FILE **_f);
584 int create_tmp_dir(char template[], char** dir_name);
585
586 #define FOREACH_LINE(line, f, on_error)                         \
587         for (;;)                                                \
588                 if (!fgets(line, sizeof(line), f)) {            \
589                         if (ferror(f)) {                        \
590                                 on_error;                       \
591                         }                                       \
592                         break;                                  \
593                 } else
594
595 #define FOREACH_DIRENT(de, d, on_error)                                 \
596         for (errno = 0, de = readdir(d);; errno = 0, de = readdir(d))   \
597                 if (!de) {                                              \
598                         if (errno != 0) {                               \
599                                 on_error;                               \
600                         }                                               \
601                         break;                                          \
602                 } else if (ignore_file((de)->d_name))                   \
603                         continue;                                       \
604                 else
605
606 static inline void *mempset(void *s, int c, size_t n) {
607         memset(s, c, n);
608         return (char*)s + n;
609 }
610
611 char *hexmem(const void *p, size_t l);
612 char *strextend(char **x, ...);
613 char *strrep(const char *s, unsigned n);