chiark / gitweb /
fix hwclock_apply_localtime_delta() to properly handle negative TZ offset
[elogind.git] / src / 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 General Public License as published by
13   the Free Software Foundation; either version 2 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   General Public License for more details.
20
21   You should have received a copy of the GNU 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
38 #include "macro.h"
39
40 typedef uint64_t usec_t;
41
42 typedef struct dual_timestamp {
43         usec_t realtime;
44         usec_t monotonic;
45 } dual_timestamp;
46
47 #define MSEC_PER_SEC  1000ULL
48 #define USEC_PER_SEC  1000000ULL
49 #define USEC_PER_MSEC 1000ULL
50 #define NSEC_PER_SEC  1000000000ULL
51 #define NSEC_PER_MSEC 1000000ULL
52 #define NSEC_PER_USEC 1000ULL
53
54 #define USEC_PER_MINUTE (60ULL*USEC_PER_SEC)
55 #define USEC_PER_HOUR (60ULL*USEC_PER_MINUTE)
56 #define USEC_PER_DAY (24ULL*USEC_PER_HOUR)
57 #define USEC_PER_WEEK (7ULL*USEC_PER_DAY)
58 #define USEC_PER_MONTH (2629800ULL*USEC_PER_SEC)
59 #define USEC_PER_YEAR (31557600ULL*USEC_PER_SEC)
60
61 /* What is interpreted as whitespace? */
62 #define WHITESPACE " \t\n\r"
63 #define NEWLINE "\n\r"
64 #define QUOTES "\"\'"
65 #define COMMENTS "#;\n"
66
67 #define FORMAT_TIMESTAMP_MAX 64
68 #define FORMAT_TIMESTAMP_PRETTY_MAX 256
69 #define FORMAT_TIMESPAN_MAX 64
70
71 #define ANSI_HIGHLIGHT_ON "\x1B[1;31m"
72 #define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
73 #define ANSI_HIGHLIGHT_OFF "\x1B[0m"
74
75 usec_t now(clockid_t clock);
76
77 dual_timestamp* dual_timestamp_get(dual_timestamp *ts);
78 dual_timestamp* dual_timestamp_from_realtime(dual_timestamp *ts, usec_t u);
79
80 #define dual_timestamp_is_set(ts) ((ts)->realtime > 0)
81
82 usec_t timespec_load(const struct timespec *ts);
83 struct timespec *timespec_store(struct timespec *ts, usec_t u);
84
85 usec_t timeval_load(const struct timeval *tv);
86 struct timeval *timeval_store(struct timeval *tv, usec_t u);
87
88 size_t page_size(void);
89 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
90
91 #define streq(a,b) (strcmp((a),(b)) == 0)
92 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
93
94 bool streq_ptr(const char *a, const char *b);
95
96 #define new(t, n) ((t*) malloc(sizeof(t)*(n)))
97
98 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
99
100 #define malloc0(n) (calloc((n), 1))
101
102 static inline const char* yes_no(bool b) {
103         return b ? "yes" : "no";
104 }
105
106 static inline const char* strempty(const char *s) {
107         return s ? s : "";
108 }
109
110 static inline const char* strnull(const char *s) {
111         return s ? s : "(null)";
112 }
113
114 static inline const char *strna(const char *s) {
115         return s ? s : "n/a";
116 }
117
118 static inline bool is_path_absolute(const char *p) {
119         return *p == '/';
120 }
121
122 static inline bool isempty(const char *p) {
123         return !p || !p[0];
124 }
125
126 bool endswith(const char *s, const char *postfix);
127 bool startswith(const char *s, const char *prefix);
128 bool startswith_no_case(const char *s, const char *prefix);
129
130 bool first_word(const char *s, const char *word);
131
132 int close_nointr(int fd);
133 void close_nointr_nofail(int fd);
134 void close_many(const int fds[], unsigned n_fd);
135
136 int parse_boolean(const char *v);
137 int parse_usec(const char *t, usec_t *usec);
138 int parse_pid(const char *s, pid_t* ret_pid);
139
140 int safe_atou(const char *s, unsigned *ret_u);
141 int safe_atoi(const char *s, int *ret_i);
142
143 int safe_atollu(const char *s, unsigned long long *ret_u);
144 int safe_atolli(const char *s, long long int *ret_i);
145
146 #if __WORDSIZE == 32
147 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
148         assert_cc(sizeof(unsigned long) == sizeof(unsigned));
149         return safe_atou(s, (unsigned*) ret_u);
150 }
151 static inline int safe_atoli(const char *s, long int *ret_u) {
152         assert_cc(sizeof(long int) == sizeof(int));
153         return safe_atoi(s, (int*) ret_u);
154 }
155 #else
156 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
157         assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
158         return safe_atollu(s, (unsigned long long*) ret_u);
159 }
160 static inline int safe_atoli(const char *s, long int *ret_u) {
161         assert_cc(sizeof(long int) == sizeof(long long int));
162         return safe_atolli(s, (long long int*) ret_u);
163 }
164 #endif
165
166 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
167         assert_cc(sizeof(uint32_t) == sizeof(unsigned));
168         return safe_atou(s, (unsigned*) ret_u);
169 }
170
171 static inline int safe_atoi32(const char *s, int32_t *ret_i) {
172         assert_cc(sizeof(int32_t) == sizeof(int));
173         return safe_atoi(s, (int*) ret_i);
174 }
175
176 static inline int safe_atou64(const char *s, uint64_t *ret_u) {
177         assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
178         return safe_atollu(s, (unsigned long long*) ret_u);
179 }
180
181 static inline int safe_atoi64(const char *s, int64_t *ret_i) {
182         assert_cc(sizeof(int64_t) == sizeof(long long int));
183         return safe_atolli(s, (long long int*) ret_i);
184 }
185
186 char *split(const char *c, size_t *l, const char *separator, char **state);
187 char *split_quoted(const char *c, size_t *l, char **state);
188
189 #define FOREACH_WORD(word, length, s, state)                            \
190         for ((state) = NULL, (word) = split((s), &(length), WHITESPACE, &(state)); (word); (word) = split((s), &(length), WHITESPACE, &(state)))
191
192 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state)       \
193         for ((state) = NULL, (word) = split((s), &(length), (separator), &(state)); (word); (word) = split((s), &(length), (separator), &(state)))
194
195 #define FOREACH_WORD_QUOTED(word, length, s, state)                     \
196         for ((state) = NULL, (word) = split_quoted((s), &(length), &(state)); (word); (word) = split_quoted((s), &(length), &(state)))
197
198 char **split_path_and_make_absolute(const char *p);
199
200 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
201 int get_starttime_of_pid(pid_t pid, unsigned long long *st);
202
203 int write_one_line_file(const char *fn, const char *line);
204 int write_one_line_file_atomic(const char *fn, const char *line);
205 int read_one_line_file(const char *fn, char **line);
206 int read_full_file(const char *fn, char **contents, size_t *size);
207
208 int parse_env_file(const char *fname, const char *separator, ...) _sentinel_;
209 int load_env_file(const char *fname, char ***l);
210 int write_env_file(const char *fname, char **l);
211
212 char *strappend(const char *s, const char *suffix);
213 char *strnappend(const char *s, const char *suffix, size_t length);
214
215 char *replace_env(const char *format, char **env);
216 char **replace_env_argv(char **argv, char **env);
217
218 int readlink_malloc(const char *p, char **r);
219 int readlink_and_make_absolute(const char *p, char **r);
220
221 char *file_name_from_path(const char *p);
222 bool is_path(const char *p);
223
224 bool path_is_absolute(const char *p);
225 char *path_make_absolute(const char *p, const char *prefix);
226 char *path_make_absolute_cwd(const char *p);
227
228 char **strv_path_make_absolute_cwd(char **l);
229 char **strv_path_canonicalize(char **l);
230 char **strv_path_remove_empty(char **l);
231
232 int reset_all_signal_handlers(void);
233
234 char *strstrip(char *s);
235 char *delete_chars(char *s, const char *bad);
236 char *truncate_nl(char *s);
237
238 char *file_in_same_dir(const char *path, const char *filename);
239 int safe_mkdir(const char *path, mode_t mode, uid_t uid, gid_t gid);
240 int mkdir_parents(const char *path, mode_t mode);
241 int mkdir_p(const char *path, mode_t mode);
242
243 int parent_of_path(const char *path, char **parent);
244
245 int rmdir_parents(const char *path, const char *stop);
246
247 int get_process_name(pid_t pid, char **name);
248 int get_process_cmdline(pid_t pid, size_t max_length, char **line);
249
250 char hexchar(int x);
251 int unhexchar(char c);
252 char octchar(int x);
253 int unoctchar(char c);
254 char decchar(int x);
255 int undecchar(char c);
256
257 char *cescape(const char *s);
258 char *cunescape(const char *s);
259 char *cunescape_length(const char *s, size_t length);
260
261 char *xescape(const char *s, const char *bad);
262
263 char *bus_path_escape(const char *s);
264 char *bus_path_unescape(const char *s);
265
266 char *path_kill_slashes(char *path);
267
268 bool path_startswith(const char *path, const char *prefix);
269 bool path_equal(const char *a, const char *b);
270
271 char *ascii_strlower(char *path);
272
273 bool dirent_is_file(struct dirent *de);
274 bool ignore_file(const char *filename);
275
276 bool chars_intersect(const char *a, const char *b);
277
278 char *format_timestamp(char *buf, size_t l, usec_t t);
279 char *format_timestamp_pretty(char *buf, size_t l, usec_t t);
280 char *format_timespan(char *buf, size_t l, usec_t t);
281
282 int make_stdio(int fd);
283 int make_null_stdio(void);
284
285 unsigned long long random_ull(void);
286
287 #define DEFINE_STRING_TABLE_LOOKUP(name,type)                           \
288         const char *name##_to_string(type i) {                          \
289                 if (i < 0 || i >= (type) ELEMENTSOF(name##_table))      \
290                         return NULL;                                    \
291                 return name##_table[i];                                 \
292         }                                                               \
293         type name##_from_string(const char *s) {                        \
294                 type i;                                                 \
295                 unsigned u = 0;                                         \
296                 assert(s);                                              \
297                 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
298                         if (name##_table[i] &&                          \
299                             streq(name##_table[i], s))                  \
300                                 return i;                               \
301                 if (safe_atou(s, &u) >= 0 &&                            \
302                     u < ELEMENTSOF(name##_table))                       \
303                         return (type) u;                                \
304                 return (type) -1;                                       \
305         }                                                               \
306         struct __useless_struct_to_allow_trailing_semicolon__
307
308
309 int fd_nonblock(int fd, bool nonblock);
310 int fd_cloexec(int fd, bool cloexec);
311
312 int close_all_fds(const int except[], unsigned n_except);
313
314 bool fstype_is_network(const char *fstype);
315
316 int chvt(int vt);
317
318 int read_one_char(FILE *f, char *ret, bool *need_nl);
319 int ask(char *ret, const char *replies, const char *text, ...);
320
321 int reset_terminal_fd(int fd);
322 int reset_terminal(const char *name);
323
324 int open_terminal(const char *name, int mode);
325 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm);
326 int release_terminal(void);
327
328 int flush_fd(int fd);
329
330 int ignore_signals(int sig, ...);
331 int default_signals(int sig, ...);
332 int sigaction_many(const struct sigaction *sa, ...);
333
334 int close_pipe(int p[]);
335 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
336
337 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
338 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
339
340 int path_is_mount_point(const char *path);
341
342 bool is_device_path(const char *path);
343
344 int dir_is_empty(const char *path);
345
346 void rename_process(const char name[8]);
347
348 void sigset_add_many(sigset_t *ss, ...);
349
350 char* gethostname_malloc(void);
351 char* getlogname_malloc(void);
352
353 int getttyname_malloc(int fd, char **r);
354 int getttyname_harder(int fd, char **r);
355
356 int get_ctty_devnr(pid_t pid, dev_t *d);
357 int get_ctty(pid_t, dev_t *_devnr, char **r);
358
359 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
360
361 int rm_rf(const char *path, bool only_dirs, bool delete_root);
362
363 int pipe_eof(int fd);
364
365 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
366
367 void status_vprintf(const char *format, va_list ap);
368 void status_printf(const char *format, ...);
369 void status_welcome(void);
370
371 int columns(void);
372
373 int running_in_chroot(void);
374
375 char *ellipsize(const char *s, unsigned length, unsigned percent);
376
377 int touch(const char *path);
378
379 char *unquote(const char *s, const char *quotes);
380 char *normalize_env_assignment(const char *s);
381
382 int wait_for_terminate(pid_t pid, siginfo_t *status);
383 int wait_for_terminate_and_warn(const char *name, pid_t pid);
384
385 _noreturn_ void freeze(void);
386
387 bool null_or_empty(struct stat *st);
388
389 DIR *xopendirat(int dirfd, const char *name, int flags);
390
391 void dual_timestamp_serialize(FILE *f, const char *name, dual_timestamp *t);
392 void dual_timestamp_deserialize(const char *value, dual_timestamp *t);
393
394 char *fstab_node_to_udev_node(const char *p);
395
396 void filter_environ(const char *prefix);
397
398 bool tty_is_vc(const char *tty);
399 int vtnr_from_tty(const char *tty);
400 const char *default_term_for_tty(const char *tty);
401
402 int detect_vm(const char **id);
403 int detect_container(const char **id);
404 int detect_virtualization(const char **id);
405
406 void execute_directory(const char *directory, DIR *_d, char *argv[]);
407
408 int kill_and_sigcont(pid_t pid, int sig);
409
410 bool nulstr_contains(const char*nulstr, const char *needle);
411
412 bool plymouth_running(void);
413
414 void parse_syslog_priority(char **p, int *priority);
415
416 int have_effective_cap(int value);
417
418 bool hostname_is_valid(const char *s);
419 char* hostname_cleanup(char *s);
420
421 char* strshorten(char *s, size_t l);
422
423 int terminal_vhangup_fd(int fd);
424 int terminal_vhangup(const char *name);
425
426 int vt_disallocate(const char *name);
427
428 int copy_file(const char *from, const char *to);
429 int symlink_or_copy(const char *from, const char *to);
430 int symlink_or_copy_atomic(const char *from, const char *to);
431
432 int fchmod_umask(int fd, mode_t mode);
433
434 int conf_files_list(char ***strv, const char *suffix, const char *dir, ...);
435
436 int hwclock_is_localtime(void);
437 int hwclock_apply_localtime_delta(int *min);
438 int hwclock_reset_localtime_delta(void);
439 int hwclock_get_time(struct tm *tm);
440 int hwclock_set_time(const struct tm *tm);
441
442 int audit_session_from_pid(pid_t pid, uint32_t *id);
443
444 bool display_is_local(const char *display);
445 int socket_from_display(const char *display, char **path);
446
447 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home);
448
449 int glob_exists(const char *path);
450
451 #define NULSTR_FOREACH(i, l)                                    \
452         for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
453
454 #define NULSTR_FOREACH_PAIR(i, j, l)                             \
455         for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
456
457 const char *ioprio_class_to_string(int i);
458 int ioprio_class_from_string(const char *s);
459
460 const char *sigchld_code_to_string(int i);
461 int sigchld_code_from_string(const char *s);
462
463 const char *log_facility_unshifted_to_string(int i);
464 int log_facility_unshifted_from_string(const char *s);
465
466 const char *log_level_to_string(int i);
467 int log_level_from_string(const char *s);
468
469 const char *sched_policy_to_string(int i);
470 int sched_policy_from_string(const char *s);
471
472 const char *rlimit_to_string(int i);
473 int rlimit_from_string(const char *s);
474
475 const char *ip_tos_to_string(int i);
476 int ip_tos_from_string(const char *s);
477
478 const char *signal_to_string(int i);
479 int signal_from_string(const char *s);
480
481 int signal_from_string_try_harder(const char *s);
482
483 extern int saved_argc;
484 extern char **saved_argv;
485
486 #endif