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