blob: 5e5c8c7e89bfd9a13991fa47cb938929cecd1b03 [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>
Denys Vlasenkod48fdde2011-09-10 13:48:34 +020035/* There are two incompatible basename's, let not use them! */
36/* See the dirname/basename man page for details */
37#include <libgen.h> /* dirname,basename */
38#undef basename
39#define basename dont_use_basename
Denis Vlasenkob308d812007-08-28 19:35:34 +000040#include <sys/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,
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000337};
Denys Vlasenkoa40f0622010-01-15 22:05:07 +0100338#define FILEUTILS_CP_OPTSTR "pdRfilsLH" IF_SELINUX("c")
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000339extern int remove_file(const char *path, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000340/* NB: without FILEUTILS_RECUR in flags, it will basically "cat"
341 * the source, not copy (unless "source" is a directory).
342 * This makes "cp /dev/null file" and "install /dev/null file" (!!!)
343 * work coreutils-compatibly. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000344extern int copy_file(const char *source, const char *dest, int flags) FAST_FUNC;
Denis Vlasenkob9ad75f2008-03-28 17:49:31 +0000345
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000346enum {
Denis Vlasenkod166f832007-07-05 00:12:55 +0000347 ACTION_RECURSE = (1 << 0),
348 ACTION_FOLLOWLINKS = (1 << 1),
349 ACTION_FOLLOWLINKS_L0 = (1 << 2),
350 ACTION_DEPTHFIRST = (1 << 3),
351 /*ACTION_REVERSE = (1 << 4), - unused */
Denis Vlasenko6e69e422008-07-27 12:10:07 +0000352 ACTION_QUIET = (1 << 5),
Denys Vlasenko8f7a6d22009-09-29 11:07:04 +0200353 ACTION_DANGLING_OK = (1 << 6),
Denis Vlasenkobbd695d2007-04-08 10:52:28 +0000354};
Denys Vlasenko8f7a6d22009-09-29 11:07:04 +0200355typedef uint8_t recurse_flags_t;
Bernhard Reutner-Fischer3e816c12007-03-29 10:30:50 +0000356extern int recursive_action(const char *fileName, unsigned flags,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000357 int FAST_FUNC (*fileAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
358 int FAST_FUNC (*dirAction)(const char *fileName, struct stat* statbuf, void* userData, int depth),
359 void* userData, unsigned depth) FAST_FUNC;
360extern int device_open(const char *device, int mode) FAST_FUNC;
Denis Vlasenko85c24712008-03-17 09:04:04 +0000361enum { GETPTY_BUFSIZE = 16 }; /* more than enough for "/dev/ttyXXX" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000362extern int xgetpty(char *line) FAST_FUNC;
Denis Vlasenko2afd5ab2008-08-05 23:32:27 +0000363extern int get_console_fd_or_die(void) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000364extern void console_make_active(int fd, const int vt_num) FAST_FUNC;
365extern char *find_block_device(const char *path) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000366/* bb_copyfd_XX print read/write errors and return -1 if they occur */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000367extern off_t bb_copyfd_eof(int fd1, int fd2) FAST_FUNC;
368extern off_t bb_copyfd_size(int fd1, int fd2, off_t size) FAST_FUNC;
369extern void bb_copyfd_exact_size(int fd1, int fd2, off_t size) FAST_FUNC;
Denis Vlasenko714701c2006-12-22 00:21:07 +0000370/* "short" copy can be detected by return value < size */
371/* this helper yells "short read!" if param is not -1 */
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000372extern void complain_copyfd_and_die(off_t sz) NORETURN FAST_FUNC;
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +0200373
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000374extern char bb_process_escape_sequence(const char **ptr) FAST_FUNC;
Denys Vlasenko53600592010-10-23 21:06:06 +0200375char* strcpy_and_process_escape_sequences(char *dst, const char *src) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000376/* xxxx_strip version can modify its parameter:
377 * "/" -> "/"
378 * "abc" -> "abc"
379 * "abc/def" -> "def"
380 * "abc/def/" -> "def" !!
381 */
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +0200382char *bb_get_last_path_component_strip(char *path) FAST_FUNC;
Denis Vlasenko818322b2007-09-24 18:27:04 +0000383/* "abc/def/" -> "" and it never modifies 'path' */
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +0200384char *bb_get_last_path_component_nostrip(const char *path) FAST_FUNC;
385/* Simpler version: does not special case "/" string */
386const char *bb_basename(const char *name) FAST_FUNC;
387/* NB: can violate const-ness (similarly to strchr) */
388char *last_char_is(const char *s, int c) FAST_FUNC;
Denis Vlasenkocad04ef2007-03-25 23:21:05 +0000389
Denys Vlasenkoe9a40e32011-01-24 00:29:55 +0100390void ndelay_on(int fd) FAST_FUNC;
391void ndelay_off(int fd) FAST_FUNC;
392void close_on_exec_on(int fd) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000393void xdup2(int, int) FAST_FUNC;
394void xmove_fd(int, int) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000395
396
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000397DIR *xopendir(const char *path) FAST_FUNC;
398DIR *warn_opendir(const char *path) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000399
Jérémie Koenigfbedacf2010-03-26 19:08:53 +0100400char *xmalloc_realpath(const char *path) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100401char *xmalloc_readlink(const char *path) FAST_FUNC RETURNS_MALLOC;
402char *xmalloc_readlink_or_warn(const char *path) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkob57eee82009-11-04 17:54:17 +0100403/* !RETURNS_MALLOC: it's a realloc-like function */
404char *xrealloc_getcwd_or_warn(char *cwd) FAST_FUNC;
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000405
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100406char *xmalloc_follow_symlinks(const char *path) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko473dae02007-04-11 07:04:23 +0000407
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000408
Denis Vlasenko33196372008-02-23 01:25:38 +0000409enum {
Denis Vlasenkocf7cf622008-03-19 19:38:46 +0000410 /* bb_signals(BB_FATAL_SIGS, handler) catches all signals which
Denis Vlasenko33196372008-02-23 01:25:38 +0000411 * otherwise would kill us, except for those resulting from bugs:
412 * SIGSEGV, SIGILL, SIGFPE.
413 * Other fatal signals not included (TODO?):
414 * SIGBUS Bus error (bad memory access)
415 * SIGPOLL Pollable event. Synonym of SIGIO
416 * SIGPROF Profiling timer expired
417 * SIGSYS Bad argument to routine
418 * SIGTRAP Trace/breakpoint trap
Denis Vlasenkod943af02008-03-30 15:56:38 +0000419 *
420 * The only known arch with some of these sigs not fitting
421 * into 32 bits is parisc (SIGXCPU=33, SIGXFSZ=34, SIGSTKFLT=36).
422 * Dance around with long long to guard against that...
Denis Vlasenko33196372008-02-23 01:25:38 +0000423 */
Denis Vlasenkod943af02008-03-30 15:56:38 +0000424 BB_FATAL_SIGS = (int)(0
425 + (1LL << SIGHUP)
426 + (1LL << SIGINT)
427 + (1LL << SIGTERM)
428 + (1LL << SIGPIPE) // Write to pipe with no readers
429 + (1LL << SIGQUIT) // Quit from keyboard
430 + (1LL << SIGABRT) // Abort signal from abort(3)
431 + (1LL << SIGALRM) // Timer signal from alarm(2)
432 + (1LL << SIGVTALRM) // Virtual alarm clock
433 + (1LL << SIGXCPU) // CPU time limit exceeded
434 + (1LL << SIGXFSZ) // File size limit exceeded
435 + (1LL << SIGUSR1) // Yes kids, these are also fatal!
436 + (1LL << SIGUSR2)
437 + 0),
Denis Vlasenko33196372008-02-23 01:25:38 +0000438};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000439void bb_signals(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko25591c32008-02-16 22:58:56 +0000440/* Unlike signal() and bb_signals, sets handler with sigaction()
441 * and in a way that while signal handler is run, no other signals
Denis Vlasenkocab28aa2009-01-31 01:02:07 +0000442 * will be blocked; syscalls will not be restarted: */
443void bb_signals_recursive_norestart(int sigs, void (*f)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000444/* syscalls like read() will be interrupted with EINTR: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000445void signal_no_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
Denis Vlasenko8e2cfec2008-03-12 23:19:35 +0000446/* syscalls like read() won't be interrupted (though select/poll will be): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000447void signal_SA_RESTART_empty_mask(int sig, void (*handler)(int)) FAST_FUNC;
448void wait_for_any_sig(void) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000449void kill_myself_with_sig(int sig) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000450void sig_block(int sig) FAST_FUNC;
451void sig_unblock(int sig) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000452/* Will do sigaction(signum, act, NULL): */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000453int sigaction_set(int sig, const struct sigaction *act) FAST_FUNC;
Denis Vlasenko3f165fa2008-03-17 08:29:08 +0000454/* SIG_BLOCK/SIG_UNBLOCK all signals: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000455int sigprocmask_allsigs(int how) FAST_FUNC;
Denis Vlasenko08ea11a2008-09-11 19:51:11 +0000456/* Standard handler which just records signo */
457extern smallint bb_got_signal;
458void record_signo(int signo); /* not FAST_FUNC! */
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000459
Denis Vlasenko2856dab2007-04-01 01:18:20 +0000460
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000461void xsetgid(gid_t gid) FAST_FUNC;
462void xsetuid(uid_t uid) FAST_FUNC;
463void xchdir(const char *path) FAST_FUNC;
464void xchroot(const char *path) FAST_FUNC;
465void xsetenv(const char *key, const char *value) FAST_FUNC;
Denis Vlasenko76ddc2e2008-12-30 05:05:31 +0000466void bb_unsetenv(const char *key) FAST_FUNC;
Denys Vlasenkodd8adde2010-06-24 05:00:50 +0200467void bb_unsetenv_and_free(char *key) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000468void xunlink(const char *pathname) FAST_FUNC;
469void xstat(const char *pathname, struct stat *buf) FAST_FUNC;
Denys Vlasenko8d3e2252010-08-31 12:42:06 +0200470void xfstat(int fd, struct stat *buf, const char *errmsg) FAST_FUNC;
Denys Vlasenkof2a8d5d2009-08-21 17:40:36 +0200471int xopen(const char *pathname, int flags) FAST_FUNC;
Bernhard Reutner-Fischera4830872009-10-26 23:27:08 +0100472int xopen_nonblocking(const char *pathname) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000473int xopen3(const char *pathname, int flags, int mode) FAST_FUNC;
474int open_or_warn(const char *pathname, int flags) FAST_FUNC;
475int open3_or_warn(const char *pathname, int flags, int mode) FAST_FUNC;
476int open_or_warn_stdin(const char *pathname) FAST_FUNC;
Denys Vlasenkoe7b0a9e2010-08-22 05:39:15 +0200477int xopen_stdin(const char *pathname) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000478void xrename(const char *oldpath, const char *newpath) FAST_FUNC;
479int rename_or_warn(const char *oldpath, const char *newpath) FAST_FUNC;
480off_t xlseek(int fd, off_t offset, int whence) FAST_FUNC;
Alexander Shishkin67227372010-10-22 13:27:16 +0200481int xmkstemp(char *template) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000482off_t fdlength(int fd) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000483
Denys Vlasenko40e7d252010-02-01 23:48:27 +0100484uoff_t FAST_FUNC get_volume_size_in_bytes(int fd,
485 const char *override,
486 unsigned override_units,
487 int extend);
488
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000489void xpipe(int filedes[2]) FAST_FUNC;
Denis Vlasenko37188322008-02-16 13:20:56 +0000490/* In this form code with pipes is much more readable */
491struct fd_pair { int rd; int wr; };
492#define piped_pair(pair) pipe(&((pair).rd))
493#define xpiped_pair(pair) xpipe(&((pair).rd))
494
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000495/* Useful for having small structure members/global variables */
496typedef int8_t socktype_t;
497typedef int8_t family_t;
498struct BUG_too_small {
499 char BUG_socktype_t_too_small[(0
500 | SOCK_STREAM
501 | SOCK_DGRAM
502 | SOCK_RDM
503 | SOCK_SEQPACKET
504 | SOCK_RAW
505 ) <= 127 ? 1 : -1];
506 char BUG_family_t_too_small[(0
507 | AF_UNSPEC
508 | AF_INET
509 | AF_INET6
510 | AF_UNIX
Mike Frysinger9412ec72008-02-07 22:41:33 +0000511#ifdef AF_PACKET
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000512 | AF_PACKET
Mike Frysinger9412ec72008-02-07 22:41:33 +0000513#endif
514#ifdef AF_NETLINK
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000515 | AF_NETLINK
Mike Frysinger9412ec72008-02-07 22:41:33 +0000516#endif
Denis Vlasenkoed6a49c2007-11-18 22:56:25 +0000517 /* | AF_DECnet */
518 /* | AF_IPX */
519 ) <= 127 ? 1 : -1];
520};
521
522
Denys Vlasenkodc698bb2010-01-09 19:10:49 +0100523void parse_datestr(const char *date_str, struct tm *ptm) FAST_FUNC;
524time_t validate_tm_time(const char *date_str, struct tm *ptm) FAST_FUNC;
Denys Vlasenko73b71f32009-07-18 03:40:35 +0200525
526
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000527int xsocket(int domain, int type, int protocol) FAST_FUNC;
528void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen) FAST_FUNC;
529void xlisten(int s, int backlog) FAST_FUNC;
530void xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen) FAST_FUNC;
Denis Vlasenkodbe6e662007-08-14 16:43:01 +0000531ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000532 socklen_t tolen) FAST_FUNC;
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000533/* SO_REUSEADDR allows a server to rebind to an address that is already
534 * "in use" by old connections to e.g. previous server instance which is
535 * killed or crashed. Without it bind will fail until all such connections
536 * time out. Linux does not allow multiple live binds on same ip:port
537 * regardless of SO_REUSEADDR (unlike some other flavors of Unix).
538 * Turn it on before you call bind(). */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000539void setsockopt_reuseaddr(int fd) FAST_FUNC; /* On Linux this never fails. */
540int setsockopt_broadcast(int fd) FAST_FUNC;
Denis Vlasenkoe5373852008-12-10 11:12:16 +0000541int setsockopt_bindtodevice(int fd, const char *iface) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000542/* NB: returns port in host byte order */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000543unsigned bb_lookup_port(const char *port, const char *protocol, unsigned default_port) FAST_FUNC;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000544typedef struct len_and_sockaddr {
Denis Vlasenko0850cda2007-02-07 23:20:32 +0000545 socklen_t len;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000546 union {
547 struct sockaddr sa;
548 struct sockaddr_in sin;
549#if ENABLE_FEATURE_IPV6
550 struct sockaddr_in6 sin6;
551#endif
Bernhard Reutner-Fischer8c69afd2008-01-29 10:33:34 +0000552 } u;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000553} len_and_sockaddr;
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000554enum {
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000555 LSA_LEN_SIZE = offsetof(len_and_sockaddr, u),
Denis Vlasenko992e05b2007-04-03 01:13:04 +0000556 LSA_SIZEOF_SA = sizeof(
557 union {
558 struct sockaddr sa;
559 struct sockaddr_in sin;
560#if ENABLE_FEATURE_IPV6
561 struct sockaddr_in6 sin6;
562#endif
563 }
564 )
565};
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000566/* Create stream socket, and allocate suitable lsa.
567 * (lsa of correct size and lsa->sa.sa_family (AF_INET/AF_INET6))
Denis Vlasenkobeffd432007-09-05 11:30:34 +0000568 * af == AF_UNSPEC will result in trying to create IPv6 socket,
Denys Vlasenkob1278a32009-11-24 16:03:47 +0100569 * and if kernel doesn't support it, fall back to IPv4.
570 * This is useful if you plan to bind to resulting local lsa.
Denis Vlasenko5c51a7c2007-06-05 20:08:11 +0000571 */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000572int xsocket_type(len_and_sockaddr **lsap, int af, int sock_type) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000573int xsocket_stream(len_and_sockaddr **lsap) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000574/* Create server socket bound to bindaddr:port. bindaddr can be NULL,
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000575 * numeric IP ("N.N.N.N") or numeric IPv6 address,
576 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000577 * Only if there is no suffix, port argument is used */
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000578/* NB: these set SO_REUSEADDR before bind */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000579int create_and_bind_stream_or_die(const char *bindaddr, int port) FAST_FUNC;
580int create_and_bind_dgram_or_die(const char *bindaddr, int port) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000581/* Create client TCP socket connected to peer:port. Peer cannot be NULL.
582 * Peer can be numeric IP ("N.N.N.N"), numeric IPv6 address or hostname,
583 * and can have ":PORT" suffix (for IPv6 use "[X:X:...:X]:PORT").
584 * If there is no suffix, port argument is used */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000585int create_and_connect_stream_or_die(const char *peer, int port) FAST_FUNC;
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000586/* Connect to peer identified by lsa */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000587int xconnect_stream(const len_and_sockaddr *lsa) FAST_FUNC;
Denis Vlasenko73c571a2009-03-09 00:12:37 +0000588/* Get local address of bound or accepted socket */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100589len_and_sockaddr *get_sock_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenkof6916db2010-04-06 17:43:29 +0200590/* Get remote address of connected or accepted socket */
591len_and_sockaddr *get_peer_lsa(int fd) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkobbe51462007-01-10 20:19:56 +0000592/* Return malloc'ed len_and_sockaddr with socket address of host:port
593 * Currently will return IPv4 or IPv6 sockaddrs only
594 * (depending on host), but in theory nothing prevents e.g.
Denis Vlasenko5870ad92007-02-04 02:39:55 +0000595 * UNIX socket address being returned, IPX sockaddr etc...
596 * On error does bb_error_msg and returns NULL */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100597len_and_sockaddr* host2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000598/* Version which dies on error */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100599len_and_sockaddr* xhost2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
600len_and_sockaddr* xdotted2sockaddr(const char *host, int port) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000601/* Same, useful if you want to force family (e.g. IPv6) */
Denis Vlasenko4e6d5112008-03-12 22:14:34 +0000602#if !ENABLE_FEATURE_IPV6
603#define host_and_af2sockaddr(host, port, af) host2sockaddr((host), (port))
604#define xhost_and_af2sockaddr(host, port, af) xhost2sockaddr((host), (port))
605#else
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100606len_and_sockaddr* host_and_af2sockaddr(const char *host, int port, sa_family_t af) FAST_FUNC RETURNS_MALLOC;
607len_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 +0000608#endif
Denis Vlasenko7f175cc2007-08-16 18:27:47 +0000609/* Assign sin[6]_port member if the socket is an AF_INET[6] one,
Denis Vlasenko85629f02007-01-22 09:36:41 +0000610 * otherwise no-op. Useful for ftp.
Denis Vlasenko8e9ccba2007-01-11 16:50:23 +0000611 * NB: does NOT do htons() internally, just direct assignment. */
Denys Vlasenkoca183112011-04-07 17:52:20 +0200612void set_nport(struct sockaddr *sa, unsigned port) FAST_FUNC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000613/* Retrieve sin[6]_port or return -1 for non-INET[6] lsa's */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000614int get_nport(const struct sockaddr *sa) FAST_FUNC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000615/* Reverse DNS. Returns NULL on failure. */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100616char* xmalloc_sockaddr2host(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000617/* This one doesn't append :PORTNUM */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100618char* xmalloc_sockaddr2host_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9adc6ce2007-01-22 22:45:27 +0000619/* This one also doesn't fall back to dotted IP (returns NULL) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100620char* xmalloc_sockaddr2hostonly_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko448f0242007-01-22 22:43:05 +0000621/* inet_[ap]ton on steroids */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100622char* xmalloc_sockaddr2dotted(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
623char* xmalloc_sockaddr2dotted_noport(const struct sockaddr *sa) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko85629f02007-01-22 09:36:41 +0000624// "old" (ipv4 only) API
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000625// users: traceroute.c hostname.c - use _list_ of all IPs
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000626struct hostent *xgethostbyname(const char *name) FAST_FUNC;
Denis Vlasenko729bd9e2007-04-02 12:37:28 +0000627// Also mount.c and inetd.c are using gethostbyname(),
Denis Vlasenkoe9913032007-02-04 02:41:57 +0000628// + inet_common.c has additional IPv4-only stuff
Denis Vlasenkoc8717cd2006-11-22 16:10:39 +0000629
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000630
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000631void socket_want_pktinfo(int fd) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000632ssize_t send_to_from(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000633 const struct sockaddr *to,
634 const struct sockaddr *from,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000635 socklen_t tolen) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000636ssize_t recv_from_to(int fd, void *buf, size_t len, int flags,
Denis Vlasenko081eb712008-03-17 09:02:21 +0000637 struct sockaddr *from,
638 struct sockaddr *to,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000639 socklen_t sa_size) FAST_FUNC;
Denis Vlasenko29fe7262007-04-05 20:26:28 +0000640
Baruch Siache8f36332011-09-07 17:52:37 +0200641uint16_t inet_cksum(uint16_t *addr, int len) FAST_FUNC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100642
643char *xstrdup(const char *s) FAST_FUNC RETURNS_MALLOC;
644char *xstrndup(const char *s, int n) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko0f293b92008-07-22 20:16:55 +0000645void overlapping_strcpy(char *dst, const char *src) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000646char *safe_strncpy(char *dst, const char *src, size_t size) FAST_FUNC;
Denis Vlasenko360d9662008-12-02 18:18:50 +0000647char *strncpy_IFNAMSIZ(char *dst, const char *src) FAST_FUNC;
Denis Vlasenko4daad902007-09-27 10:20:47 +0000648/* Guaranteed to NOT be a macro (smallest code). Saves nearly 2k on uclibc.
Denis Vlasenko7c654ae2007-09-27 10:26:59 +0000649 * But potentially slow, don't use in one-billion-times loops */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000650int bb_putchar(int ch) FAST_FUNC;
Denys Vlasenko19ced5c2010-06-06 21:53:09 +0200651/* Note: does not use stdio, writes to fd 2 directly */
652int bb_putchar_stderr(char ch) FAST_FUNC;
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100653char *xasprintf(const char *format, ...) __attribute__ ((format(printf, 1, 2))) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9f739442006-12-16 23:49:13 +0000654// gcc-4.1.1 still isn't good enough at optimizing it
655// (+200 bytes compared to macro)
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000656//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000657//int LONE_DASH(const char *s) { return s[0] == '-' && !s[1]; }
Denis Vlasenko3ad5d0c2007-06-12 20:54:54 +0000658//static ALWAYS_INLINE
Denis Vlasenko9f739442006-12-16 23:49:13 +0000659//int NOT_LONE_DASH(const char *s) { return s[0] != '-' || s[1]; }
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000660#define LONE_DASH(s) ((s)[0] == '-' && !(s)[1])
Denis Vlasenko9f739442006-12-16 23:49:13 +0000661#define NOT_LONE_DASH(s) ((s)[0] != '-' || (s)[1])
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000662#define LONE_CHAR(s,c) ((s)[0] == (c) && !(s)[1])
Denis Vlasenkobf66fbc2006-12-21 13:23:14 +0000663#define NOT_LONE_CHAR(s,c) ((s)[0] != (c) || (s)[1])
Denis Vlasenko16abcd92007-04-13 23:59:52 +0000664#define DOT_OR_DOTDOT(s) ((s)[0] == '.' && (!(s)[1] || ((s)[1] == '.' && !(s)[2])))
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000665
Denys Vlasenkod8528b82010-01-31 05:15:38 +0100666typedef struct uni_stat_t {
667 unsigned byte_count;
668 unsigned unicode_count;
669 unsigned unicode_width;
670} uni_stat_t;
671/* Returns a string with unprintable chars replaced by '?' or
672 * SUBST_WCHAR. This function is unicode-aware. */
673const char* FAST_FUNC printable_string(uni_stat_t *stats, const char *str);
674/* Prints unprintable char ch as ^C or M-c to file
675 * (M-c is used only if ch is ORed with PRINTABLE_META),
676 * else it is printed as-is (except for ch = 0x9b) */
677enum { PRINTABLE_META = 0x100 };
678void fputc_printable(int ch, FILE *file) FAST_FUNC;
679
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000680/* dmalloc will redefine these to it's own implementation. It is safe
681 * to have the prototypes here unconditionally. */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100682void *malloc_or_warn(size_t size) FAST_FUNC RETURNS_MALLOC;
683void *xmalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
684void *xzalloc(size_t size) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkodeeed592008-07-08 05:14:36 +0000685void *xrealloc(void *old, size_t size) FAST_FUNC;
Denys Vlasenko16714242011-09-21 01:59:15 +0200686/* After v = xrealloc_vector(v, SHIFT, idx) it's ok to use
Denis Vlasenko27842282008-08-04 13:20:36 +0000687 * at least v[idx] and v[idx+1], for all idx values.
Denys Vlasenko16714242011-09-21 01:59:15 +0200688 * SHIFT specifies how many new elements are added (1:2, 2:4, ..., 8:256...)
689 * when all elements are used up. New elements are zeroed out.
690 * xrealloc_vector(v, SHIFT, idx) *MUST* be called with consecutive IDXs -
691 * skipping an index is a bad bug - it may miss a realloc!
692 */
Denis Vlasenkodeeed592008-07-08 05:14:36 +0000693#define xrealloc_vector(vector, shift, idx) \
694 xrealloc_vector_helper((vector), (sizeof((vector)[0]) << 8) + (shift), (idx))
695void* xrealloc_vector_helper(void *vector, unsigned sizeof_and_shift, int idx) FAST_FUNC;
696
Eric Andersenaad1a882001-03-16 22:47:14 +0000697
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000698extern ssize_t safe_read(int fd, void *buf, size_t count) FAST_FUNC;
Denys Vlasenko80542ba2011-05-08 21:23:43 +0200699extern 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 +0000700// NB: will return short read on error, not -1,
701// if some data was read before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000702extern ssize_t full_read(int fd, void *buf, size_t count) FAST_FUNC;
703extern void xread(int fd, void *buf, size_t count) FAST_FUNC;
704extern unsigned char xread_char(int fd) FAST_FUNC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000705extern ssize_t read_close(int fd, void *buf, size_t maxsz) FAST_FUNC;
706extern ssize_t open_read_close(const char *filename, void *buf, size_t maxsz) FAST_FUNC;
Denis Vlasenko8ee649a2008-03-26 20:04:27 +0000707// Reads one line a-la fgets (but doesn't save terminating '\n').
708// Reads byte-by-byte. Useful when it is important to not read ahead.
Denis Vlasenkoe376d452008-02-20 22:23:24 +0000709// Bytes are appended to pfx (which must be malloced, or NULL).
Denys Vlasenko80c5b682011-05-08 21:21:10 +0200710extern char *xmalloc_reads(int fd, size_t *maxsz_p) FAST_FUNC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000711/* Reads block up to *maxsz_p (default: INT_MAX - 4095) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100712extern void *xmalloc_read(int fd, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000713/* Returns NULL if file can't be opened (default max size: INT_MAX - 4095) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100714extern void *xmalloc_open_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko094cc512011-01-17 14:58:27 +0100715/* Never returns NULL */
716extern void *xmalloc_xopen_read_close(const char *filename, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denys Vlasenko59655072012-03-06 16:23:50 +0100717
718#define SEAMLESS_COMPRESSION (0 \
719 || ENABLE_FEATURE_SEAMLESS_XZ \
720 || ENABLE_FEATURE_SEAMLESS_LZMA \
721 || ENABLE_FEATURE_SEAMLESS_BZ2 \
722 || ENABLE_FEATURE_SEAMLESS_GZ \
723 || ENABLE_FEATURE_SEAMLESS_Z)
724
Denys Vlasenko8a6a2f92012-03-06 16:27:48 +0100725#if SEAMLESS_COMPRESSION
Denys Vlasenko27653ad2010-05-06 14:19:19 +0000726/* Autodetects gzip/bzip2 formats. fd may be in the middle of the file! */
Denys Vlasenko8a6a2f92012-03-06 16:27:48 +0100727extern int setup_unzip_on_fd(int fd, int fail_if_not_detected) FAST_FUNC;
Denis Vlasenkob6052722008-07-10 17:43:01 +0000728/* Autodetects .gz etc */
Denis Vlasenkoe9ad84d2008-08-05 13:10:34 +0000729extern int open_zipped(const char *fname) FAST_FUNC;
Denys Vlasenko8a6a2f92012-03-06 16:27:48 +0100730#else
731# define setup_unzip_on_fd(...) (0)
732# define open_zipped(fname) open((fname), O_RDONLY);
733#endif
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100734extern void *xmalloc_open_zipped_read_close(const char *fname, size_t *maxsz_p) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoea620772006-10-14 02:23:43 +0000735
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000736extern ssize_t safe_write(int fd, const void *buf, size_t count) FAST_FUNC;
Denis Vlasenko394eebe2008-02-25 20:30:24 +0000737// NB: will return short write on error, not -1,
738// if some data was written before error occurred
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000739extern ssize_t full_write(int fd, const void *buf, size_t count) FAST_FUNC;
740extern void xwrite(int fd, const void *buf, size_t count) FAST_FUNC;
Denis Vlasenko73c571a2009-03-09 00:12:37 +0000741extern void xwrite_str(int fd, const char *str) FAST_FUNC;
Denys Vlasenko729ecb82010-06-07 14:14:26 +0200742extern ssize_t full_write1_str(const char *str) FAST_FUNC;
743extern ssize_t full_write2_str(const char *str) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000744extern void xopen_xwrite_close(const char* file, const char *str) FAST_FUNC;
Denis Vlasenkoea620772006-10-14 02:23:43 +0000745
Denys Vlasenkodcd27ab2009-10-05 03:03:07 +0200746/* Close fd, but check for failures (some types of write errors) */
747extern void xclose(int fd) FAST_FUNC;
748
Denis Vlasenko1de08302006-10-26 23:32:43 +0000749/* Reads and prints to stdout till eof, then closes FILE. Exits on error: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000750extern void xprint_and_close_file(FILE *file) FAST_FUNC;
Denis Vlasenko2132e022008-07-15 10:33:12 +0000751
Denys Vlasenkoa1a44832011-06-17 03:37:43 +0200752/* Reads a line from a text file, up to a newline or NUL byte, inclusive.
753 * Returns malloc'ed char*. If end is NULL '\n' isn't considered
754 * end of line. If end isn't NULL, length of the chunk is stored in it.
755 * Returns NULL if EOF/error.
756 */
Denis Vlasenko2132e022008-07-15 10:33:12 +0000757extern char *bb_get_chunk_from_file(FILE *file, int *end) FAST_FUNC;
Denis Vlasenkoabee3d02007-12-26 20:44:45 +0000758/* Reads up to (and including) TERMINATING_STRING: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100759extern char *xmalloc_fgets_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko9f57cf62009-03-18 17:32:44 +0000760/* Same, with limited max size, and returns the length (excluding NUL): */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100761extern 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 +0000762/* Chops off TERMINATING_STRING from the end: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100763extern char *xmalloc_fgetline_str(FILE *file, const char *terminating_string) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof3745ea2008-04-19 19:32:08 +0000764/* Reads up to (and including) "\n" or NUL byte: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100765extern char *xmalloc_fgets(FILE *file) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000766/* Chops off '\n' from the end, unlike fgets: */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100767extern char *xmalloc_fgetline(FILE *file) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenko2132e022008-07-15 10:33:12 +0000768/* Same, but doesn't try to conserve space (may have some slack after the end) */
Denys Vlasenko53283ad2009-11-02 14:20:34 +0100769/* extern char *xmalloc_fgetline_fast(FILE *file) FAST_FUNC RETURNS_MALLOC; */
Denis Vlasenko2132e022008-07-15 10:33:12 +0000770
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100771void die_if_ferror(FILE *file, const char *msg) FAST_FUNC;
772void die_if_ferror_stdout(void) FAST_FUNC;
773int fflush_all(void) FAST_FUNC;
774void fflush_stdout_and_exit(int retval) NORETURN FAST_FUNC;
775int fclose_if_not_stdin(FILE *file) FAST_FUNC;
776FILE* xfopen(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000777/* Prints warning to stderr and returns NULL on failure: */
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100778FILE* fopen_or_warn(const char *filename, const char *mode) FAST_FUNC;
Denis Vlasenkoddec5af2006-10-26 23:25:17 +0000779/* "Opens" stdin if filename is special, else just opens file: */
Denys Vlasenkoa7ccdee2009-11-15 23:28:11 +0100780FILE* xfopen_stdin(const char *filename) FAST_FUNC;
781FILE* fopen_or_warn_stdin(const char *filename) FAST_FUNC;
782FILE* fopen_for_read(const char *path) FAST_FUNC;
783FILE* xfopen_for_read(const char *path) FAST_FUNC;
784FILE* fopen_for_write(const char *path) FAST_FUNC;
785FILE* xfopen_for_write(const char *path) FAST_FUNC;
786FILE* xfdopen_for_read(int fd) FAST_FUNC;
787FILE* xfdopen_for_write(int fd) FAST_FUNC;
Eric Andersen8876fb22003-06-20 09:01:58 +0000788
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000789int bb_pstrcmp(const void *a, const void *b) /* not FAST_FUNC! */;
790void qsort_string_vector(char **sv, unsigned count) FAST_FUNC;
Denis Vlasenkofb290382008-03-02 12:51:26 +0000791
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000792/* Wrapper which restarts poll on EINTR or ENOMEM.
793 * On other errors complains [perror("poll")] and returns.
794 * Warning! May take (much) longer than timeout_ms to return!
795 * If this is a problem, use bare poll and open-code EINTR/ENOMEM handling */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000796int safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout_ms) FAST_FUNC;
Denis Vlasenko5d61e712007-09-27 10:09:59 +0000797
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000798char *safe_gethostname(void) FAST_FUNC;
Denis Vlasenko6f1713f2008-02-25 23:23:58 +0000799
Bernhard Reutner-Fischer8b1fab22007-04-10 09:38:07 +0000800/* Convert each alpha char in str to lower-case */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000801char* str_tolower(char *str) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000802
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000803char *utoa(unsigned n) FAST_FUNC;
804char *itoa(int n) FAST_FUNC;
Denis Vlasenko10457b92007-03-27 22:01:31 +0000805/* Returns a pointer past the formatted number, does NOT null-terminate */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000806char *utoa_to_buf(unsigned n, char *buf, unsigned buflen) FAST_FUNC;
807char *itoa_to_buf(int n, char *buf, unsigned buflen) FAST_FUNC;
Denis Vlasenko56ea65c2008-01-06 03:26:53 +0000808/* Intelligent formatters of bignums */
Kevin Cernekeeccb07042010-10-25 02:00:24 +0200809void smart_ulltoa4(unsigned long long ul, char buf[4], const char *scale) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000810void smart_ulltoa5(unsigned long long ul, char buf[5], const char *scale) FAST_FUNC;
Denys Vlasenko0bf44d02009-10-13 01:25:09 +0200811/* If block_size == 0, display size without fractional part,
812 * else display (size * block_size) with one decimal digit.
Denys Vlasenko9c3b84a2010-01-18 01:55:00 +0100813 * If display_unit == 0, show value no bigger than 1024 with suffix (K,M,G...),
Denys Vlasenko0bf44d02009-10-13 01:25:09 +0200814 * else divide by display_unit and do not use suffix. */
Denys Vlasenko9c3b84a2010-01-18 01:55:00 +0100815#define HUMAN_READABLE_MAX_WIDTH 7 /* "1024.0G" */
816#define HUMAN_READABLE_MAX_WIDTH_STR "7"
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000817//TODO: provide pointer to buf (avoid statics)?
818const char *make_human_readable_str(unsigned long long size,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000819 unsigned long block_size, unsigned long display_unit) FAST_FUNC;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +0000820/* Put a string of hex bytes ("1b2e66fe"...), return advanced pointer */
Denys Vlasenko1f56e512011-10-19 22:40:35 +0200821char *bin2hex(char *dst, const char *src, int count) FAST_FUNC;
Denys Vlasenko48363312010-04-04 15:29:32 +0200822/* Reverse */
Denys Vlasenko1f56e512011-10-19 22:40:35 +0200823char* hex2bin(char *dst, const char *src, int count) FAST_FUNC;
Rob Landleyc5b1d4d2006-03-13 15:45:16 +0000824
Vladimir Dronnikovdb67a202009-10-15 09:24:25 +0200825/* Generate a UUID */
826void generate_uuid(uint8_t *buf) FAST_FUNC;
827
Denis Vlasenko1bab1de2007-07-27 15:30:39 +0000828/* Last element is marked by mult == 0 */
Eric Andersenaad1a882001-03-16 22:47:14 +0000829struct suffix_mult {
Denis Vlasenkof8689632007-07-27 15:06:25 +0000830 char suffix[4];
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000831 unsigned mult;
Eric Andersenaad1a882001-03-16 22:47:14 +0000832};
Denis Vlasenkoed836cd2006-11-25 14:44:13 +0000833#include "xatonum.h"
Denis Vlasenko13858992006-10-08 12:49:22 +0000834/* Specialized: */
Denys Vlasenko77832482010-08-12 14:14:45 +0200835
Denis Vlasenko13858992006-10-08 12:49:22 +0000836/* Using xatoi() instead of naive atoi() is not always convenient -
837 * in many places people want *non-negative* values, but store them
838 * in signed int. Therefore we need this one:
Denys Vlasenko77832482010-08-12 14:14:45 +0200839 * dies if input is not in [0, INT_MAX] range. Also will reject '-0' etc.
840 * It should really be named xatoi_nonnegative (since it allows 0),
841 * but that would be too long.
842 */
843int xatoi_positive(const char *numstr) FAST_FUNC;
844
Denis Vlasenko13858992006-10-08 12:49:22 +0000845/* Useful for reading port numbers */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000846uint16_t xatou16(const char *numstr) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +0000847
Denis Vlasenkodca0b702006-10-27 09:05:02 +0000848
Eric Andersenaad1a882001-03-16 22:47:14 +0000849/* These parse entries in /etc/passwd and /etc/group. This is desirable
850 * for BusyBox since we want to avoid using the glibc NSS stuff, which
Bernhard Reutner-Fischerd5bd1372005-09-20 21:06:17 +0000851 * increases target size and is often not needed on embedded systems. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000852long xuname2uid(const char *name) FAST_FUNC;
853long xgroup2gid(const char *name) FAST_FUNC;
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000854/* wrapper: allows string to contain numeric uid or gid */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000855unsigned long get_ug_id(const char *s, long FAST_FUNC (*xname2id)(const char *)) FAST_FUNC;
Denis Vlasenko9a44c4f2006-12-28 05:44:47 +0000856/* from chpst. Does not die, returns 0 on failure */
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000857struct bb_uidgid_t {
Denis Vlasenko150f4022007-01-13 21:06:21 +0000858 uid_t uid;
859 gid_t gid;
Denis Vlasenkode59c0f2006-10-05 22:50:22 +0000860};
Denis Vlasenkocce38582007-02-26 22:47:42 +0000861/* always sets uid and gid */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000862int get_uidgid(struct bb_uidgid_t*, const char*, int numeric_ok) FAST_FUNC;
Bernhard Reutner-Fischerd73cbd32008-07-21 14:41:33 +0000863/* always sets uid and gid, allows numeric; exits on failure */
864void xget_uidgid(struct bb_uidgid_t*, const char*) FAST_FUNC;
Denis Vlasenkocce38582007-02-26 22:47:42 +0000865/* chown-like handling of "user[:[group]" */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000866void parse_chown_usergroup_or_die(struct bb_uidgid_t *u, char *user_group) FAST_FUNC;
Denis Vlasenkod7a805e2008-12-03 19:05:55 +0000867struct passwd* xgetpwnam(const char *name) FAST_FUNC;
Denis Vlasenko15437e32008-12-05 16:23:06 +0000868struct group* xgetgrnam(const char *name) FAST_FUNC;
Denis Vlasenko0c68a872008-12-02 22:56:59 +0000869struct passwd* xgetpwuid(uid_t uid) FAST_FUNC;
870struct group* xgetgrgid(gid_t gid) FAST_FUNC;
871char* xuid2uname(uid_t uid) FAST_FUNC;
872char* xgid2group(gid_t gid) FAST_FUNC;
873char* uid2uname(uid_t uid) FAST_FUNC;
874char* gid2group(gid_t gid) FAST_FUNC;
Denys Vlasenko7d65abe2011-03-01 16:27:13 +0100875char* uid2uname_utoa(uid_t uid) FAST_FUNC;
876char* gid2group_utoa(gid_t gid) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000877/* versions which cache results (useful for ps, ls etc) */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000878const char* get_cached_username(uid_t uid) FAST_FUNC;
879const char* get_cached_groupname(gid_t gid) FAST_FUNC;
880void clear_username_cache(void) FAST_FUNC;
Denis Vlasenko2405ad62007-01-19 21:24:17 +0000881/* internally usernames are saved in fixed-sized char[] buffers */
Denys Vlasenko7d65abe2011-03-01 16:27:13 +0100882enum { USERNAME_MAX_SIZE = 32 - sizeof(uid_t) };
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +0000883#if ENABLE_FEATURE_CHECK_NAMES
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000884void die_if_bad_username(const char* name) FAST_FUNC;
Denis Vlasenkoa7d6c8b2008-03-19 23:15:26 +0000885#else
886#define die_if_bad_username(name) ((void)(name))
887#endif
Eric Andersenaad1a882001-03-16 22:47:14 +0000888
Denys Vlasenko37f5bef2010-04-05 03:18:40 +0200889#if ENABLE_FEATURE_UTMP
Denys Vlasenko3a416112010-04-05 22:10:38 +0200890void FAST_FUNC write_new_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
891void FAST_FUNC update_utmp(pid_t pid, int new_type, const char *tty_name, const char *username, const char *hostname);
Denys Vlasenko37f5bef2010-04-05 03:18:40 +0200892#else
Denys Vlasenko3a416112010-04-05 22:10:38 +0200893# define write_new_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
894# define update_utmp(pid, new_type, tty_name, username, hostname) ((void)0)
Denys Vlasenko37f5bef2010-04-05 03:18:40 +0200895#endif
896
Denys Vlasenkob72baeb2011-02-02 18:38:57 +0100897
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000898int execable_file(const char *name) FAST_FUNC;
899char *find_execable(const char *filename, char **PATHp) FAST_FUNC;
900int exists_execable(const char *filename) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000901
Denis Vlasenko7e0fbf92007-09-04 19:33:22 +0000902/* BB_EXECxx always execs (it's not doing NOFORK/NOEXEC stuff),
903 * but it may exec busybox and call applet instead of searching PATH.
904 */
Denis Vlasenko80d14be2007-04-10 23:03:30 +0000905#if ENABLE_FEATURE_PREFER_APPLETS
Denys Vlasenkoc71b4692011-02-02 03:28:56 +0100906int BB_EXECVP(const char *file, char *const argv[]) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000907#define BB_EXECLP(prog,cmd,...) \
Denys Vlasenkoc71b4692011-02-02 03:28:56 +0100908 do { \
909 if (find_applet_by_name(prog) >= 0) \
910 execlp(bb_busybox_exec_path, cmd, __VA_ARGS__); \
911 execlp(prog, cmd, __VA_ARGS__); \
912 } while (0)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000913#else
914#define BB_EXECVP(prog,cmd) execvp(prog,cmd)
Denys Vlasenkoc71b4692011-02-02 03:28:56 +0100915#define BB_EXECLP(prog,cmd,...) execlp(prog,cmd,__VA_ARGS__)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000916#endif
Pascal Bellard21e8e8d2010-07-04 00:57:03 +0200917int BB_EXECVP_or_die(char **argv) NORETURN FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000918
Pascal Bellard926031b2010-07-04 15:32:38 +0200919/* xvfork() can't be a _function_, return after vfork mangles stack
920 * in the parent. It must be a macro. */
921#define xvfork() \
922({ \
923 pid_t bb__xvfork_pid = vfork(); \
924 if (bb__xvfork_pid < 0) \
925 bb_perror_msg_and_die("vfork"); \
926 bb__xvfork_pid; \
927})
928#if BB_MMU
929pid_t xfork(void) FAST_FUNC;
930#endif
931
Denys Vlasenko8531d762010-03-18 22:44:00 +0100932/* NOMMU friendy fork+exec: */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000933pid_t spawn(char **argv) FAST_FUNC;
934pid_t xspawn(char **argv) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000935
Denis Vlasenko3854c5d2008-11-06 22:39:57 +0000936pid_t safe_waitpid(pid_t pid, int *wstat, int options) FAST_FUNC;
Denys Vlasenko8531d762010-03-18 22:44:00 +0100937pid_t wait_any_nohang(int *wstat) FAST_FUNC;
938/* wait4pid: unlike waitpid, waits ONLY for one process.
939 * Returns sig + 0x180 if child is killed by signal.
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000940 * It's safe to pass negative 'pids' from failed [v]fork -
Denis Vlasenko473dae02007-04-11 07:04:23 +0000941 * wait4pid will return -1 (and will not clobber [v]fork's errno).
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000942 * IOW: rc = wait4pid(spawn(argv));
943 * if (rc < 0) bb_perror_msg("%s", argv[0]);
Denys Vlasenko8531d762010-03-18 22:44:00 +0100944 * if (rc > 0) bb_error_msg("exit code: %d", rc & 0xff);
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000945 */
Denis Vlasenko3854c5d2008-11-06 22:39:57 +0000946int wait4pid(pid_t pid) FAST_FUNC;
Denys Vlasenko8531d762010-03-18 22:44:00 +0100947/* Same as wait4pid(spawn(argv)), but with NOFORK/NOEXEC if configured: */
Denys Vlasenko8f24f982009-06-07 16:02:00 +0200948int spawn_and_wait(char **argv) FAST_FUNC;
Denis Vlasenko18e19f22007-04-28 16:43:18 +0000949/* Does NOT check that applet is NOFORK, just blindly runs it */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000950int run_nofork_applet(int applet_no, char **argv) FAST_FUNC;
Denis Vlasenkocd7001f2007-04-09 21:32:30 +0000951
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000952/* Helpers for daemonization.
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000953 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000954 * bb_daemonize(flags) = daemonize, does not compile on NOMMU
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000955 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000956 * bb_daemonize_or_rexec(flags, argv) = daemonizes on MMU (and ignores argv),
957 * rexec's itself on NOMMU with argv passed as command line.
958 * Thus bb_daemonize_or_rexec may cause your <applet>_main() to be re-executed
959 * from the start. (It will detect it and not reexec again second time).
960 * You have to audit carefully that you don't do something twice as a result
961 * (opening files/sockets, parsing config files etc...)!
962 *
963 * Both of the above will redirect fd 0,1,2 to /dev/null and drop ctty
964 * (will do setsid()).
965 *
Pascal Bellard926031b2010-07-04 15:32:38 +0200966 * fork_or_rexec(argv) = bare-bones fork on MMU,
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000967 * "vfork + re-exec ourself" on NOMMU. No fd redirection, no setsid().
Denis Vlasenko83518d12009-03-20 22:17:13 +0000968 * On MMU ignores argv.
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000969 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000970 * Helper for network daemons in foreground mode:
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000971 *
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000972 * bb_sanitize_stdio() = make sure that fd 0,1,2 are opened by opening them
973 * to /dev/null if they are not.
974 */
975enum {
976 DAEMON_CHDIR_ROOT = 1,
Denis Vlasenkoa1b16f42007-07-31 17:09:44 +0000977 DAEMON_DEVNULL_STDIO = 2,
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000978 DAEMON_CLOSE_EXTRA_FDS = 4,
979 DAEMON_ONLY_SANITIZE = 8, /* internal use */
Peter Korsgaard743edac2011-11-09 19:44:37 +0100980 DAEMON_DOUBLE_FORK = 16, /* double fork to avoid controlling tty */
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000981};
Denis Vlasenko473dae02007-04-11 07:04:23 +0000982#if BB_MMU
Denis Vlasenko367960b2007-08-18 14:20:21 +0000983 enum { re_execed = 0 };
Pascal Bellard926031b2010-07-04 15:32:38 +0200984# define fork_or_rexec(argv) xfork()
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000985# define bb_daemonize_or_rexec(flags, argv) bb_daemonize_or_rexec(flags)
986# define bb_daemonize(flags) bb_daemonize_or_rexec(flags, bogus)
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +0000987#else
Pascal Bellard926031b2010-07-04 15:32:38 +0200988 extern bool re_execed;
Denys Vlasenkod2277e22011-11-22 17:19:26 +0100989 /* Note: re_exec() and fork_or_rexec() do argv[0][0] |= 0x80 on NOMMU!
990 * _Parent_ needs to undo it if it doesn't want to have argv[0] mangled.
991 */
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +0000992 void re_exec(char **argv) NORETURN FAST_FUNC;
Denis Vlasenko83518d12009-03-20 22:17:13 +0000993 pid_t fork_or_rexec(char **argv) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +0000994 int BUG_fork_is_unavailable_on_nommu(void) FAST_FUNC;
995 int BUG_daemon_is_unavailable_on_nommu(void) FAST_FUNC;
996 void BUG_bb_daemonize_is_unavailable_on_nommu(void) FAST_FUNC;
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000997# define fork() BUG_fork_is_unavailable_on_nommu()
Pascal Bellard926031b2010-07-04 15:32:38 +0200998# define xfork() BUG_fork_is_unavailable_on_nommu()
Denis Vlasenko53091ec2007-03-26 13:35:09 +0000999# define daemon(a,b) BUG_daemon_is_unavailable_on_nommu()
1000# define bb_daemonize(a) BUG_bb_daemonize_is_unavailable_on_nommu()
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001001#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001002void bb_daemonize_or_rexec(int flags, char **argv) FAST_FUNC;
1003void bb_sanitize_stdio(void) FAST_FUNC;
Denis Vlasenkoc9ca0a32008-02-18 11:08:33 +00001004/* Clear dangerous stuff, set PATH. Return 1 if was run by different user. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001005int sanitize_env_if_suid(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001006
1007
Denys Vlasenkoe992bae2009-11-28 15:18:53 +01001008char* single_argv(char **argv) FAST_FUNC;
Denis Vlasenko62a90cd2008-03-17 09:07:36 +00001009extern const char *const bb_argv_dash[]; /* "-", NULL */
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001010extern const char *opt_complementary;
Denys Vlasenkof3b92d32009-06-19 12:10:38 +02001011#if ENABLE_LONG_OPTS || ENABLE_FEATURE_GETOPT_LONG
Denis Vlasenkobdc88fd2007-07-23 17:14:14 +00001012#define No_argument "\0"
1013#define Required_argument "\001"
1014#define Optional_argument "\002"
1015extern const char *applet_long_options;
Denis Vlasenkoc61852a2006-11-29 11:09:43 +00001016#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001017extern uint32_t option_mask32;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001018extern uint32_t getopt32(char **argv, const char *applet_opts, ...) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001019
1020
Denys Vlasenko9be47022011-05-16 12:21:31 +02001021/* Having next pointer as a first member allows easy creation
1022 * of "llist-compatible" structs, and using llist_FOO functions
1023 * on them.
1024 */
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001025typedef struct llist_t {
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001026 struct llist_t *link;
Denys Vlasenko9be47022011-05-16 12:21:31 +02001027 char *data;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001028} llist_t;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001029void llist_add_to(llist_t **old_head, void *data) FAST_FUNC;
1030void llist_add_to_end(llist_t **list_head, void *data) FAST_FUNC;
1031void *llist_pop(llist_t **elm) FAST_FUNC;
1032void llist_unlink(llist_t **head, llist_t *elm) FAST_FUNC;
1033void llist_free(llist_t *elm, void (*freeit)(void *data)) FAST_FUNC;
1034llist_t *llist_rev(llist_t *list) FAST_FUNC;
Denis Vlasenko0b791d92009-04-13 20:52:00 +00001035llist_t *llist_find_str(llist_t *first, const char *str) FAST_FUNC;
Denis Vlasenko4b924f32007-05-30 00:29:55 +00001036/* BTW, surprisingly, changing API to
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001037 * llist_t *llist_add_to(llist_t *old_head, void *data)
1038 * etc does not result in smaller code... */
1039
Denis Vlasenko80edead2007-08-02 22:31:05 +00001040/* start_stop_daemon and udhcpc are special - they want
1041 * to create pidfiles regardless of FEATURE_PIDFILE */
Denis Vlasenko1caca342007-08-02 10:14:29 +00001042#if ENABLE_FEATURE_PIDFILE || defined(WANT_PIDFILE)
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001043/* True only if we created pidfile which is *file*, not /dev/null etc */
1044extern smallint wrote_pidfile;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001045void write_pidfile(const char *path) FAST_FUNC;
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001046#define remove_pidfile(path) do { if (wrote_pidfile) unlink(path); } while (0)
Denis Vlasenko10457b92007-03-27 22:01:31 +00001047#else
Denis Vlasenkobb23c062007-08-15 20:05:37 +00001048enum { wrote_pidfile = 0 };
1049#define write_pidfile(path) ((void)0)
1050#define remove_pidfile(path) ((void)0)
Denis Vlasenko10457b92007-03-27 22:01:31 +00001051#endif
1052
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001053enum {
1054 LOGMODE_NONE = 0,
Denis Vlasenko1b97efd2007-08-17 19:18:06 +00001055 LOGMODE_STDIO = (1 << 0),
1056 LOGMODE_SYSLOG = (1 << 1) * ENABLE_FEATURE_SYSLOG,
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001057 LOGMODE_BOTH = LOGMODE_SYSLOG + LOGMODE_STDIO,
1058};
1059extern const char *msg_eol;
Denis Vlasenko04c99eb2007-04-07 00:44:31 +00001060extern smallint logmode;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001061extern int die_sleep;
Denys Vlasenko7aa63042010-09-01 16:04:24 +02001062extern uint8_t xfunc_error_retval;
Denis Vlasenko3f3aa2a2007-04-09 21:35:07 +00001063extern jmp_buf die_jmp;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001064extern void xfunc_die(void) NORETURN FAST_FUNC;
1065extern void bb_show_usage(void) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001066extern void bb_error_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1067extern void bb_error_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
1068extern void bb_perror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1069extern void bb_simple_perror_msg(const char *s) FAST_FUNC;
1070extern void bb_perror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
Denis Vlasenkofb1a23d2009-03-07 01:54:24 +00001071extern void bb_simple_perror_msg_and_die(const char *s) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001072extern void bb_herror_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1073extern void bb_herror_msg_and_die(const char *s, ...) __attribute__ ((noreturn, format (printf, 1, 2))) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001074extern void bb_perror_nomsg_and_die(void) NORETURN FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001075extern void bb_perror_nomsg(void) FAST_FUNC;
1076extern void bb_info_msg(const char *s, ...) __attribute__ ((format (printf, 1, 2))) FAST_FUNC;
1077extern void bb_verror_msg(const char *s, va_list p, const char *strerr) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001078
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +00001079/* We need to export XXX_main from libbusybox
1080 * only if we build "individual" binaries
1081 */
1082#if ENABLE_FEATURE_INDIVIDUAL
1083#define MAIN_EXTERNALLY_VISIBLE EXTERNALLY_VISIBLE
1084#else
1085#define MAIN_EXTERNALLY_VISIBLE
1086#endif
1087
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001088
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001089/* Applets which are useful from another applets */
Denis Vlasenko06af2162007-02-03 17:28:39 +00001090int bb_cat(char** argv);
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001091/* If shell needs them, they exist even if not enabled as applets */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001092int echo_main(int argc, char** argv) IF_ECHO(MAIN_EXTERNALLY_VISIBLE);
1093int printf_main(int argc, char **argv) IF_PRINTF(MAIN_EXTERNALLY_VISIBLE);
1094int test_main(int argc, char **argv) IF_TEST(MAIN_EXTERNALLY_VISIBLE);
1095int kill_main(int argc, char **argv) IF_KILL(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenkocd2663f2008-06-01 22:36:39 +00001096/* Similar, but used by chgrp, not shell */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001097int chown_main(int argc, char **argv) IF_CHOWN(MAIN_EXTERNALLY_VISIBLE);
Denis Vlasenkoc41cba52009-03-09 15:46:07 +00001098/* Used by ftpd */
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001099int ls_main(int argc, char **argv) IF_LS(MAIN_EXTERNALLY_VISIBLE);
1100/* Don't need IF_xxx() guard for these */
Denis Vlasenko9b49a5e2007-10-11 10:05:36 +00001101int gunzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko77f1ec12007-10-13 03:36:03 +00001102int bunzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
Denis Vlasenko1a9e9bd2008-11-01 12:54:56 +00001103
Denis Vlasenko468aea22008-04-01 14:47:57 +00001104#if ENABLE_ROUTE
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001105void bb_displayroutes(int noresolve, int netstatfmt) FAST_FUNC;
Denis Vlasenko468aea22008-04-01 14:47:57 +00001106#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001107
Denis Vlasenko270c17c2006-12-26 17:40:33 +00001108
1109/* Networking */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001110int create_icmp_socket(void) FAST_FUNC;
1111int create_icmp6_socket(void) FAST_FUNC;
Denis Vlasenko270c17c2006-12-26 17:40:33 +00001112/* interface.c */
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001113/* This structure defines protocol families and their handlers. */
1114struct aftype {
1115 const char *name;
1116 const char *title;
1117 int af;
1118 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001119 char* FAST_FUNC (*print)(unsigned char *);
1120 const char* FAST_FUNC (*sprint)(struct sockaddr *, int numeric);
1121 int FAST_FUNC (*input)(/*int type,*/ const char *bufp, struct sockaddr *);
1122 void FAST_FUNC (*herror)(char *text);
1123 int FAST_FUNC (*rprint)(int options);
1124 int FAST_FUNC (*rinput)(int typ, int ext, char **argv);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001125 /* may modify src */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001126 int FAST_FUNC (*getmask)(char *src, struct sockaddr *mask, char *name);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001127};
1128/* This structure defines hardware protocols and their handlers. */
1129struct hwtype {
1130 const char *name;
1131 const char *title;
1132 int type;
1133 int alen;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001134 char* FAST_FUNC (*print)(unsigned char *);
1135 int FAST_FUNC (*input)(const char *, struct sockaddr *);
1136 int FAST_FUNC (*activate)(int fd);
Denis Vlasenkof5294e12007-04-14 10:09:57 +00001137 int suppress_null_addr;
1138};
Denis Vlasenko1b16bda2007-06-19 11:10:02 +00001139extern smallint interface_opt_a;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001140int display_interfaces(char *ifname) FAST_FUNC;
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001141#if ENABLE_FEATURE_HWIB
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001142int in_ib(const char *bufp, struct sockaddr *sap) FAST_FUNC;
Denis Vlasenko3b162ec2008-06-04 07:59:51 +00001143#else
1144#define in_ib(a, b) 1 /* fail */
Bernhard Reutner-Fischerf3b778a2008-05-16 16:10:31 +00001145#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001146const struct aftype *get_aftype(const char *name) FAST_FUNC;
1147const struct hwtype *get_hwtype(const char *name) FAST_FUNC;
1148const struct hwtype *get_hwntype(int type) FAST_FUNC;
Denis Vlasenko270c17c2006-12-26 17:40:33 +00001149
1150
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001151#ifndef BUILD_INDIVIDUAL
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001152extern int find_applet_by_name(const char *name) FAST_FUNC;
Denis Vlasenko32b633a2007-04-09 03:05:48 +00001153/* Returns only if applet is not found. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001154extern void run_applet_and_exit(const char *name, char **argv) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001155extern void run_applet_no_and_exit(int a, char **argv) NORETURN FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001156#endif
1157
Mike Frysinger9412ec72008-02-07 22:41:33 +00001158#ifdef HAVE_MNTENT_H
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001159extern int match_fstype(const struct mntent *mt, const char *fstypes) FAST_FUNC;
Denys Vlasenko6ae64262009-07-18 16:22:26 +02001160extern struct mntent *find_mount_point(const char *name, int subdir_too) FAST_FUNC;
Mike Frysinger9412ec72008-02-07 22:41:33 +00001161#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001162extern void erase_mtab(const char * name) FAST_FUNC;
1163extern unsigned int tty_baud_to_value(speed_t speed) FAST_FUNC;
1164extern speed_t tty_value_to_baud(unsigned int value) FAST_FUNC;
Denys Vlasenkoa355da02010-01-04 13:16:08 +01001165#if ENABLE_DESKTOP
1166extern void bb_warn_ignoring_args(char *arg) FAST_FUNC;
1167#else
1168# define bb_warn_ignoring_args(arg) ((void)0)
1169#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001170
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001171extern int get_linux_version_code(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001172
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001173extern char *query_loop(const char *device) FAST_FUNC;
1174extern int del_loop(const char *device) FAST_FUNC;
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001175/* If *devname is not NULL, use that name, otherwise try to find free one,
1176 * malloc and return it in *devname.
1177 * return value: 1: read-only loopdev was setup, 0: rw, < 0: error */
Denys Vlasenko13e709c2011-09-12 02:13:47 +02001178extern int set_loop(char **devname, const char *file, unsigned long long offset, int ro) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001179
Bernhard Reutner-Fischer82b14292008-12-03 18:48:39 +00001180/* Like bb_ask below, but asks on stdin with no timeout. */
1181char *bb_ask_stdin(const char * prompt) FAST_FUNC;
Denis Vlasenko6ef06ee2007-03-14 22:06:01 +00001182//TODO: pass buf pointer or return allocated buf (avoid statics)?
Bernhard Reutner-Fischer82b14292008-12-03 18:48:39 +00001183char *bb_ask(const int fd, int timeout, const char * prompt) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001184int bb_ask_confirmation(void) FAST_FUNC;
Eric Andersenaad1a882001-03-16 22:47:14 +00001185
Denis Vlasenkoc01340f2008-07-16 22:12:18 +00001186int bb_parse_mode(const char* s, mode_t* theMode) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001187
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001188/*
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001189 * Config file parser
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001190 */
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001191enum {
Denis Vlasenko084266e2008-07-26 23:08:31 +00001192 PARSE_COLLAPSE = 0x00010000, // treat consecutive delimiters as one
1193 PARSE_TRIM = 0x00020000, // trim leading and trailing delimiters
1194// TODO: COLLAPSE and TRIM seem to always go in pair
1195 PARSE_GREEDY = 0x00040000, // last token takes entire remainder of the line
1196 PARSE_MIN_DIE = 0x00100000, // die if < min tokens found
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001197 // keep a copy of current line
Denis Vlasenko35a064b2008-11-06 00:49:59 +00001198 PARSE_KEEP_COPY = 0x00200000 * ENABLE_FEATURE_CROND_D,
Denys Vlasenko499597d2012-01-11 00:37:17 +01001199 PARSE_EOL_COMMENTS = 0x00400000, // comments are recognized even if they aren't the first char
Denis Vlasenko084266e2008-07-26 23:08:31 +00001200 // NORMAL is:
1201 // * remove leading and trailing delimiters and collapse
1202 // multiple delimiters into one
1203 // * warn and continue if less than mintokens delimiters found
1204 // * grab everything into last token
Denys Vlasenko499597d2012-01-11 00:37:17 +01001205 // * comments are recognized even if they aren't the first char
1206 PARSE_NORMAL = PARSE_COLLAPSE | PARSE_TRIM | PARSE_GREEDY | PARSE_EOL_COMMENTS,
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001207};
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001208typedef struct parser_t {
1209 FILE *fp;
Denis Vlasenkodcb3fcb2008-07-19 22:57:00 +00001210 char *data;
Timo Terasadcabf32011-06-20 09:49:56 +02001211 char *line, *nline;
1212 size_t line_alloc, nline_alloc;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001213 int lineno;
1214} parser_t;
Bernhard Reutner-Fischer67921282008-07-17 11:59:13 +00001215parser_t* config_open(const char *filename) FAST_FUNC;
Denis Vlasenko5415c852008-07-21 23:05:26 +00001216parser_t* config_open2(const char *filename, FILE* FAST_FUNC (*fopen_func)(const char *path)) FAST_FUNC;
Denys Vlasenkoadbbee42010-06-21 07:17:23 +02001217/* delims[0] is a comment char (use '\0' to disable), the rest are token delimiters */
Denis Vlasenko2e157dd2008-07-19 09:27:19 +00001218int config_read(parser_t *parser, char **tokens, unsigned flags, const char *delims) FAST_FUNC;
1219#define config_read(parser, tokens, max, min, str, flags) \
1220 config_read(parser, tokens, ((flags) | (((min) & 0xFF) << 8) | ((max) & 0xFF)), str)
Denis Vlasenkoc01340f2008-07-16 22:12:18 +00001221void config_close(parser_t *parser) FAST_FUNC;
Denis Vlasenkoe559e0a2008-07-15 21:09:30 +00001222
Denis Vlasenko6bf05cf2008-05-07 12:18:48 +00001223/* Concatenate path and filename to new allocated buffer.
1224 * Add "/" only as needed (no duplicate "//" are produced).
1225 * If path is NULL, it is assumed to be "/".
1226 * filename should not be NULL. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001227char *concat_path_file(const char *path, const char *filename) FAST_FUNC;
Denys Vlasenkoe6df7e22011-05-23 03:39:08 +02001228/* Returns NULL on . and .. */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001229char *concat_subpath_file(const char *path, const char *filename) FAST_FUNC;
Eric Andersene5dfced2001-04-09 22:48:12 +00001230
Denis Vlasenko4921b542007-02-03 02:17:41 +00001231
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001232int bb_make_directory(char *path, long mode, int flags) FAST_FUNC;
Matt Kraaiceeff732001-06-21 19:41:37 +00001233
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001234int get_signum(const char *name) FAST_FUNC;
1235const char *get_signame(int number) FAST_FUNC;
1236void print_signames(void) FAST_FUNC;
Rob Landleyc9c1a412006-07-12 19:17:55 +00001237
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001238char *bb_simplify_path(const char *path) FAST_FUNC;
Denis Vlasenko1cf4a0e2009-04-22 13:49:16 +00001239/* Returns ptr to NUL */
1240char *bb_simplify_abs_path_inplace(char *path) FAST_FUNC;
Eric Andersen34506362001-08-02 05:02:46 +00001241
Denys Vlasenko681efe22011-03-08 21:00:36 +01001242#define LOGIN_FAIL_DELAY 3
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001243extern void bb_do_delay(int seconds) FAST_FUNC;
1244extern void change_identity(const struct passwd *pw) FAST_FUNC;
Denis Vlasenkoa60f84e2008-07-05 09:18:54 +00001245extern 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 +01001246
1247/* Returns $SHELL, getpwuid(getuid())->pw_shell, or DEFAULT_SHELL.
1248 * Note that getpwuid result might need xstrdup'ing
1249 * if there is a possibility of intervening getpwxxx() calls.
1250 */
1251const char *get_shell_name(void);
1252
Denis Vlasenkob5a122b2006-12-30 14:46:51 +00001253#if ENABLE_SELINUX
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001254extern void renew_current_security_context(void) FAST_FUNC;
1255extern void set_current_security_context(security_context_t sid) FAST_FUNC;
Denis Vlasenko1203c9b2007-03-11 22:16:02 +00001256extern context_t set_security_context_component(security_context_t cur_context,
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001257 char *user, char *role, char *type, char *range) FAST_FUNC;
1258extern void setfscreatecon_or_die(security_context_t scontext) FAST_FUNC;
1259extern void selinux_preserve_fcontext(int fdesc) FAST_FUNC;
Denis Vlasenko2edbc2a2007-10-20 02:00:49 +00001260#else
1261#define selinux_preserve_fcontext(fdesc) ((void)0)
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001262#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001263extern void selinux_or_die(void) FAST_FUNC;
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001264
Davide Cavalca9b3b9792011-01-25 02:26:03 +01001265
1266/* systemd support */
1267#define SD_LISTEN_FDS_START 3
1268int sd_listen_fds(void);
1269
1270
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001271/* setup_environment:
Bernhard Reutner-Fischer99709ab2010-02-24 16:10:09 +01001272 * if chdir pw->pw_dir: ok: else if to_tmp == 1: goto /tmp else: goto / or die
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001273 * if clear_env = 1: cd(pw->pw_dir), clear environment, then set
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001274 * TERM=(old value)
1275 * USER=pw->pw_name, LOGNAME=pw->pw_name
1276 * PATH=bb_default_[root_]path
1277 * HOME=pw->pw_dir
1278 * SHELL=shell
Denis Vlasenkocdf62772008-03-17 08:42:43 +00001279 * else if change_env = 1:
Denis Vlasenkoa2f61012007-09-10 13:15:28 +00001280 * if not root (if pw->pw_uid != 0):
1281 * USER=pw->pw_name, LOGNAME=pw->pw_name
1282 * HOME=pw->pw_dir
1283 * SHELL=shell
1284 * else does nothing
1285 */
Denys Vlasenkofd686a22010-02-26 09:52:45 +01001286#define SETUP_ENV_CHANGEENV (1 << 0)
1287#define SETUP_ENV_CLEARENV (1 << 1)
1288#define SETUP_ENV_TO_TMP (1 << 2)
1289extern void setup_environment(const char *shell, int flags, const struct passwd *pw) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001290extern int correct_password(const struct passwd *pw) FAST_FUNC;
Denis Vlasenkofdddab02008-06-12 16:56:52 +00001291/* Returns a malloced string */
Denis Vlasenkob4c5bf62008-06-15 18:35:34 +00001292#if !ENABLE_USE_BB_CRYPT
1293#define pw_encrypt(clear, salt, cleanup) pw_encrypt(clear, salt)
1294#endif
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001295extern char *pw_encrypt(const char *clear, const char *salt, int cleanup) FAST_FUNC;
1296extern int obscure(const char *old, const char *newval, const struct passwd *pwdp) FAST_FUNC;
Denys Vlasenko12a43272011-05-13 03:19:01 +02001297/*
1298 * rnd is additional random input. New one is returned.
Denis Vlasenko4ea83bf2008-06-12 16:55:59 +00001299 * Useful if you call crypt_make_salt many times in a row:
1300 * rnd = crypt_make_salt(buf1, 4, 0);
1301 * rnd = crypt_make_salt(buf2, 4, rnd);
1302 * rnd = crypt_make_salt(buf3, 4, rnd);
1303 * (otherwise we risk having same salt generated)
1304 */
Denys Vlasenko12a43272011-05-13 03:19:01 +02001305extern int crypt_make_salt(char *p, int cnt /*, int rnd*/) FAST_FUNC;
1306/* "$N$" + sha_salt_16_bytes + NUL */
1307#define MAX_PW_SALT_LEN (3 + 16 + 1)
1308extern char* crypt_make_pw_salt(char p[MAX_PW_SALT_LEN], const char *algo) FAST_FUNC;
1309
Denis Vlasenko829bbd32009-04-14 00:51:05 +00001310
Denis Vlasenko4ea83bf2008-06-12 16:55:59 +00001311/* Returns number of lines changed, or -1 on error */
Denis Vlasenko829bbd32009-04-14 00:51:05 +00001312#if !(ENABLE_FEATURE_ADDUSER_TO_GROUP || ENABLE_FEATURE_DEL_USER_FROM_GROUP)
1313#define update_passwd(filename, username, data, member) \
1314 update_passwd(filename, username, data)
1315#endif
1316extern int update_passwd(const char *filename,
1317 const char *username,
1318 const char *data,
1319 const char *member) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001320
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001321int index_in_str_array(const char *const string_array[], const char *key) FAST_FUNC;
1322int index_in_strings(const char *strings, const char *key) FAST_FUNC;
1323int index_in_substr_array(const char *const string_array[], const char *key) FAST_FUNC;
1324int index_in_substrings(const char *strings, const char *key) FAST_FUNC;
1325const char *nth_string(const char *strings, int n) FAST_FUNC;
Denis Vlasenkobfc3d822007-11-04 04:10:17 +00001326
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001327extern void print_login_issue(const char *issue_file, const char *tty) FAST_FUNC;
1328extern void print_login_prompt(void) FAST_FUNC;
Denis Vlasenkobb7fcb42007-03-26 13:20:04 +00001329
Denys Vlasenko53283ad2009-11-02 14:20:34 +01001330char *xmalloc_ttyname(int fd) FAST_FUNC RETURNS_MALLOC;
Denis Vlasenkof893da82007-08-09 08:27:24 +00001331/* NB: typically you want to pass fd 0, not 1. Think 'applet | grep something' */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001332int get_terminal_width_height(int fd, unsigned *width, unsigned *height) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001333
Denis Vlasenko202ac502008-11-05 13:20:58 +00001334int tcsetattr_stdin_TCSANOW(const struct termios *tp) FAST_FUNC;
1335
Denis Vlasenko5bb2fc22008-04-21 03:23:59 +00001336/* NB: "unsigned request" is crucial! "int request" will break some arches! */
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001337int ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...) __attribute__ ((format (printf, 4, 5))) FAST_FUNC;
1338int 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 +00001339#if ENABLE_IOCTL_HEX2STR_ERROR
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001340int bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
1341int bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001342#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp,#request)
1343#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp,#request)
1344#else
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001345int bb_ioctl_or_warn(int fd, unsigned request, void *argp) FAST_FUNC;
1346int bb_xioctl(int fd, unsigned request, void *argp) FAST_FUNC;
Denis Vlasenkofb79a2e2007-07-14 22:07:14 +00001347#define ioctl_or_warn(fd,request,argp) bb_ioctl_or_warn(fd,request,argp)
1348#define xioctl(fd,request,argp) bb_xioctl(fd,request,argp)
1349#endif
1350
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001351char *is_in_ino_dev_hashtable(const struct stat *statbuf) FAST_FUNC;
1352void add_to_ino_dev_hashtable(const struct stat *statbuf, const char *name) FAST_FUNC;
1353void reset_ino_dev_hashtable(void) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001354#ifdef __GLIBC__
1355/* At least glibc has horrendously large inline for this, so wrap it */
Denys Vlasenko975c7142011-01-24 23:53:12 +01001356unsigned long long bb_makedev(unsigned major, unsigned minor) FAST_FUNC;
Denis Vlasenko0b354702006-11-24 14:54:27 +00001357#undef makedev
1358#define makedev(a,b) bb_makedev(a,b)
1359#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001360
1361
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001362/* "Keycodes" that report an escape sequence.
1363 * We use something which fits into signed char,
Denys Vlasenko5370bfb2009-09-06 02:58:59 +02001364 * yet doesn't represent any valid Unicode character.
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001365 * Also, -1 is reserved for error indication and we don't use it. */
1366enum {
1367 KEYCODE_UP = -2,
1368 KEYCODE_DOWN = -3,
1369 KEYCODE_RIGHT = -4,
1370 KEYCODE_LEFT = -5,
1371 KEYCODE_HOME = -6,
1372 KEYCODE_END = -7,
1373 KEYCODE_INSERT = -8,
1374 KEYCODE_DELETE = -9,
1375 KEYCODE_PAGEUP = -10,
1376 KEYCODE_PAGEDOWN = -11,
Denys Vlasenko9ce09bc2011-11-03 13:28:22 +01001377 // -12 is reserved for Alt/Ctrl/Shift-TAB
1378#if 0
1379 KEYCODE_FUN1 = -13,
1380 KEYCODE_FUN2 = -14,
1381 KEYCODE_FUN3 = -15,
1382 KEYCODE_FUN4 = -16,
1383 KEYCODE_FUN5 = -17,
1384 KEYCODE_FUN6 = -18,
1385 KEYCODE_FUN7 = -19,
1386 KEYCODE_FUN8 = -20,
1387 KEYCODE_FUN9 = -21,
1388 KEYCODE_FUN10 = -22,
1389 KEYCODE_FUN11 = -23,
1390 KEYCODE_FUN12 = -24,
1391#endif
1392 /* Be sure that last defined value is small enough
1393 * to not interfere with Alt/Ctrl/Shift bits.
1394 * So far we do not exceed -31 (0xfff..fffe1),
1395 * which gives us three upper bits in LSB to play with.
1396 */
1397 //KEYCODE_SHIFT_TAB = (-12) & ~0x80,
1398 //KEYCODE_SHIFT_... = KEYCODE_... & ~0x80,
1399 //KEYCODE_CTRL_UP = KEYCODE_UP & ~0x40,
1400 //KEYCODE_CTRL_DOWN = KEYCODE_DOWN & ~0x40,
Denys Vlasenkoa17eeb82009-10-25 23:50:56 +01001401 KEYCODE_CTRL_RIGHT = KEYCODE_RIGHT & ~0x40,
1402 KEYCODE_CTRL_LEFT = KEYCODE_LEFT & ~0x40,
Denys Vlasenko9ce09bc2011-11-03 13:28:22 +01001403 //KEYCODE_ALT_UP = KEYCODE_UP & ~0x20,
1404 //KEYCODE_ALT_DOWN = KEYCODE_DOWN & ~0x20,
1405 KEYCODE_ALT_RIGHT = KEYCODE_RIGHT & ~0x20,
1406 KEYCODE_ALT_LEFT = KEYCODE_LEFT & ~0x20,
1407
Denys Vlasenko180f5852009-10-26 00:59:59 +01001408 KEYCODE_CURSOR_POS = -0x100, /* 0xfff..fff00 */
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001409 /* How long is the longest ESC sequence we know?
1410 * We want it big enough to be able to contain
1411 * cursor position sequence "ESC [ 9999 ; 9999 R"
1412 */
1413 KEYCODE_BUFFER_SIZE = 16
1414};
1415/* Note: fd may be in blocking or non-blocking mode, both make sense.
1416 * For one, less uses non-blocking mode.
1417 * Only the first read syscall inside read_key may block indefinitely
1418 * (unless fd is in non-blocking mode),
1419 * subsequent reads will time out after a few milliseconds.
1420 * Return of -1 means EOF or error (errno == 0 on EOF).
1421 * buffer[0] is used as a counter of buffered chars and must be 0
1422 * on first call.
Denys Vlasenko58f108e2010-03-11 21:17:55 +01001423 * timeout:
1424 * -2: do not poll for input;
1425 * -1: poll(-1) (i.e. block);
1426 * >=0: poll for TIMEOUT milliseconds, return -1/EAGAIN on timeout
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001427 */
Denys Vlasenko58f108e2010-03-11 21:17:55 +01001428int64_t read_key(int fd, char *buffer, int timeout) FAST_FUNC;
Tomas Heinrichd2b04052010-03-09 14:09:24 +01001429void read_key_ungets(char *buffer, const char *str, unsigned len) FAST_FUNC;
Denys Vlasenko4b7db4f2009-05-29 10:39:06 +02001430
1431
Denis Vlasenko38f63192007-01-22 09:03:07 +00001432#if ENABLE_FEATURE_EDITING
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001433/* It's NOT just ENABLEd or disabled. It's a number: */
Denys Vlasenko2c4de5b2011-03-31 13:16:52 +02001434# if defined CONFIG_FEATURE_EDITING_HISTORY && CONFIG_FEATURE_EDITING_HISTORY > 0
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001435# define MAX_HISTORY (CONFIG_FEATURE_EDITING_HISTORY + 0)
Denys Vlasenko2c4de5b2011-03-31 13:16:52 +02001436unsigned size_from_HISTFILESIZE(const char *hp);
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001437# else
1438# define MAX_HISTORY 0
1439# endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001440typedef struct line_input_t {
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001441 int flags;
1442 const char *path_lookup;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001443# if MAX_HISTORY
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001444 int cnt_history;
1445 int cur_history;
Denys Vlasenko2c4de5b2011-03-31 13:16:52 +02001446 int max_history; /* must never be <= 0 */
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001447# if ENABLE_FEATURE_EDITING_SAVEHISTORY
Denys Vlasenkobede2152011-09-04 16:12:33 +02001448 /* meaning of this field depends on FEATURE_EDITING_SAVE_ON_EXIT:
1449 * if !FEATURE_EDITING_SAVE_ON_EXIT: "how many lines are
1450 * in on-disk history"
1451 * if FEATURE_EDITING_SAVE_ON_EXIT: "how many in-memory lines are
1452 * also in on-disk history (and thus need to be skipped on save)"
1453 */
Denis Vlasenko57abf9e2009-03-22 19:00:05 +00001454 unsigned cnt_history_in_file;
Denis Vlasenko57abf9e2009-03-22 19:00:05 +00001455 const char *hist_file;
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001456# endif
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001457 char *history[MAX_HISTORY + 1];
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001458# endif
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001459} line_input_t;
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001460enum {
Denys Vlasenkoe45af7a2011-09-04 16:15:24 +02001461 DO_HISTORY = 1 * (MAX_HISTORY > 0),
1462 TAB_COMPLETION = 2 * ENABLE_FEATURE_TAB_COMPLETION,
1463 USERNAME_COMPLETION = 4 * ENABLE_FEATURE_USERNAME_COMPLETION,
1464 VI_MODE = 8 * ENABLE_FEATURE_EDITING_VI,
1465 WITH_PATH_LOOKUP = 0x10,
1466 FOR_SHELL = DO_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001467};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001468line_input_t *new_line_input_t(int flags) FAST_FUNC;
Denys Vlasenko5c2e81b2009-07-16 14:14:34 +02001469/* So far static: void free_line_input_t(line_input_t *n) FAST_FUNC; */
Denys Vlasenko046341e2011-02-04 17:53:59 +01001470/*
1471 * maxsize must be >= 2.
Denys Vlasenko5c2e81b2009-07-16 14:14:34 +02001472 * Returns:
Denis Vlasenko80667e32008-02-02 18:35:55 +00001473 * -1 on read errors or EOF, or on bare Ctrl-D,
1474 * 0 on ctrl-C (the line entered is still returned in 'command'),
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001475 * >0 length of input string, including terminating '\n'
Denis Vlasenko6a5377a2007-09-25 18:35:28 +00001476 */
Denys Vlasenko66c5b122011-02-08 05:07:02 +01001477int read_line_input(line_input_t *st, const char *prompt, char *command, int maxsize, int timeout) FAST_FUNC;
Denys Vlasenkobede2152011-09-04 16:12:33 +02001478# if ENABLE_FEATURE_EDITING_SAVE_ON_EXIT
1479void save_history(line_input_t *st);
1480# endif
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001481#else
Denys Vlasenko36df0482009-10-19 16:07:28 +02001482#define MAX_HISTORY 0
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001483int read_line_input(const char* prompt, char* command, int maxsize) FAST_FUNC;
Denys Vlasenko66c5b122011-02-08 05:07:02 +01001484#define read_line_input(state, prompt, command, maxsize, timeout) \
Denis Vlasenko8e1c7152007-01-22 07:21:38 +00001485 read_line_input(prompt, command, maxsize)
1486#endif
1487
1488
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001489#ifndef COMM_LEN
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001490# ifdef TASK_COMM_LEN
Denis Vlasenkofa076802006-11-05 00:38:51 +00001491enum { COMM_LEN = TASK_COMM_LEN };
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001492# else
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001493/* synchronize with sizeof(task_struct.comm) in /usr/include/linux/sched.h */
Denis Vlasenkofa076802006-11-05 00:38:51 +00001494enum { COMM_LEN = 16 };
Denys Vlasenkoc15f40c2009-05-15 03:27:53 +02001495# endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001496#endif
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02001497
1498struct smaprec {
1499 unsigned long mapped_rw;
1500 unsigned long mapped_ro;
1501 unsigned long shared_clean;
1502 unsigned long shared_dirty;
1503 unsigned long private_clean;
1504 unsigned long private_dirty;
1505 unsigned long stack;
1506 unsigned long smap_pss, smap_swap;
1507 unsigned long smap_size;
1508 unsigned long smap_start;
1509 char smap_mode[5];
1510 char *smap_name;
1511};
1512
1513#if !ENABLE_PMAP
1514#define procps_read_smaps(pid, total, cb, data) \
1515 procps_read_smaps(pid, total)
1516#endif
1517int FAST_FUNC procps_read_smaps(pid_t pid, struct smaprec *total,
1518 void (*cb)(struct smaprec *, void *), void *data);
1519
Denis Vlasenko512499c2007-08-26 18:23:13 +00001520typedef struct procps_status_t {
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001521 DIR *dir;
Denys Vlasenkob410d4a2009-09-19 22:29:42 +02001522 IF_FEATURE_SHOW_THREADS(DIR *task_dir;)
Denis Vlasenko512499c2007-08-26 18:23:13 +00001523 uint8_t shift_pages_to_bytes;
1524 uint8_t shift_pages_to_kb;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001525/* Fields are set to 0/NULL if failed to determine (or not requested) */
Denis Vlasenko3b3ca112008-07-17 18:39:36 +00001526 uint16_t argv_len;
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001527 char *argv0;
Alexander Shishkine766f622009-07-29 01:35:13 +02001528 char *exe;
Denis Vlasenko5e34ff22009-04-21 11:09:40 +00001529 IF_SELINUX(char *context;)
Lauri Kasanen6578f2c2010-12-05 05:22:29 +01001530 IF_FEATURE_SHOW_THREADS(unsigned main_thread_pid;)
Denis Vlasenko0696b8a2007-06-06 07:40:16 +00001531 /* Everything below must contain no ptrs to malloc'ed data:
1532 * it is memset(0) for each process in procps_scan() */
Denis Vlasenkofc1e9952007-08-29 18:23:36 +00001533 unsigned long vsz, rss; /* we round it to kbytes */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001534 unsigned long stime, utime;
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001535 unsigned long start_time;
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001536 unsigned pid;
1537 unsigned ppid;
1538 unsigned pgid;
1539 unsigned sid;
1540 unsigned uid;
1541 unsigned gid;
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001542#if ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS
1543 unsigned ruid;
1544 unsigned rgid;
1545 int niceness;
1546#endif
Denis Vlasenko31789a82007-06-19 14:43:17 +00001547 unsigned tty_major,tty_minor;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001548#if ENABLE_FEATURE_TOPMEM
Alexander Shishkin0834a6d2010-08-28 23:20:34 +02001549 struct smaprec smaps;
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001550#endif
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001551 char state[4];
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001552 /* basename of executable in exec(2), read from /proc/N/stat
1553 * (if executable is symlink or script, it is NOT replaced
1554 * by link target or interpreter name) */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001555 char comm[COMM_LEN];
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001556 /* user/group? - use passwd/group parsing functions */
Denis Vlasenko17e7f042008-09-25 10:48:06 +00001557#if ENABLE_FEATURE_TOP_SMP_PROCESS
1558 int last_seen_on_cpu;
1559#endif
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001560} procps_status_t;
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001561/* flag bits for procps_scan(xx, flags) calls */
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001562enum {
1563 PSSCAN_PID = 1 << 0,
1564 PSSCAN_PPID = 1 << 1,
1565 PSSCAN_PGID = 1 << 2,
1566 PSSCAN_SID = 1 << 3,
1567 PSSCAN_UIDGID = 1 << 4,
1568 PSSCAN_COMM = 1 << 5,
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001569 /* PSSCAN_CMD = 1 << 6, - use read_cmdline instead */
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001570 PSSCAN_ARGV0 = 1 << 7,
Alexander Shishkine766f622009-07-29 01:35:13 +02001571 PSSCAN_EXE = 1 << 8,
Denis Vlasenkof7d07b12007-06-30 08:03:26 +00001572 PSSCAN_STATE = 1 << 9,
1573 PSSCAN_VSZ = 1 << 10,
1574 PSSCAN_RSS = 1 << 11,
1575 PSSCAN_STIME = 1 << 12,
1576 PSSCAN_UTIME = 1 << 13,
1577 PSSCAN_TTY = 1 << 14,
Denis Vlasenkoff6e8e22007-09-08 16:51:19 +00001578 PSSCAN_SMAPS = (1 << 15) * ENABLE_FEATURE_TOPMEM,
Denis Vlasenko9f00e052009-02-14 01:36:11 +00001579 /* NB: used by find_pid_by_name(). Any applet using it
1580 * needs to be mentioned here. */
1581 PSSCAN_ARGVN = (1 << 16) * (ENABLE_KILLALL
1582 || ENABLE_PGREP || ENABLE_PKILL
1583 || ENABLE_PIDOF
Denis Vlasenko3266aa92009-04-01 11:24:04 +00001584 || ENABLE_SESTATUS
Denis Vlasenko9f00e052009-02-14 01:36:11 +00001585 ),
Denys Vlasenko4ff1ce02009-09-22 11:21:48 +02001586 PSSCAN_CONTEXT = (1 << 17) * ENABLE_SELINUX,
Denis Vlasenko5fee2e12008-01-05 03:26:41 +00001587 PSSCAN_START_TIME = 1 << 18,
Denys Vlasenkofca70a82009-07-03 22:16:17 +02001588 PSSCAN_CPU = (1 << 19) * ENABLE_FEATURE_TOP_SMP_PROCESS,
1589 PSSCAN_NICE = (1 << 20) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
1590 PSSCAN_RUIDGID = (1 << 21) * ENABLE_FEATURE_PS_ADDITIONAL_COLUMNS,
Denys Vlasenkob410d4a2009-09-19 22:29:42 +02001591 PSSCAN_TASKS = (1 << 22) * ENABLE_FEATURE_SHOW_THREADS,
Denis Vlasenko459e4d62006-11-05 00:43:51 +00001592};
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001593//procps_status_t* alloc_procps_scan(void) FAST_FUNC;
1594void free_procps_scan(procps_status_t* sp) FAST_FUNC;
1595procps_status_t* procps_scan(procps_status_t* sp, int flags) FAST_FUNC;
Denys Vlasenko3a0f6f22009-09-12 00:15:34 +02001596/* Format cmdline (up to col chars) into char buf[size] */
Denis Vlasenko98ebab82007-06-30 14:47:41 +00001597/* Puts [comm] if cmdline is empty (-> process is a kernel thread) */
Denys Vlasenko3a0f6f22009-09-12 00:15:34 +02001598void read_cmdline(char *buf, int size, unsigned pid, const char *comm) FAST_FUNC;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001599pid_t *find_pid_by_name(const char* procName) FAST_FUNC;
1600pid_t *pidlist_reverse(pid_t *pidList) FAST_FUNC;
Denys Vlasenkoc9b97502010-08-16 02:49:21 +02001601int starts_with_cpu(const char *str) FAST_FUNC;
1602unsigned get_cpu_count(void) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001603
1604
Denys Vlasenkodd1061b2011-09-11 21:04:02 +02001605/* Use strict=1 if you process input from untrusted source:
1606 * it will return NULL on invalid %xx (bad hex chars)
1607 * and str + 1 if decoded char is / or NUL.
1608 * In non-strict mode, it always succeeds (returns str),
1609 * and also it additionally decoded '+' to space.
1610 */
1611char *percent_decode_in_place(char *str, int strict) FAST_FUNC;
1612
1613
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001614extern const char bb_uuenc_tbl_base64[];
1615extern const char bb_uuenc_tbl_std[];
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001616void bb_uuencode(char *store, const void *s, int length, const char *tbl) FAST_FUNC;
Denys Vlasenko9fe98f72010-09-16 17:51:13 +02001617enum {
1618 BASE64_FLAG_UU_STOP = 0x100,
1619 /* Sign-extends to a value which never matches fgetc result: */
1620 BASE64_FLAG_NO_STOP_CHAR = 0x80,
1621};
Leonid Lisovskiy328f27f2011-10-28 13:59:04 +02001622const char *decode_base64(char **pp_dst, const char *src) FAST_FUNC;
1623void read_base64(FILE *src_stream, FILE *dst_stream, int flags) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001624
Denis Vlasenkodd539f72006-11-01 20:20:37 +00001625typedef struct md5_ctx_t {
Denys Vlasenko302ad142010-10-19 02:16:12 +02001626 uint8_t wbuffer[64]; /* always correctly aligned for uint64_t */
1627 void (*process_block)(struct md5_ctx_t*) FAST_FUNC;
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02001628 uint64_t total64; /* must be directly before hash[] */
Denys Vlasenko302ad142010-10-19 02:16:12 +02001629 uint32_t hash[8]; /* 4 elements for md5, 5 for sha1, 8 for sha256 */
1630} md5_ctx_t;
1631typedef struct md5_ctx_t sha1_ctx_t;
1632typedef struct md5_ctx_t sha256_ctx_t;
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02001633typedef struct sha512_ctx_t {
1634 uint64_t total64[2]; /* must be directly before hash[] */
1635 uint64_t hash[8];
Denys Vlasenko302ad142010-10-19 02:16:12 +02001636 uint8_t wbuffer[128]; /* always correctly aligned for uint64_t */
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02001637} sha512_ctx_t;
Denys Vlasenko302ad142010-10-19 02:16:12 +02001638void md5_begin(md5_ctx_t *ctx) FAST_FUNC;
1639void md5_hash(md5_ctx_t *ctx, const void *data, size_t length) FAST_FUNC;
1640void md5_end(md5_ctx_t *ctx, void *resbuf) FAST_FUNC;
1641void sha1_begin(sha1_ctx_t *ctx) FAST_FUNC;
1642#define sha1_hash md5_hash
1643void sha1_end(sha1_ctx_t *ctx, void *resbuf) FAST_FUNC;
1644void sha256_begin(sha256_ctx_t *ctx) FAST_FUNC;
1645#define sha256_hash md5_hash
1646#define sha256_end sha1_end
Denys Vlasenkoc48a5c62010-10-18 14:48:30 +02001647void sha512_begin(sha512_ctx_t *ctx) FAST_FUNC;
1648void sha512_hash(sha512_ctx_t *ctx, const void *buffer, size_t len) FAST_FUNC;
1649void sha512_end(sha512_ctx_t *ctx, void *resbuf) FAST_FUNC;
Denis Vlasenkoe9b9a192008-11-11 01:38:04 +00001650
Denys Vlasenko9ce642f2010-10-27 15:26:45 +02001651extern uint32_t *global_crc32_table;
Denis Vlasenkodefc1ea2008-06-27 02:52:20 +00001652uint32_t *crc32_filltable(uint32_t *tbl256, int endian) FAST_FUNC;
Denys Vlasenko9ce642f2010-10-27 15:26:45 +02001653uint32_t crc32_block_endian1(uint32_t val, const void *buf, unsigned len, uint32_t *crc_table) FAST_FUNC;
1654uint32_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 +00001655
1656typedef struct masks_labels_t {
1657 const char *labels;
1658 const int masks[];
1659} masks_labels_t;
1660int print_flags_separated(const int *masks, const char *labels,
1661 int flags, const char *separator) FAST_FUNC;
1662int print_flags(const masks_labels_t *ml, int flags) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001663
Magnus Dammf5914992009-11-08 16:34:43 +01001664typedef struct bb_progress_t {
Denys Vlasenkoab8d00d2011-02-11 19:09:30 +01001665 unsigned last_size;
1666 unsigned last_update_sec;
1667 unsigned last_change_sec;
Magnus Dammf5914992009-11-08 16:34:43 +01001668 unsigned start_sec;
Denys Vlasenkod55e1392011-02-11 18:56:13 +01001669 const char *curfile;
Magnus Dammf5914992009-11-08 16:34:43 +01001670} bb_progress_t;
1671
Denys Vlasenkod55e1392011-02-11 18:56:13 +01001672#define is_bb_progress_inited(p) ((p)->curfile != NULL)
1673#define bb_progress_free(p) do { \
1674 if (ENABLE_UNICODE_SUPPORT) free((char*)((p)->curfile)); \
1675 (p)->curfile = NULL; \
1676} while (0)
1677void bb_progress_init(bb_progress_t *p, const char *curfile) FAST_FUNC;
1678void bb_progress_update(bb_progress_t *p,
Denys Vlasenko805aa9f2011-02-10 14:25:51 +01001679 uoff_t beg_range,
1680 uoff_t transferred,
1681 uoff_t totalsize) FAST_FUNC;
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001682
Denys Vlasenkod55e1392011-02-11 18:56:13 +01001683
Denis Vlasenko8f8f2682006-10-03 21:00:43 +00001684extern const char *applet_name;
Denys Vlasenko0004e992010-09-01 12:01:17 +02001685
1686/* Some older linkers don't perform string merging, we used to have common strings
1687 * as global arrays to do it by hand. But:
1688 * (1) newer linkers do it themselves,
1689 * (2) however, they DONT merge string constants with global arrays,
1690 * even if the value is the same (!). Thus global arrays actually
1691 * increased size a bit: for example, "/etc/passwd" string from libc
1692 * wasn't merged with bb_path_passwd_file[] array!
1693 * Therefore now we use #defines.
1694 */
Bernhard Reutner-Fischer78e1d582008-01-13 17:52:53 +00001695/* "BusyBox vN.N.N (timestamp or extra_version)" */
Denis Vlasenkoca525b42007-06-13 12:27:17 +00001696extern const char bb_banner[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001697extern const char bb_msg_memory_exhausted[];
1698extern const char bb_msg_invalid_date[];
Denys Vlasenko0004e992010-09-01 12:01:17 +02001699#define bb_msg_read_error "read error"
1700#define bb_msg_write_error "write error"
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001701extern const char bb_msg_unknown[];
1702extern const char bb_msg_can_not_create_raw_socket[];
1703extern const char bb_msg_perm_denied_are_you_root[];
Denys Vlasenkob2e5fc32009-11-25 14:52:47 +01001704extern const char bb_msg_you_must_be_root[];
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001705extern const char bb_msg_requires_arg[];
1706extern const char bb_msg_invalid_arg[];
1707extern const char bb_msg_standard_input[];
1708extern const char bb_msg_standard_output[];
Manuel Novoa III cad53642003-03-19 09:13:01 +00001709
Denis Vlasenko98c0bba2007-01-26 23:31:05 +00001710/* NB: (bb_hexdigits_upcase[i] | 0x20) -> lowercase hex digit */
Denis Vlasenko3a34d0c2007-01-12 22:10:34 +00001711extern const char bb_hexdigits_upcase[];
Denis Vlasenko7ca39212006-11-21 20:34:21 +00001712
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001713extern const char bb_path_wtmp_file[];
Denys Vlasenko0004e992010-09-01 12:01:17 +02001714
1715/* Busybox mount uses either /proc/mounts or /etc/mtab to
1716 * get the list of currently mounted filesystems */
1717#define bb_path_mtab_file IF_FEATURE_MTAB_SUPPORT("/etc/mtab")IF_NOT_FEATURE_MTAB_SUPPORT("/proc/mounts")
1718
Tito Ragusaad3d72f2011-01-16 23:39:45 +01001719#define bb_path_passwd_file _PATH_PASSWD
1720#define bb_path_group_file _PATH_GROUP
1721#define bb_path_shadow_file _PATH_SHADOW
1722#define bb_path_gshadow_file _PATH_GSHADOW
Denys Vlasenko0004e992010-09-01 12:01:17 +02001723
1724#define bb_path_motd_file "/etc/motd"
1725
1726#define bb_dev_null "/dev/null"
Denis Vlasenkobdbbb7e2007-06-08 15:02:55 +00001727extern const char bb_busybox_exec_path[];
Denis Vlasenko15611bb2007-06-12 08:52:02 +00001728/* util-linux manpage says /sbin:/bin:/usr/sbin:/usr/bin,
1729 * but I want to save a few bytes here */
Denis Vlasenkof5f75c52007-06-12 22:35:19 +00001730extern const char bb_PATH_root_path[]; /* "PATH=/sbin:/usr/sbin:/bin:/usr/bin" */
1731#define bb_default_root_path (bb_PATH_root_path + sizeof("PATH"))
1732#define bb_default_path (bb_PATH_root_path + sizeof("PATH=/sbin:/usr/sbin"))
"Vladimir N. Oleynik"6f347ef2005-10-15 10:23:55 +00001733
Denis Vlasenko703e2022007-01-22 14:12:08 +00001734extern const int const_int_0;
1735extern const int const_int_1;
1736
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001737
Denis Vlasenko85818632007-04-19 14:47:11 +00001738/* Providing hard guarantee on minimum size (think of BUFSIZ == 128) */
Denis Vlasenko74324c82007-06-04 10:16:52 +00001739enum { COMMON_BUFSIZE = (BUFSIZ >= 256*sizeof(void*) ? BUFSIZ+1 : 256*sizeof(void*)) };
1740extern char bb_common_bufsiz1[COMMON_BUFSIZE];
Denis Vlasenko972288e2007-03-15 00:57:01 +00001741/* This struct is deliberately not defined. */
1742/* See docs/keep_data_small.txt */
1743struct globals;
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001744/* '*const' ptr makes gcc optimize code much better.
Denis Vlasenkoe3241842007-08-13 10:36:25 +00001745 * Magic prevents ptr_to_globals from going into rodata.
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001746 * If you want to assign a value, use SET_PTR_TO_GLOBALS(x) */
Denis Vlasenkobff32ce2007-03-15 19:48:35 +00001747extern struct globals *const ptr_to_globals;
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001748/* At least gcc 3.4.6 on mipsel system needs optimization barrier */
Bernhard Reutner-Fischer797c96d2008-06-06 10:31:39 +00001749#define barrier() __asm__ __volatile__("":::"memory")
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001750#define SET_PTR_TO_GLOBALS(x) do { \
Denys Vlasenko90a99042009-09-06 02:36:23 +02001751 (*(struct globals**)&ptr_to_globals) = (void*)(x); \
Denis Vlasenko574f2f42008-02-27 18:41:59 +00001752 barrier(); \
1753} while (0)
Denis Vlasenko8d9f4952007-04-08 15:08:42 +00001754
Denis Vlasenkodca0b702006-10-27 09:05:02 +00001755/* You can change LIBBB_DEFAULT_LOGIN_SHELL, but don't use it,
1756 * use bb_default_login_shell and following defines.
1757 * If you change LIBBB_DEFAULT_LOGIN_SHELL,
1758 * don't forget to change increment constant. */
Ladislav Michla73b87e2010-06-27 03:23:31 +02001759#define LIBBB_DEFAULT_LOGIN_SHELL "-/bin/sh"
Denis Vlasenko0b5fd452006-09-19 09:55:09 +00001760extern const char bb_default_login_shell[];
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001761/* "/bin/sh" */
Ladislav Michla73b87e2010-06-27 03:23:31 +02001762#define DEFAULT_SHELL (bb_default_login_shell+1)
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001763/* "sh" */
Ladislav Michla73b87e2010-06-27 03:23:31 +02001764#define DEFAULT_SHELL_SHORT_NAME (bb_default_login_shell+6)
Glenn L McGrathdc4e75e2003-09-02 02:36:18 +00001765
Jeremie Koenig816ed972010-05-27 15:46:29 +02001766/* The following devices are the same on all systems. */
1767#define CURRENT_TTY "/dev/tty"
1768#define DEV_CONSOLE "/dev/console"
1769
1770#if defined(__FreeBSD_kernel__)
1771# define CURRENT_VC CURRENT_TTY
1772# define VC_1 "/dev/ttyv0"
1773# define VC_2 "/dev/ttyv1"
1774# define VC_3 "/dev/ttyv2"
1775# define VC_4 "/dev/ttyv3"
1776# define VC_5 "/dev/ttyv4"
1777# define VC_FORMAT "/dev/ttyv%d"
1778#elif defined(__GNU__)
1779# define CURRENT_VC CURRENT_TTY
1780# define VC_1 "/dev/tty1"
1781# define VC_2 "/dev/tty2"
1782# define VC_3 "/dev/tty3"
1783# define VC_4 "/dev/tty4"
1784# define VC_5 "/dev/tty5"
1785# define VC_FORMAT "/dev/tty%d"
Denys Vlasenko1c26e052010-10-24 02:35:17 +02001786#elif ENABLE_FEATURE_DEVFS
1787/*Linux, obsolete devfs names */
Matt Kraai439e3df2001-07-23 14:52:08 +00001788# define CURRENT_VC "/dev/vc/0"
1789# define VC_1 "/dev/vc/1"
1790# define VC_2 "/dev/vc/2"
1791# define VC_3 "/dev/vc/3"
1792# define VC_4 "/dev/vc/4"
1793# define VC_5 "/dev/vc/5"
Matt Kraai439e3df2001-07-23 14:52:08 +00001794# define VC_FORMAT "/dev/vc/%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +00001795# define LOOP_FORMAT "/dev/loop/%d"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001796# define LOOP_NAMESIZE (sizeof("/dev/loop/") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001797# define LOOP_NAME "/dev/loop/"
Eric Andersen5f284552003-11-14 03:11:29 +00001798# define FB_0 "/dev/fb/0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001799#else
Denys Vlasenko1c26e052010-10-24 02:35:17 +02001800/*Linux, normal names */
Matt Kraai439e3df2001-07-23 14:52:08 +00001801# define CURRENT_VC "/dev/tty0"
1802# define VC_1 "/dev/tty1"
1803# define VC_2 "/dev/tty2"
1804# define VC_3 "/dev/tty3"
1805# define VC_4 "/dev/tty4"
1806# define VC_5 "/dev/tty5"
Matt Kraai439e3df2001-07-23 14:52:08 +00001807# define VC_FORMAT "/dev/tty%d"
Eric Andersenc7a3fb92002-03-20 15:25:25 +00001808# define LOOP_FORMAT "/dev/loop%d"
Denis Vlasenko0e2c9fb2007-08-03 14:16:24 +00001809# define LOOP_NAMESIZE (sizeof("/dev/loop") + sizeof(int)*3 + 1)
Denis Vlasenko0b193a72006-09-29 21:47:11 +00001810# define LOOP_NAME "/dev/loop"
Eric Andersen5f284552003-11-14 03:11:29 +00001811# define FB_0 "/dev/fb0"
Matt Kraai439e3df2001-07-23 14:52:08 +00001812#endif
1813
Rob Landleyc57ec372006-04-10 17:07:15 +00001814
Denys Vlasenko9d57a802009-10-23 14:24:44 +02001815#define ARRAY_SIZE(x) ((unsigned)(sizeof(x) / sizeof((x)[0])))
1816
Rob Landleyb623a542006-05-31 22:09:03 +00001817
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001818/* We redefine ctype macros. Unicode-correct handling of char types
1819 * can't be done with such byte-oriented operations anyway,
1820 * we don't lose anything.
1821 */
Rob Landley4ae905a2006-07-06 17:22:54 +00001822#undef isalnum
1823#undef isalpha
1824#undef isascii
1825#undef isblank
1826#undef iscntrl
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001827#undef isdigit
Rob Landley4ae905a2006-07-06 17:22:54 +00001828#undef isgraph
1829#undef islower
1830#undef isprint
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001831#undef ispunct
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001832#undef isspace
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001833#undef isupper
1834#undef isxdigit
1835#undef toupper
1836#undef tolower
Rob Landley4ae905a2006-07-06 17:22:54 +00001837
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001838/* We save ~500 bytes on isdigit alone.
Denys Vlasenko7b4cd6f2009-10-23 02:22:03 +02001839 * BTW, x86 likes (unsigned char) cast more than (unsigned). */
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001840
1841/* These work the same for ASCII and Unicode,
1842 * assuming no one asks "is this a *Unicode* letter?" using isalpha(letter) */
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001843#define isascii(a) ((unsigned char)(a) <= 0x7f)
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001844#define isdigit(a) ((unsigned char)((a) - '0') <= 9)
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001845#define isupper(a) ((unsigned char)((a) - 'A') <= ('Z' - 'A'))
1846#define islower(a) ((unsigned char)((a) - 'a') <= ('z' - 'a'))
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001847#define isalpha(a) ((unsigned char)(((a)|0x20) - 'a') <= ('z' - 'a'))
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001848#define isblank(a) ({ unsigned char bb__isblank = (a); bb__isblank == ' ' || bb__isblank == '\t'; })
1849#define iscntrl(a) ({ unsigned char bb__iscntrl = (a); bb__iscntrl < ' ' || bb__iscntrl == 0x7f; })
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001850/* In POSIX/C locale isspace is only these chars: "\t\n\v\f\r" and space.
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001851 * "\t\n\v\f\r" happen to have ASCII codes 9,10,11,12,13.
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001852 */
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001853#define isspace(a) ({ unsigned char bb__isspace = (a) - 9; bb__isspace == (' ' - 9) || bb__isspace <= (13 - 9); })
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001854// Unsafe wrt NUL: #define ispunct(a) (strchr("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a)) != NULL)
1855#define ispunct(a) (strchrnul("!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~", (a))[0])
1856// 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 +02001857#define isalnum(a) bb_ascii_isalnum(a)
1858static ALWAYS_INLINE int bb_ascii_isalnum(unsigned char a)
1859{
1860 unsigned char b = a - '0';
1861 if (b <= 9)
1862 return (b <= 9);
1863 b = (a|0x20) - 'a';
1864 return b <= 'z' - 'a';
1865}
1866#define isxdigit(a) bb_ascii_isxdigit(a)
1867static ALWAYS_INLINE int bb_ascii_isxdigit(unsigned char a)
1868{
1869 unsigned char b = a - '0';
1870 if (b <= 9)
1871 return (b <= 9);
1872 b = (a|0x20) - 'a';
1873 return b <= 'f' - 'a';
1874}
Denys Vlasenkoa7a1fd02009-10-23 13:05:03 +02001875#define toupper(a) bb_ascii_toupper(a)
1876static ALWAYS_INLINE unsigned char bb_ascii_toupper(unsigned char a)
1877{
1878 unsigned char b = a - 'a';
1879 if (b <= ('z' - 'a'))
1880 a -= 'a' - 'A';
1881 return a;
1882}
1883#define tolower(a) bb_ascii_tolower(a)
1884static ALWAYS_INLINE unsigned char bb_ascii_tolower(unsigned char a)
1885{
1886 unsigned char b = a - 'A';
1887 if (b <= ('Z' - 'A'))
1888 a += 'a' - 'A';
1889 return a;
1890}
Denys Vlasenkof125b6d2009-10-22 19:41:45 +02001891
Denys Vlasenko8684cbb2009-11-18 11:34:43 +01001892/* In ASCII and Unicode, these are likely to be very different.
1893 * Let's prevent ambiguous usage from the start */
1894#define isgraph(a) isgraph_is_ambiguous_dont_use(a)
1895#define isprint(a) isprint_is_ambiguous_dont_use(a)
1896/* NB: must not treat EOF as isgraph or isprint */
1897#define isgraph_asciionly(a) ((unsigned)((a) - 0x21) <= 0x7e - 0x21)
1898#define isprint_asciionly(a) ((unsigned)((a) - 0x20) <= 0x7e - 0x20)
1899
Denys Vlasenkof2cbb032009-10-23 03:16:08 +02001900
Denis Vlasenkof81e8db2009-04-09 12:35:13 +00001901POP_SAVED_FUNCTION_VISIBILITY
1902
Bernhard Reutner-Fischer73561cc2006-08-28 23:31:54 +00001903#endif