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 Lesser General Public License as published by
13 the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
21 You should have received a copy of the GNU Lesser General Public License
22 along with systemd; If not, see <http://www.gnu.org/licenses/>.
37 #include <sys/resource.h>
41 typedef uint64_t usec_t;
43 typedef struct dual_timestamp {
48 #define MSEC_PER_SEC 1000ULL
49 #define USEC_PER_SEC 1000000ULL
50 #define USEC_PER_MSEC 1000ULL
51 #define NSEC_PER_SEC 1000000000ULL
52 #define NSEC_PER_MSEC 1000000ULL
53 #define NSEC_PER_USEC 1000ULL
55 #define USEC_PER_MINUTE (60ULL*USEC_PER_SEC)
56 #define USEC_PER_HOUR (60ULL*USEC_PER_MINUTE)
57 #define USEC_PER_DAY (24ULL*USEC_PER_HOUR)
58 #define USEC_PER_WEEK (7ULL*USEC_PER_DAY)
59 #define USEC_PER_MONTH (2629800ULL*USEC_PER_SEC)
60 #define USEC_PER_YEAR (31557600ULL*USEC_PER_SEC)
62 /* What is interpreted as whitespace? */
63 #define WHITESPACE " \t\n\r"
64 #define NEWLINE "\n\r"
66 #define COMMENTS "#;\n"
68 #define FORMAT_TIMESTAMP_MAX 64
69 #define FORMAT_TIMESTAMP_PRETTY_MAX 256
70 #define FORMAT_TIMESPAN_MAX 64
71 #define FORMAT_BYTES_MAX 8
73 #define ANSI_HIGHLIGHT_ON "\x1B[1;39m"
74 #define ANSI_HIGHLIGHT_RED_ON "\x1B[1;31m"
75 #define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
76 #define ANSI_HIGHLIGHT_YELLOW_ON "\x1B[1;33m"
77 #define ANSI_HIGHLIGHT_OFF "\x1B[0m"
79 usec_t now(clockid_t clock);
81 dual_timestamp* dual_timestamp_get(dual_timestamp *ts);
82 dual_timestamp* dual_timestamp_from_realtime(dual_timestamp *ts, usec_t u);
84 #define dual_timestamp_is_set(ts) ((ts)->realtime > 0)
86 usec_t timespec_load(const struct timespec *ts);
87 struct timespec *timespec_store(struct timespec *ts, usec_t u);
89 usec_t timeval_load(const struct timeval *tv);
90 struct timeval *timeval_store(struct timeval *tv, usec_t u);
92 size_t page_size(void);
93 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
95 #define streq(a,b) (strcmp((a),(b)) == 0)
96 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
98 bool streq_ptr(const char *a, const char *b);
100 #define new(t, n) ((t*) malloc(sizeof(t)*(n)))
102 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
104 #define newa(t, n) ((t*) alloca(sizeof(t)*(n)))
106 #define newdup(t, p, n) ((t*) memdup(p, sizeof(t)*(n)))
108 #define malloc0(n) (calloc((n), 1))
110 static inline const char* yes_no(bool b) {
111 return b ? "yes" : "no";
114 static inline const char* strempty(const char *s) {
118 static inline const char* strnull(const char *s) {
119 return s ? s : "(null)";
122 static inline const char *strna(const char *s) {
123 return s ? s : "n/a";
126 static inline bool isempty(const char *p) {
130 bool endswith(const char *s, const char *postfix);
131 bool startswith(const char *s, const char *prefix);
132 bool startswith_no_case(const char *s, const char *prefix);
134 bool first_word(const char *s, const char *word);
136 int close_nointr(int fd);
137 void close_nointr_nofail(int fd);
138 void close_many(const int fds[], unsigned n_fd);
140 int parse_boolean(const char *v);
141 int parse_usec(const char *t, usec_t *usec);
142 int parse_bytes(const char *t, off_t *bytes);
143 int parse_pid(const char *s, pid_t* ret_pid);
144 int parse_uid(const char *s, uid_t* ret_uid);
145 #define parse_gid(s, ret_uid) parse_uid(s, ret_uid)
147 int safe_atou(const char *s, unsigned *ret_u);
148 int safe_atoi(const char *s, int *ret_i);
150 int safe_atollu(const char *s, unsigned long long *ret_u);
151 int safe_atolli(const char *s, long long int *ret_i);
154 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
155 assert_cc(sizeof(unsigned long) == sizeof(unsigned));
156 return safe_atou(s, (unsigned*) ret_u);
158 static inline int safe_atoli(const char *s, long int *ret_u) {
159 assert_cc(sizeof(long int) == sizeof(int));
160 return safe_atoi(s, (int*) ret_u);
163 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
164 assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
165 return safe_atollu(s, (unsigned long long*) ret_u);
167 static inline int safe_atoli(const char *s, long int *ret_u) {
168 assert_cc(sizeof(long int) == sizeof(long long int));
169 return safe_atolli(s, (long long int*) ret_u);
173 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
174 assert_cc(sizeof(uint32_t) == sizeof(unsigned));
175 return safe_atou(s, (unsigned*) ret_u);
178 static inline int safe_atoi32(const char *s, int32_t *ret_i) {
179 assert_cc(sizeof(int32_t) == sizeof(int));
180 return safe_atoi(s, (int*) ret_i);
183 static inline int safe_atou64(const char *s, uint64_t *ret_u) {
184 assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
185 return safe_atollu(s, (unsigned long long*) ret_u);
188 static inline int safe_atoi64(const char *s, int64_t *ret_i) {
189 assert_cc(sizeof(int64_t) == sizeof(long long int));
190 return safe_atolli(s, (long long int*) ret_i);
193 char *split(const char *c, size_t *l, const char *separator, char **state);
194 char *split_quoted(const char *c, size_t *l, char **state);
196 #define FOREACH_WORD(word, length, s, state) \
197 for ((state) = NULL, (word) = split((s), &(length), WHITESPACE, &(state)); (word); (word) = split((s), &(length), WHITESPACE, &(state)))
199 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state) \
200 for ((state) = NULL, (word) = split((s), &(length), (separator), &(state)); (word); (word) = split((s), &(length), (separator), &(state)))
202 #define FOREACH_WORD_QUOTED(word, length, s, state) \
203 for ((state) = NULL, (word) = split_quoted((s), &(length), &(state)); (word); (word) = split_quoted((s), &(length), &(state)))
205 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
206 int get_starttime_of_pid(pid_t pid, unsigned long long *st);
208 int write_one_line_file(const char *fn, const char *line);
209 int write_one_line_file_atomic(const char *fn, const char *line);
210 int read_one_line_file(const char *fn, char **line);
211 int read_full_file(const char *fn, char **contents, size_t *size);
213 int parse_env_file(const char *fname, const char *separator, ...) _sentinel_;
214 int load_env_file(const char *fname, char ***l);
215 int write_env_file(const char *fname, char **l);
217 char *strappend(const char *s, const char *suffix);
218 char *strnappend(const char *s, const char *suffix, size_t length);
220 char *replace_env(const char *format, char **env);
221 char **replace_env_argv(char **argv, char **env);
223 int readlink_malloc(const char *p, char **r);
224 int readlink_and_make_absolute(const char *p, char **r);
225 int readlink_and_canonicalize(const char *p, char **r);
227 int reset_all_signal_handlers(void);
229 char *strstrip(char *s);
230 char *delete_chars(char *s, const char *bad);
231 char *truncate_nl(char *s);
233 char *file_in_same_dir(const char *path, const char *filename);
235 int rmdir_parents(const char *path, const char *stop);
237 int get_process_comm(pid_t pid, char **name);
238 int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
239 int get_process_exe(pid_t pid, char **name);
240 int get_process_uid(pid_t pid, uid_t *uid);
243 int unhexchar(char c);
245 int unoctchar(char c);
247 int undecchar(char c);
249 char *cescape(const char *s);
250 char *cunescape(const char *s);
251 char *cunescape_length(const char *s, size_t length);
253 char *xescape(const char *s, const char *bad);
255 char *bus_path_escape(const char *s);
256 char *bus_path_unescape(const char *s);
258 char *ascii_strlower(char *path);
260 bool dirent_is_file(const struct dirent *de);
261 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix);
263 bool ignore_file(const char *filename);
265 bool chars_intersect(const char *a, const char *b);
267 char *format_timestamp(char *buf, size_t l, usec_t t);
268 char *format_timestamp_pretty(char *buf, size_t l, usec_t t);
269 char *format_timespan(char *buf, size_t l, usec_t t);
271 int make_stdio(int fd);
272 int make_null_stdio(void);
274 unsigned long long random_ull(void);
276 #define __DEFINE_STRING_TABLE_LOOKUP(name,type,scope) \
277 scope const char *name##_to_string(type i) { \
278 if (i < 0 || i >= (type) ELEMENTSOF(name##_table)) \
280 return name##_table[i]; \
282 scope type name##_from_string(const char *s) { \
286 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
287 if (name##_table[i] && \
288 streq(name##_table[i], s)) \
290 if (safe_atou(s, &u) >= 0 && \
291 u < ELEMENTSOF(name##_table)) \
295 struct __useless_struct_to_allow_trailing_semicolon__
297 #define DEFINE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,)
298 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,static)
300 int fd_nonblock(int fd, bool nonblock);
301 int fd_cloexec(int fd, bool cloexec);
303 int close_all_fds(const int except[], unsigned n_except);
305 bool fstype_is_network(const char *fstype);
309 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
310 int ask(char *ret, const char *replies, const char *text, ...);
312 int reset_terminal_fd(int fd, bool switch_to_text);
313 int reset_terminal(const char *name);
315 int open_terminal(const char *name, int mode);
316 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm);
317 int release_terminal(void);
319 int flush_fd(int fd);
321 int ignore_signals(int sig, ...);
322 int default_signals(int sig, ...);
323 int sigaction_many(const struct sigaction *sa, ...);
325 int close_pipe(int p[]);
326 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
328 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
329 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
331 bool is_device_path(const char *path);
333 int dir_is_empty(const char *path);
335 void rename_process(const char name[8]);
337 void sigset_add_many(sigset_t *ss, ...);
339 char* gethostname_malloc(void);
340 bool hostname_is_set(void);
341 char* getlogname_malloc(void);
343 int getttyname_malloc(int fd, char **r);
344 int getttyname_harder(int fd, char **r);
346 int get_ctty_devnr(pid_t pid, dev_t *d);
347 int get_ctty(pid_t, dev_t *_devnr, char **r);
349 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
350 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
352 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
354 int pipe_eof(int fd);
356 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
358 void status_vprintf(const char *status, bool ellipse, const char *format, va_list ap);
359 void status_printf(const char *status, bool ellipse, const char *format, ...);
360 void status_welcome(void);
362 int fd_columns(int fd);
363 unsigned columns(void);
365 int fd_lines(int fd);
366 unsigned lines(void);
368 int running_in_chroot(void);
370 char *ellipsize(const char *s, size_t length, unsigned percent);
371 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
373 int touch(const char *path);
375 char *unquote(const char *s, const char *quotes);
376 char *normalize_env_assignment(const char *s);
378 int wait_for_terminate(pid_t pid, siginfo_t *status);
379 int wait_for_terminate_and_warn(const char *name, pid_t pid);
381 _noreturn_ void freeze(void);
383 bool null_or_empty(struct stat *st);
384 int null_or_empty_path(const char *fn);
386 DIR *xopendirat(int dirfd, const char *name, int flags);
388 void dual_timestamp_serialize(FILE *f, const char *name, dual_timestamp *t);
389 void dual_timestamp_deserialize(const char *value, dual_timestamp *t);
391 char *fstab_node_to_udev_node(const char *p);
393 bool tty_is_vc(const char *tty);
394 bool tty_is_vc_resolve(const char *tty);
395 bool tty_is_console(const char *tty);
396 int vtnr_from_tty(const char *tty);
397 const char *default_term_for_tty(const char *tty);
399 void execute_directory(const char *directory, DIR *_d, char *argv[]);
401 int kill_and_sigcont(pid_t pid, int sig);
403 bool nulstr_contains(const char*nulstr, const char *needle);
405 bool plymouth_running(void);
407 void parse_syslog_priority(char **p, int *priority);
408 void skip_syslog_pid(char **buf);
409 void skip_syslog_date(char **buf);
411 bool hostname_is_valid(const char *s);
412 char* hostname_cleanup(char *s);
414 char* strshorten(char *s, size_t l);
416 int terminal_vhangup_fd(int fd);
417 int terminal_vhangup(const char *name);
419 int vt_disallocate(const char *name);
421 int copy_file(const char *from, const char *to);
422 int symlink_or_copy(const char *from, const char *to);
423 int symlink_or_copy_atomic(const char *from, const char *to);
425 int fchmod_umask(int fd, mode_t mode);
427 bool display_is_local(const char *display);
428 int socket_from_display(const char *display, char **path);
430 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home);
431 int get_group_creds(const char **groupname, gid_t *gid);
433 int in_group(const char *name);
435 int glob_exists(const char *path);
437 int dirent_ensure_type(DIR *d, struct dirent *de);
439 int in_search_path(const char *path, char **search);
440 int get_files_in_directory(const char *path, char ***list);
442 char *join(const char *x, ...) _sentinel_;
444 bool is_main_thread(void);
446 bool in_charset(const char *s, const char* charset);
448 int block_get_whole_disk(dev_t d, dev_t *ret);
450 int file_is_priv_sticky(const char *p);
452 int strdup_or_null(const char *a, char **b);
454 #define NULSTR_FOREACH(i, l) \
455 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
457 #define NULSTR_FOREACH_PAIR(i, j, l) \
458 for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
460 const char *ioprio_class_to_string(int i);
461 int ioprio_class_from_string(const char *s);
463 const char *sigchld_code_to_string(int i);
464 int sigchld_code_from_string(const char *s);
466 const char *log_facility_unshifted_to_string(int i);
467 int log_facility_unshifted_from_string(const char *s);
469 const char *log_level_to_string(int i);
470 int log_level_from_string(const char *s);
472 const char *sched_policy_to_string(int i);
473 int sched_policy_from_string(const char *s);
475 const char *rlimit_to_string(int i);
476 int rlimit_from_string(const char *s);
478 const char *ip_tos_to_string(int i);
479 int ip_tos_from_string(const char *s);
481 const char *signal_to_string(int i);
482 int signal_from_string(const char *s);
484 int signal_from_string_try_harder(const char *s);
486 extern int saved_argc;
487 extern char **saved_argv;
489 bool kexec_loaded(void);
491 int prot_from_flags(int flags);
493 char *format_bytes(char *buf, size_t l, off_t t);
495 int fd_wait_for_event(int fd, int event, usec_t timeout);
497 void* memdup(const void *p, size_t l);
499 int is_kernel_thread(pid_t pid);
501 int fd_inc_sndbuf(int fd, size_t n);
502 int fd_inc_rcvbuf(int fd, size_t n);
504 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
506 int setrlimit_closest(int resource, const struct rlimit *rlim);
508 int getenv_for_pid(pid_t pid, const char *field, char **_value);
510 int can_sleep(const char *type);
512 bool is_valid_documentation_url(const char *url);