busybox.h - busybox - Git at Google

 /* vi: set sw=4 ts=4: */
 /*
  * Busybox main internal header file
  *
  *
  * 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
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  * General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  *
  * Based in part on code from sash, Copyright (c) 1999 by David I. Bell
  * Permission has been granted to redistribute this code under the GPL.
  *
  */
 #ifndef	_BB_INTERNAL_H_
 #define	_BB_INTERNAL_H_    1

 #include "Config.h"

 #include <stdio.h>
 #include <stdarg.h>
 #include <sys/stat.h>
 #include <sys/types.h>

 #ifdef DMALLOC
 #include "dmalloc.h"
 #endif

 /* Some useful definitions */
 #define FALSE   ((int) 0)
 #define TRUE    ((int) 1)
 #define SKIP	((int) 2)

 /* for mtab.c */
 #define MTAB_GETMOUNTPT '1'
 #define MTAB_GETDEVICE  '2'

 #define BUF_SIZE        8192
 #define EXPAND_ALLOC    1024

 static inline int is_decimal(ch) { return ((ch >= '0') && (ch <= '9')); }
 static inline int is_octal(ch)   { return ((ch >= '0') && (ch <= '7')); }

 /* 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


 enum Location {
 	_BB_DIR_ROOT = 0,
 	_BB_DIR_BIN,
 	_BB_DIR_SBIN,
 	_BB_DIR_USR_BIN,
 	_BB_DIR_USR_SBIN
 };

 struct BB_applet {
 	const	char*	name;
 	int	(*main)(int argc, char** argv);
 	enum	Location	location;
 	const	char*	usage;
 };
 /* From busybox.c */
 extern const struct BB_applet applets[];

 /* Automagically pull in all the applet function prototypes and
  * applet usage strings.  These are all of the form:
  *		extern int foo_main(int argc, char **argv);
  *		extern const char foo_usage[];
  * These are all autogenerated from the set of currently defined applets.
  */
 #define PROTOTYPES
 #include "applets.h"
 #undef PROTOTYPES

 extern const char *applet_name;
 extern int applet_name_compare(const void *x, const void *y);

 extern void usage(const char *usage) __attribute__ ((noreturn));
 extern void error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
 extern void error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
 extern void perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
 extern void perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));

 const char *mode_string(int mode);
 const char *time_string(time_t timeVal);
 int is_directory(const char *name, const int followLinks, struct stat *statBuf);
 int isDevice(const char *name);

 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 copy_file(const char *srcName, const char *destName,
 		 int setModes, int followLinks, int forceFlag);
 int copy_file_chunk(int srcFd, int dstFd, size_t remaining);
 char *buildName(const char *dirName, const char *fileName);
 int makeString(int argc, const char **argv, char *buf, int bufLen);
 char *getChunk(int size);
 char *chunkstrdup(const char *str);
 void freeChunks(void);
 ssize_t safe_read(int fd, void *buf, size_t count);
 int full_write(int fd, const char *buf, int len);
 int full_read(int fd, char *buf, int len);
 int recursive_action(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);

 extern int create_path (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 *find_mount_point(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 atoi_w_units (const char *cp);
 extern pid_t* find_pid_by_name( char* pidName);
 extern int find_real_root_device_name(char* name);
 extern char *get_line_from_file(FILE *file);
 extern void print_file(FILE *file);
 extern int print_file_by_name(char *filename);
 extern char process_escape_sequence(char **ptr);
 extern char *get_last_path_component(char *path);
 extern FILE *wfopen(const char *path, const char *mode);
 extern FILE *xfopen(const char *path, const char *mode);

 #ifndef DMALLOC
 extern void *xmalloc (size_t size);
 extern void *xrealloc(void *old, size_t size);
 extern void *xcalloc(size_t nmemb, size_t size);
 extern char *xstrdup (const char *s);
 #endif
 extern char *xstrndup (const char *s, int n);

 struct suffix_mult {
 	char *suffix;
 	int mult;
 };

 extern unsigned long parse_number(const char *numstr, struct suffix_mult *suffixes);


 /* 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 long my_getpwnam(char *name);
 extern long my_getgrnam(char *name);
 extern void my_getpwuid(char *name, long uid);
 extern void my_getgrgid(char *group, long gid);
 extern long my_getpwnamegid(char *name);

 extern int device_open(char *device, int mode);

 #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, int *flags,
 	     char **extra_opts, char **mount_opts, int running_bg);
 #endif

 #ifndef RB_POWER_OFF
 /* Stop system and switch power off if possible.  */
 #define RB_POWER_OFF   0x4321fedc
 #endif

 /* Include our own copy of struct sysinfo to avoid binary compatability
  * problems with Linux 2.4, which changed things.  Grumble, grumble. */
 struct sysinfo {
 	long uptime;			/* Seconds since boot */
 	unsigned long loads[3];		/* 1, 5, and 15 minute load averages */
 	unsigned long totalram;		/* Total usable main memory size */
 	unsigned long freeram;		/* Available memory size */
 	unsigned long sharedram;	/* Amount of shared memory */
 	unsigned long bufferram;	/* Memory used by buffers */
 	unsigned long totalswap;	/* Total swap space size */
 	unsigned long freeswap;		/* swap space still available */
 	unsigned short procs;		/* Number of current processes */
 	unsigned long totalhigh;	/* Total high memory size */
 	unsigned long freehigh;		/* Available high memory size */
 	unsigned int mem_unit;		/* Memory unit size in bytes */
 	char _f[20-2*sizeof(long)-sizeof(int)];	/* Padding: libc5 uses this.. */
 };
 extern int sysinfo (struct sysinfo* info);

 /* Bit map related macros -- libc5 doens't provide these... sigh.  */
 #ifndef setbit
 #define NBBY            CHAR_BIT
 #define setbit(a,i)     ((a)[(i)/NBBY] |= 1<<((i)%NBBY))
 #define clrbit(a,i)     ((a)[(i)/NBBY] &= ~(1<<((i)%NBBY)))
 #define isset(a,i)      ((a)[(i)/NBBY] & (1<<((i)%NBBY)))
 #define isclr(a,i)      (((a)[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
 #endif

 #ifdef BB_FEATURE_HUMAN_READABLE
 char *format(unsigned long val, unsigned long hr);
 #define KILOBYTE 1024
 #define MEGABYTE (KILOBYTE*1024)
 #define GIGABYTE (MEGABYTE*1024)
 #endif

 #ifdef BB_FEATURE_BUFFERS_GO_ON_STACK
 #define RESERVE_BB_BUFFER(buffer,len)           char buffer[len]
 #define RESERVE_BB_UBUFFER(buffer,len) unsigned char buffer[len]
 #else
 #define RESERVE_BB_BUFFER(buffer,len)           char *buffer=xmalloc(len)
 #define RESERVE_BB_UBUFFER(buffer,len) unsigned char *buffer=xmalloc(len)
 #endif

 #endif /* _BB_INTERNAL_H_ */
	/* vi: set sw=4 ts=4: */
	/*
	* Busybox main internal header file
	*
	*
	* 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
	* the Free Software Foundation; either version 2 of the License, or
	* (at your option) any later version.
	*
	* This program is distributed in the hope that it will be useful,
	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	* General Public License for more details.
	*
	* You should have received a copy of the GNU General Public License
	* along with this program; if not, write to the Free Software
	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	*
	* Based in part on code from sash, Copyright (c) 1999 by David I. Bell
	* Permission has been granted to redistribute this code under the GPL.
	*
	*/
	#ifndef _BB_INTERNAL_H_
	#define _BB_INTERNAL_H_ 1

	#include "Config.h"

	#include <stdio.h>
	#include <stdarg.h>
	#include <sys/stat.h>
	#include <sys/types.h>

	#ifdef DMALLOC
	#include "dmalloc.h"
	#endif

	/* Some useful definitions */
	#define FALSE ((int) 0)
	#define TRUE ((int) 1)
	#define SKIP ((int) 2)

	/* for mtab.c */
	#define MTAB_GETMOUNTPT '1'
	#define MTAB_GETDEVICE '2'

	#define BUF_SIZE 8192
	#define EXPAND_ALLOC 1024

	static inline int is_decimal(ch) { return ((ch >= '0') && (ch <= '9')); }
	static inline int is_octal(ch) { return ((ch >= '0') && (ch <= '7')); }

	/* 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


	enum Location {
	_BB_DIR_ROOT = 0,
	_BB_DIR_BIN,
	_BB_DIR_SBIN,
	_BB_DIR_USR_BIN,
	_BB_DIR_USR_SBIN
	};

	struct BB_applet {
	const char* name;
	int (main)(int argc, char* argv);
	enum Location location;
	const char* usage;
	};
	/* From busybox.c */
	extern const struct BB_applet applets[];

	/* Automagically pull in all the applet function prototypes and
	* applet usage strings. These are all of the form:
	* extern int foo_main(int argc, char **argv);
	* extern const char foo_usage[];
	* These are all autogenerated from the set of currently defined applets.
	*/
	#define PROTOTYPES
	#include "applets.h"
	#undef PROTOTYPES

	extern const char *applet_name;
	extern int applet_name_compare(const void x, const void y);

	extern void usage(const char *usage) __attribute__ ((noreturn));
	extern void error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
	extern void error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
	extern void perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
	extern void perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));

	const char *mode_string(int mode);
	const char *time_string(time_t timeVal);
	int is_directory(const char name, const int followLinks, struct stat statBuf);
	int isDevice(const char *name);

	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 copy_file(const char srcName, const char destName,
	int setModes, int followLinks, int forceFlag);
	int copy_file_chunk(int srcFd, int dstFd, size_t remaining);
	char buildName(const char dirName, const char *fileName);
	int makeString(int argc, const char *argv, char buf, int bufLen);
	char *getChunk(int size);
	char chunkstrdup(const char str);
	void freeChunks(void);
	ssize_t safe_read(int fd, void *buf, size_t count);
	int full_write(int fd, const char *buf, int len);
	int full_read(int fd, char *buf, int len);
	int recursive_action(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);

	extern int create_path (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 find_mount_point(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 atoi_w_units (const char *cp);
	extern pid_t* find_pid_by_name( char* pidName);
	extern int find_real_root_device_name(char* name);
	extern char get_line_from_file(FILE file);
	extern void print_file(FILE *file);
	extern int print_file_by_name(char *filename);
	extern char process_escape_sequence(char **ptr);
	extern char get_last_path_component(char path);
	extern FILE wfopen(const char path, const char *mode);
	extern FILE xfopen(const char path, const char *mode);

	#ifndef DMALLOC
	extern void *xmalloc (size_t size);
	extern void xrealloc(void old, size_t size);
	extern void *xcalloc(size_t nmemb, size_t size);
	extern char xstrdup (const char s);
	#endif
	extern char xstrndup (const char s, int n);

	struct suffix_mult {
	char *suffix;
	int mult;
	};

	extern unsigned long parse_number(const char numstr, struct suffix_mult suffixes);


	/* 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 long my_getpwnam(char *name);
	extern long my_getgrnam(char *name);
	extern void my_getpwuid(char *name, long uid);
	extern void my_getgrgid(char *group, long gid);
	extern long my_getpwnamegid(char *name);

	extern int device_open(char *device, int mode);

	#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, int *flags,
	char extra_opts, char mount_opts, int running_bg);
	#endif

	#ifndef RB_POWER_OFF
	/* Stop system and switch power off if possible. */
	#define RB_POWER_OFF 0x4321fedc
	#endif

	/* Include our own copy of struct sysinfo to avoid binary compatability
	* problems with Linux 2.4, which changed things. Grumble, grumble. */
	struct sysinfo {
	long uptime; /* Seconds since boot */
	unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
	unsigned long totalram; /* Total usable main memory size */
	unsigned long freeram; /* Available memory size */
	unsigned long sharedram; /* Amount of shared memory */
	unsigned long bufferram; /* Memory used by buffers */
	unsigned long totalswap; /* Total swap space size */
	unsigned long freeswap; /* swap space still available */
	unsigned short procs; /* Number of current processes */
	unsigned long totalhigh; /* Total high memory size */
	unsigned long freehigh; /* Available high memory size */
	unsigned int mem_unit; /* Memory unit size in bytes */
	char _f[20-2sizeof(long)-sizeof(int)]; / Padding: libc5 uses this.. */
	};
	extern int sysinfo (struct sysinfo* info);

	/* Bit map related macros -- libc5 doens't provide these... sigh. */
	#ifndef setbit
	#define NBBY CHAR_BIT
	#define setbit(a,i) ((a)[(i)/NBBY] \|= 1<<((i)%NBBY))
	#define clrbit(a,i) ((a)[(i)/NBBY] &= ~(1<<((i)%NBBY)))
	#define isset(a,i) ((a)[(i)/NBBY] & (1<<((i)%NBBY)))
	#define isclr(a,i) (((a)[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
	#endif

	#ifdef BB_FEATURE_HUMAN_READABLE
	char *format(unsigned long val, unsigned long hr);
	#define KILOBYTE 1024
	#define MEGABYTE (KILOBYTE*1024)
	#define GIGABYTE (MEGABYTE*1024)
	#endif

	#ifdef BB_FEATURE_BUFFERS_GO_ON_STACK
	#define RESERVE_BB_BUFFER(buffer,len) char buffer[len]
	#define RESERVE_BB_UBUFFER(buffer,len) unsigned char buffer[len]
	#else
	#define RESERVE_BB_BUFFER(buffer,len) char *buffer=xmalloc(len)
	#define RESERVE_BB_UBUFFER(buffer,len) unsigned char *buffer=xmalloc(len)
	#endif

	#endif /* _BB_INTERNAL_H_ */