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