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