libbb/libbb.h

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * Busybox main internal header file
   4  *
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  19  *
  20  * Based in part on code from sash, Copyright (c) 1999 by David I. Bell
  21  * Permission has been granted to redistribute this code under the GPL.
  22  *
  23  */
  24 #ifndef __LIBBB_H__
  25 #define __LIBBB_H__    1
  26
  27 #include <stdio.h>
  28 #include <stdarg.h>
  29 #include <sys/stat.h>
  30 #include <sys/types.h>
  31
  32 #ifdef DMALLOC
  33 #include "dmalloc.h"
  34 #endif
  35
  36 #include <features.h>
  37
  38 #if __GNU_LIBRARY__ < 5
  39 /* libc5 doesn't define socklen_t */
  40 typedef unsigned int socklen_t;
  41 /* libc5 doesn't implement BSD 4.4 daemon() */
  42 extern int daemon (int nochdir, int noclose);
  43 #endif
  44
  45 /* Some useful definitions */
  46 #define FALSE   ((int) 0)
  47 #define TRUE    ((int) 1)
  48 #define SKIP    ((int) 2)
  49
  50 /* for mtab.c */
  51 #define MTAB_GETMOUNTPT '1'
  52 #define MTAB_GETDEVICE  '2'
  53
  54 #define BUF_SIZE        8192
  55 #define EXPAND_ALLOC    1024
  56
  57 static inline int is_decimal(ch) { return ((ch >= '0') && (ch <= '9')); }
  58 static inline int is_octal(ch)   { return ((ch >= '0') && (ch <= '7')); }
  59
  60 /* Macros for min/max.  */
  61 #ifndef MIN
  62 #define MIN(a,b) (((a)<(b))?(a):(b))
  63 #endif
  64
  65 #ifndef MAX
  66 #define MAX(a,b) (((a)>(b))?(a):(b))
  67 #endif
  68
  69
  70
  71 extern void show_usage(void) __attribute__ ((noreturn));
  72 extern void error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
  73 extern void error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
  74 extern void perror_msg(const char *s, ...);
  75 extern void perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn));
  76
  77 /* These two are used internally -- you shouldn't need to use them */
  78 extern void verror_msg(const char *s, va_list p);
  79 extern void vperror_msg(const char *s, va_list p);
  80
  81 const char *mode_string(int mode);
  82 const char *time_string(time_t timeVal);
  83 int is_directory(const char *name, const int followLinks, struct stat *statBuf);
  84 int isDevice(const char *name);
  85
  86 typedef struct ino_dev_hash_bucket_struct {
  87   struct ino_dev_hash_bucket_struct *next;
  88   ino_t ino;
  89   dev_t dev;
  90   char name[1];
  91 } ino_dev_hashtable_bucket_t;
  92 int is_in_ino_dev_hashtable(const struct stat *statbuf, char **name);
  93 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
  94 void reset_ino_dev_hashtable(void);
  95
  96 int copy_file(const char *src_name, const char *dst_name,
  97                  int set_modes, int follow_links, int force_flag, int quiet_flag);
  98 int copy_file_chunk(FILE *src_file, FILE *dst_file, unsigned long long chunksize);
  99 char *buildName(const char *dirName, const char *fileName);
 100 int makeString(int argc, const char **argv, char *buf, int bufLen);
 101 char *getChunk(int size);
 102 char *chunkstrdup(const char *str);
 103 void freeChunks(void);
 104 ssize_t safe_read(int fd, void *buf, size_t count);
 105 int full_write(int fd, const char *buf, int len);
 106 int full_read(int fd, char *buf, int len);
 107 int recursive_action(const char *fileName, int recurse, int followLinks, int depthFirst,
 108           int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData),
 109           int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData),
 110           void* userData);
 111
 112 extern int create_path (const char *name, int mode);
 113 extern int parse_mode( const char* s, mode_t* theMode);
 114
 115 extern int get_kernel_revision(void);
 116
 117 extern int get_console_fd(char* tty_name);
 118 extern struct mntent *find_mount_point(const char *name, const char *table);
 119 extern void write_mtab(char* blockDevice, char* directory,
 120         char* filesystemType, long flags, char* string_flags);
 121 extern void erase_mtab(const char * name);
 122 extern void mtab_read(void);
 123 extern char *mtab_first(void **iter);
 124 extern char *mtab_next(void **iter);
 125 extern char *mtab_getinfo(const char *match, const char which);
 126 extern int check_wildcard_match(const char* text, const char* pattern);
 127 extern long atoi_w_units (const char *cp);
 128 extern pid_t* find_pid_by_name( char* pidName);
 129 extern int find_real_root_device_name(char* name);
 130 extern char *get_line_from_file(FILE *file);
 131 extern void print_file(FILE *file);
 132 extern int print_file_by_name(char *filename);
 133 extern char process_escape_sequence(const char **ptr);
 134 extern char *get_last_path_component(char *path);
 135 extern FILE *wfopen(const char *path, const char *mode);
 136 extern FILE *xfopen(const char *path, const char *mode);
 137 extern void chomp(char *s);
 138 extern void trim(char *s);
 139 extern struct BB_applet *find_applet_by_name(const char *name);
 140 void run_applet_by_name(const char *name, int argc, char **argv);
 141
 142 #ifndef DMALLOC
 143 extern void *xmalloc (size_t size);
 144 extern void *xrealloc(void *old, size_t size);
 145 extern void *xcalloc(size_t nmemb, size_t size);
 146 extern char *xstrdup (const char *s);
 147 #endif
 148 extern char *xstrndup (const char *s, int n);
 149 extern char * safe_strncpy(char *dst, const char *src, size_t size);
 150
 151 struct suffix_mult {
 152         const char *suffix;
 153         int mult;
 154 };
 155
 156 extern unsigned long parse_number(const char *numstr,
 157                 const struct suffix_mult *suffixes);
 158
 159
 160 /* These parse entries in /etc/passwd and /etc/group.  This is desirable
 161  * for BusyBox since we want to avoid using the glibc NSS stuff, which
 162  * increases target size and is often not needed embedded systems.  */
 163 extern long my_getpwnam(const char *name);
 164 extern long my_getgrnam(const char *name);
 165 extern void my_getpwuid(char *name, long uid);
 166 extern void my_getgrgid(char *group, long gid);
 167 extern long my_getpwnamegid(const char *name);
 168
 169 extern int device_open(char *device, int mode);
 170
 171 extern int del_loop(const char *device);
 172 extern int set_loop(const char *device, const char *file, int offset, int *loopro);
 173 extern char *find_unused_loop_device (void);
 174
 175
 176 #if (__GLIBC__ < 2)
 177 extern int vdprintf(int d, const char *format, va_list ap);
 178 #endif
 179
 180 int nfsmount(const char *spec, const char *node, int *flags,
 181              char **extra_opts, char **mount_opts, int running_bg);
 182
 183 void syslog_msg_with_name(const char *name, int facility, int pri, const char *msg);
 184 void syslog_msg(int facility, int pri, const char *msg);
 185
 186 /* Include our own copy of struct sysinfo to avoid binary compatability
 187  * problems with Linux 2.4, which changed things.  Grumble, grumble. */
 188 struct sysinfo {
 189         long uptime;                    /* Seconds since boot */
 190         unsigned long loads[3];         /* 1, 5, and 15 minute load averages */
 191         unsigned long totalram;         /* Total usable main memory size */
 192         unsigned long freeram;          /* Available memory size */
 193         unsigned long sharedram;        /* Amount of shared memory */
 194         unsigned long bufferram;        /* Memory used by buffers */
 195         unsigned long totalswap;        /* Total swap space size */
 196         unsigned long freeswap;         /* swap space still available */
 197         unsigned short procs;           /* Number of current processes */
 198         unsigned long totalhigh;        /* Total high memory size */
 199         unsigned long freehigh;         /* Available high memory size */
 200         unsigned int mem_unit;          /* Memory unit size in bytes */
 201         char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
 202 };
 203 extern int sysinfo (struct sysinfo* info);
 204
 205 const char *make_human_readable_str(unsigned long val, unsigned long not_hr);
 206 enum {
 207         KILOBYTE = 1024,
 208         MEGABYTE = (KILOBYTE*1024),
 209         GIGABYTE = (MEGABYTE*1024)
 210 };
 211
 212 int ask_confirmation(void);
 213 int klogctl(int type, char * b, int len);
 214
 215 char *xgetcwd(char *cwd);
 216 char *concat_path_file(const char *path, const char *filename);
 217
 218 typedef struct ar_headers_s {
 219         char *name;
 220         off_t size;
 221         uid_t uid;
 222         gid_t gid;
 223         mode_t mode;
 224         time_t mtime;
 225         off_t offset;
 226         struct ar_headers_s *next;
 227 } ar_headers_t;
 228 extern ar_headers_t *get_ar_headers(FILE *in_file);
 229 extern int seek_ared_file(FILE *in_file, ar_headers_t *headers, const char *tar_gz_file);
 230
 231 typedef enum extract_function_e {
 232         extract_contents = 1,
 233         extract_control = 2,
 234         extract_info = 4,
 235         extract_extract = 8,
 236         extract_verbose_extract = 16,
 237         extract_list = 32,
 238         extract_fsys_tarfile = 64
 239 } extract_function_t;
 240 extern int deb_extract(const char *package_filename, int function, char *target_dir);
 241 extern int untar(FILE *src_tar_file, int untar_function, char *base_path);
 242
 243 extern int unzip(FILE *l_in_file, FILE *l_out_file);
 244 extern void gz_close(int gunzip_pid);
 245 extern int gz_open(FILE *compressed_file, int *pid);
 246
 247 #define CT_AUTO 0
 248 #define CT_UNIX2DOS     1
 249 #define CT_DOS2UNIX     2
 250 extern int convert(char *fn, int ConvType);
 251
 252 #endif /* __LIBBB_H__ */