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