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