Get vfork_daemon_rexec working under uclinux
[people/mcb30/busybox.git] / include / libbb.h
1 /* vi: set sw=4 ts=4: */
2 /*
3  * Busybox main internal header file
4  *
5  *
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.
10  *
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.
15  *
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
19  *
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.
22  *
23  */
24 #ifndef __LIBCONFIG_H__
25 #define __LIBCONFIG_H__    1
26
27 #include <stdio.h>
28 #include <stdarg.h>
29 #include <sys/stat.h>
30 #include <sys/types.h>
31 #include <regex.h>
32 #include <termios.h>
33 #include <stdint.h>
34
35 #include <netdb.h>
36
37 #ifdef DMALLOC
38 #include <dmalloc.h>
39 #endif
40
41 #include <features.h>
42
43 #include "config.h"
44 #ifdef CONFIG_SELINUX
45 #include <proc_secure.h>
46 #endif
47
48 #include "pwd_.h"
49 #include "grp_.h"
50 #ifdef CONFIG_FEATURE_SHADOWPASSWDS
51 #include "shadow_.h"
52 #endif
53 #ifdef CONFIG_FEATURE_SHA1_PASSWORDS
54 # include "sha1.h"
55 #endif
56
57 /* Convenience macros to test the version of gcc. */
58 #if defined __GNUC__ && defined __GNUC_MINOR__
59 # define __GNUC_PREREQ(maj, min) \
60         ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
61 #else
62 # define __GNUC_PREREQ(maj, min) 0
63 #endif
64
65 /* __restrict is known in EGCS 1.2 and above. */
66 #if !__GNUC_PREREQ (2,92)
67 # define __restrict     /* Ignore */
68 #endif
69
70 /* Some useful definitions */
71 #define FALSE   ((int) 0)
72 #define TRUE    ((int) 1)
73 #define SKIP    ((int) 2)
74
75 /* for mtab.c */
76 #define MTAB_GETMOUNTPT '1'
77 #define MTAB_GETDEVICE  '2'
78
79 #define BUF_SIZE        8192
80 #define EXPAND_ALLOC    1024
81
82 /* Macros for min/max.  */
83 #ifndef MIN
84 #define MIN(a,b) (((a)<(b))?(a):(b))
85 #endif
86
87 #ifndef MAX
88 #define MAX(a,b) (((a)>(b))?(a):(b))
89 #endif
90
91 extern void bb_show_usage(void) __attribute__ ((noreturn));
92 extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
93 extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
94 extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
95 extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
96 extern void bb_vherror_msg(const char *s, va_list p);
97 extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2)));
98 extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2)));
99
100 extern void bb_perror_nomsg_and_die(void) __attribute__ ((noreturn));
101 extern void bb_perror_nomsg(void);
102
103 /* These two are used internally -- you shouldn't need to use them */
104 extern void bb_verror_msg(const char *s, va_list p) __attribute__ ((format (printf, 1, 0)));
105 extern void bb_vperror_msg(const char *s, va_list p)  __attribute__ ((format (printf, 1, 0)));
106
107 extern const char *bb_mode_string(int mode);
108 extern int is_directory(const char *name, int followLinks, struct stat *statBuf);
109
110 extern int remove_file(const char *path, int flags);
111 extern int copy_file(const char *source, const char *dest, int flags);
112 extern ssize_t safe_read(int fd, void *buf, size_t count);
113 extern ssize_t bb_full_read(int fd, void *buf, size_t len);
114 extern ssize_t safe_write(int fd, const void *buf, size_t count);
115 extern ssize_t bb_full_write(int fd, const void *buf, size_t len);
116 extern int recursive_action(const char *fileName, int recurse,
117           int followLinks, int depthFirst,
118           int (*fileAction) (const char *fileName, struct stat* statbuf, void* userData),
119           int (*dirAction) (const char *fileName, struct stat* statbuf, void* userData),
120           void* userData);
121
122 extern int bb_parse_mode( const char* s, mode_t* theMode);
123 extern long bb_xgetlarg(const char *arg, int base, long lower, long upper);
124
125 extern unsigned long bb_baud_to_value(speed_t speed);
126 extern speed_t bb_value_to_baud(unsigned long value);
127
128 extern int get_kernel_revision(void);
129
130 extern int get_console_fd(void);
131 extern struct mntent *find_mount_point(const char *name, const char *table);
132 extern void write_mtab(char* blockDevice, char* directory, 
133                                            char* filesystemType, long flags, char* string_flags);
134 extern void erase_mtab(const char * name);
135 extern long *find_pid_by_name( const char* pidName);
136 extern char *find_real_root_device_name(const char* name);
137 extern char *bb_get_line_from_file(FILE *file);
138 extern char *bb_get_chomped_line_from_file(FILE *file);
139 extern int bb_copyfd_size(int fd1, int fd2, const off_t size);
140 extern int bb_copyfd_eof(int fd1, int fd2);
141 extern void  bb_xprint_and_close_file(FILE *file);
142 extern int   bb_xprint_file_by_name(const char *filename);
143 extern char  bb_process_escape_sequence(const char **ptr);
144 extern char *bb_get_last_path_component(char *path);
145 extern FILE *bb_wfopen(const char *path, const char *mode);
146 extern FILE *bb_xfopen(const char *path, const char *mode);
147
148 //#warning rename?
149 extern int   bb_fclose_nonstdin(FILE *f);
150 extern void  bb_fflush_stdout_and_exit(int retval) __attribute__ ((noreturn));
151
152 extern const char *bb_opt_complementaly;
153 extern const struct option *bb_applet_long_options;
154 extern unsigned long bb_getopt_ulflags(int argc, char **argv, const char *applet_opts, ...);
155
156 //#warning rename?
157 extern FILE *bb_wfopen_input(const char *filename);
158
159 extern int bb_vfprintf(FILE * __restrict stream, const char * __restrict format,
160                                            va_list arg) __attribute__ ((format (printf, 2, 0)));
161 extern int bb_vprintf(const char * __restrict format, va_list arg)
162         __attribute__ ((format (printf, 1, 0)));
163 extern int bb_fprintf(FILE * __restrict stream, const char * __restrict format, ...)
164         __attribute__ ((format (printf, 2, 3)));
165 extern int bb_printf(const char * __restrict format, ...)
166         __attribute__ ((format (printf, 1, 2)));
167
168 //#warning rename to xferror_filename?
169 extern void bb_xferror(FILE *fp, const char *fn);
170 extern void bb_xferror_stdout(void);
171 extern void bb_xfflush_stdout(void);
172
173 extern void bb_warn_ignoring_args(int n);
174
175 extern void chomp(char *s);
176 extern void trim(char *s);
177 extern const char *bb_skip_whitespace(const char *);
178
179 extern struct BB_applet *find_applet_by_name(const char *name);
180 void run_applet_by_name(const char *name, int argc, char **argv);
181
182 //#warning is this needed anymore?
183 #ifndef DMALLOC
184 extern void *xmalloc (size_t size);
185 extern void *xrealloc(void *old, size_t size);
186 extern void *xcalloc(size_t nmemb, size_t size);
187 #endif
188 extern char *bb_xstrdup (const char *s);
189 extern char *bb_xstrndup (const char *s, int n);
190 extern char * safe_strncpy(char *dst, const char *src, size_t size);
191
192 struct suffix_mult {
193         const char *suffix;
194         unsigned int mult;
195 };
196
197 extern unsigned long bb_xgetularg_bnd_sfx(const char *arg, int base,
198                                                                                   unsigned long lower,
199                                                                                   unsigned long upper,
200                                                                                   const struct suffix_mult *suffixes);
201 extern unsigned long bb_xgetularg_bnd(const char *arg, int base,
202                                                                           unsigned long lower,
203                                                                           unsigned long upper);
204 extern unsigned long bb_xgetularg10_bnd(const char *arg,
205                                                                                 unsigned long lower,
206                                                                                 unsigned long upper);
207 extern unsigned long bb_xgetularg10(const char *arg);
208
209 extern long bb_xgetlarg_bnd_sfx(const char *arg, int base,
210                                                                 long lower,
211                                                                 long upper,
212                                                                 const struct suffix_mult *suffixes);
213 extern long bb_xgetlarg10_sfx(const char *arg, const struct suffix_mult *suffixes);
214
215
216 //#warning pitchable now?
217 extern unsigned long bb_xparse_number(const char *numstr,
218                 const struct suffix_mult *suffixes);
219
220
221 //#warning change names?
222
223 /* These parse entries in /etc/passwd and /etc/group.  This is desirable
224  * for BusyBox since we want to avoid using the glibc NSS stuff, which
225  * increases target size and is often not needed embedded systems.  */
226 extern long my_getpwnam(const char *name);
227 extern long my_getgrnam(const char *name);
228 extern char * my_getpwuid(char *name, long uid);
229 extern char * my_getgrgid(char *group, long gid);
230 extern long my_getpwnamegid(const char *name);
231
232 extern int device_open(const char *device, int mode);
233
234 extern int del_loop(const char *device);
235 extern int set_loop(const char *device, const char *file, int offset, int *loopro);
236 extern char *find_unused_loop_device (void);
237
238
239 #if (__GLIBC__ < 2)
240 extern int vdprintf(int d, const char *format, va_list ap);
241 #endif
242
243 int nfsmount(const char *spec, const char *node, int *flags,
244              char **extra_opts, char **mount_opts, int running_bg);
245
246 void syslog_msg_with_name(const char *name, int facility, int pri, const char *msg);
247 void syslog_msg(int facility, int pri, const char *msg);
248
249 /* Include our own copy of struct sysinfo to avoid binary compatability
250  * problems with Linux 2.4, which changed things.  Grumble, grumble. */
251 struct sysinfo {
252         long uptime;                    /* Seconds since boot */
253         unsigned long loads[3];         /* 1, 5, and 15 minute load averages */
254         unsigned long totalram;         /* Total usable main memory size */
255         unsigned long freeram;          /* Available memory size */
256         unsigned long sharedram;        /* Amount of shared memory */
257         unsigned long bufferram;        /* Memory used by buffers */
258         unsigned long totalswap;        /* Total swap space size */
259         unsigned long freeswap;         /* swap space still available */
260         unsigned short procs;           /* Number of current processes */
261         unsigned short pad;                     /* Padding needed for m68k */
262         unsigned long totalhigh;        /* Total high memory size */
263         unsigned long freehigh;         /* Available high memory size */
264         unsigned int mem_unit;          /* Memory unit size in bytes */
265         char _f[20-2*sizeof(long)-sizeof(int)]; /* Padding: libc5 uses this.. */
266 };
267 extern int sysinfo (struct sysinfo* info);
268
269 enum {
270         KILOBYTE = 1024,
271         MEGABYTE = (KILOBYTE*1024),
272         GIGABYTE = (MEGABYTE*1024)
273 };
274 const char *make_human_readable_str(unsigned long long size, 
275                 unsigned long block_size, unsigned long display_unit);
276
277 int bb_ask_confirmation(void);
278 int klogctl(int type, char * b, int len);
279
280 char *xgetcwd(char *cwd);
281 char *xreadlink(const char *path);
282 char *concat_path_file(const char *path, const char *filename);
283 char *concat_subpath_file(const char *path, const char *filename);
284 char *last_char_is(const char *s, int c);
285
286 extern long arith (const char *startbuf, int *errcode);
287
288 int read_package_field(const char *package_buffer, char **field_name, char **field_value);
289 //#warning yuk!
290 char *fgets_str(FILE *file, const char *terminating_string);
291
292 extern int uncompress(int fd_in, int fd_out);
293 extern int inflate(int in, int out);
294
295 extern struct hostent *xgethostbyname(const char *name);
296 extern struct hostent *xgethostbyname2(const char *name, int af);
297 extern int create_icmp_socket(void);
298 extern int create_icmp6_socket(void);
299 extern int xconnect(struct sockaddr_in *s_addr);
300 extern int bb_getport(const char *port);
301 extern void bb_lookup_host(struct sockaddr_in *s_in, const char *host, const char *port);
302
303 //#warning wrap this?
304 char *dirname (char *path);
305
306 int bb_make_directory (char *path, long mode, int flags);
307
308 const char *u_signal_names(const char *str_sig, int *signo, int startnum);
309 char *bb_simplify_path(const char *path);
310
311 enum {  /* DO NOT CHANGE THESE VALUES!  cp.c depends on them. */
312         FILEUTILS_PRESERVE_STATUS = 1,
313         FILEUTILS_DEREFERENCE = 2,
314         FILEUTILS_RECUR = 4,
315         FILEUTILS_FORCE = 8,
316         FILEUTILS_INTERACTIVE = 16
317 };
318
319 extern const char *bb_applet_name;
320
321 extern const char * const bb_msg_full_version;
322 extern const char * const bb_msg_memory_exhausted;
323 extern const char * const bb_msg_invalid_date;
324 extern const char * const bb_msg_io_error;
325 extern const char * const bb_msg_write_error;
326 extern const char * const bb_msg_name_longer_than_foo;
327 extern const char * const bb_msg_unknown;
328 extern const char * const bb_msg_can_not_create_raw_socket;
329 extern const char * const bb_msg_perm_denied_are_you_root;
330 extern const char * const bb_msg_standard_input;
331 extern const char * const bb_msg_standard_output;
332
333 extern const char * const bb_path_nologin_file;
334 extern const char * const bb_path_passwd_file;
335 extern const char * const bb_path_shadow_file;
336 extern const char * const bb_path_gshadow_file;
337 extern const char * const bb_path_group_file;
338 extern const char * const bb_path_securetty_file;
339 extern const char * const bb_path_motd_file;
340
341 /*
342  * You can change LIBBB_DEFAULT_LOGIN_SHELL, but don`t use,
343  * use bb_default_login_shell and next defines,
344  * if you LIBBB_DEFAULT_LOGIN_SHELL change,
345  * don`t lose change increment constant!
346  */
347 #define LIBBB_DEFAULT_LOGIN_SHELL      "-/bin/sh"
348
349 extern const char * const bb_default_login_shell;
350 /* "/bin/sh" */
351 #define DEFAULT_SHELL     (bb_default_login_shell+1)
352 /* "sh" */
353 #define DEFAULT_SHELL_SHORT_NAME     (bb_default_login_shell+6)
354
355
356 extern const char bb_path_mtab_file[];
357
358 extern int bb_default_error_retval;
359
360 #ifdef CONFIG_FEATURE_DEVFS
361 # define CURRENT_VC "/dev/vc/0"
362 # define VC_1 "/dev/vc/1"
363 # define VC_2 "/dev/vc/2"
364 # define VC_3 "/dev/vc/3"
365 # define VC_4 "/dev/vc/4"
366 # define VC_5 "/dev/vc/5"
367 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
368 /* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
369    respective serial ports .. as such, we can't use the common device paths for
370    these. -- PFM */
371 #  define SC_0 "/dev/ttsc/0"
372 #  define SC_1 "/dev/ttsc/1"
373 #  define SC_FORMAT "/dev/ttsc/%d"
374 #else
375 #  define SC_0 "/dev/tts/0"
376 #  define SC_1 "/dev/tts/1"
377 #  define SC_FORMAT "/dev/tts/%d"
378 #endif
379 # define VC_FORMAT "/dev/vc/%d"
380 # define LOOP_FORMAT "/dev/loop/%d"
381 # define FB_0 "/dev/fb/0"
382 #else
383 # define CURRENT_VC "/dev/tty0"
384 # define VC_1 "/dev/tty1"
385 # define VC_2 "/dev/tty2"
386 # define VC_3 "/dev/tty3"
387 # define VC_4 "/dev/tty4"
388 # define VC_5 "/dev/tty5"
389 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
390 #  define SC_0 "/dev/ttySC0"
391 #  define SC_1 "/dev/ttySC1"
392 #  define SC_FORMAT "/dev/ttySC%d"
393 #else
394 #  define SC_0 "/dev/ttyS0"
395 #  define SC_1 "/dev/ttyS1"
396 #  define SC_FORMAT "/dev/ttyS%d"
397 #endif
398 # define VC_FORMAT "/dev/tty%d"
399 # define LOOP_FORMAT "/dev/loop%d"
400 # define FB_0 "/dev/fb0"
401 #endif
402
403 //#warning put these in .o files
404
405 /* The following devices are the same on devfs and non-devfs systems.  */
406 #define CURRENT_TTY "/dev/tty"
407 #define CONSOLE_DEV "/dev/console"
408
409 int is_in_ino_dev_hashtable(const struct stat *statbuf, char **name);
410 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name);
411 void reset_ino_dev_hashtable(void);
412
413 /* Stupid gcc always includes its own builtin strlen()... */
414 extern size_t bb_strlen(const char *string);
415 #define strlen(x)   bb_strlen(x)
416
417 void bb_xasprintf(char **string_ptr, const char *format, ...) __attribute__ ((format (printf, 2, 3)));
418
419
420 #define FAIL_DELAY    3
421 extern void change_identity ( const struct passwd *pw );
422 extern const char *change_identity_e2str ( const struct passwd *pw );
423 extern void run_shell ( const char *shell, int loginshell, const char *command, const char **additional_args
424 #ifdef CONFIG_SELINUX
425         , security_id_t sid
426 #endif
427 );
428 extern int run_parts(char **args, const unsigned char test_mode, char **env);
429 extern int restricted_shell ( const char *shell );
430 extern void setup_environment ( const char *shell, int loginshell, int changeenv, const struct passwd *pw );
431 extern int correct_password ( const struct passwd *pw );
432 extern char *pw_encrypt(const char *clear, const char *salt);
433 extern struct spwd *pwd_to_spwd(const struct passwd *pw);
434 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp);
435
436 extern int bb_xopen(const char *pathname, int flags);
437 extern ssize_t bb_xread(int fd, void *buf, size_t count);
438 extern void bb_xread_all(int fd, void *buf, size_t count);
439 extern unsigned char bb_xread_char(int fd);
440
441 typedef struct {
442         int pid;
443         char user[9];
444         char state[4];
445         unsigned long rss;
446         int ppid;
447 #ifdef FEATURE_CPU_USAGE_PERCENTAGE
448         unsigned pcpu;
449         unsigned long stime, utime;
450 #endif
451         char *cmd;
452
453         /* basename of executable file in call to exec(2),
454                 size from kernel headers */
455         char short_cmd[16];
456 } procps_status_t;
457
458 extern procps_status_t * procps_scan(int save_user_arg0
459 #ifdef CONFIG_SELINUX
460         , int use_selinux, security_id_t *sid
461 #endif
462 );
463 extern unsigned short compare_string_array(const char *string_array[], const char *key);
464
465 extern int my_query_module(const char *name, int which, void **buf, size_t *bufsize, size_t *ret);
466
467 typedef struct llist_s {
468         char *data;
469         struct llist_s *link;
470 } llist_t;
471 extern llist_t *llist_add_to(llist_t *old_head, char *new_item);
472
473 extern void print_login_issue(const char *issue_file, const char *tty);
474 extern void print_login_prompt(void);
475
476 extern void vfork_daemon_rexec(int nochdir, int noclose,
477                 int argc, char **argv, char *foreground_opt);
478 extern void get_terminal_width_height(int fd, int *width, int *height);
479 extern unsigned long get_ug_id(const char *s, long (*my_getxxnam)(const char *));
480 extern void xregcomp(regex_t *preg, const char *regex, int cflags);
481
482 #define HASH_SHA1       1
483 #define HASH_MD5        2
484 extern int hash_fd(int fd, const size_t size, const uint8_t hash_algo, uint8_t *hashval);
485 extern size_t bb_full_fd_action(int src_fd, int dst_fd, const size_t size, ssize_t (*action)(int fd, const void *, size_t));
486
487 #endif /* __LIBCONFIG_H__ */