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 #ifdef DMALLOC
  33 #include "dmalloc.h"
  34 #endif
  35
  36 #include <features.h>
  37 /* Stupid libc doesn't have a reliable way for use to know
  38  * that libc5 is being used.   Assume this is good enough */
  39 #if ! defined __GLIBC__ && ! defined __UCLIBC__
  40 /* libc5 doesn't define socklen_t */
  41 typedef unsigned int socklen_t;
  42 #endif
  43
  44 /* Some useful definitions */
  45 #define FALSE   ((int) 0)
  46 #define TRUE    ((int) 1)
  47 #define SKIP    ((int) 2)
  48
  49 /* for mtab.c */
  50 #define MTAB_GETMOUNTPT '1'
  51 #define MTAB_GETDEVICE  '2'
  52
  53 #define BUF_SIZE        8192
  54 #define EXPAND_ALLOC    1024
  55
  56 static inline int is_decimal(ch) { return ((ch >= '0') && (ch <= '9')); }
  57 static inline int is_octal(ch)   { return ((ch >= '0') && (ch <= '7')); }
  58
  59 /* Macros for min/max.  */
  60 #ifndef MIN
  61 #define MIN(a,b) (((a)<(b))?(a):(b))
  62 #endif
  63
  64 #ifndef MAX
  65 #define MAX(a,b) (((a)>(b))?(a):(b))
  66 #endif
  67
  68
  69
  70 extern void show_usage(void) __attribute__ ((noreturn));
  71 extern void error_msg(const char *s, ...);
  72 extern void error_msg_and_die(const char *s, ...) __attribute__ ((noreturn));
  73 extern void perror_msg(const char *s, ...);
  74 extern void perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn));
  75
  76 const char *mode_string(int mode);
  77 const char *time_string(time_t timeVal);
  78 int is_directory(const char *name, const int followLinks, struct stat *statBuf);
  79 int isDevice(const char *name);
  80
  81 typedef struct ino_dev_hash_bucket_struct {
  82   struct ino_dev_hash_bucket_struct *next;
  83   ino_t ino;
  84   dev_t dev;
  85   char name[1];
  86 } ino_dev_hashtable_bucket_t;
  87 int is_in_ino_dev_hashtable(const struct stat *statbuf, char **name);
  88 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
  89 void reset_ino_dev_hashtable(void);
  90
  91 int copy_file(const char *srcName, const char *destName,
  92                  int setModes, int followLinks, int forceFlag);
  93 int copy_file_chunk(int srcFd, int dstFd, size_t remaining);
  94 char *buildName(const char *dirName, const char *fileName);
  95 int makeString(int argc, const char **argv, char *buf, int bufLen);
  96 char *getChunk(int size);
  97 char *chunkstrdup(const char *str);
  98 void freeChunks(void);
  99 ssize_t safe_read(int fd, void *buf, size_t count);
 100 int full_write(int fd, const char *buf, int len);
 101 int full_read(int fd, char *buf, int len);
 102 int recursive_action(const char *fileName, int recurse, int followLinks, int depthFirst,
 103           int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData),
 104           int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData),
 105           void* userData);
 106
 107 extern int create_path (const char *name, int mode);
 108 extern int parse_mode( const char* s, mode_t* theMode);
 109
 110 extern int get_kernel_revision(void);
 111
 112 extern int get_console_fd(char* tty_name);
 113 extern struct mntent *find_mount_point(const char *name, const char *table);
 114 extern void write_mtab(char* blockDevice, char* directory,
 115         char* filesystemType, long flags, char* string_flags);
 116 extern void erase_mtab(const char * name);
 117 extern void mtab_read(void);
 118 extern char *mtab_first(void **iter);
 119 extern char *mtab_next(void **iter);
 120 extern char *mtab_getinfo(const char *match, const char which);
 121 extern int check_wildcard_match(const char* text, const char* pattern);
 122 extern long atoi_w_units (const char *cp);
 123 extern pid_t* find_pid_by_name( char* pidName);
 124 extern int find_real_root_device_name(char* name);
 125 extern char *get_line_from_file(FILE *file);
 126 extern void print_file(FILE *file);
 127 extern int print_file_by_name(char *filename);
 128 extern char process_escape_sequence(char **ptr);
 129 extern char *get_last_path_component(char *path);
 130 extern FILE *wfopen(const char *path, const char *mode);
 131 extern FILE *xfopen(const char *path, const char *mode);
 132 extern void chomp(char *s);
 133 extern void trim(char *s);
 134 extern struct BB_applet *find_applet_by_name(const char *name);
 135 void run_applet_by_name(const char *name, int argc, char **argv);
 136
 137 #ifndef DMALLOC
 138 extern void *xmalloc (size_t size);
 139 extern void *xrealloc(void *old, size_t size);
 140 extern void *xcalloc(size_t nmemb, size_t size);
 141 extern char *xstrdup (const char *s);
 142 #endif
 143 extern char *xstrndup (const char *s, int n);
 144 extern char * safe_strncpy(char *dst, const char *src, size_t size);
 145
 146 struct suffix_mult {
 147         char *suffix;
 148         int mult;
 149 };
 150
 151 extern 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.  */
 158 extern long my_getpwnam(const char *name);
 159 extern long my_getgrnam(const char *name);
 160 extern void my_getpwuid(char *name, long uid);
 161 extern void my_getgrgid(char *group, long gid);
 162 extern long my_getpwnamegid(const char *name);
 163
 164 extern int device_open(char *device, int mode);
 165
 166 extern int del_loop(const char *device);
 167 extern int set_loop(const char *device, const char *file, int offset, int *loopro);
 168 extern char *find_unused_loop_device (void);
 169
 170
 171 #if (__GLIBC__ < 2)
 172 extern int vdprintf(int d, const char *format, va_list ap);
 173 #endif
 174
 175 int nfsmount(const char *spec, const char *node, int *flags,
 176              char **extra_opts, char **mount_opts, int running_bg);
 177
 178 void syslog_msg_with_name(const char *name, int facility, int pri, const char *msg);
 179 void 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. */
 183 struct 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 };
 198 extern int sysinfo (struct sysinfo* info);
 199
 200 const char *make_human_readable_str(unsigned long val, unsigned long hr);
 201 enum {
 202         KILOBYTE = 1024,
 203         MEGABYTE = (KILOBYTE*1024),
 204         GIGABYTE = (MEGABYTE*1024)
 205 };
 206
 207 int ask_confirmation(void);
 208
 209 #endif /* __LIBBB_H__ */