include/busybox.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 _BB_INTERNAL_H_
  25 #define _BB_INTERNAL_H_    1
  26
  27 #include "Config.h"
  28
  29 #include <stdio.h>
  30 #include <stdarg.h>
  31 #include <sys/stat.h>
  32 #include <sys/types.h>
  33
  34 #ifdef DMALLOC
  35 #include "dmalloc.h"
  36 #endif
  37
  38 /* Some useful definitions */
  39 #define FALSE   ((int) 0)
  40 #define TRUE    ((int) 1)
  41 #define SKIP    ((int) 2)
  42
  43 /* for mtab.c */
  44 #define MTAB_GETMOUNTPT '1'
  45 #define MTAB_GETDEVICE  '2'
  46
  47 #define BUF_SIZE        8192
  48 #define EXPAND_ALLOC    1024
  49
  50 static inline int is_decimal(ch) { return ((ch >= '0') && (ch <= '9')); }
  51 static inline int is_octal(ch)   { return ((ch >= '0') && (ch <= '7')); }
  52
  53 /* Macros for min/max.  */
  54 #ifndef MIN
  55 #define MIN(a,b) (((a)<(b))?(a):(b))
  56 #endif
  57
  58 #ifndef MAX
  59 #define MAX(a,b) (((a)>(b))?(a):(b))
  60 #endif
  61
  62
  63 enum Location {
  64         _BB_DIR_ROOT = 0,
  65         _BB_DIR_BIN,
  66         _BB_DIR_SBIN,
  67         _BB_DIR_USR_BIN,
  68         _BB_DIR_USR_SBIN
  69 };
  70
  71 struct BB_applet {
  72         const   char*   name;
  73         int     (*main)(int argc, char** argv);
  74         enum    Location        location;
  75         int     usage_index;
  76 };
  77 /* From busybox.c */
  78 extern const struct BB_applet applets[];
  79
  80 /* Automagically pull in all the applet function prototypes and
  81  * applet usage strings.  These are all of the form:
  82  *              extern int foo_main(int argc, char **argv);
  83  *              extern const char foo_usage[];
  84  * These are all autogenerated from the set of currently defined applets.
  85  */
  86 #define PROTOTYPES
  87 #include "applets.h"
  88 #undef PROTOTYPES
  89
  90 #define APPLET_ENUM
  91 enum APPLET_INDEX_NUMBERS {
  92 #include "applets.h"
  93 };
  94 #undef APPLET_ENUM
  95
  96 extern const char *applet_name;
  97
  98 extern void show_usage(void) __attribute__ ((noreturn));
  99 extern void error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
 100 extern void error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
 101 extern void perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
 102 extern void perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
 103
 104 const char *mode_string(int mode);
 105 const char *time_string(time_t timeVal);
 106 int is_directory(const char *name, const int followLinks, struct stat *statBuf);
 107 int isDevice(const char *name);
 108
 109 typedef struct ino_dev_hash_bucket_struct {
 110   struct ino_dev_hash_bucket_struct *next;
 111   ino_t ino;
 112   dev_t dev;
 113   char name[1];
 114 } ino_dev_hashtable_bucket_t;
 115 int is_in_ino_dev_hashtable(const struct stat *statbuf, char **name);
 116 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
 117 void reset_ino_dev_hashtable(void);
 118
 119 int copy_file(const char *srcName, const char *destName,
 120                  int setModes, int followLinks, int forceFlag);
 121 int copy_file_chunk(int srcFd, int dstFd, size_t remaining);
 122 char *buildName(const char *dirName, const char *fileName);
 123 int makeString(int argc, const char **argv, char *buf, int bufLen);
 124 char *getChunk(int size);
 125 char *chunkstrdup(const char *str);
 126 void freeChunks(void);
 127 ssize_t safe_read(int fd, void *buf, size_t count);
 128 int full_write(int fd, const char *buf, int len);
 129 int full_read(int fd, char *buf, int len);
 130 int recursive_action(const char *fileName, int recurse, int followLinks, int depthFirst,
 131           int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData),
 132           int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData),
 133           void* userData);
 134
 135 extern int create_path (const char *name, int mode);
 136 extern int parse_mode( const char* s, mode_t* theMode);
 137
 138 extern int get_kernel_revision(void);
 139
 140 extern int get_console_fd(char* tty_name);
 141 extern struct mntent *find_mount_point(const char *name, const char *table);
 142 extern void write_mtab(char* blockDevice, char* directory,
 143         char* filesystemType, long flags, char* string_flags);
 144 extern void erase_mtab(const char * name);
 145 extern void mtab_read(void);
 146 extern char *mtab_first(void **iter);
 147 extern char *mtab_next(void **iter);
 148 extern char *mtab_getinfo(const char *match, const char which);
 149 extern int check_wildcard_match(const char* text, const char* pattern);
 150 extern long atoi_w_units (const char *cp);
 151 extern pid_t* find_pid_by_name( char* pidName);
 152 extern int find_real_root_device_name(char* name);
 153 extern char *get_line_from_file(FILE *file);
 154 extern void print_file(FILE *file);
 155 extern int print_file_by_name(char *filename);
 156 extern char process_escape_sequence(char **ptr);
 157 extern char *get_last_path_component(char *path);
 158 extern FILE *wfopen(const char *path, const char *mode);
 159 extern FILE *xfopen(const char *path, const char *mode);
 160 extern void chomp(char *s);
 161 extern struct BB_applet *find_applet_by_name(const char *name);
 162 void run_applet_by_name(const char *name, int argc, char **argv);
 163
 164 #ifndef DMALLOC
 165 extern void *xmalloc (size_t size);
 166 extern void *xrealloc(void *old, size_t size);
 167 extern void *xcalloc(size_t nmemb, size_t size);
 168 extern char *xstrdup (const char *s);
 169 #endif
 170 extern char *xstrndup (const char *s, int n);
 171 extern char * safe_strncpy(char *dst, const char *src, size_t size);
 172
 173 struct suffix_mult {
 174         char *suffix;
 175         int mult;
 176 };
 177
 178 extern unsigned long parse_number(const char *numstr,
 179                 const struct suffix_mult *suffixes);
 180
 181
 182 /* These parse entries in /etc/passwd and /etc/group.  This is desirable
 183  * for BusyBox since we want to avoid using the glibc NSS stuff, which
 184  * increases target size and is often not needed embedded systems.  */
 185 extern long my_getpwnam(char *name);
 186 extern long my_getgrnam(char *name);
 187 extern void my_getpwuid(char *name, long uid);
 188 extern void my_getgrgid(char *group, long gid);
 189 extern long my_getpwnamegid(char *name);
 190
 191 extern int device_open(char *device, int mode);
 192
 193 #if defined BB_FEATURE_MOUNT_LOOP
 194 extern int del_loop(const char *device);
 195 extern int set_loop(const char *device, const char *file, int offset, int *loopro);
 196 extern char *find_unused_loop_device (void);
 197 #endif
 198
 199
 200 #if (__GLIBC__ < 2) && (defined BB_SYSLOGD || defined BB_INIT)
 201 extern int vdprintf(int d, const char *format, va_list ap);
 202 #endif
 203
 204 #if defined BB_NFSMOUNT
 205 int nfsmount(const char *spec, const char *node, int *flags,
 206              char **extra_opts, char **mount_opts, int running_bg);
 207 #endif
 208
 209 #ifndef RB_POWER_OFF
 210 /* Stop system and switch power off if possible.  */
 211 #define RB_POWER_OFF   0x4321fedc
 212 #endif
 213
 214 /* Include our own copy of struct sysinfo to avoid binary compatability
 215  * problems with Linux 2.4, which changed things.  Grumble, grumble. */
 216 struct sysinfo {
 217         long uptime;                    /* Seconds since boot */
 218         unsigned long loads[3];         /* 1, 5, and 15 minute load averages */
 219         unsigned long totalram;         /* Total usable main memory size */
 220         unsigned long freeram;          /* Available memory size */
 221         unsigned long sharedram;        /* Amount of shared memory */
 222         unsigned long bufferram;        /* Memory used by buffers */
 223         unsigned long totalswap;        /* Total swap space size */
 224         unsigned long freeswap;         /* swap space still available */
 225         unsigned short procs;           /* Number of current processes */
 226         unsigned long totalhigh;        /* Total high memory size */
 227         unsigned long freehigh;         /* Available high memory size */
 228         unsigned int mem_unit;          /* Memory unit size in bytes */
 229         char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
 230 };
 231 extern int sysinfo (struct sysinfo* info);
 232
 233 /* Bit map related macros -- libc5 doens't provide these... sigh.  */
 234 #ifndef setbit
 235 #define NBBY            CHAR_BIT
 236 #define setbit(a,i)     ((a)[(i)/NBBY] |= 1<<((i)%NBBY))
 237 #define clrbit(a,i)     ((a)[(i)/NBBY] &= ~(1<<((i)%NBBY)))
 238 #define isset(a,i)      ((a)[(i)/NBBY] & (1<<((i)%NBBY)))
 239 #define isclr(a,i)      (((a)[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
 240 #endif
 241
 242 #ifdef BB_FEATURE_HUMAN_READABLE
 243 const char *format(unsigned long val, unsigned long hr);
 244 #define KILOBYTE 1024
 245 #define MEGABYTE (KILOBYTE*1024)
 246 #define GIGABYTE (MEGABYTE*1024)
 247 #endif
 248
 249 #ifdef BB_FEATURE_BUFFERS_GO_ON_STACK
 250 #define RESERVE_BB_BUFFER(buffer,len)           char buffer[len]
 251 #define RESERVE_BB_UBUFFER(buffer,len) unsigned char buffer[len]
 252 #else
 253 #define RESERVE_BB_BUFFER(buffer,len)           char *buffer=xmalloc(len)
 254 #define RESERVE_BB_UBUFFER(buffer,len) unsigned char *buffer=xmalloc(len)
 255 #endif
 256
 257 #endif /* _BB_INTERNAL_H_ */