blob: e332ed41282a31db92c2a6e1dfff7b09adc73965 [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
Eric Andersened3ef502001-01-27 08:24:39 +000029#include <stdio.h>
Eric Andersenf6b71392000-09-26 01:09:18 +000030#include <stdarg.h>
Eric Andersenf6b71392000-09-26 01:09:18 +000031#include <sys/stat.h>
Eric Andersen01bda5d2001-01-02 01:16:38 +000032#include <sys/types.h>
Eric Andersenf6b71392000-09-26 01:09:18 +000033
Eric Andersen01bda5d2001-01-02 01:16:38 +000034#ifdef DMALLOC
35#include "dmalloc.h"
36#endif
Eric Andersenf6b71392000-09-26 01:09:18 +000037
38/* Some useful definitions */
Eric Andersen2187adc2000-12-04 20:31:45 +000039#define FALSE ((int) 0)
40#define TRUE ((int) 1)
Matt Kraaia1f97752000-12-19 06:24:08 +000041#define SKIP ((int) 2)
Eric Andersenf6b71392000-09-26 01:09:18 +000042
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
Mark Whitleyf57c9442000-12-07 19:56:48 +000050static inline int is_decimal(ch) { return ((ch >= '0') && (ch <= '9')); }
51static inline int is_octal(ch) { return ((ch >= '0') && (ch <= '7')); }
Eric Andersenf6b71392000-09-26 01:09:18 +000052
53/* Macros for min/max. */
54#ifndef MIN
55#define MIN(a,b) (((a)<(b))?(a):(b))
56#endif
57
58#ifndef MAX
59#define MAX(a,b) (((a)>(b))?(a):(b))
60#endif
61
62
Eric Andersenf6b71392000-09-26 01:09:18 +000063enum Location {
64 _BB_DIR_ROOT = 0,
65 _BB_DIR_BIN,
66 _BB_DIR_SBIN,
67 _BB_DIR_USR_BIN,
68 _BB_DIR_USR_SBIN
69};
70
71struct BB_applet {
72 const char* name;
73 int (*main)(int argc, char** argv);
74 enum Location location;
75 const char* usage;
76};
77/* From busybox.c */
78extern const struct BB_applet applets[];
79
Eric Andersen8c725e62000-11-30 00:27:06 +000080/* Automagically pull in all the applet function prototypes and
Eric Andersen87559822000-12-01 19:02:24 +000081 * applet usage strings. These are all of the form:
Eric Andersen8c725e62000-11-30 00:27:06 +000082 * extern int foo_main(int argc, char **argv);
83 * extern const char foo_usage[];
84 * These are all autogenerated from the set of currently defined applets.
85 */
86#define PROTOTYPES
87#include "applets.h"
88#undef PROTOTYPES
Eric Andersenf6b71392000-09-26 01:09:18 +000089
90extern const char *applet_name;
Eric Andersen8c725e62000-11-30 00:27:06 +000091extern int applet_name_compare(const void *x, const void *y);
Eric Andersenf6b71392000-09-26 01:09:18 +000092
93extern void usage(const char *usage) __attribute__ ((noreturn));
Mark Whitleyf57c9442000-12-07 19:56:48 +000094extern void error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
95extern void error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
96extern void perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
97extern void perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
Eric Andersenf6b71392000-09-26 01:09:18 +000098
Mark Whitleyf57c9442000-12-07 19:56:48 +000099const char *mode_string(int mode);
100const char *time_string(time_t timeVal);
101int is_directory(const char *name, const int followLinks, struct stat *statBuf);
Eric Andersenf6b71392000-09-26 01:09:18 +0000102int isDevice(const char *name);
103
104typedef struct ino_dev_hash_bucket_struct {
105 struct ino_dev_hash_bucket_struct *next;
106 ino_t ino;
107 dev_t dev;
108 char name[1];
109} ino_dev_hashtable_bucket_t;
110int is_in_ino_dev_hashtable(const struct stat *statbuf, char **name);
111void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
112void reset_ino_dev_hashtable(void);
113
Mark Whitleyf57c9442000-12-07 19:56:48 +0000114int copy_file(const char *srcName, const char *destName,
Eric Andersenf6b71392000-09-26 01:09:18 +0000115 int setModes, int followLinks, int forceFlag);
Mark Whitley47583682000-12-05 20:03:17 +0000116int copy_file_chunk(int srcFd, int dstFd, size_t remaining);
Eric Andersenf6b71392000-09-26 01:09:18 +0000117char *buildName(const char *dirName, const char *fileName);
118int makeString(int argc, const char **argv, char *buf, int bufLen);
119char *getChunk(int size);
120char *chunkstrdup(const char *str);
121void freeChunks(void);
Matt Kraaibfa79672000-12-15 22:34:34 +0000122ssize_t safe_read(int fd, void *buf, size_t count);
Mark Whitleyf57c9442000-12-07 19:56:48 +0000123int full_write(int fd, const char *buf, int len);
124int full_read(int fd, char *buf, int len);
125int recursive_action(const char *fileName, int recurse, int followLinks, int depthFirst,
Eric Andersenf6b71392000-09-26 01:09:18 +0000126 int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData),
127 int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData),
128 void* userData);
129
Mark Whitleyf57c9442000-12-07 19:56:48 +0000130extern int create_path (const char *name, int mode);
Eric Andersenf6b71392000-09-26 01:09:18 +0000131extern int parse_mode( const char* s, mode_t* theMode);
132
133extern int get_kernel_revision(void);
134
135extern int get_console_fd(char* tty_name);
Mark Whitleyf57c9442000-12-07 19:56:48 +0000136extern struct mntent *find_mount_point(const char *name, const char *table);
Eric Andersenf6b71392000-09-26 01:09:18 +0000137extern void write_mtab(char* blockDevice, char* directory,
138 char* filesystemType, long flags, char* string_flags);
139extern void erase_mtab(const char * name);
140extern void mtab_read(void);
141extern char *mtab_first(void **iter);
142extern char *mtab_next(void **iter);
143extern char *mtab_getinfo(const char *match, const char which);
144extern int check_wildcard_match(const char* text, const char* pattern);
Mark Whitleyf57c9442000-12-07 19:56:48 +0000145extern long atoi_w_units (const char *cp);
146extern pid_t* find_pid_by_name( char* pidName);
Eric Andersenf6b71392000-09-26 01:09:18 +0000147extern int find_real_root_device_name(char* name);
148extern char *get_line_from_file(FILE *file);
149extern void print_file(FILE *file);
150extern int print_file_by_name(char *filename);
151extern char process_escape_sequence(char **ptr);
152extern char *get_last_path_component(char *path);
Matt Kraaic0321f92000-09-27 04:09:22 +0000153extern FILE *wfopen(const char *path, const char *mode);
Matt Kraaie0bcce02000-09-27 02:29:39 +0000154extern FILE *xfopen(const char *path, const char *mode);
Matt Kraai05e782d2001-02-01 16:49:30 +0000155extern void chomp(char *s);
Eric Andersenf6b71392000-09-26 01:09:18 +0000156
Eric Andersen01bda5d2001-01-02 01:16:38 +0000157#ifndef DMALLOC
Eric Andersenf6b71392000-09-26 01:09:18 +0000158extern void *xmalloc (size_t size);
159extern void *xrealloc(void *old, size_t size);
160extern void *xcalloc(size_t nmemb, size_t size);
161extern char *xstrdup (const char *s);
162#endif
163extern char *xstrndup (const char *s, int n);
164
Matt Kraai24ac0172000-12-18 21:38:57 +0000165struct suffix_mult {
166 char *suffix;
167 int mult;
168};
169
170extern unsigned long parse_number(const char *numstr, struct suffix_mult *suffixes);
171
Eric Andersenf6b71392000-09-26 01:09:18 +0000172
173/* These parse entries in /etc/passwd and /etc/group. This is desirable
174 * for BusyBox since we want to avoid using the glibc NSS stuff, which
175 * increases target size and is often not needed embedded systems. */
176extern long my_getpwnam(char *name);
177extern long my_getgrnam(char *name);
178extern void my_getpwuid(char *name, long uid);
179extern void my_getgrgid(char *group, long gid);
180extern long my_getpwnamegid(char *name);
181
182extern int device_open(char *device, int mode);
183
184#if defined BB_FEATURE_MOUNT_LOOP
185extern int del_loop(const char *device);
186extern int set_loop(const char *device, const char *file, int offset, int *loopro);
187extern char *find_unused_loop_device (void);
188#endif
189
190
191#if (__GLIBC__ < 2) && (defined BB_SYSLOGD || defined BB_INIT)
192extern int vdprintf(int d, const char *format, va_list ap);
193#endif
194
195#if defined BB_NFSMOUNT
196int nfsmount(const char *spec, const char *node, int *flags,
197 char **extra_opts, char **mount_opts, int running_bg);
198#endif
199
200#ifndef RB_POWER_OFF
201/* Stop system and switch power off if possible. */
202#define RB_POWER_OFF 0x4321fedc
203#endif
204
205/* Include our own copy of struct sysinfo to avoid binary compatability
206 * problems with Linux 2.4, which changed things. Grumble, grumble. */
207struct sysinfo {
208 long uptime; /* Seconds since boot */
209 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
210 unsigned long totalram; /* Total usable main memory size */
211 unsigned long freeram; /* Available memory size */
212 unsigned long sharedram; /* Amount of shared memory */
213 unsigned long bufferram; /* Memory used by buffers */
214 unsigned long totalswap; /* Total swap space size */
215 unsigned long freeswap; /* swap space still available */
216 unsigned short procs; /* Number of current processes */
217 unsigned long totalhigh; /* Total high memory size */
218 unsigned long freehigh; /* Available high memory size */
219 unsigned int mem_unit; /* Memory unit size in bytes */
220 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
221};
222extern int sysinfo (struct sysinfo* info);
223
224/* Bit map related macros -- libc5 doens't provide these... sigh. */
225#ifndef setbit
226#define NBBY CHAR_BIT
227#define setbit(a,i) ((a)[(i)/NBBY] |= 1<<((i)%NBBY))
228#define clrbit(a,i) ((a)[(i)/NBBY] &= ~(1<<((i)%NBBY)))
229#define isset(a,i) ((a)[(i)/NBBY] & (1<<((i)%NBBY)))
230#define isclr(a,i) (((a)[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
231#endif
232
Richard June6d0921c2001-01-22 22:35:38 +0000233#ifdef BB_FEATURE_HUMAN_READABLE
234char *format(unsigned long val, unsigned long hr);
235#define KILOBYTE 1024
236#define MEGABYTE (KILOBYTE*1024)
237#define GIGABYTE (MEGABYTE*1024)
238#endif
239
Eric Andersend35c2152001-01-25 23:49:09 +0000240#ifdef BB_FEATURE_BUFFERS_GO_ON_STACK
241#define RESERVE_BB_BUFFER(buffer,len) char buffer[len]
242#define RESERVE_BB_UBUFFER(buffer,len) unsigned char buffer[len]
243#else
244#define RESERVE_BB_BUFFER(buffer,len) char *buffer=xmalloc(len)
245#define RESERVE_BB_UBUFFER(buffer,len) unsigned char *buffer=xmalloc(len)
246#endif
247
Eric Andersenf6b71392000-09-26 01:09:18 +0000248#endif /* _BB_INTERNAL_H_ */