1 /* vi: set sw=4 ts=4: */
3 * Busybox main internal header file
5 * Licensed under the GPL v2 or later, see the file LICENSE in this tarball.
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.
11 #ifndef __LIBBUSYBOX_H__
12 #define __LIBBUSYBOX_H__ 1
19 #include <sys/types.h>
24 #include <netinet/in.h>
27 #include "bb_config.h"
29 #include <selinux/selinux.h>
34 #ifdef CONFIG_FEATURE_SHADOWPASSWDS
37 #ifdef CONFIG_FEATURE_SHA1_PASSWORDS
41 /* Some useful definitions */
43 #define FALSE ((int) 0)
45 #define TRUE ((int) 1)
47 #define SKIP ((int) 2)
50 #define MTAB_GETMOUNTPT '1'
51 #define MTAB_GETDEVICE '2'
54 #define EXPAND_ALLOC 1024
56 /* Macros for min/max. */
58 #define MIN(a,b) (((a)<(b))?(a):(b))
62 #define MAX(a,b) (((a)>(b))?(a):(b))
65 /* buffer allocation schemes */
66 #ifdef CONFIG_FEATURE_BUFFERS_GO_ON_STACK
67 #define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
68 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
69 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
71 #ifdef CONFIG_FEATURE_BUFFERS_GO_IN_BSS
72 #define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
73 #define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
74 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
76 #define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer=xmalloc(len)
77 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer=xmalloc(len)
78 #define RELEASE_CONFIG_BUFFER(buffer) free (buffer)
83 typedef struct llist_s {
87 extern llist_t *llist_add_to(llist_t *old_head, void *data);
88 extern llist_t *llist_add_to_end(llist_t *list_head, void *data);
89 extern void *llist_pop(llist_t **elm);
90 extern void llist_free(llist_t *elm, void (*freeit)(void *data));
93 extern void bb_show_usage(void) ATTRIBUTE_NORETURN ATTRIBUTE_EXTERNALLY_VISIBLE;
94 extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
95 extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
96 extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
97 extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
98 extern void bb_vherror_msg(const char *s, va_list p);
99 extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
100 extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
102 extern void bb_perror_nomsg_and_die(void) ATTRIBUTE_NORETURN;
103 extern void bb_perror_nomsg(void);
105 /* These two are used internally -- you shouldn't need to use them */
106 extern void bb_verror_msg(const char *s, va_list p) __attribute__ ((format (printf, 1, 0)));
107 extern void bb_vperror_msg(const char *s, va_list p) __attribute__ ((format (printf, 1, 0)));
109 extern int bb_echo(int argc, char** argv);
111 extern const char *bb_mode_string(int mode);
112 extern int is_directory(const char *name, int followLinks, struct stat *statBuf);
113 extern DIR *bb_opendir(const char *path);
114 extern DIR *bb_xopendir(const char *path);
116 extern int remove_file(const char *path, int flags);
117 extern int copy_file(const char *source, const char *dest, int flags);
118 extern ssize_t safe_read(int fd, void *buf, size_t count);
119 extern ssize_t bb_full_read(int fd, void *buf, size_t len);
120 extern ssize_t safe_write(int fd, const void *buf, size_t count);
121 extern ssize_t bb_full_write(int fd, const void *buf, size_t len);
122 extern int recursive_action(const char *fileName, int recurse,
123 int followLinks, int depthFirst,
124 int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData),
125 int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData),
128 extern int bb_parse_mode( const char* s, mode_t* theMode);
129 extern long bb_xgetlarg(const char *arg, int base, long lower, long upper);
131 extern unsigned long bb_baud_to_value(speed_t speed);
132 extern speed_t bb_value_to_baud(unsigned long value);
134 extern int get_linux_version_code(void);
136 extern int get_console_fd(void);
137 extern struct mntent *find_mount_point(const char *name, const char *table);
138 extern void erase_mtab(const char * name);
139 extern long *find_pid_by_name( const char* pidName);
140 extern long *pidlist_reverse(long *pidList);
141 extern char *find_block_device(char *path);
142 extern char *bb_get_line_from_file(FILE *file);
143 extern char *bb_get_chomped_line_from_file(FILE *file);
144 extern char *bb_get_chunk_from_file(FILE *file, int *end);
145 extern int bb_copyfd_size(int fd1, int fd2, const off_t size);
146 extern int bb_copyfd_eof(int fd1, int fd2);
147 extern void bb_xprint_and_close_file(FILE *file);
148 extern int bb_xprint_file_by_name(const char *filename);
149 extern char bb_process_escape_sequence(const char **ptr);
150 extern char *bb_get_last_path_component(char *path);
151 extern FILE *bb_wfopen(const char *path, const char *mode);
152 extern FILE *bb_wfopen_input(const char *filename);
153 extern FILE *bb_xfopen(const char *path, const char *mode);
155 extern int bb_fclose_nonstdin(FILE *f);
156 extern void bb_fflush_stdout_and_exit(int retval) ATTRIBUTE_NORETURN;
158 extern void xstat(const char *filename, struct stat *buf);
159 extern int bb_xsocket(int domain, int type, int protocol);
160 extern pid_t bb_spawn(char **argv);
161 extern pid_t bb_xspawn(char **argv);
162 extern void bb_xdaemon(int nochdir, int noclose);
163 extern void bb_xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
164 extern void bb_xlisten(int s, int backlog);
165 extern void bb_xchdir(const char *path);
167 #define BB_GETOPT_ERROR 0x80000000UL
168 extern const char *bb_opt_complementally;
169 extern const struct option *bb_applet_long_options;
170 extern unsigned long bb_getopt_ulflags(int argc, char **argv, const char *applet_opts, ...);
172 extern int bb_vfprintf(FILE * __restrict stream, const char * __restrict format,
173 va_list arg) __attribute__ ((format (printf, 2, 0)));
174 extern int bb_vprintf(const char * __restrict format, va_list arg)
175 __attribute__ ((format (printf, 1, 0)));
176 extern int bb_fprintf(FILE * __restrict stream, const char * __restrict format, ...)
177 __attribute__ ((format (printf, 2, 3)));
178 extern int bb_printf(const char * __restrict format, ...)
179 __attribute__ ((format (printf, 1, 2)));
181 //#warning rename to xferror_filename?
182 extern void bb_xferror(FILE *fp, const char *fn);
183 extern void bb_xferror_stdout(void);
184 extern void bb_xfflush_stdout(void);
186 extern void bb_warn_ignoring_args(int n);
188 extern void chomp(char *s);
189 extern void trim(char *s);
190 extern const char *bb_skip_whitespace(const char *);
192 extern struct BB_applet *find_applet_by_name(const char *name);
193 void run_applet_by_name(const char *name, int argc, char **argv);
195 /* dmalloc will redefine these to it's own implementation. It is safe
196 * to have the prototypes here unconditionally. */
197 extern void *xmalloc(size_t size);
198 extern void *xrealloc(void *old, size_t size);
199 extern void *xzalloc(size_t size);
200 extern void *xcalloc(size_t nmemb, size_t size);
202 extern char *bb_xstrdup (const char *s);
203 extern char *bb_xstrndup (const char *s, int n);
204 extern char *safe_strncpy(char *dst, const char *src, size_t size);
205 extern int safe_strtoi(char *arg, int* value);
206 extern int safe_strtod(char *arg, double* value);
207 extern int safe_strtol(char *arg, long* value);
208 extern int safe_strtoul(char *arg, unsigned long* value);
215 extern unsigned long bb_xgetularg_bnd_sfx(const char *arg, int base,
218 const struct suffix_mult *suffixes);
219 extern unsigned long bb_xgetularg_bnd(const char *arg, int base,
221 unsigned long upper);
222 extern unsigned long bb_xgetularg10_bnd(const char *arg,
224 unsigned long upper);
225 extern unsigned long bb_xgetularg10(const char *arg);
227 extern long bb_xgetlarg_bnd_sfx(const char *arg, int base,
230 const struct suffix_mult *suffixes);
231 extern long bb_xgetlarg10_sfx(const char *arg, const struct suffix_mult *suffixes);
234 //#warning pitchable now?
235 extern unsigned long bb_xparse_number(const char *numstr,
236 const struct suffix_mult *suffixes);
239 /* These parse entries in /etc/passwd and /etc/group. This is desirable
240 * for BusyBox since we want to avoid using the glibc NSS stuff, which
241 * increases target size and is often not needed on embedded systems. */
242 extern long bb_xgetpwnam(const char *name);
243 extern long bb_xgetgrnam(const char *name);
244 extern char * bb_getug(char *buffer, char *idname, long id, int bufsize, char prefix);
245 extern char * bb_getpwuid(char *name, long uid, int bufsize);
246 extern char * bb_getgrgid(char *group, long gid, int bufsize);
247 extern char *bb_askpass(int timeout, const char * prompt);
249 extern int device_open(const char *device, int mode);
251 extern char *query_loop(const char *device);
252 extern int del_loop(const char *device);
253 extern int set_loop(char **device, const char *file, int offset);
256 extern int vdprintf(int d, const char *format, va_list ap);
259 int nfsmount(const char *spec, const char *node, int *flags,
260 char **mount_opts, int running_bg);
262 /* Include our own copy of struct sysinfo to avoid binary compatibility
263 * problems with Linux 2.4, which changed things. Grumble, grumble. */
265 long uptime; /* Seconds since boot */
266 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
267 unsigned long totalram; /* Total usable main memory size */
268 unsigned long freeram; /* Available memory size */
269 unsigned long sharedram; /* Amount of shared memory */
270 unsigned long bufferram; /* Memory used by buffers */
271 unsigned long totalswap; /* Total swap space size */
272 unsigned long freeswap; /* swap space still available */
273 unsigned short procs; /* Number of current processes */
274 unsigned short pad; /* Padding needed for m68k */
275 unsigned long totalhigh; /* Total high memory size */
276 unsigned long freehigh; /* Available high memory size */
277 unsigned int mem_unit; /* Memory unit size in bytes */
278 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
280 extern int sysinfo (struct sysinfo* info);
284 MEGABYTE = (KILOBYTE*1024),
285 GIGABYTE = (MEGABYTE*1024)
287 const char *make_human_readable_str(unsigned long long size,
288 unsigned long block_size, unsigned long display_unit);
290 int bb_ask_confirmation(void);
291 int klogctl(int type, char * b, int len);
293 char *xgetcwd(char *cwd);
294 char *xreadlink(const char *path);
295 char *concat_path_file(const char *path, const char *filename);
296 char *concat_subpath_file(const char *path, const char *filename);
297 char *last_char_is(const char *s, int c);
299 int read_package_field(const char *package_buffer, char **field_name, char **field_value);
301 char *fgets_str(FILE *file, const char *terminating_string);
303 extern int uncompress(int fd_in, int fd_out);
304 extern int inflate(int in, int out);
306 extern struct hostent *xgethostbyname(const char *name);
307 extern struct hostent *xgethostbyname2(const char *name, int af);
308 extern int create_icmp_socket(void);
309 extern int create_icmp6_socket(void);
310 extern int xconnect(struct sockaddr_in *s_addr);
311 extern unsigned short bb_lookup_port(const char *port, const char *protocol, unsigned short default_port);
312 extern void bb_lookup_host(struct sockaddr_in *s_in, const char *host);
314 //#warning wrap this?
315 char *dirname (char *path);
317 int bb_make_directory (char *path, long mode, int flags);
319 const char *u_signal_names(const char *str_sig, int *signo, int startnum);
320 char *bb_simplify_path(const char *path);
322 enum { /* DO NOT CHANGE THESE VALUES! cp.c depends on them. */
323 FILEUTILS_PRESERVE_STATUS = 1,
324 FILEUTILS_DEREFERENCE = 2,
327 FILEUTILS_INTERACTIVE = 16
330 extern const char *bb_applet_name;
332 extern const char * const bb_msg_full_version;
333 extern const char * const bb_msg_memory_exhausted;
334 extern const char * const bb_msg_invalid_date;
335 extern const char * const bb_msg_io_error;
336 extern const char * const bb_msg_read_error;
337 extern const char * const bb_msg_write_error;
338 extern const char * const bb_msg_name_longer_than_foo;
339 extern const char * const bb_msg_unknown;
340 extern const char * const bb_msg_can_not_create_raw_socket;
341 extern const char * const bb_msg_perm_denied_are_you_root;
342 extern const char * const bb_msg_standard_input;
343 extern const char * const bb_msg_standard_output;
345 extern const char * const bb_path_nologin_file;
346 extern const char * const bb_path_passwd_file;
347 extern const char * const bb_path_shadow_file;
348 extern const char * const bb_path_gshadow_file;
349 extern const char * const bb_path_group_file;
350 extern const char * const bb_path_securetty_file;
351 extern const char * const bb_path_motd_file;
352 extern const char * const bb_path_wtmp_file;
353 extern const char * const bb_dev_null;
358 extern char bb_common_bufsiz1[BUFSIZ+1];
361 * You can change LIBBB_DEFAULT_LOGIN_SHELL, but don`t use,
362 * use bb_default_login_shell and next defines,
363 * if you LIBBB_DEFAULT_LOGIN_SHELL change,
364 * don`t lose change increment constant!
366 #define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
368 extern const char * const bb_default_login_shell;
370 #define DEFAULT_SHELL (bb_default_login_shell+1)
372 #define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
375 extern const char bb_path_mtab_file[];
377 extern int bb_default_error_retval;
379 #ifdef CONFIG_FEATURE_DEVFS
380 # define CURRENT_VC "/dev/vc/0"
381 # define VC_1 "/dev/vc/1"
382 # define VC_2 "/dev/vc/2"
383 # define VC_3 "/dev/vc/3"
384 # define VC_4 "/dev/vc/4"
385 # define VC_5 "/dev/vc/5"
386 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
387 /* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
388 respective serial ports .. as such, we can't use the common device paths for
390 # define SC_0 "/dev/ttsc/0"
391 # define SC_1 "/dev/ttsc/1"
392 # define SC_FORMAT "/dev/ttsc/%d"
394 # define SC_0 "/dev/tts/0"
395 # define SC_1 "/dev/tts/1"
396 # define SC_FORMAT "/dev/tts/%d"
398 # define VC_FORMAT "/dev/vc/%d"
399 # define LOOP_FORMAT "/dev/loop/%d"
400 # define FB_0 "/dev/fb/0"
402 # define CURRENT_VC "/dev/tty0"
403 # define VC_1 "/dev/tty1"
404 # define VC_2 "/dev/tty2"
405 # define VC_3 "/dev/tty3"
406 # define VC_4 "/dev/tty4"
407 # define VC_5 "/dev/tty5"
408 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
409 # define SC_0 "/dev/ttySC0"
410 # define SC_1 "/dev/ttySC1"
411 # define SC_FORMAT "/dev/ttySC%d"
413 # define SC_0 "/dev/ttyS0"
414 # define SC_1 "/dev/ttyS1"
415 # define SC_FORMAT "/dev/ttyS%d"
417 # define VC_FORMAT "/dev/tty%d"
418 # define LOOP_FORMAT "/dev/loop%d"
419 # define FB_0 "/dev/fb0"
422 //#warning put these in .o files
424 /* The following devices are the same on devfs and non-devfs systems. */
425 #define CURRENT_TTY "/dev/tty"
426 #define CONSOLE_DEV "/dev/console"
428 int is_in_ino_dev_hashtable(const struct stat *statbuf, char **name);
429 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
430 void reset_ino_dev_hashtable(void);
432 char *bb_xasprintf(const char *format, ...) __attribute__ ((format (printf, 1, 2)));
435 extern void bb_do_delay(int seconds);
436 extern void change_identity ( const struct passwd *pw );
437 extern const char *change_identity_e2str ( const struct passwd *pw );
438 extern void run_shell ( const char *shell, int loginshell, const char *command, const char **additional_args);
439 #ifdef CONFIG_SELINUX
440 extern void renew_current_security_context(void);
441 extern void set_current_security_context(security_context_t sid);
443 extern int run_parts(char **args, const unsigned char test_mode, char **env);
444 extern int restricted_shell ( const char *shell );
445 extern void setup_environment ( const char *shell, int loginshell, int changeenv, const struct passwd *pw );
446 extern int correct_password ( const struct passwd *pw );
447 extern char *pw_encrypt(const char *clear, const char *salt);
448 extern struct spwd *pwd_to_spwd(const struct passwd *pw);
449 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp);
451 extern int bb_xopen(const char *pathname, int flags);
452 extern int bb_xopen3(const char *pathname, int flags, int mode);
453 extern ssize_t bb_xread(int fd, void *buf, size_t count);
454 extern void bb_xread_all(int fd, void *buf, size_t count);
455 extern unsigned char bb_xread_char(int fd);
458 /*#include <sched.h> *//* Task command name length */
460 #define COMM_LEN TASK_COMM_LEN
462 #define COMM_LEN 16 /* synchronize with size of comm in struct task_struct
463 in /usr/include/linux/sched.h */
472 #ifdef CONFIG_FEATURE_TOP_CPU_USAGE_PERCENTAGE
475 unsigned long stime, utime;
479 /* basename of executable file in call to exec(2),
480 size from kernel headers */
481 char short_cmd[COMM_LEN];
484 extern procps_status_t * procps_scan(int save_user_arg0);
485 extern int compare_string_array(const char * const string_array[], const char *key);
487 extern int my_query_module(const char *name, int which, void **buf, size_t *bufsize, size_t *ret);
489 extern void print_login_issue(const char *issue_file, const char *tty);
490 extern void print_login_prompt(void);
492 #if defined(__uClinux__)
493 extern void vfork_daemon_rexec(int nochdir, int noclose,
494 int argc, char **argv, char *foreground_opt);
497 extern int get_terminal_width_height(int fd, int *width, int *height);
498 extern unsigned long get_ug_id(const char *s, long (*__bb_getxxnam)(const char *));
500 typedef struct _sha1_ctx_t_ {
506 void sha1_begin(sha1_ctx_t *ctx);
507 void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx);
508 void *sha1_end(void *resbuf, sha1_ctx_t *ctx);
510 typedef struct _md5_ctx_t_ {
520 void md5_begin(md5_ctx_t *ctx);
521 void md5_hash(const void *data, size_t length, md5_ctx_t *ctx);
522 void *md5_end(void *resbuf, md5_ctx_t *ctx);
524 extern uint32_t *bb_crc32_filltable (int endian);
526 /* busybox.h will include dmalloc later for us, else include it here. */
527 #if !defined _BB_INTERNAL_H_ && defined DMALLOC
531 #endif /* __LIBBUSYBOX_H__ */