1/* lib.h - header file for lib directory
   2 *
   3 * Copyright 2006 Rob Landley <>
   4 */
   6struct ptr_len {
   7  void *ptr;
   8  long len;
  11struct str_len {
  12  char *str;
  13  long len;
  16// llist.c
  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.)
  22struct string_list {
  23  struct string_list *next;
  24  char str[0];
  27struct arg_list {
  28  struct arg_list *next;
  29  char *arg;
  32struct double_list {
  33  struct double_list *next, *prev;
  34  char *data;
  37struct num_cache {
  38  struct num_cache *next;
  39  long long num;
  40  char data[];
  43void llist_free_arg(void *node);
  44void llist_free_double(void *node);
  45void llist_traverse(void *list, void (*using)(void *node));
  46void *llist_pop(void *list);  // actually void **list
  47void *dlist_pop(void *list);  // actually struct double_list **list
  48void *dlist_lpop(void *list); // also struct double_list **list
  49void dlist_add_nomalloc(struct double_list **list, struct double_list *new);
  50struct double_list *dlist_add(struct double_list **list, char *data);
  51void *dlist_terminate(void *list);
  52struct num_cache *get_num_cache(struct num_cache *cache, long long num);
  53struct num_cache *add_num_cache(struct num_cache **cache, long long num,
  54  void *data, int len);
  56// args.c
  57#define FLAGS_NODASH (1LL<<63)
  58void get_optflags(void);
  60// dirtree.c
  62// Values returnable from callback function (bitfield, or them together)
  63// Default with no callback is 0
  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
  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
  85#define DIRTREE_ABORTVAL ((struct dirtree *)1)
  87struct 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[];
  97int isdotdot(char *name);
  98struct dirtree *dirtree_add_node(struct dirtree *p, char *name, int flags);
  99char *dirtree_path(struct dirtree *node, int *plen);
 100int dirtree_notdotdot(struct dirtree *catch);
 101int dirtree_parentfd(struct dirtree *node);
 102int dirtree_recurse(struct dirtree *node, int (*callback)(struct dirtree *node),
 103  int dirfd, int symfollow);
 104struct dirtree *dirtree_flagread(char *path, int flags,
 105  int (*callback)(struct dirtree *node));
 106struct dirtree *dirtree_read(char *path, int (*callback)(struct dirtree *node));
 108// help.c
 110void show_help(FILE *out);
 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)
 117// xwrap.c
 118void xstrncpy(char *dest, char *src, size_t size);
 119void xstrncat(char *dest, char *src, size_t size);
 120void _xexit(void) __attribute__((__noreturn__));
 121void xexit(void) __attribute__((__noreturn__));
 122void *xmmap(void *addr, size_t length, int prot, int flags, int fd, off_t off);
 123void *xmalloc(size_t size);
 124void *xzalloc(size_t size);
 125void *xrealloc(void *ptr, size_t size);
 126char *xstrndup(char *s, size_t n);
 127char *xstrdup(char *s);
 128void *xmemdup(void *s, long len);
 129char *xmprintf(char *format, ...) printf_format;
 130void xprintf(char *format, ...) printf_format;
 131void xputsl(char *s, int len);
 132void xputsn(char *s);
 133void xputs(char *s);
 134void xputc(char c);
 135void xflush(int flush);
 136void xexec(char **argv);
 137pid_t xpopen_both(char **argv, int *pipes);
 138int xwaitpid(pid_t pid);
 139int xpclose_both(pid_t pid, int *pipes);
 140pid_t xpopen(char **argv, int *pipe, int isstdout);
 141pid_t xpclose(pid_t pid, int pipe);
 142int xrun(char **argv);
 143int xpspawn(char **argv, int*pipes);
 144void xaccess(char *path, int flags);
 145void xunlink(char *path);
 146void xrename(char *from, char *to);
 147int xtempfile(char *name, char **tempname);
 148int xcreate(char *path, int flags, int mode);
 149int xopen(char *path, int flags);
 150int xcreate_stdio(char *path, int flags, int mode);
 151int xopen_stdio(char *path, int flags);
 152int openro(char *path, int flags);
 153int xopenro(char *path);
 154void xpipe(int *pp);
 155void xclose(int fd);
 156int xdup(int fd);
 157int notstdio(int fd);
 158FILE *xfdopen(int fd, char *mode);
 159FILE *xfopen(char *path, char *mode);
 160size_t xread(int fd, void *buf, size_t len);
 161void xreadall(int fd, void *buf, size_t len);
 162void xwrite(int fd, void *buf, size_t len);
 163off_t xlseek(int fd, off_t offset, int whence);
 164char *xreadfile(char *name, char *buf, off_t len);
 165int xioctl(int fd, int request, void *data);
 166char *xgetcwd(void);
 167void xstat(char *path, struct stat *st);
 168char *xabspath(char *path, int exact);
 169void xchdir(char *path);
 170void xchroot(char *path);
 171struct passwd *xgetpwuid(uid_t uid);
 172struct group *xgetgrgid(gid_t gid);
 173struct passwd *xgetpwnam(char *name);
 174struct group *xgetgrnam(char *name);
 175unsigned xgetuid(char *name);
 176unsigned xgetgid(char *name);
 177void xsetuser(struct passwd *pwd);
 178char *xreadlink(char *name);
 179double xstrtod(char *s);
 180long xparsetime(char *arg, long units, long *fraction);
 181long long xparsemillitime(char *arg);
 182void xpidfile(char *name);
 183void xregcomp(regex_t *preg, char *rexec, int cflags);
 184char *xtzset(char *new);
 185void xsignal_flags(int signal, void *handler, int flags);
 186void xsignal(int signal, void *handler);
 187time_t xvali_date(struct tm *tm, char *str);
 188void xparsedate(char *str, time_t *t, unsigned *nano, int endian);
 189char *xgetline(FILE *fp, int *len);
 191// lib.c
 192void verror_msg(char *msg, int err, va_list va);
 193void error_msg(char *msg, ...) printf_format;
 194void perror_msg(char *msg, ...) printf_format;
 195void error_exit(char *msg, ...) printf_format __attribute__((__noreturn__));
 196void perror_exit(char *msg, ...) printf_format __attribute__((__noreturn__));
 197void help_exit(char *msg, ...) printf_format __attribute__((__noreturn__));
 198void error_msg_raw(char *msg);
 199void perror_msg_raw(char *msg);
 200void error_exit_raw(char *msg);
 201void perror_exit_raw(char *msg);
 202ssize_t readall(int fd, void *buf, size_t len);
 203ssize_t writeall(int fd, void *buf, size_t len);
 204off_t lskip(int fd, off_t offset);
 205#define MKPATHAT_MKLAST  1
 206#define MKPATHAT_MAKE    2
 207#define MKPATHAT_VERBOSE 4
 208int mkpathat(int atfd, char *dir, mode_t lastmode, int flags);
 209int mkpath(char *dir);
 210struct string_list **splitpath(char *path, struct string_list **list);
 211char *readfileat(int dirfd, char *name, char *buf, off_t *len);
 212char *readfile(char *name, char *buf, off_t len);
 213void msleep(long milliseconds);
 214void nanomove(struct timespec *ts, long long offset);
 215long long nanodiff(struct timespec *old, struct timespec *new);
 216int highest_bit(unsigned long l);
 217int64_t peek_le(void *ptr, unsigned size);
 218int64_t peek_be(void *ptr, unsigned size);
 219int64_t peek(void *ptr, unsigned size);
 220void poke_le(void *ptr, long long val, unsigned size);
 221void poke_be(void *ptr, long long val, unsigned size);
 222void poke(void *ptr, long long val, unsigned size);
 223struct string_list *find_in_path(char *path, char *filename);
 224long long estrtol(char *str, char **end, int base);
 225long long xstrtol(char *str, char **end, int base);
 226long long atolx(char *c);
 227long long atolx_range(char *numstr, long long low, long long high);
 228int stridx(char *haystack, char needle);
 229int utf8towc(wchar_t *wc, char *str, unsigned len);
 230char *strlower(char *s);
 231char *strafter(char *haystack, char *needle);
 232char *chomp(char *s);
 233int unescape(char c);
 234char *strend(char *str, char *suffix);
 235int strstart(char **a, char *b);
 236int strcasestart(char **a, char *b);
 237off_t fdlength(int fd);
 238void loopfiles_rw(char **argv, int flags, int permissions,
 239  void (*function)(int fd, char *name));
 240void loopfiles(char **argv, void (*function)(int fd, char *name));
 241void loopfiles_lines(char **argv, void (*function)(char **pline, long len));
 242long long sendfile_len(int in, int out, long long len, long long *consumed);
 243long long xsendfile_len(int in, int out, long long len);
 244void xsendfile_pad(int in, int out, long long len);
 245long long xsendfile(int in, int out);
 246int wfchmodat(int rc, char *name, mode_t mode);
 247int copy_tempfile(int fdin, char *name, char **tempname);
 248void delete_tempfile(int fdin, int fdout, char **tempname);
 249void replace_tempfile(int fdin, int fdout, char **tempname);
 250void crc_init(unsigned int *crc_table, int little_endian);
 251void base64_init(char *p);
 252int yesno(int def);
 253int fyesno(FILE *fp, int def);
 254int qstrcmp(const void *a, const void *b);
 255void create_uuid(char *uuid);
 256char *show_uuid(char *uuid);
 257char *next_printf(char *s, char **start);
 258int dev_minor(int dev);
 259int dev_major(int dev);
 260int dev_makedev(int major, int minor);
 261struct passwd *bufgetpwuid(uid_t uid);
 262struct group *bufgetgrgid(gid_t gid);
 263int readlinkat0(int dirfd, char *path, char *buf, int len);
 264int readlink0(char *path, char *buf, int len);
 265int regexec0(regex_t *preg, char *string, long len, int nmatch,
 266  regmatch_t pmatch[], int eflags);
 267char *getusername(uid_t uid);
 268char *getgroupname(gid_t gid);
 269void do_lines(int fd, char delim, void (*call)(char **pline, long len));
 270long long millitime(void);
 271char *format_iso_time(char *buf, size_t len, struct timespec *ts);
 272void reset_env(struct passwd *p, int clear);
 273void loggit(int priority, char *format, ...);
 274unsigned tar_cksum(void *data);
 275int is_tar_header(void *pkt);
 277#define HR_SPACE 1 // Space between number and units
 278#define HR_B     2 // Use "B" for single byte units
 279#define HR_1000  4 // Use decimal instead of binary units
 280int human_readable_long(char *buf, unsigned long long num, int dgt, int style);
 281int human_readable(char *buf, unsigned long long num, int style);
 283// env.c
 285long environ_bytes();
 286void xsetenv(char *name, char *val);
 287void xunsetenv(char *name);
 288void xclearenv(void);
 290// linestack.c
 292struct linestack {
 293  long len, max;
 294  struct ptr_len idx[];
 297void linestack_addstack(struct linestack **lls, struct linestack *throw,
 298  long pos);
 299void linestack_insert(struct linestack **lls, long pos, char *line, long len);
 300void linestack_append(struct linestack **lls, char *line);
 301struct linestack *linestack_load(char *name);
 302int crunch_escape(FILE *out, int cols, int wc);
 303int crunch_rev_escape(FILE *out, int cols, int wc);
 304int crunch_str(char **str, int width, FILE *out, char *escmore,
 305  int (*escout)(FILE *out, int cols, int wc));
 306int draw_str(char *start, int width);
 307int utf8len(char *str);
 308int utf8skip(char *str, int width);
 309int draw_trim_esc(char *str, int padto, int width, char *escmore,
 310  int (*escout)(FILE *out, int cols,int wc));
 311int draw_trim(char *str, int padto, int width);
 313// tty.c
 314int tty_fd(void);
 315int terminal_size(unsigned *xx, unsigned *yy);
 316int terminal_probesize(unsigned *xx, unsigned *yy);
 317#define KEY_UP 0
 318#define KEY_DOWN 1
 319#define KEY_RIGHT 2
 320#define KEY_LEFT 3
 321#define KEY_PGUP 4
 322#define KEY_PGDN 5
 323#define KEY_HOME 6
 324#define KEY_END 7
 325#define KEY_INSERT 8
 326#define KEY_DELETE 9
 327#define KEY_FN 10 // F1 = KEY_FN+1, F2 = KEY_FN+2, ...
 328#define KEY_SHIFT (1<<16)
 329#define KEY_CTRL (1<<17)
 330#define KEY_ALT (1<<18)
 331int scan_key(char *scratch, int timeout_ms);
 332int scan_key_getsize(char *scratch, int timeout_ms, unsigned *xx, unsigned *yy);
 333int set_terminal(int fd, int raw, int speed, struct termios *old);
 334void xset_terminal(int fd, int raw, int speed, struct termios *old);
 335void tty_esc(char *s);
 336void tty_jump(int x, int y);
 337void tty_reset(void);
 338void tty_sigreset(int i);
 339void start_redraw(unsigned *width, unsigned *height);
 341// net.c
 343union socksaddr {
 344  struct sockaddr s;
 345  struct sockaddr_in in;
 346  struct sockaddr_in6 in6;
 349int xsocket(int domain, int type, int protocol);
 350void xsetsockopt(int fd, int level, int opt, void *val, socklen_t len);
 351struct addrinfo *xgetaddrinfo(char *host, char *port, int family, int socktype,
 352  int protocol, int flags);
 353void xbind(int fd, const struct sockaddr *sa, socklen_t len);
 354void xconnect(int fd, const struct sockaddr *sa, socklen_t len);
 355int xconnectany(struct addrinfo *ai);
 356int xbindany(struct addrinfo *ai);
 357int xpoll(struct pollfd *fds, int nfds, int timeout);
 358int pollinate(int in1, int in2, int out1, int out2, int timeout, int shutdown_timeout);
 359char *ntop(struct sockaddr *sa);
 360void xsendto(int sockfd, void *buf, size_t len, struct sockaddr *dest);
 361int xrecvwait(int fd, char *buf, int len, union socksaddr *sa, int timeout);
 363// password.c
 364int get_salt(char *salt, char * algo);
 366// commas.c
 367void comma_args(struct arg_list *al, void *data, char *err,
 368  char *(*callback)(void *data, char *str, int len));
 369void comma_collate(char **old, char *new);
 370char *comma_iterate(char **list, int *len);
 371int comma_scan(char *optlist, char *opt, int clean);
 372int comma_scanall(char *optlist, char *scanlist);
 373int comma_remove(char *optlist, char *opt);
 375// deflate.c
 377long long gzip_fd(int infd, int outfd);
 378long long gunzip_fd(int infd, int outfd);
 380// getmountlist.c
 381struct mtab_list {
 382  struct mtab_list *next, *prev;
 383  struct stat stat;
 384  struct statvfs statvfs;
 385  char *dir;
 386  char *device;
 387  char *opts;
 388  char type[0];
 391int mountlist_istype(struct mtab_list  *ml, char *typelist);
 392struct mtab_list *xgetmountlist(char *path);
 394// signal
 396void generic_signal(int signal);
 397void exit_signal(int signal);
 398void sigatexit(void *handler);
 399void list_signals();
 401mode_t string_to_mode(char *mode_str, mode_t base);
 402void mode_to_string(mode_t mode, char *buf);
 403char *getdirname(char *name);
 404char *getbasename(char *name);
 405char *fileunderdir(char *file, char *dir);
 406void names_to_pid(char **names, int (*callback)(pid_t pid, char *name),
 407    int scripts);
 409pid_t __attribute__((returns_twice)) xvforkwrap(pid_t pid);
 410#define XVFORK() xvforkwrap(vfork())
 412// Wrapper to make xfuncs() return (via siglongjmp) instead of exiting.
 413// Assigns true/false "did it exit" value to first argument.
 414#define WOULD_EXIT(y, x) do { sigjmp_buf _noexit; \
 415  int _noexit_res; \
 416  toys.rebound = &_noexit; \
 417  _noexit_res = sigsetjmp(_noexit, 1); \
 418  if (!_noexit_res) do {x;} while(0); \
 419  toys.rebound = 0; \
 420  y = _noexit_res; \
 421} while(0)
 423// Wrapper that discards true/false "did it exit" value.
 424#define NOEXIT(x) WOULD_EXIT(_noexit_res, x)
 426#define minof(a, b) ({typeof(a) aa = (a); typeof(b) bb = (b); aa<bb ? aa : bb;})
 427#define maxof(a, b) ({typeof(a) aa = (a); typeof(b) bb = (b); aa>bb ? aa : bb;})
 429// Functions in need of further review/cleanup
 430#include "lib/pending.h"