blob: d05ac29769b04c673ea98854ac0f744fe713b7ee [file] [log] [blame]
Eric Andersenaad1a882001-03-16 22:47:14 +00001/* vi: set sw=4 ts=4: */
2/*
3 * Busybox main internal header file
4 *
Eric Andersenc7bda1c2004-03-15 08:29:22 +00005 * Based in part on code from sash, Copyright (c) 1999 by David I. Bell
Denys Vlasenko0ef64bd2010-08-16 20:14:46 +02006 * Permission has been granted to redistribute this code under GPL.
Denis Vlasenkof7996f32007-01-11 17:20:00 +00007 *
Denys Vlasenko0ef64bd2010-08-16 20:14:46 +02008 * Licensed under GPLv2, see file LICENSE in this source tree.
Eric Andersenaad1a882001-03-16 22:47:14 +00009 */
Denis Vlasenkof81e8db2009-04-09 12:35:13 +000010#ifndef LIBBB_H
11#define LIBBB_H 1
Eric Andersenaad1a882001-03-16 22:47:14 +000012
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +000013#include "platform.h"
14
Rob Landley5d9c42a2006-06-24 17:55:02 +000015#include <ctype.h>
Rob Landleyb623a542006-05-31 22:09:03 +000016#include <dirent.h>
Rob Landleyc9c1a412006-07-12 19:17:55 +000017#include <errno.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000018#include <fcntl.h>
Rob Landleyb623a542006-05-31 22:09:03 +000019#include <inttypes.h>
20#include <netdb.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000021#include <setjmp.h>
Rob Landley1cca9482006-07-10 19:45:20 +000022#include <signal.h>
Kylie McClain40eea692016-02-01 01:36:05 +010023#include <paths.h>
Denys Vlasenko89f5bfd2011-05-12 23:03:18 +020024#if defined __UCLIBC__ /* TODO: and glibc? */
25/* use inlined versions of these: */
26# define sigfillset(s) __sigfillset(s)
27# define sigemptyset(s) __sigemptyset(s)
28# define sigisemptyset(s) __sigisemptyset(s)
29#endif
Denys Vlasenko5b9b1362010-02-02 03:08:57 +010030#include <stdint.h>
Eric Andersenaad1a882001-03-16 22:47:14 +000031#include <stdio.h>
Manuel Novoa III 68474f32004-02-05 14:45:58 +000032#include <stdlib.h>
Eric Andersenaad1a882001-03-16 22:47:14 +000033#include <stdarg.h>
Denis Vlasenko4b4b6192007-03-18 20:33:26 +000034#include <stddef.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000035#include <string.h>
Thomas Petazzoniaf4f0e42013-10-16 19:59:45 +020036/* There are two incompatible basename's, let's not use them! */
Denys Vlasenkod48fdde2011-09-10 13:48:34 +020037/* See the dirname/basename man page for details */
38#include <libgen.h> /* dirname,basename */
39#undef basename
40#define basename dont_use_basename
Thomas Petazzoniaf4f0e42013-10-16 19:59:45 +020041#include <poll.h>
Rob Landleyc9c1a412006-07-12 19:17:55 +000042#include <sys/ioctl.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000043#include <sys/mman.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000044#include <sys/socket.h>
"Vladimir N. Oleynik"7fe65202005-09-20 10:02:36 +000045#include <sys/stat.h>
Rob Landley299a6b42006-05-27 21:42:58 +000046#include <sys/time.h>
Rob Landleyb623a542006-05-31 22:09:03 +000047#include <sys/types.h>
Denys Vlasenkodd807c12011-02-07 14:58:57 +010048#ifndef major
49# include <sys/sysmacros.h>
50#endif
Rob Landleyc9c1a412006-07-12 19:17:55 +000051#include <sys/wait.h>
Rob Landleyb623a542006-05-31 22:09:03 +000052#include <termios.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000053#include <time.h>
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000054#include <sys/param.h>
Denys Vlasenkoa76dd502012-01-08 16:11:38 +010055#include <pwd.h>
56#include <grp.h>
Denys Vlasenko3e0c4282012-01-08 16:13:55 +010057#if ENABLE_FEATURE_SHADOWPASSWDS
58# if !ENABLE_USE_BB_SHADOW
59/* If using busybox's shadow implementation, do not include the shadow.h
60 * header as the toolchain may not provide it at all.
61 */
62# include <shadow.h>
63# endif
64#endif
Denys Vlasenkoa76dd502012-01-08 16:11:38 +010065#if defined(ANDROID) || defined(__ANDROID__)
66# define endpwent() ((void)0)
67# define endgrent() ((void)0)
68#endif
Mike Frysinger22876c72008-02-07 22:10:07 +000069#ifdef HAVE_MNTENT_H
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +020070# include <mntent.h>
Mike Frysinger22876c72008-02-07 22:10:07 +000071#endif
Mike Frysinger9412ec72008-02-07 22:41:33 +000072#ifdef HAVE_SYS_STATFS_H
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +020073# include <sys/statfs.h>
Mike Frysinger9412ec72008-02-07 22:41:33 +000074#endif
Denys Vlasenko67905e22011-07-26 13:42:12 +020075/* Don't do this here:
76 * #include <sys/sysinfo.h>
77 * Some linux/ includes pull in conflicting definition
78 * of struct sysinfo (only in some toolchanins), which breaks build.
79 * Include sys/sysinfo.h only in those files which need it.
80 */
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000081#if ENABLE_SELINUX
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +020082# include <selinux/selinux.h>
83# include <selinux/context.h>
84# include <selinux/flask.h>
85# include <selinux/av_permissions.h>
Eric Andersen9e480452003-07-03 10:07:04 +000086#endif
Denys Vlasenko8d0e0cd2011-01-25 23:21:46 +010087#if ENABLE_FEATURE_UTMP
Bernhard Reutner-Fischer7d863842015-04-19 23:45:17 +020088# if defined __UCLIBC__ && ( \
89 (UCLIBC_VERSION >= KERNEL_VERSION(0, 9, 32) \
90 && UCLIBC_VERSION < KERNEL_VERSION(0, 9, 34) \
91 && defined __UCLIBC_HAS_UTMPX__ \
92 ) || ( \
93 UCLIBC_VERSION >= KERNEL_VERSION(0, 9, 34) \
94 ) \
95 )
96# include <utmpx.h>
97# elif defined __UCLIBC__
98# include <utmp.h>
99# define utmpx utmp
100# define setutxent setutent
101# define endutxent endutent
102# define getutxent getutent
103# define getutxid getutid
104# define getutxline getutline
105# define pututxline pututline
106# define utmpxname utmpname
107# define updwtmpx updwtmp
108# define _PATH_UTMPX _PATH_UTMP
109# else
Kylie McClain40eea692016-02-01 01:36:05 +0100110# include <utmp.h>
Bernhard Reutner-Fischer7d863842015-04-19 23:45:17 +0200111# include <utmpx.h>
Kylie McClain40eea692016-02-01 01:36:05 +0100112# if defined _PATH_UTMP && !defined _PATH_UTMPX
113# define _PATH_UTMPX _PATH_UTMP
114# endif
Bernhard Reutner-Fischer7d863842015-04-19 23:45:17 +0200115# endif
Denys Vlasenko8d0e0cd2011-01-25 23:21:46 +0100116#endif
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000117#if ENABLE_LOCALE_SUPPORT
Denys Vlasenko9d57a802009-10-23 14:24:44 +0200118# include <locale.h>
Rob Landleyeb84a422006-09-20 21:41:13 +0000119#else
Denys Vlasenko9d57a802009-10-23 14:24:44 +0200120# define setlocale(x,y) ((void)0)
Rob Landleyd921b2e2006-08-03 15:41:12 +0000121#endif
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000122#ifdef DMALLOC
Denys Vlasenko9d57a802009-10-23 14:24:44 +0200123# include <dmalloc.h>
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000124#endif
Tito Ragusaad3d72f2011-01-16 23:39:45 +0100125/* Just in case libc doesn't define some of these... */
126#ifndef _PATH_PASSWD
127#define _PATH_PASSWD "/etc/passwd"
128#endif
129#ifndef _PATH_GROUP
130#define _PATH_GROUP "/etc/group"
131#endif
132#ifndef _PATH_SHADOW
133#define _PATH_SHADOW "/etc/shadow"
134#endif
135#ifndef _PATH_GSHADOW
136#define _PATH_GSHADOW "/etc/gshadow"
137#endif
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +0200138#if defined __FreeBSD__ || defined __OpenBSD__
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +0100139# include <netinet/in.h>
140# include <arpa/inet.h>
141#elif defined __APPLE__
142# include <netinet/in.h>
143#else
144# include <arpa/inet.h>
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#endif
Chris Rees330718e2011-01-24 17:07:06 +0100154#ifndef HAVE_CLEARENV
155# define clearenv() do { if (environ) environ[0] = NULL; } while (0)
156#endif
157#ifndef HAVE_FDATASYNC
158# define fdatasync fsync
159#endif
160#ifndef HAVE_XTABS
161# define XTABS TAB3
162#endif
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +0100163
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000164
Denis Vlasenkoaf6cca52008-05-25 04:31:54 +0000165/* Some libc's forget to declare these, do it ourself */
Denis Vlasenko847fa772008-01-28 22:45:43 +0000166
Denis Vlasenkocac0f5b2008-09-25 10:20:46 +0000167extern char **environ;
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000168#if defined(__GLIBC__) && __GLIBC__ < 2
169int vdprintf(int d, const char *format, va_list ap);
Rob Landley362dc2b2006-06-05 17:35:24 +0000170#endif
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000171/* klogctl is in libc's klog.h, but we cheat and not #include that */
172int klogctl(int type, char *b, int len);
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +0100173#ifndef PATH_MAX
174# define PATH_MAX 256
175#endif
176#ifndef BUFSIZ
177# define BUFSIZ 4096
178#endif
Rob Landley362dc2b2006-06-05 17:35:24 +0000179
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000180
Denys Vlasenko0c4cf422011-06-30 02:44:27 +0200181/* Busybox does not use threads, we can speed up stdio. */
Dan Fandrich75214cf2011-06-30 02:59:17 +0200182#ifdef HAVE_UNLOCKED_STDIO
183# undef getc
184# define getc(stream) getc_unlocked(stream)
185# undef getchar
186# define getchar() getchar_unlocked()
187# undef putc
188# define putc(c, stream) putc_unlocked(c, stream)
189# undef putchar
190# define putchar(c) putchar_unlocked(c)
191# undef fgetc
192# define fgetc(stream) getc_unlocked(stream)
193# undef fputc
194# define fputc(c, stream) putc_unlocked(c, stream)
195#endif
Denys Vlasenko0c4cf422011-06-30 02:44:27 +0200196/* Above functions are required by POSIX.1-2008, below ones are extensions */
Dan Fandrich75214cf2011-06-30 02:59:17 +0200197#ifdef HAVE_UNLOCKED_LINE_OPS
198# undef fgets
199# define fgets(s, n, stream) fgets_unlocked(s, n, stream)
200# undef fputs
201# define fputs(s, stream) fputs_unlocked(s, stream)
202#endif
Denys Vlasenko06448912011-06-20 10:06:28 +0200203
204
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000205/* Make all declarations hidden (-fvisibility flag only affects definitions) */
206/* (don't include system headers after this until corresponding pop!) */
Denis Vlasenkof81e8db2009-04-09 12:35:13 +0000207PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000208
209
210#if ENABLE_USE_BB_PWD_GRP
211# include "pwd_.h"
212# include "grp_.h"
213#endif
214#if ENABLE_FEATURE_SHADOWPASSWDS
215# if ENABLE_USE_BB_SHADOW
216# include "shadow_.h"
217# endif
218#endif
219
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000220/* Tested to work correctly with all int types (IIRC :]) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000221#define MAXINT(T) (T)( \
222 ((T)-1) > 0 \
223 ? (T)-1 \
224 : (T)~((T)1 << (sizeof(T)*8-1)) \
225 )
226
227#define MININT(T) (T)( \
228 ((T)-1) > 0 \
229 ? (T)0 \
230 : ((T)1 << (sizeof(T)*8-1)) \
231 )
Denis Vlasenko7039a662006-10-08 17:54:47 +0000232
Denis Vlasenko56254152006-10-07 16:24:46 +0000233/* Large file support */
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000234/* Note that CONFIG_LFS=y forces bbox to be built with all common ops
Denis Vlasenko7039a662006-10-08 17:54:47 +0000235 * (stat, lseek etc) mapped to "largefile" variants by libc.
236 * Practically it means that open() automatically has O_LARGEFILE added
237 * and all filesize/file_offset parameters and struct members are "large"
238 * (in today's world - signed 64bit). For full support of large files,
239 * we need a few helper #defines (below) and careful use of off_t
240 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000241#if ENABLE_LFS
Denis Vlasenko7039a662006-10-08 17:54:47 +0000242/* CONFIG_LFS is on */
243# if ULONG_MAX > 0xffffffff
244/* "long" is long enough on this system */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000245typedef unsigned long uoff_t;
Denys Vlasenkof59a50e2011-11-16 21:30:19 +0100246# define XATOOFF(a) xatoul_range((a), 0, LONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000247/* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
248# define BB_STRTOOFF bb_strtoul
249# define STRTOOFF strtoul
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000250/* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
251# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000252# else
Denis Vlasenkocba9ef52006-10-10 21:00:47 +0000253/* "long" is too short, need "long long" */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000254typedef unsigned long long uoff_t;
Denys Vlasenkof59a50e2011-11-16 21:30:19 +0100255# define XATOOFF(a) xatoull_range((a), 0, LLONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000256# define BB_STRTOOFF bb_strtoull
257# define STRTOOFF strtoull
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000258# define OFF_FMT "ll"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000259# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000260#else
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000261/* CONFIG_LFS is off */
262# if UINT_MAX == 0xffffffff
263/* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
264 * gcc will throw warnings on printf("%d", off_t). Crap... */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000265typedef unsigned long uoff_t;
Denys Vlasenko77832482010-08-12 14:14:45 +0200266# define XATOOFF(a) xatoi_positive(a)
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000267# define BB_STRTOOFF bb_strtou
Denis Vlasenko7039a662006-10-08 17:54:47 +0000268# define STRTOOFF strtol
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000269# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000270# else
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000271typedef unsigned long uoff_t;
Denys Vlasenkof59a50e2011-11-16 21:30:19 +0100272# define XATOOFF(a) xatoul_range((a), 0, LONG_MAX)
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000273# define BB_STRTOOFF bb_strtoul
Denis Vlasenko7039a662006-10-08 17:54:47 +0000274# define STRTOOFF strtol
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000275# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000276# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000277#endif
278/* scary. better ideas? (but do *test* them first!) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000279#define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
Denys Vlasenko1dc80ba2011-11-17 21:51:32 +0100280/* Users report bionic to use 32-bit off_t even if LARGEFILE support is requested.
281 * We misdetected that. Don't let it build:
282 */
283struct BUG_off_t_size_is_misdetected {
284 char BUG_off_t_size_is_misdetected[sizeof(off_t) == sizeof(uoff_t) ? 1 : -1];
285};
Denis Vlasenko56254152006-10-07 16:24:46 +0000286
Eric Andersenaad1a882001-03-16 22:47:14 +0000287/* Some useful definitions */
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000288#undef FALSE
Eric Andersenaad1a882001-03-16 22:47:14 +0000289#define FALSE ((int) 0)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000290#undef TRUE
Eric Andersenaad1a882001-03-16 22:47:14 +0000291#define TRUE ((int) 1)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000292#undef SKIP
Eric Andersenaad1a882001-03-16 22:47:14 +0000293#define SKIP ((int) 2)
294
Eric Andersenaad1a882001-03-16 22:47:14 +0000295/* Macros for min/max. */
296#ifndef MIN
Denys Vlasenkoe4dcba12010-10-28 18:57:19 +0200297#define MIN(a,b) (((a)<(b))?(a):(b))
Eric Andersenaad1a882001-03-16 22:47:14 +0000298#endif
299
300#ifndef MAX
Denys Vlasenkoe4dcba12010-10-28 18:57:19 +0200301#define MAX(a,b) (((a)>(b))?(a):(b))
Eric Andersenaad1a882001-03-16 22:47:14 +0000302#endif
303
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000304/* buffer allocation schemes */
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000305#if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000306#define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000307#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
308#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
309#else
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000310#if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000311#define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
312#define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
313#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
314#else
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000315#define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer = xmalloc(len)
316#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
317#define RELEASE_CONFIG_BUFFER(buffer) free(buffer)
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000318#endif
319#endif
320
Denis Vlasenkofad2b862007-05-31 22:16:38 +0000321#if defined(__GLIBC__)
322/* glibc uses __errno_location() to get a ptr to errno */
323/* We can just memorize it once - no multithreading in busybox :) */
324extern int *const bb_errno;
325#undef errno
326#define errno (*bb_errno)
327#endif
328
Denys Vlasenko9ff50b82010-10-18 11:40:26 +0200329#if !(ULONG_MAX > 0xffffffff)
330/* Only 32-bit CPUs need this, 64-bit ones use inlined version */
331uint64_t bb_bswap_64(uint64_t x) FAST_FUNC;
332#endif
333
Denis Vlasenkoce13b762008-06-29 02:25:53 +0000334unsigned long long monotonic_ns(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000335unsigned long long monotonic_us(void) FAST_FUNC;
Denys Vlasenkof2c8aa62010-01-12 12:52:30 +0100336unsigned long long monotonic_ms(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000337unsigned monotonic_sec(void) FAST_FUNC;
Manuel Novoa III cad53642003-03-19 09:13:01 +0000338
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000339extern void chomp(char *s) FAST_FUNC;
340extern void trim(char *s) FAST_FUNC;
341extern char *skip_whitespace(const char *) FAST_FUNC;
342extern char *skip_non_whitespace(const char *) FAST_FUNC;
Denys Vlasenkof8d8aa12010-04-06 18:50:05 +0200343extern char *skip_dev_pfx(const char *tty_name) FAST_FUNC;
344
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000345extern char *strrstr(const char *haystack, const char *needle) FAST_FUNC;
Paul Fox0b621582005-08-09 19:38:05 +0000346
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +0000347//TODO: supply a pointer to char[11] buffer (avoid statics)?
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000348extern const char *bb_mode_string(mode_t mode) FAST_FUNC;
Denys Vlasenkof282c6b2011-12-18 03:27:46 +0100349extern int is_directory(const char *name, int followLinks) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000350enum { /* DO NOT CHANGE THESE VALUES! cp.c, mv.c, install.c depend on them. */
Denys Vlasenkoa40f0622010-01-15 22:05:07 +0100351 FILEUTILS_PRESERVE_STATUS = 1 << 0, /* -p */
352 FILEUTILS_DEREFERENCE = 1 << 1, /* !-d */
353 FILEUTILS_RECUR = 1 << 2, /* -R */
354 FILEUTILS_FORCE = 1 << 3, /* -f */
355 FILEUTILS_INTERACTIVE = 1 << 4, /* -i */
356 FILEUTILS_MAKE_HARDLINK = 1 << 5, /* -l */
357 FILEUTILS_MAKE_SOFTLINK = 1 << 6, /* -s */
358 FILEUTILS_DEREF_SOFTLINK = 1 << 7, /* -L */
359 FILEUTILS_DEREFERENCE_L0 = 1 << 8, /* -H */
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000360#if ENABLE_SELINUX
Denys Vlasenkoa40f0622010-01-15 22:05:07 +0100361 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 1 << 9, /* -c */
362 FILEUTILS_SET_SECURITY_CONTEXT = 1 << 10,
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000363#endif
Natanael Copa02112d82012-05-22 17:11:46 +0200364 FILEUTILS_IGNORE_CHMOD_ERR = 1 << 11,
Denys Vlasenko17f84182014-05-19 16:23:50 +0200365 /* -v */
366 FILEUTILS_VERBOSE = (1 << 12) * ENABLE_FEATURE_VERBOSE,
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000367};
Denys Vlasenkoa40f0622010-01-15 22:05:07 +0100368#define FILEUTILS_CP_OPTSTR "pdRfilsLH" IF_SELINUX("c")
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000369extern int remove_file(const char *path, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000370/* NB: without FILEUTILS_RECUR in flags, it will basically "cat"
371 * the source, not copy (unless "source" is a directory).
372 * This makes "cp /dev/null file" and "install /dev/null file" (!!!)
373 * work coreutils-compatibly. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000374extern int copy_file(const char *source, const char *dest, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000375
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000376enum {
Denis Vlasenkod166f832007-07-05 00:12:55 +0000377 ACTION_RECURSE = (1 << 0),
378 ACTION_FOLLOWLINKS = (1 << 1),
379 ACTION_FOLLOWLINKS_L0 = (1 << 2),
380 ACTION_DEPTHFIRST = (1 << 3),
381 /*ACTION_REVERSE = (1 << 4), - unused */
Denis Vlasenko6e69e422008-07-27 12:10:07 +0000382 ACTION_QUIET = (1 << 5),
Denys Vlasenko8f7a6d22009-09-29 11:07:04 +0200383 ACTION_DANGLING_OK = (1 << 6),
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000384};
Denys Vlasenko8f7a6d22009-09-29 11:07:04 +0200385typedef uint8_t recurse_flags_t;
Bernhard Reutner-Fischer3e816c12007-03-29 10:30:50 +0000386extern int recursive_action(const char *fileName, unsigned flags,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000387 int FAST_FUNC (*fileAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
388 int FAST_FUNC (*dirAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
389 void* userData, unsigned depth) FAST_FUNC;
390extern int device_open(const char *device, int mode) FAST_FUNC;
Denis Vlasenko85c24712008-03-17 09:04:04 +0000391enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000392extern int xgetpty(char *line) FAST_FUNC;
Denis Vlasenko2afd5ab2008-08-05 23:32:27 +0000393extern int get_console_fd_or_die(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000394extern void console_make_active(int fd, const int vt_num) FAST_FUNC;
395extern char *find_block_device(const char *path) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000396/* bb_copyfd_XX print read/write errors and return -1 if they occur */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000397extern off_t bb_copyfd_eof(int fd1, int fd2) FAST_FUNC;
398extern off_t bb_copyfd_size(int fd1, int fd2, off_t size) FAST_FUNC;
399extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000400/* "short" copy can be detected by return value < size */
401/* this helper yells "short read!" if param is not -1 */
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000402extern void complain_copyfd_and_die(off_t sz) NORETURN FAST_FUNC;
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +0200403
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000404extern char bb_process_escape_sequence(const char **ptr) FAST_FUNC;
Denys Vlasenko53600592010-10-23 21:06:06 +0200405char* strcpy_and_process_escape_sequences(char *dst, const char *src) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000406/* xxxx_strip version can modify its parameter:
407 * "/" -> "/"
408 * "abc" -> "abc"
409 * "abc/def" -> "def"
410 * "abc/def/" -> "def" !!
411 */
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +0200412char *bb_get_last_path_component_strip(char *path) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000413/* "abc/def/" -> "" and it never modifies 'path' */
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +0200414char *bb_get_last_path_component_nostrip(const char *path) FAST_FUNC;
415/* Simpler version: does not special case "/" string */
416const char *bb_basename(const char *name) FAST_FUNC;
417/* NB: can violate const-ness (similarly to strchr) */
418char *last_char_is(const char *s, int c) FAST_FUNC;
Denys Vlasenko1961aea2013-02-26 00:36:53 +0100419const char* endofname(const char *name) FAST_FUNC;
Denys Vlasenko8dff01d2015-03-12 17:48:34 +0100420char *is_prefixed_with(const char *string, const char *key) FAST_FUNC;
Bartosz Golaszewski7448b512015-08-25 16:36:43 +0200421char *is_suffixed_with(const char *string, const char *key) FAST_FUNC;
Denis Vlasenkocad04ef2007-03-25 23:21:05 +0000422
Denys Vlasenkod6e76722014-09-22 21:14:02 +0200423int ndelay_on(int fd) FAST_FUNC;
424int ndelay_off(int fd) FAST_FUNC;
Denys Vlasenkoe9a40e32011-01-24 00:29:55 +0100425void close_on_exec_on(int fd) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000426void xdup2(int, int) FAST_FUNC;
427void xmove_fd(int, int) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000428
429
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000430DIR *xopendir(const char *path) FAST_FUNC;
431DIR *warn_opendir(const char *path) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000432
Jérémie Koenigfbedacf2010-03-26 19:08:53 +0100433char *xmalloc_realpath(const char *path) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100434char *xmalloc_readlink(const char *path) FAST_FUNC RETURNS_MALLOC;
435char *xmalloc_readlink_or_warn(const char *path) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkob57eee82009-11-04 17:54:17 +0100436/* !RETURNS_MALLOC: it's a realloc-like function */
437char *xrealloc_getcwd_or_warn(char *cwd) FAST_FUNC;
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000438
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100439char *xmalloc_follow_symlinks(const char *path) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko473dae02007-04-11 07:04:23 +0000440
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000441
Denis Vlasenko33196372008-02-23 01:25:38 +0000442enum {
Denis Vlasenkocf7cf622008-03-19 19:38:46 +0000443 /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
Denis Vlasenko33196372008-02-23 01:25:38 +0000444 * otherwise would kill us, except for those resulting from bugs:
445 * SIGSEGV, SIGILL, SIGFPE.
446 * Other fatal signals not included (TODO?):
447 * SIGBUS Bus error (bad memory access)
448 * SIGPOLL Pollable event. Synonym of SIGIO
449 * SIGPROF Profiling timer expired
450 * SIGSYS Bad argument to routine
451 * SIGTRAP Trace/breakpoint trap
Denis Vlasenkod943af02008-03-30 15:56:38 +0000452 *
453 * The only known arch with some of these sigs not fitting
454 * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
455 * Dance around with long long to guard against that...
Denis Vlasenko33196372008-02-23 01:25:38 +0000456 */
Denis Vlasenkod943af02008-03-30 15:56:38 +0000457 BB_FATAL_SIGS = (int)(0
458 + (1LL << SIGHUP)
459 + (1LL << SIGINT)
460 + (1LL << SIGTERM)
461 + (1LL << SIGPIPE) // Write to pipe with no readers
462 + (1LL << SIGQUIT) // Quit from keyboard
463 + (1LL << SIGABRT) // Abort signal from abort(3)
464 + (1LL << SIGALRM) // Timer signal from alarm(2)
465 + (1LL << SIGVTALRM) // Virtual alarm clock
466 + (1LL << SIGXCPU) // CPU time limit exceeded
467 + (1LL << SIGXFSZ) // File size limit exceeded
468 + (1LL << SIGUSR1) // Yes kids, these are also fatal!
469 + (1LL << SIGUSR2)
470 + 0),
Denis Vlasenko33196372008-02-23 01:25:38 +0000471};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000472void bb_signals(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko25591c32008-02-16 22:58:56 +0000473/* Unlike signal() and bb_signals, sets handler with sigaction()
474 * and in a way that while signal handler is run, no other signals
Denis Vlasenkocab28aa2009-01-31 01:02:07 +0000475 * will be blocked; syscalls will not be restarted: */
476void bb_signals_recursive_norestart(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000477/* syscalls like read() will be interrupted with EINTR: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000478void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000479/* syscalls like read() won't be interrupted (though select/poll will be): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000480void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
481void wait_for_any_sig(void) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000482void kill_myself_with_sig(int sig) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000483void sig_block(int sig) FAST_FUNC;
484void sig_unblock(int sig) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000485/* Will do sigaction(signum, act, NULL): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000486int sigaction_set(int sig, const struct sigaction *act) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000487/* SIG_BLOCK/SIG_UNBLOCK all signals: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000488int sigprocmask_allsigs(int how) FAST_FUNC;
Denis Vlasenko08ea11a2008-09-11 19:51:11 +0000489/* Standard handler which just records signo */
490extern smallint bb_got_signal;
491void record_signo(int signo); /* not FAST_FUNC! */
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000492
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000493
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000494void xsetgid(gid_t gid) FAST_FUNC;
495void xsetuid(uid_t uid) FAST_FUNC;
Ryan Mallon5906a5c2013-10-08 14:52:49 +0200496void xsetegid(gid_t egid) FAST_FUNC;
497void xseteuid(uid_t euid) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000498void xchdir(const char *path) FAST_FUNC;
499void xchroot(const char *path) FAST_FUNC;
500void xsetenv(const char *key, const char *value) FAST_FUNC;
Denis Vlasenko76ddc2e2008-12-30 05:05:31 +0000501void bb_unsetenv(const char *key) FAST_FUNC;
Denys Vlasenkodd8adde2010-06-24 05:00:50 +0200502void bb_unsetenv_and_free(char *key) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000503void xunlink(const char *pathname) FAST_FUNC;
504void xstat(const char *pathname, struct stat *buf) FAST_FUNC;
Denys Vlasenko8d3e2252010-08-31 12:42:06 +0200505void xfstat(int fd, struct stat *buf, const char *errmsg) FAST_FUNC;
Ryan Mallon5906a5c2013-10-08 14:52:49 +0200506int open3_or_warn(const char *pathname, int flags, int mode) FAST_FUNC;
507int open_or_warn(const char *pathname, int flags) FAST_FUNC;
508int xopen3(const char *pathname, int flags, int mode) FAST_FUNC;
Denys Vlasenkof2a8d5d2009-08-21 17:40:36 +0200509int xopen(const char *pathname, int flags) FAST_FUNC;
Bernhard Reutner-Fischera4830872009-10-26 23:27:08 +0100510int xopen_nonblocking(const char *pathname) FAST_FUNC;
Ryan Mallon5906a5c2013-10-08 14:52:49 +0200511int xopen_as_uid_gid(const char *pathname, int flags, uid_t u, gid_t g) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000512int open_or_warn_stdin(const char *pathname) FAST_FUNC;
Denys Vlasenkoe7b0a9e2010-08-22 05:39:15 +0200513int xopen_stdin(const char *pathname) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000514void xrename(const char *oldpath, const char *newpath) FAST_FUNC;
515int rename_or_warn(const char *oldpath, const char *newpath) FAST_FUNC;
516off_t xlseek(int fd, off_t offset, int whence) FAST_FUNC;
Alexander Shishkin67227372010-10-22 13:27:16 +0200517int xmkstemp(char *template) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000518off_t fdlength(int fd) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000519
Denys Vlasenko40e7d252010-02-01 23:48:27 +0100520uoff_t FAST_FUNC get_volume_size_in_bytes(int fd,
Denys Vlasenko982e87f2013-07-30 11:52:58 +0200521 const char *override,
522 unsigned override_units,
523 int extend);
Denys Vlasenko40e7d252010-02-01 23:48:27 +0100524
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000525void xpipe(int filedes[2]) FAST_FUNC;
Denis Vlasenko37188322008-02-16 13:20:56 +0000526/* In this form code with pipes is much more readable */
527struct fd_pair { int rd; int wr; };
528#define piped_pair(pair) pipe(&((pair).rd))
529#define xpiped_pair(pair) xpipe(&((pair).rd))
530
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000531/* Useful for having small structure members/global variables */
532typedef int8_t socktype_t;
533typedef int8_t family_t;
534struct BUG_too_small {
535 char BUG_socktype_t_too_small[(0
536 | SOCK_STREAM
537 | SOCK_DGRAM
538 | SOCK_RDM
539 | SOCK_SEQPACKET
540 | SOCK_RAW
541 ) <= 127 ? 1 : -1];
542 char BUG_family_t_too_small[(0
543 | AF_UNSPEC
544 | AF_INET
545 | AF_INET6
546 | AF_UNIX
Mike Frysinger9412ec72008-02-07 22:41:33 +0000547#ifdef AF_PACKET
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000548 | AF_PACKET
Mike Frysinger9412ec72008-02-07 22:41:33 +0000549#endif
550#ifdef AF_NETLINK
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000551 | AF_NETLINK
Mike Frysinger9412ec72008-02-07 22:41:33 +0000552#endif
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000553 /* | AF_DECnet */
554 /* | AF_IPX */
555 ) <= 127 ? 1 : -1];
556};
557
558
Denys Vlasenkodc698bb2010-01-09 19:10:49 +0100559void parse_datestr(const char *date_str, struct tm *ptm) FAST_FUNC;
560time_t validate_tm_time(const char *date_str, struct tm *ptm) FAST_FUNC;
Denys Vlasenko8f2cb7a2013-03-29 12:30:33 +0100561char *strftime_HHMMSS(char *buf, unsigned len, time_t *tp) FAST_FUNC;
562char *strftime_YYYYMMDDHHMMSS(char *buf, unsigned len, time_t *tp) FAST_FUNC;
Denys Vlasenko73b71f32009-07-18 03:40:35 +0200563
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000564int xsocket(int domain, int type, int protocol) FAST_FUNC;
565void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen) FAST_FUNC;
566void xlisten(int s, int backlog) FAST_FUNC;
567void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen) FAST_FUNC;
Denis Vlasenkodbe6e662007-08-14 16:43:01 +0000568ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000569 socklen_t tolen) FAST_FUNC;
Denys Vlasenkoc52cbea2015-08-24 19:48:03 +0200570
571int setsockopt_int(int fd, int level, int optname, int optval) FAST_FUNC;
572int setsockopt_1(int fd, int level, int optname) FAST_FUNC;
573int setsockopt_SOL_SOCKET_int(int fd, int optname, int optval) FAST_FUNC;
574int setsockopt_SOL_SOCKET_1(int fd, int optname) FAST_FUNC;
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000575/* SO_REUSEADDR allows a server to rebind to an address that is already
576 * "in use" by old connections to e.g. previous server instance which is
577 * killed or crashed. Without it bind will fail until all such connections
578 * time out. Linux does not allow multiple live binds on same ip:port
579 * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
580 * Turn it on before you call bind(). */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000581void setsockopt_reuseaddr(int fd) FAST_FUNC; /* On Linux this never fails. */
Denys Vlasenkoc52cbea2015-08-24 19:48:03 +0200582int setsockopt_keepalive(int fd) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000583int setsockopt_broadcast(int fd) FAST_FUNC;
Denis Vlasenkoe5373852008-12-10 11:12:16 +0000584int setsockopt_bindtodevice(int fd, const char *iface) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000585/* NB: returns port in host byte order */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000586unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port) FAST_FUNC;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000587typedef struct len_and_sockaddr {
Denis Vlasenko0850cda2007-02-07 23:20:32 +0000588 socklen_t len;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000589 union {
590 struct sockaddr sa;
591 struct sockaddr_in sin;
592#if ENABLE_FEATURE_IPV6
593 struct sockaddr_in6 sin6;
594#endif
Bernhard Reutner-Fischer8c69afd2008-01-29 10:33:34 +0000595 } u;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000596} len_and_sockaddr;
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000597enum {
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000598 LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000599 LSA_SIZEOF_SA = sizeof(
600 union {
601 struct sockaddr sa;
602 struct sockaddr_in sin;
603#if ENABLE_FEATURE_IPV6
604 struct sockaddr_in6 sin6;
605#endif
606 }
607 )
608};
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000609/* Create stream socket, and allocate suitable lsa.
610 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
Denis Vlasenkobeffd432007-09-05 11:30:34 +0000611 * af == AF_UNSPEC will result in trying to create IPv6 socket,
Denys Vlasenkob1278a32009-11-24 16:03:47 +0100612 * and if kernel doesn't support it, fall back to IPv4.
613 * This is useful if you plan to bind to resulting local lsa.
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000614 */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000615int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000616int xsocket_stream(len_and_sockaddr **lsap) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000617/* Create server socket bound to bindaddr:port. bindaddr can be NULL,
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000618 * numeric IP ("N.N.N.N") or numeric IPv6 address,
619 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000620 * Only if there is no suffix, port argument is used */
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000621/* NB: these set SO_REUSEADDR before bind */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000622int create_and_bind_stream_or_die(const char *bindaddr, int port) FAST_FUNC;
623int create_and_bind_dgram_or_die(const char *bindaddr, int port) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000624/* Create client TCP socket connected to peer:port. Peer cannot be NULL.
625 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
626 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
627 * If there is no suffix, port argument is used */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000628int create_and_connect_stream_or_die(const char *peer, int port) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000629/* Connect to peer identified by lsa */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000630int xconnect_stream(const len_and_sockaddr *lsa) FAST_FUNC;
Denis Vlasenko73c571a2009-03-09 00:12:37 +0000631/* Get local address of bound or accepted socket */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100632len_and_sockaddr *get_sock_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkof6916db2010-04-06 17:43:29 +0200633/* Get remote address of connected or accepted socket */
634len_and_sockaddr *get_peer_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000635/* Return malloc'ed len_and_sockaddr with socket address of host:port
636 * Currently will return IPv4 or IPv6 sockaddrs only
637 * (depending on host), but in theory nothing prevents e.g.
Denis Vlasenko5870ad92007-02-04 02:39:55 +0000638 * UNIX socket address being returned, IPX sockaddr etc...
639 * On error does bb_error_msg and returns NULL */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100640len_and_sockaddr* host2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000641/* Version which dies on error */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100642len_and_sockaddr* xhost2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
643len_and_sockaddr* xdotted2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000644/* Same, useful if you want to force family (e.g. IPv6) */
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000645#if !ENABLE_FEATURE_IPV6
646#define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
647#define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
648#else
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100649len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
650len_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 +0000651#endif
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000652/* Assign sin[6]_port member if the socket is an AF_INET[6] one,
Denis Vlasenko85629f02007-01-22 09:36:41 +0000653 * otherwise no-op. Useful for ftp.
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000654 * NB: does NOT do htons() internally, just direct assignment. */
Denys Vlasenkoca183112011-04-07 17:52:20 +0200655void set_nport(struct sockaddr *sa, unsigned port) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000656/* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000657int get_nport(const struct sockaddr *sa) FAST_FUNC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000658/* Reverse DNS. Returns NULL on failure. */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100659char* xmalloc_sockaddr2host(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000660/* This one doesn't append :PORTNUM */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100661char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000662/* This one also doesn't fall back to dotted IP (returns NULL) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100663char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko448f0242007-01-22 22:43:05 +0000664/* inet_[ap]ton on steroids */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100665char* xmalloc_sockaddr2dotted(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
666char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000667// "old" (ipv4 only) API
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000668// users: traceroute.c hostname.c - use _list_ of all IPs
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000669struct hostent *xgethostbyname(const char *name) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000670// Also mount.c and inetd.c are using gethostbyname(),
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000671// + inet_common.c has additional IPv4-only stuff
Denis Vlasenkoc8717cd2006-11-22 16:10:39 +0000672
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000673
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000674void socket_want_pktinfo(int fd) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000675ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000676 const struct sockaddr *to,
677 const struct sockaddr *from,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000678 socklen_t tolen) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000679ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000680 struct sockaddr *from,
681 struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000682 socklen_t sa_size) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000683
Baruch Siache8f36332011-09-07 17:52:37 +0200684uint16_t inet_cksum(uint16_t *addr, int len) FAST_FUNC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100685
686char *xstrdup(const char *s) FAST_FUNC RETURNS_MALLOC;
687char *xstrndup(const char *s, int n) FAST_FUNC RETURNS_MALLOC;
Ron Yorstond840c5d2015-07-19 23:05:20 +0200688void *xmemdup(const void *s, int n) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko0f293b92008-07-22 20:16:55 +0000689void overlapping_strcpy(char *dst, const char *src) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000690char *safe_strncpy(char *dst, const char *src, size_t size) FAST_FUNC;
Denis Vlasenko360d9662008-12-02 18:18:50 +0000691char *strncpy_IFNAMSIZ(char *dst, const char *src) FAST_FUNC;
Denys Vlasenko6f068902014-02-27 11:17:06 +0100692unsigned count_strstr(const char *str, const char *sub) FAST_FUNC;
693char *xmalloc_substitute_string(const char *src, int count, const char *sub, const char *repl) FAST_FUNC;
Denis Vlasenko4daad902007-09-27 10:20:47 +0000694/* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
Denis Vlasenko7c654ae2007-09-27 10:26:59 +0000695 * But potentially slow, don't use in one-billion-times loops */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000696int bb_putchar(int ch) FAST_FUNC;
Denys Vlasenko19ced5c2010-06-06 21:53:09 +0200697/* Note: does not use stdio, writes to fd 2 directly */
698int bb_putchar_stderr(char ch) FAST_FUNC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100699char *xasprintf(const char *format, ...) __attribute__ ((format(printf, 1, 2))) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkoe52da552015-10-09 17:59:56 +0200700char *auto_string(char *str) FAST_FUNC;
Denis Vlasenko9f739442006-12-16 23:49:13 +0000701// gcc-4.1.1 still isn't good enough at optimizing it
702// (+200 bytes compared to macro)
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000703//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000704//int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000705//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000706//int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000707#define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
Denis Vlasenko9f739442006-12-16 23:49:13 +0000708#define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000709#define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
Denis Vlasenkobf66fbc2006-12-21 13:23:14 +0000710#define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
Denis Vlasenko16abcd92007-04-13 23:59:52 +0000711#define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000712
Denys Vlasenkod8528b82010-01-31 05:15:38 +0100713typedef struct uni_stat_t {
714 unsigned byte_count;
715 unsigned unicode_count;
716 unsigned unicode_width;
717} uni_stat_t;
718/* Returns a string with unprintable chars replaced by '?' or
719 * SUBST_WCHAR. This function is unicode-aware. */
720const char* FAST_FUNC printable_string(uni_stat_t *stats, const char *str);
721/* Prints unprintable char ch as ^C or M-c to file
722 * (M-c is used only if ch is ORed with PRINTABLE_META),
723 * else it is printed as-is (except for ch = 0x9b) */
724enum { PRINTABLE_META = 0x100 };
725void fputc_printable(int ch, FILE *file) FAST_FUNC;
Bartosz Golaszewski79c618c2013-07-30 06:29:42 +0200726/* Return a string that is the printable representation of character ch.
727 * Buffer must hold at least four characters. */
Denys Vlasenkobfa6ed12013-07-30 11:41:58 +0200728enum {
729 VISIBLE_ENDLINE = 1 << 0,
730 VISIBLE_SHOW_TABS = 1 << 1,
731};
Bartosz Golaszewski79c618c2013-07-30 06:29:42 +0200732void visible(unsigned ch, char *buf, int flags) FAST_FUNC;
Denys Vlasenkod8528b82010-01-31 05:15:38 +0100733
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000734/* dmalloc will redefine these to it's own implementation. It is safe
735 * to have the prototypes here unconditionally. */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100736void *malloc_or_warn(size_t size) FAST_FUNC RETURNS_MALLOC;
737void *xmalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
738void *xzalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkodeeed592008-07-08 05:14:36 +0000739void *xrealloc(void *old, size_t size) FAST_FUNC;
Denys Vlasenko16714242011-09-21 01:59:15 +0200740/* After v = xrealloc_vector(v, SHIFT, idx) it's ok to use
Denis Vlasenko27842282008-08-04 13:20:36 +0000741 * at least v[idx] and v[idx+1], for all idx values.
Denys Vlasenko16714242011-09-21 01:59:15 +0200742 * SHIFT specifies how many new elements are added (1:2, 2:4, ..., 8:256...)
743 * when all elements are used up. New elements are zeroed out.
744 * xrealloc_vector(v, SHIFT, idx) *MUST* be called with consecutive IDXs -
745 * skipping an index is a bad bug - it may miss a realloc!
746 */
Denis Vlasenkodeeed592008-07-08 05:14:36 +0000747#define xrealloc_vector(vector, shift, idx) \
748 xrealloc_vector_helper((vector), (sizeof((vector)[0]) << 8) + (shift), (idx))
749void* xrealloc_vector_helper(void *vector, unsigned sizeof_and_shift, int idx) FAST_FUNC;
750
Eric Andersenaad1a882001-03-16 22:47:14 +0000751
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000752extern ssize_t safe_read(int fd, void *buf, size_t count) FAST_FUNC;
Ron Yorston61d6ae22015-04-19 10:50:25 +0100753extern ssize_t nonblock_immune_read(int fd, void *buf, size_t count) FAST_FUNC;
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000754// NB: will return short read on error, not -1,
755// if some data was read before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000756extern ssize_t full_read(int fd, void *buf, size_t count) FAST_FUNC;
757extern void xread(int fd, void *buf, size_t count) FAST_FUNC;
758extern unsigned char xread_char(int fd) FAST_FUNC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000759extern ssize_t read_close(int fd, void *buf, size_t maxsz) FAST_FUNC;
760extern ssize_t open_read_close(const char *filename, void *buf, size_t maxsz) FAST_FUNC;
Denis Vlasenko8ee649a2008-03-26 20:04:27 +0000761// Reads one line a-la fgets (but doesn't save terminating '\n').
762// Reads byte-by-byte. Useful when it is important to not read ahead.
Denis Vlasenkoe376d452008-02-20 22:23:24 +0000763// Bytes are appended to pfx (which must be malloced, or NULL).
Denys Vlasenko80c5b682011-05-08 21:21:10 +0200764extern char *xmalloc_reads(int fd, size_t *maxsz_p) FAST_FUNC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000765/* Reads block up to *maxsz_p (default: INT_MAX - 4095) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100766extern void *xmalloc_read(int fd, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000767/* Returns NULL if file can't be opened (default max size: INT_MAX - 4095) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100768extern void *xmalloc_open_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko094cc512011-01-17 14:58:27 +0100769/* Never returns NULL */
770extern void *xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko59655072012-03-06 16:23:50 +0100771
Denys Vlasenko04c14172014-11-26 15:17:59 +0100772#if defined(ARG_MAX) && (ARG_MAX >= 60*1024 || !defined(_SC_ARG_MAX))
773/* Use _constant_ maximum if: defined && (big enough || no variable one exists) */
Denys Vlasenkof92f1d02014-06-22 13:54:40 +0200774# define bb_arg_max() ((unsigned)ARG_MAX)
Denys Vlasenko04c14172014-11-26 15:17:59 +0100775#elif defined(_SC_ARG_MAX)
776/* Else use variable one (a bit more expensive) */
Denys Vlasenkof92f1d02014-06-22 13:54:40 +0200777unsigned bb_arg_max(void) FAST_FUNC;
778#else
Denys Vlasenko04c14172014-11-26 15:17:59 +0100779/* If all else fails */
Denys Vlasenkof92f1d02014-06-22 13:54:40 +0200780# define bb_arg_max() ((unsigned)(32 * 1024))
781#endif
Bartosz Golaszewski5d2e4092014-06-22 14:01:13 +0200782unsigned bb_clk_tck(void) FAST_FUNC;
Denys Vlasenkof92f1d02014-06-22 13:54:40 +0200783
Denys Vlasenko59655072012-03-06 16:23:50 +0100784#define SEAMLESS_COMPRESSION (0 \
785 || ENABLE_FEATURE_SEAMLESS_XZ \
786 || ENABLE_FEATURE_SEAMLESS_LZMA \
787 || ENABLE_FEATURE_SEAMLESS_BZ2 \
788 || ENABLE_FEATURE_SEAMLESS_GZ \
789 || ENABLE_FEATURE_SEAMLESS_Z)
790
Denys Vlasenko8a6a2f92012-03-06 16:27:48 +0100791#if SEAMLESS_COMPRESSION
Denys Vlasenko27653ad2010-05-06 14:19:19 +0000792/* Autodetects gzip/bzip2 formats. fd may be in the middle of the file! */
Denys Vlasenko640ce3d2014-02-02 02:06:38 +0100793extern int setup_unzip_on_fd(int fd, int fail_if_not_compressed) FAST_FUNC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000794/* Autodetects .gz etc */
Denys Vlasenko640ce3d2014-02-02 02:06:38 +0100795extern int open_zipped(const char *fname, int fail_if_not_compressed) FAST_FUNC;
Denys Vlasenkob4c11c12014-12-07 00:44:00 +0100796extern void *xmalloc_open_zipped_read_close(const char *fname, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko8a6a2f92012-03-06 16:27:48 +0100797#else
798# define setup_unzip_on_fd(...) (0)
Denys Vlasenko640ce3d2014-02-02 02:06:38 +0100799# define open_zipped(fname, fail_if_not_compressed) open((fname), O_RDONLY);
Denys Vlasenkob4c11c12014-12-07 00:44:00 +0100800# define xmalloc_open_zipped_read_close(fname, maxsz_p) xmalloc_open_read_close((fname), (maxsz_p))
Denys Vlasenko8a6a2f92012-03-06 16:27:48 +0100801#endif
Denis Vlasenkoea620772006-10-14 02:23:43 +0000802
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000803extern ssize_t safe_write(int fd, const void *buf, size_t count) FAST_FUNC;
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000804// NB: will return short write on error, not -1,
805// if some data was written before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000806extern ssize_t full_write(int fd, const void *buf, size_t count) FAST_FUNC;
807extern void xwrite(int fd, const void *buf, size_t count) FAST_FUNC;
Denis Vlasenko73c571a2009-03-09 00:12:37 +0000808extern void xwrite_str(int fd, const char *str) FAST_FUNC;
Denys Vlasenko729ecb82010-06-07 14:14:26 +0200809extern ssize_t full_write1_str(const char *str) FAST_FUNC;
810extern ssize_t full_write2_str(const char *str) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000811extern void xopen_xwrite_close(const char* file, const char *str) FAST_FUNC;
Denis Vlasenkoea620772006-10-14 02:23:43 +0000812
Denys Vlasenkodcd27ab2009-10-05 03:03:07 +0200813/* Close fd, but check for failures (some types of write errors) */
814extern void xclose(int fd) FAST_FUNC;
815
Denis Vlasenko1de08302006-10-26 23:32:43 +0000816/* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000817extern void xprint_and_close_file(FILE *file) FAST_FUNC;
Denis Vlasenko2132e022008-07-15 10:33:12 +0000818
Denys Vlasenkoa1a44832011-06-17 03:37:43 +0200819/* Reads a line from a text file, up to a newline or NUL byte, inclusive.
820 * Returns malloc'ed char*. If end is NULL '\n' isn't considered
821 * end of line. If end isn't NULL, length of the chunk is stored in it.
822 * Returns NULL if EOF/error.
823 */
Denis Vlasenko2132e022008-07-15 10:33:12 +0000824extern char *bb_get_chunk_from_file(FILE *file, int *end) FAST_FUNC;
Denis Vlasenkoabee3d02007-12-26 20:44:45 +0000825/* Reads up to (and including) TERMINATING_STRING: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100826extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000827/* Same, with limited max size, and returns the length (excluding NUL): */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100828extern 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 +0000829/* Chops off TERMINATING_STRING from the end: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100830extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000831/* Reads up to (and including) "\n" or NUL byte: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100832extern char *xmalloc_fgets(FILE *file) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000833/* Chops off '\n' from the end, unlike fgets: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100834extern char *xmalloc_fgetline(FILE *file) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko2132e022008-07-15 10:33:12 +0000835/* Same, but doesn't try to conserve space (may have some slack after the end) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100836/* extern char *xmalloc_fgetline_fast(FILE *file) FAST_FUNC RETURNS_MALLOC; */
Denis Vlasenko2132e022008-07-15 10:33:12 +0000837
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100838void die_if_ferror(FILE *file, const char *msg) FAST_FUNC;
839void die_if_ferror_stdout(void) FAST_FUNC;
840int fflush_all(void) FAST_FUNC;
841void fflush_stdout_and_exit(int retval) NORETURN FAST_FUNC;
842int fclose_if_not_stdin(FILE *file) FAST_FUNC;
843FILE* xfopen(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000844/* Prints warning to stderr and returns NULL on failure: */
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100845FILE* fopen_or_warn(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000846/* "Opens" stdin if filename is special, else just opens file: */
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100847FILE* xfopen_stdin(const char *filename) FAST_FUNC;
848FILE* fopen_or_warn_stdin(const char *filename) FAST_FUNC;
849FILE* fopen_for_read(const char *path) FAST_FUNC;
850FILE* xfopen_for_read(const char *path) FAST_FUNC;
851FILE* fopen_for_write(const char *path) FAST_FUNC;
852FILE* xfopen_for_write(const char *path) FAST_FUNC;
853FILE* xfdopen_for_read(int fd) FAST_FUNC;
854FILE* xfdopen_for_write(int fd) FAST_FUNC;
Eric Andersen8876fb22003-06-20 09:01:58 +0000855
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000856int bb_pstrcmp(const void *a, const void *b) /* not FAST_FUNC! */;
857void qsort_string_vector(char **sv, unsigned count) FAST_FUNC;
Denis Vlasenkofb290382008-03-02 12:51:26 +0000858
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000859/* Wrapper which restarts poll on EINTR or ENOMEM.
860 * On other errors complains [perror("poll")] and returns.
861 * Warning! May take (much) longer than timeout_ms to return!
862 * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000863int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms) FAST_FUNC;
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000864
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000865char *safe_gethostname(void) FAST_FUNC;
Denis Vlasenko6f1713f2008-02-25 23:23:58 +0000866
Bernhard Reutner-Fischer8b1fab22007-04-10 09:38:07 +0000867/* Convert each alpha char in str to lower-case */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000868char* str_tolower(char *str) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000869
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000870char *utoa(unsigned n) FAST_FUNC;
871char *itoa(int n) FAST_FUNC;
Denis Vlasenko10457b92007-03-27 22:01:31 +0000872/* Returns a pointer past the formatted number, does NOT null-terminate */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000873char *utoa_to_buf(unsigned n, char *buf, unsigned buflen) FAST_FUNC;
874char *itoa_to_buf(int n, char *buf, unsigned buflen) FAST_FUNC;
Denis Vlasenko56ea65c2008-01-06 03:26:53 +0000875/* Intelligent formatters of bignums */
Denys Vlasenkoa407cf72013-09-06 12:53:14 +0200876char *smart_ulltoa4(unsigned long long ul, char buf[4], const char *scale) FAST_FUNC;
877char *smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
Denys Vlasenko0bf44d02009-10-13 01:25:09 +0200878/* If block_size == 0, display size without fractional part,
879 * else display (size * block_size) with one decimal digit.
Denys Vlasenko9c3b84a2010-01-18 01:55:00 +0100880 * If display_unit == 0, show value no bigger than 1024 with suffix (K,M,G...),
Denys Vlasenko0bf44d02009-10-13 01:25:09 +0200881 * else divide by display_unit and do not use suffix. */
Denys Vlasenko9c3b84a2010-01-18 01:55:00 +0100882#define HUMAN_READABLE_MAX_WIDTH 7 /* "1024.0G" */
883#define HUMAN_READABLE_MAX_WIDTH_STR "7"
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000884//TODO: provide pointer to buf (avoid statics)?
885const char *make_human_readable_str(unsigned long long size,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000886 unsigned long block_size, unsigned long display_unit) FAST_FUNC;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000887/* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
Denys Vlasenko1f56e512011-10-19 22:40:35 +0200888char *bin2hex(char *dst, const char *src, int count) FAST_FUNC;
Denys Vlasenko48363312010-04-04 15:29:32 +0200889/* Reverse */
Denys Vlasenko1f56e512011-10-19 22:40:35 +0200890char* hex2bin(char *dst, const char *src, int count) FAST_FUNC;
Rob Landleyc5b1d4d2006-03-13 15:45:16 +0000891
Vladimir Dronnikovdb67a202009-10-15 09:24:25 +0200892/* Generate a UUID */
893void generate_uuid(uint8_t *buf) FAST_FUNC;
894
Denis Vlasenko1bab1de2007-07-27 15:30:39 +0000895/* Last element is marked by mult == 0 */
Eric Andersenaad1a882001-03-16 22:47:14 +0000896struct suffix_mult {
Denis Vlasenkof8689632007-07-27 15:06:25 +0000897 char suffix[4];
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000898 unsigned mult;
Eric Andersenaad1a882001-03-16 22:47:14 +0000899};
Denys Vlasenkoc72b43c2013-07-13 23:49:45 +0200900extern const struct suffix_mult bkm_suffixes[];
901#define km_suffixes (bkm_suffixes + 1)
Ari Sundholm88930232015-03-04 18:46:48 +0200902extern const struct suffix_mult cwbkMG_suffixes[];
Ari Sundholm911db162015-03-22 17:55:38 +0100903#define kMG_suffixes (cwbkMG_suffixes + 3)
Denys Vlasenkoc72b43c2013-07-13 23:49:45 +0200904
Denis Vlasenkoed836cd2006-11-25 14:44:13 +0000905#include "xatonum.h"
Denis Vlasenko13858992006-10-08 12:49:22 +0000906/* Specialized: */
Denys Vlasenko77832482010-08-12 14:14:45 +0200907
Denis Vlasenko13858992006-10-08 12:49:22 +0000908/* Using xatoi() instead of naive atoi() is not always convenient -
909 * in many places people want *non-negative* values, but store them
910 * in signed int. Therefore we need this one:
Denys Vlasenko77832482010-08-12 14:14:45 +0200911 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc.
912 * It should really be named xatoi_nonnegative (since it allows 0),
913 * but that would be too long.
914 */
915int xatoi_positive(const char *numstr) FAST_FUNC;
916
Denis Vlasenko13858992006-10-08 12:49:22 +0000917/* Useful for reading port numbers */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000918uint16_t xatou16(const char *numstr) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +0000919
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000920
Eric Andersenaad1a882001-03-16 22:47:14 +0000921/* These parse entries in /etc/passwd and /etc/group. This is desirable
922 * for BusyBox since we want to avoid using the glibc NSS stuff, which
Bernhard Reutner-Fischerd5bd1372005-09-20 21:06:17 +0000923 * increases target size and is often not needed on embedded systems. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000924long xuname2uid(const char *name) FAST_FUNC;
925long xgroup2gid(const char *name) FAST_FUNC;
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000926/* wrapper: allows string to contain numeric uid or gid */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000927unsigned long get_ug_id(const char *s, long FAST_FUNC (*xname2id)(const char *)) FAST_FUNC;
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000928struct bb_uidgid_t {
Denis Vlasenko150f4022007-01-13 21:06:21 +0000929 uid_t uid;
930 gid_t gid;
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000931};
Denys Vlasenko526d8582015-10-19 04:27:17 +0200932/* always sets uid and gid; returns 0 on failure */
933int get_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
934/* always sets uid and gid; exits on failure */
Bernhard Reutner-Fischerd73cbd32008-07-21 14:41:33 +0000935void xget_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
Denis Vlasenkocce38582007-02-26 22:47:42 +0000936/* chown-like handling of "user[:[group]" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000937void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group) FAST_FUNC;
Denis Vlasenkod7a805e2008-12-03 19:05:55 +0000938struct passwd* xgetpwnam(const char *name) FAST_FUNC;
Denis Vlasenko15437e32008-12-05 16:23:06 +0000939struct group* xgetgrnam(const char *name) FAST_FUNC;
Denis Vlasenko0c68a872008-12-02 22:56:59 +0000940struct passwd* xgetpwuid(uid_t uid) FAST_FUNC;
941struct group* xgetgrgid(gid_t gid) FAST_FUNC;
942char* xuid2uname(uid_t uid) FAST_FUNC;
943char* xgid2group(gid_t gid) FAST_FUNC;
944char* uid2uname(uid_t uid) FAST_FUNC;
945char* gid2group(gid_t gid) FAST_FUNC;
Denys Vlasenko7d65abe2011-03-01 16:27:13 +0100946char* uid2uname_utoa(uid_t uid) FAST_FUNC;
947char* gid2group_utoa(gid_t gid) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000948/* versions which cache results (useful for ps, ls etc) */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000949const char* get_cached_username(uid_t uid) FAST_FUNC;
950const char* get_cached_groupname(gid_t gid) FAST_FUNC;
951void clear_username_cache(void) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000952/* internally usernames are saved in fixed-sized char[] buffers */
Denys Vlasenko7d65abe2011-03-01 16:27:13 +0100953enum { USERNAME_MAX_SIZE = 32 - sizeof(uid_t) };
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +0000954#if ENABLE_FEATURE_CHECK_NAMES
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000955void die_if_bad_username(const char* name) FAST_FUNC;
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +0000956#else
957#define die_if_bad_username(name) ((void)(name))
958#endif
Eric Andersenaad1a882001-03-16 22:47:14 +0000959
Denys Vlasenko37f5bef2010-04-05 03:18:40 +0200960#if ENABLE_FEATURE_UTMP
Denys Vlasenko3a416112010-04-05 22:10:38 +0200961void FAST_FUNC write_new_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
962void 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 +0100963void FAST_FUNC update_utmp_DEAD_PROCESS(pid_t pid);
Denys Vlasenko37f5bef2010-04-05 03:18:40 +0200964#else
Denys Vlasenko3a416112010-04-05 22:10:38 +0200965# define write_new_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
966# define update_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
Denys Vlasenkoda921262015-01-05 15:37:58 +0100967# define update_utmp_DEAD_PROCESS(pid) ((void)0)
Denys Vlasenko37f5bef2010-04-05 03:18:40 +0200968#endif
969
Denys Vlasenkob72baeb2011-02-02 18:38:57 +0100970
Denys Vlasenkoe765b5a2014-05-02 17:15:58 +0200971int file_is_executable(const char *name) FAST_FUNC;
972char *find_executable(const char *filename, char **PATHp) FAST_FUNC;
973int executable_exists(const char *filename) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000974
Denis Vlasenko7e0fbf92007-09-04 19:33:22 +0000975/* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
976 * but it may exec busybox and call applet instead of searching PATH.
977 */
Denis Vlasenko80d14be2007-04-10 23:03:30 +0000978#if ENABLE_FEATURE_PREFER_APPLETS
Denys Vlasenkoc71b4692011-02-02 03:28:56 +0100979int BB_EXECVP(const char *file, char *const argv[]) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000980#define BB_EXECLP(prog,cmd,...) \
Denys Vlasenkoc71b4692011-02-02 03:28:56 +0100981 do { \
982 if (find_applet_by_name(prog) >= 0) \
983 execlp(bb_busybox_exec_path, cmd, __VA_ARGS__); \
984 execlp(prog, cmd, __VA_ARGS__); \
985 } while (0)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000986#else
987#define BB_EXECVP(prog,cmd) execvp(prog,cmd)
Denys Vlasenkoc71b4692011-02-02 03:28:56 +0100988#define BB_EXECLP(prog,cmd,...) execlp(prog,cmd,__VA_ARGS__)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000989#endif
Pascal Bellard21e8e8d2010-07-04 00:57:03 +0200990int BB_EXECVP_or_die(char **argv) NORETURN FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000991
Pascal Bellard926031b2010-07-04 15:32:38 +0200992/* xvfork() can't be a _function_, return after vfork mangles stack
993 * in the parent. It must be a macro. */
994#define xvfork() \
995({ \
996 pid_t bb__xvfork_pid = vfork(); \
997 if (bb__xvfork_pid < 0) \
998 bb_perror_msg_and_die("vfork"); \
999 bb__xvfork_pid; \
1000})
1001#if BB_MMU
1002pid_t xfork(void) FAST_FUNC;
1003#endif
1004
Denys Vlasenko8531d762010-03-18 22:44:00 +01001005/* NOMMU friendy fork+exec: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001006pid_t spawn(char **argv) FAST_FUNC;
1007pid_t xspawn(char **argv) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +00001008
Denis Vlasenko3854c5d2008-11-06 22:39:57 +00001009pid_t safe_waitpid(pid_t pid, int *wstat, int options) FAST_FUNC;
Denys Vlasenko8531d762010-03-18 22:44:00 +01001010pid_t wait_any_nohang(int *wstat) FAST_FUNC;
1011/* wait4pid: unlike waitpid, waits ONLY for one process.
1012 * Returns sig + 0x180 if child is killed by signal.
Denis Vlasenkocd7001f2007-04-09 21:32:30 +00001013 * It's safe to pass negative 'pids' from failed [v]fork -
Denis Vlasenko473dae02007-04-11 07:04:23 +00001014 * wait4pid will return -1 (and will not clobber [v]fork's errno).
Denis Vlasenkocd7001f2007-04-09 21:32:30 +00001015 * IOW: rc = wait4pid(spawn(argv));
1016 * if (rc < 0) bb_perror_msg("%s", argv[0]);
Denys Vlasenko8531d762010-03-18 22:44:00 +01001017 * if (rc > 0) bb_error_msg("exit code: %d", rc & 0xff);
Denis Vlasenkocd7001f2007-04-09 21:32:30 +00001018 */
Denis Vlasenko3854c5d2008-11-06 22:39:57 +00001019int wait4pid(pid_t pid) FAST_FUNC;
Denys Vlasenko8531d762010-03-18 22:44:00 +01001020/* Same as wait4pid(spawn(argv)), but with NOFORK/NOEXEC if configured: */
Denys Vlasenko8f24f982009-06-07 16:02:00 +02001021int spawn_and_wait(char **argv) FAST_FUNC;
Denis Vlasenko18e19f22007-04-28 16:43:18 +00001022/* Does NOT check that applet is NOFORK, just blindly runs it */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001023int run_nofork_applet(int applet_no, char **argv) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +00001024
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001025/* Helpers for daemonization.
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001026 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001027 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001028 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001029 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
1030 * rexec's itself on NOMMU with argv passed as command line.
1031 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
1032 * from the start. (It will detect it and not reexec again second time).
1033 * You have to audit carefully that you don't do something twice as a result
1034 * (opening files/sockets, parsing config files etc...)!
1035 *
1036 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
1037 * (will do setsid()).
1038 *
Pascal Bellard926031b2010-07-04 15:32:38 +02001039 * fork_or_rexec(argv) = bare-bones fork on MMU,
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001040 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
Denis Vlasenko83518d12009-03-20 22:17:13 +00001041 * On MMU ignores argv.
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001042 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001043 * Helper for network daemons in foreground mode:
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001044 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001045 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
1046 * to /dev/null if they are not.
1047 */
1048enum {
1049 DAEMON_CHDIR_ROOT = 1,
Denis Vlasenkoa1b16f42007-07-31 17:09:44 +00001050 DAEMON_DEVNULL_STDIO = 2,
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001051 DAEMON_CLOSE_EXTRA_FDS = 4,
1052 DAEMON_ONLY_SANITIZE = 8, /* internal use */
Peter Korsgaard743edac2011-11-09 19:44:37 +01001053 DAEMON_DOUBLE_FORK = 16, /* double fork to avoid controlling tty */
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001054};
Denis Vlasenko473dae02007-04-11 07:04:23 +00001055#if BB_MMU
Denis Vlasenko367960b2007-08-18 14:20:21 +00001056 enum { re_execed = 0 };
Pascal Bellard926031b2010-07-04 15:32:38 +02001057# define fork_or_rexec(argv) xfork()
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001058# define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
1059# define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001060#else
Pascal Bellard926031b2010-07-04 15:32:38 +02001061 extern bool re_execed;
Denys Vlasenkod2277e22011-11-22 17:19:26 +01001062 /* Note: re_exec() and fork_or_rexec() do argv[0][0] |= 0x80 on NOMMU!
1063 * _Parent_ needs to undo it if it doesn't want to have argv[0] mangled.
1064 */
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001065 void re_exec(char **argv) NORETURN FAST_FUNC;
Denis Vlasenko83518d12009-03-20 22:17:13 +00001066 pid_t fork_or_rexec(char **argv) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001067 int BUG_fork_is_unavailable_on_nommu(void) FAST_FUNC;
1068 int BUG_daemon_is_unavailable_on_nommu(void) FAST_FUNC;
1069 void BUG_bb_daemonize_is_unavailable_on_nommu(void) FAST_FUNC;
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001070# define fork() BUG_fork_is_unavailable_on_nommu()
Pascal Bellard926031b2010-07-04 15:32:38 +02001071# define xfork() BUG_fork_is_unavailable_on_nommu()
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001072# define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
1073# define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001074#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001075void bb_daemonize_or_rexec(int flags, char **argv) FAST_FUNC;
1076void bb_sanitize_stdio(void) FAST_FUNC;
Denis Vlasenkoc9ca0a32008-02-18 11:08:33 +00001077/* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001078int sanitize_env_if_suid(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001079
1080
Denys Vlasenkoe992bae2009-11-28 15:18:53 +01001081char* single_argv(char **argv) FAST_FUNC;
Denis Vlasenko62a90cd2008-03-17 09:07:36 +00001082extern const char *const bb_argv_dash[]; /* "-", NULL */
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001083extern const char *opt_complementary;
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001084#if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +00001085#define No_argument "\0"
1086#define Required_argument "\001"
1087#define Optional_argument "\002"
1088extern const char *applet_long_options;
Denis Vlasenkoc61852a2006-11-29 11:09:43 +00001089#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001090extern uint32_t option_mask32;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001091extern uint32_t getopt32(char **argv, const char *applet_opts, ...) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001092
1093
Denys Vlasenko9be47022011-05-16 12:21:31 +02001094/* Having next pointer as a first member allows easy creation
1095 * of "llist-compatible" structs, and using llist_FOO functions
1096 * on them.
1097 */
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001098typedef struct llist_t {
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001099 struct llist_t *link;
Denys Vlasenko9be47022011-05-16 12:21:31 +02001100 char *data;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001101} llist_t;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001102void llist_add_to(llist_t **old_head, void *data) FAST_FUNC;
1103void llist_add_to_end(llist_t **list_head, void *data) FAST_FUNC;
1104void *llist_pop(llist_t **elm) FAST_FUNC;
1105void llist_unlink(llist_t **head, llist_t *elm) FAST_FUNC;
1106void llist_free(llist_t *elm, void (*freeit)(void *data)) FAST_FUNC;
1107llist_t *llist_rev(llist_t *list) FAST_FUNC;
Denis Vlasenko0b791d92009-04-13 20:52:00 +00001108llist_t *llist_find_str(llist_t *first, const char *str) FAST_FUNC;
Denis Vlasenko4b924f32007-05-30 00:29:55 +00001109/* BTW, surprisingly, changing API to
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001110 * llist_t *llist_add_to(llist_t *old_head, void *data)
1111 * etc does not result in smaller code... */
1112
Denis Vlasenko80edead2007-08-02 22:31:05 +00001113/* start_stop_daemon and udhcpc are special - they want
1114 * to create pidfiles regardless of FEATURE_PIDFILE */
Denis Vlasenko1caca342007-08-02 10:14:29 +00001115#if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001116/* True only if we created pidfile which is *file*, not /dev/null etc */
1117extern smallint wrote_pidfile;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001118void write_pidfile(const char *path) FAST_FUNC;
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001119#define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
Denis Vlasenko10457b92007-03-27 22:01:31 +00001120#else
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001121enum { wrote_pidfile = 0 };
1122#define write_pidfile(path) ((void)0)
1123#define remove_pidfile(path) ((void)0)
Denis Vlasenko10457b92007-03-27 22:01:31 +00001124#endif
1125
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001126enum {
1127 LOGMODE_NONE = 0,
Denis Vlasenko1b97efd2007-08-17 19:18:06 +00001128 LOGMODE_STDIO = (1 << 0),
1129 LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001130 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
1131};
1132extern const char *msg_eol;
Denys Vlasenko3dfe0ae2014-04-30 14:48:28 +02001133extern smallint syslog_level;
Denis Vlasenko04c99eb2007-04-07 00:44:31 +00001134extern smallint logmode;
Denys Vlasenko7aa63042010-09-01 16:04:24 +02001135extern uint8_t xfunc_error_retval;
Denys Vlasenko550bf5b2015-10-09 16:42:57 +02001136extern void (*die_func)(void);
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001137extern void xfunc_die(void) NORETURN FAST_FUNC;
1138extern void bb_show_usage(void) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001139extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1140extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1141extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1142extern void bb_simple_perror_msg(const char *s) FAST_FUNC;
1143extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
Denis Vlasenkofb1a23d2009-03-07 01:54:24 +00001144extern void bb_simple_perror_msg_and_die(const char *s) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001145extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1146extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001147extern void bb_perror_nomsg_and_die(void) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001148extern void bb_perror_nomsg(void) FAST_FUNC;
1149extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1150extern void bb_verror_msg(const char *s, va_list p, const char *strerr) FAST_FUNC;
Michel Stamd3fabf82014-11-04 12:19:04 +01001151extern void bb_logenv_override(void) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001152
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +00001153/* We need to export XXX_main from libbusybox
1154 * only if we build "individual" binaries
1155 */
1156#if ENABLE_FEATURE_INDIVIDUAL
1157#define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
1158#else
1159#define MAIN_EXTERNALLY_VISIBLE
1160#endif
1161
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001162
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001163/* Applets which are useful from another applets */
Denis Vlasenko06af2162007-02-03 17:28:39 +00001164int bb_cat(char** argv);
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001165/* If shell needs them, they exist even if not enabled as applets */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001166int echo_main(int argc, char** argv) IF_ECHO(MAIN_EXTERNALLY_VISIBLE);
1167int printf_main(int argc, char **argv) IF_PRINTF(MAIN_EXTERNALLY_VISIBLE);
1168int test_main(int argc, char **argv) IF_TEST(MAIN_EXTERNALLY_VISIBLE);
1169int kill_main(int argc, char **argv) IF_KILL(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001170/* Similar, but used by chgrp, not shell */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001171int chown_main(int argc, char **argv) IF_CHOWN(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenkoc41cba52009-03-09 15:46:07 +00001172/* Used by ftpd */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001173int ls_main(int argc, char **argv) IF_LS(MAIN_EXTERNALLY_VISIBLE);
1174/* Don't need IF_xxx() guard for these */
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +00001175int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko77f1ec12007-10-13 03:36:03 +00001176int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko1a9e9bd2008-11-01 12:54:56 +00001177
Denis Vlasenko468aea22008-04-01 14:47:57 +00001178#if ENABLE_ROUTE
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001179void bb_displayroutes(int noresolve, int netstatfmt) FAST_FUNC;
Denis Vlasenko468aea22008-04-01 14:47:57 +00001180#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001181
Denis Vlasenko270c17c2006-12-26 17:40:33 +00001182
1183/* Networking */
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001184/* This structure defines protocol families and their handlers. */
1185struct aftype {
1186 const char *name;
1187 const char *title;
1188 int af;
1189 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001190 char* FAST_FUNC (*print)(unsigned char *);
1191 const char* FAST_FUNC (*sprint)(struct sockaddr *, int numeric);
1192 int FAST_FUNC (*input)(/*int type,*/ const char *bufp, struct sockaddr *);
1193 void FAST_FUNC (*herror)(char *text);
1194 int FAST_FUNC (*rprint)(int options);
1195 int FAST_FUNC (*rinput)(int typ, int ext, char **argv);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001196 /* may modify src */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001197 int FAST_FUNC (*getmask)(char *src, struct sockaddr *mask, char *name);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001198};
1199/* This structure defines hardware protocols and their handlers. */
1200struct hwtype {
1201 const char *name;
1202 const char *title;
1203 int type;
1204 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001205 char* FAST_FUNC (*print)(unsigned char *);
1206 int FAST_FUNC (*input)(const char *, struct sockaddr *);
1207 int FAST_FUNC (*activate)(int fd);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001208 int suppress_null_addr;
1209};
Denis Vlasenko1b16bda2007-06-19 11:10:02 +00001210extern smallint interface_opt_a;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001211int display_interfaces(char *ifname) FAST_FUNC;
Bartosz Golaszewskic19be752013-07-25 04:39:04 +02001212int in_ether(const char *bufp, struct sockaddr *sap) FAST_FUNC;
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001213#if ENABLE_FEATURE_HWIB
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001214int in_ib(const char *bufp, struct sockaddr *sap) FAST_FUNC;
Denis Vlasenko3b162ec2008-06-04 07:59:51 +00001215#else
1216#define in_ib(a, b) 1 /* fail */
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001217#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001218const struct aftype *get_aftype(const char *name) FAST_FUNC;
1219const struct hwtype *get_hwtype(const char *name) FAST_FUNC;
1220const struct hwtype *get_hwntype(int type) FAST_FUNC;
Denis Vlasenko270c17c2006-12-26 17:40:33 +00001221
1222
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001223#ifndef BUILD_INDIVIDUAL
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001224extern int find_applet_by_name(const char *name) FAST_FUNC;
Denis Vlasenko32b633a2007-04-09 03:05:48 +00001225/* Returns only if applet is not found. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001226extern void run_applet_and_exit(const char *name, char **argv) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001227extern void run_applet_no_and_exit(int a, char **argv) NORETURN FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001228#endif
1229
Mike Frysinger9412ec72008-02-07 22:41:33 +00001230#ifdef HAVE_MNTENT_H
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001231extern int match_fstype(const struct mntent *mt, const char *fstypes) FAST_FUNC;
Denys Vlasenko6ae64262009-07-18 16:22:26 +02001232extern struct mntent *find_mount_point(const char *name, int subdir_too) FAST_FUNC;
Mike Frysinger9412ec72008-02-07 22:41:33 +00001233#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001234extern void erase_mtab(const char * name) FAST_FUNC;
1235extern unsigned int tty_baud_to_value(speed_t speed) FAST_FUNC;
1236extern speed_t tty_value_to_baud(unsigned int value) FAST_FUNC;
Denys Vlasenkoa355da02010-01-04 13:16:08 +01001237#if ENABLE_DESKTOP
1238extern void bb_warn_ignoring_args(char *arg) FAST_FUNC;
1239#else
1240# define bb_warn_ignoring_args(arg) ((void)0)
1241#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001242
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001243extern int get_linux_version_code(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001244
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001245extern char *query_loop(const char *device) FAST_FUNC;
1246extern int del_loop(const char *device) FAST_FUNC;
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001247/* If *devname is not NULL, use that name, otherwise try to find free one,
1248 * malloc and return it in *devname.
1249 * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
Denys Vlasenko13e709c2011-09-12 02:13:47 +02001250extern int set_loop(char **devname, const char *file, unsigned long long offset, int ro) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001251
Bernhard Reutner-Fischer82b14292008-12-03 18:48:39 +00001252/* Like bb_ask below, but asks on stdin with no timeout. */
1253char *bb_ask_stdin(const char * prompt) FAST_FUNC;
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +00001254//TODO: pass buf pointer or return allocated buf (avoid statics)?
Bernhard Reutner-Fischer82b14292008-12-03 18:48:39 +00001255char *bb_ask(const int fd, int timeout, const char * prompt) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001256int bb_ask_confirmation(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001257
Denys Vlasenko5711a2a2015-10-07 17:55:33 +02001258/* Returns -1 if input is invalid. current_mode is a base for e.g. "u+rw" */
1259int bb_parse_mode(const char* s, unsigned cur_mode) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001260
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001261/*
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001262 * Config file parser
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001263 */
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001264enum {
Denis Vlasenko084266e2008-07-26 23:08:31 +00001265 PARSE_COLLAPSE = 0x00010000, // treat consecutive delimiters as one
1266 PARSE_TRIM = 0x00020000, // trim leading and trailing delimiters
1267// TODO: COLLAPSE and TRIM seem to always go in pair
1268 PARSE_GREEDY = 0x00040000, // last token takes entire remainder of the line
1269 PARSE_MIN_DIE = 0x00100000, // die if < min tokens found
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001270 // keep a copy of current line
Denis Vlasenko35a064b2008-11-06 00:49:59 +00001271 PARSE_KEEP_COPY = 0x00200000 * ENABLE_FEATURE_CROND_D,
Denys Vlasenko499597d2012-01-11 00:37:17 +01001272 PARSE_EOL_COMMENTS = 0x00400000, // comments are recognized even if they aren't the first char
Denis Vlasenko084266e2008-07-26 23:08:31 +00001273 // NORMAL is:
1274 // * remove leading and trailing delimiters and collapse
1275 // multiple delimiters into one
1276 // * warn and continue if less than mintokens delimiters found
1277 // * grab everything into last token
Denys Vlasenko499597d2012-01-11 00:37:17 +01001278 // * comments are recognized even if they aren't the first char
1279 PARSE_NORMAL = PARSE_COLLAPSE | PARSE_TRIM | PARSE_GREEDY | PARSE_EOL_COMMENTS,
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001280};
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001281typedef struct parser_t {
1282 FILE *fp;
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001283 char *data;
Timo Terasadcabf32011-06-20 09:49:56 +02001284 char *line, *nline;
1285 size_t line_alloc, nline_alloc;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001286 int lineno;
1287} parser_t;
Bernhard Reutner-Fischer67921282008-07-17 11:59:13 +00001288parser_t* config_open(const char *filename) FAST_FUNC;
Denis Vlasenko5415c852008-07-21 23:05:26 +00001289parser_t* config_open2(const char *filename, FILE* FAST_FUNC (*fopen_func)(const char *path)) FAST_FUNC;
Denys Vlasenkoadbbee42010-06-21 07:17:23 +02001290/* delims[0] is a comment char (use '\0' to disable), the rest are token delimiters */
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001291int config_read(parser_t *parser, char **tokens, unsigned flags, const char *delims) FAST_FUNC;
1292#define config_read(parser, tokens, max, min, str, flags) \
1293 config_read(parser, tokens, ((flags) | (((min) & 0xFF) << 8) | ((max) & 0xFF)), str)
Denis Vlasenkoc01340f2008-07-16 22:12:18 +00001294void config_close(parser_t *parser) FAST_FUNC;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001295
Denis Vlasenko6bf05cf2008-05-07 12:18:48 +00001296/* Concatenate path and filename to new allocated buffer.
1297 * Add "/" only as needed (no duplicate "//" are produced).
1298 * If path is NULL, it is assumed to be "/".
1299 * filename should not be NULL. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001300char *concat_path_file(const char *path, const char *filename) FAST_FUNC;
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +02001301/* Returns NULL on . and .. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001302char *concat_subpath_file(const char *path, const char *filename) FAST_FUNC;
Eric Andersene5dfced2001-04-09 22:48:12 +00001303
Denis Vlasenko4921b542007-02-03 02:17:41 +00001304
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001305int bb_make_directory(char *path, long mode, int flags) FAST_FUNC;
Matt Kraaiceeff732001-06-21 19:41:37 +00001306
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001307int get_signum(const char *name) FAST_FUNC;
1308const char *get_signame(int number) FAST_FUNC;
1309void print_signames(void) FAST_FUNC;
Rob Landleyc9c1a412006-07-12 19:17:55 +00001310
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001311char *bb_simplify_path(const char *path) FAST_FUNC;
Denis Vlasenko1cf4a0e2009-04-22 13:49:16 +00001312/* Returns ptr to NUL */
1313char *bb_simplify_abs_path_inplace(char *path) FAST_FUNC;
Eric Andersen34506362001-08-02 05:02:46 +00001314
Peter Kümmela6588fa2014-12-22 01:55:54 +01001315#ifndef LOGIN_FAIL_DELAY
Denys Vlasenko681efe22011-03-08 21:00:36 +01001316#define LOGIN_FAIL_DELAY 3
Peter Kümmela6588fa2014-12-22 01:55:54 +01001317#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001318extern void bb_do_delay(int seconds) FAST_FUNC;
1319extern void change_identity(const struct passwd *pw) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001320extern void run_shell(const char *shell, int loginshell, const char *command, const char **additional_args) NORETURN FAST_FUNC;
Denys Vlasenko681efe22011-03-08 21:00:36 +01001321
1322/* Returns $SHELL, getpwuid(getuid())->pw_shell, or DEFAULT_SHELL.
1323 * Note that getpwuid result might need xstrdup'ing
1324 * if there is a possibility of intervening getpwxxx() calls.
1325 */
Denys Vlasenkofd77ea52012-10-03 09:42:21 +02001326const char *get_shell_name(void) FAST_FUNC;
Denys Vlasenko681efe22011-03-08 21:00:36 +01001327
Denis Vlasenkob5a122b2006-12-30 14:46:51 +00001328#if ENABLE_SELINUX
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001329extern void renew_current_security_context(void) FAST_FUNC;
1330extern void set_current_security_context(security_context_t sid) FAST_FUNC;
Denis Vlasenko1203c9b2007-03-11 22:16:02 +00001331extern context_t set_security_context_component(security_context_t cur_context,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001332 char *user, char *role, char *type, char *range) FAST_FUNC;
1333extern void setfscreatecon_or_die(security_context_t scontext) FAST_FUNC;
1334extern void selinux_preserve_fcontext(int fdesc) FAST_FUNC;
Denis Vlasenko2edbc2a2007-10-20 02:00:49 +00001335#else
1336#define selinux_preserve_fcontext(fdesc) ((void)0)
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001337#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001338extern void selinux_or_die(void) FAST_FUNC;
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001339
Davide Cavalca9b3b9792011-01-25 02:26:03 +01001340
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001341/* setup_environment:
Bernhard Reutner-Fischer99709ab2010-02-24 16:10:09 +01001342 * if chdir pw->pw_dir: ok: else if to_tmp == 1: goto /tmp else: goto / or die
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001343 * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001344 * TERM=(old value)
1345 * USER=pw->pw_name, LOGNAME=pw->pw_name
1346 * PATH=bb_default_[root_]path
1347 * HOME=pw->pw_dir
1348 * SHELL=shell
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001349 * else if change_env = 1:
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001350 * if not root (if pw->pw_uid != 0):
1351 * USER=pw->pw_name, LOGNAME=pw->pw_name
1352 * HOME=pw->pw_dir
1353 * SHELL=shell
1354 * else does nothing
1355 */
Denys Vlasenkofd686a22010-02-26 09:52:45 +01001356#define SETUP_ENV_CHANGEENV (1 << 0)
1357#define SETUP_ENV_CLEARENV (1 << 1)
1358#define SETUP_ENV_TO_TMP (1 << 2)
Pascal Bellard70fc8c12012-06-12 13:21:02 +02001359#define SETUP_ENV_NO_CHDIR (1 << 4)
Denys Vlasenko8b59b2c2013-11-19 13:36:45 +01001360void setup_environment(const char *shell, int flags, const struct passwd *pw) FAST_FUNC;
1361void nuke_str(char *str) FAST_FUNC;
Morten Kvistgaardfeac9b62014-08-05 21:57:18 +02001362int check_password(const struct passwd *pw, const char *plaintext) FAST_FUNC;
Denys Vlasenko8b59b2c2013-11-19 13:36:45 +01001363int ask_and_check_password_extended(const struct passwd *pw, int timeout, const char *prompt) FAST_FUNC;
1364int ask_and_check_password(const struct passwd *pw) FAST_FUNC;
Denis Vlasenkofdddab02008-06-12 16:56:52 +00001365/* Returns a malloced string */
Denis Vlasenkob4c5bf62008-06-15 18:35:34 +00001366#if !ENABLE_USE_BB_CRYPT
1367#define pw_encrypt(clear, salt, cleanup) pw_encrypt(clear, salt)
1368#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001369extern char *pw_encrypt(const char *clear, const char *salt, int cleanup) FAST_FUNC;
1370extern int obscure(const char *old, const char *newval, const struct passwd *pwdp) FAST_FUNC;
Denys Vlasenko12a43272011-05-13 03:19:01 +02001371/*
1372 * rnd is additional random input. New one is returned.
Denis Vlasenko4ea83bf2008-06-12 16:55:59 +00001373 * Useful if you call crypt_make_salt many times in a row:
1374 * rnd = crypt_make_salt(buf1, 4, 0);
1375 * rnd = crypt_make_salt(buf2, 4, rnd);
1376 * rnd = crypt_make_salt(buf3, 4, rnd);
1377 * (otherwise we risk having same salt generated)
1378 */
Denys Vlasenko12a43272011-05-13 03:19:01 +02001379extern int crypt_make_salt(char *p, int cnt /*, int rnd*/) FAST_FUNC;
1380/* "$N$" + sha_salt_16_bytes + NUL */
1381#define MAX_PW_SALT_LEN (3 + 16 + 1)
1382extern char* crypt_make_pw_salt(char p[MAX_PW_SALT_LEN], const char *algo) FAST_FUNC;
1383
Denis Vlasenko829bbd32009-04-14 00:51:05 +00001384
Denis Vlasenko4ea83bf2008-06-12 16:55:59 +00001385/* Returns number of lines changed, or -1 on error */
Denis Vlasenko829bbd32009-04-14 00:51:05 +00001386#if !(ENABLE_FEATURE_ADDUSER_TO_GROUP || ENABLE_FEATURE_DEL_USER_FROM_GROUP)
1387#define update_passwd(filename, username, data, member) \
1388 update_passwd(filename, username, data)
1389#endif
1390extern int update_passwd(const char *filename,
1391 const char *username,
1392 const char *data,
1393 const char *member) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001394
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001395int index_in_str_array(const char *const string_array[], const char *key) FAST_FUNC;
1396int index_in_strings(const char *strings, const char *key) FAST_FUNC;
1397int index_in_substr_array(const char *const string_array[], const char *key) FAST_FUNC;
1398int index_in_substrings(const char *strings, const char *key) FAST_FUNC;
1399const char *nth_string(const char *strings, int n) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001400
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001401extern void print_login_issue(const char *issue_file, const char *tty) FAST_FUNC;
1402extern void print_login_prompt(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001403
Denys Vlasenko53283ad2009-11-02 14:20:34 +01001404char *xmalloc_ttyname(int fd) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof893da82007-08-09 08:27:24 +00001405/* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001406int get_terminal_width_height(int fd, unsigned *width, unsigned *height) FAST_FUNC;
Denys Vlasenko641caae2015-10-23 01:44:22 +02001407int get_terminal_width(int fd) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001408
Denis Vlasenko202ac502008-11-05 13:20:58 +00001409int tcsetattr_stdin_TCSANOW(const struct termios *tp) FAST_FUNC;
1410
Denis Vlasenko5bb2fc22008-04-21 03:23:59 +00001411/* NB: "unsigned request" is crucial! "int request" will break some arches! */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001412int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1413int 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 +00001414#if ENABLE_IOCTL_HEX2STR_ERROR
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001415int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1416int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001417#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1418#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
1419#else
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001420int bb_ioctl_or_warn(int fd, unsigned request, void *argp) FAST_FUNC;
1421int bb_xioctl(int fd, unsigned request, void *argp) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001422#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1423#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
1424#endif
1425
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001426char *is_in_ino_dev_hashtable(const struct stat *statbuf) FAST_FUNC;
1427void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name) FAST_FUNC;
1428void reset_ino_dev_hashtable(void) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001429#ifdef __GLIBC__
1430/* At least glibc has horrendously large inline for this, so wrap it */
Denys Vlasenko975c7142011-01-24 23:53:12 +01001431unsigned long long bb_makedev(unsigned major, unsigned minor) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001432#undef makedev
1433#define makedev(a,b) bb_makedev(a,b)
1434#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001435
1436
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001437/* "Keycodes" that report an escape sequence.
1438 * We use something which fits into signed char,
Denys Vlasenko5370bfb2009-09-06 02:58:59 +02001439 * yet doesn't represent any valid Unicode character.
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001440 * Also, -1 is reserved for error indication and we don't use it. */
1441enum {
1442 KEYCODE_UP = -2,
1443 KEYCODE_DOWN = -3,
1444 KEYCODE_RIGHT = -4,
1445 KEYCODE_LEFT = -5,
1446 KEYCODE_HOME = -6,
1447 KEYCODE_END = -7,
1448 KEYCODE_INSERT = -8,
1449 KEYCODE_DELETE = -9,
1450 KEYCODE_PAGEUP = -10,
1451 KEYCODE_PAGEDOWN = -11,
Denys Vlasenko9ce09bc2011-11-03 13:28:22 +01001452 // -12 is reserved for Alt/Ctrl/Shift-TAB
1453#if 0
1454 KEYCODE_FUN1 = -13,
1455 KEYCODE_FUN2 = -14,
1456 KEYCODE_FUN3 = -15,
1457 KEYCODE_FUN4 = -16,
1458 KEYCODE_FUN5 = -17,
1459 KEYCODE_FUN6 = -18,
1460 KEYCODE_FUN7 = -19,
1461 KEYCODE_FUN8 = -20,
1462 KEYCODE_FUN9 = -21,
1463 KEYCODE_FUN10 = -22,
1464 KEYCODE_FUN11 = -23,
1465 KEYCODE_FUN12 = -24,
1466#endif
1467 /* Be sure that last defined value is small enough
1468 * to not interfere with Alt/Ctrl/Shift bits.
1469 * So far we do not exceed -31 (0xfff..fffe1),
1470 * which gives us three upper bits in LSB to play with.
1471 */
1472 //KEYCODE_SHIFT_TAB = (-12) & ~0x80,
1473 //KEYCODE_SHIFT_... = KEYCODE_... & ~0x80,
1474 //KEYCODE_CTRL_UP = KEYCODE_UP & ~0x40,
1475 //KEYCODE_CTRL_DOWN = KEYCODE_DOWN & ~0x40,
Denys Vlasenkoa17eeb82009-10-25 23:50:56 +01001476 KEYCODE_CTRL_RIGHT = KEYCODE_RIGHT & ~0x40,
1477 KEYCODE_CTRL_LEFT = KEYCODE_LEFT & ~0x40,
Denys Vlasenko9ce09bc2011-11-03 13:28:22 +01001478 //KEYCODE_ALT_UP = KEYCODE_UP & ~0x20,
1479 //KEYCODE_ALT_DOWN = KEYCODE_DOWN & ~0x20,
1480 KEYCODE_ALT_RIGHT = KEYCODE_RIGHT & ~0x20,
1481 KEYCODE_ALT_LEFT = KEYCODE_LEFT & ~0x20,
1482
Denys Vlasenko180f5852009-10-26 00:59:59 +01001483 KEYCODE_CURSOR_POS = -0x100, /* 0xfff..fff00 */
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001484 /* How long is the longest ESC sequence we know?
1485 * We want it big enough to be able to contain
1486 * cursor position sequence "ESC [ 9999 ; 9999 R"
1487 */
1488 KEYCODE_BUFFER_SIZE = 16
1489};
1490/* Note: fd may be in blocking or non-blocking mode, both make sense.
1491 * For one, less uses non-blocking mode.
1492 * Only the first read syscall inside read_key may block indefinitely
1493 * (unless fd is in non-blocking mode),
1494 * subsequent reads will time out after a few milliseconds.
1495 * Return of -1 means EOF or error (errno == 0 on EOF).
1496 * buffer[0] is used as a counter of buffered chars and must be 0
1497 * on first call.
Denys Vlasenko58f108e2010-03-11 21:17:55 +01001498 * timeout:
1499 * -2: do not poll for input;
1500 * -1: poll(-1) (i.e. block);
1501 * >=0: poll for TIMEOUT milliseconds, return -1/EAGAIN on timeout
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001502 */
Denys Vlasenko58f108e2010-03-11 21:17:55 +01001503int64_t read_key(int fd, char *buffer, int timeout) FAST_FUNC;
Tomas Heinrichd2b04052010-03-09 14:09:24 +01001504void read_key_ungets(char *buffer, const char *str, unsigned len) FAST_FUNC;
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001505
1506
Denis Vlasenko38f63192007-01-22 09:03:07 +00001507#if ENABLE_FEATURE_EDITING
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001508/* It's NOT just ENABLEd or disabled. It's a number: */
Denys Vlasenko2c4de5b2011-03-31 13:16:52 +02001509# if defined CONFIG_FEATURE_EDITING_HISTORY && CONFIG_FEATURE_EDITING_HISTORY > 0
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001510# define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
Flemming Madsend96ffda2013-04-07 18:47:24 +02001511unsigned size_from_HISTFILESIZE(const char *hp) FAST_FUNC;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001512# else
1513# define MAX_HISTORY 0
1514# endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001515typedef struct line_input_t {
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001516 int flags;
1517 const char *path_lookup;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001518# if MAX_HISTORY
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001519 int cnt_history;
1520 int cur_history;
Denys Vlasenko2c4de5b2011-03-31 13:16:52 +02001521 int max_history; /* must never be <= 0 */
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001522# if ENABLE_FEATURE_EDITING_SAVEHISTORY
Denys Vlasenkobede2152011-09-04 16:12:33 +02001523 /* meaning of this field depends on FEATURE_EDITING_SAVE_ON_EXIT:
1524 * if !FEATURE_EDITING_SAVE_ON_EXIT: "how many lines are
1525 * in on-disk history"
1526 * if FEATURE_EDITING_SAVE_ON_EXIT: "how many in-memory lines are
1527 * also in on-disk history (and thus need to be skipped on save)"
1528 */
Denis Vlasenko57abf9e2009-03-22 19:00:05 +00001529 unsigned cnt_history_in_file;
Denis Vlasenko57abf9e2009-03-22 19:00:05 +00001530 const char *hist_file;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001531# endif
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001532 char *history[MAX_HISTORY + 1];
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001533# endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001534} line_input_t;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001535enum {
Denys Vlasenkoe45af7a2011-09-04 16:15:24 +02001536 DO_HISTORY = 1 * (MAX_HISTORY > 0),
1537 TAB_COMPLETION = 2 * ENABLE_FEATURE_TAB_COMPLETION,
1538 USERNAME_COMPLETION = 4 * ENABLE_FEATURE_USERNAME_COMPLETION,
1539 VI_MODE = 8 * ENABLE_FEATURE_EDITING_VI,
1540 WITH_PATH_LOOKUP = 0x10,
1541 FOR_SHELL = DO_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001542};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001543line_input_t *new_line_input_t(int flags) FAST_FUNC;
Denys Vlasenko5c2e81b2009-07-16 14:14:34 +02001544/* So far static: void free_line_input_t(line_input_t *n) FAST_FUNC; */
Denys Vlasenko046341e2011-02-04 17:53:59 +01001545/*
1546 * maxsize must be >= 2.
Denys Vlasenko5c2e81b2009-07-16 14:14:34 +02001547 * Returns:
Denis Vlasenko80667e32008-02-02 18:35:55 +00001548 * -1 on read errors or EOF, or on bare Ctrl-D,
1549 * 0 on ctrl-C (the line entered is still returned in 'command'),
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001550 * >0 length of input string, including terminating '\n'
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001551 */
Denys Vlasenko66c5b122011-02-08 05:07:02 +01001552int read_line_input(line_input_t *st, const char *prompt, char *command, int maxsize, int timeout) FAST_FUNC;
Flemming Madsend96ffda2013-04-07 18:47:24 +02001553void show_history(const line_input_t *st) FAST_FUNC;
Denys Vlasenkobede2152011-09-04 16:12:33 +02001554# if ENABLE_FEATURE_EDITING_SAVE_ON_EXIT
1555void save_history(line_input_t *st);
1556# endif
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001557#else
Denys Vlasenko36df0482009-10-19 16:07:28 +02001558#define MAX_HISTORY 0
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001559int read_line_input(const char* prompt, char* command, int maxsize) FAST_FUNC;
Denys Vlasenko66c5b122011-02-08 05:07:02 +01001560#define read_line_input(state, prompt, command, maxsize, timeout) \
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001561 read_line_input(prompt, command, maxsize)
1562#endif
1563
1564
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001565#ifndef COMM_LEN
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001566# ifdef TASK_COMM_LEN
Denis Vlasenkofa076802006-11-05 00:38:51 +00001567enum { COMM_LEN = TASK_COMM_LEN };
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001568# else
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001569/* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
Denis Vlasenkofa076802006-11-05 00:38:51 +00001570enum { COMM_LEN = 16 };
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001571# endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001572#endif
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02001573
1574struct smaprec {
1575 unsigned long mapped_rw;
1576 unsigned long mapped_ro;
1577 unsigned long shared_clean;
1578 unsigned long shared_dirty;
1579 unsigned long private_clean;
1580 unsigned long private_dirty;
1581 unsigned long stack;
1582 unsigned long smap_pss, smap_swap;
1583 unsigned long smap_size;
1584 unsigned long smap_start;
1585 char smap_mode[5];
1586 char *smap_name;
1587};
1588
1589#if !ENABLE_PMAP
1590#define procps_read_smaps(pid, total, cb, data) \
1591 procps_read_smaps(pid, total)
1592#endif
1593int FAST_FUNC procps_read_smaps(pid_t pid, struct smaprec *total,
Denys Vlasenko6830ade2013-01-15 13:58:01 +01001594 void (*cb)(struct smaprec *, void *), void *data);
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02001595
Denis Vlasenko512499c2007-08-26 18:23:13 +00001596typedef struct procps_status_t {
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001597 DIR *dir;
Denys Vlasenkob410d4a2009-09-19 22:29:42 +02001598 IF_FEATURE_SHOW_THREADS(DIR *task_dir;)
Denis Vlasenko512499c2007-08-26 18:23:13 +00001599 uint8_t shift_pages_to_bytes;
1600 uint8_t shift_pages_to_kb;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001601/* Fields are set to 0/NULL if failed to determine (or not requested) */
Denis Vlasenko3b3ca112008-07-17 18:39:36 +00001602 uint16_t argv_len;
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001603 char *argv0;
Alexander Shishkine766f622009-07-29 01:35:13 +02001604 char *exe;
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001605 IF_SELINUX(char *context;)
Lauri Kasanen6578f2c2010-12-05 05:22:29 +01001606 IF_FEATURE_SHOW_THREADS(unsigned main_thread_pid;)
Denis Vlasenko0696b8a2007-06-06 07:40:16 +00001607 /* Everything below must contain no ptrs to malloc'ed data:
1608 * it is memset(0) for each process in procps_scan() */
Denis Vlasenkofc1e9952007-08-29 18:23:36 +00001609 unsigned long vsz, rss; /* we round it to kbytes */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001610 unsigned long stime, utime;
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001611 unsigned long start_time;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001612 unsigned pid;
1613 unsigned ppid;
1614 unsigned pgid;
1615 unsigned sid;
1616 unsigned uid;
1617 unsigned gid;
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001618#if ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS
1619 unsigned ruid;
1620 unsigned rgid;
1621 int niceness;
1622#endif
Denis Vlasenko31789a82007-06-19 14:43:17 +00001623 unsigned tty_major,tty_minor;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001624#if ENABLE_FEATURE_TOPMEM
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02001625 struct smaprec smaps;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001626#endif
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001627 char state[4];
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001628 /* basename of executable in exec(2), read from /proc/N/stat
1629 * (if executable is symlink or script, it is NOT replaced
1630 * by link target or interpreter name) */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001631 char comm[COMM_LEN];
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001632 /* user/group? - use passwd/group parsing functions */
Denis Vlasenko17e7f042008-09-25 10:48:06 +00001633#if ENABLE_FEATURE_TOP_SMP_PROCESS
1634 int last_seen_on_cpu;
1635#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001636} procps_status_t;
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001637/* flag bits for procps_scan(xx, flags) calls */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001638enum {
1639 PSSCAN_PID = 1 << 0,
1640 PSSCAN_PPID = 1 << 1,
1641 PSSCAN_PGID = 1 << 2,
1642 PSSCAN_SID = 1 << 3,
1643 PSSCAN_UIDGID = 1 << 4,
1644 PSSCAN_COMM = 1 << 5,
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001645 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001646 PSSCAN_ARGV0 = 1 << 7,
Alexander Shishkine766f622009-07-29 01:35:13 +02001647 PSSCAN_EXE = 1 << 8,
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001648 PSSCAN_STATE = 1 << 9,
1649 PSSCAN_VSZ = 1 << 10,
1650 PSSCAN_RSS = 1 << 11,
1651 PSSCAN_STIME = 1 << 12,
1652 PSSCAN_UTIME = 1 << 13,
1653 PSSCAN_TTY = 1 << 14,
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001654 PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM,
Denis Vlasenko9f00e052009-02-14 01:36:11 +00001655 /* NB: used by find_pid_by_name(). Any applet using it
1656 * needs to be mentioned here. */
1657 PSSCAN_ARGVN = (1 << 16) * (ENABLE_KILLALL
1658 || ENABLE_PGREP || ENABLE_PKILL
1659 || ENABLE_PIDOF
Denis Vlasenko3266aa92009-04-01 11:24:04 +00001660 || ENABLE_SESTATUS
Denis Vlasenko9f00e052009-02-14 01:36:11 +00001661 ),
Denys Vlasenko4ff1ce02009-09-22 11:21:48 +02001662 PSSCAN_CONTEXT = (1 << 17) * ENABLE_SELINUX,
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001663 PSSCAN_START_TIME = 1 << 18,
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001664 PSSCAN_CPU = (1 << 19) * ENABLE_FEATURE_TOP_SMP_PROCESS,
1665 PSSCAN_NICE = (1 << 20) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1666 PSSCAN_RUIDGID = (1 << 21) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
Denys Vlasenkob410d4a2009-09-19 22:29:42 +02001667 PSSCAN_TASKS = (1 << 22) * ENABLE_FEATURE_SHOW_THREADS,
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001668};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001669//procps_status_t* alloc_procps_scan(void) FAST_FUNC;
1670void free_procps_scan(procps_status_t* sp) FAST_FUNC;
1671procps_status_t* procps_scan(procps_status_t* sp, int flags) FAST_FUNC;
Denys Vlasenko3a0f6f22009-09-12 00:15:34 +02001672/* Format cmdline (up to col chars) into char buf[size] */
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001673/* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
Denys Vlasenko3a0f6f22009-09-12 00:15:34 +02001674void read_cmdline(char *buf, int size, unsigned pid, const char *comm) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001675pid_t *find_pid_by_name(const char* procName) FAST_FUNC;
1676pid_t *pidlist_reverse(pid_t *pidList) FAST_FUNC;
Denys Vlasenkoc9b97502010-08-16 02:49:21 +02001677int starts_with_cpu(const char *str) FAST_FUNC;
1678unsigned get_cpu_count(void) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001679
1680
Denys Vlasenkodd1061b2011-09-11 21:04:02 +02001681/* Use strict=1 if you process input from untrusted source:
1682 * it will return NULL on invalid %xx (bad hex chars)
1683 * and str + 1 if decoded char is / or NUL.
1684 * In non-strict mode, it always succeeds (returns str),
1685 * and also it additionally decoded '+' to space.
1686 */
1687char *percent_decode_in_place(char *str, int strict) FAST_FUNC;
1688
1689
Aurelien Jarnod3a42392012-07-24 16:28:34 +02001690extern const char bb_uuenc_tbl_base64[] ALIGN1;
1691extern const char bb_uuenc_tbl_std[] ALIGN1;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001692void bb_uuencode(char *store, const void *s, int length, const char *tbl) FAST_FUNC;
Denys Vlasenko9fe98f72010-09-16 17:51:13 +02001693enum {
1694 BASE64_FLAG_UU_STOP = 0x100,
1695 /* Sign-extends to a value which never matches fgetc result: */
1696 BASE64_FLAG_NO_STOP_CHAR = 0x80,
1697};
Leonid Lisovskiy328f27f2011-10-28 13:59:04 +02001698const char *decode_base64(char **pp_dst, const char *src) FAST_FUNC;
1699void read_base64(FILE *src_stream, FILE *dst_stream, int flags) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001700
Denis Vlasenkodd539f72006-11-01 20:20:37 +00001701typedef struct md5_ctx_t {
Denys Vlasenko302ad142010-10-19 02:16:12 +02001702 uint8_t wbuffer[64]; /* always correctly aligned for uint64_t */
1703 void (*process_block)(struct md5_ctx_t*) FAST_FUNC;
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02001704 uint64_t total64; /* must be directly before hash[] */
Denys Vlasenko302ad142010-10-19 02:16:12 +02001705 uint32_t hash[8]; /* 4 elements for md5, 5 for sha1, 8 for sha256 */
1706} md5_ctx_t;
1707typedef struct md5_ctx_t sha1_ctx_t;
1708typedef struct md5_ctx_t sha256_ctx_t;
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02001709typedef struct sha512_ctx_t {
1710 uint64_t total64[2]; /* must be directly before hash[] */
1711 uint64_t hash[8];
Denys Vlasenko302ad142010-10-19 02:16:12 +02001712 uint8_t wbuffer[128]; /* always correctly aligned for uint64_t */
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02001713} sha512_ctx_t;
Lauri Kasanenb8173b62013-01-14 05:20:50 +01001714typedef struct sha3_ctx_t {
1715 uint64_t state[25];
1716 unsigned bytes_queued;
1717} sha3_ctx_t;
Denys Vlasenko302ad142010-10-19 02:16:12 +02001718void md5_begin(md5_ctx_t *ctx) FAST_FUNC;
Denys Vlasenko2cfcc9e2013-01-20 00:38:09 +01001719void md5_hash(md5_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
Denys Vlasenko302ad142010-10-19 02:16:12 +02001720void md5_end(md5_ctx_t *ctx, void *resbuf) FAST_FUNC;
1721void sha1_begin(sha1_ctx_t *ctx) FAST_FUNC;
1722#define sha1_hash md5_hash
1723void sha1_end(sha1_ctx_t *ctx, void *resbuf) FAST_FUNC;
1724void sha256_begin(sha256_ctx_t *ctx) FAST_FUNC;
1725#define sha256_hash md5_hash
1726#define sha256_end sha1_end
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02001727void sha512_begin(sha512_ctx_t *ctx) FAST_FUNC;
1728void sha512_hash(sha512_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
1729void sha512_end(sha512_ctx_t *ctx, void *resbuf) FAST_FUNC;
Lauri Kasanenb8173b62013-01-14 05:20:50 +01001730void sha3_begin(sha3_ctx_t *ctx) FAST_FUNC;
1731void sha3_hash(sha3_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
Denys Vlasenko2cfcc9e2013-01-20 00:38:09 +01001732void sha3_end(sha3_ctx_t *ctx, void *resbuf) FAST_FUNC;
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00001733
Denys Vlasenko9ce642f2010-10-27 15:26:45 +02001734extern uint32_t *global_crc32_table;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001735uint32_t *crc32_filltable(uint32_t *tbl256, int endian) FAST_FUNC;
Denys Vlasenko9ce642f2010-10-27 15:26:45 +02001736uint32_t crc32_block_endian1(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
1737uint32_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 +00001738
1739typedef struct masks_labels_t {
1740 const char *labels;
1741 const int masks[];
1742} masks_labels_t;
1743int print_flags_separated(const int *masks, const char *labels,
1744 int flags, const char *separator) FAST_FUNC;
1745int print_flags(const masks_labels_t *ml, int flags) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001746
Magnus Dammf5914992009-11-08 16:34:43 +01001747typedef struct bb_progress_t {
Denys Vlasenkoab8d00d2011-02-11 19:09:30 +01001748 unsigned last_size;
1749 unsigned last_update_sec;
1750 unsigned last_change_sec;
Magnus Dammf5914992009-11-08 16:34:43 +01001751 unsigned start_sec;
Denys Vlasenkod55e1392011-02-11 18:56:13 +01001752 const char *curfile;
Magnus Dammf5914992009-11-08 16:34:43 +01001753} bb_progress_t;
1754
Denys Vlasenkod55e1392011-02-11 18:56:13 +01001755#define is_bb_progress_inited(p) ((p)->curfile != NULL)
1756#define bb_progress_free(p) do { \
1757 if (ENABLE_UNICODE_SUPPORT) free((char*)((p)->curfile)); \
1758 (p)->curfile = NULL; \
1759} while (0)
1760void bb_progress_init(bb_progress_t *p, const char *curfile) FAST_FUNC;
1761void bb_progress_update(bb_progress_t *p,
Denys Vlasenko805aa9f2011-02-10 14:25:51 +01001762 uoff_t beg_range,
1763 uoff_t transferred,
1764 uoff_t totalsize) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001765
Denys Vlasenkod55e1392011-02-11 18:56:13 +01001766
Denis Vlasenko8f8f2682006-10-03 21:00:43 +00001767extern const char *applet_name;
Denys Vlasenko0004e992010-09-01 12:01:17 +02001768
1769/* Some older linkers don't perform string merging, we used to have common strings
1770 * as global arrays to do it by hand. But:
1771 * (1) newer linkers do it themselves,
1772 * (2) however, they DONT merge string constants with global arrays,
1773 * even if the value is the same (!). Thus global arrays actually
1774 * increased size a bit: for example, "/etc/passwd" string from libc
1775 * wasn't merged with bb_path_passwd_file[] array!
1776 * Therefore now we use #defines.
1777 */
Bernhard Reutner-Fischer78e1d582008-01-13 17:52:53 +00001778/* "BusyBox vN.N.N (timestamp or extra_version)" */
Aurelien Jarnod3a42392012-07-24 16:28:34 +02001779extern const char bb_banner[] ALIGN1;
1780extern const char bb_msg_memory_exhausted[] ALIGN1;
1781extern const char bb_msg_invalid_date[] ALIGN1;
Denys Vlasenko0004e992010-09-01 12:01:17 +02001782#define bb_msg_read_error "read error"
1783#define bb_msg_write_error "write error"
Aurelien Jarnod3a42392012-07-24 16:28:34 +02001784extern const char bb_msg_unknown[] ALIGN1;
1785extern const char bb_msg_can_not_create_raw_socket[] ALIGN1;
1786extern const char bb_msg_perm_denied_are_you_root[] ALIGN1;
1787extern const char bb_msg_you_must_be_root[] ALIGN1;
1788extern const char bb_msg_requires_arg[] ALIGN1;
Denys Vlasenko0f296a32015-10-14 13:21:01 +02001789extern const char bb_msg_invalid_arg_to[] ALIGN1;
Aurelien Jarnod3a42392012-07-24 16:28:34 +02001790extern const char bb_msg_standard_input[] ALIGN1;
1791extern const char bb_msg_standard_output[] ALIGN1;
Manuel Novoa III cad53642003-03-19 09:13:01 +00001792
Denis Vlasenko98c0bba2007-01-26 23:31:05 +00001793/* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
Aurelien Jarnod3a42392012-07-24 16:28:34 +02001794extern const char bb_hexdigits_upcase[] ALIGN1;
Denis Vlasenko7ca39212006-11-21 20:34:21 +00001795
Aurelien Jarnod3a42392012-07-24 16:28:34 +02001796extern const char bb_path_wtmp_file[] ALIGN1;
Denys Vlasenko0004e992010-09-01 12:01:17 +02001797
1798/* Busybox mount uses either /proc/mounts or /etc/mtab to
1799 * get the list of currently mounted filesystems */
1800#define bb_path_mtab_file IF_FEATURE_MTAB_SUPPORT("/etc/mtab")IF_NOT_FEATURE_MTAB_SUPPORT("/proc/mounts")
1801
Tito Ragusaad3d72f2011-01-16 23:39:45 +01001802#define bb_path_passwd_file _PATH_PASSWD
1803#define bb_path_group_file _PATH_GROUP
1804#define bb_path_shadow_file _PATH_SHADOW
1805#define bb_path_gshadow_file _PATH_GSHADOW
Denys Vlasenko0004e992010-09-01 12:01:17 +02001806
1807#define bb_path_motd_file "/etc/motd"
1808
1809#define bb_dev_null "/dev/null"
Aurelien Jarnod3a42392012-07-24 16:28:34 +02001810extern const char bb_busybox_exec_path[] ALIGN1;
Denis Vlasenko15611bb2007-06-12 08:52:02 +00001811/* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1812 * but I want to save a few bytes here */
Aurelien Jarnod3a42392012-07-24 16:28:34 +02001813extern const char bb_PATH_root_path[] ALIGN1; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
Denis Vlasenkof5f75c52007-06-12 22:35:19 +00001814#define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1815#define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +00001816
Denis Vlasenko703e2022007-01-22 14:12:08 +00001817extern const int const_int_0;
Denys Vlasenkoc52cbea2015-08-24 19:48:03 +02001818//extern const int const_int_1;
Denis Vlasenko703e2022007-01-22 14:12:08 +00001819
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001820
Denis Vlasenko85818632007-04-19 14:47:11 +00001821/* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
Denis Vlasenko74324c82007-06-04 10:16:52 +00001822enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
1823extern char bb_common_bufsiz1[COMMON_BUFSIZE];
Denis Vlasenko972288e2007-03-15 00:57:01 +00001824/* This struct is deliberately not defined. */
1825/* See docs/keep_data_small.txt */
1826struct globals;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001827/* '*const' ptr makes gcc optimize code much better.
Denis Vlasenkoe3241842007-08-13 10:36:25 +00001828 * Magic prevents ptr_to_globals from going into rodata.
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001829 * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
Denis Vlasenkobff32ce2007-03-15 19:48:35 +00001830extern struct globals *const ptr_to_globals;
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001831/* At least gcc 3.4.6 on mipsel system needs optimization barrier */
Bernhard Reutner-Fischer797c96d2008-06-06 10:31:39 +00001832#define barrier() __asm__ __volatile__("":::"memory")
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001833#define SET_PTR_TO_GLOBALS(x) do { \
Denys Vlasenko90a99042009-09-06 02:36:23 +02001834 (*(struct globals**)&ptr_to_globals) = (void*)(x); \
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001835 barrier(); \
1836} while (0)
Guilherme Maciel Ferreira840ef172013-10-16 14:43:30 +02001837#define FREE_PTR_TO_GLOBALS() do { \
1838 if (ENABLE_FEATURE_CLEAN_UP) { \
1839 free(ptr_to_globals); \
1840 } \
1841} while (0)
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001842
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001843/* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1844 * use bb_default_login_shell and following defines.
1845 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1846 * don't forget to change increment constant. */
Ladislav Michla73b87e2010-06-27 03:23:31 +02001847#define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
Aurelien Jarnod3a42392012-07-24 16:28:34 +02001848extern const char bb_default_login_shell[] ALIGN1;
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001849/* "/bin/sh" */
Ladislav Michla73b87e2010-06-27 03:23:31 +02001850#define DEFAULT_SHELL (bb_default_login_shell+1)
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001851/* "sh" */
Ladislav Michla73b87e2010-06-27 03:23:31 +02001852#define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001853
Jeremie Koenig816ed972010-05-27 15:46:29 +02001854/* The following devices are the same on all systems. */
1855#define CURRENT_TTY "/dev/tty"
1856#define DEV_CONSOLE "/dev/console"
1857
1858#if defined(__FreeBSD_kernel__)
1859# define CURRENT_VC CURRENT_TTY
1860# define VC_1 "/dev/ttyv0"
1861# define VC_2 "/dev/ttyv1"
1862# define VC_3 "/dev/ttyv2"
1863# define VC_4 "/dev/ttyv3"
1864# define VC_5 "/dev/ttyv4"
1865# define VC_FORMAT "/dev/ttyv%d"
1866#elif defined(__GNU__)
1867# define CURRENT_VC CURRENT_TTY
1868# define VC_1 "/dev/tty1"
1869# define VC_2 "/dev/tty2"
1870# define VC_3 "/dev/tty3"
1871# define VC_4 "/dev/tty4"
1872# define VC_5 "/dev/tty5"
1873# define VC_FORMAT "/dev/tty%d"
Denys Vlasenko1c26e052010-10-24 02:35:17 +02001874#elif ENABLE_FEATURE_DEVFS
1875/*Linux, obsolete devfs names */
Matt Kraai439e3df2001-07-23 14:52:08 +00001876# define CURRENT_VC "/dev/vc/0"
1877# define VC_1 "/dev/vc/1"
1878# define VC_2 "/dev/vc/2"
1879# define VC_3 "/dev/vc/3"
1880# define VC_4 "/dev/vc/4"
1881# define VC_5 "/dev/vc/5"
Matt Kraai439e3df2001-07-23 14:52:08 +00001882# define VC_FORMAT "/dev/vc/%d"
Denys Vlasenko4928e9f2013-06-27 03:45:16 +02001883# define LOOP_FORMAT "/dev/loop/%u"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001884# define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001885# define LOOP_NAME "/dev/loop/"
Eric Andersen5f284552003-11-14 03:11:29 +00001886# define FB_0 "/dev/fb/0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001887#else
Denys Vlasenko1c26e052010-10-24 02:35:17 +02001888/*Linux, normal names */
Matt Kraai439e3df2001-07-23 14:52:08 +00001889# define CURRENT_VC "/dev/tty0"
1890# define VC_1 "/dev/tty1"
1891# define VC_2 "/dev/tty2"
1892# define VC_3 "/dev/tty3"
1893# define VC_4 "/dev/tty4"
1894# define VC_5 "/dev/tty5"
Matt Kraai439e3df2001-07-23 14:52:08 +00001895# define VC_FORMAT "/dev/tty%d"
Denys Vlasenko4928e9f2013-06-27 03:45:16 +02001896# define LOOP_FORMAT "/dev/loop%u"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001897# define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001898# define LOOP_NAME "/dev/loop"
Eric Andersen5f284552003-11-14 03:11:29 +00001899# define FB_0 "/dev/fb0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001900#endif
1901
Rob Landleyc57ec372006-04-10 17:07:15 +00001902
Denys Vlasenko9d57a802009-10-23 14:24:44 +02001903#define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
Denys Vlasenkoab3964d2015-10-13 14:50:20 +02001904#define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
Denys Vlasenko9d57a802009-10-23 14:24:44 +02001905
Rob Landleyb623a542006-05-31 22:09:03 +00001906
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001907/* We redefine ctype macros. Unicode-correct handling of char types
1908 * can't be done with such byte-oriented operations anyway,
1909 * we don't lose anything.
1910 */
Rob Landley4ae905a2006-07-06 17:22:54 +00001911#undef isalnum
1912#undef isalpha
1913#undef isascii
1914#undef isblank
1915#undef iscntrl
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001916#undef isdigit
Rob Landley4ae905a2006-07-06 17:22:54 +00001917#undef isgraph
1918#undef islower
1919#undef isprint
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001920#undef ispunct
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001921#undef isspace
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001922#undef isupper
1923#undef isxdigit
1924#undef toupper
1925#undef tolower
Rob Landley4ae905a2006-07-06 17:22:54 +00001926
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001927/* We save ~500 bytes on isdigit alone.
Denys Vlasenko7b4cd6f2009-10-23 02:22:03 +02001928 * BTW, x86 likes (unsigned char) cast more than (unsigned). */
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001929
1930/* These work the same for ASCII and Unicode,
1931 * assuming no one asks "is this a *Unicode* letter?" using isalpha(letter) */
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001932#define isascii(a) ((unsigned char)(a) <= 0x7f)
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001933#define isdigit(a) ((unsigned char)((a) - '0') <= 9)
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001934#define isupper(a) ((unsigned char)((a) - 'A') <= ('Z' - 'A'))
1935#define islower(a) ((unsigned char)((a) - 'a') <= ('z' - 'a'))
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001936#define isalpha(a) ((unsigned char)(((a)|0x20) - 'a') <= ('z' - 'a'))
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001937#define isblank(a) ({ unsigned char bb__isblank = (a); bb__isblank == ' ' || bb__isblank == '\t'; })
1938#define iscntrl(a) ({ unsigned char bb__iscntrl = (a); bb__iscntrl < ' ' || bb__iscntrl == 0x7f; })
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001939/* In POSIX/C locale isspace is only these chars: "\t\n\v\f\r" and space.
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001940 * "\t\n\v\f\r" happen to have ASCII codes 9,10,11,12,13.
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001941 */
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001942#define isspace(a) ({ unsigned char bb__isspace = (a) - 9; bb__isspace == (' ' - 9) || bb__isspace <= (13 - 9); })
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001943// Unsafe wrt NUL: #define ispunct(a) (strchr("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a)) != NULL)
1944#define ispunct(a) (strchrnul("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a))[0])
1945// 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 +02001946#define isalnum(a) bb_ascii_isalnum(a)
1947static ALWAYS_INLINE int bb_ascii_isalnum(unsigned char a)
1948{
1949 unsigned char b = a - '0';
1950 if (b <= 9)
1951 return (b <= 9);
1952 b = (a|0x20) - 'a';
1953 return b <= 'z' - 'a';
1954}
1955#define isxdigit(a) bb_ascii_isxdigit(a)
1956static ALWAYS_INLINE int bb_ascii_isxdigit(unsigned char a)
1957{
1958 unsigned char b = a - '0';
1959 if (b <= 9)
1960 return (b <= 9);
1961 b = (a|0x20) - 'a';
1962 return b <= 'f' - 'a';
1963}
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001964#define toupper(a) bb_ascii_toupper(a)
1965static ALWAYS_INLINE unsigned char bb_ascii_toupper(unsigned char a)
1966{
1967 unsigned char b = a - 'a';
1968 if (b <= ('z' - 'a'))
1969 a -= 'a' - 'A';
1970 return a;
1971}
1972#define tolower(a) bb_ascii_tolower(a)
1973static ALWAYS_INLINE unsigned char bb_ascii_tolower(unsigned char a)
1974{
1975 unsigned char b = a - 'A';
1976 if (b <= ('Z' - 'A'))
1977 a += 'a' - 'A';
1978 return a;
1979}
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001980
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001981/* In ASCII and Unicode, these are likely to be very different.
1982 * Let's prevent ambiguous usage from the start */
1983#define isgraph(a) isgraph_is_ambiguous_dont_use(a)
1984#define isprint(a) isprint_is_ambiguous_dont_use(a)
1985/* NB: must not treat EOF as isgraph or isprint */
1986#define isgraph_asciionly(a) ((unsigned)((a) - 0x21) <= 0x7e - 0x21)
1987#define isprint_asciionly(a) ((unsigned)((a) - 0x20) <= 0x7e - 0x20)
1988
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001989
Bartosz Golaszewski3ed81cf2014-06-22 16:30:41 +02001990/* Simple unit-testing framework */
1991
1992typedef void (*bbunit_testfunc)(void);
1993
1994struct bbunit_listelem {
Bartosz Golaszewski3ed81cf2014-06-22 16:30:41 +02001995 const char* name;
1996 bbunit_testfunc testfunc;
1997};
1998
1999void bbunit_registertest(struct bbunit_listelem* test);
2000void bbunit_settestfailed(void);
2001
2002#define BBUNIT_DEFINE_TEST(NAME) \
2003 static void bbunit_##NAME##_test(void); \
2004 static struct bbunit_listelem bbunit_##NAME##_elem = { \
2005 .name = #NAME, \
2006 .testfunc = bbunit_##NAME##_test, \
2007 }; \
Bartosz Golaszewskibf0f2c72014-06-26 14:31:05 +02002008 static void INIT_FUNC bbunit_##NAME##_register(void) \
Bartosz Golaszewski3ed81cf2014-06-22 16:30:41 +02002009 { \
2010 bbunit_registertest(&bbunit_##NAME##_elem); \
2011 } \
2012 static void bbunit_##NAME##_test(void)
2013
2014/*
2015 * Both 'goto bbunit_end' and 'break' are here only to get rid
2016 * of compiler warnings.
2017 */
2018#define BBUNIT_ENDTEST \
2019 do { \
2020 goto bbunit_end; \
2021 bbunit_end: \
2022 break; \
2023 } while (0)
2024
2025#define BBUNIT_PRINTASSERTFAIL \
2026 do { \
2027 bb_error_msg( \
2028 "[ERROR] Assertion failed in file %s, line %d", \
2029 __FILE__, __LINE__); \
2030 } while (0)
2031
2032#define BBUNIT_ASSERTION_FAILED \
2033 do { \
2034 bbunit_settestfailed(); \
2035 goto bbunit_end; \
2036 } while (0)
2037
2038/*
2039 * Assertions.
2040 * For now we only offer assertions which cause tests to fail
2041 * immediately. In the future 'expects' might be added too -
2042 * similar to those offered by the gtest framework.
2043 */
2044#define BBUNIT_ASSERT_EQ(EXPECTED, ACTUAL) \
2045 do { \
2046 if ((EXPECTED) != (ACTUAL)) { \
2047 BBUNIT_PRINTASSERTFAIL; \
2048 bb_error_msg("[ERROR] '%s' isn't equal to '%s'", \
2049 #EXPECTED, #ACTUAL); \
2050 BBUNIT_ASSERTION_FAILED; \
2051 } \
2052 } while (0)
2053
2054#define BBUNIT_ASSERT_NOTEQ(EXPECTED, ACTUAL) \
2055 do { \
2056 if ((EXPECTED) == (ACTUAL)) { \
2057 BBUNIT_PRINTASSERTFAIL; \
2058 bb_error_msg("[ERROR] '%s' is equal to '%s'", \
2059 #EXPECTED, #ACTUAL); \
2060 BBUNIT_ASSERTION_FAILED; \
2061 } \
2062 } while (0)
2063
2064#define BBUNIT_ASSERT_NOTNULL(PTR) \
2065 do { \
2066 if ((PTR) == NULL) { \
2067 BBUNIT_PRINTASSERTFAIL; \
2068 bb_error_msg("[ERROR] '%s' is NULL!", #PTR); \
2069 BBUNIT_ASSERTION_FAILED; \
2070 } \
2071 } while (0)
2072
2073#define BBUNIT_ASSERT_NULL(PTR) \
2074 do { \
2075 if ((PTR) != NULL) { \
2076 BBUNIT_PRINTASSERTFAIL; \
2077 bb_error_msg("[ERROR] '%s' is not NULL!", #PTR); \
2078 BBUNIT_ASSERTION_FAILED; \
2079 } \
2080 } while (0)
2081
2082#define BBUNIT_ASSERT_FALSE(STATEMENT) \
2083 do { \
2084 if ((STATEMENT)) { \
2085 BBUNIT_PRINTASSERTFAIL; \
2086 bb_error_msg("[ERROR] Statement '%s' evaluated to true!", \
2087 #STATEMENT); \
2088 BBUNIT_ASSERTION_FAILED; \
2089 } \
2090 } while (0)
2091
2092#define BBUNIT_ASSERT_TRUE(STATEMENT) \
2093 do { \
2094 if (!(STATEMENT)) { \
2095 BBUNIT_PRINTASSERTFAIL; \
2096 bb_error_msg("[ERROR] Statement '%s' evaluated to false!", \
2097 #STATEMENT); \
2098 BBUNIT_ASSERTION_FAILED; \
2099 } \
2100 } while (0)
2101
2102#define BBUNIT_ASSERT_STREQ(STR1, STR2) \
2103 do { \
2104 if (strcmp(STR1, STR2) != 0) { \
2105 BBUNIT_PRINTASSERTFAIL; \
2106 bb_error_msg("[ERROR] Strings '%s' and '%s' " \
2107 "are not the same", STR1, STR2); \
2108 BBUNIT_ASSERTION_FAILED; \
2109 } \
2110 } while (0)
2111
2112#define BBUNIT_ASSERT_STRNOTEQ(STR1, STR2) \
2113 do { \
2114 if (strcmp(STR1, STR2) == 0) { \
2115 BBUNIT_PRINTASSERTFAIL; \
2116 bb_error_msg("[ERROR] Strings '%s' and '%s' " \
2117 "are the same, but were " \
2118 "expected to differ", STR1, STR2); \
2119 BBUNIT_ASSERTION_FAILED; \
2120 } \
2121 } while (0)
2122
2123
Denis Vlasenkof81e8db2009-04-09 12:35:13 +00002124POP_SAVED_FUNCTION_VISIBILITY
2125
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +00002126#endif