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
14 #include "bb_config.h"
31 #include <sys/ioctl.h>
33 #include <sys/socket.h>
35 #include <sys/statfs.h>
37 #include <sys/types.h>
45 #include <selinux/selinux.h>
48 #ifdef CONFIG_LOCALE_SUPPORT
56 /* Try to pull in PATH_MAX */
58 #include <sys/param.h>
67 /* Some useful definitions */
69 #define FALSE ((int) 0)
71 #define TRUE ((int) 1)
73 #define SKIP ((int) 2)
76 #define MTAB_GETMOUNTPT '1'
77 #define MTAB_GETDEVICE '2'
80 #define EXPAND_ALLOC 1024
82 /* Macros for min/max. */
84 #define MIN(a,b) (((a)<(b))?(a):(b))
88 #define MAX(a,b) (((a)>(b))?(a):(b))
91 /* buffer allocation schemes */
92 #ifdef CONFIG_FEATURE_BUFFERS_GO_ON_STACK
93 #define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
94 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
95 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
97 #ifdef CONFIG_FEATURE_BUFFERS_GO_IN_BSS
98 #define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
99 #define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
100 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
102 #define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer=xmalloc(len)
103 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer=xmalloc(len)
104 #define RELEASE_CONFIG_BUFFER(buffer) free (buffer)
109 typedef struct llist_s {
111 struct llist_s *link;
113 extern void llist_add_to(llist_t **old_head, void *data);
114 extern void llist_add_to_end(llist_t **list_head, void *data);
115 extern void *llist_pop(llist_t **elm);
116 extern void llist_free(llist_t *elm, void (*freeit)(void *data));
119 extern void bb_show_usage(void) ATTRIBUTE_NORETURN ATTRIBUTE_EXTERNALLY_VISIBLE;
120 extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
121 extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
122 extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
123 extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
124 extern void bb_vherror_msg(const char *s, va_list p);
125 extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
126 extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
128 extern void bb_perror_nomsg_and_die(void) ATTRIBUTE_NORETURN;
129 extern void bb_perror_nomsg(void);
131 /* These two are used internally -- you shouldn't need to use them */
132 extern void bb_verror_msg(const char *s, va_list p) __attribute__ ((format (printf, 1, 0)));
133 extern void bb_vperror_msg(const char *s, va_list p) __attribute__ ((format (printf, 1, 0)));
135 extern int bb_echo(int argc, char** argv);
136 extern int bb_test(int argc, char** argv);
138 extern const char *bb_mode_string(int mode);
139 extern int is_directory(const char *name, int followLinks, struct stat *statBuf);
140 extern DIR *warn_opendir(const char *path);
141 extern DIR *xopendir(const char *path);
143 extern int remove_file(const char *path, int flags);
144 extern int copy_file(const char *source, const char *dest, int flags);
145 extern ssize_t safe_read(int fd, void *buf, size_t count);
146 extern ssize_t full_read(int fd, void *buf, size_t len);
147 extern ssize_t safe_write(int fd, const void *buf, size_t count);
148 extern ssize_t full_write(int fd, const void *buf, size_t len);
149 extern int recursive_action(const char *fileName, int recurse,
150 int followLinks, int depthFirst,
151 int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData),
152 int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData),
155 extern int bb_parse_mode( const char* s, mode_t* theMode);
156 extern long bb_xgetlarg(const char *arg, int base, long lower, long upper);
158 extern unsigned int tty_baud_to_value(speed_t speed);
159 extern speed_t tty_value_to_baud(unsigned int value);
161 extern int get_linux_version_code(void);
163 extern int get_console_fd(void);
164 extern struct mntent *find_mount_point(const char *name, const char *table);
165 extern void erase_mtab(const char * name);
166 extern long *find_pid_by_name( const char* pidName);
167 extern long *pidlist_reverse(long *pidList);
168 extern char *find_block_device(char *path);
169 extern char *bb_get_line_from_file(FILE *file);
170 extern char *bb_get_chomped_line_from_file(FILE *file);
171 extern char *bb_get_chunk_from_file(FILE *file, int *end);
172 extern int bb_copyfd_size(int fd1, int fd2, const off_t size);
173 extern int bb_copyfd_eof(int fd1, int fd2);
174 extern char bb_process_escape_sequence(const char **ptr);
175 extern char *bb_get_last_path_component(char *path);
176 extern FILE *bb_wfopen(const char *path, const char *mode);
177 extern FILE *bb_wfopen_input(const char *filename);
178 extern FILE *xfopen(const char *path, const char *mode);
180 extern int bb_fclose_nonstdin(FILE *f);
181 extern void bb_fflush_stdout_and_exit(int retval) ATTRIBUTE_NORETURN;
183 extern void xstat(const char *filename, struct stat *buf);
184 extern int xsocket(int domain, int type, int protocol);
185 extern pid_t spawn(char **argv);
186 extern pid_t xspawn(char **argv);
187 extern int wait4pid(int pid);
188 extern void xdaemon(int nochdir, int noclose);
189 extern void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
190 extern void xlisten(int s, int backlog);
191 extern void xchdir(const char *path);
192 extern void utoa_to_buf(unsigned n, char *buf, unsigned buflen);
193 extern char *utoa(unsigned n);
194 extern void itoa_to_buf(int n, char *buf, unsigned buflen);
195 extern char *itoa(int n);
196 extern void xsetgid(gid_t gid);
197 extern void xsetuid(uid_t uid);
198 extern off_t fdlength(int fd);
200 #define BB_GETOPT_ERROR 0x80000000UL
201 extern const char *bb_opt_complementally;
202 extern const struct option *bb_applet_long_options;
203 extern unsigned long bb_getopt_ulflags(int argc, char **argv, const char *applet_opts, ...);
205 extern int bb_vfprintf(FILE * __restrict stream, const char * __restrict format,
206 va_list arg) __attribute__ ((format (printf, 2, 0)));
207 extern int bb_vprintf(const char * __restrict format, va_list arg)
208 __attribute__ ((format (printf, 1, 0)));
209 extern int bb_fprintf(FILE * __restrict stream, const char * __restrict format, ...)
210 __attribute__ ((format (printf, 2, 3)));
211 extern int bb_printf(const char * __restrict format, ...)
212 __attribute__ ((format (printf, 1, 2)));
214 //#warning rename to xferror_filename?
215 extern void xferror(FILE *fp, const char *fn);
216 extern void xferror_stdout(void);
217 extern void xfflush_stdout(void);
219 extern void bb_warn_ignoring_args(int n);
221 extern void chomp(char *s);
222 extern void trim(char *s);
223 extern char *skip_whitespace(const char *);
225 extern struct BB_applet *find_applet_by_name(const char *name);
226 void run_applet_by_name(const char *name, int argc, char **argv);
228 /* dmalloc will redefine these to it's own implementation. It is safe
229 * to have the prototypes here unconditionally. */
230 extern void *xmalloc(size_t size);
231 extern void *xrealloc(void *old, size_t size);
232 extern void *xzalloc(size_t size);
234 extern char *xstrdup (const char *s);
235 extern char *xstrndup (const char *s, int n);
236 extern char *safe_strncpy(char *dst, const char *src, size_t size);
237 extern int safe_strtoi(char *arg, int* value);
238 extern int safe_strtod(char *arg, double* value);
239 extern int safe_strtol(char *arg, long* value);
240 extern int safe_strtoul(char *arg, unsigned long* value);
247 extern unsigned long bb_xgetularg_bnd_sfx(const char *arg, int base,
250 const struct suffix_mult *suffixes);
251 extern unsigned long bb_xgetularg_bnd(const char *arg, int base,
253 unsigned long upper);
254 extern unsigned long bb_xgetularg10_bnd(const char *arg,
256 unsigned long upper);
257 extern unsigned long bb_xgetularg10(const char *arg);
259 extern long bb_xgetlarg_bnd_sfx(const char *arg, int base,
262 const struct suffix_mult *suffixes);
263 extern long bb_xgetlarg10_sfx(const char *arg, const struct suffix_mult *suffixes);
266 //#warning pitchable now?
267 extern unsigned long bb_xparse_number(const char *numstr,
268 const struct suffix_mult *suffixes);
271 /* These parse entries in /etc/passwd and /etc/group. This is desirable
272 * for BusyBox since we want to avoid using the glibc NSS stuff, which
273 * increases target size and is often not needed on embedded systems. */
274 extern long bb_xgetpwnam(const char *name);
275 extern long bb_xgetgrnam(const char *name);
276 extern char * bb_getug(char *buffer, char *idname, long id, int bufsize, char prefix);
277 extern char * bb_getpwuid(char *name, long uid, int bufsize);
278 extern char * bb_getgrgid(char *group, long gid, int bufsize);
279 extern char *bb_askpass(int timeout, const char * prompt);
281 extern int device_open(const char *device, int mode);
283 extern char *query_loop(const char *device);
284 extern int del_loop(const char *device);
285 extern int set_loop(char **device, const char *file, int offset);
288 extern int vdprintf(int d, const char *format, va_list ap);
291 int nfsmount(const char *spec, const char *node, int *flags,
292 char **mount_opts, int running_bg);
294 /* Include our own copy of struct sysinfo to avoid binary compatibility
295 * problems with Linux 2.4, which changed things. Grumble, grumble. */
297 long uptime; /* Seconds since boot */
298 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
299 unsigned long totalram; /* Total usable main memory size */
300 unsigned long freeram; /* Available memory size */
301 unsigned long sharedram; /* Amount of shared memory */
302 unsigned long bufferram; /* Memory used by buffers */
303 unsigned long totalswap; /* Total swap space size */
304 unsigned long freeswap; /* swap space still available */
305 unsigned short procs; /* Number of current processes */
306 unsigned short pad; /* Padding needed for m68k */
307 unsigned long totalhigh; /* Total high memory size */
308 unsigned long freehigh; /* Available high memory size */
309 unsigned int mem_unit; /* Memory unit size in bytes */
310 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
312 extern int sysinfo (struct sysinfo* info);
316 MEGABYTE = (KILOBYTE*1024),
317 GIGABYTE = (MEGABYTE*1024)
319 const char *make_human_readable_str(unsigned long long size,
320 unsigned long block_size, unsigned long display_unit);
322 int bb_ask_confirmation(void);
323 int klogctl(int type, char * b, int len);
325 char *xgetcwd(char *cwd);
326 char *xreadlink(const char *path);
327 char *concat_path_file(const char *path, const char *filename);
328 char *concat_subpath_file(const char *path, const char *filename);
329 char *last_char_is(const char *s, int c);
332 char *fgets_str(FILE *file, const char *terminating_string);
334 extern int uncompress(int fd_in, int fd_out);
335 extern int inflate(int in, int out);
337 extern struct hostent *xgethostbyname(const char *name);
338 extern struct hostent *xgethostbyname2(const char *name, int af);
339 extern int create_icmp_socket(void);
340 extern int create_icmp6_socket(void);
341 extern int xconnect(struct sockaddr_in *s_addr);
342 extern unsigned short bb_lookup_port(const char *port, const char *protocol, unsigned short default_port);
343 extern void bb_lookup_host(struct sockaddr_in *s_in, const char *host);
345 //#warning wrap this?
346 char *dirname (char *path);
348 int bb_make_directory (char *path, long mode, int flags);
350 int get_signum(char *name);
351 char *get_signame(int number);
353 char *bb_simplify_path(const char *path);
355 enum { /* DO NOT CHANGE THESE VALUES! cp.c depends on them. */
356 FILEUTILS_PRESERVE_STATUS = 1,
357 FILEUTILS_DEREFERENCE = 2,
360 FILEUTILS_INTERACTIVE = 16
363 extern const char *bb_applet_name;
365 extern const char * const bb_msg_full_version;
366 extern const char * const bb_msg_memory_exhausted;
367 extern const char * const bb_msg_invalid_date;
368 extern const char * const bb_msg_io_error;
369 extern const char * const bb_msg_read_error;
370 extern const char * const bb_msg_write_error;
371 extern const char * const bb_msg_name_longer_than_foo;
372 extern const char * const bb_msg_unknown;
373 extern const char * const bb_msg_can_not_create_raw_socket;
374 extern const char * const bb_msg_perm_denied_are_you_root;
375 extern const char * const bb_msg_requires_arg;
376 extern const char * const bb_msg_invalid_arg;
377 extern const char * const bb_msg_standard_input;
378 extern const char * const bb_msg_standard_output;
380 extern const char * const bb_path_nologin_file;
381 extern const char * const bb_path_passwd_file;
382 extern const char * const bb_path_shadow_file;
383 extern const char * const bb_path_gshadow_file;
384 extern const char * const bb_path_group_file;
385 extern const char * const bb_path_securetty_file;
386 extern const char * const bb_path_motd_file;
387 extern const char * const bb_path_wtmp_file;
388 extern const char * const bb_dev_null;
393 extern char bb_common_bufsiz1[BUFSIZ+1];
396 * You can change LIBBB_DEFAULT_LOGIN_SHELL, but don`t use,
397 * use bb_default_login_shell and next defines,
398 * if you LIBBB_DEFAULT_LOGIN_SHELL change,
399 * don`t lose change increment constant!
401 #define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
403 extern const char * const bb_default_login_shell;
405 #define DEFAULT_SHELL (bb_default_login_shell+1)
407 #define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
410 extern char bb_path_mtab_file[];
412 extern int bb_default_error_retval;
414 #ifdef CONFIG_FEATURE_DEVFS
415 # define CURRENT_VC "/dev/vc/0"
416 # define VC_1 "/dev/vc/1"
417 # define VC_2 "/dev/vc/2"
418 # define VC_3 "/dev/vc/3"
419 # define VC_4 "/dev/vc/4"
420 # define VC_5 "/dev/vc/5"
421 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
422 /* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
423 respective serial ports .. as such, we can't use the common device paths for
425 # define SC_0 "/dev/ttsc/0"
426 # define SC_1 "/dev/ttsc/1"
427 # define SC_FORMAT "/dev/ttsc/%d"
429 # define SC_0 "/dev/tts/0"
430 # define SC_1 "/dev/tts/1"
431 # define SC_FORMAT "/dev/tts/%d"
433 # define VC_FORMAT "/dev/vc/%d"
434 # define LOOP_FORMAT "/dev/loop/%d"
435 # define FB_0 "/dev/fb/0"
437 # define CURRENT_VC "/dev/tty0"
438 # define VC_1 "/dev/tty1"
439 # define VC_2 "/dev/tty2"
440 # define VC_3 "/dev/tty3"
441 # define VC_4 "/dev/tty4"
442 # define VC_5 "/dev/tty5"
443 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
444 # define SC_0 "/dev/ttySC0"
445 # define SC_1 "/dev/ttySC1"
446 # define SC_FORMAT "/dev/ttySC%d"
448 # define SC_0 "/dev/ttyS0"
449 # define SC_1 "/dev/ttyS1"
450 # define SC_FORMAT "/dev/ttyS%d"
452 # define VC_FORMAT "/dev/tty%d"
453 # define LOOP_FORMAT "/dev/loop%d"
454 # define FB_0 "/dev/fb0"
457 //#warning put these in .o files
459 /* The following devices are the same on devfs and non-devfs systems. */
460 #define CURRENT_TTY "/dev/tty"
461 #define CONSOLE_DEV "/dev/console"
463 int is_in_ino_dev_hashtable(const struct stat *statbuf, char **name);
464 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
465 void reset_ino_dev_hashtable(void);
467 char *xasprintf(const char *format, ...) __attribute__ ((format (printf, 1, 2)));
468 void xprint_and_close_file(FILE *file);
471 extern void bb_do_delay(int seconds);
472 extern void change_identity ( const struct passwd *pw );
473 extern const char *change_identity_e2str ( const struct passwd *pw );
474 extern void run_shell ( const char *shell, int loginshell, const char *command, const char **additional_args);
475 #ifdef CONFIG_SELINUX
476 extern void renew_current_security_context(void);
477 extern void set_current_security_context(security_context_t sid);
479 extern int run_parts(char **args, const unsigned char test_mode, char **env);
480 extern int restricted_shell ( const char *shell );
481 extern void setup_environment ( const char *shell, int loginshell, int changeenv, const struct passwd *pw );
482 extern int correct_password ( const struct passwd *pw );
483 extern char *pw_encrypt(const char *clear, const char *salt);
484 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp);
486 extern int xopen(const char *pathname, int flags);
487 extern int xopen3(const char *pathname, int flags, int mode);
488 extern void xread(int fd, void *buf, size_t count);
489 extern unsigned char xread_char(int fd);
490 extern void xlseek(int fd, off_t offset, int whence);
491 extern void xwrite(int fd, void *buf, size_t count);
495 #define COMM_LEN TASK_COMM_LEN
497 /* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
507 #ifdef CONFIG_FEATURE_TOP_CPU_USAGE_PERCENTAGE
510 unsigned long stime, utime;
514 /* basename of executable file in call to exec(2),
515 size from kernel headers */
516 char short_cmd[COMM_LEN];
519 extern procps_status_t * procps_scan(int save_user_arg0);
520 extern int compare_string_array(const char * const string_array[], const char *key);
522 extern int my_query_module(const char *name, int which, void **buf, size_t *bufsize, size_t *ret);
524 extern void print_login_issue(const char *issue_file, const char *tty);
525 extern void print_login_prompt(void);
528 extern void vfork_daemon(int nochdir, int noclose);
529 extern void vfork_daemon_rexec(int nochdir, int noclose,
530 int argc, char **argv, char *foreground_opt);
533 extern int get_terminal_width_height(int fd, int *width, int *height);
534 extern unsigned long get_ug_id(const char *s, long (*__bb_getxxnam)(const char *));
536 typedef struct _sha1_ctx_t_ {
542 void sha1_begin(sha1_ctx_t *ctx);
543 void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx);
544 void *sha1_end(void *resbuf, sha1_ctx_t *ctx);
546 typedef struct _md5_ctx_t_ {
556 void md5_begin(md5_ctx_t *ctx);
557 void md5_hash(const void *data, size_t length, md5_ctx_t *ctx);
558 void *md5_end(void *resbuf, md5_ctx_t *ctx);
560 extern uint32_t *crc32_filltable (int endian);
563 /* Stop system and switch power off if possible. */
564 #define RB_POWER_OFF 0x4321fedc
567 extern const char BB_BANNER[];
569 // Make sure we call functions instead of macros.
584 #endif /* __LIBBUSYBOX_H__ */