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 /* Some useful definitions */
66 #define FALSE ((int) 0)
68 #define TRUE ((int) 1)
70 #define SKIP ((int) 2)
73 #define MTAB_GETMOUNTPT '1'
74 #define MTAB_GETDEVICE '2'
77 #define EXPAND_ALLOC 1024
79 /* Macros for min/max. */
81 #define MIN(a,b) (((a)<(b))?(a):(b))
85 #define MAX(a,b) (((a)>(b))?(a):(b))
88 /* buffer allocation schemes */
89 #ifdef CONFIG_FEATURE_BUFFERS_GO_ON_STACK
90 #define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
91 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
92 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
94 #ifdef CONFIG_FEATURE_BUFFERS_GO_IN_BSS
95 #define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
96 #define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
97 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
99 #define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer=xmalloc(len)
100 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer=xmalloc(len)
101 #define RELEASE_CONFIG_BUFFER(buffer) free (buffer)
106 typedef struct llist_s {
108 struct llist_s *link;
110 extern void llist_add_to(llist_t **old_head, void *data);
111 extern void llist_add_to_end(llist_t **list_head, void *data);
112 extern void *llist_pop(llist_t **elm);
113 extern void llist_free(llist_t *elm, void (*freeit)(void *data));
118 LOGMODE_STDIO = 1<<0,
119 LOGMODE_SYSLOG = 1<<1,
120 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
122 extern const char *msg_eol;
124 extern int die_sleep;
126 extern void bb_show_usage(void) ATTRIBUTE_NORETURN ATTRIBUTE_EXTERNALLY_VISIBLE;
127 extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
128 extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
129 extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
130 extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
131 extern void bb_vherror_msg(const char *s, va_list p);
132 extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
133 extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
135 extern void bb_perror_nomsg_and_die(void) ATTRIBUTE_NORETURN;
136 extern void bb_perror_nomsg(void);
138 extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
140 /* These two are used internally -- you shouldn't need to use them */
141 extern void bb_verror_msg(const char *s, va_list p, const char *strerr) __attribute__ ((format (printf, 1, 0)));
142 extern void bb_vperror_msg(const char *s, va_list p) __attribute__ ((format (printf, 1, 0)));
143 extern void bb_vinfo_msg(const char *s, va_list p) __attribute__ ((format (printf, 1, 0)));
145 extern int bb_echo(int argc, char** argv);
146 extern int bb_test(int argc, char** argv);
148 extern const char *bb_mode_string(int mode);
149 extern int is_directory(const char *name, int followLinks, struct stat *statBuf);
150 extern DIR *warn_opendir(const char *path);
151 extern DIR *xopendir(const char *path);
153 extern int remove_file(const char *path, int flags);
154 extern int copy_file(const char *source, const char *dest, int flags);
155 extern ssize_t safe_read(int fd, void *buf, size_t count);
156 extern ssize_t full_read(int fd, void *buf, size_t len);
157 extern ssize_t safe_write(int fd, const void *buf, size_t count);
158 extern ssize_t full_write(int fd, const void *buf, size_t len);
159 extern int recursive_action(const char *fileName, int recurse,
160 int followLinks, int depthFirst,
161 int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData),
162 int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData),
165 extern int bb_parse_mode( const char* s, mode_t* theMode);
166 extern long bb_xgetlarg(const char *arg, int base, long lower, long upper);
168 extern unsigned int tty_baud_to_value(speed_t speed);
169 extern speed_t tty_value_to_baud(unsigned int value);
171 extern int get_linux_version_code(void);
173 extern int get_console_fd(void);
174 extern struct mntent *find_mount_point(const char *name, const char *table);
175 extern void erase_mtab(const char * name);
176 extern long *find_pid_by_name( const char* pidName);
177 extern long *pidlist_reverse(long *pidList);
178 extern char *find_block_device(char *path);
179 extern char *bb_get_line_from_file(FILE *file);
180 extern char *bb_get_chomped_line_from_file(FILE *file);
181 extern char *bb_get_chunk_from_file(FILE *file, int *end);
182 extern int bb_copyfd_size(int fd1, int fd2, const off_t size);
183 extern int bb_copyfd_eof(int fd1, int fd2);
184 extern char bb_process_escape_sequence(const char **ptr);
185 extern char *bb_get_last_path_component(char *path);
186 extern FILE *bb_wfopen(const char *path, const char *mode);
187 extern FILE *bb_wfopen_input(const char *filename);
188 extern FILE *xfopen(const char *path, const char *mode);
190 extern int bb_fclose_nonstdin(FILE *f);
191 extern void bb_fflush_stdout_and_exit(int retval) ATTRIBUTE_NORETURN;
193 extern void xstat(char *filename, struct stat *buf);
194 extern int xsocket(int domain, int type, int protocol);
195 extern pid_t spawn(char **argv);
196 extern pid_t xspawn(char **argv);
197 extern int wait4pid(int pid);
198 extern void xdaemon(int nochdir, int noclose);
199 extern void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
200 extern void xlisten(int s, int backlog);
201 extern void xchdir(const char *path);
202 extern void utoa_to_buf(unsigned n, char *buf, unsigned buflen);
203 extern char *utoa(unsigned n);
204 extern void itoa_to_buf(int n, char *buf, unsigned buflen);
205 extern char *itoa(int n);
206 extern void xsetgid(gid_t gid);
207 extern void xsetuid(uid_t uid);
208 extern off_t fdlength(int fd);
210 #define BB_GETOPT_ERROR 0x80000000UL
211 extern const char *bb_opt_complementally;
212 extern const struct option *bb_applet_long_options;
213 extern unsigned long bb_getopt_ulflags(int argc, char **argv, const char *applet_opts, ...);
215 extern int bb_vfprintf(FILE * __restrict stream, const char * __restrict format,
216 va_list arg) __attribute__ ((format (printf, 2, 0)));
217 extern int bb_vprintf(const char * __restrict format, va_list arg)
218 __attribute__ ((format (printf, 1, 0)));
219 extern int bb_fprintf(FILE * __restrict stream, const char * __restrict format, ...)
220 __attribute__ ((format (printf, 2, 3)));
221 extern int bb_printf(const char * __restrict format, ...)
222 __attribute__ ((format (printf, 1, 2)));
224 extern void xferror(FILE *fp, const char *fn);
225 extern void xferror_stdout(void);
226 extern void xfflush_stdout(void);
228 extern void bb_warn_ignoring_args(int n);
230 extern void chomp(char *s);
231 extern void trim(char *s);
232 extern char *skip_whitespace(const char *);
234 #ifndef BUILD_INDIVIDUAL
235 extern struct BB_applet *find_applet_by_name(const char *name);
236 void run_applet_by_name(const char *name, int argc, char **argv);
239 /* dmalloc will redefine these to it's own implementation. It is safe
240 * to have the prototypes here unconditionally. */
241 extern void *xmalloc(size_t size);
242 extern void *xrealloc(void *old, size_t size);
243 extern void *xzalloc(size_t size);
245 extern char *xstrdup (const char *s);
246 extern char *xstrndup (const char *s, int n);
247 extern char *safe_strncpy(char *dst, const char *src, size_t size);
248 extern int safe_strtoi(char *arg, int* value);
249 extern int safe_strtod(char *arg, double* value);
250 extern int safe_strtol(char *arg, long* value);
251 extern int safe_strtoul(char *arg, unsigned long* value);
258 extern unsigned long bb_xgetularg_bnd_sfx(const char *arg, int base,
261 const struct suffix_mult *suffixes);
262 extern unsigned long bb_xgetularg_bnd(const char *arg, int base,
264 unsigned long upper);
265 extern unsigned long bb_xgetularg10_bnd(const char *arg,
267 unsigned long upper);
268 extern unsigned long bb_xgetularg10(const char *arg);
270 extern long bb_xgetlarg_bnd_sfx(const char *arg, int base,
273 const struct suffix_mult *suffixes);
274 extern long bb_xgetlarg10_sfx(const char *arg, const struct suffix_mult *suffixes);
277 extern unsigned long bb_xparse_number(const char *numstr,
278 const struct suffix_mult *suffixes);
281 /* These parse entries in /etc/passwd and /etc/group. This is desirable
282 * for BusyBox since we want to avoid using the glibc NSS stuff, which
283 * increases target size and is often not needed on embedded systems. */
284 extern long bb_xgetpwnam(const char *name);
285 extern long bb_xgetgrnam(const char *name);
286 extern char * bb_getug(char *buffer, char *idname, long id, int bufsize, char prefix);
287 extern char * bb_getpwuid(char *name, long uid, int bufsize);
288 extern char * bb_getgrgid(char *group, long gid, int bufsize);
289 extern char *bb_askpass(int timeout, const char * prompt);
291 extern int device_open(const char *device, int mode);
293 extern char *query_loop(const char *device);
294 extern int del_loop(const char *device);
295 extern int set_loop(char **device, const char *file, int offset);
298 extern int vdprintf(int d, const char *format, va_list ap);
301 /* Include our own copy of struct sysinfo to avoid binary compatibility
302 * problems with Linux 2.4, which changed things. Grumble, grumble. */
304 long uptime; /* Seconds since boot */
305 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
306 unsigned long totalram; /* Total usable main memory size */
307 unsigned long freeram; /* Available memory size */
308 unsigned long sharedram; /* Amount of shared memory */
309 unsigned long bufferram; /* Memory used by buffers */
310 unsigned long totalswap; /* Total swap space size */
311 unsigned long freeswap; /* swap space still available */
312 unsigned short procs; /* Number of current processes */
313 unsigned short pad; /* Padding needed for m68k */
314 unsigned long totalhigh; /* Total high memory size */
315 unsigned long freehigh; /* Available high memory size */
316 unsigned int mem_unit; /* Memory unit size in bytes */
317 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
319 extern int sysinfo (struct sysinfo* info);
323 MEGABYTE = (KILOBYTE*1024),
324 GIGABYTE = (MEGABYTE*1024)
326 const char *make_human_readable_str(unsigned long long size,
327 unsigned long block_size, unsigned long display_unit);
329 int bb_ask_confirmation(void);
330 int klogctl(int type, char * b, int len);
332 char *xgetcwd(char *cwd);
333 char *xreadlink(const char *path);
334 char *concat_path_file(const char *path, const char *filename);
335 char *concat_subpath_file(const char *path, const char *filename);
336 char *last_char_is(const char *s, int c);
338 char *fgets_str(FILE *file, const char *terminating_string);
340 extern int uncompress(int fd_in, int fd_out);
341 extern int inflate(int in, int out);
343 extern struct hostent *xgethostbyname(const char *name);
344 extern struct hostent *xgethostbyname2(const char *name, int af);
345 extern int create_icmp_socket(void);
346 extern int create_icmp6_socket(void);
347 extern int xconnect(struct sockaddr_in *s_addr);
348 extern unsigned short bb_lookup_port(const char *port, const char *protocol, unsigned short default_port);
349 extern void bb_lookup_host(struct sockaddr_in *s_in, const char *host);
351 // This is declared here rather than #including <libgen.h> in order to avoid
352 // confusing the two versions of basename. See the dirname/basename man page
354 char *dirname (char *path);
356 int bb_make_directory (char *path, long mode, int flags);
358 int get_signum(char *name);
359 char *get_signame(int number);
361 char *bb_simplify_path(const char *path);
363 enum { /* DO NOT CHANGE THESE VALUES! cp.c depends on them. */
364 FILEUTILS_PRESERVE_STATUS = 1,
365 FILEUTILS_DEREFERENCE = 2,
368 FILEUTILS_INTERACTIVE = 16
371 extern const char *bb_applet_name;
373 extern const char bb_msg_full_version[];
374 extern const char bb_msg_memory_exhausted[];
375 extern const char bb_msg_invalid_date[];
376 extern const char bb_msg_io_error[];
377 extern const char bb_msg_read_error[];
378 extern const char bb_msg_write_error[];
379 extern const char bb_msg_name_longer_than_foo[];
380 extern const char bb_msg_unknown[];
381 extern const char bb_msg_can_not_create_raw_socket[];
382 extern const char bb_msg_perm_denied_are_you_root[];
383 extern const char bb_msg_requires_arg[];
384 extern const char bb_msg_invalid_arg[];
385 extern const char bb_msg_standard_input[];
386 extern const char bb_msg_standard_output[];
388 extern const char bb_path_nologin_file[];
389 extern const char bb_path_passwd_file[];
390 extern const char bb_path_shadow_file[];
391 extern const char bb_path_gshadow_file[];
392 extern const char bb_path_group_file[];
393 extern const char bb_path_securetty_file[];
394 extern const char bb_path_motd_file[];
395 extern const char bb_path_wtmp_file[];
396 extern const char bb_dev_null[];
401 extern char bb_common_bufsiz1[BUFSIZ+1];
404 * You can change LIBBB_DEFAULT_LOGIN_SHELL, but don`t use,
405 * use bb_default_login_shell and next defines,
406 * if you LIBBB_DEFAULT_LOGIN_SHELL change,
407 * don`t lose change increment constant!
409 #define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
411 extern const char bb_default_login_shell[];
413 #define DEFAULT_SHELL (bb_default_login_shell+1)
415 #define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
418 extern const char bb_path_mtab_file[];
420 extern int bb_default_error_retval;
422 #ifdef CONFIG_FEATURE_DEVFS
423 # define CURRENT_VC "/dev/vc/0"
424 # define VC_1 "/dev/vc/1"
425 # define VC_2 "/dev/vc/2"
426 # define VC_3 "/dev/vc/3"
427 # define VC_4 "/dev/vc/4"
428 # define VC_5 "/dev/vc/5"
429 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
430 /* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
431 respective serial ports .. as such, we can't use the common device paths for
433 # define SC_0 "/dev/ttsc/0"
434 # define SC_1 "/dev/ttsc/1"
435 # define SC_FORMAT "/dev/ttsc/%d"
437 # define SC_0 "/dev/tts/0"
438 # define SC_1 "/dev/tts/1"
439 # define SC_FORMAT "/dev/tts/%d"
441 # define VC_FORMAT "/dev/vc/%d"
442 # define LOOP_FORMAT "/dev/loop/%d"
443 # define FB_0 "/dev/fb/0"
445 # define CURRENT_VC "/dev/tty0"
446 # define VC_1 "/dev/tty1"
447 # define VC_2 "/dev/tty2"
448 # define VC_3 "/dev/tty3"
449 # define VC_4 "/dev/tty4"
450 # define VC_5 "/dev/tty5"
451 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
452 # define SC_0 "/dev/ttySC0"
453 # define SC_1 "/dev/ttySC1"
454 # define SC_FORMAT "/dev/ttySC%d"
456 # define SC_0 "/dev/ttyS0"
457 # define SC_1 "/dev/ttyS1"
458 # define SC_FORMAT "/dev/ttyS%d"
460 # define VC_FORMAT "/dev/tty%d"
461 # define LOOP_FORMAT "/dev/loop%d"
462 # define FB_0 "/dev/fb0"
466 /* The following devices are the same on devfs and non-devfs systems. */
467 #define CURRENT_TTY "/dev/tty"
468 #define CONSOLE_DEV "/dev/console"
470 int is_in_ino_dev_hashtable(const struct stat *statbuf, char **name);
471 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
472 void reset_ino_dev_hashtable(void);
474 char *xasprintf(const char *format, ...) __attribute__ ((format (printf, 1, 2)));
475 void xprint_and_close_file(FILE *file);
478 extern void bb_do_delay(int seconds);
479 extern void change_identity(const struct passwd *pw);
480 extern const char *change_identity_e2str(const struct passwd *pw);
481 extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args);
482 #ifdef CONFIG_SELINUX
483 extern void renew_current_security_context(void);
484 extern void set_current_security_context(security_context_t sid);
486 extern int run_parts(char **args, const unsigned char test_mode, char **env);
487 extern int restricted_shell ( const char *shell );
488 extern void setup_environment ( const char *shell, int loginshell, int changeenv, const struct passwd *pw );
489 extern int correct_password ( const struct passwd *pw );
490 extern char *pw_encrypt(const char *clear, const char *salt);
491 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp);
493 extern int xopen(const char *pathname, int flags);
494 extern int xopen3(const char *pathname, int flags, int mode);
495 extern void xread(int fd, void *buf, size_t count);
496 extern unsigned char xread_char(int fd);
497 extern void xlseek(int fd, off_t offset, int whence);
498 extern void xwrite(int fd, void *buf, size_t count);
500 extern const char bb_uuenc_tbl_base64[];
501 extern const char bb_uuenc_tbl_std[];
502 extern void bb_uuencode(const unsigned char *s, char *store, const int length, const char *tbl);
506 #define COMM_LEN TASK_COMM_LEN
508 /* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
518 #ifdef CONFIG_FEATURE_TOP_CPU_USAGE_PERCENTAGE
521 unsigned long stime, utime;
525 /* basename of executable file in call to exec(2),
526 size from kernel headers */
527 char short_cmd[COMM_LEN];
530 extern procps_status_t * procps_scan(int save_user_arg0);
531 extern int compare_string_array(const char * const string_array[], const char *key);
533 extern void print_login_issue(const char *issue_file, const char *tty);
534 extern void print_login_prompt(void);
537 extern void vfork_daemon(int nochdir, int noclose);
538 extern void vfork_daemon_rexec(int nochdir, int noclose,
539 int argc, char **argv, char *foreground_opt);
542 extern int get_terminal_width_height(int fd, int *width, int *height);
543 extern unsigned long get_ug_id(const char *s, long (*__bb_getxxnam)(const char *));
545 typedef struct _sha1_ctx_t_ {
551 void sha1_begin(sha1_ctx_t *ctx);
552 void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx);
553 void *sha1_end(void *resbuf, sha1_ctx_t *ctx);
555 typedef struct _md5_ctx_t_ {
565 void md5_begin(md5_ctx_t *ctx);
566 void md5_hash(const void *data, size_t length, md5_ctx_t *ctx);
567 void *md5_end(void *resbuf, md5_ctx_t *ctx);
569 extern uint32_t *crc32_filltable (int endian);
572 /* Stop system and switch power off if possible. */
573 #define RB_POWER_OFF 0x4321fedc
576 extern const char BB_BANNER[];
578 // Make sure we call functions instead of macros.
597 #endif /* __LIBBUSYBOX_H__ */