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 #include "config.h"
  41
  42 #include "pwd_.h"
  43 #include "grp_.h"
  44 #ifdef CONFIG_FEATURE_SHADOWPASSWDS
  45 #include "shadow_.h"
  46 #endif
  47 #ifdef CONFIG_FEATURE_SHA1_PASSWORDS
  48 # include "sha1.h"
  49 #endif
  50
  51 /* Compatability with ANSI C */
  52 #ifndef inline
  53 # define inline
  54 #endif
  55
  56 #if (__GNU_LIBRARY__ < 5) && (!defined __dietlibc__)
  57 /* libc5 doesn't define socklen_t */
  58 #ifndef _SOCKLEN_T
  59 #define _SOCKLEN_T
  60 typedef unsigned int socklen_t;
  61 #endif
  62 /* libc5 doesn't implement BSD 4.4 daemon() */
  63 extern int daemon (int nochdir, int noclose);
  64 /* libc5 doesn't implement strtok_r */
  65 char *strtok_r(char *s, const char *delim, char **ptrptr);
  66 #endif
  67
  68 /* Some useful definitions */
  69 #define FALSE   ((int) 0)
  70 #define TRUE    ((int) 1)
  71 #define SKIP    ((int) 2)
  72
  73 /* for mtab.c */
  74 #define MTAB_GETMOUNTPT '1'
  75 #define MTAB_GETDEVICE  '2'
  76
  77 #define BUF_SIZE        8192
  78 #define EXPAND_ALLOC    1024
  79
  80 /* Macros for min/max.  */
  81 #ifndef MIN
  82 #define MIN(a,b) (((a)<(b))?(a):(b))
  83 #endif
  84
  85 #ifndef MAX
  86 #define MAX(a,b) (((a)>(b))?(a):(b))
  87 #endif
  88
  89 extern void show_usage(void) __attribute__ ((noreturn));
  90 extern void error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
  91 extern void error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
  92 extern void perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
  93 extern void perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
  94 extern void vherror_msg(const char *s, va_list p);
  95 extern void herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
  96 extern void herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
  97
  98 /* These two are used internally -- you shouldn't need to use them */
  99 extern void verror_msg(const char *s, va_list p);
 100 extern void vperror_msg(const char *s, va_list p);
 101
 102 const char *mode_string(int mode);
 103 const char *time_string(time_t timeVal);
 104 int is_directory(const char *name, int followLinks, struct stat *statBuf);
 105 int isDevice(const char *name);
 106
 107 int remove_file(const char *path, int flags);
 108 int copy_file(const char *source, const char *dest, int flags);
 109 int copy_file_chunk(FILE *src_file, FILE *dst_file, unsigned long long chunksize);
 110 char *buildName(const char *dirName, const char *fileName);
 111 int makeString(int argc, const char **argv, char *buf, int bufLen);
 112 char *getChunk(int size);
 113 char *chunkstrdup(const char *str);
 114 void freeChunks(void);
 115 ssize_t safe_read(int fd, void *buf, size_t count);
 116 int full_write(int fd, const char *buf, int len);
 117 int full_read(int fd, char *buf, int len);
 118 int recursive_action(const char *fileName, int recurse, int followLinks, int depthFirst,
 119           int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData),
 120           int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData),
 121           void* userData);
 122
 123 extern int parse_mode( const char* s, mode_t* theMode);
 124
 125 extern int get_kernel_revision(void);
 126
 127 extern int get_console_fd(void);
 128 extern struct mntent *find_mount_point(const char *name, const char *table);
 129 extern void write_mtab(char* blockDevice, char* directory,
 130         char* filesystemType, long flags, char* string_flags);
 131 extern void erase_mtab(const char * name);
 132 extern long atoi_w_units (const char *cp);
 133 extern long* find_pid_by_name( const char* pidName);
 134 extern char *find_real_root_device_name(const char* name);
 135 extern char *get_line_from_file(FILE *file);
 136 extern void print_file(FILE *file);
 137 extern int copyfd(int fd1, int fd2, const off_t chunksize);
 138 extern int print_file_by_name(char *filename);
 139 extern char process_escape_sequence(const char **ptr);
 140 extern char *get_last_path_component(char *path);
 141 extern FILE *wfopen(const char *path, const char *mode);
 142 extern FILE *xfopen(const char *path, const char *mode);
 143 extern void chomp(char *s);
 144 extern void trim(char *s);
 145 extern struct BB_applet *find_applet_by_name(const char *name);
 146 void run_applet_by_name(const char *name, int argc, char **argv);
 147
 148 #ifndef DMALLOC
 149 extern void *xmalloc (size_t size);
 150 extern void *xrealloc(void *old, size_t size);
 151 extern void *xcalloc(size_t nmemb, size_t size);
 152 extern char *xstrdup (const char *s);
 153 #endif
 154 extern char *xstrndup (const char *s, int n);
 155 extern char * safe_strncpy(char *dst, const char *src, size_t size);
 156
 157 struct suffix_mult {
 158         const char *suffix;
 159         int mult;
 160 };
 161
 162 extern unsigned long parse_number(const char *numstr,
 163                 const struct suffix_mult *suffixes);
 164
 165
 166 /* These parse entries in /etc/passwd and /etc/group.  This is desirable
 167  * for BusyBox since we want to avoid using the glibc NSS stuff, which
 168  * increases target size and is often not needed embedded systems.  */
 169 extern long my_getpwnam(const char *name);
 170 extern long my_getgrnam(const char *name);
 171 extern char * my_getpwuid(char *name, long uid);
 172 extern char * my_getgrgid(char *group, long gid);
 173 extern long my_getpwnamegid(const char *name);
 174
 175 extern int device_open(const char *device, int mode);
 176
 177 extern int del_loop(const char *device);
 178 extern int set_loop(const char *device, const char *file, int offset, int *loopro);
 179 extern char *find_unused_loop_device (void);
 180
 181
 182 #if (__GLIBC__ < 2)
 183 extern int vdprintf(int d, const char *format, va_list ap);
 184 #endif
 185
 186 int nfsmount(const char *spec, const char *node, int *flags,
 187              char **extra_opts, char **mount_opts, int running_bg);
 188
 189 void syslog_msg_with_name(const char *name, int facility, int pri, const char *msg);
 190 void syslog_msg(int facility, int pri, const char *msg);
 191
 192 /* Include our own copy of struct sysinfo to avoid binary compatability
 193  * problems with Linux 2.4, which changed things.  Grumble, grumble. */
 194 struct sysinfo {
 195         long uptime;                    /* Seconds since boot */
 196         unsigned long loads[3];         /* 1, 5, and 15 minute load averages */
 197         unsigned long totalram;         /* Total usable main memory size */
 198         unsigned long freeram;          /* Available memory size */
 199         unsigned long sharedram;        /* Amount of shared memory */
 200         unsigned long bufferram;        /* Memory used by buffers */
 201         unsigned long totalswap;        /* Total swap space size */
 202         unsigned long freeswap;         /* swap space still available */
 203         unsigned short procs;           /* Number of current processes */
 204         unsigned short pad;                     /* Padding needed for m68k */
 205         unsigned long totalhigh;        /* Total high memory size */
 206         unsigned long freehigh;         /* Available high memory size */
 207         unsigned int mem_unit;          /* Memory unit size in bytes */
 208         char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
 209 };
 210 extern int sysinfo (struct sysinfo* info);
 211
 212 enum {
 213         KILOBYTE = 1024,
 214         MEGABYTE = (KILOBYTE*1024),
 215         GIGABYTE = (MEGABYTE*1024)
 216 };
 217 const char *make_human_readable_str(unsigned long size, unsigned long block_size, unsigned long display_unit);
 218
 219 int ask_confirmation(void);
 220 int klogctl(int type, char * b, int len);
 221
 222 char *xgetcwd(char *cwd);
 223 char *xreadlink(const char *path);
 224 char *concat_path_file(const char *path, const char *filename);
 225 char *last_char_is(const char *s, int c);
 226
 227 extern long arith (const char *startbuf, int *errcode);
 228
 229 int read_package_field(const char *package_buffer, char **field_name, char **field_value);
 230 char *fgets_str(FILE *file, const char *terminating_string);
 231
 232 extern int uncompress(int fd_in, int fd_out);
 233 extern int inflate(int in, int out);
 234
 235 extern struct hostent *xgethostbyname(const char *name);
 236 extern struct hostent *xgethostbyname2(const char *name, int af);
 237 extern int create_icmp_socket(void);
 238 extern int create_icmp6_socket(void);
 239 extern int xconnect(const char *host, const char *port);
 240
 241 char *dirname (char *path);
 242
 243 int make_directory (char *path, long mode, int flags);
 244
 245 const char *u_signal_names(const char *str_sig, int *signo, int startnum);
 246 char *simplify_path(const char *path);
 247
 248 #define CT_AUTO 0
 249 #define CT_UNIX2DOS     1
 250 #define CT_DOS2UNIX     2
 251 /* extern int convert(char *fn, int ConvType); */
 252
 253 enum {
 254         FILEUTILS_PRESERVE_STATUS = 1,
 255         FILEUTILS_DEREFERENCE = 2,
 256         FILEUTILS_RECUR = 4,
 257         FILEUTILS_FORCE = 8,
 258         FILEUTILS_INTERACTIVE = 16
 259 };
 260
 261 extern const char *applet_name;
 262 extern const char * const full_version;
 263 extern const char * const name_too_long;
 264 extern const char * const omitting_directory;
 265 extern const char * const not_a_directory;
 266 extern const char * const memory_exhausted;
 267 extern const char * const invalid_date;
 268 extern const char * const invalid_option;
 269 extern const char * const io_error;
 270 extern const char * const dash_dash_help;
 271 extern const char * const write_error;
 272 extern const char * const too_few_args;
 273 extern const char * const name_longer_than_foo;
 274 extern const char * const unknown;
 275 extern const char * const can_not_create_raw_socket;
 276 extern const char * const nologin_file;
 277 extern const char * const passwd_file;
 278 extern const char * const shadow_file;
 279 extern const char * const gshadow_file;
 280 extern const char * const group_file;
 281 extern const char * const securetty_file;
 282 extern const char * const motd_file;
 283 extern const char * const _path_login;
 284
 285 #ifdef CONFIG_FEATURE_DEVFS
 286 # define CURRENT_VC "/dev/vc/0"
 287 # define VC_1 "/dev/vc/1"
 288 # define VC_2 "/dev/vc/2"
 289 # define VC_3 "/dev/vc/3"
 290 # define VC_4 "/dev/vc/4"
 291 # define VC_5 "/dev/vc/5"
 292 # define SC_0 "/dev/tts/0"
 293 # define SC_1 "/dev/tts/1"
 294 # define VC_FORMAT "/dev/vc/%d"
 295 # define SC_FORMAT "/dev/tts/%d"
 296 # define LOOP_FORMAT "/dev/loop/%d"
 297 #else
 298 # define CURRENT_VC "/dev/tty0"
 299 # define VC_1 "/dev/tty1"
 300 # define VC_2 "/dev/tty2"
 301 # define VC_3 "/dev/tty3"
 302 # define VC_4 "/dev/tty4"
 303 # define VC_5 "/dev/tty5"
 304 # define SC_0 "/dev/ttyS0"
 305 # define SC_1 "/dev/ttyS1"
 306 # define VC_FORMAT "/dev/tty%d"
 307 # define SC_FORMAT "/dev/ttyS%d"
 308 # define LOOP_FORMAT "/dev/loop%d"
 309 #endif
 310
 311 /* The following devices are the same on devfs and non-devfs systems.  */
 312 #define CURRENT_TTY "/dev/tty"
 313 #define CONSOLE_DEV "/dev/console"
 314
 315 int is_in_ino_dev_hashtable(const struct stat *statbuf, char **name);
 316 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
 317 void reset_ino_dev_hashtable(void);
 318
 319 /* Stupid gcc always includes its own builtin strlen()... */
 320 extern size_t xstrlen(const char *string);
 321 #define strlen(x)   xstrlen(x)
 322
 323 void bb_asprintf(char **string_ptr, const char *format, ...) __attribute__ ((format (printf, 2, 3)));
 324
 325
 326 #define FAIL_DELAY    3
 327 extern void change_identity ( const struct passwd *pw );
 328 extern void run_shell ( const char *shell, int loginshell, const char *command, const char **additional_args );
 329 extern int run_parts(char **args, const unsigned char test_mode);
 330 extern int restricted_shell ( const char *shell );
 331 extern void setup_environment ( const char *shell, int loginshell, int changeenv, const struct passwd *pw );
 332 extern int correct_password ( const struct passwd *pw );
 333 extern char *pw_encrypt(const char *clear, const char *salt);
 334 extern struct spwd *pwd_to_spwd(const struct passwd *pw);
 335 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp);
 336
 337 extern int xopen(const char *pathname, int flags);
 338 extern ssize_t xread(int fd, void *buf, size_t count);
 339 extern void xread_all(int fd, void *buf, size_t count);
 340 extern unsigned char xread_char(int fd);
 341
 342 typedef struct {
 343         int pid;
 344         char user[9];
 345         char state[4];
 346         unsigned long rss;
 347         int ppid;
 348 #ifdef FEATURE_CPU_USAGE_PERCENTAGE
 349         unsigned pcpu;
 350         unsigned long stime, utime;
 351 #endif
 352         char *cmd;
 353
 354         /* basename of executable file in call to exec(2),
 355                 size from kernel headers */
 356         char short_cmd[16];
 357 } procps_status_t;
 358
 359 extern procps_status_t * procps_scan(int save_user_arg0);
 360 extern unsigned short compare_string_array(const char *string_array[], const char *key);
 361
 362 extern int my_query_module(const char *name, int which, void **buf, size_t *bufsize, size_t *ret);
 363
 364 typedef struct llist_s {
 365         char *data;
 366         struct llist_s *link;
 367 } llist_t;
 368 extern llist_t *llist_add_to(llist_t *old_head, char *new_item);
 369
 370 void print_login_issue(const char *issue_file, const char *tty);
 371 void print_login_prompt(void);
 372
 373 #endif /* __LIBCONFIG_H__ */