include/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 #include <netdb.h>
  33
  34 #ifdef DMALLOC
  35 #include "dmalloc.h"
  36 #endif
  37
  38 #include <features.h>
  39
  40 #ifndef _BB_INTERNAL_H_
  41 #include "../busybox.h"
  42 #endif
  43
  44 #if __GNU_LIBRARY__ < 5
  45 /* libc5 doesn't define socklen_t */
  46 typedef unsigned int socklen_t;
  47 /* libc5 doesn't implement BSD 4.4 daemon() */
  48 extern int daemon (int nochdir, int noclose);
  49 #endif
  50
  51 /* Some useful definitions */
  52 #define FALSE   ((int) 0)
  53 #define TRUE    ((int) 1)
  54 #define SKIP    ((int) 2)
  55
  56 /* for mtab.c */
  57 #define MTAB_GETMOUNTPT '1'
  58 #define MTAB_GETDEVICE  '2'
  59
  60 #define BUF_SIZE        8192
  61 #define EXPAND_ALLOC    1024
  62
  63 static inline int is_decimal(int ch) { return ((ch >= '0') && (ch <= '9')); }
  64 static inline int is_octal(int ch)   { return ((ch >= '0') && (ch <= '7')); }
  65
  66 /* Macros for min/max.  */
  67 #ifndef MIN
  68 #define MIN(a,b) (((a)<(b))?(a):(b))
  69 #endif
  70
  71 #ifndef MAX
  72 #define MAX(a,b) (((a)>(b))?(a):(b))
  73 #endif
  74
  75
  76
  77 extern void show_usage(void) __attribute__ ((noreturn));
  78 extern void error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
  79 extern void error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
  80 extern void perror_msg(const char *s, ...);
  81 extern void perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn));
  82 extern void vherror_msg(const char *s, va_list p);
  83 extern void herror_msg(const char *s, ...);
  84 extern void herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn));
  85
  86 /* These two are used internally -- you shouldn't need to use them */
  87 extern void verror_msg(const char *s, va_list p);
  88 extern void vperror_msg(const char *s, va_list p);
  89
  90 const char *mode_string(int mode);
  91 const char *time_string(time_t timeVal);
  92 int is_directory(const char *name, int followLinks, struct stat *statBuf);
  93 int isDevice(const char *name);
  94
  95 typedef struct ino_dev_hash_bucket_struct {
  96   struct ino_dev_hash_bucket_struct *next;
  97   ino_t ino;
  98   dev_t dev;
  99   char name[1];
 100 } ino_dev_hashtable_bucket_t;
 101 int is_in_ino_dev_hashtable(const struct stat *statbuf, char **name);
 102 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
 103 void reset_ino_dev_hashtable(void);
 104
 105 int remove_file(const char *path, int flags);
 106 int copy_file(const char *source, const char *dest, int flags);
 107 int copy_file_chunk(FILE *src_file, FILE *dst_file, unsigned long long chunksize);
 108 char *buildName(const char *dirName, const char *fileName);
 109 int makeString(int argc, const char **argv, char *buf, int bufLen);
 110 char *getChunk(int size);
 111 char *chunkstrdup(const char *str);
 112 void freeChunks(void);
 113 ssize_t safe_read(int fd, void *buf, size_t count);
 114 int full_write(int fd, const char *buf, int len);
 115 int full_read(int fd, char *buf, int len);
 116 int recursive_action(const char *fileName, int recurse, int followLinks, int depthFirst,
 117           int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData),
 118           int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData),
 119           void* userData);
 120
 121 extern int create_path (const char *name, int mode);
 122 extern int parse_mode( const char* s, mode_t* theMode);
 123
 124 extern int get_kernel_revision(void);
 125
 126 extern int get_console_fd(char* tty_name);
 127 extern struct mntent *find_mount_point(const char *name, const char *table);
 128 extern void write_mtab(char* blockDevice, char* directory,
 129         char* filesystemType, long flags, char* string_flags);
 130 extern void erase_mtab(const char * name);
 131 extern long atoi_w_units (const char *cp);
 132 extern pid_t* find_pid_by_name( char* pidName);
 133 extern char *find_real_root_device_name(const char* name);
 134 extern char *get_line_from_file(FILE *file);
 135 extern void print_file(FILE *file);
 136 extern size_t copyfd(int fd1, int fd2);
 137 extern int print_file_by_name(char *filename);
 138 extern char process_escape_sequence(const char **ptr);
 139 extern char *get_last_path_component(char *path);
 140 extern FILE *wfopen(const char *path, const char *mode);
 141 extern FILE *xfopen(const char *path, const char *mode);
 142 extern void chomp(char *s);
 143 extern void trim(char *s);
 144 extern struct BB_applet *find_applet_by_name(const char *name);
 145 void run_applet_by_name(const char *name, int argc, char **argv);
 146
 147 #ifndef DMALLOC
 148 extern void *xmalloc (size_t size);
 149 extern void *xrealloc(void *old, size_t size);
 150 extern void *xcalloc(size_t nmemb, size_t size);
 151 extern char *xstrdup (const char *s);
 152 #endif
 153 extern char *xstrndup (const char *s, int n);
 154 extern char * safe_strncpy(char *dst, const char *src, size_t size);
 155
 156 struct suffix_mult {
 157         const char *suffix;
 158         int mult;
 159 };
 160
 161 extern unsigned long parse_number(const char *numstr,
 162                 const struct suffix_mult *suffixes);
 163
 164
 165 /* These parse entries in /etc/passwd and /etc/group.  This is desirable
 166  * for BusyBox since we want to avoid using the glibc NSS stuff, which
 167  * increases target size and is often not needed embedded systems.  */
 168 extern long my_getpwnam(const char *name);
 169 extern long my_getgrnam(const char *name);
 170 extern void my_getpwuid(char *name, long uid);
 171 extern void my_getgrgid(char *group, long gid);
 172 extern long my_getpwnamegid(const char *name);
 173
 174 extern int device_open(char *device, int mode);
 175
 176 extern int del_loop(const char *device);
 177 extern int set_loop(const char *device, const char *file, int offset, int *loopro);
 178 extern char *find_unused_loop_device (void);
 179
 180
 181 #if (__GLIBC__ < 2)
 182 extern int vdprintf(int d, const char *format, va_list ap);
 183 #endif
 184
 185 int nfsmount(const char *spec, const char *node, int *flags,
 186              char **extra_opts, char **mount_opts, int running_bg);
 187
 188 void syslog_msg_with_name(const char *name, int facility, int pri, const char *msg);
 189 void syslog_msg(int facility, int pri, const char *msg);
 190
 191 /* Include our own copy of struct sysinfo to avoid binary compatability
 192  * problems with Linux 2.4, which changed things.  Grumble, grumble. */
 193 struct sysinfo {
 194         long uptime;                    /* Seconds since boot */
 195         unsigned long loads[3];         /* 1, 5, and 15 minute load averages */
 196         unsigned long totalram;         /* Total usable main memory size */
 197         unsigned long freeram;          /* Available memory size */
 198         unsigned long sharedram;        /* Amount of shared memory */
 199         unsigned long bufferram;        /* Memory used by buffers */
 200         unsigned long totalswap;        /* Total swap space size */
 201         unsigned long freeswap;         /* swap space still available */
 202         unsigned short procs;           /* Number of current processes */
 203         unsigned long totalhigh;        /* Total high memory size */
 204         unsigned long freehigh;         /* Available high memory size */
 205         unsigned int mem_unit;          /* Memory unit size in bytes */
 206         char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
 207 };
 208 extern int sysinfo (struct sysinfo* info);
 209
 210 const char *make_human_readable_str(unsigned long val, unsigned long not_hr);
 211 enum {
 212         KILOBYTE = 1024,
 213         MEGABYTE = (KILOBYTE*1024),
 214         GIGABYTE = (MEGABYTE*1024)
 215 };
 216
 217 int ask_confirmation(void);
 218 int klogctl(int type, char * b, int len);
 219
 220 char *xgetcwd(char *cwd);
 221 char *xreadlink(const char *path);
 222 char *concat_path_file(const char *path, const char *filename);
 223 char *last_char_is(const char *s, int c);
 224
 225 typedef struct ar_headers_s {
 226         char *name;
 227         off_t size;
 228         uid_t uid;
 229         gid_t gid;
 230         mode_t mode;
 231         time_t mtime;
 232         off_t offset;
 233         struct ar_headers_s *next;
 234 } ar_headers_t;
 235 extern ar_headers_t *get_ar_headers(FILE *in_file);
 236 extern int seek_ared_file(FILE *in_file, ar_headers_t *headers, const char *tar_gz_file);
 237
 238 typedef enum extract_function_e {
 239         extract_contents = 1,
 240         extract_control = 2,
 241         extract_info = 4,
 242         extract_extract = 8,
 243         extract_verbose_extract = 16,
 244         extract_list = 32,
 245         extract_fsys_tarfile = 64,
 246         extract_field = 128,
 247         extract_contents_to_file = 256
 248 } extract_function_t;
 249 extern char *deb_extract(const char *package_filename, int function,
 250         const char *argument, const char *argument2);
 251 extern char *untar(FILE *src_tar_file, FILE *output, int untar_function,
 252         const char *argument, const char *file_prefix);
 253 extern char *read_text_file_to_buffer(FILE *src_file);
 254 extern char *read_package_field(const char *package_buffer);
 255
 256 extern int unzip(FILE *l_in_file, FILE *l_out_file);
 257 extern void gz_close(int gunzip_pid);
 258 extern int gz_open(FILE *compressed_file, int *pid);
 259
 260 extern struct hostent *xgethostbyname(const char *name);
 261
 262 #define CT_AUTO 0
 263 #define CT_UNIX2DOS     1
 264 #define CT_DOS2UNIX     2
 265 /* extern int convert(char *fn, int ConvType); */
 266
 267 enum {
 268         FILEUTILS_PRESERVE_STATUS = 1,
 269         FILEUTILS_PRESERVE_SYMLINKS = 2,
 270         FILEUTILS_RECUR = 4,
 271         FILEUTILS_FORCE = 8,
 272         FILEUTILS_INTERACTIVE = 16
 273 };
 274
 275 extern const char *applet_name;
 276 extern const char * const full_version;
 277 extern const char * const name_too_long;
 278 extern const char * const omitting_directory;
 279 extern const char * const not_a_directory;
 280 extern const char * const memory_exhausted;
 281 extern const char * const invalid_date;
 282 extern const char * const invalid_option;
 283 extern const char * const io_error;
 284 extern const char * const dash_dash_help;
 285 extern const char * const write_error;
 286 extern const char * const too_few_args;
 287 extern const char * const name_longer_than_foo;
 288 extern const char * const unknown;
 289
 290 #endif /* __LIBBB_H__ */