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