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