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