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