9de52331b75b9182076cd66348c793f7b59f51ba
[oweals/busybox.git] / include / libbb.h
1 /* vi: set sw=4 ts=4: */
2 /*
3  * Busybox main internal header file
4  *
5  * Based in part on code from sash, Copyright (c) 1999 by David I. Bell
6  * Permission has been granted to redistribute this code under the GPL.
7  *
8  * Licensed under the GPL version 2, see the file LICENSE in this tarball.
9  */
10 #ifndef LIBBB_H
11 #define LIBBB_H 1
12
13 #include "platform.h"
14
15 #include <ctype.h>
16 #include <dirent.h>
17 #include <errno.h>
18 #include <fcntl.h>
19 #include <inttypes.h>
20 #include <netdb.h>
21 #include <setjmp.h>
22 #include <signal.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <stdarg.h>
26 #include <stddef.h>
27 #include <string.h>
28 #include <sys/poll.h>
29 #include <sys/ioctl.h>
30 #include <sys/mman.h>
31 #include <sys/socket.h>
32 #if defined __FreeBSD__
33 #include <netinet/in.h>
34 #include <arpa/inet.h>
35 #endif
36 #include <sys/stat.h>
37 #include <sys/time.h>
38 #include <sys/types.h>
39 #include <sys/wait.h>
40 #include <termios.h>
41 #include <time.h>
42 #include <unistd.h>
43 #include <utime.h>
44 /* Try to pull in PATH_MAX */
45 #include <limits.h>
46 #include <sys/param.h>
47 #ifndef PATH_MAX
48 #define PATH_MAX 256
49 #endif
50
51 #ifdef HAVE_MNTENT_H
52 #include <mntent.h>
53 #endif
54
55 #ifdef HAVE_SYS_STATFS_H
56 #include <sys/statfs.h>
57 #endif
58
59 #if ENABLE_SELINUX
60 #include <selinux/selinux.h>
61 #include <selinux/context.h>
62 #include <selinux/flask.h>
63 #include <selinux/av_permissions.h>
64 #endif
65
66 #if ENABLE_LOCALE_SUPPORT
67 #include <locale.h>
68 #else
69 #define setlocale(x,y) ((void)0)
70 #endif
71
72 #ifdef DMALLOC
73 #include <dmalloc.h>
74 #endif
75
76 #include <pwd.h>
77 #include <grp.h>
78 #if ENABLE_FEATURE_SHADOWPASSWDS
79 # if !ENABLE_USE_BB_SHADOW
80 /* If using busybox's shadow implementation, do not include the shadow.h
81  * header as the toolchain may not provide it at all.
82  */
83 #  include <shadow.h>
84 # endif
85 #endif
86
87 /* Some libc's forget to declare these, do it ourself */
88
89 extern char **environ;
90 #if defined(__GLIBC__) && __GLIBC__ < 2
91 int vdprintf(int d, const char *format, va_list ap);
92 #endif
93 /* klogctl is in libc's klog.h, but we cheat and not #include that */
94 int klogctl(int type, char *b, int len);
95 /* This is declared here rather than #including <libgen.h> in order to avoid
96  * confusing the two versions of basename.  See the dirname/basename man page
97  * for details. */
98 #if !defined __FreeBSD__
99 char *dirname(char *path);
100 #endif
101 /* Include our own copy of struct sysinfo to avoid binary compatibility
102  * problems with Linux 2.4, which changed things.  Grumble, grumble. */
103 struct sysinfo {
104         long uptime;                    /* Seconds since boot */
105         unsigned long loads[3];         /* 1, 5, and 15 minute load averages */
106         unsigned long totalram;         /* Total usable main memory size */
107         unsigned long freeram;          /* Available memory size */
108         unsigned long sharedram;        /* Amount of shared memory */
109         unsigned long bufferram;        /* Memory used by buffers */
110         unsigned long totalswap;        /* Total swap space size */
111         unsigned long freeswap;         /* swap space still available */
112         unsigned short procs;           /* Number of current processes */
113         unsigned short pad;                     /* Padding needed for m68k */
114         unsigned long totalhigh;        /* Total high memory size */
115         unsigned long freehigh;         /* Available high memory size */
116         unsigned int mem_unit;          /* Memory unit size in bytes */
117         char _f[20 - 2 * sizeof(long) - sizeof(int)]; /* Padding: libc5 uses this.. */
118 };
119 int sysinfo(struct sysinfo* info);
120
121
122 /* Make all declarations hidden (-fvisibility flag only affects definitions) */
123 /* (don't include system headers after this until corresponding pop!) */
124 PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
125
126
127 #if ENABLE_USE_BB_PWD_GRP
128 # include "pwd_.h"
129 # include "grp_.h"
130 #endif
131 #if ENABLE_FEATURE_SHADOWPASSWDS
132 # if ENABLE_USE_BB_SHADOW
133 #  include "shadow_.h"
134 # endif
135 #endif
136
137 /* Tested to work correctly with all int types (IIRC :]) */
138 #define MAXINT(T) (T)( \
139         ((T)-1) > 0 \
140         ? (T)-1 \
141         : (T)~((T)1 << (sizeof(T)*8-1)) \
142         )
143
144 #define MININT(T) (T)( \
145         ((T)-1) > 0 \
146         ? (T)0 \
147         : ((T)1 << (sizeof(T)*8-1)) \
148         )
149
150 /* Large file support */
151 /* Note that CONFIG_LFS=y forces bbox to be built with all common ops
152  * (stat, lseek etc) mapped to "largefile" variants by libc.
153  * Practically it means that open() automatically has O_LARGEFILE added
154  * and all filesize/file_offset parameters and struct members are "large"
155  * (in today's world - signed 64bit). For full support of large files,
156  * we need a few helper #defines (below) and careful use of off_t
157  * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
158 #if ENABLE_LFS
159 /* CONFIG_LFS is on */
160 # if ULONG_MAX > 0xffffffff
161 /* "long" is long enough on this system */
162 typedef unsigned long uoff_t;
163 #  define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
164 /* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
165 #  define BB_STRTOOFF bb_strtoul
166 #  define STRTOOFF strtoul
167 /* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
168 #  define OFF_FMT "l"
169 # else
170 /* "long" is too short, need "long long" */
171 typedef unsigned long long uoff_t;
172 #  define XATOOFF(a) xatoull_range(a, 0, LLONG_MAX)
173 #  define BB_STRTOOFF bb_strtoull
174 #  define STRTOOFF strtoull
175 #  define OFF_FMT "ll"
176 # endif
177 #else
178 /* CONFIG_LFS is off */
179 # if UINT_MAX == 0xffffffff
180 /* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
181  * gcc will throw warnings on printf("%d", off_t). Crap... */
182 typedef unsigned long uoff_t;
183 #  define XATOOFF(a) xatoi_u(a)
184 #  define BB_STRTOOFF bb_strtou
185 #  define STRTOOFF strtol
186 #  define OFF_FMT "l"
187 # else
188 typedef unsigned long uoff_t;
189 #  define XATOOFF(a) xatoul_range(a, 0, LONG_MAX)
190 #  define BB_STRTOOFF bb_strtoul
191 #  define STRTOOFF strtol
192 #  define OFF_FMT "l"
193 # endif
194 #endif
195 /* scary. better ideas? (but do *test* them first!) */
196 #define OFF_T_MAX  ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
197
198 /* Some useful definitions */
199 #undef FALSE
200 #define FALSE   ((int) 0)
201 #undef TRUE
202 #define TRUE    ((int) 1)
203 #undef SKIP
204 #define SKIP    ((int) 2)
205
206 /* for mtab.c */
207 #define MTAB_GETMOUNTPT '1'
208 #define MTAB_GETDEVICE  '2'
209
210 #define BUF_SIZE        8192
211 #define EXPAND_ALLOC    1024
212
213 /* Macros for min/max.  */
214 #ifndef MIN
215 #define MIN(a,b) (((a)<(b))?(a):(b))
216 #endif
217
218 #ifndef MAX
219 #define MAX(a,b) (((a)>(b))?(a):(b))
220 #endif
221
222 /* buffer allocation schemes */
223 #if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
224 #define RESERVE_CONFIG_BUFFER(buffer,len)  char buffer[len]
225 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
226 #define RELEASE_CONFIG_BUFFER(buffer)      ((void)0)
227 #else
228 #if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
229 #define RESERVE_CONFIG_BUFFER(buffer,len)  static          char buffer[len]
230 #define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
231 #define RELEASE_CONFIG_BUFFER(buffer)      ((void)0)
232 #else
233 #define RESERVE_CONFIG_BUFFER(buffer,len)  char *buffer = xmalloc(len)
234 #define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
235 #define RELEASE_CONFIG_BUFFER(buffer)      free(buffer)
236 #endif
237 #endif
238
239 #if defined(__GLIBC__)
240 /* glibc uses __errno_location() to get a ptr to errno */
241 /* We can just memorize it once - no multithreading in busybox :) */
242 extern int *const bb_errno;
243 #undef errno
244 #define errno (*bb_errno)
245 #endif
246
247 unsigned long long monotonic_ns(void) FAST_FUNC;
248 unsigned long long monotonic_us(void) FAST_FUNC;
249 unsigned monotonic_sec(void) FAST_FUNC;
250
251 extern void chomp(char *s) FAST_FUNC;
252 extern void trim(char *s) FAST_FUNC;
253 extern char *skip_whitespace(const char *) FAST_FUNC;
254 extern char *skip_non_whitespace(const char *) FAST_FUNC;
255 extern char *strrstr(const char *haystack, const char *needle) FAST_FUNC;
256
257 //TODO: supply a pointer to char[11] buffer (avoid statics)?
258 extern const char *bb_mode_string(mode_t mode) FAST_FUNC;
259 extern int is_directory(const char *name, int followLinks, struct stat *statBuf) FAST_FUNC;
260 enum {  /* DO NOT CHANGE THESE VALUES!  cp.c, mv.c, install.c depend on them. */
261         FILEUTILS_PRESERVE_STATUS = 1,
262         FILEUTILS_DEREFERENCE = 2,
263         FILEUTILS_RECUR = 4,
264         FILEUTILS_FORCE = 8,
265         FILEUTILS_INTERACTIVE = 0x10,
266         FILEUTILS_MAKE_HARDLINK = 0x20,
267         FILEUTILS_MAKE_SOFTLINK = 0x40,
268         FILEUTILS_DEREF_SOFTLINK = 0x80,
269 #if ENABLE_SELINUX
270         FILEUTILS_PRESERVE_SECURITY_CONTEXT = 0x100,
271         FILEUTILS_SET_SECURITY_CONTEXT = 0x200
272 #endif
273 };
274 #define FILEUTILS_CP_OPTSTR "pdRfilsL" IF_SELINUX("c")
275 extern int remove_file(const char *path, int flags) FAST_FUNC;
276 /* NB: without FILEUTILS_RECUR in flags, it will basically "cat"
277  * the source, not copy (unless "source" is a directory).
278  * This makes "cp /dev/null file" and "install /dev/null file" (!!!)
279  * work coreutils-compatibly. */
280 extern int copy_file(const char *source, const char *dest, int flags) FAST_FUNC;
281
282 enum {
283         ACTION_RECURSE        = (1 << 0),
284         ACTION_FOLLOWLINKS    = (1 << 1),
285         ACTION_FOLLOWLINKS_L0 = (1 << 2),
286         ACTION_DEPTHFIRST     = (1 << 3),
287         /*ACTION_REVERSE      = (1 << 4), - unused */
288         ACTION_QUIET          = (1 << 5),
289 };
290 extern int recursive_action(const char *fileName, unsigned flags,
291         int FAST_FUNC (*fileAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
292         int FAST_FUNC (*dirAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
293         void* userData, unsigned depth) FAST_FUNC;
294 extern int device_open(const char *device, int mode) FAST_FUNC;
295 enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
296 extern int xgetpty(char *line) FAST_FUNC;
297 extern int get_console_fd_or_die(void) FAST_FUNC;
298 extern void console_make_active(int fd, const int vt_num) FAST_FUNC;
299 extern char *find_block_device(const char *path) FAST_FUNC;
300 /* bb_copyfd_XX print read/write errors and return -1 if they occur */
301 extern off_t bb_copyfd_eof(int fd1, int fd2) FAST_FUNC;
302 extern off_t bb_copyfd_size(int fd1, int fd2, off_t size) FAST_FUNC;
303 extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size) FAST_FUNC;
304 /* "short" copy can be detected by return value < size */
305 /* this helper yells "short read!" if param is not -1 */
306 extern void complain_copyfd_and_die(off_t sz) NORETURN FAST_FUNC;
307 extern char bb_process_escape_sequence(const char **ptr) FAST_FUNC;
308 /* xxxx_strip version can modify its parameter:
309  * "/"        -> "/"
310  * "abc"      -> "abc"
311  * "abc/def"  -> "def"
312  * "abc/def/" -> "def" !!
313  */
314 extern char *bb_get_last_path_component_strip(char *path) FAST_FUNC;
315 /* "abc/def/" -> "" and it never modifies 'path' */
316 extern char *bb_get_last_path_component_nostrip(const char *path) FAST_FUNC;
317
318 int ndelay_on(int fd) FAST_FUNC;
319 int ndelay_off(int fd) FAST_FUNC;
320 int close_on_exec_on(int fd) FAST_FUNC;
321 void xdup2(int, int) FAST_FUNC;
322 void xmove_fd(int, int) FAST_FUNC;
323
324
325 DIR *xopendir(const char *path) FAST_FUNC;
326 DIR *warn_opendir(const char *path) FAST_FUNC;
327
328 /* UNUSED: char *xmalloc_realpath(const char *path) FAST_FUNC; */
329 char *xmalloc_readlink(const char *path) FAST_FUNC;
330 char *xmalloc_readlink_or_warn(const char *path) FAST_FUNC;
331 char *xrealloc_getcwd_or_warn(char *cwd) FAST_FUNC;
332
333 char *xmalloc_follow_symlinks(const char *path) FAST_FUNC;
334
335
336 enum {
337         /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
338          * otherwise would kill us, except for those resulting from bugs:
339          * SIGSEGV, SIGILL, SIGFPE.
340          * Other fatal signals not included (TODO?):
341          * SIGBUS   Bus error (bad memory access)
342          * SIGPOLL  Pollable event. Synonym of SIGIO
343          * SIGPROF  Profiling timer expired
344          * SIGSYS   Bad argument to routine
345          * SIGTRAP  Trace/breakpoint trap
346          *
347          * The only known arch with some of these sigs not fitting
348          * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
349          * Dance around with long long to guard against that...
350          */
351         BB_FATAL_SIGS = (int)(0
352                 + (1LL << SIGHUP)
353                 + (1LL << SIGINT)
354                 + (1LL << SIGTERM)
355                 + (1LL << SIGPIPE)   // Write to pipe with no readers
356                 + (1LL << SIGQUIT)   // Quit from keyboard
357                 + (1LL << SIGABRT)   // Abort signal from abort(3)
358                 + (1LL << SIGALRM)   // Timer signal from alarm(2)
359                 + (1LL << SIGVTALRM) // Virtual alarm clock
360                 + (1LL << SIGXCPU)   // CPU time limit exceeded
361                 + (1LL << SIGXFSZ)   // File size limit exceeded
362                 + (1LL << SIGUSR1)   // Yes kids, these are also fatal!
363                 + (1LL << SIGUSR2)
364                 + 0),
365 };
366 void bb_signals(int sigs, void (*f)(int)) FAST_FUNC;
367 /* Unlike signal() and bb_signals, sets handler with sigaction()
368  * and in a way that while signal handler is run, no other signals
369  * will be blocked; syscalls will not be restarted: */
370 void bb_signals_recursive_norestart(int sigs, void (*f)(int)) FAST_FUNC;
371 /* syscalls like read() will be interrupted with EINTR: */
372 void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
373 /* syscalls like read() won't be interrupted (though select/poll will be): */
374 void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
375 void wait_for_any_sig(void) FAST_FUNC;
376 void kill_myself_with_sig(int sig) NORETURN FAST_FUNC;
377 void sig_block(int sig) FAST_FUNC;
378 void sig_unblock(int sig) FAST_FUNC;
379 /* Will do sigaction(signum, act, NULL): */
380 int sigaction_set(int sig, const struct sigaction *act) FAST_FUNC;
381 /* SIG_BLOCK/SIG_UNBLOCK all signals: */
382 int sigprocmask_allsigs(int how) FAST_FUNC;
383 /* Standard handler which just records signo */
384 extern smallint bb_got_signal;
385 void record_signo(int signo); /* not FAST_FUNC! */
386
387
388 void xsetgid(gid_t gid) FAST_FUNC;
389 void xsetuid(uid_t uid) FAST_FUNC;
390 void xchdir(const char *path) FAST_FUNC;
391 void xchroot(const char *path) FAST_FUNC;
392 void xsetenv(const char *key, const char *value) FAST_FUNC;
393 void bb_unsetenv(const char *key) FAST_FUNC;
394 void xunlink(const char *pathname) FAST_FUNC;
395 void xstat(const char *pathname, struct stat *buf) FAST_FUNC;
396 int xopen(const char *pathname, int flags) FAST_FUNC FAST_FUNC;
397 int xopen3(const char *pathname, int flags, int mode) FAST_FUNC;
398 int open_or_warn(const char *pathname, int flags) FAST_FUNC;
399 int open3_or_warn(const char *pathname, int flags, int mode) FAST_FUNC;
400 int open_or_warn_stdin(const char *pathname) FAST_FUNC;
401 void xrename(const char *oldpath, const char *newpath) FAST_FUNC;
402 int rename_or_warn(const char *oldpath, const char *newpath) FAST_FUNC;
403 off_t xlseek(int fd, off_t offset, int whence) FAST_FUNC;
404 off_t fdlength(int fd) FAST_FUNC;
405
406 void xpipe(int filedes[2]) FAST_FUNC;
407 /* In this form code with pipes is much more readable */
408 struct fd_pair { int rd; int wr; };
409 #define piped_pair(pair)  pipe(&((pair).rd))
410 #define xpiped_pair(pair) xpipe(&((pair).rd))
411
412 /* Useful for having small structure members/global variables */
413 typedef int8_t socktype_t;
414 typedef int8_t family_t;
415 struct BUG_too_small {
416         char BUG_socktype_t_too_small[(0
417                         | SOCK_STREAM
418                         | SOCK_DGRAM
419                         | SOCK_RDM
420                         | SOCK_SEQPACKET
421                         | SOCK_RAW
422                         ) <= 127 ? 1 : -1];
423         char BUG_family_t_too_small[(0
424                         | AF_UNSPEC
425                         | AF_INET
426                         | AF_INET6
427                         | AF_UNIX
428 #ifdef AF_PACKET
429                         | AF_PACKET
430 #endif
431 #ifdef AF_NETLINK
432                         | AF_NETLINK
433 #endif
434                         /* | AF_DECnet */
435                         /* | AF_IPX */
436                         ) <= 127 ? 1 : -1];
437 };
438
439
440 void parse_datestr(const char *date_str, struct tm *tm_time) FAST_FUNC;
441
442
443 int xsocket(int domain, int type, int protocol) FAST_FUNC;
444 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen) FAST_FUNC;
445 void xlisten(int s, int backlog) FAST_FUNC;
446 void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen) FAST_FUNC;
447 ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
448                                 socklen_t tolen) FAST_FUNC;
449 /* SO_REUSEADDR allows a server to rebind to an address that is already
450  * "in use" by old connections to e.g. previous server instance which is
451  * killed or crashed. Without it bind will fail until all such connections
452  * time out. Linux does not allow multiple live binds on same ip:port
453  * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
454  * Turn it on before you call bind(). */
455 void setsockopt_reuseaddr(int fd) FAST_FUNC; /* On Linux this never fails. */
456 int setsockopt_broadcast(int fd) FAST_FUNC;
457 int setsockopt_bindtodevice(int fd, const char *iface) FAST_FUNC;
458 /* NB: returns port in host byte order */
459 unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port) FAST_FUNC;
460 typedef struct len_and_sockaddr {
461         socklen_t len;
462         union {
463                 struct sockaddr sa;
464                 struct sockaddr_in sin;
465 #if ENABLE_FEATURE_IPV6
466                 struct sockaddr_in6 sin6;
467 #endif
468         } u;
469 } len_and_sockaddr;
470 enum {
471         LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
472         LSA_SIZEOF_SA = sizeof(
473                 union {
474                         struct sockaddr sa;
475                         struct sockaddr_in sin;
476 #if ENABLE_FEATURE_IPV6
477                         struct sockaddr_in6 sin6;
478 #endif
479                 }
480         )
481 };
482 /* Create stream socket, and allocate suitable lsa.
483  * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
484  * af == AF_UNSPEC will result in trying to create IPv6 socket,
485  * and if kernel doesn't support it, IPv4.
486  */
487 #if ENABLE_FEATURE_IPV6
488 int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type) FAST_FUNC;
489 #else
490 int xsocket_type(len_and_sockaddr **lsap, int sock_type) FAST_FUNC;
491 #define xsocket_type(lsap, af, sock_type) xsocket_type((lsap), (sock_type))
492 #endif
493 int xsocket_stream(len_and_sockaddr **lsap) FAST_FUNC;
494 /* Create server socket bound to bindaddr:port. bindaddr can be NULL,
495  * numeric IP ("N.N.N.N") or numeric IPv6 address,
496  * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
497  * Only if there is no suffix, port argument is used */
498 /* NB: these set SO_REUSEADDR before bind */
499 int create_and_bind_stream_or_die(const char *bindaddr, int port) FAST_FUNC;
500 int create_and_bind_dgram_or_die(const char *bindaddr, int port) FAST_FUNC;
501 /* Create client TCP socket connected to peer:port. Peer cannot be NULL.
502  * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
503  * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
504  * If there is no suffix, port argument is used */
505 int create_and_connect_stream_or_die(const char *peer, int port) FAST_FUNC;
506 /* Connect to peer identified by lsa */
507 int xconnect_stream(const len_and_sockaddr *lsa) FAST_FUNC;
508 /* Get local address of bound or accepted socket */
509 len_and_sockaddr *get_sock_lsa(int fd) FAST_FUNC;
510 /* Return malloc'ed len_and_sockaddr with socket address of host:port
511  * Currently will return IPv4 or IPv6 sockaddrs only
512  * (depending on host), but in theory nothing prevents e.g.
513  * UNIX socket address being returned, IPX sockaddr etc...
514  * On error does bb_error_msg and returns NULL */
515 len_and_sockaddr* host2sockaddr(const char *host, int port) FAST_FUNC;
516 /* Version which dies on error */
517 len_and_sockaddr* xhost2sockaddr(const char *host, int port) FAST_FUNC;
518 len_and_sockaddr* xdotted2sockaddr(const char *host, int port) FAST_FUNC;
519 /* Same, useful if you want to force family (e.g. IPv6) */
520 #if !ENABLE_FEATURE_IPV6
521 #define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
522 #define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
523 #else
524 len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC;
525 len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC;
526 #endif
527 /* Assign sin[6]_port member if the socket is an AF_INET[6] one,
528  * otherwise no-op. Useful for ftp.
529  * NB: does NOT do htons() internally, just direct assignment. */
530 void set_nport(len_and_sockaddr *lsa, unsigned port) FAST_FUNC;
531 /* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
532 int get_nport(const struct sockaddr *sa) FAST_FUNC;
533 /* Reverse DNS. Returns NULL on failure. */
534 char* xmalloc_sockaddr2host(const struct sockaddr *sa) FAST_FUNC;
535 /* This one doesn't append :PORTNUM */
536 char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa) FAST_FUNC;
537 /* This one also doesn't fall back to dotted IP (returns NULL) */
538 char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa) FAST_FUNC;
539 /* inet_[ap]ton on steroids */
540 char* xmalloc_sockaddr2dotted(const struct sockaddr *sa) FAST_FUNC;
541 char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa) FAST_FUNC;
542 // "old" (ipv4 only) API
543 // users: traceroute.c hostname.c - use _list_ of all IPs
544 struct hostent *xgethostbyname(const char *name) FAST_FUNC;
545 // Also mount.c and inetd.c are using gethostbyname(),
546 // + inet_common.c has additional IPv4-only stuff
547
548
549 void socket_want_pktinfo(int fd) FAST_FUNC;
550 ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
551                 const struct sockaddr *to,
552                 const struct sockaddr *from,
553                 socklen_t tolen) FAST_FUNC;
554 ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
555                 struct sockaddr *from,
556                 struct sockaddr *to,
557                 socklen_t sa_size) FAST_FUNC;
558
559 char *xstrdup(const char *s) FAST_FUNC;
560 char *xstrndup(const char *s, int n) FAST_FUNC;
561 void overlapping_strcpy(char *dst, const char *src) FAST_FUNC;
562 char *safe_strncpy(char *dst, const char *src, size_t size) FAST_FUNC;
563 char *strncpy_IFNAMSIZ(char *dst, const char *src) FAST_FUNC;
564 /* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
565  * But potentially slow, don't use in one-billion-times loops */
566 int bb_putchar(int ch) FAST_FUNC;
567 char *xasprintf(const char *format, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
568 /* Prints unprintable chars ch as ^C or M-c to file
569  * (M-c is used only if ch is ORed with PRINTABLE_META),
570  * else it is printed as-is (except for ch = 0x9b) */
571 enum { PRINTABLE_META = 0x100 };
572 void fputc_printable(int ch, FILE *file) FAST_FUNC;
573 // gcc-4.1.1 still isn't good enough at optimizing it
574 // (+200 bytes compared to macro)
575 //static ALWAYS_INLINE
576 //int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
577 //static ALWAYS_INLINE
578 //int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
579 #define LONE_DASH(s)     ((s)[0] == '-' && !(s)[1])
580 #define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
581 #define LONE_CHAR(s,c)     ((s)[0] == (c) && !(s)[1])
582 #define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
583 #define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
584
585 /* dmalloc will redefine these to it's own implementation. It is safe
586  * to have the prototypes here unconditionally.  */
587 void *malloc_or_warn(size_t size) FAST_FUNC;
588 void *xmalloc(size_t size) FAST_FUNC;
589 void *xzalloc(size_t size) FAST_FUNC;
590 void *xrealloc(void *old, size_t size) FAST_FUNC;
591 /* After xrealloc_vector(v, 4, idx) it's ok to use
592  * at least v[idx] and v[idx+1], for all idx values.
593  * shift specifies how many new elements are added (1: 2, 2: 4... 8: 256...)
594  * when all elements are used up. New elements are zeroed out. */
595 #define xrealloc_vector(vector, shift, idx) \
596         xrealloc_vector_helper((vector), (sizeof((vector)[0]) << 8) + (shift), (idx))
597 void* xrealloc_vector_helper(void *vector, unsigned sizeof_and_shift, int idx) FAST_FUNC;
598
599
600 extern ssize_t safe_read(int fd, void *buf, size_t count) FAST_FUNC;
601 extern ssize_t nonblock_safe_read(int fd, void *buf, size_t count) FAST_FUNC;
602 // NB: will return short read on error, not -1,
603 // if some data was read before error occurred
604 extern ssize_t full_read(int fd, void *buf, size_t count) FAST_FUNC;
605 extern void xread(int fd, void *buf, size_t count) FAST_FUNC;
606 extern unsigned char xread_char(int fd) FAST_FUNC;
607 extern ssize_t read_close(int fd, void *buf, size_t maxsz) FAST_FUNC;
608 extern ssize_t open_read_close(const char *filename, void *buf, size_t maxsz) FAST_FUNC;
609 // Reads one line a-la fgets (but doesn't save terminating '\n').
610 // Reads byte-by-byte. Useful when it is important to not read ahead.
611 // Bytes are appended to pfx (which must be malloced, or NULL).
612 extern char *xmalloc_reads(int fd, char *pfx, size_t *maxsz_p) FAST_FUNC;
613 /* Reads block up to *maxsz_p (default: INT_MAX - 4095) */
614 extern void *xmalloc_read(int fd, size_t *maxsz_p) FAST_FUNC;
615 /* Returns NULL if file can't be opened (default max size: INT_MAX - 4095) */
616 extern void *xmalloc_open_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC;
617 /* Autodetects .gz etc */
618 extern int open_zipped(const char *fname) FAST_FUNC;
619 extern void *xmalloc_open_zipped_read_close(const char *fname, size_t *maxsz_p) FAST_FUNC;
620 /* Never returns NULL */
621 extern void *xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC;
622
623 extern ssize_t safe_write(int fd, const void *buf, size_t count) FAST_FUNC;
624 // NB: will return short write on error, not -1,
625 // if some data was written before error occurred
626 extern ssize_t full_write(int fd, const void *buf, size_t count) FAST_FUNC;
627 extern void xwrite(int fd, const void *buf, size_t count) FAST_FUNC;
628 extern void xwrite_str(int fd, const char *str) FAST_FUNC;
629 extern void xopen_xwrite_close(const char* file, const char *str) FAST_FUNC;
630
631 /* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
632 extern void xprint_and_close_file(FILE *file) FAST_FUNC;
633
634 extern char *bb_get_chunk_from_file(FILE *file, int *end) FAST_FUNC;
635 extern char *bb_get_chunk_with_continuation(FILE *file, int *end, int *lineno) FAST_FUNC;
636 /* Reads up to (and including) TERMINATING_STRING: */
637 extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string) FAST_FUNC;
638 /* Same, with limited max size, and returns the length (excluding NUL): */
639 extern char *xmalloc_fgets_str_len(FILE *file, const char *terminating_string, size_t *maxsz_p) FAST_FUNC;
640 /* Chops off TERMINATING_STRING from the end: */
641 extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string) FAST_FUNC;
642 /* Reads up to (and including) "\n" or NUL byte: */
643 extern char *xmalloc_fgets(FILE *file) FAST_FUNC;
644 /* Chops off '\n' from the end, unlike fgets: */
645 extern char *xmalloc_fgetline(FILE *file) FAST_FUNC;
646 /* Same, but doesn't try to conserve space (may have some slack after the end) */
647 /* extern char *xmalloc_fgetline_fast(FILE *file) FAST_FUNC; */
648
649 extern void die_if_ferror(FILE *file, const char *msg) FAST_FUNC;
650 extern void die_if_ferror_stdout(void) FAST_FUNC;
651 extern void xfflush_stdout(void) FAST_FUNC;
652 extern void fflush_stdout_and_exit(int retval) NORETURN FAST_FUNC;
653 extern int fclose_if_not_stdin(FILE *file) FAST_FUNC;
654 extern FILE *xfopen(const char *filename, const char *mode) FAST_FUNC;
655 /* Prints warning to stderr and returns NULL on failure: */
656 extern FILE *fopen_or_warn(const char *filename, const char *mode) FAST_FUNC;
657 /* "Opens" stdin if filename is special, else just opens file: */
658 extern FILE *xfopen_stdin(const char *filename) FAST_FUNC;
659 extern FILE *fopen_or_warn_stdin(const char *filename) FAST_FUNC;
660 extern FILE* fopen_for_read(const char *path) FAST_FUNC;
661 extern FILE* xfopen_for_read(const char *path) FAST_FUNC;
662 extern FILE* fopen_for_write(const char *path) FAST_FUNC;
663 extern FILE* xfopen_for_write(const char *path) FAST_FUNC;
664
665 int bb_pstrcmp(const void *a, const void *b) /* not FAST_FUNC! */;
666 void qsort_string_vector(char **sv, unsigned count) FAST_FUNC;
667
668 /* Wrapper which restarts poll on EINTR or ENOMEM.
669  * On other errors complains [perror("poll")] and returns.
670  * Warning! May take (much) longer than timeout_ms to return!
671  * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
672 int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms) FAST_FUNC;
673
674 char *safe_gethostname(void) FAST_FUNC;
675 char *safe_getdomainname(void) FAST_FUNC;
676
677 /* Convert each alpha char in str to lower-case */
678 char* str_tolower(char *str) FAST_FUNC;
679
680 char *utoa(unsigned n) FAST_FUNC;
681 char *itoa(int n) FAST_FUNC;
682 /* Returns a pointer past the formatted number, does NOT null-terminate */
683 char *utoa_to_buf(unsigned n, char *buf, unsigned buflen) FAST_FUNC;
684 char *itoa_to_buf(int n, char *buf, unsigned buflen) FAST_FUNC;
685 /* Intelligent formatters of bignums */
686 void smart_ulltoa4(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
687 void smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
688 //TODO: provide pointer to buf (avoid statics)?
689 const char *make_human_readable_str(unsigned long long size,
690                 unsigned long block_size, unsigned long display_unit) FAST_FUNC;
691 /* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
692 char *bin2hex(char *buf, const char *cp, int count) FAST_FUNC;
693
694 /* Last element is marked by mult == 0 */
695 struct suffix_mult {
696         char suffix[4];
697         unsigned mult;
698 };
699 #include "xatonum.h"
700 /* Specialized: */
701 /* Using xatoi() instead of naive atoi() is not always convenient -
702  * in many places people want *non-negative* values, but store them
703  * in signed int. Therefore we need this one:
704  * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc */
705 int xatoi_u(const char *numstr) FAST_FUNC;
706 /* Useful for reading port numbers */
707 uint16_t xatou16(const char *numstr) FAST_FUNC;
708
709
710 /* These parse entries in /etc/passwd and /etc/group.  This is desirable
711  * for BusyBox since we want to avoid using the glibc NSS stuff, which
712  * increases target size and is often not needed on embedded systems.  */
713 long xuname2uid(const char *name) FAST_FUNC;
714 long xgroup2gid(const char *name) FAST_FUNC;
715 /* wrapper: allows string to contain numeric uid or gid */
716 unsigned long get_ug_id(const char *s, long FAST_FUNC (*xname2id)(const char *)) FAST_FUNC;
717 /* from chpst. Does not die, returns 0 on failure */
718 struct bb_uidgid_t {
719         uid_t uid;
720         gid_t gid;
721 };
722 /* always sets uid and gid */
723 int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok) FAST_FUNC;
724 /* always sets uid and gid, allows numeric; exits on failure */
725 void xget_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
726 /* chown-like handling of "user[:[group]" */
727 void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group) FAST_FUNC;
728 struct passwd* xgetpwnam(const char *name) FAST_FUNC;
729 struct group* xgetgrnam(const char *name) FAST_FUNC;
730 struct passwd* xgetpwuid(uid_t uid) FAST_FUNC;
731 struct group* xgetgrgid(gid_t gid) FAST_FUNC;
732 char* xuid2uname(uid_t uid) FAST_FUNC;
733 char* xgid2group(gid_t gid) FAST_FUNC;
734 char* uid2uname(uid_t uid) FAST_FUNC;
735 char* gid2group(gid_t gid) FAST_FUNC;
736 char* uid2uname_utoa(long uid) FAST_FUNC;
737 char* gid2group_utoa(long gid) FAST_FUNC;
738 /* versions which cache results (useful for ps, ls etc) */
739 const char* get_cached_username(uid_t uid) FAST_FUNC;
740 const char* get_cached_groupname(gid_t gid) FAST_FUNC;
741 void clear_username_cache(void) FAST_FUNC;
742 /* internally usernames are saved in fixed-sized char[] buffers */
743 enum { USERNAME_MAX_SIZE = 16 - sizeof(int) };
744 #if ENABLE_FEATURE_CHECK_NAMES
745 void die_if_bad_username(const char* name) FAST_FUNC;
746 #else
747 #define die_if_bad_username(name) ((void)(name))
748 #endif
749
750 int execable_file(const char *name) FAST_FUNC;
751 char *find_execable(const char *filename, char **PATHp) FAST_FUNC;
752 int exists_execable(const char *filename) FAST_FUNC;
753
754 /* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
755  * but it may exec busybox and call applet instead of searching PATH.
756  */
757 #if ENABLE_FEATURE_PREFER_APPLETS
758 int bb_execvp(const char *file, char *const argv[]) FAST_FUNC;
759 #define BB_EXECVP(prog,cmd) bb_execvp(prog,cmd)
760 #define BB_EXECLP(prog,cmd,...) \
761         execlp((find_applet_by_name(prog) >= 0) ? CONFIG_BUSYBOX_EXEC_PATH : prog, \
762                 cmd, __VA_ARGS__)
763 #else
764 #define BB_EXECVP(prog,cmd)     execvp(prog,cmd)
765 #define BB_EXECLP(prog,cmd,...) execlp(prog,cmd, __VA_ARGS__)
766 #endif
767
768 /* NOMMU friendy fork+exec */
769 pid_t spawn(char **argv) FAST_FUNC;
770 pid_t xspawn(char **argv) FAST_FUNC;
771
772 pid_t safe_waitpid(pid_t pid, int *wstat, int options) FAST_FUNC;
773 /* Unlike waitpid, waits ONLY for one process.
774  * It's safe to pass negative 'pids' from failed [v]fork -
775  * wait4pid will return -1 (and will not clobber [v]fork's errno).
776  * IOW: rc = wait4pid(spawn(argv));
777  *      if (rc < 0) bb_perror_msg("%s", argv[0]);
778  *      if (rc > 0) bb_error_msg("exit code: %d", rc);
779  */
780 int wait4pid(pid_t pid) FAST_FUNC;
781 pid_t wait_any_nohang(int *wstat) FAST_FUNC;
782 /* wait4pid(spawn(argv)) + NOFORK/NOEXEC (if configured) */
783 int spawn_and_wait(char **argv) FAST_FUNC;
784 struct nofork_save_area {
785         jmp_buf die_jmp;
786         const char *applet_name;
787         int xfunc_error_retval;
788         uint32_t option_mask32;
789         int die_sleep;
790         smallint saved;
791 };
792 void save_nofork_data(struct nofork_save_area *save) FAST_FUNC;
793 void restore_nofork_data(struct nofork_save_area *save) FAST_FUNC;
794 /* Does NOT check that applet is NOFORK, just blindly runs it */
795 int run_nofork_applet(int applet_no, char **argv) FAST_FUNC;
796 int run_nofork_applet_prime(struct nofork_save_area *old, int applet_no, char **argv) FAST_FUNC;
797
798 /* Helpers for daemonization.
799  *
800  * bb_daemonize(flags) = daemonize, does not compile on NOMMU
801  *
802  * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
803  *      rexec's itself on NOMMU with argv passed as command line.
804  * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
805  * from the start. (It will detect it and not reexec again second time).
806  * You have to audit carefully that you don't do something twice as a result
807  * (opening files/sockets, parsing config files etc...)!
808  *
809  * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
810  * (will do setsid()).
811  *
812  * fork_or_rexec(argv) = bare-bones "fork" on MMU,
813  *      "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
814  *      On MMU ignores argv.
815  *
816  * Helper for network daemons in foreground mode:
817  *
818  * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
819  * to /dev/null if they are not.
820  */
821 enum {
822         DAEMON_CHDIR_ROOT = 1,
823         DAEMON_DEVNULL_STDIO = 2,
824         DAEMON_CLOSE_EXTRA_FDS = 4,
825         DAEMON_ONLY_SANITIZE = 8, /* internal use */
826 };
827 #if BB_MMU
828   pid_t fork_or_rexec(void) FAST_FUNC;
829   enum { re_execed = 0 };
830 # define fork_or_rexec(argv)                fork_or_rexec()
831 # define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
832 # define bb_daemonize(flags)                bb_daemonize_or_rexec(flags, bogus)
833 #else
834   void re_exec(char **argv) NORETURN FAST_FUNC;
835   pid_t fork_or_rexec(char **argv) FAST_FUNC;
836   extern bool re_execed;
837   int  BUG_fork_is_unavailable_on_nommu(void) FAST_FUNC;
838   int  BUG_daemon_is_unavailable_on_nommu(void) FAST_FUNC;
839   void BUG_bb_daemonize_is_unavailable_on_nommu(void) FAST_FUNC;
840 # define fork()          BUG_fork_is_unavailable_on_nommu()
841 # define daemon(a,b)     BUG_daemon_is_unavailable_on_nommu()
842 # define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
843 #endif
844 void bb_daemonize_or_rexec(int flags, char **argv) FAST_FUNC;
845 void bb_sanitize_stdio(void) FAST_FUNC;
846 /* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
847 int sanitize_env_if_suid(void) FAST_FUNC;
848
849
850 extern const char *const bb_argv_dash[]; /* "-", NULL */
851 extern const char *opt_complementary;
852 #if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG
853 #define No_argument "\0"
854 #define Required_argument "\001"
855 #define Optional_argument "\002"
856 extern const char *applet_long_options;
857 #endif
858 extern uint32_t option_mask32;
859 extern uint32_t getopt32(char **argv, const char *applet_opts, ...) FAST_FUNC;
860
861
862 typedef struct llist_t {
863         char *data;
864         struct llist_t *link;
865 } llist_t;
866 void llist_add_to(llist_t **old_head, void *data) FAST_FUNC;
867 void llist_add_to_end(llist_t **list_head, void *data) FAST_FUNC;
868 void *llist_pop(llist_t **elm) FAST_FUNC;
869 void llist_unlink(llist_t **head, llist_t *elm) FAST_FUNC;
870 void llist_free(llist_t *elm, void (*freeit)(void *data)) FAST_FUNC;
871 llist_t *llist_rev(llist_t *list) FAST_FUNC;
872 llist_t *llist_find_str(llist_t *first, const char *str) FAST_FUNC;
873 /* BTW, surprisingly, changing API to
874  *   llist_t *llist_add_to(llist_t *old_head, void *data)
875  * etc does not result in smaller code... */
876
877 /* start_stop_daemon and udhcpc are special - they want
878  * to create pidfiles regardless of FEATURE_PIDFILE */
879 #if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
880 /* True only if we created pidfile which is *file*, not /dev/null etc */
881 extern smallint wrote_pidfile;
882 void write_pidfile(const char *path) FAST_FUNC;
883 #define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
884 #else
885 enum { wrote_pidfile = 0 };
886 #define write_pidfile(path)  ((void)0)
887 #define remove_pidfile(path) ((void)0)
888 #endif
889
890 enum {
891         LOGMODE_NONE = 0,
892         LOGMODE_STDIO = (1 << 0),
893         LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
894         LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
895 };
896 extern const char *msg_eol;
897 extern smallint logmode;
898 extern int die_sleep;
899 extern int xfunc_error_retval;
900 extern jmp_buf die_jmp;
901 extern void xfunc_die(void) NORETURN FAST_FUNC;
902 extern void bb_show_usage(void) NORETURN FAST_FUNC;
903 extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
904 extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
905 extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
906 extern void bb_simple_perror_msg(const char *s) FAST_FUNC;
907 extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
908 extern void bb_simple_perror_msg_and_die(const char *s) NORETURN FAST_FUNC;
909 extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
910 extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
911 extern void bb_perror_nomsg_and_die(void) NORETURN FAST_FUNC;
912 extern void bb_perror_nomsg(void) FAST_FUNC;
913 extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
914 extern void bb_verror_msg(const char *s, va_list p, const char *strerr) FAST_FUNC;
915
916 /* We need to export XXX_main from libbusybox
917  * only if we build "individual" binaries
918  */
919 #if ENABLE_FEATURE_INDIVIDUAL
920 #define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
921 #else
922 #define MAIN_EXTERNALLY_VISIBLE
923 #endif
924
925
926 /* Applets which are useful from another applets */
927 int bb_cat(char** argv);
928 /* If shell needs them, they exist even if not enabled as applets */
929 int echo_main(int argc, char** argv) IF_ECHO(MAIN_EXTERNALLY_VISIBLE);
930 int printf_main(int argc, char **argv) IF_PRINTF(MAIN_EXTERNALLY_VISIBLE);
931 int test_main(int argc, char **argv) IF_TEST(MAIN_EXTERNALLY_VISIBLE);
932 int kill_main(int argc, char **argv) IF_KILL(MAIN_EXTERNALLY_VISIBLE);
933 /* Similar, but used by chgrp, not shell */
934 int chown_main(int argc, char **argv) IF_CHOWN(MAIN_EXTERNALLY_VISIBLE);
935 /* Used by ftpd */
936 int ls_main(int argc, char **argv) IF_LS(MAIN_EXTERNALLY_VISIBLE);
937 /* Don't need IF_xxx() guard for these */
938 int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
939 int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
940
941 #if ENABLE_ROUTE
942 void bb_displayroutes(int noresolve, int netstatfmt) FAST_FUNC;
943 #endif
944
945
946 /* Networking */
947 int create_icmp_socket(void) FAST_FUNC;
948 int create_icmp6_socket(void) FAST_FUNC;
949 /* interface.c */
950 /* This structure defines protocol families and their handlers. */
951 struct aftype {
952         const char *name;
953         const char *title;
954         int af;
955         int alen;
956         char*       FAST_FUNC (*print)(unsigned char *);
957         const char* FAST_FUNC (*sprint)(struct sockaddr *, int numeric);
958         int         FAST_FUNC (*input)(/*int type,*/ const char *bufp, struct sockaddr *);
959         void        FAST_FUNC (*herror)(char *text);
960         int         FAST_FUNC (*rprint)(int options);
961         int         FAST_FUNC (*rinput)(int typ, int ext, char **argv);
962         /* may modify src */
963         int         FAST_FUNC (*getmask)(char *src, struct sockaddr *mask, char *name);
964 };
965 /* This structure defines hardware protocols and their handlers. */
966 struct hwtype {
967         const char *name;
968         const char *title;
969         int type;
970         int alen;
971         char* FAST_FUNC (*print)(unsigned char *);
972         int   FAST_FUNC (*input)(const char *, struct sockaddr *);
973         int   FAST_FUNC (*activate)(int fd);
974         int suppress_null_addr;
975 };
976 extern smallint interface_opt_a;
977 int display_interfaces(char *ifname) FAST_FUNC;
978 #if ENABLE_FEATURE_HWIB
979 int in_ib(const char *bufp, struct sockaddr *sap) FAST_FUNC;
980 #else
981 #define in_ib(a, b) 1 /* fail */
982 #endif
983 const struct aftype *get_aftype(const char *name) FAST_FUNC;
984 const struct hwtype *get_hwtype(const char *name) FAST_FUNC;
985 const struct hwtype *get_hwntype(int type) FAST_FUNC;
986
987
988 #ifndef BUILD_INDIVIDUAL
989 extern int find_applet_by_name(const char *name) FAST_FUNC;
990 /* Returns only if applet is not found. */
991 extern void run_applet_and_exit(const char *name, char **argv) FAST_FUNC;
992 extern void run_applet_no_and_exit(int a, char **argv) NORETURN FAST_FUNC;
993 #endif
994
995 #ifdef HAVE_MNTENT_H
996 extern int match_fstype(const struct mntent *mt, const char *fstypes) FAST_FUNC;
997 extern struct mntent *find_mount_point(const char *name) FAST_FUNC;
998 #endif
999 extern void erase_mtab(const char * name) FAST_FUNC;
1000 extern unsigned int tty_baud_to_value(speed_t speed) FAST_FUNC;
1001 extern speed_t tty_value_to_baud(unsigned int value) FAST_FUNC;
1002 extern void bb_warn_ignoring_args(int n) FAST_FUNC;
1003
1004 extern int get_linux_version_code(void) FAST_FUNC;
1005
1006 extern char *query_loop(const char *device) FAST_FUNC;
1007 extern int del_loop(const char *device) FAST_FUNC;
1008 /* If *devname is not NULL, use that name, otherwise try to find free one,
1009  * malloc and return it in *devname.
1010  * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
1011 extern int set_loop(char **devname, const char *file, unsigned long long offset) FAST_FUNC;
1012
1013 /* Like bb_ask below, but asks on stdin with no timeout.  */
1014 char *bb_ask_stdin(const char * prompt) FAST_FUNC;
1015 //TODO: pass buf pointer or return allocated buf (avoid statics)?
1016 char *bb_ask(const int fd, int timeout, const char * prompt) FAST_FUNC;
1017 int bb_ask_confirmation(void) FAST_FUNC;
1018
1019 int bb_parse_mode(const char* s, mode_t* theMode) FAST_FUNC;
1020
1021 /*
1022  * Config file parser
1023  */
1024 enum {
1025         PARSE_COLLAPSE  = 0x00010000, // treat consecutive delimiters as one
1026         PARSE_TRIM      = 0x00020000, // trim leading and trailing delimiters
1027 // TODO: COLLAPSE and TRIM seem to always go in pair
1028         PARSE_GREEDY    = 0x00040000, // last token takes entire remainder of the line
1029         PARSE_MIN_DIE   = 0x00100000, // die if < min tokens found
1030         // keep a copy of current line
1031         PARSE_KEEP_COPY = 0x00200000 * ENABLE_FEATURE_CROND_D,
1032 //      PARSE_ESCAPE    = 0x00400000, // process escape sequences in tokens
1033         // NORMAL is:
1034         // * remove leading and trailing delimiters and collapse
1035         //   multiple delimiters into one
1036         // * warn and continue if less than mintokens delimiters found
1037         // * grab everything into last token
1038         PARSE_NORMAL    = PARSE_COLLAPSE | PARSE_TRIM | PARSE_GREEDY,
1039 };
1040 typedef struct parser_t {
1041         FILE *fp;
1042         char *line;
1043         char *data;
1044         int lineno;
1045 } parser_t;
1046 parser_t* config_open(const char *filename) FAST_FUNC;
1047 parser_t* config_open2(const char *filename, FILE* FAST_FUNC (*fopen_func)(const char *path)) FAST_FUNC;
1048 int config_read(parser_t *parser, char **tokens, unsigned flags, const char *delims) FAST_FUNC;
1049 #define config_read(parser, tokens, max, min, str, flags) \
1050         config_read(parser, tokens, ((flags) | (((min) & 0xFF) << 8) | ((max) & 0xFF)), str)
1051 void config_close(parser_t *parser) FAST_FUNC;
1052
1053 /* Concatenate path and filename to new allocated buffer.
1054  * Add "/" only as needed (no duplicate "//" are produced).
1055  * If path is NULL, it is assumed to be "/".
1056  * filename should not be NULL. */
1057 char *concat_path_file(const char *path, const char *filename) FAST_FUNC;
1058 char *concat_subpath_file(const char *path, const char *filename) FAST_FUNC;
1059 const char *bb_basename(const char *name) FAST_FUNC;
1060 /* NB: can violate const-ness (similarly to strchr) */
1061 char *last_char_is(const char *s, int c) FAST_FUNC;
1062
1063
1064 int bb_make_directory(char *path, long mode, int flags) FAST_FUNC;
1065
1066 int get_signum(const char *name) FAST_FUNC;
1067 const char *get_signame(int number) FAST_FUNC;
1068 void print_signames(void) FAST_FUNC;
1069
1070 char *bb_simplify_path(const char *path) FAST_FUNC;
1071 /* Returns ptr to NUL */
1072 char *bb_simplify_abs_path_inplace(char *path) FAST_FUNC;
1073
1074 #define FAIL_DELAY 3
1075 extern void bb_do_delay(int seconds) FAST_FUNC;
1076 extern void change_identity(const struct passwd *pw) FAST_FUNC;
1077 extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) NORETURN FAST_FUNC;
1078 extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) FAST_FUNC;
1079 #if ENABLE_SELINUX
1080 extern void renew_current_security_context(void) FAST_FUNC;
1081 extern void set_current_security_context(security_context_t sid) FAST_FUNC;
1082 extern context_t set_security_context_component(security_context_t cur_context,
1083                                                 char *user, char *role, char *type, char *range) FAST_FUNC;
1084 extern void setfscreatecon_or_die(security_context_t scontext) FAST_FUNC;
1085 extern void selinux_preserve_fcontext(int fdesc) FAST_FUNC;
1086 #else
1087 #define selinux_preserve_fcontext(fdesc) ((void)0)
1088 #endif
1089 extern void selinux_or_die(void) FAST_FUNC;
1090 extern int restricted_shell(const char *shell) FAST_FUNC;
1091
1092 /* setup_environment:
1093  * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
1094  *   TERM=(old value)
1095  *   USER=pw->pw_name, LOGNAME=pw->pw_name
1096  *   PATH=bb_default_[root_]path
1097  *   HOME=pw->pw_dir
1098  *   SHELL=shell
1099  * else if change_env = 1:
1100  *   if not root (if pw->pw_uid != 0):
1101  *     USER=pw->pw_name, LOGNAME=pw->pw_name
1102  *   HOME=pw->pw_dir
1103  *   SHELL=shell
1104  * else does nothing
1105  */
1106 extern void setup_environment(const char *shell, int clear_env, int change_env, const struct passwd *pw) FAST_FUNC;
1107 extern int correct_password(const struct passwd *pw) FAST_FUNC;
1108 /* Returns a malloced string */
1109 #if !ENABLE_USE_BB_CRYPT
1110 #define pw_encrypt(clear, salt, cleanup) pw_encrypt(clear, salt)
1111 #endif
1112 extern char *pw_encrypt(const char *clear, const char *salt, int cleanup) FAST_FUNC;
1113 extern int obscure(const char *old, const char *newval, const struct passwd *pwdp) FAST_FUNC;
1114 /* rnd is additional random input. New one is returned.
1115  * Useful if you call crypt_make_salt many times in a row:
1116  * rnd = crypt_make_salt(buf1, 4, 0);
1117  * rnd = crypt_make_salt(buf2, 4, rnd);
1118  * rnd = crypt_make_salt(buf3, 4, rnd);
1119  * (otherwise we risk having same salt generated)
1120  */
1121 extern int crypt_make_salt(char *p, int cnt, int rnd) FAST_FUNC;
1122
1123 /* Returns number of lines changed, or -1 on error */
1124 #if !(ENABLE_FEATURE_ADDUSER_TO_GROUP || ENABLE_FEATURE_DEL_USER_FROM_GROUP)
1125 #define update_passwd(filename, username, data, member) \
1126         update_passwd(filename, username, data)
1127 #endif
1128 extern int update_passwd(const char *filename,
1129                 const char *username,
1130                 const char *data,
1131                 const char *member) FAST_FUNC;
1132
1133 int index_in_str_array(const char *const string_array[], const char *key) FAST_FUNC;
1134 int index_in_strings(const char *strings, const char *key) FAST_FUNC;
1135 int index_in_substr_array(const char *const string_array[], const char *key) FAST_FUNC;
1136 int index_in_substrings(const char *strings, const char *key) FAST_FUNC;
1137 const char *nth_string(const char *strings, int n) FAST_FUNC;
1138
1139 extern void print_login_issue(const char *issue_file, const char *tty) FAST_FUNC;
1140 extern void print_login_prompt(void) FAST_FUNC;
1141
1142 char *xmalloc_ttyname(int fd) FAST_FUNC;
1143 /* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
1144 int get_terminal_width_height(int fd, unsigned *width, unsigned *height) FAST_FUNC;
1145
1146 int tcsetattr_stdin_TCSANOW(const struct termios *tp) FAST_FUNC;
1147
1148 /* NB: "unsigned request" is crucial! "int request" will break some arches! */
1149 int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1150 int ioctl_or_perror_and_die(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1151 #if ENABLE_IOCTL_HEX2STR_ERROR
1152 int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1153 int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1154 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1155 #define xioctl(fd,request,argp)        bb_xioctl(fd,request,argp,#request)
1156 #else
1157 int bb_ioctl_or_warn(int fd, unsigned request, void *argp) FAST_FUNC;
1158 int bb_xioctl(int fd, unsigned request, void *argp) FAST_FUNC;
1159 #define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1160 #define xioctl(fd,request,argp)        bb_xioctl(fd,request,argp)
1161 #endif
1162
1163 char *is_in_ino_dev_hashtable(const struct stat *statbuf) FAST_FUNC;
1164 void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name) FAST_FUNC;
1165 void reset_ino_dev_hashtable(void) FAST_FUNC;
1166 #ifdef __GLIBC__
1167 /* At least glibc has horrendously large inline for this, so wrap it */
1168 unsigned long long bb_makedev(unsigned int major, unsigned int minor) FAST_FUNC;
1169 #undef makedev
1170 #define makedev(a,b) bb_makedev(a,b)
1171 #endif
1172
1173
1174 /* "Keycodes" that report an escape sequence.
1175  * We use something which fits into signed char,
1176  * yet doesn't represent any valid Unicode characher.
1177  * Also, -1 is reserved for error indication and we don't use it. */
1178 enum {
1179         KEYCODE_UP       =  -2,
1180         KEYCODE_DOWN     =  -3,
1181         KEYCODE_RIGHT    =  -4,
1182         KEYCODE_LEFT     =  -5,
1183         KEYCODE_HOME     =  -6,
1184         KEYCODE_END      =  -7,
1185         KEYCODE_INSERT   =  -8,
1186         KEYCODE_DELETE   =  -9,
1187         KEYCODE_PAGEUP   = -10,
1188         KEYCODE_PAGEDOWN = -11,
1189 #if 0
1190         KEYCODE_FUN1     = -12,
1191         KEYCODE_FUN2     = -13,
1192         KEYCODE_FUN3     = -14,
1193         KEYCODE_FUN4     = -15,
1194         KEYCODE_FUN5     = -16,
1195         KEYCODE_FUN6     = -17,
1196         KEYCODE_FUN7     = -18,
1197         KEYCODE_FUN8     = -19,
1198         KEYCODE_FUN9     = -20,
1199         KEYCODE_FUN10    = -21,
1200         KEYCODE_FUN11    = -22,
1201         KEYCODE_FUN12    = -23,
1202 #endif
1203         KEYCODE_CURSOR_POS = -0x100,
1204         /* How long is the longest ESC sequence we know?
1205          * We want it big enough to be able to contain
1206          * cursor position sequence "ESC [ 9999 ; 9999 R"
1207          */
1208         KEYCODE_BUFFER_SIZE = 16
1209 };
1210 /* Note: fd may be in blocking or non-blocking mode, both make sense.
1211  * For one, less uses non-blocking mode.
1212  * Only the first read syscall inside read_key may block indefinitely
1213  * (unless fd is in non-blocking mode),
1214  * subsequent reads will time out after a few milliseconds.
1215  * Return of -1 means EOF or error (errno == 0 on EOF).
1216  * buffer[0] is used as a counter of buffered chars and must be 0
1217  * on first call.
1218  */
1219 int64_t read_key(int fd, char *buffer) FAST_FUNC;
1220
1221
1222 #if ENABLE_FEATURE_EDITING
1223 /* It's NOT just ENABLEd or disabled. It's a number: */
1224 # ifdef CONFIG_FEATURE_EDITING_HISTORY
1225 #  define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
1226 # else
1227 #  define MAX_HISTORY 0
1228 # endif
1229 typedef struct line_input_t {
1230         int flags;
1231         const char *path_lookup;
1232 # if MAX_HISTORY
1233         int cnt_history;
1234         int cur_history;
1235 #  if ENABLE_FEATURE_EDITING_SAVEHISTORY
1236         unsigned cnt_history_in_file;
1237         const char *hist_file;
1238 #  endif
1239         char *history[MAX_HISTORY + 1];
1240 # endif
1241 } line_input_t;
1242 enum {
1243         DO_HISTORY = 1 * (MAX_HISTORY > 0),
1244         SAVE_HISTORY = 2 * (MAX_HISTORY > 0) * ENABLE_FEATURE_EDITING_SAVEHISTORY,
1245         TAB_COMPLETION = 4 * ENABLE_FEATURE_TAB_COMPLETION,
1246         USERNAME_COMPLETION = 8 * ENABLE_FEATURE_USERNAME_COMPLETION,
1247         VI_MODE = 0x10 * ENABLE_FEATURE_EDITING_VI,
1248         WITH_PATH_LOOKUP = 0x20,
1249         FOR_SHELL = DO_HISTORY | SAVE_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
1250 };
1251 line_input_t *new_line_input_t(int flags) FAST_FUNC;
1252 /* So far static: void free_line_input_t(line_input_t *n) FAST_FUNC; */
1253 /* maxsize must be >= 2.
1254  * Returns:
1255  * -1 on read errors or EOF, or on bare Ctrl-D,
1256  * 0  on ctrl-C (the line entered is still returned in 'command'),
1257  * >0 length of input string, including terminating '\n'
1258  */
1259 int read_line_input(const char* prompt, char* command, int maxsize, line_input_t *state) FAST_FUNC;
1260 #else
1261 int read_line_input(const char* prompt, char* command, int maxsize) FAST_FUNC;
1262 #define read_line_input(prompt, command, maxsize, state) \
1263         read_line_input(prompt, command, maxsize)
1264 #endif
1265
1266
1267 #ifndef COMM_LEN
1268 # ifdef TASK_COMM_LEN
1269 enum { COMM_LEN = TASK_COMM_LEN };
1270 # else
1271 /* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
1272 enum { COMM_LEN = 16 };
1273 # endif
1274 #endif
1275 typedef struct procps_status_t {
1276         DIR *dir;
1277         uint8_t shift_pages_to_bytes;
1278         uint8_t shift_pages_to_kb;
1279 /* Fields are set to 0/NULL if failed to determine (or not requested) */
1280         uint16_t argv_len;
1281         char *argv0;
1282         IF_SELINUX(char *context;)
1283         /* Everything below must contain no ptrs to malloc'ed data:
1284          * it is memset(0) for each process in procps_scan() */
1285         unsigned long vsz, rss; /* we round it to kbytes */
1286         unsigned long stime, utime;
1287         unsigned long start_time;
1288         unsigned pid;
1289         unsigned ppid;
1290         unsigned pgid;
1291         unsigned sid;
1292         unsigned uid;
1293         unsigned gid;
1294 #if ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS
1295         unsigned ruid;
1296         unsigned rgid;
1297         int niceness;
1298 #endif
1299         unsigned tty_major,tty_minor;
1300 #if ENABLE_FEATURE_TOPMEM
1301         unsigned long mapped_rw;
1302         unsigned long mapped_ro;
1303         unsigned long shared_clean;
1304         unsigned long shared_dirty;
1305         unsigned long private_clean;
1306         unsigned long private_dirty;
1307         unsigned long stack;
1308 #endif
1309         char state[4];
1310         /* basename of executable in exec(2), read from /proc/N/stat
1311          * (if executable is symlink or script, it is NOT replaced
1312          * by link target or interpreter name) */
1313         char comm[COMM_LEN];
1314         /* user/group? - use passwd/group parsing functions */
1315 #if ENABLE_FEATURE_TOP_SMP_PROCESS
1316         int last_seen_on_cpu;
1317 #endif
1318 } procps_status_t;
1319 /* flag bits for procps_scan(xx, flags) calls */
1320 enum {
1321         PSSCAN_PID      = 1 << 0,
1322         PSSCAN_PPID     = 1 << 1,
1323         PSSCAN_PGID     = 1 << 2,
1324         PSSCAN_SID      = 1 << 3,
1325         PSSCAN_UIDGID   = 1 << 4,
1326         PSSCAN_COMM     = 1 << 5,
1327         /* PSSCAN_CMD      = 1 << 6, - use read_cmdline instead */
1328         PSSCAN_ARGV0    = 1 << 7,
1329         /* PSSCAN_EXE      = 1 << 8, - not implemented */
1330         PSSCAN_STATE    = 1 << 9,
1331         PSSCAN_VSZ      = 1 << 10,
1332         PSSCAN_RSS      = 1 << 11,
1333         PSSCAN_STIME    = 1 << 12,
1334         PSSCAN_UTIME    = 1 << 13,
1335         PSSCAN_TTY      = 1 << 14,
1336         PSSCAN_SMAPS    = (1 << 15) * ENABLE_FEATURE_TOPMEM,
1337         /* NB: used by find_pid_by_name(). Any applet using it
1338          * needs to be mentioned here. */
1339         PSSCAN_ARGVN    = (1 << 16) * (ENABLE_KILLALL
1340                                 || ENABLE_PGREP || ENABLE_PKILL
1341                                 || ENABLE_PIDOF
1342                                 || ENABLE_SESTATUS
1343                                 ),
1344         IF_SELINUX(PSSCAN_CONTEXT = 1 << 17,)
1345         PSSCAN_START_TIME = 1 << 18,
1346         PSSCAN_CPU      = (1 << 19) * ENABLE_FEATURE_TOP_SMP_PROCESS,
1347         PSSCAN_NICE     = (1 << 20) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1348         PSSCAN_RUIDGID  = (1 << 21) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1349         /* These are all retrieved from proc/NN/stat in one go: */
1350         PSSCAN_STAT     = PSSCAN_PPID | PSSCAN_PGID | PSSCAN_SID
1351         /**/            | PSSCAN_COMM | PSSCAN_STATE
1352         /**/            | PSSCAN_VSZ | PSSCAN_RSS
1353         /**/            | PSSCAN_STIME | PSSCAN_UTIME | PSSCAN_START_TIME
1354         /**/            | PSSCAN_TTY | PSSCAN_NICE
1355         /**/            | PSSCAN_CPU
1356 };
1357 //procps_status_t* alloc_procps_scan(void) FAST_FUNC;
1358 void free_procps_scan(procps_status_t* sp) FAST_FUNC;
1359 procps_status_t* procps_scan(procps_status_t* sp, int flags) FAST_FUNC;
1360 /* Format cmdline (up to col chars) into char buf[col+1] */
1361 /* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
1362 void read_cmdline(char *buf, int col, unsigned pid, const char *comm) FAST_FUNC;
1363 pid_t *find_pid_by_name(const char* procName) FAST_FUNC;
1364 pid_t *pidlist_reverse(pid_t *pidList) FAST_FUNC;
1365
1366
1367 extern const char bb_uuenc_tbl_base64[];
1368 extern const char bb_uuenc_tbl_std[];
1369 void bb_uuencode(char *store, const void *s, int length, const char *tbl) FAST_FUNC;
1370
1371 typedef struct sha1_ctx_t {
1372         uint32_t hash[8];    /* 5, +3 elements for sha256 */
1373         uint64_t total64;
1374         uint8_t wbuffer[64]; /* NB: always correctly aligned for uint64_t */
1375         void (*process_block)(struct sha1_ctx_t*) FAST_FUNC;
1376 } sha1_ctx_t;
1377 void sha1_begin(sha1_ctx_t *ctx) FAST_FUNC;
1378 void sha1_hash(const void *data, size_t length, sha1_ctx_t *ctx) FAST_FUNC;
1379 void sha1_end(void *resbuf, sha1_ctx_t *ctx) FAST_FUNC;
1380 typedef struct sha1_ctx_t sha256_ctx_t;
1381 void sha256_begin(sha256_ctx_t *ctx) FAST_FUNC;
1382 #define sha256_hash sha1_hash
1383 #define sha256_end sha1_end
1384 typedef struct sha512_ctx_t {
1385         uint64_t hash[8];
1386         uint64_t total64[2];
1387         uint8_t wbuffer[128]; /* NB: always correctly aligned for uint64_t */
1388 } sha512_ctx_t;
1389 void sha512_begin(sha512_ctx_t *ctx) FAST_FUNC;
1390 void sha512_hash(const void *buffer, size_t len, sha512_ctx_t *ctx) FAST_FUNC;
1391 void sha512_end(void *resbuf, sha512_ctx_t *ctx) FAST_FUNC;
1392 #if 1
1393 typedef struct md5_ctx_t {
1394         uint32_t A;
1395         uint32_t B;
1396         uint32_t C;
1397         uint32_t D;
1398         uint64_t total;
1399         uint32_t buflen;
1400         char buffer[128];
1401 } md5_ctx_t;
1402 #else
1403 /* libbb/md5prime.c uses a bit different one: */
1404 typedef struct md5_ctx_t {
1405         uint32_t state[4];      /* state (ABCD) */
1406         uint32_t count[2];      /* number of bits, modulo 2^64 (lsb first) */
1407         unsigned char buffer[64];       /* input buffer */
1408 } md5_ctx_t;
1409 #endif
1410 void md5_begin(md5_ctx_t *ctx) FAST_FUNC;
1411 void md5_hash(const void *data, size_t length, md5_ctx_t *ctx) FAST_FUNC;
1412 void md5_end(void *resbuf, md5_ctx_t *ctx) FAST_FUNC;
1413
1414
1415 uint32_t *crc32_filltable(uint32_t *tbl256, int endian) FAST_FUNC;
1416
1417 typedef struct masks_labels_t {
1418         const char *labels;
1419         const int masks[];
1420 } masks_labels_t;
1421 int print_flags_separated(const int *masks, const char *labels,
1422                 int flags, const char *separator) FAST_FUNC;
1423 int print_flags(const masks_labels_t *ml, int flags) FAST_FUNC;
1424
1425
1426 extern const char *applet_name;
1427 /* "BusyBox vN.N.N (timestamp or extra_version)" */
1428 extern const char bb_banner[];
1429 extern const char bb_msg_memory_exhausted[];
1430 extern const char bb_msg_invalid_date[];
1431 extern const char bb_msg_read_error[];
1432 extern const char bb_msg_write_error[];
1433 extern const char bb_msg_unknown[];
1434 extern const char bb_msg_can_not_create_raw_socket[];
1435 extern const char bb_msg_perm_denied_are_you_root[];
1436 extern const char bb_msg_requires_arg[];
1437 extern const char bb_msg_invalid_arg[];
1438 extern const char bb_msg_standard_input[];
1439 extern const char bb_msg_standard_output[];
1440
1441 extern const char bb_str_default[];
1442 /* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
1443 extern const char bb_hexdigits_upcase[];
1444
1445 extern const char bb_path_mtab_file[];
1446 extern const char bb_path_passwd_file[];
1447 extern const char bb_path_shadow_file[];
1448 extern const char bb_path_gshadow_file[];
1449 extern const char bb_path_group_file[];
1450 extern const char bb_path_motd_file[];
1451 extern const char bb_path_wtmp_file[];
1452 extern const char bb_dev_null[];
1453 extern const char bb_busybox_exec_path[];
1454 /* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1455  * but I want to save a few bytes here */
1456 extern const char bb_PATH_root_path[]; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
1457 #define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1458 #define bb_default_path      (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
1459
1460 extern const int const_int_0;
1461 extern const int const_int_1;
1462
1463
1464 #ifndef BUFSIZ
1465 #define BUFSIZ 4096
1466 #endif
1467 /* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
1468 enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
1469 extern char bb_common_bufsiz1[COMMON_BUFSIZE];
1470 /* This struct is deliberately not defined. */
1471 /* See docs/keep_data_small.txt */
1472 struct globals;
1473 /* '*const' ptr makes gcc optimize code much better.
1474  * Magic prevents ptr_to_globals from going into rodata.
1475  * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
1476 extern struct globals *const ptr_to_globals;
1477 /* At least gcc 3.4.6 on mipsel system needs optimization barrier */
1478 #define barrier() __asm__ __volatile__("":::"memory")
1479 #define SET_PTR_TO_GLOBALS(x) do { \
1480         (*(struct globals**)&ptr_to_globals) = (x); \
1481         barrier(); \
1482 } while (0)
1483
1484 /* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1485  * use bb_default_login_shell and following defines.
1486  * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1487  * don't forget to change increment constant. */
1488 #define LIBBB_DEFAULT_LOGIN_SHELL      "-/bin/sh"
1489 extern const char bb_default_login_shell[];
1490 /* "/bin/sh" */
1491 #define DEFAULT_SHELL     (bb_default_login_shell+1)
1492 /* "sh" */
1493 #define DEFAULT_SHELL_SHORT_NAME     (bb_default_login_shell+6)
1494
1495 #if ENABLE_FEATURE_DEVFS
1496 # define CURRENT_VC "/dev/vc/0"
1497 # define VC_1 "/dev/vc/1"
1498 # define VC_2 "/dev/vc/2"
1499 # define VC_3 "/dev/vc/3"
1500 # define VC_4 "/dev/vc/4"
1501 # define VC_5 "/dev/vc/5"
1502 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1503 /* Yes, this sucks, but both SH (including sh64) and H8 have a SCI(F) for their
1504    respective serial ports .. as such, we can't use the common device paths for
1505    these. -- PFM */
1506 #  define SC_0 "/dev/ttsc/0"
1507 #  define SC_1 "/dev/ttsc/1"
1508 #  define SC_FORMAT "/dev/ttsc/%d"
1509 #else
1510 #  define SC_0 "/dev/tts/0"
1511 #  define SC_1 "/dev/tts/1"
1512 #  define SC_FORMAT "/dev/tts/%d"
1513 #endif
1514 # define VC_FORMAT "/dev/vc/%d"
1515 # define LOOP_FORMAT "/dev/loop/%d"
1516 # define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
1517 # define LOOP_NAME "/dev/loop/"
1518 # define FB_0 "/dev/fb/0"
1519 #else
1520 # define CURRENT_VC "/dev/tty0"
1521 # define VC_1 "/dev/tty1"
1522 # define VC_2 "/dev/tty2"
1523 # define VC_3 "/dev/tty3"
1524 # define VC_4 "/dev/tty4"
1525 # define VC_5 "/dev/tty5"
1526 #if defined(__sh__) || defined(__H8300H__) || defined(__H8300S__)
1527 #  define SC_0 "/dev/ttySC0"
1528 #  define SC_1 "/dev/ttySC1"
1529 #  define SC_FORMAT "/dev/ttySC%d"
1530 #else
1531 #  define SC_0 "/dev/ttyS0"
1532 #  define SC_1 "/dev/ttyS1"
1533 #  define SC_FORMAT "/dev/ttyS%d"
1534 #endif
1535 # define VC_FORMAT "/dev/tty%d"
1536 # define LOOP_FORMAT "/dev/loop%d"
1537 # define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
1538 # define LOOP_NAME "/dev/loop"
1539 # define FB_0 "/dev/fb0"
1540 #endif
1541
1542 /* The following devices are the same on devfs and non-devfs systems.  */
1543 #define CURRENT_TTY "/dev/tty"
1544 #define DEV_CONSOLE "/dev/console"
1545
1546
1547 #ifndef RB_POWER_OFF
1548 /* Stop system and switch power off if possible.  */
1549 #define RB_POWER_OFF   0x4321fedc
1550 #endif
1551
1552 /* Make sure we call functions instead of macros.  */
1553 #undef isalnum
1554 #undef isalpha
1555 #undef isascii
1556 #undef isblank
1557 #undef iscntrl
1558 #undef isgraph
1559 #undef islower
1560 #undef isprint
1561 #undef ispunct
1562 #undef isspace
1563 #undef isupper
1564 #undef isxdigit
1565
1566 /* This one is more efficient - we save ~400 bytes */
1567 #undef isdigit
1568 #define isdigit(a) ((unsigned)((a) - '0') <= 9)
1569
1570 #define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
1571
1572
1573 POP_SAVED_FUNCTION_VISIBILITY
1574
1575 #endif