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_lpop(void *list); // also struct double_list **list 49 void dlist_add_nomalloc(struct double_list **list, struct double_list *new); 50 struct double_list *dlist_add(struct double_list **list, char *data); 51 void *dlist_terminate(void *list); 52 struct num_cache *get_num_cache(struct num_cache *cache, long long num); 53 struct num_cache *add_num_cache(struct num_cache **cache, long long num, 54 void *data, int len); 55 56 // args.c 57 #define FLAGS_NODASH (1LL<<63) 58 void get_optflags(void); 59 60 // dirtree.c 61 62 // Values returnable from callback function (bitfield, or them together) 63 // Default with no callback is 0 64 65 // Add this node to the tree 66 #define DIRTREE_SAVE 1 67 // Recurse into children 68 #define DIRTREE_RECURSE 2 69 // Call again after handling all children of this directory 70 // (Ignored for non-directories, sets linklen = -1 before second call.) 71 #define DIRTREE_COMEAGAIN 4 72 // Follow symlinks to directories 73 #define DIRTREE_SYMFOLLOW 8 74 // Don't warn about failure to stat 75 #define DIRTREE_SHUTUP 16 76 // Breadth first traversal, conserves filehandles at the expense of memory 77 #define DIRTREE_BREADTH 32 // TODO not implemented yet 78 // skip non-numeric entries 79 #define DIRTREE_PROC 64 80 // Return files we can't stat 81 #define DIRTREE_STATLESS 128 82 // Don't look at any more files in this directory. 83 #define DIRTREE_ABORT 256 84 85 #define DIRTREE_ABORTVAL ((struct dirtree *)1) 86 87 struct dirtree { 88 struct dirtree *next, *parent, *child; 89 long extra; // place for user to store their stuff (can be pointer) 90 char *symlink; 91 int dirfd; 92 struct stat st; 93 char again; 94 char name[]; 95 }; 96 97 int isdotdot(char *name); 98 struct dirtree *dirtree_add_node(struct dirtree *p, char *name, int flags); 99 char *dirtree_path(struct dirtree *node, int *plen); 100 int dirtree_notdotdot(struct dirtree *catch); 101 int dirtree_parentfd(struct dirtree *node); 102 int dirtree_recurse(struct dirtree *node, int (*callback)(struct dirtree *node), 103 int dirfd, int symfollow); 104 struct dirtree *dirtree_flagread(char *path, int flags, 105 int (*callback)(struct dirtree *node)); 106 struct dirtree *dirtree_read(char *path, int (*callback)(struct dirtree *node)); 107 108 // help.c 109 110 void show_help(FILE *out, int full); 111 112 // Tell xopen and friends to print warnings but return -1 as necessary 113 // The largest O_BLAH flag so far is arch/alpha's O_PATH at 0x800000 so 114 // plenty of headroom. 115 #define WARN_ONLY (1<<31) 116 117 // xwrap.c 118 void xstrncpy(char *dest, char *src, size_t size); 119 void xstrncat(char *dest, char *src, size_t size); 120 void _xexit(void) __attribute__((__noreturn__)); 121 void xexit(void) __attribute__((__noreturn__)); 122 void *xmmap(void *addr, size_t length, int prot, int flags, int fd, off_t off); 123 void *xmalloc(size_t size); 124 void *xzalloc(size_t size); 125 void *xrealloc(void *ptr, size_t size); 126 char *xstrndup(char *s, size_t n); 127 char *xstrdup(char *s); 128 void *xmemdup(void *s, long len); 129 char *xmprintf(char *format, ...) printf_format; 130 void xflush(int flush); 131 void xprintf(char *format, ...) printf_format; 132 void xputsl(char *s, int len); 133 void xputsn(char *s); 134 void xputs(char *s); 135 void xputc(char c); 136 void xvdaemon(void); 137 void xexec(char **argv); 138 pid_t xpopen_setup(char **argv, int *pipes, void (*callback)(char **argv)); 139 pid_t xpopen_both(char **argv, int *pipes); 140 int xwaitpid(pid_t pid); 141 int xpclose_both(pid_t pid, int *pipes); 142 pid_t xpopen(char **argv, int *pipe, int isstdout); 143 pid_t xpclose(pid_t pid, int pipe); 144 int xrun(char **argv); 145 int xpspawn(char **argv, int*pipes); 146 void xaccess(char *path, int flags); 147 void xunlink(char *path); 148 void xrename(char *from, char *to); 149 int xtempfile(char *name, char **tempname); 150 int xcreate(char *path, int flags, int mode); 151 int xopen(char *path, int flags); 152 int xcreate_stdio(char *path, int flags, int mode); 153 int xopen_stdio(char *path, int flags); 154 int openro(char *path, int flags); 155 int xopenro(char *path); 156 void xpipe(int *pp); 157 void xclose(int fd); 158 int xdup(int fd); 159 int notstdio(int fd); 160 FILE *xfdopen(int fd, char *mode); 161 FILE *xfopen(char *path, char *mode); 162 size_t xread(int fd, void *buf, size_t len); 163 void xreadall(int fd, void *buf, size_t len); 164 void xwrite(int fd, void *buf, size_t len); 165 off_t xlseek(int fd, off_t offset, int whence); 166 char *xreadfile(char *name, char *buf, off_t len); 167 int xioctl(int fd, int request, void *data); 168 char *xgetcwd(void); 169 void xstat(char *path, struct stat *st); 170 char *xabspath(char *path, int exact); 171 void xchdir(char *path); 172 void xchroot(char *path); 173 struct passwd *xgetpwuid(uid_t uid); 174 struct group *xgetgrgid(gid_t gid); 175 struct passwd *xgetpwnam(char *name); 176 struct group *xgetgrnam(char *name); 177 unsigned xgetuid(char *name); 178 unsigned xgetgid(char *name); 179 void xsetuser(struct passwd *pwd); 180 char *xreadlink(char *name); 181 double xstrtod(char *s); 182 long xparsetime(char *arg, long units, long *fraction); 183 long long xparsemillitime(char *arg); 184 void xpidfile(char *name); 185 void xregcomp(regex_t *preg, char *rexec, int cflags); 186 char *xtzset(char *new); 187 void xsignal_flags(int signal, void *handler, int flags); 188 void xsignal(int signal, void *handler); 189 time_t xvali_date(struct tm *tm, char *str); 190 void xparsedate(char *str, time_t *t, unsigned *nano, int endian); 191 char *xgetline(FILE *fp); 192 time_t xmktime(struct tm *tm, int utc); 193 194 // lib.c 195 void verror_msg(char *msg, int err, va_list va); 196 void error_msg(char *msg, ...) printf_format; 197 void perror_msg(char *msg, ...) printf_format; 198 void error_exit(char *msg, ...) printf_format __attribute__((__noreturn__)); 199 void perror_exit(char *msg, ...) printf_format __attribute__((__noreturn__)); 200 void help_exit(char *msg, ...) printf_format __attribute__((__noreturn__)); 201 void error_msg_raw(char *msg); 202 void perror_msg_raw(char *msg); 203 void error_exit_raw(char *msg); 204 void perror_exit_raw(char *msg); 205 ssize_t readall(int fd, void *buf, size_t len); 206 ssize_t writeall(int fd, void *buf, size_t len); 207 off_t lskip(int fd, off_t offset); 208 #define MKPATHAT_MKLAST 1 209 #define MKPATHAT_MAKE 2 210 #define MKPATHAT_VERBOSE 4 211 int mkpathat(int atfd, char *dir, mode_t lastmode, int flags); 212 int mkpath(char *dir); 213 struct string_list **splitpath(char *path, struct string_list **list); 214 char *readfd(int fd, char *ibuf, off_t *plen); 215 char *readfileat(int dirfd, char *name, char *buf, off_t *len); 216 char *readfile(char *name, char *buf, off_t len); 217 void msleep(long milliseconds); 218 void nanomove(struct timespec *ts, long long offset); 219 long long nanodiff(struct timespec *old, struct timespec *new); 220 int highest_bit(unsigned long l); 221 int64_t peek_le(void *ptr, unsigned size); 222 int64_t peek_be(void *ptr, unsigned size); 223 int64_t peek(void *ptr, unsigned size); 224 void poke_le(void *ptr, long long val, unsigned size); 225 void poke_be(void *ptr, long long val, unsigned size); 226 void poke(void *ptr, long long val, unsigned size); 227 struct string_list *find_in_path(char *path, char *filename); 228 long long estrtol(char *str, char **end, int base); 229 long long xstrtol(char *str, char **end, int base); 230 long long atolx(char *c); 231 long long atolx_range(char *numstr, long long low, long long high); 232 int stridx(char *haystack, char needle); 233 int wctoutf8(char *s, unsigned wc); 234 int utf8towc(wchar_t *wc, char *str, unsigned len); 235 char *strlower(char *s); 236 char *strafter(char *haystack, char *needle); 237 char *chomp(char *s); 238 int unescape(char c); 239 int unescape2(char **c, int echo); 240 char *strend(char *str, char *suffix); 241 int strstart(char **a, char *b); 242 int strcasestart(char **a, char *b); 243 off_t fdlength(int fd); 244 void loopfiles_rw(char **argv, int flags, int permissions, 245 void (*function)(int fd, char *name)); 246 void loopfiles(char **argv, void (*function)(int fd, char *name)); 247 void loopfiles_lines(char **argv, void (*function)(char **pline, long len)); 248 long long sendfile_len(int in, int out, long long len, long long *consumed); 249 long long xsendfile_len(int in, int out, long long len); 250 void xsendfile_pad(int in, int out, long long len); 251 long long xsendfile(int in, int out); 252 int wfchmodat(int rc, char *name, mode_t mode); 253 int copy_tempfile(int fdin, char *name, char **tempname); 254 void delete_tempfile(int fdin, int fdout, char **tempname); 255 void replace_tempfile(int fdin, int fdout, char **tempname); 256 void crc_init(unsigned int *crc_table, int little_endian); 257 void base64_init(char *p); 258 int yesno(int def); 259 int fyesno(FILE *fp, int def); 260 int qstrcmp(const void *a, const void *b); 261 void create_uuid(char *uuid); 262 char *show_uuid(char *uuid); 263 char *next_printf(char *s, char **start); 264 struct passwd *bufgetpwuid(uid_t uid); 265 struct group *bufgetgrgid(gid_t gid); 266 int readlinkat0(int dirfd, char *path, char *buf, int len); 267 int readlink0(char *path, char *buf, int len); 268 int regexec0(regex_t *preg, char *string, long len, int nmatch, 269 regmatch_t pmatch[], int eflags); 270 char *getusername(uid_t uid); 271 char *getgroupname(gid_t gid); 272 void do_lines(int fd, char delim, void (*call)(char **pline, long len)); 273 long long millitime(void); 274 char *format_iso_time(char *buf, size_t len, struct timespec *ts); 275 void loggit(int priority, char *format, ...); 276 unsigned tar_cksum(void *data); 277 int is_tar_header(void *pkt); 278 char *elf_arch_name(int type); 279 280 #define HR_SPACE 1 // Space between number and units 281 #define HR_B 2 // Use "B" for single byte units 282 #define HR_1000 4 // Use decimal instead of binary units 283 #define HR_NODOT 8 // No tenths for single digit units 284 int human_readable_long(char *buf, unsigned long long num, int dgt, int unit, 285 int style); 286 int human_readable(char *buf, unsigned long long num, int style); 287 288 // env.c 289 290 long environ_bytes(void); 291 char *xsetenv(char *name, char *val); 292 void xunsetenv(char *name); 293 char *xpop_env(char *name); // because xpopenv() looks like xpopen_v() 294 void xclearenv(void); 295 void reset_env(struct passwd *p, int clear); 296 297 // linestack.c 298 299 struct linestack { 300 long len, max; 301 struct ptr_len idx[]; 302 }; 303 304 void linestack_addstack(struct linestack **lls, struct linestack *throw, 305 long pos); 306 void linestack_insert(struct linestack **lls, long pos, char *line, long len); 307 void linestack_append(struct linestack **lls, char *line); 308 struct linestack *linestack_load(char *name); 309 int crunch_escape(FILE *out, int cols, int wc); 310 int crunch_rev_escape(FILE *out, int cols, int wc); 311 int crunch_str(char **str, int width, FILE *out, char *escmore, 312 int (*escout)(FILE *out, int cols, int wc)); 313 int draw_str(char *start, int width); 314 int utf8len(char *str); 315 int utf8skip(char *str, int width); 316 int draw_trim_esc(char *str, int padto, int width, char *escmore, 317 int (*escout)(FILE *out, int cols,int wc)); 318 int draw_trim(char *str, int padto, int width); 319 320 // tty.c 321 int tty_fd(void); 322 int terminal_size(unsigned *xx, unsigned *yy); 323 int terminal_probesize(unsigned *xx, unsigned *yy); 324 #define KEY_UP 0 325 #define KEY_DOWN 1 326 #define KEY_RIGHT 2 327 #define KEY_LEFT 3 328 #define KEY_PGUP 4 329 #define KEY_PGDN 5 330 #define KEY_HOME 6 331 #define KEY_END 7 332 #define KEY_INSERT 8 333 #define KEY_DELETE 9 334 #define KEY_FN 10 // F1 = KEY_FN+1, F2 = KEY_FN+2, ... 335 #define KEY_SHIFT (1<<16) 336 #define KEY_CTRL (1<<17) 337 #define KEY_ALT (1<<18) 338 int scan_key(char *scratch, int timeout_ms); 339 int scan_key_getsize(char *scratch, int timeout_ms, unsigned *xx, unsigned *yy); 340 void xsetspeed(struct termios *tio, int speed); 341 int set_terminal(int fd, int raw, int speed, struct termios *old); 342 void xset_terminal(int fd, int raw, int speed, struct termios *old); 343 void tty_esc(char *s); 344 void tty_jump(int x, int y); 345 void tty_reset(void); 346 void tty_sigreset(int i); 347 void start_redraw(unsigned *width, unsigned *height); 348 349 // net.c 350 351 union socksaddr { 352 struct sockaddr s; 353 struct sockaddr_in in; 354 struct sockaddr_in6 in6; 355 }; 356 357 int xsocket(int domain, int type, int protocol); 358 void xsetsockopt(int fd, int level, int opt, void *val, socklen_t len); 359 struct addrinfo *xgetaddrinfo(char *host, char *port, int family, int socktype, 360 int protocol, int flags); 361 void xbind(int fd, const struct sockaddr *sa, socklen_t len); 362 void xconnect(int fd, const struct sockaddr *sa, socklen_t len); 363 int xconnectany(struct addrinfo *ai); 364 int xbindany(struct addrinfo *ai); 365 int xpoll(struct pollfd *fds, int nfds, int timeout); 366 int pollinate(int in1, int in2, int out1, int out2, int timeout, int shutdown_timeout); 367 char *ntop(struct sockaddr *sa); 368 void xsendto(int sockfd, void *buf, size_t len, struct sockaddr *dest); 369 int xrecvwait(int fd, char *buf, int len, union socksaddr *sa, int timeout); 370 371 // password.c 372 int get_salt(char *salt, char * algo); 373 374 // commas.c 375 void comma_args(struct arg_list *al, void *data, char *err, 376 char *(*callback)(void *data, char *str, int len)); 377 void comma_collate(char **old, char *new); 378 char *comma_iterate(char **list, int *len); 379 int comma_scan(char *optlist, char *opt, int clean); 380 int comma_scanall(char *optlist, char *scanlist); 381 int comma_remove(char *optlist, char *opt); 382 383 // deflate.c 384 385 long long gzip_fd(int infd, int outfd); 386 long long gunzip_fd(int infd, int outfd); 387 388 // getmountlist.c 389 struct mtab_list { 390 struct mtab_list *next, *prev; 391 struct stat stat; 392 struct statvfs statvfs; 393 char *dir; 394 char *device; 395 char *opts; 396 char type[0]; 397 }; 398 399 int mountlist_istype(struct mtab_list *ml, char *typelist); 400 struct mtab_list *xgetmountlist(char *path); 401 402 // signal 403 404 void generic_signal(int signal); 405 void exit_signal(int signal); 406 void sigatexit(void *handler); 407 void list_signals(void); 408 409 mode_t string_to_mode(char *mode_str, mode_t base); 410 void mode_to_string(mode_t mode, char *buf); 411 char *getbasename(char *name); 412 char *fileunderdir(char *file, char *dir); 413 char *relative_path(char *from, char *to); 414 void names_to_pid(char **names, int (*callback)(pid_t pid, char *name), 415 int scripts); 416 417 pid_t __attribute__((returns_twice)) xvforkwrap(pid_t pid); 418 #define XVFORK() xvforkwrap(vfork()) 419 420 // Wrapper to make xfuncs() return (via siglongjmp) instead of exiting. 421 // Assigns true/false "did it exit" value to first argument. 422 #define WOULD_EXIT(y, x) do { sigjmp_buf _noexit; \ 423 int _noexit_res; \ 424 toys.rebound = &_noexit; \ 425 _noexit_res = sigsetjmp(_noexit, 1); \ 426 if (!_noexit_res) do {x;} while(0); \ 427 toys.rebound = 0; \ 428 y = _noexit_res; \ 429 } while(0) 430 431 // Wrapper that discards true/false "did it exit" value. 432 #define NOEXIT(x) WOULD_EXIT(_noexit_res, x) 433 434 #define minof(a, b) ({typeof(a) aa = (a); typeof(b) bb = (b); aa<bb ? aa : bb;}) 435 #define maxof(a, b) ({typeof(a) aa = (a); typeof(b) bb = (b); aa>bb ? aa : bb;}) 436 437 // Functions in need of further review/cleanup 438 #include "lib/pending.h" 439