blob: e2bedaf41674dd9bf4d870998daad6aec840ca97 [file] [log] [blame]
Eric Andersenaad1a882001-03-16 22:47:14 +00001/* vi: set sw=4 ts=4: */
2/*
3 * Busybox main internal header file
4 *
Eric Andersenc7bda1c2004-03-15 08:29:22 +00005 * Based in part on code from sash, Copyright (c) 1999 by David I. Bell
Denys Vlasenko0ef64bd2010-08-16 20:14:46 +02006 * Permission has been granted to redistribute this code under GPL.
Denis Vlasenkof7996f32007-01-11 17:20:00 +00007 *
Denys Vlasenko0ef64bd2010-08-16 20:14:46 +02008 * Licensed under GPLv2, see file LICENSE in this source tree.
Eric Andersenaad1a882001-03-16 22:47:14 +00009 */
Denis Vlasenkof81e8db2009-04-09 12:35:13 +000010#ifndef LIBBB_H
11#define LIBBB_H 1
Eric Andersenaad1a882001-03-16 22:47:14 +000012
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +000013#include "platform.h"
14
Rob Landley5d9c42a2006-06-24 17:55:02 +000015#include <ctype.h>
Rob Landleyb623a542006-05-31 22:09:03 +000016#include <dirent.h>
Rob Landleyc9c1a412006-07-12 19:17:55 +000017#include <errno.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000018#include <fcntl.h>
Rob Landleyb623a542006-05-31 22:09:03 +000019#include <inttypes.h>
20#include <netdb.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000021#include <setjmp.h>
Rob Landley1cca9482006-07-10 19:45:20 +000022#include <signal.h>
Kylie McClain40eea692016-02-01 01:36:05 +010023#include <paths.h>
Denys Vlasenko89f5bfd2011-05-12 23:03:18 +020024#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
Denys Vlasenko5b9b1362010-02-02 03:08:57 +010030#include <stdint.h>
Eric Andersenaad1a882001-03-16 22:47:14 +000031#include <stdio.h>
Manuel Novoa III 68474f32004-02-05 14:45:58 +000032#include <stdlib.h>
Eric Andersenaad1a882001-03-16 22:47:14 +000033#include <stdarg.h>
Denis Vlasenko4b4b6192007-03-18 20:33:26 +000034#include <stddef.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000035#include <string.h>
Thomas Petazzoniaf4f0e42013-10-16 19:59:45 +020036/* There are two incompatible basename's, let's not use them! */
Denys Vlasenkod48fdde2011-09-10 13:48:34 +020037/* See the dirname/basename man page for details */
38#include <libgen.h> /* dirname,basename */
39#undef basename
40#define basename dont_use_basename
Thomas Petazzoniaf4f0e42013-10-16 19:59:45 +020041#include <poll.h>
Rob Landleyc9c1a412006-07-12 19:17:55 +000042#include <sys/ioctl.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000043#include <sys/mman.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000044#include <sys/socket.h>
"Vladimir N. Oleynik"7fe65202005-09-20 10:02:36 +000045#include <sys/stat.h>
Rob Landley299a6b42006-05-27 21:42:58 +000046#include <sys/time.h>
Rob Landleyb623a542006-05-31 22:09:03 +000047#include <sys/types.h>
Denys Vlasenko4f13a702016-12-12 16:29:32 +010048#if !defined(major) || defined(__GLIBC__)
Denys Vlasenkodd807c12011-02-07 14:58:57 +010049# include <sys/sysmacros.h>
50#endif
Rob Landleyc9c1a412006-07-12 19:17:55 +000051#include <sys/wait.h>
Rob Landleyb623a542006-05-31 22:09:03 +000052#include <termios.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000053#include <time.h>
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000054#include <sys/param.h>
Denys Vlasenkoa76dd502012-01-08 16:11:38 +010055#include <pwd.h>
56#include <grp.h>
Denys Vlasenko3e0c4282012-01-08 16:13:55 +010057#if ENABLE_FEATURE_SHADOWPASSWDS
58# if !ENABLE_USE_BB_SHADOW
59/* If using busybox's shadow implementation, do not include the shadow.h
60 * header as the toolchain may not provide it at all.
61 */
62# include <shadow.h>
63# endif
64#endif
Denys Vlasenkoa76dd502012-01-08 16:11:38 +010065#if defined(ANDROID) || defined(__ANDROID__)
66# define endpwent() ((void)0)
67# define endgrent() ((void)0)
68#endif
Mike Frysinger22876c72008-02-07 22:10:07 +000069#ifdef HAVE_MNTENT_H
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +020070# include <mntent.h>
Mike Frysinger22876c72008-02-07 22:10:07 +000071#endif
Mike Frysinger9412ec72008-02-07 22:41:33 +000072#ifdef HAVE_SYS_STATFS_H
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +020073# include <sys/statfs.h>
Mike Frysinger9412ec72008-02-07 22:41:33 +000074#endif
Denys Vlasenko67905e22011-07-26 13:42:12 +020075/* Don't do this here:
76 * #include <sys/sysinfo.h>
77 * Some linux/ includes pull in conflicting definition
78 * of struct sysinfo (only in some toolchanins), which breaks build.
79 * Include sys/sysinfo.h only in those files which need it.
80 */
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000081#if ENABLE_SELINUX
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +020082# include <selinux/selinux.h>
83# include <selinux/context.h>
Eric Andersen9e480452003-07-03 10:07:04 +000084#endif
Denys Vlasenko8d0e0cd2011-01-25 23:21:46 +010085#if ENABLE_FEATURE_UTMP
Bernhard Reutner-Fischer7d863842015-04-19 23:45:17 +020086# if defined __UCLIBC__ && ( \
87 (UCLIBC_VERSION >= KERNEL_VERSION(0, 9, 32) \
88 && UCLIBC_VERSION < KERNEL_VERSION(0, 9, 34) \
89 && defined __UCLIBC_HAS_UTMPX__ \
90 ) || ( \
91 UCLIBC_VERSION >= KERNEL_VERSION(0, 9, 34) \
92 ) \
93 )
94# include <utmpx.h>
95# elif defined __UCLIBC__
96# include <utmp.h>
97# define utmpx utmp
98# define setutxent setutent
99# define endutxent endutent
100# define getutxent getutent
101# define getutxid getutid
102# define getutxline getutline
103# define pututxline pututline
104# define utmpxname utmpname
105# define updwtmpx updwtmp
106# define _PATH_UTMPX _PATH_UTMP
107# else
Kylie McClain40eea692016-02-01 01:36:05 +0100108# include <utmp.h>
Bernhard Reutner-Fischer7d863842015-04-19 23:45:17 +0200109# include <utmpx.h>
Kylie McClain40eea692016-02-01 01:36:05 +0100110# if defined _PATH_UTMP && !defined _PATH_UTMPX
111# define _PATH_UTMPX _PATH_UTMP
112# endif
Bernhard Reutner-Fischer7d863842015-04-19 23:45:17 +0200113# endif
Denys Vlasenko8d0e0cd2011-01-25 23:21:46 +0100114#endif
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000115#if ENABLE_LOCALE_SUPPORT
Denys Vlasenko9d57a802009-10-23 14:24:44 +0200116# include <locale.h>
Rob Landleyeb84a422006-09-20 21:41:13 +0000117#else
Denys Vlasenko9d57a802009-10-23 14:24:44 +0200118# define setlocale(x,y) ((void)0)
Rob Landleyd921b2e2006-08-03 15:41:12 +0000119#endif
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000120#ifdef DMALLOC
Denys Vlasenko9d57a802009-10-23 14:24:44 +0200121# include <dmalloc.h>
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000122#endif
Tito Ragusaad3d72f2011-01-16 23:39:45 +0100123/* Just in case libc doesn't define some of these... */
124#ifndef _PATH_PASSWD
125#define _PATH_PASSWD "/etc/passwd"
126#endif
127#ifndef _PATH_GROUP
128#define _PATH_GROUP "/etc/group"
129#endif
130#ifndef _PATH_SHADOW
131#define _PATH_SHADOW "/etc/shadow"
132#endif
133#ifndef _PATH_GSHADOW
134#define _PATH_GSHADOW "/etc/gshadow"
135#endif
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +0200136#if defined __FreeBSD__ || defined __OpenBSD__
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +0100137# include <netinet/in.h>
138# include <arpa/inet.h>
139#elif defined __APPLE__
140# include <netinet/in.h>
141#else
142# include <arpa/inet.h>
Denys Vlasenkodbb58a32016-03-14 18:23:33 +0100143//This breaks on bionic:
144//# if !defined(__socklen_t_defined) && !defined(_SOCKLEN_T_DECLARED)
145///* We #define socklen_t *after* includes, otherwise we get
146// * typedef redefinition errors from system headers
147// * (in case "is it defined already" detection above failed)
148// */
149//# define socklen_t bb_socklen_t
150// typedef unsigned socklen_t;
151//# endif
152//if this is still needed, add a fix along the lines of
153// ifdef SPECIFIC_BROKEN_LIBC_CHECK / typedef socklen_t / endif
154//in platform.h instead!
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +0100155#endif
Chris Rees330718e2011-01-24 17:07:06 +0100156#ifndef HAVE_CLEARENV
157# define clearenv() do { if (environ) environ[0] = NULL; } while (0)
158#endif
159#ifndef HAVE_FDATASYNC
160# define fdatasync fsync
161#endif
162#ifndef HAVE_XTABS
163# define XTABS TAB3
164#endif
Denys Vlasenko6f97b302017-09-29 18:17:25 +0200165/*
166 * Use '%m' to append error string on platforms that support it,
167 * '%s' and strerror() on those that don't.
168 */
169#ifdef HAVE_PRINTF_PERCENTM
170# define STRERROR_FMT "%m"
171# define STRERROR_ERRNO /*nothing*/
172#else
173# define STRERROR_FMT "%s"
174# define STRERROR_ERRNO ,strerror(errno)
175#endif
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +0100176
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000177
Denis Vlasenkoaf6cca52008-05-25 04:31:54 +0000178/* Some libc's forget to declare these, do it ourself */
Denis Vlasenko847fa772008-01-28 22:45:43 +0000179
Denis Vlasenkocac0f5b2008-09-25 10:20:46 +0000180extern char **environ;
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000181/* klogctl is in libc's klog.h, but we cheat and not #include that */
182int klogctl(int type, char *b, int len);
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +0100183#ifndef PATH_MAX
184# define PATH_MAX 256
185#endif
186#ifndef BUFSIZ
187# define BUFSIZ 4096
188#endif
Rob Landley362dc2b2006-06-05 17:35:24 +0000189
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000190
Denys Vlasenko0c4cf422011-06-30 02:44:27 +0200191/* Busybox does not use threads, we can speed up stdio. */
Dan Fandrich75214cf2011-06-30 02:59:17 +0200192#ifdef HAVE_UNLOCKED_STDIO
193# undef getc
Denys Vlasenkoaa3576a2016-08-22 19:54:12 +0200194# define getc(stream) getc_unlocked(stream)
Dan Fandrich75214cf2011-06-30 02:59:17 +0200195# undef getchar
Denys Vlasenkoaa3576a2016-08-22 19:54:12 +0200196# define getchar() getchar_unlocked()
Dan Fandrich75214cf2011-06-30 02:59:17 +0200197# undef putc
Denys Vlasenkoaa3576a2016-08-22 19:54:12 +0200198# define putc(c,stream) putc_unlocked(c,stream)
Dan Fandrich75214cf2011-06-30 02:59:17 +0200199# undef putchar
Denys Vlasenkoaa3576a2016-08-22 19:54:12 +0200200# define putchar(c) putchar_unlocked(c)
Dan Fandrich75214cf2011-06-30 02:59:17 +0200201# undef fgetc
Denys Vlasenkoaa3576a2016-08-22 19:54:12 +0200202# define fgetc(stream) getc_unlocked(stream)
Dan Fandrich75214cf2011-06-30 02:59:17 +0200203# undef fputc
Denys Vlasenkoaa3576a2016-08-22 19:54:12 +0200204# define fputc(c,stream) putc_unlocked(c,stream)
Dan Fandrich75214cf2011-06-30 02:59:17 +0200205#endif
Denys Vlasenko0c4cf422011-06-30 02:44:27 +0200206/* Above functions are required by POSIX.1-2008, below ones are extensions */
Dan Fandrich75214cf2011-06-30 02:59:17 +0200207#ifdef HAVE_UNLOCKED_LINE_OPS
208# undef fgets
Denys Vlasenkoaa3576a2016-08-22 19:54:12 +0200209# define fgets(s,n,stream) fgets_unlocked(s,n,stream)
Dan Fandrich75214cf2011-06-30 02:59:17 +0200210# undef fputs
Denys Vlasenkoaa3576a2016-08-22 19:54:12 +0200211# define fputs(s,stream) fputs_unlocked(s,stream)
Denys Vlasenko0ae05092016-09-18 21:49:30 +0200212/* musl <= 1.1.15 does not support fflush_unlocked(NULL) */
213//# undef fflush
214//# define fflush(stream) fflush_unlocked(stream)
Denys Vlasenkoaa3576a2016-08-22 19:54:12 +0200215# undef feof
216# define feof(stream) feof_unlocked(stream)
217# undef ferror
218# define ferror(stream) ferror_unlocked(stream)
219# undef fileno
220# define fileno(stream) fileno_unlocked(stream)
Dan Fandrich75214cf2011-06-30 02:59:17 +0200221#endif
Denys Vlasenko06448912011-06-20 10:06:28 +0200222
223
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000224/* Make all declarations hidden (-fvisibility flag only affects definitions) */
225/* (don't include system headers after this until corresponding pop!) */
Denis Vlasenkof81e8db2009-04-09 12:35:13 +0000226PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000227
228
229#if ENABLE_USE_BB_PWD_GRP
230# include "pwd_.h"
231# include "grp_.h"
232#endif
233#if ENABLE_FEATURE_SHADOWPASSWDS
234# if ENABLE_USE_BB_SHADOW
235# include "shadow_.h"
236# endif
237#endif
238
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000239/* Tested to work correctly with all int types (IIRC :]) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000240#define MAXINT(T) (T)( \
241 ((T)-1) > 0 \
242 ? (T)-1 \
243 : (T)~((T)1 << (sizeof(T)*8-1)) \
244 )
245
246#define MININT(T) (T)( \
247 ((T)-1) > 0 \
248 ? (T)0 \
249 : ((T)1 << (sizeof(T)*8-1)) \
250 )
Denis Vlasenko7039a662006-10-08 17:54:47 +0000251
Denis Vlasenko56254152006-10-07 16:24:46 +0000252/* Large file support */
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000253/* Note that CONFIG_LFS=y forces bbox to be built with all common ops
Denis Vlasenko7039a662006-10-08 17:54:47 +0000254 * (stat, lseek etc) mapped to "largefile" variants by libc.
255 * Practically it means that open() automatically has O_LARGEFILE added
256 * and all filesize/file_offset parameters and struct members are "large"
257 * (in today's world - signed 64bit). For full support of large files,
258 * we need a few helper #defines (below) and careful use of off_t
259 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000260#if ENABLE_LFS
Denis Vlasenko7039a662006-10-08 17:54:47 +0000261/* CONFIG_LFS is on */
262# if ULONG_MAX > 0xffffffff
263/* "long" is long enough on this system */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000264typedef unsigned long uoff_t;
Denys Vlasenkof59a50e2011-11-16 21:30:19 +0100265# define XATOOFF(a) xatoul_range((a), 0, LONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000266/* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
267# define BB_STRTOOFF bb_strtoul
268# define STRTOOFF strtoul
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000269/* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
270# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000271# else
Denis Vlasenkocba9ef52006-10-10 21:00:47 +0000272/* "long" is too short, need "long long" */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000273typedef unsigned long long uoff_t;
Denys Vlasenkof59a50e2011-11-16 21:30:19 +0100274# define XATOOFF(a) xatoull_range((a), 0, LLONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000275# define BB_STRTOOFF bb_strtoull
276# define STRTOOFF strtoull
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000277# define OFF_FMT "ll"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000278# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000279#else
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000280/* CONFIG_LFS is off */
281# if UINT_MAX == 0xffffffff
282/* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
283 * gcc will throw warnings on printf("%d", off_t). Crap... */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000284typedef unsigned long uoff_t;
Denys Vlasenko77832482010-08-12 14:14:45 +0200285# define XATOOFF(a) xatoi_positive(a)
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000286# define BB_STRTOOFF bb_strtou
Denis Vlasenko7039a662006-10-08 17:54:47 +0000287# define STRTOOFF strtol
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000288# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000289# else
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000290typedef unsigned long uoff_t;
Denys Vlasenkof59a50e2011-11-16 21:30:19 +0100291# define XATOOFF(a) xatoul_range((a), 0, LONG_MAX)
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000292# define BB_STRTOOFF bb_strtoul
Denis Vlasenko7039a662006-10-08 17:54:47 +0000293# define STRTOOFF strtol
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000294# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000295# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000296#endif
297/* scary. better ideas? (but do *test* them first!) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000298#define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
Denys Vlasenko1dc80ba2011-11-17 21:51:32 +0100299/* Users report bionic to use 32-bit off_t even if LARGEFILE support is requested.
300 * We misdetected that. Don't let it build:
301 */
302struct BUG_off_t_size_is_misdetected {
303 char BUG_off_t_size_is_misdetected[sizeof(off_t) == sizeof(uoff_t) ? 1 : -1];
304};
Denis Vlasenko56254152006-10-07 16:24:46 +0000305
Eric Andersenaad1a882001-03-16 22:47:14 +0000306/* Some useful definitions */
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000307#undef FALSE
Eric Andersenaad1a882001-03-16 22:47:14 +0000308#define FALSE ((int) 0)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000309#undef TRUE
Eric Andersenaad1a882001-03-16 22:47:14 +0000310#define TRUE ((int) 1)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000311#undef SKIP
Eric Andersenaad1a882001-03-16 22:47:14 +0000312#define SKIP ((int) 2)
313
Eric Andersenaad1a882001-03-16 22:47:14 +0000314/* Macros for min/max. */
315#ifndef MIN
Denys Vlasenkoe4dcba12010-10-28 18:57:19 +0200316#define MIN(a,b) (((a)<(b))?(a):(b))
Eric Andersenaad1a882001-03-16 22:47:14 +0000317#endif
318
319#ifndef MAX
Denys Vlasenkoe4dcba12010-10-28 18:57:19 +0200320#define MAX(a,b) (((a)>(b))?(a):(b))
Eric Andersenaad1a882001-03-16 22:47:14 +0000321#endif
322
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000323/* buffer allocation schemes */
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000324#if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000325#define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000326#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
327#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
328#else
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000329#if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000330#define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
331#define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
332#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
333#else
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000334#define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer = xmalloc(len)
335#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
336#define RELEASE_CONFIG_BUFFER(buffer) free(buffer)
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000337#endif
338#endif
339
Denis Vlasenkofad2b862007-05-31 22:16:38 +0000340#if defined(__GLIBC__)
341/* glibc uses __errno_location() to get a ptr to errno */
342/* We can just memorize it once - no multithreading in busybox :) */
343extern int *const bb_errno;
344#undef errno
345#define errno (*bb_errno)
346#endif
347
Denys Vlasenko9ff50b82010-10-18 11:40:26 +0200348#if !(ULONG_MAX > 0xffffffff)
349/* Only 32-bit CPUs need this, 64-bit ones use inlined version */
350uint64_t bb_bswap_64(uint64_t x) FAST_FUNC;
351#endif
352
Denys Vlasenko8a134ec2017-04-11 07:34:56 +0200353unsigned long FAST_FUNC isqrt(unsigned long long N);
354
Denis Vlasenkoce13b762008-06-29 02:25:53 +0000355unsigned long long monotonic_ns(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000356unsigned long long monotonic_us(void) FAST_FUNC;
Denys Vlasenkof2c8aa62010-01-12 12:52:30 +0100357unsigned long long monotonic_ms(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000358unsigned monotonic_sec(void) FAST_FUNC;
Manuel Novoa III cad53642003-03-19 09:13:01 +0000359
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000360extern void chomp(char *s) FAST_FUNC;
Denys Vlasenko20077c12017-08-05 17:50:35 +0200361extern char *trim(char *s) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000362extern char *skip_whitespace(const char *) FAST_FUNC;
363extern char *skip_non_whitespace(const char *) FAST_FUNC;
Denys Vlasenkof8d8aa12010-04-06 18:50:05 +0200364extern char *skip_dev_pfx(const char *tty_name) FAST_FUNC;
365
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000366extern char *strrstr(const char *haystack, const char *needle) FAST_FUNC;
Paul Fox0b621582005-08-09 19:38:05 +0000367
Denys Vlasenko9a647c32017-01-23 01:08:16 +0100368/* dmalloc will redefine these to it's own implementation. It is safe
369 * to have the prototypes here unconditionally. */
370void *malloc_or_warn(size_t size) FAST_FUNC RETURNS_MALLOC;
371void *xmalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
372void *xzalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
373void *xrealloc(void *old, size_t size) FAST_FUNC;
374/* After v = xrealloc_vector(v, SHIFT, idx) it's ok to use
375 * at least v[idx] and v[idx+1], for all idx values.
376 * SHIFT specifies how many new elements are added (1:2, 2:4, ..., 8:256...)
377 * when all elements are used up. New elements are zeroed out.
378 * xrealloc_vector(v, SHIFT, idx) *MUST* be called with consecutive IDXs -
379 * skipping an index is a bad bug - it may miss a realloc!
380 */
381#define xrealloc_vector(vector, shift, idx) \
382 xrealloc_vector_helper((vector), (sizeof((vector)[0]) << 8) + (shift), (idx))
383void* xrealloc_vector_helper(void *vector, unsigned sizeof_and_shift, int idx) FAST_FUNC;
384char *xstrdup(const char *s) FAST_FUNC RETURNS_MALLOC;
385char *xstrndup(const char *s, int n) FAST_FUNC RETURNS_MALLOC;
386void *xmemdup(const void *s, int n) FAST_FUNC RETURNS_MALLOC;
387
388
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +0000389//TODO: supply a pointer to char[11] buffer (avoid statics)?
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000390extern const char *bb_mode_string(mode_t mode) FAST_FUNC;
Denys Vlasenkof282c6b2011-12-18 03:27:46 +0100391extern int is_directory(const char *name, int followLinks) FAST_FUNC;
Denys Vlasenko877dedb2016-05-27 00:46:38 +0200392enum { /* cp.c, mv.c, install.c depend on these values. CAREFUL when changing them! */
Denys Vlasenkoa40f0622010-01-15 22:05:07 +0100393 FILEUTILS_PRESERVE_STATUS = 1 << 0, /* -p */
394 FILEUTILS_DEREFERENCE = 1 << 1, /* !-d */
395 FILEUTILS_RECUR = 1 << 2, /* -R */
396 FILEUTILS_FORCE = 1 << 3, /* -f */
397 FILEUTILS_INTERACTIVE = 1 << 4, /* -i */
398 FILEUTILS_MAKE_HARDLINK = 1 << 5, /* -l */
399 FILEUTILS_MAKE_SOFTLINK = 1 << 6, /* -s */
400 FILEUTILS_DEREF_SOFTLINK = 1 << 7, /* -L */
401 FILEUTILS_DEREFERENCE_L0 = 1 << 8, /* -H */
Denys Vlasenko877dedb2016-05-27 00:46:38 +0200402 /* -a = -pdR (mapped in cp.c) */
403 /* -r = -dR (mapped in cp.c) */
404 /* -P = -d (mapped in cp.c) */
405 FILEUTILS_VERBOSE = (1 << 12) * ENABLE_FEATURE_VERBOSE, /* -v */
406 FILEUTILS_UPDATE = 1 << 13, /* -u */
Aaro Koskinend15d7a02018-02-01 09:29:05 +0100407 FILEUTILS_NO_TARGET_DIR = 1 << 14, /* -T */
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000408#if ENABLE_SELINUX
Aaro Koskinend15d7a02018-02-01 09:29:05 +0100409 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 1 << 15, /* -c */
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000410#endif
Aaro Koskinend15d7a02018-02-01 09:29:05 +0100411 FILEUTILS_RMDEST = 1 << (16 - !ENABLE_SELINUX), /* --remove-destination */
Denys Vlasenko877dedb2016-05-27 00:46:38 +0200412 /*
413 * Hole. cp may have some bits set here,
414 * they should not affect remove_file()/copy_file()
415 */
416#if ENABLE_SELINUX
417 FILEUTILS_SET_SECURITY_CONTEXT = 1 << 30,
418#endif
419 FILEUTILS_IGNORE_CHMOD_ERR = 1 << 31,
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000420};
Aaro Koskinend15d7a02018-02-01 09:29:05 +0100421#define FILEUTILS_CP_OPTSTR "pdRfilsLHarPvuT" IF_SELINUX("c")
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000422extern int remove_file(const char *path, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000423/* NB: without FILEUTILS_RECUR in flags, it will basically "cat"
424 * the source, not copy (unless "source" is a directory).
425 * This makes "cp /dev/null file" and "install /dev/null file" (!!!)
426 * work coreutils-compatibly. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000427extern int copy_file(const char *source, const char *dest, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000428
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000429enum {
Denis Vlasenkod166f832007-07-05 00:12:55 +0000430 ACTION_RECURSE = (1 << 0),
431 ACTION_FOLLOWLINKS = (1 << 1),
432 ACTION_FOLLOWLINKS_L0 = (1 << 2),
433 ACTION_DEPTHFIRST = (1 << 3),
434 /*ACTION_REVERSE = (1 << 4), - unused */
Denis Vlasenko6e69e422008-07-27 12:10:07 +0000435 ACTION_QUIET = (1 << 5),
Denys Vlasenko8f7a6d22009-09-29 11:07:04 +0200436 ACTION_DANGLING_OK = (1 << 6),
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000437};
Denys Vlasenko8f7a6d22009-09-29 11:07:04 +0200438typedef uint8_t recurse_flags_t;
Bernhard Reutner-Fischer3e816c12007-03-29 10:30:50 +0000439extern int recursive_action(const char *fileName, unsigned flags,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000440 int FAST_FUNC (*fileAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
441 int FAST_FUNC (*dirAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
442 void* userData, unsigned depth) FAST_FUNC;
443extern int device_open(const char *device, int mode) FAST_FUNC;
Denis Vlasenko85c24712008-03-17 09:04:04 +0000444enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000445extern int xgetpty(char *line) FAST_FUNC;
Denis Vlasenko2afd5ab2008-08-05 23:32:27 +0000446extern int get_console_fd_or_die(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000447extern void console_make_active(int fd, const int vt_num) FAST_FUNC;
448extern char *find_block_device(const char *path) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000449/* bb_copyfd_XX print read/write errors and return -1 if they occur */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000450extern off_t bb_copyfd_eof(int fd1, int fd2) FAST_FUNC;
451extern off_t bb_copyfd_size(int fd1, int fd2, off_t size) FAST_FUNC;
452extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000453/* "short" copy can be detected by return value < size */
454/* this helper yells "short read!" if param is not -1 */
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000455extern void complain_copyfd_and_die(off_t sz) NORETURN FAST_FUNC;
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +0200456
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000457extern char bb_process_escape_sequence(const char **ptr) FAST_FUNC;
Denys Vlasenko53600592010-10-23 21:06:06 +0200458char* strcpy_and_process_escape_sequences(char *dst, const char *src) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000459/* xxxx_strip version can modify its parameter:
460 * "/" -> "/"
461 * "abc" -> "abc"
462 * "abc/def" -> "def"
463 * "abc/def/" -> "def" !!
464 */
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +0200465char *bb_get_last_path_component_strip(char *path) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000466/* "abc/def/" -> "" and it never modifies 'path' */
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +0200467char *bb_get_last_path_component_nostrip(const char *path) FAST_FUNC;
468/* Simpler version: does not special case "/" string */
469const char *bb_basename(const char *name) FAST_FUNC;
470/* NB: can violate const-ness (similarly to strchr) */
471char *last_char_is(const char *s, int c) FAST_FUNC;
Denys Vlasenko1961aea2013-02-26 00:36:53 +0100472const char* endofname(const char *name) FAST_FUNC;
Denys Vlasenko8dff01d2015-03-12 17:48:34 +0100473char *is_prefixed_with(const char *string, const char *key) FAST_FUNC;
Bartosz Golaszewski7448b512015-08-25 16:36:43 +0200474char *is_suffixed_with(const char *string, const char *key) FAST_FUNC;
Denis Vlasenkocad04ef2007-03-25 23:21:05 +0000475
Denys Vlasenkod6e76722014-09-22 21:14:02 +0200476int ndelay_on(int fd) FAST_FUNC;
477int ndelay_off(int fd) FAST_FUNC;
Denys Vlasenkoe9a40e32011-01-24 00:29:55 +0100478void close_on_exec_on(int fd) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000479void xdup2(int, int) FAST_FUNC;
480void xmove_fd(int, int) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000481
482
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000483DIR *xopendir(const char *path) FAST_FUNC;
484DIR *warn_opendir(const char *path) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000485
Jérémie Koenigfbedacf2010-03-26 19:08:53 +0100486char *xmalloc_realpath(const char *path) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100487char *xmalloc_readlink(const char *path) FAST_FUNC RETURNS_MALLOC;
488char *xmalloc_readlink_or_warn(const char *path) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkob57eee82009-11-04 17:54:17 +0100489/* !RETURNS_MALLOC: it's a realloc-like function */
490char *xrealloc_getcwd_or_warn(char *cwd) FAST_FUNC;
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000491
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100492char *xmalloc_follow_symlinks(const char *path) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko473dae02007-04-11 07:04:23 +0000493
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000494
Denis Vlasenko33196372008-02-23 01:25:38 +0000495enum {
Denis Vlasenkocf7cf622008-03-19 19:38:46 +0000496 /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
Denis Vlasenko33196372008-02-23 01:25:38 +0000497 * otherwise would kill us, except for those resulting from bugs:
498 * SIGSEGV, SIGILL, SIGFPE.
499 * Other fatal signals not included (TODO?):
500 * SIGBUS Bus error (bad memory access)
501 * SIGPOLL Pollable event. Synonym of SIGIO
502 * SIGPROF Profiling timer expired
503 * SIGSYS Bad argument to routine
504 * SIGTRAP Trace/breakpoint trap
Denis Vlasenkod943af02008-03-30 15:56:38 +0000505 *
506 * The only known arch with some of these sigs not fitting
507 * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
508 * Dance around with long long to guard against that...
Denis Vlasenko33196372008-02-23 01:25:38 +0000509 */
Denis Vlasenkod943af02008-03-30 15:56:38 +0000510 BB_FATAL_SIGS = (int)(0
511 + (1LL << SIGHUP)
512 + (1LL << SIGINT)
513 + (1LL << SIGTERM)
514 + (1LL << SIGPIPE) // Write to pipe with no readers
515 + (1LL << SIGQUIT) // Quit from keyboard
516 + (1LL << SIGABRT) // Abort signal from abort(3)
517 + (1LL << SIGALRM) // Timer signal from alarm(2)
518 + (1LL << SIGVTALRM) // Virtual alarm clock
519 + (1LL << SIGXCPU) // CPU time limit exceeded
520 + (1LL << SIGXFSZ) // File size limit exceeded
521 + (1LL << SIGUSR1) // Yes kids, these are also fatal!
522 + (1LL << SIGUSR2)
523 + 0),
Denis Vlasenko33196372008-02-23 01:25:38 +0000524};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000525void bb_signals(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko25591c32008-02-16 22:58:56 +0000526/* Unlike signal() and bb_signals, sets handler with sigaction()
527 * and in a way that while signal handler is run, no other signals
Denis Vlasenkocab28aa2009-01-31 01:02:07 +0000528 * will be blocked; syscalls will not be restarted: */
529void bb_signals_recursive_norestart(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000530/* syscalls like read() will be interrupted with EINTR: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000531void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000532/* syscalls like read() won't be interrupted (though select/poll will be): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000533void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
534void wait_for_any_sig(void) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000535void kill_myself_with_sig(int sig) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000536void sig_block(int sig) FAST_FUNC;
537void sig_unblock(int sig) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000538/* Will do sigaction(signum, act, NULL): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000539int sigaction_set(int sig, const struct sigaction *act) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000540/* SIG_BLOCK/SIG_UNBLOCK all signals: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000541int sigprocmask_allsigs(int how) FAST_FUNC;
Denis Vlasenko08ea11a2008-09-11 19:51:11 +0000542/* Standard handler which just records signo */
543extern smallint bb_got_signal;
544void record_signo(int signo); /* not FAST_FUNC! */
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000545
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000546
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000547void xsetgid(gid_t gid) FAST_FUNC;
548void xsetuid(uid_t uid) FAST_FUNC;
Ryan Mallon5906a5c2013-10-08 14:52:49 +0200549void xsetegid(gid_t egid) FAST_FUNC;
550void xseteuid(uid_t euid) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000551void xchdir(const char *path) FAST_FUNC;
Denys Vlasenkoc4199f22016-04-01 22:12:44 +0200552void xfchdir(int fd) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000553void xchroot(const char *path) FAST_FUNC;
554void xsetenv(const char *key, const char *value) FAST_FUNC;
Denis Vlasenko76ddc2e2008-12-30 05:05:31 +0000555void bb_unsetenv(const char *key) FAST_FUNC;
Denys Vlasenkodd8adde2010-06-24 05:00:50 +0200556void bb_unsetenv_and_free(char *key) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000557void xunlink(const char *pathname) FAST_FUNC;
558void xstat(const char *pathname, struct stat *buf) FAST_FUNC;
Denys Vlasenko8d3e2252010-08-31 12:42:06 +0200559void xfstat(int fd, struct stat *buf, const char *errmsg) FAST_FUNC;
Ryan Mallon5906a5c2013-10-08 14:52:49 +0200560int open3_or_warn(const char *pathname, int flags, int mode) FAST_FUNC;
561int open_or_warn(const char *pathname, int flags) FAST_FUNC;
562int xopen3(const char *pathname, int flags, int mode) FAST_FUNC;
Denys Vlasenkof2a8d5d2009-08-21 17:40:36 +0200563int xopen(const char *pathname, int flags) FAST_FUNC;
Bernhard Reutner-Fischera4830872009-10-26 23:27:08 +0100564int xopen_nonblocking(const char *pathname) FAST_FUNC;
Ryan Mallon5906a5c2013-10-08 14:52:49 +0200565int xopen_as_uid_gid(const char *pathname, int flags, uid_t u, gid_t g) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000566int open_or_warn_stdin(const char *pathname) FAST_FUNC;
Denys Vlasenkoe7b0a9e2010-08-22 05:39:15 +0200567int xopen_stdin(const char *pathname) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000568void xrename(const char *oldpath, const char *newpath) FAST_FUNC;
569int rename_or_warn(const char *oldpath, const char *newpath) FAST_FUNC;
570off_t xlseek(int fd, off_t offset, int whence) FAST_FUNC;
Alexander Shishkin67227372010-10-22 13:27:16 +0200571int xmkstemp(char *template) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000572off_t fdlength(int fd) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000573
Denys Vlasenko40e7d252010-02-01 23:48:27 +0100574uoff_t FAST_FUNC get_volume_size_in_bytes(int fd,
Denys Vlasenko982e87f2013-07-30 11:52:58 +0200575 const char *override,
576 unsigned override_units,
577 int extend);
Denys Vlasenko40e7d252010-02-01 23:48:27 +0100578
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000579void xpipe(int filedes[2]) FAST_FUNC;
Denis Vlasenko37188322008-02-16 13:20:56 +0000580/* In this form code with pipes is much more readable */
581struct fd_pair { int rd; int wr; };
582#define piped_pair(pair) pipe(&((pair).rd))
583#define xpiped_pair(pair) xpipe(&((pair).rd))
584
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000585/* Useful for having small structure members/global variables */
586typedef int8_t socktype_t;
587typedef int8_t family_t;
588struct BUG_too_small {
589 char BUG_socktype_t_too_small[(0
590 | SOCK_STREAM
591 | SOCK_DGRAM
592 | SOCK_RDM
593 | SOCK_SEQPACKET
594 | SOCK_RAW
595 ) <= 127 ? 1 : -1];
596 char BUG_family_t_too_small[(0
597 | AF_UNSPEC
598 | AF_INET
599 | AF_INET6
600 | AF_UNIX
Mike Frysinger9412ec72008-02-07 22:41:33 +0000601#ifdef AF_PACKET
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000602 | AF_PACKET
Mike Frysinger9412ec72008-02-07 22:41:33 +0000603#endif
604#ifdef AF_NETLINK
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000605 | AF_NETLINK
Mike Frysinger9412ec72008-02-07 22:41:33 +0000606#endif
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000607 /* | AF_DECnet */
608 /* | AF_IPX */
609 ) <= 127 ? 1 : -1];
610};
611
612
Denys Vlasenkodc698bb2010-01-09 19:10:49 +0100613void parse_datestr(const char *date_str, struct tm *ptm) FAST_FUNC;
614time_t validate_tm_time(const char *date_str, struct tm *ptm) FAST_FUNC;
Denys Vlasenko8f2cb7a2013-03-29 12:30:33 +0100615char *strftime_HHMMSS(char *buf, unsigned len, time_t *tp) FAST_FUNC;
616char *strftime_YYYYMMDDHHMMSS(char *buf, unsigned len, time_t *tp) FAST_FUNC;
Denys Vlasenko73b71f32009-07-18 03:40:35 +0200617
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000618int xsocket(int domain, int type, int protocol) FAST_FUNC;
619void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen) FAST_FUNC;
620void xlisten(int s, int backlog) FAST_FUNC;
621void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen) FAST_FUNC;
Denis Vlasenkodbe6e662007-08-14 16:43:01 +0000622ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000623 socklen_t tolen) FAST_FUNC;
Denys Vlasenkoc52cbea2015-08-24 19:48:03 +0200624
625int setsockopt_int(int fd, int level, int optname, int optval) FAST_FUNC;
626int setsockopt_1(int fd, int level, int optname) FAST_FUNC;
627int setsockopt_SOL_SOCKET_int(int fd, int optname, int optval) FAST_FUNC;
628int setsockopt_SOL_SOCKET_1(int fd, int optname) FAST_FUNC;
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000629/* SO_REUSEADDR allows a server to rebind to an address that is already
630 * "in use" by old connections to e.g. previous server instance which is
631 * killed or crashed. Without it bind will fail until all such connections
632 * time out. Linux does not allow multiple live binds on same ip:port
633 * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
634 * Turn it on before you call bind(). */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000635void setsockopt_reuseaddr(int fd) FAST_FUNC; /* On Linux this never fails. */
Denys Vlasenkoc52cbea2015-08-24 19:48:03 +0200636int setsockopt_keepalive(int fd) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000637int setsockopt_broadcast(int fd) FAST_FUNC;
Denis Vlasenkoe5373852008-12-10 11:12:16 +0000638int setsockopt_bindtodevice(int fd, const char *iface) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000639/* NB: returns port in host byte order */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000640unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port) FAST_FUNC;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000641typedef struct len_and_sockaddr {
Denis Vlasenko0850cda2007-02-07 23:20:32 +0000642 socklen_t len;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000643 union {
644 struct sockaddr sa;
645 struct sockaddr_in sin;
646#if ENABLE_FEATURE_IPV6
647 struct sockaddr_in6 sin6;
648#endif
Bernhard Reutner-Fischer8c69afd2008-01-29 10:33:34 +0000649 } u;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000650} len_and_sockaddr;
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000651enum {
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000652 LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000653 LSA_SIZEOF_SA = sizeof(
654 union {
655 struct sockaddr sa;
656 struct sockaddr_in sin;
657#if ENABLE_FEATURE_IPV6
658 struct sockaddr_in6 sin6;
659#endif
660 }
661 )
662};
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000663/* Create stream socket, and allocate suitable lsa.
664 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
Denis Vlasenkobeffd432007-09-05 11:30:34 +0000665 * af == AF_UNSPEC will result in trying to create IPv6 socket,
Denys Vlasenkob1278a32009-11-24 16:03:47 +0100666 * and if kernel doesn't support it, fall back to IPv4.
667 * This is useful if you plan to bind to resulting local lsa.
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000668 */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000669int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000670int xsocket_stream(len_and_sockaddr **lsap) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000671/* Create server socket bound to bindaddr:port. bindaddr can be NULL,
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000672 * numeric IP ("N.N.N.N") or numeric IPv6 address,
673 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000674 * Only if there is no suffix, port argument is used */
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000675/* NB: these set SO_REUSEADDR before bind */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000676int create_and_bind_stream_or_die(const char *bindaddr, int port) FAST_FUNC;
677int create_and_bind_dgram_or_die(const char *bindaddr, int port) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000678/* Create client TCP socket connected to peer:port. Peer cannot be NULL.
679 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
680 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
681 * If there is no suffix, port argument is used */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000682int create_and_connect_stream_or_die(const char *peer, int port) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000683/* Connect to peer identified by lsa */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000684int xconnect_stream(const len_and_sockaddr *lsa) FAST_FUNC;
Denis Vlasenko73c571a2009-03-09 00:12:37 +0000685/* Get local address of bound or accepted socket */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100686len_and_sockaddr *get_sock_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkof6916db2010-04-06 17:43:29 +0200687/* Get remote address of connected or accepted socket */
688len_and_sockaddr *get_peer_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000689/* Return malloc'ed len_and_sockaddr with socket address of host:port
690 * Currently will return IPv4 or IPv6 sockaddrs only
691 * (depending on host), but in theory nothing prevents e.g.
Denis Vlasenko5870ad92007-02-04 02:39:55 +0000692 * UNIX socket address being returned, IPX sockaddr etc...
693 * On error does bb_error_msg and returns NULL */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100694len_and_sockaddr* host2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000695/* Version which dies on error */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100696len_and_sockaddr* xhost2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
697len_and_sockaddr* xdotted2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000698/* Same, useful if you want to force family (e.g. IPv6) */
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000699#if !ENABLE_FEATURE_IPV6
700#define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
701#define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
702#else
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100703len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
704len_and_sockaddr* xhost_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000705#endif
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000706/* Assign sin[6]_port member if the socket is an AF_INET[6] one,
Denis Vlasenko85629f02007-01-22 09:36:41 +0000707 * otherwise no-op. Useful for ftp.
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000708 * NB: does NOT do htons() internally, just direct assignment. */
Denys Vlasenkoca183112011-04-07 17:52:20 +0200709void set_nport(struct sockaddr *sa, unsigned port) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000710/* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000711int get_nport(const struct sockaddr *sa) FAST_FUNC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000712/* Reverse DNS. Returns NULL on failure. */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100713char* xmalloc_sockaddr2host(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000714/* This one doesn't append :PORTNUM */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100715char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000716/* This one also doesn't fall back to dotted IP (returns NULL) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100717char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko448f0242007-01-22 22:43:05 +0000718/* inet_[ap]ton on steroids */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100719char* xmalloc_sockaddr2dotted(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
720char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000721// "old" (ipv4 only) API
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000722// users: traceroute.c hostname.c - use _list_ of all IPs
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000723struct hostent *xgethostbyname(const char *name) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000724// Also mount.c and inetd.c are using gethostbyname(),
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000725// + inet_common.c has additional IPv4-only stuff
Denis Vlasenkoc8717cd2006-11-22 16:10:39 +0000726
Denys Vlasenko49ecee02017-01-24 16:00:54 +0100727
728#define TLS_MAX_MAC_SIZE 32
729#define TLS_MAX_KEY_SIZE 32
Denys Vlasenko9a647c32017-01-23 01:08:16 +0100730struct tls_handshake_data; /* opaque */
731typedef struct tls_state {
Denys Vlasenko49ecee02017-01-24 16:00:54 +0100732 int ofd;
733 int ifd;
Denys Vlasenko9a647c32017-01-23 01:08:16 +0100734
Denys Vlasenko89193f92017-01-24 18:08:07 +0100735 unsigned min_encrypted_len_on_read;
Denys Vlasenko49ecee02017-01-24 16:00:54 +0100736 uint16_t cipher_id;
737 uint8_t encrypt_on_write;
738 unsigned MAC_size;
739 unsigned key_size;
Denys Vlasenko9a647c32017-01-23 01:08:16 +0100740
741 uint8_t *outbuf;
742 int outbuf_size;
743
744 int inbuf_size;
745 int ofs_to_buffered;
746 int buffered_size;
747 uint8_t *inbuf;
748
749 struct tls_handshake_data *hsd;
750
751 // RFC 5246
752 // sequence number
753 // Each connection state contains a sequence number, which is
754 // maintained separately for read and write states. The sequence
755 // number MUST be set to zero whenever a connection state is made the
756 // active state. Sequence numbers are of type uint64 and may not
757 // exceed 2^64-1.
758 /*uint64_t read_seq64_be;*/
759 uint64_t write_seq64_be;
760
Denys Vlasenko49ecee02017-01-24 16:00:54 +0100761 uint8_t *client_write_key;
762 uint8_t *server_write_key;
763 uint8_t client_write_MAC_key[TLS_MAX_MAC_SIZE];
764 uint8_t server_write_MAC_k__[TLS_MAX_MAC_SIZE];
765 uint8_t client_write_k__[TLS_MAX_KEY_SIZE];
766 uint8_t server_write_k__[TLS_MAX_KEY_SIZE];
Denys Vlasenko9a647c32017-01-23 01:08:16 +0100767} tls_state_t;
768
769static inline tls_state_t *new_tls_state(void)
770{
771 tls_state_t *tls = xzalloc(sizeof(*tls));
772 return tls;
773}
774void tls_handshake(tls_state_t *tls, const char *sni) FAST_FUNC;
Denys Vlasenko403f2992018-02-06 15:15:08 +0100775#define TLSLOOP_EXIT_ON_LOCAL_EOF (1 << 0)
776void tls_run_copy_loop(tls_state_t *tls, unsigned flags) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000777
Denys Vlasenko49ecee02017-01-24 16:00:54 +0100778
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000779void socket_want_pktinfo(int fd) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000780ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000781 const struct sockaddr *to,
782 const struct sockaddr *from,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000783 socklen_t tolen) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000784ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000785 struct sockaddr *from,
786 struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000787 socklen_t sa_size) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000788
Baruch Siache8f36332011-09-07 17:52:37 +0200789uint16_t inet_cksum(uint16_t *addr, int len) FAST_FUNC;
Denys Vlasenko1783ffa2018-02-06 15:48:12 +0100790int parse_pasv_epsv(char *buf) FAST_FUNC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100791
Denys Vlasenkod4e4fdb2017-07-03 21:31:16 +0200792/* 0 if argv[0] is NULL: */
793unsigned string_array_len(char **argv) FAST_FUNC;
Denis Vlasenko0f293b92008-07-22 20:16:55 +0000794void overlapping_strcpy(char *dst, const char *src) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000795char *safe_strncpy(char *dst, const char *src, size_t size) FAST_FUNC;
Denis Vlasenko360d9662008-12-02 18:18:50 +0000796char *strncpy_IFNAMSIZ(char *dst, const char *src) FAST_FUNC;
Denys Vlasenko6f068902014-02-27 11:17:06 +0100797unsigned count_strstr(const char *str, const char *sub) FAST_FUNC;
798char *xmalloc_substitute_string(const char *src, int count, const char *sub, const char *repl) FAST_FUNC;
Denis Vlasenko4daad902007-09-27 10:20:47 +0000799/* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
Denis Vlasenko7c654ae2007-09-27 10:26:59 +0000800 * But potentially slow, don't use in one-billion-times loops */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000801int bb_putchar(int ch) FAST_FUNC;
Denys Vlasenko19ced5c2010-06-06 21:53:09 +0200802/* Note: does not use stdio, writes to fd 2 directly */
803int bb_putchar_stderr(char ch) FAST_FUNC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100804char *xasprintf(const char *format, ...) __attribute__ ((format(printf, 1, 2))) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkoe52da552015-10-09 17:59:56 +0200805char *auto_string(char *str) FAST_FUNC;
Denis Vlasenko9f739442006-12-16 23:49:13 +0000806// gcc-4.1.1 still isn't good enough at optimizing it
807// (+200 bytes compared to macro)
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000808//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000809//int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000810//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000811//int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000812#define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
Denis Vlasenko9f739442006-12-16 23:49:13 +0000813#define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000814#define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
Denis Vlasenkobf66fbc2006-12-21 13:23:14 +0000815#define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
Denis Vlasenko16abcd92007-04-13 23:59:52 +0000816#define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000817
Denys Vlasenkod8528b82010-01-31 05:15:38 +0100818typedef struct uni_stat_t {
819 unsigned byte_count;
820 unsigned unicode_count;
821 unsigned unicode_width;
822} uni_stat_t;
823/* Returns a string with unprintable chars replaced by '?' or
824 * SUBST_WCHAR. This function is unicode-aware. */
825const char* FAST_FUNC printable_string(uni_stat_t *stats, const char *str);
826/* Prints unprintable char ch as ^C or M-c to file
827 * (M-c is used only if ch is ORed with PRINTABLE_META),
828 * else it is printed as-is (except for ch = 0x9b) */
829enum { PRINTABLE_META = 0x100 };
830void fputc_printable(int ch, FILE *file) FAST_FUNC;
Bartosz Golaszewski79c618c2013-07-30 06:29:42 +0200831/* Return a string that is the printable representation of character ch.
832 * Buffer must hold at least four characters. */
Denys Vlasenkobfa6ed12013-07-30 11:41:58 +0200833enum {
834 VISIBLE_ENDLINE = 1 << 0,
835 VISIBLE_SHOW_TABS = 1 << 1,
836};
Bartosz Golaszewski79c618c2013-07-30 06:29:42 +0200837void visible(unsigned ch, char *buf, int flags) FAST_FUNC;
Denys Vlasenkod8528b82010-01-31 05:15:38 +0100838
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000839extern ssize_t safe_read(int fd, void *buf, size_t count) FAST_FUNC;
Ron Yorston61d6ae22015-04-19 10:50:25 +0100840extern ssize_t nonblock_immune_read(int fd, void *buf, size_t count) FAST_FUNC;
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000841// NB: will return short read on error, not -1,
842// if some data was read before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000843extern ssize_t full_read(int fd, void *buf, size_t count) FAST_FUNC;
844extern void xread(int fd, void *buf, size_t count) FAST_FUNC;
845extern unsigned char xread_char(int fd) FAST_FUNC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000846extern ssize_t read_close(int fd, void *buf, size_t maxsz) FAST_FUNC;
847extern ssize_t open_read_close(const char *filename, void *buf, size_t maxsz) FAST_FUNC;
Denis Vlasenko8ee649a2008-03-26 20:04:27 +0000848// Reads one line a-la fgets (but doesn't save terminating '\n').
849// Reads byte-by-byte. Useful when it is important to not read ahead.
Denis Vlasenkoe376d452008-02-20 22:23:24 +0000850// Bytes are appended to pfx (which must be malloced, or NULL).
Denys Vlasenko80c5b682011-05-08 21:21:10 +0200851extern char *xmalloc_reads(int fd, size_t *maxsz_p) FAST_FUNC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000852/* Reads block up to *maxsz_p (default: INT_MAX - 4095) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100853extern void *xmalloc_read(int fd, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000854/* Returns NULL if file can't be opened (default max size: INT_MAX - 4095) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100855extern void *xmalloc_open_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko094cc512011-01-17 14:58:27 +0100856/* Never returns NULL */
857extern void *xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko59655072012-03-06 16:23:50 +0100858
Denys Vlasenko04c14172014-11-26 15:17:59 +0100859#if defined(ARG_MAX) && (ARG_MAX >= 60*1024 || !defined(_SC_ARG_MAX))
860/* Use _constant_ maximum if: defined && (big enough || no variable one exists) */
Denys Vlasenkof92f1d02014-06-22 13:54:40 +0200861# define bb_arg_max() ((unsigned)ARG_MAX)
Denys Vlasenko04c14172014-11-26 15:17:59 +0100862#elif defined(_SC_ARG_MAX)
863/* Else use variable one (a bit more expensive) */
Denys Vlasenkof92f1d02014-06-22 13:54:40 +0200864unsigned bb_arg_max(void) FAST_FUNC;
865#else
Denys Vlasenko04c14172014-11-26 15:17:59 +0100866/* If all else fails */
Denys Vlasenkof92f1d02014-06-22 13:54:40 +0200867# define bb_arg_max() ((unsigned)(32 * 1024))
868#endif
Bartosz Golaszewski5d2e4092014-06-22 14:01:13 +0200869unsigned bb_clk_tck(void) FAST_FUNC;
Denys Vlasenkof92f1d02014-06-22 13:54:40 +0200870
Denys Vlasenko59655072012-03-06 16:23:50 +0100871#define SEAMLESS_COMPRESSION (0 \
872 || ENABLE_FEATURE_SEAMLESS_XZ \
873 || ENABLE_FEATURE_SEAMLESS_LZMA \
874 || ENABLE_FEATURE_SEAMLESS_BZ2 \
875 || ENABLE_FEATURE_SEAMLESS_GZ \
876 || ENABLE_FEATURE_SEAMLESS_Z)
877
Denys Vlasenko8a6a2f92012-03-06 16:27:48 +0100878#if SEAMLESS_COMPRESSION
Denys Vlasenko27653ad2010-05-06 14:19:19 +0000879/* Autodetects gzip/bzip2 formats. fd may be in the middle of the file! */
Denys Vlasenko0cf64c82017-08-10 10:35:08 +0200880int setup_unzip_on_fd(int fd, int fail_if_not_compressed) FAST_FUNC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000881/* Autodetects .gz etc */
Denys Vlasenko640ce3d2014-02-02 02:06:38 +0100882extern int open_zipped(const char *fname, int fail_if_not_compressed) FAST_FUNC;
Denys Vlasenkob4c11c12014-12-07 00:44:00 +0100883extern void *xmalloc_open_zipped_read_close(const char *fname, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko8a6a2f92012-03-06 16:27:48 +0100884#else
885# define setup_unzip_on_fd(...) (0)
Denys Vlasenko640ce3d2014-02-02 02:06:38 +0100886# define open_zipped(fname, fail_if_not_compressed) open((fname), O_RDONLY);
Denys Vlasenkob4c11c12014-12-07 00:44:00 +0100887# define xmalloc_open_zipped_read_close(fname, maxsz_p) xmalloc_open_read_close((fname), (maxsz_p))
Denys Vlasenko8a6a2f92012-03-06 16:27:48 +0100888#endif
Denys Vlasenko0cf64c82017-08-10 10:35:08 +0200889/* lzma has no signature, need a little helper. NB: exist only for ENABLE_FEATURE_SEAMLESS_LZMA=y */
890void setup_lzma_on_fd(int fd) FAST_FUNC;
Denis Vlasenkoea620772006-10-14 02:23:43 +0000891
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000892extern ssize_t safe_write(int fd, const void *buf, size_t count) FAST_FUNC;
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000893// NB: will return short write on error, not -1,
894// if some data was written before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000895extern ssize_t full_write(int fd, const void *buf, size_t count) FAST_FUNC;
896extern void xwrite(int fd, const void *buf, size_t count) FAST_FUNC;
Denis Vlasenko73c571a2009-03-09 00:12:37 +0000897extern void xwrite_str(int fd, const char *str) FAST_FUNC;
Denys Vlasenko729ecb82010-06-07 14:14:26 +0200898extern ssize_t full_write1_str(const char *str) FAST_FUNC;
899extern ssize_t full_write2_str(const char *str) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000900extern void xopen_xwrite_close(const char* file, const char *str) FAST_FUNC;
Denis Vlasenkoea620772006-10-14 02:23:43 +0000901
Denys Vlasenkodcd27ab2009-10-05 03:03:07 +0200902/* Close fd, but check for failures (some types of write errors) */
903extern void xclose(int fd) FAST_FUNC;
904
Denis Vlasenko1de08302006-10-26 23:32:43 +0000905/* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000906extern void xprint_and_close_file(FILE *file) FAST_FUNC;
Denis Vlasenko2132e022008-07-15 10:33:12 +0000907
Denys Vlasenkoa1a44832011-06-17 03:37:43 +0200908/* Reads a line from a text file, up to a newline or NUL byte, inclusive.
909 * Returns malloc'ed char*. If end is NULL '\n' isn't considered
910 * end of line. If end isn't NULL, length of the chunk is stored in it.
911 * Returns NULL if EOF/error.
912 */
Denis Vlasenko2132e022008-07-15 10:33:12 +0000913extern char *bb_get_chunk_from_file(FILE *file, int *end) FAST_FUNC;
Denis Vlasenkoabee3d02007-12-26 20:44:45 +0000914/* Reads up to (and including) TERMINATING_STRING: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100915extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000916/* Same, with limited max size, and returns the length (excluding NUL): */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100917extern char *xmalloc_fgets_str_len(FILE *file, const char *terminating_string, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000918/* Chops off TERMINATING_STRING from the end: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100919extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000920/* Reads up to (and including) "\n" or NUL byte: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100921extern char *xmalloc_fgets(FILE *file) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000922/* Chops off '\n' from the end, unlike fgets: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100923extern char *xmalloc_fgetline(FILE *file) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko2132e022008-07-15 10:33:12 +0000924/* Same, but doesn't try to conserve space (may have some slack after the end) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100925/* extern char *xmalloc_fgetline_fast(FILE *file) FAST_FUNC RETURNS_MALLOC; */
Denis Vlasenko2132e022008-07-15 10:33:12 +0000926
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100927void die_if_ferror(FILE *file, const char *msg) FAST_FUNC;
928void die_if_ferror_stdout(void) FAST_FUNC;
929int fflush_all(void) FAST_FUNC;
930void fflush_stdout_and_exit(int retval) NORETURN FAST_FUNC;
931int fclose_if_not_stdin(FILE *file) FAST_FUNC;
932FILE* xfopen(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000933/* Prints warning to stderr and returns NULL on failure: */
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100934FILE* fopen_or_warn(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000935/* "Opens" stdin if filename is special, else just opens file: */
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100936FILE* xfopen_stdin(const char *filename) FAST_FUNC;
937FILE* fopen_or_warn_stdin(const char *filename) FAST_FUNC;
938FILE* fopen_for_read(const char *path) FAST_FUNC;
939FILE* xfopen_for_read(const char *path) FAST_FUNC;
940FILE* fopen_for_write(const char *path) FAST_FUNC;
941FILE* xfopen_for_write(const char *path) FAST_FUNC;
942FILE* xfdopen_for_read(int fd) FAST_FUNC;
943FILE* xfdopen_for_write(int fd) FAST_FUNC;
Eric Andersen8876fb22003-06-20 09:01:58 +0000944
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000945int bb_pstrcmp(const void *a, const void *b) /* not FAST_FUNC! */;
946void qsort_string_vector(char **sv, unsigned count) FAST_FUNC;
Denis Vlasenkofb290382008-03-02 12:51:26 +0000947
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000948/* Wrapper which restarts poll on EINTR or ENOMEM.
949 * On other errors complains [perror("poll")] and returns.
950 * Warning! May take (much) longer than timeout_ms to return!
951 * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000952int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms) FAST_FUNC;
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000953
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000954char *safe_gethostname(void) FAST_FUNC;
Denis Vlasenko6f1713f2008-02-25 23:23:58 +0000955
Bernhard Reutner-Fischer8b1fab22007-04-10 09:38:07 +0000956/* Convert each alpha char in str to lower-case */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000957char* str_tolower(char *str) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000958
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000959char *utoa(unsigned n) FAST_FUNC;
960char *itoa(int n) FAST_FUNC;
Denis Vlasenko10457b92007-03-27 22:01:31 +0000961/* Returns a pointer past the formatted number, does NOT null-terminate */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000962char *utoa_to_buf(unsigned n, char *buf, unsigned buflen) FAST_FUNC;
963char *itoa_to_buf(int n, char *buf, unsigned buflen) FAST_FUNC;
Denis Vlasenko56ea65c2008-01-06 03:26:53 +0000964/* Intelligent formatters of bignums */
Denys Vlasenkoa407cf72013-09-06 12:53:14 +0200965char *smart_ulltoa4(unsigned long long ul, char buf[4], const char *scale) FAST_FUNC;
966char *smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
Denys Vlasenko0bf44d02009-10-13 01:25:09 +0200967/* If block_size == 0, display size without fractional part,
968 * else display (size * block_size) with one decimal digit.
Denys Vlasenko9c3b84a2010-01-18 01:55:00 +0100969 * If display_unit == 0, show value no bigger than 1024 with suffix (K,M,G...),
Denys Vlasenko0bf44d02009-10-13 01:25:09 +0200970 * else divide by display_unit and do not use suffix. */
Denys Vlasenko9c3b84a2010-01-18 01:55:00 +0100971#define HUMAN_READABLE_MAX_WIDTH 7 /* "1024.0G" */
972#define HUMAN_READABLE_MAX_WIDTH_STR "7"
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000973//TODO: provide pointer to buf (avoid statics)?
974const char *make_human_readable_str(unsigned long long size,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000975 unsigned long block_size, unsigned long display_unit) FAST_FUNC;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000976/* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
Denys Vlasenko1f56e512011-10-19 22:40:35 +0200977char *bin2hex(char *dst, const char *src, int count) FAST_FUNC;
Denys Vlasenko48363312010-04-04 15:29:32 +0200978/* Reverse */
Denys Vlasenko1f56e512011-10-19 22:40:35 +0200979char* hex2bin(char *dst, const char *src, int count) FAST_FUNC;
Rob Landleyc5b1d4d2006-03-13 15:45:16 +0000980
Vladimir Dronnikovdb67a202009-10-15 09:24:25 +0200981/* Generate a UUID */
982void generate_uuid(uint8_t *buf) FAST_FUNC;
983
Denis Vlasenko1bab1de2007-07-27 15:30:39 +0000984/* Last element is marked by mult == 0 */
Eric Andersenaad1a882001-03-16 22:47:14 +0000985struct suffix_mult {
Denis Vlasenkof8689632007-07-27 15:06:25 +0000986 char suffix[4];
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000987 unsigned mult;
Eric Andersenaad1a882001-03-16 22:47:14 +0000988};
Denys Vlasenkoc72b43c2013-07-13 23:49:45 +0200989extern const struct suffix_mult bkm_suffixes[];
990#define km_suffixes (bkm_suffixes + 1)
Ari Sundholm88930232015-03-04 18:46:48 +0200991extern const struct suffix_mult cwbkMG_suffixes[];
Ari Sundholm911db162015-03-22 17:55:38 +0100992#define kMG_suffixes (cwbkMG_suffixes + 3)
Denys Vlasenkoe184a882016-12-12 19:56:31 +0100993extern const struct suffix_mult kmg_i_suffixes[];
Denys Vlasenkoc72b43c2013-07-13 23:49:45 +0200994
Denis Vlasenkoed836cd2006-11-25 14:44:13 +0000995#include "xatonum.h"
Denis Vlasenko13858992006-10-08 12:49:22 +0000996/* Specialized: */
Denys Vlasenko77832482010-08-12 14:14:45 +0200997
Denis Vlasenko13858992006-10-08 12:49:22 +0000998/* Using xatoi() instead of naive atoi() is not always convenient -
999 * in many places people want *non-negative* values, but store them
1000 * in signed int. Therefore we need this one:
Denys Vlasenko77832482010-08-12 14:14:45 +02001001 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc.
1002 * It should really be named xatoi_nonnegative (since it allows 0),
1003 * but that would be too long.
1004 */
1005int xatoi_positive(const char *numstr) FAST_FUNC;
1006
Denis Vlasenko13858992006-10-08 12:49:22 +00001007/* Useful for reading port numbers */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001008uint16_t xatou16(const char *numstr) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001009
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001010
Eric Andersenaad1a882001-03-16 22:47:14 +00001011/* These parse entries in /etc/passwd and /etc/group. This is desirable
1012 * for BusyBox since we want to avoid using the glibc NSS stuff, which
Bernhard Reutner-Fischerd5bd1372005-09-20 21:06:17 +00001013 * increases target size and is often not needed on embedded systems. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001014long xuname2uid(const char *name) FAST_FUNC;
1015long xgroup2gid(const char *name) FAST_FUNC;
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +00001016/* wrapper: allows string to contain numeric uid or gid */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001017unsigned long get_ug_id(const char *s, long FAST_FUNC (*xname2id)(const char *)) FAST_FUNC;
Denis Vlasenkode59c0f2006-10-05 22:50:22 +00001018struct bb_uidgid_t {
Denis Vlasenko150f4022007-01-13 21:06:21 +00001019 uid_t uid;
1020 gid_t gid;
Denis Vlasenkode59c0f2006-10-05 22:50:22 +00001021};
Denys Vlasenko526d8582015-10-19 04:27:17 +02001022/* always sets uid and gid; returns 0 on failure */
1023int get_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
1024/* always sets uid and gid; exits on failure */
Bernhard Reutner-Fischerd73cbd32008-07-21 14:41:33 +00001025void xget_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
Denis Vlasenkocce38582007-02-26 22:47:42 +00001026/* chown-like handling of "user[:[group]" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001027void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group) FAST_FUNC;
Denis Vlasenkod7a805e2008-12-03 19:05:55 +00001028struct passwd* xgetpwnam(const char *name) FAST_FUNC;
Denis Vlasenko15437e32008-12-05 16:23:06 +00001029struct group* xgetgrnam(const char *name) FAST_FUNC;
Denis Vlasenko0c68a872008-12-02 22:56:59 +00001030struct passwd* xgetpwuid(uid_t uid) FAST_FUNC;
1031struct group* xgetgrgid(gid_t gid) FAST_FUNC;
1032char* xuid2uname(uid_t uid) FAST_FUNC;
1033char* xgid2group(gid_t gid) FAST_FUNC;
1034char* uid2uname(uid_t uid) FAST_FUNC;
1035char* gid2group(gid_t gid) FAST_FUNC;
Denys Vlasenko7d65abe2011-03-01 16:27:13 +01001036char* uid2uname_utoa(uid_t uid) FAST_FUNC;
1037char* gid2group_utoa(gid_t gid) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +00001038/* versions which cache results (useful for ps, ls etc) */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001039const char* get_cached_username(uid_t uid) FAST_FUNC;
1040const char* get_cached_groupname(gid_t gid) FAST_FUNC;
1041void clear_username_cache(void) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +00001042/* internally usernames are saved in fixed-sized char[] buffers */
Denys Vlasenko7d65abe2011-03-01 16:27:13 +01001043enum { USERNAME_MAX_SIZE = 32 - sizeof(uid_t) };
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +00001044#if ENABLE_FEATURE_CHECK_NAMES
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001045void die_if_bad_username(const char* name) FAST_FUNC;
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +00001046#else
1047#define die_if_bad_username(name) ((void)(name))
1048#endif
Denys Vlasenkoa8cf9c52017-07-04 18:49:24 +02001049/*
1050 * Returns (-1) terminated malloced result of getgroups().
1051 * Reallocs group_array (useful for repeated calls).
1052 * ngroups is an initial size of array. It is rounded up to 32 for realloc.
1053 * ngroups is updated on return.
1054 * ngroups can be NULL: bb_getgroups(NULL, NULL) is valid usage.
1055 * Dies on errors (on Linux, only xrealloc can cause this, not internal getgroups call).
1056 */
1057gid_t *bb_getgroups(int *ngroups, gid_t *group_array) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001058
Denys Vlasenko37f5bef2010-04-05 03:18:40 +02001059#if ENABLE_FEATURE_UTMP
Denys Vlasenko3a416112010-04-05 22:10:38 +02001060void FAST_FUNC write_new_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
1061void FAST_FUNC update_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
Denys Vlasenkoda921262015-01-05 15:37:58 +01001062void FAST_FUNC update_utmp_DEAD_PROCESS(pid_t pid);
Denys Vlasenko37f5bef2010-04-05 03:18:40 +02001063#else
Denys Vlasenko3a416112010-04-05 22:10:38 +02001064# define write_new_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
1065# define update_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
Denys Vlasenkoda921262015-01-05 15:37:58 +01001066# define update_utmp_DEAD_PROCESS(pid) ((void)0)
Denys Vlasenko37f5bef2010-04-05 03:18:40 +02001067#endif
1068
Denys Vlasenkob72baeb2011-02-02 18:38:57 +01001069
Denys Vlasenkoe765b5a2014-05-02 17:15:58 +02001070int file_is_executable(const char *name) FAST_FUNC;
1071char *find_executable(const char *filename, char **PATHp) FAST_FUNC;
1072int executable_exists(const char *filename) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001073
Denis Vlasenko7e0fbf92007-09-04 19:33:22 +00001074/* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
1075 * but it may exec busybox and call applet instead of searching PATH.
1076 */
Denis Vlasenko80d14be2007-04-10 23:03:30 +00001077#if ENABLE_FEATURE_PREFER_APPLETS
Denys Vlasenkoc71b4692011-02-02 03:28:56 +01001078int BB_EXECVP(const char *file, char *const argv[]) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001079#define BB_EXECLP(prog,cmd,...) \
Denys Vlasenkoc71b4692011-02-02 03:28:56 +01001080 do { \
1081 if (find_applet_by_name(prog) >= 0) \
1082 execlp(bb_busybox_exec_path, cmd, __VA_ARGS__); \
1083 execlp(prog, cmd, __VA_ARGS__); \
1084 } while (0)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001085#else
1086#define BB_EXECVP(prog,cmd) execvp(prog,cmd)
Denys Vlasenkoc71b4692011-02-02 03:28:56 +01001087#define BB_EXECLP(prog,cmd,...) execlp(prog,cmd,__VA_ARGS__)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001088#endif
Denys Vlasenko82203992016-04-02 18:06:24 +02001089void BB_EXECVP_or_die(char **argv) NORETURN FAST_FUNC;
1090void exec_prog_or_SHELL(char **argv) NORETURN FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001091
Denys Vlasenko82203992016-04-02 18:06:24 +02001092/* xvfork() can't be a _function_, return after vfork in child mangles stack
Pascal Bellard926031b2010-07-04 15:32:38 +02001093 * in the parent. It must be a macro. */
1094#define xvfork() \
1095({ \
1096 pid_t bb__xvfork_pid = vfork(); \
1097 if (bb__xvfork_pid < 0) \
1098 bb_perror_msg_and_die("vfork"); \
1099 bb__xvfork_pid; \
1100})
1101#if BB_MMU
1102pid_t xfork(void) FAST_FUNC;
1103#endif
Denys Vlasenko82203992016-04-02 18:06:24 +02001104void xvfork_parent_waits_and_exits(void) FAST_FUNC;
Pascal Bellard926031b2010-07-04 15:32:38 +02001105
Denys Vlasenko8531d762010-03-18 22:44:00 +01001106/* NOMMU friendy fork+exec: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001107pid_t spawn(char **argv) FAST_FUNC;
1108pid_t xspawn(char **argv) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +00001109
Denis Vlasenko3854c5d2008-11-06 22:39:57 +00001110pid_t safe_waitpid(pid_t pid, int *wstat, int options) FAST_FUNC;
Denys Vlasenko8531d762010-03-18 22:44:00 +01001111pid_t wait_any_nohang(int *wstat) FAST_FUNC;
1112/* wait4pid: unlike waitpid, waits ONLY for one process.
1113 * Returns sig + 0x180 if child is killed by signal.
Denis Vlasenkocd7001f2007-04-09 21:32:30 +00001114 * It's safe to pass negative 'pids' from failed [v]fork -
Denis Vlasenko473dae02007-04-11 07:04:23 +00001115 * wait4pid will return -1 (and will not clobber [v]fork's errno).
Denis Vlasenkocd7001f2007-04-09 21:32:30 +00001116 * IOW: rc = wait4pid(spawn(argv));
1117 * if (rc < 0) bb_perror_msg("%s", argv[0]);
Denys Vlasenko8531d762010-03-18 22:44:00 +01001118 * if (rc > 0) bb_error_msg("exit code: %d", rc & 0xff);
Denis Vlasenkocd7001f2007-04-09 21:32:30 +00001119 */
Denis Vlasenko3854c5d2008-11-06 22:39:57 +00001120int wait4pid(pid_t pid) FAST_FUNC;
Denys Vlasenkoc4199f22016-04-01 22:12:44 +02001121int wait_for_exitstatus(pid_t pid) FAST_FUNC;
Denys Vlasenko9967c992017-01-26 01:13:58 +01001122/************************************************************************/
1123/* spawn_and_wait/run_nofork_applet/run_applet_no_and_exit need to work */
1124/* carefully together to reinit some global state while not disturbing */
1125/* other. Be careful if you change them. Consult docs/nofork_noexec.txt */
1126/************************************************************************/
Denys Vlasenko8531d762010-03-18 22:44:00 +01001127/* Same as wait4pid(spawn(argv)), but with NOFORK/NOEXEC if configured: */
Denys Vlasenko8f24f982009-06-07 16:02:00 +02001128int spawn_and_wait(char **argv) FAST_FUNC;
Denis Vlasenko18e19f22007-04-28 16:43:18 +00001129/* Does NOT check that applet is NOFORK, just blindly runs it */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001130int run_nofork_applet(int applet_no, char **argv) FAST_FUNC;
Denys Vlasenko80e8e3c2017-08-07 19:24:57 +02001131void run_noexec_applet_and_exit(int a, const char *name, char **argv) NORETURN FAST_FUNC;
Denys Vlasenko9967c992017-01-26 01:13:58 +01001132#ifndef BUILD_INDIVIDUAL
Denys Vlasenko80e8e3c2017-08-07 19:24:57 +02001133int find_applet_by_name(const char *name) FAST_FUNC;
1134void run_applet_no_and_exit(int a, const char *name, char **argv) NORETURN FAST_FUNC;
Denys Vlasenko9967c992017-01-26 01:13:58 +01001135#endif
Denys Vlasenkof2cf1cc2017-08-07 18:45:33 +02001136#if defined(__linux__)
1137void set_task_comm(const char *comm) FAST_FUNC;
1138#else
1139# define set_task_comm(name) ((void)0)
1140#endif
Denis Vlasenkocd7001f2007-04-09 21:32:30 +00001141
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001142/* Helpers for daemonization.
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001143 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001144 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001145 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001146 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
1147 * rexec's itself on NOMMU with argv passed as command line.
1148 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
1149 * from the start. (It will detect it and not reexec again second time).
1150 * You have to audit carefully that you don't do something twice as a result
1151 * (opening files/sockets, parsing config files etc...)!
1152 *
1153 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
1154 * (will do setsid()).
1155 *
Pascal Bellard926031b2010-07-04 15:32:38 +02001156 * fork_or_rexec(argv) = bare-bones fork on MMU,
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001157 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
Denis Vlasenko83518d12009-03-20 22:17:13 +00001158 * On MMU ignores argv.
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001159 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001160 * Helper for network daemons in foreground mode:
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001161 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001162 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
1163 * to /dev/null if they are not.
1164 */
1165enum {
1166 DAEMON_CHDIR_ROOT = 1,
Denis Vlasenkoa1b16f42007-07-31 17:09:44 +00001167 DAEMON_DEVNULL_STDIO = 2,
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001168 DAEMON_CLOSE_EXTRA_FDS = 4,
1169 DAEMON_ONLY_SANITIZE = 8, /* internal use */
Peter Korsgaard743edac2011-11-09 19:44:37 +01001170 DAEMON_DOUBLE_FORK = 16, /* double fork to avoid controlling tty */
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001171};
Denis Vlasenko473dae02007-04-11 07:04:23 +00001172#if BB_MMU
Denis Vlasenko367960b2007-08-18 14:20:21 +00001173 enum { re_execed = 0 };
Pascal Bellard926031b2010-07-04 15:32:38 +02001174# define fork_or_rexec(argv) xfork()
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001175# define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
1176# define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001177#else
Pascal Bellard926031b2010-07-04 15:32:38 +02001178 extern bool re_execed;
Denys Vlasenkod2277e22011-11-22 17:19:26 +01001179 /* Note: re_exec() and fork_or_rexec() do argv[0][0] |= 0x80 on NOMMU!
1180 * _Parent_ needs to undo it if it doesn't want to have argv[0] mangled.
1181 */
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001182 void re_exec(char **argv) NORETURN FAST_FUNC;
Denis Vlasenko83518d12009-03-20 22:17:13 +00001183 pid_t fork_or_rexec(char **argv) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001184 int BUG_fork_is_unavailable_on_nommu(void) FAST_FUNC;
1185 int BUG_daemon_is_unavailable_on_nommu(void) FAST_FUNC;
1186 void BUG_bb_daemonize_is_unavailable_on_nommu(void) FAST_FUNC;
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001187# define fork() BUG_fork_is_unavailable_on_nommu()
Pascal Bellard926031b2010-07-04 15:32:38 +02001188# define xfork() BUG_fork_is_unavailable_on_nommu()
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001189# define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
1190# define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001191#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001192void bb_daemonize_or_rexec(int flags, char **argv) FAST_FUNC;
1193void bb_sanitize_stdio(void) FAST_FUNC;
Denys Vlasenkob182e9a2017-08-04 23:04:17 +02001194#define bb_daemon_helper(arg) bb_daemonize_or_rexec((arg) | DAEMON_ONLY_SANITIZE, NULL)
Denis Vlasenkoc9ca0a32008-02-18 11:08:33 +00001195/* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001196int sanitize_env_if_suid(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001197
1198
Denys Vlasenko727948e2017-08-04 16:23:42 +02001199/* For top, ps. Some argv[i] are replaced by malloced "-opt" strings */
1200void make_all_argv_opts(char **argv) FAST_FUNC;
Denys Vlasenko036585a2017-08-08 16:38:18 +02001201char* single_argv(char **argv) FAST_FUNC;
1202extern const char *const bb_argv_dash[]; /* { "-", NULL } */
1203extern uint32_t option_mask32;
Denys Vlasenko036585a2017-08-08 16:38:18 +02001204uint32_t getopt32(char **argv, const char *applet_opts, ...) FAST_FUNC;
1205# define No_argument "\0"
1206# define Required_argument "\001"
1207# define Optional_argument "\002"
1208#if ENABLE_LONG_OPTS
1209uint32_t getopt32long(char **argv, const char *optstring, const char *longopts, ...) FAST_FUNC;
1210#else
1211#define getopt32long(argv,optstring,longopts,...) \
1212 getopt32(argv,optstring,##__VA_ARGS__)
1213#endif
Kaarle Ritvanen835ad3a2017-04-12 00:58:46 +03001214/* BSD-derived getopt() functions require that optind be set to 1 in
1215 * order to reset getopt() state. This used to be generally accepted
1216 * way of resetting getopt(). However, glibc's getopt()
1217 * has additional getopt() state beyond optind (specifically, glibc
Denys Vlasenko352ddd32017-04-12 20:21:34 +02001218 * extensions such as '+' and '-' at the start of the string), and requires
Kaarle Ritvanen835ad3a2017-04-12 00:58:46 +03001219 * that optind be set to zero to reset its state. BSD-derived versions
1220 * of getopt() misbehaved if optind is set to 0 in order to reset getopt(),
1221 * and glibc's getopt() used to coredump if optind is set 1 in order
1222 * to reset getopt().
Denys Vlasenko352ddd32017-04-12 20:21:34 +02001223 * Then BSD introduced additional variable "optreset" which should be
1224 * set to 1 in order to reset getopt(). Sigh. Standards, anyone?
Kaarle Ritvanen835ad3a2017-04-12 00:58:46 +03001225 *
1226 * By ~2008, OpenBSD 3.4 was changed to survive glibc-like optind = 0
1227 * (to interpret it as if optreset was set).
1228 */
Denys Vlasenko60161812017-08-29 14:32:17 +02001229#if 1 /*def __GLIBC__*/
Kaarle Ritvanen835ad3a2017-04-12 00:58:46 +03001230#define GETOPT_RESET() (optind = 0)
1231#else /* BSD style */
1232#define GETOPT_RESET() (optind = 1)
1233#endif
1234
1235
Denys Vlasenko9be47022011-05-16 12:21:31 +02001236/* Having next pointer as a first member allows easy creation
1237 * of "llist-compatible" structs, and using llist_FOO functions
1238 * on them.
1239 */
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001240typedef struct llist_t {
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001241 struct llist_t *link;
Denys Vlasenko9be47022011-05-16 12:21:31 +02001242 char *data;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001243} llist_t;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001244void llist_add_to(llist_t **old_head, void *data) FAST_FUNC;
1245void llist_add_to_end(llist_t **list_head, void *data) FAST_FUNC;
1246void *llist_pop(llist_t **elm) FAST_FUNC;
1247void llist_unlink(llist_t **head, llist_t *elm) FAST_FUNC;
1248void llist_free(llist_t *elm, void (*freeit)(void *data)) FAST_FUNC;
1249llist_t *llist_rev(llist_t *list) FAST_FUNC;
Denis Vlasenko0b791d92009-04-13 20:52:00 +00001250llist_t *llist_find_str(llist_t *first, const char *str) FAST_FUNC;
Denis Vlasenko4b924f32007-05-30 00:29:55 +00001251/* BTW, surprisingly, changing API to
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001252 * llist_t *llist_add_to(llist_t *old_head, void *data)
1253 * etc does not result in smaller code... */
1254
Denis Vlasenko80edead2007-08-02 22:31:05 +00001255/* start_stop_daemon and udhcpc are special - they want
1256 * to create pidfiles regardless of FEATURE_PIDFILE */
Denis Vlasenko1caca342007-08-02 10:14:29 +00001257#if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001258/* True only if we created pidfile which is *file*, not /dev/null etc */
1259extern smallint wrote_pidfile;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001260void write_pidfile(const char *path) FAST_FUNC;
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001261#define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
Denis Vlasenko10457b92007-03-27 22:01:31 +00001262#else
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001263enum { wrote_pidfile = 0 };
1264#define write_pidfile(path) ((void)0)
1265#define remove_pidfile(path) ((void)0)
Denis Vlasenko10457b92007-03-27 22:01:31 +00001266#endif
1267
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001268enum {
1269 LOGMODE_NONE = 0,
Denis Vlasenko1b97efd2007-08-17 19:18:06 +00001270 LOGMODE_STDIO = (1 << 0),
1271 LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001272 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
1273};
1274extern const char *msg_eol;
Denys Vlasenko3dfe0ae2014-04-30 14:48:28 +02001275extern smallint syslog_level;
Denis Vlasenko04c99eb2007-04-07 00:44:31 +00001276extern smallint logmode;
Denys Vlasenko7aa63042010-09-01 16:04:24 +02001277extern uint8_t xfunc_error_retval;
Denys Vlasenko550bf5b2015-10-09 16:42:57 +02001278extern void (*die_func)(void);
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001279extern void xfunc_die(void) NORETURN FAST_FUNC;
1280extern void bb_show_usage(void) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001281extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1282extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1283extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1284extern void bb_simple_perror_msg(const char *s) FAST_FUNC;
1285extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
Denis Vlasenkofb1a23d2009-03-07 01:54:24 +00001286extern void bb_simple_perror_msg_and_die(const char *s) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001287extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1288extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001289extern void bb_perror_nomsg_and_die(void) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001290extern void bb_perror_nomsg(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001291extern void bb_verror_msg(const char *s, va_list p, const char *strerr) FAST_FUNC;
Michel Stamd3fabf82014-11-04 12:19:04 +01001292extern void bb_logenv_override(void) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001293
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +00001294/* We need to export XXX_main from libbusybox
1295 * only if we build "individual" binaries
1296 */
1297#if ENABLE_FEATURE_INDIVIDUAL
1298#define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
1299#else
1300#define MAIN_EXTERNALLY_VISIBLE
1301#endif
1302
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001303
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001304/* Applets which are useful from another applets */
Denys Vlasenkod9eb40c2017-04-12 15:48:19 +02001305int bb_cat(char** argv) FAST_FUNC;
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001306/* If shell needs them, they exist even if not enabled as applets */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001307int echo_main(int argc, char** argv) IF_ECHO(MAIN_EXTERNALLY_VISIBLE);
1308int printf_main(int argc, char **argv) IF_PRINTF(MAIN_EXTERNALLY_VISIBLE);
Denys Vlasenko548620c2016-12-08 12:24:48 +01001309int test_main(int argc, char **argv)
1310#if ENABLE_TEST || ENABLE_TEST1 || ENABLE_TEST2
1311 MAIN_EXTERNALLY_VISIBLE
1312#endif
1313;
1314int kill_main(int argc, char **argv)
1315#if ENABLE_KILL || ENABLE_KILLALL || ENABLE_KILLALL5
1316 MAIN_EXTERNALLY_VISIBLE
1317#endif
1318;
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001319/* Similar, but used by chgrp, not shell */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001320int chown_main(int argc, char **argv) IF_CHOWN(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenkoc41cba52009-03-09 15:46:07 +00001321/* Used by ftpd */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001322int ls_main(int argc, char **argv) IF_LS(MAIN_EXTERNALLY_VISIBLE);
1323/* Don't need IF_xxx() guard for these */
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +00001324int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko77f1ec12007-10-13 03:36:03 +00001325int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko1a9e9bd2008-11-01 12:54:56 +00001326
Denis Vlasenko468aea22008-04-01 14:47:57 +00001327#if ENABLE_ROUTE
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001328void bb_displayroutes(int noresolve, int netstatfmt) FAST_FUNC;
Denis Vlasenko468aea22008-04-01 14:47:57 +00001329#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001330
Denys Vlasenkod88f94a2017-04-05 18:17:17 +02001331struct number_state {
1332 unsigned width;
1333 unsigned start;
1334 unsigned inc;
1335 const char *sep;
1336 const char *empty_str;
1337 smallint all, nonempty;
1338};
1339void print_numbered_lines(struct number_state *ns, const char *filename) FAST_FUNC;
1340
Denis Vlasenko270c17c2006-12-26 17:40:33 +00001341
1342/* Networking */
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001343/* This structure defines protocol families and their handlers. */
1344struct aftype {
1345 const char *name;
1346 const char *title;
1347 int af;
1348 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001349 char* FAST_FUNC (*print)(unsigned char *);
1350 const char* FAST_FUNC (*sprint)(struct sockaddr *, int numeric);
1351 int FAST_FUNC (*input)(/*int type,*/ const char *bufp, struct sockaddr *);
1352 void FAST_FUNC (*herror)(char *text);
1353 int FAST_FUNC (*rprint)(int options);
1354 int FAST_FUNC (*rinput)(int typ, int ext, char **argv);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001355 /* may modify src */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001356 int FAST_FUNC (*getmask)(char *src, struct sockaddr *mask, char *name);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001357};
1358/* This structure defines hardware protocols and their handlers. */
1359struct hwtype {
1360 const char *name;
1361 const char *title;
1362 int type;
1363 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001364 char* FAST_FUNC (*print)(unsigned char *);
1365 int FAST_FUNC (*input)(const char *, struct sockaddr *);
1366 int FAST_FUNC (*activate)(int fd);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001367 int suppress_null_addr;
1368};
Denis Vlasenko1b16bda2007-06-19 11:10:02 +00001369extern smallint interface_opt_a;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001370int display_interfaces(char *ifname) FAST_FUNC;
Bartosz Golaszewskic19be752013-07-25 04:39:04 +02001371int in_ether(const char *bufp, struct sockaddr *sap) FAST_FUNC;
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001372#if ENABLE_FEATURE_HWIB
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001373int in_ib(const char *bufp, struct sockaddr *sap) FAST_FUNC;
Denis Vlasenko3b162ec2008-06-04 07:59:51 +00001374#else
1375#define in_ib(a, b) 1 /* fail */
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001376#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001377const struct aftype *get_aftype(const char *name) FAST_FUNC;
1378const struct hwtype *get_hwtype(const char *name) FAST_FUNC;
1379const struct hwtype *get_hwntype(int type) FAST_FUNC;
Denis Vlasenko270c17c2006-12-26 17:40:33 +00001380
1381
Denys Vlasenko35b54a32017-01-30 00:45:05 +01001382extern int fstype_matches(const char *fstype, const char *comma_list) FAST_FUNC;
Mike Frysinger9412ec72008-02-07 22:41:33 +00001383#ifdef HAVE_MNTENT_H
Denys Vlasenko6ae64262009-07-18 16:22:26 +02001384extern struct mntent *find_mount_point(const char *name, int subdir_too) FAST_FUNC;
Mike Frysinger9412ec72008-02-07 22:41:33 +00001385#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001386extern void erase_mtab(const char * name) FAST_FUNC;
1387extern unsigned int tty_baud_to_value(speed_t speed) FAST_FUNC;
1388extern speed_t tty_value_to_baud(unsigned int value) FAST_FUNC;
Denys Vlasenkoa355da02010-01-04 13:16:08 +01001389#if ENABLE_DESKTOP
1390extern void bb_warn_ignoring_args(char *arg) FAST_FUNC;
1391#else
1392# define bb_warn_ignoring_args(arg) ((void)0)
1393#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001394
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001395extern int get_linux_version_code(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001396
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001397extern char *query_loop(const char *device) FAST_FUNC;
1398extern int del_loop(const char *device) FAST_FUNC;
Denys Vlasenkoab518ee2017-03-16 16:49:37 +01001399/*
1400 * If *devname is not NULL, use that name, otherwise try to find free one,
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001401 * malloc and return it in *devname.
Denys Vlasenkoab518ee2017-03-16 16:49:37 +01001402 * return value is the opened fd to the loop device, or < on error
1403 */
1404extern int set_loop(char **devname, const char *file, unsigned long long offset, unsigned flags) FAST_FUNC;
1405/* These constants match linux/loop.h (without BB_ prefix): */
1406#define BB_LO_FLAGS_READ_ONLY 1
1407#define BB_LO_FLAGS_AUTOCLEAR 4
Eric Andersenaad1a882001-03-16 22:47:14 +00001408
Bernhard Reutner-Fischer82b14292008-12-03 18:48:39 +00001409/* Like bb_ask below, but asks on stdin with no timeout. */
1410char *bb_ask_stdin(const char * prompt) FAST_FUNC;
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +00001411//TODO: pass buf pointer or return allocated buf (avoid statics)?
Bernhard Reutner-Fischer82b14292008-12-03 18:48:39 +00001412char *bb_ask(const int fd, int timeout, const char * prompt) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001413int bb_ask_confirmation(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001414
Denys Vlasenko5711a2a2015-10-07 17:55:33 +02001415/* Returns -1 if input is invalid. current_mode is a base for e.g. "u+rw" */
1416int bb_parse_mode(const char* s, unsigned cur_mode) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001417
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001418/*
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001419 * Config file parser
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001420 */
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001421enum {
Denis Vlasenko084266e2008-07-26 23:08:31 +00001422 PARSE_COLLAPSE = 0x00010000, // treat consecutive delimiters as one
1423 PARSE_TRIM = 0x00020000, // trim leading and trailing delimiters
1424// TODO: COLLAPSE and TRIM seem to always go in pair
1425 PARSE_GREEDY = 0x00040000, // last token takes entire remainder of the line
1426 PARSE_MIN_DIE = 0x00100000, // die if < min tokens found
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001427 // keep a copy of current line
Denis Vlasenko35a064b2008-11-06 00:49:59 +00001428 PARSE_KEEP_COPY = 0x00200000 * ENABLE_FEATURE_CROND_D,
Denys Vlasenko499597d2012-01-11 00:37:17 +01001429 PARSE_EOL_COMMENTS = 0x00400000, // comments are recognized even if they aren't the first char
Denys Vlasenko50db1f22017-08-05 18:20:34 +02001430 PARSE_ALT_COMMENTS = 0x00800000, // delim[0] and delim[1] are two different allowed comment chars
1431 // (so far, delim[0] will only work as comment char for full-line comment)
1432 // (IOW: it works as if PARSE_EOL_COMMENTS is not set. sysctl applet is okay with this)
1433 PARSE_WS_COMMENTS = 0x01000000, // comments are recognized even if there is whitespace before
1434 // ("line start><space><tab><space>#comment" is also comment, not only "line start>#comment")
Denis Vlasenko084266e2008-07-26 23:08:31 +00001435 // NORMAL is:
1436 // * remove leading and trailing delimiters and collapse
1437 // multiple delimiters into one
1438 // * warn and continue if less than mintokens delimiters found
1439 // * grab everything into last token
Denys Vlasenko499597d2012-01-11 00:37:17 +01001440 // * comments are recognized even if they aren't the first char
1441 PARSE_NORMAL = PARSE_COLLAPSE | PARSE_TRIM | PARSE_GREEDY | PARSE_EOL_COMMENTS,
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001442};
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001443typedef struct parser_t {
1444 FILE *fp;
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001445 char *data;
Timo Terasadcabf32011-06-20 09:49:56 +02001446 char *line, *nline;
1447 size_t line_alloc, nline_alloc;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001448 int lineno;
1449} parser_t;
Bernhard Reutner-Fischer67921282008-07-17 11:59:13 +00001450parser_t* config_open(const char *filename) FAST_FUNC;
Denis Vlasenko5415c852008-07-21 23:05:26 +00001451parser_t* config_open2(const char *filename, FILE* FAST_FUNC (*fopen_func)(const char *path)) FAST_FUNC;
Denys Vlasenkoadbbee42010-06-21 07:17:23 +02001452/* delims[0] is a comment char (use '\0' to disable), the rest are token delimiters */
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001453int config_read(parser_t *parser, char **tokens, unsigned flags, const char *delims) FAST_FUNC;
1454#define config_read(parser, tokens, max, min, str, flags) \
1455 config_read(parser, tokens, ((flags) | (((min) & 0xFF) << 8) | ((max) & 0xFF)), str)
Denis Vlasenkoc01340f2008-07-16 22:12:18 +00001456void config_close(parser_t *parser) FAST_FUNC;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001457
Denis Vlasenko6bf05cf2008-05-07 12:18:48 +00001458/* Concatenate path and filename to new allocated buffer.
1459 * Add "/" only as needed (no duplicate "//" are produced).
1460 * If path is NULL, it is assumed to be "/".
1461 * filename should not be NULL. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001462char *concat_path_file(const char *path, const char *filename) FAST_FUNC;
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +02001463/* Returns NULL on . and .. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001464char *concat_subpath_file(const char *path, const char *filename) FAST_FUNC;
Eric Andersene5dfced2001-04-09 22:48:12 +00001465
Denis Vlasenko4921b542007-02-03 02:17:41 +00001466
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001467int bb_make_directory(char *path, long mode, int flags) FAST_FUNC;
Matt Kraaiceeff732001-06-21 19:41:37 +00001468
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001469int get_signum(const char *name) FAST_FUNC;
1470const char *get_signame(int number) FAST_FUNC;
1471void print_signames(void) FAST_FUNC;
Rob Landleyc9c1a412006-07-12 19:17:55 +00001472
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001473char *bb_simplify_path(const char *path) FAST_FUNC;
Denis Vlasenko1cf4a0e2009-04-22 13:49:16 +00001474/* Returns ptr to NUL */
1475char *bb_simplify_abs_path_inplace(char *path) FAST_FUNC;
Eric Andersen34506362001-08-02 05:02:46 +00001476
Peter Kümmela6588fa2014-12-22 01:55:54 +01001477#ifndef LOGIN_FAIL_DELAY
Denys Vlasenko681efe22011-03-08 21:00:36 +01001478#define LOGIN_FAIL_DELAY 3
Peter Kümmela6588fa2014-12-22 01:55:54 +01001479#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001480extern void bb_do_delay(int seconds) FAST_FUNC;
1481extern void change_identity(const struct passwd *pw) FAST_FUNC;
Denys Vlasenko79e25982016-11-03 22:13:08 +01001482extern void run_shell(const char *shell, int loginshell, const char **args) NORETURN FAST_FUNC;
Denys Vlasenko681efe22011-03-08 21:00:36 +01001483
1484/* Returns $SHELL, getpwuid(getuid())->pw_shell, or DEFAULT_SHELL.
1485 * Note that getpwuid result might need xstrdup'ing
1486 * if there is a possibility of intervening getpwxxx() calls.
1487 */
Denys Vlasenkofd77ea52012-10-03 09:42:21 +02001488const char *get_shell_name(void) FAST_FUNC;
Denys Vlasenko681efe22011-03-08 21:00:36 +01001489
Denys Vlasenko44b3f2f2017-08-21 02:14:19 +02001490unsigned cap_name_to_number(const char *cap) FAST_FUNC;
1491void printf_cap(const char *pfx, unsigned cap_no) FAST_FUNC;
Denys Vlasenko200bcc82017-08-21 19:30:01 +02001492void drop_capability(int cap_ordinal) FAST_FUNC;
1493/* Structures inside "struct caps" are Linux-specific and libcap-specific: */
1494#define DEFINE_STRUCT_CAPS \
1495struct caps { \
1496 struct __user_cap_header_struct header; \
1497 unsigned u32s; \
1498 struct __user_cap_data_struct data[2]; \
1499}
1500void getcaps(void *caps) FAST_FUNC;
Denys Vlasenko44b3f2f2017-08-21 02:14:19 +02001501
1502unsigned cap_name_to_number(const char *name) FAST_FUNC;
1503void printf_cap(const char *pfx, unsigned cap_no) FAST_FUNC;
1504
Denis Vlasenkob5a122b2006-12-30 14:46:51 +00001505#if ENABLE_SELINUX
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001506extern void renew_current_security_context(void) FAST_FUNC;
1507extern void set_current_security_context(security_context_t sid) FAST_FUNC;
Denis Vlasenko1203c9b2007-03-11 22:16:02 +00001508extern context_t set_security_context_component(security_context_t cur_context,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001509 char *user, char *role, char *type, char *range) FAST_FUNC;
1510extern void setfscreatecon_or_die(security_context_t scontext) FAST_FUNC;
1511extern void selinux_preserve_fcontext(int fdesc) FAST_FUNC;
Denis Vlasenko2edbc2a2007-10-20 02:00:49 +00001512#else
1513#define selinux_preserve_fcontext(fdesc) ((void)0)
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001514#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001515extern void selinux_or_die(void) FAST_FUNC;
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001516
Davide Cavalca9b3b9792011-01-25 02:26:03 +01001517
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001518/* setup_environment:
Bernhard Reutner-Fischer99709ab2010-02-24 16:10:09 +01001519 * if chdir pw->pw_dir: ok: else if to_tmp == 1: goto /tmp else: goto / or die
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001520 * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001521 * TERM=(old value)
1522 * USER=pw->pw_name, LOGNAME=pw->pw_name
1523 * PATH=bb_default_[root_]path
1524 * HOME=pw->pw_dir
1525 * SHELL=shell
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001526 * else if change_env = 1:
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001527 * if not root (if pw->pw_uid != 0):
1528 * USER=pw->pw_name, LOGNAME=pw->pw_name
1529 * HOME=pw->pw_dir
1530 * SHELL=shell
1531 * else does nothing
Denys Vlasenkoe4f6bfd2017-07-22 03:04:20 +02001532 *
1533 * NB: CHANGEENV and CLEARENV use setenv() - this leaks memory!
1534 * If setup_environment() is used is vforked child, this leaks memory _in parent too_!
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001535 */
Denys Vlasenkofd686a22010-02-26 09:52:45 +01001536#define SETUP_ENV_CHANGEENV (1 << 0)
1537#define SETUP_ENV_CLEARENV (1 << 1)
1538#define SETUP_ENV_TO_TMP (1 << 2)
Pascal Bellard70fc8c12012-06-12 13:21:02 +02001539#define SETUP_ENV_NO_CHDIR (1 << 4)
Denys Vlasenko8b59b2c2013-11-19 13:36:45 +01001540void setup_environment(const char *shell, int flags, const struct passwd *pw) FAST_FUNC;
1541void nuke_str(char *str) FAST_FUNC;
Kaarle Ritvanen517a82c2016-01-02 00:20:39 +02001542#if ENABLE_FEATURE_SECURETTY && !ENABLE_PAM
Denys Vlasenkoa3de0b32017-04-13 13:04:05 +02001543int is_tty_secure(const char *short_tty) FAST_FUNC;
Kaarle Ritvanen517a82c2016-01-02 00:20:39 +02001544#else
Denys Vlasenkoa3de0b32017-04-13 13:04:05 +02001545static ALWAYS_INLINE int is_tty_secure(const char *short_tty UNUSED_PARAM) { return 1; }
Kaarle Ritvanen517a82c2016-01-02 00:20:39 +02001546#endif
Denys Vlasenko335681c2017-04-13 12:57:04 +02001547#define CHECKPASS_PW_HAS_EMPTY_PASSWORD 2
Morten Kvistgaardfeac9b62014-08-05 21:57:18 +02001548int check_password(const struct passwd *pw, const char *plaintext) FAST_FUNC;
Denys Vlasenko8b59b2c2013-11-19 13:36:45 +01001549int ask_and_check_password_extended(const struct passwd *pw, int timeout, const char *prompt) FAST_FUNC;
1550int ask_and_check_password(const struct passwd *pw) FAST_FUNC;
Denis Vlasenkofdddab02008-06-12 16:56:52 +00001551/* Returns a malloced string */
Denis Vlasenkob4c5bf62008-06-15 18:35:34 +00001552#if !ENABLE_USE_BB_CRYPT
1553#define pw_encrypt(clear, salt, cleanup) pw_encrypt(clear, salt)
1554#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001555extern char *pw_encrypt(const char *clear, const char *salt, int cleanup) FAST_FUNC;
1556extern int obscure(const char *old, const char *newval, const struct passwd *pwdp) FAST_FUNC;
Denys Vlasenko12a43272011-05-13 03:19:01 +02001557/*
1558 * rnd is additional random input. New one is returned.
Denis Vlasenko4ea83bf2008-06-12 16:55:59 +00001559 * Useful if you call crypt_make_salt many times in a row:
1560 * rnd = crypt_make_salt(buf1, 4, 0);
1561 * rnd = crypt_make_salt(buf2, 4, rnd);
1562 * rnd = crypt_make_salt(buf3, 4, rnd);
1563 * (otherwise we risk having same salt generated)
1564 */
Denys Vlasenko12a43272011-05-13 03:19:01 +02001565extern int crypt_make_salt(char *p, int cnt /*, int rnd*/) FAST_FUNC;
1566/* "$N$" + sha_salt_16_bytes + NUL */
1567#define MAX_PW_SALT_LEN (3 + 16 + 1)
1568extern char* crypt_make_pw_salt(char p[MAX_PW_SALT_LEN], const char *algo) FAST_FUNC;
1569
Denis Vlasenko829bbd32009-04-14 00:51:05 +00001570
Denis Vlasenko4ea83bf2008-06-12 16:55:59 +00001571/* Returns number of lines changed, or -1 on error */
Denis Vlasenko829bbd32009-04-14 00:51:05 +00001572#if !(ENABLE_FEATURE_ADDUSER_TO_GROUP || ENABLE_FEATURE_DEL_USER_FROM_GROUP)
1573#define update_passwd(filename, username, data, member) \
1574 update_passwd(filename, username, data)
1575#endif
1576extern int update_passwd(const char *filename,
1577 const char *username,
1578 const char *data,
1579 const char *member) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001580
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001581int index_in_str_array(const char *const string_array[], const char *key) FAST_FUNC;
1582int index_in_strings(const char *strings, const char *key) FAST_FUNC;
1583int index_in_substr_array(const char *const string_array[], const char *key) FAST_FUNC;
1584int index_in_substrings(const char *strings, const char *key) FAST_FUNC;
1585const char *nth_string(const char *strings, int n) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001586
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001587extern void print_login_issue(const char *issue_file, const char *tty) FAST_FUNC;
1588extern void print_login_prompt(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001589
Denys Vlasenko53283ad2009-11-02 14:20:34 +01001590char *xmalloc_ttyname(int fd) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof893da82007-08-09 08:27:24 +00001591/* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001592int get_terminal_width_height(int fd, unsigned *width, unsigned *height) FAST_FUNC;
Denys Vlasenko641caae2015-10-23 01:44:22 +02001593int get_terminal_width(int fd) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001594
Denis Vlasenko202ac502008-11-05 13:20:58 +00001595int tcsetattr_stdin_TCSANOW(const struct termios *tp) FAST_FUNC;
Denys Vlasenko01ccdd12017-01-11 16:17:59 +01001596#define TERMIOS_CLEAR_ISIG (1 << 0)
1597#define TERMIOS_RAW_CRNL (1 << 1)
1598#define TERMIOS_RAW_INPUT (1 << 2)
Denys Vlasenkoaaaaaa52017-09-15 17:14:01 +02001599int get_termios_and_make_raw(int fd, struct termios *newterm, struct termios *oldterm, int flags) FAST_FUNC;
Denys Vlasenko01ccdd12017-01-11 16:17:59 +01001600int set_termios_to_raw(int fd, struct termios *oldterm, int flags) FAST_FUNC;
Denis Vlasenko202ac502008-11-05 13:20:58 +00001601
Denis Vlasenko5bb2fc22008-04-21 03:23:59 +00001602/* NB: "unsigned request" is crucial! "int request" will break some arches! */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001603int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1604int ioctl_or_perror_and_die(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001605#if ENABLE_IOCTL_HEX2STR_ERROR
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001606int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1607int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001608#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1609#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
1610#else
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001611int bb_ioctl_or_warn(int fd, unsigned request, void *argp) FAST_FUNC;
1612int bb_xioctl(int fd, unsigned request, void *argp) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001613#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1614#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
1615#endif
1616
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001617char *is_in_ino_dev_hashtable(const struct stat *statbuf) FAST_FUNC;
1618void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name) FAST_FUNC;
1619void reset_ino_dev_hashtable(void) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001620#ifdef __GLIBC__
1621/* At least glibc has horrendously large inline for this, so wrap it */
Denys Vlasenko975c7142011-01-24 23:53:12 +01001622unsigned long long bb_makedev(unsigned major, unsigned minor) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001623#undef makedev
1624#define makedev(a,b) bb_makedev(a,b)
1625#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001626
1627
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001628/* "Keycodes" that report an escape sequence.
1629 * We use something which fits into signed char,
Denys Vlasenko5370bfb2009-09-06 02:58:59 +02001630 * yet doesn't represent any valid Unicode character.
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001631 * Also, -1 is reserved for error indication and we don't use it. */
1632enum {
Rostislav Skudnov2e4ef382016-11-24 15:04:00 +01001633 KEYCODE_UP = -2,
1634 KEYCODE_DOWN = -3,
1635 KEYCODE_RIGHT = -4,
1636 KEYCODE_LEFT = -5,
1637 KEYCODE_HOME = -6,
1638 KEYCODE_END = -7,
1639 KEYCODE_INSERT = -8,
1640 KEYCODE_DELETE = -9,
1641 KEYCODE_PAGEUP = -10,
1642 KEYCODE_PAGEDOWN = -11,
1643 KEYCODE_BACKSPACE = -12, /* Used only if Alt/Ctrl/Shifted */
1644 KEYCODE_D = -13, /* Used only if Alted */
Denys Vlasenko9ce09bc2011-11-03 13:28:22 +01001645#if 0
Rostislav Skudnov2e4ef382016-11-24 15:04:00 +01001646 KEYCODE_FUN1 = ,
1647 KEYCODE_FUN2 = ,
1648 KEYCODE_FUN3 = ,
1649 KEYCODE_FUN4 = ,
1650 KEYCODE_FUN5 = ,
1651 KEYCODE_FUN6 = ,
1652 KEYCODE_FUN7 = ,
1653 KEYCODE_FUN8 = ,
1654 KEYCODE_FUN9 = ,
1655 KEYCODE_FUN10 = ,
1656 KEYCODE_FUN11 = ,
1657 KEYCODE_FUN12 = ,
Denys Vlasenko9ce09bc2011-11-03 13:28:22 +01001658#endif
Rostislav Skudnov2e4ef382016-11-24 15:04:00 +01001659 /* ^^^^^ Be sure that last defined value is small enough.
1660 * Current read_key() code allows going up to -32 (0xfff..fffe0).
1661 * This gives three upper bits in LSB to play with:
1662 * KEYCODE_foo values are 0xfff..fffXX, lowest XX bits are: scavvvvv,
1663 * s=0 if SHIFT, c=0 if CTRL, a=0 if ALT,
1664 * vvvvv bits are the same for same key regardless of "shift bits".
Denys Vlasenko9ce09bc2011-11-03 13:28:22 +01001665 */
Rostislav Skudnov2e4ef382016-11-24 15:04:00 +01001666 //KEYCODE_SHIFT_... = KEYCODE_... & ~0x80,
1667 KEYCODE_CTRL_RIGHT = KEYCODE_RIGHT & ~0x40,
1668 KEYCODE_CTRL_LEFT = KEYCODE_LEFT & ~0x40,
1669 KEYCODE_ALT_RIGHT = KEYCODE_RIGHT & ~0x20,
1670 KEYCODE_ALT_LEFT = KEYCODE_LEFT & ~0x20,
1671 KEYCODE_ALT_BACKSPACE = KEYCODE_BACKSPACE & ~0x20,
1672 KEYCODE_ALT_D = KEYCODE_D & ~0x20,
Denys Vlasenko9ce09bc2011-11-03 13:28:22 +01001673
Denys Vlasenko180f5852009-10-26 00:59:59 +01001674 KEYCODE_CURSOR_POS = -0x100, /* 0xfff..fff00 */
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001675 /* How long is the longest ESC sequence we know?
1676 * We want it big enough to be able to contain
1677 * cursor position sequence "ESC [ 9999 ; 9999 R"
1678 */
1679 KEYCODE_BUFFER_SIZE = 16
1680};
1681/* Note: fd may be in blocking or non-blocking mode, both make sense.
1682 * For one, less uses non-blocking mode.
1683 * Only the first read syscall inside read_key may block indefinitely
1684 * (unless fd is in non-blocking mode),
1685 * subsequent reads will time out after a few milliseconds.
1686 * Return of -1 means EOF or error (errno == 0 on EOF).
1687 * buffer[0] is used as a counter of buffered chars and must be 0
1688 * on first call.
Denys Vlasenko58f108e2010-03-11 21:17:55 +01001689 * timeout:
Denys Vlasenko84ea60e2017-08-02 17:27:28 +02001690 * -2: do not poll(-1) for input - read() it, return on EAGAIN at once
1691 * -1: poll(-1) (i.e. block even on NONBLOCKed fd)
1692 * >=0: poll() for TIMEOUT milliseconds, return -1/EAGAIN on timeout
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001693 */
Denys Vlasenko58f108e2010-03-11 21:17:55 +01001694int64_t read_key(int fd, char *buffer, int timeout) FAST_FUNC;
Tomas Heinrichd2b04052010-03-09 14:09:24 +01001695void read_key_ungets(char *buffer, const char *str, unsigned len) FAST_FUNC;
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001696
1697
Denis Vlasenko38f63192007-01-22 09:03:07 +00001698#if ENABLE_FEATURE_EDITING
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001699/* It's NOT just ENABLEd or disabled. It's a number: */
Denys Vlasenko2c4de5b2011-03-31 13:16:52 +02001700# if defined CONFIG_FEATURE_EDITING_HISTORY && CONFIG_FEATURE_EDITING_HISTORY > 0
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001701# define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
Flemming Madsend96ffda2013-04-07 18:47:24 +02001702unsigned size_from_HISTFILESIZE(const char *hp) FAST_FUNC;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001703# else
1704# define MAX_HISTORY 0
1705# endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001706typedef struct line_input_t {
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001707 int flags;
Denys Vlasenko84ea60e2017-08-02 17:27:28 +02001708 int timeout;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001709 const char *path_lookup;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001710# if MAX_HISTORY
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001711 int cnt_history;
1712 int cur_history;
Denys Vlasenko2c4de5b2011-03-31 13:16:52 +02001713 int max_history; /* must never be <= 0 */
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001714# if ENABLE_FEATURE_EDITING_SAVEHISTORY
Denys Vlasenkobede2152011-09-04 16:12:33 +02001715 /* meaning of this field depends on FEATURE_EDITING_SAVE_ON_EXIT:
1716 * if !FEATURE_EDITING_SAVE_ON_EXIT: "how many lines are
1717 * in on-disk history"
1718 * if FEATURE_EDITING_SAVE_ON_EXIT: "how many in-memory lines are
1719 * also in on-disk history (and thus need to be skipped on save)"
1720 */
Denis Vlasenko57abf9e2009-03-22 19:00:05 +00001721 unsigned cnt_history_in_file;
Denis Vlasenko57abf9e2009-03-22 19:00:05 +00001722 const char *hist_file;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001723# endif
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001724 char *history[MAX_HISTORY + 1];
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001725# endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001726} line_input_t;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001727enum {
Denys Vlasenkoe45af7a2011-09-04 16:15:24 +02001728 DO_HISTORY = 1 * (MAX_HISTORY > 0),
1729 TAB_COMPLETION = 2 * ENABLE_FEATURE_TAB_COMPLETION,
1730 USERNAME_COMPLETION = 4 * ENABLE_FEATURE_USERNAME_COMPLETION,
1731 VI_MODE = 8 * ENABLE_FEATURE_EDITING_VI,
1732 WITH_PATH_LOOKUP = 0x10,
1733 FOR_SHELL = DO_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001734};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001735line_input_t *new_line_input_t(int flags) FAST_FUNC;
Denys Vlasenko5c2e81b2009-07-16 14:14:34 +02001736/* So far static: void free_line_input_t(line_input_t *n) FAST_FUNC; */
Denys Vlasenko046341e2011-02-04 17:53:59 +01001737/*
1738 * maxsize must be >= 2.
Denys Vlasenko5c2e81b2009-07-16 14:14:34 +02001739 * Returns:
Denis Vlasenko80667e32008-02-02 18:35:55 +00001740 * -1 on read errors or EOF, or on bare Ctrl-D,
1741 * 0 on ctrl-C (the line entered is still returned in 'command'),
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001742 * >0 length of input string, including terminating '\n'
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001743 */
Denys Vlasenko84ea60e2017-08-02 17:27:28 +02001744int read_line_input(line_input_t *st, const char *prompt, char *command, int maxsize) FAST_FUNC;
Flemming Madsend96ffda2013-04-07 18:47:24 +02001745void show_history(const line_input_t *st) FAST_FUNC;
Denys Vlasenkobede2152011-09-04 16:12:33 +02001746# if ENABLE_FEATURE_EDITING_SAVE_ON_EXIT
1747void save_history(line_input_t *st);
1748# endif
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001749#else
Denys Vlasenko36df0482009-10-19 16:07:28 +02001750#define MAX_HISTORY 0
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001751int read_line_input(const char* prompt, char* command, int maxsize) FAST_FUNC;
Denys Vlasenko84ea60e2017-08-02 17:27:28 +02001752#define read_line_input(state, prompt, command, maxsize) \
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001753 read_line_input(prompt, command, maxsize)
1754#endif
1755
1756
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001757#ifndef COMM_LEN
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001758# ifdef TASK_COMM_LEN
Denis Vlasenkofa076802006-11-05 00:38:51 +00001759enum { COMM_LEN = TASK_COMM_LEN };
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001760# else
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001761/* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
Denis Vlasenkofa076802006-11-05 00:38:51 +00001762enum { COMM_LEN = 16 };
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001763# endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001764#endif
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02001765
1766struct smaprec {
1767 unsigned long mapped_rw;
1768 unsigned long mapped_ro;
1769 unsigned long shared_clean;
1770 unsigned long shared_dirty;
1771 unsigned long private_clean;
1772 unsigned long private_dirty;
1773 unsigned long stack;
1774 unsigned long smap_pss, smap_swap;
1775 unsigned long smap_size;
1776 unsigned long smap_start;
1777 char smap_mode[5];
1778 char *smap_name;
1779};
1780
1781#if !ENABLE_PMAP
1782#define procps_read_smaps(pid, total, cb, data) \
1783 procps_read_smaps(pid, total)
1784#endif
1785int FAST_FUNC procps_read_smaps(pid_t pid, struct smaprec *total,
Denys Vlasenko6830ade2013-01-15 13:58:01 +01001786 void (*cb)(struct smaprec *, void *), void *data);
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02001787
Denis Vlasenko512499c2007-08-26 18:23:13 +00001788typedef struct procps_status_t {
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001789 DIR *dir;
Denys Vlasenkob410d4a2009-09-19 22:29:42 +02001790 IF_FEATURE_SHOW_THREADS(DIR *task_dir;)
Denis Vlasenko512499c2007-08-26 18:23:13 +00001791 uint8_t shift_pages_to_bytes;
1792 uint8_t shift_pages_to_kb;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001793/* Fields are set to 0/NULL if failed to determine (or not requested) */
Denis Vlasenko3b3ca112008-07-17 18:39:36 +00001794 uint16_t argv_len;
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001795 char *argv0;
Alexander Shishkine766f622009-07-29 01:35:13 +02001796 char *exe;
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001797 IF_SELINUX(char *context;)
Lauri Kasanen6578f2c2010-12-05 05:22:29 +01001798 IF_FEATURE_SHOW_THREADS(unsigned main_thread_pid;)
Denis Vlasenko0696b8a2007-06-06 07:40:16 +00001799 /* Everything below must contain no ptrs to malloc'ed data:
1800 * it is memset(0) for each process in procps_scan() */
Denis Vlasenkofc1e9952007-08-29 18:23:36 +00001801 unsigned long vsz, rss; /* we round it to kbytes */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001802 unsigned long stime, utime;
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001803 unsigned long start_time;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001804 unsigned pid;
1805 unsigned ppid;
1806 unsigned pgid;
1807 unsigned sid;
1808 unsigned uid;
1809 unsigned gid;
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001810#if ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS
1811 unsigned ruid;
1812 unsigned rgid;
1813 int niceness;
1814#endif
Denis Vlasenko31789a82007-06-19 14:43:17 +00001815 unsigned tty_major,tty_minor;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001816#if ENABLE_FEATURE_TOPMEM
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02001817 struct smaprec smaps;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001818#endif
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001819 char state[4];
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001820 /* basename of executable in exec(2), read from /proc/N/stat
1821 * (if executable is symlink or script, it is NOT replaced
1822 * by link target or interpreter name) */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001823 char comm[COMM_LEN];
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001824 /* user/group? - use passwd/group parsing functions */
Denis Vlasenko17e7f042008-09-25 10:48:06 +00001825#if ENABLE_FEATURE_TOP_SMP_PROCESS
1826 int last_seen_on_cpu;
1827#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001828} procps_status_t;
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001829/* flag bits for procps_scan(xx, flags) calls */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001830enum {
1831 PSSCAN_PID = 1 << 0,
1832 PSSCAN_PPID = 1 << 1,
1833 PSSCAN_PGID = 1 << 2,
1834 PSSCAN_SID = 1 << 3,
1835 PSSCAN_UIDGID = 1 << 4,
1836 PSSCAN_COMM = 1 << 5,
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001837 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001838 PSSCAN_ARGV0 = 1 << 7,
Alexander Shishkine766f622009-07-29 01:35:13 +02001839 PSSCAN_EXE = 1 << 8,
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001840 PSSCAN_STATE = 1 << 9,
1841 PSSCAN_VSZ = 1 << 10,
1842 PSSCAN_RSS = 1 << 11,
1843 PSSCAN_STIME = 1 << 12,
1844 PSSCAN_UTIME = 1 << 13,
1845 PSSCAN_TTY = 1 << 14,
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001846 PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM,
Denis Vlasenko9f00e052009-02-14 01:36:11 +00001847 /* NB: used by find_pid_by_name(). Any applet using it
1848 * needs to be mentioned here. */
1849 PSSCAN_ARGVN = (1 << 16) * (ENABLE_KILLALL
1850 || ENABLE_PGREP || ENABLE_PKILL
1851 || ENABLE_PIDOF
Denis Vlasenko3266aa92009-04-01 11:24:04 +00001852 || ENABLE_SESTATUS
Denis Vlasenko9f00e052009-02-14 01:36:11 +00001853 ),
Denys Vlasenko4ff1ce02009-09-22 11:21:48 +02001854 PSSCAN_CONTEXT = (1 << 17) * ENABLE_SELINUX,
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001855 PSSCAN_START_TIME = 1 << 18,
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001856 PSSCAN_CPU = (1 << 19) * ENABLE_FEATURE_TOP_SMP_PROCESS,
1857 PSSCAN_NICE = (1 << 20) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1858 PSSCAN_RUIDGID = (1 << 21) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
Denys Vlasenkob410d4a2009-09-19 22:29:42 +02001859 PSSCAN_TASKS = (1 << 22) * ENABLE_FEATURE_SHOW_THREADS,
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001860};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001861//procps_status_t* alloc_procps_scan(void) FAST_FUNC;
1862void free_procps_scan(procps_status_t* sp) FAST_FUNC;
1863procps_status_t* procps_scan(procps_status_t* sp, int flags) FAST_FUNC;
Denys Vlasenko3a0f6f22009-09-12 00:15:34 +02001864/* Format cmdline (up to col chars) into char buf[size] */
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001865/* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
Denys Vlasenko3a0f6f22009-09-12 00:15:34 +02001866void read_cmdline(char *buf, int size, unsigned pid, const char *comm) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001867pid_t *find_pid_by_name(const char* procName) FAST_FUNC;
1868pid_t *pidlist_reverse(pid_t *pidList) FAST_FUNC;
Denys Vlasenkoc9b97502010-08-16 02:49:21 +02001869int starts_with_cpu(const char *str) FAST_FUNC;
1870unsigned get_cpu_count(void) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001871
1872
Denys Vlasenkodd1061b2011-09-11 21:04:02 +02001873/* Use strict=1 if you process input from untrusted source:
1874 * it will return NULL on invalid %xx (bad hex chars)
1875 * and str + 1 if decoded char is / or NUL.
1876 * In non-strict mode, it always succeeds (returns str),
1877 * and also it additionally decoded '+' to space.
1878 */
1879char *percent_decode_in_place(char *str, int strict) FAST_FUNC;
1880
1881
Aurelien Jarnod3a42392012-07-24 16:28:34 +02001882extern const char bb_uuenc_tbl_base64[] ALIGN1;
1883extern const char bb_uuenc_tbl_std[] ALIGN1;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001884void bb_uuencode(char *store, const void *s, int length, const char *tbl) FAST_FUNC;
Denys Vlasenko9fe98f72010-09-16 17:51:13 +02001885enum {
1886 BASE64_FLAG_UU_STOP = 0x100,
1887 /* Sign-extends to a value which never matches fgetc result: */
1888 BASE64_FLAG_NO_STOP_CHAR = 0x80,
1889};
Leonid Lisovskiy328f27f2011-10-28 13:59:04 +02001890const char *decode_base64(char **pp_dst, const char *src) FAST_FUNC;
1891void read_base64(FILE *src_stream, FILE *dst_stream, int flags) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001892
Denis Vlasenkodd539f72006-11-01 20:20:37 +00001893typedef struct md5_ctx_t {
Denys Vlasenko302ad142010-10-19 02:16:12 +02001894 uint8_t wbuffer[64]; /* always correctly aligned for uint64_t */
1895 void (*process_block)(struct md5_ctx_t*) FAST_FUNC;
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02001896 uint64_t total64; /* must be directly before hash[] */
Denys Vlasenko302ad142010-10-19 02:16:12 +02001897 uint32_t hash[8]; /* 4 elements for md5, 5 for sha1, 8 for sha256 */
1898} md5_ctx_t;
1899typedef struct md5_ctx_t sha1_ctx_t;
1900typedef struct md5_ctx_t sha256_ctx_t;
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02001901typedef struct sha512_ctx_t {
1902 uint64_t total64[2]; /* must be directly before hash[] */
1903 uint64_t hash[8];
Denys Vlasenko302ad142010-10-19 02:16:12 +02001904 uint8_t wbuffer[128]; /* always correctly aligned for uint64_t */
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02001905} sha512_ctx_t;
Lauri Kasanenb8173b62013-01-14 05:20:50 +01001906typedef struct sha3_ctx_t {
1907 uint64_t state[25];
1908 unsigned bytes_queued;
Denys Vlasenko71a090f2016-08-29 14:05:25 +02001909 unsigned input_block_bytes;
Lauri Kasanenb8173b62013-01-14 05:20:50 +01001910} sha3_ctx_t;
Denys Vlasenko302ad142010-10-19 02:16:12 +02001911void md5_begin(md5_ctx_t *ctx) FAST_FUNC;
Denys Vlasenko2cfcc9e2013-01-20 00:38:09 +01001912void md5_hash(md5_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
Denys Vlasenko49ecee02017-01-24 16:00:54 +01001913unsigned md5_end(md5_ctx_t *ctx, void *resbuf) FAST_FUNC;
Denys Vlasenko302ad142010-10-19 02:16:12 +02001914void sha1_begin(sha1_ctx_t *ctx) FAST_FUNC;
1915#define sha1_hash md5_hash
Denys Vlasenko49ecee02017-01-24 16:00:54 +01001916unsigned sha1_end(sha1_ctx_t *ctx, void *resbuf) FAST_FUNC;
Denys Vlasenko302ad142010-10-19 02:16:12 +02001917void sha256_begin(sha256_ctx_t *ctx) FAST_FUNC;
1918#define sha256_hash md5_hash
1919#define sha256_end sha1_end
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02001920void sha512_begin(sha512_ctx_t *ctx) FAST_FUNC;
1921void sha512_hash(sha512_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
Denys Vlasenko49ecee02017-01-24 16:00:54 +01001922unsigned sha512_end(sha512_ctx_t *ctx, void *resbuf) FAST_FUNC;
Lauri Kasanenb8173b62013-01-14 05:20:50 +01001923void sha3_begin(sha3_ctx_t *ctx) FAST_FUNC;
1924void sha3_hash(sha3_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
Denys Vlasenko49ecee02017-01-24 16:00:54 +01001925unsigned sha3_end(sha3_ctx_t *ctx, void *resbuf) FAST_FUNC;
1926/* TLS benefits from knowing that sha1 and sha256 share these. Give them "agnostic" names too */
1927typedef struct md5_ctx_t md5sha_ctx_t;
1928#define md5sha_hash md5_hash
1929#define sha_end sha1_end
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00001930
Denys Vlasenko9ce642f2010-10-27 15:26:45 +02001931extern uint32_t *global_crc32_table;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001932uint32_t *crc32_filltable(uint32_t *tbl256, int endian) FAST_FUNC;
Denys Vlasenkoddacb032018-02-01 10:56:19 +01001933uint32_t *crc32_new_table_le(void) FAST_FUNC;
1934uint32_t *global_crc32_new_table_le(void) FAST_FUNC;
Denys Vlasenko9ce642f2010-10-27 15:26:45 +02001935uint32_t crc32_block_endian1(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
1936uint32_t crc32_block_endian0(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001937
1938typedef struct masks_labels_t {
1939 const char *labels;
1940 const int masks[];
1941} masks_labels_t;
1942int print_flags_separated(const int *masks, const char *labels,
1943 int flags, const char *separator) FAST_FUNC;
1944int print_flags(const masks_labels_t *ml, int flags) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001945
Magnus Dammf5914992009-11-08 16:34:43 +01001946typedef struct bb_progress_t {
Denys Vlasenkoab8d00d2011-02-11 19:09:30 +01001947 unsigned last_size;
1948 unsigned last_update_sec;
1949 unsigned last_change_sec;
Magnus Dammf5914992009-11-08 16:34:43 +01001950 unsigned start_sec;
Denys Vlasenkod55e1392011-02-11 18:56:13 +01001951 const char *curfile;
Magnus Dammf5914992009-11-08 16:34:43 +01001952} bb_progress_t;
1953
Denys Vlasenkod55e1392011-02-11 18:56:13 +01001954#define is_bb_progress_inited(p) ((p)->curfile != NULL)
1955#define bb_progress_free(p) do { \
1956 if (ENABLE_UNICODE_SUPPORT) free((char*)((p)->curfile)); \
1957 (p)->curfile = NULL; \
1958} while (0)
1959void bb_progress_init(bb_progress_t *p, const char *curfile) FAST_FUNC;
1960void bb_progress_update(bb_progress_t *p,
Denys Vlasenko805aa9f2011-02-10 14:25:51 +01001961 uoff_t beg_range,
1962 uoff_t transferred,
1963 uoff_t totalsize) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001964
Sven Eisenbergb068cf22016-04-03 21:53:12 +02001965unsigned ubi_devnum_from_devname(const char *str) FAST_FUNC;
Denys Vlasenko6aab9922016-04-03 22:24:51 +02001966int ubi_get_volid_by_name(unsigned ubi_devnum, const char *vol_name) FAST_FUNC;
Sven Eisenbergb068cf22016-04-03 21:53:12 +02001967
Denys Vlasenkod55e1392011-02-11 18:56:13 +01001968
Denis Vlasenko8f8f2682006-10-03 21:00:43 +00001969extern const char *applet_name;
Denys Vlasenko0004e992010-09-01 12:01:17 +02001970
1971/* Some older linkers don't perform string merging, we used to have common strings
1972 * as global arrays to do it by hand. But:
1973 * (1) newer linkers do it themselves,
1974 * (2) however, they DONT merge string constants with global arrays,
1975 * even if the value is the same (!). Thus global arrays actually
1976 * increased size a bit: for example, "/etc/passwd" string from libc
1977 * wasn't merged with bb_path_passwd_file[] array!
1978 * Therefore now we use #defines.
1979 */
Bernhard Reutner-Fischer78e1d582008-01-13 17:52:53 +00001980/* "BusyBox vN.N.N (timestamp or extra_version)" */
Aurelien Jarnod3a42392012-07-24 16:28:34 +02001981extern const char bb_banner[] ALIGN1;
1982extern const char bb_msg_memory_exhausted[] ALIGN1;
1983extern const char bb_msg_invalid_date[] ALIGN1;
Denys Vlasenko0004e992010-09-01 12:01:17 +02001984#define bb_msg_read_error "read error"
1985#define bb_msg_write_error "write error"
Aurelien Jarnod3a42392012-07-24 16:28:34 +02001986extern const char bb_msg_unknown[] ALIGN1;
1987extern const char bb_msg_can_not_create_raw_socket[] ALIGN1;
1988extern const char bb_msg_perm_denied_are_you_root[] ALIGN1;
1989extern const char bb_msg_you_must_be_root[] ALIGN1;
1990extern const char bb_msg_requires_arg[] ALIGN1;
Denys Vlasenko0f296a32015-10-14 13:21:01 +02001991extern const char bb_msg_invalid_arg_to[] ALIGN1;
Aurelien Jarnod3a42392012-07-24 16:28:34 +02001992extern const char bb_msg_standard_input[] ALIGN1;
1993extern const char bb_msg_standard_output[] ALIGN1;
Manuel Novoa III cad53642003-03-19 09:13:01 +00001994
Denis Vlasenko98c0bba2007-01-26 23:31:05 +00001995/* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
Aurelien Jarnod3a42392012-07-24 16:28:34 +02001996extern const char bb_hexdigits_upcase[] ALIGN1;
Denis Vlasenko7ca39212006-11-21 20:34:21 +00001997
Aurelien Jarnod3a42392012-07-24 16:28:34 +02001998extern const char bb_path_wtmp_file[] ALIGN1;
Denys Vlasenko0004e992010-09-01 12:01:17 +02001999
2000/* Busybox mount uses either /proc/mounts or /etc/mtab to
2001 * get the list of currently mounted filesystems */
2002#define bb_path_mtab_file IF_FEATURE_MTAB_SUPPORT("/etc/mtab")IF_NOT_FEATURE_MTAB_SUPPORT("/proc/mounts")
2003
Tito Ragusaad3d72f2011-01-16 23:39:45 +01002004#define bb_path_passwd_file _PATH_PASSWD
2005#define bb_path_group_file _PATH_GROUP
2006#define bb_path_shadow_file _PATH_SHADOW
2007#define bb_path_gshadow_file _PATH_GSHADOW
Denys Vlasenko0004e992010-09-01 12:01:17 +02002008
2009#define bb_path_motd_file "/etc/motd"
2010
2011#define bb_dev_null "/dev/null"
Aurelien Jarnod3a42392012-07-24 16:28:34 +02002012extern const char bb_busybox_exec_path[] ALIGN1;
Denys Vlasenkocca7c612018-01-12 13:21:33 +01002013/* allow default system PATH to be extended via CFLAGS */
2014#ifndef BB_ADDITIONAL_PATH
2015#define BB_ADDITIONAL_PATH ""
2016#endif
2017#define BB_PATH_ROOT_PATH "PATH=/sbin:/usr/sbin:/bin:/usr/bin" BB_ADDITIONAL_PATH
2018extern const char bb_PATH_root_path[] ALIGN1; /* BB_PATH_ROOT_PATH */
Denis Vlasenkof5f75c52007-06-12 22:35:19 +00002019#define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
Denys Vlasenkocca7c612018-01-12 13:21:33 +01002020/* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
2021 * but I want to save a few bytes here:
2022 */
Denis Vlasenkof5f75c52007-06-12 22:35:19 +00002023#define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +00002024
Denis Vlasenko703e2022007-01-22 14:12:08 +00002025extern const int const_int_0;
Denys Vlasenkoc52cbea2015-08-24 19:48:03 +02002026//extern const int const_int_1;
Denis Vlasenko703e2022007-01-22 14:12:08 +00002027
Denis Vlasenko972288e2007-03-15 00:57:01 +00002028/* This struct is deliberately not defined. */
2029/* See docs/keep_data_small.txt */
2030struct globals;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00002031/* '*const' ptr makes gcc optimize code much better.
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002032 * Magic prevents ptr_to_globals from going into rodata.
Denis Vlasenko574f2f42008-02-27 18:41:59 +00002033 * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
Denis Vlasenkobff32ce2007-03-15 19:48:35 +00002034extern struct globals *const ptr_to_globals;
Denis Vlasenko574f2f42008-02-27 18:41:59 +00002035/* At least gcc 3.4.6 on mipsel system needs optimization barrier */
Bernhard Reutner-Fischer797c96d2008-06-06 10:31:39 +00002036#define barrier() __asm__ __volatile__("":::"memory")
Denis Vlasenko574f2f42008-02-27 18:41:59 +00002037#define SET_PTR_TO_GLOBALS(x) do { \
Denys Vlasenko90a99042009-09-06 02:36:23 +02002038 (*(struct globals**)&ptr_to_globals) = (void*)(x); \
Denis Vlasenko574f2f42008-02-27 18:41:59 +00002039 barrier(); \
2040} while (0)
Guilherme Maciel Ferreira840ef172013-10-16 14:43:30 +02002041#define FREE_PTR_TO_GLOBALS() do { \
2042 if (ENABLE_FEATURE_CLEAN_UP) { \
2043 free(ptr_to_globals); \
2044 } \
2045} while (0)
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00002046
Denis Vlasenkodca0b702006-10-27 09:05:02 +00002047/* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
2048 * use bb_default_login_shell and following defines.
2049 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
2050 * don't forget to change increment constant. */
Ladislav Michla73b87e2010-06-27 03:23:31 +02002051#define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
Aurelien Jarnod3a42392012-07-24 16:28:34 +02002052extern const char bb_default_login_shell[] ALIGN1;
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00002053/* "/bin/sh" */
Ladislav Michla73b87e2010-06-27 03:23:31 +02002054#define DEFAULT_SHELL (bb_default_login_shell+1)
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00002055/* "sh" */
Ladislav Michla73b87e2010-06-27 03:23:31 +02002056#define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00002057
Jeremie Koenig816ed972010-05-27 15:46:29 +02002058/* The following devices are the same on all systems. */
2059#define CURRENT_TTY "/dev/tty"
2060#define DEV_CONSOLE "/dev/console"
2061
2062#if defined(__FreeBSD_kernel__)
2063# define CURRENT_VC CURRENT_TTY
2064# define VC_1 "/dev/ttyv0"
2065# define VC_2 "/dev/ttyv1"
2066# define VC_3 "/dev/ttyv2"
2067# define VC_4 "/dev/ttyv3"
2068# define VC_5 "/dev/ttyv4"
2069# define VC_FORMAT "/dev/ttyv%d"
2070#elif defined(__GNU__)
2071# define CURRENT_VC CURRENT_TTY
2072# define VC_1 "/dev/tty1"
2073# define VC_2 "/dev/tty2"
2074# define VC_3 "/dev/tty3"
2075# define VC_4 "/dev/tty4"
2076# define VC_5 "/dev/tty5"
2077# define VC_FORMAT "/dev/tty%d"
Denys Vlasenko1c26e052010-10-24 02:35:17 +02002078#elif ENABLE_FEATURE_DEVFS
2079/*Linux, obsolete devfs names */
Matt Kraai439e3df2001-07-23 14:52:08 +00002080# define CURRENT_VC "/dev/vc/0"
2081# define VC_1 "/dev/vc/1"
2082# define VC_2 "/dev/vc/2"
2083# define VC_3 "/dev/vc/3"
2084# define VC_4 "/dev/vc/4"
2085# define VC_5 "/dev/vc/5"
Matt Kraai439e3df2001-07-23 14:52:08 +00002086# define VC_FORMAT "/dev/vc/%d"
Denys Vlasenko4928e9f2013-06-27 03:45:16 +02002087# define LOOP_FORMAT "/dev/loop/%u"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00002088# define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00002089# define LOOP_NAME "/dev/loop/"
Eric Andersen5f284552003-11-14 03:11:29 +00002090# define FB_0 "/dev/fb/0"
Matt Kraai439e3df2001-07-23 14:52:08 +00002091#else
Denys Vlasenko1c26e052010-10-24 02:35:17 +02002092/*Linux, normal names */
Matt Kraai439e3df2001-07-23 14:52:08 +00002093# define CURRENT_VC "/dev/tty0"
2094# define VC_1 "/dev/tty1"
2095# define VC_2 "/dev/tty2"
2096# define VC_3 "/dev/tty3"
2097# define VC_4 "/dev/tty4"
2098# define VC_5 "/dev/tty5"
Matt Kraai439e3df2001-07-23 14:52:08 +00002099# define VC_FORMAT "/dev/tty%d"
Denys Vlasenko4928e9f2013-06-27 03:45:16 +02002100# define LOOP_FORMAT "/dev/loop%u"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00002101# define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00002102# define LOOP_NAME "/dev/loop"
Eric Andersen5f284552003-11-14 03:11:29 +00002103# define FB_0 "/dev/fb0"
Matt Kraai439e3df2001-07-23 14:52:08 +00002104#endif
2105
Rob Landleyc57ec372006-04-10 17:07:15 +00002106
Denys Vlasenko9d57a802009-10-23 14:24:44 +02002107#define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
Denys Vlasenkoab3964d2015-10-13 14:50:20 +02002108#define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
Denys Vlasenko9d57a802009-10-23 14:24:44 +02002109
Rob Landleyb623a542006-05-31 22:09:03 +00002110
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02002111/* We redefine ctype macros. Unicode-correct handling of char types
2112 * can't be done with such byte-oriented operations anyway,
2113 * we don't lose anything.
2114 */
Rob Landley4ae905a2006-07-06 17:22:54 +00002115#undef isalnum
2116#undef isalpha
2117#undef isascii
2118#undef isblank
2119#undef iscntrl
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02002120#undef isdigit
Rob Landley4ae905a2006-07-06 17:22:54 +00002121#undef isgraph
2122#undef islower
2123#undef isprint
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02002124#undef ispunct
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02002125#undef isspace
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02002126#undef isupper
2127#undef isxdigit
2128#undef toupper
2129#undef tolower
Rob Landley4ae905a2006-07-06 17:22:54 +00002130
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02002131/* We save ~500 bytes on isdigit alone.
Denys Vlasenko7b4cd6f2009-10-23 02:22:03 +02002132 * BTW, x86 likes (unsigned char) cast more than (unsigned). */
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01002133
2134/* These work the same for ASCII and Unicode,
2135 * assuming no one asks "is this a *Unicode* letter?" using isalpha(letter) */
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02002136#define isascii(a) ((unsigned char)(a) <= 0x7f)
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01002137#define isdigit(a) ((unsigned char)((a) - '0') <= 9)
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02002138#define isupper(a) ((unsigned char)((a) - 'A') <= ('Z' - 'A'))
2139#define islower(a) ((unsigned char)((a) - 'a') <= ('z' - 'a'))
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02002140#define isalpha(a) ((unsigned char)(((a)|0x20) - 'a') <= ('z' - 'a'))
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02002141#define isblank(a) ({ unsigned char bb__isblank = (a); bb__isblank == ' ' || bb__isblank == '\t'; })
2142#define iscntrl(a) ({ unsigned char bb__iscntrl = (a); bb__iscntrl < ' ' || bb__iscntrl == 0x7f; })
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02002143/* In POSIX/C locale isspace is only these chars: "\t\n\v\f\r" and space.
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02002144 * "\t\n\v\f\r" happen to have ASCII codes 9,10,11,12,13.
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02002145 */
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02002146#define isspace(a) ({ unsigned char bb__isspace = (a) - 9; bb__isspace == (' ' - 9) || bb__isspace <= (13 - 9); })
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01002147// Unsafe wrt NUL: #define ispunct(a) (strchr("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a)) != NULL)
2148#define ispunct(a) (strchrnul("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a))[0])
2149// Bigger code: #define isalnum(a) ({ unsigned char bb__isalnum = (a) - '0'; bb__isalnum <= 9 || ((bb__isalnum - ('A' - '0')) & 0xdf) <= 25; })
Denys Vlasenko11c12c42009-10-23 13:57:24 +02002150#define isalnum(a) bb_ascii_isalnum(a)
2151static ALWAYS_INLINE int bb_ascii_isalnum(unsigned char a)
2152{
2153 unsigned char b = a - '0';
2154 if (b <= 9)
2155 return (b <= 9);
2156 b = (a|0x20) - 'a';
2157 return b <= 'z' - 'a';
2158}
2159#define isxdigit(a) bb_ascii_isxdigit(a)
2160static ALWAYS_INLINE int bb_ascii_isxdigit(unsigned char a)
2161{
2162 unsigned char b = a - '0';
2163 if (b <= 9)
2164 return (b <= 9);
2165 b = (a|0x20) - 'a';
2166 return b <= 'f' - 'a';
2167}
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02002168#define toupper(a) bb_ascii_toupper(a)
2169static ALWAYS_INLINE unsigned char bb_ascii_toupper(unsigned char a)
2170{
2171 unsigned char b = a - 'a';
2172 if (b <= ('z' - 'a'))
2173 a -= 'a' - 'A';
2174 return a;
2175}
2176#define tolower(a) bb_ascii_tolower(a)
2177static ALWAYS_INLINE unsigned char bb_ascii_tolower(unsigned char a)
2178{
2179 unsigned char b = a - 'A';
2180 if (b <= ('Z' - 'A'))
2181 a += 'a' - 'A';
2182 return a;
2183}
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02002184
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01002185/* In ASCII and Unicode, these are likely to be very different.
2186 * Let's prevent ambiguous usage from the start */
2187#define isgraph(a) isgraph_is_ambiguous_dont_use(a)
2188#define isprint(a) isprint_is_ambiguous_dont_use(a)
2189/* NB: must not treat EOF as isgraph or isprint */
2190#define isgraph_asciionly(a) ((unsigned)((a) - 0x21) <= 0x7e - 0x21)
2191#define isprint_asciionly(a) ((unsigned)((a) - 0x20) <= 0x7e - 0x20)
2192
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02002193
Bartosz Golaszewski3ed81cf2014-06-22 16:30:41 +02002194/* Simple unit-testing framework */
2195
2196typedef void (*bbunit_testfunc)(void);
2197
2198struct bbunit_listelem {
Bartosz Golaszewski3ed81cf2014-06-22 16:30:41 +02002199 const char* name;
2200 bbunit_testfunc testfunc;
2201};
2202
2203void bbunit_registertest(struct bbunit_listelem* test);
2204void bbunit_settestfailed(void);
2205
2206#define BBUNIT_DEFINE_TEST(NAME) \
2207 static void bbunit_##NAME##_test(void); \
2208 static struct bbunit_listelem bbunit_##NAME##_elem = { \
2209 .name = #NAME, \
2210 .testfunc = bbunit_##NAME##_test, \
2211 }; \
Bartosz Golaszewskibf0f2c72014-06-26 14:31:05 +02002212 static void INIT_FUNC bbunit_##NAME##_register(void) \
Bartosz Golaszewski3ed81cf2014-06-22 16:30:41 +02002213 { \
2214 bbunit_registertest(&bbunit_##NAME##_elem); \
2215 } \
2216 static void bbunit_##NAME##_test(void)
2217
2218/*
2219 * Both 'goto bbunit_end' and 'break' are here only to get rid
2220 * of compiler warnings.
2221 */
2222#define BBUNIT_ENDTEST \
2223 do { \
2224 goto bbunit_end; \
2225 bbunit_end: \
2226 break; \
2227 } while (0)
2228
2229#define BBUNIT_PRINTASSERTFAIL \
2230 do { \
2231 bb_error_msg( \
2232 "[ERROR] Assertion failed in file %s, line %d", \
2233 __FILE__, __LINE__); \
2234 } while (0)
2235
2236#define BBUNIT_ASSERTION_FAILED \
2237 do { \
2238 bbunit_settestfailed(); \
2239 goto bbunit_end; \
2240 } while (0)
2241
2242/*
2243 * Assertions.
2244 * For now we only offer assertions which cause tests to fail
2245 * immediately. In the future 'expects' might be added too -
2246 * similar to those offered by the gtest framework.
2247 */
2248#define BBUNIT_ASSERT_EQ(EXPECTED, ACTUAL) \
2249 do { \
2250 if ((EXPECTED) != (ACTUAL)) { \
2251 BBUNIT_PRINTASSERTFAIL; \
2252 bb_error_msg("[ERROR] '%s' isn't equal to '%s'", \
2253 #EXPECTED, #ACTUAL); \
2254 BBUNIT_ASSERTION_FAILED; \
2255 } \
2256 } while (0)
2257
2258#define BBUNIT_ASSERT_NOTEQ(EXPECTED, ACTUAL) \
2259 do { \
2260 if ((EXPECTED) == (ACTUAL)) { \
2261 BBUNIT_PRINTASSERTFAIL; \
2262 bb_error_msg("[ERROR] '%s' is equal to '%s'", \
2263 #EXPECTED, #ACTUAL); \
2264 BBUNIT_ASSERTION_FAILED; \
2265 } \
2266 } while (0)
2267
2268#define BBUNIT_ASSERT_NOTNULL(PTR) \
2269 do { \
2270 if ((PTR) == NULL) { \
2271 BBUNIT_PRINTASSERTFAIL; \
2272 bb_error_msg("[ERROR] '%s' is NULL!", #PTR); \
2273 BBUNIT_ASSERTION_FAILED; \
2274 } \
2275 } while (0)
2276
2277#define BBUNIT_ASSERT_NULL(PTR) \
2278 do { \
2279 if ((PTR) != NULL) { \
2280 BBUNIT_PRINTASSERTFAIL; \
2281 bb_error_msg("[ERROR] '%s' is not NULL!", #PTR); \
2282 BBUNIT_ASSERTION_FAILED; \
2283 } \
2284 } while (0)
2285
2286#define BBUNIT_ASSERT_FALSE(STATEMENT) \
2287 do { \
2288 if ((STATEMENT)) { \
2289 BBUNIT_PRINTASSERTFAIL; \
2290 bb_error_msg("[ERROR] Statement '%s' evaluated to true!", \
2291 #STATEMENT); \
2292 BBUNIT_ASSERTION_FAILED; \
2293 } \
2294 } while (0)
2295
2296#define BBUNIT_ASSERT_TRUE(STATEMENT) \
2297 do { \
2298 if (!(STATEMENT)) { \
2299 BBUNIT_PRINTASSERTFAIL; \
2300 bb_error_msg("[ERROR] Statement '%s' evaluated to false!", \
2301 #STATEMENT); \
2302 BBUNIT_ASSERTION_FAILED; \
2303 } \
2304 } while (0)
2305
2306#define BBUNIT_ASSERT_STREQ(STR1, STR2) \
2307 do { \
2308 if (strcmp(STR1, STR2) != 0) { \
2309 BBUNIT_PRINTASSERTFAIL; \
2310 bb_error_msg("[ERROR] Strings '%s' and '%s' " \
2311 "are not the same", STR1, STR2); \
2312 BBUNIT_ASSERTION_FAILED; \
2313 } \
2314 } while (0)
2315
2316#define BBUNIT_ASSERT_STRNOTEQ(STR1, STR2) \
2317 do { \
2318 if (strcmp(STR1, STR2) == 0) { \
2319 BBUNIT_PRINTASSERTFAIL; \
2320 bb_error_msg("[ERROR] Strings '%s' and '%s' " \
2321 "are the same, but were " \
2322 "expected to differ", STR1, STR2); \
2323 BBUNIT_ASSERTION_FAILED; \
2324 } \
2325 } while (0)
2326
2327
Denis Vlasenkof81e8db2009-04-09 12:35:13 +00002328POP_SAVED_FUNCTION_VISIBILITY
2329
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +00002330#endif