1 /* vi: set sw=4 ts=4: */
3 * Busybox main internal header file
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 * Based in part on code from sash, Copyright (c) 1999 by David I. Bell
21 * Permission has been granted to redistribute this code under the GPL.
24 #ifndef __LIBCONFIG_H__
25 #define __LIBCONFIG_H__ 1
30 #include <sys/types.h>
39 #include "bb_config.h"
41 #include <selinux/selinux.h>
46 #ifdef CONFIG_FEATURE_SHADOWPASSWDS
49 #ifdef CONFIG_FEATURE_SHA1_PASSWORDS
53 /* Convenience macros to test the version of gcc. */
54 #if defined __GNUC__ && defined __GNUC_MINOR__
55 # define __GNUC_PREREQ(maj, min) \
56 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
58 # define __GNUC_PREREQ(maj, min) 0
61 /* __restrict is known in EGCS 1.2 and above. */
62 #if !__GNUC_PREREQ (2,92)
63 # define __restrict /* Ignore */
66 /* Some useful definitions */
67 #define FALSE ((int) 0)
68 #define TRUE ((int) 1)
69 #define SKIP ((int) 2)
72 #define MTAB_GETMOUNTPT '1'
73 #define MTAB_GETDEVICE '2'
76 #define EXPAND_ALLOC 1024
78 /* Macros for min/max. */
80 #define MIN(a,b) (((a)<(b))?(a):(b))
84 #define MAX(a,b) (((a)>(b))?(a):(b))
87 extern void bb_show_usage(void) __attribute__ ((noreturn));
88 extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
89 extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
90 extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
91 extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
92 extern void bb_vherror_msg(const char *s, va_list p);
93 extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
94 extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
96 extern void bb_perror_nomsg_and_die(void) __attribute__ ((noreturn));
97 extern void bb_perror_nomsg(void);
99 /* These two are used internally -- you shouldn't need to use them */
100 extern void bb_verror_msg(const char *s, va_list p) __attribute__ ((format (printf, 1, 0)));
101 extern void bb_vperror_msg(const char *s, va_list p) __attribute__ ((format (printf, 1, 0)));
103 extern int bb_echo(int argc, char** argv);
105 extern const char *bb_mode_string(int mode);
106 extern int is_directory(const char *name, int followLinks, struct stat *statBuf);
108 extern int remove_file(const char *path, int flags);
109 extern int copy_file(const char *source, const char *dest, int flags);
110 extern ssize_t safe_read(int fd, void *buf, size_t count);
111 extern ssize_t bb_full_read(int fd, void *buf, size_t len);
112 extern ssize_t safe_write(int fd, const void *buf, size_t count);
113 extern ssize_t bb_full_write(int fd, const void *buf, size_t len);
114 extern int recursive_action(const char *fileName, int recurse,
115 int followLinks, int depthFirst,
116 int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData),
117 int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData),
120 extern int bb_parse_mode( const char* s, mode_t* theMode);
121 extern long bb_xgetlarg(const char *arg, int base, long lower, long upper);
123 extern unsigned long bb_baud_to_value(speed_t speed);
124 extern speed_t bb_value_to_baud(unsigned long value);
126 extern int get_kernel_revision(void);
128 extern int get_console_fd(void);
129 extern struct mntent *find_mount_point(const char *name, const char *table);
130 extern void erase_mtab(const char * name);
131 extern long *find_pid_by_name( const char* pidName);
132 extern char *find_block_device(char *path);
133 extern char *bb_get_line_from_file(FILE *file);
134 extern char *bb_get_chomped_line_from_file(FILE *file);
135 extern char *bb_get_chunk_from_file(FILE *file);
136 extern int bb_copyfd_size(int fd1, int fd2, const off_t size);
137 extern int bb_copyfd_eof(int fd1, int fd2);
138 extern void bb_xprint_and_close_file(FILE *file);
139 extern int bb_xprint_file_by_name(const char *filename);
140 extern char bb_process_escape_sequence(const char **ptr);
141 extern char *bb_get_last_path_component(char *path);
142 extern FILE *bb_wfopen(const char *path, const char *mode);
143 extern FILE *bb_wfopen_input(const char *filename);
144 extern FILE *bb_xfopen(const char *path, const char *mode);
146 extern int bb_fclose_nonstdin(FILE *f);
147 extern void bb_fflush_stdout_and_exit(int retval) __attribute__ ((noreturn));
149 #define BB_GETOPT_ERROR 0x80000000UL
150 extern const char *bb_opt_complementally;
151 extern const struct option *bb_applet_long_options;
152 extern unsigned long bb_getopt_ulflags(int argc, char **argv, const char *applet_opts, ...);
154 extern int bb_vfprintf(FILE * __restrict stream, const char * __restrict format,
155 va_list arg) __attribute__ ((format (printf, 2, 0)));
156 extern int bb_vprintf(const char * __restrict format, va_list arg)
157 __attribute__ ((format (printf, 1, 0)));
158 extern int bb_fprintf(FILE * __restrict stream, const char * __restrict format, ...)
159 __attribute__ ((format (printf, 2, 3)));
160 extern int bb_printf(const char * __restrict format, ...)
161 __attribute__ ((format (printf, 1, 2)));
163 //#warning rename to xferror_filename?
164 extern void bb_xferror(FILE *fp, const char *fn);
165 extern void bb_xferror_stdout(void);
166 extern void bb_xfflush_stdout(void);
168 extern void bb_warn_ignoring_args(int n);
170 extern void chomp(char *s);
171 extern void trim(char *s);
172 extern const char *bb_skip_whitespace(const char *);
174 extern struct BB_applet *find_applet_by_name(const char *name);
175 void run_applet_by_name(const char *name, int argc, char **argv);
177 /* dmalloc will redefine these to it's own implementation. It is safe
178 * to have the prototypes here unconditionally. */
179 extern void *xmalloc(size_t size);
180 extern void *xrealloc(void *old, size_t size);
181 extern void *xcalloc(size_t nmemb, size_t size);
183 extern char *bb_xstrdup (const char *s);
184 extern char *bb_xstrndup (const char *s, int n);
185 extern char *safe_strncpy(char *dst, const char *src, size_t size);
186 extern int safe_strtoi(char *arg, int* value);
187 extern int safe_strtod(char *arg, double* value);
188 extern int safe_strtol(char *arg, long* value);
189 extern int safe_strtoul(char *arg, unsigned long* value);
196 extern unsigned long bb_xgetularg_bnd_sfx(const char *arg, int base,
199 const struct suffix_mult *suffixes);
200 extern unsigned long bb_xgetularg_bnd(const char *arg, int base,
202 unsigned long upper);
203 extern unsigned long bb_xgetularg10_bnd(const char *arg,
205 unsigned long upper);
206 extern unsigned long bb_xgetularg10(const char *arg);
208 extern long bb_xgetlarg_bnd_sfx(const char *arg, int base,
211 const struct suffix_mult *suffixes);
212 extern long bb_xgetlarg10_sfx(const char *arg, const struct suffix_mult *suffixes);
215 //#warning pitchable now?
216 extern unsigned long bb_xparse_number(const char *numstr,
217 const struct suffix_mult *suffixes);
220 /* These parse entries in /etc/passwd and /etc/group. This is desirable
221 * for BusyBox since we want to avoid using the glibc NSS stuff, which
222 * increases target size and is often not needed on embedded systems. */
223 extern long bb_xgetpwnam(const char *name);
224 extern long bb_xgetgrnam(const char *name);
225 extern char * bb_getug(char *buffer, char *idname, long id, int bufsize, char prefix);
226 extern char * bb_getpwuid(char *name, long uid, int bufsize);
227 extern char * bb_getgrgid(char *group, long gid, int bufsize);
228 extern char *bb_askpass(int timeout, const char * prompt);
230 extern int device_open(const char *device, int mode);
232 extern int del_loop(const char *device);
233 extern int set_loop(char **device, const char *file, int offset);
236 extern int vdprintf(int d, const char *format, va_list ap);
239 int nfsmount(const char *spec, const char *node, int *flags,
240 char **mount_opts, int running_bg);
242 /* Include our own copy of struct sysinfo to avoid binary compatability
243 * problems with Linux 2.4, which changed things. Grumble, grumble. */
245 long uptime; /* Seconds since boot */
246 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
247 unsigned long totalram; /* Total usable main memory size */
248 unsigned long freeram; /* Available memory size */
249 unsigned long sharedram; /* Amount of shared memory */
250 unsigned long bufferram; /* Memory used by buffers */
251 unsigned long totalswap; /* Total swap space size */
252 unsigned long freeswap; /* swap space still available */
253 unsigned short procs; /* Number of current processes */
254 unsigned short pad; /* Padding needed for m68k */
255 unsigned long totalhigh; /* Total high memory size */
256 unsigned long freehigh; /* Available high memory size */
257 unsigned int mem_unit; /* Memory unit size in bytes */
258 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
260 extern int sysinfo (struct sysinfo* info);
264 MEGABYTE = (KILOBYTE*1024),
265 GIGABYTE = (MEGABYTE*1024)
267 const char *make_human_readable_str(unsigned long long size,
268 unsigned long block_size, unsigned long display_unit);
270 int bb_ask_confirmation(void);
271 int klogctl(int type, char * b, int len);
273 char *xgetcwd(char *cwd);
274 char *xreadlink(const char *path);
275 char *concat_path_file(const char *path, const char *filename);
276 char *concat_subpath_file(const char *path, const char *filename);
277 char *last_char_is(const char *s, int c);
279 int read_package_field(const char *package_buffer, char **field_name, char **field_value);
281 char *fgets_str(FILE *file, const char *terminating_string);
283 extern int uncompress(int fd_in, int fd_out);
284 extern int inflate(int in, int out);
286 extern struct hostent *xgethostbyname(const char *name);
287 extern struct hostent *xgethostbyname2(const char *name, int af);
288 extern int create_icmp_socket(void);
289 extern int create_icmp6_socket(void);
290 extern int xconnect(struct sockaddr_in *s_addr);
291 extern unsigned short bb_lookup_port(const char *port, const char *protocol, unsigned short default_port);
292 extern void bb_lookup_host(struct sockaddr_in *s_in, const char *host);
294 //#warning wrap this?
295 char *dirname (char *path);
297 int bb_make_directory (char *path, long mode, int flags);
299 const char *u_signal_names(const char *str_sig, int *signo, int startnum);
300 char *bb_simplify_path(const char *path);
302 enum { /* DO NOT CHANGE THESE VALUES! cp.c depends on them. */
303 FILEUTILS_PRESERVE_STATUS = 1,
304 FILEUTILS_DEREFERENCE = 2,
307 FILEUTILS_INTERACTIVE = 16
310 extern const char *bb_applet_name;
312 extern const char * const bb_msg_full_version;
313 extern const char * const bb_msg_memory_exhausted;
314 extern const char * const bb_msg_invalid_date;
315 extern const char * const bb_msg_io_error;
316 extern const char * const bb_msg_read_error;
317 extern const char * const bb_msg_write_error;
318 extern const char * const bb_msg_name_longer_than_foo;
319 extern const char * const bb_msg_unknown;
320 extern const char * const bb_msg_can_not_create_raw_socket;
321 extern const char * const bb_msg_perm_denied_are_you_root;
322 extern const char * const bb_msg_standard_input;
323 extern const char * const bb_msg_standard_output;
325 extern const char * const bb_path_nologin_file;
326 extern const char * const bb_path_passwd_file;
327 extern const char * const bb_path_shadow_file;
328 extern const char * const bb_path_gshadow_file;
329 extern const char * const bb_path_group_file;
330 extern const char * const bb_path_securetty_file;
331 extern const char * const bb_path_motd_file;
334 * You can change LIBBB_DEFAULT_LOGIN_SHELL, but don`t use,
335 * use bb_default_login_shell and next defines,
336 * if you LIBBB_DEFAULT_LOGIN_SHELL change,
337 * don`t lose change increment constant!
339 #define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
341 extern const char * const bb_default_login_shell;
343 #define DEFAULT_SHELL (bb_default_login_shell+1)
345 #define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
348 extern const char bb_path_mtab_file[];
350 extern int bb_default_error_retval;
352 #ifdef CONFIG_FEATURE_DEVFS
353 # define CURRENT_VC "/dev/vc/0"
354 # define VC_1 "/dev/vc/1"
355 # define VC_2 "/dev/vc/2"
356 # define VC_3 "/dev/vc/3"
357 # define VC_4 "/dev/vc/4"
358 # define VC_5 "/dev/vc/5"
359 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
360 /* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
361 respective serial ports .. as such, we can't use the common device paths for
363 # define SC_0 "/dev/ttsc/0"
364 # define SC_1 "/dev/ttsc/1"
365 # define SC_FORMAT "/dev/ttsc/%d"
367 # define SC_0 "/dev/tts/0"
368 # define SC_1 "/dev/tts/1"
369 # define SC_FORMAT "/dev/tts/%d"
371 # define VC_FORMAT "/dev/vc/%d"
372 # define LOOP_FORMAT "/dev/loop/%d"
373 # define FB_0 "/dev/fb/0"
375 # define CURRENT_VC "/dev/tty0"
376 # define VC_1 "/dev/tty1"
377 # define VC_2 "/dev/tty2"
378 # define VC_3 "/dev/tty3"
379 # define VC_4 "/dev/tty4"
380 # define VC_5 "/dev/tty5"
381 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
382 # define SC_0 "/dev/ttySC0"
383 # define SC_1 "/dev/ttySC1"
384 # define SC_FORMAT "/dev/ttySC%d"
386 # define SC_0 "/dev/ttyS0"
387 # define SC_1 "/dev/ttyS1"
388 # define SC_FORMAT "/dev/ttyS%d"
390 # define VC_FORMAT "/dev/tty%d"
391 # define LOOP_FORMAT "/dev/loop%d"
392 # define FB_0 "/dev/fb0"
395 //#warning put these in .o files
397 /* The following devices are the same on devfs and non-devfs systems. */
398 #define CURRENT_TTY "/dev/tty"
399 #define CONSOLE_DEV "/dev/console"
401 int is_in_ino_dev_hashtable(const struct stat *statbuf, char **name);
402 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
403 void reset_ino_dev_hashtable(void);
405 /* Stupid gcc always includes its own builtin strlen()... */
406 extern size_t bb_strlen(const char *string);
407 #define strlen(x) bb_strlen(x)
409 void bb_xasprintf(char **string_ptr, const char *format, ...) __attribute__ ((format (printf, 2, 3)));
413 extern void change_identity ( const struct passwd *pw );
414 extern const char *change_identity_e2str ( const struct passwd *pw );
415 extern void run_shell ( const char *shell, int loginshell, const char *command, const char **additional_args);
416 #ifdef CONFIG_SELINUX
417 extern void renew_current_security_context(void);
418 extern void set_current_security_context(security_context_t sid);
420 extern int run_parts(char **args, const unsigned char test_mode, char **env);
421 extern int restricted_shell ( const char *shell );
422 extern void setup_environment ( const char *shell, int loginshell, int changeenv, const struct passwd *pw );
423 extern int correct_password ( const struct passwd *pw );
424 extern char *pw_encrypt(const char *clear, const char *salt);
425 extern struct spwd *pwd_to_spwd(const struct passwd *pw);
426 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp);
428 extern int bb_xopen(const char *pathname, int flags);
429 extern ssize_t bb_xread(int fd, void *buf, size_t count);
430 extern void bb_xread_all(int fd, void *buf, size_t count);
431 extern unsigned char bb_xread_char(int fd);
439 #ifdef CONFIG_FEATURE_TOP_CPU_USAGE_PERCENTAGE
442 unsigned long stime, utime;
446 /* basename of executable file in call to exec(2),
447 size from kernel headers */
451 extern procps_status_t * procps_scan(int save_user_arg0);
452 extern unsigned short compare_string_array(const char *string_array[], const char *key);
454 extern int my_query_module(const char *name, int which, void **buf, size_t *bufsize, size_t *ret);
456 typedef struct llist_s {
458 struct llist_s *link;
460 extern llist_t *llist_add_to(llist_t *old_head, char *new_item);
462 extern void print_login_issue(const char *issue_file, const char *tty);
463 extern void print_login_prompt(void);
465 extern void vfork_daemon_rexec(int nochdir, int noclose,
466 int argc, char **argv, char *foreground_opt);
467 extern int get_terminal_width_height(int fd, int *width, int *height);
468 extern unsigned long get_ug_id(const char *s, long (*__bb_getxxnam)(const char *));
472 extern int hash_fd(int fd, const size_t size, const uint8_t hash_algo, uint8_t *hashval);
474 /* busybox.h will include dmalloc later for us, else include it here. */
475 #if !defined _BB_INTERNAL_H_ && defined DMALLOC
479 #endif /* __LIBCONFIG_H__ */