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 #include <termios.h>
  32
  33 #include <netdb.h>
  34
  35 #ifdef DMALLOC
  36 #include <dmalloc.h>
  37 #endif
  38
  39 #include <features.h>
  40
  41 #include "config.h"
  42
  43 #include "pwd_.h"
  44 #include "grp_.h"
  45 #ifdef CONFIG_FEATURE_SHADOWPASSWDS
  46 #include "shadow_.h"
  47 #endif
  48 #ifdef CONFIG_FEATURE_SHA1_PASSWORDS
  49 # include "sha1.h"
  50 #endif
  51
  52 /* Compatability with ANSI C */
  53 #ifndef inline
  54 # define inline
  55 #endif
  56
  57 #if (__GNU_LIBRARY__ < 5) && (!defined __dietlibc__)
  58 /* libc5 doesn't define socklen_t */
  59 #ifndef _SOCKLEN_T
  60 #define _SOCKLEN_T
  61 typedef unsigned int socklen_t;
  62 #endif
  63 /* libc5 doesn't implement BSD 4.4 daemon() */
  64 extern int daemon (int nochdir, int noclose);
  65 /* libc5 doesn't implement strtok_r */
  66 char *strtok_r(char *s, const char *delim, char **ptrptr);
  67 #endif
  68
  69 /* Convenience macros to test the version of gcc. */
  70 #if defined __GNUC__ && defined __GNUC_MINOR__
  71 # define __GNUC_PREREQ(maj, min) \
  72         ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
  73 #else
  74 # define __GNUC_PREREQ(maj, min) 0
  75 #endif
  76
  77 /* __restrict is known in EGCS 1.2 and above. */
  78 #if !__GNUC_PREREQ (2,92)
  79 # define __restrict     /* Ignore */
  80 #endif
  81
  82 /* Some useful definitions */
  83 #define FALSE   ((int) 0)
  84 #define TRUE    ((int) 1)
  85 #define SKIP    ((int) 2)
  86
  87 /* for mtab.c */
  88 #define MTAB_GETMOUNTPT '1'
  89 #define MTAB_GETDEVICE  '2'
  90
  91 #define BUF_SIZE        8192
  92 #define EXPAND_ALLOC    1024
  93
  94 /* Macros for min/max.  */
  95 #ifndef MIN
  96 #define MIN(a,b) (((a)<(b))?(a):(b))
  97 #endif
  98
  99 #ifndef MAX
 100 #define MAX(a,b) (((a)>(b))?(a):(b))
 101 #endif
 102
 103 extern void bb_show_usage(void) __attribute__ ((noreturn));
 104 extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
 105 extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
 106 extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
 107 extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
 108 extern void bb_vherror_msg(const char *s, va_list p);
 109 extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
 110 extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
 111
 112 extern void bb_perror_nomsg_and_die(void) __attribute__ ((noreturn));
 113 extern void bb_perror_nomsg(void);
 114
 115 /* These two are used internally -- you shouldn't need to use them */
 116 extern void bb_verror_msg(const char *s, va_list p) __attribute__ ((format (printf, 1, 0)));
 117 extern void bb_vperror_msg(const char *s, va_list p)  __attribute__ ((format (printf, 1, 0)));
 118
 119 extern const char *bb_mode_string(int mode);
 120 extern int is_directory(const char *name, int followLinks, struct stat *statBuf);
 121
 122 extern int remove_file(const char *path, int flags);
 123 extern int copy_file(const char *source, const char *dest, int flags);
 124 extern ssize_t safe_read(int fd, void *buf, size_t count);
 125 extern ssize_t bb_full_write(int fd, const void *buf, size_t len);
 126 extern ssize_t bb_full_read(int fd, void *buf, size_t len);
 127 extern int recursive_action(const char *fileName, int recurse,
 128           int followLinks, int depthFirst,
 129           int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData),
 130           int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData),
 131           void* userData);
 132
 133 extern int bb_parse_mode( const char* s, mode_t* theMode);
 134 extern long bb_xgetlarg(char *arg, int base, long lower, long upper);
 135
 136 extern unsigned long bb_baud_to_value(speed_t speed);
 137 extern speed_t bb_value_to_baud(unsigned long value);
 138
 139 extern int get_kernel_revision(void);
 140
 141 extern int get_console_fd(void);
 142 extern struct mntent *find_mount_point(const char *name, const char *table);
 143 extern void write_mtab(char* blockDevice, char* directory,
 144                                            char* filesystemType, long flags, char* string_flags);
 145 extern void erase_mtab(const char * name);
 146 extern long *find_pid_by_name( const char* pidName);
 147 extern char *find_real_root_device_name(const char* name);
 148 extern char *bb_get_line_from_file(FILE *file);
 149 extern char *bb_get_chomped_line_from_file(FILE *file);
 150 extern int   bb_copyfd(int fd1, int fd2, const off_t chunksize);
 151 extern void  bb_xprint_and_close_file(FILE *file);
 152 extern int   bb_xprint_file_by_name(const char *filename);
 153 extern char  bb_process_escape_sequence(const char **ptr);
 154 extern char *bb_get_last_path_component(char *path);
 155 extern FILE *bb_wfopen(const char *path, const char *mode);
 156 extern FILE *bb_xfopen(const char *path, const char *mode);
 157
 158 //#warning rename?
 159 extern int   bb_fclose_nonstdin(FILE *f);
 160 extern void  bb_fflush_stdout_and_exit(int retval) __attribute__ ((noreturn));
 161 extern unsigned long bb_getopt_ulflags(int argc, char **argv, const char *applet_opts);
 162 //#warning rename?
 163 extern FILE *bb_wfopen_input(const char *filename);
 164
 165 extern int bb_vfprintf(FILE * __restrict stream, const char * __restrict format,
 166                                            va_list arg) __attribute__ ((format (printf, 2, 0)));
 167 extern int bb_vprintf(const char * __restrict format, va_list arg)
 168         __attribute__ ((format (printf, 1, 0)));
 169 extern int bb_fprintf(FILE * __restrict stream, const char * __restrict format, ...)
 170         __attribute__ ((format (printf, 2, 3)));
 171 extern int bb_printf(const char * __restrict format, ...)
 172         __attribute__ ((format (printf, 1, 2)));
 173
 174 //#warning rename to xferror_filename?
 175 extern void bb_xferror(FILE *fp, const char *fn);
 176 extern void bb_xferror_stdout(void);
 177 extern void bb_xfflush_stdout(void);
 178
 179 extern void bb_warn_ignoring_args(int n);
 180
 181 extern void chomp(char *s);
 182 extern void trim(char *s);
 183 extern const char *bb_skip_whitespace(const char *);
 184
 185 extern struct BB_applet *find_applet_by_name(const char *name);
 186 void run_applet_by_name(const char *name, int argc, char **argv);
 187
 188 //#warning is this needed anymore?
 189 #ifndef DMALLOC
 190 extern void *xmalloc (size_t size);
 191 extern void *xrealloc(void *old, size_t size);
 192 extern void *xcalloc(size_t nmemb, size_t size);
 193 extern char *bb_xstrdup (const char *s);
 194 #endif
 195 extern char *bb_xstrndup (const char *s, int n);
 196 extern char * safe_strncpy(char *dst, const char *src, size_t size);
 197
 198 struct suffix_mult {
 199         const char *suffix;
 200         unsigned int mult;
 201 };
 202
 203 extern unsigned long bb_xgetularg_bnd_sfx(const char *arg, int base,
 204                                                                                   unsigned long lower,
 205                                                                                   unsigned long upper,
 206                                                                                   const struct suffix_mult *suffixes);
 207 extern unsigned long bb_xgetularg_bnd(const char *arg, int base,
 208                                                                           unsigned long lower,
 209                                                                           unsigned long upper);
 210 extern unsigned long bb_xgetularg10_bnd(const char *arg,
 211                                                                                 unsigned long lower,
 212                                                                                 unsigned long upper);
 213 extern unsigned long bb_xgetularg10(const char *arg);
 214
 215 extern long bb_xgetlarg_bnd_sfx(const char *arg, int base,
 216                                                                 long lower,
 217                                                                 long upper,
 218                                                                 const struct suffix_mult *suffixes);
 219 extern long bb_xgetlarg10_sfx(const char *arg, const struct suffix_mult *suffixes);
 220
 221
 222 //#warning pitchable now?
 223 extern unsigned long bb_xparse_number(const char *numstr,
 224                 const struct suffix_mult *suffixes);
 225
 226
 227 //#warning change names?
 228
 229 /* These parse entries in /etc/passwd and /etc/group.  This is desirable
 230  * for BusyBox since we want to avoid using the glibc NSS stuff, which
 231  * increases target size and is often not needed embedded systems.  */
 232 extern long my_getpwnam(const char *name);
 233 extern long my_getgrnam(const char *name);
 234 extern char * my_getpwuid(char *name, long uid);
 235 extern char * my_getgrgid(char *group, long gid);
 236 extern long my_getpwnamegid(const char *name);
 237
 238 extern int device_open(const char *device, int mode);
 239
 240 extern int del_loop(const char *device);
 241 extern int set_loop(const char *device, const char *file, int offset, int *loopro);
 242 extern char *find_unused_loop_device (void);
 243
 244
 245 #if (__GLIBC__ < 2)
 246 extern int vdprintf(int d, const char *format, va_list ap);
 247 #endif
 248
 249 int nfsmount(const char *spec, const char *node, int *flags,
 250              char **extra_opts, char **mount_opts, int running_bg);
 251
 252 void syslog_msg_with_name(const char *name, int facility, int pri, const char *msg);
 253 void syslog_msg(int facility, int pri, const char *msg);
 254
 255 /* Include our own copy of struct sysinfo to avoid binary compatability
 256  * problems with Linux 2.4, which changed things.  Grumble, grumble. */
 257 struct sysinfo {
 258         long uptime;                    /* Seconds since boot */
 259         unsigned long loads[3];         /* 1, 5, and 15 minute load averages */
 260         unsigned long totalram;         /* Total usable main memory size */
 261         unsigned long freeram;          /* Available memory size */
 262         unsigned long sharedram;        /* Amount of shared memory */
 263         unsigned long bufferram;        /* Memory used by buffers */
 264         unsigned long totalswap;        /* Total swap space size */
 265         unsigned long freeswap;         /* swap space still available */
 266         unsigned short procs;           /* Number of current processes */
 267         unsigned short pad;                     /* Padding needed for m68k */
 268         unsigned long totalhigh;        /* Total high memory size */
 269         unsigned long freehigh;         /* Available high memory size */
 270         unsigned int mem_unit;          /* Memory unit size in bytes */
 271         char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
 272 };
 273 extern int sysinfo (struct sysinfo* info);
 274
 275 enum {
 276         KILOBYTE = 1024,
 277         MEGABYTE = (KILOBYTE*1024),
 278         GIGABYTE = (MEGABYTE*1024)
 279 };
 280 const char *make_human_readable_str(unsigned long size, unsigned long block_size, unsigned long display_unit);
 281
 282 int bb_ask_confirmation(void);
 283 int klogctl(int type, char * b, int len);
 284
 285 char *xgetcwd(char *cwd);
 286 char *xreadlink(const char *path);
 287 char *concat_path_file(const char *path, const char *filename);
 288 char *concat_subpath_file(const char *path, const char *filename);
 289 char *last_char_is(const char *s, int c);
 290
 291 extern long arith (const char *startbuf, int *errcode);
 292
 293 int read_package_field(const char *package_buffer, char **field_name, char **field_value);
 294 //#warning yuk!
 295 char *fgets_str(FILE *file, const char *terminating_string);
 296
 297 extern int uncompress(int fd_in, int fd_out);
 298 extern int inflate(int in, int out);
 299
 300 extern struct hostent *xgethostbyname(const char *name);
 301 extern struct hostent *xgethostbyname2(const char *name, int af);
 302 extern int create_icmp_socket(void);
 303 extern int create_icmp6_socket(void);
 304 extern int xconnect(const char *host, const char *port);
 305
 306 //#warning wrap this?
 307 char *dirname (char *path);
 308
 309 int bb_make_directory (char *path, long mode, int flags);
 310
 311 const char *u_signal_names(const char *str_sig, int *signo, int startnum);
 312 char *bb_simplify_path(const char *path);
 313
 314 enum {  /* DO NOT CHANGE THESE VALUES!  cp.c depends on them. */
 315         FILEUTILS_PRESERVE_STATUS = 1,
 316         FILEUTILS_DEREFERENCE = 2,
 317         FILEUTILS_RECUR = 4,
 318         FILEUTILS_FORCE = 8,
 319         FILEUTILS_INTERACTIVE = 16
 320 };
 321
 322 extern const char *bb_applet_name;
 323
 324 extern const char * const bb_msg_full_version;
 325 extern const char * const bb_msg_memory_exhausted;
 326 extern const char * const bb_msg_invalid_date;
 327 extern const char * const bb_msg_io_error;
 328 extern const char * const bb_msg_write_error;
 329 extern const char * const bb_msg_name_longer_than_foo;
 330 extern const char * const bb_msg_unknown;
 331 extern const char * const bb_msg_can_not_create_raw_socket;
 332 extern const char * const bb_msg_perm_denied_are_you_root;
 333 extern const char * const bb_msg_standard_input;
 334 extern const char * const bb_msg_standard_output;
 335
 336 extern const char * const bb_path_nologin_file;
 337 extern const char * const bb_path_passwd_file;
 338 extern const char * const bb_path_shadow_file;
 339 extern const char * const bb_path_gshadow_file;
 340 extern const char * const bb_path_group_file;
 341 extern const char * const bb_path_securetty_file;
 342 extern const char * const bb_path_motd_file;
 343
 344 extern const char bb_path_mtab_file[];
 345
 346 extern int bb_default_error_retval;
 347
 348 #ifdef CONFIG_FEATURE_DEVFS
 349 # define CURRENT_VC "/dev/vc/0"
 350 # define VC_1 "/dev/vc/1"
 351 # define VC_2 "/dev/vc/2"
 352 # define VC_3 "/dev/vc/3"
 353 # define VC_4 "/dev/vc/4"
 354 # define VC_5 "/dev/vc/5"
 355 # define SC_0 "/dev/tts/0"
 356 # define SC_1 "/dev/tts/1"
 357 # define VC_FORMAT "/dev/vc/%d"
 358 # define SC_FORMAT "/dev/tts/%d"
 359 # define LOOP_FORMAT "/dev/loop/%d"
 360 #else
 361 # define CURRENT_VC "/dev/tty0"
 362 # define VC_1 "/dev/tty1"
 363 # define VC_2 "/dev/tty2"
 364 # define VC_3 "/dev/tty3"
 365 # define VC_4 "/dev/tty4"
 366 # define VC_5 "/dev/tty5"
 367 # define SC_0 "/dev/ttyS0"
 368 # define SC_1 "/dev/ttyS1"
 369 # define VC_FORMAT "/dev/tty%d"
 370 # define SC_FORMAT "/dev/ttyS%d"
 371 # define LOOP_FORMAT "/dev/loop%d"
 372 #endif
 373
 374 //#warning put these in .o files
 375
 376 /* The following devices are the same on devfs and non-devfs systems.  */
 377 #define CURRENT_TTY "/dev/tty"
 378 #define CONSOLE_DEV "/dev/console"
 379
 380 int is_in_ino_dev_hashtable(const struct stat *statbuf, char **name);
 381 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
 382 void reset_ino_dev_hashtable(void);
 383
 384 /* Stupid gcc always includes its own builtin strlen()... */
 385 extern size_t bb_strlen(const char *string);
 386 #define strlen(x)   bb_strlen(x)
 387
 388 void bb_xasprintf(char **string_ptr, const char *format, ...) __attribute__ ((format (printf, 2, 3)));
 389
 390
 391 #define FAIL_DELAY    3
 392 extern void change_identity ( const struct passwd *pw );
 393 extern void run_shell ( const char *shell, int loginshell, const char *command, const char **additional_args );
 394 extern int run_parts(char **args, const unsigned char test_mode);
 395 extern int restricted_shell ( const char *shell );
 396 extern void setup_environment ( const char *shell, int loginshell, int changeenv, const struct passwd *pw );
 397 extern int correct_password ( const struct passwd *pw );
 398 extern char *pw_encrypt(const char *clear, const char *salt);
 399 extern struct spwd *pwd_to_spwd(const struct passwd *pw);
 400 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp);
 401
 402 extern int bb_xopen(const char *pathname, int flags);
 403 extern ssize_t bb_xread(int fd, void *buf, size_t count);
 404 extern void bb_xread_all(int fd, void *buf, size_t count);
 405 extern unsigned char bb_xread_char(int fd);
 406
 407 typedef struct {
 408         int pid;
 409         char user[9];
 410         char state[4];
 411         unsigned long rss;
 412         int ppid;
 413 #ifdef FEATURE_CPU_USAGE_PERCENTAGE
 414         unsigned pcpu;
 415         unsigned long stime, utime;
 416 #endif
 417         char *cmd;
 418
 419         /* basename of executable file in call to exec(2),
 420                 size from kernel headers */
 421         char short_cmd[16];
 422 } procps_status_t;
 423
 424 extern procps_status_t * procps_scan(int save_user_arg0);
 425 extern unsigned short compare_string_array(const char *string_array[], const char *key);
 426
 427 extern int my_query_module(const char *name, int which, void **buf, size_t *bufsize, size_t *ret);
 428
 429 typedef struct llist_s {
 430         char *data;
 431         struct llist_s *link;
 432 } llist_t;
 433 extern llist_t *llist_add_to(llist_t *old_head, char *new_item);
 434
 435 void print_login_issue(const char *issue_file, const char *tty);
 436 void print_login_prompt(void);
 437
 438 #endif /* __LIBCONFIG_H__ */