Add a RELEASE_BB_BUFFER macro and use it to fix a memory leak in syslogd.c
[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 "Config.h"
28
29 #include <stdio.h>
30 #include <stdarg.h>
31 #include <sys/stat.h>
32 #include <sys/types.h>
33
34 #define BB_BANNER "BusyBox v" BB_VER " (" BB_BT ")"
35
36 #ifdef DMALLOC
37 #include "dmalloc.h"
38 #endif
39
40 #include <features.h>
41
42
43 enum Location {
44         _BB_DIR_ROOT = 0,
45         _BB_DIR_BIN,
46         _BB_DIR_SBIN,
47         _BB_DIR_USR_BIN,
48         _BB_DIR_USR_SBIN
49 };
50
51 struct BB_applet {
52         const   char*   name;
53         int     (*main)(int argc, char** argv);
54         enum    Location        location;
55 };
56 /* From busybox.c */
57 extern const struct BB_applet applets[];
58
59 /* Automagically pull in all the applet function prototypes and
60  * applet usage strings.  These are all of the form:
61  *              extern int foo_main(int argc, char **argv);
62  *              extern const char foo_usage[];
63  * These are all autogenerated from the set of currently defined applets. 
64  */
65 #define PROTOTYPES
66 #include "applets.h"
67 #undef PROTOTYPES
68
69 #ifdef BB_FEATURE_BUFFERS_GO_ON_STACK
70 #define RESERVE_BB_BUFFER(buffer,len)           char buffer[len]
71 #define RESERVE_BB_UBUFFER(buffer,len) unsigned char buffer[len]
72 #define RELEASE_BB_BUFFER(buffer)      ((void)0)
73 #else
74 #ifdef BB_FEATURE_BUFFERS_GO_IN_BSS
75 #define RESERVE_BB_BUFFER(buffer,len)  static          char buffer[len]
76 #define RESERVE_BB_UBUFFER(buffer,len) static unsigned char buffer[len]
77 #define RELEASE_BB_BUFFER(buffer)      ((void)0)
78 #else
79 #define RESERVE_BB_BUFFER(buffer,len)           char *buffer=xmalloc(len)
80 #define RESERVE_BB_UBUFFER(buffer,len) unsigned char *buffer=xmalloc(len)
81 #define RELEASE_BB_BUFFER(buffer)      free (buffer)
82 #endif
83 #endif
84
85
86 /* Bit map related macros -- libc5 doens't provide these... sigh.  */
87 #ifndef setbit
88 #define NBBY            CHAR_BIT
89 #define setbit(a,i)     ((a)[(i)/NBBY] |= 1<<((i)%NBBY))
90 #define clrbit(a,i)     ((a)[(i)/NBBY] &= ~(1<<((i)%NBBY)))
91 #define isset(a,i)      ((a)[(i)/NBBY] & (1<<((i)%NBBY)))
92 #define isclr(a,i)      (((a)[(i)/NBBY] & (1<<((i)%NBBY))) == 0)
93 #endif
94
95 #ifndef RB_POWER_OFF
96 /* Stop system and switch power off if possible.  */
97 #define RB_POWER_OFF   0x4321fedc
98 #endif
99
100
101 /* Pull in the utility routines from libbb */
102 #include "libbb/libbb.h"
103
104
105
106 #endif /* _BB_INTERNAL_H_ */