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>
43 #include <proc_secure.h>
48 #ifdef CONFIG_FEATURE_SHADOWPASSWDS
51 #ifdef CONFIG_FEATURE_SHA1_PASSWORDS
55 /* Compatability with ANSI C */
60 #if (__GNU_LIBRARY__ < 5) && (!defined __dietlibc__)
61 /* libc5 doesn't define socklen_t */
64 typedef unsigned int socklen_t;
66 /* libc5 doesn't implement BSD 4.4 daemon() */
67 extern int daemon (int nochdir, int noclose);
68 /* libc5 doesn't implement strtok_r */
69 char *strtok_r(char *s, const char *delim, char **ptrptr);
72 /* Convenience macros to test the version of gcc. */
73 #if defined __GNUC__ && defined __GNUC_MINOR__
74 # define __GNUC_PREREQ(maj, min) \
75 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
77 # define __GNUC_PREREQ(maj, min) 0
80 /* __restrict is known in EGCS 1.2 and above. */
81 #if !__GNUC_PREREQ (2,92)
82 # define __restrict /* Ignore */
85 /* Some useful definitions */
86 #define FALSE ((int) 0)
87 #define TRUE ((int) 1)
88 #define SKIP ((int) 2)
91 #define MTAB_GETMOUNTPT '1'
92 #define MTAB_GETDEVICE '2'
95 #define EXPAND_ALLOC 1024
97 /* Macros for min/max. */
99 #define MIN(a,b) (((a)<(b))?(a):(b))
103 #define MAX(a,b) (((a)>(b))?(a):(b))
106 extern void bb_show_usage(void) __attribute__ ((noreturn));
107 extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
108 extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
109 extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
110 extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
111 extern void bb_vherror_msg(const char *s, va_list p);
112 extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
113 extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
115 extern void bb_perror_nomsg_and_die(void) __attribute__ ((noreturn));
116 extern void bb_perror_nomsg(void);
118 /* These two are used internally -- you shouldn't need to use them */
119 extern void bb_verror_msg(const char *s, va_list p) __attribute__ ((format (printf, 1, 0)));
120 extern void bb_vperror_msg(const char *s, va_list p) __attribute__ ((format (printf, 1, 0)));
122 extern const char *bb_mode_string(int mode);
123 extern int is_directory(const char *name, int followLinks, struct stat *statBuf);
125 extern int remove_file(const char *path, int flags);
126 extern int copy_file(const char *source, const char *dest, int flags);
127 extern ssize_t safe_read(int fd, void *buf, size_t count);
128 extern ssize_t bb_full_write(int fd, const void *buf, size_t len);
129 extern ssize_t bb_full_read(int fd, void *buf, size_t len);
130 extern int recursive_action(const char *fileName, int recurse,
131 int followLinks, int depthFirst,
132 int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData),
133 int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData),
136 extern int bb_parse_mode( const char* s, mode_t* theMode);
137 extern long bb_xgetlarg(const char *arg, int base, long lower, long upper);
139 extern unsigned long bb_baud_to_value(speed_t speed);
140 extern speed_t bb_value_to_baud(unsigned long value);
142 extern int get_kernel_revision(void);
144 extern int get_console_fd(void);
145 extern struct mntent *find_mount_point(const char *name, const char *table);
146 extern void write_mtab(char* blockDevice, char* directory,
147 char* filesystemType, long flags, char* string_flags);
148 extern void erase_mtab(const char * name);
149 extern long *find_pid_by_name( const char* pidName);
150 extern char *find_real_root_device_name(const char* name);
151 extern char *bb_get_line_from_file(FILE *file);
152 extern char *bb_get_chomped_line_from_file(FILE *file);
153 extern int bb_copyfd(int fd1, int fd2, const off_t chunksize);
154 extern void bb_xprint_and_close_file(FILE *file);
155 extern int bb_xprint_file_by_name(const char *filename);
156 extern char bb_process_escape_sequence(const char **ptr);
157 extern char *bb_get_last_path_component(char *path);
158 extern FILE *bb_wfopen(const char *path, const char *mode);
159 extern FILE *bb_xfopen(const char *path, const char *mode);
162 extern int bb_fclose_nonstdin(FILE *f);
163 extern void bb_fflush_stdout_and_exit(int retval) __attribute__ ((noreturn));
165 extern const char *bb_opt_complementaly;
166 extern const struct option *bb_applet_long_options;
167 extern unsigned long bb_getopt_ulflags(int argc, char **argv, const char *applet_opts, ...);
170 extern FILE *bb_wfopen_input(const char *filename);
172 extern int bb_vfprintf(FILE * __restrict stream, const char * __restrict format,
173 va_list arg) __attribute__ ((format (printf, 2, 0)));
174 extern int bb_vprintf(const char * __restrict format, va_list arg)
175 __attribute__ ((format (printf, 1, 0)));
176 extern int bb_fprintf(FILE * __restrict stream, const char * __restrict format, ...)
177 __attribute__ ((format (printf, 2, 3)));
178 extern int bb_printf(const char * __restrict format, ...)
179 __attribute__ ((format (printf, 1, 2)));
181 //#warning rename to xferror_filename?
182 extern void bb_xferror(FILE *fp, const char *fn);
183 extern void bb_xferror_stdout(void);
184 extern void bb_xfflush_stdout(void);
186 extern void bb_warn_ignoring_args(int n);
188 extern void chomp(char *s);
189 extern void trim(char *s);
190 extern const char *bb_skip_whitespace(const char *);
192 extern struct BB_applet *find_applet_by_name(const char *name);
193 void run_applet_by_name(const char *name, int argc, char **argv);
195 //#warning is this needed anymore?
197 extern void *xmalloc (size_t size);
198 extern void *xrealloc(void *old, size_t size);
199 extern void *xcalloc(size_t nmemb, size_t size);
200 extern char *bb_xstrdup (const char *s);
202 extern char *bb_xstrndup (const char *s, int n);
203 extern char * safe_strncpy(char *dst, const char *src, size_t size);
210 extern unsigned long bb_xgetularg_bnd_sfx(const char *arg, int base,
213 const struct suffix_mult *suffixes);
214 extern unsigned long bb_xgetularg_bnd(const char *arg, int base,
216 unsigned long upper);
217 extern unsigned long bb_xgetularg10_bnd(const char *arg,
219 unsigned long upper);
220 extern unsigned long bb_xgetularg10(const char *arg);
222 extern long bb_xgetlarg_bnd_sfx(const char *arg, int base,
225 const struct suffix_mult *suffixes);
226 extern long bb_xgetlarg10_sfx(const char *arg, const struct suffix_mult *suffixes);
229 //#warning pitchable now?
230 extern unsigned long bb_xparse_number(const char *numstr,
231 const struct suffix_mult *suffixes);
234 //#warning change names?
236 /* These parse entries in /etc/passwd and /etc/group. This is desirable
237 * for BusyBox since we want to avoid using the glibc NSS stuff, which
238 * increases target size and is often not needed embedded systems. */
239 extern long my_getpwnam(const char *name);
240 extern long my_getgrnam(const char *name);
241 extern char * my_getpwuid(char *name, long uid);
242 extern char * my_getgrgid(char *group, long gid);
243 extern long my_getpwnamegid(const char *name);
245 extern int device_open(const char *device, int mode);
247 extern int del_loop(const char *device);
248 extern int set_loop(const char *device, const char *file, int offset, int *loopro);
249 extern char *find_unused_loop_device (void);
253 extern int vdprintf(int d, const char *format, va_list ap);
256 int nfsmount(const char *spec, const char *node, int *flags,
257 char **extra_opts, char **mount_opts, int running_bg);
259 void syslog_msg_with_name(const char *name, int facility, int pri, const char *msg);
260 void syslog_msg(int facility, int pri, const char *msg);
262 /* Include our own copy of struct sysinfo to avoid binary compatability
263 * problems with Linux 2.4, which changed things. Grumble, grumble. */
265 long uptime; /* Seconds since boot */
266 unsigned long loads[3]; /* 1, 5, and 15 minute load averages */
267 unsigned long totalram; /* Total usable main memory size */
268 unsigned long freeram; /* Available memory size */
269 unsigned long sharedram; /* Amount of shared memory */
270 unsigned long bufferram; /* Memory used by buffers */
271 unsigned long totalswap; /* Total swap space size */
272 unsigned long freeswap; /* swap space still available */
273 unsigned short procs; /* Number of current processes */
274 unsigned short pad; /* Padding needed for m68k */
275 unsigned long totalhigh; /* Total high memory size */
276 unsigned long freehigh; /* Available high memory size */
277 unsigned int mem_unit; /* Memory unit size in bytes */
278 char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
280 extern int sysinfo (struct sysinfo* info);
284 MEGABYTE = (KILOBYTE*1024),
285 GIGABYTE = (MEGABYTE*1024)
287 const char *make_human_readable_str(unsigned long size, unsigned long block_size, unsigned long display_unit);
289 int bb_ask_confirmation(void);
290 int klogctl(int type, char * b, int len);
292 char *xgetcwd(char *cwd);
293 char *xreadlink(const char *path);
294 char *concat_path_file(const char *path, const char *filename);
295 char *concat_subpath_file(const char *path, const char *filename);
296 char *last_char_is(const char *s, int c);
298 extern long arith (const char *startbuf, int *errcode);
300 int read_package_field(const char *package_buffer, char **field_name, char **field_value);
302 char *fgets_str(FILE *file, const char *terminating_string);
304 extern int uncompress(int fd_in, int fd_out);
305 extern int inflate(int in, int out);
307 extern struct hostent *xgethostbyname(const char *name);
308 extern struct hostent *xgethostbyname2(const char *name, int af);
309 extern int create_icmp_socket(void);
310 extern int create_icmp6_socket(void);
311 extern int xconnect(const char *host, const char *port);
313 //#warning wrap this?
314 char *dirname (char *path);
316 int bb_make_directory (char *path, long mode, int flags);
318 const char *u_signal_names(const char *str_sig, int *signo, int startnum);
319 char *bb_simplify_path(const char *path);
321 enum { /* DO NOT CHANGE THESE VALUES! cp.c depends on them. */
322 FILEUTILS_PRESERVE_STATUS = 1,
323 FILEUTILS_DEREFERENCE = 2,
326 FILEUTILS_INTERACTIVE = 16
329 extern const char *bb_applet_name;
331 extern const char * const bb_msg_full_version;
332 extern const char * const bb_msg_memory_exhausted;
333 extern const char * const bb_msg_invalid_date;
334 extern const char * const bb_msg_io_error;
335 extern const char * const bb_msg_write_error;
336 extern const char * const bb_msg_name_longer_than_foo;
337 extern const char * const bb_msg_unknown;
338 extern const char * const bb_msg_can_not_create_raw_socket;
339 extern const char * const bb_msg_perm_denied_are_you_root;
340 extern const char * const bb_msg_standard_input;
341 extern const char * const bb_msg_standard_output;
343 extern const char * const bb_path_nologin_file;
344 extern const char * const bb_path_passwd_file;
345 extern const char * const bb_path_shadow_file;
346 extern const char * const bb_path_gshadow_file;
347 extern const char * const bb_path_group_file;
348 extern const char * const bb_path_securetty_file;
349 extern const char * const bb_path_motd_file;
351 extern const char bb_path_mtab_file[];
353 extern int bb_default_error_retval;
355 #ifdef CONFIG_FEATURE_DEVFS
356 # define CURRENT_VC "/dev/vc/0"
357 # define VC_1 "/dev/vc/1"
358 # define VC_2 "/dev/vc/2"
359 # define VC_3 "/dev/vc/3"
360 # define VC_4 "/dev/vc/4"
361 # define VC_5 "/dev/vc/5"
362 # define SC_0 "/dev/tts/0"
363 # define SC_1 "/dev/tts/1"
364 # define VC_FORMAT "/dev/vc/%d"
365 # define SC_FORMAT "/dev/tts/%d"
366 # define LOOP_FORMAT "/dev/loop/%d"
368 # define CURRENT_VC "/dev/tty0"
369 # define VC_1 "/dev/tty1"
370 # define VC_2 "/dev/tty2"
371 # define VC_3 "/dev/tty3"
372 # define VC_4 "/dev/tty4"
373 # define VC_5 "/dev/tty5"
374 # define SC_0 "/dev/ttyS0"
375 # define SC_1 "/dev/ttyS1"
376 # define VC_FORMAT "/dev/tty%d"
377 # define SC_FORMAT "/dev/ttyS%d"
378 # define LOOP_FORMAT "/dev/loop%d"
381 //#warning put these in .o files
383 /* The following devices are the same on devfs and non-devfs systems. */
384 #define CURRENT_TTY "/dev/tty"
385 #define CONSOLE_DEV "/dev/console"
387 int is_in_ino_dev_hashtable(const struct stat *statbuf, char **name);
388 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
389 void reset_ino_dev_hashtable(void);
391 /* Stupid gcc always includes its own builtin strlen()... */
392 extern size_t bb_strlen(const char *string);
393 #define strlen(x) bb_strlen(x)
395 void bb_xasprintf(char **string_ptr, const char *format, ...) __attribute__ ((format (printf, 2, 3)));
399 extern void change_identity ( const struct passwd *pw );
400 extern void run_shell ( const char *shell, int loginshell, const char *command, const char **additional_args
401 #ifdef CONFIG_SELINUX
405 extern int run_parts(char **args, const unsigned char test_mode);
406 extern int restricted_shell ( const char *shell );
407 extern void setup_environment ( const char *shell, int loginshell, int changeenv, const struct passwd *pw );
408 extern int correct_password ( const struct passwd *pw );
409 extern char *pw_encrypt(const char *clear, const char *salt);
410 extern struct spwd *pwd_to_spwd(const struct passwd *pw);
411 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp);
413 extern int bb_xopen(const char *pathname, int flags);
414 extern ssize_t bb_xread(int fd, void *buf, size_t count);
415 extern void bb_xread_all(int fd, void *buf, size_t count);
416 extern unsigned char bb_xread_char(int fd);
424 #ifdef FEATURE_CPU_USAGE_PERCENTAGE
426 unsigned long stime, utime;
430 /* basename of executable file in call to exec(2),
431 size from kernel headers */
435 extern procps_status_t * procps_scan(int save_user_arg0
436 #ifdef CONFIG_SELINUX
437 , int use_selinux, security_id_t *sid
440 extern unsigned short compare_string_array(const char *string_array[], const char *key);
442 extern int my_query_module(const char *name, int which, void **buf, size_t *bufsize, size_t *ret);
444 typedef struct llist_s {
446 struct llist_s *link;
448 extern llist_t *llist_add_to(llist_t *old_head, char *new_item);
450 void print_login_issue(const char *issue_file, const char *tty);
451 void print_login_prompt(void);
453 #endif /* __LIBCONFIG_H__ */