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