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