1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
6 This file is part of systemd.
8 Copyright 2010 Lennart Poettering
10 systemd is free software; you can redistribute it and/or modify it
11 under the terms of the GNU Lesser General Public License as published by
12 the Free Software Foundation; either version 2.1 of the License, or
13 (at your option) any later version.
15 systemd is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
20 You should have received a copy of the GNU Lesser General Public License
21 along with systemd; If not, see <http://www.gnu.org/licenses/>.
34 #include <sys/types.h>
37 #include <sys/resource.h>
41 typedef uint64_t usec_t;
42 typedef uint64_t nsec_t;
44 typedef struct dual_timestamp {
49 #define MSEC_PER_SEC 1000ULL
50 #define USEC_PER_SEC 1000000ULL
51 #define USEC_PER_MSEC 1000ULL
52 #define NSEC_PER_SEC 1000000000ULL
53 #define NSEC_PER_MSEC 1000000ULL
54 #define NSEC_PER_USEC 1000ULL
56 #define USEC_PER_MINUTE (60ULL*USEC_PER_SEC)
57 #define NSEC_PER_MINUTE (60ULL*NSEC_PER_SEC)
58 #define USEC_PER_HOUR (60ULL*USEC_PER_MINUTE)
59 #define NSEC_PER_HOUR (60ULL*NSEC_PER_MINUTE)
60 #define USEC_PER_DAY (24ULL*USEC_PER_HOUR)
61 #define NSEC_PER_DAY (24ULL*NSEC_PER_HOUR)
62 #define USEC_PER_WEEK (7ULL*USEC_PER_DAY)
63 #define NSEC_PER_WEEK (7ULL*NSEC_PER_DAY)
64 #define USEC_PER_MONTH (2629800ULL*USEC_PER_SEC)
65 #define NSEC_PER_MONTH (2629800ULL*NSEC_PER_SEC)
66 #define USEC_PER_YEAR (31557600ULL*USEC_PER_SEC)
67 #define NSEC_PER_YEAR (31557600ULL*NSEC_PER_SEC)
69 /* What is interpreted as whitespace? */
70 #define WHITESPACE " \t\n\r"
71 #define NEWLINE "\n\r"
73 #define COMMENTS "#;\n"
75 #define FORMAT_TIMESTAMP_MAX 64
76 #define FORMAT_TIMESTAMP_PRETTY_MAX 256
77 #define FORMAT_TIMESPAN_MAX 64
78 #define FORMAT_BYTES_MAX 8
80 #define ANSI_HIGHLIGHT_ON "\x1B[1;39m"
81 #define ANSI_HIGHLIGHT_RED_ON "\x1B[1;31m"
82 #define ANSI_HIGHLIGHT_GREEN_ON "\x1B[1;32m"
83 #define ANSI_HIGHLIGHT_YELLOW_ON "\x1B[1;33m"
84 #define ANSI_HIGHLIGHT_OFF "\x1B[0m"
86 usec_t now(clockid_t clock);
88 dual_timestamp* dual_timestamp_get(dual_timestamp *ts);
89 dual_timestamp* dual_timestamp_from_realtime(dual_timestamp *ts, usec_t u);
91 #define dual_timestamp_is_set(ts) ((ts)->realtime > 0)
93 usec_t timespec_load(const struct timespec *ts);
94 struct timespec *timespec_store(struct timespec *ts, usec_t u);
96 usec_t timeval_load(const struct timeval *tv);
97 struct timeval *timeval_store(struct timeval *tv, usec_t u);
99 size_t page_size(void);
100 #define PAGE_ALIGN(l) ALIGN_TO((l), page_size())
102 #define streq(a,b) (strcmp((a),(b)) == 0)
103 #define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
105 bool streq_ptr(const char *a, const char *b);
107 #define new(t, n) ((t*) malloc(sizeof(t)*(n)))
109 #define new0(t, n) ((t*) calloc((n), sizeof(t)))
111 #define newa(t, n) ((t*) alloca(sizeof(t)*(n)))
113 #define newdup(t, p, n) ((t*) memdup(p, sizeof(t)*(n)))
115 #define malloc0(n) (calloc((n), 1))
117 static inline const char* yes_no(bool b) {
118 return b ? "yes" : "no";
121 static inline const char* strempty(const char *s) {
125 static inline const char* strnull(const char *s) {
126 return s ? s : "(null)";
129 static inline const char *strna(const char *s) {
130 return s ? s : "n/a";
133 static inline bool isempty(const char *p) {
137 bool endswith(const char *s, const char *postfix);
138 bool startswith(const char *s, const char *prefix);
139 bool startswith_no_case(const char *s, const char *prefix);
141 bool first_word(const char *s, const char *word);
143 int close_nointr(int fd);
144 void close_nointr_nofail(int fd);
145 void close_many(const int fds[], unsigned n_fd);
147 int parse_boolean(const char *v);
148 int parse_usec(const char *t, usec_t *usec);
149 int parse_nsec(const char *t, nsec_t *nsec);
150 int parse_bytes(const char *t, off_t *bytes);
151 int parse_pid(const char *s, pid_t* ret_pid);
152 int parse_uid(const char *s, uid_t* ret_uid);
153 #define parse_gid(s, ret_uid) parse_uid(s, ret_uid)
155 int safe_atou(const char *s, unsigned *ret_u);
156 int safe_atoi(const char *s, int *ret_i);
158 int safe_atollu(const char *s, unsigned long long *ret_u);
159 int safe_atolli(const char *s, long long int *ret_i);
162 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
163 assert_cc(sizeof(unsigned long) == sizeof(unsigned));
164 return safe_atou(s, (unsigned*) ret_u);
166 static inline int safe_atoli(const char *s, long int *ret_u) {
167 assert_cc(sizeof(long int) == sizeof(int));
168 return safe_atoi(s, (int*) ret_u);
171 static inline int safe_atolu(const char *s, unsigned long *ret_u) {
172 assert_cc(sizeof(unsigned long) == sizeof(unsigned long long));
173 return safe_atollu(s, (unsigned long long*) ret_u);
175 static inline int safe_atoli(const char *s, long int *ret_u) {
176 assert_cc(sizeof(long int) == sizeof(long long int));
177 return safe_atolli(s, (long long int*) ret_u);
181 static inline int safe_atou32(const char *s, uint32_t *ret_u) {
182 assert_cc(sizeof(uint32_t) == sizeof(unsigned));
183 return safe_atou(s, (unsigned*) ret_u);
186 static inline int safe_atoi32(const char *s, int32_t *ret_i) {
187 assert_cc(sizeof(int32_t) == sizeof(int));
188 return safe_atoi(s, (int*) ret_i);
191 static inline int safe_atou64(const char *s, uint64_t *ret_u) {
192 assert_cc(sizeof(uint64_t) == sizeof(unsigned long long));
193 return safe_atollu(s, (unsigned long long*) ret_u);
196 static inline int safe_atoi64(const char *s, int64_t *ret_i) {
197 assert_cc(sizeof(int64_t) == sizeof(long long int));
198 return safe_atolli(s, (long long int*) ret_i);
201 char *split(const char *c, size_t *l, const char *separator, char **state);
202 char *split_quoted(const char *c, size_t *l, char **state);
204 #define FOREACH_WORD(word, length, s, state) \
205 for ((state) = NULL, (word) = split((s), &(length), WHITESPACE, &(state)); (word); (word) = split((s), &(length), WHITESPACE, &(state)))
207 #define FOREACH_WORD_SEPARATOR(word, length, s, separator, state) \
208 for ((state) = NULL, (word) = split((s), &(length), (separator), &(state)); (word); (word) = split((s), &(length), (separator), &(state)))
210 #define FOREACH_WORD_QUOTED(word, length, s, state) \
211 for ((state) = NULL, (word) = split_quoted((s), &(length), &(state)); (word); (word) = split_quoted((s), &(length), &(state)))
213 pid_t get_parent_of_pid(pid_t pid, pid_t *ppid);
214 int get_starttime_of_pid(pid_t pid, unsigned long long *st);
216 int write_one_line_file(const char *fn, const char *line);
217 int write_one_line_file_atomic(const char *fn, const char *line);
218 int read_one_line_file(const char *fn, char **line);
219 int read_full_file(const char *fn, char **contents, size_t *size);
221 int parse_env_file(const char *fname, const char *separator, ...) _sentinel_;
222 int load_env_file(const char *fname, char ***l);
223 int write_env_file(const char *fname, char **l);
225 char *strappend(const char *s, const char *suffix);
226 char *strnappend(const char *s, const char *suffix, size_t length);
228 char *replace_env(const char *format, char **env);
229 char **replace_env_argv(char **argv, char **env);
231 int readlink_malloc(const char *p, char **r);
232 int readlink_and_make_absolute(const char *p, char **r);
233 int readlink_and_canonicalize(const char *p, char **r);
235 int reset_all_signal_handlers(void);
237 char *strstrip(char *s);
238 char *delete_chars(char *s, const char *bad);
239 char *truncate_nl(char *s);
241 char *file_in_same_dir(const char *path, const char *filename);
243 int rmdir_parents(const char *path, const char *stop);
245 int get_process_comm(pid_t pid, char **name);
246 int get_process_cmdline(pid_t pid, size_t max_length, bool comm_fallback, char **line);
247 int get_process_exe(pid_t pid, char **name);
248 int get_process_uid(pid_t pid, uid_t *uid);
249 int get_process_gid(pid_t pid, gid_t *gid);
252 int unhexchar(char c);
254 int unoctchar(char c);
256 int undecchar(char c);
258 char *cescape(const char *s);
259 char *cunescape(const char *s);
260 char *cunescape_length(const char *s, size_t length);
261 char *cunescape_length_with_prefix(const char *s, size_t length, const char *prefix);
263 char *xescape(const char *s, const char *bad);
265 char *bus_path_escape(const char *s);
266 char *bus_path_unescape(const char *s);
268 char *ascii_strlower(char *path);
270 bool dirent_is_file(const struct dirent *de);
271 bool dirent_is_file_with_suffix(const struct dirent *de, const char *suffix);
273 bool ignore_file(const char *filename);
275 bool chars_intersect(const char *a, const char *b);
277 char *format_timestamp(char *buf, size_t l, usec_t t);
278 char *format_timestamp_pretty(char *buf, size_t l, usec_t t);
279 char *format_timespan(char *buf, size_t l, usec_t t);
281 int make_stdio(int fd);
282 int make_null_stdio(void);
283 int make_console_stdio(void);
285 unsigned long long random_ull(void);
287 #define __DEFINE_STRING_TABLE_LOOKUP(name,type,scope) \
288 scope const char *name##_to_string(type i) { \
289 if (i < 0 || i >= (type) ELEMENTSOF(name##_table)) \
291 return name##_table[i]; \
293 scope type name##_from_string(const char *s) { \
297 for (i = 0; i < (type)ELEMENTSOF(name##_table); i++) \
298 if (name##_table[i] && \
299 streq(name##_table[i], s)) \
301 if (safe_atou(s, &u) >= 0 && \
302 u < ELEMENTSOF(name##_table)) \
306 struct __useless_struct_to_allow_trailing_semicolon__
308 #define DEFINE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,)
309 #define DEFINE_PRIVATE_STRING_TABLE_LOOKUP(name,type) __DEFINE_STRING_TABLE_LOOKUP(name,type,static)
311 int fd_nonblock(int fd, bool nonblock);
312 int fd_cloexec(int fd, bool cloexec);
314 int close_all_fds(const int except[], unsigned n_except);
316 bool fstype_is_network(const char *fstype);
320 int read_one_char(FILE *f, char *ret, usec_t timeout, bool *need_nl);
321 int ask(char *ret, const char *replies, const char *text, ...);
323 int reset_terminal_fd(int fd, bool switch_to_text);
324 int reset_terminal(const char *name);
326 int open_terminal(const char *name, int mode);
327 int acquire_terminal(const char *name, bool fail, bool force, bool ignore_tiocstty_eperm, usec_t timeout);
328 int release_terminal(void);
330 int flush_fd(int fd);
332 int ignore_signals(int sig, ...);
333 int default_signals(int sig, ...);
334 int sigaction_many(const struct sigaction *sa, ...);
336 int close_pipe(int p[]);
337 int fopen_temporary(const char *path, FILE **_f, char **_temp_path);
339 ssize_t loop_read(int fd, void *buf, size_t nbytes, bool do_poll);
340 ssize_t loop_write(int fd, const void *buf, size_t nbytes, bool do_poll);
342 bool is_device_path(const char *path);
344 int dir_is_empty(const char *path);
346 void rename_process(const char name[8]);
348 void sigset_add_many(sigset_t *ss, ...);
350 bool hostname_is_set(void);
352 char* gethostname_malloc(void);
353 char* getlogname_malloc(void);
354 char* getusername_malloc(void);
356 int getttyname_malloc(int fd, char **r);
357 int getttyname_harder(int fd, char **r);
359 int get_ctty_devnr(pid_t pid, dev_t *d);
360 int get_ctty(pid_t, dev_t *_devnr, char **r);
362 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid);
363 int fchmod_and_fchown(int fd, mode_t mode, uid_t uid, gid_t gid);
365 int rm_rf_children(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
366 int rm_rf_children_dangerous(int fd, bool only_dirs, bool honour_sticky, struct stat *root_dev);
367 int rm_rf(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
368 int rm_rf_dangerous(const char *path, bool only_dirs, bool delete_root, bool honour_sticky);
370 int pipe_eof(int fd);
372 cpu_set_t* cpu_set_malloc(unsigned *ncpus);
374 int status_vprintf(const char *status, bool ellipse, const char *format, va_list ap);
375 int status_printf(const char *status, bool ellipse, const char *format, ...);
376 int status_welcome(void);
378 int fd_columns(int fd);
379 unsigned columns(void);
380 unsigned columns_uncached(void);
382 int fd_lines(int fd);
383 unsigned lines(void);
385 int running_in_chroot(void);
387 char *ellipsize(const char *s, size_t length, unsigned percent);
388 char *ellipsize_mem(const char *s, size_t old_length, size_t new_length, unsigned percent);
390 int touch(const char *path);
392 char *unquote(const char *s, const char *quotes);
393 char *normalize_env_assignment(const char *s);
395 int wait_for_terminate(pid_t pid, siginfo_t *status);
396 int wait_for_terminate_and_warn(const char *name, pid_t pid);
398 _noreturn_ void freeze(void);
400 bool null_or_empty(struct stat *st);
401 int null_or_empty_path(const char *fn);
403 DIR *xopendirat(int dirfd, const char *name, int flags);
405 void dual_timestamp_serialize(FILE *f, const char *name, dual_timestamp *t);
406 void dual_timestamp_deserialize(const char *value, dual_timestamp *t);
408 char *fstab_node_to_udev_node(const char *p);
410 bool tty_is_vc(const char *tty);
411 bool tty_is_vc_resolve(const char *tty);
412 bool tty_is_console(const char *tty);
413 int vtnr_from_tty(const char *tty);
414 const char *default_term_for_tty(const char *tty);
416 void execute_directory(const char *directory, DIR *_d, char *argv[]);
418 int kill_and_sigcont(pid_t pid, int sig);
420 bool nulstr_contains(const char*nulstr, const char *needle);
422 bool plymouth_running(void);
424 bool hostname_is_valid(const char *s);
425 char* hostname_cleanup(char *s);
427 char* strshorten(char *s, size_t l);
429 int terminal_vhangup_fd(int fd);
430 int terminal_vhangup(const char *name);
432 int vt_disallocate(const char *name);
434 int copy_file(const char *from, const char *to);
436 int symlink_atomic(const char *from, const char *to);
438 int fchmod_umask(int fd, mode_t mode);
440 bool display_is_local(const char *display);
441 int socket_from_display(const char *display, char **path);
443 int get_user_creds(const char **username, uid_t *uid, gid_t *gid, const char **home, const char **shell);
444 int get_group_creds(const char **groupname, gid_t *gid);
446 int in_group(const char *name);
448 int glob_exists(const char *path);
450 int dirent_ensure_type(DIR *d, struct dirent *de);
452 int in_search_path(const char *path, char **search);
453 int get_files_in_directory(const char *path, char ***list);
455 char *strjoin(const char *x, ...) _sentinel_;
457 bool is_main_thread(void);
459 bool in_charset(const char *s, const char* charset);
461 int block_get_whole_disk(dev_t d, dev_t *ret);
463 int file_is_priv_sticky(const char *p);
465 int strdup_or_null(const char *a, char **b);
467 #define NULSTR_FOREACH(i, l) \
468 for ((i) = (l); (i) && *(i); (i) = strchr((i), 0)+1)
470 #define NULSTR_FOREACH_PAIR(i, j, l) \
471 for ((i) = (l), (j) = strchr((i), 0)+1; (i) && *(i); (i) = strchr((j), 0)+1, (j) = *(i) ? strchr((i), 0)+1 : (i))
473 const char *ioprio_class_to_string(int i);
474 int ioprio_class_from_string(const char *s);
476 const char *sigchld_code_to_string(int i);
477 int sigchld_code_from_string(const char *s);
479 const char *log_facility_unshifted_to_string(int i);
480 int log_facility_unshifted_from_string(const char *s);
482 const char *log_level_to_string(int i);
483 int log_level_from_string(const char *s);
485 const char *sched_policy_to_string(int i);
486 int sched_policy_from_string(const char *s);
488 const char *rlimit_to_string(int i);
489 int rlimit_from_string(const char *s);
491 const char *ip_tos_to_string(int i);
492 int ip_tos_from_string(const char *s);
494 const char *signal_to_string(int i);
495 int signal_from_string(const char *s);
497 int signal_from_string_try_harder(const char *s);
499 extern int saved_argc;
500 extern char **saved_argv;
502 bool kexec_loaded(void);
504 int prot_from_flags(int flags);
506 char *format_bytes(char *buf, size_t l, off_t t);
508 int fd_wait_for_event(int fd, int event, usec_t timeout);
510 void* memdup(const void *p, size_t l);
512 int is_kernel_thread(pid_t pid);
514 int fd_inc_sndbuf(int fd, size_t n);
515 int fd_inc_rcvbuf(int fd, size_t n);
517 int fork_agent(pid_t *pid, const int except[], unsigned n_except, const char *path, ...);
519 int setrlimit_closest(int resource, const struct rlimit *rlim);
521 int getenv_for_pid(pid_t pid, const char *field, char **_value);
523 int can_sleep(const char *type);
525 bool is_valid_documentation_url(const char *url);
527 bool in_initrd(void);
529 void warn_melody(void);
531 int get_shell(char **ret);
532 int get_home_dir(char **ret);
535 void fclosep(FILE **f);
536 void closep(int *fd);
537 void closedirp(DIR **d);
538 void umaskp(mode_t *u);