1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
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/>.
35 typedef uint64_t usec_t;
37 typedef struct timestamp {
42 #define MSEC_PER_SEC 1000ULL
43 #define USEC_PER_SEC 1000000ULL
44 #define USEC_PER_MSEC 1000ULL
45 #define NSEC_PER_SEC 1000000000ULL
46 #define NSEC_PER_MSEC 1000000ULL
47 #define NSEC_PER_USEC 1000ULL
49 #define USEC_PER_MINUTE (60ULL*USEC_PER_SEC)
50 #define USEC_PER_HOUR (60ULL*USEC_PER_MINUTE)
51 #define USEC_PER_DAY (24ULL*USEC_PER_HOUR)
52 #define USEC_PER_WEEK (7ULL*USEC_PER_DAY)
54 /* What is interpreted as whitespace? */
55 #define WHITESPACE " \t\n\r"
56 #define NEWLINE "\n\r"
58 #define FORMAT_TIMESTAMP_MAX 64
59 #define FORMAT_TIMESPAN_MAX 64
61 usec_t now(clockid_t clock);
63 timestamp* timestamp_get(timestamp *ts);
65 usec_t timespec_load(const struct timespec *ts);
66 struct timespec *timespec_store(struct timespec *ts, usec_t u);
68 usec_t timeval_load(const struct timeval *tv);
69 struct timeval *timeval_store(struct timeval *tv, usec_t u);
71 #define streq(a,b) (strcmp((a),(b)) == 0)
73 bool streq_ptr(const char *a, const char *b);
75 #define new(t, n) ((t*) malloc(sizeof(t)*(n)))
77 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
79 #define malloc0(n) (calloc((n), 1))
81 static inline const char* yes_no(bool b) {
82 return b ? "yes" : "no";
85 static inline const char* strempty(const char *s) {
89 static inline const char* strnull(const char *s) {
90 return s ? s : "(null)";
93 static inline const char *strna(const char *s) {
97 static inline bool is_path_absolute(const char *p) {
101 bool endswith(const char *s, const char *postfix);
102 bool startswith(const char *s, const char *prefix);
103 bool startswith_no_case(const char *s, const char *prefix);
105 bool first_word(const char *s, const char *word);
107 int close_nointr(int fd);
108 void close_nointr_nofail(int fd);
109 void close_many(const int fds[], unsigned n_fd);
111 int parse_boolean(const char *v);
112 int parse_usec(const char *t, usec_t *usec);
113 int parse_pid(const char *s, pid_t* ret_pid);
115 int safe_atou(const char *s, unsigned *ret_u);
116 int safe_atoi(const char *s, int *ret_i);
118 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
119 assert_cc(sizeof(uint32_t) == sizeof(unsigned));
120 return safe_atou(s, (unsigned*) ret_u);
123 static inline int safe_atoi32(const char *s, int32_t *ret_u) {
124 assert_cc(sizeof(int32_t) == sizeof(int));
125 return safe_atoi(s, (int*) ret_u);
128 int safe_atolu(const char *s, unsigned long *ret_u);
129 int safe_atoli(const char *s, long int *ret_i);
131 int safe_atollu(const char *s, unsigned long long *ret_u);
132 int safe_atolli(const char *s, long long int *ret_i);
134 char *split(const char *c, size_t *l, const char *separator, char **state);
135 char *split_quoted(const char *c, size_t *l, char **state);
137 #define FOREACH_WORD(word, length, s, state) \
138 for ((state) = NULL, (word) = split((s), &(length), WHITESPACE, &(state)); (word); (word) = split((s), &(length), WHITESPACE, &(state)))
140 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state) \
141 for ((state) = NULL, (word) = split((s), &(length), (separator), &(state)); (word); (word) = split((s), &(length), (separator), &(state)))
143 #define FOREACH_WORD_QUOTED(word, length, s, state) \
144 for ((state) = NULL, (word) = split_quoted((s), &(length), &(state)); (word); (word) = split_quoted((s), &(length), &(state)))
146 char **split_path_and_make_absolute(const char *p);
148 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
150 int write_one_line_file(const char *fn, const char *line);
151 int read_one_line_file(const char *fn, char **line);
153 char *strappend(const char *s, const char *suffix);
155 int readlink_malloc(const char *p, char **r);
156 int readlink_and_make_absolute(const char *p, char **r);
158 char *file_name_from_path(const char *p);
159 bool is_path(const char *p);
161 bool path_is_absolute(const char *p);
162 char *path_make_absolute(const char *p, const char *prefix);
163 char *path_make_absolute_cwd(const char *p);
165 char **strv_path_make_absolute_cwd(char **l);
166 char **strv_path_canonicalize(char **l);
168 int reset_all_signal_handlers(void);
170 char *strstrip(char *s);
171 char *delete_chars(char *s, const char *bad);
172 char *truncate_nl(char *s);
174 char *file_in_same_dir(const char *path, const char *filename);
175 int safe_mkdir(const char *path, mode_t mode, uid_t uid, gid_t gid);
176 int mkdir_parents(const char *path, mode_t mode);
177 int mkdir_p(const char *path, mode_t mode);
179 int rmdir_parents(const char *path, const char *stop);
181 int get_process_name(pid_t pid, char **name);
184 int unhexchar(char c);
186 int unoctchar(char c);
188 int undecchar(char c);
190 char *cescape(const char *s);
191 char *cunescape(const char *s);
193 char *path_kill_slashes(char *path);
195 bool path_startswith(const char *path, const char *prefix);
196 bool path_equal(const char *a, const char *b);
198 char *ascii_strlower(char *path);
200 char *xescape(const char *s, const char *bad);
202 char *bus_path_escape(const char *s);
203 char *bus_path_unescape(const char *s);
205 bool ignore_file(const char *filename);
207 bool chars_intersect(const char *a, const char *b);
209 char *format_timestamp(char *buf, size_t l, usec_t t);
210 char *format_timespan(char *buf, size_t l, usec_t t);
212 int make_stdio(int fd);
214 bool is_clean_exit(int code, int status);
216 unsigned long long random_ull(void);
218 #define DEFINE_STRING_TABLE_LOOKUP(name,type) \
219 const char *name##_to_string(type i) { \
220 if (i < 0 || i >= (type) ELEMENTSOF(name##_table)) \
222 return name##_table[i]; \
224 type name##_from_string(const char *s) { \
228 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
229 if (streq(name##_table[i], s)) \
231 if (safe_atou(s, &u) >= 0 && \
232 u < ELEMENTSOF(name##_table)) \
236 struct __useless_struct_to_allow_trailing_semicolon__
239 int fd_nonblock(int fd, bool nonblock);
240 int fd_cloexec(int fd, bool cloexec);
242 int close_all_fds(const int except[], unsigned n_except);
244 bool fstype_is_network(const char *fstype);
248 int read_one_char(FILE *f, char *ret, bool *need_nl);
249 int ask(char *ret, const char *replies, const char *text, ...);
251 int reset_terminal(int fd);
252 int open_terminal(const char *name, int mode);
253 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm);
254 int release_terminal(void);
256 int flush_fd(int fd);
258 int ignore_signals(int sig, ...);
259 int default_signals(int sig, ...);
260 int sigaction_many(const struct sigaction *sa, ...);
262 int close_pipe(int p[]);
264 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
265 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
267 int path_is_mount_point(const char *path);
269 bool is_device_path(const char *path);
271 int dir_is_empty(const char *path);
273 void rename_process(const char name[8]);
275 void sigset_add_many(sigset_t *ss, ...);
277 char* gethostname_malloc(void);
278 char* getlogname_malloc(void);
279 int getttyname_malloc(char **r);
280 int getmachineid_malloc(char **r);
282 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
284 int rm_rf(const char *path, bool only_dirs, bool delete_root);
286 const char *ioprio_class_to_string(int i);
287 int ioprio_class_from_string(const char *s);
289 const char *sigchld_code_to_string(int i);
290 int sigchld_code_from_string(const char *s);
292 const char *log_facility_to_string(int i);
293 int log_facility_from_string(const char *s);
295 const char *log_level_to_string(int i);
296 int log_level_from_string(const char *s);
298 const char *sched_policy_to_string(int i);
299 int sched_policy_from_string(const char *s);
301 const char *rlimit_to_string(int i);
302 int rlimit_from_string(const char *s);