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