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