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