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