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 void llist_free_arg(void *node);
  38 void llist_free_double(void *node);
  39 void llist_traverse(void *list, void (*using)(void *node));
  40 void *llist_pop(void *list);  // actually void **list
  41 void *dlist_pop(void *list);  // actually struct double_list **list
  42 void dlist_add_nomalloc(struct double_list **list, struct double_list *new);
  43 struct double_list *dlist_add(struct double_list **list, char *data);
  44 void *dlist_terminate(void *list);
  45
  46 // args.c
  47 void get_optflags(void);
  48
  49 // dirtree.c
  50
  51 // Values returnable from callback function (bitfield, or them together)
  52 // Default with no callback is 0
  53
  54 // Add this node to the tree
  55 #define DIRTREE_SAVE         1
  56 // Recurse into children
  57 #define DIRTREE_RECURSE      2
  58 // Call again after handling all children of this directory
  59 // (Ignored for non-directories, sets linklen = -1 before second call.)
  60 #define DIRTREE_COMEAGAIN    4
  61 // Follow symlinks to directories
  62 #define DIRTREE_SYMFOLLOW    8
  63 // Don't warn about failure to stat
  64 #define DIRTREE_SHUTUP      16
  65 // Don't look at any more files in this directory.
  66 #define DIRTREE_ABORT      256
  67
  68 #define DIRTREE_ABORTVAL ((struct dirtree *)1)
  69
  70 struct dirtree {
  71   struct dirtree *next, *parent, *child;
  72   long extra; // place for user to store their stuff (can be pointer)
  73   struct stat st;
  74   char *symlink;
  75   int dirfd;
  76   char again;
  77   char name[];
  78 };
  79
  80 struct dirtree *dirtree_start(char *name, int symfollow);
  81 struct dirtree *dirtree_add_node(struct dirtree *p, char *name, int flags);
  82 char *dirtree_path(struct dirtree *node, int *plen);
  83 int dirtree_notdotdot(struct dirtree *catch);
  84 int dirtree_parentfd(struct dirtree *node);
  85 struct dirtree *dirtree_handle_callback(struct dirtree *new,
  86   int (*callback)(struct dirtree *node));
  87 int dirtree_recurse(struct dirtree *node, int (*callback)(struct dirtree *node),
  88   int symfollow);
  89 struct dirtree *dirtree_read(char *path, int (*callback)(struct dirtree *node));
  90
  91 // help.c
  92
  93 void show_help(FILE *out);
  94
  95 // xwrap.c
  96 void xstrncpy(char *dest, char *src, size_t size);
  97 void xstrncat(char *dest, char *src, size_t size);
  98 void xexit(void) noreturn;
  99 void *xmalloc(size_t size);
 100 void *xzalloc(size_t size);
 101 void *xrealloc(void *ptr, size_t size);
 102 char *xstrndup(char *s, size_t n);
 103 char *xstrdup(char *s);
 104 char *xmprintf(char *format, ...) printf_format;
 105 void xprintf(char *format, ...) printf_format;
 106 void xputs(char *s);
 107 void xputc(char c);
 108 void xflush(void);
 109 void xexec(char **argv);
 110 pid_t xpopen_both(char **argv, int *pipes);
 111 int xwaitpid(pid_t pid);
 112 int xpclose_both(pid_t pid, int *pipes);
 113 pid_t xpopen(char **argv, int *pipe, int stdout);
 114 pid_t xpclose(pid_t pid, int pipe);
 115 int xrun(char **argv);
 116 int xpspawn(char **argv, int*pipes);
 117 void xaccess(char *path, int flags);
 118 void xunlink(char *path);
 119 int xcreate(char *path, int flags, int mode);
 120 int xopen(char *path, int flags);
 121 void xclose(int fd);
 122 int xdup(int fd);
 123 FILE *xfdopen(int fd, char *mode);
 124 FILE *xfopen(char *path, char *mode);
 125 size_t xread(int fd, void *buf, size_t len);
 126 void xreadall(int fd, void *buf, size_t len);
 127 void xwrite(int fd, void *buf, size_t len);
 128 off_t xlseek(int fd, off_t offset, int whence);
 129 char *xreadfile(char *name, char *buf, off_t len);
 130 int xioctl(int fd, int request, void *data);
 131 char *xgetcwd(void);
 132 void xstat(char *path, struct stat *st);
 133 char *xabspath(char *path, int exact);
 134 void xchdir(char *path);
 135 void xchroot(char *path);
 136 struct passwd *xgetpwuid(uid_t uid);
 137 struct group *xgetgrgid(gid_t gid);
 138 struct passwd *xgetpwnam(char *name);
 139 struct group *xgetgrnam(char *name);
 140 struct passwd *xgetpwnamid(char *user);
 141 struct group *xgetgrnamid(char *group);
 142 void xsetuser(struct passwd *pwd);
 143 char *xreadlink(char *name);
 144 long xparsetime(char *arg, long units, long *fraction);
 145 void xpidfile(char *name);
 146 void xregcomp(regex_t *preg, char *rexec, int cflags);
 147 char *xtzset(char *new);
 148 void xsignal(int signal, void *handler);
 149
 150 // lib.c
 151 void verror_msg(char *msg, int err, va_list va);
 152 void error_msg(char *msg, ...) printf_format;
 153 void perror_msg(char *msg, ...) printf_format;
 154 void error_exit(char *msg, ...) printf_format noreturn;
 155 void perror_exit(char *msg, ...) printf_format noreturn;
 156 void help_exit(char *msg, ...) printf_format noreturn;
 157 void error_msg_raw(char *msg);
 158 void perror_msg_raw(char *msg);
 159 void error_exit_raw(char *msg);
 160 void perror_exit_raw(char *msg);
 161 ssize_t readall(int fd, void *buf, size_t len);
 162 ssize_t writeall(int fd, void *buf, size_t len);
 163 off_t lskip(int fd, off_t offset);
 164 int mkpathat(int atfd, char *dir, mode_t lastmode, int flags);
 165 struct string_list **splitpath(char *path, struct string_list **list);
 166 char *readfileat(int dirfd, char *name, char *buf, off_t *len);
 167 char *readfile(char *name, char *buf, off_t len);
 168 void msleep(long miliseconds);
 169 int64_t peek_le(void *ptr, unsigned size);
 170 int64_t peek_be(void *ptr, unsigned size);
 171 int64_t peek(void *ptr, unsigned size);
 172 void poke(void *ptr, uint64_t val, int size);
 173 struct string_list *find_in_path(char *path, char *filename);
 174 long estrtol(char *str, char **end, int base);
 175 long xstrtol(char *str, char **end, int base);
 176 long atolx(char *c);
 177 long atolx_range(char *numstr, long low, long high);
 178 int stridx(char *haystack, char needle);
 179 char *strlower(char *s);
 180 char *strafter(char *haystack, char *needle);
 181 char *chomp(char *s);
 182 int unescape(char c);
 183 int strstart(char **a, char *b);
 184 off_t fdlength(int fd);
 185 void loopfiles_rw(char **argv, int flags, int permissions, int failok,
 186   void (*function)(int fd, char *name));
 187 void loopfiles(char **argv, void (*function)(int fd, char *name));
 188 void xsendfile(int in, int out);
 189 int wfchmodat(int rc, char *name, mode_t mode);
 190 int copy_tempfile(int fdin, char *name, char **tempname);
 191 void delete_tempfile(int fdin, int fdout, char **tempname);
 192 void replace_tempfile(int fdin, int fdout, char **tempname);
 193 void crc_init(unsigned int *crc_table, int little_endian);
 194 void base64_init(char *p);
 195 int yesno(int def);
 196 int qstrcmp(const void *a, const void *b);
 197 void create_uuid(char *uuid);
 198
 199 #define HR_SPACE 1 // Space between number and units
 200 #define HR_B     2 // Use "B" for single byte units
 201 #define HR_1000  4 // Use decimal instead of binary units
 202 int human_readable(char *buf, unsigned long long num, int style);
 203
 204 // linestack.c
 205
 206 struct linestack {
 207   long len, max;
 208   struct ptr_len idx[];
 209 };
 210
 211 void linestack_addstack(struct linestack **lls, struct linestack *throw,
 212   long pos);
 213 void linestack_insert(struct linestack **lls, long pos, char *line, long len);
 214 void linestack_append(struct linestack **lls, char *line);
 215 struct linestack *linestack_load(char *name);
 216 int crunch_str(char **str, int width, FILE *out,
 217   int (*escout)(FILE *out, int cols, char **buf));
 218 int draw_str(char *start, int width);
 219 int draw_rstr(char *start, int width);
 220
 221 // interestingtimes.c
 222 int xgettty(void);
 223 int terminal_size(unsigned *xx, unsigned *yy);
 224 int terminal_probesize(unsigned *xx, unsigned *yy);
 225 int scan_key_getsize(char *scratch, int miliwait, unsigned *xx, unsigned *yy);
 226 int set_terminal(int fd, int raw, struct termios *old);
 227 void xset_terminal(int fd, int raw, struct termios *old);
 228 int scan_key(char *scratch, int miliwait);
 229 void tty_esc(char *s);
 230 void tty_jump(int x, int y);
 231 void tty_reset(void);
 232 void tty_sigreset(int i);
 233
 234 // net.c
 235 int xsocket(int domain, int type, int protocol);
 236 void xsetsockopt(int fd, int level, int opt, void *val, socklen_t len);
 237 int xconnect(char *host, char *port, int family, int socktype, int protocol,
 238   int flags);
 239 int xpoll(struct pollfd *fds, int nfds, int timeout);
 240
 241 // password.c
 242 int get_salt(char *salt, char * algo);
 243
 244 // getmountlist.c
 245 struct mtab_list {
 246   struct mtab_list *next, *prev;
 247   struct stat stat;
 248   struct statvfs statvfs;
 249   char *dir;
 250   char *device;
 251   char *opts;
 252   char type[0];
 253 };
 254
 255 void comma_args(struct arg_list *al, void *data, char *err,
 256   char *(*callback)(void *data, char *str, int len));
 257 void comma_collate(char **old, char *new);
 258 char *comma_iterate(char **list, int *len);
 259 int comma_scan(char *optlist, char *opt, int clean);
 260 int comma_scanall(char *optlist, char *scanlist);
 261 int mountlist_istype(struct mtab_list  *ml, char *typelist);
 262 struct mtab_list *xgetmountlist(char *path);
 263
 264 // signal
 265
 266 void generic_signal(int signal);
 267 void sigatexit(void *handler);
 268 int sig_to_num(char *pidstr);
 269 char *num_to_sig(int sig);
 270
 271 mode_t string_to_mode(char *mode_str, mode_t base);
 272 void mode_to_string(mode_t mode, char *buf);
 273 char *basename_r(char *name);
 274 void names_to_pid(char **names, int (*callback)(pid_t pid, char *name));
 275
 276 pid_t xvforkwrap(pid_t pid);
 277 #define XVFORK() xvforkwrap(vfork())
 278
 279 // Wrapper to make xfuncs() return (via longjmp) instead of exiting.
 280 // Assigns true/false "did it exit" value to first argument.
 281 #define WOULD_EXIT(y, x) do { jmp_buf _noexit; \
 282   int _noexit_res; \
 283   toys.rebound = &_noexit; \
 284   _noexit_res = setjmp(_noexit); \
 285   if (!_noexit_res) do {x;} while(0); \
 286   toys.rebound = 0; \
 287   y = _noexit_res; \
 288 } while(0);
 289
 290 // Wrapper that discards true/false "did it exit" value.
 291 #define NOEXIT(x) WOULD_EXIT(_noexit_res, x)
 292
 293 // Functions in need of further review/cleanup
 294 #include "lib/pending.h"