Magellan Linux

Annotation of /trunk/mkinitrd-magellan/busybox/include/libbb.h

Parent Directory Parent Directory | Revision Log Revision Log


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