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