blob: d2f9a95675bf1133e9a617a4c2a465620b671987 [file] [log] [blame]
Eric Andersenaad1a882001-03-16 22:47:14 +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 __LIBBB_H__
25#define __LIBBB_H__ 1
26
27#include <stdio.h>
28#include <stdarg.h>
29#include <sys/stat.h>
30#include <sys/types.h>
31
32#ifdef DMALLOC
33#include "dmalloc.h"
34#endif
35
36#include <features.h>
Eric Andersenb6b519b2001-04-09 23:52:18 +000037
Mark Whitleyc29c44c2001-04-25 18:06:21 +000038#ifndef _BB_INTERNAL_H_
39#include "../busybox.h"
40#endif
41
Eric Andersenb6b519b2001-04-09 23:52:18 +000042#if __GNU_LIBRARY__ < 5
Eric Andersenaad1a882001-03-16 22:47:14 +000043/* libc5 doesn't define socklen_t */
44typedef unsigned int socklen_t;
Eric Andersenb2e3e9b2001-04-04 19:25:57 +000045/* libc5 doesn't implement BSD 4.4 daemon() */
46extern int daemon (int nochdir, int noclose);
Eric Andersenaad1a882001-03-16 22:47:14 +000047#endif
48
49/* Some useful definitions */
50#define FALSE ((int) 0)
51#define TRUE ((int) 1)
52#define SKIP ((int) 2)
53
54/* for mtab.c */
55#define MTAB_GETMOUNTPT '1'
56#define MTAB_GETDEVICE '2'
57
58#define BUF_SIZE 8192
59#define EXPAND_ALLOC 1024
60
Eric Andersenb5ec61e2001-04-18 20:17:05 +000061static inline int is_decimal(int ch) { return ((ch >= '0') && (ch <= '9')); }
62static inline int is_octal(int ch) { return ((ch >= '0') && (ch <= '7')); }
Eric Andersenaad1a882001-03-16 22:47:14 +000063
64/* Macros for min/max. */
65#ifndef MIN
66#define MIN(a,b) (((a)<(b))?(a):(b))
67#endif
68
69#ifndef MAX
70#define MAX(a,b) (((a)>(b))?(a):(b))
71#endif
72
73
74
75extern void show_usage(void) __attribute__ ((noreturn));
Eric Andersenb183dfa2001-03-19 19:24:06 +000076extern void error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
77extern void error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
Eric Andersenaad1a882001-03-16 22:47:14 +000078extern void perror_msg(const char *s, ...);
79extern void perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn));
80
Eric Andersenb183dfa2001-03-19 19:24:06 +000081/* These two are used internally -- you shouldn't need to use them */
82extern void verror_msg(const char *s, va_list p);
83extern void vperror_msg(const char *s, va_list p);
84
Eric Andersenaad1a882001-03-16 22:47:14 +000085const char *mode_string(int mode);
86const char *time_string(time_t timeVal);
87int is_directory(const char *name, const int followLinks, struct stat *statBuf);
88int isDevice(const char *name);
89
90typedef struct ino_dev_hash_bucket_struct {
91 struct ino_dev_hash_bucket_struct *next;
92 ino_t ino;
93 dev_t dev;
94 char name[1];
95} ino_dev_hashtable_bucket_t;
96int is_in_ino_dev_hashtable(const struct stat *statbuf, char **name);
97void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
98void reset_ino_dev_hashtable(void);
99
Matt Kraai8810bdb2001-04-24 20:04:18 +0000100int remove_file(const char *path, int flags);
Matt Kraai91b28552001-04-23 18:53:07 +0000101int copy_file(const char *source, const char *dest, int flags);
Glenn L McGrathc9cac5b2001-04-12 13:47:12 +0000102int copy_file_chunk(FILE *src_file, FILE *dst_file, unsigned long long chunksize);
Eric Andersenaad1a882001-03-16 22:47:14 +0000103char *buildName(const char *dirName, const char *fileName);
104int makeString(int argc, const char **argv, char *buf, int bufLen);
105char *getChunk(int size);
106char *chunkstrdup(const char *str);
107void freeChunks(void);
108ssize_t safe_read(int fd, void *buf, size_t count);
109int full_write(int fd, const char *buf, int len);
110int full_read(int fd, char *buf, int len);
111int recursive_action(const char *fileName, int recurse, int followLinks, int depthFirst,
112 int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData),
113 int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData),
114 void* userData);
115
116extern int create_path (const char *name, int mode);
117extern int parse_mode( const char* s, mode_t* theMode);
118
119extern int get_kernel_revision(void);
120
121extern int get_console_fd(char* tty_name);
122extern struct mntent *find_mount_point(const char *name, const char *table);
123extern void write_mtab(char* blockDevice, char* directory,
124 char* filesystemType, long flags, char* string_flags);
125extern void erase_mtab(const char * name);
126extern void mtab_read(void);
127extern char *mtab_first(void **iter);
128extern char *mtab_next(void **iter);
129extern char *mtab_getinfo(const char *match, const char which);
130extern int check_wildcard_match(const char* text, const char* pattern);
131extern long atoi_w_units (const char *cp);
132extern pid_t* find_pid_by_name( char* pidName);
133extern int find_real_root_device_name(char* name);
134extern char *get_line_from_file(FILE *file);
135extern void print_file(FILE *file);
136extern int print_file_by_name(char *filename);
Eric Andersene5dfced2001-04-09 22:48:12 +0000137extern char process_escape_sequence(const char **ptr);
Eric Andersenaad1a882001-03-16 22:47:14 +0000138extern char *get_last_path_component(char *path);
139extern FILE *wfopen(const char *path, const char *mode);
140extern FILE *xfopen(const char *path, const char *mode);
141extern void chomp(char *s);
142extern void trim(char *s);
143extern struct BB_applet *find_applet_by_name(const char *name);
144void run_applet_by_name(const char *name, int argc, char **argv);
145
146#ifndef DMALLOC
147extern void *xmalloc (size_t size);
148extern void *xrealloc(void *old, size_t size);
149extern void *xcalloc(size_t nmemb, size_t size);
150extern char *xstrdup (const char *s);
151#endif
152extern char *xstrndup (const char *s, int n);
153extern char * safe_strncpy(char *dst, const char *src, size_t size);
154
155struct suffix_mult {
Eric Andersene5dfced2001-04-09 22:48:12 +0000156 const char *suffix;
Eric Andersenaad1a882001-03-16 22:47:14 +0000157 int mult;
158};
159
160extern unsigned long parse_number(const char *numstr,
161 const struct suffix_mult *suffixes);
162
163
164/* These parse entries in /etc/passwd and /etc/group. This is desirable
165 * for BusyBox since we want to avoid using the glibc NSS stuff, which
166 * increases target size and is often not needed embedded systems. */
167extern long my_getpwnam(const char *name);
168extern long my_getgrnam(const char *name);
169extern void my_getpwuid(char *name, long uid);
170extern void my_getgrgid(char *group, long gid);
171extern long my_getpwnamegid(const char *name);
172
173extern int device_open(char *device, int mode);
174
175extern int del_loop(const char *device);
176extern int set_loop(const char *device, const char *file, int offset, int *loopro);
177extern char *find_unused_loop_device (void);
178
179
180#if (__GLIBC__ < 2)
181extern int vdprintf(int d, const char *format, va_list ap);
182#endif
183
184int nfsmount(const char *spec, const char *node, int *flags,
185 char **extra_opts, char **mount_opts, int running_bg);
186
187void syslog_msg_with_name(const char *name, int facility, int pri, const char *msg);
188void syslog_msg(int facility, int pri, const char *msg);
189
190/* Include our own copy of struct sysinfo to avoid binary compatability
191 * problems with Linux 2.4, which changed things. Grumble, grumble. */
192struct sysinfo {
193 long uptime; /* Seconds since boot */
194 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
195 unsigned long totalram; /* Total usable main memory size */
196 unsigned long freeram; /* Available memory size */
197 unsigned long sharedram; /* Amount of shared memory */
198 unsigned long bufferram; /* Memory used by buffers */
199 unsigned long totalswap; /* Total swap space size */
200 unsigned long freeswap; /* swap space still available */
201 unsigned short procs; /* Number of current processes */
202 unsigned long totalhigh; /* Total high memory size */
203 unsigned long freehigh; /* Available high memory size */
204 unsigned int mem_unit; /* Memory unit size in bytes */
205 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
206};
207extern int sysinfo (struct sysinfo* info);
208
Matt Kraaid98e5742001-03-28 20:10:25 +0000209const char *make_human_readable_str(unsigned long val, unsigned long not_hr);
Eric Andersenaad1a882001-03-16 22:47:14 +0000210enum {
211 KILOBYTE = 1024,
212 MEGABYTE = (KILOBYTE*1024),
213 GIGABYTE = (MEGABYTE*1024)
214};
215
216int ask_confirmation(void);
Eric Andersene76c3b02001-04-05 03:14:39 +0000217int klogctl(int type, char * b, int len);
Eric Andersenaad1a882001-03-16 22:47:14 +0000218
Eric Andersene5dfced2001-04-09 22:48:12 +0000219char *xgetcwd(char *cwd);
Mark Whitley8a633262001-04-30 18:17:00 +0000220char *xreadlink(const char *path);
Eric Andersene5dfced2001-04-09 22:48:12 +0000221char *concat_path_file(const char *path, const char *filename);
Eric Andersenc1bdffe2001-04-26 15:56:47 +0000222int last_char_is(const char *s, const int c);
Eric Andersene5dfced2001-04-09 22:48:12 +0000223
Glenn L McGrath9d53c8a2001-04-11 01:37:03 +0000224typedef struct ar_headers_s {
225 char *name;
226 off_t size;
227 uid_t uid;
228 gid_t gid;
229 mode_t mode;
230 time_t mtime;
231 off_t offset;
232 struct ar_headers_s *next;
233} ar_headers_t;
Glenn L McGrath4949faf2001-04-11 16:23:35 +0000234extern ar_headers_t *get_ar_headers(FILE *in_file);
235extern int seek_ared_file(FILE *in_file, ar_headers_t *headers, const char *tar_gz_file);
Glenn L McGrath359c1062001-04-12 10:19:08 +0000236
237typedef enum extract_function_e {
238 extract_contents = 1,
239 extract_control = 2,
240 extract_info = 4,
241 extract_extract = 8,
242 extract_verbose_extract = 16,
Glenn L McGrathc9cac5b2001-04-12 13:47:12 +0000243 extract_list = 32,
Glenn L McGrath445fb952001-04-13 04:02:57 +0000244 extract_fsys_tarfile = 64,
Glenn L McGrath33431eb2001-04-16 04:52:19 +0000245 extract_field = 128,
246 extract_contents_to_file = 256
Glenn L McGrath359c1062001-04-12 10:19:08 +0000247} extract_function_t;
Glenn L McGrath33431eb2001-04-16 04:52:19 +0000248extern char *deb_extract(const char *package_filename, const int function,
249 const char *argument, const char *argument2);
250extern char *untar(FILE *src_tar_file, FILE *output, const int untar_function,
251 const char *argument, const char *file_prefix);
Glenn L McGrath685f5fd2001-04-15 12:51:59 +0000252extern char *read_text_file_to_buffer(FILE *src_file);
253extern char *read_package_field(const char *package_buffer);
Glenn L McGrath359c1062001-04-12 10:19:08 +0000254
Glenn L McGrath7fd92942001-04-11 03:11:33 +0000255extern int unzip(FILE *l_in_file, FILE *l_out_file);
256extern void gz_close(int gunzip_pid);
257extern int gz_open(FILE *compressed_file, int *pid);
Glenn L McGrath4949faf2001-04-11 16:23:35 +0000258
Glenn L McGratha2831572001-04-12 00:49:26 +0000259#define CT_AUTO 0
260#define CT_UNIX2DOS 1
261#define CT_DOS2UNIX 2
Matt Kraai1e04ea32001-04-12 21:38:06 +0000262/* extern int convert(char *fn, int ConvType); */
Glenn L McGratha2831572001-04-12 00:49:26 +0000263
Matt Kraai91b28552001-04-23 18:53:07 +0000264enum {
Matt Kraai01441032001-04-24 01:30:02 +0000265 FILEUTILS_PRESERVE_STATUS = 1,
266 FILEUTILS_PRESERVE_SYMLINKS = 2,
267 FILEUTILS_RECUR = 4,
268 FILEUTILS_FORCE = 8,
269 FILEUTILS_INTERACTIVE = 16
Matt Kraai91b28552001-04-23 18:53:07 +0000270};
271
Eric Andersen6f343942001-04-30 18:08:03 +0000272extern const char * const applet_name;
273extern const char * const full_version;
274extern const char * const name_too_long;
275extern const char * const omitting_directory;
276extern const char * const not_a_directory;
277extern const char * const memory_exhausted;
278extern const char * const invalid_date;
279extern const char * const invalid_option;
280extern const char * const io_error;
281extern const char * const dash_dash_help;
282extern const char * const write_error;
283extern const char * const too_few_args;
284extern const char * const name_longer_than_foo;
Matt Kraai9ff93252001-04-24 01:12:33 +0000285
Eric Andersenaad1a882001-03-16 22:47:14 +0000286#endif /* __LIBBB_H__ */