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>
44 #include <proc_secure.h>
49 #ifdef CONFIG_FEATURE_SHADOWPASSWDS
52 #ifdef CONFIG_FEATURE_SHA1_PASSWORDS
56 /* Convenience macros to test the version of gcc. */
57 #if defined __GNUC__ && defined __GNUC_MINOR__
58 # define __GNUC_PREREQ(maj, min) \
59 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
61 # define __GNUC_PREREQ(maj, min) 0
64 /* __restrict is known in EGCS 1.2 and above. */
65 #if !__GNUC_PREREQ (2,92)
66 # define __restrict /* Ignore */
69 /* Some useful definitions */
70 #define FALSE ((int) 0)
71 #define TRUE ((int) 1)
72 #define SKIP ((int) 2)
75 #define MTAB_GETMOUNTPT '1'
76 #define MTAB_GETDEVICE '2'
79 #define EXPAND_ALLOC 1024
81 /* Macros for min/max. */
83 #define MIN(a,b) (((a)<(b))?(a):(b))
87 #define MAX(a,b) (((a)>(b))?(a):(b))
90 extern void bb_show_usage(void) __attribute__ ((noreturn));
91 extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
92 extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
93 extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
94 extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
95 extern void bb_vherror_msg(const char *s, va_list p);
96 extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
97 extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
99 extern void bb_perror_nomsg_and_die(void) __attribute__ ((noreturn));
100 extern void bb_perror_nomsg(void);
102 /* These two are used internally -- you shouldn't need to use them */
103 extern void bb_verror_msg(const char *s, va_list p) __attribute__ ((format (printf, 1, 0)));
104 extern void bb_vperror_msg(const char *s, va_list p) __attribute__ ((format (printf, 1, 0)));
106 extern const char *bb_mode_string(int mode);
107 extern int is_directory(const char *name, int followLinks, struct stat *statBuf);
109 extern int remove_file(const char *path, int flags);
110 extern int copy_file(const char *source, const char *dest, int flags);
111 extern ssize_t safe_read(int fd, void *buf, size_t count);
112 extern ssize_t safe_write(int fd, void *buf, size_t count);
113 extern ssize_t bb_full_write(int fd, const void *buf, size_t len);
114 extern ssize_t bb_full_read(int fd, void *buf, size_t len);
115 extern int recursive_action(const char *fileName, int recurse,
116 int followLinks, int depthFirst,
117 int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData),
118 int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData),
121 extern int bb_parse_mode( const char* s, mode_t* theMode);
122 extern long bb_xgetlarg(const char *arg, int base, long lower, long upper);
124 extern unsigned long bb_baud_to_value(speed_t speed);
125 extern speed_t bb_value_to_baud(unsigned long value);
127 extern int get_kernel_revision(void);
129 extern int get_console_fd(void);
130 extern struct mntent *find_mount_point(const char *name, const char *table);
131 extern void write_mtab(char* blockDevice, char* directory,
132 char* filesystemType, long flags, char* string_flags);
133 extern void erase_mtab(const char * name);
134 extern long *find_pid_by_name( const char* pidName);
135 extern char *find_real_root_device_name(const char* name);
136 extern char *bb_get_line_from_file(FILE *file);
137 extern char *bb_get_chomped_line_from_file(FILE *file);
138 extern int bb_copyfd(int fd1, int fd2, const off_t chunksize);
139 extern void bb_xprint_and_close_file(FILE *file);
140 extern int bb_xprint_file_by_name(const char *filename);
141 extern char bb_process_escape_sequence(const char **ptr);
142 extern char *bb_get_last_path_component(char *path);
143 extern FILE *bb_wfopen(const char *path, const char *mode);
144 extern FILE *bb_xfopen(const char *path, const char *mode);
147 extern int bb_fclose_nonstdin(FILE *f);
148 extern void bb_fflush_stdout_and_exit(int retval) __attribute__ ((noreturn));
150 extern const char *bb_opt_complementaly;
151 extern const struct option *bb_applet_long_options;
152 extern unsigned long bb_getopt_ulflags(int argc, char **argv, const char *applet_opts, ...);
155 extern FILE *bb_wfopen_input(const char *filename);
157 extern int bb_vfprintf(FILE * __restrict stream, const char * __restrict format,
158 va_list arg) __attribute__ ((format (printf, 2, 0)));
159 extern int bb_vprintf(const char * __restrict format, va_list arg)
160 __attribute__ ((format (printf, 1, 0)));
161 extern int bb_fprintf(FILE * __restrict stream, const char * __restrict format, ...)
162 __attribute__ ((format (printf, 2, 3)));
163 extern int bb_printf(const char * __restrict format, ...)
164 __attribute__ ((format (printf, 1, 2)));
166 //#warning rename to xferror_filename?
167 extern void bb_xferror(FILE *fp, const char *fn);
168 extern void bb_xferror_stdout(void);
169 extern void bb_xfflush_stdout(void);
171 extern void bb_warn_ignoring_args(int n);
173 extern void chomp(char *s);
174 extern void trim(char *s);
175 extern const char *bb_skip_whitespace(const char *);
177 extern struct BB_applet *find_applet_by_name(const char *name);
178 void run_applet_by_name(const char *name, int argc, char **argv);
180 //#warning is this needed anymore?
182 extern void *xmalloc (size_t size);
183 extern void *xrealloc(void *old, size_t size);
184 extern void *xcalloc(size_t nmemb, size_t size);
186 extern char *bb_xstrdup (const char *s);
187 extern char *bb_xstrndup (const char *s, int n);
188 extern char * safe_strncpy(char *dst, const char *src, size_t size);
195 extern unsigned long bb_xgetularg_bnd_sfx(const char *arg, int base,
198 const struct suffix_mult *suffixes);
199 extern unsigned long bb_xgetularg_bnd(const char *arg, int base,
201 unsigned long upper);
202 extern unsigned long bb_xgetularg10_bnd(const char *arg,
204 unsigned long upper);
205 extern unsigned long bb_xgetularg10(const char *arg);
207 extern long bb_xgetlarg_bnd_sfx(const char *arg, int base,
210 const struct suffix_mult *suffixes);
211 extern long bb_xgetlarg10_sfx(const char *arg, const struct suffix_mult *suffixes);
214 //#warning pitchable now?
215 extern unsigned long bb_xparse_number(const char *numstr,
216 const struct suffix_mult *suffixes);
219 //#warning change names?
221 /* These parse entries in /etc/passwd and /etc/group. This is desirable
222 * for BusyBox since we want to avoid using the glibc NSS stuff, which
223 * increases target size and is often not needed embedded systems. */
224 extern long my_getpwnam(const char *name);
225 extern long my_getgrnam(const char *name);
226 extern char * my_getpwuid(char *name, long uid);
227 extern char * my_getgrgid(char *group, long gid);
228 extern long my_getpwnamegid(const char *name);
230 extern int device_open(const char *device, int mode);
232 extern int del_loop(const char *device);
233 extern int set_loop(const char *device, const char *file, int offset, int *loopro);
234 extern char *find_unused_loop_device (void);
238 extern int vdprintf(int d, const char *format, va_list ap);
241 int nfsmount(const char *spec, const char *node, int *flags,
242 char **extra_opts, char **mount_opts, int running_bg);
244 void syslog_msg_with_name(const char *name, int facility, int pri, const char *msg);
245 void syslog_msg(int facility, int pri, const char *msg);
247 /* Include our own copy of struct sysinfo to avoid binary compatability
248 * problems with Linux 2.4, which changed things. Grumble, grumble. */
250 long uptime; /* Seconds since boot */
251 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
252 unsigned long totalram; /* Total usable main memory size */
253 unsigned long freeram; /* Available memory size */
254 unsigned long sharedram; /* Amount of shared memory */
255 unsigned long bufferram; /* Memory used by buffers */
256 unsigned long totalswap; /* Total swap space size */
257 unsigned long freeswap; /* swap space still available */
258 unsigned short procs; /* Number of current processes */
259 unsigned short pad; /* Padding needed for m68k */
260 unsigned long totalhigh; /* Total high memory size */
261 unsigned long freehigh; /* Available high memory size */
262 unsigned int mem_unit; /* Memory unit size in bytes */
263 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
265 extern int sysinfo (struct sysinfo* info);
269 MEGABYTE = (KILOBYTE*1024),
270 GIGABYTE = (MEGABYTE*1024)
272 const char *make_human_readable_str(unsigned long long size,
273 unsigned long block_size, unsigned long display_unit);
275 int bb_ask_confirmation(void);
276 int klogctl(int type, char * b, int len);
278 char *xgetcwd(char *cwd);
279 char *xreadlink(const char *path);
280 char *concat_path_file(const char *path, const char *filename);
281 char *concat_subpath_file(const char *path, const char *filename);
282 char *last_char_is(const char *s, int c);
284 extern long arith (const char *startbuf, int *errcode);
286 int read_package_field(const char *package_buffer, char **field_name, char **field_value);
288 char *fgets_str(FILE *file, const char *terminating_string);
290 extern int uncompress(int fd_in, int fd_out);
291 extern int inflate(int in, int out);
293 extern struct hostent *xgethostbyname(const char *name);
294 extern struct hostent *xgethostbyname2(const char *name, int af);
295 extern int create_icmp_socket(void);
296 extern int create_icmp6_socket(void);
297 extern int xconnect(const char *host, const char *port);
299 //#warning wrap this?
300 char *dirname (char *path);
302 int bb_make_directory (char *path, long mode, int flags);
304 const char *u_signal_names(const char *str_sig, int *signo, int startnum);
305 char *bb_simplify_path(const char *path);
307 enum { /* DO NOT CHANGE THESE VALUES! cp.c depends on them. */
308 FILEUTILS_PRESERVE_STATUS = 1,
309 FILEUTILS_DEREFERENCE = 2,
312 FILEUTILS_INTERACTIVE = 16
315 extern const char *bb_applet_name;
317 extern const char * const bb_msg_full_version;
318 extern const char * const bb_msg_memory_exhausted;
319 extern const char * const bb_msg_invalid_date;
320 extern const char * const bb_msg_io_error;
321 extern const char * const bb_msg_write_error;
322 extern const char * const bb_msg_name_longer_than_foo;
323 extern const char * const bb_msg_unknown;
324 extern const char * const bb_msg_can_not_create_raw_socket;
325 extern const char * const bb_msg_perm_denied_are_you_root;
326 extern const char * const bb_msg_standard_input;
327 extern const char * const bb_msg_standard_output;
329 extern const char * const bb_path_nologin_file;
330 extern const char * const bb_path_passwd_file;
331 extern const char * const bb_path_shadow_file;
332 extern const char * const bb_path_gshadow_file;
333 extern const char * const bb_path_group_file;
334 extern const char * const bb_path_securetty_file;
335 extern const char * const bb_path_motd_file;
338 * You can change LIBBB_DEFAULT_LOGIN_SHELL, but don`t use,
339 * use bb_default_login_shell and next defines,
340 * if you LIBBB_DEFAULT_LOGIN_SHELL change,
341 * don`t lose change increment constant!
343 #define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
345 extern const char * const bb_default_login_shell;
347 #define DEFAULT_SHELL (bb_default_login_shell+1)
349 #define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
352 extern const char bb_path_mtab_file[];
354 extern int bb_default_error_retval;
356 #ifdef CONFIG_FEATURE_DEVFS
357 # define CURRENT_VC "/dev/vc/0"
358 # define VC_1 "/dev/vc/1"
359 # define VC_2 "/dev/vc/2"
360 # define VC_3 "/dev/vc/3"
361 # define VC_4 "/dev/vc/4"
362 # define VC_5 "/dev/vc/5"
363 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
364 /* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
365 respective serial ports .. as such, we can't use the common device paths for
367 # define SC_0 "/dev/ttsc/0"
368 # define SC_1 "/dev/ttsc/1"
369 # define SC_FORMAT "/dev/ttsc/%d"
371 # define SC_0 "/dev/tts/0"
372 # define SC_1 "/dev/tts/1"
373 # define SC_FORMAT "/dev/tts/%d"
375 # define VC_FORMAT "/dev/vc/%d"
376 # define LOOP_FORMAT "/dev/loop/%d"
378 # define CURRENT_VC "/dev/tty0"
379 # define VC_1 "/dev/tty1"
380 # define VC_2 "/dev/tty2"
381 # define VC_3 "/dev/tty3"
382 # define VC_4 "/dev/tty4"
383 # define VC_5 "/dev/tty5"
384 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
385 # define SC_0 "/dev/ttySC0"
386 # define SC_1 "/dev/ttySC1"
387 # define SC_FORMAT "/dev/ttySC%d"
389 # define SC_0 "/dev/ttyS0"
390 # define SC_1 "/dev/ttyS1"
391 # define SC_FORMAT "/dev/ttyS%d"
393 # define VC_FORMAT "/dev/tty%d"
394 # define LOOP_FORMAT "/dev/loop%d"
397 //#warning put these in .o files
399 /* The following devices are the same on devfs and non-devfs systems. */
400 #define CURRENT_TTY "/dev/tty"
401 #define CONSOLE_DEV "/dev/console"
403 int is_in_ino_dev_hashtable(const struct stat *statbuf, char **name);
404 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
405 void reset_ino_dev_hashtable(void);
407 /* Stupid gcc always includes its own builtin strlen()... */
408 extern size_t bb_strlen(const char *string);
409 #define strlen(x) bb_strlen(x)
411 void bb_xasprintf(char **string_ptr, const char *format, ...) __attribute__ ((format (printf, 2, 3)));
415 extern void change_identity ( const struct passwd *pw );
416 extern const char *change_identity_e2str ( const struct passwd *pw );
417 extern void run_shell ( const char *shell, int loginshell, const char *command, const char **additional_args
418 #ifdef CONFIG_SELINUX
422 extern int run_parts(char **args, const unsigned char test_mode, char **env);
423 extern int restricted_shell ( const char *shell );
424 extern void setup_environment ( const char *shell, int loginshell, int changeenv, const struct passwd *pw );
425 extern int correct_password ( const struct passwd *pw );
426 extern char *pw_encrypt(const char *clear, const char *salt);
427 extern struct spwd *pwd_to_spwd(const struct passwd *pw);
428 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp);
430 extern int bb_xopen(const char *pathname, int flags);
431 extern ssize_t bb_xread(int fd, void *buf, size_t count);
432 extern void bb_xread_all(int fd, void *buf, size_t count);
433 extern unsigned char bb_xread_char(int fd);
441 #ifdef FEATURE_CPU_USAGE_PERCENTAGE
443 unsigned long stime, utime;
447 /* basename of executable file in call to exec(2),
448 size from kernel headers */
452 extern procps_status_t * procps_scan(int save_user_arg0
453 #ifdef CONFIG_SELINUX
454 , int use_selinux, security_id_t *sid
457 extern unsigned short compare_string_array(const char *string_array[], const char *key);
459 extern int my_query_module(const char *name, int which, void **buf, size_t *bufsize, size_t *ret);
461 typedef struct llist_s {
463 struct llist_s *link;
465 extern llist_t *llist_add_to(llist_t *old_head, char *new_item);
467 extern void print_login_issue(const char *issue_file, const char *tty);
468 extern void print_login_prompt(void);
470 extern void vfork_daemon_rexec(int argc, char **argv, char *foreground_opt);
471 extern void get_terminal_width_height(int fd, int *width, int *height);
472 extern unsigned long get_ug_id(const char *s, long (*my_getxxnam)(const char *));
473 extern void xregcomp(regex_t *preg, const char *regex, int cflags);
474 #endif /* __LIBCONFIG_H__ */