lib/lib.h

   1 /* lib.h - header file for lib directory
   2  *
   3  * Copyright 2006 Rob Landley <rob@landley.net>
   4  */
   5
   6 // llist.c
   7
   8 // All these list types can be handled by the same code because first element
   9 // is always next pointer, so next = (mytype *)&struct. (The payloads are
  10 // named differently to catch using the wrong type early.)
  11
  12 struct string_list {
  13   struct string_list *next;
  14   char str[0];
  15 };
  16
  17 struct arg_list {
  18   struct arg_list *next;
  19   char *arg;
  20 };
  21
  22 struct double_list {
  23   struct double_list *next, *prev;
  24   char *data;
  25 };
  26
  27 void llist_traverse(void *list, void (*using)(void *data));
  28 void *llist_pop(void *list);  // actually void **list
  29 void *dlist_pop(void *list);  // actually struct double_list **list
  30 void dlist_add_nomalloc(struct double_list **list, struct double_list *new);
  31 struct double_list *dlist_add(struct double_list **list, char *data);
  32
  33 // args.c
  34 void get_optflags(void);
  35
  36 // dirtree.c
  37
  38 // Values returnable from callback function (bitfield, or them together)
  39 // Default with no callback is 0
  40
  41 // Add this node to the tree
  42 #define DIRTREE_SAVE         1
  43 // Recurse into children
  44 #define DIRTREE_RECURSE      2
  45 // Call again after handling all children of this directory
  46 // (Ignored for non-directories, sets linklen = -1 before second call.)
  47 #define DIRTREE_COMEAGAIN    4
  48 // Follow symlinks to directories
  49 #define DIRTREE_SYMFOLLOW    8
  50 // Don't look at any more files in this directory.
  51 #define DIRTREE_ABORT      256
  52
  53 #define DIRTREE_ABORTVAL ((struct dirtree *)1)
  54
  55 struct dirtree {
  56   struct dirtree *next, *parent, *child;
  57   long extra; // place for user to store their stuff (can be pointer)
  58   struct stat st;
  59   char *symlink;
  60   int data;  // dirfd for directory, linklen for symlink, -1 = comeagain
  61   char name[];
  62 };
  63
  64 struct dirtree *dirtree_add_node(struct dirtree *p, char *name, int symfollow);
  65 char *dirtree_path(struct dirtree *node, int *plen);
  66 int dirtree_notdotdot(struct dirtree *catch);
  67 int dirtree_parentfd(struct dirtree *node);
  68 struct dirtree *dirtree_handle_callback(struct dirtree *new,
  69   int (*callback)(struct dirtree *node));
  70 void dirtree_recurse(struct dirtree *node,
  71   int (*callback)(struct dirtree *node), int symfollow);
  72 struct dirtree *dirtree_read(char *path, int (*callback)(struct dirtree *node));
  73
  74 // help.c
  75
  76 void show_help(void);
  77
  78 // xwrap.c
  79 void xstrncpy(char *dest, char *src, size_t size);
  80 void xexit(void) noreturn;
  81 void *xmalloc(size_t size);
  82 void *xzalloc(size_t size);
  83 void *xrealloc(void *ptr, size_t size);
  84 char *xstrndup(char *s, size_t n);
  85 char *xstrdup(char *s);
  86 char *xmsprintf(char *format, ...);
  87 void xprintf(char *format, ...);
  88 void xputs(char *s);
  89 void xputc(char c);
  90 void xflush(void);
  91 void xexec_optargs(int skip);
  92 void xexec(char **argv);
  93 void xaccess(char *path, int flags);
  94 void xunlink(char *path);
  95 int xcreate(char *path, int flags, int mode);
  96 int xopen(char *path, int flags);
  97 void xclose(int fd);
  98 int xdup(int fd);
  99 FILE *xfdopen(int fd, char *mode);
 100 FILE *xfopen(char *path, char *mode);
 101 size_t xread(int fd, void *buf, size_t len);
 102 void xreadall(int fd, void *buf, size_t len);
 103 void xwrite(int fd, void *buf, size_t len);
 104 off_t xlseek(int fd, off_t offset, int whence);
 105 char *xreadfile(char *name);
 106 int xioctl(int fd, int request, void *data);
 107 char *xgetcwd(void);
 108 void xstat(char *path, struct stat *st);
 109 char *xabspath(char *path, int exact);
 110 char *xrealpath(char *path);
 111 void xchdir(char *path);
 112 void xmkpath(char *path, int mode);
 113 void xsetuid(uid_t uid);
 114 struct passwd *xgetpwuid(uid_t uid);
 115 struct group *xgetgrgid(gid_t gid);
 116 struct passwd *xgetpwnam(char *name);
 117 char *xreadlink(char *name);
 118 long xparsetime(char *arg, long units, long *fraction);
 119 void xpidfile(char *name);
 120
 121 // lib.c
 122 void verror_msg(char *msg, int err, va_list va);
 123 void error_msg(char *msg, ...);
 124 void perror_msg(char *msg, ...);
 125 void error_exit(char *msg, ...) noreturn;
 126 void perror_exit(char *msg, ...) noreturn;
 127 ssize_t readall(int fd, void *buf, size_t len);
 128 ssize_t writeall(int fd, void *buf, size_t len);
 129 off_t lskip(int fd, off_t offset);
 130 struct string_list **splitpath(char *path, struct string_list **list);
 131 char *readfile(char *name, char *buf, off_t len);
 132 void msleep(long miliseconds);
 133 int64_t peek(void *ptr, int size);
 134 void poke(void *ptr, uint64_t val, int size);
 135 struct string_list *find_in_path(char *path, char *filename);
 136 long atolx(char *c);
 137 long atolx_range(char *numstr, long low, long high);
 138 int numlen(long l);
 139 int stridx(char *haystack, char needle);
 140 off_t fdlength(int fd);
 141 void loopfiles_rw(char **argv, int flags, int permissions, int failok,
 142   void (*function)(int fd, char *name));
 143 void loopfiles(char **argv, void (*function)(int fd, char *name));
 144 char *get_rawline(int fd, long *plen, char end);
 145 char *get_line(int fd);
 146 void xsendfile(int in, int out);
 147 int wfchmodat(int rc, char *name, mode_t mode);
 148 int copy_tempfile(int fdin, char *name, char **tempname);
 149 void delete_tempfile(int fdin, int fdout, char **tempname);
 150 void replace_tempfile(int fdin, int fdout, char **tempname);
 151 void crc_init(unsigned int *crc_table, int little_endian);
 152 int terminal_size(unsigned *x, unsigned *y);
 153 int yesno(char *prompt, int def);
 154
 155 // net.c
 156 int xsocket(int domain, int type, int protocol);
 157
 158 // getmountlist.c
 159 struct mtab_list {
 160   struct mtab_list *next;
 161   struct stat stat;
 162   struct statvfs statvfs;
 163   char *dir;
 164   char *device;
 165   char type[0];
 166 };
 167
 168 struct mtab_list *xgetmountlist(char *path);
 169
 170 void bunzipStream(int src_fd, int dst_fd);
 171
 172 // signal
 173
 174 void sigatexit(void *handler);
 175 int sig_to_num(char *pidstr);
 176 char *num_to_sig(int sig);
 177
 178 mode_t string_to_mode(char *mode_str, mode_t base);
 179 void mode_to_string(mode_t mode, char *buf);
 180
 181 #include "lib/pending.h"