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