chiark / gitweb /
efb2c7d324afa0858212c6922ad09c52e401cd9a
[elogind.git] / src / shared / util.h
1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
2
3 #ifndef fooutilhfoo
4 #define fooutilhfoo
5
6 /***
7   This file is part of systemd.
8
9   Copyright 2010 Lennart Poettering
10
11   systemd is free software; you can redistribute it and/or modify it
12   under the terms of the GNU Lesser General Public License as published by
13   the Free Software Foundation; either version 2.1 of the License, or
14   (at your option) any later version.
15
16   systemd is distributed in the hope that it will be useful, but
17   WITHOUT ANY WARRANTY; without even the implied warranty of
18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19   Lesser General Public License for more details.
20
21   You should have received a copy of the GNU Lesser General Public License
22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
23 ***/
24
25 #include <inttypes.h>
26 #include <time.h>
27 #include <sys/time.h>
28 #include <stdarg.h>
29 #include <stdbool.h>
30 #include <stdlib.h>
31 #include <stdio.h>
32 #include <signal.h>
33 #include <sched.h>
34 #include <limits.h>
35 #include <sys/stat.h>
36 #include <dirent.h>
37 #include <sys/resource.h>
38
39 #include "macro.h"
40
41 typedef uint64_t usec_t;
42
43 typedef struct dual_timestamp {
44         usec_t realtime;
45         usec_t monotonic;
46 } dual_timestamp;
47
48 #define MSEC_PER_SEC  1000ULL
49 #define USEC_PER_SEC  1000000ULL
50 #define USEC_PER_MSEC 1000ULL
51 #define NSEC_PER_SEC  1000000000ULL
52 #define NSEC_PER_MSEC 1000000ULL
53 #define NSEC_PER_USEC 1000ULL
54
55 #define USEC_PER_MINUTE (60ULL*USEC_PER_SEC)
56 #define USEC_PER_HOUR (60ULL*USEC_PER_MINUTE)
57 #define USEC_PER_DAY (24ULL*USEC_PER_HOUR)
58 #define USEC_PER_WEEK (7ULL*USEC_PER_DAY)
59 #define USEC_PER_MONTH (2629800ULL*USEC_PER_SEC)
60 #define USEC_PER_YEAR (31557600ULL*USEC_PER_SEC)
61
62 /* What is interpreted as whitespace? */
63 #define WHITESPACE " \t\n\r"
64 #define NEWLINE "\n\r"
65 #define QUOTES "\"\'"
66 #define COMMENTS "#;\n"
67
68 #define FORMAT_TIMESTAMP_MAX 64
69 #define FORMAT_TIMESTAMP_PRETTY_MAX 256
70 #define FORMAT_TIMESPAN_MAX 64
71 #define FORMAT_BYTES_MAX 8
72
73 #define ANSI_HIGHLIGHT_ON "\x1B[1;39m"
74 #define ANSI_HIGHLIGHT_RED_ON "\x1B[1;31m"
75 #define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
76 #define ANSI_HIGHLIGHT_OFF "\x1B[0m"
77
78 usec_t now(clockid_t clock);
79
80 dual_timestamp* dual_timestamp_get(dual_timestamp *ts);
81 dual_timestamp* dual_timestamp_from_realtime(dual_timestamp *ts, usec_t u);
82
83 #define dual_timestamp_is_set(ts) ((ts)->realtime > 0)
84
85 usec_t timespec_load(const struct timespec *ts);
86 struct timespec *timespec_store(struct timespec *ts, usec_t u);
87
88 usec_t timeval_load(const struct timeval *tv);
89 struct timeval *timeval_store(struct timeval *tv, usec_t u);
90
91 size_t page_size(void);
92 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
93
94 #define streq(a,b) (strcmp((a),(b)) == 0)
95 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
96
97 bool streq_ptr(const char *a, const char *b);
98
99 #define new(t, n) ((t*) malloc(sizeof(t)*(n)))
100
101 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
102
103 #define newdup(t, p, n) ((t*) memdup(p, sizeof(t)*(n))
104
105 #define malloc0(n) (calloc((n), 1))
106
107 static inline const char* yes_no(bool b) {
108         return b ? "yes" : "no";
109 }
110
111 static inline const char* strempty(const char *s) {
112         return s ? s : "";
113 }
114
115 static inline const char* strnull(const char *s) {
116         return s ? s : "(null)";
117 }
118
119 static inline const char *strna(const char *s) {
120         return s ? s : "n/a";
121 }
122
123 static inline bool is_path_absolute(const char *p) {
124         return *p == '/';
125 }
126
127 static inline bool isempty(const char *p) {
128         return !p || !p[0];
129 }
130
131 bool endswith(const char *s, const char *postfix);
132 bool startswith(const char *s, const char *prefix);
133 bool startswith_no_case(const char *s, const char *prefix);
134
135 bool first_word(const char *s, const char *word);
136
137 int close_nointr(int fd);
138 void close_nointr_nofail(int fd);
139 void close_many(const int fds[], unsigned n_fd);
140
141 int parse_boolean(const char *v);
142 int parse_usec(const char *t, usec_t *usec);
143 int parse_bytes(const char *t, off_t *bytes);
144 int parse_pid(const char *s, pid_t* ret_pid);
145 int parse_uid(const char *s, uid_t* ret_uid);
146 #define parse_gid(s, ret_uid) parse_uid(s, ret_uid)
147
148 int safe_atou(const char *s, unsigned *ret_u);
149 int safe_atoi(const char *s, int *ret_i);
150
151 int safe_atollu(const char *s, unsigned long long *ret_u);
152 int safe_atolli(const char *s, long long int *ret_i);
153
154 #if __WORDSIZE == 32
155 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
156         assert_cc(sizeof(unsigned long) == sizeof(unsigned));
157         return safe_atou(s, (unsigned*) ret_u);
158 }
159 static inline int safe_atoli(const char *s, long int *ret_u) {
160         assert_cc(sizeof(long int) == sizeof(int));
161         return safe_atoi(s, (int*) ret_u);
162 }
163 #else
164 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
165         assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
166         return safe_atollu(s, (unsigned long long*) ret_u);
167 }
168 static inline int safe_atoli(const char *s, long int *ret_u) {
169         assert_cc(sizeof(long int) == sizeof(long long int));
170         return safe_atolli(s, (long long int*) ret_u);
171 }
172 #endif
173
174 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
175         assert_cc(sizeof(uint32_t) == sizeof(unsigned));
176         return safe_atou(s, (unsigned*) ret_u);
177 }
178
179 static inline int safe_atoi32(const char *s, int32_t *ret_i) {
180         assert_cc(sizeof(int32_t) == sizeof(int));
181         return safe_atoi(s, (int*) ret_i);
182 }
183
184 static inline int safe_atou64(const char *s, uint64_t *ret_u) {
185         assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
186         return safe_atollu(s, (unsigned long long*) ret_u);
187 }
188
189 static inline int safe_atoi64(const char *s, int64_t *ret_i) {
190         assert_cc(sizeof(int64_t) == sizeof(long long int));
191         return safe_atolli(s, (long long int*) ret_i);
192 }
193
194 char *split(const char *c, size_t *l, const char *separator, char **state);
195 char *split_quoted(const char *c, size_t *l, char **state);
196
197 #define FOREACH_WORD(word, length, s, state)                            \
198         for ((state) = NULL, (word) = split((s), &(length), WHITESPACE, &(state)); (word); (word) = split((s), &(length), WHITESPACE, &(state)))
199
200 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state)       \
201         for ((state) = NULL, (word) = split((s), &(length), (separator), &(state)); (word); (word) = split((s), &(length), (separator), &(state)))
202
203 #define FOREACH_WORD_QUOTED(word, length, s, state)                     \
204         for ((state) = NULL, (word) = split_quoted((s), &(length), &(state)); (word); (word) = split_quoted((s), &(length), &(state)))
205
206 char **split_path_and_make_absolute(const char *p);
207
208 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
209 int get_starttime_of_pid(pid_t pid, unsigned long long *st);
210
211 int write_one_line_file(const char *fn, const char *line);
212 int write_one_line_file_atomic(const char *fn, const char *line);
213 int read_one_line_file(const char *fn, char **line);
214 int read_full_file(const char *fn, char **contents, size_t *size);
215
216 int parse_env_file(const char *fname, const char *separator, ...) _sentinel_;
217 int load_env_file(const char *fname, char ***l);
218 int write_env_file(const char *fname, char **l);
219
220 char *strappend(const char *s, const char *suffix);
221 char *strnappend(const char *s, const char *suffix, size_t length);
222
223 char *replace_env(const char *format, char **env);
224 char **replace_env_argv(char **argv, char **env);
225
226 int readlink_malloc(const char *p, char **r);
227 int readlink_and_make_absolute(const char *p, char **r);
228 int readlink_and_canonicalize(const char *p, char **r);
229
230 char *file_name_from_path(const char *p);
231 bool is_path(const char *p);
232
233 bool path_is_absolute(const char *p);
234 char *path_make_absolute(const char *p, const char *prefix);
235 char *path_make_absolute_cwd(const char *p);
236
237 char **strv_path_make_absolute_cwd(char **l);
238 char **strv_path_canonicalize(char **l);
239 char **strv_path_remove_empty(char **l);
240
241 int reset_all_signal_handlers(void);
242
243 char *strstrip(char *s);
244 char *delete_chars(char *s, const char *bad);
245 char *truncate_nl(char *s);
246
247 char *file_in_same_dir(const char *path, const char *filename);
248
249 int parent_of_path(const char *path, char **parent);
250
251 int rmdir_parents(const char *path, const char *stop);
252
253 int get_process_comm(pid_t pid, char **name);
254 int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
255 int get_process_exe(pid_t pid, char **name);
256 int get_process_uid(pid_t pid, uid_t *uid);
257
258 char hexchar(int x);
259 int unhexchar(char c);
260 char octchar(int x);
261 int unoctchar(char c);
262 char decchar(int x);
263 int undecchar(char c);
264
265 char *cescape(const char *s);
266 char *cunescape(const char *s);
267 char *cunescape_length(const char *s, size_t length);
268
269 char *xescape(const char *s, const char *bad);
270
271 char *bus_path_escape(const char *s);
272 char *bus_path_unescape(const char *s);
273
274 char *path_kill_slashes(char *path);
275
276 bool path_startswith(const char *path, const char *prefix);
277 bool path_equal(const char *a, const char *b);
278
279 char *ascii_strlower(char *path);
280
281 bool dirent_is_file(const struct dirent *de);
282 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix);
283
284 bool ignore_file(const char *filename);
285
286 bool chars_intersect(const char *a, const char *b);
287
288 char *format_timestamp(char *buf, size_t l, usec_t t);
289 char *format_timestamp_pretty(char *buf, size_t l, usec_t t);
290 char *format_timespan(char *buf, size_t l, usec_t t);
291
292 int make_stdio(int fd);
293 int make_null_stdio(void);
294
295 unsigned long long random_ull(void);
296
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                 unsigned u = 0;                                         \
306                 assert(s);                                              \
307                 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
308                         if (name##_table[i] &&                          \
309                             streq(name##_table[i], s))                  \
310                                 return i;                               \
311                 if (safe_atou(s, &u) >= 0 &&                            \
312                     u < ELEMENTSOF(name##_table))                       \
313                         return (type) u;                                \
314                 return (type) -1;                                       \
315         }                                                               \
316         struct __useless_struct_to_allow_trailing_semicolon__
317
318 #define DEFINE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,)
319 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,static)
320
321 int fd_nonblock(int fd, bool nonblock);
322 int fd_cloexec(int fd, bool cloexec);
323
324 int close_all_fds(const int except[], unsigned n_except);
325
326 bool fstype_is_network(const char *fstype);
327
328 int chvt(int vt);
329
330 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
331 int ask(char *ret, const char *replies, const char *text, ...);
332
333 int reset_terminal_fd(int fd, bool switch_to_text);
334 int reset_terminal(const char *name);
335
336 int open_terminal(const char *name, int mode);
337 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm);
338 int release_terminal(void);
339
340 int flush_fd(int fd);
341
342 int ignore_signals(int sig, ...);
343 int default_signals(int sig, ...);
344 int sigaction_many(const struct sigaction *sa, ...);
345
346 int close_pipe(int p[]);
347 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
348
349 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
350 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
351
352 int path_is_mount_point(const char *path, bool allow_symlink);
353
354 bool is_device_path(const char *path);
355
356 int dir_is_empty(const char *path);
357
358 void rename_process(const char name[8]);
359
360 void sigset_add_many(sigset_t *ss, ...);
361
362 char* gethostname_malloc(void);
363 char* getlogname_malloc(void);
364
365 int getttyname_malloc(int fd, char **r);
366 int getttyname_harder(int fd, char **r);
367
368 int get_ctty_devnr(pid_t pid, dev_t *d);
369 int get_ctty(pid_t, dev_t *_devnr, char **r);
370
371 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
372 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
373
374 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
375
376 int pipe_eof(int fd);
377
378 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
379
380 void status_vprintf(const char *status, bool ellipse, const char *format, va_list ap);
381 void status_printf(const char *status, bool ellipse, const char *format, ...);
382 void status_welcome(void);
383
384 int fd_columns(int fd);
385 unsigned columns(void);
386
387 int fd_lines(int fd);
388 unsigned lines(void);
389
390 int running_in_chroot(void);
391
392 char *ellipsize(const char *s, size_t length, unsigned percent);
393 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
394
395 int touch(const char *path);
396
397 char *unquote(const char *s, const char *quotes);
398 char *normalize_env_assignment(const char *s);
399
400 int wait_for_terminate(pid_t pid, siginfo_t *status);
401 int wait_for_terminate_and_warn(const char *name, pid_t pid);
402
403 _noreturn_ void freeze(void);
404
405 bool null_or_empty(struct stat *st);
406 int null_or_empty_path(const char *fn);
407
408 DIR *xopendirat(int dirfd, const char *name, int flags);
409
410 void dual_timestamp_serialize(FILE *f, const char *name, dual_timestamp *t);
411 void dual_timestamp_deserialize(const char *value, dual_timestamp *t);
412
413 char *fstab_node_to_udev_node(const char *p);
414
415 bool tty_is_vc(const char *tty);
416 bool tty_is_vc_resolve(const char *tty);
417 int vtnr_from_tty(const char *tty);
418 const char *default_term_for_tty(const char *tty);
419
420 void execute_directory(const char *directory, DIR *_d, char *argv[]);
421
422 int kill_and_sigcont(pid_t pid, int sig);
423
424 bool nulstr_contains(const char*nulstr, const char *needle);
425
426 bool plymouth_running(void);
427
428 void parse_syslog_priority(char **p, int *priority);
429 void skip_syslog_pid(char **buf);
430 void skip_syslog_date(char **buf);
431
432 bool hostname_is_valid(const char *s);
433 char* hostname_cleanup(char *s);
434
435 char* strshorten(char *s, size_t l);
436
437 int terminal_vhangup_fd(int fd);
438 int terminal_vhangup(const char *name);
439
440 int vt_disallocate(const char *name);
441
442 int copy_file(const char *from, const char *to);
443 int symlink_or_copy(const char *from, const char *to);
444 int symlink_or_copy_atomic(const char *from, const char *to);
445
446 int fchmod_umask(int fd, mode_t mode);
447
448 int conf_files_list(char ***strv, const char *suffix, const char *dir, ...);
449
450 int hwclock_is_localtime(void);
451 int hwclock_apply_localtime_delta(int *min);
452 int hwclock_reset_localtime_delta(void);
453 int hwclock_get_time(struct tm *tm);
454 int hwclock_set_time(const struct tm *tm);
455
456 bool display_is_local(const char *display);
457 int socket_from_display(const char *display, char **path);
458
459 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home);
460 int get_group_creds(const char **groupname, gid_t *gid);
461
462 int in_group(const char *name);
463
464 int glob_exists(const char *path);
465
466 int dirent_ensure_type(DIR *d, struct dirent *de);
467
468 int in_search_path(const char *path, char **search);
469 int get_files_in_directory(const char *path, char ***list);
470
471 char *join(const char *x, ...) _sentinel_;
472
473 bool is_main_thread(void);
474
475 bool in_charset(const char *s, const char* charset);
476
477 int block_get_whole_disk(dev_t d, dev_t *ret);
478
479 int file_is_priv_sticky(const char *p);
480
481 int strdup_or_null(const char *a, char **b);
482
483 #define NULSTR_FOREACH(i, l)                                    \
484         for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
485
486 #define NULSTR_FOREACH_PAIR(i, j, l)                             \
487         for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
488
489 const char *ioprio_class_to_string(int i);
490 int ioprio_class_from_string(const char *s);
491
492 const char *sigchld_code_to_string(int i);
493 int sigchld_code_from_string(const char *s);
494
495 const char *log_facility_unshifted_to_string(int i);
496 int log_facility_unshifted_from_string(const char *s);
497
498 const char *log_level_to_string(int i);
499 int log_level_from_string(const char *s);
500
501 const char *sched_policy_to_string(int i);
502 int sched_policy_from_string(const char *s);
503
504 const char *rlimit_to_string(int i);
505 int rlimit_from_string(const char *s);
506
507 const char *ip_tos_to_string(int i);
508 int ip_tos_from_string(const char *s);
509
510 const char *signal_to_string(int i);
511 int signal_from_string(const char *s);
512
513 int signal_from_string_try_harder(const char *s);
514
515 extern int saved_argc;
516 extern char **saved_argv;
517
518 bool kexec_loaded(void);
519
520 int prot_from_flags(int flags);
521
522 char *format_bytes(char *buf, size_t l, off_t t);
523
524 int fd_wait_for_event(int fd, int event, usec_t timeout);
525
526 void* memdup(const void *p, size_t l);
527
528 int rtc_open(int flags);
529
530 int is_kernel_thread(pid_t pid);
531
532 int fd_inc_sndbuf(int fd, size_t n);
533 int fd_inc_rcvbuf(int fd, size_t n);
534
535 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
536
537 int setrlimit_closest(int resource, const struct rlimit *rlim);
538
539 #endif