blob: 392c0443d324e271bf561c02424f9489d92e1160 [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
Kylie McClain40eea692016-02-01 01:36:05 +0100109# include <utmp.h>
Bernhard Reutner-Fischer7d863842015-04-19 23:45:17 +0200110# include <utmpx.h>
Kylie McClain40eea692016-02-01 01:36:05 +0100111# if defined _PATH_UTMP && !defined _PATH_UTMPX
112# define _PATH_UTMPX _PATH_UTMP
113# endif
Bernhard Reutner-Fischer7d863842015-04-19 23:45:17 +0200114# endif
Denys Vlasenko8d0e0cd2011-01-25 23:21:46 +0100115#endif
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000116#if ENABLE_LOCALE_SUPPORT
Denys Vlasenko9d57a802009-10-23 14:24:44 +0200117# include <locale.h>
Rob Landleyeb84a422006-09-20 21:41:13 +0000118#else
Denys Vlasenko9d57a802009-10-23 14:24:44 +0200119# define setlocale(x,y) ((void)0)
Rob Landleyd921b2e2006-08-03 15:41:12 +0000120#endif
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000121#ifdef DMALLOC
Denys Vlasenko9d57a802009-10-23 14:24:44 +0200122# include <dmalloc.h>
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000123#endif
Tito Ragusaad3d72f2011-01-16 23:39:45 +0100124/* Just in case libc doesn't define some of these... */
125#ifndef _PATH_PASSWD
126#define _PATH_PASSWD "/etc/passwd"
127#endif
128#ifndef _PATH_GROUP
129#define _PATH_GROUP "/etc/group"
130#endif
131#ifndef _PATH_SHADOW
132#define _PATH_SHADOW "/etc/shadow"
133#endif
134#ifndef _PATH_GSHADOW
135#define _PATH_GSHADOW "/etc/gshadow"
136#endif
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +0200137#if defined __FreeBSD__ || defined __OpenBSD__
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +0100138# include <netinet/in.h>
139# include <arpa/inet.h>
140#elif defined __APPLE__
141# include <netinet/in.h>
142#else
143# include <arpa/inet.h>
Denys Vlasenkodbb58a32016-03-14 18:23:33 +0100144//This breaks on bionic:
145//# if !defined(__socklen_t_defined) && !defined(_SOCKLEN_T_DECLARED)
146///* We #define socklen_t *after* includes, otherwise we get
147// * typedef redefinition errors from system headers
148// * (in case "is it defined already" detection above failed)
149// */
150//# define socklen_t bb_socklen_t
151// typedef unsigned socklen_t;
152//# endif
153//if this is still needed, add a fix along the lines of
154// ifdef SPECIFIC_BROKEN_LIBC_CHECK / typedef socklen_t / endif
155//in platform.h instead!
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +0100156#endif
Chris Rees330718e2011-01-24 17:07:06 +0100157#ifndef HAVE_CLEARENV
158# define clearenv() do { if (environ) environ[0] = NULL; } while (0)
159#endif
160#ifndef HAVE_FDATASYNC
161# define fdatasync fsync
162#endif
163#ifndef HAVE_XTABS
164# define XTABS TAB3
165#endif
Denys Vlasenko6f97b302017-09-29 18:17:25 +0200166/*
167 * Use '%m' to append error string on platforms that support it,
168 * '%s' and strerror() on those that don't.
169 */
170#ifdef HAVE_PRINTF_PERCENTM
171# define STRERROR_FMT "%m"
172# define STRERROR_ERRNO /*nothing*/
173#else
174# define STRERROR_FMT "%s"
175# define STRERROR_ERRNO ,strerror(errno)
176#endif
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +0100177
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000178
Denis Vlasenkoaf6cca52008-05-25 04:31:54 +0000179/* Some libc's forget to declare these, do it ourself */
Denis Vlasenko847fa772008-01-28 22:45:43 +0000180
Denis Vlasenkocac0f5b2008-09-25 10:20:46 +0000181extern char **environ;
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000182/* klogctl is in libc's klog.h, but we cheat and not #include that */
183int klogctl(int type, char *b, int len);
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +0100184#ifndef PATH_MAX
185# define PATH_MAX 256
186#endif
187#ifndef BUFSIZ
188# define BUFSIZ 4096
189#endif
Rob Landley362dc2b2006-06-05 17:35:24 +0000190
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000191
Denys Vlasenko0c4cf422011-06-30 02:44:27 +0200192/* Busybox does not use threads, we can speed up stdio. */
Dan Fandrich75214cf2011-06-30 02:59:17 +0200193#ifdef HAVE_UNLOCKED_STDIO
194# undef getc
Denys Vlasenkoaa3576a2016-08-22 19:54:12 +0200195# define getc(stream) getc_unlocked(stream)
Dan Fandrich75214cf2011-06-30 02:59:17 +0200196# undef getchar
Denys Vlasenkoaa3576a2016-08-22 19:54:12 +0200197# define getchar() getchar_unlocked()
Dan Fandrich75214cf2011-06-30 02:59:17 +0200198# undef putc
Denys Vlasenkoaa3576a2016-08-22 19:54:12 +0200199# define putc(c,stream) putc_unlocked(c,stream)
Dan Fandrich75214cf2011-06-30 02:59:17 +0200200# undef putchar
Denys Vlasenkoaa3576a2016-08-22 19:54:12 +0200201# define putchar(c) putchar_unlocked(c)
Dan Fandrich75214cf2011-06-30 02:59:17 +0200202# undef fgetc
Denys Vlasenkoaa3576a2016-08-22 19:54:12 +0200203# define fgetc(stream) getc_unlocked(stream)
Dan Fandrich75214cf2011-06-30 02:59:17 +0200204# undef fputc
Denys Vlasenkoaa3576a2016-08-22 19:54:12 +0200205# define fputc(c,stream) putc_unlocked(c,stream)
Dan Fandrich75214cf2011-06-30 02:59:17 +0200206#endif
Denys Vlasenko0c4cf422011-06-30 02:44:27 +0200207/* Above functions are required by POSIX.1-2008, below ones are extensions */
Dan Fandrich75214cf2011-06-30 02:59:17 +0200208#ifdef HAVE_UNLOCKED_LINE_OPS
209# undef fgets
Denys Vlasenkoaa3576a2016-08-22 19:54:12 +0200210# define fgets(s,n,stream) fgets_unlocked(s,n,stream)
Dan Fandrich75214cf2011-06-30 02:59:17 +0200211# undef fputs
Denys Vlasenkoaa3576a2016-08-22 19:54:12 +0200212# define fputs(s,stream) fputs_unlocked(s,stream)
Denys Vlasenko0ae05092016-09-18 21:49:30 +0200213/* musl <= 1.1.15 does not support fflush_unlocked(NULL) */
214//# undef fflush
215//# define fflush(stream) fflush_unlocked(stream)
Denys Vlasenkoaa3576a2016-08-22 19:54:12 +0200216# undef feof
217# define feof(stream) feof_unlocked(stream)
218# undef ferror
219# define ferror(stream) ferror_unlocked(stream)
220# undef fileno
221# define fileno(stream) fileno_unlocked(stream)
Dan Fandrich75214cf2011-06-30 02:59:17 +0200222#endif
Denys Vlasenko06448912011-06-20 10:06:28 +0200223
224
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000225/* Make all declarations hidden (-fvisibility flag only affects definitions) */
226/* (don't include system headers after this until corresponding pop!) */
Denis Vlasenkof81e8db2009-04-09 12:35:13 +0000227PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000228
229
230#if ENABLE_USE_BB_PWD_GRP
231# include "pwd_.h"
232# include "grp_.h"
233#endif
234#if ENABLE_FEATURE_SHADOWPASSWDS
235# if ENABLE_USE_BB_SHADOW
236# include "shadow_.h"
237# endif
238#endif
239
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000240/* Tested to work correctly with all int types (IIRC :]) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000241#define MAXINT(T) (T)( \
242 ((T)-1) > 0 \
243 ? (T)-1 \
244 : (T)~((T)1 << (sizeof(T)*8-1)) \
245 )
246
247#define MININT(T) (T)( \
248 ((T)-1) > 0 \
249 ? (T)0 \
250 : ((T)1 << (sizeof(T)*8-1)) \
251 )
Denis Vlasenko7039a662006-10-08 17:54:47 +0000252
Denis Vlasenko56254152006-10-07 16:24:46 +0000253/* Large file support */
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000254/* Note that CONFIG_LFS=y forces bbox to be built with all common ops
Denis Vlasenko7039a662006-10-08 17:54:47 +0000255 * (stat, lseek etc) mapped to "largefile" variants by libc.
256 * Practically it means that open() automatically has O_LARGEFILE added
257 * and all filesize/file_offset parameters and struct members are "large"
258 * (in today's world - signed 64bit). For full support of large files,
259 * we need a few helper #defines (below) and careful use of off_t
260 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000261#if ENABLE_LFS
Denis Vlasenko7039a662006-10-08 17:54:47 +0000262/* CONFIG_LFS is on */
263# if ULONG_MAX > 0xffffffff
264/* "long" is long enough on this system */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000265typedef unsigned long uoff_t;
Denys Vlasenkof59a50e2011-11-16 21:30:19 +0100266# define XATOOFF(a) xatoul_range((a), 0, LONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000267/* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
268# define BB_STRTOOFF bb_strtoul
269# define STRTOOFF strtoul
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000270/* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
271# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000272# else
Denis Vlasenkocba9ef52006-10-10 21:00:47 +0000273/* "long" is too short, need "long long" */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000274typedef unsigned long long uoff_t;
Denys Vlasenkof59a50e2011-11-16 21:30:19 +0100275# define XATOOFF(a) xatoull_range((a), 0, LLONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000276# define BB_STRTOOFF bb_strtoull
277# define STRTOOFF strtoull
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000278# define OFF_FMT "ll"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000279# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000280#else
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000281/* CONFIG_LFS is off */
282# if UINT_MAX == 0xffffffff
283/* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
284 * gcc will throw warnings on printf("%d", off_t). Crap... */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000285typedef unsigned long uoff_t;
Denys Vlasenko77832482010-08-12 14:14:45 +0200286# define XATOOFF(a) xatoi_positive(a)
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000287# define BB_STRTOOFF bb_strtou
Denis Vlasenko7039a662006-10-08 17:54:47 +0000288# define STRTOOFF strtol
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000289# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000290# else
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000291typedef unsigned long uoff_t;
Denys Vlasenkof59a50e2011-11-16 21:30:19 +0100292# define XATOOFF(a) xatoul_range((a), 0, LONG_MAX)
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000293# define BB_STRTOOFF bb_strtoul
Denis Vlasenko7039a662006-10-08 17:54:47 +0000294# define STRTOOFF strtol
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000295# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000296# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000297#endif
298/* scary. better ideas? (but do *test* them first!) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000299#define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
Denys Vlasenko1dc80ba2011-11-17 21:51:32 +0100300/* Users report bionic to use 32-bit off_t even if LARGEFILE support is requested.
301 * We misdetected that. Don't let it build:
302 */
303struct BUG_off_t_size_is_misdetected {
304 char BUG_off_t_size_is_misdetected[sizeof(off_t) == sizeof(uoff_t) ? 1 : -1];
305};
Denis Vlasenko56254152006-10-07 16:24:46 +0000306
Eric Andersenaad1a882001-03-16 22:47:14 +0000307/* Some useful definitions */
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000308#undef FALSE
Eric Andersenaad1a882001-03-16 22:47:14 +0000309#define FALSE ((int) 0)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000310#undef TRUE
Eric Andersenaad1a882001-03-16 22:47:14 +0000311#define TRUE ((int) 1)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000312#undef SKIP
Eric Andersenaad1a882001-03-16 22:47:14 +0000313#define SKIP ((int) 2)
314
Eric Andersenaad1a882001-03-16 22:47:14 +0000315/* Macros for min/max. */
316#ifndef MIN
Denys Vlasenkoe4dcba12010-10-28 18:57:19 +0200317#define MIN(a,b) (((a)<(b))?(a):(b))
Eric Andersenaad1a882001-03-16 22:47:14 +0000318#endif
319
320#ifndef MAX
Denys Vlasenkoe4dcba12010-10-28 18:57:19 +0200321#define MAX(a,b) (((a)>(b))?(a):(b))
Eric Andersenaad1a882001-03-16 22:47:14 +0000322#endif
323
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000324/* buffer allocation schemes */
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000325#if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000326#define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000327#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
328#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
329#else
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000330#if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000331#define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
332#define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
333#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
334#else
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000335#define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer = xmalloc(len)
336#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
337#define RELEASE_CONFIG_BUFFER(buffer) free(buffer)
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000338#endif
339#endif
340
Denis Vlasenkofad2b862007-05-31 22:16:38 +0000341#if defined(__GLIBC__)
342/* glibc uses __errno_location() to get a ptr to errno */
343/* We can just memorize it once - no multithreading in busybox :) */
344extern int *const bb_errno;
345#undef errno
346#define errno (*bb_errno)
347#endif
348
Denys Vlasenko9ff50b82010-10-18 11:40:26 +0200349#if !(ULONG_MAX > 0xffffffff)
350/* Only 32-bit CPUs need this, 64-bit ones use inlined version */
351uint64_t bb_bswap_64(uint64_t x) FAST_FUNC;
352#endif
353
Denys Vlasenko8a134ec2017-04-11 07:34:56 +0200354unsigned long FAST_FUNC isqrt(unsigned long long N);
355
Denis Vlasenkoce13b762008-06-29 02:25:53 +0000356unsigned long long monotonic_ns(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000357unsigned long long monotonic_us(void) FAST_FUNC;
Denys Vlasenkof2c8aa62010-01-12 12:52:30 +0100358unsigned long long monotonic_ms(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000359unsigned monotonic_sec(void) FAST_FUNC;
Manuel Novoa III cad53642003-03-19 09:13:01 +0000360
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000361extern void chomp(char *s) FAST_FUNC;
Denys Vlasenko20077c12017-08-05 17:50:35 +0200362extern char *trim(char *s) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000363extern char *skip_whitespace(const char *) FAST_FUNC;
364extern char *skip_non_whitespace(const char *) FAST_FUNC;
Denys Vlasenkof8d8aa12010-04-06 18:50:05 +0200365extern char *skip_dev_pfx(const char *tty_name) FAST_FUNC;
366
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000367extern char *strrstr(const char *haystack, const char *needle) FAST_FUNC;
Paul Fox0b621582005-08-09 19:38:05 +0000368
Denys Vlasenko9a647c32017-01-23 01:08:16 +0100369/* dmalloc will redefine these to it's own implementation. It is safe
370 * to have the prototypes here unconditionally. */
371void *malloc_or_warn(size_t size) FAST_FUNC RETURNS_MALLOC;
372void *xmalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
373void *xzalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
374void *xrealloc(void *old, size_t size) FAST_FUNC;
375/* After v = xrealloc_vector(v, SHIFT, idx) it's ok to use
376 * at least v[idx] and v[idx+1], for all idx values.
377 * SHIFT specifies how many new elements are added (1:2, 2:4, ..., 8:256...)
378 * when all elements are used up. New elements are zeroed out.
379 * xrealloc_vector(v, SHIFT, idx) *MUST* be called with consecutive IDXs -
380 * skipping an index is a bad bug - it may miss a realloc!
381 */
382#define xrealloc_vector(vector, shift, idx) \
383 xrealloc_vector_helper((vector), (sizeof((vector)[0]) << 8) + (shift), (idx))
384void* xrealloc_vector_helper(void *vector, unsigned sizeof_and_shift, int idx) FAST_FUNC;
385char *xstrdup(const char *s) FAST_FUNC RETURNS_MALLOC;
386char *xstrndup(const char *s, int n) FAST_FUNC RETURNS_MALLOC;
387void *xmemdup(const void *s, int n) FAST_FUNC RETURNS_MALLOC;
388
389
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +0000390//TODO: supply a pointer to char[11] buffer (avoid statics)?
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000391extern const char *bb_mode_string(mode_t mode) FAST_FUNC;
Denys Vlasenkof282c6b2011-12-18 03:27:46 +0100392extern int is_directory(const char *name, int followLinks) FAST_FUNC;
Denys Vlasenko877dedb2016-05-27 00:46:38 +0200393enum { /* cp.c, mv.c, install.c depend on these values. CAREFUL when changing them! */
Denys Vlasenkoa40f0622010-01-15 22:05:07 +0100394 FILEUTILS_PRESERVE_STATUS = 1 << 0, /* -p */
395 FILEUTILS_DEREFERENCE = 1 << 1, /* !-d */
396 FILEUTILS_RECUR = 1 << 2, /* -R */
397 FILEUTILS_FORCE = 1 << 3, /* -f */
398 FILEUTILS_INTERACTIVE = 1 << 4, /* -i */
399 FILEUTILS_MAKE_HARDLINK = 1 << 5, /* -l */
400 FILEUTILS_MAKE_SOFTLINK = 1 << 6, /* -s */
401 FILEUTILS_DEREF_SOFTLINK = 1 << 7, /* -L */
402 FILEUTILS_DEREFERENCE_L0 = 1 << 8, /* -H */
Denys Vlasenko877dedb2016-05-27 00:46:38 +0200403 /* -a = -pdR (mapped in cp.c) */
404 /* -r = -dR (mapped in cp.c) */
405 /* -P = -d (mapped in cp.c) */
406 FILEUTILS_VERBOSE = (1 << 12) * ENABLE_FEATURE_VERBOSE, /* -v */
407 FILEUTILS_UPDATE = 1 << 13, /* -u */
Aaro Koskinend15d7a02018-02-01 09:29:05 +0100408 FILEUTILS_NO_TARGET_DIR = 1 << 14, /* -T */
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000409#if ENABLE_SELINUX
Aaro Koskinend15d7a02018-02-01 09:29:05 +0100410 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 1 << 15, /* -c */
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000411#endif
Aaro Koskinend15d7a02018-02-01 09:29:05 +0100412 FILEUTILS_RMDEST = 1 << (16 - !ENABLE_SELINUX), /* --remove-destination */
Denys Vlasenko79fb6ac2018-07-13 20:30:02 +0200413 /* bit 17 skipped for "cp --parents" */
414 FILEUTILS_REFLINK = 1 << (18 - !ENABLE_SELINUX), /* cp --reflink=auto */
415 FILEUTILS_REFLINK_ALWAYS = 1 << (19 - !ENABLE_SELINUX), /* cp --reflink[=always] */
Denys Vlasenko877dedb2016-05-27 00:46:38 +0200416 /*
417 * Hole. cp may have some bits set here,
418 * they should not affect remove_file()/copy_file()
419 */
420#if ENABLE_SELINUX
421 FILEUTILS_SET_SECURITY_CONTEXT = 1 << 30,
422#endif
423 FILEUTILS_IGNORE_CHMOD_ERR = 1 << 31,
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000424};
Aaro Koskinend15d7a02018-02-01 09:29:05 +0100425#define FILEUTILS_CP_OPTSTR "pdRfilsLHarPvuT" IF_SELINUX("c")
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000426extern int remove_file(const char *path, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000427/* NB: without FILEUTILS_RECUR in flags, it will basically "cat"
428 * the source, not copy (unless "source" is a directory).
429 * This makes "cp /dev/null file" and "install /dev/null file" (!!!)
430 * work coreutils-compatibly. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000431extern int copy_file(const char *source, const char *dest, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000432
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000433enum {
Denis Vlasenkod166f832007-07-05 00:12:55 +0000434 ACTION_RECURSE = (1 << 0),
435 ACTION_FOLLOWLINKS = (1 << 1),
436 ACTION_FOLLOWLINKS_L0 = (1 << 2),
437 ACTION_DEPTHFIRST = (1 << 3),
438 /*ACTION_REVERSE = (1 << 4), - unused */
Denis Vlasenko6e69e422008-07-27 12:10:07 +0000439 ACTION_QUIET = (1 << 5),
Denys Vlasenko8f7a6d22009-09-29 11:07:04 +0200440 ACTION_DANGLING_OK = (1 << 6),
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000441};
Denys Vlasenko8f7a6d22009-09-29 11:07:04 +0200442typedef uint8_t recurse_flags_t;
Bernhard Reutner-Fischer3e816c12007-03-29 10:30:50 +0000443extern int recursive_action(const char *fileName, unsigned flags,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000444 int FAST_FUNC (*fileAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
445 int FAST_FUNC (*dirAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
446 void* userData, unsigned depth) FAST_FUNC;
447extern int device_open(const char *device, int mode) FAST_FUNC;
Denis Vlasenko85c24712008-03-17 09:04:04 +0000448enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000449extern int xgetpty(char *line) FAST_FUNC;
Denis Vlasenko2afd5ab2008-08-05 23:32:27 +0000450extern int get_console_fd_or_die(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000451extern void console_make_active(int fd, const int vt_num) FAST_FUNC;
452extern char *find_block_device(const char *path) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000453/* bb_copyfd_XX print read/write errors and return -1 if they occur */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000454extern off_t bb_copyfd_eof(int fd1, int fd2) FAST_FUNC;
455extern off_t bb_copyfd_size(int fd1, int fd2, off_t size) FAST_FUNC;
456extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000457/* "short" copy can be detected by return value < size */
458/* this helper yells "short read!" if param is not -1 */
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000459extern void complain_copyfd_and_die(off_t sz) NORETURN FAST_FUNC;
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +0200460
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000461extern char bb_process_escape_sequence(const char **ptr) FAST_FUNC;
Denys Vlasenko53600592010-10-23 21:06:06 +0200462char* strcpy_and_process_escape_sequences(char *dst, const char *src) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000463/* xxxx_strip version can modify its parameter:
464 * "/" -> "/"
465 * "abc" -> "abc"
466 * "abc/def" -> "def"
467 * "abc/def/" -> "def" !!
468 */
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +0200469char *bb_get_last_path_component_strip(char *path) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000470/* "abc/def/" -> "" and it never modifies 'path' */
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +0200471char *bb_get_last_path_component_nostrip(const char *path) FAST_FUNC;
472/* Simpler version: does not special case "/" string */
473const char *bb_basename(const char *name) FAST_FUNC;
474/* NB: can violate const-ness (similarly to strchr) */
475char *last_char_is(const char *s, int c) FAST_FUNC;
Denys Vlasenko1961aea2013-02-26 00:36:53 +0100476const char* endofname(const char *name) FAST_FUNC;
Denys Vlasenko8dff01d2015-03-12 17:48:34 +0100477char *is_prefixed_with(const char *string, const char *key) FAST_FUNC;
Bartosz Golaszewski7448b512015-08-25 16:36:43 +0200478char *is_suffixed_with(const char *string, const char *key) FAST_FUNC;
Denis Vlasenkocad04ef2007-03-25 23:21:05 +0000479
Denys Vlasenkod6e76722014-09-22 21:14:02 +0200480int ndelay_on(int fd) FAST_FUNC;
481int ndelay_off(int fd) FAST_FUNC;
Denys Vlasenkoe9a40e32011-01-24 00:29:55 +0100482void close_on_exec_on(int fd) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000483void xdup2(int, int) FAST_FUNC;
484void xmove_fd(int, int) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000485
486
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000487DIR *xopendir(const char *path) FAST_FUNC;
488DIR *warn_opendir(const char *path) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000489
Jérémie Koenigfbedacf2010-03-26 19:08:53 +0100490char *xmalloc_realpath(const char *path) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko74716212018-05-24 17:29:14 +0200491char *xmalloc_realpath_coreutils(const char *path) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100492char *xmalloc_readlink(const char *path) FAST_FUNC RETURNS_MALLOC;
493char *xmalloc_readlink_or_warn(const char *path) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkob57eee82009-11-04 17:54:17 +0100494/* !RETURNS_MALLOC: it's a realloc-like function */
495char *xrealloc_getcwd_or_warn(char *cwd) FAST_FUNC;
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000496
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100497char *xmalloc_follow_symlinks(const char *path) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko473dae02007-04-11 07:04:23 +0000498
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000499
Denis Vlasenko33196372008-02-23 01:25:38 +0000500enum {
Denis Vlasenkocf7cf622008-03-19 19:38:46 +0000501 /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
Denis Vlasenko33196372008-02-23 01:25:38 +0000502 * otherwise would kill us, except for those resulting from bugs:
503 * SIGSEGV, SIGILL, SIGFPE.
504 * Other fatal signals not included (TODO?):
505 * SIGBUS Bus error (bad memory access)
506 * SIGPOLL Pollable event. Synonym of SIGIO
507 * SIGPROF Profiling timer expired
508 * SIGSYS Bad argument to routine
509 * SIGTRAP Trace/breakpoint trap
Denis Vlasenkod943af02008-03-30 15:56:38 +0000510 *
511 * The only known arch with some of these sigs not fitting
512 * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
513 * Dance around with long long to guard against that...
Denis Vlasenko33196372008-02-23 01:25:38 +0000514 */
Denis Vlasenkod943af02008-03-30 15:56:38 +0000515 BB_FATAL_SIGS = (int)(0
516 + (1LL << SIGHUP)
517 + (1LL << SIGINT)
518 + (1LL << SIGTERM)
519 + (1LL << SIGPIPE) // Write to pipe with no readers
520 + (1LL << SIGQUIT) // Quit from keyboard
521 + (1LL << SIGABRT) // Abort signal from abort(3)
522 + (1LL << SIGALRM) // Timer signal from alarm(2)
523 + (1LL << SIGVTALRM) // Virtual alarm clock
524 + (1LL << SIGXCPU) // CPU time limit exceeded
525 + (1LL << SIGXFSZ) // File size limit exceeded
526 + (1LL << SIGUSR1) // Yes kids, these are also fatal!
527 + (1LL << SIGUSR2)
528 + 0),
Denis Vlasenko33196372008-02-23 01:25:38 +0000529};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000530void bb_signals(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko25591c32008-02-16 22:58:56 +0000531/* Unlike signal() and bb_signals, sets handler with sigaction()
532 * and in a way that while signal handler is run, no other signals
Denis Vlasenkocab28aa2009-01-31 01:02:07 +0000533 * will be blocked; syscalls will not be restarted: */
534void bb_signals_recursive_norestart(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000535/* syscalls like read() will be interrupted with EINTR: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000536void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000537/* syscalls like read() won't be interrupted (though select/poll will be): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000538void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
539void wait_for_any_sig(void) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000540void kill_myself_with_sig(int sig) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000541void sig_block(int sig) FAST_FUNC;
542void sig_unblock(int sig) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000543/* Will do sigaction(signum, act, NULL): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000544int sigaction_set(int sig, const struct sigaction *act) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000545/* SIG_BLOCK/SIG_UNBLOCK all signals: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000546int sigprocmask_allsigs(int how) FAST_FUNC;
Denys Vlasenkob437df12018-12-08 15:35:24 +0100547/* Return old set in the same set: */
548int sigprocmask2(int how, sigset_t *set) FAST_FUNC;
Denis Vlasenko08ea11a2008-09-11 19:51:11 +0000549/* Standard handler which just records signo */
550extern smallint bb_got_signal;
551void record_signo(int signo); /* not FAST_FUNC! */
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000552
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000553
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000554void xsetgid(gid_t gid) FAST_FUNC;
555void xsetuid(uid_t uid) FAST_FUNC;
Ryan Mallon5906a5c2013-10-08 14:52:49 +0200556void xsetegid(gid_t egid) FAST_FUNC;
557void xseteuid(uid_t euid) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000558void xchdir(const char *path) FAST_FUNC;
Denys Vlasenkoc4199f22016-04-01 22:12:44 +0200559void xfchdir(int fd) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000560void xchroot(const char *path) FAST_FUNC;
561void xsetenv(const char *key, const char *value) FAST_FUNC;
Denis Vlasenko76ddc2e2008-12-30 05:05:31 +0000562void bb_unsetenv(const char *key) FAST_FUNC;
Denys Vlasenkodd8adde2010-06-24 05:00:50 +0200563void bb_unsetenv_and_free(char *key) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000564void xunlink(const char *pathname) FAST_FUNC;
565void xstat(const char *pathname, struct stat *buf) FAST_FUNC;
Denys Vlasenko8d3e2252010-08-31 12:42:06 +0200566void xfstat(int fd, struct stat *buf, const char *errmsg) FAST_FUNC;
Ryan Mallon5906a5c2013-10-08 14:52:49 +0200567int open3_or_warn(const char *pathname, int flags, int mode) FAST_FUNC;
568int open_or_warn(const char *pathname, int flags) FAST_FUNC;
569int xopen3(const char *pathname, int flags, int mode) FAST_FUNC;
Denys Vlasenkof2a8d5d2009-08-21 17:40:36 +0200570int xopen(const char *pathname, int flags) FAST_FUNC;
Bernhard Reutner-Fischera4830872009-10-26 23:27:08 +0100571int xopen_nonblocking(const char *pathname) FAST_FUNC;
Ryan Mallon5906a5c2013-10-08 14:52:49 +0200572int xopen_as_uid_gid(const char *pathname, int flags, uid_t u, gid_t g) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000573int open_or_warn_stdin(const char *pathname) FAST_FUNC;
Denys Vlasenkoe7b0a9e2010-08-22 05:39:15 +0200574int xopen_stdin(const char *pathname) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000575void xrename(const char *oldpath, const char *newpath) FAST_FUNC;
576int rename_or_warn(const char *oldpath, const char *newpath) FAST_FUNC;
577off_t xlseek(int fd, off_t offset, int whence) FAST_FUNC;
Alexander Shishkin67227372010-10-22 13:27:16 +0200578int xmkstemp(char *template) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000579off_t fdlength(int fd) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000580
Denys Vlasenko40e7d252010-02-01 23:48:27 +0100581uoff_t FAST_FUNC get_volume_size_in_bytes(int fd,
Denys Vlasenko982e87f2013-07-30 11:52:58 +0200582 const char *override,
583 unsigned override_units,
584 int extend);
Denys Vlasenko40e7d252010-02-01 23:48:27 +0100585
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000586void xpipe(int filedes[2]) FAST_FUNC;
Denis Vlasenko37188322008-02-16 13:20:56 +0000587/* In this form code with pipes is much more readable */
588struct fd_pair { int rd; int wr; };
589#define piped_pair(pair) pipe(&((pair).rd))
590#define xpiped_pair(pair) xpipe(&((pair).rd))
591
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000592/* Useful for having small structure members/global variables */
593typedef int8_t socktype_t;
594typedef int8_t family_t;
595struct BUG_too_small {
596 char BUG_socktype_t_too_small[(0
597 | SOCK_STREAM
598 | SOCK_DGRAM
599 | SOCK_RDM
600 | SOCK_SEQPACKET
601 | SOCK_RAW
602 ) <= 127 ? 1 : -1];
603 char BUG_family_t_too_small[(0
604 | AF_UNSPEC
605 | AF_INET
606 | AF_INET6
607 | AF_UNIX
Mike Frysinger9412ec72008-02-07 22:41:33 +0000608#ifdef AF_PACKET
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000609 | AF_PACKET
Mike Frysinger9412ec72008-02-07 22:41:33 +0000610#endif
611#ifdef AF_NETLINK
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000612 | AF_NETLINK
Mike Frysinger9412ec72008-02-07 22:41:33 +0000613#endif
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000614 /* | AF_DECnet */
615 /* | AF_IPX */
616 ) <= 127 ? 1 : -1];
617};
618
619
Denys Vlasenkodc698bb2010-01-09 19:10:49 +0100620void parse_datestr(const char *date_str, struct tm *ptm) FAST_FUNC;
621time_t validate_tm_time(const char *date_str, struct tm *ptm) FAST_FUNC;
Denys Vlasenko8f2cb7a2013-03-29 12:30:33 +0100622char *strftime_HHMMSS(char *buf, unsigned len, time_t *tp) FAST_FUNC;
623char *strftime_YYYYMMDDHHMMSS(char *buf, unsigned len, time_t *tp) FAST_FUNC;
Denys Vlasenko73b71f32009-07-18 03:40:35 +0200624
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000625int xsocket(int domain, int type, int protocol) FAST_FUNC;
626void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen) FAST_FUNC;
627void xlisten(int s, int backlog) FAST_FUNC;
628void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen) FAST_FUNC;
Denis Vlasenkodbe6e662007-08-14 16:43:01 +0000629ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000630 socklen_t tolen) FAST_FUNC;
Denys Vlasenkoc52cbea2015-08-24 19:48:03 +0200631
632int setsockopt_int(int fd, int level, int optname, int optval) FAST_FUNC;
633int setsockopt_1(int fd, int level, int optname) FAST_FUNC;
634int setsockopt_SOL_SOCKET_int(int fd, int optname, int optval) FAST_FUNC;
635int setsockopt_SOL_SOCKET_1(int fd, int optname) FAST_FUNC;
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000636/* SO_REUSEADDR allows a server to rebind to an address that is already
637 * "in use" by old connections to e.g. previous server instance which is
638 * killed or crashed. Without it bind will fail until all such connections
639 * time out. Linux does not allow multiple live binds on same ip:port
640 * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
641 * Turn it on before you call bind(). */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000642void setsockopt_reuseaddr(int fd) FAST_FUNC; /* On Linux this never fails. */
Denys Vlasenkoc52cbea2015-08-24 19:48:03 +0200643int setsockopt_keepalive(int fd) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000644int setsockopt_broadcast(int fd) FAST_FUNC;
Denis Vlasenkoe5373852008-12-10 11:12:16 +0000645int setsockopt_bindtodevice(int fd, const char *iface) FAST_FUNC;
Denys Vlasenkoba3b9db2018-02-11 14:55:46 +0100646int bb_getsockname(int sockfd, void *addr, socklen_t addrlen) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000647/* NB: returns port in host byte order */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000648unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port) FAST_FUNC;
Denys Vlasenko2aeb2012018-04-17 12:43:54 +0200649#if ENABLE_FEATURE_ETC_SERVICES
650# define bb_lookup_std_port(portstr, protocol, portnum) bb_lookup_port(portstr, protocol, portnum)
651#else
652# define bb_lookup_std_port(portstr, protocol, portnum) (portnum)
653#endif
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000654typedef struct len_and_sockaddr {
Denis Vlasenko0850cda2007-02-07 23:20:32 +0000655 socklen_t len;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000656 union {
657 struct sockaddr sa;
658 struct sockaddr_in sin;
659#if ENABLE_FEATURE_IPV6
660 struct sockaddr_in6 sin6;
661#endif
Bernhard Reutner-Fischer8c69afd2008-01-29 10:33:34 +0000662 } u;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000663} len_and_sockaddr;
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000664enum {
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000665 LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000666 LSA_SIZEOF_SA = sizeof(
667 union {
668 struct sockaddr sa;
669 struct sockaddr_in sin;
670#if ENABLE_FEATURE_IPV6
671 struct sockaddr_in6 sin6;
672#endif
673 }
674 )
675};
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000676/* Create stream socket, and allocate suitable lsa.
677 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
Denis Vlasenkobeffd432007-09-05 11:30:34 +0000678 * af == AF_UNSPEC will result in trying to create IPv6 socket,
Denys Vlasenkob1278a32009-11-24 16:03:47 +0100679 * and if kernel doesn't support it, fall back to IPv4.
680 * This is useful if you plan to bind to resulting local lsa.
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000681 */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000682int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000683int xsocket_stream(len_and_sockaddr **lsap) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000684/* Create server socket bound to bindaddr:port. bindaddr can be NULL,
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000685 * numeric IP ("N.N.N.N") or numeric IPv6 address,
686 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000687 * Only if there is no suffix, port argument is used */
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000688/* NB: these set SO_REUSEADDR before bind */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000689int create_and_bind_stream_or_die(const char *bindaddr, int port) FAST_FUNC;
690int create_and_bind_dgram_or_die(const char *bindaddr, int port) FAST_FUNC;
Denys Vlasenko45e39672019-06-03 14:16:52 +0200691int create_and_bind_to_netlink(int proto, int grp, unsigned rcvbuf) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000692/* Create client TCP socket connected to peer:port. Peer cannot be NULL.
693 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
694 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
695 * If there is no suffix, port argument is used */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000696int create_and_connect_stream_or_die(const char *peer, int port) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000697/* Connect to peer identified by lsa */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000698int xconnect_stream(const len_and_sockaddr *lsa) FAST_FUNC;
Denis Vlasenko73c571a2009-03-09 00:12:37 +0000699/* Get local address of bound or accepted socket */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100700len_and_sockaddr *get_sock_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkof6916db2010-04-06 17:43:29 +0200701/* Get remote address of connected or accepted socket */
702len_and_sockaddr *get_peer_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000703/* Return malloc'ed len_and_sockaddr with socket address of host:port
704 * Currently will return IPv4 or IPv6 sockaddrs only
705 * (depending on host), but in theory nothing prevents e.g.
Denis Vlasenko5870ad92007-02-04 02:39:55 +0000706 * UNIX socket address being returned, IPX sockaddr etc...
707 * On error does bb_error_msg and returns NULL */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100708len_and_sockaddr* host2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000709/* Version which dies on error */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100710len_and_sockaddr* xhost2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
711len_and_sockaddr* xdotted2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000712/* Same, useful if you want to force family (e.g. IPv6) */
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000713#if !ENABLE_FEATURE_IPV6
714#define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
715#define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
716#else
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100717len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
718len_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 +0000719#endif
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000720/* Assign sin[6]_port member if the socket is an AF_INET[6] one,
Denis Vlasenko85629f02007-01-22 09:36:41 +0000721 * otherwise no-op. Useful for ftp.
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000722 * NB: does NOT do htons() internally, just direct assignment. */
Denys Vlasenkoca183112011-04-07 17:52:20 +0200723void set_nport(struct sockaddr *sa, unsigned port) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000724/* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000725int get_nport(const struct sockaddr *sa) FAST_FUNC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000726/* Reverse DNS. Returns NULL on failure. */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100727char* xmalloc_sockaddr2host(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000728/* This one doesn't append :PORTNUM */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100729char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000730/* This one also doesn't fall back to dotted IP (returns NULL) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100731char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko448f0242007-01-22 22:43:05 +0000732/* inet_[ap]ton on steroids */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100733char* xmalloc_sockaddr2dotted(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
734char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000735// "old" (ipv4 only) API
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000736// users: traceroute.c hostname.c - use _list_ of all IPs
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000737struct hostent *xgethostbyname(const char *name) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000738// Also mount.c and inetd.c are using gethostbyname(),
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000739// + inet_common.c has additional IPv4-only stuff
Denis Vlasenkoc8717cd2006-11-22 16:10:39 +0000740
Denys Vlasenko49ecee02017-01-24 16:00:54 +0100741
Denys Vlasenko83e5c622018-11-23 17:21:38 +0100742struct tls_aes {
743 uint32_t key[60];
744 unsigned rounds;
745};
Denys Vlasenko49ecee02017-01-24 16:00:54 +0100746#define TLS_MAX_MAC_SIZE 32
747#define TLS_MAX_KEY_SIZE 32
Denys Vlasenko83e5c622018-11-23 17:21:38 +0100748#define TLS_MAX_IV_SIZE 4
Denys Vlasenko9a647c32017-01-23 01:08:16 +0100749struct tls_handshake_data; /* opaque */
750typedef struct tls_state {
Denys Vlasenko83e5c622018-11-23 17:21:38 +0100751 unsigned flags;
752
Denys Vlasenko49ecee02017-01-24 16:00:54 +0100753 int ofd;
754 int ifd;
Denys Vlasenko9a647c32017-01-23 01:08:16 +0100755
Denys Vlasenko89193f92017-01-24 18:08:07 +0100756 unsigned min_encrypted_len_on_read;
Denys Vlasenko49ecee02017-01-24 16:00:54 +0100757 uint16_t cipher_id;
Denys Vlasenko49ecee02017-01-24 16:00:54 +0100758 unsigned MAC_size;
759 unsigned key_size;
Denys Vlasenko83e5c622018-11-23 17:21:38 +0100760 unsigned IV_size;
Denys Vlasenko9a647c32017-01-23 01:08:16 +0100761
762 uint8_t *outbuf;
763 int outbuf_size;
764
765 int inbuf_size;
766 int ofs_to_buffered;
767 int buffered_size;
768 uint8_t *inbuf;
769
770 struct tls_handshake_data *hsd;
771
772 // RFC 5246
773 // sequence number
774 // Each connection state contains a sequence number, which is
775 // maintained separately for read and write states. The sequence
776 // number MUST be set to zero whenever a connection state is made the
777 // active state. Sequence numbers are of type uint64 and may not
778 // exceed 2^64-1.
779 /*uint64_t read_seq64_be;*/
780 uint64_t write_seq64_be;
781
Denys Vlasenko83e5c622018-11-23 17:21:38 +0100782 /*uint8_t *server_write_MAC_key;*/
Denys Vlasenko49ecee02017-01-24 16:00:54 +0100783 uint8_t *client_write_key;
784 uint8_t *server_write_key;
Denys Vlasenko83e5c622018-11-23 17:21:38 +0100785 uint8_t *client_write_IV;
786 uint8_t *server_write_IV;
Denys Vlasenko49ecee02017-01-24 16:00:54 +0100787 uint8_t client_write_MAC_key[TLS_MAX_MAC_SIZE];
788 uint8_t server_write_MAC_k__[TLS_MAX_MAC_SIZE];
789 uint8_t client_write_k__[TLS_MAX_KEY_SIZE];
790 uint8_t server_write_k__[TLS_MAX_KEY_SIZE];
Denys Vlasenko83e5c622018-11-23 17:21:38 +0100791 uint8_t client_write_I_[TLS_MAX_IV_SIZE];
792 uint8_t server_write_I_[TLS_MAX_IV_SIZE];
793
794 struct tls_aes aes_encrypt;
795 struct tls_aes aes_decrypt;
796 uint8_t H[16]; //used by AES_GCM
Denys Vlasenko9a647c32017-01-23 01:08:16 +0100797} tls_state_t;
798
799static inline tls_state_t *new_tls_state(void)
800{
801 tls_state_t *tls = xzalloc(sizeof(*tls));
802 return tls;
803}
804void tls_handshake(tls_state_t *tls, const char *sni) FAST_FUNC;
Denys Vlasenko403f2992018-02-06 15:15:08 +0100805#define TLSLOOP_EXIT_ON_LOCAL_EOF (1 << 0)
806void tls_run_copy_loop(tls_state_t *tls, unsigned flags) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000807
Denys Vlasenko49ecee02017-01-24 16:00:54 +0100808
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000809void socket_want_pktinfo(int fd) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000810ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000811 const struct sockaddr *to,
812 const struct sockaddr *from,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000813 socklen_t tolen) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000814ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000815 struct sockaddr *from,
816 struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000817 socklen_t sa_size) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000818
Baruch Siache8f36332011-09-07 17:52:37 +0200819uint16_t inet_cksum(uint16_t *addr, int len) FAST_FUNC;
Denys Vlasenko1783ffa2018-02-06 15:48:12 +0100820int parse_pasv_epsv(char *buf) FAST_FUNC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100821
Denys Vlasenkod4e4fdb2017-07-03 21:31:16 +0200822/* 0 if argv[0] is NULL: */
823unsigned string_array_len(char **argv) FAST_FUNC;
Denis Vlasenko0f293b92008-07-22 20:16:55 +0000824void overlapping_strcpy(char *dst, const char *src) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000825char *safe_strncpy(char *dst, const char *src, size_t size) FAST_FUNC;
Denis Vlasenko360d9662008-12-02 18:18:50 +0000826char *strncpy_IFNAMSIZ(char *dst, const char *src) FAST_FUNC;
Denys Vlasenko6f068902014-02-27 11:17:06 +0100827unsigned count_strstr(const char *str, const char *sub) FAST_FUNC;
828char *xmalloc_substitute_string(const char *src, int count, const char *sub, const char *repl) FAST_FUNC;
Denis Vlasenko4daad902007-09-27 10:20:47 +0000829/* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
Denis Vlasenko7c654ae2007-09-27 10:26:59 +0000830 * But potentially slow, don't use in one-billion-times loops */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000831int bb_putchar(int ch) FAST_FUNC;
Denys Vlasenko19ced5c2010-06-06 21:53:09 +0200832/* Note: does not use stdio, writes to fd 2 directly */
833int bb_putchar_stderr(char ch) FAST_FUNC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100834char *xasprintf(const char *format, ...) __attribute__ ((format(printf, 1, 2))) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkoe52da552015-10-09 17:59:56 +0200835char *auto_string(char *str) FAST_FUNC;
Denis Vlasenko9f739442006-12-16 23:49:13 +0000836// gcc-4.1.1 still isn't good enough at optimizing it
837// (+200 bytes compared to macro)
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000838//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000839//int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000840//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000841//int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000842#define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
Denis Vlasenko9f739442006-12-16 23:49:13 +0000843#define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000844#define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
Denis Vlasenkobf66fbc2006-12-21 13:23:14 +0000845#define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
Denis Vlasenko16abcd92007-04-13 23:59:52 +0000846#define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000847
Denys Vlasenkod8528b82010-01-31 05:15:38 +0100848typedef struct uni_stat_t {
849 unsigned byte_count;
850 unsigned unicode_count;
851 unsigned unicode_width;
852} uni_stat_t;
853/* Returns a string with unprintable chars replaced by '?' or
854 * SUBST_WCHAR. This function is unicode-aware. */
Denys Vlasenko349d72c2018-09-30 16:56:56 +0200855const char* FAST_FUNC printable_string(const char *str);
856const char* FAST_FUNC printable_string2(uni_stat_t *stats, const char *str);
Denys Vlasenkod8528b82010-01-31 05:15:38 +0100857/* Prints unprintable char ch as ^C or M-c to file
858 * (M-c is used only if ch is ORed with PRINTABLE_META),
859 * else it is printed as-is (except for ch = 0x9b) */
860enum { PRINTABLE_META = 0x100 };
861void fputc_printable(int ch, FILE *file) FAST_FUNC;
Bartosz Golaszewski79c618c2013-07-30 06:29:42 +0200862/* Return a string that is the printable representation of character ch.
863 * Buffer must hold at least four characters. */
Denys Vlasenkobfa6ed12013-07-30 11:41:58 +0200864enum {
865 VISIBLE_ENDLINE = 1 << 0,
866 VISIBLE_SHOW_TABS = 1 << 1,
867};
Bartosz Golaszewski79c618c2013-07-30 06:29:42 +0200868void visible(unsigned ch, char *buf, int flags) FAST_FUNC;
Denys Vlasenkod8528b82010-01-31 05:15:38 +0100869
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000870extern ssize_t safe_read(int fd, void *buf, size_t count) FAST_FUNC;
Ron Yorston61d6ae22015-04-19 10:50:25 +0100871extern ssize_t nonblock_immune_read(int fd, void *buf, size_t count) FAST_FUNC;
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000872// NB: will return short read on error, not -1,
873// if some data was read before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000874extern ssize_t full_read(int fd, void *buf, size_t count) FAST_FUNC;
875extern void xread(int fd, void *buf, size_t count) FAST_FUNC;
876extern unsigned char xread_char(int fd) FAST_FUNC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000877extern ssize_t read_close(int fd, void *buf, size_t maxsz) FAST_FUNC;
878extern ssize_t open_read_close(const char *filename, void *buf, size_t maxsz) FAST_FUNC;
Denis Vlasenko8ee649a2008-03-26 20:04:27 +0000879// Reads one line a-la fgets (but doesn't save terminating '\n').
880// Reads byte-by-byte. Useful when it is important to not read ahead.
Denis Vlasenkoe376d452008-02-20 22:23:24 +0000881// Bytes are appended to pfx (which must be malloced, or NULL).
Denys Vlasenko80c5b682011-05-08 21:21:10 +0200882extern char *xmalloc_reads(int fd, size_t *maxsz_p) FAST_FUNC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000883/* Reads block up to *maxsz_p (default: INT_MAX - 4095) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100884extern void *xmalloc_read(int fd, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkodff2bd72019-05-24 17:03:28 +0200885extern 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 +0000886/* Returns NULL if file can't be opened (default max size: INT_MAX - 4095) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100887extern void *xmalloc_open_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko094cc512011-01-17 14:58:27 +0100888/* Never returns NULL */
889extern void *xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko59655072012-03-06 16:23:50 +0100890
Denys Vlasenko04c14172014-11-26 15:17:59 +0100891#if defined(ARG_MAX) && (ARG_MAX >= 60*1024 || !defined(_SC_ARG_MAX))
892/* Use _constant_ maximum if: defined && (big enough || no variable one exists) */
Denys Vlasenkof92f1d02014-06-22 13:54:40 +0200893# define bb_arg_max() ((unsigned)ARG_MAX)
Denys Vlasenko04c14172014-11-26 15:17:59 +0100894#elif defined(_SC_ARG_MAX)
895/* Else use variable one (a bit more expensive) */
Denys Vlasenkof92f1d02014-06-22 13:54:40 +0200896unsigned bb_arg_max(void) FAST_FUNC;
897#else
Denys Vlasenko04c14172014-11-26 15:17:59 +0100898/* If all else fails */
Denys Vlasenkof92f1d02014-06-22 13:54:40 +0200899# define bb_arg_max() ((unsigned)(32 * 1024))
900#endif
Bartosz Golaszewski5d2e4092014-06-22 14:01:13 +0200901unsigned bb_clk_tck(void) FAST_FUNC;
Denys Vlasenkof92f1d02014-06-22 13:54:40 +0200902
Denys Vlasenko59655072012-03-06 16:23:50 +0100903#define SEAMLESS_COMPRESSION (0 \
904 || ENABLE_FEATURE_SEAMLESS_XZ \
905 || ENABLE_FEATURE_SEAMLESS_LZMA \
906 || ENABLE_FEATURE_SEAMLESS_BZ2 \
907 || ENABLE_FEATURE_SEAMLESS_GZ \
908 || ENABLE_FEATURE_SEAMLESS_Z)
909
Denys Vlasenko8a6a2f92012-03-06 16:27:48 +0100910#if SEAMLESS_COMPRESSION
Denys Vlasenko27653ad2010-05-06 14:19:19 +0000911/* Autodetects gzip/bzip2 formats. fd may be in the middle of the file! */
Denys Vlasenko0cf64c82017-08-10 10:35:08 +0200912int setup_unzip_on_fd(int fd, int fail_if_not_compressed) FAST_FUNC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000913/* Autodetects .gz etc */
Denys Vlasenko640ce3d2014-02-02 02:06:38 +0100914extern int open_zipped(const char *fname, int fail_if_not_compressed) FAST_FUNC;
Denys Vlasenkob4c11c12014-12-07 00:44:00 +0100915extern void *xmalloc_open_zipped_read_close(const char *fname, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko8a6a2f92012-03-06 16:27:48 +0100916#else
917# define setup_unzip_on_fd(...) (0)
Denys Vlasenko640ce3d2014-02-02 02:06:38 +0100918# define open_zipped(fname, fail_if_not_compressed) open((fname), O_RDONLY);
Denys Vlasenkob4c11c12014-12-07 00:44:00 +0100919# define xmalloc_open_zipped_read_close(fname, maxsz_p) xmalloc_open_read_close((fname), (maxsz_p))
Denys Vlasenko8a6a2f92012-03-06 16:27:48 +0100920#endif
Denys Vlasenko0cf64c82017-08-10 10:35:08 +0200921/* lzma has no signature, need a little helper. NB: exist only for ENABLE_FEATURE_SEAMLESS_LZMA=y */
922void setup_lzma_on_fd(int fd) FAST_FUNC;
Denis Vlasenkoea620772006-10-14 02:23:43 +0000923
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000924extern ssize_t safe_write(int fd, const void *buf, size_t count) FAST_FUNC;
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000925// NB: will return short write on error, not -1,
926// if some data was written before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000927extern ssize_t full_write(int fd, const void *buf, size_t count) FAST_FUNC;
928extern void xwrite(int fd, const void *buf, size_t count) FAST_FUNC;
Denis Vlasenko73c571a2009-03-09 00:12:37 +0000929extern void xwrite_str(int fd, const char *str) FAST_FUNC;
Denys Vlasenko729ecb82010-06-07 14:14:26 +0200930extern ssize_t full_write1_str(const char *str) FAST_FUNC;
931extern ssize_t full_write2_str(const char *str) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000932extern void xopen_xwrite_close(const char* file, const char *str) FAST_FUNC;
Denis Vlasenkoea620772006-10-14 02:23:43 +0000933
Denys Vlasenkodcd27ab2009-10-05 03:03:07 +0200934/* Close fd, but check for failures (some types of write errors) */
935extern void xclose(int fd) FAST_FUNC;
936
Denis Vlasenko1de08302006-10-26 23:32:43 +0000937/* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000938extern void xprint_and_close_file(FILE *file) FAST_FUNC;
Denis Vlasenko2132e022008-07-15 10:33:12 +0000939
Denys Vlasenkoa1a44832011-06-17 03:37:43 +0200940/* Reads a line from a text file, up to a newline or NUL byte, inclusive.
941 * Returns malloc'ed char*. If end is NULL '\n' isn't considered
942 * end of line. If end isn't NULL, length of the chunk is stored in it.
943 * Returns NULL if EOF/error.
944 */
Quentin Rameaue2afae62018-04-01 19:49:58 +0200945extern char *bb_get_chunk_from_file(FILE *file, size_t *end) FAST_FUNC;
Denis Vlasenkoabee3d02007-12-26 20:44:45 +0000946/* Reads up to (and including) TERMINATING_STRING: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100947extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000948/* Same, with limited max size, and returns the length (excluding NUL): */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100949extern 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 +0000950/* Chops off TERMINATING_STRING from the end: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100951extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000952/* Reads up to (and including) "\n" or NUL byte: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100953extern char *xmalloc_fgets(FILE *file) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000954/* Chops off '\n' from the end, unlike fgets: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100955extern char *xmalloc_fgetline(FILE *file) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko2132e022008-07-15 10:33:12 +0000956/* Same, but doesn't try to conserve space (may have some slack after the end) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100957/* extern char *xmalloc_fgetline_fast(FILE *file) FAST_FUNC RETURNS_MALLOC; */
Denis Vlasenko2132e022008-07-15 10:33:12 +0000958
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100959void die_if_ferror(FILE *file, const char *msg) FAST_FUNC;
960void die_if_ferror_stdout(void) FAST_FUNC;
961int fflush_all(void) FAST_FUNC;
962void fflush_stdout_and_exit(int retval) NORETURN FAST_FUNC;
963int fclose_if_not_stdin(FILE *file) FAST_FUNC;
964FILE* xfopen(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000965/* Prints warning to stderr and returns NULL on failure: */
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100966FILE* fopen_or_warn(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000967/* "Opens" stdin if filename is special, else just opens file: */
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100968FILE* xfopen_stdin(const char *filename) FAST_FUNC;
969FILE* fopen_or_warn_stdin(const char *filename) FAST_FUNC;
970FILE* fopen_for_read(const char *path) FAST_FUNC;
971FILE* xfopen_for_read(const char *path) FAST_FUNC;
972FILE* fopen_for_write(const char *path) FAST_FUNC;
973FILE* xfopen_for_write(const char *path) FAST_FUNC;
974FILE* xfdopen_for_read(int fd) FAST_FUNC;
975FILE* xfdopen_for_write(int fd) FAST_FUNC;
Eric Andersen8876fb22003-06-20 09:01:58 +0000976
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000977int bb_pstrcmp(const void *a, const void *b) /* not FAST_FUNC! */;
978void qsort_string_vector(char **sv, unsigned count) FAST_FUNC;
Denis Vlasenkofb290382008-03-02 12:51:26 +0000979
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000980/* Wrapper which restarts poll on EINTR or ENOMEM.
981 * On other errors complains [perror("poll")] and returns.
982 * Warning! May take (much) longer than timeout_ms to return!
983 * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000984int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms) FAST_FUNC;
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000985
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000986char *safe_gethostname(void) FAST_FUNC;
Denis Vlasenko6f1713f2008-02-25 23:23:58 +0000987
Bernhard Reutner-Fischer8b1fab22007-04-10 09:38:07 +0000988/* Convert each alpha char in str to lower-case */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000989char* str_tolower(char *str) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000990
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000991char *utoa(unsigned n) FAST_FUNC;
992char *itoa(int n) FAST_FUNC;
Denis Vlasenko10457b92007-03-27 22:01:31 +0000993/* Returns a pointer past the formatted number, does NOT null-terminate */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000994char *utoa_to_buf(unsigned n, char *buf, unsigned buflen) FAST_FUNC;
995char *itoa_to_buf(int n, char *buf, unsigned buflen) FAST_FUNC;
Denis Vlasenko56ea65c2008-01-06 03:26:53 +0000996/* Intelligent formatters of bignums */
Denys Vlasenkoa407cf72013-09-06 12:53:14 +0200997char *smart_ulltoa4(unsigned long long ul, char buf[4], const char *scale) FAST_FUNC;
998char *smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
Denys Vlasenko0bf44d02009-10-13 01:25:09 +0200999/* If block_size == 0, display size without fractional part,
1000 * else display (size * block_size) with one decimal digit.
Denys Vlasenko9c3b84a2010-01-18 01:55:00 +01001001 * If display_unit == 0, show value no bigger than 1024 with suffix (K,M,G...),
Denys Vlasenko0bf44d02009-10-13 01:25:09 +02001002 * else divide by display_unit and do not use suffix. */
Denys Vlasenko9c3b84a2010-01-18 01:55:00 +01001003#define HUMAN_READABLE_MAX_WIDTH 7 /* "1024.0G" */
1004#define HUMAN_READABLE_MAX_WIDTH_STR "7"
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001005//TODO: provide pointer to buf (avoid statics)?
1006const char *make_human_readable_str(unsigned long long size,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001007 unsigned long block_size, unsigned long display_unit) FAST_FUNC;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001008/* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
Denys Vlasenko1f56e512011-10-19 22:40:35 +02001009char *bin2hex(char *dst, const char *src, int count) FAST_FUNC;
Denys Vlasenko48363312010-04-04 15:29:32 +02001010/* Reverse */
Denys Vlasenko1f56e512011-10-19 22:40:35 +02001011char* hex2bin(char *dst, const char *src, int count) FAST_FUNC;
Rob Landleyc5b1d4d2006-03-13 15:45:16 +00001012
Vladimir Dronnikovdb67a202009-10-15 09:24:25 +02001013/* Generate a UUID */
1014void generate_uuid(uint8_t *buf) FAST_FUNC;
1015
Denis Vlasenko1bab1de2007-07-27 15:30:39 +00001016/* Last element is marked by mult == 0 */
Eric Andersenaad1a882001-03-16 22:47:14 +00001017struct suffix_mult {
Denis Vlasenkof8689632007-07-27 15:06:25 +00001018 char suffix[4];
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001019 unsigned mult;
Eric Andersenaad1a882001-03-16 22:47:14 +00001020};
Denys Vlasenkoc72b43c2013-07-13 23:49:45 +02001021extern const struct suffix_mult bkm_suffixes[];
1022#define km_suffixes (bkm_suffixes + 1)
Ari Sundholm88930232015-03-04 18:46:48 +02001023extern const struct suffix_mult cwbkMG_suffixes[];
Ari Sundholm911db162015-03-22 17:55:38 +01001024#define kMG_suffixes (cwbkMG_suffixes + 3)
Denys Vlasenkoe184a882016-12-12 19:56:31 +01001025extern const struct suffix_mult kmg_i_suffixes[];
Denys Vlasenkoc72b43c2013-07-13 23:49:45 +02001026
Denis Vlasenkoed836cd2006-11-25 14:44:13 +00001027#include "xatonum.h"
Denis Vlasenko13858992006-10-08 12:49:22 +00001028/* Specialized: */
Denys Vlasenko77832482010-08-12 14:14:45 +02001029
Denis Vlasenko13858992006-10-08 12:49:22 +00001030/* Using xatoi() instead of naive atoi() is not always convenient -
1031 * in many places people want *non-negative* values, but store them
1032 * in signed int. Therefore we need this one:
Denys Vlasenko77832482010-08-12 14:14:45 +02001033 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc.
1034 * It should really be named xatoi_nonnegative (since it allows 0),
1035 * but that would be too long.
1036 */
1037int xatoi_positive(const char *numstr) FAST_FUNC;
1038
Denis Vlasenko13858992006-10-08 12:49:22 +00001039/* Useful for reading port numbers */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001040uint16_t xatou16(const char *numstr) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001041
Denys Vlasenko4c20d9f2018-08-03 18:17:12 +02001042#if ENABLE_FLOAT_DURATION
1043typedef double duration_t;
1044void sleep_for_duration(duration_t duration) FAST_FUNC;
Denys Vlasenko0ddc7422019-03-12 18:56:51 +01001045#define DURATION_FMT "f"
Denys Vlasenko4c20d9f2018-08-03 18:17:12 +02001046#else
1047typedef unsigned duration_t;
1048#define sleep_for_duration(duration) sleep(duration)
Denys Vlasenko0ddc7422019-03-12 18:56:51 +01001049#define DURATION_FMT "u"
Denys Vlasenko4c20d9f2018-08-03 18:17:12 +02001050#endif
1051duration_t parse_duration_str(char *str) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001052
Eric Andersenaad1a882001-03-16 22:47:14 +00001053/* These parse entries in /etc/passwd and /etc/group. This is desirable
1054 * for BusyBox since we want to avoid using the glibc NSS stuff, which
Bernhard Reutner-Fischerd5bd1372005-09-20 21:06:17 +00001055 * increases target size and is often not needed on embedded systems. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001056long xuname2uid(const char *name) FAST_FUNC;
1057long xgroup2gid(const char *name) FAST_FUNC;
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +00001058/* wrapper: allows string to contain numeric uid or gid */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001059unsigned long get_ug_id(const char *s, long FAST_FUNC (*xname2id)(const char *)) FAST_FUNC;
Denis Vlasenkode59c0f2006-10-05 22:50:22 +00001060struct bb_uidgid_t {
Denis Vlasenko150f4022007-01-13 21:06:21 +00001061 uid_t uid;
1062 gid_t gid;
Denis Vlasenkode59c0f2006-10-05 22:50:22 +00001063};
Denys Vlasenko526d8582015-10-19 04:27:17 +02001064/* always sets uid and gid; returns 0 on failure */
1065int get_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
1066/* always sets uid and gid; exits on failure */
Bernhard Reutner-Fischerd73cbd32008-07-21 14:41:33 +00001067void xget_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
Denis Vlasenkocce38582007-02-26 22:47:42 +00001068/* chown-like handling of "user[:[group]" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001069void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group) FAST_FUNC;
Denis Vlasenkod7a805e2008-12-03 19:05:55 +00001070struct passwd* xgetpwnam(const char *name) FAST_FUNC;
Denis Vlasenko15437e32008-12-05 16:23:06 +00001071struct group* xgetgrnam(const char *name) FAST_FUNC;
Denis Vlasenko0c68a872008-12-02 22:56:59 +00001072struct passwd* xgetpwuid(uid_t uid) FAST_FUNC;
1073struct group* xgetgrgid(gid_t gid) FAST_FUNC;
1074char* xuid2uname(uid_t uid) FAST_FUNC;
1075char* xgid2group(gid_t gid) FAST_FUNC;
1076char* uid2uname(uid_t uid) FAST_FUNC;
1077char* gid2group(gid_t gid) FAST_FUNC;
Denys Vlasenko7d65abe2011-03-01 16:27:13 +01001078char* uid2uname_utoa(uid_t uid) FAST_FUNC;
1079char* gid2group_utoa(gid_t gid) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +00001080/* versions which cache results (useful for ps, ls etc) */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001081const char* get_cached_username(uid_t uid) FAST_FUNC;
1082const char* get_cached_groupname(gid_t gid) FAST_FUNC;
1083void clear_username_cache(void) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +00001084/* internally usernames are saved in fixed-sized char[] buffers */
Denys Vlasenko7d65abe2011-03-01 16:27:13 +01001085enum { USERNAME_MAX_SIZE = 32 - sizeof(uid_t) };
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +00001086#if ENABLE_FEATURE_CHECK_NAMES
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001087void die_if_bad_username(const char* name) FAST_FUNC;
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +00001088#else
1089#define die_if_bad_username(name) ((void)(name))
1090#endif
Denys Vlasenkoa8cf9c52017-07-04 18:49:24 +02001091/*
1092 * Returns (-1) terminated malloced result of getgroups().
1093 * Reallocs group_array (useful for repeated calls).
1094 * ngroups is an initial size of array. It is rounded up to 32 for realloc.
1095 * ngroups is updated on return.
1096 * ngroups can be NULL: bb_getgroups(NULL, NULL) is valid usage.
1097 * Dies on errors (on Linux, only xrealloc can cause this, not internal getgroups call).
1098 */
1099gid_t *bb_getgroups(int *ngroups, gid_t *group_array) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001100
Denys Vlasenko37f5bef2010-04-05 03:18:40 +02001101#if ENABLE_FEATURE_UTMP
Denys Vlasenko3a416112010-04-05 22:10:38 +02001102void FAST_FUNC write_new_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
1103void 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 +01001104void FAST_FUNC update_utmp_DEAD_PROCESS(pid_t pid);
Denys Vlasenko37f5bef2010-04-05 03:18:40 +02001105#else
Denys Vlasenko3a416112010-04-05 22:10:38 +02001106# define write_new_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
1107# define update_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
Denys Vlasenkoda921262015-01-05 15:37:58 +01001108# define update_utmp_DEAD_PROCESS(pid) ((void)0)
Denys Vlasenko37f5bef2010-04-05 03:18:40 +02001109#endif
1110
Denys Vlasenkob72baeb2011-02-02 18:38:57 +01001111
Denys Vlasenkoe765b5a2014-05-02 17:15:58 +02001112int file_is_executable(const char *name) FAST_FUNC;
1113char *find_executable(const char *filename, char **PATHp) FAST_FUNC;
1114int executable_exists(const char *filename) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001115
Denis Vlasenko7e0fbf92007-09-04 19:33:22 +00001116/* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
1117 * but it may exec busybox and call applet instead of searching PATH.
1118 */
Denis Vlasenko80d14be2007-04-10 23:03:30 +00001119#if ENABLE_FEATURE_PREFER_APPLETS
Denys Vlasenkoc71b4692011-02-02 03:28:56 +01001120int BB_EXECVP(const char *file, char *const argv[]) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001121#define BB_EXECLP(prog,cmd,...) \
Denys Vlasenkoc71b4692011-02-02 03:28:56 +01001122 do { \
1123 if (find_applet_by_name(prog) >= 0) \
1124 execlp(bb_busybox_exec_path, cmd, __VA_ARGS__); \
1125 execlp(prog, cmd, __VA_ARGS__); \
1126 } while (0)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001127#else
1128#define BB_EXECVP(prog,cmd) execvp(prog,cmd)
Denys Vlasenkoc71b4692011-02-02 03:28:56 +01001129#define BB_EXECLP(prog,cmd,...) execlp(prog,cmd,__VA_ARGS__)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001130#endif
Denys Vlasenko82203992016-04-02 18:06:24 +02001131void BB_EXECVP_or_die(char **argv) NORETURN FAST_FUNC;
1132void exec_prog_or_SHELL(char **argv) NORETURN FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001133
Denys Vlasenko82203992016-04-02 18:06:24 +02001134/* xvfork() can't be a _function_, return after vfork in child mangles stack
Pascal Bellard926031b2010-07-04 15:32:38 +02001135 * in the parent. It must be a macro. */
1136#define xvfork() \
1137({ \
1138 pid_t bb__xvfork_pid = vfork(); \
1139 if (bb__xvfork_pid < 0) \
James Byrne69374872019-07-02 11:35:03 +02001140 bb_simple_perror_msg_and_die("vfork"); \
Pascal Bellard926031b2010-07-04 15:32:38 +02001141 bb__xvfork_pid; \
1142})
1143#if BB_MMU
1144pid_t xfork(void) FAST_FUNC;
1145#endif
Denys Vlasenko82203992016-04-02 18:06:24 +02001146void xvfork_parent_waits_and_exits(void) FAST_FUNC;
Pascal Bellard926031b2010-07-04 15:32:38 +02001147
Denys Vlasenko8531d762010-03-18 22:44:00 +01001148/* NOMMU friendy fork+exec: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001149pid_t spawn(char **argv) FAST_FUNC;
1150pid_t xspawn(char **argv) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +00001151
Denis Vlasenko3854c5d2008-11-06 22:39:57 +00001152pid_t safe_waitpid(pid_t pid, int *wstat, int options) FAST_FUNC;
Denys Vlasenko8531d762010-03-18 22:44:00 +01001153pid_t wait_any_nohang(int *wstat) FAST_FUNC;
1154/* wait4pid: unlike waitpid, waits ONLY for one process.
1155 * Returns sig + 0x180 if child is killed by signal.
Denis Vlasenkocd7001f2007-04-09 21:32:30 +00001156 * It's safe to pass negative 'pids' from failed [v]fork -
Denis Vlasenko473dae02007-04-11 07:04:23 +00001157 * wait4pid will return -1 (and will not clobber [v]fork's errno).
Denis Vlasenkocd7001f2007-04-09 21:32:30 +00001158 * IOW: rc = wait4pid(spawn(argv));
1159 * if (rc < 0) bb_perror_msg("%s", argv[0]);
Denys Vlasenko8531d762010-03-18 22:44:00 +01001160 * if (rc > 0) bb_error_msg("exit code: %d", rc & 0xff);
Denis Vlasenkocd7001f2007-04-09 21:32:30 +00001161 */
Denis Vlasenko3854c5d2008-11-06 22:39:57 +00001162int wait4pid(pid_t pid) FAST_FUNC;
Denys Vlasenkoc4199f22016-04-01 22:12:44 +02001163int wait_for_exitstatus(pid_t pid) FAST_FUNC;
Denys Vlasenko9967c992017-01-26 01:13:58 +01001164/************************************************************************/
1165/* spawn_and_wait/run_nofork_applet/run_applet_no_and_exit need to work */
1166/* carefully together to reinit some global state while not disturbing */
1167/* other. Be careful if you change them. Consult docs/nofork_noexec.txt */
1168/************************************************************************/
Denys Vlasenko8531d762010-03-18 22:44:00 +01001169/* Same as wait4pid(spawn(argv)), but with NOFORK/NOEXEC if configured: */
Denys Vlasenko8f24f982009-06-07 16:02:00 +02001170int spawn_and_wait(char **argv) FAST_FUNC;
Denis Vlasenko18e19f22007-04-28 16:43:18 +00001171/* Does NOT check that applet is NOFORK, just blindly runs it */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001172int run_nofork_applet(int applet_no, char **argv) FAST_FUNC;
Denys Vlasenko80e8e3c2017-08-07 19:24:57 +02001173void run_noexec_applet_and_exit(int a, const char *name, char **argv) NORETURN FAST_FUNC;
Denys Vlasenko9967c992017-01-26 01:13:58 +01001174#ifndef BUILD_INDIVIDUAL
Denys Vlasenko80e8e3c2017-08-07 19:24:57 +02001175int find_applet_by_name(const char *name) FAST_FUNC;
1176void run_applet_no_and_exit(int a, const char *name, char **argv) NORETURN FAST_FUNC;
Denys Vlasenko9967c992017-01-26 01:13:58 +01001177#endif
Denys Vlasenkof2cf1cc2017-08-07 18:45:33 +02001178#if defined(__linux__)
1179void set_task_comm(const char *comm) FAST_FUNC;
1180#else
1181# define set_task_comm(name) ((void)0)
1182#endif
Denis Vlasenkocd7001f2007-04-09 21:32:30 +00001183
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001184/* Helpers for daemonization.
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001185 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001186 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001187 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001188 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
1189 * rexec's itself on NOMMU with argv passed as command line.
1190 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
1191 * from the start. (It will detect it and not reexec again second time).
1192 * You have to audit carefully that you don't do something twice as a result
1193 * (opening files/sockets, parsing config files etc...)!
1194 *
1195 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
1196 * (will do setsid()).
1197 *
Pascal Bellard926031b2010-07-04 15:32:38 +02001198 * fork_or_rexec(argv) = bare-bones fork on MMU,
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001199 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
Denis Vlasenko83518d12009-03-20 22:17:13 +00001200 * On MMU ignores argv.
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001201 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001202 * Helper for network daemons in foreground mode:
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001203 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001204 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
1205 * to /dev/null if they are not.
1206 */
1207enum {
Denys Vlasenko088fec32019-01-14 14:45:18 +01001208 DAEMON_CHDIR_ROOT = 1 << 0,
1209 DAEMON_DEVNULL_STDIO = 1 << 1,
1210 DAEMON_CLOSE_EXTRA_FDS = 1 << 2,
1211 DAEMON_ONLY_SANITIZE = 1 << 3, /* internal use */
1212 //DAEMON_DOUBLE_FORK = 1 << 4, /* double fork to avoid controlling tty */
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001213};
Denis Vlasenko473dae02007-04-11 07:04:23 +00001214#if BB_MMU
Denis Vlasenko367960b2007-08-18 14:20:21 +00001215 enum { re_execed = 0 };
Pascal Bellard926031b2010-07-04 15:32:38 +02001216# define fork_or_rexec(argv) xfork()
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001217# define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
1218# define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001219#else
Pascal Bellard926031b2010-07-04 15:32:38 +02001220 extern bool re_execed;
Denys Vlasenkod2277e22011-11-22 17:19:26 +01001221 /* Note: re_exec() and fork_or_rexec() do argv[0][0] |= 0x80 on NOMMU!
1222 * _Parent_ needs to undo it if it doesn't want to have argv[0] mangled.
1223 */
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001224 void re_exec(char **argv) NORETURN FAST_FUNC;
Denis Vlasenko83518d12009-03-20 22:17:13 +00001225 pid_t fork_or_rexec(char **argv) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001226 int BUG_fork_is_unavailable_on_nommu(void) FAST_FUNC;
1227 int BUG_daemon_is_unavailable_on_nommu(void) FAST_FUNC;
1228 void BUG_bb_daemonize_is_unavailable_on_nommu(void) FAST_FUNC;
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001229# define fork() BUG_fork_is_unavailable_on_nommu()
Pascal Bellard926031b2010-07-04 15:32:38 +02001230# define xfork() BUG_fork_is_unavailable_on_nommu()
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001231# define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
1232# define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001233#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001234void bb_daemonize_or_rexec(int flags, char **argv) FAST_FUNC;
1235void bb_sanitize_stdio(void) FAST_FUNC;
Denys Vlasenkob182e9a2017-08-04 23:04:17 +02001236#define bb_daemon_helper(arg) bb_daemonize_or_rexec((arg) | DAEMON_ONLY_SANITIZE, NULL)
Denis Vlasenkoc9ca0a32008-02-18 11:08:33 +00001237/* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001238int sanitize_env_if_suid(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001239
1240
Denys Vlasenko727948e2017-08-04 16:23:42 +02001241/* For top, ps. Some argv[i] are replaced by malloced "-opt" strings */
1242void make_all_argv_opts(char **argv) FAST_FUNC;
Denys Vlasenko036585a2017-08-08 16:38:18 +02001243char* single_argv(char **argv) FAST_FUNC;
1244extern const char *const bb_argv_dash[]; /* { "-", NULL } */
1245extern uint32_t option_mask32;
Denys Vlasenko036585a2017-08-08 16:38:18 +02001246uint32_t getopt32(char **argv, const char *applet_opts, ...) FAST_FUNC;
1247# define No_argument "\0"
1248# define Required_argument "\001"
1249# define Optional_argument "\002"
1250#if ENABLE_LONG_OPTS
1251uint32_t getopt32long(char **argv, const char *optstring, const char *longopts, ...) FAST_FUNC;
1252#else
1253#define getopt32long(argv,optstring,longopts,...) \
1254 getopt32(argv,optstring,##__VA_ARGS__)
1255#endif
Kaarle Ritvanen835ad3a2017-04-12 00:58:46 +03001256/* BSD-derived getopt() functions require that optind be set to 1 in
1257 * order to reset getopt() state. This used to be generally accepted
1258 * way of resetting getopt(). However, glibc's getopt()
1259 * has additional getopt() state beyond optind (specifically, glibc
Denys Vlasenko352ddd32017-04-12 20:21:34 +02001260 * extensions such as '+' and '-' at the start of the string), and requires
Kaarle Ritvanen835ad3a2017-04-12 00:58:46 +03001261 * that optind be set to zero to reset its state. BSD-derived versions
1262 * of getopt() misbehaved if optind is set to 0 in order to reset getopt(),
1263 * and glibc's getopt() used to coredump if optind is set 1 in order
1264 * to reset getopt().
Denys Vlasenko352ddd32017-04-12 20:21:34 +02001265 * Then BSD introduced additional variable "optreset" which should be
1266 * set to 1 in order to reset getopt(). Sigh. Standards, anyone?
Kaarle Ritvanen835ad3a2017-04-12 00:58:46 +03001267 *
1268 * By ~2008, OpenBSD 3.4 was changed to survive glibc-like optind = 0
1269 * (to interpret it as if optreset was set).
1270 */
Denys Vlasenko60161812017-08-29 14:32:17 +02001271#if 1 /*def __GLIBC__*/
Kaarle Ritvanen835ad3a2017-04-12 00:58:46 +03001272#define GETOPT_RESET() (optind = 0)
1273#else /* BSD style */
1274#define GETOPT_RESET() (optind = 1)
1275#endif
1276
1277
Denys Vlasenko9be47022011-05-16 12:21:31 +02001278/* Having next pointer as a first member allows easy creation
1279 * of "llist-compatible" structs, and using llist_FOO functions
1280 * on them.
1281 */
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001282typedef struct llist_t {
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001283 struct llist_t *link;
Denys Vlasenko9be47022011-05-16 12:21:31 +02001284 char *data;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001285} llist_t;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001286void llist_add_to(llist_t **old_head, void *data) FAST_FUNC;
1287void llist_add_to_end(llist_t **list_head, void *data) FAST_FUNC;
1288void *llist_pop(llist_t **elm) FAST_FUNC;
1289void llist_unlink(llist_t **head, llist_t *elm) FAST_FUNC;
1290void llist_free(llist_t *elm, void (*freeit)(void *data)) FAST_FUNC;
1291llist_t *llist_rev(llist_t *list) FAST_FUNC;
Denis Vlasenko0b791d92009-04-13 20:52:00 +00001292llist_t *llist_find_str(llist_t *first, const char *str) FAST_FUNC;
Denis Vlasenko4b924f32007-05-30 00:29:55 +00001293/* BTW, surprisingly, changing API to
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001294 * llist_t *llist_add_to(llist_t *old_head, void *data)
1295 * etc does not result in smaller code... */
1296
Denis Vlasenko80edead2007-08-02 22:31:05 +00001297/* start_stop_daemon and udhcpc are special - they want
1298 * to create pidfiles regardless of FEATURE_PIDFILE */
Denis Vlasenko1caca342007-08-02 10:14:29 +00001299#if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001300/* True only if we created pidfile which is *file*, not /dev/null etc */
1301extern smallint wrote_pidfile;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001302void write_pidfile(const char *path) FAST_FUNC;
Denys Vlasenko50596532019-03-17 19:47:52 +01001303void write_pidfile_std_path_and_ext(const char *path) FAST_FUNC;
1304void remove_pidfile_std_path_and_ext(const char *path) FAST_FUNC;
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001305#define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
Denis Vlasenko10457b92007-03-27 22:01:31 +00001306#else
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001307enum { wrote_pidfile = 0 };
Denys Vlasenko50596532019-03-17 19:47:52 +01001308#define write_pidfile_std_path_and_ext(path) ((void)0)
1309#define remove_pidfile_std_path_and_ext(path) ((void)0)
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001310#define write_pidfile(path) ((void)0)
1311#define remove_pidfile(path) ((void)0)
Denis Vlasenko10457b92007-03-27 22:01:31 +00001312#endif
1313
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001314enum {
1315 LOGMODE_NONE = 0,
Denis Vlasenko1b97efd2007-08-17 19:18:06 +00001316 LOGMODE_STDIO = (1 << 0),
1317 LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001318 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
1319};
1320extern const char *msg_eol;
Denis Vlasenko04c99eb2007-04-07 00:44:31 +00001321extern smallint logmode;
Denys Vlasenko7aa63042010-09-01 16:04:24 +02001322extern uint8_t xfunc_error_retval;
Denys Vlasenko550bf5b2015-10-09 16:42:57 +02001323extern void (*die_func)(void);
Denys Vlasenko899ae532018-04-01 19:59:37 +02001324void xfunc_die(void) NORETURN FAST_FUNC;
1325void bb_show_usage(void) NORETURN FAST_FUNC;
1326void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
James Byrne69374872019-07-02 11:35:03 +02001327void bb_simple_error_msg(const char *s) FAST_FUNC;
Denys Vlasenko899ae532018-04-01 19:59:37 +02001328void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
James Byrne69374872019-07-02 11:35:03 +02001329void bb_simple_error_msg_and_die(const char *s) NORETURN FAST_FUNC;
Denys Vlasenko899ae532018-04-01 19:59:37 +02001330void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1331void bb_simple_perror_msg(const char *s) FAST_FUNC;
1332void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1333void bb_simple_perror_msg_and_die(const char *s) NORETURN FAST_FUNC;
1334void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
James Byrne69374872019-07-02 11:35:03 +02001335void bb_simple_herror_msg(const char *s) FAST_FUNC;
Denys Vlasenko899ae532018-04-01 19:59:37 +02001336void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
James Byrne69374872019-07-02 11:35:03 +02001337void bb_simple_herror_msg_and_die(const char *s) NORETURN FAST_FUNC;
Denys Vlasenko899ae532018-04-01 19:59:37 +02001338void bb_perror_nomsg_and_die(void) NORETURN FAST_FUNC;
1339void bb_perror_nomsg(void) FAST_FUNC;
1340void bb_verror_msg(const char *s, va_list p, const char *strerr) FAST_FUNC;
1341void bb_die_memory_exhausted(void) NORETURN FAST_FUNC;
1342void bb_logenv_override(void) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001343
James Byrne253c4e72019-04-12 17:01:51 +00001344#if ENABLE_FEATURE_SYSLOG_INFO
1345void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
James Byrne69374872019-07-02 11:35:03 +02001346void bb_simple_info_msg(const char *s) FAST_FUNC;
James Byrne253c4e72019-04-12 17:01:51 +00001347void bb_vinfo_msg(const char *s, va_list p) FAST_FUNC;
1348#else
1349#define bb_info_msg bb_error_msg
James Byrne69374872019-07-02 11:35:03 +02001350#define bb_simple_info_msg bb_simple_error_msg
James Byrne253c4e72019-04-12 17:01:51 +00001351#define bb_vinfo_msg(s,p) bb_verror_msg(s,p,NULL)
1352#endif
1353
James Byrne69374872019-07-02 11:35:03 +02001354#if ENABLE_WARN_SIMPLE_MSG
1355/* If enabled, cause calls to bb_error_msg() et al that only take a single
1356 * parameter to generate a warning.
1357 */
1358static inline void __attribute__ ((deprecated("use bb_simple_error_msg instead")))
1359 bb_not_simple_error_msg(const char *s) { bb_simple_error_msg(s); }
1360static inline void __attribute__ ((deprecated("use bb_simple_error_msg_and_die instead"))) NORETURN
1361 bb_not_simple_error_msg_and_die(const char *s) { bb_simple_error_msg_and_die(s); }
1362static inline void __attribute__ ((deprecated("use bb_simple_perror_msg instead")))
1363 bb_not_simple_perror_msg(const char *s) { bb_simple_perror_msg(s); }
1364static inline void __attribute__ ((deprecated("use bb_simple_perror_msg_and_die instead"))) NORETURN
1365 bb_not_simple_perror_msg_and_die(const char *s) { bb_simple_perror_msg_and_die(s); }
1366static inline void __attribute__ ((deprecated("use bb_simple_herror_msg instead")))
1367 bb_not_simple_herror_msg(const char *s) { bb_simple_herror_msg(s); }
1368static inline void __attribute__ ((deprecated("use bb_simple_herror_msg_and_die instead"))) NORETURN
1369 bb_not_simple_herror_msg_and_die(const char *s) { bb_simple_herror_msg_and_die(s); }
1370static inline void __attribute__ ((deprecated("use bb_simple_info_msg instead")))
1371 bb_not_simple_info_msg(const char *s) { bb_simple_info_msg(s); }
1372/* Override bb_error_msg() and related functions with macros that will
1373 * substitute them for the equivalent bb_not_simple_error_msg() function when
1374 * they are used with only a single parameter. Macro approach inspired by
1375 * https://gustedt.wordpress.com/2010/06/08/detect-empty-macro-arguments and
1376 * https://gustedt.wordpress.com/2010/06/03/default-arguments-for-c99
1377 */
1378#define _ARG18(_0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11, _12, _13, _14, _15, _16, _17, ...) _17
1379#define BB_MSG_KIND(...) _ARG18(__VA_ARGS__, , , , , , , , , , , , , , , , , _not_simple)
1380#define _BB_MSG(name, kind, ...) bb##kind##name(__VA_ARGS__)
1381#define BB_MSG(name, kind, ...) _BB_MSG(name, kind, __VA_ARGS__)
1382#define bb_error_msg(...) BB_MSG(_error_msg, BB_MSG_KIND(__VA_ARGS__), __VA_ARGS__)
1383#define bb_error_msg_and_die(...) BB_MSG(_error_msg_and_die, BB_MSG_KIND(__VA_ARGS__), __VA_ARGS__)
1384#define bb_perror_msg(...) BB_MSG(_perror_msg, BB_MSG_KIND(__VA_ARGS__), __VA_ARGS__)
1385#define bb_perror_msg_and_die(...) BB_MSG(_perror_msg_and_die, BB_MSG_KIND(__VA_ARGS__), __VA_ARGS__)
1386#define bb_herror_msg(...) BB_MSG(_herror_msg, BB_MSG_KIND(__VA_ARGS__), __VA_ARGS__)
1387#define bb_herror_msg_and_die(...) BB_MSG(_herror_msg_and_die, BB_MSG_KIND(__VA_ARGS__), __VA_ARGS__)
1388#define bb_info_msg(...) BB_MSG(_info_msg, BB_MSG_KIND(__VA_ARGS__), __VA_ARGS__)
1389#endif
1390
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +00001391/* We need to export XXX_main from libbusybox
1392 * only if we build "individual" binaries
1393 */
1394#if ENABLE_FEATURE_INDIVIDUAL
1395#define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
1396#else
1397#define MAIN_EXTERNALLY_VISIBLE
1398#endif
1399
Denys Vlasenko4f2ef4a2018-11-01 09:53:25 +01001400/* Embedded script support */
Denys Vlasenko4f2ef4a2018-11-01 09:53:25 +01001401char *get_script_content(unsigned n) FAST_FUNC;
Ron Yorston3193cb52019-03-30 07:47:12 +00001402int scripted_main(int argc, char** argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001403
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001404/* Applets which are useful from another applets */
Denys Vlasenkod9eb40c2017-04-12 15:48:19 +02001405int bb_cat(char** argv) FAST_FUNC;
Denys Vlasenko4f2ef4a2018-11-01 09:53:25 +01001406int ash_main(int argc, char** argv)
1407#if ENABLE_ASH || ENABLE_SH_IS_ASH || ENABLE_BASH_IS_ASH
1408 MAIN_EXTERNALLY_VISIBLE
1409#endif
1410;
Ron Yorston71df2d32018-11-27 14:34:25 +00001411int hush_main(int argc, char** argv)
1412#if ENABLE_HUSH || ENABLE_SH_IS_HUSH || ENABLE_BASH_IS_HUSH
1413 MAIN_EXTERNALLY_VISIBLE
1414#endif
1415;
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001416/* If shell needs them, they exist even if not enabled as applets */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001417int echo_main(int argc, char** argv) IF_ECHO(MAIN_EXTERNALLY_VISIBLE);
1418int printf_main(int argc, char **argv) IF_PRINTF(MAIN_EXTERNALLY_VISIBLE);
Denys Vlasenko548620c2016-12-08 12:24:48 +01001419int test_main(int argc, char **argv)
1420#if ENABLE_TEST || ENABLE_TEST1 || ENABLE_TEST2
1421 MAIN_EXTERNALLY_VISIBLE
1422#endif
1423;
1424int kill_main(int argc, char **argv)
1425#if ENABLE_KILL || ENABLE_KILLALL || ENABLE_KILLALL5
1426 MAIN_EXTERNALLY_VISIBLE
1427#endif
1428;
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001429/* Similar, but used by chgrp, not shell */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001430int chown_main(int argc, char **argv) IF_CHOWN(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenkoc41cba52009-03-09 15:46:07 +00001431/* Used by ftpd */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001432int ls_main(int argc, char **argv) IF_LS(MAIN_EXTERNALLY_VISIBLE);
1433/* Don't need IF_xxx() guard for these */
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +00001434int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko77f1ec12007-10-13 03:36:03 +00001435int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko1a9e9bd2008-11-01 12:54:56 +00001436
Denis Vlasenko468aea22008-04-01 14:47:57 +00001437#if ENABLE_ROUTE
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001438void bb_displayroutes(int noresolve, int netstatfmt) FAST_FUNC;
Denis Vlasenko468aea22008-04-01 14:47:57 +00001439#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001440
Denys Vlasenkod88f94a2017-04-05 18:17:17 +02001441struct number_state {
1442 unsigned width;
1443 unsigned start;
1444 unsigned inc;
1445 const char *sep;
1446 const char *empty_str;
1447 smallint all, nonempty;
1448};
Denys Vlasenkoc1005352018-11-29 11:44:10 +01001449int print_numbered_lines(struct number_state *ns, const char *filename) FAST_FUNC;
Denys Vlasenkod88f94a2017-04-05 18:17:17 +02001450
Denis Vlasenko270c17c2006-12-26 17:40:33 +00001451
1452/* Networking */
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001453/* This structure defines protocol families and their handlers. */
1454struct aftype {
1455 const char *name;
1456 const char *title;
1457 int af;
1458 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001459 char* FAST_FUNC (*print)(unsigned char *);
1460 const char* FAST_FUNC (*sprint)(struct sockaddr *, int numeric);
1461 int FAST_FUNC (*input)(/*int type,*/ const char *bufp, struct sockaddr *);
1462 void FAST_FUNC (*herror)(char *text);
1463 int FAST_FUNC (*rprint)(int options);
1464 int FAST_FUNC (*rinput)(int typ, int ext, char **argv);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001465 /* may modify src */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001466 int FAST_FUNC (*getmask)(char *src, struct sockaddr *mask, char *name);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001467};
1468/* This structure defines hardware protocols and their handlers. */
1469struct hwtype {
1470 const char *name;
1471 const char *title;
1472 int type;
1473 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001474 char* FAST_FUNC (*print)(unsigned char *);
1475 int FAST_FUNC (*input)(const char *, struct sockaddr *);
1476 int FAST_FUNC (*activate)(int fd);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001477 int suppress_null_addr;
1478};
Denys Vlasenko82ec8942018-03-05 17:46:17 +01001479#define IFNAME_SHOW_DOWNED_TOO ((char*)(intptr_t)1)
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001480int display_interfaces(char *ifname) FAST_FUNC;
Bartosz Golaszewskic19be752013-07-25 04:39:04 +02001481int in_ether(const char *bufp, struct sockaddr *sap) FAST_FUNC;
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001482#if ENABLE_FEATURE_HWIB
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001483int in_ib(const char *bufp, struct sockaddr *sap) FAST_FUNC;
Denis Vlasenko3b162ec2008-06-04 07:59:51 +00001484#else
1485#define in_ib(a, b) 1 /* fail */
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001486#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001487const struct aftype *get_aftype(const char *name) FAST_FUNC;
1488const struct hwtype *get_hwtype(const char *name) FAST_FUNC;
1489const struct hwtype *get_hwntype(int type) FAST_FUNC;
Denis Vlasenko270c17c2006-12-26 17:40:33 +00001490
1491
Denys Vlasenko35b54a32017-01-30 00:45:05 +01001492extern int fstype_matches(const char *fstype, const char *comma_list) FAST_FUNC;
Mike Frysinger9412ec72008-02-07 22:41:33 +00001493#ifdef HAVE_MNTENT_H
Denys Vlasenko6ae64262009-07-18 16:22:26 +02001494extern struct mntent *find_mount_point(const char *name, int subdir_too) FAST_FUNC;
Mike Frysinger9412ec72008-02-07 22:41:33 +00001495#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001496extern void erase_mtab(const char * name) FAST_FUNC;
1497extern unsigned int tty_baud_to_value(speed_t speed) FAST_FUNC;
1498extern speed_t tty_value_to_baud(unsigned int value) FAST_FUNC;
Denys Vlasenkoa355da02010-01-04 13:16:08 +01001499#if ENABLE_DESKTOP
1500extern void bb_warn_ignoring_args(char *arg) FAST_FUNC;
1501#else
1502# define bb_warn_ignoring_args(arg) ((void)0)
1503#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001504
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001505extern int get_linux_version_code(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001506
Denys Vlasenko3b69ba72019-06-09 23:20:49 +02001507char *query_loop(const char *device) FAST_FUNC;
1508int get_free_loop(void) FAST_FUNC;
1509int del_loop(const char *device) FAST_FUNC;
Denys Vlasenkoab518ee2017-03-16 16:49:37 +01001510/*
1511 * If *devname is not NULL, use that name, otherwise try to find free one,
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001512 * malloc and return it in *devname.
Denys Vlasenkoab518ee2017-03-16 16:49:37 +01001513 * return value is the opened fd to the loop device, or < on error
1514 */
Denys Vlasenko3b69ba72019-06-09 23:20:49 +02001515int set_loop(char **devname, const char *file, unsigned long long offset, unsigned flags) FAST_FUNC;
Denys Vlasenkoab518ee2017-03-16 16:49:37 +01001516/* These constants match linux/loop.h (without BB_ prefix): */
1517#define BB_LO_FLAGS_READ_ONLY 1
1518#define BB_LO_FLAGS_AUTOCLEAR 4
Jack O'Sullivan726cbb12019-05-28 15:28:27 +01001519#define BB_LO_FLAGS_PARTSCAN 8
Eric Andersenaad1a882001-03-16 22:47:14 +00001520
Denys Vlasenko17058a02018-04-07 15:50:30 +02001521/* Returns malloced str */
1522char *bb_ask_noecho(int fd, int timeout, const char *prompt) FAST_FUNC;
1523/* Like bb_ask_noecho, but asks on stdin with no timeout. */
Denys Vlasenko77cb6b92018-04-07 15:08:12 +02001524char *bb_ask_noecho_stdin(const char *prompt) FAST_FUNC;
Denys Vlasenko17058a02018-04-07 15:50:30 +02001525
Denys Vlasenkobae8fc42018-04-07 15:21:35 +02001526int bb_ask_y_confirmation_FILE(FILE *fp) FAST_FUNC;
Denys Vlasenko77cb6b92018-04-07 15:08:12 +02001527int bb_ask_y_confirmation(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001528
Denys Vlasenko5711a2a2015-10-07 17:55:33 +02001529/* Returns -1 if input is invalid. current_mode is a base for e.g. "u+rw" */
1530int bb_parse_mode(const char* s, unsigned cur_mode) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001531
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001532/*
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001533 * Config file parser
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001534 */
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001535enum {
Denis Vlasenko084266e2008-07-26 23:08:31 +00001536 PARSE_COLLAPSE = 0x00010000, // treat consecutive delimiters as one
1537 PARSE_TRIM = 0x00020000, // trim leading and trailing delimiters
1538// TODO: COLLAPSE and TRIM seem to always go in pair
1539 PARSE_GREEDY = 0x00040000, // last token takes entire remainder of the line
1540 PARSE_MIN_DIE = 0x00100000, // die if < min tokens found
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001541 // keep a copy of current line
Denis Vlasenko35a064b2008-11-06 00:49:59 +00001542 PARSE_KEEP_COPY = 0x00200000 * ENABLE_FEATURE_CROND_D,
Denys Vlasenko499597d2012-01-11 00:37:17 +01001543 PARSE_EOL_COMMENTS = 0x00400000, // comments are recognized even if they aren't the first char
Denys Vlasenko50db1f22017-08-05 18:20:34 +02001544 PARSE_ALT_COMMENTS = 0x00800000, // delim[0] and delim[1] are two different allowed comment chars
1545 // (so far, delim[0] will only work as comment char for full-line comment)
1546 // (IOW: it works as if PARSE_EOL_COMMENTS is not set. sysctl applet is okay with this)
1547 PARSE_WS_COMMENTS = 0x01000000, // comments are recognized even if there is whitespace before
1548 // ("line start><space><tab><space>#comment" is also comment, not only "line start>#comment")
Denis Vlasenko084266e2008-07-26 23:08:31 +00001549 // NORMAL is:
1550 // * remove leading and trailing delimiters and collapse
1551 // multiple delimiters into one
1552 // * warn and continue if less than mintokens delimiters found
1553 // * grab everything into last token
Denys Vlasenko499597d2012-01-11 00:37:17 +01001554 // * comments are recognized even if they aren't the first char
1555 PARSE_NORMAL = PARSE_COLLAPSE | PARSE_TRIM | PARSE_GREEDY | PARSE_EOL_COMMENTS,
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001556};
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001557typedef struct parser_t {
1558 FILE *fp;
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001559 char *data;
Timo Terasadcabf32011-06-20 09:49:56 +02001560 char *line, *nline;
1561 size_t line_alloc, nline_alloc;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001562 int lineno;
1563} parser_t;
Bernhard Reutner-Fischer67921282008-07-17 11:59:13 +00001564parser_t* config_open(const char *filename) FAST_FUNC;
Denis Vlasenko5415c852008-07-21 23:05:26 +00001565parser_t* config_open2(const char *filename, FILE* FAST_FUNC (*fopen_func)(const char *path)) FAST_FUNC;
Denys Vlasenkoadbbee42010-06-21 07:17:23 +02001566/* delims[0] is a comment char (use '\0' to disable), the rest are token delimiters */
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001567int config_read(parser_t *parser, char **tokens, unsigned flags, const char *delims) FAST_FUNC;
1568#define config_read(parser, tokens, max, min, str, flags) \
1569 config_read(parser, tokens, ((flags) | (((min) & 0xFF) << 8) | ((max) & 0xFF)), str)
Denis Vlasenkoc01340f2008-07-16 22:12:18 +00001570void config_close(parser_t *parser) FAST_FUNC;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001571
Denis Vlasenko6bf05cf2008-05-07 12:18:48 +00001572/* Concatenate path and filename to new allocated buffer.
1573 * Add "/" only as needed (no duplicate "//" are produced).
1574 * If path is NULL, it is assumed to be "/".
1575 * filename should not be NULL. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001576char *concat_path_file(const char *path, const char *filename) FAST_FUNC;
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +02001577/* Returns NULL on . and .. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001578char *concat_subpath_file(const char *path, const char *filename) FAST_FUNC;
Eric Andersene5dfced2001-04-09 22:48:12 +00001579
Denis Vlasenko4921b542007-02-03 02:17:41 +00001580
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001581int bb_make_directory(char *path, long mode, int flags) FAST_FUNC;
Matt Kraaiceeff732001-06-21 19:41:37 +00001582
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001583int get_signum(const char *name) FAST_FUNC;
1584const char *get_signame(int number) FAST_FUNC;
1585void print_signames(void) FAST_FUNC;
Rob Landleyc9c1a412006-07-12 19:17:55 +00001586
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001587char *bb_simplify_path(const char *path) FAST_FUNC;
Denis Vlasenko1cf4a0e2009-04-22 13:49:16 +00001588/* Returns ptr to NUL */
1589char *bb_simplify_abs_path_inplace(char *path) FAST_FUNC;
Eric Andersen34506362001-08-02 05:02:46 +00001590
Peter Kümmela6588fa2014-12-22 01:55:54 +01001591#ifndef LOGIN_FAIL_DELAY
Denys Vlasenko681efe22011-03-08 21:00:36 +01001592#define LOGIN_FAIL_DELAY 3
Peter Kümmela6588fa2014-12-22 01:55:54 +01001593#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001594extern void bb_do_delay(int seconds) FAST_FUNC;
1595extern void change_identity(const struct passwd *pw) FAST_FUNC;
Denys Vlasenko79e25982016-11-03 22:13:08 +01001596extern void run_shell(const char *shell, int loginshell, const char **args) NORETURN FAST_FUNC;
Denys Vlasenko681efe22011-03-08 21:00:36 +01001597
1598/* Returns $SHELL, getpwuid(getuid())->pw_shell, or DEFAULT_SHELL.
1599 * Note that getpwuid result might need xstrdup'ing
1600 * if there is a possibility of intervening getpwxxx() calls.
1601 */
Denys Vlasenkofd77ea52012-10-03 09:42:21 +02001602const char *get_shell_name(void) FAST_FUNC;
Denys Vlasenko681efe22011-03-08 21:00:36 +01001603
Denys Vlasenko2af5e3f2018-02-21 20:13:39 +01001604#if ENABLE_FEATURE_SETPRIV_CAPABILITIES || ENABLE_RUN_INIT
Denys Vlasenko44b3f2f2017-08-21 02:14:19 +02001605unsigned cap_name_to_number(const char *cap) FAST_FUNC;
1606void printf_cap(const char *pfx, unsigned cap_no) FAST_FUNC;
Denys Vlasenko200bcc82017-08-21 19:30:01 +02001607void drop_capability(int cap_ordinal) FAST_FUNC;
1608/* Structures inside "struct caps" are Linux-specific and libcap-specific: */
1609#define DEFINE_STRUCT_CAPS \
1610struct caps { \
1611 struct __user_cap_header_struct header; \
1612 unsigned u32s; \
1613 struct __user_cap_data_struct data[2]; \
1614}
1615void getcaps(void *caps) FAST_FUNC;
Denys Vlasenko2af5e3f2018-02-21 20:13:39 +01001616#endif
Denys Vlasenko44b3f2f2017-08-21 02:14:19 +02001617
Denis Vlasenkob5a122b2006-12-30 14:46:51 +00001618#if ENABLE_SELINUX
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001619extern void renew_current_security_context(void) FAST_FUNC;
1620extern void set_current_security_context(security_context_t sid) FAST_FUNC;
Denis Vlasenko1203c9b2007-03-11 22:16:02 +00001621extern context_t set_security_context_component(security_context_t cur_context,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001622 char *user, char *role, char *type, char *range) FAST_FUNC;
1623extern void setfscreatecon_or_die(security_context_t scontext) FAST_FUNC;
1624extern void selinux_preserve_fcontext(int fdesc) FAST_FUNC;
Denis Vlasenko2edbc2a2007-10-20 02:00:49 +00001625#else
1626#define selinux_preserve_fcontext(fdesc) ((void)0)
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001627#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001628extern void selinux_or_die(void) FAST_FUNC;
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001629
Davide Cavalca9b3b9792011-01-25 02:26:03 +01001630
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001631/* setup_environment:
Bernhard Reutner-Fischer99709ab2010-02-24 16:10:09 +01001632 * if chdir pw->pw_dir: ok: else if to_tmp == 1: goto /tmp else: goto / or die
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001633 * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001634 * TERM=(old value)
1635 * USER=pw->pw_name, LOGNAME=pw->pw_name
1636 * PATH=bb_default_[root_]path
1637 * HOME=pw->pw_dir
1638 * SHELL=shell
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001639 * else if change_env = 1:
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001640 * if not root (if pw->pw_uid != 0):
1641 * USER=pw->pw_name, LOGNAME=pw->pw_name
1642 * HOME=pw->pw_dir
1643 * SHELL=shell
1644 * else does nothing
Denys Vlasenkoe4f6bfd2017-07-22 03:04:20 +02001645 *
1646 * NB: CHANGEENV and CLEARENV use setenv() - this leaks memory!
1647 * If setup_environment() is used is vforked child, this leaks memory _in parent too_!
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001648 */
Denys Vlasenkofd686a22010-02-26 09:52:45 +01001649#define SETUP_ENV_CHANGEENV (1 << 0)
1650#define SETUP_ENV_CLEARENV (1 << 1)
1651#define SETUP_ENV_TO_TMP (1 << 2)
Pascal Bellard70fc8c12012-06-12 13:21:02 +02001652#define SETUP_ENV_NO_CHDIR (1 << 4)
Denys Vlasenko8b59b2c2013-11-19 13:36:45 +01001653void setup_environment(const char *shell, int flags, const struct passwd *pw) FAST_FUNC;
1654void nuke_str(char *str) FAST_FUNC;
Kaarle Ritvanen517a82c2016-01-02 00:20:39 +02001655#if ENABLE_FEATURE_SECURETTY && !ENABLE_PAM
Denys Vlasenkoa3de0b32017-04-13 13:04:05 +02001656int is_tty_secure(const char *short_tty) FAST_FUNC;
Kaarle Ritvanen517a82c2016-01-02 00:20:39 +02001657#else
Denys Vlasenkoa3de0b32017-04-13 13:04:05 +02001658static ALWAYS_INLINE int is_tty_secure(const char *short_tty UNUSED_PARAM) { return 1; }
Kaarle Ritvanen517a82c2016-01-02 00:20:39 +02001659#endif
Denys Vlasenko335681c2017-04-13 12:57:04 +02001660#define CHECKPASS_PW_HAS_EMPTY_PASSWORD 2
Morten Kvistgaardfeac9b62014-08-05 21:57:18 +02001661int check_password(const struct passwd *pw, const char *plaintext) FAST_FUNC;
Denys Vlasenko8b59b2c2013-11-19 13:36:45 +01001662int ask_and_check_password_extended(const struct passwd *pw, int timeout, const char *prompt) FAST_FUNC;
1663int ask_and_check_password(const struct passwd *pw) FAST_FUNC;
Denis Vlasenkofdddab02008-06-12 16:56:52 +00001664/* Returns a malloced string */
Denis Vlasenkob4c5bf62008-06-15 18:35:34 +00001665#if !ENABLE_USE_BB_CRYPT
1666#define pw_encrypt(clear, salt, cleanup) pw_encrypt(clear, salt)
1667#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001668extern char *pw_encrypt(const char *clear, const char *salt, int cleanup) FAST_FUNC;
1669extern int obscure(const char *old, const char *newval, const struct passwd *pwdp) FAST_FUNC;
Denys Vlasenko12a43272011-05-13 03:19:01 +02001670/*
1671 * rnd is additional random input. New one is returned.
Denis Vlasenko4ea83bf2008-06-12 16:55:59 +00001672 * Useful if you call crypt_make_salt many times in a row:
1673 * rnd = crypt_make_salt(buf1, 4, 0);
1674 * rnd = crypt_make_salt(buf2, 4, rnd);
1675 * rnd = crypt_make_salt(buf3, 4, rnd);
1676 * (otherwise we risk having same salt generated)
1677 */
Denys Vlasenko12a43272011-05-13 03:19:01 +02001678extern int crypt_make_salt(char *p, int cnt /*, int rnd*/) FAST_FUNC;
1679/* "$N$" + sha_salt_16_bytes + NUL */
1680#define MAX_PW_SALT_LEN (3 + 16 + 1)
1681extern char* crypt_make_pw_salt(char p[MAX_PW_SALT_LEN], const char *algo) FAST_FUNC;
1682
Denis Vlasenko829bbd32009-04-14 00:51:05 +00001683
Denis Vlasenko4ea83bf2008-06-12 16:55:59 +00001684/* Returns number of lines changed, or -1 on error */
Denis Vlasenko829bbd32009-04-14 00:51:05 +00001685#if !(ENABLE_FEATURE_ADDUSER_TO_GROUP || ENABLE_FEATURE_DEL_USER_FROM_GROUP)
1686#define update_passwd(filename, username, data, member) \
1687 update_passwd(filename, username, data)
1688#endif
1689extern int update_passwd(const char *filename,
1690 const char *username,
1691 const char *data,
1692 const char *member) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001693
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001694int index_in_str_array(const char *const string_array[], const char *key) FAST_FUNC;
1695int index_in_strings(const char *strings, const char *key) FAST_FUNC;
1696int index_in_substr_array(const char *const string_array[], const char *key) FAST_FUNC;
1697int index_in_substrings(const char *strings, const char *key) FAST_FUNC;
1698const char *nth_string(const char *strings, int n) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001699
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001700extern void print_login_issue(const char *issue_file, const char *tty) FAST_FUNC;
1701extern void print_login_prompt(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001702
Denys Vlasenko53283ad2009-11-02 14:20:34 +01001703char *xmalloc_ttyname(int fd) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof893da82007-08-09 08:27:24 +00001704/* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001705int get_terminal_width_height(int fd, unsigned *width, unsigned *height) FAST_FUNC;
Denys Vlasenko641caae2015-10-23 01:44:22 +02001706int get_terminal_width(int fd) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001707
Denis Vlasenko202ac502008-11-05 13:20:58 +00001708int tcsetattr_stdin_TCSANOW(const struct termios *tp) FAST_FUNC;
Denys Vlasenko058a1532018-04-16 10:24:48 +02001709#define TERMIOS_CLEAR_ISIG (1 << 0)
1710#define TERMIOS_RAW_CRNL_INPUT (1 << 1)
1711#define TERMIOS_RAW_CRNL_OUTPUT (1 << 2)
1712#define TERMIOS_RAW_CRNL (TERMIOS_RAW_CRNL_INPUT|TERMIOS_RAW_CRNL_OUTPUT)
1713#define TERMIOS_RAW_INPUT (1 << 3)
Denys Vlasenkoaaaaaa52017-09-15 17:14:01 +02001714int get_termios_and_make_raw(int fd, struct termios *newterm, struct termios *oldterm, int flags) FAST_FUNC;
Denys Vlasenko01ccdd12017-01-11 16:17:59 +01001715int set_termios_to_raw(int fd, struct termios *oldterm, int flags) FAST_FUNC;
Denis Vlasenko202ac502008-11-05 13:20:58 +00001716
Denis Vlasenko5bb2fc22008-04-21 03:23:59 +00001717/* NB: "unsigned request" is crucial! "int request" will break some arches! */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001718int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1719int 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 +00001720#if ENABLE_IOCTL_HEX2STR_ERROR
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001721int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1722int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001723#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1724#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
1725#else
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001726int bb_ioctl_or_warn(int fd, unsigned request, void *argp) FAST_FUNC;
1727int bb_xioctl(int fd, unsigned request, void *argp) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001728#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1729#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
1730#endif
1731
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001732char *is_in_ino_dev_hashtable(const struct stat *statbuf) FAST_FUNC;
1733void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name) FAST_FUNC;
1734void reset_ino_dev_hashtable(void) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001735#ifdef __GLIBC__
1736/* At least glibc has horrendously large inline for this, so wrap it */
Denys Vlasenko975c7142011-01-24 23:53:12 +01001737unsigned long long bb_makedev(unsigned major, unsigned minor) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001738#undef makedev
1739#define makedev(a,b) bb_makedev(a,b)
1740#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001741
1742
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001743/* "Keycodes" that report an escape sequence.
1744 * We use something which fits into signed char,
Denys Vlasenko5370bfb2009-09-06 02:58:59 +02001745 * yet doesn't represent any valid Unicode character.
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001746 * Also, -1 is reserved for error indication and we don't use it. */
1747enum {
Rostislav Skudnov2e4ef382016-11-24 15:04:00 +01001748 KEYCODE_UP = -2,
1749 KEYCODE_DOWN = -3,
1750 KEYCODE_RIGHT = -4,
1751 KEYCODE_LEFT = -5,
1752 KEYCODE_HOME = -6,
1753 KEYCODE_END = -7,
1754 KEYCODE_INSERT = -8,
1755 KEYCODE_DELETE = -9,
1756 KEYCODE_PAGEUP = -10,
1757 KEYCODE_PAGEDOWN = -11,
1758 KEYCODE_BACKSPACE = -12, /* Used only if Alt/Ctrl/Shifted */
1759 KEYCODE_D = -13, /* Used only if Alted */
Denys Vlasenko9ce09bc2011-11-03 13:28:22 +01001760#if 0
Rostislav Skudnov2e4ef382016-11-24 15:04:00 +01001761 KEYCODE_FUN1 = ,
1762 KEYCODE_FUN2 = ,
1763 KEYCODE_FUN3 = ,
1764 KEYCODE_FUN4 = ,
1765 KEYCODE_FUN5 = ,
1766 KEYCODE_FUN6 = ,
1767 KEYCODE_FUN7 = ,
1768 KEYCODE_FUN8 = ,
1769 KEYCODE_FUN9 = ,
1770 KEYCODE_FUN10 = ,
1771 KEYCODE_FUN11 = ,
1772 KEYCODE_FUN12 = ,
Denys Vlasenko9ce09bc2011-11-03 13:28:22 +01001773#endif
Rostislav Skudnov2e4ef382016-11-24 15:04:00 +01001774 /* ^^^^^ Be sure that last defined value is small enough.
1775 * Current read_key() code allows going up to -32 (0xfff..fffe0).
1776 * This gives three upper bits in LSB to play with:
1777 * KEYCODE_foo values are 0xfff..fffXX, lowest XX bits are: scavvvvv,
1778 * s=0 if SHIFT, c=0 if CTRL, a=0 if ALT,
1779 * vvvvv bits are the same for same key regardless of "shift bits".
Denys Vlasenko9ce09bc2011-11-03 13:28:22 +01001780 */
Rostislav Skudnov2e4ef382016-11-24 15:04:00 +01001781 //KEYCODE_SHIFT_... = KEYCODE_... & ~0x80,
1782 KEYCODE_CTRL_RIGHT = KEYCODE_RIGHT & ~0x40,
1783 KEYCODE_CTRL_LEFT = KEYCODE_LEFT & ~0x40,
1784 KEYCODE_ALT_RIGHT = KEYCODE_RIGHT & ~0x20,
1785 KEYCODE_ALT_LEFT = KEYCODE_LEFT & ~0x20,
1786 KEYCODE_ALT_BACKSPACE = KEYCODE_BACKSPACE & ~0x20,
1787 KEYCODE_ALT_D = KEYCODE_D & ~0x20,
Denys Vlasenko9ce09bc2011-11-03 13:28:22 +01001788
Denys Vlasenko180f5852009-10-26 00:59:59 +01001789 KEYCODE_CURSOR_POS = -0x100, /* 0xfff..fff00 */
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001790 /* How long is the longest ESC sequence we know?
1791 * We want it big enough to be able to contain
1792 * cursor position sequence "ESC [ 9999 ; 9999 R"
1793 */
1794 KEYCODE_BUFFER_SIZE = 16
1795};
1796/* Note: fd may be in blocking or non-blocking mode, both make sense.
1797 * For one, less uses non-blocking mode.
1798 * Only the first read syscall inside read_key may block indefinitely
1799 * (unless fd is in non-blocking mode),
1800 * subsequent reads will time out after a few milliseconds.
1801 * Return of -1 means EOF or error (errno == 0 on EOF).
1802 * buffer[0] is used as a counter of buffered chars and must be 0
1803 * on first call.
Denys Vlasenko58f108e2010-03-11 21:17:55 +01001804 * timeout:
Denys Vlasenko84ea60e2017-08-02 17:27:28 +02001805 * -2: do not poll(-1) for input - read() it, return on EAGAIN at once
1806 * -1: poll(-1) (i.e. block even on NONBLOCKed fd)
1807 * >=0: poll() for TIMEOUT milliseconds, return -1/EAGAIN on timeout
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001808 */
Denys Vlasenko58f108e2010-03-11 21:17:55 +01001809int64_t read_key(int fd, char *buffer, int timeout) FAST_FUNC;
Tomas Heinrichd2b04052010-03-09 14:09:24 +01001810void read_key_ungets(char *buffer, const char *str, unsigned len) FAST_FUNC;
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001811
1812
Denis Vlasenko38f63192007-01-22 09:03:07 +00001813#if ENABLE_FEATURE_EDITING
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001814/* It's NOT just ENABLEd or disabled. It's a number: */
Denys Vlasenko2c4de5b2011-03-31 13:16:52 +02001815# if defined CONFIG_FEATURE_EDITING_HISTORY && CONFIG_FEATURE_EDITING_HISTORY > 0
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001816# define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
Flemming Madsend96ffda2013-04-07 18:47:24 +02001817unsigned size_from_HISTFILESIZE(const char *hp) FAST_FUNC;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001818# else
1819# define MAX_HISTORY 0
1820# endif
Ron Yorston9e2a5662020-01-21 16:01:58 +00001821typedef const char *get_exe_name_t(int i) FAST_FUNC;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001822typedef struct line_input_t {
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001823 int flags;
Denys Vlasenko84ea60e2017-08-02 17:27:28 +02001824 int timeout;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001825 const char *path_lookup;
Ron Yorston9e2a5662020-01-21 16:01:58 +00001826# if ENABLE_FEATURE_TAB_COMPLETION \
1827&& (ENABLE_ASH || ENABLE_SH_IS_ASH || ENABLE_BASH_IS_ASH \
1828|| ENABLE_HUSH || ENABLE_SH_IS_HUSH || ENABLE_BASH_IS_HUSH \
1829)
1830 /* function to fetch additional application-specific names to match */
1831 get_exe_name_t *get_exe_name;
1832# define EDITING_HAS_get_exe_name 1
1833# endif
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001834# if MAX_HISTORY
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001835 int cnt_history;
1836 int cur_history;
Denys Vlasenko2c4de5b2011-03-31 13:16:52 +02001837 int max_history; /* must never be <= 0 */
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001838# if ENABLE_FEATURE_EDITING_SAVEHISTORY
Denys Vlasenkobede2152011-09-04 16:12:33 +02001839 /* meaning of this field depends on FEATURE_EDITING_SAVE_ON_EXIT:
1840 * if !FEATURE_EDITING_SAVE_ON_EXIT: "how many lines are
1841 * in on-disk history"
1842 * if FEATURE_EDITING_SAVE_ON_EXIT: "how many in-memory lines are
1843 * also in on-disk history (and thus need to be skipped on save)"
1844 */
Denis Vlasenko57abf9e2009-03-22 19:00:05 +00001845 unsigned cnt_history_in_file;
Denis Vlasenko57abf9e2009-03-22 19:00:05 +00001846 const char *hist_file;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001847# endif
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001848 char *history[MAX_HISTORY + 1];
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001849# endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001850} line_input_t;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001851enum {
Denys Vlasenkoe45af7a2011-09-04 16:15:24 +02001852 DO_HISTORY = 1 * (MAX_HISTORY > 0),
1853 TAB_COMPLETION = 2 * ENABLE_FEATURE_TAB_COMPLETION,
1854 USERNAME_COMPLETION = 4 * ENABLE_FEATURE_USERNAME_COMPLETION,
1855 VI_MODE = 8 * ENABLE_FEATURE_EDITING_VI,
1856 WITH_PATH_LOOKUP = 0x10,
1857 FOR_SHELL = DO_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001858};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001859line_input_t *new_line_input_t(int flags) FAST_FUNC;
Denys Vlasenkoa68a87c2018-12-06 11:12:38 +01001860void free_line_input_t(line_input_t *n) FAST_FUNC;
Denys Vlasenko046341e2011-02-04 17:53:59 +01001861/*
1862 * maxsize must be >= 2.
Denys Vlasenko5c2e81b2009-07-16 14:14:34 +02001863 * Returns:
Denis Vlasenko80667e32008-02-02 18:35:55 +00001864 * -1 on read errors or EOF, or on bare Ctrl-D,
1865 * 0 on ctrl-C (the line entered is still returned in 'command'),
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001866 * >0 length of input string, including terminating '\n'
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001867 */
Denys Vlasenko84ea60e2017-08-02 17:27:28 +02001868int read_line_input(line_input_t *st, const char *prompt, char *command, int maxsize) FAST_FUNC;
Flemming Madsend96ffda2013-04-07 18:47:24 +02001869void show_history(const line_input_t *st) FAST_FUNC;
Denys Vlasenkobede2152011-09-04 16:12:33 +02001870# if ENABLE_FEATURE_EDITING_SAVE_ON_EXIT
1871void save_history(line_input_t *st);
1872# endif
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001873#else
Denys Vlasenko36df0482009-10-19 16:07:28 +02001874#define MAX_HISTORY 0
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001875int read_line_input(const char* prompt, char* command, int maxsize) FAST_FUNC;
Denys Vlasenko84ea60e2017-08-02 17:27:28 +02001876#define read_line_input(state, prompt, command, maxsize) \
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001877 read_line_input(prompt, command, maxsize)
1878#endif
1879
Ron Yorston9e2a5662020-01-21 16:01:58 +00001880#ifndef EDITING_HAS_get_exe_name
1881# define EDITING_HAS_get_exe_name 0
1882#endif
1883
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001884
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001885#ifndef COMM_LEN
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001886# ifdef TASK_COMM_LEN
Denis Vlasenkofa076802006-11-05 00:38:51 +00001887enum { COMM_LEN = TASK_COMM_LEN };
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001888# else
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001889/* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
Denis Vlasenkofa076802006-11-05 00:38:51 +00001890enum { COMM_LEN = 16 };
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001891# endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001892#endif
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02001893
1894struct smaprec {
1895 unsigned long mapped_rw;
1896 unsigned long mapped_ro;
1897 unsigned long shared_clean;
1898 unsigned long shared_dirty;
1899 unsigned long private_clean;
1900 unsigned long private_dirty;
1901 unsigned long stack;
1902 unsigned long smap_pss, smap_swap;
1903 unsigned long smap_size;
Denys Vlasenkoaad76962018-12-30 20:24:59 +01001904 // For mixed 32/64 userspace, 32-bit pmap still needs
1905 // 64-bit field here to correctly show 64-bit processes:
1906 unsigned long long smap_start;
1907 // (strictly speaking, other fields need to be wider too,
1908 // but they are in kbytes, not bytes, and they hold sizes,
1909 // not start addresses, sizes tend to be less than 4 terabytes)
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02001910 char smap_mode[5];
1911 char *smap_name;
1912};
1913
1914#if !ENABLE_PMAP
1915#define procps_read_smaps(pid, total, cb, data) \
1916 procps_read_smaps(pid, total)
1917#endif
1918int FAST_FUNC procps_read_smaps(pid_t pid, struct smaprec *total,
Denys Vlasenko6830ade2013-01-15 13:58:01 +01001919 void (*cb)(struct smaprec *, void *), void *data);
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02001920
Denis Vlasenko512499c2007-08-26 18:23:13 +00001921typedef struct procps_status_t {
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001922 DIR *dir;
Denys Vlasenkob410d4a2009-09-19 22:29:42 +02001923 IF_FEATURE_SHOW_THREADS(DIR *task_dir;)
Denis Vlasenko512499c2007-08-26 18:23:13 +00001924 uint8_t shift_pages_to_bytes;
1925 uint8_t shift_pages_to_kb;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001926/* Fields are set to 0/NULL if failed to determine (or not requested) */
Denis Vlasenko3b3ca112008-07-17 18:39:36 +00001927 uint16_t argv_len;
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001928 char *argv0;
Alexander Shishkine766f622009-07-29 01:35:13 +02001929 char *exe;
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001930 IF_SELINUX(char *context;)
Lauri Kasanen6578f2c2010-12-05 05:22:29 +01001931 IF_FEATURE_SHOW_THREADS(unsigned main_thread_pid;)
Denis Vlasenko0696b8a2007-06-06 07:40:16 +00001932 /* Everything below must contain no ptrs to malloc'ed data:
1933 * it is memset(0) for each process in procps_scan() */
Denis Vlasenkofc1e9952007-08-29 18:23:36 +00001934 unsigned long vsz, rss; /* we round it to kbytes */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001935 unsigned long stime, utime;
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001936 unsigned long start_time;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001937 unsigned pid;
1938 unsigned ppid;
1939 unsigned pgid;
1940 unsigned sid;
1941 unsigned uid;
1942 unsigned gid;
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001943#if ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS
1944 unsigned ruid;
1945 unsigned rgid;
1946 int niceness;
1947#endif
Denis Vlasenko31789a82007-06-19 14:43:17 +00001948 unsigned tty_major,tty_minor;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001949#if ENABLE_FEATURE_TOPMEM
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02001950 struct smaprec smaps;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001951#endif
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001952 char state[4];
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001953 /* basename of executable in exec(2), read from /proc/N/stat
1954 * (if executable is symlink or script, it is NOT replaced
1955 * by link target or interpreter name) */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001956 char comm[COMM_LEN];
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001957 /* user/group? - use passwd/group parsing functions */
Denis Vlasenko17e7f042008-09-25 10:48:06 +00001958#if ENABLE_FEATURE_TOP_SMP_PROCESS
1959 int last_seen_on_cpu;
1960#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001961} procps_status_t;
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001962/* flag bits for procps_scan(xx, flags) calls */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001963enum {
1964 PSSCAN_PID = 1 << 0,
1965 PSSCAN_PPID = 1 << 1,
1966 PSSCAN_PGID = 1 << 2,
1967 PSSCAN_SID = 1 << 3,
1968 PSSCAN_UIDGID = 1 << 4,
1969 PSSCAN_COMM = 1 << 5,
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001970 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001971 PSSCAN_ARGV0 = 1 << 7,
Alexander Shishkine766f622009-07-29 01:35:13 +02001972 PSSCAN_EXE = 1 << 8,
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001973 PSSCAN_STATE = 1 << 9,
1974 PSSCAN_VSZ = 1 << 10,
1975 PSSCAN_RSS = 1 << 11,
1976 PSSCAN_STIME = 1 << 12,
1977 PSSCAN_UTIME = 1 << 13,
1978 PSSCAN_TTY = 1 << 14,
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001979 PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM,
Denis Vlasenko9f00e052009-02-14 01:36:11 +00001980 /* NB: used by find_pid_by_name(). Any applet using it
1981 * needs to be mentioned here. */
1982 PSSCAN_ARGVN = (1 << 16) * (ENABLE_KILLALL
1983 || ENABLE_PGREP || ENABLE_PKILL
1984 || ENABLE_PIDOF
Denis Vlasenko3266aa92009-04-01 11:24:04 +00001985 || ENABLE_SESTATUS
Denis Vlasenko9f00e052009-02-14 01:36:11 +00001986 ),
Denys Vlasenko4ff1ce02009-09-22 11:21:48 +02001987 PSSCAN_CONTEXT = (1 << 17) * ENABLE_SELINUX,
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001988 PSSCAN_START_TIME = 1 << 18,
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001989 PSSCAN_CPU = (1 << 19) * ENABLE_FEATURE_TOP_SMP_PROCESS,
1990 PSSCAN_NICE = (1 << 20) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1991 PSSCAN_RUIDGID = (1 << 21) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
Denys Vlasenkob410d4a2009-09-19 22:29:42 +02001992 PSSCAN_TASKS = (1 << 22) * ENABLE_FEATURE_SHOW_THREADS,
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001993};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001994//procps_status_t* alloc_procps_scan(void) FAST_FUNC;
1995void free_procps_scan(procps_status_t* sp) FAST_FUNC;
1996procps_status_t* procps_scan(procps_status_t* sp, int flags) FAST_FUNC;
Denys Vlasenko3a0f6f22009-09-12 00:15:34 +02001997/* Format cmdline (up to col chars) into char buf[size] */
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001998/* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
Denys Vlasenko3a0f6f22009-09-12 00:15:34 +02001999void read_cmdline(char *buf, int size, unsigned pid, const char *comm) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00002000pid_t *find_pid_by_name(const char* procName) FAST_FUNC;
2001pid_t *pidlist_reverse(pid_t *pidList) FAST_FUNC;
Denys Vlasenkoc9b97502010-08-16 02:49:21 +02002002int starts_with_cpu(const char *str) FAST_FUNC;
2003unsigned get_cpu_count(void) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00002004
2005
Denys Vlasenkodd1061b2011-09-11 21:04:02 +02002006/* Use strict=1 if you process input from untrusted source:
2007 * it will return NULL on invalid %xx (bad hex chars)
2008 * and str + 1 if decoded char is / or NUL.
2009 * In non-strict mode, it always succeeds (returns str),
2010 * and also it additionally decoded '+' to space.
2011 */
2012char *percent_decode_in_place(char *str, int strict) FAST_FUNC;
2013
2014
Aurelien Jarnod3a42392012-07-24 16:28:34 +02002015extern const char bb_uuenc_tbl_base64[] ALIGN1;
2016extern const char bb_uuenc_tbl_std[] ALIGN1;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00002017void bb_uuencode(char *store, const void *s, int length, const char *tbl) FAST_FUNC;
Denys Vlasenko9fe98f72010-09-16 17:51:13 +02002018enum {
2019 BASE64_FLAG_UU_STOP = 0x100,
2020 /* Sign-extends to a value which never matches fgetc result: */
2021 BASE64_FLAG_NO_STOP_CHAR = 0x80,
2022};
Leonid Lisovskiy328f27f2011-10-28 13:59:04 +02002023const char *decode_base64(char **pp_dst, const char *src) FAST_FUNC;
2024void read_base64(FILE *src_stream, FILE *dst_stream, int flags) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00002025
Denis Vlasenkodd539f72006-11-01 20:20:37 +00002026typedef struct md5_ctx_t {
Denys Vlasenko302ad142010-10-19 02:16:12 +02002027 uint8_t wbuffer[64]; /* always correctly aligned for uint64_t */
2028 void (*process_block)(struct md5_ctx_t*) FAST_FUNC;
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02002029 uint64_t total64; /* must be directly before hash[] */
Denys Vlasenko302ad142010-10-19 02:16:12 +02002030 uint32_t hash[8]; /* 4 elements for md5, 5 for sha1, 8 for sha256 */
2031} md5_ctx_t;
2032typedef struct md5_ctx_t sha1_ctx_t;
2033typedef struct md5_ctx_t sha256_ctx_t;
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02002034typedef struct sha512_ctx_t {
2035 uint64_t total64[2]; /* must be directly before hash[] */
2036 uint64_t hash[8];
Denys Vlasenko302ad142010-10-19 02:16:12 +02002037 uint8_t wbuffer[128]; /* always correctly aligned for uint64_t */
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02002038} sha512_ctx_t;
Lauri Kasanenb8173b62013-01-14 05:20:50 +01002039typedef struct sha3_ctx_t {
2040 uint64_t state[25];
2041 unsigned bytes_queued;
Denys Vlasenko71a090f2016-08-29 14:05:25 +02002042 unsigned input_block_bytes;
Lauri Kasanenb8173b62013-01-14 05:20:50 +01002043} sha3_ctx_t;
Denys Vlasenko302ad142010-10-19 02:16:12 +02002044void md5_begin(md5_ctx_t *ctx) FAST_FUNC;
Denys Vlasenko2cfcc9e2013-01-20 00:38:09 +01002045void md5_hash(md5_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
Denys Vlasenko49ecee02017-01-24 16:00:54 +01002046unsigned md5_end(md5_ctx_t *ctx, void *resbuf) FAST_FUNC;
Denys Vlasenko302ad142010-10-19 02:16:12 +02002047void sha1_begin(sha1_ctx_t *ctx) FAST_FUNC;
2048#define sha1_hash md5_hash
Denys Vlasenko49ecee02017-01-24 16:00:54 +01002049unsigned sha1_end(sha1_ctx_t *ctx, void *resbuf) FAST_FUNC;
Denys Vlasenko302ad142010-10-19 02:16:12 +02002050void sha256_begin(sha256_ctx_t *ctx) FAST_FUNC;
2051#define sha256_hash md5_hash
2052#define sha256_end sha1_end
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02002053void sha512_begin(sha512_ctx_t *ctx) FAST_FUNC;
2054void sha512_hash(sha512_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
Denys Vlasenko49ecee02017-01-24 16:00:54 +01002055unsigned sha512_end(sha512_ctx_t *ctx, void *resbuf) FAST_FUNC;
Lauri Kasanenb8173b62013-01-14 05:20:50 +01002056void sha3_begin(sha3_ctx_t *ctx) FAST_FUNC;
2057void sha3_hash(sha3_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
Denys Vlasenko49ecee02017-01-24 16:00:54 +01002058unsigned sha3_end(sha3_ctx_t *ctx, void *resbuf) FAST_FUNC;
2059/* TLS benefits from knowing that sha1 and sha256 share these. Give them "agnostic" names too */
2060typedef struct md5_ctx_t md5sha_ctx_t;
2061#define md5sha_hash md5_hash
2062#define sha_end sha1_end
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00002063
Denys Vlasenko9ce642f2010-10-27 15:26:45 +02002064extern uint32_t *global_crc32_table;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00002065uint32_t *crc32_filltable(uint32_t *tbl256, int endian) FAST_FUNC;
Denys Vlasenkoddacb032018-02-01 10:56:19 +01002066uint32_t *crc32_new_table_le(void) FAST_FUNC;
2067uint32_t *global_crc32_new_table_le(void) FAST_FUNC;
Denys Vlasenko9ce642f2010-10-27 15:26:45 +02002068uint32_t crc32_block_endian1(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
2069uint32_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 +00002070
2071typedef struct masks_labels_t {
2072 const char *labels;
2073 const int masks[];
2074} masks_labels_t;
2075int print_flags_separated(const int *masks, const char *labels,
2076 int flags, const char *separator) FAST_FUNC;
2077int print_flags(const masks_labels_t *ml, int flags) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00002078
Magnus Dammf5914992009-11-08 16:34:43 +01002079typedef struct bb_progress_t {
Denys Vlasenkoab8d00d2011-02-11 19:09:30 +01002080 unsigned last_size;
2081 unsigned last_update_sec;
2082 unsigned last_change_sec;
Magnus Dammf5914992009-11-08 16:34:43 +01002083 unsigned start_sec;
Denys Vlasenkoedccc982018-02-13 16:48:52 +01002084 /*unsigned last_eta;*/
Denys Vlasenkod55e1392011-02-11 18:56:13 +01002085 const char *curfile;
Magnus Dammf5914992009-11-08 16:34:43 +01002086} bb_progress_t;
2087
Denys Vlasenkod55e1392011-02-11 18:56:13 +01002088#define is_bb_progress_inited(p) ((p)->curfile != NULL)
2089#define bb_progress_free(p) do { \
2090 if (ENABLE_UNICODE_SUPPORT) free((char*)((p)->curfile)); \
2091 (p)->curfile = NULL; \
2092} while (0)
2093void bb_progress_init(bb_progress_t *p, const char *curfile) FAST_FUNC;
Denys Vlasenko26602b82018-11-23 19:14:52 +01002094int bb_progress_update(bb_progress_t *p,
Denys Vlasenko805aa9f2011-02-10 14:25:51 +01002095 uoff_t beg_range,
2096 uoff_t transferred,
2097 uoff_t totalsize) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00002098
Sven Eisenbergb068cf22016-04-03 21:53:12 +02002099unsigned ubi_devnum_from_devname(const char *str) FAST_FUNC;
Denys Vlasenko6aab9922016-04-03 22:24:51 +02002100int ubi_get_volid_by_name(unsigned ubi_devnum, const char *vol_name) FAST_FUNC;
Sven Eisenbergb068cf22016-04-03 21:53:12 +02002101
Denys Vlasenkod55e1392011-02-11 18:56:13 +01002102
Denis Vlasenko8f8f2682006-10-03 21:00:43 +00002103extern const char *applet_name;
Denys Vlasenko0004e992010-09-01 12:01:17 +02002104
2105/* Some older linkers don't perform string merging, we used to have common strings
2106 * as global arrays to do it by hand. But:
2107 * (1) newer linkers do it themselves,
2108 * (2) however, they DONT merge string constants with global arrays,
2109 * even if the value is the same (!). Thus global arrays actually
2110 * increased size a bit: for example, "/etc/passwd" string from libc
2111 * wasn't merged with bb_path_passwd_file[] array!
2112 * Therefore now we use #defines.
2113 */
Bernhard Reutner-Fischer78e1d582008-01-13 17:52:53 +00002114/* "BusyBox vN.N.N (timestamp or extra_version)" */
Aurelien Jarnod3a42392012-07-24 16:28:34 +02002115extern const char bb_banner[] ALIGN1;
2116extern const char bb_msg_memory_exhausted[] ALIGN1;
2117extern const char bb_msg_invalid_date[] ALIGN1;
Denys Vlasenko0004e992010-09-01 12:01:17 +02002118#define bb_msg_read_error "read error"
2119#define bb_msg_write_error "write error"
Aurelien Jarnod3a42392012-07-24 16:28:34 +02002120extern const char bb_msg_unknown[] ALIGN1;
2121extern const char bb_msg_can_not_create_raw_socket[] ALIGN1;
2122extern const char bb_msg_perm_denied_are_you_root[] ALIGN1;
2123extern const char bb_msg_you_must_be_root[] ALIGN1;
2124extern const char bb_msg_requires_arg[] ALIGN1;
Denys Vlasenko0f296a32015-10-14 13:21:01 +02002125extern const char bb_msg_invalid_arg_to[] ALIGN1;
Aurelien Jarnod3a42392012-07-24 16:28:34 +02002126extern const char bb_msg_standard_input[] ALIGN1;
2127extern const char bb_msg_standard_output[] ALIGN1;
Manuel Novoa III cad53642003-03-19 09:13:01 +00002128
Denis Vlasenko98c0bba2007-01-26 23:31:05 +00002129/* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
Aurelien Jarnod3a42392012-07-24 16:28:34 +02002130extern const char bb_hexdigits_upcase[] ALIGN1;
Denis Vlasenko7ca39212006-11-21 20:34:21 +00002131
Aurelien Jarnod3a42392012-07-24 16:28:34 +02002132extern const char bb_path_wtmp_file[] ALIGN1;
Denys Vlasenko0004e992010-09-01 12:01:17 +02002133
2134/* Busybox mount uses either /proc/mounts or /etc/mtab to
2135 * get the list of currently mounted filesystems */
2136#define bb_path_mtab_file IF_FEATURE_MTAB_SUPPORT("/etc/mtab")IF_NOT_FEATURE_MTAB_SUPPORT("/proc/mounts")
2137
Tito Ragusaad3d72f2011-01-16 23:39:45 +01002138#define bb_path_passwd_file _PATH_PASSWD
2139#define bb_path_group_file _PATH_GROUP
2140#define bb_path_shadow_file _PATH_SHADOW
2141#define bb_path_gshadow_file _PATH_GSHADOW
Denys Vlasenko0004e992010-09-01 12:01:17 +02002142
2143#define bb_path_motd_file "/etc/motd"
2144
2145#define bb_dev_null "/dev/null"
Aurelien Jarnod3a42392012-07-24 16:28:34 +02002146extern const char bb_busybox_exec_path[] ALIGN1;
Denys Vlasenkocca7c612018-01-12 13:21:33 +01002147/* allow default system PATH to be extended via CFLAGS */
2148#ifndef BB_ADDITIONAL_PATH
2149#define BB_ADDITIONAL_PATH ""
2150#endif
2151#define BB_PATH_ROOT_PATH "PATH=/sbin:/usr/sbin:/bin:/usr/bin" BB_ADDITIONAL_PATH
2152extern const char bb_PATH_root_path[] ALIGN1; /* BB_PATH_ROOT_PATH */
Denis Vlasenkof5f75c52007-06-12 22:35:19 +00002153#define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
Denys Vlasenkocca7c612018-01-12 13:21:33 +01002154/* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
2155 * but I want to save a few bytes here:
2156 */
Denis Vlasenkof5f75c52007-06-12 22:35:19 +00002157#define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +00002158
Denis Vlasenko703e2022007-01-22 14:12:08 +00002159extern const int const_int_0;
Denys Vlasenkoc52cbea2015-08-24 19:48:03 +02002160//extern const int const_int_1;
Denis Vlasenko703e2022007-01-22 14:12:08 +00002161
Denis Vlasenko972288e2007-03-15 00:57:01 +00002162/* This struct is deliberately not defined. */
2163/* See docs/keep_data_small.txt */
2164struct globals;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00002165/* '*const' ptr makes gcc optimize code much better.
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002166 * Magic prevents ptr_to_globals from going into rodata.
Denis Vlasenko574f2f42008-02-27 18:41:59 +00002167 * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
Denis Vlasenkobff32ce2007-03-15 19:48:35 +00002168extern struct globals *const ptr_to_globals;
Denys Vlasenkoaf7169b2019-10-25 12:12:22 +02002169
2170#if defined(__clang_major__) && __clang_major__ >= 9
2171/* Clang/llvm drops assignment to "constant" storage. Silently.
2172 * Needs serious convincing to not eliminate the store.
2173 */
2174static ALWAYS_INLINE void* not_const_pp(const void *p)
2175{
2176 void *pp;
2177 __asm__ __volatile__(
2178 "# forget that p points to const"
2179 : /*outputs*/ "=r" (pp)
2180 : /*inputs*/ "0" (p)
2181 );
2182 return pp;
2183}
2184#else
2185static ALWAYS_INLINE void* not_const_pp(const void *p) { return (void*)p; }
2186#endif
2187
Denis Vlasenko574f2f42008-02-27 18:41:59 +00002188/* At least gcc 3.4.6 on mipsel system needs optimization barrier */
Bernhard Reutner-Fischer797c96d2008-06-06 10:31:39 +00002189#define barrier() __asm__ __volatile__("":::"memory")
Denis Vlasenko574f2f42008-02-27 18:41:59 +00002190#define SET_PTR_TO_GLOBALS(x) do { \
Denys Vlasenkoaf7169b2019-10-25 12:12:22 +02002191 (*(struct globals**)not_const_pp(&ptr_to_globals)) = (void*)(x); \
Denis Vlasenko574f2f42008-02-27 18:41:59 +00002192 barrier(); \
2193} while (0)
Denys Vlasenkoaf7169b2019-10-25 12:12:22 +02002194
Guilherme Maciel Ferreira840ef172013-10-16 14:43:30 +02002195#define FREE_PTR_TO_GLOBALS() do { \
2196 if (ENABLE_FEATURE_CLEAN_UP) { \
2197 free(ptr_to_globals); \
2198 } \
2199} while (0)
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00002200
Denis Vlasenkodca0b702006-10-27 09:05:02 +00002201/* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
2202 * use bb_default_login_shell and following defines.
2203 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
2204 * don't forget to change increment constant. */
Ladislav Michla73b87e2010-06-27 03:23:31 +02002205#define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
Aurelien Jarnod3a42392012-07-24 16:28:34 +02002206extern const char bb_default_login_shell[] ALIGN1;
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00002207/* "/bin/sh" */
Ladislav Michla73b87e2010-06-27 03:23:31 +02002208#define DEFAULT_SHELL (bb_default_login_shell+1)
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00002209/* "sh" */
Ladislav Michla73b87e2010-06-27 03:23:31 +02002210#define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00002211
Jeremie Koenig816ed972010-05-27 15:46:29 +02002212/* The following devices are the same on all systems. */
2213#define CURRENT_TTY "/dev/tty"
2214#define DEV_CONSOLE "/dev/console"
2215
2216#if defined(__FreeBSD_kernel__)
2217# define CURRENT_VC CURRENT_TTY
2218# define VC_1 "/dev/ttyv0"
2219# define VC_2 "/dev/ttyv1"
2220# define VC_3 "/dev/ttyv2"
2221# define VC_4 "/dev/ttyv3"
2222# define VC_5 "/dev/ttyv4"
2223# define VC_FORMAT "/dev/ttyv%d"
2224#elif defined(__GNU__)
2225# define CURRENT_VC CURRENT_TTY
2226# define VC_1 "/dev/tty1"
2227# define VC_2 "/dev/tty2"
2228# define VC_3 "/dev/tty3"
2229# define VC_4 "/dev/tty4"
2230# define VC_5 "/dev/tty5"
2231# define VC_FORMAT "/dev/tty%d"
Denys Vlasenko1c26e052010-10-24 02:35:17 +02002232#elif ENABLE_FEATURE_DEVFS
2233/*Linux, obsolete devfs names */
Matt Kraai439e3df2001-07-23 14:52:08 +00002234# define CURRENT_VC "/dev/vc/0"
2235# define VC_1 "/dev/vc/1"
2236# define VC_2 "/dev/vc/2"
2237# define VC_3 "/dev/vc/3"
2238# define VC_4 "/dev/vc/4"
2239# define VC_5 "/dev/vc/5"
Matt Kraai439e3df2001-07-23 14:52:08 +00002240# define VC_FORMAT "/dev/vc/%d"
Denys Vlasenko4928e9f2013-06-27 03:45:16 +02002241# define LOOP_FORMAT "/dev/loop/%u"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00002242# define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00002243# define LOOP_NAME "/dev/loop/"
Eric Andersen5f284552003-11-14 03:11:29 +00002244# define FB_0 "/dev/fb/0"
Matt Kraai439e3df2001-07-23 14:52:08 +00002245#else
Denys Vlasenko1c26e052010-10-24 02:35:17 +02002246/*Linux, normal names */
Matt Kraai439e3df2001-07-23 14:52:08 +00002247# define CURRENT_VC "/dev/tty0"
2248# define VC_1 "/dev/tty1"
2249# define VC_2 "/dev/tty2"
2250# define VC_3 "/dev/tty3"
2251# define VC_4 "/dev/tty4"
2252# define VC_5 "/dev/tty5"
Matt Kraai439e3df2001-07-23 14:52:08 +00002253# define VC_FORMAT "/dev/tty%d"
Denys Vlasenko4928e9f2013-06-27 03:45:16 +02002254# define LOOP_FORMAT "/dev/loop%u"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00002255# define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00002256# define LOOP_NAME "/dev/loop"
Eric Andersen5f284552003-11-14 03:11:29 +00002257# define FB_0 "/dev/fb0"
Matt Kraai439e3df2001-07-23 14:52:08 +00002258#endif
2259
Denys Vlasenkoabfa3ec2018-09-28 15:13:04 +02002260// storage helpers for mk*fs utilities
2261char BUG_wrong_field_size(void);
2262#define STORE_LE(field, value) \
2263do { \
2264 if (sizeof(field) == 4) \
2265 field = SWAP_LE32((uint32_t)(value)); \
2266 else if (sizeof(field) == 2) \
2267 field = SWAP_LE16((uint16_t)(value)); \
2268 else if (sizeof(field) == 1) \
2269 field = (uint8_t)(value); \
2270 else \
2271 BUG_wrong_field_size(); \
2272} while (0)
2273
2274#define FETCH_LE32(field) \
2275 (sizeof(field) == 4 ? SWAP_LE32(field) : BUG_wrong_field_size())
2276
Rob Landleyc57ec372006-04-10 17:07:15 +00002277
Denys Vlasenko9d57a802009-10-23 14:24:44 +02002278#define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
Denys Vlasenkoab3964d2015-10-13 14:50:20 +02002279#define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
Denys Vlasenko9d57a802009-10-23 14:24:44 +02002280
Rob Landleyb623a542006-05-31 22:09:03 +00002281
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02002282/* We redefine ctype macros. Unicode-correct handling of char types
2283 * can't be done with such byte-oriented operations anyway,
2284 * we don't lose anything.
2285 */
Rob Landley4ae905a2006-07-06 17:22:54 +00002286#undef isalnum
2287#undef isalpha
2288#undef isascii
2289#undef isblank
2290#undef iscntrl
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02002291#undef isdigit
Rob Landley4ae905a2006-07-06 17:22:54 +00002292#undef isgraph
2293#undef islower
2294#undef isprint
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02002295#undef ispunct
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02002296#undef isspace
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02002297#undef isupper
2298#undef isxdigit
2299#undef toupper
2300#undef tolower
Rob Landley4ae905a2006-07-06 17:22:54 +00002301
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02002302/* We save ~500 bytes on isdigit alone.
Denys Vlasenko7b4cd6f2009-10-23 02:22:03 +02002303 * BTW, x86 likes (unsigned char) cast more than (unsigned). */
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01002304
2305/* These work the same for ASCII and Unicode,
2306 * assuming no one asks "is this a *Unicode* letter?" using isalpha(letter) */
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02002307#define isascii(a) ((unsigned char)(a) <= 0x7f)
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01002308#define isdigit(a) ((unsigned char)((a) - '0') <= 9)
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02002309#define isupper(a) ((unsigned char)((a) - 'A') <= ('Z' - 'A'))
2310#define islower(a) ((unsigned char)((a) - 'a') <= ('z' - 'a'))
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02002311#define isalpha(a) ((unsigned char)(((a)|0x20) - 'a') <= ('z' - 'a'))
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02002312#define isblank(a) ({ unsigned char bb__isblank = (a); bb__isblank == ' ' || bb__isblank == '\t'; })
2313#define iscntrl(a) ({ unsigned char bb__iscntrl = (a); bb__iscntrl < ' ' || bb__iscntrl == 0x7f; })
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02002314/* In POSIX/C locale isspace is only these chars: "\t\n\v\f\r" and space.
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02002315 * "\t\n\v\f\r" happen to have ASCII codes 9,10,11,12,13.
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02002316 */
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02002317#define isspace(a) ({ unsigned char bb__isspace = (a) - 9; bb__isspace == (' ' - 9) || bb__isspace <= (13 - 9); })
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01002318// Unsafe wrt NUL: #define ispunct(a) (strchr("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a)) != NULL)
2319#define ispunct(a) (strchrnul("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a))[0])
2320// 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 +02002321#define isalnum(a) bb_ascii_isalnum(a)
2322static ALWAYS_INLINE int bb_ascii_isalnum(unsigned char a)
2323{
2324 unsigned char b = a - '0';
2325 if (b <= 9)
2326 return (b <= 9);
2327 b = (a|0x20) - 'a';
2328 return b <= 'z' - 'a';
2329}
2330#define isxdigit(a) bb_ascii_isxdigit(a)
2331static ALWAYS_INLINE int bb_ascii_isxdigit(unsigned char a)
2332{
2333 unsigned char b = a - '0';
2334 if (b <= 9)
2335 return (b <= 9);
2336 b = (a|0x20) - 'a';
2337 return b <= 'f' - 'a';
2338}
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02002339#define toupper(a) bb_ascii_toupper(a)
2340static ALWAYS_INLINE unsigned char bb_ascii_toupper(unsigned char a)
2341{
2342 unsigned char b = a - 'a';
2343 if (b <= ('z' - 'a'))
2344 a -= 'a' - 'A';
2345 return a;
2346}
2347#define tolower(a) bb_ascii_tolower(a)
2348static ALWAYS_INLINE unsigned char bb_ascii_tolower(unsigned char a)
2349{
2350 unsigned char b = a - 'A';
2351 if (b <= ('Z' - 'A'))
2352 a += 'a' - 'A';
2353 return a;
2354}
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02002355
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01002356/* In ASCII and Unicode, these are likely to be very different.
2357 * Let's prevent ambiguous usage from the start */
2358#define isgraph(a) isgraph_is_ambiguous_dont_use(a)
2359#define isprint(a) isprint_is_ambiguous_dont_use(a)
2360/* NB: must not treat EOF as isgraph or isprint */
2361#define isgraph_asciionly(a) ((unsigned)((a) - 0x21) <= 0x7e - 0x21)
2362#define isprint_asciionly(a) ((unsigned)((a) - 0x20) <= 0x7e - 0x20)
2363
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02002364
Bartosz Golaszewski3ed81cf2014-06-22 16:30:41 +02002365/* Simple unit-testing framework */
2366
2367typedef void (*bbunit_testfunc)(void);
2368
2369struct bbunit_listelem {
Bartosz Golaszewski3ed81cf2014-06-22 16:30:41 +02002370 const char* name;
2371 bbunit_testfunc testfunc;
2372};
2373
2374void bbunit_registertest(struct bbunit_listelem* test);
2375void bbunit_settestfailed(void);
2376
2377#define BBUNIT_DEFINE_TEST(NAME) \
2378 static void bbunit_##NAME##_test(void); \
2379 static struct bbunit_listelem bbunit_##NAME##_elem = { \
2380 .name = #NAME, \
2381 .testfunc = bbunit_##NAME##_test, \
2382 }; \
Bartosz Golaszewskibf0f2c72014-06-26 14:31:05 +02002383 static void INIT_FUNC bbunit_##NAME##_register(void) \
Bartosz Golaszewski3ed81cf2014-06-22 16:30:41 +02002384 { \
2385 bbunit_registertest(&bbunit_##NAME##_elem); \
2386 } \
2387 static void bbunit_##NAME##_test(void)
2388
2389/*
2390 * Both 'goto bbunit_end' and 'break' are here only to get rid
2391 * of compiler warnings.
2392 */
2393#define BBUNIT_ENDTEST \
2394 do { \
2395 goto bbunit_end; \
2396 bbunit_end: \
2397 break; \
2398 } while (0)
2399
2400#define BBUNIT_PRINTASSERTFAIL \
2401 do { \
2402 bb_error_msg( \
2403 "[ERROR] Assertion failed in file %s, line %d", \
2404 __FILE__, __LINE__); \
2405 } while (0)
2406
2407#define BBUNIT_ASSERTION_FAILED \
2408 do { \
2409 bbunit_settestfailed(); \
2410 goto bbunit_end; \
2411 } while (0)
2412
2413/*
2414 * Assertions.
2415 * For now we only offer assertions which cause tests to fail
2416 * immediately. In the future 'expects' might be added too -
2417 * similar to those offered by the gtest framework.
2418 */
2419#define BBUNIT_ASSERT_EQ(EXPECTED, ACTUAL) \
2420 do { \
2421 if ((EXPECTED) != (ACTUAL)) { \
2422 BBUNIT_PRINTASSERTFAIL; \
2423 bb_error_msg("[ERROR] '%s' isn't equal to '%s'", \
2424 #EXPECTED, #ACTUAL); \
2425 BBUNIT_ASSERTION_FAILED; \
2426 } \
2427 } while (0)
2428
2429#define BBUNIT_ASSERT_NOTEQ(EXPECTED, ACTUAL) \
2430 do { \
2431 if ((EXPECTED) == (ACTUAL)) { \
2432 BBUNIT_PRINTASSERTFAIL; \
2433 bb_error_msg("[ERROR] '%s' is equal to '%s'", \
2434 #EXPECTED, #ACTUAL); \
2435 BBUNIT_ASSERTION_FAILED; \
2436 } \
2437 } while (0)
2438
2439#define BBUNIT_ASSERT_NOTNULL(PTR) \
2440 do { \
2441 if ((PTR) == NULL) { \
2442 BBUNIT_PRINTASSERTFAIL; \
2443 bb_error_msg("[ERROR] '%s' is NULL!", #PTR); \
2444 BBUNIT_ASSERTION_FAILED; \
2445 } \
2446 } while (0)
2447
2448#define BBUNIT_ASSERT_NULL(PTR) \
2449 do { \
2450 if ((PTR) != NULL) { \
2451 BBUNIT_PRINTASSERTFAIL; \
2452 bb_error_msg("[ERROR] '%s' is not NULL!", #PTR); \
2453 BBUNIT_ASSERTION_FAILED; \
2454 } \
2455 } while (0)
2456
2457#define BBUNIT_ASSERT_FALSE(STATEMENT) \
2458 do { \
2459 if ((STATEMENT)) { \
2460 BBUNIT_PRINTASSERTFAIL; \
2461 bb_error_msg("[ERROR] Statement '%s' evaluated to true!", \
2462 #STATEMENT); \
2463 BBUNIT_ASSERTION_FAILED; \
2464 } \
2465 } while (0)
2466
2467#define BBUNIT_ASSERT_TRUE(STATEMENT) \
2468 do { \
2469 if (!(STATEMENT)) { \
2470 BBUNIT_PRINTASSERTFAIL; \
2471 bb_error_msg("[ERROR] Statement '%s' evaluated to false!", \
2472 #STATEMENT); \
2473 BBUNIT_ASSERTION_FAILED; \
2474 } \
2475 } while (0)
2476
2477#define BBUNIT_ASSERT_STREQ(STR1, STR2) \
2478 do { \
2479 if (strcmp(STR1, STR2) != 0) { \
2480 BBUNIT_PRINTASSERTFAIL; \
2481 bb_error_msg("[ERROR] Strings '%s' and '%s' " \
2482 "are not the same", STR1, STR2); \
2483 BBUNIT_ASSERTION_FAILED; \
2484 } \
2485 } while (0)
2486
2487#define BBUNIT_ASSERT_STRNOTEQ(STR1, STR2) \
2488 do { \
2489 if (strcmp(STR1, STR2) == 0) { \
2490 BBUNIT_PRINTASSERTFAIL; \
2491 bb_error_msg("[ERROR] Strings '%s' and '%s' " \
2492 "are the same, but were " \
2493 "expected to differ", STR1, STR2); \
2494 BBUNIT_ASSERTION_FAILED; \
2495 } \
2496 } while (0)
2497
2498
Denis Vlasenkof81e8db2009-04-09 12:35:13 +00002499POP_SAVED_FUNCTION_VISIBILITY
2500
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +00002501#endif