blob: 82484f9117adfab5297abdf99cd2c12fc0301b99 [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>
Denys Vlasenko89f5bfd2011-05-12 23:03:18 +020023#if defined __UCLIBC__ /* TODO: and glibc? */
24/* use inlined versions of these: */
25# define sigfillset(s) __sigfillset(s)
26# define sigemptyset(s) __sigemptyset(s)
27# define sigisemptyset(s) __sigisemptyset(s)
28#endif
Denys Vlasenko5b9b1362010-02-02 03:08:57 +010029#include <stdint.h>
Eric Andersenaad1a882001-03-16 22:47:14 +000030#include <stdio.h>
Manuel Novoa III 68474f32004-02-05 14:45:58 +000031#include <stdlib.h>
Eric Andersenaad1a882001-03-16 22:47:14 +000032#include <stdarg.h>
Denis Vlasenko4b4b6192007-03-18 20:33:26 +000033#include <stddef.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000034#include <string.h>
Thomas Petazzoniaf4f0e42013-10-16 19:59:45 +020035/* There are two incompatible basename's, let's not use them! */
Denys Vlasenkod48fdde2011-09-10 13:48:34 +020036/* See the dirname/basename man page for details */
37#include <libgen.h> /* dirname,basename */
38#undef basename
39#define basename dont_use_basename
Thomas Petazzoniaf4f0e42013-10-16 19:59:45 +020040#include <poll.h>
Rob Landleyc9c1a412006-07-12 19:17:55 +000041#include <sys/ioctl.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000042#include <sys/mman.h>
Rob Landley5d9c42a2006-06-24 17:55:02 +000043#include <sys/socket.h>
"Vladimir N. Oleynik"7fe65202005-09-20 10:02:36 +000044#include <sys/stat.h>
Rob Landley299a6b42006-05-27 21:42:58 +000045#include <sys/time.h>
Rob Landleyb623a542006-05-31 22:09:03 +000046#include <sys/types.h>
Denys Vlasenkodd807c12011-02-07 14:58:57 +010047#ifndef major
48# include <sys/sysmacros.h>
49#endif
Rob Landleyc9c1a412006-07-12 19:17:55 +000050#include <sys/wait.h>
Rob Landleyb623a542006-05-31 22:09:03 +000051#include <termios.h>
Rob Landleyd921b2e2006-08-03 15:41:12 +000052#include <time.h>
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +000053#include <sys/param.h>
Denys Vlasenkoa76dd502012-01-08 16:11:38 +010054#include <pwd.h>
55#include <grp.h>
Denys Vlasenko3e0c4282012-01-08 16:13:55 +010056#if ENABLE_FEATURE_SHADOWPASSWDS
57# if !ENABLE_USE_BB_SHADOW
58/* If using busybox's shadow implementation, do not include the shadow.h
59 * header as the toolchain may not provide it at all.
60 */
61# include <shadow.h>
62# endif
63#endif
Denys Vlasenkoa76dd502012-01-08 16:11:38 +010064#if defined(ANDROID) || defined(__ANDROID__)
65# define endpwent() ((void)0)
66# define endgrent() ((void)0)
67#endif
Mike Frysinger22876c72008-02-07 22:10:07 +000068#ifdef HAVE_MNTENT_H
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +020069# include <mntent.h>
Mike Frysinger22876c72008-02-07 22:10:07 +000070#endif
Mike Frysinger9412ec72008-02-07 22:41:33 +000071#ifdef HAVE_SYS_STATFS_H
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +020072# include <sys/statfs.h>
Mike Frysinger9412ec72008-02-07 22:41:33 +000073#endif
Denys Vlasenko67905e22011-07-26 13:42:12 +020074/* Don't do this here:
75 * #include <sys/sysinfo.h>
76 * Some linux/ includes pull in conflicting definition
77 * of struct sysinfo (only in some toolchanins), which breaks build.
78 * Include sys/sysinfo.h only in those files which need it.
79 */
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000080#if ENABLE_SELINUX
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +020081# include <selinux/selinux.h>
82# include <selinux/context.h>
83# include <selinux/flask.h>
84# include <selinux/av_permissions.h>
Eric Andersen9e480452003-07-03 10:07:04 +000085#endif
Denys Vlasenko8d0e0cd2011-01-25 23:21:46 +010086#if ENABLE_FEATURE_UTMP
Bernhard Reutner-Fischer7d863842015-04-19 23:45:17 +020087# if defined __UCLIBC__ && ( \
88 (UCLIBC_VERSION >= KERNEL_VERSION(0, 9, 32) \
89 && UCLIBC_VERSION < KERNEL_VERSION(0, 9, 34) \
90 && defined __UCLIBC_HAS_UTMPX__ \
91 ) || ( \
92 UCLIBC_VERSION >= KERNEL_VERSION(0, 9, 34) \
93 ) \
94 )
95# include <utmpx.h>
96# elif defined __UCLIBC__
97# include <utmp.h>
98# define utmpx utmp
99# define setutxent setutent
100# define endutxent endutent
101# define getutxent getutent
102# define getutxid getutid
103# define getutxline getutline
104# define pututxline pututline
105# define utmpxname utmpname
106# define updwtmpx updwtmp
107# define _PATH_UTMPX _PATH_UTMP
108# else
109# include <utmpx.h>
110# endif
Denys Vlasenko8d0e0cd2011-01-25 23:21:46 +0100111#endif
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000112#if ENABLE_LOCALE_SUPPORT
Denys Vlasenko9d57a802009-10-23 14:24:44 +0200113# include <locale.h>
Rob Landleyeb84a422006-09-20 21:41:13 +0000114#else
Denys Vlasenko9d57a802009-10-23 14:24:44 +0200115# define setlocale(x,y) ((void)0)
Rob Landleyd921b2e2006-08-03 15:41:12 +0000116#endif
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000117#ifdef DMALLOC
Denys Vlasenko9d57a802009-10-23 14:24:44 +0200118# include <dmalloc.h>
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000119#endif
Tito Ragusaad3d72f2011-01-16 23:39:45 +0100120/* Just in case libc doesn't define some of these... */
121#ifndef _PATH_PASSWD
122#define _PATH_PASSWD "/etc/passwd"
123#endif
124#ifndef _PATH_GROUP
125#define _PATH_GROUP "/etc/group"
126#endif
127#ifndef _PATH_SHADOW
128#define _PATH_SHADOW "/etc/shadow"
129#endif
130#ifndef _PATH_GSHADOW
131#define _PATH_GSHADOW "/etc/gshadow"
132#endif
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +0200133#if defined __FreeBSD__ || defined __OpenBSD__
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +0100134# include <netinet/in.h>
135# include <arpa/inet.h>
136#elif defined __APPLE__
137# include <netinet/in.h>
138#else
139# include <arpa/inet.h>
140# if !defined(__socklen_t_defined) && !defined(_SOCKLEN_T_DECLARED)
141/* We #define socklen_t *after* includes, otherwise we get
142 * typedef redefinition errors from system headers
143 * (in case "is it defined already" detection above failed)
144 */
145# define socklen_t bb_socklen_t
146 typedef unsigned socklen_t;
147# endif
148#endif
Chris Rees330718e2011-01-24 17:07:06 +0100149#ifndef HAVE_CLEARENV
150# define clearenv() do { if (environ) environ[0] = NULL; } while (0)
151#endif
152#ifndef HAVE_FDATASYNC
153# define fdatasync fsync
154#endif
155#ifndef HAVE_XTABS
156# define XTABS TAB3
157#endif
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +0100158
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000159
Denis Vlasenkoaf6cca52008-05-25 04:31:54 +0000160/* Some libc's forget to declare these, do it ourself */
Denis Vlasenko847fa772008-01-28 22:45:43 +0000161
Denis Vlasenkocac0f5b2008-09-25 10:20:46 +0000162extern char **environ;
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000163#if defined(__GLIBC__) && __GLIBC__ < 2
164int vdprintf(int d, const char *format, va_list ap);
Rob Landley362dc2b2006-06-05 17:35:24 +0000165#endif
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000166/* klogctl is in libc's klog.h, but we cheat and not #include that */
167int klogctl(int type, char *b, int len);
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +0100168#ifndef PATH_MAX
169# define PATH_MAX 256
170#endif
171#ifndef BUFSIZ
172# define BUFSIZ 4096
173#endif
Rob Landley362dc2b2006-06-05 17:35:24 +0000174
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000175
Denys Vlasenko0c4cf422011-06-30 02:44:27 +0200176/* Busybox does not use threads, we can speed up stdio. */
Dan Fandrich75214cf2011-06-30 02:59:17 +0200177#ifdef HAVE_UNLOCKED_STDIO
178# undef getc
179# define getc(stream) getc_unlocked(stream)
180# undef getchar
181# define getchar() getchar_unlocked()
182# undef putc
183# define putc(c, stream) putc_unlocked(c, stream)
184# undef putchar
185# define putchar(c) putchar_unlocked(c)
186# undef fgetc
187# define fgetc(stream) getc_unlocked(stream)
188# undef fputc
189# define fputc(c, stream) putc_unlocked(c, stream)
190#endif
Denys Vlasenko0c4cf422011-06-30 02:44:27 +0200191/* Above functions are required by POSIX.1-2008, below ones are extensions */
Dan Fandrich75214cf2011-06-30 02:59:17 +0200192#ifdef HAVE_UNLOCKED_LINE_OPS
193# undef fgets
194# define fgets(s, n, stream) fgets_unlocked(s, n, stream)
195# undef fputs
196# define fputs(s, stream) fputs_unlocked(s, stream)
197#endif
Denys Vlasenko06448912011-06-20 10:06:28 +0200198
199
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000200/* Make all declarations hidden (-fvisibility flag only affects definitions) */
201/* (don't include system headers after this until corresponding pop!) */
Denis Vlasenkof81e8db2009-04-09 12:35:13 +0000202PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000203
204
205#if ENABLE_USE_BB_PWD_GRP
206# include "pwd_.h"
207# include "grp_.h"
208#endif
209#if ENABLE_FEATURE_SHADOWPASSWDS
210# if ENABLE_USE_BB_SHADOW
211# include "shadow_.h"
212# endif
213#endif
214
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000215/* Tested to work correctly with all int types (IIRC :]) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000216#define MAXINT(T) (T)( \
217 ((T)-1) > 0 \
218 ? (T)-1 \
219 : (T)~((T)1 << (sizeof(T)*8-1)) \
220 )
221
222#define MININT(T) (T)( \
223 ((T)-1) > 0 \
224 ? (T)0 \
225 : ((T)1 << (sizeof(T)*8-1)) \
226 )
Denis Vlasenko7039a662006-10-08 17:54:47 +0000227
Denis Vlasenko56254152006-10-07 16:24:46 +0000228/* Large file support */
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000229/* Note that CONFIG_LFS=y forces bbox to be built with all common ops
Denis Vlasenko7039a662006-10-08 17:54:47 +0000230 * (stat, lseek etc) mapped to "largefile" variants by libc.
231 * Practically it means that open() automatically has O_LARGEFILE added
232 * and all filesize/file_offset parameters and struct members are "large"
233 * (in today's world - signed 64bit). For full support of large files,
234 * we need a few helper #defines (below) and careful use of off_t
235 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000236#if ENABLE_LFS
Denis Vlasenko7039a662006-10-08 17:54:47 +0000237/* CONFIG_LFS is on */
238# if ULONG_MAX > 0xffffffff
239/* "long" is long enough on this system */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000240typedef unsigned long uoff_t;
Denys Vlasenkof59a50e2011-11-16 21:30:19 +0100241# define XATOOFF(a) xatoul_range((a), 0, LONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000242/* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
243# define BB_STRTOOFF bb_strtoul
244# define STRTOOFF strtoul
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000245/* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
246# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000247# else
Denis Vlasenkocba9ef52006-10-10 21:00:47 +0000248/* "long" is too short, need "long long" */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000249typedef unsigned long long uoff_t;
Denys Vlasenkof59a50e2011-11-16 21:30:19 +0100250# define XATOOFF(a) xatoull_range((a), 0, LLONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000251# define BB_STRTOOFF bb_strtoull
252# define STRTOOFF strtoull
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000253# define OFF_FMT "ll"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000254# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000255#else
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000256/* CONFIG_LFS is off */
257# if UINT_MAX == 0xffffffff
258/* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
259 * gcc will throw warnings on printf("%d", off_t). Crap... */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000260typedef unsigned long uoff_t;
Denys Vlasenko77832482010-08-12 14:14:45 +0200261# define XATOOFF(a) xatoi_positive(a)
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000262# define BB_STRTOOFF bb_strtou
Denis Vlasenko7039a662006-10-08 17:54:47 +0000263# define STRTOOFF strtol
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000264# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000265# else
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000266typedef unsigned long uoff_t;
Denys Vlasenkof59a50e2011-11-16 21:30:19 +0100267# define XATOOFF(a) xatoul_range((a), 0, LONG_MAX)
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000268# define BB_STRTOOFF bb_strtoul
Denis Vlasenko7039a662006-10-08 17:54:47 +0000269# define STRTOOFF strtol
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000270# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000271# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000272#endif
273/* scary. better ideas? (but do *test* them first!) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000274#define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
Denys Vlasenko1dc80ba2011-11-17 21:51:32 +0100275/* Users report bionic to use 32-bit off_t even if LARGEFILE support is requested.
276 * We misdetected that. Don't let it build:
277 */
278struct BUG_off_t_size_is_misdetected {
279 char BUG_off_t_size_is_misdetected[sizeof(off_t) == sizeof(uoff_t) ? 1 : -1];
280};
Denis Vlasenko56254152006-10-07 16:24:46 +0000281
Eric Andersenaad1a882001-03-16 22:47:14 +0000282/* Some useful definitions */
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000283#undef FALSE
Eric Andersenaad1a882001-03-16 22:47:14 +0000284#define FALSE ((int) 0)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000285#undef TRUE
Eric Andersenaad1a882001-03-16 22:47:14 +0000286#define TRUE ((int) 1)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000287#undef SKIP
Eric Andersenaad1a882001-03-16 22:47:14 +0000288#define SKIP ((int) 2)
289
Eric Andersenaad1a882001-03-16 22:47:14 +0000290/* Macros for min/max. */
291#ifndef MIN
Denys Vlasenkoe4dcba12010-10-28 18:57:19 +0200292#define MIN(a,b) (((a)<(b))?(a):(b))
Eric Andersenaad1a882001-03-16 22:47:14 +0000293#endif
294
295#ifndef MAX
Denys Vlasenkoe4dcba12010-10-28 18:57:19 +0200296#define MAX(a,b) (((a)>(b))?(a):(b))
Eric Andersenaad1a882001-03-16 22:47:14 +0000297#endif
298
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000299/* buffer allocation schemes */
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000300#if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000301#define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000302#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
303#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
304#else
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000305#if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000306#define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
307#define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
308#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
309#else
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000310#define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer = xmalloc(len)
311#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
312#define RELEASE_CONFIG_BUFFER(buffer) free(buffer)
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000313#endif
314#endif
315
Denis Vlasenkofad2b862007-05-31 22:16:38 +0000316#if defined(__GLIBC__)
317/* glibc uses __errno_location() to get a ptr to errno */
318/* We can just memorize it once - no multithreading in busybox :) */
319extern int *const bb_errno;
320#undef errno
321#define errno (*bb_errno)
322#endif
323
Denys Vlasenko9ff50b82010-10-18 11:40:26 +0200324#if !(ULONG_MAX > 0xffffffff)
325/* Only 32-bit CPUs need this, 64-bit ones use inlined version */
326uint64_t bb_bswap_64(uint64_t x) FAST_FUNC;
327#endif
328
Denis Vlasenkoce13b762008-06-29 02:25:53 +0000329unsigned long long monotonic_ns(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000330unsigned long long monotonic_us(void) FAST_FUNC;
Denys Vlasenkof2c8aa62010-01-12 12:52:30 +0100331unsigned long long monotonic_ms(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000332unsigned monotonic_sec(void) FAST_FUNC;
Manuel Novoa III cad53642003-03-19 09:13:01 +0000333
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000334extern void chomp(char *s) FAST_FUNC;
335extern void trim(char *s) FAST_FUNC;
336extern char *skip_whitespace(const char *) FAST_FUNC;
337extern char *skip_non_whitespace(const char *) FAST_FUNC;
Denys Vlasenkof8d8aa12010-04-06 18:50:05 +0200338extern char *skip_dev_pfx(const char *tty_name) FAST_FUNC;
339
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000340extern char *strrstr(const char *haystack, const char *needle) FAST_FUNC;
Paul Fox0b621582005-08-09 19:38:05 +0000341
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +0000342//TODO: supply a pointer to char[11] buffer (avoid statics)?
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000343extern const char *bb_mode_string(mode_t mode) FAST_FUNC;
Denys Vlasenkof282c6b2011-12-18 03:27:46 +0100344extern int is_directory(const char *name, int followLinks) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000345enum { /* DO NOT CHANGE THESE VALUES! cp.c, mv.c, install.c depend on them. */
Denys Vlasenkoa40f0622010-01-15 22:05:07 +0100346 FILEUTILS_PRESERVE_STATUS = 1 << 0, /* -p */
347 FILEUTILS_DEREFERENCE = 1 << 1, /* !-d */
348 FILEUTILS_RECUR = 1 << 2, /* -R */
349 FILEUTILS_FORCE = 1 << 3, /* -f */
350 FILEUTILS_INTERACTIVE = 1 << 4, /* -i */
351 FILEUTILS_MAKE_HARDLINK = 1 << 5, /* -l */
352 FILEUTILS_MAKE_SOFTLINK = 1 << 6, /* -s */
353 FILEUTILS_DEREF_SOFTLINK = 1 << 7, /* -L */
354 FILEUTILS_DEREFERENCE_L0 = 1 << 8, /* -H */
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000355#if ENABLE_SELINUX
Denys Vlasenkoa40f0622010-01-15 22:05:07 +0100356 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 1 << 9, /* -c */
357 FILEUTILS_SET_SECURITY_CONTEXT = 1 << 10,
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000358#endif
Natanael Copa02112d82012-05-22 17:11:46 +0200359 FILEUTILS_IGNORE_CHMOD_ERR = 1 << 11,
Denys Vlasenko17f84182014-05-19 16:23:50 +0200360 /* -v */
361 FILEUTILS_VERBOSE = (1 << 12) * ENABLE_FEATURE_VERBOSE,
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000362};
Denys Vlasenkoa40f0622010-01-15 22:05:07 +0100363#define FILEUTILS_CP_OPTSTR "pdRfilsLH" IF_SELINUX("c")
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000364extern int remove_file(const char *path, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000365/* NB: without FILEUTILS_RECUR in flags, it will basically "cat"
366 * the source, not copy (unless "source" is a directory).
367 * This makes "cp /dev/null file" and "install /dev/null file" (!!!)
368 * work coreutils-compatibly. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000369extern int copy_file(const char *source, const char *dest, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000370
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000371enum {
Denis Vlasenkod166f832007-07-05 00:12:55 +0000372 ACTION_RECURSE = (1 << 0),
373 ACTION_FOLLOWLINKS = (1 << 1),
374 ACTION_FOLLOWLINKS_L0 = (1 << 2),
375 ACTION_DEPTHFIRST = (1 << 3),
376 /*ACTION_REVERSE = (1 << 4), - unused */
Denis Vlasenko6e69e422008-07-27 12:10:07 +0000377 ACTION_QUIET = (1 << 5),
Denys Vlasenko8f7a6d22009-09-29 11:07:04 +0200378 ACTION_DANGLING_OK = (1 << 6),
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000379};
Denys Vlasenko8f7a6d22009-09-29 11:07:04 +0200380typedef uint8_t recurse_flags_t;
Bernhard Reutner-Fischer3e816c12007-03-29 10:30:50 +0000381extern int recursive_action(const char *fileName, unsigned flags,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000382 int FAST_FUNC (*fileAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
383 int FAST_FUNC (*dirAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
384 void* userData, unsigned depth) FAST_FUNC;
385extern int device_open(const char *device, int mode) FAST_FUNC;
Denis Vlasenko85c24712008-03-17 09:04:04 +0000386enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000387extern int xgetpty(char *line) FAST_FUNC;
Denis Vlasenko2afd5ab2008-08-05 23:32:27 +0000388extern int get_console_fd_or_die(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000389extern void console_make_active(int fd, const int vt_num) FAST_FUNC;
390extern char *find_block_device(const char *path) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000391/* bb_copyfd_XX print read/write errors and return -1 if they occur */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000392extern off_t bb_copyfd_eof(int fd1, int fd2) FAST_FUNC;
393extern off_t bb_copyfd_size(int fd1, int fd2, off_t size) FAST_FUNC;
394extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000395/* "short" copy can be detected by return value < size */
396/* this helper yells "short read!" if param is not -1 */
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000397extern void complain_copyfd_and_die(off_t sz) NORETURN FAST_FUNC;
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +0200398
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000399extern char bb_process_escape_sequence(const char **ptr) FAST_FUNC;
Denys Vlasenko53600592010-10-23 21:06:06 +0200400char* strcpy_and_process_escape_sequences(char *dst, const char *src) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000401/* xxxx_strip version can modify its parameter:
402 * "/" -> "/"
403 * "abc" -> "abc"
404 * "abc/def" -> "def"
405 * "abc/def/" -> "def" !!
406 */
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +0200407char *bb_get_last_path_component_strip(char *path) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000408/* "abc/def/" -> "" and it never modifies 'path' */
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +0200409char *bb_get_last_path_component_nostrip(const char *path) FAST_FUNC;
410/* Simpler version: does not special case "/" string */
411const char *bb_basename(const char *name) FAST_FUNC;
412/* NB: can violate const-ness (similarly to strchr) */
413char *last_char_is(const char *s, int c) FAST_FUNC;
Denys Vlasenko1961aea2013-02-26 00:36:53 +0100414const char* endofname(const char *name) FAST_FUNC;
Denys Vlasenko8dff01d2015-03-12 17:48:34 +0100415char *is_prefixed_with(const char *string, const char *key) FAST_FUNC;
Bartosz Golaszewski7448b512015-08-25 16:36:43 +0200416char *is_suffixed_with(const char *string, const char *key) FAST_FUNC;
Denis Vlasenkocad04ef2007-03-25 23:21:05 +0000417
Denys Vlasenkod6e76722014-09-22 21:14:02 +0200418int ndelay_on(int fd) FAST_FUNC;
419int ndelay_off(int fd) FAST_FUNC;
Denys Vlasenkoe9a40e32011-01-24 00:29:55 +0100420void close_on_exec_on(int fd) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000421void xdup2(int, int) FAST_FUNC;
422void xmove_fd(int, int) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000423
424
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000425DIR *xopendir(const char *path) FAST_FUNC;
426DIR *warn_opendir(const char *path) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000427
Jérémie Koenigfbedacf2010-03-26 19:08:53 +0100428char *xmalloc_realpath(const char *path) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100429char *xmalloc_readlink(const char *path) FAST_FUNC RETURNS_MALLOC;
430char *xmalloc_readlink_or_warn(const char *path) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkob57eee82009-11-04 17:54:17 +0100431/* !RETURNS_MALLOC: it's a realloc-like function */
432char *xrealloc_getcwd_or_warn(char *cwd) FAST_FUNC;
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000433
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100434char *xmalloc_follow_symlinks(const char *path) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko473dae02007-04-11 07:04:23 +0000435
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000436
Denis Vlasenko33196372008-02-23 01:25:38 +0000437enum {
Denis Vlasenkocf7cf622008-03-19 19:38:46 +0000438 /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
Denis Vlasenko33196372008-02-23 01:25:38 +0000439 * otherwise would kill us, except for those resulting from bugs:
440 * SIGSEGV, SIGILL, SIGFPE.
441 * Other fatal signals not included (TODO?):
442 * SIGBUS Bus error (bad memory access)
443 * SIGPOLL Pollable event. Synonym of SIGIO
444 * SIGPROF Profiling timer expired
445 * SIGSYS Bad argument to routine
446 * SIGTRAP Trace/breakpoint trap
Denis Vlasenkod943af02008-03-30 15:56:38 +0000447 *
448 * The only known arch with some of these sigs not fitting
449 * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
450 * Dance around with long long to guard against that...
Denis Vlasenko33196372008-02-23 01:25:38 +0000451 */
Denis Vlasenkod943af02008-03-30 15:56:38 +0000452 BB_FATAL_SIGS = (int)(0
453 + (1LL << SIGHUP)
454 + (1LL << SIGINT)
455 + (1LL << SIGTERM)
456 + (1LL << SIGPIPE) // Write to pipe with no readers
457 + (1LL << SIGQUIT) // Quit from keyboard
458 + (1LL << SIGABRT) // Abort signal from abort(3)
459 + (1LL << SIGALRM) // Timer signal from alarm(2)
460 + (1LL << SIGVTALRM) // Virtual alarm clock
461 + (1LL << SIGXCPU) // CPU time limit exceeded
462 + (1LL << SIGXFSZ) // File size limit exceeded
463 + (1LL << SIGUSR1) // Yes kids, these are also fatal!
464 + (1LL << SIGUSR2)
465 + 0),
Denis Vlasenko33196372008-02-23 01:25:38 +0000466};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000467void bb_signals(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko25591c32008-02-16 22:58:56 +0000468/* Unlike signal() and bb_signals, sets handler with sigaction()
469 * and in a way that while signal handler is run, no other signals
Denis Vlasenkocab28aa2009-01-31 01:02:07 +0000470 * will be blocked; syscalls will not be restarted: */
471void bb_signals_recursive_norestart(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000472/* syscalls like read() will be interrupted with EINTR: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000473void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000474/* syscalls like read() won't be interrupted (though select/poll will be): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000475void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
476void wait_for_any_sig(void) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000477void kill_myself_with_sig(int sig) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000478void sig_block(int sig) FAST_FUNC;
479void sig_unblock(int sig) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000480/* Will do sigaction(signum, act, NULL): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000481int sigaction_set(int sig, const struct sigaction *act) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000482/* SIG_BLOCK/SIG_UNBLOCK all signals: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000483int sigprocmask_allsigs(int how) FAST_FUNC;
Denis Vlasenko08ea11a2008-09-11 19:51:11 +0000484/* Standard handler which just records signo */
485extern smallint bb_got_signal;
486void record_signo(int signo); /* not FAST_FUNC! */
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000487
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000488
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000489void xsetgid(gid_t gid) FAST_FUNC;
490void xsetuid(uid_t uid) FAST_FUNC;
Ryan Mallon5906a5c2013-10-08 14:52:49 +0200491void xsetegid(gid_t egid) FAST_FUNC;
492void xseteuid(uid_t euid) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000493void xchdir(const char *path) FAST_FUNC;
494void xchroot(const char *path) FAST_FUNC;
495void xsetenv(const char *key, const char *value) FAST_FUNC;
Denis Vlasenko76ddc2e2008-12-30 05:05:31 +0000496void bb_unsetenv(const char *key) FAST_FUNC;
Denys Vlasenkodd8adde2010-06-24 05:00:50 +0200497void bb_unsetenv_and_free(char *key) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000498void xunlink(const char *pathname) FAST_FUNC;
499void xstat(const char *pathname, struct stat *buf) FAST_FUNC;
Denys Vlasenko8d3e2252010-08-31 12:42:06 +0200500void xfstat(int fd, struct stat *buf, const char *errmsg) FAST_FUNC;
Ryan Mallon5906a5c2013-10-08 14:52:49 +0200501int open3_or_warn(const char *pathname, int flags, int mode) FAST_FUNC;
502int open_or_warn(const char *pathname, int flags) FAST_FUNC;
503int xopen3(const char *pathname, int flags, int mode) FAST_FUNC;
Denys Vlasenkof2a8d5d2009-08-21 17:40:36 +0200504int xopen(const char *pathname, int flags) FAST_FUNC;
Bernhard Reutner-Fischera4830872009-10-26 23:27:08 +0100505int xopen_nonblocking(const char *pathname) FAST_FUNC;
Ryan Mallon5906a5c2013-10-08 14:52:49 +0200506int xopen_as_uid_gid(const char *pathname, int flags, uid_t u, gid_t g) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000507int open_or_warn_stdin(const char *pathname) FAST_FUNC;
Denys Vlasenkoe7b0a9e2010-08-22 05:39:15 +0200508int xopen_stdin(const char *pathname) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000509void xrename(const char *oldpath, const char *newpath) FAST_FUNC;
510int rename_or_warn(const char *oldpath, const char *newpath) FAST_FUNC;
511off_t xlseek(int fd, off_t offset, int whence) FAST_FUNC;
Alexander Shishkin67227372010-10-22 13:27:16 +0200512int xmkstemp(char *template) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000513off_t fdlength(int fd) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000514
Denys Vlasenko40e7d252010-02-01 23:48:27 +0100515uoff_t FAST_FUNC get_volume_size_in_bytes(int fd,
Denys Vlasenko982e87f2013-07-30 11:52:58 +0200516 const char *override,
517 unsigned override_units,
518 int extend);
Denys Vlasenko40e7d252010-02-01 23:48:27 +0100519
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000520void xpipe(int filedes[2]) FAST_FUNC;
Denis Vlasenko37188322008-02-16 13:20:56 +0000521/* In this form code with pipes is much more readable */
522struct fd_pair { int rd; int wr; };
523#define piped_pair(pair) pipe(&((pair).rd))
524#define xpiped_pair(pair) xpipe(&((pair).rd))
525
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000526/* Useful for having small structure members/global variables */
527typedef int8_t socktype_t;
528typedef int8_t family_t;
529struct BUG_too_small {
530 char BUG_socktype_t_too_small[(0
531 | SOCK_STREAM
532 | SOCK_DGRAM
533 | SOCK_RDM
534 | SOCK_SEQPACKET
535 | SOCK_RAW
536 ) <= 127 ? 1 : -1];
537 char BUG_family_t_too_small[(0
538 | AF_UNSPEC
539 | AF_INET
540 | AF_INET6
541 | AF_UNIX
Mike Frysinger9412ec72008-02-07 22:41:33 +0000542#ifdef AF_PACKET
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000543 | AF_PACKET
Mike Frysinger9412ec72008-02-07 22:41:33 +0000544#endif
545#ifdef AF_NETLINK
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000546 | AF_NETLINK
Mike Frysinger9412ec72008-02-07 22:41:33 +0000547#endif
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000548 /* | AF_DECnet */
549 /* | AF_IPX */
550 ) <= 127 ? 1 : -1];
551};
552
553
Denys Vlasenkodc698bb2010-01-09 19:10:49 +0100554void parse_datestr(const char *date_str, struct tm *ptm) FAST_FUNC;
555time_t validate_tm_time(const char *date_str, struct tm *ptm) FAST_FUNC;
Denys Vlasenko8f2cb7a2013-03-29 12:30:33 +0100556char *strftime_HHMMSS(char *buf, unsigned len, time_t *tp) FAST_FUNC;
557char *strftime_YYYYMMDDHHMMSS(char *buf, unsigned len, time_t *tp) FAST_FUNC;
Denys Vlasenko73b71f32009-07-18 03:40:35 +0200558
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000559int xsocket(int domain, int type, int protocol) FAST_FUNC;
560void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen) FAST_FUNC;
561void xlisten(int s, int backlog) FAST_FUNC;
562void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen) FAST_FUNC;
Denis Vlasenkodbe6e662007-08-14 16:43:01 +0000563ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000564 socklen_t tolen) FAST_FUNC;
Denys Vlasenkoc52cbea2015-08-24 19:48:03 +0200565
566int setsockopt_int(int fd, int level, int optname, int optval) FAST_FUNC;
567int setsockopt_1(int fd, int level, int optname) FAST_FUNC;
568int setsockopt_SOL_SOCKET_int(int fd, int optname, int optval) FAST_FUNC;
569int setsockopt_SOL_SOCKET_1(int fd, int optname) FAST_FUNC;
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000570/* SO_REUSEADDR allows a server to rebind to an address that is already
571 * "in use" by old connections to e.g. previous server instance which is
572 * killed or crashed. Without it bind will fail until all such connections
573 * time out. Linux does not allow multiple live binds on same ip:port
574 * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
575 * Turn it on before you call bind(). */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000576void setsockopt_reuseaddr(int fd) FAST_FUNC; /* On Linux this never fails. */
Denys Vlasenkoc52cbea2015-08-24 19:48:03 +0200577int setsockopt_keepalive(int fd) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000578int setsockopt_broadcast(int fd) FAST_FUNC;
Denis Vlasenkoe5373852008-12-10 11:12:16 +0000579int setsockopt_bindtodevice(int fd, const char *iface) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000580/* NB: returns port in host byte order */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000581unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port) FAST_FUNC;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000582typedef struct len_and_sockaddr {
Denis Vlasenko0850cda2007-02-07 23:20:32 +0000583 socklen_t len;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000584 union {
585 struct sockaddr sa;
586 struct sockaddr_in sin;
587#if ENABLE_FEATURE_IPV6
588 struct sockaddr_in6 sin6;
589#endif
Bernhard Reutner-Fischer8c69afd2008-01-29 10:33:34 +0000590 } u;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000591} len_and_sockaddr;
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000592enum {
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000593 LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000594 LSA_SIZEOF_SA = sizeof(
595 union {
596 struct sockaddr sa;
597 struct sockaddr_in sin;
598#if ENABLE_FEATURE_IPV6
599 struct sockaddr_in6 sin6;
600#endif
601 }
602 )
603};
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000604/* Create stream socket, and allocate suitable lsa.
605 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
Denis Vlasenkobeffd432007-09-05 11:30:34 +0000606 * af == AF_UNSPEC will result in trying to create IPv6 socket,
Denys Vlasenkob1278a32009-11-24 16:03:47 +0100607 * and if kernel doesn't support it, fall back to IPv4.
608 * This is useful if you plan to bind to resulting local lsa.
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000609 */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000610int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000611int xsocket_stream(len_and_sockaddr **lsap) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000612/* Create server socket bound to bindaddr:port. bindaddr can be NULL,
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000613 * numeric IP ("N.N.N.N") or numeric IPv6 address,
614 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000615 * Only if there is no suffix, port argument is used */
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000616/* NB: these set SO_REUSEADDR before bind */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000617int create_and_bind_stream_or_die(const char *bindaddr, int port) FAST_FUNC;
618int create_and_bind_dgram_or_die(const char *bindaddr, int port) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000619/* Create client TCP socket connected to peer:port. Peer cannot be NULL.
620 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
621 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
622 * If there is no suffix, port argument is used */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000623int create_and_connect_stream_or_die(const char *peer, int port) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000624/* Connect to peer identified by lsa */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000625int xconnect_stream(const len_and_sockaddr *lsa) FAST_FUNC;
Denis Vlasenko73c571a2009-03-09 00:12:37 +0000626/* Get local address of bound or accepted socket */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100627len_and_sockaddr *get_sock_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkof6916db2010-04-06 17:43:29 +0200628/* Get remote address of connected or accepted socket */
629len_and_sockaddr *get_peer_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000630/* Return malloc'ed len_and_sockaddr with socket address of host:port
631 * Currently will return IPv4 or IPv6 sockaddrs only
632 * (depending on host), but in theory nothing prevents e.g.
Denis Vlasenko5870ad92007-02-04 02:39:55 +0000633 * UNIX socket address being returned, IPX sockaddr etc...
634 * On error does bb_error_msg and returns NULL */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100635len_and_sockaddr* host2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000636/* Version which dies on error */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100637len_and_sockaddr* xhost2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
638len_and_sockaddr* xdotted2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000639/* Same, useful if you want to force family (e.g. IPv6) */
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000640#if !ENABLE_FEATURE_IPV6
641#define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
642#define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
643#else
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100644len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
645len_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 +0000646#endif
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000647/* Assign sin[6]_port member if the socket is an AF_INET[6] one,
Denis Vlasenko85629f02007-01-22 09:36:41 +0000648 * otherwise no-op. Useful for ftp.
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000649 * NB: does NOT do htons() internally, just direct assignment. */
Denys Vlasenkoca183112011-04-07 17:52:20 +0200650void set_nport(struct sockaddr *sa, unsigned port) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000651/* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000652int get_nport(const struct sockaddr *sa) FAST_FUNC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000653/* Reverse DNS. Returns NULL on failure. */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100654char* xmalloc_sockaddr2host(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000655/* This one doesn't append :PORTNUM */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100656char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000657/* This one also doesn't fall back to dotted IP (returns NULL) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100658char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko448f0242007-01-22 22:43:05 +0000659/* inet_[ap]ton on steroids */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100660char* xmalloc_sockaddr2dotted(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
661char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000662// "old" (ipv4 only) API
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000663// users: traceroute.c hostname.c - use _list_ of all IPs
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000664struct hostent *xgethostbyname(const char *name) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000665// Also mount.c and inetd.c are using gethostbyname(),
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000666// + inet_common.c has additional IPv4-only stuff
Denis Vlasenkoc8717cd2006-11-22 16:10:39 +0000667
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000668
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000669void socket_want_pktinfo(int fd) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000670ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000671 const struct sockaddr *to,
672 const struct sockaddr *from,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000673 socklen_t tolen) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000674ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000675 struct sockaddr *from,
676 struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000677 socklen_t sa_size) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000678
Baruch Siache8f36332011-09-07 17:52:37 +0200679uint16_t inet_cksum(uint16_t *addr, int len) FAST_FUNC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100680
681char *xstrdup(const char *s) FAST_FUNC RETURNS_MALLOC;
682char *xstrndup(const char *s, int n) FAST_FUNC RETURNS_MALLOC;
Ron Yorstond840c5d2015-07-19 23:05:20 +0200683void *xmemdup(const void *s, int n) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko0f293b92008-07-22 20:16:55 +0000684void overlapping_strcpy(char *dst, const char *src) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000685char *safe_strncpy(char *dst, const char *src, size_t size) FAST_FUNC;
Denis Vlasenko360d9662008-12-02 18:18:50 +0000686char *strncpy_IFNAMSIZ(char *dst, const char *src) FAST_FUNC;
Denys Vlasenko6f068902014-02-27 11:17:06 +0100687unsigned count_strstr(const char *str, const char *sub) FAST_FUNC;
688char *xmalloc_substitute_string(const char *src, int count, const char *sub, const char *repl) FAST_FUNC;
Denis Vlasenko4daad902007-09-27 10:20:47 +0000689/* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
Denis Vlasenko7c654ae2007-09-27 10:26:59 +0000690 * But potentially slow, don't use in one-billion-times loops */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000691int bb_putchar(int ch) FAST_FUNC;
Denys Vlasenko19ced5c2010-06-06 21:53:09 +0200692/* Note: does not use stdio, writes to fd 2 directly */
693int bb_putchar_stderr(char ch) FAST_FUNC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100694char *xasprintf(const char *format, ...) __attribute__ ((format(printf, 1, 2))) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkoe52da552015-10-09 17:59:56 +0200695char *auto_string(char *str) FAST_FUNC;
Denis Vlasenko9f739442006-12-16 23:49:13 +0000696// gcc-4.1.1 still isn't good enough at optimizing it
697// (+200 bytes compared to macro)
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000698//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000699//int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000700//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000701//int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000702#define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
Denis Vlasenko9f739442006-12-16 23:49:13 +0000703#define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000704#define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
Denis Vlasenkobf66fbc2006-12-21 13:23:14 +0000705#define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
Denis Vlasenko16abcd92007-04-13 23:59:52 +0000706#define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000707
Denys Vlasenkod8528b82010-01-31 05:15:38 +0100708typedef struct uni_stat_t {
709 unsigned byte_count;
710 unsigned unicode_count;
711 unsigned unicode_width;
712} uni_stat_t;
713/* Returns a string with unprintable chars replaced by '?' or
714 * SUBST_WCHAR. This function is unicode-aware. */
715const char* FAST_FUNC printable_string(uni_stat_t *stats, const char *str);
716/* Prints unprintable char ch as ^C or M-c to file
717 * (M-c is used only if ch is ORed with PRINTABLE_META),
718 * else it is printed as-is (except for ch = 0x9b) */
719enum { PRINTABLE_META = 0x100 };
720void fputc_printable(int ch, FILE *file) FAST_FUNC;
Bartosz Golaszewski79c618c2013-07-30 06:29:42 +0200721/* Return a string that is the printable representation of character ch.
722 * Buffer must hold at least four characters. */
Denys Vlasenkobfa6ed12013-07-30 11:41:58 +0200723enum {
724 VISIBLE_ENDLINE = 1 << 0,
725 VISIBLE_SHOW_TABS = 1 << 1,
726};
Bartosz Golaszewski79c618c2013-07-30 06:29:42 +0200727void visible(unsigned ch, char *buf, int flags) FAST_FUNC;
Denys Vlasenkod8528b82010-01-31 05:15:38 +0100728
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000729/* dmalloc will redefine these to it's own implementation. It is safe
730 * to have the prototypes here unconditionally. */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100731void *malloc_or_warn(size_t size) FAST_FUNC RETURNS_MALLOC;
732void *xmalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
733void *xzalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkodeeed592008-07-08 05:14:36 +0000734void *xrealloc(void *old, size_t size) FAST_FUNC;
Denys Vlasenko16714242011-09-21 01:59:15 +0200735/* After v = xrealloc_vector(v, SHIFT, idx) it's ok to use
Denis Vlasenko27842282008-08-04 13:20:36 +0000736 * at least v[idx] and v[idx+1], for all idx values.
Denys Vlasenko16714242011-09-21 01:59:15 +0200737 * SHIFT specifies how many new elements are added (1:2, 2:4, ..., 8:256...)
738 * when all elements are used up. New elements are zeroed out.
739 * xrealloc_vector(v, SHIFT, idx) *MUST* be called with consecutive IDXs -
740 * skipping an index is a bad bug - it may miss a realloc!
741 */
Denis Vlasenkodeeed592008-07-08 05:14:36 +0000742#define xrealloc_vector(vector, shift, idx) \
743 xrealloc_vector_helper((vector), (sizeof((vector)[0]) << 8) + (shift), (idx))
744void* xrealloc_vector_helper(void *vector, unsigned sizeof_and_shift, int idx) FAST_FUNC;
745
Eric Andersenaad1a882001-03-16 22:47:14 +0000746
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000747extern ssize_t safe_read(int fd, void *buf, size_t count) FAST_FUNC;
Ron Yorston61d6ae22015-04-19 10:50:25 +0100748extern ssize_t nonblock_immune_read(int fd, void *buf, size_t count) FAST_FUNC;
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000749// NB: will return short read on error, not -1,
750// if some data was read before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000751extern ssize_t full_read(int fd, void *buf, size_t count) FAST_FUNC;
752extern void xread(int fd, void *buf, size_t count) FAST_FUNC;
753extern unsigned char xread_char(int fd) FAST_FUNC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000754extern ssize_t read_close(int fd, void *buf, size_t maxsz) FAST_FUNC;
755extern ssize_t open_read_close(const char *filename, void *buf, size_t maxsz) FAST_FUNC;
Denis Vlasenko8ee649a2008-03-26 20:04:27 +0000756// Reads one line a-la fgets (but doesn't save terminating '\n').
757// Reads byte-by-byte. Useful when it is important to not read ahead.
Denis Vlasenkoe376d452008-02-20 22:23:24 +0000758// Bytes are appended to pfx (which must be malloced, or NULL).
Denys Vlasenko80c5b682011-05-08 21:21:10 +0200759extern char *xmalloc_reads(int fd, size_t *maxsz_p) FAST_FUNC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000760/* Reads block up to *maxsz_p (default: INT_MAX - 4095) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100761extern void *xmalloc_read(int fd, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000762/* Returns NULL if file can't be opened (default max size: INT_MAX - 4095) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100763extern void *xmalloc_open_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko094cc512011-01-17 14:58:27 +0100764/* Never returns NULL */
765extern void *xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko59655072012-03-06 16:23:50 +0100766
Denys Vlasenko04c14172014-11-26 15:17:59 +0100767#if defined(ARG_MAX) && (ARG_MAX >= 60*1024 || !defined(_SC_ARG_MAX))
768/* Use _constant_ maximum if: defined && (big enough || no variable one exists) */
Denys Vlasenkof92f1d02014-06-22 13:54:40 +0200769# define bb_arg_max() ((unsigned)ARG_MAX)
Denys Vlasenko04c14172014-11-26 15:17:59 +0100770#elif defined(_SC_ARG_MAX)
771/* Else use variable one (a bit more expensive) */
Denys Vlasenkof92f1d02014-06-22 13:54:40 +0200772unsigned bb_arg_max(void) FAST_FUNC;
773#else
Denys Vlasenko04c14172014-11-26 15:17:59 +0100774/* If all else fails */
Denys Vlasenkof92f1d02014-06-22 13:54:40 +0200775# define bb_arg_max() ((unsigned)(32 * 1024))
776#endif
Bartosz Golaszewski5d2e4092014-06-22 14:01:13 +0200777unsigned bb_clk_tck(void) FAST_FUNC;
Denys Vlasenkof92f1d02014-06-22 13:54:40 +0200778
Denys Vlasenko59655072012-03-06 16:23:50 +0100779#define SEAMLESS_COMPRESSION (0 \
780 || ENABLE_FEATURE_SEAMLESS_XZ \
781 || ENABLE_FEATURE_SEAMLESS_LZMA \
782 || ENABLE_FEATURE_SEAMLESS_BZ2 \
783 || ENABLE_FEATURE_SEAMLESS_GZ \
784 || ENABLE_FEATURE_SEAMLESS_Z)
785
Denys Vlasenko8a6a2f92012-03-06 16:27:48 +0100786#if SEAMLESS_COMPRESSION
Denys Vlasenko27653ad2010-05-06 14:19:19 +0000787/* Autodetects gzip/bzip2 formats. fd may be in the middle of the file! */
Denys Vlasenko640ce3d2014-02-02 02:06:38 +0100788extern int setup_unzip_on_fd(int fd, int fail_if_not_compressed) FAST_FUNC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000789/* Autodetects .gz etc */
Denys Vlasenko640ce3d2014-02-02 02:06:38 +0100790extern int open_zipped(const char *fname, int fail_if_not_compressed) FAST_FUNC;
Denys Vlasenkob4c11c12014-12-07 00:44:00 +0100791extern void *xmalloc_open_zipped_read_close(const char *fname, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko8a6a2f92012-03-06 16:27:48 +0100792#else
793# define setup_unzip_on_fd(...) (0)
Denys Vlasenko640ce3d2014-02-02 02:06:38 +0100794# define open_zipped(fname, fail_if_not_compressed) open((fname), O_RDONLY);
Denys Vlasenkob4c11c12014-12-07 00:44:00 +0100795# define xmalloc_open_zipped_read_close(fname, maxsz_p) xmalloc_open_read_close((fname), (maxsz_p))
Denys Vlasenko8a6a2f92012-03-06 16:27:48 +0100796#endif
Denis Vlasenkoea620772006-10-14 02:23:43 +0000797
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000798extern ssize_t safe_write(int fd, const void *buf, size_t count) FAST_FUNC;
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000799// NB: will return short write on error, not -1,
800// if some data was written before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000801extern ssize_t full_write(int fd, const void *buf, size_t count) FAST_FUNC;
802extern void xwrite(int fd, const void *buf, size_t count) FAST_FUNC;
Denis Vlasenko73c571a2009-03-09 00:12:37 +0000803extern void xwrite_str(int fd, const char *str) FAST_FUNC;
Denys Vlasenko729ecb82010-06-07 14:14:26 +0200804extern ssize_t full_write1_str(const char *str) FAST_FUNC;
805extern ssize_t full_write2_str(const char *str) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000806extern void xopen_xwrite_close(const char* file, const char *str) FAST_FUNC;
Denis Vlasenkoea620772006-10-14 02:23:43 +0000807
Denys Vlasenkodcd27ab2009-10-05 03:03:07 +0200808/* Close fd, but check for failures (some types of write errors) */
809extern void xclose(int fd) FAST_FUNC;
810
Denis Vlasenko1de08302006-10-26 23:32:43 +0000811/* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000812extern void xprint_and_close_file(FILE *file) FAST_FUNC;
Denis Vlasenko2132e022008-07-15 10:33:12 +0000813
Denys Vlasenkoa1a44832011-06-17 03:37:43 +0200814/* Reads a line from a text file, up to a newline or NUL byte, inclusive.
815 * Returns malloc'ed char*. If end is NULL '\n' isn't considered
816 * end of line. If end isn't NULL, length of the chunk is stored in it.
817 * Returns NULL if EOF/error.
818 */
Denis Vlasenko2132e022008-07-15 10:33:12 +0000819extern char *bb_get_chunk_from_file(FILE *file, int *end) FAST_FUNC;
Denis Vlasenkoabee3d02007-12-26 20:44:45 +0000820/* Reads up to (and including) TERMINATING_STRING: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100821extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000822/* Same, with limited max size, and returns the length (excluding NUL): */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100823extern 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 +0000824/* Chops off TERMINATING_STRING from the end: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100825extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000826/* Reads up to (and including) "\n" or NUL byte: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100827extern char *xmalloc_fgets(FILE *file) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000828/* Chops off '\n' from the end, unlike fgets: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100829extern char *xmalloc_fgetline(FILE *file) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko2132e022008-07-15 10:33:12 +0000830/* Same, but doesn't try to conserve space (may have some slack after the end) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100831/* extern char *xmalloc_fgetline_fast(FILE *file) FAST_FUNC RETURNS_MALLOC; */
Denis Vlasenko2132e022008-07-15 10:33:12 +0000832
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100833void die_if_ferror(FILE *file, const char *msg) FAST_FUNC;
834void die_if_ferror_stdout(void) FAST_FUNC;
835int fflush_all(void) FAST_FUNC;
836void fflush_stdout_and_exit(int retval) NORETURN FAST_FUNC;
837int fclose_if_not_stdin(FILE *file) FAST_FUNC;
838FILE* xfopen(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000839/* Prints warning to stderr and returns NULL on failure: */
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100840FILE* fopen_or_warn(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000841/* "Opens" stdin if filename is special, else just opens file: */
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100842FILE* xfopen_stdin(const char *filename) FAST_FUNC;
843FILE* fopen_or_warn_stdin(const char *filename) FAST_FUNC;
844FILE* fopen_for_read(const char *path) FAST_FUNC;
845FILE* xfopen_for_read(const char *path) FAST_FUNC;
846FILE* fopen_for_write(const char *path) FAST_FUNC;
847FILE* xfopen_for_write(const char *path) FAST_FUNC;
848FILE* xfdopen_for_read(int fd) FAST_FUNC;
849FILE* xfdopen_for_write(int fd) FAST_FUNC;
Eric Andersen8876fb22003-06-20 09:01:58 +0000850
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000851int bb_pstrcmp(const void *a, const void *b) /* not FAST_FUNC! */;
852void qsort_string_vector(char **sv, unsigned count) FAST_FUNC;
Denis Vlasenkofb290382008-03-02 12:51:26 +0000853
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000854/* Wrapper which restarts poll on EINTR or ENOMEM.
855 * On other errors complains [perror("poll")] and returns.
856 * Warning! May take (much) longer than timeout_ms to return!
857 * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000858int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms) FAST_FUNC;
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000859
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000860char *safe_gethostname(void) FAST_FUNC;
Denis Vlasenko6f1713f2008-02-25 23:23:58 +0000861
Bernhard Reutner-Fischer8b1fab22007-04-10 09:38:07 +0000862/* Convert each alpha char in str to lower-case */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000863char* str_tolower(char *str) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000864
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000865char *utoa(unsigned n) FAST_FUNC;
866char *itoa(int n) FAST_FUNC;
Denis Vlasenko10457b92007-03-27 22:01:31 +0000867/* Returns a pointer past the formatted number, does NOT null-terminate */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000868char *utoa_to_buf(unsigned n, char *buf, unsigned buflen) FAST_FUNC;
869char *itoa_to_buf(int n, char *buf, unsigned buflen) FAST_FUNC;
Denis Vlasenko56ea65c2008-01-06 03:26:53 +0000870/* Intelligent formatters of bignums */
Denys Vlasenkoa407cf72013-09-06 12:53:14 +0200871char *smart_ulltoa4(unsigned long long ul, char buf[4], const char *scale) FAST_FUNC;
872char *smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
Denys Vlasenko0bf44d02009-10-13 01:25:09 +0200873/* If block_size == 0, display size without fractional part,
874 * else display (size * block_size) with one decimal digit.
Denys Vlasenko9c3b84a2010-01-18 01:55:00 +0100875 * If display_unit == 0, show value no bigger than 1024 with suffix (K,M,G...),
Denys Vlasenko0bf44d02009-10-13 01:25:09 +0200876 * else divide by display_unit and do not use suffix. */
Denys Vlasenko9c3b84a2010-01-18 01:55:00 +0100877#define HUMAN_READABLE_MAX_WIDTH 7 /* "1024.0G" */
878#define HUMAN_READABLE_MAX_WIDTH_STR "7"
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000879//TODO: provide pointer to buf (avoid statics)?
880const char *make_human_readable_str(unsigned long long size,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000881 unsigned long block_size, unsigned long display_unit) FAST_FUNC;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000882/* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
Denys Vlasenko1f56e512011-10-19 22:40:35 +0200883char *bin2hex(char *dst, const char *src, int count) FAST_FUNC;
Denys Vlasenko48363312010-04-04 15:29:32 +0200884/* Reverse */
Denys Vlasenko1f56e512011-10-19 22:40:35 +0200885char* hex2bin(char *dst, const char *src, int count) FAST_FUNC;
Rob Landleyc5b1d4d2006-03-13 15:45:16 +0000886
Vladimir Dronnikovdb67a202009-10-15 09:24:25 +0200887/* Generate a UUID */
888void generate_uuid(uint8_t *buf) FAST_FUNC;
889
Denis Vlasenko1bab1de2007-07-27 15:30:39 +0000890/* Last element is marked by mult == 0 */
Eric Andersenaad1a882001-03-16 22:47:14 +0000891struct suffix_mult {
Denis Vlasenkof8689632007-07-27 15:06:25 +0000892 char suffix[4];
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000893 unsigned mult;
Eric Andersenaad1a882001-03-16 22:47:14 +0000894};
Denys Vlasenkoc72b43c2013-07-13 23:49:45 +0200895extern const struct suffix_mult bkm_suffixes[];
896#define km_suffixes (bkm_suffixes + 1)
Ari Sundholm88930232015-03-04 18:46:48 +0200897extern const struct suffix_mult cwbkMG_suffixes[];
Ari Sundholm911db162015-03-22 17:55:38 +0100898#define kMG_suffixes (cwbkMG_suffixes + 3)
Denys Vlasenkoc72b43c2013-07-13 23:49:45 +0200899
Denis Vlasenkoed836cd2006-11-25 14:44:13 +0000900#include "xatonum.h"
Denis Vlasenko13858992006-10-08 12:49:22 +0000901/* Specialized: */
Denys Vlasenko77832482010-08-12 14:14:45 +0200902
Denis Vlasenko13858992006-10-08 12:49:22 +0000903/* Using xatoi() instead of naive atoi() is not always convenient -
904 * in many places people want *non-negative* values, but store them
905 * in signed int. Therefore we need this one:
Denys Vlasenko77832482010-08-12 14:14:45 +0200906 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc.
907 * It should really be named xatoi_nonnegative (since it allows 0),
908 * but that would be too long.
909 */
910int xatoi_positive(const char *numstr) FAST_FUNC;
911
Denis Vlasenko13858992006-10-08 12:49:22 +0000912/* Useful for reading port numbers */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000913uint16_t xatou16(const char *numstr) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +0000914
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000915
Eric Andersenaad1a882001-03-16 22:47:14 +0000916/* These parse entries in /etc/passwd and /etc/group. This is desirable
917 * for BusyBox since we want to avoid using the glibc NSS stuff, which
Bernhard Reutner-Fischerd5bd1372005-09-20 21:06:17 +0000918 * increases target size and is often not needed on embedded systems. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000919long xuname2uid(const char *name) FAST_FUNC;
920long xgroup2gid(const char *name) FAST_FUNC;
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000921/* wrapper: allows string to contain numeric uid or gid */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000922unsigned long get_ug_id(const char *s, long FAST_FUNC (*xname2id)(const char *)) FAST_FUNC;
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000923struct bb_uidgid_t {
Denis Vlasenko150f4022007-01-13 21:06:21 +0000924 uid_t uid;
925 gid_t gid;
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000926};
Denys Vlasenko526d8582015-10-19 04:27:17 +0200927/* always sets uid and gid; returns 0 on failure */
928int get_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
929/* always sets uid and gid; exits on failure */
Bernhard Reutner-Fischerd73cbd32008-07-21 14:41:33 +0000930void xget_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
Denis Vlasenkocce38582007-02-26 22:47:42 +0000931/* chown-like handling of "user[:[group]" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000932void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group) FAST_FUNC;
Denis Vlasenkod7a805e2008-12-03 19:05:55 +0000933struct passwd* xgetpwnam(const char *name) FAST_FUNC;
Denis Vlasenko15437e32008-12-05 16:23:06 +0000934struct group* xgetgrnam(const char *name) FAST_FUNC;
Denis Vlasenko0c68a872008-12-02 22:56:59 +0000935struct passwd* xgetpwuid(uid_t uid) FAST_FUNC;
936struct group* xgetgrgid(gid_t gid) FAST_FUNC;
937char* xuid2uname(uid_t uid) FAST_FUNC;
938char* xgid2group(gid_t gid) FAST_FUNC;
939char* uid2uname(uid_t uid) FAST_FUNC;
940char* gid2group(gid_t gid) FAST_FUNC;
Denys Vlasenko7d65abe2011-03-01 16:27:13 +0100941char* uid2uname_utoa(uid_t uid) FAST_FUNC;
942char* gid2group_utoa(gid_t gid) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000943/* versions which cache results (useful for ps, ls etc) */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000944const char* get_cached_username(uid_t uid) FAST_FUNC;
945const char* get_cached_groupname(gid_t gid) FAST_FUNC;
946void clear_username_cache(void) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000947/* internally usernames are saved in fixed-sized char[] buffers */
Denys Vlasenko7d65abe2011-03-01 16:27:13 +0100948enum { USERNAME_MAX_SIZE = 32 - sizeof(uid_t) };
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +0000949#if ENABLE_FEATURE_CHECK_NAMES
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000950void die_if_bad_username(const char* name) FAST_FUNC;
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +0000951#else
952#define die_if_bad_username(name) ((void)(name))
953#endif
Eric Andersenaad1a882001-03-16 22:47:14 +0000954
Denys Vlasenko37f5bef2010-04-05 03:18:40 +0200955#if ENABLE_FEATURE_UTMP
Denys Vlasenko3a416112010-04-05 22:10:38 +0200956void FAST_FUNC write_new_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
957void 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 +0100958void FAST_FUNC update_utmp_DEAD_PROCESS(pid_t pid);
Denys Vlasenko37f5bef2010-04-05 03:18:40 +0200959#else
Denys Vlasenko3a416112010-04-05 22:10:38 +0200960# define write_new_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
961# define update_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
Denys Vlasenkoda921262015-01-05 15:37:58 +0100962# define update_utmp_DEAD_PROCESS(pid) ((void)0)
Denys Vlasenko37f5bef2010-04-05 03:18:40 +0200963#endif
964
Denys Vlasenkob72baeb2011-02-02 18:38:57 +0100965
Denys Vlasenkoe765b5a2014-05-02 17:15:58 +0200966int file_is_executable(const char *name) FAST_FUNC;
967char *find_executable(const char *filename, char **PATHp) FAST_FUNC;
968int executable_exists(const char *filename) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000969
Denis Vlasenko7e0fbf92007-09-04 19:33:22 +0000970/* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
971 * but it may exec busybox and call applet instead of searching PATH.
972 */
Denis Vlasenko80d14be2007-04-10 23:03:30 +0000973#if ENABLE_FEATURE_PREFER_APPLETS
Denys Vlasenkoc71b4692011-02-02 03:28:56 +0100974int BB_EXECVP(const char *file, char *const argv[]) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000975#define BB_EXECLP(prog,cmd,...) \
Denys Vlasenkoc71b4692011-02-02 03:28:56 +0100976 do { \
977 if (find_applet_by_name(prog) >= 0) \
978 execlp(bb_busybox_exec_path, cmd, __VA_ARGS__); \
979 execlp(prog, cmd, __VA_ARGS__); \
980 } while (0)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000981#else
982#define BB_EXECVP(prog,cmd) execvp(prog,cmd)
Denys Vlasenkoc71b4692011-02-02 03:28:56 +0100983#define BB_EXECLP(prog,cmd,...) execlp(prog,cmd,__VA_ARGS__)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000984#endif
Pascal Bellard21e8e8d2010-07-04 00:57:03 +0200985int BB_EXECVP_or_die(char **argv) NORETURN FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000986
Pascal Bellard926031b2010-07-04 15:32:38 +0200987/* xvfork() can't be a _function_, return after vfork mangles stack
988 * in the parent. It must be a macro. */
989#define xvfork() \
990({ \
991 pid_t bb__xvfork_pid = vfork(); \
992 if (bb__xvfork_pid < 0) \
993 bb_perror_msg_and_die("vfork"); \
994 bb__xvfork_pid; \
995})
996#if BB_MMU
997pid_t xfork(void) FAST_FUNC;
998#endif
999
Denys Vlasenko8531d762010-03-18 22:44:00 +01001000/* NOMMU friendy fork+exec: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001001pid_t spawn(char **argv) FAST_FUNC;
1002pid_t xspawn(char **argv) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +00001003
Denis Vlasenko3854c5d2008-11-06 22:39:57 +00001004pid_t safe_waitpid(pid_t pid, int *wstat, int options) FAST_FUNC;
Denys Vlasenko8531d762010-03-18 22:44:00 +01001005pid_t wait_any_nohang(int *wstat) FAST_FUNC;
1006/* wait4pid: unlike waitpid, waits ONLY for one process.
1007 * Returns sig + 0x180 if child is killed by signal.
Denis Vlasenkocd7001f2007-04-09 21:32:30 +00001008 * It's safe to pass negative 'pids' from failed [v]fork -
Denis Vlasenko473dae02007-04-11 07:04:23 +00001009 * wait4pid will return -1 (and will not clobber [v]fork's errno).
Denis Vlasenkocd7001f2007-04-09 21:32:30 +00001010 * IOW: rc = wait4pid(spawn(argv));
1011 * if (rc < 0) bb_perror_msg("%s", argv[0]);
Denys Vlasenko8531d762010-03-18 22:44:00 +01001012 * if (rc > 0) bb_error_msg("exit code: %d", rc & 0xff);
Denis Vlasenkocd7001f2007-04-09 21:32:30 +00001013 */
Denis Vlasenko3854c5d2008-11-06 22:39:57 +00001014int wait4pid(pid_t pid) FAST_FUNC;
Denys Vlasenko8531d762010-03-18 22:44:00 +01001015/* Same as wait4pid(spawn(argv)), but with NOFORK/NOEXEC if configured: */
Denys Vlasenko8f24f982009-06-07 16:02:00 +02001016int spawn_and_wait(char **argv) FAST_FUNC;
Denis Vlasenko18e19f22007-04-28 16:43:18 +00001017/* Does NOT check that applet is NOFORK, just blindly runs it */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001018int run_nofork_applet(int applet_no, char **argv) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +00001019
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001020/* Helpers for daemonization.
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001021 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001022 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001023 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001024 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
1025 * rexec's itself on NOMMU with argv passed as command line.
1026 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
1027 * from the start. (It will detect it and not reexec again second time).
1028 * You have to audit carefully that you don't do something twice as a result
1029 * (opening files/sockets, parsing config files etc...)!
1030 *
1031 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
1032 * (will do setsid()).
1033 *
Pascal Bellard926031b2010-07-04 15:32:38 +02001034 * fork_or_rexec(argv) = bare-bones fork on MMU,
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001035 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
Denis Vlasenko83518d12009-03-20 22:17:13 +00001036 * On MMU ignores argv.
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001037 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001038 * Helper for network daemons in foreground mode:
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001039 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001040 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
1041 * to /dev/null if they are not.
1042 */
1043enum {
1044 DAEMON_CHDIR_ROOT = 1,
Denis Vlasenkoa1b16f42007-07-31 17:09:44 +00001045 DAEMON_DEVNULL_STDIO = 2,
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001046 DAEMON_CLOSE_EXTRA_FDS = 4,
1047 DAEMON_ONLY_SANITIZE = 8, /* internal use */
Peter Korsgaard743edac2011-11-09 19:44:37 +01001048 DAEMON_DOUBLE_FORK = 16, /* double fork to avoid controlling tty */
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001049};
Denis Vlasenko473dae02007-04-11 07:04:23 +00001050#if BB_MMU
Denis Vlasenko367960b2007-08-18 14:20:21 +00001051 enum { re_execed = 0 };
Pascal Bellard926031b2010-07-04 15:32:38 +02001052# define fork_or_rexec(argv) xfork()
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001053# define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
1054# define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001055#else
Pascal Bellard926031b2010-07-04 15:32:38 +02001056 extern bool re_execed;
Denys Vlasenkod2277e22011-11-22 17:19:26 +01001057 /* Note: re_exec() and fork_or_rexec() do argv[0][0] |= 0x80 on NOMMU!
1058 * _Parent_ needs to undo it if it doesn't want to have argv[0] mangled.
1059 */
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001060 void re_exec(char **argv) NORETURN FAST_FUNC;
Denis Vlasenko83518d12009-03-20 22:17:13 +00001061 pid_t fork_or_rexec(char **argv) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001062 int BUG_fork_is_unavailable_on_nommu(void) FAST_FUNC;
1063 int BUG_daemon_is_unavailable_on_nommu(void) FAST_FUNC;
1064 void BUG_bb_daemonize_is_unavailable_on_nommu(void) FAST_FUNC;
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001065# define fork() BUG_fork_is_unavailable_on_nommu()
Pascal Bellard926031b2010-07-04 15:32:38 +02001066# define xfork() BUG_fork_is_unavailable_on_nommu()
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001067# define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
1068# define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001069#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001070void bb_daemonize_or_rexec(int flags, char **argv) FAST_FUNC;
1071void bb_sanitize_stdio(void) FAST_FUNC;
Denis Vlasenkoc9ca0a32008-02-18 11:08:33 +00001072/* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001073int sanitize_env_if_suid(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001074
1075
Denys Vlasenkoe992bae2009-11-28 15:18:53 +01001076char* single_argv(char **argv) FAST_FUNC;
Denis Vlasenko62a90cd2008-03-17 09:07:36 +00001077extern const char *const bb_argv_dash[]; /* "-", NULL */
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001078extern const char *opt_complementary;
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001079#if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +00001080#define No_argument "\0"
1081#define Required_argument "\001"
1082#define Optional_argument "\002"
1083extern const char *applet_long_options;
Denis Vlasenkoc61852a2006-11-29 11:09:43 +00001084#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001085extern uint32_t option_mask32;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001086extern uint32_t getopt32(char **argv, const char *applet_opts, ...) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001087
1088
Denys Vlasenko9be47022011-05-16 12:21:31 +02001089/* Having next pointer as a first member allows easy creation
1090 * of "llist-compatible" structs, and using llist_FOO functions
1091 * on them.
1092 */
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001093typedef struct llist_t {
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001094 struct llist_t *link;
Denys Vlasenko9be47022011-05-16 12:21:31 +02001095 char *data;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001096} llist_t;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001097void llist_add_to(llist_t **old_head, void *data) FAST_FUNC;
1098void llist_add_to_end(llist_t **list_head, void *data) FAST_FUNC;
1099void *llist_pop(llist_t **elm) FAST_FUNC;
1100void llist_unlink(llist_t **head, llist_t *elm) FAST_FUNC;
1101void llist_free(llist_t *elm, void (*freeit)(void *data)) FAST_FUNC;
1102llist_t *llist_rev(llist_t *list) FAST_FUNC;
Denis Vlasenko0b791d92009-04-13 20:52:00 +00001103llist_t *llist_find_str(llist_t *first, const char *str) FAST_FUNC;
Denis Vlasenko4b924f32007-05-30 00:29:55 +00001104/* BTW, surprisingly, changing API to
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001105 * llist_t *llist_add_to(llist_t *old_head, void *data)
1106 * etc does not result in smaller code... */
1107
Denis Vlasenko80edead2007-08-02 22:31:05 +00001108/* start_stop_daemon and udhcpc are special - they want
1109 * to create pidfiles regardless of FEATURE_PIDFILE */
Denis Vlasenko1caca342007-08-02 10:14:29 +00001110#if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001111/* True only if we created pidfile which is *file*, not /dev/null etc */
1112extern smallint wrote_pidfile;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001113void write_pidfile(const char *path) FAST_FUNC;
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001114#define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
Denis Vlasenko10457b92007-03-27 22:01:31 +00001115#else
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001116enum { wrote_pidfile = 0 };
1117#define write_pidfile(path) ((void)0)
1118#define remove_pidfile(path) ((void)0)
Denis Vlasenko10457b92007-03-27 22:01:31 +00001119#endif
1120
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001121enum {
1122 LOGMODE_NONE = 0,
Denis Vlasenko1b97efd2007-08-17 19:18:06 +00001123 LOGMODE_STDIO = (1 << 0),
1124 LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001125 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
1126};
1127extern const char *msg_eol;
Denys Vlasenko3dfe0ae2014-04-30 14:48:28 +02001128extern smallint syslog_level;
Denis Vlasenko04c99eb2007-04-07 00:44:31 +00001129extern smallint logmode;
Denys Vlasenko7aa63042010-09-01 16:04:24 +02001130extern uint8_t xfunc_error_retval;
Denys Vlasenko550bf5b2015-10-09 16:42:57 +02001131extern void (*die_func)(void);
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001132extern void xfunc_die(void) NORETURN FAST_FUNC;
1133extern void bb_show_usage(void) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001134extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1135extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1136extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1137extern void bb_simple_perror_msg(const char *s) FAST_FUNC;
1138extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
Denis Vlasenkofb1a23d2009-03-07 01:54:24 +00001139extern void bb_simple_perror_msg_and_die(const char *s) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001140extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1141extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001142extern void bb_perror_nomsg_and_die(void) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001143extern void bb_perror_nomsg(void) FAST_FUNC;
1144extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1145extern void bb_verror_msg(const char *s, va_list p, const char *strerr) FAST_FUNC;
Michel Stamd3fabf82014-11-04 12:19:04 +01001146extern void bb_logenv_override(void) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001147
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +00001148/* We need to export XXX_main from libbusybox
1149 * only if we build "individual" binaries
1150 */
1151#if ENABLE_FEATURE_INDIVIDUAL
1152#define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
1153#else
1154#define MAIN_EXTERNALLY_VISIBLE
1155#endif
1156
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001157
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001158/* Applets which are useful from another applets */
Denis Vlasenko06af2162007-02-03 17:28:39 +00001159int bb_cat(char** argv);
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001160/* If shell needs them, they exist even if not enabled as applets */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001161int echo_main(int argc, char** argv) IF_ECHO(MAIN_EXTERNALLY_VISIBLE);
1162int printf_main(int argc, char **argv) IF_PRINTF(MAIN_EXTERNALLY_VISIBLE);
1163int test_main(int argc, char **argv) IF_TEST(MAIN_EXTERNALLY_VISIBLE);
1164int kill_main(int argc, char **argv) IF_KILL(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001165/* Similar, but used by chgrp, not shell */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001166int chown_main(int argc, char **argv) IF_CHOWN(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenkoc41cba52009-03-09 15:46:07 +00001167/* Used by ftpd */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001168int ls_main(int argc, char **argv) IF_LS(MAIN_EXTERNALLY_VISIBLE);
1169/* Don't need IF_xxx() guard for these */
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +00001170int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko77f1ec12007-10-13 03:36:03 +00001171int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko1a9e9bd2008-11-01 12:54:56 +00001172
Denis Vlasenko468aea22008-04-01 14:47:57 +00001173#if ENABLE_ROUTE
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001174void bb_displayroutes(int noresolve, int netstatfmt) FAST_FUNC;
Denis Vlasenko468aea22008-04-01 14:47:57 +00001175#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001176
Denis Vlasenko270c17c2006-12-26 17:40:33 +00001177
1178/* Networking */
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001179/* This structure defines protocol families and their handlers. */
1180struct aftype {
1181 const char *name;
1182 const char *title;
1183 int af;
1184 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001185 char* FAST_FUNC (*print)(unsigned char *);
1186 const char* FAST_FUNC (*sprint)(struct sockaddr *, int numeric);
1187 int FAST_FUNC (*input)(/*int type,*/ const char *bufp, struct sockaddr *);
1188 void FAST_FUNC (*herror)(char *text);
1189 int FAST_FUNC (*rprint)(int options);
1190 int FAST_FUNC (*rinput)(int typ, int ext, char **argv);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001191 /* may modify src */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001192 int FAST_FUNC (*getmask)(char *src, struct sockaddr *mask, char *name);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001193};
1194/* This structure defines hardware protocols and their handlers. */
1195struct hwtype {
1196 const char *name;
1197 const char *title;
1198 int type;
1199 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001200 char* FAST_FUNC (*print)(unsigned char *);
1201 int FAST_FUNC (*input)(const char *, struct sockaddr *);
1202 int FAST_FUNC (*activate)(int fd);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001203 int suppress_null_addr;
1204};
Denis Vlasenko1b16bda2007-06-19 11:10:02 +00001205extern smallint interface_opt_a;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001206int display_interfaces(char *ifname) FAST_FUNC;
Bartosz Golaszewskic19be752013-07-25 04:39:04 +02001207int in_ether(const char *bufp, struct sockaddr *sap) FAST_FUNC;
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001208#if ENABLE_FEATURE_HWIB
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001209int in_ib(const char *bufp, struct sockaddr *sap) FAST_FUNC;
Denis Vlasenko3b162ec2008-06-04 07:59:51 +00001210#else
1211#define in_ib(a, b) 1 /* fail */
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001212#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001213const struct aftype *get_aftype(const char *name) FAST_FUNC;
1214const struct hwtype *get_hwtype(const char *name) FAST_FUNC;
1215const struct hwtype *get_hwntype(int type) FAST_FUNC;
Denis Vlasenko270c17c2006-12-26 17:40:33 +00001216
1217
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001218#ifndef BUILD_INDIVIDUAL
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001219extern int find_applet_by_name(const char *name) FAST_FUNC;
Denis Vlasenko32b633a2007-04-09 03:05:48 +00001220/* Returns only if applet is not found. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001221extern void run_applet_and_exit(const char *name, char **argv) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001222extern void run_applet_no_and_exit(int a, char **argv) NORETURN FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001223#endif
1224
Mike Frysinger9412ec72008-02-07 22:41:33 +00001225#ifdef HAVE_MNTENT_H
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001226extern int match_fstype(const struct mntent *mt, const char *fstypes) FAST_FUNC;
Denys Vlasenko6ae64262009-07-18 16:22:26 +02001227extern struct mntent *find_mount_point(const char *name, int subdir_too) FAST_FUNC;
Mike Frysinger9412ec72008-02-07 22:41:33 +00001228#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001229extern void erase_mtab(const char * name) FAST_FUNC;
1230extern unsigned int tty_baud_to_value(speed_t speed) FAST_FUNC;
1231extern speed_t tty_value_to_baud(unsigned int value) FAST_FUNC;
Denys Vlasenkoa355da02010-01-04 13:16:08 +01001232#if ENABLE_DESKTOP
1233extern void bb_warn_ignoring_args(char *arg) FAST_FUNC;
1234#else
1235# define bb_warn_ignoring_args(arg) ((void)0)
1236#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001237
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001238extern int get_linux_version_code(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001239
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001240extern char *query_loop(const char *device) FAST_FUNC;
1241extern int del_loop(const char *device) FAST_FUNC;
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001242/* If *devname is not NULL, use that name, otherwise try to find free one,
1243 * malloc and return it in *devname.
1244 * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
Denys Vlasenko13e709c2011-09-12 02:13:47 +02001245extern int set_loop(char **devname, const char *file, unsigned long long offset, int ro) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001246
Bernhard Reutner-Fischer82b14292008-12-03 18:48:39 +00001247/* Like bb_ask below, but asks on stdin with no timeout. */
1248char *bb_ask_stdin(const char * prompt) FAST_FUNC;
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +00001249//TODO: pass buf pointer or return allocated buf (avoid statics)?
Bernhard Reutner-Fischer82b14292008-12-03 18:48:39 +00001250char *bb_ask(const int fd, int timeout, const char * prompt) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001251int bb_ask_confirmation(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001252
Denys Vlasenko5711a2a2015-10-07 17:55:33 +02001253/* Returns -1 if input is invalid. current_mode is a base for e.g. "u+rw" */
1254int bb_parse_mode(const char* s, unsigned cur_mode) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001255
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001256/*
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001257 * Config file parser
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001258 */
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001259enum {
Denis Vlasenko084266e2008-07-26 23:08:31 +00001260 PARSE_COLLAPSE = 0x00010000, // treat consecutive delimiters as one
1261 PARSE_TRIM = 0x00020000, // trim leading and trailing delimiters
1262// TODO: COLLAPSE and TRIM seem to always go in pair
1263 PARSE_GREEDY = 0x00040000, // last token takes entire remainder of the line
1264 PARSE_MIN_DIE = 0x00100000, // die if < min tokens found
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001265 // keep a copy of current line
Denis Vlasenko35a064b2008-11-06 00:49:59 +00001266 PARSE_KEEP_COPY = 0x00200000 * ENABLE_FEATURE_CROND_D,
Denys Vlasenko499597d2012-01-11 00:37:17 +01001267 PARSE_EOL_COMMENTS = 0x00400000, // comments are recognized even if they aren't the first char
Denis Vlasenko084266e2008-07-26 23:08:31 +00001268 // NORMAL is:
1269 // * remove leading and trailing delimiters and collapse
1270 // multiple delimiters into one
1271 // * warn and continue if less than mintokens delimiters found
1272 // * grab everything into last token
Denys Vlasenko499597d2012-01-11 00:37:17 +01001273 // * comments are recognized even if they aren't the first char
1274 PARSE_NORMAL = PARSE_COLLAPSE | PARSE_TRIM | PARSE_GREEDY | PARSE_EOL_COMMENTS,
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001275};
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001276typedef struct parser_t {
1277 FILE *fp;
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001278 char *data;
Timo Terasadcabf32011-06-20 09:49:56 +02001279 char *line, *nline;
1280 size_t line_alloc, nline_alloc;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001281 int lineno;
1282} parser_t;
Bernhard Reutner-Fischer67921282008-07-17 11:59:13 +00001283parser_t* config_open(const char *filename) FAST_FUNC;
Denis Vlasenko5415c852008-07-21 23:05:26 +00001284parser_t* config_open2(const char *filename, FILE* FAST_FUNC (*fopen_func)(const char *path)) FAST_FUNC;
Denys Vlasenkoadbbee42010-06-21 07:17:23 +02001285/* delims[0] is a comment char (use '\0' to disable), the rest are token delimiters */
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001286int config_read(parser_t *parser, char **tokens, unsigned flags, const char *delims) FAST_FUNC;
1287#define config_read(parser, tokens, max, min, str, flags) \
1288 config_read(parser, tokens, ((flags) | (((min) & 0xFF) << 8) | ((max) & 0xFF)), str)
Denis Vlasenkoc01340f2008-07-16 22:12:18 +00001289void config_close(parser_t *parser) FAST_FUNC;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001290
Denis Vlasenko6bf05cf2008-05-07 12:18:48 +00001291/* Concatenate path and filename to new allocated buffer.
1292 * Add "/" only as needed (no duplicate "//" are produced).
1293 * If path is NULL, it is assumed to be "/".
1294 * filename should not be NULL. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001295char *concat_path_file(const char *path, const char *filename) FAST_FUNC;
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +02001296/* Returns NULL on . and .. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001297char *concat_subpath_file(const char *path, const char *filename) FAST_FUNC;
Eric Andersene5dfced2001-04-09 22:48:12 +00001298
Denis Vlasenko4921b542007-02-03 02:17:41 +00001299
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001300int bb_make_directory(char *path, long mode, int flags) FAST_FUNC;
Matt Kraaiceeff732001-06-21 19:41:37 +00001301
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001302int get_signum(const char *name) FAST_FUNC;
1303const char *get_signame(int number) FAST_FUNC;
1304void print_signames(void) FAST_FUNC;
Rob Landleyc9c1a412006-07-12 19:17:55 +00001305
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001306char *bb_simplify_path(const char *path) FAST_FUNC;
Denis Vlasenko1cf4a0e2009-04-22 13:49:16 +00001307/* Returns ptr to NUL */
1308char *bb_simplify_abs_path_inplace(char *path) FAST_FUNC;
Eric Andersen34506362001-08-02 05:02:46 +00001309
Peter Kümmela6588fa2014-12-22 01:55:54 +01001310#ifndef LOGIN_FAIL_DELAY
Denys Vlasenko681efe22011-03-08 21:00:36 +01001311#define LOGIN_FAIL_DELAY 3
Peter Kümmela6588fa2014-12-22 01:55:54 +01001312#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001313extern void bb_do_delay(int seconds) FAST_FUNC;
1314extern void change_identity(const struct passwd *pw) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001315extern 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 +01001316
1317/* Returns $SHELL, getpwuid(getuid())->pw_shell, or DEFAULT_SHELL.
1318 * Note that getpwuid result might need xstrdup'ing
1319 * if there is a possibility of intervening getpwxxx() calls.
1320 */
Denys Vlasenkofd77ea52012-10-03 09:42:21 +02001321const char *get_shell_name(void) FAST_FUNC;
Denys Vlasenko681efe22011-03-08 21:00:36 +01001322
Denis Vlasenkob5a122b2006-12-30 14:46:51 +00001323#if ENABLE_SELINUX
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001324extern void renew_current_security_context(void) FAST_FUNC;
1325extern void set_current_security_context(security_context_t sid) FAST_FUNC;
Denis Vlasenko1203c9b2007-03-11 22:16:02 +00001326extern context_t set_security_context_component(security_context_t cur_context,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001327 char *user, char *role, char *type, char *range) FAST_FUNC;
1328extern void setfscreatecon_or_die(security_context_t scontext) FAST_FUNC;
1329extern void selinux_preserve_fcontext(int fdesc) FAST_FUNC;
Denis Vlasenko2edbc2a2007-10-20 02:00:49 +00001330#else
1331#define selinux_preserve_fcontext(fdesc) ((void)0)
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001332#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001333extern void selinux_or_die(void) FAST_FUNC;
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001334
Davide Cavalca9b3b9792011-01-25 02:26:03 +01001335
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001336/* setup_environment:
Bernhard Reutner-Fischer99709ab2010-02-24 16:10:09 +01001337 * if chdir pw->pw_dir: ok: else if to_tmp == 1: goto /tmp else: goto / or die
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001338 * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001339 * TERM=(old value)
1340 * USER=pw->pw_name, LOGNAME=pw->pw_name
1341 * PATH=bb_default_[root_]path
1342 * HOME=pw->pw_dir
1343 * SHELL=shell
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001344 * else if change_env = 1:
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001345 * if not root (if pw->pw_uid != 0):
1346 * USER=pw->pw_name, LOGNAME=pw->pw_name
1347 * HOME=pw->pw_dir
1348 * SHELL=shell
1349 * else does nothing
1350 */
Denys Vlasenkofd686a22010-02-26 09:52:45 +01001351#define SETUP_ENV_CHANGEENV (1 << 0)
1352#define SETUP_ENV_CLEARENV (1 << 1)
1353#define SETUP_ENV_TO_TMP (1 << 2)
Pascal Bellard70fc8c12012-06-12 13:21:02 +02001354#define SETUP_ENV_NO_CHDIR (1 << 4)
Denys Vlasenko8b59b2c2013-11-19 13:36:45 +01001355void setup_environment(const char *shell, int flags, const struct passwd *pw) FAST_FUNC;
1356void nuke_str(char *str) FAST_FUNC;
Morten Kvistgaardfeac9b62014-08-05 21:57:18 +02001357int check_password(const struct passwd *pw, const char *plaintext) FAST_FUNC;
Denys Vlasenko8b59b2c2013-11-19 13:36:45 +01001358int ask_and_check_password_extended(const struct passwd *pw, int timeout, const char *prompt) FAST_FUNC;
1359int ask_and_check_password(const struct passwd *pw) FAST_FUNC;
Denis Vlasenkofdddab02008-06-12 16:56:52 +00001360/* Returns a malloced string */
Denis Vlasenkob4c5bf62008-06-15 18:35:34 +00001361#if !ENABLE_USE_BB_CRYPT
1362#define pw_encrypt(clear, salt, cleanup) pw_encrypt(clear, salt)
1363#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001364extern char *pw_encrypt(const char *clear, const char *salt, int cleanup) FAST_FUNC;
1365extern int obscure(const char *old, const char *newval, const struct passwd *pwdp) FAST_FUNC;
Denys Vlasenko12a43272011-05-13 03:19:01 +02001366/*
1367 * rnd is additional random input. New one is returned.
Denis Vlasenko4ea83bf2008-06-12 16:55:59 +00001368 * Useful if you call crypt_make_salt many times in a row:
1369 * rnd = crypt_make_salt(buf1, 4, 0);
1370 * rnd = crypt_make_salt(buf2, 4, rnd);
1371 * rnd = crypt_make_salt(buf3, 4, rnd);
1372 * (otherwise we risk having same salt generated)
1373 */
Denys Vlasenko12a43272011-05-13 03:19:01 +02001374extern int crypt_make_salt(char *p, int cnt /*, int rnd*/) FAST_FUNC;
1375/* "$N$" + sha_salt_16_bytes + NUL */
1376#define MAX_PW_SALT_LEN (3 + 16 + 1)
1377extern char* crypt_make_pw_salt(char p[MAX_PW_SALT_LEN], const char *algo) FAST_FUNC;
1378
Denis Vlasenko829bbd32009-04-14 00:51:05 +00001379
Denis Vlasenko4ea83bf2008-06-12 16:55:59 +00001380/* Returns number of lines changed, or -1 on error */
Denis Vlasenko829bbd32009-04-14 00:51:05 +00001381#if !(ENABLE_FEATURE_ADDUSER_TO_GROUP || ENABLE_FEATURE_DEL_USER_FROM_GROUP)
1382#define update_passwd(filename, username, data, member) \
1383 update_passwd(filename, username, data)
1384#endif
1385extern int update_passwd(const char *filename,
1386 const char *username,
1387 const char *data,
1388 const char *member) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001389
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001390int index_in_str_array(const char *const string_array[], const char *key) FAST_FUNC;
1391int index_in_strings(const char *strings, const char *key) FAST_FUNC;
1392int index_in_substr_array(const char *const string_array[], const char *key) FAST_FUNC;
1393int index_in_substrings(const char *strings, const char *key) FAST_FUNC;
1394const char *nth_string(const char *strings, int n) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001395
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001396extern void print_login_issue(const char *issue_file, const char *tty) FAST_FUNC;
1397extern void print_login_prompt(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001398
Denys Vlasenko53283ad2009-11-02 14:20:34 +01001399char *xmalloc_ttyname(int fd) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof893da82007-08-09 08:27:24 +00001400/* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001401int get_terminal_width_height(int fd, unsigned *width, unsigned *height) FAST_FUNC;
Denys Vlasenko641caae2015-10-23 01:44:22 +02001402int get_terminal_width(int fd) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001403
Denis Vlasenko202ac502008-11-05 13:20:58 +00001404int tcsetattr_stdin_TCSANOW(const struct termios *tp) FAST_FUNC;
1405
Denis Vlasenko5bb2fc22008-04-21 03:23:59 +00001406/* NB: "unsigned request" is crucial! "int request" will break some arches! */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001407int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1408int 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 +00001409#if ENABLE_IOCTL_HEX2STR_ERROR
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001410int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1411int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001412#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1413#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
1414#else
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001415int bb_ioctl_or_warn(int fd, unsigned request, void *argp) FAST_FUNC;
1416int bb_xioctl(int fd, unsigned request, void *argp) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001417#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1418#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
1419#endif
1420
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001421char *is_in_ino_dev_hashtable(const struct stat *statbuf) FAST_FUNC;
1422void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name) FAST_FUNC;
1423void reset_ino_dev_hashtable(void) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001424#ifdef __GLIBC__
1425/* At least glibc has horrendously large inline for this, so wrap it */
Denys Vlasenko975c7142011-01-24 23:53:12 +01001426unsigned long long bb_makedev(unsigned major, unsigned minor) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001427#undef makedev
1428#define makedev(a,b) bb_makedev(a,b)
1429#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001430
1431
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001432/* "Keycodes" that report an escape sequence.
1433 * We use something which fits into signed char,
Denys Vlasenko5370bfb2009-09-06 02:58:59 +02001434 * yet doesn't represent any valid Unicode character.
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001435 * Also, -1 is reserved for error indication and we don't use it. */
1436enum {
1437 KEYCODE_UP = -2,
1438 KEYCODE_DOWN = -3,
1439 KEYCODE_RIGHT = -4,
1440 KEYCODE_LEFT = -5,
1441 KEYCODE_HOME = -6,
1442 KEYCODE_END = -7,
1443 KEYCODE_INSERT = -8,
1444 KEYCODE_DELETE = -9,
1445 KEYCODE_PAGEUP = -10,
1446 KEYCODE_PAGEDOWN = -11,
Denys Vlasenko9ce09bc2011-11-03 13:28:22 +01001447 // -12 is reserved for Alt/Ctrl/Shift-TAB
1448#if 0
1449 KEYCODE_FUN1 = -13,
1450 KEYCODE_FUN2 = -14,
1451 KEYCODE_FUN3 = -15,
1452 KEYCODE_FUN4 = -16,
1453 KEYCODE_FUN5 = -17,
1454 KEYCODE_FUN6 = -18,
1455 KEYCODE_FUN7 = -19,
1456 KEYCODE_FUN8 = -20,
1457 KEYCODE_FUN9 = -21,
1458 KEYCODE_FUN10 = -22,
1459 KEYCODE_FUN11 = -23,
1460 KEYCODE_FUN12 = -24,
1461#endif
1462 /* Be sure that last defined value is small enough
1463 * to not interfere with Alt/Ctrl/Shift bits.
1464 * So far we do not exceed -31 (0xfff..fffe1),
1465 * which gives us three upper bits in LSB to play with.
1466 */
1467 //KEYCODE_SHIFT_TAB = (-12) & ~0x80,
1468 //KEYCODE_SHIFT_... = KEYCODE_... & ~0x80,
1469 //KEYCODE_CTRL_UP = KEYCODE_UP & ~0x40,
1470 //KEYCODE_CTRL_DOWN = KEYCODE_DOWN & ~0x40,
Denys Vlasenkoa17eeb82009-10-25 23:50:56 +01001471 KEYCODE_CTRL_RIGHT = KEYCODE_RIGHT & ~0x40,
1472 KEYCODE_CTRL_LEFT = KEYCODE_LEFT & ~0x40,
Denys Vlasenko9ce09bc2011-11-03 13:28:22 +01001473 //KEYCODE_ALT_UP = KEYCODE_UP & ~0x20,
1474 //KEYCODE_ALT_DOWN = KEYCODE_DOWN & ~0x20,
1475 KEYCODE_ALT_RIGHT = KEYCODE_RIGHT & ~0x20,
1476 KEYCODE_ALT_LEFT = KEYCODE_LEFT & ~0x20,
1477
Denys Vlasenko180f5852009-10-26 00:59:59 +01001478 KEYCODE_CURSOR_POS = -0x100, /* 0xfff..fff00 */
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001479 /* How long is the longest ESC sequence we know?
1480 * We want it big enough to be able to contain
1481 * cursor position sequence "ESC [ 9999 ; 9999 R"
1482 */
1483 KEYCODE_BUFFER_SIZE = 16
1484};
1485/* Note: fd may be in blocking or non-blocking mode, both make sense.
1486 * For one, less uses non-blocking mode.
1487 * Only the first read syscall inside read_key may block indefinitely
1488 * (unless fd is in non-blocking mode),
1489 * subsequent reads will time out after a few milliseconds.
1490 * Return of -1 means EOF or error (errno == 0 on EOF).
1491 * buffer[0] is used as a counter of buffered chars and must be 0
1492 * on first call.
Denys Vlasenko58f108e2010-03-11 21:17:55 +01001493 * timeout:
1494 * -2: do not poll for input;
1495 * -1: poll(-1) (i.e. block);
1496 * >=0: poll for TIMEOUT milliseconds, return -1/EAGAIN on timeout
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001497 */
Denys Vlasenko58f108e2010-03-11 21:17:55 +01001498int64_t read_key(int fd, char *buffer, int timeout) FAST_FUNC;
Tomas Heinrichd2b04052010-03-09 14:09:24 +01001499void read_key_ungets(char *buffer, const char *str, unsigned len) FAST_FUNC;
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001500
1501
Denis Vlasenko38f63192007-01-22 09:03:07 +00001502#if ENABLE_FEATURE_EDITING
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001503/* It's NOT just ENABLEd or disabled. It's a number: */
Denys Vlasenko2c4de5b2011-03-31 13:16:52 +02001504# if defined CONFIG_FEATURE_EDITING_HISTORY && CONFIG_FEATURE_EDITING_HISTORY > 0
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001505# define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
Flemming Madsend96ffda2013-04-07 18:47:24 +02001506unsigned size_from_HISTFILESIZE(const char *hp) FAST_FUNC;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001507# else
1508# define MAX_HISTORY 0
1509# endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001510typedef struct line_input_t {
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001511 int flags;
1512 const char *path_lookup;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001513# if MAX_HISTORY
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001514 int cnt_history;
1515 int cur_history;
Denys Vlasenko2c4de5b2011-03-31 13:16:52 +02001516 int max_history; /* must never be <= 0 */
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001517# if ENABLE_FEATURE_EDITING_SAVEHISTORY
Denys Vlasenkobede2152011-09-04 16:12:33 +02001518 /* meaning of this field depends on FEATURE_EDITING_SAVE_ON_EXIT:
1519 * if !FEATURE_EDITING_SAVE_ON_EXIT: "how many lines are
1520 * in on-disk history"
1521 * if FEATURE_EDITING_SAVE_ON_EXIT: "how many in-memory lines are
1522 * also in on-disk history (and thus need to be skipped on save)"
1523 */
Denis Vlasenko57abf9e2009-03-22 19:00:05 +00001524 unsigned cnt_history_in_file;
Denis Vlasenko57abf9e2009-03-22 19:00:05 +00001525 const char *hist_file;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001526# endif
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001527 char *history[MAX_HISTORY + 1];
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001528# endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001529} line_input_t;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001530enum {
Denys Vlasenkoe45af7a2011-09-04 16:15:24 +02001531 DO_HISTORY = 1 * (MAX_HISTORY > 0),
1532 TAB_COMPLETION = 2 * ENABLE_FEATURE_TAB_COMPLETION,
1533 USERNAME_COMPLETION = 4 * ENABLE_FEATURE_USERNAME_COMPLETION,
1534 VI_MODE = 8 * ENABLE_FEATURE_EDITING_VI,
1535 WITH_PATH_LOOKUP = 0x10,
1536 FOR_SHELL = DO_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001537};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001538line_input_t *new_line_input_t(int flags) FAST_FUNC;
Denys Vlasenko5c2e81b2009-07-16 14:14:34 +02001539/* So far static: void free_line_input_t(line_input_t *n) FAST_FUNC; */
Denys Vlasenko046341e2011-02-04 17:53:59 +01001540/*
1541 * maxsize must be >= 2.
Denys Vlasenko5c2e81b2009-07-16 14:14:34 +02001542 * Returns:
Denis Vlasenko80667e32008-02-02 18:35:55 +00001543 * -1 on read errors or EOF, or on bare Ctrl-D,
1544 * 0 on ctrl-C (the line entered is still returned in 'command'),
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001545 * >0 length of input string, including terminating '\n'
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001546 */
Denys Vlasenko66c5b122011-02-08 05:07:02 +01001547int 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 +02001548void show_history(const line_input_t *st) FAST_FUNC;
Denys Vlasenkobede2152011-09-04 16:12:33 +02001549# if ENABLE_FEATURE_EDITING_SAVE_ON_EXIT
1550void save_history(line_input_t *st);
1551# endif
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001552#else
Denys Vlasenko36df0482009-10-19 16:07:28 +02001553#define MAX_HISTORY 0
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001554int read_line_input(const char* prompt, char* command, int maxsize) FAST_FUNC;
Denys Vlasenko66c5b122011-02-08 05:07:02 +01001555#define read_line_input(state, prompt, command, maxsize, timeout) \
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001556 read_line_input(prompt, command, maxsize)
1557#endif
1558
1559
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001560#ifndef COMM_LEN
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001561# ifdef TASK_COMM_LEN
Denis Vlasenkofa076802006-11-05 00:38:51 +00001562enum { COMM_LEN = TASK_COMM_LEN };
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001563# else
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001564/* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
Denis Vlasenkofa076802006-11-05 00:38:51 +00001565enum { COMM_LEN = 16 };
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001566# endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001567#endif
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02001568
1569struct smaprec {
1570 unsigned long mapped_rw;
1571 unsigned long mapped_ro;
1572 unsigned long shared_clean;
1573 unsigned long shared_dirty;
1574 unsigned long private_clean;
1575 unsigned long private_dirty;
1576 unsigned long stack;
1577 unsigned long smap_pss, smap_swap;
1578 unsigned long smap_size;
1579 unsigned long smap_start;
1580 char smap_mode[5];
1581 char *smap_name;
1582};
1583
1584#if !ENABLE_PMAP
1585#define procps_read_smaps(pid, total, cb, data) \
1586 procps_read_smaps(pid, total)
1587#endif
1588int FAST_FUNC procps_read_smaps(pid_t pid, struct smaprec *total,
Denys Vlasenko6830ade2013-01-15 13:58:01 +01001589 void (*cb)(struct smaprec *, void *), void *data);
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02001590
Denis Vlasenko512499c2007-08-26 18:23:13 +00001591typedef struct procps_status_t {
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001592 DIR *dir;
Denys Vlasenkob410d4a2009-09-19 22:29:42 +02001593 IF_FEATURE_SHOW_THREADS(DIR *task_dir;)
Denis Vlasenko512499c2007-08-26 18:23:13 +00001594 uint8_t shift_pages_to_bytes;
1595 uint8_t shift_pages_to_kb;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001596/* Fields are set to 0/NULL if failed to determine (or not requested) */
Denis Vlasenko3b3ca112008-07-17 18:39:36 +00001597 uint16_t argv_len;
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001598 char *argv0;
Alexander Shishkine766f622009-07-29 01:35:13 +02001599 char *exe;
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001600 IF_SELINUX(char *context;)
Lauri Kasanen6578f2c2010-12-05 05:22:29 +01001601 IF_FEATURE_SHOW_THREADS(unsigned main_thread_pid;)
Denis Vlasenko0696b8a2007-06-06 07:40:16 +00001602 /* Everything below must contain no ptrs to malloc'ed data:
1603 * it is memset(0) for each process in procps_scan() */
Denis Vlasenkofc1e9952007-08-29 18:23:36 +00001604 unsigned long vsz, rss; /* we round it to kbytes */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001605 unsigned long stime, utime;
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001606 unsigned long start_time;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001607 unsigned pid;
1608 unsigned ppid;
1609 unsigned pgid;
1610 unsigned sid;
1611 unsigned uid;
1612 unsigned gid;
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001613#if ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS
1614 unsigned ruid;
1615 unsigned rgid;
1616 int niceness;
1617#endif
Denis Vlasenko31789a82007-06-19 14:43:17 +00001618 unsigned tty_major,tty_minor;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001619#if ENABLE_FEATURE_TOPMEM
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02001620 struct smaprec smaps;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001621#endif
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001622 char state[4];
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001623 /* basename of executable in exec(2), read from /proc/N/stat
1624 * (if executable is symlink or script, it is NOT replaced
1625 * by link target or interpreter name) */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001626 char comm[COMM_LEN];
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001627 /* user/group? - use passwd/group parsing functions */
Denis Vlasenko17e7f042008-09-25 10:48:06 +00001628#if ENABLE_FEATURE_TOP_SMP_PROCESS
1629 int last_seen_on_cpu;
1630#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001631} procps_status_t;
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001632/* flag bits for procps_scan(xx, flags) calls */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001633enum {
1634 PSSCAN_PID = 1 << 0,
1635 PSSCAN_PPID = 1 << 1,
1636 PSSCAN_PGID = 1 << 2,
1637 PSSCAN_SID = 1 << 3,
1638 PSSCAN_UIDGID = 1 << 4,
1639 PSSCAN_COMM = 1 << 5,
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001640 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001641 PSSCAN_ARGV0 = 1 << 7,
Alexander Shishkine766f622009-07-29 01:35:13 +02001642 PSSCAN_EXE = 1 << 8,
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001643 PSSCAN_STATE = 1 << 9,
1644 PSSCAN_VSZ = 1 << 10,
1645 PSSCAN_RSS = 1 << 11,
1646 PSSCAN_STIME = 1 << 12,
1647 PSSCAN_UTIME = 1 << 13,
1648 PSSCAN_TTY = 1 << 14,
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001649 PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM,
Denis Vlasenko9f00e052009-02-14 01:36:11 +00001650 /* NB: used by find_pid_by_name(). Any applet using it
1651 * needs to be mentioned here. */
1652 PSSCAN_ARGVN = (1 << 16) * (ENABLE_KILLALL
1653 || ENABLE_PGREP || ENABLE_PKILL
1654 || ENABLE_PIDOF
Denis Vlasenko3266aa92009-04-01 11:24:04 +00001655 || ENABLE_SESTATUS
Denis Vlasenko9f00e052009-02-14 01:36:11 +00001656 ),
Denys Vlasenko4ff1ce02009-09-22 11:21:48 +02001657 PSSCAN_CONTEXT = (1 << 17) * ENABLE_SELINUX,
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001658 PSSCAN_START_TIME = 1 << 18,
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001659 PSSCAN_CPU = (1 << 19) * ENABLE_FEATURE_TOP_SMP_PROCESS,
1660 PSSCAN_NICE = (1 << 20) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1661 PSSCAN_RUIDGID = (1 << 21) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
Denys Vlasenkob410d4a2009-09-19 22:29:42 +02001662 PSSCAN_TASKS = (1 << 22) * ENABLE_FEATURE_SHOW_THREADS,
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001663};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001664//procps_status_t* alloc_procps_scan(void) FAST_FUNC;
1665void free_procps_scan(procps_status_t* sp) FAST_FUNC;
1666procps_status_t* procps_scan(procps_status_t* sp, int flags) FAST_FUNC;
Denys Vlasenko3a0f6f22009-09-12 00:15:34 +02001667/* Format cmdline (up to col chars) into char buf[size] */
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001668/* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
Denys Vlasenko3a0f6f22009-09-12 00:15:34 +02001669void read_cmdline(char *buf, int size, unsigned pid, const char *comm) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001670pid_t *find_pid_by_name(const char* procName) FAST_FUNC;
1671pid_t *pidlist_reverse(pid_t *pidList) FAST_FUNC;
Denys Vlasenkoc9b97502010-08-16 02:49:21 +02001672int starts_with_cpu(const char *str) FAST_FUNC;
1673unsigned get_cpu_count(void) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001674
1675
Denys Vlasenkodd1061b2011-09-11 21:04:02 +02001676/* Use strict=1 if you process input from untrusted source:
1677 * it will return NULL on invalid %xx (bad hex chars)
1678 * and str + 1 if decoded char is / or NUL.
1679 * In non-strict mode, it always succeeds (returns str),
1680 * and also it additionally decoded '+' to space.
1681 */
1682char *percent_decode_in_place(char *str, int strict) FAST_FUNC;
1683
1684
Aurelien Jarnod3a42392012-07-24 16:28:34 +02001685extern const char bb_uuenc_tbl_base64[] ALIGN1;
1686extern const char bb_uuenc_tbl_std[] ALIGN1;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001687void bb_uuencode(char *store, const void *s, int length, const char *tbl) FAST_FUNC;
Denys Vlasenko9fe98f72010-09-16 17:51:13 +02001688enum {
1689 BASE64_FLAG_UU_STOP = 0x100,
1690 /* Sign-extends to a value which never matches fgetc result: */
1691 BASE64_FLAG_NO_STOP_CHAR = 0x80,
1692};
Leonid Lisovskiy328f27f2011-10-28 13:59:04 +02001693const char *decode_base64(char **pp_dst, const char *src) FAST_FUNC;
1694void read_base64(FILE *src_stream, FILE *dst_stream, int flags) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001695
Denis Vlasenkodd539f72006-11-01 20:20:37 +00001696typedef struct md5_ctx_t {
Denys Vlasenko302ad142010-10-19 02:16:12 +02001697 uint8_t wbuffer[64]; /* always correctly aligned for uint64_t */
1698 void (*process_block)(struct md5_ctx_t*) FAST_FUNC;
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02001699 uint64_t total64; /* must be directly before hash[] */
Denys Vlasenko302ad142010-10-19 02:16:12 +02001700 uint32_t hash[8]; /* 4 elements for md5, 5 for sha1, 8 for sha256 */
1701} md5_ctx_t;
1702typedef struct md5_ctx_t sha1_ctx_t;
1703typedef struct md5_ctx_t sha256_ctx_t;
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02001704typedef struct sha512_ctx_t {
1705 uint64_t total64[2]; /* must be directly before hash[] */
1706 uint64_t hash[8];
Denys Vlasenko302ad142010-10-19 02:16:12 +02001707 uint8_t wbuffer[128]; /* always correctly aligned for uint64_t */
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02001708} sha512_ctx_t;
Lauri Kasanenb8173b62013-01-14 05:20:50 +01001709typedef struct sha3_ctx_t {
1710 uint64_t state[25];
1711 unsigned bytes_queued;
1712} sha3_ctx_t;
Denys Vlasenko302ad142010-10-19 02:16:12 +02001713void md5_begin(md5_ctx_t *ctx) FAST_FUNC;
Denys Vlasenko2cfcc9e2013-01-20 00:38:09 +01001714void md5_hash(md5_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
Denys Vlasenko302ad142010-10-19 02:16:12 +02001715void md5_end(md5_ctx_t *ctx, void *resbuf) FAST_FUNC;
1716void sha1_begin(sha1_ctx_t *ctx) FAST_FUNC;
1717#define sha1_hash md5_hash
1718void sha1_end(sha1_ctx_t *ctx, void *resbuf) FAST_FUNC;
1719void sha256_begin(sha256_ctx_t *ctx) FAST_FUNC;
1720#define sha256_hash md5_hash
1721#define sha256_end sha1_end
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02001722void sha512_begin(sha512_ctx_t *ctx) FAST_FUNC;
1723void sha512_hash(sha512_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
1724void sha512_end(sha512_ctx_t *ctx, void *resbuf) FAST_FUNC;
Lauri Kasanenb8173b62013-01-14 05:20:50 +01001725void sha3_begin(sha3_ctx_t *ctx) FAST_FUNC;
1726void sha3_hash(sha3_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
Denys Vlasenko2cfcc9e2013-01-20 00:38:09 +01001727void sha3_end(sha3_ctx_t *ctx, void *resbuf) FAST_FUNC;
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00001728
Denys Vlasenko9ce642f2010-10-27 15:26:45 +02001729extern uint32_t *global_crc32_table;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001730uint32_t *crc32_filltable(uint32_t *tbl256, int endian) FAST_FUNC;
Denys Vlasenko9ce642f2010-10-27 15:26:45 +02001731uint32_t crc32_block_endian1(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
1732uint32_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 +00001733
1734typedef struct masks_labels_t {
1735 const char *labels;
1736 const int masks[];
1737} masks_labels_t;
1738int print_flags_separated(const int *masks, const char *labels,
1739 int flags, const char *separator) FAST_FUNC;
1740int print_flags(const masks_labels_t *ml, int flags) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001741
Magnus Dammf5914992009-11-08 16:34:43 +01001742typedef struct bb_progress_t {
Denys Vlasenkoab8d00d2011-02-11 19:09:30 +01001743 unsigned last_size;
1744 unsigned last_update_sec;
1745 unsigned last_change_sec;
Magnus Dammf5914992009-11-08 16:34:43 +01001746 unsigned start_sec;
Denys Vlasenkod55e1392011-02-11 18:56:13 +01001747 const char *curfile;
Magnus Dammf5914992009-11-08 16:34:43 +01001748} bb_progress_t;
1749
Denys Vlasenkod55e1392011-02-11 18:56:13 +01001750#define is_bb_progress_inited(p) ((p)->curfile != NULL)
1751#define bb_progress_free(p) do { \
1752 if (ENABLE_UNICODE_SUPPORT) free((char*)((p)->curfile)); \
1753 (p)->curfile = NULL; \
1754} while (0)
1755void bb_progress_init(bb_progress_t *p, const char *curfile) FAST_FUNC;
1756void bb_progress_update(bb_progress_t *p,
Denys Vlasenko805aa9f2011-02-10 14:25:51 +01001757 uoff_t beg_range,
1758 uoff_t transferred,
1759 uoff_t totalsize) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001760
Denys Vlasenkod55e1392011-02-11 18:56:13 +01001761
Denis Vlasenko8f8f2682006-10-03 21:00:43 +00001762extern const char *applet_name;
Denys Vlasenko0004e992010-09-01 12:01:17 +02001763
1764/* Some older linkers don't perform string merging, we used to have common strings
1765 * as global arrays to do it by hand. But:
1766 * (1) newer linkers do it themselves,
1767 * (2) however, they DONT merge string constants with global arrays,
1768 * even if the value is the same (!). Thus global arrays actually
1769 * increased size a bit: for example, "/etc/passwd" string from libc
1770 * wasn't merged with bb_path_passwd_file[] array!
1771 * Therefore now we use #defines.
1772 */
Bernhard Reutner-Fischer78e1d582008-01-13 17:52:53 +00001773/* "BusyBox vN.N.N (timestamp or extra_version)" */
Aurelien Jarnod3a42392012-07-24 16:28:34 +02001774extern const char bb_banner[] ALIGN1;
1775extern const char bb_msg_memory_exhausted[] ALIGN1;
1776extern const char bb_msg_invalid_date[] ALIGN1;
Denys Vlasenko0004e992010-09-01 12:01:17 +02001777#define bb_msg_read_error "read error"
1778#define bb_msg_write_error "write error"
Aurelien Jarnod3a42392012-07-24 16:28:34 +02001779extern const char bb_msg_unknown[] ALIGN1;
1780extern const char bb_msg_can_not_create_raw_socket[] ALIGN1;
1781extern const char bb_msg_perm_denied_are_you_root[] ALIGN1;
1782extern const char bb_msg_you_must_be_root[] ALIGN1;
1783extern const char bb_msg_requires_arg[] ALIGN1;
Denys Vlasenko0f296a32015-10-14 13:21:01 +02001784extern const char bb_msg_invalid_arg_to[] ALIGN1;
Aurelien Jarnod3a42392012-07-24 16:28:34 +02001785extern const char bb_msg_standard_input[] ALIGN1;
1786extern const char bb_msg_standard_output[] ALIGN1;
Manuel Novoa III cad53642003-03-19 09:13:01 +00001787
Denis Vlasenko98c0bba2007-01-26 23:31:05 +00001788/* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
Aurelien Jarnod3a42392012-07-24 16:28:34 +02001789extern const char bb_hexdigits_upcase[] ALIGN1;
Denis Vlasenko7ca39212006-11-21 20:34:21 +00001790
Aurelien Jarnod3a42392012-07-24 16:28:34 +02001791extern const char bb_path_wtmp_file[] ALIGN1;
Denys Vlasenko0004e992010-09-01 12:01:17 +02001792
1793/* Busybox mount uses either /proc/mounts or /etc/mtab to
1794 * get the list of currently mounted filesystems */
1795#define bb_path_mtab_file IF_FEATURE_MTAB_SUPPORT("/etc/mtab")IF_NOT_FEATURE_MTAB_SUPPORT("/proc/mounts")
1796
Tito Ragusaad3d72f2011-01-16 23:39:45 +01001797#define bb_path_passwd_file _PATH_PASSWD
1798#define bb_path_group_file _PATH_GROUP
1799#define bb_path_shadow_file _PATH_SHADOW
1800#define bb_path_gshadow_file _PATH_GSHADOW
Denys Vlasenko0004e992010-09-01 12:01:17 +02001801
1802#define bb_path_motd_file "/etc/motd"
1803
1804#define bb_dev_null "/dev/null"
Aurelien Jarnod3a42392012-07-24 16:28:34 +02001805extern const char bb_busybox_exec_path[] ALIGN1;
Denis Vlasenko15611bb2007-06-12 08:52:02 +00001806/* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1807 * but I want to save a few bytes here */
Aurelien Jarnod3a42392012-07-24 16:28:34 +02001808extern const char bb_PATH_root_path[] ALIGN1; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
Denis Vlasenkof5f75c52007-06-12 22:35:19 +00001809#define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1810#define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +00001811
Denis Vlasenko703e2022007-01-22 14:12:08 +00001812extern const int const_int_0;
Denys Vlasenkoc52cbea2015-08-24 19:48:03 +02001813//extern const int const_int_1;
Denis Vlasenko703e2022007-01-22 14:12:08 +00001814
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001815
Denis Vlasenko85818632007-04-19 14:47:11 +00001816/* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
Denis Vlasenko74324c82007-06-04 10:16:52 +00001817enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
1818extern char bb_common_bufsiz1[COMMON_BUFSIZE];
Denis Vlasenko972288e2007-03-15 00:57:01 +00001819/* This struct is deliberately not defined. */
1820/* See docs/keep_data_small.txt */
1821struct globals;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001822/* '*const' ptr makes gcc optimize code much better.
Denis Vlasenkoe3241842007-08-13 10:36:25 +00001823 * Magic prevents ptr_to_globals from going into rodata.
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001824 * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
Denis Vlasenkobff32ce2007-03-15 19:48:35 +00001825extern struct globals *const ptr_to_globals;
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001826/* At least gcc 3.4.6 on mipsel system needs optimization barrier */
Bernhard Reutner-Fischer797c96d2008-06-06 10:31:39 +00001827#define barrier() __asm__ __volatile__("":::"memory")
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001828#define SET_PTR_TO_GLOBALS(x) do { \
Denys Vlasenko90a99042009-09-06 02:36:23 +02001829 (*(struct globals**)&ptr_to_globals) = (void*)(x); \
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001830 barrier(); \
1831} while (0)
Guilherme Maciel Ferreira840ef172013-10-16 14:43:30 +02001832#define FREE_PTR_TO_GLOBALS() do { \
1833 if (ENABLE_FEATURE_CLEAN_UP) { \
1834 free(ptr_to_globals); \
1835 } \
1836} while (0)
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001837
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001838/* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1839 * use bb_default_login_shell and following defines.
1840 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1841 * don't forget to change increment constant. */
Ladislav Michla73b87e2010-06-27 03:23:31 +02001842#define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
Aurelien Jarnod3a42392012-07-24 16:28:34 +02001843extern const char bb_default_login_shell[] ALIGN1;
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001844/* "/bin/sh" */
Ladislav Michla73b87e2010-06-27 03:23:31 +02001845#define DEFAULT_SHELL (bb_default_login_shell+1)
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001846/* "sh" */
Ladislav Michla73b87e2010-06-27 03:23:31 +02001847#define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001848
Jeremie Koenig816ed972010-05-27 15:46:29 +02001849/* The following devices are the same on all systems. */
1850#define CURRENT_TTY "/dev/tty"
1851#define DEV_CONSOLE "/dev/console"
1852
1853#if defined(__FreeBSD_kernel__)
1854# define CURRENT_VC CURRENT_TTY
1855# define VC_1 "/dev/ttyv0"
1856# define VC_2 "/dev/ttyv1"
1857# define VC_3 "/dev/ttyv2"
1858# define VC_4 "/dev/ttyv3"
1859# define VC_5 "/dev/ttyv4"
1860# define VC_FORMAT "/dev/ttyv%d"
1861#elif defined(__GNU__)
1862# define CURRENT_VC CURRENT_TTY
1863# define VC_1 "/dev/tty1"
1864# define VC_2 "/dev/tty2"
1865# define VC_3 "/dev/tty3"
1866# define VC_4 "/dev/tty4"
1867# define VC_5 "/dev/tty5"
1868# define VC_FORMAT "/dev/tty%d"
Denys Vlasenko1c26e052010-10-24 02:35:17 +02001869#elif ENABLE_FEATURE_DEVFS
1870/*Linux, obsolete devfs names */
Matt Kraai439e3df2001-07-23 14:52:08 +00001871# define CURRENT_VC "/dev/vc/0"
1872# define VC_1 "/dev/vc/1"
1873# define VC_2 "/dev/vc/2"
1874# define VC_3 "/dev/vc/3"
1875# define VC_4 "/dev/vc/4"
1876# define VC_5 "/dev/vc/5"
Matt Kraai439e3df2001-07-23 14:52:08 +00001877# define VC_FORMAT "/dev/vc/%d"
Denys Vlasenko4928e9f2013-06-27 03:45:16 +02001878# define LOOP_FORMAT "/dev/loop/%u"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001879# define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001880# define LOOP_NAME "/dev/loop/"
Eric Andersen5f284552003-11-14 03:11:29 +00001881# define FB_0 "/dev/fb/0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001882#else
Denys Vlasenko1c26e052010-10-24 02:35:17 +02001883/*Linux, normal names */
Matt Kraai439e3df2001-07-23 14:52:08 +00001884# define CURRENT_VC "/dev/tty0"
1885# define VC_1 "/dev/tty1"
1886# define VC_2 "/dev/tty2"
1887# define VC_3 "/dev/tty3"
1888# define VC_4 "/dev/tty4"
1889# define VC_5 "/dev/tty5"
Matt Kraai439e3df2001-07-23 14:52:08 +00001890# define VC_FORMAT "/dev/tty%d"
Denys Vlasenko4928e9f2013-06-27 03:45:16 +02001891# define LOOP_FORMAT "/dev/loop%u"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001892# define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001893# define LOOP_NAME "/dev/loop"
Eric Andersen5f284552003-11-14 03:11:29 +00001894# define FB_0 "/dev/fb0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001895#endif
1896
Rob Landleyc57ec372006-04-10 17:07:15 +00001897
Denys Vlasenko9d57a802009-10-23 14:24:44 +02001898#define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
Denys Vlasenkoab3964d2015-10-13 14:50:20 +02001899#define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)]))
Denys Vlasenko9d57a802009-10-23 14:24:44 +02001900
Rob Landleyb623a542006-05-31 22:09:03 +00001901
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001902/* We redefine ctype macros. Unicode-correct handling of char types
1903 * can't be done with such byte-oriented operations anyway,
1904 * we don't lose anything.
1905 */
Rob Landley4ae905a2006-07-06 17:22:54 +00001906#undef isalnum
1907#undef isalpha
1908#undef isascii
1909#undef isblank
1910#undef iscntrl
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001911#undef isdigit
Rob Landley4ae905a2006-07-06 17:22:54 +00001912#undef isgraph
1913#undef islower
1914#undef isprint
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001915#undef ispunct
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001916#undef isspace
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001917#undef isupper
1918#undef isxdigit
1919#undef toupper
1920#undef tolower
Rob Landley4ae905a2006-07-06 17:22:54 +00001921
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001922/* We save ~500 bytes on isdigit alone.
Denys Vlasenko7b4cd6f2009-10-23 02:22:03 +02001923 * BTW, x86 likes (unsigned char) cast more than (unsigned). */
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001924
1925/* These work the same for ASCII and Unicode,
1926 * assuming no one asks "is this a *Unicode* letter?" using isalpha(letter) */
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001927#define isascii(a) ((unsigned char)(a) <= 0x7f)
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001928#define isdigit(a) ((unsigned char)((a) - '0') <= 9)
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001929#define isupper(a) ((unsigned char)((a) - 'A') <= ('Z' - 'A'))
1930#define islower(a) ((unsigned char)((a) - 'a') <= ('z' - 'a'))
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001931#define isalpha(a) ((unsigned char)(((a)|0x20) - 'a') <= ('z' - 'a'))
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001932#define isblank(a) ({ unsigned char bb__isblank = (a); bb__isblank == ' ' || bb__isblank == '\t'; })
1933#define iscntrl(a) ({ unsigned char bb__iscntrl = (a); bb__iscntrl < ' ' || bb__iscntrl == 0x7f; })
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001934/* In POSIX/C locale isspace is only these chars: "\t\n\v\f\r" and space.
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001935 * "\t\n\v\f\r" happen to have ASCII codes 9,10,11,12,13.
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001936 */
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001937#define isspace(a) ({ unsigned char bb__isspace = (a) - 9; bb__isspace == (' ' - 9) || bb__isspace <= (13 - 9); })
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001938// Unsafe wrt NUL: #define ispunct(a) (strchr("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a)) != NULL)
1939#define ispunct(a) (strchrnul("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a))[0])
1940// 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 +02001941#define isalnum(a) bb_ascii_isalnum(a)
1942static ALWAYS_INLINE int bb_ascii_isalnum(unsigned char a)
1943{
1944 unsigned char b = a - '0';
1945 if (b <= 9)
1946 return (b <= 9);
1947 b = (a|0x20) - 'a';
1948 return b <= 'z' - 'a';
1949}
1950#define isxdigit(a) bb_ascii_isxdigit(a)
1951static ALWAYS_INLINE int bb_ascii_isxdigit(unsigned char a)
1952{
1953 unsigned char b = a - '0';
1954 if (b <= 9)
1955 return (b <= 9);
1956 b = (a|0x20) - 'a';
1957 return b <= 'f' - 'a';
1958}
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001959#define toupper(a) bb_ascii_toupper(a)
1960static ALWAYS_INLINE unsigned char bb_ascii_toupper(unsigned char a)
1961{
1962 unsigned char b = a - 'a';
1963 if (b <= ('z' - 'a'))
1964 a -= 'a' - 'A';
1965 return a;
1966}
1967#define tolower(a) bb_ascii_tolower(a)
1968static ALWAYS_INLINE unsigned char bb_ascii_tolower(unsigned char a)
1969{
1970 unsigned char b = a - 'A';
1971 if (b <= ('Z' - 'A'))
1972 a += 'a' - 'A';
1973 return a;
1974}
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001975
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001976/* In ASCII and Unicode, these are likely to be very different.
1977 * Let's prevent ambiguous usage from the start */
1978#define isgraph(a) isgraph_is_ambiguous_dont_use(a)
1979#define isprint(a) isprint_is_ambiguous_dont_use(a)
1980/* NB: must not treat EOF as isgraph or isprint */
1981#define isgraph_asciionly(a) ((unsigned)((a) - 0x21) <= 0x7e - 0x21)
1982#define isprint_asciionly(a) ((unsigned)((a) - 0x20) <= 0x7e - 0x20)
1983
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001984
Bartosz Golaszewski3ed81cf2014-06-22 16:30:41 +02001985/* Simple unit-testing framework */
1986
1987typedef void (*bbunit_testfunc)(void);
1988
1989struct bbunit_listelem {
Bartosz Golaszewski3ed81cf2014-06-22 16:30:41 +02001990 const char* name;
1991 bbunit_testfunc testfunc;
1992};
1993
1994void bbunit_registertest(struct bbunit_listelem* test);
1995void bbunit_settestfailed(void);
1996
1997#define BBUNIT_DEFINE_TEST(NAME) \
1998 static void bbunit_##NAME##_test(void); \
1999 static struct bbunit_listelem bbunit_##NAME##_elem = { \
2000 .name = #NAME, \
2001 .testfunc = bbunit_##NAME##_test, \
2002 }; \
Bartosz Golaszewskibf0f2c72014-06-26 14:31:05 +02002003 static void INIT_FUNC bbunit_##NAME##_register(void) \
Bartosz Golaszewski3ed81cf2014-06-22 16:30:41 +02002004 { \
2005 bbunit_registertest(&bbunit_##NAME##_elem); \
2006 } \
2007 static void bbunit_##NAME##_test(void)
2008
2009/*
2010 * Both 'goto bbunit_end' and 'break' are here only to get rid
2011 * of compiler warnings.
2012 */
2013#define BBUNIT_ENDTEST \
2014 do { \
2015 goto bbunit_end; \
2016 bbunit_end: \
2017 break; \
2018 } while (0)
2019
2020#define BBUNIT_PRINTASSERTFAIL \
2021 do { \
2022 bb_error_msg( \
2023 "[ERROR] Assertion failed in file %s, line %d", \
2024 __FILE__, __LINE__); \
2025 } while (0)
2026
2027#define BBUNIT_ASSERTION_FAILED \
2028 do { \
2029 bbunit_settestfailed(); \
2030 goto bbunit_end; \
2031 } while (0)
2032
2033/*
2034 * Assertions.
2035 * For now we only offer assertions which cause tests to fail
2036 * immediately. In the future 'expects' might be added too -
2037 * similar to those offered by the gtest framework.
2038 */
2039#define BBUNIT_ASSERT_EQ(EXPECTED, ACTUAL) \
2040 do { \
2041 if ((EXPECTED) != (ACTUAL)) { \
2042 BBUNIT_PRINTASSERTFAIL; \
2043 bb_error_msg("[ERROR] '%s' isn't equal to '%s'", \
2044 #EXPECTED, #ACTUAL); \
2045 BBUNIT_ASSERTION_FAILED; \
2046 } \
2047 } while (0)
2048
2049#define BBUNIT_ASSERT_NOTEQ(EXPECTED, ACTUAL) \
2050 do { \
2051 if ((EXPECTED) == (ACTUAL)) { \
2052 BBUNIT_PRINTASSERTFAIL; \
2053 bb_error_msg("[ERROR] '%s' is equal to '%s'", \
2054 #EXPECTED, #ACTUAL); \
2055 BBUNIT_ASSERTION_FAILED; \
2056 } \
2057 } while (0)
2058
2059#define BBUNIT_ASSERT_NOTNULL(PTR) \
2060 do { \
2061 if ((PTR) == NULL) { \
2062 BBUNIT_PRINTASSERTFAIL; \
2063 bb_error_msg("[ERROR] '%s' is NULL!", #PTR); \
2064 BBUNIT_ASSERTION_FAILED; \
2065 } \
2066 } while (0)
2067
2068#define BBUNIT_ASSERT_NULL(PTR) \
2069 do { \
2070 if ((PTR) != NULL) { \
2071 BBUNIT_PRINTASSERTFAIL; \
2072 bb_error_msg("[ERROR] '%s' is not NULL!", #PTR); \
2073 BBUNIT_ASSERTION_FAILED; \
2074 } \
2075 } while (0)
2076
2077#define BBUNIT_ASSERT_FALSE(STATEMENT) \
2078 do { \
2079 if ((STATEMENT)) { \
2080 BBUNIT_PRINTASSERTFAIL; \
2081 bb_error_msg("[ERROR] Statement '%s' evaluated to true!", \
2082 #STATEMENT); \
2083 BBUNIT_ASSERTION_FAILED; \
2084 } \
2085 } while (0)
2086
2087#define BBUNIT_ASSERT_TRUE(STATEMENT) \
2088 do { \
2089 if (!(STATEMENT)) { \
2090 BBUNIT_PRINTASSERTFAIL; \
2091 bb_error_msg("[ERROR] Statement '%s' evaluated to false!", \
2092 #STATEMENT); \
2093 BBUNIT_ASSERTION_FAILED; \
2094 } \
2095 } while (0)
2096
2097#define BBUNIT_ASSERT_STREQ(STR1, STR2) \
2098 do { \
2099 if (strcmp(STR1, STR2) != 0) { \
2100 BBUNIT_PRINTASSERTFAIL; \
2101 bb_error_msg("[ERROR] Strings '%s' and '%s' " \
2102 "are not the same", STR1, STR2); \
2103 BBUNIT_ASSERTION_FAILED; \
2104 } \
2105 } while (0)
2106
2107#define BBUNIT_ASSERT_STRNOTEQ(STR1, STR2) \
2108 do { \
2109 if (strcmp(STR1, STR2) == 0) { \
2110 BBUNIT_PRINTASSERTFAIL; \
2111 bb_error_msg("[ERROR] Strings '%s' and '%s' " \
2112 "are the same, but were " \
2113 "expected to differ", STR1, STR2); \
2114 BBUNIT_ASSERTION_FAILED; \
2115 } \
2116 } while (0)
2117
2118
Denis Vlasenkof81e8db2009-04-09 12:35:13 +00002119POP_SAVED_FUNCTION_VISIBILITY
2120
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +00002121#endif