]>
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/>.
39 typedef uint64_t usec_t
;
41 typedef struct dual_timestamp
{
46 #define MSEC_PER_SEC 1000ULL
47 #define USEC_PER_SEC 1000000ULL
48 #define USEC_PER_MSEC 1000ULL
49 #define NSEC_PER_SEC 1000000000ULL
50 #define NSEC_PER_MSEC 1000000ULL
51 #define NSEC_PER_USEC 1000ULL
53 #define USEC_PER_MINUTE (60ULL*USEC_PER_SEC)
54 #define USEC_PER_HOUR (60ULL*USEC_PER_MINUTE)
55 #define USEC_PER_DAY (24ULL*USEC_PER_HOUR)
56 #define USEC_PER_WEEK (7ULL*USEC_PER_DAY)
57 #define USEC_PER_MONTH (2629800ULL*USEC_PER_SEC)
58 #define USEC_PER_YEAR (31557600ULL*USEC_PER_SEC)
60 /* What is interpreted as whitespace? */
61 #define WHITESPACE " \t\n\r"
62 #define NEWLINE "\n\r"
64 #define COMMENTS "#;\n"
66 #define FORMAT_TIMESTAMP_MAX 64
67 #define FORMAT_TIMESTAMP_PRETTY_MAX 256
68 #define FORMAT_TIMESPAN_MAX 64
70 #define ANSI_HIGHLIGHT_ON "\x1B[1;31m"
71 #define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
72 #define ANSI_HIGHLIGHT_OFF "\x1B[0m"
74 usec_t
now(clockid_t clock
);
76 dual_timestamp
* dual_timestamp_get(dual_timestamp
*ts
);
78 #define dual_timestamp_is_set(ts) ((ts)->realtime > 0)
80 usec_t
timespec_load(const struct timespec
*ts
);
81 struct timespec
*timespec_store(struct timespec
*ts
, usec_t u
);
83 usec_t
timeval_load(const struct timeval
*tv
);
84 struct timeval
*timeval_store(struct timeval
*tv
, usec_t u
);
86 #define streq(a,b) (strcmp((a),(b)) == 0)
87 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
89 bool streq_ptr(const char *a
, const char *b
);
91 #define new(t, n) ((t*) malloc(sizeof(t)*(n)))
93 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
95 #define malloc0(n) (calloc((n), 1))
97 static inline const char* yes_no(bool b
) {
98 return b
? "yes" : "no";
101 static inline const char* strempty(const char *s
) {
105 static inline const char* strnull(const char *s
) {
106 return s
? s
: "(null)";
109 static inline const char *strna(const char *s
) {
110 return s
? s
: "n/a";
113 static inline bool is_path_absolute(const char *p
) {
117 bool endswith(const char *s
, const char *postfix
);
118 bool startswith(const char *s
, const char *prefix
);
119 bool startswith_no_case(const char *s
, const char *prefix
);
121 bool first_word(const char *s
, const char *word
);
123 int close_nointr(int fd
);
124 void close_nointr_nofail(int fd
);
125 void close_many(const int fds
[], unsigned n_fd
);
127 int parse_boolean(const char *v
);
128 int parse_usec(const char *t
, usec_t
*usec
);
129 int parse_pid(const char *s
, pid_t
* ret_pid
);
131 int safe_atou(const char *s
, unsigned *ret_u
);
132 int safe_atoi(const char *s
, int *ret_i
);
134 int safe_atollu(const char *s
, unsigned long long *ret_u
);
135 int safe_atolli(const char *s
, long long int *ret_i
);
138 static inline int safe_atolu(const char *s
, unsigned long *ret_u
) {
139 assert_cc(sizeof(unsigned long) == sizeof(unsigned));
140 return safe_atou(s
, (unsigned*) ret_u
);
142 static inline int safe_atoli(const char *s
, long int *ret_u
) {
143 assert_cc(sizeof(long int) == sizeof(int));
144 return safe_atoi(s
, (int*) ret_u
);
147 static inline int safe_atolu(const char *s
, unsigned long *ret_u
) {
148 assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
149 return safe_atollu(s
, (unsigned long long*) ret_u
);
151 static inline int safe_atoli(const char *s
, long int *ret_u
) {
152 assert_cc(sizeof(long int) == sizeof(long long int));
153 return safe_atolli(s
, (long long int*) ret_u
);
157 static inline int safe_atou32(const char *s
, uint32_t *ret_u
) {
158 assert_cc(sizeof(uint32_t) == sizeof(unsigned));
159 return safe_atou(s
, (unsigned*) ret_u
);
162 static inline int safe_atoi32(const char *s
, int32_t *ret_i
) {
163 assert_cc(sizeof(int32_t) == sizeof(int));
164 return safe_atoi(s
, (int*) ret_i
);
167 static inline int safe_atou64(const char *s
, uint64_t *ret_u
) {
168 assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
169 return safe_atollu(s
, (unsigned long long*) ret_u
);
172 static inline int safe_atoi64(const char *s
, int64_t *ret_i
) {
173 assert_cc(sizeof(int64_t) == sizeof(long long int));
174 return safe_atolli(s
, (long long int*) ret_i
);
177 char *split(const char *c
, size_t *l
, const char *separator
, char **state
);
178 char *split_quoted(const char *c
, size_t *l
, char **state
);
180 #define FOREACH_WORD(word, length, s, state) \
181 for ((state) = NULL, (word) = split((s), &(length), WHITESPACE, &(state)); (word); (word) = split((s), &(length), WHITESPACE, &(state)))
183 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state) \
184 for ((state) = NULL, (word) = split((s), &(length), (separator), &(state)); (word); (word) = split((s), &(length), (separator), &(state)))
186 #define FOREACH_WORD_QUOTED(word, length, s, state) \
187 for ((state) = NULL, (word) = split_quoted((s), &(length), &(state)); (word); (word) = split_quoted((s), &(length), &(state)))
189 char **split_path_and_make_absolute(const char *p
);
191 pid_t
get_parent_of_pid(pid_t pid
, pid_t
*ppid
);
193 int write_one_line_file(const char *fn
, const char *line
);
194 int read_one_line_file(const char *fn
, char **line
);
195 int read_full_file(const char *fn
, char **contents
);
197 int parse_env_file(const char *fname
, const char *separator
, ...) _sentinel_
;
199 char *strappend(const char *s
, const char *suffix
);
200 char *strnappend(const char *s
, const char *suffix
, size_t length
);
202 char *replace_env(const char *format
, char **env
);
203 char **replace_env_argv(char **argv
, char **env
);
205 int readlink_malloc(const char *p
, char **r
);
206 int readlink_and_make_absolute(const char *p
, char **r
);
208 char *file_name_from_path(const char *p
);
209 bool is_path(const char *p
);
211 bool path_is_absolute(const char *p
);
212 char *path_make_absolute(const char *p
, const char *prefix
);
213 char *path_make_absolute_cwd(const char *p
);
215 char **strv_path_make_absolute_cwd(char **l
);
216 char **strv_path_canonicalize(char **l
);
218 int reset_all_signal_handlers(void);
220 char *strstrip(char *s
);
221 char *delete_chars(char *s
, const char *bad
);
222 char *truncate_nl(char *s
);
224 char *file_in_same_dir(const char *path
, const char *filename
);
225 int safe_mkdir(const char *path
, mode_t mode
, uid_t uid
, gid_t gid
);
226 int mkdir_parents(const char *path
, mode_t mode
);
227 int mkdir_p(const char *path
, mode_t mode
);
229 int parent_of_path(const char *path
, char **parent
);
231 int rmdir_parents(const char *path
, const char *stop
);
233 int get_process_name(pid_t pid
, char **name
);
234 int get_process_cmdline(pid_t pid
, size_t max_length
, char **line
);
237 int unhexchar(char c
);
239 int unoctchar(char c
);
241 int undecchar(char c
);
243 char *cescape(const char *s
);
244 char *cunescape(const char *s
);
245 char *cunescape_length(const char *s
, size_t length
);
247 char *xescape(const char *s
, const char *bad
);
249 char *bus_path_escape(const char *s
);
250 char *bus_path_unescape(const char *s
);
252 char *path_kill_slashes(char *path
);
254 bool path_startswith(const char *path
, const char *prefix
);
255 bool path_equal(const char *a
, const char *b
);
257 char *ascii_strlower(char *path
);
259 bool ignore_file(const char *filename
);
261 bool chars_intersect(const char *a
, const char *b
);
263 char *format_timestamp(char *buf
, size_t l
, usec_t t
);
264 char *format_timestamp_pretty(char *buf
, size_t l
, usec_t t
);
265 char *format_timespan(char *buf
, size_t l
, usec_t t
);
267 int make_stdio(int fd
);
268 int make_null_stdio(void);
270 bool is_clean_exit(int code
, int status
);
271 bool is_clean_exit_lsb(int code
, int status
);
273 unsigned long long random_ull(void);
275 #define DEFINE_STRING_TABLE_LOOKUP(name,type) \
276 const char *name##_to_string(type i) { \
277 if (i < 0 || i >= (type) ELEMENTSOF(name##_table)) \
279 return name##_table[i]; \
281 type name##_from_string(const char *s) { \
285 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
286 if (name##_table[i] && \
287 streq(name##_table[i], s)) \
289 if (safe_atou(s, &u) >= 0 && \
290 u < ELEMENTSOF(name##_table)) \
294 struct __useless_struct_to_allow_trailing_semicolon__
297 int fd_nonblock(int fd
, bool nonblock
);
298 int fd_cloexec(int fd
, bool cloexec
);
300 int close_all_fds(const int except
[], unsigned n_except
);
302 bool fstype_is_network(const char *fstype
);
306 int read_one_char(FILE *f
, char *ret
, bool *need_nl
);
307 int ask(char *ret
, const char *replies
, const char *text
, ...);
309 int reset_terminal(int fd
);
310 int open_terminal(const char *name
, int mode
);
311 int acquire_terminal(const char *name
, bool fail
, bool force
, bool ignore_tiocstty_eperm
);
312 int release_terminal(void);
314 int flush_fd(int fd
);
316 int ignore_signals(int sig
, ...);
317 int default_signals(int sig
, ...);
318 int sigaction_many(const struct sigaction
*sa
, ...);
320 int close_pipe(int p
[]);
322 ssize_t
loop_read(int fd
, void *buf
, size_t nbytes
, bool do_poll
);
323 ssize_t
loop_write(int fd
, const void *buf
, size_t nbytes
, bool do_poll
);
325 int path_is_mount_point(const char *path
);
327 bool is_device_path(const char *path
);
329 int dir_is_empty(const char *path
);
331 void rename_process(const char name
[8]);
333 void sigset_add_many(sigset_t
*ss
, ...);
335 char* gethostname_malloc(void);
336 char* getlogname_malloc(void);
337 int getttyname_malloc(char **r
);
339 int chmod_and_chown(const char *path
, mode_t mode
, uid_t uid
, gid_t gid
);
341 int rm_rf(const char *path
, bool only_dirs
, bool delete_root
);
343 cpu_set_t
* cpu_set_malloc(unsigned *ncpus
);
345 void status_vprintf(const char *format
, va_list ap
);
346 void status_printf(const char *format
, ...);
347 void status_welcome(void);
351 int running_in_chroot(void);
353 char *ellipsize(const char *s
, unsigned length
, unsigned percent
);
355 int touch(const char *path
);
357 char *unquote(const char *s
, const char *quotes
);
359 int wait_for_terminate(pid_t pid
, siginfo_t
*status
);
360 int wait_for_terminate_and_warn(const char *name
, pid_t pid
);
362 _noreturn_
void freeze(void);
364 bool null_or_empty(struct stat
*st
);
366 DIR *xopendirat(int dirfd
, const char *name
);
368 int ask_password_tty(const char *message
, usec_t until
, const char *flag_file
, char **_passphrase
);
370 void dual_timestamp_serialize(FILE *f
, const char *name
, dual_timestamp
*t
);
371 void dual_timestamp_deserialize(const char *value
, dual_timestamp
*t
);
373 char *fstab_node_to_udev_node(const char *p
);
375 void filter_environ(const char *prefix
);
377 #define NULSTR_FOREACH(i, l) \
378 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
380 #define NULSTR_FOREACH_PAIR(i, j, l) \
381 for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
383 const char *ioprio_class_to_string(int i
);
384 int ioprio_class_from_string(const char *s
);
386 const char *sigchld_code_to_string(int i
);
387 int sigchld_code_from_string(const char *s
);
389 const char *log_facility_to_string(int i
);
390 int log_facility_from_string(const char *s
);
392 const char *log_level_to_string(int i
);
393 int log_level_from_string(const char *s
);
395 const char *sched_policy_to_string(int i
);
396 int sched_policy_from_string(const char *s
);
398 const char *rlimit_to_string(int i
);
399 int rlimit_from_string(const char *s
);
401 const char *ip_tos_to_string(int i
);
402 int ip_tos_from_string(const char *s
);
404 const char *signal_to_string(int i
);
405 int signal_from_string(const char *s
);
407 int signal_from_string_try_harder(const char *s
);