]>
git.ipfire.org Git - thirdparty/systemd.git/blob - src/util.h
1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
7 This file is part of systemd.
9 Copyright 2010 Lennart Poettering
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.
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.
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/>.
40 typedef uint64_t usec_t
;
42 typedef struct dual_timestamp
{
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
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)
61 /* What is interpreted as whitespace? */
62 #define WHITESPACE " \t\n\r"
63 #define NEWLINE "\n\r"
65 #define COMMENTS "#;\n"
67 #define FORMAT_TIMESTAMP_MAX 64
68 #define FORMAT_TIMESTAMP_PRETTY_MAX 256
69 #define FORMAT_TIMESPAN_MAX 64
70 #define FORMAT_BYTES_MAX 8
72 #define ANSI_HIGHLIGHT_ON "\x1B[1;39m"
73 #define ANSI_HIGHLIGHT_RED_ON "\x1B[1;32m"
74 #define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
75 #define ANSI_HIGHLIGHT_OFF "\x1B[0m"
77 usec_t
now(clockid_t clock
);
79 dual_timestamp
* dual_timestamp_get(dual_timestamp
*ts
);
80 dual_timestamp
* dual_timestamp_from_realtime(dual_timestamp
*ts
, usec_t u
);
82 #define dual_timestamp_is_set(ts) ((ts)->realtime > 0)
84 usec_t
timespec_load(const struct timespec
*ts
);
85 struct timespec
*timespec_store(struct timespec
*ts
, usec_t u
);
87 usec_t
timeval_load(const struct timeval
*tv
);
88 struct timeval
*timeval_store(struct timeval
*tv
, usec_t u
);
90 size_t page_size(void);
91 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
93 #define streq(a,b) (strcmp((a),(b)) == 0)
94 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
96 bool streq_ptr(const char *a
, const char *b
);
98 #define new(t, n) ((t*) malloc(sizeof(t)*(n)))
100 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
102 #define malloc0(n) (calloc((n), 1))
104 static inline const char* yes_no(bool b
) {
105 return b
? "yes" : "no";
108 static inline const char* strempty(const char *s
) {
112 static inline const char* strnull(const char *s
) {
113 return s
? s
: "(null)";
116 static inline const char *strna(const char *s
) {
117 return s
? s
: "n/a";
120 static inline bool is_path_absolute(const char *p
) {
124 static inline bool isempty(const char *p
) {
128 bool endswith(const char *s
, const char *postfix
);
129 bool startswith(const char *s
, const char *prefix
);
130 bool startswith_no_case(const char *s
, const char *prefix
);
132 bool first_word(const char *s
, const char *word
);
134 int close_nointr(int fd
);
135 void close_nointr_nofail(int fd
);
136 void close_many(const int fds
[], unsigned n_fd
);
138 int parse_boolean(const char *v
);
139 int parse_usec(const char *t
, usec_t
*usec
);
140 int parse_bytes(const char *t
, off_t
*bytes
);
141 int parse_pid(const char *s
, pid_t
* ret_pid
);
142 int parse_uid(const char *s
, uid_t
* ret_uid
);
143 #define parse_gid(s, ret_uid) parse_uid(s, ret_uid)
145 int safe_atou(const char *s
, unsigned *ret_u
);
146 int safe_atoi(const char *s
, int *ret_i
);
148 int safe_atollu(const char *s
, unsigned long long *ret_u
);
149 int safe_atolli(const char *s
, long long int *ret_i
);
152 static inline int safe_atolu(const char *s
, unsigned long *ret_u
) {
153 assert_cc(sizeof(unsigned long) == sizeof(unsigned));
154 return safe_atou(s
, (unsigned*) ret_u
);
156 static inline int safe_atoli(const char *s
, long int *ret_u
) {
157 assert_cc(sizeof(long int) == sizeof(int));
158 return safe_atoi(s
, (int*) ret_u
);
161 static inline int safe_atolu(const char *s
, unsigned long *ret_u
) {
162 assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
163 return safe_atollu(s
, (unsigned long long*) ret_u
);
165 static inline int safe_atoli(const char *s
, long int *ret_u
) {
166 assert_cc(sizeof(long int) == sizeof(long long int));
167 return safe_atolli(s
, (long long int*) ret_u
);
171 static inline int safe_atou32(const char *s
, uint32_t *ret_u
) {
172 assert_cc(sizeof(uint32_t) == sizeof(unsigned));
173 return safe_atou(s
, (unsigned*) ret_u
);
176 static inline int safe_atoi32(const char *s
, int32_t *ret_i
) {
177 assert_cc(sizeof(int32_t) == sizeof(int));
178 return safe_atoi(s
, (int*) ret_i
);
181 static inline int safe_atou64(const char *s
, uint64_t *ret_u
) {
182 assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
183 return safe_atollu(s
, (unsigned long long*) ret_u
);
186 static inline int safe_atoi64(const char *s
, int64_t *ret_i
) {
187 assert_cc(sizeof(int64_t) == sizeof(long long int));
188 return safe_atolli(s
, (long long int*) ret_i
);
191 char *split(const char *c
, size_t *l
, const char *separator
, char **state
);
192 char *split_quoted(const char *c
, size_t *l
, char **state
);
194 #define FOREACH_WORD(word, length, s, state) \
195 for ((state) = NULL, (word) = split((s), &(length), WHITESPACE, &(state)); (word); (word) = split((s), &(length), WHITESPACE, &(state)))
197 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state) \
198 for ((state) = NULL, (word) = split((s), &(length), (separator), &(state)); (word); (word) = split((s), &(length), (separator), &(state)))
200 #define FOREACH_WORD_QUOTED(word, length, s, state) \
201 for ((state) = NULL, (word) = split_quoted((s), &(length), &(state)); (word); (word) = split_quoted((s), &(length), &(state)))
203 char **split_path_and_make_absolute(const char *p
);
205 pid_t
get_parent_of_pid(pid_t pid
, pid_t
*ppid
);
206 int get_starttime_of_pid(pid_t pid
, unsigned long long *st
);
208 int write_one_line_file(const char *fn
, const char *line
);
209 int write_one_line_file_atomic(const char *fn
, const char *line
);
210 int read_one_line_file(const char *fn
, char **line
);
211 int read_full_file(const char *fn
, char **contents
, size_t *size
);
213 int parse_env_file(const char *fname
, const char *separator
, ...) _sentinel_
;
214 int load_env_file(const char *fname
, char ***l
);
215 int write_env_file(const char *fname
, char **l
);
217 char *strappend(const char *s
, const char *suffix
);
218 char *strnappend(const char *s
, const char *suffix
, size_t length
);
220 char *replace_env(const char *format
, char **env
);
221 char **replace_env_argv(char **argv
, char **env
);
223 int readlink_malloc(const char *p
, char **r
);
224 int readlink_and_make_absolute(const char *p
, char **r
);
225 int readlink_and_canonicalize(const char *p
, char **r
);
227 char *file_name_from_path(const char *p
);
228 bool is_path(const char *p
);
230 bool path_is_absolute(const char *p
);
231 char *path_make_absolute(const char *p
, const char *prefix
);
232 char *path_make_absolute_cwd(const char *p
);
234 char **strv_path_make_absolute_cwd(char **l
);
235 char **strv_path_canonicalize(char **l
);
236 char **strv_path_remove_empty(char **l
);
238 int reset_all_signal_handlers(void);
240 char *strstrip(char *s
);
241 char *delete_chars(char *s
, const char *bad
);
242 char *truncate_nl(char *s
);
244 char *file_in_same_dir(const char *path
, const char *filename
);
245 int safe_mkdir(const char *path
, mode_t mode
, uid_t uid
, gid_t gid
);
246 int mkdir_parents(const char *path
, mode_t mode
);
247 int mkdir_p(const char *path
, mode_t mode
);
249 int parent_of_path(const char *path
, char **parent
);
251 int rmdir_parents(const char *path
, const char *stop
);
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
);
259 int unhexchar(char c
);
261 int unoctchar(char c
);
263 int undecchar(char c
);
265 char *cescape(const char *s
);
266 char *cunescape(const char *s
);
267 char *cunescape_length(const char *s
, size_t length
);
269 char *xescape(const char *s
, const char *bad
);
271 char *bus_path_escape(const char *s
);
272 char *bus_path_unescape(const char *s
);
274 char *path_kill_slashes(char *path
);
276 bool path_startswith(const char *path
, const char *prefix
);
277 bool path_equal(const char *a
, const char *b
);
279 char *ascii_strlower(char *path
);
281 bool dirent_is_file(const struct dirent
*de
);
282 bool dirent_is_file_with_suffix(const struct dirent
*de
, const char *suffix
);
284 bool ignore_file(const char *filename
);
286 bool chars_intersect(const char *a
, const char *b
);
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
);
292 int make_stdio(int fd
);
293 int make_null_stdio(void);
295 unsigned long long random_ull(void);
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)) \
301 return name##_table[i]; \
303 scope type name##_from_string(const char *s) { \
307 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
308 if (name##_table[i] && \
309 streq(name##_table[i], s)) \
311 if (safe_atou(s, &u) >= 0 && \
312 u < ELEMENTSOF(name##_table)) \
316 struct __useless_struct_to_allow_trailing_semicolon__
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)
321 int fd_nonblock(int fd
, bool nonblock
);
322 int fd_cloexec(int fd
, bool cloexec
);
324 int close_all_fds(const int except
[], unsigned n_except
);
326 bool fstype_is_network(const char *fstype
);
330 int read_one_char(FILE *f
, char *ret
, bool *need_nl
);
331 int ask(char *ret
, const char *replies
, const char *text
, ...);
333 int reset_terminal_fd(int fd
);
334 int reset_terminal(const char *name
);
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);
340 int flush_fd(int fd
);
342 int ignore_signals(int sig
, ...);
343 int default_signals(int sig
, ...);
344 int sigaction_many(const struct sigaction
*sa
, ...);
346 int close_pipe(int p
[]);
347 int fopen_temporary(const char *path
, FILE **_f
, char **_temp_path
);
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
);
352 int path_is_mount_point(const char *path
, bool allow_symlink
);
354 bool is_device_path(const char *path
);
356 int dir_is_empty(const char *path
);
358 void rename_process(const char name
[8]);
360 void sigset_add_many(sigset_t
*ss
, ...);
362 char* gethostname_malloc(void);
363 char* getlogname_malloc(void);
365 int getttyname_malloc(int fd
, char **r
);
366 int getttyname_harder(int fd
, char **r
);
368 int get_ctty_devnr(pid_t pid
, dev_t
*d
);
369 int get_ctty(pid_t
, dev_t
*_devnr
, char **r
);
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
);
374 int rm_rf(const char *path
, bool only_dirs
, bool delete_root
, bool honour_sticky
);
376 int pipe_eof(int fd
);
378 cpu_set_t
* cpu_set_malloc(unsigned *ncpus
);
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);
384 int fd_columns(int fd
);
385 unsigned columns(void);
387 int running_in_chroot(void);
389 char *ellipsize(const char *s
, size_t length
, unsigned percent
);
390 char *ellipsize_mem(const char *s
, size_t old_length
, size_t new_length
, unsigned percent
);
392 int touch(const char *path
);
394 char *unquote(const char *s
, const char *quotes
);
395 char *normalize_env_assignment(const char *s
);
397 int wait_for_terminate(pid_t pid
, siginfo_t
*status
);
398 int wait_for_terminate_and_warn(const char *name
, pid_t pid
);
400 _noreturn_
void freeze(void);
402 bool null_or_empty(struct stat
*st
);
403 int null_or_empty_path(const char *fn
);
405 DIR *xopendirat(int dirfd
, const char *name
, int flags
);
407 void dual_timestamp_serialize(FILE *f
, const char *name
, dual_timestamp
*t
);
408 void dual_timestamp_deserialize(const char *value
, dual_timestamp
*t
);
410 char *fstab_node_to_udev_node(const char *p
);
412 void filter_environ(const char *prefix
);
414 bool tty_is_vc(const char *tty
);
415 bool tty_is_vc_resolve(const char *tty
);
416 int vtnr_from_tty(const char *tty
);
417 const char *default_term_for_tty(const char *tty
);
419 void execute_directory(const char *directory
, DIR *_d
, char *argv
[]);
421 int kill_and_sigcont(pid_t pid
, int sig
);
423 bool nulstr_contains(const char*nulstr
, const char *needle
);
425 bool plymouth_running(void);
427 void parse_syslog_priority(char **p
, int *priority
);
428 void skip_syslog_pid(char **buf
);
429 void skip_syslog_date(char **buf
);
431 int have_effective_cap(int value
);
433 bool hostname_is_valid(const char *s
);
434 char* hostname_cleanup(char *s
);
436 char* strshorten(char *s
, size_t l
);
438 int terminal_vhangup_fd(int fd
);
439 int terminal_vhangup(const char *name
);
441 int vt_disallocate(const char *name
);
443 int copy_file(const char *from
, const char *to
);
444 int symlink_or_copy(const char *from
, const char *to
);
445 int symlink_or_copy_atomic(const char *from
, const char *to
);
447 int fchmod_umask(int fd
, mode_t mode
);
449 int conf_files_list(char ***strv
, const char *suffix
, const char *dir
, ...);
451 int hwclock_is_localtime(void);
452 int hwclock_apply_localtime_delta(int *min
);
453 int hwclock_reset_localtime_delta(void);
454 int hwclock_get_time(struct tm
*tm
);
455 int hwclock_set_time(const struct tm
*tm
);
457 int audit_session_from_pid(pid_t pid
, uint32_t *id
);
458 int audit_loginuid_from_pid(pid_t pid
, uid_t
*uid
);
460 bool display_is_local(const char *display
);
461 int socket_from_display(const char *display
, char **path
);
463 int get_user_creds(const char **username
, uid_t
*uid
, gid_t
*gid
, const char **home
);
464 int get_group_creds(const char **groupname
, gid_t
*gid
);
466 int glob_exists(const char *path
);
468 int dirent_ensure_type(DIR *d
, struct dirent
*de
);
470 int in_search_path(const char *path
, char **search
);
471 int get_files_in_directory(const char *path
, char ***list
);
473 char *join(const char *x
, ...) _sentinel_
;
475 bool is_main_thread(void);
477 bool in_charset(const char *s
, const char* charset
);
479 int block_get_whole_disk(dev_t d
, dev_t
*ret
);
481 int file_is_sticky(const char *p
);
483 int strdup_or_null(const char *a
, char **b
);
485 #define NULSTR_FOREACH(i, l) \
486 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
488 #define NULSTR_FOREACH_PAIR(i, j, l) \
489 for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
491 const char *ioprio_class_to_string(int i
);
492 int ioprio_class_from_string(const char *s
);
494 const char *sigchld_code_to_string(int i
);
495 int sigchld_code_from_string(const char *s
);
497 const char *log_facility_unshifted_to_string(int i
);
498 int log_facility_unshifted_from_string(const char *s
);
500 const char *log_level_to_string(int i
);
501 int log_level_from_string(const char *s
);
503 const char *sched_policy_to_string(int i
);
504 int sched_policy_from_string(const char *s
);
506 const char *rlimit_to_string(int i
);
507 int rlimit_from_string(const char *s
);
509 const char *ip_tos_to_string(int i
);
510 int ip_tos_from_string(const char *s
);
512 const char *signal_to_string(int i
);
513 int signal_from_string(const char *s
);
515 int signal_from_string_try_harder(const char *s
);
517 extern int saved_argc
;
518 extern char **saved_argv
;
520 bool kexec_loaded(void);
522 int prot_from_flags(int flags
);
524 unsigned long cap_last_cap(void);
526 char *format_bytes(char *buf
, size_t l
, off_t t
);
528 int fd_wait_for_event(int fd
, int event
);
530 void* memdup(const void *p
, size_t l
);