blob: 8b84d13a031e9302b2bfaa47c23a899a883271a2 [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.
Denys Vlasenko5fa5c4b2020-06-23 21:28:19 +0200301 * On musl, !ENABLE_LFS on 32-bit arches thinks that off_t is 32-bit.
Denys Vlasenko1dc80ba2011-11-17 21:51:32 +0100302 * We misdetected that. Don't let it build:
303 */
304struct BUG_off_t_size_is_misdetected {
305 char BUG_off_t_size_is_misdetected[sizeof(off_t) == sizeof(uoff_t) ? 1 : -1];
306};
Denis Vlasenko56254152006-10-07 16:24:46 +0000307
Eric Andersenaad1a882001-03-16 22:47:14 +0000308/* Some useful definitions */
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000309#undef FALSE
Eric Andersenaad1a882001-03-16 22:47:14 +0000310#define FALSE ((int) 0)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000311#undef TRUE
Eric Andersenaad1a882001-03-16 22:47:14 +0000312#define TRUE ((int) 1)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000313#undef SKIP
Eric Andersenaad1a882001-03-16 22:47:14 +0000314#define SKIP ((int) 2)
315
Eric Andersenaad1a882001-03-16 22:47:14 +0000316/* Macros for min/max. */
317#ifndef MIN
Denys Vlasenkoe4dcba12010-10-28 18:57:19 +0200318#define MIN(a,b) (((a)<(b))?(a):(b))
Eric Andersenaad1a882001-03-16 22:47:14 +0000319#endif
320
321#ifndef MAX
Denys Vlasenkoe4dcba12010-10-28 18:57:19 +0200322#define MAX(a,b) (((a)>(b))?(a):(b))
Eric Andersenaad1a882001-03-16 22:47:14 +0000323#endif
324
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000325/* buffer allocation schemes */
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000326#if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000327#define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000328#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
329#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
330#else
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000331#if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000332#define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
333#define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
334#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
335#else
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000336#define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer = xmalloc(len)
337#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
338#define RELEASE_CONFIG_BUFFER(buffer) free(buffer)
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000339#endif
340#endif
341
Denys Vlasenkob1c7a662020-10-01 00:34:44 +0200342#if defined(errno)
343/* If errno is a define, assume it's "define errno (*__errno_location())"
344 * and we will cache it's result in this variable */
Denis Vlasenkofad2b862007-05-31 22:16:38 +0000345extern int *const bb_errno;
346#undef errno
347#define errno (*bb_errno)
Denys Vlasenkob1c7a662020-10-01 00:34:44 +0200348#define bb_cached_errno_ptr 1
Denis Vlasenkofad2b862007-05-31 22:16:38 +0000349#endif
350
Denys Vlasenko9ff50b82010-10-18 11:40:26 +0200351#if !(ULONG_MAX > 0xffffffff)
352/* Only 32-bit CPUs need this, 64-bit ones use inlined version */
353uint64_t bb_bswap_64(uint64_t x) FAST_FUNC;
354#endif
355
Denys Vlasenko8a134ec2017-04-11 07:34:56 +0200356unsigned long FAST_FUNC isqrt(unsigned long long N);
357
Denis Vlasenkoce13b762008-06-29 02:25:53 +0000358unsigned long long monotonic_ns(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000359unsigned long long monotonic_us(void) FAST_FUNC;
Denys Vlasenkof2c8aa62010-01-12 12:52:30 +0100360unsigned long long monotonic_ms(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000361unsigned monotonic_sec(void) FAST_FUNC;
Manuel Novoa III cad53642003-03-19 09:13:01 +0000362
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000363extern void chomp(char *s) FAST_FUNC;
Denys Vlasenko20077c12017-08-05 17:50:35 +0200364extern char *trim(char *s) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000365extern char *skip_whitespace(const char *) FAST_FUNC;
366extern char *skip_non_whitespace(const char *) FAST_FUNC;
Denys Vlasenkof8d8aa12010-04-06 18:50:05 +0200367extern char *skip_dev_pfx(const char *tty_name) FAST_FUNC;
368
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000369extern char *strrstr(const char *haystack, const char *needle) FAST_FUNC;
Paul Fox0b621582005-08-09 19:38:05 +0000370
Denys Vlasenko9a647c32017-01-23 01:08:16 +0100371/* dmalloc will redefine these to it's own implementation. It is safe
372 * to have the prototypes here unconditionally. */
373void *malloc_or_warn(size_t size) FAST_FUNC RETURNS_MALLOC;
374void *xmalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
375void *xzalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
376void *xrealloc(void *old, size_t size) FAST_FUNC;
377/* After v = xrealloc_vector(v, SHIFT, idx) it's ok to use
378 * at least v[idx] and v[idx+1], for all idx values.
379 * SHIFT specifies how many new elements are added (1:2, 2:4, ..., 8:256...)
380 * when all elements are used up. New elements are zeroed out.
381 * xrealloc_vector(v, SHIFT, idx) *MUST* be called with consecutive IDXs -
382 * skipping an index is a bad bug - it may miss a realloc!
383 */
384#define xrealloc_vector(vector, shift, idx) \
385 xrealloc_vector_helper((vector), (sizeof((vector)[0]) << 8) + (shift), (idx))
386void* xrealloc_vector_helper(void *vector, unsigned sizeof_and_shift, int idx) FAST_FUNC;
387char *xstrdup(const char *s) FAST_FUNC RETURNS_MALLOC;
388char *xstrndup(const char *s, int n) FAST_FUNC RETURNS_MALLOC;
389void *xmemdup(const void *s, int n) FAST_FUNC RETURNS_MALLOC;
390
391
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +0000392//TODO: supply a pointer to char[11] buffer (avoid statics)?
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000393extern const char *bb_mode_string(mode_t mode) FAST_FUNC;
Denys Vlasenkof282c6b2011-12-18 03:27:46 +0100394extern int is_directory(const char *name, int followLinks) FAST_FUNC;
Denys Vlasenko877dedb2016-05-27 00:46:38 +0200395enum { /* cp.c, mv.c, install.c depend on these values. CAREFUL when changing them! */
Denys Vlasenkoa40f0622010-01-15 22:05:07 +0100396 FILEUTILS_PRESERVE_STATUS = 1 << 0, /* -p */
397 FILEUTILS_DEREFERENCE = 1 << 1, /* !-d */
398 FILEUTILS_RECUR = 1 << 2, /* -R */
399 FILEUTILS_FORCE = 1 << 3, /* -f */
400 FILEUTILS_INTERACTIVE = 1 << 4, /* -i */
401 FILEUTILS_MAKE_HARDLINK = 1 << 5, /* -l */
402 FILEUTILS_MAKE_SOFTLINK = 1 << 6, /* -s */
403 FILEUTILS_DEREF_SOFTLINK = 1 << 7, /* -L */
404 FILEUTILS_DEREFERENCE_L0 = 1 << 8, /* -H */
Denys Vlasenko877dedb2016-05-27 00:46:38 +0200405 /* -a = -pdR (mapped in cp.c) */
406 /* -r = -dR (mapped in cp.c) */
407 /* -P = -d (mapped in cp.c) */
408 FILEUTILS_VERBOSE = (1 << 12) * ENABLE_FEATURE_VERBOSE, /* -v */
409 FILEUTILS_UPDATE = 1 << 13, /* -u */
Aaro Koskinend15d7a02018-02-01 09:29:05 +0100410 FILEUTILS_NO_TARGET_DIR = 1 << 14, /* -T */
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000411#if ENABLE_SELINUX
Aaro Koskinend15d7a02018-02-01 09:29:05 +0100412 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 1 << 15, /* -c */
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000413#endif
Aaro Koskinend15d7a02018-02-01 09:29:05 +0100414 FILEUTILS_RMDEST = 1 << (16 - !ENABLE_SELINUX), /* --remove-destination */
Denys Vlasenko79fb6ac2018-07-13 20:30:02 +0200415 /* bit 17 skipped for "cp --parents" */
416 FILEUTILS_REFLINK = 1 << (18 - !ENABLE_SELINUX), /* cp --reflink=auto */
417 FILEUTILS_REFLINK_ALWAYS = 1 << (19 - !ENABLE_SELINUX), /* cp --reflink[=always] */
Denys Vlasenko877dedb2016-05-27 00:46:38 +0200418 /*
419 * Hole. cp may have some bits set here,
420 * they should not affect remove_file()/copy_file()
421 */
422#if ENABLE_SELINUX
423 FILEUTILS_SET_SECURITY_CONTEXT = 1 << 30,
424#endif
425 FILEUTILS_IGNORE_CHMOD_ERR = 1 << 31,
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000426};
Aaro Koskinend15d7a02018-02-01 09:29:05 +0100427#define FILEUTILS_CP_OPTSTR "pdRfilsLHarPvuT" IF_SELINUX("c")
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000428extern int remove_file(const char *path, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000429/* NB: without FILEUTILS_RECUR in flags, it will basically "cat"
430 * the source, not copy (unless "source" is a directory).
431 * This makes "cp /dev/null file" and "install /dev/null file" (!!!)
432 * work coreutils-compatibly. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000433extern int copy_file(const char *source, const char *dest, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000434
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000435enum {
Denis Vlasenkod166f832007-07-05 00:12:55 +0000436 ACTION_RECURSE = (1 << 0),
437 ACTION_FOLLOWLINKS = (1 << 1),
438 ACTION_FOLLOWLINKS_L0 = (1 << 2),
439 ACTION_DEPTHFIRST = (1 << 3),
Denys Vlasenko3c3928f2020-10-01 20:27:28 +0200440 ACTION_QUIET = (1 << 4),
441 ACTION_DANGLING_OK = (1 << 5),
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000442};
Denys Vlasenko8f7a6d22009-09-29 11:07:04 +0200443typedef uint8_t recurse_flags_t;
Bernhard Reutner-Fischer3e816c12007-03-29 10:30:50 +0000444extern int recursive_action(const char *fileName, unsigned flags,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000445 int FAST_FUNC (*fileAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
446 int FAST_FUNC (*dirAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
447 void* userData, unsigned depth) FAST_FUNC;
Denys Vlasenko3c3928f2020-10-01 20:27:28 +0200448
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000449extern int device_open(const char *device, int mode) FAST_FUNC;
Denis Vlasenko85c24712008-03-17 09:04:04 +0000450enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000451extern int xgetpty(char *line) FAST_FUNC;
Denis Vlasenko2afd5ab2008-08-05 23:32:27 +0000452extern int get_console_fd_or_die(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000453extern void console_make_active(int fd, const int vt_num) FAST_FUNC;
454extern char *find_block_device(const char *path) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000455/* bb_copyfd_XX print read/write errors and return -1 if they occur */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000456extern off_t bb_copyfd_eof(int fd1, int fd2) FAST_FUNC;
457extern off_t bb_copyfd_size(int fd1, int fd2, off_t size) FAST_FUNC;
458extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000459/* "short" copy can be detected by return value < size */
460/* this helper yells "short read!" if param is not -1 */
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000461extern void complain_copyfd_and_die(off_t sz) NORETURN FAST_FUNC;
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +0200462
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000463extern char bb_process_escape_sequence(const char **ptr) FAST_FUNC;
Denys Vlasenko53600592010-10-23 21:06:06 +0200464char* strcpy_and_process_escape_sequences(char *dst, const char *src) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000465/* xxxx_strip version can modify its parameter:
466 * "/" -> "/"
467 * "abc" -> "abc"
468 * "abc/def" -> "def"
469 * "abc/def/" -> "def" !!
470 */
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +0200471char *bb_get_last_path_component_strip(char *path) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000472/* "abc/def/" -> "" and it never modifies 'path' */
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +0200473char *bb_get_last_path_component_nostrip(const char *path) FAST_FUNC;
474/* Simpler version: does not special case "/" string */
475const char *bb_basename(const char *name) FAST_FUNC;
476/* NB: can violate const-ness (similarly to strchr) */
477char *last_char_is(const char *s, int c) FAST_FUNC;
Denys Vlasenko1961aea2013-02-26 00:36:53 +0100478const char* endofname(const char *name) FAST_FUNC;
Denys Vlasenko8dff01d2015-03-12 17:48:34 +0100479char *is_prefixed_with(const char *string, const char *key) FAST_FUNC;
Bartosz Golaszewski7448b512015-08-25 16:36:43 +0200480char *is_suffixed_with(const char *string, const char *key) FAST_FUNC;
Denis Vlasenkocad04ef2007-03-25 23:21:05 +0000481
Denys Vlasenkod6e76722014-09-22 21:14:02 +0200482int ndelay_on(int fd) FAST_FUNC;
483int ndelay_off(int fd) FAST_FUNC;
Denys Vlasenkoe9a40e32011-01-24 00:29:55 +0100484void close_on_exec_on(int fd) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000485void xdup2(int, int) FAST_FUNC;
486void xmove_fd(int, int) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000487
488
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000489DIR *xopendir(const char *path) FAST_FUNC;
490DIR *warn_opendir(const char *path) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000491
Jérémie Koenigfbedacf2010-03-26 19:08:53 +0100492char *xmalloc_realpath(const char *path) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko74716212018-05-24 17:29:14 +0200493char *xmalloc_realpath_coreutils(const char *path) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100494char *xmalloc_readlink(const char *path) FAST_FUNC RETURNS_MALLOC;
495char *xmalloc_readlink_or_warn(const char *path) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkob57eee82009-11-04 17:54:17 +0100496/* !RETURNS_MALLOC: it's a realloc-like function */
497char *xrealloc_getcwd_or_warn(char *cwd) FAST_FUNC;
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000498
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100499char *xmalloc_follow_symlinks(const char *path) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko473dae02007-04-11 07:04:23 +0000500
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000501
Denis Vlasenko33196372008-02-23 01:25:38 +0000502enum {
Denis Vlasenkocf7cf622008-03-19 19:38:46 +0000503 /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
Denis Vlasenko33196372008-02-23 01:25:38 +0000504 * otherwise would kill us, except for those resulting from bugs:
505 * SIGSEGV, SIGILL, SIGFPE.
506 * Other fatal signals not included (TODO?):
507 * SIGBUS Bus error (bad memory access)
508 * SIGPOLL Pollable event. Synonym of SIGIO
509 * SIGPROF Profiling timer expired
510 * SIGSYS Bad argument to routine
511 * SIGTRAP Trace/breakpoint trap
Denis Vlasenkod943af02008-03-30 15:56:38 +0000512 *
513 * The only known arch with some of these sigs not fitting
514 * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
515 * Dance around with long long to guard against that...
Denis Vlasenko33196372008-02-23 01:25:38 +0000516 */
Denis Vlasenkod943af02008-03-30 15:56:38 +0000517 BB_FATAL_SIGS = (int)(0
518 + (1LL << SIGHUP)
519 + (1LL << SIGINT)
520 + (1LL << SIGTERM)
521 + (1LL << SIGPIPE) // Write to pipe with no readers
522 + (1LL << SIGQUIT) // Quit from keyboard
523 + (1LL << SIGABRT) // Abort signal from abort(3)
524 + (1LL << SIGALRM) // Timer signal from alarm(2)
525 + (1LL << SIGVTALRM) // Virtual alarm clock
526 + (1LL << SIGXCPU) // CPU time limit exceeded
527 + (1LL << SIGXFSZ) // File size limit exceeded
528 + (1LL << SIGUSR1) // Yes kids, these are also fatal!
529 + (1LL << SIGUSR2)
530 + 0),
Denis Vlasenko33196372008-02-23 01:25:38 +0000531};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000532void bb_signals(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko25591c32008-02-16 22:58:56 +0000533/* Unlike signal() and bb_signals, sets handler with sigaction()
534 * and in a way that while signal handler is run, no other signals
Denis Vlasenkocab28aa2009-01-31 01:02:07 +0000535 * will be blocked; syscalls will not be restarted: */
536void bb_signals_recursive_norestart(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000537/* syscalls like read() will be interrupted with EINTR: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000538void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000539/* syscalls like read() won't be interrupted (though select/poll will be): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000540void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
541void wait_for_any_sig(void) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000542void kill_myself_with_sig(int sig) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000543void sig_block(int sig) FAST_FUNC;
544void sig_unblock(int sig) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000545/* Will do sigaction(signum, act, NULL): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000546int sigaction_set(int sig, const struct sigaction *act) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000547/* SIG_BLOCK/SIG_UNBLOCK all signals: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000548int sigprocmask_allsigs(int how) FAST_FUNC;
Denys Vlasenkob437df12018-12-08 15:35:24 +0100549/* Return old set in the same set: */
550int sigprocmask2(int how, sigset_t *set) FAST_FUNC;
Denis Vlasenko08ea11a2008-09-11 19:51:11 +0000551/* Standard handler which just records signo */
552extern smallint bb_got_signal;
553void record_signo(int signo); /* not FAST_FUNC! */
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000554
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000555
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000556void xsetgid(gid_t gid) FAST_FUNC;
557void xsetuid(uid_t uid) FAST_FUNC;
Ryan Mallon5906a5c2013-10-08 14:52:49 +0200558void xsetegid(gid_t egid) FAST_FUNC;
559void xseteuid(uid_t euid) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000560void xchdir(const char *path) FAST_FUNC;
Denys Vlasenkoc4199f22016-04-01 22:12:44 +0200561void xfchdir(int fd) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000562void xchroot(const char *path) FAST_FUNC;
563void xsetenv(const char *key, const char *value) FAST_FUNC;
Denis Vlasenko76ddc2e2008-12-30 05:05:31 +0000564void bb_unsetenv(const char *key) FAST_FUNC;
Denys Vlasenkodd8adde2010-06-24 05:00:50 +0200565void bb_unsetenv_and_free(char *key) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000566void xunlink(const char *pathname) FAST_FUNC;
567void xstat(const char *pathname, struct stat *buf) FAST_FUNC;
Denys Vlasenko8d3e2252010-08-31 12:42:06 +0200568void xfstat(int fd, struct stat *buf, const char *errmsg) FAST_FUNC;
Ryan Mallon5906a5c2013-10-08 14:52:49 +0200569int open3_or_warn(const char *pathname, int flags, int mode) FAST_FUNC;
570int open_or_warn(const char *pathname, int flags) FAST_FUNC;
571int xopen3(const char *pathname, int flags, int mode) FAST_FUNC;
Denys Vlasenkof2a8d5d2009-08-21 17:40:36 +0200572int xopen(const char *pathname, int flags) FAST_FUNC;
Bernhard Reutner-Fischera4830872009-10-26 23:27:08 +0100573int xopen_nonblocking(const char *pathname) FAST_FUNC;
Ryan Mallon5906a5c2013-10-08 14:52:49 +0200574int xopen_as_uid_gid(const char *pathname, int flags, uid_t u, gid_t g) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000575int open_or_warn_stdin(const char *pathname) FAST_FUNC;
Denys Vlasenkoe7b0a9e2010-08-22 05:39:15 +0200576int xopen_stdin(const char *pathname) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000577void xrename(const char *oldpath, const char *newpath) FAST_FUNC;
578int rename_or_warn(const char *oldpath, const char *newpath) FAST_FUNC;
579off_t xlseek(int fd, off_t offset, int whence) FAST_FUNC;
Alexander Shishkin67227372010-10-22 13:27:16 +0200580int xmkstemp(char *template) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000581off_t fdlength(int fd) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000582
Denys Vlasenko40e7d252010-02-01 23:48:27 +0100583uoff_t FAST_FUNC get_volume_size_in_bytes(int fd,
Denys Vlasenko982e87f2013-07-30 11:52:58 +0200584 const char *override,
585 unsigned override_units,
586 int extend);
Denys Vlasenko40e7d252010-02-01 23:48:27 +0100587
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000588void xpipe(int filedes[2]) FAST_FUNC;
Denis Vlasenko37188322008-02-16 13:20:56 +0000589/* In this form code with pipes is much more readable */
590struct fd_pair { int rd; int wr; };
591#define piped_pair(pair) pipe(&((pair).rd))
592#define xpiped_pair(pair) xpipe(&((pair).rd))
593
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000594/* Useful for having small structure members/global variables */
595typedef int8_t socktype_t;
596typedef int8_t family_t;
597struct BUG_too_small {
598 char BUG_socktype_t_too_small[(0
599 | SOCK_STREAM
600 | SOCK_DGRAM
601 | SOCK_RDM
602 | SOCK_SEQPACKET
603 | SOCK_RAW
604 ) <= 127 ? 1 : -1];
605 char BUG_family_t_too_small[(0
606 | AF_UNSPEC
607 | AF_INET
608 | AF_INET6
609 | AF_UNIX
Mike Frysinger9412ec72008-02-07 22:41:33 +0000610#ifdef AF_PACKET
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000611 | AF_PACKET
Mike Frysinger9412ec72008-02-07 22:41:33 +0000612#endif
613#ifdef AF_NETLINK
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000614 | AF_NETLINK
Mike Frysinger9412ec72008-02-07 22:41:33 +0000615#endif
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000616 /* | AF_DECnet */
617 /* | AF_IPX */
618 ) <= 127 ? 1 : -1];
619};
620
621
Denys Vlasenkodc698bb2010-01-09 19:10:49 +0100622void parse_datestr(const char *date_str, struct tm *ptm) FAST_FUNC;
623time_t validate_tm_time(const char *date_str, struct tm *ptm) FAST_FUNC;
Denys Vlasenko8f2cb7a2013-03-29 12:30:33 +0100624char *strftime_HHMMSS(char *buf, unsigned len, time_t *tp) FAST_FUNC;
625char *strftime_YYYYMMDDHHMMSS(char *buf, unsigned len, time_t *tp) FAST_FUNC;
Denys Vlasenko73b71f32009-07-18 03:40:35 +0200626
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000627int xsocket(int domain, int type, int protocol) FAST_FUNC;
628void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen) FAST_FUNC;
629void xlisten(int s, int backlog) FAST_FUNC;
630void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen) FAST_FUNC;
Denis Vlasenkodbe6e662007-08-14 16:43:01 +0000631ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000632 socklen_t tolen) FAST_FUNC;
Denys Vlasenkoc52cbea2015-08-24 19:48:03 +0200633
634int setsockopt_int(int fd, int level, int optname, int optval) FAST_FUNC;
635int setsockopt_1(int fd, int level, int optname) FAST_FUNC;
636int setsockopt_SOL_SOCKET_int(int fd, int optname, int optval) FAST_FUNC;
637int setsockopt_SOL_SOCKET_1(int fd, int optname) FAST_FUNC;
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000638/* SO_REUSEADDR allows a server to rebind to an address that is already
639 * "in use" by old connections to e.g. previous server instance which is
640 * killed or crashed. Without it bind will fail until all such connections
641 * time out. Linux does not allow multiple live binds on same ip:port
642 * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
643 * Turn it on before you call bind(). */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000644void setsockopt_reuseaddr(int fd) FAST_FUNC; /* On Linux this never fails. */
Denys Vlasenkoc52cbea2015-08-24 19:48:03 +0200645int setsockopt_keepalive(int fd) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000646int setsockopt_broadcast(int fd) FAST_FUNC;
Denis Vlasenkoe5373852008-12-10 11:12:16 +0000647int setsockopt_bindtodevice(int fd, const char *iface) FAST_FUNC;
Denys Vlasenkoba3b9db2018-02-11 14:55:46 +0100648int bb_getsockname(int sockfd, void *addr, socklen_t addrlen) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000649/* NB: returns port in host byte order */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000650unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port) FAST_FUNC;
Denys Vlasenko2aeb2012018-04-17 12:43:54 +0200651#if ENABLE_FEATURE_ETC_SERVICES
652# define bb_lookup_std_port(portstr, protocol, portnum) bb_lookup_port(portstr, protocol, portnum)
653#else
654# define bb_lookup_std_port(portstr, protocol, portnum) (portnum)
655#endif
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000656typedef struct len_and_sockaddr {
Denis Vlasenko0850cda2007-02-07 23:20:32 +0000657 socklen_t len;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000658 union {
659 struct sockaddr sa;
660 struct sockaddr_in sin;
661#if ENABLE_FEATURE_IPV6
662 struct sockaddr_in6 sin6;
663#endif
Bernhard Reutner-Fischer8c69afd2008-01-29 10:33:34 +0000664 } u;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000665} len_and_sockaddr;
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000666enum {
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000667 LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000668 LSA_SIZEOF_SA = sizeof(
669 union {
670 struct sockaddr sa;
671 struct sockaddr_in sin;
672#if ENABLE_FEATURE_IPV6
673 struct sockaddr_in6 sin6;
674#endif
675 }
676 )
677};
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000678/* Create stream socket, and allocate suitable lsa.
679 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
Denis Vlasenkobeffd432007-09-05 11:30:34 +0000680 * af == AF_UNSPEC will result in trying to create IPv6 socket,
Denys Vlasenkob1278a32009-11-24 16:03:47 +0100681 * and if kernel doesn't support it, fall back to IPv4.
682 * This is useful if you plan to bind to resulting local lsa.
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000683 */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000684int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000685int xsocket_stream(len_and_sockaddr **lsap) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000686/* Create server socket bound to bindaddr:port. bindaddr can be NULL,
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000687 * numeric IP ("N.N.N.N") or numeric IPv6 address,
688 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000689 * Only if there is no suffix, port argument is used */
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000690/* NB: these set SO_REUSEADDR before bind */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000691int create_and_bind_stream_or_die(const char *bindaddr, int port) FAST_FUNC;
692int create_and_bind_dgram_or_die(const char *bindaddr, int port) FAST_FUNC;
Denys Vlasenko45e39672019-06-03 14:16:52 +0200693int create_and_bind_to_netlink(int proto, int grp, unsigned rcvbuf) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000694/* Create client TCP socket connected to peer:port. Peer cannot be NULL.
695 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
696 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
697 * If there is no suffix, port argument is used */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000698int create_and_connect_stream_or_die(const char *peer, int port) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000699/* Connect to peer identified by lsa */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000700int xconnect_stream(const len_and_sockaddr *lsa) FAST_FUNC;
Denis Vlasenko73c571a2009-03-09 00:12:37 +0000701/* Get local address of bound or accepted socket */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100702len_and_sockaddr *get_sock_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkof6916db2010-04-06 17:43:29 +0200703/* Get remote address of connected or accepted socket */
704len_and_sockaddr *get_peer_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000705/* Return malloc'ed len_and_sockaddr with socket address of host:port
706 * Currently will return IPv4 or IPv6 sockaddrs only
707 * (depending on host), but in theory nothing prevents e.g.
Denis Vlasenko5870ad92007-02-04 02:39:55 +0000708 * UNIX socket address being returned, IPX sockaddr etc...
709 * On error does bb_error_msg and returns NULL */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100710len_and_sockaddr* host2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000711/* Version which dies on error */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100712len_and_sockaddr* xhost2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
713len_and_sockaddr* xdotted2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000714/* Same, useful if you want to force family (e.g. IPv6) */
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000715#if !ENABLE_FEATURE_IPV6
716#define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
717#define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
718#else
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100719len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
720len_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 +0000721#endif
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000722/* Assign sin[6]_port member if the socket is an AF_INET[6] one,
Denis Vlasenko85629f02007-01-22 09:36:41 +0000723 * otherwise no-op. Useful for ftp.
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000724 * NB: does NOT do htons() internally, just direct assignment. */
Denys Vlasenkoca183112011-04-07 17:52:20 +0200725void set_nport(struct sockaddr *sa, unsigned port) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000726/* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000727int get_nport(const struct sockaddr *sa) FAST_FUNC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000728/* Reverse DNS. Returns NULL on failure. */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100729char* xmalloc_sockaddr2host(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000730/* This one doesn't append :PORTNUM */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100731char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000732/* This one also doesn't fall back to dotted IP (returns NULL) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100733char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko448f0242007-01-22 22:43:05 +0000734/* inet_[ap]ton on steroids */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100735char* xmalloc_sockaddr2dotted(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
736char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000737// "old" (ipv4 only) API
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000738// users: traceroute.c hostname.c - use _list_ of all IPs
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000739struct hostent *xgethostbyname(const char *name) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000740// Also mount.c and inetd.c are using gethostbyname(),
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000741// + inet_common.c has additional IPv4-only stuff
Denis Vlasenkoc8717cd2006-11-22 16:10:39 +0000742
Denys Vlasenko49ecee02017-01-24 16:00:54 +0100743
Denys Vlasenko83e5c622018-11-23 17:21:38 +0100744struct tls_aes {
745 uint32_t key[60];
746 unsigned rounds;
747};
Denys Vlasenko49ecee02017-01-24 16:00:54 +0100748#define TLS_MAX_MAC_SIZE 32
749#define TLS_MAX_KEY_SIZE 32
Denys Vlasenko83e5c622018-11-23 17:21:38 +0100750#define TLS_MAX_IV_SIZE 4
Denys Vlasenko9a647c32017-01-23 01:08:16 +0100751struct tls_handshake_data; /* opaque */
752typedef struct tls_state {
Denys Vlasenko83e5c622018-11-23 17:21:38 +0100753 unsigned flags;
754
Denys Vlasenko49ecee02017-01-24 16:00:54 +0100755 int ofd;
756 int ifd;
Denys Vlasenko9a647c32017-01-23 01:08:16 +0100757
Denys Vlasenko89193f92017-01-24 18:08:07 +0100758 unsigned min_encrypted_len_on_read;
Denys Vlasenko49ecee02017-01-24 16:00:54 +0100759 uint16_t cipher_id;
Denys Vlasenko49ecee02017-01-24 16:00:54 +0100760 unsigned MAC_size;
761 unsigned key_size;
Denys Vlasenko83e5c622018-11-23 17:21:38 +0100762 unsigned IV_size;
Denys Vlasenko9a647c32017-01-23 01:08:16 +0100763
764 uint8_t *outbuf;
765 int outbuf_size;
766
767 int inbuf_size;
768 int ofs_to_buffered;
769 int buffered_size;
770 uint8_t *inbuf;
771
772 struct tls_handshake_data *hsd;
773
774 // RFC 5246
775 // sequence number
776 // Each connection state contains a sequence number, which is
777 // maintained separately for read and write states. The sequence
778 // number MUST be set to zero whenever a connection state is made the
779 // active state. Sequence numbers are of type uint64 and may not
780 // exceed 2^64-1.
781 /*uint64_t read_seq64_be;*/
782 uint64_t write_seq64_be;
783
Denys Vlasenko83e5c622018-11-23 17:21:38 +0100784 /*uint8_t *server_write_MAC_key;*/
Denys Vlasenko49ecee02017-01-24 16:00:54 +0100785 uint8_t *client_write_key;
786 uint8_t *server_write_key;
Denys Vlasenko83e5c622018-11-23 17:21:38 +0100787 uint8_t *client_write_IV;
788 uint8_t *server_write_IV;
Denys Vlasenko49ecee02017-01-24 16:00:54 +0100789 uint8_t client_write_MAC_key[TLS_MAX_MAC_SIZE];
790 uint8_t server_write_MAC_k__[TLS_MAX_MAC_SIZE];
791 uint8_t client_write_k__[TLS_MAX_KEY_SIZE];
792 uint8_t server_write_k__[TLS_MAX_KEY_SIZE];
Denys Vlasenko83e5c622018-11-23 17:21:38 +0100793 uint8_t client_write_I_[TLS_MAX_IV_SIZE];
794 uint8_t server_write_I_[TLS_MAX_IV_SIZE];
795
796 struct tls_aes aes_encrypt;
797 struct tls_aes aes_decrypt;
798 uint8_t H[16]; //used by AES_GCM
Denys Vlasenko9a647c32017-01-23 01:08:16 +0100799} tls_state_t;
800
801static inline tls_state_t *new_tls_state(void)
802{
803 tls_state_t *tls = xzalloc(sizeof(*tls));
804 return tls;
805}
806void tls_handshake(tls_state_t *tls, const char *sni) FAST_FUNC;
Denys Vlasenko403f2992018-02-06 15:15:08 +0100807#define TLSLOOP_EXIT_ON_LOCAL_EOF (1 << 0)
808void tls_run_copy_loop(tls_state_t *tls, unsigned flags) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000809
Denys Vlasenko49ecee02017-01-24 16:00:54 +0100810
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000811void socket_want_pktinfo(int fd) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000812ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000813 const struct sockaddr *to,
814 const struct sockaddr *from,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000815 socklen_t tolen) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000816ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000817 struct sockaddr *from,
818 struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000819 socklen_t sa_size) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000820
Denys Vlasenko4a0eb032020-10-01 03:07:22 +0200821uint16_t inet_cksum(const void *addr, int len) FAST_FUNC;
Denys Vlasenko1783ffa2018-02-06 15:48:12 +0100822int parse_pasv_epsv(char *buf) FAST_FUNC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100823
Denys Vlasenkod4e4fdb2017-07-03 21:31:16 +0200824/* 0 if argv[0] is NULL: */
825unsigned string_array_len(char **argv) FAST_FUNC;
Denis Vlasenko0f293b92008-07-22 20:16:55 +0000826void overlapping_strcpy(char *dst, const char *src) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000827char *safe_strncpy(char *dst, const char *src, size_t size) FAST_FUNC;
Denis Vlasenko360d9662008-12-02 18:18:50 +0000828char *strncpy_IFNAMSIZ(char *dst, const char *src) FAST_FUNC;
Denys Vlasenko6f068902014-02-27 11:17:06 +0100829unsigned count_strstr(const char *str, const char *sub) FAST_FUNC;
830char *xmalloc_substitute_string(const char *src, int count, const char *sub, const char *repl) FAST_FUNC;
Denis Vlasenko4daad902007-09-27 10:20:47 +0000831/* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
Denis Vlasenko7c654ae2007-09-27 10:26:59 +0000832 * But potentially slow, don't use in one-billion-times loops */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000833int bb_putchar(int ch) FAST_FUNC;
Denys Vlasenko19ced5c2010-06-06 21:53:09 +0200834/* Note: does not use stdio, writes to fd 2 directly */
835int bb_putchar_stderr(char ch) FAST_FUNC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100836char *xasprintf(const char *format, ...) __attribute__ ((format(printf, 1, 2))) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkoe52da552015-10-09 17:59:56 +0200837char *auto_string(char *str) FAST_FUNC;
Denis Vlasenko9f739442006-12-16 23:49:13 +0000838// gcc-4.1.1 still isn't good enough at optimizing it
839// (+200 bytes compared to macro)
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000840//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000841//int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000842//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000843//int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000844#define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
Denis Vlasenko9f739442006-12-16 23:49:13 +0000845#define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000846#define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
Denis Vlasenkobf66fbc2006-12-21 13:23:14 +0000847#define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
Denis Vlasenko16abcd92007-04-13 23:59:52 +0000848#define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000849
Denys Vlasenkod8528b82010-01-31 05:15:38 +0100850typedef struct uni_stat_t {
851 unsigned byte_count;
852 unsigned unicode_count;
853 unsigned unicode_width;
854} uni_stat_t;
855/* Returns a string with unprintable chars replaced by '?' or
856 * SUBST_WCHAR. This function is unicode-aware. */
Denys Vlasenko349d72c2018-09-30 16:56:56 +0200857const char* FAST_FUNC printable_string(const char *str);
858const char* FAST_FUNC printable_string2(uni_stat_t *stats, const char *str);
Denys Vlasenkod8528b82010-01-31 05:15:38 +0100859/* Prints unprintable char ch as ^C or M-c to file
860 * (M-c is used only if ch is ORed with PRINTABLE_META),
861 * else it is printed as-is (except for ch = 0x9b) */
862enum { PRINTABLE_META = 0x100 };
863void fputc_printable(int ch, FILE *file) FAST_FUNC;
Bartosz Golaszewski79c618c2013-07-30 06:29:42 +0200864/* Return a string that is the printable representation of character ch.
865 * Buffer must hold at least four characters. */
Denys Vlasenkobfa6ed12013-07-30 11:41:58 +0200866enum {
867 VISIBLE_ENDLINE = 1 << 0,
868 VISIBLE_SHOW_TABS = 1 << 1,
869};
Bartosz Golaszewski79c618c2013-07-30 06:29:42 +0200870void visible(unsigned ch, char *buf, int flags) FAST_FUNC;
Denys Vlasenkod8528b82010-01-31 05:15:38 +0100871
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000872extern ssize_t safe_read(int fd, void *buf, size_t count) FAST_FUNC;
Ron Yorston61d6ae22015-04-19 10:50:25 +0100873extern ssize_t nonblock_immune_read(int fd, void *buf, size_t count) FAST_FUNC;
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000874// NB: will return short read on error, not -1,
875// if some data was read before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000876extern ssize_t full_read(int fd, void *buf, size_t count) FAST_FUNC;
877extern void xread(int fd, void *buf, size_t count) FAST_FUNC;
878extern unsigned char xread_char(int fd) FAST_FUNC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000879extern ssize_t read_close(int fd, void *buf, size_t maxsz) FAST_FUNC;
880extern ssize_t open_read_close(const char *filename, void *buf, size_t maxsz) FAST_FUNC;
Denis Vlasenko8ee649a2008-03-26 20:04:27 +0000881// Reads one line a-la fgets (but doesn't save terminating '\n').
882// Reads byte-by-byte. Useful when it is important to not read ahead.
Denis Vlasenkoe376d452008-02-20 22:23:24 +0000883// Bytes are appended to pfx (which must be malloced, or NULL).
Denys Vlasenko80c5b682011-05-08 21:21:10 +0200884extern char *xmalloc_reads(int fd, size_t *maxsz_p) FAST_FUNC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000885/* Reads block up to *maxsz_p (default: INT_MAX - 4095) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100886extern void *xmalloc_read(int fd, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkodff2bd72019-05-24 17:03:28 +0200887extern 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 +0000888/* Returns NULL if file can't be opened (default max size: INT_MAX - 4095) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100889extern void *xmalloc_open_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko094cc512011-01-17 14:58:27 +0100890/* Never returns NULL */
891extern void *xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko59655072012-03-06 16:23:50 +0100892
Denys Vlasenko04c14172014-11-26 15:17:59 +0100893#if defined(ARG_MAX) && (ARG_MAX >= 60*1024 || !defined(_SC_ARG_MAX))
894/* Use _constant_ maximum if: defined && (big enough || no variable one exists) */
Denys Vlasenkof92f1d02014-06-22 13:54:40 +0200895# define bb_arg_max() ((unsigned)ARG_MAX)
Denys Vlasenko04c14172014-11-26 15:17:59 +0100896#elif defined(_SC_ARG_MAX)
897/* Else use variable one (a bit more expensive) */
Denys Vlasenkof92f1d02014-06-22 13:54:40 +0200898unsigned bb_arg_max(void) FAST_FUNC;
899#else
Denys Vlasenko04c14172014-11-26 15:17:59 +0100900/* If all else fails */
Denys Vlasenkof92f1d02014-06-22 13:54:40 +0200901# define bb_arg_max() ((unsigned)(32 * 1024))
902#endif
Bartosz Golaszewski5d2e4092014-06-22 14:01:13 +0200903unsigned bb_clk_tck(void) FAST_FUNC;
Denys Vlasenkof92f1d02014-06-22 13:54:40 +0200904
Denys Vlasenko59655072012-03-06 16:23:50 +0100905#define SEAMLESS_COMPRESSION (0 \
906 || ENABLE_FEATURE_SEAMLESS_XZ \
907 || ENABLE_FEATURE_SEAMLESS_LZMA \
908 || ENABLE_FEATURE_SEAMLESS_BZ2 \
909 || ENABLE_FEATURE_SEAMLESS_GZ \
910 || ENABLE_FEATURE_SEAMLESS_Z)
911
Denys Vlasenko8a6a2f92012-03-06 16:27:48 +0100912#if SEAMLESS_COMPRESSION
Denys Vlasenko27653ad2010-05-06 14:19:19 +0000913/* Autodetects gzip/bzip2 formats. fd may be in the middle of the file! */
Denys Vlasenko0cf64c82017-08-10 10:35:08 +0200914int setup_unzip_on_fd(int fd, int fail_if_not_compressed) FAST_FUNC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000915/* Autodetects .gz etc */
Denys Vlasenko640ce3d2014-02-02 02:06:38 +0100916extern int open_zipped(const char *fname, int fail_if_not_compressed) FAST_FUNC;
Denys Vlasenkob4c11c12014-12-07 00:44:00 +0100917extern void *xmalloc_open_zipped_read_close(const char *fname, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko8a6a2f92012-03-06 16:27:48 +0100918#else
919# define setup_unzip_on_fd(...) (0)
Denys Vlasenko640ce3d2014-02-02 02:06:38 +0100920# define open_zipped(fname, fail_if_not_compressed) open((fname), O_RDONLY);
Denys Vlasenkob4c11c12014-12-07 00:44:00 +0100921# define xmalloc_open_zipped_read_close(fname, maxsz_p) xmalloc_open_read_close((fname), (maxsz_p))
Denys Vlasenko8a6a2f92012-03-06 16:27:48 +0100922#endif
Denys Vlasenko0cf64c82017-08-10 10:35:08 +0200923/* lzma has no signature, need a little helper. NB: exist only for ENABLE_FEATURE_SEAMLESS_LZMA=y */
924void setup_lzma_on_fd(int fd) FAST_FUNC;
Denis Vlasenkoea620772006-10-14 02:23:43 +0000925
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000926extern ssize_t safe_write(int fd, const void *buf, size_t count) FAST_FUNC;
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000927// NB: will return short write on error, not -1,
928// if some data was written before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000929extern ssize_t full_write(int fd, const void *buf, size_t count) FAST_FUNC;
930extern void xwrite(int fd, const void *buf, size_t count) FAST_FUNC;
Denis Vlasenko73c571a2009-03-09 00:12:37 +0000931extern void xwrite_str(int fd, const char *str) FAST_FUNC;
Denys Vlasenko729ecb82010-06-07 14:14:26 +0200932extern ssize_t full_write1_str(const char *str) FAST_FUNC;
933extern ssize_t full_write2_str(const char *str) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000934extern void xopen_xwrite_close(const char* file, const char *str) FAST_FUNC;
Denis Vlasenkoea620772006-10-14 02:23:43 +0000935
Denys Vlasenkodcd27ab2009-10-05 03:03:07 +0200936/* Close fd, but check for failures (some types of write errors) */
937extern void xclose(int fd) FAST_FUNC;
938
Denis Vlasenko1de08302006-10-26 23:32:43 +0000939/* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000940extern void xprint_and_close_file(FILE *file) FAST_FUNC;
Denis Vlasenko2132e022008-07-15 10:33:12 +0000941
Denys Vlasenkoa1a44832011-06-17 03:37:43 +0200942/* Reads a line from a text file, up to a newline or NUL byte, inclusive.
943 * Returns malloc'ed char*. If end is NULL '\n' isn't considered
944 * end of line. If end isn't NULL, length of the chunk is stored in it.
945 * Returns NULL if EOF/error.
946 */
Quentin Rameaue2afae62018-04-01 19:49:58 +0200947extern char *bb_get_chunk_from_file(FILE *file, size_t *end) FAST_FUNC;
Denis Vlasenkoabee3d02007-12-26 20:44:45 +0000948/* Reads up to (and including) TERMINATING_STRING: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100949extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000950/* Same, with limited max size, and returns the length (excluding NUL): */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100951extern 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 +0000952/* Chops off TERMINATING_STRING from the end: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100953extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000954/* Reads up to (and including) "\n" or NUL byte: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100955extern char *xmalloc_fgets(FILE *file) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000956/* Chops off '\n' from the end, unlike fgets: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100957extern char *xmalloc_fgetline(FILE *file) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko2132e022008-07-15 10:33:12 +0000958/* Same, but doesn't try to conserve space (may have some slack after the end) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100959/* extern char *xmalloc_fgetline_fast(FILE *file) FAST_FUNC RETURNS_MALLOC; */
Denis Vlasenko2132e022008-07-15 10:33:12 +0000960
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100961void die_if_ferror(FILE *file, const char *msg) FAST_FUNC;
962void die_if_ferror_stdout(void) FAST_FUNC;
963int fflush_all(void) FAST_FUNC;
964void fflush_stdout_and_exit(int retval) NORETURN FAST_FUNC;
965int fclose_if_not_stdin(FILE *file) FAST_FUNC;
966FILE* xfopen(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000967/* Prints warning to stderr and returns NULL on failure: */
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100968FILE* fopen_or_warn(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000969/* "Opens" stdin if filename is special, else just opens file: */
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100970FILE* xfopen_stdin(const char *filename) FAST_FUNC;
971FILE* fopen_or_warn_stdin(const char *filename) FAST_FUNC;
972FILE* fopen_for_read(const char *path) FAST_FUNC;
973FILE* xfopen_for_read(const char *path) FAST_FUNC;
974FILE* fopen_for_write(const char *path) FAST_FUNC;
975FILE* xfopen_for_write(const char *path) FAST_FUNC;
976FILE* xfdopen_for_read(int fd) FAST_FUNC;
977FILE* xfdopen_for_write(int fd) FAST_FUNC;
Eric Andersen8876fb22003-06-20 09:01:58 +0000978
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000979int bb_pstrcmp(const void *a, const void *b) /* not FAST_FUNC! */;
980void qsort_string_vector(char **sv, unsigned count) FAST_FUNC;
Denis Vlasenkofb290382008-03-02 12:51:26 +0000981
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000982/* Wrapper which restarts poll on EINTR or ENOMEM.
983 * On other errors complains [perror("poll")] and returns.
984 * Warning! May take (much) longer than timeout_ms to return!
985 * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000986int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms) FAST_FUNC;
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000987
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000988char *safe_gethostname(void) FAST_FUNC;
Denis Vlasenko6f1713f2008-02-25 23:23:58 +0000989
Bernhard Reutner-Fischer8b1fab22007-04-10 09:38:07 +0000990/* Convert each alpha char in str to lower-case */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000991char* str_tolower(char *str) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000992
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000993char *utoa(unsigned n) FAST_FUNC;
994char *itoa(int n) FAST_FUNC;
Denis Vlasenko10457b92007-03-27 22:01:31 +0000995/* Returns a pointer past the formatted number, does NOT null-terminate */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000996char *utoa_to_buf(unsigned n, char *buf, unsigned buflen) FAST_FUNC;
997char *itoa_to_buf(int n, char *buf, unsigned buflen) FAST_FUNC;
Denis Vlasenko56ea65c2008-01-06 03:26:53 +0000998/* Intelligent formatters of bignums */
Denys Vlasenkoa407cf72013-09-06 12:53:14 +0200999char *smart_ulltoa4(unsigned long long ul, char buf[4], const char *scale) FAST_FUNC;
1000char *smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
Denys Vlasenko0bf44d02009-10-13 01:25:09 +02001001/* If block_size == 0, display size without fractional part,
1002 * else display (size * block_size) with one decimal digit.
Denys Vlasenko9c3b84a2010-01-18 01:55:00 +01001003 * If display_unit == 0, show value no bigger than 1024 with suffix (K,M,G...),
Denys Vlasenko0bf44d02009-10-13 01:25:09 +02001004 * else divide by display_unit and do not use suffix. */
Denys Vlasenko9c3b84a2010-01-18 01:55:00 +01001005#define HUMAN_READABLE_MAX_WIDTH 7 /* "1024.0G" */
1006#define HUMAN_READABLE_MAX_WIDTH_STR "7"
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001007//TODO: provide pointer to buf (avoid statics)?
1008const char *make_human_readable_str(unsigned long long size,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001009 unsigned long block_size, unsigned long display_unit) FAST_FUNC;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001010/* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
Denys Vlasenko1f56e512011-10-19 22:40:35 +02001011char *bin2hex(char *dst, const char *src, int count) FAST_FUNC;
Denys Vlasenko48363312010-04-04 15:29:32 +02001012/* Reverse */
Denys Vlasenko1f56e512011-10-19 22:40:35 +02001013char* hex2bin(char *dst, const char *src, int count) FAST_FUNC;
Rob Landleyc5b1d4d2006-03-13 15:45:16 +00001014
Vladimir Dronnikovdb67a202009-10-15 09:24:25 +02001015/* Generate a UUID */
1016void generate_uuid(uint8_t *buf) FAST_FUNC;
1017
Denis Vlasenko1bab1de2007-07-27 15:30:39 +00001018/* Last element is marked by mult == 0 */
Eric Andersenaad1a882001-03-16 22:47:14 +00001019struct suffix_mult {
Denis Vlasenkof8689632007-07-27 15:06:25 +00001020 char suffix[4];
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001021 unsigned mult;
Eric Andersenaad1a882001-03-16 22:47:14 +00001022};
Denys Vlasenkoc72b43c2013-07-13 23:49:45 +02001023extern const struct suffix_mult bkm_suffixes[];
1024#define km_suffixes (bkm_suffixes + 1)
Ari Sundholm88930232015-03-04 18:46:48 +02001025extern const struct suffix_mult cwbkMG_suffixes[];
Ari Sundholm911db162015-03-22 17:55:38 +01001026#define kMG_suffixes (cwbkMG_suffixes + 3)
Denys Vlasenkoe184a882016-12-12 19:56:31 +01001027extern const struct suffix_mult kmg_i_suffixes[];
Denys Vlasenkoc72b43c2013-07-13 23:49:45 +02001028
Denis Vlasenkoed836cd2006-11-25 14:44:13 +00001029#include "xatonum.h"
Denis Vlasenko13858992006-10-08 12:49:22 +00001030/* Specialized: */
Denys Vlasenko77832482010-08-12 14:14:45 +02001031
Denis Vlasenko13858992006-10-08 12:49:22 +00001032/* Using xatoi() instead of naive atoi() is not always convenient -
1033 * in many places people want *non-negative* values, but store them
1034 * in signed int. Therefore we need this one:
Denys Vlasenko77832482010-08-12 14:14:45 +02001035 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc.
1036 * It should really be named xatoi_nonnegative (since it allows 0),
1037 * but that would be too long.
1038 */
1039int xatoi_positive(const char *numstr) FAST_FUNC;
1040
Denis Vlasenko13858992006-10-08 12:49:22 +00001041/* Useful for reading port numbers */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001042uint16_t xatou16(const char *numstr) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001043
Denys Vlasenko4c20d9f2018-08-03 18:17:12 +02001044#if ENABLE_FLOAT_DURATION
1045typedef double duration_t;
1046void sleep_for_duration(duration_t duration) FAST_FUNC;
Denys Vlasenko0ddc7422019-03-12 18:56:51 +01001047#define DURATION_FMT "f"
Denys Vlasenko4c20d9f2018-08-03 18:17:12 +02001048#else
1049typedef unsigned duration_t;
1050#define sleep_for_duration(duration) sleep(duration)
Denys Vlasenko0ddc7422019-03-12 18:56:51 +01001051#define DURATION_FMT "u"
Denys Vlasenko4c20d9f2018-08-03 18:17:12 +02001052#endif
1053duration_t parse_duration_str(char *str) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001054
Eric Andersenaad1a882001-03-16 22:47:14 +00001055/* These parse entries in /etc/passwd and /etc/group. This is desirable
1056 * for BusyBox since we want to avoid using the glibc NSS stuff, which
Bernhard Reutner-Fischerd5bd1372005-09-20 21:06:17 +00001057 * increases target size and is often not needed on embedded systems. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001058long xuname2uid(const char *name) FAST_FUNC;
1059long xgroup2gid(const char *name) FAST_FUNC;
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +00001060/* wrapper: allows string to contain numeric uid or gid */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001061unsigned long get_ug_id(const char *s, long FAST_FUNC (*xname2id)(const char *)) FAST_FUNC;
Denis Vlasenkode59c0f2006-10-05 22:50:22 +00001062struct bb_uidgid_t {
Denis Vlasenko150f4022007-01-13 21:06:21 +00001063 uid_t uid;
1064 gid_t gid;
Denis Vlasenkode59c0f2006-10-05 22:50:22 +00001065};
Denys Vlasenko526d8582015-10-19 04:27:17 +02001066/* always sets uid and gid; returns 0 on failure */
1067int get_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
1068/* always sets uid and gid; exits on failure */
Bernhard Reutner-Fischerd73cbd32008-07-21 14:41:33 +00001069void xget_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
Denis Vlasenkocce38582007-02-26 22:47:42 +00001070/* chown-like handling of "user[:[group]" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001071void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group) FAST_FUNC;
Denis Vlasenkod7a805e2008-12-03 19:05:55 +00001072struct passwd* xgetpwnam(const char *name) FAST_FUNC;
Denis Vlasenko15437e32008-12-05 16:23:06 +00001073struct group* xgetgrnam(const char *name) FAST_FUNC;
Denis Vlasenko0c68a872008-12-02 22:56:59 +00001074struct passwd* xgetpwuid(uid_t uid) FAST_FUNC;
1075struct group* xgetgrgid(gid_t gid) FAST_FUNC;
1076char* xuid2uname(uid_t uid) FAST_FUNC;
1077char* xgid2group(gid_t gid) FAST_FUNC;
1078char* uid2uname(uid_t uid) FAST_FUNC;
1079char* gid2group(gid_t gid) FAST_FUNC;
Denys Vlasenko7d65abe2011-03-01 16:27:13 +01001080char* uid2uname_utoa(uid_t uid) FAST_FUNC;
1081char* gid2group_utoa(gid_t gid) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +00001082/* versions which cache results (useful for ps, ls etc) */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001083const char* get_cached_username(uid_t uid) FAST_FUNC;
1084const char* get_cached_groupname(gid_t gid) FAST_FUNC;
1085void clear_username_cache(void) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +00001086/* internally usernames are saved in fixed-sized char[] buffers */
Denys Vlasenko7d65abe2011-03-01 16:27:13 +01001087enum { USERNAME_MAX_SIZE = 32 - sizeof(uid_t) };
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +00001088#if ENABLE_FEATURE_CHECK_NAMES
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001089void die_if_bad_username(const char* name) FAST_FUNC;
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +00001090#else
1091#define die_if_bad_username(name) ((void)(name))
1092#endif
Denys Vlasenkoa8cf9c52017-07-04 18:49:24 +02001093/*
1094 * Returns (-1) terminated malloced result of getgroups().
1095 * Reallocs group_array (useful for repeated calls).
1096 * ngroups is an initial size of array. It is rounded up to 32 for realloc.
1097 * ngroups is updated on return.
1098 * ngroups can be NULL: bb_getgroups(NULL, NULL) is valid usage.
1099 * Dies on errors (on Linux, only xrealloc can cause this, not internal getgroups call).
1100 */
1101gid_t *bb_getgroups(int *ngroups, gid_t *group_array) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001102
Denys Vlasenko37f5bef2010-04-05 03:18:40 +02001103#if ENABLE_FEATURE_UTMP
Denys Vlasenko3a416112010-04-05 22:10:38 +02001104void FAST_FUNC write_new_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
1105void 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 +01001106void FAST_FUNC update_utmp_DEAD_PROCESS(pid_t pid);
Denys Vlasenko37f5bef2010-04-05 03:18:40 +02001107#else
Denys Vlasenko3a416112010-04-05 22:10:38 +02001108# define write_new_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
1109# define update_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
Denys Vlasenkoda921262015-01-05 15:37:58 +01001110# define update_utmp_DEAD_PROCESS(pid) ((void)0)
Denys Vlasenko37f5bef2010-04-05 03:18:40 +02001111#endif
1112
Denys Vlasenkob72baeb2011-02-02 18:38:57 +01001113
Denys Vlasenkoe765b5a2014-05-02 17:15:58 +02001114int file_is_executable(const char *name) FAST_FUNC;
1115char *find_executable(const char *filename, char **PATHp) FAST_FUNC;
1116int executable_exists(const char *filename) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001117
Denis Vlasenko7e0fbf92007-09-04 19:33:22 +00001118/* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
1119 * but it may exec busybox and call applet instead of searching PATH.
1120 */
Denis Vlasenko80d14be2007-04-10 23:03:30 +00001121#if ENABLE_FEATURE_PREFER_APPLETS
Denys Vlasenkoc71b4692011-02-02 03:28:56 +01001122int BB_EXECVP(const char *file, char *const argv[]) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001123#define BB_EXECLP(prog,cmd,...) \
Denys Vlasenkoc71b4692011-02-02 03:28:56 +01001124 do { \
1125 if (find_applet_by_name(prog) >= 0) \
1126 execlp(bb_busybox_exec_path, cmd, __VA_ARGS__); \
1127 execlp(prog, cmd, __VA_ARGS__); \
1128 } while (0)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001129#else
1130#define BB_EXECVP(prog,cmd) execvp(prog,cmd)
Denys Vlasenkoc71b4692011-02-02 03:28:56 +01001131#define BB_EXECLP(prog,cmd,...) execlp(prog,cmd,__VA_ARGS__)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001132#endif
Denys Vlasenko82203992016-04-02 18:06:24 +02001133void BB_EXECVP_or_die(char **argv) NORETURN FAST_FUNC;
1134void exec_prog_or_SHELL(char **argv) NORETURN FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001135
Denys Vlasenko82203992016-04-02 18:06:24 +02001136/* xvfork() can't be a _function_, return after vfork in child mangles stack
Pascal Bellard926031b2010-07-04 15:32:38 +02001137 * in the parent. It must be a macro. */
1138#define xvfork() \
1139({ \
1140 pid_t bb__xvfork_pid = vfork(); \
1141 if (bb__xvfork_pid < 0) \
James Byrne69374872019-07-02 11:35:03 +02001142 bb_simple_perror_msg_and_die("vfork"); \
Pascal Bellard926031b2010-07-04 15:32:38 +02001143 bb__xvfork_pid; \
1144})
1145#if BB_MMU
1146pid_t xfork(void) FAST_FUNC;
1147#endif
Denys Vlasenko82203992016-04-02 18:06:24 +02001148void xvfork_parent_waits_and_exits(void) FAST_FUNC;
Pascal Bellard926031b2010-07-04 15:32:38 +02001149
Denys Vlasenko8531d762010-03-18 22:44:00 +01001150/* NOMMU friendy fork+exec: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001151pid_t spawn(char **argv) FAST_FUNC;
1152pid_t xspawn(char **argv) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +00001153
Denis Vlasenko3854c5d2008-11-06 22:39:57 +00001154pid_t safe_waitpid(pid_t pid, int *wstat, int options) FAST_FUNC;
Denys Vlasenko8531d762010-03-18 22:44:00 +01001155pid_t wait_any_nohang(int *wstat) FAST_FUNC;
1156/* wait4pid: unlike waitpid, waits ONLY for one process.
1157 * Returns sig + 0x180 if child is killed by signal.
Denis Vlasenkocd7001f2007-04-09 21:32:30 +00001158 * It's safe to pass negative 'pids' from failed [v]fork -
Denis Vlasenko473dae02007-04-11 07:04:23 +00001159 * wait4pid will return -1 (and will not clobber [v]fork's errno).
Denis Vlasenkocd7001f2007-04-09 21:32:30 +00001160 * IOW: rc = wait4pid(spawn(argv));
1161 * if (rc < 0) bb_perror_msg("%s", argv[0]);
Denys Vlasenko8531d762010-03-18 22:44:00 +01001162 * if (rc > 0) bb_error_msg("exit code: %d", rc & 0xff);
Denis Vlasenkocd7001f2007-04-09 21:32:30 +00001163 */
Denis Vlasenko3854c5d2008-11-06 22:39:57 +00001164int wait4pid(pid_t pid) FAST_FUNC;
Denys Vlasenkoc4199f22016-04-01 22:12:44 +02001165int wait_for_exitstatus(pid_t pid) FAST_FUNC;
Denys Vlasenko9967c992017-01-26 01:13:58 +01001166/************************************************************************/
1167/* spawn_and_wait/run_nofork_applet/run_applet_no_and_exit need to work */
1168/* carefully together to reinit some global state while not disturbing */
1169/* other. Be careful if you change them. Consult docs/nofork_noexec.txt */
1170/************************************************************************/
Denys Vlasenko8531d762010-03-18 22:44:00 +01001171/* Same as wait4pid(spawn(argv)), but with NOFORK/NOEXEC if configured: */
Denys Vlasenko8f24f982009-06-07 16:02:00 +02001172int spawn_and_wait(char **argv) FAST_FUNC;
Denis Vlasenko18e19f22007-04-28 16:43:18 +00001173/* Does NOT check that applet is NOFORK, just blindly runs it */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001174int run_nofork_applet(int applet_no, char **argv) FAST_FUNC;
Denys Vlasenko80e8e3c2017-08-07 19:24:57 +02001175void run_noexec_applet_and_exit(int a, const char *name, char **argv) NORETURN FAST_FUNC;
Denys Vlasenko9967c992017-01-26 01:13:58 +01001176#ifndef BUILD_INDIVIDUAL
Denys Vlasenko80e8e3c2017-08-07 19:24:57 +02001177int find_applet_by_name(const char *name) FAST_FUNC;
1178void run_applet_no_and_exit(int a, const char *name, char **argv) NORETURN FAST_FUNC;
Denys Vlasenko9967c992017-01-26 01:13:58 +01001179#endif
Denys Vlasenkof2cf1cc2017-08-07 18:45:33 +02001180#if defined(__linux__)
1181void set_task_comm(const char *comm) FAST_FUNC;
1182#else
1183# define set_task_comm(name) ((void)0)
1184#endif
Denis Vlasenkocd7001f2007-04-09 21:32:30 +00001185
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001186/* Helpers for daemonization.
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001187 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001188 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001189 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001190 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
1191 * rexec's itself on NOMMU with argv passed as command line.
1192 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
1193 * from the start. (It will detect it and not reexec again second time).
1194 * You have to audit carefully that you don't do something twice as a result
1195 * (opening files/sockets, parsing config files etc...)!
1196 *
1197 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
1198 * (will do setsid()).
1199 *
Pascal Bellard926031b2010-07-04 15:32:38 +02001200 * fork_or_rexec(argv) = bare-bones fork on MMU,
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001201 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
Denis Vlasenko83518d12009-03-20 22:17:13 +00001202 * On MMU ignores argv.
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001203 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001204 * Helper for network daemons in foreground mode:
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001205 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001206 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
1207 * to /dev/null if they are not.
1208 */
1209enum {
Denys Vlasenko088fec32019-01-14 14:45:18 +01001210 DAEMON_CHDIR_ROOT = 1 << 0,
1211 DAEMON_DEVNULL_STDIO = 1 << 1,
1212 DAEMON_CLOSE_EXTRA_FDS = 1 << 2,
1213 DAEMON_ONLY_SANITIZE = 1 << 3, /* internal use */
1214 //DAEMON_DOUBLE_FORK = 1 << 4, /* double fork to avoid controlling tty */
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001215};
Denis Vlasenko473dae02007-04-11 07:04:23 +00001216#if BB_MMU
Denis Vlasenko367960b2007-08-18 14:20:21 +00001217 enum { re_execed = 0 };
Pascal Bellard926031b2010-07-04 15:32:38 +02001218# define fork_or_rexec(argv) xfork()
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001219# define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
1220# define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001221#else
Pascal Bellard926031b2010-07-04 15:32:38 +02001222 extern bool re_execed;
Denys Vlasenkod2277e22011-11-22 17:19:26 +01001223 /* Note: re_exec() and fork_or_rexec() do argv[0][0] |= 0x80 on NOMMU!
1224 * _Parent_ needs to undo it if it doesn't want to have argv[0] mangled.
1225 */
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001226 void re_exec(char **argv) NORETURN FAST_FUNC;
Denis Vlasenko83518d12009-03-20 22:17:13 +00001227 pid_t fork_or_rexec(char **argv) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001228 int BUG_fork_is_unavailable_on_nommu(void) FAST_FUNC;
1229 int BUG_daemon_is_unavailable_on_nommu(void) FAST_FUNC;
1230 void BUG_bb_daemonize_is_unavailable_on_nommu(void) FAST_FUNC;
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001231# define fork() BUG_fork_is_unavailable_on_nommu()
Pascal Bellard926031b2010-07-04 15:32:38 +02001232# define xfork() BUG_fork_is_unavailable_on_nommu()
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001233# define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
1234# define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001235#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001236void bb_daemonize_or_rexec(int flags, char **argv) FAST_FUNC;
1237void bb_sanitize_stdio(void) FAST_FUNC;
Denys Vlasenkob182e9a2017-08-04 23:04:17 +02001238#define bb_daemon_helper(arg) bb_daemonize_or_rexec((arg) | DAEMON_ONLY_SANITIZE, NULL)
Denis Vlasenkoc9ca0a32008-02-18 11:08:33 +00001239/* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001240int sanitize_env_if_suid(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001241
1242
Denys Vlasenko727948e2017-08-04 16:23:42 +02001243/* For top, ps. Some argv[i] are replaced by malloced "-opt" strings */
1244void make_all_argv_opts(char **argv) FAST_FUNC;
Denys Vlasenko036585a2017-08-08 16:38:18 +02001245char* single_argv(char **argv) FAST_FUNC;
1246extern const char *const bb_argv_dash[]; /* { "-", NULL } */
1247extern uint32_t option_mask32;
Denys Vlasenko036585a2017-08-08 16:38:18 +02001248uint32_t getopt32(char **argv, const char *applet_opts, ...) FAST_FUNC;
1249# define No_argument "\0"
1250# define Required_argument "\001"
1251# define Optional_argument "\002"
1252#if ENABLE_LONG_OPTS
1253uint32_t getopt32long(char **argv, const char *optstring, const char *longopts, ...) FAST_FUNC;
1254#else
1255#define getopt32long(argv,optstring,longopts,...) \
1256 getopt32(argv,optstring,##__VA_ARGS__)
1257#endif
Kaarle Ritvanen835ad3a2017-04-12 00:58:46 +03001258/* BSD-derived getopt() functions require that optind be set to 1 in
1259 * order to reset getopt() state. This used to be generally accepted
1260 * way of resetting getopt(). However, glibc's getopt()
1261 * has additional getopt() state beyond optind (specifically, glibc
Denys Vlasenko352ddd32017-04-12 20:21:34 +02001262 * extensions such as '+' and '-' at the start of the string), and requires
Kaarle Ritvanen835ad3a2017-04-12 00:58:46 +03001263 * that optind be set to zero to reset its state. BSD-derived versions
1264 * of getopt() misbehaved if optind is set to 0 in order to reset getopt(),
1265 * and glibc's getopt() used to coredump if optind is set 1 in order
1266 * to reset getopt().
Denys Vlasenko352ddd32017-04-12 20:21:34 +02001267 * Then BSD introduced additional variable "optreset" which should be
1268 * set to 1 in order to reset getopt(). Sigh. Standards, anyone?
Kaarle Ritvanen835ad3a2017-04-12 00:58:46 +03001269 *
1270 * By ~2008, OpenBSD 3.4 was changed to survive glibc-like optind = 0
1271 * (to interpret it as if optreset was set).
1272 */
Denys Vlasenko60161812017-08-29 14:32:17 +02001273#if 1 /*def __GLIBC__*/
Kaarle Ritvanen835ad3a2017-04-12 00:58:46 +03001274#define GETOPT_RESET() (optind = 0)
1275#else /* BSD style */
1276#define GETOPT_RESET() (optind = 1)
1277#endif
1278
1279
Denys Vlasenko9be47022011-05-16 12:21:31 +02001280/* Having next pointer as a first member allows easy creation
1281 * of "llist-compatible" structs, and using llist_FOO functions
1282 * on them.
1283 */
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001284typedef struct llist_t {
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001285 struct llist_t *link;
Denys Vlasenko9be47022011-05-16 12:21:31 +02001286 char *data;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001287} llist_t;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001288void llist_add_to(llist_t **old_head, void *data) FAST_FUNC;
1289void llist_add_to_end(llist_t **list_head, void *data) FAST_FUNC;
1290void *llist_pop(llist_t **elm) FAST_FUNC;
1291void llist_unlink(llist_t **head, llist_t *elm) FAST_FUNC;
1292void llist_free(llist_t *elm, void (*freeit)(void *data)) FAST_FUNC;
1293llist_t *llist_rev(llist_t *list) FAST_FUNC;
Denis Vlasenko0b791d92009-04-13 20:52:00 +00001294llist_t *llist_find_str(llist_t *first, const char *str) FAST_FUNC;
Denis Vlasenko4b924f32007-05-30 00:29:55 +00001295/* BTW, surprisingly, changing API to
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001296 * llist_t *llist_add_to(llist_t *old_head, void *data)
1297 * etc does not result in smaller code... */
1298
Denis Vlasenko80edead2007-08-02 22:31:05 +00001299/* start_stop_daemon and udhcpc are special - they want
1300 * to create pidfiles regardless of FEATURE_PIDFILE */
Denis Vlasenko1caca342007-08-02 10:14:29 +00001301#if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001302/* True only if we created pidfile which is *file*, not /dev/null etc */
1303extern smallint wrote_pidfile;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001304void write_pidfile(const char *path) FAST_FUNC;
Denys Vlasenko50596532019-03-17 19:47:52 +01001305void write_pidfile_std_path_and_ext(const char *path) FAST_FUNC;
1306void remove_pidfile_std_path_and_ext(const char *path) FAST_FUNC;
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001307#define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
Denis Vlasenko10457b92007-03-27 22:01:31 +00001308#else
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001309enum { wrote_pidfile = 0 };
Denys Vlasenko50596532019-03-17 19:47:52 +01001310#define write_pidfile_std_path_and_ext(path) ((void)0)
1311#define remove_pidfile_std_path_and_ext(path) ((void)0)
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001312#define write_pidfile(path) ((void)0)
1313#define remove_pidfile(path) ((void)0)
Denis Vlasenko10457b92007-03-27 22:01:31 +00001314#endif
1315
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001316enum {
1317 LOGMODE_NONE = 0,
Denis Vlasenko1b97efd2007-08-17 19:18:06 +00001318 LOGMODE_STDIO = (1 << 0),
1319 LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001320 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
1321};
1322extern const char *msg_eol;
Denis Vlasenko04c99eb2007-04-07 00:44:31 +00001323extern smallint logmode;
Denys Vlasenko7aa63042010-09-01 16:04:24 +02001324extern uint8_t xfunc_error_retval;
Denys Vlasenko550bf5b2015-10-09 16:42:57 +02001325extern void (*die_func)(void);
Denys Vlasenko899ae532018-04-01 19:59:37 +02001326void xfunc_die(void) NORETURN FAST_FUNC;
1327void bb_show_usage(void) NORETURN FAST_FUNC;
1328void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
James Byrne69374872019-07-02 11:35:03 +02001329void bb_simple_error_msg(const char *s) FAST_FUNC;
Denys Vlasenko899ae532018-04-01 19:59:37 +02001330void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
James Byrne69374872019-07-02 11:35:03 +02001331void bb_simple_error_msg_and_die(const char *s) NORETURN FAST_FUNC;
Denys Vlasenko899ae532018-04-01 19:59:37 +02001332void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1333void bb_simple_perror_msg(const char *s) FAST_FUNC;
1334void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1335void bb_simple_perror_msg_and_die(const char *s) NORETURN FAST_FUNC;
1336void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
James Byrne69374872019-07-02 11:35:03 +02001337void bb_simple_herror_msg(const char *s) FAST_FUNC;
Denys Vlasenko899ae532018-04-01 19:59:37 +02001338void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
James Byrne69374872019-07-02 11:35:03 +02001339void bb_simple_herror_msg_and_die(const char *s) NORETURN FAST_FUNC;
Denys Vlasenko899ae532018-04-01 19:59:37 +02001340void bb_perror_nomsg_and_die(void) NORETURN FAST_FUNC;
1341void bb_perror_nomsg(void) FAST_FUNC;
1342void bb_verror_msg(const char *s, va_list p, const char *strerr) FAST_FUNC;
1343void bb_die_memory_exhausted(void) NORETURN FAST_FUNC;
1344void bb_logenv_override(void) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001345
James Byrne253c4e72019-04-12 17:01:51 +00001346#if ENABLE_FEATURE_SYSLOG_INFO
1347void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
James Byrne69374872019-07-02 11:35:03 +02001348void bb_simple_info_msg(const char *s) FAST_FUNC;
James Byrne253c4e72019-04-12 17:01:51 +00001349void bb_vinfo_msg(const char *s, va_list p) FAST_FUNC;
1350#else
1351#define bb_info_msg bb_error_msg
James Byrne69374872019-07-02 11:35:03 +02001352#define bb_simple_info_msg bb_simple_error_msg
James Byrne253c4e72019-04-12 17:01:51 +00001353#define bb_vinfo_msg(s,p) bb_verror_msg(s,p,NULL)
1354#endif
1355
James Byrne69374872019-07-02 11:35:03 +02001356#if ENABLE_WARN_SIMPLE_MSG
1357/* If enabled, cause calls to bb_error_msg() et al that only take a single
1358 * parameter to generate a warning.
1359 */
1360static inline void __attribute__ ((deprecated("use bb_simple_error_msg instead")))
1361 bb_not_simple_error_msg(const char *s) { bb_simple_error_msg(s); }
1362static inline void __attribute__ ((deprecated("use bb_simple_error_msg_and_die instead"))) NORETURN
1363 bb_not_simple_error_msg_and_die(const char *s) { bb_simple_error_msg_and_die(s); }
1364static inline void __attribute__ ((deprecated("use bb_simple_perror_msg instead")))
1365 bb_not_simple_perror_msg(const char *s) { bb_simple_perror_msg(s); }
1366static inline void __attribute__ ((deprecated("use bb_simple_perror_msg_and_die instead"))) NORETURN
1367 bb_not_simple_perror_msg_and_die(const char *s) { bb_simple_perror_msg_and_die(s); }
1368static inline void __attribute__ ((deprecated("use bb_simple_herror_msg instead")))
1369 bb_not_simple_herror_msg(const char *s) { bb_simple_herror_msg(s); }
1370static inline void __attribute__ ((deprecated("use bb_simple_herror_msg_and_die instead"))) NORETURN
1371 bb_not_simple_herror_msg_and_die(const char *s) { bb_simple_herror_msg_and_die(s); }
1372static inline void __attribute__ ((deprecated("use bb_simple_info_msg instead")))
1373 bb_not_simple_info_msg(const char *s) { bb_simple_info_msg(s); }
1374/* Override bb_error_msg() and related functions with macros that will
1375 * substitute them for the equivalent bb_not_simple_error_msg() function when
1376 * they are used with only a single parameter. Macro approach inspired by
1377 * https://gustedt.wordpress.com/2010/06/08/detect-empty-macro-arguments and
1378 * https://gustedt.wordpress.com/2010/06/03/default-arguments-for-c99
1379 */
1380#define _ARG18(_0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11, _12, _13, _14, _15, _16, _17, ...) _17
1381#define BB_MSG_KIND(...) _ARG18(__VA_ARGS__, , , , , , , , , , , , , , , , , _not_simple)
1382#define _BB_MSG(name, kind, ...) bb##kind##name(__VA_ARGS__)
1383#define BB_MSG(name, kind, ...) _BB_MSG(name, kind, __VA_ARGS__)
1384#define bb_error_msg(...) BB_MSG(_error_msg, BB_MSG_KIND(__VA_ARGS__), __VA_ARGS__)
1385#define bb_error_msg_and_die(...) BB_MSG(_error_msg_and_die, BB_MSG_KIND(__VA_ARGS__), __VA_ARGS__)
1386#define bb_perror_msg(...) BB_MSG(_perror_msg, BB_MSG_KIND(__VA_ARGS__), __VA_ARGS__)
1387#define bb_perror_msg_and_die(...) BB_MSG(_perror_msg_and_die, BB_MSG_KIND(__VA_ARGS__), __VA_ARGS__)
1388#define bb_herror_msg(...) BB_MSG(_herror_msg, BB_MSG_KIND(__VA_ARGS__), __VA_ARGS__)
1389#define bb_herror_msg_and_die(...) BB_MSG(_herror_msg_and_die, BB_MSG_KIND(__VA_ARGS__), __VA_ARGS__)
Denys Vlasenko6eb38fd2020-06-23 02:46:53 +02001390#if ENABLE_FEATURE_SYSLOG_INFO
James Byrne69374872019-07-02 11:35:03 +02001391#define bb_info_msg(...) BB_MSG(_info_msg, BB_MSG_KIND(__VA_ARGS__), __VA_ARGS__)
1392#endif
Denys Vlasenko6eb38fd2020-06-23 02:46:53 +02001393#endif
James Byrne69374872019-07-02 11:35:03 +02001394
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +00001395/* We need to export XXX_main from libbusybox
1396 * only if we build "individual" binaries
1397 */
1398#if ENABLE_FEATURE_INDIVIDUAL
1399#define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
1400#else
1401#define MAIN_EXTERNALLY_VISIBLE
1402#endif
1403
Denys Vlasenko4f2ef4a2018-11-01 09:53:25 +01001404/* Embedded script support */
Denys Vlasenko4f2ef4a2018-11-01 09:53:25 +01001405char *get_script_content(unsigned n) FAST_FUNC;
Ron Yorston3193cb52019-03-30 07:47:12 +00001406int scripted_main(int argc, char** argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001407
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001408/* Applets which are useful from another applets */
Denys Vlasenkod9eb40c2017-04-12 15:48:19 +02001409int bb_cat(char** argv) FAST_FUNC;
Denys Vlasenko4f2ef4a2018-11-01 09:53:25 +01001410int ash_main(int argc, char** argv)
1411#if ENABLE_ASH || ENABLE_SH_IS_ASH || ENABLE_BASH_IS_ASH
1412 MAIN_EXTERNALLY_VISIBLE
1413#endif
1414;
Ron Yorston71df2d32018-11-27 14:34:25 +00001415int hush_main(int argc, char** argv)
1416#if ENABLE_HUSH || ENABLE_SH_IS_HUSH || ENABLE_BASH_IS_HUSH
1417 MAIN_EXTERNALLY_VISIBLE
1418#endif
1419;
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001420/* If shell needs them, they exist even if not enabled as applets */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001421int echo_main(int argc, char** argv) IF_ECHO(MAIN_EXTERNALLY_VISIBLE);
1422int printf_main(int argc, char **argv) IF_PRINTF(MAIN_EXTERNALLY_VISIBLE);
Denys Vlasenko548620c2016-12-08 12:24:48 +01001423int test_main(int argc, char **argv)
1424#if ENABLE_TEST || ENABLE_TEST1 || ENABLE_TEST2
1425 MAIN_EXTERNALLY_VISIBLE
1426#endif
1427;
1428int kill_main(int argc, char **argv)
1429#if ENABLE_KILL || ENABLE_KILLALL || ENABLE_KILLALL5
1430 MAIN_EXTERNALLY_VISIBLE
1431#endif
1432;
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001433/* Similar, but used by chgrp, not shell */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001434int chown_main(int argc, char **argv) IF_CHOWN(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenkoc41cba52009-03-09 15:46:07 +00001435/* Used by ftpd */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001436int ls_main(int argc, char **argv) IF_LS(MAIN_EXTERNALLY_VISIBLE);
1437/* Don't need IF_xxx() guard for these */
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +00001438int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko77f1ec12007-10-13 03:36:03 +00001439int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko1a9e9bd2008-11-01 12:54:56 +00001440
Denis Vlasenko468aea22008-04-01 14:47:57 +00001441#if ENABLE_ROUTE
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001442void bb_displayroutes(int noresolve, int netstatfmt) FAST_FUNC;
Denis Vlasenko468aea22008-04-01 14:47:57 +00001443#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001444
Denys Vlasenkod88f94a2017-04-05 18:17:17 +02001445struct number_state {
1446 unsigned width;
1447 unsigned start;
1448 unsigned inc;
1449 const char *sep;
1450 const char *empty_str;
1451 smallint all, nonempty;
1452};
Denys Vlasenkoc1005352018-11-29 11:44:10 +01001453int print_numbered_lines(struct number_state *ns, const char *filename) FAST_FUNC;
Denys Vlasenkod88f94a2017-04-05 18:17:17 +02001454
Denis Vlasenko270c17c2006-12-26 17:40:33 +00001455
1456/* Networking */
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001457/* This structure defines protocol families and their handlers. */
1458struct aftype {
1459 const char *name;
1460 const char *title;
1461 int af;
1462 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001463 char* FAST_FUNC (*print)(unsigned char *);
1464 const char* FAST_FUNC (*sprint)(struct sockaddr *, int numeric);
1465 int FAST_FUNC (*input)(/*int type,*/ const char *bufp, struct sockaddr *);
1466 void FAST_FUNC (*herror)(char *text);
1467 int FAST_FUNC (*rprint)(int options);
1468 int FAST_FUNC (*rinput)(int typ, int ext, char **argv);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001469 /* may modify src */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001470 int FAST_FUNC (*getmask)(char *src, struct sockaddr *mask, char *name);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001471};
1472/* This structure defines hardware protocols and their handlers. */
1473struct hwtype {
1474 const char *name;
1475 const char *title;
1476 int type;
1477 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001478 char* FAST_FUNC (*print)(unsigned char *);
1479 int FAST_FUNC (*input)(const char *, struct sockaddr *);
1480 int FAST_FUNC (*activate)(int fd);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001481 int suppress_null_addr;
1482};
Denys Vlasenko82ec8942018-03-05 17:46:17 +01001483#define IFNAME_SHOW_DOWNED_TOO ((char*)(intptr_t)1)
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001484int display_interfaces(char *ifname) FAST_FUNC;
Bartosz Golaszewskic19be752013-07-25 04:39:04 +02001485int in_ether(const char *bufp, struct sockaddr *sap) FAST_FUNC;
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001486#if ENABLE_FEATURE_HWIB
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001487int in_ib(const char *bufp, struct sockaddr *sap) FAST_FUNC;
Denis Vlasenko3b162ec2008-06-04 07:59:51 +00001488#else
1489#define in_ib(a, b) 1 /* fail */
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001490#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001491const struct aftype *get_aftype(const char *name) FAST_FUNC;
1492const struct hwtype *get_hwtype(const char *name) FAST_FUNC;
1493const struct hwtype *get_hwntype(int type) FAST_FUNC;
Denis Vlasenko270c17c2006-12-26 17:40:33 +00001494
1495
Denys Vlasenko35b54a32017-01-30 00:45:05 +01001496extern int fstype_matches(const char *fstype, const char *comma_list) FAST_FUNC;
Mike Frysinger9412ec72008-02-07 22:41:33 +00001497#ifdef HAVE_MNTENT_H
Denys Vlasenko6ae64262009-07-18 16:22:26 +02001498extern struct mntent *find_mount_point(const char *name, int subdir_too) FAST_FUNC;
Mike Frysinger9412ec72008-02-07 22:41:33 +00001499#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001500extern void erase_mtab(const char * name) FAST_FUNC;
1501extern unsigned int tty_baud_to_value(speed_t speed) FAST_FUNC;
1502extern speed_t tty_value_to_baud(unsigned int value) FAST_FUNC;
Denys Vlasenkoa355da02010-01-04 13:16:08 +01001503#if ENABLE_DESKTOP
1504extern void bb_warn_ignoring_args(char *arg) FAST_FUNC;
1505#else
1506# define bb_warn_ignoring_args(arg) ((void)0)
1507#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001508
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001509extern int get_linux_version_code(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001510
Denys Vlasenko3b69ba72019-06-09 23:20:49 +02001511char *query_loop(const char *device) FAST_FUNC;
1512int get_free_loop(void) FAST_FUNC;
1513int del_loop(const char *device) FAST_FUNC;
Denys Vlasenkoab518ee2017-03-16 16:49:37 +01001514/*
1515 * If *devname is not NULL, use that name, otherwise try to find free one,
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001516 * malloc and return it in *devname.
Denys Vlasenkoab518ee2017-03-16 16:49:37 +01001517 * return value is the opened fd to the loop device, or < on error
1518 */
Steffen Trumtrar6561e072020-07-29 10:43:53 +02001519int set_loop(char **devname, const char *file, unsigned long long offset,
1520 unsigned long long sizelimit, unsigned flags) FAST_FUNC;
Denys Vlasenkoab518ee2017-03-16 16:49:37 +01001521/* These constants match linux/loop.h (without BB_ prefix): */
1522#define BB_LO_FLAGS_READ_ONLY 1
1523#define BB_LO_FLAGS_AUTOCLEAR 4
Jack O'Sullivan726cbb12019-05-28 15:28:27 +01001524#define BB_LO_FLAGS_PARTSCAN 8
Eric Andersenaad1a882001-03-16 22:47:14 +00001525
Denys Vlasenko17058a02018-04-07 15:50:30 +02001526/* Returns malloced str */
1527char *bb_ask_noecho(int fd, int timeout, const char *prompt) FAST_FUNC;
1528/* Like bb_ask_noecho, but asks on stdin with no timeout. */
Denys Vlasenko77cb6b92018-04-07 15:08:12 +02001529char *bb_ask_noecho_stdin(const char *prompt) FAST_FUNC;
Denys Vlasenko17058a02018-04-07 15:50:30 +02001530
Denys Vlasenkobae8fc42018-04-07 15:21:35 +02001531int bb_ask_y_confirmation_FILE(FILE *fp) FAST_FUNC;
Denys Vlasenko77cb6b92018-04-07 15:08:12 +02001532int bb_ask_y_confirmation(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001533
Denys Vlasenko5711a2a2015-10-07 17:55:33 +02001534/* Returns -1 if input is invalid. current_mode is a base for e.g. "u+rw" */
1535int bb_parse_mode(const char* s, unsigned cur_mode) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001536
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001537/*
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001538 * Config file parser
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001539 */
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001540enum {
Denis Vlasenko084266e2008-07-26 23:08:31 +00001541 PARSE_COLLAPSE = 0x00010000, // treat consecutive delimiters as one
1542 PARSE_TRIM = 0x00020000, // trim leading and trailing delimiters
1543// TODO: COLLAPSE and TRIM seem to always go in pair
1544 PARSE_GREEDY = 0x00040000, // last token takes entire remainder of the line
1545 PARSE_MIN_DIE = 0x00100000, // die if < min tokens found
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001546 // keep a copy of current line
Denis Vlasenko35a064b2008-11-06 00:49:59 +00001547 PARSE_KEEP_COPY = 0x00200000 * ENABLE_FEATURE_CROND_D,
Denys Vlasenko499597d2012-01-11 00:37:17 +01001548 PARSE_EOL_COMMENTS = 0x00400000, // comments are recognized even if they aren't the first char
Denys Vlasenko50db1f22017-08-05 18:20:34 +02001549 PARSE_ALT_COMMENTS = 0x00800000, // delim[0] and delim[1] are two different allowed comment chars
1550 // (so far, delim[0] will only work as comment char for full-line comment)
1551 // (IOW: it works as if PARSE_EOL_COMMENTS is not set. sysctl applet is okay with this)
1552 PARSE_WS_COMMENTS = 0x01000000, // comments are recognized even if there is whitespace before
1553 // ("line start><space><tab><space>#comment" is also comment, not only "line start>#comment")
Denis Vlasenko084266e2008-07-26 23:08:31 +00001554 // NORMAL is:
1555 // * remove leading and trailing delimiters and collapse
1556 // multiple delimiters into one
1557 // * warn and continue if less than mintokens delimiters found
1558 // * grab everything into last token
Denys Vlasenko499597d2012-01-11 00:37:17 +01001559 // * comments are recognized even if they aren't the first char
1560 PARSE_NORMAL = PARSE_COLLAPSE | PARSE_TRIM | PARSE_GREEDY | PARSE_EOL_COMMENTS,
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001561};
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001562typedef struct parser_t {
1563 FILE *fp;
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001564 char *data;
Timo Terasadcabf32011-06-20 09:49:56 +02001565 char *line, *nline;
1566 size_t line_alloc, nline_alloc;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001567 int lineno;
1568} parser_t;
Bernhard Reutner-Fischer67921282008-07-17 11:59:13 +00001569parser_t* config_open(const char *filename) FAST_FUNC;
Denis Vlasenko5415c852008-07-21 23:05:26 +00001570parser_t* config_open2(const char *filename, FILE* FAST_FUNC (*fopen_func)(const char *path)) FAST_FUNC;
Denys Vlasenkoadbbee42010-06-21 07:17:23 +02001571/* delims[0] is a comment char (use '\0' to disable), the rest are token delimiters */
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001572int config_read(parser_t *parser, char **tokens, unsigned flags, const char *delims) FAST_FUNC;
1573#define config_read(parser, tokens, max, min, str, flags) \
1574 config_read(parser, tokens, ((flags) | (((min) & 0xFF) << 8) | ((max) & 0xFF)), str)
Denis Vlasenkoc01340f2008-07-16 22:12:18 +00001575void config_close(parser_t *parser) FAST_FUNC;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001576
Denis Vlasenko6bf05cf2008-05-07 12:18:48 +00001577/* Concatenate path and filename to new allocated buffer.
1578 * Add "/" only as needed (no duplicate "//" are produced).
1579 * If path is NULL, it is assumed to be "/".
1580 * filename should not be NULL. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001581char *concat_path_file(const char *path, const char *filename) FAST_FUNC;
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +02001582/* Returns NULL on . and .. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001583char *concat_subpath_file(const char *path, const char *filename) FAST_FUNC;
Eric Andersene5dfced2001-04-09 22:48:12 +00001584
Denis Vlasenko4921b542007-02-03 02:17:41 +00001585
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001586int bb_make_directory(char *path, long mode, int flags) FAST_FUNC;
Matt Kraaiceeff732001-06-21 19:41:37 +00001587
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001588int get_signum(const char *name) FAST_FUNC;
1589const char *get_signame(int number) FAST_FUNC;
1590void print_signames(void) FAST_FUNC;
Rob Landleyc9c1a412006-07-12 19:17:55 +00001591
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001592char *bb_simplify_path(const char *path) FAST_FUNC;
Denis Vlasenko1cf4a0e2009-04-22 13:49:16 +00001593/* Returns ptr to NUL */
1594char *bb_simplify_abs_path_inplace(char *path) FAST_FUNC;
Eric Andersen34506362001-08-02 05:02:46 +00001595
Peter Kümmela6588fa2014-12-22 01:55:54 +01001596#ifndef LOGIN_FAIL_DELAY
Denys Vlasenko681efe22011-03-08 21:00:36 +01001597#define LOGIN_FAIL_DELAY 3
Peter Kümmela6588fa2014-12-22 01:55:54 +01001598#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001599extern void bb_do_delay(int seconds) FAST_FUNC;
1600extern void change_identity(const struct passwd *pw) FAST_FUNC;
Denys Vlasenko79e25982016-11-03 22:13:08 +01001601extern void run_shell(const char *shell, int loginshell, const char **args) NORETURN FAST_FUNC;
Denys Vlasenko681efe22011-03-08 21:00:36 +01001602
1603/* Returns $SHELL, getpwuid(getuid())->pw_shell, or DEFAULT_SHELL.
1604 * Note that getpwuid result might need xstrdup'ing
1605 * if there is a possibility of intervening getpwxxx() calls.
1606 */
Denys Vlasenkofd77ea52012-10-03 09:42:21 +02001607const char *get_shell_name(void) FAST_FUNC;
Denys Vlasenko681efe22011-03-08 21:00:36 +01001608
Denys Vlasenko2af5e3f2018-02-21 20:13:39 +01001609#if ENABLE_FEATURE_SETPRIV_CAPABILITIES || ENABLE_RUN_INIT
Denys Vlasenko44b3f2f2017-08-21 02:14:19 +02001610unsigned cap_name_to_number(const char *cap) FAST_FUNC;
1611void printf_cap(const char *pfx, unsigned cap_no) FAST_FUNC;
Denys Vlasenko200bcc82017-08-21 19:30:01 +02001612void drop_capability(int cap_ordinal) FAST_FUNC;
1613/* Structures inside "struct caps" are Linux-specific and libcap-specific: */
1614#define DEFINE_STRUCT_CAPS \
1615struct caps { \
1616 struct __user_cap_header_struct header; \
1617 unsigned u32s; \
1618 struct __user_cap_data_struct data[2]; \
1619}
1620void getcaps(void *caps) FAST_FUNC;
Denys Vlasenko2af5e3f2018-02-21 20:13:39 +01001621#endif
Denys Vlasenko44b3f2f2017-08-21 02:14:19 +02001622
Denis Vlasenkob5a122b2006-12-30 14:46:51 +00001623#if ENABLE_SELINUX
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001624extern void renew_current_security_context(void) FAST_FUNC;
1625extern void set_current_security_context(security_context_t sid) FAST_FUNC;
Denis Vlasenko1203c9b2007-03-11 22:16:02 +00001626extern context_t set_security_context_component(security_context_t cur_context,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001627 char *user, char *role, char *type, char *range) FAST_FUNC;
1628extern void setfscreatecon_or_die(security_context_t scontext) FAST_FUNC;
1629extern void selinux_preserve_fcontext(int fdesc) FAST_FUNC;
Denis Vlasenko2edbc2a2007-10-20 02:00:49 +00001630#else
1631#define selinux_preserve_fcontext(fdesc) ((void)0)
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001632#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001633extern void selinux_or_die(void) FAST_FUNC;
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001634
Davide Cavalca9b3b9792011-01-25 02:26:03 +01001635
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001636/* setup_environment:
Bernhard Reutner-Fischer99709ab2010-02-24 16:10:09 +01001637 * if chdir pw->pw_dir: ok: else if to_tmp == 1: goto /tmp else: goto / or die
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001638 * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001639 * TERM=(old value)
1640 * USER=pw->pw_name, LOGNAME=pw->pw_name
1641 * PATH=bb_default_[root_]path
1642 * HOME=pw->pw_dir
1643 * SHELL=shell
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001644 * else if change_env = 1:
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001645 * if not root (if pw->pw_uid != 0):
1646 * USER=pw->pw_name, LOGNAME=pw->pw_name
1647 * HOME=pw->pw_dir
1648 * SHELL=shell
1649 * else does nothing
Denys Vlasenkoe4f6bfd2017-07-22 03:04:20 +02001650 *
1651 * NB: CHANGEENV and CLEARENV use setenv() - this leaks memory!
1652 * If setup_environment() is used is vforked child, this leaks memory _in parent too_!
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001653 */
Denys Vlasenkofd686a22010-02-26 09:52:45 +01001654#define SETUP_ENV_CHANGEENV (1 << 0)
1655#define SETUP_ENV_CLEARENV (1 << 1)
1656#define SETUP_ENV_TO_TMP (1 << 2)
Pascal Bellard70fc8c12012-06-12 13:21:02 +02001657#define SETUP_ENV_NO_CHDIR (1 << 4)
Denys Vlasenko8b59b2c2013-11-19 13:36:45 +01001658void setup_environment(const char *shell, int flags, const struct passwd *pw) FAST_FUNC;
1659void nuke_str(char *str) FAST_FUNC;
Kaarle Ritvanen517a82c2016-01-02 00:20:39 +02001660#if ENABLE_FEATURE_SECURETTY && !ENABLE_PAM
Denys Vlasenkoa3de0b32017-04-13 13:04:05 +02001661int is_tty_secure(const char *short_tty) FAST_FUNC;
Kaarle Ritvanen517a82c2016-01-02 00:20:39 +02001662#else
Denys Vlasenkoa3de0b32017-04-13 13:04:05 +02001663static ALWAYS_INLINE int is_tty_secure(const char *short_tty UNUSED_PARAM) { return 1; }
Kaarle Ritvanen517a82c2016-01-02 00:20:39 +02001664#endif
Denys Vlasenko335681c2017-04-13 12:57:04 +02001665#define CHECKPASS_PW_HAS_EMPTY_PASSWORD 2
Morten Kvistgaardfeac9b62014-08-05 21:57:18 +02001666int check_password(const struct passwd *pw, const char *plaintext) FAST_FUNC;
Denys Vlasenko8b59b2c2013-11-19 13:36:45 +01001667int ask_and_check_password_extended(const struct passwd *pw, int timeout, const char *prompt) FAST_FUNC;
1668int ask_and_check_password(const struct passwd *pw) FAST_FUNC;
Denis Vlasenkofdddab02008-06-12 16:56:52 +00001669/* Returns a malloced string */
Denis Vlasenkob4c5bf62008-06-15 18:35:34 +00001670#if !ENABLE_USE_BB_CRYPT
1671#define pw_encrypt(clear, salt, cleanup) pw_encrypt(clear, salt)
1672#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001673extern char *pw_encrypt(const char *clear, const char *salt, int cleanup) FAST_FUNC;
1674extern int obscure(const char *old, const char *newval, const struct passwd *pwdp) FAST_FUNC;
Denys Vlasenko12a43272011-05-13 03:19:01 +02001675/*
1676 * rnd is additional random input. New one is returned.
Denis Vlasenko4ea83bf2008-06-12 16:55:59 +00001677 * Useful if you call crypt_make_salt many times in a row:
1678 * rnd = crypt_make_salt(buf1, 4, 0);
1679 * rnd = crypt_make_salt(buf2, 4, rnd);
1680 * rnd = crypt_make_salt(buf3, 4, rnd);
1681 * (otherwise we risk having same salt generated)
1682 */
Denys Vlasenko12a43272011-05-13 03:19:01 +02001683extern int crypt_make_salt(char *p, int cnt /*, int rnd*/) FAST_FUNC;
1684/* "$N$" + sha_salt_16_bytes + NUL */
1685#define MAX_PW_SALT_LEN (3 + 16 + 1)
1686extern char* crypt_make_pw_salt(char p[MAX_PW_SALT_LEN], const char *algo) FAST_FUNC;
1687
Denis Vlasenko829bbd32009-04-14 00:51:05 +00001688
Denis Vlasenko4ea83bf2008-06-12 16:55:59 +00001689/* Returns number of lines changed, or -1 on error */
Denis Vlasenko829bbd32009-04-14 00:51:05 +00001690#if !(ENABLE_FEATURE_ADDUSER_TO_GROUP || ENABLE_FEATURE_DEL_USER_FROM_GROUP)
1691#define update_passwd(filename, username, data, member) \
1692 update_passwd(filename, username, data)
1693#endif
1694extern int update_passwd(const char *filename,
1695 const char *username,
1696 const char *data,
1697 const char *member) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001698
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001699int index_in_str_array(const char *const string_array[], const char *key) FAST_FUNC;
1700int index_in_strings(const char *strings, const char *key) FAST_FUNC;
1701int index_in_substr_array(const char *const string_array[], const char *key) FAST_FUNC;
1702int index_in_substrings(const char *strings, const char *key) FAST_FUNC;
1703const char *nth_string(const char *strings, int n) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001704
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001705extern void print_login_issue(const char *issue_file, const char *tty) FAST_FUNC;
1706extern void print_login_prompt(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001707
Denys Vlasenko53283ad2009-11-02 14:20:34 +01001708char *xmalloc_ttyname(int fd) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof893da82007-08-09 08:27:24 +00001709/* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001710int get_terminal_width_height(int fd, unsigned *width, unsigned *height) FAST_FUNC;
Denys Vlasenko641caae2015-10-23 01:44:22 +02001711int get_terminal_width(int fd) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001712
Denis Vlasenko202ac502008-11-05 13:20:58 +00001713int tcsetattr_stdin_TCSANOW(const struct termios *tp) FAST_FUNC;
Denys Vlasenko058a1532018-04-16 10:24:48 +02001714#define TERMIOS_CLEAR_ISIG (1 << 0)
1715#define TERMIOS_RAW_CRNL_INPUT (1 << 1)
1716#define TERMIOS_RAW_CRNL_OUTPUT (1 << 2)
1717#define TERMIOS_RAW_CRNL (TERMIOS_RAW_CRNL_INPUT|TERMIOS_RAW_CRNL_OUTPUT)
1718#define TERMIOS_RAW_INPUT (1 << 3)
Denys Vlasenkoaaaaaa52017-09-15 17:14:01 +02001719int get_termios_and_make_raw(int fd, struct termios *newterm, struct termios *oldterm, int flags) FAST_FUNC;
Denys Vlasenko01ccdd12017-01-11 16:17:59 +01001720int set_termios_to_raw(int fd, struct termios *oldterm, int flags) FAST_FUNC;
Denis Vlasenko202ac502008-11-05 13:20:58 +00001721
Denis Vlasenko5bb2fc22008-04-21 03:23:59 +00001722/* NB: "unsigned request" is crucial! "int request" will break some arches! */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001723int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1724int 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 +00001725#if ENABLE_IOCTL_HEX2STR_ERROR
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001726int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1727int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001728#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1729#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
1730#else
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001731int bb_ioctl_or_warn(int fd, unsigned request, void *argp) FAST_FUNC;
1732int bb_xioctl(int fd, unsigned request, void *argp) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001733#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1734#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
1735#endif
1736
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001737char *is_in_ino_dev_hashtable(const struct stat *statbuf) FAST_FUNC;
1738void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name) FAST_FUNC;
1739void reset_ino_dev_hashtable(void) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001740#ifdef __GLIBC__
1741/* At least glibc has horrendously large inline for this, so wrap it */
Denys Vlasenko975c7142011-01-24 23:53:12 +01001742unsigned long long bb_makedev(unsigned major, unsigned minor) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001743#undef makedev
1744#define makedev(a,b) bb_makedev(a,b)
1745#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001746
1747
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001748/* "Keycodes" that report an escape sequence.
1749 * We use something which fits into signed char,
Denys Vlasenko5370bfb2009-09-06 02:58:59 +02001750 * yet doesn't represent any valid Unicode character.
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001751 * Also, -1 is reserved for error indication and we don't use it. */
1752enum {
Rostislav Skudnov2e4ef382016-11-24 15:04:00 +01001753 KEYCODE_UP = -2,
1754 KEYCODE_DOWN = -3,
1755 KEYCODE_RIGHT = -4,
1756 KEYCODE_LEFT = -5,
1757 KEYCODE_HOME = -6,
1758 KEYCODE_END = -7,
1759 KEYCODE_INSERT = -8,
1760 KEYCODE_DELETE = -9,
1761 KEYCODE_PAGEUP = -10,
1762 KEYCODE_PAGEDOWN = -11,
1763 KEYCODE_BACKSPACE = -12, /* Used only if Alt/Ctrl/Shifted */
1764 KEYCODE_D = -13, /* Used only if Alted */
Denys Vlasenko9ce09bc2011-11-03 13:28:22 +01001765#if 0
Rostislav Skudnov2e4ef382016-11-24 15:04:00 +01001766 KEYCODE_FUN1 = ,
1767 KEYCODE_FUN2 = ,
1768 KEYCODE_FUN3 = ,
1769 KEYCODE_FUN4 = ,
1770 KEYCODE_FUN5 = ,
1771 KEYCODE_FUN6 = ,
1772 KEYCODE_FUN7 = ,
1773 KEYCODE_FUN8 = ,
1774 KEYCODE_FUN9 = ,
1775 KEYCODE_FUN10 = ,
1776 KEYCODE_FUN11 = ,
1777 KEYCODE_FUN12 = ,
Denys Vlasenko9ce09bc2011-11-03 13:28:22 +01001778#endif
Rostislav Skudnov2e4ef382016-11-24 15:04:00 +01001779 /* ^^^^^ Be sure that last defined value is small enough.
1780 * Current read_key() code allows going up to -32 (0xfff..fffe0).
1781 * This gives three upper bits in LSB to play with:
1782 * KEYCODE_foo values are 0xfff..fffXX, lowest XX bits are: scavvvvv,
1783 * s=0 if SHIFT, c=0 if CTRL, a=0 if ALT,
1784 * vvvvv bits are the same for same key regardless of "shift bits".
Denys Vlasenko9ce09bc2011-11-03 13:28:22 +01001785 */
Rostislav Skudnov2e4ef382016-11-24 15:04:00 +01001786 //KEYCODE_SHIFT_... = KEYCODE_... & ~0x80,
1787 KEYCODE_CTRL_RIGHT = KEYCODE_RIGHT & ~0x40,
1788 KEYCODE_CTRL_LEFT = KEYCODE_LEFT & ~0x40,
1789 KEYCODE_ALT_RIGHT = KEYCODE_RIGHT & ~0x20,
1790 KEYCODE_ALT_LEFT = KEYCODE_LEFT & ~0x20,
1791 KEYCODE_ALT_BACKSPACE = KEYCODE_BACKSPACE & ~0x20,
1792 KEYCODE_ALT_D = KEYCODE_D & ~0x20,
Denys Vlasenko9ce09bc2011-11-03 13:28:22 +01001793
Denys Vlasenko180f5852009-10-26 00:59:59 +01001794 KEYCODE_CURSOR_POS = -0x100, /* 0xfff..fff00 */
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001795 /* How long is the longest ESC sequence we know?
1796 * We want it big enough to be able to contain
1797 * cursor position sequence "ESC [ 9999 ; 9999 R"
1798 */
1799 KEYCODE_BUFFER_SIZE = 16
1800};
1801/* Note: fd may be in blocking or non-blocking mode, both make sense.
1802 * For one, less uses non-blocking mode.
1803 * Only the first read syscall inside read_key may block indefinitely
1804 * (unless fd is in non-blocking mode),
1805 * subsequent reads will time out after a few milliseconds.
1806 * Return of -1 means EOF or error (errno == 0 on EOF).
1807 * buffer[0] is used as a counter of buffered chars and must be 0
1808 * on first call.
Denys Vlasenko58f108e2010-03-11 21:17:55 +01001809 * timeout:
Denys Vlasenko84ea60e2017-08-02 17:27:28 +02001810 * -2: do not poll(-1) for input - read() it, return on EAGAIN at once
1811 * -1: poll(-1) (i.e. block even on NONBLOCKed fd)
1812 * >=0: poll() for TIMEOUT milliseconds, return -1/EAGAIN on timeout
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001813 */
Denys Vlasenko58f108e2010-03-11 21:17:55 +01001814int64_t read_key(int fd, char *buffer, int timeout) FAST_FUNC;
Tomas Heinrichd2b04052010-03-09 14:09:24 +01001815void read_key_ungets(char *buffer, const char *str, unsigned len) FAST_FUNC;
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001816
1817
Denis Vlasenko38f63192007-01-22 09:03:07 +00001818#if ENABLE_FEATURE_EDITING
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001819/* It's NOT just ENABLEd or disabled. It's a number: */
Denys Vlasenko2c4de5b2011-03-31 13:16:52 +02001820# if defined CONFIG_FEATURE_EDITING_HISTORY && CONFIG_FEATURE_EDITING_HISTORY > 0
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001821# define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
Flemming Madsend96ffda2013-04-07 18:47:24 +02001822unsigned size_from_HISTFILESIZE(const char *hp) FAST_FUNC;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001823# else
1824# define MAX_HISTORY 0
1825# endif
Ron Yorston9e2a5662020-01-21 16:01:58 +00001826typedef const char *get_exe_name_t(int i) FAST_FUNC;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001827typedef struct line_input_t {
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001828 int flags;
Denys Vlasenko84ea60e2017-08-02 17:27:28 +02001829 int timeout;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001830 const char *path_lookup;
Ron Yorston9e2a5662020-01-21 16:01:58 +00001831# if ENABLE_FEATURE_TAB_COMPLETION \
1832&& (ENABLE_ASH || ENABLE_SH_IS_ASH || ENABLE_BASH_IS_ASH \
1833|| ENABLE_HUSH || ENABLE_SH_IS_HUSH || ENABLE_BASH_IS_HUSH \
1834)
1835 /* function to fetch additional application-specific names to match */
1836 get_exe_name_t *get_exe_name;
1837# define EDITING_HAS_get_exe_name 1
1838# endif
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001839# if MAX_HISTORY
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001840 int cnt_history;
1841 int cur_history;
Denys Vlasenko2c4de5b2011-03-31 13:16:52 +02001842 int max_history; /* must never be <= 0 */
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001843# if ENABLE_FEATURE_EDITING_SAVEHISTORY
Denys Vlasenkobede2152011-09-04 16:12:33 +02001844 /* meaning of this field depends on FEATURE_EDITING_SAVE_ON_EXIT:
1845 * if !FEATURE_EDITING_SAVE_ON_EXIT: "how many lines are
1846 * in on-disk history"
1847 * if FEATURE_EDITING_SAVE_ON_EXIT: "how many in-memory lines are
1848 * also in on-disk history (and thus need to be skipped on save)"
1849 */
Denis Vlasenko57abf9e2009-03-22 19:00:05 +00001850 unsigned cnt_history_in_file;
Denis Vlasenko57abf9e2009-03-22 19:00:05 +00001851 const char *hist_file;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001852# endif
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001853 char *history[MAX_HISTORY + 1];
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001854# endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001855} line_input_t;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001856enum {
Denys Vlasenkoe45af7a2011-09-04 16:15:24 +02001857 DO_HISTORY = 1 * (MAX_HISTORY > 0),
1858 TAB_COMPLETION = 2 * ENABLE_FEATURE_TAB_COMPLETION,
1859 USERNAME_COMPLETION = 4 * ENABLE_FEATURE_USERNAME_COMPLETION,
1860 VI_MODE = 8 * ENABLE_FEATURE_EDITING_VI,
1861 WITH_PATH_LOOKUP = 0x10,
1862 FOR_SHELL = DO_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001863};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001864line_input_t *new_line_input_t(int flags) FAST_FUNC;
Denys Vlasenkoa68a87c2018-12-06 11:12:38 +01001865void free_line_input_t(line_input_t *n) FAST_FUNC;
Denys Vlasenko046341e2011-02-04 17:53:59 +01001866/*
1867 * maxsize must be >= 2.
Denys Vlasenko5c2e81b2009-07-16 14:14:34 +02001868 * Returns:
Denis Vlasenko80667e32008-02-02 18:35:55 +00001869 * -1 on read errors or EOF, or on bare Ctrl-D,
1870 * 0 on ctrl-C (the line entered is still returned in 'command'),
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001871 * >0 length of input string, including terminating '\n'
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001872 */
Denys Vlasenko84ea60e2017-08-02 17:27:28 +02001873int read_line_input(line_input_t *st, const char *prompt, char *command, int maxsize) FAST_FUNC;
Flemming Madsend96ffda2013-04-07 18:47:24 +02001874void show_history(const line_input_t *st) FAST_FUNC;
Denys Vlasenkobede2152011-09-04 16:12:33 +02001875# if ENABLE_FEATURE_EDITING_SAVE_ON_EXIT
1876void save_history(line_input_t *st);
1877# endif
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001878#else
Denys Vlasenko36df0482009-10-19 16:07:28 +02001879#define MAX_HISTORY 0
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001880int read_line_input(const char* prompt, char* command, int maxsize) FAST_FUNC;
Denys Vlasenko84ea60e2017-08-02 17:27:28 +02001881#define read_line_input(state, prompt, command, maxsize) \
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001882 read_line_input(prompt, command, maxsize)
1883#endif
1884
Ron Yorston9e2a5662020-01-21 16:01:58 +00001885#ifndef EDITING_HAS_get_exe_name
1886# define EDITING_HAS_get_exe_name 0
1887#endif
1888
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001889
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001890#ifndef COMM_LEN
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001891# ifdef TASK_COMM_LEN
Denis Vlasenkofa076802006-11-05 00:38:51 +00001892enum { COMM_LEN = TASK_COMM_LEN };
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001893# else
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001894/* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
Denis Vlasenkofa076802006-11-05 00:38:51 +00001895enum { COMM_LEN = 16 };
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001896# endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001897#endif
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02001898
1899struct smaprec {
1900 unsigned long mapped_rw;
1901 unsigned long mapped_ro;
1902 unsigned long shared_clean;
1903 unsigned long shared_dirty;
1904 unsigned long private_clean;
1905 unsigned long private_dirty;
1906 unsigned long stack;
1907 unsigned long smap_pss, smap_swap;
1908 unsigned long smap_size;
Denys Vlasenkoaad76962018-12-30 20:24:59 +01001909 // For mixed 32/64 userspace, 32-bit pmap still needs
1910 // 64-bit field here to correctly show 64-bit processes:
1911 unsigned long long smap_start;
1912 // (strictly speaking, other fields need to be wider too,
1913 // but they are in kbytes, not bytes, and they hold sizes,
1914 // not start addresses, sizes tend to be less than 4 terabytes)
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02001915 char smap_mode[5];
1916 char *smap_name;
1917};
1918
1919#if !ENABLE_PMAP
1920#define procps_read_smaps(pid, total, cb, data) \
1921 procps_read_smaps(pid, total)
1922#endif
1923int FAST_FUNC procps_read_smaps(pid_t pid, struct smaprec *total,
Denys Vlasenko6830ade2013-01-15 13:58:01 +01001924 void (*cb)(struct smaprec *, void *), void *data);
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02001925
Denis Vlasenko512499c2007-08-26 18:23:13 +00001926typedef struct procps_status_t {
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001927 DIR *dir;
Denys Vlasenkob410d4a2009-09-19 22:29:42 +02001928 IF_FEATURE_SHOW_THREADS(DIR *task_dir;)
Denis Vlasenko512499c2007-08-26 18:23:13 +00001929 uint8_t shift_pages_to_bytes;
1930 uint8_t shift_pages_to_kb;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001931/* Fields are set to 0/NULL if failed to determine (or not requested) */
Denis Vlasenko3b3ca112008-07-17 18:39:36 +00001932 uint16_t argv_len;
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001933 char *argv0;
Alexander Shishkine766f622009-07-29 01:35:13 +02001934 char *exe;
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001935 IF_SELINUX(char *context;)
Lauri Kasanen6578f2c2010-12-05 05:22:29 +01001936 IF_FEATURE_SHOW_THREADS(unsigned main_thread_pid;)
Denis Vlasenko0696b8a2007-06-06 07:40:16 +00001937 /* Everything below must contain no ptrs to malloc'ed data:
1938 * it is memset(0) for each process in procps_scan() */
Denis Vlasenkofc1e9952007-08-29 18:23:36 +00001939 unsigned long vsz, rss; /* we round it to kbytes */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001940 unsigned long stime, utime;
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001941 unsigned long start_time;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001942 unsigned pid;
1943 unsigned ppid;
1944 unsigned pgid;
1945 unsigned sid;
1946 unsigned uid;
1947 unsigned gid;
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001948#if ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS
1949 unsigned ruid;
1950 unsigned rgid;
1951 int niceness;
1952#endif
Denis Vlasenko31789a82007-06-19 14:43:17 +00001953 unsigned tty_major,tty_minor;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001954#if ENABLE_FEATURE_TOPMEM
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02001955 struct smaprec smaps;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001956#endif
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001957 char state[4];
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001958 /* basename of executable in exec(2), read from /proc/N/stat
1959 * (if executable is symlink or script, it is NOT replaced
1960 * by link target or interpreter name) */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001961 char comm[COMM_LEN];
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001962 /* user/group? - use passwd/group parsing functions */
Denis Vlasenko17e7f042008-09-25 10:48:06 +00001963#if ENABLE_FEATURE_TOP_SMP_PROCESS
1964 int last_seen_on_cpu;
1965#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001966} procps_status_t;
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001967/* flag bits for procps_scan(xx, flags) calls */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001968enum {
1969 PSSCAN_PID = 1 << 0,
1970 PSSCAN_PPID = 1 << 1,
1971 PSSCAN_PGID = 1 << 2,
1972 PSSCAN_SID = 1 << 3,
1973 PSSCAN_UIDGID = 1 << 4,
1974 PSSCAN_COMM = 1 << 5,
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001975 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001976 PSSCAN_ARGV0 = 1 << 7,
Alexander Shishkine766f622009-07-29 01:35:13 +02001977 PSSCAN_EXE = 1 << 8,
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001978 PSSCAN_STATE = 1 << 9,
1979 PSSCAN_VSZ = 1 << 10,
1980 PSSCAN_RSS = 1 << 11,
1981 PSSCAN_STIME = 1 << 12,
1982 PSSCAN_UTIME = 1 << 13,
1983 PSSCAN_TTY = 1 << 14,
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001984 PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM,
Denis Vlasenko9f00e052009-02-14 01:36:11 +00001985 /* NB: used by find_pid_by_name(). Any applet using it
1986 * needs to be mentioned here. */
1987 PSSCAN_ARGVN = (1 << 16) * (ENABLE_KILLALL
1988 || ENABLE_PGREP || ENABLE_PKILL
1989 || ENABLE_PIDOF
Denis Vlasenko3266aa92009-04-01 11:24:04 +00001990 || ENABLE_SESTATUS
Denis Vlasenko9f00e052009-02-14 01:36:11 +00001991 ),
Denys Vlasenko4ff1ce02009-09-22 11:21:48 +02001992 PSSCAN_CONTEXT = (1 << 17) * ENABLE_SELINUX,
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001993 PSSCAN_START_TIME = 1 << 18,
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001994 PSSCAN_CPU = (1 << 19) * ENABLE_FEATURE_TOP_SMP_PROCESS,
1995 PSSCAN_NICE = (1 << 20) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1996 PSSCAN_RUIDGID = (1 << 21) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
Denys Vlasenkob410d4a2009-09-19 22:29:42 +02001997 PSSCAN_TASKS = (1 << 22) * ENABLE_FEATURE_SHOW_THREADS,
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001998};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001999//procps_status_t* alloc_procps_scan(void) FAST_FUNC;
2000void free_procps_scan(procps_status_t* sp) FAST_FUNC;
2001procps_status_t* procps_scan(procps_status_t* sp, int flags) FAST_FUNC;
Denys Vlasenko3a0f6f22009-09-12 00:15:34 +02002002/* Format cmdline (up to col chars) into char buf[size] */
Denis Vlasenko98ebab82007-06-30 14:47:41 +00002003/* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
Denys Vlasenko3a0f6f22009-09-12 00:15:34 +02002004void read_cmdline(char *buf, int size, unsigned pid, const char *comm) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00002005pid_t *find_pid_by_name(const char* procName) FAST_FUNC;
2006pid_t *pidlist_reverse(pid_t *pidList) FAST_FUNC;
Denys Vlasenkoc9b97502010-08-16 02:49:21 +02002007int starts_with_cpu(const char *str) FAST_FUNC;
2008unsigned get_cpu_count(void) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00002009
2010
Denys Vlasenkodd1061b2011-09-11 21:04:02 +02002011/* Use strict=1 if you process input from untrusted source:
2012 * it will return NULL on invalid %xx (bad hex chars)
2013 * and str + 1 if decoded char is / or NUL.
2014 * In non-strict mode, it always succeeds (returns str),
2015 * and also it additionally decoded '+' to space.
2016 */
2017char *percent_decode_in_place(char *str, int strict) FAST_FUNC;
2018
2019
Aurelien Jarnod3a42392012-07-24 16:28:34 +02002020extern const char bb_uuenc_tbl_base64[] ALIGN1;
2021extern const char bb_uuenc_tbl_std[] ALIGN1;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00002022void bb_uuencode(char *store, const void *s, int length, const char *tbl) FAST_FUNC;
Denys Vlasenko9fe98f72010-09-16 17:51:13 +02002023enum {
2024 BASE64_FLAG_UU_STOP = 0x100,
2025 /* Sign-extends to a value which never matches fgetc result: */
2026 BASE64_FLAG_NO_STOP_CHAR = 0x80,
2027};
Leonid Lisovskiy328f27f2011-10-28 13:59:04 +02002028const char *decode_base64(char **pp_dst, const char *src) FAST_FUNC;
2029void read_base64(FILE *src_stream, FILE *dst_stream, int flags) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00002030
Denis Vlasenkodd539f72006-11-01 20:20:37 +00002031typedef struct md5_ctx_t {
Denys Vlasenko302ad142010-10-19 02:16:12 +02002032 uint8_t wbuffer[64]; /* always correctly aligned for uint64_t */
2033 void (*process_block)(struct md5_ctx_t*) FAST_FUNC;
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02002034 uint64_t total64; /* must be directly before hash[] */
Denys Vlasenko302ad142010-10-19 02:16:12 +02002035 uint32_t hash[8]; /* 4 elements for md5, 5 for sha1, 8 for sha256 */
2036} md5_ctx_t;
2037typedef struct md5_ctx_t sha1_ctx_t;
2038typedef struct md5_ctx_t sha256_ctx_t;
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02002039typedef struct sha512_ctx_t {
2040 uint64_t total64[2]; /* must be directly before hash[] */
2041 uint64_t hash[8];
Denys Vlasenko302ad142010-10-19 02:16:12 +02002042 uint8_t wbuffer[128]; /* always correctly aligned for uint64_t */
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02002043} sha512_ctx_t;
Lauri Kasanenb8173b62013-01-14 05:20:50 +01002044typedef struct sha3_ctx_t {
2045 uint64_t state[25];
2046 unsigned bytes_queued;
Denys Vlasenko71a090f2016-08-29 14:05:25 +02002047 unsigned input_block_bytes;
Lauri Kasanenb8173b62013-01-14 05:20:50 +01002048} sha3_ctx_t;
Denys Vlasenko302ad142010-10-19 02:16:12 +02002049void md5_begin(md5_ctx_t *ctx) FAST_FUNC;
Denys Vlasenko2cfcc9e2013-01-20 00:38:09 +01002050void md5_hash(md5_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
Denys Vlasenko49ecee02017-01-24 16:00:54 +01002051unsigned md5_end(md5_ctx_t *ctx, void *resbuf) FAST_FUNC;
Denys Vlasenko302ad142010-10-19 02:16:12 +02002052void sha1_begin(sha1_ctx_t *ctx) FAST_FUNC;
2053#define sha1_hash md5_hash
Denys Vlasenko49ecee02017-01-24 16:00:54 +01002054unsigned sha1_end(sha1_ctx_t *ctx, void *resbuf) FAST_FUNC;
Denys Vlasenko302ad142010-10-19 02:16:12 +02002055void sha256_begin(sha256_ctx_t *ctx) FAST_FUNC;
2056#define sha256_hash md5_hash
2057#define sha256_end sha1_end
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02002058void sha512_begin(sha512_ctx_t *ctx) FAST_FUNC;
2059void sha512_hash(sha512_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
Denys Vlasenko49ecee02017-01-24 16:00:54 +01002060unsigned sha512_end(sha512_ctx_t *ctx, void *resbuf) FAST_FUNC;
Lauri Kasanenb8173b62013-01-14 05:20:50 +01002061void sha3_begin(sha3_ctx_t *ctx) FAST_FUNC;
2062void sha3_hash(sha3_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
Denys Vlasenko49ecee02017-01-24 16:00:54 +01002063unsigned sha3_end(sha3_ctx_t *ctx, void *resbuf) FAST_FUNC;
2064/* TLS benefits from knowing that sha1 and sha256 share these. Give them "agnostic" names too */
2065typedef struct md5_ctx_t md5sha_ctx_t;
2066#define md5sha_hash md5_hash
2067#define sha_end sha1_end
Denys Vlasenko9a2d8992020-07-20 00:04:33 +02002068enum {
2069 MD5_OUTSIZE = 16,
2070 SHA1_OUTSIZE = 20,
2071 SHA256_OUTSIZE = 32,
2072 SHA512_OUTSIZE = 64,
2073 SHA3_OUTSIZE = 28,
2074};
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00002075
Denys Vlasenko9ce642f2010-10-27 15:26:45 +02002076extern uint32_t *global_crc32_table;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00002077uint32_t *crc32_filltable(uint32_t *tbl256, int endian) FAST_FUNC;
Denys Vlasenkoddacb032018-02-01 10:56:19 +01002078uint32_t *crc32_new_table_le(void) FAST_FUNC;
2079uint32_t *global_crc32_new_table_le(void) FAST_FUNC;
Denys Vlasenko9ce642f2010-10-27 15:26:45 +02002080uint32_t crc32_block_endian1(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
2081uint32_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 +00002082
2083typedef struct masks_labels_t {
2084 const char *labels;
2085 const int masks[];
2086} masks_labels_t;
2087int print_flags_separated(const int *masks, const char *labels,
2088 int flags, const char *separator) FAST_FUNC;
2089int print_flags(const masks_labels_t *ml, int flags) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00002090
Magnus Dammf5914992009-11-08 16:34:43 +01002091typedef struct bb_progress_t {
Denys Vlasenkoab8d00d2011-02-11 19:09:30 +01002092 unsigned last_size;
2093 unsigned last_update_sec;
2094 unsigned last_change_sec;
Magnus Dammf5914992009-11-08 16:34:43 +01002095 unsigned start_sec;
Denys Vlasenkoedccc982018-02-13 16:48:52 +01002096 /*unsigned last_eta;*/
Denys Vlasenkod55e1392011-02-11 18:56:13 +01002097 const char *curfile;
Magnus Dammf5914992009-11-08 16:34:43 +01002098} bb_progress_t;
2099
Denys Vlasenkod55e1392011-02-11 18:56:13 +01002100#define is_bb_progress_inited(p) ((p)->curfile != NULL)
2101#define bb_progress_free(p) do { \
2102 if (ENABLE_UNICODE_SUPPORT) free((char*)((p)->curfile)); \
2103 (p)->curfile = NULL; \
2104} while (0)
2105void bb_progress_init(bb_progress_t *p, const char *curfile) FAST_FUNC;
Denys Vlasenko26602b82018-11-23 19:14:52 +01002106int bb_progress_update(bb_progress_t *p,
Denys Vlasenko805aa9f2011-02-10 14:25:51 +01002107 uoff_t beg_range,
2108 uoff_t transferred,
2109 uoff_t totalsize) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00002110
Sven Eisenbergb068cf22016-04-03 21:53:12 +02002111unsigned ubi_devnum_from_devname(const char *str) FAST_FUNC;
Denys Vlasenko6aab9922016-04-03 22:24:51 +02002112int ubi_get_volid_by_name(unsigned ubi_devnum, const char *vol_name) FAST_FUNC;
Sven Eisenbergb068cf22016-04-03 21:53:12 +02002113
Denys Vlasenkod55e1392011-02-11 18:56:13 +01002114
Denis Vlasenko8f8f2682006-10-03 21:00:43 +00002115extern const char *applet_name;
Denys Vlasenko0004e992010-09-01 12:01:17 +02002116
2117/* Some older linkers don't perform string merging, we used to have common strings
2118 * as global arrays to do it by hand. But:
2119 * (1) newer linkers do it themselves,
2120 * (2) however, they DONT merge string constants with global arrays,
2121 * even if the value is the same (!). Thus global arrays actually
2122 * increased size a bit: for example, "/etc/passwd" string from libc
2123 * wasn't merged with bb_path_passwd_file[] array!
2124 * Therefore now we use #defines.
2125 */
Bernhard Reutner-Fischer78e1d582008-01-13 17:52:53 +00002126/* "BusyBox vN.N.N (timestamp or extra_version)" */
Aurelien Jarnod3a42392012-07-24 16:28:34 +02002127extern const char bb_banner[] ALIGN1;
2128extern const char bb_msg_memory_exhausted[] ALIGN1;
2129extern const char bb_msg_invalid_date[] ALIGN1;
Denys Vlasenko0004e992010-09-01 12:01:17 +02002130#define bb_msg_read_error "read error"
2131#define bb_msg_write_error "write error"
Aurelien Jarnod3a42392012-07-24 16:28:34 +02002132extern const char bb_msg_unknown[] ALIGN1;
2133extern const char bb_msg_can_not_create_raw_socket[] ALIGN1;
2134extern const char bb_msg_perm_denied_are_you_root[] ALIGN1;
2135extern const char bb_msg_you_must_be_root[] ALIGN1;
2136extern const char bb_msg_requires_arg[] ALIGN1;
Denys Vlasenko0f296a32015-10-14 13:21:01 +02002137extern const char bb_msg_invalid_arg_to[] ALIGN1;
Aurelien Jarnod3a42392012-07-24 16:28:34 +02002138extern const char bb_msg_standard_input[] ALIGN1;
2139extern const char bb_msg_standard_output[] ALIGN1;
Manuel Novoa III cad53642003-03-19 09:13:01 +00002140
Denis Vlasenko98c0bba2007-01-26 23:31:05 +00002141/* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
Aurelien Jarnod3a42392012-07-24 16:28:34 +02002142extern const char bb_hexdigits_upcase[] ALIGN1;
Denis Vlasenko7ca39212006-11-21 20:34:21 +00002143
Aurelien Jarnod3a42392012-07-24 16:28:34 +02002144extern const char bb_path_wtmp_file[] ALIGN1;
Denys Vlasenko0004e992010-09-01 12:01:17 +02002145
2146/* Busybox mount uses either /proc/mounts or /etc/mtab to
2147 * get the list of currently mounted filesystems */
2148#define bb_path_mtab_file IF_FEATURE_MTAB_SUPPORT("/etc/mtab")IF_NOT_FEATURE_MTAB_SUPPORT("/proc/mounts")
2149
Tito Ragusaad3d72f2011-01-16 23:39:45 +01002150#define bb_path_passwd_file _PATH_PASSWD
2151#define bb_path_group_file _PATH_GROUP
2152#define bb_path_shadow_file _PATH_SHADOW
2153#define bb_path_gshadow_file _PATH_GSHADOW
Denys Vlasenko0004e992010-09-01 12:01:17 +02002154
2155#define bb_path_motd_file "/etc/motd"
2156
2157#define bb_dev_null "/dev/null"
Aurelien Jarnod3a42392012-07-24 16:28:34 +02002158extern const char bb_busybox_exec_path[] ALIGN1;
Denys Vlasenkocca7c612018-01-12 13:21:33 +01002159/* allow default system PATH to be extended via CFLAGS */
2160#ifndef BB_ADDITIONAL_PATH
2161#define BB_ADDITIONAL_PATH ""
2162#endif
2163#define BB_PATH_ROOT_PATH "PATH=/sbin:/usr/sbin:/bin:/usr/bin" BB_ADDITIONAL_PATH
2164extern const char bb_PATH_root_path[] ALIGN1; /* BB_PATH_ROOT_PATH */
Denis Vlasenkof5f75c52007-06-12 22:35:19 +00002165#define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
Denys Vlasenkocca7c612018-01-12 13:21:33 +01002166/* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
2167 * but I want to save a few bytes here:
2168 */
Denis Vlasenkof5f75c52007-06-12 22:35:19 +00002169#define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +00002170
Denis Vlasenko703e2022007-01-22 14:12:08 +00002171extern const int const_int_0;
Denys Vlasenkoc52cbea2015-08-24 19:48:03 +02002172//extern const int const_int_1;
Denis Vlasenko703e2022007-01-22 14:12:08 +00002173
Denis Vlasenko972288e2007-03-15 00:57:01 +00002174/* This struct is deliberately not defined. */
2175/* See docs/keep_data_small.txt */
2176struct globals;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00002177/* '*const' ptr makes gcc optimize code much better.
Denis Vlasenkoe3241842007-08-13 10:36:25 +00002178 * Magic prevents ptr_to_globals from going into rodata.
Denis Vlasenko574f2f42008-02-27 18:41:59 +00002179 * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
Denis Vlasenkobff32ce2007-03-15 19:48:35 +00002180extern struct globals *const ptr_to_globals;
Denys Vlasenkoaf7169b2019-10-25 12:12:22 +02002181
2182#if defined(__clang_major__) && __clang_major__ >= 9
2183/* Clang/llvm drops assignment to "constant" storage. Silently.
2184 * Needs serious convincing to not eliminate the store.
2185 */
2186static ALWAYS_INLINE void* not_const_pp(const void *p)
2187{
2188 void *pp;
2189 __asm__ __volatile__(
2190 "# forget that p points to const"
2191 : /*outputs*/ "=r" (pp)
2192 : /*inputs*/ "0" (p)
2193 );
2194 return pp;
2195}
2196#else
2197static ALWAYS_INLINE void* not_const_pp(const void *p) { return (void*)p; }
2198#endif
2199
Denis Vlasenko574f2f42008-02-27 18:41:59 +00002200/* At least gcc 3.4.6 on mipsel system needs optimization barrier */
Bernhard Reutner-Fischer797c96d2008-06-06 10:31:39 +00002201#define barrier() __asm__ __volatile__("":::"memory")
Denis Vlasenko574f2f42008-02-27 18:41:59 +00002202#define SET_PTR_TO_GLOBALS(x) do { \
Denys Vlasenkoaf7169b2019-10-25 12:12:22 +02002203 (*(struct globals**)not_const_pp(&ptr_to_globals)) = (void*)(x); \
Denis Vlasenko574f2f42008-02-27 18:41:59 +00002204 barrier(); \
2205} while (0)
Denys Vlasenkoaf7169b2019-10-25 12:12:22 +02002206
Guilherme Maciel Ferreira840ef172013-10-16 14:43:30 +02002207#define FREE_PTR_TO_GLOBALS() do { \
2208 if (ENABLE_FEATURE_CLEAN_UP) { \
2209 free(ptr_to_globals); \
2210 } \
2211} while (0)
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00002212
Denis Vlasenkodca0b702006-10-27 09:05:02 +00002213/* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
2214 * use bb_default_login_shell and following defines.
2215 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
2216 * don't forget to change increment constant. */
Ladislav Michla73b87e2010-06-27 03:23:31 +02002217#define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
Aurelien Jarnod3a42392012-07-24 16:28:34 +02002218extern const char bb_default_login_shell[] ALIGN1;
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00002219/* "/bin/sh" */
Ladislav Michla73b87e2010-06-27 03:23:31 +02002220#define DEFAULT_SHELL (bb_default_login_shell+1)
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00002221/* "sh" */
Ladislav Michla73b87e2010-06-27 03:23:31 +02002222#define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00002223
Jeremie Koenig816ed972010-05-27 15:46:29 +02002224/* The following devices are the same on all systems. */
2225#define CURRENT_TTY "/dev/tty"
2226#define DEV_CONSOLE "/dev/console"
2227
2228#if defined(__FreeBSD_kernel__)
2229# define CURRENT_VC CURRENT_TTY
2230# define VC_1 "/dev/ttyv0"
2231# define VC_2 "/dev/ttyv1"
2232# define VC_3 "/dev/ttyv2"
2233# define VC_4 "/dev/ttyv3"
2234# define VC_5 "/dev/ttyv4"
2235# define VC_FORMAT "/dev/ttyv%d"
2236#elif defined(__GNU__)
2237# define CURRENT_VC CURRENT_TTY
2238# define VC_1 "/dev/tty1"
2239# define VC_2 "/dev/tty2"
2240# define VC_3 "/dev/tty3"
2241# define VC_4 "/dev/tty4"
2242# define VC_5 "/dev/tty5"
2243# define VC_FORMAT "/dev/tty%d"
Denys Vlasenko1c26e052010-10-24 02:35:17 +02002244#elif ENABLE_FEATURE_DEVFS
2245/*Linux, obsolete devfs names */
Matt Kraai439e3df2001-07-23 14:52:08 +00002246# define CURRENT_VC "/dev/vc/0"
2247# define VC_1 "/dev/vc/1"
2248# define VC_2 "/dev/vc/2"
2249# define VC_3 "/dev/vc/3"
2250# define VC_4 "/dev/vc/4"
2251# define VC_5 "/dev/vc/5"
Matt Kraai439e3df2001-07-23 14:52:08 +00002252# define VC_FORMAT "/dev/vc/%d"
Denys Vlasenko4928e9f2013-06-27 03:45:16 +02002253# define LOOP_FORMAT "/dev/loop/%u"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00002254# define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00002255# define LOOP_NAME "/dev/loop/"
Eric Andersen5f284552003-11-14 03:11:29 +00002256# define FB_0 "/dev/fb/0"
Matt Kraai439e3df2001-07-23 14:52:08 +00002257#else
Denys Vlasenko1c26e052010-10-24 02:35:17 +02002258/*Linux, normal names */
Matt Kraai439e3df2001-07-23 14:52:08 +00002259# define CURRENT_VC "/dev/tty0"
2260# define VC_1 "/dev/tty1"
2261# define VC_2 "/dev/tty2"
2262# define VC_3 "/dev/tty3"
2263# define VC_4 "/dev/tty4"
2264# define VC_5 "/dev/tty5"
Matt Kraai439e3df2001-07-23 14:52:08 +00002265# define VC_FORMAT "/dev/tty%d"
Denys Vlasenko4928e9f2013-06-27 03:45:16 +02002266# define LOOP_FORMAT "/dev/loop%u"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00002267# define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00002268# define LOOP_NAME "/dev/loop"
Eric Andersen5f284552003-11-14 03:11:29 +00002269# define FB_0 "/dev/fb0"
Matt Kraai439e3df2001-07-23 14:52:08 +00002270#endif
2271
Denys Vlasenkoabfa3ec2018-09-28 15:13:04 +02002272// storage helpers for mk*fs utilities
2273char BUG_wrong_field_size(void);
2274#define STORE_LE(field, value) \
2275do { \
2276 if (sizeof(field) == 4) \
2277 field = SWAP_LE32((uint32_t)(value)); \
2278 else if (sizeof(field) == 2) \
2279 field = SWAP_LE16((uint16_t)(value)); \
2280 else if (sizeof(field) == 1) \
2281 field = (uint8_t)(value); \
2282 else \
2283 BUG_wrong_field_size(); \
2284} while (0)
2285
2286#define FETCH_LE32(field) \
2287 (sizeof(field) == 4 ? SWAP_LE32(field) : BUG_wrong_field_size())
2288
Rob Landleyc57ec372006-04-10 17:07:15 +00002289
Denys Vlasenko9d57a802009-10-23 14:24:44 +02002290#define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
Denys Vlasenkoab3964d2015-10-13 14:50:20 +02002291#define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
Denys Vlasenko9d57a802009-10-23 14:24:44 +02002292
Rob Landleyb623a542006-05-31 22:09:03 +00002293
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02002294/* We redefine ctype macros. Unicode-correct handling of char types
2295 * can't be done with such byte-oriented operations anyway,
2296 * we don't lose anything.
2297 */
Rob Landley4ae905a2006-07-06 17:22:54 +00002298#undef isalnum
2299#undef isalpha
2300#undef isascii
2301#undef isblank
2302#undef iscntrl
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02002303#undef isdigit
Rob Landley4ae905a2006-07-06 17:22:54 +00002304#undef isgraph
2305#undef islower
2306#undef isprint
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02002307#undef ispunct
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02002308#undef isspace
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02002309#undef isupper
2310#undef isxdigit
2311#undef toupper
2312#undef tolower
Rob Landley4ae905a2006-07-06 17:22:54 +00002313
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02002314/* We save ~500 bytes on isdigit alone.
Denys Vlasenko7b4cd6f2009-10-23 02:22:03 +02002315 * BTW, x86 likes (unsigned char) cast more than (unsigned). */
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01002316
2317/* These work the same for ASCII and Unicode,
2318 * assuming no one asks "is this a *Unicode* letter?" using isalpha(letter) */
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02002319#define isascii(a) ((unsigned char)(a) <= 0x7f)
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01002320#define isdigit(a) ((unsigned char)((a) - '0') <= 9)
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02002321#define isupper(a) ((unsigned char)((a) - 'A') <= ('Z' - 'A'))
2322#define islower(a) ((unsigned char)((a) - 'a') <= ('z' - 'a'))
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02002323#define isalpha(a) ((unsigned char)(((a)|0x20) - 'a') <= ('z' - 'a'))
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02002324#define isblank(a) ({ unsigned char bb__isblank = (a); bb__isblank == ' ' || bb__isblank == '\t'; })
2325#define iscntrl(a) ({ unsigned char bb__iscntrl = (a); bb__iscntrl < ' ' || bb__iscntrl == 0x7f; })
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02002326/* In POSIX/C locale isspace is only these chars: "\t\n\v\f\r" and space.
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02002327 * "\t\n\v\f\r" happen to have ASCII codes 9,10,11,12,13.
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02002328 */
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02002329#define isspace(a) ({ unsigned char bb__isspace = (a) - 9; bb__isspace == (' ' - 9) || bb__isspace <= (13 - 9); })
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01002330// Unsafe wrt NUL: #define ispunct(a) (strchr("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a)) != NULL)
2331#define ispunct(a) (strchrnul("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a))[0])
2332// 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 +02002333#define isalnum(a) bb_ascii_isalnum(a)
2334static ALWAYS_INLINE int bb_ascii_isalnum(unsigned char a)
2335{
2336 unsigned char b = a - '0';
2337 if (b <= 9)
2338 return (b <= 9);
2339 b = (a|0x20) - 'a';
2340 return b <= 'z' - 'a';
2341}
2342#define isxdigit(a) bb_ascii_isxdigit(a)
2343static ALWAYS_INLINE int bb_ascii_isxdigit(unsigned char a)
2344{
2345 unsigned char b = a - '0';
2346 if (b <= 9)
2347 return (b <= 9);
2348 b = (a|0x20) - 'a';
2349 return b <= 'f' - 'a';
2350}
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02002351#define toupper(a) bb_ascii_toupper(a)
2352static ALWAYS_INLINE unsigned char bb_ascii_toupper(unsigned char a)
2353{
2354 unsigned char b = a - 'a';
2355 if (b <= ('z' - 'a'))
2356 a -= 'a' - 'A';
2357 return a;
2358}
2359#define tolower(a) bb_ascii_tolower(a)
2360static ALWAYS_INLINE unsigned char bb_ascii_tolower(unsigned char a)
2361{
2362 unsigned char b = a - 'A';
2363 if (b <= ('Z' - 'A'))
2364 a += 'a' - 'A';
2365 return a;
2366}
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02002367
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01002368/* In ASCII and Unicode, these are likely to be very different.
2369 * Let's prevent ambiguous usage from the start */
2370#define isgraph(a) isgraph_is_ambiguous_dont_use(a)
2371#define isprint(a) isprint_is_ambiguous_dont_use(a)
2372/* NB: must not treat EOF as isgraph or isprint */
2373#define isgraph_asciionly(a) ((unsigned)((a) - 0x21) <= 0x7e - 0x21)
2374#define isprint_asciionly(a) ((unsigned)((a) - 0x20) <= 0x7e - 0x20)
2375
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02002376
Bartosz Golaszewski3ed81cf2014-06-22 16:30:41 +02002377/* Simple unit-testing framework */
2378
2379typedef void (*bbunit_testfunc)(void);
2380
2381struct bbunit_listelem {
Bartosz Golaszewski3ed81cf2014-06-22 16:30:41 +02002382 const char* name;
2383 bbunit_testfunc testfunc;
2384};
2385
2386void bbunit_registertest(struct bbunit_listelem* test);
2387void bbunit_settestfailed(void);
2388
2389#define BBUNIT_DEFINE_TEST(NAME) \
2390 static void bbunit_##NAME##_test(void); \
2391 static struct bbunit_listelem bbunit_##NAME##_elem = { \
2392 .name = #NAME, \
2393 .testfunc = bbunit_##NAME##_test, \
2394 }; \
Bartosz Golaszewskibf0f2c72014-06-26 14:31:05 +02002395 static void INIT_FUNC bbunit_##NAME##_register(void) \
Bartosz Golaszewski3ed81cf2014-06-22 16:30:41 +02002396 { \
2397 bbunit_registertest(&bbunit_##NAME##_elem); \
2398 } \
2399 static void bbunit_##NAME##_test(void)
2400
2401/*
2402 * Both 'goto bbunit_end' and 'break' are here only to get rid
2403 * of compiler warnings.
2404 */
2405#define BBUNIT_ENDTEST \
2406 do { \
2407 goto bbunit_end; \
2408 bbunit_end: \
2409 break; \
2410 } while (0)
2411
2412#define BBUNIT_PRINTASSERTFAIL \
2413 do { \
2414 bb_error_msg( \
2415 "[ERROR] Assertion failed in file %s, line %d", \
2416 __FILE__, __LINE__); \
2417 } while (0)
2418
2419#define BBUNIT_ASSERTION_FAILED \
2420 do { \
2421 bbunit_settestfailed(); \
2422 goto bbunit_end; \
2423 } while (0)
2424
2425/*
2426 * Assertions.
2427 * For now we only offer assertions which cause tests to fail
2428 * immediately. In the future 'expects' might be added too -
2429 * similar to those offered by the gtest framework.
2430 */
2431#define BBUNIT_ASSERT_EQ(EXPECTED, ACTUAL) \
2432 do { \
2433 if ((EXPECTED) != (ACTUAL)) { \
2434 BBUNIT_PRINTASSERTFAIL; \
2435 bb_error_msg("[ERROR] '%s' isn't equal to '%s'", \
2436 #EXPECTED, #ACTUAL); \
2437 BBUNIT_ASSERTION_FAILED; \
2438 } \
2439 } while (0)
2440
2441#define BBUNIT_ASSERT_NOTEQ(EXPECTED, ACTUAL) \
2442 do { \
2443 if ((EXPECTED) == (ACTUAL)) { \
2444 BBUNIT_PRINTASSERTFAIL; \
2445 bb_error_msg("[ERROR] '%s' is equal to '%s'", \
2446 #EXPECTED, #ACTUAL); \
2447 BBUNIT_ASSERTION_FAILED; \
2448 } \
2449 } while (0)
2450
2451#define BBUNIT_ASSERT_NOTNULL(PTR) \
2452 do { \
2453 if ((PTR) == NULL) { \
2454 BBUNIT_PRINTASSERTFAIL; \
2455 bb_error_msg("[ERROR] '%s' is NULL!", #PTR); \
2456 BBUNIT_ASSERTION_FAILED; \
2457 } \
2458 } while (0)
2459
2460#define BBUNIT_ASSERT_NULL(PTR) \
2461 do { \
2462 if ((PTR) != NULL) { \
2463 BBUNIT_PRINTASSERTFAIL; \
2464 bb_error_msg("[ERROR] '%s' is not NULL!", #PTR); \
2465 BBUNIT_ASSERTION_FAILED; \
2466 } \
2467 } while (0)
2468
2469#define BBUNIT_ASSERT_FALSE(STATEMENT) \
2470 do { \
2471 if ((STATEMENT)) { \
2472 BBUNIT_PRINTASSERTFAIL; \
2473 bb_error_msg("[ERROR] Statement '%s' evaluated to true!", \
2474 #STATEMENT); \
2475 BBUNIT_ASSERTION_FAILED; \
2476 } \
2477 } while (0)
2478
2479#define BBUNIT_ASSERT_TRUE(STATEMENT) \
2480 do { \
2481 if (!(STATEMENT)) { \
2482 BBUNIT_PRINTASSERTFAIL; \
2483 bb_error_msg("[ERROR] Statement '%s' evaluated to false!", \
2484 #STATEMENT); \
2485 BBUNIT_ASSERTION_FAILED; \
2486 } \
2487 } while (0)
2488
2489#define BBUNIT_ASSERT_STREQ(STR1, STR2) \
2490 do { \
2491 if (strcmp(STR1, STR2) != 0) { \
2492 BBUNIT_PRINTASSERTFAIL; \
2493 bb_error_msg("[ERROR] Strings '%s' and '%s' " \
2494 "are not the same", STR1, STR2); \
2495 BBUNIT_ASSERTION_FAILED; \
2496 } \
2497 } while (0)
2498
2499#define BBUNIT_ASSERT_STRNOTEQ(STR1, STR2) \
2500 do { \
2501 if (strcmp(STR1, STR2) == 0) { \
2502 BBUNIT_PRINTASSERTFAIL; \
2503 bb_error_msg("[ERROR] Strings '%s' and '%s' " \
2504 "are the same, but were " \
2505 "expected to differ", STR1, STR2); \
2506 BBUNIT_ASSERTION_FAILED; \
2507 } \
2508 } while (0)
2509
2510
Denis Vlasenkof81e8db2009-04-09 12:35:13 +00002511POP_SAVED_FUNCTION_VISIBILITY
2512
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +00002513#endif