3e0a5ab33fe968fb53705608238eebc6b03c4b8a
[oweals/opkg-lede.git] / libbb / libbb.h
1 /* vi: set sw=4 ts=4: */
2 /*
3  * Busybox main internal header file
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  */
19
20 #ifndef __LIBBB_H__
21 #define __LIBBB_H__    1
22
23 #include <stdio.h>
24 #include <stdarg.h>
25 #include <sys/stat.h>
26 #include <sys/types.h>
27
28 #include <netdb.h>
29
30 // Include because of single use with opkg
31 #define _BB_INTERNAL_H_
32 #define L_archive_offset
33 #define L_get_header_ar
34 #define L_free_header_tar
35 #define L_get_header_tar
36 #define L_unarchive
37 #define L_seek_sub_file
38 #define L_memory_exhausted
39 #define L_deb_extract
40 #define L_extract_archive
41 #define L_parse_mode
42 #define L_time_string
43 #define L_mode_string
44
45 #ifndef _BB_INTERNAL_H_
46 #include "../busybox.h"
47 #endif
48
49 #ifdef DMALLOC
50 #include "dmalloc.h"
51 #endif
52
53 #include <features.h>
54
55 #if (__GNU_LIBRARY__ < 5) && (!defined __dietlibc__)
56 /* libc5 doesn't define socklen_t */
57 typedef unsigned int socklen_t;
58 /* libc5 doesn't implement BSD 4.4 daemon() */
59 extern int daemon (int nochdir, int noclose);
60 /* libc5 doesn't implement strtok_r */
61 char *strtok_r(char *s, const char *delim, char **ptrptr);
62 #endif  
63
64 /* Some useful definitions */
65 #define FALSE   ((int) 0)
66 #define TRUE    ((int) 1)
67 #define SKIP    ((int) 2)
68
69 /* for mtab.c */
70 #define MTAB_GETMOUNTPT '1'
71 #define MTAB_GETDEVICE  '2'
72
73 #define BUF_SIZE        8192
74 #define EXPAND_ALLOC    1024
75
76 static inline int is_decimal(int ch) { return ((ch >= '0') && (ch <= '9')); }
77 static inline int is_octal(int ch)   { return ((ch >= '0') && (ch <= '7')); }
78
79 /* Macros for min/max.  */
80 #ifndef MIN
81 #define MIN(a,b) (((a)<(b))?(a):(b))
82 #endif
83
84 #ifndef MAX
85 #define MAX(a,b) (((a)>(b))?(a):(b))
86 #endif
87
88
89
90 extern void show_usage(void) __attribute__ ((noreturn));
91 extern void error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
92 extern void error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
93 extern void perror_msg(const char *s, ...);
94 extern void perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn));
95 extern void vherror_msg(const char *s, va_list p);
96 extern void herror_msg(const char *s, ...);
97 extern void herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn));
98 extern void archive_xread_all(int fd, char *buf, size_t count);
99
100 /* These two are used internally -- you shouldn't need to use them */
101 extern void verror_msg(const char *s, va_list p);
102 extern void vperror_msg(const char *s, va_list p);
103
104 const char *mode_string(int mode);
105 const char *time_string(time_t timeVal);
106 int is_directory(const char *name, int followLinks, struct stat *statBuf);
107 int isDevice(const char *name);
108
109 int remove_file(const char *path, int flags);
110 int copy_file(const char *source, const char *dest, int flags);
111 int copy_file_chunk(FILE *src_file, FILE *dst_file, unsigned long long chunksize);
112 char *buildName(const char *dirName, const char *fileName);
113 int makeString(int argc, const char **argv, char *buf, int bufLen);
114 char *getChunk(int size);
115 char *chunkstrdup(const char *str);
116 void freeChunks(void);
117 ssize_t safe_read(int fd, void *buf, size_t count);
118 ssize_t full_write(int fd, const char *buf, int len);
119 ssize_t full_read(int fd, char *buf, int len);
120 int recursive_action(const char *fileName, int recurse, int followLinks, int depthFirst,
121           int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData),
122           int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData),
123           void* userData);
124
125 extern int parse_mode( const char* s, mode_t* theMode);
126
127 extern int get_kernel_revision(void);
128
129 extern int get_console_fd(char* tty_name);
130 extern struct mntent *find_mount_point(const char *name, const char *table);
131 extern void write_mtab(char* blockDevice, char* directory, 
132         char* filesystemType, long flags, char* string_flags);
133 extern void erase_mtab(const char * name);
134 extern long atoi_w_units (const char *cp);
135 extern long* find_pid_by_name( char* pidName);
136 extern char *find_real_root_device_name(const char* name);
137 extern char *get_line_from_file(FILE *file);
138 extern void print_file(FILE *file);
139 extern int copyfd(int fd1, int fd2);
140 extern int print_file_by_name(char *filename);
141 extern char process_escape_sequence(const char **ptr);
142 extern char *get_last_path_component(char *path);
143 extern FILE *wfopen(const char *path, const char *mode);
144 extern FILE *xfopen(const char *path, const char *mode);
145 extern void chomp(char *s);
146 extern struct BB_applet *find_applet_by_name(const char *name);
147 void run_applet_by_name(const char *name, int argc, char **argv);
148
149 #ifndef DMALLOC
150 extern void *xmalloc (size_t size);
151 extern void *xrealloc(void *old, size_t size);
152 extern void *xcalloc(size_t nmemb, size_t size);
153 extern char *xstrdup (const char *s);
154 #endif
155 extern char *xstrndup (const char *s, int n);
156 extern char * safe_strncpy(char *dst, const char *src, size_t size);
157
158 struct suffix_mult {
159         const char *suffix;
160         int mult;
161 };
162
163 extern unsigned long parse_number(const char *numstr,
164                 const struct suffix_mult *suffixes);
165
166
167 /* These parse entries in /etc/passwd and /etc/group.  This is desirable
168  * for BusyBox since we want to avoid using the glibc NSS stuff, which
169  * increases target size and is often not needed embedded systems.  */
170 extern long my_getpwnam(const char *name);
171 extern long my_getgrnam(const char *name);
172 extern void my_getpwuid(char *name, long uid);
173 extern void my_getgrgid(char *group, long gid);
174 extern long my_getpwnamegid(const char *name);
175
176 extern int device_open(char *device, int mode);
177
178 extern int del_loop(const char *device);
179 extern int set_loop(const char *device, const char *file, int offset, int *loopro);
180 extern char *find_unused_loop_device (void);
181
182
183 #if (__GLIBC__ < 2)
184 extern int vdprintf(int d, const char *format, va_list ap);
185 #endif
186
187 int nfsmount(const char *spec, const char *node, int *flags,
188              char **extra_opts, char **mount_opts, int running_bg);
189
190 void syslog_msg_with_name(const char *name, int facility, int pri, const char *msg);
191 void syslog_msg(int facility, int pri, const char *msg);
192
193 /* Include our own copy of struct sysinfo to avoid binary compatability
194  * problems with Linux 2.4, which changed things.  Grumble, grumble. */
195 struct sysinfo {
196         long uptime;                    /* Seconds since boot */
197         unsigned long loads[3];         /* 1, 5, and 15 minute load averages */
198         unsigned long totalram;         /* Total usable main memory size */
199         unsigned long freeram;          /* Available memory size */
200         unsigned long sharedram;        /* Amount of shared memory */
201         unsigned long bufferram;        /* Memory used by buffers */
202         unsigned long totalswap;        /* Total swap space size */
203         unsigned long freeswap;         /* swap space still available */
204         unsigned short procs;           /* Number of current processes */
205         unsigned short pad;                     /* Padding needed for m68k */
206         unsigned long totalhigh;        /* Total high memory size */
207         unsigned long freehigh;         /* Available high memory size */
208         unsigned int mem_unit;          /* Memory unit size in bytes */
209         char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
210 };
211 extern int sysinfo (struct sysinfo* info);
212
213 enum {
214         KILOBYTE = 1024,
215         MEGABYTE = (KILOBYTE*1024),
216         GIGABYTE = (MEGABYTE*1024)
217 };
218 const char *make_human_readable_str(unsigned long size, unsigned long block_size, unsigned long display_unit);
219
220 int klogctl(int type, char * b, int len);
221
222 char *xgetcwd(char *cwd);
223 char *xreadlink(const char *path);
224 char *concat_path_file(const char *path, const char *filename);
225 char *last_char_is(const char *s, int c);
226
227 extern long arith (const char *startbuf, int *errcode);
228
229 typedef struct file_headers_s {
230         char *name;
231         char *link_name;
232         off_t size;
233         uid_t uid;
234         gid_t gid;
235         mode_t mode;
236         time_t mtime;
237         dev_t device;
238 } file_header_t;
239 file_header_t *get_header_ar(FILE *in_file);
240 void free_header_ar(file_header_t *ar_entry);
241 file_header_t *get_header_tar(FILE *tar_stream);
242 void free_header_tar(file_header_t *tar_entry);
243
244 enum extract_functions_e {
245         extract_verbose_list = 1,
246         extract_list = 2,
247         extract_one_to_buffer = 4,
248         extract_to_stdout = 8,
249         extract_all_to_fs = 16,
250         extract_preserve_date = 32,
251         extract_data_tar_gz = 64,
252         extract_control_tar_gz = 128,
253         extract_unzip_only = 256,
254         extract_unconditional = 512,
255         extract_create_leading_dirs = 1024,
256         extract_quiet = 2048,
257         extract_exclude_list = 4096
258 };
259 char *deb_extract(const char *package_filename, FILE *out_stream, const int extract_function,
260         const char *prefix, const char *filename);
261 int read_package_field(const char *package_buffer, char **field_name, char **field_value);
262 char *fgets_str(FILE *file, const char *terminating_string);
263
264 extern int unzip(FILE *l_in_file, FILE *l_out_file);
265 extern void gz_close(int gunzip_pid);
266 extern FILE *gz_open(FILE *compressed_file, int *pid);
267
268 extern struct hostent *xgethostbyname(const char *name);
269 extern int create_icmp_socket(void);
270
271 char *dirname (char *path);
272
273 int make_directory (const char *path, long mode, int flags);
274
275 const char *u_signal_names(const char *str_sig, int *signo, int startnum);
276 char *simplify_path(const char *path);
277
278 #define CT_AUTO 0
279 #define CT_UNIX2DOS     1
280 #define CT_DOS2UNIX     2
281 /* extern int convert(char *fn, int ConvType); */
282
283 enum {
284         FILEUTILS_PRESERVE_STATUS = 1,
285         FILEUTILS_PRESERVE_SYMLINKS = 2,
286         FILEUTILS_RECUR = 4,
287         FILEUTILS_FORCE = 8,
288 };
289
290 extern const char *applet_name;
291 extern const char * const full_version;
292 extern const char * const name_too_long;
293 extern const char * const omitting_directory;
294 extern const char * const not_a_directory;
295 extern const char * const memory_exhausted;
296 extern const char * const invalid_date;
297 extern const char * const invalid_option;
298 extern const char * const io_error;
299 extern const char * const dash_dash_help;
300 extern const char * const write_error;
301 extern const char * const too_few_args;
302 extern const char * const name_longer_than_foo;
303 extern const char * const unknown;
304 extern const char * const can_not_create_raw_socket;
305
306 #ifdef BB_FEATURE_DEVFS
307 # define CURRENT_VC "/dev/vc/0"
308 # define VC_1 "/dev/vc/1"
309 # define VC_2 "/dev/vc/2"
310 # define VC_3 "/dev/vc/3"
311 # define VC_4 "/dev/vc/4"
312 # define VC_5 "/dev/vc/5"
313 # define SC_0 "/dev/tts/0"
314 # define SC_1 "/dev/tts/1"
315 # define VC_FORMAT "/dev/vc/%d"
316 # define SC_FORMAT "/dev/tts/%d"
317 # define LOOP_FORMAT "/dev/loop/%d"
318 #else
319 # define CURRENT_VC "/dev/tty0"
320 # define VC_1 "/dev/tty1"
321 # define VC_2 "/dev/tty2"
322 # define VC_3 "/dev/tty3"
323 # define VC_4 "/dev/tty4"
324 # define VC_5 "/dev/tty5"
325 # define SC_0 "/dev/ttyS0"
326 # define SC_1 "/dev/ttyS1"
327 # define VC_FORMAT "/dev/tty%d"
328 # define SC_FORMAT "/dev/ttyS%d"
329 # define LOOP_FORMAT "/dev/loop%d"
330 #endif
331
332 /* The following devices are the same on devfs and non-devfs systems.  */
333 #define CURRENT_TTY "/dev/tty"
334 #define CONSOLE_DEV "/dev/console"
335
336 /* Cope with mmu-less systems somewhat gracefully */
337 #if defined(__UCLIBC__) && !defined(__ARCH_HAS_MMU__)
338 #define fork    vfork
339 #endif
340
341 #endif /* __LIBBB_H__ */