blob: ece03e7d83b4e2099f8845a420d6606e5c11c48c [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>
Denys Vlasenko7bcde5f2018-04-08 17:23:27 +020044#include <sys/resource.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000045#include <sys/socket.h>
"Vladimir N. Oleynik"7fe65202005-09-20 10:02:36 +000046#include <sys/stat.h>
Rob Landley299a6b42006-05-27 21:42:58 +000047#include <sys/time.h>
Rob Landleyb623a542006-05-31 22:09:03 +000048#include <sys/types.h>
Denys Vlasenko4f13a702016-12-12 16:29:32 +010049#if !defined(major) || defined(__GLIBC__)
Denys Vlasenkodd807c12011-02-07 14:58:57 +010050# include <sys/sysmacros.h>
51#endif
Rob Landleyc9c1a412006-07-12 19:17:55 +000052#include <sys/wait.h>
Rob Landleyb623a542006-05-31 22:09:03 +000053#include <termios.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000054#include <time.h>
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000055#include <sys/param.h>
Denys Vlasenkoa76dd502012-01-08 16:11:38 +010056#include <pwd.h>
57#include <grp.h>
Denys Vlasenko3e0c4282012-01-08 16:13:55 +010058#if ENABLE_FEATURE_SHADOWPASSWDS
59# if !ENABLE_USE_BB_SHADOW
60/* If using busybox's shadow implementation, do not include the shadow.h
61 * header as the toolchain may not provide it at all.
62 */
63# include <shadow.h>
64# endif
65#endif
Denys Vlasenkoa76dd502012-01-08 16:11:38 +010066#if defined(ANDROID) || defined(__ANDROID__)
67# define endpwent() ((void)0)
68# define endgrent() ((void)0)
69#endif
Mike Frysinger22876c72008-02-07 22:10:07 +000070#ifdef HAVE_MNTENT_H
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +020071# include <mntent.h>
Mike Frysinger22876c72008-02-07 22:10:07 +000072#endif
Mike Frysinger9412ec72008-02-07 22:41:33 +000073#ifdef HAVE_SYS_STATFS_H
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +020074# include <sys/statfs.h>
Mike Frysinger9412ec72008-02-07 22:41:33 +000075#endif
Denys Vlasenko67905e22011-07-26 13:42:12 +020076/* Don't do this here:
77 * #include <sys/sysinfo.h>
78 * Some linux/ includes pull in conflicting definition
79 * of struct sysinfo (only in some toolchanins), which breaks build.
80 * Include sys/sysinfo.h only in those files which need it.
81 */
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000082#if ENABLE_SELINUX
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +020083# include <selinux/selinux.h>
84# include <selinux/context.h>
Eric Andersen9e480452003-07-03 10:07:04 +000085#endif
Denys Vlasenko8d0e0cd2011-01-25 23:21:46 +010086#if ENABLE_FEATURE_UTMP
Bernhard Reutner-Fischer7d863842015-04-19 23:45:17 +020087# if defined __UCLIBC__ && ( \
88 (UCLIBC_VERSION >= KERNEL_VERSION(0, 9, 32) \
89 && UCLIBC_VERSION < KERNEL_VERSION(0, 9, 34) \
90 && defined __UCLIBC_HAS_UTMPX__ \
91 ) || ( \
92 UCLIBC_VERSION >= KERNEL_VERSION(0, 9, 34) \
93 ) \
94 )
95# include <utmpx.h>
96# elif defined __UCLIBC__
97# include <utmp.h>
98# define utmpx utmp
99# define setutxent setutent
100# define endutxent endutent
101# define getutxent getutent
102# define getutxid getutid
103# define getutxline getutline
104# define pututxline pututline
105# define utmpxname utmpname
106# define updwtmpx updwtmp
107# define _PATH_UTMPX _PATH_UTMP
108# else
Alex Samorukov4a4b4532021-01-04 19:35:09 +0100109# if !defined(__FreeBSD__)
110# include <utmp.h>
111# else
112# define _PATH_UTMPX "/var/run/utx.active"
113# endif
Bernhard Reutner-Fischer7d863842015-04-19 23:45:17 +0200114# include <utmpx.h>
Kylie McClain40eea692016-02-01 01:36:05 +0100115# if defined _PATH_UTMP && !defined _PATH_UTMPX
116# define _PATH_UTMPX _PATH_UTMP
117# endif
Bernhard Reutner-Fischer7d863842015-04-19 23:45:17 +0200118# endif
Denys Vlasenko8d0e0cd2011-01-25 23:21:46 +0100119#endif
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000120#if ENABLE_LOCALE_SUPPORT
Denys Vlasenko9d57a802009-10-23 14:24:44 +0200121# include <locale.h>
Rob Landleyeb84a422006-09-20 21:41:13 +0000122#else
Denys Vlasenko9d57a802009-10-23 14:24:44 +0200123# define setlocale(x,y) ((void)0)
Rob Landleyd921b2e2006-08-03 15:41:12 +0000124#endif
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000125#ifdef DMALLOC
Denys Vlasenko9d57a802009-10-23 14:24:44 +0200126# include <dmalloc.h>
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000127#endif
Tito Ragusaad3d72f2011-01-16 23:39:45 +0100128/* Just in case libc doesn't define some of these... */
129#ifndef _PATH_PASSWD
130#define _PATH_PASSWD "/etc/passwd"
131#endif
132#ifndef _PATH_GROUP
133#define _PATH_GROUP "/etc/group"
134#endif
135#ifndef _PATH_SHADOW
136#define _PATH_SHADOW "/etc/shadow"
137#endif
138#ifndef _PATH_GSHADOW
139#define _PATH_GSHADOW "/etc/gshadow"
140#endif
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +0200141#if defined __FreeBSD__ || defined __OpenBSD__
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +0100142# include <netinet/in.h>
143# include <arpa/inet.h>
144#elif defined __APPLE__
145# include <netinet/in.h>
146#else
147# include <arpa/inet.h>
Denys Vlasenkodbb58a32016-03-14 18:23:33 +0100148//This breaks on bionic:
149//# if !defined(__socklen_t_defined) && !defined(_SOCKLEN_T_DECLARED)
150///* We #define socklen_t *after* includes, otherwise we get
151// * typedef redefinition errors from system headers
152// * (in case "is it defined already" detection above failed)
153// */
154//# define socklen_t bb_socklen_t
155// typedef unsigned socklen_t;
156//# endif
157//if this is still needed, add a fix along the lines of
158// ifdef SPECIFIC_BROKEN_LIBC_CHECK / typedef socklen_t / endif
159//in platform.h instead!
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +0100160#endif
Chris Rees330718e2011-01-24 17:07:06 +0100161#ifndef HAVE_CLEARENV
162# define clearenv() do { if (environ) environ[0] = NULL; } while (0)
163#endif
164#ifndef HAVE_FDATASYNC
165# define fdatasync fsync
166#endif
167#ifndef HAVE_XTABS
168# define XTABS TAB3
169#endif
Denys Vlasenko6f97b302017-09-29 18:17:25 +0200170/*
171 * Use '%m' to append error string on platforms that support it,
172 * '%s' and strerror() on those that don't.
173 */
174#ifdef HAVE_PRINTF_PERCENTM
175# define STRERROR_FMT "%m"
176# define STRERROR_ERRNO /*nothing*/
177#else
178# define STRERROR_FMT "%s"
179# define STRERROR_ERRNO ,strerror(errno)
180#endif
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +0100181
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000182
Denis Vlasenkoaf6cca52008-05-25 04:31:54 +0000183/* Some libc's forget to declare these, do it ourself */
Denis Vlasenko847fa772008-01-28 22:45:43 +0000184
Denis Vlasenkocac0f5b2008-09-25 10:20:46 +0000185extern char **environ;
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000186/* klogctl is in libc's klog.h, but we cheat and not #include that */
187int klogctl(int type, char *b, int len);
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +0100188#ifndef PATH_MAX
189# define PATH_MAX 256
190#endif
191#ifndef BUFSIZ
192# define BUFSIZ 4096
193#endif
Rob Landley362dc2b2006-06-05 17:35:24 +0000194
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000195
Denys Vlasenko0c4cf422011-06-30 02:44:27 +0200196/* Busybox does not use threads, we can speed up stdio. */
Dan Fandrich75214cf2011-06-30 02:59:17 +0200197#ifdef HAVE_UNLOCKED_STDIO
198# undef getc
Denys Vlasenkoaa3576a2016-08-22 19:54:12 +0200199# define getc(stream) getc_unlocked(stream)
Dan Fandrich75214cf2011-06-30 02:59:17 +0200200# undef getchar
Denys Vlasenkoaa3576a2016-08-22 19:54:12 +0200201# define getchar() getchar_unlocked()
Dan Fandrich75214cf2011-06-30 02:59:17 +0200202# undef putc
Denys Vlasenkoaa3576a2016-08-22 19:54:12 +0200203# define putc(c,stream) putc_unlocked(c,stream)
Dan Fandrich75214cf2011-06-30 02:59:17 +0200204# undef putchar
Denys Vlasenkoaa3576a2016-08-22 19:54:12 +0200205# define putchar(c) putchar_unlocked(c)
Dan Fandrich75214cf2011-06-30 02:59:17 +0200206# undef fgetc
Denys Vlasenkoaa3576a2016-08-22 19:54:12 +0200207# define fgetc(stream) getc_unlocked(stream)
Dan Fandrich75214cf2011-06-30 02:59:17 +0200208# undef fputc
Denys Vlasenkoaa3576a2016-08-22 19:54:12 +0200209# define fputc(c,stream) putc_unlocked(c,stream)
Dan Fandrich75214cf2011-06-30 02:59:17 +0200210#endif
Denys Vlasenko0c4cf422011-06-30 02:44:27 +0200211/* Above functions are required by POSIX.1-2008, below ones are extensions */
Dan Fandrich75214cf2011-06-30 02:59:17 +0200212#ifdef HAVE_UNLOCKED_LINE_OPS
213# undef fgets
Denys Vlasenkoaa3576a2016-08-22 19:54:12 +0200214# define fgets(s,n,stream) fgets_unlocked(s,n,stream)
Dan Fandrich75214cf2011-06-30 02:59:17 +0200215# undef fputs
Denys Vlasenkoaa3576a2016-08-22 19:54:12 +0200216# define fputs(s,stream) fputs_unlocked(s,stream)
Denys Vlasenko0ae05092016-09-18 21:49:30 +0200217/* musl <= 1.1.15 does not support fflush_unlocked(NULL) */
218//# undef fflush
219//# define fflush(stream) fflush_unlocked(stream)
Denys Vlasenkoaa3576a2016-08-22 19:54:12 +0200220# undef feof
221# define feof(stream) feof_unlocked(stream)
222# undef ferror
223# define ferror(stream) ferror_unlocked(stream)
224# undef fileno
225# define fileno(stream) fileno_unlocked(stream)
Dan Fandrich75214cf2011-06-30 02:59:17 +0200226#endif
Denys Vlasenko06448912011-06-20 10:06:28 +0200227
228
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000229/* Make all declarations hidden (-fvisibility flag only affects definitions) */
230/* (don't include system headers after this until corresponding pop!) */
Denis Vlasenkof81e8db2009-04-09 12:35:13 +0000231PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000232
233
234#if ENABLE_USE_BB_PWD_GRP
235# include "pwd_.h"
236# include "grp_.h"
237#endif
238#if ENABLE_FEATURE_SHADOWPASSWDS
239# if ENABLE_USE_BB_SHADOW
240# include "shadow_.h"
241# endif
242#endif
243
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000244/* Tested to work correctly with all int types (IIRC :]) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000245#define MAXINT(T) (T)( \
246 ((T)-1) > 0 \
247 ? (T)-1 \
248 : (T)~((T)1 << (sizeof(T)*8-1)) \
249 )
250
251#define MININT(T) (T)( \
252 ((T)-1) > 0 \
253 ? (T)0 \
254 : ((T)1 << (sizeof(T)*8-1)) \
255 )
Denis Vlasenko7039a662006-10-08 17:54:47 +0000256
Denis Vlasenko56254152006-10-07 16:24:46 +0000257/* Large file support */
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000258/* Note that CONFIG_LFS=y forces bbox to be built with all common ops
Denis Vlasenko7039a662006-10-08 17:54:47 +0000259 * (stat, lseek etc) mapped to "largefile" variants by libc.
260 * Practically it means that open() automatically has O_LARGEFILE added
261 * and all filesize/file_offset parameters and struct members are "large"
262 * (in today's world - signed 64bit). For full support of large files,
263 * we need a few helper #defines (below) and careful use of off_t
264 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000265#if ENABLE_LFS
Denis Vlasenko7039a662006-10-08 17:54:47 +0000266/* CONFIG_LFS is on */
267# if ULONG_MAX > 0xffffffff
268/* "long" is long enough on this system */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000269typedef unsigned long uoff_t;
Denys Vlasenkof59a50e2011-11-16 21:30:19 +0100270# define XATOOFF(a) xatoul_range((a), 0, LONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000271/* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
272# define BB_STRTOOFF bb_strtoul
273# define STRTOOFF strtoul
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000274/* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
275# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000276# else
Denis Vlasenkocba9ef52006-10-10 21:00:47 +0000277/* "long" is too short, need "long long" */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000278typedef unsigned long long uoff_t;
Denys Vlasenkof59a50e2011-11-16 21:30:19 +0100279# define XATOOFF(a) xatoull_range((a), 0, LLONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000280# define BB_STRTOOFF bb_strtoull
281# define STRTOOFF strtoull
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000282# define OFF_FMT "ll"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000283# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000284#else
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000285/* CONFIG_LFS is off */
286# if UINT_MAX == 0xffffffff
287/* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
288 * gcc will throw warnings on printf("%d", off_t). Crap... */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000289typedef unsigned long uoff_t;
Denys Vlasenko77832482010-08-12 14:14:45 +0200290# define XATOOFF(a) xatoi_positive(a)
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000291# define BB_STRTOOFF bb_strtou
Denis Vlasenko7039a662006-10-08 17:54:47 +0000292# define STRTOOFF strtol
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000293# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000294# else
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000295typedef unsigned long uoff_t;
Denys Vlasenkof59a50e2011-11-16 21:30:19 +0100296# define XATOOFF(a) xatoul_range((a), 0, LONG_MAX)
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000297# define BB_STRTOOFF bb_strtoul
Denis Vlasenko7039a662006-10-08 17:54:47 +0000298# define STRTOOFF strtol
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000299# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000300# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000301#endif
302/* scary. better ideas? (but do *test* them first!) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000303#define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
Denys Vlasenko1dc80ba2011-11-17 21:51:32 +0100304/* Users report bionic to use 32-bit off_t even if LARGEFILE support is requested.
Denys Vlasenko5fa5c4b2020-06-23 21:28:19 +0200305 * On musl, !ENABLE_LFS on 32-bit arches thinks that off_t is 32-bit.
Denys Vlasenko1dc80ba2011-11-17 21:51:32 +0100306 * We misdetected that. Don't let it build:
307 */
308struct BUG_off_t_size_is_misdetected {
309 char BUG_off_t_size_is_misdetected[sizeof(off_t) == sizeof(uoff_t) ? 1 : -1];
310};
Denis Vlasenko56254152006-10-07 16:24:46 +0000311
Eric Andersenaad1a882001-03-16 22:47:14 +0000312/* Some useful definitions */
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000313#undef FALSE
Eric Andersenaad1a882001-03-16 22:47:14 +0000314#define FALSE ((int) 0)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000315#undef TRUE
Eric Andersenaad1a882001-03-16 22:47:14 +0000316#define TRUE ((int) 1)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000317#undef SKIP
Eric Andersenaad1a882001-03-16 22:47:14 +0000318#define SKIP ((int) 2)
319
Eric Andersenaad1a882001-03-16 22:47:14 +0000320/* Macros for min/max. */
321#ifndef MIN
Denys Vlasenkoe4dcba12010-10-28 18:57:19 +0200322#define MIN(a,b) (((a)<(b))?(a):(b))
Eric Andersenaad1a882001-03-16 22:47:14 +0000323#endif
324
325#ifndef MAX
Denys Vlasenkoe4dcba12010-10-28 18:57:19 +0200326#define MAX(a,b) (((a)>(b))?(a):(b))
Eric Andersenaad1a882001-03-16 22:47:14 +0000327#endif
328
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000329/* buffer allocation schemes */
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000330#if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000331#define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000332#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
333#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
334#else
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000335#if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000336#define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
337#define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
338#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
339#else
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000340#define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer = xmalloc(len)
341#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
342#define RELEASE_CONFIG_BUFFER(buffer) free(buffer)
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000343#endif
344#endif
345
Denys Vlasenkob1c7a662020-10-01 00:34:44 +0200346#if defined(errno)
347/* If errno is a define, assume it's "define errno (*__errno_location())"
348 * and we will cache it's result in this variable */
Denis Vlasenkofad2b862007-05-31 22:16:38 +0000349extern int *const bb_errno;
350#undef errno
351#define errno (*bb_errno)
Denys Vlasenkob1c7a662020-10-01 00:34:44 +0200352#define bb_cached_errno_ptr 1
Denis Vlasenkofad2b862007-05-31 22:16:38 +0000353#endif
354
Denys Vlasenko9ff50b82010-10-18 11:40:26 +0200355#if !(ULONG_MAX > 0xffffffff)
356/* Only 32-bit CPUs need this, 64-bit ones use inlined version */
357uint64_t bb_bswap_64(uint64_t x) FAST_FUNC;
358#endif
359
Denys Vlasenko8a134ec2017-04-11 07:34:56 +0200360unsigned long FAST_FUNC isqrt(unsigned long long N);
361
Denis Vlasenkoce13b762008-06-29 02:25:53 +0000362unsigned long long monotonic_ns(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000363unsigned long long monotonic_us(void) FAST_FUNC;
Denys Vlasenkof2c8aa62010-01-12 12:52:30 +0100364unsigned long long monotonic_ms(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000365unsigned monotonic_sec(void) FAST_FUNC;
Manuel Novoa III cad53642003-03-19 09:13:01 +0000366
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000367extern void chomp(char *s) FAST_FUNC;
Denys Vlasenko20077c12017-08-05 17:50:35 +0200368extern char *trim(char *s) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000369extern char *skip_whitespace(const char *) FAST_FUNC;
370extern char *skip_non_whitespace(const char *) FAST_FUNC;
Denys Vlasenkof8d8aa12010-04-06 18:50:05 +0200371extern char *skip_dev_pfx(const char *tty_name) FAST_FUNC;
372
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000373extern char *strrstr(const char *haystack, const char *needle) FAST_FUNC;
Paul Fox0b621582005-08-09 19:38:05 +0000374
Denys Vlasenko9a647c32017-01-23 01:08:16 +0100375/* dmalloc will redefine these to it's own implementation. It is safe
376 * to have the prototypes here unconditionally. */
377void *malloc_or_warn(size_t size) FAST_FUNC RETURNS_MALLOC;
378void *xmalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
379void *xzalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
380void *xrealloc(void *old, size_t size) FAST_FUNC;
381/* After v = xrealloc_vector(v, SHIFT, idx) it's ok to use
382 * at least v[idx] and v[idx+1], for all idx values.
383 * SHIFT specifies how many new elements are added (1:2, 2:4, ..., 8:256...)
384 * when all elements are used up. New elements are zeroed out.
385 * xrealloc_vector(v, SHIFT, idx) *MUST* be called with consecutive IDXs -
386 * skipping an index is a bad bug - it may miss a realloc!
387 */
388#define xrealloc_vector(vector, shift, idx) \
389 xrealloc_vector_helper((vector), (sizeof((vector)[0]) << 8) + (shift), (idx))
390void* xrealloc_vector_helper(void *vector, unsigned sizeof_and_shift, int idx) FAST_FUNC;
391char *xstrdup(const char *s) FAST_FUNC RETURNS_MALLOC;
392char *xstrndup(const char *s, int n) FAST_FUNC RETURNS_MALLOC;
393void *xmemdup(const void *s, int n) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkofd3c5122020-12-14 18:25:28 +0100394void *mmap_read(int fd, size_t size) FAST_FUNC;
395void *mmap_anon(size_t size) FAST_FUNC;
396void *xmmap_anon(size_t size) FAST_FUNC;
Denys Vlasenko9a647c32017-01-23 01:08:16 +0100397
Denys Vlasenkoc7b858f2020-12-14 18:49:23 +0100398#if defined(__x86_64__) || defined(i386)
399# define BB_ARCH_FIXED_PAGESIZE 4096
Denys Vlasenko01004f92020-12-15 21:24:04 +0100400#elif defined(__arm__) /* only 32bit, 64bit ARM has variable page size */
401# define BB_ARCH_FIXED_PAGESIZE 4096
Denys Vlasenkoc7b858f2020-12-14 18:49:23 +0100402#else /* if defined(ARCH) */
403/* add you favorite arch today! */
Denys Vlasenko01004f92020-12-15 21:24:04 +0100404//From Linux kernel inspection:
405//xtenza,s390[x],riscv,nios2,csky,sparc32: fixed 4k pages
406//sparc64,alpha,openrisc: fixed 8k pages
Denys Vlasenkoc7b858f2020-12-14 18:49:23 +0100407#endif
408
409#if defined BB_ARCH_FIXED_PAGESIZE
410# define IF_VARIABLE_ARCH_PAGESIZE(...) /*nothing*/
411# define bb_getpagesize() BB_ARCH_FIXED_PAGESIZE
412# define INIT_PAGESIZE(var) ((void)0)
413# define cached_pagesize(var) BB_ARCH_FIXED_PAGESIZE
414#else
415# define IF_VARIABLE_ARCH_PAGESIZE(...) __VA_ARGS__
416# define bb_getpagesize() getpagesize()
417# define INIT_PAGESIZE(var) ((var) = getpagesize())
418# define cached_pagesize(var) (var)
419#endif
420
Denys Vlasenko9a647c32017-01-23 01:08:16 +0100421
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +0000422//TODO: supply a pointer to char[11] buffer (avoid statics)?
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000423extern const char *bb_mode_string(mode_t mode) FAST_FUNC;
Denys Vlasenkof282c6b2011-12-18 03:27:46 +0100424extern int is_directory(const char *name, int followLinks) FAST_FUNC;
Denys Vlasenko877dedb2016-05-27 00:46:38 +0200425enum { /* cp.c, mv.c, install.c depend on these values. CAREFUL when changing them! */
Denys Vlasenkoa40f0622010-01-15 22:05:07 +0100426 FILEUTILS_PRESERVE_STATUS = 1 << 0, /* -p */
427 FILEUTILS_DEREFERENCE = 1 << 1, /* !-d */
428 FILEUTILS_RECUR = 1 << 2, /* -R */
429 FILEUTILS_FORCE = 1 << 3, /* -f */
430 FILEUTILS_INTERACTIVE = 1 << 4, /* -i */
431 FILEUTILS_MAKE_HARDLINK = 1 << 5, /* -l */
432 FILEUTILS_MAKE_SOFTLINK = 1 << 6, /* -s */
433 FILEUTILS_DEREF_SOFTLINK = 1 << 7, /* -L */
434 FILEUTILS_DEREFERENCE_L0 = 1 << 8, /* -H */
Denys Vlasenko877dedb2016-05-27 00:46:38 +0200435 /* -a = -pdR (mapped in cp.c) */
436 /* -r = -dR (mapped in cp.c) */
437 /* -P = -d (mapped in cp.c) */
438 FILEUTILS_VERBOSE = (1 << 12) * ENABLE_FEATURE_VERBOSE, /* -v */
439 FILEUTILS_UPDATE = 1 << 13, /* -u */
Aaro Koskinend15d7a02018-02-01 09:29:05 +0100440 FILEUTILS_NO_TARGET_DIR = 1 << 14, /* -T */
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000441#if ENABLE_SELINUX
Aaro Koskinend15d7a02018-02-01 09:29:05 +0100442 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 1 << 15, /* -c */
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000443#endif
Aaro Koskinend15d7a02018-02-01 09:29:05 +0100444 FILEUTILS_RMDEST = 1 << (16 - !ENABLE_SELINUX), /* --remove-destination */
Denys Vlasenko79fb6ac2018-07-13 20:30:02 +0200445 /* bit 17 skipped for "cp --parents" */
446 FILEUTILS_REFLINK = 1 << (18 - !ENABLE_SELINUX), /* cp --reflink=auto */
447 FILEUTILS_REFLINK_ALWAYS = 1 << (19 - !ENABLE_SELINUX), /* cp --reflink[=always] */
Denys Vlasenko877dedb2016-05-27 00:46:38 +0200448 /*
449 * Hole. cp may have some bits set here,
450 * they should not affect remove_file()/copy_file()
451 */
452#if ENABLE_SELINUX
453 FILEUTILS_SET_SECURITY_CONTEXT = 1 << 30,
454#endif
455 FILEUTILS_IGNORE_CHMOD_ERR = 1 << 31,
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000456};
Aaro Koskinend15d7a02018-02-01 09:29:05 +0100457#define FILEUTILS_CP_OPTSTR "pdRfilsLHarPvuT" IF_SELINUX("c")
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000458extern int remove_file(const char *path, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000459/* NB: without FILEUTILS_RECUR in flags, it will basically "cat"
460 * the source, not copy (unless "source" is a directory).
461 * This makes "cp /dev/null file" and "install /dev/null file" (!!!)
462 * work coreutils-compatibly. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000463extern int copy_file(const char *source, const char *dest, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000464
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000465enum {
Denis Vlasenkod166f832007-07-05 00:12:55 +0000466 ACTION_RECURSE = (1 << 0),
467 ACTION_FOLLOWLINKS = (1 << 1),
468 ACTION_FOLLOWLINKS_L0 = (1 << 2),
469 ACTION_DEPTHFIRST = (1 << 3),
Denys Vlasenko3c3928f2020-10-01 20:27:28 +0200470 ACTION_QUIET = (1 << 4),
471 ACTION_DANGLING_OK = (1 << 5),
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000472};
Denys Vlasenko8f7a6d22009-09-29 11:07:04 +0200473typedef uint8_t recurse_flags_t;
Denys Vlasenko689d0652020-10-01 21:52:16 +0200474typedef struct recursive_state {
475 unsigned flags;
476 unsigned depth;
477 void *userData;
478 int FAST_FUNC (*fileAction)(struct recursive_state *state, const char *fileName, struct stat* statbuf);
479 int FAST_FUNC (*dirAction)(struct recursive_state *state, const char *fileName, struct stat* statbuf);
480} recursive_state_t;
481int recursive_action(const char *fileName, unsigned flags,
482 int FAST_FUNC (*fileAction)(struct recursive_state *state, const char *fileName, struct stat* statbuf),
483 int FAST_FUNC (*dirAction)(struct recursive_state *state, const char *fileName, struct stat* statbuf),
484 void *userData
485) FAST_FUNC;
Denys Vlasenko3c3928f2020-10-01 20:27:28 +0200486
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000487extern int device_open(const char *device, int mode) FAST_FUNC;
Denis Vlasenko85c24712008-03-17 09:04:04 +0000488enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000489extern int xgetpty(char *line) FAST_FUNC;
Denis Vlasenko2afd5ab2008-08-05 23:32:27 +0000490extern int get_console_fd_or_die(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000491extern void console_make_active(int fd, const int vt_num) FAST_FUNC;
492extern char *find_block_device(const char *path) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000493/* bb_copyfd_XX print read/write errors and return -1 if they occur */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000494extern off_t bb_copyfd_eof(int fd1, int fd2) FAST_FUNC;
495extern off_t bb_copyfd_size(int fd1, int fd2, off_t size) FAST_FUNC;
496extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000497/* "short" copy can be detected by return value < size */
498/* this helper yells "short read!" if param is not -1 */
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000499extern void complain_copyfd_and_die(off_t sz) NORETURN FAST_FUNC;
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +0200500
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000501extern char bb_process_escape_sequence(const char **ptr) FAST_FUNC;
Denys Vlasenko53600592010-10-23 21:06:06 +0200502char* strcpy_and_process_escape_sequences(char *dst, const char *src) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000503/* xxxx_strip version can modify its parameter:
504 * "/" -> "/"
505 * "abc" -> "abc"
506 * "abc/def" -> "def"
507 * "abc/def/" -> "def" !!
508 */
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +0200509char *bb_get_last_path_component_strip(char *path) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000510/* "abc/def/" -> "" and it never modifies 'path' */
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +0200511char *bb_get_last_path_component_nostrip(const char *path) FAST_FUNC;
512/* Simpler version: does not special case "/" string */
513const char *bb_basename(const char *name) FAST_FUNC;
514/* NB: can violate const-ness (similarly to strchr) */
515char *last_char_is(const char *s, int c) FAST_FUNC;
Denys Vlasenko1961aea2013-02-26 00:36:53 +0100516const char* endofname(const char *name) FAST_FUNC;
Denys Vlasenko8dff01d2015-03-12 17:48:34 +0100517char *is_prefixed_with(const char *string, const char *key) FAST_FUNC;
Bartosz Golaszewski7448b512015-08-25 16:36:43 +0200518char *is_suffixed_with(const char *string, const char *key) FAST_FUNC;
Denis Vlasenkocad04ef2007-03-25 23:21:05 +0000519
Denys Vlasenkod6e76722014-09-22 21:14:02 +0200520int ndelay_on(int fd) FAST_FUNC;
521int ndelay_off(int fd) FAST_FUNC;
Denys Vlasenkoe9a40e32011-01-24 00:29:55 +0100522void close_on_exec_on(int fd) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000523void xdup2(int, int) FAST_FUNC;
524void xmove_fd(int, int) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000525
526
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000527DIR *xopendir(const char *path) FAST_FUNC;
528DIR *warn_opendir(const char *path) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000529
Jérémie Koenigfbedacf2010-03-26 19:08:53 +0100530char *xmalloc_realpath(const char *path) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko74716212018-05-24 17:29:14 +0200531char *xmalloc_realpath_coreutils(const char *path) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100532char *xmalloc_readlink(const char *path) FAST_FUNC RETURNS_MALLOC;
533char *xmalloc_readlink_or_warn(const char *path) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkob57eee82009-11-04 17:54:17 +0100534/* !RETURNS_MALLOC: it's a realloc-like function */
535char *xrealloc_getcwd_or_warn(char *cwd) FAST_FUNC;
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000536
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100537char *xmalloc_follow_symlinks(const char *path) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko473dae02007-04-11 07:04:23 +0000538
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000539
Denis Vlasenko33196372008-02-23 01:25:38 +0000540enum {
Denis Vlasenkocf7cf622008-03-19 19:38:46 +0000541 /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
Denis Vlasenko33196372008-02-23 01:25:38 +0000542 * otherwise would kill us, except for those resulting from bugs:
543 * SIGSEGV, SIGILL, SIGFPE.
544 * Other fatal signals not included (TODO?):
545 * SIGBUS Bus error (bad memory access)
546 * SIGPOLL Pollable event. Synonym of SIGIO
547 * SIGPROF Profiling timer expired
548 * SIGSYS Bad argument to routine
549 * SIGTRAP Trace/breakpoint trap
Denis Vlasenkod943af02008-03-30 15:56:38 +0000550 *
551 * The only known arch with some of these sigs not fitting
552 * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
553 * Dance around with long long to guard against that...
Denis Vlasenko33196372008-02-23 01:25:38 +0000554 */
Denis Vlasenkod943af02008-03-30 15:56:38 +0000555 BB_FATAL_SIGS = (int)(0
556 + (1LL << SIGHUP)
557 + (1LL << SIGINT)
558 + (1LL << SIGTERM)
559 + (1LL << SIGPIPE) // Write to pipe with no readers
560 + (1LL << SIGQUIT) // Quit from keyboard
561 + (1LL << SIGABRT) // Abort signal from abort(3)
562 + (1LL << SIGALRM) // Timer signal from alarm(2)
563 + (1LL << SIGVTALRM) // Virtual alarm clock
564 + (1LL << SIGXCPU) // CPU time limit exceeded
565 + (1LL << SIGXFSZ) // File size limit exceeded
566 + (1LL << SIGUSR1) // Yes kids, these are also fatal!
567 + (1LL << SIGUSR2)
568 + 0),
Denis Vlasenko33196372008-02-23 01:25:38 +0000569};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000570void bb_signals(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko25591c32008-02-16 22:58:56 +0000571/* Unlike signal() and bb_signals, sets handler with sigaction()
572 * and in a way that while signal handler is run, no other signals
Denis Vlasenkocab28aa2009-01-31 01:02:07 +0000573 * will be blocked; syscalls will not be restarted: */
574void bb_signals_recursive_norestart(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000575/* syscalls like read() will be interrupted with EINTR: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000576void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000577/* syscalls like read() won't be interrupted (though select/poll will be): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000578void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
579void wait_for_any_sig(void) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000580void kill_myself_with_sig(int sig) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000581void sig_block(int sig) FAST_FUNC;
582void sig_unblock(int sig) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000583/* Will do sigaction(signum, act, NULL): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000584int sigaction_set(int sig, const struct sigaction *act) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000585/* SIG_BLOCK/SIG_UNBLOCK all signals: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000586int sigprocmask_allsigs(int how) FAST_FUNC;
Denys Vlasenkob437df12018-12-08 15:35:24 +0100587/* Return old set in the same set: */
588int sigprocmask2(int how, sigset_t *set) FAST_FUNC;
Denis Vlasenko08ea11a2008-09-11 19:51:11 +0000589/* Standard handler which just records signo */
590extern smallint bb_got_signal;
591void record_signo(int signo); /* not FAST_FUNC! */
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000592
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000593
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000594void xsetgid(gid_t gid) FAST_FUNC;
595void xsetuid(uid_t uid) FAST_FUNC;
Ryan Mallon5906a5c2013-10-08 14:52:49 +0200596void xsetegid(gid_t egid) FAST_FUNC;
597void xseteuid(uid_t euid) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000598void xchdir(const char *path) FAST_FUNC;
Denys Vlasenkoc4199f22016-04-01 22:12:44 +0200599void xfchdir(int fd) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000600void xchroot(const char *path) FAST_FUNC;
601void xsetenv(const char *key, const char *value) FAST_FUNC;
Denis Vlasenko76ddc2e2008-12-30 05:05:31 +0000602void bb_unsetenv(const char *key) FAST_FUNC;
Denys Vlasenkodd8adde2010-06-24 05:00:50 +0200603void bb_unsetenv_and_free(char *key) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000604void xunlink(const char *pathname) FAST_FUNC;
605void xstat(const char *pathname, struct stat *buf) FAST_FUNC;
Denys Vlasenko8d3e2252010-08-31 12:42:06 +0200606void xfstat(int fd, struct stat *buf, const char *errmsg) FAST_FUNC;
Ryan Mallon5906a5c2013-10-08 14:52:49 +0200607int open3_or_warn(const char *pathname, int flags, int mode) FAST_FUNC;
608int open_or_warn(const char *pathname, int flags) FAST_FUNC;
609int xopen3(const char *pathname, int flags, int mode) FAST_FUNC;
Denys Vlasenkof2a8d5d2009-08-21 17:40:36 +0200610int xopen(const char *pathname, int flags) FAST_FUNC;
Bernhard Reutner-Fischera4830872009-10-26 23:27:08 +0100611int xopen_nonblocking(const char *pathname) FAST_FUNC;
Ryan Mallon5906a5c2013-10-08 14:52:49 +0200612int xopen_as_uid_gid(const char *pathname, int flags, uid_t u, gid_t g) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000613int open_or_warn_stdin(const char *pathname) FAST_FUNC;
Denys Vlasenkoe7b0a9e2010-08-22 05:39:15 +0200614int xopen_stdin(const char *pathname) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000615void xrename(const char *oldpath, const char *newpath) FAST_FUNC;
616int rename_or_warn(const char *oldpath, const char *newpath) FAST_FUNC;
617off_t xlseek(int fd, off_t offset, int whence) FAST_FUNC;
Alexander Shishkin67227372010-10-22 13:27:16 +0200618int xmkstemp(char *template) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000619off_t fdlength(int fd) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000620
Denys Vlasenko40e7d252010-02-01 23:48:27 +0100621uoff_t FAST_FUNC get_volume_size_in_bytes(int fd,
Denys Vlasenko982e87f2013-07-30 11:52:58 +0200622 const char *override,
623 unsigned override_units,
624 int extend);
Denys Vlasenko40e7d252010-02-01 23:48:27 +0100625
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000626void xpipe(int filedes[2]) FAST_FUNC;
Denis Vlasenko37188322008-02-16 13:20:56 +0000627/* In this form code with pipes is much more readable */
628struct fd_pair { int rd; int wr; };
629#define piped_pair(pair) pipe(&((pair).rd))
630#define xpiped_pair(pair) xpipe(&((pair).rd))
631
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000632/* Useful for having small structure members/global variables */
633typedef int8_t socktype_t;
634typedef int8_t family_t;
635struct BUG_too_small {
636 char BUG_socktype_t_too_small[(0
637 | SOCK_STREAM
638 | SOCK_DGRAM
639 | SOCK_RDM
640 | SOCK_SEQPACKET
641 | SOCK_RAW
642 ) <= 127 ? 1 : -1];
643 char BUG_family_t_too_small[(0
644 | AF_UNSPEC
645 | AF_INET
646 | AF_INET6
647 | AF_UNIX
Mike Frysinger9412ec72008-02-07 22:41:33 +0000648#ifdef AF_PACKET
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000649 | AF_PACKET
Mike Frysinger9412ec72008-02-07 22:41:33 +0000650#endif
651#ifdef AF_NETLINK
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000652 | AF_NETLINK
Mike Frysinger9412ec72008-02-07 22:41:33 +0000653#endif
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000654 /* | AF_DECnet */
655 /* | AF_IPX */
656 ) <= 127 ? 1 : -1];
657};
658
659
Denys Vlasenkodc698bb2010-01-09 19:10:49 +0100660void parse_datestr(const char *date_str, struct tm *ptm) FAST_FUNC;
661time_t validate_tm_time(const char *date_str, struct tm *ptm) FAST_FUNC;
Denys Vlasenko8f2cb7a2013-03-29 12:30:33 +0100662char *strftime_HHMMSS(char *buf, unsigned len, time_t *tp) FAST_FUNC;
663char *strftime_YYYYMMDDHHMMSS(char *buf, unsigned len, time_t *tp) FAST_FUNC;
Denys Vlasenko3c13da32020-12-30 23:48:01 +0100664void xgettimeofday(struct timeval *tv) FAST_FUNC;
Denys Vlasenkoeb0c2e22020-12-16 21:36:36 +0100665void xsettimeofday(const struct timeval *tv) FAST_FUNC;
666
Denys Vlasenko73b71f32009-07-18 03:40:35 +0200667
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000668int xsocket(int domain, int type, int protocol) FAST_FUNC;
669void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen) FAST_FUNC;
670void xlisten(int s, int backlog) FAST_FUNC;
671void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen) FAST_FUNC;
Denis Vlasenkodbe6e662007-08-14 16:43:01 +0000672ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000673 socklen_t tolen) FAST_FUNC;
Denys Vlasenkoc52cbea2015-08-24 19:48:03 +0200674
675int setsockopt_int(int fd, int level, int optname, int optval) FAST_FUNC;
676int setsockopt_1(int fd, int level, int optname) FAST_FUNC;
677int setsockopt_SOL_SOCKET_int(int fd, int optname, int optval) FAST_FUNC;
678int setsockopt_SOL_SOCKET_1(int fd, int optname) FAST_FUNC;
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000679/* SO_REUSEADDR allows a server to rebind to an address that is already
680 * "in use" by old connections to e.g. previous server instance which is
681 * killed or crashed. Without it bind will fail until all such connections
682 * time out. Linux does not allow multiple live binds on same ip:port
683 * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
684 * Turn it on before you call bind(). */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000685void setsockopt_reuseaddr(int fd) FAST_FUNC; /* On Linux this never fails. */
Denys Vlasenkoc52cbea2015-08-24 19:48:03 +0200686int setsockopt_keepalive(int fd) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000687int setsockopt_broadcast(int fd) FAST_FUNC;
Denis Vlasenkoe5373852008-12-10 11:12:16 +0000688int setsockopt_bindtodevice(int fd, const char *iface) FAST_FUNC;
Denys Vlasenkoba3b9db2018-02-11 14:55:46 +0100689int bb_getsockname(int sockfd, void *addr, socklen_t addrlen) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000690/* NB: returns port in host byte order */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000691unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port) FAST_FUNC;
Denys Vlasenko2aeb2012018-04-17 12:43:54 +0200692#if ENABLE_FEATURE_ETC_SERVICES
693# define bb_lookup_std_port(portstr, protocol, portnum) bb_lookup_port(portstr, protocol, portnum)
694#else
695# define bb_lookup_std_port(portstr, protocol, portnum) (portnum)
696#endif
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000697typedef struct len_and_sockaddr {
Denis Vlasenko0850cda2007-02-07 23:20:32 +0000698 socklen_t len;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000699 union {
700 struct sockaddr sa;
701 struct sockaddr_in sin;
702#if ENABLE_FEATURE_IPV6
703 struct sockaddr_in6 sin6;
704#endif
Bernhard Reutner-Fischer8c69afd2008-01-29 10:33:34 +0000705 } u;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000706} len_and_sockaddr;
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000707enum {
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000708 LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000709 LSA_SIZEOF_SA = sizeof(
710 union {
711 struct sockaddr sa;
712 struct sockaddr_in sin;
713#if ENABLE_FEATURE_IPV6
714 struct sockaddr_in6 sin6;
715#endif
716 }
717 )
718};
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000719/* Create stream socket, and allocate suitable lsa.
720 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
Denis Vlasenkobeffd432007-09-05 11:30:34 +0000721 * af == AF_UNSPEC will result in trying to create IPv6 socket,
Denys Vlasenkob1278a32009-11-24 16:03:47 +0100722 * and if kernel doesn't support it, fall back to IPv4.
723 * This is useful if you plan to bind to resulting local lsa.
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000724 */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000725int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000726int xsocket_stream(len_and_sockaddr **lsap) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000727/* Create server socket bound to bindaddr:port. bindaddr can be NULL,
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000728 * numeric IP ("N.N.N.N") or numeric IPv6 address,
729 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000730 * Only if there is no suffix, port argument is used */
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000731/* NB: these set SO_REUSEADDR before bind */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000732int create_and_bind_stream_or_die(const char *bindaddr, int port) FAST_FUNC;
733int create_and_bind_dgram_or_die(const char *bindaddr, int port) FAST_FUNC;
Denys Vlasenko45e39672019-06-03 14:16:52 +0200734int create_and_bind_to_netlink(int proto, int grp, unsigned rcvbuf) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000735/* Create client TCP socket connected to peer:port. Peer cannot be NULL.
736 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
737 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
738 * If there is no suffix, port argument is used */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000739int create_and_connect_stream_or_die(const char *peer, int port) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000740/* Connect to peer identified by lsa */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000741int xconnect_stream(const len_and_sockaddr *lsa) FAST_FUNC;
Denis Vlasenko73c571a2009-03-09 00:12:37 +0000742/* Get local address of bound or accepted socket */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100743len_and_sockaddr *get_sock_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkof6916db2010-04-06 17:43:29 +0200744/* Get remote address of connected or accepted socket */
745len_and_sockaddr *get_peer_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000746/* Return malloc'ed len_and_sockaddr with socket address of host:port
747 * Currently will return IPv4 or IPv6 sockaddrs only
748 * (depending on host), but in theory nothing prevents e.g.
Denis Vlasenko5870ad92007-02-04 02:39:55 +0000749 * UNIX socket address being returned, IPX sockaddr etc...
750 * On error does bb_error_msg and returns NULL */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100751len_and_sockaddr* host2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000752/* Version which dies on error */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100753len_and_sockaddr* xhost2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
754len_and_sockaddr* xdotted2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000755/* Same, useful if you want to force family (e.g. IPv6) */
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000756#if !ENABLE_FEATURE_IPV6
757#define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
758#define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
759#else
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100760len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
761len_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 +0000762#endif
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000763/* Assign sin[6]_port member if the socket is an AF_INET[6] one,
Denis Vlasenko85629f02007-01-22 09:36:41 +0000764 * otherwise no-op. Useful for ftp.
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000765 * NB: does NOT do htons() internally, just direct assignment. */
Denys Vlasenkoca183112011-04-07 17:52:20 +0200766void set_nport(struct sockaddr *sa, unsigned port) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000767/* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000768int get_nport(const struct sockaddr *sa) FAST_FUNC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000769/* Reverse DNS. Returns NULL on failure. */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100770char* xmalloc_sockaddr2host(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000771/* This one doesn't append :PORTNUM */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100772char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000773/* This one also doesn't fall back to dotted IP (returns NULL) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100774char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko448f0242007-01-22 22:43:05 +0000775/* inet_[ap]ton on steroids */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100776char* xmalloc_sockaddr2dotted(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
777char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000778// "old" (ipv4 only) API
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000779// users: traceroute.c hostname.c - use _list_ of all IPs
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000780struct hostent *xgethostbyname(const char *name) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000781// Also mount.c and inetd.c are using gethostbyname(),
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000782// + inet_common.c has additional IPv4-only stuff
Denis Vlasenkoc8717cd2006-11-22 16:10:39 +0000783
Denys Vlasenko49ecee02017-01-24 16:00:54 +0100784
Denys Vlasenko83e5c622018-11-23 17:21:38 +0100785struct tls_aes {
786 uint32_t key[60];
787 unsigned rounds;
788};
Denys Vlasenko49ecee02017-01-24 16:00:54 +0100789#define TLS_MAX_MAC_SIZE 32
790#define TLS_MAX_KEY_SIZE 32
Denys Vlasenko83e5c622018-11-23 17:21:38 +0100791#define TLS_MAX_IV_SIZE 4
Denys Vlasenko9a647c32017-01-23 01:08:16 +0100792struct tls_handshake_data; /* opaque */
793typedef struct tls_state {
Denys Vlasenko83e5c622018-11-23 17:21:38 +0100794 unsigned flags;
795
Denys Vlasenko49ecee02017-01-24 16:00:54 +0100796 int ofd;
797 int ifd;
Denys Vlasenko9a647c32017-01-23 01:08:16 +0100798
Denys Vlasenko89193f92017-01-24 18:08:07 +0100799 unsigned min_encrypted_len_on_read;
Denys Vlasenko49ecee02017-01-24 16:00:54 +0100800 uint16_t cipher_id;
Denys Vlasenko49ecee02017-01-24 16:00:54 +0100801 unsigned MAC_size;
802 unsigned key_size;
Denys Vlasenko83e5c622018-11-23 17:21:38 +0100803 unsigned IV_size;
Denys Vlasenko9a647c32017-01-23 01:08:16 +0100804
805 uint8_t *outbuf;
806 int outbuf_size;
807
808 int inbuf_size;
809 int ofs_to_buffered;
810 int buffered_size;
811 uint8_t *inbuf;
812
813 struct tls_handshake_data *hsd;
814
815 // RFC 5246
816 // sequence number
817 // Each connection state contains a sequence number, which is
818 // maintained separately for read and write states. The sequence
819 // number MUST be set to zero whenever a connection state is made the
820 // active state. Sequence numbers are of type uint64 and may not
821 // exceed 2^64-1.
822 /*uint64_t read_seq64_be;*/
823 uint64_t write_seq64_be;
824
Denys Vlasenko83e5c622018-11-23 17:21:38 +0100825 /*uint8_t *server_write_MAC_key;*/
Denys Vlasenko49ecee02017-01-24 16:00:54 +0100826 uint8_t *client_write_key;
827 uint8_t *server_write_key;
Denys Vlasenko83e5c622018-11-23 17:21:38 +0100828 uint8_t *client_write_IV;
829 uint8_t *server_write_IV;
Denys Vlasenko49ecee02017-01-24 16:00:54 +0100830 uint8_t client_write_MAC_key[TLS_MAX_MAC_SIZE];
831 uint8_t server_write_MAC_k__[TLS_MAX_MAC_SIZE];
832 uint8_t client_write_k__[TLS_MAX_KEY_SIZE];
833 uint8_t server_write_k__[TLS_MAX_KEY_SIZE];
Denys Vlasenko83e5c622018-11-23 17:21:38 +0100834 uint8_t client_write_I_[TLS_MAX_IV_SIZE];
835 uint8_t server_write_I_[TLS_MAX_IV_SIZE];
836
837 struct tls_aes aes_encrypt;
838 struct tls_aes aes_decrypt;
839 uint8_t H[16]; //used by AES_GCM
Denys Vlasenko9a647c32017-01-23 01:08:16 +0100840} tls_state_t;
841
842static inline tls_state_t *new_tls_state(void)
843{
844 tls_state_t *tls = xzalloc(sizeof(*tls));
845 return tls;
846}
847void tls_handshake(tls_state_t *tls, const char *sni) FAST_FUNC;
Denys Vlasenko403f2992018-02-06 15:15:08 +0100848#define TLSLOOP_EXIT_ON_LOCAL_EOF (1 << 0)
849void tls_run_copy_loop(tls_state_t *tls, unsigned flags) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000850
Denys Vlasenko49ecee02017-01-24 16:00:54 +0100851
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000852void socket_want_pktinfo(int fd) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000853ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000854 const struct sockaddr *to,
855 const struct sockaddr *from,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000856 socklen_t tolen) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000857ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000858 struct sockaddr *from,
859 struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000860 socklen_t sa_size) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000861
Denys Vlasenko4a0eb032020-10-01 03:07:22 +0200862uint16_t inet_cksum(const void *addr, int len) FAST_FUNC;
Denys Vlasenko1783ffa2018-02-06 15:48:12 +0100863int parse_pasv_epsv(char *buf) FAST_FUNC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100864
Denys Vlasenkod4e4fdb2017-07-03 21:31:16 +0200865/* 0 if argv[0] is NULL: */
866unsigned string_array_len(char **argv) FAST_FUNC;
Denis Vlasenko0f293b92008-07-22 20:16:55 +0000867void overlapping_strcpy(char *dst, const char *src) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000868char *safe_strncpy(char *dst, const char *src, size_t size) FAST_FUNC;
Denis Vlasenko360d9662008-12-02 18:18:50 +0000869char *strncpy_IFNAMSIZ(char *dst, const char *src) FAST_FUNC;
Denys Vlasenko6f068902014-02-27 11:17:06 +0100870unsigned count_strstr(const char *str, const char *sub) FAST_FUNC;
871char *xmalloc_substitute_string(const char *src, int count, const char *sub, const char *repl) FAST_FUNC;
Denis Vlasenko4daad902007-09-27 10:20:47 +0000872/* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
Denis Vlasenko7c654ae2007-09-27 10:26:59 +0000873 * But potentially slow, don't use in one-billion-times loops */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000874int bb_putchar(int ch) FAST_FUNC;
Denys Vlasenko19ced5c2010-06-06 21:53:09 +0200875/* Note: does not use stdio, writes to fd 2 directly */
876int bb_putchar_stderr(char ch) FAST_FUNC;
Ron Yorstoncad3fc72021-02-03 20:47:14 +0100877int fputs_stdout(const char *s) FAST_FUNC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100878char *xasprintf(const char *format, ...) __attribute__ ((format(printf, 1, 2))) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkoe52da552015-10-09 17:59:56 +0200879char *auto_string(char *str) FAST_FUNC;
Denis Vlasenko9f739442006-12-16 23:49:13 +0000880// gcc-4.1.1 still isn't good enough at optimizing it
881// (+200 bytes compared to macro)
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000882//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000883//int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000884//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000885//int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000886#define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
Denis Vlasenko9f739442006-12-16 23:49:13 +0000887#define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000888#define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
Denis Vlasenkobf66fbc2006-12-21 13:23:14 +0000889#define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
Denis Vlasenko16abcd92007-04-13 23:59:52 +0000890#define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000891
Denys Vlasenkod8528b82010-01-31 05:15:38 +0100892typedef struct uni_stat_t {
893 unsigned byte_count;
894 unsigned unicode_count;
895 unsigned unicode_width;
896} uni_stat_t;
897/* Returns a string with unprintable chars replaced by '?' or
898 * SUBST_WCHAR. This function is unicode-aware. */
Denys Vlasenko349d72c2018-09-30 16:56:56 +0200899const char* FAST_FUNC printable_string(const char *str);
900const char* FAST_FUNC printable_string2(uni_stat_t *stats, const char *str);
Denys Vlasenkod8528b82010-01-31 05:15:38 +0100901/* Prints unprintable char ch as ^C or M-c to file
902 * (M-c is used only if ch is ORed with PRINTABLE_META),
903 * else it is printed as-is (except for ch = 0x9b) */
904enum { PRINTABLE_META = 0x100 };
905void fputc_printable(int ch, FILE *file) FAST_FUNC;
Bartosz Golaszewski79c618c2013-07-30 06:29:42 +0200906/* Return a string that is the printable representation of character ch.
907 * Buffer must hold at least four characters. */
Denys Vlasenkobfa6ed12013-07-30 11:41:58 +0200908enum {
909 VISIBLE_ENDLINE = 1 << 0,
910 VISIBLE_SHOW_TABS = 1 << 1,
911};
Bartosz Golaszewski79c618c2013-07-30 06:29:42 +0200912void visible(unsigned ch, char *buf, int flags) FAST_FUNC;
Denys Vlasenkod8528b82010-01-31 05:15:38 +0100913
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000914extern ssize_t safe_read(int fd, void *buf, size_t count) FAST_FUNC;
Ron Yorston61d6ae22015-04-19 10:50:25 +0100915extern ssize_t nonblock_immune_read(int fd, void *buf, size_t count) FAST_FUNC;
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000916// NB: will return short read on error, not -1,
917// if some data was read before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000918extern ssize_t full_read(int fd, void *buf, size_t count) FAST_FUNC;
919extern void xread(int fd, void *buf, size_t count) FAST_FUNC;
920extern unsigned char xread_char(int fd) FAST_FUNC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000921extern ssize_t read_close(int fd, void *buf, size_t maxsz) FAST_FUNC;
922extern ssize_t open_read_close(const char *filename, void *buf, size_t maxsz) FAST_FUNC;
Denis Vlasenko8ee649a2008-03-26 20:04:27 +0000923// Reads one line a-la fgets (but doesn't save terminating '\n').
924// Reads byte-by-byte. Useful when it is important to not read ahead.
Denis Vlasenkoe376d452008-02-20 22:23:24 +0000925// Bytes are appended to pfx (which must be malloced, or NULL).
Denys Vlasenko80c5b682011-05-08 21:21:10 +0200926extern char *xmalloc_reads(int fd, size_t *maxsz_p) FAST_FUNC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000927/* Reads block up to *maxsz_p (default: INT_MAX - 4095) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100928extern void *xmalloc_read(int fd, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkodff2bd72019-05-24 17:03:28 +0200929extern void *xmalloc_read_with_initial_buf(int fd, size_t *maxsz_p, char *buf, size_t total) FAST_FUNC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000930/* Returns NULL if file can't be opened (default max size: INT_MAX - 4095) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100931extern void *xmalloc_open_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko094cc512011-01-17 14:58:27 +0100932/* Never returns NULL */
933extern void *xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko59655072012-03-06 16:23:50 +0100934
Denys Vlasenko04c14172014-11-26 15:17:59 +0100935#if defined(ARG_MAX) && (ARG_MAX >= 60*1024 || !defined(_SC_ARG_MAX))
936/* Use _constant_ maximum if: defined && (big enough || no variable one exists) */
Denys Vlasenkof92f1d02014-06-22 13:54:40 +0200937# define bb_arg_max() ((unsigned)ARG_MAX)
Denys Vlasenko04c14172014-11-26 15:17:59 +0100938#elif defined(_SC_ARG_MAX)
939/* Else use variable one (a bit more expensive) */
Denys Vlasenkof92f1d02014-06-22 13:54:40 +0200940unsigned bb_arg_max(void) FAST_FUNC;
941#else
Denys Vlasenko04c14172014-11-26 15:17:59 +0100942/* If all else fails */
Denys Vlasenkof92f1d02014-06-22 13:54:40 +0200943# define bb_arg_max() ((unsigned)(32 * 1024))
944#endif
Bartosz Golaszewski5d2e4092014-06-22 14:01:13 +0200945unsigned bb_clk_tck(void) FAST_FUNC;
Denys Vlasenkof92f1d02014-06-22 13:54:40 +0200946
Denys Vlasenko59655072012-03-06 16:23:50 +0100947#define SEAMLESS_COMPRESSION (0 \
948 || ENABLE_FEATURE_SEAMLESS_XZ \
949 || ENABLE_FEATURE_SEAMLESS_LZMA \
950 || ENABLE_FEATURE_SEAMLESS_BZ2 \
951 || ENABLE_FEATURE_SEAMLESS_GZ \
952 || ENABLE_FEATURE_SEAMLESS_Z)
953
Denys Vlasenko8a6a2f92012-03-06 16:27:48 +0100954#if SEAMLESS_COMPRESSION
Denys Vlasenko27653ad2010-05-06 14:19:19 +0000955/* Autodetects gzip/bzip2 formats. fd may be in the middle of the file! */
Denys Vlasenko0cf64c82017-08-10 10:35:08 +0200956int setup_unzip_on_fd(int fd, int fail_if_not_compressed) FAST_FUNC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000957/* Autodetects .gz etc */
Denys Vlasenko640ce3d2014-02-02 02:06:38 +0100958extern int open_zipped(const char *fname, int fail_if_not_compressed) FAST_FUNC;
Denys Vlasenkob4c11c12014-12-07 00:44:00 +0100959extern void *xmalloc_open_zipped_read_close(const char *fname, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko8a6a2f92012-03-06 16:27:48 +0100960#else
961# define setup_unzip_on_fd(...) (0)
Denys Vlasenko640ce3d2014-02-02 02:06:38 +0100962# define open_zipped(fname, fail_if_not_compressed) open((fname), O_RDONLY);
Denys Vlasenkob4c11c12014-12-07 00:44:00 +0100963# define xmalloc_open_zipped_read_close(fname, maxsz_p) xmalloc_open_read_close((fname), (maxsz_p))
Denys Vlasenko8a6a2f92012-03-06 16:27:48 +0100964#endif
Denys Vlasenko0cf64c82017-08-10 10:35:08 +0200965/* lzma has no signature, need a little helper. NB: exist only for ENABLE_FEATURE_SEAMLESS_LZMA=y */
966void setup_lzma_on_fd(int fd) FAST_FUNC;
Denis Vlasenkoea620772006-10-14 02:23:43 +0000967
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000968extern ssize_t safe_write(int fd, const void *buf, size_t count) FAST_FUNC;
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000969// NB: will return short write on error, not -1,
970// if some data was written before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000971extern ssize_t full_write(int fd, const void *buf, size_t count) FAST_FUNC;
972extern void xwrite(int fd, const void *buf, size_t count) FAST_FUNC;
Denis Vlasenko73c571a2009-03-09 00:12:37 +0000973extern void xwrite_str(int fd, const char *str) FAST_FUNC;
Denys Vlasenko729ecb82010-06-07 14:14:26 +0200974extern ssize_t full_write1_str(const char *str) FAST_FUNC;
975extern ssize_t full_write2_str(const char *str) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000976extern void xopen_xwrite_close(const char* file, const char *str) FAST_FUNC;
Denis Vlasenkoea620772006-10-14 02:23:43 +0000977
Denys Vlasenkodcd27ab2009-10-05 03:03:07 +0200978/* Close fd, but check for failures (some types of write errors) */
979extern void xclose(int fd) FAST_FUNC;
980
Denis Vlasenko1de08302006-10-26 23:32:43 +0000981/* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000982extern void xprint_and_close_file(FILE *file) FAST_FUNC;
Denis Vlasenko2132e022008-07-15 10:33:12 +0000983
Denys Vlasenkoa1a44832011-06-17 03:37:43 +0200984/* Reads a line from a text file, up to a newline or NUL byte, inclusive.
985 * Returns malloc'ed char*. If end is NULL '\n' isn't considered
986 * end of line. If end isn't NULL, length of the chunk is stored in it.
987 * Returns NULL if EOF/error.
988 */
Quentin Rameaue2afae62018-04-01 19:49:58 +0200989extern char *bb_get_chunk_from_file(FILE *file, size_t *end) FAST_FUNC;
Denis Vlasenkoabee3d02007-12-26 20:44:45 +0000990/* Reads up to (and including) TERMINATING_STRING: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100991extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000992/* Same, with limited max size, and returns the length (excluding NUL): */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100993extern 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 +0000994/* Chops off TERMINATING_STRING from the end: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100995extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000996/* Reads up to (and including) "\n" or NUL byte: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100997extern char *xmalloc_fgets(FILE *file) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000998/* Chops off '\n' from the end, unlike fgets: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100999extern char *xmalloc_fgetline(FILE *file) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko2132e022008-07-15 10:33:12 +00001000/* Same, but doesn't try to conserve space (may have some slack after the end) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +01001001/* extern char *xmalloc_fgetline_fast(FILE *file) FAST_FUNC RETURNS_MALLOC; */
Denis Vlasenko2132e022008-07-15 10:33:12 +00001002
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +01001003void die_if_ferror(FILE *file, const char *msg) FAST_FUNC;
1004void die_if_ferror_stdout(void) FAST_FUNC;
1005int fflush_all(void) FAST_FUNC;
1006void fflush_stdout_and_exit(int retval) NORETURN FAST_FUNC;
1007int fclose_if_not_stdin(FILE *file) FAST_FUNC;
1008FILE* xfopen(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +00001009/* Prints warning to stderr and returns NULL on failure: */
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +01001010FILE* fopen_or_warn(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +00001011/* "Opens" stdin if filename is special, else just opens file: */
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +01001012FILE* xfopen_stdin(const char *filename) FAST_FUNC;
1013FILE* fopen_or_warn_stdin(const char *filename) FAST_FUNC;
1014FILE* fopen_for_read(const char *path) FAST_FUNC;
1015FILE* xfopen_for_read(const char *path) FAST_FUNC;
1016FILE* fopen_for_write(const char *path) FAST_FUNC;
1017FILE* xfopen_for_write(const char *path) FAST_FUNC;
1018FILE* xfdopen_for_read(int fd) FAST_FUNC;
1019FILE* xfdopen_for_write(int fd) FAST_FUNC;
Eric Andersen8876fb22003-06-20 09:01:58 +00001020
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001021int bb_pstrcmp(const void *a, const void *b) /* not FAST_FUNC! */;
1022void qsort_string_vector(char **sv, unsigned count) FAST_FUNC;
Denis Vlasenkofb290382008-03-02 12:51:26 +00001023
Denis Vlasenko5d61e712007-09-27 10:09:59 +00001024/* Wrapper which restarts poll on EINTR or ENOMEM.
1025 * On other errors complains [perror("poll")] and returns.
1026 * Warning! May take (much) longer than timeout_ms to return!
1027 * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001028int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms) FAST_FUNC;
Denis Vlasenko5d61e712007-09-27 10:09:59 +00001029
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001030char *safe_gethostname(void) FAST_FUNC;
Denis Vlasenko6f1713f2008-02-25 23:23:58 +00001031
Bernhard Reutner-Fischer8b1fab22007-04-10 09:38:07 +00001032/* Convert each alpha char in str to lower-case */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001033char* str_tolower(char *str) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001034
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001035char *utoa(unsigned n) FAST_FUNC;
1036char *itoa(int n) FAST_FUNC;
Denis Vlasenko10457b92007-03-27 22:01:31 +00001037/* Returns a pointer past the formatted number, does NOT null-terminate */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001038char *utoa_to_buf(unsigned n, char *buf, unsigned buflen) FAST_FUNC;
1039char *itoa_to_buf(int n, char *buf, unsigned buflen) FAST_FUNC;
Denis Vlasenko56ea65c2008-01-06 03:26:53 +00001040/* Intelligent formatters of bignums */
Denys Vlasenkoa407cf72013-09-06 12:53:14 +02001041char *smart_ulltoa4(unsigned long long ul, char buf[4], const char *scale) FAST_FUNC;
1042char *smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
Denys Vlasenko0bf44d02009-10-13 01:25:09 +02001043/* If block_size == 0, display size without fractional part,
1044 * else display (size * block_size) with one decimal digit.
Denys Vlasenko9c3b84a2010-01-18 01:55:00 +01001045 * If display_unit == 0, show value no bigger than 1024 with suffix (K,M,G...),
Denys Vlasenko0bf44d02009-10-13 01:25:09 +02001046 * else divide by display_unit and do not use suffix. */
Denys Vlasenko9c3b84a2010-01-18 01:55:00 +01001047#define HUMAN_READABLE_MAX_WIDTH 7 /* "1024.0G" */
1048#define HUMAN_READABLE_MAX_WIDTH_STR "7"
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001049//TODO: provide pointer to buf (avoid statics)?
1050const char *make_human_readable_str(unsigned long long size,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001051 unsigned long block_size, unsigned long display_unit) FAST_FUNC;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001052/* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
Denys Vlasenko1f56e512011-10-19 22:40:35 +02001053char *bin2hex(char *dst, const char *src, int count) FAST_FUNC;
Denys Vlasenko48363312010-04-04 15:29:32 +02001054/* Reverse */
Denys Vlasenko1f56e512011-10-19 22:40:35 +02001055char* hex2bin(char *dst, const char *src, int count) FAST_FUNC;
Rob Landleyc5b1d4d2006-03-13 15:45:16 +00001056
Vladimir Dronnikovdb67a202009-10-15 09:24:25 +02001057/* Generate a UUID */
1058void generate_uuid(uint8_t *buf) FAST_FUNC;
1059
Denis Vlasenko1bab1de2007-07-27 15:30:39 +00001060/* Last element is marked by mult == 0 */
Eric Andersenaad1a882001-03-16 22:47:14 +00001061struct suffix_mult {
Denis Vlasenkof8689632007-07-27 15:06:25 +00001062 char suffix[4];
Denys Vlasenko965b7952020-11-30 13:03:03 +01001063 uint32_t mult;
Eric Andersenaad1a882001-03-16 22:47:14 +00001064};
Denys Vlasenko965b7952020-11-30 13:03:03 +01001065#define ALIGN_SUFFIX ALIGN4
Denys Vlasenkoc72b43c2013-07-13 23:49:45 +02001066extern const struct suffix_mult bkm_suffixes[];
1067#define km_suffixes (bkm_suffixes + 1)
Ari Sundholm88930232015-03-04 18:46:48 +02001068extern const struct suffix_mult cwbkMG_suffixes[];
Ari Sundholm911db162015-03-22 17:55:38 +01001069#define kMG_suffixes (cwbkMG_suffixes + 3)
Denys Vlasenkoe184a882016-12-12 19:56:31 +01001070extern const struct suffix_mult kmg_i_suffixes[];
Denys Vlasenkoc72b43c2013-07-13 23:49:45 +02001071
Denis Vlasenkoed836cd2006-11-25 14:44:13 +00001072#include "xatonum.h"
Denis Vlasenko13858992006-10-08 12:49:22 +00001073/* Specialized: */
Denys Vlasenko77832482010-08-12 14:14:45 +02001074
Denis Vlasenko13858992006-10-08 12:49:22 +00001075/* Using xatoi() instead of naive atoi() is not always convenient -
1076 * in many places people want *non-negative* values, but store them
1077 * in signed int. Therefore we need this one:
Denys Vlasenko77832482010-08-12 14:14:45 +02001078 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc.
1079 * It should really be named xatoi_nonnegative (since it allows 0),
1080 * but that would be too long.
1081 */
1082int xatoi_positive(const char *numstr) FAST_FUNC;
1083
Denis Vlasenko13858992006-10-08 12:49:22 +00001084/* Useful for reading port numbers */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001085uint16_t xatou16(const char *numstr) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001086
Denys Vlasenko4c20d9f2018-08-03 18:17:12 +02001087#if ENABLE_FLOAT_DURATION
1088typedef double duration_t;
1089void sleep_for_duration(duration_t duration) FAST_FUNC;
Denys Vlasenko0ddc7422019-03-12 18:56:51 +01001090#define DURATION_FMT "f"
Denys Vlasenko4c20d9f2018-08-03 18:17:12 +02001091#else
1092typedef unsigned duration_t;
1093#define sleep_for_duration(duration) sleep(duration)
Denys Vlasenko0ddc7422019-03-12 18:56:51 +01001094#define DURATION_FMT "u"
Denys Vlasenko4c20d9f2018-08-03 18:17:12 +02001095#endif
1096duration_t parse_duration_str(char *str) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001097
Eric Andersenaad1a882001-03-16 22:47:14 +00001098/* These parse entries in /etc/passwd and /etc/group. This is desirable
1099 * for BusyBox since we want to avoid using the glibc NSS stuff, which
Bernhard Reutner-Fischerd5bd1372005-09-20 21:06:17 +00001100 * increases target size and is often not needed on embedded systems. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001101long xuname2uid(const char *name) FAST_FUNC;
1102long xgroup2gid(const char *name) FAST_FUNC;
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +00001103/* wrapper: allows string to contain numeric uid or gid */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001104unsigned long get_ug_id(const char *s, long FAST_FUNC (*xname2id)(const char *)) FAST_FUNC;
Denis Vlasenkode59c0f2006-10-05 22:50:22 +00001105struct bb_uidgid_t {
Denis Vlasenko150f4022007-01-13 21:06:21 +00001106 uid_t uid;
1107 gid_t gid;
Denis Vlasenkode59c0f2006-10-05 22:50:22 +00001108};
Denys Vlasenko526d8582015-10-19 04:27:17 +02001109/* always sets uid and gid; returns 0 on failure */
1110int get_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
1111/* always sets uid and gid; exits on failure */
Bernhard Reutner-Fischerd73cbd32008-07-21 14:41:33 +00001112void xget_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
Denis Vlasenkocce38582007-02-26 22:47:42 +00001113/* chown-like handling of "user[:[group]" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001114void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group) FAST_FUNC;
Denis Vlasenkod7a805e2008-12-03 19:05:55 +00001115struct passwd* xgetpwnam(const char *name) FAST_FUNC;
Denis Vlasenko15437e32008-12-05 16:23:06 +00001116struct group* xgetgrnam(const char *name) FAST_FUNC;
Denis Vlasenko0c68a872008-12-02 22:56:59 +00001117struct passwd* xgetpwuid(uid_t uid) FAST_FUNC;
1118struct group* xgetgrgid(gid_t gid) FAST_FUNC;
1119char* xuid2uname(uid_t uid) FAST_FUNC;
1120char* xgid2group(gid_t gid) FAST_FUNC;
1121char* uid2uname(uid_t uid) FAST_FUNC;
1122char* gid2group(gid_t gid) FAST_FUNC;
Denys Vlasenko7d65abe2011-03-01 16:27:13 +01001123char* uid2uname_utoa(uid_t uid) FAST_FUNC;
1124char* gid2group_utoa(gid_t gid) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +00001125/* versions which cache results (useful for ps, ls etc) */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001126const char* get_cached_username(uid_t uid) FAST_FUNC;
1127const char* get_cached_groupname(gid_t gid) FAST_FUNC;
1128void clear_username_cache(void) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +00001129/* internally usernames are saved in fixed-sized char[] buffers */
Denys Vlasenko7d65abe2011-03-01 16:27:13 +01001130enum { USERNAME_MAX_SIZE = 32 - sizeof(uid_t) };
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +00001131#if ENABLE_FEATURE_CHECK_NAMES
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001132void die_if_bad_username(const char* name) FAST_FUNC;
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +00001133#else
1134#define die_if_bad_username(name) ((void)(name))
1135#endif
Denys Vlasenkoa8cf9c52017-07-04 18:49:24 +02001136/*
1137 * Returns (-1) terminated malloced result of getgroups().
1138 * Reallocs group_array (useful for repeated calls).
1139 * ngroups is an initial size of array. It is rounded up to 32 for realloc.
1140 * ngroups is updated on return.
1141 * ngroups can be NULL: bb_getgroups(NULL, NULL) is valid usage.
1142 * Dies on errors (on Linux, only xrealloc can cause this, not internal getgroups call).
1143 */
1144gid_t *bb_getgroups(int *ngroups, gid_t *group_array) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001145
Denys Vlasenko37f5bef2010-04-05 03:18:40 +02001146#if ENABLE_FEATURE_UTMP
Denys Vlasenko3a416112010-04-05 22:10:38 +02001147void FAST_FUNC write_new_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
1148void 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 +01001149void FAST_FUNC update_utmp_DEAD_PROCESS(pid_t pid);
Denys Vlasenko37f5bef2010-04-05 03:18:40 +02001150#else
Denys Vlasenko3a416112010-04-05 22:10:38 +02001151# define write_new_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
1152# define update_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
Denys Vlasenkoda921262015-01-05 15:37:58 +01001153# define update_utmp_DEAD_PROCESS(pid) ((void)0)
Denys Vlasenko37f5bef2010-04-05 03:18:40 +02001154#endif
1155
Denys Vlasenkob72baeb2011-02-02 18:38:57 +01001156
Denys Vlasenkoe765b5a2014-05-02 17:15:58 +02001157int file_is_executable(const char *name) FAST_FUNC;
1158char *find_executable(const char *filename, char **PATHp) FAST_FUNC;
1159int executable_exists(const char *filename) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001160
Denis Vlasenko7e0fbf92007-09-04 19:33:22 +00001161/* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
1162 * but it may exec busybox and call applet instead of searching PATH.
1163 */
Denis Vlasenko80d14be2007-04-10 23:03:30 +00001164#if ENABLE_FEATURE_PREFER_APPLETS
Denys Vlasenkoc71b4692011-02-02 03:28:56 +01001165int BB_EXECVP(const char *file, char *const argv[]) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001166#define BB_EXECLP(prog,cmd,...) \
Denys Vlasenkoc71b4692011-02-02 03:28:56 +01001167 do { \
1168 if (find_applet_by_name(prog) >= 0) \
1169 execlp(bb_busybox_exec_path, cmd, __VA_ARGS__); \
1170 execlp(prog, cmd, __VA_ARGS__); \
1171 } while (0)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001172#else
1173#define BB_EXECVP(prog,cmd) execvp(prog,cmd)
Denys Vlasenkoc71b4692011-02-02 03:28:56 +01001174#define BB_EXECLP(prog,cmd,...) execlp(prog,cmd,__VA_ARGS__)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001175#endif
Denys Vlasenko82203992016-04-02 18:06:24 +02001176void BB_EXECVP_or_die(char **argv) NORETURN FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001177
Denys Vlasenko82203992016-04-02 18:06:24 +02001178/* xvfork() can't be a _function_, return after vfork in child mangles stack
Pascal Bellard926031b2010-07-04 15:32:38 +02001179 * in the parent. It must be a macro. */
1180#define xvfork() \
1181({ \
1182 pid_t bb__xvfork_pid = vfork(); \
1183 if (bb__xvfork_pid < 0) \
James Byrne69374872019-07-02 11:35:03 +02001184 bb_simple_perror_msg_and_die("vfork"); \
Pascal Bellard926031b2010-07-04 15:32:38 +02001185 bb__xvfork_pid; \
1186})
1187#if BB_MMU
1188pid_t xfork(void) FAST_FUNC;
1189#endif
Denys Vlasenko82203992016-04-02 18:06:24 +02001190void xvfork_parent_waits_and_exits(void) FAST_FUNC;
Pascal Bellard926031b2010-07-04 15:32:38 +02001191
Denys Vlasenko8531d762010-03-18 22:44:00 +01001192/* NOMMU friendy fork+exec: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001193pid_t spawn(char **argv) FAST_FUNC;
1194pid_t xspawn(char **argv) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +00001195
Denis Vlasenko3854c5d2008-11-06 22:39:57 +00001196pid_t safe_waitpid(pid_t pid, int *wstat, int options) FAST_FUNC;
Denys Vlasenko8531d762010-03-18 22:44:00 +01001197pid_t wait_any_nohang(int *wstat) FAST_FUNC;
1198/* wait4pid: unlike waitpid, waits ONLY for one process.
1199 * Returns sig + 0x180 if child is killed by signal.
Denis Vlasenkocd7001f2007-04-09 21:32:30 +00001200 * It's safe to pass negative 'pids' from failed [v]fork -
Denis Vlasenko473dae02007-04-11 07:04:23 +00001201 * wait4pid will return -1 (and will not clobber [v]fork's errno).
Denis Vlasenkocd7001f2007-04-09 21:32:30 +00001202 * IOW: rc = wait4pid(spawn(argv));
1203 * if (rc < 0) bb_perror_msg("%s", argv[0]);
Denys Vlasenko8531d762010-03-18 22:44:00 +01001204 * if (rc > 0) bb_error_msg("exit code: %d", rc & 0xff);
Denis Vlasenkocd7001f2007-04-09 21:32:30 +00001205 */
Denis Vlasenko3854c5d2008-11-06 22:39:57 +00001206int wait4pid(pid_t pid) FAST_FUNC;
Denys Vlasenkoc4199f22016-04-01 22:12:44 +02001207int wait_for_exitstatus(pid_t pid) FAST_FUNC;
Denys Vlasenko9967c992017-01-26 01:13:58 +01001208/************************************************************************/
1209/* spawn_and_wait/run_nofork_applet/run_applet_no_and_exit need to work */
1210/* carefully together to reinit some global state while not disturbing */
1211/* other. Be careful if you change them. Consult docs/nofork_noexec.txt */
1212/************************************************************************/
Denys Vlasenko8531d762010-03-18 22:44:00 +01001213/* Same as wait4pid(spawn(argv)), but with NOFORK/NOEXEC if configured: */
Denys Vlasenko8f24f982009-06-07 16:02:00 +02001214int spawn_and_wait(char **argv) FAST_FUNC;
Denis Vlasenko18e19f22007-04-28 16:43:18 +00001215/* Does NOT check that applet is NOFORK, just blindly runs it */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001216int run_nofork_applet(int applet_no, char **argv) FAST_FUNC;
Denys Vlasenko80e8e3c2017-08-07 19:24:57 +02001217void run_noexec_applet_and_exit(int a, const char *name, char **argv) NORETURN FAST_FUNC;
Denys Vlasenko9967c992017-01-26 01:13:58 +01001218#ifndef BUILD_INDIVIDUAL
Denys Vlasenko80e8e3c2017-08-07 19:24:57 +02001219int find_applet_by_name(const char *name) FAST_FUNC;
1220void run_applet_no_and_exit(int a, const char *name, char **argv) NORETURN FAST_FUNC;
Denys Vlasenko9967c992017-01-26 01:13:58 +01001221#endif
Denys Vlasenko6bdfbc42021-02-18 23:30:24 +01001222void show_usage_if_dash_dash_help(int applet_no, char **argv) FAST_FUNC;
Denys Vlasenkof2cf1cc2017-08-07 18:45:33 +02001223#if defined(__linux__)
1224void set_task_comm(const char *comm) FAST_FUNC;
1225#else
1226# define set_task_comm(name) ((void)0)
1227#endif
Denis Vlasenkocd7001f2007-04-09 21:32:30 +00001228
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001229/* Helpers for daemonization.
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001230 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001231 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001232 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001233 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
1234 * rexec's itself on NOMMU with argv passed as command line.
1235 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
1236 * from the start. (It will detect it and not reexec again second time).
1237 * You have to audit carefully that you don't do something twice as a result
1238 * (opening files/sockets, parsing config files etc...)!
1239 *
1240 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
1241 * (will do setsid()).
1242 *
Pascal Bellard926031b2010-07-04 15:32:38 +02001243 * fork_or_rexec(argv) = bare-bones fork on MMU,
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001244 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
Denis Vlasenko83518d12009-03-20 22:17:13 +00001245 * On MMU ignores argv.
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001246 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001247 * Helper for network daemons in foreground mode:
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001248 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001249 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
1250 * to /dev/null if they are not.
1251 */
1252enum {
Denys Vlasenko088fec32019-01-14 14:45:18 +01001253 DAEMON_CHDIR_ROOT = 1 << 0,
1254 DAEMON_DEVNULL_STDIO = 1 << 1,
1255 DAEMON_CLOSE_EXTRA_FDS = 1 << 2,
1256 DAEMON_ONLY_SANITIZE = 1 << 3, /* internal use */
1257 //DAEMON_DOUBLE_FORK = 1 << 4, /* double fork to avoid controlling tty */
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001258};
Denis Vlasenko473dae02007-04-11 07:04:23 +00001259#if BB_MMU
Denis Vlasenko367960b2007-08-18 14:20:21 +00001260 enum { re_execed = 0 };
Pascal Bellard926031b2010-07-04 15:32:38 +02001261# define fork_or_rexec(argv) xfork()
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001262# define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
1263# define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001264#else
Pascal Bellard926031b2010-07-04 15:32:38 +02001265 extern bool re_execed;
Denys Vlasenkod2277e22011-11-22 17:19:26 +01001266 /* Note: re_exec() and fork_or_rexec() do argv[0][0] |= 0x80 on NOMMU!
1267 * _Parent_ needs to undo it if it doesn't want to have argv[0] mangled.
1268 */
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001269 void re_exec(char **argv) NORETURN FAST_FUNC;
Denis Vlasenko83518d12009-03-20 22:17:13 +00001270 pid_t fork_or_rexec(char **argv) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001271 int BUG_fork_is_unavailable_on_nommu(void) FAST_FUNC;
1272 int BUG_daemon_is_unavailable_on_nommu(void) FAST_FUNC;
1273 void BUG_bb_daemonize_is_unavailable_on_nommu(void) FAST_FUNC;
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001274# define fork() BUG_fork_is_unavailable_on_nommu()
Pascal Bellard926031b2010-07-04 15:32:38 +02001275# define xfork() BUG_fork_is_unavailable_on_nommu()
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001276# define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
1277# define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001278#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001279void bb_daemonize_or_rexec(int flags, char **argv) FAST_FUNC;
1280void bb_sanitize_stdio(void) FAST_FUNC;
Denys Vlasenkob182e9a2017-08-04 23:04:17 +02001281#define bb_daemon_helper(arg) bb_daemonize_or_rexec((arg) | DAEMON_ONLY_SANITIZE, NULL)
Denis Vlasenkoc9ca0a32008-02-18 11:08:33 +00001282/* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001283int sanitize_env_if_suid(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001284
1285
Denys Vlasenko727948e2017-08-04 16:23:42 +02001286/* For top, ps. Some argv[i] are replaced by malloced "-opt" strings */
1287void make_all_argv_opts(char **argv) FAST_FUNC;
Denys Vlasenko036585a2017-08-08 16:38:18 +02001288char* single_argv(char **argv) FAST_FUNC;
1289extern const char *const bb_argv_dash[]; /* { "-", NULL } */
1290extern uint32_t option_mask32;
Denys Vlasenko036585a2017-08-08 16:38:18 +02001291uint32_t getopt32(char **argv, const char *applet_opts, ...) FAST_FUNC;
1292# define No_argument "\0"
1293# define Required_argument "\001"
1294# define Optional_argument "\002"
1295#if ENABLE_LONG_OPTS
1296uint32_t getopt32long(char **argv, const char *optstring, const char *longopts, ...) FAST_FUNC;
1297#else
1298#define getopt32long(argv,optstring,longopts,...) \
1299 getopt32(argv,optstring,##__VA_ARGS__)
1300#endif
Kaarle Ritvanen835ad3a2017-04-12 00:58:46 +03001301/* BSD-derived getopt() functions require that optind be set to 1 in
1302 * order to reset getopt() state. This used to be generally accepted
1303 * way of resetting getopt(). However, glibc's getopt()
1304 * has additional getopt() state beyond optind (specifically, glibc
Denys Vlasenko352ddd32017-04-12 20:21:34 +02001305 * extensions such as '+' and '-' at the start of the string), and requires
Kaarle Ritvanen835ad3a2017-04-12 00:58:46 +03001306 * that optind be set to zero to reset its state. BSD-derived versions
1307 * of getopt() misbehaved if optind is set to 0 in order to reset getopt(),
1308 * and glibc's getopt() used to coredump if optind is set 1 in order
1309 * to reset getopt().
Denys Vlasenko352ddd32017-04-12 20:21:34 +02001310 * Then BSD introduced additional variable "optreset" which should be
1311 * set to 1 in order to reset getopt(). Sigh. Standards, anyone?
Kaarle Ritvanen835ad3a2017-04-12 00:58:46 +03001312 *
1313 * By ~2008, OpenBSD 3.4 was changed to survive glibc-like optind = 0
1314 * (to interpret it as if optreset was set).
1315 */
Denys Vlasenko60161812017-08-29 14:32:17 +02001316#if 1 /*def __GLIBC__*/
Kaarle Ritvanen835ad3a2017-04-12 00:58:46 +03001317#define GETOPT_RESET() (optind = 0)
1318#else /* BSD style */
1319#define GETOPT_RESET() (optind = 1)
1320#endif
1321
1322
Denys Vlasenko9be47022011-05-16 12:21:31 +02001323/* Having next pointer as a first member allows easy creation
1324 * of "llist-compatible" structs, and using llist_FOO functions
1325 * on them.
1326 */
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001327typedef struct llist_t {
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001328 struct llist_t *link;
Denys Vlasenko9be47022011-05-16 12:21:31 +02001329 char *data;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001330} llist_t;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001331void llist_add_to(llist_t **old_head, void *data) FAST_FUNC;
1332void llist_add_to_end(llist_t **list_head, void *data) FAST_FUNC;
1333void *llist_pop(llist_t **elm) FAST_FUNC;
1334void llist_unlink(llist_t **head, llist_t *elm) FAST_FUNC;
1335void llist_free(llist_t *elm, void (*freeit)(void *data)) FAST_FUNC;
1336llist_t *llist_rev(llist_t *list) FAST_FUNC;
Denis Vlasenko0b791d92009-04-13 20:52:00 +00001337llist_t *llist_find_str(llist_t *first, const char *str) FAST_FUNC;
Denis Vlasenko4b924f32007-05-30 00:29:55 +00001338/* BTW, surprisingly, changing API to
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001339 * llist_t *llist_add_to(llist_t *old_head, void *data)
1340 * etc does not result in smaller code... */
1341
Denis Vlasenko80edead2007-08-02 22:31:05 +00001342/* start_stop_daemon and udhcpc are special - they want
1343 * to create pidfiles regardless of FEATURE_PIDFILE */
Denis Vlasenko1caca342007-08-02 10:14:29 +00001344#if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001345/* True only if we created pidfile which is *file*, not /dev/null etc */
1346extern smallint wrote_pidfile;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001347void write_pidfile(const char *path) FAST_FUNC;
Denys Vlasenko50596532019-03-17 19:47:52 +01001348void write_pidfile_std_path_and_ext(const char *path) FAST_FUNC;
1349void remove_pidfile_std_path_and_ext(const char *path) FAST_FUNC;
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001350#define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
Denis Vlasenko10457b92007-03-27 22:01:31 +00001351#else
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001352enum { wrote_pidfile = 0 };
Denys Vlasenko50596532019-03-17 19:47:52 +01001353#define write_pidfile_std_path_and_ext(path) ((void)0)
1354#define remove_pidfile_std_path_and_ext(path) ((void)0)
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001355#define write_pidfile(path) ((void)0)
1356#define remove_pidfile(path) ((void)0)
Denis Vlasenko10457b92007-03-27 22:01:31 +00001357#endif
1358
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001359enum {
1360 LOGMODE_NONE = 0,
Denis Vlasenko1b97efd2007-08-17 19:18:06 +00001361 LOGMODE_STDIO = (1 << 0),
1362 LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001363 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
1364};
1365extern const char *msg_eol;
Denis Vlasenko04c99eb2007-04-07 00:44:31 +00001366extern smallint logmode;
Denys Vlasenko7aa63042010-09-01 16:04:24 +02001367extern uint8_t xfunc_error_retval;
Denys Vlasenko550bf5b2015-10-09 16:42:57 +02001368extern void (*die_func)(void);
Denys Vlasenko899ae532018-04-01 19:59:37 +02001369void xfunc_die(void) NORETURN FAST_FUNC;
1370void bb_show_usage(void) NORETURN FAST_FUNC;
1371void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
James Byrne69374872019-07-02 11:35:03 +02001372void bb_simple_error_msg(const char *s) FAST_FUNC;
Denys Vlasenko899ae532018-04-01 19:59:37 +02001373void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
James Byrne69374872019-07-02 11:35:03 +02001374void bb_simple_error_msg_and_die(const char *s) NORETURN FAST_FUNC;
Denys Vlasenko899ae532018-04-01 19:59:37 +02001375void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1376void bb_simple_perror_msg(const char *s) FAST_FUNC;
1377void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1378void bb_simple_perror_msg_and_die(const char *s) NORETURN FAST_FUNC;
1379void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
James Byrne69374872019-07-02 11:35:03 +02001380void bb_simple_herror_msg(const char *s) FAST_FUNC;
Denys Vlasenko899ae532018-04-01 19:59:37 +02001381void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
James Byrne69374872019-07-02 11:35:03 +02001382void bb_simple_herror_msg_and_die(const char *s) NORETURN FAST_FUNC;
Denys Vlasenko899ae532018-04-01 19:59:37 +02001383void bb_perror_nomsg_and_die(void) NORETURN FAST_FUNC;
1384void bb_perror_nomsg(void) FAST_FUNC;
1385void bb_verror_msg(const char *s, va_list p, const char *strerr) FAST_FUNC;
1386void bb_die_memory_exhausted(void) NORETURN FAST_FUNC;
1387void bb_logenv_override(void) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001388
James Byrne253c4e72019-04-12 17:01:51 +00001389#if ENABLE_FEATURE_SYSLOG_INFO
1390void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
James Byrne69374872019-07-02 11:35:03 +02001391void bb_simple_info_msg(const char *s) FAST_FUNC;
James Byrne253c4e72019-04-12 17:01:51 +00001392void bb_vinfo_msg(const char *s, va_list p) FAST_FUNC;
1393#else
1394#define bb_info_msg bb_error_msg
James Byrne69374872019-07-02 11:35:03 +02001395#define bb_simple_info_msg bb_simple_error_msg
James Byrne253c4e72019-04-12 17:01:51 +00001396#define bb_vinfo_msg(s,p) bb_verror_msg(s,p,NULL)
1397#endif
1398
James Byrne69374872019-07-02 11:35:03 +02001399#if ENABLE_WARN_SIMPLE_MSG
1400/* If enabled, cause calls to bb_error_msg() et al that only take a single
1401 * parameter to generate a warning.
1402 */
1403static inline void __attribute__ ((deprecated("use bb_simple_error_msg instead")))
1404 bb_not_simple_error_msg(const char *s) { bb_simple_error_msg(s); }
1405static inline void __attribute__ ((deprecated("use bb_simple_error_msg_and_die instead"))) NORETURN
1406 bb_not_simple_error_msg_and_die(const char *s) { bb_simple_error_msg_and_die(s); }
1407static inline void __attribute__ ((deprecated("use bb_simple_perror_msg instead")))
1408 bb_not_simple_perror_msg(const char *s) { bb_simple_perror_msg(s); }
1409static inline void __attribute__ ((deprecated("use bb_simple_perror_msg_and_die instead"))) NORETURN
1410 bb_not_simple_perror_msg_and_die(const char *s) { bb_simple_perror_msg_and_die(s); }
1411static inline void __attribute__ ((deprecated("use bb_simple_herror_msg instead")))
1412 bb_not_simple_herror_msg(const char *s) { bb_simple_herror_msg(s); }
1413static inline void __attribute__ ((deprecated("use bb_simple_herror_msg_and_die instead"))) NORETURN
1414 bb_not_simple_herror_msg_and_die(const char *s) { bb_simple_herror_msg_and_die(s); }
1415static inline void __attribute__ ((deprecated("use bb_simple_info_msg instead")))
1416 bb_not_simple_info_msg(const char *s) { bb_simple_info_msg(s); }
1417/* Override bb_error_msg() and related functions with macros that will
1418 * substitute them for the equivalent bb_not_simple_error_msg() function when
1419 * they are used with only a single parameter. Macro approach inspired by
1420 * https://gustedt.wordpress.com/2010/06/08/detect-empty-macro-arguments and
1421 * https://gustedt.wordpress.com/2010/06/03/default-arguments-for-c99
1422 */
1423#define _ARG18(_0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11, _12, _13, _14, _15, _16, _17, ...) _17
1424#define BB_MSG_KIND(...) _ARG18(__VA_ARGS__, , , , , , , , , , , , , , , , , _not_simple)
1425#define _BB_MSG(name, kind, ...) bb##kind##name(__VA_ARGS__)
1426#define BB_MSG(name, kind, ...) _BB_MSG(name, kind, __VA_ARGS__)
1427#define bb_error_msg(...) BB_MSG(_error_msg, BB_MSG_KIND(__VA_ARGS__), __VA_ARGS__)
1428#define bb_error_msg_and_die(...) BB_MSG(_error_msg_and_die, BB_MSG_KIND(__VA_ARGS__), __VA_ARGS__)
1429#define bb_perror_msg(...) BB_MSG(_perror_msg, BB_MSG_KIND(__VA_ARGS__), __VA_ARGS__)
1430#define bb_perror_msg_and_die(...) BB_MSG(_perror_msg_and_die, BB_MSG_KIND(__VA_ARGS__), __VA_ARGS__)
1431#define bb_herror_msg(...) BB_MSG(_herror_msg, BB_MSG_KIND(__VA_ARGS__), __VA_ARGS__)
1432#define bb_herror_msg_and_die(...) BB_MSG(_herror_msg_and_die, BB_MSG_KIND(__VA_ARGS__), __VA_ARGS__)
Denys Vlasenko6eb38fd2020-06-23 02:46:53 +02001433#if ENABLE_FEATURE_SYSLOG_INFO
James Byrne69374872019-07-02 11:35:03 +02001434#define bb_info_msg(...) BB_MSG(_info_msg, BB_MSG_KIND(__VA_ARGS__), __VA_ARGS__)
1435#endif
Denys Vlasenko6eb38fd2020-06-23 02:46:53 +02001436#endif
James Byrne69374872019-07-02 11:35:03 +02001437
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +00001438/* We need to export XXX_main from libbusybox
1439 * only if we build "individual" binaries
1440 */
1441#if ENABLE_FEATURE_INDIVIDUAL
1442#define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
1443#else
1444#define MAIN_EXTERNALLY_VISIBLE
1445#endif
1446
Denys Vlasenko4f2ef4a2018-11-01 09:53:25 +01001447/* Embedded script support */
Denys Vlasenko4f2ef4a2018-11-01 09:53:25 +01001448char *get_script_content(unsigned n) FAST_FUNC;
Ron Yorston3193cb52019-03-30 07:47:12 +00001449int scripted_main(int argc, char** argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001450
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001451/* Applets which are useful from another applets */
Denys Vlasenkod9eb40c2017-04-12 15:48:19 +02001452int bb_cat(char** argv) FAST_FUNC;
Denys Vlasenko4f2ef4a2018-11-01 09:53:25 +01001453int ash_main(int argc, char** argv)
1454#if ENABLE_ASH || ENABLE_SH_IS_ASH || ENABLE_BASH_IS_ASH
1455 MAIN_EXTERNALLY_VISIBLE
1456#endif
1457;
Ron Yorston71df2d32018-11-27 14:34:25 +00001458int hush_main(int argc, char** argv)
1459#if ENABLE_HUSH || ENABLE_SH_IS_HUSH || ENABLE_BASH_IS_HUSH
1460 MAIN_EXTERNALLY_VISIBLE
1461#endif
1462;
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001463/* If shell needs them, they exist even if not enabled as applets */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001464int echo_main(int argc, char** argv) IF_ECHO(MAIN_EXTERNALLY_VISIBLE);
1465int printf_main(int argc, char **argv) IF_PRINTF(MAIN_EXTERNALLY_VISIBLE);
Denys Vlasenko548620c2016-12-08 12:24:48 +01001466int test_main(int argc, char **argv)
1467#if ENABLE_TEST || ENABLE_TEST1 || ENABLE_TEST2
1468 MAIN_EXTERNALLY_VISIBLE
1469#endif
1470;
1471int kill_main(int argc, char **argv)
1472#if ENABLE_KILL || ENABLE_KILLALL || ENABLE_KILLALL5
1473 MAIN_EXTERNALLY_VISIBLE
1474#endif
1475;
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001476/* Similar, but used by chgrp, not shell */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001477int chown_main(int argc, char **argv) IF_CHOWN(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenkoc41cba52009-03-09 15:46:07 +00001478/* Used by ftpd */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001479int ls_main(int argc, char **argv) IF_LS(MAIN_EXTERNALLY_VISIBLE);
1480/* Don't need IF_xxx() guard for these */
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +00001481int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko77f1ec12007-10-13 03:36:03 +00001482int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko1a9e9bd2008-11-01 12:54:56 +00001483
Denis Vlasenko468aea22008-04-01 14:47:57 +00001484#if ENABLE_ROUTE
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001485void bb_displayroutes(int noresolve, int netstatfmt) FAST_FUNC;
Denis Vlasenko468aea22008-04-01 14:47:57 +00001486#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001487
Denys Vlasenkod88f94a2017-04-05 18:17:17 +02001488struct number_state {
1489 unsigned width;
1490 unsigned start;
1491 unsigned inc;
1492 const char *sep;
1493 const char *empty_str;
1494 smallint all, nonempty;
1495};
Denys Vlasenkoc1005352018-11-29 11:44:10 +01001496int print_numbered_lines(struct number_state *ns, const char *filename) FAST_FUNC;
Denys Vlasenkod88f94a2017-04-05 18:17:17 +02001497
Denis Vlasenko270c17c2006-12-26 17:40:33 +00001498
1499/* Networking */
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001500/* This structure defines protocol families and their handlers. */
1501struct aftype {
1502 const char *name;
1503 const char *title;
1504 int af;
1505 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001506 char* FAST_FUNC (*print)(unsigned char *);
1507 const char* FAST_FUNC (*sprint)(struct sockaddr *, int numeric);
1508 int FAST_FUNC (*input)(/*int type,*/ const char *bufp, struct sockaddr *);
1509 void FAST_FUNC (*herror)(char *text);
1510 int FAST_FUNC (*rprint)(int options);
1511 int FAST_FUNC (*rinput)(int typ, int ext, char **argv);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001512 /* may modify src */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001513 int FAST_FUNC (*getmask)(char *src, struct sockaddr *mask, char *name);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001514};
1515/* This structure defines hardware protocols and their handlers. */
1516struct hwtype {
1517 const char *name;
1518 const char *title;
1519 int type;
1520 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001521 char* FAST_FUNC (*print)(unsigned char *);
1522 int FAST_FUNC (*input)(const char *, struct sockaddr *);
1523 int FAST_FUNC (*activate)(int fd);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001524 int suppress_null_addr;
1525};
Denys Vlasenko82ec8942018-03-05 17:46:17 +01001526#define IFNAME_SHOW_DOWNED_TOO ((char*)(intptr_t)1)
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001527int display_interfaces(char *ifname) FAST_FUNC;
Bartosz Golaszewskic19be752013-07-25 04:39:04 +02001528int in_ether(const char *bufp, struct sockaddr *sap) FAST_FUNC;
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001529#if ENABLE_FEATURE_HWIB
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001530int in_ib(const char *bufp, struct sockaddr *sap) FAST_FUNC;
Denis Vlasenko3b162ec2008-06-04 07:59:51 +00001531#else
1532#define in_ib(a, b) 1 /* fail */
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001533#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001534const struct aftype *get_aftype(const char *name) FAST_FUNC;
1535const struct hwtype *get_hwtype(const char *name) FAST_FUNC;
1536const struct hwtype *get_hwntype(int type) FAST_FUNC;
Denis Vlasenko270c17c2006-12-26 17:40:33 +00001537
1538
Denys Vlasenko35b54a32017-01-30 00:45:05 +01001539extern int fstype_matches(const char *fstype, const char *comma_list) FAST_FUNC;
Mike Frysinger9412ec72008-02-07 22:41:33 +00001540#ifdef HAVE_MNTENT_H
Denys Vlasenko6ae64262009-07-18 16:22:26 +02001541extern struct mntent *find_mount_point(const char *name, int subdir_too) FAST_FUNC;
Mike Frysinger9412ec72008-02-07 22:41:33 +00001542#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001543extern void erase_mtab(const char * name) FAST_FUNC;
1544extern unsigned int tty_baud_to_value(speed_t speed) FAST_FUNC;
1545extern speed_t tty_value_to_baud(unsigned int value) FAST_FUNC;
Denys Vlasenkoa355da02010-01-04 13:16:08 +01001546#if ENABLE_DESKTOP
1547extern void bb_warn_ignoring_args(char *arg) FAST_FUNC;
1548#else
1549# define bb_warn_ignoring_args(arg) ((void)0)
1550#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001551
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001552extern int get_linux_version_code(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001553
Denys Vlasenko3b69ba72019-06-09 23:20:49 +02001554char *query_loop(const char *device) FAST_FUNC;
1555int get_free_loop(void) FAST_FUNC;
1556int del_loop(const char *device) FAST_FUNC;
Denys Vlasenkoab518ee2017-03-16 16:49:37 +01001557/*
1558 * If *devname is not NULL, use that name, otherwise try to find free one,
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001559 * malloc and return it in *devname.
Denys Vlasenkoab518ee2017-03-16 16:49:37 +01001560 * return value is the opened fd to the loop device, or < on error
1561 */
Steffen Trumtrar6561e072020-07-29 10:43:53 +02001562int set_loop(char **devname, const char *file, unsigned long long offset,
1563 unsigned long long sizelimit, unsigned flags) FAST_FUNC;
Denys Vlasenkoab518ee2017-03-16 16:49:37 +01001564/* These constants match linux/loop.h (without BB_ prefix): */
1565#define BB_LO_FLAGS_READ_ONLY 1
1566#define BB_LO_FLAGS_AUTOCLEAR 4
Jack O'Sullivan726cbb12019-05-28 15:28:27 +01001567#define BB_LO_FLAGS_PARTSCAN 8
Eric Andersenaad1a882001-03-16 22:47:14 +00001568
Denys Vlasenko17058a02018-04-07 15:50:30 +02001569/* Returns malloced str */
1570char *bb_ask_noecho(int fd, int timeout, const char *prompt) FAST_FUNC;
1571/* Like bb_ask_noecho, but asks on stdin with no timeout. */
Denys Vlasenko77cb6b92018-04-07 15:08:12 +02001572char *bb_ask_noecho_stdin(const char *prompt) FAST_FUNC;
Denys Vlasenko17058a02018-04-07 15:50:30 +02001573
Denys Vlasenkobae8fc42018-04-07 15:21:35 +02001574int bb_ask_y_confirmation_FILE(FILE *fp) FAST_FUNC;
Denys Vlasenko77cb6b92018-04-07 15:08:12 +02001575int bb_ask_y_confirmation(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001576
Denys Vlasenko5711a2a2015-10-07 17:55:33 +02001577/* Returns -1 if input is invalid. current_mode is a base for e.g. "u+rw" */
1578int bb_parse_mode(const char* s, unsigned cur_mode) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001579
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001580/*
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001581 * Config file parser
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001582 */
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001583enum {
Denis Vlasenko084266e2008-07-26 23:08:31 +00001584 PARSE_COLLAPSE = 0x00010000, // treat consecutive delimiters as one
1585 PARSE_TRIM = 0x00020000, // trim leading and trailing delimiters
1586// TODO: COLLAPSE and TRIM seem to always go in pair
1587 PARSE_GREEDY = 0x00040000, // last token takes entire remainder of the line
1588 PARSE_MIN_DIE = 0x00100000, // die if < min tokens found
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001589 // keep a copy of current line
Denis Vlasenko35a064b2008-11-06 00:49:59 +00001590 PARSE_KEEP_COPY = 0x00200000 * ENABLE_FEATURE_CROND_D,
Denys Vlasenko499597d2012-01-11 00:37:17 +01001591 PARSE_EOL_COMMENTS = 0x00400000, // comments are recognized even if they aren't the first char
Denys Vlasenko50db1f22017-08-05 18:20:34 +02001592 PARSE_ALT_COMMENTS = 0x00800000, // delim[0] and delim[1] are two different allowed comment chars
1593 // (so far, delim[0] will only work as comment char for full-line comment)
1594 // (IOW: it works as if PARSE_EOL_COMMENTS is not set. sysctl applet is okay with this)
1595 PARSE_WS_COMMENTS = 0x01000000, // comments are recognized even if there is whitespace before
1596 // ("line start><space><tab><space>#comment" is also comment, not only "line start>#comment")
Denis Vlasenko084266e2008-07-26 23:08:31 +00001597 // NORMAL is:
1598 // * remove leading and trailing delimiters and collapse
1599 // multiple delimiters into one
1600 // * warn and continue if less than mintokens delimiters found
1601 // * grab everything into last token
Denys Vlasenko499597d2012-01-11 00:37:17 +01001602 // * comments are recognized even if they aren't the first char
1603 PARSE_NORMAL = PARSE_COLLAPSE | PARSE_TRIM | PARSE_GREEDY | PARSE_EOL_COMMENTS,
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001604};
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001605typedef struct parser_t {
1606 FILE *fp;
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001607 char *data;
Timo Terasadcabf32011-06-20 09:49:56 +02001608 char *line, *nline;
1609 size_t line_alloc, nline_alloc;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001610 int lineno;
1611} parser_t;
Bernhard Reutner-Fischer67921282008-07-17 11:59:13 +00001612parser_t* config_open(const char *filename) FAST_FUNC;
Denis Vlasenko5415c852008-07-21 23:05:26 +00001613parser_t* config_open2(const char *filename, FILE* FAST_FUNC (*fopen_func)(const char *path)) FAST_FUNC;
Denys Vlasenkoadbbee42010-06-21 07:17:23 +02001614/* delims[0] is a comment char (use '\0' to disable), the rest are token delimiters */
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001615int config_read(parser_t *parser, char **tokens, unsigned flags, const char *delims) FAST_FUNC;
1616#define config_read(parser, tokens, max, min, str, flags) \
1617 config_read(parser, tokens, ((flags) | (((min) & 0xFF) << 8) | ((max) & 0xFF)), str)
Denis Vlasenkoc01340f2008-07-16 22:12:18 +00001618void config_close(parser_t *parser) FAST_FUNC;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001619
Denis Vlasenko6bf05cf2008-05-07 12:18:48 +00001620/* Concatenate path and filename to new allocated buffer.
1621 * Add "/" only as needed (no duplicate "//" are produced).
1622 * If path is NULL, it is assumed to be "/".
1623 * filename should not be NULL. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001624char *concat_path_file(const char *path, const char *filename) FAST_FUNC;
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +02001625/* Returns NULL on . and .. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001626char *concat_subpath_file(const char *path, const char *filename) FAST_FUNC;
Eric Andersene5dfced2001-04-09 22:48:12 +00001627
Denis Vlasenko4921b542007-02-03 02:17:41 +00001628
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001629int bb_make_directory(char *path, long mode, int flags) FAST_FUNC;
Matt Kraaiceeff732001-06-21 19:41:37 +00001630
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001631int get_signum(const char *name) FAST_FUNC;
1632const char *get_signame(int number) FAST_FUNC;
1633void print_signames(void) FAST_FUNC;
Rob Landleyc9c1a412006-07-12 19:17:55 +00001634
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001635char *bb_simplify_path(const char *path) FAST_FUNC;
Denis Vlasenko1cf4a0e2009-04-22 13:49:16 +00001636/* Returns ptr to NUL */
1637char *bb_simplify_abs_path_inplace(char *path) FAST_FUNC;
Eric Andersen34506362001-08-02 05:02:46 +00001638
Denys Vlasenko87bd5582020-11-29 11:32:48 +01001639void pause_after_failed_login(void) FAST_FUNC;
Denys Vlasenko6a55b4e2020-11-29 12:40:25 +01001640void bb_do_delay(unsigned seconds) FAST_FUNC;
1641void msleep(unsigned ms) FAST_FUNC;
Denys Vlasenkoec16c032020-11-29 11:37:34 +01001642void sleep1(void) FAST_FUNC;
Denys Vlasenko87bd5582020-11-29 11:32:48 +01001643void change_identity(const struct passwd *pw) FAST_FUNC;
Denys Vlasenko2075aa92020-12-02 21:28:47 +01001644void exec_shell(const char *shell, int loginshell, const char **args) NORETURN FAST_FUNC;
Denys Vlasenkof4f6e512020-12-02 21:51:08 +01001645void exec_login_shell(const char *shell) NORETURN FAST_FUNC;
Denys Vlasenko2075aa92020-12-02 21:28:47 +01001646void exec_prog_or_SHELL(char **argv) NORETURN FAST_FUNC;
Denys Vlasenko681efe22011-03-08 21:00:36 +01001647
1648/* Returns $SHELL, getpwuid(getuid())->pw_shell, or DEFAULT_SHELL.
1649 * Note that getpwuid result might need xstrdup'ing
1650 * if there is a possibility of intervening getpwxxx() calls.
1651 */
Denys Vlasenkofd77ea52012-10-03 09:42:21 +02001652const char *get_shell_name(void) FAST_FUNC;
Denys Vlasenko681efe22011-03-08 21:00:36 +01001653
Denys Vlasenko2af5e3f2018-02-21 20:13:39 +01001654#if ENABLE_FEATURE_SETPRIV_CAPABILITIES || ENABLE_RUN_INIT
Denys Vlasenko44b3f2f2017-08-21 02:14:19 +02001655unsigned cap_name_to_number(const char *cap) FAST_FUNC;
1656void printf_cap(const char *pfx, unsigned cap_no) FAST_FUNC;
Denys Vlasenko200bcc82017-08-21 19:30:01 +02001657void drop_capability(int cap_ordinal) FAST_FUNC;
1658/* Structures inside "struct caps" are Linux-specific and libcap-specific: */
1659#define DEFINE_STRUCT_CAPS \
1660struct caps { \
1661 struct __user_cap_header_struct header; \
1662 unsigned u32s; \
1663 struct __user_cap_data_struct data[2]; \
1664}
1665void getcaps(void *caps) FAST_FUNC;
Denys Vlasenko2af5e3f2018-02-21 20:13:39 +01001666#endif
Denys Vlasenko44b3f2f2017-08-21 02:14:19 +02001667
Denis Vlasenkob5a122b2006-12-30 14:46:51 +00001668#if ENABLE_SELINUX
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001669extern void renew_current_security_context(void) FAST_FUNC;
1670extern void set_current_security_context(security_context_t sid) FAST_FUNC;
Denis Vlasenko1203c9b2007-03-11 22:16:02 +00001671extern context_t set_security_context_component(security_context_t cur_context,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001672 char *user, char *role, char *type, char *range) FAST_FUNC;
1673extern void setfscreatecon_or_die(security_context_t scontext) FAST_FUNC;
1674extern void selinux_preserve_fcontext(int fdesc) FAST_FUNC;
Denis Vlasenko2edbc2a2007-10-20 02:00:49 +00001675#else
1676#define selinux_preserve_fcontext(fdesc) ((void)0)
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001677#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001678extern void selinux_or_die(void) FAST_FUNC;
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001679
Davide Cavalca9b3b9792011-01-25 02:26:03 +01001680
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001681/* setup_environment:
Bernhard Reutner-Fischer99709ab2010-02-24 16:10:09 +01001682 * if chdir pw->pw_dir: ok: else if to_tmp == 1: goto /tmp else: goto / or die
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001683 * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001684 * TERM=(old value)
1685 * USER=pw->pw_name, LOGNAME=pw->pw_name
1686 * PATH=bb_default_[root_]path
1687 * HOME=pw->pw_dir
1688 * SHELL=shell
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001689 * else if change_env = 1:
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001690 * if not root (if pw->pw_uid != 0):
1691 * USER=pw->pw_name, LOGNAME=pw->pw_name
1692 * HOME=pw->pw_dir
1693 * SHELL=shell
1694 * else does nothing
Denys Vlasenkoe4f6bfd2017-07-22 03:04:20 +02001695 *
1696 * NB: CHANGEENV and CLEARENV use setenv() - this leaks memory!
1697 * If setup_environment() is used is vforked child, this leaks memory _in parent too_!
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001698 */
Denys Vlasenkofd686a22010-02-26 09:52:45 +01001699#define SETUP_ENV_CHANGEENV (1 << 0)
1700#define SETUP_ENV_CLEARENV (1 << 1)
1701#define SETUP_ENV_TO_TMP (1 << 2)
Pascal Bellard70fc8c12012-06-12 13:21:02 +02001702#define SETUP_ENV_NO_CHDIR (1 << 4)
Denys Vlasenko8b59b2c2013-11-19 13:36:45 +01001703void setup_environment(const char *shell, int flags, const struct passwd *pw) FAST_FUNC;
1704void nuke_str(char *str) FAST_FUNC;
Kaarle Ritvanen517a82c2016-01-02 00:20:39 +02001705#if ENABLE_FEATURE_SECURETTY && !ENABLE_PAM
Denys Vlasenkoa3de0b32017-04-13 13:04:05 +02001706int is_tty_secure(const char *short_tty) FAST_FUNC;
Kaarle Ritvanen517a82c2016-01-02 00:20:39 +02001707#else
Denys Vlasenkoa3de0b32017-04-13 13:04:05 +02001708static ALWAYS_INLINE int is_tty_secure(const char *short_tty UNUSED_PARAM) { return 1; }
Kaarle Ritvanen517a82c2016-01-02 00:20:39 +02001709#endif
Denys Vlasenko335681c2017-04-13 12:57:04 +02001710#define CHECKPASS_PW_HAS_EMPTY_PASSWORD 2
Morten Kvistgaardfeac9b62014-08-05 21:57:18 +02001711int check_password(const struct passwd *pw, const char *plaintext) FAST_FUNC;
Denys Vlasenko8b59b2c2013-11-19 13:36:45 +01001712int ask_and_check_password_extended(const struct passwd *pw, int timeout, const char *prompt) FAST_FUNC;
1713int ask_and_check_password(const struct passwd *pw) FAST_FUNC;
Denis Vlasenkofdddab02008-06-12 16:56:52 +00001714/* Returns a malloced string */
Denis Vlasenkob4c5bf62008-06-15 18:35:34 +00001715#if !ENABLE_USE_BB_CRYPT
1716#define pw_encrypt(clear, salt, cleanup) pw_encrypt(clear, salt)
1717#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001718extern char *pw_encrypt(const char *clear, const char *salt, int cleanup) FAST_FUNC;
1719extern int obscure(const char *old, const char *newval, const struct passwd *pwdp) FAST_FUNC;
Denys Vlasenko12a43272011-05-13 03:19:01 +02001720/*
1721 * rnd is additional random input. New one is returned.
Denis Vlasenko4ea83bf2008-06-12 16:55:59 +00001722 * Useful if you call crypt_make_salt many times in a row:
1723 * rnd = crypt_make_salt(buf1, 4, 0);
1724 * rnd = crypt_make_salt(buf2, 4, rnd);
1725 * rnd = crypt_make_salt(buf3, 4, rnd);
1726 * (otherwise we risk having same salt generated)
1727 */
Denys Vlasenko12a43272011-05-13 03:19:01 +02001728extern int crypt_make_salt(char *p, int cnt /*, int rnd*/) FAST_FUNC;
1729/* "$N$" + sha_salt_16_bytes + NUL */
1730#define MAX_PW_SALT_LEN (3 + 16 + 1)
1731extern char* crypt_make_pw_salt(char p[MAX_PW_SALT_LEN], const char *algo) FAST_FUNC;
1732
Denis Vlasenko829bbd32009-04-14 00:51:05 +00001733
Denis Vlasenko4ea83bf2008-06-12 16:55:59 +00001734/* Returns number of lines changed, or -1 on error */
Denis Vlasenko829bbd32009-04-14 00:51:05 +00001735#if !(ENABLE_FEATURE_ADDUSER_TO_GROUP || ENABLE_FEATURE_DEL_USER_FROM_GROUP)
1736#define update_passwd(filename, username, data, member) \
1737 update_passwd(filename, username, data)
1738#endif
1739extern int update_passwd(const char *filename,
1740 const char *username,
1741 const char *data,
1742 const char *member) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001743
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001744int index_in_str_array(const char *const string_array[], const char *key) FAST_FUNC;
1745int index_in_strings(const char *strings, const char *key) FAST_FUNC;
1746int index_in_substr_array(const char *const string_array[], const char *key) FAST_FUNC;
1747int index_in_substrings(const char *strings, const char *key) FAST_FUNC;
1748const char *nth_string(const char *strings, int n) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001749
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001750extern void print_login_issue(const char *issue_file, const char *tty) FAST_FUNC;
1751extern void print_login_prompt(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001752
Denys Vlasenko53283ad2009-11-02 14:20:34 +01001753char *xmalloc_ttyname(int fd) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof893da82007-08-09 08:27:24 +00001754/* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001755int get_terminal_width_height(int fd, unsigned *width, unsigned *height) FAST_FUNC;
Denys Vlasenko641caae2015-10-23 01:44:22 +02001756int get_terminal_width(int fd) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001757
Denis Vlasenko202ac502008-11-05 13:20:58 +00001758int tcsetattr_stdin_TCSANOW(const struct termios *tp) FAST_FUNC;
Denys Vlasenko058a1532018-04-16 10:24:48 +02001759#define TERMIOS_CLEAR_ISIG (1 << 0)
1760#define TERMIOS_RAW_CRNL_INPUT (1 << 1)
1761#define TERMIOS_RAW_CRNL_OUTPUT (1 << 2)
1762#define TERMIOS_RAW_CRNL (TERMIOS_RAW_CRNL_INPUT|TERMIOS_RAW_CRNL_OUTPUT)
1763#define TERMIOS_RAW_INPUT (1 << 3)
Denys Vlasenkoaaaaaa52017-09-15 17:14:01 +02001764int get_termios_and_make_raw(int fd, struct termios *newterm, struct termios *oldterm, int flags) FAST_FUNC;
Denys Vlasenko01ccdd12017-01-11 16:17:59 +01001765int set_termios_to_raw(int fd, struct termios *oldterm, int flags) FAST_FUNC;
Denis Vlasenko202ac502008-11-05 13:20:58 +00001766
Denis Vlasenko5bb2fc22008-04-21 03:23:59 +00001767/* NB: "unsigned request" is crucial! "int request" will break some arches! */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001768int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1769int 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 +00001770#if ENABLE_IOCTL_HEX2STR_ERROR
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001771int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1772int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001773#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1774#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
1775#else
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001776int bb_ioctl_or_warn(int fd, unsigned request, void *argp) FAST_FUNC;
1777int bb_xioctl(int fd, unsigned request, void *argp) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001778#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1779#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
1780#endif
1781
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001782char *is_in_ino_dev_hashtable(const struct stat *statbuf) FAST_FUNC;
1783void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name) FAST_FUNC;
1784void reset_ino_dev_hashtable(void) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001785#ifdef __GLIBC__
1786/* At least glibc has horrendously large inline for this, so wrap it */
Denys Vlasenko975c7142011-01-24 23:53:12 +01001787unsigned long long bb_makedev(unsigned major, unsigned minor) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001788#undef makedev
1789#define makedev(a,b) bb_makedev(a,b)
1790#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001791
1792
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001793/* "Keycodes" that report an escape sequence.
1794 * We use something which fits into signed char,
Denys Vlasenko5370bfb2009-09-06 02:58:59 +02001795 * yet doesn't represent any valid Unicode character.
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001796 * Also, -1 is reserved for error indication and we don't use it. */
1797enum {
Rostislav Skudnov2e4ef382016-11-24 15:04:00 +01001798 KEYCODE_UP = -2,
1799 KEYCODE_DOWN = -3,
1800 KEYCODE_RIGHT = -4,
1801 KEYCODE_LEFT = -5,
1802 KEYCODE_HOME = -6,
1803 KEYCODE_END = -7,
1804 KEYCODE_INSERT = -8,
1805 KEYCODE_DELETE = -9,
1806 KEYCODE_PAGEUP = -10,
1807 KEYCODE_PAGEDOWN = -11,
1808 KEYCODE_BACKSPACE = -12, /* Used only if Alt/Ctrl/Shifted */
1809 KEYCODE_D = -13, /* Used only if Alted */
Denys Vlasenko9ce09bc2011-11-03 13:28:22 +01001810#if 0
Rostislav Skudnov2e4ef382016-11-24 15:04:00 +01001811 KEYCODE_FUN1 = ,
1812 KEYCODE_FUN2 = ,
1813 KEYCODE_FUN3 = ,
1814 KEYCODE_FUN4 = ,
1815 KEYCODE_FUN5 = ,
1816 KEYCODE_FUN6 = ,
1817 KEYCODE_FUN7 = ,
1818 KEYCODE_FUN8 = ,
1819 KEYCODE_FUN9 = ,
1820 KEYCODE_FUN10 = ,
1821 KEYCODE_FUN11 = ,
1822 KEYCODE_FUN12 = ,
Denys Vlasenko9ce09bc2011-11-03 13:28:22 +01001823#endif
Rostislav Skudnov2e4ef382016-11-24 15:04:00 +01001824 /* ^^^^^ Be sure that last defined value is small enough.
1825 * Current read_key() code allows going up to -32 (0xfff..fffe0).
1826 * This gives three upper bits in LSB to play with:
1827 * KEYCODE_foo values are 0xfff..fffXX, lowest XX bits are: scavvvvv,
1828 * s=0 if SHIFT, c=0 if CTRL, a=0 if ALT,
1829 * vvvvv bits are the same for same key regardless of "shift bits".
Denys Vlasenko9ce09bc2011-11-03 13:28:22 +01001830 */
Rostislav Skudnov2e4ef382016-11-24 15:04:00 +01001831 //KEYCODE_SHIFT_... = KEYCODE_... & ~0x80,
1832 KEYCODE_CTRL_RIGHT = KEYCODE_RIGHT & ~0x40,
1833 KEYCODE_CTRL_LEFT = KEYCODE_LEFT & ~0x40,
1834 KEYCODE_ALT_RIGHT = KEYCODE_RIGHT & ~0x20,
1835 KEYCODE_ALT_LEFT = KEYCODE_LEFT & ~0x20,
1836 KEYCODE_ALT_BACKSPACE = KEYCODE_BACKSPACE & ~0x20,
1837 KEYCODE_ALT_D = KEYCODE_D & ~0x20,
Denys Vlasenko9ce09bc2011-11-03 13:28:22 +01001838
Denys Vlasenko180f5852009-10-26 00:59:59 +01001839 KEYCODE_CURSOR_POS = -0x100, /* 0xfff..fff00 */
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001840 /* How long is the longest ESC sequence we know?
1841 * We want it big enough to be able to contain
1842 * cursor position sequence "ESC [ 9999 ; 9999 R"
1843 */
1844 KEYCODE_BUFFER_SIZE = 16
1845};
1846/* Note: fd may be in blocking or non-blocking mode, both make sense.
1847 * For one, less uses non-blocking mode.
1848 * Only the first read syscall inside read_key may block indefinitely
1849 * (unless fd is in non-blocking mode),
1850 * subsequent reads will time out after a few milliseconds.
1851 * Return of -1 means EOF or error (errno == 0 on EOF).
1852 * buffer[0] is used as a counter of buffered chars and must be 0
1853 * on first call.
Denys Vlasenko58f108e2010-03-11 21:17:55 +01001854 * timeout:
Denys Vlasenko84ea60e2017-08-02 17:27:28 +02001855 * -2: do not poll(-1) for input - read() it, return on EAGAIN at once
1856 * -1: poll(-1) (i.e. block even on NONBLOCKed fd)
1857 * >=0: poll() for TIMEOUT milliseconds, return -1/EAGAIN on timeout
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001858 */
Denys Vlasenko58f108e2010-03-11 21:17:55 +01001859int64_t read_key(int fd, char *buffer, int timeout) FAST_FUNC;
Tomas Heinrichd2b04052010-03-09 14:09:24 +01001860void read_key_ungets(char *buffer, const char *str, unsigned len) FAST_FUNC;
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001861
1862
Denis Vlasenko38f63192007-01-22 09:03:07 +00001863#if ENABLE_FEATURE_EDITING
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001864/* It's NOT just ENABLEd or disabled. It's a number: */
Denys Vlasenko2c4de5b2011-03-31 13:16:52 +02001865# if defined CONFIG_FEATURE_EDITING_HISTORY && CONFIG_FEATURE_EDITING_HISTORY > 0
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001866# define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
Flemming Madsend96ffda2013-04-07 18:47:24 +02001867unsigned size_from_HISTFILESIZE(const char *hp) FAST_FUNC;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001868# else
1869# define MAX_HISTORY 0
1870# endif
Ron Yorston9e2a5662020-01-21 16:01:58 +00001871typedef const char *get_exe_name_t(int i) FAST_FUNC;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001872typedef struct line_input_t {
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001873 int flags;
Denys Vlasenko84ea60e2017-08-02 17:27:28 +02001874 int timeout;
Denys Vlasenkoeaced1e2020-12-16 10:01:21 +01001875# if ENABLE_FEATURE_TAB_COMPLETION
1876# if ENABLE_SHELL_ASH
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001877 const char *path_lookup;
Denys Vlasenkoeaced1e2020-12-16 10:01:21 +01001878# define EDITING_HAS_path_lookup 1
1879# else
1880# define EDITING_HAS_path_lookup 0
1881# endif
1882# if ENABLE_SHELL_ASH || ENABLE_SHELL_HUSH
Ron Yorston9e2a5662020-01-21 16:01:58 +00001883 /* function to fetch additional application-specific names to match */
1884 get_exe_name_t *get_exe_name;
Denys Vlasenkoeaced1e2020-12-16 10:01:21 +01001885# define EDITING_HAS_get_exe_name 1
1886# else
1887# define EDITING_HAS_get_exe_name 0
1888# endif
Ron Yorston9e2a5662020-01-21 16:01:58 +00001889# endif
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001890# if MAX_HISTORY
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001891 int cnt_history;
1892 int cur_history;
Denys Vlasenko2c4de5b2011-03-31 13:16:52 +02001893 int max_history; /* must never be <= 0 */
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001894# if ENABLE_FEATURE_EDITING_SAVEHISTORY
Denys Vlasenkobede2152011-09-04 16:12:33 +02001895 /* meaning of this field depends on FEATURE_EDITING_SAVE_ON_EXIT:
1896 * if !FEATURE_EDITING_SAVE_ON_EXIT: "how many lines are
1897 * in on-disk history"
1898 * if FEATURE_EDITING_SAVE_ON_EXIT: "how many in-memory lines are
1899 * also in on-disk history (and thus need to be skipped on save)"
1900 */
Denis Vlasenko57abf9e2009-03-22 19:00:05 +00001901 unsigned cnt_history_in_file;
Denis Vlasenko57abf9e2009-03-22 19:00:05 +00001902 const char *hist_file;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001903# endif
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001904 char *history[MAX_HISTORY + 1];
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001905# endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001906} line_input_t;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001907enum {
Denys Vlasenkoe45af7a2011-09-04 16:15:24 +02001908 DO_HISTORY = 1 * (MAX_HISTORY > 0),
1909 TAB_COMPLETION = 2 * ENABLE_FEATURE_TAB_COMPLETION,
1910 USERNAME_COMPLETION = 4 * ENABLE_FEATURE_USERNAME_COMPLETION,
1911 VI_MODE = 8 * ENABLE_FEATURE_EDITING_VI,
1912 WITH_PATH_LOOKUP = 0x10,
1913 FOR_SHELL = DO_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001914};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001915line_input_t *new_line_input_t(int flags) FAST_FUNC;
Denys Vlasenko00eb23b2020-12-21 21:36:58 +01001916#if ENABLE_FEATURE_EDITING_SAVEHISTORY
Denys Vlasenkoa68a87c2018-12-06 11:12:38 +01001917void free_line_input_t(line_input_t *n) FAST_FUNC;
Denys Vlasenko00eb23b2020-12-21 21:36:58 +01001918#else
1919# define free_line_input_t(n) free(n)
1920#endif
Denys Vlasenko046341e2011-02-04 17:53:59 +01001921/*
1922 * maxsize must be >= 2.
Denys Vlasenko5c2e81b2009-07-16 14:14:34 +02001923 * Returns:
Denis Vlasenko80667e32008-02-02 18:35:55 +00001924 * -1 on read errors or EOF, or on bare Ctrl-D,
1925 * 0 on ctrl-C (the line entered is still returned in 'command'),
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001926 * >0 length of input string, including terminating '\n'
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001927 */
Denys Vlasenko84ea60e2017-08-02 17:27:28 +02001928int read_line_input(line_input_t *st, const char *prompt, char *command, int maxsize) FAST_FUNC;
Flemming Madsend96ffda2013-04-07 18:47:24 +02001929void show_history(const line_input_t *st) FAST_FUNC;
Denys Vlasenkobede2152011-09-04 16:12:33 +02001930# if ENABLE_FEATURE_EDITING_SAVE_ON_EXIT
1931void save_history(line_input_t *st);
1932# endif
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001933#else
Denys Vlasenko36df0482009-10-19 16:07:28 +02001934#define MAX_HISTORY 0
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001935int read_line_input(const char* prompt, char* command, int maxsize) FAST_FUNC;
Denys Vlasenko84ea60e2017-08-02 17:27:28 +02001936#define read_line_input(state, prompt, command, maxsize) \
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001937 read_line_input(prompt, command, maxsize)
1938#endif
1939
Ron Yorston9e2a5662020-01-21 16:01:58 +00001940#ifndef EDITING_HAS_get_exe_name
1941# define EDITING_HAS_get_exe_name 0
1942#endif
1943
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001944
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001945#ifndef COMM_LEN
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001946# ifdef TASK_COMM_LEN
Denis Vlasenkofa076802006-11-05 00:38:51 +00001947enum { COMM_LEN = TASK_COMM_LEN };
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001948# else
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001949/* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
Denis Vlasenkofa076802006-11-05 00:38:51 +00001950enum { COMM_LEN = 16 };
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001951# endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001952#endif
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02001953
1954struct smaprec {
1955 unsigned long mapped_rw;
1956 unsigned long mapped_ro;
1957 unsigned long shared_clean;
1958 unsigned long shared_dirty;
1959 unsigned long private_clean;
1960 unsigned long private_dirty;
1961 unsigned long stack;
1962 unsigned long smap_pss, smap_swap;
1963 unsigned long smap_size;
Denys Vlasenkoaad76962018-12-30 20:24:59 +01001964 // For mixed 32/64 userspace, 32-bit pmap still needs
1965 // 64-bit field here to correctly show 64-bit processes:
1966 unsigned long long smap_start;
1967 // (strictly speaking, other fields need to be wider too,
1968 // but they are in kbytes, not bytes, and they hold sizes,
1969 // not start addresses, sizes tend to be less than 4 terabytes)
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02001970 char smap_mode[5];
1971 char *smap_name;
1972};
1973
1974#if !ENABLE_PMAP
1975#define procps_read_smaps(pid, total, cb, data) \
1976 procps_read_smaps(pid, total)
1977#endif
1978int FAST_FUNC procps_read_smaps(pid_t pid, struct smaprec *total,
Denys Vlasenko6830ade2013-01-15 13:58:01 +01001979 void (*cb)(struct smaprec *, void *), void *data);
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02001980
Denis Vlasenko512499c2007-08-26 18:23:13 +00001981typedef struct procps_status_t {
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001982 DIR *dir;
Denys Vlasenkob410d4a2009-09-19 22:29:42 +02001983 IF_FEATURE_SHOW_THREADS(DIR *task_dir;)
Denis Vlasenko512499c2007-08-26 18:23:13 +00001984 uint8_t shift_pages_to_bytes;
1985 uint8_t shift_pages_to_kb;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001986/* Fields are set to 0/NULL if failed to determine (or not requested) */
Denis Vlasenko3b3ca112008-07-17 18:39:36 +00001987 uint16_t argv_len;
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001988 char *argv0;
Alexander Shishkine766f622009-07-29 01:35:13 +02001989 char *exe;
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001990 IF_SELINUX(char *context;)
Lauri Kasanen6578f2c2010-12-05 05:22:29 +01001991 IF_FEATURE_SHOW_THREADS(unsigned main_thread_pid;)
Denis Vlasenko0696b8a2007-06-06 07:40:16 +00001992 /* Everything below must contain no ptrs to malloc'ed data:
1993 * it is memset(0) for each process in procps_scan() */
Denis Vlasenkofc1e9952007-08-29 18:23:36 +00001994 unsigned long vsz, rss; /* we round it to kbytes */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001995 unsigned long stime, utime;
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001996 unsigned long start_time;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001997 unsigned pid;
1998 unsigned ppid;
1999 unsigned pgid;
2000 unsigned sid;
2001 unsigned uid;
2002 unsigned gid;
Denys Vlasenkofca70a82009-07-03 22:16:17 +02002003#if ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS
2004 unsigned ruid;
2005 unsigned rgid;
2006 int niceness;
2007#endif
Denis Vlasenko31789a82007-06-19 14:43:17 +00002008 unsigned tty_major,tty_minor;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00002009#if ENABLE_FEATURE_TOPMEM
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02002010 struct smaprec smaps;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00002011#endif
Denis Vlasenko459e4d62006-11-05 00:43:51 +00002012 char state[4];
Denis Vlasenko98ebab82007-06-30 14:47:41 +00002013 /* basename of executable in exec(2), read from /proc/N/stat
2014 * (if executable is symlink or script, it is NOT replaced
2015 * by link target or interpreter name) */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00002016 char comm[COMM_LEN];
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00002017 /* user/group? - use passwd/group parsing functions */
Denis Vlasenko17e7f042008-09-25 10:48:06 +00002018#if ENABLE_FEATURE_TOP_SMP_PROCESS
2019 int last_seen_on_cpu;
2020#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00002021} procps_status_t;
Denys Vlasenkofca70a82009-07-03 22:16:17 +02002022/* flag bits for procps_scan(xx, flags) calls */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00002023enum {
2024 PSSCAN_PID = 1 << 0,
2025 PSSCAN_PPID = 1 << 1,
2026 PSSCAN_PGID = 1 << 2,
2027 PSSCAN_SID = 1 << 3,
2028 PSSCAN_UIDGID = 1 << 4,
2029 PSSCAN_COMM = 1 << 5,
Denis Vlasenko98ebab82007-06-30 14:47:41 +00002030 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00002031 PSSCAN_ARGV0 = 1 << 7,
Alexander Shishkine766f622009-07-29 01:35:13 +02002032 PSSCAN_EXE = 1 << 8,
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00002033 PSSCAN_STATE = 1 << 9,
2034 PSSCAN_VSZ = 1 << 10,
2035 PSSCAN_RSS = 1 << 11,
2036 PSSCAN_STIME = 1 << 12,
2037 PSSCAN_UTIME = 1 << 13,
2038 PSSCAN_TTY = 1 << 14,
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00002039 PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM,
Denis Vlasenko9f00e052009-02-14 01:36:11 +00002040 /* NB: used by find_pid_by_name(). Any applet using it
2041 * needs to be mentioned here. */
2042 PSSCAN_ARGVN = (1 << 16) * (ENABLE_KILLALL
2043 || ENABLE_PGREP || ENABLE_PKILL
2044 || ENABLE_PIDOF
Denis Vlasenko3266aa92009-04-01 11:24:04 +00002045 || ENABLE_SESTATUS
Denis Vlasenko9f00e052009-02-14 01:36:11 +00002046 ),
Denys Vlasenko4ff1ce02009-09-22 11:21:48 +02002047 PSSCAN_CONTEXT = (1 << 17) * ENABLE_SELINUX,
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00002048 PSSCAN_START_TIME = 1 << 18,
Denys Vlasenkofca70a82009-07-03 22:16:17 +02002049 PSSCAN_CPU = (1 << 19) * ENABLE_FEATURE_TOP_SMP_PROCESS,
2050 PSSCAN_NICE = (1 << 20) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
2051 PSSCAN_RUIDGID = (1 << 21) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
Denys Vlasenkob410d4a2009-09-19 22:29:42 +02002052 PSSCAN_TASKS = (1 << 22) * ENABLE_FEATURE_SHOW_THREADS,
Denis Vlasenko459e4d62006-11-05 00:43:51 +00002053};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00002054//procps_status_t* alloc_procps_scan(void) FAST_FUNC;
2055void free_procps_scan(procps_status_t* sp) FAST_FUNC;
2056procps_status_t* procps_scan(procps_status_t* sp, int flags) FAST_FUNC;
Denys Vlasenko3a0f6f22009-09-12 00:15:34 +02002057/* Format cmdline (up to col chars) into char buf[size] */
Denis Vlasenko98ebab82007-06-30 14:47:41 +00002058/* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
Denys Vlasenko3a0f6f22009-09-12 00:15:34 +02002059void read_cmdline(char *buf, int size, unsigned pid, const char *comm) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00002060pid_t *find_pid_by_name(const char* procName) FAST_FUNC;
2061pid_t *pidlist_reverse(pid_t *pidList) FAST_FUNC;
Denys Vlasenkoc9b97502010-08-16 02:49:21 +02002062int starts_with_cpu(const char *str) FAST_FUNC;
2063unsigned get_cpu_count(void) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00002064
2065
Denys Vlasenkodd1061b2011-09-11 21:04:02 +02002066/* Use strict=1 if you process input from untrusted source:
2067 * it will return NULL on invalid %xx (bad hex chars)
2068 * and str + 1 if decoded char is / or NUL.
2069 * In non-strict mode, it always succeeds (returns str),
2070 * and also it additionally decoded '+' to space.
2071 */
2072char *percent_decode_in_place(char *str, int strict) FAST_FUNC;
2073
2074
Aurelien Jarnod3a42392012-07-24 16:28:34 +02002075extern const char bb_uuenc_tbl_base64[] ALIGN1;
Denys Vlasenko20900482020-11-25 22:47:00 +01002076extern const char bb_uuenc_tbl_base32[] ALIGN1;
Aurelien Jarnod3a42392012-07-24 16:28:34 +02002077extern const char bb_uuenc_tbl_std[] ALIGN1;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00002078void bb_uuencode(char *store, const void *s, int length, const char *tbl) FAST_FUNC;
Denys Vlasenko9fe98f72010-09-16 17:51:13 +02002079enum {
2080 BASE64_FLAG_UU_STOP = 0x100,
Denys Vlasenko20900482020-11-25 22:47:00 +01002081 BASE64_32 = 0x200, /* base32 */
Denys Vlasenko9fe98f72010-09-16 17:51:13 +02002082 /* Sign-extends to a value which never matches fgetc result: */
2083 BASE64_FLAG_NO_STOP_CHAR = 0x80,
2084};
Denys Vlasenko885121e2020-11-28 13:26:44 +01002085char *decode_base64(char *dst, const char **pp_src) FAST_FUNC;
2086char *decode_base32(char *dst, const char **pp_src) FAST_FUNC;
Leonid Lisovskiy328f27f2011-10-28 13:59:04 +02002087void read_base64(FILE *src_stream, FILE *dst_stream, int flags) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00002088
Denis Vlasenkodd539f72006-11-01 20:20:37 +00002089typedef struct md5_ctx_t {
Denys Vlasenko302ad142010-10-19 02:16:12 +02002090 uint8_t wbuffer[64]; /* always correctly aligned for uint64_t */
2091 void (*process_block)(struct md5_ctx_t*) FAST_FUNC;
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02002092 uint64_t total64; /* must be directly before hash[] */
Denys Vlasenko302ad142010-10-19 02:16:12 +02002093 uint32_t hash[8]; /* 4 elements for md5, 5 for sha1, 8 for sha256 */
2094} md5_ctx_t;
2095typedef struct md5_ctx_t sha1_ctx_t;
2096typedef struct md5_ctx_t sha256_ctx_t;
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02002097typedef struct sha512_ctx_t {
2098 uint64_t total64[2]; /* must be directly before hash[] */
2099 uint64_t hash[8];
Denys Vlasenko302ad142010-10-19 02:16:12 +02002100 uint8_t wbuffer[128]; /* always correctly aligned for uint64_t */
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02002101} sha512_ctx_t;
Lauri Kasanenb8173b62013-01-14 05:20:50 +01002102typedef struct sha3_ctx_t {
2103 uint64_t state[25];
2104 unsigned bytes_queued;
Denys Vlasenko71a090f2016-08-29 14:05:25 +02002105 unsigned input_block_bytes;
Lauri Kasanenb8173b62013-01-14 05:20:50 +01002106} sha3_ctx_t;
Denys Vlasenko302ad142010-10-19 02:16:12 +02002107void md5_begin(md5_ctx_t *ctx) FAST_FUNC;
Denys Vlasenko2cfcc9e2013-01-20 00:38:09 +01002108void md5_hash(md5_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
Denys Vlasenko49ecee02017-01-24 16:00:54 +01002109unsigned md5_end(md5_ctx_t *ctx, void *resbuf) FAST_FUNC;
Denys Vlasenko302ad142010-10-19 02:16:12 +02002110void sha1_begin(sha1_ctx_t *ctx) FAST_FUNC;
2111#define sha1_hash md5_hash
Denys Vlasenko49ecee02017-01-24 16:00:54 +01002112unsigned sha1_end(sha1_ctx_t *ctx, void *resbuf) FAST_FUNC;
Denys Vlasenko302ad142010-10-19 02:16:12 +02002113void sha256_begin(sha256_ctx_t *ctx) FAST_FUNC;
2114#define sha256_hash md5_hash
2115#define sha256_end sha1_end
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02002116void sha512_begin(sha512_ctx_t *ctx) FAST_FUNC;
2117void sha512_hash(sha512_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
Denys Vlasenko49ecee02017-01-24 16:00:54 +01002118unsigned sha512_end(sha512_ctx_t *ctx, void *resbuf) FAST_FUNC;
Lauri Kasanenb8173b62013-01-14 05:20:50 +01002119void sha3_begin(sha3_ctx_t *ctx) FAST_FUNC;
2120void sha3_hash(sha3_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
Denys Vlasenko49ecee02017-01-24 16:00:54 +01002121unsigned sha3_end(sha3_ctx_t *ctx, void *resbuf) FAST_FUNC;
2122/* TLS benefits from knowing that sha1 and sha256 share these. Give them "agnostic" names too */
2123typedef struct md5_ctx_t md5sha_ctx_t;
2124#define md5sha_hash md5_hash
2125#define sha_end sha1_end
Denys Vlasenko9a2d8992020-07-20 00:04:33 +02002126enum {
2127 MD5_OUTSIZE = 16,
2128 SHA1_OUTSIZE = 20,
2129 SHA256_OUTSIZE = 32,
2130 SHA512_OUTSIZE = 64,
2131 SHA3_OUTSIZE = 28,
2132};
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00002133
Denys Vlasenko9ce642f2010-10-27 15:26:45 +02002134extern uint32_t *global_crc32_table;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00002135uint32_t *crc32_filltable(uint32_t *tbl256, int endian) FAST_FUNC;
Denys Vlasenkoddacb032018-02-01 10:56:19 +01002136uint32_t *crc32_new_table_le(void) FAST_FUNC;
2137uint32_t *global_crc32_new_table_le(void) FAST_FUNC;
Denys Vlasenko9ce642f2010-10-27 15:26:45 +02002138uint32_t crc32_block_endian1(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
2139uint32_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 +00002140
2141typedef struct masks_labels_t {
2142 const char *labels;
2143 const int masks[];
2144} masks_labels_t;
2145int print_flags_separated(const int *masks, const char *labels,
2146 int flags, const char *separator) FAST_FUNC;
2147int print_flags(const masks_labels_t *ml, int flags) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00002148
Magnus Dammf5914992009-11-08 16:34:43 +01002149typedef struct bb_progress_t {
Denys Vlasenkoab8d00d2011-02-11 19:09:30 +01002150 unsigned last_size;
2151 unsigned last_update_sec;
2152 unsigned last_change_sec;
Magnus Dammf5914992009-11-08 16:34:43 +01002153 unsigned start_sec;
Denys Vlasenkoedccc982018-02-13 16:48:52 +01002154 /*unsigned last_eta;*/
Denys Vlasenkod55e1392011-02-11 18:56:13 +01002155 const char *curfile;
Magnus Dammf5914992009-11-08 16:34:43 +01002156} bb_progress_t;
2157
Denys Vlasenkod55e1392011-02-11 18:56:13 +01002158#define is_bb_progress_inited(p) ((p)->curfile != NULL)
2159#define bb_progress_free(p) do { \
2160 if (ENABLE_UNICODE_SUPPORT) free((char*)((p)->curfile)); \
2161 (p)->curfile = NULL; \
2162} while (0)
2163void bb_progress_init(bb_progress_t *p, const char *curfile) FAST_FUNC;
Denys Vlasenko26602b82018-11-23 19:14:52 +01002164int bb_progress_update(bb_progress_t *p,
Denys Vlasenko805aa9f2011-02-10 14:25:51 +01002165 uoff_t beg_range,
2166 uoff_t transferred,
2167 uoff_t totalsize) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00002168
Sven Eisenbergb068cf22016-04-03 21:53:12 +02002169unsigned ubi_devnum_from_devname(const char *str) FAST_FUNC;
Denys Vlasenko6aab9922016-04-03 22:24:51 +02002170int ubi_get_volid_by_name(unsigned ubi_devnum, const char *vol_name) FAST_FUNC;
Sven Eisenbergb068cf22016-04-03 21:53:12 +02002171
Denys Vlasenkod55e1392011-02-11 18:56:13 +01002172
Denis Vlasenko8f8f2682006-10-03 21:00:43 +00002173extern const char *applet_name;
Denys Vlasenko0004e992010-09-01 12:01:17 +02002174
2175/* Some older linkers don't perform string merging, we used to have common strings
2176 * as global arrays to do it by hand. But:
2177 * (1) newer linkers do it themselves,
2178 * (2) however, they DONT merge string constants with global arrays,
2179 * even if the value is the same (!). Thus global arrays actually
2180 * increased size a bit: for example, "/etc/passwd" string from libc
2181 * wasn't merged with bb_path_passwd_file[] array!
2182 * Therefore now we use #defines.
2183 */
Bernhard Reutner-Fischer78e1d582008-01-13 17:52:53 +00002184/* "BusyBox vN.N.N (timestamp or extra_version)" */
Aurelien Jarnod3a42392012-07-24 16:28:34 +02002185extern const char bb_banner[] ALIGN1;
2186extern const char bb_msg_memory_exhausted[] ALIGN1;
2187extern const char bb_msg_invalid_date[] ALIGN1;
Denys Vlasenko0004e992010-09-01 12:01:17 +02002188#define bb_msg_read_error "read error"
2189#define bb_msg_write_error "write error"
Aurelien Jarnod3a42392012-07-24 16:28:34 +02002190extern const char bb_msg_unknown[] ALIGN1;
2191extern const char bb_msg_can_not_create_raw_socket[] ALIGN1;
2192extern const char bb_msg_perm_denied_are_you_root[] ALIGN1;
2193extern const char bb_msg_you_must_be_root[] ALIGN1;
2194extern const char bb_msg_requires_arg[] ALIGN1;
Denys Vlasenko0f296a32015-10-14 13:21:01 +02002195extern const char bb_msg_invalid_arg_to[] ALIGN1;
Aurelien Jarnod3a42392012-07-24 16:28:34 +02002196extern const char bb_msg_standard_input[] ALIGN1;
2197extern const char bb_msg_standard_output[] ALIGN1;
Manuel Novoa III cad53642003-03-19 09:13:01 +00002198
Denis Vlasenko98c0bba2007-01-26 23:31:05 +00002199/* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
Aurelien Jarnod3a42392012-07-24 16:28:34 +02002200extern const char bb_hexdigits_upcase[] ALIGN1;
Denis Vlasenko7ca39212006-11-21 20:34:21 +00002201
Aurelien Jarnod3a42392012-07-24 16:28:34 +02002202extern const char bb_path_wtmp_file[] ALIGN1;
Denys Vlasenko0004e992010-09-01 12:01:17 +02002203
2204/* Busybox mount uses either /proc/mounts or /etc/mtab to
2205 * get the list of currently mounted filesystems */
2206#define bb_path_mtab_file IF_FEATURE_MTAB_SUPPORT("/etc/mtab")IF_NOT_FEATURE_MTAB_SUPPORT("/proc/mounts")
2207
Tito Ragusaad3d72f2011-01-16 23:39:45 +01002208#define bb_path_passwd_file _PATH_PASSWD
2209#define bb_path_group_file _PATH_GROUP
2210#define bb_path_shadow_file _PATH_SHADOW
2211#define bb_path_gshadow_file _PATH_GSHADOW
Denys Vlasenko0004e992010-09-01 12:01:17 +02002212
2213#define bb_path_motd_file "/etc/motd"
2214
2215#define bb_dev_null "/dev/null"
Aurelien Jarnod3a42392012-07-24 16:28:34 +02002216extern const char bb_busybox_exec_path[] ALIGN1;
Denys Vlasenkocca7c612018-01-12 13:21:33 +01002217/* allow default system PATH to be extended via CFLAGS */
2218#ifndef BB_ADDITIONAL_PATH
2219#define BB_ADDITIONAL_PATH ""
2220#endif
2221#define BB_PATH_ROOT_PATH "PATH=/sbin:/usr/sbin:/bin:/usr/bin" BB_ADDITIONAL_PATH
2222extern const char bb_PATH_root_path[] ALIGN1; /* BB_PATH_ROOT_PATH */
Denis Vlasenkof5f75c52007-06-12 22:35:19 +00002223#define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
Denys Vlasenkocca7c612018-01-12 13:21:33 +01002224/* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
2225 * but I want to save a few bytes here:
2226 */
Denis Vlasenkof5f75c52007-06-12 22:35:19 +00002227#define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +00002228
Denis Vlasenko703e2022007-01-22 14:12:08 +00002229extern const int const_int_0;
Denys Vlasenkoc52cbea2015-08-24 19:48:03 +02002230//extern const int const_int_1;
Denis Vlasenko703e2022007-01-22 14:12:08 +00002231
Denis Vlasenko972288e2007-03-15 00:57:01 +00002232/* This struct is deliberately not defined. */
2233/* See docs/keep_data_small.txt */
2234struct globals;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00002235/* '*const' ptr makes gcc optimize code much better.
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002236 * Magic prevents ptr_to_globals from going into rodata.
Denis Vlasenko574f2f42008-02-27 18:41:59 +00002237 * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
Denis Vlasenkobff32ce2007-03-15 19:48:35 +00002238extern struct globals *const ptr_to_globals;
Denys Vlasenkoaf7169b2019-10-25 12:12:22 +02002239
2240#if defined(__clang_major__) && __clang_major__ >= 9
2241/* Clang/llvm drops assignment to "constant" storage. Silently.
2242 * Needs serious convincing to not eliminate the store.
2243 */
2244static ALWAYS_INLINE void* not_const_pp(const void *p)
2245{
2246 void *pp;
2247 __asm__ __volatile__(
2248 "# forget that p points to const"
2249 : /*outputs*/ "=r" (pp)
2250 : /*inputs*/ "0" (p)
2251 );
2252 return pp;
2253}
2254#else
2255static ALWAYS_INLINE void* not_const_pp(const void *p) { return (void*)p; }
2256#endif
2257
Denis Vlasenko574f2f42008-02-27 18:41:59 +00002258/* At least gcc 3.4.6 on mipsel system needs optimization barrier */
Bernhard Reutner-Fischer797c96d2008-06-06 10:31:39 +00002259#define barrier() __asm__ __volatile__("":::"memory")
Denis Vlasenko574f2f42008-02-27 18:41:59 +00002260#define SET_PTR_TO_GLOBALS(x) do { \
Denys Vlasenkoaf7169b2019-10-25 12:12:22 +02002261 (*(struct globals**)not_const_pp(&ptr_to_globals)) = (void*)(x); \
Denis Vlasenko574f2f42008-02-27 18:41:59 +00002262 barrier(); \
2263} while (0)
Denys Vlasenkoaf7169b2019-10-25 12:12:22 +02002264
Guilherme Maciel Ferreira840ef172013-10-16 14:43:30 +02002265#define FREE_PTR_TO_GLOBALS() do { \
2266 if (ENABLE_FEATURE_CLEAN_UP) { \
2267 free(ptr_to_globals); \
2268 } \
2269} while (0)
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00002270
Denis Vlasenkodca0b702006-10-27 09:05:02 +00002271/* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
2272 * use bb_default_login_shell and following defines.
2273 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
2274 * don't forget to change increment constant. */
Ladislav Michla73b87e2010-06-27 03:23:31 +02002275#define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
Aurelien Jarnod3a42392012-07-24 16:28:34 +02002276extern const char bb_default_login_shell[] ALIGN1;
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00002277/* "/bin/sh" */
Ladislav Michla73b87e2010-06-27 03:23:31 +02002278#define DEFAULT_SHELL (bb_default_login_shell+1)
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00002279/* "sh" */
Ladislav Michla73b87e2010-06-27 03:23:31 +02002280#define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00002281
Jeremie Koenig816ed972010-05-27 15:46:29 +02002282/* The following devices are the same on all systems. */
2283#define CURRENT_TTY "/dev/tty"
2284#define DEV_CONSOLE "/dev/console"
2285
2286#if defined(__FreeBSD_kernel__)
2287# define CURRENT_VC CURRENT_TTY
2288# define VC_1 "/dev/ttyv0"
2289# define VC_2 "/dev/ttyv1"
2290# define VC_3 "/dev/ttyv2"
2291# define VC_4 "/dev/ttyv3"
2292# define VC_5 "/dev/ttyv4"
2293# define VC_FORMAT "/dev/ttyv%d"
2294#elif defined(__GNU__)
2295# define CURRENT_VC CURRENT_TTY
2296# define VC_1 "/dev/tty1"
2297# define VC_2 "/dev/tty2"
2298# define VC_3 "/dev/tty3"
2299# define VC_4 "/dev/tty4"
2300# define VC_5 "/dev/tty5"
2301# define VC_FORMAT "/dev/tty%d"
Denys Vlasenko1c26e052010-10-24 02:35:17 +02002302#elif ENABLE_FEATURE_DEVFS
2303/*Linux, obsolete devfs names */
Matt Kraai439e3df2001-07-23 14:52:08 +00002304# define CURRENT_VC "/dev/vc/0"
2305# define VC_1 "/dev/vc/1"
2306# define VC_2 "/dev/vc/2"
2307# define VC_3 "/dev/vc/3"
2308# define VC_4 "/dev/vc/4"
2309# define VC_5 "/dev/vc/5"
Matt Kraai439e3df2001-07-23 14:52:08 +00002310# define VC_FORMAT "/dev/vc/%d"
Denys Vlasenko4928e9f2013-06-27 03:45:16 +02002311# define LOOP_FORMAT "/dev/loop/%u"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00002312# define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00002313# define LOOP_NAME "/dev/loop/"
Eric Andersen5f284552003-11-14 03:11:29 +00002314# define FB_0 "/dev/fb/0"
Matt Kraai439e3df2001-07-23 14:52:08 +00002315#else
Denys Vlasenko1c26e052010-10-24 02:35:17 +02002316/*Linux, normal names */
Matt Kraai439e3df2001-07-23 14:52:08 +00002317# define CURRENT_VC "/dev/tty0"
2318# define VC_1 "/dev/tty1"
2319# define VC_2 "/dev/tty2"
2320# define VC_3 "/dev/tty3"
2321# define VC_4 "/dev/tty4"
2322# define VC_5 "/dev/tty5"
Matt Kraai439e3df2001-07-23 14:52:08 +00002323# define VC_FORMAT "/dev/tty%d"
Denys Vlasenko4928e9f2013-06-27 03:45:16 +02002324# define LOOP_FORMAT "/dev/loop%u"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00002325# define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00002326# define LOOP_NAME "/dev/loop"
Eric Andersen5f284552003-11-14 03:11:29 +00002327# define FB_0 "/dev/fb0"
Matt Kraai439e3df2001-07-23 14:52:08 +00002328#endif
2329
Denys Vlasenkoabfa3ec2018-09-28 15:13:04 +02002330// storage helpers for mk*fs utilities
2331char BUG_wrong_field_size(void);
2332#define STORE_LE(field, value) \
2333do { \
2334 if (sizeof(field) == 4) \
2335 field = SWAP_LE32((uint32_t)(value)); \
2336 else if (sizeof(field) == 2) \
2337 field = SWAP_LE16((uint16_t)(value)); \
2338 else if (sizeof(field) == 1) \
2339 field = (uint8_t)(value); \
2340 else \
2341 BUG_wrong_field_size(); \
2342} while (0)
2343
2344#define FETCH_LE32(field) \
2345 (sizeof(field) == 4 ? SWAP_LE32(field) : BUG_wrong_field_size())
2346
Rob Landleyc57ec372006-04-10 17:07:15 +00002347
Denys Vlasenko9d57a802009-10-23 14:24:44 +02002348#define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
Denys Vlasenkoab3964d2015-10-13 14:50:20 +02002349#define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
Denys Vlasenko9d57a802009-10-23 14:24:44 +02002350
Rob Landleyb623a542006-05-31 22:09:03 +00002351
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02002352/* We redefine ctype macros. Unicode-correct handling of char types
2353 * can't be done with such byte-oriented operations anyway,
2354 * we don't lose anything.
2355 */
Rob Landley4ae905a2006-07-06 17:22:54 +00002356#undef isalnum
2357#undef isalpha
2358#undef isascii
2359#undef isblank
2360#undef iscntrl
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02002361#undef isdigit
Rob Landley4ae905a2006-07-06 17:22:54 +00002362#undef isgraph
2363#undef islower
2364#undef isprint
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02002365#undef ispunct
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02002366#undef isspace
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02002367#undef isupper
2368#undef isxdigit
2369#undef toupper
2370#undef tolower
Rob Landley4ae905a2006-07-06 17:22:54 +00002371
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02002372/* We save ~500 bytes on isdigit alone.
Denys Vlasenko7b4cd6f2009-10-23 02:22:03 +02002373 * BTW, x86 likes (unsigned char) cast more than (unsigned). */
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01002374
2375/* These work the same for ASCII and Unicode,
2376 * assuming no one asks "is this a *Unicode* letter?" using isalpha(letter) */
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02002377#define isascii(a) ((unsigned char)(a) <= 0x7f)
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01002378#define isdigit(a) ((unsigned char)((a) - '0') <= 9)
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02002379#define isupper(a) ((unsigned char)((a) - 'A') <= ('Z' - 'A'))
2380#define islower(a) ((unsigned char)((a) - 'a') <= ('z' - 'a'))
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02002381#define isalpha(a) ((unsigned char)(((a)|0x20) - 'a') <= ('z' - 'a'))
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02002382#define isblank(a) ({ unsigned char bb__isblank = (a); bb__isblank == ' ' || bb__isblank == '\t'; })
2383#define iscntrl(a) ({ unsigned char bb__iscntrl = (a); bb__iscntrl < ' ' || bb__iscntrl == 0x7f; })
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02002384/* In POSIX/C locale isspace is only these chars: "\t\n\v\f\r" and space.
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02002385 * "\t\n\v\f\r" happen to have ASCII codes 9,10,11,12,13.
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02002386 */
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02002387#define isspace(a) ({ unsigned char bb__isspace = (a) - 9; bb__isspace == (' ' - 9) || bb__isspace <= (13 - 9); })
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01002388// Unsafe wrt NUL: #define ispunct(a) (strchr("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a)) != NULL)
2389#define ispunct(a) (strchrnul("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a))[0])
2390// 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 +02002391#define isalnum(a) bb_ascii_isalnum(a)
2392static ALWAYS_INLINE int bb_ascii_isalnum(unsigned char a)
2393{
2394 unsigned char b = a - '0';
2395 if (b <= 9)
2396 return (b <= 9);
2397 b = (a|0x20) - 'a';
2398 return b <= 'z' - 'a';
2399}
2400#define isxdigit(a) bb_ascii_isxdigit(a)
2401static ALWAYS_INLINE int bb_ascii_isxdigit(unsigned char a)
2402{
2403 unsigned char b = a - '0';
2404 if (b <= 9)
2405 return (b <= 9);
2406 b = (a|0x20) - 'a';
2407 return b <= 'f' - 'a';
2408}
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02002409#define toupper(a) bb_ascii_toupper(a)
2410static ALWAYS_INLINE unsigned char bb_ascii_toupper(unsigned char a)
2411{
2412 unsigned char b = a - 'a';
2413 if (b <= ('z' - 'a'))
2414 a -= 'a' - 'A';
2415 return a;
2416}
2417#define tolower(a) bb_ascii_tolower(a)
2418static ALWAYS_INLINE unsigned char bb_ascii_tolower(unsigned char a)
2419{
2420 unsigned char b = a - 'A';
2421 if (b <= ('Z' - 'A'))
2422 a += 'a' - 'A';
2423 return a;
2424}
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02002425
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01002426/* In ASCII and Unicode, these are likely to be very different.
2427 * Let's prevent ambiguous usage from the start */
2428#define isgraph(a) isgraph_is_ambiguous_dont_use(a)
2429#define isprint(a) isprint_is_ambiguous_dont_use(a)
2430/* NB: must not treat EOF as isgraph or isprint */
2431#define isgraph_asciionly(a) ((unsigned)((a) - 0x21) <= 0x7e - 0x21)
2432#define isprint_asciionly(a) ((unsigned)((a) - 0x20) <= 0x7e - 0x20)
2433
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02002434
Bartosz Golaszewski3ed81cf2014-06-22 16:30:41 +02002435/* Simple unit-testing framework */
2436
2437typedef void (*bbunit_testfunc)(void);
2438
2439struct bbunit_listelem {
Bartosz Golaszewski3ed81cf2014-06-22 16:30:41 +02002440 const char* name;
2441 bbunit_testfunc testfunc;
2442};
2443
2444void bbunit_registertest(struct bbunit_listelem* test);
2445void bbunit_settestfailed(void);
2446
2447#define BBUNIT_DEFINE_TEST(NAME) \
2448 static void bbunit_##NAME##_test(void); \
2449 static struct bbunit_listelem bbunit_##NAME##_elem = { \
2450 .name = #NAME, \
2451 .testfunc = bbunit_##NAME##_test, \
2452 }; \
Bartosz Golaszewskibf0f2c72014-06-26 14:31:05 +02002453 static void INIT_FUNC bbunit_##NAME##_register(void) \
Bartosz Golaszewski3ed81cf2014-06-22 16:30:41 +02002454 { \
2455 bbunit_registertest(&bbunit_##NAME##_elem); \
2456 } \
2457 static void bbunit_##NAME##_test(void)
2458
2459/*
2460 * Both 'goto bbunit_end' and 'break' are here only to get rid
2461 * of compiler warnings.
2462 */
2463#define BBUNIT_ENDTEST \
2464 do { \
2465 goto bbunit_end; \
2466 bbunit_end: \
2467 break; \
2468 } while (0)
2469
2470#define BBUNIT_PRINTASSERTFAIL \
2471 do { \
2472 bb_error_msg( \
2473 "[ERROR] Assertion failed in file %s, line %d", \
2474 __FILE__, __LINE__); \
2475 } while (0)
2476
2477#define BBUNIT_ASSERTION_FAILED \
2478 do { \
2479 bbunit_settestfailed(); \
2480 goto bbunit_end; \
2481 } while (0)
2482
2483/*
2484 * Assertions.
2485 * For now we only offer assertions which cause tests to fail
2486 * immediately. In the future 'expects' might be added too -
2487 * similar to those offered by the gtest framework.
2488 */
2489#define BBUNIT_ASSERT_EQ(EXPECTED, ACTUAL) \
2490 do { \
2491 if ((EXPECTED) != (ACTUAL)) { \
2492 BBUNIT_PRINTASSERTFAIL; \
2493 bb_error_msg("[ERROR] '%s' isn't equal to '%s'", \
2494 #EXPECTED, #ACTUAL); \
2495 BBUNIT_ASSERTION_FAILED; \
2496 } \
2497 } while (0)
2498
2499#define BBUNIT_ASSERT_NOTEQ(EXPECTED, ACTUAL) \
2500 do { \
2501 if ((EXPECTED) == (ACTUAL)) { \
2502 BBUNIT_PRINTASSERTFAIL; \
2503 bb_error_msg("[ERROR] '%s' is equal to '%s'", \
2504 #EXPECTED, #ACTUAL); \
2505 BBUNIT_ASSERTION_FAILED; \
2506 } \
2507 } while (0)
2508
2509#define BBUNIT_ASSERT_NOTNULL(PTR) \
2510 do { \
2511 if ((PTR) == NULL) { \
2512 BBUNIT_PRINTASSERTFAIL; \
2513 bb_error_msg("[ERROR] '%s' is NULL!", #PTR); \
2514 BBUNIT_ASSERTION_FAILED; \
2515 } \
2516 } while (0)
2517
2518#define BBUNIT_ASSERT_NULL(PTR) \
2519 do { \
2520 if ((PTR) != NULL) { \
2521 BBUNIT_PRINTASSERTFAIL; \
2522 bb_error_msg("[ERROR] '%s' is not NULL!", #PTR); \
2523 BBUNIT_ASSERTION_FAILED; \
2524 } \
2525 } while (0)
2526
2527#define BBUNIT_ASSERT_FALSE(STATEMENT) \
2528 do { \
2529 if ((STATEMENT)) { \
2530 BBUNIT_PRINTASSERTFAIL; \
2531 bb_error_msg("[ERROR] Statement '%s' evaluated to true!", \
2532 #STATEMENT); \
2533 BBUNIT_ASSERTION_FAILED; \
2534 } \
2535 } while (0)
2536
2537#define BBUNIT_ASSERT_TRUE(STATEMENT) \
2538 do { \
2539 if (!(STATEMENT)) { \
2540 BBUNIT_PRINTASSERTFAIL; \
2541 bb_error_msg("[ERROR] Statement '%s' evaluated to false!", \
2542 #STATEMENT); \
2543 BBUNIT_ASSERTION_FAILED; \
2544 } \
2545 } while (0)
2546
2547#define BBUNIT_ASSERT_STREQ(STR1, STR2) \
2548 do { \
2549 if (strcmp(STR1, STR2) != 0) { \
2550 BBUNIT_PRINTASSERTFAIL; \
2551 bb_error_msg("[ERROR] Strings '%s' and '%s' " \
2552 "are not the same", STR1, STR2); \
2553 BBUNIT_ASSERTION_FAILED; \
2554 } \
2555 } while (0)
2556
2557#define BBUNIT_ASSERT_STRNOTEQ(STR1, STR2) \
2558 do { \
2559 if (strcmp(STR1, STR2) == 0) { \
2560 BBUNIT_PRINTASSERTFAIL; \
2561 bb_error_msg("[ERROR] Strings '%s' and '%s' " \
2562 "are the same, but were " \
2563 "expected to differ", STR1, STR2); \
2564 BBUNIT_ASSERTION_FAILED; \
2565 } \
2566 } while (0)
2567
2568
Denis Vlasenkof81e8db2009-04-09 12:35:13 +00002569POP_SAVED_FUNCTION_VISIBILITY
2570
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +00002571#endif