Remove trailing space char.
[oweals/busybox.git] / internal.h
index d36d218a9b745e682584abb6373fc4c6533322e2..e25c14460bb34bcb06e2a10ba117c72ebc74a90a 100644 (file)
@@ -1,7 +1,7 @@
+/* vi: set sw=4 ts=4: */
 /*
- * Busybox main header file
+ * Busybox main internal header file
  *
- * Copyright (C) 1998 by Erik Andersen <andersee@debian.org>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * Permission has been granted to redistribute this code under the GPL.
  *
  */
-#ifndef        _INTERNAL_H_
-#define        _INTERNAL_H_
+#ifndef        _BB_INTERNAL_H_
+#define        _BB_INTERNAL_H_    1
 
 #include "busybox.def.h"
 
 #include <stdlib.h>
+#include <stdarg.h>
 #include <string.h>
 #include <unistd.h>
 #include <sys/stat.h>
+#include <sys/param.h>
+#include <mntent.h>
 
 
 /* Some useful definitions */
-#define STDIN  0
-#define STDOUT 1
 #define FALSE   ((int) 1)
 #define TRUE    ((int) 0)
 
-#define PATH_LEN        1024
+/* for mtab.c */
+#define MTAB_GETMOUNTPT '1'
+#define MTAB_GETDEVICE  '2'
+
 #define BUF_SIZE        8192
 #define EXPAND_ALLOC    1024
 
+
 #define isBlank(ch)     (((ch) == ' ') || ((ch) == '\t'))
 #define isDecimal(ch)   (((ch) >= '0') && ((ch) <= '9'))
 #define isOctal(ch)     (((ch) >= '0') && ((ch) <= '7'))
 #define isWildCard(ch)  (((ch) == '*') || ((ch) == '?') || ((ch) == '['))
 
+/* Macros for min/max.  */
+#ifndef MIN
+#define        MIN(a,b) (((a)<(b))?(a):(b))
+#endif
+
+#ifndef MAX
+#define        MAX(a,b) (((a)>(b))?(a):(b))
+#endif
 
 
-struct FileInfo {
-       unsigned int    complainInPostProcess:1;
-       unsigned int    changeUserID:1;
-       unsigned int    changeGroupID:1;
-       unsigned int    changeMode:1;
-       unsigned int    create:1;
-       unsigned int    force:1;
-       unsigned int    recursive:1;
-       unsigned int    processDirectoriesAfterTheirContents;
-       unsigned int    makeParentDirectories:1;
-       unsigned int    didOperation:1;
-       unsigned int    isSymbolicLink:1;
-       unsigned int    makeSymbolicLink:1;
-       unsigned int    dyadic:1;
-       const char*     source;
-       const char*     destination;
-       int                             directoryLength;
-       uid_t                   userID;
-       gid_t                   groupID;
-       mode_t                  andWithMode;
-       mode_t                  orWithMode;
-       struct stat             stat;
-       const struct Applet *
-                                       applet;
+/* I don't like nested includes, but the string and io functions are used
+ * too often
+ */
+#include <stdio.h>
+#if !defined(NO_STRING_H) || defined(STDC_HEADERS)
+#  include <string.h>
+#  if !defined(STDC_HEADERS) && !defined(NO_MEMORY_H) && !defined(__GNUC__)
+#    include <memory.h>
+#  endif
+#  define memzero(s, n)     memset ((void *)(s), 0, (n))
+#else
+#  include <strings.h>
+#  define strchr            index
+#  define strrchr           rindex
+#  define memcpy(d, s, n)   bcopy((s), (d), (n))
+#  define memcmp(s1, s2, n) bcmp((s1), (s2), (n))
+#  define memzero(s, n)     bzero((s), (n))
+#endif
+
+
+enum Location {
+       _BB_DIR_ROOT = 0,
+       _BB_DIR_BIN,
+       _BB_DIR_SBIN,
+       _BB_DIR_USR_BIN,
+       _BB_DIR_USR_SBIN
 };
 
-struct Applet {
+struct BB_applet {
        const   char*   name;
        int     (*main)(int argc, char** argv);
+       enum    Location        location;
 };
+/* From busybox.c */
+extern const struct BB_applet applets[];
 
-extern void    name_and_error(const char*);
-extern int     is_a_directory(const char*);
-extern char*   join_paths(char *, const char *, const char *);
-
-extern int     descend(
-                struct FileInfo *o
-               ,int            (*function)(const struct FileInfo * i));
-
-extern struct mntent *
-               findMountPoint(const char*, const char *);
-
-extern void usage(const char*);
+extern int ar_main(int argc, char **argv);
+extern int basename_main(int argc, char **argv);
 extern int busybox_main(int argc, char** argv);
 extern int block_device_main(int argc, char** argv);
-extern int cat_more_main(int argc, char** argv);
-extern int more_main(int argc, char** argv);
-extern int cp_main(int argc, char** argv);
-extern int chgrp_main(int argc, char** argv);
-extern int chmod_main(int argc, char** argv);
-extern int chown_main(int argc, char** argv);
+extern int cat_main(int argc, char** argv);
+extern int chmod_chown_chgrp_main(int argc, char** argv);
 extern int chroot_main(int argc, char** argv);
+extern int chvt_main(int argc, char** argv);
 extern int clear_main(int argc, char** argv);
+extern int cp_mv_main(int argc, char** argv);
+extern int cut_main(int argc, char** argv);
 extern int date_main(int argc, char** argv);
 extern int dd_main(int argc, char** argv);
+extern int dirname_main(int argc, char** argv);
+extern int deallocvt_main(int argc, char** argv);
 extern int df_main(int argc, char** argv);
 extern int dmesg_main(int argc, char** argv);
-extern int dyadic_main(int argc, char** argv);
+extern int du_main(int argc, char** argv);
+extern int dutmp_main(int argc, char** argv);
+extern int echo_main(int argc, char** argv);
 extern int false_main(int argc, char** argv);
+extern int fbset_main(int argc, char** argv);
 extern int fdisk_main(int argc, char** argv);
+extern int fdflush_main(int argc, char **argv);
+extern int fsck_minix_main(int argc, char **argv);
 extern int find_main(int argc, char** argv);
+extern int free_main(int argc, char** argv);
+extern int freeramdisk_main(int argc, char** argv);
 extern int grep_main(int argc, char** argv);
+extern int gunzip_main (int argc, char** argv);
+extern int gzip_main(int argc, char** argv);
 extern int halt_main(int argc, char** argv);
+extern int head_main(int argc, char** argv);
+extern int hostid_main(int argc, char** argv);
+extern int hostname_main(int argc, char** argv);
+extern int id_main(int argc, char** argv);
 extern int init_main(int argc, char** argv);
+extern int insmod_main(int argc, char** argv);
 extern int kill_main(int argc, char** argv);
 extern int length_main(int argc, char** argv);
 extern int ln_main(int argc, char** argv);
+extern int loadacm_main(int argc, char** argv);
+extern int loadfont_main(int argc, char** argv);
 extern int loadkmap_main(int argc, char** argv);
 extern int losetup_main(int argc, char** argv);
+extern int logger_main(int argc, char **argv);
+extern int logname_main(int argc, char **argv);
 extern int ls_main(int argc, char** argv);
+extern int lsmod_main(int argc, char** argv);
 extern int makedevs_main(int argc, char** argv);
 extern int math_main(int argc, char** argv);
+extern int md5sum_main(int argc, char** argv);
+extern int mkdir_main(int argc, char** argv);
+extern int mkfifo_main(int argc, char **argv);
+extern int mkfs_minix_main(int argc, char **argv);
 extern int mknod_main(int argc, char** argv);
 extern int mkswap_main(int argc, char** argv);
-extern int mnc_main(int argc, char** argv);
-extern int monadic_main(int argc, char** argv);
+extern int mktemp_main(int argc, char **argv);
+extern int nc_main(int argc, char** argv);
+extern int more_main(int argc, char** argv);
 extern int mount_main(int argc, char** argv);
 extern int mt_main(int argc, char** argv);
-extern int mv_main(int argc, char** argv);
+extern int nslookup_main(int argc, char **argv);
+extern int ping_main(int argc, char **argv);
+extern int poweroff_main(int argc, char **argv);
 extern int printf_main(int argc, char** argv);
+extern int ps_main(int argc, char** argv);
 extern int pwd_main(int argc, char** argv);
 extern int reboot_main(int argc, char** argv);
 extern int rm_main(int argc, char** argv);
-extern int scan_partitions_main(int argc, char** argv);
-extern int sh_main(int argc, char** argv);
+extern int rmdir_main(int argc, char **argv);
+extern int rmmod_main(int argc, char** argv);
+extern int sed_main(int argc, char** argv);
+extern int sfdisk_main(int argc, char** argv);
+extern int setkeycodes_main(int argc, char** argv);
+extern int shell_main(int argc, char** argv);
 extern int sleep_main(int argc, char** argv);
+extern int sort_main(int argc, char** argv);
+extern int swap_on_off_main(int argc, char** argv);
+extern int sync_main(int argc, char** argv);
+extern int syslogd_main(int argc, char **argv);
+extern int tail_main(int argc, char** argv);
 extern int tar_main(int argc, char** argv);
+extern int tee_main(int argc, char** argv);
+extern int test_main(int argc, char** argv);
+extern int telnet_main(int argc, char** argv);
 extern int touch_main(int argc, char** argv);
-extern int sync_main(int argc, char** argv);
-extern int tput_main(int argc, char** argv);
+extern int tr_main(int argc, char** argv);
 extern int true_main(int argc, char** argv);
+extern int tput_main(int argc, char** argv);
 extern int tryopen_main(int argc, char** argv);
+extern int tty_main(int argc, char** argv);
+extern int uuencode_main(int argc, char** argv);
+extern int uudecode_main(int argc, char** argv);
 extern int umount_main(int argc, char** argv);
+extern int uname_main(int argc, char** argv);
+extern int uptime_main(int argc, char** argv);
+extern int uniq_main(int argc, char** argv);
 extern int update_main(int argc, char** argv);
-extern int zcat_main(int argc, char** argv);
-extern int gzip_main(int argc, char** argv);
-
-extern int
-parse_mode(
- const char*   s
-,mode_t *              or
-,mode_t *              and
-,int *                 group_execute);
+extern int usleep_main(int argc, char** argv);
+extern int wc_main(int argc, char** argv);
+extern int which_main(int argc, char** argv);
+extern int whoami_main(int argc, char** argv);
+extern int yes_main(int argc, char** argv);
 
-extern int             parse_user_name(const char* string, struct FileInfo * i);
 
-
-/*
- * A chunk of data.
- * Chunks contain data which is allocated as needed, but which is
- * not freed until all of the data needs freeing, such as at
- * the beginning of the next command.
- */
-typedef struct chunk CHUNK;
-#define CHUNK_INIT_SIZE 4
-
-struct chunk {
-    CHUNK *next;
-    char data[CHUNK_INIT_SIZE];        /* actually of varying length */
-};
+extern void usage(const char *usage) __attribute__ ((noreturn));
+extern void errorMsg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
+extern void fatalError(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
 
 const char *modeString(int mode);
 const char *timeString(time_t timeVal);
-int isDirectory(const char *name);
+int isDirectory(const char *name, const int followLinks, struct stat *statBuf);
 int isDevice(const char *name);
-int copyFile(const char *srcName, const char *destName, int setModes,
-               int followLinks);
+
+typedef struct ino_dev_hash_bucket_struct {
+  struct ino_dev_hash_bucket_struct *next;
+  ino_t ino;
+  dev_t dev;
+  char name[1];
+} ino_dev_hashtable_bucket_t;
+int is_in_ino_dev_hashtable(const struct stat *statbuf, char **name);
+void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
+void reset_ino_dev_hashtable(void);
+
+int copyFile(const char *srcName, const char *destName,
+                int setModes, int followLinks, int forceFlag);
 char *buildName(const char *dirName, const char *fileName);
 int makeString(int argc, const char **argv, char *buf, int bufLen);
 char *getChunk(int size);
@@ -183,12 +232,66 @@ char *chunkstrdup(const char *str);
 void freeChunks(void);
 int fullWrite(int fd, const char *buf, int len);
 int fullRead(int fd, char *buf, int len);
-int recursiveAction(const char *fileName, int recurse, int followLinks,
-         int (*fileAction) (const char *fileName),
-         int (*dirAction) (const char *fileName));
-int match(const char* text, const char * pattern);
+int recursiveAction(const char *fileName, int recurse, int followLinks, int depthFirst,
+         int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData),
+         int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData),
+         void* userData);
 const char* timeString(time_t timeVal);
 
+extern int createPath (const char *name, int mode);
+extern int parse_mode( const char* s, mode_t* theMode);
+
+extern int get_kernel_revision(void);
+
+extern int get_console_fd(char* tty_name);
+extern struct mntent *findMountPoint(const char *name, const char *table);
+extern void write_mtab(char* blockDevice, char* directory, 
+       char* filesystemType, long flags, char* string_flags);
+extern void erase_mtab(const char * name);
+extern void mtab_read(void);
+extern char *mtab_first(void **iter);
+extern char *mtab_next(void **iter);
+extern char *mtab_getinfo(const char *match, const char which);
+extern int check_wildcard_match(const char* text, const char* pattern);
+extern long getNum (const char *cp);
+extern pid_t* findPidByName( char* pidName);
+extern void *xmalloc (size_t size);
+extern int find_real_root_device_name(char* name);
+extern char *cstring_lineFromFile(FILE *f);
+
+/* These parse entries in /etc/passwd and /etc/group.  This is desirable
+ * for BusyBox since we want to avoid using the glibc NSS stuff, which
+ * increases target size and is often not needed embedded systems.  */
+extern unsigned long my_getpwnam(char *name);
+extern unsigned long my_getgrnam(char *name);
+extern void my_getpwuid(char *name, unsigned long uid);
+extern void my_getgrgid(char *group, unsigned long gid);
+extern unsigned long my_getpwnamegid(char *name);
 
+
+#if defined BB_INIT || defined BB_SYSLOGD
+extern int device_open(char *device, int mode);
+#endif
+#if defined BB_FEATURE_MOUNT_LOOP
+extern int del_loop(const char *device);
+extern int set_loop(const char *device, const char *file, int offset, int *loopro);
+extern char *find_unused_loop_device (void);
+#endif
+
+
+#if (__GLIBC__ < 2) && (defined BB_SYSLOGD || defined BB_INIT)
+extern int vdprintf(int d, const char *format, va_list ap);
 #endif
 
+#if defined BB_NFSMOUNT
+int nfsmount(const char *spec, const char *node, unsigned long *flags,
+       char **extra_opts, char **mount_opts, int running_bg);
+#endif
+
+#ifndef RB_POWER_OFF
+/* Stop system and switch power off if possable.  */
+#define RB_POWER_OFF   0x4321fedc
+#endif
+
+
+#endif /* _BB_INTERNAL_H_ */