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