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