1 /* vi: set sw=4 ts=4: */
3 * Busybox main internal header file
5 * Based in part on code from sash, Copyright (c) 1999 by David I. Bell
6 * Permission has been granted to redistribute this code under the GPL.
8 * Licensed under the GPL version 2, see the file LICENSE in this tarball.
10 #ifndef __LIBBUSYBOX_H__
11 #define __LIBBUSYBOX_H__ 1
13 #include "bb_config.h"
30 #include <sys/ioctl.h>
32 #include <sys/socket.h>
34 #include <sys/statfs.h>
36 #include <sys/types.h>
44 #include <selinux/selinux.h>
47 #ifdef CONFIG_LOCALE_SUPPORT
50 #define setlocale(x,y)
57 /* Try to pull in PATH_MAX */
59 #include <sys/param.h>
64 /* Large file support */
66 # define FILEOFF_TYPE off64_t
67 # define FILEOFF_FMT "%lld"
68 # define LSEEK lseek64
70 # define LSTAT lstat64
71 # define STRUCT_STAT struct stat64
72 # define STRTOOFF strtoll
73 # define SAFE_STRTOOFF safe_strtoll
75 # define FILEOFF_TYPE off_t
76 # define FILEOFF_FMT "%ld"
80 # define STRUCT_STAT struct stat
81 # define STRTOOFF strtol
82 # define SAFE_STRTOOFF safe_strtol
83 /* Do we need to undefine O_LARGEFILE? */
85 /* scary. better ideas? (but do *test* them first!) */
86 #define MAX_FILEOFF_TYPE \
87 ((FILEOFF_TYPE)~((FILEOFF_TYPE)1 << (sizeof(FILEOFF_TYPE)*8-1)))
89 /* Some useful definitions */
91 #define FALSE ((int) 0)
93 #define TRUE ((int) 1)
95 #define SKIP ((int) 2)
98 #define MTAB_GETMOUNTPT '1'
99 #define MTAB_GETDEVICE '2'
101 #define BUF_SIZE 8192
102 #define EXPAND_ALLOC 1024
104 /* Macros for min/max. */
106 #define MIN(a,b) (((a)<(b))?(a):(b))
110 #define MAX(a,b) (((a)>(b))?(a):(b))
113 /* buffer allocation schemes */
114 #ifdef CONFIG_FEATURE_BUFFERS_GO_ON_STACK
115 #define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
116 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
117 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
119 #ifdef CONFIG_FEATURE_BUFFERS_GO_IN_BSS
120 #define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
121 #define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
122 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
124 #define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer=xmalloc(len)
125 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer=xmalloc(len)
126 #define RELEASE_CONFIG_BUFFER(buffer) free (buffer)
131 typedef struct llist_s {
133 struct llist_s *link;
135 extern void llist_add_to(llist_t **old_head, void *data);
136 extern void llist_add_to_end(llist_t **list_head, void *data);
137 extern void *llist_pop(llist_t **elm);
138 extern void llist_free(llist_t *elm, void (*freeit)(void *data));
143 LOGMODE_STDIO = 1<<0,
144 LOGMODE_SYSLOG = 1<<1,
145 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
147 extern const char *msg_eol;
149 extern int die_sleep;
151 extern void bb_show_usage(void) ATTRIBUTE_NORETURN ATTRIBUTE_EXTERNALLY_VISIBLE;
152 extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
153 extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
154 extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
155 extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
156 extern void bb_vherror_msg(const char *s, va_list p);
157 extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
158 extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
160 extern void bb_perror_nomsg_and_die(void) ATTRIBUTE_NORETURN;
161 extern void bb_perror_nomsg(void);
163 extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
165 /* These two are used internally -- you shouldn't need to use them */
166 extern void bb_verror_msg(const char *s, va_list p, const char *strerr) __attribute__ ((format (printf, 1, 0)));
167 extern void bb_vperror_msg(const char *s, va_list p) __attribute__ ((format (printf, 1, 0)));
168 extern void bb_vinfo_msg(const char *s, va_list p) __attribute__ ((format (printf, 1, 0)));
170 extern int bb_echo(int argc, char** argv);
171 extern int bb_test(int argc, char** argv);
173 extern const char *bb_mode_string(int mode);
174 extern int is_directory(const char *name, int followLinks, struct stat *statBuf);
175 extern DIR *warn_opendir(const char *path);
176 extern DIR *xopendir(const char *path);
178 extern int remove_file(const char *path, int flags);
179 extern int copy_file(const char *source, const char *dest, int flags);
180 extern ssize_t safe_read(int fd, void *buf, size_t count);
181 extern ssize_t full_read(int fd, void *buf, size_t len);
182 extern ssize_t safe_write(int fd, const void *buf, size_t count);
183 extern ssize_t full_write(int fd, const void *buf, size_t len);
184 extern int recursive_action(const char *fileName, int recurse,
185 int followLinks, int depthFirst,
186 int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData),
187 int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData),
190 extern int bb_parse_mode( const char* s, mode_t* theMode);
192 extern unsigned int tty_baud_to_value(speed_t speed);
193 extern speed_t tty_value_to_baud(unsigned int value);
195 extern int get_linux_version_code(void);
197 extern int get_console_fd(void);
198 extern struct mntent *find_mount_point(const char *name, const char *table);
199 extern void erase_mtab(const char * name);
200 extern long *find_pid_by_name( const char* pidName);
201 extern long *pidlist_reverse(long *pidList);
202 extern char *find_block_device(char *path);
203 extern char *bb_get_line_from_file(FILE *file);
204 extern char *bb_get_chomped_line_from_file(FILE *file);
205 extern char *bb_get_chunk_from_file(FILE *file, int *end);
206 extern int bb_copyfd_size(int fd1, int fd2, const off_t size);
207 extern int bb_copyfd_eof(int fd1, int fd2);
208 extern char bb_process_escape_sequence(const char **ptr);
209 extern char *bb_get_last_path_component(char *path);
210 extern FILE *bb_wfopen(const char *path, const char *mode);
211 extern FILE *bb_wfopen_input(const char *filename);
212 extern FILE *xfopen(const char *path, const char *mode);
214 extern int bb_fclose_nonstdin(FILE *f);
215 extern void bb_fflush_stdout_and_exit(int retval) ATTRIBUTE_NORETURN;
217 extern void xstat(char *filename, struct stat *buf);
218 extern int xsocket(int domain, int type, int protocol);
219 extern pid_t spawn(char **argv);
220 extern pid_t xspawn(char **argv);
221 extern int wait4pid(int pid);
222 extern void xdaemon(int nochdir, int noclose);
223 extern void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
224 extern void xlisten(int s, int backlog);
225 extern void xchdir(const char *path);
226 extern void utoa_to_buf(unsigned n, char *buf, unsigned buflen);
227 extern char *utoa(unsigned n);
228 extern void itoa_to_buf(int n, char *buf, unsigned buflen);
229 extern char *itoa(int n);
230 extern void xsetgid(gid_t gid);
231 extern void xsetuid(uid_t uid);
232 extern off_t fdlength(int fd);
234 enum { BB_GETOPT_ERROR = 0x80000000 };
235 extern const char *opt_complementary;
236 extern const struct option *applet_long_options;
237 extern uint32_t option_mask32;
238 extern uint32_t getopt32(int argc, char **argv, const char *applet_opts, ...);
240 extern int bb_vfprintf(FILE * __restrict stream, const char * __restrict format,
241 va_list arg) __attribute__ ((format (printf, 2, 0)));
242 extern int bb_vprintf(const char * __restrict format, va_list arg)
243 __attribute__ ((format (printf, 1, 0)));
244 extern int bb_fprintf(FILE * __restrict stream, const char * __restrict format, ...)
245 __attribute__ ((format (printf, 2, 3)));
246 extern int bb_printf(const char * __restrict format, ...)
247 __attribute__ ((format (printf, 1, 2)));
249 extern void xferror(FILE *fp, const char *fn);
250 extern void xferror_stdout(void);
251 extern void xfflush_stdout(void);
253 extern void bb_warn_ignoring_args(int n);
255 extern void chomp(char *s);
256 extern void trim(char *s);
257 extern char *skip_whitespace(const char *);
259 #ifndef BUILD_INDIVIDUAL
260 extern struct BB_applet *find_applet_by_name(const char *name);
261 extern void run_applet_by_name(const char *name, int argc, char **argv);
264 /* dmalloc will redefine these to it's own implementation. It is safe
265 * to have the prototypes here unconditionally. */
266 extern void *xmalloc(size_t size);
267 extern void *xrealloc(void *old, size_t size);
268 extern void *xzalloc(size_t size);
270 extern char *xstrdup (const char *s);
271 extern char *xstrndup (const char *s, int n);
272 extern char *safe_strncpy(char *dst, const char *src, size_t size);
273 extern int safe_strtoi(char *arg, int* value);
274 extern int safe_strtod(char *arg, double* value);
275 extern int safe_strtol(char *arg, long* value);
276 extern int safe_strtoll(char *arg, long long* value);
277 extern int safe_strtoul(char *arg, unsigned long* value);
278 extern int safe_strtoull(char *arg, unsigned long long* value);
285 extern unsigned long bb_xgetularg_bnd_sfx(const char *arg, int base,
288 const struct suffix_mult *suffixes);
289 extern unsigned long bb_xgetularg_bnd(const char *arg, int base,
291 unsigned long upper);
292 extern unsigned long bb_xgetularg10_bnd(const char *arg,
294 unsigned long upper);
295 extern unsigned long bb_xgetularg10(const char *arg);
297 extern long bb_xgetlarg(const char *arg, int base,
300 extern long bb_xgetlarg_bnd_sfx(const char *arg, int base,
303 const struct suffix_mult *suffixes);
304 extern long bb_xgetlarg10_sfx(const char *arg, const struct suffix_mult *suffixes);
307 extern unsigned long bb_xparse_number(const char *numstr,
308 const struct suffix_mult *suffixes);
311 /* These parse entries in /etc/passwd and /etc/group. This is desirable
312 * for BusyBox since we want to avoid using the glibc NSS stuff, which
313 * increases target size and is often not needed on embedded systems. */
314 extern long bb_xgetpwnam(const char *name);
315 extern long bb_xgetgrnam(const char *name);
316 extern char *bb_getug(char *buffer, char *idname, long id, int bufsize, char prefix);
317 extern char *bb_getpwuid(char *name, long uid, int bufsize);
318 extern char *bb_getgrgid(char *group, long gid, int bufsize);
319 extern char *bb_askpass(int timeout, const char * prompt);
325 extern unsigned uidgid_get(struct bb_uidgid_t*, const char* /*, unsigned*/);
328 extern int device_open(const char *device, int mode);
330 extern char *query_loop(const char *device);
331 extern int del_loop(const char *device);
332 extern int set_loop(char **device, const char *file, int offset);
335 extern int vdprintf(int d, const char *format, va_list ap);
338 /* Include our own copy of struct sysinfo to avoid binary compatibility
339 * problems with Linux 2.4, which changed things. Grumble, grumble. */
341 long uptime; /* Seconds since boot */
342 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
343 unsigned long totalram; /* Total usable main memory size */
344 unsigned long freeram; /* Available memory size */
345 unsigned long sharedram; /* Amount of shared memory */
346 unsigned long bufferram; /* Memory used by buffers */
347 unsigned long totalswap; /* Total swap space size */
348 unsigned long freeswap; /* swap space still available */
349 unsigned short procs; /* Number of current processes */
350 unsigned short pad; /* Padding needed for m68k */
351 unsigned long totalhigh; /* Total high memory size */
352 unsigned long freehigh; /* Available high memory size */
353 unsigned int mem_unit; /* Memory unit size in bytes */
354 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
356 extern int sysinfo (struct sysinfo* info);
360 MEGABYTE = (KILOBYTE*1024),
361 GIGABYTE = (MEGABYTE*1024)
363 const char *make_human_readable_str(unsigned long long size,
364 unsigned long block_size, unsigned long display_unit);
366 int bb_ask_confirmation(void);
367 int klogctl(int type, char * b, int len);
369 char *xgetcwd(char *cwd);
370 char *xreadlink(const char *path);
371 char *concat_path_file(const char *path, const char *filename);
372 char *concat_subpath_file(const char *path, const char *filename);
373 char *last_char_is(const char *s, int c);
375 char *fgets_str(FILE *file, const char *terminating_string);
377 extern USE_DESKTOP(long long) int uncompress(int fd_in, int fd_out);
378 extern int inflate(int in, int out);
380 extern struct hostent *xgethostbyname(const char *name);
381 extern struct hostent *xgethostbyname2(const char *name, int af);
382 extern int create_icmp_socket(void);
383 extern int create_icmp6_socket(void);
384 extern int xconnect(struct sockaddr_in *s_addr);
385 extern unsigned short bb_lookup_port(const char *port, const char *protocol, unsigned short default_port);
386 extern void bb_lookup_host(struct sockaddr_in *s_in, const char *host);
388 // This is declared here rather than #including <libgen.h> in order to avoid
389 // confusing the two versions of basename. See the dirname/basename man page
391 char *dirname(char *path);
393 int bb_make_directory(char *path, long mode, int flags);
395 int get_signum(const char *name);
396 const char *get_signame(int number);
398 char *bb_simplify_path(const char *path);
400 enum { /* DO NOT CHANGE THESE VALUES! cp.c depends on them. */
401 FILEUTILS_PRESERVE_STATUS = 1,
402 FILEUTILS_DEREFERENCE = 2,
405 FILEUTILS_INTERACTIVE = 16
408 extern const char *applet_name;
410 extern const char bb_msg_full_version[];
411 extern const char bb_msg_memory_exhausted[];
412 extern const char bb_msg_invalid_date[];
413 extern const char bb_msg_read_error[];
414 extern const char bb_msg_write_error[];
415 extern const char bb_msg_name_longer_than_foo[];
416 extern const char bb_msg_unknown[];
417 extern const char bb_msg_can_not_create_raw_socket[];
418 extern const char bb_msg_perm_denied_are_you_root[];
419 extern const char bb_msg_requires_arg[];
420 extern const char bb_msg_invalid_arg[];
421 extern const char bb_msg_standard_input[];
422 extern const char bb_msg_standard_output[];
424 extern const char bb_path_nologin_file[];
425 extern const char bb_path_passwd_file[];
426 extern const char bb_path_shadow_file[];
427 extern const char bb_path_gshadow_file[];
428 extern const char bb_path_group_file[];
429 extern const char bb_path_securetty_file[];
430 extern const char bb_path_motd_file[];
431 extern const char bb_path_wtmp_file[];
432 extern const char bb_dev_null[];
437 extern char bb_common_bufsiz1[BUFSIZ+1];
440 * You can change LIBBB_DEFAULT_LOGIN_SHELL, but don`t use,
441 * use bb_default_login_shell and next defines,
442 * if you LIBBB_DEFAULT_LOGIN_SHELL change,
443 * don`t lose change increment constant!
445 #define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
447 extern const char bb_default_login_shell[];
449 #define DEFAULT_SHELL (bb_default_login_shell+1)
451 #define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
454 extern const char bb_path_mtab_file[];
456 extern int xfunc_error_retval;
458 #ifdef CONFIG_FEATURE_DEVFS
459 # define CURRENT_VC "/dev/vc/0"
460 # define VC_1 "/dev/vc/1"
461 # define VC_2 "/dev/vc/2"
462 # define VC_3 "/dev/vc/3"
463 # define VC_4 "/dev/vc/4"
464 # define VC_5 "/dev/vc/5"
465 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
466 /* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
467 respective serial ports .. as such, we can't use the common device paths for
469 # define SC_0 "/dev/ttsc/0"
470 # define SC_1 "/dev/ttsc/1"
471 # define SC_FORMAT "/dev/ttsc/%d"
473 # define SC_0 "/dev/tts/0"
474 # define SC_1 "/dev/tts/1"
475 # define SC_FORMAT "/dev/tts/%d"
477 # define VC_FORMAT "/dev/vc/%d"
478 # define LOOP_FORMAT "/dev/loop/%d"
479 # define LOOP_NAME "/dev/loop/"
480 # define FB_0 "/dev/fb/0"
482 # define CURRENT_VC "/dev/tty0"
483 # define VC_1 "/dev/tty1"
484 # define VC_2 "/dev/tty2"
485 # define VC_3 "/dev/tty3"
486 # define VC_4 "/dev/tty4"
487 # define VC_5 "/dev/tty5"
488 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
489 # define SC_0 "/dev/ttySC0"
490 # define SC_1 "/dev/ttySC1"
491 # define SC_FORMAT "/dev/ttySC%d"
493 # define SC_0 "/dev/ttyS0"
494 # define SC_1 "/dev/ttyS1"
495 # define SC_FORMAT "/dev/ttyS%d"
497 # define VC_FORMAT "/dev/tty%d"
498 # define LOOP_FORMAT "/dev/loop%d"
499 # define LOOP_NAME "/dev/loop"
500 # define FB_0 "/dev/fb0"
504 /* The following devices are the same on devfs and non-devfs systems. */
505 #define CURRENT_TTY "/dev/tty"
506 #define CONSOLE_DEV "/dev/console"
508 int is_in_ino_dev_hashtable(const struct stat *statbuf, char **name);
509 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
510 void reset_ino_dev_hashtable(void);
512 char *xasprintf(const char *format, ...) __attribute__ ((format (printf, 1, 2)));
513 void xprint_and_close_file(FILE *file);
516 extern void bb_do_delay(int seconds);
517 extern void change_identity(const struct passwd *pw);
518 extern const char *change_identity_e2str(const struct passwd *pw);
519 extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args);
520 #ifdef CONFIG_SELINUX
521 extern void renew_current_security_context(void);
522 extern void set_current_security_context(security_context_t sid);
524 extern int run_parts(char **args, const unsigned char test_mode, char **env);
525 extern int restricted_shell(const char *shell);
526 extern void setup_environment(const char *shell, int loginshell, int changeenv, const struct passwd *pw);
527 extern int correct_password(const struct passwd *pw);
528 extern char *pw_encrypt(const char *clear, const char *salt);
529 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp);
531 extern void xsetenv(const char *key, const char *value);
532 extern int xopen(const char *pathname, int flags);
533 extern int xopen3(const char *pathname, int flags, int mode);
534 extern void xread(int fd, void *buf, size_t count);
535 extern unsigned char xread_char(int fd);
536 extern void xlseek(int fd, off_t offset, int whence);
537 extern void xwrite(int fd, void *buf, size_t count);
539 extern const char bb_uuenc_tbl_base64[];
540 extern const char bb_uuenc_tbl_std[];
541 extern void bb_uuencode(const unsigned char *s, char *store, const int length, const char *tbl);
545 #define COMM_LEN TASK_COMM_LEN
547 /* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
557 #ifdef CONFIG_FEATURE_TOP_CPU_USAGE_PERCENTAGE
560 unsigned long stime, utime;
564 /* basename of executable file in call to exec(2),
565 size from kernel headers */
566 char short_cmd[COMM_LEN];
569 extern procps_status_t * procps_scan(int save_user_arg0);
570 extern int compare_string_array(const char * const string_array[], const char *key);
572 extern void print_login_issue(const char *issue_file, const char *tty);
573 extern void print_login_prompt(void);
576 extern void vfork_daemon(int nochdir, int noclose);
577 extern void vfork_daemon_rexec(int nochdir, int noclose,
578 int argc, char **argv, char *foreground_opt);
581 extern int get_terminal_width_height(int fd, int *width, int *height);
582 extern unsigned long get_ug_id(const char *s, long (*__bb_getxxnam)(const char *));
584 typedef struct _sha1_ctx_t_ {
590 void sha1_begin(sha1_ctx_t *ctx);
591 void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx);
592 void *sha1_end(void *resbuf, sha1_ctx_t *ctx);
594 typedef struct _md5_ctx_t_ {
604 void md5_begin(md5_ctx_t *ctx);
605 void md5_hash(const void *data, size_t length, md5_ctx_t *ctx);
606 void *md5_end(void *resbuf, md5_ctx_t *ctx);
608 extern uint32_t *crc32_filltable (int endian);
611 /* Stop system and switch power off if possible. */
612 #define RB_POWER_OFF 0x4321fedc
615 extern const char BB_BANNER[];
617 // Make sure we call functions instead of macros.
636 #endif /* __LIBBUSYBOX_H__ */