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