blob: 4a4f44aea3dec2dcc7e63ef71d1221549d644c66 [file] [log] [blame]
Eric Andersenf6b71392000-09-26 01:09:18 +00001/* 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#ifdef DMALLOC
30#include "dmalloc.h"
31#endif
32
33#include <stdlib.h>
34#include <stdarg.h>
35#include <string.h>
36#include <unistd.h>
37#include <errno.h>
38#include <sys/stat.h>
39#include <sys/param.h>
40#include <mntent.h>
41#include <regex.h>
42/* for the _syscall() macros */
43#include <sys/syscall.h>
44#include <linux/unistd.h>
45
46
47/* Some useful definitions */
Eric Andersen2187adc2000-12-04 20:31:45 +000048#define FALSE ((int) 0)
49#define TRUE ((int) 1)
Eric Andersenf6b71392000-09-26 01:09:18 +000050
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
59#define isBlank(ch) (((ch) == ' ') || ((ch) == '\t'))
60#define isDecimal(ch) (((ch) >= '0') && ((ch) <= '9'))
61#define isOctal(ch) (((ch) >= '0') && ((ch) <= '7'))
62#define isWildCard(ch) (((ch) == '*') || ((ch) == '?') || ((ch) == '['))
63
64/* Macros for min/max. */
65#ifndef MIN
66#define MIN(a,b) (((a)<(b))?(a):(b))
67#endif
68
69#ifndef MAX
70#define MAX(a,b) (((a)>(b))?(a):(b))
71#endif
72
73
74/* I don't like nested includes, but the string and io functions are used
75 * too often
76 */
77#include <stdio.h>
78#if !defined(NO_STRING_H) || defined(STDC_HEADERS)
79# include <string.h>
80# if !defined(STDC_HEADERS) && !defined(NO_MEMORY_H) && !defined(__GNUC__)
81# include <memory.h>
82# endif
83# define memzero(s, n) memset ((void *)(s), 0, (n))
84#else
85# include <strings.h>
86# define strchr index
87# define strrchr rindex
88# define memcpy(d, s, n) bcopy((s), (d), (n))
89# define memcmp(s1, s2, n) bcmp((s1), (s2), (n))
90# define memzero(s, n) bzero((s), (n))
91#endif
92
93
94enum Location {
95 _BB_DIR_ROOT = 0,
96 _BB_DIR_BIN,
97 _BB_DIR_SBIN,
98 _BB_DIR_USR_BIN,
99 _BB_DIR_USR_SBIN
100};
101
102struct BB_applet {
103 const char* name;
104 int (*main)(int argc, char** argv);
105 enum Location location;
106 const char* usage;
107};
108/* From busybox.c */
109extern const struct BB_applet applets[];
110
Eric Andersen8c725e62000-11-30 00:27:06 +0000111/* Automagically pull in all the applet function prototypes and
Eric Andersen87559822000-12-01 19:02:24 +0000112 * applet usage strings. These are all of the form:
Eric Andersen8c725e62000-11-30 00:27:06 +0000113 * extern int foo_main(int argc, char **argv);
114 * extern const char foo_usage[];
115 * These are all autogenerated from the set of currently defined applets.
116 */
117#define PROTOTYPES
118#include "applets.h"
119#undef PROTOTYPES
Eric Andersenf6b71392000-09-26 01:09:18 +0000120
121extern const char *applet_name;
Eric Andersen8c725e62000-11-30 00:27:06 +0000122extern int applet_name_compare(const void *x, const void *y);
Eric Andersenf6b71392000-09-26 01:09:18 +0000123
124extern void usage(const char *usage) __attribute__ ((noreturn));
125extern void errorMsg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
126extern void fatalError(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
Matt Kraaief5529b2000-10-25 17:00:36 +0000127extern void perrorMsg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
Matt Kraai324a7782000-10-25 15:10:08 +0000128extern void fatalPerror(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
Eric Andersenf6b71392000-09-26 01:09:18 +0000129
130const char *modeString(int mode);
131const char *timeString(time_t timeVal);
132int isDirectory(const char *name, const int followLinks, struct stat *statBuf);
133int isDevice(const char *name);
134
135typedef struct ino_dev_hash_bucket_struct {
136 struct ino_dev_hash_bucket_struct *next;
137 ino_t ino;
138 dev_t dev;
139 char name[1];
140} ino_dev_hashtable_bucket_t;
141int is_in_ino_dev_hashtable(const struct stat *statbuf, char **name);
142void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
143void reset_ino_dev_hashtable(void);
144
145int copyFile(const char *srcName, const char *destName,
146 int setModes, int followLinks, int forceFlag);
147int copySubFile(int srcFd, int dstFd, size_t remaining);
148char *buildName(const char *dirName, const char *fileName);
149int makeString(int argc, const char **argv, char *buf, int bufLen);
150char *getChunk(int size);
151char *chunkstrdup(const char *str);
152void freeChunks(void);
153int fullWrite(int fd, const char *buf, int len);
154int fullRead(int fd, char *buf, int len);
155int recursiveAction(const char *fileName, int recurse, int followLinks, int depthFirst,
156 int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData),
157 int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData),
158 void* userData);
159
160extern int createPath (const char *name, int mode);
161extern int parse_mode( const char* s, mode_t* theMode);
162
163extern int get_kernel_revision(void);
164
165extern int get_console_fd(char* tty_name);
166extern struct mntent *findMountPoint(const char *name, const char *table);
167extern void write_mtab(char* blockDevice, char* directory,
168 char* filesystemType, long flags, char* string_flags);
169extern void erase_mtab(const char * name);
170extern void mtab_read(void);
171extern char *mtab_first(void **iter);
172extern char *mtab_next(void **iter);
173extern char *mtab_getinfo(const char *match, const char which);
174extern int check_wildcard_match(const char* text, const char* pattern);
175extern long getNum (const char *cp);
176extern pid_t* findPidByName( char* pidName);
177extern int find_real_root_device_name(char* name);
178extern char *get_line_from_file(FILE *file);
179extern void print_file(FILE *file);
180extern int print_file_by_name(char *filename);
181extern char process_escape_sequence(char **ptr);
182extern char *get_last_path_component(char *path);
183extern void xregcomp(regex_t *preg, const char *regex, int cflags);
Matt Kraaic0321f92000-09-27 04:09:22 +0000184extern FILE *wfopen(const char *path, const char *mode);
Matt Kraaie0bcce02000-09-27 02:29:39 +0000185extern FILE *xfopen(const char *path, const char *mode);
Eric Andersenf6b71392000-09-26 01:09:18 +0000186
187#ifndef DMALLOC
188extern void *xmalloc (size_t size);
189extern void *xrealloc(void *old, size_t size);
190extern void *xcalloc(size_t nmemb, size_t size);
191extern char *xstrdup (const char *s);
192#endif
193extern char *xstrndup (const char *s, int n);
194
195
196/* These parse entries in /etc/passwd and /etc/group. This is desirable
197 * for BusyBox since we want to avoid using the glibc NSS stuff, which
198 * increases target size and is often not needed embedded systems. */
199extern long my_getpwnam(char *name);
200extern long my_getgrnam(char *name);
201extern void my_getpwuid(char *name, long uid);
202extern void my_getgrgid(char *group, long gid);
203extern long my_getpwnamegid(char *name);
204
205extern int device_open(char *device, int mode);
206
207#if defined BB_FEATURE_MOUNT_LOOP
208extern int del_loop(const char *device);
209extern int set_loop(const char *device, const char *file, int offset, int *loopro);
210extern char *find_unused_loop_device (void);
211#endif
212
213
214#if (__GLIBC__ < 2) && (defined BB_SYSLOGD || defined BB_INIT)
215extern int vdprintf(int d, const char *format, va_list ap);
216#endif
217
218#if defined BB_NFSMOUNT
219int nfsmount(const char *spec, const char *node, int *flags,
220 char **extra_opts, char **mount_opts, int running_bg);
221#endif
222
223#ifndef RB_POWER_OFF
224/* Stop system and switch power off if possible. */
225#define RB_POWER_OFF 0x4321fedc
226#endif
227
228/* Include our own copy of struct sysinfo to avoid binary compatability
229 * problems with Linux 2.4, which changed things. Grumble, grumble. */
230struct sysinfo {
231 long uptime; /* Seconds since boot */
232 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
233 unsigned long totalram; /* Total usable main memory size */
234 unsigned long freeram; /* Available memory size */
235 unsigned long sharedram; /* Amount of shared memory */
236 unsigned long bufferram; /* Memory used by buffers */
237 unsigned long totalswap; /* Total swap space size */
238 unsigned long freeswap; /* swap space still available */
239 unsigned short procs; /* Number of current processes */
240 unsigned long totalhigh; /* Total high memory size */
241 unsigned long freehigh; /* Available high memory size */
242 unsigned int mem_unit; /* Memory unit size in bytes */
243 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
244};
245extern int sysinfo (struct sysinfo* info);
246
247/* Bit map related macros -- libc5 doens't provide these... sigh. */
248#ifndef setbit
249#define NBBY CHAR_BIT
250#define setbit(a,i) ((a)[(i)/NBBY] |= 1<<((i)%NBBY))
251#define clrbit(a,i) ((a)[(i)/NBBY] &= ~(1<<((i)%NBBY)))
252#define isset(a,i) ((a)[(i)/NBBY] & (1<<((i)%NBBY)))
253#define isclr(a,i) (((a)[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
254#endif
255
256#endif /* _BB_INTERNAL_H_ */