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 <stdlib.h>
  29 #include <stdarg.h>
  30 #include <sys/stat.h>
  31 #include <sys/types.h>
  32 #include <regex.h>
  33 #include <termios.h>
  34 #include <stdint.h>
  35
  36 #include <netdb.h>
  37
  38 #ifdef DMALLOC
  39 #include <dmalloc.h>
  40 #endif
  41
  42 #include <features.h>
  43
  44 #include "config.h"
  45 #ifdef CONFIG_SELINUX
  46 #include <selinux/selinux.h>
  47 #endif
  48
  49 #include "pwd_.h"
  50 #include "grp_.h"
  51 #ifdef CONFIG_FEATURE_SHADOWPASSWDS
  52 #include "shadow_.h"
  53 #endif
  54 #ifdef CONFIG_FEATURE_SHA1_PASSWORDS
  55 # include "sha1.h"
  56 #endif
  57
  58 /* Convenience macros to test the version of gcc. */
  59 #if defined __GNUC__ && defined __GNUC_MINOR__
  60 # define __GNUC_PREREQ(maj, min) \
  61         ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
  62 #else
  63 # define __GNUC_PREREQ(maj, min) 0
  64 #endif
  65
  66 /* __restrict is known in EGCS 1.2 and above. */
  67 #if !__GNUC_PREREQ (2,92)
  68 # define __restrict     /* Ignore */
  69 #endif
  70
  71 /* Some useful definitions */
  72 #define FALSE   ((int) 0)
  73 #define TRUE    ((int) 1)
  74 #define SKIP    ((int) 2)
  75
  76 /* for mtab.c */
  77 #define MTAB_GETMOUNTPT '1'
  78 #define MTAB_GETDEVICE  '2'
  79
  80 #define BUF_SIZE        8192
  81 #define EXPAND_ALLOC    1024
  82
  83 /* Macros for min/max.  */
  84 #ifndef MIN
  85 #define MIN(a,b) (((a)<(b))?(a):(b))
  86 #endif
  87
  88 #ifndef MAX
  89 #define MAX(a,b) (((a)>(b))?(a):(b))
  90 #endif
  91
  92 extern void bb_show_usage(void) __attribute__ ((noreturn));
  93 extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
  94 extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
  95 extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
  96 extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
  97 extern void bb_vherror_msg(const char *s, va_list p);
  98 extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
  99 extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
 100
 101 extern void bb_perror_nomsg_and_die(void) __attribute__ ((noreturn));
 102 extern void bb_perror_nomsg(void);
 103
 104 /* These two are used internally -- you shouldn't need to use them */
 105 extern void bb_verror_msg(const char *s, va_list p) __attribute__ ((format (printf, 1, 0)));
 106 extern void bb_vperror_msg(const char *s, va_list p)  __attribute__ ((format (printf, 1, 0)));
 107
 108 extern const char *bb_mode_string(int mode);
 109 extern int is_directory(const char *name, int followLinks, struct stat *statBuf);
 110
 111 extern int remove_file(const char *path, int flags);
 112 extern int copy_file(const char *source, const char *dest, int flags);
 113 extern ssize_t safe_read(int fd, void *buf, size_t count);
 114 extern ssize_t bb_full_read(int fd, void *buf, size_t len);
 115 extern ssize_t safe_write(int fd, const void *buf, size_t count);
 116 extern ssize_t bb_full_write(int fd, const void *buf, size_t len);
 117 extern int recursive_action(const char *fileName, int recurse,
 118           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 bb_parse_mode( const char* s, mode_t* theMode);
 124 extern long bb_xgetlarg(const char *arg, int base, long lower, long upper);
 125
 126 extern unsigned long bb_baud_to_value(speed_t speed);
 127 extern speed_t bb_value_to_baud(unsigned long value);
 128
 129 extern int get_kernel_revision(void);
 130
 131 extern int get_console_fd(void);
 132 extern struct mntent *find_mount_point(const char *name, const char *table);
 133 extern void write_mtab(char* blockDevice, char* directory,
 134                                            char* filesystemType, long flags, char* string_flags);
 135 extern void erase_mtab(const char * name);
 136 extern long *find_pid_by_name( const char* pidName);
 137 extern char *find_real_root_device_name(void);
 138 extern char *bb_get_line_from_file(FILE *file);
 139 extern char *bb_get_chomped_line_from_file(FILE *file);
 140 extern char *bb_get_chunk_from_file(FILE *file);
 141 extern int bb_copyfd_size(int fd1, int fd2, const off_t size);
 142 extern int bb_copyfd_eof(int fd1, int fd2);
 143 extern void  bb_xprint_and_close_file(FILE *file);
 144 extern int   bb_xprint_file_by_name(const char *filename);
 145 extern char  bb_process_escape_sequence(const char **ptr);
 146 extern char *bb_get_last_path_component(char *path);
 147 extern FILE *bb_wfopen(const char *path, const char *mode);
 148 extern FILE *bb_xfopen(const char *path, const char *mode);
 149
 150 //#warning rename?
 151 extern int   bb_fclose_nonstdin(FILE *f);
 152 extern void  bb_fflush_stdout_and_exit(int retval) __attribute__ ((noreturn));
 153
 154 extern const char *bb_opt_complementaly;
 155 extern const struct option *bb_applet_long_options;
 156 extern unsigned long bb_getopt_ulflags(int argc, char **argv, const char *applet_opts, ...);
 157
 158 //#warning rename?
 159 extern FILE *bb_wfopen_input(const char *filename);
 160
 161 extern int bb_vfprintf(FILE * __restrict stream, const char * __restrict format,
 162                                            va_list arg) __attribute__ ((format (printf, 2, 0)));
 163 extern int bb_vprintf(const char * __restrict format, va_list arg)
 164         __attribute__ ((format (printf, 1, 0)));
 165 extern int bb_fprintf(FILE * __restrict stream, const char * __restrict format, ...)
 166         __attribute__ ((format (printf, 2, 3)));
 167 extern int bb_printf(const char * __restrict format, ...)
 168         __attribute__ ((format (printf, 1, 2)));
 169
 170 //#warning rename to xferror_filename?
 171 extern void bb_xferror(FILE *fp, const char *fn);
 172 extern void bb_xferror_stdout(void);
 173 extern void bb_xfflush_stdout(void);
 174
 175 extern void bb_warn_ignoring_args(int n);
 176
 177 extern void chomp(char *s);
 178 extern void trim(char *s);
 179 extern const char *bb_skip_whitespace(const char *);
 180
 181 extern struct BB_applet *find_applet_by_name(const char *name);
 182 void run_applet_by_name(const char *name, int argc, char **argv);
 183
 184 //#warning is this needed anymore?
 185 #ifndef DMALLOC
 186 extern void *xmalloc (size_t size);
 187 extern void *xrealloc(void *old, size_t size);
 188 extern void *xcalloc(size_t nmemb, size_t size);
 189 #endif
 190 extern char *bb_xstrdup (const char *s);
 191 extern char *bb_xstrndup (const char *s, int n);
 192 extern char *safe_strncpy(char *dst, const char *src, size_t size);
 193 extern int safe_strtoi(char *arg, int* value);
 194 extern int safe_strtod(char *arg, double* value);
 195 extern int safe_strtol(char *arg, long* value);
 196 extern int safe_strtoul(char *arg, unsigned long* value);
 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_getug(char *buffer, char *idname, long id, int bufsize, char prefix);
 235 extern char * my_getpwuid(char *name, long uid, int bufsize);
 236 extern char * my_getgrgid(char *group, long gid, int bufsize);
 237 extern char *bb_askpass(int timeout, const char * prompt);
 238
 239 extern int device_open(const char *device, int mode);
 240
 241 extern int del_loop(const char *device);
 242 extern int set_loop(const char *device, const char *file, int offset, int *loopro);
 243 extern char *find_unused_loop_device (void);
 244
 245
 246 #if (__GLIBC__ < 2)
 247 extern int vdprintf(int d, const char *format, va_list ap);
 248 #endif
 249
 250 int nfsmount(const char *spec, const char *node, int *flags,
 251              char **extra_opts, char **mount_opts, int running_bg);
 252
 253 /* Include our own copy of struct sysinfo to avoid binary compatability
 254  * problems with Linux 2.4, which changed things.  Grumble, grumble. */
 255 struct sysinfo {
 256         long uptime;                    /* Seconds since boot */
 257         unsigned long loads[3];         /* 1, 5, and 15 minute load averages */
 258         unsigned long totalram;         /* Total usable main memory size */
 259         unsigned long freeram;          /* Available memory size */
 260         unsigned long sharedram;        /* Amount of shared memory */
 261         unsigned long bufferram;        /* Memory used by buffers */
 262         unsigned long totalswap;        /* Total swap space size */
 263         unsigned long freeswap;         /* swap space still available */
 264         unsigned short procs;           /* Number of current processes */
 265         unsigned short pad;                     /* Padding needed for m68k */
 266         unsigned long totalhigh;        /* Total high memory size */
 267         unsigned long freehigh;         /* Available high memory size */
 268         unsigned int mem_unit;          /* Memory unit size in bytes */
 269         char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
 270 };
 271 extern int sysinfo (struct sysinfo* info);
 272
 273 enum {
 274         KILOBYTE = 1024,
 275         MEGABYTE = (KILOBYTE*1024),
 276         GIGABYTE = (MEGABYTE*1024)
 277 };
 278 const char *make_human_readable_str(unsigned long long size,
 279                 unsigned long block_size, unsigned long display_unit);
 280
 281 int bb_ask_confirmation(void);
 282 int klogctl(int type, char * b, int len);
 283
 284 char *xgetcwd(char *cwd);
 285 char *xreadlink(const char *path);
 286 char *concat_path_file(const char *path, const char *filename);
 287 char *concat_subpath_file(const char *path, const char *filename);
 288 char *last_char_is(const char *s, int c);
 289
 290 int read_package_field(const char *package_buffer, char **field_name, char **field_value);
 291 //#warning yuk!
 292 char *fgets_str(FILE *file, const char *terminating_string);
 293
 294 extern int uncompress(int fd_in, int fd_out);
 295 extern int inflate(int in, int out);
 296
 297 extern struct hostent *xgethostbyname(const char *name);
 298 extern struct hostent *xgethostbyname2(const char *name, int af);
 299 extern int create_icmp_socket(void);
 300 extern int create_icmp6_socket(void);
 301 extern int xconnect(struct sockaddr_in *s_addr);
 302 extern unsigned short bb_lookup_port(const char *port, const char *protocol, unsigned short default_port);
 303 extern void bb_lookup_host(struct sockaddr_in *s_in, const char *host);
 304
 305 //#warning wrap this?
 306 char *dirname (char *path);
 307
 308 int bb_make_directory (char *path, long mode, int flags);
 309
 310 const char *u_signal_names(const char *str_sig, int *signo, int startnum);
 311 char *bb_simplify_path(const char *path);
 312
 313 enum {  /* DO NOT CHANGE THESE VALUES!  cp.c depends on them. */
 314         FILEUTILS_PRESERVE_STATUS = 1,
 315         FILEUTILS_DEREFERENCE = 2,
 316         FILEUTILS_RECUR = 4,
 317         FILEUTILS_FORCE = 8,
 318         FILEUTILS_INTERACTIVE = 16
 319 };
 320
 321 extern const char *bb_applet_name;
 322
 323 extern const char * const bb_msg_full_version;
 324 extern const char * const bb_msg_memory_exhausted;
 325 extern const char * const bb_msg_invalid_date;
 326 extern const char * const bb_msg_io_error;
 327 extern const char * const bb_msg_read_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 /*
 345  * You can change LIBBB_DEFAULT_LOGIN_SHELL, but don`t use,
 346  * use bb_default_login_shell and next defines,
 347  * if you LIBBB_DEFAULT_LOGIN_SHELL change,
 348  * don`t lose change increment constant!
 349  */
 350 #define LIBBB_DEFAULT_LOGIN_SHELL      "-/bin/sh"
 351
 352 extern const char * const bb_default_login_shell;
 353 /* "/bin/sh" */
 354 #define DEFAULT_SHELL     (bb_default_login_shell+1)
 355 /* "sh" */
 356 #define DEFAULT_SHELL_SHORT_NAME     (bb_default_login_shell+6)
 357
 358
 359 extern const char bb_path_mtab_file[];
 360
 361 extern int bb_default_error_retval;
 362
 363 #ifdef CONFIG_FEATURE_DEVFS
 364 # define CURRENT_VC "/dev/vc/0"
 365 # define VC_1 "/dev/vc/1"
 366 # define VC_2 "/dev/vc/2"
 367 # define VC_3 "/dev/vc/3"
 368 # define VC_4 "/dev/vc/4"
 369 # define VC_5 "/dev/vc/5"
 370 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
 371 /* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
 372    respective serial ports .. as such, we can't use the common device paths for
 373    these. -- PFM */
 374 #  define SC_0 "/dev/ttsc/0"
 375 #  define SC_1 "/dev/ttsc/1"
 376 #  define SC_FORMAT "/dev/ttsc/%d"
 377 #else
 378 #  define SC_0 "/dev/tts/0"
 379 #  define SC_1 "/dev/tts/1"
 380 #  define SC_FORMAT "/dev/tts/%d"
 381 #endif
 382 # define VC_FORMAT "/dev/vc/%d"
 383 # define LOOP_FORMAT "/dev/loop/%d"
 384 # define FB_0 "/dev/fb/0"
 385 #else
 386 # define CURRENT_VC "/dev/tty0"
 387 # define VC_1 "/dev/tty1"
 388 # define VC_2 "/dev/tty2"
 389 # define VC_3 "/dev/tty3"
 390 # define VC_4 "/dev/tty4"
 391 # define VC_5 "/dev/tty5"
 392 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
 393 #  define SC_0 "/dev/ttySC0"
 394 #  define SC_1 "/dev/ttySC1"
 395 #  define SC_FORMAT "/dev/ttySC%d"
 396 #else
 397 #  define SC_0 "/dev/ttyS0"
 398 #  define SC_1 "/dev/ttyS1"
 399 #  define SC_FORMAT "/dev/ttyS%d"
 400 #endif
 401 # define VC_FORMAT "/dev/tty%d"
 402 # define LOOP_FORMAT "/dev/loop%d"
 403 # define FB_0 "/dev/fb0"
 404 #endif
 405
 406 //#warning put these in .o files
 407
 408 /* The following devices are the same on devfs and non-devfs systems.  */
 409 #define CURRENT_TTY "/dev/tty"
 410 #define CONSOLE_DEV "/dev/console"
 411
 412 int is_in_ino_dev_hashtable(const struct stat *statbuf, char **name);
 413 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
 414 void reset_ino_dev_hashtable(void);
 415
 416 /* Stupid gcc always includes its own builtin strlen()... */
 417 extern size_t bb_strlen(const char *string);
 418 #define strlen(x)   bb_strlen(x)
 419
 420 void bb_xasprintf(char **string_ptr, const char *format, ...) __attribute__ ((format (printf, 2, 3)));
 421
 422
 423 #define FAIL_DELAY    3
 424 extern void change_identity ( const struct passwd *pw );
 425 extern const char *change_identity_e2str ( const struct passwd *pw );
 426 extern void run_shell ( const char *shell, int loginshell, const char *command, const char **additional_args
 427 #ifdef CONFIG_SELINUX
 428         , security_context_t sid
 429 #endif
 430 );
 431 extern int run_parts(char **args, const unsigned char test_mode, char **env);
 432 extern int restricted_shell ( const char *shell );
 433 extern void setup_environment ( const char *shell, int loginshell, int changeenv, const struct passwd *pw );
 434 extern int correct_password ( const struct passwd *pw );
 435 extern char *pw_encrypt(const char *clear, const char *salt);
 436 extern struct spwd *pwd_to_spwd(const struct passwd *pw);
 437 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp);
 438
 439 extern int bb_xopen(const char *pathname, int flags);
 440 extern ssize_t bb_xread(int fd, void *buf, size_t count);
 441 extern void bb_xread_all(int fd, void *buf, size_t count);
 442 extern unsigned char bb_xread_char(int fd);
 443
 444 typedef struct {
 445         int pid;
 446         char user[9];
 447         char state[4];
 448         unsigned long rss;
 449         int ppid;
 450 #ifdef FEATURE_CPU_USAGE_PERCENTAGE
 451         unsigned pcpu;
 452         unsigned long stime, utime;
 453 #endif
 454         char *cmd;
 455
 456         /* basename of executable file in call to exec(2),
 457                 size from kernel headers */
 458         char short_cmd[16];
 459 } procps_status_t;
 460
 461 extern procps_status_t * procps_scan(int save_user_arg0
 462 #ifdef CONFIG_SELINUX
 463         , int use_selinux, security_context_t *sid
 464 #endif
 465 );
 466 extern unsigned short compare_string_array(const char *string_array[], const char *key);
 467
 468 extern int my_query_module(const char *name, int which, void **buf, size_t *bufsize, size_t *ret);
 469
 470 typedef struct llist_s {
 471         char *data;
 472         struct llist_s *link;
 473 } llist_t;
 474 extern llist_t *llist_add_to(llist_t *old_head, char *new_item);
 475
 476 extern void print_login_issue(const char *issue_file, const char *tty);
 477 extern void print_login_prompt(void);
 478
 479 extern void vfork_daemon_rexec(int nochdir, int noclose,
 480                 int argc, char **argv, char *foreground_opt);
 481 extern void get_terminal_width_height(int fd, int *width, int *height);
 482 extern unsigned long get_ug_id(const char *s, long (*my_getxxnam)(const char *));
 483 extern void xregcomp(regex_t *preg, const char *regex, int cflags);
 484
 485 #define HASH_SHA1       1
 486 #define HASH_MD5        2
 487 extern int hash_fd(int fd, const size_t size, const uint8_t hash_algo, uint8_t *hashval);
 488
 489 #endif /* __LIBCONFIG_H__ */