- make sure to include dmalloc.h at the very end of busybox.h or libbb.h.
[oweals/busybox.git] / include / busybox.h
1 /* 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 "bb_config.h"
28
29 #include <stdio.h>
30 #include <stdlib.h>
31 #include <stdarg.h>
32 #include <sys/stat.h>
33 #include <sys/types.h>
34
35 #if __GNU_LIBRARY__ < 5 && \
36     !defined(__dietlibc__) && \
37     !defined(_NEWLIB_VERSION)
38 #error "Sorry, this libc version is not supported :("
39 #endif
40
41 #ifndef BB_EXTRA_VERSION
42 #define BB_BANNER "BusyBox v" BB_VER " (" BB_BT ")"
43 #else
44 #define BB_BANNER "BusyBox v" BB_VER " (" BB_EXTRA_VERSION ")"
45 #endif
46
47 #include <features.h>
48
49 /* Pull in the utility routines from libbb */
50 #include "libbb.h"
51
52 enum Location {
53         _BB_DIR_ROOT = 0,
54         _BB_DIR_BIN,
55         _BB_DIR_SBIN,
56         _BB_DIR_USR_BIN,
57         _BB_DIR_USR_SBIN
58 };
59
60 enum SUIDRoot {
61         _BB_SUID_NEVER = 0,
62         _BB_SUID_MAYBE,
63         _BB_SUID_ALWAYS
64 };
65
66 struct BB_applet {
67         const char *name;
68         int (*main) (int argc, char **argv);
69         enum Location location:4;
70         enum SUIDRoot need_suid:4;
71 };
72
73 /* From busybox.c */
74 extern const struct BB_applet applets[];
75
76 /* Automagically pull in all the applet function prototypes and
77  * applet usage strings.  These are all of the form:
78  *              extern int foo_main(int argc, char **argv);
79  *              extern const char foo_usage[];
80  * These are all autogenerated from the set of currently defined applets.
81  */
82 #define PROTOTYPES
83 #include "applets.h"
84 #undef PROTOTYPES
85
86 #ifdef CONFIG_FEATURE_BUFFERS_GO_ON_STACK
87 #define RESERVE_CONFIG_BUFFER(buffer,len)           char buffer[len]
88 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
89 #define RELEASE_CONFIG_BUFFER(buffer)      ((void)0)
90 #else
91 #ifdef CONFIG_FEATURE_BUFFERS_GO_IN_BSS
92 #define RESERVE_CONFIG_BUFFER(buffer,len)  static          char buffer[len]
93 #define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
94 #define RELEASE_CONFIG_BUFFER(buffer)      ((void)0)
95 #else
96 #define RESERVE_CONFIG_BUFFER(buffer,len)           char *buffer=xmalloc(len)
97 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer=xmalloc(len)
98 #define RELEASE_CONFIG_BUFFER(buffer)      free (buffer)
99 #endif
100 #endif
101
102
103 #ifndef RB_POWER_OFF
104 /* Stop system and switch power off if possible.  */
105 #define RB_POWER_OFF   0x4321fedc
106 #endif
107
108 /* Try to pull in PATH_MAX */
109 #include <limits.h>
110
111 /* for PATH_MAX on systems that don't have it in limits.h */
112 #include <sys/param.h>
113 #ifndef PATH_MAX
114 #define  PATH_MAX         256
115 #endif
116
117 #ifdef DMALLOC
118 #include <dmalloc.h>
119 #endif
120
121 #endif                                                  /* _BB_INTERNAL_H_ */