blob: 26b686805338b3a9f0a7ff08d635f74625bde0ae [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
87# include <utmp.h>
88#endif
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000089#if ENABLE_LOCALE_SUPPORT
Denys Vlasenko9d57a802009-10-23 14:24:44 +020090# include <locale.h>
Rob Landleyeb84a422006-09-20 21:41:13 +000091#else
Denys Vlasenko9d57a802009-10-23 14:24:44 +020092# define setlocale(x,y) ((void)0)
Rob Landleyd921b2e2006-08-03 15:41:12 +000093#endif
Denis Vlasenko98636eb2008-05-09 17:59:34 +000094#ifdef DMALLOC
Denys Vlasenko9d57a802009-10-23 14:24:44 +020095# include <dmalloc.h>
Denis Vlasenkob5a122b2006-12-30 14:46:51 +000096#endif
Tito Ragusaad3d72f2011-01-16 23:39:45 +010097/* Just in case libc doesn't define some of these... */
98#ifndef _PATH_PASSWD
99#define _PATH_PASSWD "/etc/passwd"
100#endif
101#ifndef _PATH_GROUP
102#define _PATH_GROUP "/etc/group"
103#endif
104#ifndef _PATH_SHADOW
105#define _PATH_SHADOW "/etc/shadow"
106#endif
107#ifndef _PATH_GSHADOW
108#define _PATH_GSHADOW "/etc/gshadow"
109#endif
Waldemar Brodkorb95b83ba2010-08-06 09:17:26 +0200110#if defined __FreeBSD__ || defined __OpenBSD__
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +0100111# include <netinet/in.h>
112# include <arpa/inet.h>
113#elif defined __APPLE__
114# include <netinet/in.h>
115#else
116# include <arpa/inet.h>
117# if !defined(__socklen_t_defined) && !defined(_SOCKLEN_T_DECLARED)
118/* We #define socklen_t *after* includes, otherwise we get
119 * typedef redefinition errors from system headers
120 * (in case "is it defined already" detection above failed)
121 */
122# define socklen_t bb_socklen_t
123 typedef unsigned socklen_t;
124# endif
125#endif
Chris Rees330718e2011-01-24 17:07:06 +0100126#ifndef HAVE_CLEARENV
127# define clearenv() do { if (environ) environ[0] = NULL; } while (0)
128#endif
129#ifndef HAVE_FDATASYNC
130# define fdatasync fsync
131#endif
132#ifndef HAVE_XTABS
133# define XTABS TAB3
134#endif
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +0100135
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000136
Denis Vlasenkoaf6cca52008-05-25 04:31:54 +0000137/* Some libc's forget to declare these, do it ourself */
Denis Vlasenko847fa772008-01-28 22:45:43 +0000138
Denis Vlasenkocac0f5b2008-09-25 10:20:46 +0000139extern char **environ;
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000140#if defined(__GLIBC__) && __GLIBC__ < 2
141int vdprintf(int d, const char *format, va_list ap);
Rob Landley362dc2b2006-06-05 17:35:24 +0000142#endif
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000143/* klogctl is in libc's klog.h, but we cheat and not #include that */
144int klogctl(int type, char *b, int len);
Denys Vlasenkobb1dcc92010-02-02 12:45:38 +0100145#ifndef PATH_MAX
146# define PATH_MAX 256
147#endif
148#ifndef BUFSIZ
149# define BUFSIZ 4096
150#endif
Rob Landley362dc2b2006-06-05 17:35:24 +0000151
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000152
Denys Vlasenko0c4cf422011-06-30 02:44:27 +0200153/* Busybox does not use threads, we can speed up stdio. */
Dan Fandrich75214cf2011-06-30 02:59:17 +0200154#ifdef HAVE_UNLOCKED_STDIO
155# undef getc
156# define getc(stream) getc_unlocked(stream)
157# undef getchar
158# define getchar() getchar_unlocked()
159# undef putc
160# define putc(c, stream) putc_unlocked(c, stream)
161# undef putchar
162# define putchar(c) putchar_unlocked(c)
163# undef fgetc
164# define fgetc(stream) getc_unlocked(stream)
165# undef fputc
166# define fputc(c, stream) putc_unlocked(c, stream)
167#endif
Denys Vlasenko0c4cf422011-06-30 02:44:27 +0200168/* Above functions are required by POSIX.1-2008, below ones are extensions */
Dan Fandrich75214cf2011-06-30 02:59:17 +0200169#ifdef HAVE_UNLOCKED_LINE_OPS
170# undef fgets
171# define fgets(s, n, stream) fgets_unlocked(s, n, stream)
172# undef fputs
173# define fputs(s, stream) fputs_unlocked(s, stream)
174#endif
Denys Vlasenko06448912011-06-20 10:06:28 +0200175
176
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000177/* Make all declarations hidden (-fvisibility flag only affects definitions) */
178/* (don't include system headers after this until corresponding pop!) */
Denis Vlasenkof81e8db2009-04-09 12:35:13 +0000179PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
Denis Vlasenko98636eb2008-05-09 17:59:34 +0000180
181
182#if ENABLE_USE_BB_PWD_GRP
183# include "pwd_.h"
184# include "grp_.h"
185#endif
186#if ENABLE_FEATURE_SHADOWPASSWDS
187# if ENABLE_USE_BB_SHADOW
188# include "shadow_.h"
189# endif
190#endif
191
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000192/* Tested to work correctly with all int types (IIRC :]) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000193#define MAXINT(T) (T)( \
194 ((T)-1) > 0 \
195 ? (T)-1 \
196 : (T)~((T)1 << (sizeof(T)*8-1)) \
197 )
198
199#define MININT(T) (T)( \
200 ((T)-1) > 0 \
201 ? (T)0 \
202 : ((T)1 << (sizeof(T)*8-1)) \
203 )
Denis Vlasenko7039a662006-10-08 17:54:47 +0000204
Denis Vlasenko56254152006-10-07 16:24:46 +0000205/* Large file support */
Denis Vlasenko7e3a5f52007-11-16 20:18:54 +0000206/* Note that CONFIG_LFS=y forces bbox to be built with all common ops
Denis Vlasenko7039a662006-10-08 17:54:47 +0000207 * (stat, lseek etc) mapped to "largefile" variants by libc.
208 * Practically it means that open() automatically has O_LARGEFILE added
209 * and all filesize/file_offset parameters and struct members are "large"
210 * (in today's world - signed 64bit). For full support of large files,
211 * we need a few helper #defines (below) and careful use of off_t
212 * instead of int/ssize_t. No lseek64(), O_LARGEFILE etc necessary */
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000213#if ENABLE_LFS
Denis Vlasenko7039a662006-10-08 17:54:47 +0000214/* CONFIG_LFS is on */
215# if ULONG_MAX > 0xffffffff
216/* "long" is long enough on this system */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000217typedef unsigned long uoff_t;
Denys Vlasenkof59a50e2011-11-16 21:30:19 +0100218# define XATOOFF(a) xatoul_range((a), 0, LONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000219/* usage: sz = BB_STRTOOFF(s, NULL, 10); if (errno || sz < 0) die(); */
220# define BB_STRTOOFF bb_strtoul
221# define STRTOOFF strtoul
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000222/* usage: printf("size: %"OFF_FMT"d (%"OFF_FMT"x)\n", sz, sz); */
223# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000224# else
Denis Vlasenkocba9ef52006-10-10 21:00:47 +0000225/* "long" is too short, need "long long" */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000226typedef unsigned long long uoff_t;
Denys Vlasenkof59a50e2011-11-16 21:30:19 +0100227# define XATOOFF(a) xatoull_range((a), 0, LLONG_MAX)
Denis Vlasenkod686a042006-11-27 14:43:21 +0000228# define BB_STRTOOFF bb_strtoull
229# define STRTOOFF strtoull
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000230# define OFF_FMT "ll"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000231# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000232#else
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000233/* CONFIG_LFS is off */
234# if UINT_MAX == 0xffffffff
235/* While sizeof(off_t) == sizeof(int), off_t is typedef'ed to long anyway.
236 * gcc will throw warnings on printf("%d", off_t). Crap... */
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000237typedef unsigned long uoff_t;
Denys Vlasenko77832482010-08-12 14:14:45 +0200238# define XATOOFF(a) xatoi_positive(a)
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000239# define BB_STRTOOFF bb_strtou
Denis Vlasenko7039a662006-10-08 17:54:47 +0000240# define STRTOOFF strtol
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000241# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000242# else
Denis Vlasenko9d04b6b2009-03-28 02:13:01 +0000243typedef unsigned long uoff_t;
Denys Vlasenkof59a50e2011-11-16 21:30:19 +0100244# define XATOOFF(a) xatoul_range((a), 0, LONG_MAX)
Denis Vlasenko5fa71482006-12-12 22:31:15 +0000245# define BB_STRTOOFF bb_strtoul
Denis Vlasenko7039a662006-10-08 17:54:47 +0000246# define STRTOOFF strtol
Denis Vlasenkocf30cc82006-11-24 14:53:18 +0000247# define OFF_FMT "l"
Denis Vlasenko7039a662006-10-08 17:54:47 +0000248# endif
Denis Vlasenko56254152006-10-07 16:24:46 +0000249#endif
250/* scary. better ideas? (but do *test* them first!) */
Denis Vlasenko7039a662006-10-08 17:54:47 +0000251#define OFF_T_MAX ((off_t)~((off_t)1 << (sizeof(off_t)*8-1)))
Denys Vlasenko1dc80ba2011-11-17 21:51:32 +0100252/* Users report bionic to use 32-bit off_t even if LARGEFILE support is requested.
253 * We misdetected that. Don't let it build:
254 */
255struct BUG_off_t_size_is_misdetected {
256 char BUG_off_t_size_is_misdetected[sizeof(off_t) == sizeof(uoff_t) ? 1 : -1];
257};
Denis Vlasenko56254152006-10-07 16:24:46 +0000258
Eric Andersenaad1a882001-03-16 22:47:14 +0000259/* Some useful definitions */
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000260#undef FALSE
Eric Andersenaad1a882001-03-16 22:47:14 +0000261#define FALSE ((int) 0)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000262#undef TRUE
Eric Andersenaad1a882001-03-16 22:47:14 +0000263#define TRUE ((int) 1)
Bernhard Reutner-Fischer781e42d2006-05-26 14:41:40 +0000264#undef SKIP
Eric Andersenaad1a882001-03-16 22:47:14 +0000265#define SKIP ((int) 2)
266
Eric Andersenaad1a882001-03-16 22:47:14 +0000267/* Macros for min/max. */
268#ifndef MIN
Denys Vlasenkoe4dcba12010-10-28 18:57:19 +0200269#define MIN(a,b) (((a)<(b))?(a):(b))
Eric Andersenaad1a882001-03-16 22:47:14 +0000270#endif
271
272#ifndef MAX
Denys Vlasenkoe4dcba12010-10-28 18:57:19 +0200273#define MAX(a,b) (((a)>(b))?(a):(b))
Eric Andersenaad1a882001-03-16 22:47:14 +0000274#endif
275
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000276/* buffer allocation schemes */
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000277#if ENABLE_FEATURE_BUFFERS_GO_ON_STACK
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000278#define RESERVE_CONFIG_BUFFER(buffer,len) char buffer[len]
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000279#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char buffer[len]
280#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
281#else
Denis Vlasenkob5a122b2006-12-30 14:46:51 +0000282#if ENABLE_FEATURE_BUFFERS_GO_IN_BSS
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000283#define RESERVE_CONFIG_BUFFER(buffer,len) static char buffer[len]
284#define RESERVE_CONFIG_UBUFFER(buffer,len) static unsigned char buffer[len]
285#define RELEASE_CONFIG_BUFFER(buffer) ((void)0)
286#else
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000287#define RESERVE_CONFIG_BUFFER(buffer,len) char *buffer = xmalloc(len)
288#define RESERVE_CONFIG_UBUFFER(buffer,len) unsigned char *buffer = xmalloc(len)
289#define RELEASE_CONFIG_BUFFER(buffer) free(buffer)
Bernhard Reutner-Fischer421d9e52006-04-03 16:39:31 +0000290#endif
291#endif
292
Denis Vlasenkofad2b862007-05-31 22:16:38 +0000293#if defined(__GLIBC__)
294/* glibc uses __errno_location() to get a ptr to errno */
295/* We can just memorize it once - no multithreading in busybox :) */
296extern int *const bb_errno;
297#undef errno
298#define errno (*bb_errno)
299#endif
300
Denys Vlasenko9ff50b82010-10-18 11:40:26 +0200301#if !(ULONG_MAX > 0xffffffff)
302/* Only 32-bit CPUs need this, 64-bit ones use inlined version */
303uint64_t bb_bswap_64(uint64_t x) FAST_FUNC;
304#endif
305
Denis Vlasenkoce13b762008-06-29 02:25:53 +0000306unsigned long long monotonic_ns(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000307unsigned long long monotonic_us(void) FAST_FUNC;
Denys Vlasenkof2c8aa62010-01-12 12:52:30 +0100308unsigned long long monotonic_ms(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000309unsigned monotonic_sec(void) FAST_FUNC;
Manuel Novoa III cad53642003-03-19 09:13:01 +0000310
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000311extern void chomp(char *s) FAST_FUNC;
312extern void trim(char *s) FAST_FUNC;
313extern char *skip_whitespace(const char *) FAST_FUNC;
314extern char *skip_non_whitespace(const char *) FAST_FUNC;
Denys Vlasenkof8d8aa12010-04-06 18:50:05 +0200315extern char *skip_dev_pfx(const char *tty_name) FAST_FUNC;
316
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000317extern char *strrstr(const char *haystack, const char *needle) FAST_FUNC;
Paul Fox0b621582005-08-09 19:38:05 +0000318
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +0000319//TODO: supply a pointer to char[11] buffer (avoid statics)?
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000320extern const char *bb_mode_string(mode_t mode) FAST_FUNC;
Denys Vlasenkof282c6b2011-12-18 03:27:46 +0100321extern int is_directory(const char *name, int followLinks) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000322enum { /* DO NOT CHANGE THESE VALUES! cp.c, mv.c, install.c depend on them. */
Denys Vlasenkoa40f0622010-01-15 22:05:07 +0100323 FILEUTILS_PRESERVE_STATUS = 1 << 0, /* -p */
324 FILEUTILS_DEREFERENCE = 1 << 1, /* !-d */
325 FILEUTILS_RECUR = 1 << 2, /* -R */
326 FILEUTILS_FORCE = 1 << 3, /* -f */
327 FILEUTILS_INTERACTIVE = 1 << 4, /* -i */
328 FILEUTILS_MAKE_HARDLINK = 1 << 5, /* -l */
329 FILEUTILS_MAKE_SOFTLINK = 1 << 6, /* -s */
330 FILEUTILS_DEREF_SOFTLINK = 1 << 7, /* -L */
331 FILEUTILS_DEREFERENCE_L0 = 1 << 8, /* -H */
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000332#if ENABLE_SELINUX
Denys Vlasenkoa40f0622010-01-15 22:05:07 +0100333 FILEUTILS_PRESERVE_SECURITY_CONTEXT = 1 << 9, /* -c */
334 FILEUTILS_SET_SECURITY_CONTEXT = 1 << 10,
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000335#endif
Natanael Copa02112d82012-05-22 17:11:46 +0200336 FILEUTILS_IGNORE_CHMOD_ERR = 1 << 11,
Denys Vlasenko17f84182014-05-19 16:23:50 +0200337 /* -v */
338 FILEUTILS_VERBOSE = (1 << 12) * ENABLE_FEATURE_VERBOSE,
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000339};
Denys Vlasenkoa40f0622010-01-15 22:05:07 +0100340#define FILEUTILS_CP_OPTSTR "pdRfilsLH" IF_SELINUX("c")
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000341extern int remove_file(const char *path, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000342/* NB: without FILEUTILS_RECUR in flags, it will basically "cat"
343 * the source, not copy (unless "source" is a directory).
344 * This makes "cp /dev/null file" and "install /dev/null file" (!!!)
345 * work coreutils-compatibly. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000346extern int copy_file(const char *source, const char *dest, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000347
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000348enum {
Denis Vlasenkod166f832007-07-05 00:12:55 +0000349 ACTION_RECURSE = (1 << 0),
350 ACTION_FOLLOWLINKS = (1 << 1),
351 ACTION_FOLLOWLINKS_L0 = (1 << 2),
352 ACTION_DEPTHFIRST = (1 << 3),
353 /*ACTION_REVERSE = (1 << 4), - unused */
Denis Vlasenko6e69e422008-07-27 12:10:07 +0000354 ACTION_QUIET = (1 << 5),
Denys Vlasenko8f7a6d22009-09-29 11:07:04 +0200355 ACTION_DANGLING_OK = (1 << 6),
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000356};
Denys Vlasenko8f7a6d22009-09-29 11:07:04 +0200357typedef uint8_t recurse_flags_t;
Bernhard Reutner-Fischer3e816c12007-03-29 10:30:50 +0000358extern int recursive_action(const char *fileName, unsigned flags,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000359 int FAST_FUNC (*fileAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
360 int FAST_FUNC (*dirAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
361 void* userData, unsigned depth) FAST_FUNC;
362extern int device_open(const char *device, int mode) FAST_FUNC;
Denis Vlasenko85c24712008-03-17 09:04:04 +0000363enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000364extern int xgetpty(char *line) FAST_FUNC;
Denis Vlasenko2afd5ab2008-08-05 23:32:27 +0000365extern int get_console_fd_or_die(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000366extern void console_make_active(int fd, const int vt_num) FAST_FUNC;
367extern char *find_block_device(const char *path) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000368/* bb_copyfd_XX print read/write errors and return -1 if they occur */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000369extern off_t bb_copyfd_eof(int fd1, int fd2) FAST_FUNC;
370extern off_t bb_copyfd_size(int fd1, int fd2, off_t size) FAST_FUNC;
371extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000372/* "short" copy can be detected by return value < size */
373/* this helper yells "short read!" if param is not -1 */
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000374extern void complain_copyfd_and_die(off_t sz) NORETURN FAST_FUNC;
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +0200375
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000376extern char bb_process_escape_sequence(const char **ptr) FAST_FUNC;
Denys Vlasenko53600592010-10-23 21:06:06 +0200377char* strcpy_and_process_escape_sequences(char *dst, const char *src) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000378/* xxxx_strip version can modify its parameter:
379 * "/" -> "/"
380 * "abc" -> "abc"
381 * "abc/def" -> "def"
382 * "abc/def/" -> "def" !!
383 */
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +0200384char *bb_get_last_path_component_strip(char *path) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000385/* "abc/def/" -> "" and it never modifies 'path' */
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +0200386char *bb_get_last_path_component_nostrip(const char *path) FAST_FUNC;
387/* Simpler version: does not special case "/" string */
388const char *bb_basename(const char *name) FAST_FUNC;
389/* NB: can violate const-ness (similarly to strchr) */
390char *last_char_is(const char *s, int c) FAST_FUNC;
Denys Vlasenko1961aea2013-02-26 00:36:53 +0100391const char* endofname(const char *name) FAST_FUNC;
Denys Vlasenko8dff01d2015-03-12 17:48:34 +0100392char *is_prefixed_with(const char *string, const char *key) FAST_FUNC;
Denis Vlasenkocad04ef2007-03-25 23:21:05 +0000393
Denys Vlasenkod6e76722014-09-22 21:14:02 +0200394int ndelay_on(int fd) FAST_FUNC;
395int ndelay_off(int fd) FAST_FUNC;
Denys Vlasenkoe9a40e32011-01-24 00:29:55 +0100396void close_on_exec_on(int fd) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000397void xdup2(int, int) FAST_FUNC;
398void xmove_fd(int, int) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000399
400
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000401DIR *xopendir(const char *path) FAST_FUNC;
402DIR *warn_opendir(const char *path) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000403
Jérémie Koenigfbedacf2010-03-26 19:08:53 +0100404char *xmalloc_realpath(const char *path) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100405char *xmalloc_readlink(const char *path) FAST_FUNC RETURNS_MALLOC;
406char *xmalloc_readlink_or_warn(const char *path) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkob57eee82009-11-04 17:54:17 +0100407/* !RETURNS_MALLOC: it's a realloc-like function */
408char *xrealloc_getcwd_or_warn(char *cwd) FAST_FUNC;
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000409
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100410char *xmalloc_follow_symlinks(const char *path) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko473dae02007-04-11 07:04:23 +0000411
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000412
Denis Vlasenko33196372008-02-23 01:25:38 +0000413enum {
Denis Vlasenkocf7cf622008-03-19 19:38:46 +0000414 /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
Denis Vlasenko33196372008-02-23 01:25:38 +0000415 * otherwise would kill us, except for those resulting from bugs:
416 * SIGSEGV, SIGILL, SIGFPE.
417 * Other fatal signals not included (TODO?):
418 * SIGBUS Bus error (bad memory access)
419 * SIGPOLL Pollable event. Synonym of SIGIO
420 * SIGPROF Profiling timer expired
421 * SIGSYS Bad argument to routine
422 * SIGTRAP Trace/breakpoint trap
Denis Vlasenkod943af02008-03-30 15:56:38 +0000423 *
424 * The only known arch with some of these sigs not fitting
425 * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
426 * Dance around with long long to guard against that...
Denis Vlasenko33196372008-02-23 01:25:38 +0000427 */
Denis Vlasenkod943af02008-03-30 15:56:38 +0000428 BB_FATAL_SIGS = (int)(0
429 + (1LL << SIGHUP)
430 + (1LL << SIGINT)
431 + (1LL << SIGTERM)
432 + (1LL << SIGPIPE) // Write to pipe with no readers
433 + (1LL << SIGQUIT) // Quit from keyboard
434 + (1LL << SIGABRT) // Abort signal from abort(3)
435 + (1LL << SIGALRM) // Timer signal from alarm(2)
436 + (1LL << SIGVTALRM) // Virtual alarm clock
437 + (1LL << SIGXCPU) // CPU time limit exceeded
438 + (1LL << SIGXFSZ) // File size limit exceeded
439 + (1LL << SIGUSR1) // Yes kids, these are also fatal!
440 + (1LL << SIGUSR2)
441 + 0),
Denis Vlasenko33196372008-02-23 01:25:38 +0000442};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000443void bb_signals(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko25591c32008-02-16 22:58:56 +0000444/* Unlike signal() and bb_signals, sets handler with sigaction()
445 * and in a way that while signal handler is run, no other signals
Denis Vlasenkocab28aa2009-01-31 01:02:07 +0000446 * will be blocked; syscalls will not be restarted: */
447void bb_signals_recursive_norestart(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000448/* syscalls like read() will be interrupted with EINTR: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000449void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000450/* syscalls like read() won't be interrupted (though select/poll will be): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000451void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
452void wait_for_any_sig(void) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000453void kill_myself_with_sig(int sig) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000454void sig_block(int sig) FAST_FUNC;
455void sig_unblock(int sig) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000456/* Will do sigaction(signum, act, NULL): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000457int sigaction_set(int sig, const struct sigaction *act) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000458/* SIG_BLOCK/SIG_UNBLOCK all signals: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000459int sigprocmask_allsigs(int how) FAST_FUNC;
Denis Vlasenko08ea11a2008-09-11 19:51:11 +0000460/* Standard handler which just records signo */
461extern smallint bb_got_signal;
462void record_signo(int signo); /* not FAST_FUNC! */
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000463
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000464
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000465void xsetgid(gid_t gid) FAST_FUNC;
466void xsetuid(uid_t uid) FAST_FUNC;
Ryan Mallon5906a5c2013-10-08 14:52:49 +0200467void xsetegid(gid_t egid) FAST_FUNC;
468void xseteuid(uid_t euid) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000469void xchdir(const char *path) FAST_FUNC;
470void xchroot(const char *path) FAST_FUNC;
471void xsetenv(const char *key, const char *value) FAST_FUNC;
Denis Vlasenko76ddc2e2008-12-30 05:05:31 +0000472void bb_unsetenv(const char *key) FAST_FUNC;
Denys Vlasenkodd8adde2010-06-24 05:00:50 +0200473void bb_unsetenv_and_free(char *key) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000474void xunlink(const char *pathname) FAST_FUNC;
475void xstat(const char *pathname, struct stat *buf) FAST_FUNC;
Denys Vlasenko8d3e2252010-08-31 12:42:06 +0200476void xfstat(int fd, struct stat *buf, const char *errmsg) FAST_FUNC;
Ryan Mallon5906a5c2013-10-08 14:52:49 +0200477int open3_or_warn(const char *pathname, int flags, int mode) FAST_FUNC;
478int open_or_warn(const char *pathname, int flags) FAST_FUNC;
479int xopen3(const char *pathname, int flags, int mode) FAST_FUNC;
Denys Vlasenkof2a8d5d2009-08-21 17:40:36 +0200480int xopen(const char *pathname, int flags) FAST_FUNC;
Bernhard Reutner-Fischera4830872009-10-26 23:27:08 +0100481int xopen_nonblocking(const char *pathname) FAST_FUNC;
Ryan Mallon5906a5c2013-10-08 14:52:49 +0200482int xopen_as_uid_gid(const char *pathname, int flags, uid_t u, gid_t g) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000483int open_or_warn_stdin(const char *pathname) FAST_FUNC;
Denys Vlasenkoe7b0a9e2010-08-22 05:39:15 +0200484int xopen_stdin(const char *pathname) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000485void xrename(const char *oldpath, const char *newpath) FAST_FUNC;
486int rename_or_warn(const char *oldpath, const char *newpath) FAST_FUNC;
487off_t xlseek(int fd, off_t offset, int whence) FAST_FUNC;
Alexander Shishkin67227372010-10-22 13:27:16 +0200488int xmkstemp(char *template) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000489off_t fdlength(int fd) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000490
Denys Vlasenko40e7d252010-02-01 23:48:27 +0100491uoff_t FAST_FUNC get_volume_size_in_bytes(int fd,
Denys Vlasenko982e87f2013-07-30 11:52:58 +0200492 const char *override,
493 unsigned override_units,
494 int extend);
Denys Vlasenko40e7d252010-02-01 23:48:27 +0100495
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000496void xpipe(int filedes[2]) FAST_FUNC;
Denis Vlasenko37188322008-02-16 13:20:56 +0000497/* In this form code with pipes is much more readable */
498struct fd_pair { int rd; int wr; };
499#define piped_pair(pair) pipe(&((pair).rd))
500#define xpiped_pair(pair) xpipe(&((pair).rd))
501
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000502/* Useful for having small structure members/global variables */
503typedef int8_t socktype_t;
504typedef int8_t family_t;
505struct BUG_too_small {
506 char BUG_socktype_t_too_small[(0
507 | SOCK_STREAM
508 | SOCK_DGRAM
509 | SOCK_RDM
510 | SOCK_SEQPACKET
511 | SOCK_RAW
512 ) <= 127 ? 1 : -1];
513 char BUG_family_t_too_small[(0
514 | AF_UNSPEC
515 | AF_INET
516 | AF_INET6
517 | AF_UNIX
Mike Frysinger9412ec72008-02-07 22:41:33 +0000518#ifdef AF_PACKET
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000519 | AF_PACKET
Mike Frysinger9412ec72008-02-07 22:41:33 +0000520#endif
521#ifdef AF_NETLINK
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000522 | AF_NETLINK
Mike Frysinger9412ec72008-02-07 22:41:33 +0000523#endif
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000524 /* | AF_DECnet */
525 /* | AF_IPX */
526 ) <= 127 ? 1 : -1];
527};
528
529
Denys Vlasenkodc698bb2010-01-09 19:10:49 +0100530void parse_datestr(const char *date_str, struct tm *ptm) FAST_FUNC;
531time_t validate_tm_time(const char *date_str, struct tm *ptm) FAST_FUNC;
Denys Vlasenko8f2cb7a2013-03-29 12:30:33 +0100532char *strftime_HHMMSS(char *buf, unsigned len, time_t *tp) FAST_FUNC;
533char *strftime_YYYYMMDDHHMMSS(char *buf, unsigned len, time_t *tp) FAST_FUNC;
Denys Vlasenko73b71f32009-07-18 03:40:35 +0200534
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000535int xsocket(int domain, int type, int protocol) FAST_FUNC;
536void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen) FAST_FUNC;
537void xlisten(int s, int backlog) FAST_FUNC;
538void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen) FAST_FUNC;
Denis Vlasenkodbe6e662007-08-14 16:43:01 +0000539ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000540 socklen_t tolen) FAST_FUNC;
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000541/* SO_REUSEADDR allows a server to rebind to an address that is already
542 * "in use" by old connections to e.g. previous server instance which is
543 * killed or crashed. Without it bind will fail until all such connections
544 * time out. Linux does not allow multiple live binds on same ip:port
545 * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
546 * Turn it on before you call bind(). */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000547void setsockopt_reuseaddr(int fd) FAST_FUNC; /* On Linux this never fails. */
548int setsockopt_broadcast(int fd) FAST_FUNC;
Denis Vlasenkoe5373852008-12-10 11:12:16 +0000549int setsockopt_bindtodevice(int fd, const char *iface) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000550/* NB: returns port in host byte order */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000551unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port) FAST_FUNC;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000552typedef struct len_and_sockaddr {
Denis Vlasenko0850cda2007-02-07 23:20:32 +0000553 socklen_t len;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000554 union {
555 struct sockaddr sa;
556 struct sockaddr_in sin;
557#if ENABLE_FEATURE_IPV6
558 struct sockaddr_in6 sin6;
559#endif
Bernhard Reutner-Fischer8c69afd2008-01-29 10:33:34 +0000560 } u;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000561} len_and_sockaddr;
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000562enum {
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000563 LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000564 LSA_SIZEOF_SA = sizeof(
565 union {
566 struct sockaddr sa;
567 struct sockaddr_in sin;
568#if ENABLE_FEATURE_IPV6
569 struct sockaddr_in6 sin6;
570#endif
571 }
572 )
573};
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000574/* Create stream socket, and allocate suitable lsa.
575 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
Denis Vlasenkobeffd432007-09-05 11:30:34 +0000576 * af == AF_UNSPEC will result in trying to create IPv6 socket,
Denys Vlasenkob1278a32009-11-24 16:03:47 +0100577 * and if kernel doesn't support it, fall back to IPv4.
578 * This is useful if you plan to bind to resulting local lsa.
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000579 */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000580int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000581int xsocket_stream(len_and_sockaddr **lsap) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000582/* Create server socket bound to bindaddr:port. bindaddr can be NULL,
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000583 * numeric IP ("N.N.N.N") or numeric IPv6 address,
584 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000585 * Only if there is no suffix, port argument is used */
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000586/* NB: these set SO_REUSEADDR before bind */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000587int create_and_bind_stream_or_die(const char *bindaddr, int port) FAST_FUNC;
588int create_and_bind_dgram_or_die(const char *bindaddr, int port) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000589/* Create client TCP socket connected to peer:port. Peer cannot be NULL.
590 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
591 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
592 * If there is no suffix, port argument is used */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000593int create_and_connect_stream_or_die(const char *peer, int port) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000594/* Connect to peer identified by lsa */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000595int xconnect_stream(const len_and_sockaddr *lsa) FAST_FUNC;
Denis Vlasenko73c571a2009-03-09 00:12:37 +0000596/* Get local address of bound or accepted socket */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100597len_and_sockaddr *get_sock_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkof6916db2010-04-06 17:43:29 +0200598/* Get remote address of connected or accepted socket */
599len_and_sockaddr *get_peer_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000600/* Return malloc'ed len_and_sockaddr with socket address of host:port
601 * Currently will return IPv4 or IPv6 sockaddrs only
602 * (depending on host), but in theory nothing prevents e.g.
Denis Vlasenko5870ad92007-02-04 02:39:55 +0000603 * UNIX socket address being returned, IPX sockaddr etc...
604 * On error does bb_error_msg and returns NULL */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100605len_and_sockaddr* host2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000606/* Version which dies on error */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100607len_and_sockaddr* xhost2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
608len_and_sockaddr* xdotted2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000609/* Same, useful if you want to force family (e.g. IPv6) */
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000610#if !ENABLE_FEATURE_IPV6
611#define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
612#define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
613#else
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100614len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
615len_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 +0000616#endif
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000617/* Assign sin[6]_port member if the socket is an AF_INET[6] one,
Denis Vlasenko85629f02007-01-22 09:36:41 +0000618 * otherwise no-op. Useful for ftp.
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000619 * NB: does NOT do htons() internally, just direct assignment. */
Denys Vlasenkoca183112011-04-07 17:52:20 +0200620void set_nport(struct sockaddr *sa, unsigned port) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000621/* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000622int get_nport(const struct sockaddr *sa) FAST_FUNC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000623/* Reverse DNS. Returns NULL on failure. */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100624char* xmalloc_sockaddr2host(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000625/* This one doesn't append :PORTNUM */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100626char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000627/* This one also doesn't fall back to dotted IP (returns NULL) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100628char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko448f0242007-01-22 22:43:05 +0000629/* inet_[ap]ton on steroids */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100630char* xmalloc_sockaddr2dotted(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
631char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000632// "old" (ipv4 only) API
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000633// users: traceroute.c hostname.c - use _list_ of all IPs
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000634struct hostent *xgethostbyname(const char *name) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000635// Also mount.c and inetd.c are using gethostbyname(),
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000636// + inet_common.c has additional IPv4-only stuff
Denis Vlasenkoc8717cd2006-11-22 16:10:39 +0000637
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000638
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000639void socket_want_pktinfo(int fd) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000640ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000641 const struct sockaddr *to,
642 const struct sockaddr *from,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000643 socklen_t tolen) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000644ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000645 struct sockaddr *from,
646 struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000647 socklen_t sa_size) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000648
Baruch Siache8f36332011-09-07 17:52:37 +0200649uint16_t inet_cksum(uint16_t *addr, int len) FAST_FUNC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100650
651char *xstrdup(const char *s) FAST_FUNC RETURNS_MALLOC;
652char *xstrndup(const char *s, int n) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko0f293b92008-07-22 20:16:55 +0000653void overlapping_strcpy(char *dst, const char *src) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000654char *safe_strncpy(char *dst, const char *src, size_t size) FAST_FUNC;
Denis Vlasenko360d9662008-12-02 18:18:50 +0000655char *strncpy_IFNAMSIZ(char *dst, const char *src) FAST_FUNC;
Denys Vlasenko6f068902014-02-27 11:17:06 +0100656unsigned count_strstr(const char *str, const char *sub) FAST_FUNC;
657char *xmalloc_substitute_string(const char *src, int count, const char *sub, const char *repl) FAST_FUNC;
Denis Vlasenko4daad902007-09-27 10:20:47 +0000658/* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
Denis Vlasenko7c654ae2007-09-27 10:26:59 +0000659 * But potentially slow, don't use in one-billion-times loops */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000660int bb_putchar(int ch) FAST_FUNC;
Denys Vlasenko19ced5c2010-06-06 21:53:09 +0200661/* Note: does not use stdio, writes to fd 2 directly */
662int bb_putchar_stderr(char ch) FAST_FUNC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100663char *xasprintf(const char *format, ...) __attribute__ ((format(printf, 1, 2))) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9f739442006-12-16 23:49:13 +0000664// gcc-4.1.1 still isn't good enough at optimizing it
665// (+200 bytes compared to macro)
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000666//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000667//int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000668//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000669//int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000670#define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
Denis Vlasenko9f739442006-12-16 23:49:13 +0000671#define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000672#define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
Denis Vlasenkobf66fbc2006-12-21 13:23:14 +0000673#define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
Denis Vlasenko16abcd92007-04-13 23:59:52 +0000674#define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000675
Denys Vlasenkod8528b82010-01-31 05:15:38 +0100676typedef struct uni_stat_t {
677 unsigned byte_count;
678 unsigned unicode_count;
679 unsigned unicode_width;
680} uni_stat_t;
681/* Returns a string with unprintable chars replaced by '?' or
682 * SUBST_WCHAR. This function is unicode-aware. */
683const char* FAST_FUNC printable_string(uni_stat_t *stats, const char *str);
684/* Prints unprintable char ch as ^C or M-c to file
685 * (M-c is used only if ch is ORed with PRINTABLE_META),
686 * else it is printed as-is (except for ch = 0x9b) */
687enum { PRINTABLE_META = 0x100 };
688void fputc_printable(int ch, FILE *file) FAST_FUNC;
Bartosz Golaszewski79c618c2013-07-30 06:29:42 +0200689/* Return a string that is the printable representation of character ch.
690 * Buffer must hold at least four characters. */
Denys Vlasenkobfa6ed12013-07-30 11:41:58 +0200691enum {
692 VISIBLE_ENDLINE = 1 << 0,
693 VISIBLE_SHOW_TABS = 1 << 1,
694};
Bartosz Golaszewski79c618c2013-07-30 06:29:42 +0200695void visible(unsigned ch, char *buf, int flags) FAST_FUNC;
Denys Vlasenkod8528b82010-01-31 05:15:38 +0100696
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000697/* dmalloc will redefine these to it's own implementation. It is safe
698 * to have the prototypes here unconditionally. */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100699void *malloc_or_warn(size_t size) FAST_FUNC RETURNS_MALLOC;
700void *xmalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
701void *xzalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkodeeed592008-07-08 05:14:36 +0000702void *xrealloc(void *old, size_t size) FAST_FUNC;
Denys Vlasenko16714242011-09-21 01:59:15 +0200703/* After v = xrealloc_vector(v, SHIFT, idx) it's ok to use
Denis Vlasenko27842282008-08-04 13:20:36 +0000704 * at least v[idx] and v[idx+1], for all idx values.
Denys Vlasenko16714242011-09-21 01:59:15 +0200705 * SHIFT specifies how many new elements are added (1:2, 2:4, ..., 8:256...)
706 * when all elements are used up. New elements are zeroed out.
707 * xrealloc_vector(v, SHIFT, idx) *MUST* be called with consecutive IDXs -
708 * skipping an index is a bad bug - it may miss a realloc!
709 */
Denis Vlasenkodeeed592008-07-08 05:14:36 +0000710#define xrealloc_vector(vector, shift, idx) \
711 xrealloc_vector_helper((vector), (sizeof((vector)[0]) << 8) + (shift), (idx))
712void* xrealloc_vector_helper(void *vector, unsigned sizeof_and_shift, int idx) FAST_FUNC;
713
Eric Andersenaad1a882001-03-16 22:47:14 +0000714
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000715extern ssize_t safe_read(int fd, void *buf, size_t count) FAST_FUNC;
Denys Vlasenko80542ba2011-05-08 21:23:43 +0200716extern ssize_t nonblock_immune_read(int fd, void *buf, size_t count, int loop_on_EINTR) FAST_FUNC;
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000717// NB: will return short read on error, not -1,
718// if some data was read before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000719extern ssize_t full_read(int fd, void *buf, size_t count) FAST_FUNC;
720extern void xread(int fd, void *buf, size_t count) FAST_FUNC;
721extern unsigned char xread_char(int fd) FAST_FUNC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000722extern ssize_t read_close(int fd, void *buf, size_t maxsz) FAST_FUNC;
723extern ssize_t open_read_close(const char *filename, void *buf, size_t maxsz) FAST_FUNC;
Denis Vlasenko8ee649a2008-03-26 20:04:27 +0000724// Reads one line a-la fgets (but doesn't save terminating '\n').
725// Reads byte-by-byte. Useful when it is important to not read ahead.
Denis Vlasenkoe376d452008-02-20 22:23:24 +0000726// Bytes are appended to pfx (which must be malloced, or NULL).
Denys Vlasenko80c5b682011-05-08 21:21:10 +0200727extern char *xmalloc_reads(int fd, size_t *maxsz_p) FAST_FUNC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000728/* Reads block up to *maxsz_p (default: INT_MAX - 4095) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100729extern void *xmalloc_read(int fd, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000730/* Returns NULL if file can't be opened (default max size: INT_MAX - 4095) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100731extern void *xmalloc_open_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko094cc512011-01-17 14:58:27 +0100732/* Never returns NULL */
733extern void *xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko59655072012-03-06 16:23:50 +0100734
Denys Vlasenko04c14172014-11-26 15:17:59 +0100735#if defined(ARG_MAX) && (ARG_MAX >= 60*1024 || !defined(_SC_ARG_MAX))
736/* Use _constant_ maximum if: defined && (big enough || no variable one exists) */
Denys Vlasenkof92f1d02014-06-22 13:54:40 +0200737# define bb_arg_max() ((unsigned)ARG_MAX)
Denys Vlasenko04c14172014-11-26 15:17:59 +0100738#elif defined(_SC_ARG_MAX)
739/* Else use variable one (a bit more expensive) */
Denys Vlasenkof92f1d02014-06-22 13:54:40 +0200740unsigned bb_arg_max(void) FAST_FUNC;
741#else
Denys Vlasenko04c14172014-11-26 15:17:59 +0100742/* If all else fails */
Denys Vlasenkof92f1d02014-06-22 13:54:40 +0200743# define bb_arg_max() ((unsigned)(32 * 1024))
744#endif
Bartosz Golaszewski5d2e4092014-06-22 14:01:13 +0200745unsigned bb_clk_tck(void) FAST_FUNC;
Denys Vlasenkof92f1d02014-06-22 13:54:40 +0200746
Denys Vlasenko59655072012-03-06 16:23:50 +0100747#define SEAMLESS_COMPRESSION (0 \
748 || ENABLE_FEATURE_SEAMLESS_XZ \
749 || ENABLE_FEATURE_SEAMLESS_LZMA \
750 || ENABLE_FEATURE_SEAMLESS_BZ2 \
751 || ENABLE_FEATURE_SEAMLESS_GZ \
752 || ENABLE_FEATURE_SEAMLESS_Z)
753
Denys Vlasenko8a6a2f92012-03-06 16:27:48 +0100754#if SEAMLESS_COMPRESSION
Denys Vlasenko27653ad2010-05-06 14:19:19 +0000755/* Autodetects gzip/bzip2 formats. fd may be in the middle of the file! */
Denys Vlasenko640ce3d2014-02-02 02:06:38 +0100756extern int setup_unzip_on_fd(int fd, int fail_if_not_compressed) FAST_FUNC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000757/* Autodetects .gz etc */
Denys Vlasenko640ce3d2014-02-02 02:06:38 +0100758extern int open_zipped(const char *fname, int fail_if_not_compressed) FAST_FUNC;
Denys Vlasenkob4c11c12014-12-07 00:44:00 +0100759extern void *xmalloc_open_zipped_read_close(const char *fname, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko8a6a2f92012-03-06 16:27:48 +0100760#else
761# define setup_unzip_on_fd(...) (0)
Denys Vlasenko640ce3d2014-02-02 02:06:38 +0100762# define open_zipped(fname, fail_if_not_compressed) open((fname), O_RDONLY);
Denys Vlasenkob4c11c12014-12-07 00:44:00 +0100763# define xmalloc_open_zipped_read_close(fname, maxsz_p) xmalloc_open_read_close((fname), (maxsz_p))
Denys Vlasenko8a6a2f92012-03-06 16:27:48 +0100764#endif
Denis Vlasenkoea620772006-10-14 02:23:43 +0000765
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000766extern ssize_t safe_write(int fd, const void *buf, size_t count) FAST_FUNC;
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000767// NB: will return short write on error, not -1,
768// if some data was written before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000769extern ssize_t full_write(int fd, const void *buf, size_t count) FAST_FUNC;
770extern void xwrite(int fd, const void *buf, size_t count) FAST_FUNC;
Denis Vlasenko73c571a2009-03-09 00:12:37 +0000771extern void xwrite_str(int fd, const char *str) FAST_FUNC;
Denys Vlasenko729ecb82010-06-07 14:14:26 +0200772extern ssize_t full_write1_str(const char *str) FAST_FUNC;
773extern ssize_t full_write2_str(const char *str) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000774extern void xopen_xwrite_close(const char* file, const char *str) FAST_FUNC;
Denis Vlasenkoea620772006-10-14 02:23:43 +0000775
Denys Vlasenkodcd27ab2009-10-05 03:03:07 +0200776/* Close fd, but check for failures (some types of write errors) */
777extern void xclose(int fd) FAST_FUNC;
778
Denis Vlasenko1de08302006-10-26 23:32:43 +0000779/* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000780extern void xprint_and_close_file(FILE *file) FAST_FUNC;
Denis Vlasenko2132e022008-07-15 10:33:12 +0000781
Denys Vlasenkoa1a44832011-06-17 03:37:43 +0200782/* Reads a line from a text file, up to a newline or NUL byte, inclusive.
783 * Returns malloc'ed char*. If end is NULL '\n' isn't considered
784 * end of line. If end isn't NULL, length of the chunk is stored in it.
785 * Returns NULL if EOF/error.
786 */
Denis Vlasenko2132e022008-07-15 10:33:12 +0000787extern char *bb_get_chunk_from_file(FILE *file, int *end) FAST_FUNC;
Denis Vlasenkoabee3d02007-12-26 20:44:45 +0000788/* Reads up to (and including) TERMINATING_STRING: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100789extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000790/* Same, with limited max size, and returns the length (excluding NUL): */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100791extern 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 +0000792/* Chops off TERMINATING_STRING from the end: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100793extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000794/* Reads up to (and including) "\n" or NUL byte: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100795extern char *xmalloc_fgets(FILE *file) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000796/* Chops off '\n' from the end, unlike fgets: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100797extern char *xmalloc_fgetline(FILE *file) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko2132e022008-07-15 10:33:12 +0000798/* Same, but doesn't try to conserve space (may have some slack after the end) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100799/* extern char *xmalloc_fgetline_fast(FILE *file) FAST_FUNC RETURNS_MALLOC; */
Denis Vlasenko2132e022008-07-15 10:33:12 +0000800
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100801void die_if_ferror(FILE *file, const char *msg) FAST_FUNC;
802void die_if_ferror_stdout(void) FAST_FUNC;
803int fflush_all(void) FAST_FUNC;
804void fflush_stdout_and_exit(int retval) NORETURN FAST_FUNC;
805int fclose_if_not_stdin(FILE *file) FAST_FUNC;
806FILE* xfopen(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000807/* Prints warning to stderr and returns NULL on failure: */
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100808FILE* fopen_or_warn(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000809/* "Opens" stdin if filename is special, else just opens file: */
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100810FILE* xfopen_stdin(const char *filename) FAST_FUNC;
811FILE* fopen_or_warn_stdin(const char *filename) FAST_FUNC;
812FILE* fopen_for_read(const char *path) FAST_FUNC;
813FILE* xfopen_for_read(const char *path) FAST_FUNC;
814FILE* fopen_for_write(const char *path) FAST_FUNC;
815FILE* xfopen_for_write(const char *path) FAST_FUNC;
816FILE* xfdopen_for_read(int fd) FAST_FUNC;
817FILE* xfdopen_for_write(int fd) FAST_FUNC;
Eric Andersen8876fb22003-06-20 09:01:58 +0000818
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000819int bb_pstrcmp(const void *a, const void *b) /* not FAST_FUNC! */;
820void qsort_string_vector(char **sv, unsigned count) FAST_FUNC;
Denis Vlasenkofb290382008-03-02 12:51:26 +0000821
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000822/* Wrapper which restarts poll on EINTR or ENOMEM.
823 * On other errors complains [perror("poll")] and returns.
824 * Warning! May take (much) longer than timeout_ms to return!
825 * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000826int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms) FAST_FUNC;
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000827
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000828char *safe_gethostname(void) FAST_FUNC;
Denis Vlasenko6f1713f2008-02-25 23:23:58 +0000829
Bernhard Reutner-Fischer8b1fab22007-04-10 09:38:07 +0000830/* Convert each alpha char in str to lower-case */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000831char* str_tolower(char *str) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000832
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000833char *utoa(unsigned n) FAST_FUNC;
834char *itoa(int n) FAST_FUNC;
Denis Vlasenko10457b92007-03-27 22:01:31 +0000835/* Returns a pointer past the formatted number, does NOT null-terminate */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000836char *utoa_to_buf(unsigned n, char *buf, unsigned buflen) FAST_FUNC;
837char *itoa_to_buf(int n, char *buf, unsigned buflen) FAST_FUNC;
Denis Vlasenko56ea65c2008-01-06 03:26:53 +0000838/* Intelligent formatters of bignums */
Denys Vlasenkoa407cf72013-09-06 12:53:14 +0200839char *smart_ulltoa4(unsigned long long ul, char buf[4], const char *scale) FAST_FUNC;
840char *smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
Denys Vlasenko0bf44d02009-10-13 01:25:09 +0200841/* If block_size == 0, display size without fractional part,
842 * else display (size * block_size) with one decimal digit.
Denys Vlasenko9c3b84a2010-01-18 01:55:00 +0100843 * If display_unit == 0, show value no bigger than 1024 with suffix (K,M,G...),
Denys Vlasenko0bf44d02009-10-13 01:25:09 +0200844 * else divide by display_unit and do not use suffix. */
Denys Vlasenko9c3b84a2010-01-18 01:55:00 +0100845#define HUMAN_READABLE_MAX_WIDTH 7 /* "1024.0G" */
846#define HUMAN_READABLE_MAX_WIDTH_STR "7"
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000847//TODO: provide pointer to buf (avoid statics)?
848const char *make_human_readable_str(unsigned long long size,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000849 unsigned long block_size, unsigned long display_unit) FAST_FUNC;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000850/* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
Denys Vlasenko1f56e512011-10-19 22:40:35 +0200851char *bin2hex(char *dst, const char *src, int count) FAST_FUNC;
Denys Vlasenko48363312010-04-04 15:29:32 +0200852/* Reverse */
Denys Vlasenko1f56e512011-10-19 22:40:35 +0200853char* hex2bin(char *dst, const char *src, int count) FAST_FUNC;
Rob Landleyc5b1d4d2006-03-13 15:45:16 +0000854
Vladimir Dronnikovdb67a202009-10-15 09:24:25 +0200855/* Generate a UUID */
856void generate_uuid(uint8_t *buf) FAST_FUNC;
857
Denis Vlasenko1bab1de2007-07-27 15:30:39 +0000858/* Last element is marked by mult == 0 */
Eric Andersenaad1a882001-03-16 22:47:14 +0000859struct suffix_mult {
Denis Vlasenkof8689632007-07-27 15:06:25 +0000860 char suffix[4];
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000861 unsigned mult;
Eric Andersenaad1a882001-03-16 22:47:14 +0000862};
Denys Vlasenkoc72b43c2013-07-13 23:49:45 +0200863extern const struct suffix_mult bkm_suffixes[];
864#define km_suffixes (bkm_suffixes + 1)
Ari Sundholm88930232015-03-04 18:46:48 +0200865extern const struct suffix_mult cwbkMG_suffixes[];
Ari Sundholm911db162015-03-22 17:55:38 +0100866#define kMG_suffixes (cwbkMG_suffixes + 3)
Denys Vlasenkoc72b43c2013-07-13 23:49:45 +0200867
Denis Vlasenkoed836cd2006-11-25 14:44:13 +0000868#include "xatonum.h"
Denis Vlasenko13858992006-10-08 12:49:22 +0000869/* Specialized: */
Denys Vlasenko77832482010-08-12 14:14:45 +0200870
Denis Vlasenko13858992006-10-08 12:49:22 +0000871/* Using xatoi() instead of naive atoi() is not always convenient -
872 * in many places people want *non-negative* values, but store them
873 * in signed int. Therefore we need this one:
Denys Vlasenko77832482010-08-12 14:14:45 +0200874 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc.
875 * It should really be named xatoi_nonnegative (since it allows 0),
876 * but that would be too long.
877 */
878int xatoi_positive(const char *numstr) FAST_FUNC;
879
Denis Vlasenko13858992006-10-08 12:49:22 +0000880/* Useful for reading port numbers */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000881uint16_t xatou16(const char *numstr) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +0000882
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000883
Eric Andersenaad1a882001-03-16 22:47:14 +0000884/* These parse entries in /etc/passwd and /etc/group. This is desirable
885 * for BusyBox since we want to avoid using the glibc NSS stuff, which
Bernhard Reutner-Fischerd5bd1372005-09-20 21:06:17 +0000886 * increases target size and is often not needed on embedded systems. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000887long xuname2uid(const char *name) FAST_FUNC;
888long xgroup2gid(const char *name) FAST_FUNC;
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000889/* wrapper: allows string to contain numeric uid or gid */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000890unsigned long get_ug_id(const char *s, long FAST_FUNC (*xname2id)(const char *)) FAST_FUNC;
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000891/* from chpst. Does not die, returns 0 on failure */
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000892struct bb_uidgid_t {
Denis Vlasenko150f4022007-01-13 21:06:21 +0000893 uid_t uid;
894 gid_t gid;
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000895};
Denis Vlasenkocce38582007-02-26 22:47:42 +0000896/* always sets uid and gid */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000897int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok) FAST_FUNC;
Bernhard Reutner-Fischerd73cbd32008-07-21 14:41:33 +0000898/* always sets uid and gid, allows numeric; exits on failure */
899void xget_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
Denis Vlasenkocce38582007-02-26 22:47:42 +0000900/* chown-like handling of "user[:[group]" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000901void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group) FAST_FUNC;
Denis Vlasenkod7a805e2008-12-03 19:05:55 +0000902struct passwd* xgetpwnam(const char *name) FAST_FUNC;
Denis Vlasenko15437e32008-12-05 16:23:06 +0000903struct group* xgetgrnam(const char *name) FAST_FUNC;
Denis Vlasenko0c68a872008-12-02 22:56:59 +0000904struct passwd* xgetpwuid(uid_t uid) FAST_FUNC;
905struct group* xgetgrgid(gid_t gid) FAST_FUNC;
906char* xuid2uname(uid_t uid) FAST_FUNC;
907char* xgid2group(gid_t gid) FAST_FUNC;
908char* uid2uname(uid_t uid) FAST_FUNC;
909char* gid2group(gid_t gid) FAST_FUNC;
Denys Vlasenko7d65abe2011-03-01 16:27:13 +0100910char* uid2uname_utoa(uid_t uid) FAST_FUNC;
911char* gid2group_utoa(gid_t gid) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000912/* versions which cache results (useful for ps, ls etc) */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000913const char* get_cached_username(uid_t uid) FAST_FUNC;
914const char* get_cached_groupname(gid_t gid) FAST_FUNC;
915void clear_username_cache(void) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000916/* internally usernames are saved in fixed-sized char[] buffers */
Denys Vlasenko7d65abe2011-03-01 16:27:13 +0100917enum { USERNAME_MAX_SIZE = 32 - sizeof(uid_t) };
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +0000918#if ENABLE_FEATURE_CHECK_NAMES
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000919void die_if_bad_username(const char* name) FAST_FUNC;
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +0000920#else
921#define die_if_bad_username(name) ((void)(name))
922#endif
Eric Andersenaad1a882001-03-16 22:47:14 +0000923
Denys Vlasenko37f5bef2010-04-05 03:18:40 +0200924#if ENABLE_FEATURE_UTMP
Denys Vlasenko3a416112010-04-05 22:10:38 +0200925void FAST_FUNC write_new_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
926void 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 +0100927void FAST_FUNC update_utmp_DEAD_PROCESS(pid_t pid);
Denys Vlasenko37f5bef2010-04-05 03:18:40 +0200928#else
Denys Vlasenko3a416112010-04-05 22:10:38 +0200929# define write_new_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
930# define update_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
Denys Vlasenkoda921262015-01-05 15:37:58 +0100931# define update_utmp_DEAD_PROCESS(pid) ((void)0)
Denys Vlasenko37f5bef2010-04-05 03:18:40 +0200932#endif
933
Denys Vlasenkob72baeb2011-02-02 18:38:57 +0100934
Denys Vlasenkoe765b5a2014-05-02 17:15:58 +0200935int file_is_executable(const char *name) FAST_FUNC;
936char *find_executable(const char *filename, char **PATHp) FAST_FUNC;
937int executable_exists(const char *filename) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000938
Denis Vlasenko7e0fbf92007-09-04 19:33:22 +0000939/* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
940 * but it may exec busybox and call applet instead of searching PATH.
941 */
Denis Vlasenko80d14be2007-04-10 23:03:30 +0000942#if ENABLE_FEATURE_PREFER_APPLETS
Denys Vlasenkoc71b4692011-02-02 03:28:56 +0100943int BB_EXECVP(const char *file, char *const argv[]) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000944#define BB_EXECLP(prog,cmd,...) \
Denys Vlasenkoc71b4692011-02-02 03:28:56 +0100945 do { \
946 if (find_applet_by_name(prog) >= 0) \
947 execlp(bb_busybox_exec_path, cmd, __VA_ARGS__); \
948 execlp(prog, cmd, __VA_ARGS__); \
949 } while (0)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000950#else
951#define BB_EXECVP(prog,cmd) execvp(prog,cmd)
Denys Vlasenkoc71b4692011-02-02 03:28:56 +0100952#define BB_EXECLP(prog,cmd,...) execlp(prog,cmd,__VA_ARGS__)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000953#endif
Pascal Bellard21e8e8d2010-07-04 00:57:03 +0200954int BB_EXECVP_or_die(char **argv) NORETURN FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000955
Pascal Bellard926031b2010-07-04 15:32:38 +0200956/* xvfork() can't be a _function_, return after vfork mangles stack
957 * in the parent. It must be a macro. */
958#define xvfork() \
959({ \
960 pid_t bb__xvfork_pid = vfork(); \
961 if (bb__xvfork_pid < 0) \
962 bb_perror_msg_and_die("vfork"); \
963 bb__xvfork_pid; \
964})
965#if BB_MMU
966pid_t xfork(void) FAST_FUNC;
967#endif
968
Denys Vlasenko8531d762010-03-18 22:44:00 +0100969/* NOMMU friendy fork+exec: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000970pid_t spawn(char **argv) FAST_FUNC;
971pid_t xspawn(char **argv) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000972
Denis Vlasenko3854c5d2008-11-06 22:39:57 +0000973pid_t safe_waitpid(pid_t pid, int *wstat, int options) FAST_FUNC;
Denys Vlasenko8531d762010-03-18 22:44:00 +0100974pid_t wait_any_nohang(int *wstat) FAST_FUNC;
975/* wait4pid: unlike waitpid, waits ONLY for one process.
976 * Returns sig + 0x180 if child is killed by signal.
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000977 * It's safe to pass negative 'pids' from failed [v]fork -
Denis Vlasenko473dae02007-04-11 07:04:23 +0000978 * wait4pid will return -1 (and will not clobber [v]fork's errno).
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000979 * IOW: rc = wait4pid(spawn(argv));
980 * if (rc < 0) bb_perror_msg("%s", argv[0]);
Denys Vlasenko8531d762010-03-18 22:44:00 +0100981 * if (rc > 0) bb_error_msg("exit code: %d", rc & 0xff);
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000982 */
Denis Vlasenko3854c5d2008-11-06 22:39:57 +0000983int wait4pid(pid_t pid) FAST_FUNC;
Denys Vlasenko8531d762010-03-18 22:44:00 +0100984/* Same as wait4pid(spawn(argv)), but with NOFORK/NOEXEC if configured: */
Denys Vlasenko8f24f982009-06-07 16:02:00 +0200985int spawn_and_wait(char **argv) FAST_FUNC;
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000986/* Does NOT check that applet is NOFORK, just blindly runs it */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000987int run_nofork_applet(int applet_no, char **argv) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000988
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000989/* Helpers for daemonization.
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000990 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000991 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000992 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000993 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
994 * rexec's itself on NOMMU with argv passed as command line.
995 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
996 * from the start. (It will detect it and not reexec again second time).
997 * You have to audit carefully that you don't do something twice as a result
998 * (opening files/sockets, parsing config files etc...)!
999 *
1000 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
1001 * (will do setsid()).
1002 *
Pascal Bellard926031b2010-07-04 15:32:38 +02001003 * fork_or_rexec(argv) = bare-bones fork on MMU,
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001004 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
Denis Vlasenko83518d12009-03-20 22:17:13 +00001005 * On MMU ignores argv.
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001006 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001007 * Helper for network daemons in foreground mode:
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001008 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001009 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
1010 * to /dev/null if they are not.
1011 */
1012enum {
1013 DAEMON_CHDIR_ROOT = 1,
Denis Vlasenkoa1b16f42007-07-31 17:09:44 +00001014 DAEMON_DEVNULL_STDIO = 2,
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001015 DAEMON_CLOSE_EXTRA_FDS = 4,
1016 DAEMON_ONLY_SANITIZE = 8, /* internal use */
Peter Korsgaard743edac2011-11-09 19:44:37 +01001017 DAEMON_DOUBLE_FORK = 16, /* double fork to avoid controlling tty */
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001018};
Denis Vlasenko473dae02007-04-11 07:04:23 +00001019#if BB_MMU
Denis Vlasenko367960b2007-08-18 14:20:21 +00001020 enum { re_execed = 0 };
Pascal Bellard926031b2010-07-04 15:32:38 +02001021# define fork_or_rexec(argv) xfork()
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001022# define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
1023# define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001024#else
Pascal Bellard926031b2010-07-04 15:32:38 +02001025 extern bool re_execed;
Denys Vlasenkod2277e22011-11-22 17:19:26 +01001026 /* Note: re_exec() and fork_or_rexec() do argv[0][0] |= 0x80 on NOMMU!
1027 * _Parent_ needs to undo it if it doesn't want to have argv[0] mangled.
1028 */
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001029 void re_exec(char **argv) NORETURN FAST_FUNC;
Denis Vlasenko83518d12009-03-20 22:17:13 +00001030 pid_t fork_or_rexec(char **argv) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001031 int BUG_fork_is_unavailable_on_nommu(void) FAST_FUNC;
1032 int BUG_daemon_is_unavailable_on_nommu(void) FAST_FUNC;
1033 void BUG_bb_daemonize_is_unavailable_on_nommu(void) FAST_FUNC;
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001034# define fork() BUG_fork_is_unavailable_on_nommu()
Pascal Bellard926031b2010-07-04 15:32:38 +02001035# define xfork() BUG_fork_is_unavailable_on_nommu()
Denis Vlasenko53091ec2007-03-26 13:35:09 +00001036# define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
1037# define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001038#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001039void bb_daemonize_or_rexec(int flags, char **argv) FAST_FUNC;
1040void bb_sanitize_stdio(void) FAST_FUNC;
Denis Vlasenkoc9ca0a32008-02-18 11:08:33 +00001041/* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001042int sanitize_env_if_suid(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001043
1044
Denys Vlasenkoe992bae2009-11-28 15:18:53 +01001045char* single_argv(char **argv) FAST_FUNC;
Denis Vlasenko62a90cd2008-03-17 09:07:36 +00001046extern const char *const bb_argv_dash[]; /* "-", NULL */
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001047extern const char *opt_complementary;
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001048#if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +00001049#define No_argument "\0"
1050#define Required_argument "\001"
1051#define Optional_argument "\002"
1052extern const char *applet_long_options;
Denis Vlasenkoc61852a2006-11-29 11:09:43 +00001053#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001054extern uint32_t option_mask32;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001055extern uint32_t getopt32(char **argv, const char *applet_opts, ...) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001056
1057
Denys Vlasenko9be47022011-05-16 12:21:31 +02001058/* Having next pointer as a first member allows easy creation
1059 * of "llist-compatible" structs, and using llist_FOO functions
1060 * on them.
1061 */
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001062typedef struct llist_t {
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001063 struct llist_t *link;
Denys Vlasenko9be47022011-05-16 12:21:31 +02001064 char *data;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001065} llist_t;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001066void llist_add_to(llist_t **old_head, void *data) FAST_FUNC;
1067void llist_add_to_end(llist_t **list_head, void *data) FAST_FUNC;
1068void *llist_pop(llist_t **elm) FAST_FUNC;
1069void llist_unlink(llist_t **head, llist_t *elm) FAST_FUNC;
1070void llist_free(llist_t *elm, void (*freeit)(void *data)) FAST_FUNC;
1071llist_t *llist_rev(llist_t *list) FAST_FUNC;
Denis Vlasenko0b791d92009-04-13 20:52:00 +00001072llist_t *llist_find_str(llist_t *first, const char *str) FAST_FUNC;
Denis Vlasenko4b924f32007-05-30 00:29:55 +00001073/* BTW, surprisingly, changing API to
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001074 * llist_t *llist_add_to(llist_t *old_head, void *data)
1075 * etc does not result in smaller code... */
1076
Denis Vlasenko80edead2007-08-02 22:31:05 +00001077/* start_stop_daemon and udhcpc are special - they want
1078 * to create pidfiles regardless of FEATURE_PIDFILE */
Denis Vlasenko1caca342007-08-02 10:14:29 +00001079#if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001080/* True only if we created pidfile which is *file*, not /dev/null etc */
1081extern smallint wrote_pidfile;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001082void write_pidfile(const char *path) FAST_FUNC;
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001083#define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
Denis Vlasenko10457b92007-03-27 22:01:31 +00001084#else
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001085enum { wrote_pidfile = 0 };
1086#define write_pidfile(path) ((void)0)
1087#define remove_pidfile(path) ((void)0)
Denis Vlasenko10457b92007-03-27 22:01:31 +00001088#endif
1089
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001090enum {
1091 LOGMODE_NONE = 0,
Denis Vlasenko1b97efd2007-08-17 19:18:06 +00001092 LOGMODE_STDIO = (1 << 0),
1093 LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001094 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
1095};
1096extern const char *msg_eol;
Denys Vlasenko3dfe0ae2014-04-30 14:48:28 +02001097extern smallint syslog_level;
Denis Vlasenko04c99eb2007-04-07 00:44:31 +00001098extern smallint logmode;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001099extern int die_sleep;
Denys Vlasenko7aa63042010-09-01 16:04:24 +02001100extern uint8_t xfunc_error_retval;
Denis Vlasenko3f3aa2a2007-04-09 21:35:07 +00001101extern jmp_buf die_jmp;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001102extern void xfunc_die(void) NORETURN FAST_FUNC;
1103extern void bb_show_usage(void) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001104extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1105extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1106extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1107extern void bb_simple_perror_msg(const char *s) FAST_FUNC;
1108extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
Denis Vlasenkofb1a23d2009-03-07 01:54:24 +00001109extern void bb_simple_perror_msg_and_die(const char *s) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001110extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1111extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001112extern void bb_perror_nomsg_and_die(void) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001113extern void bb_perror_nomsg(void) FAST_FUNC;
1114extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1115extern void bb_verror_msg(const char *s, va_list p, const char *strerr) FAST_FUNC;
Michel Stamd3fabf82014-11-04 12:19:04 +01001116extern void bb_logenv_override(void) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001117
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +00001118/* We need to export XXX_main from libbusybox
1119 * only if we build "individual" binaries
1120 */
1121#if ENABLE_FEATURE_INDIVIDUAL
1122#define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
1123#else
1124#define MAIN_EXTERNALLY_VISIBLE
1125#endif
1126
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001127
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001128/* Applets which are useful from another applets */
Denis Vlasenko06af2162007-02-03 17:28:39 +00001129int bb_cat(char** argv);
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001130/* If shell needs them, they exist even if not enabled as applets */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001131int echo_main(int argc, char** argv) IF_ECHO(MAIN_EXTERNALLY_VISIBLE);
1132int printf_main(int argc, char **argv) IF_PRINTF(MAIN_EXTERNALLY_VISIBLE);
1133int test_main(int argc, char **argv) IF_TEST(MAIN_EXTERNALLY_VISIBLE);
1134int kill_main(int argc, char **argv) IF_KILL(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001135/* Similar, but used by chgrp, not shell */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001136int chown_main(int argc, char **argv) IF_CHOWN(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenkoc41cba52009-03-09 15:46:07 +00001137/* Used by ftpd */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001138int ls_main(int argc, char **argv) IF_LS(MAIN_EXTERNALLY_VISIBLE);
1139/* Don't need IF_xxx() guard for these */
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +00001140int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko77f1ec12007-10-13 03:36:03 +00001141int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko1a9e9bd2008-11-01 12:54:56 +00001142
Denis Vlasenko468aea22008-04-01 14:47:57 +00001143#if ENABLE_ROUTE
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001144void bb_displayroutes(int noresolve, int netstatfmt) FAST_FUNC;
Denis Vlasenko468aea22008-04-01 14:47:57 +00001145#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001146
Denis Vlasenko270c17c2006-12-26 17:40:33 +00001147
1148/* Networking */
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001149/* This structure defines protocol families and their handlers. */
1150struct aftype {
1151 const char *name;
1152 const char *title;
1153 int af;
1154 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001155 char* FAST_FUNC (*print)(unsigned char *);
1156 const char* FAST_FUNC (*sprint)(struct sockaddr *, int numeric);
1157 int FAST_FUNC (*input)(/*int type,*/ const char *bufp, struct sockaddr *);
1158 void FAST_FUNC (*herror)(char *text);
1159 int FAST_FUNC (*rprint)(int options);
1160 int FAST_FUNC (*rinput)(int typ, int ext, char **argv);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001161 /* may modify src */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001162 int FAST_FUNC (*getmask)(char *src, struct sockaddr *mask, char *name);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001163};
1164/* This structure defines hardware protocols and their handlers. */
1165struct hwtype {
1166 const char *name;
1167 const char *title;
1168 int type;
1169 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001170 char* FAST_FUNC (*print)(unsigned char *);
1171 int FAST_FUNC (*input)(const char *, struct sockaddr *);
1172 int FAST_FUNC (*activate)(int fd);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001173 int suppress_null_addr;
1174};
Denis Vlasenko1b16bda2007-06-19 11:10:02 +00001175extern smallint interface_opt_a;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001176int display_interfaces(char *ifname) FAST_FUNC;
Bartosz Golaszewskic19be752013-07-25 04:39:04 +02001177int in_ether(const char *bufp, struct sockaddr *sap) FAST_FUNC;
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001178#if ENABLE_FEATURE_HWIB
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001179int in_ib(const char *bufp, struct sockaddr *sap) FAST_FUNC;
Denis Vlasenko3b162ec2008-06-04 07:59:51 +00001180#else
1181#define in_ib(a, b) 1 /* fail */
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001182#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001183const struct aftype *get_aftype(const char *name) FAST_FUNC;
1184const struct hwtype *get_hwtype(const char *name) FAST_FUNC;
1185const struct hwtype *get_hwntype(int type) FAST_FUNC;
Denis Vlasenko270c17c2006-12-26 17:40:33 +00001186
1187
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001188#ifndef BUILD_INDIVIDUAL
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001189extern int find_applet_by_name(const char *name) FAST_FUNC;
Denis Vlasenko32b633a2007-04-09 03:05:48 +00001190/* Returns only if applet is not found. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001191extern void run_applet_and_exit(const char *name, char **argv) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001192extern void run_applet_no_and_exit(int a, char **argv) NORETURN FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001193#endif
1194
Mike Frysinger9412ec72008-02-07 22:41:33 +00001195#ifdef HAVE_MNTENT_H
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001196extern int match_fstype(const struct mntent *mt, const char *fstypes) FAST_FUNC;
Denys Vlasenko6ae64262009-07-18 16:22:26 +02001197extern struct mntent *find_mount_point(const char *name, int subdir_too) FAST_FUNC;
Mike Frysinger9412ec72008-02-07 22:41:33 +00001198#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001199extern void erase_mtab(const char * name) FAST_FUNC;
1200extern unsigned int tty_baud_to_value(speed_t speed) FAST_FUNC;
1201extern speed_t tty_value_to_baud(unsigned int value) FAST_FUNC;
Denys Vlasenkoa355da02010-01-04 13:16:08 +01001202#if ENABLE_DESKTOP
1203extern void bb_warn_ignoring_args(char *arg) FAST_FUNC;
1204#else
1205# define bb_warn_ignoring_args(arg) ((void)0)
1206#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001207
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001208extern int get_linux_version_code(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001209
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001210extern char *query_loop(const char *device) FAST_FUNC;
1211extern int del_loop(const char *device) FAST_FUNC;
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001212/* If *devname is not NULL, use that name, otherwise try to find free one,
1213 * malloc and return it in *devname.
1214 * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
Denys Vlasenko13e709c2011-09-12 02:13:47 +02001215extern int set_loop(char **devname, const char *file, unsigned long long offset, int ro) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001216
Bernhard Reutner-Fischer82b14292008-12-03 18:48:39 +00001217/* Like bb_ask below, but asks on stdin with no timeout. */
1218char *bb_ask_stdin(const char * prompt) FAST_FUNC;
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +00001219//TODO: pass buf pointer or return allocated buf (avoid statics)?
Bernhard Reutner-Fischer82b14292008-12-03 18:48:39 +00001220char *bb_ask(const int fd, int timeout, const char * prompt) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001221int bb_ask_confirmation(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001222
Denis Vlasenkoc01340f2008-07-16 22:12:18 +00001223int bb_parse_mode(const char* s, mode_t* theMode) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001224
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001225/*
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001226 * Config file parser
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001227 */
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001228enum {
Denis Vlasenko084266e2008-07-26 23:08:31 +00001229 PARSE_COLLAPSE = 0x00010000, // treat consecutive delimiters as one
1230 PARSE_TRIM = 0x00020000, // trim leading and trailing delimiters
1231// TODO: COLLAPSE and TRIM seem to always go in pair
1232 PARSE_GREEDY = 0x00040000, // last token takes entire remainder of the line
1233 PARSE_MIN_DIE = 0x00100000, // die if < min tokens found
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001234 // keep a copy of current line
Denis Vlasenko35a064b2008-11-06 00:49:59 +00001235 PARSE_KEEP_COPY = 0x00200000 * ENABLE_FEATURE_CROND_D,
Denys Vlasenko499597d2012-01-11 00:37:17 +01001236 PARSE_EOL_COMMENTS = 0x00400000, // comments are recognized even if they aren't the first char
Denis Vlasenko084266e2008-07-26 23:08:31 +00001237 // NORMAL is:
1238 // * remove leading and trailing delimiters and collapse
1239 // multiple delimiters into one
1240 // * warn and continue if less than mintokens delimiters found
1241 // * grab everything into last token
Denys Vlasenko499597d2012-01-11 00:37:17 +01001242 // * comments are recognized even if they aren't the first char
1243 PARSE_NORMAL = PARSE_COLLAPSE | PARSE_TRIM | PARSE_GREEDY | PARSE_EOL_COMMENTS,
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001244};
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001245typedef struct parser_t {
1246 FILE *fp;
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001247 char *data;
Timo Terasadcabf32011-06-20 09:49:56 +02001248 char *line, *nline;
1249 size_t line_alloc, nline_alloc;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001250 int lineno;
1251} parser_t;
Bernhard Reutner-Fischer67921282008-07-17 11:59:13 +00001252parser_t* config_open(const char *filename) FAST_FUNC;
Denis Vlasenko5415c852008-07-21 23:05:26 +00001253parser_t* config_open2(const char *filename, FILE* FAST_FUNC (*fopen_func)(const char *path)) FAST_FUNC;
Denys Vlasenkoadbbee42010-06-21 07:17:23 +02001254/* delims[0] is a comment char (use '\0' to disable), the rest are token delimiters */
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001255int config_read(parser_t *parser, char **tokens, unsigned flags, const char *delims) FAST_FUNC;
1256#define config_read(parser, tokens, max, min, str, flags) \
1257 config_read(parser, tokens, ((flags) | (((min) & 0xFF) << 8) | ((max) & 0xFF)), str)
Denis Vlasenkoc01340f2008-07-16 22:12:18 +00001258void config_close(parser_t *parser) FAST_FUNC;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001259
Denis Vlasenko6bf05cf2008-05-07 12:18:48 +00001260/* Concatenate path and filename to new allocated buffer.
1261 * Add "/" only as needed (no duplicate "//" are produced).
1262 * If path is NULL, it is assumed to be "/".
1263 * filename should not be NULL. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001264char *concat_path_file(const char *path, const char *filename) FAST_FUNC;
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +02001265/* Returns NULL on . and .. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001266char *concat_subpath_file(const char *path, const char *filename) FAST_FUNC;
Eric Andersene5dfced2001-04-09 22:48:12 +00001267
Denis Vlasenko4921b542007-02-03 02:17:41 +00001268
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001269int bb_make_directory(char *path, long mode, int flags) FAST_FUNC;
Matt Kraaiceeff732001-06-21 19:41:37 +00001270
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001271int get_signum(const char *name) FAST_FUNC;
1272const char *get_signame(int number) FAST_FUNC;
1273void print_signames(void) FAST_FUNC;
Rob Landleyc9c1a412006-07-12 19:17:55 +00001274
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001275char *bb_simplify_path(const char *path) FAST_FUNC;
Denis Vlasenko1cf4a0e2009-04-22 13:49:16 +00001276/* Returns ptr to NUL */
1277char *bb_simplify_abs_path_inplace(char *path) FAST_FUNC;
Eric Andersen34506362001-08-02 05:02:46 +00001278
Peter Kümmela6588fa2014-12-22 01:55:54 +01001279#ifndef LOGIN_FAIL_DELAY
Denys Vlasenko681efe22011-03-08 21:00:36 +01001280#define LOGIN_FAIL_DELAY 3
Peter Kümmela6588fa2014-12-22 01:55:54 +01001281#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001282extern void bb_do_delay(int seconds) FAST_FUNC;
1283extern void change_identity(const struct passwd *pw) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001284extern 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 +01001285
1286/* Returns $SHELL, getpwuid(getuid())->pw_shell, or DEFAULT_SHELL.
1287 * Note that getpwuid result might need xstrdup'ing
1288 * if there is a possibility of intervening getpwxxx() calls.
1289 */
Denys Vlasenkofd77ea52012-10-03 09:42:21 +02001290const char *get_shell_name(void) FAST_FUNC;
Denys Vlasenko681efe22011-03-08 21:00:36 +01001291
Denis Vlasenkob5a122b2006-12-30 14:46:51 +00001292#if ENABLE_SELINUX
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001293extern void renew_current_security_context(void) FAST_FUNC;
1294extern void set_current_security_context(security_context_t sid) FAST_FUNC;
Denis Vlasenko1203c9b2007-03-11 22:16:02 +00001295extern context_t set_security_context_component(security_context_t cur_context,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001296 char *user, char *role, char *type, char *range) FAST_FUNC;
1297extern void setfscreatecon_or_die(security_context_t scontext) FAST_FUNC;
1298extern void selinux_preserve_fcontext(int fdesc) FAST_FUNC;
Denis Vlasenko2edbc2a2007-10-20 02:00:49 +00001299#else
1300#define selinux_preserve_fcontext(fdesc) ((void)0)
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001301#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001302extern void selinux_or_die(void) FAST_FUNC;
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001303
Davide Cavalca9b3b9792011-01-25 02:26:03 +01001304
1305/* systemd support */
1306#define SD_LISTEN_FDS_START 3
1307int sd_listen_fds(void);
1308
1309
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001310/* setup_environment:
Bernhard Reutner-Fischer99709ab2010-02-24 16:10:09 +01001311 * if chdir pw->pw_dir: ok: else if to_tmp == 1: goto /tmp else: goto / or die
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001312 * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001313 * TERM=(old value)
1314 * USER=pw->pw_name, LOGNAME=pw->pw_name
1315 * PATH=bb_default_[root_]path
1316 * HOME=pw->pw_dir
1317 * SHELL=shell
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001318 * else if change_env = 1:
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001319 * if not root (if pw->pw_uid != 0):
1320 * USER=pw->pw_name, LOGNAME=pw->pw_name
1321 * HOME=pw->pw_dir
1322 * SHELL=shell
1323 * else does nothing
1324 */
Denys Vlasenkofd686a22010-02-26 09:52:45 +01001325#define SETUP_ENV_CHANGEENV (1 << 0)
1326#define SETUP_ENV_CLEARENV (1 << 1)
1327#define SETUP_ENV_TO_TMP (1 << 2)
Pascal Bellard70fc8c12012-06-12 13:21:02 +02001328#define SETUP_ENV_NO_CHDIR (1 << 4)
Denys Vlasenko8b59b2c2013-11-19 13:36:45 +01001329void setup_environment(const char *shell, int flags, const struct passwd *pw) FAST_FUNC;
1330void nuke_str(char *str) FAST_FUNC;
Morten Kvistgaardfeac9b62014-08-05 21:57:18 +02001331int check_password(const struct passwd *pw, const char *plaintext) FAST_FUNC;
Denys Vlasenko8b59b2c2013-11-19 13:36:45 +01001332int ask_and_check_password_extended(const struct passwd *pw, int timeout, const char *prompt) FAST_FUNC;
1333int ask_and_check_password(const struct passwd *pw) FAST_FUNC;
Denis Vlasenkofdddab02008-06-12 16:56:52 +00001334/* Returns a malloced string */
Denis Vlasenkob4c5bf62008-06-15 18:35:34 +00001335#if !ENABLE_USE_BB_CRYPT
1336#define pw_encrypt(clear, salt, cleanup) pw_encrypt(clear, salt)
1337#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001338extern char *pw_encrypt(const char *clear, const char *salt, int cleanup) FAST_FUNC;
1339extern int obscure(const char *old, const char *newval, const struct passwd *pwdp) FAST_FUNC;
Denys Vlasenko12a43272011-05-13 03:19:01 +02001340/*
1341 * rnd is additional random input. New one is returned.
Denis Vlasenko4ea83bf2008-06-12 16:55:59 +00001342 * Useful if you call crypt_make_salt many times in a row:
1343 * rnd = crypt_make_salt(buf1, 4, 0);
1344 * rnd = crypt_make_salt(buf2, 4, rnd);
1345 * rnd = crypt_make_salt(buf3, 4, rnd);
1346 * (otherwise we risk having same salt generated)
1347 */
Denys Vlasenko12a43272011-05-13 03:19:01 +02001348extern int crypt_make_salt(char *p, int cnt /*, int rnd*/) FAST_FUNC;
1349/* "$N$" + sha_salt_16_bytes + NUL */
1350#define MAX_PW_SALT_LEN (3 + 16 + 1)
1351extern char* crypt_make_pw_salt(char p[MAX_PW_SALT_LEN], const char *algo) FAST_FUNC;
1352
Denis Vlasenko829bbd32009-04-14 00:51:05 +00001353
Denis Vlasenko4ea83bf2008-06-12 16:55:59 +00001354/* Returns number of lines changed, or -1 on error */
Denis Vlasenko829bbd32009-04-14 00:51:05 +00001355#if !(ENABLE_FEATURE_ADDUSER_TO_GROUP || ENABLE_FEATURE_DEL_USER_FROM_GROUP)
1356#define update_passwd(filename, username, data, member) \
1357 update_passwd(filename, username, data)
1358#endif
1359extern int update_passwd(const char *filename,
1360 const char *username,
1361 const char *data,
1362 const char *member) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001363
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001364int index_in_str_array(const char *const string_array[], const char *key) FAST_FUNC;
1365int index_in_strings(const char *strings, const char *key) FAST_FUNC;
1366int index_in_substr_array(const char *const string_array[], const char *key) FAST_FUNC;
1367int index_in_substrings(const char *strings, const char *key) FAST_FUNC;
1368const char *nth_string(const char *strings, int n) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001369
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001370extern void print_login_issue(const char *issue_file, const char *tty) FAST_FUNC;
1371extern void print_login_prompt(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001372
Denys Vlasenko53283ad2009-11-02 14:20:34 +01001373char *xmalloc_ttyname(int fd) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof893da82007-08-09 08:27:24 +00001374/* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001375int get_terminal_width_height(int fd, unsigned *width, unsigned *height) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001376
Denis Vlasenko202ac502008-11-05 13:20:58 +00001377int tcsetattr_stdin_TCSANOW(const struct termios *tp) FAST_FUNC;
1378
Denis Vlasenko5bb2fc22008-04-21 03:23:59 +00001379/* NB: "unsigned request" is crucial! "int request" will break some arches! */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001380int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1381int 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 +00001382#if ENABLE_IOCTL_HEX2STR_ERROR
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001383int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1384int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001385#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1386#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
1387#else
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001388int bb_ioctl_or_warn(int fd, unsigned request, void *argp) FAST_FUNC;
1389int bb_xioctl(int fd, unsigned request, void *argp) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001390#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1391#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
1392#endif
1393
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001394char *is_in_ino_dev_hashtable(const struct stat *statbuf) FAST_FUNC;
1395void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name) FAST_FUNC;
1396void reset_ino_dev_hashtable(void) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001397#ifdef __GLIBC__
1398/* At least glibc has horrendously large inline for this, so wrap it */
Denys Vlasenko975c7142011-01-24 23:53:12 +01001399unsigned long long bb_makedev(unsigned major, unsigned minor) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001400#undef makedev
1401#define makedev(a,b) bb_makedev(a,b)
1402#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001403
1404
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001405/* "Keycodes" that report an escape sequence.
1406 * We use something which fits into signed char,
Denys Vlasenko5370bfb2009-09-06 02:58:59 +02001407 * yet doesn't represent any valid Unicode character.
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001408 * Also, -1 is reserved for error indication and we don't use it. */
1409enum {
1410 KEYCODE_UP = -2,
1411 KEYCODE_DOWN = -3,
1412 KEYCODE_RIGHT = -4,
1413 KEYCODE_LEFT = -5,
1414 KEYCODE_HOME = -6,
1415 KEYCODE_END = -7,
1416 KEYCODE_INSERT = -8,
1417 KEYCODE_DELETE = -9,
1418 KEYCODE_PAGEUP = -10,
1419 KEYCODE_PAGEDOWN = -11,
Denys Vlasenko9ce09bc2011-11-03 13:28:22 +01001420 // -12 is reserved for Alt/Ctrl/Shift-TAB
1421#if 0
1422 KEYCODE_FUN1 = -13,
1423 KEYCODE_FUN2 = -14,
1424 KEYCODE_FUN3 = -15,
1425 KEYCODE_FUN4 = -16,
1426 KEYCODE_FUN5 = -17,
1427 KEYCODE_FUN6 = -18,
1428 KEYCODE_FUN7 = -19,
1429 KEYCODE_FUN8 = -20,
1430 KEYCODE_FUN9 = -21,
1431 KEYCODE_FUN10 = -22,
1432 KEYCODE_FUN11 = -23,
1433 KEYCODE_FUN12 = -24,
1434#endif
1435 /* Be sure that last defined value is small enough
1436 * to not interfere with Alt/Ctrl/Shift bits.
1437 * So far we do not exceed -31 (0xfff..fffe1),
1438 * which gives us three upper bits in LSB to play with.
1439 */
1440 //KEYCODE_SHIFT_TAB = (-12) & ~0x80,
1441 //KEYCODE_SHIFT_... = KEYCODE_... & ~0x80,
1442 //KEYCODE_CTRL_UP = KEYCODE_UP & ~0x40,
1443 //KEYCODE_CTRL_DOWN = KEYCODE_DOWN & ~0x40,
Denys Vlasenkoa17eeb82009-10-25 23:50:56 +01001444 KEYCODE_CTRL_RIGHT = KEYCODE_RIGHT & ~0x40,
1445 KEYCODE_CTRL_LEFT = KEYCODE_LEFT & ~0x40,
Denys Vlasenko9ce09bc2011-11-03 13:28:22 +01001446 //KEYCODE_ALT_UP = KEYCODE_UP & ~0x20,
1447 //KEYCODE_ALT_DOWN = KEYCODE_DOWN & ~0x20,
1448 KEYCODE_ALT_RIGHT = KEYCODE_RIGHT & ~0x20,
1449 KEYCODE_ALT_LEFT = KEYCODE_LEFT & ~0x20,
1450
Denys Vlasenko180f5852009-10-26 00:59:59 +01001451 KEYCODE_CURSOR_POS = -0x100, /* 0xfff..fff00 */
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001452 /* How long is the longest ESC sequence we know?
1453 * We want it big enough to be able to contain
1454 * cursor position sequence "ESC [ 9999 ; 9999 R"
1455 */
1456 KEYCODE_BUFFER_SIZE = 16
1457};
1458/* Note: fd may be in blocking or non-blocking mode, both make sense.
1459 * For one, less uses non-blocking mode.
1460 * Only the first read syscall inside read_key may block indefinitely
1461 * (unless fd is in non-blocking mode),
1462 * subsequent reads will time out after a few milliseconds.
1463 * Return of -1 means EOF or error (errno == 0 on EOF).
1464 * buffer[0] is used as a counter of buffered chars and must be 0
1465 * on first call.
Denys Vlasenko58f108e2010-03-11 21:17:55 +01001466 * timeout:
1467 * -2: do not poll for input;
1468 * -1: poll(-1) (i.e. block);
1469 * >=0: poll for TIMEOUT milliseconds, return -1/EAGAIN on timeout
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001470 */
Denys Vlasenko58f108e2010-03-11 21:17:55 +01001471int64_t read_key(int fd, char *buffer, int timeout) FAST_FUNC;
Tomas Heinrichd2b04052010-03-09 14:09:24 +01001472void read_key_ungets(char *buffer, const char *str, unsigned len) FAST_FUNC;
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001473
1474
Denis Vlasenko38f63192007-01-22 09:03:07 +00001475#if ENABLE_FEATURE_EDITING
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001476/* It's NOT just ENABLEd or disabled. It's a number: */
Denys Vlasenko2c4de5b2011-03-31 13:16:52 +02001477# if defined CONFIG_FEATURE_EDITING_HISTORY && CONFIG_FEATURE_EDITING_HISTORY > 0
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001478# define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
Flemming Madsend96ffda2013-04-07 18:47:24 +02001479unsigned size_from_HISTFILESIZE(const char *hp) FAST_FUNC;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001480# else
1481# define MAX_HISTORY 0
1482# endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001483typedef struct line_input_t {
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001484 int flags;
1485 const char *path_lookup;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001486# if MAX_HISTORY
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001487 int cnt_history;
1488 int cur_history;
Denys Vlasenko2c4de5b2011-03-31 13:16:52 +02001489 int max_history; /* must never be <= 0 */
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001490# if ENABLE_FEATURE_EDITING_SAVEHISTORY
Denys Vlasenkobede2152011-09-04 16:12:33 +02001491 /* meaning of this field depends on FEATURE_EDITING_SAVE_ON_EXIT:
1492 * if !FEATURE_EDITING_SAVE_ON_EXIT: "how many lines are
1493 * in on-disk history"
1494 * if FEATURE_EDITING_SAVE_ON_EXIT: "how many in-memory lines are
1495 * also in on-disk history (and thus need to be skipped on save)"
1496 */
Denis Vlasenko57abf9e2009-03-22 19:00:05 +00001497 unsigned cnt_history_in_file;
Denis Vlasenko57abf9e2009-03-22 19:00:05 +00001498 const char *hist_file;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001499# endif
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001500 char *history[MAX_HISTORY + 1];
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001501# endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001502} line_input_t;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001503enum {
Denys Vlasenkoe45af7a2011-09-04 16:15:24 +02001504 DO_HISTORY = 1 * (MAX_HISTORY > 0),
1505 TAB_COMPLETION = 2 * ENABLE_FEATURE_TAB_COMPLETION,
1506 USERNAME_COMPLETION = 4 * ENABLE_FEATURE_USERNAME_COMPLETION,
1507 VI_MODE = 8 * ENABLE_FEATURE_EDITING_VI,
1508 WITH_PATH_LOOKUP = 0x10,
1509 FOR_SHELL = DO_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001510};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001511line_input_t *new_line_input_t(int flags) FAST_FUNC;
Denys Vlasenko5c2e81b2009-07-16 14:14:34 +02001512/* So far static: void free_line_input_t(line_input_t *n) FAST_FUNC; */
Denys Vlasenko046341e2011-02-04 17:53:59 +01001513/*
1514 * maxsize must be >= 2.
Denys Vlasenko5c2e81b2009-07-16 14:14:34 +02001515 * Returns:
Denis Vlasenko80667e32008-02-02 18:35:55 +00001516 * -1 on read errors or EOF, or on bare Ctrl-D,
1517 * 0 on ctrl-C (the line entered is still returned in 'command'),
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001518 * >0 length of input string, including terminating '\n'
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001519 */
Denys Vlasenko66c5b122011-02-08 05:07:02 +01001520int 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 +02001521void show_history(const line_input_t *st) FAST_FUNC;
Denys Vlasenkobede2152011-09-04 16:12:33 +02001522# if ENABLE_FEATURE_EDITING_SAVE_ON_EXIT
1523void save_history(line_input_t *st);
1524# endif
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001525#else
Denys Vlasenko36df0482009-10-19 16:07:28 +02001526#define MAX_HISTORY 0
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001527int read_line_input(const char* prompt, char* command, int maxsize) FAST_FUNC;
Denys Vlasenko66c5b122011-02-08 05:07:02 +01001528#define read_line_input(state, prompt, command, maxsize, timeout) \
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001529 read_line_input(prompt, command, maxsize)
1530#endif
1531
1532
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001533#ifndef COMM_LEN
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001534# ifdef TASK_COMM_LEN
Denis Vlasenkofa076802006-11-05 00:38:51 +00001535enum { COMM_LEN = TASK_COMM_LEN };
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001536# else
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001537/* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
Denis Vlasenkofa076802006-11-05 00:38:51 +00001538enum { COMM_LEN = 16 };
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001539# endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001540#endif
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02001541
1542struct smaprec {
1543 unsigned long mapped_rw;
1544 unsigned long mapped_ro;
1545 unsigned long shared_clean;
1546 unsigned long shared_dirty;
1547 unsigned long private_clean;
1548 unsigned long private_dirty;
1549 unsigned long stack;
1550 unsigned long smap_pss, smap_swap;
1551 unsigned long smap_size;
1552 unsigned long smap_start;
1553 char smap_mode[5];
1554 char *smap_name;
1555};
1556
1557#if !ENABLE_PMAP
1558#define procps_read_smaps(pid, total, cb, data) \
1559 procps_read_smaps(pid, total)
1560#endif
1561int FAST_FUNC procps_read_smaps(pid_t pid, struct smaprec *total,
Denys Vlasenko6830ade2013-01-15 13:58:01 +01001562 void (*cb)(struct smaprec *, void *), void *data);
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02001563
Denis Vlasenko512499c2007-08-26 18:23:13 +00001564typedef struct procps_status_t {
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001565 DIR *dir;
Denys Vlasenkob410d4a2009-09-19 22:29:42 +02001566 IF_FEATURE_SHOW_THREADS(DIR *task_dir;)
Denis Vlasenko512499c2007-08-26 18:23:13 +00001567 uint8_t shift_pages_to_bytes;
1568 uint8_t shift_pages_to_kb;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001569/* Fields are set to 0/NULL if failed to determine (or not requested) */
Denis Vlasenko3b3ca112008-07-17 18:39:36 +00001570 uint16_t argv_len;
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001571 char *argv0;
Alexander Shishkine766f622009-07-29 01:35:13 +02001572 char *exe;
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001573 IF_SELINUX(char *context;)
Lauri Kasanen6578f2c2010-12-05 05:22:29 +01001574 IF_FEATURE_SHOW_THREADS(unsigned main_thread_pid;)
Denis Vlasenko0696b8a2007-06-06 07:40:16 +00001575 /* Everything below must contain no ptrs to malloc'ed data:
1576 * it is memset(0) for each process in procps_scan() */
Denis Vlasenkofc1e9952007-08-29 18:23:36 +00001577 unsigned long vsz, rss; /* we round it to kbytes */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001578 unsigned long stime, utime;
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001579 unsigned long start_time;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001580 unsigned pid;
1581 unsigned ppid;
1582 unsigned pgid;
1583 unsigned sid;
1584 unsigned uid;
1585 unsigned gid;
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001586#if ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS
1587 unsigned ruid;
1588 unsigned rgid;
1589 int niceness;
1590#endif
Denis Vlasenko31789a82007-06-19 14:43:17 +00001591 unsigned tty_major,tty_minor;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001592#if ENABLE_FEATURE_TOPMEM
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02001593 struct smaprec smaps;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001594#endif
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001595 char state[4];
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001596 /* basename of executable in exec(2), read from /proc/N/stat
1597 * (if executable is symlink or script, it is NOT replaced
1598 * by link target or interpreter name) */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001599 char comm[COMM_LEN];
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001600 /* user/group? - use passwd/group parsing functions */
Denis Vlasenko17e7f042008-09-25 10:48:06 +00001601#if ENABLE_FEATURE_TOP_SMP_PROCESS
1602 int last_seen_on_cpu;
1603#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001604} procps_status_t;
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001605/* flag bits for procps_scan(xx, flags) calls */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001606enum {
1607 PSSCAN_PID = 1 << 0,
1608 PSSCAN_PPID = 1 << 1,
1609 PSSCAN_PGID = 1 << 2,
1610 PSSCAN_SID = 1 << 3,
1611 PSSCAN_UIDGID = 1 << 4,
1612 PSSCAN_COMM = 1 << 5,
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001613 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001614 PSSCAN_ARGV0 = 1 << 7,
Alexander Shishkine766f622009-07-29 01:35:13 +02001615 PSSCAN_EXE = 1 << 8,
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001616 PSSCAN_STATE = 1 << 9,
1617 PSSCAN_VSZ = 1 << 10,
1618 PSSCAN_RSS = 1 << 11,
1619 PSSCAN_STIME = 1 << 12,
1620 PSSCAN_UTIME = 1 << 13,
1621 PSSCAN_TTY = 1 << 14,
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001622 PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM,
Denis Vlasenko9f00e052009-02-14 01:36:11 +00001623 /* NB: used by find_pid_by_name(). Any applet using it
1624 * needs to be mentioned here. */
1625 PSSCAN_ARGVN = (1 << 16) * (ENABLE_KILLALL
1626 || ENABLE_PGREP || ENABLE_PKILL
1627 || ENABLE_PIDOF
Denis Vlasenko3266aa92009-04-01 11:24:04 +00001628 || ENABLE_SESTATUS
Denis Vlasenko9f00e052009-02-14 01:36:11 +00001629 ),
Denys Vlasenko4ff1ce02009-09-22 11:21:48 +02001630 PSSCAN_CONTEXT = (1 << 17) * ENABLE_SELINUX,
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001631 PSSCAN_START_TIME = 1 << 18,
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001632 PSSCAN_CPU = (1 << 19) * ENABLE_FEATURE_TOP_SMP_PROCESS,
1633 PSSCAN_NICE = (1 << 20) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1634 PSSCAN_RUIDGID = (1 << 21) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
Denys Vlasenkob410d4a2009-09-19 22:29:42 +02001635 PSSCAN_TASKS = (1 << 22) * ENABLE_FEATURE_SHOW_THREADS,
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001636};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001637//procps_status_t* alloc_procps_scan(void) FAST_FUNC;
1638void free_procps_scan(procps_status_t* sp) FAST_FUNC;
1639procps_status_t* procps_scan(procps_status_t* sp, int flags) FAST_FUNC;
Denys Vlasenko3a0f6f22009-09-12 00:15:34 +02001640/* Format cmdline (up to col chars) into char buf[size] */
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001641/* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
Denys Vlasenko3a0f6f22009-09-12 00:15:34 +02001642void read_cmdline(char *buf, int size, unsigned pid, const char *comm) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001643pid_t *find_pid_by_name(const char* procName) FAST_FUNC;
1644pid_t *pidlist_reverse(pid_t *pidList) FAST_FUNC;
Denys Vlasenkoc9b97502010-08-16 02:49:21 +02001645int starts_with_cpu(const char *str) FAST_FUNC;
1646unsigned get_cpu_count(void) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001647
1648
Denys Vlasenkodd1061b2011-09-11 21:04:02 +02001649/* Use strict=1 if you process input from untrusted source:
1650 * it will return NULL on invalid %xx (bad hex chars)
1651 * and str + 1 if decoded char is / or NUL.
1652 * In non-strict mode, it always succeeds (returns str),
1653 * and also it additionally decoded '+' to space.
1654 */
1655char *percent_decode_in_place(char *str, int strict) FAST_FUNC;
1656
1657
Aurelien Jarnod3a42392012-07-24 16:28:34 +02001658extern const char bb_uuenc_tbl_base64[] ALIGN1;
1659extern const char bb_uuenc_tbl_std[] ALIGN1;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001660void bb_uuencode(char *store, const void *s, int length, const char *tbl) FAST_FUNC;
Denys Vlasenko9fe98f72010-09-16 17:51:13 +02001661enum {
1662 BASE64_FLAG_UU_STOP = 0x100,
1663 /* Sign-extends to a value which never matches fgetc result: */
1664 BASE64_FLAG_NO_STOP_CHAR = 0x80,
1665};
Leonid Lisovskiy328f27f2011-10-28 13:59:04 +02001666const char *decode_base64(char **pp_dst, const char *src) FAST_FUNC;
1667void read_base64(FILE *src_stream, FILE *dst_stream, int flags) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001668
Denis Vlasenkodd539f72006-11-01 20:20:37 +00001669typedef struct md5_ctx_t {
Denys Vlasenko302ad142010-10-19 02:16:12 +02001670 uint8_t wbuffer[64]; /* always correctly aligned for uint64_t */
1671 void (*process_block)(struct md5_ctx_t*) FAST_FUNC;
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02001672 uint64_t total64; /* must be directly before hash[] */
Denys Vlasenko302ad142010-10-19 02:16:12 +02001673 uint32_t hash[8]; /* 4 elements for md5, 5 for sha1, 8 for sha256 */
1674} md5_ctx_t;
1675typedef struct md5_ctx_t sha1_ctx_t;
1676typedef struct md5_ctx_t sha256_ctx_t;
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02001677typedef struct sha512_ctx_t {
1678 uint64_t total64[2]; /* must be directly before hash[] */
1679 uint64_t hash[8];
Denys Vlasenko302ad142010-10-19 02:16:12 +02001680 uint8_t wbuffer[128]; /* always correctly aligned for uint64_t */
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02001681} sha512_ctx_t;
Lauri Kasanenb8173b62013-01-14 05:20:50 +01001682typedef struct sha3_ctx_t {
1683 uint64_t state[25];
1684 unsigned bytes_queued;
1685} sha3_ctx_t;
Denys Vlasenko302ad142010-10-19 02:16:12 +02001686void md5_begin(md5_ctx_t *ctx) FAST_FUNC;
Denys Vlasenko2cfcc9e2013-01-20 00:38:09 +01001687void md5_hash(md5_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
Denys Vlasenko302ad142010-10-19 02:16:12 +02001688void md5_end(md5_ctx_t *ctx, void *resbuf) FAST_FUNC;
1689void sha1_begin(sha1_ctx_t *ctx) FAST_FUNC;
1690#define sha1_hash md5_hash
1691void sha1_end(sha1_ctx_t *ctx, void *resbuf) FAST_FUNC;
1692void sha256_begin(sha256_ctx_t *ctx) FAST_FUNC;
1693#define sha256_hash md5_hash
1694#define sha256_end sha1_end
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02001695void sha512_begin(sha512_ctx_t *ctx) FAST_FUNC;
1696void sha512_hash(sha512_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
1697void sha512_end(sha512_ctx_t *ctx, void *resbuf) FAST_FUNC;
Lauri Kasanenb8173b62013-01-14 05:20:50 +01001698void sha3_begin(sha3_ctx_t *ctx) FAST_FUNC;
1699void sha3_hash(sha3_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
Denys Vlasenko2cfcc9e2013-01-20 00:38:09 +01001700void sha3_end(sha3_ctx_t *ctx, void *resbuf) FAST_FUNC;
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00001701
Denys Vlasenko9ce642f2010-10-27 15:26:45 +02001702extern uint32_t *global_crc32_table;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001703uint32_t *crc32_filltable(uint32_t *tbl256, int endian) FAST_FUNC;
Denys Vlasenko9ce642f2010-10-27 15:26:45 +02001704uint32_t crc32_block_endian1(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
1705uint32_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 +00001706
1707typedef struct masks_labels_t {
1708 const char *labels;
1709 const int masks[];
1710} masks_labels_t;
1711int print_flags_separated(const int *masks, const char *labels,
1712 int flags, const char *separator) FAST_FUNC;
1713int print_flags(const masks_labels_t *ml, int flags) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001714
Magnus Dammf5914992009-11-08 16:34:43 +01001715typedef struct bb_progress_t {
Denys Vlasenkoab8d00d2011-02-11 19:09:30 +01001716 unsigned last_size;
1717 unsigned last_update_sec;
1718 unsigned last_change_sec;
Magnus Dammf5914992009-11-08 16:34:43 +01001719 unsigned start_sec;
Denys Vlasenkod55e1392011-02-11 18:56:13 +01001720 const char *curfile;
Magnus Dammf5914992009-11-08 16:34:43 +01001721} bb_progress_t;
1722
Denys Vlasenkod55e1392011-02-11 18:56:13 +01001723#define is_bb_progress_inited(p) ((p)->curfile != NULL)
1724#define bb_progress_free(p) do { \
1725 if (ENABLE_UNICODE_SUPPORT) free((char*)((p)->curfile)); \
1726 (p)->curfile = NULL; \
1727} while (0)
1728void bb_progress_init(bb_progress_t *p, const char *curfile) FAST_FUNC;
1729void bb_progress_update(bb_progress_t *p,
Denys Vlasenko805aa9f2011-02-10 14:25:51 +01001730 uoff_t beg_range,
1731 uoff_t transferred,
1732 uoff_t totalsize) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001733
Denys Vlasenkod55e1392011-02-11 18:56:13 +01001734
Denis Vlasenko8f8f2682006-10-03 21:00:43 +00001735extern const char *applet_name;
Denys Vlasenko0004e992010-09-01 12:01:17 +02001736
1737/* Some older linkers don't perform string merging, we used to have common strings
1738 * as global arrays to do it by hand. But:
1739 * (1) newer linkers do it themselves,
1740 * (2) however, they DONT merge string constants with global arrays,
1741 * even if the value is the same (!). Thus global arrays actually
1742 * increased size a bit: for example, "/etc/passwd" string from libc
1743 * wasn't merged with bb_path_passwd_file[] array!
1744 * Therefore now we use #defines.
1745 */
Bernhard Reutner-Fischer78e1d582008-01-13 17:52:53 +00001746/* "BusyBox vN.N.N (timestamp or extra_version)" */
Aurelien Jarnod3a42392012-07-24 16:28:34 +02001747extern const char bb_banner[] ALIGN1;
1748extern const char bb_msg_memory_exhausted[] ALIGN1;
1749extern const char bb_msg_invalid_date[] ALIGN1;
Denys Vlasenko0004e992010-09-01 12:01:17 +02001750#define bb_msg_read_error "read error"
1751#define bb_msg_write_error "write error"
Aurelien Jarnod3a42392012-07-24 16:28:34 +02001752extern const char bb_msg_unknown[] ALIGN1;
1753extern const char bb_msg_can_not_create_raw_socket[] ALIGN1;
1754extern const char bb_msg_perm_denied_are_you_root[] ALIGN1;
1755extern const char bb_msg_you_must_be_root[] ALIGN1;
1756extern const char bb_msg_requires_arg[] ALIGN1;
1757extern const char bb_msg_invalid_arg[] ALIGN1;
1758extern const char bb_msg_standard_input[] ALIGN1;
1759extern const char bb_msg_standard_output[] ALIGN1;
Manuel Novoa III cad53642003-03-19 09:13:01 +00001760
Denis Vlasenko98c0bba2007-01-26 23:31:05 +00001761/* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
Aurelien Jarnod3a42392012-07-24 16:28:34 +02001762extern const char bb_hexdigits_upcase[] ALIGN1;
Denis Vlasenko7ca39212006-11-21 20:34:21 +00001763
Aurelien Jarnod3a42392012-07-24 16:28:34 +02001764extern const char bb_path_wtmp_file[] ALIGN1;
Denys Vlasenko0004e992010-09-01 12:01:17 +02001765
1766/* Busybox mount uses either /proc/mounts or /etc/mtab to
1767 * get the list of currently mounted filesystems */
1768#define bb_path_mtab_file IF_FEATURE_MTAB_SUPPORT("/etc/mtab")IF_NOT_FEATURE_MTAB_SUPPORT("/proc/mounts")
1769
Tito Ragusaad3d72f2011-01-16 23:39:45 +01001770#define bb_path_passwd_file _PATH_PASSWD
1771#define bb_path_group_file _PATH_GROUP
1772#define bb_path_shadow_file _PATH_SHADOW
1773#define bb_path_gshadow_file _PATH_GSHADOW
Denys Vlasenko0004e992010-09-01 12:01:17 +02001774
1775#define bb_path_motd_file "/etc/motd"
1776
1777#define bb_dev_null "/dev/null"
Aurelien Jarnod3a42392012-07-24 16:28:34 +02001778extern const char bb_busybox_exec_path[] ALIGN1;
Denis Vlasenko15611bb2007-06-12 08:52:02 +00001779/* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1780 * but I want to save a few bytes here */
Aurelien Jarnod3a42392012-07-24 16:28:34 +02001781extern const char bb_PATH_root_path[] ALIGN1; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
Denis Vlasenkof5f75c52007-06-12 22:35:19 +00001782#define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1783#define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +00001784
Denis Vlasenko703e2022007-01-22 14:12:08 +00001785extern const int const_int_0;
1786extern const int const_int_1;
1787
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001788
Denis Vlasenko85818632007-04-19 14:47:11 +00001789/* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
Denis Vlasenko74324c82007-06-04 10:16:52 +00001790enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
1791extern char bb_common_bufsiz1[COMMON_BUFSIZE];
Denis Vlasenko972288e2007-03-15 00:57:01 +00001792/* This struct is deliberately not defined. */
1793/* See docs/keep_data_small.txt */
1794struct globals;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001795/* '*const' ptr makes gcc optimize code much better.
Denis Vlasenkoe3241842007-08-13 10:36:25 +00001796 * Magic prevents ptr_to_globals from going into rodata.
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001797 * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
Denis Vlasenkobff32ce2007-03-15 19:48:35 +00001798extern struct globals *const ptr_to_globals;
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001799/* At least gcc 3.4.6 on mipsel system needs optimization barrier */
Bernhard Reutner-Fischer797c96d2008-06-06 10:31:39 +00001800#define barrier() __asm__ __volatile__("":::"memory")
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001801#define SET_PTR_TO_GLOBALS(x) do { \
Denys Vlasenko90a99042009-09-06 02:36:23 +02001802 (*(struct globals**)&ptr_to_globals) = (void*)(x); \
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001803 barrier(); \
1804} while (0)
Guilherme Maciel Ferreira840ef172013-10-16 14:43:30 +02001805#define FREE_PTR_TO_GLOBALS() do { \
1806 if (ENABLE_FEATURE_CLEAN_UP) { \
1807 free(ptr_to_globals); \
1808 } \
1809} while (0)
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001810
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001811/* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1812 * use bb_default_login_shell and following defines.
1813 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1814 * don't forget to change increment constant. */
Ladislav Michla73b87e2010-06-27 03:23:31 +02001815#define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
Aurelien Jarnod3a42392012-07-24 16:28:34 +02001816extern const char bb_default_login_shell[] ALIGN1;
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001817/* "/bin/sh" */
Ladislav Michla73b87e2010-06-27 03:23:31 +02001818#define DEFAULT_SHELL (bb_default_login_shell+1)
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001819/* "sh" */
Ladislav Michla73b87e2010-06-27 03:23:31 +02001820#define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001821
Jeremie Koenig816ed972010-05-27 15:46:29 +02001822/* The following devices are the same on all systems. */
1823#define CURRENT_TTY "/dev/tty"
1824#define DEV_CONSOLE "/dev/console"
1825
1826#if defined(__FreeBSD_kernel__)
1827# define CURRENT_VC CURRENT_TTY
1828# define VC_1 "/dev/ttyv0"
1829# define VC_2 "/dev/ttyv1"
1830# define VC_3 "/dev/ttyv2"
1831# define VC_4 "/dev/ttyv3"
1832# define VC_5 "/dev/ttyv4"
1833# define VC_FORMAT "/dev/ttyv%d"
1834#elif defined(__GNU__)
1835# define CURRENT_VC CURRENT_TTY
1836# define VC_1 "/dev/tty1"
1837# define VC_2 "/dev/tty2"
1838# define VC_3 "/dev/tty3"
1839# define VC_4 "/dev/tty4"
1840# define VC_5 "/dev/tty5"
1841# define VC_FORMAT "/dev/tty%d"
Denys Vlasenko1c26e052010-10-24 02:35:17 +02001842#elif ENABLE_FEATURE_DEVFS
1843/*Linux, obsolete devfs names */
Matt Kraai439e3df2001-07-23 14:52:08 +00001844# define CURRENT_VC "/dev/vc/0"
1845# define VC_1 "/dev/vc/1"
1846# define VC_2 "/dev/vc/2"
1847# define VC_3 "/dev/vc/3"
1848# define VC_4 "/dev/vc/4"
1849# define VC_5 "/dev/vc/5"
Matt Kraai439e3df2001-07-23 14:52:08 +00001850# define VC_FORMAT "/dev/vc/%d"
Denys Vlasenko4928e9f2013-06-27 03:45:16 +02001851# define LOOP_FORMAT "/dev/loop/%u"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001852# define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001853# define LOOP_NAME "/dev/loop/"
Eric Andersen5f284552003-11-14 03:11:29 +00001854# define FB_0 "/dev/fb/0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001855#else
Denys Vlasenko1c26e052010-10-24 02:35:17 +02001856/*Linux, normal names */
Matt Kraai439e3df2001-07-23 14:52:08 +00001857# define CURRENT_VC "/dev/tty0"
1858# define VC_1 "/dev/tty1"
1859# define VC_2 "/dev/tty2"
1860# define VC_3 "/dev/tty3"
1861# define VC_4 "/dev/tty4"
1862# define VC_5 "/dev/tty5"
Matt Kraai439e3df2001-07-23 14:52:08 +00001863# define VC_FORMAT "/dev/tty%d"
Denys Vlasenko4928e9f2013-06-27 03:45:16 +02001864# define LOOP_FORMAT "/dev/loop%u"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001865# define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001866# define LOOP_NAME "/dev/loop"
Eric Andersen5f284552003-11-14 03:11:29 +00001867# define FB_0 "/dev/fb0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001868#endif
1869
Rob Landleyc57ec372006-04-10 17:07:15 +00001870
Denys Vlasenko9d57a802009-10-23 14:24:44 +02001871#define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
1872
Rob Landleyb623a542006-05-31 22:09:03 +00001873
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001874/* We redefine ctype macros. Unicode-correct handling of char types
1875 * can't be done with such byte-oriented operations anyway,
1876 * we don't lose anything.
1877 */
Rob Landley4ae905a2006-07-06 17:22:54 +00001878#undef isalnum
1879#undef isalpha
1880#undef isascii
1881#undef isblank
1882#undef iscntrl
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001883#undef isdigit
Rob Landley4ae905a2006-07-06 17:22:54 +00001884#undef isgraph
1885#undef islower
1886#undef isprint
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001887#undef ispunct
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001888#undef isspace
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001889#undef isupper
1890#undef isxdigit
1891#undef toupper
1892#undef tolower
Rob Landley4ae905a2006-07-06 17:22:54 +00001893
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001894/* We save ~500 bytes on isdigit alone.
Denys Vlasenko7b4cd6f2009-10-23 02:22:03 +02001895 * BTW, x86 likes (unsigned char) cast more than (unsigned). */
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001896
1897/* These work the same for ASCII and Unicode,
1898 * assuming no one asks "is this a *Unicode* letter?" using isalpha(letter) */
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001899#define isascii(a) ((unsigned char)(a) <= 0x7f)
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001900#define isdigit(a) ((unsigned char)((a) - '0') <= 9)
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001901#define isupper(a) ((unsigned char)((a) - 'A') <= ('Z' - 'A'))
1902#define islower(a) ((unsigned char)((a) - 'a') <= ('z' - 'a'))
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001903#define isalpha(a) ((unsigned char)(((a)|0x20) - 'a') <= ('z' - 'a'))
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001904#define isblank(a) ({ unsigned char bb__isblank = (a); bb__isblank == ' ' || bb__isblank == '\t'; })
1905#define iscntrl(a) ({ unsigned char bb__iscntrl = (a); bb__iscntrl < ' ' || bb__iscntrl == 0x7f; })
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001906/* In POSIX/C locale isspace is only these chars: "\t\n\v\f\r" and space.
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001907 * "\t\n\v\f\r" happen to have ASCII codes 9,10,11,12,13.
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001908 */
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001909#define isspace(a) ({ unsigned char bb__isspace = (a) - 9; bb__isspace == (' ' - 9) || bb__isspace <= (13 - 9); })
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001910// Unsafe wrt NUL: #define ispunct(a) (strchr("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a)) != NULL)
1911#define ispunct(a) (strchrnul("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a))[0])
1912// 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 +02001913#define isalnum(a) bb_ascii_isalnum(a)
1914static ALWAYS_INLINE int bb_ascii_isalnum(unsigned char a)
1915{
1916 unsigned char b = a - '0';
1917 if (b <= 9)
1918 return (b <= 9);
1919 b = (a|0x20) - 'a';
1920 return b <= 'z' - 'a';
1921}
1922#define isxdigit(a) bb_ascii_isxdigit(a)
1923static ALWAYS_INLINE int bb_ascii_isxdigit(unsigned char a)
1924{
1925 unsigned char b = a - '0';
1926 if (b <= 9)
1927 return (b <= 9);
1928 b = (a|0x20) - 'a';
1929 return b <= 'f' - 'a';
1930}
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001931#define toupper(a) bb_ascii_toupper(a)
1932static ALWAYS_INLINE unsigned char bb_ascii_toupper(unsigned char a)
1933{
1934 unsigned char b = a - 'a';
1935 if (b <= ('z' - 'a'))
1936 a -= 'a' - 'A';
1937 return a;
1938}
1939#define tolower(a) bb_ascii_tolower(a)
1940static ALWAYS_INLINE unsigned char bb_ascii_tolower(unsigned char a)
1941{
1942 unsigned char b = a - 'A';
1943 if (b <= ('Z' - 'A'))
1944 a += 'a' - 'A';
1945 return a;
1946}
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001947
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001948/* In ASCII and Unicode, these are likely to be very different.
1949 * Let's prevent ambiguous usage from the start */
1950#define isgraph(a) isgraph_is_ambiguous_dont_use(a)
1951#define isprint(a) isprint_is_ambiguous_dont_use(a)
1952/* NB: must not treat EOF as isgraph or isprint */
1953#define isgraph_asciionly(a) ((unsigned)((a) - 0x21) <= 0x7e - 0x21)
1954#define isprint_asciionly(a) ((unsigned)((a) - 0x20) <= 0x7e - 0x20)
1955
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001956
Bartosz Golaszewski3ed81cf2014-06-22 16:30:41 +02001957/* Simple unit-testing framework */
1958
1959typedef void (*bbunit_testfunc)(void);
1960
1961struct bbunit_listelem {
1962 struct bbunit_listelem* next;
1963 const char* name;
1964 bbunit_testfunc testfunc;
1965};
1966
1967void bbunit_registertest(struct bbunit_listelem* test);
1968void bbunit_settestfailed(void);
1969
1970#define BBUNIT_DEFINE_TEST(NAME) \
1971 static void bbunit_##NAME##_test(void); \
1972 static struct bbunit_listelem bbunit_##NAME##_elem = { \
1973 .name = #NAME, \
1974 .testfunc = bbunit_##NAME##_test, \
1975 }; \
Bartosz Golaszewskibf0f2c72014-06-26 14:31:05 +02001976 static void INIT_FUNC bbunit_##NAME##_register(void) \
Bartosz Golaszewski3ed81cf2014-06-22 16:30:41 +02001977 { \
1978 bbunit_registertest(&bbunit_##NAME##_elem); \
1979 } \
1980 static void bbunit_##NAME##_test(void)
1981
1982/*
1983 * Both 'goto bbunit_end' and 'break' are here only to get rid
1984 * of compiler warnings.
1985 */
1986#define BBUNIT_ENDTEST \
1987 do { \
1988 goto bbunit_end; \
1989 bbunit_end: \
1990 break; \
1991 } while (0)
1992
1993#define BBUNIT_PRINTASSERTFAIL \
1994 do { \
1995 bb_error_msg( \
1996 "[ERROR] Assertion failed in file %s, line %d", \
1997 __FILE__, __LINE__); \
1998 } while (0)
1999
2000#define BBUNIT_ASSERTION_FAILED \
2001 do { \
2002 bbunit_settestfailed(); \
2003 goto bbunit_end; \
2004 } while (0)
2005
2006/*
2007 * Assertions.
2008 * For now we only offer assertions which cause tests to fail
2009 * immediately. In the future 'expects' might be added too -
2010 * similar to those offered by the gtest framework.
2011 */
2012#define BBUNIT_ASSERT_EQ(EXPECTED, ACTUAL) \
2013 do { \
2014 if ((EXPECTED) != (ACTUAL)) { \
2015 BBUNIT_PRINTASSERTFAIL; \
2016 bb_error_msg("[ERROR] '%s' isn't equal to '%s'", \
2017 #EXPECTED, #ACTUAL); \
2018 BBUNIT_ASSERTION_FAILED; \
2019 } \
2020 } while (0)
2021
2022#define BBUNIT_ASSERT_NOTEQ(EXPECTED, ACTUAL) \
2023 do { \
2024 if ((EXPECTED) == (ACTUAL)) { \
2025 BBUNIT_PRINTASSERTFAIL; \
2026 bb_error_msg("[ERROR] '%s' is equal to '%s'", \
2027 #EXPECTED, #ACTUAL); \
2028 BBUNIT_ASSERTION_FAILED; \
2029 } \
2030 } while (0)
2031
2032#define BBUNIT_ASSERT_NOTNULL(PTR) \
2033 do { \
2034 if ((PTR) == NULL) { \
2035 BBUNIT_PRINTASSERTFAIL; \
2036 bb_error_msg("[ERROR] '%s' is NULL!", #PTR); \
2037 BBUNIT_ASSERTION_FAILED; \
2038 } \
2039 } while (0)
2040
2041#define BBUNIT_ASSERT_NULL(PTR) \
2042 do { \
2043 if ((PTR) != NULL) { \
2044 BBUNIT_PRINTASSERTFAIL; \
2045 bb_error_msg("[ERROR] '%s' is not NULL!", #PTR); \
2046 BBUNIT_ASSERTION_FAILED; \
2047 } \
2048 } while (0)
2049
2050#define BBUNIT_ASSERT_FALSE(STATEMENT) \
2051 do { \
2052 if ((STATEMENT)) { \
2053 BBUNIT_PRINTASSERTFAIL; \
2054 bb_error_msg("[ERROR] Statement '%s' evaluated to true!", \
2055 #STATEMENT); \
2056 BBUNIT_ASSERTION_FAILED; \
2057 } \
2058 } while (0)
2059
2060#define BBUNIT_ASSERT_TRUE(STATEMENT) \
2061 do { \
2062 if (!(STATEMENT)) { \
2063 BBUNIT_PRINTASSERTFAIL; \
2064 bb_error_msg("[ERROR] Statement '%s' evaluated to false!", \
2065 #STATEMENT); \
2066 BBUNIT_ASSERTION_FAILED; \
2067 } \
2068 } while (0)
2069
2070#define BBUNIT_ASSERT_STREQ(STR1, STR2) \
2071 do { \
2072 if (strcmp(STR1, STR2) != 0) { \
2073 BBUNIT_PRINTASSERTFAIL; \
2074 bb_error_msg("[ERROR] Strings '%s' and '%s' " \
2075 "are not the same", STR1, STR2); \
2076 BBUNIT_ASSERTION_FAILED; \
2077 } \
2078 } while (0)
2079
2080#define BBUNIT_ASSERT_STRNOTEQ(STR1, STR2) \
2081 do { \
2082 if (strcmp(STR1, STR2) == 0) { \
2083 BBUNIT_PRINTASSERTFAIL; \
2084 bb_error_msg("[ERROR] Strings '%s' and '%s' " \
2085 "are the same, but were " \
2086 "expected to differ", STR1, STR2); \
2087 BBUNIT_ASSERTION_FAILED; \
2088 } \
2089 } while (0)
2090
2091
Denis Vlasenkof81e8db2009-04-09 12:35:13 +00002092POP_SAVED_FUNCTION_VISIBILITY
2093
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +00002094#endif