1 /* lib.h - header file for lib directory
3 * Copyright 2006 Rob Landley <rob@landley.net>
18 // All these list types can be handled by the same code because first element
19 // is always next pointer, so next = (mytype *)&struct. (The payloads are
20 // named differently to catch using the wrong type early.)
23 struct string_list *next;
28 struct arg_list *next;
33 struct double_list *next, *prev;
38 struct num_cache *next;
43 void llist_free_arg(void *node);
44 void llist_free_double(void *node);
45 void llist_traverse(void *list, void (*using)(void *node));
46 void *llist_pop(void *list); // actually void **list
47 void *dlist_pop(void *list); // actually struct double_list **list
48 void dlist_add_nomalloc(struct double_list **list, struct double_list *new);
49 struct double_list *dlist_add(struct double_list **list, char *data);
50 void *dlist_terminate(void *list);
51 struct num_cache *get_num_cache(struct num_cache *cache, long long num);
52 struct num_cache *add_num_cache(struct num_cache **cache, long long num,
56 void get_optflags(void);
60 // Values returnable from callback function (bitfield, or them together)
61 // Default with no callback is 0
63 // Add this node to the tree
64 #define DIRTREE_SAVE 1
65 // Recurse into children
66 #define DIRTREE_RECURSE 2
67 // Call again after handling all children of this directory
68 // (Ignored for non-directories, sets linklen = -1 before second call.)
69 #define DIRTREE_COMEAGAIN 4
70 // Follow symlinks to directories
71 #define DIRTREE_SYMFOLLOW 8
72 // Don't warn about failure to stat
73 #define DIRTREE_SHUTUP 16
74 // Breadth first traversal, conserves filehandles at the expense of memory
75 #define DIRTREE_BREADTH 32
76 // Don't look at any more files in this directory.
77 #define DIRTREE_ABORT 256
79 #define DIRTREE_ABORTVAL ((struct dirtree *)1)
82 struct dirtree *next, *parent, *child;
83 long extra; // place for user to store their stuff (can be pointer)
91 int isdotdot(char *name);
92 struct dirtree *dirtree_add_node(struct dirtree *p, char *name, int flags);
93 char *dirtree_path(struct dirtree *node, int *plen);
94 int dirtree_notdotdot(struct dirtree *catch);
95 int dirtree_parentfd(struct dirtree *node);
96 int dirtree_recurse(struct dirtree *node, int (*callback)(struct dirtree *node),
97 int dirfd, int symfollow);
98 struct dirtree *dirtree_flagread(char *path, int flags,
99 int (*callback)(struct dirtree *node));
100 struct dirtree *dirtree_read(char *path, int (*callback)(struct dirtree *node));
104 void show_help(FILE *out);
106 // Tell xopen and friends to print warnings but return -1 as necessary
107 // The largest O_BLAH flag so far is arch/alpha's O_PATH at 0x800000 so
108 // plenty of headroom.
109 #define WARN_ONLY (1<<31)
112 void xstrncpy(char *dest, char *src, size_t size);
113 void xstrncat(char *dest, char *src, size_t size);
114 void _xexit(void) noreturn;
115 void xexit(void) noreturn;
116 void *xmalloc(size_t size);
117 void *xzalloc(size_t size);
118 void *xrealloc(void *ptr, size_t size);
119 char *xstrndup(char *s, size_t n);
120 char *xstrdup(char *s);
121 void *xmemdup(void *s, long len);
122 char *xmprintf(char *format, ...) printf_format;
123 void xprintf(char *format, ...) printf_format;
127 void xexec(char **argv);
128 pid_t xpopen_both(char **argv, int *pipes);
129 int xwaitpid(pid_t pid);
130 int xpclose_both(pid_t pid, int *pipes);
131 pid_t xpopen(char **argv, int *pipe, int stdout);
132 pid_t xpclose(pid_t pid, int pipe);
133 int xrun(char **argv);
134 int xpspawn(char **argv, int*pipes);
135 void xaccess(char *path, int flags);
136 void xunlink(char *path);
137 int xcreate(char *path, int flags, int mode);
138 int xopen(char *path, int flags);
139 int xcreate_stdio(char *path, int flags, int mode);
140 int xopen_stdio(char *path, int flags);
141 int openro(char *path, int flags);
142 int xopenro(char *path);
146 int notstdio(int fd);
147 FILE *xfdopen(int fd, char *mode);
148 FILE *xfopen(char *path, char *mode);
149 size_t xread(int fd, void *buf, size_t len);
150 void xreadall(int fd, void *buf, size_t len);
151 void xwrite(int fd, void *buf, size_t len);
152 off_t xlseek(int fd, off_t offset, int whence);
153 char *xreadfile(char *name, char *buf, off_t len);
154 int xioctl(int fd, int request, void *data);
156 void xstat(char *path, struct stat *st);
157 char *xabspath(char *path, int exact);
158 void xchdir(char *path);
159 void xchroot(char *path);
160 struct passwd *xgetpwuid(uid_t uid);
161 struct group *xgetgrgid(gid_t gid);
162 struct passwd *xgetpwnam(char *name);
163 struct group *xgetgrnam(char *name);
164 unsigned xgetuid(char *name);
165 unsigned xgetgid(char *name);
166 void xsetuser(struct passwd *pwd);
167 char *xreadlink(char *name);
168 long xparsetime(char *arg, long units, long *fraction);
169 void xpidfile(char *name);
170 void xregcomp(regex_t *preg, char *rexec, int cflags);
171 char *xtzset(char *new);
172 void xsignal(int signal, void *handler);
175 void verror_msg(char *msg, int err, va_list va);
176 void error_msg(char *msg, ...) printf_format;
177 void perror_msg(char *msg, ...) printf_format;
178 void error_exit(char *msg, ...) printf_format noreturn;
179 void perror_exit(char *msg, ...) printf_format noreturn;
180 void help_exit(char *msg, ...) printf_format noreturn;
181 void error_msg_raw(char *msg);
182 void perror_msg_raw(char *msg);
183 void error_exit_raw(char *msg);
184 void perror_exit_raw(char *msg);
185 ssize_t readall(int fd, void *buf, size_t len);
186 ssize_t writeall(int fd, void *buf, size_t len);
187 off_t lskip(int fd, off_t offset);
188 int mkpathat(int atfd, char *dir, mode_t lastmode, int flags);
189 struct string_list **splitpath(char *path, struct string_list **list);
190 char *readfileat(int dirfd, char *name, char *buf, off_t *len);
191 char *readfile(char *name, char *buf, off_t len);
192 void msleep(long miliseconds);
193 int64_t peek_le(void *ptr, unsigned size);
194 int64_t peek_be(void *ptr, unsigned size);
195 int64_t peek(void *ptr, unsigned size);
196 void poke(void *ptr, uint64_t val, int size);
197 struct string_list *find_in_path(char *path, char *filename);
198 long long estrtol(char *str, char **end, int base);
199 long long xstrtol(char *str, char **end, int base);
200 long long atolx(char *c);
201 long long atolx_range(char *numstr, long long low, long long high);
202 int stridx(char *haystack, char needle);
203 char *strlower(char *s);
204 char *strafter(char *haystack, char *needle);
205 char *chomp(char *s);
206 int unescape(char c);
207 int strstart(char **a, char *b);
208 off_t fdlength(int fd);
209 void loopfiles_rw(char **argv, int flags, int permissions,
210 void (*function)(int fd, char *name));
211 void loopfiles(char **argv, void (*function)(int fd, char *name));
212 void xsendfile(int in, int out);
213 int wfchmodat(int rc, char *name, mode_t mode);
214 int copy_tempfile(int fdin, char *name, char **tempname);
215 void delete_tempfile(int fdin, int fdout, char **tempname);
216 void replace_tempfile(int fdin, int fdout, char **tempname);
217 void crc_init(unsigned int *crc_table, int little_endian);
218 void base64_init(char *p);
220 int qstrcmp(const void *a, const void *b);
221 void create_uuid(char *uuid);
222 char *show_uuid(char *uuid);
223 char *next_printf(char *s, char **start);
224 char *strnstr(char *line, char *str);
225 int dev_minor(int dev);
226 int dev_major(int dev);
227 int dev_makedev(int major, int minor);
228 struct passwd *bufgetpwuid(uid_t uid);
229 struct group *bufgetgrgid(gid_t gid);
230 int readlinkat0(int dirfd, char *path, char *buf, int len);
231 int readlink0(char *path, char *buf, int len);
232 int regexec0(regex_t *preg, char *string, long len, int nmatch,
233 regmatch_t pmatch[], int eflags);
234 char *getusername(uid_t uid);
235 char *getgroupname(gid_t gid);
236 void do_lines(int fd, void (*call)(char **pline, long len));
238 #define HR_SPACE 1 // Space between number and units
239 #define HR_B 2 // Use "B" for single byte units
240 #define HR_1000 4 // Use decimal instead of binary units
241 int human_readable(char *buf, unsigned long long num, int style);
247 struct ptr_len idx[];
250 void linestack_addstack(struct linestack **lls, struct linestack *throw,
252 void linestack_insert(struct linestack **lls, long pos, char *line, long len);
253 void linestack_append(struct linestack **lls, char *line);
254 struct linestack *linestack_load(char *name);
255 int crunch_escape(FILE *out, int cols, int wc);
256 int crunch_rev_escape(FILE *out, int cols, int wc);
257 int crunch_str(char **str, int width, FILE *out, char *escmore,
258 int (*escout)(FILE *out, int cols, int wc));
259 int draw_str(char *start, int width);
260 int utf8len(char *str);
261 int utf8skip(char *str, int width);
262 int draw_trim_esc(char *str, int padto, int width, char *escmore,
263 int (*escout)(FILE *out, int cols,int wc));
264 int draw_trim(char *str, int padto, int width);
266 // interestingtimes.c
268 int terminal_size(unsigned *xx, unsigned *yy);
269 int terminal_probesize(unsigned *xx, unsigned *yy);
270 int scan_key_getsize(char *scratch, int miliwait, unsigned *xx, unsigned *yy);
271 int set_terminal(int fd, int raw, struct termios *old);
272 void xset_terminal(int fd, int raw, struct termios *old);
273 int scan_key(char *scratch, int miliwait);
274 void tty_esc(char *s);
275 void tty_jump(int x, int y);
276 void tty_reset(void);
277 void tty_sigreset(int i);
280 int xsocket(int domain, int type, int protocol);
281 void xsetsockopt(int fd, int level, int opt, void *val, socklen_t len);
282 int xconnect(char *host, char *port, int family, int socktype, int protocol,
284 int xpoll(struct pollfd *fds, int nfds, int timeout);
285 int pollinate(int in1, int in2, int out1, int out2, int timeout, int shutdown_timeout);
288 int get_salt(char *salt, char * algo);
292 struct mtab_list *next, *prev;
294 struct statvfs statvfs;
301 void comma_args(struct arg_list *al, void *data, char *err,
302 char *(*callback)(void *data, char *str, int len));
303 void comma_collate(char **old, char *new);
304 char *comma_iterate(char **list, int *len);
305 int comma_scan(char *optlist, char *opt, int clean);
306 int comma_scanall(char *optlist, char *scanlist);
307 int mountlist_istype(struct mtab_list *ml, char *typelist);
308 struct mtab_list *xgetmountlist(char *path);
312 void generic_signal(int signal);
313 void exit_signal(int signal);
314 void sigatexit(void *handler);
315 int sig_to_num(char *pidstr);
316 char *num_to_sig(int sig);
318 mode_t string_to_mode(char *mode_str, mode_t base);
319 void mode_to_string(mode_t mode, char *buf);
320 char *getbasename(char *name);
321 void names_to_pid(char **names, int (*callback)(pid_t pid, char *name));
323 pid_t xvforkwrap(pid_t pid);
324 #define XVFORK() xvforkwrap(vfork())
326 // Wrapper to make xfuncs() return (via longjmp) instead of exiting.
327 // Assigns true/false "did it exit" value to first argument.
328 #define WOULD_EXIT(y, x) do { jmp_buf _noexit; \
330 toys.rebound = &_noexit; \
331 _noexit_res = setjmp(_noexit); \
332 if (!_noexit_res) do {x;} while(0); \
337 // Wrapper that discards true/false "did it exit" value.
338 #define NOEXIT(x) WOULD_EXIT(_noexit_res, x)
340 // Functions in need of further review/cleanup
341 #include "lib/pending.h"