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