lib/lib.h

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