lib.h (12749B)
1 /* lib.h - header file for lib directory 2 * 3 * Copyright 2006 Rob Landley <rob@landley.net> 4 */ 5 6 struct ptr_len { 7 void *ptr; 8 long len; 9 }; 10 11 struct str_len { 12 char *str; 13 long len; 14 }; 15 16 // llist.c 17 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.) 21 22 struct string_list { 23 struct string_list *next; 24 char str[0]; 25 }; 26 27 struct arg_list { 28 struct arg_list *next; 29 char *arg; 30 }; 31 32 struct double_list { 33 struct double_list *next, *prev; 34 char *data; 35 }; 36 37 struct num_cache { 38 struct num_cache *next; 39 long long num; 40 char data[]; 41 }; 42 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, 53 void *data, int len); 54 55 // args.c 56 #define FLAGS_NODASH (1LL<<63) 57 void get_optflags(void); 58 59 // dirtree.c 60 61 // Values returnable from callback function (bitfield, or them together) 62 // Default with no callback is 0 63 64 // Add this node to the tree 65 #define DIRTREE_SAVE 1 66 // Recurse into children 67 #define DIRTREE_RECURSE 2 68 // Call again after handling all children of this directory 69 // (Ignored for non-directories, sets linklen = -1 before second call.) 70 #define DIRTREE_COMEAGAIN 4 71 // Follow symlinks to directories 72 #define DIRTREE_SYMFOLLOW 8 73 // Don't warn about failure to stat 74 #define DIRTREE_SHUTUP 16 75 // Breadth first traversal, conserves filehandles at the expense of memory 76 #define DIRTREE_BREADTH 32 77 // skip non-numeric entries 78 #define DIRTREE_PROC 64 79 // Don't look at any more files in this directory. 80 #define DIRTREE_ABORT 256 81 82 #define DIRTREE_ABORTVAL ((struct dirtree *)1) 83 84 struct dirtree { 85 struct dirtree *next, *parent, *child; 86 long extra; // place for user to store their stuff (can be pointer) 87 struct stat st; 88 char *symlink; 89 int dirfd; 90 char again; 91 char name[]; 92 }; 93 94 int isdotdot(char *name); 95 struct dirtree *dirtree_add_node(struct dirtree *p, char *name, int flags); 96 char *dirtree_path(struct dirtree *node, int *plen); 97 int dirtree_notdotdot(struct dirtree *catch); 98 int dirtree_parentfd(struct dirtree *node); 99 int dirtree_recurse(struct dirtree *node, int (*callback)(struct dirtree *node), 100 int dirfd, int symfollow); 101 struct dirtree *dirtree_flagread(char *path, int flags, 102 int (*callback)(struct dirtree *node)); 103 struct dirtree *dirtree_read(char *path, int (*callback)(struct dirtree *node)); 104 105 // help.c 106 107 void show_help(FILE *out); 108 109 // Tell xopen and friends to print warnings but return -1 as necessary 110 // The largest O_BLAH flag so far is arch/alpha's O_PATH at 0x800000 so 111 // plenty of headroom. 112 #define WARN_ONLY (1<<31) 113 114 // xwrap.c 115 void xstrncpy(char *dest, char *src, size_t size); 116 void xstrncat(char *dest, char *src, size_t size); 117 void _xexit(void) noreturn; 118 void xexit(void) noreturn; 119 void *xmmap(void *addr, size_t length, int prot, int flags, int fd, off_t off); 120 void *xmalloc(size_t size); 121 void *xzalloc(size_t size); 122 void *xrealloc(void *ptr, size_t size); 123 char *xstrndup(char *s, size_t n); 124 char *xstrdup(char *s); 125 void *xmemdup(void *s, long len); 126 char *xmprintf(char *format, ...) printf_format; 127 void xprintf(char *format, ...) printf_format; 128 void xputs(char *s); 129 void xputc(char c); 130 void xflush(void); 131 void xexec(char **argv); 132 pid_t xpopen_both(char **argv, int *pipes); 133 int xwaitpid(pid_t pid); 134 int xpclose_both(pid_t pid, int *pipes); 135 pid_t xpopen(char **argv, int *pipe, int isstdout); 136 pid_t xpclose(pid_t pid, int pipe); 137 int xrun(char **argv); 138 int xpspawn(char **argv, int*pipes); 139 void xaccess(char *path, int flags); 140 void xunlink(char *path); 141 int xtempfile(char *name, char **tempname); 142 int xcreate(char *path, int flags, int mode); 143 int xopen(char *path, int flags); 144 int xcreate_stdio(char *path, int flags, int mode); 145 int xopen_stdio(char *path, int flags); 146 int openro(char *path, int flags); 147 int xopenro(char *path); 148 void xpipe(int *pp); 149 void xclose(int fd); 150 int xdup(int fd); 151 int notstdio(int fd); 152 FILE *xfdopen(int fd, char *mode); 153 FILE *xfopen(char *path, char *mode); 154 size_t xread(int fd, void *buf, size_t len); 155 void xreadall(int fd, void *buf, size_t len); 156 void xwrite(int fd, void *buf, size_t len); 157 off_t xlseek(int fd, off_t offset, int whence); 158 char *xreadfile(char *name, char *buf, off_t len); 159 int xioctl(int fd, int request, void *data); 160 char *xgetcwd(void); 161 void xstat(char *path, struct stat *st); 162 char *xabspath(char *path, int exact); 163 void xchdir(char *path); 164 void xchroot(char *path); 165 struct passwd *xgetpwuid(uid_t uid); 166 struct group *xgetgrgid(gid_t gid); 167 struct passwd *xgetpwnam(char *name); 168 struct group *xgetgrnam(char *name); 169 unsigned xgetuid(char *name); 170 unsigned xgetgid(char *name); 171 void xsetuser(struct passwd *pwd); 172 char *xreadlink(char *name); 173 double xstrtod(char *s); 174 long xparsetime(char *arg, long units, long *fraction); 175 long long xparsemillitime(char *arg); 176 void xpidfile(char *name); 177 void xregcomp(regex_t *preg, char *rexec, int cflags); 178 char *xtzset(char *new); 179 void xsignal_flags(int signal, void *handler, int flags); 180 void xsignal(int signal, void *handler); 181 182 // lib.c 183 void verror_msg(char *msg, int err, va_list va); 184 void error_msg(char *msg, ...) printf_format; 185 void perror_msg(char *msg, ...) printf_format; 186 void error_exit(char *msg, ...) printf_format noreturn; 187 void perror_exit(char *msg, ...) printf_format noreturn; 188 void help_exit(char *msg, ...) printf_format noreturn; 189 void error_msg_raw(char *msg); 190 void perror_msg_raw(char *msg); 191 void error_exit_raw(char *msg); 192 void perror_exit_raw(char *msg); 193 ssize_t readall(int fd, void *buf, size_t len); 194 ssize_t writeall(int fd, void *buf, size_t len); 195 off_t lskip(int fd, off_t offset); 196 #define MKPATHAT_MKLAST 1 197 #define MKPATHAT_MAKE 2 198 #define MKPATHAT_VERBOSE 4 199 int mkpathat(int atfd, char *dir, mode_t lastmode, int flags); 200 int mkpath(char *dir); 201 struct string_list **splitpath(char *path, struct string_list **list); 202 char *readfileat(int dirfd, char *name, char *buf, off_t *len); 203 char *readfile(char *name, char *buf, off_t len); 204 void msleep(long miliseconds); 205 int highest_bit(unsigned long l); 206 int64_t peek_le(void *ptr, unsigned size); 207 int64_t peek_be(void *ptr, unsigned size); 208 int64_t peek(void *ptr, unsigned size); 209 void poke(void *ptr, uint64_t val, int size); 210 struct string_list *find_in_path(char *path, char *filename); 211 long long estrtol(char *str, char **end, int base); 212 long long xstrtol(char *str, char **end, int base); 213 long long atolx(char *c); 214 long long atolx_range(char *numstr, long long low, long long high); 215 int stridx(char *haystack, char needle); 216 int utf8towc(wchar_t *wc, char *str, unsigned len); 217 char *strlower(char *s); 218 char *strafter(char *haystack, char *needle); 219 char *chomp(char *s); 220 int unescape(char c); 221 char *strend(char *str, char *suffix); 222 int strstart(char **a, char *b); 223 off_t fdlength(int fd); 224 void loopfiles_rw(char **argv, int flags, int permissions, 225 void (*function)(int fd, char *name)); 226 void loopfiles(char **argv, void (*function)(int fd, char *name)); 227 void loopfiles_lines(char **argv, void (*function)(char **pline, long len)); 228 long long xsendfile(int in, int out); 229 int wfchmodat(int rc, char *name, mode_t mode); 230 int copy_tempfile(int fdin, char *name, char **tempname); 231 void delete_tempfile(int fdin, int fdout, char **tempname); 232 void replace_tempfile(int fdin, int fdout, char **tempname); 233 void crc_init(unsigned int *crc_table, int little_endian); 234 void base64_init(char *p); 235 int yesno(int def); 236 int qstrcmp(const void *a, const void *b); 237 void create_uuid(char *uuid); 238 char *show_uuid(char *uuid); 239 char *next_printf(char *s, char **start); 240 char *strnstr(char *line, char *str); 241 int dev_minor(int dev); 242 int dev_major(int dev); 243 int dev_makedev(int major, int minor); 244 struct passwd *bufgetpwuid(uid_t uid); 245 struct group *bufgetgrgid(gid_t gid); 246 int readlinkat0(int dirfd, char *path, char *buf, int len); 247 int readlink0(char *path, char *buf, int len); 248 int regexec0(regex_t *preg, char *string, long len, int nmatch, 249 regmatch_t pmatch[], int eflags); 250 char *getusername(uid_t uid); 251 char *getgroupname(gid_t gid); 252 void do_lines(int fd, void (*call)(char **pline, long len)); 253 long environ_bytes(); 254 long long millitime(void); 255 char *format_iso_time(char *buf, size_t len, struct timespec *ts); 256 257 #define HR_SPACE 1 // Space between number and units 258 #define HR_B 2 // Use "B" for single byte units 259 #define HR_1000 4 // Use decimal instead of binary units 260 int human_readable(char *buf, unsigned long long num, int style); 261 262 // linestack.c 263 264 struct linestack { 265 long len, max; 266 struct ptr_len idx[]; 267 }; 268 269 void linestack_addstack(struct linestack **lls, struct linestack *throw, 270 long pos); 271 void linestack_insert(struct linestack **lls, long pos, char *line, long len); 272 void linestack_append(struct linestack **lls, char *line); 273 struct linestack *linestack_load(char *name); 274 int crunch_escape(FILE *out, int cols, int wc); 275 int crunch_rev_escape(FILE *out, int cols, int wc); 276 int crunch_str(char **str, int width, FILE *out, char *escmore, 277 int (*escout)(FILE *out, int cols, int wc)); 278 int draw_str(char *start, int width); 279 int utf8len(char *str); 280 int utf8skip(char *str, int width); 281 int draw_trim_esc(char *str, int padto, int width, char *escmore, 282 int (*escout)(FILE *out, int cols,int wc)); 283 int draw_trim(char *str, int padto, int width); 284 285 // interestingtimes.c 286 int tty_fd(void); 287 int terminal_size(unsigned *xx, unsigned *yy); 288 int terminal_probesize(unsigned *xx, unsigned *yy); 289 int scan_key_getsize(char *scratch, int miliwait, unsigned *xx, unsigned *yy); 290 int set_terminal(int fd, int raw, int speed, struct termios *old); 291 void xset_terminal(int fd, int raw, int speed, struct termios *old); 292 int scan_key(char *scratch, int miliwait); 293 void tty_esc(char *s); 294 void tty_jump(int x, int y); 295 void tty_reset(void); 296 void tty_sigreset(int i); 297 void start_redraw(unsigned *width, unsigned *height); 298 299 // net.c 300 int xsocket(int domain, int type, int protocol); 301 void xsetsockopt(int fd, int level, int opt, void *val, socklen_t len); 302 struct addrinfo *xgetaddrinfo(char *host, char *port, int family, int socktype, 303 int protocol, int flags); 304 int xconnect(struct addrinfo *ai_arg); 305 int xpoll(struct pollfd *fds, int nfds, int timeout); 306 int pollinate(int in1, int in2, int out1, int out2, int timeout, int shutdown_timeout); 307 char *ntop(struct sockaddr *sa); 308 309 // password.c 310 int get_salt(char *salt, char * algo); 311 312 // commas.c 313 void comma_args(struct arg_list *al, void *data, char *err, 314 char *(*callback)(void *data, char *str, int len)); 315 void comma_collate(char **old, char *new); 316 char *comma_iterate(char **list, int *len); 317 int comma_scan(char *optlist, char *opt, int clean); 318 int comma_scanall(char *optlist, char *scanlist); 319 320 // deflate.c 321 322 long long gzip_fd(int infd, int outfd); 323 long long gunzip_fd(int infd, int outfd); 324 325 // getmountlist.c 326 struct mtab_list { 327 struct mtab_list *next, *prev; 328 struct stat stat; 329 struct statvfs statvfs; 330 char *dir; 331 char *device; 332 char *opts; 333 char type[0]; 334 }; 335 336 int mountlist_istype(struct mtab_list *ml, char *typelist); 337 struct mtab_list *xgetmountlist(char *path); 338 339 // signal 340 341 void generic_signal(int signal); 342 void exit_signal(int signal); 343 void sigatexit(void *handler); 344 int sig_to_num(char *pidstr); 345 char *num_to_sig(int sig); 346 347 mode_t string_to_mode(char *mode_str, mode_t base); 348 void mode_to_string(mode_t mode, char *buf); 349 char *getdirname(char *name); 350 char *getbasename(char *name); 351 int fileunderdir(char *file, char *dir); 352 void names_to_pid(char **names, int (*callback)(pid_t pid, char *name)); 353 354 pid_t __attribute__((returns_twice)) xvforkwrap(pid_t pid); 355 #define XVFORK() xvforkwrap(vfork()) 356 357 // Wrapper to make xfuncs() return (via longjmp) instead of exiting. 358 // Assigns true/false "did it exit" value to first argument. 359 #define WOULD_EXIT(y, x) do { jmp_buf _noexit; \ 360 int _noexit_res; \ 361 toys.rebound = &_noexit; \ 362 _noexit_res = setjmp(_noexit); \ 363 if (!_noexit_res) do {x;} while(0); \ 364 toys.rebound = 0; \ 365 y = _noexit_res; \ 366 } while(0) 367 368 // Wrapper that discards true/false "did it exit" value. 369 #define NOEXIT(x) WOULD_EXIT(_noexit_res, x) 370 371 #define minof(a, b) ({typeof(a) aa = (a); typeof(b) bb = (b); aa<bb ? aa : bb;}) 372 #define maxof(a, b) ({typeof(a) aa = (a); typeof(b) bb = (b); aa>bb ? aa : bb;}) 373 374 // Functions in need of further review/cleanup 375 #include "lib/pending.h"