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"
29 #include <sys/ioctl.h>
30 #include <sys/socket.h>
33 #include <sys/types.h>
39 #include <selinux/selinux.h>
46 /* Try to pull in PATH_MAX */
48 #include <sys/param.h>
57 /* Some useful definitions */
59 #define FALSE ((int) 0)
61 #define TRUE ((int) 1)
63 #define SKIP ((int) 2)
66 #define MTAB_GETMOUNTPT '1'
67 #define MTAB_GETDEVICE '2'
70 #define EXPAND_ALLOC 1024
72 /* Macros for min/max. */
74 #define MIN(a,b) (((a)<(b))?(a):(b))
78 #define MAX(a,b) (((a)>(b))?(a):(b))
81 /* buffer allocation schemes */
82 #ifdef CONFIG_FEATURE_BUFFERS_GO_ON_STACK
83 #define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
84 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
85 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
87 #ifdef CONFIG_FEATURE_BUFFERS_GO_IN_BSS
88 #define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
89 #define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
90 #define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
92 #define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer=xmalloc(len)
93 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer=xmalloc(len)
94 #define RELEASE_CONFIG_BUFFER(buffer) free (buffer)
99 typedef struct llist_s {
101 struct llist_s *link;
103 extern void llist_add_to(llist_t **old_head, void *data);
104 extern void llist_add_to_end(llist_t **list_head, void *data);
105 extern void *llist_pop(llist_t **elm);
106 extern void llist_free(llist_t *elm, void (*freeit)(void *data));
109 extern void bb_show_usage(void) ATTRIBUTE_NORETURN ATTRIBUTE_EXTERNALLY_VISIBLE;
110 extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
111 extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
112 extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
113 extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
114 extern void bb_vherror_msg(const char *s, va_list p);
115 extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
116 extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
118 extern void bb_perror_nomsg_and_die(void) ATTRIBUTE_NORETURN;
119 extern void bb_perror_nomsg(void);
121 /* These two are used internally -- you shouldn't need to use them */
122 extern void bb_verror_msg(const char *s, va_list p) __attribute__ ((format (printf, 1, 0)));
123 extern void bb_vperror_msg(const char *s, va_list p) __attribute__ ((format (printf, 1, 0)));
125 extern int bb_echo(int argc, char** argv);
126 extern int bb_test(int argc, char** argv);
128 extern const char *bb_mode_string(int mode);
129 extern int is_directory(const char *name, int followLinks, struct stat *statBuf);
130 extern DIR *bb_opendir(const char *path);
131 extern DIR *bb_xopendir(const char *path);
133 extern int remove_file(const char *path, int flags);
134 extern int copy_file(const char *source, const char *dest, int flags);
135 extern ssize_t safe_read(int fd, void *buf, size_t count);
136 extern ssize_t bb_full_read(int fd, void *buf, size_t len);
137 extern ssize_t safe_write(int fd, const void *buf, size_t count);
138 extern ssize_t bb_full_write(int fd, const void *buf, size_t len);
139 extern int recursive_action(const char *fileName, int recurse,
140 int followLinks, int depthFirst,
141 int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData),
142 int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData),
145 extern int bb_parse_mode( const char* s, mode_t* theMode);
146 extern long bb_xgetlarg(const char *arg, int base, long lower, long upper);
148 extern unsigned int tty_baud_to_value(speed_t speed);
149 extern speed_t tty_value_to_baud(unsigned int value);
151 extern int get_linux_version_code(void);
153 extern int get_console_fd(void);
154 extern struct mntent *find_mount_point(const char *name, const char *table);
155 extern void erase_mtab(const char * name);
156 extern long *find_pid_by_name( const char* pidName);
157 extern long *pidlist_reverse(long *pidList);
158 extern char *find_block_device(char *path);
159 extern char *bb_get_line_from_file(FILE *file);
160 extern char *bb_get_chomped_line_from_file(FILE *file);
161 extern char *bb_get_chunk_from_file(FILE *file, int *end);
162 extern int bb_copyfd_size(int fd1, int fd2, const off_t size);
163 extern int bb_copyfd_eof(int fd1, int fd2);
164 extern void bb_xprint_and_close_file(FILE *file);
165 extern int bb_xprint_file_by_name(const char *filename);
166 extern char bb_process_escape_sequence(const char **ptr);
167 extern char *bb_get_last_path_component(char *path);
168 extern FILE *bb_wfopen(const char *path, const char *mode);
169 extern FILE *bb_wfopen_input(const char *filename);
170 extern FILE *bb_xfopen(const char *path, const char *mode);
172 extern int bb_fclose_nonstdin(FILE *f);
173 extern void bb_fflush_stdout_and_exit(int retval) ATTRIBUTE_NORETURN;
175 extern void xstat(const char *filename, struct stat *buf);
176 extern int bb_xsocket(int domain, int type, int protocol);
177 extern pid_t bb_spawn(char **argv);
178 extern pid_t bb_xspawn(char **argv);
179 extern int wait4pid(int pid);
180 extern void bb_xdaemon(int nochdir, int noclose);
181 extern void bb_xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen);
182 extern void bb_xlisten(int s, int backlog);
183 extern void bb_xchdir(const char *path);
184 extern void utoa_to_buf(unsigned n, char *buf, unsigned buflen);
185 extern char *utoa(unsigned n);
186 extern void itoa_to_buf(int n, char *buf, unsigned buflen);
187 extern char *itoa(int n);
189 #define BB_GETOPT_ERROR 0x80000000UL
190 extern const char *bb_opt_complementally;
191 extern const struct option *bb_applet_long_options;
192 extern unsigned long bb_getopt_ulflags(int argc, char **argv, const char *applet_opts, ...);
194 extern int bb_vfprintf(FILE * __restrict stream, const char * __restrict format,
195 va_list arg) __attribute__ ((format (printf, 2, 0)));
196 extern int bb_vprintf(const char * __restrict format, va_list arg)
197 __attribute__ ((format (printf, 1, 0)));
198 extern int bb_fprintf(FILE * __restrict stream, const char * __restrict format, ...)
199 __attribute__ ((format (printf, 2, 3)));
200 extern int bb_printf(const char * __restrict format, ...)
201 __attribute__ ((format (printf, 1, 2)));
203 //#warning rename to xferror_filename?
204 extern void bb_xferror(FILE *fp, const char *fn);
205 extern void bb_xferror_stdout(void);
206 extern void bb_xfflush_stdout(void);
208 extern void bb_warn_ignoring_args(int n);
210 extern void chomp(char *s);
211 extern void trim(char *s);
212 extern char *skip_whitespace(const char *);
214 extern struct BB_applet *find_applet_by_name(const char *name);
215 void run_applet_by_name(const char *name, int argc, char **argv);
217 /* dmalloc will redefine these to it's own implementation. It is safe
218 * to have the prototypes here unconditionally. */
219 extern void *xmalloc(size_t size);
220 extern void *xrealloc(void *old, size_t size);
221 extern void *xzalloc(size_t size);
222 extern void *xcalloc(size_t nmemb, size_t size);
224 extern char *bb_xstrdup (const char *s);
225 extern char *bb_xstrndup (const char *s, int n);
226 extern char *safe_strncpy(char *dst, const char *src, size_t size);
227 extern int safe_strtoi(char *arg, int* value);
228 extern int safe_strtod(char *arg, double* value);
229 extern int safe_strtol(char *arg, long* value);
230 extern int safe_strtoul(char *arg, unsigned long* value);
237 extern unsigned long bb_xgetularg_bnd_sfx(const char *arg, int base,
240 const struct suffix_mult *suffixes);
241 extern unsigned long bb_xgetularg_bnd(const char *arg, int base,
243 unsigned long upper);
244 extern unsigned long bb_xgetularg10_bnd(const char *arg,
246 unsigned long upper);
247 extern unsigned long bb_xgetularg10(const char *arg);
249 extern long bb_xgetlarg_bnd_sfx(const char *arg, int base,
252 const struct suffix_mult *suffixes);
253 extern long bb_xgetlarg10_sfx(const char *arg, const struct suffix_mult *suffixes);
256 //#warning pitchable now?
257 extern unsigned long bb_xparse_number(const char *numstr,
258 const struct suffix_mult *suffixes);
261 /* These parse entries in /etc/passwd and /etc/group. This is desirable
262 * for BusyBox since we want to avoid using the glibc NSS stuff, which
263 * increases target size and is often not needed on embedded systems. */
264 extern long bb_xgetpwnam(const char *name);
265 extern long bb_xgetgrnam(const char *name);
266 extern char * bb_getug(char *buffer, char *idname, long id, int bufsize, char prefix);
267 extern char * bb_getpwuid(char *name, long uid, int bufsize);
268 extern char * bb_getgrgid(char *group, long gid, int bufsize);
269 extern char *bb_askpass(int timeout, const char * prompt);
271 extern int device_open(const char *device, int mode);
273 extern char *query_loop(const char *device);
274 extern int del_loop(const char *device);
275 extern int set_loop(char **device, const char *file, int offset);
278 extern int vdprintf(int d, const char *format, va_list ap);
281 int nfsmount(const char *spec, const char *node, int *flags,
282 char **mount_opts, int running_bg);
284 /* Include our own copy of struct sysinfo to avoid binary compatibility
285 * problems with Linux 2.4, which changed things. Grumble, grumble. */
287 long uptime; /* Seconds since boot */
288 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
289 unsigned long totalram; /* Total usable main memory size */
290 unsigned long freeram; /* Available memory size */
291 unsigned long sharedram; /* Amount of shared memory */
292 unsigned long bufferram; /* Memory used by buffers */
293 unsigned long totalswap; /* Total swap space size */
294 unsigned long freeswap; /* swap space still available */
295 unsigned short procs; /* Number of current processes */
296 unsigned short pad; /* Padding needed for m68k */
297 unsigned long totalhigh; /* Total high memory size */
298 unsigned long freehigh; /* Available high memory size */
299 unsigned int mem_unit; /* Memory unit size in bytes */
300 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
302 extern int sysinfo (struct sysinfo* info);
306 MEGABYTE = (KILOBYTE*1024),
307 GIGABYTE = (MEGABYTE*1024)
309 const char *make_human_readable_str(unsigned long long size,
310 unsigned long block_size, unsigned long display_unit);
312 int bb_ask_confirmation(void);
313 int klogctl(int type, char * b, int len);
315 char *xgetcwd(char *cwd);
316 char *xreadlink(const char *path);
317 char *concat_path_file(const char *path, const char *filename);
318 char *concat_subpath_file(const char *path, const char *filename);
319 char *last_char_is(const char *s, int c);
321 int read_package_field(const char *package_buffer, char **field_name, char **field_value);
323 char *fgets_str(FILE *file, const char *terminating_string);
325 extern int uncompress(int fd_in, int fd_out);
326 extern int inflate(int in, int out);
328 extern struct hostent *xgethostbyname(const char *name);
329 extern struct hostent *xgethostbyname2(const char *name, int af);
330 extern int create_icmp_socket(void);
331 extern int create_icmp6_socket(void);
332 extern int xconnect(struct sockaddr_in *s_addr);
333 extern unsigned short bb_lookup_port(const char *port, const char *protocol, unsigned short default_port);
334 extern void bb_lookup_host(struct sockaddr_in *s_in, const char *host);
336 //#warning wrap this?
337 char *dirname (char *path);
339 int bb_make_directory (char *path, long mode, int flags);
341 int get_signum(char *name);
342 char *get_signame(int number);
344 char *bb_simplify_path(const char *path);
346 enum { /* DO NOT CHANGE THESE VALUES! cp.c depends on them. */
347 FILEUTILS_PRESERVE_STATUS = 1,
348 FILEUTILS_DEREFERENCE = 2,
351 FILEUTILS_INTERACTIVE = 16
354 extern const char *bb_applet_name;
356 extern const char * const bb_msg_full_version;
357 extern const char * const bb_msg_memory_exhausted;
358 extern const char * const bb_msg_invalid_date;
359 extern const char * const bb_msg_io_error;
360 extern const char * const bb_msg_read_error;
361 extern const char * const bb_msg_write_error;
362 extern const char * const bb_msg_name_longer_than_foo;
363 extern const char * const bb_msg_unknown;
364 extern const char * const bb_msg_can_not_create_raw_socket;
365 extern const char * const bb_msg_perm_denied_are_you_root;
366 extern const char * const bb_msg_requires_arg;
367 extern const char * const bb_msg_invalid_arg;
368 extern const char * const bb_msg_standard_input;
369 extern const char * const bb_msg_standard_output;
371 extern const char * const bb_path_nologin_file;
372 extern const char * const bb_path_passwd_file;
373 extern const char * const bb_path_shadow_file;
374 extern const char * const bb_path_gshadow_file;
375 extern const char * const bb_path_group_file;
376 extern const char * const bb_path_securetty_file;
377 extern const char * const bb_path_motd_file;
378 extern const char * const bb_path_wtmp_file;
379 extern const char * const bb_dev_null;
384 extern char bb_common_bufsiz1[BUFSIZ+1];
387 * You can change LIBBB_DEFAULT_LOGIN_SHELL, but don`t use,
388 * use bb_default_login_shell and next defines,
389 * if you LIBBB_DEFAULT_LOGIN_SHELL change,
390 * don`t lose change increment constant!
392 #define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
394 extern const char * const bb_default_login_shell;
396 #define DEFAULT_SHELL (bb_default_login_shell+1)
398 #define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
401 extern const char bb_path_mtab_file[];
403 extern int bb_default_error_retval;
405 #ifdef CONFIG_FEATURE_DEVFS
406 # define CURRENT_VC "/dev/vc/0"
407 # define VC_1 "/dev/vc/1"
408 # define VC_2 "/dev/vc/2"
409 # define VC_3 "/dev/vc/3"
410 # define VC_4 "/dev/vc/4"
411 # define VC_5 "/dev/vc/5"
412 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
413 /* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
414 respective serial ports .. as such, we can't use the common device paths for
416 # define SC_0 "/dev/ttsc/0"
417 # define SC_1 "/dev/ttsc/1"
418 # define SC_FORMAT "/dev/ttsc/%d"
420 # define SC_0 "/dev/tts/0"
421 # define SC_1 "/dev/tts/1"
422 # define SC_FORMAT "/dev/tts/%d"
424 # define VC_FORMAT "/dev/vc/%d"
425 # define LOOP_FORMAT "/dev/loop/%d"
426 # define FB_0 "/dev/fb/0"
428 # define CURRENT_VC "/dev/tty0"
429 # define VC_1 "/dev/tty1"
430 # define VC_2 "/dev/tty2"
431 # define VC_3 "/dev/tty3"
432 # define VC_4 "/dev/tty4"
433 # define VC_5 "/dev/tty5"
434 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
435 # define SC_0 "/dev/ttySC0"
436 # define SC_1 "/dev/ttySC1"
437 # define SC_FORMAT "/dev/ttySC%d"
439 # define SC_0 "/dev/ttyS0"
440 # define SC_1 "/dev/ttyS1"
441 # define SC_FORMAT "/dev/ttyS%d"
443 # define VC_FORMAT "/dev/tty%d"
444 # define LOOP_FORMAT "/dev/loop%d"
445 # define FB_0 "/dev/fb0"
448 //#warning put these in .o files
450 /* The following devices are the same on devfs and non-devfs systems. */
451 #define CURRENT_TTY "/dev/tty"
452 #define CONSOLE_DEV "/dev/console"
454 int is_in_ino_dev_hashtable(const struct stat *statbuf, char **name);
455 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
456 void reset_ino_dev_hashtable(void);
458 char *bb_xasprintf(const char *format, ...) __attribute__ ((format (printf, 1, 2)));
461 extern void bb_do_delay(int seconds);
462 extern void change_identity ( const struct passwd *pw );
463 extern const char *change_identity_e2str ( const struct passwd *pw );
464 extern void run_shell ( const char *shell, int loginshell, const char *command, const char **additional_args);
465 #ifdef CONFIG_SELINUX
466 extern void renew_current_security_context(void);
467 extern void set_current_security_context(security_context_t sid);
469 extern int run_parts(char **args, const unsigned char test_mode, char **env);
470 extern int restricted_shell ( const char *shell );
471 extern void setup_environment ( const char *shell, int loginshell, int changeenv, const struct passwd *pw );
472 extern int correct_password ( const struct passwd *pw );
473 extern char *pw_encrypt(const char *clear, const char *salt);
474 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp);
476 extern int bb_xopen(const char *pathname, int flags);
477 extern int bb_xopen3(const char *pathname, int flags, int mode);
478 extern ssize_t bb_xread(int fd, void *buf, size_t count);
479 extern void bb_xread_all(int fd, void *buf, size_t count);
480 extern unsigned char bb_xread_char(int fd);
484 #define COMM_LEN TASK_COMM_LEN
486 /* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
496 #ifdef CONFIG_FEATURE_TOP_CPU_USAGE_PERCENTAGE
499 unsigned long stime, utime;
503 /* basename of executable file in call to exec(2),
504 size from kernel headers */
505 char short_cmd[COMM_LEN];
508 extern procps_status_t * procps_scan(int save_user_arg0);
509 extern int compare_string_array(const char * const string_array[], const char *key);
511 extern int my_query_module(const char *name, int which, void **buf, size_t *bufsize, size_t *ret);
513 extern void print_login_issue(const char *issue_file, const char *tty);
514 extern void print_login_prompt(void);
517 extern void vfork_daemon(int nochdir, int noclose);
518 extern void vfork_daemon_rexec(int nochdir, int noclose,
519 int argc, char **argv, char *foreground_opt);
522 extern int get_terminal_width_height(int fd, int *width, int *height);
523 extern unsigned long get_ug_id(const char *s, long (*__bb_getxxnam)(const char *));
525 typedef struct _sha1_ctx_t_ {
531 void sha1_begin(sha1_ctx_t *ctx);
532 void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx);
533 void *sha1_end(void *resbuf, sha1_ctx_t *ctx);
535 typedef struct _md5_ctx_t_ {
545 void md5_begin(md5_ctx_t *ctx);
546 void md5_hash(const void *data, size_t length, md5_ctx_t *ctx);
547 void *md5_end(void *resbuf, md5_ctx_t *ctx);
549 extern uint32_t *bb_crc32_filltable (int endian);
552 /* Stop system and switch power off if possible. */
553 #define RB_POWER_OFF 0x4321fedc
556 extern const char BB_BANNER[];
558 // Make sure we call functions instead of macros.
573 #endif /* __LIBBUSYBOX_H__ */