internal.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 "busybox.def.h"
  28
  29 #include <stdlib.h>
  30 #include <stdarg.h>
  31 #include <string.h>
  32 #include <unistd.h>
  33 #include <errno.h>
  34 #include <sys/stat.h>
  35 #include <sys/param.h>
  36 #include <mntent.h>
  37
  38
  39 /* Some useful definitions */
  40 #define FALSE   ((int) 1)
  41 #define TRUE    ((int) 0)
  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
  51 #define isBlank(ch)     (((ch) == ' ') || ((ch) == '\t'))
  52 #define isDecimal(ch)   (((ch) >= '0') && ((ch) <= '9'))
  53 #define isOctal(ch)     (((ch) >= '0') && ((ch) <= '7'))
  54 #define isWildCard(ch)  (((ch) == '*') || ((ch) == '?') || ((ch) == '['))
  55
  56 /* Macros for min/max.  */
  57 #ifndef MIN
  58 #define MIN(a,b) (((a)<(b))?(a):(b))
  59 #endif
  60
  61 #ifndef MAX
  62 #define MAX(a,b) (((a)>(b))?(a):(b))
  63 #endif
  64
  65
  66 /* I don't like nested includes, but the string and io functions are used
  67  * too often
  68  */
  69 #include <stdio.h>
  70 #if !defined(NO_STRING_H) || defined(STDC_HEADERS)
  71 #  include <string.h>
  72 #  if !defined(STDC_HEADERS) && !defined(NO_MEMORY_H) && !defined(__GNUC__)
  73 #    include <memory.h>
  74 #  endif
  75 #  define memzero(s, n)     memset ((void *)(s), 0, (n))
  76 #else
  77 #  include <strings.h>
  78 #  define strchr            index
  79 #  define strrchr           rindex
  80 #  define memcpy(d, s, n)   bcopy((s), (d), (n))
  81 #  define memcmp(s1, s2, n) bcmp((s1), (s2), (n))
  82 #  define memzero(s, n)     bzero((s), (n))
  83 #endif
  84
  85
  86 enum Location {
  87         _BB_DIR_ROOT = 0,
  88         _BB_DIR_BIN,
  89         _BB_DIR_SBIN,
  90         _BB_DIR_USR_BIN,
  91         _BB_DIR_USR_SBIN
  92 };
  93
  94 struct BB_applet {
  95         const   char*   name;
  96         int     (*main)(int argc, char** argv);
  97         enum    Location        location;
  98 };
  99 /* From busybox.c */
 100 extern const struct BB_applet applets[];
 101
 102 extern int ar_main(int argc, char **argv);
 103 extern int basename_main(int argc, char **argv);
 104 extern int busybox_main(int argc, char** argv);
 105 extern int cat_main(int argc, char** argv);
 106 extern int chmod_chown_chgrp_main(int argc, char** argv);
 107 extern int chroot_main(int argc, char** argv);
 108 extern int chvt_main(int argc, char** argv);
 109 extern int clear_main(int argc, char** argv);
 110 extern int cp_mv_main(int argc, char** argv);
 111 extern int cut_main(int argc, char** argv);
 112 extern int date_main(int argc, char** argv);
 113 extern int dc_main(int argc, char** argv);
 114 extern int dd_main(int argc, char** argv);
 115 extern int dirname_main(int argc, char** argv);
 116 extern int deallocvt_main(int argc, char** argv);
 117 extern int df_main(int argc, char** argv);
 118 extern int dmesg_main(int argc, char** argv);
 119 extern int du_main(int argc, char** argv);
 120 extern int dutmp_main(int argc, char** argv);
 121 extern int echo_main(int argc, char** argv);
 122 extern int false_main(int argc, char** argv);
 123 extern int fbset_main(int argc, char** argv);
 124 extern int fdisk_main(int argc, char** argv);
 125 extern int fdflush_main(int argc, char **argv);
 126 extern int fsck_minix_main(int argc, char **argv);
 127 extern int find_main(int argc, char** argv);
 128 extern int free_main(int argc, char** argv);
 129 extern int freeramdisk_main(int argc, char** argv);
 130 extern int grep_main(int argc, char** argv);
 131 extern int gunzip_main (int argc, char** argv);
 132 extern int gzip_main(int argc, char** argv);
 133 extern int halt_main(int argc, char** argv);
 134 extern int head_main(int argc, char** argv);
 135 extern int hostid_main(int argc, char** argv);
 136 extern int hostname_main(int argc, char** argv);
 137 extern int id_main(int argc, char** argv);
 138 extern int init_main(int argc, char** argv);
 139 extern int insmod_main(int argc, char** argv);
 140 extern int kill_main(int argc, char** argv);
 141 extern int length_main(int argc, char** argv);
 142 extern int ln_main(int argc, char** argv);
 143 extern int loadacm_main(int argc, char** argv);
 144 extern int loadfont_main(int argc, char** argv);
 145 extern int loadkmap_main(int argc, char** argv);
 146 extern int losetup_main(int argc, char** argv);
 147 extern int logger_main(int argc, char **argv);
 148 extern int logname_main(int argc, char **argv);
 149 extern int ls_main(int argc, char** argv);
 150 extern int lsmod_main(int argc, char** argv);
 151 extern int makedevs_main(int argc, char** argv);
 152 extern int md5sum_main(int argc, char** argv);
 153 extern int mkdir_main(int argc, char** argv);
 154 extern int mkfifo_main(int argc, char **argv);
 155 extern int mkfs_minix_main(int argc, char **argv);
 156 extern int mknod_main(int argc, char** argv);
 157 extern int mkswap_main(int argc, char** argv);
 158 extern int mktemp_main(int argc, char **argv);
 159 extern int nc_main(int argc, char** argv);
 160 extern int more_main(int argc, char** argv);
 161 extern int mount_main(int argc, char** argv);
 162 extern int mt_main(int argc, char** argv);
 163 extern int nslookup_main(int argc, char **argv);
 164 extern int ping_main(int argc, char **argv);
 165 extern int poweroff_main(int argc, char **argv);
 166 extern int printf_main(int argc, char** argv);
 167 extern int ps_main(int argc, char** argv);
 168 extern int pwd_main(int argc, char** argv);
 169 extern int reboot_main(int argc, char** argv);
 170 extern int rm_main(int argc, char** argv);
 171 extern int rmdir_main(int argc, char **argv);
 172 extern int rmmod_main(int argc, char** argv);
 173 extern int sed_main(int argc, char** argv);
 174 extern int sfdisk_main(int argc, char** argv);
 175 extern int setkeycodes_main(int argc, char** argv);
 176 extern int shell_main(int argc, char** argv);
 177 extern int sleep_main(int argc, char** argv);
 178 extern int sort_main(int argc, char** argv);
 179 extern int swap_on_off_main(int argc, char** argv);
 180 extern int sync_main(int argc, char** argv);
 181 extern int syslogd_main(int argc, char **argv);
 182 extern int tail_main(int argc, char** argv);
 183 extern int tar_main(int argc, char** argv);
 184 extern int tee_main(int argc, char** argv);
 185 extern int test_main(int argc, char** argv);
 186 extern int telnet_main(int argc, char** argv);
 187 extern int touch_main(int argc, char** argv);
 188 extern int tr_main(int argc, char** argv);
 189 extern int true_main(int argc, char** argv);
 190 extern int tput_main(int argc, char** argv);
 191 extern int tryopen_main(int argc, char** argv);
 192 extern int tty_main(int argc, char** argv);
 193 extern int uuencode_main(int argc, char** argv);
 194 extern int uudecode_main(int argc, char** argv);
 195 extern int umount_main(int argc, char** argv);
 196 extern int uname_main(int argc, char** argv);
 197 extern int uptime_main(int argc, char** argv);
 198 extern int uniq_main(int argc, char** argv);
 199 extern int update_main(int argc, char** argv);
 200 extern int usleep_main(int argc, char** argv);
 201 extern int wc_main(int argc, char** argv);
 202 extern int which_main(int argc, char** argv);
 203 extern int whoami_main(int argc, char** argv);
 204 extern int yes_main(int argc, char** argv);
 205
 206
 207 extern void usage(const char *usage) __attribute__ ((noreturn));
 208 extern void errorMsg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
 209 extern void fatalError(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
 210
 211 const char *modeString(int mode);
 212 const char *timeString(time_t timeVal);
 213 int isDirectory(const char *name, const int followLinks, struct stat *statBuf);
 214 int isDevice(const char *name);
 215
 216 typedef struct ino_dev_hash_bucket_struct {
 217   struct ino_dev_hash_bucket_struct *next;
 218   ino_t ino;
 219   dev_t dev;
 220   char name[1];
 221 } ino_dev_hashtable_bucket_t;
 222 int is_in_ino_dev_hashtable(const struct stat *statbuf, char **name);
 223 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
 224 void reset_ino_dev_hashtable(void);
 225
 226 int copyFile(const char *srcName, const char *destName,
 227                  int setModes, int followLinks, int forceFlag);
 228 char *buildName(const char *dirName, const char *fileName);
 229 int makeString(int argc, const char **argv, char *buf, int bufLen);
 230 char *getChunk(int size);
 231 char *chunkstrdup(const char *str);
 232 void freeChunks(void);
 233 int fullWrite(int fd, const char *buf, int len);
 234 int fullRead(int fd, char *buf, int len);
 235 int recursiveAction(const char *fileName, int recurse, int followLinks, int depthFirst,
 236           int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData),
 237           int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData),
 238           void* userData);
 239 const char* timeString(time_t timeVal);
 240
 241 extern int createPath (const char *name, int mode);
 242 extern int parse_mode( const char* s, mode_t* theMode);
 243
 244 extern int get_kernel_revision(void);
 245
 246 extern int get_console_fd(char* tty_name);
 247 extern struct mntent *findMountPoint(const char *name, const char *table);
 248 extern void write_mtab(char* blockDevice, char* directory,
 249         char* filesystemType, long flags, char* string_flags);
 250 extern void erase_mtab(const char * name);
 251 extern void mtab_read(void);
 252 extern char *mtab_first(void **iter);
 253 extern char *mtab_next(void **iter);
 254 extern char *mtab_getinfo(const char *match, const char which);
 255 extern int check_wildcard_match(const char* text, const char* pattern);
 256 extern long getNum (const char *cp);
 257 extern pid_t* findPidByName( char* pidName);
 258 extern void *xmalloc (size_t size);
 259 extern int find_real_root_device_name(char* name);
 260 extern char *get_line_from_file(FILE *file);
 261 extern char process_escape_sequence(char **ptr);
 262 extern char *get_last_path_component(char *path);
 263
 264 /* These parse entries in /etc/passwd and /etc/group.  This is desirable
 265  * for BusyBox since we want to avoid using the glibc NSS stuff, which
 266  * increases target size and is often not needed embedded systems.  */
 267 extern unsigned long my_getpwnam(char *name);
 268 extern unsigned long my_getgrnam(char *name);
 269 extern void my_getpwuid(char *name, unsigned long uid);
 270 extern void my_getgrgid(char *group, unsigned long gid);
 271 extern unsigned long my_getpwnamegid(char *name);
 272
 273
 274 #if defined BB_INIT || defined BB_SYSLOGD
 275 extern int device_open(char *device, int mode);
 276 #endif
 277 #if defined BB_FEATURE_MOUNT_LOOP
 278 extern int del_loop(const char *device);
 279 extern int set_loop(const char *device, const char *file, int offset, int *loopro);
 280 extern char *find_unused_loop_device (void);
 281 #endif
 282
 283
 284 #if (__GLIBC__ < 2) && (defined BB_SYSLOGD || defined BB_INIT)
 285 extern int vdprintf(int d, const char *format, va_list ap);
 286 #endif
 287
 288 #if defined BB_NFSMOUNT
 289 int nfsmount(const char *spec, const char *node, unsigned long *flags,
 290         char **extra_opts, char **mount_opts, int running_bg);
 291 #endif
 292
 293 #ifndef RB_POWER_OFF
 294 /* Stop system and switch power off if possible.  */
 295 #define RB_POWER_OFF   0x4321fedc
 296 #endif
 297
 298 /* Include our own copy of struct sysinfo to avoid binary compatability
 299  * problems with Linux 2.4, which changed things.  Grumble, grumble. */
 300 struct sysinfo {
 301         long uptime;                    /* Seconds since boot */
 302         unsigned long loads[3];         /* 1, 5, and 15 minute load averages */
 303         unsigned long totalram;         /* Total usable main memory size */
 304         unsigned long freeram;          /* Available memory size */
 305         unsigned long sharedram;        /* Amount of shared memory */
 306         unsigned long bufferram;        /* Memory used by buffers */
 307         unsigned long totalswap;        /* Total swap space size */
 308         unsigned long freeswap;         /* swap space still available */
 309         unsigned short procs;           /* Number of current processes */
 310         unsigned long totalhigh;        /* Total high memory size */
 311         unsigned long freehigh;         /* Available high memory size */
 312         unsigned int mem_unit;          /* Memory unit size in bytes */
 313         char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
 314 };
 315 extern int sysinfo (struct sysinfo* info);
 316
 317 /* Bit map related macros -- libc5 doens't provide these... sigh.  */
 318 #ifndef setbit
 319 #define NBBY            CHAR_BIT
 320 #define setbit(a,i)     ((a)[(i)/NBBY] |= 1<<((i)%NBBY))
 321 #define clrbit(a,i)     ((a)[(i)/NBBY] &= ~(1<<((i)%NBBY)))
 322 #define isset(a,i)      ((a)[(i)/NBBY] & (1<<((i)%NBBY)))
 323 #define isclr(a,i)      (((a)[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
 324 #endif
 325
 326 #endif /* _BB_INTERNAL_H_ */