util.h 12.9 KB
Newer Older
1
/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
Lennart Poettering's avatar
Lennart Poettering committed
2
3
4
5

#ifndef fooutilhfoo
#define fooutilhfoo

6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
/***
  This file is part of systemd.

  Copyright 2010 Lennart Poettering

  systemd is free software; you can redistribute it and/or modify it
  under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.

  systemd is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with systemd; If not, see <http://www.gnu.org/licenses/>.
***/

Lennart Poettering's avatar
Lennart Poettering committed
25
26
27
28
#include <inttypes.h>
#include <time.h>
#include <sys/time.h>
#include <stdbool.h>
29
#include <stdlib.h>
Lennart Poettering's avatar
Lennart Poettering committed
30
#include <stdio.h>
31
#include <signal.h>
32
#include <sched.h>
33
#include <limits.h>
34
#include <sys/stat.h>
35
#include <dirent.h>
Lennart Poettering's avatar
Lennart Poettering committed
36

37
38
#include "macro.h"

Lennart Poettering's avatar
Lennart Poettering committed
39
40
typedef uint64_t usec_t;

41
typedef struct dual_timestamp {
42
43
        usec_t realtime;
        usec_t monotonic;
44
} dual_timestamp;
45

46
47
48
49
50
#define MSEC_PER_SEC  1000ULL
#define USEC_PER_SEC  1000000ULL
#define USEC_PER_MSEC 1000ULL
#define NSEC_PER_SEC  1000000000ULL
#define NSEC_PER_MSEC 1000000ULL
Lennart Poettering's avatar
Lennart Poettering committed
51
52
#define NSEC_PER_USEC 1000ULL

53
54
55
56
#define USEC_PER_MINUTE (60ULL*USEC_PER_SEC)
#define USEC_PER_HOUR (60ULL*USEC_PER_MINUTE)
#define USEC_PER_DAY (24ULL*USEC_PER_HOUR)
#define USEC_PER_WEEK (7ULL*USEC_PER_DAY)
57
58
#define USEC_PER_MONTH (2629800ULL*USEC_PER_SEC)
#define USEC_PER_YEAR (31557600ULL*USEC_PER_SEC)
59

Lennart Poettering's avatar
Lennart Poettering committed
60
/* What is interpreted as whitespace? */
61
#define WHITESPACE " \t\n\r"
62
#define NEWLINE "\n\r"
63
64
#define QUOTES "\"\'"
#define COMMENTS "#;\n"
Lennart Poettering's avatar
Lennart Poettering committed
65

66
#define FORMAT_TIMESTAMP_MAX 64
67
#define FORMAT_TIMESTAMP_PRETTY_MAX 256
68
#define FORMAT_TIMESPAN_MAX 64
69

70
#define ANSI_HIGHLIGHT_ON "\x1B[1;31m"
71
#define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
72
73
#define ANSI_HIGHLIGHT_OFF "\x1B[0m"

Lennart Poettering's avatar
Lennart Poettering committed
74
75
usec_t now(clockid_t clock);

76
dual_timestamp* dual_timestamp_get(dual_timestamp *ts);
77

78
79
#define dual_timestamp_is_set(ts) ((ts)->realtime > 0)

Lennart Poettering's avatar
Lennart Poettering committed
80
81
82
83
84
85
86
usec_t timespec_load(const struct timespec *ts);
struct timespec *timespec_store(struct timespec *ts, usec_t u);

usec_t timeval_load(const struct timeval *tv);
struct timeval *timeval_store(struct timeval *tv, usec_t u);

#define streq(a,b) (strcmp((a),(b)) == 0)
87
#define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
Lennart Poettering's avatar
Lennart Poettering committed
88

89
90
bool streq_ptr(const char *a, const char *b);

Lennart Poettering's avatar
Lennart Poettering committed
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
#define new(t, n) ((t*) malloc(sizeof(t)*(n)))

#define new0(t, n) ((t*) calloc((n), sizeof(t)))

#define malloc0(n) (calloc((n), 1))

static inline const char* yes_no(bool b) {
        return b ? "yes" : "no";
}

static inline const char* strempty(const char *s) {
        return s ? s : "";
}

static inline const char* strnull(const char *s) {
        return s ? s : "(null)";
}

109
110
111
112
113
114
115
116
static inline const char *strna(const char *s) {
        return s ? s : "n/a";
}

static inline bool is_path_absolute(const char *p) {
        return *p == '/';
}

Lennart Poettering's avatar
Lennart Poettering committed
117
118
bool endswith(const char *s, const char *postfix);
bool startswith(const char *s, const char *prefix);
119
bool startswith_no_case(const char *s, const char *prefix);
Lennart Poettering's avatar
Lennart Poettering committed
120

Lennart Poettering's avatar
Lennart Poettering committed
121
122
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);
Lennart Poettering's avatar
Lennart Poettering committed
126

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);
130
131
132
133

int safe_atou(const char *s, unsigned *ret_u);
int safe_atoi(const char *s, int *ret_i);

134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
int safe_atollu(const char *s, unsigned long long *ret_u);
int safe_atolli(const char *s, long long int *ret_i);

#if __WORDSIZE == 32
static inline int safe_atolu(const char *s, unsigned long *ret_u) {
        assert_cc(sizeof(unsigned long) == sizeof(unsigned));
        return safe_atou(s, (unsigned*) ret_u);
}
static inline int safe_atoli(const char *s, long int *ret_u) {
        assert_cc(sizeof(long int) == sizeof(int));
        return safe_atoi(s, (int*) ret_u);
}
#else
static inline int safe_atolu(const char *s, unsigned long *ret_u) {
        assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
        return safe_atollu(s, (unsigned long long*) ret_u);
}
static inline int safe_atoli(const char *s, long int *ret_u) {
        assert_cc(sizeof(long int) == sizeof(long long int));
        return safe_atolli(s, (long long int*) ret_u);
}
#endif

157
158
159
160
161
static inline int safe_atou32(const char *s, uint32_t *ret_u) {
        assert_cc(sizeof(uint32_t) == sizeof(unsigned));
        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);
165
166
}

167
168
169
170
static inline int safe_atou64(const char *s, uint64_t *ret_u) {
        assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
        return safe_atollu(s, (unsigned long long*) ret_u);
}
171

172
173
174
175
static inline int safe_atoi64(const char *s, int64_t *ret_i) {
        assert_cc(sizeof(int64_t) == sizeof(long long int));
        return safe_atolli(s, (long long int*) ret_i);
}
176

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);
179

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)))
182
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)))
185

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)))
188

189
char **split_path_and_make_absolute(const char *p);
190

191
192
193
194
pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);

int write_one_line_file(const char *fn, const char *line);
int read_one_line_file(const char *fn, char **line);
195
196
int read_full_file(const char *fn, char **contents);

Dave Reisner's avatar
Dave Reisner committed
197
int parse_env_file(const char *fname, const char *separator, ...) _sentinel_;
198

Lennart Poettering's avatar
Lennart Poettering committed
199
char *strappend(const char *s, const char *suffix);
200
201
202
203
char *strnappend(const char *s, const char *suffix, size_t length);

char *replace_env(const char *format, char **env);
char **replace_env_argv(char **argv, char **env);
Lennart Poettering's avatar
Lennart Poettering committed
204

Lennart Poettering's avatar
Lennart Poettering committed
205
int readlink_malloc(const char *p, char **r);
206
int readlink_and_make_absolute(const char *p, char **r);
Lennart Poettering's avatar
Lennart Poettering committed
207
208

char *file_name_from_path(const char *p);
209
210
211
212
bool is_path(const char *p);

bool path_is_absolute(const char *p);
char *path_make_absolute(const char *p, const char *prefix);
213
char *path_make_absolute_cwd(const char *p);
214

215
char **strv_path_make_absolute_cwd(char **l);
216
char **strv_path_canonicalize(char **l);
Lennart Poettering's avatar
Lennart Poettering committed
217

218
219
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);
223

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);
Lennart Poettering's avatar
Lennart Poettering committed
227
int mkdir_p(const char *path, mode_t mode);
228

229
230
int parent_of_path(const char *path, char **parent);

231
232
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);
235

Lennart Poettering's avatar
Lennart Poettering committed
236
char hexchar(int x);
237
238
239
int unhexchar(char c);
char octchar(int x);
int unoctchar(char c);
240
241
char decchar(int x);
int undecchar(char c);
242
243
244

char *cescape(const char *s);
char *cunescape(const char *s);
245
246
247
248
249
250
char *cunescape_length(const char *s, size_t length);

char *xescape(const char *s, const char *bad);

char *bus_path_escape(const char *s);
char *bus_path_unescape(const char *s);
251
252
253
254

char *path_kill_slashes(char *path);

bool path_startswith(const char *path, const char *prefix);
255
bool path_equal(const char *a, const char *b);
256
257
258

char *ascii_strlower(char *path);

259
260
bool ignore_file(const char *filename);

261
262
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);
266

267
int make_stdio(int fd);
268
int make_null_stdio(void);
269

270
271
unsigned long long random_ull(void);

272
273
274
275
276
277
278
279
#define DEFINE_STRING_TABLE_LOOKUP(name,type)                           \
        const char *name##_to_string(type i) {                          \
                if (i < 0 || i >= (type) ELEMENTSOF(name##_table))      \
                        return NULL;                                    \
                return name##_table[i];                                 \
        }                                                               \
        type name##_from_string(const char *s) {                        \
                type i;                                                 \
Lennart Poettering's avatar
Lennart Poettering committed
280
                unsigned u = 0;                                         \
281
282
                assert(s);                                              \
                for (i = 0; i < (type)ELEMENTSOF(name##_table); i++)    \
283
284
                        if (name##_table[i] &&                          \
                            streq(name##_table[i], s))                  \
285
                                return i;                               \
286
287
288
                if (safe_atou(s, &u) >= 0 &&                            \
                    u < ELEMENTSOF(name##_table))                       \
                        return (type) u;                                \
289
290
291
292
293
                return (type) -1;                                       \
        }                                                               \
        struct __useless_struct_to_allow_trailing_semicolon__


294
295
296
int fd_nonblock(int fd, bool nonblock);
int fd_cloexec(int fd, bool cloexec);

297
298
int close_all_fds(const int except[], unsigned n_except);

299
300
bool fstype_is_network(const char *fstype);

301
302
int chvt(int vt);

Lennart Poettering's avatar
Lennart Poettering committed
303
304
305
306
307
int read_one_char(FILE *f, char *ret, bool *need_nl);
int ask(char *ret, const char *replies, const char *text, ...);

int reset_terminal(int fd);
int open_terminal(const char *name, int mode);
308
int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm);
Lennart Poettering's avatar
Lennart Poettering committed
309
310
311
312
int release_terminal(void);

int flush_fd(int fd);

313
314
315
int ignore_signals(int sig, ...);
int default_signals(int sig, ...);
int sigaction_many(const struct sigaction *sa, ...);
316

317
318
int close_pipe(int p[]);

319
320
ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
321
322
323

int path_is_mount_point(const char *path);

324
325
bool is_device_path(const char *path);

326
327
int dir_is_empty(const char *path);

328
void rename_process(const char name[8]);
329

330
331
void sigset_add_many(sigset_t *ss, ...);

332
333
char* gethostname_malloc(void);
char* getlogname_malloc(void);
334
335
336
337
338
int getttyname_malloc(char **r);

int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);

int rm_rf(const char *path, bool only_dirs, bool delete_root);
339

340
341
cpu_set_t* cpu_set_malloc(unsigned *ncpus);

342
void status_vprintf(const char *format, va_list ap);
343
344
void status_printf(const char *format, ...);
void status_welcome(void);
345

346
347
int columns(void);

348
349
int running_in_chroot(void);

350
351
char *ellipsize(const char *s, unsigned length, unsigned percent);

352
353
int touch(const char *path);

354
char *unquote(const char *s, const char *quotes);
355
char *normalize_env_assignment(const char *s);
356

357
int wait_for_terminate(pid_t pid, siginfo_t *status);
358
int wait_for_terminate_and_warn(const char *name, pid_t pid);
359

360
361
_noreturn_ void freeze(void);

362
363
bool null_or_empty(struct stat *st);

364
DIR *xopendirat(int dirfd, const char *name, int flags);
365

366
void dual_timestamp_serialize(FILE *f, const char *name, dual_timestamp *t);
367
void dual_timestamp_deserialize(const char *value, dual_timestamp *t);
368

369
370
char *fstab_node_to_udev_node(const char *p);

371
372
void filter_environ(const char *prefix);

373
374
const char *default_term_for_tty(const char *tty);

375
376
bool running_in_vm(void);

377
#define NULSTR_FOREACH(i, l)                                    \
378
379
        for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)

380
381
382
#define NULSTR_FOREACH_PAIR(i, j, l)                             \
        for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))

383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
const char *ioprio_class_to_string(int i);
int ioprio_class_from_string(const char *s);

const char *sigchld_code_to_string(int i);
int sigchld_code_from_string(const char *s);

const char *log_facility_to_string(int i);
int log_facility_from_string(const char *s);

const char *log_level_to_string(int i);
int log_level_from_string(const char *s);

const char *sched_policy_to_string(int i);
int sched_policy_from_string(const char *s);

const char *rlimit_to_string(int i);
int rlimit_from_string(const char *s);

401
402
403
const char *ip_tos_to_string(int i);
int ip_tos_from_string(const char *s);

404
405
406
const char *signal_to_string(int i);
int signal_from_string(const char *s);

407
408
int signal_from_string_try_harder(const char *s);

Lennart Poettering's avatar
Lennart Poettering committed
409
#endif