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