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