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