include/libbb.h

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * Busybox main internal header file
   4  *
   5  * Licensed under the GPL v2 or later, see the file LICENSE in this tarball.
   6  *
   7  * Based in part on code from sash, Copyright (c) 1999 by David I. Bell
   8  * Permission has been granted to redistribute this code under the GPL.
   9  *
  10  */
  11 #ifndef __LIBBUSYBOX_H__
  12 #define __LIBBUSYBOX_H__    1
  13
  14 #include <stdio.h>
  15 #include <stdlib.h>
  16 #include <stdarg.h>
  17 #include <sys/types.h>
  18 #include <sys/stat.h>
  19 #include <termios.h>
  20 #include <stdint.h>
  21
  22 #include <netinet/in.h>
  23 #include <netdb.h>
  24
  25 #include <features.h>
  26
  27 #include "platform.h"
  28 #include "bb_config.h"
  29 #ifdef CONFIG_SELINUX
  30 #include <selinux/selinux.h>
  31 #endif
  32
  33 #include "pwd_.h"
  34 #include "grp_.h"
  35 #ifdef CONFIG_FEATURE_SHADOWPASSWDS
  36 #include "shadow_.h"
  37 #endif
  38 #ifdef CONFIG_FEATURE_SHA1_PASSWORDS
  39 # include "sha1.h"
  40 #endif
  41
  42 /* Some useful definitions */
  43 #define FALSE   ((int) 0)
  44 #define TRUE    ((int) 1)
  45 #define SKIP    ((int) 2)
  46
  47 /* for mtab.c */
  48 #define MTAB_GETMOUNTPT '1'
  49 #define MTAB_GETDEVICE  '2'
  50
  51 #define BUF_SIZE        8192
  52 #define EXPAND_ALLOC    1024
  53
  54 /* Macros for min/max.  */
  55 #ifndef MIN
  56 #define MIN(a,b) (((a)<(b))?(a):(b))
  57 #endif
  58
  59 #ifndef MAX
  60 #define MAX(a,b) (((a)>(b))?(a):(b))
  61 #endif
  62
  63 /* buffer allocation schemes */
  64 #ifdef CONFIG_FEATURE_BUFFERS_GO_ON_STACK
  65 #define RESERVE_CONFIG_BUFFER(buffer,len)           char buffer[len]
  66 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
  67 #define RELEASE_CONFIG_BUFFER(buffer)      ((void)0)
  68 #else
  69 #ifdef CONFIG_FEATURE_BUFFERS_GO_IN_BSS
  70 #define RESERVE_CONFIG_BUFFER(buffer,len)  static          char buffer[len]
  71 #define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
  72 #define RELEASE_CONFIG_BUFFER(buffer)      ((void)0)
  73 #else
  74 #define RESERVE_CONFIG_BUFFER(buffer,len)           char *buffer=xmalloc(len)
  75 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer=xmalloc(len)
  76 #define RELEASE_CONFIG_BUFFER(buffer)      free (buffer)
  77 #endif
  78 #endif
  79
  80
  81 extern void bb_show_usage(void) ATTRIBUTE_NORETURN ATTRIBUTE_EXTERNALLY_VISIBLE;
  82 extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
  83 extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
  84 extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
  85 extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
  86 extern void bb_vherror_msg(const char *s, va_list p);
  87 extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
  88 extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
  89
  90 extern void bb_perror_nomsg_and_die(void) ATTRIBUTE_NORETURN;
  91 extern void bb_perror_nomsg(void);
  92
  93 /* These two are used internally -- you shouldn't need to use them */
  94 extern void bb_verror_msg(const char *s, va_list p) __attribute__ ((format (printf, 1, 0)));
  95 extern void bb_vperror_msg(const char *s, va_list p)  __attribute__ ((format (printf, 1, 0)));
  96
  97 extern int bb_echo(int argc, char** argv);
  98
  99 extern const char *bb_mode_string(int mode);
 100 extern int is_directory(const char *name, int followLinks, struct stat *statBuf);
 101
 102 extern int remove_file(const char *path, int flags);
 103 extern int copy_file(const char *source, const char *dest, int flags);
 104 extern ssize_t safe_read(int fd, void *buf, size_t count);
 105 extern ssize_t bb_full_read(int fd, void *buf, size_t len);
 106 extern ssize_t safe_write(int fd, const void *buf, size_t count);
 107 extern ssize_t bb_full_write(int fd, const void *buf, size_t len);
 108 extern int recursive_action(const char *fileName, int recurse,
 109           int followLinks, int depthFirst,
 110           int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData),
 111           int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData),
 112           void* userData);
 113
 114 extern int bb_parse_mode( const char* s, mode_t* theMode);
 115 extern long bb_xgetlarg(const char *arg, int base, long lower, long upper);
 116
 117 extern unsigned long bb_baud_to_value(speed_t speed);
 118 extern speed_t bb_value_to_baud(unsigned long value);
 119
 120 extern int get_kernel_revision(void);
 121
 122 extern int get_console_fd(void);
 123 extern struct mntent *find_mount_point(const char *name, const char *table);
 124 extern void erase_mtab(const char * name);
 125 extern long *find_pid_by_name( const char* pidName);
 126 extern long *pidlist_reverse(long *pidList);
 127 extern char *find_block_device(char *path);
 128 extern char *bb_get_line_from_file(FILE *file);
 129 extern char *bb_get_chomped_line_from_file(FILE *file);
 130 extern char *bb_get_chunk_from_file(FILE *file, int *end);
 131 extern int bb_copyfd_size(int fd1, int fd2, const off_t size);
 132 extern int bb_copyfd_eof(int fd1, int fd2);
 133 extern void  bb_xprint_and_close_file(FILE *file);
 134 extern int   bb_xprint_file_by_name(const char *filename);
 135 extern char  bb_process_escape_sequence(const char **ptr);
 136 extern char *bb_get_last_path_component(char *path);
 137 extern FILE *bb_wfopen(const char *path, const char *mode);
 138 extern FILE *bb_wfopen_input(const char *filename);
 139 extern FILE *bb_xfopen(const char *path, const char *mode);
 140
 141 extern int   bb_fclose_nonstdin(FILE *f);
 142 extern void  bb_fflush_stdout_and_exit(int retval) ATTRIBUTE_NORETURN;
 143
 144 extern void xstat(const char *filename, struct stat *buf);
 145
 146 #define BB_GETOPT_ERROR 0x80000000UL
 147 extern const char *bb_opt_complementally;
 148 extern const struct option *bb_applet_long_options;
 149 extern unsigned long bb_getopt_ulflags(int argc, char **argv, const char *applet_opts, ...);
 150
 151 extern int bb_vfprintf(FILE * __restrict stream, const char * __restrict format,
 152                                            va_list arg) __attribute__ ((format (printf, 2, 0)));
 153 extern int bb_vprintf(const char * __restrict format, va_list arg)
 154         __attribute__ ((format (printf, 1, 0)));
 155 extern int bb_fprintf(FILE * __restrict stream, const char * __restrict format, ...)
 156         __attribute__ ((format (printf, 2, 3)));
 157 extern int bb_printf(const char * __restrict format, ...)
 158         __attribute__ ((format (printf, 1, 2)));
 159
 160 //#warning rename to xferror_filename?
 161 extern void bb_xferror(FILE *fp, const char *fn);
 162 extern void bb_xferror_stdout(void);
 163 extern void bb_xfflush_stdout(void);
 164
 165 extern void bb_warn_ignoring_args(int n);
 166
 167 extern void chomp(char *s);
 168 extern void trim(char *s);
 169 extern const char *bb_skip_whitespace(const char *);
 170
 171 extern struct BB_applet *find_applet_by_name(const char *name);
 172 void run_applet_by_name(const char *name, int argc, char **argv);
 173
 174 /* dmalloc will redefine these to it's own implementation. It is safe
 175  * to have the prototypes here unconditionally.  */
 176 extern void *xmalloc(size_t size);
 177 extern void *xrealloc(void *old, size_t size);
 178 extern void *xcalloc(size_t nmemb, size_t size);
 179
 180 extern char *bb_xstrdup (const char *s);
 181 extern char *bb_xstrndup (const char *s, int n);
 182 extern char *safe_strncpy(char *dst, const char *src, size_t size);
 183 extern int safe_strtoi(char *arg, int* value);
 184 extern int safe_strtod(char *arg, double* value);
 185 extern int safe_strtol(char *arg, long* value);
 186 extern int safe_strtoul(char *arg, unsigned long* value);
 187
 188 struct suffix_mult {
 189         const char *suffix;
 190         unsigned int mult;
 191 };
 192
 193 extern unsigned long bb_xgetularg_bnd_sfx(const char *arg, int base,
 194                                                                                   unsigned long lower,
 195                                                                                   unsigned long upper,
 196                                                                                   const struct suffix_mult *suffixes);
 197 extern unsigned long bb_xgetularg_bnd(const char *arg, int base,
 198                                                                           unsigned long lower,
 199                                                                           unsigned long upper);
 200 extern unsigned long bb_xgetularg10_bnd(const char *arg,
 201                                                                                 unsigned long lower,
 202                                                                                 unsigned long upper);
 203 extern unsigned long bb_xgetularg10(const char *arg);
 204
 205 extern long bb_xgetlarg_bnd_sfx(const char *arg, int base,
 206                                                                 long lower,
 207                                                                 long upper,
 208                                                                 const struct suffix_mult *suffixes);
 209 extern long bb_xgetlarg10_sfx(const char *arg, const struct suffix_mult *suffixes);
 210
 211
 212 //#warning pitchable now?
 213 extern unsigned long bb_xparse_number(const char *numstr,
 214                 const struct suffix_mult *suffixes);
 215
 216
 217 /* These parse entries in /etc/passwd and /etc/group.  This is desirable
 218  * for BusyBox since we want to avoid using the glibc NSS stuff, which
 219  * increases target size and is often not needed on embedded systems.  */
 220 extern long bb_xgetpwnam(const char *name);
 221 extern long bb_xgetgrnam(const char *name);
 222 extern char * bb_getug(char *buffer, char *idname, long id, int bufsize, char prefix);
 223 extern char * bb_getpwuid(char *name, long uid, int bufsize);
 224 extern char * bb_getgrgid(char *group, long gid, int bufsize);
 225 extern char *bb_askpass(int timeout, const char * prompt);
 226
 227 extern int device_open(const char *device, int mode);
 228
 229 extern char *query_loop(const char *device);
 230 extern int del_loop(const char *device);
 231 extern int set_loop(char **device, const char *file, int offset);
 232
 233 #if (__GLIBC__ < 2)
 234 extern int vdprintf(int d, const char *format, va_list ap);
 235 #endif
 236
 237 int nfsmount(const char *spec, const char *node, int *flags,
 238              char **mount_opts, int running_bg);
 239
 240 /* Include our own copy of struct sysinfo to avoid binary compatibility
 241  * problems with Linux 2.4, which changed things.  Grumble, grumble. */
 242 struct sysinfo {
 243         long uptime;                    /* Seconds since boot */
 244         unsigned long loads[3];         /* 1, 5, and 15 minute load averages */
 245         unsigned long totalram;         /* Total usable main memory size */
 246         unsigned long freeram;          /* Available memory size */
 247         unsigned long sharedram;        /* Amount of shared memory */
 248         unsigned long bufferram;        /* Memory used by buffers */
 249         unsigned long totalswap;        /* Total swap space size */
 250         unsigned long freeswap;         /* swap space still available */
 251         unsigned short procs;           /* Number of current processes */
 252         unsigned short pad;                     /* Padding needed for m68k */
 253         unsigned long totalhigh;        /* Total high memory size */
 254         unsigned long freehigh;         /* Available high memory size */
 255         unsigned int mem_unit;          /* Memory unit size in bytes */
 256         char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
 257 };
 258 extern int sysinfo (struct sysinfo* info);
 259
 260 enum {
 261         KILOBYTE = 1024,
 262         MEGABYTE = (KILOBYTE*1024),
 263         GIGABYTE = (MEGABYTE*1024)
 264 };
 265 const char *make_human_readable_str(unsigned long long size,
 266                 unsigned long block_size, unsigned long display_unit);
 267
 268 int bb_ask_confirmation(void);
 269 int klogctl(int type, char * b, int len);
 270
 271 char *xgetcwd(char *cwd);
 272 char *xreadlink(const char *path);
 273 char *concat_path_file(const char *path, const char *filename);
 274 char *concat_subpath_file(const char *path, const char *filename);
 275 char *last_char_is(const char *s, int c);
 276
 277 int read_package_field(const char *package_buffer, char **field_name, char **field_value);
 278 //#warning yuk!
 279 char *fgets_str(FILE *file, const char *terminating_string);
 280
 281 extern int uncompress(int fd_in, int fd_out);
 282 extern int inflate(int in, int out);
 283
 284 extern struct hostent *xgethostbyname(const char *name);
 285 extern struct hostent *xgethostbyname2(const char *name, int af);
 286 extern int create_icmp_socket(void);
 287 extern int create_icmp6_socket(void);
 288 extern int xconnect(struct sockaddr_in *s_addr);
 289 extern unsigned short bb_lookup_port(const char *port, const char *protocol, unsigned short default_port);
 290 extern void bb_lookup_host(struct sockaddr_in *s_in, const char *host);
 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_read_error;
 315 extern const char * const bb_msg_write_error;
 316 extern const char * const bb_msg_name_longer_than_foo;
 317 extern const char * const bb_msg_unknown;
 318 extern const char * const bb_msg_can_not_create_raw_socket;
 319 extern const char * const bb_msg_perm_denied_are_you_root;
 320 extern const char * const bb_msg_standard_input;
 321 extern const char * const bb_msg_standard_output;
 322
 323 extern const char * const bb_path_nologin_file;
 324 extern const char * const bb_path_passwd_file;
 325 extern const char * const bb_path_shadow_file;
 326 extern const char * const bb_path_gshadow_file;
 327 extern const char * const bb_path_group_file;
 328 extern const char * const bb_path_securetty_file;
 329 extern const char * const bb_path_motd_file;
 330 extern const char * const bb_dev_null;
 331
 332 #ifndef BUFSIZ
 333 #define BUFSIZ 4096
 334 #endif
 335 extern char bb_common_bufsiz1[BUFSIZ+1];
 336
 337 /*
 338  * You can change LIBBB_DEFAULT_LOGIN_SHELL, but don`t use,
 339  * use bb_default_login_shell and next defines,
 340  * if you LIBBB_DEFAULT_LOGIN_SHELL change,
 341  * don`t lose change increment constant!
 342  */
 343 #define LIBBB_DEFAULT_LOGIN_SHELL      "-/bin/sh"
 344
 345 extern const char * const bb_default_login_shell;
 346 /* "/bin/sh" */
 347 #define DEFAULT_SHELL     (bb_default_login_shell+1)
 348 /* "sh" */
 349 #define DEFAULT_SHELL_SHORT_NAME     (bb_default_login_shell+6)
 350
 351
 352 extern const char bb_path_mtab_file[];
 353
 354 extern int bb_default_error_retval;
 355
 356 #ifdef CONFIG_FEATURE_DEVFS
 357 # define CURRENT_VC "/dev/vc/0"
 358 # define VC_1 "/dev/vc/1"
 359 # define VC_2 "/dev/vc/2"
 360 # define VC_3 "/dev/vc/3"
 361 # define VC_4 "/dev/vc/4"
 362 # define VC_5 "/dev/vc/5"
 363 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
 364 /* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
 365    respective serial ports .. as such, we can't use the common device paths for
 366    these. -- PFM */
 367 #  define SC_0 "/dev/ttsc/0"
 368 #  define SC_1 "/dev/ttsc/1"
 369 #  define SC_FORMAT "/dev/ttsc/%d"
 370 #else
 371 #  define SC_0 "/dev/tts/0"
 372 #  define SC_1 "/dev/tts/1"
 373 #  define SC_FORMAT "/dev/tts/%d"
 374 #endif
 375 # define VC_FORMAT "/dev/vc/%d"
 376 # define LOOP_FORMAT "/dev/loop/%d"
 377 # define FB_0 "/dev/fb/0"
 378 #else
 379 # define CURRENT_VC "/dev/tty0"
 380 # define VC_1 "/dev/tty1"
 381 # define VC_2 "/dev/tty2"
 382 # define VC_3 "/dev/tty3"
 383 # define VC_4 "/dev/tty4"
 384 # define VC_5 "/dev/tty5"
 385 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
 386 #  define SC_0 "/dev/ttySC0"
 387 #  define SC_1 "/dev/ttySC1"
 388 #  define SC_FORMAT "/dev/ttySC%d"
 389 #else
 390 #  define SC_0 "/dev/ttyS0"
 391 #  define SC_1 "/dev/ttyS1"
 392 #  define SC_FORMAT "/dev/ttyS%d"
 393 #endif
 394 # define VC_FORMAT "/dev/tty%d"
 395 # define LOOP_FORMAT "/dev/loop%d"
 396 # define FB_0 "/dev/fb0"
 397 #endif
 398
 399 //#warning put these in .o files
 400
 401 /* The following devices are the same on devfs and non-devfs systems.  */
 402 #define CURRENT_TTY "/dev/tty"
 403 #define CONSOLE_DEV "/dev/console"
 404
 405 int is_in_ino_dev_hashtable(const struct stat *statbuf, char **name);
 406 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
 407 void reset_ino_dev_hashtable(void);
 408
 409 /* Stupid gcc always includes its own builtin strlen()... */
 410 extern size_t bb_strlen(const char *string);
 411 #ifndef BB_STRLEN_IMPLEMENTATION
 412 #define strlen(x)   bb_strlen(x)
 413 #endif
 414
 415 char *bb_xasprintf(const char *format, ...) __attribute__ ((format (printf, 1, 2)));
 416
 417 #define FAIL_DELAY    3
 418 extern void bb_do_delay(int seconds);
 419 extern void change_identity ( const struct passwd *pw );
 420 extern const char *change_identity_e2str ( const struct passwd *pw );
 421 extern void run_shell ( const char *shell, int loginshell, const char *command, const char **additional_args);
 422 #ifdef CONFIG_SELINUX
 423 extern void renew_current_security_context(void);
 424 extern void set_current_security_context(security_context_t sid);
 425 #endif
 426 extern int run_parts(char **args, const unsigned char test_mode, char **env);
 427 extern int restricted_shell ( const char *shell );
 428 extern void setup_environment ( const char *shell, int loginshell, int changeenv, const struct passwd *pw );
 429 extern int correct_password ( const struct passwd *pw );
 430 extern char *pw_encrypt(const char *clear, const char *salt);
 431 extern struct spwd *pwd_to_spwd(const struct passwd *pw);
 432 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp);
 433
 434 extern int bb_xopen(const char *pathname, int flags);
 435 extern ssize_t bb_xread(int fd, void *buf, size_t count);
 436 extern void bb_xread_all(int fd, void *buf, size_t count);
 437 extern unsigned char bb_xread_char(int fd);
 438
 439 #ifndef COMM_LEN
 440 /*#include <sched.h> *//* Task command name length */
 441 #ifdef TASK_COMM_LEN
 442 #define COMM_LEN TASK_COMM_LEN
 443 #else
 444 #define COMM_LEN 16 /* synchronize with size of comm in struct task_struct
 445                                                                   in /usr/include/linux/sched.h */
 446 #endif
 447 #endif
 448 typedef struct {
 449         int pid;
 450         char user[9];
 451         char state[4];
 452         unsigned long rss;
 453         int ppid;
 454 #ifdef CONFIG_FEATURE_TOP_CPU_USAGE_PERCENTAGE
 455         unsigned pcpu;
 456         unsigned pscpu;
 457         unsigned long stime, utime;
 458 #endif
 459         char *cmd;
 460
 461         /* basename of executable file in call to exec(2),
 462                 size from kernel headers */
 463         char short_cmd[COMM_LEN];
 464 } procps_status_t;
 465
 466 extern procps_status_t * procps_scan(int save_user_arg0);
 467 extern int compare_string_array(const char * const string_array[], const char *key);
 468
 469 extern int my_query_module(const char *name, int which, void **buf, size_t *bufsize, size_t *ret);
 470
 471 typedef struct llist_s {
 472         char *data;
 473         struct llist_s *link;
 474 } llist_t;
 475 extern llist_t *llist_add_to(llist_t *old_head, char *new_item);
 476 extern llist_t *llist_add_to_end(llist_t *list_head, char *data);
 477 extern llist_t *llist_free_one(llist_t *elm);
 478 extern void llist_free(llist_t *elm);
 479
 480 extern void print_login_issue(const char *issue_file, const char *tty);
 481 extern void print_login_prompt(void);
 482
 483 #if defined(__uClinux__)
 484 extern void vfork_daemon_rexec(int nochdir, int noclose,
 485                 int argc, char **argv, char *foreground_opt);
 486 #endif
 487
 488 extern int get_terminal_width_height(int fd, int *width, int *height);
 489 extern unsigned long get_ug_id(const char *s, long (*__bb_getxxnam)(const char *));
 490
 491 typedef struct _sha1_ctx_t_ {
 492         uint32_t count[2];
 493         uint32_t hash[5];
 494         uint32_t wbuf[16];
 495 } sha1_ctx_t;
 496
 497 void sha1_begin(sha1_ctx_t *ctx);
 498 void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx);
 499 void *sha1_end(void *resbuf, sha1_ctx_t *ctx);
 500
 501 typedef struct _md5_ctx_t_ {
 502         uint32_t A;
 503         uint32_t B;
 504         uint32_t C;
 505         uint32_t D;
 506         uint32_t total[2];
 507         uint32_t buflen;
 508         char buffer[128];
 509 } md5_ctx_t;
 510
 511 void md5_begin(md5_ctx_t *ctx);
 512 void md5_hash(const void *data, size_t length, md5_ctx_t *ctx);
 513 void *md5_end(void *resbuf, md5_ctx_t *ctx);
 514
 515 extern uint32_t *bb_crc32_filltable (int endian);
 516
 517 /* busybox.h will include dmalloc later for us, else include it here.  */
 518 #if !defined _BB_INTERNAL_H_ && defined DMALLOC
 519 #include <dmalloc.h>
 520 #endif
 521
 522 #endif /* __LIBBUSYBOX_H__ */