blob: 31bd97f2e1f3fc2fc24f3467f661242e6f20f34a [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
Matt Kraaic55b8d42001-05-16 15:40:51 +000032#include <netdb.h>
33
Eric Andersenaad1a882001-03-16 22:47:14 +000034#ifdef DMALLOC
35#include "dmalloc.h"
36#endif
37
38#include <features.h>
Eric Andersenb6b519b2001-04-09 23:52:18 +000039
Mark Whitleyc29c44c2001-04-25 18:06:21 +000040#ifndef _BB_INTERNAL_H_
41#include "../busybox.h"
42#endif
43
Eric Andersenb6b519b2001-04-09 23:52:18 +000044#if __GNU_LIBRARY__ < 5
Eric Andersenaad1a882001-03-16 22:47:14 +000045/* libc5 doesn't define socklen_t */
46typedef unsigned int socklen_t;
Eric Andersenb2e3e9b2001-04-04 19:25:57 +000047/* libc5 doesn't implement BSD 4.4 daemon() */
48extern int daemon (int nochdir, int noclose);
Eric Andersenaad1a882001-03-16 22:47:14 +000049#endif
50
51/* Some useful definitions */
52#define FALSE ((int) 0)
53#define TRUE ((int) 1)
54#define SKIP ((int) 2)
55
56/* for mtab.c */
57#define MTAB_GETMOUNTPT '1'
58#define MTAB_GETDEVICE '2'
59
60#define BUF_SIZE 8192
61#define EXPAND_ALLOC 1024
62
Eric Andersenb5ec61e2001-04-18 20:17:05 +000063static inline int is_decimal(int ch) { return ((ch >= '0') && (ch <= '9')); }
64static inline int is_octal(int ch) { return ((ch >= '0') && (ch <= '7')); }
Eric Andersenaad1a882001-03-16 22:47:14 +000065
66/* Macros for min/max. */
67#ifndef MIN
68#define MIN(a,b) (((a)<(b))?(a):(b))
69#endif
70
71#ifndef MAX
72#define MAX(a,b) (((a)>(b))?(a):(b))
73#endif
74
75
76
77extern void show_usage(void) __attribute__ ((noreturn));
Eric Andersenb183dfa2001-03-19 19:24:06 +000078extern void error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
79extern void error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
Eric Andersenaad1a882001-03-16 22:47:14 +000080extern void perror_msg(const char *s, ...);
81extern void perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn));
Matt Kraaic55b8d42001-05-16 15:40:51 +000082extern void vherror_msg(const char *s, va_list p);
83extern void herror_msg(const char *s, ...);
84extern void herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn));
Eric Andersenaad1a882001-03-16 22:47:14 +000085
Eric Andersenb183dfa2001-03-19 19:24:06 +000086/* These two are used internally -- you shouldn't need to use them */
87extern void verror_msg(const char *s, va_list p);
88extern void vperror_msg(const char *s, va_list p);
89
Eric Andersenaad1a882001-03-16 22:47:14 +000090const char *mode_string(int mode);
91const char *time_string(time_t timeVal);
Eric Andersen8cd16d82001-05-07 23:11:23 +000092int is_directory(const char *name, int followLinks, struct stat *statBuf);
Eric Andersenaad1a882001-03-16 22:47:14 +000093int isDevice(const char *name);
94
Matt Kraai8810bdb2001-04-24 20:04:18 +000095int remove_file(const char *path, int flags);
Matt Kraai91b28552001-04-23 18:53:07 +000096int copy_file(const char *source, const char *dest, int flags);
Glenn L McGrathc9cac5b2001-04-12 13:47:12 +000097int copy_file_chunk(FILE *src_file, FILE *dst_file, unsigned long long chunksize);
Eric Andersenaad1a882001-03-16 22:47:14 +000098char *buildName(const char *dirName, const char *fileName);
99int makeString(int argc, const char **argv, char *buf, int bufLen);
100char *getChunk(int size);
101char *chunkstrdup(const char *str);
102void freeChunks(void);
103ssize_t safe_read(int fd, void *buf, size_t count);
104int full_write(int fd, const char *buf, int len);
105int full_read(int fd, char *buf, int len);
106int recursive_action(const char *fileName, int recurse, int followLinks, int depthFirst,
107 int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData),
108 int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData),
109 void* userData);
110
111extern int create_path (const char *name, int mode);
112extern int parse_mode( const char* s, mode_t* theMode);
113
114extern int get_kernel_revision(void);
115
116extern int get_console_fd(char* tty_name);
117extern struct mntent *find_mount_point(const char *name, const char *table);
118extern void write_mtab(char* blockDevice, char* directory,
119 char* filesystemType, long flags, char* string_flags);
120extern void erase_mtab(const char * name);
Eric Andersenaad1a882001-03-16 22:47:14 +0000121extern long atoi_w_units (const char *cp);
122extern pid_t* find_pid_by_name( char* pidName);
Eric Andersenc911a432001-05-15 17:42:16 +0000123extern char *find_real_root_device_name(const char* name);
Eric Andersenaad1a882001-03-16 22:47:14 +0000124extern char *get_line_from_file(FILE *file);
125extern void print_file(FILE *file);
Matt Kraaid6ef0742001-05-18 14:14:55 +0000126extern int copyfd(int fd1, int fd2);
Eric Andersenaad1a882001-03-16 22:47:14 +0000127extern int print_file_by_name(char *filename);
Eric Andersene5dfced2001-04-09 22:48:12 +0000128extern char process_escape_sequence(const char **ptr);
Eric Andersenaad1a882001-03-16 22:47:14 +0000129extern char *get_last_path_component(char *path);
130extern FILE *wfopen(const char *path, const char *mode);
131extern FILE *xfopen(const char *path, const char *mode);
132extern void chomp(char *s);
133extern void trim(char *s);
134extern struct BB_applet *find_applet_by_name(const char *name);
135void run_applet_by_name(const char *name, int argc, char **argv);
136
137#ifndef DMALLOC
138extern void *xmalloc (size_t size);
139extern void *xrealloc(void *old, size_t size);
140extern void *xcalloc(size_t nmemb, size_t size);
141extern char *xstrdup (const char *s);
142#endif
143extern char *xstrndup (const char *s, int n);
144extern char * safe_strncpy(char *dst, const char *src, size_t size);
145
146struct suffix_mult {
Eric Andersene5dfced2001-04-09 22:48:12 +0000147 const char *suffix;
Eric Andersenaad1a882001-03-16 22:47:14 +0000148 int mult;
149};
150
151extern unsigned long parse_number(const char *numstr,
152 const struct suffix_mult *suffixes);
153
154
155/* These parse entries in /etc/passwd and /etc/group. This is desirable
156 * for BusyBox since we want to avoid using the glibc NSS stuff, which
157 * increases target size and is often not needed embedded systems. */
158extern long my_getpwnam(const char *name);
159extern long my_getgrnam(const char *name);
160extern void my_getpwuid(char *name, long uid);
161extern void my_getgrgid(char *group, long gid);
162extern long my_getpwnamegid(const char *name);
163
164extern int device_open(char *device, int mode);
165
166extern int del_loop(const char *device);
167extern int set_loop(const char *device, const char *file, int offset, int *loopro);
168extern char *find_unused_loop_device (void);
169
170
171#if (__GLIBC__ < 2)
172extern int vdprintf(int d, const char *format, va_list ap);
173#endif
174
175int nfsmount(const char *spec, const char *node, int *flags,
176 char **extra_opts, char **mount_opts, int running_bg);
177
178void syslog_msg_with_name(const char *name, int facility, int pri, const char *msg);
179void syslog_msg(int facility, int pri, const char *msg);
180
181/* Include our own copy of struct sysinfo to avoid binary compatability
182 * problems with Linux 2.4, which changed things. Grumble, grumble. */
183struct sysinfo {
184 long uptime; /* Seconds since boot */
185 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
186 unsigned long totalram; /* Total usable main memory size */
187 unsigned long freeram; /* Available memory size */
188 unsigned long sharedram; /* Amount of shared memory */
189 unsigned long bufferram; /* Memory used by buffers */
190 unsigned long totalswap; /* Total swap space size */
191 unsigned long freeswap; /* swap space still available */
192 unsigned short procs; /* Number of current processes */
193 unsigned long totalhigh; /* Total high memory size */
194 unsigned long freehigh; /* Available high memory size */
195 unsigned int mem_unit; /* Memory unit size in bytes */
196 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
197};
198extern int sysinfo (struct sysinfo* info);
199
Matt Kraaid98e5742001-03-28 20:10:25 +0000200const char *make_human_readable_str(unsigned long val, unsigned long not_hr);
Eric Andersenaad1a882001-03-16 22:47:14 +0000201enum {
202 KILOBYTE = 1024,
203 MEGABYTE = (KILOBYTE*1024),
204 GIGABYTE = (MEGABYTE*1024)
205};
206
207int ask_confirmation(void);
Eric Andersene76c3b02001-04-05 03:14:39 +0000208int klogctl(int type, char * b, int len);
Eric Andersenaad1a882001-03-16 22:47:14 +0000209
Eric Andersene5dfced2001-04-09 22:48:12 +0000210char *xgetcwd(char *cwd);
Mark Whitley8a633262001-04-30 18:17:00 +0000211char *xreadlink(const char *path);
Eric Andersene5dfced2001-04-09 22:48:12 +0000212char *concat_path_file(const char *path, const char *filename);
Eric Andersenc911a432001-05-15 17:42:16 +0000213char *last_char_is(const char *s, int c);
Eric Andersene5dfced2001-04-09 22:48:12 +0000214
Glenn L McGrath9d53c8a2001-04-11 01:37:03 +0000215typedef struct ar_headers_s {
216 char *name;
217 off_t size;
218 uid_t uid;
219 gid_t gid;
220 mode_t mode;
221 time_t mtime;
222 off_t offset;
223 struct ar_headers_s *next;
224} ar_headers_t;
Glenn L McGrath4949faf2001-04-11 16:23:35 +0000225extern ar_headers_t *get_ar_headers(FILE *in_file);
226extern int seek_ared_file(FILE *in_file, ar_headers_t *headers, const char *tar_gz_file);
Glenn L McGrath359c1062001-04-12 10:19:08 +0000227
228typedef enum extract_function_e {
229 extract_contents = 1,
230 extract_control = 2,
231 extract_info = 4,
232 extract_extract = 8,
233 extract_verbose_extract = 16,
Glenn L McGrathc9cac5b2001-04-12 13:47:12 +0000234 extract_list = 32,
Glenn L McGrath445fb952001-04-13 04:02:57 +0000235 extract_fsys_tarfile = 64,
Glenn L McGrath33431eb2001-04-16 04:52:19 +0000236 extract_field = 128,
237 extract_contents_to_file = 256
Glenn L McGrath359c1062001-04-12 10:19:08 +0000238} extract_function_t;
Eric Andersen8cd16d82001-05-07 23:11:23 +0000239extern char *deb_extract(const char *package_filename, int function,
Glenn L McGrath33431eb2001-04-16 04:52:19 +0000240 const char *argument, const char *argument2);
Eric Andersen8cd16d82001-05-07 23:11:23 +0000241extern char *untar(FILE *src_tar_file, FILE *output, int untar_function,
Glenn L McGrath33431eb2001-04-16 04:52:19 +0000242 const char *argument, const char *file_prefix);
Glenn L McGrath685f5fd2001-04-15 12:51:59 +0000243extern char *read_text_file_to_buffer(FILE *src_file);
244extern char *read_package_field(const char *package_buffer);
Glenn L McGrath359c1062001-04-12 10:19:08 +0000245
Glenn L McGrath7fd92942001-04-11 03:11:33 +0000246extern int unzip(FILE *l_in_file, FILE *l_out_file);
247extern void gz_close(int gunzip_pid);
248extern int gz_open(FILE *compressed_file, int *pid);
Glenn L McGrath4949faf2001-04-11 16:23:35 +0000249
Matt Kraaic55b8d42001-05-16 15:40:51 +0000250extern struct hostent *xgethostbyname(const char *name);
251
Glenn L McGratha2831572001-04-12 00:49:26 +0000252#define CT_AUTO 0
253#define CT_UNIX2DOS 1
254#define CT_DOS2UNIX 2
Matt Kraai1e04ea32001-04-12 21:38:06 +0000255/* extern int convert(char *fn, int ConvType); */
Glenn L McGratha2831572001-04-12 00:49:26 +0000256
Matt Kraai91b28552001-04-23 18:53:07 +0000257enum {
Matt Kraai01441032001-04-24 01:30:02 +0000258 FILEUTILS_PRESERVE_STATUS = 1,
259 FILEUTILS_PRESERVE_SYMLINKS = 2,
260 FILEUTILS_RECUR = 4,
261 FILEUTILS_FORCE = 8,
262 FILEUTILS_INTERACTIVE = 16
Matt Kraai91b28552001-04-23 18:53:07 +0000263};
264
Eric Andersen0e9aef32001-04-30 18:18:02 +0000265extern const char *applet_name;
Eric Andersen6f343942001-04-30 18:08:03 +0000266extern const char * const full_version;
267extern const char * const name_too_long;
268extern const char * const omitting_directory;
269extern const char * const not_a_directory;
270extern const char * const memory_exhausted;
271extern const char * const invalid_date;
272extern const char * const invalid_option;
273extern const char * const io_error;
274extern const char * const dash_dash_help;
275extern const char * const write_error;
276extern const char * const too_few_args;
277extern const char * const name_longer_than_foo;
Eric Andersen5f265b72001-05-11 16:58:46 +0000278extern const char * const unknown;
Matt Kraai9ff93252001-04-24 01:12:33 +0000279
Eric Andersenaad1a882001-03-16 22:47:14 +0000280#endif /* __LIBBB_H__ */