]> git.ipfire.org Git - people/ms/systemd.git/blob - util.h
service: treat 0 timeouts as no timeouts
[people/ms/systemd.git] / util.h
1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
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 <stdbool.h>
29 #include <stdlib.h>
30 #include <stdio.h>
31
32 typedef uint64_t usec_t;
33
34 #define MSEC_PER_SEC 1000ULL
35 #define USEC_PER_SEC 1000000ULL
36 #define USEC_PER_MSEC 1000ULL
37 #define NSEC_PER_SEC 1000000000ULL
38 #define NSEC_PER_MSEC 1000000ULL
39 #define NSEC_PER_USEC 1000ULL
40
41 #define USEC_PER_MINUTE (60ULL*USEC_PER_SEC)
42 #define USEC_PER_HOUR (60ULL*USEC_PER_MINUTE)
43 #define USEC_PER_DAY (24ULL*USEC_PER_HOUR)
44 #define USEC_PER_WEEK (7ULL*USEC_PER_DAY)
45
46 /* What is interpreted as whitespace? */
47 #define WHITESPACE " \t\n\r"
48 #define NEWLINE "\n\r"
49
50 #define FORMAT_TIMESTAMP_MAX 64
51
52 usec_t now(clockid_t clock);
53
54 usec_t timespec_load(const struct timespec *ts);
55 struct timespec *timespec_store(struct timespec *ts, usec_t u);
56
57 usec_t timeval_load(const struct timeval *tv);
58 struct timeval *timeval_store(struct timeval *tv, usec_t u);
59
60 #define streq(a,b) (strcmp((a),(b)) == 0)
61
62 bool streq_ptr(const char *a, const char *b);
63
64 #define new(t, n) ((t*) malloc(sizeof(t)*(n)))
65
66 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
67
68 #define malloc0(n) (calloc((n), 1))
69
70 static inline const char* yes_no(bool b) {
71 return b ? "yes" : "no";
72 }
73
74 static inline const char* strempty(const char *s) {
75 return s ? s : "";
76 }
77
78 static inline const char* strnull(const char *s) {
79 return s ? s : "(null)";
80 }
81
82 static inline const char *strna(const char *s) {
83 return s ? s : "n/a";
84 }
85
86 static inline bool is_path_absolute(const char *p) {
87 return *p == '/';
88 }
89
90 bool endswith(const char *s, const char *postfix);
91 bool startswith(const char *s, const char *prefix);
92
93 bool first_word(const char *s, const char *word);
94
95 int close_nointr(int fd);
96 void close_nointr_nofail(int fd);
97
98 int parse_boolean(const char *v);
99 int parse_usec(const char *t, usec_t *usec);
100
101 int safe_atou(const char *s, unsigned *ret_u);
102 int safe_atoi(const char *s, int *ret_i);
103
104 int safe_atolu(const char *s, unsigned long *ret_u);
105 int safe_atoli(const char *s, long int *ret_i);
106
107 int safe_atollu(const char *s, unsigned long long *ret_u);
108 int safe_atolli(const char *s, long long int *ret_i);
109
110 char *split(const char *c, size_t *l, const char *separator, char **state);
111 char *split_quoted(const char *c, size_t *l, char **state);
112
113 #define FOREACH_WORD(word, length, s, state) \
114 for ((state) = NULL, (word) = split((s), &(length), WHITESPACE, &(state)); (word); (word) = split((s), &(length), WHITESPACE, &(state)))
115
116 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state) \
117 for ((state) = NULL, (word) = split((s), &(length), (separator), &(state)); (word); (word) = split((s), &(length), (separator), &(state)))
118
119 #define FOREACH_WORD_QUOTED(word, length, s, state) \
120 for ((state) = NULL, (word) = split_quoted((s), &(length), &(state)); (word); (word) = split_quoted((s), &(length), &(state)))
121
122 char **split_path_and_make_absolute(const char *p);
123
124 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
125
126 int write_one_line_file(const char *fn, const char *line);
127 int read_one_line_file(const char *fn, char **line);
128
129 char *strappend(const char *s, const char *suffix);
130
131 int readlink_malloc(const char *p, char **r);
132
133 char *file_name_from_path(const char *p);
134 bool is_path(const char *p);
135
136 bool path_is_absolute(const char *p);
137 char *path_make_absolute(const char *p, const char *prefix);
138 char *path_make_absolute_cwd(const char *p);
139 char **strv_path_make_absolute_cwd(char **l);
140
141 int reset_all_signal_handlers(void);
142
143 char *strstrip(char *s);
144 char *delete_chars(char *s, const char *bad);
145 char *truncate_nl(char *s);
146
147 char *file_in_same_dir(const char *path, const char *filename);
148 int mkdir_parents(const char *path, mode_t mode);
149 int mkdir_p(const char *path, mode_t mode);
150
151 int get_process_name(pid_t pid, char **name);
152
153 char hexchar(int x);
154 int unhexchar(char c);
155 char octchar(int x);
156 int unoctchar(char c);
157 char decchar(int x);
158 int undecchar(char c);
159
160 char *cescape(const char *s);
161 char *cunescape(const char *s);
162
163 char *path_kill_slashes(char *path);
164
165 bool path_startswith(const char *path, const char *prefix);
166 bool path_equal(const char *a, const char *b);
167
168 char *ascii_strlower(char *path);
169
170 char *xescape(const char *s, const char *bad);
171
172 char *bus_path_escape(const char *s);
173 char *bus_path_unescape(const char *s);
174
175 bool ignore_file(const char *filename);
176
177 bool chars_intersect(const char *a, const char *b);
178
179 char *format_timestamp(char *buf, size_t l, usec_t t);
180
181 #define DEFINE_STRING_TABLE_LOOKUP(name,type) \
182 const char *name##_to_string(type i) { \
183 if (i < 0 || i >= (type) ELEMENTSOF(name##_table)) \
184 return NULL; \
185 return name##_table[i]; \
186 } \
187 type name##_from_string(const char *s) { \
188 type i; \
189 unsigned u = 0; \
190 assert(s); \
191 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
192 if (streq(name##_table[i], s)) \
193 return i; \
194 if (safe_atou(s, &u) >= 0 && \
195 u < ELEMENTSOF(name##_table)) \
196 return (type) u; \
197 return (type) -1; \
198 } \
199 struct __useless_struct_to_allow_trailing_semicolon__
200
201
202 int fd_nonblock(int fd, bool nonblock);
203 int fd_cloexec(int fd, bool cloexec);
204
205 int close_all_fds(const int except[], unsigned n_except);
206
207 bool fstype_is_network(const char *fstype);
208
209 int chvt(int vt);
210
211 int read_one_char(FILE *f, char *ret, bool *need_nl);
212 int ask(char *ret, const char *replies, const char *text, ...);
213
214 int reset_terminal(int fd);
215 int open_terminal(const char *name, int mode);
216 int acquire_terminal(const char *name, bool fail, bool force);
217 int release_terminal(void);
218
219 int flush_fd(int fd);
220
221 int ignore_signal(int sig);
222
223 int close_pipe(int p[]);
224
225 ssize_t loop_read(int fd, void *buf, size_t nbytes);
226
227 int path_is_mount_point(const char *path);
228
229 extern char * __progname;
230
231 const char *ioprio_class_to_string(int i);
232 int ioprio_class_from_string(const char *s);
233
234 const char *sigchld_code_to_string(int i);
235 int sigchld_code_from_string(const char *s);
236
237 const char *log_facility_to_string(int i);
238 int log_facility_from_string(const char *s);
239
240 const char *log_level_to_string(int i);
241 int log_level_from_string(const char *s);
242
243 const char *sched_policy_to_string(int i);
244 int sched_policy_from_string(const char *s);
245
246 const char *rlimit_to_string(int i);
247 int rlimit_from_string(const char *s);
248
249 #endif