]> git.ipfire.org Git - people/ms/systemd.git/blame - util.h
execute: typo fix
[people/ms/systemd.git] / util.h
CommitLineData
60918275
LP
1/*-*- Mode: C; c-basic-offset: 8 -*-*/
2
3#ifndef fooutilhfoo
4#define fooutilhfoo
5
a7334b09
LP
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
60918275
LP
25#include <inttypes.h>
26#include <time.h>
27#include <sys/time.h>
28#include <stdbool.h>
5cb5a6ff 29#include <stdlib.h>
80876c20 30#include <stdio.h>
60918275
LP
31
32typedef uint64_t usec_t;
33
034c6ed7
LP
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
60918275
LP
39#define NSEC_PER_USEC 1000ULL
40
24a6e4a4
LP
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
44d8db9e 46/* What is interpreted as whitespace? */
4a72ff34 47#define WHITESPACE " \t\n\r"
7072ced8 48#define NEWLINE "\n\r"
44d8db9e 49
8b6c7120
LP
50#define FORMAT_TIMESTAMP_MAX 64
51
60918275
LP
52usec_t now(clockid_t clock);
53
54usec_t timespec_load(const struct timespec *ts);
55struct timespec *timespec_store(struct timespec *ts, usec_t u);
56
57usec_t timeval_load(const struct timeval *tv);
58struct timeval *timeval_store(struct timeval *tv, usec_t u);
59
60#define streq(a,b) (strcmp((a),(b)) == 0)
61
e05797fb
LP
62bool streq_ptr(const char *a, const char *b);
63
60918275
LP
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
70static inline const char* yes_no(bool b) {
71 return b ? "yes" : "no";
72}
73
74static inline const char* strempty(const char *s) {
75 return s ? s : "";
76}
77
78static inline const char* strnull(const char *s) {
79 return s ? s : "(null)";
80}
81
04fd6fe4
LP
82static inline const char *strna(const char *s) {
83 return s ? s : "n/a";
84}
85
86static inline bool is_path_absolute(const char *p) {
87 return *p == '/';
88}
89
60918275
LP
90bool endswith(const char *s, const char *postfix);
91bool startswith(const char *s, const char *prefix);
92
79d6d816
LP
93bool first_word(const char *s, const char *word);
94
42f4e3c4 95int close_nointr(int fd);
85f136b5 96void close_nointr_nofail(int fd);
60918275 97
85261803 98int parse_boolean(const char *v);
24a6e4a4 99int parse_usec(const char *t, usec_t *usec);
85261803
LP
100
101int safe_atou(const char *s, unsigned *ret_u);
102int safe_atoi(const char *s, int *ret_i);
103
034c6ed7
LP
104int safe_atolu(const char *s, unsigned long *ret_u);
105int safe_atoli(const char *s, long int *ret_i);
106
107int safe_atollu(const char *s, unsigned long long *ret_u);
108int safe_atolli(const char *s, long long int *ret_i);
109
65d2ebdc 110char *split(const char *c, size_t *l, const char *separator, char **state);
034c6ed7 111char *split_quoted(const char *c, size_t *l, char **state);
a41e8209 112
034c6ed7 113#define FOREACH_WORD(word, length, s, state) \
f62c0e4f 114 for ((state) = NULL, (word) = split((s), &(length), WHITESPACE, &(state)); (word); (word) = split((s), &(length), WHITESPACE, &(state)))
65d2ebdc
LP
115
116#define FOREACH_WORD_SEPARATOR(word, length, s, separator, state) \
f62c0e4f 117 for ((state) = NULL, (word) = split((s), &(length), (separator), &(state)); (word); (word) = split((s), &(length), (separator), &(state)))
a41e8209 118
034c6ed7 119#define FOREACH_WORD_QUOTED(word, length, s, state) \
f62c0e4f 120 for ((state) = NULL, (word) = split_quoted((s), &(length), &(state)); (word); (word) = split_quoted((s), &(length), &(state)))
034c6ed7 121
65d2ebdc 122char **split_path_and_make_absolute(const char *p);
82919e3d 123
034c6ed7
LP
124pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
125
126int write_one_line_file(const char *fn, const char *line);
127int read_one_line_file(const char *fn, char **line);
128
44d8db9e
LP
129char *strappend(const char *s, const char *suffix);
130
87f0e418
LP
131int readlink_malloc(const char *p, char **r);
132
133char *file_name_from_path(const char *p);
0301abf4
LP
134bool is_path(const char *p);
135
136bool path_is_absolute(const char *p);
137char *path_make_absolute(const char *p, const char *prefix);
65d2ebdc
LP
138char *path_make_absolute_cwd(const char *p);
139char **strv_path_make_absolute_cwd(char **l);
87f0e418 140
2a987ee8
LP
141int reset_all_signal_handlers(void);
142
4a72ff34 143char *strstrip(char *s);
ee9b5e01 144char *delete_chars(char *s, const char *bad);
7072ced8 145char *truncate_nl(char *s);
ee9b5e01 146
4a72ff34 147char *file_in_same_dir(const char *path, const char *filename);
a9f5d454 148int mkdir_parents(const char *path, mode_t mode);
bbd67135 149int mkdir_p(const char *path, mode_t mode);
4a72ff34 150
7072ced8
LP
151int get_process_name(pid_t pid, char **name);
152
fb624d04 153char hexchar(int x);
4fe88d28
LP
154int unhexchar(char c);
155char octchar(int x);
156int unoctchar(char c);
5af98f82
LP
157char decchar(int x);
158int undecchar(char c);
4fe88d28
LP
159
160char *cescape(const char *s);
161char *cunescape(const char *s);
162
163char *path_kill_slashes(char *path);
164
165bool path_startswith(const char *path, const char *prefix);
15ae422b 166bool path_equal(const char *a, const char *b);
4fe88d28
LP
167
168char *ascii_strlower(char *path);
169
170char *xescape(const char *s, const char *bad);
fb624d04 171
ea430986
LP
172char *bus_path_escape(const char *s);
173char *bus_path_unescape(const char *s);
174
c85dc17b
LP
175bool ignore_file(const char *filename);
176
db12775d
LP
177bool chars_intersect(const char *a, const char *b);
178
8b6c7120
LP
179char *format_timestamp(char *buf, size_t l, usec_t t);
180
1dccbe19
LP
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; \
a7610064 189 unsigned u = 0; \
1dccbe19
LP
190 assert(s); \
191 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
192 if (streq(name##_table[i], s)) \
193 return i; \
d3725859
LP
194 if (safe_atou(s, &u) >= 0 && \
195 u < ELEMENTSOF(name##_table)) \
196 return (type) u; \
1dccbe19
LP
197 return (type) -1; \
198 } \
199 struct __useless_struct_to_allow_trailing_semicolon__
200
201
3a0ecb08
LP
202int fd_nonblock(int fd, bool nonblock);
203int fd_cloexec(int fd, bool cloexec);
204
a0d40ac5
LP
205int close_all_fds(const int except[], unsigned n_except);
206
42856c10
LP
207bool fstype_is_network(const char *fstype);
208
601f6a1e
LP
209int chvt(int vt);
210
80876c20
LP
211int read_one_char(FILE *f, char *ret, bool *need_nl);
212int ask(char *ret, const char *replies, const char *text, ...);
213
214int reset_terminal(int fd);
215int open_terminal(const char *name, int mode);
216int acquire_terminal(const char *name, bool fail, bool force);
217int release_terminal(void);
218
219int flush_fd(int fd);
220
a337c6fc
LP
221int ignore_signal(int sig);
222
8d567588
LP
223int close_pipe(int p[]);
224
225ssize_t loop_read(int fd, void *buf, size_t nbytes);
226
227int path_is_mount_point(const char *path);
228
2d368c14
LP
229extern char * __progname;
230
1dccbe19
LP
231const char *ioprio_class_to_string(int i);
232int ioprio_class_from_string(const char *s);
233
234const char *sigchld_code_to_string(int i);
235int sigchld_code_from_string(const char *s);
236
237const char *log_facility_to_string(int i);
238int log_facility_from_string(const char *s);
239
240const char *log_level_to_string(int i);
241int log_level_from_string(const char *s);
242
243const char *sched_policy_to_string(int i);
244int sched_policy_from_string(const char *s);
245
246const char *rlimit_to_string(int i);
247int rlimit_from_string(const char *s);
248
60918275 249#endif