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