blob: a0a1c31695eeb0df7899f0b7250e61b7e9c7882b [file] [log] [blame]
landley09ea7ac2006-10-30 01:38:00 -05001/* lib.h - header file for lib directory
2 *
3 * Copyright 2006 Rob Landley <rob@landley.net>
4 */
landley4f344e32006-10-05 16:18:03 -04005
Rob Landley0a04b3e2006-11-03 00:05:52 -05006// llist.c
Rob Landley0a04b3e2006-11-03 00:05:52 -05007
Rob Landleyeb7ea222012-04-14 22:30:41 -05008// All these list types can be handled by the same code because first element
Rob Landleye5f3a0b2013-03-17 17:57:28 -05009// is always next pointer, so next = (mytype *)&struct. (The payloads are
10// named differently to catch using the wrong type early.)
Rob Landleyeb7ea222012-04-14 22:30:41 -050011
Rob Landley0a04b3e2006-11-03 00:05:52 -050012struct string_list {
Rob Landley7aa651a2012-11-13 17:14:08 -060013 struct string_list *next;
14 char str[0];
Rob Landley0a04b3e2006-11-03 00:05:52 -050015};
16
Rob Landley8324b892006-11-19 02:49:22 -050017struct arg_list {
Rob Landley7aa651a2012-11-13 17:14:08 -060018 struct arg_list *next;
19 char *arg;
Rob Landley8324b892006-11-19 02:49:22 -050020};
21
Rob Landleybc078652007-12-15 21:47:25 -060022struct double_list {
Rob Landley7aa651a2012-11-13 17:14:08 -060023 struct double_list *next, *prev;
24 char *data;
Rob Landleybc078652007-12-15 21:47:25 -060025};
26
Rob Landley9e2b6db2012-07-15 17:22:04 -050027void llist_traverse(void *list, void (*using)(void *data));
Rob Landley5f57bcc2013-09-09 04:26:03 -050028void *llist_pop(void *list); // actually void **list
29void *dlist_pop(void *list); // actually struct double_list **list
Rob Landley2c482472012-03-12 00:25:40 -050030void dlist_add_nomalloc(struct double_list **list, struct double_list *new);
Rob Landleybdf037f2008-10-23 16:44:30 -050031struct double_list *dlist_add(struct double_list **list, char *data);
Rob Landley6ef04ef2008-01-20 17:34:53 -060032
Rob Landley103b7e02007-10-04 02:04:10 -050033// args.c
34void get_optflags(void);
35
36// dirtree.c
Rob Landleyeb7ea222012-04-14 22:30:41 -050037
38// Values returnable from callback function (bitfield, or them together)
39// Default with no callback is 0
40
Rob Landley8c4ae8a2012-05-20 15:00:19 -050041// Add this node to the tree
42#define DIRTREE_SAVE 1
43// Recurse into children
44#define DIRTREE_RECURSE 2
45// Call again after handling all children of this directory
46// (Ignored for non-directories, sets linklen = -1 before second call.)
Rob Landleyeb7ea222012-04-14 22:30:41 -050047#define DIRTREE_COMEAGAIN 4
48// Follow symlinks to directories
49#define DIRTREE_SYMFOLLOW 8
Rob Landley8c4ae8a2012-05-20 15:00:19 -050050// Don't look at any more files in this directory.
51#define DIRTREE_ABORT 256
Rob Landleyeb7ea222012-04-14 22:30:41 -050052
53#define DIRTREE_ABORTVAL ((struct dirtree *)1)
54
Rob Landleyd25f7e42007-02-03 14:11:26 -050055struct dirtree {
Rob Landley7aa651a2012-11-13 17:14:08 -060056 struct dirtree *next, *parent, *child;
57 long extra; // place for user to store their stuff (can be pointer)
58 struct stat st;
59 char *symlink;
60 int data; // dirfd for directory, linklen for symlink, -1 = comeagain
61 char name[];
Rob Landleyd25f7e42007-02-03 14:11:26 -050062};
63
Rob Landley3162c272012-12-06 15:13:30 -060064struct dirtree *dirtree_add_node(struct dirtree *p, char *name, int symfollow);
Rob Landleyeb7ea222012-04-14 22:30:41 -050065char *dirtree_path(struct dirtree *node, int *plen);
Rob Landley8c4ae8a2012-05-20 15:00:19 -050066int dirtree_notdotdot(struct dirtree *catch);
Rob Landley6ec21782012-06-16 15:16:08 -050067int dirtree_parentfd(struct dirtree *node);
Rob Landley090c5c62012-12-31 14:38:13 -060068struct dirtree *dirtree_handle_callback(struct dirtree *new,
Rob Landley7aa651a2012-11-13 17:14:08 -060069 int (*callback)(struct dirtree *node));
Rob Landleyeb7ea222012-04-14 22:30:41 -050070void dirtree_recurse(struct dirtree *node,
Rob Landley7aa651a2012-11-13 17:14:08 -060071 int (*callback)(struct dirtree *node), int symfollow);
Rob Landleyeb7ea222012-04-14 22:30:41 -050072struct dirtree *dirtree_read(char *path, int (*callback)(struct dirtree *node));
Rob Landley8324b892006-11-19 02:49:22 -050073
Rob Landley36ffc5a2013-04-14 21:43:22 -050074// help.c
75
76void show_help(void);
77
Rob Landley72756672013-07-17 17:22:46 -050078// xwrap.c
Rob Landleybe93c912013-04-20 23:33:48 -050079void xstrncpy(char *dest, char *src, size_t size);
Rob Landley55830302013-06-16 19:59:51 -050080void xexit(void) noreturn;
landley4f344e32006-10-05 16:18:03 -040081void *xmalloc(size_t size);
landleycd9dfc32006-10-18 18:38:16 -040082void *xzalloc(size_t size);
Rob Landley0c93f6c2007-04-29 19:55:21 -040083void *xrealloc(void *ptr, size_t size);
Rob Landley1e01cd12010-01-05 10:48:32 -060084char *xstrndup(char *s, size_t n);
85char *xstrdup(char *s);
landley00f87f12006-10-25 18:38:37 -040086char *xmsprintf(char *format, ...);
Rob Landley24d1d452007-01-20 18:04:20 -050087void xprintf(char *format, ...);
Rob Landley5084fea2007-06-18 00:14:03 -040088void xputs(char *s);
Rob Landley24d1d452007-01-20 18:04:20 -050089void xputc(char c);
90void xflush(void);
Rob Landley72756672013-07-17 17:22:46 -050091void xexec_optargs(int skip);
landley09ea7ac2006-10-30 01:38:00 -050092void xexec(char **argv);
Rob Landleyd3e9d642007-01-08 03:25:47 -050093void xaccess(char *path, int flags);
Rob Landleye745d8e2007-12-20 06:30:19 -060094void xunlink(char *path);
Rob Landley1322beb2007-01-07 22:51:12 -050095int xcreate(char *path, int flags, int mode);
96int xopen(char *path, int flags);
Rob Landleybc078652007-12-15 21:47:25 -060097void xclose(int fd);
Rob Landleyeb7ea222012-04-14 22:30:41 -050098int xdup(int fd);
Rob Landley1aa75112013-08-07 12:19:51 -050099FILE *xfdopen(int fd, char *mode);
landley4f344e32006-10-05 16:18:03 -0400100FILE *xfopen(char *path, char *mode);
Rob Landley90163772007-01-18 21:54:08 -0500101size_t xread(int fd, void *buf, size_t len);
102void xreadall(int fd, void *buf, size_t len);
103void xwrite(int fd, void *buf, size_t len);
Rob Landley52476712009-01-18 16:19:25 -0600104off_t xlseek(int fd, off_t offset, int whence);
Rob Landleye824ed12008-07-18 08:43:18 -0500105char *xreadfile(char *name);
Rob Landleyf0153442013-04-26 02:41:05 -0500106int xioctl(int fd, int request, void *data);
landley00f87f12006-10-25 18:38:37 -0400107char *xgetcwd(void);
Rob Landleyd25f7e42007-02-03 14:11:26 -0500108void xstat(char *path, struct stat *st);
Rob Landleyfe91e682012-11-22 21:18:09 -0600109char *xabspath(char *path, int exact);
Rob Landleyeec46372012-06-01 13:50:41 -0500110char *xrealpath(char *path);
Rob Landley988abb32008-05-12 00:52:27 -0500111void xchdir(char *path);
Rob Landley35483412007-12-27 21:36:33 -0600112void xmkpath(char *path, int mode);
Rob Landleye0377fb2010-01-05 12:17:05 -0600113void xsetuid(uid_t uid);
Rob Landleyd3904932013-07-16 00:04:56 -0500114char *xreadlink(char *name);
Rob Landley72756672013-07-17 17:22:46 -0500115long xparsetime(char *arg, long units, long *fraction);
Felix Jandadccfb2a2013-08-26 21:55:33 +0200116void xpidfile(char *name);
Rob Landleyd3904932013-07-16 00:04:56 -0500117
118// lib.c
119void verror_msg(char *msg, int err, va_list va);
120void error_msg(char *msg, ...);
121void perror_msg(char *msg, ...);
122void error_exit(char *msg, ...) noreturn;
123void perror_exit(char *msg, ...) noreturn;
124ssize_t readall(int fd, void *buf, size_t len);
125ssize_t writeall(int fd, void *buf, size_t len);
126off_t lskip(int fd, off_t offset);
127struct string_list **splitpath(char *path, struct string_list **list);
Rob Landley8fdcfdb2013-09-03 17:56:28 -0500128char *readfile(char *name, char *buf, off_t len);
Rob Landleyd3904932013-07-16 00:04:56 -0500129void msleep(long miliseconds);
130int64_t peek(void *ptr, int size);
131void poke(void *ptr, uint64_t val, int size);
Rob Landley0a04b3e2006-11-03 00:05:52 -0500132struct string_list *find_in_path(char *path, char *filename);
Rob Landleyf5757162007-02-16 21:08:22 -0500133long atolx(char *c);
Rob Landleyeb7ea222012-04-14 22:30:41 -0500134int numlen(long l);
Rob Landley2037b832012-07-15 16:56:20 -0500135int stridx(char *haystack, char needle);
Rob Landleye2580db2007-01-23 13:20:38 -0500136off_t fdlength(int fd);
Rob Landleyad63f4b2011-12-12 15:19:52 -0600137void loopfiles_rw(char **argv, int flags, int permissions, int failok,
Rob Landley7aa651a2012-11-13 17:14:08 -0600138 void (*function)(int fd, char *name));
Rob Landley7634b552007-11-29 17:49:50 -0600139void loopfiles(char **argv, void (*function)(int fd, char *name));
Rob Landley3fc4e0f2008-04-13 00:29:00 -0500140char *get_rawline(int fd, long *plen, char end);
Rob Landleybc078652007-12-15 21:47:25 -0600141char *get_line(int fd);
142void xsendfile(int in, int out);
Rob Landley67a069d2012-06-03 00:32:12 -0500143int wfchmodat(int rc, char *name, mode_t mode);
Rob Landley42ecbab2007-12-18 02:02:21 -0600144int copy_tempfile(int fdin, char *name, char **tempname);
145void delete_tempfile(int fdin, int fdout, char **tempname);
146void replace_tempfile(int fdin, int fdout, char **tempname);
Rob Landleyb15b8fa2009-01-05 01:05:43 -0600147void crc_init(unsigned int *crc_table, int little_endian);
Rob Landley10bdaa42013-11-07 09:04:50 -0600148int terminal_size(unsigned *x, unsigned *y);
Rob Landleyf793d532012-02-27 21:56:49 -0600149int yesno(char *prompt, int def);
landley4f344e32006-10-05 16:18:03 -0400150
Rob Landleyf0153442013-04-26 02:41:05 -0500151// net.c
152int xsocket(int domain, int type, int protocol);
153
landleycd9dfc32006-10-18 18:38:16 -0400154// getmountlist.c
landley4f344e32006-10-05 16:18:03 -0400155struct mtab_list {
Rob Landley7aa651a2012-11-13 17:14:08 -0600156 struct mtab_list *next;
157 struct stat stat;
158 struct statvfs statvfs;
159 char *dir;
160 char *device;
161 char type[0];
landley4f344e32006-10-05 16:18:03 -0400162};
163
Rob Landley42adb7a2013-08-30 17:34:24 -0500164struct mtab_list *xgetmountlist(char *path);
landley4f344e32006-10-05 16:18:03 -0400165
Rob Landley6000f132007-01-18 22:00:12 -0500166void bunzipStream(int src_fd, int dst_fd);
Rob Landley2dd50ad2012-02-26 13:48:00 -0600167
168// signal
169
Rob Landleyc52db602012-07-30 01:01:33 -0500170void sigatexit(void *handler);
Rob Landley2dd50ad2012-02-26 13:48:00 -0600171int sig_to_num(char *pidstr);
172char *num_to_sig(int sig);
Daniel Walter05744b32012-03-19 19:57:56 -0500173
174mode_t string_to_mode(char *mode_str, mode_t base);
Rob Landley5a26a862013-06-02 00:24:24 -0500175void mode_to_string(mode_t mode, char *buf);
Rob Landley2c917f52012-07-17 08:54:47 -0500176
Rob Landley34b91a92013-11-10 18:20:16 -0600177#include "lib/pending.h"