blob: d9362b58b6103df8212277a356577b93542223bc [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;
Eric Andersenf6b71392000-09-26 01:09:18 +000075};
76/* From busybox.c */
77extern const struct BB_applet applets[];
78
Eric Andersen8c725e62000-11-30 00:27:06 +000079/* Automagically pull in all the applet function prototypes and
Eric Andersen87559822000-12-01 19:02:24 +000080 * applet usage strings. These are all of the form:
Eric Andersen8c725e62000-11-30 00:27:06 +000081 * extern int foo_main(int argc, char **argv);
82 * extern const char foo_usage[];
83 * These are all autogenerated from the set of currently defined applets.
84 */
85#define PROTOTYPES
86#include "applets.h"
87#undef PROTOTYPES
Eric Andersenf6b71392000-09-26 01:09:18 +000088
89extern const char *applet_name;
90
Eric Andersen67991cf2001-02-14 21:23:06 +000091extern void show_usage(void) __attribute__ ((noreturn));
Eric Andersenc163e512001-02-22 23:38:48 +000092extern void error_msg(const char *s, ...);
93extern void error_msg_and_die(const char *s, ...) __attribute__ ((noreturn));
94extern void perror_msg(const char *s, ...);
95extern void perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn));
Eric Andersenf6b71392000-09-26 01:09:18 +000096
Mark Whitleyf57c9442000-12-07 19:56:48 +000097const char *mode_string(int mode);
98const char *time_string(time_t timeVal);
99int is_directory(const char *name, const int followLinks, struct stat *statBuf);
Eric Andersenf6b71392000-09-26 01:09:18 +0000100int isDevice(const char *name);
101
102typedef struct ino_dev_hash_bucket_struct {
103 struct ino_dev_hash_bucket_struct *next;
104 ino_t ino;
105 dev_t dev;
106 char name[1];
107} ino_dev_hashtable_bucket_t;
108int is_in_ino_dev_hashtable(const struct stat *statbuf, char **name);
109void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
110void reset_ino_dev_hashtable(void);
111
Mark Whitleyf57c9442000-12-07 19:56:48 +0000112int copy_file(const char *srcName, const char *destName,
Eric Andersenf6b71392000-09-26 01:09:18 +0000113 int setModes, int followLinks, int forceFlag);
Mark Whitley47583682000-12-05 20:03:17 +0000114int copy_file_chunk(int srcFd, int dstFd, size_t remaining);
Eric Andersenf6b71392000-09-26 01:09:18 +0000115char *buildName(const char *dirName, const char *fileName);
116int makeString(int argc, const char **argv, char *buf, int bufLen);
117char *getChunk(int size);
118char *chunkstrdup(const char *str);
119void freeChunks(void);
Matt Kraaibfa79672000-12-15 22:34:34 +0000120ssize_t safe_read(int fd, void *buf, size_t count);
Mark Whitleyf57c9442000-12-07 19:56:48 +0000121int full_write(int fd, const char *buf, int len);
122int full_read(int fd, char *buf, int len);
123int recursive_action(const char *fileName, int recurse, int followLinks, int depthFirst,
Eric Andersenf6b71392000-09-26 01:09:18 +0000124 int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData),
125 int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData),
126 void* userData);
127
Mark Whitleyf57c9442000-12-07 19:56:48 +0000128extern int create_path (const char *name, int mode);
Eric Andersenf6b71392000-09-26 01:09:18 +0000129extern int parse_mode( const char* s, mode_t* theMode);
130
131extern int get_kernel_revision(void);
132
133extern int get_console_fd(char* tty_name);
Mark Whitleyf57c9442000-12-07 19:56:48 +0000134extern struct mntent *find_mount_point(const char *name, const char *table);
Eric Andersenf6b71392000-09-26 01:09:18 +0000135extern void write_mtab(char* blockDevice, char* directory,
136 char* filesystemType, long flags, char* string_flags);
137extern void erase_mtab(const char * name);
138extern void mtab_read(void);
139extern char *mtab_first(void **iter);
140extern char *mtab_next(void **iter);
141extern char *mtab_getinfo(const char *match, const char which);
142extern int check_wildcard_match(const char* text, const char* pattern);
Mark Whitleyf57c9442000-12-07 19:56:48 +0000143extern long atoi_w_units (const char *cp);
144extern pid_t* find_pid_by_name( char* pidName);
Eric Andersenf6b71392000-09-26 01:09:18 +0000145extern int find_real_root_device_name(char* name);
146extern char *get_line_from_file(FILE *file);
147extern void print_file(FILE *file);
148extern int print_file_by_name(char *filename);
149extern char process_escape_sequence(char **ptr);
150extern char *get_last_path_component(char *path);
Matt Kraaic0321f92000-09-27 04:09:22 +0000151extern FILE *wfopen(const char *path, const char *mode);
Matt Kraaie0bcce02000-09-27 02:29:39 +0000152extern FILE *xfopen(const char *path, const char *mode);
Matt Kraai05e782d2001-02-01 16:49:30 +0000153extern void chomp(char *s);
Eric Andersen13d1fa12001-03-08 23:59:45 +0000154extern void trim(char *s);
Matt Kraaif2cc2762001-02-01 19:21:20 +0000155extern struct BB_applet *find_applet_by_name(const char *name);
Eric Andersen67991cf2001-02-14 21:23:06 +0000156void run_applet_by_name(const char *name, int argc, char **argv);
Eric Andersenf6b71392000-09-26 01:09:18 +0000157
Eric Andersen01bda5d2001-01-02 01:16:38 +0000158#ifndef DMALLOC
Eric Andersenf6b71392000-09-26 01:09:18 +0000159extern void *xmalloc (size_t size);
160extern void *xrealloc(void *old, size_t size);
161extern void *xcalloc(size_t nmemb, size_t size);
162extern char *xstrdup (const char *s);
163#endif
164extern char *xstrndup (const char *s, int n);
Eric Andersenec455952001-02-14 08:11:27 +0000165extern char * safe_strncpy(char *dst, const char *src, size_t size);
Eric Andersenf6b71392000-09-26 01:09:18 +0000166
Matt Kraai24ac0172000-12-18 21:38:57 +0000167struct suffix_mult {
168 char *suffix;
169 int mult;
170};
171
Matt Kraaia164c642001-02-05 17:50:03 +0000172extern unsigned long parse_number(const char *numstr,
173 const struct suffix_mult *suffixes);
Matt Kraai24ac0172000-12-18 21:38:57 +0000174
Eric Andersenf6b71392000-09-26 01:09:18 +0000175
176/* These parse entries in /etc/passwd and /etc/group. This is desirable
177 * for BusyBox since we want to avoid using the glibc NSS stuff, which
178 * increases target size and is often not needed embedded systems. */
Eric Andersen4142d4d2001-02-27 18:22:03 +0000179extern long my_getpwnam(const char *name);
180extern long my_getgrnam(const char *name);
Eric Andersenf6b71392000-09-26 01:09:18 +0000181extern void my_getpwuid(char *name, long uid);
182extern void my_getgrgid(char *group, long gid);
Eric Andersen4142d4d2001-02-27 18:22:03 +0000183extern long my_getpwnamegid(const char *name);
Eric Andersenf6b71392000-09-26 01:09:18 +0000184
185extern int device_open(char *device, int mode);
186
187#if defined BB_FEATURE_MOUNT_LOOP
188extern int del_loop(const char *device);
189extern int set_loop(const char *device, const char *file, int offset, int *loopro);
190extern char *find_unused_loop_device (void);
191#endif
192
193
194#if (__GLIBC__ < 2) && (defined BB_SYSLOGD || defined BB_INIT)
195extern int vdprintf(int d, const char *format, va_list ap);
196#endif
197
198#if defined BB_NFSMOUNT
199int nfsmount(const char *spec, const char *node, int *flags,
200 char **extra_opts, char **mount_opts, int running_bg);
201#endif
202
203#ifndef RB_POWER_OFF
204/* Stop system and switch power off if possible. */
205#define RB_POWER_OFF 0x4321fedc
206#endif
207
208/* Include our own copy of struct sysinfo to avoid binary compatability
209 * problems with Linux 2.4, which changed things. Grumble, grumble. */
210struct sysinfo {
211 long uptime; /* Seconds since boot */
212 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
213 unsigned long totalram; /* Total usable main memory size */
214 unsigned long freeram; /* Available memory size */
215 unsigned long sharedram; /* Amount of shared memory */
216 unsigned long bufferram; /* Memory used by buffers */
217 unsigned long totalswap; /* Total swap space size */
218 unsigned long freeswap; /* swap space still available */
219 unsigned short procs; /* Number of current processes */
220 unsigned long totalhigh; /* Total high memory size */
221 unsigned long freehigh; /* Available high memory size */
222 unsigned int mem_unit; /* Memory unit size in bytes */
223 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
224};
225extern int sysinfo (struct sysinfo* info);
226
227/* Bit map related macros -- libc5 doens't provide these... sigh. */
228#ifndef setbit
229#define NBBY CHAR_BIT
230#define setbit(a,i) ((a)[(i)/NBBY] |= 1<<((i)%NBBY))
231#define clrbit(a,i) ((a)[(i)/NBBY] &= ~(1<<((i)%NBBY)))
232#define isset(a,i) ((a)[(i)/NBBY] & (1<<((i)%NBBY)))
233#define isclr(a,i) (((a)[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
234#endif
235
Richard June6d0921c2001-01-22 22:35:38 +0000236#ifdef BB_FEATURE_HUMAN_READABLE
Mark Whitleyae5612c2001-03-07 17:42:07 +0000237const char *make_human_readable_str(unsigned long val, unsigned long hr);
Mark Whitley39842de2001-03-01 18:51:33 +0000238#endif
Mark Whitley4cc8f312001-03-07 18:00:44 +0000239enum {
240 KILOBYTE = 1024,
241 MEGABYTE = (KILOBYTE*1024),
242 GIGABYTE = (MEGABYTE*1024)
243};
Richard June6d0921c2001-01-22 22:35:38 +0000244
Eric Andersend35c2152001-01-25 23:49:09 +0000245#ifdef BB_FEATURE_BUFFERS_GO_ON_STACK
246#define RESERVE_BB_BUFFER(buffer,len) char buffer[len]
247#define RESERVE_BB_UBUFFER(buffer,len) unsigned char buffer[len]
248#else
249#define RESERVE_BB_BUFFER(buffer,len) char *buffer=xmalloc(len)
250#define RESERVE_BB_UBUFFER(buffer,len) unsigned char *buffer=xmalloc(len)
251#endif
252
Eric Andersenf6b71392000-09-26 01:09:18 +0000253#endif /* _BB_INTERNAL_H_ */